Skip to main content

Watch modification of any type of field in Django’s model and call registered callback function

This observer can watch

  • Any value type of field (CharField, IntegerField …)

  • Any Model type of field (ForeignKey, OneToOneField, GenericForeignKey)

  • Any RelatedManager type of field (field automatically created via related_name of ForeignKey)

  • Any ManyRelatedManager type of field (ManyToManyField)

  • Any GenericRelatedObjectManager type of field (GenericRelation)

  • Any Model instance

Install

This library is on PyPI so you can install it with:

pip install django-observer

or from github:

pip install git+https://github.com/lambdalisue/django-observer.git

Usage

>>> from django.db import models
>>> from observer import watch
>>>
>>> class Entry(models.Model):
...     status = models.CharFiled('status', max_length=10)
...     body = models.CharField('title', max_length=100)
...
...     def save(self, *args, **kwargs):
...         super(Entry, self).save(*args, **kwargs)
...
...         # Watch callback, this is automatically called if `status` is **changed**
...         def watch_callback(sender, obj, attr):
...             # sender is a watcher instance
...             # obj is a instance of target
...             # attr is a name of target field
...             if obj.status == 'draft':
...                 obj.title = "draft - %s" % obj.body
...             else:
...                 obj.title = "publish - %s" % obj.body
...         # Start watching
...         self._watcher = watch(self, 'status', watch_callback)

See observer_test/src/miniblog/blog/tests/test_observer.py for more detail.

Settings

OBSERVER_DEFAULT_WATCHER

A class of watcher. Default is ‘observer.watcher.complex.ComplexWatcher’

Metadata

Release files for django-observer 0.4.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-observer 0.4.3
File Size Uploaded
django-observer-0.4.3.tar.gz 7.4 kB Details

Release files / django-observer-0.4.3.tar.gz

Download URL django-observer-0.4.3.tar.gz
Size 7.4 kB
Tags Source
SHA-256 checksum
How to use checksums
7760e5609bea5fe1340928f3160e368c6a444c94614a3058a6707768c0171791
BLAKE2b-256 checksum
How to use checksums
c7954e8d30e622af00055fd242833031e177476610db27d4385f6375752891bb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page