Configurator Developer Manual

Contents:

class configuration.ConfigurationSchema(name='', **args)

Configuration schemas define the configurations structure. They have a name, a list of parents, and a list of sections with options definitions.

Configuration schemas can be composed by inheriting from multiple parents. Configuration sections from the parents appear in the child configuration schema. For instance, a full stack web framework configuration schema could inherit from a generic Web schema for web server configuration, and another Database schema for database connection configuration.

Configuration schemas have sections, each containing other sections and schema options. The schemas sections and options can be manipulated in the tree appearing on the left of the configuration schemas navigator.

add_parent(parent)

Adds parent to the list of schema’s parents

classmethod configuration_schemas()

Return the list of globally registered configuration schemas

direct_sections()

Return schema’s direct sections (without looking at schema’s parents sections)

documentation

The schema’s documentation

classmethod get_named(name)

Get the configuration schema registered with name name

get_section(name)

Get section with name

move_section_backwards(section)

Move section backwards. For moving sections from UI

move_section_forward(section)

Move section forward (reorder). For moving sections from UI

name

The schema’s name

parents()

Returns the schema’s parents list

classmethod register_schema(schema)

Register a schema, globally. This is called automatically when a configuration schema is created.

remove_section(section)

Remove section from the schema

section(section)

Add section section to schema

sections()

Return schema’s sections recursively considering its parents

set_parents(parents)

Sets the schema’s parents to parents list

classmethod unregister_schema(schema)

Unregister a schema, globally.

class configuration.ConfigurationSchemaSection(name='', **args)

Configuration schema section

add_option(option)

Adds option option to the section

add_section(section)

Adds section section as a subsection

dependency_expression

The section’s dependency expression

documentation

The section’s documentation

get_option(name)

Gets section option with name name from the section. If it is not found, None is return

name

Section name

options()

Returns the section’s options list

parent

The section’s parent. It can be the configuration schema if it is a top-level section, of the parent section if it is a subsection

remove_option(option)

Removes option option from the section

remove_section(section)

Removes the subsection section

subsections()

Return the section’s subsections

Indices and tables

• Index
• Module Index
• Search Page