cognite-neat 0.123.1__py3-none-any.whl → 0.123.2__py3-none-any.whl

cognite/neat/_version.py

@@ -1,2 +1,2 @@
-__version__ = "0.123.1"
+__version__ = "0.123.2"
 __engine__ = "^2.0.4"

cognite/neat/plugins/_issues.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass
 
-from cognite.neat.core._issues._base import NeatError
+from cognite.neat.core._issues.errors import _NEAT_ERRORS_BY_NAME, NeatError
 
 
 @dataclass(unsafe_hash=True)
@@ -23,3 +23,13 @@ class PluginDuplicateError(PluginError):
     """Plugin of type '{plugin_type}' registered for under name '{plugin_name}' already exists"""
 
     ...
+
+
+# Register the errors in the _NEAT_ERRORS_BY_NAME dictionary
+_NEAT_ERRORS_BY_NAME.update(
+    {
+        "PluginError": PluginError,
+        "PluginLoadingError": PluginLoadingError,
+        "PluginDuplicateError": PluginDuplicateError,
+    }
+)

cognite/neat/plugins/_manager.py

@@ -1,7 +1,7 @@
 """Plugin manager for external plugins."""
 
 from importlib import metadata
-from typing import Any, ClassVar, TypeAlias
+from typing import Any, ClassVar, TypeAlias, TypeVar, cast
 
 from ._issues import PluginDuplicateError, PluginError, PluginLoadingError
 from .data_model.importers import DataModelImporterPlugin
@@ -14,6 +14,9 @@ plugins_entry_points = {
 #: Type alias for all supported plugin types
 NeatPlugin: TypeAlias = DataModelImporterPlugin
 
+# Generic type variable for plugin types
+T_NeatPlugin = TypeVar("T_NeatPlugin", bound=NeatPlugin)
+
 
 class Plugin:
     """Plugin class for registering plugins registered via entry points (i.e. external plugins).
@@ -33,7 +36,7 @@ class Plugin:
         self.type_ = type_
         self.entry_point = entry_point
 
-    def load(self) -> Any:
+    def load(self) -> type[NeatPlugin]:
         try:
             return self.entry_point.load()
         except Exception as e:
@@ -50,7 +53,7 @@ class PluginManager:
     def __init__(self, plugins: dict[tuple[str, type[NeatPlugin]], Any]) -> None:
         self._plugins = plugins
 
-    def get(self, name: str, type_: type[NeatPlugin]) -> Any:
+    def get(self, name: str, type_: type[T_NeatPlugin]) -> type[T_NeatPlugin]:
         """
         Returns desired plugin
 
@@ -59,7 +62,8 @@ class PluginManager:
             type_ (type): The type of the plugin.
         """
         try:
-            return self._plugins[(name, type_)]
+            plugin_class = self._plugins[(name, type_)]
+            return cast(type[T_NeatPlugin], plugin_class)
         except KeyError:
             raise PluginError(plugin_name=name, plugin_type=type_.__name__) from None
 

cognite/neat/plugins/data_model/importers/_base.py

@@ -1,3 +1,4 @@
+from pathlib import Path
 from typing import Any
 
 from cognite.neat.core._data_model.importers._base import BaseImporter
@@ -9,11 +10,11 @@ class DataModelImporterPlugin:
     It is expected to implement the `configure` method which returns a configured importer.
     """
 
-    def configure(self, io: Any, **kwargs: Any) -> BaseImporter:
+    def configure(self, io: str | Path | None, **kwargs: Any) -> BaseImporter:
         """Return a configure plugin for data model import.
 
         Args:
-            io (Any): The input/output interface for the plugin.
+            io (str | Path | None): The input/output interface for the plugin.
             **kwargs (Any): Additional keyword arguments for configuration.
 
         Returns:

cognite/neat/session/_base.py

@@ -30,6 +30,7 @@ from ._explore import ExploreAPI
 from ._fix import FixAPI
 from ._inspect import InspectAPI
 from ._mapping import MappingAPI
+from ._plugin import PluginAPI
 from ._prepare import PrepareAPI
 from ._read import ReadAPI
 from ._set import SetAPI
@@ -108,6 +109,7 @@ class NeatSession:
         self.subset = SubsetAPI(self._state)
         self.template = TemplateAPI(self._state)
         self._explore = ExploreAPI(self._state)
+        self.plugins = PluginAPI(self._state)
         self.opt = OptAPI()
         self.opt._display()
         if load_engine != "skip" and (engine_version := load_neat_engine(client, load_engine)):

cognite/neat/session/_experimental.py

@@ -23,3 +23,4 @@ class ExperimentalFlags:
     csv_read = ExperimentalFeatureWarning("csv_read")
     to_ontology = ExperimentalFeatureWarning("to_ontology")
     extension = ExperimentalFeatureWarning("extension")
+    plugin = ExperimentalFeatureWarning("plugin")

cognite/neat/session/_plugin.py

@@ -0,0 +1,67 @@
+import warnings
+from pathlib import Path
+from typing import Any
+
+from cognite.neat.core._issues._base import IssueList
+from cognite.neat.core._utils.reader._base import NeatReader
+from cognite.neat.plugins import get_plugin_manager
+from cognite.neat.plugins.data_model.importers._base import DataModelImporterPlugin
+from cognite.neat.session._experimental import ExperimentalFlags
+
+from ._state import SessionState
+from .exceptions import session_class_wrapper
+
+
+@session_class_wrapper
+class PluginAPI:
+    """Read from a data source into NeatSession graph store."""
+
+    def __init__(self, state: SessionState) -> None:
+        self._state = state
+
+        self.data_model = DataModelPlugins(self._state)
+
+
+@session_class_wrapper
+class DataModelPlugins:
+    """Read from a data source into NeatSession graph store."""
+
+    def __init__(self, state: SessionState) -> None:
+        self._state = state
+
+    def read(self, name: str, io: str | Path | None = None, **kwargs: Any) -> IssueList:
+        """Provides access to the external plugins for data model importing.
+
+        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.
+
+        !!! note "kwargs"
+            Users must consult the documentation of the plugin to understand
+            what keyword arguments are supported.
+        """
+        warnings.filterwarnings("default")
+        ExperimentalFlags.plugin.warn()
+
+        # Some plugins may not support the io argument
+        if io:
+            reader = NeatReader.create(io)
+            path = reader.materialize_path()
+        else:
+            path = None
+
+        self._state._raise_exception_if_condition_not_met(
+            "Data Model Read",
+            empty_data_model_store_required=True,
+        )
+
+        plugin_manager = get_plugin_manager()
+        plugin = plugin_manager.get(name, DataModelImporterPlugin)
+
+        print(
+            f"You are using an external plugin {plugin.__name__}, which is not developed by the NEAT team."
+            "\nUse it at your own risk."
+        )
+
+        return self._state.data_model_import(plugin().configure(io=path, **kwargs))

cognite/neat/session/exceptions.py

@@ -6,6 +6,7 @@ from typing import Any, TypeVar
 from cognite.neat.core._issues.errors import CDFMissingClientError, NeatImportError
 from cognite.neat.core._issues.errors._external import OxigraphStorageLockedError
 from cognite.neat.core._issues.errors._general import NeatValueError, WillExceedLimitError
+from cognite.neat.plugins._issues import PluginError
 from cognite.neat.session._experimental import ExperimentalFeatureWarning
 
 from ._collector import _COLLECTOR
@@ -50,6 +51,7 @@ def _session_method_wrapper(func: Callable, cls_name: str) -> Any:
             NeatImportError,
             NeatValueError,
             OxigraphStorageLockedError,
+            PluginError,
             WillExceedLimitError,
         ) as e:
             print(f"{_ERROR_PREFIX} {escape(e.as_message())}")

{cognite_neat-0.123.1.dist-info → cognite_neat-0.123.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cognite-neat
-Version: 0.123.1
+Version: 0.123.2
 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.1.dist-info → cognite_neat-0.123.2.dist-info}/RECORD

@@ -1,5 +1,5 @@
 cognite/neat/__init__.py,sha256=12StS1dzH9_MElqxGvLWrNsxCJl9Hv8A2a9D0E5OD_U,193
-cognite/neat/_version.py,sha256=9xSFXBm0153-WkCC4TsK5hz4FpM0Eo8Z2KVqo6ptqSA,46
+cognite/neat/_version.py,sha256=HP2O0I_4JuG1TczHFazc53TQqD0Z8qh9R2SVWsXmlSQ,46
 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
@@ -161,20 +161,21 @@ cognite/neat/core/_utils/xml_.py,sha256=FQkq84u35MUsnKcL6nTMJ9ajtG9D5i1u4VBnhGqP
 cognite/neat/core/_utils/reader/__init__.py,sha256=fPkrNB_9hLB7CyHTCFV_xEbIfOMqUQzNly5JN33-QfM,146
 cognite/neat/core/_utils/reader/_base.py,sha256=fRXxUWW8a3UFedeCLxDTDgFntWGlHaEGxmKLcITtiWE,5417
 cognite/neat/plugins/__init__.py,sha256=Q7r1FFbybOt71N9TjHjjk-1HguLRfHieLeiGVSG5HTY,75
-cognite/neat/plugins/_issues.py,sha256=Xd3YsIN0EZakvgCLm5ilantTv17dVUabXc61nFxriQM,671
-cognite/neat/plugins/_manager.py,sha256=LQlEGjRgn55nu-dad9LKpqIaYqM12OoKRYBepCQz_1c,3769
+cognite/neat/plugins/_issues.py,sha256=jukeVjSs1DEzqtFuGRcIDbg7bNxZRxGPqnzumVRF-8c,940
+cognite/neat/plugins/_manager.py,sha256=_eJa5_3UGoLVacSQgbDrE0eWcopjeXxgbfSmvujeSiU,3979
 cognite/neat/plugins/data_model/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cognite/neat/plugins/data_model/importers/__init__.py,sha256=d4UJNCFR1DXPY7lv5LdCW2hiStEhvXiu2g_bRSIp1y0,89
-cognite/neat/plugins/data_model/importers/_base.py,sha256=S8VOw0eYJ94CDeOx7aTjBbBebNlpoWoGatpU5eOohtQ,981
+cognite/neat/plugins/data_model/importers/_base.py,sha256=M9zXp7tEu1SfJZRAJAtLmqpssdFcoi2X-5e25q_n_h8,1034
 cognite/neat/session/__init__.py,sha256=fxQ5URVlUnmEGYyB8Baw7IDq-uYacqkigbc4b-Pr9Fw,58
-cognite/neat/session/_base.py,sha256=DqujVyC19Jg8hGxnw9TfCeF3BYOFuauk4yTTuAsjJz4,12807
+cognite/neat/session/_base.py,sha256=vg8KgzpQxFnFCR4F0yRNSsRmrgYZQ77rW6eX4w7L9M4,12884
 cognite/neat/session/_collector.py,sha256=-icWXOT9YBjAOVZfpPtBx-D39kpRP2RaQKdPtcr7Xm8,4233
 cognite/neat/session/_drop.py,sha256=ipD8RS_ZebPNpeIkhC7yqSSeo7e57TXMRxrh5_6IRik,4239
-cognite/neat/session/_experimental.py,sha256=U_Wq3NWgnGaOJh5Fq8iO6HcYUhlG9RQIutT8e4LZL8o,1224
+cognite/neat/session/_experimental.py,sha256=0peZPZ9JpmzQE05wHbng2tWmPPLLTAVfWZEEUhdnI6o,1274
 cognite/neat/session/_explore.py,sha256=PLxpHDqBk5B0Q4a5tJKnF6KzL4heQ77b2qUETbf6iVQ,1599
 cognite/neat/session/_fix.py,sha256=oJRXuRI4f_HgLYHkjbtPAwHK0vSDUYd19hIZeFaE7rQ,919
 cognite/neat/session/_inspect.py,sha256=AESQd2SOidR_pDTFk5B_JdPnKZ5PNNskdAQBepH2Mv0,10175
 cognite/neat/session/_mapping.py,sha256=ItEXhXo_8V3069hktHMxdpBsLNeTck3gZBvhlm12Oxw,2895
+cognite/neat/session/_plugin.py,sha256=diFvZUFRvY037iVy_HxnIGMSfrauOpwYCSvFEPOzchQ,2282
 cognite/neat/session/_prepare.py,sha256=pskEVNgcnVJVRvYKk5xI55V89vKDO_kgjszj5flY8Zs,12778
 cognite/neat/session/_read.py,sha256=sKtSw7Ub--vR6wfEexNzzaEHb0MZCHj3kzCEnF5wjf0,35349
 cognite/neat/session/_set.py,sha256=PU4lKI-LGtKFVyvdtfZkk-zLw9e_rnFHzuV9IyrOrTM,4593
@@ -184,13 +185,13 @@ cognite/neat/session/_subset.py,sha256=p7n6WmL0gZlUbqpVBgyPncQ6uWn_pi7FDSixDFrm7
 cognite/neat/session/_template.py,sha256=NCgrrwLT98DpLYoo3Wybr_OUXrEXpsJZjrJ83KqfyWc,9908
 cognite/neat/session/_to.py,sha256=_R-UB3iEIQoa12kTD7tuSrRDdbySQXQg_mzbn5t-7bg,19399
 cognite/neat/session/_wizard.py,sha256=hARNNzD5Zfkk_V147rIjOLVvrFaqzXGXWhZuH1NJG3M,1486
-cognite/neat/session/exceptions.py,sha256=lcO-qQcWkKeF2lvlIZngs358ClcNIH8i6LVW7ioSinQ,3397
+cognite/neat/session/exceptions.py,sha256=z5jxwfVTXDCCFZKTTYVIaksNKqb9CMa2tyIZgyNL3Us,3475
 cognite/neat/session/_state/README.md,sha256=o6N7EL98lgyWffw8IoEUf2KG5uSKveD5__TW45YzVjA,902
 cognite/neat/session/engine/__init__.py,sha256=D3MxUorEs6-NtgoICqtZ8PISQrjrr4dvca6n48bu_bI,120
 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.1.dist-info/METADATA,sha256=4NPwnKYbAwVmCTktDxLB82sU6BtQKaqOA9vRTxUJveU,9171
-cognite_neat-0.123.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-cognite_neat-0.123.1.dist-info/licenses/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
-cognite_neat-0.123.1.dist-info/RECORD,,
+cognite_neat-0.123.2.dist-info/METADATA,sha256=S0A0bAMepNWiOxj_BGAZL_nSetJnWlVdrgA8JOps3rI,9171
+cognite_neat-0.123.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+cognite_neat-0.123.2.dist-info/licenses/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
+cognite_neat-0.123.2.dist-info/RECORD,,