Environment#

Exceptions#

class council.utils.MissingEnvVariableException(name: str)[source]#

Bases: Exception

Custom exception raised when a required environment variable is missing.

__init__(name: str) → None[source]#

Initializes an instance of MissingEnvVariableError.

Parameters:: name (str) – The name of the missing environment variable.
Returns:: None

class council.utils.EnvVariableValueException(name: str, value: str, expected_type: Type)[source]#

Bases: Exception

Custom exception raised if an environment variable is assigned a value that is inconsistent with its declared data type.

__init__(name: str, value: str, expected_type: Type) → None[source]#

Initializes an instance of MissingEnvVariableError.

council.utils.read_env_str(name: str, required: bool = True, default: str | None = None) → Option[str][source]#: Read an environment variable as string, return as Option.

council.utils.must_read_env_str(name: str) → str[source]#: Read an environment variable as string.

council.utils.read_env_int(name: str, required: bool = True, default: int | None = None) → Option[int][source]#: Read an environment variable as integer, return as Option.

council.utils.must_read_env_int(name: str) → int[source]#: Read an environment variable as integer.

council.utils.read_env_float(name: str, required: bool = True, default: float | None = None) → Option[float][source]#: Read an environment variable as float, return as Option.

council.utils.must_read_env_float(name: str) → float[source]#: Read an environment variable as float.

council.utils.read_env_bool(name: str, required: bool = True, default: bool | None = None) → Option[bool][source]#: Read an environment variable as boolean, return as Option.

council.utils.must_read_env_bool(name: str) → bool[source]#: Read an environment variable as boolean.