Real

class ase2sprkkr.common.test.grammar_types.basic.Real(prefix=None, postfix=None, format='', after_format=None, default_value=None, condition=None, after_convert=None, description='', min=None, max=None, nan=None)[source]

A real value

Class hierarchy

Inheritance diagram of ase2sprkkr.common.test.grammar_types.basic.Real

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)

  • min (int | None)

  • max (int | None)

__init__(prefix=None, postfix=None, format='', after_format=None, default_value=None, condition=None, after_convert=None, description='', min=None, max=None, nan=None)[source]
Parameters:
  • min (int | None) – Minimal allowed value.

  • max (int | None) – Maximal allowed value.

  • 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)

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

numpy_type

alias of float

nan = None
_grammar = fnumber
Parameters:

name (str | None)

Return type:

ParserElement

convert(value)[source]

Convert a value from user to the “cannonical form”

I = <Real>