Commit Graph

210 Commits

Author SHA1 Message Date
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
Gregory P. Smith 6e73000723 Add a subprocess.run() function than returns a CalledProcess instance for a
more consistent API than the existing call* functions.
(enhancement from issue 23342)
2015-04-14 16:14:25 -07:00
Victor Stinner 395c73436e Merge 3.4 (asyncio doc) 2014-10-14 00:53:13 +02: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
Antoine Pitrou 6e311aa748 Issue #21332: Ensure that ``bufsize=1`` in subprocess.Popen() selects line buffering, rather than block buffering. 2014-09-21 21:15:42 +02:00
Antoine Pitrou afe8d0646c Issue #21332: Ensure that ``bufsize=1`` in subprocess.Popen() selects line buffering, rather than block buffering. 2014-09-21 21:10:56 +02:00
R David Murray 37f524f001 Merge: #21347: use string not list in shell=True example. 2014-05-14 10:10:14 -04:00
R David Murray ae9d193dc4 #21347: use string not list in shell=True example.
Patch by Akira.
2014-05-14 10:09:52 -04:00
Gregory P. Smith 3a17e21755 merge from 3.4 - clean up the subprocess docs warning-soup and
s/Unix/POSIX/.
2014-05-11 13:29:36 -07:00
Gregory P. Smith 8e0aa051e6 Change all references to Unix to POSIX in the subprocess docs. It's
more accurate and sounds less like a strange tale of yore.
2014-05-11 13:28:35 -07:00
Gregory P. Smith 6436cba9db Remove the warning-soup from the subprocess documentation by adding
a Security Considerations section as preferred by both the devguide
and documentation users who do not wish to go insane.
2014-05-11 13:26:21 -07:00
Gregory P. Smith 30a6df5b64 Document the subprocess Popen.args attribute (issue21353) 2014-04-29 11:34:15 -07:00
Gregory P. Smith d8ea56d26d Document the subprocess Popen.args attribute (issue21353) 2014-04-29 11:33:56 -07:00
Gregory P. Smith 024c5eecbc Document the subprocess Popen.args attribute (issue21353) 2014-04-29 11:33:23 -07:00
Andrew Kuchling 4f7b0c3c35 #10481: describe universal_newlines' effect on communicate()/check_output() output (alternately bytes or strings)
Patch by Sam Kimbrel.
2014-04-14 15:08:18 -04:00
Larry Hastings 3732ed2414 Merge in all documentation changes since branching 3.4.0rc1. 2014-03-15 21:13:56 -07:00
Benjamin Peterson 21317b654e merge 3.3 (#19060) 2014-03-12 21:42:04 -05:00
Benjamin Peterson 5eea8a7780 remove unnecessary word (closes #19060)
Patch by Anastasia Filatova.
2014-03-12 21:41:35 -05:00
Benjamin Peterson 605765fa32 merge 3.3 (#19060) 2014-03-12 21:42:04 -05:00
R David Murray 48b6b70b95 #10197: Update get[status]output versionchanged with actual version.
This was perhaps on the border between a bug fix and a feature since
the Python3 docs did not originally say it was unix only.  However, the
functions never worked anywhere but unix, and the docs were changed to
say it was unix only well before the windows support was added.

Unfortunately, windows support was added in 3.3.4 as well as 3.4.
That leaves us in the uncomfortable position of needing the tag to say
"version changed: 3.3.4" :(
2014-03-07 20:04:41 -05:00
R David Murray 95b696a010 #10197: Update get[status]output versionchanged with actual version.
This was perhaps on the border between a bug fix and a feature since
the Python3 docs did not originally say it was unix only.  However, the
functions never worked anywhere but unix, and the docs were changed to
say it was unix only well before the windows support was added.

Unfortunately, windows support was added in 3.3.4 as well as 3.4.
That leaves us in the uncomfortable position of needing the tag to say
"version changed: 3.3.4" :(
2014-03-07 20:04:17 -05:00
Victor Stinner 07171242d5 subprocess.Popen.wait doc: mention asyncio to avoid busy loop 2014-02-24 13:18:47 +01:00
Gregory P. Smith bbe3335f65 Deprecate Popen.wait()'s undocumented endtime parameter. issue20572. 2014-02-11 09:21:03 -08:00
Benjamin Peterson 3c16c1d821 merge 3.3 2014-01-18 00:49:30 -05:00
Benjamin Peterson af69fe2311 rm extra whitespace 2014-01-18 00:49:04 -05:00