Сигналы

Wagtail’s PageRevision и Page реализуют Сигналы из django.dispatch. Сигналы полезны для создания побочных эффектов из событий публикации/снятия с публикации страницы.

Например, вы можете использовать сигналы для отправки уведомлений о публикации в службу обмена сообщениями или POST сообщения в другое приложение, использующее API, например, генератор статического сайта.

`page_published`

Этот сигнал испускается из PageRevision при установке пересмотра в published.

Для прослушивания сигнала реализуйте page_published.connect(receiver, sender, **kwargs). Вот простой пример того, как вы можете уведомить свою команду о публикации:

from wagtail.signals import page_published
import requests


# Let everyone know when a new page is published
def send_to_slack(sender, **kwargs):
    instance = kwargs['instance']
    url = 'https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX'
    values = {
        "text" : "%s was published by %s " % (instance.title, instance.owner.username),
        "channel": "#publish-notifications",
        "username": "the squid of content",
        "icon_emoji": ":octopus:"
    }

    response = requests.post(url, values)

# Register a receiver
page_published.connect(send_to_slack)

Получение конкретных событий модели

Иногда вы не заинтересованы в получении сигналов для каждой модели или хотите обрабатывать сигналы для конкретных моделей по-разному. Например, вы можете что-то сделать, когда публикуется новая статья блога:

from wagtail.signals import page_published
from mysite.models import BlogPostPage

# Do something clever for each model type
def receiver(sender, **kwargs):
    # Do something with blog posts
    pass

# Register listeners for each page model class
page_published.connect(receiver, sender=BlogPostPage)

Wagtail предоставляет доступ к списку зарегистрированных типов страниц через функцию get_page_models() в wagtail.models.

Дополнительную информацию об указании отправителей см. в документации Django.

`page_unpublished`

Этот сигнал испускается из Page при снятии страницы с публикации.

`pre_page_move` и `post_page_move`

Эти сигналы испускаются из Page непосредственно перед и после перемещения.

Подпишитесь на pre_page_move, если вам необходимо узнать значения ДО применения каких-либо изменений в базе данных. Например: Получение предыдущего URL страницы или её потомков.

Подпишитесь на post_page_move, если вам нужно узнать значения ПОСЛЕ применения изменений в базе данных. Например: Получение нового URL страницы или её потомков.

Для обоих сигналов передаются следующие аргументы:

Различие между «перемещением» и «переупорядочиванием»

Сигнал может быть испущен в результате перемещения страницы в другой раздел («перемещение») или в результате перемещения страницы в другое положение в том же разделе («переупорядочивание»). Знание разницы между этими двумя случаями может быть особенно полезным, так как только «перемещение» влияет на URL страницы (и её потомков), а «переупорядочивание» влияет только на естественный порядок страниц; что, вероятно, менее важно.

Лучший способ отличить «перемещение» от «переупорядочивания» — сравнить значения url_path_before и url_path_after. Например:

from wagtail.signals import pre_page_move
from wagtail.contrib.frontend_cache.utils import purge_page_from_cache

# Clear a page's old URLs from the cache when it moves to a different section
def clear_page_url_from_cache_on_move(sender, **kwargs):

    if kwargs['url_path_before'] == kwargs['url_path_after']:
        # No URLs are changing :) nothing to do here!
        return

    # The page is moving to a new section (possibly even a new site)
    # so clear old URL(s) from the cache
    purge_page_from_cache(kwargs['instance'])

# Register a receiver
pre_page_move.connect(clear_old_page_urls_from_cache)

`page_slug_changed`

Этот сигнал испускается из Page при публикации изменения в её URL-фрагменте.

Следующие аргументы испускаются этим сигналом:

workflow_submitted

Этот сигнал испускается из WorkflowState при отправке страницы в рабочий процесс.

workflow_rejected

Этот сигнал испускается из WorkflowState при отклонении страницы из рабочего процесса.

workflow_approved

Этот сигнал испускается из WorkflowState при успешном завершении рабочего процесса страницы.

workflow_cancelled

Этот сигнал испускается из WorkflowState при отмене рабочего процесса страницы.

task_submitted

Этот сигнал испускается из TaskState при отправке страницы на задачу.

task_rejected

Этот сигнал испускается из TaskState при отклонении страницы из задачи.

task_approved

Этот сигнал испускается из TaskState при одобрении задачи страницы.

task_cancelled

Этот сигнал испускается из TaskState при отмене задачи страницы.