django-dirtyfields

Tracking dirty fields on a Django model instance.

These details have not been verified by PyPI

Project links

Project description

Join the chat at https://gitter.im/romgar/django-dirtyfields

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

$ pip install django-dirtyfields

Usage

To use django-dirtyfields, you need to:

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

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

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

Project details

These details have not been verified by PyPI

Project links

Release history Release notifications | RSS feed

1.9.3

May 24, 2024

1.9.2

Apr 12, 2023

1.9.1

Jan 14, 2023

1.9.0

Nov 7, 2022

1.8.2

Jul 16, 2022

1.8.1

Mar 7, 2022

1.8.0

Jan 22, 2022

This version

1.7.0

May 2, 2021

1.6.0

Apr 7, 2021

1.5.0

Jan 23, 2021

1.4.1

Nov 28, 2020

1.4

Apr 13, 2020

1.3.1

Feb 28, 2018

1.3

Aug 23, 2017

1.2.1

Nov 16, 2016

1.2

Aug 11, 2016

1.1

Aug 4, 2016

1.0.1

Jul 25, 2016

1.0

Jun 26, 2016

0.9

Jun 18, 2016

0.8.2

Mar 18, 2016

0.8.1

Dec 8, 2015

0.8

Oct 31, 2015

0.7

Jun 18, 2015

0.6.1

Jun 14, 2015

0.6

Jun 11, 2015

0.5

May 8, 2015

0.4.1

Apr 8, 2015

0.4

Mar 31, 2015

0.3

Mar 11, 2014

0.2

Nov 21, 2013

0.1

Jan 21, 2011

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-dirtyfields-1.7.0.tar.gz (9.7 kB view details)

Uploaded May 2, 2021 Source

Built Distribution

django_dirtyfields-1.7.0-py3-none-any.whl (7.5 kB view details)

Uploaded May 2, 2021 Python 3

File details

Details for the file django-dirtyfields-1.7.0.tar.gz.

File metadata

Download URL: django-dirtyfields-1.7.0.tar.gz
Upload date: May 2, 2021
Size: 9.7 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.4.1 importlib_metadata/1.3.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.6.10

File hashes

Hashes for django-dirtyfields-1.7.0.tar.gz
Algorithm	Hash digest
SHA256	`76fd01c69e077fd39f49376d9684d04188b821dafd342bf82d935036ff2f5946`
MD5	`b4631a1e8c7035b044cefd267c2b51a4`
BLAKE2b-256	`2c82cb4f4c7ae322c5acc6ceff18b5a6b28386ccb7580907f0dfffb278e6d42e`

See more details on using hashes here.

Provenance

File details

Details for the file django_dirtyfields-1.7.0-py3-none-any.whl.

File metadata

Download URL: django_dirtyfields-1.7.0-py3-none-any.whl
Upload date: May 2, 2021
Size: 7.5 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.4.1 importlib_metadata/1.3.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.6.10

File hashes

Hashes for django_dirtyfields-1.7.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`ed8d780d439281372ca1dd301b21d6536b950dad3c32f95740e8236c0ed423bc`
MD5	`9248b29d835d11c15cf752ca764b97b3`
BLAKE2b-256	`5cc0aaf3e82a1b6dff5ebf65f7cc92697d9bc10939bae02ac227b2f83137fd9e`