blob: df384af41e918fe137e5ac4ede9aa515a656c04b [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 Drake53525371998-03-03 21:56:15 +000010This function is invoked by the \keyword{import} statement. It
Guido van Rossum7974b0f1997-10-05 18:53:00 +000011mainly exists so that you can replace it with another
12function that has a compatible interface, in order to change the
Fred Drake53525371998-03-03 21:56:15 +000013semantics of the \keyword{import} statement. For examples of why and
Fred Drake0a73d4d1998-04-02 18:46:44 +000014how you would do this, see the standard library modules
Fred Drake53525371998-03-03 21:56:15 +000015\module{ihooks} and \module{rexec}. See also the built-in module
16\module{imp}, which defines some useful operations out of which you can
17build your own \function{__import__()} function.
Guido van Rossum7974b0f1997-10-05 18:53:00 +000018\stindex{import}
Fred Drakee14388c1997-12-15 22:28:38 +000019\refstmodindex{ihooks}
20\refstmodindex{rexec}
21\refbimodindex{imp}
Guido van Rossum7974b0f1997-10-05 18:53:00 +000022
Fred Drake53525371998-03-03 21:56:15 +000023For example, the statement `\code{import} \code{spam}' results in the
Fred Drake315b5d81998-02-13 21:26:35 +000024following call:
25\code{__import__('spam',} \code{globals(),} \code{locals(), [])};
26the statement \code{from} \code{spam.ham import} \code{eggs} results
27in \code{__import__('spam.ham',} \code{globals(),} \code{locals(),}
28\code{['eggs'])}.
Guido van Rossum7974b0f1997-10-05 18:53:00 +000029Note that even though \code{locals()} and \code{['eggs']} are passed
Fred Drake53525371998-03-03 21:56:15 +000030in as arguments, the \function{__import__()} function does not set the
Guido van Rossum7974b0f1997-10-05 18:53:00 +000031local variable named \code{eggs}; this is done by subsequent code that
32is generated for the import statement. (In fact, the standard
33implementation does not use its \var{locals} argument at all, and uses
34its \var{globals} only to determine the package context of the
Fred Drake53525371998-03-03 21:56:15 +000035\keyword{import} statement.)
Guido van Rossum7974b0f1997-10-05 18:53:00 +000036
37When the \var{name} variable is of the form \code{package.module},
38normally, the top-level package (the name up till the first dot) is
39returned, \emph{not} the module named by \var{name}. However, when a
40non-empty \var{fromlist} argument is given, the module named by
41\var{name} is returned. This is done for compatibility with the
42bytecode generated for the different kinds of import statement; when
Fred Drake53525371998-03-03 21:56:15 +000043using \samp{import spam.ham.eggs}, the top-level package \code{spam}
44must be placed in the importing namespace, but when using \samp{from
Guido van Rossum7974b0f1997-10-05 18:53:00 +000045spam.ham import eggs}, the \code{spam.ham} subpackage must be used to
46find the \code{eggs} variable.
Guido van Rossum8c2da611998-12-04 15:32:17 +000047As a workaround for this behavior, use \function{getattr()} to extract
48the desired components. For example, you could define the following
49helper:
50
51\begin{verbatim}
52import string
53
54def my_import(name):
55 mod = __import__(name)
56 components = string.split(name, '.')
57 for comp in components[1:]:
58 mod = getattr(mod, comp)
59 return mod
60\end{verbatim}
61
Guido van Rossum7974b0f1997-10-05 18:53:00 +000062\end{funcdesc}
63
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000064\begin{funcdesc}{abs}{x}
65 Return the absolute value of a number. The argument may be a plain
Guido van Rossum921f32c1997-06-02 17:21:20 +000066 or long integer or a floating point number. If the argument is a
Guido van Rossum7974b0f1997-10-05 18:53:00 +000067 complex number, its magnitude is returned.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000068\end{funcdesc}
69
Fred Drakecce10901998-03-17 06:33:25 +000070\begin{funcdesc}{apply}{function, args\optional{, keywords}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000071The \var{function} argument must be a callable object (a user-defined or
72built-in function or method, or a class object) and the \var{args}
Barry Warsawb2031f71998-10-01 15:35:43 +000073argument must be a sequence (if it is not a tuple, the sequence is
74first converted to a tuple). The \var{function} is called with
75\var{args} as the argument list; the number of arguments is the the length
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000076of the tuple. (This is different from just calling
77\code{\var{func}(\var{args})}, since in that case there is always
78exactly one argument.)
Guido van Rossum0568d5e1995-10-08 01:06:46 +000079If the optional \var{keywords} argument is present, it must be a
80dictionary whose keys are strings. It specifies keyword arguments to
81be added to the end of the the argument list.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000082\end{funcdesc}
83
Guido van Rossum8be22961999-03-19 19:10:14 +000084\begin{funcdesc}{buffer}{object\optional{, offset\optional{, size}}}
85The \var{object} argument must be an object that supports the
86buffer call interface (such as strings, arrays, and buffers). A new
87buffer object will be created which references the \var{object} argument.
88The buffer object will be a slice from the beginning of \var{object}
89(or from the specified \var{offset}). The slice will extend to the
90end of \var{object} (or will have a length given by the \var{size}
91argument).
92\end{funcdesc}
93
Guido van Rossum7974b0f1997-10-05 18:53:00 +000094\begin{funcdesc}{callable}{object}
95Return true if the \var{object} argument appears callable, false if
96not. If this returns true, it is still possible that a call fails,
97but if it is false, calling \var{object} will never succeed. Note
98that classes are callable (calling a class returns a new instance);
Fred Drake53525371998-03-03 21:56:15 +000099class instances are callable if they have a \method{__call__()} method.
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000100\end{funcdesc}
101
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000102\begin{funcdesc}{chr}{i}
103 Return a string of one character whose \ASCII{} code is the integer
104 \var{i}, e.g., \code{chr(97)} returns the string \code{'a'}. This is the
Fred Drake53525371998-03-03 21:56:15 +0000105 inverse of \function{ord()}. The argument must be in the range [0..255],
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000106 inclusive.
107\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})}.
181 For floating point numbers the result is the same as
182 \code{(math.floor(\var{a} / \var{b}), \var{a} \%{} \var{b})}.
183\end{funcdesc}
184
Fred Drakecce10901998-03-17 06:33:25 +0000185\begin{funcdesc}{eval}{expression\optional{, globals\optional{, locals}}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000186 The arguments are a string and two optional dictionaries. The
Guido van Rossumf8601621995-01-10 10:50:24 +0000187 \var{expression} argument is parsed and evaluated as a Python
188 expression (technically speaking, a condition list) using the
189 \var{globals} and \var{locals} dictionaries as global and local name
Guido van Rossum470be141995-03-17 16:07:09 +0000190 space. If the \var{locals} dictionary is omitted it defaults to
191 the \var{globals} dictionary. If both dictionaries are omitted, the
Fred Drake53525371998-03-03 21:56:15 +0000192 expression is executed in the environment where \keyword{eval} is
Guido van Rossumf8601621995-01-10 10:50:24 +0000193 called. The return value is the result of the evaluated expression.
194 Syntax errors are reported as exceptions. Example:
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000195
Fred Drake19479911998-02-13 06:58:54 +0000196\begin{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000197>>> x = 1
198>>> print eval('x+1')
1992
Fred Drake19479911998-02-13 06:58:54 +0000200\end{verbatim}
Fred Drake53525371998-03-03 21:56:15 +0000201
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000202 This function can also be used to execute arbitrary code objects
Fred Drake53525371998-03-03 21:56:15 +0000203 (e.g.\ created by \function{compile()}). In this case pass a code
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000204 object instead of a string. The code object must have been compiled
205 passing \code{'eval'} to the \var{kind} argument.
206
Guido van Rossum6c4f0031995-03-07 10:14:09 +0000207 Hints: dynamic execution of statements is supported by the
Fred Drake53525371998-03-03 21:56:15 +0000208 \keyword{exec} statement. Execution of statements from a file is
209 supported by the \function{execfile()} function. The
210 \function{globals()} and \function{locals()} functions returns the
211 current global and local dictionary, respectively, which may be
212 useful to pass around for use by \function{eval()} or
213 \function{execfile()}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000214\end{funcdesc}
215
Fred Drakecce10901998-03-17 06:33:25 +0000216\begin{funcdesc}{execfile}{file\optional{, globals\optional{, locals}}}
Guido van Rossum470be141995-03-17 16:07:09 +0000217 This function is similar to the
Fred Drake53525371998-03-03 21:56:15 +0000218 \keyword{exec} statement, but parses a file instead of a string. It
219 is different from the \keyword{import} statement in that it does not
220 use the module administration --- it reads the file unconditionally
221 and does not create a new module.\footnote{It is used relatively
222 rarely so does not warrant being made into a statement.}
Guido van Rossumf8601621995-01-10 10:50:24 +0000223
224 The arguments are a file name and two optional dictionaries. The
225 file is parsed and evaluated as a sequence of Python statements
226 (similarly to a module) using the \var{globals} and \var{locals}
Guido van Rossum470be141995-03-17 16:07:09 +0000227 dictionaries as global and local name space. If the \var{locals}
228 dictionary is omitted it defaults to the \var{globals} dictionary.
Guido van Rossumf8601621995-01-10 10:50:24 +0000229 If both dictionaries are omitted, the expression is executed in the
Fred Drake53525371998-03-03 21:56:15 +0000230 environment where \function{execfile()} is called. The return value is
Guido van Rossum470be141995-03-17 16:07:09 +0000231 \code{None}.
Guido van Rossumf8601621995-01-10 10:50:24 +0000232\end{funcdesc}
233
Fred Drakecce10901998-03-17 06:33:25 +0000234\begin{funcdesc}{filter}{function, list}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000235Construct a list from those elements of \var{list} for which
236\var{function} returns true. If \var{list} is a string or a tuple,
237the result also has that type; otherwise it is always a list. If
238\var{function} is \code{None}, the identity function is assumed,
Guido van Rossum6c4f0031995-03-07 10:14:09 +0000239i.e.\ all elements of \var{list} that are false (zero or empty) are
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000240removed.
241\end{funcdesc}
242
243\begin{funcdesc}{float}{x}
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000244 Convert a string or a number to floating point. If the argument is a
Fred Draked83675f1998-12-07 17:13:18 +0000245 string, it must contain a possibly signed decimal or floating point
Fred Drake70a66c91999-02-18 16:08:36 +0000246 number, possibly embedded in whitespace; this behaves identical to
247 \code{string.atof(\var{x})}. Otherwise, the argument may be a plain
248 or long integer or a floating point number, and a floating point
249 number with the same value (within Python's floating point
250 precision) is returned.
251
252 \strong{Note:} When passing in a string, values for NaN\index{NaN}
253 and Infinity\index{Infinity} may be returned, depending on the
254 underlying C library. The specific set of strings accepted which
255 cause these values to be returned depends entirely on the C library
256 and is known to vary.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000257\end{funcdesc}
258
Fred Drakecce10901998-03-17 06:33:25 +0000259\begin{funcdesc}{getattr}{object, name}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000260 The arguments are an object and a string. The string must be the
Fred Drake53525371998-03-03 21:56:15 +0000261 name of one of the object's attributes. The result is the value of
262 that attribute. For example, \code{getattr(\var{x},
263 '\var{foobar}')} is equivalent to \code{\var{x}.\var{foobar}}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000264\end{funcdesc}
265
Guido van Rossumfb502e91995-07-07 22:58:28 +0000266\begin{funcdesc}{globals}{}
267Return a dictionary representing the current global symbol table.
268This is always the dictionary of the current module (inside a
269function or method, this is the module where it is defined, not the
270module from which it is called).
271\end{funcdesc}
272
Fred Drakecce10901998-03-17 06:33:25 +0000273\begin{funcdesc}{hasattr}{object, name}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000274 The arguments are an object and a string. The result is 1 if the
275 string is the name of one of the object's attributes, 0 if not.
Fred Drake53525371998-03-03 21:56:15 +0000276 (This is implemented by calling \code{getattr(\var{object},
277 \var{name})} and seeing whether it raises an exception or not.)
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000278\end{funcdesc}
279
280\begin{funcdesc}{hash}{object}
281 Return the hash value of the object (if it has one). Hash values
Guido van Rossumeb0f0661997-12-30 20:38:16 +0000282 are integers. They are used to quickly compare dictionary
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000283 keys during a dictionary lookup. Numeric values that compare equal
284 have the same hash value (even if they are of different types, e.g.
285 1 and 1.0).
286\end{funcdesc}
287
288\begin{funcdesc}{hex}{x}
Guido van Rossum470be141995-03-17 16:07:09 +0000289 Convert an integer number (of any size) to a hexadecimal string.
Guido van Rossum5cd75201997-01-14 18:44:23 +0000290 The result is a valid Python expression. Note: this always yields
291 an unsigned literal, e.g. on a 32-bit machine, \code{hex(-1)} yields
292 \code{'0xffffffff'}. When evaluated on a machine with the same
293 word size, this literal is evaluated as -1; at a different word
294 size, it may turn up as a large positive number or raise an
Fred Drake53525371998-03-03 21:56:15 +0000295 \exception{OverflowError} exception.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000296\end{funcdesc}
297
298\begin{funcdesc}{id}{object}
299 Return the `identity' of an object. This is an integer which is
300 guaranteed to be unique and constant for this object during its
301 lifetime. (Two objects whose lifetimes are disjunct may have the
Fred Drake53525371998-03-03 21:56:15 +0000302 same \function{id()} value.) (Implementation note: this is the
303 address of the object.)
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000304\end{funcdesc}
305
Guido van Rossum16d6e711994-08-08 12:30:22 +0000306\begin{funcdesc}{input}{\optional{prompt}}
Guido van Rossum777dcc61998-06-17 15:16:40 +0000307 Equivalent to \code{eval(raw_input(\var{prompt}))}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000308\end{funcdesc}
309
Guido van Rossum3978d751997-03-03 16:03:27 +0000310\begin{funcdesc}{intern}{string}
311 Enter \var{string} in the table of ``interned'' strings and return
312 the interned string -- which is \var{string} itself or a copy.
313 Interning strings is useful to gain a little performance on
314 dictionary lookup -- if the keys in a dictionary are interned, and
315 the lookup key is interned, the key comparisons (after hashing) can
316 be done by a pointer compare instead of a string compare. Normally,
317 the names used in Python programs are automatically interned, and
318 the dictionaries used to hold module, class or instance attributes
319 have interned keys. Interned strings are immortal (i.e. never get
320 garbage collected).
321\end{funcdesc}
322
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000323\begin{funcdesc}{int}{x}
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000324 Convert a string or number to a plain integer. If the argument is a
Fred Draked83675f1998-12-07 17:13:18 +0000325 string, it must contain a possibly signed decimal number
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000326 representable as a Python integer, possibly embedded in whitespace;
327 this behaves identical to \code{string.atoi(\var{x})}.
328 Otherwise, the argument may be a plain or
Guido van Rossum470be141995-03-17 16:07:09 +0000329 long integer or a floating point number. Conversion of floating
330 point numbers to integers is defined by the C semantics; normally
Guido van Rossumecde7811995-03-28 13:35:14 +0000331 the conversion truncates towards zero.\footnote{This is ugly --- the
332 language definition should require truncation towards zero.}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000333\end{funcdesc}
334
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000335\begin{funcdesc}{isinstance}{object, class}
336Return true if the \var{object} argument is an instance of the
337\var{class} argument, or of a (direct or indirect) subclass thereof.
Guido van Rossum3593e5c1997-12-02 19:15:01 +0000338Also return true if \var{class} is a type object and \var{object} is
339an object of that type. If \var{object} is not a class instance or a
340object of the given type, the function always returns false. If
341\var{class} is neither a class object nor a type object, a
Fred Drake53525371998-03-03 21:56:15 +0000342\exception{TypeError} exception is raised.
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000343\end{funcdesc}
344
345\begin{funcdesc}{issubclass}{class1, class2}
346Return true if \var{class1} is a subclass (direct or indirect) of
347\var{class2}. A class is considered a subclass of itself. If either
Fred Drake53525371998-03-03 21:56:15 +0000348argument is not a class object, a \exception{TypeError} exception is
349raised.
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000350\end{funcdesc}
351
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000352\begin{funcdesc}{len}{s}
353 Return the length (the number of items) of an object. The argument
354 may be a sequence (string, tuple or list) or a mapping (dictionary).
355\end{funcdesc}
356
Guido van Rossum921f32c1997-06-02 17:21:20 +0000357\begin{funcdesc}{list}{sequence}
358Return a list whose items are the same and in the same order as
359\var{sequence}'s items. If \var{sequence} is already a list,
360a copy is made and returned, similar to \code{\var{sequence}[:]}.
361For instance, \code{list('abc')} returns
362returns \code{['a', 'b', 'c']} and \code{list( (1, 2, 3) )} returns
363\code{[1, 2, 3]}.
364\end{funcdesc}
365
Guido van Rossumfb502e91995-07-07 22:58:28 +0000366\begin{funcdesc}{locals}{}
367Return a dictionary representing the current local symbol table.
Guido van Rossum7b7f6681998-06-18 16:45:34 +0000368\strong{Warning:} the contents of this dictionary should not be
369modified; changes may not affect the values of local variables used by
370the interpreter.
Guido van Rossumfb502e91995-07-07 22:58:28 +0000371\end{funcdesc}
372
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000373\begin{funcdesc}{long}{x}
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000374 Convert a string or number to a long integer. If the argument is a
Fred Draked83675f1998-12-07 17:13:18 +0000375 string, it must contain a possibly signed decimal number of
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000376 arbitrary size, possibly embedded in whitespace;
377 this behaves identical to \code{string.atol(\var{x})}.
378 Otherwise, the argument may be a plain or
Guido van Rossumeb0f0661997-12-30 20:38:16 +0000379 long integer or a floating point number, and a long integer with
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000380 the same value is returned. Conversion of floating
381 point numbers to integers is defined by the C semantics;
Fred Drake53525371998-03-03 21:56:15 +0000382 see the description of \function{int()}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000383\end{funcdesc}
384
Fred Drakecce10901998-03-17 06:33:25 +0000385\begin{funcdesc}{map}{function, list, ...}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000386Apply \var{function} to every item of \var{list} and return a list
387of the results. If additional \var{list} arguments are passed,
388\var{function} must take that many arguments and is applied to
389the items of all lists in parallel; if a list is shorter than another
390it is assumed to be extended with \code{None} items. If
391\var{function} is \code{None}, the identity function is assumed; if
Fred Drake53525371998-03-03 21:56:15 +0000392there are multiple list arguments, \function{map()} returns a list
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000393consisting of tuples containing the corresponding items from all lists
394(i.e. a kind of transpose operation). The \var{list} arguments may be
395any kind of sequence; the result is always a list.
396\end{funcdesc}
397
Guido van Rossum5eabf381998-11-25 18:53:05 +0000398\begin{funcdesc}{max}{s\optional{, args...}}
399With a single argument \var{s}, return the largest item of a
400non-empty sequence (e.g., a string, tuple or list). With more than
401one argument, return the largest of the arguments.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000402\end{funcdesc}
403
Guido van Rossum5eabf381998-11-25 18:53:05 +0000404\begin{funcdesc}{min}{s\optional{, args...}}
405With a single argument \var{s}, return the smallest item of a
406non-empty sequence (e.g., a string, tuple or list). With more than
407one argument, return the smallest of the arguments.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000408\end{funcdesc}
409
410\begin{funcdesc}{oct}{x}
Guido van Rossum470be141995-03-17 16:07:09 +0000411 Convert an integer number (of any size) to an octal string. The
Guido van Rossum5cd75201997-01-14 18:44:23 +0000412 result is a valid Python expression. Note: this always yields
413 an unsigned literal, e.g. on a 32-bit machine, \code{oct(-1)} yields
414 \code{'037777777777'}. When evaluated on a machine with the same
415 word size, this literal is evaluated as -1; at a different word
416 size, it may turn up as a large positive number or raise an
Fred Drake53525371998-03-03 21:56:15 +0000417 \exception{OverflowError} exception.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000418\end{funcdesc}
419
Fred Drakecce10901998-03-17 06:33:25 +0000420\begin{funcdesc}{open}{filename\optional{, mode\optional{, bufsize}}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000421 Return a new file object (described earlier under Built-in Types).
Guido van Rossum041be051994-05-03 14:46:50 +0000422 The first two arguments are the same as for \code{stdio}'s
Fred Drake53525371998-03-03 21:56:15 +0000423 \cfunction{fopen()}: \var{filename} is the file name to be opened,
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000424 \var{mode} indicates how the file is to be opened: \code{'r'} for
425 reading, \code{'w'} for writing (truncating an existing file), and
Fred Drakeaf8a0151998-01-14 14:51:31 +0000426 \code{'a'} opens it for appending (which on \emph{some} \UNIX{}
427 systems means that \emph{all} writes append to the end of the file,
Guido van Rossum59b328e1996-05-02 15:16:59 +0000428 regardless of the current seek position).
Guido van Rossum5fdd1191998-07-29 21:05:35 +0000429
430 Modes \code{'r+'}, \code{'w+'} and \code{'a+'} open the file for
431 updating (note that \code{'w+'} truncates the file). Append
432 \code{'b'} to the mode to open the file in binary mode, on systems
433 that differentiate between binary and text files (else it is
434 ignored). If the file cannot be opened, \exception{IOError} is
435 raised.
436
Fred Drake9aa85431999-04-05 21:22:41 +0000437 If \var{mode} is omitted, it defaults to \code{'r'}. When opening a
438 binary file, you should append \code{'b'} to the \var{mode} value
439 for improved portability. (It's useful even on systems which don't
440 treat binary and text files differently, where it serves as
441 documentation.) The optional \var{bufsize} argument specifies the
442 file's desired buffer size: 0 means unbuffered, 1 means line
443 buffered, any other positive value means use a buffer of
444 (approximately) that size. A negative \var{bufsize} means to use
445 the system default, which is usually line buffered for for tty
446 devices and fully buffered for other files. If omitted, the system
447 default is used.\footnote{
448 Specifying a buffer size currently has no effect on systems that
449 don't have \cfunction{setvbuf()}. The interface to specify the
450 buffer size is not done using a method that calls
451 \cfunction{setvbuf()}, because that may dump core when called
452 after any I/O has been performed, and there's no reliable way to
453 determine whether this is the case.}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000454\end{funcdesc}
455
456\begin{funcdesc}{ord}{c}
457 Return the \ASCII{} value of a string of one character. E.g.,
458 \code{ord('a')} returns the integer \code{97}. This is the inverse of
Fred Drake53525371998-03-03 21:56:15 +0000459 \function{chr()}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000460\end{funcdesc}
461
Fred Drakecce10901998-03-17 06:33:25 +0000462\begin{funcdesc}{pow}{x, y\optional{, z}}
Guido van Rossumb8b264b1994-08-12 13:13:50 +0000463 Return \var{x} to the power \var{y}; if \var{z} is present, return
464 \var{x} to the power \var{y}, modulo \var{z} (computed more
Fred Drake6251c161998-04-03 07:15:54 +0000465 efficiently than \code{pow(\var{x}, \var{y}) \%\ \var{z}}).
Guido van Rossumb8b264b1994-08-12 13:13:50 +0000466 The arguments must have
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000467 numeric types. With mixed operand types, the rules for binary
468 arithmetic operators apply. The effective operand type is also the
469 type of the result; if the result is not expressible in this type, the
Guido van Rossum16d6e711994-08-08 12:30:22 +0000470 function raises an exception; e.g., \code{pow(2, -1)} or \code{pow(2,
471 35000)} is not allowed.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000472\end{funcdesc}
473
Fred Drakecce10901998-03-17 06:33:25 +0000474\begin{funcdesc}{range}{\optional{start,} stop\optional{, step}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000475 This is a versatile function to create lists containing arithmetic
Fred Drake53525371998-03-03 21:56:15 +0000476 progressions. It is most often used in \keyword{for} loops. The
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000477 arguments must be plain integers. If the \var{step} argument is
478 omitted, it defaults to \code{1}. If the \var{start} argument is
479 omitted, it defaults to \code{0}. The full form returns a list of
480 plain integers \code{[\var{start}, \var{start} + \var{step},
481 \var{start} + 2 * \var{step}, \ldots]}. If \var{step} is positive,
482 the last element is the largest \code{\var{start} + \var{i} *
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000483 \var{step}} less than \var{stop}; if \var{step} is negative, the last
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000484 element is the largest \code{\var{start} + \var{i} * \var{step}}
Fred Drake6251c161998-04-03 07:15:54 +0000485 greater than \var{stop}. \var{step} must not be zero (or else
486 \exception{ValueError} is raised). Example:
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000487
Fred Drake19479911998-02-13 06:58:54 +0000488\begin{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000489>>> range(10)
490[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
491>>> range(1, 11)
492[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
493>>> range(0, 30, 5)
494[0, 5, 10, 15, 20, 25]
495>>> range(0, 10, 3)
496[0, 3, 6, 9]
497>>> range(0, -10, -1)
498[0, -1, -2, -3, -4, -5, -6, -7, -8, -9]
499>>> range(0)
500[]
501>>> range(1, 0)
502[]
503>>>
Fred Drake19479911998-02-13 06:58:54 +0000504\end{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000505\end{funcdesc}
506
Guido van Rossum16d6e711994-08-08 12:30:22 +0000507\begin{funcdesc}{raw_input}{\optional{prompt}}
508 If the \var{prompt} argument is present, it is written to standard output
509 without a trailing newline. The function then reads a line from input,
510 converts it to a string (stripping a trailing newline), and returns that.
Fred Drake53525371998-03-03 21:56:15 +0000511 When \EOF{} is read, \exception{EOFError} is raised. Example:
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000512
Fred Drake19479911998-02-13 06:58:54 +0000513\begin{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000514>>> s = raw_input('--> ')
515--> Monty Python's Flying Circus
516>>> s
Guido van Rossum470be141995-03-17 16:07:09 +0000517"Monty Python's Flying Circus"
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000518>>>
Fred Drake19479911998-02-13 06:58:54 +0000519\end{verbatim}
Guido van Rossum921f32c1997-06-02 17:21:20 +0000520
Fred Drake53525371998-03-03 21:56:15 +0000521If the \module{readline} module was loaded, then
522\function{raw_input()} will use it to provide elaborate
Guido van Rossum921f32c1997-06-02 17:21:20 +0000523line editing and history features.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000524\end{funcdesc}
525
Guido van Rossum87e611e1999-01-06 23:10:51 +0000526\begin{funcdesc}{reduce}{function, sequence\optional{, initializer}}
527Apply \var{function} of two arguments cumulatively to the items of
528\var{sequence}, from left to right, so as to reduce the sequence to
529a single value. For example,
530\code{reduce(lambda x, y: x+y, [1, 2, 3, 4, 5])} calculates
531\code{((((1+2)+3)+4)+5)}.
532If the optional \var{initializer} is present, it is placed before the
533items of the sequence in the calculation, and serves as a default when
534the sequence is empty.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000535\end{funcdesc}
536
537\begin{funcdesc}{reload}{module}
Guido van Rossum470be141995-03-17 16:07:09 +0000538Re-parse and re-initialize an already imported \var{module}. The
539argument must be a module object, so it must have been successfully
540imported before. This is useful if you have edited the module source
541file using an external editor and want to try out the new version
542without leaving the Python interpreter. The return value is the
543module object (i.e.\ the same as the \var{module} argument).
544
545There are a number of caveats:
546
547If a module is syntactically correct but its initialization fails, the
Fred Drake53525371998-03-03 21:56:15 +0000548first \keyword{import} statement for it does not bind its name locally,
Guido van Rossum470be141995-03-17 16:07:09 +0000549but does store a (partially initialized) module object in
550\code{sys.modules}. To reload the module you must first
Fred Drake53525371998-03-03 21:56:15 +0000551\keyword{import} it again (this will bind the name to the partially
552initialized module object) before you can \function{reload()} it.
Guido van Rossum470be141995-03-17 16:07:09 +0000553
554When a module is reloaded, its dictionary (containing the module's
555global variables) is retained. Redefinitions of names will override
556the old definitions, so this is generally not a problem. If the new
557version of a module does not define a name that was defined by the old
558version, the old definition remains. This feature can be used to the
559module's advantage if it maintains a global table or cache of objects
Fred Drake53525371998-03-03 21:56:15 +0000560--- with a \keyword{try} statement it can test for the table's presence
Guido van Rossum470be141995-03-17 16:07:09 +0000561and skip its initialization if desired.
562
563It is legal though generally not very useful to reload built-in or
Fred Drake53525371998-03-03 21:56:15 +0000564dynamically loaded modules, except for \module{sys}, \module{__main__}
565and \module{__builtin__}. In certain cases, however, extension
566modules are not designed to be initialized more than once, and may
567fail in arbitrary ways when reloaded.
Guido van Rossum470be141995-03-17 16:07:09 +0000568
Fred Drake53525371998-03-03 21:56:15 +0000569If a module imports objects from another module using \keyword{from}
570\ldots{} \keyword{import} \ldots{}, calling \function{reload()} for
571the other module does not redefine the objects imported from it ---
572one way around this is to re-execute the \keyword{from} statement,
573another is to use \keyword{import} and qualified names
574(\var{module}.\var{name}) instead.
Guido van Rossum470be141995-03-17 16:07:09 +0000575
576If a module instantiates instances of a class, reloading the module
577that defines the class does not affect the method definitions of the
578instances --- they continue to use the old class definition. The same
579is true for derived classes.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000580\end{funcdesc}
581
582\begin{funcdesc}{repr}{object}
583Return a string containing a printable representation of an object.
584This is the same value yielded by conversions (reverse quotes).
585It is sometimes useful to be able to access this operation as an
586ordinary function. For many types, this function makes an attempt
587to return a string that would yield an object with the same value
Fred Drake53525371998-03-03 21:56:15 +0000588when passed to \function{eval()}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000589\end{funcdesc}
590
Fred Drake607f8021998-08-24 20:30:07 +0000591\begin{funcdesc}{round}{x\optional{, n}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000592 Return the floating point value \var{x} rounded to \var{n} digits
593 after the decimal point. If \var{n} is omitted, it defaults to zero.
594 The result is a floating point number. Values are rounded to the
595 closest multiple of 10 to the power minus \var{n}; if two multiples
596 are equally close, rounding is done away from 0 (so e.g.
597 \code{round(0.5)} is \code{1.0} and \code{round(-0.5)} is \code{-1.0}).
598\end{funcdesc}
599
Fred Drakecce10901998-03-17 06:33:25 +0000600\begin{funcdesc}{setattr}{object, name, value}
Fred Drake53525371998-03-03 21:56:15 +0000601 This is the counterpart of \function{getattr()}. The arguments are an
Fred Drake607f8021998-08-24 20:30:07 +0000602 object, a string and an arbitrary value. The string may name an
603 existing attribute or a new attribute. The function assigns the
604 value to the attribute, provided the object allows it. For example,
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000605 \code{setattr(\var{x}, '\var{foobar}', 123)} is equivalent to
606 \code{\var{x}.\var{foobar} = 123}.
607\end{funcdesc}
608
Fred Drakecce10901998-03-17 06:33:25 +0000609\begin{funcdesc}{slice}{\optional{start,} stop\optional{, step}}
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000610Return a slice object representing the set of indices specified by
611\code{range(\var{start}, \var{stop}, \var{step})}. The \var{start}
612and \var{step} arguments default to None. Slice objects have
Fred Drake53525371998-03-03 21:56:15 +0000613read-only data attributes \member{start}, \member{stop} and \member{step}
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000614which merely return the argument values (or their default). They have
615no other explicit functionality; however they are used by Numerical
Fred Drake6251c161998-04-03 07:15:54 +0000616Python\index{Numerical Python} and other third party extensions.
617Slice objects are also generated when extended indexing syntax is
618used, e.g. for \samp{a[start:stop:step]} or \samp{a[start:stop, i]}.
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000619\end{funcdesc}
620
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000621\begin{funcdesc}{str}{object}
622Return a string containing a nicely printable representation of an
623object. For strings, this returns the string itself. The difference
Guido van Rossum6c4f0031995-03-07 10:14:09 +0000624with \code{repr(\var{object})} is that \code{str(\var{object})} does not
Fred Drake53525371998-03-03 21:56:15 +0000625always attempt to return a string that is acceptable to \function{eval()};
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000626its goal is to return a printable string.
627\end{funcdesc}
628
Guido van Rossum470be141995-03-17 16:07:09 +0000629\begin{funcdesc}{tuple}{sequence}
Guido van Rossumb8b264b1994-08-12 13:13:50 +0000630Return a tuple whose items are the same and in the same order as
Guido van Rossum921f32c1997-06-02 17:21:20 +0000631\var{sequence}'s items. If \var{sequence} is already a tuple, it
Guido van Rossumb8b264b1994-08-12 13:13:50 +0000632is returned unchanged. For instance, \code{tuple('abc')} returns
633returns \code{('a', 'b', 'c')} and \code{tuple([1, 2, 3])} returns
634\code{(1, 2, 3)}.
635\end{funcdesc}
636
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000637\begin{funcdesc}{type}{object}
Guido van Rossum470be141995-03-17 16:07:09 +0000638Return the type of an \var{object}. The return value is a type
Fred Drake53525371998-03-03 21:56:15 +0000639object. The standard module \module{types} defines names for all
Guido van Rossum470be141995-03-17 16:07:09 +0000640built-in types.
Fred Drakee14388c1997-12-15 22:28:38 +0000641\refstmodindex{types}
Guido van Rossum470be141995-03-17 16:07:09 +0000642\obindex{type}
643For instance:
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000644
Fred Drake19479911998-02-13 06:58:54 +0000645\begin{verbatim}
Guido van Rossum470be141995-03-17 16:07:09 +0000646>>> import types
Guido van Rossuma7874d11998-06-22 14:07:36 +0000647>>> if type(x) == types.StringType: print "It's a string"
Fred Drake19479911998-02-13 06:58:54 +0000648\end{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000649\end{funcdesc}
Guido van Rossum68cfbe71994-02-24 11:28:27 +0000650
Guido van Rossum6bb1adc1995-03-13 10:03:32 +0000651\begin{funcdesc}{vars}{\optional{object}}
Guido van Rossum17383111994-04-21 10:32:28 +0000652Without arguments, return a dictionary corresponding to the current
653local symbol table. With a module, class or class instance object as
Fred Drake53525371998-03-03 21:56:15 +0000654argument (or anything else that has a \member{__dict__} attribute),
Guido van Rossum17383111994-04-21 10:32:28 +0000655returns a dictionary corresponding to the object's symbol table.
656The returned dictionary should not be modified: the effects on the
Fred Drake9aa85431999-04-05 21:22:41 +0000657corresponding symbol table are undefined.\footnote{
658 In the current implementation, local variable bindings cannot
659 normally be affected this way, but variables retrieved from
660 other scopes (e.g. modules) can be. This may change.}
Guido van Rossum17383111994-04-21 10:32:28 +0000661\end{funcdesc}
662
Fred Drakecce10901998-03-17 06:33:25 +0000663\begin{funcdesc}{xrange}{\optional{start,} stop\optional{, step}}
Fred Drake53525371998-03-03 21:56:15 +0000664This function is very similar to \function{range()}, but returns an
Guido van Rossum68cfbe71994-02-24 11:28:27 +0000665``xrange object'' instead of a list. This is an opaque sequence type
666which yields the same values as the corresponding list, without
667actually storing them all simultaneously. The advantage of
Fred Drake53525371998-03-03 21:56:15 +0000668\function{xrange()} over \function{range()} is minimal (since
669\function{xrange()} still has to create the values when asked for
670them) except when a very large range is used on a memory-starved
671machine (e.g. MS-DOS) or when all of the range's elements are never
672used (e.g. when the loop is usually terminated with \keyword{break}).
Guido van Rossum68cfbe71994-02-24 11:28:27 +0000673\end{funcdesc}