RFC: Add type hints #344
RFC: Add type hints #344
Conversation
jwt/api_jws.py
Outdated
| def encode(self, payload, key, algorithm='HS256', headers=None, | ||
| json_encoder=None): | ||
| def encode_bytes(self, | ||
| payload, # type: bytes |
There was a problem hiding this comment.
I'm wondering if we could leave this as .encode() and make the type for payload Union[bytes, Dict]?
There was a problem hiding this comment.
It's possible, doing so mypy says:
jwt/api_jwt.py:57: error: Unsupported target for indexed assignment
because the function is using the payload it as a dictionary. But before that there's a check for it and an error being thrown if it's not so I think it's fine to silence it.
The new commit does that and revert encode_bytes to encode
| @@ -55,7 +66,12 @@ def encode(self, payload, key, algorithm='HS256', headers=None, | |||
| json_payload, key, algorithm, headers, json_encoder | |||
| ) | |||
|
|
|||
| def decode(self, jwt, key='', verify=True, algorithms=None, options=None, | |||
There was a problem hiding this comment.
change jwt -> token, changes public interface and broken my code
There was a problem hiding this comment.
Sorry, I didn't see it as a major change as the argument is positional, turns out I was wrong and there are users with the same problem. It has been reverted here
I decided to use the time my company, Flixbus, dedicates to FOSS projects to contribute to this package.
This PR adds type hints as described in issue #312 and includes
mypyin Travis configuration. This means that IDEs can automatically detect type errors and results from static check tools can improve.There are a few doubts about which I'd like a feedback and for which I'm ready to work to change/fix:
Mypy complains about
PyJWT.encodenot being a subtype ofPyJWS.encode, and the same fordecode. In the case ofdecodethe problem is that one calls the tokenjwtand the otherjws, so I just called bothtoken. As forencodethe problem is thatJWSexpects bytes andJWTa dictionary, so I changedJWS.encodetoJWS.encode_bytes. In the documentation there are no examples about using that function, but it is a breaking change for who uses it.The change required to import the
typingmodule in atry...catch, so it can be imported when checking the types but is ignored during normal usage of the library. It's a bit ugly but I couldn't find other ways to have it work on Python 2.7I didn't update the changelog or bump the version, if
JWS.encodeis considered part of the API I guess the major version number is affected