X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=plomtask%2Fdays.py;h=d838039a715677ffb3c9022f82715859d80fd652;hb=2d0d3a138de69e5e09208936ac094b53b0785c0b;hp=8db9f15b7362ede61c70265e4d5eb8a4c2c0c626;hpb=4546631ed7cc59f3e66a1902b28930f955b2b03f;p=plomtask diff --git a/plomtask/days.py b/plomtask/days.py index 8db9f15..d838039 100644 --- a/plomtask/days.py +++ b/plomtask/days.py @@ -1,24 +1,108 @@ -#!/usr/bin/env python3 """Collecting Day and date-related items.""" -from datetime import datetime +from __future__ import annotations +from datetime import datetime, timedelta +from plomtask.exceptions import BadFormatException, NotFoundException +from plomtask.db import DatabaseConnection, BaseModel DATE_FORMAT = '%Y-%m-%d' -class Day: +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: + dt = datetime.strptime(date_str, DATE_FORMAT) + except (ValueError, TypeError) as e: + msg = f'Given date of wrong format: {date_str}' + raise BadFormatException(msg) from e + return dt.strftime(DATE_FORMAT) + + +def todays_date() -> str: + """Return current date in DATE_FORMAT.""" + return datetime.now().strftime(DATE_FORMAT) + + +class Day(BaseModel): """Individual days defined by their dates.""" + table_name = 'days' + to_save = ['comment'] + id_type = str + + def __init__(self, date: str, comment: str = '') -> None: + self.id_: str = valid_date(date) + 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 - def __init__(self, date: str): - self.date = date - self.datetime = datetime.strptime(date, DATE_FORMAT) + @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.""" + 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 id FROM days WHERE id >= ? AND id <= ?' + for row in db_conn.exec(sql, (start_date, end_date)): + days += [cls.by_id(db_conn, row[0])] + days.sort() + if fill_gaps and len(days) > 1: + gapless_days = [] + for i, day in enumerate(days): + gapless_days += [day] + if i < len(days) - 1: + while day.next_date != days[i+1].date: + day = Day(day.next_date) + gapless_days += [day] + days = gapless_days + return days + + @classmethod + def by_id(cls, db_conn: DatabaseConnection, + date: str, create: bool = False) -> Day: + """Retrieve Day by date if in DB (prefer cache), else return None.""" + day, _ = super()._by_id(db_conn, date) + if day: + assert isinstance(day, Day) + return day + 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.""" + return self.id_ @property - def weekday(self): + def weekday(self) -> str: """Return what weekday matches self.date.""" return self.datetime.strftime('%A') - def __eq__(self, other: object): - return isinstance(other, self.__class__) and self.date == other.date + @property + 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) - def __lt__(self, other): - return self.date < other.date + @property + 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) -> None: + """Add (or re-write) self to DB and cache.""" + self.save_core(db_conn, update_with_lastrowid=False)