blob: e9f184acd58cbb7ee9ad3b9248cba98b25245d72 [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}
Fred Drakec46864e1999-06-14 19:49:50 +000078\input{liblinecache}
Guido van Rossumd1883581995-02-15 15:53:08 +000079\input{libpickle}
Fred Drake23f414c1998-08-11 15:47:16 +000080\input{libcopyreg} % really copy_reg
Guido van Rossumd1883581995-02-15 15:53:08 +000081\input{libshelve}
82\input{libcopy}
Guido van Rossumecde7811995-03-28 13:35:14 +000083\input{libmarshal}
84\input{libimp}
Fred Drakebd400881998-04-09 11:04:19 +000085%\input{libni}
Guido van Rossumca814701995-10-11 17:32:29 +000086\input{libparser}
Fred Drakeb0df5671998-02-18 15:59:13 +000087\input{libsymbol}
88\input{libtoken}
Fred Drake14bf3411997-10-06 21:40:48 +000089\input{libkeyword}
Fred Drake4d358b51999-02-18 20:40:26 +000090\input{libtokenize}
91\input{libpyclbr}
Guido van Rossum61c27031997-07-18 21:08:07 +000092\input{libcode}
Fred Drake00eb96a1997-10-06 21:26:03 +000093\input{libpprint}
Fred Drake9d814c61999-01-27 17:20:33 +000094\input{librepr}
Fred Drake23f414c1998-08-11 15:47:16 +000095\input{libpycompile} % really py_compile
96\input{libcompileall}
Guido van Rossumeae121e1997-11-18 15:11:47 +000097\input{libdis}
Fred Drake26da2841999-06-17 15:12:16 +000098\input{libnew}
Guido van Rossum571391b1997-04-03 22:41:49 +000099\input{libsite}
Guido van Rossum36764b81997-08-30 20:02:25 +0000100\input{libuser}
Guido van Rossumecde7811995-03-28 13:35:14 +0000101\input{libbltin} % really __builtin__
102\input{libmain} % really __main__
103
104\input{libstrings} % String Services
105\input{libstring}
Guido van Rossum9cb64801997-12-29 20:01:55 +0000106\input{libre}
Guido van Rossumecde7811995-03-28 13:35:14 +0000107\input{libregex}
108\input{libregsub}
109\input{libstruct}
Fred Drake7df4dd71999-06-11 18:36:42 +0000110\input{libfpformat}
Fred Drake64e3b431998-07-24 13:56:11 +0000111\input{libstringio}
Fred Drake363ab1a1998-04-09 14:23:48 +0000112%\input{libsoundex}
Guido van Rossumecde7811995-03-28 13:35:14 +0000113
114\input{libmisc} % Miscellaneous Services
115\input{libmath}
Guido van Rossum84057a31997-07-17 16:15:18 +0000116\input{libcmath}
Guido van Rossumecde7811995-03-28 13:35:14 +0000117\input{libwhrandom}
Guido van Rossum571391b1997-04-03 22:41:49 +0000118\input{librandom}
Fred Drakeeac469c1998-04-09 04:51:07 +0000119%\input{librand}
Fred Drake188a8471998-04-28 18:27:53 +0000120\input{libbisect}
Guido van Rossumecde7811995-03-28 13:35:14 +0000121\input{libarray}
Fred Drakebc866ce1999-01-26 15:47:59 +0000122\input{libcfgparser}
Fred Drake4bde97f1998-04-04 05:50:12 +0000123\input{libfileinput}
Fred Drakef8d50bf1998-04-28 14:29:27 +0000124\input{libcalendar}
Guido van Rossum8668e8e1998-06-28 17:55:53 +0000125\input{libcmd}
Guido van Rossum5e97c9d1998-12-22 05:18:24 +0000126\input{libshlex}
Guido van Rossumecde7811995-03-28 13:35:14 +0000127
128\input{liballos} % Generic Operating System Services
129\input{libos}
Fred Drake12ba7861999-02-02 19:00:37 +0000130\input{libposixpath} % os.path
Fred Drake26da2841999-06-17 15:12:16 +0000131\input{libdircache}
Fred Drake5254a6d1999-04-22 15:01:44 +0000132\input{libstat}
Fred Drake26da2841999-06-17 15:12:16 +0000133\input{libstatcache}
Fred Drake4755e7d1999-06-21 18:25:49 +0000134\input{libstatvfs}
Fred Drake26da2841999-06-17 15:12:16 +0000135\input{libcmp}
136\input{libcmpcache}
Guido van Rossumecde7811995-03-28 13:35:14 +0000137\input{libtime}
Fred Drake99e2c391998-12-22 23:37:46 +0000138\input{libgetpass}
Guido van Rossumecde7811995-03-28 13:35:14 +0000139\input{libgetopt}
Guido van Rossumdc46c7f1995-03-01 15:38:16 +0000140\input{libtempfile}
Guido van Rossumc0fcc441996-07-30 18:20:01 +0000141\input{liberrno}
Guido van Rossumb6a80261997-03-25 22:09:18 +0000142\input{libglob}
Guido van Rossume76b7a81997-04-27 21:25:52 +0000143\input{libfnmatch}
Fred Drake449e18f1998-12-28 20:16:58 +0000144\input{libshutil}
Guido van Rossumbc12f781997-11-20 21:04:27 +0000145\input{liblocale}
Guido van Rossumecde7811995-03-28 13:35:14 +0000146
147\input{libsomeos} % Optional Operating System Services
148\input{libsignal}
149\input{libsocket}
150\input{libselect}
151\input{libthread}
Guido van Rossumd623d20e7d61998-07-20 17:34:50 +0000152\input{libthreading}
Barry Warsaw17c8e781997-11-20 19:54:16 +0000153\input{libqueue}
Guido van Rossum571391b1997-04-03 22:41:49 +0000154\input{libanydbm}
Fred Drake666255f1999-04-15 15:11:40 +0000155\input{libdbhash}
Guido van Rossum571391b1997-04-03 22:41:49 +0000156\input{libwhichdb}
Fred Drake4ae52691999-04-19 21:21:28 +0000157\input{libbsddb}
Guido van Rossumdfb41201997-04-30 19:40:10 +0000158\input{libzlib}
Guido van Rossum0fcbe8d1997-07-17 16:27:42 +0000159\input{libgzip}
Fred Drake4755e7d1999-06-21 18:25:49 +0000160\input{librlcompleter}
Guido van Rossumecde7811995-03-28 13:35:14 +0000161
162\input{libunix} % UNIX Specific Services
163\input{libposix}
Guido van Rossumecde7811995-03-28 13:35:14 +0000164\input{libpwd}
165\input{libgrp}
Guido van Rossum5c6e3731996-04-10 16:18:20 +0000166\input{libcrypt}
Guido van Rossumecde7811995-03-28 13:35:14 +0000167\input{libdbm}
168\input{libgdbm}
169\input{libtermios}
170\input{libfcntl}
Fred Drake4755e7d1999-06-21 18:25:49 +0000171\input{libpipes}
Guido van Rossumecde7811995-03-28 13:35:14 +0000172\input{libposixfile}
Guido van Rossum3c7b2dc1996-12-18 18:37:05 +0000173\input{libresource}
Guido van Rossumfbe34fa1995-10-09 20:49:57 +0000174\input{libsyslog}
Fred Drake188a8471998-04-28 18:27:53 +0000175\input{libpopen2}
Fred Drake4fd12921997-06-12 16:05:46 +0000176\input{libcommands}
Guido van Rossumdf804f81995-03-02 12:38:39 +0000177
178\input{libpdb} % The Python Debugger
179
180\input{libprofile} % The Python Profiler
Guido van Rossum6938f061994-08-01 12:22:53 +0000181
Fred Drakef44c4851998-08-07 15:58:31 +0000182\input{internet} % Internet Protocols
Guido van Rossuma12ef941995-02-27 17:53:25 +0000183\input{libcgi}
Guido van Rossumcca8d2b1995-03-22 15:48:46 +0000184\input{liburllib}
185\input{libhttplib}
Guido van Rossum817a8421995-02-16 16:28:22 +0000186\input{libftplib}
187\input{libgopherlib}
Fred Drakea4684041998-04-24 20:49:02 +0000188\input{libpoplib}
Fred Drake1e0f8bf1998-04-11 04:27:07 +0000189\input{libimaplib}
Guido van Rossum817a8421995-02-16 16:28:22 +0000190\input{libnntplib}
Guido van Rossum8668e8e1998-06-28 17:55:53 +0000191\input{libsmtplib}
Fred Drake658cef01999-03-15 15:44:18 +0000192\input{libtelnetlib}
Guido van Rossum817a8421995-02-16 16:28:22 +0000193\input{liburlparse}
Fred Drakef44c4851998-08-07 15:58:31 +0000194\input{libsocksvr}
195\input{libbasehttp}
Fred Drakec46864e1999-06-14 19:49:50 +0000196\input{libsimplehttp}
197\input{libcgihttp}
Fred Drakef44c4851998-08-07 15:58:31 +0000198
199\input{netdata}
Guido van Rossumcca8d2b1995-03-22 15:48:46 +0000200\input{libsgmllib}
Fred Drakee1980ed1996-10-09 14:36:54 +0000201\input{libhtmllib}
Guido van Rossumeae121e1997-11-18 15:11:47 +0000202\input{libxmllib}
Fred Drake53e84d51996-10-08 21:54:41 +0000203\input{libformatter}
Guido van Rossumcca8d2b1995-03-22 15:48:46 +0000204\input{librfc822}
205\input{libmimetools}
Fred Drake28bc7111999-02-12 19:26:09 +0000206\input{libmimewriter}
Guido van Rossum8668e8e1998-06-28 17:55:53 +0000207\input{libmultifile}
Fred Drake1aabe5e1998-02-19 18:29:18 +0000208\input{libbinhex}
209\input{libuu}
Jack Jansen4549b131995-08-29 11:30:24 +0000210\input{libbinascii}
Guido van Rossum40006cf1996-08-19 22:58:03 +0000211\input{libxdrlib}
Guido van Rossumb6a80261997-03-25 22:09:18 +0000212\input{libmailcap}
Fred Drakeb818b461998-05-19 15:03:45 +0000213\input{libmimetypes}
Guido van Rossume76b7a81997-04-27 21:25:52 +0000214\input{libbase64}
215\input{libquopri}
Guido van Rossume5bb7901997-06-02 17:35:51 +0000216\input{libmailbox}
Fred Drake658cef01999-03-15 15:44:18 +0000217\input{libmhlib}
Guido van Rossumfd16ca41997-07-30 22:05:07 +0000218\input{libmimify}
Guido van Rossum5e97c9d1998-12-22 05:18:24 +0000219\input{libnetrc}
Guido van Rossum817a8421995-02-16 16:28:22 +0000220
Guido van Rossum6e308d71996-10-22 01:11:53 +0000221\input{librestricted}
222\input{librexec}
223\input{libbastion}
224
Guido van Rossumecde7811995-03-28 13:35:14 +0000225\input{libmm} % Multimedia Services
Guido van Rossum6938f061994-08-01 12:22:53 +0000226\input{libaudioop}
227\input{libimageop}
Guido van Rossumecde7811995-03-28 13:35:14 +0000228\input{libaifc}
Fred Drake26da2841999-06-17 15:12:16 +0000229\input{libwave}
Fred Drake4ae52691999-04-19 21:21:28 +0000230\input{libcolorsys}
Guido van Rossum6938f061994-08-01 12:22:53 +0000231\input{librgbimg}
Guido van Rossum40006cf1996-08-19 22:58:03 +0000232\input{libimghdr}
Fred Drake60adb361999-01-05 23:09:12 +0000233\input{libsndhdr}
Guido van Rossum6938f061994-08-01 12:22:53 +0000234
Guido van Rossumecde7811995-03-28 13:35:14 +0000235\input{libcrypto} % Cryptographic Services
Guido van Rossum6938f061994-08-01 12:22:53 +0000236\input{libmd5}
Fred Drake957ac3f1999-04-23 21:52:18 +0000237\input{libsha}
Guido van Rossum6938f061994-08-01 12:22:53 +0000238\input{libmpz}
239\input{librotor}
240
241%\input{libamoeba} % AMOEBA ONLY
242
Guido van Rossume5bb7901997-06-02 17:35:51 +0000243%\input{libstdwin} % STDWIN ONLY
Guido van Rossum6938f061994-08-01 12:22:53 +0000244
245\input{libsgi} % SGI IRIX ONLY
246\input{libal}
Sjoerd Mullenderffd6de11995-03-28 11:56:52 +0000247\input{libcd}
Guido van Rossum6938f061994-08-01 12:22:53 +0000248\input{libfl}
249\input{libfm}
250\input{libgl}
251\input{libimgfile}
Fred Drake9ea3e361999-01-20 15:55:20 +0000252\input{libjpeg}
Guido van Rossum6938f061994-08-01 12:22:53 +0000253%\input{libpanel}
254
255\input{libsun} % SUNOS ONLY
Fred Drake83c1a391998-02-19 18:59:48 +0000256\input{libsunaudio}
Guido van Rossum6938f061994-08-01 12:22:53 +0000257
Fred Drakec7b72db1999-02-16 19:18:38 +0000258\input{windows} % MS Windows ONLY
259\input{libmsvcrt}
260\input{libwinsound}
261
Guido van Rossum612316f1997-03-14 04:12:52 +0000262\input{libundoc}
263
Fred Drakef3aa0e01998-03-17 06:23:13 +0000264%
265% The ugly "%begin{latexonly}" pseudo-environments are really just to
266% keep LaTeX2HTML quiet during the \renewcommand{} macros; they're
267% not really valuable.
268%
Fred Drake0b1337d1998-01-02 02:59:09 +0000269
Fred Drakef3aa0e01998-03-17 06:23:13 +0000270%begin{latexonly}
271\renewcommand{\indexname}{Module Index}
272%end{latexonly}
273\input{modlib.ind} % Module Index
274
275%begin{latexonly}
Fred Drake0b1337d1998-01-02 02:59:09 +0000276\renewcommand{\indexname}{Index}
Fred Drakef3aa0e01998-03-17 06:23:13 +0000277%end{latexonly}
278\input{lib.ind} % Index
Guido van Rossum515834a1991-01-22 11:45:29 +0000279
280\end{document}