cognite-neat 1.0.22__tar.gz → 1.0.24__tar.gz

{cognite_neat-1.0.22 → cognite_neat-1.0.24}/PKG-INFO

@@ -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.24/cognite/neat/_data_model/exporters/_api_exporter.py

@@ -0,0 +1,122 @@
+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]):
+    def export(self, data_model: RequestSchema) -> RequestSchema:
+        return data_model
+
+    def export_to_file(self, data_model: RequestSchema, file_path: Path) -> None:
+        raise RuntimeError(f"{type(self).__name__} does not support export_to_file method.")
+
+
+class DMSAPIYAMLExporter(DMSAPIExporter, DMSFileExporter[RequestSchema]):
+    def export_to_file(self, data_model: RequestSchema, file_path: Path) -> None:
+        """Export the data model to a YAML files or zip file in API format.
+
+        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]):
+    def export_to_file(self, data_model: RequestSchema, file_path: Path) -> None:
+        """Export the data model to a JSON file in API format."""
+        if file_path.suffix.lower() != ".json":
+            raise ValueError("The file path must have a .json extension.")
+
+        file_path.write_text(
+            data_model.model_dump_json(by_alias=True),
+            encoding=self.ENCODING,
+            newline=self.NEW_LINE,
+        )

{cognite_neat-1.0.22 → cognite_neat-1.0.24}/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-1.0.22 → cognite_neat-1.0.24}/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-1.0.24/cognite/neat/_version.py

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

{cognite_neat-1.0.22 → cognite_neat-1.0.24}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cognite-neat"
-version = "1.0.22"
+version = "1.0.24"
 readme = "README.md"
 description = "Knowledge graph transformation"
 authors = [

cognite_neat-1.0.22/cognite/neat/_data_model/exporters/_api_exporter.py

@@ -1,37 +0,0 @@
-from pathlib import Path
-
-import yaml
-
-from cognite.neat._data_model.exporters._base import DMSExporter, DMSFileExporter
-from cognite.neat._data_model.models.dms import RequestSchema
-
-
-class DMSAPIExporter(DMSExporter[RequestSchema]):
-    def export(self, data_model: RequestSchema) -> RequestSchema:
-        return data_model
-
-    def export_to_file(self, data_model: RequestSchema, file_path: Path) -> None:
-        raise RuntimeError(f"{type(self).__name__} does not support export_to_file method.")
-
-
-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.")
-
-        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)
-
-
-class DMSAPIJSONExporter(DMSAPIExporter, DMSFileExporter[RequestSchema]):
-    def export_to_file(self, data_model: RequestSchema, file_path: Path) -> None:
-        """Export the data model to a JSON file in API format."""
-        if file_path.suffix.lower() != ".json":
-            raise ValueError("The file path must have a .json extension.")
-
-        file_path.write_text(
-            data_model.model_dump_json(by_alias=True),
-            encoding=self.ENCODING,
-            newline=self.NEW_LINE,
-        )

cognite_neat-1.0.22/cognite/neat/_version.py

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