Flag

class ase2sprkkr.common.grammar_types.Flag(prefix=None, postfix=None, format='', default_value=None, condition=None, after_convert=None, description='')

A boolean value, which is True, if a name of the value appears in the input file.

Class hierarchy

Constructor

Parameters

• prefix (Optional[str]) –

• postfix (Optional[str]) –

• format (str) –

• default_value (Any) –

• condition (Optional[Callable[[Any], Union[bool, str]]]) –

• after_convert (Optional[Callable[[Any], Any]]) –

__init__(prefix=None, postfix=None, format='', default_value=None, condition=None, after_convert=None, description='')

Create the object.

Parameters

• prefix (Optional[str]) – The string, that will be printed before the value

• postfix (Optional[str]) – The string, that will be printed after the value

• format (str) – 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 (Optional[Any]) – The default value of the options of this type. None means no default value.

• condition (Optional[Callable[[Any], Union[bool, str]]]) – 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 (Optional[Callable[[Any], Any]]) – 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

numpy_type

alias of bool

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

str()

missing_value()

Is the configuraion value a flag? I.e., can be =<value> ommited in the configuration?

Returns

• can_be_ommited (bool) – Is an ommision of the value possible, e.g. the option is given as Flag (only by name of the option)

• default_value – The value used if the value is ommitted

• do_not_output_the_option – The value, for which the variable should not be outputed at all (e.g. False for a flag)

_validate(value, why='set')

Return error message if the value is not valid.

_grammar = Empty

Parameters

name (str) –

Return type

ParserElement

I = <Flag>

allowed_types = (<class 'numpy.bool_'>, <class 'bool'>)

datatype

alias of bool

datatype_name = 'flag'