plomlompom.com Git - plomtask/blob - 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 from plomtask.todos import Todo
   7
   8 DATE_FORMAT = '%Y-%m-%d'
   9 MIN_RANGE_DATE = '2024-01-01'
  10 MAX_RANGE_DATE = '2030-12-31'
  11
  12
  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()
  17     try:
  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)
  23
  24
  25 def todays_date() -> str:
  26     """Return current date in DATE_FORMAT."""
  27     return datetime.now().strftime(DATE_FORMAT)
  28
  29
  30 class Day(BaseModel[str]):
  31     """Individual days defined by their dates."""
  32     table_name = 'days'
  33     to_save = ['comment']
  34
  35     def __init__(self, date: str, comment: str = '') -> None:
  36         id_ = valid_date(date)
  37         super().__init__(id_)
  38         self.datetime = datetime.strptime(self.date, DATE_FORMAT)
  39         self.comment = comment
  40         self.calendarized_todos: list[Todo] = []
  41
  42     def __lt__(self, other: Day) -> bool:
  43         return self.date < other.date
  44
  45     @classmethod
  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.
  50
  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.
  53
  54         On fill_gaps=True, will instantiate (without saving) Days of all dates
  55         within the date range that don't exist yet.
  56         """
  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)
  61         days = []
  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])]
  65         days.sort()
  66         if fill_gaps:
  67             if start_date not in [d.date for d in days]:
  68                 days = [Day(start_date)] + days
  69             if end_date not in [d.date for d in days]:
  70                 days += [Day(end_date)]
  71             if len(days) > 1:
  72                 gapless_days = []
  73                 for i, day in enumerate(days):
  74                     gapless_days += [day]
  75                     if i < len(days) - 1:
  76                         while day.next_date != days[i+1].date:
  77                             day = Day(day.next_date)
  78                             gapless_days += [day]
  79                 days = gapless_days
  80         return days
  81
  82     @property
  83     def date(self) -> str:
  84         """Return self.id_ under the assumption it's a date string."""
  85         assert isinstance(self.id_, str)
  86         return self.id_
  87
  88     @property
  89     def first_of_month(self) -> bool:
  90         """Return what month self.date is part of."""
  91         assert isinstance(self.id_, str)
  92         return self.id_[-2:] == '01'
  93
  94     @property
  95     def month_name(self) -> str:
  96         """Return what month self.date is part of."""
  97         return self.datetime.strftime('%B')
  98
  99     @property
 100     def weekday(self) -> str:
 101         """Return what weekday matches self.date."""
 102         return self.datetime.strftime('%A')
 103
 104     @property
 105     def prev_date(self) -> str:
 106         """Return date preceding date of this Day."""
 107         prev_datetime = self.datetime - timedelta(days=1)
 108         return prev_datetime.strftime(DATE_FORMAT)
 109
 110     @property
 111     def next_date(self) -> str:
 112         """Return date succeeding date of this Day."""
 113         next_datetime = self.datetime + timedelta(days=1)
 114         return next_datetime.strftime(DATE_FORMAT)
 115
 116     def collect_calendarized_todos(self, db_conn: DatabaseConnection) -> None:
 117         """Fill self.calendarized_todos."""
 118         self.calendarized_todos = [t for t in Todo.by_date(db_conn, self.date)
 119                                    if t.calendarize]