========== python-lz4

状态

.. image:: https://github.com/python-lz4/python-lz4/actions/workflows/build_dist.yml/badge.svg :target: https://github.com/python-lz4/python-lz4/actions/workflows/build_dist.yml :alt: 构建状态

.. image:: https://readthedocs.org/projects/python-lz4/badge/?version=stable :target: https://readthedocs.org/projects/python-lz4/ :alt: 文档

.. image:: https://codecov.io/gh/python-lz4/python-lz4/branch/codecov/graph/badge.svg :target: https://codecov.io/gh/python-lz4/python-lz4 :alt: 代码覆盖率

简介

本软件包提供了 LZ4 压缩库 <https://lz4.github.io/lz4/>_ 的 Python 绑定。

本软件包中提供的生产就绪型绑定涵盖了 帧格式 <https://github.com/lz4/lz4/blob/master/doc/lz4_Frame_format.md>_ 和 块格式 <https://github.com/lz4/lz4/blob/dev/doc/lz4_Block_format.md>_ 规范。推荐使用帧格式绑定，因为它可确保与其他实现和语言绑定的互操作性。

还包含了针对 流格式 <https://github.com/lz4/lz4/blob/master/examples/streaming_api_basics.md>_ 规范的实验性绑定，但这些绑定仍需进一步完善。

帧格式绑定提供的 API 遵循 Python 标准库中 LZMA、zlib、gzip 和 bzip2 压缩库的 API。因此，这些 LZ4 绑定应可作为 Python 自带压缩库的即插即用替代品。该软件包提供上下文管理器和文件处理程序支持。

调用底层 LZ4 库时，绑定会释放 GIL，并且是线程安全的。软件包中包含了一套全面的测试套件。

文档

.. image:: https://readthedocs.org/projects/python-lz4/badge/?version=stable :target: https://readthedocs.org/projects/python-lz4/ :alt: 文档

项目包含完整文档。文档使用 Sphinx 生成，同时也托管在 Read the Docs 上。

:master: http://python-lz4.readthedocs.io/en/stable/ :development: http://python-lz4.readthedocs.io/en/latest/

主页

项目主页 <https://www.github.com/python-lz4/python-lz4>_ 托管在 Github 上。如发现任何问题，请通过 问题跟踪器 <https://github.com/python-lz4/python-lz4/issues>_ 进行报告。

许可协议

本项目特定代码遵循 BSD 3-Clause 许可协议 <http://opensource.org/licenses/BSD-3-Clause>_。