Guido van Rossum | 3795378 | 1992-04-06 14:04:04 +0000 | [diff] [blame] | 1 | \documentstyle[twoside,11pt,myformat]{report} |
Guido van Rossum | 19f1b82 | 1991-11-12 15:41:57 +0000 | [diff] [blame] | 2 | |
Guido van Rossum | 8675115 | 1995-02-28 17:14:32 +0000 | [diff] [blame] | 3 | % 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 Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 7 | \title{Python Library Reference} |
Guido van Rossum | 515834a | 1991-01-22 11:45:29 +0000 | [diff] [blame] | 8 | |
Guido van Rossum | 16cd7f9 | 1994-10-06 10:29:26 +0000 | [diff] [blame] | 9 | \input{boilerplate} |
Guido van Rossum | 83eb962 | 1993-11-23 16:28:45 +0000 | [diff] [blame] | 10 | |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 11 | \makeindex % tell \index to actually write the .idx file |
| 12 | |
Guido van Rossum | 1230c08 | 1992-01-07 16:40:44 +0000 | [diff] [blame] | 13 | |
Guido van Rossum | 515834a | 1991-01-22 11:45:29 +0000 | [diff] [blame] | 14 | \begin{document} |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 15 | |
Guido van Rossum | 515834a | 1991-01-22 11:45:29 +0000 | [diff] [blame] | 16 | \pagenumbering{roman} |
| 17 | |
| 18 | \maketitle |
| 19 | |
Guido van Rossum | 16cd7f9 | 1994-10-06 10:29:26 +0000 | [diff] [blame] | 20 | \input{copyright} |
| 21 | |
Guido van Rossum | 515834a | 1991-01-22 11:45:29 +0000 | [diff] [blame] | 22 | \begin{abstract} |
| 23 | |
| 24 | \noindent |
Guido van Rossum | 2ddd978 | 1995-03-30 16:01:33 +0000 | [diff] [blame] | 25 | Python is an extensible, interpreted, object-oriented programming |
| 26 | language. It supports a wide range of applications, from simple text |
| 27 | processing scripts to interactive WWW browsers. |
| 28 | |
| 29 | While the {\em Python Reference Manual} describes the exact syntax and |
| 30 | semantics of the language, it does not describe the standard library |
| 31 | that is distributed with the language, and which greatly enhances its |
| 32 | immediate usability. This library contains built-in modules (written |
| 33 | in C) that provide access to system functionality such as file I/O |
| 34 | that would otherwise be inaccessible to Python programmers, as well as |
| 35 | modules written in Python that provide standardized solutions for many |
| 36 | problems that occur in everyday programming. Some of these modules |
| 37 | are explicitly designed to encourage and enhance the portability of |
| 38 | Python programs. |
| 39 | |
| 40 | This library reference manual documents Python's standard library, as |
| 41 | well as many optional library modules (which may or may not be |
| 42 | available, depending on whether the underlying platform supports them |
| 43 | and on the configuration choices made at compile time). It also |
| 44 | documents the standard types of the language and its built-in |
| 45 | functions and exceptions, many of which are not or incompletely |
| 46 | documented in the Reference Manual. |
| 47 | |
| 48 | This manual assumes basic knowledge about the Python language. For an |
| 49 | informal introduction to Python, see the {\em Python Tutorial}; the |
| 50 | Python Reference Manual remains the highest authority on syntactic and |
| 51 | semantic questions. Finally, the manual entitled {\em Extending and |
| 52 | Embedding the Python Interpreter} describes how to add new extensions |
| 53 | to Python and how to embed it in other applications. |
Guido van Rossum | 515834a | 1991-01-22 11:45:29 +0000 | [diff] [blame] | 54 | |
| 55 | \end{abstract} |
| 56 | |
| 57 | \pagebreak |
| 58 | |
Guido van Rossum | 9b57385 | 1992-01-29 14:46:35 +0000 | [diff] [blame] | 59 | { |
| 60 | \parskip = 0mm |
Guido van Rossum | 515834a | 1991-01-22 11:45:29 +0000 | [diff] [blame] | 61 | \tableofcontents |
Guido van Rossum | 9b57385 | 1992-01-29 14:46:35 +0000 | [diff] [blame] | 62 | } |
Guido van Rossum | 515834a | 1991-01-22 11:45:29 +0000 | [diff] [blame] | 63 | |
| 64 | \pagebreak |
| 65 | |
| 66 | \pagenumbering{arabic} |
Guido van Rossum | be3eb96 | 1992-03-24 13:34:33 +0000 | [diff] [blame] | 67 | |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 68 | % 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 Rossum | ecde781 | 1995-03-28 13:35:14 +0000 | [diff] [blame] | 77 | \input{libpython} % Python Services |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 78 | \input{libsys} |
Guido van Rossum | ecde781 | 1995-03-28 13:35:14 +0000 | [diff] [blame] | 79 | \input{libtypes2} % types is already taken :-( |
Guido van Rossum | 7f3b042 | 1997-03-27 14:56:18 +0000 | [diff] [blame] | 80 | \input{libuser} |
Guido van Rossum | 61ed4db | 1996-12-06 21:22:41 +0000 | [diff] [blame] | 81 | \input{liboperator} |
Guido van Rossum | ecde781 | 1995-03-28 13:35:14 +0000 | [diff] [blame] | 82 | \input{libtraceback} |
Guido van Rossum | d188358 | 1995-02-15 15:53:08 +0000 | [diff] [blame] | 83 | \input{libpickle} |
| 84 | \input{libshelve} |
| 85 | \input{libcopy} |
Guido van Rossum | ecde781 | 1995-03-28 13:35:14 +0000 | [diff] [blame] | 86 | \input{libmarshal} |
| 87 | \input{libimp} |
Guido van Rossum | ca81470 | 1995-10-11 17:32:29 +0000 | [diff] [blame] | 88 | \input{libparser} |
Guido van Rossum | ecde781 | 1995-03-28 13:35:14 +0000 | [diff] [blame] | 89 | \input{libbltin} % really __builtin__ |
| 90 | \input{libmain} % really __main__ |
| 91 | |
| 92 | \input{libstrings} % String Services |
| 93 | \input{libstring} |
| 94 | \input{libregex} |
| 95 | \input{libregsub} |
| 96 | \input{libstruct} |
Guido van Rossum | cda3d7d | 1997-03-03 16:01:21 +0000 | [diff] [blame] | 97 | \input{libstrio} |
Guido van Rossum | 3486f27 | 1996-12-12 17:02:21 +0000 | [diff] [blame] | 98 | \input{libsoundex} |
Guido van Rossum | ecde781 | 1995-03-28 13:35:14 +0000 | [diff] [blame] | 99 | |
| 100 | \input{libmisc} % Miscellaneous Services |
| 101 | \input{libmath} |
| 102 | \input{librand} |
| 103 | \input{libwhrandom} |
| 104 | \input{libarray} |
| 105 | |
| 106 | \input{liballos} % Generic Operating System Services |
| 107 | \input{libos} |
| 108 | \input{libtime} |
| 109 | \input{libgetopt} |
Guido van Rossum | dc46c7f | 1995-03-01 15:38:16 +0000 | [diff] [blame] | 110 | \input{libtempfile} |
Guido van Rossum | c0fcc44 | 1996-07-30 18:20:01 +0000 | [diff] [blame] | 111 | \input{liberrno} |
Guido van Rossum | b6a8026 | 1997-03-25 22:09:18 +0000 | [diff] [blame] | 112 | \input{libglob} |
Guido van Rossum | ecde781 | 1995-03-28 13:35:14 +0000 | [diff] [blame] | 113 | |
| 114 | \input{libsomeos} % Optional Operating System Services |
| 115 | \input{libsignal} |
| 116 | \input{libsocket} |
| 117 | \input{libselect} |
| 118 | \input{libthread} |
| 119 | |
| 120 | \input{libunix} % UNIX Specific Services |
| 121 | \input{libposix} |
| 122 | \input{libppath} % == posixpath |
| 123 | \input{libpwd} |
| 124 | \input{libgrp} |
Guido van Rossum | 5c6e373 | 1996-04-10 16:18:20 +0000 | [diff] [blame] | 125 | \input{libcrypt} |
Guido van Rossum | ecde781 | 1995-03-28 13:35:14 +0000 | [diff] [blame] | 126 | \input{libdbm} |
| 127 | \input{libgdbm} |
| 128 | \input{libtermios} |
| 129 | \input{libfcntl} |
| 130 | \input{libposixfile} |
Guido van Rossum | 3c7b2dc | 1996-12-18 18:37:05 +0000 | [diff] [blame] | 131 | \input{libresource} |
Guido van Rossum | fbe34fa | 1995-10-09 20:49:57 +0000 | [diff] [blame] | 132 | \input{libsyslog} |
Guido van Rossum | 3dd68d3 | 1996-12-31 02:24:54 +0000 | [diff] [blame] | 133 | \input{libstat} |
Guido van Rossum | df804f8 | 1995-03-02 12:38:39 +0000 | [diff] [blame] | 134 | |
| 135 | \input{libpdb} % The Python Debugger |
| 136 | |
| 137 | \input{libprofile} % The Python Profiler |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 138 | |
Guido van Rossum | ecde781 | 1995-03-28 13:35:14 +0000 | [diff] [blame] | 139 | \input{libwww} % Internet and WWW Services |
Guido van Rossum | a12ef94 | 1995-02-27 17:53:25 +0000 | [diff] [blame] | 140 | \input{libcgi} |
Guido van Rossum | cca8d2b | 1995-03-22 15:48:46 +0000 | [diff] [blame] | 141 | \input{liburllib} |
| 142 | \input{libhttplib} |
Guido van Rossum | 817a842 | 1995-02-16 16:28:22 +0000 | [diff] [blame] | 143 | \input{libftplib} |
| 144 | \input{libgopherlib} |
Guido van Rossum | 817a842 | 1995-02-16 16:28:22 +0000 | [diff] [blame] | 145 | \input{libnntplib} |
Guido van Rossum | 817a842 | 1995-02-16 16:28:22 +0000 | [diff] [blame] | 146 | \input{liburlparse} |
Guido van Rossum | cca8d2b | 1995-03-22 15:48:46 +0000 | [diff] [blame] | 147 | \input{libsgmllib} |
Fred Drake | e1980ed | 1996-10-09 14:36:54 +0000 | [diff] [blame] | 148 | \input{libhtmllib} |
Fred Drake | 53e84d5 | 1996-10-08 21:54:41 +0000 | [diff] [blame] | 149 | \input{libformatter} |
Guido van Rossum | cca8d2b | 1995-03-22 15:48:46 +0000 | [diff] [blame] | 150 | \input{librfc822} |
| 151 | \input{libmimetools} |
Jack Jansen | 4549b13 | 1995-08-29 11:30:24 +0000 | [diff] [blame] | 152 | \input{libbinascii} |
Guido van Rossum | 40006cf | 1996-08-19 22:58:03 +0000 | [diff] [blame] | 153 | \input{libxdrlib} |
Guido van Rossum | b6a8026 | 1997-03-25 22:09:18 +0000 | [diff] [blame] | 154 | \input{libmailcap} |
Guido van Rossum | 817a842 | 1995-02-16 16:28:22 +0000 | [diff] [blame] | 155 | |
Guido van Rossum | 6e308d7 | 1996-10-22 01:11:53 +0000 | [diff] [blame] | 156 | \input{librestricted} |
| 157 | \input{librexec} |
| 158 | \input{libbastion} |
| 159 | |
Guido van Rossum | ecde781 | 1995-03-28 13:35:14 +0000 | [diff] [blame] | 160 | \input{libmm} % Multimedia Services |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 161 | \input{libaudioop} |
| 162 | \input{libimageop} |
Guido van Rossum | ecde781 | 1995-03-28 13:35:14 +0000 | [diff] [blame] | 163 | \input{libaifc} |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 164 | \input{libjpeg} |
| 165 | \input{librgbimg} |
Guido van Rossum | 40006cf | 1996-08-19 22:58:03 +0000 | [diff] [blame] | 166 | \input{libimghdr} |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 167 | |
Guido van Rossum | ecde781 | 1995-03-28 13:35:14 +0000 | [diff] [blame] | 168 | \input{libcrypto} % Cryptographic Services |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 169 | \input{libmd5} |
| 170 | \input{libmpz} |
| 171 | \input{librotor} |
| 172 | |
| 173 | %\input{libamoeba} % AMOEBA ONLY |
| 174 | |
Guido van Rossum | 8675115 | 1995-02-28 17:14:32 +0000 | [diff] [blame] | 175 | \input{libmac} % MACINTOSH ONLY |
Guido van Rossum | dc46c7f | 1995-03-01 15:38:16 +0000 | [diff] [blame] | 176 | \input{libctb} |
| 177 | \input{libmacconsole} |
Guido van Rossum | 85c4ff2 | 1995-03-07 10:12:11 +0000 | [diff] [blame] | 178 | \input{libmacdnr} |
Guido van Rossum | dc46c7f | 1995-03-01 15:38:16 +0000 | [diff] [blame] | 179 | \input{libmacfs} |
Jack Jansen | ebed45f | 1995-08-14 13:40:05 +0000 | [diff] [blame] | 180 | \input{libmacos} |
Jack Jansen | da53c52 | 1995-10-10 14:43:20 +0000 | [diff] [blame] | 181 | \input{libmacostools} |
Guido van Rossum | dc46c7f | 1995-03-01 15:38:16 +0000 | [diff] [blame] | 182 | \input{libmactcp} |
| 183 | \input{libmacspeech} |
Jack Jansen | da53c52 | 1995-10-10 14:43:20 +0000 | [diff] [blame] | 184 | \input{libmacui} |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 185 | |
| 186 | \input{libstdwin} % STDWIN ONLY |
| 187 | |
| 188 | \input{libsgi} % SGI IRIX ONLY |
| 189 | \input{libal} |
| 190 | %\input{libaudio} |
Sjoerd Mullender | ffd6de1 | 1995-03-28 11:56:52 +0000 | [diff] [blame] | 191 | \input{libcd} |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 192 | \input{libfl} |
| 193 | \input{libfm} |
| 194 | \input{libgl} |
| 195 | \input{libimgfile} |
| 196 | %\input{libpanel} |
| 197 | |
| 198 | \input{libsun} % SUNOS ONLY |
| 199 | |
Guido van Rossum | 612316f | 1997-03-14 04:12:52 +0000 | [diff] [blame] | 200 | \input{libundoc} |
| 201 | |
Guido van Rossum | 6938f06 | 1994-08-01 12:22:53 +0000 | [diff] [blame] | 202 | \input{lib.ind} % Index |
Guido van Rossum | 515834a | 1991-01-22 11:45:29 +0000 | [diff] [blame] | 203 | |
| 204 | \end{document} |