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 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825
//! <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
//!
//! Items marked with
//! <span
//! class="module-item stab portability"
//! style="display: inline; border-radius: 3px; padding: 2px; font-size: 80%; line-height: 1.2;"
//! ><code>unstable-streams</code></span>
//! are only available when the `unstable-streams` Cargo feature is enabled:
//!
//! ```toml
//! [dependencies.pyo3-asyncio]
//! version = "0.20"
//! features = ["unstable-streams"]
//! ```
use std::ops::Deref;
use std::{future::Future, pin::Pin, sync::Mutex};
use ::tokio::{
runtime::{Builder, Runtime},
task,
};
use once_cell::{
sync::{Lazy, OnceCell},
unsync::OnceCell as UnsyncOnceCell,
};
use pyo3::prelude::*;
use crate::{
generic::{self, ContextExt, LocalContextExt, Runtime as GenericRuntime, SpawnLocalExt},
TaskLocals,
};
/// <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 pending to be used in tokio macros without additional dependency
pub use futures::future::pending;
/// re-export tokio::runtime to build runtimes in tokio macros without additional dependency
pub use tokio::runtime;
}
/// <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>
#[cfg(feature = "attributes")]
pub use pyo3_asyncio_macros::tokio_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 a `tokio` test with the `pyo3-asyncio` test harness
#[cfg(all(feature = "attributes", feature = "testing"))]
pub use pyo3_asyncio_macros::tokio_test as test;
enum Pyo3Runtime {
Borrowed(&'static Runtime),
Owned(Runtime),
}
impl Deref for Pyo3Runtime {
type Target = Runtime;
fn deref(&self) -> &Self::Target {
match self {
Self::Borrowed(rt) => rt,
Self::Owned(rt) => rt,
}
}
}
static TOKIO_BUILDER: Lazy<Mutex<Builder>> = Lazy::new(|| Mutex::new(multi_thread()));
static TOKIO_RUNTIME: OnceCell<Pyo3Runtime> = OnceCell::new();
impl generic::JoinError for task::JoinError {
fn is_panic(&self) -> bool {
task::JoinError::is_panic(self)
}
fn into_panic(self) -> Box<dyn std::any::Any + Send + 'static> {
task::JoinError::into_panic(self)
}
}
struct TokioRuntime;
tokio::task_local! {
static TASK_LOCALS: UnsyncOnceCell<TaskLocals>;
}
impl GenericRuntime for TokioRuntime {
type JoinError = task::JoinError;
type JoinHandle = task::JoinHandle<()>;
fn spawn<F>(fut: F) -> Self::JoinHandle
where
F: Future<Output = ()> + Send + 'static,
{
get_runtime().spawn(async move {
fut.await;
})
}
}
impl ContextExt for TokioRuntime {
fn scope<F, R>(locals: TaskLocals, fut: F) -> Pin<Box<dyn Future<Output = R> + Send>>
where
F: Future<Output = R> + Send + 'static,
{
let cell = UnsyncOnceCell::new();
cell.set(locals).unwrap();
Box::pin(TASK_LOCALS.scope(cell, fut))
}
fn get_task_locals() -> Option<TaskLocals> {
match TASK_LOCALS.try_with(|c| c.get().map(|locals| locals.clone())) {
Ok(locals) => locals,
Err(_) => None,
}
}
}
impl SpawnLocalExt for TokioRuntime {
fn spawn_local<F>(fut: F) -> Self::JoinHandle
where
F: Future<Output = ()> + 'static,
{
tokio::task::spawn_local(fut)
}
}
impl LocalContextExt for TokioRuntime {
fn scope_local<F, R>(locals: TaskLocals, fut: F) -> Pin<Box<dyn Future<Output = R>>>
where
F: Future<Output = R> + 'static,
{
let cell = UnsyncOnceCell::new();
cell.set(locals).unwrap();
Box::pin(TASK_LOCALS.scope(cell, fut))
}
}
/// Set the task local event loop for the given future
pub async fn scope<F, R>(locals: TaskLocals, fut: F) -> R
where
F: Future<Output = R> + Send + 'static,
{
TokioRuntime::scope(locals, fut).await
}
/// Set the task local event loop for the given !Send future
pub async fn scope_local<F, R>(locals: TaskLocals, fut: F) -> R
where
F: Future<Output = R> + 'static,
{
TokioRuntime::scope_local(locals, 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::<TokioRuntime>(py)
}
/// Either copy the task locals from the current task OR get the current running loop and
/// contextvars from Python.
pub fn get_current_locals(py: Python) -> PyResult<TaskLocals> {
generic::get_current_locals::<TokioRuntime>(py)
}
/// Initialize the Tokio runtime with a custom build
pub fn init(builder: Builder) {
*TOKIO_BUILDER.lock().unwrap() = builder
}
/// Initialize the Tokio runtime with a custom Tokio runtime
///
/// Returns Ok(()) if success and Err(()) if it had been inited.
pub fn init_with_runtime(runtime: &'static Runtime) -> Result<(), ()> {
TOKIO_RUNTIME
.set(Pyo3Runtime::Borrowed(runtime))
.map_err(|_| ())
}
/// Get a reference to the current tokio runtime
pub fn get_runtime<'a>() -> &'a Runtime {
TOKIO_RUNTIME.get_or_init(|| {
let rt = TOKIO_BUILDER
.lock()
.unwrap()
.build()
.expect("Unable to build Tokio runtime");
Pyo3Runtime::Owned(rt)
})
}
fn multi_thread() -> Builder {
let mut builder = Builder::new_multi_thread();
builder.enable_all();
builder
}
/// 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 [`run_until_complete`]
///
/// # 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| -> PyResult<()> {
/// # let event_loop = py.import("asyncio")?.call_method0("new_event_loop")?;
/// pyo3_asyncio::tokio::run_until_complete(event_loop, async move {
/// tokio::time::sleep(Duration::from_secs(1)).await;
/// Ok(())
/// })?;
/// # Ok(())
/// # }).unwrap();
/// ```
pub fn run_until_complete<F, T>(event_loop: &PyAny, fut: F) -> PyResult<T>
where
F: Future<Output = PyResult<T>> + Send + 'static,
T: Send + Sync + 'static,
{
generic::run_until_complete::<TokioRuntime, _, T>(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() {
/// Python::with_gil(|py| {
/// pyo3_asyncio::tokio::run(py, async move {
/// tokio::time::sleep(Duration::from_secs(1)).await;
/// Ok(())
/// })
/// .map_err(|e| {
/// e.print_and_set_sys_last_vars(py);
/// })
/// .unwrap();
/// })
/// }
/// ```
pub fn run<F, T>(py: Python, fut: F) -> PyResult<T>
where
F: Future<Output = PyResult<T>> + Send + 'static,
T: Send + Sync + 'static,
{
generic::run::<TokioRuntime, F, T>(py, fut)
}
/// Convert a Rust Future into a Python awaitable
///
/// If the `asyncio.Future` returned by this conversion is cancelled via `asyncio.Future.cancel`,
/// the Rust future will be cancelled as well (new behaviour in `v0.15`).
///
/// Python `contextvars` are preserved when calling async Python functions within the Rust future
/// via [`into_future`] (new behaviour in `v0.15`).
///
/// > Although `contextvars` are preserved for async Python functions, synchronous functions will
/// unfortunately fail to resolve them when called within the Rust future. This is because the
/// function is being called from a Rust thread, not inside an actual Python coroutine context.
/// >
/// > As a workaround, you can get the `contextvars` from the current task locals using
/// [`get_current_locals`] and [`TaskLocals::context`](`crate::TaskLocals::context`), then wrap your
/// synchronous function in a call to `contextvars.Context.run`. This will set the context, call the
/// synchronous function, and restore the previous context when it returns or raises an exception.
///
/// # Arguments
/// * `py` - PyO3 GIL guard
/// * `locals` - The task locals for the given future
/// * `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::tokio::future_into_py_with_locals(
/// py,
/// pyo3_asyncio::tokio::get_current_locals(py)?,
/// async move {
/// tokio::time::sleep(Duration::from_secs(secs)).await;
/// Python::with_gil(|py| Ok(py.None()))
/// }
/// )
/// }
/// ```
pub fn future_into_py_with_locals<F, T>(py: Python, locals: TaskLocals, fut: F) -> PyResult<&PyAny>
where
F: Future<Output = PyResult<T>> + Send + 'static,
T: IntoPy<PyObject>,
{
generic::future_into_py_with_locals::<TokioRuntime, F, T>(py, locals, fut)
}
/// Convert a Rust Future into a Python awaitable
///
/// If the `asyncio.Future` returned by this conversion is cancelled via `asyncio.Future.cancel`,
/// the Rust future will be cancelled as well (new behaviour in `v0.15`).
///
/// Python `contextvars` are preserved when calling async Python functions within the Rust future
/// via [`into_future`] (new behaviour in `v0.15`).
///
/// > Although `contextvars` are preserved for async Python functions, synchronous functions will
/// unfortunately fail to resolve them when called within the Rust future. This is because the
/// function is being called from a Rust thread, not inside an actual Python coroutine context.
/// >
/// > As a workaround, you can get the `contextvars` from the current task locals using
/// [`get_current_locals`] and [`TaskLocals::context`](`crate::TaskLocals::context`), then wrap your
/// synchronous function in a call to `contextvars.Context.run`. This will set the context, call the
/// synchronous function, and restore the previous context when it returns or raises an exception.
///
/// # 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::tokio::future_into_py(py, async move {
/// tokio::time::sleep(Duration::from_secs(secs)).await;
/// Ok(())
/// })
/// }
/// ```
pub fn future_into_py<F, T>(py: Python, fut: F) -> PyResult<&PyAny>
where
F: Future<Output = PyResult<T>> + Send + 'static,
T: IntoPy<PyObject>,
{
generic::future_into_py::<TokioRuntime, _, T>(py, fut)
}
/// Convert a `!Send` Rust Future into a Python awaitable
///
/// If the `asyncio.Future` returned by this conversion is cancelled via `asyncio.Future.cancel`,
/// the Rust future will be cancelled as well (new behaviour in `v0.15`).
///
/// Python `contextvars` are preserved when calling async Python functions within the Rust future
/// via [`into_future`] (new behaviour in `v0.15`).
///
/// > Although `contextvars` are preserved for async Python functions, synchronous functions will
/// unfortunately fail to resolve them when called within the Rust future. This is because the
/// function is being called from a Rust thread, not inside an actual Python coroutine context.
/// >
/// > As a workaround, you can get the `contextvars` from the current task locals using
/// [`get_current_locals`] and [`TaskLocals::context`](`crate::TaskLocals::context`), then wrap your
/// synchronous function in a call to `contextvars.Context.run`. This will set the context, call the
/// synchronous function, and restore the previous context when it returns or raises an exception.
///
/// # Arguments
/// * `py` - PyO3 GIL guard
/// * `locals` - The task locals for the given future
/// * `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::tokio::future_into_py
/// let secs = Rc::new(secs);
///
/// pyo3_asyncio::tokio::local_future_into_py_with_locals(
/// py,
/// pyo3_asyncio::tokio::get_current_locals(py)?,
/// async move {
/// tokio::time::sleep(Duration::from_secs(*secs)).await;
/// Python::with_gil(|py| Ok(py.None()))
/// }
/// )
/// }
///
/// # #[cfg(all(feature = "tokio-runtime", feature = "attributes"))]
/// #[pyo3_asyncio::tokio::main]
/// async fn main() -> PyResult<()> {
/// let locals = Python::with_gil(|py| -> PyResult<_> {
/// pyo3_asyncio::tokio::get_current_locals(py)
/// })?;
///
/// // the main coroutine is running in a Send context, so we cannot use LocalSet here. Instead
/// // we use spawn_blocking in order to use LocalSet::block_on
/// tokio::task::spawn_blocking(move || {
/// // LocalSet allows us to work with !Send futures within tokio. Without it, any calls to
/// // pyo3_asyncio::tokio::local_future_into_py will panic.
/// tokio::task::LocalSet::new().block_on(
/// pyo3_asyncio::tokio::get_runtime(),
/// pyo3_asyncio::tokio::scope_local(locals, async {
/// Python::with_gil(|py| {
/// let py_future = sleep_for(py, 1)?;
/// pyo3_asyncio::tokio::into_future(py_future)
/// })?
/// .await?;
///
/// Ok(())
/// })
/// )
/// }).await.unwrap()
/// }
/// # #[cfg(not(all(feature = "tokio-runtime", feature = "attributes")))]
/// # fn main() {}
/// ```
#[deprecated(
since = "0.18.0",
note = "Questionable whether these conversions have real-world utility (see https://github.com/awestlake87/pyo3-asyncio/issues/59#issuecomment-1008038497 and let me know if you disagree!)"
)]
#[allow(deprecated)]
pub fn local_future_into_py_with_locals<F, T>(
py: Python,
locals: TaskLocals,
fut: F,
) -> PyResult<&PyAny>
where
F: Future<Output = PyResult<T>> + 'static,
T: IntoPy<PyObject>,
{
generic::local_future_into_py_with_locals::<TokioRuntime, _, T>(py, locals, fut)
}
/// Convert a `!Send` Rust Future into a Python awaitable
///
/// If the `asyncio.Future` returned by this conversion is cancelled via `asyncio.Future.cancel`,
/// the Rust future will be cancelled as well (new behaviour in `v0.15`).
///
/// Python `contextvars` are preserved when calling async Python functions within the Rust future
/// via [`into_future`] (new behaviour in `v0.15`).
///
/// > Although `contextvars` are preserved for async Python functions, synchronous functions will
/// unfortunately fail to resolve them when called within the Rust future. This is because the
/// function is being called from a Rust thread, not inside an actual Python coroutine context.
/// >
/// > As a workaround, you can get the `contextvars` from the current task locals using
/// [`get_current_locals`] and [`TaskLocals::context`](`crate::TaskLocals::context`), then wrap your
/// synchronous function in a call to `contextvars.Context.run`. This will set the context, call the
/// synchronous function, and restore the previous context when it returns or raises an exception.
///
/// # 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::tokio::future_into_py
/// let secs = Rc::new(secs);
/// pyo3_asyncio::tokio::local_future_into_py(py, async move {
/// tokio::time::sleep(Duration::from_secs(*secs)).await;
/// Ok(())
/// })
/// }
///
/// # #[cfg(all(feature = "tokio-runtime", feature = "attributes"))]
/// #[pyo3_asyncio::tokio::main]
/// async fn main() -> PyResult<()> {
/// let locals = Python::with_gil(|py| {
/// pyo3_asyncio::tokio::get_current_locals(py).unwrap()
/// });
///
/// // the main coroutine is running in a Send context, so we cannot use LocalSet here. Instead
/// // we use spawn_blocking in order to use LocalSet::block_on
/// tokio::task::spawn_blocking(move || {
/// // LocalSet allows us to work with !Send futures within tokio. Without it, any calls to
/// // pyo3_asyncio::tokio::local_future_into_py will panic.
/// tokio::task::LocalSet::new().block_on(
/// pyo3_asyncio::tokio::get_runtime(),
/// pyo3_asyncio::tokio::scope_local(locals, async {
/// Python::with_gil(|py| {
/// let py_future = sleep_for(py, 1)?;
/// pyo3_asyncio::tokio::into_future(py_future)
/// })?
/// .await?;
///
/// Ok(())
/// })
/// )
/// }).await.unwrap()
/// }
/// # #[cfg(not(all(feature = "tokio-runtime", feature = "attributes")))]
/// # fn main() {}
/// ```
#[deprecated(
since = "0.18.0",
note = "Questionable whether these conversions have real-world utility (see https://github.com/awestlake87/pyo3-asyncio/issues/59#issuecomment-1008038497 and let me know if you disagree!)"
)]
#[allow(deprecated)]
pub fn local_future_into_py<F, T>(py: Python, fut: F) -> PyResult<&PyAny>
where
F: Future<Output = PyResult<T>> + 'static,
T: IntoPy<PyObject>,
{
generic::local_future_into_py::<TokioRuntime, _, T>(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::tokio::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::<TokioRuntime>(awaitable)
}
/// <span class="module-item stab portability" style="display: inline; border-radius: 3px; padding: 2px; font-size: 80%; line-height: 1.2;"><code>unstable-streams</code></span> Convert an async generator into a stream
///
/// **This API is marked as unstable** and is only available when the
/// `unstable-streams` crate feature is enabled. This comes with no
/// stability guarantees, and could be changed or removed at any time.
///
/// # Arguments
/// * `locals` - The current task locals
/// * `gen` - The Python async generator to be converted
///
/// # Examples
/// ```
/// use pyo3::prelude::*;
/// use futures::{StreamExt, TryStreamExt};
///
/// const TEST_MOD: &str = r#"
/// import asyncio
///
/// async def gen():
/// for i in range(10):
/// await asyncio.sleep(0.1)
/// yield i
/// "#;
///
/// # #[cfg(all(feature = "unstable-streams", feature = "attributes"))]
/// # #[pyo3_asyncio::tokio::main]
/// # async fn main() -> PyResult<()> {
/// let stream = Python::with_gil(|py| {
/// let test_mod = PyModule::from_code(
/// py,
/// TEST_MOD,
/// "test_rust_coroutine/test_mod.py",
/// "test_mod",
/// )?;
///
/// pyo3_asyncio::tokio::into_stream_with_locals_v1(
/// pyo3_asyncio::tokio::get_current_locals(py)?,
/// test_mod.call_method0("gen")?
/// )
/// })?;
///
/// let vals = stream
/// .map(|item| Python::with_gil(|py| -> PyResult<i32> { Ok(item?.as_ref(py).extract()?) }))
/// .try_collect::<Vec<i32>>()
/// .await?;
///
/// assert_eq!((0..10).collect::<Vec<i32>>(), vals);
///
/// Ok(())
/// # }
/// # #[cfg(not(all(feature = "unstable-streams", feature = "attributes")))]
/// # fn main() {}
/// ```
#[cfg(feature = "unstable-streams")]
pub fn into_stream_with_locals_v1<'p>(
locals: TaskLocals,
gen: &'p PyAny,
) -> PyResult<impl futures::Stream<Item = PyResult<PyObject>> + 'static> {
generic::into_stream_with_locals_v1::<TokioRuntime>(locals, gen)
}
/// <span class="module-item stab portability" style="display: inline; border-radius: 3px; padding: 2px; font-size: 80%; line-height: 1.2;"><code>unstable-streams</code></span> Convert an async generator into a stream
///
/// **This API is marked as unstable** and is only available when the
/// `unstable-streams` crate feature is enabled. This comes with no
/// stability guarantees, and could be changed or removed at any time.
///
/// # Arguments
/// * `gen` - The Python async generator to be converted
///
/// # Examples
/// ```
/// use pyo3::prelude::*;
/// use futures::{StreamExt, TryStreamExt};
///
/// const TEST_MOD: &str = r#"
/// import asyncio
///
/// async def gen():
/// for i in range(10):
/// await asyncio.sleep(0.1)
/// yield i
/// "#;
///
/// # #[cfg(all(feature = "unstable-streams", feature = "attributes"))]
/// # #[pyo3_asyncio::tokio::main]
/// # async fn main() -> PyResult<()> {
/// let stream = Python::with_gil(|py| {
/// let test_mod = PyModule::from_code(
/// py,
/// TEST_MOD,
/// "test_rust_coroutine/test_mod.py",
/// "test_mod",
/// )?;
///
/// pyo3_asyncio::tokio::into_stream_v1(test_mod.call_method0("gen")?)
/// })?;
///
/// let vals = stream
/// .map(|item| Python::with_gil(|py| -> PyResult<i32> { Ok(item?.as_ref(py).extract()?) }))
/// .try_collect::<Vec<i32>>()
/// .await?;
///
/// assert_eq!((0..10).collect::<Vec<i32>>(), vals);
///
/// Ok(())
/// # }
/// # #[cfg(not(all(feature = "unstable-streams", feature = "attributes")))]
/// # fn main() {}
/// ```
#[cfg(feature = "unstable-streams")]
pub fn into_stream_v1<'p>(
gen: &'p PyAny,
) -> PyResult<impl futures::Stream<Item = PyResult<PyObject>> + 'static> {
generic::into_stream_v1::<TokioRuntime>(gen)
}
/// <span class="module-item stab portability" style="display: inline; border-radius: 3px; padding: 2px; font-size: 80%; line-height: 1.2;"><code>unstable-streams</code></span> Convert an async generator into a stream
///
/// **This API is marked as unstable** and is only available when the
/// `unstable-streams` crate feature is enabled. This comes with no
/// stability guarantees, and could be changed or removed at any time.
///
/// # Arguments
/// * `locals` - The current task locals
/// * `gen` - The Python async generator to be converted
///
/// # Examples
/// ```
/// use pyo3::prelude::*;
/// use futures::{StreamExt, TryStreamExt};
///
/// const TEST_MOD: &str = r#"
/// import asyncio
///
/// async def gen():
/// for i in range(10):
/// await asyncio.sleep(0.1)
/// yield i
/// "#;
///
/// # #[cfg(all(feature = "unstable-streams", feature = "attributes"))]
/// # #[pyo3_asyncio::tokio::main]
/// # async fn main() -> PyResult<()> {
/// let stream = Python::with_gil(|py| {
/// let test_mod = PyModule::from_code(
/// py,
/// TEST_MOD,
/// "test_rust_coroutine/test_mod.py",
/// "test_mod",
/// )?;
///
/// pyo3_asyncio::tokio::into_stream_with_locals_v2(
/// pyo3_asyncio::tokio::get_current_locals(py)?,
/// test_mod.call_method0("gen")?
/// )
/// })?;
///
/// let vals = stream
/// .map(|item| Python::with_gil(|py| -> PyResult<i32> { Ok(item.as_ref(py).extract()?) }))
/// .try_collect::<Vec<i32>>()
/// .await?;
///
/// assert_eq!((0..10).collect::<Vec<i32>>(), vals);
///
/// Ok(())
/// # }
/// # #[cfg(not(all(feature = "unstable-streams", feature = "attributes")))]
/// # fn main() {}
/// ```
#[cfg(feature = "unstable-streams")]
pub fn into_stream_with_locals_v2<'p>(
locals: TaskLocals,
gen: &'p PyAny,
) -> PyResult<impl futures::Stream<Item = PyObject> + 'static> {
generic::into_stream_with_locals_v2::<TokioRuntime>(locals, gen)
}
/// <span class="module-item stab portability" style="display: inline; border-radius: 3px; padding: 2px; font-size: 80%; line-height: 1.2;"><code>unstable-streams</code></span> Convert an async generator into a stream
///
/// **This API is marked as unstable** and is only available when the
/// `unstable-streams` crate feature is enabled. This comes with no
/// stability guarantees, and could be changed or removed at any time.
///
/// # Arguments
/// * `gen` - The Python async generator to be converted
///
/// # Examples
/// ```
/// use pyo3::prelude::*;
/// use futures::{StreamExt, TryStreamExt};
///
/// const TEST_MOD: &str = r#"
/// import asyncio
///
/// async def gen():
/// for i in range(10):
/// await asyncio.sleep(0.1)
/// yield i
/// "#;
///
/// # #[cfg(all(feature = "unstable-streams", feature = "attributes"))]
/// # #[pyo3_asyncio::tokio::main]
/// # async fn main() -> PyResult<()> {
/// let stream = Python::with_gil(|py| {
/// let test_mod = PyModule::from_code(
/// py,
/// TEST_MOD,
/// "test_rust_coroutine/test_mod.py",
/// "test_mod",
/// )?;
///
/// pyo3_asyncio::tokio::into_stream_v2(test_mod.call_method0("gen")?)
/// })?;
///
/// let vals = stream
/// .map(|item| Python::with_gil(|py| -> PyResult<i32> { Ok(item.as_ref(py).extract()?) }))
/// .try_collect::<Vec<i32>>()
/// .await?;
///
/// assert_eq!((0..10).collect::<Vec<i32>>(), vals);
///
/// Ok(())
/// # }
/// # #[cfg(not(all(feature = "unstable-streams", feature = "attributes")))]
/// # fn main() {}
/// ```
#[cfg(feature = "unstable-streams")]
pub fn into_stream_v2<'p>(
gen: &'p PyAny,
) -> PyResult<impl futures::Stream<Item = PyObject> + 'static> {
generic::into_stream_v2::<TokioRuntime>(gen)
}