configuration_definitions

Full name: ase2sprkkr.common.configuration_definitions

Module class hierarchy

Inheritance diagram of ase2sprkkr.common.configuration_definitions.BaseDefinition, ase2sprkkr.common.configuration_definitions.ConfigurationRootDefinition, ase2sprkkr.common.configuration_definitions.ContainerDefinition, ase2sprkkr.common.configuration_definitions.MergeDictAdaptor, ase2sprkkr.common.configuration_definitions.SectionDefinition, ase2sprkkr.common.configuration_definitions.ValueDefinition

Description

Configuration definitions are classes, that desribes the syntax of a configuration file, or its parts (sections or configuration options)

They are able both to parse a file, which results in an instance of (an instance of ase2sprkkr.common.Configuration, e.g. an Option or Section ), or write such object to a file.

Functions

add_excluded_names_condition(element, names)

Add the condition to the element, that its value is not any of given names

unique_dict(values)

Create a dictionary from the arguments.

Classes

BaseDefinition(name[, alternative_names, ...])

A base class for a configuration definition, either of an option, or of a container.

ConfigurationRootDefinition(name[, members])

From this class, the definition of the format of a whole configuration file should be derived.

ContainerDefinition(name[, members, ...])

Base class for a definition (of contained data, format, etc) of either a whole configuration file (e.g.

MergeDictAdaptor(values, definition)

This class returns a read-only dict-like class that merge values from a container and from the definition of a section

SectionDefinition(name[, members, ...])

Base class for definition of the sections in Pot or InputParameters files.

ValueDefinition(name[, type, default_value, ...])