improv.utils.checks

The script checks the validity of the YAML configuration file.

Example usage:

$ python checks.py [file_name].yaml

$ python checks.py good_config.yaml No loops.

$ python checks.py bad_config.yaml Loop(s) found. Processor to Analysis to Acquirer

Module Contents

Functions

check_if_connections_acyclic(path_to_yaml)

Check if connections in the YAML configuration file do not form a loop.

improv.utils.checks.check_if_connections_acyclic(path_to_yaml)

Check if connections in the YAML configuration file do not form a loop.

Print ‘No loops.’ if the connections are acyclic. Print ‘Loop(s) found.’ followed by the loop path if loops are found.

Parameters:

path_to_yaml (str) – Path to the YAML file.

Returns:

Whether the connections are acyclic.

Return type:

bool