jsoncanon

A Python library that creates a canonicalized version of a JSON document for uniqueness checking, hashing, and cryptography

Note: Do NOT use this in a production environment yet, still working on performance and a formal standard for sorting lists

Usage

Basic usage

import jsoncanon

doc1 = {
    "def": [5, 2, 1, 7],
    "abc": 123
}

doc2 = {
    "abc": 123,
    "def": [5, 2, 1, 7]
}

jsoncanon.dumps(doc1)
jsoncanon.dumps(doc2)
jsoncanon.dumps(doc, sort_lists=True)

yields

{"abc":123,"def":[5,2,1,7]}
{"abc":123,"def":[5,2,1,7]}

and

{"abc":123,"def":[1,2,5,7]}

respectively.

Excluded Keys

import jsoncanon

doc1 = {
    "_id": "a4337bc45a8fc544c03f52dc550",
    "name": "Robert Paulson",
    "age": 55
}

jsoncanon.dumps(doc1, excluded_keys=['_id'])

yeilds

{"age":55,"name":"Robert Paulson"}

Benchmark Report

name	rank	runs	mean	sd	timesBaseline
json module	1	5	0.2205	0.06855	1.0
jsoncanon	2	5	2.571	0.1222	11.6598209591
jsoncanon sorting lists	3	5	6.916	2.016	31.3608244859

Each of the above 15 runs were run in random, non-consecutive order by benchmark v0.1.5 (http://jspi.es/benchmark) with Python 2.7.6 Darwin-13.1.0-x86_64 on 2014-05-18 21:53:23

nathanjordan/jsoncanon

jsoncanon

Usage

Benchmark Report