Update typing syntax and usage for Python 3.6+#535
Merged
jpadilla merged 1 commit intojpadilla:masterfrom Dec 16, 2020
jdufresne:typing
Merged
Update typing syntax and usage for Python 3.6+#535jpadilla merged 1 commit intojpadilla:masterfrom jdufresne:typing
jpadilla merged 1 commit intojpadilla:masterfrom
jdufresne:typing
Conversation
auvipy
approved these changes
Dec 16, 2020
jpadilla
reviewed
Dec 16, 2020
Owner
jpadilla
left a comment
There was a problem hiding this comment.
@jdufresne thank you for this! q: is that jwt/py.typed file supposed to be empty?
Now that Python 2 is not supported, can move away from type comments to type annotation 🎉. The typing module is always available, so remove the guards. Specify the supported Python in the mypy configuration. Move other mypy configurations to one place. This way, whether tox is used or not, the same mypy errors appear. Distribute and install PEP-561 compliant py.typed file. When PyJWT is a imported as a library, this tells mypy to use the provided type annotations rather than going through typeshed. This way, the types are always up to date when running mypy. Remove outdated ignores since dropping Python 2.
Contributor
Author
Yes, that is correct. This file is merely a marker for mypy to decide where to find type annotations. Its contents have no meaning. For details, see:
And here is the mypy source that interacts with this file, notice it only checks that it exists and doesn't open the file: |
jpadilla
approved these changes
Dec 16, 2020
DMRobertson
pushed a commit
to matrix-org/synapse
that referenced
this pull request
May 2, 2022
We lock 2.3.0. jpadilla/pyjwt#535
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.
Now that Python 2 is not supported, can move away from type comments to
type annotation 🎉.
The typing module is always available, so remove the guards.
Specify the supported Python in the mypy configuration.
Move other mypy configurations to one place. This way, whether tox is
used or not, the same mypy errors appear.
Distribute and install PEP-561 compliant py.typed file. When PyJWT is a
imported as a library, this tells mypy to use the provided type
annotations rather than going through typeshed. This way, the types are
always up to date when running mypy.
Remove outdated ignores since dropping Python 2.