Config objects

Here we describe the types and functions you can use to model configuration within your app. Usually each app will have a single subclass of Config.

class nx_config.Config

TODO

class nx_config.ConfigSection

TODO

class nx_config.SecretString

TODO

SecretString cannot be instantiated. It is not meant to be used as an actual type but only as a type hint when declaring config entries within a config section. It allows the parser to handle those entries differently (e.g. by forbidding the use of default values) and conveys their intended usage and their secrecy to the user.

In the end, the actual type of the config entries is simply str.

class nx_config.URL

TODO

URL cannot be instantiated. It is not meant to be used as an actual type but only as a type hint when declaring config entries within a config section. It allows the parser to handle those entries differently (e.g. by verifying that their values are valid URLs) and conveys their intended usage to the user.

In the end, the actual type of the config entries is simply str.

@nx_config.validate(wrapped: Callable[[nx_config.section.ConfigSection], None]) → nx_config._core.validator.Validator

TODO