GitHub

HistoryIndex

API reference for HistoryIndex.

Stored entries by id and by event and primary key.

Functions

__init__

__init__(history) -> None
ParameterTypeDescription
historySequence[Entry]
def __init__(self, history: Sequence[Entry]) -> None:
    self._ids: set[bytes] = set()
    self._by_key: dict[tuple[str, str], list[Entry]] = {}
    # Storage returns history in sequence order; conflicts are in id order.
    for entry in sorted(history, key=lambda e: e.id):
        self._ids.add(entry.id)
        self._by_key.setdefault((entry.event, entry.primary_key), []).append(entry)

has

has(entry) -> bool
ParameterTypeDescription
entryEntry

Returns bool

def has(self, entry: Entry) -> bool:
    return entry.id in self._ids

conflicts

conflicts(entry) -> list[Entry]
ParameterTypeDescription
entryEntry

Returns list[Entry]

def conflicts(self, entry: Entry) -> list[Entry]:
    stored = self._by_key.get((entry.event, entry.primary_key), [])
    return [candidate for candidate in stored if candidate.id > entry.id]