"""Collecting Day and date-related items."""
from __future__ import annotations
from datetime import datetime, timedelta
-from sqlite3 import Row
-from plomtask.exceptions import BadFormatException, NotFoundException
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 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)
-
-
-class Day(BaseModel):
+class Day(BaseModel[str]):
"""Individual days defined by their dates."""
table_name = 'days'
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
- @classmethod
- def from_table_row(cls, db_conn: DatabaseConnection, row: Row) -> Day:
- """Make Day from database row, write to cache."""
- day = cls(row[0], row[1])
- db_conn.cached_days[day.date] = day
- return day
-
@classmethod
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 date FROM days WHERE date >= ? AND date <= ?'
- for row in db_conn.exec(sql, (start_date, end_date)):
- days += [cls.by_date(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_date(cls, db_conn: DatabaseConnection,
- date: str, create: bool = False) -> Day:
- """Retrieve Day by date if in DB (prefer cache), else return None."""
- if date in db_conn.cached_days.keys():
- day = db_conn.cached_days[date]
- assert isinstance(day, Day)
- return day
- for row in db_conn.exec('SELECT * FROM days WHERE date = ?', (date,)):
- return cls.from_table_row(db_conn, row)
- 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]
projects / plomtask / blobdiff