Merged invalid-state-fix changes

Author: Andrew J Westlake

pytests/test_async_std_asyncio.rs

@@ -3,7 +3,7 @@ mod common;
 use std::{rc::Rc, time::Duration};
 
 use async_std::task;
-use pyo3::{prelude::*, wrap_pyfunction};
+use pyo3::{prelude::*, types::PyType, wrap_pyfunction};
 
 #[pyfunction]
 #[allow(deprecated)]
@@ -157,6 +157,38 @@ async fn test_local_future_into_py() -> PyResult<()> {
     Ok(())
 }
 
+#[pyo3_asyncio::async_std::test]
+async fn test_cancel() -> PyResult<()> {
+    let py_future = Python::with_gil(|py| -> PyResult<PyObject> {
+        Ok(pyo3_asyncio::async_std::future_into_py(py, async {
+            async_std::task::sleep(Duration::from_secs(1)).await;
+            Ok(Python::with_gil(|py| py.None()))
+        })?
+        .into())
+    })?;
+
+    if let Err(e) = Python::with_gil(|py| -> PyResult<_> {
+        py_future.as_ref(py).call_method0("cancel")?;
+        pyo3_asyncio::async_std::into_future(py_future.as_ref(py))
+    })?
+    .await
+    {
+        Python::with_gil(|py| -> PyResult<()> {
+            assert!(py
+                .import("asyncio.exceptions")?
+                .getattr("CancelledError")?
+                .downcast::<PyType>()
+                .unwrap()
+                .is_instance(e.pvalue(py))?);
+            Ok(())
+        })?;
+    } else {
+        panic!("expected CancelledError");
+    }
+
+    Ok(())
+}
+
 #[allow(deprecated)]
 fn main() -> pyo3::PyResult<()> {
     pyo3::prepare_freethreaded_python();

pytests/tokio_asyncio/mod.rs

@@ -1,6 +1,6 @@
 use std::{rc::Rc, time::Duration};
 
-use pyo3::{prelude::*, wrap_pyfunction};
+use pyo3::{prelude::*, types::PyType, wrap_pyfunction};
 
 use crate::common;
 
@@ -166,3 +166,35 @@ async fn test_panic() -> PyResult<()> {
         }),
     }
 }
+
+#[pyo3_asyncio::tokio::test]
+async fn test_cancel() -> PyResult<()> {
+    let py_future = Python::with_gil(|py| -> PyResult<PyObject> {
+        Ok(pyo3_asyncio::tokio::future_into_py(py, async {
+            tokio::time::sleep(Duration::from_secs(1)).await;
+            Ok(Python::with_gil(|py| py.None()))
+        })?
+        .into())
+    })?;
+
+    if let Err(e) = Python::with_gil(|py| -> PyResult<_> {
+        py_future.as_ref(py).call_method0("cancel")?;
+        pyo3_asyncio::tokio::into_future(py_future.as_ref(py))
+    })?
+    .await
+    {
+        Python::with_gil(|py| -> PyResult<()> {
+            assert!(py
+                .import("asyncio.exceptions")?
+                .getattr("CancelledError")?
+                .downcast::<PyType>()
+                .unwrap()
+                .is_instance(e.pvalue(py))?);
+            Ok(())
+        })?;
+    } else {
+        panic!("expected CancelledError");
+    }
+
+    Ok(())
+}

src/generic.rs

@@ -244,6 +244,10 @@ where
     result
 }
 
+fn cancelled(future: &PyAny) -> PyResult<bool> {
+    future.getattr("cancelled")?.call0()?.is_true()
+}
+
 fn set_result(event_loop: &PyAny, future: &PyAny, result: PyResult<PyObject>) -> PyResult<()> {
     match result {
         Ok(val) => {
@@ -461,29 +465,34 @@ where
             let result = R::scope(event_loop2.clone(), fut).await;
 
             Python::with_gil(move |py| {
-                if set_result(event_loop2.as_ref(py), future_tx1.as_ref(py), result)
+                if cancelled(future_tx1.as_ref(py))
                     .map_err(dump_err(py))
-                    .is_err()
+                    .unwrap_or(false)
                 {
-
-                    // Cancelled
+                    return;
                 }
+
+                let _ = set_result(event_loop2.as_ref(py), future_tx1.as_ref(py), result)
+                    .map_err(dump_err(py));
             });
         })
         .await
         {
             if e.is_panic() {
                 Python::with_gil(move |py| {
-                    if set_result(
+                    if cancelled(future_tx2.as_ref(py))
+                        .map_err(dump_err(py))
+                        .unwrap_or(false)
+                    {
+                        return;
+                    }
+
+                    let _ = set_result(
                         event_loop.as_ref(py),
                         future_tx2.as_ref(py),
                         Err(RustPanic::new_err("rust future panicked")),
                     )
-                    .map_err(dump_err(py))
-                    .is_err()
-                    {
-                        // Cancelled
-                    }
+                    .map_err(dump_err(py));
                 });
             }
         }
@@ -777,28 +786,34 @@ where
             let result = R::scope_local(event_loop2.clone(), fut).await;
 
             Python::with_gil(move |py| {
-                if set_result(event_loop2.as_ref(py), future_tx1.as_ref(py), result)
+                if cancelled(future_tx1.as_ref(py))
                     .map_err(dump_err(py))
-                    .is_err()
+                    .unwrap_or(false)
                 {
-                    // Cancelled
+                    return;
                 }
+
+                let _ = set_result(event_loop2.as_ref(py), future_tx1.as_ref(py), result)
+                    .map_err(dump_err(py));
             });
         })
         .await
         {
             if e.is_panic() {
                 Python::with_gil(move |py| {
-                    if set_result(
+                    if cancelled(future_tx2.as_ref(py))
+                        .map_err(dump_err(py))
+                        .unwrap_or(false)
+                    {
+                        return;
+                    }
+
+                    let _ = set_result(
                         event_loop.as_ref(py),
                         future_tx2.as_ref(py),
                         Err(RustPanic::new_err("Rust future panicked")),
                     )
-                    .map_err(dump_err(py))
-                    .is_err()
-                    {
-                        // Cancelled
-                    }
+                    .map_err(dump_err(py));
                 });
             }
         }

src/lib.rs

@@ -90,17 +90,14 @@
 
 /// <span class="module-item stab portability" style="display: inline; border-radius: 3px; padding: 2px; font-size: 80%; line-height: 1.2;"><code>testing</code></span> Utilities for writing PyO3 Asyncio tests
 #[cfg(feature = "testing")]
-#[doc(inline)]
 pub mod testing;
 
 /// <span class="module-item stab portability" style="display: inline; border-radius: 3px; padding: 2px; font-size: 80%; line-height: 1.2;"><code>async-std-runtime</code></span> PyO3 Asyncio functions specific to the async-std runtime
 #[cfg(feature = "async-std")]
-#[doc(inline)]
 pub mod async_std;
 
 /// <span class="module-item stab portability" style="display: inline; border-radius: 3px; padding: 2px; font-size: 80%; line-height: 1.2;"><code>tokio-runtime</code></span> PyO3 Asyncio functions specific to the tokio runtime
 #[cfg(feature = "tokio-runtime")]
-#[doc(inline)]
 pub mod tokio;
 
 /// Errors and exceptions related to PyO3 Asyncio