SectionDefinition
- class ase2sprkkr.common.container_definitions.SectionDefinition(name, members=[], written_name=None, info=None, description=None, is_optional=None, is_hidden=False, is_expert=False, experimental=False, has_hidden_members=False, name_in_grammar=None, force_order=None, name_regex=False, result_class=None, is_repeated=False, repeated_delimiter=None, repeated_count=None, repeated_with_name=False, write_condition=None, warning_condition=None, validators=())[source]
Base class for definition of the sections in Pot or InputParameters files.
It just redefine a few properties/methods to values/behavior typical for the sections
Class hierarchy
Constructor
- Parameters:
validators (Callable[[Any, Any, str], Any] | Iterable[Callable[[Any, Any, str], Any]] | None)
- __init__(name, members=[], written_name=None, info=None, description=None, is_optional=None, is_hidden=False, is_expert=False, experimental=False, has_hidden_members=False, name_in_grammar=None, force_order=None, name_regex=False, result_class=None, is_repeated=False, repeated_delimiter=None, repeated_count=None, repeated_with_name=False, write_condition=None, warning_condition=None, validators=())
Definition of container (e.g. section of an input file). For the rest of the parameters see the
RealItemDefinition.- Parameters:
has_hidden_members (bool) – If true, this section is not intended for a direct editing
force_order (bool) – If True, the items has to retain the order, if False, the items can be in the input file in any order.
validators (callable or iterable of callables) – Semantic validators passed to
RealItemDefinition.
- result_class
- property values
- custom_value_name = 'CUSTOM_VALUE'
Just the name that appears in the grammar, when it is printed.