Mercurial > public > mercurial-scm > hg
view rust/hg-cpython/src/conversion.rs @ 52411:c2480ac4c5e2
rust-pyo3: retrieving the InnerRevlog of hg-cpython
This allows PyO3-based code to use the InnerRevlog, access its shared data
(core InnerRevlog), which will then allow, e.g., to retrieve references on
the core Index.
On the `hg-cpython` (`rusthg` crate, `rustext` Python extension module),
we had to also build as a Rust library, and open up some accesses (see
notably the public accessor for `inner`, the core `InnerRevlog`).
Retrieving the Rust struct underlying a Python object defined by another
extension module written in Rust is tricky because the Python type objects
are duplicated in the extension modules, leading to failure of the normal
type checking. See the doc-comment of `convert_cpython::extract_inner_revlog`
for a complete explanation.
To solve this, we import the Python type object of `rustext` (defined
by `hg-cpython`) and perform a manual check. Checking the Python type is
necessary, as PyO3 documentation clearly state that downcasting an object
that has not the proper type is Undefined Behaviour.
At this point, we do not have conversion facilities for exceptions (`PyErr`
on both sides), hence the remaining unwraps).
author | Georges Racinet <georges.racinet@cloudcrane.io> |
---|---|
date | Sat, 30 Nov 2024 20:57:02 +0100 |
parents | bd8081e9fd62 |
children |
line wrap: on
line source
// conversion.rs // // Copyright 2019 Georges Racinet <georges.racinet@octobus.net> // // This software may be used and distributed according to the terms of the // GNU General Public License version 2 or any later version. //! Bindings for the hg::ancestors module provided by the //! `hg-core` crate. From Python, this will be seen as `rustext.ancestor` use cpython::{ObjectProtocol, PyErr, PyObject, PyResult, Python}; use hg::{revlog::RevlogIndex, Revision, UncheckedRevision}; use crate::{exceptions::GraphError, PyRevision}; /// Utility function to convert a Python iterable into various collections /// /// We need this in particular to feed to various methods of inner objects /// with `impl IntoIterator<Item=Revision>` arguments, because /// a `PyErr` can arise at each step of iteration, whereas these methods /// expect iterables over `Revision`, not over some `Result<Revision, PyErr>` pub fn rev_pyiter_collect<C, I>( py: Python, revs: &PyObject, index: &I, ) -> PyResult<C> where C: FromIterator<Revision>, I: RevlogIndex, { rev_pyiter_collect_or_else(py, revs, index, |r| { PyErr::new::<GraphError, _>(py, ("InvalidRevision", r.0)) }) } /// Same as [`rev_pyiter_collect`], giving control on returned errors pub fn rev_pyiter_collect_or_else<C, I>( py: Python, revs: &PyObject, index: &I, invalid_rev_error: impl FnOnce(PyRevision) -> PyErr + Copy, ) -> PyResult<C> where C: FromIterator<Revision>, I: RevlogIndex, { revs.iter(py)? .map(|r| { r.and_then(|o| match o.extract::<PyRevision>(py) { Ok(r) => index .check_revision(UncheckedRevision(r.0)) .ok_or_else(|| invalid_rev_error(r)), Err(e) => Err(e), }) }) .collect() }