[{"id":"cG9zdDo1MDc=","slug":"rust-in-python-made-easy","title":"Rust in Python made easy","content":"\n

Python is truly amazing. With all that greatness generally there has to be a tradeoff and in the case of Python it’s performance.

\n\n\n\n

Luckily there is an easy way to run computation intensive work in Rust, which is of course orders of magnitude faster. Let’s see how!

\n\n\n\n

Overview

\n\n\n\n

\"\" — Photo by Jonathan Chng on Unsplash

\n\n\n\n

Lets assume we want to run the following python code in rust.

\n\n\n\n

def add(a, b):\n    return a + b\n\nadd(1, 2)  # 3

\n\n\n\n

Lets see the steps we need to take to achieve this:

\n\n\n\n

write some rust code
compile rust
import rust in python
run the rust code inside of python

\n\n\n\n

Hello world example

\n\n\n\n

First lets create a new rust project by running:

\n\n\n\n

cargo new rust_in_python

\n\n\n\n

Then lets rename src/main.rs to src/lib.rs as we want a library and not standalone program.

\n\n\n\n

mv src/main.rs src/lib.rs

\n\n\n\n

Now we simply write a hello world function in rust

\n\n\n\n

#[no_mangle]\nfn hello() {\n    println!(\"Hello from rust 👋\");\n}

\n\n\n\n

For every function that need to be available to other languages (in our case Python) through foreign function call (ffi) we will need to add the #[no_mangle] flag to it.

\n\n\n\n

The last step is to tell rust to compile to a dynamic library. To do so simply add the following to your Cargo.toml config file.

\n\n\n\n

[lib]\ncrate-type = [\"dylib\"]

\n\n\n\n

Now we are ready to build 🚀

\n\n\n\n

cargo build --release

\n\n\n\n

Now just create a main.py file and we can import and run our function.

\n\n\n\n

from ctypes import CDLL\n\nlib = CDLL(\"target/release/librust_in_python.dylib\")\nlib.hello()

\n\n\n\n

And if you run it you will be greeted from rust. No need to install, the ctypes package is included the standard python library.

\n\n\n\n

python main.py

\n\n\n\n

With return & parameters

\n\n\n\n

Of course without giving parameters to the function and receiving its output this whole endeavour would be useless.

\n\n\n\n

Before we start I would like to remind you that python is untyped whereas rust of course is strongly typed. This means that we will need to tell python what types the parameters and the return of our rust function we have.

\n\n\n\n

First lets write the simple add function in rust

\n\n\n\n

#[no_mangle]\nfn add(a: f64, b: f64) -> f64 {\n    return a + b;\n}

\n\n\n\n

Don’t forget to build again 😉

\n\n\n\n

cargo build --release

\n\n\n\n

Now to the python part

\n\n\n\n

from ctypes import CDLL, c_double\n\nlib = CDLL(\"target/release/librust_in_python.dylib\")\n\nlib.add.argtypes = (c_double, c_double)\nlib.add.restype = c_double\n\nresult = lib.add(1.5, 2.5)\nprint(result)  # 4.0

\n\n\n\n

Lets see what is happening here:

\n\n\n\n

With lib.add.argtypes we must pass a tuple specifying how python should parse the data we pass to the add function. The ctypes package includes a list of different types we can use. See the full list here.

\n\n\n\n

The same happens with lib.add.restype. As you might have guessed this tells python what type is returned from the rust function.

\n\n\n\n

In our case it’s all c_double as we are using f64 in rust.

\n\n\n\n

Data types in rust

\n\n\n\n

Lets see some other data types and their equivalent in rust.

\n\n\n\n

Python	C	Rust
c_bool	–
c_byte	char	i8
c_ubyte	unsigned char	u8
c_short	short	i16
c_ushort	unsigned short	u16
c_int	int	i32
c_uint	unsigned int	u32
c_long	long	i64
c_ulong	unsigned long	u64
c_float	float	f32
c_double	double	f64

\n\n\n\n

Arrays & List

\n\n\n\n

So what about lists? Unfortunately I have not found a way to use Vectors for dynamic size arrays. So for now it’s just fixed size arrays.

\n\n\n\n

Rust

\n\n\n\n

#[no_mangle]\nfn sum(arr: [i32; 5]) -> i32 {\n    let mut total: i32 = 0;\n    for number in arr.iter() {\n        total += number;\n    }\n    return total;\n}

\n\n\n\n

Python

\n\n\n\n

from ctypes import CDLL, c_int\n\nlib = CDLL(\"target/release/librust_in_python.dylib\")\n\nlst = [1, 2, 3, 4, 5]\n# Create the memory of the list size\nseq = c_int * len(lst)\narr = seq(*lst)\n\nresult = lib.sum(arr)\nprint(result)

\n\n\n\n

Classes and complex data types

\n\n\n\n

Often it can be very useful to send and/or receive data in a structured, compact way. We can do this using structs.

\n\n\n\n

Rust

\n\n\n\n

#[repr(C)]\npub struct Point {\n    pub x: f64,\n    pub y: f64,\n}\n\n#[no_mangle]\nfn greet_point(p: Point) {\n    println!(\"x: {}, y: {}\", p.x, p.y);\n}

\n\n\n\n

Python

\n\n\n\n

from ctypes import CDLL, Structure, c_double\n\nlib = CDLL(\"target/release/librust_in_python.dylib\")\n\nclass Point(Structure):\n    _fields_ = [\n        ('x', c_double),\n        ('y', c_double)\n    ]\n\n\np = Point(x=1.2, y=3.4)\nlib.greet_point(p)

\n","status":"publish","date":"2020-01-01T23:25:27","modified":"2020-09-22T20:50:35","tags":{"nodes":[{"id":"dGVybToyMQ==","slug":"ffi","name":"ffi","count":1},{"id":"dGVybTo0Ng==","slug":"python","name":"python","count":3},{"id":"dGVybTo0OQ==","slug":"rust","name":"rust","count":1}]},"post":{"featured":{"srcSet":"https://api.nicco.io/wp-content/uploads/2020/01/jonathan-chng-HgoKvtKpyHA-unsplash-scaled-1-300x185.jpg 300w, https://api.nicco.io/wp-content/uploads/2020/01/jonathan-chng-HgoKvtKpyHA-unsplash-scaled-1-1024x631.jpg 1024w, https://api.nicco.io/wp-content/uploads/2020/01/jonathan-chng-HgoKvtKpyHA-unsplash-scaled-1-150x92.jpg 150w, https://api.nicco.io/wp-content/uploads/2020/01/jonathan-chng-HgoKvtKpyHA-unsplash-scaled-1-768x473.jpg 768w, https://api.nicco.io/wp-content/uploads/2020/01/jonathan-chng-HgoKvtKpyHA-unsplash-scaled-1-1536x947.jpg 1536w, https://api.nicco.io/wp-content/uploads/2020/01/jonathan-chng-HgoKvtKpyHA-unsplash-scaled-1-2048x1262.jpg 2048w, https://api.nicco.io/wp-content/uploads/2020/01/jonathan-chng-HgoKvtKpyHA-unsplash-scaled-1-500x308.jpg 500w, https://api.nicco.io/wp-content/uploads/2020/01/jonathan-chng-HgoKvtKpyHA-unsplash-scaled-1-800x493.jpg 800w, https://api.nicco.io/wp-content/uploads/2020/01/jonathan-chng-HgoKvtKpyHA-unsplash-scaled-1-1200x740.jpg 1200w, https://api.nicco.io/wp-content/uploads/2020/01/jonathan-chng-HgoKvtKpyHA-unsplash-scaled-1-1500x925.jpg 1500w, https://api.nicco.io/wp-content/uploads/2020/01/jonathan-chng-HgoKvtKpyHA-unsplash-scaled-1-2000x1233.jpg 2000w","altText":"","sourceUrl":"https://api.nicco.io/wp-content/uploads/2020/01/jonathan-chng-HgoKvtKpyHA-unsplash-scaled-1.jpg"}}}]