1
<?xml version="1.0" encoding="ascii"?>
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">
6
<title>epydoc.cli.UnifiedProgressConsoleLogger</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css" />
8
<script type="text/javascript" src="epydoc.js"></script>
11
<body bgcolor="white" text="black" link="blue" vlink="#204080"
13
<!-- ==================== NAVIGATION BAR ==================== -->
14
<table class="navbar" border="0" width="100%" cellpadding="0"
15
bgcolor="#a0c0ff" cellspacing="0">
18
<th> <a
19
href="epydoc-module.html">Home</a> </th>
22
<th> <a
23
href="module-tree.html">Trees</a> </th>
26
<th> <a
27
href="identifier-index.html">Indices</a> </th>
30
<th> <a
31
href="help.html">Help</a> </th>
33
<!-- Project homepage -->
34
<th class="navbar" align="right" width="100%">
35
<table border="0" cellpadding="0" cellspacing="0">
36
<tr><th class="navbar" align="center"
37
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
41
<table width="100%" cellpadding="0" cellspacing="0">
44
<span class="breadcrumbs">
45
<a href="epydoc-module.html">Package epydoc</a> ::
46
<a href="epydoc.cli-module.html">Module cli</a> ::
47
Class UnifiedProgressConsoleLogger
51
<table cellpadding="0" cellspacing="0">
52
<!-- hide/show private -->
53
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
54
onclick="toggle_private();">hide private</a>]</span></td></tr>
55
<tr><td align="right"><span class="options"
56
>[<a href="frames.html" target="_top">frames</a
57
>] | <a href="epydoc.cli.UnifiedProgressConsoleLogger-class.html"
58
target="_top">no frames</a>]</span></td></tr>
63
<!-- ==================== CLASS DESCRIPTION ==================== -->
64
<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>
66
<center> <map id="uml_class_diagram_for_epydoc_c_3" name="uml_class_diagram_for_epydoc_c_3">
67
<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" />
68
<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" />
69
<area shape="rect" href="epydoc.cli.ConsoleLogger-class.html#start_block" title="Start a new message block." alt="" coords="88,143,280,161" />
70
<area shape="rect" href="epydoc.cli.ConsoleLogger-class.html#end_block" title="End a warning block." alt="" coords="88,161,280,180" />
71
<area shape="rect" href="epydoc.cli.ConsoleLogger-class.html#log" title="Display a message." alt="" coords="88,180,280,199" />
72
<area shape="rect" href="epydoc.cli.ConsoleLogger-class.html" title="epydoc.cli.ConsoleLogger" alt="" coords="76,80,292,205" />
73
<area shape="rect" href="epydoc.cli.UnifiedProgressConsoleLogger-class.html#__init__" title="epydoc.cli.UnifiedProgressConsoleLogger.__init__" alt="" coords="17,255,351,273" />
74
<area shape="rect" href="epydoc.cli.UnifiedProgressConsoleLogger-class.html#progress" title="Update the progress display." alt="" coords="17,273,351,292" />
75
<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" />
76
<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" />
77
<area shape="rect" href="epydoc.cli.UnifiedProgressConsoleLogger-class.html#print_times" title="epydoc.cli.UnifiedProgressConsoleLogger.print_times" alt="" coords="17,329,351,348" />
78
<area shape="rect" href="epydoc.cli.UnifiedProgressConsoleLogger-class.html" title="epydoc.cli.UnifiedProgressConsoleLogger" alt="" coords="5,224,363,355" />
79
<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" />
80
<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" />
82
<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" />
86
<!-- ==================== INSTANCE METHODS ==================== -->
87
<a name="section-InstanceMethods"></a>
88
<table class="summary" border="1" cellpadding="3"
89
cellspacing="0" width="100%" bgcolor="white">
90
<tr bgcolor="#70b0f0" class="table-header">
91
<td colspan="2" class="table-header">
92
<table border="0" cellpadding="0" cellspacing="0" width="100%">
94
<td align="left"><span class="table-header">Instance Methods</span></td>
95
<td align="right" valign="top"
96
><span class="options">[<a href="#section-InstanceMethods"
97
class="privatelink" onclick="toggle_private();"
98
>hide private</a>]</span></td>
104
<td width="15%" align="right" valign="top" class="summary">
105
<span class="summary-type"> </span>
106
</td><td class="summary">
107
<table width="100%" cellpadding="0" cellspacing="0" border="0">
109
<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>,
110
<span class="summary-sig-arg">verbosity</span>,
111
<span class="summary-sig-arg">stages</span>,
112
<span class="summary-sig-arg">progress_mode</span>=<span class="summary-sig-default">None</span>)</span></td>
113
<td align="right" valign="top">
114
<span class="codelink"><a href="epydoc.cli-pysrc.html#UnifiedProgressConsoleLogger.__init__">source code</a></span>
123
<td width="15%" align="right" valign="top" class="summary">
124
<span class="summary-type"> </span>
125
</td><td class="summary">
126
<table width="100%" cellpadding="0" cellspacing="0" border="0">
128
<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>,
129
<span class="summary-sig-arg">percent</span>,
130
<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 />
131
Update the progress display.</td>
132
<td align="right" valign="top">
133
<span class="codelink"><a href="epydoc.cli-pysrc.html#UnifiedProgressConsoleLogger.progress">source code</a></span>
142
<td width="15%" align="right" valign="top" class="summary">
143
<span class="summary-type"> </span>
144
</td><td class="summary">
145
<table width="100%" cellpadding="0" cellspacing="0" border="0">
147
<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>,
148
<span class="summary-sig-arg">header</span>=<span class="summary-sig-default">None</span>)</span><br />
149
Begin displaying progress for a new task.</td>
150
<td align="right" valign="top">
151
<span class="codelink"><a href="epydoc.cli-pysrc.html#UnifiedProgressConsoleLogger.start_progress">source code</a></span>
160
<td width="15%" align="right" valign="top" class="summary">
161
<span class="summary-type"> </span>
162
</td><td class="summary">
163
<table width="100%" cellpadding="0" cellspacing="0" border="0">
165
<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 />
166
Finish off the display of progress for the current task.</td>
167
<td align="right" valign="top">
168
<span class="codelink"><a href="epydoc.cli-pysrc.html#UnifiedProgressConsoleLogger.end_progress">source code</a></span>
177
<td width="15%" align="right" valign="top" class="summary">
178
<span class="summary-type"> </span>
179
</td><td class="summary">
180
<table width="100%" cellpadding="0" cellspacing="0" border="0">
182
<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>
183
<td align="right" valign="top">
184
<span class="codelink"><a href="epydoc.cli-pysrc.html#UnifiedProgressConsoleLogger.print_times">source code</a></span>
193
<td colspan="2" class="summary">
194
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.cli.ConsoleLogger-class.html">ConsoleLogger</a></code></b>:
195
<code><a href="epydoc.cli.ConsoleLogger-class.html#end_block">end_block</a></code>,
196
<code><a href="epydoc.cli.ConsoleLogger-class.html#log">log</a></code>,
197
<code><a href="epydoc.cli.ConsoleLogger-class.html#start_block">start_block</a></code>
199
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.cli.ConsoleLogger-class.html">ConsoleLogger</a></code></b> (private):
200
<code><a href="epydoc.cli.ConsoleLogger-class.html#_format" onclick="show_private();">_format</a></code>,
201
<code><a href="epydoc.cli.ConsoleLogger-class.html#_report" onclick="show_private();">_report</a></code>,
202
<code><a href="epydoc.cli.ConsoleLogger-class.html#_timestr" onclick="show_private();">_timestr</a></code>
204
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.log.Logger-class.html">log.Logger</a></code></b>:
205
<code><a href="epydoc.log.Logger-class.html#close">close</a></code>
210
<!-- ==================== INSTANCE VARIABLES ==================== -->
211
<a name="section-InstanceVariables"></a>
212
<table class="summary" border="1" cellpadding="3"
213
cellspacing="0" width="100%" bgcolor="white">
214
<tr bgcolor="#70b0f0" class="table-header">
215
<td colspan="2" class="table-header">
216
<table border="0" cellpadding="0" cellspacing="0" width="100%">
218
<td align="left"><span class="table-header">Instance Variables</span></td>
219
<td align="right" valign="top"
220
><span class="options">[<a href="#section-InstanceVariables"
221
class="privatelink" onclick="toggle_private();"
222
>hide private</a>]</span></td>
228
<td colspan="2" class="summary">
229
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.cli.ConsoleLogger-class.html">ConsoleLogger</a></code></b>:
230
<code><a href="epydoc.cli.ConsoleLogger-class.html#reported_message_levels">reported_message_levels</a></code>,
231
<code><a href="epydoc.cli.ConsoleLogger-class.html#suppressed_docstring_warning">suppressed_docstring_warning</a></code>
236
<!-- ==================== METHOD DETAILS ==================== -->
237
<a name="section-MethodDetails"></a>
238
<table class="details" border="1" cellpadding="3"
239
cellspacing="0" width="100%" bgcolor="white">
240
<tr bgcolor="#70b0f0" class="table-header">
241
<td colspan="2" class="table-header">
242
<table border="0" cellpadding="0" cellspacing="0" width="100%">
244
<td align="left"><span class="table-header">Method Details</span></td>
245
<td align="right" valign="top"
246
><span class="options">[<a href="#section-MethodDetails"
247
class="privatelink" onclick="toggle_private();"
248
>hide private</a>]</span></td>
254
<a name="__init__"></a>
256
<table class="details" border="1" cellpadding="3"
257
cellspacing="0" width="100%" bgcolor="white">
259
<table width="100%" cellpadding="0" cellspacing="0" border="0">
260
<tr valign="top"><td>
261
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
262
<span class="sig-arg">verbosity</span>,
263
<span class="sig-arg">stages</span>,
264
<span class="sig-arg">progress_mode</span>=<span class="sig-default">None</span>)</span>
265
<br /><em class="fname">(Constructor)</em>
267
</td><td align="right" valign="top"
268
><span class="codelink"><a href="epydoc.cli-pysrc.html#UnifiedProgressConsoleLogger.__init__">source code</a></span>
275
<a href="epydoc.cli.ConsoleLogger-class.html#__init__">ConsoleLogger.__init__</a>
280
<a name="progress"></a>
282
<table class="details" border="1" cellpadding="3"
283
cellspacing="0" width="100%" bgcolor="white">
285
<table width="100%" cellpadding="0" cellspacing="0" border="0">
286
<tr valign="top"><td>
287
<h3 class="epydoc"><span class="sig"><span class="sig-name">progress</span>(<span class="sig-arg">self</span>,
288
<span class="sig-arg">percent</span>,
289
<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>
291
</td><td align="right" valign="top"
292
><span class="codelink"><a href="epydoc.cli-pysrc.html#UnifiedProgressConsoleLogger.progress">source code</a></span>
296
<p>Update the progress display.</p>
299
<dd><ul class="nomargin-top">
300
<li><strong class="pname"><code>percent</code></strong> - A float from 0.0 to 1.0, indicating how much progress has been
302
<li><strong class="pname"><code>message</code></strong> - A message indicating the most recent action that contributed
303
towards that progress.</li>
306
<a href="epydoc.log.Logger-class.html#progress">log.Logger.progress</a>
307
<dd><em class="note">(inherited documentation)</em></dd>
312
<a name="start_progress"></a>
314
<table class="details" border="1" cellpadding="3"
315
cellspacing="0" width="100%" bgcolor="white">
317
<table width="100%" cellpadding="0" cellspacing="0" border="0">
318
<tr valign="top"><td>
319
<h3 class="epydoc"><span class="sig"><span class="sig-name">start_progress</span>(<span class="sig-arg">self</span>,
320
<span class="sig-arg">header</span>=<span class="sig-default">None</span>)</span>
322
</td><td align="right" valign="top"
323
><span class="codelink"><a href="epydoc.cli-pysrc.html#UnifiedProgressConsoleLogger.start_progress">source code</a></span>
327
<p>Begin displaying progress for a new task. <code>header</code> is a
328
description of the task for which progress is being reported. Each call
329
to <code>start_progress</code> must be followed by a call to
330
<code>end_progress</code> (with no intervening calls to
331
<code>start_progress</code>).</p>
334
<a href="epydoc.log.Logger-class.html#start_progress">log.Logger.start_progress</a>
335
<dd><em class="note">(inherited documentation)</em></dd>
340
<a name="end_progress"></a>
342
<table class="details" border="1" cellpadding="3"
343
cellspacing="0" width="100%" bgcolor="white">
345
<table width="100%" cellpadding="0" cellspacing="0" border="0">
346
<tr valign="top"><td>
347
<h3 class="epydoc"><span class="sig"><span class="sig-name">end_progress</span>(<span class="sig-arg">self</span>)</span>
349
</td><td align="right" valign="top"
350
><span class="codelink"><a href="epydoc.cli-pysrc.html#UnifiedProgressConsoleLogger.end_progress">source code</a></span>
354
<p>Finish off the display of progress for the current task. See <a
355
href="epydoc.cli.ConsoleLogger-class.html#start_progress"
356
class="link">start_progress</a> for more information.</p>
359
<a href="epydoc.log.Logger-class.html#end_progress">log.Logger.end_progress</a>
360
<dd><em class="note">(inherited documentation)</em></dd>
365
<a name="print_times"></a>
367
<table class="details" border="1" cellpadding="3"
368
cellspacing="0" width="100%" bgcolor="white">
370
<table width="100%" cellpadding="0" cellspacing="0" border="0">
371
<tr valign="top"><td>
372
<h3 class="epydoc"><span class="sig"><span class="sig-name">print_times</span>(<span class="sig-arg">self</span>)</span>
374
</td><td align="right" valign="top"
375
><span class="codelink"><a href="epydoc.cli-pysrc.html#UnifiedProgressConsoleLogger.print_times">source code</a></span>
382
<a href="epydoc.cli.ConsoleLogger-class.html#print_times">ConsoleLogger.print_times</a>
388
<!-- ==================== NAVIGATION BAR ==================== -->
389
<table class="navbar" border="0" width="100%" cellpadding="0"
390
bgcolor="#a0c0ff" cellspacing="0">
393
<th> <a
394
href="epydoc-module.html">Home</a> </th>
397
<th> <a
398
href="module-tree.html">Trees</a> </th>
401
<th> <a
402
href="identifier-index.html">Indices</a> </th>
405
<th> <a
406
href="help.html">Help</a> </th>
408
<!-- Project homepage -->
409
<th class="navbar" align="right" width="100%">
410
<table border="0" cellpadding="0" cellspacing="0">
411
<tr><th class="navbar" align="center"
412
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
416
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
418
<td align="left" class="footer">
419
<a href="epydoc-log.html">Generated by Epydoc
420
3.0.1 on Wed Jan 30 14:07:37 2008</a>
422
<td align="right" class="footer">
423
<a target="mainFrame" href="http://epydoc.sourceforge.net"
424
>http://epydoc.sourceforge.net</a>
429
<script type="text/javascript">
431
// Private objects are initially displayed (because if
432
// javascript is turned off then we want them to be
433
// visible); but by default, we want to hide them. So hide
434
// them unless we have a cookie that says to show them.