django-dirtyfields

What it is and what it does

Django Dirty Fields is a mixin that tracks in-memory changes to Django model instances, letting you detect which fields differ from their database values without querying the database. You inherit from DirtyFieldsMixin on any model, then call is_dirty() to check if the instance has unsaved changes or get_dirty_fields() to retrieve a dictionary of changed field names and their original values.

This is useful for conditional logic around saves, audit trails, or avoiding unnecessary database writes. The package has been in production use since its early releases and is tested against a wide range of Django and Python versions. It requires only Django as a dependency and installs as a lightweight pure-Python wheel.

Use it for

• Check if a model instance has unsaved changes before deciding whether to call save().
• Audit which fields were modified on an instance for logging or change-tracking systems.
• Conditionally trigger side effects only when specific fields change.
• Implement undo/rollback logic by comparing dirty fields to their original database values.
• Validate that certain fields have not been modified before allowing a save operation.

Worth the install?

AI-flagged interpretation of the facts on this page. Verify before relying on it.

Install

django-dirtyfields on PyPI

Before you install

Low friction: pure Python wheel with only Django as a runtime dependency. Actively maintained with recent commits and compatible across Django 3.2 through 6.0 and Python 3.10–3.14.

License in practice

BSD-3-Clause permissive license allows commercial and private use with minimal restrictions beyond attribution and liability disclaimers.

Quickstart

pip install django-dirtyfields

from django.db import models
from dirtyfields import DirtyFieldsMixin

class ExampleModel(DirtyFieldsMixin, models.Model):
    boolean = models.BooleanField(default=True)

model = ExampleModel.objects.create(boolean=True)
model.boolean = False
model.is_dirty()  # True
model.get_dirty_fields()  # {'boolean': True}

Package facts

Evidence: django_dirtyfields-1.9.9-py3-none-any.whl

Tags

More Python Modules packages

See also django-auditlog · django-lifecycle · django-model-utils · django-perf-rec · django-test-plus · django-read-only · django-concurrency · django-pghistory · django-picklefield · django-fsm-log