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
use crate::auditwheel::auditwheel_rs;
use crate::auditwheel::PlatformTag;
use crate::auditwheel::Policy;
use crate::compile;
use crate::compile::warn_missing_py_init;
use crate::module_writer::write_python_part;
use crate::module_writer::WheelWriter;
use crate::module_writer::{write_bin, write_bindings_module, write_cffi_module};
use crate::python_interpreter::InterpreterKind;
use crate::source_distribution::source_distribution;
use crate::Metadata21;
use crate::PyProjectToml;
use crate::PythonInterpreter;
use crate::Target;
use anyhow::{anyhow, bail, Context, Result};
use cargo_metadata::Metadata;
use fs_err as fs;
use std::borrow::Cow;
use std::path::{Path, PathBuf};
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum BridgeModel {
Cffi,
Bin,
Bindings(String),
BindingsAbi3(u8, u8),
}
impl BridgeModel {
pub fn unwrap_bindings(&self) -> &str {
match self {
BridgeModel::Bindings(value) => value,
_ => panic!("Expected Bindings"),
}
}
pub fn is_bindings(&self, name: &str) -> bool {
match self {
BridgeModel::Bindings(value) => value == name,
_ => false,
}
}
}
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum ProjectLayout {
PureRust {
rust_module: PathBuf,
extension_name: String,
},
Mixed {
python_module: PathBuf,
rust_module: PathBuf,
extension_name: String,
},
}
impl ProjectLayout {
pub fn determine(
project_root: impl AsRef<Path>,
module_name: &str,
py_src: Option<impl AsRef<Path>>,
) -> Result<ProjectLayout> {
let parts: Vec<&str> = module_name.split('.').collect();
let project_root = project_root.as_ref();
let python_root = py_src.map_or(Cow::Borrowed(project_root), |py_src| {
Cow::Owned(project_root.join(py_src))
});
let (python_module, rust_module, extension_name) = if parts.len() > 1 {
let mut rust_module = project_root.to_path_buf();
rust_module.extend(&parts[0..parts.len() - 1]);
(
python_root.join(parts[0]),
rust_module,
parts[parts.len() - 1].to_string(),
)
} else {
(
python_root.join(module_name),
python_root.join(module_name),
module_name.to_string(),
)
};
if python_module.is_dir() {
if !python_module.join("__init__.py").is_file() {
bail!("Found a directory with the module name ({}) next to Cargo.toml, which indicates a mixed python/rust project, but the directory didn't contain an __init__.py file.", module_name)
}
println!("🍹 Building a mixed python/rust project");
Ok(ProjectLayout::Mixed {
python_module,
rust_module,
extension_name,
})
} else {
Ok(ProjectLayout::PureRust {
rust_module: project_root.to_path_buf(),
extension_name,
})
}
}
pub fn extension_name(&self) -> &str {
match *self {
ProjectLayout::PureRust {
ref extension_name, ..
} => extension_name,
ProjectLayout::Mixed {
ref extension_name, ..
} => extension_name,
}
}
}
#[derive(Clone)]
pub struct BuildContext {
pub target: Target,
pub bridge: BridgeModel,
pub project_layout: ProjectLayout,
pub metadata21: Metadata21,
pub crate_name: String,
pub module_name: String,
pub manifest_path: PathBuf,
pub out: PathBuf,
pub release: bool,
pub strip: bool,
pub skip_auditwheel: bool,
pub platform_tag: Option<PlatformTag>,
pub cargo_extra_args: Vec<String>,
pub rustc_extra_args: Vec<String>,
pub interpreter: Vec<PythonInterpreter>,
pub cargo_metadata: Metadata,
pub universal2: bool,
pub editable: bool,
}
pub type BuiltWheelMetadata = (PathBuf, String);
impl BuildContext {
pub fn build_wheels(&self) -> Result<Vec<BuiltWheelMetadata>> {
fs::create_dir_all(&self.out)
.context("Failed to create the target directory for the wheels")?;
let wheels = match &self.bridge {
BridgeModel::Cffi => self.build_cffi_wheel()?,
BridgeModel::Bin => self.build_bin_wheel()?,
BridgeModel::Bindings(_) => self.build_binding_wheels(&self.interpreter)?,
BridgeModel::BindingsAbi3(major, minor) => {
let cpythons: Vec<_> = self
.interpreter
.iter()
.filter(|interp| interp.interpreter_kind == InterpreterKind::CPython)
.cloned()
.collect();
let pypys: Vec<_> = self
.interpreter
.iter()
.filter(|interp| interp.interpreter_kind == InterpreterKind::PyPy)
.cloned()
.collect();
let mut built_wheels = Vec::new();
if !cpythons.is_empty() {
built_wheels.extend(self.build_binding_wheel_abi3(&cpythons, *major, *minor)?);
}
if !pypys.is_empty() {
println!(
"⚠️ Warning: PyPy does not yet support abi3 so the build artifacts will be version-specific. \
See https://foss.heptapod.net/pypy/pypy/-/issues/3397 for more information."
);
built_wheels.extend(self.build_binding_wheels(&pypys)?);
}
built_wheels
}
};
Ok(wheels)
}
pub fn build_source_distribution(&self) -> Result<Option<BuiltWheelMetadata>> {
fs::create_dir_all(&self.out)
.context("Failed to create the target directory for the source distribution")?;
match PyProjectToml::new(self.manifest_path.parent().unwrap()) {
Ok(pyproject) => {
let sdist_path = source_distribution(
&self.out,
&self.metadata21,
&self.manifest_path,
&self.cargo_metadata,
pyproject.sdist_include(),
)
.context("Failed to build source distribution")?;
Ok(Some((sdist_path, "source".to_string())))
}
Err(_) => Ok(None),
}
}
fn auditwheel(
&self,
python_interpreter: Option<&PythonInterpreter>,
artifact: &Path,
platform_tag: Option<PlatformTag>,
) -> Result<Policy> {
if self.skip_auditwheel {
return Ok(Policy::default());
}
let target = python_interpreter
.map(|x| &x.target)
.unwrap_or(&self.target);
let policy = auditwheel_rs(artifact, target, platform_tag).context(
if let Some(platform_tag) = platform_tag {
format!("Error ensuring {} compliance", platform_tag)
} else {
"Error checking for manylinux/musllinux compliance".to_string()
},
)?;
Ok(policy)
}
fn add_pth(&self, writer: &mut WheelWriter) -> Result<()> {
if self.editable {
writer.add_pth(&self.project_layout, &self.metadata21)?;
}
Ok(())
}
fn write_binding_wheel_abi3(
&self,
artifact: &Path,
platform_tag: PlatformTag,
major: u8,
min_minor: u8,
) -> Result<BuiltWheelMetadata> {
let platform = self.target.get_platform_tag(platform_tag, self.universal2);
let tag = format!("cp{}{}-abi3-{}", major, min_minor, platform);
let mut writer = WheelWriter::new(&tag, &self.out, &self.metadata21, &[tag.clone()])?;
write_bindings_module(
&mut writer,
&self.project_layout,
&self.module_name,
artifact,
None,
&self.target,
self.editable,
)
.context("Failed to add the files to the wheel")?;
self.add_pth(&mut writer)?;
let wheel_path = writer.finish()?;
Ok((wheel_path, format!("cp{}{}", major, min_minor)))
}
pub fn build_binding_wheel_abi3(
&self,
interpreters: &[PythonInterpreter],
major: u8,
min_minor: u8,
) -> Result<Vec<BuiltWheelMetadata>> {
let mut wheels = Vec::new();
let python_interpreter = interpreters.get(0);
let artifact = self.compile_cdylib(
python_interpreter,
Some(self.project_layout.extension_name()),
)?;
let policy = self.auditwheel(python_interpreter, &artifact, self.platform_tag)?;
let (wheel_path, tag) =
self.write_binding_wheel_abi3(&artifact, policy.platform_tag(), major, min_minor)?;
println!(
"📦 Built wheel for abi3 Python ≥ {}.{} to {}",
major,
min_minor,
wheel_path.display()
);
wheels.push((wheel_path, tag));
Ok(wheels)
}
fn write_binding_wheel(
&self,
python_interpreter: &PythonInterpreter,
artifact: &Path,
platform_tag: PlatformTag,
) -> Result<BuiltWheelMetadata> {
let tag = python_interpreter.get_tag(platform_tag, self.universal2);
let mut writer = WheelWriter::new(&tag, &self.out, &self.metadata21, &[tag.clone()])?;
write_bindings_module(
&mut writer,
&self.project_layout,
&self.module_name,
artifact,
Some(python_interpreter),
&self.target,
self.editable,
)
.context("Failed to add the files to the wheel")?;
self.add_pth(&mut writer)?;
let wheel_path = writer.finish()?;
Ok((
wheel_path,
format!("cp{}{}", python_interpreter.major, python_interpreter.minor),
))
}
pub fn build_binding_wheels(
&self,
interpreters: &[PythonInterpreter],
) -> Result<Vec<BuiltWheelMetadata>> {
let mut wheels = Vec::new();
for python_interpreter in interpreters {
let artifact = self.compile_cdylib(
Some(python_interpreter),
Some(self.project_layout.extension_name()),
)?;
let policy = self.auditwheel(Some(python_interpreter), &artifact, self.platform_tag)?;
let (wheel_path, tag) =
self.write_binding_wheel(python_interpreter, &artifact, policy.platform_tag())?;
println!(
"📦 Built wheel for {} {}.{}{} to {}",
python_interpreter.interpreter_kind,
python_interpreter.major,
python_interpreter.minor,
python_interpreter.abiflags,
wheel_path.display()
);
wheels.push((wheel_path, tag));
}
Ok(wheels)
}
pub fn compile_cdylib(
&self,
python_interpreter: Option<&PythonInterpreter>,
extension_name: Option<&str>,
) -> Result<PathBuf> {
let artifacts = compile(self, python_interpreter, &self.bridge)
.context("Failed to build a native library through cargo")?;
let artifact = artifacts.get("cdylib").cloned().ok_or_else(|| {
anyhow!(
"Cargo didn't build a cdylib. Did you miss crate-type = [\"cdylib\"] \
in the lib section of your Cargo.toml?",
)
})?;
if let Some(extension_name) = extension_name {
warn_missing_py_init(&artifact, extension_name)
.context("Failed to parse the native library")?;
}
Ok(artifact)
}
fn write_cffi_wheel(
&self,
artifact: &Path,
platform_tag: PlatformTag,
) -> Result<BuiltWheelMetadata> {
let (tag, tags) = self
.target
.get_universal_tags(platform_tag, self.universal2);
let mut writer = WheelWriter::new(&tag, &self.out, &self.metadata21, &tags)?;
write_cffi_module(
&mut writer,
&self.project_layout,
self.manifest_path.parent().unwrap(),
&self.module_name,
artifact,
&self.interpreter[0].executable,
self.editable,
)?;
self.add_pth(&mut writer)?;
let wheel_path = writer.finish()?;
Ok((wheel_path, "py3".to_string()))
}
pub fn build_cffi_wheel(&self) -> Result<Vec<BuiltWheelMetadata>> {
let mut wheels = Vec::new();
let artifact = self.compile_cdylib(None, None)?;
let policy = self.auditwheel(None, &artifact, self.platform_tag)?;
let (wheel_path, tag) = self.write_cffi_wheel(&artifact, policy.platform_tag())?;
println!("📦 Built wheel to {}", wheel_path.display());
wheels.push((wheel_path, tag));
Ok(wheels)
}
fn write_bin_wheel(
&self,
artifact: &Path,
platform_tag: PlatformTag,
) -> Result<BuiltWheelMetadata> {
let (tag, tags) = self
.target
.get_universal_tags(platform_tag, self.universal2);
if !self.metadata21.scripts.is_empty() {
bail!("Defining entrypoints and working with a binary doesn't mix well");
}
let mut writer = WheelWriter::new(&tag, &self.out, &self.metadata21, &tags)?;
match self.project_layout {
ProjectLayout::Mixed {
ref python_module,
ref extension_name,
..
} => {
if !self.editable {
write_python_part(&mut writer, python_module, extension_name)
.context("Failed to add the python module to the package")?;
}
}
ProjectLayout::PureRust { .. } => {}
}
let bin_name = artifact
.file_name()
.expect("Couldn't get the filename from the binary produced by cargo");
write_bin(&mut writer, artifact, &self.metadata21, bin_name)?;
self.add_pth(&mut writer)?;
let wheel_path = writer.finish()?;
Ok((wheel_path, "py3".to_string()))
}
pub fn build_bin_wheel(&self) -> Result<Vec<BuiltWheelMetadata>> {
let mut wheels = Vec::new();
let artifacts = compile(self, None, &self.bridge)
.context("Failed to build a native library through cargo")?;
let artifact = artifacts
.get("bin")
.cloned()
.ok_or_else(|| anyhow!("Cargo didn't build a binary"))?;
let policy = self.auditwheel(None, &artifact, self.platform_tag)?;
let (wheel_path, tag) = self.write_bin_wheel(&artifact, policy.platform_tag())?;
println!("📦 Built wheel to {}", wheel_path.display());
wheels.push((wheel_path, tag));
Ok(wheels)
}
}