]> git.ipfire.org Git - thirdparty/Python/cpython.git/commit
Fix asyncio.to_thread() documented return type (GH-20547)
authorKyle Stanley <aeros167@gmail.com>
Sun, 31 May 2020 07:07:04 +0000 (03:07 -0400)
committerGitHub <noreply@github.com>
Sun, 31 May 2020 07:07:04 +0000 (00:07 -0700)
commit2b201369b435a4266bda5b895e3b615dbe28ea6e
tree75306b15a42274e929b3286f4a74368b983f205c
parent007bb06a2de9e64fa978f5dd9131d0100227b4cf
Fix asyncio.to_thread() documented return type (GH-20547)

When I wrote the documentation for `asyncio.to_thread()`, I mistakenly assumed that `return await loop.run_in_executor(...)` within an async def function would return a Future. In reality, it returns a coroutine.

This likely won't affect typical usage of `asyncio.to_thread()`, but it's important for the documentation to be correct here. In general, we also tend to avoid returning futures from high-level APIs in asyncio.
Doc/library/asyncio-task.rst
Lib/asyncio/threads.py