storable

Classes:

• LongStorableConfigDict –

  Configuration for a storable class with explicit names.

• Storable –

  Base class for storable objects.

• StorableConfig –

  Configuration for a storable class.

• StorableConfigDict –

  Configuration for a storable class.

Functions:

• normalize_storable_config_dict –

  Normalize a StorableConfigDict to an ExplicitStorableConfigDict.

LongStorableConfigDict

Bases: TypedDict

Configuration for a storable class with explicit names.

Attributes:

• storable_class_id (LiteralString | None) –

  ID of the storable class, as a 16-character hexadecimal string.

• storable_unpacker (Unpacker | None) –

  ID of the storable class, as a 16-character hexadecimal string.

storable_class_id instance-attribute

storable_class_id: LiteralString | None

ID of the storable class, as a 16-character hexadecimal string.

storable_unpacker instance-attribute

storable_unpacker: Unpacker | None

ID of the storable class, as a 16-character hexadecimal string.

Storable

Base class for storable objects.

Methods:

• storable_config –

  Get the configuration for this storable class.

storable_config classmethod

storable_config(
    *, allow_none: bool
) -> StorableConfig | None

storable_config(
    *, allow_none: Literal[False] = ...
) -> StorableConfig

storable_config(
    *, allow_none: bool = False
) -> StorableConfig | None

Get the configuration for this storable class.

StorableConfig dataclass

StorableConfig(class_id: UUID, unpacker: Unpacker)

Configuration for a storable class.

StorableConfigDict

Bases: LongStorableConfigDict

Configuration for a storable class.

Attributes:

• class_id (LiteralString | None) –

  An alias for storable_class_id.

• storable_class_id (LiteralString | None) –

  ID of the storable class, as a 16-character hexadecimal string.

• storable_unpacker (Unpacker | None) –

  ID of the storable class, as a 16-character hexadecimal string.

• unpacker (Unpacker | None) –

  An alias for storable_unpacker.

class_id instance-attribute

class_id: LiteralString | None

An alias for storable_class_id.

storable_class_id instance-attribute

storable_class_id: LiteralString | None

ID of the storable class, as a 16-character hexadecimal string.

storable_unpacker instance-attribute

storable_unpacker: Unpacker | None

ID of the storable class, as a 16-character hexadecimal string.

unpacker instance-attribute

unpacker: Unpacker | None

An alias for storable_unpacker.

normalize_storable_config_dict

normalize_storable_config_dict(
    cfg: StorableConfigDict,
) -> LongStorableConfigDict

Normalize a StorableConfigDict to an ExplicitStorableConfigDict.