Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

Tracking dirty fields on a Django model instance

Project Description

Tracking changed fields on a Django model instance.

Makes a Mixin available that will give you the properties:

  • is_dirty
  • dirty_fields


Install the package using pip. Then use the instructions in “Using the Mixin in the Model”.

$ pip install django-dirtyfields

or if you’re interested in developing it, use virtualenv. The default will look for the dirtyfields package in its current location.

$ virtualenv --no-site-packages ve/
$ source ve/bin/activate
(ve)$ cd example_app
(ve)$ pip install -r requirements.pip
(ve)$ ./ test testing_app

Using the Mixin in the Model

from django.db import models
from dirtyfields import DirtyFieldsMixin

class TestModel(DirtyFieldsMixin, models.Model):
    """A simple test model to test dirty fields mixin with"""
    boolean = models.BooleanField(default=True)
    characters = models.CharField(blank=True, max_length=80)

Using it in the shell

(ve)$ ./ shell
>>> from testing_app.models import TestModel
>>> tm = TestModel(boolean=True, characters="testing")
>>> tm.is_dirty
>>> tm.dirty_fields
>>> tm.boolean = False
>>> tm.is_dirty
>>> tm.dirty_fields
('boolean', )
>>> tm.characters = "have changed"
>>> tm.is_dirty
>>> tm.dirty_fields
('boolean', 'characters', )
>>> tm.is_dirty
>>> tm.get_dirty_fields

Why would you want this?

When using signals, especially pre_save, it is useful to be able to see what fields have changed or not. A signal could change its behaviour depending on whether a specific field has changed, whereas otherwise, you only could work on the event that the model’s save() method had been called.


This code has largely be adapted from what was made available at Stack Overflow.

Release History

This version
History Node


History Node


History Node


Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, Size & Hash SHA256 Hash Help File Type Python Version Upload Date
(8.5 kB) Copy SHA256 Hash SHA256
Source None Mar 27, 2013

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Google Google Cloud Servers