Skip to content

Implement command completion for task arguments #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jwodder wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Implement command completion for task arguments #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions src/habits/__main__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
from configparser import ConfigParser
from dataclasses import dataclass
from datetime import datetime, time, timedelta
from difflib import get_close_matches
import json
import os
from pathlib import Path
Expand All @@ -11,6 +12,7 @@
from cachecontrol import CacheControl
from cachecontrol.caches.file_cache import FileCache
import click
from click.shell_completion import CompletionItem
from dateutil.parser import isoparse
from dateutil.tz import tzstr
from platformdirs import PlatformDirs
Expand Down Expand Up @@ -188,6 +190,26 @@ def show_json(self) -> None:
print_json(self.response_json)


class TaskParam(click.ParamType):
def convert(
self, value: str, _param: click.Parameter | None, ctx: click.Context | None
) -> str:
if ctx is None or value in ctx.obj.aliases:
return value
else:
candidates = get_close_matches(value, list(ctx.obj.aliases.keys()))
if candidates:
dym = " (Did you mean:" + "".join(f" {c}?" for c in candidates) + ")"
else:
dym = ""
self.fail(f"{value!r}: unknown task{dym}")

def shell_complete(
self, ctx: click.Context, _param: click.Parameter, incomplete: str
) -> list[CompletionItem]:
return [CompletionItem(c) for c in ctx.obj.aliases if c.startswith(incomplete)]


@click.group(context_settings={"help_option_names": ["-h", "--help"]})
@click.option(
"-c",
Expand All @@ -211,7 +233,7 @@ def main(ctx: click.Context, config: Path) -> None:
@main.command()
@click.option("-J", "--show-json", is_flag=True)
@click.option("--no-cron", is_flag=True)
@click.argument("task", nargs=-1)
@click.argument("task", type=TaskParam(), nargs=-1)
@click.pass_obj
def up(hb: Habitica, task: str, no_cron: bool, show_json: bool) -> None:
"""Check-off or +1 a task"""
Expand All @@ -234,7 +256,7 @@ def up(hb: Habitica, task: str, no_cron: bool, show_json: bool) -> None:
@main.command()
@click.option("-J", "--show-json", is_flag=True)
@click.option("--no-cron", is_flag=True)
@click.argument("task", nargs=-1)
@click.argument("task", type=TaskParam(), nargs=-1)
@click.pass_obj
def down(hb: Habitica, task: str, no_cron: bool, show_json: bool) -> None:
"""Uncheck or -1 a task"""
Expand Down