Ensure backwards compatibility for imports

Author: mmwinther

generated/python/datadoc_model/datadoc_model/__init__.py

@@ -1,4 +1,7 @@
-# This is provided for backwards compatibility
-import all_optional.model
-import all_optional.model as model
-import required.model
+from . import (
+    all_optional,
+    model,  # For backwards compatibility
+    required,
+)
+
+__all__ = ["model", "all_optional", "required"]

generated/python/datadoc_model/datadoc_model/all_optional/__init__.py

@@ -0,0 +1,4 @@
+"""Module where all model fields are forced to be optional.
+
+This is useful for persisting and validating data from users as it is entered via an interface.
+"""

generated/python/datadoc_model/datadoc_model/model.py

@@ -0,0 +1,11 @@
+"""This module is a backwards compatibility shim, to support `from datadoc_model.model import xxx` formats"""
+
+import warnings
+
+warnings.warn(
+    message="datadoc_model.model has been moved to datadoc_model.all_optional.model. Please update imports accordingly. This will be removed in the next major release.",
+    category=DeprecationWarning,
+    stacklevel=2,
+)
+
+from .all_optional.model import *  # noqa: E402, F403

generated/python/datadoc_model/datadoc_model/required/__init__.py

@@ -0,0 +1,4 @@
+"""Module where model fields which are required must be provided on model instantiation.
+
+This is useful for validating finished data structures.
+"""

generated/python/datadoc_model/poetry.lock

@@ -0,0 +1,27 @@
+import pytest
+from datadoc_model.model import (
+    DatadocMetadata,
+    MetadataContainer,
+    PseudonymizationMetadata,
+)
+from pydantic import ValidationError
+
+
+def test_instantiate_no_values_container():
+    container = MetadataContainer()
+    assert isinstance(container, MetadataContainer)
+
+
+def test_instantiate_no_values_datadoc():
+    datadoc = DatadocMetadata()
+    assert isinstance(datadoc, DatadocMetadata)
+
+
+def test_instantiate_no_values_pseudo():
+    pseudo = PseudonymizationMetadata()
+    assert isinstance(pseudo, PseudonymizationMetadata)
+
+
+def test_unknown_field():
+    with pytest.raises(ValidationError):
+        DatadocMetadata(unknown_field="random_value")

generated/python/datadoc_model/tests/test_datadoc_model_all_optional.py

@@ -0,0 +1,80 @@
+from datetime import datetime
+from uuid import uuid4
+
+import pytest
+from datadoc_model.required.model import (
+    DatadocMetadata,
+    Dataset,
+    LanguageStringType,
+    LanguageStringTypeItem,
+    MetadataContainer,
+    PseudonymizationMetadata,
+)
+from pydantic import ValidationError
+
+
+def test_instantiate_no_values_container():
+    container = MetadataContainer()
+    assert isinstance(container, MetadataContainer)
+
+
+def test_instantiate_no_values_datadoc():
+    with pytest.raises(ValidationError):
+        DatadocMetadata()
+
+
+def test_instantiate_all_required_values_datadoc():
+    DatadocMetadata(
+        dataset=Dataset(
+            short_name="person_testdata",
+            name=LanguageStringType(
+                [
+                    LanguageStringTypeItem(
+                        languageCode="nb",
+                        languageText="Person test data",
+                    ),
+                ],
+            ),
+            description=LanguageStringType(
+                [
+                    LanguageStringTypeItem(
+                        languageCode="nb",
+                        languageText="Person test data",
+                    ),
+                ],
+            ),
+            population_description=LanguageStringType(
+                [
+                    LanguageStringTypeItem(
+                        languageCode="nb",
+                        languageText="Person test data",
+                    ),
+                ],
+            ),
+            version="1",
+            unit_type="20",
+            subject_field="20",
+            contains_personal_data=True,
+            id=uuid4(),
+            owner="team-metadata",
+            file_path="path/to/dataset",
+            metadata_created_by="mmw",
+            metadata_created_date=datetime.now(),
+            metadata_last_updated_by="mmw",
+            metadata_last_updated_date=datetime.now(),
+            assessment="PROTECTED",
+            dataset_status="DRAFT",
+            dataset_state="PROCESSED_DATA",
+        ),
+        variables=[],
+    )
+
+
+def test_instantiate_no_values_pseudo():
+    with pytest.raises(ValidationError):
+        PseudonymizationMetadata()
+
+
+def test_unknown_field():
+    with pytest.raises(ValidationError):
+        DatadocMetadata(unknown_field="random_value")