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

[plomtask] / plomtask / days.py

diff --git a/plomtask/days.py b/plomtask/days.py
index 0622f1de7e1871138cd5f77e51693f0ca224d800..3b81a7f3bf526fd7bc56849558fbfaa451cdbe88 100644 (file)
--- a/plomtask/days.py
+++ b/plomtask/days.py
@@ -1,4 +1,5 @@
 """Collecting Day and date-related items."""
+from __future__ import annotations
 from datetime import datetime, timedelta
 from sqlite3 import Row
 from plomtask.misc import HandledException
@@ -7,16 +8,19 @@ from plomtask.db import DatabaseConnection
 DATE_FORMAT = '%Y-%m-%d'
 
 
-def date_valid(date: str):
-    """Validate date against DATE_FORMAT, return Datetime or None."""
+def valid_date(date_str: str) -> str:
+    """Validate date against DATE_FORMAT or 'today', return in DATE_FORMAT."""
+    if date_str == 'today':
+        date_str = todays_date()
     try:
-        result = datetime.strptime(date, DATE_FORMAT)
-    except (ValueError, TypeError):
-        return None
-    return result
+        dt = datetime.strptime(date_str, DATE_FORMAT)
+    except (ValueError, TypeError) as e:
+        msg = f'Given date of wrong format: {date_str}'
+        raise HandledException(msg) from e
+    return dt.strftime(DATE_FORMAT)
 
 
-def todays_date():
+def todays_date() -> str:
     """Return current date in DATE_FORMAT."""
     return datetime.now().strftime(DATE_FORMAT)
 
@@ -24,38 +28,31 @@ def todays_date():
 class Day:
     """Individual days defined by their dates."""
 
-    def __init__(self, date: str, comment: str = ''):
-        self.date = date
-        self.datetime = date_valid(self.date)
-        if not self.datetime:
-            raise HandledException(f'Given date of wrong format: {self.date}')
+    def __init__(self, date: str, comment: str = '') -> None:
+        self.date = valid_date(date)
+        self.datetime = datetime.strptime(self.date, DATE_FORMAT)
         self.comment = comment
 
-    def __eq__(self, other: object):
+    def __eq__(self, other: object) -> bool:
         return isinstance(other, self.__class__) and self.date == other.date
 
-    def __lt__(self, other):
+    def __lt__(self, other: Day) -> bool:
         return self.date < other.date
 
     @classmethod
-    def from_table_row(cls, row: Row):
+    def from_table_row(cls, row: Row) -> Day:
         """Make Day from database row."""
         return cls(row[0], row[1])
 
     @classmethod
     def all(cls, db_conn: DatabaseConnection,
-            date_range: tuple[str, str] = ('', ''), fill_gaps: bool = False):
+            date_range: tuple[str, str] = ('', ''),
+            fill_gaps: bool = False) -> list[Day]:
         """Return list of Days in database within date_range."""
-        def date_from_range_str(date_str: str, default: str):
-            if date_str == '':
-                date_str = default
-            elif date_str == 'today':
-                date_str = todays_date()
-            elif not date_valid(date_str):
-                raise HandledException(f'Bad date: {date_str}')
-            return date_str
-        start_date = date_from_range_str(date_range[0], '2024-01-01')
-        end_date = date_from_range_str(date_range[1], '2030-01-01')
+        min_date = '2024-01-01'
+        max_date = '2030-12-31'
+        start_date = valid_date(date_range[0] if date_range[0] else min_date)
+        end_date = valid_date(date_range[1] if date_range[1] else max_date)
         days = []
         sql = 'SELECT * FROM days WHERE date >= ? AND date <= ?'
         for row in db_conn.exec(sql, (start_date, end_date)):
@@ -74,32 +71,32 @@ class Day:
 
     @classmethod
     def by_date(cls, db_conn: DatabaseConnection,
-                date: str, create: bool = False):
+                date: str, create: bool = False) -> Day:
         """Retrieve Day by date if in DB, else return None."""
         for row in db_conn.exec('SELECT * FROM days WHERE date = ?', (date,)):
             return cls.from_table_row(row)
-        if create:
-            return cls(date)
-        return None
+        if not create:
+            raise HandledException(f'Day not found for date: {date}')
+        return cls(date)
 
     @property
-    def weekday(self):
+    def weekday(self) -> str:
         """Return what weekday matches self.date."""
         return self.datetime.strftime('%A')
 
     @property
-    def prev_date(self):
+    def prev_date(self) -> str:
         """Return date preceding date of this Day."""
         prev_datetime = self.datetime - timedelta(days=1)
         return prev_datetime.strftime(DATE_FORMAT)
 
     @property
-    def next_date(self):
+    def next_date(self) -> str:
         """Return date succeeding date of this Day."""
         next_datetime = self.datetime + timedelta(days=1)
         return next_datetime.strftime(DATE_FORMAT)
 
-    def save(self, db_conn: DatabaseConnection):
+    def save(self, db_conn: DatabaseConnection) -> None:
         """Add (or re-write) self to database."""
         db_conn.exec('REPLACE INTO days VALUES (?, ?)',
                      (self.date, self.comment))