Source code for betty.serde.dump

"""
Provide a serialization API.
"""
from __future__ import annotations

from typing import TypeVar, Sequence, Mapping, overload, Literal, TypeAlias, Any

T = TypeVar('T')
U = TypeVar('U')



[docs]
class Void:
    pass



DumpType: TypeAlias = bool | int | float | str | None | list['Dump'] | dict[str, 'Dump']
DumpTypeT = TypeVar('DumpTypeT', bound=DumpType)

Dump: TypeAlias = bool | int | float | str | None | Sequence['Dump'] | Mapping[str, 'Dump']
DumpT = TypeVar('DumpT', bound=Dump)
DumpU = TypeVar('DumpU', bound=Dump)

VoidableDump: TypeAlias = Dump | type[Void]
VoidableDumpT = TypeVar('VoidableDumpT', bound=VoidableDump)
VoidableDumpU = TypeVar('VoidableDumpU', bound=VoidableDump)

ListDump: TypeAlias = list[DumpT]

DictDump: TypeAlias = dict[str, DumpT]

VoidableListDump: TypeAlias = list[VoidableDumpT]

VoidableDictDump: TypeAlias = dict[str, VoidableDumpT]

_MinimizableDump: TypeAlias = VoidableDump | VoidableListDump[VoidableDumpT] | VoidableDictDump[VoidableDumpT]


@overload
def minimize(dump: _MinimizableDump[VoidableDump], voidable: Literal[True] = True) -> VoidableDump:
    pass


@overload
def minimize(dump: _MinimizableDump[VoidableDump], voidable: Literal[False]) -> Dump:
    pass



[docs]
def minimize(dump: _MinimizableDump[VoidableDump], voidable: bool = True) -> VoidableDump:
    """
    Minimize a configuration dump by removing any Void configurationfrom sequences and mappings.
    """
    if isinstance(dump, (Sequence, Mapping)) and not isinstance(dump, str):
        if isinstance(dump, Sequence):
            dump = [
                value
                for value
                in dump
                if value is not Void
            ]
            for key in reversed(range(len(dump))):
                if dump[key] is Void:
                    del dump[key]
        if isinstance(dump, Mapping):
            dump = {
                key: value
                for key, value
                in dump.items()
                if value is not Void
            }
        if len(dump) or not voidable:
            return dump  # type: ignore[return-value]
        return Void
    return dump




[docs]
def void_none(value: VoidableDump) -> VoidableDump:
    """
    Passthrough a value, but convert Void to None.
    """
    return Void if value is None else value




[docs]
def none_void(value: VoidableDump) -> VoidableDump:
    """
    Passthrough a value, but convert None to Void.
    """
    return None if value is Void else value



@overload
def dump_default(dump: DictDump[Dump], key: str, default_type: type[dict[Any, Any]]) -> DictDump[Dump]:
    pass


@overload
def dump_default(dump: DictDump[Dump], key: str, default_type: type[list[Any]]) -> ListDump[Dump]:
    pass



[docs]
def dump_default(dump, key, default_type):
    """
    Add a key and value to a dump, if the key does not exist yet.
    """
    try:
        assert isinstance(dump[key], default_type)
    except KeyError:
        dump[key] = default_type()
    return dump[key]  # type: ignore[return-value]




[docs]
class Dumpable:

[docs]
    def dump(self) -> VoidableDump:
        """
        Dump this instance to a portable format.
        """
        raise NotImplementedError(repr(self))