Struct pyo3_pack::BuildContext

pub struct BuildContext {
    pub interpreter: Vec<String>,
    pub binding_crate: String,
    pub manifest_path: PathBuf,
    pub wheel_dir: Option<PathBuf>,
    pub use_cached: bool,
    pub debug: bool,
    pub skip_auditwheel: bool,
}

High level API for building wheels from a crate which can be also used for the CLI

Fields

interpreter: Vec<String>

The python versions to build wheels for, given as the names of the interpreters. Uses a built-in list if not explicitly set.

binding_crate: String

The crate providing the python bindings

manifest_path: PathBuf

The path to the Cargo.toml or the directory containing it

wheel_dir: Option<PathBuf>

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

use_cached: bool

Don't rebuild if a wheel with the same name is already present

debug: bool

Do a debug build (don't pass --release to cargo)

skip_auditwheel: bool

Don't check for manylinux compliance

Methods

impl BuildContext

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

Builds wheels for a Cargo project for all given python versions. Returns the paths where the wheels are saved and the Python metadata describing the cargo project

Defaults to 2.7 and 3.{5, 6, 7, 8, 9} if not python versions are given and silently ignores all non-existent python versions. Runs auditwheel_rs().if the auditwheel feature isn't deactivated

Trait Implementations

impl Debug for BuildContext

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

Formats the value using the given formatter.

impl StructOpt for BuildContext

fn clap<'a, 'b>() -> App<'a, 'b>

Returns the corresponding clap::App.

fn from_clap(matches: &ArgMatches) -> Self

Creates the struct from clap::ArgMatches. It cannot fail with a parameter generated by clap by construction.

fn from_args() -> Self

Gets the struct from the command line arguments. Print the error message and quit the program in case of failure.

fn from_iter<I>(iter: I) -> Self where     I: IntoIterator,     <I as IntoIterator>::Item: Into<OsString>,     <I as IntoIterator>::Item: Clone,

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

fn from_iter_safe<I>(iter: I) -> Result<Self, Error> where     I: IntoIterator,     <I as IntoIterator>::Item: Into<OsString>,     <I as IntoIterator>::Item: Clone,

Gets the struct from any iterator such as a Vec of your making.

impl Clone for BuildContext

fn clone(&self) -> BuildContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for BuildContext

impl PartialEq for BuildContext

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

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

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

This method tests for !=.

impl Default for BuildContext

fn default() -> Self

Returns the "default value" for a type.