home · contact · privacy
Move VersionedAttributes code into appropriotely named module.
[plomtask] / plomtask / conditions.py
1 """Non-doable elements of ProcessStep/Todo chains."""
2 from __future__ import annotations
3 from typing import Any
4 from sqlite3 import Row
5 from plomtask.db import DatabaseConnection, BaseModel
6 from plomtask.versioned_attributes import VersionedAttribute
7 from plomtask.exceptions import HandledException
8
9
10 class Condition(BaseModel[int]):
11     """Non-Process dependency for ProcessSteps and Todos."""
12     table_name = 'conditions'
13     to_save = ['is_active']
14
15     def __init__(self, id_: int | None, is_active: bool = False) -> None:
16         super().__init__(id_)
17         self.is_active = is_active
18         self.title = VersionedAttribute(self, 'condition_titles', 'UNNAMED')
19         self.description = VersionedAttribute(self, 'condition_descriptions',
20                                               '')
21
22     @classmethod
23     def from_table_row(cls, db_conn: DatabaseConnection,
24                        row: Row | list[Any]) -> Condition:
25         """Build condition from row, including VersionedAttributes."""
26         condition = super().from_table_row(db_conn, row)
27         for name in ('title', 'description'):
28             table_name = f'condition_{name}s'
29             for row_ in db_conn.row_where(table_name, 'parent', row[0]):
30                 getattr(condition, name).history_from_row(row_)
31         return condition
32
33     def save(self, db_conn: DatabaseConnection) -> None:
34         """Save self and its VersionedAttributes to DB and cache."""
35         self.save_core(db_conn)
36         self.title.save(db_conn)
37         self.description.save(db_conn)
38
39     def remove(self, db_conn: DatabaseConnection) -> None:
40         """Remove from DB, with dependencies."""
41         assert isinstance(self.id_, int)
42         for item in ('process', 'todo'):
43             for attr in ('conditions', 'enables', 'disables'):
44                 table_name = f'{item}_{attr}'
45                 for _ in db_conn.row_where(table_name, 'condition', self.id_):
46                     raise HandledException('cannot remove Condition in use')
47         db_conn.delete_where('condition_titles', 'parent', self.id_)
48         db_conn.delete_where('condition_descriptions', 'parent', self.id_)
49         super().remove(db_conn)
50
51
52 class ConditionsRelations:
53     """Methods for handling relations to Conditions, for Todo and Process."""
54
55     def set_conditions(self, db_conn: DatabaseConnection, ids: list[int],
56                        target: str = 'conditions') -> None:
57         """Set self.[target] to Conditions identified by ids."""
58         target_list = getattr(self, target)
59         while len(target_list) > 0:
60             target_list.pop()
61         for id_ in ids:
62             target_list += [Condition.by_id(db_conn, id_)]
63
64     def set_enables(self, db_conn: DatabaseConnection,
65                     ids: list[int]) -> None:
66         """Set self.enables to Conditions identified by ids."""
67         self.set_conditions(db_conn, ids, 'enables')
68
69     def set_disables(self, db_conn: DatabaseConnection,
70                      ids: list[int]) -> None:
71         """Set self.disables to Conditions identified by ids."""
72         self.set_conditions(db_conn, ids, 'disables')