Struct maturin::PythonInterpreter

pub struct PythonInterpreter {
    pub config: InterpreterConfig,
    pub executable: PathBuf,
    pub platform: Option<String>,
    pub runnable: bool,
    pub implementation_name: String,
    pub soabi: Option<String>,
}

The location and version of an interpreter

Fields

config: InterpreterConfig

Python’s sysconfig Python’s major version

executable: PathBuf

Path to the python interpreter, e.g. /usr/bin/python3.6

Just the name of the binary in PATH does also work, e.g. python3.5

platform: Option<String>

Comes from sysconfig.get_platform()

Note that this can be None when cross compiling

runnable: bool

Is this interpreter runnable

When cross compile the target interpreter isn’t runnable, and it’s executable is empty

implementation_name: String

Comes from sys.platform.name

soabi: Option<String>

Comes from sysconfig var SOABI

Implementations

impl PythonInterpreter

pub fn has_stable_api(&self) -> bool

Does this interpreter have PEP 384 stable api aka. abi3 support?

pub fn get_tag( &self, context: &BuildContext, platform_tags: &[PlatformTag] ) -> Result<String>

Returns the supported python environment in the PEP 425 format used for the wheel filename: {python tag}-{abi tag}-{platform tag}

Don’t ask me why or how, this is just what setuptools uses so I’m also going to use

If abi3 is true, cpython wheels use the generic abi3 with the given version as minimum

pub fn get_library_name(&self, base: &str) -> String

Adds the ext_suffix we read from python or know (.pyd/.abi3.so) and adds it to the base name

For CPython, generate extensions as follows:

For python 3, there is PEP 3149, but that is only valid for 3.2 - 3.4. Since only 3.6+ is supported, the templates are adapted from the (also incorrect) release notes of CPython 3.5: https://docs.python.org/3/whatsnew/3.5.html#build-and-c-api-changes

Examples for 64-bit on CPython 3.6m: Linux: foobar.cpython-36m-x86_64-linux-gnu.so Windows: foobar.cp36-win_amd64.pyd Mac: foobar.cpython-36m-darwin.so FreeBSD: foobar.cpython-36m.so

For pypy3, we read importlib.machinery.EXTENSION_SUFFIXES[0].

pub fn is_windows_debug(&self) -> bool

Is this a debug build of Python for Windows?

pub fn check_executable( executable: impl AsRef<Path>, target: &Target, bridge: &BridgeModel ) -> Result<Option<PythonInterpreter>>

Checks whether the given command is a python interpreter and returns a PythonInterpreter if that is the case

pub fn from_config(config: InterpreterConfig) -> Self

Construct a PythonInterpreter from a sysconfig and target

pub fn find_by_target( target: &Target, requires_python: Option<&VersionSpecifiers> ) -> Vec<PythonInterpreter>

Find all available python interpreters for a given target

pub fn find_all( target: &Target, bridge: &BridgeModel, requires_python: Option<&VersionSpecifiers> ) -> Result<Vec<PythonInterpreter>>

Tries to find all installed python versions using the heuristic for the given platform.

We have two filters: The optional requires-python from the pyproject.toml and minimum python minor either from the bindings (i.e. Cargo.toml abi3-py{major}{minor}) or the global default minimum minor version

pub fn check_executables( executables: &[PathBuf], target: &Target, bridge: &BridgeModel ) -> Result<Vec<PythonInterpreter>>

Checks that given list of executables are all valid python interpreters, determines the abiflags and versions of those interpreters and returns them as PythonInterpreter

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

Run a python script using this Python interpreter.

pub fn support_portable_wheels(&self) -> bool

Whether this Python interpreter support portable manylinux/musllinux wheels

Returns true if we can not decide

pub fn environment_signature(&self) -> String

An opaque string that uniquely identifies this Python interpreter. Used to trigger rebuilds for pyo3 when the Python interpreter changes.

pub fn get_venv_site_package( &self, venv_base: impl AsRef<Path>, target: &Target ) -> PathBuf

Returns the site-packages directory inside a venv e.g. {venv_base}/lib/python{x}.{y} on unix or {venv_base}/Lib on window

Trait Implementations

impl Clone for PythonInterpreter

fn clone(&self) -> PythonInterpreter

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PythonInterpreter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for PythonInterpreter

type Target = InterpreterConfig

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for PythonInterpreter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for PythonInterpreter

fn eq(&self, other: &PythonInterpreter) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for PythonInterpreter

impl StructuralPartialEq for PythonInterpreter