X-Git-Url: https://plomlompom.com/repos/%7B%7B%20web_path%20%7D%7D/decks/%7B%7Bdeck_id%7D%7D/cards/%7B%7Bcard_id%7D%7D/form?a=blobdiff_plain;f=plomtask%2Fdays.py;h=d7083b4310bf76c168f6f33d29cf55c8ada7a29f;hb=f92de64d072009c8c4bf96b9eeb9fa245045662b;hp=258d38dbbf1d7f920f36ca06c9f8292506d16807;hpb=7eb81e526c45118a295dbfc12be01f92dc809974;p=plomtask diff --git a/plomtask/days.py b/plomtask/days.py index 258d38d..d7083b4 100644 --- a/plomtask/days.py +++ b/plomtask/days.py @@ -1,27 +1,9 @@ """Collecting Day and date-related items.""" 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' - - -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) +from plomtask.todos import Todo +from plomtask.dating import (DATE_FORMAT, valid_date) class Day(BaseModel[str]): @@ -30,12 +12,11 @@ class Day(BaseModel[str]): to_save = ['comment'] def __init__(self, date: str, comment: str = '') -> None: - self.id_: str = 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 @@ -44,45 +25,47 @@ class Day(BaseModel[str]): 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])] + """Return list of Days in database within (open) date_range interval. + + On fill_gaps=True, will instantiate (without saving) Days of all dates + within the date range that don't exist yet. + """ + ret = cls.by_date_range_with_limits(db_conn, date_range, 'id') + days, start_date, end_date = ret 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 + if fill_gaps: + if start_date not in [d.date for d in days]: + days = [Day(start_date)] + days + if end_date not in [d.date for d in days]: + days += [Day(end_date)] + if 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: - return day - if not create: - raise NotFoundException(f'Day not found for date: {date}') - day = cls(date) - day.cache() - 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: """Return what weekday matches self.date.""" @@ -100,6 +83,7 @@ class Day(BaseModel[str]): 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) + 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]