bec_widgets.utils.yaml_dialog
=============================

.. py:module:: bec_widgets.utils.yaml_dialog


Functions
---------

.. autoapisummary::

   bec_widgets.utils.yaml_dialog.load_yaml
   bec_widgets.utils.yaml_dialog.load_yaml_gui
   bec_widgets.utils.yaml_dialog.save_yaml
   bec_widgets.utils.yaml_dialog.save_yaml_gui


Module Contents
---------------

.. py:function:: load_yaml(file_path: str) -> Union[dict, None]

   Load YAML file from disk.

   :param file_path: Path to the YAML file.
   :type file_path: str

   :returns: Configuration data loaded from the YAML file.
   :rtype: dict


.. py:function:: load_yaml_gui(instance) -> Union[dict, None]

   Load YAML file from disk.

   :param instance: Instance of the calling widget.

   :returns: Configuration data loaded from the YAML file.
   :rtype: dict


.. py:function:: save_yaml(file_path: str, config: dict) -> None

   Save YAML file to disk.

   :param file_path: Path to the YAML file.
   :type file_path: str
   :param config: Configuration data to be saved.
   :type config: dict


.. py:function:: save_yaml_gui(instance, config: dict) -> None

   Save YAML file to disk.

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