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

annotate Doc/lib/libfuncs.tex @ 27998:e27f58a50737 legacy-trunk

SF bug #690377: Dud footnote reference in distutils docs

author	Raymond Hettinger <python@rcn.com>
date	Fri, 21 Feb 2003 02:47:09 +0000
parents	c267f28724dd
children	13d0a3c4e465

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
25887 529da505eabc Modify example to use string methods instead of the string module. Fred Drake <fdrake@acm.org> parents: 25408 diff changeset	40 using \samp{import spam.ham.eggs}, the top-level package \module{spam}
20341 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 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	49 mod = __import__(name)
25887 529da505eabc Modify example to use string methods instead of the string module. Fred Drake <fdrake@acm.org> parents: 25408 diff changeset	50 components = name.split('.')
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	51 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	52 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	53 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	54 \end{verbatim}
6385 14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	55 \end{funcdesc}
14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	56
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	57 \begin{funcdesc}{abs}{x}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	58 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	59 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	60 complex number, its magnitude is returned.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	61 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	62
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	63 \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	64 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	65 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	66 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	67 called with \var{args} as the argument list; the number of arguments
25121 c7310f348c78 Fix typo Raymond Hettinger <python@rcn.com> parents: 24941 diff changeset	68 is 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	69 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	70 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	71 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	72 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	73 \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	74 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	75 to \code{\var{function}(\var{args}, *\var{keywords})}.
24941 67048454aa1e Add a note that apply() is needed since the extended call syntax is Fred Drake <fdrake@acm.org> parents: 24901 diff changeset	76 Use of \function{apply()} is not necessary since the ``extended call
67048454aa1e Add a note that apply() is needed since the extended call syntax is Fred Drake <fdrake@acm.org> parents: 24901 diff changeset	77 syntax,'' as used in the last example, is completely equivalent.
27012 6a5cffc62387 Document that apply() is deprecated. See: Fred Drake <fdrake@acm.org> parents: 26683 diff changeset	78
6a5cffc62387 Document that apply() is deprecated. See: Fred Drake <fdrake@acm.org> parents: 26683 diff changeset	79 \deprecated{2.3}{Use the extended call syntax instead, as described
6a5cffc62387 Document that apply() is deprecated. See: Fred Drake <fdrake@acm.org> parents: 26683 diff changeset	80 above.}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	81 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	82
22785 aa8d59823add Add the 'bool' type and its values 'False' and 'True', as described in Guido van Rossum <guido@python.org> parents: 22152 diff changeset	83 \begin{funcdesc}{bool}{x}
aa8d59823add Add the 'bool' type and its values 'False' and 'True', as described in Guido van Rossum <guido@python.org> parents: 22152 diff changeset	84 Convert a value to a Boolean, using the standard truth testing
aa8d59823add Add the 'bool' type and its values 'False' and 'True', as described in Guido van Rossum <guido@python.org> parents: 22152 diff changeset	85 procedure. If \code{x} is false, this returns \code{False};
aa8d59823add Add the 'bool' type and its values 'False' and 'True', as described in Guido van Rossum <guido@python.org> parents: 22152 diff changeset	86 otherwise it returns \code{True}. \code{bool} is also a class,
aa8d59823add Add the 'bool' type and its values 'False' and 'True', as described in Guido van Rossum <guido@python.org> parents: 22152 diff changeset	87 which is a subclass of \code{int}. Class \code{bool} cannot be
aa8d59823add Add the 'bool' type and its values 'False' and 'True', as described in Guido van Rossum <guido@python.org> parents: 22152 diff changeset	88 subclassed further. Its only instances are \code{False} and
aa8d59823add Add the 'bool' type and its values 'False' and 'True', as described in Guido van Rossum <guido@python.org> parents: 22152 diff changeset	89 \code{True}.
aa8d59823add Add the 'bool' type and its values 'False' and 'True', as described in Guido van Rossum <guido@python.org> parents: 22152 diff changeset	90 \indexii{Boolean}{type}
26682 c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	91 \versionadded{2.2.1}
22785 aa8d59823add Add the 'bool' type and its values 'False' and 'True', as described in Guido van Rossum <guido@python.org> parents: 22152 diff changeset	92 \end{funcdesc}
aa8d59823add Add the 'bool' type and its values 'False' and 'True', as described in Guido van Rossum <guido@python.org> parents: 22152 diff changeset	93
10430 d592fe5e09d5 Document new builtin buffer(). Greg Stein. Guido van Rossum <guido@python.org> parents: 10229 diff changeset	94 \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	95 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	96 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	97 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	98 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	99 (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	100 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	101 argument).
10430 d592fe5e09d5 Document new builtin buffer(). Greg Stein. Guido van Rossum <guido@python.org> parents: 10229 diff changeset	102 \end{funcdesc}
d592fe5e09d5 Document new builtin buffer(). Greg Stein. Guido van Rossum <guido@python.org> parents: 10229 diff changeset	103
6385 14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	104 \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	105 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	106 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	107 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	108 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	109 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	110 method.
6385 14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	111 \end{funcdesc}
14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	112
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	113 \begin{funcdesc}{chr}{i}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	114 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	115 \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	116 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	117 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	118 if \var{i} is outside that range.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	119 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	120
26682 c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	121 \begin{funcdesc}{classmethod}{function}
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	122 Return a class method for \var{function}.
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	123
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	124 A class method receives the class as implicit first argument,
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	125 just like an instance method receives the instance.
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	126 To declare a class method, use this idiom:
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	127
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	128 \begin{verbatim}
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	129 class C:
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	130 def f(cls, arg1, arg2, ...): ...
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	131 f = classmethod(f)
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	132 \end{verbatim}
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	133
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	134 It can be called either on the class (e.g. C.f()) or on an instance
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	135 (e.g. C().f()). The instance is ignored except for its class.
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	136 If a class method is called for a derived class, the derived class
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	137 object is passed as the implied first argument.
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	138
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	139 Class methods are different than C++ or Java static methods.
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	140 If you want those, see \ref{staticmethod}.
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	141 \versionadded{2.2}
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	142 \end{funcdesc}
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	143
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	144 \begin{funcdesc}{cmp}{x, y}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	145 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	146 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	147 < \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	148 \code{\var{x} > \var{y}}.
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	149 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	150
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	151 \begin{funcdesc}{coerce}{x, y}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	152 Return a tuple consisting of the two numeric arguments converted to
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	153 a common type, using the same rules as used by arithmetic
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	154 operations.
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	155 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	156
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	157 \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	158 flags\optional{, dont_inherit}}}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	159 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	160 executed by an \keyword{exec} statement or evaluated by a call to
60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	161 \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	162 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	163 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	164 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	165 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	166 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	167 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	168 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	169 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	170
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	171 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	172 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	173 (\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	174 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	175 \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	176 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	177
784e21bdd9a2 Fix two typos in the text about compile(), and add two caveats from Guido van Rossum <guido@python.org> parents: 20010 diff changeset	178 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	179 (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	180 \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	181 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	182 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	183 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	184 (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	185 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	186 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	187 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	188 compile are ignored.
17b2afba7a6f Docs for the PEP 264 changes. Michael W. Hudson <mwh@python.net> parents: 18838 diff changeset	189
17b2afba7a6f Docs for the PEP 264 changes. Michael W. Hudson <mwh@python.net> parents: 18838 diff changeset	190 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	191 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	192 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	193 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	194 \module{__future__} module.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	195 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	196
5246 23330a1b9594 Add complex(). Guido van Rossum <guido@python.org> parents: 5163 diff changeset	197 \begin{funcdesc}{complex}{real\optional{, imag}}
10468 9cd4fd926df6 Document complex() with string arg. Guido van Rossum <guido@python.org> parents: 10430 diff changeset	198 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	199 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	200 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	201 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	202 second parameter can never be a string.
5246 23330a1b9594 Add complex(). Guido van Rossum <guido@python.org> parents: 5163 diff changeset	203 Each argument may be any numeric type (including complex).
23330a1b9594 Add complex(). Guido van Rossum <guido@python.org> parents: 5163 diff changeset	204 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	205 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	206 \function{long()} and \function{float()}.
5246 23330a1b9594 Add complex(). Guido van Rossum <guido@python.org> parents: 5163 diff changeset	207 \end{funcdesc}
23330a1b9594 Add complex(). Guido van Rossum <guido@python.org> parents: 5163 diff changeset	208
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	209 \begin{funcdesc}{delattr}{object, name}
7526 60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	210 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	211 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	212 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	213 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	214 \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	215 \code{del \var{x}.\var{foobar}}.
20897816a4b6 Added docs for delattr Guido van Rossum <guido@python.org> parents: 1776 diff changeset	216 \end{funcdesc}
20897816a4b6 Added docs for delattr Guido van Rossum <guido@python.org> parents: 1776 diff changeset	217
20754 272336648d1f Rename "dictionary" (type and constructor) to "dict". Tim Peters <tim.peters@gmail.com> parents: 20693 diff changeset	218 \begin{funcdesc}{dict}{\optional{mapping-or-sequence}}
26366 08b720cd387e Patch #642500 with slight modifications: allow keyword arguments in Just van Rossum <just@letterror.com> parents: 26291 diff changeset	219 Return a new dictionary initialized from an optional positional
08b720cd387e Patch #642500 with slight modifications: allow keyword arguments in Just van Rossum <just@letterror.com> parents: 26291 diff changeset	220 argument or from a set of keyword arguments.
08b720cd387e Patch #642500 with slight modifications: allow keyword arguments in Just van Rossum <just@letterror.com> parents: 26291 diff changeset	221 If no arguments are given, return a new empty dictionary.
08b720cd387e Patch #642500 with slight modifications: allow keyword arguments in Just van Rossum <just@letterror.com> parents: 26291 diff changeset	222 If the positional argument is a mapping object, return a dictionary
08b720cd387e Patch #642500 with slight modifications: allow keyword arguments in Just van Rossum <just@letterror.com> parents: 26291 diff changeset	223 mapping the same keys to the same values as does the mapping object.
08b720cd387e Patch #642500 with slight modifications: allow keyword arguments in Just van Rossum <just@letterror.com> parents: 26291 diff changeset	224 Otherwise the positional argument must be a sequence, a container that
08b720cd387e Patch #642500 with slight modifications: allow keyword arguments in Just van Rossum <just@letterror.com> parents: 26291 diff changeset	225 supports iteration, or an iterator object. The elements of the argument
08b720cd387e Patch #642500 with slight modifications: allow keyword arguments in Just van Rossum <just@letterror.com> parents: 26291 diff changeset	226 must each also be of one of those kinds, and each must in turn contain
20683 505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the Tim Peters <tim.peters@gmail.com> parents: 20563 diff changeset	227 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	228 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	229 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	230 dictionary.
26366 08b720cd387e Patch #642500 with slight modifications: allow keyword arguments in Just van Rossum <just@letterror.com> parents: 26291 diff changeset	231
08b720cd387e Patch #642500 with slight modifications: allow keyword arguments in Just van Rossum <just@letterror.com> parents: 26291 diff changeset	232 If keyword arguments are given, the keywords themselves with their
08b720cd387e Patch #642500 with slight modifications: allow keyword arguments in Just van Rossum <just@letterror.com> parents: 26291 diff changeset	233 associated values are added as items to the dictionary. If a key
08b720cd387e Patch #642500 with slight modifications: allow keyword arguments in Just van Rossum <just@letterror.com> parents: 26291 diff changeset	234 is specified both in the positional argument and as a keyword argument,
08b720cd387e Patch #642500 with slight modifications: allow keyword arguments in Just van Rossum <just@letterror.com> parents: 26291 diff changeset	235 the value associated with the keyword is retained in the dictionary.
20683 505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the Tim Peters <tim.peters@gmail.com> parents: 20563 diff changeset	236 For example, these all return a dictionary equal to
26366 08b720cd387e Patch #642500 with slight modifications: allow keyword arguments in Just van Rossum <just@letterror.com> parents: 26291 diff changeset	237 \code{\{"one": 2, "two": 3\}}:
20693 6903420f0a82 Some style changes and typo fixes. Fred Drake <fdrake@acm.org> parents: 20683 diff changeset	238
6903420f0a82 Some style changes and typo fixes. Fred Drake <fdrake@acm.org> parents: 20683 diff changeset	239 \begin{itemize}
26366 08b720cd387e Patch #642500 with slight modifications: allow keyword arguments in Just van Rossum <just@letterror.com> parents: 26291 diff changeset	240 \item \code{dict(\{'one': 2, 'two': 3\})}
08b720cd387e Patch #642500 with slight modifications: allow keyword arguments in Just van Rossum <just@letterror.com> parents: 26291 diff changeset	241 \item \code{dict(\{'one': 2, 'two': 3\}.items())}
08b720cd387e Patch #642500 with slight modifications: allow keyword arguments in Just van Rossum <just@letterror.com> parents: 26291 diff changeset	242 \item \code{dict(\{'one': 2, 'two': 3\}.iteritems())}
08b720cd387e Patch #642500 with slight modifications: allow keyword arguments in Just van Rossum <just@letterror.com> parents: 26291 diff changeset	243 \item \code{dict(zip(('one', 'two'), (2, 3)))}
08b720cd387e Patch #642500 with slight modifications: allow keyword arguments in Just van Rossum <just@letterror.com> parents: 26291 diff changeset	244 \item \code{dict([['two', 3], ['one', 2]])}
08b720cd387e Patch #642500 with slight modifications: allow keyword arguments in Just van Rossum <just@letterror.com> parents: 26291 diff changeset	245 \item \code{dict(one=2, two=3)}
08b720cd387e Patch #642500 with slight modifications: allow keyword arguments in Just van Rossum <just@letterror.com> parents: 26291 diff changeset	246 \item \code{dict([(['one', 'two'][i-2], i) for i in (2, 3)])}
20693 6903420f0a82 Some style changes and typo fixes. Fred Drake <fdrake@acm.org> parents: 20683 diff changeset	247 \end{itemize}
22152 a53730cd29c1 Added missing version annotation for dict(). Fred Drake <fdrake@acm.org> parents: 22007 diff changeset	248
a53730cd29c1 Added missing version annotation for dict(). Fred Drake <fdrake@acm.org> parents: 22007 diff changeset	249 \versionadded{2.2}
26371 3d0e02976bc3 Added change note about returning a dictionary based on keyword Fred Drake <fdrake@acm.org> parents: 26366 diff changeset	250 \versionchanged[Support for building a dictionary from keyword
3d0e02976bc3 Added change note about returning a dictionary based on keyword Fred Drake <fdrake@acm.org> parents: 26366 diff changeset	251 arguments added]{2.3}
20683 505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the Tim Peters <tim.peters@gmail.com> parents: 20563 diff changeset	252 \end{funcdesc}
505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the Tim Peters <tim.peters@gmail.com> parents: 20563 diff changeset	253
8072 b8162d086850 Signature for dir() omitted the optional argument. Fred Drake <fdrake@acm.org> parents: 7832 diff changeset	254 \begin{funcdesc}{dir}{\optional{object}}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	255 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	256 symbol table. With an argument, attempts to return a list of valid
22007 8a791330fc20 backport tim_one's checkin of Michael W. Hudson <mwh@python.net> parents: 21467 diff changeset	257 attributes 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	258 object's \member{__dict__} attribute, if defined, and from the class
22007 8a791330fc20 backport tim_one's checkin of Michael W. Hudson <mwh@python.net> parents: 21467 diff changeset	259 or type object. The list is not necessarily complete.
8a791330fc20 backport tim_one's checkin of Michael W. Hudson <mwh@python.net> parents: 21467 diff changeset	260 If the object is a module object, the list contains the names of the
8a791330fc20 backport tim_one's checkin of Michael W. Hudson <mwh@python.net> parents: 21467 diff changeset	261 module's attributes.
8a791330fc20 backport tim_one's checkin of Michael W. Hudson <mwh@python.net> parents: 21467 diff changeset	262 If the object is a type or class object,
8a791330fc20 backport tim_one's checkin of Michael W. Hudson <mwh@python.net> parents: 21467 diff changeset	263 the list contains the names of its attributes,
8a791330fc20 backport tim_one's checkin of Michael W. Hudson <mwh@python.net> parents: 21467 diff changeset	264 and recursively of the attributes of its bases.
8a791330fc20 backport tim_one's checkin of Michael W. Hudson <mwh@python.net> parents: 21467 diff changeset	265 Otherwise, the list contains the object's attributes' names,
8a791330fc20 backport tim_one's checkin of Michael W. Hudson <mwh@python.net> parents: 21467 diff changeset	266 the names of its class's attributes,
8a791330fc20 backport tim_one's checkin of Michael W. Hudson <mwh@python.net> parents: 21467 diff changeset	267 and recursively of the attributes of its class's base classes.
8a791330fc20 backport tim_one's checkin of Michael W. Hudson <mwh@python.net> parents: 21467 diff changeset	268 The resulting list is sorted alphabetically.
8a791330fc20 backport tim_one's checkin of Michael W. Hudson <mwh@python.net> parents: 21467 diff changeset	269 For example:
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	270
7277 bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous Fred Drake <fdrake@acm.org> parents: 7096 diff changeset	271 \begin{verbatim}
22007 8a791330fc20 backport tim_one's checkin of Michael W. Hudson <mwh@python.net> parents: 21467 diff changeset	272 >>> import struct
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	273 >>> dir()
22007 8a791330fc20 backport tim_one's checkin of Michael W. Hudson <mwh@python.net> parents: 21467 diff changeset	274 ['__builtins__', '__doc__', '__name__', 'struct']
8a791330fc20 backport tim_one's checkin of Michael W. Hudson <mwh@python.net> parents: 21467 diff changeset	275 >>> dir(struct)
8a791330fc20 backport tim_one's checkin of Michael W. Hudson <mwh@python.net> parents: 21467 diff changeset	276 ['__doc__', '__name__', 'calcsize', 'error', 'pack', 'unpack']
7277 bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous Fred Drake <fdrake@acm.org> parents: 7096 diff changeset	277 \end{verbatim}
22007 8a791330fc20 backport tim_one's checkin of Michael W. Hudson <mwh@python.net> parents: 21467 diff changeset	278
8a791330fc20 backport tim_one's checkin of Michael W. Hudson <mwh@python.net> parents: 21467 diff changeset	279 \note{Because \function{dir()} is supplied primarily as a convenience
8a791330fc20 backport tim_one's checkin of Michael W. Hudson <mwh@python.net> parents: 21467 diff changeset	280 for use at an interactive prompt,
8a791330fc20 backport tim_one's checkin of Michael W. Hudson <mwh@python.net> parents: 21467 diff changeset	281 it tries to supply an interesting set of names more than it tries to
8a791330fc20 backport tim_one's checkin of Michael W. Hudson <mwh@python.net> parents: 21467 diff changeset	282 supply a rigorously or consistently defined set of names,
8a791330fc20 backport tim_one's checkin of Michael W. Hudson <mwh@python.net> parents: 21467 diff changeset	283 and its detailed behavior may change across releases.}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	284 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	285
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	286 \begin{funcdesc}{divmod}{a, b}
23499 dba4f5176492 Patch 543387. Document deprecation of complex %, //,and divmod(). Raymond Hettinger <python@rcn.com> parents: 23287 diff changeset	287 Take two (non complex) numbers as arguments and return a pair of numbers
dba4f5176492 Patch 543387. Document deprecation of complex %, //,and divmod(). Raymond Hettinger <python@rcn.com> parents: 23287 diff changeset	288 consisting of their quotient and remainder when using long division. With
dba4f5176492 Patch 543387. Document deprecation of complex %, //,and divmod(). Raymond Hettinger <python@rcn.com> parents: 23287 diff changeset	289 mixed operand types, the rules for binary arithmetic operators apply. For
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	290 plain and long integers, the result is the same as
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	291 \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	292 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	293 \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	294 \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	295 \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	296 \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	297 \var{b}, and \code{0 <= abs(\var{a} \%{} \var{b}) < abs(\var{b})}.
23941 a60a3d9c6fd9 Add a note that divmod() with complex numbers is deprecated. Fred Drake <fdrake@acm.org> parents: 23515 diff changeset	298
a60a3d9c6fd9 Add a note that divmod() with complex numbers is deprecated. Fred Drake <fdrake@acm.org> parents: 23515 diff changeset	299 \versionchanged[Using \function{divmod()} with complex numbers is
a60a3d9c6fd9 Add a note that divmod() with complex numbers is deprecated. Fred Drake <fdrake@acm.org> parents: 23515 diff changeset	300 deprecated]{2.3}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	301 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	302
23287 b60b73d41eb4 Documentation for the enumerate() function/type. Fred Drake <fdrake@acm.org> parents: 23109 diff changeset	303 \begin{funcdesc}{enumerate}{iterable}
b60b73d41eb4 Documentation for the enumerate() function/type. Fred Drake <fdrake@acm.org> parents: 23109 diff changeset	304 Return an enumerate object. \var{iterable} must be a sequence, an
b60b73d41eb4 Documentation for the enumerate() function/type. Fred Drake <fdrake@acm.org> parents: 23109 diff changeset	305 iterator, or some other object which supports iteration. The
b60b73d41eb4 Documentation for the enumerate() function/type. Fred Drake <fdrake@acm.org> parents: 23109 diff changeset	306 \method{next()} method of the iterator returned by
b60b73d41eb4 Documentation for the enumerate() function/type. Fred Drake <fdrake@acm.org> parents: 23109 diff changeset	307 \function{enumerate()} returns a tuple containing a count (from
b60b73d41eb4 Documentation for the enumerate() function/type. Fred Drake <fdrake@acm.org> parents: 23109 diff changeset	308 zero) and the corresponding value obtained from iterating over
b60b73d41eb4 Documentation for the enumerate() function/type. Fred Drake <fdrake@acm.org> parents: 23109 diff changeset	309 \var{iterable}. \function{enumerate} is useful for obtaining an
b60b73d41eb4 Documentation for the enumerate() function/type. Fred Drake <fdrake@acm.org> parents: 23109 diff changeset	310 indexed series: \code{(0, seq[0])}, \code{(1, seq[1])}, \code{(2,
b60b73d41eb4 Documentation for the enumerate() function/type. Fred Drake <fdrake@acm.org> parents: 23109 diff changeset	311 seq[2])}, \ldots.
b60b73d41eb4 Documentation for the enumerate() function/type. Fred Drake <fdrake@acm.org> parents: 23109 diff changeset	312 \versionadded{2.3}
b60b73d41eb4 Documentation for the enumerate() function/type. Fred Drake <fdrake@acm.org> parents: 23109 diff changeset	313 \end{funcdesc}
b60b73d41eb4 Documentation for the enumerate() function/type. Fred Drake <fdrake@acm.org> parents: 23109 diff changeset	314
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	315 \begin{funcdesc}{eval}{expression\optional{, globals\optional{, locals}}}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	316 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	317 \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	318 expression (technically speaking, a condition list) using the
af41f4a21682 updated eval(), added execfile() Guido van Rossum <guido@python.org> parents: 1782 diff changeset	319 \var{globals} and \var{locals} dictionaries as global and local name
26683 6059e41bd77a Fix SF # 641111, Undocumented side effect of eval Neal Norwitz <nnorwitz@gmail.com> parents: 26682 diff changeset	320 space. If the \var{globals} dictionary is present and lacks
6059e41bd77a Fix SF # 641111, Undocumented side effect of eval Neal Norwitz <nnorwitz@gmail.com> parents: 26682 diff changeset	321 '__builtins__', the current globals are copied into \var{globals} before
6059e41bd77a Fix SF # 641111, Undocumented side effect of eval Neal Norwitz <nnorwitz@gmail.com> parents: 26682 diff changeset	322 \var{expression} is parsed. This means that \var{expression}
6059e41bd77a Fix SF # 641111, Undocumented side effect of eval Neal Norwitz <nnorwitz@gmail.com> parents: 26682 diff changeset	323 normally has full access to the standard
6059e41bd77a Fix SF # 641111, Undocumented side effect of eval Neal Norwitz <nnorwitz@gmail.com> parents: 26682 diff changeset	324 \refmodule[builtin]{__builtin__} module and restricted environments
6059e41bd77a Fix SF # 641111, Undocumented side effect of eval Neal Norwitz <nnorwitz@gmail.com> parents: 26682 diff changeset	325 are propagated. If the \var{locals} dictionary is omitted it defaults to
2576 f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications; Guido van Rossum <guido@python.org> parents: 2527 diff changeset	326 the \var{globals} dictionary. If both dictionaries are omitted, the
7526 60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	327 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	328 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	329 Syntax errors are reported as exceptions. Example:
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	330
7277 bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous Fred Drake <fdrake@acm.org> parents: 7096 diff changeset	331 \begin{verbatim}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	332 >>> x = 1
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	333 >>> print eval('x+1')
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	334 2
7277 bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous Fred Drake <fdrake@acm.org> parents: 7096 diff changeset	335 \end{verbatim}
7526 60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	336
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	337 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	338 (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	339 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	340 compiled passing \code{'eval'} as the \var{kind} argument.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	341
2491 fb8e08ec88dd changes (suggested) by Soren Larsen Guido van Rossum <guido@python.org> parents: 2453 diff changeset	342 Hints: dynamic execution of statements is supported by the
7526 60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	343 \keyword{exec} statement. Execution of statements from a file is
60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	344 supported by the \function{execfile()} function. The
60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	345 \function{globals()} and \function{locals()} functions returns the
60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	346 current global and local dictionary, respectively, which may be
60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	347 useful to pass around for use by \function{eval()} or
60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	348 \function{execfile()}.
2108 af41f4a21682 updated eval(), added execfile() Guido van Rossum <guido@python.org> parents: 1782 diff changeset	349 \end{funcdesc}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	350
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	351 \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	352 This function is similar to the
7526 60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	353 \keyword{exec} statement, but parses a file instead of a string. It
60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	354 is different from the \keyword{import} statement in that it does not
60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	355 use the module administration --- it reads the file unconditionally
60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	356 and does not create a new module.\footnote{It is used relatively
60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	357 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	358
af41f4a21682 updated eval(), added execfile() Guido van Rossum <guido@python.org> parents: 1782 diff changeset	359 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	360 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	361 (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	362 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	363 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	364 If both dictionaries are omitted, the expression is executed in the
7526 60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	365 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	366 \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	367
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	368 \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	369 \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	370 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	371 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	372 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	373 be used reliably to modify a function's locals.}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	374 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	375
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	376 \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	377 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	378 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	379 \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	380 \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	381 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	382 \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	383 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	384 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	385
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	386 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	387 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	388 \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	389 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	390 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	391 raised.
23515 b3898d326519 Jack's documentation for the U mode character on the file() Barry Warsaw <barry@python.org> parents: 23499 diff changeset	392
b3898d326519 Jack's documentation for the U mode character on the file() Barry Warsaw <barry@python.org> parents: 23499 diff changeset	393 In addition to the standard \cfunction{fopen()} values \var{mode}
b3898d326519 Jack's documentation for the U mode character on the file() Barry Warsaw <barry@python.org> parents: 23499 diff changeset	394 may be \code{'U'} or \code{'rU'}. If Python is built with universal
b3898d326519 Jack's documentation for the U mode character on the file() Barry Warsaw <barry@python.org> parents: 23499 diff changeset	395 newline support (the default) the file is opened as a text file, but
b3898d326519 Jack's documentation for the U mode character on the file() Barry Warsaw <barry@python.org> parents: 23499 diff changeset	396 lines may be terminated by any of \code{'\e n'}, the Unix end-of-line
b3898d326519 Jack's documentation for the U mode character on the file() Barry Warsaw <barry@python.org> parents: 23499 diff changeset	397 convention,
b3898d326519 Jack's documentation for the U mode character on the file() Barry Warsaw <barry@python.org> parents: 23499 diff changeset	398 \code{'\e r'}, the Macintosh convention or \code{'\e r\e n'}, the Windows
b3898d326519 Jack's documentation for the U mode character on the file() Barry Warsaw <barry@python.org> parents: 23499 diff changeset	399 convention. All of these external representations are seen as
b3898d326519 Jack's documentation for the U mode character on the file() Barry Warsaw <barry@python.org> parents: 23499 diff changeset	400 \code{'\e n'}
b3898d326519 Jack's documentation for the U mode character on the file() Barry Warsaw <barry@python.org> parents: 23499 diff changeset	401 by the Python program. If Python is built without universal newline support
b3898d326519 Jack's documentation for the U mode character on the file() Barry Warsaw <barry@python.org> parents: 23499 diff changeset	402 \var{mode} \code{'U'} is the same as normal text mode. Note that
b3898d326519 Jack's documentation for the U mode character on the file() Barry Warsaw <barry@python.org> parents: 23499 diff changeset	403 file objects so opened also have an attribute called
b3898d326519 Jack's documentation for the U mode character on the file() Barry Warsaw <barry@python.org> parents: 23499 diff changeset	404 \member{newlines} which has a value of \code{None} (if no newlines
b3898d326519 Jack's documentation for the U mode character on the file() Barry Warsaw <barry@python.org> parents: 23499 diff changeset	405 have yet been seen), \code{'\e n'}, \code{'\e r'}, \code{'\e r\e n'},
b3898d326519 Jack's documentation for the U mode character on the file() Barry Warsaw <barry@python.org> parents: 23499 diff changeset	406 or a tuple containing all the newline types seen.
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	407
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	408 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	409 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	410 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	411 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	412 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	413 \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	414 \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	415 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	416 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	417 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	418 (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	419 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	420 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	421 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	422 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	423 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	424 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	425 \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	426 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	427 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	428
d03c19db3094 Document new file() constructor, with the body of open()'s text, plus a Tim Peters <tim.peters@gmail.com> parents: 19781 diff changeset	429 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	430 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	431 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	432 \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	433
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	434 \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	435 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	436 \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	437 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	438 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	439 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	440 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	441 (zero or empty) are removed.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	442 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	443
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	444 \begin{funcdesc}{float}{x}
5246 23330a1b9594 Add complex(). Guido van Rossum <guido@python.org> parents: 5163 diff changeset	445 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	446 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	447 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	448 \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	449 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	450 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	451 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	452
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	453 \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	454 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	455 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	456 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	457 and is known to vary.}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	458 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	459
11136 c2ac896926cc Update getattr() description to document the optional third Fred Drake <fdrake@acm.org> parents: 10967 diff changeset	460 \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	461 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	462 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	463 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	464 \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	465 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	466 otherwise \exception{AttributeError} is raised.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	467 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	468
2816 c4c39d171ec3 documented globals() and locals() Guido van Rossum <guido@python.org> parents: 2609 diff changeset	469 \begin{funcdesc}{globals}{}
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	470 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	471 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	472 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	473 module from which it is called).
2816 c4c39d171ec3 documented globals() and locals() Guido van Rossum <guido@python.org> parents: 2609 diff changeset	474 \end{funcdesc}
c4c39d171ec3 documented globals() and locals() Guido van Rossum <guido@python.org> parents: 2609 diff changeset	475
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	476 \begin{funcdesc}{hasattr}{object, name}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	477 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	478 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	479 (This is implemented by calling \code{getattr(\var{object},
60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	480 \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	481 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	482
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	483 \begin{funcdesc}{hash}{object}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	484 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	485 are integers. They are used to quickly compare dictionary
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	486 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	487 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	488 the case for 1 and 1.0).
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	489 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	490
21467 4e35fa5d5708 Add documentation for the help() built-in; contributed by Ka-Ping Yee. Fred Drake <fdrake@acm.org> parents: 21399 diff changeset	491 \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	492 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	493 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	494 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	495 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	496 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	497 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	498 kind of object, a help page on the object is generated.
23109 7b00dab988cf Add a version annotation for the help() function. Fred Drake <fdrake@acm.org> parents: 22785 diff changeset	499 \versionadded{2.2}
21467 4e35fa5d5708 Add documentation for the help() built-in; contributed by Ka-Ping Yee. Fred Drake <fdrake@acm.org> parents: 21399 diff changeset	500 \end{funcdesc}
4e35fa5d5708 Add documentation for the help() built-in; contributed by Ka-Ping Yee. Fred Drake <fdrake@acm.org> parents: 21399 diff changeset	501
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	502 \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	503 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	504 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	505 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	506 \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	507 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	508 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	509 raise an \exception{OverflowError} exception.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	510 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	511
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	512 \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	513 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	514 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	515 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	516 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	517 note: this is the address of the object.)
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	518 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	519
1767 907605320a5f Lots of small corrections by Andrew Kuchling (plus all new rotor docs) Guido van Rossum <guido@python.org> parents: 1605 diff changeset	520 \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	521 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	522 \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	523 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	524 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	525 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	526 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	527 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	528
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	529 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	530 \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	531 history features.
8a715d2dfeb9 Various clarifications and minor nits fixed. Affected descriptions of Fred Drake <fdrake@acm.org> parents: 14034 diff changeset	532
8a715d2dfeb9 Various clarifications and minor nits fixed. Affected descriptions of Fred Drake <fdrake@acm.org> parents: 14034 diff changeset	533 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	534 from users.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	535 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	536
11805 bd161a908b3b Update the description of int() to include the radix parameter; Fred Drake <fdrake@acm.org> parents: 11180 diff changeset	537 \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	538 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	539 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	540 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	541 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	542 \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	543 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	544 \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	545 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	546 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	547 \exception{TypeError} is raised.
bd161a908b3b Update the description of int() to include the radix parameter; Fred Drake <fdrake@acm.org> parents: 11180 diff changeset	548 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	549 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	550 point numbers to integers truncates (towards zero).
26291 d31ddc66b1b5 Change int() so that passing a string, unicode, float or long argument Walter Dörwald <walter@livinglogic.de> parents: 25984 diff changeset	551 If the argument is outside the integer range a long object will
d31ddc66b1b5 Change int() so that passing a string, unicode, float or long argument Walter Dörwald <walter@livinglogic.de> parents: 25984 diff changeset	552 be returned instead.
11805 bd161a908b3b Update the description of int() to include the radix parameter; Fred Drake <fdrake@acm.org> parents: 11180 diff changeset	553 \end{funcdesc}
bd161a908b3b Update the description of int() to include the radix parameter; Fred Drake <fdrake@acm.org> parents: 11180 diff changeset	554
5163 9063f60ea28d Added intern() Guido van Rossum <guido@python.org> parents: 4961 diff changeset	555 \begin{funcdesc}{intern}{string}
9063f60ea28d Added intern() Guido van Rossum <guido@python.org> parents: 4961 diff changeset	556 Enter \var{string} in the table of ``interned'' strings and return
9063f60ea28d Added intern() Guido van Rossum <guido@python.org> parents: 4961 diff changeset	557 the interned string -- which is \var{string} itself or a copy.
9063f60ea28d Added intern() Guido van Rossum <guido@python.org> parents: 4961 diff changeset	558 Interning strings is useful to gain a little performance on
9063f60ea28d Added intern() Guido van Rossum <guido@python.org> parents: 4961 diff changeset	559 dictionary lookup -- if the keys in a dictionary are interned, and
9063f60ea28d Added intern() Guido van Rossum <guido@python.org> parents: 4961 diff changeset	560 the lookup key is interned, the key comparisons (after hashing) can
9063f60ea28d Added intern() Guido van Rossum <guido@python.org> parents: 4961 diff changeset	561 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	562 the names used in Python programs are automatically interned, and
9063f60ea28d Added intern() Guido van Rossum <guido@python.org> parents: 4961 diff changeset	563 the dictionaries used to hold module, class or instance attributes
24901 bc660f73795c SF patch 576101, by Oren Tirosh: alternative implementation of Guido van Rossum <guido@python.org> parents: 24270 diff changeset	564 have interned keys. \versionchanged[Interned strings are not
bc660f73795c SF patch 576101, by Oren Tirosh: alternative implementation of Guido van Rossum <guido@python.org> parents: 24270 diff changeset	565 immortal (like they used to be in Python 2.2 and before);
bc660f73795c SF patch 576101, by Oren Tirosh: alternative implementation of Guido van Rossum <guido@python.org> parents: 24270 diff changeset	566 you must keep a reference to the return value of \function{intern()}
bc660f73795c SF patch 576101, by Oren Tirosh: alternative implementation of Guido van Rossum <guido@python.org> parents: 24270 diff changeset	567 around to benefit from it]{2.3}
5163 9063f60ea28d Added intern() Guido van Rossum <guido@python.org> parents: 4961 diff changeset	568 \end{funcdesc}
9063f60ea28d Added intern() Guido van Rossum <guido@python.org> parents: 4961 diff changeset	569
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	570 \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	571 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	572 \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	573 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	574 \var{object} is an object of that type. If \var{object} is not a
27555 c267f28724dd Change the treatment of positions returned by PEP293 Walter Dörwald <walter@livinglogic.de> parents: 27076 diff changeset	575 class instance or an object of the given type, the function always
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	576 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	577 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	578 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	579 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	580 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	581 is raised.
14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	582 \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	583 \end{funcdesc}
14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	584
26612 97f83542f8ee Enhance issubclass() and PyObject_IsSubclass() so that a tuple is Walter Dörwald <walter@livinglogic.de> parents: 26371 diff changeset	585 \begin{funcdesc}{issubclass}{class, classinfo}
97f83542f8ee Enhance issubclass() and PyObject_IsSubclass() so that a tuple is Walter Dörwald <walter@livinglogic.de> parents: 26371 diff changeset	586 Return true if \var{class} is a subclass (direct or indirect) of
97f83542f8ee Enhance issubclass() and PyObject_IsSubclass() so that a tuple is Walter Dörwald <walter@livinglogic.de> parents: 26371 diff changeset	587 \var{classinfo}. A class is considered a subclass of itself.
97f83542f8ee Enhance issubclass() and PyObject_IsSubclass() so that a tuple is Walter Dörwald <walter@livinglogic.de> parents: 26371 diff changeset	588 \var{classinfo} may be a tuple of class objects, in which case every
97f83542f8ee Enhance issubclass() and PyObject_IsSubclass() so that a tuple is Walter Dörwald <walter@livinglogic.de> parents: 26371 diff changeset	589 entry in \var{classinfo} will be checked. In any other case, a
97f83542f8ee Enhance issubclass() and PyObject_IsSubclass() so that a tuple is Walter Dörwald <walter@livinglogic.de> parents: 26371 diff changeset	590 \exception{TypeError} exception is raised.
97f83542f8ee Enhance issubclass() and PyObject_IsSubclass() so that a tuple is Walter Dörwald <walter@livinglogic.de> parents: 26371 diff changeset	591 \versionchanged[Support for a tuple of type information was added]{2.3}
6385 14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	592 \end{funcdesc}
14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	593
19781 7b722b6cc77b Document the built-in iter() function. Fred Drake <fdrake@acm.org> parents: 19666 diff changeset	594 \begin{funcdesc}{iter}{o\optional{, sentinel}}
7b722b6cc77b Document the built-in iter() function. Fred Drake <fdrake@acm.org> parents: 19666 diff changeset	595 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	596 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	597 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	598 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	599 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	600 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	601 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	602 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	603 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	604 \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	605 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	606 \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	607 be returned.
7b722b6cc77b Document the built-in iter() function. Fred Drake <fdrake@acm.org> parents: 19666 diff changeset	608 \versionadded{2.2}
7b722b6cc77b Document the built-in iter() function. Fred Drake <fdrake@acm.org> parents: 19666 diff changeset	609 \end{funcdesc}
7b722b6cc77b Document the built-in iter() function. Fred Drake <fdrake@acm.org> parents: 19666 diff changeset	610
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	611 \begin{funcdesc}{len}{s}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	612 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	613 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	614 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	615
20683 505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the Tim Peters <tim.peters@gmail.com> parents: 20563 diff changeset	616 \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	617 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	618 \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	619 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	620 \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	621 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	622 \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	623 (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	624 \end{funcdesc}
fd6acad7cc7a Mention abs(complex) -> magnitude (AMK). Guido van Rossum <guido@python.org> parents: 5246 diff changeset	625
2816 c4c39d171ec3 documented globals() and locals() Guido van Rossum <guido@python.org> parents: 2609 diff changeset	626 \begin{funcdesc}{locals}{}
27076 753306f9b0a0 SF bug #655271: Slightly modify locals() doc Raymond Hettinger <python@rcn.com> parents: 27012 diff changeset	627 Update and return a dictionary representing the current local symbol table.
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	628 \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	629 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	630 interpreter.}
2816 c4c39d171ec3 documented globals() and locals() Guido van Rossum <guido@python.org> parents: 2609 diff changeset	631 \end{funcdesc}
c4c39d171ec3 documented globals() and locals() Guido van Rossum <guido@python.org> parents: 2609 diff changeset	632
15417 6b2524e9c672 Added information about the %r string formatting conversion. Added note Fred Drake <fdrake@acm.org> parents: 14520 diff changeset	633 \begin{funcdesc}{long}{x\optional{, radix}}
5246 23330a1b9594 Add complex(). Guido van Rossum <guido@python.org> parents: 5163 diff changeset	634 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	635 string, it must contain a possibly signed number of
5246 23330a1b9594 Add complex(). Guido van Rossum <guido@python.org> parents: 5163 diff changeset	636 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	637 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	638 \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	639 \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	640 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	641 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	642 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	643 point numbers to integers truncates (towards zero).
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	644 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	645
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	646 \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	647 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	648 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	649 \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	650 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	651 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	652 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	653 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	654 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	655 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	656 of sequence; the result is always a list.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	657 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	658
9529 d7d39260fe82 Clarify that min and max also take multiple arguments. Guido van Rossum <guido@python.org> parents: 9478 diff changeset	659 \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	660 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	661 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	662 than one argument, return the largest of the arguments.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	663 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	664
9529 d7d39260fe82 Clarify that min and max also take multiple arguments. Guido van Rossum <guido@python.org> parents: 9478 diff changeset	665 \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	666 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	667 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	668 than one argument, return the smallest of the arguments.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	669 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	670
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	671 \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	672 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	673 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	674 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	675 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	676 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	677 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	678 \exception{OverflowError} exception.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	679 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	680
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	681 \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	682 An alias for the \function{file()} function above.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	683 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	684
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	685 \begin{funcdesc}{ord}{c}
12264 64fcae78d47a Marc-Andre Lemburg <mal@lemburg.com>: Fred Drake <fdrake@acm.org> parents: 11805 diff changeset	686 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	687 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	688 \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	689 \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	690 characters.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	691 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	692
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	693 \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	694 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	695 \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	696 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	697 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	698 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	699 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	700 (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	701 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	702 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	703 \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	704 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	705 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	706 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	707 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	708 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	709 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	710 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	711 rounding accidents.)
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	712 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	713
26682 c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	714 \begin{funcdesc}{property}{\optional{fget\optional{, fset\optional{, fdel\optional{, doc}}}}}
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	715 Return a property attribute for new-style classes (classes that
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	716 derive from \function{object}.
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	717
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	718 \var{fget} is a function for getting an attribute value, likewise
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	719 \var{fset} is a function for setting, and \var{fdel} a function
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	720 for del'ing, an attribute. Typical use is to define a managed attribute x:
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	721
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	722 \begin{verbatim}
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	723 class C(object):
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	724 def getx(self): return self.__x
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	725 def setx(self, value): self.__x = value
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	726 def delx(self): del self.__x
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	727 x = property(getx, setx, delx, "I'm the 'x' property.")
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	728 \end{verbatim}
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	729
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	730 \versionadded{2.2}
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	731 \end{funcdesc}
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	732
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	733 \begin{funcdesc}{range}{\optional{start,} stop\optional{, step}}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	734 This is a versatile function to create lists containing arithmetic
7526 60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	735 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	736 arguments must be plain integers. If the \var{step} argument is
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	737 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	738 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	739 plain integers \code{[\var{start}, \var{start} + \var{step},
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	740 \var{start} + 2 * \var{step}, \ldots]}. If \var{step} is positive,
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	741 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	742 \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	743 element is the largest \code{\var{start} + \var{i} * \var{step}}
7832 d14b7120c551 Small nits. Fred Drake <fdrake@acm.org> parents: 7791 diff changeset	744 greater than \var{stop}. \var{step} must not be zero (or else
d14b7120c551 Small nits. Fred Drake <fdrake@acm.org> parents: 7791 diff changeset	745 \exception{ValueError} is raised). Example:
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	746
7277 bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous Fred Drake <fdrake@acm.org> parents: 7096 diff changeset	747 \begin{verbatim}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	748 >>> range(10)
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	749 [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	750 >>> range(1, 11)
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	751 [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	752 >>> range(0, 30, 5)
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	753 [0, 5, 10, 15, 20, 25]
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	754 >>> range(0, 10, 3)
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	755 [0, 3, 6, 9]
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	756 >>> range(0, -10, -1)
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	757 [0, -1, -2, -3, -4, -5, -6, -7, -8, -9]
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	758 >>> range(0)
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	759 []
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	760 >>> range(1, 0)
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	761 []
7277 bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous Fred Drake <fdrake@acm.org> parents: 7096 diff changeset	762 \end{verbatim}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	763 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	764
1767 907605320a5f Lots of small corrections by Andrew Kuchling (plus all new rotor docs) Guido van Rossum <guido@python.org> parents: 1605 diff changeset	765 \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	766 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	767 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	768 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	769 When \EOF{} is read, \exception{EOFError} is raised. Example:
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	770
7277 bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous Fred Drake <fdrake@acm.org> parents: 7096 diff changeset	771 \begin{verbatim}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	772 >>> s = raw_input('--> ')
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	773 --> Monty Python's Flying Circus
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	774 >>> s
2576 f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications; Guido van Rossum <guido@python.org> parents: 2527 diff changeset	775 "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	776 \end{verbatim}
5675 fd6acad7cc7a Mention abs(complex) -> magnitude (AMK). Guido van Rossum <guido@python.org> parents: 5246 diff changeset	777
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	778 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	779 \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	780 line editing and history features.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	781 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	782
9798 9cfc53e5996e Replace the docs for reduce with an adaptation of its docstring, which Guido van Rossum <guido@python.org> parents: 9602 diff changeset	783 \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	784 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	785 \var{sequence}, from left to right, so as to reduce the sequence to
24270 a4f4ce5e8aa9 reduce(): Clarified what is returned in the case of a sequence 1 item long and Fred Drake <fdrake@acm.org> parents: 24157 diff changeset	786 a single value. For example, \code{reduce(lambda x, y: x+y, [1, 2,
a4f4ce5e8aa9 reduce(): Clarified what is returned in the case of a sequence 1 item long and Fred Drake <fdrake@acm.org> parents: 24157 diff changeset	787 3, 4, 5])} calculates \code{((((1+2)+3)+4)+5)}. If the optional
a4f4ce5e8aa9 reduce(): Clarified what is returned in the case of a sequence 1 item long and Fred Drake <fdrake@acm.org> parents: 24157 diff changeset	788 \var{initializer} is present, it is placed before the items of the
a4f4ce5e8aa9 reduce(): Clarified what is returned in the case of a sequence 1 item long and Fred Drake <fdrake@acm.org> parents: 24157 diff changeset	789 sequence in the calculation, and serves as a default when the
a4f4ce5e8aa9 reduce(): Clarified what is returned in the case of a sequence 1 item long and Fred Drake <fdrake@acm.org> parents: 24157 diff changeset	790 sequence is empty. If \var{initializer} is not given and
a4f4ce5e8aa9 reduce(): Clarified what is returned in the case of a sequence 1 item long and Fred Drake <fdrake@acm.org> parents: 24157 diff changeset	791 \var{sequence} contains only one item, the first item is returned.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	792 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	793
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	794 \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	795 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	796 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	797 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	798 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	799 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	800 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	801
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	802 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	803
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	804 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	805 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	806 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	807 \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	808 \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	809 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	810
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	811 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	812 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	813 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	814 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	815 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	816 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	817 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	818 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	819
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	820 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	821 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	822 \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	823 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	824 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	825 reloaded.
2576 f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications; Guido van Rossum <guido@python.org> parents: 2527 diff changeset	826
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	827 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	828 \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	829 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	830 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	831 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	832 (\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	833
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	834 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	835 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	836 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	837 same is true for derived classes.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	838 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	839
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	840 \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	841 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	842 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	843 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	844 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	845 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	846 when passed to \function{eval()}.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	847 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	848
9036 18697f59fd48 round(): Mark the second (optional) parameter as optional, since it's Fred Drake <fdrake@acm.org> parents: 8918 diff changeset	849 \begin{funcdesc}{round}{x\optional{, n}}
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	850 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	851 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	852 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	853 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	854 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	855 \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	856 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	857
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	858 \begin{funcdesc}{setattr}{object, name, value}
7526 60e7b000f273 Logical markup. Fred Drake <fdrake@acm.org> parents: 7292 diff changeset	859 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	860 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	861 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	862 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	863 \code{setattr(\var{x}, '\var{foobar}', 123)} is equivalent to
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	864 \code{\var{x}.\var{foobar} = 123}.
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	865 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	866
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	867 \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	868 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	869 \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	870 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	871 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	872 \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	873 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	874 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	875 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	876 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	877 \samp{a[start:stop, i]}.
6385 14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	878 \end{funcdesc}
14d58b5a21c4 Documented __import__, callable, isinstance, issubclass, Guido van Rossum <guido@python.org> parents: 5818 diff changeset	879
26682 c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	880 \begin{funcdesc}{staticmethod}{function}
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	881 Return a static method for \var{function}.
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	882
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	883 A static method does not receive an implicit first argument.
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	884 To declare a static method, use this idiom:
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	885
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	886 \begin{verbatim}
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	887 class C:
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	888 def f(arg1, arg2, ...): ...
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	889 f = staticmethod(f)
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	890 \end{verbatim}
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	891
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	892 It can be called either on the class (e.g. C.f()) or on an instance
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	893 (e.g. C().f()). The instance is ignored except for its class.
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	894
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	895 Static methods in Python are similar to those found in Java or C++.
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	896 For a more advanced concept, see \ref{classmethod}.
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	897 \versionadded{2.2}
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	898 \end{funcdesc}
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	899
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	900 \begin{funcdesc}{super}{type\optional{object-or-type}}
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	901 Return the superclass of \var{type}. If the second argument is omitted
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	902 the super object returned is unbound. If the second argument is an
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	903 object, isinstance(obj, type) must be true. If the second argument is a
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	904 type, issubclass(type2, type) must be true.
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	905
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	906 A typical use for calling a cooperative superclass method is:
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	907 \begin{verbatim}
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	908 class C(B):
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	909 def meth(self, arg):
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	910 super(C, self).meth(arg)
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	911 \end{verbatim}
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	912 \versionadded{2.2}
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	913 \end{funcdesc}
c11a6e1cede0 Fix SF #642742, property() builtin not documented Neal Norwitz <nnorwitz@gmail.com> parents: 26612 diff changeset	914
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	915 \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	916 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	917 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	918 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	919 \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	920 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	921 printable string.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	922 \end{funcdesc}
2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	923
20683 505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the Tim Peters <tim.peters@gmail.com> parents: 20563 diff changeset	924 \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	925 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	926 \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	927 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	928 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	929 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	930 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	931 \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	932 \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	933
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	934 \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	935 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	936 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	937 \module{types}\refstmodindex{types} defines names for all built-in
25984 152219807144 Update example for the type() function to use the currently accepted Fred Drake <fdrake@acm.org> parents: 25887 diff changeset	938 types that don't already have built-in names.
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	939 For instance:
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	940
7277 bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous Fred Drake <fdrake@acm.org> parents: 7096 diff changeset	941 \begin{verbatim}
2576 f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications; Guido van Rossum <guido@python.org> parents: 2527 diff changeset	942 >>> import types
25984 152219807144 Update example for the type() function to use the currently accepted Fred Drake <fdrake@acm.org> parents: 25887 diff changeset	943 >>> x = 'abc'
152219807144 Update example for the type() function to use the currently accepted Fred Drake <fdrake@acm.org> parents: 25887 diff changeset	944 >>> if type(x) is str: print "It's a string"
152219807144 Update example for the type() function to use the currently accepted Fred Drake <fdrake@acm.org> parents: 25887 diff changeset	945 ...
152219807144 Update example for the type() function to use the currently accepted Fred Drake <fdrake@acm.org> parents: 25887 diff changeset	946 It's a string
152219807144 Update example for the type() function to use the currently accepted Fred Drake <fdrake@acm.org> parents: 25887 diff changeset	947 >>> def f(): pass
152219807144 Update example for the type() function to use the currently accepted Fred Drake <fdrake@acm.org> parents: 25887 diff changeset	948 ...
152219807144 Update example for the type() function to use the currently accepted Fred Drake <fdrake@acm.org> parents: 25887 diff changeset	949 >>> if type(f) is types.FunctionType: print "It's a function"
152219807144 Update example for the type() function to use the currently accepted Fred Drake <fdrake@acm.org> parents: 25887 diff changeset	950 ...
152219807144 Update example for the type() function to use the currently accepted Fred Drake <fdrake@acm.org> parents: 25887 diff changeset	951 It's a function
7277 bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous Fred Drake <fdrake@acm.org> parents: 7096 diff changeset	952 \end{verbatim}
25984 152219807144 Update example for the type() function to use the currently accepted Fred Drake <fdrake@acm.org> parents: 25887 diff changeset	953
152219807144 Update example for the type() function to use the currently accepted Fred Drake <fdrake@acm.org> parents: 25887 diff changeset	954 The \function{isinstance()} built-in function is recommended for
152219807144 Update example for the type() function to use the currently accepted Fred Drake <fdrake@acm.org> parents: 25887 diff changeset	955 testing the type of an object.
1471 2ec96140a36b Restructured library documentation Guido van Rossum <guido@python.org> parents: diff changeset	956 \end{funcdesc}
1560 274b93b12113 Documented xrange; crossreffed lambda a bit more Guido van Rossum <guido@python.org> parents: 1471 diff changeset	957
12264 64fcae78d47a Marc-Andre Lemburg <mal@lemburg.com>: Fred Drake <fdrake@acm.org> parents: 11805 diff changeset	958 \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	959 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	960 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	961 \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	962 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	963 \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	964 \versionadded{2.0}
12264 64fcae78d47a Marc-Andre Lemburg <mal@lemburg.com>: Fred Drake <fdrake@acm.org> parents: 11805 diff changeset	965 \end{funcdesc}
64fcae78d47a Marc-Andre Lemburg <mal@lemburg.com>: Fred Drake <fdrake@acm.org> parents: 11805 diff changeset	966
20563 9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	967 \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	968 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	969 following modes:
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	970
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	971 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	972 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	973 character buffer using the codec for \var{encoding}. The
24157 9dded6f18819 Note that unicode() can raise LookupError for unknown codecs. Fred Drake <fdrake@acm.org> parents: 24135 diff changeset	974 \var{encoding} parameter is a string giving the name of an encoding;
9dded6f18819 Note that unicode() can raise LookupError for unknown codecs. Fred Drake <fdrake@acm.org> parents: 24135 diff changeset	975 if the encoding is not known, \exception{LookupError} is raised.
20563 9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	976 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	977 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	978 \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	979 \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	980 \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	981 \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	982 \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	983 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	984
9058e49c6c57 Additional test and documentation for the unicode() changes. Marc-André Lemburg <mal@egenix.com> parents: 20341 diff changeset	985 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	986 behaviour of \code{str()} except that it returns Unicode strings
24135 7c1a76b78712 Fix typo: "an Unicode string" --> "a Unicode string" Fred Drake <fdrake@acm.org> parents: 24056 diff changeset	987 instead of 8-bit strings. More precisely, if \var{object} is a
7c1a76b78712 Fix typo: "an Unicode string" --> "a Unicode string" Fred Drake <fdrake@acm.org> parents: 24056 diff changeset	988 Unicode string or subclass it will return that Unicode string without
24056 dcc2b75d7a78 Clarify the version information for the unicode() built-in. Fred Drake <fdrake@acm.org> parents: 23941 diff changeset	989 any additional decoding applied.
dcc2b75d7a78 Clarify the version information for the unicode() built-in. Fred Drake <fdrake@acm.org> parents: 23941 diff changeset	990
dcc2b75d7a78 Clarify the version information for the unicode() built-in. Fred Drake <fdrake@acm.org> parents: 23941 diff changeset	991 For objects which provide a \method{__unicode__()} method, it will
dcc2b75d7a78 Clarify the version information for the unicode() built-in. Fred Drake <fdrake@acm.org> parents: 23941 diff changeset	992 call this method without arguments to create a Unicode string. For
dcc2b75d7a78 Clarify the version information for the unicode() built-in. Fred Drake <fdrake@acm.org> parents: 23941 diff changeset	993 all other objects, the 8-bit string version or representation is
dcc2b75d7a78 Clarify the version information for the unicode() built-in. Fred Drake <fdrake@acm.org> parents: 23941 diff changeset	994 requested and then converted to a Unicode string using the codec for
dcc2b75d7a78 Clarify the version information for the unicode() built-in. Fred Drake <fdrake@acm.org> parents: 23941 diff changeset	995 the default encoding in \code{'strict'} mode.
dcc2b75d7a78 Clarify the version information for the unicode() built-in. Fred Drake <fdrake@acm.org> parents: 23941 diff changeset	996
20341 14e0fe152711 Update the documentation for the isinstance() function to reflect recent Fred Drake <fdrake@acm.org> parents: 20245 diff changeset	997 \versionadded{2.0}
24056 dcc2b75d7a78 Clarify the version information for the unicode() built-in. Fred Drake <fdrake@acm.org> parents: 23941 diff changeset	998 \versionchanged[Support for \method{__unicode__()} added]{2.2}
12264 64fcae78d47a Marc-Andre Lemburg <mal@lemburg.com>: Fred Drake <fdrake@acm.org> parents: 11805 diff changeset	999 \end{funcdesc}
64fcae78d47a Marc-Andre Lemburg <mal@lemburg.com>: Fred Drake <fdrake@acm.org> parents: 11805 diff changeset	1000
2527 815dfaa6a778 small changes by Soren Larsen Guido van Rossum <guido@python.org> parents: 2491 diff changeset	1001 \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	1002 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	1003 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	1004 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	1005 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	1006 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	1007 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	1008 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	1009 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	1010 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	1011 \end{funcdesc}
ac9e12b4ea8c Documented new built-in function vars(). Guido van Rossum <guido@python.org> parents: 1560 diff changeset	1012
7712 0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain, Fred Drake <fdrake@acm.org> parents: 7526 diff changeset	1013 \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	1014 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	1015 ``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	1016 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	1017 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	1018 \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	1019 \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	1020 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	1021 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	1022 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	1023 \end{funcdesc}
13823 eeed7bc8a283 Both PEP 201 Lockstep Iteration and SF patch #101030 have been Barry Warsaw <barry@python.org> parents: 13222 diff changeset	1024
13833 5136e37ff548 int() description: Fix markup to avoid image generation for math mode. Fred Drake <fdrake@acm.org> parents: 13823 diff changeset	1025 \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	1026 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	1027 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	1028 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	1029 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	1030 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	1031 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	1032 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	1033 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	1034 \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	1035 \end{funcdesc}

Mercurial > cpython-lru_cache-weakref

annotate Doc/lib/libfuncs.tex @ 27998:e27f58a50737 legacy-trunk