Декоратор задач¶

task(*, priority=0, queue_name='default', backend='default', takes_context=False)¶

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

• priority: устанавливает priority Task. По умолчанию 0.

• queue_name: устанавливает queue_name Task. По умолчанию установлено значение «по умолчанию».

• backend: устанавливает backend Task. По умолчанию установлено значение «по умолчанию».

• takes_context: контролирует, принимает ли функция Task TaskContext. По умолчанию установлено значение «False». Подробности смотрите в Контексте задачи.

Если определенная Task недействительна в соответствии с серверной частью, вызывается InvalidTask.

См. примеры использования в разделе «Определение задач <defining-tasks>».

Задание¶

class Task¶

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

Атрибуты «Задачи» не могут быть изменены. Подробности см. в разделе изменение задач.

priority¶

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

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

backend¶

Псевдоним серверной части «Задачи» должен быть поставлен в очередь. Это должно соответствовать серверной части, определенной в BACKEND.

queue_name¶

Имя очереди, в которую будет поставлена ​​задача. По умолчанию установлено значение «по умолчанию». Это должно соответствовать очереди, определенной в QUEUES, если только QUEUES не установлен в [].

run_after¶

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

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

name¶

Имя функции, дополненное task(). Это имя не обязательно уникально.

using(*, priority=None, backend=None, queue_name=None, run_after=None)¶

Создает новую «Задачу» с измененными настройками по умолчанию. Существующая Задача остается без изменений.

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

• priority

• backend

• queue_name

• run_after

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

enqueue(*args, **kwargs)¶

Ставит задачу в очередь на серверную часть задачи для последующего выполнения.

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

Если Task недействителен в соответствии с серверной частью, вызывается InvalidTask.

См. примеры использования в разделе «Задачи постановки в очередь <enqueueing-tasks>».

aenqueue(*args, **kwargs)¶

async вариант enqueue.

get_result(result_id)¶

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

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

aget_result(*args, **kwargs)¶

асинхронный вариант get_result.

Ошибки задачи¶

class TaskError¶

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

traceback¶

Обратная трассировка (в виде строки) из возникшего исключения в случае сбоя Задачи.

exception_class¶

Класс исключения, возникающий при выполнении задачи.

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

class BaseTaskBackend¶

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

options¶

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

enqueue(task, args, kwargs)¶

Серверные части задач, подкласс которых BaseTaskBackend должны реализовывать этот метод как минимум.

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

aenqueue(task, args, kwargs)¶

Асинхронный вариант BaseTaskBackend.enqueue().

get_result(result_id)¶

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

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

aget_result(result_id)¶

Асинхронный вариант BaseTaskBackend.get_result().

validate_task(task)¶

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

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

Django включает в себя только серверную часть разработки и тестирования. Они поддерживают локальное выполнение и проверку. Готовые к работе серверные части см. в разделе Настройка серверной части задачи.