Need help with django-dirtyfields?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

romgar
511 Stars 107 Forks Other 531 Commits 12 Opened issues

Description

Tracking dirty fields on a Django model

Services available

!
?

Need anything else?

Contributors list

===================

Django Dirty Fields

.. image:: https://badges.gitter.im/Join%20Chat.svg :alt: Join the chat at https://gitter.im/romgar/django-dirtyfields :target: https://gitter.im/romgar/django-dirtyfields?utmsource=badge&utmmedium=badge&utmcampaign=pr-badge&utmcontent=badge .. image:: https://img.shields.io/pypi/v/django-dirtyfields.svg :alt: Published PyPI version :target: https://pypi.org/project/django-dirtyfields/ .. image:: https://github.com/romgar/django-dirtyfields/actions/workflows/tests.yml/badge.svg :alt: Github Actions Test status :target: https://github.com/romgar/django-dirtyfields/actions/workflows/tests.yml .. image:: https://coveralls.io/repos/github/romgar/django-dirtyfields/badge.svg?branch=develop :alt: Coveralls code coverage status :target: https://coveralls.io/github/romgar/django-dirtyfields?branch=develop .. image:: https://readthedocs.org/projects/django-dirtyfields/badge/?version=develop :alt: Read the Docs documentation status :target: https://django-dirtyfields.readthedocs.io/en/develop/

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.6, 3.7 | +------------------------+-----------------------------------+ | 2.2, 3.0, 3.1 | 3.6, 3.7, 3.8, 3.9 | +------------------------+-----------------------------------+ | 3.2 | 3.6, 3.7, 3.8, 3.9, 3.10 | +------------------------+-----------------------------------+

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

.. code-block:: python

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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.