From b4a09abfce9a8d38dbd4a8be38ca68cfe22e82f9 Mon Sep 17 00:00:00 2001 From: Andrew Svetlov Date: Thu, 9 Aug 2012 15:11:45 +0300 Subject: Issue #15501: Document exception classes in subprocess module. Initial patch by Anton Barkovsky. --- Doc/library/subprocess.rst | 48 ++++++++++++++++++++++++++++++++++++++++++++++ Misc/ACKS | 1 + 2 files changed, 49 insertions(+) diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst index a8d65b2..a67bf64 100644 --- a/Doc/library/subprocess.rst +++ b/Doc/library/subprocess.rst @@ -208,6 +208,54 @@ use cases, the underlying :class:`Popen` interface can be used directly. 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 index b255ed2..4dce609 100644 --- a/Misc/ACKS +++ b/Misc/ACKS @@ -56,6 +56,7 @@ Matt Bandy Michael J. Barber Nicolas Bareil Chris Barker +Anton Barkovsky Nick Barnes Quentin Barnes David Barnett -- cgit v0.12