Connecting signal handlers in Django - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a signal handler in Django?

A signal handler is a function that gets called automatically when a specific event (signal) happens in Django, like saving a model or user login.

beginner

How do you connect a signal handler to a signal in Django?

You use the connect() method on the signal, passing the handler function and optionally the sender model to listen for specific events.

intermediate

Why should you connect signal handlers inside the apps.py or a ready method?

Connecting signals in apps.py ensures handlers are registered only once when the app starts, avoiding duplicate calls or missed signals.

intermediate

What does the sender argument do when connecting a signal handler?

The sender argument limits the signal handler to respond only to signals sent by that specific model or class.

beginner

Show a simple example of connecting a signal handler to Django's post_save signal.

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

@receiver(post_save, sender=MyModel)
def my_handler(sender, instance, created, **kwargs):
    if created:
        print(f"New instance created: {instance}")

What method do you use to connect a signal handler in Django?

A register()

B bind()

C connect()

D attach()

The correct method to connect a signal handler is connect().

Where is the best place to connect signal handlers to avoid multiple registrations?

A Inside apps.py in the ready() method

B Inside models.py

C Inside views.py

D Inside templates

Connecting signals inside the ready() method of apps.py ensures handlers are registered once when the app loads.

What does the sender argument specify when connecting a signal?

A The function to call

B The model or class sending the signal

C The signal type

D The database connection

The sender argument limits the handler to signals sent by a specific model or class.

Which Django signal is commonly used to run code after a model instance is saved?

A post_save

B pre_save

C pre_delete

D post_delete

The post_save signal runs after a model instance is saved.

What happens if you connect the same signal handler multiple times?

A It runs only once

B It disables the signal

C It causes an error

D It runs multiple times for one event

Connecting the same handler multiple times causes it to run multiple times for a single event.

Explain how to connect a signal handler in Django and why it is important to do it in the right place.

Think about app startup and avoiding duplicate calls.

Describe the role of the sender argument when connecting a signal handler in Django.

Sender is like choosing which friend’s message you want to listen to.

Practice

1. What is the main purpose of connecting signal handlers in Django?

easy

A. To style HTML templates dynamically

B. To manually call functions from views

C. To create new database tables

D. To automatically run code when certain model events happen

Solution

1. Step 1: Understand signal handlers

   Signal handlers let Django apps respond automatically to events like saving or deleting a model.

2. Step 2: Identify the purpose

   Connecting signal handlers means running code automatically when these events happen, without manual calls.

3. Final Answer:

   To automatically run code when certain model events happen -> Option D

4. Quick Check:

   Signal handlers = automatic event response [OK]

Hint: Signals run code automatically on model events [OK]

Common Mistakes:

• Thinking signals create database tables
• Confusing signals with manual function calls
• Assuming signals style templates

2. Which of the following is the correct way to connect a signal handler using the decorator in Django?

easy

A. @receiver(post_save, sender=MyModel)
def my_handler(sender, instance, **kwargs): pass

B. @signal(post_save, sender=MyModel)
def my_handler(sender, instance): pass

C. @connect(post_save, sender=MyModel)
def my_handler(instance): pass

D. @listen(post_save, sender=MyModel)
def my_handler(sender): pass

Solution

1. Step 1: Recall the correct decorator

   Django uses @receiver to connect signal handlers, not @signal, @connect, or @listen.

2. Step 2: Check function parameters

   The handler must accept sender, instance, and optionally **kwargs. @receiver(post_save, sender=MyModel) def my_handler(sender, instance, **kwargs): pass matches this.

3. Final Answer:

   @receiver(post_save, sender=MyModel) def my_handler(sender, instance, **kwargs): pass -> Option A

4. Quick Check:

   Use @receiver with correct params [OK]

Hint: Use @receiver decorator with sender and signal [OK]

Common Mistakes:

• Using wrong decorator names
• Missing sender argument
• Incorrect handler parameters

3. Given this code snippet, what will be printed when a new Book instance is created?

from django.db.models.signals import post_save
from django.dispatch import receiver

@receiver(post_save, sender=Book)
def announce_book(sender, instance, created, **kwargs):
    if created:
        print(f"New book added: {instance.title}")

book = Book.objects.create(title='Django Basics')

medium

A. New book added:

B. New book added: Django Basics

C. No output

D. Error: missing argument

Solution

1. Step 1: Understand the signal and handler

   The post_save signal triggers after saving a model. The handler checks if created is True, meaning a new record.

2. Step 2: Analyze the code execution

   Creating a new Book instance sets created=True, so the print statement runs with the title.

3. Final Answer:

   New book added: Django Basics -> Option B

4. Quick Check:

   post_save with created=True prints title [OK]

Hint: Check 'created' flag to print on new records only [OK]

Common Mistakes:

• Ignoring the 'created' flag
• Assuming no output on create
• Confusing signal arguments

4. Identify the error in this signal handler connection code:

from django.db.models.signals import post_save
from django.dispatch import receiver

@receiver(post_save)
def handler(sender, instance, **kwargs):
    print('Saved!')

medium

A. Missing sender argument in @receiver decorator

B. Handler function missing 'created' parameter

C. post_save signal is not imported correctly

D. Handler function should not have **kwargs

Solution

1. Step 1: Check the @receiver decorator usage

   The @receiver decorator requires the signal and optionally the sender. Omitting sender means the handler listens to all senders, which is allowed but often unintended.

2. Step 2: Identify the likely error

   Since the question asks for an error, the missing sender argument is the problem if the handler is meant for a specific model.

3. Final Answer:

   Missing sender argument in @receiver decorator -> Option A

4. Quick Check:

   Specify sender to target model signals [OK]

Hint: Always specify sender to avoid catching all signals [OK]

Common Mistakes:

• Not specifying sender when needed
• Assuming 'created' param is always required
• Misunderstanding **kwargs usage

5. You want to run a function only when a new UserProfile is created, not when updated. Which is the best way to connect the signal handler?

hard

A. Use @receiver(post_save) without sender and ignore created flag

B. Use @receiver(pre_save, sender=UserProfile) and always run the function

C. Use @receiver(post_save, sender=UserProfile) and check if created is True inside the handler

D. Use @receiver(post_delete, sender=UserProfile) to detect creation

Solution

1. Step 1: Identify the correct signal for creation

   post_save runs after saving, and the created flag tells if it's a new record.

2. Step 2: Choose the best method

   Using @receiver(post_save, sender=UserProfile) and checking created inside the handler ensures the function runs only on creation.

3. Final Answer:

   Use @receiver(post_save, sender=UserProfile) and check if created is True inside the handler -> Option C

4. Quick Check:

   post_save + created=True = run on new only [OK]

Hint: Check 'created' flag in post_save for new records only [OK]

Common Mistakes:

• Using pre_save which runs before saving
• Using post_delete which runs on deletion
• Ignoring the created flag and running always