[issue14966] Fully document subprocess.CalledProcessError
New submission from Nick Coghlan <ncoghlan@gmail.com>: CalledProcessError provides a nice encapsulation for a returncode, the original command and any partial output. The API should be officially documented so that third party subprocess.Popen convenience wrappers can use it easily. ---------- assignee: docs@python components: Documentation keywords: easy messages: 161984 nosy: docs@python, ncoghlan priority: normal severity: normal status: open title: Fully document subprocess.CalledProcessError type: enhancement versions: Python 2.7, Python 3.2, Python 3.3 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14966> _______________________________________
Changes by Chris Rebert <pybugs@rebertia.com>: ---------- nosy: +cvrebert _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14966> _______________________________________
Michael Driscoll <mike@pythonlibrary.org> added the comment: I don't see the error, TimeoutExpired, documented either. At least the doc page mentions CalledProcessError a couple times. Do we want to use the docstring for CalledProcessError for the documentation page? Where on the page would it go? I assume we'd want an example showing how to use it? ---------- nosy: +michael.driscoll _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14966> _______________________________________
Changes by Anton Barkovsky <swarmer.pm@gmail.com>: ---------- nosy: +anton.barkovsky _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14966> _______________________________________
Andrew Svetlov added the comment: Documented in #15501. I like to close this issue as duplicate. If anybody don't agree with closing feel free to reopen this one. ---------- nosy: +asvetlov resolution: -> duplicate stage: -> committed/rejected status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14966> _______________________________________
Changes by Chris Rebert <pybugs@rebertia.com>: ---------- nosy: +cvrebert _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14966> _______________________________________
Michael Driscoll <mike@pythonlibrary.org> added the comment: I don't see the error, TimeoutExpired, documented either. At least the doc page mentions CalledProcessError a couple times. Do we want to use the docstring for CalledProcessError for the documentation page? Where on the page would it go? I assume we'd want an example showing how to use it? ---------- nosy: +michael.driscoll _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14966> _______________________________________
Changes by Anton Barkovsky <swarmer.pm@gmail.com>: ---------- nosy: +anton.barkovsky _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14966> _______________________________________
Andrew Svetlov added the comment: Documented in #15501. I like to close this issue as duplicate. If anybody don't agree with closing feel free to reopen this one. ---------- nosy: +asvetlov resolution: -> duplicate stage: -> committed/rejected status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14966> _______________________________________
participants (5)
-
Andrew Svetlov -
Anton Barkovsky
-
Chris Rebert
-
Michael Driscoll
-
Nick Coghlan