cognite-neat 0.85.9__tar.gz → 0.85.11__tar.gz

{cognite_neat-0.85.9 → cognite_neat-0.85.11}/PKG-INFO

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

cognite_neat-0.85.11/cognite/neat/_version.py

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

{cognite_neat-0.85.9 → cognite_neat-0.85.11}/cognite/neat/graph/queries/_base.py

@@ -2,6 +2,7 @@ import warnings
 from typing import Literal, cast, overload
 
 from rdflib import RDF, Graph, URIRef
+from rdflib import Literal as RdfLiteral
 from rdflib.query import ResultRow
 
 from cognite.neat.rules.models.entities import ClassEntity
@@ -18,6 +19,24 @@ class Queries:
         self.graph = graph
         self.rules = rules
 
+    def summarize_instances(self) -> list[tuple]:
+        """Summarize instances in the graph store by class and count"""
+
+        query_statement = """ SELECT ?class (COUNT(?instance) AS ?instanceCount)
+                             WHERE {
+                             ?instance a ?class .
+                             }
+                             GROUP BY ?class
+                             ORDER BY DESC(?instanceCount) """
+
+        return [
+            (
+                remove_namespace_from_uri(cast(URIRef, cast(tuple, res)[0])),
+                cast(RdfLiteral, cast(tuple, res)[1]).value,
+            )
+            for res in list(self.graph.query(query_statement))
+        ]
+
     def list_instances_ids_of_class(self, class_uri: URIRef, limit: int = -1) -> list[URIRef]:
         """Get instances ids for a given class
 
@@ -68,7 +87,10 @@ class Queries:
             # We cannot include the RDF.type in case there is a neat:type property
             return [remove_namespace_from_uri(*triple) for triple in result if triple[1] != RDF.type]  # type: ignore[misc, index]
         else:
-            warnings.warn("No rules found for the graph store, returning empty list.", stacklevel=2)
+            warnings.warn(
+                "No rules found for the graph store, returning empty list.",
+                stacklevel=2,
+            )
             return []
 
     def construct_instances_of_class(self, class_: str, properties_optional: bool = True) -> list[tuple[str, str, str]]:
@@ -95,7 +117,10 @@ class Queries:
             # We cannot include the RDF.type in case there is a neat:type property
             return [remove_namespace_from_uri(*triple) for triple in result if triple[1] != RDF.type]  # type: ignore[misc, index]
         else:
-            warnings.warn("No rules found for the graph store, returning empty list.", stacklevel=2)
+            warnings.warn(
+                "No rules found for the graph store, returning empty list.",
+                stacklevel=2,
+            )
             return []
 
     def list_triples(self, limit: int = 25) -> list[ResultRow]:

{cognite_neat-0.85.9 → cognite_neat-0.85.11}/cognite/neat/graph/stores/_base.py

@@ -5,6 +5,7 @@ from datetime import datetime, timezone
 from pathlib import Path
 from typing import cast
 
+import pandas as pd
 from rdflib import Graph, Namespace, URIRef
 from rdflib.plugins.stores.sparqlstore import SPARQLUpdateStore
 
@@ -283,12 +284,23 @@ class NeatGraphStore:
                 )
             )
 
+    @property
+    def summary(self) -> pd.DataFrame:
+        return pd.DataFrame(self.queries.summarize_instances(), columns=["Type", "Occurrence"])
+
     def _repr_html_(self) -> str:
         provenance = self.provenance._repr_html_()
+        summary: pd.DataFrame = self.summary
+        summary_text = (
+            "<br /><strong>Graph is empty</strong><br />"
+            if summary.empty
+            else f"<br /><strong>Graph content</strong><br />{cast(pd.DataFrame, summary)._repr_html_()}"  # type: ignore[operator]
+        )
 
         return (
             f"<strong>{type(self).__name__}</strong> A graph store is a container for storing triples. "
             "It can be queried and transformed to extract information.<br />"
             "<strong>Provenance</strong> Provenance is a record of changes that have occurred in the graph store.<br />"
             f"{provenance}"
+            f"{summary_text}"
         )

{cognite_neat-0.85.9 → cognite_neat-0.85.11}/cognite/neat/graph/transformers/_classic_cdf.py

@@ -1,6 +1,6 @@
 from typing import cast
 
-from rdflib import Graph, Literal, URIRef
+from rdflib import RDF, Graph, Literal, URIRef
 
 from cognite.neat.constants import DEFAULT_NAMESPACE
 from cognite.neat.graph import extractors
@@ -21,11 +21,16 @@ class AddAssetDepth(BaseTransformer):
                              <{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: URIRef | None = None,
+        root_prop: URIRef | None = None,
+        parent_prop: URIRef | None = None,
+        depth_typing: dict[int, str] | 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
+        self.depth_typing = depth_typing
 
     def transform(self, graph: Graph) -> None:
         """Adds depth of asset in the asset hierarchy to the graph."""
@@ -34,6 +39,13 @@ class AddAssetDepth(BaseTransformer):
             if depth := self.get_depth(graph, asset_id, self.root_prop, self.parent_prop):
                 graph.add((asset_id, DEFAULT_NAMESPACE.depth, Literal(depth)))
 
+                if self.depth_typing and (type_ := self.depth_typing.get(depth, None)):
+                    # remove existing type
+                    graph.remove((asset_id, RDF.type, None))
+
+                    # add new type
+                    graph.add((asset_id, RDF.type, DEFAULT_NAMESPACE[type_]))
+
     @classmethod
     def get_depth(
         cls,
@@ -62,7 +74,12 @@ class AddAssetDepth(BaseTransformer):
 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__)})
+    _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}>}}"""
@@ -100,7 +117,12 @@ class AssetTimeSeriesConnector(BaseTransformer):
 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__)})
+    _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}>}}"""
@@ -138,7 +160,12 @@ class AssetSequenceConnector(BaseTransformer):
 class AssetFileConnector(BaseTransformer):
     description: str = "Connects assets to files, thus forming bi-directional connection"
     _use_only_once: bool = True
-    _need_changes = frozenset({str(extractors.AssetsExtractor.__name__), str(extractors.FilesExtractor.__name__)})
+    _need_changes = frozenset(
+        {
+            str(extractors.AssetsExtractor.__name__),
+            str(extractors.FilesExtractor.__name__),
+        }
+    )
     _asset_template: str = """SELECT ?asset_id WHERE {{
                               <{file_id}> <{asset_prop}> ?asset_id .
                               ?asset_id a <{asset_type}>}}"""
@@ -174,7 +201,12 @@ class AssetFileConnector(BaseTransformer):
 class AssetEventConnector(BaseTransformer):
     description: str = "Connects assets to events, thus forming bi-directional connection"
     _use_only_once: bool = True
-    _need_changes = frozenset({str(extractors.AssetsExtractor.__name__), str(extractors.EventsExtractor.__name__)})
+    _need_changes = frozenset(
+        {
+            str(extractors.AssetsExtractor.__name__),
+            str(extractors.EventsExtractor.__name__),
+        }
+    )
     _asset_template: str = """SELECT ?asset_id WHERE {{
                               <{event_id}> <{asset_prop}> ?asset_id .
                               ?asset_id a <{asset_type}>}}"""
@@ -211,7 +243,10 @@ class AssetRelationshipConnector(BaseTransformer):
     description: str = "Connects assets via relationships"
     _use_only_once: bool = True
     _need_changes = frozenset(
-        {str(extractors.AssetsExtractor.__name__), str(extractors.RelationshipsExtractor.__name__)}
+        {
+            str(extractors.AssetsExtractor.__name__),
+            str(extractors.RelationshipsExtractor.__name__),
+        }
     )
     _asset_template: str = """SELECT ?source ?target WHERE {{
                               <{relationship_id}> <{relationship_source_xid_prop}> ?source_xid .
@@ -256,8 +291,20 @@ class AssetRelationshipConnector(BaseTransformer):
                 # files can be connected to multiple assets in the graph
                 for source_asset_id, target_asset_id in cast(list[tuple], assets_id_res):
                     # create a relationship between the two assets
-                    graph.add((source_asset_id, DEFAULT_NAMESPACE.relationship, relationship_id))
-                    graph.add((target_asset_id, DEFAULT_NAMESPACE.relationship, relationship_id))
+                    graph.add(
+                        (
+                            source_asset_id,
+                            DEFAULT_NAMESPACE.relationship,
+                            relationship_id,
+                        )
+                    )
+                    graph.add(
+                        (
+                            target_asset_id,
+                            DEFAULT_NAMESPACE.relationship,
+                            relationship_id,
+                        )
+                    )
 
                     # add source and target to the relationship
                     graph.add((relationship_id, DEFAULT_NAMESPACE.source, source_asset_id))

{cognite_neat-0.85.9 → cognite_neat-0.85.11}/cognite/neat/rules/models/dms/_rules.py

@@ -2,6 +2,7 @@ import math
 import re
 import sys
 import warnings
+from collections import defaultdict
 from datetime import datetime
 from typing import TYPE_CHECKING, Any, ClassVar, Literal
 
@@ -390,3 +391,72 @@ class DMSRules(BaseRules):
         from ._converter import _DMSRulesConverter
 
         return _DMSRulesConverter(self).as_domain_rules()
+
+    def create_reference(
+        self, reference: "DMSRules", view_extension_mapping: dict[str, str], default_extension: str | None = None
+    ) -> None:
+        """Takes this data models and makes it into an extension of the reference data model.
+
+        The argument view_extension_mapping is a dictionary where the keys are views of this data model,
+        and each value is the view of the reference data model that the view should extend. For example:
+
+        ```python
+        view_extension_mapping = {"Pump": "Asset"}
+        ```
+
+        This would make the view "Pump" in this data model extend the view "Asset" in the reference data model.
+        Note that all the keys in the dictionary must be external ids of views in this data model,
+        and all the values must be external ids of views in the reference data model.
+
+        Args:
+            reference: The reference data model
+            view_extension_mapping: A dictionary mapping views in this data model to views in the reference data model
+            default_extension: The default view in the reference data model that views in this
+                data model should extend if no mapping is provided.
+
+        """
+        if self.reference is not None:
+            raise ValueError("Reference already exists")
+        self.reference = reference
+        view_by_external_id = {view.view.external_id: view for view in self.views}
+        ref_view_by_external_id = {view.view.external_id: view for view in reference.views}
+
+        if invalid_views := set(view_extension_mapping.keys()) - set(view_by_external_id.keys()):
+            raise ValueError(f"Views are not in this dat model {invalid_views}")
+        if invalid_views := set(view_extension_mapping.values()) - set(ref_view_by_external_id.keys()):
+            raise ValueError(f"Views are not in the reference data model {invalid_views}")
+        if default_extension and default_extension not in ref_view_by_external_id:
+            raise ValueError(f"Default extension view not in the reference data model {default_extension}")
+
+        properties_by_view_external_id: dict[str, dict[str, DMSProperty]] = defaultdict(dict)
+        for prop in self.properties:
+            properties_by_view_external_id[prop.view.external_id][prop.view_property] = prop
+
+        ref_properties_by_view_external_id: dict[str, dict[str, DMSProperty]] = defaultdict(dict)
+        for prop in reference.properties:
+            ref_properties_by_view_external_id[prop.view.external_id][prop.view_property] = prop
+
+        for view_external_id, view in view_by_external_id.items():
+            if view_external_id in view_extension_mapping:
+                ref_external_id = view_extension_mapping[view_external_id]
+            elif default_extension:
+                ref_external_id = default_extension
+            else:
+                continue
+
+            ref_view = ref_view_by_external_id[ref_external_id]
+            shared_properties = set(properties_by_view_external_id[view_external_id].keys()) & set(
+                ref_properties_by_view_external_id[ref_external_id].keys()
+            )
+            if shared_properties:
+                if view.implements is None:
+                    view.implements = [ref_view.view]
+                elif isinstance(view.implements, list) and ref_view.view not in view.implements:
+                    view.implements.append(ref_view.view)
+            for prop_name in shared_properties:
+                prop = properties_by_view_external_id[view_external_id][prop_name]
+                ref_prop = ref_properties_by_view_external_id[ref_external_id][prop_name]
+                if ref_prop.container and ref_prop.container_property:
+                    prop.container = ref_prop.container
+                    prop.container_property = ref_prop.container_property
+                prop.reference = ReferenceEntity.from_entity(ref_prop.view, ref_prop.view_property)

{cognite_neat-0.85.9 → cognite_neat-0.85.11}/cognite/neat/rules/models/dms/_rules_input.py

@@ -146,7 +146,9 @@ class DMSPropertyInput:
             "Value Type": value_type,
             "Property (linage)": self.property_ or self.view_property,
             "Class (linage)": (
-                ClassEntity.load(self.class_, prefix=default_space, version=default_version) if self.class_ else None
+                ClassEntity.load(self.class_ or self.view, prefix=default_space, version=default_version)
+                if self.class_ or self.view
+                else None
             ),
             "Name": self.name,
             "Description": self.description,

{cognite_neat-0.85.9 → cognite_neat-0.85.11}/cognite/neat/rules/models/entities.py

@@ -499,6 +499,13 @@ class ReferenceEntity(ClassEntity):
     prefix: str
     property_: str | None = Field(None, alias="property")
 
+    @classmethod
+    def from_entity(cls, entity: Entity, property_: str) -> "ReferenceEntity":
+        if isinstance(entity, ClassEntity):
+            return cls(prefix=str(entity.prefix), suffix=entity.suffix, version=entity.version, property=property_)
+        else:
+            return cls(prefix=str(entity.prefix), suffix=entity.suffix, property=property_)
+
     def as_view_id(self) -> ViewId:
         if isinstance(self.prefix, _UndefinedType) or isinstance(self.suffix, _UnknownType):
             raise ValueError("Prefix is not defined or suffix is unknown")

{cognite_neat-0.85.9 → cognite_neat-0.85.11}/pyproject.toml

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

cognite_neat-0.85.9/cognite/neat/_version.py

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