Support auth param string for Basic authentication#15
Merged
merlimat merged 3 commits intoapache:mainfrom Oct 13, 2022
Merged
Conversation
### Motivation apache/pulsar#17482 supported basic authentication for Python client, but the `AuthenticationBasic` class accepts two positional arguments as the username and password. It's not good for extension. We should accept an auth param string like `AuthenticationOauth2` so that no changes are needed if the upstream C++ client's implementation changed, like apache/pulsar-client-cpp#37. ### Modifications To be compatible with the existing API, change the first two arguments to keyword arguments. Then, add the 3rd keyword argument to represent the auth param string. ### Verifications `test_basic_auth` and `test_invalid_basic_auth` are extended for this change.
BewareMyPower
requested review from
Demogorgon314,
RobertIndie,
merlimat and
nodece
merlimat
reviewed
Oct 13, 2022
pulsar/__init__.py
Outdated
| Basic Authentication implementation | ||
| """ | ||
| def __init__(self, username, password): | ||
| def __init__(self, username=None, password=None, auth_params_string=None): |
Contributor
There was a problem hiding this comment.
We should also accept the method argument here, otherwise it might not be obvious that you can pass it in the json string
Contributor
Author
merlimat
approved these changes
Oct 13, 2022
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
3 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.
Motivation
apache/pulsar#17482 supported basic authentication for Python client, but the
AuthenticationBasicclass accepts two positional arguments as the username and password. It's not good for extension. We should accept an auth param string likeAuthenticationOauth2so that no changes are needed if the upstream C++ client's implementation changed, likeapache/pulsar-client-cpp#37.
Modifications
To be compatible with the existing API, change the first two arguments to keyword arguments. Then, add the 3rd keyword argument to represent the auth param string.
Verifications
test_basic_authandtest_invalid_basic_authare extended for this change.