Fix auth0-python: SignatureVerifier.verify_signature is sync, not async#15468
Open
cadupont wants to merge 1 commit intopython:mainfrom
Open
Fix auth0-python: SignatureVerifier.verify_signature is sync, not async#15468cadupont wants to merge 1 commit intopython:mainfrom
cadupont wants to merge 1 commit intopython:mainfrom
Conversation
The typeshed stub incorrectly declares verify_signature as async def. The actual auth0-python implementation is synchronous. See: https://github.com/auth0/auth0-python/blob/master/auth0/authentication/token_verifier.py#L103
Contributor
|
According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉 |
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
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.
Summary
The typeshed stub for
auth0-pythonincorrectly declaresSignatureVerifier.verify_signatureasasync def. The actual implementation is synchronous.Evidence
The auth0-python implementation uses a regular
def:Impact
With the current stub, mypy reports:
Argument 1 to "_verify_claims" has incompatible type "Coroutine[Any, Any, dict[str, Any]"; expected "dict[str, Any]"Maybe you forgot to use "await"?This forces downstream code to use
cast()or# type: ignoreas a workaround, when the correct fix is to align the stub with the runtime.Change
Change
async def verify_signaturetodef verify_signaturein theSignatureVerifierclass.