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 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
#![feature(specialization)] //! Rust bindings to the Python interpreter. //! //! Look at [the guide](https://pyo3.rs/) for a detailed introduction. //! //! # Ownership and Lifetimes //! //! In Python, all objects are implicitly reference counted. //! In rust, we will use the `PyObject` type to represent a reference to a Python object. //! //! Because all Python objects potentially have multiple owners, the //! concept of Rust mutability does not apply to Python objects. //! As a result, this API will allow mutating Python objects even if they are not stored //! in a mutable Rust variable. //! //! The Python interpreter uses a global interpreter lock (GIL) //! to ensure thread-safety. //! This API uses a zero-sized `struct Python<'p>` as a token to indicate //! that a function can assume that the GIL is held. //! //! You obtain a `Python` instance by acquiring the GIL, //! and have to pass it into all operations that call into the Python runtime. //! //! # Error Handling //! The vast majority of operations in this library will return `PyResult<...>`. //! This is an alias for the type `Result<..., PyErr>`. //! //! A `PyErr` represents a Python exception. Errors within the `PyO3` library are //! also exposed as Python exceptions. //! //! # Example //! //! ## Using rust from python //! //! Pyo3 can be used to generate a native python module. //! //! **`Cargo.toml`** //! //! ```toml //! [package] //! name = "string-sum" //! version = "0.1.0" //! edition = "2018" //! //! [lib] //! name = "string_sum" //! crate-type = ["cdylib"] //! //! [dependencies.pyo3] //! version = "0.8.5" //! features = ["extension-module"] //! ``` //! //! **`src/lib.rs`** //! //! ```rust //! use pyo3::prelude::*; //! use pyo3::wrap_pyfunction; //! //! #[pyfunction] //! /// Formats the sum of two numbers as string //! fn sum_as_string(a: usize, b: usize) -> PyResult<String> { //! Ok((a + b).to_string()) //! } //! //! /// This module is a python module implemented in Rust. //! #[pymodule] //! fn string_sum(py: Python, m: &PyModule) -> PyResult<()> { //! m.add_wrapped(wrap_pyfunction!(sum_as_string))?; //! //! Ok(()) //! } //! ``` //! //! On windows and linux, you can build normally with `cargo build --release`. On macOS, you need to set additional linker arguments. One option is to compile with `cargo rustc --release -- -C link-arg=-undefined -C link-arg=dynamic_lookup`, the other is to create a `.cargo/config` with the following content: //! //! ```toml //! [target.x86_64-apple-darwin] //! rustflags = [ //! "-C", "link-arg=-undefined", //! "-C", "link-arg=dynamic_lookup", //! ] //! ``` //! //! For developing, you can copy and rename the shared library from the target folder: On macOS, rename `libstring_sum.dylib` to `string_sum.so`, on windows `libstring_sum.dll` to `string_sum.pyd` and on linux `libstring_sum.so` to `string_sum.so`. Then open a python shell in the same folder and you'll be able to `import string_sum`. //! //! To build, test and publish your crate as python module, you can use [maturin](https://github.com/PyO3/maturin) or [setuptools-rust](https://github.com/PyO3/setuptools-rust). You can find an example for setuptools-rust in [examples/word-count](examples/word-count), while maturin should work on your crate without any configuration. //! //! ## Using python from rust //! //! Add `pyo3` this to your `Cargo.toml`: //! //! ```toml //! [dependencies] //! pyo3 = "0.8.5" //! ``` //! //! Example program displaying the value of `sys.version`: //! //! ```rust //! use pyo3::prelude::*; //! use pyo3::types::IntoPyDict; //! //! fn main() -> PyResult<()> { //! let gil = Python::acquire_gil(); //! let py = gil.python(); //! let sys = py.import("sys")?; //! let version: String = sys.get("version")?.extract()?; //! //! let locals = [("os", py.import("os")?)].into_py_dict(py); //! let code = "os.getenv('USER') or os.getenv('USERNAME') or 'Unknown'"; //! let user: String = py.eval(code, None, Some(&locals))?.extract()?; //! //! println!("Hello {}, I'm Python {}", user, version); //! Ok(()) //! } //! ``` pub use crate::class::*; pub use crate::conversion::{ AsPyPointer, FromPy, FromPyObject, FromPyPointer, IntoPy, IntoPyPointer, PyTryFrom, PyTryInto, ToBorrowedObject, ToPyObject, }; pub use crate::err::{PyDowncastError, PyErr, PyErrArguments, PyErrValue, PyResult}; pub use crate::gil::{init_once, GILGuard, GILPool}; pub use crate::instance::{AsPyRef, ManagedPyRef, Py, PyNativeType, PyRef, PyRefMut}; pub use crate::object::PyObject; pub use crate::objectprotocol::ObjectProtocol; pub use crate::python::{prepare_freethreaded_python, Python}; pub use crate::type_object::{PyObjectAlloc, PyRawObject, PyTypeInfo}; // Re-exported for wrap_function #[doc(hidden)] pub use paste; // Re-exported for py_run #[doc(hidden)] pub use indoc; // Re-exported for pymethods #[doc(hidden)] pub use inventory; // Re-exported for the `__wrap` functions #[doc(hidden)] pub use libc; // Re-exported for py_run #[doc(hidden)] pub use unindent; /// Raw ffi declarations for the c interface of python #[allow(clippy::unknown_clippy_lints)] #[allow(clippy::missing_safety_doc)] pub mod ffi; pub mod buffer; #[doc(hidden)] pub mod callback; pub mod class; mod conversion; #[doc(hidden)] pub mod derive_utils; mod err; pub mod exceptions; pub mod freelist; mod gil; mod instance; mod internal_tricks; pub mod marshal; mod object; mod objectprotocol; pub mod prelude; mod python; pub mod type_object; pub mod types; /// The proc macros, which are also part of the prelude pub mod proc_macro { pub use pyo3cls::pymodule; /// The proc macro attributes pub use pyo3cls::{pyclass, pyfunction, pymethods, pyproto}; } /// Returns a function that takes a [Python] instance and returns a python function. /// /// Use this together with `#[pyfunction]` and [types::PyModule::add_wrapped]. #[macro_export] macro_rules! wrap_pyfunction { ($function_name: ident) => {{ &pyo3::paste::expr! { [<__pyo3_get_function_ $function_name>] } }}; } /// Returns a function that takes a [Python] instance and returns a python module. /// /// Use this together with `#[pymodule]` and [types::PyModule::add_wrapped]. #[macro_export] macro_rules! wrap_pymodule { ($module_name:ident) => {{ pyo3::paste::expr! { &|py| unsafe { pyo3::PyObject::from_owned_ptr(py, [<PyInit_ $module_name>]()) } } }}; } /// A convenient macro to execute a Python code snippet, with some local variables set. /// /// # Example /// ``` /// use pyo3::{prelude::*, py_run, types::PyList}; /// let gil = Python::acquire_gil(); /// let py = gil.python(); /// let list = PyList::new(py, &[1, 2, 3]); /// py_run!(py, list, "assert list == [1, 2, 3]"); /// ``` /// /// You can use this macro to test pyfunctions or pyclasses quickly. /// /// # Example /// ``` /// use pyo3::{prelude::*, py_run}; /// #[pyclass] /// #[derive(Debug)] /// struct Time { /// hour: u32, /// minute: u32, /// second: u32, /// } /// #[pymethods] /// impl Time { /// fn repl_japanese(&self) -> String { /// format!("{}時{}分{}秒", self.hour, self.minute, self.second) /// } /// #[getter] /// fn hour(&self) -> u32 { /// self.hour /// } /// fn as_tuple(&self) -> (u32, u32, u32) { /// (self.hour, self.minute, self.second) /// } /// } /// let gil = Python::acquire_gil(); /// let py = gil.python(); /// let time = PyRef::new(py, Time {hour: 8, minute: 43, second: 16}).unwrap(); /// let time_as_tuple = (8, 43, 16); /// py_run!(py, time time_as_tuple, r#" /// assert time.hour == 8 /// assert time.repl_japanese() == "8時43分16秒" /// assert time.as_tuple() == time_as_tuple /// "#); /// ``` /// /// **Note** /// Since this macro is intended to use for testing, it **causes panic** when /// [Python::run] returns `Err` internally. /// If you need to handle failures, please use [Python::run] directly. /// #[macro_export] macro_rules! py_run { ($py:expr, $($val:ident)+, $code:literal) => {{ pyo3::py_run_impl!($py, $($val)+, pyo3::indoc::indoc!($code)) }}; ($py:expr, $($val:ident)+, $code:expr) => {{ pyo3::py_run_impl!($py, $($val)+, &pyo3::unindent::unindent($code)) }}; } #[macro_export] #[doc(hidden)] macro_rules! py_run_impl { ($py:expr, $($val:ident)+, $code:expr) => {{ use pyo3::types::IntoPyDict; use pyo3::ToPyObject; let d = [$((stringify!($val), $val.to_object($py)),)+].into_py_dict($py); $py.run($code, None, Some(d)) .map_err(|e| { e.print($py); // So when this c api function the last line called printed the error to stderr, // the output is only written into a buffer which is never flushed because we // panic before flushing. This is where this hack comes into place $py.run("import sys; sys.stderr.flush()", None, None) .unwrap(); }) .expect($code) }}; } /// Test readme and user guide #[doc(hidden)] pub mod doc_test { macro_rules! doc_comment { ($x:expr, $($tt:tt)*) => { #[doc = $x] $($tt)* }; } macro_rules! doctest { ($x:expr, $y:ident) => { doc_comment!(include_str!($x), mod $y {}); }; } doctest!("../README.md", readme_md); doctest!("../guide/src/advanced.md", guide_advanced_md); doctest!( "../guide/src/building_and_distribution.md", guide_building_and_distribution_md ); doctest!("../guide/src/class.md", guide_class_md); doctest!("../guide/src/conversions.md", guide_conversions_md); doctest!("../guide/src/debugging.md", guide_debugging_md); doctest!("../guide/src/exception.md", guide_exception_md); doctest!("../guide/src/function.md", guide_function_md); doctest!("../guide/src/get_started.md", guide_get_started_md); doctest!("../guide/src/module.md", guide_module_md); doctest!( "../guide/src/python_from_rust.md", guide_python_from_rust_md ); doctest!("../guide/src/parallelism.md", guide_parallelism_md); doctest!("../guide/src/pypy.md", guide_pypy_md); doctest!("../guide/src/rust_cpython.md", guide_rust_cpython_md); }