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
|
<?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.markup.restructuredtext.OptimizedReporter</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.markup-module.html">Package markup</a> ::
<a href="epydoc.markup.restructuredtext-module.html">Module restructuredtext</a> ::
Class OptimizedReporter
</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.markup.restructuredtext.OptimizedReporter-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class OptimizedReporter</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.markup.restructuredtext-pysrc.html#OptimizedReporter">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_epydoc_m_18" name="uml_class_diagram_for_epydoc_m_18">
<area shape="rect" href="javascript:void(0);" title="List of names for system message levels, indexed by level." alt="" coords="18,28,682,47" />
<area shape="rect" href="javascript:void(0);" title="The path to or description of the source data." alt="" coords="18,47,682,65" />
<area shape="rect" href="javascript:void(0);" title="The character encoding for the stderr output." alt="" coords="18,65,682,84" />
<area shape="rect" href="javascript:void(0);" title="The character encoding error handler." alt="" coords="18,84,682,103" />
<area shape="rect" href="javascript:void(0);" title="Show debug (level=0) system messages?" alt="" coords="18,103,682,121" />
<area shape="rect" href="javascript:void(0);" title="The level at or above which warning output will be sent to self.stream." alt="" coords="18,121,682,140" />
<area shape="rect" href="javascript:void(0);" title="The level at or above which SystemMessage exceptions will be raised, halting execution." alt="" coords="18,140,682,159" />
<area shape="rect" href="javascript:void(0);" title="Where warning output is sent." alt="" coords="18,159,682,177" />
<area shape="rect" href="javascript:void(0);" title="List of bound methods or functions to call with each system_message created." alt="" coords="18,177,682,196" />
<area shape="rect" href="javascript:void(0);" title="The highest level system message generated so far." alt="" coords="18,196,682,215" />
<area shape="rect" href="javascript:void(0);" title="docutils.utils.Reporter.DEBUG_LEVEL" alt="" coords="18,215,682,233" />
<area shape="rect" href="javascript:void(0);" title="docutils.utils.Reporter.ERROR_LEVEL" alt="" coords="18,233,682,252" />
<area shape="rect" href="javascript:void(0);" title="docutils.utils.Reporter.INFO_LEVEL" alt="" coords="18,252,682,271" />
<area shape="rect" href="javascript:void(0);" title="docutils.utils.Reporter.SEVERE_LEVEL" alt="" coords="18,271,682,289" />
<area shape="rect" href="javascript:void(0);" title="docutils.utils.Reporter.WARNING_LEVEL" alt="" coords="18,289,682,308" />
<area shape="rect" href="javascript:void(0);" title="docutils.utils.Reporter.__init__" alt="" coords="18,311,682,329" />
<area shape="rect" href="javascript:void(0);" title="docutils.utils.Reporter.set_conditions" alt="" coords="18,329,682,348" />
<area shape="rect" href="javascript:void(0);" title="The observer parameter is a function or bound method which takes one argument, a nodes.system_message instance." alt="" coords="18,348,682,367" />
<area shape="rect" href="javascript:void(0);" title="docutils.utils.Reporter.detach_observer" alt="" coords="18,367,682,385" />
<area shape="rect" href="javascript:void(0);" title="docutils.utils.Reporter.notify_observers" alt="" coords="18,385,682,404" />
<area shape="rect" href="javascript:void(0);" title="Return a system_message object." alt="" coords="18,404,682,423" />
<area shape="rect" href="javascript:void(0);" title="Level-1, "INFO": a minor issue that can be ignored." alt="" coords="18,423,682,441" />
<area shape="rect" href="javascript:void(0);" title="Level-2, "WARNING": an issue that should be addressed." alt="" coords="18,441,682,460" />
<area shape="rect" href="javascript:void(0);" title="Level-3, "ERROR": an error that should be addressed." alt="" coords="18,460,682,479" />
<area shape="rect" href="javascript:void(0);" title="Level-4, "SEVERE": a severe error that must be addressed." alt="" coords="18,479,682,497" />
<area shape="rect" href="javascript:void(0);" title="Info/warning/error reporter and system_message element generator." alt="" coords="6,5,694,504" />
<area shape="rect" href="epydoc.markup.restructuredtext.OptimizedReporter-class.html#debug" title="Level-0, "DEBUG": an internal reporting issue." alt="" coords="263,553,436,572" />
<area shape="rect" href="epydoc.markup.restructuredtext.OptimizedReporter-class.html" title="A reporter that ignores all debug messages." alt="" coords="251,523,448,579" />
</map>
<img src="uml_class_diagram_for_epydoc_m_18.gif" alt='' usemap="#uml_class_diagram_for_epydoc_m_18" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>A reporter that ignores all debug messages. This is used to shave a
couple seconds off of epydoc's run time, since docutils isn't very fast
about processing its own debug messages.</p>
<!-- ==================== 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.markup.restructuredtext.OptimizedReporter-class.html#debug" class="summary-sig-name">debug</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Level-0, "DEBUG": an internal reporting issue.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.restructuredtext-pysrc.html#OptimizedReporter.debug">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_debug_2-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_debug_2-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_debug_2" name="call_graph_for_debug_2">
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.Node.walk()" alt="" coords="84,6,311,38" />
<area shape="rect" href="epydoc.markup.restructuredtext.OptimizedReporter-class.html#debug" title="debug()" alt="" coords="438,90,518,122" />
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.Node.walkabout()" alt="" coords="63,62,332,94" />
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.NodeVisitor.dispatch_departure()" alt="" coords="6,118,390,150" />
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.NodeVisitor.dispatch_visit()" alt="" coords="24,174,371,206" />
</map>
<img src="call_graph_for_debug_2.gif" alt='' usemap="#call_graph_for_debug_2" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>docutils.utils.Reporter</code></b>:
<code>__init__</code>,
<code>attach_observer</code>,
<code>detach_observer</code>,
<code>error</code>,
<code>info</code>,
<code>notify_observers</code>,
<code>set_conditions</code>,
<code>severe</code>,
<code>system_message</code>,
<code>warning</code>
</p>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></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">Class Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariables"
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>docutils.utils.Reporter</code></b>:
<code>DEBUG_LEVEL</code>,
<code>ERROR_LEVEL</code>,
<code>INFO_LEVEL</code>,
<code>SEVERE_LEVEL</code>,
<code>WARNING_LEVEL</code>,
<code>levels</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>docutils.utils.Reporter</code></b>:
<code>debug_flag</code>,
<code>encoding</code>,
<code>error_handler</code>,
<code>halt_level</code>,
<code>max_level</code>,
<code>observers</code>,
<code>report_level</code>,
<code>source</code>,
<code>stream</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="debug"></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">debug</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.markup.restructuredtext-pysrc.html#OptimizedReporter.debug">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_debug_2-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_debug_2-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_debug_2" name="call_graph_for_debug_2">
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.Node.walk()" alt="" coords="84,6,311,38" />
<area shape="rect" href="epydoc.markup.restructuredtext.OptimizedReporter-class.html#debug" title="debug()" alt="" coords="438,90,518,122" />
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.Node.walkabout()" alt="" coords="63,62,332,94" />
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.NodeVisitor.dispatch_departure()" alt="" coords="6,118,390,150" />
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.NodeVisitor.dispatch_visit()" alt="" coords="24,174,371,206" />
</map>
<img src="call_graph_for_debug_2.gif" alt='' usemap="#call_graph_for_debug_2" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
Level-0, "DEBUG": an internal reporting issue. Typically, there is no
effect on the processing. Level-0 system messages are handled
separately from the others.
<dl class="fields">
<dt>Overrides:
docutils.utils.Reporter.debug
<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> <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:08:45 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>
|
