plomlompom.com Git - plomtask/blob - plomtask/days.py

   1 """Collecting Day and date-related items."""
   2 from __future__ import annotations
   3 from typing import Any
   4 from sqlite3 import Row
   5 from datetime import datetime, timedelta
   6 from plomtask.db import DatabaseConnection, BaseModel
   7 from plomtask.todos import Todo
   8 from plomtask.dating import (DATE_FORMAT, valid_date)
   9
  10
  11 class Day(BaseModel[str]):
  12     """Individual days defined by their dates."""
  13     table_name = 'days'
  14     to_save = ['comment']
  15     add_to_dict = ['todos']
  16     can_create_by_id = True
  17
  18     def __init__(self, date: str, comment: str = '') -> None:
  19         id_ = valid_date(date)
  20         super().__init__(id_)
  21         self.datetime = datetime.strptime(self.date, DATE_FORMAT)
  22         self.comment = comment
  23         self.todos: list[Todo] = []
  24
  25     def __lt__(self, other: Day) -> bool:
  26         return self.date < other.date
  27
  28     @classmethod
  29     def from_table_row(cls, db_conn: DatabaseConnection, row: Row | list[Any]
  30                        ) -> Day:
  31         """Make from DB row, with linked Todos."""
  32         day = super().from_table_row(db_conn, row)
  33         assert isinstance(day.id_, str)
  34         day.todos = Todo.by_date(db_conn, day.id_)
  35         return day
  36
  37     @classmethod
  38     def by_id(cls, db_conn: DatabaseConnection, id_: str) -> Day:
  39         """Extend BaseModel.by_id
  40
  41         Checks Todo.days_to_update if we need to a retrieved Day's .todos,
  42         and also ensures we're looking for proper dates and not strings like
  43         "yesterday" by enforcing the valid_date translation.
  44         """
  45         assert isinstance(id_, str)
  46         possibly_translated_date = valid_date(id_)
  47         day = super().by_id(db_conn, possibly_translated_date)
  48         if day.id_ in Todo.days_to_update:
  49             Todo.days_to_update.remove(day.id_)
  50             day.todos = Todo.by_date(db_conn, day.id_)
  51         return day
  52
  53     @classmethod
  54     def by_date_range_filled(cls, db_conn: DatabaseConnection,
  55                              start: str, end: str) -> list[Day]:
  56         """Return days existing and non-existing between dates start/end."""
  57         ret = cls.by_date_range_with_limits(db_conn, (start, end), 'id')
  58         days, start_date, end_date = ret
  59         return cls.with_filled_gaps(days, start_date, end_date)
  60
  61     @classmethod
  62     def with_filled_gaps(cls, days: list[Day], start_date: str, end_date: str
  63                          ) -> list[Day]:
  64         """In days, fill with (un-saved) Days gaps between start/end_date."""
  65         if start_date > end_date:
  66             return days
  67         days.sort()
  68         if start_date not in [d.date for d in days]:
  69             days[:] = [Day(start_date)] + days
  70         if end_date not in [d.date for d in days]:
  71             days += [Day(end_date)]
  72         if len(days) > 1:
  73             gapless_days = []
  74             for i, day in enumerate(days):
  75                 gapless_days += [day]
  76                 if i < len(days) - 1:
  77                     while day.next_date != days[i+1].date:
  78                         day = Day(day.next_date)
  79                         gapless_days += [day]
  80             days[:] = gapless_days
  81         return days
  82
  83     @property
  84     def date(self) -> str:
  85         """Return self.id_ under the assumption it's a date string."""
  86         assert isinstance(self.id_, str)
  87         return self.id_
  88
  89     @property
  90     def first_of_month(self) -> bool:
  91         """Return what month self.date is part of."""
  92         assert isinstance(self.id_, str)
  93         return self.id_[-2:] == '01'
  94
  95     @property
  96     def month_name(self) -> str:
  97         """Return what month self.date is part of."""
  98         return self.datetime.strftime('%B')
  99
 100     @property
 101     def weekday(self) -> str:
 102         """Return what weekday matches self.date."""
 103         return self.datetime.strftime('%A')
 104
 105     @property
 106     def prev_date(self) -> str:
 107         """Return date preceding date of this Day."""
 108         prev_datetime = self.datetime - timedelta(days=1)
 109         return prev_datetime.strftime(DATE_FORMAT)
 110
 111     @property
 112     def next_date(self) -> str:
 113         """Return date succeeding date of this Day."""
 114         next_datetime = self.datetime + timedelta(days=1)
 115         return next_datetime.strftime(DATE_FORMAT)
 116
 117     @property
 118     def calendarized_todos(self) -> list[Todo]:
 119         """Return only those of self.todos that have .calendarize set."""
 120         return [t for t in self.todos if t.calendarize]
 121
 122     @property
 123     def total_effort(self) -> float:
 124         """"Sum all .performed_effort of self.todos."""
 125         total_effort = 0.0
 126         for todo in self.todos:
 127             total_effort += todo.performed_effort
 128         return total_effort