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](http://web.archive.org/web/20140721022102/http://blog.picloud.com/2013/11/17/picloud-has-joined-dropbox/) 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.4.3.tar.gz (23.1 kB view details)

Uploaded Source

Built Distribution

cloudpickle-0.4.3-py2.py3-none-any.whl (15.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for cloudpickle-0.4.3.tar.gz
Algorithm Hash digest
SHA256 ffba0fc0c368e658aeca074467c7c1f6d0614424ad6ec895f194b8ad566bfda1
MD5 2b61ba76b9b93530d3fef46dcf0932b7
BLAKE2b-256 160f89d15ca27a628cc612960928b19c31a9bdaa1d78fb4fa43bc24bd51cb363

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cloudpickle-0.4.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ba9728367d7ea7f1e6b9a6b70846224b61cf1237dac9e146645cbd511f5db727
MD5 4f5ac273a6436d0deef01f5c2969c1d3
BLAKE2b-256 7fcd47b28a4d1632e6b72c7aec002b8ec19d1f5db0d3c7b4d63af6de432aa89a

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