cognite-neat 0.127.26__py3-none-any.whl → 0.127.27__py3-none-any.whl

cognite/neat/_data_model/_analysis.py

@@ -14,6 +14,7 @@ from cognite.neat._data_model.models.dms._view_property import (
     EdgeProperty,
     ReverseDirectRelationProperty,
     ViewCorePropertyRequest,
+    ViewRequestProperty,
 )
 from cognite.neat._data_model.models.dms._views import ViewRequest
 
@@ -82,6 +83,15 @@ class DataModelAnalysis:
 
         return view_by_reference
 
+    @property
+    def properties_by_view(self) -> dict[ViewReference, dict[str, ViewRequestProperty]]:
+        """Get a mapping of view references to their corresponding properties."""
+        view_by_reference = self.view_by_reference(include_inherited_properties=False)
+        return {
+            view_ref: {prop_name: prop for prop_name, prop in view.properties.items()}
+            for view_ref, view in view_by_reference.items()
+        }
+
     @staticmethod
     def ancestors_by_view(views: list[ViewRequest]) -> dict[ViewReference, set[ViewReference]]:
         """Get a mapping of each view to its ancestors in the physical data model."""

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

@@ -1,4 +1,11 @@
-from ._ai_readiness import DataModelMissingDescription, DataModelMissingName, ViewMissingDescription, ViewMissingName
+from ._ai_readiness import (
+    DataModelMissingDescription,
+    DataModelMissingName,
+    ViewMissingDescription,
+    ViewMissingName,
+    ViewPropertyMissingDescription,
+    ViewPropertyMissingName,
+)
 from ._connections import (
     ConnectionValueTypeUndefined,
     ConnectionValueTypeUnexisting,
@@ -57,6 +64,8 @@ __all__ = [
     "ViewMissingDescription",
     "ViewMissingName",
     "ViewPropertyCountIsOutOfLimits",
+    "ViewPropertyMissingDescription",
+    "ViewPropertyMissingName",
     "ViewSpaceVersionInconsistentWithDataModel",
     "ViewToContainerMappingNotPossible",
 ]

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

@@ -165,3 +165,88 @@ class ViewMissingDescription(DataModelValidator):
                 )
 
         return recommendations
+
+
+class ViewPropertyMissingName(DataModelValidator):
+    """Validates that a view property has a human-readable name.
+
+    ## What it does
+    Validates that each view property 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 view property.
+    This is important as view property's ids are often based on technical identifiers, abbreviations, etc.
+    Providing a clear name improves usability, maintainability, searchability, and AI-readiness.
+
+    ## Example
+    A view WindTurbine has a property pc which has no name. Users may find it difficult to understand what this view
+    property represents, unless they look up the id in documentation or other resources. Adding name "power curve"
+    would increase clarity and usability.
+    """
+
+    code = f"{BASE_CODE}-005"
+
+    def run(self) -> list[Recommendation]:
+        recommendations: list[Recommendation] = []
+
+        for view_ref in self.local_resources.data_model_views:
+            if properties := self.local_resources.properties_by_view.get(view_ref):
+                for prop_ref, definition in properties.items():
+                    if not definition.name:
+                        recommendations.append(
+                            Recommendation(
+                                message=f"View {view_ref!s} property {prop_ref!s} is missing a human-readable name.",
+                                fix="Add a clear and concise name to the view property.",
+                                code=self.code,
+                            )
+                        )
+
+        return recommendations
+
+
+class ViewPropertyMissingDescription(DataModelValidator):
+    """Validates that a View property has a human-readable description.
+
+    ## What it does
+    Validates that each view property 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 in what context the view property
+    should be used. The description can provide important information about the view property's purpose,
+    scope, and usage.
+
+
+    ## Example
+    A view WindTurbine has a property status with no description. Users may find it difficult to understand what this
+    property represents, unless extra context is provided. Even if we know that status is related to wind turbine
+    operations, a description is necessary as it can have different meanings in various contexts:
+
+    Option 1 — Operational status
+    Current operational state of the wind turbine (e.g., running, stopped, maintenance, fault).
+
+    Option 2 — Connection status
+    Grid connection status indicating whether the turbine is connected to the electrical grid.
+
+    Option 3 — Availability status
+    Availability state for production indicating whether the turbine is available for power generation.
+
+    """
+
+    code = f"{BASE_CODE}-006"
+
+    def run(self) -> list[Recommendation]:
+        recommendations: list[Recommendation] = []
+
+        for view_ref in self.local_resources.data_model_views:
+            if properties := self.local_resources.properties_by_view.get(view_ref):
+                for prop_ref, definition in properties.items():
+                    if not definition.description:
+                        recommendations.append(
+                            Recommendation(
+                                message=f"View {view_ref!s} property {prop_ref!s} is missing a description.",
+                                fix="Add a clear and concise description to the view property.",
+                                code=self.code,
+                            )
+                        )
+
+        return recommendations

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

@@ -13,6 +13,7 @@ from cognite.neat._data_model.models.dms._references import (
     ViewDirectReference,
     ViewReference,
 )
+from cognite.neat._data_model.models.dms._view_property import ViewRequestProperty
 from cognite.neat._data_model.models.dms._views import ViewRequest
 from cognite.neat._issues import ConsistencyError, Recommendation
 from cognite.neat._utils.useful_types import ModusOperandi
@@ -36,6 +37,7 @@ class LocalResources:
     data_model_description: str | None
     data_model_name: str | None
     views_by_reference: ViewsByReference
+    properties_by_view: dict[ViewReference, dict[str, ViewRequestProperty]]
     ancestors_by_view_reference: AncestorsByReference
     reverse_to_direct_mapping: ReverseToDirectMapping
     containers_by_reference: ContainersByReference

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

@@ -19,7 +19,14 @@ from cognite.neat._data_model.validation.dms._limits import (
 )
 from cognite.neat._utils.useful_types import ModusOperandi
 
-from ._ai_readiness import DataModelMissingDescription, DataModelMissingName, ViewMissingDescription, ViewMissingName
+from ._ai_readiness import (
+    DataModelMissingDescription,
+    DataModelMissingName,
+    ViewMissingDescription,
+    ViewMissingName,
+    ViewPropertyMissingDescription,
+    ViewPropertyMissingName,
+)
 from ._base import CDFResources, DataModelValidator, LocalResources
 from ._connections import (
     ConnectionValueTypeUndefined,
@@ -74,6 +81,7 @@ class DmsDataModelValidation(OnSuccessIssuesChecker):
             data_model_name=data_model.data_model.name,
             data_model_reference=data_model.data_model.as_reference(),
             views_by_reference=local_views_by_reference,
+            properties_by_view=analysis.properties_by_view,
             ancestors_by_view_reference=local_ancestors_by_view_reference,
             reverse_to_direct_mapping=local_reverse_to_direct_mapping,
             containers_by_reference=local_containers_by_reference,
@@ -141,6 +149,8 @@ class DmsDataModelValidation(OnSuccessIssuesChecker):
             DataModelMissingDescription(local_resources, cdf_resources, self._modus_operandi),
             ViewMissingName(local_resources, cdf_resources, self._modus_operandi),
             ViewMissingDescription(local_resources, cdf_resources, self._modus_operandi),
+            ViewPropertyMissingName(local_resources, cdf_resources, self._modus_operandi),
+            ViewPropertyMissingDescription(local_resources, cdf_resources, self._modus_operandi),
         ]
 
         # Run validators

cognite/neat/_version.py

@@ -1,2 +1,2 @@
-__version__ = "0.127.26"
+__version__ = "0.127.27"
 __engine__ = "^2.0.4"

{cognite_neat-0.127.26.dist-info → cognite_neat-0.127.27.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cognite-neat
-Version: 0.127.26
+Version: 0.127.27
 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.26.dist-info → cognite_neat-0.127.27.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=zp1q6MhRkZE6P6k0LZ7xa5KjU1ZbL4JI5oVv8qlg_5Q,47
+cognite/neat/_version.py,sha256=cz0CG5j6gdpaAmogpF9j31GRp2vxv4fKDwo6HE72kx0,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
@@ -15,7 +15,7 @@ cognite/neat/_client/spaces_api.py,sha256=xHtSMt_2k2YwZ5_8kH2dfa7fWxQQrky7wra4Ar
 cognite/neat/_client/statistics_api.py,sha256=HcYb2nNC9M_iaI1xyjjLn2Cz1tcyu7BJeaqVps79tg4,773
 cognite/neat/_client/views_api.py,sha256=vZh851Yw8X-Y90sahOiGnq-pwDOBBXegcxTtypkcMvA,4956
 cognite/neat/_data_model/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cognite/neat/_data_model/_analysis.py,sha256=WJNMRXMBngrjdSPxEZLMg75_6mDZhOuJxrflG4n6Anc,8355
+cognite/neat/_data_model/_analysis.py,sha256=d_gP0M_8-HjSAhWT28cfdOsydNAKmOOT4pTh5W_CQcU,8827
 cognite/neat/_data_model/_constants.py,sha256=txKFNRPkCRrIkXbf_bLCYBCMkoE_7nc5LliohzMGwOs,1596
 cognite/neat/_data_model/_identifiers.py,sha256=a0LcQ_h0NffxSKTCrzCDpYkrlaUTk-D_rfaQUh-BhWc,1921
 cognite/neat/_data_model/_shared.py,sha256=H0gFqa8tKFNWuvdat5jL6OwySjCw3aQkLPY3wtb9Wrw,1302
@@ -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=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/__init__.py,sha256=Ps26r8bY4sLPsceaS6CpgS-s6JxN_zKbiteF5RrQYYw,2512
+cognite/neat/_data_model/validation/dms/_ai_readiness.py,sha256=_7R4BVVcJw27OYmMS-GxxcvQdocr67sU1gGouUo81EU,10525
+cognite/neat/_data_model/validation/dms/_base.py,sha256=HJRoo1fX2Fu0bzlPKhn3VOsrtaOv4ea49BxvEpfOjIY,13272
 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=Jqwu2JH36eyqA7xt6_UaLEl-zhZi4itI1dmb73GpJMY,7431
 cognite/neat/_data_model/validation/dms/_limits.py,sha256=LVxF1qmeEdUVVAPmywCgxWJ9BR7Ai6nI4X1ylJ7pv8I,15982
-cognite/neat/_data_model/validation/dms/_orchestrator.py,sha256=4_KHtfJcuXSSIP7sazhBzM4_nSEz0d77CrsX5rmShOc,10337
+cognite/neat/_data_model/validation/dms/_orchestrator.py,sha256=1cwGrtsSs6Q1vT-8vbZ2DM_3WYu9YTSRDbDGJhkTCBs,10672
 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
@@ -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.26.dist-info/METADATA,sha256=W1EY7XRW7rN7oqdEfS1UMJW1drv2KQyTFuDIH8V1Yh4,9150
-cognite_neat-0.127.26.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-cognite_neat-0.127.26.dist-info/licenses/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
-cognite_neat-0.127.26.dist-info/RECORD,,
+cognite_neat-0.127.27.dist-info/METADATA,sha256=QOiSm6GFoghApq_RDl6xHl3ACh9pnoLdrVRV_j-uAGk,9150
+cognite_neat-0.127.27.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+cognite_neat-0.127.27.dist-info/licenses/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
+cognite_neat-0.127.27.dist-info/RECORD,,

{cognite_neat-0.127.26.dist-info → cognite_neat-0.127.27.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any