Struct InterpreterConfig

pub struct InterpreterConfig {
    pub implementation: PythonImplementation,
    pub version: PythonVersion,
    pub shared: bool,
    pub abi3: bool,
    pub lib_name: Option<String>,
    pub lib_dir: Option<String>,
    pub executable: Option<String>,
    pub pointer_width: Option<u32>,
    pub build_flags: BuildFlags,
    pub suppress_build_script_link_lines: bool,
    pub extra_build_script_lines: Vec<String>,
    pub python_framework_prefix: Option<String>,
}

Configuration needed by PyO3 to build for the correct Python implementation.

Usually this is queried directly from the Python interpreter, or overridden using the PYO3_CONFIG_FILE environment variable.

When the PYO3_NO_PYTHON variable is set, or during cross compile situations, then alternative strategies are used to populate this type.

Fields

implementation: PythonImplementation

The Python implementation flavor.

Serialized to implementation.

version: PythonVersion

Python X.Y version. e.g. 3.9.

Serialized to version.

shared: bool

Whether link library is shared.

Serialized to shared.

abi3: bool

Whether linking against the stable/limited Python 3 API.

Serialized to abi3.

lib_name: Option<String>

The name of the link library defining Python.

This effectively controls the cargo:rustc-link-lib=<name> value to control how libpython is linked. Values should not contain the lib prefix.

Serialized to lib_name.

lib_dir: Option<String>

The directory containing the Python library to link against.

The effectively controls the cargo:rustc-link-search=native=<path> value to add an additional library search path for the linker.

Serialized to lib_dir.

executable: Option<String>

Path of host python executable.

This is a valid executable capable of running on the host/building machine. For configurations derived by invoking a Python interpreter, it was the executable invoked.

Serialized to executable.

pointer_width: Option<u32>

Width in bits of pointers on the target machine.

Serialized to pointer_width.

build_flags: BuildFlags

Additional relevant Python build flags / configuration settings.

Serialized to build_flags.

suppress_build_script_link_lines: bool

Whether to suppress emitting of cargo:rustc-link-* lines from the build script.

Typically, pyo3’s build script will emit cargo:rustc-link-lib= and cargo:rustc-link-search= lines derived from other fields in this struct. In advanced building configurations, the default logic to derive these lines may not be sufficient. This field can be set to Some(true) to suppress the emission of these lines.

If suppression is enabled, extra_build_script_lines should contain equivalent functionality or else a build failure is likely.

extra_build_script_lines: Vec<String>

Additional lines to println!() from Cargo build scripts.

This field can be populated to enable the pyo3 crate to emit additional lines from its its Cargo build script.

This crate doesn’t populate this field itself. Rather, it is intended to be used with externally provided config files to give them significant control over how the crate is build/configured.

Serialized to multiple extra_build_script_line values.

python_framework_prefix: Option<String>

macOS Python3.framework requires special rpath handling

Implementations

impl InterpreterConfig

#[doc(hidden)] pub fn build_script_outputs(&self) -> Vec<String>

#[doc(hidden)] pub fn from_interpreter( interpreter: impl AsRef<Path>, ) -> Result<Self>

pub fn from_sysconfigdata(sysconfigdata: &Sysconfigdata) -> Result<Self>

Generate from parsed sysconfigdata file

Use parse_sysconfigdata to generate a hash map of configuration values which may be used to build an InterpreterConfig.

pub(crate) fn from_pyo3_config_file_env() -> Option<Result<Self>>

Import an externally-provided config file.

The abi3 features, if set, may apply an abi3 constraint to the Python version.

#[doc(hidden)] pub fn from_path(path: impl AsRef<Path>) -> Result<Self>

#[doc(hidden)] pub fn from_cargo_dep_env() -> Option<Result<Self>>

#[doc(hidden)] pub fn from_reader(reader: impl Read) -> Result<Self>

pub fn generate_import_libs(&mut self) -> Result<()>

#[doc(hidden)] pub fn to_cargo_dep_env(&self) -> Result<()>

Serialize the InterpreterConfig and print it to the environment for Cargo to pass along to dependent packages during build time.

NB: writing to the cargo environment requires the links manifest key to be set. In this case that means this is called by the pyo3-ffi crate and available for dependent package build scripts in DEP_PYTHON_PYO3_CONFIG. See documentation for the DEP_<name>_<key> environment variable.

#[doc(hidden)] pub fn to_writer(&self, writer: impl Write) -> Result<()>

pub fn run_python_script(&self, script: &str) -> Result<String>

Run a python script using the InterpreterConfig::executable.

Panics

This function will panic if the executable is None.

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 a python script using the InterpreterConfig::executable with additional environment variables (e.g. PYTHONPATH) set.

Panics

This function will panic if the executable is None.

pub fn is_free_threaded(&self) -> bool

fn fixup_for_abi3_version( &mut self, abi3_version: Option<PythonVersion>, ) -> Result<()>

Updates configured ABI to build for to the requested abi3 version This is a no-op for platforms where abi3 is not supported