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 Web 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{libfuncs}
  71 \input{libstdtypes}
  72 \input{libexcs}
  73 \input{libconsts}
  74
  75 \input{libpython}               % Python Runtime Services
  76 \input{libsys}
  77 \input{libgc}
  78 \input{libweakref}
  79 \input{libfpectl}
  80 \input{libatexit}
  81 \input{libtypes}
  82 \input{libuserdict}
  83 \input{liboperator}
  84 \input{libinspect}
  85 \input{libtraceback}
  86 \input{liblinecache}
  87 \input{libpickle}
  88 \input{libcopyreg}              % really copy_reg
  89 \input{libshelve}
  90 \input{libcopy}
  91 \input{libmarshal}
  92 \input{libwarnings}
  93 \input{libimp}
  94 \input{libzipimport}
  95 \input{libpkgutil}
  96 \input{libcode}
  97 \input{libcodeop}
  98 \input{libpprint}
  99 \input{librepr}
 100 \input{libnew}
 101 \input{libsite}
 102 \input{libuser}
 103 \input{libbltin}                % really __builtin__
 104 \input{libmain}                 % really __main__
 105 \input{libfuture}               % really __future__
 106
 107 \input{libstrings}              % String Services
 108 \input{libstring}
 109 \input{libre}
 110 \input{libstruct}
 111 \input{libdifflib}
 112 \input{libfpformat}
 113 \input{libstringio}
 114 \input{libtextwrap}
 115 \input{libcodecs}
 116 \input{libunicodedata}
 117 \input{libstringprep}
 118
 119 \input{libmisc}                 % Miscellaneous Services
 120 \input{libpydoc}
 121 \input{libdoctest}
 122 \input{libunittest}
 123 \input{libtest}
 124 \input{libdecimal}
 125 \input{libmath}
 126 \input{libcmath}
 127 \input{librandom}
 128 \input{libwhrandom}
 129 \input{libbisect}
 130 \input{libcollections}
 131 \input{libheapq}
 132 \input{libarray}
 133 \input{libsets}
 134 \input{libitertools}
 135 \input{libcfgparser}
 136 \input{libfileinput}
 137 \input{libcalendar}
 138 \input{libcmd}
 139 \input{libshlex}
 140
 141 \input{liballos}                % Generic Operating System Services
 142 \input{libos}
 143 \input{libposixpath}            % os.path
 144 \input{libdircache}
 145 \input{libstat}
 146 \input{libstatcache}
 147 \input{libstatvfs}
 148 \input{libfilecmp}
 149 \input{libsubprocess}
 150 \input{libpopen2}
 151 \input{libdatetime}
 152 \input{libtime}
 153 \input{libsched}
 154 \input{libmutex}
 155 \input{libgetpass}
 156 \input{libcurses}
 157 \input{libascii}                % curses.ascii
 158 \input{libcursespanel}
 159 \input{libgetopt}
 160 \input{liboptparse}
 161 \input{libtempfile}
 162 \input{liberrno}
 163 \input{libglob}
 164 \input{libfnmatch}
 165 \input{libshutil}
 166 \input{liblocale}
 167 \input{libgettext}
 168 \input{liblogging}
 169 \input{libplatform}
 170
 171 \input{libsomeos}               % Optional Operating System Services
 172 \input{libsignal}
 173 \input{libsocket}
 174 \input{libselect}
 175 \input{libthread}
 176 \input{libthreading}
 177 \input{libdummythread}
 178 \input{libdummythreading}
 179 \input{libqueue}
 180 \input{libmmap}
 181 \input{libanydbm}
 182 \input{libdbhash}
 183 \input{libwhichdb}
 184 \input{libbsddb}
 185 \input{libdumbdbm}
 186 \input{libzlib}
 187 \input{libgzip}
 188 \input{libbz2}
 189 \input{libzipfile}
 190 \input{libtarfile}
 191 \input{libreadline}
 192 \input{librlcompleter}
 193
 194 \input{libunix}                 % UNIX Specific Services
 195 \input{libposix}
 196 \input{libpwd}
 197 \input{libgrp}
 198 \input{libcrypt}
 199 \input{libdl}
 200 \input{libdbm}
 201 \input{libgdbm}
 202 \input{libtermios}
 203 \input{libtty}
 204 \input{libpty}
 205 \input{libfcntl}
 206 \input{libpipes}
 207 \input{libposixfile}
 208 \input{libresource}
 209 \input{libnis}
 210 \input{libsyslog}
 211 \input{libcommands}
 212
 213 \input{libpdb}                  % The Python Debugger
 214
 215 \input{libprofile}              % The Python Profiler
 216 \input{libhotshot}              % New profiler
 217 \input{libtimeit}
 218
 219 \input{internet}                % Internet Protocols
 220 \input{libwebbrowser}
 221 \input{libcgi}
 222 \input{libcgitb}
 223 \input{liburllib}
 224 \input{liburllib2}
 225 \input{libhttplib}
 226 \input{libftplib}
 227 \input{libgopherlib}
 228 \input{libpoplib}
 229 \input{libimaplib}
 230 \input{libnntplib}
 231 \input{libsmtplib}
 232 \input{libsmtpd}
 233 \input{libtelnetlib}
 234 \input{liburlparse}
 235 \input{libsocksvr}
 236 \input{libbasehttp}
 237 \input{libsimplehttp}
 238 \input{libcgihttp}
 239 \input{libcookielib}
 240 \input{libcookie}
 241 \input{libxmlrpclib}
 242 \input{libsimplexmlrpc}
 243 \input{libdocxmlrpc}
 244 \input{libasyncore}
 245 \input{libasynchat}
 246
 247 \input{netdata}                 % Internet Data Handling
 248 \input{libformatter}
 249
 250 % MIME & email stuff
 251 \input{email}
 252 \input{libmailcap}
 253 \input{libmailbox}
 254 \input{libmhlib}
 255 \input{libmimetools}
 256 \input{libmimetypes}
 257 \input{libmimewriter}
 258 \input{libmimify}
 259 \input{libmultifile}
 260 \input{librfc822}
 261
 262 % encoding stuff
 263 \input{libbase64}
 264 \input{libbinascii}
 265 \input{libbinhex}
 266 \input{libquopri}
 267 \input{libuu}
 268 \input{libxdrlib}
 269
 270 % file formats
 271 \input{libnetrc}
 272 \input{librobotparser}
 273 \input{libcsv}
 274
 275 \input{markup}                  % Structured Markup Processing Tools
 276 \input{libhtmlparser}
 277 \input{libsgmllib}
 278 \input{libhtmllib}
 279 \input{libpyexpat}
 280 \input{xmldom}
 281 \input{xmldomminidom}
 282 \input{xmldompulldom}
 283 \input{xmlsax}
 284 \input{xmlsaxhandler}
 285 \input{xmlsaxutils}
 286 \input{xmlsaxreader}
 287 \input{libxmllib}
 288
 289 \input{libmm}                   % Multimedia Services
 290 \input{libaudioop}
 291 \input{libimageop}
 292 \input{libaifc}
 293 \input{libsunau}
 294 \input{libwave}
 295 \input{libchunk}
 296 \input{libcolorsys}
 297 \input{librgbimg}
 298 \input{libimghdr}
 299 \input{libsndhdr}
 300 \input{libossaudiodev}
 301
 302 \input{libcrypto}               % Cryptographic Services
 303 \input{libhmac}
 304 \input{libmd5}
 305 \input{libsha}
 306
 307 \input{tkinter}
 308
 309 \input{librestricted}           % Restricted Execution
 310 \input{librexec}
 311 \input{libbastion}
 312
 313 \input{language}                % Python Language Services
 314 \input{libparser}
 315 \input{libsymbol}
 316 \input{libtoken}
 317 \input{libkeyword}
 318 \input{libtokenize}
 319 \input{libtabnanny}
 320 \input{libpyclbr}
 321 \input{libpycompile}            % really py_compile
 322 \input{libcompileall}
 323 \input{libdis}
 324 \input{libpickletools}
 325 \input{distutils}
 326
 327 \input{compiler}                % compiler package
 328
 329 %\input{libamoeba}              % AMOEBA ONLY
 330
 331 %\input{libstdwin}              % STDWIN ONLY
 332
 333 \input{libsgi}                  % SGI IRIX ONLY
 334 \input{libal}
 335 \input{libcd}
 336 \input{libfl}
 337 \input{libfm}
 338 \input{libgl}
 339 \input{libimgfile}
 340 \input{libjpeg}
 341 %\input{libpanel}
 342
 343 \input{libsun}                  % SUNOS ONLY
 344 \input{libsunaudio}
 345
 346 \input{windows}                 % MS Windows ONLY
 347 \input{libmsvcrt}
 348 \input{libwinreg}
 349 \input{libwinsound}
 350
 351 \appendix
 352 \input{libundoc}
 353
 354 %\chapter{Obsolete Modules}
 355 %\input{libcmpcache}
 356 %\input{libcmp}
 357 %\input{libni}
 358 %\input{librand}
 359 %\input{libregex}
 360 %\input{libregsub}
 361
 362 \chapter{Reporting Bugs}
 363 \input{reportingbugs}
 364
 365 \chapter{History and License}
 366 \input{license}
 367
 368 %
 369 %  The ugly "%begin{latexonly}" pseudo-environments are really just to
 370 %  keep LaTeX2HTML quiet during the \renewcommand{} macros; they're
 371 %  not really valuable.
 372 %
 373
 374 %begin{latexonly}
 375 \renewcommand{\indexname}{Module Index}
 376 %end{latexonly}
 377 \input{modlib.ind}              % Module Index
 378
 379 %begin{latexonly}
 380 \renewcommand{\indexname}{Index}
 381 %end{latexonly}
 382 \input{lib.ind}                 % Index
 383
 384 \end{document}