Merge tag 'v0.3.3' into v0.x.x #85

llucax · 2025-07-01T09:09:16Z

A new module frequenz.client.common.enum_proto has been added, which provides a generic enum_from_proto() function to convert protobuf enums to Python enums.
Documentation for some frequenz.client.common.microgrid.electrical_components.ElectricalComponentCategory values was improved.
The metrics and components enums .from_proto() are deprecated, please use the new enum_from_proto() instead.
Classes to represent microgrid-related ID were added (MicrogridId, EnterpriseId, ComponentId, and SensorId).

Signed-off-by: Leandro Lucarella <[email protected]>

Adds: EnterpriseId, MicrogridId, ComponentId and SensorId. Signed-off-by: Leandro Lucarella <[email protected]>

Signed-off-by: Leandro Lucarella <[email protected]>

We need to bump typing-extensions to 4.13.0 because that's the minimum supported version declaraed by `frequenz-core`. Signed-off-by: Leandro Lucarella <[email protected]>

…nz-floss#79)

Signed-off-by: Leandro Lucarella <[email protected]>

This needs a bump of the minimum `frequenz-api-common` to v0.6.1 as this category was added in that version. Signed-off-by: Leandro Lucarella <[email protected]>

This function can convert any `int` to any `Enum`, with optional validation or forward-compatibility. Signed-off-by: Leandro Lucarella <[email protected]>

Recommend using the new `enum_from_proto()` instead. Signed-off-by: Leandro Lucarella <[email protected]>

This is to avoid errors in tests about duplicated `BaseId` prefixes. Signed-off-by: Leandro Lucarella <[email protected]>

Signed-off-by: Leandro Lucarella <[email protected]>

Copilot

Pull Request Overview

This PR merges tag v0.3.3 into v0.x.x, introducing a new generic enum_from_proto utility, deprecating old .from_proto() methods, and adding microgrid-related ID classes with accompanying tests.

Added enum_from_proto in enum_proto.py and comprehensive tests in tests/test_enum_proto.py.
Deprecated old .from_proto() on metrics and electrical component enums; marked for migration to enum_from_proto.
Introduced EnterpriseId, MicrogridId, ComponentId, and SensorId classes under microgrid, with matching tests in tests/microgrid/test_ids.py.

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
tests/test_enum_proto.py	New tests to verify `enum_from_proto` handling of valid/invalid values
tests/microgrid/test_ids.py	Tests for string/repr of new ID classes
src/frequenz/client/common/enum_proto.py	New `enum_from_proto` implementation
src/frequenz/client/common/microgrid/init.py	Added `EnterpriseId` and `MicrogridId` classes
src/frequenz/client/common/microgrid/sensors.py	Added `SensorId` class
src/frequenz/client/common/microgrid/electrical_components/init.py	Deprecated old `.from_proto()`, added `ComponentId`, enriched docs
src/frequenz/client/common/metric/init.py	Deprecated old `Metric.from_proto()`, updated imports
pyproject.toml	Bumped `typing-extensions`, added `frequenz-core`, updated warnings rules

Comments suppressed due to low confidence (2)

tests/microgrid/test_ids.py:10

The test imports ComponentId from microgrid.components, but the class is defined in microgrid.electrical_components. Either move ComponentId to microgrid/components.py or update the import path to frequenz.client.common.microgrid.electrical_components.

from frequenz.client.common.microgrid.components import ComponentId

src/frequenz/client/common/microgrid/electrical_components/init.py:9

[nitpick] The import of Enum is no longer used (classes now derive from enum.Enum). Consider removing this unused import to clean up the module.

from enum import Enum

- A new module `frequenz.client.common.enum_proto` has been added, which provides a generic `enum_from_proto()` function to convert protobuf enums to Python enums. - Documentation for some `frequenz.client.common.microgrid.electrical_components.ElectricalComponentCategory` values was improved. - The metrics and components enums `.from_proto()` are deprecated, please use the new `enum_from_proto()` instead. - Classes to represent microgrid-related ID were added (`MicrogridId`, `EnterpriseId`, `ElectricalComponentId`, and `SensorId`). * tag 'v0.3.3': Update release notes Bump the minimum version of `frequenz-core` to 1.0.2 Deprecate uses of enum's `.from_proto()` Add a generic `enum_from_proto()` function Add the `HVAC` component category Add missing component categories Make enums unique Clear release notes Fix dependencies and prepare release notes for v0.3.2 release Clear release notes Add release notes Add microgrid-related ID types Fix warning filtering in pytest configuration

llucax · 2025-07-01T09:19:05Z

Question: The ID type prefix for Electrical components before they were explicitly named "electrical" was CID. We use this prefix everywhere, so I left it as CID, even when now just CID might be ambiguous as we have non-electrical component IDs too. I guess when we add Communication Component IDs we will call them CCID and we keep the unique prefixes, but now maybe it would be too easy oversee the difference between CCID and CID so they might get confused.

So I wonder if you think we should bite the bullet and just go with ECID for *electrical component IDsand slowly update our use ofCID, or keep CID` for historical reasons?

@cwasicki @tiyash-basu-frequenz @shsms

(for more context, the prefix is used when converting a ID object to a string, for example when logging an ID)

Marenz

Not quite sure how to review this 😅

cwasicki · 2025-07-01T14:11:20Z

(for more context, the prefix is used when converting a ID object to a string, for example when logging an ID)

So it mainly affects logging? Don't have objections against neither of the two options.

llucax · 2025-07-01T14:13:17Z

Yeah, it is never easy to review merges, but I would say this:

7098a3f?diff=split

llucax · 2025-07-01T14:14:13Z

So it mainly affects logging? Don't have objections against neither of the two options.

Yeah, logging and how people refer to an electrical component ID, as if they don't match it can get pretty confusing.

llucax · 2025-07-01T14:15:21Z

Actually now that I think about it, I guess CID is not that widely used, I think MID is much more widely used (but there is no need to change that one), so maybe going for ECID is not that big of a change.

llucax and others added 18 commits June 6, 2025 12:42

Fix warning filtering in pytest configuration

fd68238

Signed-off-by: Leandro Lucarella <[email protected]>

Add microgrid-related ID types

ec129d1

Adds: EnterpriseId, MicrogridId, ComponentId and SensorId. Signed-off-by: Leandro Lucarella <[email protected]>

Add release notes

514aa3f

Signed-off-by: Leandro Lucarella <[email protected]>

Add microgrid-related ID types (frequenz-floss#77)

cc5e5ba

Clear release notes

1490d0b

Signed-off-by: Leandro Lucarella <[email protected]>

Clear release notes (frequenz-floss#78)

07b4d82

Fix dependencies and prepare release notes for v0.3.2 release

cdb8cce

We need to bump typing-extensions to 4.13.0 because that's the minimum supported version declaraed by `frequenz-core`. Signed-off-by: Leandro Lucarella <[email protected]>

Fix dependencies and prepare release notes for v0.3.2 release (freque…

895ad7c

…nz-floss#79)

Clear release notes

96e57e6

Signed-off-by: Leandro Lucarella <[email protected]>

Clear release notes (frequenz-floss#80)

78548f5

Make enums unique

16a87c3

Signed-off-by: Leandro Lucarella <[email protected]>

Add missing component categories

9fb29df

Signed-off-by: Leandro Lucarella <[email protected]>

Add the HVAC component category

10d81cb

This needs a bump of the minimum `frequenz-api-common` to v0.6.1 as this category was added in that version. Signed-off-by: Leandro Lucarella <[email protected]>

Add a generic enum_from_proto() function

eb121d9

This function can convert any `int` to any `Enum`, with optional validation or forward-compatibility. Signed-off-by: Leandro Lucarella <[email protected]>

Deprecate uses of enum's .from_proto()

4320e05

Recommend using the new `enum_from_proto()` instead. Signed-off-by: Leandro Lucarella <[email protected]>

Bump the minimum version of frequenz-core to 1.0.2

021010b

This is to avoid errors in tests about duplicated `BaseId` prefixes. Signed-off-by: Leandro Lucarella <[email protected]>

Update release notes

31a2ea8

Signed-off-by: Leandro Lucarella <[email protected]>

Improve enums and add a generic enum_from_proto() (frequenz-floss#82)

2e59182

Copilot AI review requested due to automatic review settings July 1, 2025 09:09

llucax requested a review from a team as a code owner July 1, 2025 09:09

llucax requested a review from daniel-zullo-frequenz July 1, 2025 09:09

llucax self-assigned this Jul 1, 2025

github-actions bot added part:tests Affects the unit, integration and performance (benchmarks) tests part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) part:microgrid Affects the microgrid protobuf definitions labels Jul 1, 2025

llucax requested a review from flora-hofmann-frequenz July 1, 2025 09:09

llucax added cmd:skip-release-notes It is not necessary to update release notes for this PR type:enhancement New feature or enhancement visitble to users labels Jul 1, 2025

llucax enabled auto-merge July 1, 2025 09:10

Copilot AI reviewed Jul 1, 2025

View reviewed changes

llucax force-pushed the merge-v0.3.3 branch from 8c2e93d to 7098a3f Compare July 1, 2025 09:14

llucax disabled auto-merge July 1, 2025 09:14

Marenz approved these changes Jul 1, 2025

View reviewed changes

llucax added this pull request to the merge queue Jul 7, 2025

llucax removed this pull request from the merge queue due to a manual request Jul 7, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Merge tag 'v0.3.3' into v0.x.x #85

Merge tag 'v0.3.3' into v0.x.x #85

Uh oh!

llucax commented Jul 1, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

llucax commented Jul 1, 2025

Uh oh!

Marenz left a comment

Uh oh!

cwasicki commented Jul 1, 2025

Uh oh!

llucax commented Jul 1, 2025

Uh oh!

llucax commented Jul 1, 2025

Uh oh!

llucax commented Jul 1, 2025

Uh oh!

Uh oh!

Merge tag 'v0.3.3' into v0.x.x #85

Are you sure you want to change the base?

Merge tag 'v0.3.3' into v0.x.x #85

Uh oh!

Conversation

llucax commented Jul 1, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

llucax commented Jul 1, 2025

Uh oh!

Marenz left a comment

Choose a reason for hiding this comment

Uh oh!

cwasicki commented Jul 1, 2025

Uh oh!

llucax commented Jul 1, 2025

Uh oh!

llucax commented Jul 1, 2025

Uh oh!

llucax commented Jul 1, 2025

Uh oh!

Uh oh!