jsonpickle is a library for the two-way conversion of complex Python objects and JSON. jsonpickle builds upon the existing JSON encoders, such as simplejson, json, and demjson.
For complete documentation, please visit the jsonpickle documentation.
Bug reports and merge requests are encouraged at the jsonpickle repository on github.
jsonpickle supports Python 2.7 and Python 3.4 or greater.
WARNING: jsonpickle can execute arbitrary Python code. Do not load jsonpickles from untrusted / unauthenticated sources.
Data serialized with python's pickle (or cPickle or dill) is not easily readable outside of python. Using the json format, jsonpickle allows simple data types to be stored in a human-readable format, and more complex data types such as numpy arrays and pandas dataframes, to be machine-readable on any platform that supports json. E.g., unlike pickled data, jsonpickled data stored in an Amazon S3 bucket is indexible by Amazon's Athena.
Install from pip for the latest stable release:
pip install jsonpickle
Install from github for the latest changes:
pip install git+https://github.com/jsonpickle/jsonpickle.git
If you have the files checked out for development:
git clone https://github.com/jsonpickle/jsonpickle.git cd jsonpickle python setup.py develop
jsonpickle includes a built-in numpy extension. If would like to encode sklearn models, numpy arrays, and other numpy-based data then you must enable the numpy extension by registering its handlers:
>>> import jsonpickle.ext.numpy as jsonpickle_numpy >>> jsonpickle_numpy.register_handlers()
jsonpickle includes a built-in pandas extension. If would like to encode pandas DataFrame or Series objects then you must enable the pandas extension by registering its handlers:
>>> import jsonpickle.ext.pandas as jsonpickle_pandas >>> jsonpickle_pandas.register_handlers()
Licensed under the BSD License. See COPYING for details. See jsonpickleJS/LICENSE for details about the jsonpickleJS license.
Use make to run the unit tests:
pytest is used to run unit tests internally.
A tox target is provided to run tests using tox.
multi=1 tests using all installed and supported Python versions:
make tox make tox multi=1
jsonpickle itself has no dependencies beyond the Python stdlib. tox is required for testing when using the tox test runner only.
The testing requirements are specified in requirements-dev.txt. It is recommended to create a virtualenv and run tests from within the virtualenv, or use a tool such as vx to activate the virtualenv without polluting the shell environment:
python3 -mvenv env3x vx env3x pip install --requirement requirements-dev.txt vx env3x make test
jsonpickle supports multiple Python versions, so using a combination of multiple virtualenvs and tox is useful in order to catch compatibility issues when developing.