home · contact · privacy
8dd384349bd1419a16b19971ee4d9aa81deff796
[plomtask] / plomtask / days.py
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
7 DATE_FORMAT = '%Y-%m-%d'
8 MIN_RANGE_DATE = '2024-01-01'
9 MAX_RANGE_DATE = '2030-12-31'
10
11
12 def valid_date(date_str: str) -> str:
13     """Validate date against DATE_FORMAT or 'today', return in DATE_FORMAT."""
14     if date_str == 'today':
15         date_str = todays_date()
16     try:
17         dt = datetime.strptime(date_str, DATE_FORMAT)
18     except (ValueError, TypeError) as e:
19         msg = f'Given date of wrong format: {date_str}'
20         raise BadFormatException(msg) from e
21     return dt.strftime(DATE_FORMAT)
22
23
24 def todays_date() -> str:
25     """Return current date in DATE_FORMAT."""
26     return datetime.now().strftime(DATE_FORMAT)
27
28
29 class Day(BaseModel[str]):
30     """Individual days defined by their dates."""
31     table_name = 'days'
32     to_save = ['comment']
33
34     def __init__(self, date: str, comment: str = '') -> None:
35         id_ = valid_date(date)
36         super().__init__(id_)
37         self.datetime = datetime.strptime(self.date, DATE_FORMAT)
38         self.comment = comment
39
40     def __lt__(self, other: Day) -> bool:
41         return self.date < other.date
42
43     @classmethod
44     def all(cls, db_conn: DatabaseConnection,
45             date_range: tuple[str, str] = ('', ''),
46             fill_gaps: bool = False) -> list[Day]:
47         """Return list of Days in database within (open) date_range interval.
48
49         If no range values provided, defaults them to MIN_RANGE_DATE and
50         MAX_RANGE_DATE. Also knows to properly interpret 'today' as value.
51
52         On fill_gaps=True, will instantiate (without saving) Days of all dates
53         within the date range that don't exist yet.
54         """
55         min_date = '2024-01-01'
56         max_date = '2030-12-31'
57         start_date = valid_date(date_range[0] if date_range[0] else min_date)
58         end_date = valid_date(date_range[1] if date_range[1] else max_date)
59         days = []
60         sql = 'SELECT id FROM days WHERE id >= ? AND id <= ?'
61         for row in db_conn.exec(sql, (start_date, end_date)):
62             days += [cls.by_id(db_conn, row[0])]
63         days.sort()
64         if fill_gaps and len(days) > 1:
65             gapless_days = []
66             for i, day in enumerate(days):
67                 gapless_days += [day]
68                 if i < len(days) - 1:
69                     while day.next_date != days[i+1].date:
70                         day = Day(day.next_date)
71                         gapless_days += [day]
72             days = gapless_days
73         return days
74
75     @property
76     def date(self) -> str:
77         """Return self.id_ under the assumption it's a date string."""
78         assert isinstance(self.id_, str)
79         return self.id_
80
81     @property
82     def weekday(self) -> str:
83         """Return what weekday matches self.date."""
84         return self.datetime.strftime('%A')
85
86     @property
87     def prev_date(self) -> str:
88         """Return date preceding date of this Day."""
89         prev_datetime = self.datetime - timedelta(days=1)
90         return prev_datetime.strftime(DATE_FORMAT)
91
92     @property
93     def next_date(self) -> str:
94         """Return date succeeding date of this Day."""
95         next_datetime = self.datetime + timedelta(days=1)
96         return next_datetime.strftime(DATE_FORMAT)
97
98     def save(self, db_conn: DatabaseConnection) -> None:
99         """Add (or re-write) self to DB and cache."""
100         self.save_core(db_conn)