Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fallback to sysconfig interpreters for pyo3 bindings #1381

Merged
merged 1 commit into from
Dec 31, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
* **Breaking Change**: Turn `patchelf` version warning into a hard error in [#1335](https://github.com/PyO3/maturin/pull/1335)
* **Breaking Change**: [`uniffi_bindgen` CLI](https://mozilla.github.io/uniffi-rs/tutorial/Prerequisites.html#the-uniffi-bindgen-cli-tool) is required for building `uniffi` bindings wheels in [#1352](https://github.com/PyO3/maturin/pull/1352)
* Add support for packaging multiple pure Python packages in [#1378](https://github.com/PyO3/maturin/pull/1378)
* Fallback to sysconfig interpreters for pyo3 bindings in [#1381](https://github.com/PyO3/maturin/pull/1381)

## [0.14.7] - 2022-12-20

Expand Down
79 changes: 54 additions & 25 deletions src/build_options.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ use std::collections::{HashMap, HashSet};
use std::env;
use std::ops::{Deref, DerefMut};
use std::path::PathBuf;
use tracing::debug;

// This is used for BridgeModel::Bindings("pyo3-ffi") and BridgeModel::Bindings("pyo3").
// These should be treated almost identically but must be correctly identified
Expand Down Expand Up @@ -219,7 +220,6 @@ impl BuildOptions {
) -> Result<Vec<PythonInterpreter>> {
match bridge {
BridgeModel::Bindings(binding_name, _) | BridgeModel::Bin(Some((binding_name, _))) => {
let mut native_interpreters = false;
let mut interpreters = Vec::new();
if let Some(config_file) = env::var_os("PYO3_CONFIG_FILE") {
if !binding_name.starts_with("pyo3") {
Expand Down Expand Up @@ -308,37 +308,20 @@ impl BuildOptions {
interpreters =
find_interpreter_in_sysconfig(interpreter, target, min_python_minor)?;
}
} else if binding_name.starts_with("pyo3") {
// Only pyo3/pyo3-ffi bindings supports bundled sysconfig interpreters
interpreters = find_interpreter(bridge, interpreter, target, min_python_minor)?;
} else {
match find_interpreter_in_host(bridge, interpreter, target, min_python_minor) {
Ok(host_interps) => {
interpreters = host_interps;
native_interpreters = true;
}
Err(err) => {
if binding_name.starts_with("pyo3") && target.is_unix() {
interpreters = find_interpreter_in_sysconfig(
interpreter,
target,
min_python_minor,
)
.map_err(|_| err)?;
} else {
return Err(err);
}
}
}
interpreters =
find_interpreter_in_host(bridge, interpreter, target, min_python_minor)?;
}

let interpreters_str = interpreters
.iter()
.map(ToString::to_string)
.collect::<Vec<String>>()
.join(", ");
if native_interpreters {
println!("🐍 Found {}", interpreters_str);
} else {
println!("🐍 Found cross compiling target {}", interpreters_str);
}
println!("🐍 Found {}", interpreters_str);

Ok(interpreters)
}
Expand Down Expand Up @@ -1000,6 +983,43 @@ fn find_single_python_interpreter(
Ok(interpreter)
}

/// Find python interpreters in host machine first,
/// fallback to bundled sysconfig if not found in host machine
fn find_interpreter(
bridge: &BridgeModel,
interpreter: &[PathBuf],
target: &Target,
min_python_minor: Option<usize>,
) -> Result<Vec<PythonInterpreter>> {
let mut interpreters = Vec::new();
if !interpreter.is_empty() {
let mut missing = Vec::new();
for interp in interpreter {
match PythonInterpreter::check_executable(interp.clone(), target, bridge) {
Ok(Some(interp)) => interpreters.push(interp),
_ => missing.push(interp.clone()),
}
}
if !missing.is_empty() {
let sysconfig_interps =
find_interpreter_in_sysconfig(&missing, target, min_python_minor)?;
interpreters.extend(sysconfig_interps);
}
} else {
interpreters = PythonInterpreter::find_all(target, bridge, min_python_minor)
.context("Finding python interpreters failed")?;
};

if interpreters.is_empty() {
if let Some(minor) = min_python_minor {
bail!("Couldn't find any python interpreters with version >= 3.{}. Please specify at least one with -i", minor);
} else {
bail!("Couldn't find any python interpreters. Please specify at least one with -i");
}
}
Ok(interpreters)
}

/// Find python interpreters in the host machine
fn find_interpreter_in_host(
bridge: &BridgeModel,
Expand Down Expand Up @@ -1076,7 +1096,16 @@ fn find_interpreter_in_sysconfig(
python_impl,
(ver_major, ver_minor),
)
.context("Failed to find a python interpreter")?;
.with_context(|| {
format!(
"Failed to find a {} {}.{} interpreter",
python_impl, ver_major, ver_minor
)
})?;
debug!(
"Found {} {}.{} in bundled sysconfig",
sysconfig.interpreter_kind, sysconfig.major, sysconfig.minor,
);
interpreters.push(PythonInterpreter::from_config(sysconfig.clone()));
}
Ok(interpreters)
Expand Down
19 changes: 15 additions & 4 deletions src/python_interpreter/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ use std::ops::Deref;
use std::path::{Path, PathBuf};
use std::process::{Command, Stdio};
use std::str::{self, FromStr};
use tracing::debug;

mod config;

Expand Down Expand Up @@ -613,6 +614,10 @@ impl PythonInterpreter {
.context(String::from_utf8_lossy(&output.stdout).trim().to_string())?;

if (message.major == 2 && message.minor != 7) || (message.major == 3 && message.minor < 5) {
debug!(
"Skipping outdated python interpreter '{}'",
executable.as_ref().display()
);
return Ok(None);
}

Expand All @@ -636,6 +641,15 @@ impl PythonInterpreter {
Some(message.platform.to_lowercase().replace(['-', '.'], "_"))
};

let executable = message
.executable
.map(PathBuf::from)
.unwrap_or_else(|| executable.as_ref().to_path_buf());
debug!(
"Found {} interpreter at {}",
interpreter,
executable.display()
);
Ok(Some(PythonInterpreter {
config: InterpreterConfig {
major: message.major,
Expand All @@ -648,10 +662,7 @@ impl PythonInterpreter {
abi_tag: message.abi_tag,
pointer_width: None,
},
executable: message
.executable
.map(PathBuf::from)
.unwrap_or_else(|| executable.as_ref().to_path_buf()),
executable,
platform,
runnable: true,
implmentation_name: message.implementation_name,
Expand Down