Signal dispatch process in Django - Mini Project: Build & Apply

Signal dispatch process

📖 Scenario: You are building a Django app that needs to perform an action automatically when a new user is created.We will use Django signals to detect when a user is saved and then run custom code.

🎯 Goal: Create a Django signal handler that listens for the post_save signal on the User model and prints a message when a new user is created.

📋 What You'll Learn

Import the post_save signal from django.db.models.signals

Import the User model from django.contrib.auth.models

Define a function called welcome_new_user that accepts sender, instance, created, and **kwargs parameters

Connect the welcome_new_user function to the post_save signal for the User model

Inside the signal handler, check if created is True and then print "Welcome, {username}!" where {username} is the username of the new user

💡 Why This Matters

🌍 Real World

Automatically perform actions like sending welcome messages or updating related data when database changes happen.

💼 Career

Understanding Django signals is important for backend developers to write clean, decoupled code that reacts to model events.

1

Import necessary modules and models

Import post_save from django.db.models.signals and import User from django.contrib.auth.models.

Django

# Your code here

Hint

Use from django.db.models.signals import post_save and from django.contrib.auth.models import User.

2

Define the signal handler function

Define a function called welcome_new_user that accepts parameters sender, instance, created, and **kwargs.

Django

from django.db.models.signals import post_save
from django.contrib.auth.models import User

# Define the signal handler function
# Your code here

Hint

Define the function with the exact name and parameters.

3

Add logic to check if a new user was created

Inside the welcome_new_user function, add an if statement to check if created is True. If so, print "Welcome, {instance.username}!" using an f-string.

Django

from django.db.models.signals import post_save
from django.contrib.auth.models import User

def welcome_new_user(sender, instance, created, **kwargs):
    # Your code here

Hint

Use if created: and inside it use print(f"Welcome, {instance.username}!").

4

Connect the signal handler to the post_save signal

Connect the welcome_new_user function to the post_save signal for the User model using post_save.connect(welcome_new_user, sender=User).

Django

from django.db.models.signals import post_save
from django.contrib.auth.models import User

def welcome_new_user(sender, instance, created, **kwargs):
    if created:
        print(f"Welcome, {instance.username}!")

# Your code here

Hint

Use post_save.connect(welcome_new_user, sender=User) to connect the signal.

Practice

1. What is the main purpose of Django signals in the signal dispatch process?

easy

A. To allow different parts of an app to communicate automatically when events happen

B. To store data in the database

C. To create user interface elements

D. To handle HTTP requests directly

Solution

1. Step 1: Understand what signals do

   Django signals send messages between parts of an app when something happens.

2. Step 2: Identify the purpose of signals

   Signals let parts of the app react automatically to events like saving or deleting data.

3. Final Answer:

   To allow different parts of an app to communicate automatically when events happen -> Option A

4. Quick Check:

   Signals enable automatic communication [OK]

Hint: Signals connect events to actions automatically [OK]

Common Mistakes:

• Thinking signals store data
• Confusing signals with UI elements
• Believing signals handle HTTP requests

2. Which of the following is the correct way to connect a receiver function to a Django signal?

easy

A. signal.connect(receiver_function, sender=ModelClass)

B. receiver_function.connect(signal, sender=ModelClass)

C. signal.send(receiver_function, sender=ModelClass)

D. receiver_function.send(signal, sender=ModelClass)

Solution

1. Step 1: Recall the syntax for connecting signals

   In Django, you connect a receiver to a signal using signal.connect(receiver, sender=...).

2. Step 2: Match the correct method call

   signal.connect(receiver_function, sender=ModelClass) uses signal.connect with the receiver function and sender, which is correct.

3. Final Answer:

   signal.connect(receiver_function, sender=ModelClass) -> Option A

4. Quick Check:

   Use signal.connect to attach receivers [OK]

Hint: Remember: signal.connect(receiver, sender) [OK]

Common Mistakes:

• Calling connect on the receiver instead of the signal
• Using send instead of connect to attach receivers
• Mixing up sender and receiver parameters

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

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

@receiver(post_save, sender=User)
def user_saved(sender, instance, created, **kwargs):
    if created:
        print(f"User {instance.username} created")
    else:
        print(f"User {instance.username} updated")

user = User(username='alice')
user.save()

medium

A. User alice updated

B. User alice created

C. No output

D. Error: receiver not connected

Solution

1. Step 1: Understand the post_save signal and receiver

   The receiver listens for post_save on User. It prints 'created' if the instance is new.

2. Step 2: Analyze the save call

   Creating a new User and calling save triggers post_save with created=True, so it prints 'User alice created'.

3. Final Answer:

   User alice created -> Option B

4. Quick Check:

   New save triggers created=True message [OK]

Hint: post_save with created=True means new instance saved [OK]

Common Mistakes:

• Assuming updated message prints on new save
• Thinking receiver is not connected automatically
• Ignoring the created flag in the receiver

4. What is wrong with this signal receiver code when trying to target deletes from a specific model only?

from django.db.models.signals import pre_delete

def my_receiver(sender, instance, **kwargs):
    print(f"Deleting {instance}")

pre_delete.connect(my_receiver)

medium

A. Signal pre_delete does not exist

B. Receiver function must be decorated with @receiver

C. Missing sender argument in connect call

D. Receiver function must return a value

Solution

1. Step 1: Check the connect call parameters

   The connect call lacks the sender argument, so it connects to all senders.

2. Step 2: Identify why it doesn't target a specific model

   Without specifying sender, the receiver runs for deletes on any model. Adding sender=ModelClass limits it to that model.

3. Final Answer:

   Missing sender argument in connect call -> Option C

4. Quick Check:

   Always specify sender for model-specific receivers [OK]

Hint: Always specify sender in connect unless you want all senders [OK]

Common Mistakes:

• Thinking @receiver decorator is required
• Believing pre_delete signal does not exist
• Expecting receiver to return a value

5. You want to send a custom signal when a blog post is published. Which steps correctly describe the signal dispatch process to achieve this?

hard

A. Override the save method without using signals, then print a message

B. Call the receiver function directly without connecting it to a signal

C. Use Django's built-in signals only; custom signals are not supported

D. Define a custom Signal, connect a receiver with @receiver decorator, then send the signal when publishing

Solution

1. Step 1: Define a custom Signal

   Create a Signal instance to represent the blog post published event.

2. Step 2: Connect a receiver function

   Use the @receiver decorator or signal.connect to attach a function that reacts to the signal.

3. Step 3: Send the signal when publishing

   Call signal.send(sender=..., instance=...) at the point where the blog post is published.

4. Final Answer:

   Define a custom Signal, connect a receiver with @receiver decorator, then send the signal when publishing -> Option D

5. Quick Check:

   Custom signal + receiver + send = correct process [OK]

Hint: Custom signals need definition, connection, and sending [OK]

Common Mistakes:

• Trying to use only built-in signals for custom events
• Calling receiver directly without signal
• Overriding save without signals when signals are needed