BaseGeneratedValueDefinition
- class ase2sprkkr.common.generated_configuration_definitions.BaseGeneratedValueDefinition(name, written_name=None, alternative_names=None, is_optional=False, is_hidden=False, is_expert=False, name_in_grammar=None, info=None, description=None, write_alternative_name=False, condition=None, write_condition=None, result_class=None, warning_condition=None)[source]
Base class for all generated values. It just set that it is generated.
Class hierarchy
Constructor
- Parameters:
write_alternative_name (bool) –
- __init__(name, written_name=None, alternative_names=None, is_optional=False, is_hidden=False, is_expert=False, name_in_grammar=None, info=None, description=None, write_alternative_name=False, condition=None, write_condition=None, result_class=None, warning_condition=None)
- Parameters:
name (str) – Name of the value/section
written_name (str or None) – Name to write to the input file. Default None means use the name.
alternative_names (str or [str]) – Alternative names that can denotes the value. If no written_name is given, the first alternative_names is used for the output. However, contrary to written_name, such way still allow to parse the name during parsing as the name of 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.
write_condition – If defined, write the value, only if write_condition(the option) is True.
condition –
- If defined, the condition
the condition.parse_condition() is invoked, when a given grammar element should be parsed. If it is False, the element is skipped
the condition() is invoked, when the elements of the container is listed to hide the inactive members
result_class – Redefine the class that holds data for this option/section.
warning_condition – If this lambda returns a non-none during validation, a warning will be issued.
- is_generated = True
Generated value - the value is computed from other values
- is_stored = False
This property sets, that this Value/Option is generated.
- _grammar = None
Do not generated grammar, since this item is not readed, but computed from other values.