cognite-neat 0.72.3__tar.gz → 0.73.1__tar.gz

{cognite_neat-0.72.3 → cognite_neat-0.73.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cognite-neat
-Version: 0.72.3
+Version: 0.73.1
 Summary: Knowledge graph transformation
 Home-page: https://cognite-neat.readthedocs-hosted.com/
 License: Apache-2.0
@@ -19,7 +19,7 @@ Provides-Extra: graphql
 Provides-Extra: oxi
 Requires-Dist: PyYAML
 Requires-Dist: backports.strenum (>=1.2,<2.0) ; python_version < "3.11"
-Requires-Dist: cognite-sdk (>=7.28.2,<8.0.0)
+Requires-Dist: cognite-sdk (>=7.37.0,<8.0.0)
 Requires-Dist: deepdiff
 Requires-Dist: exceptiongroup (>=1.1.3,<2.0.0) ; python_version < "3.11"
 Requires-Dist: fastapi (>=0.100,<0.101)

cognite_neat-0.73.1/cognite/neat/_version.py

@@ -0,0 +1 @@
+__version__ = "0.73.1"

{cognite_neat-0.72.3 → cognite_neat-0.73.1}/cognite/neat/graph/extractor/_dexpi.py

@@ -103,6 +103,10 @@ def _add_node_label(id_: str, nodes: dict, element: Element) -> dict:
         if grandchildren := get_children(children[0], "Text", 1):
             if "String" in grandchildren[0].attrib:
                 nodes[id_]["header"]["label"] = grandchildren[0].attrib["String"]
+    # extension for schema version 3.3, where text is used to "label" without a <label> parent
+    elif children := get_children(element, "Text", 1):
+        if "String" in children[0].attrib:
+            nodes[id_]["header"]["label"] = children[0].attrib["String"]
 
     return nodes
 
@@ -111,10 +115,14 @@ def _add_node_generic_attributes(id_: str, nodes: dict, element: Element) -> dic
     if children := get_children(element, "GenericAttributes", 1):
         if grandchildren := get_children(children[0], "GenericAttribute"):
             for generic_attribute in grandchildren:
-                if generic_attribute.attrib["AttributeURI"] not in nodes[id_]:
-                    nodes[id_]["attributes"][generic_attribute.attrib["AttributeURI"]] = [generic_attribute.attrib]
-                else:
-                    nodes[id_]["attributes"][generic_attribute.attrib["AttributeURI"]].append(generic_attribute.attrib)
+                # extension for schema version 3.3, where "AttributeURI" is not included
+                if "AttributeURI" in generic_attribute.attrib:
+                    if generic_attribute.attrib["AttributeURI"] not in nodes[id_]:
+                        nodes[id_]["attributes"][generic_attribute.attrib["AttributeURI"]] = [generic_attribute.attrib]
+                    else:
+                        nodes[id_]["attributes"][generic_attribute.attrib["AttributeURI"]].append(
+                            generic_attribute.attrib
+                        )
 
     return nodes
 

{cognite_neat-0.72.3 → cognite_neat-0.73.1}/cognite/neat/graph/extractor/_graph_capturing_sheet.py

@@ -11,6 +11,7 @@ from openpyxl.cell import Cell
 from openpyxl.styles import Alignment, Border, Font, NamedStyle, PatternFill, Side
 from openpyxl.utils import get_column_letter
 from openpyxl.worksheet.datavalidation import DataValidation
+from openpyxl.worksheet.worksheet import Worksheet
 from rdflib import RDF, XSD, Literal, Namespace, URIRef
 
 from cognite.neat.graph import exceptions
@@ -321,7 +322,7 @@ def rules2graph_capturing_sheet(
         workbook.create_sheet(title=class_)
 
         # Add header rows
-        workbook[class_].append(["identifier", *list(properties.keys())])
+        cast(Worksheet, workbook[class_]).append(["identifier", *list(properties.keys())])
 
         if auto_identifier_type and auto_identifier_type == "index-based":  # default, easy to read
             logging.debug(f"Configuring index-based automatic identifiers for sheet {class_}")
@@ -350,35 +351,35 @@ def _add_index_identifiers(workbook: Workbook, sheet: str, no_rows: int):
     """Adds index-based auto identifier to a sheet identifier column"""
     for i in range(no_rows):
         prefix = to_dms_name(sheet, "class", True)
-        workbook[sheet][f"A{i+2}"] = f'=IF(ISBLANK(B{i+2}), "","{prefix}-{i+1}")'
+        workbook[sheet][f"A{i+2}"] = f'=IF(ISBLANK(B{i+2}), "","{prefix}-{i+1}")'  # type: ignore[index]
 
 
 def _add_uuid_identifiers(workbook: Workbook, sheet: str, no_rows: int):
     """Adds UUID-based auto identifier to a sheet identifier column"""
     for i in range(no_rows):
         prefix = to_dms_name(sheet, "class", True)
-        workbook[sheet][f"A{i+2}"] = f'=IF(ISBLANK(B{i+2}), "","{prefix}-{uuid.uuid4()}")'
+        workbook[sheet][f"A{i+2}"] = f'=IF(ISBLANK(B{i+2}), "","{prefix}-{uuid.uuid4()}")'  # type: ignore[index]
 
 
 def _add_drop_down_list(workbook: Workbook, sheet: str, column: str, no_rows: int, value_sheet: str, value_column: str):
     """Adds a drop down list to a column"""
     drop_down_list = DataValidation(type="list", formula1=f"={value_sheet}!{value_column}$2:{value_column}${no_rows}")
 
-    workbook[sheet].add_data_validation(drop_down_list)
+    cast(Worksheet, workbook[sheet]).add_data_validation(drop_down_list)
 
     for i in range(no_rows):
-        drop_down_list.add(workbook[sheet][f"{column}{i+2}"])
+        drop_down_list.add(workbook[sheet][f"{column}{i+2}"])  # type: ignore[index, misc]
 
 
 def _adjust_column_width(workbook: Workbook):
     """Adjusts the column width based on the content"""
     for sheet in workbook.sheetnames:
-        for cell_tuple in workbook[sheet].columns:
+        for cell_tuple in cast(Worksheet, workbook[sheet]).columns:
             # Wrong type annotation in openpyxl
             cell = cast(Cell, cell_tuple[0])  # type: ignore[index]
             if cell.value:
                 adjusted_width = (len(str(cell.value)) + 5) * 1.2
-                workbook[sheet].column_dimensions[cell.column_letter].width = adjusted_width
+                cast(Worksheet, workbook[sheet]).column_dimensions[cell.column_letter].width = adjusted_width
 
 
 def _set_header_style(workbook: Workbook):
@@ -390,12 +391,13 @@ def _set_header_style(workbook: Workbook):
     workbook.add_named_style(style)
 
     for sheet in workbook.sheetnames:
-        for cell_tuple in workbook[sheet].columns:
+        for cell_tuple in cast(Worksheet, workbook[sheet]).columns:
             # Wrong type annotation in openpyxl
             cell = cast(Cell, cell_tuple[0])  # type: ignore[index]
-            workbook[sheet][f"{cell.column_letter}1"].style = style
+            worksheet = cast(Worksheet, workbook[sheet])
+            worksheet[f"{cell.column_letter}1"].style = style
             if f"{cell.column_letter}1" == "A1":
-                workbook[sheet][f"{cell.column_letter}1"].fill = PatternFill("solid", start_color="2FB5F2")
+                worksheet[f"{cell.column_letter}1"].fill = PatternFill("solid", start_color="2FB5F2")
             else:
-                workbook[sheet][f"{cell.column_letter}1"].fill = PatternFill("solid", start_color="FFB202")
-            workbook[sheet][f"{cell.column_letter}1"].alignment = Alignment(horizontal="center", vertical="center")
+                worksheet[f"{cell.column_letter}1"].fill = PatternFill("solid", start_color="FFB202")
+            worksheet[f"{cell.column_letter}1"].alignment = Alignment(horizontal="center", vertical="center")

{cognite_neat-0.72.3 → cognite_neat-0.73.1}/cognite/neat/rules/examples/power-grid-containers.yaml

@@ -53,6 +53,7 @@
       type:
         container: null
         type: direct
+        list: false
   space: workshop
   usedFor: node
 - externalId: SubGeographicalRegion
@@ -81,6 +82,7 @@
       type:
         container: null
         type: direct
+        list: false
   space: workshop
   usedFor: node
 - externalId: Substation
@@ -109,5 +111,6 @@
       type:
         container: null
         type: direct
+        list: false
   space: workshop
   usedFor: node

{cognite_neat-0.72.3 → cognite_neat-0.73.1}/cognite/neat/rules/examples/power-grid-model.yaml

@@ -81,6 +81,7 @@ views:
         type:
           container: null
           type: direct
+          list: false
           source:
             space: workshop
             externalId: GeographicalRegion
@@ -132,6 +133,7 @@ views:
         type:
           container: null
           type: direct
+          list: false
           source:
             space: workshop
             externalId: SubGeographicalRegion
@@ -195,6 +197,7 @@ views:
         type:
           container: null
           type: direct
+          list: false
           source:
             space: workshop
             externalId: Substation

{cognite_neat-0.72.3 → cognite_neat-0.73.1}/cognite/neat/rules/exporter/_rules2dms.py

@@ -34,7 +34,6 @@ from cognite.client.data_classes.data_modeling import (
     ViewApply,
     ViewId,
 )
-from cognite.client.data_classes.data_modeling.data_types import ListablePropertyType
 from cognite.client.data_classes.data_modeling.views import (
     ConnectionDefinitionApply,
     SingleHopConnectionDefinitionApply,
@@ -284,12 +283,9 @@ class DMSSchemaComponents(BaseModel):
                     if (
                         not isinstance(existing_property.type, DirectRelation)
                         and not isinstance(api_container_property.type, DirectRelation)
-                        and cast(ListablePropertyType, existing_property.type).is_list
-                        != cast(ListablePropertyType, api_container_property.type).is_list
+                        and existing_property.type.is_list != api_container_property.type.is_list
                     ):
-                        cast(
-                            ListablePropertyType, containers[container_id].properties[container_property_id].type
-                        ).is_list = True
+                        containers[container_id].properties[container_property_id].type.is_list = True
 
         if errors:
             raise ExceptionGroup("Properties value types have been redefined! This is prohibited! Aborting!", errors)
@@ -302,10 +298,7 @@ class DMSSchemaComponents(BaseModel):
 
         # Literal, i.e. Node attribute
         if property_.property_type is EntityTypes.data_property:
-            property_type = cast(
-                type[ListablePropertyType],
-                cast(ValueTypeMapping, property_.expected_value_type.mapping).dms,
-            )
+            property_type = cast(ValueTypeMapping, property_.expected_value_type.mapping).dms
             return ContainerProperty(
                 type=property_type(is_list=is_one_to_many),
                 nullable=property_.min_count == 0,

{cognite_neat-0.72.3 → cognite_neat-0.73.1}/cognite/neat/rules/exporter/_rules2excel.py

@@ -4,6 +4,7 @@ from typing import cast
 from openpyxl import Workbook
 from openpyxl.cell import Cell
 from openpyxl.styles import Alignment, Border, Font, NamedStyle, PatternFill, Side
+from openpyxl.worksheet.worksheet import Worksheet
 
 from cognite.neat.rules.models._base import EntityTypes
 
@@ -190,7 +191,7 @@ class ExcelExporter(BaseExporter[Workbook]):
             if sheet == "Metadata":
                 continue
             if sheet == "Classes" or sheet == "Properties":
-                sheet_obj = data[sheet]
+                sheet_obj = cast(Worksheet, data[sheet])
                 if sheet == "Classes":
                     sheet_obj.freeze_panes = "A3"
                 else:
@@ -207,6 +208,6 @@ class ExcelExporter(BaseExporter[Workbook]):
                     cell.fill = PatternFill("solid", start_color="D5DBD5")
                     cell.alignment = Alignment(horizontal="center", vertical="center")
                     adjusted_width = (len(str(cell.value)) + 5) * 1.2
-                    data[sheet].column_dimensions[cell.column_letter].width = adjusted_width
+                    cast(Worksheet, data[sheet]).column_dimensions[cell.column_letter].width = adjusted_width
 
         return data

{cognite_neat-0.72.3 → cognite_neat-0.73.1}/cognite/neat/rules/exporters/_rules2excel.py

@@ -1,16 +1,19 @@
 from __future__ import annotations
 
 import itertools
+from datetime import datetime
 from pathlib import Path
 from types import GenericAlias
-from typing import Any, ClassVar, Literal, get_args
+from typing import Any, ClassVar, Literal, cast, get_args
 
 from openpyxl import Workbook
 from openpyxl.cell import MergedCell
 from openpyxl.styles import Alignment, Border, Font, PatternFill, Side
+from openpyxl.worksheet.worksheet import Worksheet
 
 from cognite.neat.rules._shared import Rules
-from cognite.neat.rules.models._rules.base import RoleTypes, SheetEntity
+from cognite.neat.rules.models._rules import DMSRules, DomainRules, InformationRules
+from cognite.neat.rules.models._rules.base import RoleTypes, SchemaCompleteness, SheetEntity
 
 from ._base import BaseExporter
 
@@ -23,6 +26,9 @@ class ExcelExporter(BaseExporter[Workbook]):
             on the different styles.
         output_role: The role to use for the exported spreadsheet. If provided, the rules will be converted to
             this role formate before being written to excel. If not provided, the role from the rules will be used.
+        new_model_id: The new model ID to use for the exported spreadsheet. This is only applicable if the input
+            rules have 'is_reference' set. If provided, the model ID will be used to automatically create the
+            new metadata sheet in the Excel file.
 
     The following styles are available:
 
@@ -43,12 +49,18 @@ class ExcelExporter(BaseExporter[Workbook]):
     }
     style_options = get_args(Style)
 
-    def __init__(self, styling: Style = "default", output_role: RoleTypes | None = None):
+    def __init__(
+        self,
+        styling: Style = "default",
+        output_role: RoleTypes | None = None,
+        new_model_id: tuple[str, str, str] | None = None,
+    ):
         if styling not in self.style_options:
             raise ValueError(f"Invalid styling: {styling}. Valid options are {self.style_options}")
         self.styling = styling
         self._styling_level = self.style_options.index(styling)
         self.output_role = output_role
+        self.new_model_id = new_model_id
 
     def export_to_file(self, rules: Rules, filepath: Path) -> None:
         """Exports transformation rules to excel file."""
@@ -70,7 +82,7 @@ class ExcelExporter(BaseExporter[Workbook]):
         if rules.is_reference:
             # Writes empty reference sheets
             dumped_rules = {
-                "Metadata": {field_alias: None for field_alias in rules.metadata.model_dump(by_alias=True).keys()},
+                "Metadata": self._create_metadata_sheet_user_rules(rules),
             }
             dumped_rules["Metadata"]["role"] = (
                 self.output_role and self.output_role.value
@@ -155,6 +167,12 @@ class ExcelExporter(BaseExporter[Workbook]):
                     cell.font = Font(bold=True, size=14)
 
     def _write_metadata_sheet(self, workbook: Workbook, metadata: dict[str, Any], is_reference: bool = False) -> None:
+        # Excel does not support timezone in datetime strings
+        if isinstance(metadata.get("created"), datetime):
+            metadata["created"] = metadata["created"].replace(tzinfo=None)
+        if isinstance(metadata.get("updated"), datetime):
+            metadata["updated"] = metadata["updated"].replace(tzinfo=None)
+
         if is_reference:
             metadata_sheet = workbook.create_sheet("RefMetadata")
         else:
@@ -181,6 +199,7 @@ class ExcelExporter(BaseExporter[Workbook]):
     @classmethod
     def _adjust_column_widths(cls, workbook: Workbook) -> None:
         for sheet in workbook:
+            sheet = cast(Worksheet, sheet)
             for column_cells in sheet.columns:
                 try:
                     max_length = max(len(str(cell.value)) for cell in column_cells if cell.value is not None)
@@ -194,3 +213,74 @@ class ExcelExporter(BaseExporter[Workbook]):
                 current = sheet.column_dimensions[selected_column.column_letter].width or (max_length + 0.5)
                 sheet.column_dimensions[selected_column.column_letter].width = max(current, max_length + 0.5)
         return None
+
+    def _create_metadata_sheet_user_rules(self, rules: Rules) -> dict[str, Any]:
+        metadata: dict[str, Any] = {
+            field_alias: None for field_alias in rules.metadata.model_dump(by_alias=True).keys()
+        }
+        if "creator" in metadata:
+            metadata["creator"] = "YOUR NAME"
+
+        if isinstance(rules, DomainRules):
+            return metadata
+        elif isinstance(rules, DMSRules):
+            existing_model_id = (rules.metadata.space, rules.metadata.external_id, rules.metadata.version)
+        elif isinstance(rules, InformationRules):
+            existing_model_id = (rules.metadata.prefix, rules.metadata.name, rules.metadata.version)
+        else:
+            raise ValueError(f"Unsupported rules type: {type(rules)}")
+        existing_metadata = rules.metadata.model_dump(by_alias=True)
+        if isinstance(existing_metadata["created"], datetime):
+            metadata["created"] = existing_metadata["created"].replace(tzinfo=None)
+        if isinstance(existing_metadata["updated"], datetime):
+            metadata["updated"] = existing_metadata["updated"].replace(tzinfo=None)
+        # Excel does not support timezone in datetime strings
+        now_iso = datetime.now().replace(tzinfo=None).isoformat()
+        is_info = isinstance(rules, InformationRules)
+        is_dms = not is_info
+        is_extension = self.new_model_id is not None
+        is_solution = is_extension and self.new_model_id != existing_model_id
+
+        if is_solution:
+            metadata["prefix" if is_info else "space"] = self.new_model_id[0]  # type: ignore[index]
+            metadata["title" if is_info else "externalId"] = self.new_model_id[1]  # type: ignore[index]
+            metadata["version"] = self.new_model_id[2]  # type: ignore[index]
+        else:
+            metadata["prefix" if is_info else "space"] = existing_model_id[0]
+            metadata["title" if is_info else "externalId"] = existing_model_id[1]
+            metadata["version"] = existing_model_id[2]
+
+        if is_solution and is_info:
+            metadata["namespace"] = f"http://purl.org/{self.new_model_id[0]}/"  # type: ignore[index]
+        elif is_info:
+            metadata["namespace"] = existing_metadata["namespace"]
+
+        if is_solution and is_dms:
+            metadata["name"] = self.new_model_id[1]  # type: ignore[index]
+
+        if is_solution:
+            metadata["created"] = now_iso
+        else:
+            metadata["created"] = existing_metadata["created"]
+
+        if is_solution or is_extension:
+            metadata["updated"] = now_iso
+        else:
+            metadata["updated"] = existing_metadata["updated"]
+
+        if is_solution:
+            metadata["creator"] = "YOUR NAME"
+        else:
+            metadata["creator"] = existing_metadata["creator"]
+
+        if not is_solution:
+            metadata["description"] = existing_metadata["description"]
+
+        if is_extension:
+            metadata["schema"] = SchemaCompleteness.extended.value
+        else:
+            metadata["schema"] = SchemaCompleteness.complete.value
+
+        metadata["extension"] = "addition"
+
+        return metadata

{cognite_neat-0.72.3 → cognite_neat-0.73.1}/cognite/neat/rules/importer/_dms2rules.py

@@ -13,7 +13,6 @@ from cognite.client.data_classes.data_modeling import (
     SingleHopConnectionDefinition,
     View,
 )
-from cognite.client.data_classes.data_modeling.data_types import ListablePropertyType
 from cognite.client.data_classes.data_modeling.ids import DataModelIdentifier, ViewId
 
 from cognite.neat.rules.models.tables import Tables
@@ -132,9 +131,7 @@ class DMSImporter(BaseImporter):
 
                 max_count: str | float = "1"
                 if isinstance(prop, SingleHopConnectionDefinition) or (
-                    isinstance(prop, MappedProperty)
-                    and isinstance(prop.type, ListablePropertyType)
-                    and prop.type.is_list
+                    isinstance(prop, MappedProperty) and prop.type.is_list
                 ):
                     max_count = float("nan")
 

{cognite_neat-0.72.3 → cognite_neat-0.73.1}/cognite/neat/rules/importers/_dms2rules.py

@@ -5,9 +5,10 @@ from cognite.client import CogniteClient
 from cognite.client import data_modeling as dm
 from cognite.client.data_classes.data_modeling import DataModelIdentifier
 from cognite.client.data_classes.data_modeling.containers import BTreeIndex, InvertedIndex
-from cognite.client.data_classes.data_modeling.data_types import ListablePropertyType
+from cognite.client.utils import ms_to_datetime
 
 from cognite.neat.rules import issues
+from cognite.neat.rules.importers._base import BaseImporter, Rules
 from cognite.neat.rules.issues import IssueList
 from cognite.neat.rules.models._rules import DMSRules, DMSSchema, RoleTypes
 from cognite.neat.rules.models._rules._types import (
@@ -19,6 +20,7 @@ from cognite.neat.rules.models._rules._types import (
     ViewEntity,
     ViewPropEntity,
 )
+from cognite.neat.rules.models._rules.base import ExtensionCategory, SchemaCompleteness
 from cognite.neat.rules.models._rules.dms_architect_rules import (
     DMSContainer,
     DMSMetadata,
@@ -27,16 +29,47 @@ from cognite.neat.rules.models._rules.dms_architect_rules import (
     SheetList,
 )
 
-from ._base import BaseImporter, Rules
-
 
 class DMSImporter(BaseImporter):
-    def __init__(self, schema: DMSSchema):
+    def __init__(self, schema: DMSSchema, metadata: DMSMetadata | None = None):
         self.schema = schema
+        self.metadata = metadata
 
     @classmethod
     def from_data_model_id(cls, client: CogniteClient, data_model_id: DataModelIdentifier) -> "DMSImporter":
-        return cls(DMSSchema.from_model_id(client, data_model_id))
+        """Create a DMSImporter ready to convert the given data model to rules.
+
+        Args:
+            client: Instantiated CogniteClient to retrieve data model.
+            data_model_id: Data Model to retrieve.
+
+        Returns:
+            DMSImporter: DMSImporter instance
+        """
+        data_models = client.data_modeling.data_models.retrieve(data_model_id, inline_views=True)
+        if len(data_models) == 0:
+            raise ValueError(f"Data model {data_model_id} not found")
+        data_model = data_models.latest_version()
+        schema = DMSSchema.from_data_model(client, data_model)
+        description, creator = DMSMetadata._get_description_and_creator(data_model.description)
+
+        created = ms_to_datetime(data_model.created_time)
+        updated = ms_to_datetime(data_model.last_updated_time)
+
+        metadata = DMSMetadata(
+            schema_=SchemaCompleteness.complete,
+            extension=ExtensionCategory.addition,
+            space=data_model.space,
+            external_id=data_model.external_id,
+            name=data_model.name or data_model.external_id,
+            version=data_model.version or "0.1.0",
+            updated=updated,
+            created=created,
+            creator=creator,
+            description=description,
+            default_view_version=data_model.version or "0.1.0",
+        )
+        return cls(schema, metadata)
 
     @classmethod
     def from_directory(cls, directory: str | Path) -> "DMSImporter":
@@ -138,11 +171,7 @@ class DMSImporter(BaseImporter):
                             description=prop.description,
                             value_type=cast(ViewPropEntity | DMSValueType, container_prop.type._type),
                             nullable=container_prop.nullable,
-                            is_list=(
-                                container_prop.type.is_list
-                                if isinstance(container_prop.type, ListablePropertyType)
-                                else False
-                            ),
+                            is_list=container_prop.type.is_list,
                             default=container_prop.default_value,
                             container=ContainerEntity.from_id(container.as_id()),
                             container_property=prop.container_property_identifier,
@@ -172,7 +201,7 @@ class DMSImporter(BaseImporter):
         }
 
         dms_rules = DMSRules(
-            metadata=DMSMetadata.from_data_model(data_model),
+            metadata=self.metadata or DMSMetadata.from_data_model(data_model),
             properties=properties,
             containers=SheetList[DMSContainer](
                 data=[DMSContainer.from_container(container) for container in self.schema.containers]

{cognite_neat-0.72.3 → cognite_neat-0.73.1}/cognite/neat/rules/issues/base.py

@@ -68,7 +68,15 @@ class NeatValidationError(ValidationIssue, ABC):
 
         This is intended to be overridden in subclasses to handle specific error types.
         """
-        return [DefaultPydanticError.from_pydantic_error(error) for error in errors]
+        all_errors = []
+        for error in errors:
+            if isinstance(ctx := error.get("ctx"), dict) and isinstance(
+                multi_error := ctx.get("error"), MultiValueError
+            ):
+                all_errors.extend(multi_error.errors)
+            else:
+                all_errors.append(DefaultPydanticError.from_pydantic_error(error))
+        return all_errors
 
 
 @dataclass(frozen=True)

{cognite_neat-0.72.3 → cognite_neat-0.73.1}/cognite/neat/rules/issues/dms.py

@@ -26,6 +26,8 @@ __all__ = [
     "MultipleReferenceWarning",
     "HasDataFilterOnNoPropertiesViewWarning",
     "NodeTypeFilterOnParentViewWarning",
+    "ChangingContainerError",
+    "ChangingViewError",
 ]
 
 
@@ -225,6 +227,78 @@ class ContainerPropertyUsedMultipleTimesError(DMSSchemaError):
         return output
 
 
+@dataclass(frozen=True)
+class ChangingContainerError(DMSSchemaError):
+    description = "You are adding to an existing model. "
+    fix = "Keep the container the same"
+    error_name: ClassVar[str] = "ChangingContainerError"
+    container_id: dm.ContainerId
+    changed_properties: list[str] | None = None
+    changed_attributes: list[str] | None = None
+
+    def __post_init__(self):
+        # Sorting for deterministic output
+        if self.changed_properties:
+            self.changed_properties.sort()
+        if self.changed_attributes:
+            self.changed_attributes.sort()
+
+    def message(self) -> str:
+        if self.changed_properties:
+            changed = f" properties {self.changed_properties}."
+        elif self.changed_attributes:
+            changed = f" attributes {self.changed_attributes}."
+        else:
+            changed = "."
+        return (
+            f"The container {self.container_id} has changed{changed}"
+            "When extending model with extension set to addition or reshape, the container "
+            "properties must remain the same"
+        )
+
+    def dump(self) -> dict[str, Any]:
+        output = super().dump()
+        output["container_id"] = self.container_id.dump()
+        output["changed_properties"] = self.changed_properties
+        return output
+
+
+@dataclass(frozen=True)
+class ChangingViewError(DMSSchemaError):
+    description = "You are adding to an existing model. "
+    fix = "Keep the view the same"
+    error_name: ClassVar[str] = "ChangingViewError"
+    view_id: dm.ViewId
+    changed_properties: list[str] | None = None
+    changed_attributes: list[str] | None = None
+
+    def __post_init__(self):
+        # Sorting for deterministic output
+        if self.changed_properties:
+            self.changed_properties.sort()
+        if self.changed_attributes:
+            self.changed_attributes.sort()
+
+    def message(self) -> str:
+        if self.changed_properties:
+            changed = f" properties {self.changed_properties}."
+        elif self.changed_attributes:
+            changed = f" attributes {self.changed_attributes}."
+        else:
+            changed = "."
+
+        return (
+            f"The view {self.view_id} has changed{changed}"
+            "When extending model with extension set to addition, the view properties must remain the same"
+        )
+
+    def dump(self) -> dict[str, Any]:
+        output = super().dump()
+        output["view_id"] = self.view_id.dump()
+        output["difference"] = self.changed_properties
+        return output
+
+
 @dataclass(frozen=True)
 class DirectRelationListWarning(DMSSchemaWarning):
     description = "The container property is set to a direct relation list, which is not supported by the CDF API"

{cognite_neat-0.72.3 → cognite_neat-0.73.1}/cognite/neat/rules/models/_rules/base.py

@@ -10,10 +10,21 @@ import types
 from abc import abstractmethod
 from collections.abc import Callable, Iterator
 from functools import wraps
-from typing import Any, ClassVar, Generic, TypeAlias, TypeVar
+from typing import Annotated, Any, ClassVar, Generic, TypeAlias, TypeVar
 
 import pandas as pd
-from pydantic import BaseModel, ConfigDict, Field, HttpUrl, constr, field_validator, model_serializer, model_validator
+from pydantic import (
+    BaseModel,
+    BeforeValidator,
+    ConfigDict,
+    Field,
+    HttpUrl,
+    PlainSerializer,
+    constr,
+    field_validator,
+    model_serializer,
+    model_validator,
+)
 from pydantic.fields import FieldInfo
 
 from cognite.neat.rules.models._rules._types import ClassType
@@ -318,3 +329,14 @@ class SheetList(BaseModel, Generic[T_Entity]):
     def mandatory_fields(cls, use_alias=False) -> set[str]:
         """Returns a set of mandatory fields for the model."""
         return _get_required_fields(cls, use_alias)
+
+
+ExtensionCategoryType = Annotated[
+    ExtensionCategory,
+    PlainSerializer(
+        lambda v: v.value if isinstance(v, ExtensionCategory) else v,
+        return_type=str,
+        when_used="unless-none",
+    ),
+    BeforeValidator(lambda v: ExtensionCategory(v) if isinstance(v, str) else v),
+]