Правильное место, чтобы сохранить файл 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.

Может ли кто-нибудь посоветовать, как я могу это решить?

С уважением

Ответы

Ответ 1

Оригинальный ответ, для Джанго <1.7:

Вы можете зарегистрировать сигналы, импортировав signals.py в файл приложения __init__.py:

# __init__.py
import signals

Это позволит импортировать models.py из signals.py без циклических ошибок импорта.

Одна из проблем этого подхода заключается в том, что он испортит результаты покрытия, если вы используете cover.py.

Связанное обсуждение

Редактировать: Для Джанго> = 1.7:

Поскольку был представлен AppConfig, рекомендуемый способ импорта сигналов заключается в его функции init(). См. Ответ Эрика Маркоса для более подробной информации.

Ответ 2

Если вы используете Django <= 1.6, я бы рекомендовал решение Kamagatos: просто импортируйте свои сигналы в конце вашего модуля моделей.

Для будущих версий Django ( >= 1.7) способ рекомендуется импортировать ваш модуль сигналов в конфигурацию вашего приложения 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'

Ответ 3

Чтобы решить вашу проблему, вам просто нужно импортировать signal.py после определения модели. Все это.

Ответ 4

Я также помещаю сигналы в файл 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)))

Это для проекта, я не уверен, работает ли он на уровне приложения.

Ответ 5

В старых версиях 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, но для меня это просто над инженерной. Взгляните на Размещение сигналов

Ответ 6

Я предполагаю, что вы делаете это, чтобы ваши сигналы регистрировались, чтобы их где-то нашли. Я просто правильно передал свои сигналы в файле models.py.

Ответ 7

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

signals.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 для его управления.

Ответ 8

Полностью согласен с ответом @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',
    # ...
]