Keyword
- class ase2sprkkr.common.grammar_types.Keyword(*keywords, **kwargs)[source]
A value, that can take values from the predefined set of strings.
Class hierarchy
Constructor
- __init__(*keywords, **kwargs)[source]
Create the object.
- Parameters
prefix – The string, that will be printed before the value
postfix – The string, that will be printed after the value
format – The (python) format string, that will be used for printing the value. The format is passed as format argument to
str.format
routine.default_value – The default value of the options of this type.
None
means no default value.condition – Function, that check the validity of the value. It should return
True
for a valid value, andFalse
or string for invalid. The string is interpreted as an error message that explains the invalidity of the value.after_convert – Function, that - if it is given - is applied to the (entered or parsed) value. The function is applied on the result of the
convert
method