Custom signals in Django

Introduction

Custom signals let you send messages inside your Django app when something happens. This helps different parts of your app talk to each other without being tightly connected.

You want to run extra code after saving a model without changing the model code.

You need to notify other parts of your app when a user logs in or out.

You want to keep your code organized by separating actions triggered by events.

You want to add logging or analytics when certain actions happen in your app.

Syntax

Django

from django.dispatch import Signal

# Define a custom signal
my_signal = Signal()

# Define a receiver function
def my_receiver(sender, **kwargs):
    print(f"Signal received with args: {kwargs}")

# Connect the receiver to the signal
my_signal.connect(my_receiver)

# Send the signal
my_signal.send(sender=None, arg1='hello', arg2='world')

Signal: This is the message you send.

Receiver: This is the function that listens and reacts to the signal.

Examples

This example shows a signal without any extra data sent.

Django

from django.dispatch import Signal

# Create a signal without arguments
simple_signal = Signal()

# Receiver function
def receiver(sender, **kwargs):
     print("Simple signal received")

# Connect and send
simple_signal.connect(receiver)
simple_signal.send(sender=None)

This example sends a username with the signal and the receiver greets the user.

Django

from django.dispatch import Signal

# Signal with arguments
user_logged_in = Signal()

def greet_user(sender, user, **kwargs):
    print(f"Welcome {user}!")

user_logged_in.connect(greet_user)
user_logged_in.send(sender=None, user='Alice')

Sample Program

This program creates a custom signal called order_completed. When the signal is sent with an order ID, the receiver prints a message to notify shipping.

Django

from django.dispatch import Signal

# Define a custom signal with one argument
order_completed = Signal()

# Receiver function that reacts to the signal
def notify_shipping(sender, order_id, **kwargs):
    print(f"Order {order_id} completed. Notify shipping department.")

# Connect the receiver to the signal
order_completed.connect(notify_shipping)

# Simulate sending the signal when an order is done
order_completed.send(sender=None, order_id=12345)

Important Notes

Always connect your receiver functions before sending signals.

Use providing_args to document what data your signal sends, but Django does not enforce it.

Signals help keep your code clean by separating event handling from main logic.

Summary

Custom signals let parts of your Django app communicate without tight links.

Define signals, write receivers, connect them, then send signals when needed.

This helps organize code and add features like notifications or logging easily.

Practice

1. What is the main purpose of custom signals in Django?

easy

A. To create new database tables dynamically

B. To speed up database queries automatically

C. To replace Django's URL routing system

D. To allow different parts of an app to communicate without being tightly connected

Solution

1. Step 1: Understand what custom signals do

   Custom signals let different parts of a Django app send messages to each other without direct links.

2. Step 2: Compare options to this purpose

   Only To allow different parts of an app to communicate without being tightly connected describes this communication purpose; others describe unrelated features.

3. Final Answer:

   To allow different parts of an app to communicate without being tightly connected -> Option D

4. Quick Check:

   Custom signals = loose communication [OK]

Hint: Custom signals help parts talk without tight links [OK]

Common Mistakes:

• Thinking signals speed up queries
• Confusing signals with URL routing
• Believing signals create database tables

2. Which of the following is the correct way to define a custom signal in Django?

easy

A. my_signal = signal(["instance", "created"])

B. my_signal = Signal(providing_args=["instance", "created"])

C. my_signal = Signal(args=["instance", "created"])

D. my_signal = Signal(provides=["instance", "created"])

Solution

1. Step 1: Recall Django's Signal class syntax

   The correct way is to create a Signal object with providing_args as a list of argument names.

2. Step 2: Check each option's syntax

   Only my_signal = Signal(providing_args=["instance", "created"]) uses Signal with providing_args correctly; others use wrong parameter names or lowercase Signal.

3. Final Answer:

   my_signal = Signal(providing_args=["instance", "created"]) -> Option B

4. Quick Check:

   Signal(providing_args=...) is correct syntax [OK]

Hint: Use Signal(providing_args=[...]) to define custom signals [OK]

Common Mistakes:

• Using lowercase 'signal' instead of 'Signal'
• Using 'args' or 'provides' instead of 'providing_args'
• Passing arguments without a list

3. Given this code snippet, what will be printed when my_signal.send(sender=None, instance='obj1', created=True) is called?

from django.dispatch import Signal, receiver

my_signal = Signal(providing_args=["instance", "created"])

@receiver(my_signal)
def my_receiver(sender, **kwargs):
    print(f"Received: {kwargs['instance']}, Created: {kwargs['created']}")

medium

A. Received: obj1, Created: True

B. Received: None, Created: True

C. Received: obj1, Created: False

D. Error: missing sender argument

Solution

1. Step 1: Understand signal sending and receiver

   The signal is sent with instance='obj1' and created=True. The receiver prints these values from kwargs.

2. Step 2: Match printed output to sent values

   The print statement uses kwargs['instance'] and kwargs['created'], so it prints 'obj1' and 'True'.

3. Final Answer:

   Received: obj1, Created: True -> Option A

4. Quick Check:

   Signal send values print correctly [OK]

Hint: Receiver prints kwargs values sent by signal [OK]

Common Mistakes:

• Confusing sender with instance
• Assuming created is False by default
• Thinking sender is required in print

4. What is wrong with this code that tries to connect a receiver to a custom signal?

from django.dispatch import Signal

my_signal = Signal(providing_args=["data"])

def receiver_func(sender, data):
    print(f"Data: {data}")

my_signal.connect(receiver_func)

medium

A. The receiver function must accept **kwargs, not just named arguments

B. Signal must be imported from django.signals, not django.dispatch

C. The connect method requires a sender argument

D. providing_args should be a tuple, not a list

Solution

1. Step 1: Check receiver function signature

   Receivers must accept sender and **kwargs to handle all signal arguments flexibly.

2. Step 2: Identify mismatch in receiver parameters

   The receiver only accepts sender and data, missing **kwargs, which causes errors when extra arguments are sent.

3. Final Answer:

   The receiver function must accept **kwargs, not just named arguments -> Option A

4. Quick Check:

   Receiver needs **kwargs for signal args [OK]

Hint: Receiver functions always need **kwargs parameter [OK]

Common Mistakes:

• Forgetting **kwargs in receiver signature
• Importing Signal from wrong module
• Assuming connect requires sender argument
• Confusing list and tuple for providing_args

5. You want to create a custom signal that notifies when a user profile is updated, sending the user instance and a flag if the update was major. Which of these is the best way to define and send this signal?

hard

A. Define signal with no providing_args and send with user=user_obj, major_update=True

B. Define signal with providing_args=['user'] and send with user=user_obj, major_update=True

C. Define signal with providing_args=['user', 'major_update'] and send with user=user_obj, major_update=True

D. Define signal with providing_args=['user', 'major_update'] but send only user=user_obj

Solution

1. Step 1: Define signal with all expected arguments

   Since you want to send both user and major_update, both must be listed in providing_args.

2. Step 2: Send signal with matching arguments

   When sending, include both user and major_update to match the signal definition and receiver expectations.

3. Final Answer:

   Define signal with providing_args=['user', 'major_update'] and send with user=user_obj, major_update=True -> Option C

4. Quick Check:

   Signal args must match send args [OK]

Hint: Match providing_args and send arguments exactly [OK]

Common Mistakes:

• Omitting arguments in providing_args
• Sending arguments not declared in providing_args
• Defining signal without providing_args but sending args