plainbox.impl.config – configuration

Warning

THIS MODULE DOES NOT HAVE A STABLE PUBLIC API

class plainbox.impl.secure.config.ChoiceValidator(choice_list)[source]

A validator ensuring that values are in a given set

plainbox.impl.secure.config.Config[source]

alias of _del_section

class plainbox.impl.secure.config.ConfigMeta[source]

Meta class for all configuration classes.

This meta class handles assignment of ‘_name’ attribute to each Variable instance created in the class body.

It also accumulates such instances and assigns them to variable_list in a helper Meta class which is assigned back to the namespace

class plainbox.impl.secure.config.ConfigMetaData[source]

Class containing meta-data about a Config class

Sub-classes of this class are automatically added to each Config subclass as a Meta class-level attribute.

This class has typically two attributes:

cvar variable_list:
 A list of all Variable objects defined in the class
cvar section_list:
 A list of all Section object defined in the class
cvar filename_list:
 A list of config files (pathnames) to read on call to Config.read()
filename_list = []
section_list = []
variable_list = []
class plainbox.impl.secure.config.INameTracking[source]

Interface for classes that are instantiated as a part of definition of another class. The purpose of this interface is to allow instances to learn about the name (python identifier) that was assigned to the instance at class definition time.

Subclasses must define the _set_tracked_name() method.

class plainbox.impl.secure.config.IValidator[source]

An interface for variable vale validators

plainbox.impl.secure.config.KindValidator(variable, new_value)[source]

A validator ensuring that values match the “kind” of the variable.

class plainbox.impl.secure.config.NotEmptyValidator(msg=None)[source]

A validator ensuring that values aren’t empty

class plainbox.impl.secure.config.PatternValidator(pattern_text)[source]

A validator ensuring that values match a given pattern

class plainbox.impl.secure.config.PlainBoxConfigParser(defaults=None, dict_type=<class 'collections.OrderedDict'>, allow_no_value=False, *, delimiters=('=', ':'), comment_prefixes=('#', ';'), inline_comment_prefixes=None, strict=True, empty_lines_in_values=True, default_section='DEFAULT', interpolation=<object object at 0x2b41da541090>)[source]

A simple ConfigParser subclass that does not lowercase key names.

optionxform(option)[source]
plainbox.impl.secure.config.Section[source]

A section of a configuration file.

class plainbox.impl.secure.config.UnsetType[source]

Class of the Unset object

exception plainbox.impl.secure.config.ValidationError(variable, new_value, message)[source]

Exception raised when configuration variables fail to validate

plainbox.impl.secure.config.Variable[source]

Variable that can be used in a configuration systems

Previous topic

plainbox.impl.secure – code for external (trusted) launchers

Next topic

plainbox.impl.secure.job – secure code for job definitions

This Page