cognite-neat 0.123.40__py3-none-any.whl → 0.123.42__py3-none-any.whl

cognite/neat/_data_model/importers/__init__.py

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

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/_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/_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/_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/_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/_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/_version.py

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

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/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/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.40.dist-info → cognite_neat-0.123.42.dist-info}/METADATA

@@ -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.40.dist-info → cognite_neat-0.123.42.dist-info}/RECORD

@@ -1,28 +1,31 @@
 cognite/neat/__init__.py,sha256=Lo4DbjDOwnhCYUoAgPp5RG1fDdF7OlnomalTe7n1ydw,211
 cognite/neat/_issues.py,sha256=uv0fkkWwTKqNmTmHqyoBB3L6yMCh42EZpEkLGmIJYOY,812
-cognite/neat/_version.py,sha256=EIGI3787UrfBLzGRh7i7dj6FiXl8fYEyp70inEeAqk8,47
+cognite/neat/_version.py,sha256=KPC_vMI9YJae3HbWzCydHnx-9mFGFnywrlkj0xH-U6U,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
 cognite/neat/_data_model/_identifiers.py,sha256=a0LcQ_h0NffxSKTCrzCDpYkrlaUTk-D_rfaQUh-BhWc,1921
+cognite/neat/_data_model/importers/__init__.py,sha256=GUp7WkjX6R02lQRHD-2ygkwNGPSWbFjrFettnCdrrAQ,58
+cognite/neat/_data_model/importers/_base.py,sha256=NRB0FcEBj4GaethU68nRffBfTedBBA866A3zfJNfmiQ,433
 cognite/neat/_data_model/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cognite/neat/_data_model/models/conceptual/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cognite/neat/_data_model/models/conceptual/_base.py,sha256=SFkoBJDM51pqew_isHFJoB20OgfofpwVRnTrg-rKkNY,710
 cognite/neat/_data_model/models/conceptual/_concept.py,sha256=0Pk4W2TJ_Y0Z7oPHpzely1kPXrAkmkyqw6a0n3il6LY,2248
 cognite/neat/_data_model/models/conceptual/_properties.py,sha256=CpF37vJYBTLT4DH4ZOu2U-JyWtkb_27V8fw52qiaE_k,4007
 cognite/neat/_data_model/models/conceptual/_property.py,sha256=CpF37vJYBTLT4DH4ZOu2U-JyWtkb_27V8fw52qiaE_k,4007
-cognite/neat/_data_model/models/dms/__init__.py,sha256=WDF6VOPdVbH5QX1Z_k5fLqxY1Joqy94IEEpPs69UnrQ,3477
+cognite/neat/_data_model/models/dms/__init__.py,sha256=I_yw2GoEjUdLk8VOiLSlU4BWgE3u_GgCHJayeEa1w1w,3583
 cognite/neat/_data_model/models/dms/_base.py,sha256=R8SP3Zi9daTBqewYKGjuNEkrWc-j91f-6t34CN-9YJ0,719
 cognite/neat/_data_model/models/dms/_constants.py,sha256=wBkLjAPwufPc2naxOfPA1XC0CM2RbDbo6Dpiv9dPrew,1344
 cognite/neat/_data_model/models/dms/_constraints.py,sha256=7Nv-EoNl6lSHUQh6r15Ei0LzR3gWV006K3RlAi1Ic68,956
 cognite/neat/_data_model/models/dms/_container.py,sha256=SgrMCRo04A1gqayJsCia6oMhYT7q3NaeMBZMOQNI-lA,5967
-cognite/neat/_data_model/models/dms/_data_model.py,sha256=vm_MPKdNAh9Ig4J4yz8gHv-qam_1rnH4SGwWXzPFPtw,2316
+cognite/neat/_data_model/models/dms/_data_model.py,sha256=GNa05JEj_eSRGoKB8vkR85-Qv-IhPlDR3gXZNQMfe6g,2537
 cognite/neat/_data_model/models/dms/_data_types.py,sha256=XSGQWVzYFRYAzKsDln20nC2kqiHQC6JAvDeTzCBPT-0,5202
 cognite/neat/_data_model/models/dms/_indexes.py,sha256=MsiHbGCH50QaF1mw_pIY-AZ5dY37vS3fQECOd2rBXWo,780
-cognite/neat/_data_model/models/dms/_references.py,sha256=OLqp3EFMJDOl4Zaw2IdtM2vPWeDZf6VMYPgjNX6R0Jc,2532
+cognite/neat/_data_model/models/dms/_references.py,sha256=LJ7xlXATf7AP_Uj-8LlxatQk5GG1Tu4CHGK63cJqUU4,3078
+cognite/neat/_data_model/models/dms/_schema.py,sha256=2JFLcm52smzPdtZ69Lf02UbYAD8I_hpRbI7ZAzdxJJs,641
 cognite/neat/_data_model/models/dms/_space.py,sha256=-1LkRmQaAdIj2EYDcVv5Mcejl5uswgAEVv7DztpIUk4,1680
 cognite/neat/_data_model/models/dms/_view_property.py,sha256=wiRxb5qtzGnBooBUzN7xtwMBZiZ9aRFcN5ML4lCTXdQ,8331
-cognite/neat/_data_model/models/dms/_views.py,sha256=mpIKOgMs5WkUZ8fupcHGOrcJtDH9o4f0fhuB3Pua5OE,6435
+cognite/neat/_data_model/models/dms/_views.py,sha256=afUZisM-6r0_IeSwn8ZVFAqWfodHBWrMcFnk_a-ewSI,6579
 cognite/neat/_data_model/models/entities/__init__.py,sha256=qdtIpyy2hjfdMwEHya-efOCvWassaalQla15RnqK00E,798
 cognite/neat/_data_model/models/entities/_base.py,sha256=PaNrD29iwxuqTpRWbmESMTxRhhKXmRyDF_cLZEC69dg,3927
 cognite/neat/_data_model/models/entities/_constants.py,sha256=EK9Bus8UgFgxK5cVFMTAqWSl6aWkDe7d59hpUmlHlBs,517
@@ -42,7 +45,7 @@ cognite/neat/_utils/http_client/_tracker.py,sha256=EBBnd-JZ7nc_jYNFJokCHN2UZ9sx0
 cognite/neat/v0/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cognite/neat/v0/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cognite/neat/v0/core/_config.py,sha256=WT1BS8uADcFvGoUYOOfwFOVq_VBl472TisdoA3wLick,280
-cognite/neat/v0/core/_constants.py,sha256=J0avfxWcipJup-pv9MvFIaO8NC0heDaNAsmSPMFEP3U,9063
+cognite/neat/v0/core/_constants.py,sha256=mNNHu-QAD54DEA9A1yHd9Fk19SbqZAE6DoCfYxDRvbM,9134
 cognite/neat/v0/core/_shared.py,sha256=Ov59SWYboRRsncB_5V1ZC_BAoACfNLjo80vqE5Ru6wo,2325
 cognite/neat/v0/core/_client/__init__.py,sha256=RQ7MwL8mwGqGHokRzsPqO3XStDzmI4-c12_gz1UPJ74,177
 cognite/neat/v0/core/_client/_api_client.py,sha256=ZIipNVjd0kVts5Gh-PcV96DhA-RyT0v5EwZHa77hdXg,863
@@ -152,7 +155,7 @@ cognite/neat/v0/core/_instances/loaders/_rdf_to_instance_space.py,sha256=T1nNzhY
 cognite/neat/v0/core/_instances/queries/__init__.py,sha256=W477LMyB4l6HIRbQhJoFgA_MUBwVCh2GBvtFeZu0AUA,53
 cognite/neat/v0/core/_instances/queries/_base.py,sha256=APevHeeWQDEoOQ0MlBtVlPf9hbZukVkI5fOvt5oPJCE,543
 cognite/neat/v0/core/_instances/queries/_queries.py,sha256=4BidSQXhdZYZ6_kyG7jMJ2iG0UtSrbQxfmwPM7V167A,466
-cognite/neat/v0/core/_instances/queries/_select.py,sha256=nVhXGA8oSVNfhXo7p2poM40ATbQ2wXa6TFeJiJl7Nto,19105
+cognite/neat/v0/core/_instances/queries/_select.py,sha256=NYEEGafbb02poVb3vJ9Ov0XQq9f8YRxpfqq1WFc-36Q,20539
 cognite/neat/v0/core/_instances/queries/_update.py,sha256=WJmh0hGoKT4pbbWeED6udFAXiv_qFPd3v9tnZLORcNk,1293
 cognite/neat/v0/core/_instances/transformers/__init__.py,sha256=YzC1Z8BuT77NwagWX4Z-F9R9BARLSS7zM4bCdxBbqKg,1761
 cognite/neat/v0/core/_instances/transformers/_base.py,sha256=a8TVhgYGdt7Mj5-omT6gxOHeGvYnMd9vJCty6p7ctx4,4707
@@ -214,7 +217,7 @@ cognite/neat/v0/session/_inspect.py,sha256=6xC-tLJfP7sbSQpIlpPmCQWklGxK_rEXBE41j
 cognite/neat/v0/session/_mapping.py,sha256=9lQFnB0wpizo4ySIEDMWh183qpHh8TlVL7uOgAtJUxE,2904
 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/_read.py,sha256=jMviC69NLxaGqHFBcqHLNA_XPmIl2vOTTAchTOxR5nw,35288
 cognite/neat/v0/session/_set.py,sha256=qFi3YrYBd09MfHVJ2Ak0PCGigTAhGttfnA2iWSYwUt4,4617
 cognite/neat/v0/session/_show.py,sha256=O6Vcp5BNWfp2hpWuyqsdFhN0WAl29ot-QrC5iKBGe5Y,10758
 cognite/neat/v0/session/_state.py,sha256=2t1DBybamq67CuNZo_a1AQfDfYWnKS-MATFFuJf_h4M,7454
@@ -228,7 +231,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.40.dist-info/METADATA,sha256=922IsoPiMWLcfFWeR64XxhshmVXVHh8iI8HSqODPWrY,9148
-cognite_neat-0.123.40.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-cognite_neat-0.123.40.dist-info/licenses/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
-cognite_neat-0.123.40.dist-info/RECORD,,
+cognite_neat-0.123.42.dist-info/METADATA,sha256=R-A1tkY3opZDSbVVDo2flVy7ZlawJvUISZCllr6i_mM,9148
+cognite_neat-0.123.42.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+cognite_neat-0.123.42.dist-info/licenses/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
+cognite_neat-0.123.42.dist-info/RECORD,,