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 |
|---|---|
| 2.0, 2.1 | 3.7 |
| 2.2, 3.0, 3.1 | 3.7, 3.8, 3.9 |
| 3.2 | 3.7, 3.8, 3.9, 3.10 |
| 4.0 | 3.8, 3.9, 3.10 |
| 4.1, 4.2 | 3.8, 3.9, 3.10, 3.11 |
Install
$ pip install django-dirtyfieldsUsage
To use django-dirtyfields, you need to:
- Inherit from
DirtyFieldsMixinin the Django model you want to track.
from django.db import models
from dirtyfields import DirtyFieldsMixin
class ExampleModel(DirtyFieldsMixin, models.Model):
"""A simple example 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
>>> model = ExampleModel.objects.create(boolean=True,characters="first value")
>>> model.is_dirty()
False
>>> model.get_dirty_fields()
{}
>>> model.boolean = False
>>> model.characters = "second value"
>>> model.is_dirty()
True
>>> model.get_dirty_fields()
{'boolean': True, "characters": "first_value"}Consult the full documentation for more information.