feat: add edit command

- fix when data file do not exists
- adds the "touched" field
This commit is contained in:
Johann Dreo 2023-07-27 22:42:50 +02:00
commit b26e384000

View file

@ -1,6 +1,7 @@
import sys
import csv
import json
import datetime
from configparser import ConfigParser
import pandas as pd
@ -15,17 +16,30 @@ error_codes = {
def error(id,msg):
print(msg)
print("ERROR:",msg)
sys.exit(error_codes[id])
def load_data(context):
# Automagically manages standard input if input=="-", thanks to allow_dash=True.
with click.open_file(context.obj['input'], mode='r') as fd:
df = pd.read_csv(fd)
# FIXME data sanity checks: unique index, aligned status, valid dates
try:
# Automagically manages standard input if input=="-", thanks to allow_dash=True.
with click.open_file(context.obj['input'], mode='r') as fd:
df = pd.read_csv(fd)
# FIXME data sanity checks: unique index, aligned status, valid dates
# df.set_index(context.obj['id_key'])
except FileNotFoundError:
df = pd.DataFrame(columns=[
context.obj['id_key'],
context.obj['status_key'],
context.obj['title_key'],
context.obj['details_key'],
context.obj['tags_key'],
context.obj['deadline_key'],
context.obj['touched_key'],
])
save_data(context, df)
df.set_index(context.obj['id_key'])
return df
@ -36,15 +50,16 @@ def save_data(context, df):
df.to_csv(fd, index=False, quoting=csv.QUOTE_NONNUMERIC)
def configure(ctx, param, filename):
def configure(context, param, filename):
"""Overwrite defaults for options."""
cfg = ConfigParser()
cfg.read(filename)
ctx.default_map = {}
context.default_map = {}
for sect in cfg.sections():
command_path = sect.split('.')
if command_path[0] != 'options':
continue
defaults = ctx.default_map
defaults = context.default_map
for cmdname in command_path[1:]:
defaults = defaults.setdefault(cmdname, {})
defaults.update(cfg[sect])
@ -64,12 +79,13 @@ def configure(ctx, param, filename):
)
@click.option('-i', '--input' , help="CSV data file.", default='.klyban.csv', type=click.Path(writable=True, readable=True, allow_dash=True), show_default=True)
@click.option('--status-key' , default='STATUS' , type=str, show_default=True, help="Header key defining the status of tasks.")
@click.option('--status-list' , default='TODO ,DOING ,HOLD ,DONE' , type=str, show_default=True, help="Comma-separated, ordered list of possible values for the status of tasks.")
@click.option('--status-list' , default='TODO,DOING,HOLD,DONE', type=str, show_default=True, help="Comma-separated, ordered list of possible values for the status of tasks.")
@click.option('--id-key' , default='ID' , type=str, show_default=True, help="Header key defining the unique ID of tasks.")
@click.option('--title-key' , default='TITLE' , type=str, show_default=True, help="Header key defining the title (short description) of tasks.")
@click.option('--details-key' , default='DETAILS' , type=str, show_default=True, help="Header key defining the details (long description) of tasks.")
@click.option('--tags-key' , default='TAGS' , type=str, show_default=True, help="Header key defining the tags associated to tasks.")
@click.option('--deadline-key', default='DEADLINE', type=str, show_default=True, help="Header key defining the deadlines tasks.")
@click.option('--touched-key', default='TOUCHED', type=str, show_default=True, help="Header key defining the deadlines tasks.")
@click.option('--show-keys' , default='ID,TITLE,DETAILS,DEADLINE,TAGS', type=str , show_default=True, help="Comma-separated, ordered list of fields that should be shown")
@click.pass_context
def cli(context, **kwargs):
@ -81,12 +97,13 @@ def cli(context, **kwargs):
context.obj['input'] = kwargs['input']
context.obj['status_key'] = kwargs['status_key']
context.obj['id_key'] = kwargs['id_key']
context.obj['status_key'] = kwargs['status_key']
context.obj['title_key'] = kwargs['title_key']
context.obj['details_key'] = kwargs['details_key']
context.obj['tags_key'] = kwargs['tags_key']
context.obj['deadline_key'] = kwargs['deadline_key']
context.obj['touched_key'] = kwargs['touched_key']
context.obj['status_list'] = kwargs['status_list'].split(',')
context.obj['show_keys'] = kwargs['show_keys'].split(',')
@ -98,6 +115,9 @@ def show(context):
"""Show the kanban."""
df = load_data(context)
if df.empty:
print("No task.")
return
tables = df.groupby(context.obj['status_key'])
for k in context.obj['status_list']: # Ordered.
@ -116,6 +136,7 @@ def show(context):
else:
print(tabulate.tabulate(t.fillna(""), headers=context.obj['show_keys'], tablefmt="fancy_grid", showindex=False))
@cli.command()
@click.argument('TITLE', required=True, nargs=-1)
@click.option('-d', '--details' , type=str, default="", prompt=True)
@ -134,6 +155,40 @@ def add(context, title, status, details, tags, deadline):
context.obj['details_key']: details,
context.obj['tags_key']: tags,
context.obj['deadline_key']: deadline,
context.obj['touched_key']: datetime.datetime.now().isoformat(),
}
save_data(context,df)
context.invoke(show)
def check_id(context, param, value):
"""Eager callback, checking ID before edit's options prompting."""
df = load_data(context)
if id not in df.index:
error("ID_NOT_FOUND", "{} `{}` was not found in data `{}`".format(context.obj['id_key'], value, context.obj['input']))
@cli.command()
@click.argument('ID', required=True, type=int, is_eager=True, callback=check_id)
@click.option('-t', '--title' , type=str, prompt=True)
@click.option('-s', '--status' , type=str, prompt=True)
@click.option('-d', '--details' , type=str, prompt=True, default="")
@click.option('-t', '--tags' , type=str, prompt=True, default="")
@click.option('-a', '--deadline', type=str, prompt=True, default="")
# FIXME populate the defaults with actual existing data.
@click.pass_context
def edit(context, id, title, status, details, tags, deadline):
"""Add a new task."""
df = load_data(context)
df.loc[id] = {
context.obj['id_key']: id,
context.obj['status_key']: status,
context.obj['title_key']: " ".join(title),
context.obj['details_key']: details,
context.obj['tags_key']: tags,
context.obj['deadline_key']: deadline,
context.obj['touched_key']: datetime.datetime.now().isoformat(),
}
save_data(context,df)
@ -146,7 +201,7 @@ def add(context, title, status, details, tags, deadline):
def promote(context, id):
"""Upgrade the status of task `ID` to the next one.
Use status configured with --status-list."""
Use status names configured with --status-list."""
df = load_data(context)
@ -164,6 +219,7 @@ def promote(context, id):
error("UNKNOWN_STATUS", "Cannot promote task {}, already at the last status.".format(id))
else:
df.loc[df[context.obj['id_key']] == int(id), context.obj['status_key']] = context.obj['status_list'][i+1]
df.loc[df[context.obj['id_key']] == int(id), context.obj['touched_key']] = datetime.datetime.now().isoformat()
save_data(context, df)
@ -176,7 +232,7 @@ def promote(context, id):
def demote(context, id):
"""Downgrade the status of task `ID` to the previous one.
Use status configured with --status-list."""
Use status names configured with --status-list."""
df = load_data(context)
@ -194,6 +250,7 @@ def demote(context, id):
error("UNKNOWN_STATUS", "Cannot demote task {}, already at the first status.".format(id))
else:
df.loc[df[context.obj['id_key']] == int(id), context.obj['status_key']] = context.obj['status_list'][i-1]
df.loc[df[context.obj['id_key']] == int(id), context.obj['touched_key']] = datetime.datetime.now().isoformat()
save_data(context, df)