betty.plugin.config module

Provide plugin configuration.

class betty.plugin.config.PluginConfiguration[source]

Bases: Configuration

Configure a single plugin.

__init__(plugin_id: str, label: Mapping[str, str] | str, *, description: Mapping[str, str] | str | None = None)[source]
description

An instance attribute that contains betty.locale.localizable.config.StaticTranslationsLocalizableConfiguration.

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]

Dump this instance to a portable format.

property id: str

The configured plugin ID.

label

An instance attribute that contains betty.locale.localizable.config.StaticTranslationsLocalizableConfiguration.

load(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]]) None[source]

Load dumped configuration.

Raises:

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

update(other: Self) None[source]

Update this configuration with the values from other.

class betty.plugin.config.PluginConfigurationMapping[source]

Bases: ConfigurationMapping[str, _PluginConfigurationT], Generic[_PluginCoT, _PluginConfigurationT]

Configure a collection of plugins.

property plugins: Sequence[type[_PluginCoT]]

The plugins for this configuration.

You SHOULD NOT cache the value anywhere, as it will change when this configuration changes.

class betty.plugin.config.PluginConfigurationPluginConfigurationMapping[source]

Bases: PluginConfigurationMapping[_PluginCoT, PluginConfiguration], Generic[_PluginCoT]

Configure a collection of plugins using betty.plugin.config.PluginConfiguration.

load_item(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]]) PluginConfiguration[source]

Create and load a new item from the given dump, or raise an assertion error.

Raises:

betty.assertion.error.AssertionFailed – Raised when the dump is invalid and cannot be loaded.