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.markup.restructuredtext._SummaryExtractor</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.markup-module.html">Package markup</a> ::
47
<a href="epydoc.markup.restructuredtext-module.html">Module restructuredtext</a> ::
48
Class _SummaryExtractor
52
<table cellpadding="0" cellspacing="0">
53
<!-- hide/show private -->
54
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
55
onclick="toggle_private();">hide private</a>]</span></td></tr>
56
<tr><td align="right"><span class="options"
57
>[<a href="frames.html" target="_top">frames</a
58
>] | <a href="epydoc.markup.restructuredtext._SummaryExtractor-class.html"
59
target="_top">no frames</a>]</span></td></tr>
64
<!-- ==================== CLASS DESCRIPTION ==================== -->
65
<h1 class="epydoc">Class _SummaryExtractor</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.markup.restructuredtext-pysrc.html#_SummaryExtractor">source code</a></span></p>
67
<center> <map id="uml_class_diagram_for_epydoc_m_25" name="uml_class_diagram_for_epydoc_m_25">
68
<area shape="rect" href="javascript:void(0);" title="Tuple containing node class names (as strings)." alt="" coords="18,28,210,47" />
69
<area shape="rect" href="javascript:void(0);" title="Call self."visit_ + node class name" with node as parameter." alt="" coords="18,50,210,68" />
70
<area shape="rect" href="javascript:void(0);" title="Call self."depart_ + node class name" with node as parameter." alt="" coords="18,68,210,87" />
71
<area shape="rect" href="javascript:void(0);" title="Called before exiting unknown Node types." alt="" coords="18,87,210,106" />
72
<area shape="rect" href="javascript:void(0);" title=""Visitor" pattern GoF95 abstract superclass implementation for document tree traversals." alt="" coords="6,6,222,112" />
73
<area shape="rect" href="epydoc.markup.restructuredtext._SummaryExtractor-class.html#__init__" title="epydoc.markup.restructuredtext._SummaryExtractor.__init__" alt="" coords="31,162,196,180" />
74
<area shape="rect" href="epydoc.markup.restructuredtext._SummaryExtractor-class.html#visit_document" title="epydoc.markup.restructuredtext._SummaryExtractor.visit_document" alt="" coords="31,180,196,199" />
75
<area shape="rect" href="epydoc.markup.restructuredtext._SummaryExtractor-class.html#visit_paragraph" title="epydoc.markup.restructuredtext._SummaryExtractor.visit_paragraph" alt="" coords="31,199,196,218" />
76
<area shape="rect" href="epydoc.markup.restructuredtext._SummaryExtractor-class.html#visit_field" title="epydoc.markup.restructuredtext._SummaryExtractor.visit_field" alt="" coords="31,218,196,236" />
77
<area shape="rect" href="epydoc.markup.restructuredtext._SummaryExtractor-class.html#unknown_visit" title="Ignore all unknown nodes" alt="" coords="31,236,196,255" />
78
<area shape="rect" href="epydoc.markup.restructuredtext._SummaryExtractor-class.html" title="A docutils node visitor that extracts the first sentence from the first paragraph in a document." alt="" coords="19,131,208,262" />
80
<img src="uml_class_diagram_for_epydoc_m_25.gif" alt='' usemap="#uml_class_diagram_for_epydoc_m_25" ismap="ismap" class="graph-without-title" />
84
<p>A docutils node visitor that extracts the first sentence from the
85
first paragraph in a document.</p>
87
<!-- ==================== INSTANCE METHODS ==================== -->
88
<a name="section-InstanceMethods"></a>
89
<table class="summary" border="1" cellpadding="3"
90
cellspacing="0" width="100%" bgcolor="white">
91
<tr bgcolor="#70b0f0" class="table-header">
92
<td colspan="2" class="table-header">
93
<table border="0" cellpadding="0" cellspacing="0" width="100%">
95
<td align="left"><span class="table-header">Instance Methods</span></td>
96
<td align="right" valign="top"
97
><span class="options">[<a href="#section-InstanceMethods"
98
class="privatelink" onclick="toggle_private();"
99
>hide private</a>]</span></td>
105
<td width="15%" align="right" valign="top" class="summary">
106
<span class="summary-type"> </span>
107
</td><td class="summary">
108
<table width="100%" cellpadding="0" cellspacing="0" border="0">
110
<td><span class="summary-sig"><a href="epydoc.markup.restructuredtext._SummaryExtractor-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
111
<span class="summary-sig-arg">document</span>)</span></td>
112
<td align="right" valign="top">
113
<span class="codelink"><a href="epydoc.markup.restructuredtext-pysrc.html#_SummaryExtractor.__init__">source code</a></span>
114
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___init___48-summary-div');return false;">call graph</a></span>
118
<div style="display:none" id="call_graph_for___init___48-summary-div"><center>
119
<table border="0" cellpadding="0" cellspacing="0">
120
<tr><td><center> <map id="call_graph_for___init___48" name="call_graph_for___init___48">
121
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.NodeVisitor.__init__()" alt="" coords="457,6,761,38" />
122
<area shape="rect" href="epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#summary" title="ParsedRstDocstring.summary()" alt="" coords="5,6,261,38" />
123
<area shape="rect" href="epydoc.markup.restructuredtext._SummaryExtractor-class.html#__init__" title="__init__()" alt="" coords="311,6,407,38" />
125
<img src="call_graph_for___init___48.gif" alt='' usemap="#call_graph_for___init___48" ismap="ismap" class="graph-without-title" />
127
<tr><th>Call Graph</th></tr>
134
<td width="15%" align="right" valign="top" class="summary">
135
<span class="summary-type"> </span>
136
</td><td class="summary">
137
<table width="100%" cellpadding="0" cellspacing="0" border="0">
139
<td><span class="summary-sig"><a name="visit_document"></a><span class="summary-sig-name">visit_document</span>(<span class="summary-sig-arg">self</span>,
140
<span class="summary-sig-arg">node</span>)</span></td>
141
<td align="right" valign="top">
142
<span class="codelink"><a href="epydoc.markup.restructuredtext-pysrc.html#_SummaryExtractor.visit_document">source code</a></span>
143
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_visit_document_4-summary-div');return false;">call graph</a></span>
147
<div style="display:none" id="call_graph_for_visit_document_4-summary-div"><center>
148
<table border="0" cellpadding="0" cellspacing="0">
149
<tr><td><center> <map id="call_graph_for_visit_document_4" name="call_graph_for_visit_document_4">
150
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.NodeVisitor.dispatch_visit()" alt="" coords="6,6,352,38" />
151
<area shape="rect" href="epydoc.markup.restructuredtext._SummaryExtractor-class.html#visit_document" title="visit_document()" alt="" coords="400,6,550,38" />
153
<img src="call_graph_for_visit_document_4.gif" alt='' usemap="#call_graph_for_visit_document_4" ismap="ismap" class="graph-without-title" />
155
<tr><th>Call Graph</th></tr>
162
<td width="15%" align="right" valign="top" class="summary">
163
<span class="summary-type"> </span>
164
</td><td class="summary">
165
<table width="100%" cellpadding="0" cellspacing="0" border="0">
167
<td><span class="summary-sig"><a name="visit_paragraph"></a><span class="summary-sig-name">visit_paragraph</span>(<span class="summary-sig-arg">self</span>,
168
<span class="summary-sig-arg">node</span>)</span></td>
169
<td align="right" valign="top">
170
<span class="codelink"><a href="epydoc.markup.restructuredtext-pysrc.html#_SummaryExtractor.visit_paragraph">source code</a></span>
171
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_visit_paragraph-summary-div');return false;">call graph</a></span>
175
<div style="display:none" id="call_graph_for_visit_paragraph-summary-div"><center>
176
<table border="0" cellpadding="0" cellspacing="0">
177
<tr><td><center> <map id="call_graph_for_visit_paragraph" name="call_graph_for_visit_paragraph">
178
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.Element.__getitem__()" alt="" coords="597,6,904,38" />
179
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.Element.__setitem__()" alt="" coords="599,62,903,94" />
180
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.Element.copy()" alt="" coords="627,118,875,150" />
181
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.NodeVisitor.dispatch_visit()" alt="" coords="5,90,352,122" />
182
<area shape="rect" href="epydoc.markup.restructuredtext._SummaryExtractor-class.html#visit_paragraph" title="visit_paragraph()" alt="" coords="400,90,549,122" />
183
<area shape="rect" href="epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#__init__" title="ParsedRstDocstring.__init__()" alt="" coords="627,174,875,206" />
185
<img src="call_graph_for_visit_paragraph.gif" alt='' usemap="#call_graph_for_visit_paragraph" ismap="ismap" class="graph-without-title" />
187
<tr><th>Call Graph</th></tr>
194
<td width="15%" align="right" valign="top" class="summary">
195
<span class="summary-type"> </span>
196
</td><td class="summary">
197
<table width="100%" cellpadding="0" cellspacing="0" border="0">
199
<td><span class="summary-sig"><a name="visit_field"></a><span class="summary-sig-name">visit_field</span>(<span class="summary-sig-arg">self</span>,
200
<span class="summary-sig-arg">node</span>)</span></td>
201
<td align="right" valign="top">
202
<span class="codelink"><a href="epydoc.markup.restructuredtext-pysrc.html#_SummaryExtractor.visit_field">source code</a></span>
211
<td width="15%" align="right" valign="top" class="summary">
212
<span class="summary-type"> </span>
213
</td><td class="summary">
214
<table width="100%" cellpadding="0" cellspacing="0" border="0">
216
<td><span class="summary-sig"><a href="epydoc.markup.restructuredtext._SummaryExtractor-class.html#unknown_visit" class="summary-sig-name">unknown_visit</a>(<span class="summary-sig-arg">self</span>,
217
<span class="summary-sig-arg">node</span>)</span><br />
218
Ignore all unknown nodes</td>
219
<td align="right" valign="top">
220
<span class="codelink"><a href="epydoc.markup.restructuredtext-pysrc.html#_SummaryExtractor.unknown_visit">source code</a></span>
221
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_unknown_visit_2-summary-div');return false;">call graph</a></span>
225
<div style="display:none" id="call_graph_for_unknown_visit_2-summary-div"><center>
226
<table border="0" cellpadding="0" cellspacing="0">
227
<tr><td><center> <map id="call_graph_for_unknown_visit_2" name="call_graph_for_unknown_visit_2">
228
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.NodeVisitor.dispatch_visit()" alt="" coords="5,6,352,38" />
229
<area shape="rect" href="epydoc.markup.restructuredtext._SummaryExtractor-class.html#unknown_visit" title="unknown_visit()" alt="" coords="400,6,547,38" />
231
<img src="call_graph_for_unknown_visit_2.gif" alt='' usemap="#call_graph_for_unknown_visit_2" ismap="ismap" class="graph-without-title" />
233
<tr><th>Call Graph</th></tr>
240
<td colspan="2" class="summary">
241
<p class="indent-wrapped-lines"><b>Inherited from <code>docutils.nodes.NodeVisitor</code></b>:
242
<code>dispatch_departure</code>,
243
<code>dispatch_visit</code>,
244
<code>unknown_departure</code>
249
<!-- ==================== CLASS VARIABLES ==================== -->
250
<a name="section-ClassVariables"></a>
251
<table class="summary" border="1" cellpadding="3"
252
cellspacing="0" width="100%" bgcolor="white">
253
<tr bgcolor="#70b0f0" class="table-header">
254
<td colspan="2" class="table-header">
255
<table border="0" cellpadding="0" cellspacing="0" width="100%">
257
<td align="left"><span class="table-header">Class Variables</span></td>
258
<td align="right" valign="top"
259
><span class="options">[<a href="#section-ClassVariables"
260
class="privatelink" onclick="toggle_private();"
261
>hide private</a>]</span></td>
267
<td width="15%" align="right" valign="top" class="summary">
268
<span class="summary-type"> </span>
269
</td><td class="summary">
270
<a name="_SUMMARY_RE"></a><span class="summary-name">_SUMMARY_RE</span> = <code title="re.compile(r'(\s*[\w\W]*?\.)(\s|$)')">re.compile(r'<code class="re-group">(</code>\s<code class="re-op">*</code><code class="re-group">[</code>\w\W<code class="re-group">]</code><code class="re-op">*?</code>\.<code class="re-group">)</code><code class="re-group">(</code>\s<code class="re-op">|</code>$<code class="re-group">)</code>')</code>
274
<td colspan="2" class="summary">
275
<p class="indent-wrapped-lines"><b>Inherited from <code>docutils.nodes.NodeVisitor</code></b>:
276
<code>optional</code>
281
<!-- ==================== METHOD DETAILS ==================== -->
282
<a name="section-MethodDetails"></a>
283
<table class="details" border="1" cellpadding="3"
284
cellspacing="0" width="100%" bgcolor="white">
285
<tr bgcolor="#70b0f0" class="table-header">
286
<td colspan="2" class="table-header">
287
<table border="0" cellpadding="0" cellspacing="0" width="100%">
289
<td align="left"><span class="table-header">Method Details</span></td>
290
<td align="right" valign="top"
291
><span class="options">[<a href="#section-MethodDetails"
292
class="privatelink" onclick="toggle_private();"
293
>hide private</a>]</span></td>
299
<a name="__init__"></a>
301
<table class="details" border="1" cellpadding="3"
302
cellspacing="0" width="100%" bgcolor="white">
304
<table width="100%" cellpadding="0" cellspacing="0" border="0">
305
<tr valign="top"><td>
306
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
307
<span class="sig-arg">document</span>)</span>
308
<br /><em class="fname">(Constructor)</em>
310
</td><td align="right" valign="top"
311
><span class="codelink"><a href="epydoc.markup.restructuredtext-pysrc.html#_SummaryExtractor.__init__">source code</a></span>
312
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___init___48-div');return false;">call graph</a></span> </td>
314
<div style="display:none" id="call_graph_for___init___48-div"><center>
315
<table border="0" cellpadding="0" cellspacing="0">
316
<tr><td><center> <map id="call_graph_for___init___48" name="call_graph_for___init___48">
317
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.NodeVisitor.__init__()" alt="" coords="457,6,761,38" />
318
<area shape="rect" href="epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#summary" title="ParsedRstDocstring.summary()" alt="" coords="5,6,261,38" />
319
<area shape="rect" href="epydoc.markup.restructuredtext._SummaryExtractor-class.html#__init__" title="__init__()" alt="" coords="311,6,407,38" />
321
<img src="call_graph_for___init___48.gif" alt='' usemap="#call_graph_for___init___48" ismap="ismap" class="graph-without-title" />
323
<tr><th>Call Graph</th></tr>
330
docutils.nodes.NodeVisitor.__init__
335
<a name="unknown_visit"></a>
337
<table class="details" border="1" cellpadding="3"
338
cellspacing="0" width="100%" bgcolor="white">
340
<table width="100%" cellpadding="0" cellspacing="0" border="0">
341
<tr valign="top"><td>
342
<h3 class="epydoc"><span class="sig"><span class="sig-name">unknown_visit</span>(<span class="sig-arg">self</span>,
343
<span class="sig-arg">node</span>)</span>
345
</td><td align="right" valign="top"
346
><span class="codelink"><a href="epydoc.markup.restructuredtext-pysrc.html#_SummaryExtractor.unknown_visit">source code</a></span>
347
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_unknown_visit_2-div');return false;">call graph</a></span> </td>
349
<div style="display:none" id="call_graph_for_unknown_visit_2-div"><center>
350
<table border="0" cellpadding="0" cellspacing="0">
351
<tr><td><center> <map id="call_graph_for_unknown_visit_2" name="call_graph_for_unknown_visit_2">
352
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.NodeVisitor.dispatch_visit()" alt="" coords="5,6,352,38" />
353
<area shape="rect" href="epydoc.markup.restructuredtext._SummaryExtractor-class.html#unknown_visit" title="unknown_visit()" alt="" coords="400,6,547,38" />
355
<img src="call_graph_for_unknown_visit_2.gif" alt='' usemap="#call_graph_for_unknown_visit_2" ismap="ismap" class="graph-without-title" />
357
<tr><th>Call Graph</th></tr>
361
<p>Ignore all unknown nodes</p>
364
docutils.nodes.NodeVisitor.unknown_visit
370
<!-- ==================== NAVIGATION BAR ==================== -->
371
<table class="navbar" border="0" width="100%" cellpadding="0"
372
bgcolor="#a0c0ff" cellspacing="0">
375
<th> <a
376
href="epydoc-module.html">Home</a> </th>
379
<th> <a
380
href="module-tree.html">Trees</a> </th>
383
<th> <a
384
href="identifier-index.html">Indices</a> </th>
387
<th> <a
388
href="help.html">Help</a> </th>
390
<!-- Project homepage -->
391
<th class="navbar" align="right" width="100%">
392
<table border="0" cellpadding="0" cellspacing="0">
393
<tr><th class="navbar" align="center"
394
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
398
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
400
<td align="left" class="footer">
401
<a href="epydoc-log.html">Generated by Epydoc
402
3.0.1 on Wed Jan 30 14:09:00 2008</a>
404
<td align="right" class="footer">
405
<a target="mainFrame" href="http://epydoc.sourceforge.net"
406
>http://epydoc.sourceforge.net</a>
411
<script type="text/javascript">
413
// Private objects are initially displayed (because if
414
// javascript is turned off then we want them to be
415
// visible); but by default, we want to hide them. So hide
416
// them unless we have a cookie that says to show them.