1 """Collecting Day and date-related items."""
2 from __future__ import annotations
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)
11 class Day(BaseModel[str]):
12 """Individual days defined by their dates."""
14 to_save_simples = ['comment']
15 add_to_dict = ['todos']
16 can_create_by_id = True
18 def __init__(self, date: str, comment: str = '') -> None:
19 id_ = valid_date(date)
21 self.datetime = datetime.strptime(self.date, DATE_FORMAT)
22 self.comment = comment
23 self.todos: list[Todo] = []
25 def __lt__(self, other: Day) -> bool:
26 return self.date < other.date
29 def from_table_row(cls, db_conn: DatabaseConnection, row: Row | list[Any]
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_)
38 def by_id(cls, db_conn: DatabaseConnection, id_: str) -> Day:
39 """Extend BaseModel.by_id
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.
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_)
54 def with_filled_gaps(cls, days: list[Day], start_date: str, end_date: str
56 """In days, fill with (un-stored) Days gaps between start/end_date."""
58 start_date, end_date = valid_date(start_date), valid_date(end_date)
59 if start_date > end_date:
61 days = [d for d in days if d.date >= start_date and d.date <= end_date]
63 if start_date not in [d.date for d in days]:
64 days[:] = [Day(start_date)] + days
65 if end_date not in [d.date for d in days]:
66 days += [Day(end_date)]
69 for i, day in enumerate(days):
72 while day.next_date != days[i+1].date:
73 day = Day(day.next_date)
75 days[:] = gapless_days
79 def date(self) -> str:
80 """Return self.id_ under the assumption it's a date string."""
81 assert isinstance(self.id_, str)
85 def first_of_month(self) -> bool:
86 """Return what month self.date is part of."""
87 assert isinstance(self.id_, str)
88 return self.id_[-2:] == '01'
91 def month_name(self) -> str:
92 """Return what month self.date is part of."""
93 return self.datetime.strftime('%B')
96 def weekday(self) -> str:
97 """Return what weekday matches self.date."""
98 return self.datetime.strftime('%A')
101 def prev_date(self) -> str:
102 """Return date preceding date of this Day."""
103 prev_datetime = self.datetime - timedelta(days=1)
104 return prev_datetime.strftime(DATE_FORMAT)
107 def next_date(self) -> str:
108 """Return date succeeding date of this Day."""
109 next_datetime = self.datetime + timedelta(days=1)
110 return next_datetime.strftime(DATE_FORMAT)
113 def calendarized_todos(self) -> list[Todo]:
114 """Return only those of self.todos that have .calendarize set."""
115 return [t for t in self.todos if t.calendarize]
118 def total_effort(self) -> float:
119 """"Sum all .performed_effort of self.todos."""
121 for todo in self.todos:
122 total_effort += todo.performed_effort