blob: 078ea856b67f671cefe65515f23123b0c9810410 [file] [log] [blame]
Fred Drake4fd12921997-06-12 16:05:46 +00001\documentstyle[twoside,openright,10pt,myformat]{report}
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\pagenumbering{roman}
17
18\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
29While the {\em Python Reference Manual} describes the exact syntax and
30semantics 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
49informal introduction to Python, see the {\em Python Tutorial}; the
50Python Reference Manual remains the highest authority on syntactic and
51semantic questions. Finally, the manual entitled {\em Extending and
52Embedding the Python Interpreter} describes how to add new extensions
53to Python and how to embed it in other applications.
Guido van Rossum515834a1991-01-22 11:45:29 +000054
55\end{abstract}
56
57\pagebreak
58
Guido van Rossum9b573851992-01-29 14:46:35 +000059{
60\parskip = 0mm
Guido van Rossum515834a1991-01-22 11:45:29 +000061\tableofcontents
Guido van Rossum9b573851992-01-29 14:46:35 +000062}
Guido van Rossum515834a1991-01-22 11:45:29 +000063
64\pagebreak
65
66\pagenumbering{arabic}
Guido van Rossumbe3eb961992-03-24 13:34:33 +000067
Guido van Rossum6938f061994-08-01 12:22:53 +000068 % Chapter title:
69
70\input{libintro} % Introduction
71
72\input{libobjs} % Built-in Types, Exceptions and Functions
73\input{libtypes}
74\input{libexcs}
75\input{libfuncs}
76
Guido van Rossumecde7811995-03-28 13:35:14 +000077\input{libpython} % Python Services
Guido van Rossum6938f061994-08-01 12:22:53 +000078\input{libsys}
Guido van Rossumecde7811995-03-28 13:35:14 +000079\input{libtypes2} % types is already taken :-(
Guido van Rossum36764b81997-08-30 20:02:25 +000080\input{libuserdict}
Guido van Rossum61ed4db1996-12-06 21:22:41 +000081\input{liboperator}
Guido van Rossumecde7811995-03-28 13:35:14 +000082\input{libtraceback}
Guido van Rossumd1883581995-02-15 15:53:08 +000083\input{libpickle}
84\input{libshelve}
85\input{libcopy}
Guido van Rossumecde7811995-03-28 13:35:14 +000086\input{libmarshal}
87\input{libimp}
Guido van Rossum0fcbe8d1997-07-17 16:27:42 +000088\input{libni}
Guido van Rossumca814701995-10-11 17:32:29 +000089\input{libparser}
Fred Drake14bf3411997-10-06 21:40:48 +000090\input{libkeyword}
Guido van Rossum61c27031997-07-18 21:08:07 +000091\input{libcode}
Fred Drake00eb96a1997-10-06 21:26:03 +000092\input{libpprint}
Guido van Rossum571391b1997-04-03 22:41:49 +000093\input{libsite}
Guido van Rossum36764b81997-08-30 20:02:25 +000094\input{libuser}
Guido van Rossumecde7811995-03-28 13:35:14 +000095\input{libbltin} % really __builtin__
96\input{libmain} % really __main__
97
98\input{libstrings} % String Services
99\input{libstring}
100\input{libregex}
101\input{libregsub}
Guido van Rossum1acceb01997-08-14 23:12:18 +0000102\input{libre}
Guido van Rossumecde7811995-03-28 13:35:14 +0000103\input{libstruct}
Guido van Rossumcda3d7d1997-03-03 16:01:21 +0000104\input{libstrio}
Guido van Rossum3486f271996-12-12 17:02:21 +0000105\input{libsoundex}
Guido van Rossumecde7811995-03-28 13:35:14 +0000106
107\input{libmisc} % Miscellaneous Services
108\input{libmath}
Guido van Rossum84057a31997-07-17 16:15:18 +0000109\input{libcmath}
Guido van Rossumecde7811995-03-28 13:35:14 +0000110\input{libwhrandom}
Guido van Rossum571391b1997-04-03 22:41:49 +0000111\input{librandom}
112\input{librand}
Guido van Rossumecde7811995-03-28 13:35:14 +0000113\input{libarray}
114
115\input{liballos} % Generic Operating System Services
116\input{libos}
117\input{libtime}
118\input{libgetopt}
Guido van Rossumdc46c7f1995-03-01 15:38:16 +0000119\input{libtempfile}
Guido van Rossumc0fcc441996-07-30 18:20:01 +0000120\input{liberrno}
Guido van Rossumb6a80261997-03-25 22:09:18 +0000121\input{libglob}
Guido van Rossume76b7a81997-04-27 21:25:52 +0000122\input{libfnmatch}
Guido van Rossumecde7811995-03-28 13:35:14 +0000123
124\input{libsomeos} % Optional Operating System Services
125\input{libsignal}
126\input{libsocket}
127\input{libselect}
128\input{libthread}
Guido van Rossum571391b1997-04-03 22:41:49 +0000129\input{libanydbm}
130\input{libwhichdb}
Guido van Rossumdfb41201997-04-30 19:40:10 +0000131\input{libzlib}
Guido van Rossum0fcbe8d1997-07-17 16:27:42 +0000132\input{libgzip}
Guido van Rossumecde7811995-03-28 13:35:14 +0000133
134\input{libunix} % UNIX Specific Services
135\input{libposix}
136\input{libppath} % == posixpath
137\input{libpwd}
138\input{libgrp}
Guido van Rossum5c6e3731996-04-10 16:18:20 +0000139\input{libcrypt}
Guido van Rossumecde7811995-03-28 13:35:14 +0000140\input{libdbm}
141\input{libgdbm}
142\input{libtermios}
143\input{libfcntl}
144\input{libposixfile}
Guido van Rossum3c7b2dc1996-12-18 18:37:05 +0000145\input{libresource}
Guido van Rossumfbe34fa1995-10-09 20:49:57 +0000146\input{libsyslog}
Guido van Rossum3dd68d31996-12-31 02:24:54 +0000147\input{libstat}
Fred Drake4fd12921997-06-12 16:05:46 +0000148\input{libcommands}
Guido van Rossumdf804f81995-03-02 12:38:39 +0000149
150\input{libpdb} % The Python Debugger
151
152\input{libprofile} % The Python Profiler
Guido van Rossum6938f061994-08-01 12:22:53 +0000153
Guido van Rossumecde7811995-03-28 13:35:14 +0000154\input{libwww} % Internet and WWW Services
Guido van Rossuma12ef941995-02-27 17:53:25 +0000155\input{libcgi}
Guido van Rossumcca8d2b1995-03-22 15:48:46 +0000156\input{liburllib}
157\input{libhttplib}
Guido van Rossum817a8421995-02-16 16:28:22 +0000158\input{libftplib}
159\input{libgopherlib}
Guido van Rossum817a8421995-02-16 16:28:22 +0000160\input{libnntplib}
Guido van Rossum817a8421995-02-16 16:28:22 +0000161\input{liburlparse}
Guido van Rossumcca8d2b1995-03-22 15:48:46 +0000162\input{libsgmllib}
Fred Drakee1980ed1996-10-09 14:36:54 +0000163\input{libhtmllib}
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 Rossum817a8421995-02-16 16:28:22 +0000175
Guido van Rossum6e308d71996-10-22 01:11:53 +0000176\input{librestricted}
177\input{librexec}
178\input{libbastion}
179
Guido van Rossumecde7811995-03-28 13:35:14 +0000180\input{libmm} % Multimedia Services
Guido van Rossum6938f061994-08-01 12:22:53 +0000181\input{libaudioop}
182\input{libimageop}
Guido van Rossumecde7811995-03-28 13:35:14 +0000183\input{libaifc}
Guido van Rossum6938f061994-08-01 12:22:53 +0000184\input{libjpeg}
185\input{librgbimg}
Guido van Rossum40006cf1996-08-19 22:58:03 +0000186\input{libimghdr}
Guido van Rossum6938f061994-08-01 12:22:53 +0000187
Guido van Rossumecde7811995-03-28 13:35:14 +0000188\input{libcrypto} % Cryptographic Services
Guido van Rossum6938f061994-08-01 12:22:53 +0000189\input{libmd5}
190\input{libmpz}
191\input{librotor}
192
193%\input{libamoeba} % AMOEBA ONLY
194
Guido van Rossum86751151995-02-28 17:14:32 +0000195\input{libmac} % MACINTOSH ONLY
Guido van Rossumdc46c7f1995-03-01 15:38:16 +0000196\input{libctb}
197\input{libmacconsole}
Guido van Rossum85c4ff21995-03-07 10:12:11 +0000198\input{libmacdnr}
Guido van Rossumdc46c7f1995-03-01 15:38:16 +0000199\input{libmacfs}
Guido van Rossume229d861997-08-18 15:14:26 +0000200\input{libmacic}
Jack Jansenebed45f1995-08-14 13:40:05 +0000201\input{libmacos}
Jack Jansenda53c521995-10-10 14:43:20 +0000202\input{libmacostools}
Guido van Rossumdc46c7f1995-03-01 15:38:16 +0000203\input{libmactcp}
204\input{libmacspeech}
Jack Jansenda53c521995-10-10 14:43:20 +0000205\input{libmacui}
Guido van Rossum6938f061994-08-01 12:22:53 +0000206
Guido van Rossume5bb7901997-06-02 17:35:51 +0000207%\input{libstdwin} % STDWIN ONLY
Guido van Rossum6938f061994-08-01 12:22:53 +0000208
209\input{libsgi} % SGI IRIX ONLY
210\input{libal}
211%\input{libaudio}
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
Guido van Rossum6938f061994-08-01 12:22:53 +0000223\input{lib.ind} % Index
Guido van Rossum515834a1991-01-22 11:45:29 +0000224
225\end{document}