mirror of
https://git.mirrors.martin98.com/https://github.com/Ultimaker/Cura
synced 2025-04-22 05:39:37 +08:00
45 lines
1.4 KiB
Python
45 lines
1.4 KiB
Python
# Copyright (c) 2018 Ultimaker B.V.
|
|
# Cura is released under the terms of the LGPLv3 or higher.
|
|
from typing import Tuple, Optional, TYPE_CHECKING, Dict, Any
|
|
|
|
from cura.Backups.BackupsManager import BackupsManager
|
|
|
|
if TYPE_CHECKING:
|
|
from cura.CuraApplication import CuraApplication
|
|
|
|
|
|
class Backups:
|
|
"""The back-ups API provides a version-proof bridge between Cura's
|
|
|
|
BackupManager and plug-ins that hook into it.
|
|
|
|
Usage:
|
|
|
|
.. code-block:: python
|
|
|
|
from cura.API import CuraAPI
|
|
api = CuraAPI()
|
|
api.backups.createBackup()
|
|
api.backups.restoreBackup(my_zip_file, {"cura_release": "3.1"})
|
|
"""
|
|
|
|
def __init__(self, application: "CuraApplication") -> None:
|
|
self.manager = BackupsManager(application)
|
|
|
|
def createBackup(self) -> Tuple[Optional[bytes], Optional[Dict[str, Any]]]:
|
|
"""Create a new back-up using the BackupsManager.
|
|
|
|
:return: Tuple containing a ZIP file with the back-up data and a dict with metadata about the back-up.
|
|
"""
|
|
|
|
return self.manager.createBackup()
|
|
|
|
def restoreBackup(self, zip_file: bytes, meta_data: Dict[str, Any]) -> None:
|
|
"""Restore a back-up using the BackupsManager.
|
|
|
|
:param zip_file: A ZIP file containing the actual back-up data.
|
|
:param meta_data: Some metadata needed for restoring a back-up, like the Cura version number.
|
|
"""
|
|
|
|
return self.manager.restoreBackup(zip_file, meta_data)
|