This module handles Ibid’s configuration file and provides helper functions for accessing configuration from sources and plugins.
A unicode string configuration item.
Param name: | The configuration key |
---|---|
Param description: | |
A human-readable description for the configuration item. | |
Param default: | The default value, if not specified in the configuration file. |
If created as an attribute to a ibid.plugins.Processor or ibid.source.IbidSourceFactory, it will retrieve the value of plugins.plugin.name or sources.source.name.
This is also the base class for other Options.
Example:
class Secret(Processor):
password = Option('password', 'Secret Password', 's3cr3t')
Assuming that processor is in the secret plugin, the configuration item could be provided as:
[plugins]
[[secret]]
password = blue
A boolean configuration item.
Usage is identical to Option.
A integer configuration item.
Usage is identical to Option.
A floating-point configuration item.
Usage is identical to Option.