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 |
|---|---|
2.2, 3.0, 3.1 |
3.8, 3.9 |
3.2, 4.0 |
3.8, 3.9, 3.10 |
4.1 |
3.8, 3.9, 3.10, 3.11 |
4.2 |
3.8, 3.9, 3.10, 3.11, 3.12 |
5.0 |
3.10, 3.11, 3.12 |
Install
$ pip install django-dirtyfieldsUsage
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 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.
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.9.3-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | efeeb49c5b36a982eb44e0aa03a9e4619ad0b48da36c9101cdca8175f5e416ed |
|
| MD5 | 7de98b493e6f56ba4f10f84700eb800a |
|
| BLAKE2b-256 | 91972b8beefe1a41aa25912079f0f91754983b35615287a7e3ddd8c18d5624ea |
