Module pyo3_asyncio::tokio

tokio-runtime PyO3 Asyncio functions specific to the tokio runtime

Items marked with unstable-streams are only available when the unstable-streams Cargo feature is enabled:

[dependencies.pyo3-asyncio]
version = "0.20"
features = ["unstable-streams"]

Modules

• re_exports
  attributes re-exports for macros

Functions

• future_into_py
  Convert a Rust Future into a Python awaitable
• future_into_py_with_locals
  Convert a Rust Future into a Python awaitable
• get_current_locals
  Either copy the task locals from the current task OR get the current running loop and contextvars from Python.
• get_current_loop
  Get the current event loop from either Python or Rust async task local context
• get_runtime
  Get a reference to the current tokio runtime
• init
  Initialize the Tokio runtime with a custom build
• init_with_runtime
  Initialize the Tokio runtime with a custom Tokio runtime
• into_future
  Convert a Python awaitable into a Rust Future
• into_stream_v1
  unstable-streams Convert an async generator into a stream
• into_stream_v2
  unstable-streams Convert an async generator into a stream
• into_stream_with_locals_v1
  unstable-streams Convert an async generator into a stream
• into_stream_with_locals_v2
  unstable-streams Convert an async generator into a stream
• local_future_into_pyDeprecated
  Convert a !Send Rust Future into a Python awaitable
• local_future_into_py_with_localsDeprecated
  Convert a !Send Rust Future into a Python awaitable
• run
  Run the event loop until the given Future completes
• run_until_complete
  Run the event loop until the given Future completes
• scope
  Set the task local event loop for the given future
• scope_local
  Set the task local event loop for the given !Send future

Attribute Macros

• main
  attributes Enables an async main function that uses the tokio runtime.
• test
  attributes testing Registers a tokio test with the pyo3-asyncio test harness Registers a tokio test with the pyo3-asyncio test harness.