GitHub

primary_key

API reference for primary_key.

Values that name themselves with a string (Effect's PrimaryKey).

A persisted request is stored under its primary key, so two requests with the same key share one stored result::

@dataclass(frozen=True)
class GetUser(persistable.Class(success=User)):
    id: int

    def primary_key(self) -> str:
        return f"GetUser:{self.id}"

Classes

Functions

is_primary_key

is_primary_key(u) -> TypeIs[PrimaryKey]
ParameterTypeDescription
uobject

Returns TypeIs[PrimaryKey]

def is_primary_key(u: object) -> TypeIs[PrimaryKey]:
    return isinstance(u, PrimaryKey)

value

value(key) -> str

key.primary_key().

ParameterTypeDescription
keyPrimaryKey

Returns str

def value(key: PrimaryKey) -> str:
    """``key.primary_key()``."""
    return key.primary_key()