Put mypy into strict mode, adapt code to still pass.

[plomtask] / plomtask / db.py

diff --git a/plomtask/db.py b/plomtask/db.py
index b7291dba4245852097f7dc3146e9b1d6d355bbcf..e0a5d4f5df5426512c8a7552ca889c598dcaabfe 100644 (file)
--- a/plomtask/db.py
+++ b/plomtask/db.py
@@ -1,33 +1,34 @@
 """Database management."""
 from os.path import isfile
 from difflib import Differ
-from sqlite3 import connect as sql_connect
+from sqlite3 import connect as sql_connect, Cursor
+from typing import Any
 from plomtask.misc import HandledException
 
 PATH_DB_SCHEMA = 'scripts/init.sql'
 
 
-class DatabaseFile:
+class DatabaseFile:  # pylint: disable=too-few-public-methods
     """Represents the sqlite3 database's file."""
 
-    def __init__(self, path):
+    def __init__(self, path: str) -> None:
         self.path = path
-        self.check()
+        self._check()
 
-    def check(self):
-        """Check file exists and is of proper schema."""
-        self.exists = isfile(self.path)
-        if self.exists:
-            self.validate_schema()
-
-    def remake(self):
+    def remake(self) -> None:
         """Create tables in self.path file as per PATH_DB_SCHEMA sql file."""
         with sql_connect(self.path) as conn:
             with open(PATH_DB_SCHEMA, 'r', encoding='utf-8') as f:
                 conn.executescript(f.read())
-        self.check()
+        self._check()
+
+    def _check(self) -> None:
+        """Check file exists and is of proper schema."""
+        self.exists = isfile(self.path)
+        if self.exists:
+            self._validate_schema()
 
-    def validate_schema(self):
+    def _validate_schema(self) -> None:
         """Compare found schema with what's stored at PATH_DB_SCHEMA."""
         sql_for_schema = 'SELECT sql FROM sqlite_master ORDER BY sql'
         msg_err = 'Database has wrong tables schema. Diff:\n'
@@ -40,3 +41,23 @@ class DatabaseFile:
                     diff_msg = Differ().compare(retrieved_schema.splitlines(),
                                                 stored_schema.splitlines())
                     raise HandledException(msg_err + '\n'.join(diff_msg))
+
+
+class DatabaseConnection:
+    """A single connection to the database."""
+
+    def __init__(self, db_file: DatabaseFile) -> None:
+        self.file = db_file
+        self.conn = sql_connect(self.file.path)
+
+    def commit(self) -> None:
+        """Commit SQL transaction."""
+        self.conn.commit()
+
+    def exec(self, code: str, inputs: tuple[Any, ...] = tuple()) -> Cursor:
+        """Add commands to SQL transaction."""
+        return self.conn.execute(code, inputs)
+
+    def close(self) -> None:
+        """Close DB connection."""
+        self.conn.close()