cognite-neat 0.78.5__py3-none-any.whl → 0.79.0__py3-none-any.whl

cognite/neat/_version.py

@@ -1 +1 @@
-__version__ = "0.78.5"
+__version__ = "0.79.0"

cognite/neat/graph/stores/_base.py

@@ -3,10 +3,12 @@ import sys
 import time
 from abc import ABC, abstractmethod
 from collections.abc import Iterable, Iterator
+from datetime import datetime
 from pathlib import Path
 from typing import Literal, TypeAlias, cast
 
 import pandas as pd
+import pytz
 from prometheus_client import Gauge, Summary
 from rdflib import RDF, Graph, Namespace, URIRef
 from rdflib.query import Result, ResultRow
@@ -16,6 +18,8 @@ from cognite.neat.graph.models import Triple
 from cognite.neat.graph.stores._rdf_to_graph import rdf_file_to_graph
 from cognite.neat.utils import remove_namespace
 
+from ._provenance import Change, Provenance
+
 if sys.version_info >= (3, 11):
     pass
 else:
@@ -49,6 +53,7 @@ class NeatGraphStoreBase(ABC):
         namespace: Namespace = DEFAULT_NAMESPACE,
         prefixes: dict = PREFIXES,
     ):
+        _start = datetime.now(pytz.utc)
         self.graph = graph or Graph()
         self.base_prefix: str = base_prefix
         self.namespace: Namespace = namespace
@@ -63,6 +68,16 @@ class NeatGraphStoreBase(ABC):
         self.internal_storage_dir_orig: Path | None = None
         self.storage_dirs_to_delete: list[Path] = []
         self.queries = _Queries(self)
+        self.provenance = Provenance(
+            [
+                Change.record(
+                    activity=f"{type(self).__name__}.__init__",
+                    start=_start,
+                    end=datetime.now(pytz.utc),
+                    description="Initialize graph store",
+                )
+            ]
+        )
 
     @abstractmethod
     def _set_graph(self) -> None:

cognite/neat/graph/stores/_provenance.py

@@ -0,0 +1,99 @@
+# we will use prov-o to represent the provenance of the neat graph store
+# basically tracking changes that occur in the graph store
+# prov-o use concepts of Agent, Activity and Entity to represent provenance
+# where in case of neat we have:
+# Agent: triples extractors, graph enhancers, contextualizers, etc.
+# Activity: write triple, add connection, etc.
+# Entity: neat graph store
+
+
+import uuid
+from collections import UserList
+from collections.abc import Sequence
+from dataclasses import dataclass
+from datetime import datetime
+from typing import TypeVar
+
+from rdflib import PROV, RDF, Literal, URIRef
+
+from cognite.neat.constants import DEFAULT_NAMESPACE
+
+
+@dataclass(frozen=True)
+class Agent:
+    id_: URIRef = DEFAULT_NAMESPACE.agent
+    acted_on_behalf_of: str = "NEAT"
+
+    def as_triples(self):
+        return [
+            (self.id_, RDF.type, PROV[type(self).__name__]),
+            (self.id_, PROV.actedOnBehalfOf, self.acted_on_behalf_of),
+        ]
+
+
+@dataclass(frozen=True)
+class Activity:
+    was_associated_with: Agent
+    ended_at_time: datetime
+    started_at_time: datetime
+    used: str  # this would be set to for example Extractor, Enhancer, Contextualizer, etc.
+    id_: URIRef = DEFAULT_NAMESPACE[f"activity-{uuid.uuid4()}"]
+
+    def as_triples(self):
+        return [
+            (self.id_, RDF.type, PROV[type(self).__name__]),
+            (self.id_, PROV.wasAssociatedWith, self.was_associated_with.id_),
+            (self.id_, PROV.startedAtTime, Literal(self.started_at_time)),
+            (self.id_, PROV.endedAtTime, Literal(self.ended_at_time)),
+            (self.id_, PROV.used, self.used),
+        ]
+
+
+@dataclass(frozen=True)
+class Entity:
+    was_generated_by: Activity
+    was_attributed_to: Agent
+    id_: URIRef = DEFAULT_NAMESPACE["graph-store"]
+
+    def as_triples(self):
+        return [
+            (self.id_, RDF.type, PROV[type(self).__name__]),
+            (self.id_, PROV.wasGeneratedBy, self.was_generated_by.id_),
+            (self.id_, PROV.wasAttributedTo, self.was_attributed_to.id_),
+        ]
+
+
+@dataclass(frozen=True)
+class Change:
+    agent: Agent
+    activity: Activity
+    entity: Entity
+    description: str
+
+    def as_triples(self):
+        return self.agent.as_triples() + self.activity.as_triples() + self.entity.as_triples()
+
+    @classmethod
+    def record(cls, activity: str, start: datetime, end: datetime, description: str):
+        """User friendly method to record a change that occurred in the graph store."""
+        agent = Agent()
+        activity = Activity(used=activity, was_associated_with=agent, started_at_time=start, ended_at_time=end)
+        entity = Entity(was_generated_by=activity, was_attributed_to=agent)
+        return cls(agent, activity, entity, description)
+
+
+T_Change = TypeVar("T_Change", bound=Change)
+
+
+class Provenance(UserList[T_Change]):
+    def __init__(self, changes: Sequence[T_Change] | None = None):
+        super().__init__(changes or [])
+
+    def did_this_happen(self, this: str) -> bool:
+        return any(change.description == this for change in self)
+
+    def __delitem__(self, *args, **kwargs):
+        raise TypeError("Cannot delete change from provenance")
+
+    def __setitem__(self, *args, **kwargs):
+        raise TypeError("Cannot modify change from provenance")

{cognite_neat-0.78.5.dist-info → cognite_neat-0.79.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cognite-neat
-Version: 0.78.5
+Version: 0.79.0
 Summary: Knowledge graph transformation
 Home-page: https://cognite-neat.readthedocs-hosted.com/
 License: Apache-2.0

{cognite_neat-0.78.5.dist-info → cognite_neat-0.79.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 cognite/neat/__init__.py,sha256=v-rRiDOgZ3sQSMQKq0vgUQZvpeOkoHFXissAx6Ktg84,61
-cognite/neat/_version.py,sha256=2uubg0ZmASu9ykJZHeQzJ7RUMWo2b-kKPcvmMJ5XS4A,23
+cognite/neat/_version.py,sha256=1nnRuZbUvt4h80F41M2EZqt3TsZYyhJ2C2rRdk9uzhA,23
 cognite/neat/app/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cognite/neat/app/api/asgi/metrics.py,sha256=nxFy7L5cChTI0a-zkCiJ59Aq8yLuIJp5c9Dg0wRXtV0,152
 cognite/neat/app/api/configuration.py,sha256=2U5M6M252swvQPQyooA1EBzFUZNtcTmuSaywfJDgckM,4232
@@ -70,11 +70,12 @@ cognite/neat/graph/loaders/_base.py,sha256=VOCRIee9ms6FuBlT3mwBV_mQnI6bO53mrardq
 cognite/neat/graph/loaders/_rdf2dms.py,sha256=bVFLjukCwEUGVoyQ6YnmdRXV945fhX3SiHR6yHLXO2k,12873
 cognite/neat/graph/models.py,sha256=AtLgZh2qyRP6NRetjQCy9qLMuTQB0CH52Zsev-qa2sk,149
 cognite/neat/graph/stores/__init__.py,sha256=ivvk7STSo-4wuP_CpizKUCPKmt_ufpNWRJUN9Bv5gdY,543
-cognite/neat/graph/stores/_base.py,sha256=ZrPDfWjmO3nJwpLS6r0ru7LZAhMtOcA76-v5akHq-kQ,14226
+cognite/neat/graph/stores/_base.py,sha256=ZeeHxPHV0TU5B3Ep2db6FOkB1VP1gbJzKRjcY46zqGg,14682
 cognite/neat/graph/stores/_graphdb_store.py,sha256=8QM8I4srDKNsR0PddN6htCYUhfkoqlyy-c232Os7C0A,1776
 cognite/neat/graph/stores/_memory_store.py,sha256=GQq19xiyAWU0WQU5txmWnLXBuyP6ywd8plR21UtD3Uw,1420
 cognite/neat/graph/stores/_oxigraph_store.py,sha256=Xj69oE4M-9aqd8bq5CpLCMAhwNjJQAP1AC7lxzDsCn0,5448
 cognite/neat/graph/stores/_oxrdflib.py,sha256=A5zeRm5_e8ui_ihGpgstRDg_N7qcLZ3QZBRGrOXSGI0,9569
+cognite/neat/graph/stores/_provenance.py,sha256=Y20-I8dP3DwTQ1sdI_eC4va2Az2FpK0oZwdfJ5T-2wc,3279
 cognite/neat/graph/stores/_rdf_to_graph.py,sha256=1ezWHTPn9UkIsAlxZcYRlqWvj3ixlmB5GGG9NN0ls2Q,1244
 cognite/neat/issues.py,sha256=pxQfqfBseMDE8JM0iqZnkLXngeyeFfT0TFtu1UuAd4c,4629
 cognite/neat/legacy/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -293,8 +294,8 @@ cognite/neat/workflows/steps_registry.py,sha256=fkTX14ZA7_gkUYfWIlx7A1XbCidvqR23
 cognite/neat/workflows/tasks.py,sha256=dqlJwKAb0jlkl7abbY8RRz3m7MT4SK8-7cntMWkOYjw,788
 cognite/neat/workflows/triggers.py,sha256=_BLNplzoz0iic367u1mhHMHiUrCwP-SLK6_CZzfODX0,7071
 cognite/neat/workflows/utils.py,sha256=gKdy3RLG7ctRhbCRwaDIWpL9Mi98zm56-d4jfHDqP1E,453
-cognite_neat-0.78.5.dist-info/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
-cognite_neat-0.78.5.dist-info/METADATA,sha256=cndbsOaHg6ndd8FtHUJVa5ojU6kQvr_ikXsByBRloW8,9298
-cognite_neat-0.78.5.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-cognite_neat-0.78.5.dist-info/entry_points.txt,sha256=61FPqiWb25vbqB0KI7znG8nsg_ibLHBvTjYnkPvNFso,50
-cognite_neat-0.78.5.dist-info/RECORD,,
+cognite_neat-0.79.0.dist-info/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
+cognite_neat-0.79.0.dist-info/METADATA,sha256=Ww02h9AuPpAD5i76P15Q0T3gYFtxd2crDdFGX0yxcBg,9298
+cognite_neat-0.79.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+cognite_neat-0.79.0.dist-info/entry_points.txt,sha256=61FPqiWb25vbqB0KI7znG8nsg_ibLHBvTjYnkPvNFso,50
+cognite_neat-0.79.0.dist-info/RECORD,,