Skip to content
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

Fix bug type in EnergyMarketCodeType #32

Merged
merged 2 commits into from
Jan 31, 2024
Merged

Fix bug type in EnergyMarketCodeType #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37061d6
Fix bug in EnergyMarketCodeType type
camille-bouvy-frequenz Jan 30, 2024
0c0e32e
Update release notes
camille-bouvy-frequenz Jan 30, 2024
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
19 changes: 3 additions & 16 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,16 @@

## Summary

This API interface's client requires the SDK, which depends on
frequenz-api-common in the version range of 0.3.0 to < 0.4.0. However,
electricity_trading.proto needs some proto files from frequenz-api-common,
which are only available from version 0.5.0. This discrepancy creates
a dependency conflict. To resolve this, the current PR incorporates
the required protos directly from the frequenz-api-common repository and
stores them locally. This approach eliminates the dependency on the common
repository for the time being, until the SDK is updated to a newer version
of frequenz-api-common.

A couple of additions were also made to the `__init__` and `_types.py` files.

<!-- Here goes a general summary of what this release is about -->

## Upgrading

<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->

## New Features

* Addition of missing types to the `__init__` file
* Addition of missing `to_pb()` methods in the `_types.py` file
<!-- Here goes the main new features and examples or instructions on how to use them -->

## Bug Fixes

* Remove dependency conflict on `frequenz-api-common` by adding it locally
* Add a py.typed file
* Fix bug type for `EnergyMarketCodeType`
2 changes: 1 addition & 1 deletion py/frequenz/client/electricity_trading/_types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ class DeliveryArea:
code: str
"""Code representing the unique identifier for the delivery area."""

code_type: delivery_area_pb2.EnergyMarketCodeType.ValueType
code_type: EnergyMarketCodeType
"""Type of code used for identifying the delivery area itself."""

@classmethod
Expand Down
Loading