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

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

@@ -1,323 +0,0 @@
-from pathlib import Path
-from typing import Any, ClassVar
-
-from cognite.client import CogniteClient
-
-from cognite.neat._client import NeatClient
-from cognite.neat._issues.errors import WorkflowStepNotInitializedError
-from cognite.neat._issues.formatters import FORMATTER_BY_NAME
-from cognite.neat._rules import importers
-from cognite.neat._rules.models import DMSRules, InformationRules, RoleTypes
-from cognite.neat._rules.models.entities import DataModelEntity, DMSUnknownEntity
-from cognite.neat._rules.transformers import DMSToInformation, InformationToDMS, VerifyAnyRules
-from cognite.neat._workflows.model import FlowMessage, StepExecutionStatus
-from cognite.neat._workflows.steps.data_contracts import MultiRuleData
-from cognite.neat._workflows.steps.step_model import Configurable, Step
-
-CATEGORY = __name__.split(".")[-1].replace("_", " ").title()
-
-__all__ = [
-    "DMSToRules",
-    "ExcelToRules",
-    "IMFToRules",
-    "OntologyToRules",
-    "RulesInferenceFromRdfFile",
-]
-
-
-class ExcelToRules(Step):
-    """This step import rules from the Excel file and validates it."""
-
-    description = "This step imports rules from an excel file "
-    version = "private-beta"
-    category = CATEGORY
-    configurables: ClassVar[list[Configurable]] = [
-        Configurable(
-            name="File name",
-            value="",
-            label="Full file name of the rules file in the rules folder. \
-                If not provided, step will attempt to get file name from payload \
-                    of 'File Uploader' step (if exist)",
-        ),
-        Configurable(
-            name="Report formatter",
-            value=next(iter(FORMATTER_BY_NAME.keys())),
-            label="The format of the report for the validation of the rules",
-            options=list(FORMATTER_BY_NAME),
-        ),
-        Configurable(
-            name="Role",
-            value="infer",
-            label="For what role Rules are intended?",
-            options=["infer", *RoleTypes.__members__.keys()],
-        ),
-    ]
-
-    def run(self, flow_message: FlowMessage) -> (FlowMessage, MultiRuleData):  # type: ignore[syntax, override]
-        if self.configs is None or self.data_store_path is None:
-            raise WorkflowStepNotInitializedError(type(self).__name__)
-
-        file_name = self.configs.get("File name", None)
-        full_path = flow_message.payload.get("full_path", None) if flow_message.payload else None
-
-        if file_name:
-            rules_file_path = Path(self.data_store_path) / "rules" / file_name
-        elif full_path:
-            rules_file_path = full_path
-        else:
-            error_text = "Expected either 'File name' in the step config or 'File uploader' step uploading Excel Rules."
-            return FlowMessage(error_text=error_text, step_execution_status=StepExecutionStatus.ABORT_AND_FAIL)
-
-        # if role is None, it will be inferred from the rules file
-        role = self.configs.get("Role")
-        role_enum: RoleTypes | None = None
-        if role != "infer" and role is not None:
-            role_enum = RoleTypes[role]
-
-        excel_importer = importers.ExcelImporter(rules_file_path)  # type: ignore[var-annotated]
-        read_rules = excel_importer.to_rules()
-        rules = VerifyAnyRules[Any]().transform(read_rules)
-        result: DMSRules | InformationRules
-        if role_enum is RoleTypes.dms and isinstance(rules, InformationRules):
-            result = InformationToDMS().transform(rules)
-        elif role_enum is RoleTypes.dms and isinstance(rules, DMSRules):
-            result = rules
-        elif role_enum is RoleTypes.information and isinstance(rules, InformationRules):
-            result = rules
-        elif role_enum is RoleTypes.information and isinstance(rules, DMSRules):
-            result = DMSToInformation().transform(rules)
-        else:
-            raise ValueError(f"Role {role_enum} is not supported for rules of type {type(rules)}")
-
-        output_text = "Rules validation passed successfully!"
-
-        return FlowMessage(output_text=output_text), MultiRuleData.from_rules(result)
-
-
-class OntologyToRules(Step):
-    """This step import rules from the ontology file (owl) and validates it."""
-
-    description = "This step imports rules from an ontology file "
-    version = "private-beta"
-    category = CATEGORY
-    configurables: ClassVar[list[Configurable]] = [
-        Configurable(
-            name="File name",
-            value="",
-            label="Full file name of the ontology file in the rules folder. \
-                If not provided, step will attempt to get file name from payload \
-                    of 'File Uploader' step (if exist)",
-        ),
-        Configurable(
-            name="Report formatter",
-            value=next(iter(FORMATTER_BY_NAME.keys())),
-            label="The format of the report for the validation of the rules",
-            options=list(FORMATTER_BY_NAME),
-        ),
-        Configurable(
-            name="Role",
-            value="infer",
-            label="For what role Rules are intended?",
-            options=["infer", *RoleTypes.__members__.keys()],
-        ),
-    ]
-
-    def run(self, flow_message: FlowMessage) -> (FlowMessage, MultiRuleData):  # type: ignore[syntax, override]
-        if self.configs is None or self.data_store_path is None:
-            raise WorkflowStepNotInitializedError(type(self).__name__)
-
-        file_name = self.configs.get("File name", None)
-        full_path = flow_message.payload.get("full_path", None) if flow_message.payload else None
-
-        if file_name:
-            rules_file_path = self.config.rules_store_path / file_name
-        elif full_path:
-            rules_file_path = full_path
-        else:
-            error_text = "Expected either 'File name' in the step config or 'File uploader' step uploading Excel Rules."
-            return FlowMessage(error_text=error_text, step_execution_status=StepExecutionStatus.ABORT_AND_FAIL)
-
-        ontology_importer = importers.OWLImporter.from_file(filepath=rules_file_path)
-        result = ontology_importer.to_rules().rules.as_verified_rules()
-        output_text = "Rules validation passed successfully!"
-
-        return FlowMessage(output_text=output_text), MultiRuleData.from_rules(result.rules)
-
-
-class IMFToRules(Step):
-    """This step import rules from the IMF-types and validates them."""
-
-    description = "This step imports rules from an RDF file "
-    version = "private-beta"
-    category = CATEGORY
-    configurables: ClassVar[list[Configurable]] = [
-        Configurable(
-            name="File name",
-            value="",
-            label="""Full file name of the RDF-file containing the IMF-types in the rules folder.
-                If not provided, step will attempt to get file name from payload
-                    of 'File Uploader' step (if exist)""",
-        ),
-        Configurable(
-            name="Report formatter",
-            value=next(iter(FORMATTER_BY_NAME.keys())),
-            label="The format of the report for the validation of the rules",
-            options=list(FORMATTER_BY_NAME),
-        ),
-        Configurable(
-            name="Role",
-            value="infer",
-            label="For what role Rules are intended?",
-            options=["infer", *RoleTypes.__members__.keys()],
-        ),
-    ]
-
-    def run(self, flow_message: FlowMessage) -> (FlowMessage, MultiRuleData):  # type: ignore[syntax, override]
-        if self.configs is None or self.data_store_path is None:
-            raise WorkflowStepNotInitializedError(type(self).__name__)
-
-        file_name = self.configs.get("File name", None)
-
-        full_path = flow_message.payload.get("full_path", None) if flow_message.payload else None
-
-        if file_name:
-            rules_file_path = self.config.rules_store_path / file_name
-
-        elif full_path:
-            rules_file_path = full_path
-        else:
-            error_text = "Expected either 'File name' in the step config or 'File uploader' step uploading Excel Rules."
-            return FlowMessage(error_text=error_text, step_execution_status=StepExecutionStatus.ABORT_AND_FAIL)
-
-        ontology_importer = importers.IMFImporter.from_file(rules_file_path)
-        result = ontology_importer.to_rules().rules.as_verified_rules()
-
-        output_text = "Rules validation passed successfully!"
-
-        return FlowMessage(output_text=output_text), MultiRuleData.from_rules(result.rules)
-
-
-class DMSToRules(Step):
-    """This step imports rules from CDF Data Model"""
-
-    description = "This step imports rules from CDF Data Model"
-    version = "private-beta"
-    category = CATEGORY
-    configurables: ClassVar[list[Configurable]] = [
-        Configurable(
-            name="Data model id",
-            value="",
-            label="The ID of the Data Model to import. Written at 'my_space:my_data_model(version=1)'",
-            type="string",
-            required=True,
-        ),
-        Configurable(
-            name="Reference data model id",
-            value="",
-            label="The ID of the Reference Data Model to import. Written at 'my_space:my_data_model(version=1)'. "
-            "This is typically an enterprise data model when you want to import a solution model",
-            type="string",
-        ),
-        Configurable(
-            name="Report formatter",
-            value=next(iter(FORMATTER_BY_NAME.keys())),
-            label="The format of the report for the validation of the rules",
-            options=list(FORMATTER_BY_NAME),
-        ),
-        Configurable(
-            name="Role",
-            value="infer",
-            label="For what role Rules are intended?",
-            options=["infer", *RoleTypes.__members__.keys()],
-        ),
-    ]
-
-    def run(self, cdf_client: CogniteClient) -> (FlowMessage, MultiRuleData):  # type: ignore[syntax, override]
-        if self.configs is None or self.data_store_path is None:
-            raise WorkflowStepNotInitializedError(type(self).__name__)
-
-        datamodel_id_str = self.configs.get("Data model id")
-        if datamodel_id_str is None:
-            error_text = "Expected input payload to contain 'Data model id' key."
-            return FlowMessage(error_text=error_text, step_execution_status=StepExecutionStatus.ABORT_AND_FAIL)
-
-        datamodel_entity = DataModelEntity.load(datamodel_id_str)
-        if isinstance(datamodel_entity, DMSUnknownEntity):
-            error_text = (
-                f"Data model id should be in the format 'my_space:my_data_model(version=1)' "
-                f"or 'my_space:my_data_model', failed to parse space from {datamodel_id_str}"
-            )
-            return FlowMessage(error_text=error_text, step_execution_status=StepExecutionStatus.ABORT_AND_FAIL)
-
-        dms_importer = importers.DMSImporter.from_data_model_id(NeatClient(cdf_client), datamodel_entity.as_id())
-
-        result = dms_importer.to_rules().rules.as_verified_rules()  # type: ignore[union-attr]
-
-        output_text = "Rules import and validation passed successfully!"
-
-        return FlowMessage(output_text=output_text), MultiRuleData.from_rules(result)
-
-
-class RulesInferenceFromRdfFile(Step):
-    """This step infers rules from the RDF file which contains knowledge graph."""
-
-    description = "This step infers rules from the RDF file which contains knowledge graph"
-    version = "private-beta"
-    category = CATEGORY
-    configurables: ClassVar[list[Configurable]] = [
-        Configurable(
-            name="File path",
-            value="staging/knowledge_graph.ttl",
-            label=("Relative path to the RDF file to be used for inference"),
-        ),
-        Configurable(
-            name="Report formatter",
-            value=next(iter(FORMATTER_BY_NAME.keys())),
-            label="The format of the report for the validation of the rules",
-            options=list(FORMATTER_BY_NAME),
-        ),
-        Configurable(
-            name="Role",
-            value="infer",
-            label="For what role Rules are intended?",
-            options=["infer", *RoleTypes.__members__.keys()],
-        ),
-        Configurable(
-            name="Maximum number of instances to process",
-            value="-1",
-            label=(
-                "Maximum number of instances to process"
-                " to infer rules from the RDF file. Default -1 means all instances."
-            ),
-        ),
-    ]
-
-    def run(self, flow_message: FlowMessage) -> (FlowMessage, MultiRuleData):  # type: ignore[syntax, override]
-        if self.configs is None or self.data_store_path is None:
-            raise WorkflowStepNotInitializedError(type(self).__name__)
-
-        file_path = self.configs.get("File path", None)
-        full_path = flow_message.payload.get("full_path", None) if flow_message.payload else None
-
-        try:
-            max_number_of_instance = int(self.configs.get("Maximum number of instances to process", -1))
-        except ValueError:
-            error_text = "Maximum number of instances to process should be an integer value"
-            return FlowMessage(error_text=error_text, step_execution_status=StepExecutionStatus.ABORT_AND_FAIL)
-
-        if file_path:
-            rdf_file_path = self.data_store_path / Path(file_path)
-        elif full_path:
-            rdf_file_path = full_path
-        else:
-            error_text = "Expected either 'File name' in the step config or 'File uploader' step uploading Excel Rules."
-            return FlowMessage(error_text=error_text, step_execution_status=StepExecutionStatus.ABORT_AND_FAIL)
-
-        inference_importer = importers.InferenceImporter.from_file(
-            rdf_file_path, max_number_of_instance=max_number_of_instance
-        )
-        result = inference_importer.to_rules().rules.as_verified_rules()  # type: ignore[union-attr]
-
-        output_text = "Rules validation passed successfully!"
-
-        return FlowMessage(output_text=output_text), MultiRuleData.from_rules(result)

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

@@ -1,106 +0,0 @@
-import logging
-import time
-from pathlib import Path
-from typing import ClassVar
-
-from cognite.client import CogniteClient
-
-from cognite.neat._client import NeatClient
-from cognite.neat._client._api.data_modeling_loaders import ViewLoader
-from cognite.neat._issues import NeatIssueList
-from cognite.neat._issues.errors import ResourceNotFoundError, WorkflowStepNotInitializedError
-from cognite.neat._issues.formatters import FORMATTER_BY_NAME
-from cognite.neat._rules.models import DMSRules
-from cognite.neat._rules.models.dms import DMSValidation
-from cognite.neat._workflows.model import FlowMessage, StepExecutionStatus
-from cognite.neat._workflows.steps.data_contracts import MultiRuleData
-from cognite.neat._workflows.steps.step_model import Configurable, Step
-
-CATEGORY = __name__.split(".")[-1].replace("_", " ").title()
-
-__all__ = [
-    "ValidateRulesAgainstCDF",
-]
-
-
-class ValidateRulesAgainstCDF(Step):
-    """This steps downloads views and containers from CDF and validates the rules against them
-
-    Note that this only applies to DMSRules
-    """
-
-    description = "This steps downloads views and containers from CDF and validates the rules against them."
-    category = CATEGORY
-    version = "private-beta"
-    configurables: ClassVar[list[Configurable]] = [
-        Configurable(
-            name="Report Formatter",
-            value=next(iter(FORMATTER_BY_NAME.keys())),
-            label="The format of the report for the validation of the rules",
-            options=list(FORMATTER_BY_NAME),
-        ),
-    ]
-
-    def run(self, rules: MultiRuleData, cdf_client: CogniteClient) -> FlowMessage:  # type: ignore[override, syntax]
-        if self.configs is None or self.data_store_path is None:
-            raise WorkflowStepNotInitializedError(type(self).__name__)
-
-        if not isinstance(rules.dms, DMSRules):
-            return FlowMessage(
-                error_text="DMS rules are missing. This step requires DMS rules to be present.",
-                step_execution_status=StepExecutionStatus.ABORT_AND_FAIL,
-            )
-        dms_rules = rules.dms
-
-        errors = DMSValidation(dms_rules, NeatClient(cdf_client)).validate()
-
-        missing_spaces = [
-            error.identifier
-            for error in errors
-            if isinstance(error, ResourceNotFoundError) and error.resource_type == "Space"
-        ]
-        missing_views = [
-            error.identifier
-            for error in errors
-            if isinstance(error, ResourceNotFoundError) and error.resource_type == "View"
-        ]
-        missing_containers = [
-            error.identifier
-            for error in errors
-            if isinstance(error, ResourceNotFoundError) and error.resource_type == "Container"
-        ]
-
-        retrieved_spaces = cdf_client.data_modeling.spaces.retrieve(missing_spaces).as_write()
-        retrieved_containers = cdf_client.data_modeling.containers.retrieve(missing_containers).as_write()
-        # Converting read format of views to write format requires to account for parents (implements)
-        # Thus we use the loader to convert the views to write format.
-        view_loader = ViewLoader(NeatClient(cdf_client))
-        retrieved_views = [
-            view_loader.as_write(view) for view in cdf_client.data_modeling.views.retrieve(missing_views)
-        ]
-        logging.info(
-            f"Retrieved {len(retrieved_spaces)} spaces, {len(retrieved_containers)} containers, "
-            f"and {len(retrieved_views)} views from CDF."
-        )
-
-        schema = dms_rules.as_schema()
-        schema.spaces.update({space.space: space for space in retrieved_spaces})
-        schema.containers.update({container.as_id(): container for container in retrieved_containers})
-        schema.views.update({view.as_id(): view for view in retrieved_views})
-
-        if errors:
-            output_dir = self.data_store_path / Path("staging")
-            report_writer = FORMATTER_BY_NAME[self.configs["Report Formatter"]]()
-            report_writer.write_to_file(
-                NeatIssueList(errors, title=dms_rules.metadata.name or dms_rules.metadata.external_id),
-                file_or_dir_path=output_dir,
-            )
-            report_file = report_writer.default_file_name
-            error_text = (
-                "<p></p>"
-                f'<a href="/data/staging/{report_file}?{time.time()}" '
-                f'target="_blank">The rules failed validation against CDF, click here for report</a>'
-            )
-            return FlowMessage(error_text=error_text, step_execution_status=StepExecutionStatus.ABORT_AND_FAIL)
-
-        return FlowMessage(output_text="Rules validated successfully against CDF")

cognite/neat/_workflows/steps/lib/io/__init__.py

@@ -1 +0,0 @@
-from .io_steps import *  # noqa