summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorAntoine Pitrou <solipsis@pitrou.net>2010-06-02 17:08:47 (GMT)
committerAntoine Pitrou <solipsis@pitrou.net>2010-06-02 17:08:47 (GMT)
commitc395545a4ab4b4760c0472af74f526f405389864 (patch)
tree96d56e0872bef4c0b28ad25a76bf391ddd13391b /Doc/library
parent3b4849a21d691bf95b9d4d4171b60c496e109ae6 (diff)
downloadcpython-c395545a4ab4b4760c0472af74f526f405389864.zip
cpython-c395545a4ab4b4760c0472af74f526f405389864.tar.gz
cpython-c395545a4ab4b4760c0472af74f526f405389864.tar.bz2
Issue #8873: add a documentation note about possible performance issues with the
default of unbuffered IO in subprocess.Popen.
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/subprocess.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst
index 19a8b6b..b5e769c 100644
--- a/Doc/library/subprocess.rst
+++ b/Doc/library/subprocess.rst
@@ -94,6 +94,12 @@ This module defines one class called :class:`Popen`:
size. A negative *bufsize* means to use the system default, which usually means
fully buffered. The default value for *bufsize* is :const:`0` (unbuffered).
+ .. note::
+
+ If you experience performance issues, it is recommended that you try to
+ enable buffering by setting *bufsize* to either -1 or a large enough
+ positive value (such as 4096).
+
The *executable* argument specifies the program to execute. It is very seldom
needed: Usually, the program to execute is defined by the *args* argument. If
``shell=True``, the *executable* argument specifies which shell to use. On Unix,