Sinyal işleyicileri bir django projesinde nerede yaşamalıdır?

Bir django projesinde sinyal dinleyicileri uygulamaya başladım. Ben ne olduklarını ve nasıl kullanılacağını anladım. Onları nereye koymam gerektiğini anlamakta zorlanıyorum. Django sitesindeki belgeler şunları söylemektedir:

Bu kod nerede yaşamalıdır?

Sinyal işleme ve kayıt kodunu istediğiniz yere koyabilirsiniz. Ancak, içinde bulunan modülün erken alındığından emin olmanız gerekir, böylece herhangi bir sinyal gönderilmeden önce sinyal işleme kaydedilir. Bu, uygulamanızın models.py'sini sinyal işleyicilerinin kaydını koymak için iyi bir yer yapar.

Modellerimde model olmayan sınıflara veya yöntemlere sahip olmak iyi bir öneri olsa da, sadece bana yanlış bir şekilde ovalar.

Peki, sinyal işleyicilerini saklamak ve kaydetmek için en iyi uygulama / kural nedir?

Aslında onları modelin kendi sınıf yöntemlerini yapmaktan hoşlanıyorum. Bu, her şeyi tek bir sınıfta tutar ve hiçbir şey içe aktarma konusunda endişelenmenize gerek olmadığı anlamına gelir.

Bu, Django 1.7 piyasaya çıktığında belgelere eklendi :

Kesin olarak, sinyal işleme ve kayıt kodu istediğiniz yerde yaşayabilir, ancak kodun içe aktarılmasının yan etkilerini en aza indirmek için uygulamanın kök modülünden ve model modülünden kaçınmanız önerilir.

Pratikte, sinyal işleyiciler genellikle ilişkili oldukları uygulamanın bir sinyal alt modülünde tanımlanır. Sinyal alıcıları, uygulama yapılandırma sınıfınızın ready () yöntemine bağlanır. Receiver () dekoratörünü kullanıyorsanız, ready () içindeki sinyaller alt modülünü içe aktarmanız yeterlidir.

Django 1.7'de değiştirildi: Django'nun önceki sürümlerinde ready () bulunmadığından, sinyal kaydı genellikle modeller modülünde gerçekleşti.

En iyi uygulama, işleyicilerinizi handlers.py dosyasında sinyaller alt modülünde, örneğin şuna benzer bir dosya olarak tanımlamaktır:

yourapp / signal / handlers.py :

from django.db.models.signals import pre_save
from django.dispatch import receiver
from myapp.models import MyModel

@receiver(pre_save, sender=MyModel)
def my_handler(sender, **kwargs):
    pass

Sinyal işleyicinizi kaydetmek için en iyi yer, hazır () kullanarak uygulamayı tanımlayan uygulamanın AppConfig dosyasındadır. yöntemini . Bu şöyle görünecektir:

yourapp / apps.py :

from django.apps import AppConfig

class TasksConfig(AppConfig):
    name = 'tasks'
    verbose_name = "Tasks"

    def ready(self):
        import yourproject.yourapp.signals.handlers #noqa

Doğrudan ayarlarınızda veya __init__uygulamanızda INSTALLED_APPS ayarında belirterek AppConfig'nizi yüklediğinizden emin olun . Daha fazla bilgi için hazır () belgelerine bakın.

Not: Diğer uygulamaların da dinlemesi için sinyal sağlıyorsanız, bunları __init__sinyal modülünüze, örneğin aşağıdaki gibi bir dosyaya yerleştirin:

YourApp / sinyaller / __ init__.py

import django.dispatch

task_generate_pre_save = django.dispatch.Signal(providing_args=["task"])

Daha sonra başka bir uygulama sinyalinizi içe aktararak ve kaydederek dinleyebilir, örn from yourapp.signals import task_generate_pre_save. Sinyallerinizi işleyicilerinizden ayırmak işleri temiz tutar.

Django 1.6 için talimatlar:

Hala Django 1.6 veya daha düşük bir sürümde kalıyorsanız, aynı şeyi yaparsınız (işleyicilerinizi yourapp / signal / handlers.py'de tanımlayın), ancak AppConfig kullanmak yerine, işleyicileri __init__.py üzerinden yüklersiniz. uygulamanız, örneğin:

YourApp / __ init__.py

import signals

Bu, genellikle dairesel içe aktarma sorunlarına neden olduğu için ready () yöntemini kullanmak kadar hoş değildir.

Sadece bununla karşılaştım ve sinyallerim modelle ilgili olmadığından çözümümü ekleyeceğimi düşündüm.

Ben giriş / çıkış etrafında çeşitli veri giriş ve içine kanca gerekiyordu django.contrib.auth.signals.

Sinyal işleyicilerini bir signals.pydosyaya koydum ve sonra __init__.pymodül dosyasından sinyalleri aldım , çünkü uygulama başlar başlamaz bu çağrıldığına inanıyorum (bir printifade ile test , ayarlar dosyası okunmadan önce çağrıldığını gösteriyor.)

# /project/__init__.py
import signals

ve sinyaller halinde.

# /project/signals.py
from django.contrib.auth.signals import user_logged_in

def on_logged_in(sender, user, request, **kwargs):
    print 'User logged in as: \'{0}\''.format(user)

user_logged_in.connect(on_logged_in)

Django (/ python) için oldukça yeniyim, bu yüzden bana bunun korkunç bir fikir olduğunu söyleyen herkese açıkım!

Yakın zamanda projelerinizi / uygulamalarınızı düzenleme konusunda en iyi uygulamalar hakkında bu makaleyi okudum ve tüm özel dağıtım sinyallerinizinsignals.py . Ancak, sorununuzu tam olarak çözmez, çünkü bunları bir yere aktarmanız gerekir ve ne kadar erken içe aktarılırsa o kadar iyidir.

Model önerisi iyi bir öneridir. signals.pyDosyanızdaki her şeyi zaten tanımladığınızdan, dosyanın üst kısmındaki bir satırdan fazla sürmemelidir. Bu,admin.py dosyanın düzenlenme (üstte sınıf tanımları ve altta tüm özel yönetici sınıflarını kaydetme kodu ile), eğer sinyallerinizi tanımlarsanız, aynı dosyaya bağlayın.

Umarım yardımcı olur! Nihayetinde tercih ettiğiniz şeye iniyor.

Her uygulamadaki models.py ve signal.py, sinyalleri bağlamak için önerilen yerler olmuştur, ancak, sinyalleri ve işleyicileri gönderilmek için bence en iyi çözüm değildir. Sevkıyat, django'da icat edilmiş olan işaret ve işleyicilerin nedeni olmalıdır.

Uzun zamandır mücadele ediyordum ve sonunda çözümü bulduk.

uygulama klasöründe bir bağlayıcı modülü oluşturma

Böylece sahibiz:

app/
    __init__.py
    signals.py
    models.py
    connectors.py

app / connectors.py'de sinyal işleyicilerini tanımladık ve bağladık. Bir örnek verilmiştir:

from signals import example_signal
from models import ExampleModel
from django.db.models.signals import post_save, post_delete

def hanndler(sender, *args, **kwargs):
    pass

post_save.connect(hander, sender=ExampleModel)

sonra models.py'de dosyanın sonuna aşağıdaki satırı ekliyoruz:

from app import connector

Burada her şey yapıldı.

Bu şekilde, signal.py'ye ve tüm işleyicileri connectors.py'ye sinyaller koyabiliriz. Modellerde ve sinyallerde karışıklık yok.

Umarım başka bir çözüm sağlar.

Onları ayrı bir dosyada saklıyorum signals.py, models.pysonra tüm modeller tanımlandıktan sonra. Onları içe aktarırım ve modelleri sinyallere bağlarım.

signals.py

#  necessary imports

def send_mail_on_save(<args>):
    # code here 

models.py

# imports
class mymodel(models.Model):
    # model here

# import signals
from signals import send_mail_on_save
# connect them 
post_save.connect(send_mail_on_save,sender=mymodel)

Bu bana mantıklı bir ayrım sağlıyor, elbette onları saklamakta yanlış bir şey yok models.py'de , Ama bu şekilde daha yönetilebilir.

Bu yardımcı olur umarım!!

Hakkında küçük bir hatırlatma AppConfig. Ayarlamayı unutmayın:

# yourapp/__init__.py

default_app_config = 'yourapp.apps.RockNRollConfig'