pyembed 0.24.0

Embed a 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

.. py:currentmodule:: oxidized_importer

.. _pyembed_controlling_python:

=================================
Controlling Python from Rust Code
=================================

Initializing a Python Interpreter
=================================

Initializing an embedded Python interpreter in your Rust process is as simple
as calling
``pyembed::MainPythonInterpreter::new(config: OxidizedPythonInterpreterConfig)``.

The hardest part about this is constructing the
``pyembed::OxidizedPythonInterpreterConfig`` instance.

Using a Python Interpreter
==========================

Once you've constructed a ``pyembed::MainPythonInterpreter`` instance, you
can obtain a ``pyo3::Python`` instance via ``.with_gil()`` and then
use it:

.. code-block:: rust

   fn do_it(interpreter: &MainPythonInterpreter) -> {
       interpreter.with_gil(|py| {
            match py.eval("print('hello, world')") {
               Ok(_) => print("python code executed successfully"),
               Err(e) => print("python error: {:?}", e),
           }
       });

   }

Since CPython's API relies on static variables (sadly), if you really wanted
to, you could call out to CPython C APIs directly (probably via the
bindings in the ``pyo3`` crate) and they would interact with the
interpreter started by the ``pyembed`` crate. This is all ``unsafe``, of course,
so tread at your own peril.

Finalizing the Interpreter
==========================

``pyembed::MainPythonInterpreter`` implements ``Drop`` and it will call
``Py_FinalizeEx()`` when called. So to terminate the Python interpreter, simply
have the ``MainPythonInterpreter`` instance go out of scope or drop it
explicitly.

A Note on the ``pyembed`` APIs
==============================

The ``pyembed`` crate is highly tailored towards PyOxidizer's default use
cases and the APIs are not considered extremely well polished.

While the functionality should work, the ergonomics may not be great.

It is a goal of the PyOxidizer project to support Rust programmers who want
to embed Python in Rust applications. So contributions to improve the quality
of the ``pyembed`` crate will likely be greatly appreciated!