Issue 23859: asyncio: document behaviour of wait() cancellation (original) (raw)

Issue23859

Created on 2015-04-03 15:13 by vstinner, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Messages (5)
msg240001 - (view)	Author: STINNER Victor (vstinner) *	Date: 2015-04-03 15:13
When wait(fs) is cancelled, futures of fs are not cancelled. This behaviour is not documented. It should be documented, and a warning should be added to the Cancellation section: https://docs.python.org/dev/library/asyncio-dev.html#cancellation See my message "Cancellation of asyncio.wait()": https://mail.google.com/mail/u/0/#label/Tulip/14b34f0a5d31114f
msg318124 - (view)	Author: Yury Selivanov (yselivanov) *	Date: 2018-05-29 22:21
New changeset f9aeca2085464838f04bf13f816a1f861d43541f by Yury Selivanov (Elvis Pranskevichus) in branch 'master': bpo-23859: Document that asyncio.wait() does not cancel its futures (#7217) https://github.com/python/cpython/commit/f9aeca2085464838f04bf13f816a1f861d43541f
msg318136 - (view)	Author: STINNER Victor (vstinner) *	Date: 2018-05-29 22:48
> https://github.com/python/cpython/commit/f9aeca2085464838f04bf13f816a1f861d43541f " + when a timeout accurs. " typo: accurs => occurs
msg318145 - (view)	Author: Yury Selivanov (yselivanov) *	Date: 2018-05-30 01:26
New changeset f95269404c03bd769a3551cd851b51b8f89672df by Yury Selivanov (Miss Islington (bot)) in branch '3.7': [3.7] bpo-23859: Document that asyncio.wait() does not cancel its futures (GH-7217) (#7227) https://github.com/python/cpython/commit/f95269404c03bd769a3551cd851b51b8f89672df
msg318161 - (view)	Author: STINNER Victor (vstinner) *	Date: 2018-05-30 10:06
Thank you Elvis for the documentation! Cancellation is one of the most complex part of asynchronous programming, and I don't think that asyncio documentation explains it properly. We may document the behaviour on cancellation for most task functions. https://docs.python.org/dev/library/asyncio-task.html#task-functions as_completed() behaviour on cancellation is not documented for example. The wait() documentation should be backported to 3.6 as well.