-
-
Notifications
You must be signed in to change notification settings - Fork 2k
Add PyJWT type annotations #1281
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 3 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
9e14364
Add PyJWT type annotations
toolness 493044b
Make jwt.pyi more compact, fix flake8 errors.
toolness 3c36782
Put spaces around '=' for default values.
toolness 9f3ac44
Add more public APIs for pyjwt.
toolness 4060191
Fix typings.
toolness 38d932c
Add type: ignore to Algorithm.
toolness 3e20c57
Make Algorithm a subclass of Any.
toolness c093029
Remove blank lines between exception classes.
toolness 0d5790d
Merge branch 'master' into patch-1
toolness a609aae
import _Hash as _HashAlg.
toolness c805fcb
Get rid of unused typing imports.
toolness File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| from typing import Mapping, Any, Optional, Union | ||
|
|
||
|
|
||
| def decode(jwt: Union[str, bytes], key: Union[str, bytes] = ..., | ||
| verify: bool = ..., algorithms: Optional[Any] = ..., | ||
| options: Optional[Mapping[Any, Any]] = ..., | ||
| **kwargs: Any) -> Mapping[str, Any]: ... | ||
|
|
||
| def encode(payload: Mapping[str, Any], key: Union[str, bytes], | ||
| algorithm: str = ..., headers: Optional[Mapping[str, Any]] = ..., | ||
| json_encoder: Optional[Any] = ...) -> bytes: ... | ||
|
|
||
| class InvalidTokenError(Exception): pass | ||
|
|
||
| class DecodeError(InvalidTokenError): pass | ||
|
|
||
| class ExpiredSignatureError(InvalidTokenError): pass | ||
|
|
||
| class InvalidAudienceError(InvalidTokenError): pass | ||
|
|
||
| class InvalidIssuerError(InvalidTokenError): pass | ||
|
|
||
| class InvalidIssuedAtError(InvalidTokenError): pass | ||
|
|
||
| class ImmatureSignatureError(InvalidTokenError): pass | ||
|
|
||
| class InvalidKeyError(Exception): pass | ||
|
|
||
| class InvalidAlgorithmError(InvalidTokenError): pass | ||
|
|
||
| class MissingRequiredClaimError(InvalidTokenError): ... | ||
|
|
||
| # Compatibility aliases (deprecated) | ||
| ExpiredSignature = ExpiredSignatureError | ||
| InvalidAudience = InvalidAudienceError | ||
| InvalidIssuer = InvalidIssuerError | ||
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.
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.
From https://github.com/jpadilla/pyjwt/blob/master/jwt/__init__.py it looks like there's a few more public functions. The documentation isn't very comprehensive, but at least
register_algorithmis documented.It's important to include all public functions, because otherwise people using those functions will get spurious errors.