Commit Graph

173 Commits

Author SHA1 Message Date
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 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 ae9d193dc4 #21347: use string not list in shell=True example.
Patch by Akira.
2014-05-14 10:09:52 -04: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 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
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
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
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
Benjamin Peterson 9308c420d3 merge 3.3 2014-01-18 00:47:06 -05:00
Benjamin Peterson eacec1ccff link to builtin open not io.open 2014-01-18 00:47:00 -05:00
Benjamin Peterson d8af6700b9 merge 3.3 (#17814) 2014-01-18 00:46:49 -05:00
Benjamin Peterson 3d8814e1d3 describe type of Popen streams (closes #17814)
Patch more or less by Nikolaus Rath.
2014-01-18 00:45:56 -05:00
Serhiy Storchaka 0e90e99188 Issue #19795: Improved markup of True/False constants. 2013-11-29 12:19:53 +02:00
Serhiy Storchaka fbc1c26803 Issue #19795: Improved markup of True/False constants. 2013-11-29 12:17:13 +02:00
Georg Brandl 5831882c08 merge with 3.3 2013-11-26 08:25:45 +01:00
Georg Brandl 1833ac37b5 Markup fix. 2013-11-26 08:25:24 +01:00
Georg Brandl d476ab1276 merge with 3.3 2013-11-25 08:52:24 +01:00
Georg Brandl 37b70bb908 Closes #19622: clarify message about bufsize changes in 3.2.4 and 3.3.1. 2013-11-25 08:48:37 +01:00
Tim Golden 607981402c Issue #10197 Tweak docs for subprocess.getstatusoutput and align the documentation, the module docstring, and the function docstring. 2013-11-05 12:57:25 +00:00
Tim Golden 2964138371 Issue #10197: Indicate availability of subprocess.get[status]output on Windows and add a note about the effects of universal newlines 2013-11-03 18:25:51 +00:00
Tim Golden 3a2abb5800 Issue #10197: Indicate availability of subprocess.get[status]output on Windows and add a note about the effects of universal newlines 2013-11-03 18:24:50 +00:00
Serhiy Storchaka 96d5c54130 Issue #18757: Improved cross-references in the concurrent package. 2013-08-24 00:27:59 +03:00
Serhiy Storchaka 9e0ae53980 Issue #18757: Improved cross-references in the concurrent package. 2013-08-24 00:23:38 +03:00
Ronald Oussoren 5f8e78545c (3.3->default) Cleanup of documentation change from #17860
Reformulated the textual change, and applied it to the docstring as well.
2013-07-07 09:28:01 +02:00
Ronald Oussoren 385521c90e Cleanup of documentation change from #17860
Reformulated the textual change, and applied it to the docstring as well.
2013-07-07 09:26:45 +02:00
Ronald Oussoren c17d0c2218 (3.3->default) Issue #17860: explicitly mention that std* streams are opened in binary mode by default.
The documentation does mention that the streams are opened in text mode
when univeral_newlines is true, but not that that they are opened in
binary mode when that argument is false and that seems to confuse at
least some users.
2013-07-06 10:25:04 +02:00
Ronald Oussoren a68650553d Issue #17860: explicitly mention that std* streams are opened in binary mode by default.
The documentation does mention that the streams are opened in text mode
when univeral_newlines is true, but not that that they are opened in
binary mode when that argument is false and that seems to confuse at
least some users.
2013-07-06 10:23:59 +02:00
Serhiy Storchaka fcd9f22238 Issue #16624: `subprocess.check_output` now accepts an `input` argument,
allowing the subprocess's stdin to be provided as a (byte) string.
Patch by Zack Weinberg.
2013-04-22 20:20:54 +03:00
Georg Brandl 1bab7134a8 Merge with 3.3. 2013-03-28 13:28:55 +01:00
Georg Brandl 44ea77bd81 Closes #4159: add LaTeX tabular column specifications to tables that otherwise are cut off or have overlapping text. 2013-03-28 13:28:44 +01:00
Gregory P. Smith 4a8ea9e2a6 Fixes issue #17488: Change the subprocess.Popen bufsize parameter default value
from unbuffered (0) to buffering (-1) to match the behavior existing code
expects and match the behavior of the subprocess module in Python 2 to avoid
introducing hard to track down bugs.
2013-03-23 12:00:00 -07:00
Gregory P. Smith a1b9ed32ee Fixes issue #17488: Change the subprocess.Popen bufsize parameter default value
from unbuffered (0) to buffering (-1) to match the behavior existing code
expects and match the behavior of the subprocess module in Python 2 to avoid
introducing hard to track down bugs.
2013-03-23 11:54:22 -07:00
Gregory P. Smith a1ed539268 Fixes issue #17488: Change the subprocess.Popen bufsize parameter default value
from unbuffered (0) to buffering (-1) to match the behavior existing code
expects and match the behavior of the subprocess module in Python 2 to avoid
introducing hard to track down bugs.
2013-03-23 11:44:25 -07:00
Gregory P. Smith e25df59427 merge 2013-03-20 18:32:45 -07:00
Gregory P. Smith 74b24047e3 merge 2013-03-20 18:32:22 -07:00
Gregory P. Smith 1f8a40b81d remove the long obsolete mention of universal newlines mode only being
available when configured at compile time.
2013-03-20 18:32:03 -07:00
Gregory P. Smith 6409989dc8 clarifiy the documentation for issue17285. see also commit
ee30400efceb which updated the docstring.
2013-03-19 23:36:59 -07:00
Gregory P. Smith f16455aa4a clarifiy the documentation for issue17285. see also commit
ee30400efceb which updated the docstring.
2013-03-19 23:36:31 -07:00
Serhiy Storchaka b3f194d109 Issue #16903: Popen.communicate() on Unix now accepts strings when
universal_newlines is true as on Windows.
2013-02-04 16:47:39 +02:00
Tim Golden 9d30698d9e #16921 Since Win9x is no longer supported, CREATE_NEW_CONSOLE is
no longer implied by shell=True
2013-01-11 13:28:31 +00:00
Ezio Melotti 60e22b9c5d #10385: merge with 3.2. 2012-11-08 10:09:06 +02:00
Ezio Melotti 402f75d966 #10385: use the mod role in subprocess docs. 2012-11-08 10:07:10 +02:00
Andrew Svetlov c2415eb7e6 Issue #14616: Mention shlex.quote in subprocess docs.
Patch by Chris Rebert.
2012-10-28 11:42:26 +02:00
Chris Jerdonek c3de6d63cd Merge from 3.2: Fix placement of shell=True warning in subprocess.Popen() docs. 2012-10-10 22:53:35 -07:00
Chris Jerdonek cc32a68216 Fix placement of shell=True warning in subprocess.Popen() docs. 2012-10-10 22:52:22 -07:00