Snippet

Context Manager to Mute Django Signals During Unit Testing

Creating a context manager using @contextmanager helps temporarily disconnect model signals in unit tests to prevent unintended side effects like sending emails.

snippet.py

python

from contextlib import contextmanager
from django.db.models.signals import post_save
 
@contextmanager
def mute_signal(signal, receiver, sender):
    signal.disconnect(receiver, sender=sender)
    try:
        yield
    finally:
        signal.connect(receiver, sender=sender)

django

Breakdown

@contextmanager

Decorator from contextlib converting a generator into a Python context manager.

signal.disconnect(receiver, sender=sender)

Temporarily unbinds the signal handler before entering the context block.

signal.connect(receiver, sender=sender)

Re-attaches the signal handler in the finally block when leaving the context.

Previous snippet Next snippet

More Intermediate Python exercises →

Context Manager to Mute Django Signals During Unit Testing

Related