関連オブジェクト削除からログ記録まで！Django post_delete シグナルの多様な活用例

Djangoにおけるdjango.db.models.signals.post_deleteの解説

django.db.models.signals.post_deleteは、Djangoモデルオブジェクトが削除された後に実行されるシグナルです。このシグナルは、モデル削除後の処理を実行するために使用できます。例えば、関連オブジェクトの削除、ログ記録、メール送信などを行うことができます。

使い方

post_deleteシグナルは、以下の2つの方法で使用できます。

デコレータを使用する

from django.db.models.signals import post_delete

@receiver(post_delete, sender=MyModel)
def my_callback(sender, instance, **kwargs):
    # モデル削除後に実行する処理を記述
    pass

この例では、MyModelオブジェクトが削除されたときにmy_callback関数が呼び出されます。instanceパラメータには削除されたオブジェクトが渡されます。

connect()関数を使用する

from django.db.models.signals import post_delete
from my_app.models import MyModel

def my_callback(sender, instance, **kwargs):
    # モデル削除後に実行する処理を記述
    pass

post_delete.connect(my_callback, sender=MyModel)

この例では、MyModelオブジェクトが削除されたときにmy_callback関数を呼び出すようにシグナルに接続します。

シグナル引数

post_deleteシグナルには以下の引数が渡されます。

• sender: シグナルを送信したモデルクラス
• instance: 削除されたオブジェクト
• using: オブジェクトが削除されたデータベース

例

以下の例は、MyModelオブジェクトが削除されたときに関連するOtherModelオブジェクトを削除する方法を示しています。

from django.db.models.signals import post_delete

@receiver(post_delete, sender=MyModel)
def delete_related_objects(sender, instance, **kwargs):
    instance.othermodel_set.all().delete()

この例では、MyModelオブジェクトが削除されたときに、othermodel_set属性に関連するすべてのOtherModelオブジェクトが削除されます。

補足

• post_deleteシグナルは、オブジェクトが削除される前に送信されるpre_deleteシグナルとは異なります。
• post_deleteシグナルは、トランザクション内で送信されます。つまり、トランザクションがロールバックされた場合、シグナルは送信されません。
• シグナルハンドラは、非同期的に実行される可能性があります。そのため、シグナルハンドラ内でデータベースへの書き込みを行う場合は、トランザクションを使用する必要があります。

Django post_delete シグナルのサンプルコード

この例では、Author オブジェクトが削除されたときに関連する Book オブジェクトをすべて削除します。

from django.db.models.signals import post_delete
from myapp.models import Author, Book

@receiver(post_delete, sender=Author)
def delete_books(sender, instance, **kwargs):
    instance.books.all().delete()

ログ記録

この例では、Article オブジェクトが削除されたときにログメッセージを記録します。

from django.db.models.signals import post_delete
from myapp.models import Article
from django.utils.timezone import now

@receiver(post_delete, sender=Article)
def log_article_deletion(sender, instance, **kwargs):
    logger.info(f"Article {instance.pk} deleted at {now()}")

メール送信

この例では、User オブジェクトが削除されたときに管理者にメールを送信します。

from django.db.models.signals import post_delete
from myapp.models import User
from django.core.mail import send_mail

@receiver(post_delete, sender=User)
def send_user_deletion_email(sender, instance, **kwargs):
    send_mail(
        subject="User Deleted",
        message=f"User {instance.email} has been deleted.",
        from_email="[email protected]",
        recipient_list=["[email protected]"],
    )

ファイルの削除

この例では、Profile オブジェクトが削除されたときに関連するファイルを削除します。

from django.db.models.signals import post_delete
from myapp.models import Profile
import os

@receiver(post_delete, sender=Profile)
def delete_profile_picture(sender, instance, **kwargs):
    if instance.picture:
        os.remove(instance.picture.path)

キャッシュのクリア

この例では、Product オブジェクトが削除されたときにキャッシュをクリアします。

from django.db.models.signals import post_delete
from myapp.models import Product
from django.core.cache import cache

@receiver(post_delete, sender=Product)
def clear_product_cache(sender, instance, **kwargs):
    cache.delete(f"product_{instance.pk}")

これらの例は、post_delete シグナルを使用してさまざまなタスクを実行する方法を示すほんの一例です。

Django post_delete シグナルを使用したその他のアプローチ

タスクキューにジョブを追加する

post_delete シグナルを使用して、Celeryなどのタスクキューにジョブを追加できます。これにより、時間のかかる処理を非同期的に実行できます。

from django.db.models.signals import post_delete
from myapp.models import Product
from celery import Celery

app = Celery('tasks')

@receiver(post_delete, sender=Product)
def send_product_deletion_notification(sender, instance, **kwargs):
    app.send_task('send_product_deletion_email', args=[instance.pk])

この例では、Product オブジェクトが削除されたときに、send_product_deletion_email タスクがキューに追加されます。このタスクは、削除された製品に関するメールを送信します。

Webhookをトリガーする

post_delete シグナルを使用して、Webhookをトリガーできます。これにより、他のシステムにオブジェクトの削除を通知できます。

from django.db.models.signals import post_delete
from myapp.models import Order
import requests

@receiver(post_delete, sender=Order)
def send_order_deletion_webhook(sender, instance, **kwargs):
    data = {
        'order_id': instance.pk,
    }
    requests.post('https://example.com/webhooks/order-deleted/', data=data)

この例では、Order オブジェクトが削除されたときに、https://example.com/webhooks/order-deleted/ に Webhook POST リクエストが送信されます。

サードパーティサービスを呼び出す

post_delete シグナルを使用して、サードパーティサービスを呼び出すことができます。これにより、オブジェクトの削除を外部システムに通知したり、処理を実行したりできます。

from django.db.models.signals import post_delete
from myapp.models import Customer
from myservice import MyService

@receiver(post_delete, sender=Customer)
def delete_customer_from_myservice(sender, instance, **kwargs):
    MyService.delete_customer(instance.pk)

この例では、Customer オブジェクトが削除されたときに、MyService クラスの delete_customer メソッドが呼び出されます。このメソッドは、myservice サービスから顧客を削除します。

カスタムロジックを実行する

post_delete シグナルを使用して、カスタムロジックを実行できます。これは、前述の例では説明されていない特定のニーズを満たすために使用できます。

from django.db.models.signals import post_delete
from myapp.models import Product

@receiver(post_delete, sender=Product)
def handle_product_deletion(sender, instance, **kwargs):
    # カスタムロジックを実行
    pass

この例では、Product オブジェクトが削除されたときに、handle_product_deletion 関数が呼び出されます。この関数は、カスタムロジックを実行するために使用できます。

これらの例は、post_delete シグナルを使用してさまざまなタスクを実行する方法を示すほんの一例です。このシグナルは、オブジェクトの削除後に実行する必要があるあらゆる処理に使用できます。