Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/romgar/django-dirtyfields
Tracking dirty fields on a Django model
https://github.com/romgar/django-dirtyfields
django python
Last synced: 4 days ago
JSON representation
Tracking dirty fields on a Django model
- Host: GitHub
- URL: https://github.com/romgar/django-dirtyfields
- Owner: romgar
- License: bsd-3-clause
- Created: 2010-09-09T06:54:09.000Z (over 14 years ago)
- Default Branch: develop
- Last Pushed: 2024-11-09T05:15:58.000Z (about 2 months ago)
- Last Synced: 2024-12-14T23:00:09.186Z (11 days ago)
- Topics: django, python
- Language: Python
- Homepage:
- Size: 468 KB
- Stars: 630
- Watchers: 12
- Forks: 111
- Open Issues: 14
-
Metadata Files:
- Readme: README.rst
- Changelog: ChangeLog.rst
- Contributing: docs/contributing.rst
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
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://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=latest
:alt: Read the Docs documentation status
:target: https://django-dirtyfields.readthedocs.io/en/latest/
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 |
+========================+===================================+
| 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 `_ for more information.