cognite-neat 0.123.21__py3-none-any.whl → 0.123.22__py3-none-any.whl

cognite/neat/_version.py

@@ -1,2 +1,2 @@
-__version__ = "0.123.21"
+__version__ = "0.123.22"
 __engine__ = "^2.0.4"

cognite/neat/session/_session/_data_model/_read.py

@@ -1,6 +1,9 @@
-from typing import Any, Literal
+from typing import Any, Literal, cast
 from zipfile import Path
 
+from cognite.client.data_classes.data_modeling import DataModelId, DataModelIdentifier
+
+from cognite.neat.core._client._api_client import NeatClient
 from cognite.neat.core._data_model import importers
 from cognite.neat.core._data_model.importers._base import BaseImporter
 from cognite.neat.core._issues._base import IssueList
@@ -12,7 +15,7 @@ from cognite.neat.plugins.data_model.importers._base import DataModelImporterPlu
 from cognite.neat.session._state import SessionState
 from cognite.neat.session.exceptions import NeatSessionError, session_class_wrapper
 
-InternalReaderName = Literal["excel", "ontology", "yaml"]
+InternalReaderName = Literal["excel", "cdf", "ontology", "yaml"]
 
 
 @session_class_wrapper
@@ -20,16 +23,21 @@ class ReadAPI:
     def __init__(self, state: SessionState) -> None:
         self._state = state
 
-    def __call__(self, name: str, io: str | Path, **kwargs: Any) -> IssueList:
-        """Provides access to the external plugins for data model importing.
+    def __call__(self, name: str, io: str | Path | DataModelIdentifier, **kwargs: Any) -> IssueList:
+        """Provides access to internal data model readers and external data model
+        reader plugins.
 
         Args:
-            name (str): The name of format (e.g. Excel) plugin is handling.
-            io (str | Path | None): The input/output interface for the plugin.
-            **kwargs (Any): Additional keyword arguments for the plugin.
+            name (str): The name of format (e.g. Excel) reader is handling.
+            io (str | Path | | DataModelIdentifier | None): The input/output interface for the reader.
+            **kwargs (Any): Additional keyword arguments for the reader.
+
+        !!! note "io"
+            The `io` parameter can be a file path, sting, or a DataModelIdentifier
+            depending on the reader's requirements.
 
         !!! note "kwargs"
-            Users must consult the documentation of the plugin to understand
+            Users must consult the documentation of the reader to understand
             what keyword arguments are supported.
         """
 
@@ -39,16 +47,19 @@ class ReadAPI:
         # The match statement cleanly handles each case.
         match clean_name:
             case "excel":
-                return self.excel(io, **kwargs)
+                return self.excel(cast(str | Path, io), **kwargs)
+
+            case "cdf":
+                return self.cdf(cast(DataModelIdentifier, io))
 
             case "ontology":
-                return self.ontology(io)
+                return self.ontology(cast(str | Path, io))
 
             case "yaml":
-                return self.yaml(io, **kwargs)
+                return self.yaml(cast(str | Path, io), **kwargs)
 
             case _:  # The wildcard '_' acts as the default 'else' case.
-                return self._plugin(name, io, **kwargs)
+                return self._plugin(name, cast(str | Path, io), **kwargs)
 
     def _plugin(self, name: str, io: str | Path, **kwargs: Any) -> IssueList:
         """Provides access to the external plugins for data model importing.
@@ -82,6 +93,34 @@ class ReadAPI:
 
         return self._state.data_model_import(plugin().configure(io=path, **kwargs))
 
+    def cdf(self, io: DataModelIdentifier) -> IssueList:
+        """Reads a Data Model from CDF to the knowledge graph.
+
+        Args:
+            io: Tuple of strings with the id of a CDF Data Model.
+            Notation as follows (<name_of_space>, <name_of_data_model>, <data_model_version>)
+
+        Example:
+            ```python
+            neat.read.cdf.data_model(("example_data_model_space", "EXAMPLE_DATA_MODEL", "v1"))
+            ```
+        """
+
+        data_model_id = DataModelId.load(io)
+
+        if not data_model_id.version:
+            raise NeatSessionError("Data model version is required to read a data model.")
+
+        self._state._raise_exception_if_condition_not_met(
+            "Read data model from CDF",
+            empty_data_model_store_required=True,
+            client_required=True,
+        )
+
+        return self._state.data_model_import(
+            importers.DMSImporter.from_data_model_id(cast(NeatClient, self._state.client), data_model_id)
+        )
+
     def excel(self, io: str | Path, *, enable_manual_edit: bool = False) -> IssueList:
         """Reads a Neat Excel Data Model to the data model store.
         The data model spreadsheets may contain conceptual or physical data model definitions.

{cognite_neat-0.123.21.dist-info → cognite_neat-0.123.22.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cognite-neat
-Version: 0.123.21
+Version: 0.123.22
 Summary: Knowledge graph transformation
 Project-URL: Documentation, https://cognite-neat.readthedocs-hosted.com/
 Project-URL: Homepage, https://cognite-neat.readthedocs-hosted.com/

{cognite_neat-0.123.21.dist-info → cognite_neat-0.123.22.dist-info}/RECORD

@@ -1,5 +1,5 @@
 cognite/neat/__init__.py,sha256=12StS1dzH9_MElqxGvLWrNsxCJl9Hv8A2a9D0E5OD_U,193
-cognite/neat/_version.py,sha256=9-mMs5I23aZ63EJvthXAffhYSuElr0qE664JQ-Vdr_I,47
+cognite/neat/_version.py,sha256=F_PTAPIzLmGDm4RPxIsNpijbHtxGJrALannZQ5hHcUY,47
 cognite/neat/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cognite/neat/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cognite/neat/core/_config.py,sha256=WT1BS8uADcFvGoUYOOfwFOVq_VBl472TisdoA3wLick,280
@@ -186,7 +186,7 @@ cognite/neat/session/_wizard.py,sha256=hARNNzD5Zfkk_V147rIjOLVvrFaqzXGXWhZuH1NJG
 cognite/neat/session/exceptions.py,sha256=z5jxwfVTXDCCFZKTTYVIaksNKqb9CMa2tyIZgyNL3Us,3475
 cognite/neat/session/_session/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cognite/neat/session/_session/_data_model/__init__.py,sha256=417QF6wm3r-bLTmhYGXL_5XnEFShCklLCoGg3YBOIqY,62
-cognite/neat/session/_session/_data_model/_read.py,sha256=boGdDCBQgBWsCf--HagOyOmUc4F49oPWLge7cVh7_6M,6355
+cognite/neat/session/_session/_data_model/_read.py,sha256=B_mVOt_9uKzG5vbrZG2Uf5D0FQGjcCDEdfAhIp2veUI,7902
 cognite/neat/session/_session/_data_model/_routes.py,sha256=wF83vLtmgyGCM2zxnHq0m3-sPQXQamObc58u2kSN7nQ,1666
 cognite/neat/session/_session/_data_model/_show.py,sha256=yX4BTIeBzcCcllfJvGm8g4qy13heFmcJtpXPixI8T2o,5835
 cognite/neat/session/_state/README.md,sha256=o6N7EL98lgyWffw8IoEUf2KG5uSKveD5__TW45YzVjA,902
@@ -194,7 +194,7 @@ cognite/neat/session/engine/__init__.py,sha256=D3MxUorEs6-NtgoICqtZ8PISQrjrr4dvc
 cognite/neat/session/engine/_import.py,sha256=1QxA2_EK613lXYAHKQbZyw2yjo5P9XuiX4Z6_6-WMNQ,169
 cognite/neat/session/engine/_interface.py,sha256=3W-cYr493c_mW3P5O6MKN1xEQg3cA7NHR_ev3zdF9Vk,533
 cognite/neat/session/engine/_load.py,sha256=g52uYakQM03VqHt_RDHtpHso1-mFFifH5M4T2ScuH8A,5198
-cognite_neat-0.123.21.dist-info/METADATA,sha256=MKG9VkaPiSGq4Ygn0MnUdqyX5TYKqtGmJfNVt-DvOdg,9172
-cognite_neat-0.123.21.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-cognite_neat-0.123.21.dist-info/licenses/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
-cognite_neat-0.123.21.dist-info/RECORD,,
+cognite_neat-0.123.22.dist-info/METADATA,sha256=cIvYIW2976HqHJSdiseJuSEG3om5ldv2Z-csEbZQt6Y,9172
+cognite_neat-0.123.22.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+cognite_neat-0.123.22.dist-info/licenses/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
+cognite_neat-0.123.22.dist-info/RECORD,,