4898415df7
gh-98641: Document difference between task group and gather ( #103644 )
...
The purpose of the comments is to rule out the implication that asyncio.TaskGroup is a drop-in replacement / better alternative to asyncio.gather().
2023-04-20 07:07:41 -07:00
da2273fec7
GH-88342: clarify that `asyncio.as_completed` accepts generators yielding tasks ( #103626 )
2023-04-19 15:51:53 +05:30
6a1c49a717
gh-101100: Test docs in nit-picky mode ( #102513 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2023-03-24 13:23:35 +02:00
f13fdacadf
gh-102810 Improve the sphinx docs for `asyncio.Timeout` ( #102934 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-03-23 16:43:13 +00:00
04adf2df39
gh-102780: Fix uncancel() call in asyncio timeouts ( #102815 )
...
Also use `raise TimeOut from <CancelledError instance>` so that the CancelledError is set
in the `__cause__` field rather than in the `__context__` field.
Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-03-22 10:52:10 -07:00
4f5774f648
GH-78530: add support for generators in `asyncio.wait` ( #102761 )
2023-03-17 06:58:43 +05:30
7bdb331b67
doc: Remove a duplicate 'versionchanged' in library/asyncio-task (gh-102677)
2023-03-14 11:07:59 +09:00
f87f6e2396
gh-97725: Fix documentation for the default file of `asyncio.Task.print_stack` ( #101652 )
2023-02-07 23:34:31 +05:30
95fb0e0258
gh-101498 : Fix asyncio.Timeout example in docs ( #101499 )
...
Doc/library/asyncio-task.rst#timeout
2023-02-01 10:08:31 -08:00
ef09bf63d2
Fixes typo in asyncio.TaskGroup context manager code example ( #101449 )
2023-01-30 21:36:40 -08:00
27d8dc2c9d
gh-85073: Add some missing links to source (GH-99363)
...
Add some missing links to source from Python docs
2022-11-18 11:33:40 -08:00
fa2d43e518
Docs: Fix backtick errors found by sphinx-lint ( #97998 )
...
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2022-10-06 18:01:30 -07:00
09de8d7aaf
GH-90985: Revert "Deprecate passing a message into cancel()" ( #97999 )
...
Reason: we were too hasty in deprecating this.
We shouldn't deprecate it before we have a replacement.
2022-10-06 17:30:27 -07:00
8079bef56f
GH-96704: Add {Task,Handle}.get_context(), use it in call_exception_handler() ( #96756 )
...
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-10-04 23:49:10 -07:00
f00645d5db
gh-90908: Document asyncio.Task.cancelling() and asyncio.Task.uncancel() ( #95253 )
...
Co-authored-by: Thomas Grainger <tagrain@gmail.com>
2022-10-01 10:42:36 -07:00
6281affee6
gh-94972: document that shield users need to keep a reference to their task ( #96724 )
...
Co-authored-by: Thomas Grainger <tagrain@gmail.com>
Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>
2022-09-10 07:34:14 -07:00
35e4da25d4
Docs: Fix count of bullets in asyncio-task.rst ( #96307 )
2022-08-26 20:50:48 -07:00
0c6f898005
gh-95051: ensure that timeouts scheduled with `asyncio.Timeout` that have already expired are deliverered promptly ( #95109 )
...
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-07-24 13:18:05 -07:00
08f68975ab
GH-46771: docs for asyncio.timeout and task cancellation ( #94794 )
2022-07-14 19:38:38 -07:00
594c369949
GH-94398: TaskGroup: Fail create_task() during shutdown (GH-94400)
...
Once the task group is shutting down, it should not be possible to create a new task.
Here "shutting down" means `self._aborting` is set, indicating that at least one task
has failed and we have cancelled all others.
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2022-06-30 19:10:46 +02:00
b6ec6d4041
GH-90908: Document asyncio.TaskGroup (GH-94359)
...
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-06-30 18:16:22 +02:00
75ceae05c1
gh-88831: In docs for asyncio.create_task, explain why strong references to tasks are needed (GH-93258)
...
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2022-06-07 10:56:09 +02:00
d1b2e989be
gh-92223: Remove pre-Python 3.7 alternative in asyncio docs ( #92224 )
2022-05-04 17:14:07 -07:00
4119d2d7c9
bpo-47062: Implement asyncio.Runner context manager (GH-31799)
...
Co-authored-by: Zachary Ware <zach@python.org>
2022-03-24 21:51:16 +02:00
0360e9f346
bpo-46829: Deprecate passing a message into Future.cancel() and Task.cancel() (GH-31840)
...
After a long deliberation we ended up feeling that the message argument for Future.cancel(), added in 3.9, was a bad idea, so we're deprecating it in 3.11 and plan to remove it in 3.13.
2022-03-23 08:43:05 -07:00
903f0a02c1
bpo-34790: Remove passing coroutine objects to asyncio.wait() (GH-31964)
...
Co-authored-by: Yury Selivanov <yury@edgedb.com>
2022-03-17 22:51:40 +02:00
9523c0d84f
bpo-46994: Accept explicit contextvars.Context in asyncio create_task() API (GH-31837)
2022-03-14 13:54:13 +02:00
4140bcb1cd
bpo-45390: Propagate CancelledError's message from cancelled task to its awaiter (GH-31383)
...
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2022-02-21 22:59:04 +02:00
2923d87ca2
bpo-46777: Fix incorrect use of directives in asyncio documentation (GH-31388)
2022-02-18 10:58:48 +02:00
da4b214304
bpo-42413: Replace `concurrent.futures.TimeoutError` and `asyncio.TimeoutError` with builtin `TimeoutError` (GH-30197)
...
Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com>
2021-12-19 13:22:40 +02:00
8518ee348c
removal of duplicated text paragraph ( #29666 )
2021-12-07 01:12:29 +02:00
c750adbe69
Save a reference for ensure_future and create_task (GH-29163)
...
Co-authored-by: Joannah Nanjekye <jnanjekye@python.org>
2021-11-15 14:30:28 -08:00
e25e43e355
correct spelling (GH-27076)
2021-07-19 17:46:42 -03:00
15f0fc571c
Doc: Fix wrong exception used in example. (GH-26572)
2021-07-08 09:31:28 +02:00
a1092f6249
bpo-43216: Remove @asyncio.coroutine (GH-26369)
...
Remove the @asyncio.coroutine decorator
enabling legacy generator-based coroutines to be compatible with async/await
code; remove asyncio.coroutines.CoroWrapper used for wrapping
legacy coroutine objects in the debug mode.
The decorator has been deprecated
since Python 3.8 and the removal was initially scheduled for Python 3.10.
2021-07-01 15:13:59 +02:00
d8fd8c8568
bpo-42392: [docs] Add deprecated-removed loop labels for asyncio (GH-26357)
...
* Add deprecated-removed loop labels for all reelvant functions/classes in asyncio
2021-05-26 14:59:34 -07:00
56b8ea65d2
Updated code example for asyncio.gather (GH-20604)
...
The previous example did not fully showcase the interest of using gather.
Here the example showcases "the result is an aggregate list of returned values".
2021-05-13 23:06:26 -07:00
172c0f2752
bpo-39529: Deprecate creating new event loop in asyncio.get_event_loop() (GH-23554)
...
asyncio.get_event_loop() emits now a deprecation warning when it creates a new event loop.
In future releases it will became an alias of asyncio.get_running_loop().
2021-04-25 13:40:44 +03:00
5c30145afb
bpo-42783: Documentation for asyncio.sleep(0) ( #24002 )
...
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
2021-01-07 12:03:18 +10:00
dcc997cd28
[doc] Fix erroneous backslashes in signatures and names (GH-23658)
...
The issue being resolved is shown in the 3.10 docs (if you select docs for older versions you won't see a visual glitch).
The newer sphinx version that produces the 3.10 docs doesn't treat the backslash to escape things in some situations it previously did.
2020-12-16 17:37:28 -08:00
86150d39c8
bpo-42392: Remove deprecated loop parameter from docs (GH-23552)
2020-11-29 14:50:57 +02:00
989af25616
Typo ( #23482 )
2020-11-24 00:56:30 +01:00
3d86d090dc
bpo-42230: Improve asyncio documentation regarding accepting sets vs iterables (GH-23073)
...
People call wait() and as_completed() with various non-set iterables,
a list should be the most common but there are others as well[1].
Considering typeshed also documents wait()[2] and as_completed()[3]
as accepting arbitrary iterables I think it's a good idea to document
the status quo better.
[1] https://github.com/aio-libs/aiokafka/pull/672
[2] 620989bac5/stdlib/3/asyncio/tasks.pyi (L161)620989bac5/stdlib/3/asyncio/tasks.pyi (L40)
2020-11-02 12:56:35 +02:00
d42528a3a2
bpo-37703: improve asyncio.gather documentation regarding cancellation (GH-15312)
...
These changes updates the doc to comprehensively mention the behaviour of gather.cancel()
Automerge-Triggered-By: @asvetlov
2020-07-20 01:42:57 -07:00
004e64e805
bpo-40967: Remove deprecated asyncio.Task.current_task() and asyncio.Task.all_tasks() (GH-20874)
2020-07-01 20:41:21 -07:00
2b201369b4
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.
2020-05-31 00:07:04 -07:00
13206b52d1
bpo-40405: Fix asyncio.as_completed docs (GH-19753)
...
* Fix as_completed docs to correctly state the function return value.
* Also, improves the general wording of the as_completed documentation.
Co-Authored-By: Rémi Lapeyre <remi.lapeyre@henki.fr>
Co-Authored-By: Kyle Stanley <aeros167@gmail.com>
Co-Authored-By: Yury Selivanov <yury@edgedb.com>
2020-05-23 19:14:31 -04:00
0f56263e62
bpo-32309: Add support for contextvars in asyncio.to_thread() (GH-20278)
...
Allows contextvars from the main thread to be accessed in the separate thread used in `asyncio.to_thread()`. See the [discussion](https://github.com/python/cpython/pull/20143#discussion_r427808225 ) in GH-20143 for context.
Automerge-Triggered-By: @aeros
2020-05-20 22:20:43 -07:00
cc2bbc2227
bpo-32309: Implement asyncio.to_thread() (GH-20143)
...
Implements `asyncio.to_thread`, a coroutine for asynchronously running IO-bound functions in a separate thread without blocking the event loop. See the discussion starting from [here](https://github.com/python/cpython/pull/18410#issuecomment-628930973 ) in GH-18410 for context.
Automerge-Triggered-By: @aeros
2020-05-18 20:03:28 -07:00
1ce5841eca
bpo-31033: Add a msg argument to Future.cancel() and Task.cancel() (GH-19979)
2020-05-15 16:55:50 -07:00
Adrien
Kumar Aditya
Hugo van Kemenade
JosephSBoyle
Kristján Valur Jónsson
Joongi Kim
Oleg Iarygin
Raj
Ben
Stanley
Guido van Rossum
Łukasz Langa
Hendrik Makait
zhanpon
Thomas Grainger
Tin Tvrtković
Andreas Grommek
Sebastian Rittau
Andrew Svetlov
Serhiy Storchaka
Taras Sereda
Joannah Nanjekye
Sondre Lillebø Gundersen
Julien Palard
Illia Volochii
Ken Jin
josephernest
Simon Willison
Andre Delfino
Yurii Karabas
Jesús Cea
Jakub Stasiak
Vinay Sharma
Rémi Lapeyre
Kyle Stanley
Bar Harel
Chris Jerdonek