Crate pyembed[−][src]

Control an embedded Python interpreter.

The pyembed crate contains functionality for controlling an embedded Python interpreter running in the current process.

pyembed provides significant additional functionality over what is covered by the official Embedding Python in Another Application docs and provided by the CPython C API. For example, pyembed defines a custom Python meta path importer that can import Python module bytecode from memory using 0-copy.

While this crate is conceptually generic and can be used as a high-level manager of an embedded Python interpreter (it has a high-level API that makes running an embedded Python interpreter relatively easy), the crate was designed for use with PyOxidizer. If you are leveraging the advanced features like the module importer that can import modules from memory using 0-copy, you probably want to use this crate with PyOxidizer.

The most important types in this crate are OxidizedPythonInterpreterConfig and MainPythonInterpreter. An OxidizedPythonInterpreterConfig defines how a Python interpreter is to behave. A MainPythonInterpreter creates and manages that interpreter and serves as a high-level interface for running code in the interpreter.

Dependencies

Under the hood, pyembed makes direct use of the python3-sys crate for low-level Python FFI bindings as well as the cpython crate for higher-level interfacing.

It is an explicit goal of this crate to rely on as few external dependencies as possible. This is because we want to minimize bloat in produced binaries. At this time, we have required direct dependencies on published versions of the anyhow, dunce, libc, memmap, once_cell, python-packed-resources, python-packaging, tugger-file-manifest, and uuid crates. On Windows, this list is extended by memory-module-sys and winapi, which are required to support loading DLLs from memory. We also have an optional direct dependency on the jemalloc-sys, libmimalloc-sys, and snmalloc-sys crates for custom memory allocators.

This crate requires linking against a library providing CPython C symbols. (This dependency is via the python3-sys crate.) On Windows, this library must be named pythonXY.

Features

The optional jemalloc feature controls support for using jemalloc as Python’s memory allocator. Use of Jemalloc from Python is a run-time configuration option controlled by the OxidizedPythonInterpreterConfig type and having jemalloc compiled into the binary does not mean it is being used!

The optional mimalloc feature controls support for using mimalloc as Python’s memory allocator. The feature behaves similarly to jemalloc, which is documented above.

The optional snmalloc feature controls support for using snmalloc as Python’s memory allocator. The feature behaves similarly to jemalloc, which is documented above.

There exist mutually exclusive build-mode-* features to control how the build.rs build script works.

build-mode-standalone (the default) builds the crate as a standalone crate and doesn’t attempt to do anything special at build time.

build-mode-pyoxidizer-exe attempts to invoke a pyoxidizer executable to build required artifacts.

build-mode-prebuilt-artifacts will attempt to use artifacts produced by PyOxidizer out-of-band. In this mode, the PYOXIDIZER_ARTIFACT_DIR environment variable can refer to the directory containing build artifacts that this crate needs. If not set, OUT_DIR will be used.

The exist mutually exclusive cpython-link-* features to control how the cpython/python3-sys crates are built.

cpython-link-unresolved-static instructs to leave the Python symbols as unresolved. This crate will provide a static library providing the symbols.

cpython-link-default builds cpython with default link mode control. That crate’s build script will attempt to find a libpython from the python defined by PYTHON_SYS_EXECUTABLE or present on PATH.

Modules

technotes

Technical Implementation Notes

Structs

ExtensionModule	Defines an extra extension module to load.
MainPythonInterpreter	Manages an embedded Python interpreter.
OxidizedPythonInterpreterConfig	Configure a Python interpreter.
PythonInterpreterConfig	Holds configuration of a Python interpreter.

Enums