Restructure modules and class names #25
Merged
Conversation
This file contains 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
|
I'm planning to improve the docs too, but I will wait until this is merged because I can imagine there could be some push back. BTW, I really think we should eventually rename this project |
llucax
added
scope:breaking-change
Marenz
previously approved these changes
Feb 29, 2024
The comments are using the old v4 syntax, so it might confuse users trying to add more rules. We consider all files under `docs/_scripts/` as tooling, and we remove the TODO as the work was already done. Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
The `aio` module doesn't seem to be properly exposed in the `grpc` package and it makes `pyright` think it doesn't exist. Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
The `grpcio-tools` package is not really necessary for this repository, as it provides tools to build `.proto` files, but it is indirectly providing the dependency to `protobuf`, which provides `google.protobuf` and it's indeed used by this repository. Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
We remove the `_helper` suffix, as it doesn't provide any information. We also remove the `grpc_` prefix for `streaming` as we have that info in the class name, and it also involves Frequenz channels, and the same for the `_strategy` in `retry`. In general it is also a good practice to keep module names short. Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
github-actions
bot
added
part:docs
Marenz
previously approved these changes
Feb 29, 2024
|
I will update and improve the docs in a followup PR, and then do the v0.2.0 release. |
|
Enabled auto-merge. |
|
do you want to update the commit message also? edab315 |
The `Helper` part doesn't provide any useful information, what is more important about this class, is that it is using a `Broadcast` channel to broadcast what's received by the gRPC stream. Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
The `Retry` part is in the module name, so it is redundant. This also change imports to use the module name, and change some variables to `strategy` to make the code more clear (before the style was not very consistent, sometimes calling variables `retry_spec` or just `retry`. Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
|
Good catch, done now! |
shsms
approved these changes
Mar 1, 2024
|
I updated the PR description also with the new name, and removed and re-enabled auto-merge, so that it uses the updated merge commit message. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 PR do some minor cleanups and some major project structuring to use more consistent and shorter modules and class names.
frequenz.client.base.grpc_streaming_helperwas renamed tofrequenz.client.base.streaming.The
GrpcStreamingHelperclass was renamed toGrpcStreamBroadcaster.retry_specwas renamed toretry_strategy.frequenz.client.base.retry_strategywas renamed tofrequenz.client.base.retry.RetryStrategyclass was renamed toStrategy.