betty.serde.dump module

An API to produce serializable data dumps.

betty.serde.dump.Dump: TypeAlias = bool | int | float | str | None | collections.abc.MutableSequence['Dump'] | collections.abc.MutableMapping[str, 'Dump']

A serialized dump.

betty.serde.dump.DumpMapping

A dump which is a mapping whose keys are strings and values are serialized dumps.

alias of MutableMapping[str, _DumpT]

betty.serde.dump.DumpSequence

A dump which is a sequence whose values are serialized dumps.

alias of MutableSequence[_DumpT]

class betty.serde.dump.Dumpable[source]

Bases: ABC

Instances can be produce serialized data dumps of self.

abstract dump() bool | int | float | str | None | MutableSequence[bool | int | float | str | None | MutableSequence[Dump] | MutableMapping[str, Dump]] | MutableMapping[str, bool | int | float | str | None | MutableSequence[Dump] | MutableMapping[str, Dump]] | type[Void][source]

Produce a serialized data dump of self.

betty.serde.dump.minimize(dump: Sequence[bool | int | float | str | None | MutableSequence[bool | int | float | str | None | MutableSequence[Dump] | MutableMapping[str, Dump]] | MutableMapping[str, bool | int | float | str | None | MutableSequence[Dump] | MutableMapping[str, Dump]] | type[Void]], voidable: Literal[False] = False) MutableSequence[bool | int | float | str | None | MutableSequence[bool | int | float | str | None | MutableSequence[Dump] | MutableMapping[str, Dump]] | MutableMapping[str, bool | int | float | str | None | MutableSequence[Dump] | MutableMapping[str, Dump]]][source]
betty.serde.dump.minimize(dump: Sequence[bool | int | float | str | None | MutableSequence[bool | int | float | str | None | MutableSequence[Dump] | MutableMapping[str, Dump]] | MutableMapping[str, bool | int | float | str | None | MutableSequence[Dump] | MutableMapping[str, Dump]] | type[Void]], voidable: bool) MutableSequence[bool | int | float | str | None | MutableSequence[bool | int | float | str | None | MutableSequence[Dump] | MutableMapping[str, Dump]] | MutableMapping[str, bool | int | float | str | None | MutableSequence[Dump] | MutableMapping[str, Dump]]] | type[Void]
betty.serde.dump.minimize(dump: Mapping[str, bool | int | float | str | None | MutableSequence[bool | int | float | str | None | MutableSequence[Dump] | MutableMapping[str, Dump]] | MutableMapping[str, bool | int | float | str | None | MutableSequence[Dump] | MutableMapping[str, Dump]] | type[Void]], voidable: Literal[False] = False) MutableMapping[str, bool | int | float | str | None | MutableSequence[bool | int | float | str | None | MutableSequence[Dump] | MutableMapping[str, Dump]] | MutableMapping[str, bool | int | float | str | None | MutableSequence[Dump] | MutableMapping[str, Dump]]]
betty.serde.dump.minimize(dump: Mapping[str, bool | int | float | str | None | MutableSequence[bool | int | float | str | None | MutableSequence[Dump] | MutableMapping[str, Dump]] | MutableMapping[str, bool | int | float | str | None | MutableSequence[Dump] | MutableMapping[str, Dump]] | type[Void]], voidable: bool) MutableMapping[str, bool | int | float | str | None | MutableSequence[bool | int | float | str | None | MutableSequence[Dump] | MutableMapping[str, Dump]] | MutableMapping[str, bool | int | float | str | None | MutableSequence[Dump] | MutableMapping[str, Dump]]] | type[Void]

Minimize a configuration dump by removing any :py:class:’betty.typing.Void’ values from sequences and mappings.