starmallow 0.7.0__py3-none-any.whl → 0.9.0__py3-none-any.whl

starmallow/security/oauth2.py

@@ -1,7 +1,7 @@
-from typing import Any, Dict, List, Optional, Union
+from typing import Annotated, Any, ClassVar
 
 import marshmallow as ma
-from marshmallow_dataclass import dataclass as ma_dataclass
+from marshmallow_dataclass2 import dataclass as ma_dataclass
 from starlette.requests import Request
 from starlette.status import HTTP_401_UNAUTHORIZED, HTTP_403_FORBIDDEN
 
@@ -15,14 +15,14 @@ from starmallow.security.utils import get_authorization_scheme_param
 # region - Models
 @ma_dataclass(frozen=True)
 class OAuthFlow:
-    refreshUrl: Optional[str] = optional_field()
-    scopes: Dict[str, str] = optional_field(default_factory=dict)
+    refreshUrl: str | None = optional_field()
+    scopes: dict[str, str] = optional_field(default_factory=dict)
 
     class Meta:
         unknown = ma.INCLUDE
 
     @ma.post_dump()
-    def post_dump(self, data: Dict[str, Any], **kwargs):
+    def post_dump(self, data: dict[str, Any], **kwargs):
         # Remove None values
         return {
             key: value
@@ -54,16 +54,16 @@ class OAuthFlowAuthorizationCode(OAuthFlow):
 
 @ma_dataclass(frozen=True)
 class OAuthFlowsModel:
-    implicit: Optional[OAuthFlowImplicit] = optional_field()
-    password: Optional[OAuthFlowPassword] = optional_field()
-    clientCredentials: Optional[OAuthFlowClientCredentials] = optional_field()
-    authorizationCode: Optional[OAuthFlowAuthorizationCode] = optional_field()
+    implicit: OAuthFlowImplicit | None = optional_field()
+    password: OAuthFlowPassword | None = optional_field()
+    clientCredentials: OAuthFlowClientCredentials | None = optional_field()
+    authorizationCode: OAuthFlowAuthorizationCode | None = optional_field()
 
     class Meta:
         unknown = ma.INCLUDE
 
     @ma.post_dump()
-    def post_dump(self, data: Dict[str, Any], **kwargs):
+    def post_dump(self, data: dict[str, Any], **kwargs):
         # Remove None values
         return {
             key: value
@@ -74,7 +74,7 @@ class OAuthFlowsModel:
 
 @ma_dataclass(frozen=True)
 class OAuth2Model(SecurityBase):
-    type: SecurityTypes = SecurityTypes.oauth2
+    type: ClassVar[SecurityTypes] = SecurityTypes.oauth2
     flows: OAuthFlowsModel = required_field()
 # endregion
 
@@ -114,12 +114,12 @@ class OAuth2PasswordRequestForm:
 
     def __init__(
         self,
-        grant_type: str = Form(default=None, regex="password"),
-        username: str = Form(),
-        password: str = Form(),
-        scope: str = Form(default=""),
-        client_id: Optional[str] = Form(default=None),
-        client_secret: Optional[str] = Form(default=None),
+        grant_type: Annotated[str, Form(default=None, regex="password")],
+        username: Annotated[str, Form()],
+        password: Annotated[str, Form()],
+        scope: Annotated[str, Form(default="")],
+        client_id: Annotated[str | None, Form(default=None)],
+        client_secret: Annotated[str | None, Form(default=None)],
     ):
         self.grant_type = grant_type
         self.username = username
@@ -164,12 +164,12 @@ class OAuth2PasswordRequestFormStrict(OAuth2PasswordRequestForm):
 
     def __init__(
         self,
-        grant_type: str = Form(regex="password"),
-        username: str = Form(),
-        password: str = Form(),
-        scope: str = Form(default=""),
-        client_id: Optional[str] = Form(default=None),
-        client_secret: Optional[str] = Form(default=None),
+        grant_type: Annotated[str, Form(regex="password")],
+        username: Annotated[str, Form()],
+        password: Annotated[str, Form()],
+        scope: Annotated[str, Form(default="")],
+        client_id: Annotated[str | None, Form(default=None)],
+        client_secret:Annotated[str | None, Form(default=None)],
     ):
         super().__init__(
             grant_type=grant_type,
@@ -185,16 +185,16 @@ class OAuth2(SecurityBaseResolver):
     def __init__(
         self,
         *,
-        flows: Union[OAuthFlowsModel, Dict[str, Dict[str, Any]]] = OAuthFlowsModel(),
-        scheme_name: Optional[str] = None,
-        description: Optional[str] = None,
+        flows: OAuthFlowsModel | None = None,
+        scheme_name: str | None = None,
+        description: str | None = None,
         auto_error: bool = True,
     ):
-        self.model = OAuth2Model(flows=flows, description=description)
+        self.model = OAuth2Model(flows=flows or OAuthFlowsModel(), description=description)
         self.scheme_name = scheme_name or self.__class__.__name__
         self.auto_error = auto_error
 
-    async def __call__(self, request: Request) -> Optional[str]:
+    async def __call__(self, request: Request) -> str | None:
         authorization = request.headers.get("Authorization")
         if not authorization:
             if self.auto_error:
@@ -209,15 +209,15 @@ class OAuth2(SecurityBaseResolver):
 class OAuth2PasswordBearer(OAuth2):
     def __init__(
         self,
-        tokenUrl: str,
-        scheme_name: Optional[str] = None,
-        scopes: Optional[Dict[str, str]] = None,
-        description: Optional[str] = None,
+        tokenUrl: str, # noqa: N803
+        scheme_name: str | None = None,
+        scopes: dict[str, str] | None = None,
+        description: str | None = None,
         auto_error: bool = True,
     ):
         if not scopes:
             scopes = {}
-        flows = OAuthFlowsModel(password={"tokenUrl": tokenUrl, "scopes": scopes})
+        flows = OAuthFlowsModel(password=OAuthFlowPassword(tokenUrl=tokenUrl, scopes=scopes))
         super().__init__(
             flows=flows,
             scheme_name=scheme_name,
@@ -225,7 +225,7 @@ class OAuth2PasswordBearer(OAuth2):
             auto_error=auto_error,
         )
 
-    async def __call__(self, request: Request) -> Optional[str]:
+    async def __call__(self, request: Request) -> str | None:
         authorization = request.headers.get("Authorization")
         scheme, param = get_authorization_scheme_param(authorization)
         if not authorization or scheme.lower() != "bearer":
@@ -243,23 +243,23 @@ class OAuth2PasswordBearer(OAuth2):
 class OAuth2AuthorizationCodeBearer(OAuth2):
     def __init__(
         self,
-        authorizationUrl: str,
-        tokenUrl: str,
-        refreshUrl: Optional[str] = None,
-        scheme_name: Optional[str] = None,
-        scopes: Optional[Dict[str, str]] = None,
-        description: Optional[str] = None,
+        authorizationUrl: str, # noqa: N803
+        tokenUrl: str, # noqa: N803
+        refresh_url: str | None = None,
+        scheme_name: str | None = None,
+        scopes: dict[str, str] | None = None,
+        description: str | None = None,
         auto_error: bool = True,
     ):
         if not scopes:
             scopes = {}
         flows = OAuthFlowsModel(
-            authorizationCode={
-                "authorizationUrl": authorizationUrl,
-                "tokenUrl": tokenUrl,
-                "refreshUrl": refreshUrl,
-                "scopes": scopes,
-            },
+            authorizationCode=OAuthFlowAuthorizationCode(
+                authorizationUrl=authorizationUrl,
+                tokenUrl=tokenUrl,
+                refreshUrl=refresh_url,
+                scopes=scopes,
+            ),
         )
         super().__init__(
             flows=flows,
@@ -268,7 +268,7 @@ class OAuth2AuthorizationCodeBearer(OAuth2):
             auto_error=auto_error,
         )
 
-    async def __call__(self, request: Request) -> Optional[str]:
+    async def __call__(self, request: Request) -> str | None:
         authorization = request.headers.get("Authorization")
         scheme, param = get_authorization_scheme_param(authorization)
         if not authorization or scheme.lower() != "bearer":
@@ -284,6 +284,6 @@ class OAuth2AuthorizationCodeBearer(OAuth2):
 
 
 class SecurityScopes:
-    def __init__(self, scopes: Optional[List[str]] = None):
+    def __init__(self, scopes: list[str] | None = None):
         self.scopes = scopes or []
         self.scope_str = " ".join(self.scopes)

starmallow/security/open_id_connect_url.py

@@ -1,6 +1,6 @@
-from typing import Optional
+from typing import ClassVar
 
-from marshmallow_dataclass import dataclass as ma_dataclass
+from marshmallow_dataclass2 import dataclass as ma_dataclass
 from starlette.exceptions import HTTPException
 from starlette.requests import Request
 from starlette.status import HTTP_403_FORBIDDEN
@@ -11,7 +11,7 @@ from starmallow.security.base import SecurityBase, SecurityBaseResolver, Securit
 
 @ma_dataclass(frozen=True)
 class OpenIdConnectModel(SecurityBase):
-    type: SecurityTypes = SecurityTypes.openIdConnect
+    type: ClassVar[SecurityTypes] = SecurityTypes.openIdConnect
     openIdConnectUrl: str = required_field()
 
 
@@ -19,9 +19,9 @@ class OpenIdConnect(SecurityBaseResolver):
     def __init__(
         self,
         *,
-        openIdConnectUrl: str,
-        scheme_name: Optional[str] = None,
-        description: Optional[str] = None,
+        openIdConnectUrl: str,  # noqa: N803
+        scheme_name: str | None = None,
+        description: str | None = None,
         auto_error: bool = True,
     ):
         self.model = OpenIdConnectModel(
@@ -30,7 +30,7 @@ class OpenIdConnect(SecurityBaseResolver):
         self.scheme_name = scheme_name or self.__class__.__name__
         self.auto_error = auto_error
 
-    async def __call__(self, request: Request) -> Optional[str]:
+    async def __call__(self, request: Request) -> str | None:
         authorization = request.headers.get("Authorization")
         if not authorization:
             if self.auto_error:

starmallow/security/utils.py

@@ -1,9 +1,6 @@
-from typing import Optional, Tuple
-
-
 def get_authorization_scheme_param(
-    authorization_header_value: Optional[str],
-) -> Tuple[str, str]:
+    authorization_header_value: str | None,
+) -> tuple[str, str]:
     if not authorization_header_value:
         return "", ""
     scheme, _, param = authorization_header_value.partition(" ")

starmallow/serializers.py

@@ -8,52 +8,53 @@ from uuid import UUID
 
 logger = logging.getLogger(__name__)
 
-def json_default(obj):
-    if isinstance(obj, bytes):
-        return obj.hex()
-    elif isinstance(obj, set):
-        return list(obj)
-    elif isinstance(obj, Decimal):
-        return str(obj)
-    elif isinstance(obj, (datetime, date)):
-        return obj.isoformat()
-    elif isinstance(obj, UUID):
-        return str(obj)
-    elif is_dataclass(obj):
-        return asdict(obj)
-    elif isinstance(obj, Enum):
-        return obj.name
+
+def json_default(o):
+    if isinstance(o, bytes):
+        return o.hex()
+    elif isinstance(o, set):
+        return list(o)
+    elif isinstance(o, Decimal):
+        return str(o)
+    elif isinstance(o, datetime | date):
+        return o.isoformat()
+    elif isinstance(o, UUID):
+        return str(o)
+    elif is_dataclass(o) and not isinstance(o, type):
+        return asdict(o)
+    elif isinstance(o, Enum):
+        return o.name
 
 
 class JSONEncoder(json.JSONEncoder):
     '''
         Simple JSONEncoder that handles additional types
     '''
-    def default(self, obj):
-        if isinstance(obj, bytes):
-            return obj.hex()
-        elif isinstance(obj, set):
-            return list(obj)
-        elif isinstance(obj, Decimal):
-            return str(obj)
-        elif isinstance(obj, (datetime, date)):
-            return obj.isoformat()
-        elif isinstance(obj, UUID):
-            return str(obj)
-        elif is_dataclass(obj):
-            return asdict(obj)
-        elif isinstance(obj, Enum):
-            return obj.name
+    def default(self, o):
+        if isinstance(o, bytes):
+            return o.hex()
+        elif isinstance(o, set):
+            return list(o)
+        elif isinstance(o, Decimal):
+            return str(o)
+        elif isinstance(o, datetime | date):
+            return o.isoformat()
+        elif isinstance(o, UUID):
+            return str(o)
+        elif is_dataclass(o) and not isinstance(o, type):
+            return asdict(o)
+        elif isinstance(o, Enum):
+            return o.name
         # If a class and not any of the default types, automatically try to parse the object's attributes
-        elif not isinstance(obj, (str, int, float, type(None), list, dict)):
+        elif not isinstance(o, str | int | float | type(None) | list | dict):
             try:
-                data = vars(obj)
+                data = vars(o)
             except Exception:
-                logger.exception(f'Failed to encode {obj}')
+                logger.exception(f'Failed to encode {o}')
                 return None
             else:
                 return data
-        return json.JSONEncoder.default(self, obj)
+        return json.JSONEncoder.default(self, o)
 
     def encode(self, o):
         """Return a JSON string representation of a Python data structure.
@@ -78,12 +79,12 @@ class JSONEncoder(json.JSONEncoder):
         # The remainder would be a little slower, but acceptably so.
         try:
             chunks = self.iterencode(o, _one_shot=True)
-            if not isinstance(chunks, (list, tuple)):
+            if not isinstance(chunks, list | tuple):
                 chunks = list(chunks)
         except TypeError as e:
             if e.args[0].startswith('keys must be '):
                 chunks = self.iterencode(o, _one_shot=True, use_python_iterencode=True)
-                if not isinstance(chunks, (list, tuple)):
+                if not isinstance(chunks, list | tuple):
                     chunks = list(chunks)
             else:
                 raise
@@ -100,14 +101,12 @@ class JSONEncoder(json.JSONEncoder):
                 mysocket.write(chunk)
 
         """
-        if self.check_circular:
-            markers = {}
-        else:
-            markers = None
-        if self.ensure_ascii:
-            _encoder = json.encoder.encode_basestring_ascii
-        else:
-            _encoder = json.encoder.encode_basestring
+        markers = {} if self.check_circular else None
+        _encoder = (
+            json.encoder.encode_basestring_ascii
+            if self.ensure_ascii
+            else json.encoder.encode_basestring
+        )
 
         def floatstr(
             o,
@@ -130,17 +129,17 @@ class JSONEncoder(json.JSONEncoder):
                 return _repr(o)
 
             if not allow_nan:
-                raise ValueError(f"Out of range float values are not JSON compliant: {repr(o)}")
+                raise ValueError(f"Out of range float values are not JSON compliant: {o!r}")
 
             return text
 
         if (
             _one_shot
-            and json.encoder.c_make_encoder is not None
+            and json.encoder.c_make_encoder is not None # type: ignore
             and self.indent is None
             and not use_python_iterencode
         ):
-            _iterencode = json.encoder.c_make_encoder(
+            _iterencode = json.encoder.c_make_encoder( # type: ignore
                 markers, self.default, _encoder, self.indent,
                 self.key_separator, self.item_separator, self.sort_keys,
                 self.skipkeys, self.allow_nan,
@@ -166,15 +165,15 @@ def _make_iterencode(
     _skipkeys,
     _one_shot,
     ## HACK: hand-optimized bytecode; turn globals into locals
-    ValueError=ValueError,
-    dict=dict,
-    float=float,
-    id=id,
-    int=int,
-    isinstance=isinstance,
-    list=list,
-    str=str,
-    tuple=tuple,
+    ValueError=ValueError,  # noqa: A002, N803
+    dict=dict,  # noqa: A002
+    float=float,  # noqa: A002
+    id=id,  # noqa: A002
+    int=int,  # noqa: A002
+    isinstance=isinstance,  # noqa: A002
+    list=list,  # noqa: A002
+    str=str,  # noqa: A002
+    tuple=tuple,  # noqa: A002
     _intstr=int.__repr__,
 ):
 
@@ -235,7 +234,7 @@ def _make_iterencode(
             yield '\n' + _indent * _current_indent_level
         yield ']'
         if markers is not None:
-            del markers[markerid]
+            del markers[markerid] # type: ignore
 
     def _iterencode_dict(dct, _current_indent_level):
         if not dct:
@@ -256,10 +255,7 @@ def _make_iterencode(
             newline_indent = None
             item_separator = _item_separator
         first = True
-        if _sort_keys:
-            items = sorted(dct.items())
-        else:
-            items = dct.items()
+        items = sorted(dct.items()) if _sort_keys else dct.items()
         for key, value in items:
             if isinstance(key, str):
                 pass
@@ -324,7 +320,7 @@ def _make_iterencode(
             yield '\n' + _indent * _current_indent_level
         yield '}'
         if markers is not None:
-            del markers[markerid]
+            del markers[markerid] # type: ignore
 
     def _iterencode(o, _current_indent_level):
         if isinstance(o, str):
@@ -354,5 +350,5 @@ def _make_iterencode(
             o = _default(o)
             yield from _iterencode(o, _current_indent_level)
             if markers is not None:
-                del markers[markerid]
+                del markers[markerid] # type: ignore
     return _iterencode

starmallow/types.py

@@ -1,20 +1,24 @@
 import uuid
-from typing import Any, Callable, List, TypeVar, Union
+from collections.abc import Awaitable, Callable
+from typing import Annotated, Any, TypeVar
 
 import marshmallow.fields as mf
-from marshmallow_dataclass import NewType
+from starlette.websockets import WebSocket
 
 import starmallow.fields as sf
+from starmallow.delimited_field import DelimitedList
 from starmallow.endpoints import APIHTTPEndpoint
 
-DecoratedCallable = TypeVar("DecoratedCallable", bound=Union[Callable[..., Any], APIHTTPEndpoint])
+EndpointCallable = Callable[[], Awaitable[Any] | Any] | Callable[[...], Awaitable[Any] | Any]
+WebSocketEndpointCallable = Callable[[WebSocket], Awaitable[None]]
+DecoratedCallable = TypeVar("DecoratedCallable", bound=EndpointCallable | type[APIHTTPEndpoint])
 
-UUID = NewType('UUID', uuid.UUID, field=mf.UUID)
-DelimitedListUUID = NewType('DelimitedListUUID', List[uuid.UUID], field=sf.DelimitedListUUID)
-DelimitedListStr = NewType('DelimitedListStr', List[str], field=sf.DelimitedListStr)
-DelimitedListInt = NewType('DelimitedListInt', List[int], field=sf.DelimitedListInt)
+UUID = Annotated[uuid.UUID, mf.UUID]
+DelimitedListUUID = Annotated[list[uuid.UUID], DelimitedList[mf.UUID]]
+DelimitedListStr = Annotated[list[str], DelimitedList[mf.String]]
+DelimitedListInt = Annotated[list[int], DelimitedList[mf.Integer]]
 
-HttpUrl = NewType("HttpUrl", str, field=sf.HttpUrl)
+HttpUrl = Annotated[str, sf.HttpUrl]
 
 # Aliases
 UUIDType = UUID