django-model-changes allows you to track model instance changes.
Project description
django-model-changes allows you to track the state and changes of a model instance:
- current_state()
The current state of the instance.
- previous_state()
The state of the instance after it was created, saved or deleted the last time.
- ancient_state()
The previous previous_state(), i.e. the state of the instance before it was created, saved or deleted the last time.
Quick start
Install django-model-changes:
pip install django-model-changes
Add “django_model_changes” to your INSTALLED_APPS setting like this:
INSTALLED_APPS = ( ... 'django_model_changes', )
Add the ChangesMixin to your model:
>>> from django.db import models >>> from django_model_changes import ChangesMixin >>> class User(ChangesMixin, models.Model): >>> name = models.CharField(max_length=100)
Get instance changes:
>>> user = User() >>> user.name = 'Foo Bar' >>> user.save() >>> user.name 'I got a new name' >>> # Get current state >>> user.current_state() {'id': 1, 'name': 'I got a new name'} >>> # Get previous state (state after previous save/create/delete) >>> user.previous_state() {'id': 1, 'name': 'Foo Bar'} >>> # Get ancient state (state before previous save/create/delete) >>> user.ancient_state() {'id': None, 'name': ''} >>> # Get changes from the previous state to the current state >>> user.changes() {'name': ('Foo Bar', 'I got a new name')} >>> # Get changes from the ancient state to the current state >>> user.changes_from_ancient_state() {'id': (None, 1), 'name': ('', 'Foo Bar')} >>> # Check if the instance was persisted (saved) >>> user.was_persisted() False >>> # Check if the instance is persisted >>> user.is_persisted() True
Listen for changes:
>>> from django_model_changes import post_change
>>> def my_callback(sender, instance, **kwargs): >>> # Do something with previous and current state >>> instance.ancient_state() >>> instance.current_state()
>>> # There is also a convenience method to get >>> # an instance from the previous state >>> instance.ancient_instance()
>>> post_change.connect(my_callback, User)
Documentation
Refer to the doc strings in changes.py, or build the documentation:
>>> pip install Sphinx >>> cd docs >>> make html Open build/html/index.html
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.