"""Collecting Day and date-related items."""
-from datetime import datetime
+from __future__ import annotations
+from typing import Any
+from sqlite3 import Row
+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'
-
-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 __lt__(self, other: Day) -> bool:
+ return self.date < other.date
+
+ @classmethod
+ def from_table_row(cls, db_conn: DatabaseConnection, row: Row | list[Any]
+ ) -> Day:
+ """Make from DB row, with linked Todos."""
+ # pylint: disable=protected-access
+ # (since on ._todo we're only meddling within cls)
+ 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 by_id(cls,
+ db_conn: DatabaseConnection, id_: str | None,
+ create: bool = False,
+ init_empty_todo_list: bool = False
+ ) -> Day:
+ """Extend BaseModel.by_id with init_empty_todo_list flag."""
+ # pylint: disable=protected-access
+ # (since on ._todo we're only meddling within cls)
+ day = super().by_id(db_conn, id_, create)
+ if init_empty_todo_list and day._todos is None:
+ day._todos = []
+ 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, 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 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'
- def __init__(self, date: str):
- self.date = date
- self.datetime = datetime.strptime(date, DATE_FORMAT)
+ @property
+ def month_name(self) -> str:
+ """Return what month self.date is part of."""
+ return self.datetime.strftime('%B')
@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)
+
+ @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 todos(self) -> list[Todo]:
+ """Return self.todos if initialized, else raise Exception."""
+ if self._todos is None:
+ msg = 'Trying to return from un-initialized Day.todos.'
+ raise HandledException(msg)
+ return list(self._todos)
+
+ @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
projects / plomtask / blobdiff