Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork493
initial idea for clarifying names of token -> token_dict and token_str#869
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
jvanasco wants to merge1 commit intooauthlib:masterChoose a base branch fromjvanasco:feature-clarify_code
base:master
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
Uh oh!
There was an error while loading.Please reload this page.
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
auvipy requested changesNov 21, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
the name change scheme seems to be OK but need input from more maintainers. also the related tests also should be renamed I think
Sign up for freeto 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.
Here is an initial idea to start addressing#856
Various functions accept a parameter with a name like "token", but the parameter might either be a String or a Dict depending on the function. Sometimes two similar functions will require different input types - for example
save_bearer_token
operates on a Dict, butvalidate_bearer_token
operates on a string. To better clarify this, and aid in future typing, the names of these functions were updated to have a_str
or_dict
suffix. On several functions, the type of input was not identified in the docstring and a code audit was needed to determine.This does not change the various attributes on
oauthlib.common.Request
- which do need to be better listed and typed.This quick PR was done for initial feedback. I did not run this through any tests yet.