Repository navigation
Preserve protobuf field names in CategorySpecificInfo.fields - #273
Merged
llucax merged 1 commit intoAug 20, 2026
Merged
llucax merged 1 commit into
llucax merged 1 commit into
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
`electrical_component_from_proto` builds `CategorySpecificInfo.fields` with `MessageToDict`, which defaults to protobuf JSON `lowerCamelCase` keys. That contradicted the field's documented contract — "the keys are the protobuf field names" — for every multiword field: a grid connection point's `rated_fuse_current` was exposed as `ratedFuseCurrent`, so a forward-compatible caller reading the documented `fields["rated_fuse_current"]` off an unrecognized or mismatched component got a `KeyError`. Pass `preserving_proto_field_name=True` so the keys are the `snake_case` `.proto` field names, matching both the docstring and the typed attributes (e.g. `GridConnectionPoint.rated_fuse_current`). The recognized grid connection point strips its translated field from the leftover `fields`, so update that key from `"ratedFuseCurrent"` to `"rated_fuse_current"` too; otherwise the newly snake_cased key would leak back into `fields`. Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
llucax
requested review from
florian-wagner-frequenz
and removed request for
a team
August 20, 2026 11:47
llucax
marked this pull request as draft
August 20, 2026 12:46
llucax
marked this pull request as ready for review
August 20, 2026 12:46
llucax
enabled auto-merge
August 20, 2026 12:47
Marenz
approved these changes
Aug 20, 2026
Marenz
left a comment
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
🤖 Correct fix for a real contract violation.
I checked all five _leftover_info call sites: grid was the only one keyed on a multiword field, so "type", "primary" and "secondary" are unaffected by the flag and the single key update is complete.
CategorySpecificInfo doesn't exist at v0.4.0, so this fixes an unreleased feature and cmd:skip-release-notes is the right call.
Sorry, something went wrong.
Merged
via the queue into
frequenz-floss:v0.x.x
with commit 701aef6
Aug 20, 2026
16 of 17 checks passed
llucax
added a commit
to llucax/frequenz-client-common-python
that referenced
this pull request
Sep 16, 2026
* Mention that `metric_config_bounds` keys also store the raw `0` for unspecified metrics (frequenz-floss#224). * Merge the two `Microgrid` bullets, which described the same addition. * Describe the `ElectricalComponent` boolean accessors (frequenz-floss#237), the `CategorySpecificInfo` field (frequenz-floss#257, frequenz-floss#273) and the aggregated `metric_config_bounds` (frequenz-floss#268). * Add a compact list of the smaller supporting types from frequenz-floss#248 and frequenz-floss#249 (`Invalid{Latitude,Longitude,CountryCode}`, `InvalidLifetime` and their errors). Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
llucax
added a commit
to llucax/frequenz-client-common-python
that referenced
this pull request
Sep 16, 2026
Fill the gaps found in a pre-release sanity check of `RELEASE_NOTES.md`: * Replace the template placeholder with a real release summary, including release stats and the note that this is a huge release despite the patch version, realizing the new library design while keeping backwards compatibility, with the breaking cleanup to follow in v0.5.0. * Document two breaking changes to symbols released in v0.4.0 that were missing from Upgrading: `Bounds` raising on `NaN` endpoints (frequenz-floss#254) and `MetricConnection.name` no longer being optional (frequenz-floss#257). * Complete the `UNSPECIFIED`-as-`0` bullet with `metric_config_bounds` keys (frequenz-floss#224), merge the duplicated `Microgrid` bullets, and briefly cover the `ElectricalComponent` accessors, `CategorySpecificInfo` and the smaller `Invalid*` types from frequenz-floss#237, frequenz-floss#248, frequenz-floss#249, frequenz-floss#257, frequenz-floss#268 and frequenz-floss#273. * Add the `str()` exception message change (frequenz-floss#258) to Bug Fixes. The `PaginationInfo` breaking change from frequenz-floss#217 is documented separately in frequenz-floss#285, which adds `InvalidPaginationInfo` and `pagination_info_from_proto2`.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
Assignees
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
electrical_component_from_proto builds CategorySpecificInfo.fields with MessageToDict, which defaults to protobuf JSON lowerCamelCase keys. That contradicted the field's documented contract — "the keys are the protobuf field names" — for every multiword field: a grid connection point's rated_fuse_current was exposed as ratedFuseCurrent, so a forward-compatible caller reading the documented fields["rated_fuse_current"] off an unrecognized or mismatched component got a KeyError.
Pass preserving_proto_field_name=True so the keys are the snake_case .proto field names, matching both the docstring and the typed attributes (e.g. GridConnectionPoint.rated_fuse_current). The recognized grid connection point strips its translated field from the leftover fields, so update that key from "ratedFuseCurrent" to "rated_fuse_current" too; otherwise the newly snake_cased key would leak back into fields.