Merge pull request #107 from lsst-sqre/tickets/DM-51083

DM-51083: Fix handling of relative days/weeks/years

Author: jonathansick

CHANGELOG.md

@@ -8,6 +8,20 @@ Collect fragments into this file with: scriv collect --version X.Y.Z
 
 <!-- scriv-insert-here -->
 
+<a id='changelog-0.21.1'></a>
+
+## 0.21.1 (2025-05-30)
+
+### Bug fixes
+
+- The `dynamic_default` date syntax for a relative number of weeks/months/years from the current date didn't work in the 0.21.0 release. We fixed that feature and changed the syntax to use `w`, `m`, and `y` for weeks, months, and years respectively. This syntax is similar to how relative numbers of days are treated (for example, `+5d` for 5 days from now). Some examples:
+
+  - `dynamic_default: 1w` for one week from now
+  - `dynamic_default: -2m` for two months ago
+  - `dynamic_default: 3y` for three years from now
+
+  The promised syntax of `dynamic_default: +1week` from the 0.21.0 release is no longer supported. The `week_end` / `week_start` syntax still uses the full words rather than the first letter abbreviations.
+
 <a id='changelog-0.21.0'></a>
 
 ## 0.21.0 (2025-05-29)

src/timessquare/domain/pageparameters/_datedynamicdefault.py

@@ -8,7 +8,7 @@
 
 
 DYNAMIC_DATE_PATTERN = re.compile(
-    r"^(?:(?P<sign>[+-])(?P<offset>\d+)(?P<base>d|(?:week|month|year)_(?:start|end)))|"
+    r"^(?:(?P<sign>[+-])(?P<offset>\d+)(?P<base>(?:week|month|year)_(?:start|end)|d|w|m|y))|"
     r"(?P<simple>today|yesterday|tomorrow|(?:week|month|year)_(?:start|end))$"
 )
 """Pattern for dynamic date default configurations."""
@@ -22,8 +22,8 @@ class DateDynamicDefault:
     config_value : str
         The dynamic default value in the format defined by
         `DYNAMIC_DATE_PATTERN`. It can be a simple value like "today",
-        "yesterday", "tomorrow", or a more complex expression like "+7d" or
-        "-1month_start".
+        "yesterday", "tomorrow", or a more complex expression like "+7d",
+        "+2w", "+3m", "+1y", or "-1month_start".
     """
 
     def __init__(self, config_value: str) -> None:
@@ -81,7 +81,7 @@ def __call__(self, current_date: date | None = None) -> date:
         # Handle complex patterns
         return self._compute_complex_date(current_date)
 
-    def _compute_complex_date(self, current_date: date) -> date:  # noqa: C901
+    def _compute_complex_date(self, current_date: date) -> date:  # noqa: C901,PLR0912
         """Compute dates for complex patterns."""
         match = DYNAMIC_DATE_PATTERN.match(self.config_value)
         if not match:
@@ -105,6 +105,12 @@ def _compute_complex_date(self, current_date: date) -> date:  # noqa: C901
         match base:
             case "d":
                 return self._add_days(current_date, offset)
+            case "w":
+                return self._add_days(current_date, offset * 7)
+            case "m":
+                return self._add_months(current_date, offset)
+            case "y":
+                return self._add_years(current_date, offset)
             case "week_start":
                 return self._compute_week_start(current_date, offset)
             case "week_end":
@@ -196,3 +202,12 @@ def _add_months(base_date: date, months: int) -> date:
             return base_date.replace(
                 year=new_year, month=new_month, day=last_day
             )
+
+    @staticmethod
+    def _add_years(base_date: date, years: int) -> date:
+        """Add years to a date."""
+        try:
+            return base_date.replace(year=base_date.year + years)
+        except ValueError:
+            # Handle leap year edge case (Feb 29 + 1 year)
+            return base_date.replace(year=base_date.year + years, day=28)

tests/domain/pageparameters_test.py

@@ -417,6 +417,71 @@ def now(cls, tz: timezone | None = None) -> datetime:
         )
         assert schema_minus_1_year_end.default == date(2024, 12, 31)
 
+        # Test short-form week patterns
+        schema_plus_2w = create_and_validate_parameter_schema(
+            "myvar",
+            {
+                "type": "string",
+                "format": "date",
+                "X-Dynamic-Default": "+2w",
+            },
+        )
+        assert schema_plus_2w.default == date(2025, 1, 15)  # 2 weeks = 14 days
+
+        schema_minus_3w = create_and_validate_parameter_schema(
+            "myvar",
+            {
+                "type": "string",
+                "format": "date",
+                "X-Dynamic-Default": "-3w",
+            },
+        )
+        assert schema_minus_3w.default == date(
+            2024, 12, 11
+        )  # 3 weeks = 21 days ago
+
+        # Test short-form month patterns
+        schema_plus_2m = create_and_validate_parameter_schema(
+            "myvar",
+            {
+                "type": "string",
+                "format": "date",
+                "X-Dynamic-Default": "+2m",
+            },
+        )
+        assert schema_plus_2m.default == date(2025, 3, 1)  # 2 months later
+
+        schema_minus_1m = create_and_validate_parameter_schema(
+            "myvar",
+            {
+                "type": "string",
+                "format": "date",
+                "X-Dynamic-Default": "-1m",
+            },
+        )
+        assert schema_minus_1m.default == date(2024, 12, 1)  # 1 month ago
+
+        # Test short-form year patterns
+        schema_plus_1y = create_and_validate_parameter_schema(
+            "myvar",
+            {
+                "type": "string",
+                "format": "date",
+                "X-Dynamic-Default": "+1y",
+            },
+        )
+        assert schema_plus_1y.default == date(2026, 1, 1)  # 1 year later
+
+        schema_minus_2y = create_and_validate_parameter_schema(
+            "myvar",
+            {
+                "type": "string",
+                "format": "date",
+                "X-Dynamic-Default": "-2y",
+            },
+        )
+        assert schema_minus_2y.default == date(2023, 1, 1)  # 2 years ago
+
 
 def test_date_parameter_dynamic_default_validation() -> None:
     """Test validation of X-Dynamic-Default values."""
@@ -427,6 +492,12 @@ def test_date_parameter_dynamic_default_validation() -> None:
         "tomorrow",
         "+5d",
         "-10d",
+        "+2w",
+        "-3w",
+        "+1m",
+        "-6m",
+        "+1y",
+        "-2y",
         "week_start",
         "week_end",
         "+2week_start",
@@ -458,6 +529,15 @@ def test_date_parameter_dynamic_default_validation() -> None:
         "d",  # missing sign and offset
         "+d",  # missing offset
         "5d",  # missing sign
+        "w",  # missing sign and offset
+        "+w",  # missing offset
+        "5w",  # missing sign
+        "m",  # missing sign and offset
+        "+m",  # missing offset
+        "3m",  # missing sign
+        "y",  # missing sign and offset
+        "+y",  # missing offset
+        "2y",  # missing sign
         "week",  # incomplete
         "month",  # incomplete
         "year",  # incomplete