Skip to content

Env

Environment variable parsing for the state.

get_env #

get_env(
    key: str, parse: Callable[[str], T], default: V
) -> T | V

Get an environment variable or return a default value.

Source code in neps/env.py 
15
16
17
18
19
20
21
22
23
def get_env(key: str, parse: Callable[[str], T], default: V) -> T | V:
    """Get an environment variable or return a default value."""
    if (e := os.environ.get(key)) is not None:
        value = parse(e)
        ENV_VARS_USED[key] = (e, value)
        return value

    ENV_VARS_USED[key] = (default, default)
    return default

is_nullable #

is_nullable(e: str) -> bool

Check if an environment variable is nullable.

Source code in neps/env.py 
26
27
28
def is_nullable(e: str) -> bool:
    """Check if an environment variable is nullable."""
    return e.lower() in ("none", "n", "null")

yaml_or_json #

yaml_or_json(e: str) -> Literal['yaml', 'json']

Check if an environment variable is either yaml or json.

Source code in neps/env.py 
31
32
33
34
35
def yaml_or_json(e: str) -> Literal["yaml", "json"]:
    """Check if an environment variable is either yaml or json."""
    if e.lower() in ("yaml", "json"):
        return e.lower()  # type: ignore
    raise ValueError(f"Expected 'yaml' or 'json', got '{e}'.")