Commit | Line | Data |
---|---|---|
920dae64 AT |
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
2 | <html> | |
3 | <head> | |
4 | <link rel="STYLESHEET" href="lib.css" type='text/css' /> | |
5 | <link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" /> | |
6 | <link rel='start' href='../index.html' title='Python Documentation Index' /> | |
7 | <link rel="first" href="lib.html" title='Python Library Reference' /> | |
8 | <link rel='contents' href='contents.html' title="Contents" /> | |
9 | <link rel='index' href='genindex.html' title='Index' /> | |
10 | <link rel='last' href='about.html' title='About this document...' /> | |
11 | <link rel='help' href='about.html' title='About this document...' /> | |
12 | <link rel="next" href="module-pycompile.html" /> | |
13 | <link rel="prev" href="module-tabnanny.html" /> | |
14 | <link rel="parent" href="language.html" /> | |
15 | <link rel="next" href="pyclbr-class-objects.html" /> | |
16 | <meta name='aesop' content='information' /> | |
17 | <title>18.7 pyclbr -- Python class browser support</title> | |
18 | </head> | |
19 | <body> | |
20 | <DIV CLASS="navigation"> | |
21 | <div id='top-navigation-panel' xml:id='top-navigation-panel'> | |
22 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
23 | <tr> | |
24 | <td class='online-navigation'><a rel="prev" title="18.6 tabnanny " | |
25 | href="module-tabnanny.html"><img src='../icons/previous.png' | |
26 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
27 | <td class='online-navigation'><a rel="parent" title="18. Python Language Services" | |
28 | href="language.html"><img src='../icons/up.png' | |
29 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
30 | <td class='online-navigation'><a rel="next" title="18.7.1 Class Descriptor Objects" | |
31 | href="pyclbr-class-objects.html"><img src='../icons/next.png' | |
32 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
33 | <td align="center" width="100%">Python Library Reference</td> | |
34 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
35 | href="contents.html"><img src='../icons/contents.png' | |
36 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
37 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' | |
38 | border='0' height='32' alt='Module Index' width='32' /></a></td> | |
39 | <td class='online-navigation'><a rel="index" title="Index" | |
40 | href="genindex.html"><img src='../icons/index.png' | |
41 | border='0' height='32' alt='Index' width='32' /></A></td> | |
42 | </tr></table> | |
43 | <div class='online-navigation'> | |
44 | <b class="navlabel">Previous:</b> | |
45 | <a class="sectref" rel="prev" href="module-tabnanny.html">18.6 tabnanny </A> | |
46 | <b class="navlabel">Up:</b> | |
47 | <a class="sectref" rel="parent" href="language.html">18. Python Language Services</A> | |
48 | <b class="navlabel">Next:</b> | |
49 | <a class="sectref" rel="next" href="pyclbr-class-objects.html">18.7.1 Class Descriptor Objects</A> | |
50 | </div> | |
51 | <hr /></div> | |
52 | </DIV> | |
53 | <!--End of Navigation Panel--> | |
54 | ||
55 | <H1><A NAME="SECTION0020700000000000000000"> | |
56 | 18.7 <tt class="module">pyclbr</tt> -- | |
57 | Python class browser support</A> | |
58 | </H1> | |
59 | ||
60 | <P> | |
61 | <A NAME="module-pyclbr"></A> | |
62 | ||
63 | <P> | |
64 | The <tt class="module">pyclbr</tt> can be used to determine some limited information | |
65 | about the classes, methods and top-level functions | |
66 | defined in a module. The information | |
67 | provided is sufficient to implement a traditional three-pane class | |
68 | browser. The information is extracted from the source code rather | |
69 | than by importing the module, so this module is safe to use with | |
70 | untrusted source code. This restriction makes it impossible to use | |
71 | this module with modules not implemented in Python, including many | |
72 | standard and optional extension modules. | |
73 | ||
74 | <P> | |
75 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
76 | <td><nobr><b><tt id='l2h-4980' xml:id='l2h-4980' class="function">readmodule</tt></b>(</nobr></td> | |
77 | <td><var>module</var><big>[</big><var>, path</var><big>]</big><var></var>)</td></tr></table></dt> | |
78 | <dd> | |
79 | Read a module and return a dictionary mapping class names to class | |
80 | descriptor objects. The parameter <var>module</var> should be the name | |
81 | of a module as a string; it may be the name of a module within a | |
82 | package. The <var>path</var> parameter should be a sequence, and is used | |
83 | to augment the value of <code>sys.path</code>, which is used to locate | |
84 | module source code. | |
85 | </dl> | |
86 | ||
87 | <P> | |
88 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
89 | <td><nobr><b><tt id='l2h-4981' xml:id='l2h-4981' class="function">readmodule_ex</tt></b>(</nobr></td> | |
90 | <td><var>module</var><big>[</big><var>, path</var><big>]</big><var></var>)</td></tr></table></dt> | |
91 | <dd> | |
92 | Like <tt class="function">readmodule()</tt>, but the returned dictionary, in addition | |
93 | to mapping class names to class descriptor objects, also maps | |
94 | top-level function names to function descriptor objects. Moreover, if | |
95 | the module being read is a package, the key <code>'__path__'</code> in the | |
96 | returned dictionary has as its value a list which contains the package | |
97 | search path. | |
98 | </dl> | |
99 | ||
100 | <P> | |
101 | ||
102 | <p><br /></p><hr class='online-navigation' /> | |
103 | <div class='online-navigation'> | |
104 | <!--Table of Child-Links--> | |
105 | <A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></a> | |
106 | ||
107 | <UL CLASS="ChildLinks"> | |
108 | <LI><A href="pyclbr-class-objects.html">18.7.1 Class Descriptor Objects</a> | |
109 | <LI><A href="pyclbr-function-objects.html">18.7.2 Function Descriptor Objects</a> | |
110 | </ul> | |
111 | <!--End of Table of Child-Links--> | |
112 | </div> | |
113 | ||
114 | <DIV CLASS="navigation"> | |
115 | <div class='online-navigation'> | |
116 | <p></p><hr /> | |
117 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
118 | <tr> | |
119 | <td class='online-navigation'><a rel="prev" title="18.6 tabnanny " | |
120 | href="module-tabnanny.html"><img src='../icons/previous.png' | |
121 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
122 | <td class='online-navigation'><a rel="parent" title="18. Python Language Services" | |
123 | href="language.html"><img src='../icons/up.png' | |
124 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
125 | <td class='online-navigation'><a rel="next" title="18.7.1 Class Descriptor Objects" | |
126 | href="pyclbr-class-objects.html"><img src='../icons/next.png' | |
127 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
128 | <td align="center" width="100%">Python Library Reference</td> | |
129 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
130 | href="contents.html"><img src='../icons/contents.png' | |
131 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
132 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' | |
133 | border='0' height='32' alt='Module Index' width='32' /></a></td> | |
134 | <td class='online-navigation'><a rel="index" title="Index" | |
135 | href="genindex.html"><img src='../icons/index.png' | |
136 | border='0' height='32' alt='Index' width='32' /></A></td> | |
137 | </tr></table> | |
138 | <div class='online-navigation'> | |
139 | <b class="navlabel">Previous:</b> | |
140 | <a class="sectref" rel="prev" href="module-tabnanny.html">18.6 tabnanny </A> | |
141 | <b class="navlabel">Up:</b> | |
142 | <a class="sectref" rel="parent" href="language.html">18. Python Language Services</A> | |
143 | <b class="navlabel">Next:</b> | |
144 | <a class="sectref" rel="next" href="pyclbr-class-objects.html">18.7.1 Class Descriptor Objects</A> | |
145 | </div> | |
146 | </div> | |
147 | <hr /> | |
148 | <span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span> | |
149 | </DIV> | |
150 | <!--End of Navigation Panel--> | |
151 | <ADDRESS> | |
152 | See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. | |
153 | </ADDRESS> | |
154 | </BODY> | |
155 | </HTML> |