BaseGeneratedValueDefinition
- class ase2sprkkr.common.generated_configuration_definitions.BaseGeneratedValueDefinition(name, written_name=None, is_optional=None, is_hidden=False, is_expert=False, experimental=False, name_in_grammar=None, name_format=None, info=None, description=None, name_regex=None, condition=None, write_condition=None, result_class=None, is_repeated=False, repeated_delimiter=None, repeated_count=None, repeated_with_name=None, warning_condition=None, validators=(), plot=None, indent=None)[source]
Base class for all generated values. It just set that it is generated.
Class hierarchy
Constructor
- Parameters:
warning_condition (Callable[[Any], Any] | None)
validators (Callable[[Any, Any, str], Any] | Iterable[Callable[[Any, Any, str], Any]] | None)
- __init__(name, written_name=None, is_optional=None, is_hidden=False, is_expert=False, experimental=False, name_in_grammar=None, name_format=None, info=None, description=None, name_regex=None, condition=None, write_condition=None, result_class=None, is_repeated=False, repeated_delimiter=None, repeated_count=None, repeated_with_name=None, warning_condition=None, validators=(), plot=None, indent=None)
- Parameters:
name (str | Tuple(str)) – Name of the value/section
written_name (str or None) – Name to write to the input file. Default None means use the name.
is_optional (bool or callable) – If True, the section/value may be omitted from input. A callable accepts its runtime item and is evaluated after parsing.
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
experimental (bool) – Whether this value or section is experimental (metadata only).
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
name_format (str or None) – The way how the name is written
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_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.
is_repeated (bool or string) – The section can be repeated. If a non-empty string is given, the values are divided by the string.
repeated_delimiter (string) – The delimiter used between repeated instances of self, if not repeated_with_name
repeated_count (string or int or callable) – The number of repetitions. If string, the repetition is given from the parsed value at that exact path;
..selects the parent section (for example..NPAN). If callable, the function is called on the values of the local options named by its parameters.repeated_with_name (bool) – If True, the whole value-name pair is repeated
warning_condition (Callable[[Any], Any] | None) – A one-value warning condition executed through the validator pipeline.
validators (Callable[[Any, Any, str], Any] | Iterable[Callable[[Any, Any, str], Any]] | None) –
- A callable or an iterable of callables accepting the runtime item,
its containing runtime section, and the validation reason (
set,parseorsave). Validators return aDataValidityWarning,DataValidityError, an iterable of such issues, or None.- indent
Vytiskne daný string před názvem
- is_generated = True
Generated value - the value is computed from other values
- is_stored = False
This property sets, that this Value/Option is generated.
- is_validated = False
By default, there is nothing to check on generated values
- result_class
The generated Values creates
Optionalias of
ase2sprkkr.common.options.Option
- _grammar = None
Do not generated grammar, since this item is not readed, but computed from other values.
- item_type = 'generated value'