Skip to main content

Canonical JSON

Project description

Latest Version


  • Encodes objects and arrays as RFC 7159 JSON.
  • Sorts object keys so that you get the same result each time.
  • Has no insignificant whitespace to make the output as small as possible.
  • Escapes only the characters that must be escaped, U+0000 to U+0019 / U+0022 / U+0056, to keep the output as small as possible.
  • Uses the shortest escape sequence for each escaped character.
  • Encodes the JSON as UTF-8.
  • Can encode frozendict immutable dictionaries.

Supports Python versions 3.5 and newer.


pip install canonicaljson


To encode an object into the canonicaljson:

import canonicaljson
assert canonicaljson.encode_canonical_json({}) == b'{}'

There’s also an iterator version:

import canonicaljson
assert b''.join(canonicaljson.iterencode_canonical_json({})) == b'{}'

The underlying JSON implementation can be chosen with the following:

import json
import canonicaljson


By default canonicaljson uses simplejson under the hood (except for PyPy, which uses the standard library json module).

Project details

Download files

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

Files for canonicaljson, version 1.4.0
Filename, size File type Python version Upload date Hashes
Filename, size canonicaljson-1.4.0-py3-none-any.whl (7.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size canonicaljson-1.4.0.tar.gz (9.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page