AxipyProgressHandler - Объект для связи с задачей и её управлением¶

class axipy.concurrent.AxipyProgressHandler¶

Класс объекты которого выполняют функцию канала передачи данных между выполняемой задачей и элементом отображающим прогресс.

add_progress(value)¶

Добавляет к текущему прогрессу переданное значение.

Параметры: value (float) – Значение, которое будет добавлено к прогрессу.

cancel()¶: Отменяет задачу связанную с обработчиком.

Примечание

Эта функция посылает только запрос на отмену операции. Реальное прерывание операции возможно только если есть поддержка в пользовательском коде. Например с помощью функций is_canceled или raise_if_canceled

property canceled¶

Signal[] Уведомляет, что задача была отменена. Сигнал испускается когда была вызвана функция cancel.

Предупреждение

Получение этого сигнала не означает, что задача была завершена. Если в пользовательском коде не обрабатывается отмена задача будет продолжать выполняться до логического завершения.

Тип результата: Signal

property description_changed¶

Signal[str] Уведомляет о изменении описания задачи.

Тип результата: Signal

property error¶

Singal[tuple] Сигнал об ошибке, содержащий информацию о исключении.

Тип результата: Signal

property finished¶

Signal[] Уведомляет о завершении выполняемой задачи.

Тип результата: Signal

is_canceled()¶

Проверяем не была ли задача отменена.

Тип результата: bool

is_finished()¶

Проверяем не завершилась ли задача.

Тип результата: bool

is_running()¶

Возвращает True если задача сейчас выполняется.

Тип результата: bool

prepare_to_write_changes()¶: Вспомогательная функция. Делает прогрессбар бесконечным, убирает кнопку отмены и добавляет надпись о том, что производится запись изменений

progress()¶

Возвращает текущий прогресс выполнения.

Тип результата: float

property progress_changed¶

Signal[float] Уведомляет о изменении значения прогресса.

Тип результата: Signal

raise_if_canceled()¶: Если задача была отменена выбрасывает исключение. Удобно при работе с большим количеством вложенных циклов или вызовов функции.

property result¶

Содержит результат выполнения задачи связанной с обработчиком. None возвращается если произошла ошибка, либо задача не предполагает возвращение результата.

Результат: Результат выполнения задачи или None.

set_description(description)¶

Устанавливаем описание для задачи. Эта информация может быть использована элементами отображающими прогресс выполнения.

Параметры: description (str) – Новое описание задачи.

set_max_progress(value)¶

Устанавливает максимальное значение прогресса. Минимальное значение берется за ноль.

Параметры: value (float) – Верхний порог для прогресса операции.

set_progress(value)¶

Устанавливает текущий прогресс задачи.

Параметры: value (float) – Новое значение прогресса.

set_window_title(title)¶

Устанавливает заголовок диалога с прогрессом.

Параметры: title (str) – Новый заголовок.

property started¶

Signal[] Уведомляет о старте выполнения задачи.

Тип результата: Signal

property window_title_changed¶

Signal[str] Уведомляет о изменении заголовка диалога отображающего прогресс.

Тип результата: Signal