Improve Days tests.

[plomtask] / plomtask / db.py

diff --git a/plomtask/db.py b/plomtask/db.py
index 34b5887c0204532ea6a32ade0eed6ccea92fbbaa..3a661d37758f579a9cac09dc90b86f07f0572e04 100644 (file)
--- a/plomtask/db.py
+++ b/plomtask/db.py
@@ -179,27 +179,26 @@ class BaseModel(Generic[BaseModelId]):
         obj.cache()
         return obj
 
-    @classmethod
-    def _by_id(cls, db_conn: DatabaseConnection,
-               id_: BaseModelId) -> Self | None:
-        """Return instance found by ID, or None, and if from cache or not."""
-        obj = cls.get_cached(id_)
-        if not obj:
-            for row in db_conn.row_where(cls.table_name, 'id', id_):
-                obj = cls.from_table_row(db_conn, row)
-                obj.cache()
-                break
-        return obj
-
     @classmethod
     def by_id(cls, db_conn: DatabaseConnection,
               id_: BaseModelId | None,
               # pylint: disable=unused-argument
               create: bool = False) -> Self:
-        """Retrieve by id_, on failure throw NotFoundException."""
+        """Retrieve by id_, on failure throw NotFoundException.
+
+        First try to get from cls.cache_, only then check DB; if found,
+        put into cache.
+
+        If create=True, make anew (but do not cache yet).
+        """
         obj = None
         if id_ is not None:
-            obj = cls._by_id(db_conn, id_)
+            obj = cls.get_cached(id_)
+            if not obj:
+                for row in db_conn.row_where(cls.table_name, 'id', id_):
+                    obj = cls.from_table_row(db_conn, row)
+                    obj.cache()
+                    break
         if obj:
             return obj
         if create:
@@ -210,7 +209,13 @@ class BaseModel(Generic[BaseModelId]):
     @classmethod
     def all(cls: type[BaseModelInstance],
             db_conn: DatabaseConnection) -> list[BaseModelInstance]:
-        """Collect all objects of class."""
+        """Collect all objects of class into list.
+
+        Note that this primarily returns the contents of the cache, and only
+        _expands_ that by additional findings in the DB. This assumes the
+        cache is always instantly cleaned of any items that would be removed
+        from the DB.
+        """
         items: dict[BaseModelId, BaseModelInstance] = {}
         for k, v in cls.get_cache().items():
             assert isinstance(v, cls)
@@ -255,7 +260,7 @@ class BaseModel(Generic[BaseModelId]):
         self.cache()
 
     def remove(self, db_conn: DatabaseConnection) -> None:
-        """Remove from DB."""
+        """Remove from DB and cache."""
         assert isinstance(self.id_, int | str)
         self.uncache()
         db_conn.delete_where(self.table_name, 'id', self.id_)