betty.config module¶

Provide the Configuration API.

class betty.config.Configurable(*args, **kwargs)[source]¶

Bases: Generic[ConfigurationT]

Parameters:¶

*args¶

**kwargs¶

property configuration : ConfigurationT¶

class betty.config.Configuration(*args, **kwargs)[source]¶

Bases: Dumpable

Parameters:¶

*args¶

**kwargs¶

classmethod assert_load(configuration=None)[source]¶

Parameters:¶

configuration=None¶

Return type:¶

typing.Callable[[typing.Union[bool, int, float, str, None, typing.Sequence[typing.Union[bool, int, float, str, None, typing.Sequence[Dump], typing.Mapping[str, Dump]]], typing.Mapping[str, typing.Union[bool, int, float, str, None, typing.Sequence[Dump], typing.Mapping[str, Dump]]]]], typing.TypeVar(ConfigurationT, bound= betty.config.Configuration)]

classmethod load(dump, configuration=None)[source]¶

Load dumped configuration into a new configuration instance.

Parameters:¶

dump¶

configuration=None¶

Return type:¶

typing.Self

on_change(listener)[source]¶

Parameters:¶

listener¶

Return type:¶

None

remove_on_change(listener)[source]¶

Parameters:¶

listener¶

Return type:¶

None

update(other)[source]¶

Parameters:¶

other¶

Return type:¶

None

class betty.config.ConfigurationCollection(configurations=None)[source]¶

Bases: Configuration, Generic[ConfigurationKeyT, ConfigurationT]

Parameters:¶

configurations=None¶

append(*configurations)[source]¶

Parameters:¶

*configurations¶

Return type:¶

None

clear()[source]¶

Return type:¶

None

insert(index, *configurations)[source]¶

Parameters:¶

index¶

*configurations¶

Return type:¶

None

keys()[source]¶

Return type:¶

typing.Iterator[typing.TypeVar(ConfigurationKeyT, bound= typing.Union[typing.SupportsIndex, typing.Hashable, type[typing.Any]])]

move_to_beginning(*configuration_keys)[source]¶

Parameters:¶

*configuration_keys¶

Return type:¶

None

move_to_end(*configuration_keys)[source]¶

Parameters:¶

*configuration_keys¶

Return type:¶

None

move_towards_beginning(*configuration_keys)[source]¶

Parameters:¶

*configuration_keys¶

Return type:¶

None

move_towards_end(*configuration_keys)[source]¶

Parameters:¶

*configuration_keys¶

Return type:¶

None

prepend(*configurations)[source]¶

Parameters:¶

*configurations¶

Return type:¶

None

remove(*configuration_keys)[source]¶

Parameters:¶

*configuration_keys¶

Return type:¶

None

to_index(configuration_key)[source]¶

Parameters:¶

configuration_key¶

Return type:¶

int

to_indices(*configuration_keys)[source]¶

Parameters:¶

*configuration_keys¶

Return type:¶

typing.Iterator[int]

to_key(index)[source]¶

Parameters:¶

index¶

Return type:¶

typing.TypeVar(ConfigurationKeyT, bound= typing.Union[typing.SupportsIndex, typing.Hashable, type[typing.Any]])

to_keys(*indices)[source]¶

Parameters:¶

*indices¶

Return type:¶

typing.Iterator[typing.TypeVar(ConfigurationKeyT, bound= typing.Union[typing.SupportsIndex, typing.Hashable, type[typing.Any]])]

values()[source]¶

Return type:¶

typing.Iterator[typing.TypeVar(ConfigurationT, bound= betty.config.Configuration)]

class betty.config.ConfigurationMapping(configurations=None)[source]¶

Bases: ConfigurationCollection[ConfigurationKeyT, ConfigurationT], Generic[ConfigurationKeyT, ConfigurationT]

Parameters:¶

configurations=None¶

append(*configurations)[source]¶

Parameters:¶

*configurations¶

Return type:¶

None

dump()[source]¶

Dump this instance to a portable format.

Return type:¶

typing.Union[bool, int, float, str, None, typing.Sequence[typing.Union[bool, int, float, str, None, typing.Sequence[Dump], typing.Mapping[str, Dump]]], typing.Mapping[str, typing.Union[bool, int, float, str, None, typing.Sequence[Dump], typing.Mapping[str, Dump]]], type[betty.serde.dump.Void]]

insert(index, *configurations)[source]¶

Parameters:¶

index¶

*configurations¶

Return type:¶

None

keys()[source]¶

Return type:¶

typing.Iterator[typing.TypeVar(ConfigurationKeyT, bound= typing.Union[typing.SupportsIndex, typing.Hashable, type[typing.Any]])]

classmethod load(dump, configuration=None)[source]¶

Load dumped configuration into a new configuration instance.

Parameters:¶

dump¶

configuration=None¶

Return type:¶

typing.Self

move_to_beginning(*configuration_keys)[source]¶

Parameters:¶

*configuration_keys¶

Return type:¶

None

move_to_end(*configuration_keys)[source]¶

Parameters:¶

*configuration_keys¶

Return type:¶

None

move_towards_beginning(*configuration_keys)[source]¶

Parameters:¶

*configuration_keys¶

Return type:¶

None

move_towards_end(*configuration_keys)[source]¶

Parameters:¶

*configuration_keys¶

Return type:¶

None

prepend(*configurations)[source]¶

Parameters:¶

*configurations¶

Return type:¶

None

replace(*values)[source]¶

Parameters:¶

*values¶

Return type:¶

None

to_index(configuration_key)[source]¶

Parameters:¶

configuration_key¶

Return type:¶

int

to_key(index)[source]¶

Parameters:¶

index¶

Return type:¶

typing.TypeVar(ConfigurationKeyT, bound= typing.Union[typing.SupportsIndex, typing.Hashable, type[typing.Any]])

update(other)[source]¶

Parameters:¶

other¶

Return type:¶

None

values()[source]¶

Return type:¶

typing.Iterator[typing.TypeVar(ConfigurationT, bound= betty.config.Configuration)]

class betty.config.ConfigurationSequence(configurations=None)[source]¶

Bases: ConfigurationCollection[int, ConfigurationT], Generic[ConfigurationT]

Parameters:¶

configurations=None¶

append(*configurations)[source]¶

Parameters:¶

*configurations¶

Return type:¶

None

dump()[source]¶

Dump this instance to a portable format.

Return type:¶

typing.Union[bool, int, float, str, None, typing.Sequence[typing.Union[bool, int, float, str, None, typing.Sequence[Dump], typing.Mapping[str, Dump]]], typing.Mapping[str, typing.Union[bool, int, float, str, None, typing.Sequence[Dump], typing.Mapping[str, Dump]]], type[betty.serde.dump.Void]]

insert(index, *configurations)[source]¶

Parameters:¶

index¶

*configurations¶

Return type:¶

None

keys()[source]¶

Return type:¶

typing.Iterator[int]

classmethod load(dump, configuration=None)[source]¶

Load dumped configuration into a new configuration instance.

Parameters:¶

dump¶

configuration=None¶

Return type:¶

typing.Self

move_to_beginning(*configuration_keys)[source]¶

Parameters:¶

*configuration_keys¶

Return type:¶

None

move_to_end(*configuration_keys)[source]¶

Parameters:¶

*configuration_keys¶

Return type:¶

None

move_towards_beginning(*configuration_keys)[source]¶

Parameters:¶

*configuration_keys¶

Return type:¶

None

move_towards_end(*configuration_keys)[source]¶

Parameters:¶

*configuration_keys¶

Return type:¶

None

prepend(*configurations)[source]¶

Parameters:¶

*configurations¶

Return type:¶

None

to_index(configuration_key)[source]¶

Parameters:¶

configuration_key¶

Return type:¶

int

to_key(index)[source]¶

Parameters:¶

index¶

Return type:¶

int

update(other)[source]¶

Parameters:¶

other¶

Return type:¶

None

values()[source]¶

Return type:¶

typing.Iterator[typing.TypeVar(ConfigurationT, bound= betty.config.Configuration)]

class betty.config.FileBasedConfiguration[source]¶

Bases: Configuration

property autowrite : bool¶

property configuration_file_path : Path¶

async read(configuration_file_path=None)[source]¶

Parameters:¶

configuration_file_path=None¶

Return type:¶

None

async write(configuration_file_path=None)[source]¶

Parameters:¶

configuration_file_path=None¶

Return type:¶

None