cd

caldwell-dirtyfields

Tracking dirty fields on a Django model

Showing:

Popularity

Downloads/wk

0

GitHub Stars

503

Maintenance

Last Commit

1mo ago

Contributors

39

Package

Dependencies

0

License

BSD

Categories

Readme

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

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?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge .. image:: https://img.shields.io/pypi/v/django-dirtyfields.svg :alt: Published PyPI version :target: https://pypi.org/project/django-dirtyfields/ .. image:: https://travis-ci.org/romgar/django-dirtyfields.svg?branch=develop :alt: Travis CI status :target: https://travis-ci.org/romgar/django-dirtyfields .. 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.2 | 3.6, 3.7, 3.8, 3.9 | +------------------------+------------------------+

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

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100