policyengine 3.1.2__tar.gz → 3.1.3__tar.gz

{policyengine-3.1.2 → policyengine-3.1.3}/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.1.3] - 2025-11-18 13:46:23
+
+### Fixed
+
+- Entity variables moved out to an editable constant.
+
 ## [3.1.2] - 2025-11-18 11:09:18
 
 ### Fixed
@@ -209,6 +215,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 
+[3.1.3]: https://github.com/PolicyEngine/policyengine.py/compare/3.1.2...3.1.3
 [3.1.2]: https://github.com/PolicyEngine/policyengine.py/compare/3.1.1...3.1.2
 [3.1.1]: https://github.com/PolicyEngine/policyengine.py/compare/3.1.0...3.1.1
 [3.1.0]: https://github.com/PolicyEngine/policyengine.py/compare/3.0.0...3.1.0

{policyengine-3.1.2 → policyengine-3.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: policyengine
-Version: 3.1.2
+Version: 3.1.3
 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.2 → policyengine-3.1.3}/changelog.yaml

@@ -170,3 +170,8 @@
     fixed:
     - Standardised saving and loading of simulations.
   date: 2025-11-18 11:09:18
+- bump: patch
+  changes:
+    fixed:
+    - Entity variables moved out to an editable constant.
+  date: 2025-11-18 13:46:23

{policyengine-3.1.2 → policyengine-3.1.3}/pyproject.toml

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

{policyengine-3.1.2 → policyengine-3.1.3}/src/policyengine/tax_benefit_models/uk/model.py

@@ -44,6 +44,73 @@ class PolicyEngineUKLatest(TaxBenefitModelVersion):
         upload_time
     )
 
+    entity_variables: dict[str, list[str]] = {
+        "person": [
+            # IDs and weights
+            "person_id",
+            "benunit_id",
+            "household_id",
+            "person_weight",
+            # Demographics
+            "age",
+            "gender",
+            "is_adult",
+            "is_SP_age",
+            "is_child",
+            # Income
+            "employment_income",
+            "self_employment_income",
+            "pension_income",
+            "private_pension_income",
+            "savings_interest_income",
+            "dividend_income",
+            "property_income",
+            "total_income",
+            "earned_income",
+            # Benefits
+            "universal_credit",
+            "child_benefit",
+            "pension_credit",
+            "income_support",
+            "working_tax_credit",
+            "child_tax_credit",
+            # Tax
+            "income_tax",
+            "national_insurance",
+        ],
+        "benunit": [
+            # IDs and weights
+            "benunit_id",
+            "benunit_weight",
+            # Structure
+            "family_type",
+            # Income and benefits
+            "universal_credit",
+            "child_benefit",
+            "working_tax_credit",
+            "child_tax_credit",
+        ],
+        "household": [
+            # IDs and weights
+            "household_id",
+            "household_weight",
+            # Income measures
+            "household_net_income",
+            "hbai_household_net_income",
+            "equiv_hbai_household_net_income",
+            "household_market_income",
+            "household_gross_income",
+            # Benefits and tax
+            "household_benefits",
+            "household_tax",
+            "vat",
+            # Housing
+            "rent",
+            "council_tax",
+            "tenure_type",
+        ],
+    }
+
     def __init__(self, **kwargs: dict):
         super().__init__(**kwargs)
         from policyengine_core.enums import Enum
@@ -153,80 +220,13 @@ class PolicyEngineUKLatest(TaxBenefitModelVersion):
             )
             modifier(microsim)
 
-        entity_variables = {
-            "person": [
-                # IDs and weights
-                "person_id",
-                "benunit_id",
-                "household_id",
-                "person_weight",
-                # Demographics
-                "age",
-                "gender",
-                "is_adult",
-                "is_SP_age",
-                "is_child",
-                # Income
-                "employment_income",
-                "self_employment_income",
-                "pension_income",
-                "private_pension_income",
-                "savings_interest_income",
-                "dividend_income",
-                "property_income",
-                "total_income",
-                "earned_income",
-                # Benefits
-                "universal_credit",
-                "child_benefit",
-                "pension_credit",
-                "income_support",
-                "working_tax_credit",
-                "child_tax_credit",
-                # Tax
-                "income_tax",
-                "national_insurance",
-            ],
-            "benunit": [
-                # IDs and weights
-                "benunit_id",
-                "benunit_weight",
-                # Structure
-                "family_type",
-                # Income and benefits
-                "universal_credit",
-                "child_benefit",
-                "working_tax_credit",
-                "child_tax_credit",
-            ],
-            "household": [
-                # IDs and weights
-                "household_id",
-                "household_weight",
-                # Income measures
-                "household_net_income",
-                "hbai_household_net_income",
-                "equiv_hbai_household_net_income",
-                "household_market_income",
-                "household_gross_income",
-                # Benefits and tax
-                "household_benefits",
-                "household_tax",
-                "vat",
-                # Housing
-                "rent",
-                "council_tax",
-                "tenure_type",
-            ],
-        }
-
         data = {
             "person": pd.DataFrame(),
             "benunit": pd.DataFrame(),
             "household": pd.DataFrame(),
         }
 
-        for entity, variables in entity_variables.items():
+        for entity, variables in self.entity_variables.items():
             for var in variables:
                 data[entity][var] = microsim.calculate(
                     var, period=simulation.dataset.year, map_to=entity

{policyengine-3.1.2 → policyengine-3.1.3}/src/policyengine/tax_benefit_models/us/model.py

@@ -45,6 +45,59 @@ class PolicyEngineUSLatest(TaxBenefitModelVersion):
     version: str = None
     created_at: datetime.datetime = None
 
+    entity_variables: dict[str, list[str]] = {
+        "person": [
+            # IDs and weights
+            "person_id",
+            "marital_unit_id",
+            "family_id",
+            "spm_unit_id",
+            "tax_unit_id",
+            "household_id",
+            "person_weight",
+            # Demographics
+            "age",
+            # Income
+            "employment_income",
+            # Benefits
+            "ssi",
+            "social_security",
+            "medicaid",
+            "unemployment_compensation",
+        ],
+        "marital_unit": [
+            "marital_unit_id",
+            "marital_unit_weight",
+        ],
+        "family": [
+            "family_id",
+            "family_weight",
+        ],
+        "spm_unit": [
+            "spm_unit_id",
+            "spm_unit_weight",
+            "snap",
+            "tanf",
+            "spm_unit_net_income",
+        ],
+        "tax_unit": [
+            "tax_unit_id",
+            "tax_unit_weight",
+            "income_tax",
+            "employee_payroll_tax",
+            "eitc",
+            "ctc",
+        ],
+        "household": [
+            "household_id",
+            "household_weight",
+            "household_net_income",
+            "household_benefits",
+            "household_tax",
+            "household_market_income",
+        ],
+    }
+
     def __init__(self, **kwargs: dict):
         # Lazy-load package metadata if not provided
         if "version" not in kwargs or kwargs.get("version") is None:
@@ -156,59 +209,6 @@ class PolicyEngineUSLatest(TaxBenefitModelVersion):
             )
             modifier(microsim)
 
-        entity_variables = {
-            "person": [
-                # IDs and weights
-                "person_id",
-                "marital_unit_id",
-                "family_id",
-                "spm_unit_id",
-                "tax_unit_id",
-                "household_id",
-                "person_weight",
-                # Demographics
-                "age",
-                # Income
-                "employment_income",
-                # Benefits
-                "ssi",
-                "social_security",
-                "medicaid",
-                "unemployment_compensation",
-            ],
-            "marital_unit": [
-                "marital_unit_id",
-                "marital_unit_weight",
-            ],
-            "family": [
-                "family_id",
-                "family_weight",
-            ],
-            "spm_unit": [
-                "spm_unit_id",
-                "spm_unit_weight",
-                "snap",
-                "tanf",
-                "spm_unit_net_income",
-            ],
-            "tax_unit": [
-                "tax_unit_id",
-                "tax_unit_weight",
-                "income_tax",
-                "employee_payroll_tax",
-                "eitc",
-                "ctc",
-            ],
-            "household": [
-                "household_id",
-                "household_weight",
-                "household_net_income",
-                "household_benefits",
-                "household_tax",
-                "household_market_income",
-            ],
-        }
-
         data = {
             "person": pd.DataFrame(),
             "marital_unit": pd.DataFrame(),
@@ -259,7 +259,7 @@ class PolicyEngineUSLatest(TaxBenefitModelVersion):
                     data["person"][target_col] = person_input_df[col].values
 
         # Then calculate non-ID, non-weight variables from simulation
-        for entity, variables in entity_variables.items():
+        for entity, variables in self.entity_variables.items():
             for var in variables:
                 if var not in id_columns and var not in weight_columns:
                     data[entity][var] = microsim.calculate(

{policyengine-3.1.2 → policyengine-3.1.3}/src/policyengine.egg-info/PKG-INFO

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