X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=plomtask%2Fdays.py;h=23201301bbe792042a361d3f970415c622d80627;hb=HEAD;hp=89c957eef7ee49746e079d91ac3db3fa8d178760;hpb=ab5a23f86261ef74b00fd77ff198275bac6b82fd;p=plomtask diff --git a/plomtask/days.py b/plomtask/days.py index 89c957e..2320130 100644 --- a/plomtask/days.py +++ b/plomtask/days.py @@ -1,71 +1,128 @@ """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.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'] + add_to_dict = ['todos'] + can_create_by_id = True - def __init__(self, date: str, comment: 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 __init__(self, date: str, comment: str = '') -> None: + id_ = valid_date(date) + super().__init__(id_) + self.datetime = datetime.strptime(self.date, DATE_FORMAT) self.comment = comment + self.todos: list[Todo] = [] - def __eq__(self, other: object): - return isinstance(other, self.__class__) and self.date == other.date - - def __lt__(self, other): + def __lt__(self, other: Day) -> bool: return self.date < other.date @classmethod - def from_table_row(cls, row: Row): - """Make new Day from database row.""" - return cls(row[0], row[1]) + 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 all(cls, db_conn: DatabaseConnection, - date_range: tuple[str, str] = ('', '')): - """Return list of Days in database within date_range.""" - start_date = date_range[0] if date_range[0] else '2024-01-01' - end_date = date_range[1] if date_range[1] else '2030-12-31' - days = [] - sql = 'SELECT * FROM days WHERE date >= ? AND date <= ?' - for row in db_conn.exec(sql, (start_date, end_date)): - days += [cls.from_table_row(row)] + def by_id(cls, db_conn: DatabaseConnection, id_: str) -> Day: + """Extend BaseModel.by_id + + Checks Todo.days_to_update if we need to a retrieved Day's .todos, + and also ensures we're looking for proper dates and not strings like + "yesterday" by enforcing the valid_date translation. + """ + assert isinstance(id_, str) + possibly_translated_date = valid_date(id_) + day = super().by_id(db_conn, possibly_translated_date) + if day.id_ in Todo.days_to_update: + Todo.days_to_update.remove(day.id_) + day.todos = Todo.by_date(db_conn, day.id_) + return day + + @classmethod + 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 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)] + 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_date(cls, db_conn: DatabaseConnection, - date: str, create: bool = False): - """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 create: - return cls(date) - return None + @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): + 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 save(self, db_conn: DatabaseConnection): - """Add (or re-write) self to database.""" - db_conn.exec('REPLACE INTO days VALUES (?, ?)', - (self.date, self.comment)) + @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) + + @property + def calendarized_todos(self) -> list[Todo]: + """Return only those of self.todos that have .calendarize set.""" + return [t for t in self.todos if t.calendarize] + + @property + def total_effort(self) -> float: + """"Sum all .performed_effort of self.todos.""" + total_effort = 0.0 + for todo in self.todos: + total_effort += todo.performed_effort + return total_effort