Add 'data' field into Notification model

This commit is contained in:
zzy 2015-03-20 19:03:41 +08:00
parent a2cd0a8726
commit e244ba3ec0
6 changed files with 109 additions and 11 deletions

View file

@ -37,3 +37,5 @@ Jesper Håkansson (https://github.com/drager)
Fábio C. Barrionuevo da Luz (https://github.com/luzfcb)
fay (https://github.com/fay)
blag (https://github.com/blag)
Zhongyuan Zhang (https://github.com/zhang-z)

View file

@ -113,7 +113,6 @@ Extra data
You can attach arbitrary data to your notifications by doing the following:
* Install a compatible JSONField application.
* Add to your settings.py: ``NOTIFY_USE_JSONFIELD=True``
Then, any extra arguments you pass to ``notify.send(...)`` will be attached to the ``.data`` attribute of the notification object. These will be serialised using the JSONField's serialiser, so you may need to take that into account: using only objects that will be serialised is a good idea.

View file

@ -0,0 +1,21 @@
# -*- coding: utf-8 -*-
from __future__ import unicode_literals
from django.db import models, migrations
import jsonfield.fields
class Migration(migrations.Migration):
dependencies = [
('notifications', '0002_auto_20150224_1134'),
]
operations = [
migrations.AddField(
model_name='notification',
name='data',
field=jsonfield.fields.JSONField(null=True, blank=True),
preserve_default=True,
),
]

View file

@ -9,6 +9,7 @@ from .utils import id2slug
from .signals import notify
from model_utils import managers, Choices
from jsonfield.fields import JSONField
now = datetime.datetime.now
if getattr(settings, 'USE_TZ'):
@ -115,6 +116,7 @@ class Notification(models.Model):
deleted = models.BooleanField(default=False)
emailed = models.BooleanField(default=False)
data = JSONField(blank=True, null=True)
objects = managers.PassThroughManager.for_queryset_class(NotificationQuerySet)()
class Meta:
@ -158,15 +160,7 @@ class Notification(models.Model):
self.unread = True
self.save()
EXTRA_DATA = False
if getattr(settings, 'NOTIFY_USE_JSONFIELD', False):
try:
from jsonfield.fields import JSONField
except ImportError:
raise ImproperlyConfigured("You must have a suitable JSONField installed")
JSONField(blank=True, null=True).contribute_to_class(Notification, 'data')
EXTRA_DATA = True
EXTRA_DATA = getattr(settings, 'NOTIFY_USE_JSONFIELD', False)
def notify_handler(verb, **kwargs):

View file

@ -0,0 +1,81 @@
# -*- coding: utf-8 -*-
from south.utils import datetime_utils as datetime
from south.db import db
from south.v2 import SchemaMigration
from django.db import models
class Migration(SchemaMigration):
def forwards(self, orm):
# Adding field 'Notification.data'
db.add_column(u'notifications_notification', 'data',
self.gf('jsonfield.fields.JSONField')(null=True, blank=True),
keep_default=False)
def backwards(self, orm):
# Deleting field 'Notification.data'
db.delete_column(u'notifications_notification', 'data')
models = {
u'auth.group': {
'Meta': {'object_name': 'Group'},
u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '80'}),
'permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': u"orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'})
},
u'auth.permission': {
'Meta': {'ordering': "(u'content_type__app_label', u'content_type__model', u'codename')", 'unique_together': "((u'content_type', u'codename'),)", 'object_name': 'Permission'},
'codename': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
'content_type': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['contenttypes.ContentType']"}),
u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
'name': ('django.db.models.fields.CharField', [], {'max_length': '50'})
},
u'auth.user': {
'Meta': {'object_name': 'User'},
'date_joined': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
'email': ('django.db.models.fields.EmailField', [], {'max_length': '75', 'blank': 'True'}),
'first_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}),
'groups': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "u'user_set'", 'blank': 'True', 'to': u"orm['auth.Group']"}),
u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
'is_active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
'is_staff': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
'is_superuser': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
'last_login': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
'last_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}),
'password': ('django.db.models.fields.CharField', [], {'max_length': '128'}),
'user_permissions': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "u'user_set'", 'blank': 'True', 'to': u"orm['auth.Permission']"}),
'username': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '30'})
},
u'contenttypes.contenttype': {
'Meta': {'ordering': "('name',)", 'unique_together': "(('app_label', 'model'),)", 'object_name': 'ContentType', 'db_table': "'django_content_type'"},
'app_label': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
'model': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
'name': ('django.db.models.fields.CharField', [], {'max_length': '100'})
},
u'notifications.notification': {
'Meta': {'ordering': "('-timestamp',)", 'object_name': 'Notification'},
'action_object_content_type': ('django.db.models.fields.related.ForeignKey', [], {'blank': 'True', 'related_name': "'notify_action_object'", 'null': 'True', 'to': u"orm['contenttypes.ContentType']"}),
'action_object_object_id': ('django.db.models.fields.CharField', [], {'max_length': '255', 'null': 'True', 'blank': 'True'}),
'actor_content_type': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'notify_actor'", 'to': u"orm['contenttypes.ContentType']"}),
'actor_object_id': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
'data': ('jsonfield.fields.JSONField', [], {'null': 'True', 'blank': 'True'}),
'deleted': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
'description': ('django.db.models.fields.TextField', [], {'null': 'True', 'blank': 'True'}),
'emailed': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
'level': ('django.db.models.fields.CharField', [], {'default': "'info'", 'max_length': '20'}),
'public': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
'recipient': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'notifications'", 'to': u"orm['auth.User']"}),
'target_content_type': ('django.db.models.fields.related.ForeignKey', [], {'blank': 'True', 'related_name': "'notify_target'", 'null': 'True', 'to': u"orm['contenttypes.ContentType']"}),
'target_object_id': ('django.db.models.fields.CharField', [], {'max_length': '255', 'null': 'True', 'blank': 'True'}),
'timestamp': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
'unread': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
'verb': ('django.db.models.fields.CharField', [], {'max_length': '255'})
}
}
complete_apps = ['notifications']

View file

@ -11,7 +11,8 @@ setup(name='django-notifications-hq',
install_requires=[
'django>=1.4',
'django-model-utils>=2.0.3',
'six>=1.9.0'
'six>=1.9.0',
'jsonfield>=1.0.3',
],
packages=['notifications',
'notifications.templatetags',