home · contact · privacy
Add basic date ranging to Day.all().
[plomtask] / plomtask / days.py
1 """Collecting Day and date-related items."""
2 from datetime import datetime
3 from sqlite3 import Row
4 from plomtask.misc import HandledException
5 from plomtask.db import DatabaseConnection
6
7 DATE_FORMAT = '%Y-%m-%d'
8
9
10 def date_valid(date: str):
11     """Validate date against DATE_FORMAT, return Datetime or None."""
12     try:
13         result = datetime.strptime(date, DATE_FORMAT)
14     except (ValueError, TypeError):
15         return None
16     return result
17
18
19 class Day:
20     """Individual days defined by their dates."""
21
22     def __init__(self, date: str):
23         self.date = date
24         self.datetime = date_valid(self.date)
25         if not self.datetime:
26             raise HandledException(f'Given date of wrong format: {self.date}')
27
28     def save(self, db_conn: DatabaseConnection):
29         """Add (or re-write) self to database."""
30         db_conn.exec('REPLACE INTO days VALUES (?)', (self.date,))
31
32     @classmethod
33     def from_table_row(cls, row: Row):
34         """Make new Day from database row."""
35         return cls(row[0])
36
37     @classmethod
38     def all(cls, db_conn: DatabaseConnection,
39             date_range: tuple[str, str] = ('', '')):
40         """Return list of Days in database within date_range."""
41         start_date = date_range[0] if date_range[0] else '2024-01-01'
42         end_date = date_range[1] if date_range[1] else '2030-12-31'
43         days = []
44         sql = 'SELECT * FROM days WHERE date >= ? AND date <= ?'
45         for row in db_conn.exec(sql, (start_date, end_date)):
46             days += [cls.from_table_row(row)]
47         days.sort()
48         return days
49
50     @property
51     def weekday(self):
52         """Return what weekday matches self.date."""
53         return self.datetime.strftime('%A')
54
55     def __eq__(self, other: object):
56         return isinstance(other, self.__class__) and self.date == other.date
57
58     def __lt__(self, other):
59         return self.date < other.date