InputSectionDefinition

class ase2sprkkr.input_parameters.input_parameters_definitions.InputSectionDefinition(name, members=[], written_name=None, info=None, description=None, is_optional=None, is_hidden=False, is_expert=False, experimental=False, has_hidden_members=False, name_in_grammar=None, force_order=None, name_regex=False, result_class=None, is_repeated=False, repeated_delimiter=None, repeated_count=None, repeated_with_name=False, write_condition=None, warning_condition=None, validators=())[source]

Class hierarchy

Inheritance diagram of ase2sprkkr.input_parameters.input_parameters_definitions.InputSectionDefinition


Constructor

Parameters:

validators (Callable[[Any, Any, str], Any] | Iterable[Callable[[Any, Any, str], Any]] | None)

__init__(name, members=[], written_name=None, info=None, description=None, is_optional=None, is_hidden=False, is_expert=False, experimental=False, has_hidden_members=False, name_in_grammar=None, force_order=None, name_regex=False, result_class=None, is_repeated=False, repeated_delimiter=None, repeated_count=None, repeated_with_name=False, write_condition=None, warning_condition=None, validators=())

Definition of container (e.g. section of an input file). For the rest of the parameters see the RealItemDefinition.

Parameters:
  • has_hidden_members (bool) – If true, this section is not intended for a direct editing

  • force_order (bool) – If True, the items has to retain the order, if False, the items can be in the input file in any order.

  • validators (callable or iterable of callables) – Semantic validators passed to RealItemDefinition.

child_class

alias of ase2sprkkr.input_parameters.input_parameters_definitions.InputValueDefinition

result_class

alias of ase2sprkkr.input_parameters.input_parameters.InputSection

_resolve_is_optional(is_optional)[source]
static custom_class(name, section)
delimiter
Parameters:

name (Optional[str])

Return type:

ParserElement

do_not_skip_whitespaces_before_name = True
_copy_args = {'description': '_description', 'experimental': 'experimental', 'force_order': 'force_order', 'has_hidden_members': 'has_hidden_members', 'info': '_info', 'is_expert': 'is_expert', 'is_hidden': 'is_hidden', 'is_optional': 'is_optional', 'is_repeated': 'is_repeated', 'members': '_members', 'name': 'name', 'name_in_grammar': 'name_in_grammar', 'name_regex': 'name_regex', 'repeated_count': 'repeated_count', 'repeated_delimiter': '_repeated_delimiter', 'repeated_with_name': 'repeated_with_name', 'result_class': 'result_class', 'validators': 'validators', 'warning_condition': 'warning_condition', 'write_condition': 'write_condition', 'written_name': 'written_name'}