Правильное место для хранения моего файла signal.py в проекте Django - PullRequest
Новая
       3

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

73 голосов
/ 19 августа 2011

На основании документации 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.

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

С уважением

Ответы [ 8 ]

172 голосов
/ 06 февраля 2014

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

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

Оригинальный ответ, для Django <1.7: </h3> Вы можете зарегистрировать сигналы, импортировав signals.py в файл приложения __init__.py: # __init__.py import signals Это позволит импортировать models.py из signals.py без циклических ошибок импорта. Одна из проблем этого подхода заключается в том, что он испортит результаты покрытия, если вы используете cover.py. Связанное обсуждение Редактировать: Для Django> = 1.7:

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

24 голосов
/ 24 марта 2012

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

5 голосов
/ 08 марта 2012

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

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

4 голосов
/ 12 января 2017

В старых версиях Django было бы неплохо поставить сигналы на __init__.py или, может быть, на models.py (хотя, в конце концов, модели будут слишком большими на мой вкус).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, но для меня это только инженерное дело.Взгляните на Размещение сигналов

3 голосов
/ 19 августа 2011

Я предполагаю, что вы делаете это, чтобы ваши сигналы были зарегистрированы, чтобы они были где-то найдены. Обычно я просто помещаю свои сигналы в файл models.py.

1 голос
/ 21 марта 2012

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

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

0 голосов
/ 14 мая 2019

Это применимо, только если ваши сигналы хранятся в отдельном 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',
    # ...
]
...