"""Collecting Day and date-related items."""
-from datetime import datetime
-from sqlite3 import Row
-from plomtask.misc import HandledException
-from plomtask.db import DatabaseConnection
+from __future__ import annotations
+from datetime import datetime, timedelta
+from plomtask.exceptions import BadFormatException, NotFoundException
+from plomtask.db import DatabaseConnection, BaseModel
DATE_FORMAT = '%Y-%m-%d'
-def date_valid(date: str):
- """Validate date against DATE_FORMAT, return Datetime or None."""
+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:
- result = datetime.strptime(date, DATE_FORMAT)
- except (ValueError, TypeError):
- return None
- return result
+ 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)
-class Day:
+def todays_date() -> str:
+ """Return current date in DATE_FORMAT."""
+ return datetime.now().strftime(DATE_FORMAT)
+
+
+class Day(BaseModel[str]):
"""Individual days defined by their dates."""
+ table_name = 'days'
+ to_save = ['comment']
+ id_type = str
- def __init__(self, date: str, comment: str = ''):
- self.date = date
- self.datetime = date_valid(self.date)
- if not self.datetime:
- raise HandledException(f'Given date of wrong format: {self.date}')
+ def __init__(self, date: str, comment: str = '') -> None:
+ self.id_: str = valid_date(date)
+ self.datetime = datetime.strptime(self.date, DATE_FORMAT)
self.comment = comment
- def __eq__(self, other: object):
+ def __eq__(self, other: object) -> bool:
return isinstance(other, self.__class__) and self.date == other.date
- def __lt__(self, other):
+ def __lt__(self, other: Day) -> bool:
return self.date < other.date
- @classmethod
- def from_table_row(cls, row: Row):
- """Make new Day from database row."""
- return cls(row[0], row[1])
-
@classmethod
def all(cls, db_conn: DatabaseConnection,
- date_range: tuple[str, str] = ('', '')):
+ date_range: tuple[str, str] = ('', ''),
+ fill_gaps: bool = False) -> list[Day]:
"""Return list of Days in database within date_range."""
- start_date = date_range[0] if date_range[0] else '2024-01-01'
- end_date = date_range[1] if date_range[1] else '2030-12-31'
+ 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 * FROM days WHERE date >= ? AND date <= ?'
+ sql = 'SELECT id FROM days WHERE id >= ? AND id <= ?'
for row in db_conn.exec(sql, (start_date, end_date)):
- days += [cls.from_table_row(row)]
+ days += [cls.by_id(db_conn, row[0])]
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
return days
@classmethod
- def by_date(cls, db_conn: DatabaseConnection,
- date: str, create: bool = False):
- """Retrieve Day by date if in DB, else return None."""
- for row in db_conn.exec('SELECT * FROM days WHERE date = ?', (date,)):
- return cls.from_table_row(row)
- if create:
- return cls(date)
- return None
+ def by_id(cls, db_conn: DatabaseConnection,
+ date: str, create: bool = False) -> Day:
+ """Retrieve Day by date if in DB (prefer cache), else return None."""
+ day, _ = super()._by_id(db_conn, date)
+ if day:
+ assert isinstance(day, Day)
+ return day
+ if not create:
+ raise NotFoundException(f'Day not found for date: {date}')
+ day = cls(date)
+ day.cache()
+ assert isinstance(day, Day)
+ return day
+
+ @property
+ def date(self) -> str:
+ """Return self.id_ under the assumption it's a date string."""
+ return self.id_
@property
- def weekday(self):
+ def weekday(self) -> str:
"""Return what weekday matches self.date."""
return self.datetime.strftime('%A')
- def save(self, db_conn: DatabaseConnection):
- """Add (or re-write) self to database."""
- db_conn.exec('REPLACE INTO days VALUES (?, ?)',
- (self.date, self.comment))
+ @property
+ def prev_date(self) -> str:
+ """Return date preceding date of this Day."""
+ prev_datetime = self.datetime - timedelta(days=1)
+ return prev_datetime.strftime(DATE_FORMAT)
+
+ @property
+ def next_date(self) -> str:
+ """Return date succeeding date of this Day."""
+ 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)
projects / plomtask / blobdiff