pyiron_base.utils.strtobool.strtobool

Contents

pyiron_base.utils.strtobool.strtobool#

pyiron_base.utils.strtobool.strtobool(val: str) int[source]#

Convert a string representation of truth to true (1) or false (0).

True values are ‘y’, ‘yes’, ‘t’, ‘true’, ‘on’, and ‘1’; false values are ‘n’, ‘no’, ‘f’, ‘false’, ‘off’, and ‘0’. Raises ValueError if ‘val’ is anything else.

Parameters:

val (str) – The string representation of truth value.

Returns:

The converted truth value as an integer (1 for true, 0 for false).

Return type:

int

Raises:

ValueError – If ‘val’ is not a valid truth value.