Moshe Zadka <mzadka@geocities.com>:

Document the __contains__() method.
(Patch slightly modified by FLD.)

This closes SourceForge patch #101387.
This commit is contained in:
Fred Drake 2000-09-19 18:21:25 +00:00
parent 1156f62348
commit 8d27f898b2

View file

@ -1172,6 +1172,16 @@ involving extended slice notation, or in absence of the slice methods,
\method{__getitem__()}, \method{__setitem__()} or \method{__delitem__()} is
called with a slice object as argument.
The membership test operators (\keyword{in} and \keyword{not in}) are
normally implemented as iteration loop through the sequence. However,
sequence objects can supply the following special method with a more
efficient implementation:
\begin{methoddesc}[sequence object]{__contains__}{self, item}
Called to implement membership test operators. Should return true if
\var{item} is in \var{self}, false otherwise.
\end{methoddesc}
\subsection{Emulating numeric types\label{numeric-types}}