bec_widgets.utils.yaml_dialog#

Functions#

`load_yaml`(→ Union[dict, None])	Load YAML file from disk.
`load_yaml_gui`(→ Union[dict, None])	Load YAML file from disk.
`save_yaml`(→ None)	Save YAML file to disk.
`save_yaml_gui`(→ None)	Save YAML file to disk.

Module Contents#

load_yaml(file_path: str) → dict | None#

Load YAML file from disk.

Parameters:: file_path (str) – Path to the YAML file.
Returns:: Configuration data loaded from the YAML file.
Return type:: dict

load_yaml_gui(instance) → dict | None#

Load YAML file from disk.

Parameters:: instance – Instance of the calling widget.
Returns:: Configuration data loaded from the YAML file.
Return type:: dict

save_yaml(file_path: str, config: dict) → None#

Save YAML file to disk.

Parameters:

file_path (str) – Path to the YAML file.
config (dict) – Configuration data to be saved.

save_yaml_gui(instance, config: dict) → None#

Save YAML file to disk.

Parameters:

instance – Instance of the calling widget.
config – Configuration data to be saved.