cognite-neat 0.119.9__py3-none-any.whl → 0.121.0__py3-none-any.whl

cognite/neat/{_rules → core/_rules}/exporters/_rules2excel.py

@@ -4,27 +4,29 @@ import itertools
 from datetime import datetime
 from pathlib import Path
 from types import GenericAlias
-from typing import Any, ClassVar, Literal, cast, get_args
+from typing import Any, ClassVar, Literal, cast, get_args, overload
 
 from openpyxl import Workbook
 from openpyxl.cell import MergedCell
 from openpyxl.styles import Alignment, Border, Font, PatternFill, Side
+from openpyxl.utils import get_column_letter
+from openpyxl.worksheet.datavalidation import DataValidation
 from openpyxl.worksheet.worksheet import Worksheet
 from rdflib import Namespace
 
-from cognite.neat._constants import COGNITE_CONCEPTS
-from cognite.neat._rules._constants import get_internal_properties
-from cognite.neat._rules._shared import VerifiedRules
-from cognite.neat._rules.models import (
+from cognite.neat.core._constants import BASE_MODEL, get_base_concepts
+from cognite.neat.core._rules._constants import get_internal_properties
+from cognite.neat.core._rules._shared import VerifiedRules
+from cognite.neat.core._rules.models import (
     SheetRow,
 )
-from cognite.neat._rules.models._base_rules import BaseMetadata, RoleTypes
-from cognite.neat._rules.models.data_types import (
+from cognite.neat.core._rules.models._base_rules import BaseMetadata, RoleTypes
+from cognite.neat.core._rules.models.data_types import (
     _DATA_TYPE_BY_DMS_TYPE,
 )
-from cognite.neat._rules.models.dms._rules import DMSRules
-from cognite.neat._rules.models.information._rules import InformationRules
-from cognite.neat._utils.spreadsheet import (
+from cognite.neat.core._rules.models.dms._rules import DMSRules
+from cognite.neat.core._rules.models.information._rules import InformationRules
+from cognite.neat.core._utils.spreadsheet import (
     find_column_with_value,
     generate_data_validation,
 )
@@ -67,6 +69,16 @@ class ExcelExporter(BaseExporter[VerifiedRules, Workbook]):
         "Nodes": "Definition of Nodes",
         "Enum": "Definition of Enum Collections",
     }
+    _helper_sheet_column_indexes_by_names: ClassVar[dict[str, int]] = {
+        "Class": 1,
+        "View": 1,
+        "Implements": 2,
+        "Value Type": 3,
+        "Container": 4,
+        "In Model": 5,
+        "Immutable": 5,
+        "Used For": 6,
+    }
     style_options = get_args(Style)
     dump_options = get_args(DumpOptions)
 
@@ -80,6 +92,8 @@ class ExcelExporter(BaseExporter[VerifiedRules, Workbook]):
         hide_internal_columns: bool = True,
         include_properties: Literal["same-space", "all"] = "all",
         add_drop_downs: bool = True,
+        base_model: BASE_MODEL | None = None,
+        total_concepts: int | None = None,
     ):
         self.sheet_prefix = sheet_prefix or ""
         if styling not in self.style_options:
@@ -92,6 +106,8 @@ class ExcelExporter(BaseExporter[VerifiedRules, Workbook]):
         self.hide_internal_columns = hide_internal_columns
         self.include_properties = include_properties
         self.add_drop_downs = add_drop_downs
+        self.base_model = base_model
+        self.total_concepts = total_concepts
 
     @property
     def description(self) -> str:
@@ -106,6 +122,12 @@ class ExcelExporter(BaseExporter[VerifiedRules, Workbook]):
             data.close()
         return None
 
+    @overload
+    def template(self, role: RoleTypes, filepath: Path) -> None: ...
+
+    @overload
+    def template(self, role: RoleTypes, filepath: Path | None = None) -> None: ...
+
     def template(self, role: RoleTypes, filepath: Path | None = None) -> None | Workbook:
         """This method will create an spreadsheet template for data modeling depending on the role.
 
@@ -137,10 +159,7 @@ class ExcelExporter(BaseExporter[VerifiedRules, Workbook]):
         self._adjust_column_widths(workbook)
         self._hide_internal_columns(workbook)
 
-        if role == RoleTypes.dms:
-            self._add_dms_drop_downs(workbook)
-        else:
-            self._add_info_drop_downs(workbook)
+        self._add_drop_downs(role, workbook)
 
         if filepath:
             try:
@@ -176,10 +195,8 @@ class ExcelExporter(BaseExporter[VerifiedRules, Workbook]):
             self._hide_internal_columns(workbook)
 
         # Only add drop downs if the rules are DMSRules
-        if self.add_drop_downs and isinstance(rules, DMSRules):
-            self._add_dms_drop_downs(workbook)
-        elif self.add_drop_downs and isinstance(rules, InformationRules):
-            self._add_info_drop_downs(workbook)
+        if self.add_drop_downs:
+            self._add_drop_downs(rules.metadata.role, workbook)
 
         return workbook
 
@@ -199,199 +216,238 @@ class ExcelExporter(BaseExporter[VerifiedRules, Workbook]):
                 if column_letter:
                     ws.column_dimensions[column_letter].hidden = True
 
-    def _add_info_drop_downs(self, workbook: Workbook, no_rows: int = 100) -> None:
+    def _add_drop_downs(
+        self,
+        role: RoleTypes,
+        workbook: Workbook,
+    ) -> None:
         """Adds drop down menus to specific columns for fast and accurate data entry
-        in the Information rules.
+        for both DMS and Information rules.
 
         Args:
+            role: The role for which the drop downs are created. Can be either "dms" or "information".
             workbook: Workbook representation of the Excel file.
-            no_rows: number of rows to add drop down menus. Defaults to 100*100.
-
-        !!! note "Why no_rows=100?"
-            Maximum number of views per data model is 100, thus this value is set accordingly
 
         !!! note "Why defining individual data validation per desired column?
             This is due to the internal working of openpyxl. Adding same validation to
             different column leads to unexpected behavior when the openpyxl workbook is exported
             as and Excel file. Probably, the validation is not copied to the new column,
             but instead reference to the data validation object is added.
+
+        !!! note "Why 100*100 rows?"
+            This is due to the fact that we need to add drop down menus for all properties
+            in the sheet. The maximum number of properties per view/class is 100. So considering
+            maximum number of views/classes is 100, we need to add 100*100 rows.
         """
-        self._make_helper_info_sheet(workbook, no_rows)
+
+        self._make_helper_sheet(role, workbook, 100)
+
+        data_validators: dict[str, DataValidation] = {}
 
         # We need create individual data validation and cannot re-use the same one due
         # the internals of openpyxl
-        dv_classes = generate_data_validation(self._helper_sheet_name, "A", no_header_rows=0, no_rows=no_rows)
-        dv_value_types = generate_data_validation(self._helper_sheet_name, "B", no_header_rows=0, no_rows=no_rows)
-        dv_implements = generate_data_validation(
-            self._helper_sheet_name,
-            "C",
-            no_header_rows=0,
-            no_rows=no_rows + len(COGNITE_CONCEPTS),
+
+        self._add_data_validation(
+            workbook,
+            sheet_name="Views" if role == RoleTypes.dms else "Classes",
+            column_name="Implements",
+            data_validator_name="implements",
+            data_validators=data_validators,
+            validation_range=100 + 100,  # base + user concepts (max)
+            total_rows=100,
+        )
+
+        self._add_data_validation(
+            workbook,
+            sheet_name="Properties",
+            column_name="Value Type",
+            data_validator_name="value_type",
+            data_validators=data_validators,
+            validation_range=150,  # primitive types + classes
+            total_rows=100 * 100,  # 100 views/classes * 100 properties (max properties per view/class)
         )
 
-        workbook["Properties"].add_data_validation(dv_classes)
-        workbook["Properties"].add_data_validation(dv_value_types)
-        workbook["Classes"].add_data_validation(dv_implements)
+        self._add_data_validation(
+            workbook,
+            sheet_name="Properties",
+            column_name="View" if role == RoleTypes.dms else "Class",
+            data_validator_name="views_or_classes",
+            data_validators=data_validators,
+            validation_range=100,
+            total_rows=100 * 100,
+        )
 
-        # we multiply no_rows with 100 since a view can have max 100 properties per view
-        if column := find_column_with_value(workbook["Properties"], "Class"):
-            dv_classes.add(f"{column}{3}:{column}{no_rows * 100}")
+        if role == RoleTypes.dms:
+            self._add_data_validation(
+                workbook,
+                sheet_name="Properties",
+                column_name="Container",
+                data_validator_name="container",
+                data_validators=data_validators,
+                validation_range=100,
+                total_rows=100 * 100,
+            )
 
-        if column := find_column_with_value(workbook["Properties"], "Value Type"):
-            dv_value_types.add(f"{column}{3}:{column}{no_rows * 100}")
+            self._add_data_validation(
+                workbook,
+                sheet_name="Properties",
+                column_name="Immutable",
+                data_validator_name="immutable",
+                data_validators=data_validators,
+                validation_range=2,
+                total_rows=100 * 100,
+            )
 
-        if column := find_column_with_value(workbook["Classes"], "Implements"):
-            dv_implements.add(f"{column}{3}:{column}{no_rows}")
+            self._add_data_validation(
+                workbook,
+                sheet_name="Views",
+                column_name="In Model",
+                data_validator_name="in_model",
+                data_validators=data_validators,
+                validation_range=2,
+                total_rows=100,  # 100 views
+            )
+
+            self._add_data_validation(
+                workbook,
+                sheet_name="Containers",
+                column_name="Used For",
+                data_validator_name="used_for",
+                data_validators=data_validators,
+                validation_range=3,
+                total_rows=100,  # 100 views
+            )
+
+    def _make_helper_sheet(
+        self,
+        role: RoleTypes,
+        workbook: Workbook,
+        no_rows: int,
+    ) -> None:
+        """This helper sheet is used as source of data for drop down menus creation
+
+        Args:
+            role: The role for which the helper sheet is created. Can be either "dms" or "information".
+            workbook: Workbook representation of the Excel file.
+            no_rows: number of rows to add data too that will form base for drop down menus.
+        """
 
-    def _make_helper_info_sheet(self, workbook: Workbook, no_rows: int) -> None:
-        """This helper Information sheet is used as source of data for drop down menus creation"""
         workbook.create_sheet(title=self._helper_sheet_name)
 
-        for dtype_counter, dtype in enumerate(_DATA_TYPE_BY_DMS_TYPE.values()):
+        value_type_counter = 0
+
+        for value_type_counter, value_type in enumerate(_DATA_TYPE_BY_DMS_TYPE.values()):
+            value_type_as_str = value_type.dms._type.casefold() if role == RoleTypes.dms else value_type.xsd
             # skip types which require special handling or are surpassed by CDM
-            if dtype.xsd in ["enum", "timeseries", "sequence", "file", "json"]:
+            if value_type_as_str in ["enum", "timeseries", "sequence", "file", "json"]:
                 continue
-            workbook[self._helper_sheet_name].cell(row=dtype_counter + 1, column=2, value=dtype.xsd)
-
-        # Add Cognite Core Data Views:
-        for concept_counter, concept in enumerate(COGNITE_CONCEPTS):
             workbook[self._helper_sheet_name].cell(
-                row=concept_counter + 1,
-                column=3,
-                value=f"cdf_cdm:{concept}(version=v1)",
+                row=value_type_counter + 1,
+                column=self._helper_sheet_column_indexes_by_names["Value Type"],
+                value=value_type_as_str,
             )
 
+        value_type_counter += 1
+
+        concept_counter = 0
+        if self.base_model and (concepts := get_base_concepts(self.base_model, self.total_concepts)):
+            for concept_counter, concept in enumerate(concepts):
+                workbook[self._helper_sheet_name].cell(
+                    row=concept_counter + 1,
+                    column=self._helper_sheet_column_indexes_by_names["Implements"],
+                    value=concept,
+                )
+            concept_counter += 1
+
+        views_or_classes_sheet = "Views" if role == RoleTypes.dms else "Classes"
+        view_or_class_column = "View" if role == RoleTypes.dms else "Class"
+
         for i in range(no_rows):
             workbook[self._helper_sheet_name].cell(
                 row=i + 1,
-                column=1,
-                value=f'=IF(ISBLANK(Classes!A{i + 3}), "", Classes!A{i + 3})',
+                column=self._helper_sheet_column_indexes_by_names[view_or_class_column],
+                value=f'=IF(ISBLANK({views_or_classes_sheet}!A{i + 3}), "", {views_or_classes_sheet}!A{i + 3})',
             )
+
             workbook[self._helper_sheet_name].cell(
-                row=dtype_counter + i + 2,
-                column=2,
-                value=f'=IF(ISBLANK(Classes!A{i + 3}), "", Classes!A{i + 3})',
+                row=concept_counter + i + 1,
+                column=self._helper_sheet_column_indexes_by_names["Implements"],
+                value=f'=IF(ISBLANK({views_or_classes_sheet}!A{i + 3}), "", {views_or_classes_sheet}!A{i + 3})',
             )
+
             workbook[self._helper_sheet_name].cell(
-                row=concept_counter + i + 2,
-                column=3,
-                value=f'=IF(ISBLANK(Classes!A{i + 3}), "", Classes!A{i + 3})',
+                row=value_type_counter + i + 1,
+                column=self._helper_sheet_column_indexes_by_names["Value Type"],
+                value=f'=IF(ISBLANK({views_or_classes_sheet}!A{i + 3}), "", {views_or_classes_sheet}!A{i + 3})',
             )
 
+            if role == RoleTypes.dms:
+                workbook[self._helper_sheet_name].cell(
+                    row=i + 1,
+                    column=self._helper_sheet_column_indexes_by_names["Container"],
+                    value=f'=IF(ISBLANK(Containers!A{i + 3}), "", Containers!A{i + 3})',
+                )
+
+        if role == RoleTypes.dms:
+            for i, value in enumerate([True, False, ""]):
+                workbook[self._helper_sheet_name].cell(
+                    row=i + 1,
+                    column=self._helper_sheet_column_indexes_by_names["In Model"],
+                    value=cast(bool | str, value),
+                )
+
+            for i, value in enumerate(["node", "edge", "all"]):
+                workbook[self._helper_sheet_name].cell(
+                    row=i + 1,
+                    column=self._helper_sheet_column_indexes_by_names["Used For"],
+                    value=value,
+                )
+
         workbook[self._helper_sheet_name].sheet_state = "hidden"
 
-    def _add_dms_drop_downs(self, workbook: Workbook, no_rows: int = 100) -> None:
-        """Adds drop down menus to specific columns for fast and accurate data entry
-        in the DMS rules.
+    def _add_data_validation(
+        self,
+        workbook: Workbook,
+        sheet_name: str,
+        column_name: str,
+        data_validator_name: str,
+        data_validators: dict,
+        validation_range: int,
+        total_rows: int,
+    ) -> None:
+        """Adds data validation to a column in a sheet.
 
         Args:
             workbook: Workbook representation of the Excel file.
-            no_rows: number of rows to add drop down menus. Defaults to 100*100.
-
-        !!! note "Why no_rows=100?"
-            Maximum number of views per data model is 100, thus this value is set accordingly
-
-        !!! note "Why defining individual data validation per desired column?
+            sheet_name: The name of the sheet to add the data validation to.
+            column_name: The name of the column to add the data validation to.
+            data_validator_name: The name of the data validation to add.
+            data_validators: A dictionary to store the data validators.
+            validation_range: The total number of validation values to add.
+            total_rows: The number of rows to add the data validation to.
+
+        !!! note "Why defining individual data validation per desired column?"
             This is due to the internal working of openpyxl. Adding same validation to
             different column leads to unexpected behavior when the openpyxl workbook is exported
-            as and Excel file. Probably, the validation is not copied to the new column,
-            but instead reference to the data validation object is added.
-        """
+            as and Excel file.
 
-        self._make_helper_dms_sheet(workbook, no_rows)
-
-        # We need create individual data validation and cannot re-use the same one due
-        # the internals of openpyxl
-        dv_views = generate_data_validation(self._helper_sheet_name, "A", no_header_rows=0, no_rows=no_rows)
-        dv_containers = generate_data_validation(self._helper_sheet_name, "B", no_header_rows=0, no_rows=no_rows)
-        dv_value_types = generate_data_validation(self._helper_sheet_name, "C", no_header_rows=0, no_rows=no_rows)
-        dv_implements = generate_data_validation(
+        !!! note "Why starting at row 3?"
+            This is due to the header rows in the sheet. The first two rows are reserved for the header.
+        """
+        # CREATE VALIDATOR
+        data_validators[data_validator_name] = generate_data_validation(
             self._helper_sheet_name,
-            "F",
-            no_header_rows=0,
-            no_rows=no_rows + len(COGNITE_CONCEPTS),
+            get_column_letter(self._helper_sheet_column_indexes_by_names[column_name]),
+            total_header_rows=0,
+            validation_range=validation_range,
         )
 
-        dv_immutable = generate_data_validation(self._helper_sheet_name, "D", no_header_rows=0, no_rows=3)
-        dv_in_model = generate_data_validation(self._helper_sheet_name, "D", no_header_rows=0, no_rows=3)
-        dv_used_for = generate_data_validation(self._helper_sheet_name, "E", no_header_rows=0, no_rows=3)
-
-        workbook["Properties"].add_data_validation(dv_views)
-        workbook["Properties"].add_data_validation(dv_containers)
-        workbook["Properties"].add_data_validation(dv_value_types)
-        workbook["Properties"].add_data_validation(dv_immutable)
-        workbook["Views"].add_data_validation(dv_in_model)
-        workbook["Views"].add_data_validation(dv_implements)
-        workbook["Containers"].add_data_validation(dv_used_for)
-
-        # we multiply no_rows with 100 since a view can have max 100 properties per view
-        if column := find_column_with_value(workbook["Properties"], "View"):
-            dv_views.add(f"{column}{3}:{column}{no_rows * 100}")
-
-        if column := find_column_with_value(workbook["Properties"], "Container"):
-            dv_containers.add(f"{column}{3}:{column}{no_rows * 100}")
-
-        if column := find_column_with_value(workbook["Properties"], "Value Type"):
-            dv_value_types.add(f"{column}{3}:{column}{no_rows * 100}")
-
-        if column := find_column_with_value(workbook["Properties"], "Immutable"):
-            dv_immutable.add(f"{column}{3}:{column}{no_rows * 100}")
-
-        if column := find_column_with_value(workbook["Views"], "In Model"):
-            dv_in_model.add(f"{column}{3}:{column}{no_rows}")
-
-        if column := find_column_with_value(workbook["Views"], "Implements"):
-            dv_implements.add(f"{column}{3}:{column}{no_rows}")
+        # REGISTER VALIDATOR TO SPECIFIC WORKBOOK SHEET
+        workbook[sheet_name].add_data_validation(data_validators[data_validator_name])
 
-        if column := find_column_with_value(workbook["Containers"], "Used For"):
-            dv_used_for.add(f"{column}{3}:{column}{no_rows}")
-
-    def _make_helper_dms_sheet(self, workbook: Workbook, no_rows: int) -> None:
-        """This helper DMS sheet is used as source of data for drop down menus creation"""
-        workbook.create_sheet(title=self._helper_sheet_name)
-
-        for dtype_counter, dtype in enumerate(_DATA_TYPE_BY_DMS_TYPE):
-            if dtype in ["enum", "timeseries", "sequence", "file", "json"]:
-                continue
-            workbook[self._helper_sheet_name].cell(row=dtype_counter + 1, column=3, value=dtype)
-
-        # Add Cognite Core Data Views:
-        for concept_counter, concept in enumerate(COGNITE_CONCEPTS):
-            workbook[self._helper_sheet_name].cell(
-                row=concept_counter + 1,
-                column=6,
-                value=f"cdf_cdm:{concept}(version=v1)",
-            )
-
-        for i in range(no_rows):
-            workbook[self._helper_sheet_name].cell(
-                row=i + 1,
-                column=1,
-                value=f'=IF(ISBLANK(Views!A{i + 3}), "", Views!A{i + 3})',
-            )
-            workbook[self._helper_sheet_name].cell(
-                row=i + 1,
-                column=2,
-                value=f'=IF(ISBLANK(Containers!A{i + 3}), "", Containers!A{i + 3})',
-            )
-            workbook[self._helper_sheet_name].cell(
-                row=dtype_counter + i + 2,
-                column=3,
-                value=f'=IF(ISBLANK(Views!A{i + 3}), "", Views!A{i + 3})',
-            )
-            workbook[self._helper_sheet_name].cell(
-                row=concept_counter + i + 2,
-                column=6,
-                value=f'=IF(ISBLANK(Views!A{i + 3}), "", Views!A{i + 3})',
-            )
-
-        for i, value in enumerate([True, False, ""]):
-            workbook[self._helper_sheet_name].cell(row=i + 1, column=4, value=cast(bool | str, value))
-
-        for i, value in enumerate(["node", "edge", "all"]):
-            workbook[self._helper_sheet_name].cell(row=i + 1, column=5, value=value)
-
-        workbook[self._helper_sheet_name].sheet_state = "hidden"
+        # APPLY VALIDATOR TO SPECIFIC COLUMN
+        if column_letter := find_column_with_value(workbook[sheet_name], column_name):
+            data_validators[data_validator_name].add(f"{column_letter}{3}:{column_letter}{3 + total_rows}")
 
     def _create_sheet_with_header(
         self,

cognite/neat/{_rules → core/_rules}/exporters/_rules2instance_template.py

@@ -8,10 +8,10 @@ from openpyxl.styles import Alignment, Border, Font, NamedStyle, PatternFill, Si
 from openpyxl.utils import get_column_letter
 from openpyxl.worksheet.datavalidation import DataValidation
 
-from cognite.neat._rules._constants import EntityTypes
-from cognite.neat._rules.analysis import RulesAnalysis
-from cognite.neat._rules.models.entities._single_value import ClassEntity
-from cognite.neat._rules.models.information._rules import InformationRules
+from cognite.neat.core._rules._constants import EntityTypes
+from cognite.neat.core._rules.analysis import RulesAnalysis
+from cognite.neat.core._rules.models.entities._single_value import ClassEntity
+from cognite.neat.core._rules.models.information._rules import InformationRules
 
 from ._base import BaseExporter
 

cognite/neat/{_rules → core/_rules}/exporters/_rules2ontology.py

@@ -8,23 +8,23 @@ from pydantic import BaseModel, ConfigDict, ValidationInfo, field_validator
 from rdflib import DCTERMS, OWL, RDF, RDFS, XSD, BNode, Graph, Literal, Namespace, URIRef
 from rdflib.collection import Collection as GraphCollection
 
-from cognite.neat._constants import DEFAULT_NAMESPACE as NEAT_NAMESPACE
-from cognite.neat._issues import MultiValueError
-from cognite.neat._issues.errors import (
+from cognite.neat.core._constants import DEFAULT_NAMESPACE as NEAT_NAMESPACE
+from cognite.neat.core._issues import MultiValueError
+from cognite.neat.core._issues.errors import (
     PropertyDefinitionDuplicatedError,
 )
-from cognite.neat._issues.warnings import PropertyDefinitionDuplicatedWarning
-from cognite.neat._rules._constants import EntityTypes
-from cognite.neat._rules.analysis import RulesAnalysis
-from cognite.neat._rules.models.data_types import DataType
-from cognite.neat._rules.models.entities import ClassEntity
-from cognite.neat._rules.models.information import (
+from cognite.neat.core._issues.warnings import PropertyDefinitionDuplicatedWarning
+from cognite.neat.core._rules._constants import EntityTypes
+from cognite.neat.core._rules.analysis import RulesAnalysis
+from cognite.neat.core._rules.models.data_types import DataType
+from cognite.neat.core._rules.models.entities import ClassEntity
+from cognite.neat.core._rules.models.information import (
     InformationClass,
     InformationMetadata,
     InformationProperty,
     InformationRules,
 )
-from cognite.neat._utils.rdf_ import remove_namespace_from_uri
+from cognite.neat.core._utils.rdf_ import remove_namespace_from_uri
 
 from ._base import BaseExporter
 from ._validation import duplicated_properties

cognite/neat/{_rules → core/_rules}/exporters/_rules2yaml.py

@@ -5,7 +5,7 @@ from typing import Literal, get_args
 
 import yaml
 
-from cognite.neat._rules._shared import VerifiedRules
+from cognite.neat.core._rules._shared import VerifiedRules
 
 from ._base import BaseExporter
 

cognite/neat/{_rules → core/_rules}/exporters/_validation.py

@@ -1,8 +1,8 @@
 from collections import defaultdict
 from collections.abc import Iterable
 
-from cognite.neat._rules.models.entities import ClassEntity
-from cognite.neat._rules.models.information import InformationProperty
+from cognite.neat.core._rules.models.entities import ClassEntity
+from cognite.neat.core._rules.models.information import InformationProperty
 
 
 def duplicated_properties(

cognite/neat/{_rules → core/_rules}/importers/_base.py

@@ -5,12 +5,12 @@ from typing import TYPE_CHECKING, Any, Generic
 
 from rdflib import URIRef
 
-from cognite.neat._constants import DEFAULT_NAMESPACE
-from cognite.neat._rules._shared import ReadRules, T_InputRules
-from cognite.neat._utils.auxiliary import class_html_doc
+from cognite.neat.core._constants import DEFAULT_NAMESPACE
+from cognite.neat.core._rules._shared import ReadRules, T_InputRules
+from cognite.neat.core._utils.auxiliary import class_html_doc
 
 if TYPE_CHECKING:
-    from cognite.neat._store._provenance import Agent as ProvenanceAgent
+    from cognite.neat.core._store._provenance import Agent as ProvenanceAgent
 
 
 class BaseImporter(ABC, Generic[T_InputRules]):
@@ -49,7 +49,7 @@ class BaseImporter(ABC, Generic[T_InputRules]):
     @property
     def agent(self) -> "ProvenanceAgent":
         """Provenance agent for the importer."""
-        from cognite.neat._store._provenance import Agent as ProvenanceAgent
+        from cognite.neat.core._store._provenance import Agent as ProvenanceAgent
 
         return ProvenanceAgent(id_=DEFAULT_NAMESPACE[f"agent/{type(self).__name__}"])
 

cognite/neat/{_rules → core/_rules}/importers/_dms2rules.py

@@ -28,17 +28,25 @@ from cognite.client.data_classes.data_modeling.views import (
 )
 from cognite.client.utils import ms_to_datetime
 
-from cognite.neat._client import NeatClient
-from cognite.neat._constants import DMS_DIRECT_RELATION_LIST_DEFAULT_LIMIT, DMS_PRIMITIVE_LIST_DEFAULT_LIMIT
-from cognite.neat._issues import IssueList, MultiValueError, NeatIssue, catch_issues
-from cognite.neat._issues.errors import (
+from cognite.neat.core._client import NeatClient
+from cognite.neat.core._constants import (
+    DMS_DIRECT_RELATION_LIST_DEFAULT_LIMIT,
+    DMS_PRIMITIVE_LIST_DEFAULT_LIMIT,
+)
+from cognite.neat.core._issues import (
+    IssueList,
+    MultiValueError,
+    NeatIssue,
+    catch_issues,
+)
+from cognite.neat.core._issues.errors import (
     FileTypeUnexpectedError,
     NeatValueError,
     PropertyTypeNotSupportedError,
     ResourceMissingIdentifierError,
     ResourceRetrievalError,
 )
-from cognite.neat._issues.warnings import (
+from cognite.neat.core._issues.warnings import (
     MissingCogniteClientWarning,
     NeatValueWarning,
     PropertyNotFoundWarning,
@@ -47,14 +55,14 @@ from cognite.neat._issues.warnings import (
     ResourcesDuplicatedWarning,
     ResourceUnknownWarning,
 )
-from cognite.neat._rules._shared import ReadRules
-from cognite.neat._rules.importers._base import BaseImporter
-from cognite.neat._rules.models import (
+from cognite.neat.core._rules._shared import ReadRules
+from cognite.neat.core._rules.importers._base import BaseImporter
+from cognite.neat.core._rules.models import (
     DMSInputRules,
     DMSSchema,
 )
-from cognite.neat._rules.models.data_types import DataType, Enum, String
-from cognite.neat._rules.models.dms import (
+from cognite.neat.core._rules.models.data_types import DataType, Enum, String
+from cognite.neat.core._rules.models.dms import (
     DMSInputContainer,
     DMSInputEnum,
     DMSInputMetadata,
@@ -62,7 +70,7 @@ from cognite.neat._rules.models.dms import (
     DMSInputProperty,
     DMSInputView,
 )
-from cognite.neat._rules.models.entities import (
+from cognite.neat.core._rules.models.entities import (
     ClassEntity,
     ContainerEntity,
     DMSNodeEntity,
@@ -71,7 +79,7 @@ from cognite.neat._rules.models.entities import (
     ReverseConnectionEntity,
     ViewEntity,
 )
-from cognite.neat._rules.models.information import (
+from cognite.neat.core._rules.models.information import (
     InformationInputClass,
     InformationInputProperty,
 )