Mercurial > public > mercurial-scm > hg
view rust/hg-cpython/src/conversion.rs @ 42752:30320c7bf79f
rust-cpython: add macro for sharing references
Following an experiment done by Georges Racinet, we now have a working way of
sharing references between Python and Rust. This is needed in many points of
the codebase, for example every time we need to expose an iterator to a
Rust-backed Python class.
In a few words, references are (unsafely) marked as `'static` and coupled
with manual reference counting; we are doing manual borrow-checking.
This changes introduces two declarative macro to help reduce boilerplate.
While it is better than not using macros, they are not perfect. They need to:
- Integrate with the garbage collector for container types (not needed
as of yet), as stated in the docstring
- Allow for leaking multiple attributes at the same time
- Inject the `py_shared_state` data attribute in `py_class`-generated
structs
- Automatically namespace the functions and attributes they generate
For at least the last two points, we will need to write a procedural macro
instead of a declarative one.
While this reference-sharing mechanism is being ironed out I thought it best
not to implement it yet.
Lastly, and implementation detail renders our Rust-backed Python iterators too
strict to be proper drop-in replacements, as will be illustrated in a future
patch: if the data structure referenced by a non-depleted iterator is mutated,
an `AlreadyBorrowed` exception is raised, whereas Python would allow it, only
to raise a `RuntimeError` if `next` is called on said iterator. This will have
to be addressed at some point.
Differential Revision: https://phab.mercurial-scm.org/D6631
author | Rapha?l Gom?s <rgomes@octobus.net> |
---|---|
date | Tue, 09 Jul 2019 15:15:54 +0200 |
parents | 060c030c9993 |
children | 33fe96a5c522 |
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, PyDict, PyObject, PyResult, PyTuple, Python, PythonObject, ToPyObject, }; use hg::Revision; use std::collections::HashSet; use std::iter::FromIterator; /// 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>(py: Python, revs: &PyObject) -> PyResult<C> where C: FromIterator<Revision>, { revs.iter(py)? .map(|r| r.and_then(|o| o.extract::<Revision>(py))) .collect() } /// Copy and convert an `HashSet<Revision>` in a Python set /// /// This will probably turn useless once `PySet` support lands in /// `rust-cpython`. /// /// This builds a Python tuple, then calls Python's "set()" on it pub fn py_set(py: Python, set: &HashSet<Revision>) -> PyResult<PyObject> { let as_vec: Vec<PyObject> = set .iter() .map(|rev| rev.to_py_object(py).into_object()) .collect(); let as_pytuple = PyTuple::new(py, as_vec.as_slice()); let locals = PyDict::new(py); locals.set_item(py, "obj", as_pytuple.to_py_object(py))?; py.eval("set(obj)", None, Some(&locals)) }