]> granicus.if.org Git - python/commitdiff
Document the mapping object's new get() method.
authorBarry Warsaw <barry@python.org>
Mon, 6 Oct 1997 17:50:48 +0000 (17:50 +0000)
committerBarry Warsaw <barry@python.org>
Mon, 6 Oct 1997 17:50:48 +0000 (17:50 +0000)
Doc/lib/libtypes.tex
Doc/libtypes.tex

index e040c3a543f4b3b0bcef2effd573f0f1c3f5871a..029da07f654c692afbfec852e1978fa55db8b698 100644 (file)
@@ -528,6 +528,7 @@ mapping, \var{k} is a key and \var{x} is an arbitrary object):
   \lineiii{\var{a}.keys()}{a copy of \var{a}'s list of keys}{(2)}
   \lineiii{\var{a}.update(b)}{\code{for k, v in b.items(): a[k] = v}}{(3)}
   \lineiii{\var{a}.values()}{a copy of \var{a}'s list of values}{(2)}
+  \lineiii{\var{a}.get(k, f)}{the item of \var{a} with key \var{k}}{(4)}
 \end{tableiii}
 \indexiii{operations on}{mapping}{types}
 \indexiii{operations on}{dictionary}{type}
@@ -545,6 +546,10 @@ Notes:
 \item[(2)] Keys and values are listed in random order.
 
 \item[(3)] \code{b} must be of the same type as \code{a}.
+
+\item[(4)] Never raises an exception if \var{k} is not in the map,
+instead it returns \var{f}.  \var{f} is optional, when not provided
+and \var{k} is not in the map, \code{None} is returned.
 \end{description}
 
 \subsection{Other Built-in Types}
index e040c3a543f4b3b0bcef2effd573f0f1c3f5871a..029da07f654c692afbfec852e1978fa55db8b698 100644 (file)
@@ -528,6 +528,7 @@ mapping, \var{k} is a key and \var{x} is an arbitrary object):
   \lineiii{\var{a}.keys()}{a copy of \var{a}'s list of keys}{(2)}
   \lineiii{\var{a}.update(b)}{\code{for k, v in b.items(): a[k] = v}}{(3)}
   \lineiii{\var{a}.values()}{a copy of \var{a}'s list of values}{(2)}
+  \lineiii{\var{a}.get(k, f)}{the item of \var{a} with key \var{k}}{(4)}
 \end{tableiii}
 \indexiii{operations on}{mapping}{types}
 \indexiii{operations on}{dictionary}{type}
@@ -545,6 +546,10 @@ Notes:
 \item[(2)] Keys and values are listed in random order.
 
 \item[(3)] \code{b} must be of the same type as \code{a}.
+
+\item[(4)] Never raises an exception if \var{k} is not in the map,
+instead it returns \var{f}.  \var{f} is optional, when not provided
+and \var{k} is not in the map, \code{None} is returned.
 \end{description}
 
 \subsection{Other Built-in Types}