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.0, 2.1 | 3.6, 3.7 |
2.2, 3.0, 3.1 | 3.6, 3.7, 3.8, 3.9 |
3.2 | 3.6, 3.7, 3.8, 3.9, 3.10 |
$ pip install django-dirtyfields
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 ModelTest(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()
>>> from tests.models import ModelTest
>>> tm = ModelTest.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 information.