starmallow 0.6.5__py3-none-any.whl → 0.8.0__py3-none-any.whl

starmallow/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.6.5"
+__version__ = "0.8.0"
 
 from .applications import StarMallow
 from .exceptions import RequestValidationError

starmallow/endpoint.py

@@ -20,6 +20,7 @@ from typing import (
 import marshmallow as ma
 import marshmallow.fields as mf
 from marshmallow.utils import missing as missing_
+from marshmallow_dataclass2 import class_schema, is_generic_alias_of_dataclass
 from starlette.background import BackgroundTasks
 from starlette.requests import HTTPConnection, Request
 from starlette.responses import Response
@@ -243,6 +244,9 @@ class EndpointMixin:
         if is_marshmallow_dataclass(model):
             model = model.Schema
 
+        if is_generic_alias_of_dataclass(model):
+            model = class_schema(model)
+
         if isinstance(model, NewType) and getattr(model, '_marshmallow_field', None):
             return model._marshmallow_field(**kwargs)
         elif is_marshmallow_schema(model):

starmallow/ext/marshmallow/openapi.py

@@ -2,7 +2,7 @@ from typing import Any
 
 import marshmallow as ma
 import marshmallow.fields as mf
-import marshmallow_dataclass.collection_field as collection_field
+import marshmallow_dataclass2.collection_field as collection_field
 from apispec import APISpec
 from apispec.ext.marshmallow.common import get_fields
 from apispec.ext.marshmallow.field_converter import (
@@ -12,6 +12,7 @@ from apispec.ext.marshmallow.field_converter import (
 )
 from apispec.ext.marshmallow.openapi import OpenAPIConverter as ApiSpecOpenAPIConverter
 from marshmallow.utils import is_collection
+from marshmallow_dataclass2.union_field import Union as UnionField
 from packaging.version import Version
 
 from starmallow.utils import MARSHMALLOW_ITERABLES
@@ -98,6 +99,7 @@ class OpenAPIConverter(ApiSpecOpenAPIConverter):
         self.add_attribute_function(self.field2title)
         self.add_attribute_function(self.field2uniqueItems)
         self.add_attribute_function(self.field2enum)
+        self.add_attribute_function(self.field2union)
 
     # Overriding to add exclusiveMinimum and exclusiveMaximum support
     def field2range(self: FieldConverterMixin, field: mf.Field, ret) -> dict:
@@ -211,6 +213,35 @@ class OpenAPIConverter(ApiSpecOpenAPIConverter):
 
         return ret
 
+    def field2union(self: FieldConverterMixin, field: mf.Field, **kwargs: Any) -> dict:
+        ret = {}
+
+        if isinstance(field, UnionField):
+            union_types = []
+            untyped = False
+            for _, subfield in field.union_fields:
+                for field_class in type(subfield).__mro__:
+                    if field_class in self.field_mapping:
+                        type_, fmt = self.field_mapping[field_class]
+
+                        union_type = {}
+                        if type_:
+                            union_type['type'] = type_
+                        if fmt:
+                            union_type['fmt'] = fmt
+
+                        if union_type:
+                            union_types.append(union_type)
+                        else:
+                            # at least one untyped, so can't reliably create a schema
+                            untyped = True
+                        break
+
+            if union_types and not untyped:
+                ret['type'] = {'oneOf': union_types}
+
+        return ret
+
     # Overrice to add 'deprecated' support
     def _field2parameter(
         self, field: mf.Field, *, name: str, location: str,

starmallow/security/api_key.py

@@ -1,7 +1,7 @@
 from enum import Enum
 from typing import ClassVar, Optional
 
-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_403_FORBIDDEN
 

starmallow/security/base.py

@@ -2,7 +2,7 @@ from enum import Enum
 from typing import Any, ClassVar, Dict, Optional
 
 import marshmallow as ma
-from marshmallow_dataclass import dataclass as ma_dataclass
+from marshmallow_dataclass2 import dataclass as ma_dataclass
 
 
 # Provided by: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#security-scheme-object

starmallow/security/http.py

@@ -2,7 +2,7 @@ import binascii
 from base64 import b64decode
 from typing import ClassVar, Optional
 
-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
 

starmallow/security/oauth2.py

@@ -1,7 +1,7 @@
 from typing import Any, Dict, List, Optional, Union
 
 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
 

starmallow/security/open_id_connect_url.py

@@ -1,6 +1,6 @@
 from typing import Optional
 
-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

starmallow/types.py

@@ -2,7 +2,7 @@ import uuid
 from typing import Any, Callable, List, TypeVar, Union
 
 import marshmallow.fields as mf
-from marshmallow_dataclass import NewType
+from marshmallow_dataclass2 import NewType
 
 import starmallow.fields as sf
 from starmallow.endpoints import APIHTTPEndpoint

starmallow/utils.py

@@ -33,8 +33,11 @@ from typing import (
 import dpath.util
 import marshmallow as ma
 import marshmallow.fields as mf
-import marshmallow_dataclass.collection_field as collection_field
+import marshmallow_dataclass2.collection_field as collection_field
+import typing_inspect
 from marshmallow.validate import Equal, OneOf
+from marshmallow_dataclass2 import class_schema, is_generic_alias_of_dataclass
+from marshmallow_dataclass2.union_field import Union as UnionField
 from starlette.responses import Response
 from typing_inspect import is_final_type, is_generic_type, is_literal_type
 
@@ -103,6 +106,9 @@ def get_model_field(model: Any, **kwargs) -> mf.Field:
     if is_marshmallow_dataclass(model):
         model = model.Schema
 
+    if is_generic_alias_of_dataclass(model):
+        model = class_schema(model)
+
     if is_marshmallow_schema(model):
         return mf.Nested(model if isinstance(model, ma.Schema) else model())
 
@@ -136,6 +142,25 @@ def get_model_field(model: Any, **kwargs) -> mf.Field:
     if not is_generic_type(model) and lenient_issubclass(model, Enum):
         return mf.Enum(model, **kwargs)
 
+    # Union
+    if typing_inspect.is_union_type(model):
+        if typing_inspect.is_optional_type(model):
+            kwargs["allow_none"] = kwargs.get("allow_none", True)
+            kwargs["dump_default"] = kwargs.get("dump_default", None)
+            if not kwargs.get("required"):
+                kwargs["load_default"] = kwargs.get("load_default", None)
+            kwargs.setdefault("required", False)
+
+        arguments = get_args(model)
+        subtypes = [t for t in arguments if t is not NoneType]  # type: ignore
+        if len(subtypes) == 1:
+            return get_model_field(model, **kwargs)
+
+        return UnionField(
+            [(subtyp, get_model_field(subtyp, required=True)) for subtyp in subtypes],
+            **kwargs
+        )
+
     origin = get_origin(model)
     if origin not in PY_ITERABLES:
         raise Exception(f'Unknown model type, model is {model}')

{starmallow-0.6.5.dist-info → starmallow-0.8.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: starmallow
-Version: 0.6.5
+Version: 0.8.0
 Summary: StarMallow framework
 Project-URL: Homepage, https://github.com/mvanderlee/starmallow
 Author-email: Michiel Vanderlee <jmt.vanderlee@gmail.com>
@@ -28,7 +28,7 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.10
 Requires-Dist: apispec[marshmallow]<7,>=6
 Requires-Dist: dpath<3,>=2.1.0
-Requires-Dist: marshmallow-dataclass<9,>=8.5.1
+Requires-Dist: marshmallow-dataclass2<9,>=8.8.1
 Requires-Dist: marshmallow<4,>=3.18.0
 Requires-Dist: python-multipart<0.0.7,>=0.0.5
 Requires-Dist: pyyaml>=5.4.1
@@ -68,7 +68,7 @@ Create a file `main.py` with:
 
 ```python
 from typing import Annotated
-from marshmallow_dataclass import dataclass
+from marshmallow_dataclass2 import dataclass
 from starmallow import Body, Path, StarMallow
 
 app = StarMallow()
@@ -131,7 +131,7 @@ INFO:     Application startup complete.
 You can also use class-based views. This can make it easier to organize your code and gives you an easy migration path if you use [flask-smorest](https://flask-smorest.readthedocs.io/)
 
 ```python
-from marshmallow_dataclass import dataclass
+from marshmallow_dataclass2 import dataclass
 from starmallow import StarMallow
 from starmallow.decorators import route
 from starmallow.endpoints import APIHTTPEndpoint

{starmallow-0.6.5.dist-info → starmallow-0.8.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-starmallow/__init__.py,sha256=BM647YLqYd8UyAgINXcC9B8aSFtZNYWdO3Gridcnn2s,322
+starmallow/__init__.py,sha256=_rVQsLfQ3QzRRXvJYKcuR9Ki79d7xvWU1Mhk7E4y2KY,322
 starmallow/applications.py,sha256=mSL4YDozP8n6v22g4NX7EAMXmGhzzhtjtZd68YHcFvw,31720
 starmallow/background.py,sha256=qxT6-9SfnkcGZzvecNOpIsCOMW0TPwDtpQ81GHI28P0,995
 starmallow/concurrency.py,sha256=MVRjo4Vqss_yqhaoeVt3xb7rLaSuAq_q9uYgTwbsojE,1375
@@ -8,7 +8,7 @@ starmallow/datastructures.py,sha256=iH_KJuJ6kBCWEsnHFLdA3iyb6ZxhfdMHYrJlhiEZtDU,
 starmallow/decorators.py,sha256=MYk3WEFRSfQTN0Y3JoL3Y_Cz47gatMrVEPtNDw42XwU,4105
 starmallow/delimited_field.py,sha256=gonWgYg6G5xH2yXAyfDgkePmQ8dUaRSp2hdJ3mCfOBw,3466
 starmallow/docs.py,sha256=eA39LunVMEoPU5ge4qxm2eiJbrFTUSUu5EhG1L_LKxk,6268
-starmallow/endpoint.py,sha256=aNsbN0mdcVvIIcdgqICRgoGjIYJAeSVFXcpDlAji0Oc,16017
+starmallow/endpoint.py,sha256=WChgjb47lYUrbyeaQiyUbuyHFCREYPiZJMNLqnz_iuA,16186
 starmallow/endpoints.py,sha256=UrwVZCxbmWI20iNtJ0oXxo4d3-y12TjsOGs_jnStTiU,939
 starmallow/exception_handlers.py,sha256=gr2qLYWEtsIEH28n7OreEiiLVz6Y7b6osRyS9esJbBk,891
 starmallow/exceptions.py,sha256=vabtPJkTmtCdC8_2OPBE8Osz0v0KxaSOX6IWf1jgNkc,872
@@ -20,22 +20,22 @@ starmallow/responses.py,sha256=k2pf_m21ykf_FECdODUz400pMucMJJf_Zm8TXFujvaU,2012
 starmallow/routing.py,sha256=VSotmrEerVzuUfn20mpmSbuRVS4XiHrPtNRvBP8KJ4M,45397
 starmallow/schema_generator.py,sha256=yi368FwF9B50ZHSNOG0rvYVirVUeMFq2kXkUDeJUz4w,17961
 starmallow/serializers.py,sha256=rBEKMNgONgz_bai12uDvAEMCI_aEFGsqMSeIoWtlrOI,12514
-starmallow/types.py,sha256=8GXWjvzXQhF5NMHf14fbid6uErxVd1Xk_w2I4FoUgZ4,717
-starmallow/utils.py,sha256=WHw3MhCy1McGLEuhIDveH0NW8zpdyxSuvjVVx7NiAkU,11453
+starmallow/types.py,sha256=xp4eitWenXRZCPlsopTfG4aMs86kOrvioDTCVLg-MXU,718
+starmallow/utils.py,sha256=lI6qWalsBsEaJLSiGsCC_vBN6Sw-r5aDTl9hWuHCW-Q,12459
 starmallow/websockets.py,sha256=yIz3LzTBMNclpEoG7oTMbQwxbcdKNU6M8XcqZMyBTuA,2223
 starmallow/ext/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 starmallow/ext/marshmallow/__init__.py,sha256=33jENGdfPq4-CDG0LOmN3KOGW1pXTy7a2oMwy4hrYzM,208
-starmallow/ext/marshmallow/openapi.py,sha256=5aGvbwLGVucsVhXExpYeyt8n5dQTzazrf-nuh6mVhmA,9017
+starmallow/ext/marshmallow/openapi.py,sha256=LHFcdw8ISpPsS2drefL2h8AiKk_B_I7UffloEH3-xXI,10202
 starmallow/middleware/__init__.py,sha256=vtNm85Z9pUPjJd-9giJGg3YL1wO7Jm5ooXBm31pDOK8,53
 starmallow/middleware/asyncexitstack.py,sha256=0GPhQSxqSVmAiVIqBIN5slueWYZ8bwh9f2bBPy7AbP0,1191
 starmallow/security/__init__.py,sha256=1rQFBIGnEbE51XDZSSi9NgPjXLScFq3RoLu4vk0KVYw,191
-starmallow/security/api_key.py,sha256=E326Sxb_qhWbfN70vHuq4KEJcToW1Fxw0qGL0pHmQjc,3144
-starmallow/security/base.py,sha256=_7PR7tepr0CHJxg6uTc_cBAeY90jBS5gu8z5598yEM0,1144
-starmallow/security/http.py,sha256=cpGjM1kFDq3i_bOY96kMkf4cspBUxFkkET9lTK3NA-0,6607
-starmallow/security/oauth2.py,sha256=1nv1580PY4cwgu5gzpQCf2MfMNv2Cfv05753AUHPOhQ,10005
-starmallow/security/open_id_connect_url.py,sha256=IPsL2YzWc2mPwJbrUn6oFRTi7uRAG6mR62CGwmzBs1k,1399
+starmallow/security/api_key.py,sha256=OWogzuwqPC3H0xf4jzx_RQjC8UoM8WDVtOhjq1lQ5ik,3145
+starmallow/security/base.py,sha256=PtTsBViTUEtNUT9q_zFFydnOqIvGLfKggtgyCYeYRZk,1145
+starmallow/security/http.py,sha256=O4mUrBHp6JTJNewOvcG_dgsx0IwjMonL8usswOqGdOY,6608
+starmallow/security/oauth2.py,sha256=wlc5K6rURqOrMLwSYeOcd_2ZtFcvMqG3OwbiAwpft3E,10006
+starmallow/security/open_id_connect_url.py,sha256=NONotu-uAWJUps06wdyVCJSRrK71Bl23z8gWWi7ymmw,1400
 starmallow/security/utils.py,sha256=bd8T0YM7UQD5ATKucr1bNtAvz_Y3__dVNAv5UebiPvc,293
-starmallow-0.6.5.dist-info/METADATA,sha256=cAAboTKZYPwxOZEqzjIxZx6lfcMlRLPbee8vRRAQkfo,5615
-starmallow-0.6.5.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-starmallow-0.6.5.dist-info/licenses/LICENSE.md,sha256=QelyGgOzch8CXzy6HrYwHh7nmj0rlWkDA0YzmZ3CPaY,1084
-starmallow-0.6.5.dist-info/RECORD,,
+starmallow-0.8.0.dist-info/METADATA,sha256=w3SFqGhVi71VdQQZBQyQsM0Kk7dPvrGRAte3GpVAH5M,5618
+starmallow-0.8.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+starmallow-0.8.0.dist-info/licenses/LICENSE.md,sha256=QelyGgOzch8CXzy6HrYwHh7nmj0rlWkDA0YzmZ3CPaY,1084
+starmallow-0.8.0.dist-info/RECORD,,