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
|
import os
import subprocess
import sys
import sysconfig
import logging
from typing import List, Literal, Optional, Set, Tuple, Type, TypeVar, cast
from functools import partial
from setuptools.command.build_ext import build_ext
from setuptools.command.install import install
from setuptools.command.install_lib import install_lib
from setuptools.command.install_scripts import install_scripts
from setuptools.command.sdist import sdist
from setuptools.dist import Distribution
from .build import _get_bdist_wheel_cmd
from .extension import Binding, RustBin, RustExtension, Strip
try:
from wheel.bdist_wheel import bdist_wheel
except ImportError:
bdist_wheel = None
if sys.version_info[:2] >= (3, 11):
from tomllib import load as toml_load
else:
from tomli import load as toml_load
logger = logging.getLogger(__name__)
T = TypeVar("T", bound=RustExtension)
def add_rust_extension(dist: Distribution) -> None:
sdist_base_class = cast(Type[sdist], dist.cmdclass.get("sdist", sdist))
sdist_options = sdist_base_class.user_options.copy()
sdist_boolean_options = sdist_base_class.boolean_options.copy()
sdist_negative_opt = sdist_base_class.negative_opt.copy()
sdist_options.extend(
[
("vendor-crates", None, "vendor Rust crates"),
(
"no-vendor-crates",
None,
"don't vendor Rust crates." "[default; enable with --vendor-crates]",
),
]
)
sdist_boolean_options.append("vendor-crates")
sdist_negative_opt["no-vendor-crates"] = "vendor-crates"
# Patch dist to include console_scripts for Exec binding
console_scripts = []
for ext in dist.rust_extensions: # type: ignore[attr-defined]
console_scripts.extend(ext.entry_points())
if console_scripts:
if not dist.entry_points: # type: ignore[attr-defined]
dist.entry_points = {"console_scripts": console_scripts} # type: ignore[attr-defined]
else:
ep_scripts = dist.entry_points.get("console_scripts") # type: ignore[attr-defined]
if ep_scripts:
for script in console_scripts:
if script not in ep_scripts:
ep_scripts.append(console_scripts)
else:
ep_scripts = console_scripts
dist.entry_points["console_scripts"] = ep_scripts # type: ignore[attr-defined]
class sdist_rust_extension(sdist_base_class): # type: ignore[misc,valid-type]
user_options = sdist_options
boolean_options = sdist_boolean_options
negative_opt = sdist_negative_opt
def initialize_options(self) -> None:
super().initialize_options()
self.vendor_crates = 0
def make_distribution(self) -> None:
if self.vendor_crates:
manifest_paths = []
# Collate cargo manifest options together.
# We can cheat here, as the only valid options are the simple strings
# --frozen, --locked, or --offline.
#
# https://doc.rust-lang.org/cargo/commands/cargo-build.html#manifest-options
cargo_manifest_args: Set[str] = set()
for ext in self.distribution.rust_extensions:
manifest_paths.append(ext.path)
if ext.cargo_manifest_args:
cargo_manifest_args.update(ext.cargo_manifest_args)
if manifest_paths:
base_dir = self.distribution.get_fullname()
dot_cargo_path = os.path.join(base_dir, ".cargo")
self.mkpath(dot_cargo_path)
cargo_config_path = os.path.join(dot_cargo_path, "config.toml")
vendor_path = os.path.join(dot_cargo_path, "vendor")
command = ["cargo", "vendor"]
if cargo_manifest_args:
command.extend(sorted(cargo_manifest_args))
# additional Cargo.toml for extension 1..n
for extra_path in manifest_paths[1:]:
command.append("--sync")
command.append(extra_path)
# `cargo vendor --sync` accepts multiple values, for example
# `cargo vendor --sync a --sync b --sync c vendor_path`
# but it would also consider vendor_path as --sync value
# set --manifest-path before vendor_path and after --sync to workaround that
# See https://docs.rs/clap/latest/clap/struct.Arg.html#method.multiple for detail
command.extend(["--manifest-path", manifest_paths[0], vendor_path])
subprocess.run(command, check=True)
cargo_config = _CARGO_VENDOR_CONFIG
# Check whether `.cargo/config`/`.cargo/config.toml` already exists
existing_cargo_config = None
for filename in (
f".cargo{os.sep}config",
f".cargo{os.sep}config.toml",
):
if filename in self.filelist.files:
existing_cargo_config = filename
break
if existing_cargo_config:
cargo_config_path = os.path.join(
base_dir, existing_cargo_config
)
# Append vendor config to original cargo config
with open(existing_cargo_config, "rb") as f:
cargo_config += f.read() + b"\n"
with open(cargo_config_path, "wb") as f:
f.write(cargo_config)
super().make_distribution()
dist.cmdclass["sdist"] = sdist_rust_extension
build_ext_base_class = cast(
Type[build_ext], dist.cmdclass.get("build_ext", build_ext)
)
build_ext_options = build_ext_base_class.user_options.copy()
build_ext_options.append(("target", None, "Build for the target triple"))
class build_ext_rust_extension(build_ext_base_class): # type: ignore[misc,valid-type]
user_options = build_ext_options
def initialize_options(self) -> None:
super().initialize_options()
self.target = os.getenv("CARGO_BUILD_TARGET")
def run(self) -> None:
super().run()
if self.distribution.rust_extensions:
logger.info("running build_rust")
build_rust = self.get_finalized_command("build_rust")
build_rust.inplace = self.inplace
build_rust.target = self.target
build_rust.verbose = self.verbose
build_rust.plat_name = self._get_wheel_plat_name() or self.plat_name
build_rust.run()
def _get_wheel_plat_name(self) -> Optional[str]:
cmd = _get_bdist_wheel_cmd(self.distribution)
return cast(Optional[str], getattr(cmd, "plat_name", None))
dist.cmdclass["build_ext"] = build_ext_rust_extension
clean_base_class = dist.cmdclass.get("clean")
if clean_base_class is not None:
class clean_rust_extension(clean_base_class): # type: ignore[misc,valid-type]
def run(self) -> None:
super().run()
if not self.dry_run:
self.run_command("clean_rust")
dist.cmdclass["clean"] = clean_rust_extension
install_base_class = cast(Type[install], dist.cmdclass.get("install", install))
# this is required to make install_scripts compatible with RustBin
class install_rust_extension(install_base_class): # type: ignore[misc,valid-type]
def run(self) -> None:
super().run()
install_rustbin = False
if self.distribution.rust_extensions:
install_rustbin = any(
isinstance(ext, RustBin)
for ext in self.distribution.rust_extensions
)
if install_rustbin:
self.run_command("install_scripts")
dist.cmdclass["install"] = install_rust_extension
install_lib_base_class = cast(
Type[install_lib], dist.cmdclass.get("install_lib", install_lib)
)
# prevent RustBin from being installed to data_dir
class install_lib_rust_extension(install_lib_base_class): # type: ignore[misc,valid-type]
def get_exclusions(self) -> Set[str]:
exclusions: Set[str] = super().get_exclusions()
install_scripts_obj = cast(
install_scripts, self.get_finalized_command("install_scripts")
)
scripts_path = install_scripts_obj.build_dir
if self.distribution.rust_extensions:
exe = sysconfig.get_config_var("EXE")
for ext in self.distribution.rust_extensions:
if isinstance(ext, RustBin):
executable_name = ext.name
if exe is not None:
executable_name += exe
exclusions.add(os.path.join(scripts_path, executable_name))
return exclusions
dist.cmdclass["install_lib"] = install_lib_rust_extension
install_scripts_base_class = cast(
Type[install_scripts], dist.cmdclass.get("install_scripts", install_scripts)
)
# this is required to make install_scripts compatible with RustBin
class install_scripts_rust_extension(install_scripts_base_class): # type: ignore[misc,valid-type]
def run(self) -> None:
super().run()
install_scripts_obj = cast(
install_scripts, self.get_finalized_command("install_scripts")
)
scripts_path = install_scripts_obj.build_dir
if os.path.isdir(scripts_path):
for file in os.listdir(scripts_path):
script_path = os.path.join(scripts_path, file)
if os.path.isfile(script_path):
with open(os.path.join(script_path), "rb") as script_reader:
self.write_script(file, script_reader.read(), mode="b")
dist.cmdclass["install_scripts"] = install_scripts_rust_extension
if bdist_wheel is not None:
bdist_wheel_base_class = cast( # type: ignore[no-any-unimported]
Type[bdist_wheel], dist.cmdclass.get("bdist_wheel", bdist_wheel)
)
bdist_wheel_options = bdist_wheel_base_class.user_options.copy()
bdist_wheel_options.append(("target", None, "Build for the target triple"))
# this is for console entries
class bdist_wheel_rust_extension(bdist_wheel_base_class): # type: ignore[misc,valid-type]
user_options = bdist_wheel_options
def initialize_options(self) -> None:
super().initialize_options()
self.target = os.getenv("CARGO_BUILD_TARGET")
def get_tag(self) -> Tuple[str, str, str]:
python, abi, plat = super().get_tag()
arch_flags = os.getenv("ARCHFLAGS")
universal2 = False
if self.plat_name.startswith("macosx-") and arch_flags:
universal2 = "x86_64" in arch_flags and "arm64" in arch_flags
if universal2 and plat.startswith("macosx_"):
from wheel.macosx_libfile import calculate_macosx_platform_tag
macos_target = os.getenv("MACOSX_DEPLOYMENT_TARGET")
if macos_target is None:
# Example: macosx_11_0_arm64
macos_target = ".".join(plat.split("_")[1:3])
plat = calculate_macosx_platform_tag(
self.bdist_dir, "macosx-{}-universal2".format(macos_target)
)
return python, abi, plat
dist.cmdclass["bdist_wheel"] = bdist_wheel_rust_extension
def rust_extensions(
dist: Distribution, attr: Literal["rust_extensions"], value: List[RustExtension]
) -> None:
assert attr == "rust_extensions"
has_rust_extensions = len(value) > 0
# Monkey patch has_ext_modules to include Rust extensions.
orig_has_ext_modules = dist.has_ext_modules
dist.has_ext_modules = lambda: (orig_has_ext_modules() or has_rust_extensions) # type: ignore[method-assign]
if has_rust_extensions:
add_rust_extension(dist)
def pyprojecttoml_config(dist: Distribution) -> None:
try:
with open("pyproject.toml", "rb") as f:
cfg = toml_load(f).get("tool", {}).get("setuptools-rust")
except FileNotFoundError:
return None
if cfg:
modules = map(partial(_create, RustExtension), cfg.get("ext-modules", []))
binaries = map(partial(_create, RustBin), cfg.get("bins", []))
dist.rust_extensions = [*modules, *binaries] # type: ignore[attr-defined]
rust_extensions(dist, "rust_extensions", dist.rust_extensions) # type: ignore[attr-defined]
def _create(constructor: Type[T], config: dict) -> T:
kwargs = {
# PEP 517/621 convention: pyproject.toml uses dashes
k.replace("-", "_"): v
for k, v in config.items()
}
if "binding" in config:
kwargs["binding"] = Binding[config["binding"]]
if "strip" in config:
kwargs["strip"] = Strip[config["strip"]]
return constructor(**kwargs)
_CARGO_VENDOR_CONFIG = b"""
[source.crates-io]
replace-with = "vendored-sources"
[source.vendored-sources]
directory = ".cargo/vendor"
"""
|