pyo3 0.30.1

Bindings to Python interpreter
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

use std::env;

use pyo3_build_config::pyo3_build_script_impl::{
    cargo_env_var, env_var, errors::Result, print_feature_cfgs,
};
use pyo3_build_config::{InterpreterConfig, add_libpython_rpath_link_args, bail};

fn ensure_auto_initialize_ok(interpreter_config: &InterpreterConfig) -> Result<()> {
    if cargo_env_var("CARGO_FEATURE_AUTO_INITIALIZE").is_some() && !interpreter_config.shared() {
        bail!(
            "The `auto-initialize` feature is enabled, but your python installation only supports \
            embedding the Python interpreter statically. If you are attempting to run tests, or a \
            binary which is okay to link dynamically, install a Python distribution which ships \
            with the Python shared library.\n\
            \n\
            Embedding the Python interpreter statically does not yet have first-class support in \
            PyO3. If you are sure you intend to do this, disable the `auto-initialize` feature.\n\
            \n\
            For more information, see \
            https://pyo3.rs/v{pyo3_version}/\
                building-and-distribution.html#embedding-python-in-rust",
            pyo3_version = env::var("CARGO_PKG_VERSION").unwrap()
        );
    }
    Ok(())
}

/// Prepares the PyO3 crate for compilation.
///
/// This loads the config from pyo3-build-config and then makes some additional checks to improve UX
/// for users.
///
/// Emits the cargo configuration based on this config as well as a few checks of the Rust compiler
/// version to enable features which aren't supported on MSRV.
fn configure_pyo3() -> Result<()> {
    let interpreter_config = pyo3_build_config::get();

    ensure_auto_initialize_ok(interpreter_config)?;

    for cfg in interpreter_config.build_script_outputs() {
        println!("{cfg}")
    }

    print_feature_cfgs();

    // Forwards interpreter config under the links = "pyo3-python" configuration,
    // which allows consumers of `pyo3-build-config` APIs to depend on pyo3 instead of pyo3-ffi.
    interpreter_config.to_cargo_dep_env()?;

    // Make `cargo test` etc work with non-system Python installations
    add_libpython_rpath_link_args();

    Ok(())
}

/// Enables a faux `std` feature by default.
///
/// Set env var `PYO3_WIP_NO_STD` to `1` to disable it.
// Has matching functions in
// - pyo3-macros-backend
// - pytests
fn configure_wip_no_std() {
    println!("cargo:rustc-check-cfg=cfg(wip_feature_std)");
    match env_var("PYO3_WIP_NO_STD").map(|s| s.into_string().unwrap()) {
        Some(no_std) if no_std.trim() == "1" || no_std.trim().eq_ignore_ascii_case("true") => (),
        _ => println!("cargo:rustc-cfg=wip_feature_std"),
    }
}

fn main() {
    configure_wip_no_std();
    pyo3_build_config::print_expected_cfgs();
    if let Err(e) = configure_pyo3() {
        eprintln!("error: {}", e.report());
        std::process::exit(1)
    }
}