save_result
- glotaran.plugin_system.project_io_registration.save_result(result: Result, result_path: StrOrPath, format_name: str = None, *, allow_overwrite: bool = False, update_source_path: bool = True, **kwargs: Any) list[str] | None [source]
Write a
Result
instance to a spec file.- Parameters
result (Result) –
Result
instance to write.result_path (StrOrPath) – Path to write the result data to.
format_name (str) – Format the result should be saved in, if not provided and it is a file 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 toresult_path
when saving. by default True**kwargs (Any) – Additional keyword arguments passes to the
save_result
implementation of the project io plugin.
- Returns
List of file paths which were saved.
- Return type