upsilonconf.save_config

upsilonconf.save_config(config: ConfigurationBase, path: Path | str, key_mods: Mapping[str, str] | None = None, config_io: ConfigIO | None = None) → None[source]

Write a configuration data to disk.

Parameters:
configConfigurationBase

The configuration object to save.

pathPath or str

Path to a writeable text file on disk.

key_modsdict, optional

A dictionary mapping key substrings to replacement patterns. This allows to modify keys with invalid characters for config keys.

config_ioConfigIO, optional

The IO to use for writing the file. If not specified, the default IO will be used.

See also

io.get_default_io

retrieve the default IO.

io.ConfigIO.save_config

implementation of functionality.