cognite-neat 1.0.22__py3-none-any.whl → 1.0.24__py3-none-any.whl

cognite/neat/_data_model/exporters/_api_exporter.py

@@ -1,9 +1,16 @@
+import warnings
+import zipfile
+from collections.abc import Iterator
 from pathlib import Path
 
 import yaml
+from pydantic import BaseModel
 
 from cognite.neat._data_model.exporters._base import DMSExporter, DMSFileExporter
 from cognite.neat._data_model.models.dms import RequestSchema
+from cognite.neat._data_model.models.dms._container import ContainerRequest
+from cognite.neat._data_model.models.dms._references import NodeReference
+from cognite.neat._data_model.models.dms._views import ViewRequest
 
 
 class DMSAPIExporter(DMSExporter[RequestSchema]):
@@ -16,12 +23,90 @@ class DMSAPIExporter(DMSExporter[RequestSchema]):
 
 class DMSAPIYAMLExporter(DMSAPIExporter, DMSFileExporter[RequestSchema]):
     def export_to_file(self, data_model: RequestSchema, file_path: Path) -> None:
-        """Export the data model to a YAML file in API format."""
-        if file_path.suffix.lower() not in {".yaml", ".yml"}:
-            raise ValueError("The file path must have a .yaml or .yml extension.")
+        """Export the data model to a YAML files or zip file in API format.
 
-        api_format = data_model.model_dump(mode="json", by_alias=True)
-        file_path.write_text(yaml.safe_dump(api_format, sort_keys=False), encoding=self.ENCODING, newline=self.NEW_LINE)
+        Args:
+            data_model: Request schema
+            file_path: The directory or zip file to save the schema to.
+
+        """
+
+        if file_path.is_dir():
+            self._export_to_directory(data_model, file_path)
+        else:
+            self._export_to_zip_file(data_model, file_path)
+
+    def _export_to_directory(self, data_model: RequestSchema, directory: Path) -> None:
+        """Save the schema to a directory as YAML files. This is compatible with the Cognite-Toolkit convention.
+
+        Args:
+            data_model: Request schema
+            directory: The directory to save the schema to.
+        """
+
+        subdir = directory / "data_models"
+        subdir.mkdir(parents=True, exist_ok=True)
+
+        for file_path, yaml_content in self._generate_yaml_entries(data_model):
+            full_path = subdir / file_path
+            # Create parent directories if needed (e.g., for views/, containers/, nodes/)
+            full_path.parent.mkdir(parents=True, exist_ok=True)
+            full_path.write_text(
+                yaml_content,
+                encoding=self.ENCODING,
+                newline=self.NEW_LINE,
+            )
+
+    def _export_to_zip_file(self, data_model: RequestSchema, zip_file: Path) -> None:
+        """Save the schema as a zip file containing a directory as YAML files.
+        This is compatible with the Cognite-Toolkit convention.
+
+        Args:
+            data_model: Request schema
+            zip_file: The zip file path to save the schema to.
+        """
+        if zip_file.suffix not in {".zip"}:
+            warnings.warn("File extension is not .zip, adding it to the file name", stacklevel=2)
+            zip_file = zip_file.with_suffix(".zip")
+
+        with zipfile.ZipFile(zip_file, "w") as zip_ref:
+            for file_path, yaml_content in self._generate_yaml_entries(data_model):
+                zip_ref.writestr(f"data_models/{file_path}", yaml_content)
+
+    def _generate_yaml_entries(self, data_model: RequestSchema) -> Iterator[tuple[str, str]]:
+        """Generate file paths and YAML content for all data model components.
+
+        This helper method eliminates duplication by centralizing the logic for
+        iterating through spaces, views, containers, and node types.
+
+        Args:
+            data_model: Request schema
+
+        Yields:
+            Tuples of (file_path, yaml_content) for each component.
+            File paths are relative to the data_models directory.
+        """
+
+        def _dump(item: BaseModel) -> str:
+            return yaml.safe_dump(item.model_dump(mode="json", by_alias=True), sort_keys=False)
+
+        # Export spaces
+        for space in data_model.spaces:
+            yield f"{space.space}.space.yaml", _dump(space)
+
+        # Export data model
+        yield f"{data_model.data_model.external_id}.datamodel.yaml", _dump(data_model.data_model)
+
+        component_configs: list[tuple[str, list[ViewRequest] | list[ContainerRequest] | list[NodeReference]]] = [
+            ("views", data_model.views),
+            ("containers", data_model.containers),
+            ("nodes", data_model.node_types),
+        ]
+
+        for dir_prefix, components in component_configs:
+            file_suffix = dir_prefix.removesuffix("s")
+            for component in components:
+                yield f"{dir_prefix}/{component.external_id}.{file_suffix}.yaml", _dump(component)
 
 
 class DMSAPIJSONExporter(DMSAPIExporter, DMSFileExporter[RequestSchema]):

cognite/neat/_data_model/validation/dms/__init__.py

@@ -26,6 +26,7 @@ from ._containers import (
     ExternalContainerDoesNotExist,
     ExternalContainerPropertyDoesNotExist,
     RequiredContainerDoesNotExist,
+    RequiresConstraintCycle,
 )
 from ._limits import (
     ContainerPropertyCountIsOutOfLimits,
@@ -54,6 +55,7 @@ __all__ = [
     "ExternalContainerPropertyDoesNotExist",
     "ImplementedViewNotExisting",
     "RequiredContainerDoesNotExist",
+    "RequiresConstraintCycle",
     "ReverseConnectionContainerMissing",
     "ReverseConnectionContainerPropertyMissing",
     "ReverseConnectionContainerPropertyWrongType",

cognite/neat/_data_model/validation/dms/_containers.py

@@ -197,3 +197,41 @@ class RequiredContainerDoesNotExist(DataModelValidator):
                     )
 
         return errors
+
+
+class RequiresConstraintCycle(DataModelValidator):
+    """
+    Validates that requires constraints between containers do not form cycles.
+
+    ## What it does
+    This validator checks if the requires constraints between containers form a cycle.
+    For example, if container A requires B, B requires C, and C requires A, this forms
+    a cycle.
+
+    ## Why is this bad?
+    Cycles in requires constraints will be rejected by the CDF API. The deployment
+    of the data model will fail if any such cycle exists.
+
+    ## Example
+    Container `my_space:OrderContainer` requires `my_space:CustomerContainer`, which
+    requires `my_space:OrderContainer`. This creates a cycle and will be rejected.
+    """
+
+    code = f"{BASE_CODE}-005"
+    issue_type = ConsistencyError
+    alpha = True  # Still in development
+
+    def run(self) -> list[ConsistencyError]:
+        errors: list[ConsistencyError] = []
+
+        for cycle in self.validation_resources.requires_constraint_cycles:
+            cycle_str = " -> ".join(str(c) for c in cycle) + f" -> {cycle[0]!s}"
+            errors.append(
+                ConsistencyError(
+                    message=f"Requires constraints form a cycle: {cycle_str}",
+                    fix="Remove one of the requires constraints to break the cycle",
+                    code=self.code,
+                )
+            )
+
+        return errors

cognite/neat/_version.py

@@ -1,2 +1,2 @@
-__version__ = "1.0.22"
+__version__ = "1.0.24"
 __engine__ = "^2.0.4"

{cognite_neat-1.0.22.dist-info → cognite_neat-1.0.24.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cognite-neat
-Version: 1.0.22
+Version: 1.0.24
 Summary: Knowledge graph transformation
 Author: Nikola Vasiljevic, Anders Albert
 Author-email: Nikola Vasiljevic <nikola.vasiljevic@cognite.com>, Anders Albert <anders.albert@cognite.com>
@@ -55,10 +55,10 @@ Requires-Dist: lxml>=5.3.0,<6.0.0 ; extra == 'lxml'
 Requires-Dist: oxrdflib>=0.4.0,<0.5.0 ; extra == 'oxi'
 Requires-Dist: pyoxigraph>=0.4.3,<0.5.0 ; extra == 'oxi'
 Requires-Python: >=3.10
-Project-URL: Changelog, https://github.com/cognitedata/neat/releases
 Project-URL: Documentation, https://cognite-neat.readthedocs-hosted.com/
-Project-URL: GitHub, https://github.com/cognitedata/neat
 Project-URL: Homepage, https://cognite-neat.readthedocs-hosted.com/
+Project-URL: GitHub, https://github.com/cognitedata/neat
+Project-URL: Changelog, https://github.com/cognitedata/neat/releases
 Provides-Extra: docs
 Provides-Extra: google
 Provides-Extra: lxml

{cognite_neat-1.0.22.dist-info → cognite_neat-1.0.24.dist-info}/RECORD

@@ -29,7 +29,7 @@ cognite/neat/_data_model/deployer/_differ_view.py,sha256=g1xHwsoxFUaTOTtQa19nntK
 cognite/neat/_data_model/deployer/data_classes.py,sha256=cq86u7wuKCcvH-A_cGI_gWzlQCTIG6mrXG2MahdiGco,27299
 cognite/neat/_data_model/deployer/deployer.py,sha256=lEdTh4jOwTxLkSEx-SlcnXUZyPZCUtIzop1zhAe2s44,19681
 cognite/neat/_data_model/exporters/__init__.py,sha256=AskjmB_0Vqib4kN84bWt8-M8nO42QypFf-l-E8oA5W8,482
-cognite/neat/_data_model/exporters/_api_exporter.py,sha256=G9cqezy_SH8VdhW4o862qBHh_QcbzfP6O1Yyjvdpeog,1579
+cognite/neat/_data_model/exporters/_api_exporter.py,sha256=nBDHx9dGbaje0T4IEQv0Kulk2Yu7FkPXgXK_MgLbE50,4948
 cognite/neat/_data_model/exporters/_base.py,sha256=rG_qAU5i5Hh5hUMep2UmDFFZID4x3LEenL6Z5C6N8GQ,646
 cognite/neat/_data_model/exporters/_table_exporter/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cognite/neat/_data_model/exporters/_table_exporter/exporter.py,sha256=4BPu_Chtjh1EyOaKbThXYohsqllVOkCbSoNekNZuBXc,5159
@@ -74,12 +74,12 @@ cognite/neat/_data_model/models/entities/_data_types.py,sha256=DfdEWGek7gODro-_0
 cognite/neat/_data_model/models/entities/_identifiers.py,sha256=a7ojJKY1ErZgUANHscEwkctX4RJ7bWEEWOQt5g5Tsdk,1915
 cognite/neat/_data_model/models/entities/_parser.py,sha256=zef_pSDZYMZrJl4IKreFDR577KutfhtN1xpH3Ayjt2o,7669
 cognite/neat/_data_model/validation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cognite/neat/_data_model/validation/dms/__init__.py,sha256=kKD18-Bg_G-w11Cs7Wv_TKV0C_q62Pm2RKLpOz27ar4,2642
+cognite/neat/_data_model/validation/dms/__init__.py,sha256=STb0mYmyD-E6CfhjaXNOgWM1LvYSm59m6-Khu9cEhNI,2702
 cognite/neat/_data_model/validation/dms/_ai_readiness.py,sha256=bffMQJ5pqumU5P3KaEdQP67OO5eMKqzN2BAWbUjG6KE,16143
 cognite/neat/_data_model/validation/dms/_base.py,sha256=G_gMPTgKwyBW62UcCkKIBVHWp9ufAZPJ2p7o69_dJI0,820
 cognite/neat/_data_model/validation/dms/_connections.py,sha256=-kUXf2_3V50ckxwXRwJoTHsKkS5zxiBKkkkHg8Dm4WI,30353
 cognite/neat/_data_model/validation/dms/_consistency.py,sha256=IKSUoRQfQQcsymviESW9VuTFX7jsZMXfsObeZHPdov4,2435
-cognite/neat/_data_model/validation/dms/_containers.py,sha256=5Lka1Cg-SaP9Ued0cku0leG1Sjx76JQ9XcBZK_dtfuM,8520
+cognite/neat/_data_model/validation/dms/_containers.py,sha256=8pVnmeX6G9tQaGzzwRB_40y7TYUm4guaNbRiFgoGILU,9895
 cognite/neat/_data_model/validation/dms/_limits.py,sha256=U7z8sN-kAyJsF5hYHPNBBg25Fvz1F8njhzYVSQOIiOU,14779
 cognite/neat/_data_model/validation/dms/_orchestrator.py,sha256=qiuUSUmNhekFyBARUUO2yhG-X9AeU_LL49UrJ65JXFA,2964
 cognite/neat/_data_model/validation/dms/_views.py,sha256=pRdnj5ZBnHNnbLKleXGbipteGma8_l5AYsDIfqgAil4,6345
@@ -321,9 +321,9 @@ cognite/neat/_v0/session/_template.py,sha256=BNcvrW5y7LWzRM1XFxZkfR1Nc7e8UgjBClH
 cognite/neat/_v0/session/_to.py,sha256=AnsRSDDdfFyYwSgi0Z-904X7WdLtPfLlR0x1xsu_jAo,19447
 cognite/neat/_v0/session/_wizard.py,sha256=baPJgXAAF3d1bn4nbIzon1gWfJOeS5T43UXRDJEnD3c,1490
 cognite/neat/_v0/session/exceptions.py,sha256=jv52D-SjxGfgqaHR8vnpzo0SOJETIuwbyffSWAxSDJw,3495
-cognite/neat/_version.py,sha256=Hfg3XAZ55nMEf14PYaan3dSoGcksNgatAnU-8OnQxPQ,45
+cognite/neat/_version.py,sha256=PO9Xwbm-V67g819NDS3RNL4T-HEXrVj1Uh15fuaKXMw,45
 cognite/neat/legacy.py,sha256=eI2ecxOV8ilGHyLZlN54ve_abtoK34oXognkFv3yvF0,219
 cognite/neat/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cognite_neat-1.0.22.dist-info/WHEEL,sha256=XjEbIc5-wIORjWaafhI6vBtlxDBp7S9KiujWF1EM7Ak,79
-cognite_neat-1.0.22.dist-info/METADATA,sha256=mctTUqJ2MXTzVNKQPCDhhCFzHim1f7W5tTHhVtdytac,6689
-cognite_neat-1.0.22.dist-info/RECORD,,
+cognite_neat-1.0.24.dist-info/WHEEL,sha256=XV0cjMrO7zXhVAIyyc8aFf1VjZ33Fen4IiJk5zFlC3g,80
+cognite_neat-1.0.24.dist-info/METADATA,sha256=2vPtDebNUHh5VM6_xSvyvtiDYEegtjFKofJk2siB6Iw,6689
+cognite_neat-1.0.24.dist-info/RECORD,,

{cognite_neat-1.0.22.dist-info → cognite_neat-1.0.24.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: uv 0.9.25
+Generator: uv 0.9.26
 Root-Is-Purelib: true
-Tag: py3-none-any
+Tag: py3-none-any