blob: 76fddcaaa1be00f44eeb89eef39e7628f44ded94 [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
Guido van Rossum6938f061994-08-01 12:22:53 +000011\makeindex % tell \index to actually write the .idx file
12
Guido van Rossum1230c081992-01-07 16:40:44 +000013
Guido van Rossum515834a1991-01-22 11:45:29 +000014\begin{document}
Guido van Rossum6938f061994-08-01 12:22:53 +000015
Guido van Rossum515834a1991-01-22 11:45:29 +000016\maketitle
17
Guido van Rossum16cd7f91994-10-06 10:29:26 +000018\input{copyright}
19
Guido van Rossum515834a1991-01-22 11:45:29 +000020\begin{abstract}
21
22\noindent
Guido van Rossum2ddd9781995-03-30 16:01:33 +000023Python is an extensible, interpreted, object-oriented programming
24language. It supports a wide range of applications, from simple text
25processing scripts to interactive WWW browsers.
26
Fred Drakeb2c6ef81997-12-18 15:56:05 +000027While the \emph{Python Reference Manual} describes the exact syntax and
Guido van Rossum2ddd9781995-03-30 16:01:33 +000028semantics of the language, it does not describe the standard library
29that is distributed with the language, and which greatly enhances its
30immediate usability. This library contains built-in modules (written
31in C) that provide access to system functionality such as file I/O
32that would otherwise be inaccessible to Python programmers, as well as
33modules written in Python that provide standardized solutions for many
34problems that occur in everyday programming. Some of these modules
35are explicitly designed to encourage and enhance the portability of
36Python programs.
37
38This library reference manual documents Python's standard library, as
39well as many optional library modules (which may or may not be
40available, depending on whether the underlying platform supports them
41and on the configuration choices made at compile time). It also
42documents the standard types of the language and its built-in
43functions and exceptions, many of which are not or incompletely
44documented in the Reference Manual.
45
46This manual assumes basic knowledge about the Python language. For an
Fred Drakeb2c6ef81997-12-18 15:56:05 +000047informal introduction to Python, see the \emph{Python Tutorial}; the
Fred Drakeb660b631998-01-16 16:34:34 +000048\emph{Python Reference Manual} remains the highest authority on
49syntactic and semantic questions. Finally, the manual entitled
50\emph{Extending and Embedding the Python Interpreter} describes how to
51add new extensions to Python and how to embed it in other applications.
Guido van Rossum515834a1991-01-22 11:45:29 +000052
53\end{abstract}
54
Fred Drake4d4f9e71998-01-13 22:25:02 +000055\tableofcontents
Guido van Rossum515834a1991-01-22 11:45:29 +000056
Guido van Rossum6938f061994-08-01 12:22:53 +000057 % Chapter title:
58
59\input{libintro} % Introduction
60
61\input{libobjs} % Built-in Types, Exceptions and Functions
62\input{libtypes}
63\input{libexcs}
64\input{libfuncs}
65
Guido van Rossumecde7811995-03-28 13:35:14 +000066\input{libpython} % Python Services
Guido van Rossum6938f061994-08-01 12:22:53 +000067\input{libsys}
Guido van Rossumecde7811995-03-28 13:35:14 +000068\input{libtypes2} % types is already taken :-(
Guido van Rossum36764b81997-08-30 20:02:25 +000069\input{libuserdict}
Guido van Rossum61ed4db1996-12-06 21:22:41 +000070\input{liboperator}
Guido van Rossumecde7811995-03-28 13:35:14 +000071\input{libtraceback}
Guido van Rossumd1883581995-02-15 15:53:08 +000072\input{libpickle}
Fred Drake2d754431998-01-21 04:58:39 +000073\input{libcopyreg}
Guido van Rossumd1883581995-02-15 15:53:08 +000074\input{libshelve}
75\input{libcopy}
Guido van Rossumecde7811995-03-28 13:35:14 +000076\input{libmarshal}
77\input{libimp}
Guido van Rossum0fcbe8d1997-07-17 16:27:42 +000078\input{libni}
Guido van Rossumca814701995-10-11 17:32:29 +000079\input{libparser}
Fred Drakeb0df5671998-02-18 15:59:13 +000080\input{libsymbol}
81\input{libtoken}
Fred Drake14bf3411997-10-06 21:40:48 +000082\input{libkeyword}
Guido van Rossum61c27031997-07-18 21:08:07 +000083\input{libcode}
Fred Drake00eb96a1997-10-06 21:26:03 +000084\input{libpprint}
Guido van Rossumeae121e1997-11-18 15:11:47 +000085\input{libdis}
Guido van Rossum571391b1997-04-03 22:41:49 +000086\input{libsite}
Guido van Rossum36764b81997-08-30 20:02:25 +000087\input{libuser}
Guido van Rossumecde7811995-03-28 13:35:14 +000088\input{libbltin} % really __builtin__
89\input{libmain} % really __main__
90
91\input{libstrings} % String Services
92\input{libstring}
Guido van Rossum9cb64801997-12-29 20:01:55 +000093\input{libre}
Guido van Rossumecde7811995-03-28 13:35:14 +000094\input{libregex}
95\input{libregsub}
96\input{libstruct}
Guido van Rossumcda3d7d1997-03-03 16:01:21 +000097\input{libstrio}
Guido van Rossum3486f271996-12-12 17:02:21 +000098\input{libsoundex}
Guido van Rossumecde7811995-03-28 13:35:14 +000099
100\input{libmisc} % Miscellaneous Services
101\input{libmath}
Guido van Rossum84057a31997-07-17 16:15:18 +0000102\input{libcmath}
Guido van Rossumecde7811995-03-28 13:35:14 +0000103\input{libwhrandom}
Guido van Rossum571391b1997-04-03 22:41:49 +0000104\input{librandom}
105\input{librand}
Guido van Rossumecde7811995-03-28 13:35:14 +0000106\input{libarray}
107
108\input{liballos} % Generic Operating System Services
109\input{libos}
110\input{libtime}
111\input{libgetopt}
Guido van Rossumdc46c7f1995-03-01 15:38:16 +0000112\input{libtempfile}
Guido van Rossumc0fcc441996-07-30 18:20:01 +0000113\input{liberrno}
Guido van Rossumb6a80261997-03-25 22:09:18 +0000114\input{libglob}
Guido van Rossume76b7a81997-04-27 21:25:52 +0000115\input{libfnmatch}
Guido van Rossumbc12f781997-11-20 21:04:27 +0000116\input{liblocale}
Guido van Rossumecde7811995-03-28 13:35:14 +0000117
118\input{libsomeos} % Optional Operating System Services
119\input{libsignal}
120\input{libsocket}
121\input{libselect}
122\input{libthread}
Barry Warsaw17c8e781997-11-20 19:54:16 +0000123\input{libqueue}
Guido van Rossum571391b1997-04-03 22:41:49 +0000124\input{libanydbm}
125\input{libwhichdb}
Guido van Rossumdfb41201997-04-30 19:40:10 +0000126\input{libzlib}
Guido van Rossum0fcbe8d1997-07-17 16:27:42 +0000127\input{libgzip}
Guido van Rossumecde7811995-03-28 13:35:14 +0000128
129\input{libunix} % UNIX Specific Services
130\input{libposix}
131\input{libppath} % == posixpath
132\input{libpwd}
133\input{libgrp}
Guido van Rossum5c6e3731996-04-10 16:18:20 +0000134\input{libcrypt}
Guido van Rossumecde7811995-03-28 13:35:14 +0000135\input{libdbm}
136\input{libgdbm}
137\input{libtermios}
138\input{libfcntl}
139\input{libposixfile}
Guido van Rossum3c7b2dc1996-12-18 18:37:05 +0000140\input{libresource}
Guido van Rossumfbe34fa1995-10-09 20:49:57 +0000141\input{libsyslog}
Guido van Rossum3dd68d31996-12-31 02:24:54 +0000142\input{libstat}
Fred Drake4fd12921997-06-12 16:05:46 +0000143\input{libcommands}
Guido van Rossumdf804f81995-03-02 12:38:39 +0000144
145\input{libpdb} % The Python Debugger
146
147\input{libprofile} % The Python Profiler
Guido van Rossum6938f061994-08-01 12:22:53 +0000148
Guido van Rossumecde7811995-03-28 13:35:14 +0000149\input{libwww} % Internet and WWW Services
Guido van Rossuma12ef941995-02-27 17:53:25 +0000150\input{libcgi}
Guido van Rossumcca8d2b1995-03-22 15:48:46 +0000151\input{liburllib}
152\input{libhttplib}
Guido van Rossum817a8421995-02-16 16:28:22 +0000153\input{libftplib}
154\input{libgopherlib}
Guido van Rossum817a8421995-02-16 16:28:22 +0000155\input{libnntplib}
Guido van Rossum817a8421995-02-16 16:28:22 +0000156\input{liburlparse}
Guido van Rossumcca8d2b1995-03-22 15:48:46 +0000157\input{libsgmllib}
Fred Drakee1980ed1996-10-09 14:36:54 +0000158\input{libhtmllib}
Guido van Rossumeae121e1997-11-18 15:11:47 +0000159\input{libxmllib}
Fred Drake53e84d51996-10-08 21:54:41 +0000160\input{libformatter}
Guido van Rossumcca8d2b1995-03-22 15:48:46 +0000161\input{librfc822}
162\input{libmimetools}
Fred Drake1aabe5e1998-02-19 18:29:18 +0000163\input{libbinhex}
164\input{libuu}
Jack Jansen4549b131995-08-29 11:30:24 +0000165\input{libbinascii}
Guido van Rossum40006cf1996-08-19 22:58:03 +0000166\input{libxdrlib}
Guido van Rossumb6a80261997-03-25 22:09:18 +0000167\input{libmailcap}
Guido van Rossume76b7a81997-04-27 21:25:52 +0000168\input{libbase64}
169\input{libquopri}
Guido van Rossum6181e001997-05-19 19:55:16 +0000170\input{libsocksvr}
Guido van Rossume5bb7901997-06-02 17:35:51 +0000171\input{libmailbox}
Guido van Rossumfd16ca41997-07-30 22:05:07 +0000172\input{libmimify}
Guido van Rossum9cb64801997-12-29 20:01:55 +0000173\input{libbasehttp}
Guido van Rossum817a8421995-02-16 16:28:22 +0000174
Guido van Rossum6e308d71996-10-22 01:11:53 +0000175\input{librestricted}
176\input{librexec}
177\input{libbastion}
178
Guido van Rossumecde7811995-03-28 13:35:14 +0000179\input{libmm} % Multimedia Services
Guido van Rossum6938f061994-08-01 12:22:53 +0000180\input{libaudioop}
181\input{libimageop}
Guido van Rossumecde7811995-03-28 13:35:14 +0000182\input{libaifc}
Guido van Rossum6938f061994-08-01 12:22:53 +0000183\input{libjpeg}
184\input{librgbimg}
Guido van Rossum40006cf1996-08-19 22:58:03 +0000185\input{libimghdr}
Guido van Rossum6938f061994-08-01 12:22:53 +0000186
Guido van Rossumecde7811995-03-28 13:35:14 +0000187\input{libcrypto} % Cryptographic Services
Guido van Rossum6938f061994-08-01 12:22:53 +0000188\input{libmd5}
189\input{libmpz}
190\input{librotor}
191
192%\input{libamoeba} % AMOEBA ONLY
193
Guido van Rossum86751151995-02-28 17:14:32 +0000194\input{libmac} % MACINTOSH ONLY
Guido van Rossumdc46c7f1995-03-01 15:38:16 +0000195\input{libctb}
196\input{libmacconsole}
Guido van Rossum85c4ff21995-03-07 10:12:11 +0000197\input{libmacdnr}
Guido van Rossumdc46c7f1995-03-01 15:38:16 +0000198\input{libmacfs}
Guido van Rossume229d861997-08-18 15:14:26 +0000199\input{libmacic}
Jack Jansenebed45f1995-08-14 13:40:05 +0000200\input{libmacos}
Jack Jansenda53c521995-10-10 14:43:20 +0000201\input{libmacostools}
Guido van Rossumdc46c7f1995-03-01 15:38:16 +0000202\input{libmactcp}
203\input{libmacspeech}
Jack Jansenda53c521995-10-10 14:43:20 +0000204\input{libmacui}
Fred Drakeb4efb6c1998-02-18 17:19:11 +0000205\input{libframework}
206\input{libminiae}
Guido van Rossum6938f061994-08-01 12:22:53 +0000207
Guido van Rossume5bb7901997-06-02 17:35:51 +0000208%\input{libstdwin} % STDWIN ONLY
Guido van Rossum6938f061994-08-01 12:22:53 +0000209
210\input{libsgi} % SGI IRIX ONLY
211\input{libal}
Sjoerd Mullenderffd6de11995-03-28 11:56:52 +0000212\input{libcd}
Guido van Rossum6938f061994-08-01 12:22:53 +0000213\input{libfl}
214\input{libfm}
215\input{libgl}
216\input{libimgfile}
217%\input{libpanel}
218
219\input{libsun} % SUNOS ONLY
Fred Drake83c1a391998-02-19 18:59:48 +0000220\input{libsunaudio}
Guido van Rossum6938f061994-08-01 12:22:53 +0000221
Guido van Rossum612316f1997-03-14 04:12:52 +0000222\input{libundoc}
223
Fred Drake0b1337d1998-01-02 02:59:09 +0000224\renewcommand{\indexname}{Module Index}
Fred Drake540e13d1998-02-25 15:31:20 +0000225\input{modlib.ind} % Module Index
Fred Drake0b1337d1998-01-02 02:59:09 +0000226
227\renewcommand{\indexname}{Index}
Guido van Rossum6938f061994-08-01 12:22:53 +0000228\input{lib.ind} % Index
Guido van Rossum515834a1991-01-22 11:45:29 +0000229
230\end{document}