2 from __future__ import annotations
3 from dataclasses import dataclass
5 from sqlite3 import Row
6 from plomtask.db import DatabaseConnection, BaseModel
7 from plomtask.processes import Process
8 from plomtask.conditions import Condition, ConditionsRelations
9 from plomtask.exceptions import (NotFoundException, BadFormatException,
15 """Collects what's useful to know for Todo/Condition tree display."""
16 item: Todo | Condition
18 children: list[TodoStepsNode]
22 class Todo(BaseModel, ConditionsRelations):
23 """Individual actionable."""
25 # pylint: disable=too-many-instance-attributes
28 to_save = ['process_id', 'is_done', 'date']
30 def __init__(self, id_: int | None, process: Process,
31 is_done: bool, date: str) -> None:
33 self.process = process
34 self._is_done = is_done
36 self.children: list[Todo] = []
37 self.parents: list[Todo] = []
38 self.conditions: list[Condition] = []
39 self.enables: list[Condition] = []
40 self.disables: list[Condition] = []
42 self.conditions = process.conditions[:]
43 self.enables = process.enables[:]
44 self.disables = process.disables[:]
47 def from_table_row(cls, db_conn: DatabaseConnection,
48 row: Row | list[Any]) -> Todo:
49 """Make from DB row, write to DB cache."""
51 raise NotFoundException('calling Todo of '
53 row_as_list = list(row)
54 row_as_list[1] = Process.by_id(db_conn, row[1])
55 todo = super().from_table_row(db_conn, row_as_list)
56 assert isinstance(todo, Todo)
60 def by_id(cls, db_conn: DatabaseConnection, id_: int) -> Todo:
61 """Get Todo of .id_=id_ and children (from DB cache if possible)."""
62 todo, from_cache = super()._by_id(db_conn, id_)
64 raise NotFoundException(f'Todo of ID not found: {id_}')
66 for t_id in db_conn.column_where('todo_children', 'child',
68 todo.children += [cls.by_id(db_conn, t_id)]
69 for t_id in db_conn.column_where('todo_children', 'parent',
71 todo.parents += [cls.by_id(db_conn, t_id)]
72 for name in ('conditions', 'enables', 'disables'):
73 table = f'todo_{name}'
74 for cond_id in db_conn.column_where(table, 'condition',
76 target = getattr(todo, name)
77 target += [Condition.by_id(db_conn, cond_id)]
78 assert isinstance(todo, Todo)
82 def by_date(cls, db_conn: DatabaseConnection, date: str) -> list[Todo]:
83 """Collect all Todos for Day of date."""
85 for id_ in db_conn.column_where('todos', 'id', 'day', date):
86 todos += [cls.by_id(db_conn, id_)]
90 def _x_ablers_for_at(db_conn: DatabaseConnection, name: str,
91 cond: Condition, date: str) -> list[Todo]:
92 """Collect all Todos of day that [name] condition."""
93 assert isinstance(cond.id_, int)
95 table = f'todo_{name}'
96 for id_ in db_conn.column_where(table, 'todo', 'condition', cond.id_):
97 todo = Todo.by_id(db_conn, id_)
103 def enablers_for_at(cls, db_conn: DatabaseConnection,
104 condition: Condition, date: str) -> list[Todo]:
105 """Collect all Todos of day that enable condition."""
106 return cls._x_ablers_for_at(db_conn, 'enables', condition, date)
109 def disablers_for_at(cls, db_conn: DatabaseConnection,
110 condition: Condition, date: str) -> list[Todo]:
111 """Collect all Todos of day that disable condition."""
112 return cls._x_ablers_for_at(db_conn, 'disables', condition, date)
115 def is_doable(self) -> bool:
116 """Decide whether .is_done settable based on children, Conditions."""
117 for child in self.children:
118 if not child.is_done:
120 for condition in self.conditions:
121 if not condition.is_active:
126 def process_id(self) -> int | str | None:
127 """Return ID of tasked Process."""
128 return self.process.id_
131 def is_done(self) -> bool:
132 """Wrapper around self._is_done so we can control its setter."""
136 def is_done(self, value: bool) -> None:
137 if value != self.is_done and not self.is_doable:
138 raise BadFormatException('cannot change doneness of undoable Todo')
139 if self._is_done != value:
140 self._is_done = value
142 for condition in self.enables:
143 condition.is_active = True
144 for condition in self.disables:
145 condition.is_active = False
147 def get_step_tree(self, seen_todos: set[int],
148 seen_conditions: set[int]) -> TodoStepsNode:
149 """Return tree of depended-on Todos and Conditions."""
151 def make_node(step: Todo | Condition) -> TodoStepsNode:
152 assert isinstance(step.id_, int)
153 is_todo = isinstance(step, Todo)
156 assert isinstance(step, Todo)
157 seen = step.id_ in seen_todos
158 seen_todos.add(step.id_)
159 potentially_enabled = set()
160 for child in step.children:
161 for condition in child.enables:
162 potentially_enabled.add(condition)
163 children += [make_node(child)]
164 for condition in [c for c in step.conditions
166 and (c not in potentially_enabled)]:
167 children += [make_node(condition)]
169 assert isinstance(step, Condition)
170 seen = step.id_ in seen_conditions
171 seen_conditions.add(step.id_)
172 return TodoStepsNode(step, is_todo, children, seen)
174 node = make_node(self)
177 def add_child(self, child: Todo) -> None:
178 """Add child to self.children, avoid recursion, update parenthoods."""
180 def walk_steps(node: Todo) -> None:
181 if node.id_ == self.id_:
182 raise BadFormatException('bad child choice causes recursion')
183 for child in node.children:
187 raise HandledException('Can only add children to saved Todos.')
188 if child.id_ is None:
189 raise HandledException('Can only add saved children to Todos.')
190 if child in self.children:
191 raise BadFormatException('cannot adopt same child twice')
193 self.children += [child]
194 child.parents += [self]
196 def remove_child(self, child: Todo) -> None:
197 """Remove child from self.children, update counter relations."""
198 if child not in self.children:
199 raise HandledException('Cannot remove un-parented child.')
200 self.children.remove(child)
201 child.parents.remove(self)
203 def save(self, db_conn: DatabaseConnection) -> None:
204 """Write self and children to DB and its cache."""
205 if self.process.id_ is None:
206 raise NotFoundException('Process of Todo without ID (not saved?)')
207 self.save_core(db_conn)
208 assert isinstance(self.id_, int)
209 db_conn.cached_todos[self.id_] = self
210 db_conn.rewrite_relations('todo_children', 'parent', self.id_,
211 [[c.id_] for c in self.children])
212 db_conn.rewrite_relations('todo_conditions', 'todo', self.id_,
213 [[c.id_] for c in self.conditions])
214 db_conn.rewrite_relations('todo_enables', 'todo', self.id_,
215 [[c.id_] for c in self.enables])
216 db_conn.rewrite_relations('todo_disables', 'todo', self.id_,
217 [[c.id_] for c in self.disables])