Commits on Aug 1, 2024

1. Improve type annotations for the option parameter in decode methods. …

   The options parameter currently accepts any key-value pair so long as the key is of type string (`options: dict[str, Any] | None = None`) and overwrites the default values with the arguments, as opposed to being limited to a strict set of keys and values (see [TypedDict](https://typing.readthedocs.io/en/latest/spec/typeddict.html#class-based-syntax)).
   
   Fixes: #869
   
   ***
   
   Here's a minimal reproducible example you can try at the [MyPy Playground](https://mypy-play.net/?mypy=latest&python=3.12).
   
   ```python
   
   from typing import TypedDict, List
   
   class JwtOptions(TypedDict):
       verify_signature: bool
       verify_exp: bool
       verify_nbf: bool
       verify_iat: bool
       verify_aud: bool
       verify_iss: bool
       require: List[str]
   
   class PyJWT:
       def __init__(self, options: JwtOptions | None = None) -> None:
           if options is None:
               self.options: JwtOptions = self._get_default_options()
   
       @staticmethod
       def _get_default_options() -> JwtOptions:
           return {
               "verify_signature": True,
               "verify_exp": True,
               "verify_nbf": True,
               "verify_iat": True,
               "verify_aud": True,
               "verify_iss": True,
               "require": [],
           }
   
       def decode(self, options: JwtOptions) -> None:
           pass
   
   pyJWT = PyJWT()
   
   pyJWT.decode(options={
       'verify_signature': True,
       'verify_exp': True,
       'verify_nbf': True,
       'verify_iat': True,
       'verify_aud': True,
       'verify_iss': True,
       'required': [] # misspelled key
   })
   ```
   
   Signed-off-by: Pedro Aguiar <contact@codespearhead.com>

   

   codespearhead committed Aug 1, 2024
   Configuration menu

   • View commit details
   • Copy full SHA for 10d0f09
   • Browse repository at this point

   Copy the full SHA

   10d0f09 View commit details

   Browse the repository at this point in the history