Struct pyo3_pack::BuildContext

pub struct BuildContext {
    pub target: Target,
    pub bridge: BridgeModel,
    pub metadata21: Metadata21,
    pub scripts: HashMap<String, String>,
    pub module_name: String,
    pub manifest_path: PathBuf,
    pub out: PathBuf,
    pub release: bool,
    pub strip: bool,
    pub manylinux: Manylinux,
    pub cargo_extra_args: Vec<String>,
    pub rustc_extra_args: Vec<String>,
    pub interpreter: Vec<PythonInterpreter>,
    pub cargo_metadata: Metadata,
}

Contains all the metadata required to build the crate

Fields

target: Target

The platform, i.e. os and pointer width

bridge: BridgeModel

Whether to use cffi or pyo3/rust-cpython

metadata21: Metadata21

Python Package Metadata 2.1

scripts: HashMap<String, String>

The [console_scripts] for the entry_points.txt

module_name: String

The name of the module can be distinct from the package name, mostly because package names normally contain minuses while module names have underscores. The package name is part of metadata21

manifest_path: PathBuf

The path to the Cargo.toml. Required for the cargo invocations

out: PathBuf

The directory to store the built wheels in. Defaults to a new "wheels" directory in the project's target directory

release: bool

Pass --release to cargo

strip: bool

Strip the library for minimum file size

manylinux: Manylinux

Whether to use the the manylinux and check compliance (on), use it but don't check compliance (no-auditwheel) or use the native linux tag (off)

cargo_extra_args: Vec<String>

Extra arguments that will be passed to cargo as cargo rustc [...] [arg1] [arg2] --

rustc_extra_args: Vec<String>

Extra arguments that will be passed to rustc as cargo rustc [...] -- [arg1] [arg2]

interpreter: Vec<PythonInterpreter>

The available python interpreter

cargo_metadata: Metadata

Cargo.toml as resolved by cargo_metadata

Methods

impl BuildContext

pub fn build_wheels(
    &self
) -> Result<Vec<(PathBuf, String, Option<PythonInterpreter>)>, Error>

Checks which kind of bindings we have (pyo3/rust-cypthon or cffi or bin) and calls the correct builder. Returns a Vec that contains location, python tag (e.g. py2.py3 or cp35) and for bindings the python interpreter they bind against.

pub fn build_binding_wheels(
    &self
) -> Result<Vec<(PathBuf, String, Option<PythonInterpreter>)>, Error>

Builds wheels for a Cargo project for all given python versions. Return type is the same as BuildContext::build_wheels()

Defaults to 2.7 and 3.{5, 6, 7, 8, 9} if no python versions are given and silently ignores all non-existent python versions.

Runs auditwheel_rs() if not deactivated

pub fn compile_cdylib(
    &self,
    python_interpreter: Option<&PythonInterpreter>
) -> Result<PathBuf, Error>

Runs cargo build, extracts the cdylib from the output, runs auditwheel and returns the artifact

pub fn build_cffi_wheel(&self) -> Result<PathBuf, Error>

Builds a wheel with cffi bindings

pub fn build_bin_wheel(&self) -> Result<PathBuf, Error>

Builds a wheel that contains a binary

Runs auditwheel_rs() if not deactivated