plomlompom.com Git - plomtask/blob - plomtask/processes.py

   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,
  10                                  HandledException)
  11
  12
  13 @dataclass
  14 class ProcessStepsNode:
  15     """Collects what's useful to know for ProcessSteps tree display."""
  16     process: Process
  17     parent_id: int | None
  18     is_explicit: bool
  19     steps: dict[int, ProcessStepsNode]
  20     seen: bool = False
  21     is_suppressed: bool = False
  22
  23
  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     add_to_dict = ['explicit_steps']
  37     to_search = ['title.newest', 'description.newest']
  38     can_create_by_id = True
  39     sorters = {'steps': lambda p: len(p.explicit_steps),
  40                'owners': lambda p: p.n_owners,
  41                'effort': lambda p: p.effort.newest,
  42                'title': lambda p: p.title.newest}
  43
  44     def __init__(self, id_: int | None, calendarize: bool = False) -> None:
  45         BaseModel.__init__(self, id_)
  46         ConditionsRelations.__init__(self)
  47         self.title = VersionedAttribute(self, 'process_titles', 'UNNAMED')
  48         self.description = VersionedAttribute(self, 'process_descriptions', '')
  49         self.effort = VersionedAttribute(self, 'process_efforts', 1.0)
  50         self.explicit_steps: list[ProcessStep] = []
  51         self.suppressed_steps: list[ProcessStep] = []
  52         self.calendarize = calendarize
  53         self.n_owners: int | None = None  # only set by from_table_row
  54
  55     @classmethod
  56     def from_table_row(cls, db_conn: DatabaseConnection,
  57                        row: Row | list[Any]) -> Process:
  58         """Make from DB row, with dependencies."""
  59         process = super().from_table_row(db_conn, row)
  60         assert process.id_ is not None
  61         for name in ('conditions', 'blockers', 'enables', 'disables'):
  62             table = f'process_{name}'
  63             assert isinstance(process.id_, int)
  64             for c_id in db_conn.column_where(table, 'condition',
  65                                              'process', process.id_):
  66                 target = getattr(process, name)
  67                 target += [Condition.by_id(db_conn, c_id)]
  68         for row_ in db_conn.row_where('process_steps', 'owner', process.id_):
  69             step = ProcessStep.from_table_row(db_conn, row_)
  70             process.explicit_steps += [step]
  71         for row_ in db_conn.row_where('process_step_suppressions', 'process',
  72                                       process.id_):
  73             step = ProcessStep.by_id(db_conn, row_[1])
  74             process.suppressed_steps += [step]
  75         process.n_owners = len(process.used_as_step_by(db_conn))
  76         return process
  77
  78     def used_as_step_by(self, db_conn: DatabaseConnection) -> list[Process]:
  79         """Return Processes using self for a ProcessStep."""
  80         if not self.id_:
  81             return []
  82         owner_ids = set()
  83         for id_ in db_conn.column_where('process_steps', 'owner',
  84                                         'step_process', self.id_):
  85             owner_ids.add(id_)
  86         return [self.__class__.by_id(db_conn, id_) for id_ in owner_ids]
  87
  88     def get_steps(self, db_conn: DatabaseConnection, external_owner:
  89                   Process | None = None) -> dict[int, ProcessStepsNode]:
  90         """Return tree of depended-on explicit and implicit ProcessSteps."""
  91
  92         def make_node(step: ProcessStep, suppressed: bool) -> ProcessStepsNode:
  93             is_explicit = False
  94             if external_owner is not None:
  95                 is_explicit = step.owner_id == external_owner.id_
  96             process = self.__class__.by_id(db_conn, step.step_process_id)
  97             step_steps = {}
  98             if not suppressed:
  99                 step_steps = process.get_steps(db_conn, external_owner)
 100             return ProcessStepsNode(process, step.parent_step_id,
 101                                     is_explicit, step_steps, False, suppressed)
 102
 103         def walk_steps(node_id: int, node: ProcessStepsNode) -> None:
 104             node.seen = node_id in seen_step_ids
 105             seen_step_ids.add(node_id)
 106             if node.is_suppressed:
 107                 return
 108             explicit_children = [s for s in self.explicit_steps
 109                                  if s.parent_step_id == node_id]
 110             for child in explicit_children:
 111                 assert isinstance(child.id_, int)
 112                 node.steps[child.id_] = make_node(child, False)
 113             for id_, step in node.steps.items():
 114                 walk_steps(id_, step)
 115
 116         steps: dict[int, ProcessStepsNode] = {}
 117         seen_step_ids: Set[int] = set()
 118         if external_owner is None:
 119             external_owner = self
 120         for step in [s for s in self.explicit_steps
 121                      if s.parent_step_id is None]:
 122             assert isinstance(step.id_, int)
 123             new_node = make_node(step, step in external_owner.suppressed_steps)
 124             steps[step.id_] = new_node
 125         for step_id, step_node in steps.items():
 126             walk_steps(step_id, step_node)
 127         return steps
 128
 129     def set_step_suppressions(self, db_conn: DatabaseConnection,
 130                               step_ids: list[int]) -> None:
 131         """Set self.suppressed_steps from step_ids."""
 132         assert isinstance(self.id_, int)
 133         db_conn.delete_where('process_step_suppressions', 'process', self.id_)
 134         self.suppressed_steps = [ProcessStep.by_id(db_conn, s)
 135                                  for s in step_ids]
 136
 137     def set_steps(self, db_conn: DatabaseConnection,
 138                   steps: list[ProcessStep]) -> None:
 139         """Set self.explicit_steps in bulk.
 140
 141         Checks against recursion, and turns into top-level steps any of
 142         unknown or non-owned parent.
 143         """
 144         def walk_steps(node: ProcessStep) -> None:
 145             if node.step_process_id == self.id_:
 146                 raise BadFormatException('bad step selection causes recursion')
 147             step_process = self.by_id(db_conn, node.step_process_id)
 148             for step in step_process.explicit_steps:
 149                 walk_steps(step)
 150
 151         assert isinstance(self.id_, int)
 152         for step in [s for s in self.explicit_steps if s not in steps]:
 153             step.remove(db_conn)
 154         for step in [s for s in steps if s not in self.explicit_steps]:
 155             if step.parent_step_id is not None:
 156                 try:
 157                     parent_step = ProcessStep.by_id(db_conn,
 158                                                     step.parent_step_id)
 159                     if parent_step.owner_id != self.id_:
 160                         step.parent_step_id = None
 161                 except NotFoundException:
 162                     step.parent_step_id = None
 163             walk_steps(step)
 164             step.save(db_conn)
 165
 166     def set_owners(self, db_conn: DatabaseConnection,
 167                    owner_ids: list[int]) -> None:
 168         """Re-set owners to those identified in owner_ids."""
 169         owners_old = self.used_as_step_by(db_conn)
 170         losers = [o for o in owners_old if o.id_ not in owner_ids]
 171         owners_old_ids = [o.id_ for o in owners_old]
 172         winners = [Process.by_id(db_conn, id_) for id_ in owner_ids
 173                    if id_ not in owners_old_ids]
 174         steps_to_remove = []
 175         for loser in losers:
 176             steps_to_remove += [s for s in loser.explicit_steps
 177                                 if s.step_process_id == self.id_]
 178         for step in steps_to_remove:
 179             step.remove(db_conn)
 180         for winner in winners:
 181             assert isinstance(winner.id_, int)
 182             assert isinstance(self.id_, int)
 183             new_step = ProcessStep(None, winner.id_, self.id_, None)
 184             new_explicit_steps = winner.explicit_steps + [new_step]
 185             winner.set_steps(db_conn, new_explicit_steps)
 186
 187     def save(self, db_conn: DatabaseConnection) -> None:
 188         """Add (or re-write) self and connected items to DB."""
 189         super().save(db_conn)
 190         assert isinstance(self.id_, int)
 191         db_conn.delete_where('process_steps', 'owner', self.id_)
 192         for step in self.explicit_steps:
 193             step.save(db_conn)
 194
 195     def remove(self, db_conn: DatabaseConnection) -> None:
 196         """Remove from DB, with dependencies.
 197
 198         Guard against removal of Processes in use.
 199         """
 200         assert isinstance(self.id_, int)
 201         for _ in db_conn.row_where('process_steps', 'step_process', self.id_):
 202             raise HandledException('cannot remove Process in use')
 203         for _ in db_conn.row_where('todos', 'process', self.id_):
 204             raise HandledException('cannot remove Process in use')
 205         for step in self.explicit_steps:
 206             step.remove(db_conn)
 207         super().remove(db_conn)
 208
 209
 210 class ProcessStep(BaseModel[int]):
 211     """Sub-unit of Processes."""
 212     table_name = 'process_steps'
 213     to_save = ['owner_id', 'step_process_id', 'parent_step_id']
 214
 215     def __init__(self, id_: int | None, owner_id: int, step_process_id: int,
 216                  parent_step_id: int | None) -> None:
 217         super().__init__(id_)
 218         self.owner_id = owner_id
 219         self.step_process_id = step_process_id
 220         self.parent_step_id = parent_step_id
 221
 222     def save(self, db_conn: DatabaseConnection) -> None:
 223         """Update into DB/cache, and owner's .explicit_steps."""
 224         super().save(db_conn)
 225         owner = Process.by_id(db_conn, self.owner_id)
 226         if self not in owner.explicit_steps:
 227             for s in [s for s in owner.explicit_steps if s.id_ == self.id_]:
 228                 s.remove(db_conn)
 229             owner.explicit_steps += [self]
 230         owner.explicit_steps.sort(key=hash)
 231
 232     def remove(self, db_conn: DatabaseConnection) -> None:
 233         """Remove from DB, and owner's .explicit_steps."""
 234         owner = Process.by_id(db_conn, self.owner_id)
 235         owner.explicit_steps.remove(self)
 236         super().remove(db_conn)