Commit Graph

104 Commits

Author SHA1 Message Date
Miss Islington (bot) 2eb1dac46e Fix and improve `asyncio.run()` docs (GH-16403) (GH-16505)
(cherry picked from commit e407013089)

Co-authored-by: Kyle Stanley <aeros167@gmail.com>
2019-09-30 18:47:13 -07:00
Miss Islington (bot) d3666945d7
bpo-38260: Add Docs on asyncio.run (GH-16337)
Add docs about return and raise exception on asyncio.run

https://bugs.python.org/issue38260

Automerge-Triggered-By: @asvetlov
(cherry picked from commit 17deb16883)

Co-authored-by: Emmanuel Arias <emmanuelarias30@gmail.com>
2019-09-25 02:13:00 -07:00
Miss Islington (bot) f81b33bada
Orthographical fix (GH-13418)
Add a missing comma.
(cherry picked from commit 1d5bdef550)

Co-authored-by: Boštjan Mejak <bostjan.xperia@gmail.com>
2019-05-19 02:13:28 -07:00
Miss Islington (bot) dcf14d1a98
bpo-35579: Fix typo in in asyncio-task documentation (GH-11321)
https://bugs.python.org/issue35579

https://bugs.python.org/issue35579
(cherry picked from commit 3a81076bbf)

Co-authored-by: Vaibhav Gupta <vaibhgupt199@gmail.com>
2018-12-26 06:53:03 -08:00
Miss Islington (bot) d9dbb864cd
Use f-strings in asyncio-task code examples (GH-10035)
Replace str.format with f-strings in the code examples of asyncio-task documentation.
(cherry picked from commit 9f43fbbd9d)

Co-authored-by: Mariatta <Mariatta@users.noreply.github.com>
2018-10-24 15:45:44 -07:00
Miss Islington (bot) 655608a111 bpo-34476: Document that asyncio.sleep() always suspends. (GH-9643) (#9654)
(cherry picked from commit cd602b8af2)

Co-authored-by: Hrvoje Nikšić <hniksic@gmail.com>
2018-10-01 13:19:33 +03:00
Miss Islington (bot) 85ccedc5b5
bpo-34802: Fix asyncio.iscoroutine() docs (GH-9611)
(cherry picked from commit 59ee5b1293)

Co-authored-by: Yury Selivanov <yury@magic.io>
2018-09-27 12:53:18 -07:00
Yury Selivanov 22a56958e7
[3.7] asyncio/docs: Replace Python 4.0 -> 3.10 (GH-9580) 2018-09-25 18:00:15 -04:00
Miss Islington (bot) 3cc9557d9f
bpo-34790: [docs] Passing coroutines to asyncio.wait() can be confusing. (GH-9543)
(cherry picked from commit 996859a90d)

Co-authored-by: Yury Selivanov <yury@magic.io>
2018-09-25 11:57:49 -07:00
Miss Islington (bot) e45662c28b bpo-33649: Fix gather() docs; fix title; few other nits. (GH-9475) (GH-9481)
(cherry picked from commit db1a80e97a)

Co-authored-by: Yury Selivanov <yury@magic.io>
2018-09-21 16:35:34 -04:00
Miss Islington (bot) 8e5ef58c10
bpo-33649: More improvements (GH-9439)
(cherry picked from commit e247b46cba)

Co-authored-by: Yury Selivanov <yury@magic.io>
2018-09-20 09:57:19 -07:00
Miss Islington (bot) 73c0006e71
bpo-33649: Add a high-level section about Futures; few quick fixes (GH-9403)
Co-authored-by: Elvis Pranskevichus <elvis@magic.io>
(cherry picked from commit 471503954a)

Co-authored-by: Yury Selivanov <yury@magic.io>
2018-09-18 15:09:51 -07:00
Miss Islington (bot) 45452b738b
bpo-33649: Fix markup; add another note that asyncio.run is 3.7+ (GH-9389)
(cherry picked from commit b042cf10c6)

Co-authored-by: Yury Selivanov <yury@magic.io>
2018-09-18 00:00:58 -07:00
Miss Islington (bot) ee2ff1a335 Fix syntax error on Asyncio example in doc (GH-9387) (GH-9388)
The `gather` method requires to close the parenthesis, but it is being closed twice.
(cherry picked from commit 9c53fa6ad9)

Co-authored-by: Miguel Ángel García <magmax@users.noreply.github.com>
2018-09-18 02:27:27 -04:00
Miss Islington (bot) 9a89fd6884 Change "set_after" reference to `say_after`. (GH-9384) (GH-9386)
(cherry picked from commit 7bfbda46f4)

Co-authored-by: Danny Hermes <daniel.j.hermes@gmail.com>
2018-09-18 02:27:07 -04:00
Yury Selivanov 512d710109
bpo-33649: Backport asyncio docs from 'master' to 3.7 (GH-9377) 2018-09-17 19:35:30 -04:00
Miss Islington (bot) f95269404c [3.7] bpo-23859: Document that asyncio.wait() does not cancel its futures (GH-7217) (#7227)
* bpo-23859: Document that asyncio.wait() does not cancel its futures (GH-7217)

Unlike `asyncio.wait_for()`, `asyncio.wait()` does not cancel the passed
futures when a timeout accurs.
(cherry picked from commit f9aeca2085)

Co-authored-by: Elvis Pranskevichus <elvis@magic.io>

* Update asyncio-task.rst
2018-05-29 21:26:22 -04:00
Miss Islington (bot) d8948c5e09
bpo-32751: Wait for task cancellation in asyncio.wait_for() (GH-7216)
Currently, asyncio.wait_for(fut), upon reaching the timeout deadline,
cancels the future and returns immediately.  This is problematic for
when *fut* is a Task, because it will be left running for an arbitrary
amount of time.  This behavior is iself surprising and may lead to
related bugs such as the one described in bpo-33638:

    condition = asyncio.Condition()
    async with condition:
        await asyncio.wait_for(condition.wait(), timeout=0.5)

Currently, instead of raising a TimeoutError, the above code will fail
with `RuntimeError: cannot wait on un-acquired lock`, because
`__aexit__` is reached _before_ `condition.wait()` finishes its
cancellation and re-acquires the condition lock.

To resolve this, make `wait_for` await for the task cancellation.
The tradeoff here is that the `timeout` promise may be broken if the
task decides to handle its cancellation in a slow way.  This represents
a behavior change and should probably not be back-patched to 3.6 and
earlier.
(cherry picked from commit e2b340ab41)

Co-authored-by: Elvis Pranskevichus <elvis@magic.io>
2018-05-29 15:37:06 -07:00
Miss Islington (bot) 036434273e bpo-32684: Fix gather to propagate cancel of itself with return_exceptions (GH-7209) (#7222)
(cherry picked from commit 863b674909)

Co-authored-by: Yury Selivanov <yury@magic.io>
2018-05-29 18:29:12 -04:00
Miss Islington (bot) ddc613f203
bpo-32610: Fix asyncio.all_tasks() to return only pending tasks. (GH-7174)
(cherry picked from commit 416c1ebd98)

Co-authored-by: Yury Selivanov <yury@magic.io>
2018-05-28 17:16:43 -07:00
Miss Islington (bot) 2fc443c469
bpo-32436: Document PEP 567 changes to asyncio. (GH-7073)
(cherry picked from commit 28b9178023)

Co-authored-by: Yury Selivanov <yury@magic.io>
2018-05-23 10:59:17 -07:00
Elvis Pranskevichus 15f3d0cc76 [3.7] bpo-32996: The bulk of What's New in Python 3.7 (GH-6978). (GH-6998)
(cherry picked from commit 63536bd286)

Co-authored-by: Elvis Pranskevichus <elvis@magic.io>
2018-05-19 23:39:45 -04:00
Miss Islington (bot) f34ade33ee asyncio/docs: Mark asyncio.run() as provisional in 3.7. (GH-6946) (GH-6949)
(cherry picked from commit d8d715f514)

Co-authored-by: Yury Selivanov <yury@magic.io>
2018-05-17 15:10:56 -04:00
Miss Islington (bot) ee28cd57df
Fix docs markup for asyncio current_task() and all_tasks() (GH-6089)
(cherry picked from commit b21505e710)

Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com>
2018-03-12 12:12:05 -07:00
Miss Islington (bot) 0f7cf7eb8a
Fix missing coroutine declaration in the asyncio documentation. (GH-5964)
(cherry picked from commit 13cfd57dcf)

Co-authored-by: Joongi Kim <me@daybreaker.info>
2018-03-03 13:22:49 -08:00
Yury Selivanov ca9b36cd1a
bpo-32415: Add asyncio.Task.get_loop() and Future.get_loop() (#4992) 2017-12-23 15:04:15 -05:00
Andrew Svetlov 44d1a5912e
bpo-32250: Implement asyncio.current_task() and asyncio.all_tasks() (#4799) 2017-12-16 21:58:38 +02:00
Andrew Svetlov f74ef458ab
bpo-32311: Implement asyncio.create_task() shortcut (#4848)
* Implement functionality
* Add documentation
2017-12-15 07:04:38 +02:00
Yury Selivanov 02a0a19206
bpo-32314: Implement asyncio.run() (#4852) 2017-12-14 09:42:21 -05:00
Andrew Svetlov 8874342cf3
bpo-32258: Replace 'yield from' to 'await' in asyncio docs (#4779)
* Replace 'yield from' to 'await' in asyncio docs

* Fix docstrings
2017-12-11 17:35:49 +02:00
Yury Selivanov 9edad3c701
bpo-32272: Remove asyncio.async() function. (#4784) 2017-12-11 10:03:48 -05:00
Antoine Pitrou 22b1128559
bpo-31960: Fix asyncio.Future documentation for thread (un)safety. (#4319) 2017-11-07 17:03:28 +01:00
luzpaz a5293b4ff2 Fix miscellaneous typos (#4275) 2017-11-05 15:37:50 +02:00
lf 627d2c8e8d Add the link to asyncio source code in the docs (GH-2373) 2017-07-25 16:03:51 -07:00
adisbladis 824f687912 bpo-24755: Document asyncio.wrap_future (GH-603) 2017-06-08 23:28:59 -07:00
Berker Peksag f59286794b Issue #29441: Update examples to use async and await keywords in asyncio-task.rst 2017-02-07 11:27:09 +03:00
Berker Peksag d5adb63673 Issue #29407: Remove redundant ensure_future() calls in factorial example 2017-02-01 22:37:16 +03:00
Serhiy Storchaka 4adf01caae Issue #19795: Improved more markups of True/False. 2016-10-19 18:30:05 +03:00
Berker Peksag 002b0a7ecd Issue #28348: Fix typo in asyncio.Task() documentation
Patch by Mariatta Wijaya.
2016-10-04 20:45:47 +03:00
Guido van Rossum f68afd8544 Issue #27700: Document AbstractEventLoop, not BaseEventLoop. 2016-08-08 09:41:21 -07:00
Andrew Svetlov 4365b8302d Use asyncio.gather instead of asyncio.wait in example.
gather will raise exception in case of problem but wait just returns done and pending lists of futures.
For getting error every future result should be retrieved, which is boring and error prone.
2016-08-08 03:10:39 +03:00
Yury Selivanov c1cf296de6 asyncio: Remove asyncio.timeout() context manager.
It will probably be added back in Python 3.6, once its compatibility
issues are resolved; see [1] for more details.

[1] https://mail.python.org/pipermail/async-sig/2016-June/000045.html
2016-06-08 13:57:03 -04:00
Zachary Ware f9aff925e0 Fix typo 2016-06-01 00:01:10 -05:00
Yury Selivanov 950204df9c docs: Update asyncio docs & whatsnew 2016-05-16 16:23:00 -04:00
Andrew Svetlov 6f57424ae0 Document None as timeout for asyncio.timeout() 2016-03-29 09:39:02 +03:00
Martin Panter c04fb56e36 Issue #26304: Change "allows to <verb>" to "allows <verb>ing" or similar
The original form is incorrect grammar and feels awkward, even though the
meaning is clear.
2016-02-10 05:44:01 +00:00
Andrew Svetlov ea471348f4 Fix versionadded to use 3.5.1 only for 3.5 branch 2016-01-11 15:41:43 +02:00
Andrew Svetlov 3af81f2505 merge 3.4 2016-01-11 14:45:25 +02:00
Andrew Svetlov f1240169b3 Document asyncio.timeout() 2016-01-11 14:40:35 +02:00
Yury Selivanov e319ab01ce docs/asyncio: Update ensure_future & run_coroutine_threadsafe docs 2015-12-15 00:45:24 -05:00