Сигналы

Список всех сигналов, которые отправляет Django. Все встроенные сигналы отправляются с помощью метода send().

Сигналы модели

Модуль django.db.models.signals определяет набор сигналов, отправляемых системой модели.

pre_init

django.db.models.signals.pre_init

Всякий раз, когда вы создаёте экземпляр модели Django, этот сигнал отправляется в начале метода __init__() модели.

Аргументы, отправленные с этим сигналом:

sender

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

args

Список позиционных аргументов, переданных в __init__().

kwargs

Словарь ключевых аргументов, переданных в __init__().

Например, в учебнике есть такая строка:

q = Question(question_text="What's new?", pub_date=timezone.now())

Аргументы, отправленные обработчику pre_init, были бы такими:

post_init

django.db.models.signals.post_init

Как и pre_init, но этот сигнал отправляется после завершения метода __init__().

Аргументы, отправленные с этим сигналом:

sender

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

instance

Фактический экземпляр модели, который только что был создан.

Примечание

instance._state не задаётся до отправки сигнала post_init, поэтому атрибуты _state всегда имеют свои значения по умолчанию. Например, _state.db является None.

pre_save

django.db.models.signals.pre_save

Отправляется в начале метода save() модели.

Аргументы, отправленные с этим сигналом:

sender

Класс модели.

instance

Фактический экземпляр, который сохраняется.

raw

Булево значение; True если модель сохраняется точно как представлено (например, при загрузке фикстуры). Не следует выполнять запросы/изменять другие записи в базе данных, так как база данных может ещё не находиться в согласованном состоянии.

using

Используемый алиас базы данных.

update_fields

Набор полей для обновления, переданных в Model.save(), или None если update_fields не был передан в save().

post_save

django.db.models.signals.post_save

Как pre_save, но отправляется в конце метода save().

Аргументы, отправленные с этим сигналом:

sender

Класс модели.

instance

Фактический экземпляр, который сохраняется.

created

Булево значение; True если была создана новая запись.

raw

Булево значение; True если модель сохраняется точно как представлено (например, при загрузке фикстуры). Не следует выполнять запросы/изменять другие записи в базе данных, так как база данных может ещё не находиться в согласованном состоянии.

using

Используемый алиас базы данных.

update_fields

Набор полей для обновления, переданных в Model.save(), или None если update_fields не был передан в save().

pre_delete

django.db.models.signals.pre_delete

Отправляется в начале метода delete() модели и метода delete() набора результатов запроса.

Аргументы, отправленные с этим сигналом:

sender

Класс модели.

instance

Фактический экземпляр, который удаляется.

using

Используемый алиас базы данных.

origin

Добавлено в Django 4.1.

Источник удаления, экземпляр класса Model или QuerySet.

post_delete

django.db.models.signals.post_delete

Как pre_delete, но отправляется в конце метода delete() модели и метода delete() набора результатов запроса.

Аргументы, отправленные с этим сигналом:

sender

Класс модели.

instance

Фактический экземпляр, который удаляется.

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

using

Используемый алиас базы данных.

origin

Добавлено в Django 4.1.

Источник удаления, экземпляр класса Model или QuerySet.

m2m_changed

django.db.models.signals.m2m_changed

Отправляется при изменении ManyToManyField на экземпляре модели. Строго говоря, это не сигнал модели, так как он отправляется ManyToManyField, но поскольку он дополняет pre_save/post_save и pre_delete/post_delete при отслеживании изменений моделей, он включён сюда.

Аргументы, отправленные с этим сигналом:

sender

Класс промежуточной модели, описывающей ManyToManyField. Этот класс автоматически создаётся при определении поля "многие ко многим"; вы можете получить к нему доступ, используя атрибут through у поля "многие ко многим".

instance

Экземпляр, чья связь "многие ко многим" обновляется. Это может быть экземпляр sender, или класса, к которому относится ManyToManyField.

action

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

"pre_add"

Отправляется перед добавлением одного или нескольких объектов в связь.

"post_add"

Отправляется после добавления одного или нескольких объектов в связь.

"pre_remove"

Отправляется перед удалением одного или нескольких объектов из связи.

"post_remove"

Отправляется после удаления одного или нескольких объектов из связи.

"pre_clear"

Отправляется перед очисткой связи.

"post_clear"

Отправляется после очистки связи.

reverse

Указывает, какая сторона связи обновляется (т.е., если модифицируется прямая или обратная связь).

model

Класс объектов, которые добавляются, удаляются или очищаются из связи.

pk_set

Для действий pre_add и post_add, это набор значений первичных ключей, которые будут или уже были добавлены в связь. Это может быть подмножество значений, отправленных для добавления, так как вставки должны отфильтровывать существующие значения, чтобы избежать баз данных IntegrityError.

Для действий pre_remove и post_remove, это набор значений первичных ключей, которые были отправлены для удаления из связи. Это не зависит от того, будут ли значения фактически удалены или нет. В частности, могут быть отправлены несуществующие значения, и они появятся в pk_set, даже если они не оказывают влияния на базу данных.

Для действий pre_clear и post_clear, это None.

using

Используемый псевдоним базы данных.

Например, если у Pizza может быть несколько объектов Topping, смоделированных так:

class Topping(models.Model):
    # ...
    pass

class Pizza(models.Model):
    # ...
    toppings = models.ManyToManyField(Topping)

Если мы подключим обработчик так:

from django.db.models.signals import m2m_changed

def toppings_changed(sender, **kwargs):
    # Do something
    pass

m2m_changed.connect(toppings_changed, sender=Pizza.toppings.through)

и затем сделаем что-то вроде этого:

>>> p = Pizza.objects.create(...)
>>> t = Topping.objects.create(...)
>>> p.toppings.add(t)

аргументы, отправленные обработчику m2m_changed (toppings_changed в примере выше), будут такими:

И если мы затем сделаем что-то вроде этого:

>>> t.pizza_set.remove(p)

аргументы, отправленные обработчику m2m_changed, будут:

class_prepared

django.db.models.signals.class_prepared

Отправляется всякий раз, когда класс модели «подготовлен» — то есть, когда модель определена и зарегистрирована в системе моделей Django. Django использует этот сигнал внутри; он обычно не используется в сторонних приложениях.

Поскольку этот сигнал отправляется во время процесса заполнения реестра приложений, и AppConfig.ready() выполняется после полного заполнения реестра приложений, получатели не могут быть подключены в этом методе. Одним из возможных вариантов является подключение их AppConfig.__init__() вместо, позаботившись о том, чтобы не импортировать модели или не вызывать вызовы реестра приложений.

Аргументы, которые отправляются с этим сигналом:

sender

Класс модели, которая только что была подготовлена.

Сигналы управления

Сигналы, отправленные командой django-admin.

pre_migrate

django.db.models.signals.pre_migrate

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

Аргументы, отправленные с этим сигналом:

sender

Экземпляр AppConfig для приложения, которое собирается импортировать/синхронизировать.

app_config

То же, что и sender.

verbosity

Указывает, сколько информации manage.py печатает на экране. Подробности см. в флаге --verbosity.

Функции, которые слушают pre_migrate, должны изменять вывод на экран в зависимости от значения этого аргумента.

interactive

Если interactive равно True, можно безопасно запросить у пользователя ввод с командной строки. Если interactive равно False, функции, которые слушают этот сигнал, не должны пытаться запросить ничего.

Например, приложение django.contrib.auth запрашивает создание суперпользователя только тогда, когда interactive равно True.

stdout

В Django 4.0.

Поток-подобный объект, куда нужно перенаправить подробный вывод.

using

Псевдоним базы данных, на которой будет работать команда.

plan

План миграции, который будет использован для выполнения миграции. Хотя план не является общедоступным API, это позволяет в редких случаях, когда необходимо знать план. План — это список пар кортежей, где первый элемент — экземпляр класса миграции, а второй — показывает, была ли миграция отката (True) или применена (False).

apps

Экземпляр Apps содержащий состояние проекта до выполнения миграции. Его следует использовать вместо глобального реестра apps, чтобы получить модели, на которых нужно выполнить операции.

post_migrate

django.db.models.signals.post_migrate

Отправляется в конце команд migrate (даже если миграции не выполняются) и flush. Она не отправляется для приложений, у которых отсутствует модуль models.

Обработчики этого сигнала не должны выполнять изменения схемы базы данных, так как это может привести к ошибке команды flush, если она выполняется во время команды migrate.

Аргументы, отправляемые с этим сигналом:

sender

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

app_config

То же, что и sender.

verbosity

Указывает, сколько информации manage.py выводит на экран. Подробности см. в флаге --verbosity.

Функции, которые слушают сигнал post_migrate, должны изменять вывод на экран в зависимости от значения этого аргумента.

interactive

Если interactive равно True, можно безопасно запросить у пользователя ввод с командной строки. Если interactive равно False, функции, которые слушают этот сигнал, не должны пытаться запросить ввод.

Например, приложение django.contrib.auth запрашивает создание суперпользователя только тогда, когда interactive равно True.

stdout

Добавлена в Django 4.0.

Потокоподобный объект, в который следует перенаправлять подробный вывод.

using

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

plan

План миграций, который использовался для выполнения миграции. Хотя план не является общедоступным API, это позволяет в редких случаях узнать план. План представляет собой список пар кортежей, где первый элемент — экземпляр класса миграции, а второй — показывает, была ли миграция отменена (True) или применена (False).

apps

Экземпляр Apps, содержащий состояние проекта после выполнения миграции. Его следует использовать вместо глобальной регистрации apps для извлечения моделей, на которых необходимо выполнить операции.

Например, вы можете зарегистрировать обратный вызов в AppConfig следующим образом:

from django.apps import AppConfig
from django.db.models.signals import post_migrate

def my_callback(sender, **kwargs):
    # Your specific logic here
    pass

class MyAppConfig(AppConfig):
    ...

    def ready(self):
        post_migrate.connect(my_callback, sender=self)

Сигналы запроса/ответа

Сигналы, отправляемые ядром фреймворка при обработке запроса.

request_started

django.core.signals.request_started

Отправляется, когда Django начинает обрабатывать HTTP-запрос.

Аргументы, отправляемые с этим сигналом:

sender

Класс обработчика – например, django.core.handlers.wsgi.WsgiHandler – который обработал запрос.

environ

Словарь environ, предоставленный для запроса.

request_finished

django.core.signals.request_finished

Отправляется, когда Django завершает передачу HTTP-ответа клиенту.

Аргументы, отправляемые с этим сигналом:

sender

Класс обработчика, как указано выше.

got_request_exception

django.core.signals.got_request_exception

Этот сигнал отправляется всякий раз, когда Django обнаруживает исключение при обработке входящего HTTP-запроса.

Аргументы, отправляемые с этим сигналом:

sender

Не используется (всегда None).

request

Объект HttpRequest.

Сигналы для тестов

Сигналы, отправляемые только при выполнении тестов.

setting_changed

django.test.signals.setting_changed

Этот сигнал отправляется при изменении значения настройки через менеджер контекста django.test.TestCase.settings() или декоратор/менеджер контекста django.test.override_settings().

На самом деле он отправляется дважды: при применении нового значения («настройка») и при восстановлении исходного значения («разборка»). Используйте аргумент enter для различения этих двух случаев.

Вы также можете импортировать этот сигнал из django.core.signals для избежания импорта из django.test в ситуациях, не связанных с тестированием.

Аргументы, отправляемые с этим сигналом:

sender

Обработчик настроек.

setting

Имя настройки.

value

Значение настройки после изменения. Для настроек, которые изначально не существуют, в фазе «разборка» значение value равно None.

enter

Булево значение; True если настройка применена, False если восстановлена.

template_rendered

django.test.signals.template_rendered

Отправляется при отрисовке шаблона в системе тестирования. Этот сигнал не отправляется во время обычной работы сервера Django – он доступен только во время тестирования.

Аргументы, отправляемые с этим сигналом:

sender

Объект Template, который был отрисован.

template

То же, что и отправитель

context

Контекст Context, с помощью которого был отрисован шаблон.

Оборачиватели баз данных

Сигналы, отправляемые оборачивателем базы данных при инициализации подключения к базе данных.

connection_created

django.db.backends.signals.connection_created

Отправляется, когда оборачиватель базы данных устанавливает начальное подключение к базе данных. Это особенно полезно, если вы хотите отправить любые команды после подключения к SQL-бекенду.

Аргументы, отправляемые с этим сигналом:

sender

Класс оборачивателя базы данных – например, django.db.backends.postgresql.DatabaseWrapper или django.db.backends.mysql.DatabaseWrapper, и т.д.

connection

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