Tracking dirty fields on a Django model instance.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for romgar from gravatar.com romgar Avatar for smn from gravatar.com smn

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: BSD License (Copyright (c) Praekelt Foundation and individual contributors.)
  • Author: Romain Garrigues
  • Maintainer: Lincoln Puzey
  • Tags django, dirtyfields, track, model, changes
  • Requires: Python >=3.9
Classifiers
Report project as malware

Project description

Join the chat at https://gitter.im/romgar/django-dirtyfields Published PyPI version Github Actions Test status Coveralls code coverage status Read the Docs documentation status

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.9

3.2, 4.0

3.9, 3.10

4.1

3.9, 3.10, 3.11

4.2

3.9, 3.10, 3.11, 3.12

5.0

3.10, 3.11, 3.12

5.1

3.10, 3.11, 3.12, 3.13

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 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.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page