将我的signals.py文件保留在Django项目中的正确位置

根据我正在阅读的Django文档，似乎signals.py在app文件夹中是一个不错的起点，但是我面临的问题是，当我为创建信号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而不会出现循环导入错误。

这种方法的一个问题是，如果您使用coverage.py，它会弄乱覆盖率结果。

相关讨论

编辑：对于Django> = 1.7：

自从引入AppConfig以来，推荐的信号导入方式是其init()功能。有关更多详细信息，请参见 Eric Marcos的答案。

如果您使用的是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'

要解决您的问题，您只需在模型定义之后导入signals.py。就这样。

我也将信号放在signals.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文档明确建议不要使用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：

signal.py

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

模型

# 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方法中创建一个控制参数来控制它。