ewoksorange.gui.concurrency.queued.TaskExecutorQueue#

class ewoksorange.gui.concurrency.queued.TaskExecutorQueue(ewokstaskclass)[source]#

Bases: QObject, Queue

Processing Queue with a First In, First Out behavior

add(**kwargs)[source]#: Add a task ewokstaskclass execution request

classmethod blockSignals(self, b: bool) → bool#

cancel_running_task(wait=True)[source]#: will cancel current task. task_executor signal ‘finished’ will be blocked but callbacks will be executed to ensure a safe processing

classmethod childEvent(self, a0: QChildEvent | None)#

classmethod children(self) → list[QObject]#

classmethod connectNotify(self, signal: QMetaMethod)#

property current_task#

classmethod customEvent(self, a0: QEvent | None)#

classmethod deleteLater(self)#

destroyed#

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

classmethod disconnect(a0: QMetaObject.Connection) → bool#
classmethod disconnect(self)

classmethod disconnectNotify(self, signal: QMetaMethod)#

classmethod dumpObjectInfo(self)#

classmethod dumpObjectTree(self)#

classmethod dynamicPropertyNames(self) → list[QByteArray]#

empty()#

Return True if the queue is empty, False otherwise (not reliable!).

This method is likely to be removed at some point. Use qsize() == 0 as a direct substitute, but be aware that either approach risks a race condition where a queue can grow before the result of empty() or qsize() can be used.

To create code that needs to wait for all queued tasks to be completed, the preferred technique is to use the join() method.

classmethod event(self, a0: QEvent | None) → bool#

classmethod eventFilter(self, a0: QObject | None, a1: QEvent | None) → bool#

classmethod findChild(self, type: type[QObjectT], name: str | None = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) → QObjectT#
classmethod findChild(self, types: tuple[type[QObjectT], ...], name: str | None = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) → QObjectT

classmethod findChildren(self, type: type[QObjectT], name: str | None = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) → list[QObjectT]#
classmethod findChildren(self, types: tuple[type[QObjectT], ...], name: str | None = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) → list[QObjectT]
classmethod findChildren(self, type: type[QObjectT], re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) → list[QObjectT]
classmethod findChildren(self, types: tuple[type[QObjectT], ...], re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) → list[QObjectT]

full()#

Return True if the queue is full, False otherwise (not reliable!).

This method is likely to be removed at some point. Use qsize() >= n as a direct substitute, but be aware that either approach risks a race condition where a queue can shrink before the result of full() or qsize() can be used.

get(block=True, timeout=None)#

Remove and return an item from the queue.

If optional args ‘block’ is true and ‘timeout’ is None (the default), block if necessary until an item is available. If ‘timeout’ is a non-negative number, it blocks at most ‘timeout’ seconds and raises the Empty exception if no item was available within that time. Otherwise (‘block’ is false), return an item if one is immediately available, else raise the Empty exception (‘timeout’ is ignored in that case).

get_nowait()#

Remove and return an item from the queue without blocking.

Only get an item if one is immediately available. Otherwise raise the Empty exception.

classmethod inherits(self, classname: str) → bool#

classmethod installEventFilter(self, a0: QObject | None)#

classmethod isQmlExposed(self) → bool#

classmethod isQuickItemType(self) → bool#

classmethod isSignalConnected(self, signal: QMetaMethod) → bool#

classmethod isWidgetType(self) → bool#

classmethod isWindowType(self) → bool#

property is_available: bool#

join()#

Blocks until all items in the Queue have been gotten and processed.

The count of unfinished tasks goes up whenever an item is added to the queue. The count goes down whenever a consumer thread calls task_done() to indicate the item was retrieved and all work on it is complete.

When the count of unfinished tasks drops to zero, join() unblocks.

classmethod killTimer(self, id: int)#

classmethod metaObject(self) → QMetaObject | None#

classmethod moveToThread(self, thread: QThread | None)#

classmethod objectName(self) → str#

objectNameChanged#

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

classmethod parent(self) → QObject | None#

classmethod property(self, name: str) → Any#

put(item, block=True, timeout=None)#

Put an item into the queue.

If optional args ‘block’ is true and ‘timeout’ is None (the default), block if necessary until a free slot is available. If ‘timeout’ is a non-negative number, it blocks at most ‘timeout’ seconds and raises the Full exception if no free slot was available within that time. Otherwise (‘block’ is false), put an item on the queue if a free slot is immediately available, else raise the Full exception (‘timeout’ is ignored in that case).

put_nowait(item)#

Put an item into the queue without blocking.

Only enqueue the item if a free slot is immediately available. Otherwise raise the Full exception.

classmethod pyqtConfigure(...)#: Each keyword argument is either the name of a Qt property or a Qt signal. For properties the property is set to the given value which should be of an appropriate type. For signals the signal is connected to the given value which should be a callable.

qsize()#: Return the approximate size of the queue (not reliable!).

classmethod receivers(self, signal: PYQT_SIGNAL) → int#

classmethod removeEventFilter(self, a0: QObject | None)#

classmethod sender(self) → QObject | None#

classmethod senderSignalIndex(self) → int#

classmethod setObjectName(self, name: QByteArray | bytes | bytearray | memoryview | str | None)#

classmethod setParent(self, a0: QObject | None)#

classmethod setProperty(self, name: str, value: Any) → bool#

sigComputationEnded#: Signal emitted when a computation is ended

sigComputationStarted#: Signal emitted when a computation is started

classmethod signalsBlocked(self) → bool#

classmethod startTimer(self, interval: int, timerType: Qt.TimerType = Qt.CoarseTimer) → int#

staticMetaObject = <PyQt6.QtCore.QMetaObject object>#

stop()[source]#: stop the queue. Wait for the last processing to be finished and reset current_task

task_done()#

Indicate that a formerly enqueued task is complete.

Used by Queue consumer threads. For each get() used to fetch a task, a subsequent call to task_done() tells the queue that the processing on the task is complete.

If a join() is currently blocking, it will resume when all items have been processed (meaning that a task_done() call was received for every item that had been put() into the queue).

Raises a ValueError if called more times than there were items placed in the queue.

classmethod thread(self) → QThread | None#

classmethod timerEvent(self, a0: QTimerEvent | None)#

classmethod tr(sourceText: str, disambiguation: str = None, n: int = -1) → str#