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

starmallow/__init__.py

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

starmallow/ext/marshmallow/openapi.py

@@ -14,6 +14,7 @@ from apispec.ext.marshmallow.openapi import OpenAPIConverter as ApiSpecOpenAPICo
 from marshmallow.utils import is_collection
 from packaging.version import Version
 
+from starmallow.union_field import Union as UnionField
 from starmallow.utils import MARSHMALLOW_ITERABLES
 
 # marshmallow field => (JSON Schema type, format)
@@ -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/union_field.py

@@ -0,0 +1,86 @@
+'''Copied from marshmallow_dataclass, https://github.com/lovasoa/marshmallow_dataclass/blob/master/marshmallow_dataclass/union_field.py
+    Didn't want to add the dependency to this project1
+'''
+
+import copy
+import inspect
+from typing import Any, List, Optional, Tuple
+
+import typeguard
+from marshmallow import Schema, ValidationError, fields
+
+try:
+    from typeguard import TypeCheckError  # type: ignore[attr-defined]
+except ImportError:
+    # typeguard < 3
+    TypeCheckError = TypeError  # type: ignore[misc, assignment]
+
+if "argname" not in inspect.signature(typeguard.check_type).parameters:
+
+    def _check_type(value, expected_type, argname: str):
+        return typeguard.check_type(value=value, expected_type=expected_type)
+
+else:
+    # typeguard < 3.0.0rc2
+    def _check_type(value, expected_type, argname: str):
+        return typeguard.check_type(  # type: ignore[call-overload]
+            value=value, expected_type=expected_type, argname=argname,
+        )
+
+
+class Union(fields.Field):
+    """A union field, composed other `Field` classes or instances.
+    This field serializes elements based on their type, with one of its child fields.
+
+    Example: ::
+
+        number_or_string = UnionField([
+                    (float, fields.Float()),
+                    (str, fields.Str())
+                ])
+
+    :param union_fields: A list of types and their associated field instance.
+    :param kwargs: The same keyword arguments that :class:`Field` receives.
+    """
+
+    def __init__(self, union_fields: List[Tuple[type, fields.Field]], **kwargs):
+        super().__init__(**kwargs)
+        self.union_fields = union_fields
+
+    def _bind_to_schema(self, field_name: str, schema: Schema) -> None:
+        super()._bind_to_schema(field_name, schema)
+        new_union_fields = []
+        for typ, field in self.union_fields:
+            field = copy.deepcopy(field)
+            field._bind_to_schema(field_name, self)
+            new_union_fields.append((typ, field))
+
+        self.union_fields = new_union_fields
+
+    def _serialize(self, value: Any, attr: Optional[str], obj, **kwargs) -> Any:
+        errors = []
+        if value is None:
+            return value
+        for typ, field in self.union_fields:
+            try:
+                _check_type(value=value, expected_type=typ, argname=attr or "anonymous")
+                return field._serialize(value, attr, obj, **kwargs)
+            except TypeCheckError as e:
+                errors.append(e)
+        raise TypeError(
+            f"Unable to serialize value with any of the fields in the union: {errors}",
+        )
+
+    def _deserialize(self, value: Any, attr: Optional[str], data, **kwargs) -> Any:
+        errors = []
+        for typ, field in self.union_fields:
+            try:
+                result = field.deserialize(value, **kwargs)
+                _check_type(
+                    value=result, expected_type=typ, argname=attr or "anonymous",
+                )
+                return result
+            except (TypeCheckError, ValidationError) as e:
+                errors.append(e)
+
+        raise ValidationError(errors)

starmallow/utils.py

@@ -34,12 +34,14 @@ import dpath.util
 import marshmallow as ma
 import marshmallow.fields as mf
 import marshmallow_dataclass.collection_field as collection_field
+import typing_inspect
 from marshmallow.validate import Equal, OneOf
 from starlette.responses import Response
 from typing_inspect import is_final_type, is_generic_type, is_literal_type
 
 from starmallow.concurrency import contextmanager_in_threadpool
 from starmallow.datastructures import DefaultPlaceholder, DefaultType
+from starmallow.union_field import Union as UnionField
 
 if TYPE_CHECKING:  # pragma: nocover
     from starmallow.routing import APIRoute
@@ -136,6 +138,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.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: starmallow
-Version: 0.6.5
+Version: 0.7.0
 Summary: StarMallow framework
 Project-URL: Homepage, https://github.com/mvanderlee/starmallow
 Author-email: Michiel Vanderlee <jmt.vanderlee@gmail.com>

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

@@ -1,4 +1,4 @@
-starmallow/__init__.py,sha256=BM647YLqYd8UyAgINXcC9B8aSFtZNYWdO3Gridcnn2s,322
+starmallow/__init__.py,sha256=9E5AxUkYZG-q-eDh8OMP4YBFBCKro7Lp7hn2VFQe5E8,322
 starmallow/applications.py,sha256=mSL4YDozP8n6v22g4NX7EAMXmGhzzhtjtZd68YHcFvw,31720
 starmallow/background.py,sha256=qxT6-9SfnkcGZzvecNOpIsCOMW0TPwDtpQ81GHI28P0,995
 starmallow/concurrency.py,sha256=MVRjo4Vqss_yqhaoeVt3xb7rLaSuAq_q9uYgTwbsojE,1375
@@ -21,11 +21,12 @@ 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/union_field.py,sha256=psc5GPWDGVeu4vxFf2ItgtHEK8tT62IZHrxoRZidyxc,3113
+starmallow/utils.py,sha256=ilJyQHXZq1o6XRaDdninTNTt4u4KzIPQwImbhNQeZUs,12285
 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=BOPgTmolpZxQaPvyg0VcHLTjWSlvEj2L1OOHGFKfWik,10189
 starmallow/middleware/__init__.py,sha256=vtNm85Z9pUPjJd-9giJGg3YL1wO7Jm5ooXBm31pDOK8,53
 starmallow/middleware/asyncexitstack.py,sha256=0GPhQSxqSVmAiVIqBIN5slueWYZ8bwh9f2bBPy7AbP0,1191
 starmallow/security/__init__.py,sha256=1rQFBIGnEbE51XDZSSi9NgPjXLScFq3RoLu4vk0KVYw,191
@@ -35,7 +36,7 @@ starmallow/security/http.py,sha256=cpGjM1kFDq3i_bOY96kMkf4cspBUxFkkET9lTK3NA-0,6
 starmallow/security/oauth2.py,sha256=1nv1580PY4cwgu5gzpQCf2MfMNv2Cfv05753AUHPOhQ,10005
 starmallow/security/open_id_connect_url.py,sha256=IPsL2YzWc2mPwJbrUn6oFRTi7uRAG6mR62CGwmzBs1k,1399
 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.7.0.dist-info/METADATA,sha256=nfu-fi46UGqJcsgp88z9WTm_D1qepTVczqHGdkb-a_w,5615
+starmallow-0.7.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+starmallow-0.7.0.dist-info/licenses/LICENSE.md,sha256=QelyGgOzch8CXzy6HrYwHh7nmj0rlWkDA0YzmZ3CPaY,1084
+starmallow-0.7.0.dist-info/RECORD,,