Де повинні жити обробники сигналів у проекті джанго?

Я щойно почав впроваджувати слухачі сигналів в проект джанго. Поки я розумію, що вони є, і як ними користуватися. Мені важко зрозуміти, куди мені їх поставити. У документації з сайту django написано:

Де повинен жити цей код?

Ви можете розмістити сигнал обробки та реєстраційний код куди завгодно. Однак вам потрібно переконатися, що модуль, який він вводить, рано імпортується, щоб обробка сигналів була зареєстрована перед тим, як будь-які сигнали потрібно надсилати. Це робить models.py вашого додатка гарним місцем для реєстрації обробників сигналів.

Хоча це гарна пропозиція, маючи не модельні класи чи методи в моїх моделях.py, просто протирає мене неправильно.

Тож, яка найкраща практика / правило для зберігання та реєстрації обробників сигналів?

Я насправді люблю робити їх методами самої моделі. Це зберігає все в одному класі, а значить, вам не доведеться турбуватися про імпорт.

Це було додано до документації, коли було випущено Django 1.7 :

Строго кажучи, обробка сигналів та код реєстрації можуть жити де завгодно, хоча рекомендується уникати кореневого модуля програми та модуля його моделей, щоб мінімізувати побічні ефекти імпорту коду.

На практиці обробники сигналів зазвичай визначаються в підмодулі сигналів програми, до якої вони відносяться. Приймачі сигналів підключаються за готовим () методом вашого класу конфігурації програми. Якщо ви використовуєте декоратор приймача (), просто імпортуйте підмодуль сигналів всередині готового ().

Змінено в Django 1.7: Оскільки Ready () не існував у попередніх версіях Django, реєстрація сигналів зазвичай відбувалася в модулі моделей.

Найкраща практика - визначити ваших обробників у handlers.py в підмодулі сигналів, наприклад, у файлі, який виглядає так:

yourapp / signal / handlers.py :

from django.db.models.signals import pre_save
from django.dispatch import receiver
from myapp.models import MyModel

@receiver(pre_save, sender=MyModel)
def my_handler(sender, **kwargs):
    pass

Найкраще місце для реєстрації обробника сигналів - це в AppConfig програми, яка визначає його, використовуючи метод Ready () . Це буде виглядати приблизно так:

yourapp / apps.py :

from django.apps import AppConfig

class TasksConfig(AppConfig):
    name = 'tasks'
    verbose_name = "Tasks"

    def ready(self):
        import yourproject.yourapp.signals.handlers #noqa

Переконайтеся, що ви завантажуєте свій AppConfig, вказавши його безпосередньо в INSTALLED_APPS свого settings.py або в __init__додатку. Для отримання додаткової інформації див. Готову () документацію .

Примітка. Якщо ви надаєте сигнали і для інших додатків для прослуховування, __init__введіть їх у модуль сигналів, наприклад, у файл, який виглядає так:

yourapp / сигнали / __ init__.py

import django.dispatch

task_generate_pre_save = django.dispatch.Signal(providing_args=["task"])

Потім інша програма може прослуховувати ваш сигнал, імпортуючи та реєструючи його, наприклад from yourapp.signals import task_generate_pre_save. Відокремлення сигналів від ваших обробників забезпечує чистоту.

Інструкція для Django 1.6:

Якщо ви все ще застрягли на Django 1.6 або новішої версії, тоді ви зробите те ж саме (визначте ваших обробників у yourapp / signal / handlers.py), але замість того, щоб використовувати AppConfig, ви завантажите обробники через __init__.py з ваш додаток, наприклад щось подібне:

yourapp / __ init__.py

import signals

Це не так приємно, як використання методу Ready (), оскільки це часто викликає кругові проблеми з імпортом.

Я тільки що натрапив на це, і оскільки мої сигнали не пов'язані з моделлю, я подумав, що додам своє рішення.

Я реєструю різні дані навколо входу / виходу та потрібні для підключення django.contrib.auth.signals.

Я помістив обробники сигналів у signals.pyфайл, а потім імпортував сигнали з __init__.pyфайлу модуля, так як я вважаю, що це викликається, як тільки програма запускається (тестування з printзаявою говорить про те, що він викликається ще до того, як файл налаштувань буде прочитаний.)

# /project/__init__.py
import signals

і в signals.py

# /project/signals.py
from django.contrib.auth.signals import user_logged_in

def on_logged_in(sender, user, request, **kwargs):
    print 'User logged in as: \'{0}\''.format(user)

user_logged_in.connect(on_logged_in)

Я досить новачок у Django (/ python), тому я відкритий для всіх, хто скаже мені, що це жахлива ідея!

Я нещодавно прочитав цю статтю про кращі практики, коли мова йде про викладення ваших проектів / додатків, і це дозволяє припустити, що всі ваші власні сигнали диспетчера повинні надходити у файл, який називається signals.py. Однак це не повністю вирішує вашу проблему, оскільки вам все-таки потрібно десь імпортувати їх, і чим раніше вони імпортуються, тим краще.

Пропозиція моделі хороша. Оскільки ви вже визначили все у вашому signals.pyфайлі, воно не повинно займати більше рядка у верхній частині файлу. Це подібно до того, як admin.pyвикладається файл (з визначенням класу вгорі та кодом для реєстрації всіх спеціальних класів адміністратора внизу), якщо ви визначаєте свої сигнали, то з'єднуйте їх у тому самому файлі.

Сподіваюся, що це допомагає! Зрештою, це зводиться до того, що ви віддаєте перевагу.

models.py та signals.py в кожному додатку були рекомендованими місцями для підключення сигналів, однак, на мою думку, вони не найкраще рішення для збереження сигналів та обробників. Диспетчеризація повинна бути причиною сигналів та обробників, винайдених у джанго.

Я довго боровся, і нарешті ми придумали рішення.

створити модуль з'єднувача в папці додатків

тому у нас є:

app/
    __init__.py
    signals.py
    models.py
    connectors.py

у додатку / connectors.py ми визначили обробники сигналів та підключили їх. Наведено приклад:

from signals import example_signal
from models import ExampleModel
from django.db.models.signals import post_save, post_delete

def hanndler(sender, *args, **kwargs):
    pass

post_save.connect(hander, sender=ExampleModel)

то в models.py ми додаємо наступний рядок у кінці файлу:

from app import connector

Тут все зроблено.

Таким чином, ми можемо поставити сигнали в signals.py, а всі обробники в connectors.py. Ніякого безладу в моделях та сигналах.

Сподіваюсь, це забезпечує інше рішення.

Я зберігаю їх в окремому файлі signals.py, In models.pyпісля того, як всі моделі визначені. Я імпортую їх і підключаю моделі до сигналів.

signals.py

#  necessary imports

def send_mail_on_save(<args>):
    # code here 

models.py

# imports
class mymodel(models.Model):
    # model here

# import signals
from signals import send_mail_on_save
# connect them 
post_save.connect(send_mail_on_save,sender=mymodel)

Це дає мені логічне розмежування, звичайно, немає нічого поганого в тому, щоб зберігати їх у models.py , але це більш керовано таким чином.

Сподіваюся, це допомагає !!

Невелике нагадування про AppConfig. Не забудьте встановити:

# yourapp/__init__.py

default_app_config = 'yourapp.apps.RockNRollConfig'