#[cfg(test)]
use std::cell::RefCell;
use std::{
collections::{HashMap, HashSet},
env,
ffi::{OsStr, OsString},
fmt::Display,
fs::{self, DirEntry},
io::{BufRead, BufReader, Read, Write},
path::{Path, PathBuf},
process::{Command, Stdio},
str::{self, FromStr},
};
pub use target_lexicon::Triple;
use target_lexicon::{Architecture, Environment, OperatingSystem, Vendor};
use crate::{
bail, ensure,
errors::{Context, Error, Result},
warn,
};
pub(crate) const MINIMUM_SUPPORTED_VERSION: PythonVersion = PythonVersion { major: 3, minor: 8 };
pub(crate) const MINIMUM_SUPPORTED_VERSION_ABI3T: PythonVersion = PythonVersion {
major: 3,
minor: 15,
};
const MINIMUM_SUPPORTED_VERSION_GRAALPY: PythonVersion = PythonVersion {
major: 25,
minor: 0,
};
pub(crate) const STABLE_ABI_MAX_MINOR: u8 = 15;
#[cfg(test)]
thread_local! {
static READ_ENV_VARS: RefCell<Vec<String>> = const { RefCell::new(Vec::new()) };
}
pub fn cargo_env_var(var: &str) -> Option<String> {
env::var_os(var).map(|os_string| os_string.to_str().unwrap().into())
}
pub fn env_var(var: &str) -> Option<OsString> {
println!("cargo:rerun-if-env-changed={var}");
#[cfg(test)]
{
READ_ENV_VARS.with(|env_vars| {
env_vars.borrow_mut().push(var.to_owned());
});
}
env::var_os(var)
}
pub fn target_triple_from_env() -> Triple {
env::var("TARGET")
.expect("target_triple_from_env() must be called from a build script")
.parse()
.expect("Unrecognized TARGET environment variable value")
}
fn sanitize_stable_abi_version(
stable_abi_version: Option<PythonVersion>,
version: PythonVersion,
) -> Result<PythonVersion> {
if let Some(min_version) = stable_abi_version {
ensure!(
min_version <= version,
"cannot set a minimum Python version {} higher than the interpreter version {} \
(the minimum Python version is implied by the abi3-py3{} feature)",
min_version,
version,
min_version.minor
);
Ok(min_version)
} else {
Ok(version)
}
}
fn applicable_stable_abi(
implementation: PythonImplementation,
version: PythonVersion,
gil_disabled: bool,
abi3_version: Option<StableAbiVersion>,
abi3t_version: Option<StableAbiVersion>,
) -> Option<(StableAbi, PythonVersion)> {
let exact = |requested: StableAbiVersion| match requested {
StableAbiVersion::Current => version,
StableAbiVersion::Target(target) => target,
};
let abi3 = abi3_version.map(|v| (StableAbi::Abi3, exact(v)));
let abi3t = abi3t_version.map(|v| (StableAbi::Abi3t, exact(v)));
let selected = if version >= MINIMUM_SUPPORTED_VERSION_ABI3T {
match gil_disabled {
false => abi3t.or(abi3),
true => abi3t,
}
} else {
match gil_disabled {
false => abi3,
true => None,
}
};
match implementation {
PythonImplementation::PyPy | PythonImplementation::GraalPy => {
selected.map(|(kind, _)| (kind, version))
}
_ => selected,
}
}
fn applicable_stable_abi_at_interpreter_version(
implementation: PythonImplementation,
version: PythonVersion,
gil_disabled: bool,
) -> Option<(StableAbi, PythonVersion)> {
applicable_stable_abi(
implementation,
version,
gil_disabled,
get_abi3_version(),
get_abi3t_version(),
)
.map(|(kind, _)| (kind, version))
}
#[cfg_attr(test, derive(Debug, PartialEq, Eq))]
pub struct InterpreterConfig {
#[deprecated(
since = "0.29.0",
note = "please use `.implementation()` getter or `InterpreterConfigBuilder` instead"
)]
pub implementation: PythonImplementation,
#[deprecated(
since = "0.29.0",
note = "please use `.version()` getter or `InterpreterConfigBuilder` instead"
)]
pub version: PythonVersion,
#[deprecated(
since = "0.29.0",
note = "please use `.shared()` getter or `InterpreterConfigBuilder` instead"
)]
pub shared: bool,
target_abi: PythonAbi,
#[deprecated(since = "0.29.0", note = "please match against target_abi instead")]
pub abi3: bool,
#[deprecated(
since = "0.29.0",
note = "please use `.lib_name()` getter or `InterpreterConfigBuilder` instead"
)]
pub lib_name: Option<String>,
#[deprecated(
since = "0.29.0",
note = "please use `.lib_dir()` getter or `InterpreterConfigBuilder` instead"
)]
pub lib_dir: Option<String>,
#[deprecated(
since = "0.29.0",
note = "please use `.executable()` getter or `InterpreterConfigBuilder` instead"
)]
pub executable: Option<String>,
#[deprecated(
since = "0.29.0",
note = "please use `.pointer_width()` getter or `InterpreterConfigBuilder` instead"
)]
pub pointer_width: Option<u32>,
#[deprecated(
since = "0.29.0",
note = "please use `.build_flags()` getter or `InterpreterConfigBuilder` instead"
)]
pub build_flags: BuildFlags,
#[deprecated(
since = "0.29.0",
note = "please use `.suppress_build_script_link_lines()` getter or `InterpreterConfigBuilder` instead"
)]
pub suppress_build_script_link_lines: bool,
#[deprecated(
since = "0.29.0",
note = "please use `.extra_build_script_lines()` getter or `InterpreterConfigBuilder` instead"
)]
pub extra_build_script_lines: Vec<String>,
#[deprecated(
since = "0.29.0",
note = "please use `.python_framework_prefix()` getter or `InterpreterConfigBuilder` instead"
)]
pub python_framework_prefix: Option<String>,
}
#[expect(deprecated, reason = "this impl block touches the internal fields")]
impl InterpreterConfig {
pub fn implementation(&self) -> PythonImplementation {
self.implementation
}
pub fn version(&self) -> PythonVersion {
self.version
}
pub fn shared(&self) -> bool {
self.shared
}
pub fn target_abi(&self) -> PythonAbi {
self.target_abi
}
#[deprecated(since = "0.29.0", note = "please use `target_abi()` instead")]
pub fn abi3(&self) -> bool {
matches!(self.target_abi.kind, PythonAbiKind::Stable(StableAbi::Abi3))
}
pub fn lib_name(&self) -> Option<&str> {
self.lib_name.as_deref()
}
pub fn lib_dir(&self) -> Option<&str> {
self.lib_dir.as_deref()
}
pub fn executable(&self) -> Option<&str> {
self.executable.as_deref()
}
pub fn pointer_width(&self) -> Option<u32> {
self.pointer_width
}
pub fn build_flags(&self) -> &BuildFlags {
&self.build_flags
}
pub fn suppress_build_script_link_lines(&self) -> bool {
self.suppress_build_script_link_lines
}
pub fn extra_build_script_lines(&self) -> &[String] {
&self.extra_build_script_lines
}
pub fn python_framework_prefix(&self) -> Option<&str> {
self.python_framework_prefix.as_deref()
}
#[doc(hidden)]
pub fn build_script_outputs(&self) -> Vec<String> {
assert!(self.target_abi.version() >= MINIMUM_SUPPORTED_VERSION);
let mut out = vec![];
for i in MINIMUM_SUPPORTED_VERSION.minor..=self.target_abi.version().minor {
out.push(format!("cargo:rustc-cfg=Py_3_{i}"));
}
match self.target_abi.implementation() {
PythonImplementation::CPython => {}
PythonImplementation::PyPy => out.push("cargo:rustc-cfg=PyPy".to_owned()),
PythonImplementation::GraalPy => out.push("cargo:rustc-cfg=GraalPy".to_owned()),
PythonImplementation::RustPython => out.push("cargo:rustc-cfg=RustPython".to_owned()),
}
match self.target_abi.kind() {
PythonAbiKind::Stable(kind) => {
out.push("cargo:rustc-cfg=Py_LIMITED_API".to_owned());
if kind == StableAbi::Abi3t {
out.push("cargo:rustc-cfg=Py_GIL_DISABLED".to_owned());
}
}
PythonAbiKind::VersionSpecific(kind) => match kind {
GilUsed::FreeThreaded => {
out.push("cargo:rustc-cfg=Py_GIL_DISABLED".to_owned());
}
GilUsed::GilEnabled => {}
},
}
for flag in &self.build_flags.0 {
match flag {
BuildFlag::Py_GIL_DISABLED => continue,
flag => out.push(format!("cargo:rustc-cfg=py_sys_config=\"{flag}\"")),
}
}
out
}
fn from_interpreter(
interpreter: impl AsRef<Path>,
abi3_version: Option<StableAbiVersion>,
abi3t_version: Option<StableAbiVersion>,
) -> Result<Self> {
const SCRIPT: &str = r#"
# Allow the script to run on Python 2, so that nicer error can be printed later.
from __future__ import print_function
import os.path
import platform
import struct
import sys
from sysconfig import get_config_var, get_platform
PYPY = platform.python_implementation() == "PyPy"
GRAALPY = platform.python_implementation() == "GraalVM"
if GRAALPY:
graalpy_ver = map(int, __graalpython__.get_graalvm_version().split('.'));
print("graalpy_major", next(graalpy_ver))
print("graalpy_minor", next(graalpy_ver))
# sys.base_prefix is missing on Python versions older than 3.3; this allows the script to continue
# so that the version mismatch can be reported in a nicer way later.
base_prefix = getattr(sys, "base_prefix", None)
if base_prefix:
# Anaconda based python distributions have a static python executable, but include
# the shared library. Use the shared library for embedding to avoid rust trying to
# LTO the static library (and failing with newer gcc's, because it is old).
ANACONDA = os.path.exists(os.path.join(base_prefix, "conda-meta"))
else:
ANACONDA = False
def print_if_set(varname, value):
if value is not None:
print(varname, value)
# Windows always uses shared linking
WINDOWS = platform.system() == "Windows"
# macOS framework packages use shared linking
FRAMEWORK = bool(get_config_var("PYTHONFRAMEWORK"))
FRAMEWORK_PREFIX = get_config_var("PYTHONFRAMEWORKPREFIX")
# unix-style shared library enabled
SHARED = bool(get_config_var("Py_ENABLE_SHARED"))
print("implementation", platform.python_implementation())
print("version_major", sys.version_info[0])
print("version_minor", sys.version_info[1])
print("shared", PYPY or GRAALPY or ANACONDA or WINDOWS or FRAMEWORK or SHARED)
print("python_framework_prefix", FRAMEWORK_PREFIX)
print_if_set("ld_version", get_config_var("LDVERSION"))
print_if_set("libdir", get_config_var("LIBDIR"))
print_if_set("base_prefix", base_prefix)
print("executable", sys.executable)
print("calcsize_pointer", struct.calcsize("P"))
print("mingw", get_platform().startswith("mingw"))
print("cygwin", get_platform().startswith("cygwin"))
print("ext_suffix", get_config_var("EXT_SUFFIX"))
print("gil_disabled", get_config_var("Py_GIL_DISABLED"))
"#;
let output = run_python_script(interpreter.as_ref(), SCRIPT)?;
let map: HashMap<String, String> = parse_script_output(&output);
ensure!(
!map.is_empty(),
"broken Python interpreter: {}",
interpreter.as_ref().display()
);
if let Some(value) = map.get("graalpy_major") {
let graalpy_version = PythonVersion {
major: value
.parse()
.context("failed to parse GraalPy major version")?,
minor: map["graalpy_minor"]
.parse()
.context("failed to parse GraalPy minor version")?,
};
ensure!(
graalpy_version >= MINIMUM_SUPPORTED_VERSION_GRAALPY,
"At least GraalPy version {} needed, got {}",
MINIMUM_SUPPORTED_VERSION_GRAALPY,
graalpy_version
);
};
let shared = map["shared"].as_str() == "True";
let python_framework_prefix = map.get("python_framework_prefix").cloned();
let version = PythonVersion {
major: map["version_major"]
.parse()
.context("failed to parse major version")?,
minor: map["version_minor"]
.parse()
.context("failed to parse minor version")?,
};
let implementation = map["implementation"].parse()?;
let gil_disabled = match map["gil_disabled"].as_str() {
"1" => true,
"0" => false,
"None" => false,
_ => panic!("Unknown Py_GIL_DISABLED value"),
};
let stable_abi = applicable_stable_abi(
implementation,
version,
gil_disabled,
abi3_version,
abi3t_version,
);
let target_abi =
PythonAbi::from_stable_abi(implementation, version, stable_abi, gil_disabled)?;
let cygwin = map["cygwin"].as_str() == "True";
let lib_name = if cfg!(windows) {
default_lib_name_windows(
target_abi,
map["mingw"].as_str() == "True",
map["ext_suffix"].starts_with("_d."),
)?
} else {
default_lib_name_unix(
target_abi,
cygwin,
map.get("ld_version").map(String::as_str),
)?
};
let lib_dir = if cfg!(windows) {
map.get("base_prefix")
.map(|base_prefix| format!("{base_prefix}\\libs"))
} else {
map.get("libdir").cloned()
};
let calcsize_pointer: u32 = map["calcsize_pointer"]
.parse()
.context("failed to parse calcsize_pointer")?;
InterpreterConfigBuilder::new(implementation, version)
.target_abi(target_abi)
.shared(shared)
.lib_name(lib_name)
.lib_dir(lib_dir)
.executable(map["executable"].clone())
.pointer_width(calcsize_pointer * 8)
.build_flags(BuildFlags::from_interpreter(interpreter)?)
.python_framework_prefix(python_framework_prefix)
.finalize()
}
pub fn from_sysconfigdata(sysconfigdata: &Sysconfigdata) -> Result<Self> {
macro_rules! get_key {
($sysconfigdata:expr, $key:literal) => {
$sysconfigdata
.get_value($key)
.ok_or(concat!($key, " not found in sysconfigdata file"))
};
}
macro_rules! parse_key {
($sysconfigdata:expr, $key:literal) => {
get_key!($sysconfigdata, $key)?
.parse()
.context(concat!("could not parse value of ", $key))
};
}
let soabi = get_key!(sysconfigdata, "SOABI")?;
let implementation = PythonImplementation::from_soabi(soabi)?;
let version = parse_key!(sysconfigdata, "VERSION")?;
let shared = match sysconfigdata.get_value("Py_ENABLE_SHARED") {
Some("1") | Some("true") | Some("True") => true,
Some("0") | Some("false") | Some("False") => false,
_ => bail!("expected a bool (1/true/True or 0/false/False) for Py_ENABLE_SHARED"),
};
let framework = match sysconfigdata.get_value("PYTHONFRAMEWORK") {
Some(s) => !s.is_empty(),
_ => false,
};
let python_framework_prefix = sysconfigdata
.get_value("PYTHONFRAMEWORKPREFIX")
.map(str::to_string);
let lib_dir = get_key!(sysconfigdata, "LIBDIR").ok().map(str::to_string);
let gil_disabled = match sysconfigdata.get_value("Py_GIL_DISABLED") {
Some(value) => value == "1",
None => false,
};
let cygwin = soabi.ends_with("cygwin");
let stable_abi =
applicable_stable_abi_at_interpreter_version(implementation, version, gil_disabled);
let target_abi =
PythonAbi::from_stable_abi(implementation, version, stable_abi, gil_disabled)?;
let lib_name =
default_lib_name_unix(target_abi, cygwin, sysconfigdata.get_value("LDVERSION"))?;
let pointer_width = parse_key!(sysconfigdata, "SIZEOF_VOID_P")
.map(|bytes_width: u32| bytes_width * 8)
.ok();
let build_flags = BuildFlags::from_sysconfigdata(sysconfigdata);
InterpreterConfigBuilder::new(implementation, version)
.target_abi(target_abi)
.shared(shared || framework)
.pointer_width(pointer_width)
.lib_name(lib_name)
.lib_dir(lib_dir)
.python_framework_prefix(python_framework_prefix)
.build_flags(build_flags)
.finalize()
}
pub(super) fn from_pyo3_config_file_env(target: &Triple) -> Option<Result<Self>> {
env_var("PYO3_CONFIG_FILE").map(|path| {
let path = Path::new(&path);
println!("cargo:rerun-if-changed={}", path.display());
ensure!(
path.is_absolute(),
"PYO3_CONFIG_FILE must be an absolute path"
);
let mut config = InterpreterConfig::from_path(path)
.context("failed to parse contents of PYO3_CONFIG_FILE")?
.apply_build_env()?;
if config.lib_name.is_none() {
config.lib_name = Some(default_lib_name_for_target(config.target_abi, target));
}
Ok(config)
})
}
fn from_path(path: impl AsRef<Path>) -> Result<Self> {
let path = path.as_ref();
let config_file = std::fs::File::open(path)
.with_context(|| format!("failed to open PyO3 config file at {}", path.display()))?;
let reader = std::io::BufReader::new(config_file);
InterpreterConfig::from_reader(reader)
}
pub(crate) const PYO3_FFI_CONFIG_ENV_VAR: &str = "DEP_PYTHON_PYO3_CONFIG";
pub(crate) const PYO3_CONFIG_ENV_VAR: &str = "DEP_PYO3_PYTHON_PYO3_CONFIG";
pub(crate) fn from_cargo_dep_env() -> Option<Result<Self>> {
cargo_env_var(Self::PYO3_FFI_CONFIG_ENV_VAR)
.or_else(|| cargo_env_var(Self::PYO3_CONFIG_ENV_VAR))
.map(|buf| InterpreterConfig::from_reader(&*unescape(&buf)))
}
fn from_reader(reader: impl Read) -> Result<Self> {
let reader = BufReader::new(reader);
let lines = reader.lines();
macro_rules! parse_value {
($variable:ident, $value:ident) => {
$variable = Some($value.trim().parse().context(format!(
concat!(
"failed to parse ",
stringify!($variable),
" from config value '{}'"
),
$value
))?)
};
}
let mut implementation = None;
let mut version = None;
let mut shared = None;
let mut target_abi = None;
let mut abi3 = None;
let mut lib_name = None;
let mut lib_dir = None;
let mut executable = None;
let mut pointer_width = None;
let mut build_flags: Option<BuildFlags> = None;
let mut suppress_build_script_link_lines: Option<bool> = None;
let mut extra_build_script_lines = vec![];
let mut python_framework_prefix = None;
for (i, line) in lines.enumerate() {
let line = line.context("failed to read line from config")?;
let mut split = line.splitn(2, '=');
let (key, value) = (
split
.next()
.expect("first splitn value should always be present"),
split
.next()
.ok_or_else(|| format!("expected key=value pair on line {}", i + 1))?,
);
match key {
"implementation" => parse_value!(implementation, value),
"version" => parse_value!(version, value),
"shared" => parse_value!(shared, value),
"target_abi" => parse_value!(target_abi, value),
"abi3" => parse_value!(abi3, value),
"lib_name" => parse_value!(lib_name, value),
"lib_dir" => parse_value!(lib_dir, value),
"executable" => parse_value!(executable, value),
"pointer_width" => parse_value!(pointer_width, value),
"build_flags" => parse_value!(build_flags, value),
"suppress_build_script_link_lines" => {
parse_value!(suppress_build_script_link_lines, value)
}
"extra_build_script_line" => {
extra_build_script_lines.push(value.to_string());
}
"python_framework_prefix" => parse_value!(python_framework_prefix, value),
unknown => warn!("unknown config key `{}`", unknown),
}
}
let version = version.ok_or("missing value for version")?;
let implementation = implementation.unwrap_or(PythonImplementation::CPython);
let flags_contains_free_threaded = if let Some(ref flags) = build_flags {
flags.0.contains(&BuildFlag::Py_GIL_DISABLED)
} else {
false
};
let target_abi = if let Some(target_abi) = target_abi {
ensure!(
abi3.is_none(),
"Invalid config that sets both target_abi and abi3."
);
target_abi
} else if flags_contains_free_threaded {
PythonAbiBuilder::new(implementation, version)
.free_threaded()
.finalize()?
} else if abi3 == Some(true) {
warn!("abi3 configuration file option is deprecated since pyo3 0.29, set target_abi instead");
PythonAbiBuilder::new(implementation, version)
.stable_abi(StableAbi::Abi3)
.finalize()?
} else {
PythonAbiBuilder::new(implementation, version).finalize()?
};
let builder = InterpreterConfigBuilder::new(implementation, version)
.target_abi(target_abi)
.shared(shared.unwrap_or(true))
.lib_name(lib_name)
.lib_dir(lib_dir)
.executable(executable)
.pointer_width(pointer_width)
.build_flags(build_flags.unwrap_or_default())
.suppress_build_script_link_lines(suppress_build_script_link_lines.unwrap_or(false))
.extra_build_script_lines(extra_build_script_lines)
.python_framework_prefix(python_framework_prefix);
builder.finalize()
}
#[doc(hidden)]
pub fn to_cargo_dep_env(&self) -> Result<()> {
let mut buf = Vec::new();
self.to_writer(&mut buf)?;
println!("cargo:PYO3_CONFIG={}", escape(&buf));
Ok(())
}
#[doc(hidden)]
pub fn to_writer(&self, mut writer: impl Write) -> Result<()> {
macro_rules! write_line {
($value:ident) => {
writeln!(writer, "{}={}", stringify!($value), self.$value).context(concat!(
"failed to write ",
stringify!($value),
" to config"
))
};
}
macro_rules! write_option_line {
($value:ident) => {
if let Some(value) = &self.$value {
writeln!(writer, "{}={}", stringify!($value), value).context(concat!(
"failed to write ",
stringify!($value),
" to config"
))
} else {
Ok(())
}
};
}
write_line!(implementation)?;
write_line!(version)?;
write_line!(shared)?;
write_line!(target_abi)?;
write_option_line!(lib_name)?;
write_option_line!(lib_dir)?;
write_option_line!(executable)?;
write_option_line!(pointer_width)?;
write_line!(build_flags)?;
write_option_line!(python_framework_prefix)?;
write_line!(suppress_build_script_link_lines)?;
for line in &self.extra_build_script_lines {
writeln!(writer, "extra_build_script_line={line}")
.context("failed to write extra_build_script_line")?;
}
Ok(())
}
pub fn run_python_script(&self, script: &str) -> Result<String> {
run_python_script_with_envs(
Path::new(self.executable.as_ref().expect("no interpreter executable")),
script,
std::iter::empty::<(&str, &str)>(),
)
}
pub fn run_python_script_with_envs<I, K, V>(&self, script: &str, envs: I) -> Result<String>
where
I: IntoIterator<Item = (K, V)>,
K: AsRef<OsStr>,
V: AsRef<OsStr>,
{
run_python_script_with_envs(
Path::new(self.executable.as_ref().expect("no interpreter executable")),
script,
envs,
)
}
pub fn is_free_threaded(&self) -> bool {
self.target_abi.kind().is_free_threaded()
}
fn apply_build_env(mut self) -> Result<InterpreterConfig> {
let implementation = self.target_abi.implementation;
let gil_disabled = self.target_abi.kind().is_free_threaded();
let stable_abi = applicable_stable_abi(
implementation,
self.version,
gil_disabled,
get_abi3_version(),
get_abi3t_version(),
);
self.target_abi =
PythonAbi::from_stable_abi(implementation, self.version, stable_abi, gil_disabled)?;
Ok(self)
}
}
#[cfg_attr(test, derive(Debug))]
pub struct PythonAbiBuilder {
implementation: PythonImplementation,
version: PythonVersion,
kind: Option<PythonAbiKind>,
}
impl PythonAbiBuilder {
pub fn new(implementation: PythonImplementation, version: PythonVersion) -> PythonAbiBuilder {
PythonAbiBuilder {
implementation,
version,
kind: None,
}
}
pub fn stable_abi(self, kind: StableAbi) -> PythonAbiBuilder {
let mut build_version = self.version;
if self.version.minor > STABLE_ABI_MAX_MINOR {
warn!("Automatically falling back to {kind}-py3{STABLE_ABI_MAX_MINOR} because current Python is higher than the maximum supported");
build_version.minor = STABLE_ABI_MAX_MINOR;
}
PythonAbiBuilder {
kind: Some(PythonAbiKind::Stable(kind)),
version: build_version,
..self
}
}
pub fn free_threaded(self) -> PythonAbiBuilder {
PythonAbiBuilder {
kind: Some(PythonAbiKind::VersionSpecific(GilUsed::FreeThreaded)),
..self
}
}
pub fn finalize(self) -> Result<PythonAbi> {
let kind = self.kind.unwrap_or(match self.implementation {
PythonImplementation::RustPython => PythonAbiKind::Stable(StableAbi::Abi3t),
_ => PythonAbiKind::VersionSpecific(GilUsed::GilEnabled),
});
if matches!(self.implementation, PythonImplementation::RustPython) {
ensure!(matches!(kind, PythonAbiKind::Stable(StableAbi::Abi3t)),
"RustPython only supports targeting abi3t, it does not allow targeting other Python ABIs. Currently targeting '{kind}'")
}
if matches!(kind, PythonAbiKind::VersionSpecific(GilUsed::FreeThreaded))
&& self.version
< (PythonVersion {
major: 3,
minor: 13,
})
{
bail!(
"Cannot target free-threaded builds for Python versions before 3.13, tried to build for {}", self.version
)
}
Ok(PythonAbi {
implementation: self.implementation,
kind,
version: self.version,
})
}
}
#[non_exhaustive]
#[derive(Copy, Clone, PartialEq, Eq)]
#[cfg_attr(test, derive(Debug))]
pub struct PythonAbi {
implementation: PythonImplementation,
kind: PythonAbiKind,
version: PythonVersion,
}
impl Display for PythonAbi {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}-{}-{}", self.implementation, self.kind, self.version)
}
}
impl FromStr for PythonAbi {
type Err = crate::errors::Error;
fn from_str(value: &str) -> Result<Self, Self::Err> {
let mut parts = value.splitn(3, '-');
Ok(PythonAbi {
implementation: parts
.next()
.ok_or_else(|| format!("Invalid ABI string representation: {value}"))?
.parse()?,
kind: parts
.next()
.ok_or_else(|| format!("Invalid ABI string representation: {value}"))?
.parse()?,
version: parts
.next()
.ok_or_else(|| format!("Invalid ABI string representation: {value}"))?
.parse()?,
})
}
}
impl PythonAbi {
fn from_stable_abi(
implementation: PythonImplementation,
version: PythonVersion,
stable_abi: Option<(StableAbi, PythonVersion)>,
gil_disabled: bool,
) -> Result<PythonAbi> {
let builder = match stable_abi {
Some((kind, min_version)) => {
ensure!(
min_version <= version,
"cannot set a minimum Python version {} higher than the interpreter version {} \
(the minimum Python version is implied by the {}-py3{} feature)",
min_version,
version,
kind,
min_version.minor
);
PythonAbiBuilder::new(implementation, min_version).stable_abi(kind)
}
None if gil_disabled => PythonAbiBuilder::new(implementation, version).free_threaded(),
None => PythonAbiBuilder::new(implementation, version),
};
builder.finalize()
}
pub fn from_build_env(
implementation: PythonImplementation,
version: PythonVersion,
stable_abi_version: Option<PythonVersion>,
gil_disabled: bool,
) -> Result<PythonAbi> {
let builder = PythonAbiBuilder {
implementation,
version: sanitize_stable_abi_version(stable_abi_version, version)?,
kind: None,
};
let builder = if get_abi3t_version().is_some() && version >= MINIMUM_SUPPORTED_VERSION_ABI3T
{
builder.stable_abi(StableAbi::Abi3t)
} else if get_abi3_version().is_some() && !gil_disabled {
builder.stable_abi(StableAbi::Abi3)
} else if gil_disabled {
builder.free_threaded()
} else {
builder
};
builder.finalize()
}
pub fn implementation(&self) -> PythonImplementation {
self.implementation
}
pub fn kind(&self) -> PythonAbiKind {
self.kind
}
pub fn version(&self) -> PythonVersion {
self.version
}
}
#[derive(Clone, Copy, PartialEq, Eq)]
#[cfg_attr(test, derive(Debug))]
pub enum PythonAbiKind {
Stable(StableAbi),
VersionSpecific(GilUsed),
}
impl Display for PythonAbiKind {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
PythonAbiKind::Stable(stable_abi) => write!(f, "{stable_abi}"),
PythonAbiKind::VersionSpecific(gil_used) => {
write!(f, "{gil_used}")
}
}
}
}
impl FromStr for PythonAbiKind {
type Err = crate::errors::Error;
fn from_str(value: &str) -> Result<Self, Self::Err> {
match value {
"abi3" => Ok(PythonAbiKind::Stable(StableAbi::Abi3)),
"abi3t" => Ok(PythonAbiKind::Stable(StableAbi::Abi3t)),
"free_threaded" => Ok(PythonAbiKind::VersionSpecific(GilUsed::FreeThreaded)),
"gil_enabled" => Ok(PythonAbiKind::VersionSpecific(GilUsed::GilEnabled)),
_ => Err(format!("Unrecognized ABI name: {value}").into()),
}
}
}
impl PythonAbiKind {
pub fn is_free_threaded(self) -> bool {
match self {
PythonAbiKind::VersionSpecific(gil_disabled) => gil_disabled == GilUsed::FreeThreaded,
PythonAbiKind::Stable(StableAbi::Abi3) => false,
PythonAbiKind::Stable(StableAbi::Abi3t) => true,
}
}
}
#[derive(Clone, Copy, PartialEq, Eq)]
#[cfg_attr(test, derive(Debug))]
pub enum StableAbi {
Abi3,
Abi3t,
}
impl Display for StableAbi {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
StableAbi::Abi3 => write!(f, "abi3"),
StableAbi::Abi3t => write!(f, "abi3t"),
}
}
}
#[derive(Clone, Copy, PartialEq, Eq)]
#[cfg_attr(test, derive(Debug))]
pub enum GilUsed {
GilEnabled,
FreeThreaded,
}
impl Display for GilUsed {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
GilUsed::GilEnabled => write!(f, "gil_enabled"),
GilUsed::FreeThreaded => write!(f, "free_threaded"),
}
}
}
#[cfg_attr(test, derive(Debug))]
pub struct InterpreterConfigBuilder {
implementation: PythonImplementation,
version: PythonVersion,
shared: bool,
target_abi: Option<PythonAbi>,
lib_name: Option<String>,
lib_dir: Option<String>,
executable: Option<String>,
pointer_width: Option<u32>,
build_flags: BuildFlags,
suppress_build_script_link_lines: bool,
extra_build_script_lines: Vec<String>,
python_framework_prefix: Option<String>,
}
impl InterpreterConfigBuilder {
pub fn new(
implementation: PythonImplementation,
version: PythonVersion,
) -> InterpreterConfigBuilder {
InterpreterConfigBuilder {
implementation,
version,
shared: true,
target_abi: None,
lib_name: None,
lib_dir: None,
executable: None,
pointer_width: None,
build_flags: BuildFlags::default(),
suppress_build_script_link_lines: false,
extra_build_script_lines: vec![],
python_framework_prefix: None,
}
}
pub fn target_abi(self, target_abi: PythonAbi) -> InterpreterConfigBuilder {
InterpreterConfigBuilder {
target_abi: Some(target_abi),
..self
}
}
pub fn stable_abi(self, kind: StableAbi) -> InterpreterConfigBuilder {
let implementation = self.implementation;
let version = self.version;
self.target_abi(
PythonAbiBuilder::new(implementation, version)
.stable_abi(kind)
.finalize()
.unwrap(),
)
}
pub fn free_threaded(self) -> Result<InterpreterConfigBuilder> {
let implementation = self.implementation;
let version = self.version;
Ok(self.target_abi(
PythonAbiBuilder::new(implementation, version)
.free_threaded()
.finalize()?,
))
}
pub fn lib_name(mut self, lib_name: impl Into<Option<String>>) -> InterpreterConfigBuilder {
self.lib_name = lib_name.into();
self
}
pub fn pointer_width(
mut self,
pointer_width: impl Into<Option<u32>>,
) -> InterpreterConfigBuilder {
self.pointer_width = pointer_width.into();
self
}
pub fn executable(mut self, executable: impl Into<Option<String>>) -> InterpreterConfigBuilder {
self.executable = executable.into();
self
}
pub fn suppress_build_script_link_lines(
mut self,
suppress_build_script_link_lines: bool,
) -> InterpreterConfigBuilder {
self.suppress_build_script_link_lines = suppress_build_script_link_lines;
self
}
pub fn extra_build_script_lines(
mut self,
extra_build_script_lines: Vec<String>,
) -> InterpreterConfigBuilder {
self.extra_build_script_lines = extra_build_script_lines;
self
}
pub fn lib_dir(mut self, lib_dir: impl Into<Option<String>>) -> InterpreterConfigBuilder {
self.lib_dir = lib_dir.into();
self
}
pub fn shared(mut self, shared: bool) -> InterpreterConfigBuilder {
self.shared = shared;
self
}
pub fn build_flags(mut self, build_flags: BuildFlags) -> InterpreterConfigBuilder {
self.build_flags = build_flags;
self
}
pub fn python_framework_prefix(
mut self,
python_framework_prefix: impl Into<Option<String>>,
) -> InterpreterConfigBuilder {
self.python_framework_prefix = python_framework_prefix.into();
self
}
pub fn finalize(self) -> Result<InterpreterConfig> {
let mut build_flags = self.build_flags.clone();
let py_gil_disabled = build_flags.0.contains(&BuildFlag::Py_GIL_DISABLED);
let target_abi = match (self.target_abi, py_gil_disabled) {
(None, false) => PythonAbiBuilder::new(self.implementation, self.version).finalize()?,
(None, true) => PythonAbiBuilder::new(self.implementation, self.version)
.free_threaded()
.finalize()?,
(Some(target_abi), false) => target_abi,
(Some(target_abi), true) => match target_abi.kind() {
PythonAbiKind::Stable(StableAbi::Abi3) => {
let new_abi =
PythonAbiBuilder::new(target_abi.implementation(), target_abi.version())
.free_threaded()
.finalize()?;
warn!(
"Targeting an abi3 build but build_flags contains Py_GIL_DISABLED, \
falling back to a version-specific free-threaded build"
);
new_abi
}
PythonAbiKind::VersionSpecific(GilUsed::GilEnabled) => bail!(
"build_flags contains Py_GIL_DISABLED but target_abi \
'{target_abi}' is not free-threaded"
),
_ => target_abi,
},
};
if target_abi.kind().is_free_threaded() {
build_flags.0.insert(BuildFlag::Py_GIL_DISABLED);
}
#[expect(
deprecated,
reason = "constructing an InterpreterConfig directly, need to write to fields"
)]
Ok(InterpreterConfig {
implementation: self.implementation,
version: self.version,
shared: self.shared,
target_abi,
abi3: matches!(target_abi.kind(), PythonAbiKind::Stable(StableAbi::Abi3)),
lib_name: self.lib_name,
lib_dir: self.lib_dir,
executable: self.executable,
pointer_width: self.pointer_width,
build_flags,
suppress_build_script_link_lines: self.suppress_build_script_link_lines,
extra_build_script_lines: self.extra_build_script_lines,
python_framework_prefix: self.python_framework_prefix,
})
}
}
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub struct PythonVersion {
pub major: u8,
pub minor: u8,
}
impl PythonVersion {
#[cfg(test)]
pub(crate) const PY315: Self = PythonVersion {
major: 3,
minor: 15,
};
#[cfg(test)]
pub(crate) const PY314: Self = PythonVersion {
major: 3,
minor: 14,
};
#[deprecated(
since = "0.29.0",
note = "please construct `PythonVersion` directly rather than use these constants"
)]
pub const PY313: Self = PythonVersion {
major: 3,
minor: 13,
};
#[deprecated(
since = "0.29.0",
note = "please construct `PythonVersion` directly rather than use these constants"
)]
pub const PY312: Self = PythonVersion {
major: 3,
minor: 12,
};
#[cfg(test)]
const PY311: Self = PythonVersion {
major: 3,
minor: 11,
};
const PY310: Self = PythonVersion {
major: 3,
minor: 10,
};
#[cfg(test)]
const PY39: Self = PythonVersion { major: 3, minor: 9 };
#[cfg(test)]
const PY38: Self = PythonVersion { major: 3, minor: 8 };
}
impl Display for PythonVersion {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}.{}", self.major, self.minor)
}
}
impl FromStr for PythonVersion {
type Err = crate::errors::Error;
fn from_str(value: &str) -> Result<Self, Self::Err> {
let mut split = value.splitn(2, '.');
let (major, minor) = (
split
.next()
.expect("first splitn value should always be present"),
split.next().ok_or("expected major.minor version")?,
);
Ok(Self {
major: major.parse().context("failed to parse major version")?,
minor: minor.parse().context("failed to parse minor version")?,
})
}
}
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum PythonImplementation {
CPython,
PyPy,
GraalPy,
RustPython,
}
impl PythonImplementation {
fn is_pypy(self) -> bool {
self == PythonImplementation::PyPy
}
fn from_soabi(soabi: &str) -> Result<Self> {
if soabi.starts_with("pypy") {
Ok(PythonImplementation::PyPy)
} else if soabi.starts_with("cpython") {
Ok(PythonImplementation::CPython)
} else if soabi.starts_with("graalpy") {
Ok(PythonImplementation::GraalPy)
} else {
bail!("unsupported Python interpreter");
}
}
}
impl Display for PythonImplementation {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
PythonImplementation::CPython => write!(f, "CPython"),
PythonImplementation::PyPy => write!(f, "PyPy"),
PythonImplementation::GraalPy => write!(f, "GraalVM"),
PythonImplementation::RustPython => write!(f, "RustPython"),
}
}
}
impl FromStr for PythonImplementation {
type Err = Error;
fn from_str(s: &str) -> Result<Self> {
match s {
"CPython" => Ok(PythonImplementation::CPython),
"PyPy" => Ok(PythonImplementation::PyPy),
"GraalVM" => Ok(PythonImplementation::GraalPy),
"RustPython" => Ok(PythonImplementation::RustPython),
_ => bail!("unknown interpreter: {}", s),
}
}
}
fn have_python_interpreter() -> bool {
env_var("PYO3_NO_PYTHON").is_none()
}
#[derive(Debug, Copy, Clone)]
pub enum StableAbiVersion {
Current,
Target(PythonVersion),
}
pub fn get_abi3_version() -> Option<StableAbiVersion> {
let minor_version = (MINIMUM_SUPPORTED_VERSION.minor..=STABLE_ABI_MAX_MINOR)
.find(|i| cargo_env_var(&format!("CARGO_FEATURE_ABI3_PY3{i}")).is_some());
minor_version.map_or(
if cargo_env_var("CARGO_FEATURE_ABI3").is_some() {
Some(StableAbiVersion::Current)
} else {
None
},
|minor| Some(StableAbiVersion::Target(PythonVersion { major: 3, minor })),
)
}
pub fn get_abi3t_version() -> Option<StableAbiVersion> {
let minor_version = (MINIMUM_SUPPORTED_VERSION_ABI3T.minor..=STABLE_ABI_MAX_MINOR)
.find(|i| cargo_env_var(&format!("CARGO_FEATURE_ABI3T_PY3{i}")).is_some());
minor_version.map_or(
if cargo_env_var("CARGO_FEATURE_ABI3T").is_some() {
Some(StableAbiVersion::Current)
} else {
None
},
|minor| Some(StableAbiVersion::Target(PythonVersion { major: 3, minor })),
)
}
pub fn is_extension_module() -> bool {
cargo_env_var("CARGO_FEATURE_EXTENSION_MODULE").is_some()
|| env_var("PYO3_BUILD_EXTENSION_MODULE").is_some()
}
pub fn is_linking_libpython_for_target(target: &Triple) -> bool {
target.operating_system == OperatingSystem::Windows
|| target.operating_system == OperatingSystem::Aix
|| target.environment == Environment::Android
|| target.environment == Environment::Androideabi
|| target.operating_system == OperatingSystem::Cygwin
|| matches!(target.operating_system, OperatingSystem::IOS(_))
|| !is_extension_module()
}
fn require_libdir_for_target(target: &Triple) -> bool {
if target.operating_system == OperatingSystem::Windows {
return false;
}
is_linking_libpython_for_target(target)
}
#[derive(Debug, PartialEq, Eq)]
pub struct CrossCompileConfig {
pub lib_dir: Option<PathBuf>,
version: Option<PythonVersion>,
implementation: Option<PythonImplementation>,
target: Triple,
abiflags: Option<String>,
}
impl CrossCompileConfig {
fn try_from_env_vars_host_target(
env_vars: CrossCompileEnvVars,
host: &Triple,
target: &Triple,
) -> Result<Option<Self>> {
if env_vars.any() || Self::is_cross_compiling_from_to(host, target) {
let lib_dir = env_vars.lib_dir_path()?;
let (version, abiflags) = env_vars.parse_version()?;
let implementation = env_vars.parse_implementation()?;
let target = target.clone();
Ok(Some(CrossCompileConfig {
lib_dir,
version,
implementation,
target,
abiflags,
}))
} else {
Ok(None)
}
}
fn is_cross_compiling_from_to(host: &Triple, target: &Triple) -> bool {
let mut compatible = host.architecture == target.architecture
&& (host.vendor == target.vendor
|| (host.vendor == Vendor::Pc && target.vendor.as_str() == "win7"))
&& host.operating_system == target.operating_system;
compatible |= target.operating_system == OperatingSystem::Windows
&& host.operating_system == OperatingSystem::Windows
&& matches!(target.architecture, Architecture::X86_32(_))
&& host.architecture == Architecture::X86_64;
compatible |= matches!(target.operating_system, OperatingSystem::Darwin(_))
&& matches!(host.operating_system, OperatingSystem::Darwin(_));
compatible |= matches!(target.operating_system, OperatingSystem::IOS(_));
!compatible
}
fn lib_dir_string(&self) -> Option<String> {
self.lib_dir
.as_ref()
.map(|s| s.to_str().unwrap().to_owned())
}
}
struct CrossCompileEnvVars {
pyo3_cross: Option<OsString>,
pyo3_cross_lib_dir: Option<OsString>,
pyo3_cross_python_version: Option<OsString>,
pyo3_cross_python_implementation: Option<OsString>,
}
impl CrossCompileEnvVars {
fn from_env() -> Self {
CrossCompileEnvVars {
pyo3_cross: env_var("PYO3_CROSS"),
pyo3_cross_lib_dir: env_var("PYO3_CROSS_LIB_DIR"),
pyo3_cross_python_version: env_var("PYO3_CROSS_PYTHON_VERSION"),
pyo3_cross_python_implementation: env_var("PYO3_CROSS_PYTHON_IMPLEMENTATION"),
}
}
fn any(&self) -> bool {
self.pyo3_cross.is_some()
|| self.pyo3_cross_lib_dir.is_some()
|| self.pyo3_cross_python_version.is_some()
|| self.pyo3_cross_python_implementation.is_some()
}
fn parse_version(&self) -> Result<(Option<PythonVersion>, Option<String>)> {
match self.pyo3_cross_python_version.as_ref() {
Some(os_string) => {
let utf8_str = os_string
.to_str()
.ok_or("PYO3_CROSS_PYTHON_VERSION is not valid a UTF-8 string")?;
let (utf8_str, abiflags) = if let Some(version) = utf8_str.strip_suffix('t') {
(version, Some("t".to_string()))
} else {
(utf8_str, None)
};
let version = utf8_str
.parse()
.context("failed to parse PYO3_CROSS_PYTHON_VERSION")?;
Ok((Some(version), abiflags))
}
None => Ok((None, None)),
}
}
fn parse_implementation(&self) -> Result<Option<PythonImplementation>> {
let implementation = self
.pyo3_cross_python_implementation
.as_ref()
.map(|os_string| {
let utf8_str = os_string
.to_str()
.ok_or("PYO3_CROSS_PYTHON_IMPLEMENTATION is not valid a UTF-8 string")?;
utf8_str
.parse()
.context("failed to parse PYO3_CROSS_PYTHON_IMPLEMENTATION")
})
.transpose()?;
Ok(implementation)
}
fn lib_dir_path(&self) -> Result<Option<PathBuf>> {
let lib_dir = self.pyo3_cross_lib_dir.as_ref().map(PathBuf::from);
if let Some(dir) = lib_dir.as_ref() {
ensure!(
dir.to_str().is_some(),
"PYO3_CROSS_LIB_DIR variable value is not a valid UTF-8 string"
);
}
Ok(lib_dir)
}
}
pub fn cross_compiling_from_to(
host: &Triple,
target: &Triple,
) -> Result<Option<CrossCompileConfig>> {
let env_vars = CrossCompileEnvVars::from_env();
CrossCompileConfig::try_from_env_vars_host_target(env_vars, host, target)
}
#[allow(non_camel_case_types)]
#[derive(Debug, Clone, Hash, PartialEq, Eq)]
pub enum BuildFlag {
Py_DEBUG,
Py_REF_DEBUG,
#[deprecated(since = "0.29.0", note = "no longer supported by PyO3")]
Py_TRACE_REFS,
Py_GIL_DISABLED,
COUNT_ALLOCS,
Other(String),
}
impl Display for BuildFlag {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
BuildFlag::Other(flag) => write!(f, "{flag}"),
_ => write!(f, "{self:?}"),
}
}
}
impl FromStr for BuildFlag {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> Result<Self, Self::Err> {
match s {
"Py_DEBUG" => Ok(BuildFlag::Py_DEBUG),
"Py_REF_DEBUG" => Ok(BuildFlag::Py_REF_DEBUG),
"Py_GIL_DISABLED" => Ok(BuildFlag::Py_GIL_DISABLED),
"COUNT_ALLOCS" => Ok(BuildFlag::COUNT_ALLOCS),
other => Ok(BuildFlag::Other(other.to_owned())),
}
}
}
#[cfg_attr(test, derive(Debug, PartialEq, Eq))]
#[derive(Clone, Default)]
pub struct BuildFlags(pub HashSet<BuildFlag>);
impl BuildFlags {
const ALL: [BuildFlag; 4] = [
BuildFlag::Py_DEBUG,
BuildFlag::Py_REF_DEBUG,
BuildFlag::Py_GIL_DISABLED,
BuildFlag::COUNT_ALLOCS,
];
pub fn new() -> Self {
BuildFlags(HashSet::new())
}
fn from_sysconfigdata(config_map: &Sysconfigdata) -> Self {
Self(
BuildFlags::ALL
.iter()
.filter(|flag| config_map.get_value(flag.to_string()) == Some("1"))
.cloned()
.collect(),
)
.fixup()
}
fn from_interpreter(interpreter: impl AsRef<Path>) -> Result<Self> {
if cfg!(windows) {
let script = String::from("import sys;print(sys.version_info < (3, 13))");
let stdout = run_python_script(interpreter.as_ref(), &script)?;
if stdout.trim_end() == "True" {
return Ok(Self::new());
}
}
let mut script = String::from("import sysconfig\n");
script.push_str("config = sysconfig.get_config_vars()\n");
for k in &BuildFlags::ALL {
use std::fmt::Write;
writeln!(&mut script, "print(config.get('{k}', '0'))").unwrap();
}
let stdout = run_python_script(interpreter.as_ref(), &script)?;
let split_stdout: Vec<&str> = stdout.trim_end().lines().collect();
ensure!(
split_stdout.len() == BuildFlags::ALL.len(),
"Python stdout len didn't return expected number of lines: {}",
split_stdout.len()
);
let flags = BuildFlags::ALL
.iter()
.zip(split_stdout)
.filter(|(_, flag_value)| *flag_value == "1")
.map(|(flag, _)| flag.clone())
.collect();
Ok(Self(flags).fixup())
}
fn fixup(mut self) -> Self {
if self.0.contains(&BuildFlag::Py_DEBUG) {
self.0.insert(BuildFlag::Py_REF_DEBUG);
}
self
}
}
impl Display for BuildFlags {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut first = true;
for flag in &self.0 {
if first {
first = false;
} else {
write!(f, ",")?;
}
write!(f, "{flag}")?;
}
Ok(())
}
}
impl FromStr for BuildFlags {
type Err = std::convert::Infallible;
fn from_str(value: &str) -> Result<Self, Self::Err> {
let mut flags = HashSet::new();
for flag in value.split_terminator(',') {
flags.insert(flag.parse().unwrap());
}
Ok(BuildFlags(flags))
}
}
fn parse_script_output(output: &str) -> HashMap<String, String> {
output
.lines()
.filter_map(|line| {
let mut i = line.splitn(2, ' ');
Some((i.next()?.into(), i.next()?.into()))
})
.collect()
}
pub struct Sysconfigdata(HashMap<String, String>);
impl Sysconfigdata {
pub fn get_value<S: AsRef<str>>(&self, k: S) -> Option<&str> {
self.0.get(k.as_ref()).map(String::as_str)
}
#[cfg(test)]
fn new() -> Self {
Sysconfigdata(HashMap::new())
}
#[cfg(test)]
fn insert<S: Into<String>>(&mut self, k: S, v: S) {
self.0.insert(k.into(), v.into());
}
}
pub fn parse_sysconfigdata(sysconfigdata_path: impl AsRef<Path>) -> Result<Sysconfigdata> {
let sysconfigdata_path = sysconfigdata_path.as_ref();
let mut script = fs::read_to_string(sysconfigdata_path).with_context(|| {
format!(
"failed to read config from {}",
sysconfigdata_path.display()
)
})?;
script += r#"
for key, val in build_time_vars.items():
# (ana)conda(-forge) built Pythons are statically linked but ship the shared library with them.
# We detect them based on the magic prefix directory they have encoded in their builds.
if key == "Py_ENABLE_SHARED" and "_h_env_placehold" in build_time_vars.get("prefix"):
val = 1
print(key, val)
"#;
let output = run_python_script(&find_interpreter()?, &script)?;
Ok(Sysconfigdata(parse_script_output(&output)))
}
fn starts_with(entry: &DirEntry, pat: &str) -> bool {
let name = entry.file_name();
name.to_string_lossy().starts_with(pat)
}
fn ends_with(entry: &DirEntry, pat: &str) -> bool {
let name = entry.file_name();
name.to_string_lossy().ends_with(pat)
}
fn find_sysconfigdata(cross: &CrossCompileConfig) -> Result<Option<PathBuf>> {
let mut sysconfig_paths = find_all_sysconfigdata(cross)?;
if sysconfig_paths.is_empty() {
if let Some(lib_dir) = cross.lib_dir.as_ref() {
bail!("Could not find _sysconfigdata*.py in {}", lib_dir.display());
} else {
return Ok(None);
}
} else if sysconfig_paths.len() > 1 {
let mut error_msg = String::from(
"Detected multiple possible Python versions. Please set either the \
PYO3_CROSS_PYTHON_VERSION variable to the wanted version or the \
_PYTHON_SYSCONFIGDATA_NAME variable to the wanted sysconfigdata file name.\n\n\
sysconfigdata files found:",
);
for path in sysconfig_paths {
use std::fmt::Write;
write!(&mut error_msg, "\n\t{}", path.display()).unwrap();
}
bail!("{}\n", error_msg);
}
Ok(Some(sysconfig_paths.remove(0)))
}
pub fn find_all_sysconfigdata(cross: &CrossCompileConfig) -> Result<Vec<PathBuf>> {
let sysconfig_paths = if let Some(lib_dir) = cross.lib_dir.as_ref() {
search_lib_dir(lib_dir, cross).with_context(|| {
format!(
"failed to search the lib dir at 'PYO3_CROSS_LIB_DIR={}'",
lib_dir.display()
)
})?
} else {
return Ok(Vec::new());
};
let sysconfig_name = env_var("_PYTHON_SYSCONFIGDATA_NAME");
let mut sysconfig_paths = sysconfig_paths
.iter()
.filter_map(|p| {
let canonical = fs::canonicalize(p).ok();
match &sysconfig_name {
Some(_) => canonical.filter(|p| p.file_stem() == sysconfig_name.as_deref()),
None => canonical,
}
})
.collect::<Vec<PathBuf>>();
sysconfig_paths.sort();
sysconfig_paths.dedup();
Ok(sysconfig_paths)
}
fn is_pypy_lib_dir(path: &str, v: &Option<PythonVersion>) -> bool {
let pypy_version_pat = if let Some(v) = v {
format!("pypy{v}")
} else {
"pypy3.".into()
};
path == "lib_pypy" || path.starts_with(&pypy_version_pat)
}
fn is_graalpy_lib_dir(path: &str, v: &Option<PythonVersion>) -> bool {
let graalpy_version_pat = if let Some(v) = v {
format!("graalpy{v}")
} else {
"graalpy2".into()
};
path == "lib_graalpython" || path.starts_with(&graalpy_version_pat)
}
fn is_cpython_lib_dir(path: &str, v: &Option<PythonVersion>) -> bool {
let cpython_version_pat = if let Some(v) = v {
format!("python{v}")
} else {
"python3.".into()
};
path.starts_with(&cpython_version_pat)
}
fn search_lib_dir(path: impl AsRef<Path>, cross: &CrossCompileConfig) -> Result<Vec<PathBuf>> {
let mut sysconfig_paths = vec![];
for f in fs::read_dir(path.as_ref()).with_context(|| {
format!(
"failed to list the entries in '{}'",
path.as_ref().display()
)
})? {
sysconfig_paths.extend(match &f {
Ok(f) if starts_with(f, "_sysconfigdata_") && ends_with(f, "py") => vec![f.path()],
Ok(f) if f.metadata().is_ok_and(|metadata| metadata.is_dir()) => {
let file_name = f.file_name();
let file_name = file_name.to_string_lossy();
if file_name == "build" || file_name == "lib" {
search_lib_dir(f.path(), cross)?
} else if file_name.starts_with("lib.") {
if !file_name.contains(&cross.target.operating_system.to_string()) {
continue;
}
if !file_name.contains(&cross.target.architecture.to_string()) {
continue;
}
search_lib_dir(f.path(), cross)?
} else if is_cpython_lib_dir(&file_name, &cross.version)
|| is_pypy_lib_dir(&file_name, &cross.version)
|| is_graalpy_lib_dir(&file_name, &cross.version)
{
search_lib_dir(f.path(), cross)?
} else {
continue;
}
}
_ => continue,
});
}
if sysconfig_paths.len() > 1 {
let temp = sysconfig_paths
.iter()
.filter(|p| {
p.to_string_lossy()
.contains(&cross.target.architecture.to_string())
})
.cloned()
.collect::<Vec<PathBuf>>();
if !temp.is_empty() {
sysconfig_paths = temp;
}
}
Ok(sysconfig_paths)
}
fn cross_compile_from_sysconfigdata(
cross_compile_config: &CrossCompileConfig,
) -> Result<Option<InterpreterConfig>> {
if let Some(path) = find_sysconfigdata(cross_compile_config)? {
let data = parse_sysconfigdata(path)?;
let mut config = InterpreterConfig::from_sysconfigdata(&data)?;
#[expect(deprecated, reason = "modifying config inline")]
if let Some(cross_lib_dir) = cross_compile_config.lib_dir_string() {
config.lib_dir = Some(cross_lib_dir)
}
Ok(Some(config))
} else {
Ok(None)
}
}
fn exact_stable_abi_version(version: Option<StableAbiVersion>) -> Option<PythonVersion> {
version.and_then(|v| match v {
StableAbiVersion::Current => None,
StableAbiVersion::Target(inner) => Some(inner),
})
}
fn default_cross_compile(cross_compile_config: &CrossCompileConfig) -> Result<InterpreterConfig> {
let version = cross_compile_config
.version
.or_else(|| exact_stable_abi_version(get_abi3_version()))
.or_else(|| exact_stable_abi_version(get_abi3t_version()))
.ok_or_else(||
format!(
"PYO3_CROSS_PYTHON_VERSION or either an abi3-py3* or abi3t-py3* feature must be specified \
when cross-compiling and PYO3_CROSS_LIB_DIR is not set.\n\
= help: see the PyO3 user guide for more information: https://pyo3.rs/v{}/building-and-distribution.html#cross-compiling",
env!("CARGO_PKG_VERSION")
)
)?;
let gil_disabled = cross_compile_config.abiflags.as_deref() == Some("t");
let implementation = cross_compile_config
.implementation
.unwrap_or(PythonImplementation::CPython);
let stable_abi =
applicable_stable_abi_at_interpreter_version(implementation, version, gil_disabled);
let target_abi = PythonAbi::from_stable_abi(implementation, version, stable_abi, gil_disabled)?;
let lib_name = default_lib_name_for_target(target_abi, &cross_compile_config.target);
let lib_dir = cross_compile_config.lib_dir_string();
InterpreterConfigBuilder::new(implementation, version)
.target_abi(target_abi)
.lib_name(lib_name)
.lib_dir(lib_dir)
.finalize()
}
fn default_stable_abi_config(
host: &Triple,
abi3_version: Option<PythonVersion>,
abi3t_version: Option<PythonVersion>,
) -> Result<InterpreterConfig> {
if abi3_version.is_none() && abi3t_version.is_none() {
bail!("Neither abi3 or abi3t features are enabled")
}
let (stable_abi, version) = if let Some(version) = abi3_version {
(StableAbi::Abi3, version)
} else if let Some(version) = abi3t_version {
(StableAbi::Abi3t, version)
} else {
unreachable!();
};
if stable_abi == StableAbi::Abi3t && version < MINIMUM_SUPPORTED_VERSION_ABI3T {
bail!("Cannot target an abi3t version below {MINIMUM_SUPPORTED_VERSION_ABI3T}")
}
let target_abi = PythonAbiBuilder::new(PythonImplementation::CPython, version)
.stable_abi(stable_abi)
.finalize()?;
let builder = InterpreterConfigBuilder::new(PythonImplementation::CPython, version)
.target_abi(target_abi);
if host.operating_system == OperatingSystem::Windows {
builder.lib_name(default_lib_name_windows(target_abi, false, false)?)
} else {
builder
}
.finalize()
}
fn load_cross_compile_config(
cross_compile_config: CrossCompileConfig,
) -> Result<InterpreterConfig> {
let windows = cross_compile_config.target.operating_system == OperatingSystem::Windows;
let config = if windows || !have_python_interpreter() {
default_cross_compile(&cross_compile_config)?
} else if let Some(config) = cross_compile_from_sysconfigdata(&cross_compile_config)? {
config
} else {
default_cross_compile(&cross_compile_config)?
};
Ok(config)
}
const WINDOWS_STABLE_ABI_LIB_NAME: &str = "python3";
const WINDOWS_STABLE_ABI_DEBUG_LIB_NAME: &str = "python3_d";
#[allow(dead_code)]
fn default_lib_name_for_target(abi: PythonAbi, target: &Triple) -> String {
if target.operating_system == OperatingSystem::Windows {
default_lib_name_windows(abi, false, false).unwrap()
} else {
default_lib_name_unix(
abi,
target.operating_system == OperatingSystem::Cygwin,
None,
)
.unwrap()
}
}
fn default_lib_name_windows(abi: PythonAbi, mingw: bool, debug: bool) -> Result<String> {
if mingw {
let mut lib_name = default_lib_name_unix(abi, true, None)?;
lib_name.insert_str(0, "lib");
return Ok(lib_name);
}
if abi.implementation.is_pypy() {
Ok(format!(
"libpypy{}.{}-c",
abi.version.major, abi.version.minor
))
} else if debug && abi.version < PythonVersion::PY310 {
Ok(format!(
"python{}{}_d",
abi.version.major, abi.version.minor
))
} else if abi.kind == PythonAbiKind::Stable(StableAbi::Abi3)
|| abi.kind == PythonAbiKind::Stable(StableAbi::Abi3t)
{
let mut lib_name = if debug {
WINDOWS_STABLE_ABI_DEBUG_LIB_NAME.to_owned()
} else {
WINDOWS_STABLE_ABI_LIB_NAME.to_owned()
};
if abi.kind == PythonAbiKind::Stable(StableAbi::Abi3t) {
lib_name = lib_name.replace("python3", "python3t");
}
Ok(lib_name)
} else if abi.kind().is_free_threaded() {
#[expect(deprecated, reason = "using constant internally")]
{
ensure!(abi.version() >= PythonVersion::PY313, "Cannot compile extensions for the free-threaded build on Python versions earlier than 3.13, found {}.{}", abi.version.major, abi.version.minor);
}
if debug {
Ok(format!(
"python{}{}t_d",
abi.version.major, abi.version.minor
))
} else {
Ok(format!("python{}{}t", abi.version.major, abi.version.minor))
}
} else if debug {
Ok(format!(
"python{}{}_d",
abi.version.major, abi.version.minor
))
} else {
Ok(format!("python{}{}", abi.version.major, abi.version.minor))
}
}
fn default_lib_name_unix(
abi: PythonAbi,
use_stable_abi_lib: bool,
ld_version: Option<&str>,
) -> Result<String> {
match abi.implementation {
PythonImplementation::CPython => match ld_version {
Some(ld_version) => Ok(format!("python{ld_version}")),
None => match abi.kind {
PythonAbiKind::Stable(StableAbi::Abi3) if use_stable_abi_lib => {
Ok("python3".to_string())
}
PythonAbiKind::Stable(StableAbi::Abi3t) if use_stable_abi_lib => {
Ok("python3t".to_string())
}
_ => {
if abi.kind.is_free_threaded() {
#[expect(deprecated, reason = "using constant internally")]
{
ensure!(abi.version >= PythonVersion::PY313, "Cannot compile extensions for the free-threaded build on Python versions earlier than 3.13, found {}.{}", abi.version.major, abi.version.minor);
}
Ok(format!(
"python{}.{}t",
abi.version.major, abi.version.minor
))
} else {
Ok(format!("python{}.{}", abi.version.major, abi.version.minor))
}
}
},
},
PythonImplementation::PyPy => match ld_version {
Some(ld_version) => Ok(format!("pypy{ld_version}-c")),
None => Ok(format!("pypy{}.{}-c", abi.version.major, abi.version.minor)),
},
PythonImplementation::GraalPy => Ok("python-native".to_string()),
PythonImplementation::RustPython => Ok("rustpython_capi".to_string()),
}
}
fn run_python_script(interpreter: &Path, script: &str) -> Result<String> {
run_python_script_with_envs(interpreter, script, std::iter::empty::<(&str, &str)>())
}
fn run_python_script_with_envs<I, K, V>(interpreter: &Path, script: &str, envs: I) -> Result<String>
where
I: IntoIterator<Item = (K, V)>,
K: AsRef<OsStr>,
V: AsRef<OsStr>,
{
let out = Command::new(interpreter)
.env("PYTHONIOENCODING", "utf-8")
.envs(envs)
.stdin(Stdio::piped())
.stdout(Stdio::piped())
.stderr(Stdio::inherit())
.spawn()
.and_then(|mut child| {
child
.stdin
.as_mut()
.expect("piped stdin")
.write_all(script.as_bytes())?;
child.wait_with_output()
});
match out {
Err(err) => bail!(
"failed to run the Python interpreter at {}: {}",
interpreter.display(),
err
),
Ok(ok) if !ok.status.success() => bail!("Python script failed"),
Ok(ok) => Ok(String::from_utf8(ok.stdout)
.context("failed to parse Python script output as utf-8")?),
}
}
fn venv_interpreter(virtual_env: &OsStr, windows: bool) -> PathBuf {
let venv = Path::new(virtual_env);
println!(
"cargo:rerun-if-changed={}",
venv.join("pyvenv.cfg").display()
);
if windows {
venv.join("Scripts").join("python.exe")
} else {
venv.join("bin").join("python")
}
}
fn conda_env_interpreter(conda_prefix: &OsStr, windows: bool) -> PathBuf {
if windows {
Path::new(conda_prefix).join("python.exe")
} else {
Path::new(conda_prefix).join("bin").join("python")
}
}
fn get_env_interpreter() -> Option<PathBuf> {
match (env_var("VIRTUAL_ENV"), env_var("CONDA_PREFIX")) {
(Some(dir), None) => Some(venv_interpreter(&dir, cfg!(windows))),
(None, Some(dir)) => Some(conda_env_interpreter(&dir, cfg!(windows))),
(Some(_), Some(_)) => {
warn!(
"Both VIRTUAL_ENV and CONDA_PREFIX are set. PyO3 will ignore both of these for \
locating the Python interpreter until you unset one of them."
);
None
}
(None, None) => None,
}
}
pub fn find_interpreter() -> Result<PathBuf> {
println!("cargo:rerun-if-env-changed=PYO3_ENVIRONMENT_SIGNATURE");
if let Some(exe) = env_var("PYO3_PYTHON") {
Ok(exe.into())
} else if let Some(env_interpreter) = get_env_interpreter() {
Ok(env_interpreter)
} else {
println!("cargo:rerun-if-env-changed=PATH");
["python", "python3"]
.iter()
.find(|bin| {
if let Ok(out) = Command::new(bin).arg("--version").output() {
out.stdout.starts_with(b"Python 3")
|| out.stderr.starts_with(b"Python 3")
|| out.stdout.starts_with(b"GraalPy 3")
} else {
false
}
})
.map(PathBuf::from)
.ok_or_else(|| "no Python 3.x interpreter found".into())
}
}
fn get_host_interpreter(
abi3_version: Option<StableAbiVersion>,
abi3t_version: Option<StableAbiVersion>,
) -> Result<InterpreterConfig> {
let interpreter_path = find_interpreter()?;
let interpreter_config =
InterpreterConfig::from_interpreter(interpreter_path, abi3_version, abi3t_version)?;
Ok(interpreter_config)
}
pub fn make_cross_compile_config(target: &Triple) -> Result<Option<InterpreterConfig>> {
let interpreter_config =
if let Some(cross_config) = cross_compiling_from_to(&Triple::host(), target)? {
Some(load_cross_compile_config(cross_config)?.apply_build_env()?)
} else {
None
};
Ok(interpreter_config)
}
pub fn make_interpreter_config() -> Result<InterpreterConfig> {
let host = Triple::host();
let abi3_version = get_abi3_version();
let abi3t_version = get_abi3t_version();
let need_interpreter =
(abi3_version.is_none() && abi3t_version.is_none()) || require_libdir_for_target(&host);
if have_python_interpreter() {
match get_host_interpreter(abi3_version, abi3t_version) {
Ok(interpreter_config) => return Ok(interpreter_config),
Err(e) if need_interpreter => return Err(e),
_ => {
warn!("Compiling without a working Python interpreter.");
}
}
}
let interpreter_config = default_stable_abi_config(
&host,
exact_stable_abi_version(abi3_version),
exact_stable_abi_version(abi3t_version),
)?;
Ok(interpreter_config)
}
pub(crate) fn escape(bytes: &[u8]) -> String {
let mut escaped = String::with_capacity(2 * bytes.len());
for byte in bytes {
const LUT: &[u8; 16] = b"0123456789abcdef";
escaped.push(LUT[(byte >> 4) as usize] as char);
escaped.push(LUT[(byte & 0x0F) as usize] as char);
}
escaped
}
fn unescape(escaped: &str) -> Vec<u8> {
assert_eq!(escaped.len() % 2, 0, "invalid hex encoding");
let mut bytes = Vec::with_capacity(escaped.len() / 2);
for chunk in escaped.as_bytes().chunks_exact(2) {
fn unhex(hex: u8) -> u8 {
match hex {
b'a'..=b'f' => hex - b'a' + 10,
b'0'..=b'9' => hex - b'0',
_ => panic!("invalid hex encoding"),
}
}
bytes.push((unhex(chunk[0]) << 4) | unhex(chunk[1]));
}
bytes
}
#[cfg(test)]
#[expect(deprecated, reason = "accessing config fields directly for testing")]
mod tests {
use target_lexicon::triple;
use super::*;
#[test]
fn test_config_file_roundtrip() {
let implementation = PythonImplementation::CPython;
let version = MINIMUM_SUPPORTED_VERSION;
let config = InterpreterConfigBuilder::new(implementation, version)
.stable_abi(StableAbi::Abi3)
.pointer_width(32)
.executable("executable".to_string())
.lib_dir("lib_name".to_string())
.lib_name("lib_name".to_string())
.extra_build_script_lines(vec!["cargo:test1".to_string(), "cargo:test2".to_string()])
.finalize()
.unwrap();
let mut buf: Vec<u8> = Vec::new();
config.to_writer(&mut buf).unwrap();
assert_eq!(config, InterpreterConfig::from_reader(&*buf).unwrap());
let version = PythonVersion::PY310;
let implementation = PythonImplementation::PyPy;
let build_flags = {
let mut flags = HashSet::new();
flags.insert(BuildFlag::Py_DEBUG);
flags.insert(BuildFlag::Other(String::from("Py_SOME_FLAG")));
BuildFlags(flags)
};
let config = InterpreterConfigBuilder::new(implementation, version)
.build_flags(build_flags)
.finalize()
.unwrap();
let mut buf: Vec<u8> = Vec::new();
config.to_writer(&mut buf).unwrap();
assert_eq!(config, InterpreterConfig::from_reader(&*buf).unwrap());
}
#[test]
fn test_config_file_roundtrip_with_escaping() {
let implementation = PythonImplementation::CPython;
let version = MINIMUM_SUPPORTED_VERSION;
let config = InterpreterConfigBuilder::new(implementation, version)
.stable_abi(StableAbi::Abi3)
.pointer_width(32)
.executable("executable".to_string())
.lib_name("lib_name".to_string())
.lib_dir("lib_dir\\n".to_string())
.extra_build_script_lines(vec!["cargo:test1".to_string(), "cargo:test2".to_string()])
.finalize()
.unwrap();
let mut buf: Vec<u8> = Vec::new();
config.to_writer(&mut buf).unwrap();
let buf = unescape(&escape(&buf));
assert_eq!(config, InterpreterConfig::from_reader(&*buf).unwrap());
}
#[test]
fn test_config_file_defaults() {
let implementation = PythonImplementation::CPython;
let version = PythonVersion::PY38;
assert_eq!(
InterpreterConfig::from_reader("version=3.8".as_bytes()).unwrap(),
InterpreterConfigBuilder::new(implementation, version,)
.finalize()
.unwrap()
)
}
#[test]
fn test_config_file_unknown_keys() {
let implementation = PythonImplementation::CPython;
let version = PythonVersion::PY38;
assert_eq!(
InterpreterConfig::from_reader("version=3.8\next_suffix=.python38.so".as_bytes())
.unwrap(),
InterpreterConfigBuilder::new(implementation, version,)
.finalize()
.unwrap()
)
}
#[test]
fn test_config_file_invalid_keys() {
assert!(
InterpreterConfig::from_reader("version=3.14\ntarget_abi=foo-bar-baz".as_bytes())
.is_err()
);
assert!(InterpreterConfig::from_reader(
"version=3.14\ntarget_abi=CPython-bar-baz".as_bytes()
)
.is_err());
assert!(InterpreterConfig::from_reader(
"version=3.14\ntarget_abi=CPython-abi3-baz".as_bytes()
)
.is_err());
}
#[test]
fn gil_disabled_config_file_corner_cases() {
let implementation = PythonImplementation::CPython;
let version = PythonVersion::PY313;
assert_eq!(
InterpreterConfig::from_reader("version=3.13\nbuild_flags=Py_GIL_DISABLED".as_bytes())
.unwrap(),
InterpreterConfigBuilder::new(implementation, version)
.free_threaded()
.unwrap()
.finalize()
.unwrap()
);
assert_eq!(
InterpreterConfig::from_reader(
"version=3.13\ntarget_abi=CPython-free_threaded-3.13".as_bytes()
)
.unwrap(),
InterpreterConfigBuilder::new(implementation, version)
.free_threaded()
.unwrap()
.finalize()
.unwrap()
);
assert!(InterpreterConfig::from_reader(
"version=3.13\ntarget_abi=CPython-gil_enabled-3.13\nbuild_flags=Py_GIL_DISABLED"
.as_bytes()
)
.is_err());
let mut flags = BuildFlags::default();
flags.0.insert(BuildFlag::Py_GIL_DISABLED);
assert!(InterpreterConfigBuilder::new(implementation, version)
.build_flags(flags)
.finalize()
.unwrap()
.target_abi
.kind
.is_free_threaded());
let mut flags = BuildFlags::default();
flags.0.insert(BuildFlag::Py_GIL_DISABLED);
assert!(
InterpreterConfigBuilder::new(implementation, PythonVersion::PY312)
.build_flags(flags)
.finalize()
.is_err()
);
let mut flags = BuildFlags::default();
flags.0.insert(BuildFlag::Py_GIL_DISABLED);
assert!(
InterpreterConfigBuilder::new(implementation, PythonVersion::PY312)
.stable_abi(StableAbi::Abi3)
.build_flags(flags)
.finalize()
.is_err()
);
assert!(
InterpreterConfigBuilder::new(implementation, PythonVersion::PY38)
.free_threaded()
.is_err()
);
}
#[test]
fn abi3_from_old_config_file() {
let implementation = PythonImplementation::CPython;
let version = PythonVersion::PY313;
assert_eq!(
InterpreterConfig::from_reader("version=3.13\nabi3=true".as_bytes()).unwrap(),
InterpreterConfigBuilder::new(implementation, version)
.stable_abi(StableAbi::Abi3)
.finalize()
.unwrap()
);
}
#[test]
fn test_target_abi_and_abi3() {
assert!(InterpreterConfig::from_reader(
"version=3.13\nabi3=true\ntarget_abi=CPython-abi3-3.13".as_bytes()
)
.unwrap_err()
.to_string()
.contains("Invalid config"),);
}
#[test]
fn build_flags_default() {
assert_eq!(BuildFlags::default(), BuildFlags::new());
}
#[test]
fn build_flags_from_sysconfigdata() {
let mut sysconfigdata = Sysconfigdata::new();
assert_eq!(
BuildFlags::from_sysconfigdata(&sysconfigdata).0,
HashSet::new()
);
for flag in &BuildFlags::ALL {
sysconfigdata.insert(flag.to_string(), "0".into());
}
assert_eq!(
BuildFlags::from_sysconfigdata(&sysconfigdata).0,
HashSet::new()
);
let mut expected_flags = HashSet::new();
for flag in &BuildFlags::ALL {
sysconfigdata.insert(flag.to_string(), "1".into());
expected_flags.insert(flag.clone());
}
assert_eq!(
BuildFlags::from_sysconfigdata(&sysconfigdata).0,
expected_flags
);
}
#[test]
fn build_flags_fixup() {
let mut build_flags = BuildFlags::new();
build_flags = build_flags.fixup();
assert!(build_flags.0.is_empty());
build_flags.0.insert(BuildFlag::Py_DEBUG);
build_flags = build_flags.fixup();
assert!(build_flags.0.contains(&BuildFlag::Py_REF_DEBUG));
}
#[test]
fn parse_script_output() {
let output = "foo bar\nbar foobar\n\n";
let map = super::parse_script_output(output);
assert_eq!(map.len(), 2);
assert_eq!(map["foo"], "bar");
assert_eq!(map["bar"], "foobar");
}
#[test]
fn config_from_interpreter() {
assert!(make_interpreter_config().is_ok())
}
#[test]
fn config_from_empty_sysconfigdata() {
let sysconfigdata = Sysconfigdata::new();
assert!(InterpreterConfig::from_sysconfigdata(&sysconfigdata).is_err());
}
#[test]
fn config_from_sysconfigdata() {
let mut sysconfigdata = Sysconfigdata::new();
sysconfigdata.insert("SOABI", "cpython-38-x86_64-linux-gnu");
sysconfigdata.insert("VERSION", "3.8");
sysconfigdata.insert("Py_ENABLE_SHARED", "1");
sysconfigdata.insert("LIBDIR", "/usr/lib");
sysconfigdata.insert("LDVERSION", "3.8");
sysconfigdata.insert("SIZEOF_VOID_P", "8");
let implementation = PythonImplementation::CPython;
let version = PythonVersion::PY38;
assert_eq!(
InterpreterConfig::from_sysconfigdata(&sysconfigdata).unwrap(),
InterpreterConfigBuilder::new(implementation, version,)
.build_flags(BuildFlags::from_sysconfigdata(&sysconfigdata))
.lib_dir("/usr/lib".to_string())
.lib_name("python3.8".to_string())
.pointer_width(64)
.finalize()
.unwrap()
);
}
#[test]
fn config_from_sysconfigdata_framework() {
let mut sysconfigdata = Sysconfigdata::new();
sysconfigdata.insert("SOABI", "cpython-38-x86_64-linux-gnu");
sysconfigdata.insert("VERSION", "3.8");
sysconfigdata.insert("Py_ENABLE_SHARED", "0");
sysconfigdata.insert("PYTHONFRAMEWORK", "Python");
sysconfigdata.insert("LIBDIR", "/usr/lib");
sysconfigdata.insert("LDVERSION", "3.8");
sysconfigdata.insert("SIZEOF_VOID_P", "8");
let implementation = PythonImplementation::CPython;
let version = PythonVersion::PY38;
assert_eq!(
InterpreterConfig::from_sysconfigdata(&sysconfigdata).unwrap(),
InterpreterConfigBuilder::new(implementation, version,)
.build_flags(BuildFlags::from_sysconfigdata(&sysconfigdata))
.lib_dir("/usr/lib".to_string())
.lib_name("python3.8".to_string())
.pointer_width(64)
.finalize()
.unwrap()
);
sysconfigdata = Sysconfigdata::new();
sysconfigdata.insert("SOABI", "cpython-38-x86_64-linux-gnu");
sysconfigdata.insert("VERSION", "3.8");
sysconfigdata.insert("Py_ENABLE_SHARED", "0");
sysconfigdata.insert("PYTHONFRAMEWORK", "");
sysconfigdata.insert("LIBDIR", "/usr/lib");
sysconfigdata.insert("LDVERSION", "3.8");
sysconfigdata.insert("SIZEOF_VOID_P", "8");
let implementation = PythonImplementation::CPython;
let version = PythonVersion::PY38;
assert_eq!(
InterpreterConfig::from_sysconfigdata(&sysconfigdata).unwrap(),
InterpreterConfigBuilder::new(implementation, version,)
.build_flags(BuildFlags::from_sysconfigdata(&sysconfigdata))
.lib_dir("/usr/lib".to_string())
.lib_name("python3.8".to_string())
.pointer_width(64)
.shared(false)
.finalize()
.unwrap()
);
}
#[test]
fn windows_hardcoded_abi3_compile() {
let host = triple!("x86_64-pc-windows-msvc");
let implementation = PythonImplementation::CPython;
let version = PythonVersion::PY38;
let config = InterpreterConfigBuilder::new(implementation, version)
.stable_abi(StableAbi::Abi3)
.lib_name("python3".to_string())
.finalize()
.unwrap();
assert_eq!(
default_stable_abi_config(&host, Some(version), None).unwrap(),
config
);
}
#[test]
fn windows_hardcoded_abi3t_compile() {
let host = triple!("x86_64-pc-windows-msvc");
let implementation = PythonImplementation::CPython;
let version = PythonVersion::PY315;
let config = InterpreterConfigBuilder::new(implementation, version)
.stable_abi(StableAbi::Abi3t)
.lib_name("python3t".to_string())
.finalize()
.unwrap();
assert_eq!(
default_stable_abi_config(&host, None, Some(version)).unwrap(),
config
);
}
#[test]
fn unix_hardcoded_abi3_compile() {
let host = triple!("x86_64-unknown-linux-gnu");
let implementation = PythonImplementation::CPython;
let version = PythonVersion::PY39;
let config = InterpreterConfigBuilder::new(implementation, version)
.stable_abi(StableAbi::Abi3)
.finalize()
.unwrap();
assert_eq!(
default_stable_abi_config(&host, Some(version), None).unwrap(),
config
);
}
#[test]
fn unix_hardcoded_abi3t_compile() {
let host = triple!("x86_64-unknown-linux-gnu");
let implementation = PythonImplementation::CPython;
let version = PythonVersion::PY315;
let config = InterpreterConfigBuilder::new(implementation, version)
.stable_abi(StableAbi::Abi3t)
.finalize()
.unwrap();
assert_eq!(
default_stable_abi_config(&host, None, Some(version)).unwrap(),
config
);
}
#[test]
fn default_stable_abi_config_corner_cases() {
let host = triple!("x86_64-unknown-linux-gnu");
let py315 = Some("3.15".parse().unwrap());
let py39 = Some("3.9".parse().unwrap());
let implementation = PythonImplementation::CPython;
let version = PythonVersion::PY39;
let config = InterpreterConfigBuilder::new(implementation, version)
.stable_abi(StableAbi::Abi3)
.finalize()
.unwrap();
assert_eq!(
default_stable_abi_config(&host, py39, py315).unwrap(),
config
);
assert!(default_stable_abi_config(&host, None, py39).is_err());
}
#[test]
fn windows_hardcoded_cross_compile() {
let env_vars = CrossCompileEnvVars {
pyo3_cross: None,
pyo3_cross_lib_dir: Some("C:\\some\\path".into()),
pyo3_cross_python_implementation: None,
pyo3_cross_python_version: Some("3.8".into()),
};
let host = triple!("x86_64-unknown-linux-gnu");
let target = triple!("i686-pc-windows-msvc");
let cross_config =
CrossCompileConfig::try_from_env_vars_host_target(env_vars, &host, &target)
.unwrap()
.unwrap();
let implementation = PythonImplementation::CPython;
let version = PythonVersion::PY38;
let config = InterpreterConfigBuilder::new(implementation, version)
.lib_name("python38".to_string())
.lib_dir("C:\\some\\path".to_string())
.finalize()
.unwrap();
assert_eq!(default_cross_compile(&cross_config).unwrap(), config);
}
#[test]
fn mingw_hardcoded_cross_compile() {
let env_vars = CrossCompileEnvVars {
pyo3_cross: None,
pyo3_cross_lib_dir: Some("/usr/lib/mingw".into()),
pyo3_cross_python_implementation: None,
pyo3_cross_python_version: Some("3.8".into()),
};
let host = triple!("x86_64-unknown-linux-gnu");
let target = triple!("i686-pc-windows-gnu");
let cross_config =
CrossCompileConfig::try_from_env_vars_host_target(env_vars, &host, &target)
.unwrap()
.unwrap();
let implementation = PythonImplementation::CPython;
let version = PythonVersion::PY38;
let config = InterpreterConfigBuilder::new(implementation, version)
.lib_name("python38".to_string())
.lib_dir("/usr/lib/mingw".to_string())
.finalize()
.unwrap();
assert_eq!(default_cross_compile(&cross_config).unwrap(), config);
}
#[test]
fn unix_hardcoded_cross_compile() {
let env_vars = CrossCompileEnvVars {
pyo3_cross: None,
pyo3_cross_lib_dir: Some("/usr/arm64/lib".into()),
pyo3_cross_python_implementation: None,
pyo3_cross_python_version: Some("3.9".into()),
};
let host = triple!("x86_64-unknown-linux-gnu");
let target = triple!("aarch64-unknown-linux-gnu");
let cross_config =
CrossCompileConfig::try_from_env_vars_host_target(env_vars, &host, &target)
.unwrap()
.unwrap();
let implementation = PythonImplementation::CPython;
let version = PythonVersion::PY39;
let config = InterpreterConfigBuilder::new(implementation, version)
.lib_name("python3.9".to_string())
.lib_dir("/usr/arm64/lib".to_string())
.finalize()
.unwrap();
assert_eq!(default_cross_compile(&cross_config).unwrap(), config);
}
#[test]
fn pypy_hardcoded_cross_compile() {
let env_vars = CrossCompileEnvVars {
pyo3_cross: None,
pyo3_cross_lib_dir: None,
pyo3_cross_python_implementation: Some("PyPy".into()),
pyo3_cross_python_version: Some("3.11".into()),
};
let triple = triple!("x86_64-unknown-linux-gnu");
let cross_config =
CrossCompileConfig::try_from_env_vars_host_target(env_vars, &triple, &triple)
.unwrap()
.unwrap();
let implementation = PythonImplementation::PyPy;
let version = PythonVersion::PY311;
let config = InterpreterConfigBuilder::new(implementation, version)
.lib_name("pypy3.11-c".to_string())
.finalize()
.unwrap();
assert_eq!(default_cross_compile(&cross_config).unwrap(), config);
}
#[test]
fn unix_free_threaded_pre_315_cross_compile() {
let env_vars = CrossCompileEnvVars {
pyo3_cross: None,
pyo3_cross_lib_dir: None,
pyo3_cross_python_implementation: None,
pyo3_cross_python_version: Some("3.14t".into()),
};
let host = triple!("x86_64-unknown-linux-gnu");
let target = triple!("aarch64-unknown-linux-gnu");
let cross_config =
CrossCompileConfig::try_from_env_vars_host_target(env_vars, &host, &target)
.unwrap()
.unwrap();
let implementation = PythonImplementation::CPython;
let version = PythonVersion::PY314;
let config = InterpreterConfigBuilder::new(implementation, version)
.free_threaded()
.unwrap()
.lib_name("python3.14t".to_string())
.finalize()
.unwrap();
let result = default_cross_compile(&cross_config).unwrap();
assert_eq!(result, config);
assert_eq!(
result.target_abi.kind(),
PythonAbiKind::VersionSpecific(GilUsed::FreeThreaded)
);
}
#[test]
fn windows_free_threaded_pre_315_cross_compile() {
let env_vars = CrossCompileEnvVars {
pyo3_cross: None,
pyo3_cross_lib_dir: None,
pyo3_cross_python_implementation: None,
pyo3_cross_python_version: Some("3.14t".into()),
};
let host = triple!("x86_64-unknown-linux-gnu");
let target = triple!("x86_64-pc-windows-msvc");
let cross_config =
CrossCompileConfig::try_from_env_vars_host_target(env_vars, &host, &target)
.unwrap()
.unwrap();
let implementation = PythonImplementation::CPython;
let version = PythonVersion::PY314;
let config = InterpreterConfigBuilder::new(implementation, version)
.free_threaded()
.unwrap()
.lib_name("python314t".to_string())
.finalize()
.unwrap();
let result = default_cross_compile(&cross_config).unwrap();
assert_eq!(result, config);
assert_eq!(
result.target_abi.kind(),
PythonAbiKind::VersionSpecific(GilUsed::FreeThreaded)
);
}
#[test]
fn unix_free_threaded_315_cross_compile() {
let env_vars = CrossCompileEnvVars {
pyo3_cross: None,
pyo3_cross_lib_dir: None,
pyo3_cross_python_implementation: None,
pyo3_cross_python_version: Some("3.15t".into()),
};
let host = triple!("x86_64-unknown-linux-gnu");
let target = triple!("aarch64-unknown-linux-gnu");
let cross_config =
CrossCompileConfig::try_from_env_vars_host_target(env_vars, &host, &target)
.unwrap()
.unwrap();
let implementation = PythonImplementation::CPython;
let version = PythonVersion::PY315;
let config = InterpreterConfigBuilder::new(implementation, version)
.free_threaded()
.unwrap()
.lib_name("python3.15t".to_string())
.finalize()
.unwrap();
let result = default_cross_compile(&cross_config).unwrap();
assert_eq!(result, config);
assert_eq!(
result.target_abi.kind(),
PythonAbiKind::VersionSpecific(GilUsed::FreeThreaded)
);
}
#[test]
fn default_lib_name_windows() {
assert_eq!(
super::default_lib_name_windows(
PythonAbiBuilder::new(PythonImplementation::CPython, PythonVersion::PY39)
.finalize()
.unwrap(),
false,
false,
)
.unwrap(),
"python39",
);
assert!(
PythonAbiBuilder::new(PythonImplementation::CPython, PythonVersion::PY39)
.free_threaded()
.finalize()
.is_err()
);
assert_eq!(
super::default_lib_name_windows(
PythonAbiBuilder::new(PythonImplementation::CPython, PythonVersion::PY39)
.stable_abi(StableAbi::Abi3)
.finalize()
.unwrap(),
false,
false,
)
.unwrap(),
"python3",
);
assert_eq!(
super::default_lib_name_windows(
PythonAbiBuilder::new(PythonImplementation::CPython, PythonVersion::PY39)
.finalize()
.unwrap(),
true,
false,
)
.unwrap(),
"libpython3.9",
);
assert_eq!(
super::default_lib_name_windows(
PythonAbiBuilder::new(PythonImplementation::CPython, PythonVersion::PY39)
.stable_abi(StableAbi::Abi3)
.finalize()
.unwrap(),
true,
false,
)
.unwrap(),
"libpython3",
);
assert_eq!(
super::default_lib_name_windows(
PythonAbiBuilder::new(PythonImplementation::PyPy, PythonVersion::PY39)
.stable_abi(StableAbi::Abi3)
.finalize()
.unwrap(),
false,
false,
)
.unwrap(),
"libpypy3.9-c",
);
assert_eq!(
super::default_lib_name_windows(
PythonAbiBuilder::new(PythonImplementation::PyPy, PythonVersion::PY311)
.stable_abi(StableAbi::Abi3)
.finalize()
.unwrap(),
false,
false,
)
.unwrap(),
"libpypy3.11-c",
);
assert_eq!(
super::default_lib_name_windows(
PythonAbiBuilder::new(PythonImplementation::CPython, PythonVersion::PY310)
.stable_abi(StableAbi::Abi3)
.finalize()
.unwrap(),
false,
true,
)
.unwrap(),
"python3_d",
);
assert_eq!(
super::default_lib_name_windows(
PythonAbiBuilder::new(PythonImplementation::CPython, PythonVersion::PY39)
.stable_abi(StableAbi::Abi3)
.finalize()
.unwrap(),
false,
true,
)
.unwrap(),
"python39_d",
);
assert_eq!(
super::default_lib_name_windows(
PythonAbiBuilder::new(PythonImplementation::CPython, PythonVersion::PY310)
.stable_abi(StableAbi::Abi3)
.finalize()
.unwrap(),
false,
true,
)
.unwrap(),
"python3_d",
);
assert_eq!(
super::default_lib_name_windows(
PythonAbiBuilder::new(PythonImplementation::CPython, PythonVersion::PY313)
.free_threaded()
.finalize()
.unwrap(),
false,
false,
)
.unwrap(),
"python313t",
);
assert_eq!(
super::default_lib_name_windows(
PythonAbiBuilder::new(PythonImplementation::CPython, PythonVersion::PY313)
.free_threaded()
.finalize()
.unwrap(),
false,
true,
)
.unwrap(),
"python313t_d",
);
assert_eq!(
super::default_lib_name_windows(
PythonAbiBuilder::new(PythonImplementation::CPython, PythonVersion::PY315)
.stable_abi(StableAbi::Abi3t)
.finalize()
.unwrap(),
false,
false,
)
.unwrap(),
"python3t",
);
assert_eq!(
super::default_lib_name_windows(
PythonAbiBuilder::new(PythonImplementation::CPython, PythonVersion::PY315)
.stable_abi(StableAbi::Abi3t)
.finalize()
.unwrap(),
false,
true,
)
.unwrap(),
"python3t_d",
);
}
#[test]
fn default_lib_name_unix() {
assert_eq!(
super::default_lib_name_unix(
PythonAbiBuilder::new(PythonImplementation::CPython, PythonVersion::PY38)
.finalize()
.unwrap(),
false,
None,
)
.unwrap(),
"python3.8",
);
assert_eq!(
super::default_lib_name_unix(
PythonAbiBuilder::new(PythonImplementation::CPython, PythonVersion::PY39)
.finalize()
.unwrap(),
false,
None,
)
.unwrap(),
"python3.9",
);
assert_eq!(
super::default_lib_name_unix(
PythonAbiBuilder::new(PythonImplementation::CPython, PythonVersion::PY39)
.finalize()
.unwrap(),
false,
Some("3.8d"),
)
.unwrap(),
"python3.8d",
);
assert_eq!(
super::default_lib_name_unix(
PythonAbiBuilder::new(PythonImplementation::PyPy, PythonVersion::PY311)
.finalize()
.unwrap(),
false,
None,
)
.unwrap(),
"pypy3.11-c",
);
assert_eq!(
super::default_lib_name_unix(
PythonAbiBuilder::new(PythonImplementation::PyPy, PythonVersion::PY39)
.finalize()
.unwrap(),
false,
Some("3.11d"),
)
.unwrap(),
"pypy3.11d-c",
);
assert_eq!(
super::default_lib_name_unix(
PythonAbiBuilder::new(PythonImplementation::CPython, PythonVersion::PY313)
.free_threaded()
.finalize()
.unwrap(),
false,
None,
)
.unwrap(),
"python3.13t",
);
assert_eq!(
super::default_lib_name_unix(
PythonAbiBuilder::new(PythonImplementation::CPython, PythonVersion::PY313)
.stable_abi(StableAbi::Abi3)
.finalize()
.unwrap(),
true,
None,
)
.unwrap(),
"python3",
);
}
#[test]
fn abi_builder_error_paths() {
let builder = PythonAbiBuilder::new(PythonImplementation::CPython, PythonVersion::PY39)
.free_threaded()
.finalize();
assert!(builder.is_err());
assert!(builder.unwrap_err().to_string().contains("Cannot target"));
assert_eq!(
PythonAbiBuilder::new(
PythonImplementation::CPython,
PythonVersion {
major: 3,
minor: 16,
},
)
.stable_abi(StableAbi::Abi3)
.finalize()
.unwrap()
.version
.minor,
STABLE_ABI_MAX_MINOR
);
assert!("invalid".parse::<PythonAbi>().is_err());
assert!("CPython-invalid".parse::<PythonAbi>().is_err());
assert!("CPython-free_threaded-invalid"
.parse::<PythonAbi>()
.is_err());
let builder = PythonAbiBuilder::new(PythonImplementation::RustPython, PythonVersion::PY315)
.free_threaded();
let res = builder.finalize();
assert!(res.is_err());
assert!(res
.unwrap_err()
.to_string()
.contains("RustPython only supports targeting abi3t"));
}
#[test]
fn parse_cross_python_version() {
let env_vars = CrossCompileEnvVars {
pyo3_cross: None,
pyo3_cross_lib_dir: None,
pyo3_cross_python_version: Some("3.9".into()),
pyo3_cross_python_implementation: None,
};
assert_eq!(
env_vars.parse_version().unwrap(),
(Some(PythonVersion { major: 3, minor: 9 }), None),
);
let env_vars = CrossCompileEnvVars {
pyo3_cross: None,
pyo3_cross_lib_dir: None,
pyo3_cross_python_version: None,
pyo3_cross_python_implementation: None,
};
assert_eq!(env_vars.parse_version().unwrap(), (None, None));
let env_vars = CrossCompileEnvVars {
pyo3_cross: None,
pyo3_cross_lib_dir: None,
pyo3_cross_python_version: Some("3.13t".into()),
pyo3_cross_python_implementation: None,
};
assert_eq!(
env_vars.parse_version().unwrap(),
(
Some(PythonVersion {
major: 3,
minor: 13
}),
Some("t".into())
),
);
let env_vars = CrossCompileEnvVars {
pyo3_cross: None,
pyo3_cross_lib_dir: None,
pyo3_cross_python_version: Some("100".into()),
pyo3_cross_python_implementation: None,
};
assert!(env_vars.parse_version().is_err());
}
#[test]
fn target_abi3_version_different_from_host() {
let implementation = PythonImplementation::CPython;
let host_version = PythonVersion::PY39;
let target_version = PythonVersion::PY38;
let config = InterpreterConfigBuilder::new(implementation, host_version)
.target_abi(
PythonAbiBuilder::new(implementation, target_version)
.stable_abi(StableAbi::Abi3)
.finalize()
.unwrap(),
)
.finalize()
.unwrap();
assert_eq!(config.target_abi.version(), target_version);
assert_eq!(config.version, host_version);
}
#[test]
fn stable_abi_applicability() {
use PythonImplementation::*;
let abi3 = Some(StableAbiVersion::Target(PythonVersion::PY310));
let abi3t = Some(StableAbiVersion::Target(PythonVersion::PY315));
assert_eq!(
applicable_stable_abi(CPython, PythonVersion::PY314, true, abi3, abi3t),
None
);
assert_eq!(
applicable_stable_abi(CPython, PythonVersion::PY314, false, abi3, abi3t),
Some((StableAbi::Abi3, PythonVersion::PY310))
);
assert_eq!(
applicable_stable_abi(CPython, PythonVersion::PY314, false, None, abi3t),
None
);
assert_eq!(
applicable_stable_abi(CPython, PythonVersion::PY315, false, abi3, abi3t),
Some((StableAbi::Abi3t, PythonVersion::PY315))
);
assert_eq!(
applicable_stable_abi(CPython, PythonVersion::PY315, false, abi3, None),
Some((StableAbi::Abi3, PythonVersion::PY310))
);
assert_eq!(
applicable_stable_abi(CPython, PythonVersion::PY315, true, abi3, abi3t),
Some((StableAbi::Abi3t, PythonVersion::PY315))
);
assert_eq!(
applicable_stable_abi(CPython, PythonVersion::PY315, true, abi3, None),
None
);
assert_eq!(
applicable_stable_abi(
CPython,
PythonVersion::PY314,
false,
Some(StableAbiVersion::Current),
None
),
Some((StableAbi::Abi3, PythonVersion::PY314))
);
assert_eq!(
applicable_stable_abi(
CPython,
PythonVersion::PY315,
true,
None,
Some(StableAbiVersion::Current)
),
Some((StableAbi::Abi3t, PythonVersion::PY315))
);
assert_eq!(
applicable_stable_abi(PyPy, PythonVersion::PY311, false, abi3, abi3t),
Some((StableAbi::Abi3, PythonVersion::PY311))
);
assert_eq!(
applicable_stable_abi(GraalPy, PythonVersion::PY311, false, abi3, abi3t),
Some((StableAbi::Abi3, PythonVersion::PY311))
);
assert_eq!(
applicable_stable_abi(PyPy, PythonVersion::PY311, false, None, abi3t),
None
);
}
#[test]
fn apply_build_env_preserves_target_implementation() {
let config = InterpreterConfig::from_reader(
"implementation=CPython\nversion=3.11\ntarget_abi=PyPy-gil_enabled-3.11".as_bytes(),
)
.unwrap()
.apply_build_env()
.unwrap();
assert_eq!(
config.target_abi.implementation(),
PythonImplementation::PyPy
);
assert_eq!(
config.target_abi.kind(),
PythonAbiKind::VersionSpecific(GilUsed::GilEnabled)
);
assert_eq!(config.target_abi.version(), PythonVersion::PY311);
}
#[test]
fn python_abi_from_stable_abi() {
let implementation = PythonImplementation::CPython;
let abi =
PythonAbi::from_stable_abi(implementation, PythonVersion::PY314, None, true).unwrap();
assert_eq!(
abi.kind(),
PythonAbiKind::VersionSpecific(GilUsed::FreeThreaded)
);
assert_eq!(abi.version(), PythonVersion::PY314);
let abi =
PythonAbi::from_stable_abi(implementation, PythonVersion::PY314, None, false).unwrap();
assert_eq!(
abi.kind(),
PythonAbiKind::VersionSpecific(GilUsed::GilEnabled)
);
let abi = PythonAbi::from_stable_abi(
implementation,
PythonVersion::PY314,
Some((StableAbi::Abi3, PythonVersion::PY310)),
false,
)
.unwrap();
assert_eq!(abi.kind(), PythonAbiKind::Stable(StableAbi::Abi3));
assert_eq!(abi.version(), PythonVersion::PY310);
let error = PythonAbi::from_stable_abi(
implementation,
PythonVersion::PY314,
Some((StableAbi::Abi3t, PythonVersion::PY315)),
true,
)
.unwrap_err();
assert!(error.to_string().contains(
"cannot set a minimum Python version 3.15 higher than the interpreter version 3.14 \
(the minimum Python version is implied by the abi3t-py315 feature)"
));
}
#[test]
fn config_file_applies_build_env() {
let config = InterpreterConfig::from_reader(
"version=3.14\ntarget_abi=CPython-free_threaded-3.14\nbuild_flags=Py_GIL_DISABLED"
.as_bytes(),
)
.unwrap()
.apply_build_env()
.unwrap();
assert_eq!(
config.target_abi.kind(),
PythonAbiKind::VersionSpecific(GilUsed::FreeThreaded)
);
assert_eq!(config.target_abi.version(), PythonVersion::PY314);
let config =
InterpreterConfig::from_reader("version=3.12\ntarget_abi=CPython-abi3-3.10".as_bytes())
.unwrap()
.apply_build_env()
.unwrap();
assert_eq!(
config.target_abi.kind(),
PythonAbiKind::VersionSpecific(GilUsed::GilEnabled)
);
assert_eq!(config.target_abi.version(), PythonVersion::PY312);
}
#[test]
fn abi3_version_cannot_be_higher_than_interpreter() {
if !have_python_interpreter() {
return;
}
let host_interpreter = get_host_interpreter(None, None).unwrap();
let host_version = host_interpreter.version;
let host_free_threaded = host_interpreter.target_abi.kind.is_free_threaded();
if matches!(
host_interpreter.implementation,
PythonImplementation::PyPy | PythonImplementation::GraalPy
) || ((host_version == PythonVersion::PY314) && host_free_threaded)
{
return;
}
let interpreter = get_host_interpreter(
Some(StableAbiVersion::Target(PythonVersion {
major: 3,
minor: 45,
})),
None,
);
if !host_free_threaded {
assert!(interpreter.unwrap_err().to_string().contains(
"cannot set a minimum Python version 3.45 higher than the interpreter version"
));
if host_version >= PythonVersion::PY313 {
let interpreter = get_host_interpreter(
Some(StableAbiVersion::Target(PythonVersion::PY313)),
None,
);
assert_eq!(
interpreter.unwrap().target_abi.version(),
PythonVersion::PY313
);
}
}
if host_version >= PythonVersion::PY313 {
let interpreter = get_host_interpreter(
Some(StableAbiVersion::Target(PythonVersion::PY313)),
Some(StableAbiVersion::Target(PythonVersion::PY315)),
)
.unwrap();
assert_eq!(
interpreter.target_abi.version(),
if host_version >= PythonVersion::PY315 {
PythonVersion::PY315
} else {
PythonVersion::PY313
}
);
}
}
#[test]
#[cfg(all(target_os = "linux", target_arch = "x86_64",))]
fn parse_sysconfigdata() {
let Ok(interpreter_config) = make_interpreter_config() else {
return;
};
let lib_dir = match &interpreter_config.lib_dir {
Some(lib_dir) => Path::new(lib_dir),
None => return,
};
let cross = CrossCompileConfig {
lib_dir: Some(lib_dir.into()),
version: Some(interpreter_config.version),
implementation: Some(interpreter_config.implementation),
target: triple!("x86_64-unknown-linux-gnu"),
abiflags: if interpreter_config.target_abi.kind().is_free_threaded() {
Some("t".into())
} else {
None
},
};
let sysconfigdata_path = match find_sysconfigdata(&cross) {
Ok(Some(path)) => path,
_ => return,
};
let sysconfigdata = super::parse_sysconfigdata(sysconfigdata_path).unwrap();
let mut parsed_config = InterpreterConfig::from_sysconfigdata(&sysconfigdata).unwrap();
if parsed_config.python_framework_prefix.as_deref() == Some("") {
parsed_config.python_framework_prefix = None;
}
assert_eq!(parsed_config.implementation, PythonImplementation::CPython);
assert_eq!(
parsed_config,
InterpreterConfigBuilder::new(
interpreter_config.implementation,
interpreter_config.version,
)
.build_flags(interpreter_config.build_flags().clone())
.pointer_width(64)
.lib_dir(interpreter_config.lib_dir().map(str::to_owned))
.lib_name(interpreter_config.lib_name().map(str::to_owned))
.finalize()
.unwrap()
)
}
#[test]
fn test_venv_interpreter() {
let base = OsStr::new("base");
assert_eq!(
venv_interpreter(base, true),
PathBuf::from_iter(&["base", "Scripts", "python.exe"])
);
assert_eq!(
venv_interpreter(base, false),
PathBuf::from_iter(&["base", "bin", "python"])
);
}
#[test]
fn test_conda_env_interpreter() {
let base = OsStr::new("base");
assert_eq!(
conda_env_interpreter(base, true),
PathBuf::from_iter(&["base", "python.exe"])
);
assert_eq!(
conda_env_interpreter(base, false),
PathBuf::from_iter(&["base", "bin", "python"])
);
}
#[test]
fn test_not_cross_compiling_from_to() {
assert!(cross_compiling_from_to(
&triple!("x86_64-unknown-linux-gnu"),
&triple!("x86_64-unknown-linux-gnu"),
)
.unwrap()
.is_none());
assert!(cross_compiling_from_to(
&triple!("x86_64-apple-darwin"),
&triple!("x86_64-apple-darwin")
)
.unwrap()
.is_none());
assert!(cross_compiling_from_to(
&triple!("aarch64-apple-darwin"),
&triple!("x86_64-apple-darwin")
)
.unwrap()
.is_none());
assert!(cross_compiling_from_to(
&triple!("x86_64-apple-darwin"),
&triple!("aarch64-apple-darwin")
)
.unwrap()
.is_none());
assert!(cross_compiling_from_to(
&triple!("x86_64-pc-windows-msvc"),
&triple!("i686-pc-windows-msvc")
)
.unwrap()
.is_none());
assert!(cross_compiling_from_to(
&triple!("x86_64-unknown-linux-gnu"),
&triple!("x86_64-unknown-linux-musl")
)
.unwrap()
.is_none());
assert!(cross_compiling_from_to(
&triple!("x86_64-pc-windows-msvc"),
&triple!("x86_64-win7-windows-msvc"),
)
.unwrap()
.is_none());
}
#[test]
fn test_is_cross_compiling_from_to() {
assert!(cross_compiling_from_to(
&triple!("x86_64-pc-windows-msvc"),
&triple!("aarch64-pc-windows-msvc")
)
.unwrap()
.is_some());
}
#[test]
fn test_run_python_script() {
let interpreter = make_interpreter_config()
.expect("could not get InterpreterConfig from installed interpreter");
let out = interpreter
.run_python_script("print(2 + 2)")
.expect("failed to run Python script");
assert_eq!(out.trim_end(), "4");
}
#[test]
fn test_run_python_script_with_envs() {
let interpreter = make_interpreter_config()
.expect("could not get InterpreterConfig from installed interpreter");
let out = interpreter
.run_python_script_with_envs(
"import os; print(os.getenv('PYO3_TEST'))",
vec![("PYO3_TEST", "42")],
)
.expect("failed to run Python script");
assert_eq!(out.trim_end(), "42");
}
#[test]
fn test_build_script_outputs_base() {
let implementation = PythonImplementation::CPython;
let version = PythonVersion::PY311;
let interpreter_config = InterpreterConfigBuilder::new(implementation, version)
.finalize()
.unwrap();
assert_eq!(
interpreter_config.build_script_outputs(),
[
"cargo:rustc-cfg=Py_3_8".to_owned(),
"cargo:rustc-cfg=Py_3_9".to_owned(),
"cargo:rustc-cfg=Py_3_10".to_owned(),
"cargo:rustc-cfg=Py_3_11".to_owned(),
]
);
let interpreter_config = InterpreterConfigBuilder::new(PythonImplementation::PyPy, version)
.finalize()
.unwrap();
assert_eq!(
interpreter_config.build_script_outputs(),
[
"cargo:rustc-cfg=Py_3_8".to_owned(),
"cargo:rustc-cfg=Py_3_9".to_owned(),
"cargo:rustc-cfg=Py_3_10".to_owned(),
"cargo:rustc-cfg=Py_3_11".to_owned(),
"cargo:rustc-cfg=PyPy".to_owned(),
]
);
let interpreter_config =
InterpreterConfigBuilder::new(PythonImplementation::RustPython, version)
.finalize()
.unwrap();
assert_eq!(
interpreter_config.build_script_outputs(),
[
"cargo:rustc-cfg=Py_3_8".to_owned(),
"cargo:rustc-cfg=Py_3_9".to_owned(),
"cargo:rustc-cfg=Py_3_10".to_owned(),
"cargo:rustc-cfg=Py_3_11".to_owned(),
"cargo:rustc-cfg=RustPython".to_owned(),
"cargo:rustc-cfg=Py_LIMITED_API".to_owned(),
"cargo:rustc-cfg=Py_GIL_DISABLED".to_owned(),
]
);
}
#[test]
fn test_build_script_outputs_abi3() {
let implementation = PythonImplementation::CPython;
let version = PythonVersion::PY39;
let interpreter_config = InterpreterConfigBuilder::new(implementation, version)
.stable_abi(StableAbi::Abi3)
.finalize()
.unwrap();
assert_eq!(
interpreter_config.build_script_outputs(),
[
"cargo:rustc-cfg=Py_3_8".to_owned(),
"cargo:rustc-cfg=Py_3_9".to_owned(),
"cargo:rustc-cfg=Py_LIMITED_API".to_owned(),
]
);
let interpreter_config = InterpreterConfigBuilder::new(PythonImplementation::PyPy, version)
.stable_abi(StableAbi::Abi3)
.finalize()
.unwrap();
assert_eq!(
interpreter_config.build_script_outputs(),
[
"cargo:rustc-cfg=Py_3_8".to_owned(),
"cargo:rustc-cfg=Py_3_9".to_owned(),
"cargo:rustc-cfg=PyPy".to_owned(),
"cargo:rustc-cfg=Py_LIMITED_API".to_owned(),
]
);
let interpreter_config =
InterpreterConfigBuilder::new(PythonImplementation::CPython, PythonVersion::PY315)
.stable_abi(StableAbi::Abi3)
.finalize()
.unwrap();
assert_eq!(
interpreter_config.build_script_outputs(),
[
"cargo:rustc-cfg=Py_3_8".to_owned(),
"cargo:rustc-cfg=Py_3_9".to_owned(),
"cargo:rustc-cfg=Py_3_10".to_owned(),
"cargo:rustc-cfg=Py_3_11".to_owned(),
"cargo:rustc-cfg=Py_3_12".to_owned(),
"cargo:rustc-cfg=Py_3_13".to_owned(),
"cargo:rustc-cfg=Py_3_14".to_owned(),
"cargo:rustc-cfg=Py_3_15".to_owned(),
"cargo:rustc-cfg=Py_LIMITED_API".to_owned(),
]
);
}
#[test]
fn test_build_script_outputs_gil_disabled() {
let interpreter_config =
InterpreterConfigBuilder::new(PythonImplementation::CPython, PythonVersion::PY313)
.free_threaded()
.unwrap()
.finalize()
.unwrap();
assert_eq!(
interpreter_config.build_script_outputs(),
[
"cargo:rustc-cfg=Py_3_8".to_owned(),
"cargo:rustc-cfg=Py_3_9".to_owned(),
"cargo:rustc-cfg=Py_3_10".to_owned(),
"cargo:rustc-cfg=Py_3_11".to_owned(),
"cargo:rustc-cfg=Py_3_12".to_owned(),
"cargo:rustc-cfg=Py_3_13".to_owned(),
"cargo:rustc-cfg=Py_GIL_DISABLED".to_owned(),
]
);
}
#[test]
fn test_interpreter_config_builder_gil_disabled_flag() {
let builder = InterpreterConfigBuilder::new(
PythonImplementation::CPython,
PythonVersion {
major: 3,
minor: 14,
},
);
let mut flags = BuildFlags::new();
flags.0.insert(BuildFlag::Py_GIL_DISABLED);
let config = builder
.stable_abi(StableAbi::Abi3)
.build_flags(flags)
.finalize()
.unwrap();
assert!(config.target_abi.kind() == PythonAbiKind::VersionSpecific(GilUsed::FreeThreaded));
let builder = InterpreterConfigBuilder::new(
PythonImplementation::CPython,
PythonVersion {
major: 3,
minor: 14,
},
);
let mut flags = BuildFlags::new();
flags.0.insert(BuildFlag::Py_GIL_DISABLED);
let config = builder
.build_flags(flags)
.stable_abi(StableAbi::Abi3)
.finalize()
.unwrap();
assert!(config.target_abi.kind() == PythonAbiKind::VersionSpecific(GilUsed::FreeThreaded));
let builder = InterpreterConfigBuilder::new(
PythonImplementation::CPython,
PythonVersion {
major: 3,
minor: 14,
},
);
let target_abi = PythonAbiBuilder::new(
PythonImplementation::CPython,
PythonVersion {
major: 3,
minor: 14,
},
)
.finalize()
.unwrap();
let mut flags = BuildFlags::new();
flags.0.insert(BuildFlag::Py_GIL_DISABLED);
assert!(builder
.target_abi(target_abi)
.build_flags(flags)
.finalize()
.is_err());
let builder = InterpreterConfigBuilder::new(
PythonImplementation::CPython,
PythonVersion {
major: 3,
minor: 14,
},
);
let config = builder.free_threaded().unwrap().finalize().unwrap();
assert!(config.target_abi.kind().is_free_threaded());
assert!(config.build_flags.0.contains(&BuildFlag::Py_GIL_DISABLED));
}
#[test]
fn test_build_script_outputs_debug() {
let mut build_flags = BuildFlags::default();
build_flags.0.insert(BuildFlag::Py_DEBUG);
let implementation = PythonImplementation::CPython;
let version = PythonVersion::PY38;
let interpreter_config = InterpreterConfigBuilder::new(implementation, version)
.build_flags(build_flags)
.finalize()
.unwrap();
assert_eq!(
interpreter_config.build_script_outputs(),
[
"cargo:rustc-cfg=Py_3_8".to_owned(),
"cargo:rustc-cfg=py_sys_config=\"Py_DEBUG\"".to_owned(),
]
);
}
#[test]
fn test_find_sysconfigdata_in_invalid_lib_dir() {
let e = find_all_sysconfigdata(&CrossCompileConfig {
lib_dir: Some(PathBuf::from("/abc/123/not/a/real/path")),
version: None,
implementation: None,
target: triple!("x86_64-unknown-linux-gnu"),
abiflags: None,
})
.unwrap_err();
assert!(e.report().to_string().starts_with(
"failed to search the lib dir at 'PYO3_CROSS_LIB_DIR=/abc/123/not/a/real/path'\n\
caused by:\n \
- 0: failed to list the entries in '/abc/123/not/a/real/path'\n \
- 1: \
"
));
}
#[test]
fn test_from_pyo3_config_file_env_rebuild() {
READ_ENV_VARS.with(|vars| vars.borrow_mut().clear());
let _ = InterpreterConfig::from_pyo3_config_file_env(&Triple::host());
READ_ENV_VARS.with(|vars| assert!(vars.borrow().contains(&"PYO3_CONFIG_FILE".to_string())));
}
#[test]
fn test_default_lib_name_for_target() {
let cpython = PythonImplementation::CPython;
let pypy = PythonImplementation::PyPy;
let py39 = PythonVersion::PY39;
let py311 = PythonVersion {
major: 3,
minor: 11,
};
let py313 = PythonVersion {
major: 3,
minor: 13,
};
let cpy39 = PythonAbiBuilder::new(cpython, py39).finalize().unwrap();
let pypy311 = PythonAbiBuilder::new(pypy, py311).finalize().unwrap();
let cpy313t = PythonAbiBuilder::new(cpython, py313)
.free_threaded()
.finalize()
.unwrap();
let cpy313_abi3 = PythonAbiBuilder::new(cpython, py313)
.stable_abi(StableAbi::Abi3)
.finalize()
.unwrap();
let unix = Triple::from_str("x86_64-unknown-linux-gnu").unwrap();
let win_x64 = Triple::from_str("x86_64-pc-windows-msvc").unwrap();
let win_arm64 = Triple::from_str("aarch64-pc-windows-msvc").unwrap();
let lib_name = default_lib_name_for_target(cpy39, &unix);
assert_eq!(lib_name, "python3.9");
let lib_name = default_lib_name_for_target(cpy39, &win_x64);
assert_eq!(lib_name, "python39");
let lib_name = default_lib_name_for_target(cpy39, &win_arm64);
assert_eq!(lib_name, "python39");
let lib_name = default_lib_name_for_target(pypy311, &unix);
assert_eq!(lib_name, "pypy3.11-c");
let lib_name = default_lib_name_for_target(pypy311, &win_x64);
assert_eq!(lib_name, "libpypy3.11-c");
let lib_name = default_lib_name_for_target(cpy313t, &unix);
assert_eq!(lib_name, "python3.13t");
let lib_name = default_lib_name_for_target(cpy313t, &win_x64);
assert_eq!(lib_name, "python313t");
let lib_name = default_lib_name_for_target(cpy313t, &win_arm64);
assert_eq!(lib_name, "python313t");
let lib_name = default_lib_name_for_target(cpy313_abi3, &unix);
assert_eq!(lib_name, "python3.13");
let lib_name = default_lib_name_for_target(cpy313_abi3, &win_x64);
assert_eq!(lib_name, "python3");
let lib_name = default_lib_name_for_target(cpy313_abi3, &win_arm64);
assert_eq!(lib_name, "python3");
}
}