sam-t2/devtools/v9/html/python/lib/template-objects.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<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-pipes.html" />
<link rel="parent" href="module-pipes.html" />
<link rel="next" href="module-posixfile.html" />
<meta name='aesop' content='information' />
<title>8.12.1 Template Objects </title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="8.12 pipes  "
  href="module-pipes.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.12 pipes  "
  href="module-pipes.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="8.13 posixfile  "
  href="module-posixfile.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>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-pipes.html">8.12 pipes  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-pipes.html">8.12 pipes  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-posixfile.html">8.13 posixfile  </A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION00101210000000000000000"></A><A NAME="template-objects"></A>
<BR>
8.12.1 Template Objects
</H2>

<P>
Template objects following methods:

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3032' xml:id='l2h-3032' class="method">reset</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Restore a pipeline template to its initial state.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3033' xml:id='l2h-3033' class="method">clone</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Return a new, equivalent, pipeline template.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3034' xml:id='l2h-3034' class="method">debug</tt></b>(</nobr></td>
  <td><var>flag</var>)</td></tr></table></dt>
<dd>
If <var>flag</var> is true, turn debugging on. Otherwise, turn debugging
off. When debugging is on, commands to be executed are printed, and
the shell is given <code>set -x</code> command to be more verbose.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3035' xml:id='l2h-3035' class="method">append</tt></b>(</nobr></td>
  <td><var>cmd, kind</var>)</td></tr></table></dt>
<dd>
Append a new action at the end. The <var>cmd</var> variable must be a valid
bourne shell command. The <var>kind</var> variable consists of two letters.

<P>
The first letter can be either of <code>'-'</code> (which means the command
reads its standard input), <code>'f'</code> (which means the commands reads
a given file on the command line) or <code>'.'</code> (which means the commands
reads no input, and hence must be first.)

<P>
Similarly, the second letter can be either of <code>'-'</code> (which means
the command writes to standard output), <code>'f'</code> (which means the
command writes a file on the command line) or <code>'.'</code> (which means
the command does not write anything, and hence must be last.)
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3036' xml:id='l2h-3036' class="method">prepend</tt></b>(</nobr></td>
  <td><var>cmd, kind</var>)</td></tr></table></dt>
<dd>
Add a new action at the beginning. See <tt class="method">append()</tt> for explanations
of the arguments.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3037' xml:id='l2h-3037' class="method">open</tt></b>(</nobr></td>
  <td><var>file, mode</var>)</td></tr></table></dt>
<dd>
Return a file-like object, open to <var>file</var>, but read from or
written to by the pipeline.  Note that only one of <code>'r'</code>,
<code>'w'</code> may be given.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3038' xml:id='l2h-3038' class="method">copy</tt></b>(</nobr></td>
  <td><var>infile, outfile</var>)</td></tr></table></dt>
<dd>
Copy <var>infile</var> to <var>outfile</var> through the pipe.
</dl>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="8.12 pipes  "
  href="module-pipes.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.12 pipes  "
  href="module-pipes.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="8.13 posixfile  "
  href="module-posixfile.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>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-pipes.html">8.12 pipes  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-pipes.html">8.12 pipes  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-posixfile.html">8.13 posixfile  </A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>