refactor: Support TypedDict

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 José Padilla
+Copyright (c) 2015-2022 José Padilla
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

docs/conf.py

@@ -51,7 +51,7 @@ def find_version(*file_paths):
 
 # General information about the project.
 project = "PyJWT"
-copyright = "2015, José Padilla"
+copyright = "2015-2022, José Padilla"
 author = "José Padilla"
 
 # The version info for the project you're documenting, acts as replacement for

jwt/__init__.py

@@ -37,7 +37,7 @@
 __email__ = "hello@jpadilla.com"
 
 __license__ = "MIT"
-__copyright__ = "Copyright 2015-2020 José Padilla"
+__copyright__ = "Copyright 2015-2022 José Padilla"
 
 
 __all__ = [

jwt/api_jws.py

@@ -1,7 +1,8 @@
 import binascii
 import json
 from collections.abc import Mapping
-from typing import Any, Dict, List, Optional, Type
+from sys import version_info
+from typing import Dict, List, Optional, Type
 
 from .algorithms import (
     Algorithm,
@@ -17,11 +18,26 @@
 )
 from .utils import base64url_decode, base64url_encode
 
+if version_info < (3, 8):
+    from typing_extensions import TypedDict
+else:
+    from typing import TypedDict
+
+
+class PyJWSOptions(TypedDict):
+    verify_signature: bool
+
+
+class DecodedPyJWS(TypedDict):
+    payload: bytes
+    header: Mapping
+    signature: bytes
+
 
 class PyJWS:
     header_typ = "JWT"
 
-    def __init__(self, algorithms=None, options=None):
+    def __init__(self, algorithms=None, options: Optional[PyJWSOptions] = None):
         self._algorithms = get_default_algorithms()
         self._valid_algs = (
             set(algorithms) if algorithms is not None else set(self._algorithms)
@@ -33,12 +49,12 @@ def __init__(self, algorithms=None, options=None):
                 del self._algorithms[key]
 
         if options is None:
-            options = {}
-        self.options = {**self._get_default_options(), **options}
+            options = PyJWSOptions()
+        self.options = PyJWSOptions({**self._get_default_options(), **options})
 
     @staticmethod
-    def _get_default_options():
-        return {"verify_signature": True}
+    def _get_default_options() -> PyJWSOptions:
+        return PyJWSOptions(verify_signature=True)
 
     def register_algorithm(self, alg_id, alg_obj):
         """
@@ -133,12 +149,12 @@ def decode_complete(
         jwt: str,
         key: str = "",
         algorithms: Optional[List[str]] = None,
-        options: Optional[Dict] = None,
+        options: Optional[PyJWSOptions] = None,
         **kwargs,
-    ) -> Dict[str, Any]:
+    ) -> DecodedPyJWS:
         if options is None:
-            options = {}
-        merged_options = {**self.options, **options}
+            options = PyJWSOptions()
+        merged_options = PyJWSOptions({**self.options, **options})
         verify_signature = merged_options["verify_signature"]
 
         if verify_signature and not algorithms:
@@ -151,18 +167,18 @@ def decode_complete(
         if verify_signature:
             self._verify_signature(signing_input, header, signature, key, algorithms)
 
-        return {
-            "payload": payload,
-            "header": header,
-            "signature": signature,
-        }
+        return DecodedPyJWS(
+            payload=payload,
+            header=header,
+            signature=signature,
+        )
 
     def decode(
         self,
         jwt: str,
         key: str = "",
         algorithms: Optional[List[str]] = None,
-        options: Optional[Dict] = None,
+        options: Optional[PyJWSOptions] = None,
         **kwargs,
     ) -> str:
         decoded = self.decode_complete(jwt, key, algorithms, options, **kwargs)

jwt/api_jwt.py

@@ -2,7 +2,8 @@
 from calendar import timegm
 from collections.abc import Iterable, Mapping
 from datetime import datetime, timedelta, timezone
-from typing import Any, Dict, List, Optional, Type, Union
+from sys import version_info
+from typing import Any, Dict, List, Optional, Type
 
 from . import api_jws
 from .exceptions import (
@@ -15,24 +16,38 @@
     MissingRequiredClaimError,
 )
 
+if version_info < (3, 8):
+    from typing_extensions import TypedDict
+else:
+    from typing import TypedDict
+
+
+class PyJWTOptions(TypedDict):
+    verify_signature: bool
+    verify_exp: bool
+    verify_nbf: bool
+    verify_iat: bool
+    verify_iss: bool
+    require: List[str]
+
 
 class PyJWT:
-    def __init__(self, options=None):
+    def __init__(self, options: Optional[PyJWTOptions] = None):
         if options is None:
             options = {}
-        self.options = {**self._get_default_options(), **options}
+        self.options = PyJWTOptions(**self._get_default_options(), **options)
 
     @staticmethod
-    def _get_default_options() -> Dict[str, Union[bool, List[str]]]:
-        return {
-            "verify_signature": True,
-            "verify_exp": True,
-            "verify_nbf": True,
-            "verify_iat": True,
-            "verify_aud": True,
-            "verify_iss": True,
-            "require": [],
-        }
+    def _get_default_options() -> PyJWTOptions:
+        return PyJWTOptions(
+            verify_signature=True,
+            verify_exp=True,
+            verify_nbf=True,
+            verify_iat=True,
+            verify_aud=True,
+            verify_iss=True,
+            require=[],
+        )
 
     def encode(
         self,
@@ -67,11 +82,11 @@ def decode_complete(
         jwt: str,
         key: str = "",
         algorithms: Optional[List[str]] = None,
-        options: Optional[Dict] = None,
+        options: Optional[PyJWTOptions] = None,
         **kwargs,
     ) -> Dict[str, Any]:
         if options is None:
-            options = {"verify_signature": True}
+            options = PyJWTOptions(verify_signature=True)
         else:
             options.setdefault("verify_signature", True)
 
@@ -102,7 +117,7 @@ def decode_complete(
         if not isinstance(payload, dict):
             raise DecodeError("Invalid payload string: must be a json object")
 
-        merged_options = {**self.options, **options}
+        merged_options = PyJWTOptions({**self.options, **options})
         self._validate_claims(payload, merged_options, **kwargs)
 
         decoded["payload"] = payload
@@ -113,7 +128,7 @@ def decode(
         jwt: str,
         key: str = "",
         algorithms: Optional[List[str]] = None,
-        options: Optional[Dict] = None,
+        options: Optional[PyJWTOptions] = None,
         **kwargs,
     ) -> Dict[str, Any]:
         decoded = self.decode_complete(jwt, key, algorithms, options, **kwargs)

setup.cfg

@@ -36,6 +36,9 @@ include_package_data = true
 python_requires = >=3.6
 packages = find:
 
+install_requires =
+    typing-extensions>=4;python_version<"3.8"
+
 [options.package_data]
 * = py.typed