jsonfield is a reusable model field that allows you to store validated JSON, automatically handling serialization to and from the database. To use, add jsonfield.JSONField to one of your models.
Deprecation & Migration to Django’s native JSONField
Django 3.1 introduced a native JSONField that supports all database backends. As such, this package is considered deprecated and will be archived in the future. Existing projects should migrate to Django’s implemenation.
Migrating from jsonfield.JSONField to models.JSONField should generally be straightforward. After swapping field classes, python manage.py migrate will generate AlterField operations that should correctly migrate your field data. However, if this does not work for your case, you will instead need to create a data migration. The process will roughly look like:
Rename <field> to old_<field>, create migration.
Add a nullable <field> = models.JSONField(null=True, ...), create migration.
Create an empty migration file, add RunPython operation that reserializes the old_<field> data into the new <field>.
Update <field> to not nullable, delete old_<field>, create migration.
Manually combine the operations into a single migration file.
Examples can be found in the migration-example project.
Installation
pip install jsonfieldUsage
from django.db import models
from jsonfield import JSONField
class MyModel(models.Model):
json = JSONField()Querying
As stated above, JSONField is not intended to provide extended querying capabilities. That said, you may perform the same basic lookups provided by regular text fields (e.g., exact or regex lookups). Since values are stored as serialized JSON, it is highly recommended that you test your queries to ensure the expected results are returned.
Handling null values
A model field’s null argument typically controls whether null values may be stored in its column by setting a not-null constraint. However, because JSONField serializes its values (including nulls), this option instead controls how null values are persisted. If null=True, then nulls are not serialized and are stored as a null value in the database. If null=False, then the null is instead stored in its serialized form.
This in turn affects how null values may be queried. Both fields support exact matching:
MyModel.objects.filter(json=None)However, if you want to use the isnull lookup, you must set null=True.
class MyModel(models.Model):
json = JSONField(null=True)
MyModel.objects.filter(json__isnull=True)Note that as JSONField.null does not prevent nulls from being stored, achieving this must instead be handled with a validator.
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
Subclasses models.CharField instead of models.TextField.
Running the tests
The test suite requires tox.
$ pip install toxThen, run the tox command, which will run all test jobs.
$ toxOr, to test just one job (for example Django 5.2 on Python 3.13):
$ tox -e py313-django52Release Process
Update changelog
Update package version in setup.py
Check supported versions in setup.py and readme
Create git tag for version
Upload release to PyPI test server
Upload release to official PyPI server
$ pip install -U pip setuptools wheel twine
$ rm -rf dist/ build/
$ python setup.py sdist bdist_wheel
$ twine upload -r test dist/*
$ twine upload dist/*Changes
Take a look at the changelog.
2 maintainers
Release files for jsonfield 3.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| jsonfield-3.2.0.tar.gz | 17.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| jsonfield-3.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 25.5 kB
Release files / jsonfield-3.2.0.tar.gz
| Download URL | jsonfield-3.2.0.tar.gz |
|---|---|
| Size | 17.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ca53871bc3308ae4f4cddc3b4f99ed5c6fc6abb1832fbfb499bc6da566c70e4a
|
|
BLAKE2b-256 checksum How to use checksums |
fae9537e105246dba81d898853dbbe17eb3edd23d47a35074b99fd4add6f1662
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.5
|
Release files / jsonfield-3.2.0-py3-none-any.whl
| Download URL | jsonfield-3.2.0-py3-none-any.whl |
|---|---|
| Size | 8.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ca4f6bf89c819f293e77074d613c0021e3c4e8521be95c73d03caecb4372e1ee
|
|
BLAKE2b-256 checksum How to use checksums |
0a222e08e7b957f50e5eceefde018ce9ee88aceb5126231128d9c1cb8167c1c8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.5
|
