initial idea for clarifying names of token -> token_dict and token_str #869
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 changes
Nov 21, 2023
Contributor
auvipy
left a comment
There was a problem hiding this comment.
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 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.
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_tokenoperates on a Dict, butvalidate_bearer_tokenoperates on a string. To better clarify this, and aid in future typing, the names of these functions were updated to have a_stror_dictsuffix. 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.