policyengine 3.1.12__py3-none-any.whl → 3.1.13__py3-none-any.whl

policyengine/core/parameter.py

@@ -1,7 +1,7 @@
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 from uuid import uuid4
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, Field, PrivateAttr
 
 from .parameter_value import ParameterValue
 from .tax_benefit_model_version import TaxBenefitModelVersion
@@ -11,6 +11,8 @@ if TYPE_CHECKING:
 
 
 class Parameter(BaseModel):
+    model_config = {"arbitrary_types_allowed": True}
+
     id: str = Field(default_factory=lambda: str(uuid4()))
     name: str
     label: str | None = None
@@ -18,4 +20,46 @@ class Parameter(BaseModel):
     data_type: type | None = None
     tax_benefit_model_version: TaxBenefitModelVersion
     unit: str | None = None
-    parameter_values: list["ParameterValue"] = Field(default_factory=list)
+
+    # Lazy loading: store core param ref, build values on demand
+    _core_param: Any = PrivateAttr(default=None)
+    _parameter_values: list["ParameterValue"] | None = PrivateAttr(
+        default=None
+    )
+
+    def __init__(self, _core_param: Any = None, **data):
+        super().__init__(**data)
+        self._core_param = _core_param
+        self._parameter_values = None
+
+    @property
+    def parameter_values(self) -> list["ParameterValue"]:
+        """Lazily build parameter values on first access."""
+        if self._parameter_values is None:
+            self._parameter_values = []
+            if self._core_param is not None:
+                from policyengine.utils import parse_safe_date
+
+                for i in range(len(self._core_param.values_list)):
+                    param_at_instant = self._core_param.values_list[i]
+                    if i + 1 < len(self._core_param.values_list):
+                        next_instant = self._core_param.values_list[i + 1]
+                    else:
+                        next_instant = None
+                    pv = ParameterValue(
+                        parameter=self,
+                        start_date=parse_safe_date(
+                            param_at_instant.instant_str
+                        ),
+                        end_date=parse_safe_date(next_instant.instant_str)
+                        if next_instant
+                        else None,
+                        value=param_at_instant.value,
+                    )
+                    self._parameter_values.append(pv)
+        return self._parameter_values
+
+    @parameter_values.setter
+    def parameter_values(self, value: list["ParameterValue"]) -> None:
+        """Allow direct setting of parameter values."""
+        self._parameter_values = value

policyengine/core/tax_benefit_model_version.py

@@ -14,6 +14,8 @@ if TYPE_CHECKING:
 
 
 class TaxBenefitModelVersion(BaseModel):
+    model_config = {"arbitrary_types_allowed": True}
+
     id: str = Field(default_factory=lambda: str(uuid4()))
     model: TaxBenefitModel
     version: str
@@ -24,6 +26,14 @@ class TaxBenefitModelVersion(BaseModel):
     parameters: list["Parameter"] = Field(default_factory=list)
     parameter_values: list["ParameterValue"] = Field(default_factory=list)
 
+    # Lookup dicts for O(1) access (excluded from serialization)
+    variables_by_name: dict[str, "Variable"] = Field(
+        default_factory=dict, exclude=True
+    )
+    parameters_by_name: dict[str, "Parameter"] = Field(
+        default_factory=dict, exclude=True
+    )
+
     def run(self, simulation: "Simulation") -> "Simulation":
         raise NotImplementedError(
             "The TaxBenefitModel class must define a method to execute simulations."
@@ -39,40 +49,28 @@ class TaxBenefitModelVersion(BaseModel):
             "The TaxBenefitModel class must define a method to load simulations."
         )
 
-    def get_parameter(self, name: str) -> "Parameter":
-        """Get a parameter by name.
-
-        Args:
-            name: The parameter name (e.g., "gov.hmrc.income_tax.allowances.personal_allowance.amount")
+    def add_parameter(self, param: "Parameter") -> None:
+        """Add a parameter and index it for fast lookup."""
+        self.parameters.append(param)
+        self.parameters_by_name[param.name] = param
 
-        Returns:
-            Parameter: The matching parameter
+    def add_variable(self, var: "Variable") -> None:
+        """Add a variable and index it for fast lookup."""
+        self.variables.append(var)
+        self.variables_by_name[var.name] = var
 
-        Raises:
-            ValueError: If parameter not found
-        """
-        for param in self.parameters:
-            if param.name == name:
-                return param
+    def get_parameter(self, name: str) -> "Parameter":
+        """Get a parameter by name (O(1) lookup)."""
+        if name in self.parameters_by_name:
+            return self.parameters_by_name[name]
         raise ValueError(
             f"Parameter '{name}' not found in {self.model.id} version {self.version}"
         )
 
     def get_variable(self, name: str) -> "Variable":
-        """Get a variable by name.
-
-        Args:
-            name: The variable name (e.g., "income_tax", "household_net_income")
-
-        Returns:
-            Variable: The matching variable
-
-        Raises:
-            ValueError: If variable not found
-        """
-        for var in self.variables:
-            if var.name == name:
-                return var
+        """Get a variable by name (O(1) lookup)."""
+        if name in self.variables_by_name:
+            return self.variables_by_name[name]
         raise ValueError(
             f"Variable '{name}' not found in {self.model.id} version {self.version}"
         )

policyengine/tax_benefit_models/uk/datasets.py

@@ -161,8 +161,8 @@ def create_datasets(
 
             uk_dataset = PolicyEngineUKDataset(
                 id=f"{Path(dataset).stem}_year_{year}",
-                name=f"{dataset}-year-{year}",
-                description=f"UK Dataset for year {year} based on {dataset}",
+                name=f"{Path(dataset).stem}-year-{year}",
+                description=f"UK Dataset for year {year} based on {Path(dataset).stem}",
                 filepath=f"{data_folder}/{Path(dataset).stem}_year_{year}.h5",
                 year=int(year),
                 data=UKYearData(

policyengine/tax_benefit_models/uk/model.py

@@ -118,7 +118,6 @@ class PolicyEngineUKLatest(TaxBenefitModelVersion):
 
         self.id = f"{self.model.id}@{self.version}"
 
-        self.variables = []
         for var_obj in system.variables.values():
             variable = Variable(
                 id=self.id + "-" + var_obj.name,
@@ -140,9 +139,8 @@ class PolicyEngineUKLatest(TaxBenefitModelVersion):
                         var_obj.possible_values._value2member_map_.values(),
                     )
                 )
-            self.variables.append(variable)
+            self.add_variable(variable)
 
-        self.parameters = []
         from policyengine_core.parameters import Parameter as CoreParameter
 
         for param_node in system.parameters.get_descendants():
@@ -153,33 +151,11 @@ class PolicyEngineUKLatest(TaxBenefitModelVersion):
                     label=param_node.metadata.get("label", param_node.name),
                     tax_benefit_model_version=self,
                     description=param_node.description,
-                    data_type=type(
-                        param_node(2025)
-                    ),  # Example year to infer type
+                    data_type=type(param_node(2025)),
                     unit=param_node.metadata.get("unit"),
+                    _core_param=param_node,  # Store for lazy value loading
                 )
-                self.parameters.append(parameter)
-
-                for i in range(len(param_node.values_list)):
-                    param_at_instant = param_node.values_list[i]
-                    if i + 1 < len(param_node.values_list):
-                        next_instant = param_node.values_list[i + 1]
-                    else:
-                        next_instant = None
-                    parameter_value = ParameterValue(
-                        parameter=parameter,
-                        start_date=parse_safe_date(
-                            param_at_instant.instant_str
-                        ),
-                        end_date=parse_safe_date(next_instant.instant_str)
-                        if next_instant
-                        else None,
-                        value=param_at_instant.value,
-                    )
-                    self.parameter_values.append(parameter_value)
-                    self.get_parameter(parameter.name).parameter_values.append(
-                        parameter_value
-                    )
+                self.add_parameter(parameter)
 
     def run(self, simulation: "Simulation") -> "Simulation":
         from policyengine_uk import Microsimulation

policyengine/tax_benefit_models/us/datasets.py

@@ -266,8 +266,8 @@ def create_datasets(
 
             us_dataset = PolicyEngineUSDataset(
                 id=f"{Path(dataset).stem}_year_{year}",
-                name=f"{dataset}-year-{year}",
-                description=f"US Dataset for year {year} based on {dataset}",
+                name=f"{Path(dataset).stem}-year-{year}",
+                description=f"US Dataset for year {year} based on {Path(dataset).stem}",
                 filepath=f"{data_folder}/{Path(dataset).stem}_year_{year}.h5",
                 year=int(year),
                 data=USYearData(

policyengine/tax_benefit_models/us/model.py

@@ -111,7 +111,6 @@ class PolicyEngineUSLatest(TaxBenefitModelVersion):
 
         self.id = f"{self.model.id}@{self.version}"
 
-        self.variables = []
         for var_obj in system.variables.values():
             variable = Variable(
                 id=self.id + "-" + var_obj.name,
@@ -133,9 +132,8 @@ class PolicyEngineUSLatest(TaxBenefitModelVersion):
                         var_obj.possible_values._value2member_map_.values(),
                     )
                 )
-            self.variables.append(variable)
+            self.add_variable(variable)
 
-        self.parameters = []
         from policyengine_core.parameters import Parameter as CoreParameter
 
         for param_node in system.parameters.get_descendants():
@@ -147,29 +145,9 @@ class PolicyEngineUSLatest(TaxBenefitModelVersion):
                     description=param_node.description,
                     data_type=type(param_node(2025)),
                     unit=param_node.metadata.get("unit"),
+                    _core_param=param_node,  # Store for lazy value loading
                 )
-                self.parameters.append(parameter)
-
-                for i in range(len(param_node.values_list)):
-                    param_at_instant = param_node.values_list[i]
-                    if i + 1 < len(param_node.values_list):
-                        next_instant = param_node.values_list[i + 1]
-                    else:
-                        next_instant = None
-                    parameter_value = ParameterValue(
-                        parameter=parameter,
-                        start_date=parse_safe_date(
-                            param_at_instant.instant_str
-                        ),
-                        end_date=parse_safe_date(next_instant.instant_str)
-                        if next_instant
-                        else None,
-                        value=param_at_instant.value,
-                    )
-                    self.parameter_values.append(parameter_value)
-                    self.get_parameter(parameter.name).parameter_values.append(
-                        parameter_value
-                    )
+                self.add_parameter(parameter)
 
     def run(self, simulation: "Simulation") -> "Simulation":
         from policyengine_us import Microsimulation

{policyengine-3.1.12.dist-info → policyengine-3.1.13.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: policyengine
-Version: 3.1.12
+Version: 3.1.13
 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-3.1.12.dist-info → policyengine-3.1.13.dist-info}/RECORD

@@ -1,17 +1,17 @@
 policyengine/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-policyengine/__pycache__/__init__.cpython-313.pyc,sha256=2hzM29K_GrxvAZxRI8IB8gIAj0kAhBHsikLWKkeDug0,175
+policyengine/__pycache__/__init__.cpython-313.pyc,sha256=uVHsGqNxZlQfIUi3c2mJIGYwZoh7v_hBZty19_E2l2g,175
 policyengine/core/__init__.py,sha256=KBVhkqzkvjWLDDwk96vquQKL63ZFuLen5AzBOBnO9pg,912
 policyengine/core/cache.py,sha256=DcVVFaCt7k9PmqwlhXoNDMtJ8sF4neYP1uRqWik5QYg,1812
 policyengine/core/dataset.py,sha256=iJr9-J6w11uMRYy3EEJO9Gveku1m71AA1yzeo-0SiCs,16094
 policyengine/core/dataset_version.py,sha256=6KeFCRGQto_Yyl4QY4Vo2JFythjaXrNAOHQiwRGESyM,378
 policyengine/core/dynamic.py,sha256=ng9BjDzxdwjJ0e7zoqXFmq33E1SRbaaPYfW7pjRSSzI,1641
 policyengine/core/output.py,sha256=cCW4vbzkLdQaT_nJTyDJBl7Hubm7nZeRuR7aVG1dKvg,643
-policyengine/core/parameter.py,sha256=8RKKuGCDW1OoHPoXI9vF3JY6COc1qhUtMolXTUxPoEs,626
+policyengine/core/parameter.py,sha256=MMhx5bN-9jn6n2sRxJf_ow-j-ze8IehCF4r_VrpfR94,2407
 policyengine/core/parameter_value.py,sha256=ZRBZWFYtaY9TqdgjrCymzOZNmuKOBZsrWBET24DIJ_Q,434
 policyengine/core/policy.py,sha256=ExMrUDMvNk_uuOL0cSm0UCzDyGka0t_yk6x4U0Kp6Ww,1635
 policyengine/core/simulation.py,sha256=h6QbFt3uEvyfRXRVbSFBlrOd6Ze03OeZkwX9oElmO2M,1406
 policyengine/core/tax_benefit_model.py,sha256=2Yc1RlQrUG7djDMZbJOQH4Ns86_lOnLeISCGR4-9zMo,176
-policyengine/core/tax_benefit_model_version.py,sha256=V1CGft5Y6YflMASx0wR3V73jr-WqQu2R8N5QVMRm9yw,2752
+policyengine/core/tax_benefit_model_version.py,sha256=csHeZasdvCyyRTlBIr1gtuJstye3pftQAsoI8mpRHa4,3012
 policyengine/core/variable.py,sha256=AjSImORlRkh05xhYxyeT6GFMOfViRzYg0qRQAIj-mxo,350
 policyengine/outputs/__init__.py,sha256=IJUmLP0Og41VrwiqhJF-a9-3fIb4nlXpS7uFuVCINIs,515
 policyengine/outputs/aggregate.py,sha256=exI-U04OF5kVf2BBYV6sf8VldIWnT_IzxgkBs5wtnCw,4846
@@ -21,20 +21,20 @@ policyengine/tax_benefit_models/uk.py,sha256=HzAG_dORmsj1NJ9pd9WrqwgZPe9DUDrZ1wV
 policyengine/tax_benefit_models/us.py,sha256=G51dAmHo8NJLb2mnbne6iO5eNaatCGUd_2unvawwF84,946
 policyengine/tax_benefit_models/uk/__init__.py,sha256=AiA74iED5FEryvUCMfVZi6pYDYuTfQcj9B01h8J5xFA,1105
 policyengine/tax_benefit_models/uk/analysis.py,sha256=O4eYJYF7tsgiuLuiWMU0OXq7ss6U8-vzlg6nC2U8sgU,3175
-policyengine/tax_benefit_models/uk/datasets.py,sha256=fGKfeCJ6bOj0LHTcvHFDScYem5vTb3XVPp9nk8G5lGE,8999
-policyengine/tax_benefit_models/uk/model.py,sha256=djCLLBeik9ZGFqe5WXUNVcu1JXjh0U8MXakvncasUj0,9754
+policyengine/tax_benefit_models/uk/datasets.py,sha256=OtBGQPI-P2jnLfurw1MiFDo3LRi5xye0uI3XM9J-9rY,9021
+policyengine/tax_benefit_models/uk/model.py,sha256=7eqCNW9bjCM-6BN2Dp8soUAEjZBP_0QmMC2OtDPCiXw,8694
 policyengine/tax_benefit_models/uk/outputs.py,sha256=2mYLwQW4QNvrOHtHfm_ACqE9gbmuLxvcCyldRU46s0o,3543
 policyengine/tax_benefit_models/us/__init__.py,sha256=zP-UUQqOc9g0ymyHkweJdi4RVXQDKSR6SUxavUKvV0s,1101
 policyengine/tax_benefit_models/us/analysis.py,sha256=Xf-DT0QjVySs0QG_koCwgvOeWI_scLtv3S3SP8u8ZWc,3253
-policyengine/tax_benefit_models/us/datasets.py,sha256=Si0oeTVLpoXLpLbQCxtp3ZZB8JFrcHgxRa_16k7x8BQ,14713
-policyengine/tax_benefit_models/us/model.py,sha256=x3xRoIpXV2idVr0IwPJzujLHqu3qeO-iWN2Sv7Tuj9Q,16563
+policyengine/tax_benefit_models/us/datasets.py,sha256=Jfw8cYHBTjokiJJ1WBQtNcHEDd7BJuQ4A4wD6dN7Znk,14735
+policyengine/tax_benefit_models/us/model.py,sha256=eNlot8yMZkNwPiYfrWpDJkxRAwTBYLGWL-VC4Pss4JI,15579
 policyengine/tax_benefit_models/us/outputs.py,sha256=GT8Eur8DfB9cPQRbSljEl9RpKSNHW80Fq_CBXCybvIU,3519
 policyengine/utils/__init__.py,sha256=1X-VYAWLyB9A0YRHwsGWrqQHns1WfeZ7ISC6DMU5myM,140
 policyengine/utils/dates.py,sha256=HnAqyl8S8EOYp8ibsnMTmECYoDWCSqwL-7A2_qKgxSc,1510
 policyengine/utils/parametric_reforms.py,sha256=4P3U39-4pYTU4BN6JjgmVLUkCkBhRfZJ6UIWTlsjyQE,1155
 policyengine/utils/plotting.py,sha256=ZAzTWz38vIaW0c3Nt4Un1kfrNoXLyHCDd1pEJIlsRg4,5335
-policyengine-3.1.12.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
-policyengine-3.1.12.dist-info/METADATA,sha256=lmH-TG4Q8JYw_NebpYc3IwwZKAyNeGbeyNnx3kCX5is,45919
-policyengine-3.1.12.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-policyengine-3.1.12.dist-info/top_level.txt,sha256=_23UPobfkneHQkpJ0e0OmDJfhCUfoXj_F2sTckCGOH4,13
-policyengine-3.1.12.dist-info/RECORD,,
+policyengine-3.1.13.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
+policyengine-3.1.13.dist-info/METADATA,sha256=35l_TCb-BLgwO2Gbdpnl5up_-LMcqSowLieYrjTrjpw,45919
+policyengine-3.1.13.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+policyengine-3.1.13.dist-info/top_level.txt,sha256=_23UPobfkneHQkpJ0e0OmDJfhCUfoXj_F2sTckCGOH4,13
+policyengine-3.1.13.dist-info/RECORD,,