]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Add descriptions of {}.iteritems(), {}.iterkeys(), and {}.itervalues()
authorFred Drake <fdrake@acm.org>
Fri, 25 May 2001 04:24:37 +0000 (04:24 +0000)
committerFred Drake <fdrake@acm.org>
Fri, 25 May 2001 04:24:37 +0000 (04:24 +0000)
in the table of mapping object operations.  Re-numbered the list of
notes to reflect the move of the "Added in version 2.2." note to the list
of notes instead of being inserted into the last column of the table.

Doc/lib/libstdtypes.tex

index da8e61fac346a7e90e10d4b5d16a7dad07b7468c..d55127cdb6335c2afe21edcc11d224f4643e11c0 100644 (file)
@@ -923,29 +923,38 @@ arbitrary objects):
           {}
   \lineiii{\var{k} \code{in} \var{a}}
           {Equivalent to \var{a}.has_key(\var{k})}
-          {\versionadded{2.2}}
+          {(2)}
   \lineiii{\var{k} not in \var{a}}
           {Equivalent to \code{not} \var{a}.has_key(\var{k})}
-          {\versionadded{2.2}}
+          {(2)}
   \lineiii{\var{a}.items()}
           {a copy of \var{a}'s list of (\var{key}, \var{value}) pairs}
-          {(2)}
+          {(3)}
   \lineiii{\var{a}.keys()}{a copy of \var{a}'s list of keys}{(2)}
   \lineiii{\var{a}.update(\var{b})}
           {\code{for k in \var{b}.keys(): \var{a}[k] = \var{b}[k]}}
-          {(3)}
+          {(4)}
   \lineiii{\var{a}.values()}{a copy of \var{a}'s list of values}{(2)}
   \lineiii{\var{a}.get(\var{k}\optional{, \var{x}})}
           {\code{\var{a}[\var{k}]} if \code{\var{k} in \var{a}},
            else \var{x}}
-          {(4)}
+          {(5)}
   \lineiii{\var{a}.setdefault(\var{k}\optional{, \var{x}})}
           {\code{\var{a}[\var{k}]} if \code{\var{k} in \var{a}},
            else \var{x} (also setting it)}
-          {(5)}
+          {(6)}
   \lineiii{\var{a}.popitem()}
           {remove and return an arbitrary (\var{key}, \var{value}) pair}
-          {(6)}
+          {(7)}
+  \lineiii{\var{a}.iteritems()}
+          {return an iterator over (\var{key}, \var{value}) pairs}
+          {(2)}
+  \lineiii{\var{a}.iterkeys()}
+          {return an iterator over the mapping's keys}
+          {(2)}
+  \lineiii{\var{a}.itervalues()}
+          {return an iterator over the mapping's values}
+          {(2)}
 \end{tableiii}
 
 \noindent
@@ -954,24 +963,26 @@ Notes:
 \item[(1)] Raises a \exception{KeyError} exception if \var{k} is not
 in the map.
 
-\item[(2)] Keys and values are listed in random order.  If
+\item[(2)] \versionadded{2.2}
+
+\item[(3)] Keys and values are listed in random order.  If
 \method{keys()} and \method{values()} are called with no intervening
 modifications to the dictionary, the two lists will directly
 correspond.  This allows the creation of \code{(\var{value},
 \var{key})} pairs using \function{map()}: \samp{pairs = map(None,
 \var{a}.values(), \var{a}.keys())}.
 
-\item[(3)] \var{b} must be of the same type as \var{a}.
+\item[(4)] \var{b} must be of the same type as \var{a}.
 
-\item[(4)] Never raises an exception if \var{k} is not in the map,
+\item[(5)] Never raises an exception if \var{k} is not in the map,
 instead it returns \var{x}.  \var{x} is optional; when \var{x} is not
 provided and \var{k} is not in the map, \code{None} is returned.
 
-\item[(5)] \function{setdefault()} is like \function{get()}, except
+\item[(6)] \function{setdefault()} is like \function{get()}, except
 that if \var{k} is missing, \var{x} is both returned and inserted into
 the dictionary as the value of \var{k}.
 
-\item[(6)] \function{popitem()} is useful to destructively iterate
+\item[(7)] \function{popitem()} is useful to destructively iterate
 over a dictionary, as often used in set algorithms.
 \end{description}