Brian Bjarke JensenandCursor
50444af982
Test Python Package / unit-tests (pull_request) Successful in 14s
Code Quality Pipeline / code-quality (pull_request) Successful in 32s
Test Python Package / coverage-report (pull_request) Successful in 16s
PR Title Check / check-title (pull_request) Successful in 6s
Test Python Package / integration-tests (pull_request) Successful in 1m3s
Provide a SCAN-based key iterator for Redis adapters so callers can enumerate large keyspaces without relying on blocking KEYS lookups. Co-authored-by: Cursor <[email protected]>
39 lines
977 B
Python
39 lines
977 B
Python
"""Definition of JsonRepositoryInterface abstract base class."""
|
|
|
|
from collections.abc import Iterator
|
|
from abc import ABC, abstractmethod
|
|
|
|
|
|
class JsonRepositoryInterface(ABC):
|
|
"""Interface that defines JSON document CRUD methods."""
|
|
|
|
@abstractmethod
|
|
def get(self, key: str) -> dict | None:
|
|
"""Get a JSON object by key."""
|
|
...
|
|
|
|
@abstractmethod
|
|
def set(self, key: str, data: dict) -> None:
|
|
"""Set a JSON object by key."""
|
|
...
|
|
|
|
@abstractmethod
|
|
def delete(self, key: str) -> None:
|
|
"""Delete a JSON object by key."""
|
|
...
|
|
|
|
@abstractmethod
|
|
def list_keys(self, pattern: str) -> list[str]:
|
|
"""List keys matching a glob pattern."""
|
|
...
|
|
|
|
def scan_keys(
|
|
self,
|
|
pattern: str,
|
|
*,
|
|
count: int | None = None,
|
|
) -> Iterator[str]:
|
|
"""Yield keys matching a glob pattern incrementally."""
|
|
del count
|
|
yield from self.list_keys(pattern)
|