betty.config package¶
Subpackages¶
- betty.config.collections package
- Submodules
- betty.config.collections.mapping module
ConfigurationMapping
ConfigurationMapping.__init__()
ConfigurationMapping.append()
ConfigurationMapping.dump()
ConfigurationMapping.insert()
ConfigurationMapping.keys()
ConfigurationMapping.load()
ConfigurationMapping.move_to_beginning()
ConfigurationMapping.move_to_end()
ConfigurationMapping.move_towards_beginning()
ConfigurationMapping.move_towards_end()
ConfigurationMapping.prepend()
ConfigurationMapping.replace()
ConfigurationMapping.to_index()
ConfigurationMapping.to_key()
ConfigurationMapping.update()
ConfigurationMapping.values()
- betty.config.collections.sequence module
ConfigurationSequence
ConfigurationSequence.__init__()
ConfigurationSequence.append()
ConfigurationSequence.dump()
ConfigurationSequence.insert()
ConfigurationSequence.keys()
ConfigurationSequence.load()
ConfigurationSequence.move_to_beginning()
ConfigurationSequence.move_to_end()
ConfigurationSequence.move_towards_beginning()
ConfigurationSequence.move_towards_end()
ConfigurationSequence.prepend()
ConfigurationSequence.replace()
ConfigurationSequence.to_index()
ConfigurationSequence.to_key()
ConfigurationSequence.update()
ConfigurationSequence.values()
- betty.config.collections.mapping module
- Module contents
ConfigurationCollection
ConfigurationCollection.__init__()
ConfigurationCollection.append()
ConfigurationCollection.clear()
ConfigurationCollection.insert()
ConfigurationCollection.keys()
ConfigurationCollection.load_item()
ConfigurationCollection.move_to_beginning()
ConfigurationCollection.move_to_end()
ConfigurationCollection.move_towards_beginning()
ConfigurationCollection.move_towards_end()
ConfigurationCollection.prepend()
ConfigurationCollection.remove()
ConfigurationCollection.replace()
ConfigurationCollection.to_index()
ConfigurationCollection.to_indices()
ConfigurationCollection.to_key()
ConfigurationCollection.to_keys()
ConfigurationCollection.values()
- Submodules
Module contents¶
The Configuration API.
- class betty.config.Configurable[source]¶
Bases:
Generic
[_ConfigurationT
]Any configurable object.
- Parameters:
args (
typing.Any
)kwargs (
typing.Any
)
- __init__(*args: Any, **kwargs: Any)[source]¶
- Parameters:
args (
typing.Any
)kwargs (
typing.Any
)
- property configuration: _ConfigurationT¶
The object’s configuration.
- class betty.config.Configuration[source]¶
Bases:
Dumpable
Any configuration object.
- Parameters:
args (
typing.Any
)kwargs (
typing.Any
)
- __init__(*args: Any, **kwargs: Any)[source]¶
- Parameters:
args (
typing.Any
)kwargs (
typing.Any
)
- 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:
- 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:
configuration (
betty.config.Configuration
)configuration_file_path (
pathlib.Path
)
- Return type: