cognite-neat 1.0.21__py3-none-any.whl → 1.0.23__py3-none-any.whl

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/_data_model/validation/dms/__init__.py

@@ -26,6 +26,7 @@ from ._containers import (
     ExternalContainerDoesNotExist,
     ExternalContainerPropertyDoesNotExist,
     RequiredContainerDoesNotExist,
+    RequiresConstraintCycle,
 )
 from ._limits import (
     ContainerPropertyCountIsOutOfLimits,
@@ -54,6 +55,7 @@ __all__ = [
     "ExternalContainerPropertyDoesNotExist",
     "ImplementedViewNotExisting",
     "RequiredContainerDoesNotExist",
+    "RequiresConstraintCycle",
     "ReverseConnectionContainerMissing",
     "ReverseConnectionContainerPropertyMissing",
     "ReverseConnectionContainerPropertyWrongType",

cognite/neat/_data_model/validation/dms/_containers.py

@@ -197,3 +197,41 @@ class RequiredContainerDoesNotExist(DataModelValidator):
                     )
 
         return errors
+
+
+class RequiresConstraintCycle(DataModelValidator):
+    """
+    Validates that requires constraints between containers do not form cycles.
+
+    ## What it does
+    This validator checks if the requires constraints between containers form a cycle.
+    For example, if container A requires B, B requires C, and C requires A, this forms
+    a cycle.
+
+    ## Why is this bad?
+    Cycles in requires constraints will be rejected by the CDF API. The deployment
+    of the data model will fail if any such cycle exists.
+
+    ## Example
+    Container `my_space:OrderContainer` requires `my_space:CustomerContainer`, which
+    requires `my_space:OrderContainer`. This creates a cycle and will be rejected.
+    """
+
+    code = f"{BASE_CODE}-005"
+    issue_type = ConsistencyError
+    alpha = True  # Still in development
+
+    def run(self) -> list[ConsistencyError]:
+        errors: list[ConsistencyError] = []
+
+        for cycle in self.validation_resources.requires_constraint_cycles:
+            cycle_str = " -> ".join(str(c) for c in cycle) + f" -> {cycle[0]!s}"
+            errors.append(
+                ConsistencyError(
+                    message=f"Requires constraints form a cycle: {cycle_str}",
+                    fix="Remove one of the requires constraints to break the cycle",
+                    code=self.code,
+                )
+            )
+
+        return errors

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/_version.py

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

{cognite_neat-1.0.21.dist-info → cognite_neat-1.0.23.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cognite-neat
-Version: 1.0.21
+Version: 1.0.23
 Summary: Knowledge graph transformation
 Author: Nikola Vasiljevic, Anders Albert
 Author-email: Nikola Vasiljevic <nikola.vasiljevic@cognite.com>, Anders Albert <anders.albert@cognite.com>
@@ -55,10 +55,10 @@ Requires-Dist: lxml>=5.3.0,<6.0.0 ; extra == 'lxml'
 Requires-Dist: oxrdflib>=0.4.0,<0.5.0 ; extra == 'oxi'
 Requires-Dist: pyoxigraph>=0.4.3,<0.5.0 ; extra == 'oxi'
 Requires-Python: >=3.10
-Project-URL: Changelog, https://github.com/cognitedata/neat/releases
 Project-URL: Documentation, https://cognite-neat.readthedocs-hosted.com/
-Project-URL: GitHub, https://github.com/cognitedata/neat
 Project-URL: Homepage, https://cognite-neat.readthedocs-hosted.com/
+Project-URL: GitHub, https://github.com/cognitedata/neat
+Project-URL: Changelog, https://github.com/cognitedata/neat/releases
 Provides-Extra: docs
 Provides-Extra: google
 Provides-Extra: lxml

{cognite_neat-1.0.21.dist-info → cognite_neat-1.0.23.dist-info}/RECORD

@@ -15,7 +15,7 @@ cognite/neat/_client/statistics_api.py,sha256=HcYb2nNC9M_iaI1xyjjLn2Cz1tcyu7BJea
 cognite/neat/_client/views_api.py,sha256=Qzk_wiLtaWszxCQFDBoWCH1yDc4GOEJsVOcL061rcK0,5639
 cognite/neat/_config.py,sha256=ZvCkcaRVAvH4-ClvinoWaLWhRJpRByqdvncGFsf5gLk,9886
 cognite/neat/_data_model/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cognite/neat/_data_model/_analysis.py,sha256=lPiXF0td4y5TudrR1KPH5OUZ_YNBz8tO6cLg3RnJwEg,22413
+cognite/neat/_data_model/_analysis.py,sha256=dN-udKm_5oD3217O4B_QIps2Hx4v50-Pu2fR0bQNQg0,23504
 cognite/neat/_data_model/_constants.py,sha256=E2axzdYjsIy7lTHsjW91wsv6r-pUwko8g6K8C_oRnxk,1707
 cognite/neat/_data_model/_identifiers.py,sha256=lDLvMvYDgRNFgk5GmxWzOUunG7M3synAciNjzJI0m_o,1913
 cognite/neat/_data_model/_shared.py,sha256=H0gFqa8tKFNWuvdat5jL6OwySjCw3aQkLPY3wtb9Wrw,1302
@@ -74,15 +74,15 @@ cognite/neat/_data_model/models/entities/_data_types.py,sha256=DfdEWGek7gODro-_0
 cognite/neat/_data_model/models/entities/_identifiers.py,sha256=a7ojJKY1ErZgUANHscEwkctX4RJ7bWEEWOQt5g5Tsdk,1915
 cognite/neat/_data_model/models/entities/_parser.py,sha256=zef_pSDZYMZrJl4IKreFDR577KutfhtN1xpH3Ayjt2o,7669
 cognite/neat/_data_model/validation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cognite/neat/_data_model/validation/dms/__init__.py,sha256=kKD18-Bg_G-w11Cs7Wv_TKV0C_q62Pm2RKLpOz27ar4,2642
+cognite/neat/_data_model/validation/dms/__init__.py,sha256=STb0mYmyD-E6CfhjaXNOgWM1LvYSm59m6-Khu9cEhNI,2702
 cognite/neat/_data_model/validation/dms/_ai_readiness.py,sha256=bffMQJ5pqumU5P3KaEdQP67OO5eMKqzN2BAWbUjG6KE,16143
 cognite/neat/_data_model/validation/dms/_base.py,sha256=G_gMPTgKwyBW62UcCkKIBVHWp9ufAZPJ2p7o69_dJI0,820
 cognite/neat/_data_model/validation/dms/_connections.py,sha256=-kUXf2_3V50ckxwXRwJoTHsKkS5zxiBKkkkHg8Dm4WI,30353
 cognite/neat/_data_model/validation/dms/_consistency.py,sha256=IKSUoRQfQQcsymviESW9VuTFX7jsZMXfsObeZHPdov4,2435
-cognite/neat/_data_model/validation/dms/_containers.py,sha256=5Lka1Cg-SaP9Ued0cku0leG1Sjx76JQ9XcBZK_dtfuM,8520
+cognite/neat/_data_model/validation/dms/_containers.py,sha256=8pVnmeX6G9tQaGzzwRB_40y7TYUm4guaNbRiFgoGILU,9895
 cognite/neat/_data_model/validation/dms/_limits.py,sha256=U7z8sN-kAyJsF5hYHPNBBg25Fvz1F8njhzYVSQOIiOU,14779
 cognite/neat/_data_model/validation/dms/_orchestrator.py,sha256=qiuUSUmNhekFyBARUUO2yhG-X9AeU_LL49UrJ65JXFA,2964
-cognite/neat/_data_model/validation/dms/_views.py,sha256=Q0x7jdG69-AVc93VrwdZ1_rFHpq-I-OG98puM4lcweE,5068
+cognite/neat/_data_model/validation/dms/_views.py,sha256=pRdnj5ZBnHNnbLKleXGbipteGma8_l5AYsDIfqgAil4,6345
 cognite/neat/_exceptions.py,sha256=mO19TEecZYDNqSvzuc6JmCLFQ70eniT1-Gb0AEbgbzE,2090
 cognite/neat/_issues.py,sha256=wH1mnkrpBsHUkQMGUHFLUIQWQlfJ_qMfdF7q0d9wNhY,1871
 cognite/neat/_session/__init__.py,sha256=owqW5Mml2DSZx1AvPvwNRTBngfhBNrQ6EH-7CKL7Jp0,61
@@ -321,9 +321,9 @@ cognite/neat/_v0/session/_template.py,sha256=BNcvrW5y7LWzRM1XFxZkfR1Nc7e8UgjBClH
 cognite/neat/_v0/session/_to.py,sha256=AnsRSDDdfFyYwSgi0Z-904X7WdLtPfLlR0x1xsu_jAo,19447
 cognite/neat/_v0/session/_wizard.py,sha256=baPJgXAAF3d1bn4nbIzon1gWfJOeS5T43UXRDJEnD3c,1490
 cognite/neat/_v0/session/exceptions.py,sha256=jv52D-SjxGfgqaHR8vnpzo0SOJETIuwbyffSWAxSDJw,3495
-cognite/neat/_version.py,sha256=0Bv-euqjHzX0kdwCv6YRDD5BAUEFBhkf7f6PaEKGdd0,45
+cognite/neat/_version.py,sha256=rj_LKbqpGZavJZekkd20Oo3-5Wi6i3pBDjeRkCt22zY,45
 cognite/neat/legacy.py,sha256=eI2ecxOV8ilGHyLZlN54ve_abtoK34oXognkFv3yvF0,219
 cognite/neat/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cognite_neat-1.0.21.dist-info/WHEEL,sha256=XjEbIc5-wIORjWaafhI6vBtlxDBp7S9KiujWF1EM7Ak,79
-cognite_neat-1.0.21.dist-info/METADATA,sha256=QpA63SYiPB_pttmYhdDpmx7AbJl98Sd8V-wIbjoWCwI,6689
-cognite_neat-1.0.21.dist-info/RECORD,,
+cognite_neat-1.0.23.dist-info/WHEEL,sha256=XV0cjMrO7zXhVAIyyc8aFf1VjZ33Fen4IiJk5zFlC3g,80
+cognite_neat-1.0.23.dist-info/METADATA,sha256=hByYgnOhvq27boiIAHGRyCwddaWgqPxcP_jX8TytSMs,6689
+cognite_neat-1.0.23.dist-info/RECORD,,

{cognite_neat-1.0.21.dist-info → cognite_neat-1.0.23.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: uv 0.9.25
+Generator: uv 0.9.26
 Root-Is-Purelib: true
-Tag: py3-none-any
+Tag: py3-none-any