シグナルハンドラーはdjangoプロジェクトのどこに住むべきですか？

私はちょうどdjangoプロジェクトでシグナルリスナーを実装し始めました。私はそれらが何であるか、そしてそれらの使い方を理解しています。私はそれらをどこに置くべきかを理解するのに苦労しています。djangoサイトのドキュメントには、次のように書かれています。

このコードはどこに置くべきですか？

信号処理と登録コードを好きな場所に配置できます。ただし、シグナルが送信される前にシグナル処理が登録されるように、モジュールが含まれているモジュールが早い段階でインポートされていることを確認する必要があります。これにより、アプリのmodels.pyがシグナルハンドラの登録を配置するのに適した場所になります。

それは良い提案ですが、私のmodels.pyに非モデルクラスまたはメソッドがあると、間違った方法で私をこするだけです。

それでは、シグナルハンドラを保存して登録するためのベストプラクティス/ルールは何ですか？

私は実際には、モデル自体のクラスメソッドを作成するのが好きです。これにより、すべてが1つのクラス内に保持され、何もインポートすることを心配する必要がなくなります。

これは、Django 1.7のリリース時にドキュメントに追加されました。

厳密に言えば、信号処理と登録コードは好きな場所に配置できますが、アプリケーションのルートモジュールとそのモデルモジュールを避けて、コードのインポートによる副作用を最小限に抑えることをお勧めします。

実際には、シグナルハンドラは通常、関連するアプリケーションのシグナルサブモジュールで定義されます。シグナルレシーバーは、アプリケーション構成クラスのready（）メソッドで接続されます。receiver（）デコレーターを使用している場合は、ready（）内に信号サブモジュールをインポートするだけです。

Django 1.7で変更：以前のバージョンのDjangoにはready（）が存在しなかったため、通常、信号の登録はモデルモジュールで行われていました。

ベストプラクティスは、次のようなファイルなど、シグナルサブモジュールのhandlers.pyでハンドラーを定義することです。

yourapp / signals / 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

シグナルハンドラーを登録するのに最適な場所は、ready（）メソッドを使用して、シグナルハンドラーを定義するアプリのAppConfig内です。これは次のようになります。

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

settings.pyのINSTALLED_APPSで直接、または__init__アプリので指定して、AppConfigをロードしていることを確認してください。詳細については、ready（）のドキュメントを参照してください。

注：他のアプリも同様にリッスンするシグナルを提供する場合は、それらを__init__シグナルモジュールに入れます（例：次のようなファイル）。

yourapp / signals / __ init__.py

import django.dispatch

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

次に、別のアプリが信号をインポートして登録することで信号を聞くことができますfrom yourapp.signals import task_generate_pre_save。ハンドラーからシグナルを分離することで、物事をきれいに保ちます。

Django 1.6の手順：

それでもDjango 1.6以下でスタックしている場合は、同じことを行います（yourapp / signals / handlers.pyでハンドラーを定義します）。ただし、AppConfigを使用する代わりに、__ init__.pyを介してハンドラーをロードします。あなたのアプリ、例えば次のようなもの：

yourapp / __ init__.py

import signals

これは、ready（）メソッドの使用ほどよくありません。循環インポートの問題を引き起こすことが多いからです。

私はこれに遭遇しただけであり、私の信号はモデルに関連していないので、自分の解決策を追加すると思いました。

ログイン/ログアウトに関するさまざまなデータをログに記録しており、にフックする必要がありますdjango.contrib.auth.signals。

シグナルハンドラーをsignals.pyファイルに入れ、__init__.pyモジュールファイルからシグナルをインポートしました。これは、アプリが起動するとすぐに呼び出されると思います（printステートメントでテストすると、設定ファイルが読み取られる前でも呼び出されることが示唆されています）。

# /project/__init__.py
import signals

そしてsignals.pyで

# /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）にかなり慣れていないので、これはひどいアイデアだと言ってくれる人なら誰でも受け入れることができます。

プロジェクト/アプリケーションのレイアウトに関するベストプラクティスについてのこの記事を最近読んだところ、すべてのカスタムディスパッチャーシグナルをというファイルに入れる必要があることを示唆していますsignals.py。ただし、これらはまだどこかにインポートする必要があるため、問題が完全に解決されるわけではありません。

モデルの提案は良いものです。signals.pyファイル内のすべてをすでに定義しているので、ファイルの上部にある1行以上は必要ありません。これは、admin.pyファイルをレイアウトする方法に似ています（上部にクラス定義を、下部にすべてのカスタム管理クラスを登録するためのコードを使用）。信号を定義して同じファイルに接続する場合。

お役に立てば幸いです。結局、それはあなたが好むものに帰着します。

各アプリのmodels.pyとsignals.pyは、信号を接続するための推奨される場所ですが、私の意見では、信号とハンドラーをディスパッチしたままにしておくための最良の解決策ではありません。ディスパッチは、djangoで発明されたシグナルとハンドラーの理由です。

私は長い間苦労していましたが、最終的に解決策を見つけました。

アプリフォルダーにコネクタモジュールを作成する

だから私たちは：

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

app / connectors.pyで、シグナルハンドラーを定義して接続します。例を示します。

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)

次に、models.pyで、ファイルの最後に次の行を追加します。

from app import connector

ここですべてが行われました。

このようにして、signals.pyにシグナルを配置し、connectors.pyにすべてのハンドラーを配置できます。モデルと信号に混乱はありません。

別のソリューションが提供されることを願っています。

私は別のファイルにそれらを保つsignals.pyには、models.pyすべてのモデルが定義されていた後。それらをインポートして、モデルを信号に接続します。

signal.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)

これは私に論理的な分離を提供します。もちろん、それらをmodels.pyに保持することには何の問題もありませんが、 この方法の方が扱いやすいです。

お役に立てれば！！

についての小さなリマインダーAppConfig。設定することを忘れないでください：

# yourapp/__init__.py

default_app_config = 'yourapp.apps.RockNRollConfig'