Issue #15501: Document exception classes in subprocess module.

Initial patch by Anton Barkovsky.
This commit is contained in:
Andrew Svetlov 2012-08-09 15:11:45 +03:00
parent e939f383c1
commit b4a09abfce
2 changed files with 49 additions and 0 deletions

View File

@ -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

View File

@ -56,6 +56,7 @@ Matt Bandy
Michael J. Barber
Nicolas Bareil
Chris Barker
Anton Barkovsky
Nick Barnes
Quentin Barnes
David Barnett