Tested under feature powerset to ensure all docs/tests work under any set of features

Author: Andrew J Westlake

pytests/tokio_asyncio/mod.rs

@@ -203,8 +203,8 @@ fn test_mod(_py: Python, m: &PyModule) -> PyResult<()> {
     #![allow(deprecated)]
     #[pyfn(m, "sleep")]
     fn sleep(py: Python) -> PyResult<&PyAny> {
-        pyo3_asyncio::async_std::future_into_py(py, async move {
-            async_std::task::sleep(Duration::from_millis(500)).await;
+        pyo3_asyncio::tokio::future_into_py(py, async move {
+            tokio::time::sleep(Duration::from_millis(500)).await;
             Ok(Python::with_gil(|py| py.None()))
         })
     }

src/lib.rs

@@ -51,8 +51,9 @@
 //! One clear disadvantage to this approach (aside from the verbose naming) is that the Rust application has to explicitly track its references to the Python event loop. In native libraries, we can't make any assumptions about the underlying event loop, so the only reliable way to make sure our conversions work properly is to store a reference to the current event loop at the callsite to use later on.
 //!
 //! ```rust
-//! use pyo3::prelude::*;
+//! use pyo3::{wrap_pyfunction, prelude::*};
 //!
+//! # #[cfg(feature = "tokio-runtime")]
 //! #[pyfunction]
 //! fn sleep(py: Python) -> PyResult<&PyAny> {
 //!     let current_loop = pyo3_asyncio::get_running_loop(py)?;
@@ -76,6 +77,7 @@
 //!     })
 //! }
 //!
+//! # #[cfg(feature = "tokio-runtime")]
 //! #[pymodule]
 //! fn my_mod(py: Python, m: &PyModule) -> PyResult<()> {
 //!     m.add_function(wrap_pyfunction!(sleep, m)?)?;
@@ -101,6 +103,7 @@
 //! ```rust no_run
 //! use pyo3::prelude::*;
 //!
+//! # #[cfg(feature = "tokio-runtime")]
 //! #[pyfunction]
 //! fn sleep(py: Python) -> PyResult<&PyAny> {
 //!     // get the current event loop through task-local data
@@ -126,6 +129,7 @@
 //!     )
 //! }
 //!
+//! # #[cfg(feature = "tokio-runtime")]
 //! #[pyfunction]
 //! fn wrap_sleep(py: Python) -> PyResult<&PyAny> {
 //!     // get the current event loop through task-local data
@@ -152,6 +156,7 @@
 //!     )
 //! }
 //!
+//! # #[cfg(feature = "tokio-runtime")]
 //! #[pymodule]
 //! fn my_mod(py: Python, m: &PyModule) -> PyResult<()> {
 //!     m.add_function(wrap_pyfunction!(sleep, m)?)?;
@@ -174,6 +179,7 @@
 //! ```rust
 //! use pyo3::prelude::*;
 //!
+//! # #[cfg(feature = "tokio-runtime")]
 //! #[pyfunction]
 //! fn sleep(py: Python) -> PyResult<&PyAny> {
 //!     pyo3_asyncio::tokio::future_into_py(py, async move {
@@ -189,6 +195,7 @@
 //!     })
 //! }
 //!
+//! # #[cfg(feature = "tokio-runtime")]
 //! #[pyfunction]
 //! fn wrap_sleep(py: Python) -> PyResult<&PyAny> {
 //!     pyo3_asyncio::tokio::future_into_py(py, async move {
@@ -202,6 +209,7 @@
 //!     })
 //! }
 //!
+//! # #[cfg(feature = "tokio-runtime")]
 //! #[pymodule]
 //! fn my_mod(py: Python, m: &PyModule) -> PyResult<()> {
 //!     m.add_function(wrap_pyfunction!(sleep, m)?)?;
@@ -391,7 +399,7 @@ fn create_future(event_loop: &PyAny) -> PyResult<&PyAny> {
 /// ```
 #[deprecated(
     since = "0.14.0",
-    note = "Use the pyo3_asyncio::async_std::run or pyo3_asyncio::tokio::run instead\n\t\t(see the [migration guide](https://github.com/awestlake87/pyo3-asyncio/#migrating-from-013-to-014) for more details)"
+    note = "Use the pyo3_asyncio::async_std::run or pyo3_asyncio::tokio::run instead\n    (see the [migration guide](https://github.com/awestlake87/pyo3-asyncio/#migrating-from-013-to-014) for more details)"
 )]
 #[allow(deprecated)]
 pub fn with_runtime<F, R>(py: Python, f: F) -> PyResult<R>

src/testing.rs

@@ -30,18 +30,24 @@
 //!
 //! `pytests/test_example.rs` for the `tokio` runtime:
 //! ```rust
+//! # #[cfg(all(feature = "tokio-runtime", feature = "attributes"))]
 //! #[pyo3_asyncio::tokio::main]
 //! async fn main() -> pyo3::PyResult<()> {
 //!     pyo3_asyncio::testing::main().await
 //! }
+//! # #[cfg(not(all(feature = "tokio-runtime", feature = "attributes")))]
+//! # fn main() {}
 //! ```
 //!
 //! `pytests/test_example.rs` for the `async-std` runtime:
 //! ```rust
+//! # #[cfg(all(feature = "async-std-runtime", feature = "attributes"))]
 //! #[pyo3_asyncio::async_std::main]
 //! async fn main() -> pyo3::PyResult<()> {
 //!     pyo3_asyncio::testing::main().await
 //! }
+//! # #[cfg(not(all(feature = "async-std-runtime", feature = "attributes")))]
+//! # fn main() {}
 //! ```
 //!
 //! ## Cargo Configuration
@@ -69,6 +75,7 @@
 //!
 //! For `async-std` use the [`pyo3_asyncio::async_std::test`](https://docs.rs/pyo3-asyncio/latest/pyo3_asyncio/async_std/attr.test.html) attribute:
 //! ```rust
+//! # #[cfg(all(feature = "async-std-runtime", feature = "attributes"))]
 //! mod tests {
 //!     use std::{time::Duration, thread};
 //!
@@ -89,14 +96,18 @@
 //!     }
 //! }
 //!
+//! # #[cfg(all(feature = "async-std-runtime", feature = "attributes"))]
 //! #[pyo3_asyncio::async_std::main]
 //! async fn main() -> pyo3::PyResult<()> {
 //!     pyo3_asyncio::testing::main().await
 //! }
+//! # #[cfg(not(all(feature = "async-std-runtime", feature = "attributes")))]
+//! # fn main() {}
 //! ```
 //!
 //! For `tokio` use the [`pyo3_asyncio::tokio::test`](https://docs.rs/pyo3-asyncio/latest/pyo3_asyncio/tokio/attr.test.html) attribute:
 //! ```rust
+//! # #[cfg(all(feature = "tokio-runtime", feature = "attributes"))]
 //! mod tests {
 //!     use std::{time::Duration, thread};
 //!
@@ -117,10 +128,13 @@
 //!     }
 //! }
 //!
+//! # #[cfg(all(feature = "tokio-runtime", feature = "attributes"))]
 //! #[pyo3_asyncio::tokio::main]
 //! async fn main() -> pyo3::PyResult<()> {
 //!     pyo3_asyncio::testing::main().await
 //! }
+//! # #[cfg(not(all(feature = "tokio-runtime", feature = "attributes")))]
+//! # fn main() {}
 //! ```
 //!
 //! ## Lib Tests