Skip to content

Commit

Permalink
Add macro append_to_inittab
Browse files Browse the repository at this point in the history
Sometimes we need to debug in a real environment with our module installed. `append_to_inittab` will be a wrapper for PyImport_AppendInittab (https://docs.python.org/3/c-api/import.html#c.PyImport_AppendInittab) and help us to do this
  • Loading branch information
herquan committed May 16, 2022
1 parent 3544b61 commit f9644e0
Show file tree
Hide file tree
Showing 4 changed files with 56 additions and 1 deletion.
1 change: 1 addition & 0 deletions CHANGELOG.md
Expand Up @@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Add `PyDictKeys`, `PyDictValues` and `PyDictItems` Rust types to represent `dict_keys`, `dict_values` and `dict_items` types. [#2358](https://github.com/PyO3/pyo3/pull/2358)
- Add an experimental `generate-import-lib` feature to support auto-generating non-abi3 python import libraries for Windows targets. [#2364](https://github.com/PyO3/pyo3/pull/2364)
- Add FFI definition `Py_ExitStatusException`. [#2374](https://github.com/PyO3/pyo3/pull/2374)
- Add macro `append_to_inittab`. [#2377](https://github.com/PyO3/pyo3/pull/2377)

### Changed

Expand Down
2 changes: 1 addition & 1 deletion pyo3-ffi/src/import.rs
Expand Up @@ -76,6 +76,6 @@ extern "C" {

pub fn PyImport_AppendInittab(
name: *const c_char,
initfunc: Option<extern "C" fn() -> *mut PyObject>,
initfunc: Option<unsafe extern "C" fn() -> *mut PyObject>,
) -> c_int;
}
22 changes: 22 additions & 0 deletions src/macros.rs
Expand Up @@ -150,3 +150,25 @@ macro_rules! wrap_pymodule {
}
};
}

#[cfg(not(PyPy))]
/// Add current module to the existing table of built-in modules.
///
/// Use it before [`prepare_freethreaded_python`](crate::prepare_freethreaded_python) and
/// leave feature `auto-initialize` off
#[macro_export]
macro_rules! append_to_inittab {
($module:ident) => {
unsafe {
assert_eq!(
$crate::ffi::Py_IsInitialized(),
0,
"called `append_to_inittab_impl` but a Python interpreter is already running."
);
$crate::ffi::PyImport_AppendInittab(
concat!(stringify!($module), "\0").as_ptr() as *const std::os::raw::c_char,
Option::Some($module::init),
);
}
};
}
32 changes: 32 additions & 0 deletions tests/test_append_to_inittab.rs
@@ -0,0 +1,32 @@
#![cfg(feature = "macros")]
use pyo3::prelude::*;

#[pyfunction]
fn foo() -> usize {
123
}

#[pymodule]
fn module_with_functions(_py: Python<'_>, m: &PyModule) -> PyResult<()> {
m.add_function(wrap_pyfunction!(foo, m)?).unwrap();
Ok(())
}

#[cfg(not(PyPy))]
#[test]
fn test_module_append_to_inittab() {
use pyo3::append_to_inittab;
append_to_inittab!(module_with_functions);
Python::with_gil(|py| {
py.run(
r#"
import module_with_functions
assert module_with_functions.foo() == 123
"#,
None,
None,
)
.map_err(|e| e.print(py))
.unwrap();
})
}

0 comments on commit f9644e0

Please sign in to comment.