setup.py 4.81 KB
Newer Older
1
2
#!/usr/bin/env python

Dean Moldovan's avatar
Dean Moldovan committed
3
# Setup script for PyPI; use CMakeFile.txt to build extension modules
4

5
import contextlib
6
import os
7
8
9
10
11
import re
import shutil
import string
import subprocess
import sys
12
13
14
from pathlib import Path
from tempfile import TemporaryDirectory
from typing import Dict, Iterator, List, Union
15

16
17
import setuptools.command.sdist

18
DIR = Path(__file__).parent.absolute()
19
20
21
VERSION_REGEX = re.compile(
    r"^\s*#\s*define\s+PYBIND11_VERSION_([A-Z]+)\s+(.*)$", re.MULTILINE
)
22
23
VERSION_FILE = Path("pybind11/_version.py")
COMMON_FILE = Path("include/pybind11/detail/common.h")
24

25

26
def build_expected_version_hex(matches: Dict[str, str]) -> str:
27
28
    patch_level_serial = matches["PATCH"]
    serial = None
29
30
31
32
33
34
35
36
37
38
39
40
41
42
    major = int(matches["MAJOR"])
    minor = int(matches["MINOR"])
    flds = patch_level_serial.split(".")
    if flds:
        patch = int(flds[0])
        if len(flds) == 1:
            level = "0"
            serial = 0
        elif len(flds) == 2:
            level_serial = flds[1]
            for level in ("a", "b", "c", "dev"):
                if level_serial.startswith(level):
                    serial = int(level_serial[len(level) :])
                    break
43
44
45
    if serial is None:
        msg = 'Invalid PYBIND11_VERSION_PATCH: "{}"'.format(patch_level_serial)
        raise RuntimeError(msg)
46
47
    version_hex_str = "{:02x}{:02x}{:02x}{}{:x}".format(
        major, minor, patch, level[:1], serial
48
    )
49
    return "0x{}".format(version_hex_str.upper())
50
51


52
53
54
55
56
# PYBIND11_GLOBAL_SDIST will build a different sdist, with the python-headers
# files, and the sys.prefix files (CMake and headers).

global_sdist = os.environ.get("PYBIND11_GLOBAL_SDIST", False)

57
58
59
setup_py = Path(
    "tools/setup_global.py.in" if global_sdist else "tools/setup_main.py.in"
)
60
61
62
extra_cmd = 'cmdclass["sdist"] = SDist\n'

to_src = (
63
64
    (Path("pyproject.toml"), Path("tools/pyproject.toml")),
    (Path("setup.py"), setup_py),
65
66
)

67

68
# Read the listed version
69
70
loc = {}  # type: Dict[str, str]
code = compile(VERSION_FILE.read_text(encoding="utf-8"), "pybind11/_version.py", "exec")
71
72
exec(code, loc)
version = loc["__version__"]
73
74

# Verify that the version matches the one in C++
75
matches = dict(VERSION_REGEX.findall(COMMON_FILE.read_text(encoding="utf8")))
76
77
78
79
80
81
82
cpp_version = "{MAJOR}.{MINOR}.{PATCH}".format(**matches)
if version != cpp_version:
    msg = "Python version {} does not match C++ version {}!".format(
        version, cpp_version
    )
    raise RuntimeError(msg)

83
version_hex = matches.get("HEX", "MISSING")
84
85
exp_version_hex = build_expected_version_hex(matches)
if version_hex != exp_version_hex:
86
    msg = "PYBIND11_VERSION_HEX {} does not match expected value {}!".format(
87
        version_hex, exp_version_hex
88
89
90
    )
    raise RuntimeError(msg)

91

92
93
94
95
# TODO: use literals & overload (typing extensions or Python 3.8)
def get_and_replace(
    filename: Path, binary: bool = False, **opts: str
) -> Union[bytes, str]:
96
    if binary:
97
        contents = filename.read_bytes()
98
        return string.Template(contents.decode()).substitute(opts).encode()
99
100

    return string.Template(filename.read_text()).substitute(opts)
101
102
103
104


# Use our input files instead when making the SDist (and anything that depends
# on it, like a wheel)
105
106
107
class SDist(setuptools.command.sdist.sdist):  # type: ignore[misc]
    def make_release_tree(self, base_dir: str, files: List[str]) -> None:
        super().make_release_tree(base_dir, files)
108
109
110
111

        for to, src in to_src:
            txt = get_and_replace(src, binary=True, version=version, extra_cmd="")

112
            dest = Path(base_dir) / to
113
114

            # This is normally linked, so unlink before writing!
115
116
            dest.unlink()
            dest.write_bytes(txt)  # type: ignore[arg-type]
117
118
119
120


# Remove the CMake install directory when done
@contextlib.contextmanager
121
def remove_output(*sources: str) -> Iterator[None]:
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
    try:
        yield
    finally:
        for src in sources:
            shutil.rmtree(src)


with remove_output("pybind11/include", "pybind11/share"):
    # Generate the files if they are not present.
    with TemporaryDirectory() as tmpdir:
        cmd = ["cmake", "-S", ".", "-B", tmpdir] + [
            "-DCMAKE_INSTALL_PREFIX=pybind11",
            "-DBUILD_TESTING=OFF",
            "-DPYBIND11_NOPYTHON=ON",
        ]
137
138
139
140
141
142
143
        if "CMAKE_ARGS" in os.environ:
            fcommand = [
                c
                for c in os.environ["CMAKE_ARGS"].split()
                if "DCMAKE_INSTALL_PREFIX" not in c
            ]
            cmd += fcommand
144
145
146
147
148
149
150
151
        subprocess.run(cmd, check=True, cwd=DIR, stdout=sys.stdout, stderr=sys.stderr)
        subprocess.run(
            ["cmake", "--install", tmpdir],
            check=True,
            cwd=DIR,
            stdout=sys.stdout,
            stderr=sys.stderr,
        )
152
153
154
155

    txt = get_and_replace(setup_py, version=version, extra_cmd=extra_cmd)
    code = compile(txt, setup_py, "exec")
    exec(code, {"SDist": SDist})