write_config#

caf.toolkit.config_base.write_config(yaml, path, *, datetime_comment=True, name=None, other_comment=None, format_comment=False)[source]#

Write data from self to a YAML file.

Parameters:

  • yaml (str) – YAML formatted text to write to config file.

  • path (Path) – Path to YAML file to output.

  • datetime_comment (bool, default True) – Whether to include a comment at the top of the config file with the current date and time.

  • name (str) – Name of the type of config being written, used for datetime comments.

  • other_comment (str, optional) – Additional comments to add to the top of the config file, “#” will be added to the start of each new line if it isn’t already there.

  • format_comment (bool, default False) – Whether to remove newlines from other_comment and format lines to a specific character length.

Return type:

None