blob: f1fd33e4db393f4b9cdc478becffc863fba72321 [file] [log] [blame]
Fred Drakedca87921998-01-13 16:53:23 +00001\documentclass[twoside,openright]{report}
Fred Drake1f8449a1998-01-09 05:36:43 +00002\usepackage{myformat}
Guido van Rossum19f1b821991-11-12 15:41:57 +00003
Guido van Rossum86751151995-02-28 17:14:32 +00004% NOTE: this file controls which chapters/sections of the library
5% manual are actually printed. It is easy to customize your manual
6% by commenting out sections that you're not interested in.
7
Guido van Rossum6938f061994-08-01 12:22:53 +00008\title{Python Library Reference}
Guido van Rossum515834a1991-01-22 11:45:29 +00009
Guido van Rossum16cd7f91994-10-06 10:29:26 +000010\input{boilerplate}
Guido van Rossum83eb9621993-11-23 16:28:45 +000011
Guido van Rossum6938f061994-08-01 12:22:53 +000012\makeindex % tell \index to actually write the .idx file
13
Guido van Rossum1230c081992-01-07 16:40:44 +000014
Guido van Rossum515834a1991-01-22 11:45:29 +000015\begin{document}
Guido van Rossum6938f061994-08-01 12:22:53 +000016
Fred Drake1f8449a1998-01-09 05:36:43 +000017\pagestyle{empty}
Guido van Rossum515834a1991-01-22 11:45:29 +000018\pagenumbering{roman}
19
20\maketitle
21
Guido van Rossum16cd7f91994-10-06 10:29:26 +000022\input{copyright}
23
Guido van Rossum515834a1991-01-22 11:45:29 +000024\begin{abstract}
25
26\noindent
Guido van Rossum2ddd9781995-03-30 16:01:33 +000027Python is an extensible, interpreted, object-oriented programming
28language. It supports a wide range of applications, from simple text
29processing scripts to interactive WWW browsers.
30
Fred Drakeb2c6ef81997-12-18 15:56:05 +000031While the \emph{Python Reference Manual} describes the exact syntax and
Guido van Rossum2ddd9781995-03-30 16:01:33 +000032semantics of the language, it does not describe the standard library
33that is distributed with the language, and which greatly enhances its
34immediate usability. This library contains built-in modules (written
35in C) that provide access to system functionality such as file I/O
36that would otherwise be inaccessible to Python programmers, as well as
37modules written in Python that provide standardized solutions for many
38problems that occur in everyday programming. Some of these modules
39are explicitly designed to encourage and enhance the portability of
40Python programs.
41
42This library reference manual documents Python's standard library, as
43well as many optional library modules (which may or may not be
44available, depending on whether the underlying platform supports them
45and on the configuration choices made at compile time). It also
46documents the standard types of the language and its built-in
47functions and exceptions, many of which are not or incompletely
48documented in the Reference Manual.
49
50This manual assumes basic knowledge about the Python language. For an
Fred Drakeb2c6ef81997-12-18 15:56:05 +000051informal introduction to Python, see the \emph{Python Tutorial}; the
Fred Drakeb660b631998-01-16 16:34:34 +000052\emph{Python Reference Manual} remains the highest authority on
53syntactic and semantic questions. Finally, the manual entitled
54\emph{Extending and Embedding the Python Interpreter} describes how to
55add new extensions to Python and how to embed it in other applications.
Guido van Rossum515834a1991-01-22 11:45:29 +000056
57\end{abstract}
58
Fred Drake4d4f9e71998-01-13 22:25:02 +000059\tableofcontents
Guido van Rossum515834a1991-01-22 11:45:29 +000060
61\pagenumbering{arabic}
Guido van Rossumbe3eb961992-03-24 13:34:33 +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
68\input{libtypes}
69\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}
Guido van Rossumecde7811995-03-28 13:35:14 +000074\input{libtypes2} % types is already taken :-(
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}
Guido van Rossum0fcbe8d1997-07-17 16:27:42 +000084\input{libni}
Guido van Rossumca814701995-10-11 17:32:29 +000085\input{libparser}
Fred Drake14bf3411997-10-06 21:40:48 +000086\input{libkeyword}
Guido van Rossum61c27031997-07-18 21:08:07 +000087\input{libcode}
Fred Drake00eb96a1997-10-06 21:26:03 +000088\input{libpprint}
Guido van Rossumeae121e1997-11-18 15:11:47 +000089\input{libdis}
Guido van Rossum571391b1997-04-03 22:41:49 +000090\input{libsite}
Guido van Rossum36764b81997-08-30 20:02:25 +000091\input{libuser}
Guido van Rossumecde7811995-03-28 13:35:14 +000092\input{libbltin} % really __builtin__
93\input{libmain} % really __main__
94
95\input{libstrings} % String Services
96\input{libstring}
Guido van Rossum9cb64801997-12-29 20:01:55 +000097\input{libre}
Guido van Rossumecde7811995-03-28 13:35:14 +000098\input{libregex}
99\input{libregsub}
100\input{libstruct}
Guido van Rossumcda3d7d1997-03-03 16:01:21 +0000101\input{libstrio}
Guido van Rossum3486f271996-12-12 17:02:21 +0000102\input{libsoundex}
Guido van Rossumecde7811995-03-28 13:35:14 +0000103
104\input{libmisc} % Miscellaneous Services
105\input{libmath}
Guido van Rossum84057a31997-07-17 16:15:18 +0000106\input{libcmath}
Guido van Rossumecde7811995-03-28 13:35:14 +0000107\input{libwhrandom}
Guido van Rossum571391b1997-04-03 22:41:49 +0000108\input{librandom}
109\input{librand}
Guido van Rossumecde7811995-03-28 13:35:14 +0000110\input{libarray}
111
112\input{liballos} % Generic Operating System Services
113\input{libos}
114\input{libtime}
115\input{libgetopt}
Guido van Rossumdc46c7f1995-03-01 15:38:16 +0000116\input{libtempfile}
Guido van Rossumc0fcc441996-07-30 18:20:01 +0000117\input{liberrno}
Guido van Rossumb6a80261997-03-25 22:09:18 +0000118\input{libglob}
Guido van Rossume76b7a81997-04-27 21:25:52 +0000119\input{libfnmatch}
Guido van Rossumbc12f781997-11-20 21:04:27 +0000120\input{liblocale}
Guido van Rossumecde7811995-03-28 13:35:14 +0000121
122\input{libsomeos} % Optional Operating System Services
123\input{libsignal}
124\input{libsocket}
125\input{libselect}
126\input{libthread}
Barry Warsaw17c8e781997-11-20 19:54:16 +0000127\input{libqueue}
Guido van Rossum571391b1997-04-03 22:41:49 +0000128\input{libanydbm}
129\input{libwhichdb}
Guido van Rossumdfb41201997-04-30 19:40:10 +0000130\input{libzlib}
Guido van Rossum0fcbe8d1997-07-17 16:27:42 +0000131\input{libgzip}
Guido van Rossumecde7811995-03-28 13:35:14 +0000132
133\input{libunix} % UNIX Specific Services
134\input{libposix}
135\input{libppath} % == posixpath
136\input{libpwd}
137\input{libgrp}
Guido van Rossum5c6e3731996-04-10 16:18:20 +0000138\input{libcrypt}
Guido van Rossumecde7811995-03-28 13:35:14 +0000139\input{libdbm}
140\input{libgdbm}
141\input{libtermios}
142\input{libfcntl}
143\input{libposixfile}
Guido van Rossum3c7b2dc1996-12-18 18:37:05 +0000144\input{libresource}
Guido van Rossumfbe34fa1995-10-09 20:49:57 +0000145\input{libsyslog}
Guido van Rossum3dd68d31996-12-31 02:24:54 +0000146\input{libstat}
Fred Drake4fd12921997-06-12 16:05:46 +0000147\input{libcommands}
Guido van Rossumdf804f81995-03-02 12:38:39 +0000148
149\input{libpdb} % The Python Debugger
150
151\input{libprofile} % The Python Profiler
Guido van Rossum6938f061994-08-01 12:22:53 +0000152
Guido van Rossumecde7811995-03-28 13:35:14 +0000153\input{libwww} % Internet and WWW Services
Guido van Rossuma12ef941995-02-27 17:53:25 +0000154\input{libcgi}
Guido van Rossumcca8d2b1995-03-22 15:48:46 +0000155\input{liburllib}
156\input{libhttplib}
Guido van Rossum817a8421995-02-16 16:28:22 +0000157\input{libftplib}
158\input{libgopherlib}
Guido van Rossum817a8421995-02-16 16:28:22 +0000159\input{libnntplib}
Guido van Rossum817a8421995-02-16 16:28:22 +0000160\input{liburlparse}
Guido van Rossumcca8d2b1995-03-22 15:48:46 +0000161\input{libsgmllib}
Fred Drakee1980ed1996-10-09 14:36:54 +0000162\input{libhtmllib}
Guido van Rossumeae121e1997-11-18 15:11:47 +0000163\input{libxmllib}
Fred Drake53e84d51996-10-08 21:54:41 +0000164\input{libformatter}
Guido van Rossumcca8d2b1995-03-22 15:48:46 +0000165\input{librfc822}
166\input{libmimetools}
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
Guido van Rossum86751151995-02-28 17:14:32 +0000196\input{libmac} % MACINTOSH ONLY
Guido van Rossumdc46c7f1995-03-01 15:38:16 +0000197\input{libctb}
198\input{libmacconsole}
Guido van Rossum85c4ff21995-03-07 10:12:11 +0000199\input{libmacdnr}
Guido van Rossumdc46c7f1995-03-01 15:38:16 +0000200\input{libmacfs}
Guido van Rossume229d861997-08-18 15:14:26 +0000201\input{libmacic}
Jack Jansenebed45f1995-08-14 13:40:05 +0000202\input{libmacos}
Jack Jansenda53c521995-10-10 14:43:20 +0000203\input{libmacostools}
Guido van Rossumdc46c7f1995-03-01 15:38:16 +0000204\input{libmactcp}
205\input{libmacspeech}
Jack Jansenda53c521995-10-10 14:43:20 +0000206\input{libmacui}
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
220
Guido van Rossum612316f1997-03-14 04:12:52 +0000221\input{libundoc}
222
Fred Drake0b1337d1998-01-02 02:59:09 +0000223\renewcommand{\indexname}{Module Index}
224\input{modules.ind} % Module Index
225
226\renewcommand{\indexname}{Index}
Guido van Rossum6938f061994-08-01 12:22:53 +0000227\input{lib.ind} % Index
Guido van Rossum515834a1991-01-22 11:45:29 +0000228
229\end{document}