Data Types¶

`AsyncWorkerResults`¶

class PySink.AsyncWorkerResults¶

Bases: object

Class to store the results of an AsyncWorker. Custom result types should inherit from this class.

errors = []¶: list: Errors encountered by the worker.

id = None¶: str: The worker’s unique identifier.

results_dict = {}¶: dict: Results of the worker’s task defined as key-value pairs.

warnings = []¶: list: Warnings encountered by the worker.

`AsyncWorkerProgress`¶

class PySink.AsyncWorkerProgress¶

Bases: object

Class to store the progress of an AsyncWorker.

id: str = None¶: str: The worker’s unique identifier.

message: str = None¶: str, optional: Status message about the worker’s progress (Downloading, Calculating, etc).

value = 0¶: Union[int, float]: Current progress value. For determinate progress, value should be [0, 100]. Indeterminate progress value should be -1.

`AsyncWorkerSignals`¶

class PySink.AsyncWorkerSignals¶

Bases: QObject

Class to store the signals of an AsyncWorker. Custom signal type should inherit from this class.

finished¶: Signal(AsyncWorkerResults): Signals that a worker has finished its task and contains the results of the worker’s task.

progress¶: Signal(AsyncWorkerProgress): Signal that contains progress information for the worker.

started¶: Signal(str): Signals that the worker has started its task. Contains the workers unique identified.