cognite-neat 0.104.0__py3-none-any.whl → 0.105.0__py3-none-any.whl

cognite/neat/_workflows/steps/lib/current/rules_exporter.py

@@ -1,537 +0,0 @@
-import time
-from pathlib import Path
-from typing import ClassVar, Literal, cast
-
-from cognite.neat._client import NeatClient
-from cognite.neat._issues.errors import WorkflowStepNotInitializedError
-from cognite.neat._rules import exporters
-from cognite.neat._rules._shared import DMSRules, InformationRules, VerifiedRules
-from cognite.neat._rules.models import RoleTypes
-from cognite.neat._rules.transformers import (
-    DMSToInformation,
-    InformationToDMS,
-)
-from cognite.neat._workflows.model import FlowMessage, StepExecutionStatus
-from cognite.neat._workflows.steps.data_contracts import CogniteClient, MultiRuleData
-from cognite.neat._workflows.steps.step_model import Configurable, Step
-
-__all__ = [
-    "DeleteDataModelFromCDF",
-    "RulesToDMS",
-    "RulesToExcel",
-    "RulesToOntology",
-    "RulesToSHACL",
-    "RulesToSemanticDataModel",
-]
-
-
-CATEGORY = __name__.split(".")[-1].replace("_", " ").title()
-
-
-class DeleteDataModelFromCDF(Step):
-    """
-    This step deletes data model and its components from CDF
-    """
-
-    description = "This step deletes data model and its components from CDF."
-    version = "private-beta"
-    category = CATEGORY
-
-    configurables: ClassVar[list[Configurable]] = [
-        Configurable(
-            name="Dry run",
-            value="False",
-            label=("Whether to perform a dry run of the deleter. "),
-            options=["True", "False"],
-        ),
-        Configurable(
-            name="Components",
-            type="multi_select",
-            value="",
-            label="Select which DMS schema component(s) to be deleted from CDF",
-            options=["spaces", "containers", "views", "data_models"],
-        ),
-        Configurable(
-            name="Multi-space components deletion",
-            value="False",
-            label=(
-                "Whether to delete only components belonging to the data model space"
-                " (i.e. space define under Metadata sheet of Rules), "
-                "or also additionally delete components outside of the data model space."
-            ),
-            options=["True", "False"],
-        ),
-    ]
-
-    def run(self, rules: MultiRuleData, cdf_client: CogniteClient) -> FlowMessage:  # type: ignore[override]
-        if self.configs is None or self.data_store_path is None:
-            raise WorkflowStepNotInitializedError(type(self).__name__)
-        components_to_delete = {
-            cast(Literal["spaces", "data_models", "views", "containers"], key)
-            for key, value in self.complex_configs["Components"].items()
-            if value
-        }
-        dry_run = self.configs["Dry run"] == "True"
-        multi_space_components_delete: bool = self.configs["Multi-space components deletion"] == "True"
-
-        if not components_to_delete:
-            return FlowMessage(
-                error_text="No DMS Schema components selected for removal! Please select minimum one!",
-                step_execution_status=StepExecutionStatus.ABORT_AND_FAIL,
-            )
-        input_rules = rules.dms or rules.information
-        if input_rules is None:
-            return FlowMessage(
-                error_text="Missing DMS or Information rules in the input data! "
-                "Please ensure that a DMS or Information rules is provided!",
-                step_execution_status=StepExecutionStatus.ABORT_AND_FAIL,
-            )
-        if isinstance(input_rules, DMSRules):
-            dms_rules = input_rules
-        elif isinstance(input_rules, InformationRules):
-            dms_rules = InformationToDMS().transform(input_rules)
-        else:
-            raise NotImplementedError(f"Unsupported rules type {type(input_rules)}")
-
-        dms_exporter = exporters.DMSExporter(
-            export_components=frozenset(components_to_delete),
-            include_space=(None if multi_space_components_delete else {dms_rules.metadata.space}),
-        )
-
-        report_lines = ["# Data Model Deletion from CDF\n\n"]
-        errors = []
-        for result in dms_exporter.delete_from_cdf(rules=dms_rules, client=NeatClient(cdf_client), dry_run=dry_run):
-            report_lines.append(str(result))
-            errors.extend(result.error_messages)
-
-        report_lines.append("\n\n# ERRORS\n\n")
-        report_lines.extend(errors)
-
-        output_dir = self.config.staging_path
-        output_dir.mkdir(parents=True, exist_ok=True)
-        report_file = "dms_component_creation_report.txt"
-        report_full_path = output_dir / report_file
-        report_full_path.write_text("\n".join(report_lines))
-
-        output_text = (
-            "<p></p>"
-            "Download Data Model Deletion "
-            f'<a href="/data/staging/{report_file}?{time.time()}" '
-            f'target="_blank">Report</a>'
-        )
-
-        if errors:
-            return FlowMessage(error_text=output_text, step_execution_status=StepExecutionStatus.ABORT_AND_FAIL)
-        else:
-            return FlowMessage(output_text=output_text)
-
-
-class RulesToDMS(Step):
-    """
-    This step exports Rules to DMS Schema components in CDF
-    """
-
-    description = "This step exports Rules to DMS Schema components in CDF."
-    version = "private-beta"
-    category = CATEGORY
-
-    configurables: ClassVar[list[Configurable]] = [
-        Configurable(
-            name="Dry run",
-            value="False",
-            label=("Whether to perform a dry run of the export. "),
-            options=["True", "False"],
-        ),
-        Configurable(
-            name="Components",
-            type="multi_select",
-            value="",
-            label="Select which DMS schema component(s) to export to CDF",
-            options=["spaces", "containers", "views", "data_models"],
-        ),
-        Configurable(
-            name="Existing component handling",
-            value="fail",
-            label=(
-                "How to handle situation when components being exported in CDF already exist."
-                "Fail the step if any component already exists, "
-                "Skip the component if it already exists, "
-                " or Update the component try to update the component."
-            ),
-            options=["fail", "skip", "update", "force"],
-        ),
-        Configurable(
-            name="Multi-space components create",
-            value="False",
-            label=(
-                "Whether to create only components belonging to the data model space"
-                " (i.e. space define under Metadata sheet of Rules), "
-                "or also additionally components outside of the data model space."
-            ),
-            options=["True", "False"],
-        ),
-    ]
-
-    def run(self, rules: MultiRuleData, cdf_client: CogniteClient) -> FlowMessage:  # type: ignore[override]
-        if self.configs is None or self.data_store_path is None:
-            raise WorkflowStepNotInitializedError(type(self).__name__)
-        existing_components_handling = cast(
-            Literal["fail", "update", "skip", "force"], self.configs["Existing component handling"]
-        )
-        multi_space_components_create: bool = self.configs["Multi-space components create"] == "True"
-        components_to_create = {
-            cast(Literal["spaces", "data_models", "views", "containers"], key)
-            for key, value in self.complex_configs["Components"].items()
-            if value
-        }
-        dry_run = self.configs["Dry run"] == "True"
-
-        if not components_to_create:
-            return FlowMessage(
-                error_text="No DMS Schema components selected for upload! Please select minimum one!",
-                step_execution_status=StepExecutionStatus.ABORT_AND_FAIL,
-            )
-        input_rules = rules.dms or rules.information
-        if input_rules is None:
-            return FlowMessage(
-                error_text="Missing DMS or Information rules in the input data! "
-                "Please ensure that a DMS or Information rules is provided!",
-                step_execution_status=StepExecutionStatus.ABORT_AND_FAIL,
-            )
-        if isinstance(input_rules, DMSRules):
-            dms_rules = input_rules
-        elif isinstance(input_rules, InformationRules):
-            dms_rules = InformationToDMS().transform(input_rules)
-        else:
-            raise NotImplementedError(f"Unsupported rules type {type(input_rules)}")
-
-        dms_exporter = exporters.DMSExporter(
-            export_components=frozenset(components_to_create),
-            include_space=(None if multi_space_components_create else {dms_rules.metadata.space}),
-            existing=existing_components_handling,
-        )
-
-        output_dir = self.config.staging_path
-        output_dir.mkdir(parents=True, exist_ok=True)
-        file_name = input_rules.metadata.external_id
-        schema_zip = f"{file_name}.zip"
-        schema_full_path = output_dir / schema_zip
-        dms_exporter.export_to_file(dms_rules, schema_full_path)
-
-        report_lines = ["# DMS Schema Export to CDF\n\n"]
-        errors = []
-        for result in dms_exporter.export_to_cdf_iterable(
-            rules=dms_rules, client=NeatClient(cdf_client), dry_run=dry_run
-        ):
-            report_lines.append(str(result))
-            errors.extend(result.error_messages)
-
-        report_lines.append("\n\n# ERRORS\n\n")
-        report_lines.extend(errors)
-
-        output_dir = self.config.staging_path
-        output_dir.mkdir(parents=True, exist_ok=True)
-        report_file = "dms_component_creation_report.txt"
-        report_full_path = output_dir / report_file
-        report_full_path.write_text("\n".join(report_lines))
-
-        output_text = (
-            "<p></p>"
-            "Download DMS Export "
-            f'<a href="/data/staging/{report_file}?{time.time()}" '
-            f'target="_blank">Report</a>'
-            "<p></p>"
-            "Download DMS exported schema"
-            f'- <a href="/data/staging/{schema_zip}?{time.time()}" '
-            f'target="_blank">{schema_zip}</a>'
-        )
-
-        if errors:
-            return FlowMessage(error_text=output_text, step_execution_status=StepExecutionStatus.ABORT_AND_FAIL)
-        else:
-            return FlowMessage(output_text=output_text)
-
-
-class RulesToExcel(Step):
-    """This step exports Rules to Excel serialization"""
-
-    description = "This step exports Rules to Excel serialization."
-    version = "private-beta"
-    category = CATEGORY
-
-    configurables: ClassVar[list[Configurable]] = [
-        Configurable(
-            name="Styling",
-            value="default",
-            label="Styling of the Excel file",
-            options=list(exporters.ExcelExporter.style_options),
-        ),
-        Configurable(
-            name="Output role format",
-            value="input",
-            label="The role to use for the exported spreadsheet. If provided, the rules will be converted to "
-            "this role format before being written to excel. If not provided, the role from the input "
-            "rules will be used.",
-            options=["input", *RoleTypes.__members__.keys()],
-        ),
-        Configurable(
-            name="New Data Model ID",
-            value="",
-            label="If you chose Dump Format 'reference', the provided ID will be use in the new medata sheet. "
-            "Expected format 'sp_space:my_external_id'.",
-        ),
-        Configurable(
-            name="File path",
-            value="",
-            label="File path to the generated Excel file.For example: 'staging/exported-rules.xlsx'",
-        ),
-    ]
-
-    def run(self, rules: MultiRuleData) -> FlowMessage:  # type: ignore[override, syntax]
-        if self.configs is None or self.data_store_path is None:
-            raise WorkflowStepNotInitializedError(type(self).__name__)
-
-        styling = cast(exporters.ExcelExporter.Style, self.configs.get("Styling", "default"))
-        role = self.configs.get("Output role format")
-        output_role: RoleTypes | None = None
-        if role != "input" and role is not None:
-            output_role = RoleTypes[role]
-
-        new_model_str = self.configs.get("New Data Model ID")
-        new_model_id: tuple[str, str] | None = None
-        if new_model_str and ":" in new_model_str:
-            new_model_id = tuple(new_model_str.split(":", 1))  # type: ignore[assignment]
-        elif new_model_str:
-            return FlowMessage(
-                error_text="New Data Model ID must be in the format 'sp_space:my_external_id'!",
-                step_execution_status=StepExecutionStatus.ABORT_AND_FAIL,
-            )
-
-        excel_exporter = exporters.ExcelExporter(styling=styling, new_model_id=new_model_id)  # type: ignore[arg-type]
-
-        # Todo - Move the conversion to a separate workflow step.
-        rule_instance: VerifiedRules
-
-        if rules.information:
-            rule_instance = rules.information
-        elif rules.dms:
-            rule_instance = rules.dms
-        else:
-            output_errors = "No rules provided for export!"
-            return FlowMessage(error_text=output_errors, step_execution_status=StepExecutionStatus.ABORT_AND_FAIL)
-
-        if rule_instance.metadata.role is output_role or output_role is None:
-            ...
-        elif output_role is RoleTypes.dms:
-            if isinstance(rule_instance, InformationRules):
-                rule_instance = InformationToDMS().transform(rule_instance)
-            else:
-                raise NotImplementedError(f"Role {output_role} is not supported for {type(rules).__name__} rules")
-        elif output_role is RoleTypes.information:
-            if isinstance(rule_instance, DMSRules):
-                rule_instance = DMSToInformation().transform(rule_instance)
-            else:
-                raise NotImplementedError(f"Role {output_role} is not supported for {type(rules).__name__} rules")
-        else:
-            raise NotImplementedError(f"Role {output_role} is not supported for {type(rules).__name__} rules")
-
-        if output_role is None:
-            output_role = rule_instance.metadata.role
-        output_dir = self.data_store_path / Path("staging")
-        output_dir.mkdir(parents=True, exist_ok=True)
-        file_name = f"exported_rules_{output_role.value}.xlsx"
-        filepath = output_dir / file_name
-        if self.configs.get("File path", ""):
-            file_name = self.configs["File path"]
-            filepath = Path(self.data_store_path) / Path(file_name)
-        else:
-            file_name = f"staging/{file_name}"
-
-        excel_exporter.export_to_file(rule_instance, filepath)
-
-        output_text = (
-            "<p></p>"
-            f"Download Excel Exported {output_role.value} rules: "
-            f'- <a href="/data/{file_name}?{time.time()}" '
-            f'target="_blank">{file_name}</a>'
-        )
-
-        return FlowMessage(output_text=output_text)
-
-
-class RulesToOntology(Step):
-    """
-    This step exports Rules to OWL ontology
-    """
-
-    description = "This step exports Rules to OWL ontology"
-    version = "private-beta"
-    category = CATEGORY
-    configurables: ClassVar[list[Configurable]] = [
-        Configurable(
-            name="File path",
-            value="staging/ontology.ttl",
-            label=("Relative path for the ontology file storage, " " It will be auto-created if not provided ! "),
-        )
-    ]
-
-    def run(self, rules: MultiRuleData) -> FlowMessage:  # type: ignore[override, syntax]
-        if self.configs is None or self.data_store_path is None:
-            raise WorkflowStepNotInitializedError(type(self).__name__)
-
-        if not rules.information and not rules.dms:
-            return FlowMessage(
-                error_text="Rules must be made either by Information Architect or DMS Architect!",
-                step_execution_status=StepExecutionStatus.ABORT_AND_FAIL,
-            )
-
-        default_path = self.config.staging_path / _get_default_file_name(rules, "ontology", "ttl")
-
-        storage_path = (
-            self.data_store_path / Path(self.configs["File path"]) if self.configs["File path"] else default_path
-        )
-        storage_path.parent.mkdir(parents=True, exist_ok=True)
-
-        input_rules = rules.information or rules.dms
-        if isinstance(input_rules, DMSRules):
-            info_rules = DMSToInformation().transform(input_rules)
-        elif isinstance(input_rules, InformationRules):
-            info_rules = input_rules
-        else:
-            raise NotImplementedError(f"Unsupported rules type {type(input_rules)}")
-
-        exporter = exporters.OWLExporter()
-        exporter.export_to_file(info_rules, storage_path)
-
-        relative_file_path = "/".join(storage_path.relative_to(self.data_store_path).parts)
-
-        output_text = (
-            "<p></p>"
-            "Rules exported as OWL ontology can be downloaded here : "
-            f'<a href="/data/{relative_file_path}?{time.time()}" '
-            f'target="_blank">{storage_path.stem}.ttl</a>'
-        )
-
-        return FlowMessage(output_text=output_text)
-
-
-class RulesToSHACL(Step):
-    """
-    This step exports Rules to SHACL
-    """
-
-    description = "This step exports Rules to SHACL"
-    version = "private-beta"
-    category = CATEGORY
-    configurables: ClassVar[list[Configurable]] = [
-        Configurable(
-            name="File path",
-            value="staging/shacl.ttl",
-            label=(
-                "Relative path for the shacl file storage, "
-                "must end with .ttl ! It will be auto-created if not provided !"
-            ),
-        )
-    ]
-
-    def run(self, rules: MultiRuleData) -> FlowMessage:  # type: ignore[override, syntax]
-        if self.configs is None or self.data_store_path is None:
-            raise WorkflowStepNotInitializedError(type(self).__name__)
-
-        if not rules.information and not rules.dms:
-            return FlowMessage(
-                error_text="Rules must be made either by Information Architect or DMS Architect!",
-                step_execution_status=StepExecutionStatus.ABORT_AND_FAIL,
-            )
-
-        default_path = self.config.staging_path / _get_default_file_name(rules, "shacl", "ttl")
-
-        storage_path = (
-            self.data_store_path / Path(self.configs["File path"]) if self.configs["File path"] else default_path
-        )
-        storage_path.parent.mkdir(parents=True, exist_ok=True)
-
-        input_rules = rules.information or rules.dms
-        if isinstance(input_rules, DMSRules):
-            info_rules = DMSToInformation().transform(input_rules)
-        elif isinstance(input_rules, InformationRules):
-            info_rules = input_rules
-        else:
-            raise NotImplementedError(f"Unsupported rules type {type(input_rules)}")
-
-        exporter = exporters.SHACLExporter()
-        exporter.export_to_file(info_rules, storage_path)
-
-        relative_file_path = "/".join(storage_path.relative_to(self.data_store_path).parts)
-
-        output_text = (
-            "<p></p>"
-            "Rules exported as SHACL shapes can be downloaded here : "
-            f'<a href="/data/{relative_file_path}?{time.time()}" '
-            f'target="_blank">{storage_path.stem}.ttl</a>'
-        )
-
-        return FlowMessage(output_text=output_text)
-
-
-class RulesToSemanticDataModel(Step):
-    """
-    This step exports Rules to semantic data model
-    """
-
-    description = "This step exports Rules to semantic data model (ontology + SHACL)"
-    version = "private-beta"
-    category = CATEGORY
-    configurables: ClassVar[list[Configurable]] = [
-        Configurable(
-            name="File path",
-            value="staging/semantic-data-model.ttl",
-            label=(
-                "Relative path for the semantic data model file storage, "
-                "must end with .ttl ! It will be auto-created if not provided !"
-            ),
-        )
-    ]
-
-    def run(self, rules: MultiRuleData) -> FlowMessage:  # type: ignore[override, syntax]
-        if self.configs is None or self.data_store_path is None:
-            raise WorkflowStepNotInitializedError(type(self).__name__)
-
-        if not rules.information and not rules.dms:
-            return FlowMessage(
-                error_text="Rules must be made either by Information Architect or DMS Architect!",
-                step_execution_status=StepExecutionStatus.ABORT_AND_FAIL,
-            )
-
-        default_path = self.config.staging_path / _get_default_file_name(rules, "semantic-data-model", "ttl")
-
-        storage_path = (
-            self.data_store_path / Path(self.configs["File path"]) if self.configs["File path"] else default_path
-        )
-        storage_path.parent.mkdir(parents=True, exist_ok=True)
-        input_rules = rules.information or rules.dms
-        if isinstance(input_rules, DMSRules):
-            info_rules = DMSToInformation().transform(input_rules)
-        elif isinstance(input_rules, InformationRules):
-            info_rules = input_rules
-        else:
-            raise NotImplementedError(f"Unsupported rules type {type(input_rules)}")
-        exporter = exporters.SemanticDataModelExporter()
-        exporter.export_to_file(info_rules, storage_path)
-
-        relative_file_path = "/".join(storage_path.relative_to(self.data_store_path).parts)
-
-        output_text = (
-            "<p></p>"
-            "Rules exported as semantic data model (OWL + SHACL) can be downloaded here : "
-            f'<a href="/data/{relative_file_path}?{time.time()}" '
-            f'target="_blank">{storage_path.stem}.ttl</a>'
-        )
-
-        return FlowMessage(output_text=output_text)
-
-
-def _get_default_file_name(rules: MultiRuleData, file_category: str = "ontology", extension: str = "ttl") -> str:
-    name = rules.information.metadata.prefix if rules.information else cast(DMSRules, rules.dms).metadata.space
-    version = rules.information.metadata.version if rules.information else cast(DMSRules, rules.dms).metadata.version
-    return f"{name}-v{version.strip().replace('.', '_')}-{file_category}.{extension}"