summaryrefslogtreecommitdiffstats
path: root/Doc/lib/lib.tex
blob: f57c961fb0ee3814fa15a6f04077c366995189f4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
\documentclass{manual}

% NOTE: this file controls which chapters/sections of the library
% manual are actually printed.  It is easy to customize your manual
% by commenting out sections that you're not interested in.

\title{Python Library Reference}

\input{boilerplate}

\makeindex			% tell \index to actually write the
				% .idx file
\makemodindex			% ... and the module index as well.


\begin{document}

\maketitle

\ifhtml
\chapter*{Front Matter\label{front}}
\fi

\input{copyright}

\begin{abstract}

\noindent
Python is an extensible, interpreted, object-oriented programming
language.  It supports a wide range of applications, from simple text
processing scripts to interactive WWW browsers.

While the \emph{Python Reference Manual} describes the exact syntax and
semantics of the language, it does not describe the standard library
that is distributed with the language, and which greatly enhances its
immediate usability.  This library contains built-in modules (written
in C) that provide access to system functionality such as file I/O
that would otherwise be inaccessible to Python programmers, as well as
modules written in Python that provide standardized solutions for many
problems that occur in everyday programming.  Some of these modules
are explicitly designed to encourage and enhance the portability of
Python programs.

This library reference manual documents Python's standard library, as
well as many optional library modules (which may or may not be
available, depending on whether the underlying platform supports them
and on the configuration choices made at compile time).  It also
documents the standard types of the language and its built-in
functions and exceptions, many of which are not or incompletely
documented in the Reference Manual.

This manual assumes basic knowledge about the Python language.  For an
informal introduction to Python, see the \emph{Python Tutorial}; the
\emph{Python Reference Manual} remains the highest authority on
syntactic and semantic questions.  Finally, the manual entitled
\emph{Extending and Embedding the Python Interpreter} describes how to
add new extensions to Python and how to embed it in other applications.

\end{abstract}

\tableofcontents

				% Chapter title:

\input{libintro}		% Introduction

\input{libobjs}			% Built-in Types, Exceptions and Functions
\input{libstdtypes}
\input{libexcs}
\input{libfuncs}

\input{libpython}		% Python Services
\input{libsys}
\input{libtypes}
\input{libuserdict}
\input{liboperator}
\input{libtraceback}
\input{liblinecache}
\input{libpickle}
\input{libcopyreg}		% really copy_reg
\input{libshelve}
\input{libcopy}
\input{libmarshal}
\input{libimp}
%\input{libni}
\input{libparser}
\input{libsymbol}
\input{libtoken}
\input{libkeyword}
\input{libtokenize}
\input{libpyclbr}
\input{libcode}
\input{libcodeop}
\input{libpprint}
\input{librepr}
\input{libpycompile}		% really py_compile
\input{libcompileall}
\input{libdis}
\input{libnew}
\input{libsite}
\input{libuser}
\input{libbltin}		% really __builtin__
\input{libmain}			% really __main__

\input{libstrings}		% String Services
\input{libstring}
\input{libre}
\input{libregex}
\input{libregsub}
\input{libstruct}
\input{libfpformat}
\input{libstringio}
%\input{libsoundex}

\input{libmisc}			% Miscellaneous Services
\input{libmath}
\input{libcmath}
\input{librandom}
\input{libwhrandom}
%\input{librand}
\input{libbisect}
\input{libarray}
\input{libcfgparser}
\input{libfileinput}
\input{libcalendar}
\input{libcmd}
\input{libshlex}

\input{liballos}		% Generic Operating System Services
\input{libos}
\input{libposixpath}		% os.path
\input{libdircache}
\input{libstat}
\input{libstatcache}
\input{libstatvfs}
\input{libfilecmp}
%\input{libcmp}
%\input{libcmpcache}
\input{libtime}
\input{libsched}
\input{libgetpass}
\input{libcurses}
\input{libgetopt}
\input{libtempfile}
\input{liberrno}
\input{libglob}
\input{libfnmatch}
\input{libshutil}
\input{liblocale}
\input{libmutex}

\input{libsomeos}		% Optional Operating System Services
\input{libsignal}
\input{libsocket}
\input{libselect}
\input{libthread}
\input{libthreading}
\input{libqueue}
\input{libanydbm}
\input{libdbhash}
\input{libwhichdb}
\input{libbsddb}
\input{libzlib}
\input{libgzip}
\input{librlcompleter}

\input{libunix}			% UNIX Specific Services
\input{libposix}
\input{libpwd}
\input{libgrp}
\input{libcrypt}
\input{libdl}
\input{libdbm}
\input{libgdbm}
\input{libtermios}
\input{libtty}
\input{libpty}
\input{libfcntl}
\input{libpipes}
\input{libposixfile}
\input{libresource}
\input{libnis}
\input{libsyslog}
\input{libpopen2}
\input{libcommands}

\input{libpdb}			% The Python Debugger

\input{libprofile}		% The Python Profiler

\input{internet}		% Internet Protocols
\input{libcgi}
\input{liburllib}
\input{libhttplib}
\input{libftplib}
\input{libgopherlib}
\input{libpoplib}
\input{libimaplib}
\input{libnntplib}
\input{libsmtplib}
\input{libtelnetlib}
\input{liburlparse}
\input{libsocksvr}
\input{libbasehttp}
\input{libsimplehttp}
\input{libcgihttp}
\input{libasyncore}

\input{netdata}			% Internet Data Handling
\input{libsgmllib}
\input{libhtmllib}
\input{libxmllib}
\input{libformatter}
\input{librfc822}
\input{libmimetools}
\input{libmimewriter}
\input{libmultifile}
\input{libbinhex}
\input{libuu}
\input{libbinascii}
\input{libxdrlib}
\input{libmailcap}
\input{libmimetypes}
\input{libbase64}
\input{libquopri}
\input{libmailbox}
\input{libmhlib}
\input{libmimify}
\input{libnetrc}

\input{librestricted}
\input{librexec}
\input{libbastion}

\input{libmm}			% Multimedia Services
\input{libaudioop}
\input{libimageop}
\input{libaifc}
\input{libsunau}
\input{libwave}
\input{libchunk}
\input{libcolorsys}
\input{librgbimg}
\input{libimghdr}
\input{libsndhdr}

\input{libcrypto}		% Cryptographic Services
\input{libmd5}
\input{libsha}
\input{libmpz}
\input{librotor}

%\input{libamoeba}		% AMOEBA ONLY

%\input{libstdwin}		% STDWIN ONLY

\input{libsgi}			% SGI IRIX ONLY
\input{libal}
\input{libcd}
\input{libfl}
\input{libfm}
\input{libgl}
\input{libimgfile}
\input{libjpeg}
%\input{libpanel}

\input{libsun}			% SUNOS ONLY
\input{libsunaudio}

\input{windows}			% MS Windows ONLY
\input{libmsvcrt}
\input{libwinsound}

\input{libundoc}

%
%  The ugly "%begin{latexonly}" pseudo-environments are really just to
%  keep LaTeX2HTML quiet during the \renewcommand{} macros; they're
%  not really valuable.
%

%begin{latexonly}
\renewcommand{\indexname}{Module Index}
%end{latexonly}
\input{modlib.ind}		% Module Index

%begin{latexonly}
\renewcommand{\indexname}{Index}
%end{latexonly}
\input{lib.ind}			% Index

\end{document}