Bool
- class ase2sprkkr.common.grammar_types.Bool(prefix=None, postfix=None, format='', default_value=None, condition=None, after_convert=None, description='')[source]
A bool type, whose value is represented by a letter (T or F)
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, andFalse
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
- _grammar = {'T' | 'F'}
- Parameters
name (str) –
- 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
- _string(val)[source]
The string method do some additional transformation (add prefix, postfix etc.), so the actual way how to convert the value for the output should be here.
- numpy_type
alias of
bool
- type_name = 'boolean'
- I = <Bool>
- allowed_types = (<class 'numpy.bool_'>, <class 'bool'>)
- datatype
alias of
bool
- datatype_name = 'bool'