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