hpcflow.sdk.core.utils.read_YAML_file

hpcflow.sdk.core.utils.read_YAML_file(path, typ='safe', variables=None)

Load a YAML file. This will produce basic objects.

Parameters:

• path (PathLike) – Path to the YAML file to parse.

• typ – Load type passed to the YAML library.

• variables (dict[str, str] | Literal[False] | None) – String variables to substitute in the file given by path. Substitutions will be attempted if the file looks to contain variable references (like “<<var:name>>”). If set to False, no substitutions will occur.

Return type:

Any