OutputSectionDefinition

class ase2sprkkr.outputs.output_definitions.OutputSectionDefinition(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 standard potential section

Class hierarchy

Inheritance diagram of ase2sprkkr.outputs.output_definitions.OutputSectionDefinition

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

force_order = True

The order of items in output file is fixed

name_in_grammar = False

Parsed parts of the output have no names, they are identified by its positions

child_class

standard child class

alias of OutputValueDefinition

custom_class = None

There is no custom class in the output, only known parts of the file are parsed

delimiter = '\n'

options are delimited by newline in ouptut.

grammar_of_delimiter = Suppress:({[ ] WordStart})
Parameters

name (str) –

Return type

ParserElement