blob: 53970ee451a19754c58ff7959eb43c062710a233 [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 Drakebc0b2602001-01-18 18:09:07 +000022For example, the statement \samp{import spam} results in the
Fred Drake315b5d81998-02-13 21:26:35 +000023following call:
24\code{__import__('spam',} \code{globals(),} \code{locals(), [])};
Fred Drakebc0b2602001-01-18 18:09:07 +000025the statement \samp{from spam.ham import eggs} results
26in \samp{__import__('spam.ham', globals(), locals(), ['eggs'])}.
Guido van Rossum7974b0f1997-10-05 18:53:00 +000027Note that even though \code{locals()} and \code{['eggs']} are passed
Fred Drake53525371998-03-03 21:56:15 +000028in as arguments, the \function{__import__()} function does not set the
Guido van Rossum7974b0f1997-10-05 18:53:00 +000029local variable named \code{eggs}; this is done by subsequent code that
30is generated for the import statement. (In fact, the standard
31implementation does not use its \var{locals} argument at all, and uses
32its \var{globals} only to determine the package context of the
Fred Drake53525371998-03-03 21:56:15 +000033\keyword{import} statement.)
Guido van Rossum7974b0f1997-10-05 18:53:00 +000034
35When the \var{name} variable is of the form \code{package.module},
36normally, the top-level package (the name up till the first dot) is
37returned, \emph{not} the module named by \var{name}. However, when a
38non-empty \var{fromlist} argument is given, the module named by
39\var{name} is returned. This is done for compatibility with the
40bytecode generated for the different kinds of import statement; when
Fred Drake53525371998-03-03 21:56:15 +000041using \samp{import spam.ham.eggs}, the top-level package \code{spam}
42must be placed in the importing namespace, but when using \samp{from
Guido van Rossum7974b0f1997-10-05 18:53:00 +000043spam.ham import eggs}, the \code{spam.ham} subpackage must be used to
44find the \code{eggs} variable.
Guido van Rossum8c2da611998-12-04 15:32:17 +000045As a workaround for this behavior, use \function{getattr()} to extract
46the desired components. For example, you could define the following
47helper:
48
49\begin{verbatim}
50import string
51
52def my_import(name):
53 mod = __import__(name)
54 components = string.split(name, '.')
55 for comp in components[1:]:
56 mod = getattr(mod, comp)
57 return mod
58\end{verbatim}
59
Guido van Rossum7974b0f1997-10-05 18:53:00 +000060\end{funcdesc}
61
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000062\begin{funcdesc}{abs}{x}
63 Return the absolute value of a number. The argument may be a plain
Guido van Rossum921f32c1997-06-02 17:21:20 +000064 or long integer or a floating point number. If the argument is a
Guido van Rossum7974b0f1997-10-05 18:53:00 +000065 complex number, its magnitude is returned.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000066\end{funcdesc}
67
Fred Drakecce10901998-03-17 06:33:25 +000068\begin{funcdesc}{apply}{function, args\optional{, keywords}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000069The \var{function} argument must be a callable object (a user-defined or
70built-in function or method, or a class object) and the \var{args}
Barry Warsawb2031f71998-10-01 15:35:43 +000071argument must be a sequence (if it is not a tuple, the sequence is
72first converted to a tuple). The \var{function} is called with
73\var{args} as the argument list; the number of arguments is the the length
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000074of the tuple. (This is different from just calling
75\code{\var{func}(\var{args})}, since in that case there is always
76exactly one argument.)
Guido van Rossum0568d5e1995-10-08 01:06:46 +000077If the optional \var{keywords} argument is present, it must be a
78dictionary whose keys are strings. It specifies keyword arguments to
79be added to the end of the the argument list.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000080\end{funcdesc}
81
Guido van Rossum8be22961999-03-19 19:10:14 +000082\begin{funcdesc}{buffer}{object\optional{, offset\optional{, size}}}
83The \var{object} argument must be an object that supports the
84buffer call interface (such as strings, arrays, and buffers). A new
85buffer object will be created which references the \var{object} argument.
86The buffer object will be a slice from the beginning of \var{object}
87(or from the specified \var{offset}). The slice will extend to the
88end of \var{object} (or will have a length given by the \var{size}
89argument).
90\end{funcdesc}
91
Guido van Rossum7974b0f1997-10-05 18:53:00 +000092\begin{funcdesc}{callable}{object}
93Return true if the \var{object} argument appears callable, false if
94not. If this returns true, it is still possible that a call fails,
95but if it is false, calling \var{object} will never succeed. Note
96that classes are callable (calling a class returns a new instance);
Fred Drake53525371998-03-03 21:56:15 +000097class instances are callable if they have a \method{__call__()} method.
Guido van Rossum7974b0f1997-10-05 18:53:00 +000098\end{funcdesc}
99
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000100\begin{funcdesc}{chr}{i}
101 Return a string of one character whose \ASCII{} code is the integer
Fred Drake91f2f262001-07-06 19:28:48 +0000102 \var{i}. For example, \code{chr(97)} returns the string \code{'a'}.
103 This is the inverse of \function{ord()}. The argument must be in
104 the range [0..255], inclusive; \exception{ValueError} will be raised
105 if \var{i} is outside that range.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000106\end{funcdesc}
107
Fred Drakecce10901998-03-17 06:33:25 +0000108\begin{funcdesc}{cmp}{x, y}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000109 Compare the two objects \var{x} and \var{y} and return an integer
110 according to the outcome. The return value is negative if \code{\var{x}
111 < \var{y}}, zero if \code{\var{x} == \var{y}} and strictly positive if
112 \code{\var{x} > \var{y}}.
113\end{funcdesc}
114
Fred Drakecce10901998-03-17 06:33:25 +0000115\begin{funcdesc}{coerce}{x, y}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000116 Return a tuple consisting of the two numeric arguments converted to
117 a common type, using the same rules as used by arithmetic
118 operations.
119\end{funcdesc}
120
Michael W. Hudson53da3172001-08-27 20:02:17 +0000121\begin{funcdesc}{compile}{string, filename, kind\optional{,
122 flags\optional{, dont_inherit}}}
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
Fred Drake91f2f262001-07-06 19:28:48 +0000126 give the file from which the code was read; pass same recognizable value
127 if it wasn't read from a file (\code{'<string>'} is commonly used).
128 The \var{kind} argument specifies what kind of code must be
129 compiled; it can be \code{'exec'} if \var{string} consists of a
130 sequence of statements, \code{'eval'} if it consists of a single
131 expression, or \code{'single'} if it consists of a single
132 interactive statement (in the latter case, expression statements
133 that evaluate to something else than \code{None} will printed).
Michael W. Hudson53da3172001-08-27 20:02:17 +0000134
135 The optional arguments \var{flags} and \optional{dont_inherit}
136 (which are new in Python 2.2) control which future statements (see
137 \pep{236}) affect the compilation of \var{string}. If neither is
138 present (or both are zero) the code is compiled with those future
139 statements that are in effect in the code that is calling compile.
140 If the \var{flags} argument is given and \var{dont_inherit} is not
141 (or is zero) then the future statements specified by the \var{flags}
142 argument are used in addition to those that would be used anyway.
143 If \var{dont_inherit} is a non-zero integer then the \var{flags}
144 argument is it -- the future statements in effect around the call to
145 compile are ignored.
146
147 Future statemants are specified by bits which can be bitwise or-ed
148 together to specify multiple statements. The bitfield required to
149 specify a given feature can be found as the \member{compiler_flag}
150 attribute on the \class{_Feature} instance in the
151 \module{__future__} module.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000152\end{funcdesc}
153
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000154\begin{funcdesc}{complex}{real\optional{, imag}}
Guido van Rossumcb1f2421999-03-25 21:23:26 +0000155 Create a complex number with the value \var{real} + \var{imag}*j or
156 convert a string or number to a complex number.
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000157 Each argument may be any numeric type (including complex).
158 If \var{imag} is omitted, it defaults to zero and the function
Fred Drake53525371998-03-03 21:56:15 +0000159 serves as a numeric conversion function like \function{int()},
Guido van Rossumcb1f2421999-03-25 21:23:26 +0000160 \function{long()} and \function{float()}; in this case it also
161 accepts a string argument which should be a valid complex number.
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000162\end{funcdesc}
163
Fred Drakecce10901998-03-17 06:33:25 +0000164\begin{funcdesc}{delattr}{object, name}
Fred Drake53525371998-03-03 21:56:15 +0000165 This is a relative of \function{setattr()}. The arguments are an
Guido van Rossum1efbb0f1994-08-16 22:15:11 +0000166 object and a string. The string must be the name
167 of one of the object's attributes. The function deletes
168 the named attribute, provided the object allows it. For example,
Guido van Rossum6c4f0031995-03-07 10:14:09 +0000169 \code{delattr(\var{x}, '\var{foobar}')} is equivalent to
Guido van Rossum1efbb0f1994-08-16 22:15:11 +0000170 \code{del \var{x}.\var{foobar}}.
171\end{funcdesc}
172
Fred Drake6b303b41998-04-16 22:10:27 +0000173\begin{funcdesc}{dir}{\optional{object}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000174 Without arguments, return the list of names in the current local
Guido van Rossumeb0f0661997-12-30 20:38:16 +0000175 symbol table. With an argument, attempts to return a list of valid
176 attribute for that object. This information is gleaned from the
Fred Drake53525371998-03-03 21:56:15 +0000177 object's \member{__dict__}, \member{__methods__} and \member{__members__}
Fred Drake91f2f262001-07-06 19:28:48 +0000178 attributes, if defined. The list is not necessarily complete. For
179 example, for classes, attributes defined in base classes are not
180 included, and for class instances, methods are not included.
Guido van Rossumeb0f0661997-12-30 20:38:16 +0000181 The resulting list is sorted alphabetically. For example:
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000182
Fred Drake19479911998-02-13 06:58:54 +0000183\begin{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000184>>> import sys
185>>> dir()
186['sys']
187>>> dir(sys)
188['argv', 'exit', 'modules', 'path', 'stderr', 'stdin', 'stdout']
Fred Drake19479911998-02-13 06:58:54 +0000189\end{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000190\end{funcdesc}
191
Fred Drakecce10901998-03-17 06:33:25 +0000192\begin{funcdesc}{divmod}{a, b}
Guido van Rossumeb0f0661997-12-30 20:38:16 +0000193 Take two numbers as arguments and return a pair of numbers consisting
194 of their quotient and remainder when using long division. With mixed
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000195 operand types, the rules for binary arithmetic operators apply. For
196 plain and long integers, the result is the same as
197 \code{(\var{a} / \var{b}, \var{a} \%{} \var{b})}.
Fred Drake1ea7c751999-05-06 14:46:35 +0000198 For floating point numbers the result is \code{(\var{q}, \var{a} \%{}
199 \var{b})}, where \var{q} is usually \code{math.floor(\var{a} /
200 \var{b})} but may be 1 less than that. In any case \code{\var{q} *
201 \var{b} + \var{a} \%{} \var{b}} is very close to \var{a}, if
202 \code{\var{a} \%{} \var{b}} is non-zero it has the same sign as
203 \var{b}, and \code{0 <= abs(\var{a} \%{} \var{b}) < abs(\var{b})}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000204\end{funcdesc}
205
Fred Drakecce10901998-03-17 06:33:25 +0000206\begin{funcdesc}{eval}{expression\optional{, globals\optional{, locals}}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000207 The arguments are a string and two optional dictionaries. The
Guido van Rossumf8601621995-01-10 10:50:24 +0000208 \var{expression} argument is parsed and evaluated as a Python
209 expression (technically speaking, a condition list) using the
210 \var{globals} and \var{locals} dictionaries as global and local name
Guido van Rossum470be141995-03-17 16:07:09 +0000211 space. If the \var{locals} dictionary is omitted it defaults to
212 the \var{globals} dictionary. If both dictionaries are omitted, the
Fred Drake53525371998-03-03 21:56:15 +0000213 expression is executed in the environment where \keyword{eval} is
Guido van Rossumf8601621995-01-10 10:50:24 +0000214 called. The return value is the result of the evaluated expression.
215 Syntax errors are reported as exceptions. Example:
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000216
Fred Drake19479911998-02-13 06:58:54 +0000217\begin{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000218>>> x = 1
219>>> print eval('x+1')
2202
Fred Drake19479911998-02-13 06:58:54 +0000221\end{verbatim}
Fred Drake53525371998-03-03 21:56:15 +0000222
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000223 This function can also be used to execute arbitrary code objects
Fred Drake91f2f262001-07-06 19:28:48 +0000224 (such as those created by \function{compile()}). In this case pass
225 a code object instead of a string. The code object must have been
226 compiled passing \code{'eval'} as the \var{kind} argument.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000227
Guido van Rossum6c4f0031995-03-07 10:14:09 +0000228 Hints: dynamic execution of statements is supported by the
Fred Drake53525371998-03-03 21:56:15 +0000229 \keyword{exec} statement. Execution of statements from a file is
230 supported by the \function{execfile()} function. The
231 \function{globals()} and \function{locals()} functions returns the
232 current global and local dictionary, respectively, which may be
233 useful to pass around for use by \function{eval()} or
234 \function{execfile()}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000235\end{funcdesc}
236
Fred Drakecce10901998-03-17 06:33:25 +0000237\begin{funcdesc}{execfile}{file\optional{, globals\optional{, locals}}}
Guido van Rossum470be141995-03-17 16:07:09 +0000238 This function is similar to the
Fred Drake53525371998-03-03 21:56:15 +0000239 \keyword{exec} statement, but parses a file instead of a string. It
240 is different from the \keyword{import} statement in that it does not
241 use the module administration --- it reads the file unconditionally
242 and does not create a new module.\footnote{It is used relatively
243 rarely so does not warrant being made into a statement.}
Guido van Rossumf8601621995-01-10 10:50:24 +0000244
245 The arguments are a file name and two optional dictionaries. The
246 file is parsed and evaluated as a sequence of Python statements
247 (similarly to a module) using the \var{globals} and \var{locals}
Fred Drake13494372000-09-12 16:23:48 +0000248 dictionaries as global and local namespace. If the \var{locals}
Guido van Rossum470be141995-03-17 16:07:09 +0000249 dictionary is omitted it defaults to the \var{globals} dictionary.
Guido van Rossumf8601621995-01-10 10:50:24 +0000250 If both dictionaries are omitted, the expression is executed in the
Fred Drake53525371998-03-03 21:56:15 +0000251 environment where \function{execfile()} is called. The return value is
Guido van Rossum470be141995-03-17 16:07:09 +0000252 \code{None}.
Guido van Rossumf8601621995-01-10 10:50:24 +0000253\end{funcdesc}
254
Fred Drakecce10901998-03-17 06:33:25 +0000255\begin{funcdesc}{filter}{function, list}
Fred Drakeeacdec62001-05-02 20:19:19 +0000256 Construct a list from those elements of \var{list} for which
257 \var{function} returns true. \var{list} may be either a sequence, a
258 container which supports iteration, or an iterator, If \var{list}
259 is a string or a tuple, the result also has that type; otherwise it
260 is always a list. If \var{function} is \code{None}, the identity
Fred Drake91f2f262001-07-06 19:28:48 +0000261 function is assumed, that is, all elements of \var{list} that are false
Fred Drakeeacdec62001-05-02 20:19:19 +0000262 (zero or empty) are removed.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000263\end{funcdesc}
264
265\begin{funcdesc}{float}{x}
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000266 Convert a string or a number to floating point. If the argument is a
Fred Draked83675f1998-12-07 17:13:18 +0000267 string, it must contain a possibly signed decimal or floating point
Fred Drake70a66c91999-02-18 16:08:36 +0000268 number, possibly embedded in whitespace; this behaves identical to
269 \code{string.atof(\var{x})}. Otherwise, the argument may be a plain
270 or long integer or a floating point number, and a floating point
271 number with the same value (within Python's floating point
272 precision) is returned.
273
274 \strong{Note:} When passing in a string, values for NaN\index{NaN}
275 and Infinity\index{Infinity} may be returned, depending on the
276 underlying C library. The specific set of strings accepted which
277 cause these values to be returned depends entirely on the C library
278 and is known to vary.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000279\end{funcdesc}
280
Fred Drakede5d5ce1999-07-22 19:21:45 +0000281\begin{funcdesc}{getattr}{object, name\optional{, default}}
282 Return the value of the named attributed of \var{object}. \var{name}
283 must be a string. If the string is the name of one of the object's
284 attributes, the result is the value of that attribute. For example,
285 \code{getattr(x, 'foobar')} is equivalent to \code{x.foobar}. If the
286 named attribute does not exist, \var{default} is returned if provided,
287 otherwise \exception{AttributeError} is raised.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000288\end{funcdesc}
289
Guido van Rossumfb502e91995-07-07 22:58:28 +0000290\begin{funcdesc}{globals}{}
291Return a dictionary representing the current global symbol table.
292This is always the dictionary of the current module (inside a
293function or method, this is the module where it is defined, not the
294module from which it is called).
295\end{funcdesc}
296
Fred Drakecce10901998-03-17 06:33:25 +0000297\begin{funcdesc}{hasattr}{object, name}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000298 The arguments are an object and a string. The result is 1 if the
299 string is the name of one of the object's attributes, 0 if not.
Fred Drake53525371998-03-03 21:56:15 +0000300 (This is implemented by calling \code{getattr(\var{object},
301 \var{name})} and seeing whether it raises an exception or not.)
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000302\end{funcdesc}
303
304\begin{funcdesc}{hash}{object}
305 Return the hash value of the object (if it has one). Hash values
Guido van Rossumeb0f0661997-12-30 20:38:16 +0000306 are integers. They are used to quickly compare dictionary
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000307 keys during a dictionary lookup. Numeric values that compare equal
Fred Drake91f2f262001-07-06 19:28:48 +0000308 have the same hash value (even if they are of different types, as is
309 the case for 1 and 1.0).
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000310\end{funcdesc}
311
312\begin{funcdesc}{hex}{x}
Guido van Rossum470be141995-03-17 16:07:09 +0000313 Convert an integer number (of any size) to a hexadecimal string.
Guido van Rossum5cd75201997-01-14 18:44:23 +0000314 The result is a valid Python expression. Note: this always yields
Fred Drake91f2f262001-07-06 19:28:48 +0000315 an unsigned literal. For example, on a 32-bit machine,
316 \code{hex(-1)} yields \code{'0xffffffff'}. When evaluated on a
317 machine with the same word size, this literal is evaluated as -1; at
318 a different word size, it may turn up as a large positive number or
319 raise an \exception{OverflowError} exception.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000320\end{funcdesc}
321
322\begin{funcdesc}{id}{object}
Fred Drake8aa3bd92000-06-29 03:46:46 +0000323 Return the `identity' of an object. This is an integer (or long
324 integer) which is guaranteed to be unique and constant for this
325 object during its lifetime. Two objects whose lifetimes are
326 disjunct may have the same \function{id()} value. (Implementation
327 note: this is the address of the object.)
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000328\end{funcdesc}
329
Guido van Rossum16d6e711994-08-08 12:30:22 +0000330\begin{funcdesc}{input}{\optional{prompt}}
Guido van Rossum777dcc61998-06-17 15:16:40 +0000331 Equivalent to \code{eval(raw_input(\var{prompt}))}.
Fred Drakef96e0d22000-09-09 03:33:42 +0000332 \strong{Warning:} This function is not safe from user errors! It
333 expects a valid Python expression as input; if the input is not
334 syntactically valid, a \exception{SyntaxError} will be raised.
335 Other exceptions may be raised if there is an error during
336 evaluation. (On the other hand, sometimes this is exactly what you
337 need when writing a quick script for expert use.)
338
339 If the \module{readline} module was loaded, then
340 \function{input()} will use it to provide elaborate line editing and
341 history features.
342
343 Consider using the \function{raw_input()} function for general input
344 from users.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000345\end{funcdesc}
346
Fred Drake1e862e82000-02-17 17:45:52 +0000347\begin{funcdesc}{int}{x\optional{, radix}}
348 Convert a string or number to a plain integer. If the argument is a
349 string, it must contain a possibly signed decimal number
350 representable as a Python integer, possibly embedded in whitespace;
351 this behaves identical to \code{string.atoi(\var{x}\optional{,
352 \var{radix}})}. The \var{radix} parameter gives the base for the
Fred Drake17383b92000-11-17 19:44:14 +0000353 conversion and may be any integer in the range [2, 36], or zero. If
354 \var{radix} is zero, the proper radix is guessed based on the
355 contents of string; the interpretation is the same as for integer
356 literals. If \var{radix} is specified and \var{x} is not a string,
Fred Drake1e862e82000-02-17 17:45:52 +0000357 \exception{TypeError} is raised.
358 Otherwise, the argument may be a plain or
359 long integer or a floating point number. Conversion of floating
Tim Peters7321ec42001-07-26 20:02:17 +0000360 point numbers to integers truncates (towards zero).
Fred Drake1e862e82000-02-17 17:45:52 +0000361\end{funcdesc}
362
Guido van Rossum3978d751997-03-03 16:03:27 +0000363\begin{funcdesc}{intern}{string}
364 Enter \var{string} in the table of ``interned'' strings and return
365 the interned string -- which is \var{string} itself or a copy.
366 Interning strings is useful to gain a little performance on
367 dictionary lookup -- if the keys in a dictionary are interned, and
368 the lookup key is interned, the key comparisons (after hashing) can
369 be done by a pointer compare instead of a string compare. Normally,
370 the names used in Python programs are automatically interned, and
371 the dictionaries used to hold module, class or instance attributes
Fred Drake91f2f262001-07-06 19:28:48 +0000372 have interned keys. Interned strings are immortal (never get
Guido van Rossum3978d751997-03-03 16:03:27 +0000373 garbage collected).
374\end{funcdesc}
375
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000376\begin{funcdesc}{isinstance}{object, class}
377Return true if the \var{object} argument is an instance of the
378\var{class} argument, or of a (direct or indirect) subclass thereof.
Guido van Rossum3593e5c1997-12-02 19:15:01 +0000379Also return true if \var{class} is a type object and \var{object} is
380an object of that type. If \var{object} is not a class instance or a
381object of the given type, the function always returns false. If
382\var{class} is neither a class object nor a type object, a
Fred Drake53525371998-03-03 21:56:15 +0000383\exception{TypeError} exception is raised.
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000384\end{funcdesc}
385
386\begin{funcdesc}{issubclass}{class1, class2}
387Return true if \var{class1} is a subclass (direct or indirect) of
388\var{class2}. A class is considered a subclass of itself. If either
Fred Drake53525371998-03-03 21:56:15 +0000389argument is not a class object, a \exception{TypeError} exception is
390raised.
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000391\end{funcdesc}
392
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000393\begin{funcdesc}{len}{s}
394 Return the length (the number of items) of an object. The argument
395 may be a sequence (string, tuple or list) or a mapping (dictionary).
396\end{funcdesc}
397
Guido van Rossum921f32c1997-06-02 17:21:20 +0000398\begin{funcdesc}{list}{sequence}
Fred Drakeeacdec62001-05-02 20:19:19 +0000399 Return a list whose items are the same and in the same order as
400 \var{sequence}'s items. \var{sequence} may be either a sequence, a
401 container that supports iteration, or an iterator object. If
402 \var{sequence} is already a list, a copy is made and returned,
403 similar to \code{\var{sequence}[:]}. For instance,
404 \code{list('abc')} returns \code{['a', 'b', 'c']} and \code{list(
405 (1, 2, 3) )} returns \code{[1, 2, 3]}.
Guido van Rossum921f32c1997-06-02 17:21:20 +0000406\end{funcdesc}
407
Guido van Rossumfb502e91995-07-07 22:58:28 +0000408\begin{funcdesc}{locals}{}
409Return a dictionary representing the current local symbol table.
Fred Drakef96e0d22000-09-09 03:33:42 +0000410\strong{Warning:} The contents of this dictionary should not be
Guido van Rossum7b7f6681998-06-18 16:45:34 +0000411modified; changes may not affect the values of local variables used by
412the interpreter.
Guido van Rossumfb502e91995-07-07 22:58:28 +0000413\end{funcdesc}
414
Fred Drake17383b92000-11-17 19:44:14 +0000415\begin{funcdesc}{long}{x\optional{, radix}}
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000416 Convert a string or number to a long integer. If the argument is a
Fred Drake9c15fa72001-01-04 05:09:16 +0000417 string, it must contain a possibly signed number of
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000418 arbitrary size, possibly embedded in whitespace;
Fred Drake17383b92000-11-17 19:44:14 +0000419 this behaves identical to \code{string.atol(\var{x})}. The
420 \var{radix} argument is interpreted in the same way as for
421 \function{int()}, and may only be given when \var{x} is a string.
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000422 Otherwise, the argument may be a plain or
Guido van Rossumeb0f0661997-12-30 20:38:16 +0000423 long integer or a floating point number, and a long integer with
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000424 the same value is returned. Conversion of floating
425 point numbers to integers is defined by the C semantics;
Fred Drake53525371998-03-03 21:56:15 +0000426 see the description of \function{int()}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000427\end{funcdesc}
428
Fred Drakecce10901998-03-17 06:33:25 +0000429\begin{funcdesc}{map}{function, list, ...}
Fred Drake91f2f262001-07-06 19:28:48 +0000430 Apply \var{function} to every item of \var{list} and return a list
431 of the results. If additional \var{list} arguments are passed,
432 \var{function} must take that many arguments and is applied to the
433 items of all lists in parallel; if a list is shorter than another it
434 is assumed to be extended with \code{None} items. If \var{function}
435 is \code{None}, the identity function is assumed; if there are
436 multiple list arguments, \function{map()} returns a list consisting
437 of tuples containing the corresponding items from all lists (a kind
438 of transpose operation). The \var{list} arguments may be any kind
439 of sequence; the result is always a list.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000440\end{funcdesc}
441
Guido van Rossum5eabf381998-11-25 18:53:05 +0000442\begin{funcdesc}{max}{s\optional{, args...}}
Fred Drake91f2f262001-07-06 19:28:48 +0000443 With a single argument \var{s}, return the largest item of a
444 non-empty sequence (such as a string, tuple or list). With more
445 than one argument, return the largest of the arguments.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000446\end{funcdesc}
447
Guido van Rossum5eabf381998-11-25 18:53:05 +0000448\begin{funcdesc}{min}{s\optional{, args...}}
Fred Drake91f2f262001-07-06 19:28:48 +0000449 With a single argument \var{s}, return the smallest item of a
450 non-empty sequence (such as a string, tuple or list). With more
451 than one argument, return the smallest of the arguments.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000452\end{funcdesc}
453
454\begin{funcdesc}{oct}{x}
Guido van Rossum470be141995-03-17 16:07:09 +0000455 Convert an integer number (of any size) to an octal string. The
Fred Drake91f2f262001-07-06 19:28:48 +0000456 result is a valid Python expression. Note: this always yields an
457 unsigned literal. For example, on a 32-bit machine, \code{oct(-1)}
458 yields \code{'037777777777'}. When evaluated on a machine with the
459 same word size, this literal is evaluated as -1; at a different word
Guido van Rossum5cd75201997-01-14 18:44:23 +0000460 size, it may turn up as a large positive number or raise an
Fred Drake53525371998-03-03 21:56:15 +0000461 \exception{OverflowError} exception.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000462\end{funcdesc}
463
Fred Drakecce10901998-03-17 06:33:25 +0000464\begin{funcdesc}{open}{filename\optional{, mode\optional{, bufsize}}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000465 Return a new file object (described earlier under Built-in Types).
Guido van Rossum041be051994-05-03 14:46:50 +0000466 The first two arguments are the same as for \code{stdio}'s
Fred Drake53525371998-03-03 21:56:15 +0000467 \cfunction{fopen()}: \var{filename} is the file name to be opened,
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000468 \var{mode} indicates how the file is to be opened: \code{'r'} for
469 reading, \code{'w'} for writing (truncating an existing file), and
Fred Drakeaf8a0151998-01-14 14:51:31 +0000470 \code{'a'} opens it for appending (which on \emph{some} \UNIX{}
471 systems means that \emph{all} writes append to the end of the file,
Guido van Rossum59b328e1996-05-02 15:16:59 +0000472 regardless of the current seek position).
Guido van Rossum5fdd1191998-07-29 21:05:35 +0000473
474 Modes \code{'r+'}, \code{'w+'} and \code{'a+'} open the file for
475 updating (note that \code{'w+'} truncates the file). Append
476 \code{'b'} to the mode to open the file in binary mode, on systems
477 that differentiate between binary and text files (else it is
478 ignored). If the file cannot be opened, \exception{IOError} is
479 raised.
480
Fred Drake9aa85431999-04-05 21:22:41 +0000481 If \var{mode} is omitted, it defaults to \code{'r'}. When opening a
482 binary file, you should append \code{'b'} to the \var{mode} value
483 for improved portability. (It's useful even on systems which don't
484 treat binary and text files differently, where it serves as
Fred Draked3fbdfd1999-08-05 13:43:08 +0000485 documentation.)
486 \index{line-buffered I/O}\index{unbuffered I/O}\index{buffer size, I/O}
487 \index{I/O control!buffering}
488 The optional \var{bufsize} argument specifies the
Fred Drake9aa85431999-04-05 21:22:41 +0000489 file's desired buffer size: 0 means unbuffered, 1 means line
490 buffered, any other positive value means use a buffer of
491 (approximately) that size. A negative \var{bufsize} means to use
492 the system default, which is usually line buffered for for tty
493 devices and fully buffered for other files. If omitted, the system
494 default is used.\footnote{
495 Specifying a buffer size currently has no effect on systems that
496 don't have \cfunction{setvbuf()}. The interface to specify the
497 buffer size is not done using a method that calls
498 \cfunction{setvbuf()}, because that may dump core when called
499 after any I/O has been performed, and there's no reliable way to
500 determine whether this is the case.}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000501\end{funcdesc}
502
503\begin{funcdesc}{ord}{c}
Fred Drake33d51842000-04-06 14:43:12 +0000504 Return the \ASCII{} value of a string of one character or a Unicode
505 character. E.g., \code{ord('a')} returns the integer \code{97},
506 \code{ord(u'\\u2020')} returns \code{8224}. This is the inverse of
507 \function{chr()} for strings and of \function{unichr()} for Unicode
508 characters.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000509\end{funcdesc}
510
Fred Drakecce10901998-03-17 06:33:25 +0000511\begin{funcdesc}{pow}{x, y\optional{, z}}
Guido van Rossumb8b264b1994-08-12 13:13:50 +0000512 Return \var{x} to the power \var{y}; if \var{z} is present, return
513 \var{x} to the power \var{y}, modulo \var{z} (computed more
Guido van Rossumbf5a7742001-07-12 11:27:16 +0000514 efficiently than \code{pow(\var{x}, \var{y}) \%\ \var{z}}). The
515 arguments must have numeric types. With mixed operand types, the
516 coercion rules for binary arithmetic operators apply. For int and
517 long int operands, the result has the same type as the operands
518 (after coercion) unless the second argument is negative; in that
519 case, all arguments are converted to float and a float result is
520 delivered. For example, \code{10**2} returns \code{100}, but
521 \code{10**-2} returns \code{0.01}. (This last feature was added in
522 Python 2.2. In Python 2.1 and before, a negative second argument
523 would raise an exception.)
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000524\end{funcdesc}
525
Fred Drakecce10901998-03-17 06:33:25 +0000526\begin{funcdesc}{range}{\optional{start,} stop\optional{, step}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000527 This is a versatile function to create lists containing arithmetic
Fred Drake53525371998-03-03 21:56:15 +0000528 progressions. It is most often used in \keyword{for} loops. The
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000529 arguments must be plain integers. If the \var{step} argument is
530 omitted, it defaults to \code{1}. If the \var{start} argument is
531 omitted, it defaults to \code{0}. The full form returns a list of
532 plain integers \code{[\var{start}, \var{start} + \var{step},
533 \var{start} + 2 * \var{step}, \ldots]}. If \var{step} is positive,
534 the last element is the largest \code{\var{start} + \var{i} *
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000535 \var{step}} less than \var{stop}; if \var{step} is negative, the last
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000536 element is the largest \code{\var{start} + \var{i} * \var{step}}
Fred Drake6251c161998-04-03 07:15:54 +0000537 greater than \var{stop}. \var{step} must not be zero (or else
538 \exception{ValueError} is raised). Example:
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000539
Fred Drake19479911998-02-13 06:58:54 +0000540\begin{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000541>>> range(10)
542[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
543>>> range(1, 11)
544[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
545>>> range(0, 30, 5)
546[0, 5, 10, 15, 20, 25]
547>>> range(0, 10, 3)
548[0, 3, 6, 9]
549>>> range(0, -10, -1)
550[0, -1, -2, -3, -4, -5, -6, -7, -8, -9]
551>>> range(0)
552[]
553>>> range(1, 0)
554[]
Fred Drake19479911998-02-13 06:58:54 +0000555\end{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000556\end{funcdesc}
557
Guido van Rossum16d6e711994-08-08 12:30:22 +0000558\begin{funcdesc}{raw_input}{\optional{prompt}}
559 If the \var{prompt} argument is present, it is written to standard output
560 without a trailing newline. The function then reads a line from input,
561 converts it to a string (stripping a trailing newline), and returns that.
Fred Drake53525371998-03-03 21:56:15 +0000562 When \EOF{} is read, \exception{EOFError} is raised. Example:
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000563
Fred Drake19479911998-02-13 06:58:54 +0000564\begin{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000565>>> s = raw_input('--> ')
566--> Monty Python's Flying Circus
567>>> s
Guido van Rossum470be141995-03-17 16:07:09 +0000568"Monty Python's Flying Circus"
Fred Drake19479911998-02-13 06:58:54 +0000569\end{verbatim}
Guido van Rossum921f32c1997-06-02 17:21:20 +0000570
Fred Drake53525371998-03-03 21:56:15 +0000571If the \module{readline} module was loaded, then
572\function{raw_input()} will use it to provide elaborate
Guido van Rossum921f32c1997-06-02 17:21:20 +0000573line editing and history features.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000574\end{funcdesc}
575
Guido van Rossum87e611e1999-01-06 23:10:51 +0000576\begin{funcdesc}{reduce}{function, sequence\optional{, initializer}}
577Apply \var{function} of two arguments cumulatively to the items of
578\var{sequence}, from left to right, so as to reduce the sequence to
579a single value. For example,
580\code{reduce(lambda x, y: x+y, [1, 2, 3, 4, 5])} calculates
581\code{((((1+2)+3)+4)+5)}.
582If the optional \var{initializer} is present, it is placed before the
583items of the sequence in the calculation, and serves as a default when
584the sequence is empty.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000585\end{funcdesc}
586
587\begin{funcdesc}{reload}{module}
Guido van Rossum470be141995-03-17 16:07:09 +0000588Re-parse and re-initialize an already imported \var{module}. The
589argument must be a module object, so it must have been successfully
590imported before. This is useful if you have edited the module source
591file using an external editor and want to try out the new version
592without leaving the Python interpreter. The return value is the
Fred Drake91f2f262001-07-06 19:28:48 +0000593module object (the same as the \var{module} argument).
Guido van Rossum470be141995-03-17 16:07:09 +0000594
595There are a number of caveats:
596
597If a module is syntactically correct but its initialization fails, the
Fred Drake53525371998-03-03 21:56:15 +0000598first \keyword{import} statement for it does not bind its name locally,
Guido van Rossum470be141995-03-17 16:07:09 +0000599but does store a (partially initialized) module object in
600\code{sys.modules}. To reload the module you must first
Fred Drake53525371998-03-03 21:56:15 +0000601\keyword{import} it again (this will bind the name to the partially
602initialized module object) before you can \function{reload()} it.
Guido van Rossum470be141995-03-17 16:07:09 +0000603
604When a module is reloaded, its dictionary (containing the module's
605global variables) is retained. Redefinitions of names will override
606the old definitions, so this is generally not a problem. If the new
607version of a module does not define a name that was defined by the old
608version, the old definition remains. This feature can be used to the
609module's advantage if it maintains a global table or cache of objects
Fred Drake53525371998-03-03 21:56:15 +0000610--- with a \keyword{try} statement it can test for the table's presence
Guido van Rossum470be141995-03-17 16:07:09 +0000611and skip its initialization if desired.
612
613It is legal though generally not very useful to reload built-in or
Fred Drake53525371998-03-03 21:56:15 +0000614dynamically loaded modules, except for \module{sys}, \module{__main__}
Fred Drakef96e0d22000-09-09 03:33:42 +0000615and \module{__builtin__}. In many cases, however, extension
Fred Drake53525371998-03-03 21:56:15 +0000616modules are not designed to be initialized more than once, and may
617fail in arbitrary ways when reloaded.
Guido van Rossum470be141995-03-17 16:07:09 +0000618
Fred Drake53525371998-03-03 21:56:15 +0000619If a module imports objects from another module using \keyword{from}
620\ldots{} \keyword{import} \ldots{}, calling \function{reload()} for
621the other module does not redefine the objects imported from it ---
622one way around this is to re-execute the \keyword{from} statement,
623another is to use \keyword{import} and qualified names
624(\var{module}.\var{name}) instead.
Guido van Rossum470be141995-03-17 16:07:09 +0000625
626If a module instantiates instances of a class, reloading the module
627that defines the class does not affect the method definitions of the
628instances --- they continue to use the old class definition. The same
629is true for derived classes.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000630\end{funcdesc}
631
632\begin{funcdesc}{repr}{object}
633Return a string containing a printable representation of an object.
634This is the same value yielded by conversions (reverse quotes).
635It is sometimes useful to be able to access this operation as an
636ordinary function. For many types, this function makes an attempt
637to return a string that would yield an object with the same value
Fred Drake53525371998-03-03 21:56:15 +0000638when passed to \function{eval()}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000639\end{funcdesc}
640
Fred Drake607f8021998-08-24 20:30:07 +0000641\begin{funcdesc}{round}{x\optional{, n}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000642 Return the floating point value \var{x} rounded to \var{n} digits
643 after the decimal point. If \var{n} is omitted, it defaults to zero.
644 The result is a floating point number. Values are rounded to the
645 closest multiple of 10 to the power minus \var{n}; if two multiples
Fred Drake91f2f262001-07-06 19:28:48 +0000646 are equally close, rounding is done away from 0 (so. for example,
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000647 \code{round(0.5)} is \code{1.0} and \code{round(-0.5)} is \code{-1.0}).
648\end{funcdesc}
649
Fred Drakecce10901998-03-17 06:33:25 +0000650\begin{funcdesc}{setattr}{object, name, value}
Fred Drake53525371998-03-03 21:56:15 +0000651 This is the counterpart of \function{getattr()}. The arguments are an
Fred Drake607f8021998-08-24 20:30:07 +0000652 object, a string and an arbitrary value. The string may name an
653 existing attribute or a new attribute. The function assigns the
654 value to the attribute, provided the object allows it. For example,
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000655 \code{setattr(\var{x}, '\var{foobar}', 123)} is equivalent to
656 \code{\var{x}.\var{foobar} = 123}.
657\end{funcdesc}
658
Fred Drakecce10901998-03-17 06:33:25 +0000659\begin{funcdesc}{slice}{\optional{start,} stop\optional{, step}}
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000660Return a slice object representing the set of indices specified by
661\code{range(\var{start}, \var{stop}, \var{step})}. The \var{start}
662and \var{step} arguments default to None. Slice objects have
Fred Drake53525371998-03-03 21:56:15 +0000663read-only data attributes \member{start}, \member{stop} and \member{step}
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000664which merely return the argument values (or their default). They have
665no other explicit functionality; however they are used by Numerical
Fred Drake6251c161998-04-03 07:15:54 +0000666Python\index{Numerical Python} and other third party extensions.
667Slice objects are also generated when extended indexing syntax is
Fred Drake91f2f262001-07-06 19:28:48 +0000668used. For example: \samp{a[start:stop:step]} or \samp{a[start:stop, i]}.
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000669\end{funcdesc}
670
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000671\begin{funcdesc}{str}{object}
672Return a string containing a nicely printable representation of an
673object. For strings, this returns the string itself. The difference
Guido van Rossum6c4f0031995-03-07 10:14:09 +0000674with \code{repr(\var{object})} is that \code{str(\var{object})} does not
Fred Drake53525371998-03-03 21:56:15 +0000675always attempt to return a string that is acceptable to \function{eval()};
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000676its goal is to return a printable string.
677\end{funcdesc}
678
Guido van Rossum470be141995-03-17 16:07:09 +0000679\begin{funcdesc}{tuple}{sequence}
Guido van Rossumb8b264b1994-08-12 13:13:50 +0000680Return a tuple whose items are the same and in the same order as
Guido van Rossum921f32c1997-06-02 17:21:20 +0000681\var{sequence}'s items. If \var{sequence} is already a tuple, it
Guido van Rossumb8b264b1994-08-12 13:13:50 +0000682is returned unchanged. For instance, \code{tuple('abc')} returns
683returns \code{('a', 'b', 'c')} and \code{tuple([1, 2, 3])} returns
684\code{(1, 2, 3)}.
685\end{funcdesc}
686
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000687\begin{funcdesc}{type}{object}
Guido van Rossum470be141995-03-17 16:07:09 +0000688Return the type of an \var{object}. The return value is a type
Fred Drake53525371998-03-03 21:56:15 +0000689object. The standard module \module{types} defines names for all
Guido van Rossum470be141995-03-17 16:07:09 +0000690built-in types.
Fred Drakee14388c1997-12-15 22:28:38 +0000691\refstmodindex{types}
Guido van Rossum470be141995-03-17 16:07:09 +0000692\obindex{type}
693For instance:
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000694
Fred Drake19479911998-02-13 06:58:54 +0000695\begin{verbatim}
Guido van Rossum470be141995-03-17 16:07:09 +0000696>>> import types
Guido van Rossuma7874d11998-06-22 14:07:36 +0000697>>> if type(x) == types.StringType: print "It's a string"
Fred Drake19479911998-02-13 06:58:54 +0000698\end{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000699\end{funcdesc}
Guido van Rossum68cfbe71994-02-24 11:28:27 +0000700
Fred Drake33d51842000-04-06 14:43:12 +0000701\begin{funcdesc}{unichr}{i}
702Return the Unicode string of one character whose Unicode code is the
Fred Drake91f2f262001-07-06 19:28:48 +0000703integer \var{i}. For example, \code{unichr(97)} returns the string
Fred Drake33d51842000-04-06 14:43:12 +0000704\code{u'a'}. This is the inverse of \function{ord()} for Unicode
705strings. The argument must be in the range [0..65535], inclusive.
706\exception{ValueError} is raised otherwise.
Fred Drake30f76ff2000-06-30 16:06:19 +0000707\versionadded{2.0}
Fred Drake33d51842000-04-06 14:43:12 +0000708\end{funcdesc}
709
Fred Drakef96e0d22000-09-09 03:33:42 +0000710\begin{funcdesc}{unicode}{string\optional{, encoding\optional{, errors}}}
Fred Drakec0dac1a2001-05-15 15:27:53 +0000711Create a Unicode string from an 8-bit string \var{string} using the
712codec for \var{encoding}. The \var{encoding} parameter is a string
713giving the name of an encoding. Error handling is done according to
714\var{errors}; this specifies the treatment of characters which are
715invalid in the input encoding. If \var{errors} is \code{'strict'}
716(the default), a \exception{ValueError} is raised on errors, while a
717value of \code{'ignore'} causes errors to be silently ignored, and a
718value of \code{'replace'} causes the official Unicode replacement
719character, \code{U+FFFD}, to be used to replace input characters which
720cannot be decoded. The default behavior is to decode UTF-8 in strict
721mode, meaning that encoding errors raise \exception{ValueError}. See
722also the \refmodule{codecs} module.
Fred Drake30f76ff2000-06-30 16:06:19 +0000723\versionadded{2.0}
Fred Drake33d51842000-04-06 14:43:12 +0000724\end{funcdesc}
725
Guido van Rossum6bb1adc1995-03-13 10:03:32 +0000726\begin{funcdesc}{vars}{\optional{object}}
Guido van Rossum17383111994-04-21 10:32:28 +0000727Without arguments, return a dictionary corresponding to the current
728local symbol table. With a module, class or class instance object as
Fred Drake53525371998-03-03 21:56:15 +0000729argument (or anything else that has a \member{__dict__} attribute),
Guido van Rossum17383111994-04-21 10:32:28 +0000730returns a dictionary corresponding to the object's symbol table.
731The returned dictionary should not be modified: the effects on the
Fred Drake9aa85431999-04-05 21:22:41 +0000732corresponding symbol table are undefined.\footnote{
733 In the current implementation, local variable bindings cannot
734 normally be affected this way, but variables retrieved from
Fred Drake91f2f262001-07-06 19:28:48 +0000735 other scopes (such as modules) can be. This may change.}
Guido van Rossum17383111994-04-21 10:32:28 +0000736\end{funcdesc}
737
Fred Drakecce10901998-03-17 06:33:25 +0000738\begin{funcdesc}{xrange}{\optional{start,} stop\optional{, step}}
Fred Drake53525371998-03-03 21:56:15 +0000739This function is very similar to \function{range()}, but returns an
Guido van Rossum68cfbe71994-02-24 11:28:27 +0000740``xrange object'' instead of a list. This is an opaque sequence type
741which yields the same values as the corresponding list, without
742actually storing them all simultaneously. The advantage of
Fred Drake53525371998-03-03 21:56:15 +0000743\function{xrange()} over \function{range()} is minimal (since
744\function{xrange()} still has to create the values when asked for
745them) except when a very large range is used on a memory-starved
Fred Drake91f2f262001-07-06 19:28:48 +0000746machine or when all of the range's elements are never used (such as
747when the loop is usually terminated with \keyword{break}).
Guido van Rossum68cfbe71994-02-24 11:28:27 +0000748\end{funcdesc}
Barry Warsawfaefa2a2000-08-03 15:46:17 +0000749
Fred Drake8b168ba2000-08-03 17:29:13 +0000750\begin{funcdesc}{zip}{seq1, \moreargs}
Barry Warsawfaefa2a2000-08-03 15:46:17 +0000751This function returns a list of tuples, where each tuple contains the
Fred Drake8b168ba2000-08-03 17:29:13 +0000752\var{i}-th element from each of the argument sequences. At least one
Barry Warsawfaefa2a2000-08-03 15:46:17 +0000753sequence is required, otherwise a \exception{TypeError} is raised.
754The returned list is truncated in length to the length of the shortest
Fred Drakef96e0d22000-09-09 03:33:42 +0000755argument sequence. When there are multiple argument sequences which
756are all of the same length, \function{zip()} is similar to
757\function{map()} with an initial argument of \code{None}. With a
758single sequence argument, it returns a list of 1-tuples.
Fred Drakee581bb32000-08-17 22:30:30 +0000759\versionadded{2.0}
Fred Drake8b168ba2000-08-03 17:29:13 +0000760\end{funcdesc}