blob: 1ea8c10a746e7e37bcb4bb151118f7033c57a375 [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 Drakee0063d22001-10-09 19:31:08 +000010 This function is invoked by the \keyword{import}\stindex{import}
11 statement. It mainly exists so that you can replace it with another
12 function that has a compatible interface, in order to change the
13 semantics of the \keyword{import} statement. For examples of why
14 and how you would do this, see the standard library modules
15 \module{ihooks}\refstmodindex{ihooks} and
16 \refmodule{rexec}\refstmodindex{rexec}. See also the built-in
17 module \refmodule{imp}\refbimodindex{imp}, which defines some useful
18 operations out of which you can build your own
19 \function{__import__()} function.
Guido van Rossum7974b0f1997-10-05 18:53:00 +000020
Fred Drakee0063d22001-10-09 19:31:08 +000021 For example, the statement \samp{import spam} results in the
22 following call: \code{__import__('spam',} \code{globals(),}
23 \code{locals(), [])}; the statement \samp{from spam.ham import eggs}
24 results in \samp{__import__('spam.ham', globals(), locals(),
25 ['eggs'])}. Note that even though \code{locals()} and
26 \code{['eggs']} are passed in as arguments, the
27 \function{__import__()} function does not set the local variable
28 named \code{eggs}; this is done by subsequent code that is generated
29 for the import statement. (In fact, the standard implementation
30 does not use its \var{locals} argument at all, and uses its
31 \var{globals} only to determine the package context of the
32 \keyword{import} statement.)
Guido van Rossum7974b0f1997-10-05 18:53:00 +000033
Fred Drakee0063d22001-10-09 19:31:08 +000034 When the \var{name} variable is of the form \code{package.module},
35 normally, the top-level package (the name up till the first dot) is
36 returned, \emph{not} the module named by \var{name}. However, when
37 a non-empty \var{fromlist} argument is given, the module named by
38 \var{name} is returned. This is done for compatibility with the
39 bytecode generated for the different kinds of import statement; when
40 using \samp{import spam.ham.eggs}, the top-level package \code{spam}
41 must be placed in the importing namespace, but when using \samp{from
42 spam.ham import eggs}, the \code{spam.ham} subpackage must be used
43 to find the \code{eggs} variable. As a workaround for this
44 behavior, use \function{getattr()} to extract the desired
45 components. For example, you could define the following helper:
Guido van Rossum8c2da611998-12-04 15:32:17 +000046
47\begin{verbatim}
48import string
49
50def my_import(name):
51 mod = __import__(name)
52 components = string.split(name, '.')
53 for comp in components[1:]:
54 mod = getattr(mod, comp)
55 return mod
56\end{verbatim}
Guido van Rossum7974b0f1997-10-05 18:53:00 +000057\end{funcdesc}
58
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000059\begin{funcdesc}{abs}{x}
60 Return the absolute value of a number. The argument may be a plain
Guido van Rossum921f32c1997-06-02 17:21:20 +000061 or long integer or a floating point number. If the argument is a
Guido van Rossum7974b0f1997-10-05 18:53:00 +000062 complex number, its magnitude is returned.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000063\end{funcdesc}
64
Fred Drakecce10901998-03-17 06:33:25 +000065\begin{funcdesc}{apply}{function, args\optional{, keywords}}
Fred Drakee0063d22001-10-09 19:31:08 +000066 The \var{function} argument must be a callable object (a
67 user-defined or built-in function or method, or a class object) and
68 the \var{args} argument must be a sequence (if it is not a tuple,
69 the sequence is first converted to a tuple). The \var{function} is
70 called with \var{args} as the argument list; the number of arguments
71 is the the length of the tuple. (This is different from just
72 calling \code{\var{func}(\var{args})}, since in that case there is
73 always exactly one argument.)
74 If the optional \var{keywords} argument is present, it must be a
75 dictionary whose keys are strings. It specifies keyword arguments
76 to be added to the end of the the argument list.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000077\end{funcdesc}
78
Guido van Rossum8be22961999-03-19 19:10:14 +000079\begin{funcdesc}{buffer}{object\optional{, offset\optional{, size}}}
Fred Drakee0063d22001-10-09 19:31:08 +000080 The \var{object} argument must be an object that supports the buffer
81 call interface (such as strings, arrays, and buffers). A new buffer
82 object will be created which references the \var{object} argument.
83 The buffer object will be a slice from the beginning of \var{object}
84 (or from the specified \var{offset}). The slice will extend to the
85 end of \var{object} (or will have a length given by the \var{size}
86 argument).
Guido van Rossum8be22961999-03-19 19:10:14 +000087\end{funcdesc}
88
Guido van Rossum7974b0f1997-10-05 18:53:00 +000089\begin{funcdesc}{callable}{object}
Fred Drakee0063d22001-10-09 19:31:08 +000090 Return true if the \var{object} argument appears callable, false if
91 not. If this returns true, it is still possible that a call fails,
92 but if it is false, calling \var{object} will never succeed. Note
93 that classes are callable (calling a class returns a new instance);
94 class instances are callable if they have a \method{__call__()}
95 method.
Guido van Rossum7974b0f1997-10-05 18:53:00 +000096\end{funcdesc}
97
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000098\begin{funcdesc}{chr}{i}
99 Return a string of one character whose \ASCII{} code is the integer
Fred Drake91f2f262001-07-06 19:28:48 +0000100 \var{i}. For example, \code{chr(97)} returns the string \code{'a'}.
101 This is the inverse of \function{ord()}. The argument must be in
102 the range [0..255], inclusive; \exception{ValueError} will be raised
103 if \var{i} is outside that range.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000104\end{funcdesc}
105
Fred Drakecce10901998-03-17 06:33:25 +0000106\begin{funcdesc}{cmp}{x, y}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000107 Compare the two objects \var{x} and \var{y} and return an integer
108 according to the outcome. The return value is negative if \code{\var{x}
109 < \var{y}}, zero if \code{\var{x} == \var{y}} and strictly positive if
110 \code{\var{x} > \var{y}}.
111\end{funcdesc}
112
Fred Drakecce10901998-03-17 06:33:25 +0000113\begin{funcdesc}{coerce}{x, y}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000114 Return a tuple consisting of the two numeric arguments converted to
115 a common type, using the same rules as used by arithmetic
116 operations.
117\end{funcdesc}
118
Tim Peters32f453e2001-09-03 08:35:41 +0000119\begin{funcdesc}{compile}{string, filename, kind\optional{,
Michael W. Hudson53da3172001-08-27 20:02:17 +0000120 flags\optional{, dont_inherit}}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000121 Compile the \var{string} into a code object. Code objects can be
Fred Drake53525371998-03-03 21:56:15 +0000122 executed by an \keyword{exec} statement or evaluated by a call to
123 \function{eval()}. The \var{filename} argument should
Guido van Rossum0d682462001-09-29 14:28:52 +0000124 give the file from which the code was read; pass some recognizable value
Fred Drake91f2f262001-07-06 19:28:48 +0000125 if it wasn't read from a file (\code{'<string>'} is commonly used).
126 The \var{kind} argument specifies what kind of code must be
127 compiled; it can be \code{'exec'} if \var{string} consists of a
128 sequence of statements, \code{'eval'} if it consists of a single
129 expression, or \code{'single'} if it consists of a single
130 interactive statement (in the latter case, expression statements
131 that evaluate to something else than \code{None} will printed).
Michael W. Hudson53da3172001-08-27 20:02:17 +0000132
Guido van Rossum0d682462001-09-29 14:28:52 +0000133 When compiling multi-line statements, two caveats apply: line
134 endings must be represented by a single newline character
135 (\code{'\e n'}), and the input must be terminated by at least one
136 newline character. If line endings are represented by
137 \code{'\e r\e n'}, use the string \method{replace()} method to
138 change them into \code{'\e n'}.
139
140 The optional arguments \var{flags} and \var{dont_inherit}
Michael W. Hudson53da3172001-08-27 20:02:17 +0000141 (which are new in Python 2.2) control which future statements (see
142 \pep{236}) affect the compilation of \var{string}. If neither is
143 present (or both are zero) the code is compiled with those future
144 statements that are in effect in the code that is calling compile.
145 If the \var{flags} argument is given and \var{dont_inherit} is not
146 (or is zero) then the future statements specified by the \var{flags}
147 argument are used in addition to those that would be used anyway.
148 If \var{dont_inherit} is a non-zero integer then the \var{flags}
149 argument is it -- the future statements in effect around the call to
150 compile are ignored.
151
152 Future statemants are specified by bits which can be bitwise or-ed
153 together to specify multiple statements. The bitfield required to
154 specify a given feature can be found as the \member{compiler_flag}
155 attribute on the \class{_Feature} instance in the
156 \module{__future__} module.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000157\end{funcdesc}
158
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000159\begin{funcdesc}{complex}{real\optional{, imag}}
Guido van Rossumcb1f2421999-03-25 21:23:26 +0000160 Create a complex number with the value \var{real} + \var{imag}*j or
161 convert a string or number to a complex number.
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000162 Each argument may be any numeric type (including complex).
163 If \var{imag} is omitted, it defaults to zero and the function
Fred Drake53525371998-03-03 21:56:15 +0000164 serves as a numeric conversion function like \function{int()},
Guido van Rossumcb1f2421999-03-25 21:23:26 +0000165 \function{long()} and \function{float()}; in this case it also
166 accepts a string argument which should be a valid complex number.
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000167\end{funcdesc}
168
Fred Drakecce10901998-03-17 06:33:25 +0000169\begin{funcdesc}{delattr}{object, name}
Fred Drake53525371998-03-03 21:56:15 +0000170 This is a relative of \function{setattr()}. The arguments are an
Guido van Rossum1efbb0f1994-08-16 22:15:11 +0000171 object and a string. The string must be the name
172 of one of the object's attributes. The function deletes
173 the named attribute, provided the object allows it. For example,
Guido van Rossum6c4f0031995-03-07 10:14:09 +0000174 \code{delattr(\var{x}, '\var{foobar}')} is equivalent to
Guido van Rossum1efbb0f1994-08-16 22:15:11 +0000175 \code{del \var{x}.\var{foobar}}.
176\end{funcdesc}
177
Tim Petersa427a2b2001-10-29 22:25:45 +0000178\begin{funcdesc}{dict}{\optional{mapping-or-sequence}}
Tim Peters1fc240e2001-10-26 05:06:50 +0000179 Return a new dictionary initialized from the optional argument.
180 If an argument is not specified, return a new empty dictionary.
181 If the argument is a mapping object, return a dictionary mapping the
182 same keys to the same values as does the mapping object.
183 Else the argument must be a sequence, a container that supports
184 iteration, or an iterator object. The elements of the argument must
185 each also be of one of those kinds, and each must in turn contain
186 exactly two objects. The first is used as a key in the new dictionary,
187 and the second as the key's value. If a given key is seen more than
188 once, the last value associated with it is retained in the new
189 dictionary.
190 For example, these all return a dictionary equal to
191 \code{\{1: 2, 2: 3\}}:
Fred Drakeef7d08a2001-10-26 15:04:33 +0000192
193 \begin{itemize}
Tim Petersa427a2b2001-10-29 22:25:45 +0000194 \item \code{dict(\{1: 2, 2: 3\})}
195 \item \code{dict(\{1: 2, 2: 3\}.items())}
196 \item \code{dict(\{1: 2, 2: 3\}.iteritems())}
197 \item \code{dict(zip((1, 2), (2, 3)))}
198 \item \code{dict([[2, 3], [1, 2]])}
199 \item \code{dict([(i-1, i) for i in (2, 3)])}
Fred Drakeef7d08a2001-10-26 15:04:33 +0000200 \end{itemize}
Tim Peters1fc240e2001-10-26 05:06:50 +0000201\end{funcdesc}
202
Fred Drake6b303b41998-04-16 22:10:27 +0000203\begin{funcdesc}{dir}{\optional{object}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000204 Without arguments, return the list of names in the current local
Guido van Rossumeb0f0661997-12-30 20:38:16 +0000205 symbol table. With an argument, attempts to return a list of valid
206 attribute for that object. This information is gleaned from the
Fred Drake53525371998-03-03 21:56:15 +0000207 object's \member{__dict__}, \member{__methods__} and \member{__members__}
Fred Drake91f2f262001-07-06 19:28:48 +0000208 attributes, if defined. The list is not necessarily complete. For
209 example, for classes, attributes defined in base classes are not
210 included, and for class instances, methods are not included.
Guido van Rossumeb0f0661997-12-30 20:38:16 +0000211 The resulting list is sorted alphabetically. For example:
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000212
Fred Drake19479911998-02-13 06:58:54 +0000213\begin{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000214>>> import sys
215>>> dir()
216['sys']
217>>> dir(sys)
218['argv', 'exit', 'modules', 'path', 'stderr', 'stdin', 'stdout']
Fred Drake19479911998-02-13 06:58:54 +0000219\end{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000220\end{funcdesc}
221
Fred Drakecce10901998-03-17 06:33:25 +0000222\begin{funcdesc}{divmod}{a, b}
Guido van Rossumeb0f0661997-12-30 20:38:16 +0000223 Take two numbers as arguments and return a pair of numbers consisting
224 of their quotient and remainder when using long division. With mixed
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000225 operand types, the rules for binary arithmetic operators apply. For
226 plain and long integers, the result is the same as
227 \code{(\var{a} / \var{b}, \var{a} \%{} \var{b})}.
Fred Drake1ea7c751999-05-06 14:46:35 +0000228 For floating point numbers the result is \code{(\var{q}, \var{a} \%{}
229 \var{b})}, where \var{q} is usually \code{math.floor(\var{a} /
230 \var{b})} but may be 1 less than that. In any case \code{\var{q} *
231 \var{b} + \var{a} \%{} \var{b}} is very close to \var{a}, if
232 \code{\var{a} \%{} \var{b}} is non-zero it has the same sign as
233 \var{b}, and \code{0 <= abs(\var{a} \%{} \var{b}) < abs(\var{b})}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000234\end{funcdesc}
235
Fred Drakecce10901998-03-17 06:33:25 +0000236\begin{funcdesc}{eval}{expression\optional{, globals\optional{, locals}}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000237 The arguments are a string and two optional dictionaries. The
Guido van Rossumf8601621995-01-10 10:50:24 +0000238 \var{expression} argument is parsed and evaluated as a Python
239 expression (technically speaking, a condition list) using the
240 \var{globals} and \var{locals} dictionaries as global and local name
Guido van Rossum470be141995-03-17 16:07:09 +0000241 space. If the \var{locals} dictionary is omitted it defaults to
242 the \var{globals} dictionary. If both dictionaries are omitted, the
Fred Drake53525371998-03-03 21:56:15 +0000243 expression is executed in the environment where \keyword{eval} is
Guido van Rossumf8601621995-01-10 10:50:24 +0000244 called. The return value is the result of the evaluated expression.
245 Syntax errors are reported as exceptions. Example:
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000246
Fred Drake19479911998-02-13 06:58:54 +0000247\begin{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000248>>> x = 1
249>>> print eval('x+1')
2502
Fred Drake19479911998-02-13 06:58:54 +0000251\end{verbatim}
Fred Drake53525371998-03-03 21:56:15 +0000252
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000253 This function can also be used to execute arbitrary code objects
Fred Drake91f2f262001-07-06 19:28:48 +0000254 (such as those created by \function{compile()}). In this case pass
255 a code object instead of a string. The code object must have been
256 compiled passing \code{'eval'} as the \var{kind} argument.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000257
Guido van Rossum6c4f0031995-03-07 10:14:09 +0000258 Hints: dynamic execution of statements is supported by the
Fred Drake53525371998-03-03 21:56:15 +0000259 \keyword{exec} statement. Execution of statements from a file is
260 supported by the \function{execfile()} function. The
261 \function{globals()} and \function{locals()} functions returns the
262 current global and local dictionary, respectively, which may be
263 useful to pass around for use by \function{eval()} or
264 \function{execfile()}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000265\end{funcdesc}
266
Fred Drakecce10901998-03-17 06:33:25 +0000267\begin{funcdesc}{execfile}{file\optional{, globals\optional{, locals}}}
Guido van Rossum470be141995-03-17 16:07:09 +0000268 This function is similar to the
Fred Drake53525371998-03-03 21:56:15 +0000269 \keyword{exec} statement, but parses a file instead of a string. It
270 is different from the \keyword{import} statement in that it does not
271 use the module administration --- it reads the file unconditionally
272 and does not create a new module.\footnote{It is used relatively
273 rarely so does not warrant being made into a statement.}
Guido van Rossumf8601621995-01-10 10:50:24 +0000274
275 The arguments are a file name and two optional dictionaries. The
276 file is parsed and evaluated as a sequence of Python statements
277 (similarly to a module) using the \var{globals} and \var{locals}
Fred Drake13494372000-09-12 16:23:48 +0000278 dictionaries as global and local namespace. If the \var{locals}
Guido van Rossum470be141995-03-17 16:07:09 +0000279 dictionary is omitted it defaults to the \var{globals} dictionary.
Guido van Rossumf8601621995-01-10 10:50:24 +0000280 If both dictionaries are omitted, the expression is executed in the
Fred Drake53525371998-03-03 21:56:15 +0000281 environment where \function{execfile()} is called. The return value is
Guido van Rossum470be141995-03-17 16:07:09 +0000282 \code{None}.
Tim Petersaf5910f2001-09-30 06:32:59 +0000283
Fred Drakee0063d22001-10-09 19:31:08 +0000284 \warning{The default \var{locals} act as described for function
Tim Petersaf5910f2001-09-30 06:32:59 +0000285 \function{locals()} below: modifications to the default \var{locals}
286 dictionary should not be attempted. Pass an explicit \var{locals}
287 dictionary if you need to see effects of the code on \var{locals} after
288 function \function{execfile()} returns. \function{execfile()} cannot
Fred Drakee0063d22001-10-09 19:31:08 +0000289 be used reliably to modify a function's locals.}
Guido van Rossumf8601621995-01-10 10:50:24 +0000290\end{funcdesc}
291
Tim Peters2e29bfb2001-09-20 19:55:29 +0000292\begin{funcdesc}{file}{filename\optional{, mode\optional{, bufsize}}}
293 Return a new file object (described earlier under Built-in Types).
294 The first two arguments are the same as for \code{stdio}'s
295 \cfunction{fopen()}: \var{filename} is the file name to be opened,
296 \var{mode} indicates how the file is to be opened: \code{'r'} for
297 reading, \code{'w'} for writing (truncating an existing file), and
298 \code{'a'} opens it for appending (which on \emph{some} \UNIX{}
299 systems means that \emph{all} writes append to the end of the file,
300 regardless of the current seek position).
301
302 Modes \code{'r+'}, \code{'w+'} and \code{'a+'} open the file for
303 updating (note that \code{'w+'} truncates the file). Append
304 \code{'b'} to the mode to open the file in binary mode, on systems
305 that differentiate between binary and text files (else it is
306 ignored). If the file cannot be opened, \exception{IOError} is
307 raised.
308
309 If \var{mode} is omitted, it defaults to \code{'r'}. When opening a
310 binary file, you should append \code{'b'} to the \var{mode} value
311 for improved portability. (It's useful even on systems which don't
312 treat binary and text files differently, where it serves as
313 documentation.)
314 \index{line-buffered I/O}\index{unbuffered I/O}\index{buffer size, I/O}
315 \index{I/O control!buffering}
316 The optional \var{bufsize} argument specifies the
317 file's desired buffer size: 0 means unbuffered, 1 means line
318 buffered, any other positive value means use a buffer of
319 (approximately) that size. A negative \var{bufsize} means to use
320 the system default, which is usually line buffered for for tty
321 devices and fully buffered for other files. If omitted, the system
322 default is used.\footnote{
323 Specifying a buffer size currently has no effect on systems that
324 don't have \cfunction{setvbuf()}. The interface to specify the
325 buffer size is not done using a method that calls
326 \cfunction{setvbuf()}, because that may dump core when called
327 after any I/O has been performed, and there's no reliable way to
328 determine whether this is the case.}
329
330 The \function{file()} constructor is new in Python 2.2. The previous
331 spelling, \function{open()}, is retained for compatibility, and is an
332 alias for \function{file()}.
333\end{funcdesc}
334
Fred Drakecce10901998-03-17 06:33:25 +0000335\begin{funcdesc}{filter}{function, list}
Fred Drakeeacdec62001-05-02 20:19:19 +0000336 Construct a list from those elements of \var{list} for which
337 \var{function} returns true. \var{list} may be either a sequence, a
338 container which supports iteration, or an iterator, If \var{list}
339 is a string or a tuple, the result also has that type; otherwise it
340 is always a list. If \var{function} is \code{None}, the identity
Fred Drake91f2f262001-07-06 19:28:48 +0000341 function is assumed, that is, all elements of \var{list} that are false
Fred Drakeeacdec62001-05-02 20:19:19 +0000342 (zero or empty) are removed.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000343\end{funcdesc}
344
345\begin{funcdesc}{float}{x}
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000346 Convert a string or a number to floating point. If the argument is a
Fred Draked83675f1998-12-07 17:13:18 +0000347 string, it must contain a possibly signed decimal or floating point
Fred Drake70a66c91999-02-18 16:08:36 +0000348 number, possibly embedded in whitespace; this behaves identical to
349 \code{string.atof(\var{x})}. Otherwise, the argument may be a plain
350 or long integer or a floating point number, and a floating point
351 number with the same value (within Python's floating point
352 precision) is returned.
353
Fred Drakee0063d22001-10-09 19:31:08 +0000354 \note{When passing in a string, values for NaN\index{NaN}
Fred Drake70a66c91999-02-18 16:08:36 +0000355 and Infinity\index{Infinity} may be returned, depending on the
356 underlying C library. The specific set of strings accepted which
357 cause these values to be returned depends entirely on the C library
Fred Drakee0063d22001-10-09 19:31:08 +0000358 and is known to vary.}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000359\end{funcdesc}
360
Fred Drakede5d5ce1999-07-22 19:21:45 +0000361\begin{funcdesc}{getattr}{object, name\optional{, default}}
362 Return the value of the named attributed of \var{object}. \var{name}
363 must be a string. If the string is the name of one of the object's
364 attributes, the result is the value of that attribute. For example,
365 \code{getattr(x, 'foobar')} is equivalent to \code{x.foobar}. If the
366 named attribute does not exist, \var{default} is returned if provided,
367 otherwise \exception{AttributeError} is raised.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000368\end{funcdesc}
369
Guido van Rossumfb502e91995-07-07 22:58:28 +0000370\begin{funcdesc}{globals}{}
Fred Drakee0063d22001-10-09 19:31:08 +0000371 Return a dictionary representing the current global symbol table.
372 This is always the dictionary of the current module (inside a
373 function or method, this is the module where it is defined, not the
374 module from which it is called).
Guido van Rossumfb502e91995-07-07 22:58:28 +0000375\end{funcdesc}
376
Fred Drakecce10901998-03-17 06:33:25 +0000377\begin{funcdesc}{hasattr}{object, name}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000378 The arguments are an object and a string. The result is 1 if the
379 string is the name of one of the object's attributes, 0 if not.
Fred Drake53525371998-03-03 21:56:15 +0000380 (This is implemented by calling \code{getattr(\var{object},
381 \var{name})} and seeing whether it raises an exception or not.)
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000382\end{funcdesc}
383
384\begin{funcdesc}{hash}{object}
385 Return the hash value of the object (if it has one). Hash values
Guido van Rossumeb0f0661997-12-30 20:38:16 +0000386 are integers. They are used to quickly compare dictionary
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000387 keys during a dictionary lookup. Numeric values that compare equal
Fred Drake91f2f262001-07-06 19:28:48 +0000388 have the same hash value (even if they are of different types, as is
389 the case for 1 and 1.0).
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000390\end{funcdesc}
391
392\begin{funcdesc}{hex}{x}
Guido van Rossum470be141995-03-17 16:07:09 +0000393 Convert an integer number (of any size) to a hexadecimal string.
Guido van Rossum5cd75201997-01-14 18:44:23 +0000394 The result is a valid Python expression. Note: this always yields
Fred Drake91f2f262001-07-06 19:28:48 +0000395 an unsigned literal. For example, on a 32-bit machine,
396 \code{hex(-1)} yields \code{'0xffffffff'}. When evaluated on a
397 machine with the same word size, this literal is evaluated as -1; at
398 a different word size, it may turn up as a large positive number or
399 raise an \exception{OverflowError} exception.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000400\end{funcdesc}
401
402\begin{funcdesc}{id}{object}
Fred Drake8aa3bd92000-06-29 03:46:46 +0000403 Return the `identity' of an object. This is an integer (or long
404 integer) which is guaranteed to be unique and constant for this
405 object during its lifetime. Two objects whose lifetimes are
406 disjunct may have the same \function{id()} value. (Implementation
407 note: this is the address of the object.)
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000408\end{funcdesc}
409
Guido van Rossum16d6e711994-08-08 12:30:22 +0000410\begin{funcdesc}{input}{\optional{prompt}}
Guido van Rossum777dcc61998-06-17 15:16:40 +0000411 Equivalent to \code{eval(raw_input(\var{prompt}))}.
Fred Drakee0063d22001-10-09 19:31:08 +0000412 \warning{This function is not safe from user errors! It
Fred Drakef96e0d22000-09-09 03:33:42 +0000413 expects a valid Python expression as input; if the input is not
414 syntactically valid, a \exception{SyntaxError} will be raised.
415 Other exceptions may be raised if there is an error during
416 evaluation. (On the other hand, sometimes this is exactly what you
Fred Drakee0063d22001-10-09 19:31:08 +0000417 need when writing a quick script for expert use.)}
Fred Drakef96e0d22000-09-09 03:33:42 +0000418
Fred Drakee0063d22001-10-09 19:31:08 +0000419 If the \refmodule{readline} module was loaded, then
Fred Drakef96e0d22000-09-09 03:33:42 +0000420 \function{input()} will use it to provide elaborate line editing and
421 history features.
422
423 Consider using the \function{raw_input()} function for general input
424 from users.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000425\end{funcdesc}
426
Fred Drake1e862e82000-02-17 17:45:52 +0000427\begin{funcdesc}{int}{x\optional{, radix}}
428 Convert a string or number to a plain integer. If the argument is a
429 string, it must contain a possibly signed decimal number
430 representable as a Python integer, possibly embedded in whitespace;
431 this behaves identical to \code{string.atoi(\var{x}\optional{,
432 \var{radix}})}. The \var{radix} parameter gives the base for the
Fred Drake17383b92000-11-17 19:44:14 +0000433 conversion and may be any integer in the range [2, 36], or zero. If
434 \var{radix} is zero, the proper radix is guessed based on the
435 contents of string; the interpretation is the same as for integer
436 literals. If \var{radix} is specified and \var{x} is not a string,
Fred Drake1e862e82000-02-17 17:45:52 +0000437 \exception{TypeError} is raised.
438 Otherwise, the argument may be a plain or
439 long integer or a floating point number. Conversion of floating
Tim Peters7321ec42001-07-26 20:02:17 +0000440 point numbers to integers truncates (towards zero).
Fred Drake1e862e82000-02-17 17:45:52 +0000441\end{funcdesc}
442
Guido van Rossum3978d751997-03-03 16:03:27 +0000443\begin{funcdesc}{intern}{string}
444 Enter \var{string} in the table of ``interned'' strings and return
445 the interned string -- which is \var{string} itself or a copy.
446 Interning strings is useful to gain a little performance on
447 dictionary lookup -- if the keys in a dictionary are interned, and
448 the lookup key is interned, the key comparisons (after hashing) can
449 be done by a pointer compare instead of a string compare. Normally,
450 the names used in Python programs are automatically interned, and
451 the dictionaries used to hold module, class or instance attributes
Fred Drake91f2f262001-07-06 19:28:48 +0000452 have interned keys. Interned strings are immortal (never get
Guido van Rossum3978d751997-03-03 16:03:27 +0000453 garbage collected).
454\end{funcdesc}
455
Fred Drakee0063d22001-10-09 19:31:08 +0000456\begin{funcdesc}{isinstance}{object, classinfo}
457 Return true if the \var{object} argument is an instance of the
458 \var{classinfo} argument, or of a (direct or indirect) subclass
459 thereof. Also return true if \var{classinfo} is a type object and
460 \var{object} is an object of that type. If \var{object} is not a
461 class instance or a object of the given type, the function always
462 returns false. If \var{classinfo} is neither a class object nor a
463 type object, it may be a tuple of class or type objects, or may
464 recursively contain other such tuples (other sequence types are not
465 accepted). If \var{classinfo} is not a class, type, or tuple of
466 classes, types, and such tuples, a \exception{TypeError} exception
467 is raised.
468 \versionchanged[Support for a tuple of type information was added]{2.2}
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000469\end{funcdesc}
470
471\begin{funcdesc}{issubclass}{class1, class2}
Fred Drakee0063d22001-10-09 19:31:08 +0000472 Return true if \var{class1} is a subclass (direct or indirect) of
473 \var{class2}. A class is considered a subclass of itself. If
474 either argument is not a class object, a \exception{TypeError}
475 exception is raised.
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000476\end{funcdesc}
477
Fred Drake00bb3292001-09-06 19:04:29 +0000478\begin{funcdesc}{iter}{o\optional{, sentinel}}
479 Return an iterator object. The first argument is interpreted very
480 differently depending on the presence of the second argument.
481 Without a second argument, \var{o} must be a collection object which
482 supports the iteration protocol (the \method{__iter__()} method), or
483 it must support the sequence protocol (the \method{__getitem__()}
484 method with integer arguments starting at \code{0}). If it does not
485 support either of those protocols, \exception{TypeError} is raised.
486 If the second argument, \var{sentinel}, is given, then \var{o} must
487 be a callable object. The iterator created in this case will call
488 \var{o} with no arguments for each call to its \method{next()}
489 method; if the value returned is equal to \var{sentinel},
490 \exception{StopIteration} will be raised, otherwise the value will
491 be returned.
492 \versionadded{2.2}
493\end{funcdesc}
494
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000495\begin{funcdesc}{len}{s}
496 Return the length (the number of items) of an object. The argument
497 may be a sequence (string, tuple or list) or a mapping (dictionary).
498\end{funcdesc}
499
Tim Peters1fc240e2001-10-26 05:06:50 +0000500\begin{funcdesc}{list}{\optional{sequence}}
Fred Drakeeacdec62001-05-02 20:19:19 +0000501 Return a list whose items are the same and in the same order as
502 \var{sequence}'s items. \var{sequence} may be either a sequence, a
503 container that supports iteration, or an iterator object. If
504 \var{sequence} is already a list, a copy is made and returned,
505 similar to \code{\var{sequence}[:]}. For instance,
506 \code{list('abc')} returns \code{['a', 'b', 'c']} and \code{list(
507 (1, 2, 3) )} returns \code{[1, 2, 3]}.
Guido van Rossum921f32c1997-06-02 17:21:20 +0000508\end{funcdesc}
509
Guido van Rossumfb502e91995-07-07 22:58:28 +0000510\begin{funcdesc}{locals}{}
Fred Drakee0063d22001-10-09 19:31:08 +0000511 Return a dictionary representing the current local symbol table.
512 \warning{The contents of this dictionary should not be modified;
513 changes may not affect the values of local variables used by the
514 interpreter.}
Guido van Rossumfb502e91995-07-07 22:58:28 +0000515\end{funcdesc}
516
Fred Drake17383b92000-11-17 19:44:14 +0000517\begin{funcdesc}{long}{x\optional{, radix}}
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000518 Convert a string or number to a long integer. If the argument is a
Fred Drake9c15fa72001-01-04 05:09:16 +0000519 string, it must contain a possibly signed number of
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000520 arbitrary size, possibly embedded in whitespace;
Fred Drake17383b92000-11-17 19:44:14 +0000521 this behaves identical to \code{string.atol(\var{x})}. The
522 \var{radix} argument is interpreted in the same way as for
523 \function{int()}, and may only be given when \var{x} is a string.
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000524 Otherwise, the argument may be a plain or
Guido van Rossumeb0f0661997-12-30 20:38:16 +0000525 long integer or a floating point number, and a long integer with
Guido van Rossum1cd26f21997-04-02 06:04:02 +0000526 the same value is returned. Conversion of floating
Tim Peters1c33daf2001-09-30 06:18:26 +0000527 point numbers to integers truncates (towards zero).
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000528\end{funcdesc}
529
Fred Drakecce10901998-03-17 06:33:25 +0000530\begin{funcdesc}{map}{function, list, ...}
Fred Drake91f2f262001-07-06 19:28:48 +0000531 Apply \var{function} to every item of \var{list} and return a list
532 of the results. If additional \var{list} arguments are passed,
533 \var{function} must take that many arguments and is applied to the
534 items of all lists in parallel; if a list is shorter than another it
535 is assumed to be extended with \code{None} items. If \var{function}
536 is \code{None}, the identity function is assumed; if there are
537 multiple list arguments, \function{map()} returns a list consisting
538 of tuples containing the corresponding items from all lists (a kind
539 of transpose operation). The \var{list} arguments may be any kind
540 of sequence; the result is always a list.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000541\end{funcdesc}
542
Guido van Rossum5eabf381998-11-25 18:53:05 +0000543\begin{funcdesc}{max}{s\optional{, args...}}
Fred Drake91f2f262001-07-06 19:28:48 +0000544 With a single argument \var{s}, return the largest item of a
545 non-empty sequence (such as a string, tuple or list). With more
546 than one argument, return the largest of the arguments.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000547\end{funcdesc}
548
Guido van Rossum5eabf381998-11-25 18:53:05 +0000549\begin{funcdesc}{min}{s\optional{, args...}}
Fred Drake91f2f262001-07-06 19:28:48 +0000550 With a single argument \var{s}, return the smallest item of a
551 non-empty sequence (such as a string, tuple or list). With more
552 than one argument, return the smallest of the arguments.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000553\end{funcdesc}
554
555\begin{funcdesc}{oct}{x}
Guido van Rossum470be141995-03-17 16:07:09 +0000556 Convert an integer number (of any size) to an octal string. The
Fred Drake91f2f262001-07-06 19:28:48 +0000557 result is a valid Python expression. Note: this always yields an
558 unsigned literal. For example, on a 32-bit machine, \code{oct(-1)}
559 yields \code{'037777777777'}. When evaluated on a machine with the
560 same word size, this literal is evaluated as -1; at a different word
Guido van Rossum5cd75201997-01-14 18:44:23 +0000561 size, it may turn up as a large positive number or raise an
Fred Drake53525371998-03-03 21:56:15 +0000562 \exception{OverflowError} exception.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000563\end{funcdesc}
564
Fred Drakecce10901998-03-17 06:33:25 +0000565\begin{funcdesc}{open}{filename\optional{, mode\optional{, bufsize}}}
Tim Peters2e29bfb2001-09-20 19:55:29 +0000566 An alias for the \function{file()} function above.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000567\end{funcdesc}
568
569\begin{funcdesc}{ord}{c}
Fred Drake33d51842000-04-06 14:43:12 +0000570 Return the \ASCII{} value of a string of one character or a Unicode
571 character. E.g., \code{ord('a')} returns the integer \code{97},
572 \code{ord(u'\\u2020')} returns \code{8224}. This is the inverse of
573 \function{chr()} for strings and of \function{unichr()} for Unicode
574 characters.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000575\end{funcdesc}
576
Fred Drakecce10901998-03-17 06:33:25 +0000577\begin{funcdesc}{pow}{x, y\optional{, z}}
Guido van Rossumb8b264b1994-08-12 13:13:50 +0000578 Return \var{x} to the power \var{y}; if \var{z} is present, return
579 \var{x} to the power \var{y}, modulo \var{z} (computed more
Guido van Rossumbf5a7742001-07-12 11:27:16 +0000580 efficiently than \code{pow(\var{x}, \var{y}) \%\ \var{z}}). The
581 arguments must have numeric types. With mixed operand types, the
582 coercion rules for binary arithmetic operators apply. For int and
583 long int operands, the result has the same type as the operands
584 (after coercion) unless the second argument is negative; in that
585 case, all arguments are converted to float and a float result is
586 delivered. For example, \code{10**2} returns \code{100}, but
587 \code{10**-2} returns \code{0.01}. (This last feature was added in
Tim Peters32f453e2001-09-03 08:35:41 +0000588 Python 2.2. In Python 2.1 and before, if both arguments were of integer
589 types and the second argument was negative, an exception was raised.)
Tim Peters2e29bfb2001-09-20 19:55:29 +0000590 If the second argument is negative, the third argument must be omitted.
Tim Peters32f453e2001-09-03 08:35:41 +0000591 If \var{z} is present, \var{x} and \var{y} must be of integer types,
592 and \var{y} must be non-negative. (This restriction was added in
593 Python 2.2. In Python 2.1 and before, floating 3-argument \code{pow()}
594 returned platform-dependent results depending on floating-point
595 rounding accidents.)
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000596\end{funcdesc}
597
Fred Drakecce10901998-03-17 06:33:25 +0000598\begin{funcdesc}{range}{\optional{start,} stop\optional{, step}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000599 This is a versatile function to create lists containing arithmetic
Fred Drake53525371998-03-03 21:56:15 +0000600 progressions. It is most often used in \keyword{for} loops. The
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000601 arguments must be plain integers. If the \var{step} argument is
602 omitted, it defaults to \code{1}. If the \var{start} argument is
603 omitted, it defaults to \code{0}. The full form returns a list of
604 plain integers \code{[\var{start}, \var{start} + \var{step},
605 \var{start} + 2 * \var{step}, \ldots]}. If \var{step} is positive,
606 the last element is the largest \code{\var{start} + \var{i} *
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000607 \var{step}} less than \var{stop}; if \var{step} is negative, the last
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000608 element is the largest \code{\var{start} + \var{i} * \var{step}}
Fred Drake6251c161998-04-03 07:15:54 +0000609 greater than \var{stop}. \var{step} must not be zero (or else
610 \exception{ValueError} is raised). Example:
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000611
Fred Drake19479911998-02-13 06:58:54 +0000612\begin{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000613>>> range(10)
614[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
615>>> range(1, 11)
616[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
617>>> range(0, 30, 5)
618[0, 5, 10, 15, 20, 25]
619>>> range(0, 10, 3)
620[0, 3, 6, 9]
621>>> range(0, -10, -1)
622[0, -1, -2, -3, -4, -5, -6, -7, -8, -9]
623>>> range(0)
624[]
625>>> range(1, 0)
626[]
Fred Drake19479911998-02-13 06:58:54 +0000627\end{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000628\end{funcdesc}
629
Guido van Rossum16d6e711994-08-08 12:30:22 +0000630\begin{funcdesc}{raw_input}{\optional{prompt}}
631 If the \var{prompt} argument is present, it is written to standard output
632 without a trailing newline. The function then reads a line from input,
633 converts it to a string (stripping a trailing newline), and returns that.
Fred Drake53525371998-03-03 21:56:15 +0000634 When \EOF{} is read, \exception{EOFError} is raised. Example:
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000635
Fred Drake19479911998-02-13 06:58:54 +0000636\begin{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000637>>> s = raw_input('--> ')
638--> Monty Python's Flying Circus
639>>> s
Guido van Rossum470be141995-03-17 16:07:09 +0000640"Monty Python's Flying Circus"
Fred Drake19479911998-02-13 06:58:54 +0000641\end{verbatim}
Guido van Rossum921f32c1997-06-02 17:21:20 +0000642
Fred Drakee0063d22001-10-09 19:31:08 +0000643 If the \refmodule{readline} module was loaded, then
644 \function{raw_input()} will use it to provide elaborate
645 line editing and history features.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000646\end{funcdesc}
647
Guido van Rossum87e611e1999-01-06 23:10:51 +0000648\begin{funcdesc}{reduce}{function, sequence\optional{, initializer}}
Fred Drakee0063d22001-10-09 19:31:08 +0000649 Apply \var{function} of two arguments cumulatively to the items of
650 \var{sequence}, from left to right, so as to reduce the sequence to
651 a single value. For example,
652 \code{reduce(lambda x, y: x+y, [1, 2, 3, 4, 5])} calculates
653 \code{((((1+2)+3)+4)+5)}.
654 If the optional \var{initializer} is present, it is placed before
655 the items of the sequence in the calculation, and serves as a
656 default when the sequence is empty.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000657\end{funcdesc}
658
659\begin{funcdesc}{reload}{module}
Fred Drakee0063d22001-10-09 19:31:08 +0000660 Re-parse and re-initialize an already imported \var{module}. The
661 argument must be a module object, so it must have been successfully
662 imported before. This is useful if you have edited the module
663 source file using an external editor and want to try out the new
664 version without leaving the Python interpreter. The return value is
665 the module object (the same as the \var{module} argument).
Guido van Rossum470be141995-03-17 16:07:09 +0000666
Fred Drakee0063d22001-10-09 19:31:08 +0000667 There are a number of caveats:
Guido van Rossum470be141995-03-17 16:07:09 +0000668
Fred Drakee0063d22001-10-09 19:31:08 +0000669 If a module is syntactically correct but its initialization fails,
670 the first \keyword{import} statement for it does not bind its name
671 locally, but does store a (partially initialized) module object in
672 \code{sys.modules}. To reload the module you must first
673 \keyword{import} it again (this will bind the name to the partially
674 initialized module object) before you can \function{reload()} it.
Guido van Rossum470be141995-03-17 16:07:09 +0000675
Fred Drakee0063d22001-10-09 19:31:08 +0000676 When a module is reloaded, its dictionary (containing the module's
677 global variables) is retained. Redefinitions of names will override
678 the old definitions, so this is generally not a problem. If the new
679 version of a module does not define a name that was defined by the
680 old version, the old definition remains. This feature can be used
681 to the module's advantage if it maintains a global table or cache of
682 objects --- with a \keyword{try} statement it can test for the
683 table's presence and skip its initialization if desired.
Guido van Rossum470be141995-03-17 16:07:09 +0000684
Fred Drakee0063d22001-10-09 19:31:08 +0000685 It is legal though generally not very useful to reload built-in or
686 dynamically loaded modules, except for \refmodule{sys},
687 \refmodule[main]{__main__} and \refmodule[builtin]{__builtin__}. In
688 many cases, however, extension modules are not designed to be
689 initialized more than once, and may fail in arbitrary ways when
690 reloaded.
Guido van Rossum470be141995-03-17 16:07:09 +0000691
Fred Drakee0063d22001-10-09 19:31:08 +0000692 If a module imports objects from another module using \keyword{from}
693 \ldots{} \keyword{import} \ldots{}, calling \function{reload()} for
694 the other module does not redefine the objects imported from it ---
695 one way around this is to re-execute the \keyword{from} statement,
696 another is to use \keyword{import} and qualified names
697 (\var{module}.\var{name}) instead.
Guido van Rossum470be141995-03-17 16:07:09 +0000698
Fred Drakee0063d22001-10-09 19:31:08 +0000699 If a module instantiates instances of a class, reloading the module
700 that defines the class does not affect the method definitions of the
701 instances --- they continue to use the old class definition. The
702 same is true for derived classes.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000703\end{funcdesc}
704
705\begin{funcdesc}{repr}{object}
Fred Drakee0063d22001-10-09 19:31:08 +0000706 Return a string containing a printable representation of an object.
707 This is the same value yielded by conversions (reverse quotes).
708 It is sometimes useful to be able to access this operation as an
709 ordinary function. For many types, this function makes an attempt
710 to return a string that would yield an object with the same value
711 when passed to \function{eval()}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000712\end{funcdesc}
713
Fred Drake607f8021998-08-24 20:30:07 +0000714\begin{funcdesc}{round}{x\optional{, n}}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000715 Return the floating point value \var{x} rounded to \var{n} digits
716 after the decimal point. If \var{n} is omitted, it defaults to zero.
717 The result is a floating point number. Values are rounded to the
718 closest multiple of 10 to the power minus \var{n}; if two multiples
Fred Drake91f2f262001-07-06 19:28:48 +0000719 are equally close, rounding is done away from 0 (so. for example,
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000720 \code{round(0.5)} is \code{1.0} and \code{round(-0.5)} is \code{-1.0}).
721\end{funcdesc}
722
Fred Drakecce10901998-03-17 06:33:25 +0000723\begin{funcdesc}{setattr}{object, name, value}
Fred Drake53525371998-03-03 21:56:15 +0000724 This is the counterpart of \function{getattr()}. The arguments are an
Fred Drake607f8021998-08-24 20:30:07 +0000725 object, a string and an arbitrary value. The string may name an
726 existing attribute or a new attribute. The function assigns the
727 value to the attribute, provided the object allows it. For example,
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000728 \code{setattr(\var{x}, '\var{foobar}', 123)} is equivalent to
729 \code{\var{x}.\var{foobar} = 123}.
730\end{funcdesc}
731
Fred Drakecce10901998-03-17 06:33:25 +0000732\begin{funcdesc}{slice}{\optional{start,} stop\optional{, step}}
Fred Drakee0063d22001-10-09 19:31:08 +0000733 Return a slice object representing the set of indices specified by
734 \code{range(\var{start}, \var{stop}, \var{step})}. The \var{start}
735 and \var{step} arguments default to None. Slice objects have
736 read-only data attributes \member{start}, \member{stop} and
737 \member{step} which merely return the argument values (or their
738 default). They have no other explicit functionality; however they
739 are used by Numerical Python\index{Numerical Python} and other third
740 party extensions. Slice objects are also generated when extended
741 indexing syntax is used. For example: \samp{a[start:stop:step]} or
742 \samp{a[start:stop, i]}.
Guido van Rossum7974b0f1997-10-05 18:53:00 +0000743\end{funcdesc}
744
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000745\begin{funcdesc}{str}{object}
Fred Drakee0063d22001-10-09 19:31:08 +0000746 Return a string containing a nicely printable representation of an
747 object. For strings, this returns the string itself. The
748 difference with \code{repr(\var{object})} is that
749 \code{str(\var{object})} does not always attempt to return a string
750 that is acceptable to \function{eval()}; its goal is to return a
751 printable string.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000752\end{funcdesc}
753
Tim Peters1fc240e2001-10-26 05:06:50 +0000754\begin{funcdesc}{tuple}{\optional{sequence}}
Fred Drakee0063d22001-10-09 19:31:08 +0000755 Return a tuple whose items are the same and in the same order as
756 \var{sequence}'s items. \var{sequence} may be a sequence, a
757 container that supports iteration, or an iterator object.
758 If \var{sequence} is already a tuple, it
759 is returned unchanged. For instance, \code{tuple('abc')} returns
760 returns \code{('a', 'b', 'c')} and \code{tuple([1, 2, 3])} returns
761 \code{(1, 2, 3)}.
Guido van Rossumb8b264b1994-08-12 13:13:50 +0000762\end{funcdesc}
763
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000764\begin{funcdesc}{type}{object}
Fred Drakee0063d22001-10-09 19:31:08 +0000765 Return the type of an \var{object}. The return value is a
766 type\obindex{type} object. The standard module
767 \module{types}\refstmodindex{types} defines names for all built-in
768 types.
769 For instance:
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000770
Fred Drake19479911998-02-13 06:58:54 +0000771\begin{verbatim}
Guido van Rossum470be141995-03-17 16:07:09 +0000772>>> import types
Guido van Rossuma7874d11998-06-22 14:07:36 +0000773>>> if type(x) == types.StringType: print "It's a string"
Fred Drake19479911998-02-13 06:58:54 +0000774\end{verbatim}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +0000775\end{funcdesc}
Guido van Rossum68cfbe71994-02-24 11:28:27 +0000776
Fred Drake33d51842000-04-06 14:43:12 +0000777\begin{funcdesc}{unichr}{i}
Fred Drakee0063d22001-10-09 19:31:08 +0000778 Return the Unicode string of one character whose Unicode code is the
779 integer \var{i}. For example, \code{unichr(97)} returns the string
780 \code{u'a'}. This is the inverse of \function{ord()} for Unicode
781 strings. The argument must be in the range [0..65535], inclusive.
782 \exception{ValueError} is raised otherwise.
783 \versionadded{2.0}
Fred Drake33d51842000-04-06 14:43:12 +0000784\end{funcdesc}
785
Marc-André Lemburgb5507ec2001-10-19 12:02:29 +0000786\begin{funcdesc}{unicode}{object\optional{, encoding\optional{, errors}}}
787 Return the Unicode string version of \var{object} using one of the
788 following modes:
789
790 If \var{encoding} and/or \var{errors} are given, \code{unicode()}
791 will decode the object which can either be an 8-bit string or a
792 character buffer using the codec for \var{encoding}. The
793 \var{encoding} parameter is a string giving the name of an encoding.
794 Error handling is done according to \var{errors}; this specifies the
795 treatment of characters which are invalid in the input encoding. If
796 \var{errors} is \code{'strict'} (the default), a
797 \exception{ValueError} is raised on errors, while a value of
798 \code{'ignore'} causes errors to be silently ignored, and a value of
799 \code{'replace'} causes the official Unicode replacement character,
800 \code{U+FFFD}, to be used to replace input characters which cannot
801 be decoded. See also the \refmodule{codecs} module.
802
803 If no optional parameters are given, \code{unicode()} will mimic the
804 behaviour of \code{str()} except that it returns Unicode strings
805 instead of 8-bit strings. More precisely, if \var{object} is an
806 Unicode string or subclass it will return a Unicode string without
807 any additional decoding applied. For objects which provide a
808 \code{__unicode__} method, it will call this method without
809 arguments to create a Unicode string. For all other objects, the
810 8-bit string version or representation is requested and then
811 converted to a Unicode string using the codec for the default
812 encoding in \code{'strict'} mode.
Fred Drakee0063d22001-10-09 19:31:08 +0000813 \versionadded{2.0}
Fred Drake33d51842000-04-06 14:43:12 +0000814\end{funcdesc}
815
Guido van Rossum6bb1adc1995-03-13 10:03:32 +0000816\begin{funcdesc}{vars}{\optional{object}}
Fred Drakee0063d22001-10-09 19:31:08 +0000817 Without arguments, return a dictionary corresponding to the current
818 local symbol table. With a module, class or class instance object
819 as argument (or anything else that has a \member{__dict__}
820 attribute), returns a dictionary corresponding to the object's
821 symbol table. The returned dictionary should not be modified: the
822 effects on the corresponding symbol table are undefined.\footnote{
823 In the current implementation, local variable bindings cannot
824 normally be affected this way, but variables retrieved from
825 other scopes (such as modules) can be. This may change.}
Guido van Rossum17383111994-04-21 10:32:28 +0000826\end{funcdesc}
827
Fred Drakecce10901998-03-17 06:33:25 +0000828\begin{funcdesc}{xrange}{\optional{start,} stop\optional{, step}}
Fred Drakee0063d22001-10-09 19:31:08 +0000829 This function is very similar to \function{range()}, but returns an
830 ``xrange object'' instead of a list. This is an opaque sequence
831 type which yields the same values as the corresponding list, without
832 actually storing them all simultaneously. The advantage of
833 \function{xrange()} over \function{range()} is minimal (since
834 \function{xrange()} still has to create the values when asked for
835 them) except when a very large range is used on a memory-starved
836 machine or when all of the range's elements are never used (such as
837 when the loop is usually terminated with \keyword{break}).
Guido van Rossum68cfbe71994-02-24 11:28:27 +0000838\end{funcdesc}
Barry Warsawfaefa2a2000-08-03 15:46:17 +0000839
Fred Drake8b168ba2000-08-03 17:29:13 +0000840\begin{funcdesc}{zip}{seq1, \moreargs}
Fred Drakee0063d22001-10-09 19:31:08 +0000841 This function returns a list of tuples, where each tuple contains
842 the \var{i}-th element from each of the argument sequences. At
843 least one sequence is required, otherwise a \exception{TypeError} is
844 raised. The returned list is truncated in length to the length of
845 the shortest argument sequence. When there are multiple argument
846 sequences which are all of the same length, \function{zip()} is
847 similar to \function{map()} with an initial argument of \code{None}.
848 With a single sequence argument, it returns a list of 1-tuples.
849 \versionadded{2.0}
Fred Drake8b168ba2000-08-03 17:29:13 +0000850\end{funcdesc}