Renamed local_future_into_py, changed return type to &PyAny

Author: Andrew J Westlake

pytests/test_async_std_asyncio.rs

@@ -84,12 +84,12 @@ async fn test_local_coroutine() -> PyResult<()> {
     Python::with_gil(|py| {
         let non_send_secs = Rc::new(1);
 
-        let py_future = pyo3_asyncio::async_std::into_local_py_future(py, async move {
+        let py_future = pyo3_asyncio::async_std::local_future_into_py(py, async move {
             async_std::task::sleep(Duration::from_secs(*non_send_secs)).await;
             Ok(Python::with_gil(|py| py.None()))
         })?;
 
-        pyo3_asyncio::into_future(py_future.as_ref(py))
+        pyo3_asyncio::into_future(py_future)
     })?
     .await?;
 

pytests/tokio_asyncio/mod.rs

@@ -89,12 +89,12 @@ fn test_local_set_coroutine() -> PyResult<()> {
         Python::with_gil(|py| {
             let non_send_secs = Rc::new(1);
 
-            let py_future = pyo3_asyncio::tokio::into_local_py_future(py, async move {
+            let py_future = pyo3_asyncio::tokio::local_future_into_py(py, async move {
                 tokio::time::sleep(Duration::from_secs(*non_send_secs)).await;
                 Ok(Python::with_gil(|py| py.None()))
             })?;
 
-            pyo3_asyncio::into_future(py_future.as_ref(py))
+            pyo3_asyncio::into_future(py_future)
         })?
         .await?;
 

src/async_std.rs

@@ -99,7 +99,7 @@ where
     generic::run_until_complete::<AsyncStdRuntime, _>(py, fut)
 }
 
-/// Convert a Rust Future into a Python coroutine
+/// Convert a Rust Future into a Python awaitable
 ///
 /// # Arguments
 /// * `py` - The current PyO3 GIL guard
@@ -130,7 +130,7 @@ where
     generic::into_coroutine::<AsyncStdRuntime, _>(py, fut)
 }
 
-/// Convert a `!Send` Rust Future into a Python coroutine
+/// Convert a `!Send` Rust Future into a Python awaitable
 ///
 /// # Arguments
 /// * `py` - The current PyO3 GIL guard
@@ -145,11 +145,11 @@ where
 ///
 /// /// Awaitable non-send sleep function
 /// #[pyfunction]
-/// fn sleep_for(py: Python, secs: u64) -> PyResult<PyObject> {
+/// fn sleep_for(py: Python, secs: u64) -> PyResult<&PyAny> {
 ///     // Rc is non-send so it cannot be passed into pyo3_asyncio::tokio::into_coroutine
 ///     let secs = Rc::new(secs);
 ///
-///     pyo3_asyncio::async_std::into_local_py_future(py, async move {
+///     pyo3_asyncio::async_std::local_future_into_py(py, async move {
 ///         async_std::task::sleep(Duration::from_secs(*secs)).await;
 ///         Python::with_gil(|py| Ok(py.None()))
 ///     })
@@ -160,7 +160,7 @@ where
 /// async fn main() -> PyResult<()> {
 ///     Python::with_gil(|py| {
 ///        let py_future = sleep_for(py, 1)?;
-///        pyo3_asyncio::into_future(py_future.as_ref(py))
+///        pyo3_asyncio::into_future(py_future)
 ///     })?
 ///     .await?;
 ///
@@ -169,9 +169,9 @@ where
 /// # #[cfg(not(all(feature = "async-std-runtime", feature = "attributes")))]
 /// # fn main() {}
 /// ```
-pub fn into_local_py_future<F>(py: Python, fut: F) -> PyResult<PyObject>
+pub fn local_future_into_py<F>(py: Python, fut: F) -> PyResult<&PyAny>
 where
     F: Future<Output = PyResult<PyObject>> + 'static,
 {
-    generic::into_local_py_future::<AsyncStdRuntime, _>(py, fut)
+    generic::local_future_into_py::<AsyncStdRuntime, _>(py, fut)
 }

src/generic.rs

@@ -134,7 +134,7 @@ fn set_result(py: Python, future: &PyAny, result: PyResult<PyObject>) -> PyResul
     Ok(())
 }
 
-/// Convert a Rust Future into a Python coroutine with a generic runtime
+/// Convert a Rust Future into a Python awaitable with a generic runtime
 ///
 /// # Arguments
 /// * `py` - The current PyO3 GIL guard
@@ -245,7 +245,7 @@ where
     Ok(future_rx)
 }
 
-/// Convert a `!Send` Rust Future into a Python coroutine with a generic runtime
+/// Convert a `!Send` Rust Future into a Python awaitable with a generic runtime
 ///
 /// # Arguments
 /// * `py` - The current PyO3 GIL guard
@@ -311,23 +311,21 @@ where
 ///
 /// /// Awaitable sleep function
 /// #[pyfunction]
-/// fn sleep_for(py: Python, secs: &PyAny) -> PyResult<PyObject> {
-///     let secs = secs.extract()?;
-///
-///     pyo3_asyncio::generic::into_local_py_future::<MyCustomRuntime, _>(py, async move {
+/// fn sleep_for(py: Python, secs: u64) -> PyResult<&PyAny> {
+///     pyo3_asyncio::generic::local_future_into_py::<MyCustomRuntime, _>(py, async move {
 ///         MyCustomRuntime::sleep(Duration::from_secs(secs)).await;
 ///         Python::with_gil(|py| Ok(py.None()))
 ///    })
 /// }
 /// ```
-pub fn into_local_py_future<R, F>(py: Python, fut: F) -> PyResult<PyObject>
+pub fn local_future_into_py<R, F>(py: Python, fut: F) -> PyResult<&PyAny>
 where
     R: SpawnLocalExt,
     F: Future<Output = PyResult<PyObject>> + 'static,
 {
-    let future_rx = CREATE_FUTURE.get().expect(EXPECT_INIT).call0(py)?;
-    let future_tx1 = future_rx.clone();
-    let future_tx2 = future_rx.clone();
+    let future_rx = CREATE_FUTURE.get().expect(EXPECT_INIT).as_ref(py).call0()?;
+    let future_tx1 = PyObject::from(future_rx);
+    let future_tx2 = future_tx1.clone();
 
     R::spawn_local(async move {
         if let Err(e) = R::spawn_local(async move {

src/lib.rs

@@ -45,7 +45,7 @@
 //!
 //! ```toml
 //! [dependencies.pyo3-asyncio]
-//! version = "0.13.0"
+//! version = "0.13"
 //! features = ["attributes"]
 //! ```
 //!
@@ -58,7 +58,7 @@
 //!
 //! ```toml
 //! [dependencies.pyo3-asyncio]
-//! version = "0.13.0"
+//! version = "0.13"
 //! features = ["async-std-runtime"]
 //! ```
 //!
@@ -71,7 +71,7 @@
 //!
 //! ```toml
 //! [dependencies.pyo3-asyncio]
-//! version = "0.13.0"
+//! version = "0.13"
 //! features = ["tokio-runtime"]
 //! ```
 //!
@@ -84,7 +84,7 @@
 //!
 //! ```toml
 //! [dependencies.pyo3-asyncio]
-//! version = "0.13.0"
+//! version = "0.13"
 //! features = ["testing"]
 //! ```
 

src/tokio.rs

@@ -186,7 +186,7 @@ where
     generic::run_until_complete::<TokioRuntime, _>(py, fut)
 }
 
-/// Convert a Rust Future into a Python coroutine
+/// Convert a Rust Future into a Python awaitable
 ///
 /// # Arguments
 /// * `py` - The current PyO3 GIL guard
@@ -217,7 +217,7 @@ where
     generic::into_coroutine::<TokioRuntime, _>(py, fut)
 }
 
-/// Convert a `!Send` Rust Future into a Python coroutine
+/// Convert a `!Send` Rust Future into a Python awaitable
 ///
 /// # Arguments
 /// * `py` - The current PyO3 GIL guard
@@ -232,11 +232,11 @@ where
 ///
 /// /// Awaitable non-send sleep function
 /// #[pyfunction]
-/// fn sleep_for(py: Python, secs: u64) -> PyResult<PyObject> {
+/// fn sleep_for(py: Python, secs: u64) -> PyResult<&PyAny> {
 ///     // Rc is non-send so it cannot be passed into pyo3_asyncio::tokio::into_coroutine
 ///     let secs = Rc::new(secs);
 ///
-///     pyo3_asyncio::tokio::into_local_py_future(py, async move {
+///     pyo3_asyncio::tokio::local_future_into_py(py, async move {
 ///         tokio::time::sleep(Duration::from_secs(*secs)).await;
 ///         Python::with_gil(|py| Ok(py.None()))
 ///     })
@@ -249,11 +249,11 @@ where
 ///     // we use spawn_blocking in order to use LocalSet::block_on
 ///     tokio::task::spawn_blocking(|| {
 ///         // LocalSet allows us to work with !Send futures within tokio. Without it, any calls to
-///         // pyo3_asyncio::tokio::into_local_py_future will panic.
+///         // pyo3_asyncio::tokio::local_future_into_py will panic.
 ///         tokio::task::LocalSet::new().block_on(pyo3_asyncio::tokio::get_runtime(), async {
 ///             Python::with_gil(|py| {
 ///                let py_future = sleep_for(py, 1)?;
-///                pyo3_asyncio::into_future(py_future.as_ref(py))
+///                pyo3_asyncio::into_future(py_future)
 ///             })?
 ///             .await?;
 ///
@@ -264,9 +264,9 @@ where
 /// # #[cfg(not(all(feature = "tokio-runtime", feature = "attributes")))]
 /// # fn main() {}
 /// ```
-pub fn into_local_py_future<F>(py: Python, fut: F) -> PyResult<PyObject>
+pub fn local_future_into_py<'p, F>(py: Python<'p>, fut: F) -> PyResult<&'p PyAny>
 where
     F: Future<Output = PyResult<PyObject>> + 'static,
 {
-    generic::into_local_py_future::<TokioRuntime, _>(py, fut)
+    generic::local_future_into_py::<TokioRuntime, _>(py, fut)
 }