Added support for ma.INCLUDE, ma.EXCLUDE, ma.RAISE (#229)

oarepo_model_builder/datatypes/components/marshmallow/graph.py

@@ -47,7 +47,7 @@ class MarshmallowClass:
     base_classes: List[str]
     imports: List[Import]
     fields: List[MarshmallowField]
-    strict: bool
+    unknown: str
     order: Optional[int] = None
 
     references: List[MarshmallowReference] = dataclasses.field(default_factory=list)

oarepo_model_builder/datatypes/components/marshmallow/object.py

@@ -1,6 +1,7 @@
 from typing import List
 
 import marshmallow as ma
+import marshmallow.validate
 from marshmallow import fields
 
 from oarepo_model_builder.datatypes import DataType, ObjectDataType, datatypes
@@ -63,6 +64,10 @@ class ObjectMarshmallowExtraSchema(ma.Schema):
         metadata={"doc": "Extra fields to generate into the marshmallow class"},
     )
     skip = fields.Boolean()
+    unknown = fields.Str(
+        validate=[marshmallow.validate.OneOf(["RAISE", "INCLUDE", "EXCLUDE"])],
+        default="RAISE",
+    )
 
 
 class ObjectMarshmallowSchema(PropertyMarshmallowSchema, ObjectMarshmallowExtraSchema):
@@ -195,7 +200,7 @@ def _build_class(
                 base_classes=marshmallow.get("base-classes", []) or ["ma.Schema"],
                 imports=Import.from_config(marshmallow.get("imports", [])),
                 fields=fields,
-                strict=True,
+                unknown=marshmallow.get("unknown", "RAISE"),
             )
         )
 

oarepo_model_builder/invenio/templates/marshmallow.py.jinja2

@@ -8,10 +8,8 @@ from marshmallow_utils import schemas as mu_schemas
 
 {% for cls in generated_classes %}
 class {{cls.class_name|base_name}}({% for bc in cls.base_classes %}{% if not loop.first%}, {% endif %}{{bc}}{% endfor %}):
-{% if cls.strict %}
     class Meta:
-        unknown = ma.RAISE
-{% endif %}
+        unknown = ma.{{ cls.unknown }}
 {% for fld in cls.fields %}
     {{fld.key}} = {{fld.full_definition}}
 {% endfor %}

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = oarepo-model-builder
-version = 4.0.51
+version = 4.0.52
 description = A utility library that generates OARepo required data model files from a JSON specification file
 authors = Miroslav Bauer <[email protected]>, Miroslav Simek <[email protected]>
 readme = README.md

tests/test_marshmallow_builder.py

@@ -229,6 +229,95 @@ class Meta:
     )
 
 
+def test_strict_object(fulltext_builder):
+    schema = get_test_schema(
+        a={
+            "type": "object",
+            "properties": {"b": {"type": "integer"}},
+        }
+    )
+    fulltext_builder.filesystem = InMemoryFileSystem()
+    fulltext_builder.build(
+        schema, profile="record", model_path=["record"], output_dir=""
+    )
+
+    with fulltext_builder.filesystem.open(
+        os.path.join("test", "services", "records", "schema.py")
+    ) as f:
+        data = f.read()
+    assert (
+        strip_whitespaces(
+            """
+ class ASchema(ma.Schema):
+    class Meta:
+        unknown= ma.RAISE
+    b= ma.fields.Integer()
+"""
+        )
+        in strip_whitespaces(data)
+    )
+
+
+def test_permissive_object(fulltext_builder):
+    schema = get_test_schema(
+        a={
+            "type": "object",
+            "marshmallow": {"unknown": "INCLUDE"},
+            "properties": {"b": {"type": "integer"}},
+        }
+    )
+    fulltext_builder.filesystem = InMemoryFileSystem()
+    fulltext_builder.build(
+        schema, profile="record", model_path=["record"], output_dir=""
+    )
+
+    with fulltext_builder.filesystem.open(
+        os.path.join("test", "services", "records", "schema.py")
+    ) as f:
+        data = f.read()
+    assert (
+        strip_whitespaces(
+            """
+ class ASchema(ma.Schema):
+    class Meta:
+        unknown= ma.INCLUDE
+    b= ma.fields.Integer()
+"""
+        )
+        in strip_whitespaces(data)
+    )
+
+
+def test_excluding_object(fulltext_builder):
+    schema = get_test_schema(
+        a={
+            "type": "object",
+            "marshmallow": {"unknown": "EXCLUDE"},
+            "properties": {"b": {"type": "integer"}},
+        }
+    )
+    fulltext_builder.filesystem = InMemoryFileSystem()
+    fulltext_builder.build(
+        schema, profile="record", model_path=["record"], output_dir=""
+    )
+
+    with fulltext_builder.filesystem.open(
+        os.path.join("test", "services", "records", "schema.py")
+    ) as f:
+        data = f.read()
+    assert (
+        strip_whitespaces(
+            """
+ class ASchema(ma.Schema):
+    class Meta:
+        unknown= ma.EXCLUDE
+    b= ma.fields.Integer()
+"""
+        )
+        in strip_whitespaces(data)
+    )
+
+
 def test_generate_nested_schema_same_file(fulltext_builder):
     schema = get_test_schema(
         a={