napari.qt.threading.GeneratorWorker#

class napari.qt.threading.GeneratorWorker(func: ~typing.Callable[[~_P], ~typing.Generator[~superqt.utils._qthreading._Y, ~superqt.utils._qthreading._S | None, ~superqt.utils._qthreading._R]], *args, SignalsClass: type[~superqt.utils._qthreading.WorkerBaseSignals] = <class 'superqt.utils._qthreading.GeneratorWorkerSignals'>, **kwargs)[source]#

Bases: GeneratorWorker[_Y, _S, _R], _NotifyingMixin

inherited-members:

Methods

autoDelete(self)

await_workers([msecs])

Ask all workers to quit, and wait up to msec for quit.

create(functionToRun)

pause()

Request to pause the worker.

quit()

Send a request to abort the worker.

resume()

Send a request to resume the worker.

run()

Start the worker.

send(value)

Send a value into the function (if a generator was used).

setAutoDelete(self, _autoDelete)

start()

Start this worker in a thread and add it to the global threadpool.

toggle_pause()

Request to pause the worker if playing or resume if paused.

work()

Core event loop that calls the original function.

Attributes

abort_requested

Whether the worker has been requested to stop.

is_paused

Whether the worker is currently paused.

is_running

Whether the worker has been started.

Details