สถานที่ที่เหมาะสมในการเก็บไฟล์ 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โดยไม่มีข้อผิดพลาดในการนำเข้าแบบวงกลม

ปัญหาอย่างหนึ่งของแนวทางนี้คือทำให้ผลลัพธ์ความครอบคลุมยุ่งเหยิงหากคุณใช้ 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'

ในการแก้ปัญหาของคุณคุณต้องนำเข้า 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:

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วิธีการเพื่อควบคุมได้