<!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
<link rel=
"STYLESHEET" href=
"lib.css" type='text/css'
/>
<link rel=
"SHORTCUT ICON" href=
"../icons/pyfav.png" type=
"image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index'
/>
<link rel=
"first" href=
"lib.html" title='Python Library Reference'
/>
<link rel='contents' href='contents.html'
title=
"Contents" />
<link rel='index' href='genindex.html' title='Index'
/>
<link rel='last' href='about.html' title='About this document...'
/>
<link rel='help' href='about.html' title='About this document...'
/>
<link rel=
"prev" href=
"module-syslog.html" />
<link rel=
"parent" href=
"unix.html" />
<link rel=
"next" href=
"module-pdb.html" />
<meta name='aesop' content='information'
/>
<title>8.17 commands -- Utilities for running commands
</title>
<div id='top-navigation-panel' xml:id='top-navigation-panel'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"8.16 syslog "
href=
"module-syslog.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"8. Unix Specific Services"
href=
"unix.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"9. The Python Debugger"
href=
"module-pdb.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"module-syslog.html">8.16 syslog
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"unix.html">8. Unix Specific Services
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"module-pdb.html">9. The Python Debugger
</A>
<!--End of Navigation Panel-->
<H1><A NAME=
"SECTION00101700000000000000000">
8.17 <tt class=
"module">commands
</tt> --
Utilities for running commands
</A>
<A NAME=
"module-commands"></A>
<p class=
"availability">Availability:
<span
class=
"platform">Unix
</span>.
</p>
The
<tt class=
"module">commands
</tt> module contains wrapper functions for
<tt class=
"function">os.popen()
</tt> which take a system command as a string and
return any output generated by the command and, optionally, the exit
The
<tt class=
"module">commands
</tt> module defines the following functions:
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3087' xml:id='l2h-
3087'
class=
"function">getstatusoutput
</tt></b>(
</nobr></td>
<td><var>cmd
</var>)
</td></tr></table></dt>
Execute the string
<var>cmd
</var> in a shell with
<tt class=
"function">os.popen()
</tt> and
return a
2-tuple
<code>(
<var>status
</var>,
<var>output
</var>)
</code>.
<var>cmd
</var> is
actually run as
<code>{
<var>cmd
</var> ; }
2>&1</code>, so that the returned
output will contain output or error messages. A trailing newline is
stripped from the output. The exit status for the command can be
interpreted according to the rules for the C function
<tt class=
"cfunction">wait()
</tt>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3088' xml:id='l2h-
3088'
class=
"function">getoutput
</tt></b>(
</nobr></td>
<td><var>cmd
</var>)
</td></tr></table></dt>
Like
<tt class=
"function">getstatusoutput()
</tt>, except the exit status is ignored
and the return value is a string containing the command's output.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3089' xml:id='l2h-
3089'
class=
"function">getstatus
</tt></b>(
</nobr></td>
<td><var>file
</var>)
</td></tr></table></dt>
Return the output of
"<tt class="samp
">ls -ld <var>file</var></tt>" as a string. This
function uses the
<tt class=
"function">getoutput()
</tt> function, and properly
escapes backslashes and dollar signs in the argument.
<div class=
"verbatim"><pre>
>>> import commands
>>> commands.getstatusoutput('ls /bin/ls')
>>> commands.getstatusoutput('cat /bin/junk')
(
256, 'cat: /bin/junk: No such file or directory')
>>> commands.getstatusoutput('/bin/junk')
(
256, 'sh: /bin/junk: not found')
>>> commands.getoutput('ls /bin/ls')
>>> commands.getstatus('/bin/ls')
'-rwxr-xr-x
1 root
13352 Oct
14 1994 /bin/ls'
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"8.16 syslog "
href=
"module-syslog.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"8. Unix Specific Services"
href=
"unix.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"9. The Python Debugger"
href=
"module-pdb.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"module-syslog.html">8.16 syslog
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"unix.html">8. Unix Specific Services
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"module-pdb.html">9. The Python Debugger
</A>
<span class=
"release-info">Release
2.4.2, documentation updated on
28 September
2005.
</span>
<!--End of Navigation Panel-->
See
<i><a href=
"about.html">About this document...
</a></i> for information on suggesting changes.