Сигналы

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

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

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

pre_init

django.db.models.signals.pre_init

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

Передаваемые аргументы:

sender

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

args

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

kwargs

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

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

p = Poll(question="What's up?", pub_date=datetime.now())

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

post_init

django.db.models.signals.post_init

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

Передаваемые аргументы:

sender

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

instance

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

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

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

post_delete

django.db.models.signals.post_delete

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

Передаваемые аргументы:

sender

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

instance

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

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

using

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

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, pre_remove и post_remove, это множество значений первичных ключей, которые были добавлены в или удалены из связи.

Для действий 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.

using

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

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.

using

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

Например, вы можете зарегистрировать обработчик в 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

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

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

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