Skip to content

Annotate jwt.algorithms #2532

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.

Sign up for GitHub

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 4 commits into from
Oct 23, 2018
Merged

Annotate jwt.algorithms #2532

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9ccd0b3
Annotate jwt.algorithms
srittau Oct 21, 2018
1c7be01
Fix return type of Algorithm.prepare_key()
srittau Oct 21, 2018
829a28b
Fix types and attribute name
srittau Oct 23, 2018
59bbecc
Add cryptography algorithms
srittau Oct 23, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 42 additions & 2 deletions third_party/3/jwt/algorithms.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,43 @@
from typing import Any
import sys
from hashlib import _Hash
from typing import Any, Set, Dict, Optional, ClassVar, Union, Generic, TypeVar

class Algorithm(Any): ... # type: ignore
requires_cryptography = Set[str]

def get_default_algorithms() -> Dict[str, Algorithm]: ...

_K = TypeVar("_K")

class Algorithm(Generic[_K]):
def prepare_key(self, key: _K) -> _K: ...
def sign(self, msg: bytes, key: _K) -> bytes: ...
def verify(self, msg: bytes, key: _K, sig: bytes) -> bool: ...
@staticmethod
def to_jwk(key_obj: _K) -> str: ...
@staticmethod
def from_jwk(jwk: str) -> _K: ...
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this works correctly:

$ cat bin/genstat.py 
from typing import *

T = TypeVar('T')

class A(Generic[T]):
    @staticmethod
    def foo() -> T:
        pass

class B(A[int]):
    pass

reveal_type(B.foo())
$ python3.7 -m mypy bin/genstat.py 
bin/genstat.py:13: error: Revealed type is 'T`1'

This is python/mypy#1337.

There doesn't appear to be a good workaround, so we may have to use Any for now.


class NoneAlgorithm(Algorithm[None]):
def prepare_key(self, key: Optional[str]) -> None: ...

class _HashAlg:
def __call__(self, arg: Union[bytes, bytearray, memoryview] = ...) -> _Hash: ...

if sys.version_info >= (3, 6):
_LoadsString = Union[str, bytes, bytearray]
else:
_LoadsString = str

class HMACAlgorithm(Algorithm[bytes]):
SHA256: ClassVar[_HashAlg]
SHA384: ClassVar[_HashAlg]
SHA512: ClassVar[_HashAlg]
has_alg: _HashAlg
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hash_alg

def __init__(self, _HashAlg) -> None: ...
def prepare_key(self, key: Union[str, bytes]) -> bytes: ...
@staticmethod
def to_jwk(key_obj: Union[str, bytes]) -> Any: ...
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems to actually return str.

@staticmethod
def from_jwk(jwk: _LoadsString) -> bytes: ...

# If cryptography is installed, also has classes RSAAlgorithm and ECAlgorithm.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should also have stubs for these classes then. False negatives are better than false positives.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. I left them out for now, since we don't have stubs for cryptography, yet, but we could of course use Any.