nip.utils.env.get_env_var

Contents

nip.utils.env.get_env_var#

nip.utils.env.get_env_var(var_name: str, default=<object object>) str[source]#

Get the value of an environment variable, raising an error if not set.

Parameters:
  • var_name (str) – The name of the environment variable to get.

  • default (str, optional) – The default value to return if the environment variable is not set. If not provided, an error is raised if the environment variable is not set.

Returns:

env_value (str) – The value of the environment variable.

Raises:

EnvironmentVariableDoesNotExistError – If the environment variable is not set.