"""Actionables."""
from __future__ import annotations
+from collections import namedtuple
from typing import Any
from sqlite3 import Row
from plomtask.db import DatabaseConnection, BaseModel
from plomtask.processes import Process
-from plomtask.conditions import Condition
+from plomtask.conditions import Condition, ConditionsRelations
from plomtask.exceptions import (NotFoundException, BadFormatException,
HandledException)
-class Todo(BaseModel):
+TodoStepsNode = namedtuple('TodoStepsNode',
+ ('item', 'is_todo', 'children', 'seen'))
+
+
+class Todo(BaseModel, ConditionsRelations):
"""Individual actionable."""
# pylint: disable=too-many-instance-attributes
self.children: list[Todo] = []
self.parents: list[Todo] = []
self.conditions: list[Condition] = []
- self.fulfills: list[Condition] = []
- self.undoes: list[Condition] = []
+ self.enables: list[Condition] = []
+ self.disables: list[Condition] = []
if not self.id_:
self.conditions = process.conditions[:]
- self.fulfills = process.fulfills[:]
- self.undoes = process.undoes[:]
+ self.enables = process.enables[:]
+ self.disables = process.disables[:]
@classmethod
def from_table_row(cls, db_conn: DatabaseConnection,
for t_id in db_conn.column_where('todo_children', 'parent',
'child', id_):
todo.parents += [cls.by_id(db_conn, t_id)]
- for name in ('conditions', 'fulfills', 'undoes'):
+ for name in ('conditions', 'enables', 'disables'):
table = f'todo_{name}'
for cond_id in db_conn.column_where(table, 'condition',
'todo', todo.id_):
todos += [cls.by_id(db_conn, id_)]
return todos
+ @staticmethod
+ def _x_ablers_for_at(db_conn: DatabaseConnection, name: str,
+ cond: Condition, date: str) -> list[Todo]:
+ """Collect all Todos of day that [name] condition."""
+ assert isinstance(cond.id_, int)
+ x_ablers = []
+ table = f'todo_{name}'
+ for id_ in db_conn.column_where(table, 'todo', 'condition', cond.id_):
+ todo = Todo.by_id(db_conn, id_)
+ if todo.date == date:
+ x_ablers += [todo]
+ return x_ablers
+
@classmethod
- def enablers_for_at(cls, db_conn: DatabaseConnection, condition: Condition,
- date: str) -> list[Todo]:
+ def enablers_for_at(cls, db_conn: DatabaseConnection,
+ condition: Condition, date: str) -> list[Todo]:
"""Collect all Todos of day that enable condition."""
- assert isinstance(condition.id_, int)
- enablers = []
- for id_ in db_conn.column_where('todo_fulfills', 'todo', 'condition',
- condition.id_):
- todo = cls.by_id(db_conn, id_)
- if todo.date == date:
- enablers += [todo]
- return enablers
+ return cls._x_ablers_for_at(db_conn, 'enables', condition, date)
@classmethod
def disablers_for_at(cls, db_conn: DatabaseConnection,
condition: Condition, date: str) -> list[Todo]:
"""Collect all Todos of day that disable condition."""
- assert isinstance(condition.id_, int)
- disablers = []
- for id_ in db_conn.column_where('todo_undoes', 'todo', 'condition',
- condition.id_):
- todo = cls.by_id(db_conn, id_)
- if todo.date == date:
- disablers += [todo]
- return disablers
+ return cls._x_ablers_for_at(db_conn, 'disables', condition, date)
@property
def is_doable(self) -> bool:
if self._is_done != value:
self._is_done = value
if value is True:
- for condition in self.fulfills:
+ for condition in self.enables:
condition.is_active = True
- for condition in self.undoes:
+ for condition in self.disables:
condition.is_active = False
- def set_undoes(self, db_conn: DatabaseConnection, ids: list[int]) -> None:
- """Set self.undoes to Conditions identified by ids."""
- self.set_conditions(db_conn, ids, 'undoes')
-
- def set_fulfills(self, db_conn: DatabaseConnection,
- ids: list[int]) -> None:
- """Set self.fulfills to Conditions identified by ids."""
- self.set_conditions(db_conn, ids, 'fulfills')
-
- def set_conditions(self, db_conn: DatabaseConnection, ids: list[int],
- target: str = 'conditions') -> None:
- """Set self.[target] to Conditions identified by ids."""
- target_list = getattr(self, target)
- while len(target_list) > 0:
- target_list.pop()
- for id_ in ids:
- target_list += [Condition.by_id(db_conn, id_)]
+ def get_step_tree(self, seen_todos: set[int],
+ seen_conditions: set[int]) -> TodoStepsNode:
+ """Return tree of depended-on Todos and Conditions."""
+
+ def make_node(step: Todo | Condition) -> TodoStepsNode:
+ assert isinstance(step.id_, int)
+ is_todo = isinstance(step, Todo)
+ children = []
+ if is_todo:
+ assert isinstance(step, Todo)
+ seen = step.id_ in seen_todos
+ seen_todos.add(step.id_)
+ potentially_enabled = set()
+ for child in step.children:
+ for condition in child.enables:
+ potentially_enabled.add(condition)
+ children += [make_node(child)]
+ for condition in [c for c in step.conditions
+ if (not c.is_active)
+ and (c not in potentially_enabled)]:
+ children += [make_node(condition)]
+ else:
+ assert isinstance(step, Condition)
+ seen = step.id_ in seen_conditions
+ seen_conditions.add(step.id_)
+ return TodoStepsNode(step, is_todo, children, seen)
+
+ node = make_node(self)
+ return node
def add_child(self, child: Todo) -> None:
- """Add child to self.children, guard against recursion"""
+ """Add child to self.children, avoid recursion, update parenthoods."""
def walk_steps(node: Todo) -> None:
if node.id_ == self.id_:
raise BadFormatException('bad child choice causes recursion')
self.children += [child]
child.parents += [self]
+ def remove_child(self, child: Todo) -> None:
+ """Remove child from self.children, update counter relations."""
+ if child not in self.children:
+ raise HandledException('Cannot remove un-parented child.')
+ self.children.remove(child)
+ child.parents.remove(self)
+
def save(self, db_conn: DatabaseConnection) -> None:
"""Write self and children to DB and its cache."""
if self.process.id_ is None:
[[c.id_] for c in self.children])
db_conn.rewrite_relations('todo_conditions', 'todo', self.id_,
[[c.id_] for c in self.conditions])
- db_conn.rewrite_relations('todo_fulfills', 'todo', self.id_,
- [[c.id_] for c in self.fulfills])
- db_conn.rewrite_relations('todo_undoes', 'todo', self.id_,
- [[c.id_] for c in self.undoes])
+ db_conn.rewrite_relations('todo_enables', 'todo', self.id_,
+ [[c.id_] for c in self.enables])
+ db_conn.rewrite_relations('todo_disables', 'todo', self.id_,
+ [[c.id_] for c in self.disables])
projects / plomtask / blobdiff