django-dirtyfields

by romgar

Tracking dirty fields on a Django model

437 Stars 98 Forks Last release: Not found Other 400 Commits 18 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

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

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://travis-ci.org/romgar/django-dirtyfields.svg?branch=develop :target: https://travis-ci.org/romgar/django-dirtyfields?branch=develop .. image:: https://coveralls.io/repos/romgar/django-dirtyfields/badge.svg?branch=develop :target: https://coveralls.io/r/romgar/django-dirtyfields?branch=develop .. image:: http://readthedocs.org/projects/django-dirtyfields/badge/?version=develop :target: http://django-dirtyfields.readthedocs.org/en/develop/?badge=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.7, 3.5, 3.6, 3.7 (added in 1.11.17) | +---------------+---------------------------------------+ | 2.0, 2.1, 2.2 | 3.5, 3.6, 3.7 | +---------------+---------------------------------------+

Full documentation 
_

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 TestModel(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 TestModel
>>> tm = TestModel.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 informations.

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.