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

class axipy.AxipyProgressHandler

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

error

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

Type:

Signal[tuple]

Свойства:

result

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

Методы:

add_progress(value)	Добавляет к текущему прогрессу переданное значение.
cancel()	Отменяет задачу, связанную с обработчиком.
is_canceled()	Проверяем не была ли задача отменена.
is_finished()	Проверяем не завершилась ли задача.
is_running()	Возвращает True если задача сейчас выполняется.
prepare_to_write_changes([description])	Делает индикатор выполнения бесконечным, убирает кнопку отмены и добавляет переданное описание.
progress()	Возвращает текущий прогресс выполнения.
raise_if_canceled()	Если задача была отменена выбрасывает исключение.
set_description(description)	Устанавливаем описание для задачи.
set_max_progress(value)	Устанавливает максимальное значение прогресса.
set_progress(value)	Устанавливает текущий прогресс задачи.
set_window_title(title)	Устанавливает заголовок диалога с прогрессом.

Сигналы:

canceled	Уведомляет, что задача была отменена.
description_changed	Уведомляет о изменении описания задачи.
finished	Уведомляет о завершении выполняемой задачи.
progress_changed	Уведомляет о изменении значения прогресса.
started	Уведомляет о старте выполнения задачи.
window_title_changed	Уведомляет о изменении заголовка диалога отображающего прогресс.

add_progress(value: float)

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

Параметры:

value – Значение, которое будет добавлено к прогрессу.

cancel()

Отменяет задачу, связанную с обработчиком.

Примечание

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

property canceled: Signal

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

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

Signal[]

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

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

property description_changed: Signal

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

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

Signal[str], где str - текущее описание задачи.

property finished: Signal

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

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

Signal[]

is_canceled() → bool

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

is_finished() → bool

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

is_running() → bool

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

prepare_to_write_changes(description: str = '')

Делает индикатор выполнения бесконечным, убирает кнопку отмены и добавляет переданное описание. По умолчанию описание содержит запись о том, что производится запись изменений.

Параметры:

description – Сообщение которое будет отображаться.

progress() → float

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

property progress_changed: Signal

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

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

Signal[float]

raise_if_canceled()

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

property result

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

Результат:

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

set_description(description: str)

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

Параметры:

description – Новое описание задачи.

set_max_progress(value: float)

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

Параметры:

value – Верхний порог для прогресса операции.

set_progress(value: float)

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

Параметры:

value – Новое значение прогресса.

set_window_title(title: str)

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

Параметры:

title – Новый заголовок.

property started: Signal

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

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

Signal[]

property window_title_changed: Signal

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

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

Signal[str]