emorozov / django-dirtyfields

Tracking dirty fields on a Django model

Django Dirty Fields

Tracking dirty fields on a Django model instance. Dirty means that field in-memory and database values are different.

This package is compatible and tested with the following Python & Django versions:

Django	Python
1.11	2.7, 3.5, 3.6, 3.7 (added in 1.11.17)
2.0, 2.1, 2.2	3.5, 3.6, 3.7

Full documentation

Install

$ pip install django-dirtyfields

Usage

To use django-dirtyfields, you need to:

• Inherit from DirtyFieldsMixin 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}

Consult the full documentation for more informations.