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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html40/loose.dtd">
<html>
<head>
<title>HappyDoc Source Documentation: happydoclib.parseinfo</title>
</head>
<body bgcolor="#ffffff">
<p><i><a href="index.html">Table of Contents</a></i></p>
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr bgcolor="#88bbee">
<th rowspan="2"
valign="top"
align="left"
width="10%"><font color="#000000">HappyDoc Source Documentation: happydoclib.parseinfo</font>
</th>
<th width="90%" align="right"><font color="#000000"> </font></th>
</tr>
<tr>
<td>
<h3>Extract information from a Python code parse tree.</h3>
<p> This module is based on the Demos/parser/example.py module
distributed with the Python source distribution.</p>
<h4> File-specific Parser Configuration Values</h4>
<p> Parameters to the HappyDoc Parser can also be embedded within the
first comment block of the module. The parameter values
recognized and their meanings are listed below.</p>
<p> To provide file-specific parser configuration settings, any Python
code can be embedded in the comments of the file. For example:
<pre>
#!/usr/bin/env python
#
# HappyDoc:# These variables should be discovered.
# HappyDoc:TestInt=1
# HappyDoc:TestString="String"
# HappyDoc:TestStringModule=string.strip(' this has spaces in front and back ')
# HappyDoc:url=urlencode({'a':'A', 'b':'B'})
# HappyDoc:docStringFormat='StructuredText'
</pre>
</p>
<p> All lines beginning with the pattern "'# HappyDoc:'" will be
concatenated (separated by newlines) and <code>execed</code>. The local
namespace resulting from the execution of the code will be
examined for variables of interest to the parser. The incoming
global namespace for the configuration code will have a few
pre-populated names for convenience.</p>
<h5> Pre-defined Globals</h5>
<table border="1" cellpadding="2">
<tr>
<th colspan="1" align="left" valign="middle"><p> Name </p>
</th>
<th colspan="1" align="left" valign="middle"><p> Description </p>
</th>
</tr>
<tr>
<td colspan="1" align="left" valign="middle"><p> string </p>
</td>
<td colspan="1" align="left" valign="middle"><p> The <code>string</code> module. </p>
</td>
</tr>
<tr>
<td colspan="1" align="left" valign="middle"><p> urlquote </p>
</td>
<td colspan="1" align="left" valign="middle"><p> Same as <code>urllib.quote</code> function. </p>
</td>
</tr>
<tr>
<td colspan="1" align="left" valign="middle"><p> urlencode </p>
</td>
<td colspan="1" align="left" valign="middle"><p> Same as <code>urllib.urlencode</code> function. </p>
</td>
</tr>
</table>
<h5> Recognized Parser Configuration Variables</h5>
<table border="1" cellpadding="2">
<tr>
<th colspan="1" align="left" valign="middle"><p> Parameter </p>
</th>
<th colspan="1" align="left" valign="middle"><p> Description </p>
</th>
</tr>
<tr>
<td colspan="1" align="left" valign="top"><p> docStringFormat </p>
</td>
<td colspan="1" align="left" valign="middle"><p> The name of the format for the <code>__doc__</code>
strings in the module. This value is used
to determine the docstring converter which
will know how to translate the docstrings in
the module. </p>
</td>
</tr>
</table>
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="Modules and Packages">Modules and Packages</a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000"> </font>
</th>
</tr>
<tr>
<td>
<h4>HappyDoc-r2_0/happydoclib/parseinfo/</h4>
<table border="0" cellpadding="3" cellspacing="0">
<tr><td valign="top" align="left"><a href="__init__.py.html">__init__</a></td><td valign="top" align="left">
<p>Extract information from a Python code parse tree.</p>
</td></tr>
<tr><td valign="top" align="left"><a href="classinfo.py.html">classinfo</a></td><td valign="top" align="left">
<p>Gather information about a Python class from its parse tree.</p>
</td></tr>
<tr><td valign="top" align="left"><a href="functioninfo.py.html">functioninfo</a></td><td valign="top" align="left">
<p>Gather information about a function or method definition.</p>
</td></tr>
<tr><td valign="top" align="left"><a href="imports.py.html">imports</a></td><td valign="top" align="left">
<p>Collects info about imports for a module.</p>
</td></tr>
<tr><td valign="top" align="left"><a href="moduleinfo.py.html">moduleinfo</a></td><td valign="top" align="left">
<p>Information gatherer for source code modules.</p>
</td></tr>
<tr><td valign="top" align="left"><a href="suite.py.html">suite</a></td><td valign="top" align="left">
<p>Base class for information gathering classes.</p>
</td></tr>
<tr><td valign="top" align="left"><a href="utils.py.html">utils</a></td><td valign="top" align="left">
<p>Utility functions for parseinfo package.</p>
</td></tr>
</table>
</td></tr>
</table>
</td>
</tr>
</table>
<hr>
<p><i><a href="index.html">Table of Contents</a></i></p>
<font size="-2"><i>This document was automatically generated
on Sun Dec 30 07:30:22 2001 by
<a href="http://happydoc.sourceforge.net">HappyDoc</a> version
2.0</i></font>
</body>
</html>
|
