1 """Collecting Day and date-related items."""
2 from datetime import datetime, timedelta
3 from sqlite3 import Row
4 from plomtask.misc import HandledException
5 from plomtask.db import DatabaseConnection
7 DATE_FORMAT = '%Y-%m-%d'
10 def date_valid(date: str):
11 """Validate date against DATE_FORMAT, return Datetime or None."""
13 result = datetime.strptime(date, DATE_FORMAT)
14 except (ValueError, TypeError):
20 """Return current date in DATE_FORMAT."""
21 return datetime.now().strftime(DATE_FORMAT)
25 """Individual days defined by their dates."""
27 def __init__(self, date: str, comment: str = ''):
29 self.datetime = date_valid(self.date)
31 raise HandledException(f'Given date of wrong format: {self.date}')
32 self.comment = comment
34 def __eq__(self, other: object):
35 return isinstance(other, self.__class__) and self.date == other.date
37 def __lt__(self, other):
38 return self.date < other.date
41 def from_table_row(cls, row: Row):
42 """Make Day from database row."""
43 return cls(row[0], row[1])
46 def all(cls, db_conn: DatabaseConnection,
47 date_range: tuple[str, str] = ('', ''), fill_gaps: bool = False):
48 """Return list of Days in database within date_range."""
49 def date_from_range_str(date_str: str, default: str):
52 elif date_str == 'today':
53 date_str = todays_date()
54 elif not date_valid(date_str):
55 raise HandledException(f'Bad date: {date_str}')
57 start_date = date_from_range_str(date_range[0], '2024-01-01')
58 end_date = date_from_range_str(date_range[1], '2030-01-01')
60 sql = 'SELECT * FROM days WHERE date >= ? AND date <= ?'
61 for row in db_conn.exec(sql, (start_date, end_date)):
62 days += [cls.from_table_row(row)]
64 if fill_gaps and len(days) > 1:
66 for i, day in enumerate(days):
69 while day.next_date != days[i+1].date:
70 day = Day(day.next_date)
76 def by_date(cls, db_conn: DatabaseConnection,
77 date: str, create: bool = False):
78 """Retrieve Day by date if in DB, else return None."""
79 for row in db_conn.exec('SELECT * FROM days WHERE date = ?', (date,)):
80 return cls.from_table_row(row)
87 """Return what weekday matches self.date."""
88 return self.datetime.strftime('%A')
92 """Return date preceding date of this Day."""
93 prev_datetime = self.datetime - timedelta(days=1)
94 return prev_datetime.strftime(DATE_FORMAT)
98 """Return date succeeding date of this Day."""
99 next_datetime = self.datetime + timedelta(days=1)
100 return next_datetime.strftime(DATE_FORMAT)
102 def save(self, db_conn: DatabaseConnection):
103 """Add (or re-write) self to database."""
104 db_conn.exec('REPLACE INTO days VALUES (?, ?)',
105 (self.date, self.comment))