Fred Drake | 295da24 | 1998-08-10 19:42:37 +0000 | [diff] [blame] | 1 | \section{Built-in Functions \label{built-in-funcs}} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 2 | |
| 3 | The Python interpreter has a number of functions built into it that |
| 4 | are always available. They are listed here in alphabetical order. |
| 5 | |
| 6 | |
Fred Drake | 1947991 | 1998-02-13 06:58:54 +0000 | [diff] [blame] | 7 | \setindexsubitem{(built-in function)} |
Guido van Rossum | 7974b0f | 1997-10-05 18:53:00 +0000 | [diff] [blame] | 8 | |
| 9 | \begin{funcdesc}{__import__}{name\optional{, globals\optional{, locals\optional{, fromlist}}}} |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 10 | 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 Rossum | 7974b0f | 1997-10-05 18:53:00 +0000 | [diff] [blame] | 20 | |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 21 | 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 Rossum | 7974b0f | 1997-10-05 18:53:00 +0000 | [diff] [blame] | 33 | |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 34 | 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 |
Fred Drake | d6cf8be | 2002-10-22 20:31:22 +0000 | [diff] [blame] | 40 | using \samp{import spam.ham.eggs}, the top-level package \module{spam} |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 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 Rossum | 8c2da61 | 1998-12-04 15:32:17 +0000 | [diff] [blame] | 46 | |
| 47 | \begin{verbatim} |
Guido van Rossum | 8c2da61 | 1998-12-04 15:32:17 +0000 | [diff] [blame] | 48 | def my_import(name): |
| 49 | mod = __import__(name) |
Fred Drake | d6cf8be | 2002-10-22 20:31:22 +0000 | [diff] [blame] | 50 | components = name.split('.') |
Guido van Rossum | 8c2da61 | 1998-12-04 15:32:17 +0000 | [diff] [blame] | 51 | for comp in components[1:]: |
| 52 | mod = getattr(mod, comp) |
| 53 | return mod |
| 54 | \end{verbatim} |
Guido van Rossum | 7974b0f | 1997-10-05 18:53:00 +0000 | [diff] [blame] | 55 | \end{funcdesc} |
| 56 | |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 57 | \begin{funcdesc}{abs}{x} |
| 58 | Return the absolute value of a number. The argument may be a plain |
Guido van Rossum | 921f32c | 1997-06-02 17:21:20 +0000 | [diff] [blame] | 59 | or long integer or a floating point number. If the argument is a |
Guido van Rossum | 7974b0f | 1997-10-05 18:53:00 +0000 | [diff] [blame] | 60 | complex number, its magnitude is returned. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 61 | \end{funcdesc} |
| 62 | |
Fred Drake | cce1090 | 1998-03-17 06:33:25 +0000 | [diff] [blame] | 63 | \begin{funcdesc}{apply}{function, args\optional{, keywords}} |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 64 | The \var{function} argument must be a callable object (a |
| 65 | user-defined or built-in function or method, or a class object) and |
Fred Drake | 66ded52 | 2001-11-07 06:22:25 +0000 | [diff] [blame] | 66 | the \var{args} argument must be a sequence. The \var{function} is |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 67 | called with \var{args} as the argument list; the number of arguments |
Raymond Hettinger | d918884 | 2002-09-04 23:52:42 +0000 | [diff] [blame] | 68 | is the length of the tuple. |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 69 | If the optional \var{keywords} argument is present, it must be a |
| 70 | dictionary whose keys are strings. It specifies keyword arguments |
| 71 | to be added to the end of the the argument list. |
Fred Drake | 66ded52 | 2001-11-07 06:22:25 +0000 | [diff] [blame] | 72 | Calling \function{apply()} is different from just calling |
Fred Drake | 0b66310 | 2001-11-07 06:28:47 +0000 | [diff] [blame] | 73 | \code{\var{function}(\var{args})}, since in that case there is always |
Fred Drake | 66ded52 | 2001-11-07 06:22:25 +0000 | [diff] [blame] | 74 | exactly one argument. The use of \function{apply()} is equivalent |
| 75 | to \code{\var{function}(*\var{args}, **\var{keywords})}. |
Fred Drake | 5ec486b | 2002-08-22 14:27:35 +0000 | [diff] [blame] | 76 | Use of \function{apply()} is not necessary since the ``extended call |
| 77 | syntax,'' as used in the last example, is completely equivalent. |
Fred Drake | 45e482f | 2003-01-02 04:54:04 +0000 | [diff] [blame] | 78 | |
| 79 | \deprecated{2.3}{Use the extended call syntax instead, as described |
| 80 | above.} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 81 | \end{funcdesc} |
| 82 | |
Raymond Hettinger | 3985df2 | 2003-06-11 08:16:06 +0000 | [diff] [blame] | 83 | \begin{funcdesc}{bool}{\optional{x}} |
Guido van Rossum | 77f6a65 | 2002-04-03 22:41:51 +0000 | [diff] [blame] | 84 | Convert a value to a Boolean, using the standard truth testing |
| 85 | procedure. If \code{x} is false, this returns \code{False}; |
| 86 | otherwise it returns \code{True}. \code{bool} is also a class, |
| 87 | which is a subclass of \code{int}. Class \code{bool} cannot be |
| 88 | subclassed further. Its only instances are \code{False} and |
Raymond Hettinger | 7e902b2 | 2003-06-11 09:15:26 +0000 | [diff] [blame] | 89 | \code{True}. |
| 90 | |
Guido van Rossum | 77f6a65 | 2002-04-03 22:41:51 +0000 | [diff] [blame] | 91 | \indexii{Boolean}{type} |
Neal Norwitz | e9ce25e | 2002-12-17 01:02:57 +0000 | [diff] [blame] | 92 | \versionadded{2.2.1} |
Raymond Hettinger | 7e902b2 | 2003-06-11 09:15:26 +0000 | [diff] [blame] | 93 | |
Neal Norwitz | 938b7a0 | 2003-06-17 02:37:06 +0000 | [diff] [blame] | 94 | \versionchanged[If no argument is given, this function returns |
| 95 | \code{False}]{2.3} |
Guido van Rossum | 77f6a65 | 2002-04-03 22:41:51 +0000 | [diff] [blame] | 96 | \end{funcdesc} |
| 97 | |
Guido van Rossum | 8be2296 | 1999-03-19 19:10:14 +0000 | [diff] [blame] | 98 | \begin{funcdesc}{buffer}{object\optional{, offset\optional{, size}}} |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 99 | The \var{object} argument must be an object that supports the buffer |
| 100 | call interface (such as strings, arrays, and buffers). A new buffer |
| 101 | object will be created which references the \var{object} argument. |
| 102 | The buffer object will be a slice from the beginning of \var{object} |
| 103 | (or from the specified \var{offset}). The slice will extend to the |
| 104 | end of \var{object} (or will have a length given by the \var{size} |
| 105 | argument). |
Guido van Rossum | 8be2296 | 1999-03-19 19:10:14 +0000 | [diff] [blame] | 106 | \end{funcdesc} |
| 107 | |
Guido van Rossum | 7974b0f | 1997-10-05 18:53:00 +0000 | [diff] [blame] | 108 | \begin{funcdesc}{callable}{object} |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 109 | Return true if the \var{object} argument appears callable, false if |
| 110 | not. If this returns true, it is still possible that a call fails, |
| 111 | but if it is false, calling \var{object} will never succeed. Note |
| 112 | that classes are callable (calling a class returns a new instance); |
| 113 | class instances are callable if they have a \method{__call__()} |
| 114 | method. |
Guido van Rossum | 7974b0f | 1997-10-05 18:53:00 +0000 | [diff] [blame] | 115 | \end{funcdesc} |
| 116 | |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 117 | \begin{funcdesc}{chr}{i} |
| 118 | Return a string of one character whose \ASCII{} code is the integer |
Fred Drake | 91f2f26 | 2001-07-06 19:28:48 +0000 | [diff] [blame] | 119 | \var{i}. For example, \code{chr(97)} returns the string \code{'a'}. |
| 120 | This is the inverse of \function{ord()}. The argument must be in |
| 121 | the range [0..255], inclusive; \exception{ValueError} will be raised |
| 122 | if \var{i} is outside that range. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 123 | \end{funcdesc} |
| 124 | |
Neal Norwitz | e9ce25e | 2002-12-17 01:02:57 +0000 | [diff] [blame] | 125 | \begin{funcdesc}{classmethod}{function} |
| 126 | Return a class method for \var{function}. |
| 127 | |
| 128 | A class method receives the class as implicit first argument, |
| 129 | just like an instance method receives the instance. |
| 130 | To declare a class method, use this idiom: |
| 131 | |
| 132 | \begin{verbatim} |
| 133 | class C: |
| 134 | def f(cls, arg1, arg2, ...): ... |
| 135 | f = classmethod(f) |
| 136 | \end{verbatim} |
| 137 | |
Raymond Hettinger | 3985df2 | 2003-06-11 08:16:06 +0000 | [diff] [blame] | 138 | It can be called either on the class (such as \code{C.f()}) or on an |
| 139 | instance (such as \code{C().f()}). The instance is ignored except for |
| 140 | its class. |
Neal Norwitz | e9ce25e | 2002-12-17 01:02:57 +0000 | [diff] [blame] | 141 | If a class method is called for a derived class, the derived class |
| 142 | object is passed as the implied first argument. |
| 143 | |
| 144 | Class methods are different than C++ or Java static methods. |
Fred Drake | f91888b | 2003-06-26 03:11:57 +0000 | [diff] [blame] | 145 | If you want those, see \function{staticmethod()} in this section. |
Neal Norwitz | e9ce25e | 2002-12-17 01:02:57 +0000 | [diff] [blame] | 146 | \versionadded{2.2} |
| 147 | \end{funcdesc} |
| 148 | |
Fred Drake | cce1090 | 1998-03-17 06:33:25 +0000 | [diff] [blame] | 149 | \begin{funcdesc}{cmp}{x, y} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 150 | Compare the two objects \var{x} and \var{y} and return an integer |
| 151 | according to the outcome. The return value is negative if \code{\var{x} |
| 152 | < \var{y}}, zero if \code{\var{x} == \var{y}} and strictly positive if |
| 153 | \code{\var{x} > \var{y}}. |
| 154 | \end{funcdesc} |
| 155 | |
Fred Drake | cce1090 | 1998-03-17 06:33:25 +0000 | [diff] [blame] | 156 | \begin{funcdesc}{coerce}{x, y} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 157 | Return a tuple consisting of the two numeric arguments converted to |
| 158 | a common type, using the same rules as used by arithmetic |
| 159 | operations. |
| 160 | \end{funcdesc} |
| 161 | |
Tim Peters | 32f453e | 2001-09-03 08:35:41 +0000 | [diff] [blame] | 162 | \begin{funcdesc}{compile}{string, filename, kind\optional{, |
Michael W. Hudson | 53da317 | 2001-08-27 20:02:17 +0000 | [diff] [blame] | 163 | flags\optional{, dont_inherit}}} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 164 | Compile the \var{string} into a code object. Code objects can be |
Fred Drake | 5352537 | 1998-03-03 21:56:15 +0000 | [diff] [blame] | 165 | executed by an \keyword{exec} statement or evaluated by a call to |
| 166 | \function{eval()}. The \var{filename} argument should |
Guido van Rossum | 0d68246 | 2001-09-29 14:28:52 +0000 | [diff] [blame] | 167 | give the file from which the code was read; pass some recognizable value |
Fred Drake | 91f2f26 | 2001-07-06 19:28:48 +0000 | [diff] [blame] | 168 | if it wasn't read from a file (\code{'<string>'} is commonly used). |
| 169 | The \var{kind} argument specifies what kind of code must be |
| 170 | compiled; it can be \code{'exec'} if \var{string} consists of a |
| 171 | sequence of statements, \code{'eval'} if it consists of a single |
| 172 | expression, or \code{'single'} if it consists of a single |
| 173 | interactive statement (in the latter case, expression statements |
| 174 | that evaluate to something else than \code{None} will printed). |
Michael W. Hudson | 53da317 | 2001-08-27 20:02:17 +0000 | [diff] [blame] | 175 | |
Guido van Rossum | 0d68246 | 2001-09-29 14:28:52 +0000 | [diff] [blame] | 176 | When compiling multi-line statements, two caveats apply: line |
| 177 | endings must be represented by a single newline character |
| 178 | (\code{'\e n'}), and the input must be terminated by at least one |
| 179 | newline character. If line endings are represented by |
| 180 | \code{'\e r\e n'}, use the string \method{replace()} method to |
| 181 | change them into \code{'\e n'}. |
| 182 | |
| 183 | The optional arguments \var{flags} and \var{dont_inherit} |
Michael W. Hudson | 53da317 | 2001-08-27 20:02:17 +0000 | [diff] [blame] | 184 | (which are new in Python 2.2) control which future statements (see |
| 185 | \pep{236}) affect the compilation of \var{string}. If neither is |
| 186 | present (or both are zero) the code is compiled with those future |
| 187 | statements that are in effect in the code that is calling compile. |
| 188 | If the \var{flags} argument is given and \var{dont_inherit} is not |
| 189 | (or is zero) then the future statements specified by the \var{flags} |
| 190 | argument are used in addition to those that would be used anyway. |
| 191 | If \var{dont_inherit} is a non-zero integer then the \var{flags} |
| 192 | argument is it -- the future statements in effect around the call to |
| 193 | compile are ignored. |
| 194 | |
| 195 | Future statemants are specified by bits which can be bitwise or-ed |
| 196 | together to specify multiple statements. The bitfield required to |
| 197 | specify a given feature can be found as the \member{compiler_flag} |
| 198 | attribute on the \class{_Feature} instance in the |
| 199 | \module{__future__} module. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 200 | \end{funcdesc} |
| 201 | |
Raymond Hettinger | 3985df2 | 2003-06-11 08:16:06 +0000 | [diff] [blame] | 202 | \begin{funcdesc}{complex}{\optional{real\optional{, imag}}} |
Guido van Rossum | cb1f242 | 1999-03-25 21:23:26 +0000 | [diff] [blame] | 203 | Create a complex number with the value \var{real} + \var{imag}*j or |
Fred Drake | 526c7a0 | 2001-12-13 19:52:22 +0000 | [diff] [blame] | 204 | convert a string or number to a complex number. If the first |
| 205 | parameter is a string, it will be interpreted as a complex number |
| 206 | and the function must be called without a second parameter. The |
| 207 | second parameter can never be a string. |
Guido van Rossum | 1cd26f2 | 1997-04-02 06:04:02 +0000 | [diff] [blame] | 208 | Each argument may be any numeric type (including complex). |
| 209 | If \var{imag} is omitted, it defaults to zero and the function |
Fred Drake | 5352537 | 1998-03-03 21:56:15 +0000 | [diff] [blame] | 210 | serves as a numeric conversion function like \function{int()}, |
Raymond Hettinger | 3985df2 | 2003-06-11 08:16:06 +0000 | [diff] [blame] | 211 | \function{long()} and \function{float()}. If both arguments |
| 212 | are omitted, returns \code{0j}. |
Guido van Rossum | 1cd26f2 | 1997-04-02 06:04:02 +0000 | [diff] [blame] | 213 | \end{funcdesc} |
| 214 | |
Fred Drake | cce1090 | 1998-03-17 06:33:25 +0000 | [diff] [blame] | 215 | \begin{funcdesc}{delattr}{object, name} |
Fred Drake | 5352537 | 1998-03-03 21:56:15 +0000 | [diff] [blame] | 216 | This is a relative of \function{setattr()}. The arguments are an |
Guido van Rossum | 1efbb0f | 1994-08-16 22:15:11 +0000 | [diff] [blame] | 217 | object and a string. The string must be the name |
| 218 | of one of the object's attributes. The function deletes |
| 219 | the named attribute, provided the object allows it. For example, |
Guido van Rossum | 6c4f003 | 1995-03-07 10:14:09 +0000 | [diff] [blame] | 220 | \code{delattr(\var{x}, '\var{foobar}')} is equivalent to |
Guido van Rossum | 1efbb0f | 1994-08-16 22:15:11 +0000 | [diff] [blame] | 221 | \code{del \var{x}.\var{foobar}}. |
| 222 | \end{funcdesc} |
| 223 | |
Tim Peters | a427a2b | 2001-10-29 22:25:45 +0000 | [diff] [blame] | 224 | \begin{funcdesc}{dict}{\optional{mapping-or-sequence}} |
Just van Rossum | a797d81 | 2002-11-23 09:45:04 +0000 | [diff] [blame] | 225 | Return a new dictionary initialized from an optional positional |
| 226 | argument or from a set of keyword arguments. |
| 227 | If no arguments are given, return a new empty dictionary. |
| 228 | If the positional argument is a mapping object, return a dictionary |
| 229 | mapping the same keys to the same values as does the mapping object. |
| 230 | Otherwise the positional argument must be a sequence, a container that |
| 231 | supports iteration, or an iterator object. The elements of the argument |
| 232 | must each also be of one of those kinds, and each must in turn contain |
Tim Peters | 1fc240e | 2001-10-26 05:06:50 +0000 | [diff] [blame] | 233 | exactly two objects. The first is used as a key in the new dictionary, |
| 234 | and the second as the key's value. If a given key is seen more than |
| 235 | once, the last value associated with it is retained in the new |
| 236 | dictionary. |
Just van Rossum | a797d81 | 2002-11-23 09:45:04 +0000 | [diff] [blame] | 237 | |
| 238 | If keyword arguments are given, the keywords themselves with their |
| 239 | associated values are added as items to the dictionary. If a key |
| 240 | is specified both in the positional argument and as a keyword argument, |
| 241 | the value associated with the keyword is retained in the dictionary. |
Tim Peters | 1fc240e | 2001-10-26 05:06:50 +0000 | [diff] [blame] | 242 | For example, these all return a dictionary equal to |
Just van Rossum | a797d81 | 2002-11-23 09:45:04 +0000 | [diff] [blame] | 243 | \code{\{"one": 2, "two": 3\}}: |
Fred Drake | ef7d08a | 2001-10-26 15:04:33 +0000 | [diff] [blame] | 244 | |
| 245 | \begin{itemize} |
Just van Rossum | a797d81 | 2002-11-23 09:45:04 +0000 | [diff] [blame] | 246 | \item \code{dict(\{'one': 2, 'two': 3\})} |
| 247 | \item \code{dict(\{'one': 2, 'two': 3\}.items())} |
| 248 | \item \code{dict(\{'one': 2, 'two': 3\}.iteritems())} |
| 249 | \item \code{dict(zip(('one', 'two'), (2, 3)))} |
| 250 | \item \code{dict([['two', 3], ['one', 2]])} |
| 251 | \item \code{dict(one=2, two=3)} |
| 252 | \item \code{dict([(['one', 'two'][i-2], i) for i in (2, 3)])} |
Fred Drake | ef7d08a | 2001-10-26 15:04:33 +0000 | [diff] [blame] | 253 | \end{itemize} |
Fred Drake | da8a6dd | 2002-03-06 02:29:30 +0000 | [diff] [blame] | 254 | |
| 255 | \versionadded{2.2} |
Fred Drake | 6e596b6 | 2002-11-23 15:02:13 +0000 | [diff] [blame] | 256 | \versionchanged[Support for building a dictionary from keyword |
| 257 | arguments added]{2.3} |
Tim Peters | 1fc240e | 2001-10-26 05:06:50 +0000 | [diff] [blame] | 258 | \end{funcdesc} |
| 259 | |
Fred Drake | 6b303b4 | 1998-04-16 22:10:27 +0000 | [diff] [blame] | 260 | \begin{funcdesc}{dir}{\optional{object}} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 261 | Without arguments, return the list of names in the current local |
Guido van Rossum | eb0f066 | 1997-12-30 20:38:16 +0000 | [diff] [blame] | 262 | symbol table. With an argument, attempts to return a list of valid |
Tim Peters | 9f4341b | 2002-02-23 04:40:15 +0000 | [diff] [blame] | 263 | attributes for that object. This information is gleaned from the |
Fred Drake | 3570551 | 2001-12-03 17:32:27 +0000 | [diff] [blame] | 264 | object's \member{__dict__} attribute, if defined, and from the class |
Tim Peters | 9f4341b | 2002-02-23 04:40:15 +0000 | [diff] [blame] | 265 | or type object. The list is not necessarily complete. |
| 266 | If the object is a module object, the list contains the names of the |
| 267 | module's attributes. |
| 268 | If the object is a type or class object, |
| 269 | the list contains the names of its attributes, |
| 270 | and recursively of the attributes of its bases. |
| 271 | Otherwise, the list contains the object's attributes' names, |
| 272 | the names of its class's attributes, |
| 273 | and recursively of the attributes of its class's base classes. |
| 274 | The resulting list is sorted alphabetically. |
| 275 | For example: |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 276 | |
Fred Drake | 1947991 | 1998-02-13 06:58:54 +0000 | [diff] [blame] | 277 | \begin{verbatim} |
Tim Peters | 9f4341b | 2002-02-23 04:40:15 +0000 | [diff] [blame] | 278 | >>> import struct |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 279 | >>> dir() |
Tim Peters | 9f4341b | 2002-02-23 04:40:15 +0000 | [diff] [blame] | 280 | ['__builtins__', '__doc__', '__name__', 'struct'] |
| 281 | >>> dir(struct) |
| 282 | ['__doc__', '__name__', 'calcsize', 'error', 'pack', 'unpack'] |
Fred Drake | 1947991 | 1998-02-13 06:58:54 +0000 | [diff] [blame] | 283 | \end{verbatim} |
Tim Peters | 9f4341b | 2002-02-23 04:40:15 +0000 | [diff] [blame] | 284 | |
| 285 | \note{Because \function{dir()} is supplied primarily as a convenience |
| 286 | for use at an interactive prompt, |
| 287 | it tries to supply an interesting set of names more than it tries to |
| 288 | supply a rigorously or consistently defined set of names, |
| 289 | and its detailed behavior may change across releases.} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 290 | \end{funcdesc} |
| 291 | |
Fred Drake | cce1090 | 1998-03-17 06:33:25 +0000 | [diff] [blame] | 292 | \begin{funcdesc}{divmod}{a, b} |
Raymond Hettinger | 6cf09f0 | 2002-05-21 18:19:49 +0000 | [diff] [blame] | 293 | Take two (non complex) numbers as arguments and return a pair of numbers |
| 294 | consisting of their quotient and remainder when using long division. With |
| 295 | mixed operand types, the rules for binary arithmetic operators apply. For |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 296 | plain and long integers, the result is the same as |
| 297 | \code{(\var{a} / \var{b}, \var{a} \%{} \var{b})}. |
Fred Drake | 1ea7c75 | 1999-05-06 14:46:35 +0000 | [diff] [blame] | 298 | For floating point numbers the result is \code{(\var{q}, \var{a} \%{} |
| 299 | \var{b})}, where \var{q} is usually \code{math.floor(\var{a} / |
| 300 | \var{b})} but may be 1 less than that. In any case \code{\var{q} * |
| 301 | \var{b} + \var{a} \%{} \var{b}} is very close to \var{a}, if |
| 302 | \code{\var{a} \%{} \var{b}} is non-zero it has the same sign as |
| 303 | \var{b}, and \code{0 <= abs(\var{a} \%{} \var{b}) < abs(\var{b})}. |
Fred Drake | 807354f | 2002-06-20 21:10:25 +0000 | [diff] [blame] | 304 | |
| 305 | \versionchanged[Using \function{divmod()} with complex numbers is |
| 306 | deprecated]{2.3} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 307 | \end{funcdesc} |
| 308 | |
Fred Drake | 38f7197 | 2002-04-26 20:29:44 +0000 | [diff] [blame] | 309 | \begin{funcdesc}{enumerate}{iterable} |
| 310 | Return an enumerate object. \var{iterable} must be a sequence, an |
| 311 | iterator, or some other object which supports iteration. The |
| 312 | \method{next()} method of the iterator returned by |
| 313 | \function{enumerate()} returns a tuple containing a count (from |
| 314 | zero) and the corresponding value obtained from iterating over |
Fred Drake | 8f53cdc | 2003-05-10 19:46:39 +0000 | [diff] [blame] | 315 | \var{iterable}. \function{enumerate()} is useful for obtaining an |
Fred Drake | 38f7197 | 2002-04-26 20:29:44 +0000 | [diff] [blame] | 316 | indexed series: \code{(0, seq[0])}, \code{(1, seq[1])}, \code{(2, |
| 317 | seq[2])}, \ldots. |
| 318 | \versionadded{2.3} |
| 319 | \end{funcdesc} |
| 320 | |
Fred Drake | cce1090 | 1998-03-17 06:33:25 +0000 | [diff] [blame] | 321 | \begin{funcdesc}{eval}{expression\optional{, globals\optional{, locals}}} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 322 | The arguments are a string and two optional dictionaries. The |
Guido van Rossum | f860162 | 1995-01-10 10:50:24 +0000 | [diff] [blame] | 323 | \var{expression} argument is parsed and evaluated as a Python |
| 324 | expression (technically speaking, a condition list) using the |
| 325 | \var{globals} and \var{locals} dictionaries as global and local name |
Neal Norwitz | 046b8a7 | 2002-12-17 01:08:06 +0000 | [diff] [blame] | 326 | space. If the \var{globals} dictionary is present and lacks |
| 327 | '__builtins__', the current globals are copied into \var{globals} before |
| 328 | \var{expression} is parsed. This means that \var{expression} |
| 329 | normally has full access to the standard |
| 330 | \refmodule[builtin]{__builtin__} module and restricted environments |
| 331 | are propagated. If the \var{locals} dictionary is omitted it defaults to |
Guido van Rossum | 470be14 | 1995-03-17 16:07:09 +0000 | [diff] [blame] | 332 | the \var{globals} dictionary. If both dictionaries are omitted, the |
Fred Drake | 5352537 | 1998-03-03 21:56:15 +0000 | [diff] [blame] | 333 | expression is executed in the environment where \keyword{eval} is |
Guido van Rossum | f860162 | 1995-01-10 10:50:24 +0000 | [diff] [blame] | 334 | called. The return value is the result of the evaluated expression. |
| 335 | Syntax errors are reported as exceptions. Example: |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 336 | |
Fred Drake | 1947991 | 1998-02-13 06:58:54 +0000 | [diff] [blame] | 337 | \begin{verbatim} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 338 | >>> x = 1 |
| 339 | >>> print eval('x+1') |
| 340 | 2 |
Fred Drake | 1947991 | 1998-02-13 06:58:54 +0000 | [diff] [blame] | 341 | \end{verbatim} |
Fred Drake | 5352537 | 1998-03-03 21:56:15 +0000 | [diff] [blame] | 342 | |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 343 | This function can also be used to execute arbitrary code objects |
Fred Drake | 91f2f26 | 2001-07-06 19:28:48 +0000 | [diff] [blame] | 344 | (such as those created by \function{compile()}). In this case pass |
| 345 | a code object instead of a string. The code object must have been |
| 346 | compiled passing \code{'eval'} as the \var{kind} argument. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 347 | |
Guido van Rossum | 6c4f003 | 1995-03-07 10:14:09 +0000 | [diff] [blame] | 348 | Hints: dynamic execution of statements is supported by the |
Fred Drake | 5352537 | 1998-03-03 21:56:15 +0000 | [diff] [blame] | 349 | \keyword{exec} statement. Execution of statements from a file is |
| 350 | supported by the \function{execfile()} function. The |
| 351 | \function{globals()} and \function{locals()} functions returns the |
| 352 | current global and local dictionary, respectively, which may be |
| 353 | useful to pass around for use by \function{eval()} or |
| 354 | \function{execfile()}. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 355 | \end{funcdesc} |
| 356 | |
Fred Drake | cce1090 | 1998-03-17 06:33:25 +0000 | [diff] [blame] | 357 | \begin{funcdesc}{execfile}{file\optional{, globals\optional{, locals}}} |
Guido van Rossum | 470be14 | 1995-03-17 16:07:09 +0000 | [diff] [blame] | 358 | This function is similar to the |
Fred Drake | 5352537 | 1998-03-03 21:56:15 +0000 | [diff] [blame] | 359 | \keyword{exec} statement, but parses a file instead of a string. It |
| 360 | is different from the \keyword{import} statement in that it does not |
| 361 | use the module administration --- it reads the file unconditionally |
| 362 | and does not create a new module.\footnote{It is used relatively |
| 363 | rarely so does not warrant being made into a statement.} |
Guido van Rossum | f860162 | 1995-01-10 10:50:24 +0000 | [diff] [blame] | 364 | |
| 365 | The arguments are a file name and two optional dictionaries. The |
| 366 | file is parsed and evaluated as a sequence of Python statements |
| 367 | (similarly to a module) using the \var{globals} and \var{locals} |
Fred Drake | 1349437 | 2000-09-12 16:23:48 +0000 | [diff] [blame] | 368 | dictionaries as global and local namespace. If the \var{locals} |
Guido van Rossum | 470be14 | 1995-03-17 16:07:09 +0000 | [diff] [blame] | 369 | dictionary is omitted it defaults to the \var{globals} dictionary. |
Guido van Rossum | f860162 | 1995-01-10 10:50:24 +0000 | [diff] [blame] | 370 | If both dictionaries are omitted, the expression is executed in the |
Fred Drake | 5352537 | 1998-03-03 21:56:15 +0000 | [diff] [blame] | 371 | environment where \function{execfile()} is called. The return value is |
Guido van Rossum | 470be14 | 1995-03-17 16:07:09 +0000 | [diff] [blame] | 372 | \code{None}. |
Tim Peters | af5910f | 2001-09-30 06:32:59 +0000 | [diff] [blame] | 373 | |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 374 | \warning{The default \var{locals} act as described for function |
Tim Peters | af5910f | 2001-09-30 06:32:59 +0000 | [diff] [blame] | 375 | \function{locals()} below: modifications to the default \var{locals} |
| 376 | dictionary should not be attempted. Pass an explicit \var{locals} |
| 377 | dictionary if you need to see effects of the code on \var{locals} after |
| 378 | function \function{execfile()} returns. \function{execfile()} cannot |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 379 | be used reliably to modify a function's locals.} |
Guido van Rossum | f860162 | 1995-01-10 10:50:24 +0000 | [diff] [blame] | 380 | \end{funcdesc} |
| 381 | |
Tim Peters | 2e29bfb | 2001-09-20 19:55:29 +0000 | [diff] [blame] | 382 | \begin{funcdesc}{file}{filename\optional{, mode\optional{, bufsize}}} |
| 383 | Return a new file object (described earlier under Built-in Types). |
| 384 | The first two arguments are the same as for \code{stdio}'s |
| 385 | \cfunction{fopen()}: \var{filename} is the file name to be opened, |
| 386 | \var{mode} indicates how the file is to be opened: \code{'r'} for |
| 387 | reading, \code{'w'} for writing (truncating an existing file), and |
| 388 | \code{'a'} opens it for appending (which on \emph{some} \UNIX{} |
| 389 | systems means that \emph{all} writes append to the end of the file, |
| 390 | regardless of the current seek position). |
| 391 | |
| 392 | Modes \code{'r+'}, \code{'w+'} and \code{'a+'} open the file for |
| 393 | updating (note that \code{'w+'} truncates the file). Append |
| 394 | \code{'b'} to the mode to open the file in binary mode, on systems |
| 395 | that differentiate between binary and text files (else it is |
| 396 | ignored). If the file cannot be opened, \exception{IOError} is |
| 397 | raised. |
Barry Warsaw | 177b4a0 | 2002-05-22 20:39:43 +0000 | [diff] [blame] | 398 | |
| 399 | In addition to the standard \cfunction{fopen()} values \var{mode} |
| 400 | may be \code{'U'} or \code{'rU'}. If Python is built with universal |
| 401 | newline support (the default) the file is opened as a text file, but |
| 402 | lines may be terminated by any of \code{'\e n'}, the Unix end-of-line |
| 403 | convention, |
| 404 | \code{'\e r'}, the Macintosh convention or \code{'\e r\e n'}, the Windows |
| 405 | convention. All of these external representations are seen as |
| 406 | \code{'\e n'} |
| 407 | by the Python program. If Python is built without universal newline support |
| 408 | \var{mode} \code{'U'} is the same as normal text mode. Note that |
| 409 | file objects so opened also have an attribute called |
| 410 | \member{newlines} which has a value of \code{None} (if no newlines |
| 411 | have yet been seen), \code{'\e n'}, \code{'\e r'}, \code{'\e r\e n'}, |
| 412 | or a tuple containing all the newline types seen. |
Tim Peters | 2e29bfb | 2001-09-20 19:55:29 +0000 | [diff] [blame] | 413 | |
| 414 | If \var{mode} is omitted, it defaults to \code{'r'}. When opening a |
| 415 | binary file, you should append \code{'b'} to the \var{mode} value |
| 416 | for improved portability. (It's useful even on systems which don't |
| 417 | treat binary and text files differently, where it serves as |
| 418 | documentation.) |
| 419 | \index{line-buffered I/O}\index{unbuffered I/O}\index{buffer size, I/O} |
| 420 | \index{I/O control!buffering} |
| 421 | The optional \var{bufsize} argument specifies the |
| 422 | file's desired buffer size: 0 means unbuffered, 1 means line |
| 423 | buffered, any other positive value means use a buffer of |
| 424 | (approximately) that size. A negative \var{bufsize} means to use |
| 425 | the system default, which is usually line buffered for for tty |
| 426 | devices and fully buffered for other files. If omitted, the system |
| 427 | default is used.\footnote{ |
| 428 | Specifying a buffer size currently has no effect on systems that |
| 429 | don't have \cfunction{setvbuf()}. The interface to specify the |
| 430 | buffer size is not done using a method that calls |
| 431 | \cfunction{setvbuf()}, because that may dump core when called |
| 432 | after any I/O has been performed, and there's no reliable way to |
| 433 | determine whether this is the case.} |
| 434 | |
| 435 | The \function{file()} constructor is new in Python 2.2. The previous |
| 436 | spelling, \function{open()}, is retained for compatibility, and is an |
| 437 | alias for \function{file()}. |
| 438 | \end{funcdesc} |
| 439 | |
Fred Drake | cce1090 | 1998-03-17 06:33:25 +0000 | [diff] [blame] | 440 | \begin{funcdesc}{filter}{function, list} |
Fred Drake | eacdec6 | 2001-05-02 20:19:19 +0000 | [diff] [blame] | 441 | Construct a list from those elements of \var{list} for which |
| 442 | \var{function} returns true. \var{list} may be either a sequence, a |
| 443 | container which supports iteration, or an iterator, If \var{list} |
| 444 | is a string or a tuple, the result also has that type; otherwise it |
| 445 | is always a list. If \var{function} is \code{None}, the identity |
Fred Drake | 91f2f26 | 2001-07-06 19:28:48 +0000 | [diff] [blame] | 446 | function is assumed, that is, all elements of \var{list} that are false |
Fred Drake | eacdec6 | 2001-05-02 20:19:19 +0000 | [diff] [blame] | 447 | (zero or empty) are removed. |
Martin v. Löwis | 7472336 | 2003-05-31 08:02:38 +0000 | [diff] [blame] | 448 | |
| 449 | Note that \code{filter(function, list)} equals |
| 450 | \code{[item for item in list if function(item)]} if function is not |
| 451 | \code{None} and \code{[item for item in list if item]} if function is |
| 452 | None. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 453 | \end{funcdesc} |
| 454 | |
Raymond Hettinger | 3985df2 | 2003-06-11 08:16:06 +0000 | [diff] [blame] | 455 | \begin{funcdesc}{float}{\optional{x}} |
Guido van Rossum | 1cd26f2 | 1997-04-02 06:04:02 +0000 | [diff] [blame] | 456 | Convert a string or a number to floating point. If the argument is a |
Fred Drake | d83675f | 1998-12-07 17:13:18 +0000 | [diff] [blame] | 457 | string, it must contain a possibly signed decimal or floating point |
Fred Drake | 70a66c9 | 1999-02-18 16:08:36 +0000 | [diff] [blame] | 458 | number, possibly embedded in whitespace; this behaves identical to |
| 459 | \code{string.atof(\var{x})}. Otherwise, the argument may be a plain |
| 460 | or long integer or a floating point number, and a floating point |
| 461 | number with the same value (within Python's floating point |
Raymond Hettinger | 3985df2 | 2003-06-11 08:16:06 +0000 | [diff] [blame] | 462 | precision) is returned. If no argument is given, returns \code{0.0}. |
Fred Drake | 70a66c9 | 1999-02-18 16:08:36 +0000 | [diff] [blame] | 463 | |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 464 | \note{When passing in a string, values for NaN\index{NaN} |
Fred Drake | 70a66c9 | 1999-02-18 16:08:36 +0000 | [diff] [blame] | 465 | and Infinity\index{Infinity} may be returned, depending on the |
| 466 | underlying C library. The specific set of strings accepted which |
| 467 | cause these values to be returned depends entirely on the C library |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 468 | and is known to vary.} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 469 | \end{funcdesc} |
| 470 | |
Fred Drake | de5d5ce | 1999-07-22 19:21:45 +0000 | [diff] [blame] | 471 | \begin{funcdesc}{getattr}{object, name\optional{, default}} |
| 472 | Return the value of the named attributed of \var{object}. \var{name} |
| 473 | must be a string. If the string is the name of one of the object's |
| 474 | attributes, the result is the value of that attribute. For example, |
| 475 | \code{getattr(x, 'foobar')} is equivalent to \code{x.foobar}. If the |
| 476 | named attribute does not exist, \var{default} is returned if provided, |
| 477 | otherwise \exception{AttributeError} is raised. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 478 | \end{funcdesc} |
| 479 | |
Guido van Rossum | fb502e9 | 1995-07-07 22:58:28 +0000 | [diff] [blame] | 480 | \begin{funcdesc}{globals}{} |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 481 | Return a dictionary representing the current global symbol table. |
| 482 | This is always the dictionary of the current module (inside a |
| 483 | function or method, this is the module where it is defined, not the |
| 484 | module from which it is called). |
Guido van Rossum | fb502e9 | 1995-07-07 22:58:28 +0000 | [diff] [blame] | 485 | \end{funcdesc} |
| 486 | |
Fred Drake | cce1090 | 1998-03-17 06:33:25 +0000 | [diff] [blame] | 487 | \begin{funcdesc}{hasattr}{object, name} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 488 | The arguments are an object and a string. The result is 1 if the |
| 489 | string is the name of one of the object's attributes, 0 if not. |
Fred Drake | 5352537 | 1998-03-03 21:56:15 +0000 | [diff] [blame] | 490 | (This is implemented by calling \code{getattr(\var{object}, |
| 491 | \var{name})} and seeing whether it raises an exception or not.) |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 492 | \end{funcdesc} |
| 493 | |
| 494 | \begin{funcdesc}{hash}{object} |
| 495 | Return the hash value of the object (if it has one). Hash values |
Guido van Rossum | eb0f066 | 1997-12-30 20:38:16 +0000 | [diff] [blame] | 496 | are integers. They are used to quickly compare dictionary |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 497 | keys during a dictionary lookup. Numeric values that compare equal |
Fred Drake | 91f2f26 | 2001-07-06 19:28:48 +0000 | [diff] [blame] | 498 | have the same hash value (even if they are of different types, as is |
| 499 | the case for 1 and 1.0). |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 500 | \end{funcdesc} |
| 501 | |
Fred Drake | 732299f | 2001-12-18 16:31:08 +0000 | [diff] [blame] | 502 | \begin{funcdesc}{help}{\optional{object}} |
| 503 | Invoke the built-in help system. (This function is intended for |
| 504 | interactive use.) If no argument is given, the interactive help |
| 505 | system starts on the interpreter console. If the argument is a |
| 506 | string, then the string is looked up as the name of a module, |
| 507 | function, class, method, keyword, or documentation topic, and a |
| 508 | help page is printed on the console. If the argument is any other |
| 509 | kind of object, a help page on the object is generated. |
Fred Drake | 933f159 | 2002-04-17 12:54:04 +0000 | [diff] [blame] | 510 | \versionadded{2.2} |
Fred Drake | 732299f | 2001-12-18 16:31:08 +0000 | [diff] [blame] | 511 | \end{funcdesc} |
| 512 | |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 513 | \begin{funcdesc}{hex}{x} |
Guido van Rossum | 470be14 | 1995-03-17 16:07:09 +0000 | [diff] [blame] | 514 | Convert an integer number (of any size) to a hexadecimal string. |
Guido van Rossum | 5cd7520 | 1997-01-14 18:44:23 +0000 | [diff] [blame] | 515 | The result is a valid Python expression. Note: this always yields |
Fred Drake | 91f2f26 | 2001-07-06 19:28:48 +0000 | [diff] [blame] | 516 | an unsigned literal. For example, on a 32-bit machine, |
| 517 | \code{hex(-1)} yields \code{'0xffffffff'}. When evaluated on a |
| 518 | machine with the same word size, this literal is evaluated as -1; at |
| 519 | a different word size, it may turn up as a large positive number or |
| 520 | raise an \exception{OverflowError} exception. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 521 | \end{funcdesc} |
| 522 | |
| 523 | \begin{funcdesc}{id}{object} |
Fred Drake | 8aa3bd9 | 2000-06-29 03:46:46 +0000 | [diff] [blame] | 524 | Return the `identity' of an object. This is an integer (or long |
| 525 | integer) which is guaranteed to be unique and constant for this |
| 526 | object during its lifetime. Two objects whose lifetimes are |
| 527 | disjunct may have the same \function{id()} value. (Implementation |
| 528 | note: this is the address of the object.) |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 529 | \end{funcdesc} |
| 530 | |
Guido van Rossum | 16d6e71 | 1994-08-08 12:30:22 +0000 | [diff] [blame] | 531 | \begin{funcdesc}{input}{\optional{prompt}} |
Guido van Rossum | 777dcc6 | 1998-06-17 15:16:40 +0000 | [diff] [blame] | 532 | Equivalent to \code{eval(raw_input(\var{prompt}))}. |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 533 | \warning{This function is not safe from user errors! It |
Fred Drake | f96e0d2 | 2000-09-09 03:33:42 +0000 | [diff] [blame] | 534 | expects a valid Python expression as input; if the input is not |
| 535 | syntactically valid, a \exception{SyntaxError} will be raised. |
| 536 | Other exceptions may be raised if there is an error during |
| 537 | evaluation. (On the other hand, sometimes this is exactly what you |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 538 | need when writing a quick script for expert use.)} |
Fred Drake | f96e0d2 | 2000-09-09 03:33:42 +0000 | [diff] [blame] | 539 | |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 540 | If the \refmodule{readline} module was loaded, then |
Fred Drake | f96e0d2 | 2000-09-09 03:33:42 +0000 | [diff] [blame] | 541 | \function{input()} will use it to provide elaborate line editing and |
| 542 | history features. |
| 543 | |
| 544 | Consider using the \function{raw_input()} function for general input |
| 545 | from users. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 546 | \end{funcdesc} |
| 547 | |
Raymond Hettinger | 3985df2 | 2003-06-11 08:16:06 +0000 | [diff] [blame] | 548 | \begin{funcdesc}{int}{\optional{x\optional{, radix}}} |
Fred Drake | 1e862e8 | 2000-02-17 17:45:52 +0000 | [diff] [blame] | 549 | Convert a string or number to a plain integer. If the argument is a |
| 550 | string, it must contain a possibly signed decimal number |
Martin v. Löwis | 7472336 | 2003-05-31 08:02:38 +0000 | [diff] [blame] | 551 | representable as a Python integer, possibly embedded in whitespace. |
| 552 | The \var{radix} parameter gives the base for the |
Fred Drake | 17383b9 | 2000-11-17 19:44:14 +0000 | [diff] [blame] | 553 | conversion and may be any integer in the range [2, 36], or zero. If |
| 554 | \var{radix} is zero, the proper radix is guessed based on the |
| 555 | contents of string; the interpretation is the same as for integer |
| 556 | literals. If \var{radix} is specified and \var{x} is not a string, |
Fred Drake | 1e862e8 | 2000-02-17 17:45:52 +0000 | [diff] [blame] | 557 | \exception{TypeError} is raised. |
| 558 | Otherwise, the argument may be a plain or |
| 559 | long integer or a floating point number. Conversion of floating |
Tim Peters | 7321ec4 | 2001-07-26 20:02:17 +0000 | [diff] [blame] | 560 | point numbers to integers truncates (towards zero). |
Walter Dörwald | f171540 | 2002-11-19 20:49:15 +0000 | [diff] [blame] | 561 | If the argument is outside the integer range a long object will |
Raymond Hettinger | 3985df2 | 2003-06-11 08:16:06 +0000 | [diff] [blame] | 562 | be returned instead. If no arguments are given, returns \code{0}. |
Fred Drake | 1e862e8 | 2000-02-17 17:45:52 +0000 | [diff] [blame] | 563 | \end{funcdesc} |
| 564 | |
Guido van Rossum | 3978d75 | 1997-03-03 16:03:27 +0000 | [diff] [blame] | 565 | \begin{funcdesc}{intern}{string} |
| 566 | Enter \var{string} in the table of ``interned'' strings and return |
| 567 | the interned string -- which is \var{string} itself or a copy. |
| 568 | Interning strings is useful to gain a little performance on |
| 569 | dictionary lookup -- if the keys in a dictionary are interned, and |
| 570 | the lookup key is interned, the key comparisons (after hashing) can |
| 571 | be done by a pointer compare instead of a string compare. Normally, |
| 572 | the names used in Python programs are automatically interned, and |
| 573 | the dictionaries used to hold module, class or instance attributes |
Guido van Rossum | 45ec02a | 2002-08-19 21:43:18 +0000 | [diff] [blame] | 574 | have interned keys. \versionchanged[Interned strings are not |
| 575 | immortal (like they used to be in Python 2.2 and before); |
| 576 | you must keep a reference to the return value of \function{intern()} |
| 577 | around to benefit from it]{2.3} |
Guido van Rossum | 3978d75 | 1997-03-03 16:03:27 +0000 | [diff] [blame] | 578 | \end{funcdesc} |
| 579 | |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 580 | \begin{funcdesc}{isinstance}{object, classinfo} |
| 581 | Return true if the \var{object} argument is an instance of the |
| 582 | \var{classinfo} argument, or of a (direct or indirect) subclass |
| 583 | thereof. Also return true if \var{classinfo} is a type object and |
| 584 | \var{object} is an object of that type. If \var{object} is not a |
Walter Dörwald | 2e0b18a | 2003-01-31 17:19:08 +0000 | [diff] [blame] | 585 | class instance or an object of the given type, the function always |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 586 | returns false. If \var{classinfo} is neither a class object nor a |
| 587 | type object, it may be a tuple of class or type objects, or may |
| 588 | recursively contain other such tuples (other sequence types are not |
| 589 | accepted). If \var{classinfo} is not a class, type, or tuple of |
| 590 | classes, types, and such tuples, a \exception{TypeError} exception |
| 591 | is raised. |
| 592 | \versionchanged[Support for a tuple of type information was added]{2.2} |
Guido van Rossum | 7974b0f | 1997-10-05 18:53:00 +0000 | [diff] [blame] | 593 | \end{funcdesc} |
| 594 | |
Walter Dörwald | d9a6ad3 | 2002-12-12 16:41:44 +0000 | [diff] [blame] | 595 | \begin{funcdesc}{issubclass}{class, classinfo} |
| 596 | Return true if \var{class} is a subclass (direct or indirect) of |
| 597 | \var{classinfo}. A class is considered a subclass of itself. |
| 598 | \var{classinfo} may be a tuple of class objects, in which case every |
| 599 | entry in \var{classinfo} will be checked. In any other case, a |
| 600 | \exception{TypeError} exception is raised. |
| 601 | \versionchanged[Support for a tuple of type information was added]{2.3} |
Guido van Rossum | 7974b0f | 1997-10-05 18:53:00 +0000 | [diff] [blame] | 602 | \end{funcdesc} |
| 603 | |
Fred Drake | 00bb329 | 2001-09-06 19:04:29 +0000 | [diff] [blame] | 604 | \begin{funcdesc}{iter}{o\optional{, sentinel}} |
| 605 | Return an iterator object. The first argument is interpreted very |
| 606 | differently depending on the presence of the second argument. |
| 607 | Without a second argument, \var{o} must be a collection object which |
| 608 | supports the iteration protocol (the \method{__iter__()} method), or |
| 609 | it must support the sequence protocol (the \method{__getitem__()} |
| 610 | method with integer arguments starting at \code{0}). If it does not |
| 611 | support either of those protocols, \exception{TypeError} is raised. |
| 612 | If the second argument, \var{sentinel}, is given, then \var{o} must |
| 613 | be a callable object. The iterator created in this case will call |
| 614 | \var{o} with no arguments for each call to its \method{next()} |
| 615 | method; if the value returned is equal to \var{sentinel}, |
| 616 | \exception{StopIteration} will be raised, otherwise the value will |
| 617 | be returned. |
| 618 | \versionadded{2.2} |
| 619 | \end{funcdesc} |
| 620 | |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 621 | \begin{funcdesc}{len}{s} |
| 622 | Return the length (the number of items) of an object. The argument |
| 623 | may be a sequence (string, tuple or list) or a mapping (dictionary). |
| 624 | \end{funcdesc} |
| 625 | |
Tim Peters | 1fc240e | 2001-10-26 05:06:50 +0000 | [diff] [blame] | 626 | \begin{funcdesc}{list}{\optional{sequence}} |
Fred Drake | eacdec6 | 2001-05-02 20:19:19 +0000 | [diff] [blame] | 627 | Return a list whose items are the same and in the same order as |
| 628 | \var{sequence}'s items. \var{sequence} may be either a sequence, a |
| 629 | container that supports iteration, or an iterator object. If |
| 630 | \var{sequence} is already a list, a copy is made and returned, |
| 631 | similar to \code{\var{sequence}[:]}. For instance, |
| 632 | \code{list('abc')} returns \code{['a', 'b', 'c']} and \code{list( |
Raymond Hettinger | 3985df2 | 2003-06-11 08:16:06 +0000 | [diff] [blame] | 633 | (1, 2, 3) )} returns \code{[1, 2, 3]}. If no argument is given, |
| 634 | returns a new empty list, \code{[]}. |
Guido van Rossum | 921f32c | 1997-06-02 17:21:20 +0000 | [diff] [blame] | 635 | \end{funcdesc} |
| 636 | |
Guido van Rossum | fb502e9 | 1995-07-07 22:58:28 +0000 | [diff] [blame] | 637 | \begin{funcdesc}{locals}{} |
Raymond Hettinger | 69bf8f3 | 2003-01-04 02:16:22 +0000 | [diff] [blame] | 638 | Update and return a dictionary representing the current local symbol table. |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 639 | \warning{The contents of this dictionary should not be modified; |
| 640 | changes may not affect the values of local variables used by the |
| 641 | interpreter.} |
Guido van Rossum | fb502e9 | 1995-07-07 22:58:28 +0000 | [diff] [blame] | 642 | \end{funcdesc} |
| 643 | |
Raymond Hettinger | 3985df2 | 2003-06-11 08:16:06 +0000 | [diff] [blame] | 644 | \begin{funcdesc}{long}{\optional{x\optional{, radix}}} |
Guido van Rossum | 1cd26f2 | 1997-04-02 06:04:02 +0000 | [diff] [blame] | 645 | Convert a string or number to a long integer. If the argument is a |
Fred Drake | 9c15fa7 | 2001-01-04 05:09:16 +0000 | [diff] [blame] | 646 | string, it must contain a possibly signed number of |
Guido van Rossum | 1cd26f2 | 1997-04-02 06:04:02 +0000 | [diff] [blame] | 647 | arbitrary size, possibly embedded in whitespace; |
Fred Drake | 17383b9 | 2000-11-17 19:44:14 +0000 | [diff] [blame] | 648 | this behaves identical to \code{string.atol(\var{x})}. The |
| 649 | \var{radix} argument is interpreted in the same way as for |
| 650 | \function{int()}, and may only be given when \var{x} is a string. |
Guido van Rossum | 1cd26f2 | 1997-04-02 06:04:02 +0000 | [diff] [blame] | 651 | Otherwise, the argument may be a plain or |
Guido van Rossum | eb0f066 | 1997-12-30 20:38:16 +0000 | [diff] [blame] | 652 | long integer or a floating point number, and a long integer with |
Guido van Rossum | 1cd26f2 | 1997-04-02 06:04:02 +0000 | [diff] [blame] | 653 | the same value is returned. Conversion of floating |
Raymond Hettinger | 3985df2 | 2003-06-11 08:16:06 +0000 | [diff] [blame] | 654 | point numbers to integers truncates (towards zero). If no arguments |
| 655 | are given, returns \code{0L}. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 656 | \end{funcdesc} |
| 657 | |
Fred Drake | cce1090 | 1998-03-17 06:33:25 +0000 | [diff] [blame] | 658 | \begin{funcdesc}{map}{function, list, ...} |
Fred Drake | 91f2f26 | 2001-07-06 19:28:48 +0000 | [diff] [blame] | 659 | Apply \var{function} to every item of \var{list} and return a list |
| 660 | of the results. If additional \var{list} arguments are passed, |
| 661 | \var{function} must take that many arguments and is applied to the |
| 662 | items of all lists in parallel; if a list is shorter than another it |
| 663 | is assumed to be extended with \code{None} items. If \var{function} |
| 664 | is \code{None}, the identity function is assumed; if there are |
| 665 | multiple list arguments, \function{map()} returns a list consisting |
| 666 | of tuples containing the corresponding items from all lists (a kind |
| 667 | of transpose operation). The \var{list} arguments may be any kind |
| 668 | of sequence; the result is always a list. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 669 | \end{funcdesc} |
| 670 | |
Guido van Rossum | 5eabf38 | 1998-11-25 18:53:05 +0000 | [diff] [blame] | 671 | \begin{funcdesc}{max}{s\optional{, args...}} |
Fred Drake | 91f2f26 | 2001-07-06 19:28:48 +0000 | [diff] [blame] | 672 | With a single argument \var{s}, return the largest item of a |
| 673 | non-empty sequence (such as a string, tuple or list). With more |
| 674 | than one argument, return the largest of the arguments. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 675 | \end{funcdesc} |
| 676 | |
Guido van Rossum | 5eabf38 | 1998-11-25 18:53:05 +0000 | [diff] [blame] | 677 | \begin{funcdesc}{min}{s\optional{, args...}} |
Fred Drake | 91f2f26 | 2001-07-06 19:28:48 +0000 | [diff] [blame] | 678 | With a single argument \var{s}, return the smallest item of a |
| 679 | non-empty sequence (such as a string, tuple or list). With more |
| 680 | than one argument, return the smallest of the arguments. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 681 | \end{funcdesc} |
| 682 | |
Raymond Hettinger | 7e902b2 | 2003-06-11 09:15:26 +0000 | [diff] [blame] | 683 | \begin{funcdesc}{object}{} |
Fred Drake | f91888b | 2003-06-26 03:11:57 +0000 | [diff] [blame] | 684 | Return a new featureless object. \function{object()} is a base |
| 685 | for all new style classes. It has the methods that are common |
| 686 | to all instances of new style classes. |
| 687 | \versionadded{2.2} |
Raymond Hettinger | 7e902b2 | 2003-06-11 09:15:26 +0000 | [diff] [blame] | 688 | |
Fred Drake | f91888b | 2003-06-26 03:11:57 +0000 | [diff] [blame] | 689 | \versionchanged[This function does not accept any arguments. |
| 690 | Formerly, it accepted arguments but ignored them]{2.3} |
Raymond Hettinger | 7e902b2 | 2003-06-11 09:15:26 +0000 | [diff] [blame] | 691 | \end{funcdesc} |
| 692 | |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 693 | \begin{funcdesc}{oct}{x} |
Guido van Rossum | 470be14 | 1995-03-17 16:07:09 +0000 | [diff] [blame] | 694 | Convert an integer number (of any size) to an octal string. The |
Fred Drake | 91f2f26 | 2001-07-06 19:28:48 +0000 | [diff] [blame] | 695 | result is a valid Python expression. Note: this always yields an |
| 696 | unsigned literal. For example, on a 32-bit machine, \code{oct(-1)} |
| 697 | yields \code{'037777777777'}. When evaluated on a machine with the |
| 698 | same word size, this literal is evaluated as -1; at a different word |
Guido van Rossum | 5cd7520 | 1997-01-14 18:44:23 +0000 | [diff] [blame] | 699 | size, it may turn up as a large positive number or raise an |
Fred Drake | 5352537 | 1998-03-03 21:56:15 +0000 | [diff] [blame] | 700 | \exception{OverflowError} exception. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 701 | \end{funcdesc} |
| 702 | |
Fred Drake | cce1090 | 1998-03-17 06:33:25 +0000 | [diff] [blame] | 703 | \begin{funcdesc}{open}{filename\optional{, mode\optional{, bufsize}}} |
Tim Peters | 2e29bfb | 2001-09-20 19:55:29 +0000 | [diff] [blame] | 704 | An alias for the \function{file()} function above. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 705 | \end{funcdesc} |
| 706 | |
| 707 | \begin{funcdesc}{ord}{c} |
Fred Drake | 33d5184 | 2000-04-06 14:43:12 +0000 | [diff] [blame] | 708 | Return the \ASCII{} value of a string of one character or a Unicode |
| 709 | character. E.g., \code{ord('a')} returns the integer \code{97}, |
| 710 | \code{ord(u'\\u2020')} returns \code{8224}. This is the inverse of |
| 711 | \function{chr()} for strings and of \function{unichr()} for Unicode |
| 712 | characters. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 713 | \end{funcdesc} |
| 714 | |
Fred Drake | cce1090 | 1998-03-17 06:33:25 +0000 | [diff] [blame] | 715 | \begin{funcdesc}{pow}{x, y\optional{, z}} |
Guido van Rossum | b8b264b | 1994-08-12 13:13:50 +0000 | [diff] [blame] | 716 | Return \var{x} to the power \var{y}; if \var{z} is present, return |
| 717 | \var{x} to the power \var{y}, modulo \var{z} (computed more |
Guido van Rossum | bf5a774 | 2001-07-12 11:27:16 +0000 | [diff] [blame] | 718 | efficiently than \code{pow(\var{x}, \var{y}) \%\ \var{z}}). The |
| 719 | arguments must have numeric types. With mixed operand types, the |
| 720 | coercion rules for binary arithmetic operators apply. For int and |
| 721 | long int operands, the result has the same type as the operands |
| 722 | (after coercion) unless the second argument is negative; in that |
| 723 | case, all arguments are converted to float and a float result is |
| 724 | delivered. For example, \code{10**2} returns \code{100}, but |
| 725 | \code{10**-2} returns \code{0.01}. (This last feature was added in |
Tim Peters | 32f453e | 2001-09-03 08:35:41 +0000 | [diff] [blame] | 726 | Python 2.2. In Python 2.1 and before, if both arguments were of integer |
| 727 | types and the second argument was negative, an exception was raised.) |
Tim Peters | 2e29bfb | 2001-09-20 19:55:29 +0000 | [diff] [blame] | 728 | If the second argument is negative, the third argument must be omitted. |
Tim Peters | 32f453e | 2001-09-03 08:35:41 +0000 | [diff] [blame] | 729 | If \var{z} is present, \var{x} and \var{y} must be of integer types, |
| 730 | and \var{y} must be non-negative. (This restriction was added in |
| 731 | Python 2.2. In Python 2.1 and before, floating 3-argument \code{pow()} |
| 732 | returned platform-dependent results depending on floating-point |
| 733 | rounding accidents.) |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 734 | \end{funcdesc} |
| 735 | |
Fred Drake | 8f53cdc | 2003-05-10 19:46:39 +0000 | [diff] [blame] | 736 | \begin{funcdesc}{property}{\optional{fget\optional{, fset\optional{, |
| 737 | fdel\optional{, doc}}}}} |
Neal Norwitz | e9ce25e | 2002-12-17 01:02:57 +0000 | [diff] [blame] | 738 | Return a property attribute for new-style classes (classes that |
Fred Drake | 8f53cdc | 2003-05-10 19:46:39 +0000 | [diff] [blame] | 739 | derive from \class{object}). |
Neal Norwitz | e9ce25e | 2002-12-17 01:02:57 +0000 | [diff] [blame] | 740 | |
| 741 | \var{fget} is a function for getting an attribute value, likewise |
| 742 | \var{fset} is a function for setting, and \var{fdel} a function |
| 743 | for del'ing, an attribute. Typical use is to define a managed attribute x: |
| 744 | |
| 745 | \begin{verbatim} |
| 746 | class C(object): |
| 747 | def getx(self): return self.__x |
| 748 | def setx(self, value): self.__x = value |
| 749 | def delx(self): del self.__x |
| 750 | x = property(getx, setx, delx, "I'm the 'x' property.") |
| 751 | \end{verbatim} |
| 752 | |
| 753 | \versionadded{2.2} |
| 754 | \end{funcdesc} |
| 755 | |
Fred Drake | cce1090 | 1998-03-17 06:33:25 +0000 | [diff] [blame] | 756 | \begin{funcdesc}{range}{\optional{start,} stop\optional{, step}} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 757 | This is a versatile function to create lists containing arithmetic |
Fred Drake | 5352537 | 1998-03-03 21:56:15 +0000 | [diff] [blame] | 758 | progressions. It is most often used in \keyword{for} loops. The |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 759 | arguments must be plain integers. If the \var{step} argument is |
| 760 | omitted, it defaults to \code{1}. If the \var{start} argument is |
| 761 | omitted, it defaults to \code{0}. The full form returns a list of |
| 762 | plain integers \code{[\var{start}, \var{start} + \var{step}, |
| 763 | \var{start} + 2 * \var{step}, \ldots]}. If \var{step} is positive, |
| 764 | the last element is the largest \code{\var{start} + \var{i} * |
Guido van Rossum | 7974b0f | 1997-10-05 18:53:00 +0000 | [diff] [blame] | 765 | \var{step}} less than \var{stop}; if \var{step} is negative, the last |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 766 | element is the largest \code{\var{start} + \var{i} * \var{step}} |
Fred Drake | 6251c16 | 1998-04-03 07:15:54 +0000 | [diff] [blame] | 767 | greater than \var{stop}. \var{step} must not be zero (or else |
| 768 | \exception{ValueError} is raised). Example: |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 769 | |
Fred Drake | 1947991 | 1998-02-13 06:58:54 +0000 | [diff] [blame] | 770 | \begin{verbatim} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 771 | >>> range(10) |
| 772 | [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] |
| 773 | >>> range(1, 11) |
| 774 | [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] |
| 775 | >>> range(0, 30, 5) |
| 776 | [0, 5, 10, 15, 20, 25] |
| 777 | >>> range(0, 10, 3) |
| 778 | [0, 3, 6, 9] |
| 779 | >>> range(0, -10, -1) |
| 780 | [0, -1, -2, -3, -4, -5, -6, -7, -8, -9] |
| 781 | >>> range(0) |
| 782 | [] |
| 783 | >>> range(1, 0) |
| 784 | [] |
Fred Drake | 1947991 | 1998-02-13 06:58:54 +0000 | [diff] [blame] | 785 | \end{verbatim} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 786 | \end{funcdesc} |
| 787 | |
Guido van Rossum | 16d6e71 | 1994-08-08 12:30:22 +0000 | [diff] [blame] | 788 | \begin{funcdesc}{raw_input}{\optional{prompt}} |
| 789 | If the \var{prompt} argument is present, it is written to standard output |
| 790 | without a trailing newline. The function then reads a line from input, |
| 791 | converts it to a string (stripping a trailing newline), and returns that. |
Fred Drake | 5352537 | 1998-03-03 21:56:15 +0000 | [diff] [blame] | 792 | When \EOF{} is read, \exception{EOFError} is raised. Example: |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 793 | |
Fred Drake | 1947991 | 1998-02-13 06:58:54 +0000 | [diff] [blame] | 794 | \begin{verbatim} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 795 | >>> s = raw_input('--> ') |
| 796 | --> Monty Python's Flying Circus |
| 797 | >>> s |
Guido van Rossum | 470be14 | 1995-03-17 16:07:09 +0000 | [diff] [blame] | 798 | "Monty Python's Flying Circus" |
Fred Drake | 1947991 | 1998-02-13 06:58:54 +0000 | [diff] [blame] | 799 | \end{verbatim} |
Guido van Rossum | 921f32c | 1997-06-02 17:21:20 +0000 | [diff] [blame] | 800 | |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 801 | If the \refmodule{readline} module was loaded, then |
| 802 | \function{raw_input()} will use it to provide elaborate |
| 803 | line editing and history features. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 804 | \end{funcdesc} |
| 805 | |
Guido van Rossum | 87e611e | 1999-01-06 23:10:51 +0000 | [diff] [blame] | 806 | \begin{funcdesc}{reduce}{function, sequence\optional{, initializer}} |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 807 | Apply \var{function} of two arguments cumulatively to the items of |
| 808 | \var{sequence}, from left to right, so as to reduce the sequence to |
Fred Drake | 2095b96 | 2002-07-17 13:55:33 +0000 | [diff] [blame] | 809 | a single value. For example, \code{reduce(lambda x, y: x+y, [1, 2, |
| 810 | 3, 4, 5])} calculates \code{((((1+2)+3)+4)+5)}. If the optional |
| 811 | \var{initializer} is present, it is placed before the items of the |
| 812 | sequence in the calculation, and serves as a default when the |
| 813 | sequence is empty. If \var{initializer} is not given and |
| 814 | \var{sequence} contains only one item, the first item is returned. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 815 | \end{funcdesc} |
| 816 | |
| 817 | \begin{funcdesc}{reload}{module} |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 818 | Re-parse and re-initialize an already imported \var{module}. The |
| 819 | argument must be a module object, so it must have been successfully |
| 820 | imported before. This is useful if you have edited the module |
| 821 | source file using an external editor and want to try out the new |
| 822 | version without leaving the Python interpreter. The return value is |
| 823 | the module object (the same as the \var{module} argument). |
Guido van Rossum | 470be14 | 1995-03-17 16:07:09 +0000 | [diff] [blame] | 824 | |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 825 | There are a number of caveats: |
Guido van Rossum | 470be14 | 1995-03-17 16:07:09 +0000 | [diff] [blame] | 826 | |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 827 | If a module is syntactically correct but its initialization fails, |
| 828 | the first \keyword{import} statement for it does not bind its name |
| 829 | locally, but does store a (partially initialized) module object in |
| 830 | \code{sys.modules}. To reload the module you must first |
| 831 | \keyword{import} it again (this will bind the name to the partially |
| 832 | initialized module object) before you can \function{reload()} it. |
Guido van Rossum | 470be14 | 1995-03-17 16:07:09 +0000 | [diff] [blame] | 833 | |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 834 | When a module is reloaded, its dictionary (containing the module's |
| 835 | global variables) is retained. Redefinitions of names will override |
| 836 | the old definitions, so this is generally not a problem. If the new |
| 837 | version of a module does not define a name that was defined by the |
| 838 | old version, the old definition remains. This feature can be used |
| 839 | to the module's advantage if it maintains a global table or cache of |
| 840 | objects --- with a \keyword{try} statement it can test for the |
| 841 | table's presence and skip its initialization if desired. |
Guido van Rossum | 470be14 | 1995-03-17 16:07:09 +0000 | [diff] [blame] | 842 | |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 843 | It is legal though generally not very useful to reload built-in or |
| 844 | dynamically loaded modules, except for \refmodule{sys}, |
| 845 | \refmodule[main]{__main__} and \refmodule[builtin]{__builtin__}. In |
| 846 | many cases, however, extension modules are not designed to be |
| 847 | initialized more than once, and may fail in arbitrary ways when |
| 848 | reloaded. |
Guido van Rossum | 470be14 | 1995-03-17 16:07:09 +0000 | [diff] [blame] | 849 | |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 850 | If a module imports objects from another module using \keyword{from} |
| 851 | \ldots{} \keyword{import} \ldots{}, calling \function{reload()} for |
| 852 | the other module does not redefine the objects imported from it --- |
| 853 | one way around this is to re-execute the \keyword{from} statement, |
| 854 | another is to use \keyword{import} and qualified names |
| 855 | (\var{module}.\var{name}) instead. |
Guido van Rossum | 470be14 | 1995-03-17 16:07:09 +0000 | [diff] [blame] | 856 | |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 857 | If a module instantiates instances of a class, reloading the module |
| 858 | that defines the class does not affect the method definitions of the |
| 859 | instances --- they continue to use the old class definition. The |
| 860 | same is true for derived classes. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 861 | \end{funcdesc} |
| 862 | |
| 863 | \begin{funcdesc}{repr}{object} |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 864 | Return a string containing a printable representation of an object. |
| 865 | This is the same value yielded by conversions (reverse quotes). |
| 866 | It is sometimes useful to be able to access this operation as an |
| 867 | ordinary function. For many types, this function makes an attempt |
| 868 | to return a string that would yield an object with the same value |
| 869 | when passed to \function{eval()}. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 870 | \end{funcdesc} |
| 871 | |
Fred Drake | 607f802 | 1998-08-24 20:30:07 +0000 | [diff] [blame] | 872 | \begin{funcdesc}{round}{x\optional{, n}} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 873 | Return the floating point value \var{x} rounded to \var{n} digits |
| 874 | after the decimal point. If \var{n} is omitted, it defaults to zero. |
| 875 | The result is a floating point number. Values are rounded to the |
| 876 | closest multiple of 10 to the power minus \var{n}; if two multiples |
Fred Drake | 91f2f26 | 2001-07-06 19:28:48 +0000 | [diff] [blame] | 877 | are equally close, rounding is done away from 0 (so. for example, |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 878 | \code{round(0.5)} is \code{1.0} and \code{round(-0.5)} is \code{-1.0}). |
| 879 | \end{funcdesc} |
| 880 | |
Fred Drake | cce1090 | 1998-03-17 06:33:25 +0000 | [diff] [blame] | 881 | \begin{funcdesc}{setattr}{object, name, value} |
Fred Drake | 5352537 | 1998-03-03 21:56:15 +0000 | [diff] [blame] | 882 | This is the counterpart of \function{getattr()}. The arguments are an |
Fred Drake | 607f802 | 1998-08-24 20:30:07 +0000 | [diff] [blame] | 883 | object, a string and an arbitrary value. The string may name an |
| 884 | existing attribute or a new attribute. The function assigns the |
| 885 | value to the attribute, provided the object allows it. For example, |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 886 | \code{setattr(\var{x}, '\var{foobar}', 123)} is equivalent to |
| 887 | \code{\var{x}.\var{foobar} = 123}. |
| 888 | \end{funcdesc} |
| 889 | |
Fred Drake | cce1090 | 1998-03-17 06:33:25 +0000 | [diff] [blame] | 890 | \begin{funcdesc}{slice}{\optional{start,} stop\optional{, step}} |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 891 | Return a slice object representing the set of indices specified by |
| 892 | \code{range(\var{start}, \var{stop}, \var{step})}. The \var{start} |
| 893 | and \var{step} arguments default to None. Slice objects have |
| 894 | read-only data attributes \member{start}, \member{stop} and |
| 895 | \member{step} which merely return the argument values (or their |
| 896 | default). They have no other explicit functionality; however they |
| 897 | are used by Numerical Python\index{Numerical Python} and other third |
| 898 | party extensions. Slice objects are also generated when extended |
| 899 | indexing syntax is used. For example: \samp{a[start:stop:step]} or |
| 900 | \samp{a[start:stop, i]}. |
Guido van Rossum | 7974b0f | 1997-10-05 18:53:00 +0000 | [diff] [blame] | 901 | \end{funcdesc} |
| 902 | |
Neal Norwitz | e9ce25e | 2002-12-17 01:02:57 +0000 | [diff] [blame] | 903 | \begin{funcdesc}{staticmethod}{function} |
| 904 | Return a static method for \var{function}. |
| 905 | |
| 906 | A static method does not receive an implicit first argument. |
| 907 | To declare a static method, use this idiom: |
| 908 | |
| 909 | \begin{verbatim} |
| 910 | class C: |
| 911 | def f(arg1, arg2, ...): ... |
| 912 | f = staticmethod(f) |
| 913 | \end{verbatim} |
| 914 | |
Raymond Hettinger | 3985df2 | 2003-06-11 08:16:06 +0000 | [diff] [blame] | 915 | It can be called either on the class (such as \code{C.f()}) or on an |
| 916 | instance (such as \code{C().f()}). The instance is ignored except |
| 917 | for its class. |
Neal Norwitz | e9ce25e | 2002-12-17 01:02:57 +0000 | [diff] [blame] | 918 | |
Fred Drake | f91888b | 2003-06-26 03:11:57 +0000 | [diff] [blame] | 919 | Static methods in Python are similar to those found in Java or \Cpp. |
| 920 | For a more advanced concept, see \function{classmethod()} in this |
| 921 | section. |
Neal Norwitz | e9ce25e | 2002-12-17 01:02:57 +0000 | [diff] [blame] | 922 | \versionadded{2.2} |
| 923 | \end{funcdesc} |
| 924 | |
Fred Drake | 282be3a | 2003-04-22 14:52:08 +0000 | [diff] [blame] | 925 | \begin{funcdesc}{sum}{sequence\optional{, start}} |
| 926 | Sums \var{start} and the items of a \var{sequence}, from left to |
| 927 | right, and returns the total. \var{start} defaults to \code{0}. |
| 928 | The \var{sequence}'s items are normally numbers, and are not allowed |
| 929 | to be strings. The fast, correct way to concatenate sequence of |
| 930 | strings is by calling \code{''.join(\var{sequence})}. |
Martin v. Löwis | 7472336 | 2003-05-31 08:02:38 +0000 | [diff] [blame] | 931 | Note that \code{sum(range(n), m)} equals \code{reduce(operator.add, range(n), m)} |
Alex Martelli | a70b191 | 2003-04-22 08:12:33 +0000 | [diff] [blame] | 932 | \versionadded{2.3} |
| 933 | \end{funcdesc} |
| 934 | |
Neal Norwitz | e9ce25e | 2002-12-17 01:02:57 +0000 | [diff] [blame] | 935 | \begin{funcdesc}{super}{type\optional{object-or-type}} |
| 936 | Return the superclass of \var{type}. If the second argument is omitted |
| 937 | the super object returned is unbound. If the second argument is an |
Fred Drake | 3ede784 | 2003-07-01 16:31:26 +0000 | [diff] [blame^] | 938 | object, \code{isinstance(\var{obj}, \var{type})} must be true. If |
| 939 | the second argument is a type, \code{issubclass(\var{type2}, |
| 940 | \var{type})} must be true. |
| 941 | \function{super()} only works for new-style classes. |
Neal Norwitz | e9ce25e | 2002-12-17 01:02:57 +0000 | [diff] [blame] | 942 | |
| 943 | A typical use for calling a cooperative superclass method is: |
| 944 | \begin{verbatim} |
| 945 | class C(B): |
| 946 | def meth(self, arg): |
| 947 | super(C, self).meth(arg) |
| 948 | \end{verbatim} |
| 949 | \versionadded{2.2} |
| 950 | \end{funcdesc} |
| 951 | |
Raymond Hettinger | 3985df2 | 2003-06-11 08:16:06 +0000 | [diff] [blame] | 952 | \begin{funcdesc}{str}{\optional{object}} |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 953 | Return a string containing a nicely printable representation of an |
| 954 | object. For strings, this returns the string itself. The |
| 955 | difference with \code{repr(\var{object})} is that |
| 956 | \code{str(\var{object})} does not always attempt to return a string |
| 957 | that is acceptable to \function{eval()}; its goal is to return a |
Raymond Hettinger | 3985df2 | 2003-06-11 08:16:06 +0000 | [diff] [blame] | 958 | printable string. If no argument is given, returns the empty |
| 959 | string, \code{''}. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 960 | \end{funcdesc} |
| 961 | |
Tim Peters | 1fc240e | 2001-10-26 05:06:50 +0000 | [diff] [blame] | 962 | \begin{funcdesc}{tuple}{\optional{sequence}} |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 963 | Return a tuple whose items are the same and in the same order as |
| 964 | \var{sequence}'s items. \var{sequence} may be a sequence, a |
| 965 | container that supports iteration, or an iterator object. |
| 966 | If \var{sequence} is already a tuple, it |
| 967 | is returned unchanged. For instance, \code{tuple('abc')} returns |
| 968 | returns \code{('a', 'b', 'c')} and \code{tuple([1, 2, 3])} returns |
Raymond Hettinger | 3985df2 | 2003-06-11 08:16:06 +0000 | [diff] [blame] | 969 | \code{(1, 2, 3)}. If no argument is given, returns a new empty |
| 970 | tuple, \code{()}. |
Guido van Rossum | b8b264b | 1994-08-12 13:13:50 +0000 | [diff] [blame] | 971 | \end{funcdesc} |
| 972 | |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 973 | \begin{funcdesc}{type}{object} |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 974 | Return the type of an \var{object}. The return value is a |
| 975 | type\obindex{type} object. The standard module |
| 976 | \module{types}\refstmodindex{types} defines names for all built-in |
Fred Drake | 9482d25 | 2002-11-01 21:33:44 +0000 | [diff] [blame] | 977 | types that don't already have built-in names. |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 978 | For instance: |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 979 | |
Fred Drake | 1947991 | 1998-02-13 06:58:54 +0000 | [diff] [blame] | 980 | \begin{verbatim} |
Guido van Rossum | 470be14 | 1995-03-17 16:07:09 +0000 | [diff] [blame] | 981 | >>> import types |
Fred Drake | 9482d25 | 2002-11-01 21:33:44 +0000 | [diff] [blame] | 982 | >>> x = 'abc' |
| 983 | >>> if type(x) is str: print "It's a string" |
| 984 | ... |
| 985 | It's a string |
| 986 | >>> def f(): pass |
| 987 | ... |
| 988 | >>> if type(f) is types.FunctionType: print "It's a function" |
| 989 | ... |
| 990 | It's a function |
Fred Drake | 1947991 | 1998-02-13 06:58:54 +0000 | [diff] [blame] | 991 | \end{verbatim} |
Fred Drake | 9482d25 | 2002-11-01 21:33:44 +0000 | [diff] [blame] | 992 | |
| 993 | The \function{isinstance()} built-in function is recommended for |
| 994 | testing the type of an object. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 995 | \end{funcdesc} |
Guido van Rossum | 68cfbe7 | 1994-02-24 11:28:27 +0000 | [diff] [blame] | 996 | |
Fred Drake | 33d5184 | 2000-04-06 14:43:12 +0000 | [diff] [blame] | 997 | \begin{funcdesc}{unichr}{i} |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 998 | Return the Unicode string of one character whose Unicode code is the |
| 999 | integer \var{i}. For example, \code{unichr(97)} returns the string |
| 1000 | \code{u'a'}. This is the inverse of \function{ord()} for Unicode |
| 1001 | strings. The argument must be in the range [0..65535], inclusive. |
| 1002 | \exception{ValueError} is raised otherwise. |
| 1003 | \versionadded{2.0} |
Fred Drake | 33d5184 | 2000-04-06 14:43:12 +0000 | [diff] [blame] | 1004 | \end{funcdesc} |
| 1005 | |
Raymond Hettinger | 3985df2 | 2003-06-11 08:16:06 +0000 | [diff] [blame] | 1006 | \begin{funcdesc}{unicode}{\optional{object\optional{, encoding |
| 1007 | \optional{, errors}}}} |
Marc-André Lemburg | b5507ec | 2001-10-19 12:02:29 +0000 | [diff] [blame] | 1008 | Return the Unicode string version of \var{object} using one of the |
| 1009 | following modes: |
| 1010 | |
| 1011 | If \var{encoding} and/or \var{errors} are given, \code{unicode()} |
| 1012 | will decode the object which can either be an 8-bit string or a |
| 1013 | character buffer using the codec for \var{encoding}. The |
Fred Drake | 4254cbd | 2002-07-09 05:25:46 +0000 | [diff] [blame] | 1014 | \var{encoding} parameter is a string giving the name of an encoding; |
| 1015 | if the encoding is not known, \exception{LookupError} is raised. |
Marc-André Lemburg | b5507ec | 2001-10-19 12:02:29 +0000 | [diff] [blame] | 1016 | Error handling is done according to \var{errors}; this specifies the |
| 1017 | treatment of characters which are invalid in the input encoding. If |
| 1018 | \var{errors} is \code{'strict'} (the default), a |
| 1019 | \exception{ValueError} is raised on errors, while a value of |
| 1020 | \code{'ignore'} causes errors to be silently ignored, and a value of |
| 1021 | \code{'replace'} causes the official Unicode replacement character, |
| 1022 | \code{U+FFFD}, to be used to replace input characters which cannot |
| 1023 | be decoded. See also the \refmodule{codecs} module. |
| 1024 | |
| 1025 | If no optional parameters are given, \code{unicode()} will mimic the |
| 1026 | behaviour of \code{str()} except that it returns Unicode strings |
Fred Drake | 50e1286 | 2002-07-08 14:29:05 +0000 | [diff] [blame] | 1027 | instead of 8-bit strings. More precisely, if \var{object} is a |
| 1028 | Unicode string or subclass it will return that Unicode string without |
Fred Drake | 78e057a | 2002-06-29 16:06:47 +0000 | [diff] [blame] | 1029 | any additional decoding applied. |
| 1030 | |
| 1031 | For objects which provide a \method{__unicode__()} method, it will |
| 1032 | call this method without arguments to create a Unicode string. For |
| 1033 | all other objects, the 8-bit string version or representation is |
| 1034 | requested and then converted to a Unicode string using the codec for |
| 1035 | the default encoding in \code{'strict'} mode. |
| 1036 | |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 1037 | \versionadded{2.0} |
Fred Drake | 78e057a | 2002-06-29 16:06:47 +0000 | [diff] [blame] | 1038 | \versionchanged[Support for \method{__unicode__()} added]{2.2} |
Fred Drake | 33d5184 | 2000-04-06 14:43:12 +0000 | [diff] [blame] | 1039 | \end{funcdesc} |
| 1040 | |
Guido van Rossum | 6bb1adc | 1995-03-13 10:03:32 +0000 | [diff] [blame] | 1041 | \begin{funcdesc}{vars}{\optional{object}} |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 1042 | Without arguments, return a dictionary corresponding to the current |
| 1043 | local symbol table. With a module, class or class instance object |
| 1044 | as argument (or anything else that has a \member{__dict__} |
| 1045 | attribute), returns a dictionary corresponding to the object's |
| 1046 | symbol table. The returned dictionary should not be modified: the |
| 1047 | effects on the corresponding symbol table are undefined.\footnote{ |
| 1048 | In the current implementation, local variable bindings cannot |
| 1049 | normally be affected this way, but variables retrieved from |
| 1050 | other scopes (such as modules) can be. This may change.} |
Guido van Rossum | 1738311 | 1994-04-21 10:32:28 +0000 | [diff] [blame] | 1051 | \end{funcdesc} |
| 1052 | |
Fred Drake | cce1090 | 1998-03-17 06:33:25 +0000 | [diff] [blame] | 1053 | \begin{funcdesc}{xrange}{\optional{start,} stop\optional{, step}} |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 1054 | This function is very similar to \function{range()}, but returns an |
| 1055 | ``xrange object'' instead of a list. This is an opaque sequence |
| 1056 | type which yields the same values as the corresponding list, without |
| 1057 | actually storing them all simultaneously. The advantage of |
| 1058 | \function{xrange()} over \function{range()} is minimal (since |
| 1059 | \function{xrange()} still has to create the values when asked for |
| 1060 | them) except when a very large range is used on a memory-starved |
| 1061 | machine or when all of the range's elements are never used (such as |
| 1062 | when the loop is usually terminated with \keyword{break}). |
Guido van Rossum | 68cfbe7 | 1994-02-24 11:28:27 +0000 | [diff] [blame] | 1063 | \end{funcdesc} |
Barry Warsaw | faefa2a | 2000-08-03 15:46:17 +0000 | [diff] [blame] | 1064 | |
Fred Drake | 8b168ba | 2000-08-03 17:29:13 +0000 | [diff] [blame] | 1065 | \begin{funcdesc}{zip}{seq1, \moreargs} |
Fred Drake | 5172adc | 2001-12-03 18:35:05 +0000 | [diff] [blame] | 1066 | This function returns a list of tuples, where the \var{i}-th tuple contains |
Fred Drake | e0063d2 | 2001-10-09 19:31:08 +0000 | [diff] [blame] | 1067 | the \var{i}-th element from each of the argument sequences. At |
| 1068 | least one sequence is required, otherwise a \exception{TypeError} is |
| 1069 | raised. The returned list is truncated in length to the length of |
| 1070 | the shortest argument sequence. When there are multiple argument |
| 1071 | sequences which are all of the same length, \function{zip()} is |
| 1072 | similar to \function{map()} with an initial argument of \code{None}. |
| 1073 | With a single sequence argument, it returns a list of 1-tuples. |
| 1074 | \versionadded{2.0} |
Fred Drake | 8b168ba | 2000-08-03 17:29:13 +0000 | [diff] [blame] | 1075 | \end{funcdesc} |