Using Django's built in signals and writing custom signals.

Django has a beautiful feature of signals which will record all the actions performed on the particular model. In the current blog post, we’ll learn how to use Django's built-in signals and how to create custom signal

Using Django’s built in Signals:
Django has a lot of built-in signals like pre_save, post_save, pre_delete and post_delete and etc., For more information about Django's built-in signals visit https://docs.djangoproject.com/en/1.9/ref/signals/. Now we’ll learn how to use Django's pre_delete signal with a simple example. In the way we use pre_delete in the present blog post we can use other signals also in the same way. We have two models called Author and Book their models are defined in models.py as below.

# In models.py
from django.db import models

class Author(models.Model):
    full_name = models.CharField(max_length=100)
    short_name = models.CharField(max_length=50)

class Book(models.Model):
    title = models.CharField(max_length=100)
    slug = models.SlugField(max_length=100)
    content = model.TextField()
    status = models.CharField(max_length=10, default=”Drafted”)
    author_id = model.PositiveIntegerField(null=True)

In the above two models we are not having an author as foreignKey to Book model, so by default when the Author gets deleted it won’t delete all the Books written by the author. This is the case where signals come to picture, we can achieve this by using pre_delete or post_delete signals. For this, we’ll write a receiver function which will be called on pre_delete of the author object. Write the following code in your models.py

def remove_books(sender, instance, **kwargs):
    author_id = instance.id
    Book.objects.filter(author_id=author_id).delete()

pre_delete.connect(remove_books, sender=Author)

In the above snippet sender is the model name on which the pre_delete signal is called, in the current example it is Author model. Remove_books is the receiver function which will be called on delete of the Author object. It takes sender, instance(the Author instance which is called for delete) and any other keyword arguments.

Writing Custom Signals:
Now in this section, we’ll learn, how to create custom signals using the same above example. Suppose if the author has to get an email when the Book status is changed to “Published”. For this, we have to create a file called signals.py to create a custom signal. By default all the signals are django.dispatch.Signal instances.

# In signals.py
import django.dispatch
book_publised = django.dispatch.Signal(providing_args=["book", “author”])

Create receivers.py which contains the receiver function which will be called when the signal is dispatched.

# In receivers.py
from django.dispatch import receiver
from .signals import *

@receiver(book_publised)
def send_mail_on_publish(sender, **kwargs):
    # contains the logic to send the email to author.

In the above snippet receiver is decorator which tells the book_published signal that send_mail_on_publish is the receiver function which will be called when the book_publisehd signal is dispatched.

We can dispatch signal anywhere as following.

book_published.send(sender=Book, book=<Book Instance>, user=<Author Instance>)

Note: The most important to be remembered is when we just call book_published.send(*****) it won’t hit the receiver function. To make the signal hit the receiver function is we have to import receiver in your app’s __init__.py. 

# In __init__.py

import receivers

But from Django 1.9+ if we import receivers in __init__.py, it will cause runtime error of Apps not ready. To avoid this issue we have to import this inside the ready function of your apps.py

# In apps.py

from django.apps import AppConfig
class LoadReceivers(AppConfig):
    name = testapp

    def ready(self):
        from . import receivers

Posted On 13 August 2012 By MicroPyramid

Previous post Next post

Need any Help in your Project?Let's Talk

Latest Comments

OUR SERVICES

OPEN SOURCE PACKAGES

Django-CRM :Customer relationship management based on Django

Django-blog-it : django blog with complete customization and ready to use with one click installer Edit

Django-webpacker : A django compressor tool

Django-MFA : Multi Factor Authentication

Docker-box : Web Interface to manage full blown docker containers and images

More...

Using Django's built in signals and writing custom signals.

Need any Help in your Project?Let's Talk

Is Django best framework for your web application development

How to maintain user session across sub domains in Django

What is Django CRM and it’s advantages

Implementation of single sign on using auth0 in django application

Customizing Django REST API Serializers

How to implement TokenBasedAuthentication in DjangoRestFramework?

Understanding middleware functionality in django2.0

Django acceptance testing automation with robot framework

How to filter a Django Queryset using Extra

how to pass extra context data to serializers in django-rest-framework ?

Overriding Django Model behaviour with Proxy Model

Understanding Routers in Django-Rest-Framework

Django Single Sign On(SSO) to multiple applications

How to Document API Requests using Django Rest Swagger

Django webpacker - A compression tool to bundles css, js files

What's great about Django girls to inspire women into programming

How to use nested formsets in django

How to convert xml content into json using xmltodict

Custom validations for serializer fields Django Rest Framework

How To Add A Custom Managers In Django

Introduction to API development using Django REST framework with Example

Django-REST Framework Object Level Permissions and User Level Permissions

Using Python weasyprint generate HTML to PDF in django

How to create thumbnail image in Django templates using sorl-thumbnail?

Deploying Your Django app on Heroku

Django Template language Intro

Using Gitlab API, integrating gitlab in django project for authentication and access

Sorl-thumbnail to generate thumbnails in django

Django Conditional Expressions in Queries

Querying with Django Q objects

How to Create initial django migrations for existing DB schema.

Integration Of GitHub API with python django

Django Unit Test cases with Forms and Views

Django - Database access optimization

How To Write Custom migrations in Django

Dynamically Adding Google Maps with Marker In Django

Django - migrating from function based views to class based views

Integration Of Linkedin API in python django

Understanding Checkout flow in Django Oscar.

Django efficient implementation of Amazon s3 and Cloudfront CDN for faster loading.

How to monitor django application live events with sentry

How to create Custom User Model or Extend User Model in Django?

Working with Django Plugins

Export html web page to pdf using jspdf

Preserve file names with sorl for better SEO

Custom Password Less Authentication in Django

Improving page speed score in Google Page Score test- PART2

Extract text with OCR for all image types in python using pytesseract

Factory Boy - An alternative for Fixtures

Improving page speed score in Google Page Score test- PART1

Integration of 2checkout with django

Get count, average, min, max values from model field using Django Aggregate

Set Up Travis CI For Django project

Sending emails using sendgrid on heroku for a Django App

Django Custom Template Tags And Filters

Generic, functional based and class based views in Django REST Framework

Python Memcached Implementation for Django project

How to customize Django Oscar Models, Views and URL's

Integrate Django-Oscar-Accounts with Django-Oscar

Google plus API integration with django

Extract data from PDF and all Microsoft Office files in python

django Payu Payment gateway Integration

Running Django with PyPy to boost performance

How to Create your own e-commerce shop using Django-Oscar.

Setting Up Coveralls for Django Project

Sendgrid Inbound Email Parsing with django

How to customize the admin actions in list pages of Django admin?

Handling Custom Error Pages(404, 500) In Django

Autocomplete with Django-Haystack and Elasticsearch with single letter querying.

How to create Periodic Tasks with Django Celery?

Best Practices of Using Django Celery in Django Social Auth

Custom Decorators To Check User Roles And Permissions In Django

Implement search with Django-haystack and Elasticsearch Part-1

How to index binary files in django haystack

Understanding django serializers with examples

Introduction to Django's Class based views - Understanding how a class based view works

Understanding Django Permissions And Groups

Django Inclusion Tags