2 from __future__ import annotations
4 from sqlite3 import Row
5 from plomtask.db import DatabaseConnection, BaseModel
6 from plomtask.processes import Process
7 from plomtask.conditions import Condition
8 from plomtask.exceptions import (NotFoundException, BadFormatException,
12 class Todo(BaseModel):
13 """Individual actionable."""
15 # pylint: disable=too-many-instance-attributes
18 to_save = ['process_id', 'is_done', 'date']
20 def __init__(self, id_: int | None, process: Process,
21 is_done: bool, date: str) -> None:
23 self.process = process
24 self._is_done = is_done
26 self.children: list[Todo] = []
27 self.parents: list[Todo] = []
28 self.conditions: list[Condition] = []
29 self.fulfills: list[Condition] = []
30 self.undoes: list[Condition] = []
32 self.conditions = process.conditions[:]
33 self.fulfills = process.fulfills[:]
34 self.undoes = process.undoes[:]
37 def from_table_row(cls, db_conn: DatabaseConnection,
38 row: Row | list[Any]) -> Todo:
39 """Make from DB row, write to DB cache."""
41 raise NotFoundException('calling Todo of '
43 row_as_list = list(row)
44 row_as_list[1] = Process.by_id(db_conn, row[1])
45 todo = super().from_table_row(db_conn, row_as_list)
46 assert isinstance(todo, Todo)
50 def by_id(cls, db_conn: DatabaseConnection, id_: int) -> Todo:
51 """Get Todo of .id_=id_ and children (from DB cache if possible)."""
52 todo, from_cache = super()._by_id(db_conn, id_)
54 raise NotFoundException(f'Todo of ID not found: {id_}')
56 for t_id in db_conn.column_where('todo_children', 'child',
58 todo.children += [cls.by_id(db_conn, t_id)]
59 for t_id in db_conn.column_where('todo_children', 'parent',
61 todo.parents += [cls.by_id(db_conn, t_id)]
62 for name in ('conditions', 'fulfills', 'undoes'):
63 table = f'todo_{name}'
64 for cond_id in db_conn.column_where(table, 'condition',
66 target = getattr(todo, name)
67 target += [Condition.by_id(db_conn, cond_id)]
68 assert isinstance(todo, Todo)
72 def by_date(cls, db_conn: DatabaseConnection, date: str) -> list[Todo]:
73 """Collect all Todos for Day of date."""
75 for id_ in db_conn.column_where('todos', 'id', 'day', date):
76 todos += [cls.by_id(db_conn, id_)]
80 def enablers_for_at(cls, db_conn: DatabaseConnection, condition: Condition,
81 date: str) -> list[Todo]:
82 """Collect all Todos of day that enable condition."""
83 assert isinstance(condition.id_, int)
85 for id_ in db_conn.column_where('todo_fulfills', 'todo', 'condition',
87 todo = cls.by_id(db_conn, id_)
93 def disablers_for_at(cls, db_conn: DatabaseConnection,
94 condition: Condition, date: str) -> list[Todo]:
95 """Collect all Todos of day that disable condition."""
96 assert isinstance(condition.id_, int)
98 for id_ in db_conn.column_where('todo_undoes', 'todo', 'condition',
100 todo = cls.by_id(db_conn, id_)
101 if todo.date == date:
106 def is_doable(self) -> bool:
107 """Decide whether .is_done settable based on children, Conditions."""
108 for child in self.children:
109 if not child.is_done:
111 for condition in self.conditions:
112 if not condition.is_active:
117 def process_id(self) -> int | str | None:
118 """Return ID of tasked Process."""
119 return self.process.id_
122 def is_done(self) -> bool:
123 """Wrapper around self._is_done so we can control its setter."""
127 def is_done(self, value: bool) -> None:
128 if value != self.is_done and not self.is_doable:
129 raise BadFormatException('cannot change doneness of undoable Todo')
130 if self._is_done != value:
131 self._is_done = value
133 for condition in self.fulfills:
134 condition.is_active = True
135 for condition in self.undoes:
136 condition.is_active = False
138 def set_undoes(self, db_conn: DatabaseConnection, ids: list[int]) -> None:
139 """Set self.undoes to Conditions identified by ids."""
140 self.set_conditions(db_conn, ids, 'undoes')
142 def set_fulfills(self, db_conn: DatabaseConnection,
143 ids: list[int]) -> None:
144 """Set self.fulfills to Conditions identified by ids."""
145 self.set_conditions(db_conn, ids, 'fulfills')
147 def set_conditions(self, db_conn: DatabaseConnection, ids: list[int],
148 target: str = 'conditions') -> None:
149 """Set self.[target] to Conditions identified by ids."""
150 target_list = getattr(self, target)
151 while len(target_list) > 0:
154 target_list += [Condition.by_id(db_conn, id_)]
156 def add_child(self, child: Todo) -> None:
157 """Add child to self.children, guard against recursion"""
158 def walk_steps(node: Todo) -> None:
159 if node.id_ == self.id_:
160 raise BadFormatException('bad child choice causes recursion')
161 for child in node.children:
164 raise HandledException('Can only add children to saved Todos.')
165 if child.id_ is None:
166 raise HandledException('Can only add saved children to Todos.')
167 if child in self.children:
168 raise BadFormatException('cannot adopt same child twice')
170 self.children += [child]
171 child.parents += [self]
173 def save(self, db_conn: DatabaseConnection) -> None:
174 """Write self and children to DB and its cache."""
175 if self.process.id_ is None:
176 raise NotFoundException('Process of Todo without ID (not saved?)')
177 self.save_core(db_conn)
178 assert isinstance(self.id_, int)
179 db_conn.cached_todos[self.id_] = self
180 db_conn.rewrite_relations('todo_children', 'parent', self.id_,
181 [[c.id_] for c in self.children])
182 db_conn.rewrite_relations('todo_conditions', 'todo', self.id_,
183 [[c.id_] for c in self.conditions])
184 db_conn.rewrite_relations('todo_fulfills', 'todo', self.id_,
185 [[c.id_] for c in self.fulfills])
186 db_conn.rewrite_relations('todo_undoes', 'todo', self.id_,
187 [[c.id_] for c in self.undoes])