"""Collecting Day and date-related items."""
from __future__ import annotations
from datetime import datetime, timedelta
-from plomtask.exceptions import BadFormatException, NotFoundException
+from plomtask.exceptions import BadFormatException
from plomtask.db import DatabaseConnection, BaseModel
+from plomtask.todos import Todo
DATE_FORMAT = '%Y-%m-%d'
+MIN_RANGE_DATE = '2024-01-01'
+MAX_RANGE_DATE = '2030-12-31'
def valid_date(date_str: str) -> str:
return datetime.now().strftime(DATE_FORMAT)
-class Day(BaseModel):
+class Day(BaseModel[str]):
"""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)
+ 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
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."""
+ """Return list of Days in database within (open) date_range interval.
+
+ If no range values provided, defaults them to MIN_RANGE_DATE and
+ MAX_RANGE_DATE. Also knows to properly interpret 'today' as value.
+
+ On fill_gaps=True, will instantiate (without saving) Days of all dates
+ within the date range that don't exist yet.
+ """
min_date = '2024-01-01'
max_date = '2030-12-31'
start_date = valid_date(date_range[0] if date_range[0] else min_date)
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."""
+ 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."""
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]