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.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.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.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.
- property configuration: _ConfigurationT¶
The object’s configuration.
- class betty.config.Configuration[source]¶
Bases:
Dumpable
Any configuration object.
- abstract load(dump: 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.
- betty.config.assert_configuration_file(configuration: _ConfigurationT) AssertionChain[Path, _ConfigurationT] [source]¶
Assert that configuration can be loaded from a file.
- async betty.config.write_configuration_file(configuration: Configuration, configuration_file_path: Path) None [source]¶
Write configuration to file.