blob: 7681a1af76a33bafc4fe1e9cdbf946387ffb4577 [file] [log] [blame]
Fred Drake6659c301998-03-03 22:02:19 +00001\documentclass{manual}
Guido van Rossum19f1b821991-11-12 15:41:57 +00002
Guido van Rossum86751151995-02-28 17:14:32 +00003% 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
Guido van Rossum6938f061994-08-01 12:22:53 +00007\title{Python Library Reference}
Guido van Rossum515834a1991-01-22 11:45:29 +00008
Guido van Rossum16cd7f91994-10-06 10:29:26 +00009\input{boilerplate}
Guido van Rossum83eb9621993-11-23 16:28:45 +000010
Fred Drake7d20ffe1998-03-09 16:39:22 +000011\makeindex % tell \index to actually write the
12 % .idx file
13\makemodindex % ... and the module index as well.
Guido van Rossum6938f061994-08-01 12:22:53 +000014
Guido van Rossum1230c081992-01-07 16:40:44 +000015
Guido van Rossum515834a1991-01-22 11:45:29 +000016\begin{document}
Guido van Rossum6938f061994-08-01 12:22:53 +000017
Guido van Rossum515834a1991-01-22 11:45:29 +000018\maketitle
19
Fred Drake9f86b661998-07-28 21:55:19 +000020\ifhtml
21\chapter*{Front Matter\label{front}}
22\fi
23
Guido van Rossum16cd7f91994-10-06 10:29:26 +000024\input{copyright}
25
Guido van Rossum515834a1991-01-22 11:45:29 +000026\begin{abstract}
27
28\noindent
Guido van Rossum2ddd9781995-03-30 16:01:33 +000029Python is an extensible, interpreted, object-oriented programming
30language. It supports a wide range of applications, from simple text
31processing scripts to interactive WWW browsers.
32
Fred Drakeb2c6ef81997-12-18 15:56:05 +000033While the \emph{Python Reference Manual} describes the exact syntax and
Guido van Rossum2ddd9781995-03-30 16:01:33 +000034semantics of the language, it does not describe the standard library
35that is distributed with the language, and which greatly enhances its
36immediate usability. This library contains built-in modules (written
37in C) that provide access to system functionality such as file I/O
38that would otherwise be inaccessible to Python programmers, as well as
39modules written in Python that provide standardized solutions for many
40problems that occur in everyday programming. Some of these modules
41are explicitly designed to encourage and enhance the portability of
42Python programs.
43
44This library reference manual documents Python's standard library, as
45well as many optional library modules (which may or may not be
46available, depending on whether the underlying platform supports them
47and on the configuration choices made at compile time). It also
48documents the standard types of the language and its built-in
49functions and exceptions, many of which are not or incompletely
50documented in the Reference Manual.
51
52This manual assumes basic knowledge about the Python language. For an
Fred Drakeb2c6ef81997-12-18 15:56:05 +000053informal introduction to Python, see the \emph{Python Tutorial}; the
Fred Drakeb660b631998-01-16 16:34:34 +000054\emph{Python Reference Manual} remains the highest authority on
55syntactic and semantic questions. Finally, the manual entitled
56\emph{Extending and Embedding the Python Interpreter} describes how to
57add new extensions to Python and how to embed it in other applications.
Guido van Rossum515834a1991-01-22 11:45:29 +000058
59\end{abstract}
60
Fred Drake4d4f9e71998-01-13 22:25:02 +000061\tableofcontents
Guido van Rossum515834a1991-01-22 11:45:29 +000062
Guido van Rossum6938f061994-08-01 12:22:53 +000063 % Chapter title:
64
65\input{libintro} % Introduction
66
67\input{libobjs} % Built-in Types, Exceptions and Functions
Fred Drake64e3b431998-07-24 13:56:11 +000068\input{libstdtypes}
Guido van Rossum6938f061994-08-01 12:22:53 +000069\input{libexcs}
70\input{libfuncs}
71
Guido van Rossumecde7811995-03-28 13:35:14 +000072\input{libpython} % Python Services
Guido van Rossum6938f061994-08-01 12:22:53 +000073\input{libsys}
Fred Drake64e3b431998-07-24 13:56:11 +000074\input{libtypes}
Guido van Rossum36764b81997-08-30 20:02:25 +000075\input{libuserdict}
Guido van Rossum61ed4db1996-12-06 21:22:41 +000076\input{liboperator}
Guido van Rossumecde7811995-03-28 13:35:14 +000077\input{libtraceback}
Guido van Rossumd1883581995-02-15 15:53:08 +000078\input{libpickle}
Fred Drake2d754431998-01-21 04:58:39 +000079\input{libcopyreg}
Guido van Rossumd1883581995-02-15 15:53:08 +000080\input{libshelve}
81\input{libcopy}
Guido van Rossumecde7811995-03-28 13:35:14 +000082\input{libmarshal}
83\input{libimp}
Fred Drakebd400881998-04-09 11:04:19 +000084%\input{libni}
Guido van Rossumca814701995-10-11 17:32:29 +000085\input{libparser}
Fred Drakeb0df5671998-02-18 15:59:13 +000086\input{libsymbol}
87\input{libtoken}
Fred Drake14bf3411997-10-06 21:40:48 +000088\input{libkeyword}
Guido van Rossum61c27031997-07-18 21:08:07 +000089\input{libcode}
Fred Drake00eb96a1997-10-06 21:26:03 +000090\input{libpprint}
Guido van Rossumeae121e1997-11-18 15:11:47 +000091\input{libdis}
Guido van Rossum571391b1997-04-03 22:41:49 +000092\input{libsite}
Guido van Rossum36764b81997-08-30 20:02:25 +000093\input{libuser}
Guido van Rossumecde7811995-03-28 13:35:14 +000094\input{libbltin} % really __builtin__
95\input{libmain} % really __main__
96
97\input{libstrings} % String Services
98\input{libstring}
Guido van Rossum9cb64801997-12-29 20:01:55 +000099\input{libre}
Guido van Rossumecde7811995-03-28 13:35:14 +0000100\input{libregex}
101\input{libregsub}
102\input{libstruct}
Fred Drake64e3b431998-07-24 13:56:11 +0000103\input{libstringio}
Fred Drake363ab1a1998-04-09 14:23:48 +0000104%\input{libsoundex}
Guido van Rossumecde7811995-03-28 13:35:14 +0000105
106\input{libmisc} % Miscellaneous Services
107\input{libmath}
Guido van Rossum84057a31997-07-17 16:15:18 +0000108\input{libcmath}
Guido van Rossumecde7811995-03-28 13:35:14 +0000109\input{libwhrandom}
Guido van Rossum571391b1997-04-03 22:41:49 +0000110\input{librandom}
Fred Drakeeac469c1998-04-09 04:51:07 +0000111%\input{librand}
Fred Drake188a8471998-04-28 18:27:53 +0000112\input{libbisect}
Guido van Rossumecde7811995-03-28 13:35:14 +0000113\input{libarray}
Fred Drake4bde97f1998-04-04 05:50:12 +0000114\input{libfileinput}
Fred Drakef8d50bf1998-04-28 14:29:27 +0000115\input{libcalendar}
Guido van Rossum8668e8e1998-06-28 17:55:53 +0000116\input{libcmd}
Guido van Rossumecde7811995-03-28 13:35:14 +0000117
118\input{liballos} % Generic Operating System Services
119\input{libos}
120\input{libtime}
121\input{libgetopt}
Guido van Rossumdc46c7f1995-03-01 15:38:16 +0000122\input{libtempfile}
Guido van Rossumc0fcc441996-07-30 18:20:01 +0000123\input{liberrno}
Guido van Rossumb6a80261997-03-25 22:09:18 +0000124\input{libglob}
Guido van Rossume76b7a81997-04-27 21:25:52 +0000125\input{libfnmatch}
Guido van Rossumbc12f781997-11-20 21:04:27 +0000126\input{liblocale}
Guido van Rossumecde7811995-03-28 13:35:14 +0000127
128\input{libsomeos} % Optional Operating System Services
129\input{libsignal}
130\input{libsocket}
131\input{libselect}
132\input{libthread}
Guido van Rossumd623d20e7d61998-07-20 17:34:50 +0000133\input{libthreading}
Barry Warsaw17c8e781997-11-20 19:54:16 +0000134\input{libqueue}
Guido van Rossum571391b1997-04-03 22:41:49 +0000135\input{libanydbm}
136\input{libwhichdb}
Guido van Rossumdfb41201997-04-30 19:40:10 +0000137\input{libzlib}
Guido van Rossum0fcbe8d1997-07-17 16:27:42 +0000138\input{libgzip}
Guido van Rossumecde7811995-03-28 13:35:14 +0000139
140\input{libunix} % UNIX Specific Services
141\input{libposix}
Fred Drake64e3b431998-07-24 13:56:11 +0000142\input{libposixpath}
Guido van Rossumecde7811995-03-28 13:35:14 +0000143\input{libpwd}
144\input{libgrp}
Guido van Rossum5c6e3731996-04-10 16:18:20 +0000145\input{libcrypt}
Guido van Rossumecde7811995-03-28 13:35:14 +0000146\input{libdbm}
147\input{libgdbm}
148\input{libtermios}
149\input{libfcntl}
150\input{libposixfile}
Guido van Rossum3c7b2dc1996-12-18 18:37:05 +0000151\input{libresource}
Guido van Rossumfbe34fa1995-10-09 20:49:57 +0000152\input{libsyslog}
Guido van Rossum3dd68d31996-12-31 02:24:54 +0000153\input{libstat}
Fred Drake188a8471998-04-28 18:27:53 +0000154\input{libpopen2}
Fred Drake4fd12921997-06-12 16:05:46 +0000155\input{libcommands}
Guido van Rossumdf804f81995-03-02 12:38:39 +0000156
157\input{libpdb} % The Python Debugger
158
159\input{libprofile} % The Python Profiler
Guido van Rossum6938f061994-08-01 12:22:53 +0000160
Fred Drakef44c4851998-08-07 15:58:31 +0000161\input{internet} % Internet Protocols
Guido van Rossuma12ef941995-02-27 17:53:25 +0000162\input{libcgi}
Guido van Rossumcca8d2b1995-03-22 15:48:46 +0000163\input{liburllib}
164\input{libhttplib}
Guido van Rossum817a8421995-02-16 16:28:22 +0000165\input{libftplib}
166\input{libgopherlib}
Fred Drakea4684041998-04-24 20:49:02 +0000167\input{libpoplib}
Fred Drake1e0f8bf1998-04-11 04:27:07 +0000168\input{libimaplib}
Guido van Rossum817a8421995-02-16 16:28:22 +0000169\input{libnntplib}
Guido van Rossum8668e8e1998-06-28 17:55:53 +0000170\input{libsmtplib}
Guido van Rossum817a8421995-02-16 16:28:22 +0000171\input{liburlparse}
Fred Drakef44c4851998-08-07 15:58:31 +0000172\input{libsocksvr}
173\input{libbasehttp}
174
175\input{netdata}
Guido van Rossumcca8d2b1995-03-22 15:48:46 +0000176\input{libsgmllib}
Fred Drakee1980ed1996-10-09 14:36:54 +0000177\input{libhtmllib}
Guido van Rossumeae121e1997-11-18 15:11:47 +0000178\input{libxmllib}
Fred Drake53e84d51996-10-08 21:54:41 +0000179\input{libformatter}
Guido van Rossumcca8d2b1995-03-22 15:48:46 +0000180\input{librfc822}
181\input{libmimetools}
Guido van Rossum8668e8e1998-06-28 17:55:53 +0000182\input{libmultifile}
Fred Drake1aabe5e1998-02-19 18:29:18 +0000183\input{libbinhex}
184\input{libuu}
Jack Jansen4549b131995-08-29 11:30:24 +0000185\input{libbinascii}
Guido van Rossum40006cf1996-08-19 22:58:03 +0000186\input{libxdrlib}
Guido van Rossumb6a80261997-03-25 22:09:18 +0000187\input{libmailcap}
Fred Drakeb818b461998-05-19 15:03:45 +0000188\input{libmimetypes}
Guido van Rossume76b7a81997-04-27 21:25:52 +0000189\input{libbase64}
190\input{libquopri}
Guido van Rossume5bb7901997-06-02 17:35:51 +0000191\input{libmailbox}
Guido van Rossumfd16ca41997-07-30 22:05:07 +0000192\input{libmimify}
Guido van Rossum817a8421995-02-16 16:28:22 +0000193
Guido van Rossum6e308d71996-10-22 01:11:53 +0000194\input{librestricted}
195\input{librexec}
196\input{libbastion}
197
Guido van Rossumecde7811995-03-28 13:35:14 +0000198\input{libmm} % Multimedia Services
Guido van Rossum6938f061994-08-01 12:22:53 +0000199\input{libaudioop}
200\input{libimageop}
Guido van Rossumecde7811995-03-28 13:35:14 +0000201\input{libaifc}
Guido van Rossum6938f061994-08-01 12:22:53 +0000202\input{libjpeg}
203\input{librgbimg}
Guido van Rossum40006cf1996-08-19 22:58:03 +0000204\input{libimghdr}
Guido van Rossum6938f061994-08-01 12:22:53 +0000205
Guido van Rossumecde7811995-03-28 13:35:14 +0000206\input{libcrypto} % Cryptographic Services
Guido van Rossum6938f061994-08-01 12:22:53 +0000207\input{libmd5}
208\input{libmpz}
209\input{librotor}
210
211%\input{libamoeba} % AMOEBA ONLY
212
Guido van Rossume5bb7901997-06-02 17:35:51 +0000213%\input{libstdwin} % STDWIN ONLY
Guido van Rossum6938f061994-08-01 12:22:53 +0000214
215\input{libsgi} % SGI IRIX ONLY
216\input{libal}
Sjoerd Mullenderffd6de11995-03-28 11:56:52 +0000217\input{libcd}
Guido van Rossum6938f061994-08-01 12:22:53 +0000218\input{libfl}
219\input{libfm}
220\input{libgl}
221\input{libimgfile}
222%\input{libpanel}
223
224\input{libsun} % SUNOS ONLY
Fred Drake83c1a391998-02-19 18:59:48 +0000225\input{libsunaudio}
Guido van Rossum6938f061994-08-01 12:22:53 +0000226
Guido van Rossum612316f1997-03-14 04:12:52 +0000227\input{libundoc}
228
Fred Drakef3aa0e01998-03-17 06:23:13 +0000229%
230% The ugly "%begin{latexonly}" pseudo-environments are really just to
231% keep LaTeX2HTML quiet during the \renewcommand{} macros; they're
232% not really valuable.
233%
Fred Drake0b1337d1998-01-02 02:59:09 +0000234
Fred Drakef3aa0e01998-03-17 06:23:13 +0000235%begin{latexonly}
236\renewcommand{\indexname}{Module Index}
237%end{latexonly}
238\input{modlib.ind} % Module Index
239
240%begin{latexonly}
Fred Drake0b1337d1998-01-02 02:59:09 +0000241\renewcommand{\indexname}{Index}
Fred Drakef3aa0e01998-03-17 06:23:13 +0000242%end{latexonly}
243\input{lib.ind} % Index
Guido van Rossum515834a1991-01-22 11:45:29 +0000244
245\end{document}