"""Collecting Processes and Process-related items."""
from __future__ import annotations
+from dataclasses import dataclass
+from typing import Set, Any
from sqlite3 import Row
-from datetime import datetime
-from typing import Any, Set
-from plomtask.db import DatabaseConnection
-from plomtask.exceptions import NotFoundException, BadFormatException
+from plomtask.db import DatabaseConnection, BaseModel
+from plomtask.versioned_attributes import VersionedAttribute
+from plomtask.conditions import Condition, ConditionsRelations
+from plomtask.exceptions import (NotFoundException, BadFormatException,
+ HandledException)
-class Process:
- """Template for, and metadata for, Todos, and their arrangements."""
+@dataclass
+class ProcessStepsNode:
+ """Collects what's useful to know for ProcessSteps tree display."""
+ process: Process
+ parent_id: int | None
+ is_explicit: bool
+ steps: dict[int, ProcessStepsNode]
+ seen: bool = False
+ is_suppressed: bool = False
- def __init__(self, id_: int | None) -> None:
- if (id_ is not None) and id_ < 1:
- raise BadFormatException(f'illegal Process ID, must be >=1: {id_}')
- self.id_ = id_
- self.title = VersionedAttribute(self, 'title', 'UNNAMED')
- self.description = VersionedAttribute(self, 'description', '')
- self.effort = VersionedAttribute(self, 'effort', 1.0)
- self.explicit_steps: list[ProcessStep] = []
- @classmethod
- def from_table_row(cls, db_conn: DatabaseConnection, row: Row) -> Process:
- """Make Process from database row, with empty VersionedAttributes."""
- process = cls(row[0])
- assert process.id_ is not None
- db_conn.cached_processes[process.id_] = process
- return process
+class Process(BaseModel[int], ConditionsRelations):
+ """Template for, and metadata for, Todos, and their arrangements."""
+ # pylint: disable=too-many-instance-attributes
+ table_name = 'processes'
+ to_save = ['calendarize']
+ to_save_versioned = ['title', 'description', 'effort']
+ to_save_relations = [('process_conditions', 'process', 'conditions', 0),
+ ('process_blockers', 'process', 'blockers', 0),
+ ('process_enables', 'process', 'enables', 0),
+ ('process_disables', 'process', 'disables', 0),
+ ('process_step_suppressions', 'process',
+ 'suppressed_steps', 0)]
+ to_search = ['title.newest', 'description.newest']
+
+ def __init__(self, id_: int | None, calendarize: bool = False) -> None:
+ BaseModel.__init__(self, id_)
+ ConditionsRelations.__init__(self)
+ self.title = VersionedAttribute(self, 'process_titles', 'UNNAMED')
+ self.description = VersionedAttribute(self, 'process_descriptions', '')
+ self.effort = VersionedAttribute(self, 'process_efforts', 1.0)
+ self.explicit_steps: list[ProcessStep] = []
+ self.suppressed_steps: list[ProcessStep] = []
+ self.calendarize = calendarize
+ self.n_owners: int | None = None # only set by from_table_row
- @classmethod
- def all(cls, db_conn: DatabaseConnection) -> list[Process]:
- """Collect all Processes and their connected VersionedAttributes."""
- processes = {}
- for id_, process in db_conn.cached_processes.items():
- processes[id_] = process
- already_recorded = processes.keys()
- for row in db_conn.exec('SELECT id FROM processes'):
- if row[0] not in already_recorded:
- process = cls.by_id(db_conn, row[0])
- processes[process.id_] = process
- return list(processes.values())
+ @property
+ def as_dict(self) -> dict[str, object]:
+ """Return self as (json.dumps-coompatible) dict."""
+ d = super().as_dict
+ d['explicit_steps'] = [s.as_dict for s in self.explicit_steps]
+ d['suppressed_steps'] = [s.as_dict for s in self.suppressed_steps]
+ return d
@classmethod
- def by_id(cls, db_conn: DatabaseConnection, id_: int | None,
- create: bool = False) -> Process:
- """Collect Process, its VersionedAttributes, and its child IDs."""
- if id_ in db_conn.cached_processes.keys():
- process = db_conn.cached_processes[id_]
- assert isinstance(process, Process)
- return process
- process = None
- for row in db_conn.exec('SELECT * FROM processes '
- 'WHERE id = ?', (id_,)):
- process = cls(row[0])
- break
- if not process:
- if not create:
- raise NotFoundException(f'Process not found of id: {id_}')
- process = Process(id_)
- if process:
- for row in db_conn.exec('SELECT * FROM process_titles '
- 'WHERE process_id = ?', (process.id_,)):
- process.title.history[row[1]] = row[2]
- for row in db_conn.exec('SELECT * FROM process_descriptions '
- 'WHERE process_id = ?', (process.id_,)):
- process.description.history[row[1]] = row[2]
- for row in db_conn.exec('SELECT * FROM process_efforts '
- 'WHERE process_id = ?', (process.id_,)):
- process.effort.history[row[1]] = row[2]
- for row in db_conn.exec('SELECT * FROM process_steps '
- 'WHERE owner_id = ?', (process.id_,)):
- process.explicit_steps += [ProcessStep.from_table_row(db_conn,
- row)]
- assert isinstance(process, Process)
+ def from_table_row(cls, db_conn: DatabaseConnection,
+ row: Row | list[Any]) -> Process:
+ """Make from DB row, with dependencies."""
+ process = super().from_table_row(db_conn, row)
+ assert isinstance(process.id_, int)
+ for name in ('title', 'description', 'effort'):
+ table = f'process_{name}s'
+ for row_ in db_conn.row_where(table, 'parent', process.id_):
+ getattr(process, name).history_from_row(row_)
+ for name in ('conditions', 'blockers', 'enables', 'disables'):
+ table = f'process_{name}'
+ assert isinstance(process.id_, int)
+ for c_id in db_conn.column_where(table, 'condition',
+ 'process', process.id_):
+ target = getattr(process, name)
+ target += [Condition.by_id(db_conn, c_id)]
+ for row_ in db_conn.row_where('process_steps', 'owner', process.id_):
+ step = ProcessStep.from_table_row(db_conn, row_)
+ process.explicit_steps += [step]
+ for row_ in db_conn.row_where('process_step_suppressions', 'process',
+ process.id_):
+ step = ProcessStep.by_id(db_conn, row_[1])
+ process.suppressed_steps += [step]
+ process.n_owners = len(process.used_as_step_by(db_conn))
return process
def used_as_step_by(self, db_conn: DatabaseConnection) -> list[Process]:
"""Return Processes using self for a ProcessStep."""
+ if not self.id_:
+ return []
owner_ids = set()
- for owner_id in db_conn.exec('SELECT owner_id FROM process_steps WHERE'
- ' step_process_id = ?', (self.id_,)):
- owner_ids.add(owner_id[0])
+ for id_ in db_conn.column_where('process_steps', 'owner',
+ 'step_process', self.id_):
+ owner_ids.add(id_)
return [self.__class__.by_id(db_conn, id_) for id_ in owner_ids]
def get_steps(self, db_conn: DatabaseConnection, external_owner:
- Process | None = None) -> dict[int, dict[str, object]]:
+ Process | None = None) -> dict[int, ProcessStepsNode]:
"""Return tree of depended-on explicit and implicit ProcessSteps."""
- def make_node(step: ProcessStep) -> dict[str, object]:
- step_process = self.__class__.by_id(db_conn, step.step_process_id)
+ def make_node(step: ProcessStep, suppressed: bool) -> ProcessStepsNode:
is_explicit = False
if external_owner is not None:
is_explicit = step.owner_id == external_owner.id_
- step_steps = step_process.get_steps(db_conn, external_owner)
- return {'process': step_process, 'parent_id': step.parent_step_id,
- 'is_explicit': is_explicit, 'steps': step_steps}
-
- def walk_steps(node_id: int, node: dict[str, Any]) -> None:
+ process = self.__class__.by_id(db_conn, step.step_process_id)
+ step_steps = {}
+ if not suppressed:
+ step_steps = process.get_steps(db_conn, external_owner)
+ return ProcessStepsNode(process, step.parent_step_id,
+ is_explicit, step_steps, False, suppressed)
+
+ def walk_steps(node_id: int, node: ProcessStepsNode) -> None:
+ node.seen = node_id in seen_step_ids
+ seen_step_ids.add(node_id)
+ if node.is_suppressed:
+ return
explicit_children = [s for s in self.explicit_steps
if s.parent_step_id == node_id]
for child in explicit_children:
- node['steps'][child.id_] = make_node(child)
- node['seen'] = node_id in seen_step_ids
- seen_step_ids.add(node_id)
- for id_, step in node['steps'].items():
+ assert isinstance(child.id_, int)
+ node.steps[child.id_] = make_node(child, False)
+ for id_, step in node.steps.items():
walk_steps(id_, step)
- steps: dict[int, dict[str, object]] = {}
+ steps: dict[int, ProcessStepsNode] = {}
seen_step_ids: Set[int] = set()
if external_owner is None:
external_owner = self
for step in [s for s in self.explicit_steps
if s.parent_step_id is None]:
- assert step.id_ is not None # for mypy
- steps[step.id_] = make_node(step)
+ assert isinstance(step.id_, int)
+ new_node = make_node(step, step in external_owner.suppressed_steps)
+ steps[step.id_] = new_node
for step_id, step_node in steps.items():
walk_steps(step_id, step_node)
return steps
- def add_step(self, db_conn: DatabaseConnection, id_: int | None,
- step_process_id: int,
- parent_step_id: int | None) -> ProcessStep:
- """Create new ProcessStep, save and add it to self.explicit_steps.
+ def set_step_suppressions(self, db_conn: DatabaseConnection,
+ step_ids: list[int]) -> None:
+ """Set self.suppressed_steps from step_ids."""
+ assert isinstance(self.id_, int)
+ db_conn.delete_where('process_step_suppressions', 'process', self.id_)
+ self.suppressed_steps = [ProcessStep.by_id(db_conn, s)
+ for s in step_ids]
+
+ def set_steps(self, db_conn: DatabaseConnection,
+ steps: list[ProcessStep]) -> None:
+ """Set self.explicit_steps in bulk.
- Also checks against step recursion.
- The new step's parent_step_id will fall back to None either if no
- matching ProcessStep is found (which can be assumed in case it was
- just deleted under its feet), or if the parent step would not be
- owned by the current Process.
+ Checks against recursion, and turns into top-level steps any of
+ unknown or non-owned parent.
"""
def walk_steps(node: ProcessStep) -> None:
if node.step_process_id == self.id_:
step_process = self.by_id(db_conn, node.step_process_id)
for step in step_process.explicit_steps:
walk_steps(step)
- if parent_step_id is not None:
- try:
- parent_step = ProcessStep.by_id(db_conn, parent_step_id)
- if parent_step.owner_id != self.id_:
- parent_step_id = None
- except NotFoundException:
- parent_step_id = None
- assert self.id_ is not None
- step = ProcessStep(id_, self.id_, step_process_id, parent_step_id)
- walk_steps(step)
- self.explicit_steps += [step]
- step.save(db_conn) # NB: This ensures a non-None step.id_.
- return step
-
- def save_without_steps(self, db_conn: DatabaseConnection) -> None:
- """Add (or re-write) self and connected VersionedAttributes to DB."""
- cursor = db_conn.exec('REPLACE INTO processes VALUES (?)', (self.id_,))
- self.id_ = cursor.lastrowid
- self.title.save(db_conn)
- self.description.save(db_conn)
- self.effort.save(db_conn)
- assert self.id_ is not None
- db_conn.cached_processes[self.id_] = self
- def fix_steps(self, db_conn: DatabaseConnection) -> None:
- """Rewrite ProcessSteps from self.explicit_steps.
-
- This also fixes illegal Step.parent_step_id values, i.e. those pointing
- to steps now absent, or owned by a different Process, fall back into
- .parent_step_id=None
- """
- db_conn.exec('DELETE FROM process_steps WHERE owner_id = ?',
- (self.id_,))
- for step in self.explicit_steps:
+ assert isinstance(self.id_, int)
+ for step in [s for s in self.explicit_steps if s not in steps]:
+ step.remove(db_conn)
+ for step in [s for s in steps if s not in self.explicit_steps]:
if step.parent_step_id is not None:
try:
parent_step = ProcessStep.by_id(db_conn,
step.parent_step_id = None
except NotFoundException:
step.parent_step_id = None
+ walk_steps(step)
+ step.save(db_conn)
+
+ def set_owners(self, db_conn: DatabaseConnection,
+ owner_ids: list[int]) -> None:
+ """Re-set owners to those identified in owner_ids."""
+ owners_old = self.used_as_step_by(db_conn)
+ losers = [o for o in owners_old if o.id_ not in owner_ids]
+ owners_old_ids = [o.id_ for o in owners_old]
+ winners = [Process.by_id(db_conn, id_) for id_ in owner_ids
+ if id_ not in owners_old_ids]
+ steps_to_remove = []
+ for loser in losers:
+ steps_to_remove += [s for s in loser.explicit_steps
+ if s.step_process_id == self.id_]
+ for step in steps_to_remove:
+ step.remove(db_conn)
+ for winner in winners:
+ assert isinstance(winner.id_, int)
+ assert isinstance(self.id_, int)
+ new_step = ProcessStep(None, winner.id_, self.id_, None)
+ new_explicit_steps = winner.explicit_steps + [new_step]
+ winner.set_steps(db_conn, new_explicit_steps)
+
+ def save(self, db_conn: DatabaseConnection) -> None:
+ """Add (or re-write) self and connected items to DB."""
+ super().save(db_conn)
+ assert isinstance(self.id_, int)
+ db_conn.delete_where('process_steps', 'owner', self.id_)
+ for step in self.explicit_steps:
step.save(db_conn)
+ def remove(self, db_conn: DatabaseConnection) -> None:
+ """Remove from DB, with dependencies.
+
+ Guard against removal of Processes in use.
+ """
+ assert isinstance(self.id_, int)
+ for _ in db_conn.row_where('process_steps', 'step_process', self.id_):
+ raise HandledException('cannot remove Process in use')
+ for _ in db_conn.row_where('todos', 'process', self.id_):
+ raise HandledException('cannot remove Process in use')
+ for step in self.explicit_steps:
+ step.remove(db_conn)
+ super().remove(db_conn)
+
-class ProcessStep:
+class ProcessStep(BaseModel[int]):
"""Sub-unit of Processes."""
+ table_name = 'process_steps'
+ to_save = ['owner_id', 'step_process_id', 'parent_step_id']
def __init__(self, id_: int | None, owner_id: int, step_process_id: int,
parent_step_id: int | None) -> None:
- self.id_ = id_
+ super().__init__(id_)
self.owner_id = owner_id
self.step_process_id = step_process_id
self.parent_step_id = parent_step_id
- @classmethod
- def from_table_row(cls, db_conn: DatabaseConnection,
- row: Row) -> ProcessStep:
- """Make ProcessStep from database row, store in DB cache."""
- step = cls(row[0], row[1], row[2], row[3])
- assert step.id_ is not None
- db_conn.cached_process_steps[step.id_] = step
- return step
-
- @classmethod
- def by_id(cls, db_conn: DatabaseConnection, id_: int) -> ProcessStep:
- """Retrieve ProcessStep by id_, or throw NotFoundException."""
- if id_ in db_conn.cached_process_steps.keys():
- step = db_conn.cached_process_steps[id_]
- assert isinstance(step, ProcessStep)
- return step
- for row in db_conn.exec('SELECT * FROM process_steps '
- 'WHERE step_id = ?', (id_,)):
- return cls.from_table_row(db_conn, row)
- raise NotFoundException(f'found no ProcessStep of ID {id_}')
-
- def save(self, db_conn: DatabaseConnection) -> None:
- """Save to database and cache."""
- cursor = db_conn.exec('REPLACE INTO process_steps VALUES (?, ?, ?, ?)',
- (self.id_, self.owner_id, self.step_process_id,
- self.parent_step_id))
- self.id_ = cursor.lastrowid
- assert self.id_ is not None
- db_conn.cached_process_steps[self.id_] = self
-
-
-class VersionedAttribute:
- """Attributes whose values are recorded as a timestamped history."""
-
- def __init__(self,
- parent: Process, name: str, default: str | float) -> None:
- self.parent = parent
- self.name = name
- self.default = default
- self.history: dict[str, str | float] = {}
-
- @property
- def _newest_timestamp(self) -> str:
- """Return most recent timestamp."""
- return sorted(self.history.keys())[-1]
-
- @property
- def newest(self) -> str | float:
- """Return most recent value, or self.default if self.history empty."""
- if 0 == len(self.history):
- return self.default
- return self.history[self._newest_timestamp]
-
- def set(self, value: str | float) -> None:
- """Add to self.history if and only if not same value as newest one."""
- if 0 == len(self.history) \
- or value != self.history[self._newest_timestamp]:
- self.history[datetime.now().strftime('%Y-%m-%d %H:%M:%S')] = value
-
- def at(self, queried_time: str) -> str | float:
- """Retrieve value of timestamp nearest queried_time from the past."""
- sorted_timestamps = sorted(self.history.keys())
- if 0 == len(sorted_timestamps):
- return self.default
- selected_timestamp = sorted_timestamps[0]
- for timestamp in sorted_timestamps[1:]:
- if timestamp > queried_time:
- break
- selected_timestamp = timestamp
- return self.history[selected_timestamp]
-
def save(self, db_conn: DatabaseConnection) -> None:
- """Save as self.history entries, but first wipe old ones."""
- db_conn.exec(f'DELETE FROM process_{self.name}s WHERE process_id = ?',
- (self.parent.id_,))
- for timestamp, value in self.history.items():
- db_conn.exec(f'INSERT INTO process_{self.name}s VALUES (?, ?, ?)',
- (self.parent.id_, timestamp, value))
+ """Update into DB/cache, and owner's .explicit_steps."""
+ super().save(db_conn)
+ owner = Process.by_id(db_conn, self.owner_id)
+ if self not in owner.explicit_steps:
+ for s in [s for s in owner.explicit_steps if s.id_ == self.id_]:
+ s.remove(db_conn)
+ owner.explicit_steps += [self]
+ owner.explicit_steps.sort(key=hash)
+
+ def remove(self, db_conn: DatabaseConnection) -> None:
+ """Remove from DB, and owner's .explicit_steps."""
+ owner = Process.by_id(db_conn, self.owner_id)
+ owner.explicit_steps.remove(self)
+ super().remove(db_conn)