Flag

class ase2sprkkr.ase.test.grammar_types.basic.Flag(prefix=None, postfix=None, format='', after_format=None, default_value=None, condition=None, after_convert=None, description='')[source]

A boolean value, which is True, if a name of the value appears in the input file. The resulting type of a Flag value is bool

Class hierarchy

Inheritance diagram of ase2sprkkr.ase.test.grammar_types.basic.Flag

Constructor

Parameters:
  • prefix (str | None)

  • postfix (str | None)

  • format (str)

  • after_format (str | None)

  • default_value (Any)

  • condition (Callable[[Any], bool | str] | None)

  • after_convert (Callable[[Any], Any] | None)

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

Create the object.

Parameters:
  • prefix (str | None) – The string, that will be printed before the value

  • postfix (str | None) – The string, that will be printed after the value

  • format (str) – The (python) format string, that will be used for outputing the value. The format is passed as format argument to str.format routine.

  • after_format (str | None) – In some cases, the additional formating is required after converting to the string and adding postfix/prefix.

  • default_value (Any) – The default value of the options of this type. None means no default value.

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

_grammar = Empty
Parameters:

name (str | None)

Return type:

ParserElement

grammar_name()[source]

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()[source]
missing_value()[source]

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')[source]

Return error message if the value is not valid.

I = <Flag>