cognite-neat 1.0.21__tar.gz → 1.0.22__tar.gz

{cognite_neat-1.0.21 → cognite_neat-1.0.22}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cognite-neat
-Version: 1.0.21
+Version: 1.0.22
 Summary: Knowledge graph transformation
 Author: Nikola Vasiljevic, Anders Albert
 Author-email: Nikola Vasiljevic <nikola.vasiljevic@cognite.com>, Anders Albert <anders.albert@cognite.com>

{cognite_neat-1.0.21 → cognite_neat-1.0.22}/cognite/neat/_data_model/_analysis.py

@@ -23,7 +23,7 @@ from cognite.neat._data_model.models.dms._view_property import (
     ViewRequestProperty,
 )
 from cognite.neat._data_model.models.dms._views import ViewRequest
-from cognite.neat._utils.useful_types import ModusOperandi
+from cognite.neat._utils.useful_types import ModusOperandi, T_Reference
 
 # Type aliases for better readability
 ViewsByReference: TypeAlias = dict[ViewReference, ViewRequest]
@@ -458,9 +458,42 @@ class ValidationResources:
         view_sets = [self.views_by_container.get(c, set()) for c in containers]
         return set.intersection(*view_sets)
 
-    # =========================================================================
-    # Methods used for requires constraint validation
-    # =========================================================================
+    @cached_property
+    def implements_graph(self) -> nx.DiGraph:
+        """Build a weighted directed graph of view implements.
+
+        Nodes are ViewReferences, edges represent implements.
+        An edge A → B means view A implements view B. Order of views in implements is used to set weight of an edge.
+
+        Includes views from both merged schema and CDF
+        """
+        graph: nx.DiGraph = nx.DiGraph()
+
+        for view_ref in self.cdf.views:
+            graph.add_node(view_ref)
+        for view_ref in self.merged.views:
+            graph.add_node(view_ref)
+
+        # Add edges for implements
+        for view_ref in graph.nodes():
+            view = self.select_view(view_ref)
+            if not view or not view.implements:
+                continue
+
+            # Adding weight to preserve order of implements
+            for i, implement in enumerate(view.implements):
+                graph.add_edge(view_ref, implement, weight=i + 1)
+
+        return graph
+
+    @cached_property
+    def implements_cycles(self) -> list[list[ViewReference]]:
+        """Find all cycles in the implements graph.
+        Returns:
+            List of lists, where each list contains the ordered Views involved in forming the implements cycle.
+        """
+
+        return self.graph_cycles(self.implements_graph)
 
     @cached_property
     def requires_constraint_graph(self) -> nx.DiGraph:
@@ -524,15 +557,15 @@ class ValidationResources:
         return False
 
     @cached_property
-    def requires_constraint_cycles(self) -> list[set[ContainerReference]]:
-        """Find all cycles in the requires constraint graph using Tarjan's algorithm.
-
-        Uses strongly connected components (SCC) to identify cycles efficiently.
-        An SCC with more than one node indicates a cycle.
-
+    def requires_constraint_cycles(self) -> list[list[ContainerReference]]:
+        """Find all cycles in the requires constraint graph.
         Returns:
-            List of sets, where each set contains the containers involved in a cycle.
+            List of lists, where each list contains the ordered containers involved in forming the requires cycle.
         """
-        sccs = nx.strongly_connected_components(self.requires_constraint_graph)
-        # Only SCCs with more than one node represent cycles
-        return [scc for scc in sccs if len(scc) > 1]
+
+        return self.graph_cycles(self.requires_constraint_graph)
+
+    @staticmethod
+    def graph_cycles(graph: nx.DiGraph) -> list[list[T_Reference]]:
+        """Returns cycles in the graph otherwise empty list"""
+        return [candidate for candidate in nx.simple_cycles(graph) if len(candidate) > 1]

{cognite_neat-1.0.21 → cognite_neat-1.0.22}/cognite/neat/_data_model/validation/dms/_views.py

@@ -124,3 +124,41 @@ class ImplementedViewNotExisting(DataModelValidator):
                     )
 
         return errors
+
+
+class CyclicImplements(DataModelValidator):
+    """Validates that view implements are not forming a cycle (i.e. cyclic graph of implements)
+
+    ## What it does
+    Runs graph analysis of the implements graph finding every cycle within the graph
+
+    ## Why is this bad?
+    You will not be able to deploy the data model to CDF, since cyclic implements are impossible to resolve
+    in terms of inheritance of properties.
+
+    ## Example
+    Say we have following views: A, B, and C, where A implements B, B implements C, and C implements A. This forms
+    the cyclic graph of implements A->B->C->A.
+
+    """
+
+    code = f"{BASE_CODE}-003"
+    issue_type = ConsistencyError
+    alpha = True
+
+    def run(self) -> list[ConsistencyError]:
+        errors: list[ConsistencyError] = []
+
+        for cycle in self.validation_resources.implements_cycles:
+            errors.append(
+                ConsistencyError(
+                    message=(
+                        "Detected cycle of view implements "
+                        f"{'->'.join([str(view) for view in cycle]) + f'->{cycle[0]}'}"
+                    ),
+                    fix="Inspect involved views and make necessary fix",
+                    code=self.code,
+                )
+            )
+
+        return errors

cognite_neat-1.0.22/cognite/neat/_version.py

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

{cognite_neat-1.0.21 → cognite_neat-1.0.22}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cognite-neat"
-version = "1.0.21"
+version = "1.0.22"
 readme = "README.md"
 description = "Knowledge graph transformation"
 authors = [
@@ -112,6 +112,8 @@ dev = [
     "hypothesis>=6.135.0, <7.0.0",
     "polyfactory>=2.22.2",
     "pytest-json-report>=1.5.0",
+    "matplotlib>=3.10.8",
+    "ipycytoscape>=1.3.3",
 ]
 
 [tool.pytest.ini_options]
@@ -195,4 +197,4 @@ build-backend = "uv_build"
 [tool.uv.build-backend]
 module-name = "cognite.neat"
 module-root = ""
-namespace = true
+namespace = true

cognite_neat-1.0.21/cognite/neat/_version.py

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