class EventRow[R: Row, K = object, E = Never, P: Row = Row]
An event setting, patching or removing rows of schema keyed by
key_fields (of type K); a patch writes some of the fields
P.
Attributes#
| Attribute | Type | Description |
|---|---|---|
key_fields | tuple[str, ...] = () | |
schema | S.StructSchema[R, object, object] = field(default=(cast('Any', None)), repr=False) |
Functions#
__init__#
__init__(tag, primary_key, payload, success, error, _payload_codec=None, key_fields=(), schema=cast('Any', None), _key=cast('Any', None), _patchable=frozenset()) -> None| Parameter | Type | Description |
|---|---|---|
tag | str | |
primary_key | Callable[[P], str] | |
payload | _C[P] | |
success | _C[A] | |
error | _C[E] | |
_payload_codec | BytesCodec[P] | None = None | |
key_fields | tuple[str, ...] = () | |
schema | S.StructSchema[R, object, object] = cast('Any', None) | |
_key | _RowKey = cast('Any', None) | |
_patchable | frozenset[str] = frozenset() |
key_of#
key_of(fields) -> strThe primary key of the row with these key field values.
| Parameter | Type | Description |
|---|---|---|
fields | Row |
Returns str
def key_of(self, fields: Row) -> str:
"""The primary key of the row with these key field values."""
return self._key.primary_key(fields)set#
set(row) -> Write[Payload[R, K], None, E]| Parameter | Type | Description |
|---|---|---|
row | R |
Returns Write[Payload[R, K], None, E]
def set(self, row: R) -> Write[Payload[R, K], None, E]:
return Write(self, {"_tag": "set", "row": row})patch#
patch(key, fields) -> Write[Payload[R, K], None, E]Write fields (non-key fields) over the row's; a key field or
a field the row does not have raises EventRowPatchError.
| Parameter | Type | Description |
|---|---|---|
key | K | |
fields | P |
Returns Write[Payload[R, K], None, E]
def patch(self, key: K, fields: P) -> Write[Payload[R, K], None, E]:
"""Write ``fields`` (non-key fields) over the row's; a key field or
a field the row does not have raises ``EventRowPatchError``."""
wrong = [name for name in fields if name not in self._patchable]
if wrong:
raise EventRowPatchError(self.tag, wrong, self._patchable)
return Write(self, {"_tag": "patch", "key": key, "fields": fields})remove#
remove(key) -> Write[Payload[R, K], None, E]| Parameter | Type | Description |
|---|---|---|
key | K |
Returns Write[Payload[R, K], None, E]
def remove(self, key: K) -> Write[Payload[R, K], None, E]:
return Write(self, {"_tag": "remove", "key": key})