cognite-neat 0.123.34__py3-none-any.whl → 0.123.35__py3-none-any.whl

cognite/neat/_version.py

@@ -1,2 +1,2 @@
-__version__ = "0.123.34"
+__version__ = "0.123.35"
 __engine__ = "^2.0.4"

cognite/neat/v0/plugins/__init__.py

@@ -1,3 +1,4 @@
+from ._data_model import DataModelImporterPlugin, DataModelTransformerPlugin
 from ._manager import get_plugin_manager
 
-__all__ = ["get_plugin_manager"]
+__all__ = ["DataModelImporterPlugin", "DataModelTransformerPlugin", "get_plugin_manager"]

cognite/neat/v0/plugins/_base.py

@@ -0,0 +1,9 @@
+from abc import ABC, abstractmethod
+from typing import Any
+
+
+class NeatPlugin(ABC):
+    @abstractmethod
+    def configure(self, *args: Any, **kwargs: Any) -> Any:
+        """A method that all plugins must implement."""
+        raise NotImplementedError()

cognite/neat/v0/plugins/_data_model.py

@@ -0,0 +1,48 @@
+from pathlib import Path
+from typing import Any
+
+from cognite.neat.v0.core._data_model.importers._base import BaseImporter
+from cognite.neat.v0.core._data_model.transformers._base import VerifiedDataModelTransformer
+
+from ._base import NeatPlugin
+
+
+class DataModelImporterPlugin(NeatPlugin):
+    """This class is used an interface for data model import plugins.
+    Any plugin that is used for importing data models should inherit from this class.
+    It is expected to implement the `configure` method which returns a configured importer.
+    """
+
+    def configure(self, io: str | Path | None, **kwargs: Any) -> BaseImporter:
+        """Return a configure plugin for data model import.
+        Args:
+            io (str | Path | None): The input/output interface for the plugin.
+            **kwargs (Any): Additional keyword arguments for configuration.
+        Returns:
+            BaseImporter: A configured instance of the BaseImporter.
+        !!! note "Returns"
+            The method must return an instance of `BaseImporter` or its subclasses
+            meaning it must implement the `BaseImporter` interface.
+        """
+
+        raise NotImplementedError()
+
+
+class DataModelTransformerPlugin(NeatPlugin):
+    """This class is used as an interface for data model transformer plugins.
+    Any plugin that is used for transforming data models should inherit from this class.
+    It is expected to implement the `configure` method which returns a configured transformer.
+    """
+
+    def configure(self, **kwargs: Any) -> VerifiedDataModelTransformer:
+        """Return a configure plugin for data model import.
+        Args:
+            **kwargs (Any): Additional keyword arguments for configuration.
+        Returns:
+            VerifiedDataModelTransformer: A configured instance of the VerifiedDataModelTransformer.
+        !!! note "Returns"
+            The method must return an instance of `VerifiedDataModelTransformer` or its subclasses
+            meaning it must implement the `VerifiedDataModelTransformer` interface.
+        """
+
+        raise NotImplementedError()

cognite/neat/v0/plugins/_manager.py

@@ -1,21 +1,11 @@
 """Plugin manager for external plugins."""
 
 from importlib import metadata
-from typing import Any, ClassVar, TypeAlias, TypeVar, cast
+from typing import Any, ClassVar
 
+from ._base import NeatPlugin
+from ._data_model import DataModelImporterPlugin, DataModelTransformerPlugin
 from ._issues import PluginDuplicateError, PluginError, PluginLoadingError
-from .data_model.importers import DataModelImporterPlugin
-
-# Here we configure entry points where external plugins are going to be registered.
-plugins_entry_points = {
-    "cognite.neat.v0.plugins.data_model.importers": DataModelImporterPlugin,
-}
-
-#: 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:
@@ -48,12 +38,13 @@ class PluginManager:
 
     _plugins_entry_points: ClassVar[dict[str, type[NeatPlugin]]] = {
         "cognite.neat.v0.plugins.data_model.importers": DataModelImporterPlugin,
+        "cognite.neat.v0.plugins.data_model.transformers": DataModelTransformerPlugin,
     }
 
     def __init__(self, plugins: dict[tuple[str, type[NeatPlugin]], Any]) -> None:
         self._plugins = plugins
 
-    def get(self, name: str, type_: type[T_NeatPlugin]) -> type[T_NeatPlugin]:
+    def get(self, name: str, type_: type[NeatPlugin]) -> type[NeatPlugin]:
         """
         Returns desired plugin
 
@@ -63,7 +54,7 @@ class PluginManager:
         """
         try:
             plugin_class = self._plugins[(name, type_)]
-            return cast(type[T_NeatPlugin], plugin_class)
+            return plugin_class
         except KeyError:
             raise PluginError(plugin_name=name, plugin_type=type_.__name__) from None
 

cognite/neat/v0/session/_plugin.py

@@ -4,8 +4,7 @@ from typing import Any
 
 from cognite.neat.v0.core._issues._base import IssueList
 from cognite.neat.v0.core._utils.reader._base import NeatReader
-from cognite.neat.v0.plugins import get_plugin_manager
-from cognite.neat.v0.plugins.data_model.importers._base import DataModelImporterPlugin
+from cognite.neat.v0.plugins import DataModelImporterPlugin, get_plugin_manager
 from cognite.neat.v0.session._experimental import ExperimentalFlags
 
 from ._state import SessionState

{cognite_neat-0.123.34.dist-info → cognite_neat-0.123.35.dist-info}/METADATA

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

@@ -1,5 +1,5 @@
 cognite/neat/__init__.py,sha256=Lo4DbjDOwnhCYUoAgPp5RG1fDdF7OlnomalTe7n1ydw,211
-cognite/neat/_version.py,sha256=ta4oMlJUvDU3nY4lbUMsc0rlosf138ZYBeYdejtGs_0,47
+cognite/neat/_version.py,sha256=oyuRoPyhH1BP1A6GaXszY7yVBk58ETdF9YpPI-S9EPQ,47
 cognite/neat/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cognite/neat/_data_model/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cognite/neat/_data_model/_constants.py,sha256=NGGvWHlQqhkkSBP_AqoofGYjNph3SiZX6QPINlMsy04,107
@@ -182,12 +182,11 @@ cognite/neat/v0/core/_utils/upload.py,sha256=nRhq8G63avFZW-o9HCsepXCk1qFmFfm0EpE
 cognite/neat/v0/core/_utils/xml_.py,sha256=FQkq84u35MUsnKcL6nTMJ9ajtG9D5i1u4VBnhGqP2DQ,1710
 cognite/neat/v0/core/_utils/reader/__init__.py,sha256=fPkrNB_9hLB7CyHTCFV_xEbIfOMqUQzNly5JN33-QfM,146
 cognite/neat/v0/core/_utils/reader/_base.py,sha256=baZVNEFv7F2xheQOy34K0sBjsHQTUT6se3kZDrBsVXA,5420
-cognite/neat/v0/plugins/__init__.py,sha256=Q7r1FFbybOt71N9TjHjjk-1HguLRfHieLeiGVSG5HTY,75
+cognite/neat/v0/plugins/__init__.py,sha256=acsDoiw0ztT2T-RyUIPtr8rfWpQBj4M6LmSEuAJcQjQ,209
+cognite/neat/v0/plugins/_base.py,sha256=zYy9b7LeDrijRHWzj_ASv4WlsSjo12Msu3DIyBW2zT8,255
+cognite/neat/v0/plugins/_data_model.py,sha256=MSfb9Gtz-whsY3-usMaPYBxpc9-C5qN3gWdN5ca6wDI,2088
 cognite/neat/v0/plugins/_issues.py,sha256=9lbLlxgPSVHjirOhEHyNQ0Pf3NH82Psj_DuTCcJDQQQ,943
-cognite/neat/v0/plugins/_manager.py,sha256=KQkQJGcXa5oXGQVqYGJFBNIJuSLxVrcaxBeH0Fs0GRs,3985
-cognite/neat/v0/plugins/data_model/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cognite/neat/v0/plugins/data_model/importers/__init__.py,sha256=d4UJNCFR1DXPY7lv5LdCW2hiStEhvXiu2g_bRSIp1y0,89
-cognite/neat/v0/plugins/data_model/importers/_base.py,sha256=fgqf9-HPpiSf9GCyHfcERiOhjNQVk_uAQDz3E-7ezTM,1037
+cognite/neat/v0/plugins/_manager.py,sha256=Pmaw5yjobMJ64OYaODX3FTaH1Q7hW9rzbz0A8wyIZcI,3683
 cognite/neat/v0/session/__init__.py,sha256=fxQ5URVlUnmEGYyB8Baw7IDq-uYacqkigbc4b-Pr9Fw,58
 cognite/neat/v0/session/_base.py,sha256=cLVrNEIizWKdPb2LRtXYxQRQczAnyHXJ46Ak1P4X03k,12967
 cognite/neat/v0/session/_collector.py,sha256=YCPeapbxBK-vAFMq7ekLy0Pn796M9AM7B8hxFtgsOUU,4236
@@ -197,7 +196,7 @@ cognite/neat/v0/session/_explore.py,sha256=YQF8ubCm-dkpO5WuVfYGTkQjhF_XKHFcG6Ko5
 cognite/neat/v0/session/_fix.py,sha256=PrXfrSR2DMkKD_k3MajaaziKJaYdIp9wr5aHvra66V4,925
 cognite/neat/v0/session/_inspect.py,sha256=6xC-tLJfP7sbSQpIlpPmCQWklGxK_rEXBE41jtuUQ-s,10184
 cognite/neat/v0/session/_mapping.py,sha256=9lQFnB0wpizo4ySIEDMWh183qpHh8TlVL7uOgAtJUxE,2904
-cognite/neat/v0/session/_plugin.py,sha256=1FTkwCkfUpNUQHzb_EM_2LHKnbxjOgU8exBxhmzNb24,2297
+cognite/neat/v0/session/_plugin.py,sha256=TqEeUYDiZmOyl33h44J5OlqkH7VzgGi63nJFidpBV4M,2235
 cognite/neat/v0/session/_prepare.py,sha256=HFdDmBnYRpaCm90s_A0byHLJIZwKrt2ve6i3EyN0V6w,12802
 cognite/neat/v0/session/_read.py,sha256=2pdlWa-OHQ4j2gRKNTeBzWBOipDPnznnqyys-yzUq2s,34658
 cognite/neat/v0/session/_set.py,sha256=qFi3YrYBd09MfHVJ2Ak0PCGigTAhGttfnA2iWSYwUt4,4617
@@ -213,7 +212,7 @@ cognite/neat/v0/session/engine/__init__.py,sha256=D3MxUorEs6-NtgoICqtZ8PISQrjrr4
 cognite/neat/v0/session/engine/_import.py,sha256=1QxA2_EK613lXYAHKQbZyw2yjo5P9XuiX4Z6_6-WMNQ,169
 cognite/neat/v0/session/engine/_interface.py,sha256=3W-cYr493c_mW3P5O6MKN1xEQg3cA7NHR_ev3zdF9Vk,533
 cognite/neat/v0/session/engine/_load.py,sha256=u0x7vuQCRoNcPt25KJBJRn8sJabonYK4vtSZpiTdP4k,5201
-cognite_neat-0.123.34.dist-info/METADATA,sha256=LQ5wGh18pUFa70uOa5fM2u8ptNENBCOvLeAaJ2cJTSM,9195
-cognite_neat-0.123.34.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-cognite_neat-0.123.34.dist-info/licenses/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
-cognite_neat-0.123.34.dist-info/RECORD,,
+cognite_neat-0.123.35.dist-info/METADATA,sha256=6euHGIZPibwW7EYiWDy5Y829gpbSJyKlt7xjQDD5UkI,9195
+cognite_neat-0.123.35.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+cognite_neat-0.123.35.dist-info/licenses/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
+cognite_neat-0.123.35.dist-info/RECORD,,

cognite/neat/v0/plugins/data_model/importers/__init__.py

@@ -1,5 +0,0 @@
-from ._base import DataModelImporterPlugin
-
-__all__ = [
-    "DataModelImporterPlugin",
-]

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

@@ -1,28 +0,0 @@
-from pathlib import Path
-from typing import Any
-
-from cognite.neat.v0.core._data_model.importers._base import BaseImporter
-
-
-class DataModelImporterPlugin:
-    """This class is used an interface for data model import plugins.
-    Any plugin that is used for importing data models should inherit from this class.
-    It is expected to implement the `configure` method which returns a configured importer.
-    """
-
-    def configure(self, io: str | Path | None, **kwargs: Any) -> BaseImporter:
-        """Return a configure plugin for data model import.
-
-        Args:
-            io (str | Path | None): The input/output interface for the plugin.
-            **kwargs (Any): Additional keyword arguments for configuration.
-
-        Returns:
-            BaseImporter: A configured instance of the BaseImporter.
-
-        !!! note "Returns"
-            The method must return an instance of `BaseImporter` or its subclasses
-            meaning it must implement the `BaseImporter` interface.
-        """
-
-        raise NotImplementedError()