cognite-neat 0.93.0__py3-none-any.whl → 0.94.0__py3-none-any.whl

cognite/neat/_session/_show.py

@@ -1,11 +1,16 @@
+import random
 from typing import Any, cast
 
 import networkx as nx
 from ipycytoscape import CytoscapeWidget  # type: ignore
 from IPython.display import display
 
+from cognite.neat._rules._constants import EntityTypes
 from cognite.neat._rules.models.dms._rules import DMSRules
-from cognite.neat._rules.models.entities._single_value import ViewEntity
+from cognite.neat._rules.models.entities._single_value import ClassEntity, ViewEntity
+from cognite.neat._rules.models.information._rules import InformationRules
+from cognite.neat._session.exceptions import NeatSessionError
+from cognite.neat._utils.rdf_ import remove_namespace_from_uri
 
 from ._state import SessionState
 
@@ -14,6 +19,119 @@ class ShowAPI:
     def __init__(self, state: SessionState) -> None:
         self._state = state
         self.data_model = ShowDataModelAPI(self._state)
+        self.instances = ShowInstanceAPI(self._state)
+
+
+class ShowInstanceAPI:
+    def __init__(self, state: SessionState) -> None:
+        self._state = state
+
+    def __call__(self) -> Any:
+        if not self._state.store.graph:
+            raise NeatSessionError("No instances available. Try using [bold].read[/bold] to load instances.")
+
+        widget = CytoscapeWidget()
+        widget.layout.height = "700px"
+
+        NxGraph, types = self._generate_instance_di_graph_and_types()
+        widget_style = self._generate_cytoscape_widget_style(types)
+        widget.set_style(widget_style)
+
+        widget.graph.add_graph_from_networkx(NxGraph)
+        print("Max of 100 nodes and edges are displayed, which are randomly selected.")
+
+        return display(widget)
+
+    def _generate_instance_di_graph_and_types(self) -> tuple[nx.DiGraph, set[str]]:
+        query = """
+        SELECT ?s ?p ?o ?ts ?to WHERE {
+            ?s ?p ?o .
+            FILTER(isIRI(?o))  # Example filter to check if ?o is an IRI (object type)
+            FILTER(BOUND(?o))
+            FILTER(?p != rdf:type)
+
+            ?s a ?ts .
+            ?o a ?to .
+        }
+        LIMIT 100
+        """
+
+        NxGraph = nx.DiGraph()
+
+        types = set()
+
+        for (  # type: ignore
+            subject,
+            property_,
+            object,
+            subject_type,
+            object_type,
+        ) in self._state.store.graph.query(query):
+            subject = remove_namespace_from_uri(subject)
+            property_ = remove_namespace_from_uri(property_)
+            object = remove_namespace_from_uri(object)
+            subject_type = remove_namespace_from_uri(subject_type)
+            object_type = remove_namespace_from_uri(object_type)
+
+            NxGraph.add_node(subject, label=subject, type=subject_type)
+            NxGraph.add_node(object, label=object, type=object_type)
+            NxGraph.add_edge(subject, object, label=property_)
+
+            types.add(subject_type)
+            types.add(object_type)
+
+        return NxGraph, types
+
+    def _generate_cytoscape_widget_style(self, types: set[str]) -> list[dict]:
+        widget_style = [
+            {
+                "selector": "edge",
+                "style": {
+                    "width": 1,
+                    "target-arrow-shape": "triangle",
+                    "curve-style": "bezier",
+                    "label": "data(label)",
+                    "font-size": "8px",
+                    "line-color": "black",
+                    "target-arrow-color": "black",
+                },
+            },
+        ]
+
+        colors = self._generate_hex_colors(len(types))
+
+        for i, type_ in enumerate(types):
+            widget_style.append(self._generate_node_cytoscape_style(type_, colors[i]))
+
+        return widget_style
+
+    @staticmethod
+    def _generate_hex_colors(n: int) -> list[str]:
+        """Generate a list of N random HEX color codes."""
+        random.seed(42)  # Set a seed for deterministic behavior
+        hex_colors = []
+        for _ in range(n):
+            color = f"#{random.randint(0, 0xFFFFFF):06x}"
+            hex_colors.append(color)
+        return hex_colors
+
+    @staticmethod
+    def _generate_node_cytoscape_style(type_: str, color: str) -> dict:
+        template = {
+            "css": {
+                "content": "data(label)",
+                "text-valign": "center",
+                "color": "black",
+                "font-size": "10px",
+                "width": "mapData(score, 0, 1, 10, 50)",
+                "height": "mapData(score, 0, 1, 10, 50)",
+            },
+        }
+
+        template["selector"] = f'node[type = "{type_}"]'  # type: ignore
+        template["css"]["background-color"] = color
+
+        return template
 
 
 class ShowDataModelAPI:
@@ -21,50 +139,90 @@ class ShowDataModelAPI:
         self._state = state
 
     def __call__(self) -> Any:
+        if not self._state.last_verified_dms_rules and not self._state.last_verified_information_rules:
+            raise NeatSessionError(
+                "No verified data model available. Try using [bold].verify()[/bold] to verify data model."
+            )
+
         if self._state.last_verified_dms_rules:
-            digraph = self._generate_dms_di_graph()
-            widget = self._generate_widget()
-            widget.graph.add_graph_from_networkx(digraph)
-            return display(widget)
+            NxGraph = self._generate_dms_di_graph()
+        elif self._state.last_verified_information_rules:
+            NxGraph = self._generate_info_di_graph()
+
+        widget = self._generate_widget()
+        widget.graph.add_graph_from_networkx(NxGraph)
+        return display(widget)
 
     def _generate_dms_di_graph(self) -> nx.DiGraph:
         """Generate a DiGraph from the last verified DMS rules."""
-        G = nx.DiGraph()
+        NxGraph = nx.DiGraph()
 
-        nodes, edges = self._generate_dms_rules_nodes_and_edges()
-        G.add_nodes_from(nodes)
-        G.add_edges_from(edges)
-        for node in G.nodes:
-            G.nodes[node]["label"] = node
-
-        return G
+        # Add nodes and edges from Views sheet
+        for view in cast(DMSRules, self._state.last_verified_dms_rules).views:
+            # if possible use human readable label coming from the view name
+            if not NxGraph.has_node(view.view.suffix):
+                NxGraph.add_node(view.view.suffix, label=view.name or view.view.suffix)
 
-    def _generate_dms_rules_nodes_and_edges(self) -> tuple[list[str], list[tuple[str, str, dict]]]:
-        """Generate nodes and edges for the last verified DMS rules for DiGraph."""
+            # add implements as edges
+            if view.implements:
+                for implement in view.implements:
+                    if not NxGraph.has_node(implement.suffix):
+                        NxGraph.add_node(implement.suffix, label=implement.suffix)
 
-        nodes = []
-        edges = []
+                    NxGraph.add_edge(view.view.suffix, implement.suffix, label="implements")
 
+        # Add nodes and edges from Properties sheet
         for prop_ in cast(DMSRules, self._state.last_verified_dms_rules).properties:
-            nodes.append(prop_.view.suffix)
-
             if prop_.connection and isinstance(prop_.value_type, ViewEntity):
+                if not NxGraph.has_node(prop_.view.suffix):
+                    NxGraph.add_node(prop_.view.suffix, label=prop_.view.suffix)
+
                 label = f"{prop_.property_} [{0 if prop_.nullable else 1}..{ '' if prop_.is_list else 1}]"
-                edges.append((prop_.view.suffix, prop_.value_type.suffix, {"label": label}))
+                NxGraph.add_edge(prop_.view.suffix, prop_.value_type.suffix, label=label)
 
-        for view in cast(DMSRules, self._state.last_verified_dms_rules).views:
-            nodes.append(view.view.suffix)
+        return NxGraph
 
-            if view.implements:
-                for implement in view.implements:
-                    edges.append((view.view.suffix, implement.suffix, {"label": "implements"}))
+    def _generate_info_di_graph(self) -> nx.DiGraph:
+        """Generate nodes and edges for the last verified Information rules for DiGraph."""
+
+        NxGraph = nx.DiGraph()
+
+        # Add nodes and edges from Views sheet
+        for class_ in cast(InformationRules, self._state.last_verified_information_rules).classes:
+            # if possible use human readable label coming from the view name
+            if not NxGraph.has_node(class_.class_.suffix):
+                NxGraph.add_node(
+                    class_.class_.suffix,
+                    label=class_.name or class_.class_.suffix,
+                )
+
+            # add implements as edges
+            if class_.parent:
+                for parent in class_.parent:
+                    if not NxGraph.has_node(parent.suffix):
+                        NxGraph.add_node(parent.suffix, label=parent.suffix)
 
-        return nodes, edges
+                    NxGraph.add_edge(class_.class_.suffix, parent.suffix, label="subClassOf")
+
+        # Add nodes and edges from Properties sheet
+        for prop_ in cast(InformationRules, self._state.last_verified_information_rules).properties:
+            if prop_.type_ == EntityTypes.object_property:
+                if not NxGraph.has_node(prop_.class_.suffix):
+                    NxGraph.add_node(prop_.class_.suffix, label=prop_.class_.suffix)
+
+                label = f"{prop_.property_} [{1 if prop_.is_mandatory else 0}..{ '' if prop_.is_list else 1}]"
+                NxGraph.add_edge(
+                    prop_.class_.suffix,
+                    cast(ClassEntity, prop_.value_type).suffix,
+                    label=label,
+                )
+
+        return NxGraph
 
     def _generate_widget(self):
         """Generates an empty a CytoscapeWidget."""
         widget = CytoscapeWidget()
-        widget.layout.height = "500px"
+        widget.layout.height = "700px"
 
         widget.set_style(
             [
@@ -88,6 +246,26 @@ class ShowDataModelAPI:
                         "curve-style": "bezier",
                         "label": "data(label)",
                         "font-size": "8px",
+                        "line-color": "black",
+                        "target-arrow-color": "black",
+                    },
+                },
+                {
+                    "selector": 'edge[label = "subClassOf"]',
+                    "style": {
+                        "line-color": "grey",
+                        "target-arrow-color": "grey",
+                        "line-style": "dashed",
+                        "font-size": "8px",
+                    },
+                },
+                {
+                    "selector": 'edge[label = "implements"]',
+                    "style": {
+                        "line-color": "grey",
+                        "target-arrow-color": "grey",
+                        "line-style": "dashed",
+                        "font-size": "8px",
                     },
                 },
             ]

cognite/neat/_store/_base.py

@@ -3,7 +3,7 @@ import warnings
 from collections.abc import Iterable
 from datetime import datetime, timezone
 from pathlib import Path
-from typing import Any, cast
+from typing import cast
 
 import pandas as pd
 from pandas import Index
@@ -383,6 +383,6 @@ class NeatGraphStore:
             ],
             ignore_index=True,
         )
-        shorter_summary.index = cast(Index[Any], indexes)
+        shorter_summary.index = cast(Index, indexes)
 
         return shorter_summary

cognite/neat/_version.py

@@ -1 +1 @@
-__version__ = "0.93.0"
+__version__ = "0.94.0"

{cognite_neat-0.93.0.dist-info → cognite_neat-0.94.0.dist-info}/METADATA

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

{cognite_neat-0.93.0.dist-info → cognite_neat-0.94.0.dist-info}/RECORD

@@ -215,14 +215,14 @@ cognite/neat/_session/__init__.py,sha256=fxQ5URVlUnmEGYyB8Baw7IDq-uYacqkigbc4b-P
 cognite/neat/_session/_base.py,sha256=9QgOUeizAwG9P7xy5J8zOsRd5cMMkncYgv6PTeWgd_k,3564
 cognite/neat/_session/_prepare.py,sha256=u7dJ4nZqB9j6JWoBx6em9ABKc_PA_yaRQWfiI1n3iks,2484
 cognite/neat/_session/_read.py,sha256=JQyxG1-QyX8fbiUnwVexKzlgWMg9VUeTJvC0uFgAg_U,4401
-cognite/neat/_session/_show.py,sha256=0xzXx8fzM1CWxflWwQK0QYE3KU0ZDJUYL8W5Pg-21b0,3286
+cognite/neat/_session/_show.py,sha256=q1cuqpDRaNS1hCwgvpxk-nR1V3pcYPyQdyRn5zUMGWQ,10217
 cognite/neat/_session/_state.py,sha256=ef7OiCxavk4_asIivENaWrvC3HcXZNV6wGldus55JD0,2488
 cognite/neat/_session/_to.py,sha256=u--yGD2y9JKV-sf34PYsMf-nc9Qs2yibpPsv6IG0CLA,2125
 cognite/neat/_session/_wizard.py,sha256=Rdld2eZ-Q5BYbmAwW8FlfAYebdlw_P6L6V2WSDk-dHI,1306
 cognite/neat/_session/exceptions.py,sha256=qT0Mq3h-0NaDatvyr2D476LkSjmvyZtNmmLXtd1SLVg,1106
 cognite/neat/_shared.py,sha256=RSaHm2eJceTlvb-hMMe4nHgoHdPYDfN3XcxDXo24k3A,1530
 cognite/neat/_store/__init__.py,sha256=G-VG_YwfRt1kuPao07PDJyZ3w_0-eguzLUM13n-Z_RA,64
-cognite/neat/_store/_base.py,sha256=W-xcxfmlAUG-7JKcL2JwUuPG5xA4KugHT2x_FdZXJQY,14215
+cognite/neat/_store/_base.py,sha256=xi9uxV12X5XcGW-fzTEeDfaTM6Rkt-KpGaeyLXqep4Q,14205
 cognite/neat/_store/_provenance.py,sha256=mD14UnETX6YkR8RO60Oxz7vBPm2Dm8m2xwthhLIxqSc,4122
 cognite/neat/_utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cognite/neat/_utils/auth.py,sha256=hyDnVBUbbgVANzayxbh9uTWlYb924hmzPYkVwwLfDIg,13241
@@ -240,7 +240,7 @@ cognite/neat/_utils/text.py,sha256=PvTEsEjaTu8SE8yYaKUrce4msboMj933dK7-0Eey_rE,3
 cognite/neat/_utils/time_.py,sha256=O30LUiDH9TdOYz8_a9pFqTtJdg8vEjC3qHCk8xZblG8,345
 cognite/neat/_utils/upload.py,sha256=X5GGWHswnW0BrL2ulmm5MnKKtn-t1C8Ps3gb9Byc914,4016
 cognite/neat/_utils/xml_.py,sha256=FQkq84u35MUsnKcL6nTMJ9ajtG9D5i1u4VBnhGqP2DQ,1710
-cognite/neat/_version.py,sha256=W-KEJT0wpRrG8XJ2aDG4NSyzaUucgZR9y6mwfCTlku4,23
+cognite/neat/_version.py,sha256=BbCpQB0IaKmq_fOtysTb_iVtvqbH-vHS1DoS1eLd4w8,23
 cognite/neat/_workflows/__init__.py,sha256=S0fZq7kvoqDKodHu1UIPsqcpdvXoefUWRPt1lqeQkQs,420
 cognite/neat/_workflows/base.py,sha256=O1pcmfbme2gIVF2eOGrKZSUDmhZc8L9rI8UfvLN2YAM,26839
 cognite/neat/_workflows/cdf_store.py,sha256=3pebnATPo6In4-1srpa3wzstynTOi3T6hwFX5uaie4c,18050
@@ -269,8 +269,8 @@ cognite/neat/_workflows/tasks.py,sha256=dr2xuIb8P5e5e9p_fjzRlvDbKsre2xGYrkc3wnRx
 cognite/neat/_workflows/triggers.py,sha256=u69xOsaTtM8_WD6ZeIIBB-XKwvlZmPHAsZQh_TnyHcM,7073
 cognite/neat/_workflows/utils.py,sha256=gKdy3RLG7ctRhbCRwaDIWpL9Mi98zm56-d4jfHDqP1E,453
 cognite/neat/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cognite_neat-0.93.0.dist-info/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
-cognite_neat-0.93.0.dist-info/METADATA,sha256=7LtcqYVhejVdcOylDNH0joitMI2PEGd-Dn6JJkKVDuQ,9668
-cognite_neat-0.93.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-cognite_neat-0.93.0.dist-info/entry_points.txt,sha256=SsQlnl8SNMSSjE3acBI835JYFtsIinLSbVmHmMEXv6E,51
-cognite_neat-0.93.0.dist-info/RECORD,,
+cognite_neat-0.94.0.dist-info/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
+cognite_neat-0.94.0.dist-info/METADATA,sha256=aKSpijqnnPjjnO0NTC98tdm4YBbP67wwGz8tM_DSnus,9668
+cognite_neat-0.94.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+cognite_neat-0.94.0.dist-info/entry_points.txt,sha256=SsQlnl8SNMSSjE3acBI835JYFtsIinLSbVmHmMEXv6E,51
+cognite_neat-0.94.0.dist-info/RECORD,,