Skip to main content

Optimized format for pickling binary data.

Project description

BinPickle - efficient binary pickled data

PyPI version Test and Build codecov

This package uses the new Pickle Protocol 5 added in Python 3.8 to efficiently serialize large objects, particularly from scientific Python packages, to an on-disk format. This format is designed to support two use cases:

  1. Serializing data-intensive statistical models in a memory-mappable format so multiple processes can share the same (read-only) model memory.
  2. Serializing data-intensive statistical models with good compression for long-term storage and cross-machine transportation.

BinPickle does this by using Pickle 5's out-of-band buffer serialization support to write buffers uncompressed and page-aligned for memory mapping (use case 1) or with per-buffer efficient compression with libraries like Blosc (use case 2).

Format Stability

We do not yet guarantee the stability of the BinPickle format. We will avoid gratuitous changes, but BinPickle 1.0 will be the first with a stability guarantee.

Acknowledgements

This material is based upon work supported by the National Science Foundation under Grant No. IIS 17-51278. Any opinions, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation. This page has not been approved by Boise State University and does not reflect official university positions.

Project details


Download files

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

Source Distribution

binpickle-0.4.0a2.tar.gz (22.9 kB view details)

Uploaded Source

Built Distribution

binpickle-0.4.0a2-py3-none-any.whl (13.8 kB view details)

Uploaded Python 3

File details

Details for the file binpickle-0.4.0a2.tar.gz.

File metadata

  • Download URL: binpickle-0.4.0a2.tar.gz
  • Upload date:
  • Size: 22.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.0

File hashes

Hashes for binpickle-0.4.0a2.tar.gz
Algorithm Hash digest
SHA256 4d45ec2a8b5aa489807ef3ec8d51c2133b735d2833816d0a5d9852fd9eadbfdc
MD5 3cf36bc41759dfcdee7386952bf89fc8
BLAKE2b-256 dd823225eae38af11d07c8fbc7fd64e0b7a5e2babeec08660b236383d5a1e760

See more details on using hashes here.

File details

Details for the file binpickle-0.4.0a2-py3-none-any.whl.

File metadata

  • Download URL: binpickle-0.4.0a2-py3-none-any.whl
  • Upload date:
  • Size: 13.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.0

File hashes

Hashes for binpickle-0.4.0a2-py3-none-any.whl
Algorithm Hash digest
SHA256 1e7ab9bdc08cf5e4c59007bc37bea3c42a8ed78a3534fa462a9ba757df29b8b0
MD5 a2b12e289e2bc8ac1b2cc25bc7b2e690
BLAKE2b-256 94d96794567b6a584147f7d49241b0f0362ac3631b0d6066666e59de7cd20786

See more details on using hashes here.

Supported by

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