cognite-neat 0.81.5__tar.gz → 0.81.8__tar.gz

{cognite_neat-0.81.5 → cognite_neat-0.81.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cognite-neat
-Version: 0.81.5
+Version: 0.81.8
 Summary: Knowledge graph transformation
 Home-page: https://cognite-neat.readthedocs-hosted.com/
 License: Apache-2.0

cognite_neat-0.81.8/cognite/neat/_version.py

@@ -0,0 +1 @@
+__version__ = "0.81.8"

{cognite_neat-0.81.5 → cognite_neat-0.81.8}/cognite/neat/graph/stores/_base.py

@@ -9,9 +9,11 @@ from rdflib import RDF, Graph, Namespace, URIRef
 from rdflib.plugins.stores.sparqlstore import SPARQLUpdateStore
 from rdflib.query import ResultRow
 
+from cognite.neat.constants import DEFAULT_NAMESPACE
 from cognite.neat.graph._shared import MIMETypes
 from cognite.neat.graph.extractors import RdfFileExtractor, TripleExtractors
 from cognite.neat.graph.models import Triple
+from cognite.neat.graph.transformers import Transformers
 from cognite.neat.rules.models.information import InformationRules
 from cognite.neat.utils import remove_namespace
 from cognite.neat.utils.auxiliary import local_import
@@ -56,6 +58,9 @@ class NeatGraphStore:
 
         if self.rules and self.rules.prefixes:
             self._upsert_prefixes(self.rules.prefixes)
+            self.base_namespace = self.rules.metadata.namespace
+        else:
+            self.base_namespace = DEFAULT_NAMESPACE
 
         self.queries = _Queries(self)
 
@@ -206,6 +211,38 @@ class NeatGraphStore:
 
         check_commit(force_commit=True)
 
+    def transform(self, transformer: Transformers) -> None:
+        """Transforms the graph store using a transformer."""
+
+        missing_changes = [
+            change for change in transformer._need_changes if not self.provenance.activity_took_place(change)
+        ]
+        if self.provenance.activity_took_place(type(transformer).__name__) and transformer._use_only_once:
+            warnings.warn(
+                f"Cannot transform graph store with {type(transformer).__name__}, already applied",
+                stacklevel=2,
+            )
+        elif missing_changes:
+            warnings.warn(
+                (
+                    f"Cannot transform graph store with {type(transformer).__name__}, "
+                    f"missing one or more required changes [{', '.join(missing_changes)}]"
+                ),
+                stacklevel=2,
+            )
+
+        else:
+            _start = datetime.now(timezone.utc)
+            transformer.transform(self.graph)
+            self.provenance.append(
+                Change.record(
+                    activity=f"{type(transformer).__name__}",
+                    start=_start,
+                    end=datetime.now(timezone.utc),
+                    description=transformer.description,
+                )
+            )
+
 
 class _Queries:
     """Helper class for storing standard queries for the graph store."""

{cognite_neat-0.81.5 → cognite_neat-0.81.8}/cognite/neat/graph/stores/_provenance.py

@@ -89,8 +89,8 @@ class Provenance(UserList[T_Change]):
     def __init__(self, changes: Sequence[T_Change] | None = None):
         super().__init__(changes or [])
 
-    def did_this_happen(self, this: str) -> bool:
-        return any(change.description == this for change in self)
+    def activity_took_place(self, activity: str) -> bool:
+        return any(change.activity.used == activity for change in self)
 
     def __delitem__(self, *args, **kwargs):
         raise TypeError("Cannot delete change from provenance")

cognite_neat-0.81.8/cognite/neat/graph/transformers/__init__.py

@@ -0,0 +1,5 @@
+from ._classic_cdf import AddAssetDepth, AssetSequenceConnector, AssetTimeSeriesConnector
+
+__all__ = ["AddAssetDepth", "AssetTimeSeriesConnector", "AssetSequenceConnector"]
+
+Transformers = AddAssetDepth | AssetTimeSeriesConnector | AssetSequenceConnector

cognite_neat-0.81.8/cognite/neat/graph/transformers/_base.py

@@ -0,0 +1,14 @@
+from abc import ABC, abstractmethod
+from typing import ClassVar
+
+from rdflib import Graph
+
+
+class BaseTransformer(ABC):
+    description: str
+    _use_only_once: bool
+    _need_changes: ClassVar[frozenset[str]] = frozenset()
+
+    @abstractmethod
+    def transform(self, graph: Graph) -> None:
+        raise NotImplementedError()

cognite_neat-0.81.8/cognite/neat/graph/transformers/_classic_cdf.py

@@ -0,0 +1,135 @@
+from typing import cast
+
+from rdflib import Graph, Literal, URIRef
+
+from cognite.neat.constants import DEFAULT_NAMESPACE
+from cognite.neat.graph import extractors
+
+from ._base import BaseTransformer
+
+
+class AddAssetDepth(BaseTransformer):
+    description: str = "Adds depth of asset in the asset hierarchy to the graph"
+    _use_only_once: bool = True
+    _need_changes = frozenset({str(extractors.AssetsExtractor.__name__)})
+
+    _parent_template: str = """SELECT ?child ?parent WHERE {{
+                              <{asset_id}> <{parent_prop}> ?child .
+                              OPTIONAL{{?child <{parent_prop}>+ ?parent .}}}}"""
+
+    _root_template: str = """SELECT ?root WHERE {{
+                             <{asset_id}> <{root_prop}> ?root .}}"""
+
+    def __init__(
+        self, asset_type: URIRef | None = None, root_prop: URIRef | None = None, parent_prop: URIRef | None = None
+    ):
+        self.asset_type = asset_type or DEFAULT_NAMESPACE.Asset
+        self.root_prop = root_prop or DEFAULT_NAMESPACE.root
+        self.parent_prop = parent_prop or DEFAULT_NAMESPACE.parent
+
+    def transform(self, graph: Graph) -> None:
+        """Adds depth of asset in the asset hierarchy to the graph."""
+        for result in graph.query(f"SELECT DISTINCT ?asset_id WHERE {{?asset_id a <{self.asset_type}>}}"):
+            asset_id = cast(tuple, result)[0]
+            if depth := self.get_depth(graph, asset_id, self.root_prop, self.parent_prop):
+                graph.add((asset_id, DEFAULT_NAMESPACE.depth, Literal(depth)))
+
+    @classmethod
+    def get_depth(
+        cls,
+        graph: Graph,
+        asset_id: URIRef,
+        root_prop: URIRef,
+        parent_prop: URIRef,
+    ) -> int | None:
+        """Get asset depth in the asset hierarchy."""
+
+        # Handles non-root assets
+        if result := list(graph.query(cls._parent_template.format(asset_id=asset_id, parent_prop=parent_prop))):
+            return len(cast(list[tuple], result)) + 2 if cast(list[tuple], result)[0][1] else 2
+
+        # Handles root assets
+        elif (
+            (result := list(graph.query(cls._root_template.format(asset_id=asset_id, root_prop=root_prop))))
+            and len(cast(list[tuple], result)) == 1
+            and cast(list[tuple], result)[0][0] == asset_id
+        ):
+            return 1
+        else:
+            return None
+
+
+class AssetTimeSeriesConnector(BaseTransformer):
+    description: str = "Connects assets to timeseries, thus forming bi-directional connection"
+    _use_only_once: bool = True
+    _need_changes = frozenset({str(extractors.AssetsExtractor.__name__), str(extractors.TimeSeriesExtractor.__name__)})
+    _asset_template: str = """SELECT ?asset_id WHERE {{
+                              <{timeseries_id}> <{asset_prop}> ?asset_id .
+                              ?asset_id a <{asset_type}>}}"""
+
+    def __init__(
+        self,
+        asset_type: URIRef | None = None,
+        timeseries_type: URIRef | None = None,
+        asset_prop: URIRef | None = None,
+    ):
+        self.asset_type = asset_type or DEFAULT_NAMESPACE.Asset
+        self.timeseries_type = timeseries_type or DEFAULT_NAMESPACE.TimeSeries
+        self.asset_prop = asset_prop or DEFAULT_NAMESPACE.asset
+
+    def transform(self, graph: Graph) -> None:
+        for ts_id_result in graph.query(
+            f"SELECT DISTINCT ?timeseries_id WHERE {{?timeseries_id a <{self.timeseries_type}>}}"
+        ):
+            timeseries_id: URIRef = cast(tuple, ts_id_result)[0]
+
+            if asset_id_res := list(
+                graph.query(
+                    self._asset_template.format(
+                        timeseries_id=timeseries_id,
+                        asset_prop=self.asset_prop,
+                        asset_type=self.asset_type,
+                    )
+                )
+            ):
+                # timeseries can be connected to only one asset in the graph
+                asset_id = cast(list[tuple], asset_id_res)[0][0]
+                graph.add((asset_id, DEFAULT_NAMESPACE.timeSeries, timeseries_id))
+
+
+class AssetSequenceConnector(BaseTransformer):
+    description: str = "Connects assets to sequences, thus forming bi-directional connection"
+    _use_only_once: bool = True
+    _need_changes = frozenset({str(extractors.AssetsExtractor.__name__), str(extractors.SequencesExtractor.__name__)})
+    _asset_template: str = """SELECT ?asset_id WHERE {{
+                              <{sequence_id}> <{asset_prop}> ?asset_id .
+                              ?asset_id a <{asset_type}>}}"""
+
+    def __init__(
+        self,
+        asset_type: URIRef | None = None,
+        sequence_type: URIRef | None = None,
+        asset_prop: URIRef | None = None,
+    ):
+        self.asset_type = asset_type or DEFAULT_NAMESPACE.Asset
+        self.sequence_type = sequence_type or DEFAULT_NAMESPACE.Sequence
+        self.asset_prop = asset_prop or DEFAULT_NAMESPACE.asset
+
+    def transform(self, graph: Graph) -> None:
+        for sequency_id_result in graph.query(
+            f"SELECT DISTINCT ?sequence_id WHERE {{?sequence_id a <{self.sequence_type}>}}"
+        ):
+            sequence_id: URIRef = cast(tuple, sequency_id_result)[0]
+
+            if asset_id_res := list(
+                graph.query(
+                    self._asset_template.format(
+                        sequence_id=sequence_id,
+                        asset_prop=self.asset_prop,
+                        asset_type=self.asset_type,
+                    )
+                )
+            ):
+                # sequence can be connected to only one asset in the graph
+                asset_id = cast(list[tuple], asset_id_res)[0][0]
+                graph.add((asset_id, DEFAULT_NAMESPACE.sequence, sequence_id))

{cognite_neat-0.81.5 → cognite_neat-0.81.8}/pyproject.toml

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

cognite_neat-0.81.5/cognite/neat/_version.py

@@ -1 +0,0 @@
-__version__ = "0.81.5"