fix: lockdown type-hinting syntax to python3.9

Author: aekasitt

src/fastapi_csrf_protect/__init__.py

@@ -12,13 +12,10 @@
 FastAPI extension that provides Csrf Protection Token support
 """
 
-### Standard packages ###
-from typing import Tuple
-
 ### Local modules ###
 from fastapi_csrf_protect.core import CsrfProtect
 
-__all__: Tuple[str, ...] = ("CsrfProtect",)
+__all__: tuple[str, ...] = ("CsrfProtect",)
 __name__ = "fastapi-csrf-protect"
 __package__ = "fastapi-csrf-protect"
 __version__ = "1.0.4"

src/fastapi_csrf_protect/core.py

@@ -13,7 +13,7 @@
 from hashlib import sha1
 from re import match
 from os import urandom
-from typing import Dict, Optional, Tuple, Union
+from typing import Optional, Union
 
 ### Third-party packages ###
 from itsdangerous import BadData, SignatureExpired, URLSafeTimedSerializer
@@ -32,7 +32,7 @@
 
 
 class CsrfProtect(CsrfConfig):
-  def generate_csrf_tokens(self, secret_key: Optional[str] = None) -> Tuple[str, str]:
+  def generate_csrf_tokens(self, secret_key: Optional[str] = None) -> tuple[str, str]:
     """
     Generate a CSRF token and a signed CSRF token using server's secret key to be stored in cookie.
 
@@ -56,7 +56,7 @@ def get_csrf_from_body(self, data: bytes) -> str:
     :param data: attached request body containing cookie data with configured `token_key`
     :type data: bytes
     """
-    fields: Dict[str, Tuple[type, str]] = {self._token_key: (str, "csrf-token")}
+    fields: dict[str, tuple[type, str]] = {self._token_key: (str, "csrf-token")}
     Body = create_model("Body", **fields)
     content: str = '{"' + data.decode("utf-8").replace("&", '","').replace("=", '":"') + '"}'
     body = Body.model_validate_json(content)
@@ -192,4 +192,4 @@ async def validate_csrf(
       raise TokenValidationError("The CSRF token is invalid.")
 
 
-__all__: Tuple[str, ...] = ("CsrfProtect",)
+__all__: tuple[str, ...] = ("CsrfProtect",)

src/fastapi_csrf_protect/csrf_config.py

@@ -10,10 +10,9 @@
 # *************************************************************
 
 ### Standard packages ###
-from typing import Any, ClassVar, Callable, Literal, Optional, Sequence, Set, Tuple, Union, cast
+from typing import Any, ClassVar, Callable, Literal, Optional, Sequence, Set, Union
 
 ### Third-party packages ###
-from pydantic import ValidationError
 from pydantic_settings import BaseSettings
 
 ### Local modules ###
@@ -42,29 +41,25 @@ class CsrfConfig(object):
 
   @classmethod
   def load_config(
-    cls, settings: Callable[..., Union[Sequence[Tuple[str, Any]], BaseSettings]]
+    cls, settings: Callable[..., Union[Sequence[tuple[str, Any]], BaseSettings]]
   ) -> None:
-    try:
-      config = LoadConfig(**{key.lower(): value for key, value in settings()})
-      cls._cookie_key = config.cookie_key or cls._cookie_key
-      cls._cookie_path = config.cookie_path or cls._cookie_path
-      cls._cookie_domain = config.cookie_domain
-      if config.cookie_samesite in {"lax", "none", "strict"}:
-        cls._cookie_samesite = cast(Literal["lax", "none", "strict"], config.cookie_samesite)
-      cls._cookie_secure = False if config.cookie_secure is None else config.cookie_secure
-      cls._header_name = config.header_name or cls._header_name
-      cls._header_type = config.header_type
-      cls._httponly = True if config.httponly is None else config.httponly
-      cls._max_age = config.max_age or cls._max_age
-      cls._methods = config.methods or cls._methods
-      cls._secret_key = config.secret_key
-      cls._token_location = config.token_location or cls._token_location
-      cls._token_key = config.token_key or cls._token_key
-    except ValidationError:
-      raise
-    except Exception as err:
-      print(err)
-      raise TypeError('CsrfConfig must be pydantic "BaseSettings" or list of tuple')
+    """
+    :raises pydantic_core.ValidationError: in case of settings' attribute type mismatched
+    """
+    config = LoadConfig(**{key.lower(): value for key, value in settings()})
+    cls._cookie_key = config.cookie_key or cls._cookie_key
+    cls._cookie_path = config.cookie_path or cls._cookie_path
+    cls._cookie_domain = config.cookie_domain
+    cls._cookie_samesite = config.cookie_samesite
+    cls._cookie_secure = False if config.cookie_secure is None else config.cookie_secure
+    cls._header_name = config.header_name or cls._header_name
+    cls._header_type = config.header_type
+    cls._httponly = True if config.httponly is None else config.httponly
+    cls._max_age = config.max_age or cls._max_age
+    cls._methods = config.methods or cls._methods
+    cls._secret_key = config.secret_key
+    cls._token_location = config.token_location or cls._token_location
+    cls._token_key = config.token_key or cls._token_key
 
 
-__all__: Tuple[str, ...] = ("CsrfConfig",)
+__all__: tuple[str, ...] = ("CsrfConfig",)

src/fastapi_csrf_protect/exceptions.py

@@ -9,10 +9,6 @@
 # HISTORY:
 # *************************************************************
 
-### Standard packages ###
-from typing import Tuple
-
-
 class CsrfProtectError(Exception):
   def __init__(self, status_code: int, message: str):
     self.status_code = status_code
@@ -34,7 +30,7 @@ def __init__(self, message: str):
     super().__init__(401, message)
 
 
-__all__: Tuple[str, ...] = (
+__all__: tuple[str, ...] = (
   "CsrfProtectError",
   "InvalidHeaderError",
   "MissingTokenError",

src/fastapi_csrf_protect/flexible/__init__.py

@@ -9,10 +9,7 @@
 # HISTORY:
 # *************************************************************
 
-### Standard packages ###
-from typing import Tuple
-
 ### Local modules ###
 from fastapi_csrf_protect.flexible.core import CsrfProtect
 
-__all__: Tuple[str, ...] = ("CsrfProtect",)
+__all__: tuple[str, ...] = ("CsrfProtect",)

src/fastapi_csrf_protect/flexible/core.py

@@ -13,7 +13,7 @@
 from hashlib import sha1
 from os import urandom
 from re import match
-from typing import Dict, Tuple, Optional, Union
+from typing import Optional, Union
 
 ### Third-party packages ###
 from itsdangerous import BadData, SignatureExpired, URLSafeTimedSerializer
@@ -38,7 +38,7 @@ class CsrfProtect(CsrfConfig):
     2. Body
   """
 
-  def generate_csrf_tokens(self, secret_key: Optional[str] = None) -> Tuple[str, str]:
+  def generate_csrf_tokens(self, secret_key: Optional[str] = None) -> tuple[str, str]:
     """
     Generate a CSRF token and a signed CSRF token using server's secret key to be stored in cookie.
 
@@ -62,7 +62,7 @@ def get_csrf_from_body(self, data: bytes) -> str:
     :param data: attached request body containing cookie data with configured `token_key`
     :type data: bytes
     """
-    fields: Dict[str, Tuple[type, str]] = {self._token_key: (str, "csrf-token")}
+    fields: dict[str, tuple[type, str]] = {self._token_key: (str, "csrf-token")}
     Body = create_model("Body", **fields)
     content: str = '{"' + data.decode("utf-8").replace("&", '","').replace("=", '":"') + '"}'
     body = Body.model_validate_json(content)
@@ -171,7 +171,7 @@ async def validate_csrf(
     if signed_token is None:
       raise MissingTokenError(f"Missing Cookie: `{cookie_key}`.")
     time_limit = time_limit or self._max_age
-    token: None | str = self.get_csrf_from_headers(request.headers)
+    token: Optional[str] = self.get_csrf_from_headers(request.headers)
     if not token:
       token = self.get_csrf_from_body(await request.body())
     serializer = URLSafeTimedSerializer(secret_key, salt="fastapi-csrf-token")
@@ -185,4 +185,4 @@ async def validate_csrf(
       raise TokenValidationError("The CSRF token is invalid.")
 
 
-__all__: Tuple[str, ...] = ("CsrfProtect",)
+__all__: tuple[str, ...] = ("CsrfProtect",)

src/fastapi_csrf_protect/flexible/csrf_config.py

@@ -10,10 +10,9 @@
 # *************************************************************
 
 ### Standard packages ###
-from typing import Any, ClassVar, Callable, Literal, Optional, Sequence, Set, Tuple, Union, cast
+from typing import Any, ClassVar, Callable, Literal, Optional, Sequence, Set, Union
 
 ### Third-party packages ###
-from pydantic import ValidationError
 from pydantic_settings import BaseSettings
 
 ### Local modules ###
@@ -41,28 +40,24 @@ class CsrfConfig(object):
 
   @classmethod
   def load_config(
-    cls, settings: Callable[..., Union[Sequence[Tuple[str, Any]], BaseSettings]]
+    cls, settings: Callable[..., Union[Sequence[tuple[str, Any]], BaseSettings]]
   ) -> None:
-    try:
-      config = LoadConfig(**{key.lower(): value for key, value in settings()})
-      cls._cookie_key = config.cookie_key or cls._cookie_key
-      cls._cookie_path = config.cookie_path or cls._cookie_path
-      cls._cookie_domain = config.cookie_domain
-      if config.cookie_samesite in {"lax", "none", "strict"}:
-        cls._cookie_samesite = cast(Literal["lax", "none", "strict"], config.cookie_samesite)
-      cls._cookie_secure = False if config.cookie_secure is None else config.cookie_secure
-      cls._header_name = config.header_name or cls._header_name
-      cls._header_type = config.header_type
-      cls._httponly = True if config.httponly is None else config.httponly
-      cls._max_age = config.max_age or cls._max_age
-      cls._methods = config.methods or cls._methods
-      cls._secret_key = config.secret_key
-      cls._token_key = config.token_key or cls._token_key
-    except ValidationError:
-      raise
-    except Exception as err:
-      print(err)
-      raise TypeError('CsrfConfig must be pydantic "BaseSettings" or list of tuple')
-
-
-__all__: Tuple[str, ...] = ("CsrfConfig",)
+    """
+    :raises pydantic_core.ValidationError: in case of settings' attribute type mismatched
+    """
+    config = LoadConfig(**{key.lower(): value for key, value in settings()})
+    cls._cookie_key = config.cookie_key or cls._cookie_key
+    cls._cookie_path = config.cookie_path or cls._cookie_path
+    cls._cookie_domain = config.cookie_domain
+    cls._cookie_samesite = config.cookie_samesite
+    cls._cookie_secure = False if config.cookie_secure is None else config.cookie_secure
+    cls._header_name = config.header_name or cls._header_name
+    cls._header_type = config.header_type
+    cls._httponly = True if config.httponly is None else config.httponly
+    cls._max_age = config.max_age or cls._max_age
+    cls._methods = config.methods or cls._methods
+    cls._secret_key = config.secret_key
+    cls._token_key = config.token_key or cls._token_key
+
+
+__all__: tuple[str, ...] = ("CsrfConfig",)

src/fastapi_csrf_protect/flexible/load_config.py

@@ -11,7 +11,7 @@
 
 ### Standard packages ###
 from __future__ import annotations
-from typing import Literal, Optional, Set, Tuple
+from typing import Literal, Optional, Set
 
 ### Third-party packages ###
 from pydantic import (
@@ -45,4 +45,4 @@ def validate_cookie_samesite_none_secure(self) -> LoadConfig:
     return self
 
 
-__all__: Tuple[str, ...] = ("LoadConfig",)
+__all__: tuple[str, ...] = ("LoadConfig",)

src/fastapi_csrf_protect/load_config.py

@@ -11,7 +11,7 @@
 
 ### Standard packages ###
 from __future__ import annotations
-from typing import Literal, Optional, Set, Tuple
+from typing import Literal, Optional, Set
 
 ### Third-party packages ###
 from pydantic import (
@@ -53,4 +53,4 @@ def validate_token_key(self) -> LoadConfig:
     return self
 
 
-__all__: Tuple[str, ...] = ("LoadConfig",)
+__all__: tuple[str, ...] = ("LoadConfig",)

tests/__init__.py

@@ -11,7 +11,6 @@
 
 ### Standard packages ###
 from collections.abc import Generator
-from typing import Tuple
 
 ### Third-party packages ###
 from fastapi import Depends, FastAPI, Request
@@ -62,4 +61,4 @@ def csrf_protect_error_handler(request: Request, exc: CsrfProtectError) -> JSONR
     yield client
 
 
-__all__: Tuple[str, ...] = ("test_client",)
+__all__: tuple[str, ...] = ("test_client",)