Skip to content

Add support for adding tags to tasks and limiting lists #61

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

Open
hardaker wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add support for adding tags to tasks and limiting lists #61

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c507667
Add support for adding tags to tasks and limiting lists
hardaker Feb 18, 2025
3f40f96
fix casting issues with a return type check
hardaker Feb 19, 2025
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
101 changes: 96 additions & 5 deletions habitipy/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,10 +342,41 @@ def color(cls, value):
return colors.fg(cls.colors_[index])


class TasksPrint(ApplicationWithApi):
class TagsHelper(ApplicationWithApi):
"""A base class for getting and setting tags."""
def get_tags(self):
"""Fetch all the tags defined by a user."""
self.tags_list = self.api.tags.get()
self.tags_by_id = {x['id']: x for x in self.tags_list}
self.tags_by_name = {x['name']: x for x in self.tags_list}

def get_or_create_tag_id_by_name(self, tag_name: str):
"""Get the ID of an existing tag or create it if it doesn't exist."""
if not getattr(self, 'tags_list', False):
self.get_tags()
if tag_name in self.tags_by_name:
return self.tags_by_name[tag_name]['id']

new_tag = self.api.tags.post(name=tag_name)
if not isinstance(new_tag, dict):
raise TypeError("API returned a list, but a dict was expected")

return new_tag['id']

def apply_tags_to(self, apply_to: str, tag_names_list: list[str]):
"""Apply a list of tags to a given task."""
# apply requested tags
self.get_tags()
for tag in tag_names_list:
tag_id = self.get_or_create_tag_id_by_name(tag)
self.api.tasks[apply_to]['tags'][tag_id].post()


class TasksPrint(TagsHelper):
"""Put all tasks from `domain` to print"""
domain = '' # type: str
more_tasks = [] # type: List[Dict[str, Any]]
tag = None
def domain_format(self, task):
"""format task for domain"""
raise NotImplementedError()
Expand All @@ -354,14 +385,34 @@ def main(self):
if self.nested_command:
return
super().main()
if self.tag:
self.get_tags()
tasks = self.api.tasks.user.get(type=self.domain)
tasks.extend(self.more_tasks)
habits_len = len(tasks)
ident_size = len(str(habits_len)) + 2
number_format = '{{:{}d}}. '.format(ident_size - 2)

self.get_tags()

filter_by_tag = self.tag
if filter_by_tag:
filter_by_tag = self.get_or_create_tag_id_by_name(self.tag)

for i, task in enumerate(tasks):
if filter_by_tag and filter_by_tag not in task['tags']:
continue

i = number_format.format(i + 1) if self.config['show_numbers'] else ''
res = i + prettify(self.domain_format(task))

tag_list = ""
if task['tags']:
tag_list = ", ".join([self.tags_by_id[x]["name"] for x in task['tags']])
tag_list = colors.dark_gray | " (" + tag_list + ")"

res = i + prettify(self.domain_format(task)) + tag_list

print(res)


Expand Down Expand Up @@ -747,6 +798,11 @@ def main(self, *args, **kwargs):
class Habits(TasksPrint): # pylint: disable=missing-docstring
DESCRIPTION = _("List, up and down habit tasks") # noqa: Q000
domain = 'habits'
tag = cli.SwitchAttr(
Copy link
Owner

@asmfreak asmfreak Feb 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please try to move this to its base class (TagsHelper)?

Copy link
Owner

@asmfreak asmfreak Feb 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, please use a repeatable switch. See plumbum docs on this.

['-t', '--tag'],
default="",
help=_("Tag name to limit the list by")
)
def domain_format(self, habit): # pylint: disable=arguments-renamed
score = ScoreInfo(self.config['show_style'], habit['value'])
return _("{0} {text}").format(score, **habit) # noqa: Q000
Expand All @@ -755,6 +811,11 @@ def domain_format(self, habit): # pylint: disable=arguments-renamed
class Dailys(TasksPrint): # pylint: disable=missing-class-docstring
DESCRIPTION = _("List, check, uncheck daily tasks") # noqa: Q000
domain = 'dailys'
tag = cli.SwitchAttr(
['-t', '--tag'],
default="",
help=_("Tag name to limit the list by")
)
def domain_format(self, daily): # pylint: disable=arguments-renamed
score = ScoreInfo(self.config['show_style'], daily['value'])
check = CHECK if daily['completed'] else UNCHECK
Expand All @@ -775,6 +836,11 @@ def domain_format(self, daily): # pylint: disable=arguments-renamed
class ToDos(TasksPrint): # pylint: disable=missing-class-docstring
DESCRIPTION = _("List, comlete, add or delete todo tasks") # noqa: Q000
domain = 'todos'
tag = cli.SwitchAttr(
['-t', '--tag'],
default="",
help=_("Tag name to limit the list by")
)
def domain_format(self, todo): # pylint: disable=arguments-renamed
score = ScoreInfo(self.config['show_style'], todo['value'])
check = CHECK if todo['completed'] else UNCHECK
Expand Down Expand Up @@ -921,12 +987,17 @@ def domain_print(self):


@Habits.subcommand('add')
class HabitsAdd(ApplicationWithApi): # pylint: disable=missing-class-docstring
class HabitsAdd(TagsHelper): # pylint: disable=missing-class-docstring
DESCRIPTION = _("Add a habit <habit>") # noqa: Q000
priority = cli.SwitchAttr(
['-p', '--priority'],
cli.Set('0.1', '1', '1.5', '2'), default='1',
help=_("Priority (complexity) of a habit")) # noqa: Q000
tags = cli.SwitchAttr(
['-t', '--tag'],
default="",
help=_("List of tag names to add to the new task.")
)
direction = cli.SwitchAttr(
['-d', '--direction'],
cli.Set('positive', 'negative', 'both'), default='both',
Expand All @@ -938,13 +1009,20 @@ def main(self, *habit: str):
self.log.error(_("Empty habit text!")) # noqa: Q000
return 1
super().main()
self.api.tasks.user.post(
response = self.api.tasks.user.post(
type='habit', text=habit_str,
priority=self.priority, up=(self.direction != 'negative'),
down=self.direction != 'positive')

if not isinstance(response, dict):
raise TypeError("API returned a list, but a dict was expected")

res = _("Added habit '{}' with priority {} and direction {}").format( # noqa: Q000
habit_str, self.priority, self.direction)

# apply requested tags
self.apply_tags_to(response["id"], self.tags.split(","))

print(prettify(res))
Habits.invoke(config_filename=self.config_filename)
return None
Expand Down Expand Up @@ -1040,21 +1118,34 @@ def log_op(self, tid):


@ToDos.subcommand('add')
class TodosAdd(ApplicationWithApi): # pylint: disable=missing-class-docstring
class TodosAdd(TagsHelper): # pylint: disable=missing-class-docstring
DESCRIPTION = _("Add a todo <todo>") # noqa: Q000
priority = cli.SwitchAttr(
['-p', '--priority'],
cli.Set('0.1', '1', '1.5', '2'), default='1',
help=_("Priority (complexity) of a todo")) # noqa: Q000
tags = cli.SwitchAttr(
['-t', '--tags'],
default="",
help=_("Comma separated list of tags to apply")
)

def main(self, *todo: str):
todo_str = ' '.join(todo)
if not todo_str:
self.log.error(_("Empty todo text!")) # noqa: Q000
return 1
super().main()
self.api.tasks.user.post(type='todo', text=todo_str, priority=self.priority)
response = self.api.tasks.user.post(type='todo', text=todo_str, priority=self.priority)
if not isinstance(response, dict):
raise TypeError("API returned a list, but a dict was expected")

res = _("Added todo '{}' with priority {}").format(todo_str, self.priority) # noqa: Q000

# apply requested tags
if self.tags:
self.apply_tags_to(response["id"], self.tags.split(","))

print(prettify(res))
ToDos.invoke(config_filename=self.config_filename)
return 0
Expand Down