env_bool¶
-
privex.helpers.common.
env_bool
(env_key: str, env_default=None) → Optional[bool][source]¶ Obtains an environment variable
env_key
, if it’s empty or not set,env_default
will be returned. Otherwise, it will be converted into a boolean usingis_true()
Example:
>>> os.environ['HELLO_WORLD'] = '1' >>> env_bool('HELLO_WORLD') True >>> env_bool('HELLO_NOEXIST') None >>> env_bool('HELLO_NOEXIST', 'error') 'error'
- Parameters
env_key (str) – Environment var to attempt to load
env_default (any) – Fallback value if the env var is empty / not set (Default: None)