[Python-checkins] cpython: Issue #15501: Document exception classes in subprocess module.

Thu Aug 9 14:28:00 CEST 2012

http://hg.python.org/cpython/rev/b863e231ad9f
changeset: 78475:b863e231ad9f
user: Andrew Svetlov <andrew.svetlov at gmail.com>
date: Thu Aug 09 15:11:45 2012 +0300
summary:
 Issue #15501: Document exception classes in subprocess module.
Initial patch by Anton Barkovsky.
files:
 Doc/library/subprocess.rst | 48 ++++++++++++++++++++++++++
 Misc/ACKS | 1 +
 2 files changed, 49 insertions(+), 0 deletions(-)

diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst
--- a/Doc/library/subprocess.rst
+++ b/Doc/library/subprocess.rst
@@ -208,6 +208,54 @@
 output.
 
 
+.. exception:: SubprocessError
+
+ Base class for all other exceptions from this module.
+
+ .. versionadded:: 3.3
+
+
+.. exception:: TimeoutExpired
+
+ Subclass of :exc:`SubprocessError`, raised when a timeout expires
+ while waiting for a child process.
+
+ .. attribute:: cmd
+
+ Command that was used to spawn the child process.
+
+ .. attribute:: timeout
+
+ Timeout in seconds.
+
+ .. attribute:: output
+
+ Output of the child process if this exception is raised by
+ :func:`check_output`. Otherwise, ``None``.
+
+ .. versionadded:: 3.3
+
+
+.. exception:: CalledProcessError
+
+ Subclass of :exc:`SubprocessError`, raised when a process run by
+ :func:`check_call` or :func:`check_output` returns a non-zero exit status.
+
+ .. attribute:: returncode
+
+ Exit status of the child process.
+
+ .. attribute:: cmd
+
+ Command that was used to spawn the child process.
+
+ .. attribute:: output
+
+ Output of the child process if this exception is raised by
+ :func:`check_output`. Otherwise, ``None``.
+
+
+
 .. _frequently-used-arguments:
 
 Frequently Used Arguments
diff --git a/Misc/ACKS b/Misc/ACKS
--- a/Misc/ACKS
+++ b/Misc/ACKS
@@ -56,6 +56,7 @@
 Michael J. Barber
 Nicolas Bareil
 Chris Barker
+Anton Barkovsky
 Nick Barnes
 Quentin Barnes
 David Barnett
-- 
Repository URL: http://hg.python.org/cpython
