mercurial-scm/hg-stable: rust/hg-pyo3/src/convert

annotate rust/hg-pyo3/src/convert_cpython.rs @ 52554:64a618048ba8

rust-pyo3: intermediate ProxyIndex extraction Retrieving the `UnsafePyLeaked` without borrowing it will be necessary for the upcoming classes that need to store an inner object derived from it.

author	Georges Racinet <georges.racinet@cloudcrane.io>
date	Sat, 07 Dec 2024 18:05:47 +0100
parents	233707101dae
children	1dd673c1ab3b

rev	line source
52442 c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	1 //! This module takes care of all conversions involving `rusthg` (hg-cpython)
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	2 //! objects in the PyO3 call context.
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	3 //!
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	4 //! For source code clarity, we only import (`use`) [`cpython`] traits and not
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	5 //! any of its data objects. We are instead using full qualifiers, such as
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	6 //! `cpython::PyObject`, and believe that the added heaviness is an acceptatble
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	7 //! price to pay to avoid confusion.
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	8 //!
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	9 //! Also it, is customary in [`cpython`] to label the GIL lifetime as `'p`,
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	10 //! whereas it is `'py` in PyO3 context. We keep both these conventions in
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	11 //! the arguments side of function signatures when they are not simply elided.
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	12 use pyo3::exceptions::PyTypeError;
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	13 use pyo3::prelude::*;
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	14
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	15 use cpython::ObjectProtocol;
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	16 use cpython::PythonObject;
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	17 use lazy_static::lazy_static;
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	18
52445 233707101dae rust-pyo3: simplified API to get core Index references Georges Racinet <georges.racinet@cloudcrane.io> parents: 52442 diff changeset	19 use hg::revlog::index::Index as CoreIndex;
52442 c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	20 use rusthg::revlog::{InnerRevlog, PySharedIndex};
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	21
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	22 /// Force cpython's GIL handle with the appropriate lifetime
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	23 ///
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	24 /// In `pyo3`, the fact that we have the GIL is expressed by the lifetime of
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	25 /// the incoming [`Bound`] smart pointer. We therefore simply instantiate
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	26 /// the `cpython` handle and coerce its lifetime by the function signature.
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	27 ///
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	28 /// Reacquiring the GIL is also a possible alternative, as the CPython
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	29 /// documentation explicitely states that "recursive calls are allowed"
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	30 /// (we interpret that as saying that acquiring the GIL within a thread that
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	31 /// already has it works) as long as it is properly released
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	32 /// reference:
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	33 /// <https://docs.python.org/3.8/c-api/init.html#c.PyGILState_Ensure>
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	34 pub(crate) fn cpython_handle<'py, T>(
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	35 _bound: &Bound<'py, T>,
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	36 ) -> cpython::Python<'py> {
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	37 // safety: this is safe because the returned object has the 'py lifetime
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	38 unsafe { cpython::Python::assume_gil_acquired() }
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	39 }
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	40
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	41 /// Force PyO3 GIL handle from cpython's.
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	42 ///
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	43 /// Very similar to [`cpython_handle`]
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	44 pub fn pyo3_handle(_py: cpython::Python<'_>) -> Python<'_> {
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	45 // safety: this is safe because the returned object has the same lifetime
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	46 // as the incoming object.
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	47 unsafe { Python::assume_gil_acquired() }
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	48 }
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	49
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	50 /// Convert a PyO3 [`PyObject`] into a [`cpython::PyObject`]
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	51 ///
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	52 /// During this process, the reference count is increased, then decreased.
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	53 /// This means that the GIL (symbolized by the lifetime on the `obj`
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	54 /// argument) is needed.
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	55 ///
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	56 /// We could make something perhaps more handy by simply stealing the
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	57 /// pointer, forgetting the incoming and then implement `From` with "newtype".
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	58 /// It would be worth the effort for a generic cpython-to-pyo3 crate, perhaps
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	59 /// not for the current endeavour.
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	60 pub(crate) fn to_cpython_py_object<'py>(
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	61 obj: &Bound<'py, PyAny>,
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	62 ) -> (cpython::Python<'py>, cpython::PyObject) {
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	63 let py = cpython_handle(obj);
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	64 // public alias of the private cpython::fii::PyObject (!)
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	65 let raw = obj.as_ptr() as *mut python3_sys::PyObject;
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	66 // both pyo3 and rust-cpython will decrement the refcount on drop.
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	67 // If we use from_owned_ptr, that's a segfault.
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	68 (py, unsafe { cpython::PyObject::from_borrowed_ptr(py, raw) })
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	69 }
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	70
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	71 /// Convert a [`cpython::PyObject`] into a PyO3 [`PyObject`]
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	72 ///
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	73 /// During this process, the reference count is increased, then decreased.
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	74 /// This means that the GIL (symbolized by the PyO3 [`Python`] handle is
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	75 /// needed.
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	76 ///
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	77 /// We could make something perhaps more handy by simply stealing the
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	78 /// pointer, forgetting the incoming and then implement `From` with "newtype".
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	79 /// It would be worth the effort for a generic cpython-to-pyo3 crate, perhaps
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	80 /// not for the current endeavour.
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	81 pub(crate) fn from_cpython_py_object(
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	82 py: Python<'_>,
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	83 obj: cpython::PyObject,
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	84 ) -> PyObject {
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	85 let raw = obj.as_ptr() as *mut pyo3::ffi::PyObject;
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	86 unsafe { Py::from_borrowed_ptr(py, raw) }
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	87 }
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	88
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	89 /// Convert [`cpython::PyErr`] into [`pyo3::PyErr`]
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	90 ///
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	91 /// The exception class remains the same as the original exception,
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	92 /// hence if it is also defined in another dylib based on `cpython` crate,
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	93 /// it will need to be converted to be downcasted in this crate.
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	94 pub(crate) fn from_cpython_pyerr(
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	95 py: cpython::Python<'_>,
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	96 mut e: cpython::PyErr,
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	97 ) -> PyErr {
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	98 let pyo3_py = pyo3_handle(py);
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	99 let cpython_exc_obj = e.instance(py);
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	100 let pyo3_exc_obj = from_cpython_py_object(pyo3_py, cpython_exc_obj);
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	101 PyErr::from_value(pyo3_exc_obj.into_bound(pyo3_py))
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	102 }
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	103
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	104 /// Retrieve the PyType for objects from the `mercurial.rustext` crate.
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	105 fn retrieve_cpython_py_type(
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	106 submodule_name: &str,
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	107 type_name: &str,
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	108 ) -> cpython::PyResult<cpython::PyType> {
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	109 let guard = cpython::Python::acquire_gil();
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	110 let py = guard.python();
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	111 let module = py.import(&format!("mercurial.rustext.{submodule_name}"))?;
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	112 module.get(py, type_name)?.extract::<cpython::PyType>(py)
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	113 }
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	114
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	115 lazy_static! {
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	116 static ref INNER_REVLOG_PY_TYPE: cpython::PyType = {
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	117 retrieve_cpython_py_type("revlog", "InnerRevlog")
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	118 .expect("Could not import InnerRevlog in Python")
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	119 };
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	120 }
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	121
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	122 /// Downcast [`InnerRevlog`], with the appropriate Python type checking.
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	123 ///
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	124 /// The PyType object representing the `InnerRevlog` Python class is not the
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	125 /// the same in this dylib as it is in the `mercurial.rustext` module.
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	126 /// This is because the code created with the [`cpython::py_class!`]
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	127 /// macro is itself duplicated in both dylibs. In the case of this crate, this
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	128 /// happens by linking to the [`rusthg`] crate and provides the `InnerRevlog`
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	129 /// that is visible from this crate. The `InnerRevlog::get_type` associated
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	130 /// function turns out to return a `static mut` (look for `TYPE_OBJECT` in
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	131 /// `py_class_impl3.rs`), which obviously is different in both dylibs.
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	132 ///
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	133 /// The consequence of that is that downcasting an `InnerRevlog` originally
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	134 /// from the `mecurial.rustext` module to our `InnerRevlog` cannot be done with
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	135 /// the usual `extract::<InnerRevlog>(py)`, as it would perform the type
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	136 /// checking with the `PyType` that is embedded in `mercurial.pyo3_rustext`.
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	137 /// We must check the `PyType` that is within `mercurial.rustext` instead.
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	138 /// This is what this function does.
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	139 fn extract_inner_revlog(
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	140 py: cpython::Python,
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	141 inner_revlog: cpython::PyObject,
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	142 ) -> PyResult<InnerRevlog> {
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	143 if !(*INNER_REVLOG_PY_TYPE).is_instance(py, &inner_revlog) {
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	144 return Err(PyTypeError::new_err("Not an InnerRevlog instance"));
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	145 }
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	146 // Safety: this is safe because we checked the PyType already, with the
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	147 // value embedded in `mercurial.rustext`.
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	148 Ok(unsafe { InnerRevlog::unchecked_downcast_from(inner_revlog) })
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	149 }
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	150
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	151 /// This is similar to [`rusthg.py_rust_index_to_graph`], with difference in
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	152 /// how we retrieve the [`InnerRevlog`].
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	153 pub fn py_rust_index_to_graph(
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	154 py: cpython::Python,
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	155 index_proxy: cpython::PyObject,
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	156 ) -> PyResult<cpython::UnsafePyLeaked<PySharedIndex>> {
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	157 let inner_revlog = extract_inner_revlog(
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	158 py,
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	159 index_proxy
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	160 .getattr(py, "inner")
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	161 .map_err(\|e\| from_cpython_pyerr(py, e))?,
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	162 )?;
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	163
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	164 let leaked = inner_revlog.pub_inner(py).leak_immutable();
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	165 // Safety: we don't leak the "faked" reference out of the `UnsafePyLeaked`
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	166 Ok(unsafe { leaked.map(py, \|idx\| PySharedIndex { inner: &idx.index }) })
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	167 }
c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	168
52554 64a618048ba8 rust-pyo3: intermediate ProxyIndex extraction Georges Racinet <georges.racinet@cloudcrane.io> parents: 52445 diff changeset	169 pub(crate) fn proxy_index_py_leak<'py>(
64a618048ba8 rust-pyo3: intermediate ProxyIndex extraction Georges Racinet <georges.racinet@cloudcrane.io> parents: 52445 diff changeset	170 index_proxy: &Bound<'py, PyAny>,
64a618048ba8 rust-pyo3: intermediate ProxyIndex extraction Georges Racinet <georges.racinet@cloudcrane.io> parents: 52445 diff changeset	171 ) -> PyResult<(cpython::Python<'py>, cpython::UnsafePyLeaked<PySharedIndex>)> {
64a618048ba8 rust-pyo3: intermediate ProxyIndex extraction Georges Racinet <georges.racinet@cloudcrane.io> parents: 52445 diff changeset	172 let (py, idx_proxy) = to_cpython_py_object(index_proxy);
64a618048ba8 rust-pyo3: intermediate ProxyIndex extraction Georges Racinet <georges.racinet@cloudcrane.io> parents: 52445 diff changeset	173 let py_leaked = py_rust_index_to_graph(py, idx_proxy)?;
64a618048ba8 rust-pyo3: intermediate ProxyIndex extraction Georges Racinet <georges.racinet@cloudcrane.io> parents: 52445 diff changeset	174 Ok((py, py_leaked))
64a618048ba8 rust-pyo3: intermediate ProxyIndex extraction Georges Racinet <georges.racinet@cloudcrane.io> parents: 52445 diff changeset	175 }
64a618048ba8 rust-pyo3: intermediate ProxyIndex extraction Georges Racinet <georges.racinet@cloudcrane.io> parents: 52445 diff changeset	176
52445 233707101dae rust-pyo3: simplified API to get core Index references Georges Racinet <georges.racinet@cloudcrane.io> parents: 52442 diff changeset	177 /// Full extraction of the proxy index object as received in PyO3 to a
233707101dae rust-pyo3: simplified API to get core Index references Georges Racinet <georges.racinet@cloudcrane.io> parents: 52442 diff changeset	178 /// [`CoreIndex`] reference.
233707101dae rust-pyo3: simplified API to get core Index references Georges Racinet <georges.racinet@cloudcrane.io> parents: 52442 diff changeset	179 ///
52554 64a618048ba8 rust-pyo3: intermediate ProxyIndex extraction Georges Racinet <georges.racinet@cloudcrane.io> parents: 52445 diff changeset	180 /// # Safety
64a618048ba8 rust-pyo3: intermediate ProxyIndex extraction Georges Racinet <georges.racinet@cloudcrane.io> parents: 52445 diff changeset	181 ///
64a618048ba8 rust-pyo3: intermediate ProxyIndex extraction Georges Racinet <georges.racinet@cloudcrane.io> parents: 52445 diff changeset	182 /// The invariants to maintain are those of the underlying
52445 233707101dae rust-pyo3: simplified API to get core Index references Georges Racinet <georges.racinet@cloudcrane.io> parents: 52442 diff changeset	183 /// [`UnsafePyLeaked::try_borrow`]: the caller must not leak the inner
233707101dae rust-pyo3: simplified API to get core Index references Georges Racinet <georges.racinet@cloudcrane.io> parents: 52442 diff changeset	184 /// reference.
233707101dae rust-pyo3: simplified API to get core Index references Georges Racinet <georges.racinet@cloudcrane.io> parents: 52442 diff changeset	185 pub(crate) unsafe fn proxy_index_extract<'py>(
52442 c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	186 index_proxy: &Bound<'py, PyAny>,
52445 233707101dae rust-pyo3: simplified API to get core Index references Georges Racinet <georges.racinet@cloudcrane.io> parents: 52442 diff changeset	187 ) -> PyResult<&'py CoreIndex> {
52554 64a618048ba8 rust-pyo3: intermediate ProxyIndex extraction Georges Racinet <georges.racinet@cloudcrane.io> parents: 52445 diff changeset	188 let (py, py_leaked) = proxy_index_py_leak(index_proxy)?;
52445 233707101dae rust-pyo3: simplified API to get core Index references Georges Racinet <georges.racinet@cloudcrane.io> parents: 52442 diff changeset	189 let py_shared = &*unsafe {
233707101dae rust-pyo3: simplified API to get core Index references Georges Racinet <georges.racinet@cloudcrane.io> parents: 52442 diff changeset	190 py_leaked
233707101dae rust-pyo3: simplified API to get core Index references Georges Racinet <georges.racinet@cloudcrane.io> parents: 52442 diff changeset	191 .try_borrow(py)
233707101dae rust-pyo3: simplified API to get core Index references Georges Racinet <georges.racinet@cloudcrane.io> parents: 52442 diff changeset	192 .map_err(\|e\| from_cpython_pyerr(py, e))?
233707101dae rust-pyo3: simplified API to get core Index references Georges Racinet <georges.racinet@cloudcrane.io> parents: 52442 diff changeset	193 };
233707101dae rust-pyo3: simplified API to get core Index references Georges Racinet <georges.racinet@cloudcrane.io> parents: 52442 diff changeset	194 Ok(py_shared.inner)
52442 c2480ac4c5e2 rust-pyo3: retrieving the InnerRevlog of hg-cpython Georges Racinet <georges.racinet@cloudcrane.io> parents: diff changeset	195 }

Mercurial > public > mercurial-scm > hg-stable

annotate rust/hg-pyo3/src/convert_cpython.rs @ 52554:64a618048ba8