Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/reject-misplaced-uprating-rounding.fixed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Parameter loading now rejects uprating rounding rules placed where they would be silently ignored.
17 changes: 17 additions & 0 deletions policyengine_core/parameters/helpers.py
Original file line number Diff line number Diff line change
Expand Up @@ -90,10 +90,27 @@ def _validate_parameter(parameter, data, data_type=None, allowed_keys=None):
parameter.file_path,
)

if isinstance(data, dict):
_validate_uprating_rounding_metadata(parameter, data.get("metadata"))

if allowed_keys is not None and isinstance(data, dict):
_warn_on_unknown_keys(parameter, data, allowed_keys)


def _validate_uprating_rounding_metadata(parameter, metadata):
if not isinstance(metadata, dict):
return
if "uprating" not in metadata or "rounding" not in metadata:
return

raise ParameterParsingError(
"Invalid uprating metadata for '{}': `rounding` must be nested inside "
"`uprating`; placing both keys at the same level causes the rounding "
"rule to be ignored.".format(parameter.name),
parameter.file_path,
)


def _warn_on_unknown_keys(parameter, data, allowed_keys):
"""Warn about keys placed alongside the recognized parameter keys.

Expand Down
56 changes: 56 additions & 0 deletions tests/core/parameters/operations/test_uprating.py
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,62 @@ def test_parameter_uprating_with_rounding():
assert interpolated.to_be_uprated("2018-01-01") == 4


@pytest.mark.parametrize(
"data",
[
{
"parameter": {
"values": {"2025-01-01": 1},
"metadata": {
"uprating": "uprater",
"rounding": {"interval": 1, "type": "upwards"},
},
},
},
{
"scale": {
"metadata": {
"uprating": "uprater",
"rounding": {"interval": 1, "type": "upwards"},
},
"brackets": [
{
"threshold": {"2025-01-01": 0},
"rate": {"2025-01-01": 0.1},
},
],
},
},
{
"scale": {
"brackets": [
{
"threshold": {"2025-01-01": 0},
"rate": {"2025-01-01": 0.1},
"metadata": {
"uprating": "uprater",
"rounding": {
"interval": 1,
"type": "upwards",
},
},
},
],
},
},
],
)
def test_parameter_uprating_rejects_rounding_beside_uprating(data):
from policyengine_core.errors import ParameterParsingError
from policyengine_core.parameters import ParameterNode

with pytest.raises(
ParameterParsingError,
match="`rounding` must be nested inside `uprating`",
):
ParameterNode(data=data)


def test_parameter_uprating_with_self():
from policyengine_core.parameters import ParameterNode

Expand Down