Skip to main content

Watch any object/field/relation/generic relation of django and recive signals

Project description

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’

Project details


Download files

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

Source Distribution

django-observer-0.4.1.tar.gz (19.3 kB view details)

Uploaded Source

File details

Details for the file django-observer-0.4.1.tar.gz.

File metadata

File hashes

Hashes for django-observer-0.4.1.tar.gz
Algorithm Hash digest
SHA256 967857182281e424e2d3442ab90ff361c9f8a27fddae73d3de5bab0c7ddba1b0
MD5 a8f680e631c103e081c8f20385defa19
BLAKE2b-256 e6ed4490cdd7eb5bd92472009d88877cd8d8b2bc34fd21f4983bf0ea084e0aa9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page