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)[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)
Parameters

  • name (str) – Name of the value/section

  • alternative_names (str or [str]) – Alternative names that can denotes the value

  • is_optional (boolean) – If True, this section/value can be missing in the .pot/task file

  • is_hidden (boolean) – Hidden values are not offered to a user, usually they are set by another object (and so a direct setting of their values has no sense)

  • is_expert (boolean) – Expert values/sections are not required and they are somewhat hidden from the user

  • name_in_grammar (boolean or None) – If False, there the name of the variable is not printed in the configuration file. The variable is recognized by its position. If None, the default class value is used

  • info (str) – A short help message for the value/section. It will be the perex for description.

  • description (str) – The additional informations for the users.

  • write_alternative_name (bool) – Wheter use the name or the (first) alternative name in the output.

  • result_class – Redefine the class that holds data for this option/section

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) –

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', 'members': '_members', 'name': 'name', 'name_in_grammar': 'name_in_grammar', 'result_class': 'result_class', 'write_alternative_name': 'write_alternative_name'}