Skip to main content

A library for converting between BSON and JSON.

Project description

View build status
Info:See github for the latest source.
Author:Shane Harvey <shane.harvey@mongodb.com>

About

A fast BSON to MongoDB Extended JSON converter for Python that uses libbson.

Installation

python-bsonjs can be installed with pip:

$ python -m pip install python-bsonjs

Examples

>>> import bsonjs
>>> bson_bytes = bsonjs.loads('{"hello": "world"}')
>>> bson_bytes
'\x16\x00\x00\x00\x02hello\x00\x06\x00\x00\x00world\x00\x00'
>>> bsonjs.dumps(bson_bytes)
'{ "hello" : "world" }'

Using bsonjs with pymongo to insert a RawBSONDocument.

>>> import bsonjs
>>> from pymongo import MongoClient
>>> from bson.raw_bson import RawBSONDocument
>>> client = MongoClient("localhost", 27017, document_class=RawBSONDocument)
>>> db = client.test
>>> bson_bytes = bsonjs.loads('{"_id": 1, "x": 2}')
>>> bson_bytes
'\x15\x00\x00\x00\x10_id\x00\x01\x00\x00\x00\x10x\x00\x02\x00\x00\x00\x00'
>>> result = db.test.insert_one(RawBSONDocument(bson_bytes))
>>> result.inserted_id  # NOTE: inserted_id is None
>>> result.acknowledged
True
>>> raw_doc = db.test.find_one({'x': 2})
>>> raw_doc.raw == bson_bytes
True
>>> bsonjs.dumps(raw_doc.raw)
'{ "_id" : 1, "x" : 2 }'

Speed

bsonjs is roughly 10-15x faster than PyMongo’s json_util at decoding BSON to JSON and encoding JSON to BSON. See benchmark.py:

$ python benchmark.py
Timing: bsonjs.dumps(b)
10000 loops, best of 3: 0.110911846161
Timing: json_util.dumps(bson.BSON(b).decode())
10000 loops, best of 3: 1.46571397781
bsonjs is 13.22x faster than json_util

Timing: bsonjs.loads(j)
10000 loops, best of 3: 0.0628039836884
Timing: bson.BSON().encode(json_util.loads(j))
10000 loops, best of 3: 0.683200120926
bsonjs is 11.72x faster than json_util

Installing From Source

python-bsonjs supports CPython 2.6, 2.7, and 3.3+.

Compiler

You must build python-bsonjs separately for each version of Python. On Windows this means you must use the same C compiler your Python version was built with.

Source

Note that this repository contains a git submodule. You must initialize the submodule by using:

$ git clone --recursive https://github.com/mongodb-labs/python-bsonjs.git

Or, if your version of git does not have clone --recursive:

$ git clone https://github.com/mongodb-labs/python-bsonjs.git
$ cd python-bsonjs
$ git submodule update --init --recursive

Install

Once you have the source properly downloaded, build and install the package:

$ python setup.py install

Test

To run the test suite:

$ python setup.py test

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
python_bsonjs-0.2.0-cp26-cp26m-macosx_10_12_intel.whl (142.8 kB) Copy SHA256 hash SHA256 Wheel cp26
python_bsonjs-0.2.0-cp26-cp26m-manylinux1_i686.whl (238.5 kB) Copy SHA256 hash SHA256 Wheel cp26
python_bsonjs-0.2.0-cp26-cp26m-manylinux1_x86_64.whl (257.6 kB) Copy SHA256 hash SHA256 Wheel cp26
python_bsonjs-0.2.0-cp26-cp26mu-manylinux1_i686.whl (238.5 kB) Copy SHA256 hash SHA256 Wheel cp26
python_bsonjs-0.2.0-cp26-cp26mu-manylinux1_x86_64.whl (257.6 kB) Copy SHA256 hash SHA256 Wheel cp26
python_bsonjs-0.2.0-cp26-cp26m-win32.whl (67.9 kB) Copy SHA256 hash SHA256 Wheel cp26
python_bsonjs-0.2.0-cp26-cp26m-win_amd64.whl (74.1 kB) Copy SHA256 hash SHA256 Wheel cp26
python_bsonjs-0.2.0-cp27-cp27m-macosx_10_12_intel.whl (142.8 kB) Copy SHA256 hash SHA256 Wheel cp27
python_bsonjs-0.2.0-cp27-cp27m-manylinux1_i686.whl (238.4 kB) Copy SHA256 hash SHA256 Wheel cp27
python_bsonjs-0.2.0-cp27-cp27m-manylinux1_x86_64.whl (257.6 kB) Copy SHA256 hash SHA256 Wheel cp27
python_bsonjs-0.2.0-cp27-cp27mu-manylinux1_i686.whl (238.4 kB) Copy SHA256 hash SHA256 Wheel cp27
python_bsonjs-0.2.0-cp27-cp27mu-manylinux1_x86_64.whl (257.6 kB) Copy SHA256 hash SHA256 Wheel cp27
python_bsonjs-0.2.0-cp27-cp27m-win32.whl (67.9 kB) Copy SHA256 hash SHA256 Wheel cp27
python_bsonjs-0.2.0-cp27-cp27m-win_amd64.whl (73.8 kB) Copy SHA256 hash SHA256 Wheel cp27
python_bsonjs-0.2.0-cp33-cp33m-manylinux1_i686.whl (239.5 kB) Copy SHA256 hash SHA256 Wheel cp33
python_bsonjs-0.2.0-cp33-cp33m-manylinux1_x86_64.whl (258.5 kB) Copy SHA256 hash SHA256 Wheel cp33
python_bsonjs-0.2.0-cp33-cp33m-win32.whl (68.3 kB) Copy SHA256 hash SHA256 Wheel cp33
python_bsonjs-0.2.0-cp33-cp33m-win_amd64.whl (73.9 kB) Copy SHA256 hash SHA256 Wheel cp33
python_bsonjs-0.2.0-cp34-cp34m-macosx_10_6_intel.whl (158.4 kB) Copy SHA256 hash SHA256 Wheel cp34
python_bsonjs-0.2.0-cp34-cp34m-manylinux1_i686.whl (239.6 kB) Copy SHA256 hash SHA256 Wheel cp34
python_bsonjs-0.2.0-cp34-cp34m-manylinux1_x86_64.whl (258.7 kB) Copy SHA256 hash SHA256 Wheel cp34
python_bsonjs-0.2.0-cp34-cp34m-win32.whl (68.3 kB) Copy SHA256 hash SHA256 Wheel cp34
python_bsonjs-0.2.0-cp34-cp34m-win_amd64.whl (73.9 kB) Copy SHA256 hash SHA256 Wheel cp34
python_bsonjs-0.2.0-cp35-cp35m-macosx_10_6_intel.whl (158.5 kB) Copy SHA256 hash SHA256 Wheel cp35
python_bsonjs-0.2.0-cp35-cp35m-manylinux1_i686.whl (239.8 kB) Copy SHA256 hash SHA256 Wheel cp35
python_bsonjs-0.2.0-cp35-cp35m-manylinux1_x86_64.whl (258.9 kB) Copy SHA256 hash SHA256 Wheel cp35
python_bsonjs-0.2.0-cp35-cp35m-win32.whl (70.2 kB) Copy SHA256 hash SHA256 Wheel cp35
python_bsonjs-0.2.0-cp35-cp35m-win_amd64.whl (77.3 kB) Copy SHA256 hash SHA256 Wheel cp35
python_bsonjs-0.2.0-cp36-cp36m-macosx_10_6_intel.whl (158.5 kB) Copy SHA256 hash SHA256 Wheel cp36
python_bsonjs-0.2.0-cp36-cp36m-manylinux1_i686.whl (239.8 kB) Copy SHA256 hash SHA256 Wheel cp36
python_bsonjs-0.2.0-cp36-cp36m-manylinux1_x86_64.whl (258.9 kB) Copy SHA256 hash SHA256 Wheel cp36
python-bsonjs-0.2.0.tar.gz (150.7 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page