Features
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 be configured to encode custom types unknown to the stdlib JSON encoder.
Supports Python versions 3.7 and newer.
Installing
pip install canonicaljsonUsing
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
canonicaljson.set_json_library(json)A preserialisation hook allows you to encode objects which aren’t encodable by the standard library JSONEncoder.
import canonicaljson
from typing import Dict
class CustomType:
pass
def callback(c: CustomType) -> Dict[str, str]:
return {"Hello": "world!"}
canonicaljson.register_preserialisation_callback(CustomType, callback)
assert canonicaljson.encode_canonical_json(CustomType()) == b'{"Hello":"world!"}'5 maintainers
Release files for canonicaljson 2.0.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 | |
|---|---|---|---|
| canonicaljson-2.0.0.tar.gz | 10.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| canonicaljson-2.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 18.6 kB
Release files / canonicaljson-2.0.0.tar.gz
| Download URL | canonicaljson-2.0.0.tar.gz |
|---|---|
| Size | 10.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e2fdaef1d7fadc5d9cb59bd3d0d41b064ddda697809ac4325dced721d12f113f
|
|
BLAKE2b-256 checksum How to use checksums |
a8f22835b7ab464988d1f85e351a19c4d6b2e4c317ba8484ebd2a311850eab8c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.2
|
Release files / canonicaljson-2.0.0-py3-none-any.whl
| Download URL | canonicaljson-2.0.0-py3-none-any.whl |
|---|---|
| Size | 7.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c38a315de3b5a0532f1ec1f9153cd3d716abfc565a558d00a4835428a34fca5b
|
|
BLAKE2b-256 checksum How to use checksums |
e554346f681c24a9c3a08e2e74dcee2555ccd1081705b46f791f7b228e177d06
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.2
|
