granular_configuration_language .yaml.file_ops.environment_variable

granular_configuration_language.yaml.file_ops.environment_variable.load_as_file(
tag: Tag,
variable_name: str,
options: LoadOptions,
) → EagerIOTextFile[source]

Added in version 2.3.0.

Load the environment variable, as if it were an already loaded file.

(A missing environment variable follows the conventions of a missing file, setting the exists flag to False)

Parameters:

  • tag (Tag) – Tag doing this, used for error reporting.

  • variable_name (str) – Name of the environment variable being loaded

  • options (LoadOptions) – options from the Tag doing this action, used for tracking chains.

Returns:

Constructed instance

Return type:

EagerIOTextFile