David Jones
6a61714cde
Replace backquote with command substitution in subprocess doc example (GH-13941)
...
Replace backquotes with POSIXy command substitution in example.
2019-07-16 07:55:19 -07:00
Steve Dower
44f91c388a
bpo-37390: Add audit event table to documentations (GH-14406)
...
Also updates some (unreleased) event names to be consistent with the others.
2019-06-27 10:47:59 -07:00
Steve Dower
60419a7e96
bpo-37363: Add audit events for a range of modules (GH-14301)
2019-06-24 08:42:54 -07:00
Serhiy Storchaka
9e3c452639
bpo-31961: Fix support of path-like executables in subprocess. (GH-5914)
2019-05-28 22:49:35 +03:00
Gregory P. Smith
e883091abf
bpo-36760: Clarify subprocess capture_output docs. (GH-13322)
...
Clarify how to capture stdout and stderr combined into one stream.
2019-05-14 12:33:17 -07:00
Victor Stinner
d7befad328
bpo-35537: Document posix_spawn() change in subprocess (GH-11668)
...
Document that subprocess.Popen no longer raise an exception on error
like missing program on very specific platforms when using
os.posix_spawn() is used.
2019-04-25 14:30:16 +02:00
Gregory P. Smith
7a2e84c348
bpo-33319: Clarify subprocess call docs. (GH-12508)
...
Clarify capturing or suppressing stdout and stderr on the old call APIs.
Do not state that they are equivalent to run() calls when they are not implemented using run as that was misleading. Unlike run they cannot handle stdout or stderr being set to PIPE without a risk of deadlock.
2019-03-23 00:40:28 -07:00
Jules Lasne (jlasne)
7e9ce4c89e
Fixed a missing . and a missing capital letter. (GH-12170)
2019-03-04 20:12:04 +02:00
Harmandeep Singh
47a2fced84
bpo-31450: Remove documentation mentioning that subprocess's child_traceback is available with the parent process (GH-11422)
2019-01-03 11:53:56 -08:00
Jakub Stasiak
7432f0929f
Update subprocess.Popen documentation wrt universal_newlines arg (GH-10337)
...
* universal_newlines defaulting to False would suggest, that not
specifying universal_newlines explicitly and setting text to True
should cause an error, which is not the case.
* The run function didn't have the universal_newlines parameter
documented
* The check_output function didn't have its text parameter documented
2018-11-11 19:40:42 -08:00
Cheryl Sabella
2d6097d027
bpo-11233: Create availability directive for documentation (GH-9692)
...
Replace "Availability: xxx" with ".. availability:: xxx" in the doc.
Original patch by Georg Brandl.
Co-Authored-By: Georg Brandl <georg@python.org>
2018-10-12 16:55:20 +02:00
Xiang Zhang
7d161726e4
Make docs of exitcode for subprocess.getstatusoutput more clear. (GH-9477)
...
Make it more accurate and not limited to UNIX.
2018-09-21 13:18:20 -07:00
Andriy Maletsky
22d131a7f9
Doc: add missing capture_output arg to subprocess.run() signature ( #8374 )
2018-08-09 13:01:54 -07:00
Sergey Fedoseev
f12028809b
versionadded -> versionchanged for all 'X parameter was added' for uniformity. (GH8114)
...
Per the recommendation in our Developer's Guide:
https://devguide.python.org/documenting/#paragraph-level-markup
2018-07-05 17:01:16 -07:00
Tobias Kunze
af1ec97a6d
bpo-32392: Document env keyword argument of subprocess.run() (GH-7289)
2018-06-05 14:41:42 +03:00
Gregory P. Smith
dfb6e54dd8
Clarify fd inheritance when close_fds=False. (GH-6240)
...
Clarify the subprocess documentation.
2018-03-25 10:27:59 -07:00
Serhiy Storchaka
be50a7b627
Revert "bpo-31961: subprocess now accepts path-like args (GH-4329)" ( #5912 )
...
* Revert "bpo-31961: subprocess now accepts path-like args (GH-4329)"
This reverts commit dd42cb71f2 .
2018-02-27 18:03:46 -05:00
Pablo Galindo
e14c010378
bpo-32815: Improve docs on the subprocess API *text* parameter (GH-5622)
...
Describe *text* as an alias for *universal_newlines* in more places that people are likely to be referred to.
2018-02-11 12:58:23 -08:00
Brice Gros
fc1ce810f1
bpo-6135: Fix subprocess.check_output doc to mention changes in 3.6 (GH-5564)
...
Fixes the documentation for `subprocess.check_output()` not mentioning that the encoding and errors parameters were added in 3.6.
2018-02-06 16:46:29 -08:00
Anders Lorentsen
dd42cb71f2
bpo-31961: subprocess now accepts path-like args (GH-4329)
...
Allow os.PathLike args in subprocess APIs.
2018-01-29 23:27:28 -08:00
Bo Bayles
ce0f33d045
bpo-32102 Add "capture_output=True" to subprocess.run (GH-5149)
...
Add "capture_output=True" option to subprocess.run, this is equivalent to
setting stdout=PIPE, stderr=PIPE but is much more readable.
2018-01-29 22:40:39 -08:00
Segev Finer
b2a6083eb0
bpo-19764: Implemented support for subprocess.Popen(close_fds=True) on Windows ( #1218 )
...
Even though Python marks any handles it opens as non-inheritable there
is still a race when using `subprocess.Popen` since creating a process
with redirected stdio requires temporarily creating inheritable handles.
By implementing support for `subprocess.Popen(close_fds=True)` we fix
this race.
In order to implement this we use PROC_THREAD_ATTRIBUTE_HANDLE_LIST
which is available since Windows Vista. Which allows to pass an explicit
list of handles to inherit when creating a process.
This commit also adds `STARTUPINFO.lpAttributeList["handle_list"]`
which can be used to control PROC_THREAD_ATTRIBUTE_HANDLE_LIST
directly.
2017-12-18 10:28:19 +01:00
James
b5d9e08114
bpo-31884 subprocess: add Windows constants for process priority ( #4150 )
2017-11-08 06:18:59 -08:00
andyclegg
7fed7bd8bb
bpo-31756: subprocess.run should alias universal_newlines to text ( #4049 )
...
Improve human friendliness of the Popen API: Add text=False as a
keyword-only argument to subprocess.Popen along with a Popen
attribute .text_mode and set this based on the
encoding/errors/universal_newlines/text arguments.
The universal_newlines parameter and attribute are maintained for
backwards compatibility.
2017-10-22 19:01:19 -07:00
Gregory P. Smith
738b7d9766
bpo-22635: subprocess.getstatusoutput doc update. ( #3398 )
...
The `subprocess.getstatusoutput` API was inadvertently changed
in Python 3.3.4. Document the change, it is too late to undo the
API change now as it has shipped in many stable releases.
2017-09-06 17:39:23 -07:00
Ivan Chernoff
006617ff7d
bpo-31065: Add doc about Popen.poll returning None. ( #3169 )
2017-08-29 07:46:24 -07:00
Alex Gaynor
368cf1d206
bpo-30420: List cwd parameter in subprocess convenience APIs (GH-1685)
...
Partially clarify the subprocess convenience API documentation by
explicitly listing the `cwd` parameter in their abbreviated signatures.
While this has been merged as an improvement, it doesn't fully
resolve the issue, as the `cwd` should also be covered in the
"Frequently Used Arguments" section, and the fact these APIs
pass unlisted keyword arguments down to the lower level APIs
is currently still unclear.
2017-05-26 12:28:17 +10:00
Berker Peksag
f5184745a5
Tweak subprocess.STARTUPINFO documentation ( #347 )
...
* Document STARTUPINFO constructor
* Move versionchanged directive to above of attributes
2017-03-01 12:51:55 +03:00
Sayan Chowdhury
d5c11f7ace
bpo-28624: Add a test that checks that cwd parameter of Popen() accepts PathLike objects ( #157 )
2017-02-26 20:06:10 +03:00
Subhendu Ghosh
ae160bba20
bpo-26128: Added __init__to subprocess.STARTUPINFO ( #171 )
...
The Windows-specific subprocess.STARTUPINFO class now accepts
keyword-only arguments to its constructor to set the various
data attributes.
Patch by Subhendu Ghosh.
2017-02-26 00:59:05 +10:00
Gregory P. Smith
a9ef715b39
issue 20572: remove the deprecation notice for the deleted endtime parameter.
2016-11-20 16:35:30 -08:00
Serhiy Storchaka
7d6dda4b78
Issue #19795 : Improved more markups of True/False.
2016-10-19 18:36:51 +03:00
Serhiy Storchaka
4adf01caae
Issue #19795 : Improved more markups of True/False.
2016-10-19 18:30:05 +03:00
Serhiy Storchaka
0bbf8c08ab
Issue #19795 : Mark up True and False as literal text instead of bold.
2016-10-19 16:44:47 +03:00
Serhiy Storchaka
a97cd2eb17
Issue #19795 : Mark up True and False as literal text instead of bold.
2016-10-19 16:43:42 +03:00
Serhiy Storchaka
989db5c880
Issue #19795 : Mark up None as literal text.
2016-10-19 16:37:13 +03:00
Serhiy Storchaka
ecf41da83e
Issue #19795 : Mark up None as literal text.
2016-10-19 16:29:26 +03:00
Steve Dower
050acaed99
Issue #6135 : Adds encoding and errors parameters to subprocess
2016-09-06 20:16:17 -07:00
Martin Panter
6a09315ff0
Issue #26462 : Merge code block fixes from 3.5
2016-07-29 01:49:37 +00:00
Martin Panter
1050d2d0c7
Issue #26462 : Doc: reduce literal_block warnings, fix syntax highlighting.
...
Patch by Julien Palard.
2016-07-26 11:18:21 +02:00
Terry Jan Reedy
4da945f361
Merge Issue #22558 .
2016-06-11 15:06:08 -04:00
Terry Jan Reedy
fa089b9b0b
Issue #22558 : Add remaining doc links to source code for Python-coded modules.
...
Reformat header above separator line (added if missing) to a common format.
Patch by Yoni Lavi.
2016-06-11 15:02:54 -04:00
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)
3498db1f78
merge 3.5
2016-06-03 00:33:02 +00:00
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)
583a1d6240
Document that CalledProcessError.returncode is the negative
...
signal number when the process died due to a signal.
2016-06-03 00:31:21 +00:00
Victor Stinner
5a48e21ff1
subprocess now emits a ResourceWarning warning
...
Issue #26741 : subprocess.Popen destructor now emits a ResourceWarning warning
if the child process is still running.
2016-05-20 12:11:15 +02: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
R David Murray
d529ebb438
Merge: #24998 : fix cut and paste error in subprocess example.
2015-09-04 10:02:27 -04:00
R David Murray
17227a7334
#24998 : fix cut and paste error in subprocess example.
2015-09-04 10:01:19 -04:00
Berker Peksag
bf1d4b6d7d
Issue #24420 : Fix documentation regression introduced by f0a00ee094ff.
...
These functions accept same arguments as subprocess.Popen().
Patch by Martin Panter.
2015-07-25 14:27:07 +03:00
Benjamin Peterson
ef9ffcbcd4
properly wrap
2015-04-14 22:12:14 -04:00