cognite-neat 0.74.0__py3-none-any.whl → 0.75.2__py3-none-any.whl

cognite/neat/legacy/graph/examples/__init__.py

@@ -0,0 +1,7 @@
+from pathlib import Path
+
+# we should make this a proper package that loads examples
+# similar how they handle it in xarray:
+# https://github.com/pydata/xarray/blob/main/xarray/tutorial.py
+# Currently there are simple paths to the examples which are then easily loaded in the notebooks
+nordic44_knowledge_graph = Path(__file__).parent / "Knowledge-Graph-Nordic44.xml"

cognite/neat/legacy/graph/exceptions.py

@@ -0,0 +1,91 @@
+"""This module contains the definition of validation errors and warnings raised during graph methods
+"""
+
+from cognite.neat.constants import DEFAULT_DOCS_URL
+from cognite.neat.exceptions import NeatException
+
+DOCS_BASE_URL = f"{DEFAULT_DOCS_URL}api/exceptions.html#{__name__}"
+
+
+class UnsupportedPropertyType(NeatException):
+    """Unsupported property type when processing the graph capturing sheet
+
+    Args:
+        property_type: property type that is not supported
+        verbose: flag that indicates whether to provide enhanced exception message, by default False
+    """
+
+    type_: str = "UnsupportedPropertyType"
+    code: int = 1000
+    description: str = "Unsupported property type when processing the graph capturing sheet."
+    example: str = ""
+    fix: str = ""
+
+    def __init__(self, property_type: str, verbose: bool = False):
+        self.property_type = property_type
+
+        self.message = (
+            f"Property type {self.property_type} is not supported. "
+            " Only the following property types are supported: DatatypeProperty and ObjectProperty"
+            f"\nFor more information visit: {DOCS_BASE_URL}.{self.__class__.__name__}"
+        )
+
+        if verbose:
+            self.message += f"\nDescription: {self.description}"
+            self.message += f"\nExample: {self.example}"
+            self.message += f"\nFix: {self.fix}"
+        super().__init__(self.message)
+
+
+class NamespaceRequired(NeatException):
+    """The functionality requires namespace in the TransformationRules.
+
+    Args:
+        functionality: functionality that requires namespace
+        verbose: flag that indicates whether to provide enhanced exception message, by default False
+    """
+
+    type_ = "NamespaceRequired"
+    description: str = "The functionality requires namespace in the TransformationRules."
+    example: str = ""
+    fix: str = ""
+
+    def __init__(self, functionality: str, verbose: bool = False):
+        self.message = (
+            f"Namespace is required to be set in the Transformation rules"
+            f"to use {functionality}."
+            f"\nFor more information visit: {DOCS_BASE_URL}.{self.__class__.__name__}"
+        )
+
+        if verbose:
+            self.message += f"\nDescription: {self.description}"
+            self.message += f"\nExample: {self.example}"
+            self.message += f"\nFix: {self.fix}"
+        super().__init__(self.message)
+
+
+class DatasetIdRequired(NeatException):
+    """The functionality requires data_set_id in the TransformationRules.
+
+    Args:
+        functionality: functionality that requires namespace
+        verbose: flag that indicates whether to provide enhanced exception message, by default False
+    """
+
+    type_ = "DatasetIdRequired"
+    description: str = "The functionality requires data_set_id in the TransformationRules."
+    example: str = ""
+    fix: str = ""
+
+    def __init__(self, functionality: str, verbose: bool = False):
+        self.message = (
+            f"DataSetId is required to be set in the Transformation rules"
+            f"to use {functionality}."
+            f"\nFor more information visit: {DOCS_BASE_URL}.{self.__class__.__name__}"
+        )
+
+        if verbose:
+            self.message += f"\nDescription: {self.description}"
+            self.message += f"\nExample: {self.example}"
+            self.message += f"\nFix: {self.fix}"
+        super().__init__(self.message)

cognite/neat/{graph/extractor → legacy/graph/extractors}/_base.py

@@ -1,7 +1,7 @@
 from abc import abstractmethod
 from collections.abc import Iterable
 
-from cognite.neat.graph.models import Triple
+from cognite.neat.legacy.graph.models import Triple
 
 
 class BaseExtractor:

cognite/neat/{graph/extractor → legacy/graph/extractors}/_dexpi.py

@@ -6,8 +6,8 @@ from xml.etree.ElementTree import Element
 from rdflib import OWL, RDF, RDFS, SKOS, XSD, Literal, Namespace, URIRef
 
 from cognite.neat.constants import PREFIXES
-from cognite.neat.graph.models import Triple
-from cognite.neat.rules.models._base import ALLOWED_PATTERN
+from cognite.neat.legacy.graph.models import Triple
+from cognite.neat.legacy.rules.models._base import ALLOWED_PATTERN
 from cognite.neat.utils.utils import get_namespace, remove_namespace
 from cognite.neat.utils.xml import get_children, iterate_tree
 

cognite/neat/{graph/extractor → legacy/graph/extractors}/_graph_capturing_sheet.py

@@ -14,12 +14,12 @@ from openpyxl.worksheet.datavalidation import DataValidation
 from openpyxl.worksheet.worksheet import Worksheet
 from rdflib import RDF, XSD, Literal, Namespace, URIRef
 
-from cognite.neat.graph import exceptions
-from cognite.neat.graph.exceptions import NamespaceRequired
-from cognite.neat.graph.models import Triple
-from cognite.neat.rules.analysis import get_defined_classes, to_class_property_pairs
-from cognite.neat.rules.exporter._rules2rules import to_dms_name
-from cognite.neat.rules.models.rules import Rules
+from cognite.neat.legacy.graph import exceptions
+from cognite.neat.legacy.graph.exceptions import NamespaceRequired
+from cognite.neat.legacy.graph.models import Triple
+from cognite.neat.legacy.rules.analysis import get_defined_classes, to_class_property_pairs
+from cognite.neat.legacy.rules.exporters._rules2rules import to_dms_name
+from cognite.neat.legacy.rules.models.rules import Rules
 
 from ._base import BaseExtractor
 

cognite/neat/{graph/extractor → legacy/graph/extractors}/_mock_graph_generator.py

@@ -1,5 +1,6 @@
 """This module is used to generate mock graph data for purposes of testing of NEAT.
 """
+
 import logging
 import random
 import warnings
@@ -10,16 +11,16 @@ import pandas as pd
 from prometheus_client import Gauge
 from rdflib import RDF, Literal, Namespace, URIRef
 
-from cognite.neat.graph.models import Triple
-from cognite.neat.rules.analysis import (
+from cognite.neat.legacy.graph.models import Triple
+from cognite.neat.legacy.rules.analysis import (
     get_class_linkage,
     get_classes_with_properties,
     get_defined_classes,
     get_symmetric_pairs,
 )
-from cognite.neat.rules.exporter._rules2rules import subset_rules
-from cognite.neat.rules.models import Rules
-from cognite.neat.rules.models.value_types import XSD_VALUE_TYPE_MAPPINGS
+from cognite.neat.legacy.rules.exporters._rules2rules import subset_rules
+from cognite.neat.legacy.rules.models import Rules
+from cognite.neat.legacy.rules.models.value_types import XSD_VALUE_TYPE_MAPPINGS
 from cognite.neat.utils.utils import remove_namespace
 
 from ._base import BaseExtractor

cognite/neat/{graph/loader → legacy/graph/loaders}/__init__.py

@@ -1,4 +1,4 @@
-from cognite.neat.graph.loader.core.labels import upload_labels
+from cognite.neat.legacy.graph.loaders.core.labels import upload_labels
 
 from ._asset_loader import AssetLoader
 from ._base import BaseLoader, CogniteLoader

cognite/neat/{graph/loader → legacy/graph/loaders}/_asset_loader.py

@@ -12,9 +12,9 @@ from cognite.client.data_classes import AssetWrite, LabelDefinitionWrite, Relati
 from pydantic_core import ErrorDetails
 from rdflib.query import ResultRow
 
-from cognite.neat.graph.stores import NeatGraphStoreBase
-from cognite.neat.rules.models import Rules
-from cognite.neat.rules.models.rules import Property
+from cognite.neat.legacy.graph.stores import NeatGraphStoreBase
+from cognite.neat.legacy.rules.models import Rules
+from cognite.neat.legacy.rules.models.rules import Property
 from cognite.neat.utils import remove_namespace
 from cognite.neat.utils.utils import epoch_now_ms
 

cognite/neat/{graph/loader → legacy/graph/loaders}/_base.py

@@ -6,10 +6,10 @@ from typing import Generic, Literal, TypeVar, overload
 from cognite.client import CogniteClient
 from pydantic_core import ErrorDetails
 
-from cognite.neat.graph.models import Triple
-from cognite.neat.graph.stores import NeatGraphStoreBase
-from cognite.neat.graph.transformation.query_generator.sparql import build_construct_query
-from cognite.neat.rules.models import Rules
+from cognite.neat.legacy.graph.models import Triple
+from cognite.neat.legacy.graph.stores import NeatGraphStoreBase
+from cognite.neat.legacy.graph.transformations.query_generator.sparql import build_construct_query
+from cognite.neat.legacy.rules.models import Rules
 
 T_Output = TypeVar("T_Output")
 

cognite/neat/{graph/loader → legacy/graph/loaders}/core/labels.py

@@ -5,8 +5,8 @@ from typing import cast
 from cognite.client import CogniteClient
 from cognite.client.data_classes import LabelDefinition, LabelDefinitionList
 
-from cognite.neat.rules.exporter._core import get_labels
-from cognite.neat.rules.models.rules import Rules
+from cognite.neat.legacy.rules.exporters._core import get_labels
+from cognite.neat.legacy.rules.models.rules import Rules
 
 
 def upload_labels(

cognite/neat/{graph/loader → legacy/graph/loaders}/core/models.py

@@ -6,7 +6,7 @@ from typing import ClassVar
 from pydantic import BaseModel, ConfigDict, root_validator, validator
 from rdflib import Namespace
 
-from cognite.neat.rules.models.rules import METADATA_VALUE_MAX_LENGTH
+from cognite.neat.legacy.rules.models.rules import METADATA_VALUE_MAX_LENGTH
 
 
 class AssetClassMapping(BaseModel):

cognite/neat/{graph/loader → legacy/graph/loaders}/core/rdf_to_assets.py

@@ -15,9 +15,9 @@ from deepdiff import DeepDiff  # type: ignore[import]
 from rdflib import Graph
 from rdflib.term import URIRef
 
-from cognite.neat.graph.loader.core.models import AssetTemplate
-from cognite.neat.graph.stores import NeatGraphStoreBase
-from cognite.neat.rules.models.rules import Property, Rules
+from cognite.neat.legacy.graph.loaders.core.models import AssetTemplate
+from cognite.neat.legacy.graph.stores import NeatGraphStoreBase
+from cognite.neat.legacy.rules.models.rules import Property, Rules
 from cognite.neat.utils.utils import chunker, datetime_utc_now, remove_namespace, retry_decorator
 
 if sys.version_info >= (3, 11):

cognite/neat/{graph/loader → legacy/graph/loaders}/core/rdf_to_relationships.py

@@ -9,11 +9,11 @@ from cognite.client import CogniteClient
 from cognite.client.data_classes import LabelFilter, Relationship, RelationshipUpdate
 from cognite.client.exceptions import CogniteDuplicatedError
 
-from cognite.neat.graph.exceptions import NamespaceRequired
-from cognite.neat.graph.loader.core.models import RelationshipDefinition, RelationshipDefinitions
-from cognite.neat.graph.loader.core.rdf_to_assets import _categorize_cdf_assets
-from cognite.neat.graph.stores import NeatGraphStoreBase
-from cognite.neat.rules.models.rules import Rules
+from cognite.neat.legacy.graph.exceptions import NamespaceRequired
+from cognite.neat.legacy.graph.loaders.core.models import RelationshipDefinition, RelationshipDefinitions
+from cognite.neat.legacy.graph.loaders.core.rdf_to_assets import _categorize_cdf_assets
+from cognite.neat.legacy.graph.stores import NeatGraphStoreBase
+from cognite.neat.legacy.rules.models.rules import Rules
 from cognite.neat.utils.utils import chunker, datetime_utc_now, epoch_now_ms, remove_namespace, retry_decorator
 
 

cognite/neat/{graph/loader → legacy/graph/loaders}/rdf_to_dms.py

@@ -8,11 +8,11 @@ from cognite.client.data_classes.data_modeling import EdgeApply, InstanceApply,
 from pydantic_core import ErrorDetails
 
 from cognite.neat.exceptions import NeatException
-from cognite.neat.graph.stores import NeatGraphStoreBase
-from cognite.neat.graph.transformation.query_generator.sparql import triples2dictionary
-from cognite.neat.rules.exporter._rules2dms import DMSSchemaComponents
-from cognite.neat.rules.exporter._rules2pydantic_models import add_class_prefix_to_xid, rules_to_pydantic_models
-from cognite.neat.rules.models.rules import Rules
+from cognite.neat.legacy.graph.stores import NeatGraphStoreBase
+from cognite.neat.legacy.graph.transformations.query_generator.sparql import triples2dictionary
+from cognite.neat.legacy.rules.exporters._rules2dms import DMSSchemaComponents
+from cognite.neat.legacy.rules.exporters._rules2pydantic_models import add_class_prefix_to_xid, rules_to_pydantic_models
+from cognite.neat.legacy.rules.models.rules import Rules
 from cognite.neat.utils.utils import chunker, datetime_utc_now, retry_decorator
 
 from ._base import CogniteLoader

cognite/neat/legacy/graph/models.py

@@ -0,0 +1,6 @@
+from typing import TypeAlias
+
+from rdflib import Literal
+from rdflib.term import URIRef
+
+Triple: TypeAlias = tuple[URIRef, URIRef, Literal | URIRef]

cognite/neat/legacy/graph/stores/__init__.py

@@ -0,0 +1,13 @@
+from ._base import NeatGraphStoreBase
+from ._graphdb_store import GraphDBStore
+from ._memory_store import MemoryStore
+from ._oxigraph_store import OxiGraphStore
+
+STORE_BY_TYPE: dict[str, type[NeatGraphStoreBase]] = {}
+for store in NeatGraphStoreBase.__subclasses__():
+    STORE_BY_TYPE[store.rdf_store_type] = store  # type: ignore[type-abstract]
+
+del store  # Cleanup namespace
+AVAILABLE_STORES = set(STORE_BY_TYPE.keys())
+
+__all__ = ["NeatGraphStoreBase", "MemoryStore", "OxiGraphStore", "GraphDBStore", "STORE_BY_TYPE", "AVAILABLE_STORES"]