appsettings2.ConfigurationBuilder

class ConfigurationBuilder(normalize: bool = False, scrubkeys: bool = False)

Build a Configuration object from one or more ConfigurationProvider instances.

Initialize ConfigurationBuilder instance.

Parameters:

normalize – Option indicating whether or not attribute names should be normalized to upper-case on the resulting Configuration object, defaults to False.
scrubkeys – Option indicating whether or not attribute names should be scrubbed to be compatible with the Python lexer, defaults to False.

Add the specified ConfigurationProvider object to the builder.

Can be called multiple times to add multiple providers.

Parameters:: provider – A class implementing the ConfigurationProvider abstract class.
Returns:: Returns ConfigurationBuilder for method chaining.

addProvider(provider: ConfigurationProvider) → ConfigurationBuilder: ⚠️ DEPRECATED: use add_provider(...) instead.

add_command_line(argv=None) → ConfigurationBuilder

Add a CommandLineConfigurationProvider, optionally overriding argv.

addCommandLine(argv=None) → ConfigurationBuilder: ⚠️ DEPRECATED: use add_command_line(...) instead.

addEnvironment() → ConfigurationBuilder: ⚠️ DEPRECATED: use add_environment(...) instead.

add_json(filepath: str | None = None, json: str | None = None, fd: int | None = None, required: bool = True) → ConfigurationBuilder

The filepath, json, and fd parameters are mutually exclusive.

Parameters:

filepath – Optional path to a JSON file used as a configuration source, defaults to None.
json – Optional JSON string used as a configuration source, defaults to None.
fd – Optional file descriptor (int) to be used as a configuration source, defaults to None.
required – Optional parameter indicating whether the configuration source will raise ConfigurationException if the specified configuration source is missing, defaults to True.

Returns:

Returns ConfigurationBuilder for method chaining.

addJson(filepath: str | None = None, json: str | None = None, fd: int | None = None, required: bool = True) → ConfigurationBuilder: ⚠️ DEPRECATED: use add_json(...) instead.

add_toml(filepath: str | None = None, toml: str | None = None, fd: int | None = None, required: bool = True) → ConfigurationBuilder

The filepath, toml, and fd parameters are mutually exclusive.

Parameters:

filepath – Optional path to a TOML file used as a configuration source, defaults to None.
toml – Optional TOML string used as a configuration source, defaults to None.
fd – Optional file descriptor (int) to be used as a configuration source, defaults to None.
required – Optional parameter indicating whether the configuration source will raise ConfigurationException if the specified configuration source is missing, defaults to True.

Returns:

Returns ConfigurationBuilder for method chaining.

addToml(filepath: str | None = None, toml: str | None = None, fd: int | None = None, required: bool = True) → ConfigurationBuilder: ⚠️ DEPRECATED: use add_toml(...) instead.

add_yaml(filepath: str | None = None, yaml: str | None = None, fd: int | None = None, required: bool = True) → ConfigurationBuilder

The filepath, yaml, and fd parameters are mutually exclusive.

Parameters:

filepath – Optional path to a YAML file used as a configuration source, defaults to None.
yaml – Optional YAML string used as a configuration source, defaults to None.
fd – Optional file descriptor (int) to be used as a configuration source, defaults to None.
required – Optional parameter indicating whether the configuration source will raise ConfigurationException if the specified configuration source is missing, defaults to True.

Returns:

Returns ConfigurationBuilder for method chaining.

addYaml(filepath: str | None = None, yaml: str | None = None, fd: int | None = None, required: bool = True) → ConfigurationBuilder: ⚠️ DEPRECATED: use add_yaml(...) instead.

Builds a Configuration object using the providers which have been added to the builder.