File: Camelot.camelot.bin.camelot_manage.Shell-class.html

package info (click to toggle)
camelot 10.07.02-c2-4
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 35,864 kB
  • ctags: 28,700
  • sloc: python: 14,067; makefile: 125; sh: 32
file content (304 lines) | stat: -rw-r--r-- 13,548 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>Camelot.camelot.bin.camelot_manage.Shell</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="Camelot.camelot-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://www.python-camelot.com">Camelot</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Package&nbsp;Camelot ::
        <a href="Camelot.camelot-module.html">Package&nbsp;camelot</a> ::
        <a href="Camelot.camelot.bin-module.html">Package&nbsp;bin</a> ::
        <a href="Camelot.camelot.bin.camelot_manage-module.html">Module&nbsp;camelot_manage</a> ::
        Class&nbsp;Shell
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="Camelot.camelot.bin.camelot_manage.Shell-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Shell</h1><p class="nomargin-top"><span class="codelink"><a href="Camelot.camelot.bin.camelot_manage-pysrc.html#Shell">source&nbsp;code</a></span></p>
<center>
<center>  <map id="uml_class_diagram_for_camelot__23" name="uml_class_diagram_for_camelot__23">
<area shape="rect" href="javascript:void(0);" title="Compile and run some source in the interpreter." alt="" coords="17,36,364,55"/>
<area shape="rect" href="javascript:void(0);" title="Execute a code object." alt="" coords="17,55,364,73"/>
<area shape="rect" href="javascript:void(0);" title="Display the syntax error that just occurred." alt="" coords="17,73,364,92"/>
<area shape="rect" href="javascript:void(0);" title="Display the exception that just occurred." alt="" coords="17,92,364,111"/>
<area shape="rect" href="javascript:void(0);" title="Write a string." alt="" coords="17,111,364,129"/>
<area shape="rect" href="javascript:void(0);" title="Base class for InteractiveConsole." alt="" coords="16,11,365,131"/>
<area shape="rect" href="javascript:void(0);" title="Reset the input buffer." alt="" coords="109,185,272,204"/>
<area shape="rect" href="javascript:void(0);" title="Closely emulate the interactive Python console." alt="" coords="109,204,272,223"/>
<area shape="rect" href="javascript:void(0);" title="Write a prompt and read a line." alt="" coords="109,223,272,241"/>
<area shape="rect" href="javascript:void(0);" title="Closely emulate the behavior of the interactive Python interpreter." alt="" coords="108,160,273,243"/>
<area shape="rect" href="Camelot.camelot.bin.camelot_manage.Shell-class.html#__init__" title="Constructor." alt="" coords="123,297,259,316"/>
<area shape="rect" href="Camelot.camelot.bin.camelot_manage.Shell-class.html#get_output" title="Camelot.camelot.bin.camelot_manage.Shell.get_output" alt="" coords="123,316,259,335"/>
<area shape="rect" href="Camelot.camelot.bin.camelot_manage.Shell-class.html#return_output" title="Camelot.camelot.bin.camelot_manage.Shell.return_output" alt="" coords="123,335,259,353"/>
<area shape="rect" href="Camelot.camelot.bin.camelot_manage.Shell-class.html#push" title="Push a line to the interpreter." alt="" coords="123,353,259,372"/>
<area shape="rect" href="Camelot.camelot.bin.camelot_manage.Shell-class.html" title="Wrapper around Python that can filter input/output to the shell" alt="" coords="121,272,260,373"/>
</map>
  <img src="uml_class_diagram_for_camelot__23.gif" alt='' usemap="#uml_class_diagram_for_camelot__23" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
Wrapper around Python that can filter input/output to the shell

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Instance Methods</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="Camelot.camelot.bin.camelot_manage.Shell-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">locals</span>=<span class="summary-sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>)</span><br />
      Constructor.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Camelot.camelot.bin.camelot_manage-pysrc.html#Shell.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="get_output"></a><span class="summary-sig-name">get_output</span>(<span class="summary-sig-arg">self</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Camelot.camelot.bin.camelot_manage-pysrc.html#Shell.get_output">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="return_output"></a><span class="summary-sig-name">return_output</span>(<span class="summary-sig-arg">self</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Camelot.camelot.bin.camelot_manage-pysrc.html#Shell.return_output">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="Camelot.camelot.bin.camelot_manage.Shell-class.html#push" class="summary-sig-name">push</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">line</span>)</span><br />
      Push a line to the interpreter.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Camelot.camelot.bin.camelot_manage-pysrc.html#Shell.push">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>code.InteractiveConsole</code></b>:
      <code>interact</code>,
      <code>raw_input</code>,
      <code>resetbuffer</code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>code.InteractiveInterpreter</code></b>:
      <code>runcode</code>,
      <code>runsource</code>,
      <code>showsyntaxerror</code>,
      <code>showtraceback</code>,
      <code>write</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">locals</span>=<span class="sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Camelot.camelot.bin.camelot_manage-pysrc.html#Shell.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Constructor.</p>
<p>The optional locals argument will be passed to the
InteractiveInterpreter base class.</p>
<p>The optional filename argument should specify the (file)name
of the input stream; it will show up in tracebacks.</p>
  <dl class="fields">
    <dt>Overrides:
        code.InteractiveInterpreter.__init__
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="push"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">push</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">line</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Camelot.camelot.bin.camelot_manage-pysrc.html#Shell.push">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Push a line to the interpreter.</p>
<p>The line should not have a trailing newline; it may have
internal newlines.  The line is appended to a buffer and the
interpreter's runsource() method is called with the
concatenated contents of the buffer as source.  If this
indicates that the command was executed or invalid, the buffer
is reset; otherwise, the command is incomplete, and the buffer
is left as it was after the line was appended.  The return
value is 1 if more input is required, 0 if the line was dealt
with in some way (this is the same as runsource()).</p>
  <dl class="fields">
    <dt>Overrides:
        code.InteractiveConsole.push
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="Camelot.camelot-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://www.python-camelot.com">Camelot</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Sat Jun 12 15:41:32 2010
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>