vantage.builtin.env

The __env builtin provides commands that help read and write your env files.

env_cmd(env, *args)

Parameters:

Name	Type	Description	Default
env	dict	The environment we run this command inside	required
*args	List[str]	The arguments passed from the command line	()

Source code in vantage/builtin/env.py

def env_cmd(env:dict, *args: List[str]):
    """

    Arguments:
         env: The environment we run this command inside
         *args: The arguments passed from the command line
    """
    utils.loquacious("Running __env", env)
    args = parser.parse_args(args)

    if args.key_val is None:
        utils.loquacious("  Printing ENV", env)
        for k, v in env.items():
            print(f"{k}={v}")
    elif "=" in args.key_val:
        utils.loquacious("  Setting ENV value", env)
        key, val = args.key_val.split("=", 1)
        write_env_value(env, key, val, args.base64)
    elif args.stdin:
        utils.loquacious("  Setting ENV value from stdin", env)
        val = sys.stdin.read().strip()
        write_env_value(env, args.key_val, val, args.base64)
    else:
        utils.loquacious("  Printing single ENV value", env)
        try:
            value = env[args.key_val]
            print(value)
        except KeyError:
            raise VantageException(f"No value found for '{args.key_val}'")

write_env_value(env, key, value, base64=False)

Writes a key=value line into an environment file.

Parameters:

Name	Type	Description	Default
env	dict	The environment we run this command inside	required
key	str	The name of the new env variable (usually in ALL CAPS)	required
value	str	The value of the new env variable	required
base64	bool	Set to true if you want to base64 encode the value before writing it. Useful if you're dealing with values that contain unexpected characters (like new lines, or emoji). vantage will automatically decode these values when reading them back in.	False

Source code in vantage/builtin/env.py

def write_env_value(env:dict, key:str, value:str, base64:bool=False):
    """Writes a key=value line into an environment file.

    Arguments:
        env: The environment we run this command inside
        key: The name of the new env variable (usually in ALL CAPS)
        value: The value of the new env variable
        base64: Set to true if you want to base64 encode the value before writing it. Useful if you're dealing with
            values that contain unexpected characters (like new lines, or emoji). vantage will automatically decode
            these values when reading them back in.
    """
    try:
        env_file = Path(env["VG_ENV_FILE"])
        utils.loquacious(f"  Adding {key}={value} to {env_file}", env)
        if base64:
            value = utils.to_base64(value)
        env[key] = value
        with env_file.open("w") as fp:
            for key, value in sorted(env.items()):
                if not key.startswith("VG_"):
                    fp.write(f"{key}={value}\n")
    except KeyError:
        raise VantageException(
            "No env file provided, there's nowhere to store this value"
        )

---

Last update: 2022-04-12