Struct pyembed::MainPythonInterpreter

pub struct MainPythonInterpreter<'a> {
    pub config: PythonConfig,
    // some fields omitted
}

Manages an embedded Python interpreter.

Warning: Python interpreters have global state. There should only be a single instance of this type per process.

Instances must only be constructed through MainPythonInterpreter::new().

This type and its various functionality is a glorified wrapper around the Python C API. But there's a lot of added functionality on top of what the C API provides.

Both the low-level python3-sys and higher-level cpython crates are used.

Fields

config: PythonConfig

Methods

impl<'a> MainPythonInterpreter<'a>

pub fn new(
    config: PythonConfig
) -> Result<MainPythonInterpreter<'a>, &'static str>

Construct a Python interpreter from a configuration.

The Python interpreter is initialized as a side-effect. The GIL is held.

pub fn release_gil(&mut self)

Ensure the Python GIL is released.

pub fn acquire_gil(&mut self) -> Python<'a>

Ensure the Python GIL is acquired, returning a handle on the interpreter.

pub fn run(&mut self) -> PyResult<PyObject>

Runs the interpreter with the default code execution settings.

The crate was built with settings that configure what should be executed by default. Those settings will be loaded and executed.

pub fn run_and_handle_error(&mut self) -> PythonRunResult

Runs the interpreter and handles any exception that was raised.

pub fn run_as_main(&mut self) -> i32

Calls run() and resolves a suitable exit code.

pub fn run_module_as_main(&mut self, name: &str) -> PyResult<PyObject>

Runs a Python module as the main module.

Returns the execution result of the module code.

The interpreter is automatically initialized if needed.

pub fn run_repl(&mut self) -> PyResult<PyObject>

Start and run a Python REPL.

This emulates what CPython's main.c does.

The interpreter is automatically initialized if needed.

pub fn run_code(&mut self, code: &str) -> PyResult<PyObject>

Runs Python code provided by a string.

This is similar to what python -c <code> would do.

The interpreter is automatically initialized if needed.

pub fn run_file(&mut self, filename: &CStr) -> PyResult<PyObject>

Runs Python code in a filesystem path.

pub fn print_err(&mut self, err: PyErr)

Print a Python error.

Under the hood this calls PyErr_PrintEx(), which may call Py_Exit() and may write to stderr.

Trait Implementations

impl<'a> Drop for MainPythonInterpreter<'a>

fn drop(&mut self)

Executes the destructor for this type.