Python Functions
PyO3 supports two ways to define a free function in Python. Both require registering the function to a module.
One way is defining the function in the module definition.
use pyo3::prelude::*; #[pymodule] fn rust2py(py: Python, m: &PyModule) -> PyResult<()> { // Note that the `#[pyfn()]` annotation automatically converts the arguments from // Python objects to Rust values; and the Rust return value back into a Python object. #[pyfn(m, "sum_as_string")] fn sum_as_string_py(_py: Python, a:i64, b:i64) -> PyResult<String> { Ok(format!("{}", a + b)) } Ok(()) } # fn main() {}
The other is annotating a function with #[pyfunction]
and then adding it
to the module using the wrap_pyfunction!
macro.
use pyo3::prelude::*; use pyo3::wrap_pyfunction; #[pyfunction] fn double(x: usize) -> usize { x * 2 } #[pymodule] fn module_with_functions(py: Python, m: &PyModule) -> PyResult<()> { m.add_wrapped(wrap_pyfunction!(double)).unwrap(); Ok(()) } # fn main() {}
Argument parsing
Both the #[pyfunction]
and #[pyfn]
attributes support specifying details of
argument parsing. The details are given in the section "Method arguments" in
the Classes chapter. Here is an example for a function that accepts
arbitrary keyword arguments (**kwargs
in Python syntax) and returns the number
that was passed:
# extern crate pyo3; use pyo3::prelude::*; use pyo3::wrap_pyfunction; use pyo3::types::PyDict; #[pyfunction(kwds="**")] fn num_kwds(kwds: Option<&PyDict>) -> usize { kwds.map_or(0, |dict| dict.len()) } #[pymodule] fn module_with_functions(py: Python, m: &PyModule) -> PyResult<()> { m.add_wrapped(wrap_pyfunction!(num_kwds)).unwrap(); Ok(()) } # fn main() {}
Making the function signature available to Python
In order to make the function signature available to Python to be retrieved via
inspect.signature
, use the #[text_signature]
annotation as in the example
below. The /
signifies the end of positional-only arguments.
# #![allow(unused_variables)] #fn main() { use pyo3::prelude::*; /// This function adds two unsigned 64-bit integers. #[pyfunction] #[text_signature = "(a, b, /)"] fn add(a: u64, b: u64) -> u64 { a + b } #}
This also works for classes and methods:
# #![allow(unused_variables)] #fn main() { use pyo3::prelude::*; use pyo3::types::PyType; // it works even if the item is not documented: #[pyclass] #[text_signature = "(c, d, /)"] struct MyClass {} #[pymethods] impl MyClass { // the signature for the constructor is attached // to the struct definition instead. #[new] fn new(obj: &PyRawObject, c: i32, d: &str) { obj.init(Self {}); } // the self argument should be written $self #[text_signature = "($self, e, f)"] fn my_method(&self, e: i32, f: i32) -> i32 { e + f } #[classmethod] #[text_signature = "(cls, e, f)"] fn my_class_method(cls: &PyType, e: i32, f: i32) -> i32 { e + f } #[staticmethod] #[text_signature = "(e, f)"] fn my_static_method(e: i32, f: i32) -> i32 { e + f } } #}
Making the function signature available to Python (old method)
Alternatively, simply make sure the first line of your docstring is
formatted like in the following example. Please note that the newline after the
--
is mandatory. The /
signifies the end of positional-only arguments. This
is not a feature of this library in particular, but the general format used by
CPython for annotating signatures of built-in functions.
#[text_signature]
should be preferred, since it will override automatically
generated signatures when those are added in a future version of PyO3.
# #![allow(unused_variables)] #fn main() { use pyo3::prelude::*; /// add(a, b, /) /// -- /// /// This function adds two unsigned 64-bit integers. #[pyfunction] fn add(a: u64, b: u64) -> u64 { a + b } // a function with a signature but without docs. Both blank lines after the `--` are mandatory. /// sub(a, b, /) /// -- /// /// #[pyfunction] fn sub(a: u64, b: u64) -> u64 { a - b } #}
When annotated like this, signatures are also correctly displayed in IPython.
>>> pyo3_test.add?
Signature: pyo3_test.add(a, b, /)
Docstring: This function adds two unsigned 64-bit integers.
Type: builtin_function_or_method
Closures
Currently, there are no conversions between Fn
s in Rust and callables in Python. This would definitely be possible and very useful, so contributions are welcome. In the meantime, you can do the following:
Calling a Python function in Rust
You can use ObjectProtocol::is_callable
to check if you got a callable, which is true for functions (including lambdas), methods and objects with a __call__
method. You can call the object with ObjectProtocol::call
with the args as first parameter and the kwargs (or None
) as second parameter. There are also ObjectProtocol::call0
with no args and ObjectProtocol::call1
with only the positional args.
Calling Rust Fn
s in Python
If you have a static function, you can expose it with #[pyfunction]
and use wrap_pyfunction!
to get the corresponding PyObject
. For dynamic functions, e.g. lambda and functions that were passed as arguments, you must put them in some kind of owned container, e.g. a box. (A long-term solution will be a special container similar to wasm-bindgen's Closure
). You can then use a #[pyclass]
struct with that container as a field as a way to pass the function over the FFI barrier. You can even make that class callable with __call__
so it looks like a function in Python code.