cognite-neat 0.123.40__tar.gz → 0.123.42__tar.gz

cognite_neat-0.123.42/.github/CODEOWNERS

@@ -0,0 +1,3 @@
+* @cognitedata/velocity
+
+

{cognite_neat-0.123.40 → cognite_neat-0.123.42}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cognite-neat
-Version: 0.123.40
+Version: 0.123.42
 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.42/cognite/neat/_data_model/importers/__init__.py

@@ -0,0 +1,3 @@
+from ._base import DMSImporter
+
+__all__ = ["DMSImporter"]

cognite_neat-0.123.42/cognite/neat/_data_model/importers/_base.py

@@ -0,0 +1,16 @@
+from abc import ABC, abstractmethod
+
+from cognite.neat._data_model.models.dms import RequestSchema
+
+
+class DMSImporter(ABC):
+    """This is the base class for all DMS importers."""
+
+    @abstractmethod
+    def to_data_model(self) -> RequestSchema:
+        """Convert the imported data to a RequestSchema.
+
+        Returns:
+            RequestSchema: The data model as a RequestSchema.
+        """
+        raise NotImplementedError()

{cognite_neat-0.123.40 → cognite_neat-0.123.42}/cognite/neat/_data_model/models/dms/__init__.py

@@ -36,10 +36,12 @@ from ._data_model import DataModelRequest, DataModelResponse
 from ._references import (
     ContainerDirectReference,
     ContainerReference,
+    DataModelReference,
     NodeReference,
     ViewDirectReference,
     ViewReference,
 )
+from ._schema import RequestSchema
 from ._view_property import (
     ConnectionPropertyDefinition,
     ConstraintOrIndexState,
@@ -74,6 +76,7 @@ __all__ = [
     "ContainerReference",
     "ContainerRequest",
     "ContainerResponse",
+    "DataModelReference",
     "DataModelRequest",
     "DataModelResponse",
     "DataType",
@@ -94,6 +97,7 @@ __all__ = [
     "MultiReverseDirectRelationPropertyResponse",
     "NodeReference",
     "PropertyTypeDefinition",
+    "RequestSchema",
     "RequiresConstraintDefinition",
     "Resource",
     "SequenceCDFExternalIdReference",

{cognite_neat-0.123.40 → cognite_neat-0.123.42}/cognite/neat/_data_model/models/dms/_data_model.py

@@ -8,7 +8,7 @@ from ._constants import (
     DM_VERSION_PATTERN,
     SPACE_FORMAT_PATTERN,
 )
-from ._references import ViewReference
+from ._references import DataModelReference, ViewReference
 
 
 class DataModel(Resource, ABC):
@@ -52,6 +52,13 @@ class DataModel(Resource, ABC):
         default=None,
     )
 
+    def as_reference(self) -> DataModelReference:
+        return DataModelReference(
+            space=self.space,
+            externalId=self.external_id,
+            version=self.version,
+        )
+
 
 class DataModelRequest(DataModel): ...
 

{cognite_neat-0.123.40 → cognite_neat-0.123.42}/cognite/neat/_data_model/models/dms/_references.py

@@ -31,7 +31,7 @@ class ContainerReference(ReferenceObject):
     )
 
 
-class ViewReference(BaseModelObject):
+class ViewReference(ReferenceObject):
     type: Literal["view"] = "view"
     space: str = Field(
         description="Id of the space that the view belongs to.",
@@ -52,7 +52,27 @@ class ViewReference(BaseModelObject):
     )
 
 
-class NodeReference(BaseModelObject):
+class DataModelReference(ReferenceObject):
+    space: str = Field(
+        description="Id of the space that the data model belongs to.",
+        min_length=1,
+        max_length=43,
+        pattern=SPACE_FORMAT_PATTERN,
+    )
+    external_id: str = Field(
+        description="External-id of the data model.",
+        min_length=1,
+        max_length=255,
+        pattern=DM_EXTERNAL_ID_PATTERN,
+    )
+    version: str = Field(
+        description="Version of the data model.",
+        max_length=43,
+        pattern=DM_VERSION_PATTERN,
+    )
+
+
+class NodeReference(ReferenceObject):
     space: str = Field(
         description="Id of the space hosting (containing) the node.",
         min_length=1,
@@ -67,7 +87,7 @@ class NodeReference(BaseModelObject):
     )
 
 
-class ContainerDirectReference(BaseModelObject):
+class ContainerDirectReference(ReferenceObject):
     source: ContainerReference = Field(
         description="Reference to the container from where this relation is inherited.",
     )
@@ -79,7 +99,7 @@ class ContainerDirectReference(BaseModelObject):
     )
 
 
-class ViewDirectReference(BaseModelObject):
+class ViewDirectReference(ReferenceObject):
     source: ViewReference = Field(
         description="Reference to the view from where this relation is inherited.",
     )

cognite_neat-0.123.42/cognite/neat/_data_model/models/dms/_schema.py

@@ -0,0 +1,18 @@
+from pydantic import Field
+
+from ._base import Resource
+from ._container import ContainerRequest
+from ._data_model import DataModelRequest
+from ._references import NodeReference
+from ._space import SpaceRequest
+from ._views import ViewRequest
+
+
+class RequestSchema(Resource):
+    """Represents a schema for creating or updating a data model in DMS."""
+
+    data_model: DataModelRequest
+    views: list[ViewRequest] = Field(default_factory=list)
+    containers: list[ContainerRequest] = Field(default_factory=list)
+    spaces: list[SpaceRequest] = Field(default_factory=list)
+    node_types: list[NodeReference] = Field(default_factory=list)

{cognite_neat-0.123.40 → cognite_neat-0.123.42}/cognite/neat/_data_model/models/dms/_views.py

@@ -61,6 +61,9 @@ class View(Resource, ABC):
         description="References to the views from where this view will inherit properties.",
     )
 
+    def as_reference(self) -> ViewReference:
+        return ViewReference(space=self.space, externalId=self.external_id, version=self.version)
+
     @model_validator(mode="before")
     def set_connection_type_on_primary_properties(cls, data: dict) -> dict:
         if "properties" not in data:

cognite_neat-0.123.42/cognite/neat/_version.py

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

{cognite_neat-0.123.40 → cognite_neat-0.123.42}/cognite/neat/v0/core/_constants.py

@@ -274,3 +274,5 @@ DMS_RESERVED_PROPERTIES = frozenset(
         "endNode",
     }
 )
+
+NAMED_GRAPH_NAMESPACE = Namespace("http://thisisneat.io/namedgraph/")

{cognite_neat-0.123.40 → cognite_neat-0.123.42}/cognite/neat/v0/core/_instances/queries/_select.py

@@ -450,3 +450,45 @@ class SelectQueries(BaseQuery):
                 yield instance_id, str(space.toPython())
             else:
                 yield instance_id, str(space)
+
+    def _get_graph_diff(
+        self, source_graph: URIRef, target_graph: URIRef
+    ) -> Iterable[tuple[URIRef, URIRef, URIRef | RdfLiteral]]:
+        query = f"""
+        SELECT ?s ?p ?o
+        WHERE {{
+        GRAPH <{source_graph}> {{ ?s ?p ?o }}
+        FILTER NOT EXISTS {{
+            GRAPH <{target_graph}> {{ ?s ?p ?o }}
+        }}
+        }}
+        """
+        return cast(Iterable[tuple[URIRef, URIRef, URIRef | RdfLiteral]], self.dataset.query(query))
+
+    def get_triples_to_delete(
+        self, old_graph: URIRef, new_graph: URIRef
+    ) -> Iterable[tuple[URIRef, URIRef, URIRef | RdfLiteral]]:
+        """Find triples that exist in old graph but not in new graph.
+
+        Args:
+            old_graph: URI of the old named graph
+            new_graph: URI of the new named graph
+
+        Returns:
+            List of triples (subject, predicate, object) to delete
+        """
+        return self._get_graph_diff(old_graph, new_graph)
+
+    def get_triples_to_add(
+        self, old_graph: URIRef, new_graph: URIRef
+    ) -> Iterable[tuple[URIRef, URIRef, URIRef | RdfLiteral]]:
+        """Find triples that exist in new graph but not in old graph.
+
+        Args:
+            old_graph: URI of the old named graph
+            new_graph: URI of the new named graph
+
+        Returns:
+            List of triples (subject, predicate, object) to add
+        """
+        return self._get_graph_diff(new_graph, old_graph)

{cognite_neat-0.123.40 → cognite_neat-0.123.42}/cognite/neat/v0/session/_read.py

@@ -1,15 +1,19 @@
+import re
 import warnings
 from typing import Any, Literal, cast
 
 from cognite.client.data_classes.data_modeling import DataModelId, DataModelIdentifier
 from cognite.client.utils.useful_types import SequenceNotStr
+from rdflib import URIRef
 
 from cognite.neat.v0.core._client import NeatClient
 from cognite.neat.v0.core._constants import (
     CLASSIC_CDF_NAMESPACE,
+    NAMED_GRAPH_NAMESPACE,
     get_default_prefixes_and_namespaces,
 )
 from cognite.neat.v0.core._data_model import catalog, importers
+from cognite.neat.v0.core._data_model._constants import SPACE_COMPLIANCE_REGEX
 from cognite.neat.v0.core._data_model.importers import BaseImporter
 from cognite.neat.v0.core._data_model.models.entities._single_value import ViewEntity
 from cognite.neat.v0.core._data_model.transformers import ClassicPrepareCore
@@ -826,13 +830,21 @@ class RDFReadAPI(BaseReadAPI):
         importer = importers.OWLImporter.from_file(reader.materialize_path(), source_name=f"file {reader!s}")
         return self._state.data_model_import(importer)
 
-    def instances(self, io: Any) -> IssueList:
+    def instances(self, io: Any, named_graph: str | None = None) -> IssueList:
         self._state._raise_exception_if_condition_not_met(
             "Read RDF Instances",
             empty_data_model_store_required=True,
         )
         reader = NeatReader.create(io)
-        self._state.instances.store.write(extractors.RdfFileExtractor(reader.materialize_path()))
+
+        # validate and convert named_graph to URI
+        named_graph_uri: URIRef | None = None
+        if named_graph:
+            if not re.match(SPACE_COMPLIANCE_REGEX, named_graph):
+                raise NeatValueError(f"Named graph '{named_graph}' does not comply with naming requirements. ")
+            named_graph_uri = NAMED_GRAPH_NAMESPACE[named_graph]
+
+        self._state.instances.store.write(extractors.RdfFileExtractor(reader.materialize_path()), named_graph_uri)
         return IssueList()
 
     def __call__(
@@ -840,6 +852,7 @@ class RDFReadAPI(BaseReadAPI):
         io: Any,
         type: NeatObjectType | None = None,
         source: RDFFileType | None = None,
+        named_graph: str | URIRef | None = None,
     ) -> IssueList:
         if type is None:
             type = object_wizard()
@@ -858,7 +871,7 @@ class RDFReadAPI(BaseReadAPI):
                 raise ValueError(f"Expected ontology, imf types or instances, got {source}")
 
         elif type == "instances":
-            return self.instances(io)
+            return self.instances(io, named_graph=named_graph)
 
         else:
             raise NeatSessionError(f"Expected data model or instances, got {type}")

cognite_neat-0.123.42/last_changelog_entry.md

@@ -0,0 +1,3 @@
+### Added
+- Add named_graph parameter to read.rdf.instances() to support loading
+RDF data into named graphs

cognite_neat-0.123.42/last_git_message.txt

@@ -0,0 +1,23 @@
+THIS-758 Extends neat.read.rdf.instances() with optional named_graph parameter (#1316)
+
+# Description
+
+Extends neat.read.rdf.instances() with optional named_graph parameter
+to specify which named graph to load RDF data into.
+
+## Bump
+
+- [x] Patch
+- [ ] Minor
+- [ ] Skip
+
+## Changelog
+### Added
+- Add named_graph parameter to read.rdf.instances() to support loading
+RDF data into named graphs
+
+---------
+
+Co-authored-by: Andrian Gasper <andrian.gasper@cognite.com>
+Co-authored-by: Nikola Vasiljevic <35523348+nikokaoja@users.noreply.github.com>
+Co-authored-by: Anders Albert <60234212+doctrino@users.noreply.github.com>

cognite_neat-0.123.42/last_version.txt

@@ -0,0 +1 @@
+0.123.41

{cognite_neat-0.123.40 → cognite_neat-0.123.42}/pyproject.toml

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

{cognite_neat-0.123.40 → cognite_neat-0.123.42}/tests/tests_unit/test_data_model/test_models/test_dms/test_data_models.py

@@ -5,7 +5,7 @@ import pytest
 from hypothesis import given, settings
 from pydantic import ValidationError
 
-from cognite.neat._data_model.models.dms import DataModelRequest, DataModelResponse
+from cognite.neat._data_model.models.dms import DataModelReference, DataModelRequest, DataModelResponse
 from cognite.neat._utils.validation import humanize_validation_error
 
 from .strategies import data_model_strategy
@@ -164,6 +164,9 @@ class TestDataModelResponse:
         request = response.as_request()
         assert isinstance(request, DataModelRequest)
 
+        reference = response.as_reference()
+        assert isinstance(reference, DataModelReference)
+
         dumped = request.model_dump()
         response_dumped = response.model_dump()
         response_only_keys = set(DataModelResponse.model_fields.keys()) - set(DataModelRequest.model_fields.keys())

{cognite_neat-0.123.40 → cognite_neat-0.123.42}/tests/tests_unit/test_data_model/test_models/test_dms/test_views.py

@@ -7,6 +7,7 @@ from pydantic import ValidationError
 
 from cognite.neat._data_model.models.dms import (
     ViewPropertyDefinition,
+    ViewReference,
     ViewRequest,
     ViewRequestProperty,
     ViewResponse,
@@ -269,6 +270,9 @@ class TestViewResponse:
         request = response.as_request()
         assert isinstance(request, ViewRequest)
 
+        reference = response.as_reference()
+        assert isinstance(reference, ViewReference)
+
         # Properties have differences in request and response, so we need to compare them
         # separately
         dumped = request.model_dump(exclude={"properties"})

{cognite_neat-0.123.40 → cognite_neat-0.123.42}/tests/v0/tests_unit/test_session/test_read.py

@@ -3,7 +3,7 @@ from cognite.client.data_classes.data_modeling import NodeId
 
 from cognite.neat import NeatSession
 from cognite.neat.v0.core._client.testing import monkeypatch_neat_client
-from cognite.neat.v0.core._constants import CLASSIC_CDF_NAMESPACE
+from cognite.neat.v0.core._constants import CLASSIC_CDF_NAMESPACE, NAMED_GRAPH_NAMESPACE
 from cognite.neat.v0.core._instances.extractors._classic_cdf._base import InstanceIdPrefix
 from cognite.neat.v0.core._issues import NeatIssue
 from cognite.neat.v0.core._issues.warnings import NeatValueWarning
@@ -95,3 +95,27 @@ class TestReadClassicTimeSeries:
             )
         )
         assert instances_ids == expected
+
+
+def test_read_rdf_instances_with_named_graph(tmp_path) -> None:
+    """Test reading RDF instances into a named graph"""
+
+    ttl_file = tmp_path / "test.ttl"
+    ttl_file.write_text(
+        """
+        @prefix ex: <http://example.org/> .
+        ex:subject1 ex:predicate1 "value1" .
+        ex:subject2 ex:predicate2 "value2" .
+    """
+    )
+
+    neat = NeatSession()
+
+    # Test with string named_graph
+    issues = neat.read.rdf.instances(ttl_file, named_graph="my_test_graph")
+    assert not issues.has_errors
+
+    expected_graph_uri = NAMED_GRAPH_NAMESPACE["my_test_graph"]
+    target_graph = neat._state.instances.store.graph(expected_graph_uri)
+
+    assert target_graph.identifier == expected_graph_uri

cognite_neat-0.123.42/tests/v0/tests_unit/test_store/test_select_queries.py

@@ -0,0 +1,104 @@
+from rdflib import RDF, Literal, Namespace, URIRef
+from rdflib.namespace import XSD
+
+from cognite.neat.v0.core._constants import DEFAULT_NAMESPACE
+from cognite.neat.v0.core._store import NeatInstanceStore
+
+
+class TestListInstanceObjectIds:
+    def test_list_instance_object_ids(self) -> None:
+        store = NeatInstanceStore.from_oxi_local_store()
+        my_entity = DEFAULT_NAMESPACE["my_entity"]
+        my_other_entity = DEFAULT_NAMESPACE["my_other_entity"]
+        store._add_triples(
+            [
+                (my_entity, RDF.type, DEFAULT_NAMESPACE["Entity"]),
+                (my_entity, DEFAULT_NAMESPACE["name"], Literal("My Entity")),
+                (my_entity, DEFAULT_NAMESPACE["connection"], my_other_entity),
+                (my_other_entity, RDF.type, DEFAULT_NAMESPACE["Entity"]),
+            ],
+            named_graph=store.default_named_graph,
+        )
+
+        result = list(store.queries.select.list_instance_object_ids())
+
+        assert len(result) == 1
+        assert result[0] == my_other_entity
+
+
+def test_get_triples_to_delete() -> None:
+    """Test finding triples that exist in old graph but not in new graph"""
+    store = NeatInstanceStore.from_oxi_local_store()
+    example = Namespace("http://example.org/")
+
+    old_graph = URIRef("urn:test:old")
+    new_graph = URIRef("urn:test:new")
+
+    # add 3 triples to old graph
+    store._add_triples(
+        [
+            (example.subject1, example.pred1, Literal("value1")),
+            (example.subject2, example.pred2, Literal("value2")),
+            (example.subject3, example.pred3, Literal("value3")),
+        ],
+        named_graph=old_graph,
+    )
+
+    # add 2 same triples + 1 new to new graph
+    store._add_triples(
+        [
+            (example.subject1, example.pred1, Literal("value1")),
+            (example.subject2, example.pred2, Literal("value2")),
+            (example.subject4, example.pred4, Literal("value4")),
+        ],
+        named_graph=new_graph,
+    )
+
+    # get triples to delete
+    result = list(store.queries.select.get_triples_to_delete(old_graph, new_graph))
+
+    assert len(result) == 1
+    assert tuple(result[0]) == (
+        example.subject3,
+        example.pred3,
+        Literal("value3", datatype=XSD.string),
+    )
+
+
+def test_get_triples_to_add() -> None:
+    """Test finding triples that exist in new graph but not in old graph"""
+
+    store = NeatInstanceStore.from_oxi_local_store()
+    example = Namespace("http://example.org/")
+
+    old_graph = URIRef("urn:test:old")
+    new_graph = URIRef("urn:test:new")
+
+    # add 2 triples to old graph
+    store._add_triples(
+        [
+            (example.subject1, example.pred1, Literal("value1")),
+            (example.subject2, example.pred2, Literal("value2")),
+        ],
+        named_graph=old_graph,
+    )
+
+    # add 2 same triples + 1 new to new graph
+    store._add_triples(
+        [
+            (example.subject1, example.pred1, Literal("value1")),
+            (example.subject2, example.pred2, Literal("value2")),
+            (example.subject3, example.pred3, Literal("value3")),
+        ],
+        named_graph=new_graph,
+    )
+
+    # get triples to add
+    result = list(store.queries.select.get_triples_to_add(old_graph, new_graph))
+
+    assert len(result) == 1
+    assert tuple(result[0]) == (
+        example.subject3,
+        example.pred3,
+        Literal("value3", datatype=XSD.string),
+    )

{cognite_neat-0.123.40 → cognite_neat-0.123.42}/uv.lock

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

cognite_neat-0.123.40/.github/CODEOWNERS

@@ -1,3 +0,0 @@
-* @cognitedata/accelerate @cognitedata/velocity
-
-

cognite_neat-0.123.40/cognite/neat/_version.py

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

cognite_neat-0.123.40/last_changelog_entry.md

@@ -1,4 +0,0 @@
-
-### Added
-
-- Add Concept Pydantic Model

cognite_neat-0.123.40/last_git_message.txt

@@ -1,22 +0,0 @@
-THIS-268 Add Concept Pydantic Model (#1306)
-
-# Description
-
-This is stacked PR on top of #1301
-
-`Concept` pydantic model has been added. The model shape is similar to
-DMS `View` pydantic representation. This has been purposely done as it
-will aid simpler conversion between DMS and Conceptual representation
-
-No tests as we are trusting Pydantic doing what is suppose to do
-
-## Bump
-
-- [x] Patch
-- [ ] Minor
-- [ ] Skip
-
-## Changelog
-### Added
-
-- Add Concept Pydantic Model

cognite_neat-0.123.40/last_version.txt

@@ -1 +0,0 @@
-0.123.39

cognite_neat-0.123.40/tests/v0/tests_unit/test_store/test_select_queries.py

@@ -1,25 +0,0 @@
-from rdflib import RDF, Literal
-
-from cognite.neat.v0.core._constants import DEFAULT_NAMESPACE
-from cognite.neat.v0.core._store import NeatInstanceStore
-
-
-class TestListInstanceObjectIds:
-    def test_list_instance_object_ids(self) -> None:
-        store = NeatInstanceStore.from_oxi_local_store()
-        my_entity = DEFAULT_NAMESPACE["my_entity"]
-        my_other_entity = DEFAULT_NAMESPACE["my_other_entity"]
-        store._add_triples(
-            [
-                (my_entity, RDF.type, DEFAULT_NAMESPACE["Entity"]),
-                (my_entity, DEFAULT_NAMESPACE["name"], Literal("My Entity")),
-                (my_entity, DEFAULT_NAMESPACE["connection"], my_other_entity),
-                (my_other_entity, RDF.type, DEFAULT_NAMESPACE["Entity"]),
-            ],
-            named_graph=store.default_named_graph,
-        )
-
-        result = list(store.queries.select.list_instance_object_ids())
-
-        assert len(result) == 1
-        assert result[0] == my_other_entity