Struct PyEnv

pub struct PyEnv { /* private fields */ }

A Python environment that can install packages and execute code.

Implementations

impl PyEnv

pub fn new( path: impl Into<PathBuf>, std_out: impl Fn(&str) + 'static, std_err: impl Fn(&str) + 'static, ) -> Self

Constructor for piping stdout and stderr to a custom stream. Use at() if you want to inherit the streams.

Examples found in repository

examples/pipe.rs (line 6)

fn main() -> PyResult<()> {
    let out = |line: &str| println!("{}", line);
    let err = |line: &str| eprintln!("{}", line);
    PyEnv::new("./py_test/run", out, err)
        .execute("print('hello world')")?;
    Ok(())
}

pub fn at(path: impl Into<PathBuf>) -> Self

Constructor inheriting default stdout and stderr; use new() to customize the streams.

Examples found in repository

examples/unwrapped.rs (line 6)

pub fn main() {
    // This code attempts to install faker and run a script dependent on it, panicing upon shell
    // command error (not Python code error).
    PyEnv::at("./py_test")
        .try_install("faker")
        .try_execute("import faker; print(faker.Faker().name())");
}

pub fn install(&self, package_name: &str) -> PyResult<&Self>

Installs a package in the PyEnv, returning itself to easily chain dependencies.

pub fn try_install(&self, package_name: &str) -> &Self

An unwrapped install() run, which panics upon failure. See install() for the version which returns a PyResult.

Examples found in repository

examples/unwrapped.rs (line 7)

pub fn main() {
    // This code attempts to install faker and run a script dependent on it, panicing upon shell
    // command error (not Python code error).
    PyEnv::at("./py_test")
        .try_install("faker")
        .try_execute("import faker; print(faker.Faker().name())");
}

pub fn execute(&self, code: &str) -> PyResult<&Self>

Executes arbitrary code in the PyEnv, returning itself to easily chain runs.

Examples found in repository

examples/pipe.rs (line 7)

fn main() -> PyResult<()> {
    let out = |line: &str| println!("{}", line);
    let err = |line: &str| eprintln!("{}", line);
    PyEnv::new("./py_test/run", out, err)
        .execute("print('hello world')")?;
    Ok(())
}

pub fn try_execute(&self, code: &str) -> &Self

An unwrapped execute() run, which panics upon failure. See execute() for the version which returns a PyResult.

Examples found in repository

examples/unwrapped.rs (line 8)

pub fn main() {
    // This code attempts to install faker and run a script dependent on it, panicing upon shell
    // command error (not Python code error).
    PyEnv::at("./py_test")
        .try_install("faker")
        .try_execute("import faker; print(faker.Faker().name())");
}

pub fn persistent(&mut self, persistent: bool) -> &Self

Makes the environment impersistent beyond the PyEnv, deleting it upon dropping

Trait Implementations

impl Drop for PyEnv

fn drop(&mut self)

Executes the destructor for this type.