Задачи

Декоратор task

task(*, priority=0, queue_name='default', backend='default', takes_context=False) [источник]

Декоратор @task определяет экземпляр Task. Он принимает следующие необязательные аргументы:

• priority: задаёт priority объекта Task. По умолчанию равно 0.
• queue_name: задаёт queue_name объекта Task. По умолчанию равно "default".
• backend: задаёт backend объекта Task. По умолчанию равно "default".
• takes_context: определяет, принимает ли функция Task аргумент TaskContext. По умолчанию равно False. Подробности см. в разделе Контекст задачи.

Если определённый объект Task недопустим для бэкенда, вызывается исключение InvalidTask.

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

Task

class Task [источник]

Представляет задачу, выполняемую в фоновом режиме. Задачи следует определять с помощью декоратора task().

Атрибуты объекта Task нельзя изменять. Подробности см. в разделе изменение задач.

priority

Приоритет объекта Task. Приоритет должен находиться в диапазоне от -100 до 100. Чем больше число, тем выше приоритет и тем раньше будет выполнена задача.

Чтобы использовать эту возможность, атрибут supports_priority бэкенда должен иметь значение True.

backend

Псевдоним бэкенда, в очередь которого следует добавить объект Task. Он должен соответствовать бэкенду, определённому в BACKEND.

queue_name

Имя очереди, в которую будет добавлен объект Task. По умолчанию равно "default". Оно должно соответствовать очереди, определённой в QUEUES, если только для QUEUES не задано значение [].

run_after

Самое раннее время выполнения объекта Task. Это может быть timedelta, отсчитываемое от текущего времени, объект datetime с часовым поясом или None, если ограничение не задано. По умолчанию равно None.

Чтобы использовать эту возможность, атрибут supports_defer бэкенда должен иметь значение True. В противном случае вызывается исключение InvalidTask.

name [источник]

Имя функции, декорированной с помощью task(). Это имя не обязательно должно быть уникальным.

using(*, priority=None, backend=None, queue_name=None, run_after=None) [источник]

Создаёт новый объект Task с изменёнными значениями по умолчанию. Существующий объект Task остаётся без изменений.

using позволяет изменять следующие атрибуты:

• priority
• backend
• queue_name
• run_after

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

enqueue(*args, **kwargs) [источник]

Добавляет объект Task в очередь бэкенда Task для последующего выполнения.

Аргументы передаются функции объекта Task после цикла сериализации и десериализации с помощью json.dumps()/json.loads(). Поэтому все аргументы должны быть сериализуемы в JSON, а их типы должны сохраняться после такого преобразования.

Если объект Task недопустим для бэкенда, вызывается исключение InvalidTask.

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

aenqueue(*args, **kwargs)

Асинхронный вариант метода enqueue — async.

get_result(result_id) [источник]

Получает результат по его идентификатору.

Если результат не существует, вызывается исключение TaskResultDoesNotExist. Если результат имеет тип, отличный от типа текущей задачи, вызывается исключение TaskResultMismatch. Если бэкенд не поддерживает get_result(), вызывается исключение NotImplementedError.

aget_result(*args, **kwargs)

Асинхронный вариант метода get_result — async.

Ошибки задач

class TaskError

Содержит информацию об ошибке, возникшей при выполнении объекта Task.

traceback

Трассировка стека (в виде строки) возникшего исключения, из-за которого завершилось с ошибкой выполнение объекта Task.

exception_class

Класс исключения, возникшего при выполнении объекта Task.

Базовый бэкенд

class BaseTaskBackend [источник]

BaseTaskBackend — родительский класс для всех бэкендов задач.

options

Словарь дополнительных параметров бэкенда задач. Они задаются с помощью настройки OPTIONS.

enqueue(task, args, kwargs) [источник]

Бэкенды задач, наследующие BaseTaskBackend, должны как минимум реализовать этот метод.

После реализации enqueue() добавляет объект task — экземпляр Task — в очередь для последующего выполнения. args — это позиционные аргументы, а kwargs — именованные аргументы, передаваемые объекту task. Возвращает экземпляр TaskResult.

aenqueue(task, args, kwargs)

Асинхронный вариант метода BaseTaskBackend.enqueue() — async.

get_result(result_id) [источник]

Получает результат по его идентификатору. Если результат не существует, вызывается исключение TaskResultDoesNotExist.

Если бэкенд не поддерживает get_result(), вызывается исключение NotImplementedError.

aget_result(result_id)

Асинхронный вариант метода BaseTaskBackend.get_result() — async.

validate_task(task) [источник]

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

Доступные бэкенды