home · contact · privacy
Enable toggling of Todo.is_done.
[plomtask] / plomtask / todos.py
1 """Actionables."""
2 from __future__ import annotations
3 from sqlite3 import Row
4 from plomtask.db import DatabaseConnection
5 from plomtask.days import Day
6 from plomtask.processes import Process
7 from plomtask.exceptions import (NotFoundException, BadFormatException,
8                                  HandledException)
9
10
11 class Todo:
12     """Individual actionable."""
13
14     def __init__(self, id_: int | None, process: Process,
15                  is_done: bool, day: Day) -> None:
16         self.id_ = id_
17         self.process = process
18         self.is_done = is_done
19         self.day = day
20         self.children: list[Todo] = []
21         self.parents: list[Todo] = []
22
23     @classmethod
24     def from_table_row(cls, db_conn: DatabaseConnection, row: Row) -> Todo:
25         """Make Todo from database row, write to DB cache."""
26         todo = cls(id_=row[0],
27                    process=Process.by_id(db_conn, row[1]),
28                    is_done=bool(row[2]),
29                    day=Day.by_date(db_conn, row[3]))
30         assert todo.id_ is not None
31         db_conn.cached_todos[todo.id_] = todo
32         return todo
33
34     @classmethod
35     def by_id(cls, db_conn: DatabaseConnection, id_: int | None) -> Todo:
36         """Get Todo of .id_=id_ and children (from DB cache if possible)."""
37         if id_ in db_conn.cached_todos.keys():
38             todo = db_conn.cached_todos[id_]
39         else:
40             todo = None
41             for row in db_conn.exec('SELECT * FROM todos WHERE id = ?',
42                                     (id_,)):
43                 todo = cls.from_table_row(db_conn, row)
44                 break
45             if todo is None:
46                 raise NotFoundException(f'Todo of ID not found: {id_}')
47             for row in db_conn.exec('SELECT child FROM todo_children '
48                                     'WHERE parent = ?', (id_,)):
49                 todo.children += [cls.by_id(db_conn, row[0])]
50             for row in db_conn.exec('SELECT parent FROM todo_children '
51                                     'WHERE child = ?', (id_,)):
52                 todo.parents += [cls.by_id(db_conn, row[0])]
53         assert isinstance(todo, Todo)
54         return todo
55
56     @classmethod
57     def by_date(cls, db_conn: DatabaseConnection, date: str) -> list[Todo]:
58         """Collect all Todos for Day of date."""
59         todos = []
60         for row in db_conn.exec('SELECT id FROM todos WHERE day = ?', (date,)):
61             todos += [cls.by_id(db_conn, row[0])]
62         return todos
63
64     def add_child(self, child: Todo) -> None:
65         """Add child to self.children, guard against recursion"""
66         def walk_steps(node: Todo) -> None:
67             if node.id_ == self.id_:
68                 raise BadFormatException('bad child choice causes recursion')
69             for child in node.children:
70                 walk_steps(child)
71         if self.id_ is None:
72             raise HandledException('Can only add children to saved Todos.')
73         if child.id_ is None:
74             raise HandledException('Can only add saved children to Todos.')
75         if child in self.children:
76             raise BadFormatException('cannot adopt same child twice')
77         walk_steps(child)
78         self.children += [child]
79         child.parents += [self]
80
81     def save(self, db_conn: DatabaseConnection) -> None:
82         """Write self and children to DB and its cache."""
83         if self.process.id_ is None:
84             raise NotFoundException('Process of Todo without ID (not saved?)')
85         cursor = db_conn.exec('REPLACE INTO todos VALUES (?,?,?,?)',
86                               (self.id_, self.process.id_,
87                                self.is_done, self.day.date))
88         self.id_ = cursor.lastrowid
89         assert self.id_ is not None
90         db_conn.cached_todos[self.id_] = self
91         db_conn.exec('DELETE FROM todo_children WHERE parent = ?',
92                      (self.id_,))
93         for child in self.children:
94             db_conn.exec('INSERT INTO todo_children VALUES (?, ?)',
95                          (self.id_, child.id_))