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

.. code-block:: bash

$ pip install django-dirtyfields

Usage

To use django-dirtyfields, you need to:

Inherit from DirtyFieldsMixin in the Django model you want to track.

.. code-block:: python

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

.. code-block:: python

>>> 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 <https://django-dirtyfields.readthedocs.io/>_ for more information.

Keywords

FAQs

What is django-dirtyfields?

Is django-dirtyfields well maintained?

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install