InputSectionDefinition

class ase2sprkkr.input_parameters.input_parameters_definitions.InputSectionDefinition(name, members=[], alternative_names=[], info=None, description=None, is_optional=False, is_hidden=False, is_expert=False, has_hidden_members=False, name_in_grammar=None, force_order=None, write_alternative_name=False, result_class=None, is_repeated=False)[source]

This class describes the format of one value of a task section

Class hierarchy

Inheritance diagram of ase2sprkkr.input_parameters.input_parameters_definitions.InputSectionDefinition

Constructor

Parameters:

write_alternative_name (bool) –

__init__(name, members=[], alternative_names=[], info=None, description=None, is_optional=False, is_hidden=False, is_expert=False, has_hidden_members=False, name_in_grammar=None, force_order=None, write_alternative_name=False, result_class=None, is_repeated=False)

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

  • is_repeated (bool or string) – The section can be repeated. The name of the section appears only once on the beginning (this differs from ValueDefinition.is_repeated #TODO - merge the meaning of the swtich). If a non-empty string is given, the values are divided by the string.

  • 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.

  • write_alternative_name (bool) –

child_class

standard child class

alias of InputValueDefinition

result_class

The standard class for InputParameters section

alias of InputSection

static custom_class(name, section)

Factory for custom values in the input sections.

delimiter = '\n'

options are delimited by newline in ouptut.

grammar_of_delimiter = Suppress:({[[{[LineEnd]... <SP><TAB>}]...] WordStart})
Parameters:

name (str | None) –

Return type:

ParserElement

do_not_skip_whitespaces_before_name = True
_copy_args = {'alternative_names': 'alternative_names', 'description': '_description', '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', 'result_class': 'result_class', 'write_alternative_name': 'write_alternative_name'}