blob: 67571cfeeb368d84a0a9fc31d3aa08cea8bffb12 [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']
Fred Drake19479911998-02-13 06:58:54 +0000171\end{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000172\end{funcdesc}
173
Fred Drakecce10901998-03-17 06:33:25 +0000174\begin{funcdesc}{divmod}{a, b}
Guido van Rossumeb0f0661997-12-30 20:38:16 +0000175 Take two numbers as arguments and return a pair of numbers consisting
176 of their quotient and remainder when using long division. With mixed
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000177 operand types, the rules for binary arithmetic operators apply. For
178 plain and long integers, the result is the same as
179 \code{(\var{a} / \var{b}, \var{a} \%{} \var{b})}.
Fred Drake1ea7c751999-05-06 14:46:35 +0000180 For floating point numbers the result is \code{(\var{q}, \var{a} \%{}
181 \var{b})}, where \var{q} is usually \code{math.floor(\var{a} /
182 \var{b})} but may be 1 less than that. In any case \code{\var{q} *
183 \var{b} + \var{a} \%{} \var{b}} is very close to \var{a}, if
184 \code{\var{a} \%{} \var{b}} is non-zero it has the same sign as
185 \var{b}, and \code{0 <= abs(\var{a} \%{} \var{b}) < abs(\var{b})}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000186\end{funcdesc}
187
Fred Drakecce10901998-03-17 06:33:25 +0000188\begin{funcdesc}{eval}{expression\optional{, globals\optional{, locals}}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000189 The arguments are a string and two optional dictionaries. The
Guido van Rossumf8601621995-01-10 10:50:24 +0000190 \var{expression} argument is parsed and evaluated as a Python
191 expression (technically speaking, a condition list) using the
192 \var{globals} and \var{locals} dictionaries as global and local name
Guido van Rossum470be141995-03-17 16:07:09 +0000193 space. If the \var{locals} dictionary is omitted it defaults to
194 the \var{globals} dictionary. If both dictionaries are omitted, the
Fred Drake53525371998-03-03 21:56:15 +0000195 expression is executed in the environment where \keyword{eval} is
Guido van Rossumf8601621995-01-10 10:50:24 +0000196 called. The return value is the result of the evaluated expression.
197 Syntax errors are reported as exceptions. Example:
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000198
Fred Drake19479911998-02-13 06:58:54 +0000199\begin{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000200>>> x = 1
201>>> print eval('x+1')
2022
Fred Drake19479911998-02-13 06:58:54 +0000203\end{verbatim}
Fred Drake53525371998-03-03 21:56:15 +0000204
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000205 This function can also be used to execute arbitrary code objects
Fred Drake53525371998-03-03 21:56:15 +0000206 (e.g.\ created by \function{compile()}). In this case pass a code
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000207 object instead of a string. The code object must have been compiled
208 passing \code{'eval'} to the \var{kind} argument.
209
Guido van Rossum6c4f0031995-03-07 10:14:09 +0000210 Hints: dynamic execution of statements is supported by the
Fred Drake53525371998-03-03 21:56:15 +0000211 \keyword{exec} statement. Execution of statements from a file is
212 supported by the \function{execfile()} function. The
213 \function{globals()} and \function{locals()} functions returns the
214 current global and local dictionary, respectively, which may be
215 useful to pass around for use by \function{eval()} or
216 \function{execfile()}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000217\end{funcdesc}
218
Fred Drakecce10901998-03-17 06:33:25 +0000219\begin{funcdesc}{execfile}{file\optional{, globals\optional{, locals}}}
Guido van Rossum470be141995-03-17 16:07:09 +0000220 This function is similar to the
Fred Drake53525371998-03-03 21:56:15 +0000221 \keyword{exec} statement, but parses a file instead of a string. It
222 is different from the \keyword{import} statement in that it does not
223 use the module administration --- it reads the file unconditionally
224 and does not create a new module.\footnote{It is used relatively
225 rarely so does not warrant being made into a statement.}
Guido van Rossumf8601621995-01-10 10:50:24 +0000226
227 The arguments are a file name and two optional dictionaries. The
228 file is parsed and evaluated as a sequence of Python statements
229 (similarly to a module) using the \var{globals} and \var{locals}
Guido van Rossum470be141995-03-17 16:07:09 +0000230 dictionaries as global and local name space. If the \var{locals}
231 dictionary is omitted it defaults to the \var{globals} dictionary.
Guido van Rossumf8601621995-01-10 10:50:24 +0000232 If both dictionaries are omitted, the expression is executed in the
Fred Drake53525371998-03-03 21:56:15 +0000233 environment where \function{execfile()} is called. The return value is
Guido van Rossum470be141995-03-17 16:07:09 +0000234 \code{None}.
Guido van Rossumf8601621995-01-10 10:50:24 +0000235\end{funcdesc}
236
Fred Drakecce10901998-03-17 06:33:25 +0000237\begin{funcdesc}{filter}{function, list}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000238Construct a list from those elements of \var{list} for which
239\var{function} returns true. If \var{list} is a string or a tuple,
240the result also has that type; otherwise it is always a list. If
241\var{function} is \code{None}, the identity function is assumed,
Guido van Rossum6c4f0031995-03-07 10:14:09 +0000242i.e.\ all elements of \var{list} that are false (zero or empty) are
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000243removed.
244\end{funcdesc}
245
246\begin{funcdesc}{float}{x}
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000247 Convert a string or a number to floating point. If the argument is a
Fred Draked83675f1998-12-07 17:13:18 +0000248 string, it must contain a possibly signed decimal or floating point
Fred Drake70a66c91999-02-18 16:08:36 +0000249 number, possibly embedded in whitespace; this behaves identical to
250 \code{string.atof(\var{x})}. Otherwise, the argument may be a plain
251 or long integer or a floating point number, and a floating point
252 number with the same value (within Python's floating point
253 precision) is returned.
254
255 \strong{Note:} When passing in a string, values for NaN\index{NaN}
256 and Infinity\index{Infinity} may be returned, depending on the
257 underlying C library. The specific set of strings accepted which
258 cause these values to be returned depends entirely on the C library
259 and is known to vary.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000260\end{funcdesc}
261
Fred Drakede5d5ce1999-07-22 19:21:45 +0000262\begin{funcdesc}{getattr}{object, name\optional{, default}}
263 Return the value of the named attributed of \var{object}. \var{name}
264 must be a string. If the string is the name of one of the object's
265 attributes, the result is the value of that attribute. For example,
266 \code{getattr(x, 'foobar')} is equivalent to \code{x.foobar}. If the
267 named attribute does not exist, \var{default} is returned if provided,
268 otherwise \exception{AttributeError} is raised.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000269\end{funcdesc}
270
Guido van Rossumfb502e91995-07-07 22:58:28 +0000271\begin{funcdesc}{globals}{}
272Return a dictionary representing the current global symbol table.
273This is always the dictionary of the current module (inside a
274function or method, this is the module where it is defined, not the
275module from which it is called).
276\end{funcdesc}
277
Fred Drakecce10901998-03-17 06:33:25 +0000278\begin{funcdesc}{hasattr}{object, name}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000279 The arguments are an object and a string. The result is 1 if the
280 string is the name of one of the object's attributes, 0 if not.
Fred Drake53525371998-03-03 21:56:15 +0000281 (This is implemented by calling \code{getattr(\var{object},
282 \var{name})} and seeing whether it raises an exception or not.)
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000283\end{funcdesc}
284
285\begin{funcdesc}{hash}{object}
286 Return the hash value of the object (if it has one). Hash values
Guido van Rossumeb0f0661997-12-30 20:38:16 +0000287 are integers. They are used to quickly compare dictionary
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000288 keys during a dictionary lookup. Numeric values that compare equal
289 have the same hash value (even if they are of different types, e.g.
290 1 and 1.0).
291\end{funcdesc}
292
293\begin{funcdesc}{hex}{x}
Guido van Rossum470be141995-03-17 16:07:09 +0000294 Convert an integer number (of any size) to a hexadecimal string.
Guido van Rossum5cd75201997-01-14 18:44:23 +0000295 The result is a valid Python expression. Note: this always yields
296 an unsigned literal, e.g. on a 32-bit machine, \code{hex(-1)} yields
297 \code{'0xffffffff'}. When evaluated on a machine with the same
298 word size, this literal is evaluated as -1; at a different word
299 size, it may turn up as a large positive number or raise an
Fred Drake53525371998-03-03 21:56:15 +0000300 \exception{OverflowError} exception.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000301\end{funcdesc}
302
303\begin{funcdesc}{id}{object}
Fred Drake8aa3bd92000-06-29 03:46:46 +0000304 Return the `identity' of an object. This is an integer (or long
305 integer) which is guaranteed to be unique and constant for this
306 object during its lifetime. Two objects whose lifetimes are
307 disjunct may have the same \function{id()} value. (Implementation
308 note: this is the address of the object.)
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000309\end{funcdesc}
310
Guido van Rossum16d6e711994-08-08 12:30:22 +0000311\begin{funcdesc}{input}{\optional{prompt}}
Guido van Rossum777dcc61998-06-17 15:16:40 +0000312 Equivalent to \code{eval(raw_input(\var{prompt}))}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000313\end{funcdesc}
314
Fred Drake1e862e82000-02-17 17:45:52 +0000315\begin{funcdesc}{int}{x\optional{, radix}}
316 Convert a string or number to a plain integer. If the argument is a
317 string, it must contain a possibly signed decimal number
318 representable as a Python integer, possibly embedded in whitespace;
319 this behaves identical to \code{string.atoi(\var{x}\optional{,
320 \var{radix}})}. The \var{radix} parameter gives the base for the
Fred Drake8b168ba2000-08-03 17:29:13 +0000321 conversion and may be any integer in the range [2, 36]. If
Fred Drake1e862e82000-02-17 17:45:52 +0000322 \var{radix} is specified and \var{x} is not a string,
323 \exception{TypeError} is raised.
324 Otherwise, the argument may be a plain or
325 long integer or a floating point number. Conversion of floating
326 point numbers to integers is defined by the C semantics; normally
327 the conversion truncates towards zero.\footnote{This is ugly --- the
328 language definition should require truncation towards zero.}
329\end{funcdesc}
330
Guido van Rossum3978d751997-03-03 16:03:27 +0000331\begin{funcdesc}{intern}{string}
332 Enter \var{string} in the table of ``interned'' strings and return
333 the interned string -- which is \var{string} itself or a copy.
334 Interning strings is useful to gain a little performance on
335 dictionary lookup -- if the keys in a dictionary are interned, and
336 the lookup key is interned, the key comparisons (after hashing) can
337 be done by a pointer compare instead of a string compare. Normally,
338 the names used in Python programs are automatically interned, and
339 the dictionaries used to hold module, class or instance attributes
340 have interned keys. Interned strings are immortal (i.e. never get
341 garbage collected).
342\end{funcdesc}
343
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000344\begin{funcdesc}{isinstance}{object, class}
345Return true if the \var{object} argument is an instance of the
346\var{class} argument, or of a (direct or indirect) subclass thereof.
Guido van Rossum3593e5c1997-12-02 19:15:01 +0000347Also return true if \var{class} is a type object and \var{object} is
348an object of that type. If \var{object} is not a class instance or a
349object of the given type, the function always returns false. If
350\var{class} is neither a class object nor a type object, a
Fred Drake53525371998-03-03 21:56:15 +0000351\exception{TypeError} exception is raised.
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000352\end{funcdesc}
353
354\begin{funcdesc}{issubclass}{class1, class2}
355Return true if \var{class1} is a subclass (direct or indirect) of
356\var{class2}. A class is considered a subclass of itself. If either
Fred Drake53525371998-03-03 21:56:15 +0000357argument is not a class object, a \exception{TypeError} exception is
358raised.
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000359\end{funcdesc}
360
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000361\begin{funcdesc}{len}{s}
362 Return the length (the number of items) of an object. The argument
363 may be a sequence (string, tuple or list) or a mapping (dictionary).
364\end{funcdesc}
365
Guido van Rossum921f32c1997-06-02 17:21:20 +0000366\begin{funcdesc}{list}{sequence}
367Return a list whose items are the same and in the same order as
368\var{sequence}'s items. If \var{sequence} is already a list,
369a copy is made and returned, similar to \code{\var{sequence}[:]}.
370For instance, \code{list('abc')} returns
371returns \code{['a', 'b', 'c']} and \code{list( (1, 2, 3) )} returns
372\code{[1, 2, 3]}.
373\end{funcdesc}
374
Guido van Rossumfb502e91995-07-07 22:58:28 +0000375\begin{funcdesc}{locals}{}
376Return a dictionary representing the current local symbol table.
Guido van Rossum7b7f6681998-06-18 16:45:34 +0000377\strong{Warning:} the contents of this dictionary should not be
378modified; changes may not affect the values of local variables used by
379the interpreter.
Guido van Rossumfb502e91995-07-07 22:58:28 +0000380\end{funcdesc}
381
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000382\begin{funcdesc}{long}{x}
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000383 Convert a string or number to a long integer. If the argument is a
Fred Draked83675f1998-12-07 17:13:18 +0000384 string, it must contain a possibly signed decimal number of
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000385 arbitrary size, possibly embedded in whitespace;
386 this behaves identical to \code{string.atol(\var{x})}.
387 Otherwise, the argument may be a plain or
Guido van Rossumeb0f0661997-12-30 20:38:16 +0000388 long integer or a floating point number, and a long integer with
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000389 the same value is returned. Conversion of floating
390 point numbers to integers is defined by the C semantics;
Fred Drake53525371998-03-03 21:56:15 +0000391 see the description of \function{int()}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000392\end{funcdesc}
393
Fred Drakecce10901998-03-17 06:33:25 +0000394\begin{funcdesc}{map}{function, list, ...}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000395Apply \var{function} to every item of \var{list} and return a list
396of the results. If additional \var{list} arguments are passed,
397\var{function} must take that many arguments and is applied to
398the items of all lists in parallel; if a list is shorter than another
399it is assumed to be extended with \code{None} items. If
400\var{function} is \code{None}, the identity function is assumed; if
Fred Drake53525371998-03-03 21:56:15 +0000401there are multiple list arguments, \function{map()} returns a list
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000402consisting of tuples containing the corresponding items from all lists
403(i.e. a kind of transpose operation). The \var{list} arguments may be
404any kind of sequence; the result is always a list.
405\end{funcdesc}
406
Guido van Rossum5eabf381998-11-25 18:53:05 +0000407\begin{funcdesc}{max}{s\optional{, args...}}
408With a single argument \var{s}, return the largest item of a
409non-empty sequence (e.g., a string, tuple or list). With more than
410one argument, return the largest of the arguments.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000411\end{funcdesc}
412
Guido van Rossum5eabf381998-11-25 18:53:05 +0000413\begin{funcdesc}{min}{s\optional{, args...}}
414With a single argument \var{s}, return the smallest item of a
415non-empty sequence (e.g., a string, tuple or list). With more than
416one argument, return the smallest of the arguments.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000417\end{funcdesc}
418
419\begin{funcdesc}{oct}{x}
Guido van Rossum470be141995-03-17 16:07:09 +0000420 Convert an integer number (of any size) to an octal string. The
Guido van Rossum5cd75201997-01-14 18:44:23 +0000421 result is a valid Python expression. Note: this always yields
422 an unsigned literal, e.g. on a 32-bit machine, \code{oct(-1)} yields
423 \code{'037777777777'}. When evaluated on a machine with the same
424 word size, this literal is evaluated as -1; at a different word
425 size, it may turn up as a large positive number or raise an
Fred Drake53525371998-03-03 21:56:15 +0000426 \exception{OverflowError} exception.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000427\end{funcdesc}
428
Fred Drakecce10901998-03-17 06:33:25 +0000429\begin{funcdesc}{open}{filename\optional{, mode\optional{, bufsize}}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000430 Return a new file object (described earlier under Built-in Types).
Guido van Rossum041be051994-05-03 14:46:50 +0000431 The first two arguments are the same as for \code{stdio}'s
Fred Drake53525371998-03-03 21:56:15 +0000432 \cfunction{fopen()}: \var{filename} is the file name to be opened,
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000433 \var{mode} indicates how the file is to be opened: \code{'r'} for
434 reading, \code{'w'} for writing (truncating an existing file), and
Fred Drakeaf8a0151998-01-14 14:51:31 +0000435 \code{'a'} opens it for appending (which on \emph{some} \UNIX{}
436 systems means that \emph{all} writes append to the end of the file,
Guido van Rossum59b328e1996-05-02 15:16:59 +0000437 regardless of the current seek position).
Guido van Rossum5fdd1191998-07-29 21:05:35 +0000438
439 Modes \code{'r+'}, \code{'w+'} and \code{'a+'} open the file for
440 updating (note that \code{'w+'} truncates the file). Append
441 \code{'b'} to the mode to open the file in binary mode, on systems
442 that differentiate between binary and text files (else it is
443 ignored). If the file cannot be opened, \exception{IOError} is
444 raised.
445
Fred Drake9aa85431999-04-05 21:22:41 +0000446 If \var{mode} is omitted, it defaults to \code{'r'}. When opening a
447 binary file, you should append \code{'b'} to the \var{mode} value
448 for improved portability. (It's useful even on systems which don't
449 treat binary and text files differently, where it serves as
Fred Draked3fbdfd1999-08-05 13:43:08 +0000450 documentation.)
451 \index{line-buffered I/O}\index{unbuffered I/O}\index{buffer size, I/O}
452 \index{I/O control!buffering}
453 The optional \var{bufsize} argument specifies the
Fred Drake9aa85431999-04-05 21:22:41 +0000454 file's desired buffer size: 0 means unbuffered, 1 means line
455 buffered, any other positive value means use a buffer of
456 (approximately) that size. A negative \var{bufsize} means to use
457 the system default, which is usually line buffered for for tty
458 devices and fully buffered for other files. If omitted, the system
459 default is used.\footnote{
460 Specifying a buffer size currently has no effect on systems that
461 don't have \cfunction{setvbuf()}. The interface to specify the
462 buffer size is not done using a method that calls
463 \cfunction{setvbuf()}, because that may dump core when called
464 after any I/O has been performed, and there's no reliable way to
465 determine whether this is the case.}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000466\end{funcdesc}
467
468\begin{funcdesc}{ord}{c}
Fred Drake33d51842000-04-06 14:43:12 +0000469 Return the \ASCII{} value of a string of one character or a Unicode
470 character. E.g., \code{ord('a')} returns the integer \code{97},
471 \code{ord(u'\\u2020')} returns \code{8224}. This is the inverse of
472 \function{chr()} for strings and of \function{unichr()} for Unicode
473 characters.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000474\end{funcdesc}
475
Fred Drakecce10901998-03-17 06:33:25 +0000476\begin{funcdesc}{pow}{x, y\optional{, z}}
Guido van Rossumb8b264b1994-08-12 13:13:50 +0000477 Return \var{x} to the power \var{y}; if \var{z} is present, return
478 \var{x} to the power \var{y}, modulo \var{z} (computed more
Fred Drake6251c161998-04-03 07:15:54 +0000479 efficiently than \code{pow(\var{x}, \var{y}) \%\ \var{z}}).
Guido van Rossumb8b264b1994-08-12 13:13:50 +0000480 The arguments must have
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000481 numeric types. With mixed operand types, the rules for binary
482 arithmetic operators apply. The effective operand type is also the
483 type of the result; if the result is not expressible in this type, the
Guido van Rossum16d6e711994-08-08 12:30:22 +0000484 function raises an exception; e.g., \code{pow(2, -1)} or \code{pow(2,
485 35000)} is not allowed.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000486\end{funcdesc}
487
Fred Drakecce10901998-03-17 06:33:25 +0000488\begin{funcdesc}{range}{\optional{start,} stop\optional{, step}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000489 This is a versatile function to create lists containing arithmetic
Fred Drake53525371998-03-03 21:56:15 +0000490 progressions. It is most often used in \keyword{for} loops. The
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000491 arguments must be plain integers. If the \var{step} argument is
492 omitted, it defaults to \code{1}. If the \var{start} argument is
493 omitted, it defaults to \code{0}. The full form returns a list of
494 plain integers \code{[\var{start}, \var{start} + \var{step},
495 \var{start} + 2 * \var{step}, \ldots]}. If \var{step} is positive,
496 the last element is the largest \code{\var{start} + \var{i} *
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000497 \var{step}} less than \var{stop}; if \var{step} is negative, the last
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000498 element is the largest \code{\var{start} + \var{i} * \var{step}}
Fred Drake6251c161998-04-03 07:15:54 +0000499 greater than \var{stop}. \var{step} must not be zero (or else
500 \exception{ValueError} is raised). Example:
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000501
Fred Drake19479911998-02-13 06:58:54 +0000502\begin{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000503>>> range(10)
504[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
505>>> range(1, 11)
506[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
507>>> range(0, 30, 5)
508[0, 5, 10, 15, 20, 25]
509>>> range(0, 10, 3)
510[0, 3, 6, 9]
511>>> range(0, -10, -1)
512[0, -1, -2, -3, -4, -5, -6, -7, -8, -9]
513>>> range(0)
514[]
515>>> range(1, 0)
516[]
Fred Drake19479911998-02-13 06:58:54 +0000517\end{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000518\end{funcdesc}
519
Guido van Rossum16d6e711994-08-08 12:30:22 +0000520\begin{funcdesc}{raw_input}{\optional{prompt}}
521 If the \var{prompt} argument is present, it is written to standard output
522 without a trailing newline. The function then reads a line from input,
523 converts it to a string (stripping a trailing newline), and returns that.
Fred Drake53525371998-03-03 21:56:15 +0000524 When \EOF{} is read, \exception{EOFError} is raised. Example:
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000525
Fred Drake19479911998-02-13 06:58:54 +0000526\begin{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000527>>> s = raw_input('--> ')
528--> Monty Python's Flying Circus
529>>> s
Guido van Rossum470be141995-03-17 16:07:09 +0000530"Monty Python's Flying Circus"
Fred Drake19479911998-02-13 06:58:54 +0000531\end{verbatim}
Guido van Rossum921f32c1997-06-02 17:21:20 +0000532
Fred Drake53525371998-03-03 21:56:15 +0000533If the \module{readline} module was loaded, then
534\function{raw_input()} will use it to provide elaborate
Guido van Rossum921f32c1997-06-02 17:21:20 +0000535line editing and history features.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000536\end{funcdesc}
537
Guido van Rossum87e611e1999-01-06 23:10:51 +0000538\begin{funcdesc}{reduce}{function, sequence\optional{, initializer}}
539Apply \var{function} of two arguments cumulatively to the items of
540\var{sequence}, from left to right, so as to reduce the sequence to
541a single value. For example,
542\code{reduce(lambda x, y: x+y, [1, 2, 3, 4, 5])} calculates
543\code{((((1+2)+3)+4)+5)}.
544If the optional \var{initializer} is present, it is placed before the
545items of the sequence in the calculation, and serves as a default when
546the sequence is empty.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000547\end{funcdesc}
548
549\begin{funcdesc}{reload}{module}
Guido van Rossum470be141995-03-17 16:07:09 +0000550Re-parse and re-initialize an already imported \var{module}. The
551argument must be a module object, so it must have been successfully
552imported before. This is useful if you have edited the module source
553file using an external editor and want to try out the new version
554without leaving the Python interpreter. The return value is the
555module object (i.e.\ the same as the \var{module} argument).
556
557There are a number of caveats:
558
559If a module is syntactically correct but its initialization fails, the
Fred Drake53525371998-03-03 21:56:15 +0000560first \keyword{import} statement for it does not bind its name locally,
Guido van Rossum470be141995-03-17 16:07:09 +0000561but does store a (partially initialized) module object in
562\code{sys.modules}. To reload the module you must first
Fred Drake53525371998-03-03 21:56:15 +0000563\keyword{import} it again (this will bind the name to the partially
564initialized module object) before you can \function{reload()} it.
Guido van Rossum470be141995-03-17 16:07:09 +0000565
566When a module is reloaded, its dictionary (containing the module's
567global variables) is retained. Redefinitions of names will override
568the old definitions, so this is generally not a problem. If the new
569version of a module does not define a name that was defined by the old
570version, the old definition remains. This feature can be used to the
571module's advantage if it maintains a global table or cache of objects
Fred Drake53525371998-03-03 21:56:15 +0000572--- with a \keyword{try} statement it can test for the table's presence
Guido van Rossum470be141995-03-17 16:07:09 +0000573and skip its initialization if desired.
574
575It is legal though generally not very useful to reload built-in or
Fred Drake53525371998-03-03 21:56:15 +0000576dynamically loaded modules, except for \module{sys}, \module{__main__}
577and \module{__builtin__}. In certain cases, however, extension
578modules are not designed to be initialized more than once, and may
579fail in arbitrary ways when reloaded.
Guido van Rossum470be141995-03-17 16:07:09 +0000580
Fred Drake53525371998-03-03 21:56:15 +0000581If a module imports objects from another module using \keyword{from}
582\ldots{} \keyword{import} \ldots{}, calling \function{reload()} for
583the other module does not redefine the objects imported from it ---
584one way around this is to re-execute the \keyword{from} statement,
585another is to use \keyword{import} and qualified names
586(\var{module}.\var{name}) instead.
Guido van Rossum470be141995-03-17 16:07:09 +0000587
588If a module instantiates instances of a class, reloading the module
589that defines the class does not affect the method definitions of the
590instances --- they continue to use the old class definition. The same
591is true for derived classes.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000592\end{funcdesc}
593
594\begin{funcdesc}{repr}{object}
595Return a string containing a printable representation of an object.
596This is the same value yielded by conversions (reverse quotes).
597It is sometimes useful to be able to access this operation as an
598ordinary function. For many types, this function makes an attempt
599to return a string that would yield an object with the same value
Fred Drake53525371998-03-03 21:56:15 +0000600when passed to \function{eval()}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000601\end{funcdesc}
602
Fred Drake607f8021998-08-24 20:30:07 +0000603\begin{funcdesc}{round}{x\optional{, n}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000604 Return the floating point value \var{x} rounded to \var{n} digits
605 after the decimal point. If \var{n} is omitted, it defaults to zero.
606 The result is a floating point number. Values are rounded to the
607 closest multiple of 10 to the power minus \var{n}; if two multiples
608 are equally close, rounding is done away from 0 (so e.g.
609 \code{round(0.5)} is \code{1.0} and \code{round(-0.5)} is \code{-1.0}).
610\end{funcdesc}
611
Fred Drakecce10901998-03-17 06:33:25 +0000612\begin{funcdesc}{setattr}{object, name, value}
Fred Drake53525371998-03-03 21:56:15 +0000613 This is the counterpart of \function{getattr()}. The arguments are an
Fred Drake607f8021998-08-24 20:30:07 +0000614 object, a string and an arbitrary value. The string may name an
615 existing attribute or a new attribute. The function assigns the
616 value to the attribute, provided the object allows it. For example,
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000617 \code{setattr(\var{x}, '\var{foobar}', 123)} is equivalent to
618 \code{\var{x}.\var{foobar} = 123}.
619\end{funcdesc}
620
Fred Drakecce10901998-03-17 06:33:25 +0000621\begin{funcdesc}{slice}{\optional{start,} stop\optional{, step}}
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000622Return a slice object representing the set of indices specified by
623\code{range(\var{start}, \var{stop}, \var{step})}. The \var{start}
624and \var{step} arguments default to None. Slice objects have
Fred Drake53525371998-03-03 21:56:15 +0000625read-only data attributes \member{start}, \member{stop} and \member{step}
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000626which merely return the argument values (or their default). They have
627no other explicit functionality; however they are used by Numerical
Fred Drake6251c161998-04-03 07:15:54 +0000628Python\index{Numerical Python} and other third party extensions.
629Slice objects are also generated when extended indexing syntax is
630used, e.g. for \samp{a[start:stop:step]} or \samp{a[start:stop, i]}.
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000631\end{funcdesc}
632
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000633\begin{funcdesc}{str}{object}
634Return a string containing a nicely printable representation of an
635object. For strings, this returns the string itself. The difference
Guido van Rossum6c4f0031995-03-07 10:14:09 +0000636with \code{repr(\var{object})} is that \code{str(\var{object})} does not
Fred Drake53525371998-03-03 21:56:15 +0000637always attempt to return a string that is acceptable to \function{eval()};
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000638its goal is to return a printable string.
639\end{funcdesc}
640
Guido van Rossum470be141995-03-17 16:07:09 +0000641\begin{funcdesc}{tuple}{sequence}
Guido van Rossumb8b264b1994-08-12 13:13:50 +0000642Return a tuple whose items are the same and in the same order as
Guido van Rossum921f32c1997-06-02 17:21:20 +0000643\var{sequence}'s items. If \var{sequence} is already a tuple, it
Guido van Rossumb8b264b1994-08-12 13:13:50 +0000644is returned unchanged. For instance, \code{tuple('abc')} returns
645returns \code{('a', 'b', 'c')} and \code{tuple([1, 2, 3])} returns
646\code{(1, 2, 3)}.
647\end{funcdesc}
648
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000649\begin{funcdesc}{type}{object}
Guido van Rossum470be141995-03-17 16:07:09 +0000650Return the type of an \var{object}. The return value is a type
Fred Drake53525371998-03-03 21:56:15 +0000651object. The standard module \module{types} defines names for all
Guido van Rossum470be141995-03-17 16:07:09 +0000652built-in types.
Fred Drakee14388c1997-12-15 22:28:38 +0000653\refstmodindex{types}
Guido van Rossum470be141995-03-17 16:07:09 +0000654\obindex{type}
655For instance:
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000656
Fred Drake19479911998-02-13 06:58:54 +0000657\begin{verbatim}
Guido van Rossum470be141995-03-17 16:07:09 +0000658>>> import types
Guido van Rossuma7874d11998-06-22 14:07:36 +0000659>>> if type(x) == types.StringType: print "It's a string"
Fred Drake19479911998-02-13 06:58:54 +0000660\end{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000661\end{funcdesc}
Guido van Rossum68cfbe71994-02-24 11:28:27 +0000662
Fred Drake33d51842000-04-06 14:43:12 +0000663\begin{funcdesc}{unichr}{i}
664Return the Unicode string of one character whose Unicode code is the
665integer \var{i}, e.g., \code{unichr(97)} returns the string
666\code{u'a'}. This is the inverse of \function{ord()} for Unicode
667strings. The argument must be in the range [0..65535], inclusive.
668\exception{ValueError} is raised otherwise.
Fred Drake30f76ff2000-06-30 16:06:19 +0000669\versionadded{2.0}
Fred Drake33d51842000-04-06 14:43:12 +0000670\end{funcdesc}
671
672\begin{funcdesc}{unicode}{string\optional{, encoding='utf-8'\optional{, errors='strict'}}}
673Decodes \var{string} using the codec for \var{encoding}. Error
674handling is done according to \var{errors}. The default behavior is
675to decode UTF-8 in strict mode, meaning that encoding errors raise
676\exception{ValueError}.
Fred Drake30f76ff2000-06-30 16:06:19 +0000677\versionadded{2.0}
Fred Drake33d51842000-04-06 14:43:12 +0000678\end{funcdesc}
679
Guido van Rossum6bb1adc1995-03-13 10:03:32 +0000680\begin{funcdesc}{vars}{\optional{object}}
Guido van Rossum17383111994-04-21 10:32:28 +0000681Without arguments, return a dictionary corresponding to the current
682local symbol table. With a module, class or class instance object as
Fred Drake53525371998-03-03 21:56:15 +0000683argument (or anything else that has a \member{__dict__} attribute),
Guido van Rossum17383111994-04-21 10:32:28 +0000684returns a dictionary corresponding to the object's symbol table.
685The returned dictionary should not be modified: the effects on the
Fred Drake9aa85431999-04-05 21:22:41 +0000686corresponding symbol table are undefined.\footnote{
687 In the current implementation, local variable bindings cannot
688 normally be affected this way, but variables retrieved from
689 other scopes (e.g. modules) can be. This may change.}
Guido van Rossum17383111994-04-21 10:32:28 +0000690\end{funcdesc}
691
Fred Drakecce10901998-03-17 06:33:25 +0000692\begin{funcdesc}{xrange}{\optional{start,} stop\optional{, step}}
Fred Drake53525371998-03-03 21:56:15 +0000693This function is very similar to \function{range()}, but returns an
Guido van Rossum68cfbe71994-02-24 11:28:27 +0000694``xrange object'' instead of a list. This is an opaque sequence type
695which yields the same values as the corresponding list, without
696actually storing them all simultaneously. The advantage of
Fred Drake53525371998-03-03 21:56:15 +0000697\function{xrange()} over \function{range()} is minimal (since
698\function{xrange()} still has to create the values when asked for
699them) except when a very large range is used on a memory-starved
700machine (e.g. MS-DOS) or when all of the range's elements are never
701used (e.g. when the loop is usually terminated with \keyword{break}).
Guido van Rossum68cfbe71994-02-24 11:28:27 +0000702\end{funcdesc}
Barry Warsawfaefa2a2000-08-03 15:46:17 +0000703
Fred Drake8b168ba2000-08-03 17:29:13 +0000704\begin{funcdesc}{zip}{seq1, \moreargs}
Barry Warsawfaefa2a2000-08-03 15:46:17 +0000705This function returns a list of tuples, where each tuple contains the
Fred Drake8b168ba2000-08-03 17:29:13 +0000706\var{i}-th element from each of the argument sequences. At least one
Barry Warsawfaefa2a2000-08-03 15:46:17 +0000707sequence is required, otherwise a \exception{TypeError} is raised.
708The returned list is truncated in length to the length of the shortest
709argument sequence. When the argument sequences are all of the same
Fred Drake8b168ba2000-08-03 17:29:13 +0000710length, \function{zip()} is similar to \function{map()} with an
711initial argument of \code{None}.
Fred Drakee581bb32000-08-17 22:30:30 +0000712\versionadded{2.0}
Fred Drake8b168ba2000-08-03 17:29:13 +0000713\end{funcdesc}