Tracking dirty fields on a Django model instance.
Project description
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.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 |
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 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()
Example
>>> 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django_dirtyfields-1.8.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 84750ad11b6555100c0cd60057a9317c1f078dde3f65d51d0867e11894fb25a2 |
|
MD5 | ec83a5c4fc1f0a7a466b7cfe119c0632 |
|
BLAKE2b-256 | a5037b388c24280faa558ecebee810c4d1d1020920b9adddb2d1d13571735e9d |