BaseConfigurationContainer

class ase2sprkkr.common.configuration_containers.BaseConfigurationContainer(definition, container=None)[source]

Configuration container, that holds members, either in classical way (see :class:ConfigurationContainer) or treat them in a special way

Class hierarchy

Inheritance diagram of ase2sprkkr.common.configuration_containers.BaseConfigurationContainer


Constructor

__init__(definition, container=None)

Create the object. Just sets the two properties from the parameters.

Parameters:
copy(copy_values=False)[source]

Create a copy of the container

Parameters:

copy_values (bool) – If true, the copy of values is done, so their modifications do not affects the container. (e.g. for numpy arrays)

abstractmethod values()[source]

Return the configuration objects contained by this container.

has_any_value()[source]

Return True if any member of the section has value.

Returns:

has_any_value – True, if no value in the container is set, False otherwise

Return type:

bool

get_members(name=None, unknown='find', is_option=None, lower_case=True, *, accept=None)[source]

Return members selected by a path.

None and leading parent operators are common to all containers; each concrete container implements lookup of its own members in _get_members().

Parameters:
Return type:

Iterator[ase2sprkkr.common.configuration.Configuration]

abstractmethod _get_members(name, unknown, is_option, lower_case, *, accept)[source]

Return members owned directly or indirectly by this container.

Parameters:
Return type:

Iterator[ase2sprkkr.common.configuration.Configuration]

get_member(name, *, unknown='find', is_option=None, lower_case=True, accept=None)[source]

Return the first matching member, raising KeyError if absent.

unknown, is_option, lower_case and accept have the same meaning as in get_members().

Parameters:
Return type:

ase2sprkkr.common.configuration.Configuration

property definition

The definition of the section.

Returns:

  • ase2sprkkr.common.configuration_definitions.ContainerDefinition

  • The definition of the section. I.e. the object that defines, which configuration values

  • are in the section, their default values etc.

_abc_impl = <_abc._abc_data object>