cognite-neat 0.75.9__py3-none-any.whl → 0.76.0__py3-none-any.whl

cognite/neat/_version.py

@@ -1 +1 @@
-__version__ = "0.75.9"
+__version__ = "0.76.0"

cognite/neat/rules/exporters/_models.py

@@ -2,6 +2,8 @@ from abc import ABC
 from dataclasses import dataclass, field
 from functools import total_ordering
 
+from cognite.neat.rules.issues import IssueList
+
 
 @total_ordering
 @dataclass
@@ -32,6 +34,7 @@ class UploadResult(UploadResultCore):
     failed_changed: int = 0
     failed_deleted: int = 0
     error_messages: list[str] = field(default_factory=list)
+    issues: IssueList = field(default_factory=IssueList)
 
     @property
     def total(self) -> int:

cognite/neat/rules/exporters/_rules2dms.py

@@ -4,10 +4,13 @@ from pathlib import Path
 from typing import Literal, TypeAlias, cast
 
 from cognite.client import CogniteClient
-from cognite.client.data_classes._base import CogniteResourceList
+from cognite.client.data_classes._base import CogniteResource, CogniteResourceList
+from cognite.client.data_classes.data_modeling import DataModelApply, DataModelId
 from cognite.client.exceptions import CogniteAPIError
 
+from cognite.neat.rules import issues
 from cognite.neat.rules._shared import Rules
+from cognite.neat.rules.issues import IssueList
 from cognite.neat.rules.models.rules import InformationRules
 from cognite.neat.rules.models.rules._base import ExtensionCategory, SheetList
 from cognite.neat.rules.models.rules._dms_architect_rules import DMSContainer, DMSRules
@@ -43,6 +46,8 @@ class DMSExporter(CDFExporter[DMSSchema]):
         export_pipeline (bool, optional): Whether to export the pipeline. Defaults to False. This means setting
             up transformations, RAW databases and tables to populate the data model.
         instance_space (str, optional): The space to use for the instance. Defaults to None.
+        suppress_warnings (bool, optional): Suppress warnings. Defaults to False.
+
     ... note::
 
         - "fail": If any component already exists, the export will fail.
@@ -59,12 +64,14 @@ class DMSExporter(CDFExporter[DMSSchema]):
         existing_handling: Literal["fail", "skip", "update", "force"] = "update",
         export_pipeline: bool = False,
         instance_space: str | None = None,
+        suppress_warnings: bool = False,
     ):
         self.export_components = {export_components} if isinstance(export_components, str) else set(export_components)
         self.include_space = include_space
         self.existing_handling = existing_handling
         self.export_pipeline = export_pipeline
         self.instance_space = instance_space
+        self.suppress_warnings = suppress_warnings
         self._schema: DMSSchema | None = None
 
     def export_to_file(self, rules: Rules, filepath: Path) -> None:
@@ -115,11 +122,11 @@ class DMSExporter(CDFExporter[DMSSchema]):
         )
         is_new_model = dms_rules.reference is None
         if is_new_model or is_solution_model:
-            return dms_rules.as_schema(self.export_pipeline, self.instance_space)
+            return dms_rules.as_schema(False, self.export_pipeline, self.instance_space)
 
         # This is an extension of an existing model.
         reference_rules = cast(DMSRules, dms_rules.reference).model_copy(deep=True)
-        reference_schema = reference_rules.as_schema(self.export_pipeline)
+        reference_schema = reference_rules.as_schema(include_ref=False, include_pipeline=self.export_pipeline)
 
         # Todo Move this to an appropriate location
         # Merging Reference with User Rules
@@ -142,7 +149,7 @@ class DMSExporter(CDFExporter[DMSSchema]):
                 property_.reference = None
                 combined_rules.properties.append(property_)
 
-        schema = combined_rules.as_schema(self.export_pipeline, self.instance_space)
+        schema = combined_rules.as_schema(True, self.export_pipeline, self.instance_space)
 
         if dms_rules.metadata.extension in (ExtensionCategory.addition, ExtensionCategory.reshape):
             # We do not freeze views as they might be changed, even for addition,
@@ -206,6 +213,7 @@ class DMSExporter(CDFExporter[DMSSchema]):
         redeploy_data_model = False
 
         for all_items, loader in to_export:
+            issue_list = IssueList()
             all_item_ids = loader.get_ids(all_items)
             skipped = sum(1 for item_id in all_item_ids if item_id in schema.frozen_ids)
             item_ids = [item_id for item_id in all_item_ids if item_id not in schema.frozen_ids]
@@ -249,6 +257,9 @@ class DMSExporter(CDFExporter[DMSSchema]):
             else:
                 raise ValueError(f"Unsupported existing_handling {self.existing_handling}")
 
+            warning_list = self._validate(loader, items)
+            issue_list.extend(warning_list)
+
             error_messages: list[str] = []
             if not dry_run:
                 if to_delete:
@@ -284,6 +295,7 @@ class DMSExporter(CDFExporter[DMSSchema]):
                 failed_created=failed_created,
                 failed_changed=failed_changed,
                 error_messages=error_messages,
+                issues=issue_list,
             )
 
             if loader.resource_name == "views" and (created or changed) and not redeploy_data_model:
@@ -307,3 +319,33 @@ class DMSExporter(CDFExporter[DMSSchema]):
             to_export.append((schema.raw_tables, RawTableLoader(client)))
             to_export.append((schema.transformations, TransformationLoader(client)))
         return schema, to_export
+
+    def _validate(self, loader: ResourceLoader, items: list[CogniteResource]) -> IssueList:
+        issue_list = IssueList()
+        if isinstance(loader, DataModelLoader):
+            models = cast(list[DataModelApply], items)
+            if other_models := self._exist_other_data_models(loader, models):
+                warning = issues.dms.OtherDataModelsInSpaceWarning(models[0].space, other_models)
+                if not self.suppress_warnings:
+                    warnings.warn(warning, stacklevel=2)
+                issue_list.append(warning)
+
+        return issue_list
+
+    @classmethod
+    def _exist_other_data_models(cls, loader: DataModelLoader, models: list[DataModelApply]) -> list[DataModelId]:
+        if not models:
+            return []
+        space = models[0].space
+        external_id = models[0].external_id
+        try:
+            data_models = loader.client.data_modeling.data_models.list(space=space, limit=25, all_versions=False)
+        except CogniteAPIError as e:
+            warnings.warn(issues.importing.APIWarning(str(e)), stacklevel=2)
+            return []
+        else:
+            return [
+                data_model.as_id()
+                for data_model in data_models
+                if (data_model.space, data_model.external_id) != (space, external_id)
+            ]

cognite/neat/rules/exporters/_rules2excel.py

@@ -120,13 +120,6 @@ class ExcelExporter(BaseExporter[Workbook]):
             else:
                 sheet = workbook.create_sheet(sheet_name)
 
-            # Reorder such that the first column is class + the first field of the subclass
-            # of sheet entity. This is to make the properties/classes/views/containers sheet more readable.
-            # For example, for the properties these that means class, property, name, description
-            # instead of class, name, description, property
-            move = len(SheetEntity.model_fields) - 1  # -1 is for the class field
-            headers = headers[:1] + headers[move : move + 1] + headers[1:move] + headers[move + 1 :]
-
             main_header = self._main_header_by_sheet_name[sheet_name]
             sheet.append([main_header] + [""] * (len(headers) - 1))
             sheet.merge_cells(start_row=1, start_column=1, end_row=1, end_column=len(headers))
@@ -150,8 +143,6 @@ class ExcelExporter(BaseExporter[Workbook]):
                         cell.border = Border(left=side, right=side, top=side, bottom=side)
                     fill_color = next(fill_colors)
 
-                # Need to do the same reordering as for the headers above
-                row = row[:1] + row[move : move + 1] + row[1:move] + row[move + 1 :]
                 sheet.append(row)
                 if self._styling_level > 2 and is_properties:
                     for cell in sheet[sheet.max_row]:

cognite/neat/rules/importers/_base.py

@@ -60,6 +60,12 @@ class BaseImporter(ABC):
         else:
             return output, issues
 
+    @classmethod
+    def _return_or_raise(cls, issue_list: IssueList, errors: Literal["raise", "continue"]) -> tuple[None, IssueList]:
+        if errors == "raise":
+            raise issue_list.as_errors()
+        return None, issue_list
+
     def _default_metadata(self):
         return {
             "prefix": "neat",