X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=plomtask%2Fdays.py;h=fe1ba44e80e9a1c4182130b870d6d531dc9c9c06;hb=31b778276bb7297151f1c90098cc50842c9c138f;hp=abfce06f51fc7ab43607ccd177dddc2194667391;hpb=6b329a28bb4aec8d1846f5cc5402ed6fca5eb3da;p=plomtask diff --git a/plomtask/days.py b/plomtask/days.py index abfce06..fe1ba44 100644 --- a/plomtask/days.py +++ b/plomtask/days.py @@ -1,11 +1,13 @@ """Collecting Day and date-related items.""" from __future__ import annotations from datetime import datetime, timedelta -from sqlite3 import Row -from plomtask.exceptions import BadFormatException, NotFoundException -from plomtask.db import DatabaseConnection +from plomtask.exceptions import BadFormatException +from plomtask.db import DatabaseConnection, BaseModel +from plomtask.todos import Todo DATE_FORMAT = '%Y-%m-%d' +MIN_RANGE_DATE = '2024-01-01' +MAX_RANGE_DATE = '2030-12-31' def valid_date(date_str: str) -> str: @@ -25,40 +27,41 @@ 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 + self.calendarized_todos: list[Todo] = [] def __lt__(self, other: Day) -> bool: return self.date < other.date - @classmethod - def from_table_row(cls, db_conn: DatabaseConnection, row: Row) -> Day: - """Make Day from database row, write to cache.""" - day = cls(row[0], row[1]) - db_conn.cached_days[day.date] = day - return day - @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 date 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.by_date(db_conn, row[0])] + days += [cls.by_id(db_conn, row[0])] days.sort() if fill_gaps and len(days) > 1: gapless_days = [] @@ -71,22 +74,22 @@ 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 (prefer cache), else return None.""" - if date in db_conn.cached_days.keys(): - day = db_conn.cached_days[date] - assert isinstance(day, Day) - return day - for row in db_conn.exec('SELECT * FROM days WHERE date = ?', (date,)): - return cls.from_table_row(db_conn, row) - if not create: - raise NotFoundException(f'Day not found for date: {date}') - day = cls(date) - db_conn.cached_days[date] = day - assert isinstance(day, Day) - return day + @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 first_of_month(self) -> bool: + """Return what month self.date is part of.""" + assert isinstance(self.id_, str) + return self.id_[-2:] == '01' + + @property + def month_name(self) -> str: + """Return what month self.date is part of.""" + return self.datetime.strftime('%B') @property def weekday(self) -> str: @@ -105,8 +108,7 @@ class 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 DB and cache.""" - db_conn.exec('REPLACE INTO days VALUES (?, ?)', - (self.date, self.comment)) - db_conn.cached_days[self.date] = self + def collect_calendarized_todos(self, db_conn: DatabaseConnection) -> None: + """Fill self.calendarized_todos.""" + self.calendarized_todos = [t for t in Todo.by_date(db_conn, self.date) + if t.calendarize]