mirror of
https://github.com/facebook/sapling.git
synced 2024-10-07 23:38:50 +03:00
2005375cdc
As the commit message for the previous changeset says, we wish for zstd to be a 1st class citizen in Mercurial. To make that happen, we need to enable Python to talk to the zstd C API. And that requires bindings. This commit vendors a copy of existing Python bindings. Why do we need to vendor? As the commit message of the previous commit says, relying on systems in the wild to have the bindings or zstd present is a losing proposition. By distributing the zstd and bindings with Mercurial, we significantly increase our chances that zstd will work. Since zstd will deliver a better end-user experience by achieving better performance, this benefits our users. Another reason is that the Python bindings still aren't stable and the API is somewhat fluid. While Mercurial could be coded to target multiple versions of the Python bindings, it is safer to bundle an explicit, known working version. The added Python bindings are mostly a fully-featured interface to the zstd C API. They allow one-shot operations, streaming, reading and writing from objects implements the file object protocol, dictionary compression, control over low-level compression parameters, and more. The Python bindings work on Python 2.6, 2.7, and 3.3+ and have been tested on Linux and Windows. There are CFFI bindings, but they are lacking compared to the C extension. Upstream work will be needed before we can support zstd with PyPy. But it will be possible. The files added in this commit come from Git commit e637c1b214d5f869cf8116c550dcae23ec13b677 from https://github.com/indygreg/python-zstandard and are added without modifications. Some files from the upstream repository have been omitted, namely files related to continuous integration. In the spirit of full disclosure, I'm the maintainer of the "python-zstandard" project and have authored 100% of the code added in this commit. Unfortunately, the Python bindings have not been formally code reviewed by anyone. While I've tested much of the code thoroughly (I even have tests that fuzz APIs), there's a good chance there are bugs, memory leaks, not well thought out APIs, etc. If someone wants to review the code and send feedback to the GitHub project, it would be greatly appreciated. Despite my involvement with both projects, my opinions of code style differ from Mercurial's. The code in this commit introduces numerous code style violations in Mercurial's linters. So, the code is excluded from most lints. However, some violations I agree with. These have been added to the known violations ignore list for now.
65 lines
1.6 KiB
Python
65 lines
1.6 KiB
Python
# Copyright (c) 2016-present, Gregory Szorc
|
|
# All rights reserved.
|
|
#
|
|
# This software may be modified and distributed under the terms
|
|
# of the BSD license. See the LICENSE file for details.
|
|
|
|
import os
|
|
from distutils.extension import Extension
|
|
|
|
|
|
zstd_sources = ['zstd/%s' % p for p in (
|
|
'common/entropy_common.c',
|
|
'common/error_private.c',
|
|
'common/fse_decompress.c',
|
|
'common/xxhash.c',
|
|
'common/zstd_common.c',
|
|
'compress/fse_compress.c',
|
|
'compress/huf_compress.c',
|
|
'compress/zbuff_compress.c',
|
|
'compress/zstd_compress.c',
|
|
'decompress/huf_decompress.c',
|
|
'decompress/zbuff_decompress.c',
|
|
'decompress/zstd_decompress.c',
|
|
'dictBuilder/divsufsort.c',
|
|
'dictBuilder/zdict.c',
|
|
)]
|
|
|
|
|
|
zstd_includes = [
|
|
'c-ext',
|
|
'zstd',
|
|
'zstd/common',
|
|
'zstd/compress',
|
|
'zstd/decompress',
|
|
'zstd/dictBuilder',
|
|
]
|
|
|
|
ext_sources = [
|
|
'zstd.c',
|
|
'c-ext/compressiondict.c',
|
|
'c-ext/compressobj.c',
|
|
'c-ext/compressor.c',
|
|
'c-ext/compressoriterator.c',
|
|
'c-ext/compressionparams.c',
|
|
'c-ext/compressionwriter.c',
|
|
'c-ext/constants.c',
|
|
'c-ext/decompressobj.c',
|
|
'c-ext/decompressor.c',
|
|
'c-ext/decompressoriterator.c',
|
|
'c-ext/decompressionwriter.c',
|
|
'c-ext/dictparams.c',
|
|
]
|
|
|
|
|
|
def get_c_extension(name='zstd'):
|
|
"""Obtain a distutils.extension.Extension for the C extension."""
|
|
root = os.path.abspath(os.path.dirname(__file__))
|
|
|
|
sources = [os.path.join(root, p) for p in zstd_sources + ext_sources]
|
|
include_dirs = [os.path.join(root, d) for d in zstd_includes]
|
|
|
|
# TODO compile with optimizations.
|
|
return Extension(name, sources,
|
|
include_dirs=include_dirs)
|