Skip to content

configuration

Configuration Objects

class Configuration(AttrDict)

Represents the running configuration.

This class never raises IndexError, instead it will return None if a section or option does not yet exist.

__getitem__

def __getitem__(key)

Returns a config section, creating it if it doesn't exist yet.

ConfigurationSection Objects

class ConfigurationSection(Configuration)

__getitem__

def __getitem__(key)

Returns a config value, pulling from the user section as a fallback. This is called when the attribute is accessed either via the get method or through [ ] index.

__getattr__

def __getattr__(key)

Returns the config value from the user section. This is called when the attribute is accessed via dot notation but does not exist.

__setattr__

def __setattr__(key, value)

Sets dictionary value when an attribute is set.

SubparserWrapper Objects

class SubparserWrapper(object)

Wrap subparsers so we can track what options the user passed.

completer

def completer(completer)

Add an arpcomplete completer to this subcommand.

add_argument

def add_argument(*args, **kwargs)

Add an argument for this subcommand.

This also stores the default for the argument in self.cli.default_arguments.

get_argument_strings

def get_argument_strings(arg_parser, *args, **kwargs)

Takes argparse arguments and returns a list of argument strings or positional names.

get_argument_name

def get_argument_name(arg_parser, *args, **kwargs)

Takes argparse arguments and returns the dest name.

handle_store_boolean

def handle_store_boolean(self, *args, **kwargs)

Does the add_argument for action='store_boolean'.