X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=plomtask%2Fdays.py;h=0e07bf7aeb8837fc28031d2d924d65d17b0256bd;hb=e60bbd142b5026748ee2181ca6758afef6202fb4;hp=3b81a7f3bf526fd7bc56849558fbfaa451cdbe88;hpb=3558a14701955de18ae7adbda0e93aaee7710a92;p=plomtask diff --git a/plomtask/days.py b/plomtask/days.py index 3b81a7f..0e07bf7 100644 --- a/plomtask/days.py +++ b/plomtask/days.py @@ -1,11 +1,12 @@ """Collecting Day and date-related items.""" from __future__ import annotations from datetime import datetime, timedelta -from sqlite3 import Row -from plomtask.misc import HandledException -from plomtask.db import DatabaseConnection +from plomtask.exceptions import BadFormatException +from plomtask.db import DatabaseConnection, BaseModel DATE_FORMAT = '%Y-%m-%d' +MIN_RANGE_DATE = '2024-01-01' +MAX_RANGE_DATE = '2030-12-31' def valid_date(date_str: str) -> str: @@ -16,7 +17,7 @@ def valid_date(date_str: str) -> str: 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 + raise BadFormatException(msg) from e return dt.strftime(DATE_FORMAT) @@ -25,38 +26,40 @@ def todays_date() -> str: return datetime.now().strftime(DATE_FORMAT) -class Day: +class Day(BaseModel[str]): """Individual days defined by their dates.""" + table_name = 'days' + to_save = ['comment'] def __init__(self, date: str, comment: str = '') -> None: - self.date = valid_date(date) + id_ = valid_date(date) + super().__init__(id_) self.datetime = datetime.strptime(self.date, DATE_FORMAT) self.comment = comment - def __eq__(self, other: object) -> bool: - return isinstance(other, self.__class__) and self.date == other.date - def __lt__(self, other: Day) -> bool: return self.date < other.date - @classmethod - 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) -> list[Day]: - """Return list of Days in database within date_range.""" + """Return list of Days in database within (open) date_range interval. + + If no range values provided, defaults them to MIN_RANGE_DATE and + MAX_RANGE_DATE. Also knows to properly interpret 'today' as value. + + On fill_gaps=True, will instantiate (without saving) Days of all dates + within the date range that don't exist yet. + """ 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 <= ?' + sql = 'SELECT id FROM days WHERE id >= ? AND id <= ?' for row in db_conn.exec(sql, (start_date, end_date)): - days += [cls.from_table_row(row)] + days += [cls.by_id(db_conn, row[0])] days.sort() if fill_gaps and len(days) > 1: gapless_days = [] @@ -69,15 +72,11 @@ class Day: days = gapless_days return days - @classmethod - def by_date(cls, db_conn: DatabaseConnection, - 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 not create: - raise HandledException(f'Day not found for date: {date}') - return cls(date) + @property + def date(self) -> str: + """Return self.id_ under the assumption it's a date string.""" + assert isinstance(self.id_, str) + return self.id_ @property def weekday(self) -> str: @@ -95,8 +94,3 @@ class Day: """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) -> None: - """Add (or re-write) self to database.""" - db_conn.exec('REPLACE INTO days VALUES (?, ?)', - (self.date, self.comment))