1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
use std::{any::Any, cell::RefCell, future::Future, panic::AssertUnwindSafe, pin::Pin}; use async_std::task; use futures::prelude::*; use pyo3::prelude::*; use crate::generic::{self, JoinError, Runtime, SpawnLocalExt}; /// <span class="module-item stab portability" style="display: inline; border-radius: 3px; padding: 2px; font-size: 80%; line-height: 1.2;"><code>attributes</code></span> /// re-exports for macros #[cfg(feature = "attributes")] pub mod re_exports { /// re-export spawn_blocking for use in `#[test]` macro without external dependency pub use async_std::task::spawn_blocking; } /// <span class="module-item stab portability" style="display: inline; border-radius: 3px; padding: 2px; font-size: 80%; line-height: 1.2;"><code>attributes</code></span> Provides the boilerplate for the `async-std` runtime and runs an async fn as main #[cfg(feature = "attributes")] pub use pyo3_asyncio_macros::async_std_main as main; /// <span class="module-item stab portability" style="display: inline; border-radius: 3px; padding: 2px; font-size: 80%; line-height: 1.2;"><code>attributes</code></span> /// <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> /// Registers an `async-std` test with the `pyo3-asyncio` test harness #[cfg(all(feature = "attributes", feature = "testing"))] pub use pyo3_asyncio_macros::async_std_test as test; struct AsyncStdJoinErr(Box<dyn Any + Send + 'static>); impl JoinError for AsyncStdJoinErr { fn is_panic(&self) -> bool { true } } async_std::task_local! { static EVENT_LOOP: RefCell<Option<PyObject>> = RefCell::new(None); } struct AsyncStdRuntime; impl Runtime for AsyncStdRuntime { type JoinError = AsyncStdJoinErr; type JoinHandle = task::JoinHandle<Result<(), AsyncStdJoinErr>>; fn scope<F, R>(event_loop: PyObject, fut: F) -> Pin<Box<dyn Future<Output = R> + Send>> where F: Future<Output = R> + Send + 'static, { let old = EVENT_LOOP.with(|c| c.replace(Some(event_loop))); Box::pin(async move { let result = fut.await; EVENT_LOOP.with(|c| c.replace(old)); result }) } fn get_task_event_loop(py: Python) -> Option<&PyAny> { match EVENT_LOOP.try_with(|c| { c.borrow() .as_ref() .map(|event_loop| event_loop.clone().into_ref(py)) }) { Ok(event_loop) => event_loop, Err(_) => None, } } fn spawn<F>(fut: F) -> Self::JoinHandle where F: Future<Output = ()> + Send + 'static, { task::spawn(async move { AssertUnwindSafe(fut) .catch_unwind() .await .map_err(|e| AsyncStdJoinErr(e)) }) } } impl SpawnLocalExt for AsyncStdRuntime { fn scope_local<F, R>(event_loop: PyObject, fut: F) -> Pin<Box<dyn Future<Output = R>>> where F: Future<Output = R> + 'static, { let old = EVENT_LOOP.with(|c| c.replace(Some(event_loop))); Box::pin(async move { let result = fut.await; EVENT_LOOP.with(|c| c.replace(old)); result }) } fn spawn_local<F>(fut: F) -> Self::JoinHandle where F: Future<Output = ()> + 'static, { task::spawn_local(async move { fut.await; Ok(()) }) } } /// Set the task local event loop for the given future pub async fn scope<F, R>(event_loop: PyObject, fut: F) -> R where F: Future<Output = R> + Send + 'static, { AsyncStdRuntime::scope(event_loop, fut).await } /// Set the task local event loop for the given !Send future pub async fn scope_local<F, R>(event_loop: PyObject, fut: F) -> R where F: Future<Output = R> + 'static, { AsyncStdRuntime::scope_local(event_loop, fut).await } /// Get the current event loop from either Python or Rust async task local context /// /// This function first checks if the runtime has a task-local reference to the Python event loop. /// If not, it calls [`get_running_loop`](`crate::get_running_loop`) to get the event loop /// associated with the current OS thread. pub fn get_current_loop(py: Python) -> PyResult<&PyAny> { generic::get_current_loop::<AsyncStdRuntime>(py) } /// Run the event loop until the given Future completes /// /// The event loop runs until the given future is complete. /// /// After this function returns, the event loop can be resumed with either [`run_until_complete`] or /// [`run_forever`](`crate::run_forever`) /// /// # Arguments /// * `event_loop` - The Python event loop that should run the future /// * `fut` - The future to drive to completion /// /// # Examples /// /// ``` /// # use std::time::Duration; /// # /// # use pyo3::prelude::*; /// # /// # pyo3::prepare_freethreaded_python(); /// # /// # Python::with_gil(|py| { /// # pyo3_asyncio::with_runtime(py, || { /// # let event_loop = py.import("asyncio")?.call_method0("new_event_loop")?; /// pyo3_asyncio::async_std::run_until_complete(event_loop, async move { /// async_std::task::sleep(Duration::from_secs(1)).await; /// Ok(()) /// })?; /// # Ok(()) /// # }) /// # .map_err(|e| { /// # e.print_and_set_sys_last_vars(py); /// # }) /// # .unwrap(); /// # }); /// ``` pub fn run_until_complete<F>(event_loop: &PyAny, fut: F) -> PyResult<()> where F: Future<Output = PyResult<()>> + Send + 'static, { generic::run_until_complete::<AsyncStdRuntime, _>(event_loop, fut) } /// Run the event loop until the given Future completes /// /// # Arguments /// * `py` - The current PyO3 GIL guard /// * `fut` - The future to drive to completion /// /// # Examples /// /// ```no_run /// # use std::time::Duration; /// # /// # use pyo3::prelude::*; /// # /// fn main() { /// // call this or use pyo3 0.14 "auto-initialize" feature /// pyo3::prepare_freethreaded_python(); /// /// Python::with_gil(|py| { /// pyo3_asyncio::async_std::run(py, async move { /// async_std::task::sleep(Duration::from_secs(1)).await; /// Ok(()) /// }) /// .map_err(|e| { /// e.print_and_set_sys_last_vars(py); /// }) /// .unwrap(); /// }) /// } /// ``` pub fn run<F>(py: Python, fut: F) -> PyResult<()> where F: Future<Output = PyResult<()>> + Send + 'static, { generic::run::<AsyncStdRuntime, F>(py, fut) } /// Convert a Rust Future into a Python awaitable /// /// # Arguments /// * `py` - The current PyO3 GIL guard /// * `fut` - The Rust future to be converted /// /// # Examples /// /// ``` /// use std::time::Duration; /// /// use pyo3::prelude::*; /// /// /// Awaitable sleep function /// #[pyfunction] /// fn sleep_for(py: Python, secs: &PyAny) -> PyResult<PyObject> { /// let secs = secs.extract()?; /// /// pyo3_asyncio::async_std::into_coroutine(py, async move { /// async_std::task::sleep(Duration::from_secs(secs)).await; /// Python::with_gil(|py| Ok(py.None())) /// }) /// } /// ``` #[deprecated( since = "0.14.0", note = "Use the pyo3_asyncio::async_std::future_into_py instead\n (see the [migration guide](https://github.com/awestlake87/pyo3-asyncio/#migrating-from-013-to-014) for more details)" )] #[allow(deprecated)] pub fn into_coroutine<F>(py: Python, fut: F) -> PyResult<PyObject> where F: Future<Output = PyResult<PyObject>> + Send + 'static, { generic::into_coroutine::<AsyncStdRuntime, _>(py, fut) } /// Convert a Rust Future into a Python awaitable /// /// # Arguments /// * `event_loop` - The Python event loop that the awaitable should be attached to /// * `fut` - The Rust future to be converted /// /// # Examples /// /// ``` /// use std::time::Duration; /// /// use pyo3::prelude::*; /// /// /// Awaitable sleep function /// #[pyfunction] /// fn sleep_for<'p>(py: Python<'p>, secs: &'p PyAny) -> PyResult<&'p PyAny> { /// let secs = secs.extract()?; /// pyo3_asyncio::async_std::future_into_py_with_loop( /// pyo3_asyncio::async_std::get_current_loop(py)?, /// async move { /// async_std::task::sleep(Duration::from_secs(secs)).await; /// Python::with_gil(|py| Ok(py.None())) /// } /// ) /// } /// ``` pub fn future_into_py_with_loop<F>(event_loop: &PyAny, fut: F) -> PyResult<&PyAny> where F: Future<Output = PyResult<PyObject>> + Send + 'static, { generic::future_into_py_with_loop::<AsyncStdRuntime, F>(event_loop, fut) } /// Convert a Rust Future into a Python awaitable /// /// # Arguments /// * `py` - The current PyO3 GIL guard /// * `fut` - The Rust future to be converted /// /// # Examples /// /// ``` /// use std::time::Duration; /// /// use pyo3::prelude::*; /// /// /// Awaitable sleep function /// #[pyfunction] /// fn sleep_for<'p>(py: Python<'p>, secs: &'p PyAny) -> PyResult<&'p PyAny> { /// let secs = secs.extract()?; /// pyo3_asyncio::async_std::future_into_py(py, async move { /// async_std::task::sleep(Duration::from_secs(secs)).await; /// Python::with_gil(|py| Ok(py.None())) /// }) /// } /// ``` pub fn future_into_py<F>(py: Python, fut: F) -> PyResult<&PyAny> where F: Future<Output = PyResult<PyObject>> + Send + 'static, { generic::future_into_py::<AsyncStdRuntime, _>(py, fut) } /// Convert a `!Send` Rust Future into a Python awaitable /// /// # Arguments /// * `event_loop` - The Python event loop that the awaitable should be attached to /// * `fut` - The Rust future to be converted /// /// # Examples /// /// ``` /// use std::{rc::Rc, time::Duration}; /// /// use pyo3::prelude::*; /// /// /// Awaitable non-send sleep function /// #[pyfunction] /// fn sleep_for(py: Python, secs: u64) -> PyResult<&PyAny> { /// // Rc is non-send so it cannot be passed into pyo3_asyncio::async_std::future_into_py /// let secs = Rc::new(secs); /// Ok(pyo3_asyncio::async_std::local_future_into_py_with_loop( /// pyo3_asyncio::async_std::get_current_loop(py)?, /// async move { /// async_std::task::sleep(Duration::from_secs(*secs)).await; /// Python::with_gil(|py| Ok(py.None())) /// } /// )?.into()) /// } /// /// # #[cfg(all(feature = "async-std-runtime", feature = "attributes"))] /// #[pyo3_asyncio::async_std::main] /// async fn main() -> PyResult<()> { /// Python::with_gil(|py| { /// let py_future = sleep_for(py, 1)?; /// pyo3_asyncio::async_std::into_future(py_future) /// })? /// .await?; /// /// Ok(()) /// } /// # #[cfg(not(all(feature = "async-std-runtime", feature = "attributes")))] /// # fn main() {} /// ``` pub fn local_future_into_py_with_loop<F>(event_loop: &PyAny, fut: F) -> PyResult<&PyAny> where F: Future<Output = PyResult<PyObject>> + 'static, { generic::local_future_into_py_with_loop::<AsyncStdRuntime, _>(event_loop, fut) } /// Convert a `!Send` Rust Future into a Python awaitable /// /// # Arguments /// * `py` - The current PyO3 GIL guard /// * `fut` - The Rust future to be converted /// /// # Examples /// /// ``` /// use std::{rc::Rc, time::Duration}; /// /// use pyo3::prelude::*; /// /// /// Awaitable non-send sleep function /// #[pyfunction] /// fn sleep_for(py: Python, secs: u64) -> PyResult<&PyAny> { /// // Rc is non-send so it cannot be passed into pyo3_asyncio::async_std::future_into_py /// let secs = Rc::new(secs); /// 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())) /// }) /// } /// /// # #[cfg(all(feature = "async-std-runtime", feature = "attributes"))] /// #[pyo3_asyncio::async_std::main] /// async fn main() -> PyResult<()> { /// Python::with_gil(|py| { /// let py_future = sleep_for(py, 1)?; /// pyo3_asyncio::async_std::into_future(py_future) /// })? /// .await?; /// /// Ok(()) /// } /// # #[cfg(not(all(feature = "async-std-runtime", feature = "attributes")))] /// # fn main() {} /// ``` pub fn local_future_into_py<F>(py: Python, fut: F) -> PyResult<&PyAny> where F: Future<Output = PyResult<PyObject>> + 'static, { generic::local_future_into_py::<AsyncStdRuntime, _>(py, fut) } /// Convert a Python `awaitable` into a Rust Future /// /// This function converts the `awaitable` into a Python Task using `run_coroutine_threadsafe`. A /// completion handler sends the result of this Task through a /// `futures::channel::oneshot::Sender<PyResult<PyObject>>` and the future returned by this function /// simply awaits the result through the `futures::channel::oneshot::Receiver<PyResult<PyObject>>`. /// /// # Arguments /// * `awaitable` - The Python `awaitable` to be converted /// /// # Examples /// /// ``` /// use std::time::Duration; /// /// use pyo3::prelude::*; /// /// const PYTHON_CODE: &'static str = r#" /// import asyncio /// /// async def py_sleep(duration): /// await asyncio.sleep(duration) /// "#; /// /// async fn py_sleep(seconds: f32) -> PyResult<()> { /// let test_mod = Python::with_gil(|py| -> PyResult<PyObject> { /// Ok( /// PyModule::from_code( /// py, /// PYTHON_CODE, /// "test_into_future/test_mod.py", /// "test_mod" /// )? /// .into() /// ) /// })?; /// /// Python::with_gil(|py| { /// pyo3_asyncio::async_std::into_future( /// test_mod /// .call_method1(py, "py_sleep", (seconds.into_py(py),))? /// .as_ref(py), /// ) /// })? /// .await?; /// Ok(()) /// } /// ``` pub fn into_future(awaitable: &PyAny) -> PyResult<impl Future<Output = PyResult<PyObject>> + Send> { generic::into_future::<AsyncStdRuntime>(awaitable) }