betty.config package

Subpackages

Module contents

The Configuration API.

class betty.config.Configurable[source]

Bases: Generic[_ConfigurationT]

Any configurable object.

Parameters:
__init__(*args: Any, **kwargs: Any)[source]
Parameters:
property configuration: _ConfigurationT

The object’s configuration.

class betty.config.Configuration[source]

Bases: Dumpable

Any configuration object.

Parameters:
__init__(*args: Any, **kwargs: Any)[source]
Parameters:
abstract load(dump: bool | int | float | str | None | Sequence[Dump] | Mapping[str, Dump]) None[source]

Load dumped configuration.

Raises:

betty.assertion.error.AssertionFailed – Raised if the dump contains invalid configuration.

Parameters:

dump (typing.Union[bool, int, float, str, None, typing.Sequence[Dump], typing.Mapping[str, Dump]])

Return type:

None

abstract update(other: Self) None[source]

Update this configuration with the values from other.

Parameters:

other (typing.Self)

Return type:

None

betty.config.assert_configuration_file(configuration: betty.config._ConfigurationT) betty.assertion.AssertionChain[pathlib.Path, betty.config._ConfigurationT][source]

Assert that configuration can be loaded from a file.

Parameters:

configuration (typing.TypeVar(_ConfigurationT, bound= betty.config.Configuration))

Return type:

betty.assertion.AssertionChain[pathlib.Path, typing.TypeVar(_ConfigurationT, bound= betty.config.Configuration)]

async betty.config.write_configuration_file(configuration: betty.config.Configuration, configuration_file_path: pathlib.Path) None[source]

Write configuration to file.

Parameters:
Return type:

None