Правильне місце для зберігання мого файлу signal.py у проекті Django

На основі документації Django, яку я читав, здається, що signals.pyз папки програми - це гарне місце для початку, але проблема, з якою я стикаюся, полягає в тому, що коли я створюю сигнали для pre_saveі намагаюся імпортувати клас із моделі, він конфліктує з importв моїй моделі.

# models.py

from django.contrib.auth.models import User
from django.db import models
from django.utils.translation import gettext as _
from signals import *

class Comm_Queue(CommunicatorAbstract):
    queue_statuses = (
        ('P', _('Pending')),
        ('S', _('Sent')),
        ('E', _('Error')),
        ('R', _('Rejected')),
    )
    status          = models.CharField(max_length=10, db_index=True, default='P')
    is_html         = models.BooleanField(default=False)
    language        = models.CharField(max_length=6, choices=settings.LANGUAGES)
    sender_email    = models.EmailField()
    recipient_email = models.EmailField()
    subject         = models.CharField(max_length=100)
    content         = models.TextField()

# signals.py

from django.conf import settings
from django.db.models.signals import pre_save
from django.dispatch import receiver
from models import Comm_Queue

@receiver(pre_save, sender=Comm_Queue)
def get_sender_email_from_settings(sender, **kwargs):
    obj=kwargs['instance']
    if not obj.sender_email:
        obj.sender_email='%s' % settings.ADMINS[0][1]

Цей код не буде запущений, оскільки я імпортую Comm_Queueвсередину, signals.pyа також імпортую сигнали всередині models.py.

Хто-небудь може порадити, як я можу перейти до цього питання?

З повагою

Оригінальна відповідь для Django <1,7:

Ви можете зареєструвати сигнали, імпортуючи signals.pyу __init__.pyфайл програми:

# __init__.py
import signals

Це дозволить імпортувати models.pyз signals.pyбез кругових помилок імпорту.

Однією з проблем цього підходу є те, що він псує результати покриття, якщо ви використовуєте покриття.py.

Пов'язана дискусія

Редагувати: для Django> = 1,7:

З моменту введення AppConfig рекомендований спосіб імпорту сигналів є у його init()функції. Докладніше див. У відповіді Еріка Маркоса .

Якщо ви використовуєте Django <= 1,6, я б рекомендував рішення Kamagatos: просто імпортуйте свої сигнали в кінці модуля ваших моделей.

Для майбутніх версій Django (> = 1,7) рекомендованим способом є імпорт модуля сигналів у функцію config ready () програми :

my_app/apps.py

from django.apps import AppConfig

class MyAppConfig(AppConfig):
    name = 'my_app'

    def ready(self):
        import my_app.signals

my_app/__init__.py

default_app_config = 'my_app.apps.MyAppConfig'

Щоб вирішити вашу проблему, вам просто потрібно імпортувати signal.py після визначення вашої моделі. Це все.

Я також розміщую сигнали у файлі signal.py, а також маю цей фрагмент коду, який завантажує всі сигнали:

# import this in url.py file !

import logging

from importlib import import_module

from django.conf import settings

logger = logging.getLogger(__name__)

signal_modules = {}

for app in settings.INSTALLED_APPS:
    signals_module = '%s.signals' % app
    try:
        logger.debug('loading "%s" ..' % signals_module)
        signal_modules[app] = import_module(signals_module)
    except ImportError as e:
        logger.warning(
            'failed to import "%s", reason: %s' % (signals_module, str(e)))

Це для проекту, я не впевнений, чи працює він на рівні програми.

У старих версіях Django було б непогано подавати сигнали на __init__.pyабо, можливо, на models.py(хоча в кінці моделі на мій смак будуть великими).

З Django 1.9, на мою думку, краще розмістити сигнали у signals.pyфайлі та імпортувати їх разом із apps.py, де вони будуть завантажуватися після завантаження моделі.

apps.py:

from django.apps import AppConfig


class PollsConfig(AppConfig):
    name = 'polls'

    def ready(self):
        from . import signals  # NOQA

Ви також можете розділити свої сигнали на signals.pyта handlers.pyв іншій папці вашої моделі signals, але також для мене це більше, ніж інженерія. Погляньте на Розміщення сигналів

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

Це стосується лише тих випадків, коли ваші сигнали signals.pyмістяться в окремому файлі

Цілком погоджуючись з відповіддю @EricMarcos, але слід зазначити, що django docs явно радить не використовувати змінну default_app_config (хоча це не неправильно). Для поточних версій правильним буде такий спосіб:

my_app / apps.py

from django.apps import AppConfig

class MyAppConfig(AppConfig):
    name = 'my_app'

    def ready(self):
        import my_app.signals

settings.py

(Переконайтеся, що у вашому додатку не просто ім’я програми, а натомість відносний шлях до вашого AppConfig)

INSTALLED_APPS = [
    'my_app.apps.MyAppConfig',
    # ...
]

Альтернативою є імпорт функцій зворотного виклику з signals.pyта підключення їх у models.py:

сигнали.py

def pre_save_callback_function(sender, instance, **kwargs):
    # Do stuff here

model.py

# Your imports here
from django.db.models.signals import pre_save
from yourapp.signals import pre_save_callback_function

class YourModel:
    # Model stuff here
pre_save.connect(pre_save_callback_function, sender=YourModel)

Ps: Імпорт YourModelв signals.pyстворить рекурсії; використовувати senderзамість цього.

Ps2: Збереження екземпляра знову у функції зворотного виклику створить рекурсію. Ви можете зробити аргумент управління в .saveметоді, щоб керувати ним.