policyengine 6.2.6__tar.gz → 6.3.0__tar.gz

{policyengine-6.2.6 → policyengine-6.3.0}/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [6.3.0] - 2026-10-12
+
+### Added
+
+- Added the UK Budget reform contract (`policyengine.tax_benefit_models.uk.budget_reform_contract`), version 1.0.0. `run_budget_reform_contract()` checks that dated reforms (an April rate change, a finite change, an extended freeze, an April uprating schedule, a mid-year blended rate, a CPI-driven indexation change, a scenario or policy combining a parameter-setting modifier with dated changes, an unknown path, and each route's documented key readings) give independently derived results through the policyengine-uk and policyengine.py routes, leave the baseline and later unreformed runs unchanged, and survive bounded property sampling. It returns a JSON report for release qualification.
+
+
+## [6.2.7] - 2026-10-12
+
+### Fixed
+
+- Align UK household and population reform routes with policy effective dates and inclusive date intervals, reject ambiguous bare-year keys, and pass parameter reforms at country-model construction so dated changes are reprocessed when supported by policyengine-uk. A UK policy or dynamic carrying both parameter values and a simulation modifier (as a `Policy` or `Dynamic` sum does) now applies its values and then its modifier, where the modifier used to replace the values.
+
+
 ## [6.2.6] - 2026-10-10
 
 ### Changed

{policyengine-6.2.6/src/policyengine.egg-info → policyengine-6.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: policyengine
-Version: 6.2.6
+Version: 6.3.0
 Summary: A package to conduct policy analysis using PolicyEngine tax-benefit models.
 Author-email: PolicyEngine <hello@policyengine.org>
 License:                     GNU AFFERO GENERAL PUBLIC LICENSE

{policyengine-6.2.6 → policyengine-6.3.0}/docs/households.md

@@ -150,7 +150,7 @@ Scale parameters use bracket indexing:
 reform = {"gov.irs.credits.ctc.amount.base[0].amount": 3_000}
 ```
 
-Time-varying reforms use a nested dict of `YYYY-MM-DD → value`:
+Time-varying reforms use a nested dict of date keys to values:
 
 ```python
 reform = {
@@ -161,6 +161,10 @@ reform = {
 }
 ```
 
+For UK households, a `YYYY-MM-DD` key is effective from that date until the next value for the same parameter, or December 31, 2100 if no later value follows. A `YYYY-MM-DD.YYYY-MM-DD` key applies over that inclusive interval. Scalar values default to January 1 of `year`.
+
+UK households reject bare years such as `"2027"` or `2027`, because the underlying packages assign different meanings to them. Use `"2027-04-06.2028-04-05"` for one UK fiscal year or `"2027-01-01"` for an effective date. See [Reforms](reforms.md) for the shared `Simulation(policy=...)` and `Simulation(dynamic=...)` date contract. The US household route retains its country package's period-key handling.
+
 Structural reforms (new variables, formula swaps) require the `Simulation` path — see [Reforms](reforms.md).
 
 ## Year

{policyengine-6.2.6 → policyengine-6.3.0}/docs/reforms.md

@@ -29,7 +29,19 @@ reform = {
 }
 ```
 
-Dates that haven't passed become "from this date onward." Earlier dates replace the baseline schedule.
+A `YYYY-MM-DD` key is an effective date: its value applies from that date until the next date in the same parameter's reform schedule. If no later value follows, the wrapper emits an interval ending on December 31, 2100.
+
+Use `YYYY-MM-DD.YYYY-MM-DD` for an inclusive interval. For example, this UK reform applies for fiscal year 2027 only:
+
+```python
+reform = {
+    "gov.hmrc.income_tax.rates.uk[0].rate": {
+        "2027-04-06.2028-04-05": 0.21,
+    },
+}
+```
+
+`Simulation(policy=...)`, `Simulation(dynamic=...)`, and UK `calculate_household(reform=...)` accept these two date formats and reject an interval whose end precedes its start. They reject bare years such as `"2027"` or `2027`, because policyengine-uk reads them as fiscal year 2027 only, while policyengine-core's `Reform.from_dict` reads them as from 2027 onward. Use `"2027-04-06.2028-04-05"` for one UK fiscal year or `"2027-01-01"` for an effective date. The US household route retains its country package's period-key handling.
 
 ### Multiple changes
 

{policyengine-6.2.6 → policyengine-6.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "policyengine"
-version = "6.2.6"
+version = "6.3.0"
 description = "A package to conduct policy analysis using PolicyEngine tax-benefit models."
 readme = "README.md"
 authors = [

{policyengine-6.2.6 → policyengine-6.3.0}/src/policyengine/data/bundle/manifest.json

@@ -1,10 +1,10 @@
 {
-  "bundle_version": "6.2.6",
+  "bundle_version": "6.3.0",
   "citation": {
     "publisher": "PolicyEngine",
-    "title": "PolicyEngine bundle 6.2.6",
+    "title": "PolicyEngine bundle 6.3.0",
     "type": "software-bundle",
-    "version": "6.2.6"
+    "version": "6.3.0"
   },
   "countries": {
     "uk": {
@@ -17,7 +17,7 @@
   "data_releases": {
     "uk": {
       "build_id": "policyengine-uk-data-1.58.0",
-      "bundle_id": "uk-6.2.6",
+      "bundle_id": "uk-6.3.0",
       "certification": {
         "built_with_model_git_sha": "4cbedbecca352f52dffe47e849553c2759a00711",
         "built_with_model_version": "2.122.2",
@@ -99,7 +99,7 @@
         "version": "2.125.1",
         "wheel_url": "https://files.pythonhosted.org/packages/ec/3a/1d90bad4346d1a8c2715be211ed3d3d7f48917da0d90405b8257b7304091/policyengine_uk-2.125.1-py3-none-any.whl"
       },
-      "policyengine_version": "6.2.6",
+      "policyengine_version": "6.3.0",
       "region_datasets": {
         "national": {
           "path_template": "enhanced_frs_2024_25.h5"
@@ -112,7 +112,7 @@
     },
     "us": {
       "build_id": "populace-us-2024-spm-20260915",
-      "bundle_id": "us-6.2.6",
+      "bundle_id": "us-6.3.0",
       "certification": {
         "built_with_model_version": "2.2.1",
         "certified_by": "policyengine.py bundle certification",
@@ -217,7 +217,7 @@
         "version": "2.2.1",
         "wheel_url": "https://files.pythonhosted.org/packages/5e/09/86ac3968d2a18e28fce3ba1186fc21728e9f299b96a806d6f204f1e0aaed/policyengine_us-2.2.1-py3-none-any.whl"
       },
-      "policyengine_version": "6.2.6",
+      "policyengine_version": "6.3.0",
       "region_datasets": {
         "congressional_district": {
           "path_template": "populace_us_2024_acs_local.h5"
@@ -295,10 +295,10 @@
   "packages": {
     "policyengine": {
       "import_name": "policyengine",
-      "install_requirement": "policyengine==6.2.6",
+      "install_requirement": "policyengine==6.3.0",
       "name": "policyengine",
       "role": "bundle_carrier",
-      "version": "6.2.6"
+      "version": "6.3.0"
     },
     "policyengine-core": {
       "import_name": "policyengine_core",
@@ -334,6 +334,6 @@
       "wheel_url": "https://files.pythonhosted.org/packages/19/a0/c484f69a0ebf88a9b9fd0ac28176f8df66550f46714f1b0c5ec0b360824e/spm_calculator-1.0.0-py3-none-any.whl"
     }
   },
-  "policyengine_version": "6.2.6",
+  "policyengine_version": "6.3.0",
   "schema_version": 2
 }

{policyengine-6.2.6 → policyengine-6.3.0}/src/policyengine/data/bundle/uk.trace.tro.jsonld

@@ -18,18 +18,18 @@
         "schema:url": "https://policyengine.org"
       },
       "schema:dateCreated": "2026-10-07T17:31:53.189867Z",
-      "schema:description": "TRACE TRO for certified runtime bundle uk-6.2.6 covering the bundle manifest, the certified dataset artifact, the country model wheel, and the country data release manifest when it is available.",
+      "schema:description": "TRACE TRO for certified runtime bundle uk-6.3.0 covering the bundle manifest, the certified dataset artifact, the country model wheel, and the country data release manifest when it is available.",
       "schema:name": "policyengine uk certified bundle TRO",
       "trov:createdWith": {
         "@type": "schema:SoftwareApplication",
         "schema:name": "policyengine",
-        "schema:softwareVersion": "6.2.6"
+        "schema:softwareVersion": "6.3.0"
       },
       "trov:hasArrangement": [
         {
           "@id": "arrangement/1",
           "@type": "trov:ArtifactArrangement",
-          "rdfs:comment": "Certified arrangement for bundle uk-6.2.6.",
+          "rdfs:comment": "Certified arrangement for bundle uk-6.3.0.",
           "trov:hasArtifactLocation": [
             {
               "@id": "arrangement/1/location/bundle_manifest",
@@ -75,7 +75,7 @@
             "@type": "trov:ResearchArtifact",
             "schema:name": "policyengine.py bundle manifest for uk",
             "trov:mimeType": "application/json",
-            "trov:sha256": "8633ad814c9c85e53c7c513f69c4c7b1500a03cd2f6ef133d6e2ea8346b2db54"
+            "trov:sha256": "5880d61838b08e6e0aa94c5ff8b6b0806892efae4f0a1c262319b9ce722dff13"
           },
           {
             "@id": "composition/1/artifact/data_release_manifest",
@@ -102,7 +102,7 @@
         "trov:hasFingerprint": {
           "@id": "composition/1/fingerprint",
           "@type": "trov:CompositionFingerprint",
-          "trov:sha256": "e6c6d39c2dfcf28a1047e783f4a927673d0dfbcd84b5b305675e1de10e6c4050"
+          "trov:sha256": "5a84f161fc95544ff2d6d8bfbcc3e8dd10e8573b8bc7e3b9b876b9f1b115d703"
         }
       },
       "trov:hasPerformance": {

{policyengine-6.2.6 → policyengine-6.3.0}/src/policyengine/data/bundle/us.trace.tro.jsonld

@@ -17,18 +17,18 @@
         "schema:name": "PolicyEngine",
         "schema:url": "https://policyengine.org"
       },
-      "schema:description": "TRACE TRO for certified runtime bundle us-6.2.6 covering the bundle manifest, the certified dataset artifact, the country model wheel, and the country data release manifest when it is available.",
+      "schema:description": "TRACE TRO for certified runtime bundle us-6.3.0 covering the bundle manifest, the certified dataset artifact, the country model wheel, and the country data release manifest when it is available.",
       "schema:name": "policyengine us certified bundle TRO",
       "trov:createdWith": {
         "@type": "schema:SoftwareApplication",
         "schema:name": "policyengine",
-        "schema:softwareVersion": "6.2.6"
+        "schema:softwareVersion": "6.3.0"
       },
       "trov:hasArrangement": [
         {
           "@id": "arrangement/1",
           "@type": "trov:ArtifactArrangement",
-          "rdfs:comment": "Certified arrangement for bundle us-6.2.6.",
+          "rdfs:comment": "Certified arrangement for bundle us-6.3.0.",
           "trov:hasArtifactLocation": [
             {
               "@id": "arrangement/1/location/bundle_manifest",
@@ -74,7 +74,7 @@
             "@type": "trov:ResearchArtifact",
             "schema:name": "policyengine.py bundle manifest for us",
             "trov:mimeType": "application/json",
-            "trov:sha256": "8633ad814c9c85e53c7c513f69c4c7b1500a03cd2f6ef133d6e2ea8346b2db54"
+            "trov:sha256": "5880d61838b08e6e0aa94c5ff8b6b0806892efae4f0a1c262319b9ce722dff13"
           },
           {
             "@id": "composition/1/artifact/data_release_manifest",
@@ -101,7 +101,7 @@
         "trov:hasFingerprint": {
           "@id": "composition/1/fingerprint",
           "@type": "trov:CompositionFingerprint",
-          "trov:sha256": "4c980b674225037116186b6a8af9a22ff68f534b52dc05dc4519b2dbe2e9055c"
+          "trov:sha256": "c5765f37db02194b84a3100e16426431eded1862eb1332855db27507eca18248"
         }
       },
       "trov:hasPerformance": {

{policyengine-6.2.6 → policyengine-6.3.0}/src/policyengine/tax_benefit_models/common/reform.py

@@ -1,4 +1,4 @@
-"""Compile a simple reform dict into the format policyengine_core expects.
+"""Compile a simple reform dict into country-model inputs or parameter values.
 
 Accepted shapes for the agent-facing API:
 
@@ -10,6 +10,13 @@ Accepted shapes for the agent-facing API:
     # With explicit effective date(s).
     reform = {"gov.irs.deductions.salt.cap": {"2026-01-01": 0}}
 
+    # With an inclusive start and end date.
+    reform = {
+        "gov.hmrc.income_tax.rates.uk[0].rate": {
+            "2027-04-06.2028-04-05": 0.21,
+        },
+    }
+
     # Multiple parameters.
     reform = {
         "gov.irs.deductions.salt.cap": 0,
@@ -25,9 +32,17 @@ the top-bracket SS wage base is ``gov.ssa.payroll.cap``. If a reform
 dict uses the bracket-head path instead of ``[0].amount`` the
 ``ValueError`` will list the close match.
 
-The compiled form is ``{param_path: {period: value}}`` — exactly what
-``policyengine_us.Simulation(reform=...)`` /
-``policyengine_uk.Simulation(reform=...)`` accept at construction.
+The parameter-value compiler accepts ``YYYY-MM-DD`` as an effective date
+with no end date, or ``YYYY-MM-DD.YYYY-MM-DD`` as an inclusive interval.
+Months and days may be unpadded (``2027-4-6``), as ``strptime`` reads them.
+Other keys, including bare years, are rejected: policyengine-uk interprets
+a bare year as one fiscal year, while policyengine-core interprets it as
+an effective year continuing onward. Use ``2027-04-06.2028-04-05`` for one
+UK fiscal year, or ``2027-01-01`` for an effective date.
+
+The low-level :func:`compile_reform` returns ``{param_path: {period: value}}``
+without interpreting period keys. Parameter-value routes convert values
+to explicit intervals before passing them to the country model.
 
 Scalar reforms default to ``{year}-01-01`` so a caller running
 mid-year does not accidentally get a blended partial-year result.
@@ -103,8 +118,8 @@ def _reform_dict_to_parameter_values(
     """Compile a flat reform dict into a list of ``ParameterValue`` objects.
 
     Uses :func:`compile_reform` for path validation and effective-date
-    defaulting, then materialises each ``{path: {date: value}}`` pair
-    as an open-ended ``ParameterValue`` bound to a
+    defaulting, then materialises each effective date or inclusive interval
+    as a ``ParameterValue`` bound to a
     ``Parameter(name=path, tax_benefit_model_version=model_version)``.
     """
     from policyengine.core.parameter import Parameter
@@ -117,6 +132,32 @@ def _reform_dict_to_parameter_values(
     parameter_values: list[ParameterValue] = []
     for path, date_to_value in compiled.items():
         for effective_date, value in date_to_value.items():
+            try:
+                parts = str(effective_date).split(".")
+                if len(parts) > 2:
+                    raise ValueError("Too many dates")
+                start_date = datetime.datetime.strptime(parts[0], "%Y-%m-%d")
+                end_date = (
+                    datetime.datetime.strptime(parts[1], "%Y-%m-%d")
+                    if len(parts) == 2
+                    else None
+                )
+            except ValueError as exc:
+                raise ValueError(
+                    f"Invalid reform date key {effective_date!r}. Accepted formats are "
+                    "'YYYY-MM-DD' (effective date) and "
+                    "'YYYY-MM-DD.YYYY-MM-DD' (inclusive interval); months and "
+                    "days may be unpadded. Bare years are "
+                    "ambiguous: policyengine-uk's reform dict reads '2027' as fiscal "
+                    "year 2027 only, while policyengine-core's Reform.from_dict "
+                    "reads it as from 2027 on. Use '2027-04-06.2028-04-05' for one "
+                    "UK fiscal year, or '2027-01-01' for an effective date."
+                ) from exc
+            if end_date is not None and end_date < start_date:
+                raise ValueError(
+                    f"Reform interval {effective_date!r} has an end date before "
+                    "its start date."
+                )
             data_type = type(value) if isinstance(value, (int, float, bool)) else float
             parameter_values.append(
                 ParameterValue(
@@ -125,8 +166,8 @@ def _reform_dict_to_parameter_values(
                         tax_benefit_model_version=model_version,
                         data_type=data_type,
                     ),
-                    start_date=datetime.datetime.strptime(effective_date, "%Y-%m-%d"),
-                    end_date=None,
+                    start_date=start_date,
+                    end_date=end_date,
                     value=value,
                 )
             )
@@ -160,7 +201,7 @@ def compile_reform_to_policy(
     """Compile a flat reform dict into a fully-assembled ``Policy``.
 
     Accepts the same ``{param.path: value}`` /
-    ``{param.path: {date: value}}`` shape as :func:`compile_reform`,
+    ``{param.path: {date_or_interval: value}}`` shape as :func:`compile_reform`,
     but returns a ready-to-use ``Policy`` with ``ParameterValue``
     objects so ``Simulation(policy={...})`` works without hand-building
     ``Parameter`` / ``ParameterValue``.