Skip to main content

Python package for serializing tables in portable format with Capnp.

Project description

PortableTab

Python 3.7 Python 3.8 Python 3.9 Python 3.10 Python 3.11 Python 3.12

PortableTab is a Python library that allows for serialization of typed tables into a set of files, as well as deserialization of specific rows extracted from the files.

Features

The serialized files are independent of OS and CPU architecture, so it can be used to create portable table which is useful when working with large datasets that need to be shared between different systems or environments.

It also allows fast deserialization of only specified rows without loading the entire table into memory, so it does not take time to load and deserialize the table on the first access, nor consume memory during execution.

  • Capn' Proto is used for serialization, making the file format portable.
  • Since PortableTab uses mmap for file access, it does not consume much memory even when handling large tables.
  • Indexes on strings are created using Marisa-trie, the output files are also portable and accessible using mmap.

Limitations

The tables are serialized into compact files so they cannot be dynamically modified.

  • Rows can only be retrieved at their specified position. If you want to access by an attribute such as id, you must create an index on that attribute.
  • Updating records in serialized files is possible but very slow.
  • It is not possible to insert rows in the middle of a serialized file. If you want to insert rows in the middle, the only way is to deserialize the entire table and recreate another table.

How to use

Please refer to the documentation at PortableTab Document.

Development status

Unstable alpha version.

License

This package is available according to the MIT license.

Author

Takeshi SAGARA sagara@info-proto.com

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

portabletab-0.3.5.tar.gz (10.3 kB view hashes)

Uploaded Source

Built Distribution

portabletab-0.3.5-py3-none-any.whl (12.8 kB view hashes)

Uploaded Python 3

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