blob: c6ca392d08df6cb9cbc8f22a6aec969774d40d0a [file] [log] [blame]
Guido van Rossum37953781992-04-06 14:04:04 +00001\documentstyle[twoside,11pt,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 Rossum61ed4db1996-12-06 21:22:41 +000080\input{liboperator}
Guido van Rossumecde7811995-03-28 13:35:14 +000081\input{libtraceback}
Guido van Rossumd1883581995-02-15 15:53:08 +000082\input{libpickle}
83\input{libshelve}
84\input{libcopy}
Guido van Rossumecde7811995-03-28 13:35:14 +000085\input{libmarshal}
86\input{libimp}
Guido van Rossumca814701995-10-11 17:32:29 +000087\input{libparser}
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}
93\input{libregex}
94\input{libregsub}
95\input{libstruct}
Guido van Rossumcda3d7d1997-03-03 16:01:21 +000096\input{libstrio}
Guido van Rossum3486f271996-12-12 17:02:21 +000097\input{libsoundex}
Guido van Rossumecde7811995-03-28 13:35:14 +000098
99\input{libmisc} % Miscellaneous Services
100\input{libmath}
101\input{librand}
102\input{libwhrandom}
103\input{libarray}
104
105\input{liballos} % Generic Operating System Services
106\input{libos}
107\input{libtime}
108\input{libgetopt}
Guido van Rossumdc46c7f1995-03-01 15:38:16 +0000109\input{libtempfile}
Guido van Rossumc0fcc441996-07-30 18:20:01 +0000110\input{liberrno}
Guido van Rossumb6a80261997-03-25 22:09:18 +0000111\input{libglob}
Guido van Rossumecde7811995-03-28 13:35:14 +0000112
113\input{libsomeos} % Optional Operating System Services
114\input{libsignal}
115\input{libsocket}
116\input{libselect}
117\input{libthread}
118
119\input{libunix} % UNIX Specific Services
120\input{libposix}
121\input{libppath} % == posixpath
122\input{libpwd}
123\input{libgrp}
Guido van Rossum5c6e3731996-04-10 16:18:20 +0000124\input{libcrypt}
Guido van Rossumecde7811995-03-28 13:35:14 +0000125\input{libdbm}
126\input{libgdbm}
127\input{libtermios}
128\input{libfcntl}
129\input{libposixfile}
Guido van Rossum3c7b2dc1996-12-18 18:37:05 +0000130\input{libresource}
Guido van Rossumfbe34fa1995-10-09 20:49:57 +0000131\input{libsyslog}
Guido van Rossum3dd68d31996-12-31 02:24:54 +0000132\input{libstat}
Guido van Rossumdf804f81995-03-02 12:38:39 +0000133
134\input{libpdb} % The Python Debugger
135
136\input{libprofile} % The Python Profiler
Guido van Rossum6938f061994-08-01 12:22:53 +0000137
Guido van Rossumecde7811995-03-28 13:35:14 +0000138\input{libwww} % Internet and WWW Services
Guido van Rossuma12ef941995-02-27 17:53:25 +0000139\input{libcgi}
Guido van Rossumcca8d2b1995-03-22 15:48:46 +0000140\input{liburllib}
141\input{libhttplib}
Guido van Rossum817a8421995-02-16 16:28:22 +0000142\input{libftplib}
143\input{libgopherlib}
Guido van Rossum817a8421995-02-16 16:28:22 +0000144\input{libnntplib}
Guido van Rossum817a8421995-02-16 16:28:22 +0000145\input{liburlparse}
Guido van Rossumcca8d2b1995-03-22 15:48:46 +0000146\input{libsgmllib}
Fred Drakee1980ed1996-10-09 14:36:54 +0000147\input{libhtmllib}
Fred Drake53e84d51996-10-08 21:54:41 +0000148\input{libformatter}
Guido van Rossumcca8d2b1995-03-22 15:48:46 +0000149\input{librfc822}
150\input{libmimetools}
Jack Jansen4549b131995-08-29 11:30:24 +0000151\input{libbinascii}
Guido van Rossum40006cf1996-08-19 22:58:03 +0000152\input{libxdrlib}
Guido van Rossumb6a80261997-03-25 22:09:18 +0000153\input{libmailcap}
Guido van Rossum817a8421995-02-16 16:28:22 +0000154
Guido van Rossum6e308d71996-10-22 01:11:53 +0000155\input{librestricted}
156\input{librexec}
157\input{libbastion}
158
Guido van Rossumecde7811995-03-28 13:35:14 +0000159\input{libmm} % Multimedia Services
Guido van Rossum6938f061994-08-01 12:22:53 +0000160\input{libaudioop}
161\input{libimageop}
Guido van Rossumecde7811995-03-28 13:35:14 +0000162\input{libaifc}
Guido van Rossum6938f061994-08-01 12:22:53 +0000163\input{libjpeg}
164\input{librgbimg}
Guido van Rossum40006cf1996-08-19 22:58:03 +0000165\input{libimghdr}
Guido van Rossum6938f061994-08-01 12:22:53 +0000166
Guido van Rossumecde7811995-03-28 13:35:14 +0000167\input{libcrypto} % Cryptographic Services
Guido van Rossum6938f061994-08-01 12:22:53 +0000168\input{libmd5}
169\input{libmpz}
170\input{librotor}
171
172%\input{libamoeba} % AMOEBA ONLY
173
Guido van Rossum86751151995-02-28 17:14:32 +0000174\input{libmac} % MACINTOSH ONLY
Guido van Rossumdc46c7f1995-03-01 15:38:16 +0000175\input{libctb}
176\input{libmacconsole}
Guido van Rossum85c4ff21995-03-07 10:12:11 +0000177\input{libmacdnr}
Guido van Rossumdc46c7f1995-03-01 15:38:16 +0000178\input{libmacfs}
Jack Jansenebed45f1995-08-14 13:40:05 +0000179\input{libmacos}
Jack Jansenda53c521995-10-10 14:43:20 +0000180\input{libmacostools}
Guido van Rossumdc46c7f1995-03-01 15:38:16 +0000181\input{libmactcp}
182\input{libmacspeech}
Jack Jansenda53c521995-10-10 14:43:20 +0000183\input{libmacui}
Guido van Rossum6938f061994-08-01 12:22:53 +0000184
185\input{libstdwin} % STDWIN ONLY
186
187\input{libsgi} % SGI IRIX ONLY
188\input{libal}
189%\input{libaudio}
Sjoerd Mullenderffd6de11995-03-28 11:56:52 +0000190\input{libcd}
Guido van Rossum6938f061994-08-01 12:22:53 +0000191\input{libfl}
192\input{libfm}
193\input{libgl}
194\input{libimgfile}
195%\input{libpanel}
196
197\input{libsun} % SUNOS ONLY
198
Guido van Rossum612316f1997-03-14 04:12:52 +0000199\input{libundoc}
200
Guido van Rossum6938f061994-08-01 12:22:53 +0000201\input{lib.ind} % Index
Guido van Rossum515834a1991-01-22 11:45:29 +0000202
203\end{document}