1 """Collecting Day and date-related items."""
2 from __future__ import annotations
3 from datetime import datetime, timedelta
4 from plomtask.exceptions import BadFormatException
5 from plomtask.db import DatabaseConnection, BaseModel
6 from plomtask.todos import Todo
8 DATE_FORMAT = '%Y-%m-%d'
9 MIN_RANGE_DATE = '2024-01-01'
10 MAX_RANGE_DATE = '2030-12-31'
13 def valid_date(date_str: str) -> str:
14 """Validate date against DATE_FORMAT or 'today', return in DATE_FORMAT."""
15 if date_str == 'today':
16 date_str = todays_date()
18 dt = datetime.strptime(date_str, DATE_FORMAT)
19 except (ValueError, TypeError) as e:
20 msg = f'Given date of wrong format: {date_str}'
21 raise BadFormatException(msg) from e
22 return dt.strftime(DATE_FORMAT)
25 def todays_date() -> str:
26 """Return current date in DATE_FORMAT."""
27 return datetime.now().strftime(DATE_FORMAT)
30 class Day(BaseModel[str]):
31 """Individual days defined by their dates."""
35 def __init__(self, date: str, comment: str = '') -> None:
36 id_ = valid_date(date)
38 self.datetime = datetime.strptime(self.date, DATE_FORMAT)
39 self.comment = comment
40 self.calendarized_todos: list[Todo] = []
42 def __lt__(self, other: Day) -> bool:
43 return self.date < other.date
46 def all(cls, db_conn: DatabaseConnection,
47 date_range: tuple[str, str] = ('', ''),
48 fill_gaps: bool = False) -> list[Day]:
49 """Return list of Days in database within (open) date_range interval.
51 If no range values provided, defaults them to MIN_RANGE_DATE and
52 MAX_RANGE_DATE. Also knows to properly interpret 'today' as value.
54 On fill_gaps=True, will instantiate (without saving) Days of all dates
55 within the date range that don't exist yet.
57 min_date = '2024-01-01'
58 max_date = '2030-12-31'
59 start_date = valid_date(date_range[0] if date_range[0] else min_date)
60 end_date = valid_date(date_range[1] if date_range[1] else max_date)
62 sql = 'SELECT id FROM days WHERE id >= ? AND id <= ?'
63 for row in db_conn.exec(sql, (start_date, end_date)):
64 days += [cls.by_id(db_conn, row[0])]
66 if fill_gaps and len(days) > 1:
68 for i, day in enumerate(days):
71 while day.next_date != days[i+1].date:
72 day = Day(day.next_date)
78 def date(self) -> str:
79 """Return self.id_ under the assumption it's a date string."""
80 assert isinstance(self.id_, str)
84 def first_of_month(self) -> bool:
85 """Return what month self.date is part of."""
86 assert isinstance(self.id_, str)
87 return self.id_[-2:] == '01'
90 def month_name(self) -> str:
91 """Return what month self.date is part of."""
92 return self.datetime.strftime('%B')
95 def weekday(self) -> str:
96 """Return what weekday matches self.date."""
97 return self.datetime.strftime('%A')
100 def prev_date(self) -> str:
101 """Return date preceding date of this Day."""
102 prev_datetime = self.datetime - timedelta(days=1)
103 return prev_datetime.strftime(DATE_FORMAT)
106 def next_date(self) -> str:
107 """Return date succeeding date of this Day."""
108 next_datetime = self.datetime + timedelta(days=1)
109 return next_datetime.strftime(DATE_FORMAT)
111 def collect_calendarized_todos(self, db_conn: DatabaseConnection) -> None:
112 """Fill self.calendarized_todos."""
113 self.calendarized_todos = [t for t in Todo.by_date(db_conn, self.date)