10 unstable releases (4 breaking)

✓ Uses Rust 2018 edition

0.5.1 Apr 24, 2020
0.4.1 Apr 3, 2020
0.4.0 Nov 22, 2019
0.3.1 Jun 19, 2019

#26 in FFI

Download history 15/week @ 2020-03-14 26/week @ 2020-03-21 23/week @ 2020-03-28 29/week @ 2020-04-04 53/week @ 2020-04-11 80/week @ 2020-04-18 159/week @ 2020-04-25 63/week @ 2020-05-02 103/week @ 2020-05-09 14/week @ 2020-05-16 23/week @ 2020-05-23 39/week @ 2020-05-30 16/week @ 2020-06-06 28/week @ 2020-06-13 16/week @ 2020-06-20 23/week @ 2020-06-27

114 downloads per month
Used in 2 crates

BSD-2-Clause

29KB
422 lines

inline-python

Inline Python code directly in your Rust code.

Example

#![feature(proc_macro_hygiene)]
use inline_python::python;

fn main() {
    let who = "world";
    let n = 5;
    python! {
        for i in range('n):
            print(i, "Hello", 'who)
        print("Goodbye")
    }
}

How to use

Use the python!{..} macro to write Python code directly in your Rust code. You'll need to add #![feature(proc_macro_hygiene)], and use a nightly version of the compiler that supports this feature.

Using Rust variables

To reference Rust variables, use 'var, as shown in the example above. var needs to implement pyo3::ToPyObject.

Re-using a Python context

It is possible to create a Context object ahead of time and use it for running the Python code. The context can be re-used for multiple invocations to share global variables across macro calls.

let c = Context::new();

c.run(python! {
  foo = 5
});

c.run(python! {
  assert foo == 5
});

As a shortcut, you can assign a python!{} invocation directly to a variable of type Context to create a new context and run the Python code in it.

let c: Context = python! {
  foo = 5
};

c.run(python! {
  assert foo == 5
});

Getting information back

A Context object could also be used to pass information back to Rust, as you can retrieve the global Python variables from the context through Context::get.

let c: Context = python! {
  foo = 5
};

assert_eq!(c.get::<i32>("foo"), 5);

Syntax issues

Since the Rust tokenizer will tokenize the Python code, some valid Python code is rejected. The two main things to remember are:

  • Use double quoted strings ("") instead of single quoted strings ('').

    (Single quoted strings only work if they contain a single character, since in Rust, 'a' is a character literal.)

  • Use //-comments instead of #-comments.

    (If you use # comments, the Rust tokenizer will try to tokenize your comment, and complain if your comment doesn't tokenize properly.)

Other minor things that don't work are:

  • Certain escape codes in string literals. (Specifically: \a, \b, \f, \v, \N{..}, \123 (octal escape codes), \u, and \U.)

    These, however, are accepted just fine: \\, \n, \t, \r, \xAB (hex escape codes), and \0

  • Raw string literals with escaped double quotes. (E.g. r"...\"...".)

  • Triple-quoted byte- and raw-strings with content that would not be valid as a regular string. And the same for raw-byte and raw-format strings. (E.g. b"""\xFF""", r"""\z""", fr"\z", br"\xFF".)

  • The // and //= operators are unusable, as they start a comment.

    Workaround: you can write ## instead, which is automatically converted to //.

Everything else should work fine.

Dependencies

~1.9–2.6MB
~58K SLoC