TypedGrammarType

class ase2sprkkr.sprkkr.test.grammar_types.grammar_type.TypedGrammarType(prefix=None, postfix=None, format='', after_format=None, default_value=None, condition=None, after_convert=None, description='')[source]

Class hierarchy

Inheritance diagram of ase2sprkkr.sprkkr.test.grammar_types.grammar_type.TypedGrammarType

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

datatype

alias of object

allowed_types = (<class 'object'>,)
convert(value)[source]

Convert a value from user to the “cannonical form”

datatype_name = 'typedgrammartype'
_validate(value, why='set')[source]

Return error message if the value is not valid.