cognite-neat 0.116.1__tar.gz → 0.117.1__tar.gz

{cognite_neat-0.116.1 → cognite_neat-0.117.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: cognite-neat
-Version: 0.116.1
+Version: 0.117.1
 Summary: Knowledge graph transformation
 License: Apache-2.0
 Author: Nikola Vasiljevic

{cognite_neat-0.116.1 → cognite_neat-0.117.1}/cognite/neat/_graph/extractors/_dms.py

@@ -1,12 +1,12 @@
+import typing
 import urllib.parse
-from collections.abc import Iterable, Iterator, Set
+from collections.abc import Callable, Iterable, Iterator, Set
 from functools import cached_property
-from typing import cast
 
 from cognite.client import CogniteClient
 from cognite.client import data_modeling as dm
 from cognite.client.data_classes.data_modeling import DataModelIdentifier
-from cognite.client.data_classes.data_modeling.instances import Instance, InstanceSort
+from cognite.client.data_classes.data_modeling.instances import Edge, Instance, InstanceSort, Node
 from cognite.client.utils.useful_types import SequenceNotStr
 from rdflib import RDF, Literal, Namespace, URIRef
 
@@ -33,6 +33,10 @@ class DMSExtractor(BaseExtractor):
             considered as an empty value and skipped.
         str_to_ideal_type: If unpack_json is True, when unpacking JSON objects, if the value is a string, the extractor
             will try to convert it to the ideal type.
+        node_type: The prioritized order of the node type to use. The options are "view" and "type". "view"
+            means the externalId of the view used as type, while type is the node.type.
+        edge_type: The prioritized order of the edge type to use. The options are "view" and "type". "view"
+            means the externalId of the view used as type, while type is the edge.type.
     """
 
     def __init__(
@@ -43,6 +47,8 @@ class DMSExtractor(BaseExtractor):
         unpack_json: bool = False,
         empty_values: Set[str] = DEFAULT_EMPTY_VALUES,
         str_to_ideal_type: bool = False,
+        node_type: tuple[typing.Literal["view", "type"], ...] = ("view",),
+        edge_type: tuple[typing.Literal["view", "type"], ...] = ("view", "type"),
     ) -> None:
         self.total_instances_pair_by_view = total_instances_pair_by_view
         self.limit = limit
@@ -50,6 +56,8 @@ class DMSExtractor(BaseExtractor):
         self.unpack_json = unpack_json
         self.empty_values = empty_values
         self.str_to_ideal_type = str_to_ideal_type
+        self.node_type = node_type
+        self.edge_type = edge_type
 
     @classmethod
     def from_data_model(
@@ -154,7 +162,10 @@ class DMSExtractor(BaseExtractor):
             else:
                 # If the edge has properties, we create a node for the edge and connect it to the start and end nodes.
                 id_ = self._as_uri_ref(instance)
-                yield id_, RDF.type, self._as_uri_ref(instance.type)
+                type_ = self._create_type(
+                    instance, fallback=self._get_namespace(instance.space).Edge, type_priority=self.edge_type
+                )
+                yield id_, RDF.type, type_
                 yield (
                     id_,
                     self._as_uri_ref(dm.DirectRelationReference(instance.space, "startNode")),
@@ -168,14 +179,9 @@ class DMSExtractor(BaseExtractor):
 
         elif isinstance(instance, dm.Node):
             id_ = self._as_uri_ref(instance)
-            if instance.type:
-                type_ = self._as_uri_ref(cast(dm.DirectRelationReference, instance.type))
-            elif len(instance.properties) == 1:
-                view_id = next(iter(instance.properties.keys()))
-                type_ = self._get_namespace(view_id.space)[urllib.parse.quote(view_id.external_id)]
-            else:
-                type_ = self._get_namespace(instance.space).Node
-
+            type_ = self._create_type(
+                instance, fallback=self._get_namespace(instance.space).Node, type_priority=self.node_type
+            )
             yield id_, RDF.type, type_
         else:
             raise NotImplementedError(f"Unknown instance type {type(instance)}")
@@ -196,6 +202,31 @@ class DMSExtractor(BaseExtractor):
                 self.unpack_json,
             ).extract()
 
+    def _create_type(
+        self, instance: Node | Edge, fallback: URIRef, type_priority: tuple[typing.Literal["view", "type"], ...]
+    ) -> URIRef:
+        method_by_name: dict[str, Callable[[Node | Edge], URIRef | None]] = {
+            "view": self._view_to_rdf_type,
+            "type": self._instance_type_to_rdf,
+        }
+        for method_name in type_priority:
+            type_ = method_by_name[method_name](instance)
+            if type_:
+                return type_
+        else:
+            return fallback
+
+    def _instance_type_to_rdf(self, instance: Node | Edge) -> URIRef | None:
+        if instance.type:
+            return self._as_uri_ref(instance.type)
+        return None
+
+    def _view_to_rdf_type(self, instance: Node | Edge) -> URIRef | None:
+        view_id = next(iter((instance.properties or {}).keys()), None)
+        if view_id:
+            return self._get_namespace(view_id.space)[urllib.parse.quote(view_id.external_id)]
+        return None
+
     def _as_uri_ref(self, instance: Instance | dm.DirectRelationReference) -> URIRef:
         return self._get_namespace(instance.space)[urllib.parse.quote(instance.external_id)]
 

{cognite_neat-0.116.1 → cognite_neat-0.117.1}/cognite/neat/_session/_base.py

@@ -23,7 +23,6 @@ from cognite.neat._store._rules_store import RulesEntity
 from cognite.neat._utils.auxiliary import local_import
 
 from ._collector import _COLLECTOR, Collector
-from ._create import CreateAPI
 from ._drop import DropAPI
 from ._explore import ExploreAPI
 from ._fix import FixAPI
@@ -35,6 +34,7 @@ from ._set import SetAPI
 from ._show import ShowAPI
 from ._state import SessionState
 from ._subset import SubsetAPI
+from ._template import TemplateAPI
 from ._to import ToAPI
 from .engine import load_neat_engine
 from .exceptions import session_class_wrapper
@@ -104,7 +104,7 @@ class NeatSession:
         self.mapping = MappingAPI(self._state)
         self.drop = DropAPI(self._state)
         self.subset = SubsetAPI(self._state)
-        self.create = CreateAPI(self._state)
+        self.template = TemplateAPI(self._state)
         self._explore = ExploreAPI(self._state)
         self.opt = OptAPI()
         self.opt._display()

cognite_neat-0.116.1/cognite/neat/_session/_create.py → cognite_neat-0.117.1/cognite/neat/_session/_template.py

@@ -17,9 +17,9 @@ from .exceptions import NeatSessionError, session_class_wrapper
 
 
 @session_class_wrapper
-class CreateAPI:
+class TemplateAPI:
     """
-    Create new data model based on the given data.
+    Create a template for a new data model.
     """
 
     def __init__(self, state: SessionState):
@@ -31,7 +31,10 @@ class CreateAPI:
         org_name: str = "CopyOf",
         dummy_property: str = "GUID",
     ) -> IssueList:
-        """Uses the current data model as a basis to create enterprise data model
+        """Creates a template for an enterprise model based on the current data model in the session.
+        An enterprise data model is a model that is used for read and write of instances. In addition,
+        it is governed by the organization.
+        The basis for an enterprise data model should be a Cognite Data Model.
 
         Args:
             data_model_id: The enterprise data model id that is being created
@@ -76,7 +79,9 @@ class CreateAPI:
         direct_property: str = "enterprise",
         view_prefix: str = "Enterprise",
     ) -> IssueList:
-        """Uses the current data model as a basis to create solution data model
+        """Creates a template for a solution model based on the current data model in the session.
+        A solution data model is for read and write of instances.
+        The basis for a solution data model should be an enterprise data model.
 
         Args:
             data_model_id: The solution data model id that is being created.
@@ -121,7 +126,9 @@ class CreateAPI:
         data_model_id: DataModelIdentifier,
         include: Literal["same-space", "all"] = "same-space",
     ) -> IssueList:
-        """Uses the current data model as a basis to create data product data model.
+        """Creates a template for a data product model based on the current data model in the session.
+        A data product model is only used for reading of instances.
+        It can be based on any data model, but typically it is based on an enterprise or solution data model.
 
         A data product model is a data model that ONLY maps to containers and do not use implements. This is
         typically used for defining the data in a data product.

cognite_neat-0.117.1/cognite/neat/_version.py

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

{cognite_neat-0.116.1 → cognite_neat-0.117.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cognite-neat"
-version = "0.116.1"
+version = "0.117.1"
 readme = "README.md"
 description = "Knowledge graph transformation"
 authors = [

cognite_neat-0.116.1/cognite/neat/_version.py

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