3D-printing/Cura
1
0
Fork 0
mirror of https://github.com/Ultimaker/Cura.git synced 2025-07-16 11:17:49 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

STAR-322: Improving documentation

Browse source
This commit is contained in:
Daniel Schiavini 2018-12-17 14:51:57 +01:00
parent 42ae9faeb4
commit da974d9868
2 changed files with 20 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

24
plugins/UM3NetworkPrinting/src/Cloud/CloudApiClient.py
View file

@ -72,12 +72,12 @@ class CloudApiClient:
reply = self._manager.put(self._createEmptyRequest(url), body.encode()) reply = self._manager.put(self._createEmptyRequest(url), body.encode())
self._addCallback(reply, on_finished, CloudPrintJobResponse) self._addCallback(reply, on_finished, CloudPrintJobResponse)
## Requests the cloud to register the upload of a print job mesh. ## Uploads a print job mesh to the cloud.
# \param upload_response: The object received after requesting an upload with `self.requestUpload`. # \param print_job: The object received after requesting an upload with `self.requestUpload`.
# \param mesh: The mesh data to be uploaded. # \param mesh: The mesh data to be uploaded.
# \param on_finished: The function to be called after the result is parsed. It receives the print job ID. # \param on_finished: The function to be called after the upload is successful.
# \param on_progress: A function to be called during upload progress. It receives a percentage (0-100). # \param on_progress: A function to be called during upload progress. It receives a percentage (0-100).
# \param on_error: A function to be called if the upload fails. It receives a dict with the error. # \param on_error: A function to be called if the upload fails.
def uploadMesh(self, print_job: CloudPrintJobResponse, mesh: bytes, on_finished: Callable[[], Any], def uploadMesh(self, print_job: CloudPrintJobResponse, mesh: bytes, on_finished: Callable[[], Any],
on_progress: Callable[[int], Any], on_error: Callable[[], Any]): on_progress: Callable[[int], Any], on_error: Callable[[], Any]):
self._upload = MeshUploader(self._manager, print_job, mesh, on_finished, on_progress, on_error) self._upload = MeshUploader(self._manager, print_job, mesh, on_finished, on_progress, on_error)
@ -134,19 +134,23 @@ class CloudApiClient:
data = response["data"] data = response["data"]
if isinstance(data, list): if isinstance(data, list):
results = [model_class(**c) for c in data] # type: List[CloudApiClient.Model] results = [model_class(**c) for c in data] # type: List[CloudApiClient.Model]
cast(Callable[[List[CloudApiClient.Model]], Any], on_finished)(results) on_finished_list = cast(Callable[[List[CloudApiClient.Model]], Any], on_finished)
on_finished_list(results)
else: else:
result = model_class(**data) # type: CloudApiClient.Model result = model_class(**data) # type: CloudApiClient.Model
cast(Callable[[CloudApiClient.Model], Any], on_finished)(result) on_finished_item = cast(Callable[[CloudApiClient.Model], Any], on_finished)
on_finished_item(result)
elif "errors" in response: elif "errors" in response:
self._on_error([CloudErrorObject(**error) for error in response["errors"]]) self._on_error([CloudErrorObject(**error) for error in response["errors"]])
else: else:
Logger.log("e", "Cannot find data or errors in the cloud response: %s", response) Logger.log("e", "Cannot find data or errors in the cloud response: %s", response)
## Wraps a callback function so that it includes the parsing of the response into the correct model. ## Creates a callback function so that it includes the parsing of the response into the correct model.
# \param on_finished: The callback in case the response is successful. # The callback is added to the 'finished' signal of the reply.
# \param model: The type of the model to convert the response to. It may either be a single record or a list. # \param reply: The reply that should be listened to.
# \return: A function that can be passed to the # \param on_finished: The callback in case the response is successful. Depending on the endpoint it will be either
# a list or a single item.
# \param model: The type of the model to convert the response to.
def _addCallback(self, def _addCallback(self,
reply: QNetworkReply, reply: QNetworkReply,
on_finished: Union[Callable[[Model], Any], Callable[[List[Model]], Any]], on_finished: Union[Callable[[Model], Any], Callable[[List[Model]], Any]],

4
plugins/UM3NetworkPrinting/tests/Cloud/NetworkManagerMock.py
View file

@ -1,7 +1,7 @@
# Copyright (c) 2018 Ultimaker B.V. # Copyright (c) 2018 Ultimaker B.V.
# Cura is released under the terms of the LGPLv3 or higher. # Cura is released under the terms of the LGPLv3 or higher.
import json import json
from typing import Dict, Tuple, Union, Optional from typing import Dict, Tuple, Union, Optional, Any
from unittest.mock import MagicMock from unittest.mock import MagicMock
from PyQt5.QtNetwork import QNetworkAccessManager, QNetworkRequest from PyQt5.QtNetwork import QNetworkAccessManager, QNetworkRequest
@ -53,7 +53,7 @@ class NetworkManagerMock:
# Since the methods are very simple and the same it didn't make sense to repeat the code. # Since the methods are very simple and the same it didn't make sense to repeat the code.
# \param method: The method being called. # \param method: The method being called.
# \return The mocked function, if the method name is known. Defaults to the standard getattr function. # \return The mocked function, if the method name is known. Defaults to the standard getattr function.
def __getattr__(self, method: str) -> any: def __getattr__(self, method: str) -> Any:
## This mock implementation will simply return the reply from the prepared ones. ## This mock implementation will simply return the reply from the prepared ones.
# it raises a KeyError if requests are done without being prepared. # it raises a KeyError if requests are done without being prepared.
def doRequest(request: QNetworkRequest, body: Optional[bytes] = None, *_): def doRequest(request: QNetworkRequest, body: Optional[bytes] = None, *_):