mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-12-04 00:30:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

New subprocess utility function: check_call. Closes #1071764.

Browse source
This commit is contained in:
Peter Astrand 2005-01-01 09:36:35 +00:00
parent ed2dbe3f33
commit 454f76711c
3 changed files with 72 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

18
Doc/lib/libsubprocess.tex
View file

@ -120,7 +120,7 @@ process. (Windows only)
\subsubsection{Convenience Functions}
This module also defines one shortcut function:
This module also defines two shortcut functions:
\begin{funcdesc}{call}{*popenargs, **kwargs}
Run command with arguments. Wait for command to complete, then
@ -133,6 +133,18 @@ The arguments are the same as for the Popen constructor. Example:
\end{verbatim}
\end{funcdesc}
\begin{funcdesc}{check_call}{*popenargs, **kwargs}
Run command with arguments. Wait for command to complete. If the exit
code was zero then return, otherwise raise CalledProcessError. The
CalledProcessError object will have the return code in the
\member{errno} attribute.
The arguments are the same as for the Popen constructor. Example:
\begin{verbatim}
check_call(["ls", "-l"])
\end{verbatim}
\end{funcdesc}
\subsubsection{Exceptions}
@ -149,6 +161,10 @@ should prepare for \exception{OSError} exceptions.
A \exception{ValueError} will be raised if \class{Popen} is called
with invalid arguments.
check_call() will raise \exception{CalledProcessError}, which is a
subclass of \exception{OSError}, if the called process returns a
non-zero return code.
\subsubsection{Security}