92483b21b3
gh-101100: Fix Sphinx warnings in `whatsnew/2.7.rst` and related ( #115319 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-02-12 14:40:41 +02:00
4b9948617f
gh-106909: Use role :const: for referencing module constants (GH-106910)
2023-07-21 12:40:37 +03:00
d036db728e
gh-106892: Use roles :data: and :const: for referencing module variables (GH-106894)
2023-07-21 12:34:30 +03:00
67d140dba7
gh-83925: Make asyncio.subprocess communicate similar to non-asyncio ( #18650 )
...
subprocess's communicate(None) closes stdin of the child process, after
sending no (extra) data. Make asyncio variant do the same.
This fixes issues with processes that waits for EOF on stdin before
continuing.
2023-04-27 17:30:26 -07:00
acf4d5d5bd
Fix broken link in `asyncio-subprocesses` doc (GH-99214)
...
# Fix broken link in Doc/library/asyncio-subprocess.rst
This is a trivial fix in documentation to fix a broken link.
There is a broken link in [Doc/library/asyncio-subprocess.rst](https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.subprocess.Process ) for the function ``wait_for``:
I suppose this refers to the function ``asyncio.wait_for`` which is not clear in the docs.
This PR fixes the link and the result looks like the following:
Automerge-Triggered-By: GH:AlexWaygood
2022-11-08 08:26:06 -08:00
2cdd57f119
bpo-46879: Fix incorrect sphinx object names in doc (GH-31615)
...
API members documented in sphinx have an object name, which allow the
documentation to be linked from other projects. Sphinx calculates the
object name by prefixing the current module name to the directive
argument, e.g:
.. module:: foo
.. function:: bar.baz
becomes foo.bar.baz. Since these anchors aren't displayed in the
documentation, some mistakes have crept in, namely the Python stdlib
documentation currently contains the objects:
* asyncio.asyncio.subprocess.DEVNULL
* asyncio.asyncio.subprocess.PIPE
* asyncio.asyncio.subprocess.STDOUT
* asyncio.asyncio.subprocess.Process
* multiprocessing.sharedctypes.multiprocessing.Manager
* xml.etree.ElementTree.xml.etree.ElementInclude
This commit fixes this by making use of the :module: option which
without an argument makes sphinx take the directive argument as is
for the object name (avoiding the prefixing of the current module
name that led to these broken object names).
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2022-05-19 17:34:58 +02:00
bb857a96ef
asyncio.subprocess: Fix a typo in doc ( #92030 )
...
Remove a confusion for read method in asyncio-subprocess doc for stderr StreamReader instance
2022-05-02 09:01:52 -06:00
2923d87ca2
bpo-46777: Fix incorrect use of directives in asyncio documentation (GH-31388)
2022-02-18 10:58:48 +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
3c4850e222
Update asyncio-subprocess.rst (GH-21680)
2021-04-25 21:38:16 -07: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
4dfb190a33
bpo-41217: Fix incorrect note in the asyncio.create_subprocess_shell() docs (GH-21360)
...
On Windows, the default asyncio event loop is ProactorEventLoop (as of 3.8).
2020-10-19 23:08:34 +01:00
4a0ac42c52
closes bpo-40774: Fix docs indentation for asyncio.create_subprocess_shell() (GH-20403)
2020-05-25 23:08:40 -05:00
f900064ac4
docs: Add asyncio source code links (GH-16640)
2019-10-10 19:18:46 -04:00
a488879cba
bpo-36373: Deprecate explicit loop in task and subprocess API (GH-16033)
2019-09-12 15:40:40 +03:00
0d671c04c3
bpo-35621: Support running subprocesses in asyncio when loop is executed in non-main thread (GH-14344)
2019-06-30 12:54:59 +03:00
1328375ad1
Fix doc for create_subprocess_exec (GH-12598)
...
Add missing `program` argument to asyncio.create_subprocess_exec documentation.
2019-04-05 07:02:28 -07:00
37aae9dcf1
bpo-34687: Update asyncio doc for ProactorEventLoop (GH-9623)
...
Since ProactorEventLoop is now the default in 3.8, remove examples
using it explicitly on Windows.
https://bugs.python.org/issue34687
2018-09-28 08:40:08 -07:00
1fa2ec49be
bpo-33649: A copy-editing pass on asyncio documentation (GH-9376)
2018-09-17 19:16:44 -04:00
394374e30c
bpo-33649: Add low-level APIs index. (GH-9364)
2018-09-17 15:35:24 -04:00
7372c3bbef
bpo-33649: Add high-level APIs cheat-sheet (GH-9319)
2018-09-14 15:11:24 -07:00
4e824e9649
bpo-33649: Polish asyncio subprocess and sync docs (GH-9285)
...
Second pass for asyncio subprocess and sync docs.
https://bugs.python.org/issue33649
2018-09-13 18:28:19 -07:00
7c7605ff11
bpo-33649: First asyncio docs improvement pass (GH-9142)
...
Rewritten/updated sections:
* Event Loop APIs
* Transports & Protocols
* Streams
* Exceptions
* Policies
* Queues
* Subprocesses
* Platforms
2018-09-11 09:54:40 -07:00
d2ac400267
bpo-34335: Use async/await syntax in documentation examples (GH-8674)
2018-08-07 13:29:06 -07:00
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
627d2c8e8d
Add the link to asyncio source code in the docs (GH-2373)
2017-07-25 16:03:51 -07:00
6abaed0dda
Correct spelling "instanciate" ( #465 )
2017-03-04 17:51:08 -05:00
f68afd8544
Issue #27700 : Document AbstractEventLoop, not BaseEventLoop.
2016-08-08 09:41:21 -07:00
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
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
5492d358e4
asyncio doc: fix subprocess sections
2015-09-02 15:39:01 +02:00
2249d9f7d6
Make sentence correct English.
2015-05-14 08:50:38 -04:00
83704963c0
asyncio: add a note about (non) thread safety in each class
2015-02-25 14:24:15 +01:00
bdd574d09a
asyncio doc: annotate coroutine on coroutine functions and methods
2015-02-12 22:49:18 +01:00
399c59d7bd
asyncio doc: list limitations to run subprocesses from different threads
2015-01-09 01:32:02 +01:00
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
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
d55b54d5c0
asyncio, tulip issue 190: Process.communicate() now ignores
...
ConnectionResetError too
2014-07-17 13:12:03 +02:00
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
778015b3bc
asyncio: enhance documentation of platform support
2014-07-11 12:13:39 +02:00
aea82293be
Issue #21680 : Document asyncio event loops
2014-07-08 23:42:38 +02:00
6bfd854ea8
Closes #21758 : asyncio doc: mention explicitly that subprocess parameters are
...
bytes or character strings
2014-06-19 12:50:27 +02:00
b0539b27d9
Issue #21485 : remove unnecesary .flush() calls in the asyncio subprocess code
...
example
2014-05-12 23:25:09 +02:00
5280d2e399
asyncio docs: ProactorEventLoop does not support SSL.
2014-05-05 07:34:56 -07:00
984600fba7
Issue #21006 : asyncio doc: reorganize subprocess doc
2014-03-25 09:40:26 +01:00
6bc239619c
Issue #21006 : Fix subprocess example on Windows in asyncio doc
2014-03-21 11:56:40 +01:00
7280486ce3
Close #21005 : Fix documentation of asyncio.subprocess.DEVNULL
2014-03-21 11:44:49 +01:00
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
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
Hugo van Kemenade
Serhiy Storchaka
Marek Marczykowski-Górecki
Mikael Koli
Martin Fischer
Harsh
Ken Jin
Gabriel R F
Andre Delfino
Yurii Karabas
Zackery Spytz
sth
Kyle Stanley
Andrew Svetlov
Dima Tisnek
Victor Stinner
Elvis Pranskevichus
Yury Selivanov
Carol Willing
Mikhail Terekhov
lf
J. W
Guido van Rossum
Georg Brandl
Victor Stinner
R David Murray
