~pythoneers/ubuntu/lucid/psycopg2/ltsppa

<tr><td align="right"><span class="options">[<a href="frames.html" target="_top">frames</a> | <a href="help.html" target="_top">no frames</a>]</span></td></tr>

</table></td>

</tr></table>

<h1 class="help"> API Documentation </h1>

<p> This document contains the API (Application Programming Interface)

documentation for this project. Documentation for the Python

objects defined by the project is divided into separate pages for each

package, module, and class. The API documentation also includes two

pages containing information about the project as a whole: a trees

page, and an index page. </p>

<h2> Object Documentation </h2>

<p>Each <strong>Package Documentation</strong> page contains: </p>

<ul>

<li> A description of the package. </li>

<li> A list of the modules and sub-packages contained by the

package. </li>

<li> A summary of the classes defined by the package. </li>

<li> A summary of the functions defined by the package. </li>

<li> A summary of the variables defined by the package. </li>

<li> A detailed description of each function defined by the

package. </li>

<li> A detailed description of each variable defined by the

package. </li>

</ul>

<p>Each <strong>Module Documentation</strong> page contains:</p>

<ul>

<li> A description of the module. </li>

<li> A summary of the classes defined by the module. </li>

<li> A summary of the functions defined by the module. </li>

<li> A summary of the variables defined by the module. </li>

<li> A detailed description of each function defined by the

module. </li>

<li> A detailed description of each variable defined by the

module. </li>

</ul>

<p>Each <strong>Class Documentation</strong> page contains: </p>

<ul>

<li> A class inheritance diagram. </li>

<li> A list of known subclasses. </li>

<li> A description of the class. </li>

<li> A summary of the methods defined by the class. </li>

<li> A summary of the instance variables defined by the class. </li>

<li> A summary of the class (static) variables defined by the

class. </li>

<li> A detailed description of each method defined by the

class. </li>

<li> A detailed description of each instance variable defined by the

class. </li>

<li> A detailed description of each class (static) variable defined

by the class. </li>

</ul>

<h2> Project Documentation </h2>

<p> The <strong>Trees</strong> page contains the module and class hierarchies: </p>

<ul>

<li> The <em>module hierarchy</em> lists every package and module, with

modules grouped into packages. At the top level, and within each

100

package, modules and sub-packages are listed alphabetically. </li>

101

<li> The <em>class hierarchy</em> lists every class, grouped by base

102

class. If a class has more than one base class, then it will be

103

listed under each base class. At the top level, and under each base

104

class, classes are listed alphabetically. </li>

105

</ul>

106

107

<p> The <strong>Index</strong> page contains indices of terms and

108

identifiers: </p>

109

<ul>

110

<li> The <em>term index</em> lists every term indexed by any object's

111

documentation. For each term, the index provides links to each

112

place where the term is indexed. </li>

113

<li> The <em>identifier index</em> lists the (short) name of every package,

114

module, class, method, function, variable, and parameter. For each

115

identifier, the index provides a short description, and a link to

116

its documentation. </li>

117

</ul>

118

119

<h2> The Table of Contents </h2>

120

121

<p> The table of contents occupies the two frames on the left side of

122

the window. The upper-left frame displays the <em>project

123

contents</em>, and the lower-left frame displays the <em>module

124

contents</em>: </p>

125

126

127

128

129

Project<br />Contents<hr />...</td>

130

131

API<br />Documentation<br />Frame<br /><br /><br />

132

</td>

133

</tr>

134

<tr>

135

136

Module<br />Contents<hr /> <br />...<br /> 

137

</td>

138

</tr>

139

</table><br />

140

141

<p> The <strong>project contents frame</strong> contains a list of all packages

142

and modules that are defined by the project. Clicking on an entry

143

will display its contents in the module contents frame. Clicking on a

144

special entry, labeled "Everything," will display the contents of

145

the entire project. </p>

146

147

<p> The <strong>module contents frame</strong> contains a list of every

148

submodule, class, type, exception, function, and variable defined by a

149

module or package. Clicking on an entry will display its

150

documentation in the API documentation frame. Clicking on the name of

151

the module, at the top of the frame, will display the documentation

152

for the module itself. </p>

153

154

<p> The "<strong>frames</strong>" and "<strong>no frames</strong>" buttons below the top

155

navigation bar can be used to control whether the table of contents is

156

displayed or not. </p>

157

158

<h2> The Navigation Bar </h2>

159

160

<p> A navigation bar is located at the top and bottom of every page.

161

It indicates what type of page you are currently viewing, and allows

162

you to go to related pages. The following table describes the labels

163

on the navigation bar. Note that not some labels (such as

164

[Parent]) are not displayed on all pages. </p>

165

166

167

168

<th>Label</th>

169

<th>Highlighted when...</th>

170

<th>Links to...</th>

171

</tr>

172

<tr><td valign="top"><strong>[Parent]</strong></td>

173

<td valign="top"><em>(never highlighted)</em></td>

174

<td valign="top"> the parent of the current package </td></tr>

175

<tr><td valign="top"><strong>[Package]</strong></td>

176

<td valign="top">viewing a package</td>

177

<td valign="top">the package containing the current object

178

</td></tr>

179

<tr><td valign="top"><strong>[Module]</strong></td>

180

<td valign="top">viewing a module</td>

181

<td valign="top">the module containing the current object

182

</td></tr>

183

<tr><td valign="top"><strong>[Class]</strong></td>

184

<td valign="top">viewing a class </td>

185

<td valign="top">the class containing the current object</td></tr>

186

<tr><td valign="top"><strong>[Trees]</strong></td>

187

<td valign="top">viewing the trees page</td>

188

<td valign="top"> the trees page </td></tr>

189

<tr><td valign="top"><strong>[Index]</strong></td>

190

<td valign="top">viewing the index page</td>

191

<td valign="top"> the index page </td></tr>

192

193

<td valign="top">viewing the help page</td>

194

195

</table>

196

197

<p> The "<strong>show private</strong>" and "<strong>hide private</strong>" buttons below

198

the top navigation bar can be used to control whether documentation

199

for private objects is displayed. Private objects are usually defined

200

as objects whose (short) names begin with a single underscore, but do

201

not end with an underscore. For example, "<code>_x</code>",

202

"<code>__pprint</code>", and "<code>epydoc.epytext._tokenize</code>"

203

are private objects; but "<code>re.sub</code>",

204

"<code>__init__</code>", and "<code>type_</code>" are not. However,

205

if a module defines the "<code>__all__</code>" variable, then its

206

contents are used to decide which objects are private. </p>

207

208

<p> A timestamp below the bottom navigation bar indicates when each

209

page was last updated. </p>

210

211

212

213

214

215

<th class="navbar">   <a class="navbar" href="trees.html">Trees</a>   </th>

216

<th class="navbar">   <a class="navbar" href="indices.html">Index</a>   </th>

217

218

219

</tr>

220

</table>

221

222

223

<tr>

224

<td align="left" class="footer">Generated by Epydoc 2.1 on Sat Jan 14 01:42:37 2006</td>

225

226

<a href="http://epydoc.sourceforge.net">http://epydoc.sf.net</a>

227

</td>

228

</tr>

229

</table>

230

</body>

231

</html>

Older »