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

时间:2011-08-18 22:53:23

标签: django django-signals

根据我正在阅读的Django文档,似乎app文件夹中的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内导入了信号。

有人可以就如何解决这个问题提出建议吗?

此致

7 个答案:

答案 0 :(得分:170)

如果您使用的是Django< = 1.6,我建议使用Kamagatos解决方案:只需在模型模块的末尾导入信号。

对于Django的未来版本(> = 1.7),recommended方式是在应用程序的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'

答案 1 :(得分:24)

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

答案 2 :(得分:5)

我还将信号放在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)))

这是针对项目的,我不确定它是否适用于应用级别。

答案 3 :(得分:4)

在旧的Django版本中可以将信号放在__init__.pymodels.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.pyhandlers.py上的信号划分到名为signals的模型中的另一个文件夹中,但对于我来说,这只是过度工程化。看看Placing Signals

答案 4 :(得分:3)

我猜你正在这样做,所以你的信号已被注册,以便在某处找到它们。我只是正确地将我的信号放在models.py文件中。

答案 5 :(得分:1)

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

答案 6 :(得分:0)

这仅适用于将信号保存在单独的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',
    # ...
]