1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
# 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 distutils.ccompiler
import distutils.command.build_ext
import distutils.extension
import distutils.util
import glob
import os
import shutil
import subprocess
import sys
ext_includes = [
"c-ext",
]
ext_sources = [
"c-ext/backend_c.c",
]
def get_c_extension(
support_legacy=False,
system_zstd=False,
name="zstandard.backend_c",
warnings_as_errors=False,
root=None,
):
"""Obtain a distutils.extension.Extension for the C extension.
``support_legacy`` controls whether to compile in legacy zstd format support.
``system_zstd`` controls whether to compile against the system zstd library.
For this to work, the system zstd library and headers must match what
python-zstandard is coded against exactly.
``name`` is the module name of the C extension to produce.
``warnings_as_errors`` controls whether compiler warnings are turned into
compiler errors.
``root`` defines a root path that source should be computed as relative
to. This should be the directory with the main ``setup.py`` that is
being invoked. If not defined, paths will be relative to this file.
"""
actual_root = os.path.abspath(os.path.dirname(__file__))
root = root or actual_root
sources = sorted(set([os.path.join(actual_root, p) for p in ext_sources]))
local_include_dirs = [os.path.join(actual_root, d) for d in ext_includes]
if not system_zstd:
local_include_dirs.append(os.path.join(actual_root, "zstd"))
depends = sorted(glob.glob(os.path.join(actual_root, "c-ext", "*")))
compiler = distutils.ccompiler.new_compiler()
# Needed for MSVC.
if hasattr(compiler, "initialize"):
compiler.initialize()
if compiler.compiler_type == "unix":
compiler_type = "unix"
elif compiler.compiler_type == "msvc":
compiler_type = "msvc"
elif compiler.compiler_type == "mingw32":
compiler_type = "mingw32"
else:
raise Exception("unhandled compiler type: %s" % compiler.compiler_type)
extra_args = []
if system_zstd:
extra_args.append("-DZSTD_MULTITHREAD")
else:
extra_args.append("-DZSTD_SINGLE_FILE")
extra_args.append("-DZSTDLIB_VISIBLE=")
extra_args.append("-DZDICTLIB_VISIBLE=")
extra_args.append("-DZSTDERRORLIB_VISIBLE=")
if compiler_type == "unix":
extra_args.append("-fvisibility=hidden")
if not system_zstd and support_legacy:
extra_args.append("-DZSTD_LEGACY_SUPPORT=1")
if warnings_as_errors:
if compiler_type in ("unix", "mingw32"):
extra_args.append("-Werror")
elif compiler_type == "msvc":
extra_args.append("/WX")
else:
assert False
libraries = ["zstd"] if system_zstd else []
# Python 3.7 doesn't like absolute paths. So normalize to relative.
sources = [os.path.relpath(p, root) for p in sources]
local_include_dirs = [os.path.relpath(p, root) for p in local_include_dirs]
depends = [os.path.relpath(p, root) for p in depends]
if "ZSTD_EXTRA_COMPILER_ARGS" in os.environ:
extra_args.extend(
distutils.util.split_quoted(os.environ["ZSTD_EXTRA_COMPILER_ARGS"])
)
# TODO compile with optimizations.
return distutils.extension.Extension(
name,
sources,
include_dirs=local_include_dirs,
depends=depends,
extra_compile_args=extra_args,
libraries=libraries,
)
class RustExtension(distutils.extension.Extension):
def __init__(self, name, root):
super().__init__(name, [])
self.root = root
self.depends.extend(
[
os.path.join(root, "Cargo.toml"),
os.path.join(root, "rust-ext", "src", "lib.rs"),
]
)
def build(self, build_dir, get_ext_path_fn):
env = os.environ.copy()
env["PYTHON_SYS_EXECUTABLE"] = sys.executable
# Needed for try_reserve()
env["RUSTC_BOOTSTRAP"] = "1"
args = [
"cargo",
"build",
"--release",
"--target-dir",
str(build_dir),
]
subprocess.run(args, env=env, cwd=self.root, check=True)
dest_path = get_ext_path_fn(self.name)
libname = self.name.split(".")[-1]
if os.name == "nt":
rust_lib_filename = "%s.dll" % libname
elif sys.platform == "darwin":
rust_lib_filename = "lib%s.dylib" % libname
else:
rust_lib_filename = "lib%s.so" % libname
rust_lib = os.path.join(build_dir, "release", rust_lib_filename)
os.makedirs(os.path.dirname(rust_lib), exist_ok=True)
shutil.copy2(rust_lib, dest_path)
class RustBuildExt(distutils.command.build_ext.build_ext):
def build_extension(self, ext):
if isinstance(ext, RustExtension):
ext.build(
build_dir=os.path.abspath(self.build_temp),
get_ext_path_fn=self.get_ext_fullpath,
)
else:
super().build_extension(ext)
def get_rust_extension(
root=None,
):
actual_root = os.path.abspath(os.path.dirname(__file__))
root = root or actual_root
return RustExtension("zstandard.backend_rust", root)
|
