cognite-neat 0.87.6__py3-none-any.whl → 0.88.0__py3-none-any.whl

cognite/neat/workflows/steps/lib/legacy/graph_store.py

@@ -1,307 +0,0 @@
-import logging
-from pathlib import Path
-from typing import ClassVar, cast
-
-from cognite.neat.constants import DEFAULT_NAMESPACE, get_default_prefixes
-from cognite.neat.legacy.graph import stores
-from cognite.neat.workflows._exceptions import StepNotInitialized
-from cognite.neat.workflows.model import FlowMessage
-from cognite.neat.workflows.steps.data_contracts import (
-    RulesData,
-    SolutionGraph,
-    SourceGraph,
-)
-from cognite.neat.workflows.steps.step_model import Configurable, Step
-
-__all__ = ["ResetGraphStores", "ConfigureGraphStore"]
-
-CATEGORY = __name__.split(".")[-1].replace("_", " ").title() + " [LEGACY]"
-
-
-class ConfigureDefaultGraphStores(Step):
-    """
-    This step initializes the source and solution graph stores
-    """
-
-    description = "This step initializes the source and solution graph stores."
-    category = CATEGORY
-    version = "legacy"
-    configurables: ClassVar[list[Configurable]] = [
-        Configurable(
-            name="source_rdf_store.type",
-            value=stores.OxiGraphStore.rdf_store_type,
-            label="Data store type for source graph. Supported: oxigraph, memory,file, graphdb, sparql. ",
-            options=["oxigraph", "memory", "file", "graphdb", "sparql"],
-        ),
-        Configurable(
-            name="solution_rdf_store.type",
-            value=stores.OxiGraphStore.rdf_store_type,
-            label="Data store type for solutioin graph. Supported: oxigraph, memory,file, graphdb, sparql",
-            options=["oxigraph", "memory", "file", "graphdb", "sparql"],
-        ),
-        Configurable(
-            name="source_rdf_store.disk_store_dir",
-            value="source-graph-store",
-            label="Local directory for source graph store",
-        ),
-        Configurable(
-            name="source_rdf_store.query_url",
-            value="",
-            label="Sparql query endpoint.Only for sparql and graphdb store type",
-        ),
-        Configurable(
-            name="source_rdf_store.update_url",
-            value="",
-            label="Sparql update endpoint.Only for sparql and graphdb store type",
-        ),
-        Configurable(
-            name="solution_rdf_store.query_url",
-            value="",
-            label="Sparql query endpoint.Only for sparql and graphdb store type",
-        ),
-        Configurable(
-            name="solution_rdf_store.update_url",
-            value="",
-            label="Sparql update endpoint.Only for sparql and graphdb store type",
-        ),
-        Configurable(
-            name="solution_rdf_store.disk_store_dir",
-            value="solution-graph-store",
-            label="Local directory for solution graph store",
-        ),
-        Configurable(
-            name="stores_to_configure",
-            value="all",
-            label="Defines which stores to configure",
-            options=["all", "source", "solution"],
-        ),
-        Configurable(
-            name="solution_rdf_store.api_root_url",
-            value="",
-            label="Root url for graphdb or sparql endpoint",
-        ),
-    ]
-
-    def run(self, rules_data: RulesData | None = None) -> (FlowMessage, SourceGraph, SolutionGraph):  # type: ignore[override, syntax]
-        prefixes = rules_data.rules.prefixes if rules_data else get_default_prefixes()
-
-        if self.configs is None or self.data_store_path is None:
-            raise StepNotInitialized(type(self).__name__)
-        logging.info("Initializing source graph")
-        stores_to_configure = self.configs["stores_to_configure"]
-        source_store_dir = self.configs["source_rdf_store.disk_store_dir"]
-        source_store_dir = Path(self.data_store_path) / Path(source_store_dir) if source_store_dir else None
-        source_store_type = self.configs["source_rdf_store.type"]
-        if stores_to_configure in ["all", "source"]:
-            if source_store_type == stores.OxiGraphStore.rdf_store_type and "SourceGraph" in self.flow_context:
-                cast(SourceGraph, self.flow_context["SourceGraph"]).graph.upsert_prefixes(prefixes)
-                return FlowMessage(output_text="Stores already configured")
-            try:
-                store_cls = stores.STORE_BY_TYPE[source_store_type]
-            except KeyError:
-                return FlowMessage(output_text="Invalid store type")
-            source_graph = store_cls(prefixes=prefixes, base_prefix="neat", namespace=DEFAULT_NAMESPACE)
-
-            source_graph.init_graph(
-                self.configs["source_rdf_store.query_url"],
-                self.configs["source_rdf_store.update_url"],
-                "neat-tnt",
-                internal_storage_dir=source_store_dir,
-            )
-            if stores_to_configure == "source":
-                return FlowMessage(output_text="Source graph store configured successfully"), SourceGraph(
-                    graph=source_graph
-                )
-        else:
-            source_graph = None
-
-        if stores_to_configure in ["all", "solution"]:
-            solution_store_dir = self.configs["solution_rdf_store.disk_store_dir"]
-            solution_store_dir = self.data_store_path / Path(solution_store_dir) if solution_store_dir else None
-            solution_store_type = self.configs["solution_rdf_store.type"]
-
-            if solution_store_type == stores.OxiGraphStore.rdf_store_type and "SolutionGraph" in self.flow_context:
-                cast(SolutionGraph, self.flow_context["SolutionGraph"]).graph.upsert_prefixes(prefixes)
-                return FlowMessage(output_text="Stores already configured")
-
-            try:
-                solution_graph = stores.STORE_BY_TYPE[solution_store_type](
-                    prefixes=prefixes, base_prefix="neat", namespace=DEFAULT_NAMESPACE
-                )
-            except KeyError:
-                return FlowMessage(output_text="Invalid store type")
-
-            solution_graph.init_graph(
-                self.configs["solution_rdf_store.query_url"],
-                self.configs["solution_rdf_store.update_url"],
-                "tnt-solution",
-                internal_storage_dir=solution_store_dir,
-            )
-
-            if isinstance(solution_graph, stores.GraphDBStore):
-                solution_graph.graph_db_rest_url = self.configs["solution_rdf_store.api_root_url"]
-
-            if stores_to_configure == "solution":
-                return FlowMessage(output_text="Solution graph store configured successfully"), SolutionGraph(
-                    graph=solution_graph
-                )
-        else:
-            solution_graph = None
-
-        return (
-            FlowMessage(output_text="All graph stores configured successfully"),
-            SourceGraph(graph=source_graph) if source_graph else None,
-            SolutionGraph(graph=solution_graph) if solution_graph else None,
-        )
-
-
-class ResetGraphStores(Step):
-    """
-    This step resets graph stores to their initial state (clears all data)
-    """
-
-    description = "This step resets graph stores to their initial state (clears all data)."
-    category = CATEGORY
-    version = "legacy"
-    configurables: ClassVar[list[Configurable]] = [
-        Configurable(
-            name="graph_name",
-            value="source",
-            label="Name of the data store. Supported: solution, source ",
-            options=["source", "solution"],
-        )
-    ]
-
-    def run(self) -> FlowMessage:  # type: ignore[override, syntax]
-        if self.configs is None or self.data_store_path is None:
-            raise StepNotInitialized(type(self).__name__)
-        graph_name_mapping = {"source": "SourceGraph", "solution": "SolutionGraph"}
-
-        graph_name = graph_name_mapping[self.configs["graph_name"]]
-        graph_store = cast(SourceGraph | SolutionGraph | None, self.flow_context.get(graph_name, None))
-        if graph_store is not None:
-            reset_store(graph_store.graph.internal_storage_dir, graph_store.graph)
-            if graph_name in self.flow_context:
-                del self.flow_context[graph_name]
-            return FlowMessage(output_text="Reset operation completed")
-        else:
-            return FlowMessage(output_text="Stores already reset")
-
-
-class ConfigureGraphStore(Step):
-    """
-    This step initializes source OR solution graph store
-    """
-
-    description = "This step initializes the source and solution graph stores."
-    version = "legacy"
-    category = CATEGORY
-    configurables: ClassVar[list[Configurable]] = [
-        Configurable(
-            name="graph_name",
-            value="source",
-            label="Name of the data store. Supported: solution, source ",
-            options=["source", "solution"],
-        ),
-        Configurable(
-            name="store_type",
-            value=stores.OxiGraphStore.rdf_store_type,
-            label="Data store type for source graph. Supported: oxigraph, memory,file, graphdb, sparql. ",
-            options=["oxigraph", "memory", "file", "graphdb", "sparql"],
-        ),
-        Configurable(
-            name="disk_store_dir",
-            value="source-graph-store",
-            label="Local directory that is used as local graph store.Only for oxigraph, file store types",
-        ),
-        Configurable(
-            name="sparql_query_url",
-            value="",
-            label="Query url for sparql endpoint.Only for sparql store type",
-        ),
-        Configurable(
-            name="sparql_update_url",
-            value="",
-            label="Update url for sparql endpoint.Only for sparql store type",
-        ),
-        Configurable(
-            name="db_server_api_root_url",
-            value="",
-            label="Root url for graphdb or sparql endpoint.Only for graphdb",
-        ),
-        Configurable(
-            name="init_procedure",
-            value="reset",
-            label="Operations to be performed on the graph store as part of init and configuration process. \
-              Supported options : reset, clear, none",
-            options=["reset", "none"],
-        ),
-    ]
-
-    def run(  # type: ignore[override]
-        self, rules_data: RulesData | None = None
-    ) -> (FlowMessage, SourceGraph | SolutionGraph):  # type: ignore[syntax]
-        if self.configs is None or self.data_store_path is None:
-            raise StepNotInitialized(type(self).__name__)
-        logging.info("Initializing graph")
-        store_dir = self.data_store_path / Path(value) if (value := self.configs["disk_store_dir"]) else None
-        store_type = self.configs["store_type"]
-        graph_name_mapping = {"source": "SourceGraph", "solution": "SolutionGraph"}
-
-        graph_name = graph_name_mapping[self.configs["graph_name"]]
-        graph_store = cast(SourceGraph | SolutionGraph | None, self.flow_context.get(graph_name, None))
-        if self.configs["init_procedure"] == "reset":
-            logging.info("Resetting graph")
-            reset_store(store_dir, graph_store.graph if graph_store else None)
-            if graph_name in self.flow_context:
-                del self.flow_context[graph_name]
-            graph_store = None
-            logging.info("Graph reset complete")
-
-        prefixes = rules_data.rules.prefixes if rules_data else get_default_prefixes()
-
-        if store_type == stores.OxiGraphStore.rdf_store_type and graph_store is not None:
-            # OXIGRAPH doesn't like to be initialized twice without a good reason
-            graph_store.graph.upsert_prefixes(prefixes)
-            return FlowMessage(output_text="Stores already configured")
-        try:
-            store_cls = stores.STORE_BY_TYPE[store_type]
-        except KeyError:
-            return FlowMessage(output_text="Invalid store type")
-
-        new_graph_store = store_cls(prefixes=prefixes, base_prefix="neat", namespace=DEFAULT_NAMESPACE)
-        new_graph_store.init_graph(
-            self.configs["sparql_query_url"],
-            self.configs["sparql_update_url"],
-            "neat-tnt",
-            internal_storage_dir=store_dir,
-        )
-        logging.info(50 * "*")
-        logging.info(50 * "*")
-        logging.info(50 * "*")
-        logging.info(type(new_graph_store))
-        logging.info(50 * "*")
-        logging.info(50 * "*")
-
-        return (
-            FlowMessage(output_text="Graph store configured successfully"),
-            (
-                SourceGraph(graph=new_graph_store)
-                if graph_name == "SourceGraph"
-                else SolutionGraph(graph=new_graph_store)
-            ),
-        )
-
-
-def reset_store(data_store_dir: Path | None, graph_store: stores.NeatGraphStoreBase | None = None):
-    if isinstance(graph_store, stores.OxiGraphStore):
-        if graph_store:
-            graph_store.close()
-            graph_store.drop_graph_store_storage(data_store_dir)
-        elif data_store_dir:
-            graph_store.drop_graph_store_storage(data_store_dir)
-    elif isinstance(graph_store, stores.GraphDBStore):
-        if graph_store:
-            graph_store.drop()
-            graph_store.reinitialize_graph()
-    return None

cognite/neat/workflows/steps/lib/legacy/graph_transformer.py

@@ -1,58 +0,0 @@
-from typing import ClassVar
-
-from cognite.client import CogniteClient
-
-from cognite.neat.legacy.graph.transformations.transformer import RuleProcessingReport, domain2app_knowledge_graph
-from cognite.neat.legacy.rules.exporters._rules2triples import get_instances_as_triples
-from cognite.neat.workflows.model import FlowMessage
-from cognite.neat.workflows.steps.data_contracts import RulesData, SolutionGraph, SourceGraph
-from cognite.neat.workflows.steps.step_model import Configurable, Step
-
-__all__ = ["TransformSourceToSolutionGraph"]
-
-CATEGORY = __name__.split(".")[-1].replace("_", " ").title() + " [LEGACY]"
-
-
-class TransformSourceToSolutionGraph(Step):
-    """
-    The step transforms source graph to solution graph
-    """
-
-    description = "The step transforms source graph to solution graph"
-    category = CATEGORY
-    version = "legacy"
-    configurables: ClassVar[list[Configurable]] = [
-        Configurable(
-            name="cdf_lookup_database",
-            value="",
-            label="Name of the CDF raw database to use for data lookup (rawlookup rules).\
-            Applicable only for transformations with rawlookup rules.",
-        )
-    ]
-
-    def run(  # type: ignore[override, syntax]
-        self,
-        transformation_rules: RulesData,
-        cdf_client: CogniteClient,
-        source_graph: SourceGraph,
-        solution_graph: SolutionGraph,
-    ) -> FlowMessage:
-        report = RuleProcessingReport()
-        # run transformation and generate new graph
-        cdf_lookup_database = self.configs.get("cdf_lookup_database", "")
-        solution_graph.graph.set_graph(
-            domain2app_knowledge_graph(
-                source_graph.graph.get_graph(),
-                transformation_rules.rules,
-                app_instance_graph=solution_graph.graph.get_graph(),
-                extra_triples=get_instances_as_triples(transformation_rules.rules),
-                client=cdf_client,
-                cdf_lookup_database=cdf_lookup_database,  # change this accordingly!
-                processing_report=report,
-            )
-        )
-        return FlowMessage(
-            output_text=f"Total processed rules: { report.total_rules } , success: { report.total_success } , \
-             no results: { report.total_success_no_results } , failed: { report.total_failed }",
-            payload=report,
-        )