Brian Bjarke JensenandCursor
f6ee9a3724
PR Title Check / check-title (pull_request) Successful in 7s
Test Python Package / unit-tests (pull_request) Successful in 9s
Code Quality Pipeline / code-quality (pull_request) Successful in 22s
Test Python Package / integration-tests (pull_request) Successful in 24s
Test Python Package / coverage-report (pull_request) Successful in 8s
Enables structural subtyping for consumers while preserving nominal adapter inheritance, instantiation guards, and scan_keys defaults. Co-authored-by: Cursor <[email protected]>
51 lines
1.5 KiB
Python
51 lines
1.5 KiB
Python
"""Definition of JsonRepositoryInterface protocol and abstract base class."""
|
|
|
|
from abc import abstractmethod
|
|
from collections.abc import Iterator
|
|
from typing import Any, Protocol, runtime_checkable
|
|
|
|
|
|
@runtime_checkable
|
|
class JsonRepositoryInterface(Protocol):
|
|
"""Interface that defines JSON document CRUD methods."""
|
|
|
|
@abstractmethod
|
|
def get(self, key: str) -> dict[str, Any] | None:
|
|
"""Get a JSON object by key.
|
|
|
|
Returns ``None`` when the key is absent. Returns ``{}`` when the key
|
|
exists with an empty JSON object. Use ``value is not None`` to test
|
|
existence; avoid truthiness checks (``{}`` is falsy).
|
|
"""
|
|
...
|
|
|
|
@abstractmethod
|
|
def set(self, key: str, data: dict[str, Any]) -> None:
|
|
"""Set a JSON object by key.
|
|
|
|
Accepts any dict, including ``{}``. An empty dict creates a key that
|
|
``get()`` returns as ``{}``, not ``None``. Use ``delete()`` to remove a
|
|
key entirely.
|
|
"""
|
|
...
|
|
|
|
@abstractmethod
|
|
def delete(self, key: str) -> None:
|
|
"""Delete a JSON object by key, removing it entirely."""
|
|
...
|
|
|
|
@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)
|