save_scheme

glotaran.plugin_system.project_io_registration.save_scheme(scheme: Scheme, file_name: StrOrPath, format_name: str | None = None, *, allow_overwrite: bool = False, update_source_path: bool = True, **kwargs: Any) → None[source]

Save a Scheme instance to a spec file.

Parameters:

  • scheme (Scheme) – Scheme instance to save to specs file.

  • file_name (StrOrPath) – File to write the scheme specs to.

  • format_name (str | None) – Format the file should be in, if not provided it will be inferred from the file extension.

  • allow_overwrite (bool) – Whether or not to allow overwriting existing files, by default False

  • update_source_path (bool) – Whether or not to update the source_path attribute to file_name when saving. by default True

  • **kwargs (Any) – Additional keyword arguments passes to the save_scheme implementation of the project io plugin.