Refactor from_table_row methods of core DB models.

[plomtask] / plomtask / db.py

diff --git a/plomtask/db.py b/plomtask/db.py
index 4a82132ff9e89d990c5d3f04f1b4f7395bfb0fda..2cc1d64d54576a46a0b9c7edb513abaa28d4008e 100644 (file)
--- a/plomtask/db.py
+++ b/plomtask/db.py
@@ -1,7 +1,7 @@
 """Database management."""
 from os.path import isfile
 from difflib import Differ
-from sqlite3 import connect as sql_connect, Cursor
+from sqlite3 import connect as sql_connect, Cursor, Row
 from typing import Any, Dict
 from plomtask.exceptions import HandledException
 
@@ -23,7 +23,7 @@ class DatabaseFile:  # pylint: disable=too-few-public-methods
         self._check()
 
     def _check(self) -> None:
-        """Check file exists and is of proper schema."""
+        """Check file exists, and is of proper schema."""
         self.exists = isfile(self.path)
         if self.exists:
             self._validate_schema()
@@ -66,3 +66,41 @@ class DatabaseConnection:
     def close(self) -> None:
         """Close DB connection."""
         self.conn.close()
+
+
+class BaseModel:
+    """Template for most of the models we use/derive from the DB."""
+    table_name = ''
+    to_save: list[str] = []
+    id_: None | int | str
+    id_type: type[Any] = int
+
+    @classmethod
+    def from_table_row(cls, db_conn: DatabaseConnection, row: Row) -> Any:
+        """Make from DB row, write to DB cache."""
+        obj = cls(*row)
+        assert isinstance(obj.id_, cls.id_type)
+        cache = getattr(db_conn, f'cached_{cls.table_name}')
+        cache[obj.id_] = obj
+        return obj
+
+    def set_int_id(self, id_: int | None) -> None:
+        """Set id_ if >= 1 or None, else fail."""
+        if (id_ is not None) and id_ < 1:
+            msg = f'illegal {self.__class__.__name__} ID, must be >=1: {id_}'
+            raise HandledException(msg)
+        self.id_ = id_
+
+    def save_core(self, db_conn: DatabaseConnection,
+                  update_with_lastrowid: bool = True) -> None:
+        """Write bare-bones self (sans connected items), ensuring self.id_."""
+        q_marks = ','.join(['?'] * (len(self.to_save) + 1))
+        values = tuple([self.id_] + [getattr(self, key)
+                                     for key in self.to_save])
+        table_name = self.table_name
+        cursor = db_conn.exec(f'REPLACE INTO {table_name} VALUES ({q_marks})',
+                              values)
+        if update_with_lastrowid:
+            self.id_ = cursor.lastrowid
+        cache = getattr(db_conn, f'cached_{table_name}')
+        cache[self.id_] = self