blob: 789b905c77e497a865af4a43d91f51194e77fe2b [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
Guido van Rossum16cd7f91994-10-06 10:29:26 +000020\input{copyright}
21
Guido van Rossum515834a1991-01-22 11:45:29 +000022\begin{abstract}
23
24\noindent
Guido van Rossum2ddd9781995-03-30 16:01:33 +000025Python is an extensible, interpreted, object-oriented programming
26language. It supports a wide range of applications, from simple text
27processing scripts to interactive WWW browsers.
28
Fred Drakeb2c6ef81997-12-18 15:56:05 +000029While the \emph{Python Reference Manual} describes the exact syntax and
Guido van Rossum2ddd9781995-03-30 16:01:33 +000030semantics of the language, it does not describe the standard library
31that is distributed with the language, and which greatly enhances its
32immediate usability. This library contains built-in modules (written
33in C) that provide access to system functionality such as file I/O
34that would otherwise be inaccessible to Python programmers, as well as
35modules written in Python that provide standardized solutions for many
36problems that occur in everyday programming. Some of these modules
37are explicitly designed to encourage and enhance the portability of
38Python programs.
39
40This library reference manual documents Python's standard library, as
41well as many optional library modules (which may or may not be
42available, depending on whether the underlying platform supports them
43and on the configuration choices made at compile time). It also
44documents the standard types of the language and its built-in
45functions and exceptions, many of which are not or incompletely
46documented in the Reference Manual.
47
48This manual assumes basic knowledge about the Python language. For an
Fred Drakeb2c6ef81997-12-18 15:56:05 +000049informal introduction to Python, see the \emph{Python Tutorial}; the
Fred Drakeb660b631998-01-16 16:34:34 +000050\emph{Python Reference Manual} remains the highest authority on
51syntactic and semantic questions. Finally, the manual entitled
52\emph{Extending and Embedding the Python Interpreter} describes how to
53add new extensions to Python and how to embed it in other applications.
Guido van Rossum515834a1991-01-22 11:45:29 +000054
55\end{abstract}
56
Fred Drake4d4f9e71998-01-13 22:25:02 +000057\tableofcontents
Guido van Rossum515834a1991-01-22 11:45:29 +000058
Guido van Rossum6938f061994-08-01 12:22:53 +000059 % Chapter title:
60
61\input{libintro} % Introduction
62
63\input{libobjs} % Built-in Types, Exceptions and Functions
64\input{libtypes}
65\input{libexcs}
66\input{libfuncs}
67
Guido van Rossumecde7811995-03-28 13:35:14 +000068\input{libpython} % Python Services
Guido van Rossum6938f061994-08-01 12:22:53 +000069\input{libsys}
Guido van Rossumecde7811995-03-28 13:35:14 +000070\input{libtypes2} % types is already taken :-(
Guido van Rossum36764b81997-08-30 20:02:25 +000071\input{libuserdict}
Guido van Rossum61ed4db1996-12-06 21:22:41 +000072\input{liboperator}
Guido van Rossumecde7811995-03-28 13:35:14 +000073\input{libtraceback}
Guido van Rossumd1883581995-02-15 15:53:08 +000074\input{libpickle}
Fred Drake2d754431998-01-21 04:58:39 +000075\input{libcopyreg}
Guido van Rossumd1883581995-02-15 15:53:08 +000076\input{libshelve}
77\input{libcopy}
Guido van Rossumecde7811995-03-28 13:35:14 +000078\input{libmarshal}
79\input{libimp}
Guido van Rossumca814701995-10-11 17:32:29 +000080\input{libparser}
Fred Drakeb0df5671998-02-18 15:59:13 +000081\input{libsymbol}
82\input{libtoken}
Fred Drake14bf3411997-10-06 21:40:48 +000083\input{libkeyword}
Guido van Rossum61c27031997-07-18 21:08:07 +000084\input{libcode}
Fred Drake00eb96a1997-10-06 21:26:03 +000085\input{libpprint}
Guido van Rossumeae121e1997-11-18 15:11:47 +000086\input{libdis}
Guido van Rossum571391b1997-04-03 22:41:49 +000087\input{libsite}
Guido van Rossum36764b81997-08-30 20:02:25 +000088\input{libuser}
Guido van Rossumecde7811995-03-28 13:35:14 +000089\input{libbltin} % really __builtin__
90\input{libmain} % really __main__
91
92\input{libstrings} % String Services
93\input{libstring}
Guido van Rossum9cb64801997-12-29 20:01:55 +000094\input{libre}
Guido van Rossumecde7811995-03-28 13:35:14 +000095\input{libregex}
96\input{libregsub}
97\input{libstruct}
Guido van Rossumcda3d7d1997-03-03 16:01:21 +000098\input{libstrio}
Guido van Rossum3486f271996-12-12 17:02:21 +000099\input{libsoundex}
Guido van Rossumecde7811995-03-28 13:35:14 +0000100
101\input{libmisc} % Miscellaneous Services
102\input{libmath}
Guido van Rossum84057a31997-07-17 16:15:18 +0000103\input{libcmath}
Guido van Rossumecde7811995-03-28 13:35:14 +0000104\input{libwhrandom}
Guido van Rossum571391b1997-04-03 22:41:49 +0000105\input{librandom}
Fred Drakeeac469c1998-04-09 04:51:07 +0000106%\input{librand}
Guido van Rossumecde7811995-03-28 13:35:14 +0000107\input{libarray}
Fred Drake4bde97f1998-04-04 05:50:12 +0000108\input{libfileinput}
Guido van Rossumecde7811995-03-28 13:35:14 +0000109
110\input{liballos} % Generic Operating System Services
111\input{libos}
112\input{libtime}
113\input{libgetopt}
Guido van Rossumdc46c7f1995-03-01 15:38:16 +0000114\input{libtempfile}
Guido van Rossumc0fcc441996-07-30 18:20:01 +0000115\input{liberrno}
Guido van Rossumb6a80261997-03-25 22:09:18 +0000116\input{libglob}
Guido van Rossume76b7a81997-04-27 21:25:52 +0000117\input{libfnmatch}
Guido van Rossumbc12f781997-11-20 21:04:27 +0000118\input{liblocale}
Guido van Rossumecde7811995-03-28 13:35:14 +0000119
120\input{libsomeos} % Optional Operating System Services
121\input{libsignal}
122\input{libsocket}
123\input{libselect}
124\input{libthread}
Barry Warsaw17c8e781997-11-20 19:54:16 +0000125\input{libqueue}
Guido van Rossum571391b1997-04-03 22:41:49 +0000126\input{libanydbm}
127\input{libwhichdb}
Guido van Rossumdfb41201997-04-30 19:40:10 +0000128\input{libzlib}
Guido van Rossum0fcbe8d1997-07-17 16:27:42 +0000129\input{libgzip}
Guido van Rossumecde7811995-03-28 13:35:14 +0000130
131\input{libunix} % UNIX Specific Services
132\input{libposix}
133\input{libppath} % == posixpath
134\input{libpwd}
135\input{libgrp}
Guido van Rossum5c6e3731996-04-10 16:18:20 +0000136\input{libcrypt}
Guido van Rossumecde7811995-03-28 13:35:14 +0000137\input{libdbm}
138\input{libgdbm}
139\input{libtermios}
140\input{libfcntl}
141\input{libposixfile}
Guido van Rossum3c7b2dc1996-12-18 18:37:05 +0000142\input{libresource}
Guido van Rossumfbe34fa1995-10-09 20:49:57 +0000143\input{libsyslog}
Guido van Rossum3dd68d31996-12-31 02:24:54 +0000144\input{libstat}
Fred Drake4fd12921997-06-12 16:05:46 +0000145\input{libcommands}
Guido van Rossumdf804f81995-03-02 12:38:39 +0000146
147\input{libpdb} % The Python Debugger
148
149\input{libprofile} % The Python Profiler
Guido van Rossum6938f061994-08-01 12:22:53 +0000150
Guido van Rossumecde7811995-03-28 13:35:14 +0000151\input{libwww} % Internet and WWW Services
Guido van Rossuma12ef941995-02-27 17:53:25 +0000152\input{libcgi}
Guido van Rossumcca8d2b1995-03-22 15:48:46 +0000153\input{liburllib}
154\input{libhttplib}
Guido van Rossum817a8421995-02-16 16:28:22 +0000155\input{libftplib}
156\input{libgopherlib}
Guido van Rossum817a8421995-02-16 16:28:22 +0000157\input{libnntplib}
Guido van Rossum817a8421995-02-16 16:28:22 +0000158\input{liburlparse}
Guido van Rossumcca8d2b1995-03-22 15:48:46 +0000159\input{libsgmllib}
Fred Drakee1980ed1996-10-09 14:36:54 +0000160\input{libhtmllib}
Guido van Rossumeae121e1997-11-18 15:11:47 +0000161\input{libxmllib}
Fred Drake53e84d51996-10-08 21:54:41 +0000162\input{libformatter}
Guido van Rossumcca8d2b1995-03-22 15:48:46 +0000163\input{librfc822}
164\input{libmimetools}
Fred Drake1aabe5e1998-02-19 18:29:18 +0000165\input{libbinhex}
166\input{libuu}
Jack Jansen4549b131995-08-29 11:30:24 +0000167\input{libbinascii}
Guido van Rossum40006cf1996-08-19 22:58:03 +0000168\input{libxdrlib}
Guido van Rossumb6a80261997-03-25 22:09:18 +0000169\input{libmailcap}
Guido van Rossume76b7a81997-04-27 21:25:52 +0000170\input{libbase64}
171\input{libquopri}
Guido van Rossum6181e001997-05-19 19:55:16 +0000172\input{libsocksvr}
Guido van Rossume5bb7901997-06-02 17:35:51 +0000173\input{libmailbox}
Guido van Rossumfd16ca41997-07-30 22:05:07 +0000174\input{libmimify}
Guido van Rossum9cb64801997-12-29 20:01:55 +0000175\input{libbasehttp}
Guido van Rossum817a8421995-02-16 16:28:22 +0000176
Guido van Rossum6e308d71996-10-22 01:11:53 +0000177\input{librestricted}
178\input{librexec}
179\input{libbastion}
180
Guido van Rossumecde7811995-03-28 13:35:14 +0000181\input{libmm} % Multimedia Services
Guido van Rossum6938f061994-08-01 12:22:53 +0000182\input{libaudioop}
183\input{libimageop}
Guido van Rossumecde7811995-03-28 13:35:14 +0000184\input{libaifc}
Guido van Rossum6938f061994-08-01 12:22:53 +0000185\input{libjpeg}
186\input{librgbimg}
Guido van Rossum40006cf1996-08-19 22:58:03 +0000187\input{libimghdr}
Guido van Rossum6938f061994-08-01 12:22:53 +0000188
Guido van Rossumecde7811995-03-28 13:35:14 +0000189\input{libcrypto} % Cryptographic Services
Guido van Rossum6938f061994-08-01 12:22:53 +0000190\input{libmd5}
191\input{libmpz}
192\input{librotor}
193
194%\input{libamoeba} % AMOEBA ONLY
195
Fred Drakeeac469c1998-04-09 04:51:07 +0000196%\input{libmac} % MACINTOSH ONLY
197%\input{libctb}
198%\input{libmacconsole}
199%\input{libmacdnr}
200%\input{libmacfs}
201%\input{libmacic}
202%\input{libmacos}
203%\input{libmacostools}
204%\input{libmactcp}
205%\input{libmacspeech}
206%\input{libmacui}
207%\input{libframework}
208%\input{libminiae}
Guido van Rossum6938f061994-08-01 12:22:53 +0000209
Guido van Rossume5bb7901997-06-02 17:35:51 +0000210%\input{libstdwin} % STDWIN ONLY
Guido van Rossum6938f061994-08-01 12:22:53 +0000211
212\input{libsgi} % SGI IRIX ONLY
213\input{libal}
Sjoerd Mullenderffd6de11995-03-28 11:56:52 +0000214\input{libcd}
Guido van Rossum6938f061994-08-01 12:22:53 +0000215\input{libfl}
216\input{libfm}
217\input{libgl}
218\input{libimgfile}
219%\input{libpanel}
220
221\input{libsun} % SUNOS ONLY
Fred Drake83c1a391998-02-19 18:59:48 +0000222\input{libsunaudio}
Guido van Rossum6938f061994-08-01 12:22:53 +0000223
Guido van Rossum612316f1997-03-14 04:12:52 +0000224\input{libundoc}
225
Fred Drakef3aa0e01998-03-17 06:23:13 +0000226%
227% The ugly "%begin{latexonly}" pseudo-environments are really just to
228% keep LaTeX2HTML quiet during the \renewcommand{} macros; they're
229% not really valuable.
230%
Fred Drake0b1337d1998-01-02 02:59:09 +0000231
Fred Drakef3aa0e01998-03-17 06:23:13 +0000232%begin{latexonly}
233\renewcommand{\indexname}{Module Index}
234%end{latexonly}
235\input{modlib.ind} % Module Index
236
237%begin{latexonly}
Fred Drake0b1337d1998-01-02 02:59:09 +0000238\renewcommand{\indexname}{Index}
Fred Drakef3aa0e01998-03-17 06:23:13 +0000239%end{latexonly}
240\input{lib.ind} % Index
Guido van Rossum515834a1991-01-22 11:45:29 +0000241
242\end{document}