Add parsing of gRPC channel URIs #51
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
github-actions
bot
added
part:docs
Marenz
reviewed
May 13, 2024
src/frequenz/client/base/channel.py
Outdated
| - If a query parameter is passed many times, the last value is used. | ||
| - The only supported query parameter is `ssl`, which must be a boolean value and | ||
| defaults to `false`. | ||
| - Bolean query parameters can be specified with the following values |
Marenz
reviewed
May 13, 2024
| from grpclib.client import Channel | ||
|
|
||
|
|
||
| def _to_bool(value: str) -> bool: |
There was a problem hiding this comment.
It's private and trivial, I intentionally left it without docs, but I can add some if you think it should have some.
|
Updated to fix the typo. |
This new module provides a function to parse URIs to create `grpclib` client `Channel` instances. For now the URI provides only very basic options, but it can be extended in the future. Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
This is already checked by `mypy`, and `pylint` is not as smart as `mypy` to understand types, so it suffers from some false positives (for example after asserting that an object `isinstance` of a type, `pylint` still complains that the object don't have the attributes of the type). Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Marenz
approved these changes
May 14, 2024
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.
Add a new module
channelwith a function to parse URIs to creategrpclibclientChannelinstances. For now the URI provides only very basic options, but it can be extended in the future.The main idea for this is to abstract ourselves from the channel class in the client, for one side to ease the transition to
betterproto/grpclibbut also because we will soon need an easy way to configure secure channels too, so just host/port won't be enough. Using URIs is pretty flexible as one can pass arbitrary options via query strings.