Fix/nested schema fields (#102)

* Fix generating schema's for types with array properties

When the type of the array is a built-in type we should generate a
`fields.List()` with a regular field as argument instead of referencing
a non-existing schema.

* Regenerate

* Fix isort on project

Should fix in codegen/main.py#105 since it doesn't seem to do isort...

Co-authored-by: David Weterings <d.weterings@labdigital.nl>

Author: mvantellingen

codegen/generate_schema.py

@@ -370,15 +370,25 @@ def _get_property_field(self, prop):
             if prop.type.name == "array":
                 assert prop.items, f"The array property {prop.name} has no items"
                 assert prop.items_types
+                item_type = prop.items_types[0]
 
                 # TODO: We for now assume that the items are all subclasses of
                 # the first item. We shouldn't do that :-)
-                if prop.items_types[0].discriminator:
-                    node.args.append(
-                        self._create_discriminator_field(prop.items_types[0])
+                if item_type.discriminator:
+                    field = self._create_discriminator_field(item_type)
+                elif item_type.name in FIELD_TYPES:
+                    field = ast.Call(
+                        func=ast.Name(id=FIELD_TYPES[item_type.name]),
+                        args=[],
+                        keywords=[
+                            ast.keyword(
+                                arg="allow_none", value=ast.NameConstant(True, kind=None)
+                            )
+                        ],
                     )
                 else:
-                    node.args.append(self._create_nested_field(prop.items_types[0]))
+                    field = self._create_nested_field(item_type)
+                node.args.append(field)
             return node
 
         # Dict Field

src/commercetools/_schemas/_common.py

@@ -769,12 +769,7 @@ class GeoJsonPointSchema(GeoJsonSchema):
     """Marshmallow schema for :class:`commercetools.types.GeoJsonPoint`."""
 
     coordinates = marshmallow.fields.List(
-        helpers.LazyNestedField(
-            nested="commercetools._schemas.None.numberSchema",
-            unknown=marshmallow.EXCLUDE,
-            allow_none=True,
-        ),
-        allow_none=True,
+        marshmallow.fields.Integer(allow_none=True), allow_none=True
     )
 
     class Meta:

src/commercetools/_schemas/_discount_code.py

@@ -66,13 +66,7 @@ class DiscountCodeDraftSchema(marshmallow.Schema):
         missing=None,
     )
     groups = marshmallow.fields.List(
-        helpers.LazyNestedField(
-            nested="commercetools._schemas.None.stringSchema",
-            unknown=marshmallow.EXCLUDE,
-            allow_none=True,
-        ),
-        allow_none=True,
-        missing=None,
+        marshmallow.fields.String(allow_none=True), allow_none=True, missing=None
     )
     valid_from = marshmallow.fields.DateTime(
         allow_none=True, missing=None, data_key="validFrom"

src/commercetools/_schemas/_error.py

@@ -517,11 +517,7 @@ class InvalidFieldErrorSchema(ErrorObjectSchema):
     field = marshmallow.fields.String(allow_none=True)
     invalid_value = marshmallow.fields.Raw(allow_none=True, data_key="invalidValue")
     allowed_values = marshmallow.fields.List(
-        helpers.LazyNestedField(
-            nested="commercetools._schemas.None.anySchema",
-            unknown=marshmallow.EXCLUDE,
-            allow_none=True,
-        ),
+        marshmallow.fields.Raw(allow_none=True),
         allow_none=True,
         missing=None,
         data_key="allowedValues",

src/commercetools/_schemas/_graph_ql.py

@@ -41,12 +41,7 @@ class GraphQLErrorSchema(marshmallow.Schema):
         allow_none=True,
     )
     path = marshmallow.fields.List(
-        helpers.LazyNestedField(
-            nested="commercetools._schemas.None.anySchema",
-            unknown=marshmallow.EXCLUDE,
-            allow_none=True,
-        ),
-        allow_none=True,
+        marshmallow.fields.Raw(allow_none=True), allow_none=True
     )
 
     class Meta:

src/commercetools/_schemas/_message.py

@@ -2840,11 +2840,7 @@ class ProductDeletedMessagePayloadSchema(MessagePayloadSchema):
     """Marshmallow schema for :class:`commercetools.types.ProductDeletedMessagePayload`."""
 
     removed_image_urls = marshmallow.fields.List(
-        helpers.LazyNestedField(
-            nested="commercetools._schemas.None.stringSchema",
-            unknown=marshmallow.EXCLUDE,
-            allow_none=True,
-        ),
+        marshmallow.fields.String(allow_none=True),
         allow_none=True,
         data_key="removedImageUrls",
     )
@@ -2868,11 +2864,7 @@ class ProductDeletedMessageSchema(MessageSchema):
     """Marshmallow schema for :class:`commercetools.types.ProductDeletedMessage`."""
 
     removed_image_urls = marshmallow.fields.List(
-        helpers.LazyNestedField(
-            nested="commercetools._schemas.None.stringSchema",
-            unknown=marshmallow.EXCLUDE,
-            allow_none=True,
-        ),
+        marshmallow.fields.String(allow_none=True),
         allow_none=True,
         data_key="removedImageUrls",
     )
@@ -3028,11 +3020,7 @@ class ProductPublishedMessagePayloadSchema(MessagePayloadSchema):
     """Marshmallow schema for :class:`commercetools.types.ProductPublishedMessagePayload`."""
 
     removed_image_urls = marshmallow.fields.List(
-        helpers.LazyNestedField(
-            nested="commercetools._schemas.None.anySchema",
-            unknown=marshmallow.EXCLUDE,
-            allow_none=True,
-        ),
+        marshmallow.fields.Raw(allow_none=True),
         allow_none=True,
         data_key="removedImageUrls",
     )
@@ -3057,11 +3045,7 @@ class ProductPublishedMessageSchema(MessageSchema):
     """Marshmallow schema for :class:`commercetools.types.ProductPublishedMessage`."""
 
     removed_image_urls = marshmallow.fields.List(
-        helpers.LazyNestedField(
-            nested="commercetools._schemas.None.anySchema",
-            unknown=marshmallow.EXCLUDE,
-            allow_none=True,
-        ),
+        marshmallow.fields.Raw(allow_none=True),
         allow_none=True,
         data_key="removedImageUrls",
     )
@@ -3124,11 +3108,7 @@ class ProductRevertedStagedChangesMessagePayloadSchema(MessagePayloadSchema):
     """Marshmallow schema for :class:`commercetools.types.ProductRevertedStagedChangesMessagePayload`."""
 
     removed_image_urls = marshmallow.fields.List(
-        helpers.LazyNestedField(
-            nested="commercetools._schemas.None.stringSchema",
-            unknown=marshmallow.EXCLUDE,
-            allow_none=True,
-        ),
+        marshmallow.fields.String(allow_none=True),
         allow_none=True,
         data_key="removedImageUrls",
     )
@@ -3146,11 +3126,7 @@ class ProductRevertedStagedChangesMessageSchema(MessageSchema):
     """Marshmallow schema for :class:`commercetools.types.ProductRevertedStagedChangesMessage`."""
 
     removed_image_urls = marshmallow.fields.List(
-        helpers.LazyNestedField(
-            nested="commercetools._schemas.None.stringSchema",
-            unknown=marshmallow.EXCLUDE,
-            allow_none=True,
-        ),
+        marshmallow.fields.String(allow_none=True),
         allow_none=True,
         data_key="removedImageUrls",
     )
@@ -3263,11 +3239,7 @@ class ProductVariantDeletedMessagePayloadSchema(MessagePayloadSchema):
         allow_none=True,
     )
     removed_image_urls = marshmallow.fields.List(
-        helpers.LazyNestedField(
-            nested="commercetools._schemas.None.stringSchema",
-            unknown=marshmallow.EXCLUDE,
-            allow_none=True,
-        ),
+        marshmallow.fields.String(allow_none=True),
         allow_none=True,
         data_key="removedImageUrls",
     )
@@ -3290,11 +3262,7 @@ class ProductVariantDeletedMessageSchema(MessageSchema):
         allow_none=True,
     )
     removed_image_urls = marshmallow.fields.List(
-        helpers.LazyNestedField(
-            nested="commercetools._schemas.None.stringSchema",
-            unknown=marshmallow.EXCLUDE,
-            allow_none=True,
-        ),
+        marshmallow.fields.String(allow_none=True),
         allow_none=True,
         data_key="removedImageUrls",
     )

src/commercetools/services/project.py

@@ -1,7 +1,7 @@
 from typing import List
 
 from commercetools import types
-from commercetools._schemas._project import ProjectUpdateSchema, ProjectSchema
+from commercetools._schemas._project import ProjectSchema, ProjectUpdateSchema
 from commercetools.services import abstract
 
 __all__ = ["ProjectService"]