cpython-lru_cache-weakref: Doc/lib/libfuncs.tex annotate

annotate Doc/lib/libfuncs.tex @ 21467:4e35fa5d5708 legacy-trunk

Add documentation for the help() built-in; contributed by Ka-Ping Yee. This is part of SF patch #494622.

author	Fred Drake <fdrake@acm.org>
date	Tue, 18 Dec 2001 16:31:08 +0000
parents	33d59e18b68d
children	8a791330fc20

rev	line source
8918 acfffe14628e New section header style. Fred Drake <fdrake@acm.org> parents: 8787 diff changeset	1 \section{Built-in Functions \label{built-in-funcs}}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	2
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	3 The Python interpreter has a number of functions built into it that
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	4 are always available. They are listed here in alphabetical order.
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	5
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	6
7277 bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous Fred Drake <fdrake@acm.org> parents: 7096 diff changeset	7 \setindexsubitem{(built-in function)}
6385 14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	8
14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	9 \begin{funcdesc}{__import__}{name\optional{, globals\optional{, locals\optional{, fromlist}}}}
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	10 This function is invoked by the \keyword{import}\stindex{import}
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	11 statement. It mainly exists so that you can replace it with another
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	12 function that has a compatible interface, in order to change the
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	13 semantics of the \keyword{import} statement. For examples of why
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	14 and how you would do this, see the standard library modules
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	15 \module{ihooks}\refstmodindex{ihooks} and
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	16 \refmodule{rexec}\refstmodindex{rexec}. See also the built-in
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	17 module \refmodule{imp}\refbimodindex{imp}, which defines some useful
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	18 operations out of which you can build your own
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	19 \function{__import__()} function.
6385 14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	20
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	21 For example, the statement \samp{import spam} results in the
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	22 following call: \code{__import__('spam',} \code{globals(),}
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	23 \code{locals(), [])}; the statement \samp{from spam.ham import eggs}
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	24 results in \samp{__import__('spam.ham', globals(), locals(),
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	25 ['eggs'])}. Note that even though \code{locals()} and
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	26 \code{['eggs']} are passed in as arguments, the
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	27 \function{__import__()} function does not set the local variable
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	28 named \code{eggs}; this is done by subsequent code that is generated
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	29 for the import statement. (In fact, the standard implementation
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	30 does not use its \var{locals} argument at all, and uses its
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	31 \var{globals} only to determine the package context of the
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	32 \keyword{import} statement.)
6385 14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	33
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	34 When the \var{name} variable is of the form \code{package.module},
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	35 normally, the top-level package (the name up till the first dot) is
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	36 returned, \emph{not} the module named by \var{name}. However, when
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	37 a non-empty \var{fromlist} argument is given, the module named by
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	38 \var{name} is returned. This is done for compatibility with the
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	39 bytecode generated for the different kinds of import statement; when
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	40 using \samp{import spam.ham.eggs}, the top-level package \code{spam}
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	41 must be placed in the importing namespace, but when using \samp{from
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	42 spam.ham import eggs}, the \code{spam.ham} subpackage must be used
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	43 to find the \code{eggs} variable. As a workaround for this
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	44 behavior, use \function{getattr()} to extract the desired
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	45 components. For example, you could define the following helper:
9583 6483dbe09f06 Add explicit example on how to import a submodule of a package using Guido van Rossum <guido@python.org> parents: 9529 diff changeset	46
6483dbe09f06 Add explicit example on how to import a submodule of a package using Guido van Rossum <guido@python.org> parents: 9529 diff changeset	47 \begin{verbatim}
6483dbe09f06 Add explicit example on how to import a submodule of a package using Guido van Rossum <guido@python.org> parents: 9529 diff changeset	48 import string
6483dbe09f06 Add explicit example on how to import a submodule of a package using Guido van Rossum <guido@python.org> parents: 9529 diff changeset	49
6483dbe09f06 Add explicit example on how to import a submodule of a package using Guido van Rossum <guido@python.org> parents: 9529 diff changeset	50 def my_import(name):
6483dbe09f06 Add explicit example on how to import a submodule of a package using Guido van Rossum <guido@python.org> parents: 9529 diff changeset	51 mod = __import__(name)
6483dbe09f06 Add explicit example on how to import a submodule of a package using Guido van Rossum <guido@python.org> parents: 9529 diff changeset	52 components = string.split(name, '.')
6483dbe09f06 Add explicit example on how to import a submodule of a package using Guido van Rossum <guido@python.org> parents: 9529 diff changeset	53 for comp in components[1:]:
6483dbe09f06 Add explicit example on how to import a submodule of a package using Guido van Rossum <guido@python.org> parents: 9529 diff changeset	54 mod = getattr(mod, comp)
6483dbe09f06 Add explicit example on how to import a submodule of a package using Guido van Rossum <guido@python.org> parents: 9529 diff changeset	55 return mod
6483dbe09f06 Add explicit example on how to import a submodule of a package using Guido van Rossum <guido@python.org> parents: 9529 diff changeset	56 \end{verbatim}
6385 14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	57 \end{funcdesc}
14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	58
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	59 \begin{funcdesc}{abs}{x}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	60 Return the absolute value of a number. The argument may be a plain
5675 fd6acad7cc7a Mention abs(complex) -> magnitude (AMK). Guido van Rossum <guido@python.org> parents: 5246 diff changeset	61 or long integer or a floating point number. If the argument is a
6385 14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	62 complex number, its magnitude is returned.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	63 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	64
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	65 \begin{funcdesc}{apply}{function, args\optional{, keywords}}
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	66 The \var{function} argument must be a callable object (a
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	67 user-defined or built-in function or method, or a class object) and
20909 669eddf470ba apply() documentation: Remove a detail about the implementation that does Fred Drake <fdrake@acm.org> parents: 20754 diff changeset	68 the \var{args} argument must be a sequence. The \var{function} is
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	69 called with \var{args} as the argument list; the number of arguments
20909 669eddf470ba apply() documentation: Remove a detail about the implementation that does Fred Drake <fdrake@acm.org> parents: 20754 diff changeset	70 is the the length of the tuple.
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	71 If the optional \var{keywords} argument is present, it must be a
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	72 dictionary whose keys are strings. It specifies keyword arguments
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	73 to be added to the end of the the argument list.
20909 669eddf470ba apply() documentation: Remove a detail about the implementation that does Fred Drake <fdrake@acm.org> parents: 20754 diff changeset	74 Calling \function{apply()} is different from just calling
20911 55a060f4173f When referring to a formal parameter from the description, use the name given Fred Drake <fdrake@acm.org> parents: 20909 diff changeset	75 \code{\var{function}(\var{args})}, since in that case there is always
20909 669eddf470ba apply() documentation: Remove a detail about the implementation that does Fred Drake <fdrake@acm.org> parents: 20754 diff changeset	76 exactly one argument. The use of \function{apply()} is equivalent
669eddf470ba apply() documentation: Remove a detail about the implementation that does Fred Drake <fdrake@acm.org> parents: 20754 diff changeset	77 to \code{\var{function}(\var{args}, *\var{keywords})}.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	78 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	79
10430 d592fe5e09d5 Document new builtin buffer(). Greg Stein. Guido van Rossum <guido@python.org> parents: 10229 diff changeset	80 \begin{funcdesc}{buffer}{object\optional{, offset\optional{, size}}}
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	81 The \var{object} argument must be an object that supports the buffer
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	82 call interface (such as strings, arrays, and buffers). A new buffer
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	83 object will be created which references the \var{object} argument.
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	84 The buffer object will be a slice from the beginning of \var{object}
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	85 (or from the specified \var{offset}). The slice will extend to the
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	86 end of \var{object} (or will have a length given by the \var{size}
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	87 argument).
10430 d592fe5e09d5 Document new builtin buffer(). Greg Stein. Guido van Rossum <guido@python.org> parents: 10229 diff changeset	88 \end{funcdesc}
d592fe5e09d5 Document new builtin buffer(). Greg Stein. Guido van Rossum <guido@python.org> parents: 10229 diff changeset	89
6385 14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	90 \begin{funcdesc}{callable}{object}
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	91 Return true if the \var{object} argument appears callable, false if
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	92 not. If this returns true, it is still possible that a call fails,
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	93 but if it is false, calling \var{object} will never succeed. Note
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	94 that classes are callable (calling a class returns a new instance);
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	95 class instances are callable if they have a \method{__call__()}
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	96 method.
6385 14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	97 \end{funcdesc}
14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	98
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	99 \begin{funcdesc}{chr}{i}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	100 Return a string of one character whose \ASCII{} code is the integer
18411 eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	101 \var{i}. For example, \code{chr(97)} returns the string \code{'a'}.
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	102 This is the inverse of \function{ord()}. The argument must be in
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	103 the range [0..255], inclusive; \exception{ValueError} will be raised
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	104 if \var{i} is outside that range.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	105 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	106
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	107 \begin{funcdesc}{cmp}{x, y}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	108 Compare the two objects \var{x} and \var{y} and return an integer
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	109 according to the outcome. The return value is negative if \code{\var{x}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	110 < \var{y}}, zero if \code{\var{x} == \var{y}} and strictly positive if
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	111 \code{\var{x} > \var{y}}.
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	112 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	113
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	114 \begin{funcdesc}{coerce}{x, y}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	115 Return a tuple consisting of the two numeric arguments converted to
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	116 a common type, using the same rules as used by arithmetic
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	117 operations.
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	118 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	119
19666 cf65ebf87560 New restriction on pow(x, y, z): If z is not None, x and y must be of Tim Peters <tim.peters@gmail.com> parents: 19503 diff changeset	120 \begin{funcdesc}{compile}{string, filename, kind\optional{,
19503 17b2afba7a6f Docs for the PEP 264 changes. Michael W. Hudson <mwh@python.net> parents: 18838 diff changeset	121 flags\optional{, dont_inherit}}}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	122 Compile the \var{string} into a code object. Code objects can be
7526 60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	123 executed by an \keyword{exec} statement or evaluated by a call to
60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	124 \function{eval()}. The \var{filename} argument should
20180 784e21bdd9a2 Fix two typos in the text about compile(), and add two caveats from Guido van Rossum <guido@python.org> parents: 20010 diff changeset	125 give the file from which the code was read; pass some recognizable value
18411 eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	126 if it wasn't read from a file (\code{'<string>'} is commonly used).
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	127 The \var{kind} argument specifies what kind of code must be
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	128 compiled; it can be \code{'exec'} if \var{string} consists of a
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	129 sequence of statements, \code{'eval'} if it consists of a single
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	130 expression, or \code{'single'} if it consists of a single
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	131 interactive statement (in the latter case, expression statements
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	132 that evaluate to something else than \code{None} will printed).
19503 17b2afba7a6f Docs for the PEP 264 changes. Michael W. Hudson <mwh@python.net> parents: 18838 diff changeset	133
20180 784e21bdd9a2 Fix two typos in the text about compile(), and add two caveats from Guido van Rossum <guido@python.org> parents: 20010 diff changeset	134 When compiling multi-line statements, two caveats apply: line
784e21bdd9a2 Fix two typos in the text about compile(), and add two caveats from Guido van Rossum <guido@python.org> parents: 20010 diff changeset	135 endings must be represented by a single newline character
784e21bdd9a2 Fix two typos in the text about compile(), and add two caveats from Guido van Rossum <guido@python.org> parents: 20010 diff changeset	136 (\code{'\e n'}), and the input must be terminated by at least one
784e21bdd9a2 Fix two typos in the text about compile(), and add two caveats from Guido van Rossum <guido@python.org> parents: 20010 diff changeset	137 newline character. If line endings are represented by
784e21bdd9a2 Fix two typos in the text about compile(), and add two caveats from Guido van Rossum <guido@python.org> parents: 20010 diff changeset	138 \code{'\e r\e n'}, use the string \method{replace()} method to
784e21bdd9a2 Fix two typos in the text about compile(), and add two caveats from Guido van Rossum <guido@python.org> parents: 20010 diff changeset	139 change them into \code{'\e n'}.
784e21bdd9a2 Fix two typos in the text about compile(), and add two caveats from Guido van Rossum <guido@python.org> parents: 20010 diff changeset	140
784e21bdd9a2 Fix two typos in the text about compile(), and add two caveats from Guido van Rossum <guido@python.org> parents: 20010 diff changeset	141 The optional arguments \var{flags} and \var{dont_inherit}
19503 17b2afba7a6f Docs for the PEP 264 changes. Michael W. Hudson <mwh@python.net> parents: 18838 diff changeset	142 (which are new in Python 2.2) control which future statements (see
17b2afba7a6f Docs for the PEP 264 changes. Michael W. Hudson <mwh@python.net> parents: 18838 diff changeset	143 \pep{236}) affect the compilation of \var{string}. If neither is
17b2afba7a6f Docs for the PEP 264 changes. Michael W. Hudson <mwh@python.net> parents: 18838 diff changeset	144 present (or both are zero) the code is compiled with those future
17b2afba7a6f Docs for the PEP 264 changes. Michael W. Hudson <mwh@python.net> parents: 18838 diff changeset	145 statements that are in effect in the code that is calling compile.
17b2afba7a6f Docs for the PEP 264 changes. Michael W. Hudson <mwh@python.net> parents: 18838 diff changeset	146 If the \var{flags} argument is given and \var{dont_inherit} is not
17b2afba7a6f Docs for the PEP 264 changes. Michael W. Hudson <mwh@python.net> parents: 18838 diff changeset	147 (or is zero) then the future statements specified by the \var{flags}
17b2afba7a6f Docs for the PEP 264 changes. Michael W. Hudson <mwh@python.net> parents: 18838 diff changeset	148 argument are used in addition to those that would be used anyway.
17b2afba7a6f Docs for the PEP 264 changes. Michael W. Hudson <mwh@python.net> parents: 18838 diff changeset	149 If \var{dont_inherit} is a non-zero integer then the \var{flags}
17b2afba7a6f Docs for the PEP 264 changes. Michael W. Hudson <mwh@python.net> parents: 18838 diff changeset	150 argument is it -- the future statements in effect around the call to
17b2afba7a6f Docs for the PEP 264 changes. Michael W. Hudson <mwh@python.net> parents: 18838 diff changeset	151 compile are ignored.
17b2afba7a6f Docs for the PEP 264 changes. Michael W. Hudson <mwh@python.net> parents: 18838 diff changeset	152
17b2afba7a6f Docs for the PEP 264 changes. Michael W. Hudson <mwh@python.net> parents: 18838 diff changeset	153 Future statemants are specified by bits which can be bitwise or-ed
17b2afba7a6f Docs for the PEP 264 changes. Michael W. Hudson <mwh@python.net> parents: 18838 diff changeset	154 together to specify multiple statements. The bitfield required to
17b2afba7a6f Docs for the PEP 264 changes. Michael W. Hudson <mwh@python.net> parents: 18838 diff changeset	155 specify a given feature can be found as the \member{compiler_flag}
17b2afba7a6f Docs for the PEP 264 changes. Michael W. Hudson <mwh@python.net> parents: 18838 diff changeset	156 attribute on the \class{_Feature} instance in the
17b2afba7a6f Docs for the PEP 264 changes. Michael W. Hudson <mwh@python.net> parents: 18838 diff changeset	157 \module{__future__} module.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	158 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	159
5246 23330a1b9594 Add complex(). Guido van Rossum <guido@python.org> parents: 5163 diff changeset	160 \begin{funcdesc}{complex}{real\optional{, imag}}
10468 9cd4fd926df6 Document complex() with string arg. Guido van Rossum <guido@python.org> parents: 10430 diff changeset	161 Create a complex number with the value \var{real} + \var{imag}*j or
21399 33d59e18b68d Ensure that complex() only accepts a string argument as the first arg, Fred Drake <fdrake@acm.org> parents: 21164 diff changeset	162 convert a string or number to a complex number. If the first
33d59e18b68d Ensure that complex() only accepts a string argument as the first arg, Fred Drake <fdrake@acm.org> parents: 21164 diff changeset	163 parameter is a string, it will be interpreted as a complex number
33d59e18b68d Ensure that complex() only accepts a string argument as the first arg, Fred Drake <fdrake@acm.org> parents: 21164 diff changeset	164 and the function must be called without a second parameter. The
33d59e18b68d Ensure that complex() only accepts a string argument as the first arg, Fred Drake <fdrake@acm.org> parents: 21164 diff changeset	165 second parameter can never be a string.
5246 23330a1b9594 Add complex(). Guido van Rossum <guido@python.org> parents: 5163 diff changeset	166 Each argument may be any numeric type (including complex).
23330a1b9594 Add complex(). Guido van Rossum <guido@python.org> parents: 5163 diff changeset	167 If \var{imag} is omitted, it defaults to zero and the function
7526 60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	168 serves as a numeric conversion function like \function{int()},
21399 33d59e18b68d Ensure that complex() only accepts a string argument as the first arg, Fred Drake <fdrake@acm.org> parents: 21164 diff changeset	169 \function{long()} and \function{float()}.
5246 23330a1b9594 Add complex(). Guido van Rossum <guido@python.org> parents: 5163 diff changeset	170 \end{funcdesc}
23330a1b9594 Add complex(). Guido van Rossum <guido@python.org> parents: 5163 diff changeset	171
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	172 \begin{funcdesc}{delattr}{object, name}
7526 60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	173 This is a relative of \function{setattr()}. The arguments are an
1782 20897816a4b6 Added docs for delattr Guido van Rossum <guido@python.org> parents: 1776 diff changeset	174 object and a string. The string must be the name
20897816a4b6 Added docs for delattr Guido van Rossum <guido@python.org> parents: 1776 diff changeset	175 of one of the object's attributes. The function deletes
20897816a4b6 Added docs for delattr Guido van Rossum <guido@python.org> parents: 1776 diff changeset	176 the named attribute, provided the object allows it. For example,
2491 fb8e08ec88dd changes (suggested) by Soren Larsen Guido van Rossum <guido@python.org> parents: 2453 diff changeset	177 \code{delattr(\var{x}, '\var{foobar}')} is equivalent to
1782 20897816a4b6 Added docs for delattr Guido van Rossum <guido@python.org> parents: 1776 diff changeset	178 \code{del \var{x}.\var{foobar}}.
20897816a4b6 Added docs for delattr Guido van Rossum <guido@python.org> parents: 1776 diff changeset	179 \end{funcdesc}
20897816a4b6 Added docs for delattr Guido van Rossum <guido@python.org> parents: 1776 diff changeset	180
20754 272336648d1f Rename "dictionary" (type and constructor) to "dict". Tim Peters <tim.peters@gmail.com> parents: 20693 diff changeset	181 \begin{funcdesc}{dict}{\optional{mapping-or-sequence}}
20683 505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the Tim Peters <tim.peters@gmail.com> parents: 20563 diff changeset	182 Return a new dictionary initialized from the optional argument.
505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the Tim Peters <tim.peters@gmail.com> parents: 20563 diff changeset	183 If an argument is not specified, return a new empty dictionary.
505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the Tim Peters <tim.peters@gmail.com> parents: 20563 diff changeset	184 If the argument is a mapping object, return a dictionary mapping the
505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the Tim Peters <tim.peters@gmail.com> parents: 20563 diff changeset	185 same keys to the same values as does the mapping object.
505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the Tim Peters <tim.peters@gmail.com> parents: 20563 diff changeset	186 Else the argument must be a sequence, a container that supports
505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the Tim Peters <tim.peters@gmail.com> parents: 20563 diff changeset	187 iteration, or an iterator object. The elements of the argument must
505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the Tim Peters <tim.peters@gmail.com> parents: 20563 diff changeset	188 each also be of one of those kinds, and each must in turn contain
505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the Tim Peters <tim.peters@gmail.com> parents: 20563 diff changeset	189 exactly two objects. The first is used as a key in the new dictionary,
505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the Tim Peters <tim.peters@gmail.com> parents: 20563 diff changeset	190 and the second as the key's value. If a given key is seen more than
505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the Tim Peters <tim.peters@gmail.com> parents: 20563 diff changeset	191 once, the last value associated with it is retained in the new
505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the Tim Peters <tim.peters@gmail.com> parents: 20563 diff changeset	192 dictionary.
505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the Tim Peters <tim.peters@gmail.com> parents: 20563 diff changeset	193 For example, these all return a dictionary equal to
505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the Tim Peters <tim.peters@gmail.com> parents: 20563 diff changeset	194 \code{\{1: 2, 2: 3\}}:
20693 6903420f0a82 Some style changes and typo fixes. Fred Drake <fdrake@acm.org> parents: 20683 diff changeset	195
6903420f0a82 Some style changes and typo fixes. Fred Drake <fdrake@acm.org> parents: 20683 diff changeset	196 \begin{itemize}
20754 272336648d1f Rename "dictionary" (type and constructor) to "dict". Tim Peters <tim.peters@gmail.com> parents: 20693 diff changeset	197 \item \code{dict(\{1: 2, 2: 3\})}
272336648d1f Rename "dictionary" (type and constructor) to "dict". Tim Peters <tim.peters@gmail.com> parents: 20693 diff changeset	198 \item \code{dict(\{1: 2, 2: 3\}.items())}
272336648d1f Rename "dictionary" (type and constructor) to "dict". Tim Peters <tim.peters@gmail.com> parents: 20693 diff changeset	199 \item \code{dict(\{1: 2, 2: 3\}.iteritems())}
272336648d1f Rename "dictionary" (type and constructor) to "dict". Tim Peters <tim.peters@gmail.com> parents: 20693 diff changeset	200 \item \code{dict(zip((1, 2), (2, 3)))}
272336648d1f Rename "dictionary" (type and constructor) to "dict". Tim Peters <tim.peters@gmail.com> parents: 20693 diff changeset	201 \item \code{dict([[2, 3], [1, 2]])}
272336648d1f Rename "dictionary" (type and constructor) to "dict". Tim Peters <tim.peters@gmail.com> parents: 20693 diff changeset	202 \item \code{dict([(i-1, i) for i in (2, 3)])}
20693 6903420f0a82 Some style changes and typo fixes. Fred Drake <fdrake@acm.org> parents: 20683 diff changeset	203 \end{itemize}
20683 505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the Tim Peters <tim.peters@gmail.com> parents: 20563 diff changeset	204 \end{funcdesc}
505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the Tim Peters <tim.peters@gmail.com> parents: 20563 diff changeset	205
8072 b8162d086850 Signature for dir() omitted the optional argument. Fred Drake <fdrake@acm.org> parents: 7832 diff changeset	206 \begin{funcdesc}{dir}{\optional{object}}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	207 Without arguments, return the list of names in the current local
7007 6f2ab4afa8f9 Correct small nits reported by Rob Hooft. Guido van Rossum <guido@python.org> parents: 6874 diff changeset	208 symbol table. With an argument, attempts to return a list of valid
6f2ab4afa8f9 Correct small nits reported by Rob Hooft. Guido van Rossum <guido@python.org> parents: 6874 diff changeset	209 attribute for that object. This information is gleaned from the
21159 6fa96b329e15 Remove most references to __members__ and __methods__, leaving only one pair Fred Drake <fdrake@acm.org> parents: 20911 diff changeset	210 object's \member{__dict__} attribute, if defined, and from the class
6fa96b329e15 Remove most references to __members__ and __methods__, leaving only one pair Fred Drake <fdrake@acm.org> parents: 20911 diff changeset	211 or type object. The list is not necessarily complete. For
18411 eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	212 example, for classes, attributes defined in base classes are not
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	213 included, and for class instances, methods are not included.
7007 6f2ab4afa8f9 Correct small nits reported by Rob Hooft. Guido van Rossum <guido@python.org> parents: 6874 diff changeset	214 The resulting list is sorted alphabetically. For example:
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	215
7277 bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous Fred Drake <fdrake@acm.org> parents: 7096 diff changeset	216 \begin{verbatim}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	217 >>> import sys
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	218 >>> dir()
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	219 ['sys']
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	220 >>> dir(sys)
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	221 ['argv', 'exit', 'modules', 'path', 'stderr', 'stdin', 'stdout']
7277 bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous Fred Drake <fdrake@acm.org> parents: 7096 diff changeset	222 \end{verbatim}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	223 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	224
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	225 \begin{funcdesc}{divmod}{a, b}
7007 6f2ab4afa8f9 Correct small nits reported by Rob Hooft. Guido van Rossum <guido@python.org> parents: 6874 diff changeset	226 Take two numbers as arguments and return a pair of numbers consisting
6f2ab4afa8f9 Correct small nits reported by Rob Hooft. Guido van Rossum <guido@python.org> parents: 6874 diff changeset	227 of their quotient and remainder when using long division. With mixed
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	228 operand types, the rules for binary arithmetic operators apply. For
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	229 plain and long integers, the result is the same as
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	230 \code{(\var{a} / \var{b}, \var{a} \%{} \var{b})}.
10834 5581307db2f7 Reflect recent patch for float % and divmod() by Tim Peters. Content Fred Drake <fdrake@acm.org> parents: 10514 diff changeset	231 For floating point numbers the result is \code{(\var{q}, \var{a} \%{}
5581307db2f7 Reflect recent patch for float % and divmod() by Tim Peters. Content Fred Drake <fdrake@acm.org> parents: 10514 diff changeset	232 \var{b})}, where \var{q} is usually \code{math.floor(\var{a} /
5581307db2f7 Reflect recent patch for float % and divmod() by Tim Peters. Content Fred Drake <fdrake@acm.org> parents: 10514 diff changeset	233 \var{b})} but may be 1 less than that. In any case \code{\var{q} *
5581307db2f7 Reflect recent patch for float % and divmod() by Tim Peters. Content Fred Drake <fdrake@acm.org> parents: 10514 diff changeset	234 \var{b} + \var{a} \%{} \var{b}} is very close to \var{a}, if
5581307db2f7 Reflect recent patch for float % and divmod() by Tim Peters. Content Fred Drake <fdrake@acm.org> parents: 10514 diff changeset	235 \code{\var{a} \%{} \var{b}} is non-zero it has the same sign as
5581307db2f7 Reflect recent patch for float % and divmod() by Tim Peters. Content Fred Drake <fdrake@acm.org> parents: 10514 diff changeset	236 \var{b}, and \code{0 <= abs(\var{a} \%{} \var{b}) < abs(\var{b})}.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	237 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	238
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	239 \begin{funcdesc}{eval}{expression\optional{, globals\optional{, locals}}}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	240 The arguments are a string and two optional dictionaries. The
2108 af41f4a21682 updated eval(), added execfile() Guido van Rossum <guido@python.org> parents: 1782 diff changeset	241 \var{expression} argument is parsed and evaluated as a Python
af41f4a21682 updated eval(), added execfile() Guido van Rossum <guido@python.org> parents: 1782 diff changeset	242 expression (technically speaking, a condition list) using the
af41f4a21682 updated eval(), added execfile() Guido van Rossum <guido@python.org> parents: 1782 diff changeset	243 \var{globals} and \var{locals} dictionaries as global and local name
2576 f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications; Guido van Rossum <guido@python.org> parents: 2527 diff changeset	244 space. If the \var{locals} dictionary is omitted it defaults to
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications; Guido van Rossum <guido@python.org> parents: 2527 diff changeset	245 the \var{globals} dictionary. If both dictionaries are omitted, the
7526 60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	246 expression is executed in the environment where \keyword{eval} is
2108 af41f4a21682 updated eval(), added execfile() Guido van Rossum <guido@python.org> parents: 1782 diff changeset	247 called. The return value is the result of the evaluated expression.
af41f4a21682 updated eval(), added execfile() Guido van Rossum <guido@python.org> parents: 1782 diff changeset	248 Syntax errors are reported as exceptions. Example:
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	249
7277 bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous Fred Drake <fdrake@acm.org> parents: 7096 diff changeset	250 \begin{verbatim}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	251 >>> x = 1
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	252 >>> print eval('x+1')
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	253 2
7277 bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous Fred Drake <fdrake@acm.org> parents: 7096 diff changeset	254 \end{verbatim}
7526 60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	255
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	256 This function can also be used to execute arbitrary code objects
18411 eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	257 (such as those created by \function{compile()}). In this case pass
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	258 a code object instead of a string. The code object must have been
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	259 compiled passing \code{'eval'} as the \var{kind} argument.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	260
2491 fb8e08ec88dd changes (suggested) by Soren Larsen Guido van Rossum <guido@python.org> parents: 2453 diff changeset	261 Hints: dynamic execution of statements is supported by the
7526 60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	262 \keyword{exec} statement. Execution of statements from a file is
60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	263 supported by the \function{execfile()} function. The
60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	264 \function{globals()} and \function{locals()} functions returns the
60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	265 current global and local dictionary, respectively, which may be
60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	266 useful to pass around for use by \function{eval()} or
60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	267 \function{execfile()}.
2108 af41f4a21682 updated eval(), added execfile() Guido van Rossum <guido@python.org> parents: 1782 diff changeset	268 \end{funcdesc}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	269
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	270 \begin{funcdesc}{execfile}{file\optional{, globals\optional{, locals}}}
2576 f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications; Guido van Rossum <guido@python.org> parents: 2527 diff changeset	271 This function is similar to the
7526 60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	272 \keyword{exec} statement, but parses a file instead of a string. It
60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	273 is different from the \keyword{import} statement in that it does not
60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	274 use the module administration --- it reads the file unconditionally
60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	275 and does not create a new module.\footnote{It is used relatively
60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	276 rarely so does not warrant being made into a statement.}
2108 af41f4a21682 updated eval(), added execfile() Guido van Rossum <guido@python.org> parents: 1782 diff changeset	277
af41f4a21682 updated eval(), added execfile() Guido van Rossum <guido@python.org> parents: 1782 diff changeset	278 The arguments are a file name and two optional dictionaries. The
af41f4a21682 updated eval(), added execfile() Guido van Rossum <guido@python.org> parents: 1782 diff changeset	279 file is parsed and evaluated as a sequence of Python statements
af41f4a21682 updated eval(), added execfile() Guido van Rossum <guido@python.org> parents: 1782 diff changeset	280 (similarly to a module) using the \var{globals} and \var{locals}
14520 addaba991077 When referring to namespaces, always say "namespaces" instead of Fred Drake <fdrake@acm.org> parents: 14487 diff changeset	281 dictionaries as global and local namespace. If the \var{locals}
2576 f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications; Guido van Rossum <guido@python.org> parents: 2527 diff changeset	282 dictionary is omitted it defaults to the \var{globals} dictionary.
2108 af41f4a21682 updated eval(), added execfile() Guido van Rossum <guido@python.org> parents: 1782 diff changeset	283 If both dictionaries are omitted, the expression is executed in the
7526 60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	284 environment where \function{execfile()} is called. The return value is
2576 f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications; Guido van Rossum <guido@python.org> parents: 2527 diff changeset	285 \code{None}.
20185 8d79db01b2ba The execfile() docs imply it acts on locals same as exec. But in truth Tim Peters <tim.peters@gmail.com> parents: 20184 diff changeset	286
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	287 \warning{The default \var{locals} act as described for function
20185 8d79db01b2ba The execfile() docs imply it acts on locals same as exec. But in truth Tim Peters <tim.peters@gmail.com> parents: 20184 diff changeset	288 \function{locals()} below: modifications to the default \var{locals}
8d79db01b2ba The execfile() docs imply it acts on locals same as exec. But in truth Tim Peters <tim.peters@gmail.com> parents: 20184 diff changeset	289 dictionary should not be attempted. Pass an explicit \var{locals}
8d79db01b2ba The execfile() docs imply it acts on locals same as exec. But in truth Tim Peters <tim.peters@gmail.com> parents: 20184 diff changeset	290 dictionary if you need to see effects of the code on \var{locals} after
8d79db01b2ba The execfile() docs imply it acts on locals same as exec. But in truth Tim Peters <tim.peters@gmail.com> parents: 20184 diff changeset	291 function \function{execfile()} returns. \function{execfile()} cannot
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	292 be used reliably to modify a function's locals.}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	293 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	294
20010 d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	295 \begin{funcdesc}{file}{filename\optional{, mode\optional{, bufsize}}}
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	296 Return a new file object (described earlier under Built-in Types).
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	297 The first two arguments are the same as for \code{stdio}'s
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	298 \cfunction{fopen()}: \var{filename} is the file name to be opened,
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	299 \var{mode} indicates how the file is to be opened: \code{'r'} for
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	300 reading, \code{'w'} for writing (truncating an existing file), and
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	301 \code{'a'} opens it for appending (which on \emph{some} \UNIX{}
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	302 systems means that \emph{all} writes append to the end of the file,
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	303 regardless of the current seek position).
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	304
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	305 Modes \code{'r+'}, \code{'w+'} and \code{'a+'} open the file for
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	306 updating (note that \code{'w+'} truncates the file). Append
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	307 \code{'b'} to the mode to open the file in binary mode, on systems
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	308 that differentiate between binary and text files (else it is
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	309 ignored). If the file cannot be opened, \exception{IOError} is
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	310 raised.
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	311
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	312 If \var{mode} is omitted, it defaults to \code{'r'}. When opening a
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	313 binary file, you should append \code{'b'} to the \var{mode} value
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	314 for improved portability. (It's useful even on systems which don't
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	315 treat binary and text files differently, where it serves as
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	316 documentation.)
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	317 \index{line-buffered I/O}\index{unbuffered I/O}\index{buffer size, I/O}
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	318 \index{I/O control!buffering}
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	319 The optional \var{bufsize} argument specifies the
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	320 file's desired buffer size: 0 means unbuffered, 1 means line
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	321 buffered, any other positive value means use a buffer of
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	322 (approximately) that size. A negative \var{bufsize} means to use
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	323 the system default, which is usually line buffered for for tty
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	324 devices and fully buffered for other files. If omitted, the system
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	325 default is used.\footnote{
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	326 Specifying a buffer size currently has no effect on systems that
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	327 don't have \cfunction{setvbuf()}. The interface to specify the
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	328 buffer size is not done using a method that calls
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	329 \cfunction{setvbuf()}, because that may dump core when called
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	330 after any I/O has been performed, and there's no reliable way to
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	331 determine whether this is the case.}
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	332
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	333 The \function{file()} constructor is new in Python 2.2. The previous
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	334 spelling, \function{open()}, is retained for compatibility, and is an
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	335 alias for \function{file()}.
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	336 \end{funcdesc}
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	337
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	338 \begin{funcdesc}{filter}{function, list}
17659 deb8a5e151a3 Update the filter() and list() descriptions to include information about Fred Drake <fdrake@acm.org> parents: 16048 diff changeset	339 Construct a list from those elements of \var{list} for which
deb8a5e151a3 Update the filter() and list() descriptions to include information about Fred Drake <fdrake@acm.org> parents: 16048 diff changeset	340 \var{function} returns true. \var{list} may be either a sequence, a
deb8a5e151a3 Update the filter() and list() descriptions to include information about Fred Drake <fdrake@acm.org> parents: 16048 diff changeset	341 container which supports iteration, or an iterator, If \var{list}
deb8a5e151a3 Update the filter() and list() descriptions to include information about Fred Drake <fdrake@acm.org> parents: 16048 diff changeset	342 is a string or a tuple, the result also has that type; otherwise it
deb8a5e151a3 Update the filter() and list() descriptions to include information about Fred Drake <fdrake@acm.org> parents: 16048 diff changeset	343 is always a list. If \var{function} is \code{None}, the identity
18411 eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	344 function is assumed, that is, all elements of \var{list} that are false
17659 deb8a5e151a3 Update the filter() and list() descriptions to include information about Fred Drake <fdrake@acm.org> parents: 16048 diff changeset	345 (zero or empty) are removed.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	346 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	347
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	348 \begin{funcdesc}{float}{x}
5246 23330a1b9594 Add complex(). Guido van Rossum <guido@python.org> parents: 5163 diff changeset	349 Convert a string or a number to floating point. If the argument is a
9602 d7986b4b9100 "singed" --> "signed" (3 places) Fred Drake <fdrake@acm.org> parents: 9583 diff changeset	350 string, it must contain a possibly signed decimal or floating point
10229 ce57eb30968a Add notes to __builtin__.float() and string.atof() that the NaN and Inf Fred Drake <fdrake@acm.org> parents: 10222 diff changeset	351 number, possibly embedded in whitespace; this behaves identical to
ce57eb30968a Add notes to __builtin__.float() and string.atof() that the NaN and Inf Fred Drake <fdrake@acm.org> parents: 10222 diff changeset	352 \code{string.atof(\var{x})}. Otherwise, the argument may be a plain
ce57eb30968a Add notes to __builtin__.float() and string.atof() that the NaN and Inf Fred Drake <fdrake@acm.org> parents: 10222 diff changeset	353 or long integer or a floating point number, and a floating point
ce57eb30968a Add notes to __builtin__.float() and string.atof() that the NaN and Inf Fred Drake <fdrake@acm.org> parents: 10222 diff changeset	354 number with the same value (within Python's floating point
ce57eb30968a Add notes to __builtin__.float() and string.atof() that the NaN and Inf Fred Drake <fdrake@acm.org> parents: 10222 diff changeset	355 precision) is returned.
ce57eb30968a Add notes to __builtin__.float() and string.atof() that the NaN and Inf Fred Drake <fdrake@acm.org> parents: 10222 diff changeset	356
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	357 \note{When passing in a string, values for NaN\index{NaN}
10229 ce57eb30968a Add notes to __builtin__.float() and string.atof() that the NaN and Inf Fred Drake <fdrake@acm.org> parents: 10222 diff changeset	358 and Infinity\index{Infinity} may be returned, depending on the
ce57eb30968a Add notes to __builtin__.float() and string.atof() that the NaN and Inf Fred Drake <fdrake@acm.org> parents: 10222 diff changeset	359 underlying C library. The specific set of strings accepted which
ce57eb30968a Add notes to __builtin__.float() and string.atof() that the NaN and Inf Fred Drake <fdrake@acm.org> parents: 10222 diff changeset	360 cause these values to be returned depends entirely on the C library
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	361 and is known to vary.}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	362 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	363
11136 c2ac896926cc Update getattr() description to document the optional third Fred Drake <fdrake@acm.org> parents: 10967 diff changeset	364 \begin{funcdesc}{getattr}{object, name\optional{, default}}
c2ac896926cc Update getattr() description to document the optional third Fred Drake <fdrake@acm.org> parents: 10967 diff changeset	365 Return the value of the named attributed of \var{object}. \var{name}
c2ac896926cc Update getattr() description to document the optional third Fred Drake <fdrake@acm.org> parents: 10967 diff changeset	366 must be a string. If the string is the name of one of the object's
c2ac896926cc Update getattr() description to document the optional third Fred Drake <fdrake@acm.org> parents: 10967 diff changeset	367 attributes, the result is the value of that attribute. For example,
c2ac896926cc Update getattr() description to document the optional third Fred Drake <fdrake@acm.org> parents: 10967 diff changeset	368 \code{getattr(x, 'foobar')} is equivalent to \code{x.foobar}. If the
c2ac896926cc Update getattr() description to document the optional third Fred Drake <fdrake@acm.org> parents: 10967 diff changeset	369 named attribute does not exist, \var{default} is returned if provided,
c2ac896926cc Update getattr() description to document the optional third Fred Drake <fdrake@acm.org> parents: 10967 diff changeset	370 otherwise \exception{AttributeError} is raised.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	371 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	372
2816 c4c39d171ec3 documented globals() and locals() Guido van Rossum <guido@python.org> parents: 2609 diff changeset	373 \begin{funcdesc}{globals}{}
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	374 Return a dictionary representing the current global symbol table.
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	375 This is always the dictionary of the current module (inside a
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	376 function or method, this is the module where it is defined, not the
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	377 module from which it is called).
2816 c4c39d171ec3 documented globals() and locals() Guido van Rossum <guido@python.org> parents: 2609 diff changeset	378 \end{funcdesc}
c4c39d171ec3 documented globals() and locals() Guido van Rossum <guido@python.org> parents: 2609 diff changeset	379
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	380 \begin{funcdesc}{hasattr}{object, name}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	381 The arguments are an object and a string. The result is 1 if the
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	382 string is the name of one of the object's attributes, 0 if not.
7526 60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	383 (This is implemented by calling \code{getattr(\var{object},
60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	384 \var{name})} and seeing whether it raises an exception or not.)
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	385 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	386
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	387 \begin{funcdesc}{hash}{object}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	388 Return the hash value of the object (if it has one). Hash values
7007 6f2ab4afa8f9 Correct small nits reported by Rob Hooft. Guido van Rossum <guido@python.org> parents: 6874 diff changeset	389 are integers. They are used to quickly compare dictionary
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	390 keys during a dictionary lookup. Numeric values that compare equal
18411 eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	391 have the same hash value (even if they are of different types, as is
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	392 the case for 1 and 1.0).
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	393 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	394
21467 4e35fa5d5708 Add documentation for the help() built-in; contributed by Ka-Ping Yee. Fred Drake <fdrake@acm.org> parents: 21399 diff changeset	395 \begin{funcdesc}{help}{\optional{object}}
4e35fa5d5708 Add documentation for the help() built-in; contributed by Ka-Ping Yee. Fred Drake <fdrake@acm.org> parents: 21399 diff changeset	396 Invoke the built-in help system. (This function is intended for
4e35fa5d5708 Add documentation for the help() built-in; contributed by Ka-Ping Yee. Fred Drake <fdrake@acm.org> parents: 21399 diff changeset	397 interactive use.) If no argument is given, the interactive help
4e35fa5d5708 Add documentation for the help() built-in; contributed by Ka-Ping Yee. Fred Drake <fdrake@acm.org> parents: 21399 diff changeset	398 system starts on the interpreter console. If the argument is a
4e35fa5d5708 Add documentation for the help() built-in; contributed by Ka-Ping Yee. Fred Drake <fdrake@acm.org> parents: 21399 diff changeset	399 string, then the string is looked up as the name of a module,
4e35fa5d5708 Add documentation for the help() built-in; contributed by Ka-Ping Yee. Fred Drake <fdrake@acm.org> parents: 21399 diff changeset	400 function, class, method, keyword, or documentation topic, and a
4e35fa5d5708 Add documentation for the help() built-in; contributed by Ka-Ping Yee. Fred Drake <fdrake@acm.org> parents: 21399 diff changeset	401 help page is printed on the console. If the argument is any other
4e35fa5d5708 Add documentation for the help() built-in; contributed by Ka-Ping Yee. Fred Drake <fdrake@acm.org> parents: 21399 diff changeset	402 kind of object, a help page on the object is generated.
4e35fa5d5708 Add documentation for the help() built-in; contributed by Ka-Ping Yee. Fred Drake <fdrake@acm.org> parents: 21399 diff changeset	403 \end{funcdesc}
4e35fa5d5708 Add documentation for the help() built-in; contributed by Ka-Ping Yee. Fred Drake <fdrake@acm.org> parents: 21399 diff changeset	404
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	405 \begin{funcdesc}{hex}{x}
2576 f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications; Guido van Rossum <guido@python.org> parents: 2527 diff changeset	406 Convert an integer number (of any size) to a hexadecimal string.
4961 5e63322f4c06 Describe new ("unsigned") behavior of hex() and oct(). Guido van Rossum <guido@python.org> parents: 4728 diff changeset	407 The result is a valid Python expression. Note: this always yields
18411 eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	408 an unsigned literal. For example, on a 32-bit machine,
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	409 \code{hex(-1)} yields \code{'0xffffffff'}. When evaluated on a
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	410 machine with the same word size, this literal is evaluated as -1; at
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	411 a different word size, it may turn up as a large positive number or
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	412 raise an \exception{OverflowError} exception.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	413 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	414
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	415 \begin{funcdesc}{id}{object}
13114 90eb58224e43 Make it clear that id() can return either a long integer or a plain integer. Fred Drake <fdrake@acm.org> parents: 12273 diff changeset	416 Return the `identity' of an object. This is an integer (or long
90eb58224e43 Make it clear that id() can return either a long integer or a plain integer. Fred Drake <fdrake@acm.org> parents: 12273 diff changeset	417 integer) which is guaranteed to be unique and constant for this
90eb58224e43 Make it clear that id() can return either a long integer or a plain integer. Fred Drake <fdrake@acm.org> parents: 12273 diff changeset	418 object during its lifetime. Two objects whose lifetimes are
90eb58224e43 Make it clear that id() can return either a long integer or a plain integer. Fred Drake <fdrake@acm.org> parents: 12273 diff changeset	419 disjunct may have the same \function{id()} value. (Implementation
90eb58224e43 Make it clear that id() can return either a long integer or a plain integer. Fred Drake <fdrake@acm.org> parents: 12273 diff changeset	420 note: this is the address of the object.)
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	421 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	422
1767 907605320a5f Lots of small corrections by Andrew Kuchling (plus all new rotor docs) Guido van Rossum <guido@python.org> parents: 1605 diff changeset	423 \begin{funcdesc}{input}{\optional{prompt}}
8516 81e29477d2a4 Change the description of input() -- it is exactly equivalent to Guido van Rossum <guido@python.org> parents: 8072 diff changeset	424 Equivalent to \code{eval(raw_input(\var{prompt}))}.
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	425 \warning{This function is not safe from user errors! It
14487 8a715d2dfeb9 Various clarifications and minor nits fixed. Affected descriptions of Fred Drake <fdrake@acm.org> parents: 14034 diff changeset	426 expects a valid Python expression as input; if the input is not
8a715d2dfeb9 Various clarifications and minor nits fixed. Affected descriptions of Fred Drake <fdrake@acm.org> parents: 14034 diff changeset	427 syntactically valid, a \exception{SyntaxError} will be raised.
8a715d2dfeb9 Various clarifications and minor nits fixed. Affected descriptions of Fred Drake <fdrake@acm.org> parents: 14034 diff changeset	428 Other exceptions may be raised if there is an error during
8a715d2dfeb9 Various clarifications and minor nits fixed. Affected descriptions of Fred Drake <fdrake@acm.org> parents: 14034 diff changeset	429 evaluation. (On the other hand, sometimes this is exactly what you
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	430 need when writing a quick script for expert use.)}
14487 8a715d2dfeb9 Various clarifications and minor nits fixed. Affected descriptions of Fred Drake <fdrake@acm.org> parents: 14034 diff changeset	431
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	432 If the \refmodule{readline} module was loaded, then
14487 8a715d2dfeb9 Various clarifications and minor nits fixed. Affected descriptions of Fred Drake <fdrake@acm.org> parents: 14034 diff changeset	433 \function{input()} will use it to provide elaborate line editing and
8a715d2dfeb9 Various clarifications and minor nits fixed. Affected descriptions of Fred Drake <fdrake@acm.org> parents: 14034 diff changeset	434 history features.
8a715d2dfeb9 Various clarifications and minor nits fixed. Affected descriptions of Fred Drake <fdrake@acm.org> parents: 14034 diff changeset	435
8a715d2dfeb9 Various clarifications and minor nits fixed. Affected descriptions of Fred Drake <fdrake@acm.org> parents: 14034 diff changeset	436 Consider using the \function{raw_input()} function for general input
8a715d2dfeb9 Various clarifications and minor nits fixed. Affected descriptions of Fred Drake <fdrake@acm.org> parents: 14034 diff changeset	437 from users.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	438 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	439
11805 bd161a908b3b Update the description of int() to include the radix parameter; Fred Drake <fdrake@acm.org> parents: 11180 diff changeset	440 \begin{funcdesc}{int}{x\optional{, radix}}
bd161a908b3b Update the description of int() to include the radix parameter; Fred Drake <fdrake@acm.org> parents: 11180 diff changeset	441 Convert a string or number to a plain integer. If the argument is a
bd161a908b3b Update the description of int() to include the radix parameter; Fred Drake <fdrake@acm.org> parents: 11180 diff changeset	442 string, it must contain a possibly signed decimal number
bd161a908b3b Update the description of int() to include the radix parameter; Fred Drake <fdrake@acm.org> parents: 11180 diff changeset	443 representable as a Python integer, possibly embedded in whitespace;
bd161a908b3b Update the description of int() to include the radix parameter; Fred Drake <fdrake@acm.org> parents: 11180 diff changeset	444 this behaves identical to \code{string.atoi(\var{x}\optional{,
bd161a908b3b Update the description of int() to include the radix parameter; Fred Drake <fdrake@acm.org> parents: 11180 diff changeset	445 \var{radix}})}. The \var{radix} parameter gives the base for the
15417 6b2524e9c672 Added information about the %r string formatting conversion. Added note Fred Drake <fdrake@acm.org> parents: 14520 diff changeset	446 conversion and may be any integer in the range [2, 36], or zero. If
6b2524e9c672 Added information about the %r string formatting conversion. Added note Fred Drake <fdrake@acm.org> parents: 14520 diff changeset	447 \var{radix} is zero, the proper radix is guessed based on the
6b2524e9c672 Added information about the %r string formatting conversion. Added note Fred Drake <fdrake@acm.org> parents: 14520 diff changeset	448 contents of string; the interpretation is the same as for integer
6b2524e9c672 Added information about the %r string formatting conversion. Added note Fred Drake <fdrake@acm.org> parents: 14520 diff changeset	449 literals. If \var{radix} is specified and \var{x} is not a string,
11805 bd161a908b3b Update the description of int() to include the radix parameter; Fred Drake <fdrake@acm.org> parents: 11180 diff changeset	450 \exception{TypeError} is raised.
bd161a908b3b Update the description of int() to include the radix parameter; Fred Drake <fdrake@acm.org> parents: 11180 diff changeset	451 Otherwise, the argument may be a plain or
bd161a908b3b Update the description of int() to include the radix parameter; Fred Drake <fdrake@acm.org> parents: 11180 diff changeset	452 long integer or a floating point number. Conversion of floating
18838 a8575f358b9f SF bug #444510: int() should guarantee truncation. Tim Peters <tim.peters@gmail.com> parents: 18501 diff changeset	453 point numbers to integers truncates (towards zero).
11805 bd161a908b3b Update the description of int() to include the radix parameter; Fred Drake <fdrake@acm.org> parents: 11180 diff changeset	454 \end{funcdesc}
bd161a908b3b Update the description of int() to include the radix parameter; Fred Drake <fdrake@acm.org> parents: 11180 diff changeset	455
5163 9063f60ea28d Added intern() Guido van Rossum <guido@python.org> parents: 4961 diff changeset	456 \begin{funcdesc}{intern}{string}
9063f60ea28d Added intern() Guido van Rossum <guido@python.org> parents: 4961 diff changeset	457 Enter \var{string} in the table of ``interned'' strings and return
9063f60ea28d Added intern() Guido van Rossum <guido@python.org> parents: 4961 diff changeset	458 the interned string -- which is \var{string} itself or a copy.
9063f60ea28d Added intern() Guido van Rossum <guido@python.org> parents: 4961 diff changeset	459 Interning strings is useful to gain a little performance on
9063f60ea28d Added intern() Guido van Rossum <guido@python.org> parents: 4961 diff changeset	460 dictionary lookup -- if the keys in a dictionary are interned, and
9063f60ea28d Added intern() Guido van Rossum <guido@python.org> parents: 4961 diff changeset	461 the lookup key is interned, the key comparisons (after hashing) can
9063f60ea28d Added intern() Guido van Rossum <guido@python.org> parents: 4961 diff changeset	462 be done by a pointer compare instead of a string compare. Normally,
9063f60ea28d Added intern() Guido van Rossum <guido@python.org> parents: 4961 diff changeset	463 the names used in Python programs are automatically interned, and
9063f60ea28d Added intern() Guido van Rossum <guido@python.org> parents: 4961 diff changeset	464 the dictionaries used to hold module, class or instance attributes
18411 eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	465 have interned keys. Interned strings are immortal (never get
5163 9063f60ea28d Added intern() Guido van Rossum <guido@python.org> parents: 4961 diff changeset	466 garbage collected).
9063f60ea28d Added intern() Guido van Rossum <guido@python.org> parents: 4961 diff changeset	467 \end{funcdesc}
9063f60ea28d Added intern() Guido van Rossum <guido@python.org> parents: 4961 diff changeset	468
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	469 \begin{funcdesc}{isinstance}{object, classinfo}
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	470 Return true if the \var{object} argument is an instance of the
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	471 \var{classinfo} argument, or of a (direct or indirect) subclass
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	472 thereof. Also return true if \var{classinfo} is a type object and
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	473 \var{object} is an object of that type. If \var{object} is not a
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	474 class instance or a object of the given type, the function always
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	475 returns false. If \var{classinfo} is neither a class object nor a
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	476 type object, it may be a tuple of class or type objects, or may
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	477 recursively contain other such tuples (other sequence types are not
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	478 accepted). If \var{classinfo} is not a class, type, or tuple of
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	479 classes, types, and such tuples, a \exception{TypeError} exception
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	480 is raised.
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	481 \versionchanged[Support for a tuple of type information was added]{2.2}
6385 14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	482 \end{funcdesc}
14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	483
14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	484 \begin{funcdesc}{issubclass}{class1, class2}
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	485 Return true if \var{class1} is a subclass (direct or indirect) of
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	486 \var{class2}. A class is considered a subclass of itself. If
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	487 either argument is not a class object, a \exception{TypeError}
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	488 exception is raised.
6385 14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	489 \end{funcdesc}
14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	490
19781 7b722b6cc77b Document the built-in iter() function. Fred Drake <fdrake@acm.org> parents: 19666 diff changeset	491 \begin{funcdesc}{iter}{o\optional{, sentinel}}
7b722b6cc77b Document the built-in iter() function. Fred Drake <fdrake@acm.org> parents: 19666 diff changeset	492 Return an iterator object. The first argument is interpreted very
7b722b6cc77b Document the built-in iter() function. Fred Drake <fdrake@acm.org> parents: 19666 diff changeset	493 differently depending on the presence of the second argument.
7b722b6cc77b Document the built-in iter() function. Fred Drake <fdrake@acm.org> parents: 19666 diff changeset	494 Without a second argument, \var{o} must be a collection object which
7b722b6cc77b Document the built-in iter() function. Fred Drake <fdrake@acm.org> parents: 19666 diff changeset	495 supports the iteration protocol (the \method{__iter__()} method), or
7b722b6cc77b Document the built-in iter() function. Fred Drake <fdrake@acm.org> parents: 19666 diff changeset	496 it must support the sequence protocol (the \method{__getitem__()}
7b722b6cc77b Document the built-in iter() function. Fred Drake <fdrake@acm.org> parents: 19666 diff changeset	497 method with integer arguments starting at \code{0}). If it does not
7b722b6cc77b Document the built-in iter() function. Fred Drake <fdrake@acm.org> parents: 19666 diff changeset	498 support either of those protocols, \exception{TypeError} is raised.
7b722b6cc77b Document the built-in iter() function. Fred Drake <fdrake@acm.org> parents: 19666 diff changeset	499 If the second argument, \var{sentinel}, is given, then \var{o} must
7b722b6cc77b Document the built-in iter() function. Fred Drake <fdrake@acm.org> parents: 19666 diff changeset	500 be a callable object. The iterator created in this case will call
7b722b6cc77b Document the built-in iter() function. Fred Drake <fdrake@acm.org> parents: 19666 diff changeset	501 \var{o} with no arguments for each call to its \method{next()}
7b722b6cc77b Document the built-in iter() function. Fred Drake <fdrake@acm.org> parents: 19666 diff changeset	502 method; if the value returned is equal to \var{sentinel},
7b722b6cc77b Document the built-in iter() function. Fred Drake <fdrake@acm.org> parents: 19666 diff changeset	503 \exception{StopIteration} will be raised, otherwise the value will
7b722b6cc77b Document the built-in iter() function. Fred Drake <fdrake@acm.org> parents: 19666 diff changeset	504 be returned.
7b722b6cc77b Document the built-in iter() function. Fred Drake <fdrake@acm.org> parents: 19666 diff changeset	505 \versionadded{2.2}
7b722b6cc77b Document the built-in iter() function. Fred Drake <fdrake@acm.org> parents: 19666 diff changeset	506 \end{funcdesc}
7b722b6cc77b Document the built-in iter() function. Fred Drake <fdrake@acm.org> parents: 19666 diff changeset	507
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	508 \begin{funcdesc}{len}{s}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	509 Return the length (the number of items) of an object. The argument
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	510 may be a sequence (string, tuple or list) or a mapping (dictionary).
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	511 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	512
20683 505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the Tim Peters <tim.peters@gmail.com> parents: 20563 diff changeset	513 \begin{funcdesc}{list}{\optional{sequence}}
17659 deb8a5e151a3 Update the filter() and list() descriptions to include information about Fred Drake <fdrake@acm.org> parents: 16048 diff changeset	514 Return a list whose items are the same and in the same order as
deb8a5e151a3 Update the filter() and list() descriptions to include information about Fred Drake <fdrake@acm.org> parents: 16048 diff changeset	515 \var{sequence}'s items. \var{sequence} may be either a sequence, a
deb8a5e151a3 Update the filter() and list() descriptions to include information about Fred Drake <fdrake@acm.org> parents: 16048 diff changeset	516 container that supports iteration, or an iterator object. If
deb8a5e151a3 Update the filter() and list() descriptions to include information about Fred Drake <fdrake@acm.org> parents: 16048 diff changeset	517 \var{sequence} is already a list, a copy is made and returned,
deb8a5e151a3 Update the filter() and list() descriptions to include information about Fred Drake <fdrake@acm.org> parents: 16048 diff changeset	518 similar to \code{\var{sequence}[:]}. For instance,
deb8a5e151a3 Update the filter() and list() descriptions to include information about Fred Drake <fdrake@acm.org> parents: 16048 diff changeset	519 \code{list('abc')} returns \code{['a', 'b', 'c']} and \code{list(
deb8a5e151a3 Update the filter() and list() descriptions to include information about Fred Drake <fdrake@acm.org> parents: 16048 diff changeset	520 (1, 2, 3) )} returns \code{[1, 2, 3]}.
5675 fd6acad7cc7a Mention abs(complex) -> magnitude (AMK). Guido van Rossum <guido@python.org> parents: 5246 diff changeset	521 \end{funcdesc}
fd6acad7cc7a Mention abs(complex) -> magnitude (AMK). Guido van Rossum <guido@python.org> parents: 5246 diff changeset	522
2816 c4c39d171ec3 documented globals() and locals() Guido van Rossum <guido@python.org> parents: 2609 diff changeset	523 \begin{funcdesc}{locals}{}
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	524 Return a dictionary representing the current local symbol table.
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	525 \warning{The contents of this dictionary should not be modified;
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	526 changes may not affect the values of local variables used by the
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	527 interpreter.}
2816 c4c39d171ec3 documented globals() and locals() Guido van Rossum <guido@python.org> parents: 2609 diff changeset	528 \end{funcdesc}
c4c39d171ec3 documented globals() and locals() Guido van Rossum <guido@python.org> parents: 2609 diff changeset	529
15417 6b2524e9c672 Added information about the %r string formatting conversion. Added note Fred Drake <fdrake@acm.org> parents: 14520 diff changeset	530 \begin{funcdesc}{long}{x\optional{, radix}}
5246 23330a1b9594 Add complex(). Guido van Rossum <guido@python.org> parents: 5163 diff changeset	531 Convert a string or number to a long integer. If the argument is a
15728 4dd0b97aa6e1 Description of long(): A string parameter is no longer required to be Fred Drake <fdrake@acm.org> parents: 15417 diff changeset	532 string, it must contain a possibly signed number of
5246 23330a1b9594 Add complex(). Guido van Rossum <guido@python.org> parents: 5163 diff changeset	533 arbitrary size, possibly embedded in whitespace;
15417 6b2524e9c672 Added information about the %r string formatting conversion. Added note Fred Drake <fdrake@acm.org> parents: 14520 diff changeset	534 this behaves identical to \code{string.atol(\var{x})}. The
6b2524e9c672 Added information about the %r string formatting conversion. Added note Fred Drake <fdrake@acm.org> parents: 14520 diff changeset	535 \var{radix} argument is interpreted in the same way as for
6b2524e9c672 Added information about the %r string formatting conversion. Added note Fred Drake <fdrake@acm.org> parents: 14520 diff changeset	536 \function{int()}, and may only be given when \var{x} is a string.
5246 23330a1b9594 Add complex(). Guido van Rossum <guido@python.org> parents: 5163 diff changeset	537 Otherwise, the argument may be a plain or
7007 6f2ab4afa8f9 Correct small nits reported by Rob Hooft. Guido van Rossum <guido@python.org> parents: 6874 diff changeset	538 long integer or a floating point number, and a long integer with
5246 23330a1b9594 Add complex(). Guido van Rossum <guido@python.org> parents: 5163 diff changeset	539 the same value is returned. Conversion of floating
20184 4c6922f266f0 Correct docs for long(float). Tim Peters <tim.peters@gmail.com> parents: 20180 diff changeset	540 point numbers to integers truncates (towards zero).
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	541 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	542
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	543 \begin{funcdesc}{map}{function, list, ...}
18411 eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	544 Apply \var{function} to every item of \var{list} and return a list
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	545 of the results. If additional \var{list} arguments are passed,
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	546 \var{function} must take that many arguments and is applied to the
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	547 items of all lists in parallel; if a list is shorter than another it
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	548 is assumed to be extended with \code{None} items. If \var{function}
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	549 is \code{None}, the identity function is assumed; if there are
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	550 multiple list arguments, \function{map()} returns a list consisting
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	551 of tuples containing the corresponding items from all lists (a kind
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	552 of transpose operation). The \var{list} arguments may be any kind
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	553 of sequence; the result is always a list.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	554 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	555
9529 d7d39260fe82 Clarify that min and max also take multiple arguments. Guido van Rossum <guido@python.org> parents: 9478 diff changeset	556 \begin{funcdesc}{max}{s\optional{, args...}}
18411 eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	557 With a single argument \var{s}, return the largest item of a
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	558 non-empty sequence (such as a string, tuple or list). With more
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	559 than one argument, return the largest of the arguments.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	560 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	561
9529 d7d39260fe82 Clarify that min and max also take multiple arguments. Guido van Rossum <guido@python.org> parents: 9478 diff changeset	562 \begin{funcdesc}{min}{s\optional{, args...}}
18411 eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	563 With a single argument \var{s}, return the smallest item of a
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	564 non-empty sequence (such as a string, tuple or list). With more
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	565 than one argument, return the smallest of the arguments.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	566 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	567
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	568 \begin{funcdesc}{oct}{x}
2576 f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications; Guido van Rossum <guido@python.org> parents: 2527 diff changeset	569 Convert an integer number (of any size) to an octal string. The
18411 eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	570 result is a valid Python expression. Note: this always yields an
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	571 unsigned literal. For example, on a 32-bit machine, \code{oct(-1)}
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	572 yields \code{'037777777777'}. When evaluated on a machine with the
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	573 same word size, this literal is evaluated as -1; at a different word
4961 5e63322f4c06 Describe new ("unsigned") behavior of hex() and oct(). Guido van Rossum <guido@python.org> parents: 4728 diff changeset	574 size, it may turn up as a large positive number or raise an
7526 60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	575 \exception{OverflowError} exception.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	576 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	577
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	578 \begin{funcdesc}{open}{filename\optional{, mode\optional{, bufsize}}}
20010 d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	579 An alias for the \function{file()} function above.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	580 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	581
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	582 \begin{funcdesc}{ord}{c}
12264 64fcae78d47a Marc-Andre Lemburg <mal@lemburg.com>: Fred Drake <fdrake@acm.org> parents: 11805 diff changeset	583 Return the \ASCII{} value of a string of one character or a Unicode
64fcae78d47a Marc-Andre Lemburg <mal@lemburg.com>: Fred Drake <fdrake@acm.org> parents: 11805 diff changeset	584 character. E.g., \code{ord('a')} returns the integer \code{97},
64fcae78d47a Marc-Andre Lemburg <mal@lemburg.com>: Fred Drake <fdrake@acm.org> parents: 11805 diff changeset	585 \code{ord(u'\\u2020')} returns \code{8224}. This is the inverse of
64fcae78d47a Marc-Andre Lemburg <mal@lemburg.com>: Fred Drake <fdrake@acm.org> parents: 11805 diff changeset	586 \function{chr()} for strings and of \function{unichr()} for Unicode
64fcae78d47a Marc-Andre Lemburg <mal@lemburg.com>: Fred Drake <fdrake@acm.org> parents: 11805 diff changeset	587 characters.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	588 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	589
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	590 \begin{funcdesc}{pow}{x, y\optional{, z}}
1776 5257af80e161 * Doc/libfuncs.tex: don't use $math$ in description of pow(x,y,z); Guido van Rossum <guido@python.org> parents: 1767 diff changeset	591 Return \var{x} to the power \var{y}; if \var{z} is present, return
5257af80e161 * Doc/libfuncs.tex: don't use $math$ in description of pow(x,y,z); Guido van Rossum <guido@python.org> parents: 1767 diff changeset	592 \var{x} to the power \var{y}, modulo \var{z} (computed more
18501 46dd873d26f6 On int/long to the negative int/long power, let float handle it Guido van Rossum <guido@python.org> parents: 18411 diff changeset	593 efficiently than \code{pow(\var{x}, \var{y}) \%\ \var{z}}). The
46dd873d26f6 On int/long to the negative int/long power, let float handle it Guido van Rossum <guido@python.org> parents: 18411 diff changeset	594 arguments must have numeric types. With mixed operand types, the
46dd873d26f6 On int/long to the negative int/long power, let float handle it Guido van Rossum <guido@python.org> parents: 18411 diff changeset	595 coercion rules for binary arithmetic operators apply. For int and
46dd873d26f6 On int/long to the negative int/long power, let float handle it Guido van Rossum <guido@python.org> parents: 18411 diff changeset	596 long int operands, the result has the same type as the operands
46dd873d26f6 On int/long to the negative int/long power, let float handle it Guido van Rossum <guido@python.org> parents: 18411 diff changeset	597 (after coercion) unless the second argument is negative; in that
46dd873d26f6 On int/long to the negative int/long power, let float handle it Guido van Rossum <guido@python.org> parents: 18411 diff changeset	598 case, all arguments are converted to float and a float result is
46dd873d26f6 On int/long to the negative int/long power, let float handle it Guido van Rossum <guido@python.org> parents: 18411 diff changeset	599 delivered. For example, \code{10**2} returns \code{100}, but
46dd873d26f6 On int/long to the negative int/long power, let float handle it Guido van Rossum <guido@python.org> parents: 18411 diff changeset	600 \code{10**-2} returns \code{0.01}. (This last feature was added in
19666 cf65ebf87560 New restriction on pow(x, y, z): If z is not None, x and y must be of Tim Peters <tim.peters@gmail.com> parents: 19503 diff changeset	601 Python 2.2. In Python 2.1 and before, if both arguments were of integer
cf65ebf87560 New restriction on pow(x, y, z): If z is not None, x and y must be of Tim Peters <tim.peters@gmail.com> parents: 19503 diff changeset	602 types and the second argument was negative, an exception was raised.)
20010 d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	603 If the second argument is negative, the third argument must be omitted.
19666 cf65ebf87560 New restriction on pow(x, y, z): If z is not None, x and y must be of Tim Peters <tim.peters@gmail.com> parents: 19503 diff changeset	604 If \var{z} is present, \var{x} and \var{y} must be of integer types,
cf65ebf87560 New restriction on pow(x, y, z): If z is not None, x and y must be of Tim Peters <tim.peters@gmail.com> parents: 19503 diff changeset	605 and \var{y} must be non-negative. (This restriction was added in
cf65ebf87560 New restriction on pow(x, y, z): If z is not None, x and y must be of Tim Peters <tim.peters@gmail.com> parents: 19503 diff changeset	606 Python 2.2. In Python 2.1 and before, floating 3-argument \code{pow()}
cf65ebf87560 New restriction on pow(x, y, z): If z is not None, x and y must be of Tim Peters <tim.peters@gmail.com> parents: 19503 diff changeset	607 returned platform-dependent results depending on floating-point
cf65ebf87560 New restriction on pow(x, y, z): If z is not None, x and y must be of Tim Peters <tim.peters@gmail.com> parents: 19503 diff changeset	608 rounding accidents.)
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	609 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	610
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	611 \begin{funcdesc}{range}{\optional{start,} stop\optional{, step}}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	612 This is a versatile function to create lists containing arithmetic
7526 60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	613 progressions. It is most often used in \keyword{for} loops. The
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	614 arguments must be plain integers. If the \var{step} argument is
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	615 omitted, it defaults to \code{1}. If the \var{start} argument is
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	616 omitted, it defaults to \code{0}. The full form returns a list of
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	617 plain integers \code{[\var{start}, \var{start} + \var{step},
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	618 \var{start} + 2 * \var{step}, \ldots]}. If \var{step} is positive,
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	619 the last element is the largest \code{\var{start} + \var{i} *
6385 14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	620 \var{step}} less than \var{stop}; if \var{step} is negative, the last
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	621 element is the largest \code{\var{start} + \var{i} * \var{step}}
7832 d14b7120c551 Small nits. Fred Drake <fdrake@acm.org> parents: 7791 diff changeset	622 greater than \var{stop}. \var{step} must not be zero (or else
d14b7120c551 Small nits. Fred Drake <fdrake@acm.org> parents: 7791 diff changeset	623 \exception{ValueError} is raised). Example:
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	624
7277 bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous Fred Drake <fdrake@acm.org> parents: 7096 diff changeset	625 \begin{verbatim}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	626 >>> range(10)
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	627 [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	628 >>> range(1, 11)
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	629 [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	630 >>> range(0, 30, 5)
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	631 [0, 5, 10, 15, 20, 25]
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	632 >>> range(0, 10, 3)
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	633 [0, 3, 6, 9]
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	634 >>> range(0, -10, -1)
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	635 [0, -1, -2, -3, -4, -5, -6, -7, -8, -9]
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	636 >>> range(0)
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	637 []
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	638 >>> range(1, 0)
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	639 []
7277 bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous Fred Drake <fdrake@acm.org> parents: 7096 diff changeset	640 \end{verbatim}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	641 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	642
1767 907605320a5f Lots of small corrections by Andrew Kuchling (plus all new rotor docs) Guido van Rossum <guido@python.org> parents: 1605 diff changeset	643 \begin{funcdesc}{raw_input}{\optional{prompt}}
907605320a5f Lots of small corrections by Andrew Kuchling (plus all new rotor docs) Guido van Rossum <guido@python.org> parents: 1605 diff changeset	644 If the \var{prompt} argument is present, it is written to standard output
907605320a5f Lots of small corrections by Andrew Kuchling (plus all new rotor docs) Guido van Rossum <guido@python.org> parents: 1605 diff changeset	645 without a trailing newline. The function then reads a line from input,
907605320a5f Lots of small corrections by Andrew Kuchling (plus all new rotor docs) Guido van Rossum <guido@python.org> parents: 1605 diff changeset	646 converts it to a string (stripping a trailing newline), and returns that.
7526 60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	647 When \EOF{} is read, \exception{EOFError} is raised. Example:
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	648
7277 bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous Fred Drake <fdrake@acm.org> parents: 7096 diff changeset	649 \begin{verbatim}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	650 >>> s = raw_input('--> ')
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	651 --> Monty Python's Flying Circus
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	652 >>> s
2576 f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications; Guido van Rossum <guido@python.org> parents: 2527 diff changeset	653 "Monty Python's Flying Circus"
7277 bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous Fred Drake <fdrake@acm.org> parents: 7096 diff changeset	654 \end{verbatim}
5675 fd6acad7cc7a Mention abs(complex) -> magnitude (AMK). Guido van Rossum <guido@python.org> parents: 5246 diff changeset	655
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	656 If the \refmodule{readline} module was loaded, then
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	657 \function{raw_input()} will use it to provide elaborate
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	658 line editing and history features.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	659 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	660
9798 9cfc53e5996e Replace the docs for reduce with an adaptation of its docstring, which Guido van Rossum <guido@python.org> parents: 9602 diff changeset	661 \begin{funcdesc}{reduce}{function, sequence\optional{, initializer}}
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	662 Apply \var{function} of two arguments cumulatively to the items of
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	663 \var{sequence}, from left to right, so as to reduce the sequence to
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	664 a single value. For example,
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	665 \code{reduce(lambda x, y: x+y, [1, 2, 3, 4, 5])} calculates
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	666 \code{((((1+2)+3)+4)+5)}.
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	667 If the optional \var{initializer} is present, it is placed before
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	668 the items of the sequence in the calculation, and serves as a
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	669 default when the sequence is empty.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	670 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	671
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	672 \begin{funcdesc}{reload}{module}
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	673 Re-parse and re-initialize an already imported \var{module}. The
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	674 argument must be a module object, so it must have been successfully
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	675 imported before. This is useful if you have edited the module
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	676 source file using an external editor and want to try out the new
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	677 version without leaving the Python interpreter. The return value is
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	678 the module object (the same as the \var{module} argument).
2576 f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications; Guido van Rossum <guido@python.org> parents: 2527 diff changeset	679
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	680 There are a number of caveats:
2576 f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications; Guido van Rossum <guido@python.org> parents: 2527 diff changeset	681
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	682 If a module is syntactically correct but its initialization fails,
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	683 the first \keyword{import} statement for it does not bind its name
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	684 locally, but does store a (partially initialized) module object in
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	685 \code{sys.modules}. To reload the module you must first
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	686 \keyword{import} it again (this will bind the name to the partially
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	687 initialized module object) before you can \function{reload()} it.
2576 f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications; Guido van Rossum <guido@python.org> parents: 2527 diff changeset	688
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	689 When a module is reloaded, its dictionary (containing the module's
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	690 global variables) is retained. Redefinitions of names will override
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	691 the old definitions, so this is generally not a problem. If the new
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	692 version of a module does not define a name that was defined by the
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	693 old version, the old definition remains. This feature can be used
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	694 to the module's advantage if it maintains a global table or cache of
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	695 objects --- with a \keyword{try} statement it can test for the
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	696 table's presence and skip its initialization if desired.
2576 f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications; Guido van Rossum <guido@python.org> parents: 2527 diff changeset	697
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	698 It is legal though generally not very useful to reload built-in or
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	699 dynamically loaded modules, except for \refmodule{sys},
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	700 \refmodule[main]{__main__} and \refmodule[builtin]{__builtin__}. In
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	701 many cases, however, extension modules are not designed to be
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	702 initialized more than once, and may fail in arbitrary ways when
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	703 reloaded.
2576 f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications; Guido van Rossum <guido@python.org> parents: 2527 diff changeset	704
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	705 If a module imports objects from another module using \keyword{from}
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	706 \ldots{} \keyword{import} \ldots{}, calling \function{reload()} for
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	707 the other module does not redefine the objects imported from it ---
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	708 one way around this is to re-execute the \keyword{from} statement,
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	709 another is to use \keyword{import} and qualified names
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	710 (\var{module}.\var{name}) instead.
2576 f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications; Guido van Rossum <guido@python.org> parents: 2527 diff changeset	711
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	712 If a module instantiates instances of a class, reloading the module
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	713 that defines the class does not affect the method definitions of the
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	714 instances --- they continue to use the old class definition. The
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	715 same is true for derived classes.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	716 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	717
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	718 \begin{funcdesc}{repr}{object}
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	719 Return a string containing a printable representation of an object.
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	720 This is the same value yielded by conversions (reverse quotes).
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	721 It is sometimes useful to be able to access this operation as an
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	722 ordinary function. For many types, this function makes an attempt
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	723 to return a string that would yield an object with the same value
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	724 when passed to \function{eval()}.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	725 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	726
9036 18697f59fd48 round(): Mark the second (optional) parameter as optional, since it's Fred Drake <fdrake@acm.org> parents: 8918 diff changeset	727 \begin{funcdesc}{round}{x\optional{, n}}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	728 Return the floating point value \var{x} rounded to \var{n} digits
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	729 after the decimal point. If \var{n} is omitted, it defaults to zero.
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	730 The result is a floating point number. Values are rounded to the
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	731 closest multiple of 10 to the power minus \var{n}; if two multiples
18411 eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make Fred Drake <fdrake@acm.org> parents: 17837 diff changeset	732 are equally close, rounding is done away from 0 (so. for example,
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	733 \code{round(0.5)} is \code{1.0} and \code{round(-0.5)} is \code{-1.0}).
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	734 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	735
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	736 \begin{funcdesc}{setattr}{object, name, value}
7526 60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	737 This is the counterpart of \function{getattr()}. The arguments are an
9036 18697f59fd48 round(): Mark the second (optional) parameter as optional, since it's Fred Drake <fdrake@acm.org> parents: 8918 diff changeset	738 object, a string and an arbitrary value. The string may name an
18697f59fd48 round(): Mark the second (optional) parameter as optional, since it's Fred Drake <fdrake@acm.org> parents: 8918 diff changeset	739 existing attribute or a new attribute. The function assigns the
18697f59fd48 round(): Mark the second (optional) parameter as optional, since it's Fred Drake <fdrake@acm.org> parents: 8918 diff changeset	740 value to the attribute, provided the object allows it. For example,
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	741 \code{setattr(\var{x}, '\var{foobar}', 123)} is equivalent to
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	742 \code{\var{x}.\var{foobar} = 123}.
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	743 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	744
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	745 \begin{funcdesc}{slice}{\optional{start,} stop\optional{, step}}
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	746 Return a slice object representing the set of indices specified by
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	747 \code{range(\var{start}, \var{stop}, \var{step})}. The \var{start}
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	748 and \var{step} arguments default to None. Slice objects have
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	749 read-only data attributes \member{start}, \member{stop} and
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	750 \member{step} which merely return the argument values (or their
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	751 default). They have no other explicit functionality; however they
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	752 are used by Numerical Python\index{Numerical Python} and other third
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	753 party extensions. Slice objects are also generated when extended
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	754 indexing syntax is used. For example: \samp{a[start:stop:step]} or
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	755 \samp{a[start:stop, i]}.
6385 14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	756 \end{funcdesc}
14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	757
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	758 \begin{funcdesc}{str}{object}
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	759 Return a string containing a nicely printable representation of an
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	760 object. For strings, this returns the string itself. The
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	761 difference with \code{repr(\var{object})} is that
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	762 \code{str(\var{object})} does not always attempt to return a string
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	763 that is acceptable to \function{eval()}; its goal is to return a
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	764 printable string.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	765 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	766
20683 505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the Tim Peters <tim.peters@gmail.com> parents: 20563 diff changeset	767 \begin{funcdesc}{tuple}{\optional{sequence}}
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	768 Return a tuple whose items are the same and in the same order as
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	769 \var{sequence}'s items. \var{sequence} may be a sequence, a
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	770 container that supports iteration, or an iterator object.
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	771 If \var{sequence} is already a tuple, it
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	772 is returned unchanged. For instance, \code{tuple('abc')} returns
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	773 returns \code{('a', 'b', 'c')} and \code{tuple([1, 2, 3])} returns
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	774 \code{(1, 2, 3)}.
1776 5257af80e161 * Doc/libfuncs.tex: don't use $math$ in description of pow(x,y,z); Guido van Rossum <guido@python.org> parents: 1767 diff changeset	775 \end{funcdesc}
5257af80e161 * Doc/libfuncs.tex: don't use $math$ in description of pow(x,y,z); Guido van Rossum <guido@python.org> parents: 1767 diff changeset	776
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	777 \begin{funcdesc}{type}{object}
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	778 Return the type of an \var{object}. The return value is a
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	779 type\obindex{type} object. The standard module
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	780 \module{types}\refstmodindex{types} defines names for all built-in
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	781 types.
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	782 For instance:
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	783
7277 bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous Fred Drake <fdrake@acm.org> parents: 7096 diff changeset	784 \begin{verbatim}
2576 f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications; Guido van Rossum <guido@python.org> parents: 2527 diff changeset	785 >>> import types
8534 5f5b492d1804 Revert the change of revision 1.30. While it's in general a laudable Guido van Rossum <guido@python.org> parents: 8530 diff changeset	786 >>> if type(x) == types.StringType: print "It's a string"
7277 bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous Fred Drake <fdrake@acm.org> parents: 7096 diff changeset	787 \end{verbatim}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	788 \end{funcdesc}
1560 274b93b12113 Documented xrange; crossreffed lambda a bit more Guido van Rossum <guido@python.org> parents: 1471 diff changeset	789
12264 64fcae78d47a Marc-Andre Lemburg <mal@lemburg.com>: Fred Drake <fdrake@acm.org> parents: 11805 diff changeset	790 \begin{funcdesc}{unichr}{i}
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	791 Return the Unicode string of one character whose Unicode code is the
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	792 integer \var{i}. For example, \code{unichr(97)} returns the string
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	793 \code{u'a'}. This is the inverse of \function{ord()} for Unicode
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	794 strings. The argument must be in the range [0..65535], inclusive.
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	795 \exception{ValueError} is raised otherwise.
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	796 \versionadded{2.0}
12264 64fcae78d47a Marc-Andre Lemburg <mal@lemburg.com>: Fred Drake <fdrake@acm.org> parents: 11805 diff changeset	797 \end{funcdesc}
64fcae78d47a Marc-Andre Lemburg <mal@lemburg.com>: Fred Drake <fdrake@acm.org> parents: 11805 diff changeset	798
20563 9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	799 \begin{funcdesc}{unicode}{object\optional{, encoding\optional{, errors}}}
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	800 Return the Unicode string version of \var{object} using one of the
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	801 following modes:
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	802
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	803 If \var{encoding} and/or \var{errors} are given, \code{unicode()}
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	804 will decode the object which can either be an 8-bit string or a
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	805 character buffer using the codec for \var{encoding}. The
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	806 \var{encoding} parameter is a string giving the name of an encoding.
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	807 Error handling is done according to \var{errors}; this specifies the
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	808 treatment of characters which are invalid in the input encoding. If
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	809 \var{errors} is \code{'strict'} (the default), a
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	810 \exception{ValueError} is raised on errors, while a value of
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	811 \code{'ignore'} causes errors to be silently ignored, and a value of
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	812 \code{'replace'} causes the official Unicode replacement character,
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	813 \code{U+FFFD}, to be used to replace input characters which cannot
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	814 be decoded. See also the \refmodule{codecs} module.
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	815
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	816 If no optional parameters are given, \code{unicode()} will mimic the
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	817 behaviour of \code{str()} except that it returns Unicode strings
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	818 instead of 8-bit strings. More precisely, if \var{object} is an
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	819 Unicode string or subclass it will return a Unicode string without
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	820 any additional decoding applied. For objects which provide a
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	821 \code{__unicode__} method, it will call this method without
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	822 arguments to create a Unicode string. For all other objects, the
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	823 8-bit string version or representation is requested and then
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	824 converted to a Unicode string using the codec for the default
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	825 encoding in \code{'strict'} mode.
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	826 \versionadded{2.0}
12264 64fcae78d47a Marc-Andre Lemburg <mal@lemburg.com>: Fred Drake <fdrake@acm.org> parents: 11805 diff changeset	827 \end{funcdesc}
64fcae78d47a Marc-Andre Lemburg <mal@lemburg.com>: Fred Drake <fdrake@acm.org> parents: 11805 diff changeset	828
2527 815dfaa6a778 small changes by Soren Larsen Guido van Rossum <guido@python.org> parents: 2491 diff changeset	829 \begin{funcdesc}{vars}{\optional{object}}
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	830 Without arguments, return a dictionary corresponding to the current
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	831 local symbol table. With a module, class or class instance object
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	832 as argument (or anything else that has a \member{__dict__}
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	833 attribute), returns a dictionary corresponding to the object's
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	834 symbol table. The returned dictionary should not be modified: the
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	835 effects on the corresponding symbol table are undefined.\footnote{
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	836 In the current implementation, local variable bindings cannot
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	837 normally be affected this way, but variables retrieved from
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	838 other scopes (such as modules) can be. This may change.}
1591 ac9e12b4ea8c Documented new built-in function vars(). Guido van Rossum <guido@python.org> parents: 1560 diff changeset	839 \end{funcdesc}
ac9e12b4ea8c Documented new built-in function vars(). Guido van Rossum <guido@python.org> parents: 1560 diff changeset	840
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	841 \begin{funcdesc}{xrange}{\optional{start,} stop\optional{, step}}
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	842 This function is very similar to \function{range()}, but returns an
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	843 ``xrange object'' instead of a list. This is an opaque sequence
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	844 type which yields the same values as the corresponding list, without
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	845 actually storing them all simultaneously. The advantage of
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	846 \function{xrange()} over \function{range()} is minimal (since
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	847 \function{xrange()} still has to create the values when asked for
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	848 them) except when a very large range is used on a memory-starved
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	849 machine or when all of the range's elements are never used (such as
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	850 when the loop is usually terminated with \keyword{break}).
1560 274b93b12113 Documented xrange; crossreffed lambda a bit more Guido van Rossum <guido@python.org> parents: 1471 diff changeset	851 \end{funcdesc}
13823 eeed7bc8a283 Both PEP 201 Lockstep Iteration and SF patch #101030 have been Barry Warsaw <barry@python.org> parents: 13222 diff changeset	852
13833 5136e37ff548 int() description: Fix markup to avoid image generation for math mode. Fred Drake <fdrake@acm.org> parents: 13823 diff changeset	853 \begin{funcdesc}{zip}{seq1, \moreargs}
21164 21ac55fb2dd8 Minor clarification of the zip() description, based on a comment sent to Fred Drake <fdrake@acm.org> parents: 21159 diff changeset	854 This function returns a list of tuples, where the \var{i}-th tuple contains
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	855 the \var{i}-th element from each of the argument sequences. At
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	856 least one sequence is required, otherwise a \exception{TypeError} is
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	857 raised. The returned list is truncated in length to the length of
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	858 the shortest argument sequence. When there are multiple argument
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	859 sequences which are all of the same length, \function{zip()} is
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	860 similar to \function{map()} with an initial argument of \code{None}.
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	861 With a single sequence argument, it returns a list of 1-tuples.
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	862 \versionadded{2.0}
13833 5136e37ff548 int() description: Fix markup to avoid image generation for math mode. Fred Drake <fdrake@acm.org> parents: 13823 diff changeset	863 \end{funcdesc}

Mercurial > cpython-lru_cache-weakref

annotate Doc/lib/libfuncs.tex @ 21467:4e35fa5d5708 legacy-trunk