~ubuntu-branches/ubuntu/karmic/cedar-backup2/karmic

« back to all changes in this revision

Viewing changes to doc/interface/public/subprocess.Popen-class.html

  • Committer: Bazaar Package Importer
  • Author(s): Kenneth J. Pronovici
  • Date: 2006-12-18 22:59:17 UTC
  • mfrom: (1.1.5 upstream)
  • Revision ID: james.westby@ubuntu.com-20061218225917-gwos76xdo3jewj6i
Tags: 2.9.0-1
* New upstream release.
  - Provide way to configure dev=/dev/cdrw and the like (closes: #403546).
  - Fix, clean up and reorganize parts of user manual (closes: #403448, #403662).

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 
3
          "DTD/xhtml1-transitional.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<head>
 
6
  <title>subprocess.Popen</title>
 
7
  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
 
8
</head>
 
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
 
10
      alink="#204080">
 
11
 
 
12
<!-- =========== START OF NAVBAR =========== -->
 
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
14
  <tr valign="center">
 
15
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="CedarBackup2-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
16
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
17
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
18
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
19
    <th class="navbar" align="right" width="100%">
 
20
      <table border="0" cellpadding="0" cellspacing="0">
 
21
      <tr><th class="navbar" align="center">
 
22
        <p class="nomargin">
 
23
          <a class="navbar" target="_top" href="http://cedar-solutions.com/software/cedar-backup">CedarBackup2</a>
 
24
      </p></th></tr></table>
 
25
    </th>
 
26
  </tr>
 
27
</table>
 
28
<table width="100%" cellpadding="0" cellspacing="0">
 
29
  <tr valign="top">
 
30
    <td width="100%">
 
31
      <font size="-1"><b class="breadcrumbs">
 
32
        Module&nbsp;subprocess ::
 
33
        Class&nbsp;Popen
 
34
      </b></font></br>
 
35
    </td>
 
36
    <td><table cellpadding="0" cellspacing="0">
 
37
      <tr><td align="right"><font size="-2">[<a href="../private/subprocess.Popen-class.html">show&nbsp;private</a>&nbsp;|&nbsp;hide&nbsp;private]</font></td></tr>
 
38
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="subprocess.Popen-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
 
39
    </table></td>
 
40
</tr></table>
 
41
 
 
42
<!-- =========== START OF CLASS DESCRIPTION =========== -->
 
43
<h2 class="class">Type Popen</h2>
 
44
 
 
45
<pre class="base-tree">
 
46
<a href="__builtin__.object-class.html"><code>object</code></a> --+
 
47
         |
 
48
        <b>Popen</b>
 
49
</pre><br />
 
50
 
 
51
<dl><dt><b>Known Subclasses:</b></dt>
 
52
<dd>
 
53
    <a href="CedarBackup2.util.Pipe-class.html"><code>Pipe</code></a></dd></dl>
 
54
 
 
55
<hr/>
 
56
 
 
57
 
 
58
<!-- =========== START OF METHOD SUMMARY =========== -->
 
59
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
60
<tr bgcolor="#70b0f0" class="summary">
 
61
  <th colspan="2">Method Summary</th></tr>
 
62
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
63
  <td><code><span class="summary-sig"><a href="subprocess.Popen-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
 
64
          <span class=summary-sig-arg>args</span>,
 
65
          <span class=summary-sig-arg>bufsize</span>,
 
66
          <span class=summary-sig-arg>executable</span>,
 
67
          <span class=summary-sig-arg>stdin</span>,
 
68
          <span class=summary-sig-arg>stdout</span>,
 
69
          <span class=summary-sig-arg>stderr</span>,
 
70
          <span class=summary-sig-arg>preexec_fn</span>,
 
71
          <span class=summary-sig-arg>close_fds</span>,
 
72
          <span class=summary-sig-arg>shell</span>,
 
73
          <span class=summary-sig-arg>cwd</span>,
 
74
          <span class=summary-sig-arg>env</span>,
 
75
          <span class=summary-sig-arg>universal_newlines</span>,
 
76
          <span class=summary-sig-arg>startupinfo</span>,
 
77
          <span class=summary-sig-arg>creationflags</span>)</span></code>
 
78
<br />
 
79
Create new Popen instance.</td></tr>
 
80
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
81
  <td><code><span class="summary-sig"><a href="subprocess.Popen-class.html#communicate" class="summary-sig-name"><code>communicate</code></a>(<span class=summary-sig-arg>self</span>,
 
82
          <span class=summary-sig-arg>input</span>)</span></code>
 
83
<br />
 
84
Interact with process: Send data to stdin.</td></tr>
 
85
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
86
  <td><code><span class="summary-sig"><a href="subprocess.Popen-class.html#poll" class="summary-sig-name"><code>poll</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
87
<br />
 
88
Check if child process has terminated.</td></tr>
 
89
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
90
  <td><code><span class="summary-sig"><a href="subprocess.Popen-class.html#wait" class="summary-sig-name"><code>wait</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
91
<br />
 
92
Wait for child process to terminate.</td></tr>
 
93
<tr bgcolor="#e8f0f8" class="group">
 
94
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from object</th></tr>
 
95
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
96
  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
 
97
<br />
 
98
x.__delattr__('name') &lt;==&gt; del x.name</td></tr>
 
99
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
100
  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
 
101
<br />
 
102
x.__getattribute__('name') &lt;==&gt; x.name</td></tr>
 
103
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
104
  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
 
105
<br />
 
106
x.__hash__() &lt;==&gt; hash(x)</td></tr>
 
107
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
108
  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>,
 
109
          <span class=summary-sig-arg>S</span>,
 
110
          <span class="summary-sig-vararg">...</span>)</span></code>
 
111
<br />
 
112
T.__new__(S, ...) -&gt; a new object with type S, a subtype of T</td></tr>
 
113
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
114
  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
 
115
<br />
 
116
helper for pickle</td></tr>
 
117
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
118
  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
 
119
<br />
 
120
helper for pickle</td></tr>
 
121
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
122
  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
 
123
<br />
 
124
x.__repr__() &lt;==&gt; repr(x)</td></tr>
 
125
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
126
  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
 
127
<br />
 
128
x.__setattr__('name', value) &lt;==&gt; x.name = value</td></tr>
 
129
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
130
  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
 
131
<br />
 
132
x.__str__() &lt;==&gt; str(x)</td></tr>
 
133
</table><br />
 
134
 
 
135
 
 
136
<!-- =========== START OF METHOD DETAILS =========== -->
 
137
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
138
<tr bgcolor="#70b0f0" class="details">
 
139
  <th colspan="2">Method Details</th></tr>
 
140
</table>
 
141
 
 
142
<a name="__init__"></a>
 
143
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
144
  <h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
 
145
          <span class=sig-arg>args</span>,
 
146
          <span class=sig-arg>bufsize</span>=<span class=sig-default>0</span>,
 
147
          <span class=sig-arg>executable</span>=<span class=sig-default>None</span>,
 
148
          <span class=sig-arg>stdin</span>=<span class=sig-default>None</span>,
 
149
          <span class=sig-arg>stdout</span>=<span class=sig-default>None</span>,
 
150
          <span class=sig-arg>stderr</span>=<span class=sig-default>None</span>,
 
151
          <span class=sig-arg>preexec_fn</span>=<span class=sig-default>None</span>,
 
152
          <span class=sig-arg>close_fds</span>=<span class=sig-default>False</span>,
 
153
          <span class=sig-arg>shell</span>=<span class=sig-default>False</span>,
 
154
          <span class=sig-arg>cwd</span>=<span class=sig-default>None</span>,
 
155
          <span class=sig-arg>env</span>=<span class=sig-default>None</span>,
 
156
          <span class=sig-arg>universal_newlines</span>=<span class=sig-default>False</span>,
 
157
          <span class=sig-arg>startupinfo</span>=<span class=sig-default>None</span>,
 
158
          <span class=sig-arg>creationflags</span>=<span class=sig-default>0</span>)</span>
 
159
    <br /><i>(Constructor)</i>
 
160
  </h3>
 
161
  Create new Popen instance.
 
162
  <dl><dt></dt><dd>
 
163
    <dl><dt><b>Overrides:</b></dt>
 
164
      <dd><a href="__builtin__.object-class.html#__init__"><code>__builtin__.object.__init__</code></a></dd>
 
165
    </dl>
 
166
  </dd></dl>
 
167
</td></tr></table>
 
168
 
 
169
<a name="communicate"></a>
 
170
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
171
  <h3><span class="sig"><span class="sig-name">communicate</span>(<span class=sig-arg>self</span>,
 
172
          <span class=sig-arg>input</span>=<span class=sig-default>None</span>)</span>
 
173
  </h3>
 
174
  <p>Interact with process: Send data to stdin. Read data from stdout and 
 
175
  stderr, until end-of-file is reached. Wait for process to terminate. 
 
176
  The optional input argument should be a string to be sent to the child 
 
177
  process, or None, if no data should be sent to the child.</p>
 
178
  communicate() returns a tuple (stdout, stderr).
 
179
  <dl><dt></dt><dd>
 
180
  </dd></dl>
 
181
</td></tr></table>
 
182
 
 
183
<a name="poll"></a>
 
184
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
185
  <h3><span class="sig"><span class="sig-name">poll</span>(<span class=sig-arg>self</span>)</span>
 
186
  </h3>
 
187
  Check if child process has terminated. Returns returncode 
 
188
  attribute.
 
189
  <dl><dt></dt><dd>
 
190
  </dd></dl>
 
191
</td></tr></table>
 
192
 
 
193
<a name="wait"></a>
 
194
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
195
  <h3><span class="sig"><span class="sig-name">wait</span>(<span class=sig-arg>self</span>)</span>
 
196
  </h3>
 
197
  Wait for child process to terminate. Returns returncode 
 
198
  attribute.
 
199
  <dl><dt></dt><dd>
 
200
  </dd></dl>
 
201
</td></tr></table>
 
202
<br />
 
203
 
 
204
 
 
205
<!-- =========== START OF NAVBAR =========== -->
 
206
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
207
  <tr valign="center">
 
208
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="CedarBackup2-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
209
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
210
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
211
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
212
    <th class="navbar" align="right" width="100%">
 
213
      <table border="0" cellpadding="0" cellspacing="0">
 
214
      <tr><th class="navbar" align="center">
 
215
        <p class="nomargin">
 
216
          <a class="navbar" target="_top" href="http://cedar-solutions.com/software/cedar-backup">CedarBackup2</a>
 
217
      </p></th></tr></table>
 
218
    </th>
 
219
  </tr>
 
220
</table>
 
221
 
 
222
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
223
  <tr>
 
224
    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Mon Dec 18 22:53:31 2006</font></td>
 
225
    <td align="right"><a href="http://epydoc.sourceforge.net"
 
226
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
 
227
  </tr>
 
228
</table>
 
229
</body>
 
230
</html>