Keyword

class ase2sprkkr.common.grammar_types.Keyword(*keywords, **kwargs)

A value, that can take values from the predefined set of strings.

Class hierarchy

Constructor

__init__(*keywords, **kwargs)

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, and False 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

_validate(value, why='set')

Return error message if the value is not valid.

grammar_name()

Human readable expression of the grammar. By default, this is what is set by grammar.setName, however, sometimes is desirable to set even shorter string

convert(value)

Convert a value from user to the “cannonical form”

additional_description(prefix='')

If the description of the type does not fit on one line, this method should return

Returns

The additional description (e.g. possible choices) of the type. Multiline string.

Return type

additional_description