cognite-neat 0.127.29__py3-none-any.whl → 0.127.31__py3-none-any.whl

cognite/neat/_data_model/deployer/_differ_container.py

@@ -323,7 +323,7 @@ class DataTypeDiffer(ItemDiffer[PropertyTypeDefinition]):
         if current.collation != new.collation:
             changes.append(
                 ChangedField(
-                    item_severity=SeverityType.WARNING,
+                    item_severity=SeverityType.BREAKING,
                     field_path=self._get_path("collation"),
                     current_value=current.collation,
                     new_value=new.collation,

cognite/neat/_data_model/deployer/_differ_view.py

@@ -220,7 +220,7 @@ class ViewPropertyDiffer(ObjectDiffer[ViewPropertyDefinition]):
             changes.append(
                 ChangedField(
                     field_path=self._get_path(f"{identifier}.edgeSource"),
-                    item_severity=SeverityType.WARNING,
+                    item_severity=SeverityType.BREAKING,
                     new_value=new.edge_source,
                     current_value=current.edge_source,
                 )
@@ -229,7 +229,7 @@ class ViewPropertyDiffer(ObjectDiffer[ViewPropertyDefinition]):
             changes.append(
                 ChangedField(
                     field_path=self._get_path(f"{identifier}.direction"),
-                    item_severity=SeverityType.WARNING,
+                    item_severity=SeverityType.BREAKING,
                     new_value=new.direction,
                     current_value=current.direction,
                 )

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

@@ -1,6 +1,8 @@
 from ._ai_readiness import (
     DataModelMissingDescription,
     DataModelMissingName,
+    EnumerationMissingDescription,
+    EnumerationMissingName,
     ViewMissingDescription,
     ViewMissingName,
     ViewPropertyMissingDescription,
@@ -46,6 +48,8 @@ __all__ = [
     "DataModelMissingName",
     "DataModelViewCountIsOutOfLimits",
     "DmsDataModelValidation",
+    "EnumerationMissingDescription",
+    "EnumerationMissingName",
     "ExternalContainerDoesNotExist",
     "ExternalContainerPropertyDoesNotExist",
     "ImplementedViewNotExisting",

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

@@ -1,5 +1,6 @@
 """Validators for checking if data model is AI-ready."""
 
+from cognite.neat._data_model.models.dms._data_types import EnumProperty
 from cognite.neat._data_model.validation.dms._base import DataModelValidator
 from cognite.neat._issues import Recommendation
 
@@ -256,3 +257,108 @@ class ViewPropertyMissingDescription(DataModelValidator):
                         )
 
         return recommendations
+
+
+class EnumerationMissingName(DataModelValidator):
+    """Validates that an enumeration has a human-readable name.
+
+    ## What it does
+    Validates that each enumeration value in the data model has a human-readable name.
+
+    ## Why is this bad?
+    A missing name makes it harder for users (humans or machines) to understand the purpose of the enumeration value.
+    This is important as enumeration values are often technical codes or abbreviations, and a clear name improves
+    usability, maintainability, searchability, and AI-readiness.
+
+    ## Example
+    An enumeration value with id "NOM" in a wind turbine operational mode property has no name. Users may find it
+    difficult to understand what this value represents. Adding name "Normal Operation" would increase clarity
+    and usability.
+    """
+
+    code = f"{BASE_CODE}-007"
+    issue_type = Recommendation
+
+    def run(self) -> list[Recommendation]:
+        recommendations: list[Recommendation] = []
+
+        for container_ref, container in self.local_resources.containers_by_reference.items():
+            if container_ref.space != self.local_resources.data_model_reference.space:
+                continue
+
+            for prop_ref, definition in container.properties.items():
+                if not isinstance(definition.type, EnumProperty):
+                    continue
+
+                for value, enum_def in definition.type.values.items():
+                    if not enum_def.name:
+                        recommendations.append(
+                            Recommendation(
+                                message=(
+                                    f"Enumeration value {value!r} in property {prop_ref!s} of container "
+                                    f"{container_ref!s} is missing a human-readable name."
+                                ),
+                                fix="Add a clear and concise name to the enumeration value.",
+                                code=self.code,
+                            )
+                        )
+
+        return recommendations
+
+
+class EnumerationMissingDescription(DataModelValidator):
+    """Validates that an enumeration value has a human-readable description.
+
+    ## What it does
+    Validates that each enumeration value in the data model has a human-readable description.
+
+    ## Why is this bad?
+    A missing description makes it harder for users (humans or machines) to understand the meaning and context
+    of the enumeration value. The description can provide important information about when and how the value
+    should be used, especially when enumeration values are technical codes or abbreviations.
+
+    ## Example
+    An enumeration value "NOM" in a wind turbine operational mode property has no description. Users may find it
+    difficult to understand what this value represents without additional context. Even with a name like
+    "Normal Operation", the description is valuable as it can clarify specifics:
+
+    Option 1 — Basic definition
+    The turbine is operating normally and generating power according to its power curve.
+
+    Option 2 — Detailed operational context
+    The turbine is in normal operation mode, actively generating power with all systems functioning within
+    specified parameters and connected to the grid.
+
+    Option 3 — Contrasting with other modes
+    Standard operating mode where the turbine follows the power curve and responds to grid commands,
+    as opposed to maintenance mode or fault conditions.
+    """
+
+    code = f"{BASE_CODE}-008"
+    issue_type = Recommendation
+
+    def run(self) -> list[Recommendation]:
+        recommendations: list[Recommendation] = []
+
+        for container_ref, container in self.local_resources.containers_by_reference.items():
+            if container_ref.space != self.local_resources.data_model_reference.space:
+                continue
+
+            for prop_ref, definition in container.properties.items():
+                if not isinstance(definition.type, EnumProperty):
+                    continue
+
+                for value, enum_def in definition.type.values.items():
+                    if not enum_def.description:
+                        recommendations.append(
+                            Recommendation(
+                                message=(
+                                    f"Enumeration value {value!r} in property {prop_ref!s} of container "
+                                    f"{container_ref!s} is missing a human-readable description."
+                                ),
+                                fix="Add a clear and concise description to the enumeration value.",
+                                code=self.code,
+                            )
+                        )
+
+        return recommendations

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

@@ -23,6 +23,8 @@ from cognite.neat._utils.useful_types import ModusOperandi
 from ._ai_readiness import (
     DataModelMissingDescription,
     DataModelMissingName,
+    EnumerationMissingDescription,
+    EnumerationMissingName,
     ViewMissingDescription,
     ViewMissingName,
     ViewPropertyMissingDescription,
@@ -152,6 +154,8 @@ class DmsDataModelValidation(OnSuccessIssuesChecker):
             ViewMissingDescription(local_resources, cdf_resources, self._modus_operandi),
             ViewPropertyMissingName(local_resources, cdf_resources, self._modus_operandi),
             ViewPropertyMissingDescription(local_resources, cdf_resources, self._modus_operandi),
+            EnumerationMissingName(local_resources, cdf_resources, self._modus_operandi),
+            EnumerationMissingDescription(local_resources, cdf_resources, self._modus_operandi),
         ]
 
         # Run validators

cognite/neat/_version.py

@@ -1,2 +1,2 @@
-__version__ = "0.127.29"
+__version__ = "0.127.31"
 __engine__ = "^2.0.4"

{cognite_neat-0.127.29.dist-info → cognite_neat-0.127.31.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cognite-neat
-Version: 0.127.29
+Version: 0.127.31
 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.29.dist-info → cognite_neat-0.127.31.dist-info}/RECORD

@@ -2,7 +2,7 @@ cognite/neat/__init__.py,sha256=Lo4DbjDOwnhCYUoAgPp5RG1fDdF7OlnomalTe7n1ydw,211
 cognite/neat/_config.py,sha256=W42Lj5PNR9X1is9vIPHLHvkl_rpU5PCrDuQI4zSNTJQ,6359
 cognite/neat/_exceptions.py,sha256=ox-5hXpee4UJlPE7HpuEHV2C96aLbLKo-BhPDoOAzhA,1650
 cognite/neat/_issues.py,sha256=wH1mnkrpBsHUkQMGUHFLUIQWQlfJ_qMfdF7q0d9wNhY,1871
-cognite/neat/_version.py,sha256=HnkgU0oEwuWFxHjFpJFKDNKAV0Zn342c-qMWtztHfKE,47
+cognite/neat/_version.py,sha256=rvkcySAmEggTDqAglgVEXmb2SsDZO3WaXGVcdNwHKNU,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
@@ -22,10 +22,10 @@ cognite/neat/_data_model/_identifiers.py,sha256=a0LcQ_h0NffxSKTCrzCDpYkrlaUTk-D_
 cognite/neat/_data_model/_shared.py,sha256=H0gFqa8tKFNWuvdat5jL6OwySjCw3aQkLPY3wtb9Wrw,1302
 cognite/neat/_data_model/deployer/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cognite/neat/_data_model/deployer/_differ.py,sha256=1ircRBCoaFooSzMTmTZBTORHeAhDa8YtDEnVwBo6TUI,4742
-cognite/neat/_data_model/deployer/_differ_container.py,sha256=7iKQVxCtwjOMlydzX8U2Vs09pTiF-SflQoE_FsMCWN4,14664
+cognite/neat/_data_model/deployer/_differ_container.py,sha256=mcy7PhUOfnvAxnZWNoeNRmiXa8ovIn0W6YoqfzVYyiQ,14665
 cognite/neat/_data_model/deployer/_differ_data_model.py,sha256=iA7Xp-7NRvzZJXLLpJaLebkKKpv_VCBKPX6f-RU9wBk,1864
 cognite/neat/_data_model/deployer/_differ_space.py,sha256=J_AaqiseLpwQsOkKc7gmho4U2oSWAGVeEdQNepZiWw0,343
-cognite/neat/_data_model/deployer/_differ_view.py,sha256=Gho1XAR7S5G41JPj_4E2rkYzuOQYid3AlsyIwvXAzlM,11410
+cognite/neat/_data_model/deployer/_differ_view.py,sha256=g1xHwsoxFUaTOTtQa19nntKF3rxFzc2FxpKKFAUN_NE,11412
 cognite/neat/_data_model/deployer/data_classes.py,sha256=ZNSBFNhq46FfERKwC3Zu2TU1RFDdFsnaUzTtztgWdDY,23050
 cognite/neat/_data_model/deployer/deployer.py,sha256=_d3A2JnrVD4sjBNJIkXbwtTQOW5fc7QWrQBdwBfN8fs,18277
 cognite/neat/_data_model/exporters/__init__.py,sha256=AskjmB_0Vqib4kN84bWt8-M8nO42QypFf-l-E8oA5W8,482
@@ -74,14 +74,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=Ps26r8bY4sLPsceaS6CpgS-s6JxN_zKbiteF5RrQYYw,2512
-cognite/neat/_data_model/validation/dms/_ai_readiness.py,sha256=yKT9KHS4iD7ijKBjjAGbREKWDGunBuDTl9FCX0RiW2Q,10717
+cognite/neat/_data_model/validation/dms/__init__.py,sha256=kKD18-Bg_G-w11Cs7Wv_TKV0C_q62Pm2RKLpOz27ar4,2642
+cognite/neat/_data_model/validation/dms/_ai_readiness.py,sha256=hFrnRzBBf143ejLHRk3BpylzrVpxUX537BouOlv4PFE,15552
 cognite/neat/_data_model/validation/dms/_base.py,sha256=3Lqs8pzMQZznxhUr8esEe9H7F2wM3EKEl2H64GLS5OA,13344
 cognite/neat/_data_model/validation/dms/_connections.py,sha256=6ea8WZNqYT9SPluwXvg0mgDJpzZMqpPC5xonbdLrT4E,27305
 cognite/neat/_data_model/validation/dms/_consistency.py,sha256=uJ6coAVupD3WfeeXxoCIebM8WSnR78GXBXIBnN59aao,2477
 cognite/neat/_data_model/validation/dms/_containers.py,sha256=UuvzrBBw45F5f9uzCh97lW4t7m7XIIT1I9FnzzYUYv4,7533
 cognite/neat/_data_model/validation/dms/_limits.py,sha256=UDJ3oY2Xp96Zw2QpsGM4MQ6gZCrDuoKhhuEY2uQJLP4,16186
-cognite/neat/_data_model/validation/dms/_orchestrator.py,sha256=0KpXMWlofpELCE3QXQh6SDyP3IoATPrR1412HJzAN6w,10811
+cognite/neat/_data_model/validation/dms/_orchestrator.py,sha256=XrozA27fbzWCuCQKLx70jMaeABedKHTHs8vg-hqx3_w,11061
 cognite/neat/_data_model/validation/dms/_views.py,sha256=M4egIa7UAMGtZlqzIxx6ZzL4e_qo8GbDGh7vs9wywD8,4266
 cognite/neat/_session/__init__.py,sha256=owqW5Mml2DSZx1AvPvwNRTBngfhBNrQ6EH-7CKL7Jp0,61
 cognite/neat/_session/_issues.py,sha256=E8UQeSJURg2dm4MF1pfD9dp-heSRT7pgQZgKlD1-FGs,2723
@@ -313,7 +313,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.29.dist-info/METADATA,sha256=BODhl8sBHt2YtVcTIr7NK7Pcew1A68onQGB63HaKYDo,9150
-cognite_neat-0.127.29.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-cognite_neat-0.127.29.dist-info/licenses/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
-cognite_neat-0.127.29.dist-info/RECORD,,
+cognite_neat-0.127.31.dist-info/METADATA,sha256=M2giADSPBb8V9B1ejRjCNgGcYL8hZCdPoyg3Ddwrt9M,9150
+cognite_neat-0.127.31.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+cognite_neat-0.127.31.dist-info/licenses/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
+cognite_neat-0.127.31.dist-info/RECORD,,