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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
|
<?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>epydoc.cli.UnifiedProgressConsoleLogger</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> <a
href="epydoc-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </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://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="epydoc-module.html">Package epydoc</a> ::
<a href="epydoc.cli-module.html">Module cli</a> ::
Class UnifiedProgressConsoleLogger
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="epydoc.cli.UnifiedProgressConsoleLogger-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class UnifiedProgressConsoleLogger</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.cli-pysrc.html#UnifiedProgressConsoleLogger">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_epydoc_c_3" name="uml_class_diagram_for_epydoc_c_3">
<area shape="rect" href="epydoc.cli.ConsoleLogger-class.html#reported_message_levels" title="This set contains all the message levels (WARNING, ERROR, etc) that have been reported." alt="" coords="88,103,280,121" />
<area shape="rect" href="epydoc.cli.ConsoleLogger-class.html#suppressed_docstring_warning" title="This variable will be incremented once every time a docstring warning is reported tothe logger, but the verbosity level is too low for it to be displayed." alt="" coords="88,121,280,140" />
<area shape="rect" href="epydoc.cli.ConsoleLogger-class.html#start_block" title="Start a new message block." alt="" coords="88,143,280,161" />
<area shape="rect" href="epydoc.cli.ConsoleLogger-class.html#end_block" title="End a warning block." alt="" coords="88,161,280,180" />
<area shape="rect" href="epydoc.cli.ConsoleLogger-class.html#log" title="Display a message." alt="" coords="88,180,280,199" />
<area shape="rect" href="epydoc.cli.ConsoleLogger-class.html" title="epydoc.cli.ConsoleLogger" alt="" coords="76,80,292,205" />
<area shape="rect" href="epydoc.cli.UnifiedProgressConsoleLogger-class.html#__init__" title="epydoc.cli.UnifiedProgressConsoleLogger.__init__" alt="" coords="17,255,351,273" />
<area shape="rect" href="epydoc.cli.UnifiedProgressConsoleLogger-class.html#progress" title="Update the progress display." alt="" coords="17,273,351,292" />
<area shape="rect" href="epydoc.cli.UnifiedProgressConsoleLogger-class.html#start_progress" title="Begin displaying progress for a new task." alt="" coords="17,292,351,311" />
<area shape="rect" href="epydoc.cli.UnifiedProgressConsoleLogger-class.html#end_progress" title="Finish off the display of progress for the current task." alt="" coords="17,311,351,329" />
<area shape="rect" href="epydoc.cli.UnifiedProgressConsoleLogger-class.html#print_times" title="epydoc.cli.UnifiedProgressConsoleLogger.print_times" alt="" coords="17,329,351,348" />
<area shape="rect" href="epydoc.cli.UnifiedProgressConsoleLogger-class.html" title="epydoc.cli.UnifiedProgressConsoleLogger" alt="" coords="5,224,363,355" />
<area shape="rect" href="epydoc.log.Logger-class.html#close" title="Perform any tasks needed to close this logger." alt="" coords="151,36,217,55" />
<area shape="rect" href="epydoc.log.Logger-class.html" title="An abstract base class that defines the interface for loggers, which are used by epydoc to report information back to the user." alt="" coords="139,5,229,61" />
</map>
<img src="uml_class_diagram_for_epydoc_c_3.gif" alt='' usemap="#uml_class_diagram_for_epydoc_c_3" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<!-- ==================== 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 colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.cli.UnifiedProgressConsoleLogger-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">verbosity</span>,
<span class="summary-sig-arg">stages</span>,
<span class="summary-sig-arg">progress_mode</span>=<span class="summary-sig-default">None</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.cli-pysrc.html#UnifiedProgressConsoleLogger.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.cli.UnifiedProgressConsoleLogger-class.html#progress" class="summary-sig-name">progress</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">percent</span>,
<span class="summary-sig-arg">message</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span><br />
Update the progress display.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.cli-pysrc.html#UnifiedProgressConsoleLogger.progress">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.cli.UnifiedProgressConsoleLogger-class.html#start_progress" class="summary-sig-name">start_progress</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">header</span>=<span class="summary-sig-default">None</span>)</span><br />
Begin displaying progress for a new task.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.cli-pysrc.html#UnifiedProgressConsoleLogger.start_progress">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.cli.UnifiedProgressConsoleLogger-class.html#end_progress" class="summary-sig-name">end_progress</a>(<span class="summary-sig-arg">self</span>)</span><br />
Finish off the display of progress for the current task.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.cli-pysrc.html#UnifiedProgressConsoleLogger.end_progress">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.cli.UnifiedProgressConsoleLogger-class.html#print_times" class="summary-sig-name">print_times</a>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.cli-pysrc.html#UnifiedProgressConsoleLogger.print_times">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.cli.ConsoleLogger-class.html">ConsoleLogger</a></code></b>:
<code><a href="epydoc.cli.ConsoleLogger-class.html#end_block">end_block</a></code>,
<code><a href="epydoc.cli.ConsoleLogger-class.html#log">log</a></code>,
<code><a href="epydoc.cli.ConsoleLogger-class.html#start_block">start_block</a></code>
</p>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.cli.ConsoleLogger-class.html">ConsoleLogger</a></code></b> (private):
<code><a href="epydoc.cli.ConsoleLogger-class.html#_format" onclick="show_private();">_format</a></code>,
<code><a href="epydoc.cli.ConsoleLogger-class.html#_report" onclick="show_private();">_report</a></code>,
<code><a href="epydoc.cli.ConsoleLogger-class.html#_timestr" onclick="show_private();">_timestr</a></code>
</p></div>
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.log.Logger-class.html">log.Logger</a></code></b>:
<code><a href="epydoc.log.Logger-class.html#close">close</a></code>
</p>
</td>
</tr>
</table>
<!-- ==================== INSTANCE VARIABLES ==================== -->
<a name="section-InstanceVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.cli.ConsoleLogger-class.html">ConsoleLogger</a></code></b>:
<code><a href="epydoc.cli.ConsoleLogger-class.html#reported_message_levels">reported_message_levels</a></code>,
<code><a href="epydoc.cli.ConsoleLogger-class.html#suppressed_docstring_warning">suppressed_docstring_warning</a></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 colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</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">verbosity</span>,
<span class="sig-arg">stages</span>,
<span class="sig-arg">progress_mode</span>=<span class="sig-default">None</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.cli-pysrc.html#UnifiedProgressConsoleLogger.__init__">source code</a></span>
</td>
</tr></table>
<dl class="fields">
<dt>Overrides:
<a href="epydoc.cli.ConsoleLogger-class.html#__init__">ConsoleLogger.__init__</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="progress"></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">progress</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">percent</span>,
<span class="sig-arg">message</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.cli-pysrc.html#UnifiedProgressConsoleLogger.progress">source code</a></span>
</td>
</tr></table>
<p>Update the progress display.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>percent</code></strong> - A float from 0.0 to 1.0, indicating how much progress has been
made.</li>
<li><strong class="pname"><code>message</code></strong> - A message indicating the most recent action that contributed
towards that progress.</li>
</ul></dd>
<dt>Overrides:
<a href="epydoc.log.Logger-class.html#progress">log.Logger.progress</a>
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="start_progress"></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">start_progress</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">header</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.cli-pysrc.html#UnifiedProgressConsoleLogger.start_progress">source code</a></span>
</td>
</tr></table>
<p>Begin displaying progress for a new task. <code>header</code> is a
description of the task for which progress is being reported. Each call
to <code>start_progress</code> must be followed by a call to
<code>end_progress</code> (with no intervening calls to
<code>start_progress</code>).</p>
<dl class="fields">
<dt>Overrides:
<a href="epydoc.log.Logger-class.html#start_progress">log.Logger.start_progress</a>
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="end_progress"></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">end_progress</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.cli-pysrc.html#UnifiedProgressConsoleLogger.end_progress">source code</a></span>
</td>
</tr></table>
<p>Finish off the display of progress for the current task. See <a
href="epydoc.cli.ConsoleLogger-class.html#start_progress"
class="link">start_progress</a> for more information.</p>
<dl class="fields">
<dt>Overrides:
<a href="epydoc.log.Logger-class.html#end_progress">log.Logger.end_progress</a>
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="print_times"></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">print_times</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.cli-pysrc.html#UnifiedProgressConsoleLogger.print_times">source code</a></span>
</td>
</tr></table>
<dl class="fields">
<dt>Overrides:
<a href="epydoc.cli.ConsoleLogger-class.html#print_times">ConsoleLogger.print_times</a>
</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> <a
href="epydoc-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </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://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
<a href="epydoc-log.html">Generated by Epydoc
3.0.1 on Wed Jan 30 14:07:37 2008</a>
</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>
|
