Сигналы

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

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

page_published

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

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

from wagtail.core.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.core.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.core.models.

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

page_unpublished

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

pre_page_move и post_page_move

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

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

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

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

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

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

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

from wagtail.core.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 при публикации изменений в его slug.

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

workflow_submitted

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

workflow_rejected

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

workflow_approved

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

workflow_cancelled

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

task_submitted

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

task_rejected

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

task_approved

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

task_cancelled

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