cognite-neat 0.127.22__py3-none-any.whl → 0.127.24__py3-none-any.whl

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

@@ -13,7 +13,11 @@ from ._connections import (
     ReverseConnectionTargetMissing,
 )
 from ._consistency import ViewSpaceVersionInconsistentWithDataModel
-from ._containers import ExternalContainerDoesNotExist, RequiredContainerDoesNotExist
+from ._containers import (
+    ExternalContainerDoesNotExist,
+    ExternalContainerPropertyDoesNotExist,
+    RequiredContainerDoesNotExist,
+)
 from ._limits import (
     ContainerPropertyCountIsOutOfLimits,
     ContainerPropertyListSizeIsOutOfLimits,
@@ -36,6 +40,7 @@ __all__ = [
     "DataModelViewCountIsOutOfLimits",
     "DmsDataModelValidation",
     "ExternalContainerDoesNotExist",
+    "ExternalContainerPropertyDoesNotExist",
     "ImplementedViewNotExisting",
     "RequiredContainerDoesNotExist",
     "ReverseConnectionContainerMissing",

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

@@ -12,17 +12,15 @@ BASE_CODE = "NEAT-DMS-CONTAINER"
 
 class ExternalContainerDoesNotExist(DataModelValidator):
     """
-    Validates that any container or container property referenced by a view property, when the
+    Validates that any container referenced by a view property, when the
     referenced container does not belong to the data model's space, exists in CDF.
 
     ## What it does
     For each view property that maps to a container in a different space than the data model,
-    this validator checks that:
-    - the referenced external container exists in CDF, and
-    - that the referenced container property also exists in that external container.
+    this validator checks that the referenced external container exists in CDF.
 
     ## Why is this bad?
-    If a view property references a container or container property that does not exist in CDF,
+    If a view property references a container that does not exist in CDF,
     the data model cannot be deployed. The affected view property will not function, and the
     deployment of the entire data model will fail.
 
@@ -30,10 +28,6 @@ class ExternalContainerDoesNotExist(DataModelValidator):
     View `my_space:WindTurbine` has a property `location` that maps to container
     `other_space:WindTurbineContainer`, where `other_space` differs from `my_space`. If that
     container does not exist in CDF, the model cannot be deployed.
-
-    Similarly, if a view property references `other_space:WindTurbineContainer` and its property
-    `gpsCoordinates`, and `gpsCoordinates` does not exist in that container in CDF, deployment
-    will also fail.
     """
 
     code = f"{BASE_CODE}-001"
@@ -50,7 +44,7 @@ class ExternalContainerDoesNotExist(DataModelValidator):
                     continue
 
                 # Check existence of container in CDF
-                elif property_.container not in self.cdf_resources.containers_by_reference:
+                if property_.container not in self.cdf_resources.containers_by_reference:
                     errors.append(
                         ConsistencyError(
                             message=(
@@ -62,8 +56,50 @@ class ExternalContainerDoesNotExist(DataModelValidator):
                         )
                     )
 
+        return errors
+
+
+class ExternalContainerPropertyDoesNotExist(DataModelValidator):
+    """
+    Validates that any container property referenced by a view property, when the
+    referenced container does not belong to the data model's space, exists in CDF.
+
+    ## What it does
+    For each view property that maps to a container in a different space than the data model,
+    this validator checks that the referenced container property exists in that external container in CDF.
+    This validator only runs if the external container exists in CDF.
+
+    ## Why is this bad?
+    If a view property references a container property that does not exist in CDF,
+    the data model cannot be deployed. The affected view property will not function, and the
+    deployment of the entire data model will fail.
+
+    ## Example
+    View `my_space:WindTurbine` has a property `location` that maps to container property
+    `gpsCoordinates` in `other_space:WindTurbineContainer`. If `gpsCoordinates` does not exist
+    in that container in CDF, deployment will fail.
+    """
+
+    code = f"{BASE_CODE}-002"
+
+    def run(self) -> list[ConsistencyError]:
+        errors: list[ConsistencyError] = []
+
+        for view_ref, view in self.merged_views.items():
+            for property_ref, property_ in view.properties.items():
+                if not isinstance(property_, ViewCorePropertyRequest):
+                    continue
+
+                if property_.container.space == self.local_resources.data_model_reference.space:
+                    continue
+
+                # Only check property if container exists in CDF
+                # this check is done in ExternalContainerDoesNotExist
+                if property_.container not in self.cdf_resources.containers_by_reference:
+                    continue
+
                 # Check existence of container property in CDF
-                elif (
+                if (
                     property_.container_property_identifier
                     not in self.cdf_resources.containers_by_reference[property_.container].properties
                 ):
@@ -100,7 +136,7 @@ class RequiredContainerDoesNotExist(DataModelValidator):
     If `windy_space:LocationContainer` does not exist in the data model or in CDF, deployment will fail.
     """
 
-    code = f"{BASE_CODE}-002"
+    code = f"{BASE_CODE}-003"
 
     def run(self) -> list[ConsistencyError]:
         errors: list[ConsistencyError] = []

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

@@ -35,7 +35,11 @@ from ._connections import (
     ReverseConnectionTargetMissing,
 )
 from ._consistency import ViewSpaceVersionInconsistentWithDataModel
-from ._containers import ExternalContainerDoesNotExist, RequiredContainerDoesNotExist
+from ._containers import (
+    ExternalContainerDoesNotExist,
+    ExternalContainerPropertyDoesNotExist,
+    RequiredContainerDoesNotExist,
+)
 from ._views import ImplementedViewNotExisting, ViewToContainerMappingNotPossible
 
 
@@ -116,6 +120,7 @@ class DmsDataModelValidation(OnSuccessIssuesChecker):
             ImplementedViewNotExisting(local_resources, cdf_resources, self._modus_operandi),
             # Containers
             ExternalContainerDoesNotExist(local_resources, cdf_resources, self._modus_operandi),
+            ExternalContainerPropertyDoesNotExist(local_resources, cdf_resources, self._modus_operandi),
             RequiredContainerDoesNotExist(local_resources, cdf_resources, self._modus_operandi),
             # Consistency
             ViewSpaceVersionInconsistentWithDataModel(local_resources, cdf_resources, self._modus_operandi),

cognite/neat/_utils/validation.py

@@ -93,6 +93,8 @@ def humanize_validation_error(
         )
     elif type_ == "union_tag_invalid":
         msg = error["msg"].replace(", 'direct'", "").replace("found using 'type' ", "").replace("tag", "value")
+    elif type_ == "string_pattern_mismatch":
+        msg = f"string '{error['input']}' does not match the required pattern: '{error['ctx']['pattern']}'."
 
     elif type_.endswith("_type"):
         msg = f"{error['msg']}. Got {error['input']!r} of type {type(error['input']).__name__}."
@@ -142,8 +144,11 @@ def _enum_message(type_: str, loc: tuple[int | str, ...], context: ValidationCon
     if loc[-1] != "values":
         raise RuntimeError("This is a neat bug, report to the team.")
     if type_ == "missing":
-        return f"In {context.humanize_location(loc[:-1])} definition is missing the collection reference"
+        return (
+            f"In {context.humanize_location(loc[:-1])} definition should include "
+            "a reference to a collection in the 'Enum' sheet (e.g., collection='MyEnumCollection')."
+        )
     elif type_ == "too_short":
-        return f"In {context.humanize_location(loc[:-1])} collection is not defined in 'Enum' sheet"
+        return f"In {context.humanize_location(loc[:-1])} collection is not defined in the 'Enum' sheet"
     else:
         raise RuntimeError("This is a neat bug, report to the team.")

cognite/neat/_version.py

@@ -1,2 +1,2 @@
-__version__ = "0.127.22"
+__version__ = "0.127.24"
 __engine__ = "^2.0.4"

{cognite_neat-0.127.22.dist-info → cognite_neat-0.127.24.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cognite-neat
-Version: 0.127.22
+Version: 0.127.24
 Summary: Knowledge graph transformation
 Project-URL: Documentation, https://cognite-neat.readthedocs-hosted.com/
 Project-URL: Homepage, https://cognite-neat.readthedocs-hosted.com/

{cognite_neat-0.127.22.dist-info → cognite_neat-0.127.24.dist-info}/RECORD

@@ -1,7 +1,7 @@
 cognite/neat/__init__.py,sha256=Lo4DbjDOwnhCYUoAgPp5RG1fDdF7OlnomalTe7n1ydw,211
 cognite/neat/_exceptions.py,sha256=ox-5hXpee4UJlPE7HpuEHV2C96aLbLKo-BhPDoOAzhA,1650
 cognite/neat/_issues.py,sha256=wH1mnkrpBsHUkQMGUHFLUIQWQlfJ_qMfdF7q0d9wNhY,1871
-cognite/neat/_version.py,sha256=Lln5aX0eKRyzYKw67isIIefxhPXDVBWcCGy6IFleQUM,47
+cognite/neat/_version.py,sha256=LNaUX8rigYyV0YJJO1DIZXt21i_AUALgOhe4snlff6o,47
 cognite/neat/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cognite/neat/v1.py,sha256=owqW5Mml2DSZx1AvPvwNRTBngfhBNrQ6EH-7CKL7Jp0,61
 cognite/neat/_client/__init__.py,sha256=75Bh7eGhaN4sOt3ZcRzHl7pXaheu1z27kmTHeaI05vo,114
@@ -73,14 +73,14 @@ cognite/neat/_data_model/models/entities/_data_types.py,sha256=DfdEWGek7gODro-_0
 cognite/neat/_data_model/models/entities/_identifiers.py,sha256=uBiK4ot3V0b_LGXuJ7bfha6AEcFI3p2letr1z2iSvig,1923
 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=y-7ISQri7EVZJDNcDgtxpnCm6c_JulrLmmxOeHPJNm0,2256
+cognite/neat/_data_model/validation/dms/__init__.py,sha256=qK9zBaXHj7x9k7geA1fRk6ewRB_hGm7bcq69WlDyffc,2357
 cognite/neat/_data_model/validation/dms/_ai_readiness.py,sha256=SI46roGc2pbZQwY-6tuSWyS7uMbg2mIzXcVA3NPRCk4,6742
 cognite/neat/_data_model/validation/dms/_base.py,sha256=y95k6HWGxX_EnnyuV2ooftgiyC-fwJaaHW28oEf9oBs,13113
 cognite/neat/_data_model/validation/dms/_connections.py,sha256=goIcsGV4yYb-d9ltXg4eM5qxt8iErIIxtkiKJXZUYyM,26937
 cognite/neat/_data_model/validation/dms/_consistency.py,sha256=K0mfAwwpW6zQXGDEldrA7Lgqk-giV_Y-gUKyb8Dw47k,2445
-cognite/neat/_data_model/validation/dms/_containers.py,sha256=Vs5Zj0NWVuO0APDEZaO7q2U877-tJzTDpaaCEd5AcTA,5991
+cognite/neat/_data_model/validation/dms/_containers.py,sha256=Jqwu2JH36eyqA7xt6_UaLEl-zhZi4itI1dmb73GpJMY,7431
 cognite/neat/_data_model/validation/dms/_limits.py,sha256=LVxF1qmeEdUVVAPmywCgxWJ9BR7Ai6nI4X1ylJ7pv8I,15982
-cognite/neat/_data_model/validation/dms/_orchestrator.py,sha256=FChXB7zflQtnR46BRUFkDCwosLu9YeFLeydEoyFtpVI,10176
+cognite/neat/_data_model/validation/dms/_orchestrator.py,sha256=4_KHtfJcuXSSIP7sazhBzM4_nSEz0d77CrsX5rmShOc,10337
 cognite/neat/_data_model/validation/dms/_views.py,sha256=3bHEEbFKTR_QH_tiJYHppQsZ9ruApv-kdyfehEjIlCU,4198
 cognite/neat/_session/__init__.py,sha256=owqW5Mml2DSZx1AvPvwNRTBngfhBNrQ6EH-7CKL7Jp0,61
 cognite/neat/_session/_issues.py,sha256=E8UQeSJURg2dm4MF1pfD9dp-heSRT7pgQZgKlD1-FGs,2723
@@ -116,7 +116,7 @@ cognite/neat/_utils/auxiliary.py,sha256=Cx-LP8dfN782R3iUcm--q26zdzQ0k_RFnVbJ0bwV
 cognite/neat/_utils/collection.py,sha256=BIwRrFbUXNPvHhEVujLHgVoDJXzdPEMScrbSBhyCibk,446
 cognite/neat/_utils/text.py,sha256=-ujNaG_hLkdurKsUmZB9ZI_kJkddlCKEf8g-g_XCk10,2010
 cognite/neat/_utils/useful_types.py,sha256=BwTjcWnpxnxN8rWXuYXMgU55O_YjVteMtYK0y25OmH0,1260
-cognite/neat/_utils/validation.py,sha256=Pg6EzS-sxB3k4P3OR1O15SSqBXIzpbPwvPSrosOxNJk,6675
+cognite/neat/_utils/validation.py,sha256=U422V0TY5KujFJFyfhRLONVj5A4AcCWgqIKVK6BUm7M,6938
 cognite/neat/_utils/http_client/__init__.py,sha256=qaCLLLhi7H3b_cmbknX0S66KILT7JSKX1YSgZjNdd1U,786
 cognite/neat/_utils/http_client/_client.py,sha256=TO9C77LcsqX0R3Fu-mP560nnV6rP5oRXki9kxRYtBlg,9658
 cognite/neat/_utils/http_client/_config.py,sha256=C8IF1JoijmVMjA_FEMgAkiD1buEV1cY5Og3t-Ecyfmk,756
@@ -312,7 +312,7 @@ cognite/neat/v0/session/engine/__init__.py,sha256=D3MxUorEs6-NtgoICqtZ8PISQrjrr4
 cognite/neat/v0/session/engine/_import.py,sha256=1QxA2_EK613lXYAHKQbZyw2yjo5P9XuiX4Z6_6-WMNQ,169
 cognite/neat/v0/session/engine/_interface.py,sha256=3W-cYr493c_mW3P5O6MKN1xEQg3cA7NHR_ev3zdF9Vk,533
 cognite/neat/v0/session/engine/_load.py,sha256=u0x7vuQCRoNcPt25KJBJRn8sJabonYK4vtSZpiTdP4k,5201
-cognite_neat-0.127.22.dist-info/METADATA,sha256=Z7803rtujMVrtcXDwv6nG-sVhmPaEM7WBZhK-41Lryk,9150
-cognite_neat-0.127.22.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-cognite_neat-0.127.22.dist-info/licenses/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
-cognite_neat-0.127.22.dist-info/RECORD,,
+cognite_neat-0.127.24.dist-info/METADATA,sha256=MAWzw07h5PAWRf-4uH9i42Ljqj4n5f_DUI29VJ8ka_I,9150
+cognite_neat-0.127.24.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+cognite_neat-0.127.24.dist-info/licenses/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
+cognite_neat-0.127.24.dist-info/RECORD,,