memoryframes 0.1.6__tar.gz → 0.2.0__tar.gz

{memoryframes-0.1.6 → memoryframes-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: memoryframes
-Version: 0.1.6
+Version: 0.2.0
 Summary: Add your description here
 Author: David Brownell
 Author-email: David Brownell <github@DavidBrownell.com>

{memoryframes-0.1.6 → memoryframes-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "MemoryFrames"
-version = "0.1.6"
+version = "0.2.0"
 #          ^^^^^
 # Wheel names will be generated according to this value. Do not manually modify this value; instead
 # update it according to committed changes by running this command from the root of the repository:

memoryframes-0.2.0/src/MemoryFrames/PluginInfra/Note.py

@@ -0,0 +1,25 @@
+from dataclasses import dataclass, field
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from uuid import UUID
+
+    from MemoryFrames.PluginInfra.NoteSource import NoteSource
+
+
+# ----------------------------------------------------------------------
+@dataclass
+class Note:
+    """A note."""
+
+    id: UUID
+
+    source: NoteSource
+    source_data: object
+    """Opaque data provided by the NoteSource that created the note."""
+
+    metadata: dict[str, object] = field(repr=False)
+    content: str = field(repr=False)
+
+    metadata_hash: bytes = field(repr=False)
+    content_hash: bytes = field(repr=False)

memoryframes-0.2.0/src/MemoryFrames/PluginInfra/NoteSource.py

@@ -0,0 +1,36 @@
+from abc import ABC, abstractmethod
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from MemoryFrames.PluginInfra.Note import Note
+
+
+# ----------------------------------------------------------------------
+class NoteSource:
+    """Base class for a plugin component that provides notes to MemoryFrames."""
+
+    # ----------------------------------------------------------------------
+    def __init__(self, observer: NoteSourceObserver) -> None:
+        self.observer = observer
+
+
+# ----------------------------------------------------------------------
+class NoteSourceObserver(ABC):
+    """Base class for an observer that receives event notifications from a NoteSource."""
+
+    # ----------------------------------------------------------------------
+    @abstractmethod
+    def OnNewNote(
+        self,
+        note: Note,
+        *,
+        is_initializing: bool,
+    ) -> None:
+        """Indicate that a note has been discovered."""
+        raise NotImplementedError()  # pragma: no cover
+
+    # ----------------------------------------------------------------------
+    @abstractmethod
+    def OnInitializationComplete(self, note_source: NoteSource) -> None:
+        """Indicate that the NoteSource has completed its initialization."""
+        raise NotImplementedError()  # pragma: no cover