clowder.yaml package

Submodules

clowder.yaml.loading module

clowder.yaml loading

clowder.yaml.loading.load_yaml()

Load clowder from yaml file

Raises:ClowderYAMLError –

clowder.yaml.parsing module

clowder.yaml parsing

clowder.yaml.parsing.parse_yaml(yaml_file)

Parse yaml file

Parameters:

yaml_file (str) – Path to yaml file
Returns:

YAML python object
Return type:

dict
Raises:
  • ClowderExit
  • ClowderYAMLError

clowder.yaml.printing module

clowder.yaml printing

clowder.yaml.printing.print_yaml()

Print current clowder yaml

clowder.yaml.saving module

clowder.yaml saving

clowder.yaml.saving.save_yaml(yaml_output, yaml_file)

Save yaml file to disk

Parameters:
  • yaml_output (dict) – Parsed YAML python object
  • yaml_file (str) – Path to save yaml file
Raises:

ClowderExit –

clowder.yaml.validating module

clowder.yaml validation

clowder.yaml.validating.validate_yaml(yaml_file, depth=10)

Validate clowder.yaml

Parameters:
  • yaml_file (str) – Yaml file path to validate
  • depth (Optional[int]) – Max depth of clowder.yaml imports
Raises:
  • ClowderExit
  • ClowderYAMLError

Module contents

clowder.yaml __init__