Why Receiver decorator in Django? - Purpose & Use Cases

The Big Idea

Discover how a simple decorator can save you from tangled event code and bugs!

The Scenario

Imagine you have to write code that listens for many different events in your Django app, like when a user logs in or a model is saved. You manually connect functions to these events everywhere in your code.

The Problem

Manually connecting event handlers is easy to forget, can cause duplicate connections, and makes your code messy and hard to follow. It's like trying to remember to plug in every appliance separately instead of having a smart power strip.

The Solution

The receiver decorator in Django lets you neatly attach your functions to signals in one place. It automatically connects your handler to the right event, keeping your code clean and reliable.

Before vs After

✗ Before

from django.db.models.signals import post_save
post_save.connect(my_handler, sender=MyModel)

✓ After

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

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

What It Enables

This lets you easily organize event-driven code, making your app responsive and maintainable without messy manual wiring.

Real Life Example

When a new user signs up, you want to send a welcome email. Using the receiver decorator, you write a clean function that automatically runs after the user is saved, without extra setup.

Key Takeaways

Manually connecting signals is error-prone and cluttered.

The receiver decorator simplifies and organizes signal handling.

It helps keep your Django app clean and event-driven.

Practice

1. What is the main purpose of the @receiver decorator in Django?

easy

A. To register a template filter

B. To create a new database model

C. To connect a function to a signal so it runs automatically when the signal is sent

D. To define a URL route in Django

Solution

1. Step 1: Understand what signals do in Django

   Signals notify parts of your app when something happens, like saving a model.

2. Step 2: Role of the @receiver decorator

   The decorator links a function to a signal so it runs automatically when the signal is sent.

3. Final Answer:

   To connect a function to a signal so it runs automatically when the signal is sent -> Option C

4. Quick Check:

   Receiver decorator connects functions to signals = D [OK]

Hint: Receiver links functions to signals for automatic execution [OK]

Common Mistakes:

• Confusing receiver with model or URL definitions
• Thinking receiver creates models or templates
• Mixing up signals with URL routing

2. Which of the following is the correct syntax to use the @receiver decorator for the post_save signal of a model named Book?

easy

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

B. @receiver(post_save(Book))
def my_handler(sender, instance, **kwargs):
pass

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

D. @receiver(post_save)
def my_handler(Book, instance, **kwargs):
pass

Solution

1. Step 1: Check the correct decorator syntax

   The @receiver decorator takes the signal as first argument and sender=ModelName as keyword argument.

2. Step 2: Match the correct function signature

   The handler function must accept sender, instance, and **kwargs.

3. Final Answer:

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

4. Quick Check:

   Correct decorator syntax = C [OK]

Hint: Use @receiver(signal, sender=Model) syntax [OK]

Common Mistakes:

• Passing sender as positional argument
• Incorrect function parameters
• Missing sender keyword argument

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

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

@receiver(post_save, sender=Book)
def notify(sender, instance, **kwargs):
    print(f"Book saved: {instance.title}")

book = Book(title='Django Basics')
book.save()

medium

A. Book saved: None

B. Error: receiver not connected

C. No output printed

D. Book saved: Django Basics

Solution

1. Step 1: Understand the signal connection

   The @receiver decorator connects notify to post_save for Book.

2. Step 2: What happens on book.save()?

   Saving the book triggers post_save, calling notify, which prints the book's title.

3. Final Answer:

   Book saved: Django Basics -> Option D

4. Quick Check:

   post_save triggers print with instance title = B [OK]

Hint: post_save calls receiver printing instance data [OK]

Common Mistakes:

• Assuming no output without explicit call
• Confusing instance attribute access
• Thinking receiver needs manual call

4. Identify the error in this signal receiver code:

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

@receiver(post_save, sender=Author)
def handle_save(instance, **kwargs):
    print(f"Author saved: {instance.name}")

medium

A. Incorrect decorator usage, should not use sender

B. Missing sender parameter in function definition

C. Function name must be post_save_handler

D. No error, code is correct

Solution

1. Step 1: Check function parameters for signal handlers

   Signal handlers must accept sender, instance, and **kwargs.

2. Step 2: Identify missing parameter

   The function handle_save lacks the sender parameter, causing an error.

3. Final Answer:

   Missing sender parameter in function definition -> Option B

4. Quick Check:

   Signal handler must have sender parameter = A [OK]

Hint: Signal handlers need sender, instance, **kwargs parameters [OK]

Common Mistakes:

• Omitting sender parameter
• Wrong function signature order
• Assuming function name matters

5. You want to run a function only when a User model instance is created (not updated). How do you use the @receiver decorator with post_save to achieve this?

hard

A. @receiver(post_save, sender=User)
def user_created(sender, instance, created, **kwargs):
if created:
print('New user created')

B. @receiver(post_save, sender=User)
def user_created(sender, instance, **kwargs):
print('New user created')

C. @receiver(post_save, sender=User)
def user_created(sender, instance, created=False, **kwargs):
if created == False:
print('New user created')

D. @receiver(post_save, sender=User)
def user_created(sender, instance, **kwargs):
if not created:
print('New user created')

Solution

1. Step 1: Understand the created flag in post_save

   The post_save signal passes a created boolean indicating if the instance was newly created.

2. Step 2: Use created to run code only on creation

   Check if created: inside the receiver function to run code only when a new instance is created.

3. Final Answer:

   @receiver(post_save, sender=User) def user_created(sender, instance, created, **kwargs): if created: print('New user created') -> Option A

4. Quick Check:

   Use created flag in post_save receiver = A [OK]

Hint: Check 'created' flag in post_save receiver to detect new instances [OK]

Common Mistakes:

• Ignoring the created parameter
• Checking created incorrectly
• Missing created parameter in function