-
-
Notifications
You must be signed in to change notification settings - Fork 25
/
setup.py
executable file
·631 lines (524 loc) · 20.7 KB
/
setup.py
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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
#!/usr/bin/env python3
"""python-libzim (openZIM/libzim binding for Python)
The project is compiled in two steps:
1. Cython: compile the cython format files (.pyx, .pyd) to C++ (.cpp and .h)
2. Cythonize: compile the generated C++ to a python-importable binary extension .so
The Cython and Cythonize compilation is done automatically by the build backend"""
from __future__ import annotations
import os
import pathlib
import platform as sysplatform
import re
import shutil
import subprocess
import sys
import sysconfig
import tarfile
import urllib.request
import zipfile
from ctypes.util import find_library
from pathlib import Path
from Cython.Build import cythonize
from Cython.Distutils.build_ext import new_build_ext as build_ext
from setuptools import Command, Extension, setup
class Config:
libzim_dl_version: str = os.getenv("LIBZIM_DL_VERSION", "9.2.3-2")
use_system_libzim: bool = bool(os.getenv("USE_SYSTEM_LIBZIM") or False)
download_libzim: bool = not bool(os.getenv("DONT_DOWNLOAD_LIBZIM") or False)
# toggle profiling for coverage report in Cython
profiling: bool = os.getenv("PROFILE", "0") == "1"
# macOS signing
should_sign_apple: bool = bool(os.getenv("SIGN_APPLE") or False)
apple_signing_identity: str = os.getenv("APPLE_SIGNING_IDENTITY") or ""
apple_signing_keychain: str = os.getenv("APPLE_SIGNING_KEYCHAIN_PATH") or ""
apple_signing_keychain_profile: str = (
os.getenv("APPLE_SIGNING_KEYCHAIN_PROFILE") or ""
)
# windows
_msvc_debug: bool = bool(os.getenv("MSVC_DEBUG"))
supported_platforms = { # noqa: RUF012
"Darwin": ["x86_64", "arm64"],
"Linux": ["x86_64", "aarch64"],
"Linux-musl": ["x86_64", "aarch64"],
"Windows": ["amd64"],
}
base_dir: pathlib.Path = Path(__file__).parent
# Avoid running cythonize on `setup.py clean` and similar
buildless_commands: tuple[str, ...] = (
"clean",
"repair_win_wheel",
"--help",
"egg_info",
"--version",
"download_libzim",
"build_sdist",
"sdist",
)
@property
def libzim_major(self) -> str:
# assuming nightlies are for version 8.x
return "9" if self.is_nightly else self.libzim_dl_version[0]
@property
def found_libzim(self) -> str:
return find_library("zim") or ""
@property
def is_latest_nightly(self) -> bool:
"""will use redirect to latest available nightly"""
return self.libzim_dl_version == "nightly"
@property
def is_nightly(self) -> bool:
return self.is_latest_nightly or bool(
re.match(r"\d{4}-\d{2}-\d{2}", self.libzim_dl_version)
)
@property
def platform(self) -> str:
"""Platform building for: Darwin, Linux"""
return sysplatform.system()
@property
def platform_libc(self) -> str:
"""Platform adjusted for libc variant: Darwin, Linux, Linux-musl"""
if self.platform == "Linux" and self.is_musl:
return "Linux-musl"
return self.platform
@property
def arch(self) -> str:
# macOS x86_64|arm64 - linux x86_64|aarch64
# when using cibuildwheel on macOS to cross-compile,
# `_PYTHON_HOST_PLATFORM` contains
# a platform string like macosx-11.0-arm64
# we extract the cross-compile arch from it
return (
os.getenv("_PYTHON_HOST_PLATFORM", "").rsplit("-", 1)[-1]
or sysplatform.machine().lower()
)
def check_platform(self):
if (
self.platform_libc not in self.supported_platforms
or self.arch not in self.supported_platforms[self.platform_libc]
):
raise NotImplementedError(
f"Platform {self.platform_libc}/{self.arch} is not supported."
)
@property
def libzim_fname(self):
"""binary libzim dynamic library fname (platform dependent)"""
# assuming we'll always link to same major
return {
"Darwin": f"libzim.{self.libzim_major}.dylib",
"Linux": f"libzim.so.{self.libzim_major}",
"Windows": f"zim-{self.libzim_major}.dll",
}[self.platform]
@property
def archive_suffix(self):
if self.platform == "Windows":
return ".zip"
return ".tar.gz"
@property
def archive_format(self):
return {".zip": "zip", ".tar.gz": "gztar"}.get(self.archive_suffix)
@property
def is_musl(self) -> bool:
"""whether running on a musl system (Alpine)"""
ps = subprocess.run(
["/usr/bin/env", "ldd", "--version"],
capture_output=True,
text=True,
check=False,
)
try:
return "musl libc" in ps.stderr.splitlines()[0]
except Exception:
return False
@property
def wants_universal(self) -> bool:
"""whether requesting a macOS universal build"""
return self.platform == "Darwin" and sysconfig.get_platform().endswith(
"universal2"
)
@property
def use_msvc_debug(self) -> bool:
"""whether to add _DEBUG define to compilation
requires having python debug binaries installed.
mandatory for compiling against libzim nighlies"""
return self._msvc_debug or self.is_nightly
def get_download_filename(self, arch: str | None = None) -> str:
"""filename to download to get binary libzim for platform/arch"""
arch = arch or self.arch
# believe this is incorrect naming at openZIM ; will open ticket
if self.platform == "Windows" and arch == "amd64":
arch = "x86_64"
lzplatform = {"Darwin": "macos", "Linux": "linux", "Windows": "win"}.get(
self.platform
)
variant = ""
if self.platform == "Linux":
variant = "-musl" if self.is_musl else "-manylinux"
if self.is_latest_nightly:
version_suffix = ""
else:
version_suffix = f"-{self.libzim_dl_version}"
return pathlib.Path(
f"libzim_{lzplatform}-{arch}{variant}{version_suffix}{self.archive_suffix}"
).name
def download_to_dest(self):
"""download expected libzim binary into libzim/ and libzim/include/ folders"""
self.check_platform()
if self.wants_universal:
folders = {}
for arch in self.supported_platforms["Darwin"]:
folders[arch] = self._download_and_extract(
self.get_download_filename(arch)
)
try:
# duplicate x86_64 tree as placeholder (removing first)
folder = folders["x86_64"].with_name(
folders["x86_64"].name.replace("x86_64", "universal")
)
shutil.rmtree(folder, ignore_errors=True)
shutil.copytree(
folders["x86_64"],
folder,
symlinks=True,
ignore_dangling_symlinks=True,
)
# delete libzim from copied tree
dest = folder / "lib" / self.libzim_fname
dest.unlink()
# create universal from all archs
subprocess.run(
["/usr/bin/env", "lipo"]
+ [
str(folder / "lib" / self.libzim_fname)
for folder in folders.values()
]
+ ["-output", str(dest), "-create"],
check=True,
)
finally:
# clean-up temp folders
for _folder in folders.values():
shutil.rmtree(_folder, ignore_errors=True)
else:
folder = self._download_and_extract(self.get_download_filename())
self._install_from(folder)
def _download_and_extract(self, filename: str) -> pathlib.Path:
"""folder it downloaded and extracted libzim dist to"""
fpath = self.base_dir / filename
source_url = "http://download.openzim.org/release/libzim"
if self.is_latest_nightly:
source_url = "http://download.openzim.org/nightly"
elif self.is_nightly:
source_url = f"http://download.openzim.org/nightly/{self.libzim_dl_version}"
url = f"{source_url}/{fpath.name}"
# download a local copy if none present
if not fpath.exists():
print(f"> from {url}")
with (
urllib.request.urlopen(url) as response, # noqa: S310
open(fpath, "wb") as fh, # nosec
): # nosec
fh.write(response.read())
else:
print(f"> reusing local file {fpath}")
print("> extracting archive")
# nightly have different download name and extracted folder name as it
# uses a redirect
if self.is_latest_nightly:
if self.archive_format == "zip":
zf = zipfile.ZipFile(fpath)
folder = pathlib.Path(pathlib.Path(zf.namelist()[0]).parts[0])
else:
tf = tarfile.open(fpath)
folder = pathlib.Path(pathlib.Path(tf.getmembers()[0].name).parts[0])
else:
folder = fpath.with_name(fpath.name.replace(self.archive_suffix, ""))
# unless for ZIP, extract to current folder (all files inside an in-tar folder)
extract_to = folder if self.archive_format == "zip" else self.base_dir
shutil.unpack_archive(fpath, extract_to, self.archive_format)
return folder
def _install_from(self, folder: pathlib.Path):
"""move headers and libzim binary from dist folder to expected location"""
libzim_dir = self.base_dir / "libzim"
# remove existing headers if present
self.base_dir.joinpath("include").mkdir(parents=True, exist_ok=True)
shutil.rmtree(self.base_dir / "include" / "zim", ignore_errors=True)
# copy new zim headers
(self.base_dir / "include").mkdir(exist_ok=True, parents=True)
shutil.move(folder / "include" / "zim", self.base_dir / "include" / "zim")
# copy new libs (from lib/, lib/<arch> or lib64/)
for fpath in folder.rglob("lib*/**/libzim.*"):
print(f"{fpath} -> {libzim_dir / fpath.name}")
os.replace(fpath, libzim_dir / fpath.name)
# windows has different folder and name
for fpath in (
list(folder.joinpath("bin").rglob("zim-*.dll"))
+ list(folder.joinpath("bin").rglob("icu*.dll"))
+ list(folder.joinpath("lib").rglob("zim.lib"))
):
print(f"{fpath} -> {libzim_dir / fpath.name}")
os.replace(fpath, libzim_dir / fpath.name)
# remove temp folder
shutil.rmtree(folder, ignore_errors=True)
assert self.base_dir.joinpath("include", "zim", "zim.h").exists() # noqa: S101
if config.platform == "Darwin":
print("> ensure libzim is notarized")
spctl = subprocess.run(
[
"/usr/bin/env",
"spctl",
"-a",
"-v",
"-t",
"install",
str(self.base_dir / "libzim" / config.libzim_fname),
],
check=False,
)
if spctl.returncode != 0:
print(
"libzim binary is not notarized! Not an official release?",
file=sys.stderr,
)
def cleanup(self):
"""removes created files to prevent re-run issues"""
# we downloaded libzim, so we must remove it
if self.download_libzim:
print("removing downloaded libraries")
for fpath in self.dylib_file.parent.glob("*.[dylib|so|dll|lib|pc]*"):
print(">", fpath)
fpath.unlink(missing_ok=True)
if self.header_file.parent.exists():
print("removing downloaded headers")
shutil.rmtree(self.header_file.parent, ignore_errors=True)
def repair_windows_wheel(self, wheel: Path, dest_dir: Path):
"""opens windows wheels in target folder and moves all DLLs files inside
subdirectories of the wheel to the root one (where wrapper is expected)"""
from delocate.wheeltools import InWheel
# we're only interested in windows wheels
if not re.match(r"libzim-.+-win_.+", wheel.stem):
return
dest_wheel = dest_dir / wheel.name
with InWheel(str(wheel), str(dest_wheel)) as wheel_dir_path:
print(f"repairing {wheel.name} for Windows (DLLs next to wrapper)")
wheel_dir = Path(wheel_dir_path)
for dll in wheel_dir.joinpath("libzim").rglob("*.dll"):
print(f"> moving {dll} using {dll.relative_to(wheel_dir).parent}")
dll.replace(wheel_dir / dll.name)
@property
def header_file(self) -> pathlib.Path:
return self.base_dir / "include" / "zim" / "zim.h"
@property
def dylib_file(self) -> pathlib.Path:
return self.base_dir / "libzim" / self.libzim_fname
@property
def can_sign_apple(self) -> bool:
return all(
[
self.platform == "Darwin",
self.apple_signing_identity,
self.apple_signing_keychain,
self.apple_signing_keychain_profile,
self.should_sign_apple,
]
)
config = Config()
def get_cython_extension() -> list[Extension]:
define_macros: list[tuple[str, str | None]] = []
compiler_directives = {"language_level": "3"}
if config.profiling:
define_macros += [("CYTHON_TRACE", "1"), ("CYTHON_TRACE_NOGIL", "1")]
compiler_directives.update(linetrace="true")
include_dirs: list[str] = []
library_dirs: list[str] = []
runtime_library_dirs: list[str] = []
if config.use_system_libzim:
if not config.found_libzim:
raise OSError(
"[!] The libzim library cannot be found.\n"
"Please verify it is correctly installed and can be found."
)
print(
f"Using found library at {config.found_libzim}. "
"Adjust CFLAGS/LDFLAGS if needed"
)
else:
if config.download_libzim:
print("Downloading libzim. Set `DONT_DOWNLOAD_LIBZIM` not to.")
config.download_to_dest()
# Check for the CPP Libzim library headers in expected directory
if not config.header_file.exists() or not config.dylib_file.exists():
raise OSError(
"Unable to find a local copy of libzim "
f"at {config.header_file} and {config.dylib_file}"
)
print("Using local libzim binary. Set `USE_SYSTEM_LIBZIM` otherwise.")
include_dirs.append("include")
library_dirs = ["libzim"]
if config.platform != "Windows":
runtime_library_dirs = (
[f"@loader_path/libzim/{config.libzim_fname}"]
if config.platform == "Darwin"
else ["$ORIGIN/libzim/"]
)
extra_compile_args = ["-std=c++11", "-Wall"]
if config.platform == "Windows":
extra_compile_args.append("/MDd" if config.use_msvc_debug else "/MD")
...
else:
extra_compile_args.append("-Wextra")
wrapper_extension = Extension(
name="libzim",
sources=["libzim/libzim.pyx", "libzim/libwrapper.cpp"],
include_dirs=include_dirs,
libraries=["zim"],
library_dirs=library_dirs,
runtime_library_dirs=runtime_library_dirs,
extra_compile_args=extra_compile_args,
language="c++",
define_macros=define_macros,
)
return cythonize([wrapper_extension], compiler_directives=compiler_directives)
class LibzimBuildExt(build_ext):
def finalize_options(self):
"""Workaround for rpath bug in distutils for macOS"""
super().finalize_options()
if config.platform == "Darwin":
# Special treatment of rpath in case of OSX, to work around python
# distutils bug 36353. This constructs proper rpath arguments for clang.
# See https://bugs.python.org/issue36353
for path in self.rpath:
for ext in self.extensions:
ext.extra_link_args.append("-Wl,-rpath," + path)
self.rpath[:] = []
def build_extension(self, ext):
"""Properly set rpath on macOS and optionaly trigger macOS signing"""
super().build_extension(ext)
if config.platform == "Darwin" and not config.use_system_libzim:
# use install_name_tool to properly set the rpath on the wrapper
# so it finds libzim in a subfolder
# for ext in self.extensions:
fpath = self.get_ext_fullpath(ext.name)
subprocess.run(
[
"/usr/bin/env",
"install_name_tool",
"-change",
config.libzim_fname,
f"@loader_path/libzim/{config.libzim_fname}",
str(fpath),
],
check=True,
)
if config.platform == "Darwin" and config.should_sign_apple:
self.sign_extension_macos(ext)
def sign_extension_macos(self, ext):
"""sign and notarize extension on macOS"""
print("Signing & Notarization of the extension")
if not config.can_sign_apple:
raise OSError("Can't sign for apple. Missing information")
ext_fpath = pathlib.Path(self.get_ext_fullpath(ext.name))
print("> signing the extension")
subprocess.run(
[
"/usr/bin/env",
"codesign",
"--force",
"--sign",
config.apple_signing_identity,
str(ext_fpath),
"--deep",
"--timestamp",
],
check=True,
)
print("> create ZIP package for notarization request")
ext_zip = ext_fpath.with_name(f"{ext_fpath.name}.zip")
subprocess.run(
[
"/usr/bin/env",
"ditto",
"-c",
"-k",
"--keepParent",
str(ext_fpath),
str(ext_zip),
],
check=True,
)
print("> request notarization")
# security unlock-keychain -p mysecretpassword $(pwd)/build.keychain
subprocess.run(
[
"/usr/bin/env",
"xcrun",
"notarytool",
"submit",
"--keychain",
config.apple_signing_keychain,
"--keychain-profile",
config.apple_signing_keychain_profile,
"--wait",
ext_zip,
],
check=True,
)
print("> removing zip file")
ext_zip.unlink()
print("> displaying request status (should be rejected)")
subprocess.run(
[
"/usr/bin/env",
"spctl",
"--assess",
"-vv",
"--type",
"install",
str(ext_fpath),
],
check=False,
)
class DownloadLibzim(Command):
"""dedicated command to solely download libzim binary"""
user_options = [] # noqa: RUF012
def initialize_options(self): ...
def finalize_options(self): ...
def run(self):
config.download_to_dest()
class LibzimClean(Command):
user_options = [] # noqa: RUF012
def initialize_options(self): ...
def finalize_options(self): ...
def run(self):
config.cleanup()
class RepairWindowsWheel(Command):
user_options = [ # noqa: RUF012
("wheel=", None, "Wheel to repair"),
("destdir=", None, "Destination folder for repaired wheels"),
]
def initialize_options(self):
self.wheel: str = ""
self.destdir: str = ""
def finalize_options(self):
assert ( # noqa: S101
self.wheel and Path(self.wheel).exists()
), "wheel file does not exists"
assert self.destdir and ( # noqa: S101
Path(self.destdir).exists() and Path(self.destdir).is_dir()
), "dest_dir does not exists"
def run(self):
config.repair_windows_wheel(wheel=Path(self.wheel), dest_dir=Path(self.destdir))
if len(sys.argv) == 1 or (
len(sys.argv) >= 2 and sys.argv[1] in config.buildless_commands # noqa: PLR2004
):
ext_modules = []
else:
ext_modules = get_cython_extension()
setup(
cmdclass={
"build_ext": LibzimBuildExt,
"download_libzim": DownloadLibzim,
"clean": LibzimClean,
"repair_win_wheel": RepairWindowsWheel,
},
ext_modules=ext_modules,
)