blob: 91afe4fba0b02ad2737ed92345d54fc6b94b6fa6 [file] [log] [blame]
Fred Drake295da241998-08-10 19:42:37 +00001\section{Built-in Functions \label{built-in-funcs}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +00002
3The Python interpreter has a number of functions built into it that
4are always available. They are listed here in alphabetical order.
5
6
Fred Drake19479911998-02-13 06:58:54 +00007\setindexsubitem{(built-in function)}
Guido van Rossum7974b0f1997-10-05 18:53:00 +00008
9\begin{funcdesc}{__import__}{name\optional{, globals\optional{, locals\optional{, fromlist}}}}
Fred Drake697c7791999-06-10 22:09:20 +000010This function is invoked by the
11\keyword{import}\stindex{import} statement. It mainly
12exists so that you can replace it with another function that has a
13compatible interface, in order to change the semantics of the
14\keyword{import} statement. For examples of why and how you would do
15this, see the standard library modules
16\module{ihooks}\refstmodindex{ihooks} and
17\refmodule{rexec}\refstmodindex{rexec}. See also the built-in module
18\refmodule{imp}\refbimodindex{imp}, which defines some useful
19operations out of which you can build your own
20\function{__import__()} function.
Guido van Rossum7974b0f1997-10-05 18:53:00 +000021
Fred Drake53525371998-03-03 21:56:15 +000022For example, the statement `\code{import} \code{spam}' results in the
Fred Drake315b5d81998-02-13 21:26:35 +000023following call:
24\code{__import__('spam',} \code{globals(),} \code{locals(), [])};
25the statement \code{from} \code{spam.ham import} \code{eggs} results
26in \code{__import__('spam.ham',} \code{globals(),} \code{locals(),}
27\code{['eggs'])}.
Guido van Rossum7974b0f1997-10-05 18:53:00 +000028Note that even though \code{locals()} and \code{['eggs']} are passed
Fred Drake53525371998-03-03 21:56:15 +000029in as arguments, the \function{__import__()} function does not set the
Guido van Rossum7974b0f1997-10-05 18:53:00 +000030local variable named \code{eggs}; this is done by subsequent code that
31is generated for the import statement. (In fact, the standard
32implementation does not use its \var{locals} argument at all, and uses
33its \var{globals} only to determine the package context of the
Fred Drake53525371998-03-03 21:56:15 +000034\keyword{import} statement.)
Guido van Rossum7974b0f1997-10-05 18:53:00 +000035
36When the \var{name} variable is of the form \code{package.module},
37normally, the top-level package (the name up till the first dot) is
38returned, \emph{not} the module named by \var{name}. However, when a
39non-empty \var{fromlist} argument is given, the module named by
40\var{name} is returned. This is done for compatibility with the
41bytecode generated for the different kinds of import statement; when
Fred Drake53525371998-03-03 21:56:15 +000042using \samp{import spam.ham.eggs}, the top-level package \code{spam}
43must be placed in the importing namespace, but when using \samp{from
Guido van Rossum7974b0f1997-10-05 18:53:00 +000044spam.ham import eggs}, the \code{spam.ham} subpackage must be used to
45find the \code{eggs} variable.
Guido van Rossum8c2da611998-12-04 15:32:17 +000046As a workaround for this behavior, use \function{getattr()} to extract
47the desired components. For example, you could define the following
48helper:
49
50\begin{verbatim}
51import string
52
53def my_import(name):
54 mod = __import__(name)
55 components = string.split(name, '.')
56 for comp in components[1:]:
57 mod = getattr(mod, comp)
58 return mod
59\end{verbatim}
60
Guido van Rossum7974b0f1997-10-05 18:53:00 +000061\end{funcdesc}
62
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000063\begin{funcdesc}{abs}{x}
64 Return the absolute value of a number. The argument may be a plain
Guido van Rossum921f32c1997-06-02 17:21:20 +000065 or long integer or a floating point number. If the argument is a
Guido van Rossum7974b0f1997-10-05 18:53:00 +000066 complex number, its magnitude is returned.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000067\end{funcdesc}
68
Fred Drakecce10901998-03-17 06:33:25 +000069\begin{funcdesc}{apply}{function, args\optional{, keywords}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000070The \var{function} argument must be a callable object (a user-defined or
71built-in function or method, or a class object) and the \var{args}
Barry Warsawb2031f71998-10-01 15:35:43 +000072argument must be a sequence (if it is not a tuple, the sequence is
73first converted to a tuple). The \var{function} is called with
74\var{args} as the argument list; the number of arguments is the the length
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000075of the tuple. (This is different from just calling
76\code{\var{func}(\var{args})}, since in that case there is always
77exactly one argument.)
Guido van Rossum0568d5e1995-10-08 01:06:46 +000078If the optional \var{keywords} argument is present, it must be a
79dictionary whose keys are strings. It specifies keyword arguments to
80be added to the end of the the argument list.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000081\end{funcdesc}
82
Guido van Rossum8be22961999-03-19 19:10:14 +000083\begin{funcdesc}{buffer}{object\optional{, offset\optional{, size}}}
84The \var{object} argument must be an object that supports the
85buffer call interface (such as strings, arrays, and buffers). A new
86buffer object will be created which references the \var{object} argument.
87The buffer object will be a slice from the beginning of \var{object}
88(or from the specified \var{offset}). The slice will extend to the
89end of \var{object} (or will have a length given by the \var{size}
90argument).
91\end{funcdesc}
92
Guido van Rossum7974b0f1997-10-05 18:53:00 +000093\begin{funcdesc}{callable}{object}
94Return true if the \var{object} argument appears callable, false if
95not. If this returns true, it is still possible that a call fails,
96but if it is false, calling \var{object} will never succeed. Note
97that classes are callable (calling a class returns a new instance);
Fred Drake53525371998-03-03 21:56:15 +000098class instances are callable if they have a \method{__call__()} method.
Guido van Rossum7974b0f1997-10-05 18:53:00 +000099\end{funcdesc}
100
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000101\begin{funcdesc}{chr}{i}
102 Return a string of one character whose \ASCII{} code is the integer
103 \var{i}, e.g., \code{chr(97)} returns the string \code{'a'}. This is the
Fred Drake53525371998-03-03 21:56:15 +0000104 inverse of \function{ord()}. The argument must be in the range [0..255],
Fred Drake665dd702000-04-06 14:45:19 +0000105 inclusive; \exception{ValueError} will be raised if \var{i} is
106 outside that range.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000107\end{funcdesc}
108
Fred Drakecce10901998-03-17 06:33:25 +0000109\begin{funcdesc}{cmp}{x, y}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000110 Compare the two objects \var{x} and \var{y} and return an integer
111 according to the outcome. The return value is negative if \code{\var{x}
112 < \var{y}}, zero if \code{\var{x} == \var{y}} and strictly positive if
113 \code{\var{x} > \var{y}}.
114\end{funcdesc}
115
Fred Drakecce10901998-03-17 06:33:25 +0000116\begin{funcdesc}{coerce}{x, y}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000117 Return a tuple consisting of the two numeric arguments converted to
118 a common type, using the same rules as used by arithmetic
119 operations.
120\end{funcdesc}
121
Fred Drakecce10901998-03-17 06:33:25 +0000122\begin{funcdesc}{compile}{string, filename, kind}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000123 Compile the \var{string} into a code object. Code objects can be
Fred Drake53525371998-03-03 21:56:15 +0000124 executed by an \keyword{exec} statement or evaluated by a call to
125 \function{eval()}. The \var{filename} argument should
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000126 give the file from which the code was read; pass e.g. \code{'<string>'}
127 if it wasn't read from a file. The \var{kind} argument specifies
128 what kind of code must be compiled; it can be \code{'exec'} if
Guido van Rossumfb502e91995-07-07 22:58:28 +0000129 \var{string} consists of a sequence of statements, \code{'eval'}
130 if it consists of a single expression, or \code{'single'} if
131 it consists of a single interactive statement (in the latter case,
132 expression statements that evaluate to something else than
133 \code{None} will printed).
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000134\end{funcdesc}
135
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000136\begin{funcdesc}{complex}{real\optional{, imag}}
Guido van Rossumcb1f2421999-03-25 21:23:26 +0000137 Create a complex number with the value \var{real} + \var{imag}*j or
138 convert a string or number to a complex number.
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000139 Each argument may be any numeric type (including complex).
140 If \var{imag} is omitted, it defaults to zero and the function
Fred Drake53525371998-03-03 21:56:15 +0000141 serves as a numeric conversion function like \function{int()},
Guido van Rossumcb1f2421999-03-25 21:23:26 +0000142 \function{long()} and \function{float()}; in this case it also
143 accepts a string argument which should be a valid complex number.
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000144\end{funcdesc}
145
Fred Drakecce10901998-03-17 06:33:25 +0000146\begin{funcdesc}{delattr}{object, name}
Fred Drake53525371998-03-03 21:56:15 +0000147 This is a relative of \function{setattr()}. The arguments are an
Guido van Rossum1efbb0f1994-08-16 22:15:11 +0000148 object and a string. The string must be the name
149 of one of the object's attributes. The function deletes
150 the named attribute, provided the object allows it. For example,
Guido van Rossum6c4f0031995-03-07 10:14:09 +0000151 \code{delattr(\var{x}, '\var{foobar}')} is equivalent to
Guido van Rossum1efbb0f1994-08-16 22:15:11 +0000152 \code{del \var{x}.\var{foobar}}.
153\end{funcdesc}
154
Fred Drake6b303b41998-04-16 22:10:27 +0000155\begin{funcdesc}{dir}{\optional{object}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000156 Without arguments, return the list of names in the current local
Guido van Rossumeb0f0661997-12-30 20:38:16 +0000157 symbol table. With an argument, attempts to return a list of valid
158 attribute for that object. This information is gleaned from the
Fred Drake53525371998-03-03 21:56:15 +0000159 object's \member{__dict__}, \member{__methods__} and \member{__members__}
Guido van Rossumeb0f0661997-12-30 20:38:16 +0000160 attributes, if defined. The list is not necessarily complete; e.g.,
161 for classes, attributes defined in base classes are not included,
162 and for class instances, methods are not included.
163 The resulting list is sorted alphabetically. For example:
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000164
Fred Drake19479911998-02-13 06:58:54 +0000165\begin{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000166>>> import sys
167>>> dir()
168['sys']
169>>> dir(sys)
170['argv', 'exit', 'modules', 'path', 'stderr', 'stdin', 'stdout']
171>>>
Fred Drake19479911998-02-13 06:58:54 +0000172\end{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000173\end{funcdesc}
174
Fred Drakecce10901998-03-17 06:33:25 +0000175\begin{funcdesc}{divmod}{a, b}
Guido van Rossumeb0f0661997-12-30 20:38:16 +0000176 Take two numbers as arguments and return a pair of numbers consisting
177 of their quotient and remainder when using long division. With mixed
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000178 operand types, the rules for binary arithmetic operators apply. For
179 plain and long integers, the result is the same as
180 \code{(\var{a} / \var{b}, \var{a} \%{} \var{b})}.
Fred Drake1ea7c751999-05-06 14:46:35 +0000181 For floating point numbers the result is \code{(\var{q}, \var{a} \%{}
182 \var{b})}, where \var{q} is usually \code{math.floor(\var{a} /
183 \var{b})} but may be 1 less than that. In any case \code{\var{q} *
184 \var{b} + \var{a} \%{} \var{b}} is very close to \var{a}, if
185 \code{\var{a} \%{} \var{b}} is non-zero it has the same sign as
186 \var{b}, and \code{0 <= abs(\var{a} \%{} \var{b}) < abs(\var{b})}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000187\end{funcdesc}
188
Fred Drakecce10901998-03-17 06:33:25 +0000189\begin{funcdesc}{eval}{expression\optional{, globals\optional{, locals}}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000190 The arguments are a string and two optional dictionaries. The
Guido van Rossumf8601621995-01-10 10:50:24 +0000191 \var{expression} argument is parsed and evaluated as a Python
192 expression (technically speaking, a condition list) using the
193 \var{globals} and \var{locals} dictionaries as global and local name
Guido van Rossum470be141995-03-17 16:07:09 +0000194 space. If the \var{locals} dictionary is omitted it defaults to
195 the \var{globals} dictionary. If both dictionaries are omitted, the
Fred Drake53525371998-03-03 21:56:15 +0000196 expression is executed in the environment where \keyword{eval} is
Guido van Rossumf8601621995-01-10 10:50:24 +0000197 called. The return value is the result of the evaluated expression.
198 Syntax errors are reported as exceptions. Example:
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000199
Fred Drake19479911998-02-13 06:58:54 +0000200\begin{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000201>>> x = 1
202>>> print eval('x+1')
2032
Fred Drake19479911998-02-13 06:58:54 +0000204\end{verbatim}
Fred Drake53525371998-03-03 21:56:15 +0000205
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000206 This function can also be used to execute arbitrary code objects
Fred Drake53525371998-03-03 21:56:15 +0000207 (e.g.\ created by \function{compile()}). In this case pass a code
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000208 object instead of a string. The code object must have been compiled
209 passing \code{'eval'} to the \var{kind} argument.
210
Guido van Rossum6c4f0031995-03-07 10:14:09 +0000211 Hints: dynamic execution of statements is supported by the
Fred Drake53525371998-03-03 21:56:15 +0000212 \keyword{exec} statement. Execution of statements from a file is
213 supported by the \function{execfile()} function. The
214 \function{globals()} and \function{locals()} functions returns the
215 current global and local dictionary, respectively, which may be
216 useful to pass around for use by \function{eval()} or
217 \function{execfile()}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000218\end{funcdesc}
219
Fred Drakecce10901998-03-17 06:33:25 +0000220\begin{funcdesc}{execfile}{file\optional{, globals\optional{, locals}}}
Guido van Rossum470be141995-03-17 16:07:09 +0000221 This function is similar to the
Fred Drake53525371998-03-03 21:56:15 +0000222 \keyword{exec} statement, but parses a file instead of a string. It
223 is different from the \keyword{import} statement in that it does not
224 use the module administration --- it reads the file unconditionally
225 and does not create a new module.\footnote{It is used relatively
226 rarely so does not warrant being made into a statement.}
Guido van Rossumf8601621995-01-10 10:50:24 +0000227
228 The arguments are a file name and two optional dictionaries. The
229 file is parsed and evaluated as a sequence of Python statements
230 (similarly to a module) using the \var{globals} and \var{locals}
Guido van Rossum470be141995-03-17 16:07:09 +0000231 dictionaries as global and local name space. If the \var{locals}
232 dictionary is omitted it defaults to the \var{globals} dictionary.
Guido van Rossumf8601621995-01-10 10:50:24 +0000233 If both dictionaries are omitted, the expression is executed in the
Fred Drake53525371998-03-03 21:56:15 +0000234 environment where \function{execfile()} is called. The return value is
Guido van Rossum470be141995-03-17 16:07:09 +0000235 \code{None}.
Guido van Rossumf8601621995-01-10 10:50:24 +0000236\end{funcdesc}
237
Fred Drakecce10901998-03-17 06:33:25 +0000238\begin{funcdesc}{filter}{function, list}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000239Construct a list from those elements of \var{list} for which
240\var{function} returns true. If \var{list} is a string or a tuple,
241the result also has that type; otherwise it is always a list. If
242\var{function} is \code{None}, the identity function is assumed,
Guido van Rossum6c4f0031995-03-07 10:14:09 +0000243i.e.\ all elements of \var{list} that are false (zero or empty) are
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000244removed.
245\end{funcdesc}
246
247\begin{funcdesc}{float}{x}
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000248 Convert a string or a number to floating point. If the argument is a
Fred Draked83675f1998-12-07 17:13:18 +0000249 string, it must contain a possibly signed decimal or floating point
Fred Drake70a66c91999-02-18 16:08:36 +0000250 number, possibly embedded in whitespace; this behaves identical to
251 \code{string.atof(\var{x})}. Otherwise, the argument may be a plain
252 or long integer or a floating point number, and a floating point
253 number with the same value (within Python's floating point
254 precision) is returned.
255
256 \strong{Note:} When passing in a string, values for NaN\index{NaN}
257 and Infinity\index{Infinity} may be returned, depending on the
258 underlying C library. The specific set of strings accepted which
259 cause these values to be returned depends entirely on the C library
260 and is known to vary.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000261\end{funcdesc}
262
Fred Drakede5d5ce1999-07-22 19:21:45 +0000263\begin{funcdesc}{getattr}{object, name\optional{, default}}
264 Return the value of the named attributed of \var{object}. \var{name}
265 must be a string. If the string is the name of one of the object's
266 attributes, the result is the value of that attribute. For example,
267 \code{getattr(x, 'foobar')} is equivalent to \code{x.foobar}. If the
268 named attribute does not exist, \var{default} is returned if provided,
269 otherwise \exception{AttributeError} is raised.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000270\end{funcdesc}
271
Guido van Rossumfb502e91995-07-07 22:58:28 +0000272\begin{funcdesc}{globals}{}
273Return a dictionary representing the current global symbol table.
274This is always the dictionary of the current module (inside a
275function or method, this is the module where it is defined, not the
276module from which it is called).
277\end{funcdesc}
278
Fred Drakecce10901998-03-17 06:33:25 +0000279\begin{funcdesc}{hasattr}{object, name}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000280 The arguments are an object and a string. The result is 1 if the
281 string is the name of one of the object's attributes, 0 if not.
Fred Drake53525371998-03-03 21:56:15 +0000282 (This is implemented by calling \code{getattr(\var{object},
283 \var{name})} and seeing whether it raises an exception or not.)
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000284\end{funcdesc}
285
286\begin{funcdesc}{hash}{object}
287 Return the hash value of the object (if it has one). Hash values
Guido van Rossumeb0f0661997-12-30 20:38:16 +0000288 are integers. They are used to quickly compare dictionary
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000289 keys during a dictionary lookup. Numeric values that compare equal
290 have the same hash value (even if they are of different types, e.g.
291 1 and 1.0).
292\end{funcdesc}
293
294\begin{funcdesc}{hex}{x}
Guido van Rossum470be141995-03-17 16:07:09 +0000295 Convert an integer number (of any size) to a hexadecimal string.
Guido van Rossum5cd75201997-01-14 18:44:23 +0000296 The result is a valid Python expression. Note: this always yields
297 an unsigned literal, e.g. on a 32-bit machine, \code{hex(-1)} yields
298 \code{'0xffffffff'}. When evaluated on a machine with the same
299 word size, this literal is evaluated as -1; at a different word
300 size, it may turn up as a large positive number or raise an
Fred Drake53525371998-03-03 21:56:15 +0000301 \exception{OverflowError} exception.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000302\end{funcdesc}
303
304\begin{funcdesc}{id}{object}
Fred Drake8aa3bd92000-06-29 03:46:46 +0000305 Return the `identity' of an object. This is an integer (or long
306 integer) which is guaranteed to be unique and constant for this
307 object during its lifetime. Two objects whose lifetimes are
308 disjunct may have the same \function{id()} value. (Implementation
309 note: this is the address of the object.)
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000310\end{funcdesc}
311
Guido van Rossum16d6e711994-08-08 12:30:22 +0000312\begin{funcdesc}{input}{\optional{prompt}}
Guido van Rossum777dcc61998-06-17 15:16:40 +0000313 Equivalent to \code{eval(raw_input(\var{prompt}))}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000314\end{funcdesc}
315
Fred Drake1e862e82000-02-17 17:45:52 +0000316\begin{funcdesc}{int}{x\optional{, radix}}
317 Convert a string or number to a plain integer. If the argument is a
318 string, it must contain a possibly signed decimal number
319 representable as a Python integer, possibly embedded in whitespace;
320 this behaves identical to \code{string.atoi(\var{x}\optional{,
321 \var{radix}})}. The \var{radix} parameter gives the base for the
322 conversion and may be any integer in the range $[2, 36]$. If
323 \var{radix} is specified and \var{x} is not a string,
324 \exception{TypeError} is raised.
325 Otherwise, the argument may be a plain or
326 long integer or a floating point number. Conversion of floating
327 point numbers to integers is defined by the C semantics; normally
328 the conversion truncates towards zero.\footnote{This is ugly --- the
329 language definition should require truncation towards zero.}
330\end{funcdesc}
331
Guido van Rossum3978d751997-03-03 16:03:27 +0000332\begin{funcdesc}{intern}{string}
333 Enter \var{string} in the table of ``interned'' strings and return
334 the interned string -- which is \var{string} itself or a copy.
335 Interning strings is useful to gain a little performance on
336 dictionary lookup -- if the keys in a dictionary are interned, and
337 the lookup key is interned, the key comparisons (after hashing) can
338 be done by a pointer compare instead of a string compare. Normally,
339 the names used in Python programs are automatically interned, and
340 the dictionaries used to hold module, class or instance attributes
341 have interned keys. Interned strings are immortal (i.e. never get
342 garbage collected).
343\end{funcdesc}
344
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000345\begin{funcdesc}{isinstance}{object, class}
346Return true if the \var{object} argument is an instance of the
347\var{class} argument, or of a (direct or indirect) subclass thereof.
Guido van Rossum3593e5c1997-12-02 19:15:01 +0000348Also return true if \var{class} is a type object and \var{object} is
349an object of that type. If \var{object} is not a class instance or a
350object of the given type, the function always returns false. If
351\var{class} is neither a class object nor a type object, a
Fred Drake53525371998-03-03 21:56:15 +0000352\exception{TypeError} exception is raised.
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000353\end{funcdesc}
354
355\begin{funcdesc}{issubclass}{class1, class2}
356Return true if \var{class1} is a subclass (direct or indirect) of
357\var{class2}. A class is considered a subclass of itself. If either
Fred Drake53525371998-03-03 21:56:15 +0000358argument is not a class object, a \exception{TypeError} exception is
359raised.
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000360\end{funcdesc}
361
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000362\begin{funcdesc}{len}{s}
363 Return the length (the number of items) of an object. The argument
364 may be a sequence (string, tuple or list) or a mapping (dictionary).
365\end{funcdesc}
366
Guido van Rossum921f32c1997-06-02 17:21:20 +0000367\begin{funcdesc}{list}{sequence}
368Return a list whose items are the same and in the same order as
369\var{sequence}'s items. If \var{sequence} is already a list,
370a copy is made and returned, similar to \code{\var{sequence}[:]}.
371For instance, \code{list('abc')} returns
372returns \code{['a', 'b', 'c']} and \code{list( (1, 2, 3) )} returns
373\code{[1, 2, 3]}.
374\end{funcdesc}
375
Guido van Rossumfb502e91995-07-07 22:58:28 +0000376\begin{funcdesc}{locals}{}
377Return a dictionary representing the current local symbol table.
Guido van Rossum7b7f6681998-06-18 16:45:34 +0000378\strong{Warning:} the contents of this dictionary should not be
379modified; changes may not affect the values of local variables used by
380the interpreter.
Guido van Rossumfb502e91995-07-07 22:58:28 +0000381\end{funcdesc}
382
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000383\begin{funcdesc}{long}{x}
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000384 Convert a string or number to a long integer. If the argument is a
Fred Draked83675f1998-12-07 17:13:18 +0000385 string, it must contain a possibly signed decimal number of
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000386 arbitrary size, possibly embedded in whitespace;
387 this behaves identical to \code{string.atol(\var{x})}.
388 Otherwise, the argument may be a plain or
Guido van Rossumeb0f0661997-12-30 20:38:16 +0000389 long integer or a floating point number, and a long integer with
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000390 the same value is returned. Conversion of floating
391 point numbers to integers is defined by the C semantics;
Fred Drake53525371998-03-03 21:56:15 +0000392 see the description of \function{int()}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000393\end{funcdesc}
394
Fred Drakecce10901998-03-17 06:33:25 +0000395\begin{funcdesc}{map}{function, list, ...}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000396Apply \var{function} to every item of \var{list} and return a list
397of the results. If additional \var{list} arguments are passed,
398\var{function} must take that many arguments and is applied to
399the items of all lists in parallel; if a list is shorter than another
400it is assumed to be extended with \code{None} items. If
401\var{function} is \code{None}, the identity function is assumed; if
Fred Drake53525371998-03-03 21:56:15 +0000402there are multiple list arguments, \function{map()} returns a list
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000403consisting of tuples containing the corresponding items from all lists
404(i.e. a kind of transpose operation). The \var{list} arguments may be
405any kind of sequence; the result is always a list.
406\end{funcdesc}
407
Guido van Rossum5eabf381998-11-25 18:53:05 +0000408\begin{funcdesc}{max}{s\optional{, args...}}
409With a single argument \var{s}, return the largest item of a
410non-empty sequence (e.g., a string, tuple or list). With more than
411one argument, return the largest of the arguments.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000412\end{funcdesc}
413
Guido van Rossum5eabf381998-11-25 18:53:05 +0000414\begin{funcdesc}{min}{s\optional{, args...}}
415With a single argument \var{s}, return the smallest item of a
416non-empty sequence (e.g., a string, tuple or list). With more than
417one argument, return the smallest of the arguments.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000418\end{funcdesc}
419
420\begin{funcdesc}{oct}{x}
Guido van Rossum470be141995-03-17 16:07:09 +0000421 Convert an integer number (of any size) to an octal string. The
Guido van Rossum5cd75201997-01-14 18:44:23 +0000422 result is a valid Python expression. Note: this always yields
423 an unsigned literal, e.g. on a 32-bit machine, \code{oct(-1)} yields
424 \code{'037777777777'}. When evaluated on a machine with the same
425 word size, this literal is evaluated as -1; at a different word
426 size, it may turn up as a large positive number or raise an
Fred Drake53525371998-03-03 21:56:15 +0000427 \exception{OverflowError} exception.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000428\end{funcdesc}
429
Fred Drakecce10901998-03-17 06:33:25 +0000430\begin{funcdesc}{open}{filename\optional{, mode\optional{, bufsize}}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000431 Return a new file object (described earlier under Built-in Types).
Guido van Rossum041be051994-05-03 14:46:50 +0000432 The first two arguments are the same as for \code{stdio}'s
Fred Drake53525371998-03-03 21:56:15 +0000433 \cfunction{fopen()}: \var{filename} is the file name to be opened,
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000434 \var{mode} indicates how the file is to be opened: \code{'r'} for
435 reading, \code{'w'} for writing (truncating an existing file), and
Fred Drakeaf8a0151998-01-14 14:51:31 +0000436 \code{'a'} opens it for appending (which on \emph{some} \UNIX{}
437 systems means that \emph{all} writes append to the end of the file,
Guido van Rossum59b328e1996-05-02 15:16:59 +0000438 regardless of the current seek position).
Guido van Rossum5fdd1191998-07-29 21:05:35 +0000439
440 Modes \code{'r+'}, \code{'w+'} and \code{'a+'} open the file for
441 updating (note that \code{'w+'} truncates the file). Append
442 \code{'b'} to the mode to open the file in binary mode, on systems
443 that differentiate between binary and text files (else it is
444 ignored). If the file cannot be opened, \exception{IOError} is
445 raised.
446
Fred Drake9aa85431999-04-05 21:22:41 +0000447 If \var{mode} is omitted, it defaults to \code{'r'}. When opening a
448 binary file, you should append \code{'b'} to the \var{mode} value
449 for improved portability. (It's useful even on systems which don't
450 treat binary and text files differently, where it serves as
Fred Draked3fbdfd1999-08-05 13:43:08 +0000451 documentation.)
452 \index{line-buffered I/O}\index{unbuffered I/O}\index{buffer size, I/O}
453 \index{I/O control!buffering}
454 The optional \var{bufsize} argument specifies the
Fred Drake9aa85431999-04-05 21:22:41 +0000455 file's desired buffer size: 0 means unbuffered, 1 means line
456 buffered, any other positive value means use a buffer of
457 (approximately) that size. A negative \var{bufsize} means to use
458 the system default, which is usually line buffered for for tty
459 devices and fully buffered for other files. If omitted, the system
460 default is used.\footnote{
461 Specifying a buffer size currently has no effect on systems that
462 don't have \cfunction{setvbuf()}. The interface to specify the
463 buffer size is not done using a method that calls
464 \cfunction{setvbuf()}, because that may dump core when called
465 after any I/O has been performed, and there's no reliable way to
466 determine whether this is the case.}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000467\end{funcdesc}
468
469\begin{funcdesc}{ord}{c}
Fred Drake33d51842000-04-06 14:43:12 +0000470 Return the \ASCII{} value of a string of one character or a Unicode
471 character. E.g., \code{ord('a')} returns the integer \code{97},
472 \code{ord(u'\\u2020')} returns \code{8224}. This is the inverse of
473 \function{chr()} for strings and of \function{unichr()} for Unicode
474 characters.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000475\end{funcdesc}
476
Fred Drakecce10901998-03-17 06:33:25 +0000477\begin{funcdesc}{pow}{x, y\optional{, z}}
Guido van Rossumb8b264b1994-08-12 13:13:50 +0000478 Return \var{x} to the power \var{y}; if \var{z} is present, return
479 \var{x} to the power \var{y}, modulo \var{z} (computed more
Fred Drake6251c161998-04-03 07:15:54 +0000480 efficiently than \code{pow(\var{x}, \var{y}) \%\ \var{z}}).
Guido van Rossumb8b264b1994-08-12 13:13:50 +0000481 The arguments must have
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000482 numeric types. With mixed operand types, the rules for binary
483 arithmetic operators apply. The effective operand type is also the
484 type of the result; if the result is not expressible in this type, the
Guido van Rossum16d6e711994-08-08 12:30:22 +0000485 function raises an exception; e.g., \code{pow(2, -1)} or \code{pow(2,
486 35000)} is not allowed.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000487\end{funcdesc}
488
Fred Drakecce10901998-03-17 06:33:25 +0000489\begin{funcdesc}{range}{\optional{start,} stop\optional{, step}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000490 This is a versatile function to create lists containing arithmetic
Fred Drake53525371998-03-03 21:56:15 +0000491 progressions. It is most often used in \keyword{for} loops. The
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000492 arguments must be plain integers. If the \var{step} argument is
493 omitted, it defaults to \code{1}. If the \var{start} argument is
494 omitted, it defaults to \code{0}. The full form returns a list of
495 plain integers \code{[\var{start}, \var{start} + \var{step},
496 \var{start} + 2 * \var{step}, \ldots]}. If \var{step} is positive,
497 the last element is the largest \code{\var{start} + \var{i} *
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000498 \var{step}} less than \var{stop}; if \var{step} is negative, the last
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000499 element is the largest \code{\var{start} + \var{i} * \var{step}}
Fred Drake6251c161998-04-03 07:15:54 +0000500 greater than \var{stop}. \var{step} must not be zero (or else
501 \exception{ValueError} is raised). Example:
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000502
Fred Drake19479911998-02-13 06:58:54 +0000503\begin{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000504>>> range(10)
505[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
506>>> range(1, 11)
507[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
508>>> range(0, 30, 5)
509[0, 5, 10, 15, 20, 25]
510>>> range(0, 10, 3)
511[0, 3, 6, 9]
512>>> range(0, -10, -1)
513[0, -1, -2, -3, -4, -5, -6, -7, -8, -9]
514>>> range(0)
515[]
516>>> range(1, 0)
517[]
518>>>
Fred Drake19479911998-02-13 06:58:54 +0000519\end{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000520\end{funcdesc}
521
Guido van Rossum16d6e711994-08-08 12:30:22 +0000522\begin{funcdesc}{raw_input}{\optional{prompt}}
523 If the \var{prompt} argument is present, it is written to standard output
524 without a trailing newline. The function then reads a line from input,
525 converts it to a string (stripping a trailing newline), and returns that.
Fred Drake53525371998-03-03 21:56:15 +0000526 When \EOF{} is read, \exception{EOFError} is raised. Example:
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000527
Fred Drake19479911998-02-13 06:58:54 +0000528\begin{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000529>>> s = raw_input('--> ')
530--> Monty Python's Flying Circus
531>>> s
Guido van Rossum470be141995-03-17 16:07:09 +0000532"Monty Python's Flying Circus"
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000533>>>
Fred Drake19479911998-02-13 06:58:54 +0000534\end{verbatim}
Guido van Rossum921f32c1997-06-02 17:21:20 +0000535
Fred Drake53525371998-03-03 21:56:15 +0000536If the \module{readline} module was loaded, then
537\function{raw_input()} will use it to provide elaborate
Guido van Rossum921f32c1997-06-02 17:21:20 +0000538line editing and history features.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000539\end{funcdesc}
540
Guido van Rossum87e611e1999-01-06 23:10:51 +0000541\begin{funcdesc}{reduce}{function, sequence\optional{, initializer}}
542Apply \var{function} of two arguments cumulatively to the items of
543\var{sequence}, from left to right, so as to reduce the sequence to
544a single value. For example,
545\code{reduce(lambda x, y: x+y, [1, 2, 3, 4, 5])} calculates
546\code{((((1+2)+3)+4)+5)}.
547If the optional \var{initializer} is present, it is placed before the
548items of the sequence in the calculation, and serves as a default when
549the sequence is empty.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000550\end{funcdesc}
551
552\begin{funcdesc}{reload}{module}
Guido van Rossum470be141995-03-17 16:07:09 +0000553Re-parse and re-initialize an already imported \var{module}. The
554argument must be a module object, so it must have been successfully
555imported before. This is useful if you have edited the module source
556file using an external editor and want to try out the new version
557without leaving the Python interpreter. The return value is the
558module object (i.e.\ the same as the \var{module} argument).
559
560There are a number of caveats:
561
562If a module is syntactically correct but its initialization fails, the
Fred Drake53525371998-03-03 21:56:15 +0000563first \keyword{import} statement for it does not bind its name locally,
Guido van Rossum470be141995-03-17 16:07:09 +0000564but does store a (partially initialized) module object in
565\code{sys.modules}. To reload the module you must first
Fred Drake53525371998-03-03 21:56:15 +0000566\keyword{import} it again (this will bind the name to the partially
567initialized module object) before you can \function{reload()} it.
Guido van Rossum470be141995-03-17 16:07:09 +0000568
569When a module is reloaded, its dictionary (containing the module's
570global variables) is retained. Redefinitions of names will override
571the old definitions, so this is generally not a problem. If the new
572version of a module does not define a name that was defined by the old
573version, the old definition remains. This feature can be used to the
574module's advantage if it maintains a global table or cache of objects
Fred Drake53525371998-03-03 21:56:15 +0000575--- with a \keyword{try} statement it can test for the table's presence
Guido van Rossum470be141995-03-17 16:07:09 +0000576and skip its initialization if desired.
577
578It is legal though generally not very useful to reload built-in or
Fred Drake53525371998-03-03 21:56:15 +0000579dynamically loaded modules, except for \module{sys}, \module{__main__}
580and \module{__builtin__}. In certain cases, however, extension
581modules are not designed to be initialized more than once, and may
582fail in arbitrary ways when reloaded.
Guido van Rossum470be141995-03-17 16:07:09 +0000583
Fred Drake53525371998-03-03 21:56:15 +0000584If a module imports objects from another module using \keyword{from}
585\ldots{} \keyword{import} \ldots{}, calling \function{reload()} for
586the other module does not redefine the objects imported from it ---
587one way around this is to re-execute the \keyword{from} statement,
588another is to use \keyword{import} and qualified names
589(\var{module}.\var{name}) instead.
Guido van Rossum470be141995-03-17 16:07:09 +0000590
591If a module instantiates instances of a class, reloading the module
592that defines the class does not affect the method definitions of the
593instances --- they continue to use the old class definition. The same
594is true for derived classes.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000595\end{funcdesc}
596
597\begin{funcdesc}{repr}{object}
598Return a string containing a printable representation of an object.
599This is the same value yielded by conversions (reverse quotes).
600It is sometimes useful to be able to access this operation as an
601ordinary function. For many types, this function makes an attempt
602to return a string that would yield an object with the same value
Fred Drake53525371998-03-03 21:56:15 +0000603when passed to \function{eval()}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000604\end{funcdesc}
605
Fred Drake607f8021998-08-24 20:30:07 +0000606\begin{funcdesc}{round}{x\optional{, n}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000607 Return the floating point value \var{x} rounded to \var{n} digits
608 after the decimal point. If \var{n} is omitted, it defaults to zero.
609 The result is a floating point number. Values are rounded to the
610 closest multiple of 10 to the power minus \var{n}; if two multiples
611 are equally close, rounding is done away from 0 (so e.g.
612 \code{round(0.5)} is \code{1.0} and \code{round(-0.5)} is \code{-1.0}).
613\end{funcdesc}
614
Fred Drakecce10901998-03-17 06:33:25 +0000615\begin{funcdesc}{setattr}{object, name, value}
Fred Drake53525371998-03-03 21:56:15 +0000616 This is the counterpart of \function{getattr()}. The arguments are an
Fred Drake607f8021998-08-24 20:30:07 +0000617 object, a string and an arbitrary value. The string may name an
618 existing attribute or a new attribute. The function assigns the
619 value to the attribute, provided the object allows it. For example,
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000620 \code{setattr(\var{x}, '\var{foobar}', 123)} is equivalent to
621 \code{\var{x}.\var{foobar} = 123}.
622\end{funcdesc}
623
Fred Drakecce10901998-03-17 06:33:25 +0000624\begin{funcdesc}{slice}{\optional{start,} stop\optional{, step}}
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000625Return a slice object representing the set of indices specified by
626\code{range(\var{start}, \var{stop}, \var{step})}. The \var{start}
627and \var{step} arguments default to None. Slice objects have
Fred Drake53525371998-03-03 21:56:15 +0000628read-only data attributes \member{start}, \member{stop} and \member{step}
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000629which merely return the argument values (or their default). They have
630no other explicit functionality; however they are used by Numerical
Fred Drake6251c161998-04-03 07:15:54 +0000631Python\index{Numerical Python} and other third party extensions.
632Slice objects are also generated when extended indexing syntax is
633used, e.g. for \samp{a[start:stop:step]} or \samp{a[start:stop, i]}.
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000634\end{funcdesc}
635
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000636\begin{funcdesc}{str}{object}
637Return a string containing a nicely printable representation of an
638object. For strings, this returns the string itself. The difference
Guido van Rossum6c4f0031995-03-07 10:14:09 +0000639with \code{repr(\var{object})} is that \code{str(\var{object})} does not
Fred Drake53525371998-03-03 21:56:15 +0000640always attempt to return a string that is acceptable to \function{eval()};
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000641its goal is to return a printable string.
642\end{funcdesc}
643
Guido van Rossum470be141995-03-17 16:07:09 +0000644\begin{funcdesc}{tuple}{sequence}
Guido van Rossumb8b264b1994-08-12 13:13:50 +0000645Return a tuple whose items are the same and in the same order as
Guido van Rossum921f32c1997-06-02 17:21:20 +0000646\var{sequence}'s items. If \var{sequence} is already a tuple, it
Guido van Rossumb8b264b1994-08-12 13:13:50 +0000647is returned unchanged. For instance, \code{tuple('abc')} returns
648returns \code{('a', 'b', 'c')} and \code{tuple([1, 2, 3])} returns
649\code{(1, 2, 3)}.
650\end{funcdesc}
651
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000652\begin{funcdesc}{type}{object}
Guido van Rossum470be141995-03-17 16:07:09 +0000653Return the type of an \var{object}. The return value is a type
Fred Drake53525371998-03-03 21:56:15 +0000654object. The standard module \module{types} defines names for all
Guido van Rossum470be141995-03-17 16:07:09 +0000655built-in types.
Fred Drakee14388c1997-12-15 22:28:38 +0000656\refstmodindex{types}
Guido van Rossum470be141995-03-17 16:07:09 +0000657\obindex{type}
658For instance:
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000659
Fred Drake19479911998-02-13 06:58:54 +0000660\begin{verbatim}
Guido van Rossum470be141995-03-17 16:07:09 +0000661>>> import types
Guido van Rossuma7874d11998-06-22 14:07:36 +0000662>>> if type(x) == types.StringType: print "It's a string"
Fred Drake19479911998-02-13 06:58:54 +0000663\end{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000664\end{funcdesc}
Guido van Rossum68cfbe71994-02-24 11:28:27 +0000665
Fred Drake33d51842000-04-06 14:43:12 +0000666\begin{funcdesc}{unichr}{i}
667Return the Unicode string of one character whose Unicode code is the
668integer \var{i}, e.g., \code{unichr(97)} returns the string
669\code{u'a'}. This is the inverse of \function{ord()} for Unicode
670strings. The argument must be in the range [0..65535], inclusive.
671\exception{ValueError} is raised otherwise.
Fred Drake30f76ff2000-06-30 16:06:19 +0000672\versionadded{2.0}
Fred Drake33d51842000-04-06 14:43:12 +0000673\end{funcdesc}
674
675\begin{funcdesc}{unicode}{string\optional{, encoding='utf-8'\optional{, errors='strict'}}}
676Decodes \var{string} using the codec for \var{encoding}. Error
677handling is done according to \var{errors}. The default behavior is
678to decode UTF-8 in strict mode, meaning that encoding errors raise
679\exception{ValueError}.
Fred Drake30f76ff2000-06-30 16:06:19 +0000680\versionadded{2.0}
Fred Drake33d51842000-04-06 14:43:12 +0000681\end{funcdesc}
682
Guido van Rossum6bb1adc1995-03-13 10:03:32 +0000683\begin{funcdesc}{vars}{\optional{object}}
Guido van Rossum17383111994-04-21 10:32:28 +0000684Without arguments, return a dictionary corresponding to the current
685local symbol table. With a module, class or class instance object as
Fred Drake53525371998-03-03 21:56:15 +0000686argument (or anything else that has a \member{__dict__} attribute),
Guido van Rossum17383111994-04-21 10:32:28 +0000687returns a dictionary corresponding to the object's symbol table.
688The returned dictionary should not be modified: the effects on the
Fred Drake9aa85431999-04-05 21:22:41 +0000689corresponding symbol table are undefined.\footnote{
690 In the current implementation, local variable bindings cannot
691 normally be affected this way, but variables retrieved from
692 other scopes (e.g. modules) can be. This may change.}
Guido van Rossum17383111994-04-21 10:32:28 +0000693\end{funcdesc}
694
Fred Drakecce10901998-03-17 06:33:25 +0000695\begin{funcdesc}{xrange}{\optional{start,} stop\optional{, step}}
Fred Drake53525371998-03-03 21:56:15 +0000696This function is very similar to \function{range()}, but returns an
Guido van Rossum68cfbe71994-02-24 11:28:27 +0000697``xrange object'' instead of a list. This is an opaque sequence type
698which yields the same values as the corresponding list, without
699actually storing them all simultaneously. The advantage of
Fred Drake53525371998-03-03 21:56:15 +0000700\function{xrange()} over \function{range()} is minimal (since
701\function{xrange()} still has to create the values when asked for
702them) except when a very large range is used on a memory-starved
703machine (e.g. MS-DOS) or when all of the range's elements are never
704used (e.g. when the loop is usually terminated with \keyword{break}).
Guido van Rossum68cfbe71994-02-24 11:28:27 +0000705\end{funcdesc}