Commit Graph

33 Commits

Author SHA1 Message Date
Miss Islington (bot) fac49762c5
bpo-34335: Use async/await syntax in documentation examples (GH-8674)
(cherry picked from commit d2ac400267)

Co-authored-by: Mikhail Terekhov <termim@gmail.com>
2018-08-07 13:33:31 -07: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
lf 627d2c8e8d Add the link to asyncio source code in the docs (GH-2373) 2017-07-25 16:03:51 -07:00
J. W 6abaed0dda Correct spelling "instanciate" (#465) 2017-03-04 17:51:08 -05:00
Guido van Rossum f68afd8544 Issue #27700: Document AbstractEventLoop, not BaseEventLoop. 2016-08-08 09:41:21 -07:00
Georg Brandl 5d94134040 Closes #25910: fix dead and permanently redirected links in the docs. Thanks to SilentGhost for the patch. 2016-02-26 19:37:12 +01:00
Guido van Rossum 8778c6b77e Use sys.platform instead of os.name to detect Windows in asyncio docs. Patch by Akira Li. 2015-11-02 09:15:47 -08:00
Victor Stinner 5492d358e4 asyncio doc: fix subprocess sections 2015-09-02 15:39:01 +02:00
R David Murray 2249d9f7d6 Make sentence correct English. 2015-05-14 08:50:38 -04:00
Victor Stinner 83704963c0 asyncio: add a note about (non) thread safety in each class 2015-02-25 14:24:15 +01:00
Victor Stinner bdd574d09a asyncio doc: annotate coroutine on coroutine functions and methods 2015-02-12 22:49:18 +01:00
Victor Stinner 399c59d7bd asyncio doc: list limitations to run subprocesses from different threads 2015-01-09 01:32:02 +01:00
Victor Stinner 39892055cd asyncio doc: rewrite subprocess doc
* add a new example using transport and protocol
* rewrite the example using streams to make it much simpler (remove error
  handling, use a simpler Python code)
* copy (and adapt) more documentation from the subprocess module:

  - add a note about Process.wait() deadlock
  - add a note about shell injection
  - etc.

* sort Process methods and attributes in the same order than subprocess.Popen
  methods and attributes, so the documentation looks closer
* list differences between Process and subprocess.Popen APIs
2014-10-14 00:52:07 +02:00
Victor Stinner 3c95062f52 asyncio doc: protocol_factory of subprocess_exec() and subprocess_shell() must
instanciate a subclass of SubprocessProtocol
2014-10-14 00:02:10 +02:00
Victor Stinner d55b54d5c0 asyncio, tulip issue 190: Process.communicate() now ignores
ConnectionResetError too
2014-07-17 13:12:03 +02:00
Victor Stinner cc996b5789 asyncio, tulip issue 190: Process.communicate() must ignore BrokenPipeError
If you want to handle the BrokenPipeError, you can easily reimplement
communicate().

Add also a unit test to ensure that stdin.write() + stdin.drain() raises
BrokenPipeError.
2014-07-17 12:25:27 +02:00
Victor Stinner 778015b3bc asyncio: enhance documentation of platform support 2014-07-11 12:13:39 +02:00
Victor Stinner aea82293be Issue #21680: Document asyncio event loops 2014-07-08 23:42:38 +02:00
Victor Stinner 6bfd854ea8 Closes #21758: asyncio doc: mention explicitly that subprocess parameters are
bytes or character strings
2014-06-19 12:50:27 +02:00
Victor Stinner b0539b27d9 Issue #21485: remove unnecesary .flush() calls in the asyncio subprocess code
example
2014-05-12 23:25:09 +02:00
Guido van Rossum 5280d2e399 asyncio docs: ProactorEventLoop does not support SSL. 2014-05-05 07:34:56 -07:00
Victor Stinner 984600fba7 Issue #21006: asyncio doc: reorganize subprocess doc 2014-03-25 09:40:26 +01:00
Victor Stinner 6bc239619c Issue #21006: Fix subprocess example on Windows in asyncio doc 2014-03-21 11:56:40 +01:00
Victor Stinner 7280486ce3 Close #21005: Fix documentation of asyncio.subprocess.DEVNULL 2014-03-21 11:44:49 +01:00
Victor Stinner 7bdf786e74 Issue #20950: Fix typo asyncio doc, wait() has no self parameter
self parameter is implicit. Mention also that communicate() and wait() are
coroutines.
2014-03-16 21:29:31 +01:00
Victor Stinner 2fb3b82706 asyncio doc: functions are coroutine, they don't return a coroutine
It's not exact, but easier to understand.
2014-03-13 10:58:03 +01:00
Victor Stinner de0e1d30d8 asyncio doc: fix references in subprocess doc 2014-02-24 13:19:19 +01:00
Victor Stinner 0c3949c963 asyncio: Remove Process.subprocess attribute; it's too easy to get inconsistent
Process and Popen objects
2014-02-09 02:51:40 +01:00
Brian Curtin a1afeec9aa Spelling corrections. Submitted to python-dev by python@mrabarnett.plus.com 2014-02-08 18:36:14 -06:00
Victor Stinner e48d4db000 asyncio doc: add an example of asyncio.subprocess with communicate() and wait() 2014-02-03 23:26:28 +01:00
Victor Stinner b79eb0502c asyncio.subprocess: Replace Process.get_subprocess() method with a
Process.subprocess read-only property
2014-02-03 23:08:14 +01:00
Benjamin Peterson 233eac42d4 remove extra backtick 2014-02-03 14:08:00 -05:00
Victor Stinner 084443809f asyncio: document the new asyncio.subprocess module 2014-02-02 22:43:39 +01:00