cognite-neat 0.123.30__tar.gz → 0.123.31__tar.gz

{cognite_neat-0.123.30 → cognite_neat-0.123.31}/.pre-commit-config.yaml

@@ -23,7 +23,7 @@ repos:
   - hooks:
     - id: mypy
       name: mypy
-      entry: dmypy run -- cognite/neat/
+      entry: dmypy run -- cognite/neat/ tests/tests_unit_v1/
       files: ^.*.(py|pyi)$
       language: system
       pass_filenames: false

{cognite_neat-0.123.30 → cognite_neat-0.123.31}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cognite-neat
-Version: 0.123.30
+Version: 0.123.31
 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.31/cognite/neat/_data_model/models/dms/__init__.py

@@ -0,0 +1,10 @@
+from ._base import Resource, WriteableResource
+from ._space import Space, SpaceRequest, SpaceResponse
+
+__all__ = [
+    "Resource",
+    "Space",
+    "SpaceRequest",
+    "SpaceResponse",
+    "WriteableResource",
+]

cognite_neat-0.123.31/cognite/neat/_data_model/models/dms/_base.py

@@ -0,0 +1,27 @@
+from abc import ABC, abstractmethod
+from typing import Generic, TypeVar
+
+from pydantic import BaseModel
+from pydantic.alias_generators import to_camel
+
+
+class BaseModelObject(BaseModel, alias_generator=to_camel, extra="ignore"):
+    """Base class for all object. This includes resources and nested objects."""
+
+    ...
+
+
+class Resource(BaseModelObject):
+    """Base class for all data modeling resources."""
+
+    ...
+
+
+T_Resource = TypeVar("T_Resource", bound=Resource)
+
+
+class WriteableResource(Generic[T_Resource], Resource, ABC):
+    @abstractmethod
+    def as_request(self) -> T_Resource:
+        """Convert the response model to a request model by removing read-only fields."""
+        raise NotImplementedError()

cognite_neat-0.123.31/cognite/neat/_data_model/models/dms/_constants.py

@@ -0,0 +1,2 @@
+SPACE_FORMAT_PATTERN = r"[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$"
+FORBIDDEN_SPACES = frozenset(["space", "cdf", "dms", "pg3", "shared", "system", "node", "edge"])

cognite_neat-0.123.31/cognite/neat/_data_model/models/dms/_space.py

@@ -0,0 +1,44 @@
+from abc import ABC
+
+from pydantic import Field, field_validator
+
+from cognite.neat.core._utils.text import humanize_collection
+
+from ._base import WriteableResource
+from ._constants import FORBIDDEN_SPACES, SPACE_FORMAT_PATTERN
+
+
+class Space(WriteableResource["SpaceRequest"], ABC):
+    space: str = Field(
+        description="The Space identifier (id).",
+        min_length=1,
+        max_length=43,
+        pattern=SPACE_FORMAT_PATTERN,
+    )
+    name: str | None = Field(None, description="Name of the space.", max_length=1024)
+    description: str | None = Field(None, description="The description of the space.", max_length=255)
+
+    @field_validator("space")
+    def check_forbidden_space_value(cls, val: str) -> str:
+        """Check the space name not present in forbidden set"""
+        if val in FORBIDDEN_SPACES:
+            raise ValueError(f"{val!r} is a reserved space. Reserved Spaces: {humanize_collection(FORBIDDEN_SPACES)}")
+        return val
+
+    def as_request(self) -> "SpaceRequest":
+        return SpaceRequest.model_validate(self.model_dump(by_alias=True))
+
+
+class SpaceResponse(Space):
+    created_time: int = Field(
+        description="When the space was created. The number of milliseconds since 00:00:00 Thursday, 1 January 1970, "
+        "Coordinated Universal Time (UTC), minus leap seconds."
+    )
+    last_updated_time: int = Field(
+        description="When the space was last updated. The number of milliseconds since 00:00:00 Thursday, "
+        "1 January 1970, Coordinated Universal Time (UTC), minus leap seconds."
+    )
+    is_global: bool = Field(description="Whether the space is a global space.")
+
+
+class SpaceRequest(Space): ...

cognite_neat-0.123.31/cognite/neat/_utils/auxiliary.py

@@ -0,0 +1,32 @@
+import inspect
+from abc import ABC
+from typing import TypeVar
+
+T_Cls = TypeVar("T_Cls")
+
+
+def get_concrete_subclasses(base_cls: type[T_Cls], exclude_direct_abc_inheritance: bool = True) -> list[type[T_Cls]]:
+    """
+    Returns a list of all concrete subclasses of the given base class.
+    Args:
+        base_cls (type[T_Cls]): The base class to find subclasses for.
+        exclude_direct_abc_inheritance (bool): If True, excludes classes that directly inherit from `abc.ABC`.
+            This is used as a marker to filter out intermediate base classes. Defaults to True.
+    Returns:
+        list[type[T_Cls]]: A list of concrete subclasses of the base class.
+    """
+    to_check = [base_cls]
+    subclasses: list[type[T_Cls]] = []
+    seen: set[type[T_Cls]] = {base_cls}
+    while to_check:
+        current_cls = to_check.pop()
+        for subclass in current_cls.__subclasses__():
+            if subclass in seen:
+                continue
+            if (not inspect.isabstract(subclass)) and (
+                not exclude_direct_abc_inheritance or ABC not in subclass.__bases__
+            ):
+                subclasses.append(subclass)
+            seen.add(subclass)
+            to_check.append(subclass)
+    return subclasses

cognite_neat-0.123.31/cognite/neat/_version.py

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

{cognite_neat-0.123.30 → cognite_neat-0.123.31}/cognite/neat/session/_base.py

@@ -33,7 +33,6 @@ from ._mapping import MappingAPI
 from ._plugin import PluginAPI
 from ._prepare import PrepareAPI
 from ._read import ReadAPI
-from ._session._data_model import DataModelAPI
 from ._set import SetAPI
 from ._show import ShowAPI
 from ._state import SessionState
@@ -116,9 +115,6 @@ class NeatSession:
         if load_engine != "skip" and (engine_version := load_neat_engine(client, load_engine)):
             print(f"Neat Engine {engine_version} loaded.")
 
-        # new API for data model operations
-        self.data_model = DataModelAPI(self._state)
-
     def _select_most_performant_store(self) -> Literal["memory", "oxigraph"]:
         """Select the most performant store based on the current environment."""
 

cognite_neat-0.123.31/last_changelog_entry.md

@@ -0,0 +1,3 @@
+
+### Removed
+- Object oriented session endpoints

cognite_neat-0.123.31/last_git_message.txt

@@ -0,0 +1,16 @@
+Removing object oriented Neat session endpoints (#1288)
+
+# Description
+
+New object oriented session endpoints are removed due to agreed strategy
+for neat version 1, which will be based on this new approach.
+
+## Bump
+
+- [x] Patch
+- [ ] Minor
+- [ ] Skip
+
+## Changelog
+### Removed
+- Object oriented session endpoints

cognite_neat-0.123.31/last_version.txt

@@ -0,0 +1 @@
+0.123.30

{cognite_neat-0.123.30 → cognite_neat-0.123.31}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cognite-neat"
-version = "0.123.30"
+version = "0.123.31"
 readme = "README.md"
 description = "Knowledge graph transformation"
 authors = [
@@ -95,6 +95,7 @@ dev = [
     "tqdm>=4.67.1, <5",
     "deepdiff>=8.2.0, <9.0.0",
     "hypothesis>=6.135.0, <7.0.0",
+    "polyfactory>=2.22.2",
 ]
 
 [tool.uv]
@@ -126,12 +127,17 @@ allow_redefinition = true
 namespace_packages = true
 show_error_codes = true
 plugins = ["pydantic.mypy"]
-exclude = ["tests/*"]
+# We use reflection a lot in this codebace, and mypy does not understand that
+# finding all subclasses of an abstract class gives you concrete implementations.
+# Thus, we disable the type-abstract error.
+disable_error_code = ["type-abstract"]
 
 [tool.pydantic-mypy]
 init_forbid_extra = true
 init_typed = true
-warn_required_dynamic_aliases = true
+# We use dynamic alias creation as much as possible. This is to ensure
+# all aliases are consistentenly camelCase.
+warn_required_dynamic_aliases = false
 
 [build-system]
 requires = ["hatchling >= 1.26"]

{cognite_neat-0.123.30 → cognite_neat-0.123.31}/tests/tests_end_to_end/test_rules_flow.py

@@ -28,21 +28,6 @@ class TestImportersToYAMLExporter:
         exported_rules = yaml.safe_load(exported_yaml_str)
         data_regression.check(exported_rules)
 
-    def test_excel_importer_to_yaml_new_endpoint(self, data_regression: DataRegressionFixture) -> None:
-        neat = NeatSession(verbose=False)
-
-        neat.data_model.read.excel(DOC_RULES / "information-architect-david.xlsx")
-
-        neat.convert()
-
-        exported_yaml_str = neat.to.yaml()
-
-        exported_rules = yaml.safe_load(exported_yaml_str)
-        data_regression.check(exported_rules)
-
-        exported_rules = yaml.safe_load(exported_yaml_str)
-        data_regression.check(exported_rules)
-
     def test_prohibiting_conversion_with_nice_message(self) -> None:
         neat = NeatSession()
 
@@ -57,20 +42,6 @@ class TestImportersToYAMLExporter:
             "[ERROR] Cannot convert: Convert to physical expects conceptual data model"
         )
 
-    def test_prohibiting_conversion_with_nice_message_new_endpoint(self) -> None:
-        neat = NeatSession()
-
-        neat.data_model.read.ontology(SchemaData.Conceptual.ontology_with_regex_warnings)
-
-        output = io.StringIO()
-        with contextlib.redirect_stdout(output):
-            neat.convert()
-
-        printed_statements = output.getvalue()
-        assert printed_statements.startswith(
-            "[ERROR] Cannot convert: Convert to physical expects conceptual data model"
-        )
-
     @pytest.mark.freeze_time("2017-05-21")
     @pytest.mark.skip("Needs NEAT-608 to be completed")
     def test_ontology_importer_to_yaml(self, data_regression: DataRegressionFixture, tmp_path: Path) -> None:

{cognite_neat-0.123.30 → cognite_neat-0.123.31}/tests/tests_integration/test_session/test_read.py

@@ -41,7 +41,7 @@ class TestRead:
         neat = NeatSession(client=cognite_client)
         # The CogniteDescribable view is referenced in the REFERENCING_CORE model read below.
         # The data product should lookup the describable properties and include them.
-        neat.data_model.read.cdf(("cdf_cdm", "CogniteCore", "v1"))
+        neat.read.cdf.data_model(("cdf_cdm", "CogniteCore", "v1"))
 
         exported_yaml_str = neat.to.yaml()
         exported_rules = yaml.safe_load(exported_yaml_str)

{cognite_neat-0.123.30 → cognite_neat-0.123.31}/tests/tests_unit/test_plugins.py

@@ -147,16 +147,6 @@ def test_plugin_error_handling():
         "[ERROR] PluginError: No plugin of type 'DataModelImporterPlugin' registered \nunder name 'csv'\n"
     )
 
-    # Alternative access point to the plugins via read
-    output = io.StringIO()
-    with contextlib.redirect_stdout(output):
-        neat.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()
@@ -166,12 +156,3 @@ def test_plugin_read(mock_external_plugin):
         neat._state.data_model_store.last_verified_conceptual_data_model,
         ConceptualDataModel,
     )
-
-    # alternative access point to the plugins via read
-    neat = NeatSession()
-    neat.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.31/tests/tests_unit_v1/test_data_model/test_models/test_dms/test_resources.py

@@ -0,0 +1,20 @@
+import pytest
+from polyfactory.factories.pydantic_factory import ModelFactory
+
+from cognite.neat._data_model.models.dms import Resource, WriteableResource
+from cognite.neat._utils.auxiliary import get_concrete_subclasses
+
+
+def all_concrete_resources() -> list[type[WriteableResource]]:
+    return get_concrete_subclasses(WriteableResource, exclude_direct_abc_inheritance=True)
+
+
+class TestAsRequest:
+    @pytest.mark.parametrize("resource_cls", all_concrete_resources())
+    def test_writeable_resource_as_request(self, resource_cls: type[WriteableResource]) -> None:
+        class ResourceFactory(ModelFactory[resource_cls]): ...  # type: ignore[valid-type]
+
+        instance = ResourceFactory.build()
+        # MyPy fails to understand that instance is a WriteableResource and not a type[WriteableResource]
+        request_instance = instance.as_request()  # type: ignore[attr-defined]
+        assert isinstance(request_instance, Resource)

cognite_neat-0.123.31/tests/tests_unit_v1/test_utils/test_auxiliary.py

@@ -0,0 +1,68 @@
+from abc import ABC, abstractmethod
+
+from cognite.neat._utils.auxiliary import get_concrete_subclasses
+
+
+class GrandParent(ABC):
+    @abstractmethod
+    def method(self) -> None:
+        pass
+
+
+class Parent(GrandParent, ABC): ...
+
+
+class Parent2(GrandParent):
+    def method(self) -> None:
+        print("Parent2 method implementation")
+
+
+class Child(Parent):
+    def method(self) -> None:
+        print("Child method implementation")
+
+
+class Child2(Parent):
+    def method(self) -> None:
+        print("Child2 method implementation")
+
+
+class Child3(Child, Parent2):
+    def method(self) -> None:
+        print("Child3 method implementation")
+
+
+class Mixin1(ABC):
+    @property
+    @abstractmethod
+    def mixin_property(self) -> str:
+        raise NotImplementedError()
+
+
+class Mixin2(ABC):
+    @abstractmethod
+    def mixin_method(self) -> str:
+        raise NotImplementedError()
+
+
+class MultiChild(Mixin1, Mixin2, GrandParent):
+    def method(self) -> None:
+        pass
+
+    def mixin_method(self) -> str:
+        return "Mixin method implementation"
+
+    @property
+    def mixin_property(self) -> str:
+        return "Mixin property implementation"
+
+
+class TestGetConcreteSubclasses:
+    def test_get_concrete_subclasses(self) -> None:
+        subclasses = get_concrete_subclasses(GrandParent)
+
+        assert set(subclasses) == {Parent2, Child, Child2, Child3, MultiChild}
+
+    def test_multiple_inheritance(self) -> None:
+        subclasses = get_concrete_subclasses(GrandParent)
+        assert len(subclasses) == len(set(subclasses)), "Subclasses should be unique"

{cognite_neat-0.123.30 → cognite_neat-0.123.31}/uv.lock

@@ -346,7 +346,7 @@ wheels = [
 
 [[package]]
 name = "cognite-neat"
-version = "0.123.30"
+version = "0.123.31"
 source = { editable = "." }
 dependencies = [
     { name = "backports-strenum", marker = "python_full_version < '3.11'" },
@@ -409,6 +409,7 @@ dev = [
     { name = "mypy" },
     { name = "networkx-stubs" },
     { name = "pandas-stubs" },
+    { name = "polyfactory" },
     { name = "pre-commit" },
     { name = "pytest" },
     { name = "pytest-cov" },
@@ -478,6 +479,7 @@ dev = [
     { name = "mypy", specifier = ">=1.8,<2" },
     { name = "networkx-stubs", specifier = ">=0,<1" },
     { name = "pandas-stubs", specifier = ">=2,<3" },
+    { name = "polyfactory", specifier = ">=2.22.2" },
     { name = "pre-commit", specifier = ">=4.0.0,<5.0.0" },
     { name = "pytest", specifier = ">=8.0.0,<9.0.0" },
     { name = "pytest-cov", specifier = ">=6.0.0,<7.0.0" },
@@ -794,6 +796,18 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/7b/8f/c4d9bafc34ad7ad5d8dc16dd1347ee0e507a52c3adb6bfa8887e1c6a26ba/executing-2.2.0-py2.py3-none-any.whl", hash = "sha256:11387150cad388d62750327a53d3339fad4888b39a6fe233c3afbb54ecffd3aa", size = 26702, upload-time = "2025-01-22T15:41:25.929Z" },
 ]
 
+[[package]]
+name = "faker"
+version = "37.8.0"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "tzdata" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/3a/da/1336008d39e5d4076dddb4e0f3a52ada41429274bf558a3cc28030d324a3/faker-37.8.0.tar.gz", hash = "sha256:090bb5abbec2b30949a95ce1ba6b20d1d0ed222883d63483a0d4be4a970d6fb8", size = 1912113, upload-time = "2025-09-15T20:24:13.592Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/f5/11/02ebebb09ff2104b690457cb7bc6ed700c9e0ce88cf581486bb0a5d3c88b/faker-37.8.0-py3-none-any.whl", hash = "sha256:b08233118824423b5fc239f7dd51f145e7018082b4164f8da6a9994e1f1ae793", size = 1953940, upload-time = "2025-09-15T20:24:11.482Z" },
+]
+
 [[package]]
 name = "fastjsonschema"
 version = "2.21.1"
@@ -2580,6 +2594,19 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/54/20/4d324d65cc6d9205fabedc306948156824eb9f0ee1633355a8f7ec5c66bf/pluggy-1.6.0-py3-none-any.whl", hash = "sha256:e920276dd6813095e9377c0bc5566d94c932c33b27a3e3945d8389c374dd4746", size = 20538, upload-time = "2025-05-15T12:30:06.134Z" },
 ]
 
+[[package]]
+name = "polyfactory"
+version = "2.22.2"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "faker" },
+    { name = "typing-extensions" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/4e/a6/950d13856d995705df33b92451559fd317207a9c43629ab1771135a0c966/polyfactory-2.22.2.tar.gz", hash = "sha256:a3297aa0b004f2b26341e903795565ae88507c4d86e68b132c2622969028587a", size = 254462, upload-time = "2025-08-15T06:23:21.28Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/e7/fe/d52c90e07c458f38b26f9972a25cb011b2744813f76fcd6121dde64744fa/polyfactory-2.22.2-py3-none-any.whl", hash = "sha256:9bea58ac9a80375b4153cd60820f75e558b863e567e058794d28c6a52b84118a", size = 63715, upload-time = "2025-08-15T06:23:19.664Z" },
+]
+
 [[package]]
 name = "pre-commit"
 version = "4.2.0"

cognite_neat-0.123.30/cognite/neat/_version.py

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

cognite_neat-0.123.30/cognite/neat/session/_session/_data_model/__init__.py

@@ -1,3 +0,0 @@
-from ._routes import DataModelAPI
-
-__all__ = ["DataModelAPI"]