Mercurial > cpython-lru_cache-weakref

annotate Doc/libtypes.tex @ 5817:48b94de85bf3 legacy-trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Extensive changes by AMK.
author Guido van Rossum <guido@python.org>
date Thu, 17 Jul 1997 16:29:42 +0000
parents dffd22146aab
children 4d55bfe1febb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
1 \section{Built-in Types}
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 following sections describe the standard types that are built into
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
4 the interpreter. These are the numeric types, sequence types, and
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
5 several others, including types themselves. There is no explicit
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
6 Boolean type; use integers instead.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
7 \indexii{built-in}{types}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
8 \indexii{Boolean}{type}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
9
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
10 Some operations are supported by several object types; in particular,
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
11 all objects can be compared, tested for truth value, and converted to
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
12 a string (with the \code{`{\rm \ldots}`} notation). The latter conversion is
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
13 implicitly used when an object is written by the \code{print} statement.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
14 \stindex{print}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
15
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
16 \subsection{Truth Value Testing}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
17
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
18 Any object can be tested for truth value, for use in an \code{if} or
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
19 \code{while} condition or as operand of the Boolean operations below.
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
20 The following values are considered false:
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
21 \stindex{if}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
22 \stindex{while}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
23 \indexii{truth}{value}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
24 \indexii{Boolean}{operations}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
25 \index{false}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
26
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
27 \begin{itemize}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
28 \renewcommand{\indexsubitem}{(Built-in object)}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
29
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
30 \item \code{None}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
31 \ttindex{None}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
32
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
33 \item zero of any numeric type, e.g., \code{0}, \code{0L}, \code{0.0}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
34
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
35 \item any empty sequence, e.g., \code{''}, \code{()}, \code{[]}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
36
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
37 \item any empty mapping, e.g., \code{\{\}}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
38
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
39 \item instances of user-defined classes, if the class defines a
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
40 \code{__nonzero__()} or \code{__len__()} method, when that
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
41 method returns zero.
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
42
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
43 \end{itemize}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
44
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
45 All other values are considered true --- so objects of many types are
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
46 always true.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
47 \index{true}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
48
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
49 Operations and built-in functions that have a Boolean result always
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
50 return \code{0} for false and \code{1} for true, unless otherwise
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
51 stated. (Important exception: the Boolean operations \samp{or} and
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
52 \samp{and} always return one of their operands.)
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
53
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
54 \subsection{Boolean Operations}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
55
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
56 These are the Boolean operations, ordered by ascending priority:
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
57 \indexii{Boolean}{operations}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
58
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
59 \begin{tableiii}{|c|l|c|}{code}{Operation}{Result}{Notes}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
60 \lineiii{\var{x} or \var{y}}{if \var{x} is false, then \var{y}, else \var{x}}{(1)}
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
61 \hline
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
62 \lineiii{\var{x} and \var{y}}{if \var{x} is false, then \var{x}, else \var{y}}{(1)}
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
63 \hline
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
64 \lineiii{not \var{x}}{if \var{x} is false, then \code{1}, else \code{0}}{(2)}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
65 \end{tableiii}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
66 \opindex{and}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
67 \opindex{or}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
68 \opindex{not}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
69
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
70 \noindent
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
71 Notes:
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
72
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
73 \begin{description}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
74
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
75 \item[(1)]
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
76 These only evaluate their second argument if needed for their outcome.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
77
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
78 \item[(2)]
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
79 \samp{not} has a lower priority than non-Boolean operators, so e.g.
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
80 \code{not a == b} is interpreted as \code{not(a == b)}, and
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
81 \code{a == not b} is a syntax error.
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
82
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
83 \end{description}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
84
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
85 \subsection{Comparisons}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
86
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
87 Comparison operations are supported by all objects. They all have the
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
88 same priority (which is higher than that of the Boolean operations).
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
89 Comparisons can be chained arbitrarily, e.g. \code{x < y <= z} is
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
90 equivalent to \code{x < y and y <= z}, except that \code{y} is
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
91 evaluated only once (but in both cases \code{z} is not evaluated at
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
92 all when \code{x < y} is found to be false).
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
93 \indexii{chaining}{comparisons}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
94
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
95 This table summarizes the comparison operations:
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
96
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
97 \begin{tableiii}{|c|l|c|}{code}{Operation}{Meaning}{Notes}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
98 \lineiii{<}{strictly less than}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
99 \lineiii{<=}{less than or equal}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
100 \lineiii{>}{strictly greater than}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
101 \lineiii{>=}{greater than or equal}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
102 \lineiii{==}{equal}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
103 \lineiii{<>}{not equal}{(1)}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
104 \lineiii{!=}{not equal}{(1)}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
105 \lineiii{is}{object identity}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
106 \lineiii{is not}{negated object identity}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
107 \end{tableiii}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
108 \indexii{operator}{comparison}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
109 \opindex{==} % XXX *All* others have funny characters < ! >
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
110 \opindex{is}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
111 \opindex{is not}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
112
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
113 \noindent
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
114 Notes:
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
115
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
116 \begin{description}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
117
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
118 \item[(1)]
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
119 \code{<>} and \code{!=} are alternate spellings for the same operator.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
120 (I couldn't choose between \ABC{} and \C{}! :-)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
121 \indexii{\ABC{}}{language}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
122 \indexii{\C{}}{language}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
123
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
124 \end{description}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
125
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
126 Objects of different types, except different numeric types, never
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
127 compare equal; such objects are ordered consistently but arbitrarily
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
128 (so that sorting a heterogeneous array yields a consistent result).
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
129 Furthermore, some types (e.g., windows) support only a degenerate
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
130 notion of comparison where any two objects of that type are unequal.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
131 Again, such objects are ordered arbitrarily but consistently.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
132 \indexii{types}{numeric}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
133 \indexii{objects}{comparing}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
134
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
135 (Implementation note: objects of different types except numbers are
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
136 ordered by their type names; objects of the same types that don't
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
137 support proper comparison are ordered by their address.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
138
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
139 Two more operations with the same syntactic priority, \code{in} and
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
140 \code{not in}, are supported only by sequence types (below).
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
141 \opindex{in}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
142 \opindex{not in}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
143
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
144 \subsection{Numeric Types}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
145
5674
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
146 There are four numeric types: \dfn{plain integers}, \dfn{long integers},
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
147 \dfn{floating point numbers}, and \dfn{complex numbers}.
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
148 Plain integers (also just called \dfn{integers})
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
149 are implemented using \code{long} in \C{}, which gives them at least 32
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
150 bits of precision. Long integers have unlimited precision. Floating
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
151 point numbers are implemented using \code{double} in \C{}. All bets on
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
152 their precision are off unless you happen to know the machine you are
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
153 working with.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
154 \indexii{numeric}{types}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
155 \indexii{integer}{types}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
156 \indexii{integer}{type}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
157 \indexiii{long}{integer}{type}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
158 \indexii{floating point}{type}
5674
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
159 \indexii{complex number}{type}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
160 \indexii{\C{}}{language}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
161
5674
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
162 Complex numbers have a real and imaginary part, which are both
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
163 implemented using \code{double} in \C{}. To extract these parts from
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
164 a complex number \code{z}, use \code{z.real} and \code{z.imag}.
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
165
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
166 Numbers are created by numeric literals or as the result of built-in
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
167 functions and operators. Unadorned integer literals (including hex
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
168 and octal numbers) yield plain integers. Integer literals with an \samp{L}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
169 or \samp{l} suffix yield long integers
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
170 (\samp{L} is preferred because \code{1l} looks too much like eleven!).
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
171 Numeric literals containing a decimal point or an exponent sign yield
5674
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
172 floating point numbers. Appending \code{j} or \code{J} to a numeric
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
173 literal yields a complex number.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
174 \indexii{numeric}{literals}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
175 \indexii{integer}{literals}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
176 \indexiii{long}{integer}{literals}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
177 \indexii{floating point}{literals}
5674
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
178 \indexii{complex number}{literals}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
179 \indexii{hexadecimal}{literals}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
180 \indexii{octal}{literals}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
181
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
182 Python fully supports mixed arithmetic: when a binary arithmetic
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
183 operator has operands of different numeric types, the operand with the
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
184 ``smaller'' type is converted to that of the other, where plain
5674
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
185 integer is smaller than long integer is smaller than floating point is
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
186 smaller than complex.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
187 Comparisons between numbers of mixed type use the same rule.%
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
188 \footnote{As a consequence, the list \code{[1, 2]} is considered equal
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
189 to \code{[1.0, 2.0]}, and similar for tuples.}
5674
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
190 The functions \code{int()}, \code{long()}, \code{float()},
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
191 and \code{complex()} can be used
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
192 to coerce numbers to a specific type.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
193 \index{arithmetic}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
194 \bifuncindex{int}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
195 \bifuncindex{long}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
196 \bifuncindex{float}
5674
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
197 \bifuncindex{complex}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
198
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
199 All numeric types support the following operations, sorted by
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
200 ascending priority (operations in the same box have the same
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
201 priority; all numeric operations have a higher priority than
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
202 comparison operations):
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
203
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
204 \begin{tableiii}{|c|l|c|}{code}{Operation}{Result}{Notes}
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
205 \lineiii{\var{x} + \var{y}}{sum of \var{x} and \var{y}}{}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
206 \lineiii{\var{x} - \var{y}}{difference of \var{x} and \var{y}}{}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
207 \hline
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
208 \lineiii{\var{x} * \var{y}}{product of \var{x} and \var{y}}{}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
209 \lineiii{\var{x} / \var{y}}{quotient of \var{x} and \var{y}}{(1)}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
210 \lineiii{\var{x} \%{} \var{y}}{remainder of \code{\var{x} / \var{y}}}{}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
211 \hline
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
212 \lineiii{-\var{x}}{\var{x} negated}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
213 \lineiii{+\var{x}}{\var{x} unchanged}{}
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
214 \hline
5674
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
215 \lineiii{abs(\var{x})}{absolute value or magnitude of \var{x}}{}
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
216 \lineiii{int(\var{x})}{\var{x} converted to integer}{(2)}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
217 \lineiii{long(\var{x})}{\var{x} converted to long integer}{(2)}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
218 \lineiii{float(\var{x})}{\var{x} converted to floating point}{}
5674
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
219 \lineiii{complex(\var{re},\var{im})}{a complex number with real part \var{re}, imaginary part \var{im}. \var{im} defaults to zero.}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
220 \lineiii{divmod(\var{x}, \var{y})}{the pair \code{(\var{x} / \var{y}, \var{x} \%{} \var{y})}}{(3)}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
221 \lineiii{pow(\var{x}, \var{y})}{\var{x} to the power \var{y}}{}
5674
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
222 \lineiii{\var{x}**\var{y}}{\var{x} to the power \var{y}}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
223 \end{tableiii}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
224 \indexiii{operations on}{numeric}{types}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
225
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
226 \noindent
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
227 Notes:
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
228 \begin{description}
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
229
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
230 \item[(1)]
2945
f17b7d0a7482 correct description of integer division; describe optional read arg
Guido van Rossum <guido@python.org>
parents: 2819
diff changeset
231 For (plain or long) integer division, the result is an integer.
f17b7d0a7482 correct description of integer division; describe optional read arg
Guido van Rossum <guido@python.org>
parents: 2819
diff changeset
232 The result is always rounded towards minus infinity: 1/2 is 0,
f17b7d0a7482 correct description of integer division; describe optional read arg
Guido van Rossum <guido@python.org>
parents: 2819
diff changeset
233 (-1)/2 is -1, 1/(-2) is -1, and (-1)/(-2) is 0.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
234 \indexii{integer}{division}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
235 \indexiii{long}{integer}{division}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
236
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
237 \item[(2)]
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
238 Conversion from floating point to (long or plain) integer may round or
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
239 truncate as in \C{}; see functions \code{floor()} and \code{ceil()} in
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
240 module \code{math} for well-defined conversions.
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
241 \bifuncindex{floor}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
242 \bifuncindex{ceil}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
243 \indexii{numeric}{conversions}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
244 \stmodindex{math}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
245 \indexii{\C{}}{language}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
246
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
247 \item[(3)]
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
248 See the section on built-in functions for an exact definition.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
249
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
250 \end{description}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
251 % XXXJH exceptions: overflow (when? what operations?) zerodivision
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
252
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2488
diff changeset
253 \subsubsection{Bit-string Operations on Integer Types}
2581
4d28b655b728 added nodename macro calls for new very long section names
Guido van Rossum <guido@python.org>
parents: 2576
diff changeset
254 \nodename{Bit-string Operations}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
255
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
256 Plain and long integer types support additional operations that make
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
257 sense only for bit-strings. Negative numbers are treated as their 2's
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
258 complement value (for long integers, this assumes a sufficiently large
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
259 number of bits that no overflow occurs during the operation).
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
260
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
261 The priorities of the binary bit-wise operations are all lower than
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
262 the numeric operations and higher than the comparisons; the unary
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
263 operation \samp{~} has the same priority as the other unary numeric
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
264 operations (\samp{+} and \samp{-}).
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
265
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
266 This table lists the bit-string operations sorted in ascending
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
267 priority (operations in the same box have the same priority):
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
268
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
269 \begin{tableiii}{|c|l|c|}{code}{Operation}{Result}{Notes}
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
270 \lineiii{\var{x} | \var{y}}{bitwise \dfn{or} of \var{x} and \var{y}}{}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
271 \hline
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
272 \lineiii{\var{x} \^{} \var{y}}{bitwise \dfn{exclusive or} of \var{x} and \var{y}}{}
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
273 \hline
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
274 \lineiii{\var{x} \&{} \var{y}}{bitwise \dfn{and} of \var{x} and \var{y}}{}
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
275 \hline
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
276 \lineiii{\var{x} << \var{n}}{\var{x} shifted left by \var{n} bits}{(1), (2)}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
277 \lineiii{\var{x} >> \var{n}}{\var{x} shifted right by \var{n} bits}{(1), (3)}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
278 \hline
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
279 \hline
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
280 \lineiii{\~\var{x}}{the bits of \var{x} inverted}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
281 \end{tableiii}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
282 \indexiii{operations on}{integer}{types}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
283 \indexii{bit-string}{operations}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
284 \indexii{shifting}{operations}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
285 \indexii{masking}{operations}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
286
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
287 \noindent
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
288 Notes:
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
289 \begin{description}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
290 \item[(1)] Negative shift counts are illegal.
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
291 \item[(2)] A left shift by \var{n} bits is equivalent to
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
292 multiplication by \code{pow(2, \var{n})} without overflow check.
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
293 \item[(3)] A right shift by \var{n} bits is equivalent to
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
294 division by \code{pow(2, \var{n})} without overflow check.
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
295 \end{description}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
296
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
297 \subsection{Sequence Types}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
298
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
299 There are three sequence types: strings, lists and tuples.
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
300
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
301 Strings literals are written in single or double quotes:
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
302 \code{'xyzzy'}, \code{"frobozz"}. See Chapter 2 of the Python
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
303 Reference Manual for more about string literals. Lists are
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
304 constructed with square brackets, separating items with commas:
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
305 \code{[a, b, c]}. Tuples are constructed by the comma operator (not
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
306 within square brackets), with or without enclosing parentheses, but an
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
307 empty tuple must have the enclosing parentheses, e.g.,
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
308 \code{a, b, c} or \code{()}. A single item tuple must have a trailing
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
309 comma, e.g., \code{(d,)}.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
310 \indexii{sequence}{types}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
311 \indexii{string}{type}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
312 \indexii{tuple}{type}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
313 \indexii{list}{type}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
314
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
315 Sequence types support the following operations. The \samp{in} and
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
316 \samp{not\,in} operations have the same priorities as the comparison
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
317 operations. The \samp{+} and \samp{*} operations have the same
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
318 priority as the corresponding numeric operations.\footnote{They must
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
319 have since the parser can't tell the type of the operands.}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
320
2647
9b7e6d9a528d typos, layout and other small things
Guido van Rossum <guido@python.org>
parents: 2609
diff changeset
321 This table lists the sequence operations sorted in ascending priority
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
322 (operations in the same box have the same priority). In the table,
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
323 \var{s} and \var{t} are sequences of the same type; \var{n}, \var{i}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
324 and \var{j} are integers:
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
325
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
326 \begin{tableiii}{|c|l|c|}{code}{Operation}{Result}{Notes}
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
327 \lineiii{\var{x} in \var{s}}{\code{1} if an item of \var{s} is equal to \var{x}, else \code{0}}{}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
328 \lineiii{\var{x} not in \var{s}}{\code{0} if an item of \var{s} is
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
329 equal to \var{x}, else \code{1}}{}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
330 \hline
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
331 \lineiii{\var{s} + \var{t}}{the concatenation of \var{s} and \var{t}}{}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
332 \hline
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
333 \lineiii{\var{s} * \var{n}{\rm ,} \var{n} * \var{s}}{\var{n} copies of \var{s} concatenated}{}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
334 \hline
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
335 \lineiii{\var{s}[\var{i}]}{\var{i}'th item of \var{s}, origin 0}{(1)}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
336 \lineiii{\var{s}[\var{i}:\var{j}]}{slice of \var{s} from \var{i} to \var{j}}{(1), (2)}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
337 \hline
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
338 \lineiii{len(\var{s})}{length of \var{s}}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
339 \lineiii{min(\var{s})}{smallest item of \var{s}}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
340 \lineiii{max(\var{s})}{largest item of \var{s}}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
341 \end{tableiii}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
342 \indexiii{operations on}{sequence}{types}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
343 \bifuncindex{len}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
344 \bifuncindex{min}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
345 \bifuncindex{max}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
346 \indexii{concatenation}{operation}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
347 \indexii{repetition}{operation}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
348 \indexii{subscript}{operation}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
349 \indexii{slice}{operation}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
350 \opindex{in}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
351 \opindex{not in}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
352
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
353 \noindent
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
354 Notes:
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
355
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
356 \begin{description}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
357
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
358 \item[(1)] If \var{i} or \var{j} is negative, the index is relative to
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
359 the end of the string, i.e., \code{len(\var{s}) + \var{i}} or
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
360 \code{len(\var{s}) + \var{j}} is substituted. But note that \code{-0} is
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
361 still \code{0}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
362
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
363 \item[(2)] The slice of \var{s} from \var{i} to \var{j} is defined as
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
364 the sequence of items with index \var{k} such that \code{\var{i} <=
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
365 \var{k} < \var{j}}. If \var{i} or \var{j} is greater than
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
366 \code{len(\var{s})}, use \code{len(\var{s})}. If \var{i} is omitted,
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
367 use \code{0}. If \var{j} is omitted, use \code{len(\var{s})}. If
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
368 \var{i} is greater than or equal to \var{j}, the slice is empty.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
369
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
370 \end{description}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
371
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2488
diff changeset
372 \subsubsection{More String Operations}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
373
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
374 String objects have one unique built-in operation: the \code{\%}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
375 operator (modulo) with a string left argument interprets this string
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
376 as a C sprintf format string to be applied to the right argument, and
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
377 returns the string resulting from this formatting operation.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
378
1683
080811b1d023 documented writelines()
Guido van Rossum <guido@python.org>
parents: 1625
diff changeset
379 The right argument should be a tuple with one item for each argument
080811b1d023 documented writelines()
Guido van Rossum <guido@python.org>
parents: 1625
diff changeset
380 required by the format string; if the string requires a single
080811b1d023 documented writelines()
Guido van Rossum <guido@python.org>
parents: 1625
diff changeset
381 argument, the right argument may also be a single non-tuple object.%
080811b1d023 documented writelines()
Guido van Rossum <guido@python.org>
parents: 1625
diff changeset
382 \footnote{A tuple object in this case should be a singleton.}
080811b1d023 documented writelines()
Guido van Rossum <guido@python.org>
parents: 1625
diff changeset
383 The following format characters are understood:
080811b1d023 documented writelines()
Guido van Rossum <guido@python.org>
parents: 1625
diff changeset
384 \%, c, s, i, d, u, o, x, X, e, E, f, g, G.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
385 Width and precision may be a * to specify that an integer argument
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
386 specifies the actual width or precision. The flag characters -, +,
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
387 blank, \# and 0 are understood. The size specifiers h, l or L may be
1591
ac9e12b4ea8c Documented new built-in function vars().
Guido van Rossum <guido@python.org>
parents: 1471
diff changeset
388 present but are ignored. The \code{\%s} conversion takes any Python
ac9e12b4ea8c Documented new built-in function vars().
Guido van Rossum <guido@python.org>
parents: 1471
diff changeset
389 object and converts it to a string using \code{str()} before
ac9e12b4ea8c Documented new built-in function vars().
Guido van Rossum <guido@python.org>
parents: 1471
diff changeset
390 formatting it. The ANSI features \code{\%p} and \code{\%n}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
391 are not supported. Since Python strings have an explicit length,
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2488
diff changeset
392 \code{\%s} conversions don't assume that \code{'\e0'} is the end of
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
393 the string.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
394
1625
96d0dc4739ec * Doc/libtypes.tex: fix typo in table of list methods; clarify
Guido van Rossum <guido@python.org>
parents: 1591
diff changeset
395 For safety reasons, floating point precisions are clipped to 50;
96d0dc4739ec * Doc/libtypes.tex: fix typo in table of list methods; clarify
Guido van Rossum <guido@python.org>
parents: 1591
diff changeset
396 \code{\%f} conversions for numbers whose absolute value is over 1e25
96d0dc4739ec * Doc/libtypes.tex: fix typo in table of list methods; clarify
Guido van Rossum <guido@python.org>
parents: 1591
diff changeset
397 are replaced by \code{\%g} conversions.%
96d0dc4739ec * Doc/libtypes.tex: fix typo in table of list methods; clarify
Guido van Rossum <guido@python.org>
parents: 1591
diff changeset
398 \footnote{These numbers are fairly arbitrary. They are intended to
96d0dc4739ec * Doc/libtypes.tex: fix typo in table of list methods; clarify
Guido van Rossum <guido@python.org>
parents: 1591
diff changeset
399 avoid printing endless strings of meaningless digits without hampering
96d0dc4739ec * Doc/libtypes.tex: fix typo in table of list methods; clarify
Guido van Rossum <guido@python.org>
parents: 1591
diff changeset
400 correct use and without having to know the exact precision of floating
96d0dc4739ec * Doc/libtypes.tex: fix typo in table of list methods; clarify
Guido van Rossum <guido@python.org>
parents: 1591
diff changeset
401 point values on a particular machine.}
96d0dc4739ec * Doc/libtypes.tex: fix typo in table of list methods; clarify
Guido van Rossum <guido@python.org>
parents: 1591
diff changeset
402 All other errors raise exceptions.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
403
1591
ac9e12b4ea8c Documented new built-in function vars().
Guido van Rossum <guido@python.org>
parents: 1471
diff changeset
404 If the right argument is a dictionary (or any kind of mapping), then
ac9e12b4ea8c Documented new built-in function vars().
Guido van Rossum <guido@python.org>
parents: 1471
diff changeset
405 the formats in the string must have a parenthesized key into that
ac9e12b4ea8c Documented new built-in function vars().
Guido van Rossum <guido@python.org>
parents: 1471
diff changeset
406 dictionary inserted immediately after the \code{\%} character, and
ac9e12b4ea8c Documented new built-in function vars().
Guido van Rossum <guido@python.org>
parents: 1471
diff changeset
407 each format formats the corresponding entry from the mapping. E.g.
5808
dffd22146aab Added fileno(); added readlines(sizehint).
Guido van Rossum <guido@python.org>
parents: 5674
diff changeset
408 \bcode\begin{verbatim}
dffd22146aab Added fileno(); added readlines(sizehint).
Guido van Rossum <guido@python.org>
parents: 5674
diff changeset
409 >>> count = 2
dffd22146aab Added fileno(); added readlines(sizehint).
Guido van Rossum <guido@python.org>
parents: 5674
diff changeset
410 >>> language = 'Python'
dffd22146aab Added fileno(); added readlines(sizehint).
Guido van Rossum <guido@python.org>
parents: 5674
diff changeset
411 >>> print '%(language)s has %(count)03d quote types.' % vars()
dffd22146aab Added fileno(); added readlines(sizehint).
Guido van Rossum <guido@python.org>
parents: 5674
diff changeset
412 Python has 002 quote types.
dffd22146aab Added fileno(); added readlines(sizehint).
Guido van Rossum <guido@python.org>
parents: 5674
diff changeset
413 >>>
dffd22146aab Added fileno(); added readlines(sizehint).
Guido van Rossum <guido@python.org>
parents: 5674
diff changeset
414 \end{verbatim}\ecode
4404
1e2d280606d1 (libtypes.tex): Correct reversal of two words in description of
Fred Drake <fdrake@acm.org>
parents: 4401
diff changeset
415 In this case no * specifiers may occur in a format (since they
1e2d280606d1 (libtypes.tex): Correct reversal of two words in description of
Fred Drake <fdrake@acm.org>
parents: 4401
diff changeset
416 require a sequential parameter list).
1591
ac9e12b4ea8c Documented new built-in function vars().
Guido van Rossum <guido@python.org>
parents: 1471
diff changeset
417
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
418 Additional string operations are defined in standard module
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
419 \code{string} and in built-in module \code{regex}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
420 \index{string}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
421 \index{regex}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
422
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2488
diff changeset
423 \subsubsection{Mutable Sequence Types}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
424
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
425 List objects support additional operations that allow in-place
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
426 modification of the object.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
427 These operations would be supported by other mutable sequence types
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
428 (when added to the language) as well.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
429 Strings and tuples are immutable sequence types and such objects cannot
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
430 be modified once created.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
431 The following operations are defined on mutable sequence types (where
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
432 \var{x} is an arbitrary object):
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
433 \indexiii{mutable}{sequence}{types}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
434 \indexii{list}{type}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
435
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
436 \begin{tableiii}{|c|l|c|}{code}{Operation}{Result}{Notes}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
437 \lineiii{\var{s}[\var{i}] = \var{x}}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
438 {item \var{i} of \var{s} is replaced by \var{x}}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
439 \lineiii{\var{s}[\var{i}:\var{j}] = \var{t}}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
440 {slice of \var{s} from \var{i} to \var{j} is replaced by \var{t}}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
441 \lineiii{del \var{s}[\var{i}:\var{j}]}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
442 {same as \code{\var{s}[\var{i}:\var{j}] = []}}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
443 \lineiii{\var{s}.append(\var{x})}
1625
96d0dc4739ec * Doc/libtypes.tex: fix typo in table of list methods; clarify
Guido van Rossum <guido@python.org>
parents: 1591
diff changeset
444 {same as \code{\var{s}[len(\var{s}):len(\var{s})] = [\var{x}]}}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
445 \lineiii{\var{s}.count(\var{x})}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
446 {return number of \var{i}'s for which \code{\var{s}[\var{i}] == \var{x}}}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
447 \lineiii{\var{s}.index(\var{x})}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
448 {return smallest \var{i} such that \code{\var{s}[\var{i}] == \var{x}}}{(1)}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
449 \lineiii{\var{s}.insert(\var{i}, \var{x})}
2819
8225c6581b3d correct description of list.insert()
Guido van Rossum <guido@python.org>
parents: 2647
diff changeset
450 {same as \code{\var{s}[\var{i}:\var{i}] = [\var{x}]}
8225c6581b3d correct description of list.insert()
Guido van Rossum <guido@python.org>
parents: 2647
diff changeset
451 if \code{\var{i} >= 0}}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
452 \lineiii{\var{s}.remove(\var{x})}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
453 {same as \code{del \var{s}[\var{s}.index(\var{x})]}}{(1)}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
454 \lineiii{\var{s}.reverse()}
5674
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
455 {reverses the items of \var{s} in place}{(3)}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
456 \lineiii{\var{s}.sort()}
5674
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
457 {sort the items of \var{s} in place}{(2), (3)}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
458 \end{tableiii}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
459 \indexiv{operations on}{mutable}{sequence}{types}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
460 \indexiii{operations on}{sequence}{types}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
461 \indexiii{operations on}{list}{type}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
462 \indexii{subscript}{assignment}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
463 \indexii{slice}{assignment}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
464 \stindex{del}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
465 \renewcommand{\indexsubitem}{(list method)}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
466 \ttindex{append}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
467 \ttindex{count}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
468 \ttindex{index}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
469 \ttindex{insert}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
470 \ttindex{remove}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
471 \ttindex{reverse}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
472 \ttindex{sort}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
473
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
474 \noindent
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
475 Notes:
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
476 \begin{description}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
477 \item[(1)] Raises an exception when \var{x} is not found in \var{s}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
478
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
479 \item[(2)] The \code{sort()} method takes an optional argument
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
480 specifying a comparison function of two arguments (list items) which
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
481 should return \code{-1}, \code{0} or \code{1} depending on whether the
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
482 first argument is considered smaller than, equal to, or larger than the
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
483 second argument. Note that this slows the sorting process down
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2488
diff changeset
484 considerably; e.g. to sort a list in reverse order it is much faster
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
485 to use calls to \code{sort()} and \code{reverse()} than to use
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
486 \code{sort()} with a comparison function that reverses the ordering of
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
487 the elements.
5674
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
488
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
489 \item[(3)] The \code{sort()} and \code{reverse()} methods modify the
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
490 list in place for economy of space when sorting or reversing a large
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
491 list. They don't return the sorted or reversed list to remind you of
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
492 this side effect.
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
493
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
494 \end{description}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
495
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
496 \subsection{Mapping Types}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
497
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
498 A \dfn{mapping} object maps values of one type (the key type) to
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
499 arbitrary objects. Mappings are mutable objects. There is currently
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2488
diff changeset
500 only one standard mapping type, the \dfn{dictionary}. A dictionary's keys are
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
501 almost arbitrary values. The only types of values not acceptable as
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
502 keys are values containing lists or dictionaries or other mutable
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
503 types that are compared by value rather than by object identity.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
504 Numeric types used for keys obey the normal rules for numeric
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
505 comparison: if two numbers compare equal (e.g. 1 and 1.0) then they
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
506 can be used interchangeably to index the same dictionary entry.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
507
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
508 \indexii{mapping}{types}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
509 \indexii{dictionary}{type}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
510
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
511 Dictionaries are created by placing a comma-separated list of
4401
d16b8621a3f0 Typos detected by Sjoerd
Guido van Rossum <guido@python.org>
parents: 3543
diff changeset
512 \code{\var{key}:\,\var{value}} pairs within braces, for example:
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
513 \code{\{'jack':\,4098, 'sjoerd':\,4127\}} or
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
514 \code{\{4098:\,'jack', 4127:\,'sjoerd'\}}.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
515
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
516 The following operations are defined on mappings (where \var{a} is a
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
517 mapping, \var{k} is a key and \var{x} is an arbitrary object):
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
518
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
519 \begin{tableiii}{|c|l|c|}{code}{Operation}{Result}{Notes}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
520 \lineiii{len(\var{a})}{the number of items in \var{a}}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
521 \lineiii{\var{a}[\var{k}]}{the item of \var{a} with key \var{k}}{(1)}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
522 \lineiii{\var{a}[\var{k}] = \var{x}}{set \code{\var{a}[\var{k}]} to \var{x}}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
523 \lineiii{del \var{a}[\var{k}]}{remove \code{\var{a}[\var{k}]} from \var{a}}{(1)}
5660
efdee7d43270 Added copy() and absorb().
Guido van Rossum <guido@python.org>
parents: 4404
diff changeset
524 \lineiii{\var{a}.clear()}{remove all items from \code{a}}{}
efdee7d43270 Added copy() and absorb().
Guido van Rossum <guido@python.org>
parents: 4404
diff changeset
525 \lineiii{\var{a}.copy()}{a (shallow) copy of \code{a}}{}
efdee7d43270 Added copy() and absorb().
Guido van Rossum <guido@python.org>
parents: 4404
diff changeset
526 \lineiii{\var{a}.has_key(\var{k})}{\code{1} if \var{a} has a key \var{k}, else \code{0}}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
527 \lineiii{\var{a}.items()}{a copy of \var{a}'s list of (key, item) pairs}{(2)}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
528 \lineiii{\var{a}.keys()}{a copy of \var{a}'s list of keys}{(2)}
5674
e5de707300e1 Added complex numbers (AMK).
Guido van Rossum <guido@python.org>
parents: 5660
diff changeset
529 \lineiii{\var{a}.update(b)}{\code{for k, v in b.items(): a[k] = v}}{(3)}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
530 \lineiii{\var{a}.values()}{a copy of \var{a}'s list of values}{(2)}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
531 \end{tableiii}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
532 \indexiii{operations on}{mapping}{types}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
533 \indexiii{operations on}{dictionary}{type}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
534 \stindex{del}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
535 \bifuncindex{len}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
536 \renewcommand{\indexsubitem}{(dictionary method)}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
537 \ttindex{keys}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
538 \ttindex{has_key}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
539
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
540 \noindent
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
541 Notes:
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
542 \begin{description}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
543 \item[(1)] Raises an exception if \var{k} is not in the map.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
544
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2488
diff changeset
545 \item[(2)] Keys and values are listed in random order.
5660
efdee7d43270 Added copy() and absorb().
Guido van Rossum <guido@python.org>
parents: 4404
diff changeset
546
efdee7d43270 Added copy() and absorb().
Guido van Rossum <guido@python.org>
parents: 4404
diff changeset
547 \item[(3)] \code{b} must be of the same type as \code{a}.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
548 \end{description}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
549
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
550 \subsection{Other Built-in Types}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
551
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
552 The interpreter supports several other kinds of objects.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
553 Most of these support only one or two operations.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
554
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2488
diff changeset
555 \subsubsection{Modules}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
556
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
557 The only special operation on a module is attribute access:
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
558 \code{\var{m}.\var{name}}, where \var{m} is a module and \var{name} accesses
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
559 a name defined in \var{m}'s symbol table. Module attributes can be
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
560 assigned to. (Note that the \code{import} statement is not, strictly
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
561 spoken, an operation on a module object; \code{import \var{foo}} does not
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
562 require a module object named \var{foo} to exist, rather it requires
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
563 an (external) \emph{definition} for a module named \var{foo}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
564 somewhere.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
565
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
566 A special member of every module is \code{__dict__}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
567 This is the dictionary containing the module's symbol table.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
568 Modifying this dictionary will actually change the module's symbol
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
569 table, but direct assignment to the \code{__dict__} attribute is not
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
570 possible (i.e., you can write \code{\var{m}.__dict__['a'] = 1}, which
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
571 defines \code{\var{m}.a} to be \code{1}, but you can't write \code{\var{m}.__dict__ = \{\}}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
572
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
573 Modules are written like this: \code{<module 'sys'>}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
574
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2488
diff changeset
575 \subsubsection{Classes and Class Instances}
2581
4d28b655b728 added nodename macro calls for new very long section names
Guido van Rossum <guido@python.org>
parents: 2576
diff changeset
576 \nodename{Classes and Instances}
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
577
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
578 (See Chapters 3 and 7 of the Python Reference Manual for these.)
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
579
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2488
diff changeset
580 \subsubsection{Functions}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
581
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
582 Function objects are created by function definitions. The only
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
583 operation on a function object is to call it:
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
584 \code{\var{func}(\var{argument-list})}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
585
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
586 There are really two flavors of function objects: built-in functions
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
587 and user-defined functions. Both support the same operation (to call
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
588 the function), but the implementation is different, hence the
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
589 different object types.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
590
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
591 The implementation adds two special read-only attributes:
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
592 \code{\var{f}.func_code} is a function's \dfn{code object} (see below) and
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
593 \code{\var{f}.func_globals} is the dictionary used as the function's
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
594 global name space (this is the same as \code{\var{m}.__dict__} where
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
595 \var{m} is the module in which the function \var{f} was defined).
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
596
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2488
diff changeset
597 \subsubsection{Methods}
2488
80729aff9057 added code objects
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
598 \obindex{method}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
599
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
600 Methods are functions that are called using the attribute notation.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
601 There are two flavors: built-in methods (such as \code{append()} on
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
602 lists) and class instance methods. Built-in methods are described
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
603 with the types that support them.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
604
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
605 The implementation adds two special read-only attributes to class
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
606 instance methods: \code{\var{m}.im_self} is the object whose method this
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
607 is, and \code{\var{m}.im_func} is the function implementing the method.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
608 Calling \code{\var{m}(\var{arg-1}, \var{arg-2}, {\rm \ldots},
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
609 \var{arg-n})} is completely equivalent to calling
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
610 \code{\var{m}.im_func(\var{m}.im_self, \var{arg-1}, \var{arg-2}, {\rm
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
611 \ldots}, \var{arg-n})}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
612
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
613 (See the Python Reference Manual for more info.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
614
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2488
diff changeset
615 \subsubsection{Code Objects}
2488
80729aff9057 added code objects
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
616 \obindex{code}
80729aff9057 added code objects
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
617
80729aff9057 added code objects
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
618 Code objects are used by the implementation to represent
80729aff9057 added code objects
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
619 ``pseudo-compiled'' executable Python code such as a function body.
80729aff9057 added code objects
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
620 They differ from function objects because they don't contain a
80729aff9057 added code objects
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
621 reference to their global execution environment. Code objects are
80729aff9057 added code objects
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
622 returned by the built-in \code{compile()} function and can be
80729aff9057 added code objects
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
623 extracted from function objects through their \code{func_code}
80729aff9057 added code objects
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
624 attribute.
80729aff9057 added code objects
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
625 \bifuncindex{compile}
80729aff9057 added code objects
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
626 \ttindex{func_code}
80729aff9057 added code objects
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
627
80729aff9057 added code objects
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
628 A code object can be executed or evaluated by passing it (instead of a
80729aff9057 added code objects
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
629 source string) to the \code{exec} statement or the built-in
80729aff9057 added code objects
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
630 \code{eval()} function.
80729aff9057 added code objects
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
631 \stindex{exec}
80729aff9057 added code objects
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
632 \bifuncindex{eval}
80729aff9057 added code objects
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
633
80729aff9057 added code objects
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
634 (See the Python Reference Manual for more info.)
80729aff9057 added code objects
Guido van Rossum <guido@python.org>
parents: 2064
diff changeset
635
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2488
diff changeset
636 \subsubsection{Type Objects}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
637
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
638 Type objects represent the various object types. An object's type is
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
639 accessed by the built-in function \code{type()}. There are no special
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
640 operations on types. The standard module \code{types} defines names
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
641 for all standard built-in types.
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
642 \bifuncindex{type}
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
643 \stmodindex{types}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
644
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
645 Types are written like this: \code{<type 'int'>}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
646
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2488
diff changeset
647 \subsubsection{The Null Object}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
648
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
649 This object is returned by functions that don't explicitly return a
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
650 value. It supports no special operations. There is exactly one null
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
651 object, named \code{None} (a built-in name).
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
652
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
653 It is written as \code{None}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
654
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2488
diff changeset
655 \subsubsection{File Objects}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
656
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
657 File objects are implemented using \C{}'s \code{stdio} package and can be
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
658 created with the built-in function \code{open()} described under
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
659 Built-in Functions below. They are also returned by some other
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
660 built-in functions and methods, e.g.\ \code{posix.popen()} and
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
661 \code{posix.fdopen()} and the \code{makefile()} method of socket
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
662 objects.
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
663 \bifuncindex{open}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
664
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
665 When a file operation fails for an I/O-related reason, the exception
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
666 \code{IOError} is raised. This includes situations where the
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
667 operation is not defined for some reason, like \code{seek()} on a tty
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
668 device or writing a file opened for reading.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
669
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
670 Files have the following methods:
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
671
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
672
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
673 \renewcommand{\indexsubitem}{(file method)}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
674
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
675 \begin{funcdesc}{close}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
676 Close the file. A closed file cannot be read or written anymore.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
677 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
678
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
679 \begin{funcdesc}{flush}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
680 Flush the internal buffer, like \code{stdio}'s \code{fflush()}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
681 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
682
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
683 \begin{funcdesc}{isatty}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
684 Return \code{1} if the file is connected to a tty(-like) device, else
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
685 \code{0}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
686 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
687
5808
dffd22146aab Added fileno(); added readlines(sizehint).
Guido van Rossum <guido@python.org>
parents: 5674
diff changeset
688 \begin{funcdesc}{fileno}{}
dffd22146aab Added fileno(); added readlines(sizehint).
Guido van Rossum <guido@python.org>
parents: 5674
diff changeset
689 Return the integer ``file descriptor'' that is used by the underlying
dffd22146aab Added fileno(); added readlines(sizehint).
Guido van Rossum <guido@python.org>
parents: 5674
diff changeset
690 implementation to request I/O operations from the operating system.
dffd22146aab Added fileno(); added readlines(sizehint).
Guido van Rossum <guido@python.org>
parents: 5674
diff changeset
691 This can be useful for other, lower level interfaces that use file
dffd22146aab Added fileno(); added readlines(sizehint).
Guido van Rossum <guido@python.org>
parents: 5674
diff changeset
692 descriptors, e.g. module \code{fcntl} or \code{os.read} and friends.
dffd22146aab Added fileno(); added readlines(sizehint).
Guido van Rossum <guido@python.org>
parents: 5674
diff changeset
693 \end{funcdesc}
dffd22146aab Added fileno(); added readlines(sizehint).
Guido van Rossum <guido@python.org>
parents: 5674
diff changeset
694
2945
f17b7d0a7482 correct description of integer division; describe optional read arg
Guido van Rossum <guido@python.org>
parents: 2819
diff changeset
695 \begin{funcdesc}{read}{\optional{size}}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
696 Read at most \var{size} bytes from the file (less if the read hits
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
697 \EOF{} or no more data is immediately available on a pipe, tty or
2945
f17b7d0a7482 correct description of integer division; describe optional read arg
Guido van Rossum <guido@python.org>
parents: 2819
diff changeset
698 similar device). If the \var{size} argument is negative or omitted,
f17b7d0a7482 correct description of integer division; describe optional read arg
Guido van Rossum <guido@python.org>
parents: 2819
diff changeset
699 read all data until \EOF{} is reached. The bytes are returned as a string
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
700 object. An empty string is returned when \EOF{} is encountered
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
701 immediately. (For certain files, like ttys, it makes sense to
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
702 continue reading after an \EOF{} is hit.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
703 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
704
2993
5d4749a470b4 Fixed incorrect tex-code for readline
Jack Jansen <jack.jansen@cwi.nl>
parents: 2945
diff changeset
705 \begin{funcdesc}{readline}{\optional{size}}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
706 Read one entire line from the file. A trailing newline character is
2064
280f31e6c653 copyright.tex: Add 1995 to copyright message.
Guido van Rossum <guido@python.org>
parents: 1683
diff changeset
707 kept in the string%
280f31e6c653 copyright.tex: Add 1995 to copyright message.
Guido van Rossum <guido@python.org>
parents: 1683
diff changeset
708 \footnote{The advantage of leaving the newline on is that an empty string
280f31e6c653 copyright.tex: Add 1995 to copyright message.
Guido van Rossum <guido@python.org>
parents: 1683
diff changeset
709 can be returned to mean \EOF{} without being ambiguous. Another
280f31e6c653 copyright.tex: Add 1995 to copyright message.
Guido van Rossum <guido@python.org>
parents: 1683
diff changeset
710 advantage is that (in cases where it might matter, e.g. if you
280f31e6c653 copyright.tex: Add 1995 to copyright message.
Guido van Rossum <guido@python.org>
parents: 1683
diff changeset
711 want to make an exact copy of a file while scanning its lines)
280f31e6c653 copyright.tex: Add 1995 to copyright message.
Guido van Rossum <guido@python.org>
parents: 1683
diff changeset
712 you can tell whether the last line of a file ended in a newline
280f31e6c653 copyright.tex: Add 1995 to copyright message.
Guido van Rossum <guido@python.org>
parents: 1683
diff changeset
713 or not (yes this happens!).}
280f31e6c653 copyright.tex: Add 1995 to copyright message.
Guido van Rossum <guido@python.org>
parents: 1683
diff changeset
714 (but may be absent when a file ends with an
4401
d16b8621a3f0 Typos detected by Sjoerd
Guido van Rossum <guido@python.org>
parents: 3543
diff changeset
715 incomplete line). If the \var{size} argument is present and
2945
f17b7d0a7482 correct description of integer division; describe optional read arg
Guido van Rossum <guido@python.org>
parents: 2819
diff changeset
716 non-negative, it is a maximum byte count (including the trailing
f17b7d0a7482 correct description of integer division; describe optional read arg
Guido van Rossum <guido@python.org>
parents: 2819
diff changeset
717 newline) and an incomplete line may be returned.
f17b7d0a7482 correct description of integer division; describe optional read arg
Guido van Rossum <guido@python.org>
parents: 2819
diff changeset
718 An empty string is returned when \EOF{} is hit
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
719 immediately. Note: unlike \code{stdio}'s \code{fgets()}, the returned
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
720 string contains null characters (\code{'\e 0'}) if they occurred in the
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
721 input.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
722 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
723
5808
dffd22146aab Added fileno(); added readlines(sizehint).
Guido van Rossum <guido@python.org>
parents: 5674
diff changeset
724 \begin{funcdesc}{readlines}{\optional{sizehint}}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
725 Read until \EOF{} using \code{readline()} and return a list containing
5808
dffd22146aab Added fileno(); added readlines(sizehint).
Guido van Rossum <guido@python.org>
parents: 5674
diff changeset
726 the lines thus read. If the optional \var{bufferhint} argument is
dffd22146aab Added fileno(); added readlines(sizehint).
Guido van Rossum <guido@python.org>
parents: 5674
diff changeset
727 present, instead of reading up to \EOF{}, whole lines totalling
dffd22146aab Added fileno(); added readlines(sizehint).
Guido van Rossum <guido@python.org>
parents: 5674
diff changeset
728 approximately \var{sizehint} bytes are read.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
729 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
730
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
731 \begin{funcdesc}{seek}{offset\, whence}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
732 Set the file's current position, like \code{stdio}'s \code{fseek()}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
733 The \var{whence} argument is optional and defaults to \code{0}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
734 (absolute file positioning); other values are \code{1} (seek
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
735 relative to the current position) and \code{2} (seek relative to the
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
736 file's end). There is no return value.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
737 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
738
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
739 \begin{funcdesc}{tell}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
740 Return the file's current position, like \code{stdio}'s \code{ftell()}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
741 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
742
3543
22d7f54c5792 Removed some spurios biindex calls.
Guido van Rossum <guido@python.org>
parents: 2993
diff changeset
743 \begin{funcdesc}{truncate}{\optional{size}}
22d7f54c5792 Removed some spurios biindex calls.
Guido van Rossum <guido@python.org>
parents: 2993
diff changeset
744 Truncate the file's size. If the optional size argument present, the
22d7f54c5792 Removed some spurios biindex calls.
Guido van Rossum <guido@python.org>
parents: 2993
diff changeset
745 file is truncated to (at most) that size. The size defaults to the
22d7f54c5792 Removed some spurios biindex calls.
Guido van Rossum <guido@python.org>
parents: 2993
diff changeset
746 current position. Availability of this function depends on the
4401
d16b8621a3f0 Typos detected by Sjoerd
Guido van Rossum <guido@python.org>
parents: 3543
diff changeset
747 operating system version (e.g., not all \UNIX{} versions support this
3543
22d7f54c5792 Removed some spurios biindex calls.
Guido van Rossum <guido@python.org>
parents: 2993
diff changeset
748 operation).
22d7f54c5792 Removed some spurios biindex calls.
Guido van Rossum <guido@python.org>
parents: 2993
diff changeset
749 \end{funcdesc}
22d7f54c5792 Removed some spurios biindex calls.
Guido van Rossum <guido@python.org>
parents: 2993
diff changeset
750
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
751 \begin{funcdesc}{write}{str}
3543
22d7f54c5792 Removed some spurios biindex calls.
Guido van Rossum <guido@python.org>
parents: 2993
diff changeset
752 Write a string to the file. There is no return value. Note: due to
22d7f54c5792 Removed some spurios biindex calls.
Guido van Rossum <guido@python.org>
parents: 2993
diff changeset
753 buffering, the string may not actually show up in the file until
22d7f54c5792 Removed some spurios biindex calls.
Guido van Rossum <guido@python.org>
parents: 2993
diff changeset
754 the \code{flush()} or \code{close()} method is called.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
755 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
756
1683
080811b1d023 documented writelines()
Guido van Rossum <guido@python.org>
parents: 1625
diff changeset
757 \begin{funcdesc}{writelines}{list}
080811b1d023 documented writelines()
Guido van Rossum <guido@python.org>
parents: 1625
diff changeset
758 Write a list of strings to the file. There is no return value.
080811b1d023 documented writelines()
Guido van Rossum <guido@python.org>
parents: 1625
diff changeset
759 (The name is intended to match \code{readlines}; \code{writelines}
080811b1d023 documented writelines()
Guido van Rossum <guido@python.org>
parents: 1625
diff changeset
760 does not add line separators.)
080811b1d023 documented writelines()
Guido van Rossum <guido@python.org>
parents: 1625
diff changeset
761 \end{funcdesc}
080811b1d023 documented writelines()
Guido van Rossum <guido@python.org>
parents: 1625
diff changeset
762
5808
dffd22146aab Added fileno(); added readlines(sizehint).
Guido van Rossum <guido@python.org>
parents: 5674
diff changeset
763 Classes that are trying to simulate a file object should also have a
dffd22146aab Added fileno(); added readlines(sizehint).
Guido van Rossum <guido@python.org>
parents: 5674
diff changeset
764 writable \code{softspace} attribute, which should be initialized to
dffd22146aab Added fileno(); added readlines(sizehint).
Guido van Rossum <guido@python.org>
parents: 5674
diff changeset
765 zero. (\code{softspace} is used by the \code{print} statement.) This
dffd22146aab Added fileno(); added readlines(sizehint).
Guido van Rossum <guido@python.org>
parents: 5674
diff changeset
766 will be automatic for classes implemented in Python; types implemented
dffd22146aab Added fileno(); added readlines(sizehint).
Guido van Rossum <guido@python.org>
parents: 5674
diff changeset
767 in C will have to provide a writable \code{softspace} attribute.
dffd22146aab Added fileno(); added readlines(sizehint).
Guido van Rossum <guido@python.org>
parents: 5674
diff changeset
768
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2488
diff changeset
769 \subsubsection{Internal Objects}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
770
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
771 (See the Python Reference Manual for these.)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
772
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
773 \subsection{Special Attributes}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
774
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
775 The implementation adds a few special read-only attributes to several
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
776 object types, where they are relevant:
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
777
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
778 \begin{itemize}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
779
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
780 \item
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
781 \code{\var{x}.__dict__} is a dictionary of some sort used to store an
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
782 object's (writable) attributes;
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
783
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
784 \item
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
785 \code{\var{x}.__methods__} lists the methods of many built-in object types,
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2581
diff changeset
786 e.g., \code{[].__methods__} yields
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
787 \code{['append', 'count', 'index', 'insert', 'remove', 'reverse', 'sort']};
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
788
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
789 \item
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
790 \code{\var{x}.__members__} lists data attributes;
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
791
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
792 \item
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
793 \code{\var{x}.__class__} is the class to which a class instance belongs;
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
794
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
795 \item
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
796 \code{\var{x}.__bases__} is the tuple of base classes of a class object.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
797
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
798 \end{itemize}