home · contact · privacy
Improve Days tests.
[plomtask] / plomtask / days.py
index 9f3aa697a831758d0635109446a35e73428b7181..8dd384349bd1419a16b19971ee4d9aa81deff796 100644 (file)
@@ -5,6 +5,8 @@ from plomtask.exceptions import BadFormatException
 from plomtask.db import DatabaseConnection, BaseModel
 
 DATE_FORMAT = '%Y-%m-%d'
+MIN_RANGE_DATE = '2024-01-01'
+MAX_RANGE_DATE = '2030-12-31'
 
 
 def valid_date(date_str: str) -> str:
@@ -42,7 +44,14 @@ class Day(BaseModel[str]):
     def all(cls, db_conn: DatabaseConnection,
             date_range: tuple[str, str] = ('', ''),
             fill_gaps: bool = False) -> list[Day]:
-        """Return list of Days in database within date_range."""
+        """Return list of Days in database within (open) date_range interval.
+
+        If no range values provided, defaults them to MIN_RANGE_DATE and
+        MAX_RANGE_DATE. Also knows to properly interpret 'today' as value.
+
+        On fill_gaps=True, will instantiate (without saving) Days of all dates
+        within the date range that don't exist yet.
+        """
         min_date = '2024-01-01'
         max_date = '2030-12-31'
         start_date = valid_date(date_range[0] if date_range[0] else min_date)