Skip to main content

A reusable Django field that allows you to store validated JSON in your model.

Project description

django-jsonfield

django-jsonfield is a reusable Django field that allows you to store validated JSON in your model.

It silently takes care of serialization. To use, simply add the field to one of your models.

New: Python 3 support added!

Install

pip install jsonfield

Usage

from django.db import models
from jsonfield import JSONField

class MyModel(models.Model):
  json = JSONField()

Advanced Usage

By default python deserializes json into dict objects. This behavior differs from the standard json behavior because python dicts do not have ordered keys.

To overcome this limitation and keep the sort order of OrderedDict keys the deserialisation can be adjusted on model initialisation:

import collections
class MyModel(models.Model):
  json = JSONField(load_kwargs={'object_pairs_hook': collections.OrderedDict})

Other Fields

jsonfield.JSONCharField

If you need to use your JSON field in an index or other constraint, you can use JSONCharField which subclasses CharField instead of TextField. You’ll also need to specify a max_length parameter if you use this field.

Contact

http://bradjasper.com

Travis CI

https://travis-ci.org/bradjasper/django-jsonfield.png?branch=master

Changes

v0.9.14/15, 04/29/2013 – Python 3 support added!

v0.9.11/12/13, 03/26/2013 – PyPi changes

v0.9.9/10/11, 03/21/2013 – PyPi changes

v0.9.8, 03/21/2013 – Added support for native PostgreSQL JSON data type

v0.9.7, 03/21/2013 – Fix bug #33 where JSONField didn’t correctly store some values inside of strings

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

jsonfield-0.9.15.tar.gz (6.0 kB view details)

Uploaded Source

File details

Details for the file jsonfield-0.9.15.tar.gz.

File metadata

  • Download URL: jsonfield-0.9.15.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for jsonfield-0.9.15.tar.gz
Algorithm Hash digest
SHA256 b853963844cf82f9a63e69eee27b5a0dcc4802048f9d42048a9cd4f4d1bd2c30
MD5 f14f61d98720538d9feb155d677dccf6
BLAKE2b-256 3bd9b9ff542f04eff0dc32f6a5b86c485ba6a744f3cabfcc1dac57a5304ea3a9

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