1 """Collecting Processes and Process-related items."""
2 from __future__ import annotations
3 from dataclasses import dataclass
4 from typing import Set, Any
5 from sqlite3 import Row
6 from plomtask.db import DatabaseConnection, BaseModel
7 from plomtask.versioned_attributes import VersionedAttribute
8 from plomtask.conditions import Condition, ConditionsRelations
9 from plomtask.exceptions import (NotFoundException, BadFormatException,
14 class ProcessStepsNode:
15 """Collects what's useful to know for ProcessSteps tree display."""
19 steps: dict[int, ProcessStepsNode]
21 is_suppressed: bool = False
24 class Process(BaseModel[int], ConditionsRelations):
25 """Template for, and metadata for, Todos, and their arrangements."""
26 # pylint: disable=too-many-instance-attributes
27 table_name = 'processes'
28 to_save = ['calendarize']
29 to_save_versioned = ['title', 'description', 'effort']
30 to_save_relations = [('process_conditions', 'process', 'conditions', 0),
31 ('process_blockers', 'process', 'blockers', 0),
32 ('process_enables', 'process', 'enables', 0),
33 ('process_disables', 'process', 'disables', 0),
34 ('process_step_suppressions', 'process',
35 'suppressed_steps', 0)]
36 to_search = ['title.newest', 'description.newest']
38 def __init__(self, id_: int | None, calendarize: bool = False) -> None:
39 BaseModel.__init__(self, id_)
40 ConditionsRelations.__init__(self)
41 self.title = VersionedAttribute(self, 'process_titles', 'UNNAMED')
42 self.description = VersionedAttribute(self, 'process_descriptions', '')
43 self.effort = VersionedAttribute(self, 'process_efforts', 1.0)
44 self.explicit_steps: list[ProcessStep] = []
45 self.suppressed_steps: list[ProcessStep] = []
46 self.calendarize = calendarize
47 self.n_owners: int | None = None # only set by from_table_row
50 def as_dict(self) -> dict[str, object]:
51 """Return self as (json.dumps-coompatible) dict."""
53 d['explicit_steps'] = [s.as_dict for s in self.explicit_steps]
54 d['suppressed_steps'] = [s.as_dict for s in self.suppressed_steps]
58 def from_table_row(cls, db_conn: DatabaseConnection,
59 row: Row | list[Any]) -> Process:
60 """Make from DB row, with dependencies."""
61 process = super().from_table_row(db_conn, row)
62 assert process.id_ is not None
63 for name in ('conditions', 'blockers', 'enables', 'disables'):
64 table = f'process_{name}'
65 assert isinstance(process.id_, int)
66 for c_id in db_conn.column_where(table, 'condition',
67 'process', process.id_):
68 target = getattr(process, name)
69 target += [Condition.by_id(db_conn, c_id)]
70 for row_ in db_conn.row_where('process_steps', 'owner', process.id_):
71 step = ProcessStep.from_table_row(db_conn, row_)
72 process.explicit_steps += [step]
73 for row_ in db_conn.row_where('process_step_suppressions', 'process',
75 step = ProcessStep.by_id(db_conn, row_[1])
76 process.suppressed_steps += [step]
77 process.n_owners = len(process.used_as_step_by(db_conn))
80 def used_as_step_by(self, db_conn: DatabaseConnection) -> list[Process]:
81 """Return Processes using self for a ProcessStep."""
85 for id_ in db_conn.column_where('process_steps', 'owner',
86 'step_process', self.id_):
88 return [self.__class__.by_id(db_conn, id_) for id_ in owner_ids]
90 def get_steps(self, db_conn: DatabaseConnection, external_owner:
91 Process | None = None) -> dict[int, ProcessStepsNode]:
92 """Return tree of depended-on explicit and implicit ProcessSteps."""
94 def make_node(step: ProcessStep, suppressed: bool) -> ProcessStepsNode:
96 if external_owner is not None:
97 is_explicit = step.owner_id == external_owner.id_
98 process = self.__class__.by_id(db_conn, step.step_process_id)
101 step_steps = process.get_steps(db_conn, external_owner)
102 return ProcessStepsNode(process, step.parent_step_id,
103 is_explicit, step_steps, False, suppressed)
105 def walk_steps(node_id: int, node: ProcessStepsNode) -> None:
106 node.seen = node_id in seen_step_ids
107 seen_step_ids.add(node_id)
108 if node.is_suppressed:
110 explicit_children = [s for s in self.explicit_steps
111 if s.parent_step_id == node_id]
112 for child in explicit_children:
113 assert isinstance(child.id_, int)
114 node.steps[child.id_] = make_node(child, False)
115 for id_, step in node.steps.items():
116 walk_steps(id_, step)
118 steps: dict[int, ProcessStepsNode] = {}
119 seen_step_ids: Set[int] = set()
120 if external_owner is None:
121 external_owner = self
122 for step in [s for s in self.explicit_steps
123 if s.parent_step_id is None]:
124 assert isinstance(step.id_, int)
125 new_node = make_node(step, step in external_owner.suppressed_steps)
126 steps[step.id_] = new_node
127 for step_id, step_node in steps.items():
128 walk_steps(step_id, step_node)
131 def set_step_suppressions(self, db_conn: DatabaseConnection,
132 step_ids: list[int]) -> None:
133 """Set self.suppressed_steps from step_ids."""
134 assert isinstance(self.id_, int)
135 db_conn.delete_where('process_step_suppressions', 'process', self.id_)
136 self.suppressed_steps = [ProcessStep.by_id(db_conn, s)
139 def set_steps(self, db_conn: DatabaseConnection,
140 steps: list[ProcessStep]) -> None:
141 """Set self.explicit_steps in bulk.
143 Checks against recursion, and turns into top-level steps any of
144 unknown or non-owned parent.
146 def walk_steps(node: ProcessStep) -> None:
147 if node.step_process_id == self.id_:
148 raise BadFormatException('bad step selection causes recursion')
149 step_process = self.by_id(db_conn, node.step_process_id)
150 for step in step_process.explicit_steps:
153 assert isinstance(self.id_, int)
154 for step in [s for s in self.explicit_steps if s not in steps]:
156 for step in [s for s in steps if s not in self.explicit_steps]:
157 if step.parent_step_id is not None:
159 parent_step = ProcessStep.by_id(db_conn,
161 if parent_step.owner_id != self.id_:
162 step.parent_step_id = None
163 except NotFoundException:
164 step.parent_step_id = None
168 def set_owners(self, db_conn: DatabaseConnection,
169 owner_ids: list[int]) -> None:
170 """Re-set owners to those identified in owner_ids."""
171 owners_old = self.used_as_step_by(db_conn)
172 losers = [o for o in owners_old if o.id_ not in owner_ids]
173 owners_old_ids = [o.id_ for o in owners_old]
174 winners = [Process.by_id(db_conn, id_) for id_ in owner_ids
175 if id_ not in owners_old_ids]
178 steps_to_remove += [s for s in loser.explicit_steps
179 if s.step_process_id == self.id_]
180 for step in steps_to_remove:
182 for winner in winners:
183 assert isinstance(winner.id_, int)
184 assert isinstance(self.id_, int)
185 new_step = ProcessStep(None, winner.id_, self.id_, None)
186 new_explicit_steps = winner.explicit_steps + [new_step]
187 winner.set_steps(db_conn, new_explicit_steps)
189 def save(self, db_conn: DatabaseConnection) -> None:
190 """Add (or re-write) self and connected items to DB."""
191 super().save(db_conn)
192 assert isinstance(self.id_, int)
193 db_conn.delete_where('process_steps', 'owner', self.id_)
194 for step in self.explicit_steps:
197 def remove(self, db_conn: DatabaseConnection) -> None:
198 """Remove from DB, with dependencies.
200 Guard against removal of Processes in use.
202 assert isinstance(self.id_, int)
203 for _ in db_conn.row_where('process_steps', 'step_process', self.id_):
204 raise HandledException('cannot remove Process in use')
205 for _ in db_conn.row_where('todos', 'process', self.id_):
206 raise HandledException('cannot remove Process in use')
207 for step in self.explicit_steps:
209 super().remove(db_conn)
212 class ProcessStep(BaseModel[int]):
213 """Sub-unit of Processes."""
214 table_name = 'process_steps'
215 to_save = ['owner_id', 'step_process_id', 'parent_step_id']
217 def __init__(self, id_: int | None, owner_id: int, step_process_id: int,
218 parent_step_id: int | None) -> None:
219 super().__init__(id_)
220 self.owner_id = owner_id
221 self.step_process_id = step_process_id
222 self.parent_step_id = parent_step_id
224 def save(self, db_conn: DatabaseConnection) -> None:
225 """Update into DB/cache, and owner's .explicit_steps."""
226 super().save(db_conn)
227 owner = Process.by_id(db_conn, self.owner_id)
228 if self not in owner.explicit_steps:
229 for s in [s for s in owner.explicit_steps if s.id_ == self.id_]:
231 owner.explicit_steps += [self]
232 owner.explicit_steps.sort(key=hash)
234 def remove(self, db_conn: DatabaseConnection) -> None:
235 """Remove from DB, and owner's .explicit_steps."""
236 owner = Process.by_id(db_conn, self.owner_id)
237 owner.explicit_steps.remove(self)
238 super().remove(db_conn)