mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-02 19:12:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Additional docs for __iadd__ and family, closing SF bug #117178 and SF patch

Browse source 
#102169.
This commit is contained in:
Thomas Wouters 2000-12-11 23:11:51 +00:00
parent 2a22200ab4
commit dc90cc2b15
1 changed files with 26 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

26
Doc/ref/ref3.tex
View file

@ -1293,6 +1293,32 @@ try calling \method{__rpow__()} (the coercion rules would become too
complicated). complicated).
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[numeric object]{__iadd__}{self, other}
\methodline[numeric object]{__isub__}{self, other}
\methodline[numeric object]{__imul__}{self, other}
\methodline[numeric object]{__idiv__}{self, other}
\methodline[numeric object]{__imod__}{self, other}
\methodline[numeric object]{__ipow__}{self, other\optional{, modulo}}
\methodline[numeric object]{__ilshift__}{self, other}
\methodline[numeric object]{__irshift__}{self, other}
\methodline[numeric object]{__iand__}{self, other}
\methodline[numeric object]{__ixor__}{self, other}
\methodline[numeric object]{__ior__}{self, other}
These methods are called to implement the augmented arithmetic operations
(\code{+=}, \code{-=}, \code{*=}, \code{/=}, \code{\%=}, \code{**=},
\code{<<=}, \code{>>=}, \code{\&=}, \code{\^=}, \code{|=}). These methods
should attempt to do the operation in-place (modifying \var{self}) and
return the result (which could be, but does not have to be, \var{self}). If
a specific method is not defined, the augmented operation falls back to the
normal methods. For instance, to evaluate the expression
\var{x}\code{+=}\var{y}, where \var{x} is an instance of a class that has an
\method{__iadd__()} method, \code{\var{x}.__iadd__(\var{y})} is called. If
\var{x} is an instance of a class that does not define a \method{__iadd()}
method, \code{\var{x}.__add__(\var{y})} and \code{\var{y}.__radd__(\var{x})}
are considered, as with the evaluation of \var{x}\code{+}\var{y}.
\end{methoddesc}
\begin{methoddesc}[numeric object]{__neg__}{self} \begin{methoddesc}[numeric object]{__neg__}{self}
\methodline[numeric object]{__pos__}{self} \methodline[numeric object]{__pos__}{self}
\methodline[numeric object]{__abs__}{self} \methodline[numeric object]{__abs__}{self}