Merge pull request #1 from Pavkazzz/add-mypy

Mypy support

Author: mosquito

.github/workflows/pythonpackage.yml

@@ -0,0 +1,33 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Python package
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.5, 3.6, 3.7, 3.8]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+        pip install -r requirements.dev.txt
+    - name: Test with pytest
+      run: |
+        pytest

.gitignore

@@ -138,3 +138,5 @@ fabric.properties
 .DS_Store
 
 /*/version.py
+
+.mypy_cache/*

.travis.yml

@@ -4,9 +4,12 @@ matrix:
   include:
     - python: 3.5
       env: TOXENV=py35
-
     - python: 3.6
       env: TOXENV=py36
+    - python: 3.7
+      env: TOXENV=py36
+    - python: 3.8
+      env: TOXENV=py36
 install:
   - pip install tox coveralls codecov
 script:

Makefile

@@ -36,3 +36,6 @@ develop: purge bump
 	env/bin/pip install -Ue '.[develop]'
 
 release: test upload
+
+mypy:
+	mypy jwt_rsa

jwt_rsa/__init__.py

@@ -4,7 +4,6 @@
     version_info = (0, 0, 0, 'x')
     __version__ = '{}.{}.{}+{}'.format(*version_info)
 
-
 authors = (
     ('Dmitry Orlov', '[email protected]'),
 )

jwt_rsa/issue.py

@@ -14,7 +14,7 @@
                     type=float, default=...)
 
 
-def main():
+def main() -> None:
     arguments = parser.parse_args()
     jwt = JWT(private_key=arguments.private_key)
     print(

jwt_rsa/keygen.py

@@ -6,7 +6,7 @@
 from cryptography.hazmat.primitives import serialization
 
 
-def main():
+def main() -> None:
     parser = argparse.ArgumentParser()
     parser.add_argument('-b', '--bits', dest="bits", type=int, default=2048)
     parser.add_argument('-P', '--pem', dest="pem", action='store_true')

jwt_rsa/rsa.py

@@ -1,21 +1,18 @@
 import base64
 from collections import namedtuple
-from typing import Tuple
 
 from cryptography.hazmat.backends import default_backend
-from cryptography.hazmat.primitives.asymmetric import rsa
 from cryptography.hazmat.primitives import serialization
-
+from cryptography.hazmat.primitives.asymmetric import rsa
 from cryptography.hazmat.primitives.asymmetric.rsa import (
     RSAPrivateKeyWithSerialization as RSAPrivateKey,
     RSAPublicKeyWithSerialization as RSAPublicKey,
 )
 
-
 KeyPair = namedtuple('KeyPair', ('private', 'public'))
 
 
-def generate_rsa(bits=2048) -> Tuple[RSAPrivateKey, RSAPublicKey]:
+def generate_rsa(bits: int = 2048) -> KeyPair:
     '''
     Generate an RSA keypair with an exponent of 65537 in PEM format
     param: bits The key length in bits

jwt_rsa/token.py

@@ -1,13 +1,20 @@
 import time
-from datetime import timedelta, datetime
-from operator import sub, add
-from typing import Union
+from datetime import datetime, timedelta
+from operator import add, sub
+from typing import Any, Callable, Dict, Optional, TYPE_CHECKING, TypeVar, \
+    Union
 
 from jwt import PyJWT
+
 from jwt_rsa.rsa import RSAPrivateKey, RSAPublicKey
 
+if TYPE_CHECKING:
+    # pylama:ignore=E0602
+    DateType = Union[timedelta, datetime, float, int, ellipsis]
+else:
+    DateType = Union[timedelta, datetime, float, int, type(Ellipsis)]
 
-DateType = Union[timedelta, datetime, float, int, type(Ellipsis)]
+R = TypeVar('R')
 
 
 class JWT:
@@ -21,9 +28,14 @@ class JWT:
         'ES521', 'ES512', 'PS256', 'PS384', 'PS512'
     })
 
-    def __init__(self, private_key: RSAPrivateKey=None,
-                 public_key: RSAPublicKey=None, expires=None,
-                 nbf_delta=None, algorithm="RS512"):
+    def __init__(
+        self,
+        private_key: Optional[RSAPrivateKey] = None,
+        public_key: Optional[RSAPublicKey] = None,
+        expires: Optional[int] = None,
+        nbf_delta: Optional[int] = None,
+        algorithm: str = "RS512"
+    ):
 
         self.__private_key = private_key
         self.__public_key = public_key
@@ -32,7 +44,12 @@ def __init__(self, private_key: RSAPrivateKey=None,
         self.__nbf_delta = nbf_delta or self.NBF_DELTA
         self.__algorithm = algorithm
 
-    def _date_to_timestamp(self, value, default, timedelta_func=add):
+    def _date_to_timestamp(
+        self,
+        value: DateType,
+        default: Callable[[], R],
+        timedelta_func: Callable[[float, float], int] = add
+    ) -> Union[int, float, R]:
         if isinstance(value, timedelta):
             return timedelta_func(time.time(), value.total_seconds())
         elif isinstance(value, datetime):
@@ -44,7 +61,12 @@ def _date_to_timestamp(self, value, default, timedelta_func=add):
 
         raise ValueError(type(value))
 
-    def encode(self, expired: DateType=..., nbf: DateType=..., **claims) -> str:
+    def encode(
+        self,
+        expired: DateType = ...,
+        nbf: DateType = ...,
+        **claims: int
+    ) -> str:
         if not self.__private_key:
             raise RuntimeError("Can't encode without private key")
 
@@ -72,7 +94,9 @@ def encode(self, expired: DateType=..., nbf: DateType=..., **claims) -> str:
             algorithm=self.__algorithm,
         ).decode()
 
-    def decode(self, token: str, verify=True, **kwargs) -> dict:
+    def decode(
+        self, token: str, verify: bool = True, **kwargs: Any
+    ) -> Dict[str, Any]:
         if not self.__public_key:
             raise RuntimeError("Can't decode without public key")
 

jwt_rsa/verify.py

@@ -8,7 +8,7 @@
 from jwt_rsa.rsa import load_private_key, load_public_key
 
 
-def main():
+def main() -> None:
     logging.basicConfig(level=logging.INFO)
 
     logging.info("Awaiting JSON on stdin...")