Doc/lib/lib.tex

   1 \documentclass{manual}
   2
   3 % NOTE: this file controls which chapters/sections of the library
   4 % manual are actually printed.  It is easy to customize your manual
   5 % by commenting out sections that you're not interested in.
   6
   7 \title{Python Library Reference}
   8
   9 \input{boilerplate}
  10
  11 \makeindex                      % tell \index to actually write the
  12                                 % .idx file
  13 \makemodindex                   % ... and the module index as well.
  14
  15
  16 \begin{document}
  17
  18 \maketitle
  19
  20 \ifhtml
  21 \chapter*{Front Matter\label{front}}
  22 \fi
  23
  24 \input{copyright}
  25
  26 \begin{abstract}
  27
  28 \noindent
  29 Python is an extensible, interpreted, object-oriented programming
  30 language.  It supports a wide range of applications, from simple text
  31 processing scripts to interactive WWW browsers.
  32
  33 While the \citetitle[../ref/ref.html]{Python Reference Manual}
  34 describes the exact syntax and semantics of the language, it does not
  35 describe the standard library that is distributed with the language,
  36 and which greatly enhances its immediate usability.  This library
  37 contains built-in modules (written in C) that provide access to system
  38 functionality such as file I/O that would otherwise be inaccessible to
  39 Python programmers, as well as modules written in Python that provide
  40 standardized solutions for many problems that occur in everyday
  41 programming.  Some of these modules are explicitly designed to
  42 encourage and enhance the portability of Python programs.
  43
  44 This library reference manual documents Python's standard library, as
  45 well as many optional library modules (which may or may not be
  46 available, depending on whether the underlying platform supports them
  47 and on the configuration choices made at compile time).  It also
  48 documents the standard types of the language and its built-in
  49 functions and exceptions, many of which are not or incompletely
  50 documented in the Reference Manual.
  51
  52 This manual assumes basic knowledge about the Python language.  For an
  53 informal introduction to Python, see the
  54 \citetitle[../tut/tut.html]{Python Tutorial}; the
  55 \citetitle[../ref/ref.html]{Python Reference Manual} remains the
  56 highest authority on syntactic and semantic questions.  Finally, the
  57 manual entitled \citetitle[../ext/ext.html]{Extending and Embedding
  58 the Python Interpreter} describes how to add new extensions to Python
  59 and how to embed it in other applications.
  60
  61 \end{abstract}
  62
  63 \tableofcontents
  64
  65                                 % Chapter title:
  66
  67 \input{libintro}                % Introduction
  68
  69 \input{libobjs}                 % Built-in Types, Exceptions and Functions
  70 \input{libstdtypes}
  71 \input{libexcs}
  72 \input{libfuncs}
  73
  74 \input{libpython}               % Python Runtime Services
  75 \input{libsys}
  76 \input{libgc}
  77 \input{libweakref}
  78 \input{libfpectl}
  79 \input{libatexit}
  80 \input{libtypes}
  81 \input{libuserdict}
  82 \input{liboperator}
  83 \input{libinspect}
  84 \input{libtraceback}
  85 \input{liblinecache}
  86 \input{libpickle}
  87 \input{libcopyreg}              % really copy_reg
  88 \input{libshelve}
  89 \input{libcopy}
  90 \input{libmarshal}
  91 \input{libwarnings}
  92 \input{libimp}
  93 \input{libcode}
  94 \input{libcodeop}
  95 \input{libpprint}
  96 \input{librepr}
  97 \input{libnew}
  98 \input{libsite}
  99 \input{libuser}
 100 \input{libbltin}                % really __builtin__
 101 \input{libmain}                 % really __main__
 102
 103 \input{libstrings}              % String Services
 104 \input{libstring}
 105 \input{libre}
 106 \input{libstruct}
 107 \input{libdifflib}
 108 \input{libfpformat}
 109 \input{libstringio}
 110 \input{libcodecs}
 111 \input{libunicodedata}
 112
 113 \input{libmisc}                 % Miscellaneous Services
 114 \input{libdoctest}
 115 \input{libunittest}
 116 \input{libmath}
 117 \input{libcmath}
 118 \input{librandom}
 119 \input{libwhrandom}
 120 \input{libbisect}
 121 \input{libarray}
 122 \input{libcfgparser}
 123 \input{libfileinput}
 124 \input{libxreadlines}
 125 \input{libcalendar}
 126 \input{libcmd}
 127 \input{libshlex}
 128
 129 \input{liballos}                % Generic Operating System Services
 130 \input{libos}
 131 \input{libposixpath}            % os.path
 132 \input{libdircache}
 133 \input{libstat}
 134 \input{libstatcache}
 135 \input{libstatvfs}
 136 \input{libfilecmp}
 137 \input{libpopen2}
 138 \input{libtime}
 139 \input{libsched}
 140 \input{libmutex}
 141 \input{libgetpass}
 142 \input{libcurses}
 143 \input{libascii}                % curses.ascii
 144 \input{libcursespanel}
 145 \input{libgetopt}
 146 \input{libtempfile}
 147 \input{liberrno}
 148 \input{libglob}
 149 \input{libfnmatch}
 150 \input{libshutil}
 151 \input{liblocale}
 152 \input{libgettext}
 153
 154 \input{libsomeos}               % Optional Operating System Services
 155 \input{libsignal}
 156 \input{libsocket}
 157 \input{libselect}
 158 \input{libthread}
 159 \input{libthreading}
 160 \input{libqueue}
 161 \input{libmmap}
 162 \input{libanydbm}
 163 \input{libdbhash}
 164 \input{libwhichdb}
 165 \input{libbsddb}
 166 \input{libzlib}
 167 \input{libgzip}
 168 \input{libzipfile}
 169 \input{libreadline}
 170 \input{librlcompleter}
 171
 172 \input{libunix}                 % UNIX Specific Services
 173 \input{libposix}
 174 \input{libpwd}
 175 \input{libgrp}
 176 \input{libcrypt}
 177 \input{libdl}
 178 \input{libdbm}
 179 \input{libgdbm}
 180 \input{libtermios}
 181 \input{libtty}
 182 \input{libpty}
 183 \input{libfcntl}
 184 \input{libpipes}
 185 \input{libposixfile}
 186 \input{libresource}
 187 \input{libnis}
 188 \input{libsyslog}
 189 \input{libcommands}
 190
 191 \input{libpdb}                  % The Python Debugger
 192
 193 \input{libprofile}              % The Python Profiler
 194
 195 \input{internet}                % Internet Protocols
 196 \input{libwebbrowser}
 197 \input{libcgi}
 198 \input{liburllib}
 199 \input{liburllib2}
 200 \input{libhttplib}
 201 \input{libftplib}
 202 \input{libgopherlib}
 203 \input{libpoplib}
 204 \input{libimaplib}
 205 \input{libnntplib}
 206 \input{libsmtplib}
 207 \input{libtelnetlib}
 208 \input{liburlparse}
 209 \input{libsocksvr}
 210 \input{libbasehttp}
 211 \input{libsimplehttp}
 212 \input{libcgihttp}
 213 \input{libcookie}
 214 \input{libasyncore}
 215
 216 \input{netdata}                 % Internet Data Handling
 217 \input{libformatter}
 218 \input{librfc822}
 219 \input{libmimetools}
 220 \input{libmimewriter}
 221 \input{libmultifile}
 222 \input{libbinhex}
 223 \input{libuu}
 224 \input{libbinascii}
 225 \input{libxdrlib}
 226 \input{libmailcap}
 227 \input{libmimetypes}
 228 \input{libbase64}
 229 \input{libquopri}
 230 \input{libmailbox}
 231 \input{libmhlib}
 232 \input{libmimify}
 233 \input{libnetrc}
 234 \input{librobotparser}
 235
 236 \input{markup}                  % Structured Markup Processing Tools
 237 \input{libhtmlparser}
 238 \input{libsgmllib}
 239 \input{libhtmllib}
 240 \input{libpyexpat}
 241 \input{xmldom}
 242 \input{xmldomminidom}
 243 \input{xmldompulldom}
 244 \input{xmlsax}
 245 \input{xmlsaxhandler}
 246 \input{xmlsaxutils}
 247 \input{xmlsaxreader}
 248 \input{libxmllib}
 249
 250 \input{libmm}                   % Multimedia Services
 251 \input{libaudioop}
 252 \input{libimageop}
 253 \input{libaifc}
 254 \input{libsunau}
 255 \input{libwave}
 256 \input{libchunk}
 257 \input{libcolorsys}
 258 \input{librgbimg}
 259 \input{libimghdr}
 260 \input{libsndhdr}
 261
 262 \input{libcrypto}               % Cryptographic Services
 263 \input{libmd5}
 264 \input{libsha}
 265 \input{libmpz}
 266 \input{librotor}
 267
 268 \input{librestricted}           % Restricted Execution
 269 \input{librexec}
 270 \input{libbastion}
 271
 272 \input{language}                % Python Language Services
 273 \input{libparser}
 274 \input{libsymbol}
 275 \input{libtoken}
 276 \input{libkeyword}
 277 \input{libtokenize}
 278 \input{libtabnanny}
 279 \input{libpyclbr}
 280 \input{libpycompile}            % really py_compile
 281 \input{libcompileall}
 282 \input{libdis}
 283
 284 %\input{libamoeba}              % AMOEBA ONLY
 285
 286 %\input{libstdwin}              % STDWIN ONLY
 287
 288 \input{libsgi}                  % SGI IRIX ONLY
 289 \input{libal}
 290 \input{libcd}
 291 \input{libfl}
 292 \input{libfm}
 293 \input{libgl}
 294 \input{libimgfile}
 295 \input{libjpeg}
 296 %\input{libpanel}
 297
 298 \input{libsun}                  % SUNOS ONLY
 299 \input{libsunaudio}
 300
 301 \input{windows}                 % MS Windows ONLY
 302 \input{libmsvcrt}
 303 \input{libwinreg}
 304 \input{libwinsound}
 305
 306 \appendix
 307 \input{libundoc}
 308
 309 %\chapter{Obsolete Modules}
 310 %\input{libcmpcache}
 311 %\input{libcmp}
 312 %\input{libni}
 313 %\input{librand}
 314 %\input{libregex}
 315 %\input{libregsub}
 316
 317 \chapter{Reporting Bugs}
 318 \input{reportingbugs}
 319
 320 \chapter{History and License}
 321 \input{license}
 322
 323 %
 324 %  The ugly "%begin{latexonly}" pseudo-environments are really just to
 325 %  keep LaTeX2HTML quiet during the \renewcommand{} macros; they're
 326 %  not really valuable.
 327 %
 328
 329 %begin{latexonly}
 330 \renewcommand{\indexname}{Module Index}
 331 %end{latexonly}
 332 \input{modlib.ind}              % Module Index
 333
 334 %begin{latexonly}
 335 \renewcommand{\indexname}{Index}
 336 %end{latexonly}
 337 \input{lib.ind}                 % Index
 338
 339 \end{document}