Rename package types to type
#370
Merged
Conversation
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
This commit: - Renames the directory `proto/frequenz/api/common/v1/types` to `proto/frequenz/api/common/v1/type` .. - .. along with renaming the corresponding package from `types` to `type`. This is done to use the same standards as google, potentially making it more familiar to users. Signed-off-by: Tiyash Basu <[email protected]>
github-actions
bot
added
part:docs
Contributor
There was a problem hiding this comment.
Pull Request Overview
Align package naming with Google standards by renaming the types directory and package to type.
- Updated Python test imports to point at the new
typepackage. - Adjusted all
.protofiles’ package declarations and imports fromtypestotype. - Added a release notes entry for the rename.
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| pytests/test_common.py | Updated imports from frequenz.api.common.v1.types to .type |
| proto/frequenz/api/common/v1/type/location.proto | Changed package declaration to frequenz.api.common.v1.type |
| proto/frequenz/api/common/v1/type/interval.proto | Changed package declaration to frequenz.api.common.v1.type |
| proto/frequenz/api/common/v1/type/decimal.proto | Changed package declaration to frequenz.api.common.v1.type |
| proto/frequenz/api/common/v1/microgrid/microgrid.proto | Updated import and message reference from types to type |
| proto/frequenz/api/common/v1/market/price.proto | Updated import and field type from types to type |
| proto/frequenz/api/common/v1/market/power.proto | Updated import and field type from types to type |
| proto/frequenz/api/common/v1/market/energy.proto | Updated import and field type from types to type |
| RELEASE_NOTES.md | Documented the package rename from types to type |
Comments suppressed due to low confidence (3)
RELEASE_NOTES.md:60
- The release notes entry still references the old package name
types; update it totypeto match the change.
+ + `types`:
RELEASE_NOTES.md:60
- [nitpick] The indentation of this bullet is inconsistent with the surrounding list; consider aligning it with the other top-level entries.
+ + `types`:
pytests/test_common.py:17
- [nitpick] Consider adding a test for importing the renamed
interval_pb2andinterval_pb2_grpcmodules to ensure full coverage of the newtypepackage.
def test_module_import_decimal() -> None:
llucax
approved these changes
Jun 13, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This commit:
proto/frequenz/api/common/v1/typestoproto/frequenz/api/common/v1/type..typestotype.This is done to use the same standards as google, potentially making it more familiar to users.
closes #365