Skip to content

Remove replace_unspecified_code_type_with #253

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
llucax merged 1 commit into from
Jul 17, 2026
Merged

Remove replace_unspecified_code_type_with #253

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 1 addition & 7 deletions src/frequenz/client/common/grid/proto/v1alpha8/_delivery_area.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,6 @@ def delivery_area_from_proto( # noqa: DOC502

def delivery_area_from_proto2(
message: delivery_area_pb2.DeliveryArea,
*,
replace_unspecified_code_type_with: EnergyMarketCodeType = EnergyMarketCodeType.EUROPE_EIC,
) -> DeliveryArea | InvalidDeliveryArea:
"""Convert a protobuf message to a delivery area object.

Expand All @@ -123,10 +121,6 @@ def delivery_area_from_proto2(

Args:
message: The protobuf message to convert.
replace_unspecified_code_type_with: The default `EnergyMarketCodeType`
to use when the protobuf message has `code_type` of `0`
(`UNSPECIFIED`). This is a temporary option until delivery areas
consistently provide a valid `code_type`.

Returns:
A [`DeliveryArea`][....DeliveryArea] when the wire data is
Expand All @@ -135,7 +129,7 @@ def delivery_area_from_proto2(
"""
raw_code_type = message.code_type
code_type: EnergyMarketCodeType | int = (
replace_unspecified_code_type_with
raw_code_type
if raw_code_type == 0
else energy_market_code_type_from_proto(raw_code_type)
)
Expand Down
46 changes: 4 additions & 42 deletions tests/grid/proto/v1alpha8/test_delivery_area.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,19 +213,19 @@ class _FromProto2TestCase:
expected_type=InvalidDeliveryArea,
),
_FromProto2TestCase(
name="unspecified_code_type_replaced_with_default",
name="unspecified_code_type_is_invalid",
code="DE",
code_type=delivery_area_pb2.EnergyMarketCodeType.ENERGY_MARKET_CODE_TYPE_UNSPECIFIED,
expected_code="DE",
expected_code_type=EnergyMarketCodeType.EUROPE_EIC,
expected_type=DeliveryArea,
expected_code_type=0,
expected_type=InvalidDeliveryArea,
),
_FromProto2TestCase(
name="no_code_with_unspecified_code_type_is_invalid",
code="",
code_type=delivery_area_pb2.EnergyMarketCodeType.ENERGY_MARKET_CODE_TYPE_UNSPECIFIED,
expected_code="",
expected_code_type=EnergyMarketCodeType.EUROPE_EIC,
expected_code_type=0,
expected_type=InvalidDeliveryArea,
),
],
Expand All @@ -248,41 +248,3 @@ def test_from_proto2(
assert area.code_type == case.expected_code_type
# The new converter never logs issues.
assert len(caplog.records) == 0


def test_from_proto2_replaces_unspecified_code_type_with_custom_default() -> None:
"""`replace_unspecified_code_type_with` overrides the fallback for `code_type=0`."""
proto = delivery_area_pb2.DeliveryArea(
code="PJM",
code_type=(
delivery_area_pb2.EnergyMarketCodeType.ENERGY_MARKET_CODE_TYPE_UNSPECIFIED
),
)
with warnings.catch_warnings():
warnings.simplefilter("error", DeprecationWarning)
area = delivery_area_from_proto2(
proto, replace_unspecified_code_type_with=EnergyMarketCodeType.US_NERC
)

assert isinstance(area, DeliveryArea)
assert area.code == "PJM"
assert area.code_type is EnergyMarketCodeType.US_NERC


def test_from_proto2_does_not_replace_specified_code_type() -> None:
"""`replace_unspecified_code_type_with` is ignored when `code_type` is specified."""
proto = delivery_area_pb2.DeliveryArea(
code="10Y1001A1001A450",
code_type=(
delivery_area_pb2.EnergyMarketCodeType.ENERGY_MARKET_CODE_TYPE_EUROPE_EIC
),
)
with warnings.catch_warnings():
warnings.simplefilter("error", DeprecationWarning)
area = delivery_area_from_proto2(
proto, replace_unspecified_code_type_with=EnergyMarketCodeType.US_NERC
)

assert isinstance(area, DeliveryArea)
assert area.code == "10Y1001A1001A450"
assert area.code_type is EnergyMarketCodeType.EUROPE_EIC
Loading