Skip to content
Tracking dirty fields on a Django model
Python
Latest commit 47e29a0 @romgar Merge pull request #56 from mr-tron/develop
fix bytea support for postrgesql
Failed to load latest commit information.
docs Updating package version for PyPI deployment
src/dirtyfields fix
tests Updating references from old smn repo to new urls
.gitignore Initialise sphinx configuration
.travis.yml
AUTHORS add an AUTHORS file and update setup.py
CLASSIFIERS.txt wrong classifier
ChangeLog.rst Updating package version for PyPI deployment
LICENSE BSD
MANIFEST.in
README.rst Adding badge for documentation
requirements.txt
setup.py Updating package version for PyPI deployment
tox.ini Add travis coverage for django14 by avoiding python3 testing in that …

README.rst

Django Dirty Fields

Join the chat at https://gitter.im/romgar/django-dirtyfields https://travis-ci.org/romgar/django-dirtyfields.svg?branch=develop https://coveralls.io/repos/romgar/django-dirtyfields/badge.svg?branch=develop http://readthedocs.org/projects/django-dirtyfields/badge/?version=develop

Tracking dirty fields on a Django model instance.

Dirty means that there is a difference between field value in the database and the one we currently have on a model instance.

Documentation

Install

$ pip install django-dirtyfields

Usage

To use django-dirtyfields, you need to:

  • Inherit from DirtyFieldMixin in the Django model you want to track.
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)
  • Use one of these 2 functions on a model instance to know if this instance is dirty, and get the dirty fields:

    • is_dirty()
    • get_dirty_fields()

Example

>>> from tests.models import TestModel
>>> tm = TestModel.objects.create(boolean=True,characters="testing")
>>> tm.is_dirty()
False
>>> tm.get_dirty_fields()
{}

>>> tm.boolean = False

>>> tm.is_dirty()
True
>>> tm.get_dirty_fields()
{'boolean': True}

Checking foreign key fields.

By default, dirty functions are not checking foreign keys. If you want to also take these relationships into account, use check_relationship parameter:

>>> from tests.models import TestModel
>>> tm = TestModel.objects.create(fkey=obj1)
>>> tm.is_dirty()
False
>>> tm.get_dirty_fields()
{}

>>> tm.fkey = obj2

>>> tm.is_dirty()
False
>>> tm.is_dirty(check_relationship=True)
True

>>> tm.get_dirty_fields()
{}
>>> tm.get_dirty_fields(check_relationship=True)
{'fkey': 1}

Saving dirty fields.

If you want to only save dirty fields from an instance in the database (only these fields will be involved in SQL query), you can use save_dirty_fields method.

Warning: this save_dirty_fields method will trigger the same signals as django default save method. But, in django 1.4.22-, as we are using under the hood an update method, we need to manually send these signals, so be aware that only sender and instance arguments are passed to the signal in that context.

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.

Contributing

If you're interested in developing it, you can launch project tests on that way:

$ pip install tox
$ pip install -e .
$ tox

Credits

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

Something went wrong with that request. Please try again.