cognite-neat 0.98.0__py3-none-any.whl → 0.99.1__py3-none-any.whl

cognite/neat/_rules/models/information/__init__.py

@@ -5,6 +5,7 @@ from ._rules_input import (
     InformationInputProperty,
     InformationInputRules,
 )
+from ._validation import InformationValidation
 
 __all__ = [
     "InformationRules",
@@ -15,4 +16,5 @@ __all__ = [
     "InformationInputMetadata",
     "InformationInputClass",
     "InformationInputProperty",
+    "InformationValidation",
 ]

cognite/neat/_rules/models/information/_rules.py

@@ -1,5 +1,4 @@
 import math
-import sys
 from collections.abc import Hashable
 from typing import TYPE_CHECKING, Any, ClassVar
 
@@ -14,9 +13,7 @@ from cognite.neat._rules._constants import EntityTypes
 from cognite.neat._rules.models._base_rules import (
     BaseMetadata,
     BaseRules,
-    ClassRef,
     DataModelAspect,
-    PropertyRef,
     RoleTypes,
     SheetList,
     SheetRow,
@@ -36,8 +33,6 @@ from cognite.neat._rules.models.entities import (
     ClassEntity,
     ClassEntityList,
     Entity,
-    MultiValueTypeInfo,
-    Undefined,
     UnknownEntity,
 )
 
@@ -45,12 +40,6 @@ if TYPE_CHECKING:
     from cognite.neat._rules.models import DMSRules
 
 
-if sys.version_info >= (3, 11):
-    from typing import Self
-else:
-    from typing_extensions import Self
-
-
 class InformationMetadata(BaseMetadata):
     role: ClassVar[RoleTypes] = RoleTypes.information
     aspect: ClassVar[DataModelAspect] = DataModelAspect.logical
@@ -103,9 +92,6 @@ class InformationClass(SheetRow):
             )
         return ",".join(str(value) for value in value)
 
-    def as_reference(self) -> ClassRef:
-        return ClassRef(Class=self.class_)
-
 
 class InformationProperty(SheetRow):
     """
@@ -160,21 +146,6 @@ class InformationProperty(SheetRow):
         else:
             raise NeatValueError(f"Invalid RDF Path: {value!s}")
 
-    @model_validator(mode="after")
-    def set_default_as_list(self):
-        if (
-            self.type_ == EntityTypes.data_property
-            and self.default
-            and self.is_list
-            and not isinstance(self.default, list)
-        ):
-            if isinstance(self.default, str):
-                if self.default:
-                    self.default = self.default.replace(", ", ",").split(",")
-                else:
-                    self.default = [self.default]
-        return self
-
     @model_validator(mode="after")
     def set_type_for_default(self):
         if self.type_ == EntityTypes.data_property and self.default:
@@ -233,9 +204,6 @@ class InformationProperty(SheetRow):
             isinstance(self.max_count, int | float) and self.max_count > 1
         )
 
-    def as_reference(self) -> PropertyRef:
-        return PropertyRef(Class=self.class_, Property=self.property_)
-
 
 class InformationRules(BaseRules):
     metadata: InformationMetadata = Field(alias="Metadata")
@@ -251,41 +219,6 @@ class InformationRules(BaseRules):
             values = get_default_prefixes()
         return values
 
-    @model_validator(mode="after")
-    def update_entities_prefix(self) -> Self:
-        # update expected_value_types
-        for property_ in self.properties:
-            if isinstance(property_.value_type, ClassEntity) and property_.value_type.prefix is Undefined:
-                property_.value_type.prefix = self.metadata.prefix
-
-            if isinstance(property_.value_type, MultiValueTypeInfo):
-                property_.value_type.set_default_prefix(self.metadata.prefix)
-
-            if property_.class_.prefix is Undefined:
-                property_.class_.prefix = self.metadata.prefix
-
-        # update implements
-        for class_ in self.classes:
-            if class_.implements:
-                for parent in class_.implements:
-                    if not isinstance(parent.prefix, str):
-                        parent.prefix = self.metadata.prefix
-            if class_.class_.prefix is Undefined:
-                class_.class_.prefix = self.metadata.prefix
-
-        return self
-
-    @model_validator(mode="after")
-    def post_validation(self) -> "InformationRules":
-        from ._validation import InformationPostValidation
-
-        issue_list = InformationPostValidation(self).validate()
-        if issue_list.warnings:
-            issue_list.trigger_warnings()
-        if issue_list.has_errors:
-            raise issue_list.as_exception()
-        return self
-
     def as_dms_rules(self) -> "DMSRules":
         from cognite.neat._rules.transformers._converters import _InformationRulesConverter
 

cognite/neat/_rules/models/information/_validation.py

@@ -1,17 +1,17 @@
 import itertools
 from collections import Counter
-from typing import cast
 
 from cognite.neat._issues import IssueList
-from cognite.neat._issues.errors import NeatValueError, ResourceNotDefinedError
+from cognite.neat._issues.errors import NeatValueError
 from cognite.neat._issues.warnings._models import UndefinedClassWarning
+from cognite.neat._issues.warnings._resources import ResourceNotDefinedWarning
 from cognite.neat._rules._constants import EntityTypes
 from cognite.neat._rules.models.entities import ClassEntity, UnknownEntity
 
 from ._rules import InformationRules
 
 
-class InformationPostValidation:
+class InformationValidation:
     """This class does all the validation of the Information rules that have dependencies
     between components."""
 
@@ -44,10 +44,10 @@ class InformationPostValidation:
                 # same prefix, meaning same space
                 if not class_parent_pairs[class_] and class_.prefix == self.metadata.prefix:
                     self.issue_list.append(
-                        ResourceNotDefinedError[ClassEntity](
+                        ResourceNotDefinedWarning(
                             resource_type="class",
                             identifier=class_,
-                            location="Classes sheet",
+                            location="Properties sheet",
                         )
                     )
 
@@ -63,7 +63,7 @@ class InformationPostValidation:
                     self.issue_list.append(UndefinedClassWarning(class_id=str(parent)))
                 else:
                     self.issue_list.append(
-                        ResourceNotDefinedError[ClassEntity](
+                        ResourceNotDefinedWarning(
                             resource_type="class",
                             identifier=parent,
                             location="Classes sheet",
@@ -79,7 +79,7 @@ class InformationPostValidation:
         if missing_classes := classes_with_explicit_properties.difference(defined_classes):
             for class_ in missing_classes:
                 self.issue_list.append(
-                    ResourceNotDefinedError[ClassEntity](
+                    ResourceNotDefinedWarning(
                         resource_type="class",
                         identifier=class_,
                         location="Classes sheet",
@@ -99,9 +99,9 @@ class InformationPostValidation:
             # Todo: include row and column number
             for missing in missing_value_types:
                 self.issue_list.append(
-                    ResourceNotDefinedError[ClassEntity](
+                    ResourceNotDefinedWarning(
                         resource_type="class",
-                        identifier=cast(ClassEntity, missing),
+                        identifier=missing,
                         location="Classes sheet",
                     )
                 )

cognite/neat/_rules/models/mapping/__init__.py

@@ -1,4 +1,3 @@
-from ._base import Mapping, MappingList, RuleMapping
-from ._classic2core import create_classic_to_core_mapping
+from ._classic2core import load_classic_to_core_mapping
 
-__all__ = ["RuleMapping", "Mapping", "MappingList", "create_classic_to_core_mapping"]
+__all__ = ["load_classic_to_core_mapping"]

cognite/neat/_rules/models/mapping/_classic2core.py

@@ -1,150 +1,40 @@
-from ._base import RuleMapping
+from functools import lru_cache
+from pathlib import Path
 
+import yaml
 
-def create_classic_to_core_mapping() -> RuleMapping:
-    return RuleMapping.model_validate(_CLASSIC_TO_CORE)
+from cognite.neat._issues.errors import NeatValueError
+from cognite.neat._rules._shared import ReadRules
+from cognite.neat._rules.models.dms import DMSInputRules, DMSRules
 
+_CLASSIC_TO_CORE_MAPPING = Path(__file__).resolve().parent / "_classic2core.yaml"
 
-_CLASSIC_TO_CORE = {
-    "classes": [
-        {"destination": {"Class": "cdf_cdm:CogniteAsset"}, "source": {"Class": "classic:Asset"}},
-        {"destination": {"Class": "cdf_cdm:DataProduct"}, "source": {"Class": "classic:DataSet"}},
-        {"destination": {"Class": "cdf_cdm:CogniteActivity"}, "source": {"Class": "classic:Event"}},
-        {"destination": {"Class": "cdf_cdm:CogniteFile"}, "source": {"Class": "classic:File"}},
-        {"destination": {"Class": "cdf_cdm:CogniteTimeSeries"}, "source": {"Class": "classic:TimeSeries"}},
-    ],
-    "properties": [
-        {
-            "destination": {"Class": "cdf_cdm:CogniteAsset", "Property": "externalId"},
-            "source": {"Class": "classic:Asset", "Property": "externalId"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteAsset", "Property": "name"},
-            "source": {"Class": "classic:Asset", "Property": "name"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteAsset", "Property": "parent"},
-            "source": {"Class": "classic:Asset", "Property": "parentId"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteAsset", "Property": "description"},
-            "source": {"Class": "classic:Asset", "Property": "description"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteSourceSystem", "Property": "name"},
-            "source": {"Class": "classic:Asset", "Property": "source"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteAsset", "Property": "tag"},
-            "source": {"Class": "classic:Asset", "Property": "labels"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:DataProduct", "Property": "externalId"},
-            "source": {"Class": "classic:DataSet", "Property": "externalId"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:DataProduct", "Property": "name"},
-            "source": {"Class": "classic:DataSet", "Property": "name"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:DataProduct", "Property": "description"},
-            "source": {"Class": "classic:DataSet", "Property": "description"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:DataProduct", "Property": "metadata"},
-            "source": {"Class": "classic:DataSet", "Property": "metadata"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:DataProduct", "Property": "writeProtected"},
-            "source": {"Class": "classic:DataSet", "Property": "writeProtected"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteActivity", "Property": "externalId"},
-            "source": {"Class": "classic:Event", "Property": "externalId"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteSchedulable", "Property": "startTime"},
-            "source": {"Class": "classic:Event", "Property": "startTime"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteSchedulable", "Property": "endTime"},
-            "source": {"Class": "classic:Event", "Property": "endTime"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteActivity", "Property": "description"},
-            "source": {"Class": "classic:Event", "Property": "description"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteActivity", "Property": "assets"},
-            "source": {"Class": "classic:Event", "Property": "assetIds"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteSourceSystem", "Property": "name"},
-            "source": {"Class": "classic:Event", "Property": "source"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteFile", "Property": "externalId"},
-            "source": {"Class": "classic:File", "Property": "externalId"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteFile", "Property": "name"},
-            "source": {"Class": "classic:File", "Property": "name"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteFile", "Property": "directory"},
-            "source": {"Class": "classic:File", "Property": "directory"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteSourceSystem", "Property": "name"},
-            "source": {"Class": "classic:File", "Property": "source"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteFile", "Property": "mimeType"},
-            "source": {"Class": "classic:File", "Property": "mimeType"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteFile", "Property": "assets"},
-            "source": {"Class": "classic:File", "Property": "assetIds"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteFile", "Property": "sourceCreatedTime"},
-            "source": {"Class": "classic:File", "Property": "sourceCreatedTime"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteFile", "Property": "sourceUpdatedTime"},
-            "source": {"Class": "classic:File", "Property": "sourceModifiedTime"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteTimeSeries", "Property": "externalId"},
-            "source": {"Class": "classic:TimeSeries", "Property": "externalId"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteTimeSeries", "Property": "name"},
-            "source": {"Class": "classic:TimeSeries", "Property": "name"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteTimeSeries", "Property": "type"},
-            "source": {"Class": "classic:TimeSeries", "Property": "isString"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteTimeSeries", "Property": "sourceUnit"},
-            "source": {"Class": "classic:TimeSeries", "Property": "unit"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteTimeSeries", "Property": "unit"},
-            "source": {"Class": "classic:TimeSeries", "Property": "unitExternalId"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteTimeSeries", "Property": "assets"},
-            "source": {"Class": "classic:TimeSeries", "Property": "assetId"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteTimeSeries", "Property": "isStep"},
-            "source": {"Class": "classic:TimeSeries", "Property": "isStep"},
-        },
-        {
-            "destination": {"Class": "cdf_cdm:CogniteTimeSeries", "Property": "description"},
-            "source": {"Class": "classic:TimeSeries", "Property": "description"},
-        },
-    ],
-}
+
+@lru_cache(maxsize=1)
+def _read_source_file() -> str:
+    return _CLASSIC_TO_CORE_MAPPING.read_text()
+
+
+def load_classic_to_core_mapping(org_name: str, source_space: str, source_version: str) -> DMSRules:
+    if not org_name:
+        raise NeatValueError("Organization name must be provided.")
+
+    from cognite.neat._rules.importers import YAMLImporter
+    from cognite.neat._rules.transformers import VerifyDMSRules
+
+    raw_str = _read_source_file().replace("Classic", org_name)
+
+    loaded = yaml.safe_load(raw_str)
+    loaded["metadata"]["space"] = source_space
+    loaded["metadata"]["version"] = source_version
+
+    read: ReadRules[DMSInputRules] = YAMLImporter(loaded).to_rules()
+    if not isinstance(read.rules, DMSInputRules):
+        raise NeatValueError(f"Expected DMS rules, but got {type(read.rules).__name__}")
+
+    verified = VerifyDMSRules(errors="raise", validate=False).transform(read)
+
+    if verified.rules is None:
+        raise NeatValueError("Failed to verify the rules.")
+
+    return verified.rules