X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=plomtask%2Fdays.py;h=2531a011f1875a4819337adcd7e59c7a08355af4;hb=5ced0155ad11f5fb87aaa0848402e95f8ff49acd;hp=02ad1a8f5223e1dbaee1ef445fd4e9b211ad4842;hpb=9c3ba57169fdc71d3ffefd4c7c20cae4e89f9c9c;p=plomtask diff --git a/plomtask/days.py b/plomtask/days.py index 02ad1a8..2531a01 100644 --- a/plomtask/days.py +++ b/plomtask/days.py @@ -1,55 +1,112 @@ """Collecting Day and date-related items.""" -from datetime import datetime +from __future__ import annotations +from typing import Any from sqlite3 import Row -from plomtask.misc import HandledException -from plomtask.db import DatabaseConnection +from datetime import datetime, timedelta +from plomtask.exceptions import HandledException +from plomtask.db import DatabaseConnection, BaseModel +from plomtask.todos import Todo +from plomtask.dating import (DATE_FORMAT, valid_date) -DATE_FORMAT = '%Y-%m-%d' - -def date_valid(date: str): - """Validate date against DATE_FORMAT, return Datetime or None.""" - try: - result = datetime.strptime(date, DATE_FORMAT) - except (ValueError, TypeError): - return None - return result - - -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 = '', + init_empty_todo_list: bool = False + ) -> None: + id_ = valid_date(date) + super().__init__(id_) + self.datetime = datetime.strptime(self.date, DATE_FORMAT) + self.comment = comment + self.todos: list[Todo] | None = [] if init_empty_todo_list else None - def __init__(self, date: 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 __lt__(self, other: Day) -> bool: + return self.date < other.date @classmethod - def add(cls, db_conn: DatabaseConnection, date: str): - """Add (or re-write) new Day(date) to database.""" - db_conn.exec('REPLACE INTO days VALUES (?)', (date,)) + def from_table_row(cls, db_conn: DatabaseConnection, row: Row | list[Any] + ) -> Day: + """Make from DB row, with linked Todos.""" + day = super().from_table_row(db_conn, row) + assert isinstance(day.id_, str) + day.todos = Todo.by_date(db_conn, day.id_) + return day @classmethod - def from_table_row(cls, row: Row): - """Make new Day from database row.""" - return cls(row[0]) + def by_date_range_filled(cls, db_conn: DatabaseConnection, + start: str, end: str) -> list[Day]: + """Return days existing and non-existing between dates start/end.""" + ret = cls.by_date_range_with_limits(db_conn, (start, end), 'id') + days, start_date, end_date = ret + return cls.with_filled_gaps(days, start_date, end_date) @classmethod - def all(cls, db_conn: DatabaseConnection): - """Return list of all Days in database.""" - days = [] - for row in db_conn.exec('SELECT * FROM days'): - days += [cls.from_table_row(row)] + def with_filled_gaps(cls, days: list[Day], start_date: str, end_date: str + ) -> list[Day]: + """In days, fill with (un-saved) Days gaps between start/end_date.""" + if start_date > end_date: + return days + days.sort() + if start_date not in [d.date for d in days]: + days[:] = [Day(start_date, init_empty_todo_list=True)] + days + if end_date not in [d.date for d in days]: + days += [Day(end_date, init_empty_todo_list=True)] + 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, init_empty_todo_list=True) + gapless_days += [day] + days[:] = gapless_days return days @property - def weekday(self): + 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.""" 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) + + @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 __lt__(self, other): - return self.date < other.date + @property + def calendarized_todos(self) -> list[Todo]: + """Return only those of self.todos that have .calendarize set.""" + if self.todos is None: + msg = 'Trying to return from un-initialized Day.todos.' + raise HandledException(msg) + # pylint: disable=not-an-iterable + # (after the above is-None test, self.todos _should_ be iterable!) + return [t for t in self.todos if t.calendarize]