Skip to main content

Extended pickling support for Python objects

Project description

# cloudpickle

[![Build Status](https://travis-ci.org/cloudpipe/cloudpickle.svg?branch=master
)](https://travis-ci.org/cloudpipe/cloudpickle)
[![codecov.io](https://codecov.io/github/cloudpipe/cloudpickle/coverage.svg?branch=master)](https://codecov.io/github/cloudpipe/cloudpickle?branch=master)

`cloudpickle` makes it possible to serialize Python constructs not supported
by the default `pickle` module from the Python standard library.

`cloudpickle` is especially useful for cluster computing where Python
expressions are shipped over the network to execute on remote hosts, possibly
close to the data.

Among other things, `cloudpickle` supports pickling for lambda expressions,
functions and classes defined interactively in the `__main__` module.


Installation
------------

The latest release of `cloudpickle` is available from
[pypi](https://pypi.python.org/pypi/cloudpickle):

pip install cloudpickle


Examples
--------

Pickling a lambda expression:

```python
>>> import cloudpickle
>>> squared = lambda x: x ** 2
>>> pickled_lambda = cloudpickle.dumps(squared)

>>> import pickle
>>> new_squared = pickle.loads(pickled_lambda)
>>> new_squared(2)
4
```

Pickling a function interactively defined in a Python shell session
(in the `__main__` module):

```python
>>> CONSTANT = 42
>>> def my_function(data):
... return data + CONSTANT
...
>>> pickled_function = cloudpickle.dumps(my_function)
>>> pickle.loads(pickled_function)(43)
85
```

Running the tests
-----------------

- With `tox`, to test run the tests for all the supported versions of
Python and PyPy:

pip install tox
tox

or alternatively for a specific environment:

tox -e py27


- With `py.test` to only run the tests for your current version of
Python:

pip install -r dev-requirements.txt
PYTHONPATH='.:tests' py.test


History
-------

`cloudpickle` was initially developed by picloud.com and shipped as part of
the client SDK.

A copy of `cloudpickle.py` was included as part of PySpark, the Python
interface to [Apache Spark](https://spark.apache.org/). Davies Liu, Josh
Rosen, Thom Neale and other Apache Spark developers improved it significantly,
most notably to add support for PyPy and Python 3.

The aim of the `cloudpickle` project is to make that work available to a wider
audience outside of the Spark ecosystem and to make it easier to improve it
further notably with the help of a dedicated non-regression test suite.

Download files

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

Source Distribution

cloudpickle-0.2.1.tar.gz (15.5 kB view details)

Uploaded Source

Built Distribution

cloudpickle-0.2.1-py2.py3-none-any.whl (12.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file cloudpickle-0.2.1.tar.gz.

File metadata

  • Download URL: cloudpickle-0.2.1.tar.gz
  • Upload date:
  • Size: 15.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for cloudpickle-0.2.1.tar.gz
Algorithm Hash digest
SHA256 eea4b655e6aed3dba39b104ad1872226e3f9e23d8d202fc003f3e65f2d125c3b
MD5 d6c92acdfa253a50b2ef86a1b6443e39
BLAKE2b-256 4e3940a2862086fdd55eb1881a499a834bfae98ce70f272ed19385f4c74ebe7c

See more details on using hashes here.

File details

Details for the file cloudpickle-0.2.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for cloudpickle-0.2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3938c171c3cc232622df167e3f8db593ea7dc964bceb441548466f93db037991
MD5 f13f2b9ac7e013a453522fe8d867f002
BLAKE2b-256 6473167e991c906b4f2ecd7b1eeba3de9878194d3120049f4104571c97882d04

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page