Сигналы

Подписка на сигналы

Для подписки на сигнал можно использовать метод connect() сигнала. Первый аргумент — функция, которая должна быть вызвана при возникновении сигнала, необязательный второй аргумент указывает отправителя. Чтобы отписаться от сигнала, можно использовать метод disconnect().

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

Например, вот вспомогательный менеджер контекста, который можно использовать в тесте для определения отображённых шаблонов и переменных, переданных в шаблон:

from flask import template_rendered
from contextlib import contextmanager

@contextmanager
def captured_templates(app):
    recorded = []
    def record(sender, template, context, **extra):
        recorded.append((template, context))
    template_rendered.connect(record, app)
    try:
        yield recorded
    finally:
        template_rendered.disconnect(record, app)

Теперь это легко можно использовать с клиентом для тестов:

with captured_templates(app) as templates:
    rv = app.test_client().get('/')
    assert rv.status_code == 200
    assert len(templates) == 1
    template, context = templates[0]
    assert template.name == 'index.html'
    assert len(context['items']) == 10

Не забудьте подписаться с дополнительным **extra аргументом, чтобы ваши вызовы не давали сбоев, если Flask добавит новые аргументы в сигналы.

Всё отображение шаблонов в коде, выпущенном приложением app в теле блока with теперь будет записано в переменной templates. Всякий раз, когда шаблон отображается, объект шаблона и контекст добавляются в него.

Кроме того, есть удобный вспомогательный метод (connected_to()), который позволяет временно подписать функцию на сигнал с помощью менеджера контекста. Поскольку возвращаемое значение менеджера контекста не может быть указано таким образом, вам нужно передать список в качестве аргумента:

from flask import template_rendered

def captured_templates(app, recorded, **extra):
    def record(sender, template, context):
        recorded.append((template, context))
    return template_rendered.connected_to(record, app)

Пример выше тогда будет выглядеть так:

templates = []
with captured_templates(app, templates, **extra):
    ...
    template, context = templates[0]

Создание сигналов

Если вы хотите использовать сигналы в собственном приложении, вы можете напрямую использовать библиотеку blinker. Наиболее распространённый случай — именованные сигналы в пользовательском Namespace.. Это то, что рекомендуется чаще всего:

from blinker import Namespace
my_signals = Namespace()

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

model_saved = my_signals.signal('model-saved')

Имя сигнала делает его уникальным и упрощает отладку. Вы можете получить имя сигнала с помощью атрибута name.

Отправка сигналов

Если вы хотите сгенерировать сигнал, вы можете сделать это, вызвав метод send(). Он принимает отправителя в качестве первого аргумента и необязательно некоторые ключевые аргументы, которые передаются подписчикам сигнала:

class Model(object):
    ...

    def save(self):
        model_saved.send(self)

Старайтесь всегда выбирать подходящего отправителя. Если у вас есть класс, который отправляет сигнал, передайте self в качестве отправителя. Если вы отправляете сигнал из произвольной функции, можете передать current_app._get_current_object() в качестве отправителя.

Сигналы и контекст запроса Flask

Сигналы полностью поддерживают Контекст запроса при получении сигналов. Локальные переменные контекста последовательно доступны между request_started и request_finished, поэтому вы можете полагаться на flask.g и другие по мере необходимости. Обратите внимание на ограничения, описанные в Отправка сигналов и сигнале request_tearing_down.

Подписка на сигналы с использованием декораторов

С Blinker 1.1 вы также можете легко подписываться на сигналы, используя новый декоратор connect_via():

from flask import template_rendered

@template_rendered.connect_via(app)
def when_template_rendered(sender, template, context, **extra):
    print(f'Template {template.name} is rendered with {context}')

Встроенные сигналы

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