ConfigurationFileDefinition
- class ase2sprkkr.sprkkr.configuration.ConfigurationFileDefinition(name, members=[], **kwargs)[source]
The class for the configuration files (the root nodes of the configuration).
Class hierarchy
Constructor
- __init__(name, members=[], **kwargs)
- 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 – Wheter use the name or the (first) alternative name in the output.
result_class – Redefine the class that holds data for this option/section