cognite-neat 0.123.1__tar.gz → 0.123.2__tar.gz

{cognite_neat-0.123.1 → cognite_neat-0.123.2}/PKG-INFO

@@ -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.2/cognite/neat/_version.py

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

{cognite_neat-0.123.1 → cognite_neat-0.123.2}/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-0.123.1 → cognite_neat-0.123.2}/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-0.123.1 → cognite_neat-0.123.2}/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-0.123.1 → cognite_neat-0.123.2}/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-0.123.1 → cognite_neat-0.123.2}/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-0.123.2/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-0.123.1 → cognite_neat-0.123.2}/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.2/last_changelog_entry.md

@@ -0,0 +1,4 @@
+
+### Added
+
+- Access to the neat plugins via NeatSession

cognite_neat-0.123.2/last_git_message.txt

@@ -0,0 +1,27 @@
+Neat 1031 plugin access via NeatSession (#1233)
+
+# Description
+
+This PR provides interface in NeatSession for accessing external plugins
+(if they exist). If external plugin does not exist a nice error is
+returned:
+![Screenshot 2025-06-06 at 15 12
+51](https://github.com/user-attachments/assets/b9106baf-bfbd-4bb8-909a-eb8509ff4360)
+
+Example of WIP external plugins:
+- [IMF Importer](https://github.com/thisisneat-io/imf-importer-plugin)
+- [CFIHOS](https://github.com/cognitedata/industrial-standard-processor)
+
+To reviewers: this is stacked PR on top of
+[Neat-1030](https://github.com/cognitedata/neat/pull/1232).
+
+## Bump
+
+- [x] Patch
+- [ ] Minor
+- [ ] Skip
+
+## Changelog
+### Added
+
+- Access to the neat plugins via NeatSession

cognite_neat-0.123.2/last_version.txt

@@ -0,0 +1 @@
+0.123.1

{cognite_neat-0.123.1 → cognite_neat-0.123.2}/pyproject.toml

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

{cognite_neat-0.123.1 → cognite_neat-0.123.2}/tests/tests_unit/test_plugins.py

@@ -1,16 +1,24 @@
+import contextlib
+import io
 from importlib.metadata import EntryPoint, EntryPoints
 from pathlib import Path
 from typing import Any
 
 import pytest
 
+from cognite.neat import NeatSession
 from cognite.neat.core._data_model.importers._spreadsheet2data_model import ExcelImporter
+from cognite.neat.core._data_model.models.conceptual._verified import (
+    ConceptualDataModel,
+)
+from cognite.neat.plugins import _manager
 from cognite.neat.plugins._issues import (
     PluginDuplicateError,
     PluginLoadingError,
 )
 from cognite.neat.plugins._manager import PluginManager
 from cognite.neat.plugins.data_model.importers import DataModelImporterPlugin
+from tests.data import SchemaData
 
 
 class ExcelDataModelImporterPlugin(DataModelImporterPlugin):
@@ -86,6 +94,21 @@ def non_loadable_neat_plugin():
     )
 
 
+@pytest.fixture
+def mock_external_plugin(neat_plugin_entry_points):
+    """Setup and teardown plugin manager for testing."""
+    # Store original manager instance
+    original_manager = _manager._manager_instance
+
+    # Setup: Load plugins with test entry points
+    _manager._manager_instance = _manager.PluginManager.load_plugins(neat_plugin_entry_points)
+
+    yield  # This is where the test runs
+
+    # Teardown: Restore original manager instance
+    _manager._manager_instance = original_manager
+
+
 def test_load_neat_plugin(neat_plugin_entry_points):
     """Test ExternalPlugin initialization."""
     manager = PluginManager.load_plugins(neat_plugin_entry_points)
@@ -108,3 +131,28 @@ def test_load_plugin_error(non_loadable_neat_plugin):
     """Test that registering a plugin with the same name raises an error."""
     with pytest.raises(PluginLoadingError):
         PluginManager.load_plugins(non_loadable_neat_plugin)
+
+
+def test_plugin_error_handling():
+    """Test that the plugin API raises the correct error when no plugin is found."""
+    neat = NeatSession()
+
+    # Neat Session does not raise an error, but prints it.
+    output = io.StringIO()
+    with contextlib.redirect_stdout(output):
+        neat.plugins.data_model.read("csv", "./test.txt")
+
+    printed_statements = output.getvalue()
+    assert printed_statements == (
+        "[ERROR] PluginError: No plugin of type 'DataModelImporterPlugin' registered \nunder name 'csv'\n"
+    )
+
+
+def test_plugin_read(mock_external_plugin):
+    neat = NeatSession()
+    neat.plugins.data_model.read("excel", SchemaData.Conceptual.info_arch_car_rules_xlsx)
+
+    assert isinstance(
+        neat._state.data_model_store.last_verified_conceptual_data_model,
+        ConceptualDataModel,
+    )

{cognite_neat-0.123.1 → cognite_neat-0.123.2}/uv.lock

@@ -346,7 +346,7 @@ wheels = [
 
 [[package]]
 name = "cognite-neat"
-version = "0.123.1"
+version = "0.123.2"
 source = { editable = "." }
 dependencies = [
     { name = "backports-strenum", marker = "python_full_version < '3.11'" },

cognite_neat-0.123.1/cognite/neat/_version.py

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

cognite_neat-0.123.1/last_changelog_entry.md

@@ -1,6 +0,0 @@
-
-### Fixed
-
-- When writing instances (nodes and edges) to CDF using the
-`neat.to.cdf.instance()` method, Neat now checks that CDF will have at
-least free space for 500 000 instances after the writing is done.

cognite_neat-0.123.1/last_git_message.txt

@@ -1,23 +0,0 @@
-[NEAT-958, NEAT-811]  Check instance limit (#1222)
-
-# Description
-
-**Context**: We had incidents were neat has caused other applications to
-fail. This happen as the result of the user creating large amounts of
-instances in CDF using neat and filling up the instance capacity of the
-CDF project. This adds a fail-safe that stops the user from using neat
-to fill up to the instance limit in a CDF project and leave a margin
-such that other applications can continue to add new instances.
-
-## Bump
-
-- [x] Patch
-- [ ] Minor
-- [ ] Skip
-
-## Changelog
-### Fixed
-
-- When writing instances (nodes and edges) to CDF using the
-`neat.to.cdf.instance()` method, Neat now checks that CDF will have at
-least free space for 500 000 instances after the writing is done.

cognite_neat-0.123.1/last_version.txt

@@ -1 +0,0 @@
-0.123.0