policyengine 3.1.14__py3-none-any.whl → 3.1.16__py3-none-any.whl

policyengine/utils/parameter_labels.py

@@ -0,0 +1,213 @@
+"""Utilities for generating human-readable labels for tax-benefit parameters."""
+
+import re
+
+
+def generate_label_for_parameter(param_node, system, scale_lookup):
+    """
+    Generate a label for a parameter that doesn't have one.
+
+    For breakdown parameters: Uses parent label + enum value
+    For bracket parameters: Uses scale label + bracket info
+
+    Args:
+        param_node: The CoreParameter object
+        system: The tax-benefit system (has variables and parameters)
+        scale_lookup: Dict mapping scale names to ParameterScale objects
+
+    Returns:
+        str or None: Generated label, or None if cannot generate
+    """
+    if param_node.metadata.get("label"):
+        return param_node.metadata.get("label")
+
+    param_name = param_node.name
+
+    if "[" in param_name:
+        return _generate_bracket_label(param_name, scale_lookup)
+
+    # Check for breakdown - either direct child or nested
+    breakdown_parent = _find_breakdown_parent(param_node)
+    if breakdown_parent:
+        return _generate_breakdown_label(param_node, system, breakdown_parent)
+
+    return None
+
+
+def _find_breakdown_parent(param_node):
+    """
+    Walk up the tree to find the nearest ancestor with breakdown metadata.
+
+    Args:
+        param_node: The CoreParameter object
+
+    Returns:
+        The breakdown parent node, or None if not found
+    """
+    current = param_node.parent
+    while current:
+        if current.metadata.get("breakdown"):
+            return current
+        current = getattr(current, "parent", None)
+    return None
+
+
+def _generate_breakdown_label(param_node, system, breakdown_parent=None):
+    """
+    Generate label for a breakdown parameter using enum values.
+
+    Handles both single-level and nested breakdowns by walking up to the
+    breakdown parent and collecting all dimension values.
+
+    Args:
+        param_node: The CoreParameter object
+        system: The tax-benefit system
+        breakdown_parent: The ancestor node with breakdown metadata (optional)
+
+    Returns:
+        str or None: Generated label, or None if cannot generate
+    """
+    # Find breakdown parent if not provided
+    if breakdown_parent is None:
+        breakdown_parent = _find_breakdown_parent(param_node)
+        if not breakdown_parent:
+            return None
+
+    parent_label = breakdown_parent.metadata.get("label")
+    if not parent_label:
+        return None
+
+    breakdown_vars = breakdown_parent.metadata.get("breakdown", [])
+    breakdown_labels = breakdown_parent.metadata.get("breakdown_labels", [])
+
+    # Collect dimension values from breakdown parent to param_node
+    dimension_values = _collect_dimension_values(
+        param_node, breakdown_parent
+    )
+
+    if not dimension_values:
+        return None
+
+    # Generate labels for each dimension
+    formatted_parts = []
+    for i, (dim_key, dim_value) in enumerate(dimension_values):
+        var_name = breakdown_vars[i] if i < len(breakdown_vars) else None
+        dim_label = breakdown_labels[i] if i < len(breakdown_labels) else None
+
+        formatted_value = _format_dimension_value(
+            dim_value, var_name, dim_label, system
+        )
+        formatted_parts.append(formatted_value)
+
+    return f"{parent_label} ({', '.join(formatted_parts)})"
+
+
+def _collect_dimension_values(param_node, breakdown_parent):
+    """
+    Collect dimension keys and values from breakdown parent to param_node.
+
+    Args:
+        param_node: The CoreParameter object
+        breakdown_parent: The ancestor node with breakdown metadata
+
+    Returns:
+        list of (dimension_key, value) tuples, ordered from parent to child
+    """
+    # Build path from param_node up to breakdown_parent
+    path = []
+    current = param_node
+    while current and current != breakdown_parent:
+        path.append(current)
+        current = getattr(current, "parent", None)
+
+    # Reverse to get parent-to-child order
+    path.reverse()
+
+    # Extract dimension values
+    dimension_values = []
+    for i, node in enumerate(path):
+        key = node.name.split(".")[-1]
+        dimension_values.append((i, key))
+
+    return dimension_values
+
+
+def _format_dimension_value(value, var_name, dim_label, system):
+    """
+    Format a single dimension value with semantic label if available.
+
+    Args:
+        value: The raw dimension value (e.g., "SINGLE", "1", "CA")
+        var_name: The breakdown variable name (e.g., "filing_status", "range(1, 9)")
+        dim_label: The human-readable label for this dimension (e.g., "Household size")
+        system: The tax-benefit system
+
+    Returns:
+        str: Formatted dimension value
+    """
+    # First, try to get enum display value
+    if var_name and isinstance(var_name, str) and not var_name.startswith("range(") and not var_name.startswith("list("):
+        var = system.variables.get(var_name)
+        if var and hasattr(var, "possible_values") and var.possible_values:
+            try:
+                enum_value = var.possible_values[value].value
+                return str(enum_value)
+            except (KeyError, AttributeError):
+                pass
+
+    # For range() dimensions or when no enum found, use breakdown_label if available
+    if dim_label:
+        return f"{dim_label} {value}"
+
+    return value
+
+
+def _generate_bracket_label(param_name, scale_lookup):
+    """Generate label for a bracket parameter."""
+    match = re.match(r"^(.+)\[(\d+)\]\.(\w+)$", param_name)
+    if not match:
+        return None
+
+    scale_name = match.group(1)
+    bracket_index = int(match.group(2))
+    field_name = match.group(3)
+
+    scale = scale_lookup.get(scale_name)
+    if not scale:
+        return None
+
+    scale_label = scale.metadata.get("label")
+    scale_type = scale.metadata.get("type", "")
+
+    if not scale_label:
+        return None
+
+    bracket_num = bracket_index + 1
+
+    if scale_type in ("marginal_rate", "marginal_amount"):
+        bracket_desc = f"bracket {bracket_num}"
+    elif scale_type == "single_amount":
+        bracket_desc = f"tier {bracket_num}"
+    else:
+        bracket_desc = f"bracket {bracket_num}"
+
+    return f"{scale_label} ({bracket_desc} {field_name})"
+
+
+def build_scale_lookup(system):
+    """
+    Build a lookup dict mapping scale names to ParameterScale objects.
+
+    Args:
+        system: The tax-benefit system
+
+    Returns:
+        dict: Mapping of scale name -> ParameterScale object
+    """
+    from policyengine_core.parameters import ParameterScale
+
+    return {
+        p.name: p
+        for p in system.parameters.get_descendants()
+        if isinstance(p, ParameterScale)
+    }

{policyengine-3.1.14.dist-info → policyengine-3.1.16.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: policyengine
-Version: 3.1.14
+Version: 3.1.16
 Summary: A package to conduct policy analysis using PolicyEngine tax-benefit models.
 Author-email: PolicyEngine <hello@policyengine.org>
 License:                     GNU AFFERO GENERAL PUBLIC LICENSE
@@ -670,15 +670,15 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pydantic>=2.0.0
 Requires-Dist: pandas>=2.0.0
-Requires-Dist: microdf_python
+Requires-Dist: microdf_python>=1.2.1
 Requires-Dist: plotly>=5.0.0
 Requires-Dist: requests>=2.31.0
 Requires-Dist: psutil>=5.9.0
 Provides-Extra: uk
-Requires-Dist: policyengine_core>=3.10; extra == "uk"
+Requires-Dist: policyengine_core>=3.23.6; extra == "uk"
 Requires-Dist: policyengine-uk>=2.51.0; extra == "uk"
 Provides-Extra: us
-Requires-Dist: policyengine_core>=3.10; extra == "us"
+Requires-Dist: policyengine_core>=3.23.6; extra == "us"
 Requires-Dist: policyengine-us>=1.213.1; extra == "us"
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
@@ -691,7 +691,7 @@ Requires-Dist: itables; extra == "dev"
 Requires-Dist: build; extra == "dev"
 Requires-Dist: pytest-asyncio>=0.26.0; extra == "dev"
 Requires-Dist: ruff>=0.5.0; extra == "dev"
-Requires-Dist: policyengine_core>=3.10; extra == "dev"
+Requires-Dist: policyengine_core>=3.23.6; extra == "dev"
 Requires-Dist: policyengine-uk>=2.51.0; extra == "dev"
 Requires-Dist: policyengine-us>=1.213.1; extra == "dev"
 Dynamic: license-file

{policyengine-3.1.14.dist-info → policyengine-3.1.16.dist-info}/RECORD

@@ -1,5 +1,5 @@
 policyengine/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-policyengine/__pycache__/__init__.cpython-313.pyc,sha256=mUwBXdcdGEIhSmoQGkgDXX5E9QkcB86jl4HABKXQyAk,175
+policyengine/__pycache__/__init__.cpython-313.pyc,sha256=pXlfNHK9qaW6hIe40yAYhaHxkBtl6c_uvAIzt-n6hzM,175
 policyengine/core/__init__.py,sha256=KBVhkqzkvjWLDDwk96vquQKL63ZFuLen5AzBOBnO9pg,912
 policyengine/core/cache.py,sha256=DcVVFaCt7k9PmqwlhXoNDMtJ8sF4neYP1uRqWik5QYg,1812
 policyengine/core/dataset.py,sha256=iJr9-J6w11uMRYy3EEJO9Gveku1m71AA1yzeo-0SiCs,16094
@@ -11,30 +11,33 @@ policyengine/core/parameter_value.py,sha256=ZRBZWFYtaY9TqdgjrCymzOZNmuKOBZsrWBET
 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=csHeZasdvCyyRTlBIr1gtuJstye3pftQAsoI8mpRHa4,3012
+policyengine/core/tax_benefit_model_version.py,sha256=iVzEKWzQxoPVicwxcqo9Fy8PfVX07faBvyL9NhVIjuU,3212
 policyengine/core/variable.py,sha256=AjSImORlRkh05xhYxyeT6GFMOfViRzYg0qRQAIj-mxo,350
-policyengine/outputs/__init__.py,sha256=IJUmLP0Og41VrwiqhJF-a9-3fIb4nlXpS7uFuVCINIs,515
+policyengine/outputs/__init__.py,sha256=fcqkl1iK4lMpkdS0OBj3wWGAd1zZjc6IiJ-nrXy9VU8,1254
 policyengine/outputs/aggregate.py,sha256=exI-U04OF5kVf2BBYV6sf8VldIWnT_IzxgkBs5wtnCw,4846
 policyengine/outputs/change_aggregate.py,sha256=tK4K87YlByKikqFaB7OHyh1SqAuGtUnLL7cSF_EhrOs,7373
-policyengine/outputs/decile_impact.py,sha256=jclhbj5U-xX8D-myy0SuWeJFVfQTqJDCh7qBXugak5U,4811
+policyengine/outputs/decile_impact.py,sha256=f8nR3pea8_qDuQ-M6kaKnVKxbGnfL0IzpRfFTdi7TqA,5522
+policyengine/outputs/inequality.py,sha256=W_yc9Ibeavx7KA3reJTFArK3fR1kf_YFV0jAaC121w0,9356
+policyengine/outputs/poverty.py,sha256=h8dHj-S8YeEQ6CXqmWje3gEz30H8jgE-gmXQ0NoJTUU,7866
 policyengine/tax_benefit_models/uk.py,sha256=HzAG_dORmsj1NJ9pd9WrqwgZPe9DUDrZ1wV5LuVCKAg,950
 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/__init__.py,sha256=StjVt4mV0n2QxlM_2oCp_OqHJu7eyWNbdPndezC7ve0,1294
+policyengine/tax_benefit_models/uk/analysis.py,sha256=uPQt2EI2y6obibLfZfV-fHuN-FVzvUVUgeZY9kKSB5E,9527
 policyengine/tax_benefit_models/uk/datasets.py,sha256=N8pMrlhQFec_cbgvVf5HE2owU14VF1i8-ZUwZYBSeio,9043
-policyengine/tax_benefit_models/uk/model.py,sha256=7eqCNW9bjCM-6BN2Dp8soUAEjZBP_0QmMC2OtDPCiXw,8694
+policyengine/tax_benefit_models/uk/model.py,sha256=8byY9n8rEWA2DxG3uq7N3SogZWvl_o9JqKcL0xfQ6fk,8984
 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/__init__.py,sha256=0RtqCl01j-Z_T4i9LITBSePegO97gZ4IIYqt-nsv2O0,1290
+policyengine/tax_benefit_models/us/analysis.py,sha256=qJ9pZjyEY1xS7HCpT5-AETdPTtd-k7hWePxJz-NpXDE,10344
 policyengine/tax_benefit_models/us/datasets.py,sha256=OWqiYK8TWwdYP2qgUNIv6nIpqN5FVtyd8aYkVMUkAno,14757
-policyengine/tax_benefit_models/us/model.py,sha256=nYgad3x2yDpNDSyc44ku1ExuMyLxqfVKyDNVtVOxeZs,15639
+policyengine/tax_benefit_models/us/model.py,sha256=t8YPeiEzOskzSnEIwCSZFPvdxFubtLTAUPkTEcG_JN8,15945
 policyengine/tax_benefit_models/us/outputs.py,sha256=GT8Eur8DfB9cPQRbSljEl9RpKSNHW80Fq_CBXCybvIU,3519
-policyengine/utils/__init__.py,sha256=1X-VYAWLyB9A0YRHwsGWrqQHns1WfeZ7ISC6DMU5myM,140
+policyengine/utils/__init__.py,sha256=qq9ElvVnZtmM0CAjbkJV_QFBHz3bAjOSCTJGqx29F0c,311
 policyengine/utils/dates.py,sha256=HnAqyl8S8EOYp8ibsnMTmECYoDWCSqwL-7A2_qKgxSc,1510
+policyengine/utils/parameter_labels.py,sha256=_QTCTOjOdaW-pPVOsYMn7VyN-75QTD6IILfH-6oAd7U,6549
 policyengine/utils/parametric_reforms.py,sha256=4P3U39-4pYTU4BN6JjgmVLUkCkBhRfZJ6UIWTlsjyQE,1155
 policyengine/utils/plotting.py,sha256=ZAzTWz38vIaW0c3Nt4Un1kfrNoXLyHCDd1pEJIlsRg4,5335
-policyengine-3.1.14.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
-policyengine-3.1.14.dist-info/METADATA,sha256=SUCzPeZHriMkpLZQ1Ai-QS1xnwNrCIEtzUEUbrCAXUk,45919
-policyengine-3.1.14.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-policyengine-3.1.14.dist-info/top_level.txt,sha256=_23UPobfkneHQkpJ0e0OmDJfhCUfoXj_F2sTckCGOH4,13
-policyengine-3.1.14.dist-info/RECORD,,
+policyengine-3.1.16.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
+policyengine-3.1.16.dist-info/METADATA,sha256=rmdahoK--THkMMXjckeYhFpagrIk6w_oANMFgTE9rts,45932
+policyengine-3.1.16.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
+policyengine-3.1.16.dist-info/top_level.txt,sha256=_23UPobfkneHQkpJ0e0OmDJfhCUfoXj_F2sTckCGOH4,13
+policyengine-3.1.16.dist-info/RECORD,,

{policyengine-3.1.14.dist-info → policyengine-3.1.16.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (80.10.1)
 Root-Is-Purelib: true
 Tag: py3-none-any