mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-03 19:34:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Add documentation for PyObject_RichCompare() and PyObject_RichCompareBool(),

Browse source 
constributed by David Abrahams.
This closes SF patch #568081.
This commit is contained in:
Fred Drake 2002-06-13 11:51:48 +00:00
parent 2e82e717e6
commit 178153f8d6
1 changed files with 42 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

42
Doc/api/abstract.tex
View file

@ -81,6 +81,48 @@ for which they do not apply, they will raise a Python exception.
\end{cfuncdesc}
\begin{cfuncdesc}{PyObject*}{PyObject_RichCompare}{PyObject *o1,
PyObject *o2, int op}
Compare the values of \var{o1} and \var{o2} using the operation
specified by \var{op}, which must be one of
\constant{Py_LT},
\constant{Py_LE},
\constant{Py_EQ},
\constant{Py_NE},
\constant{Py_GT}, or
\constant{Py_GE}, corresponding to
\code{<},
\code{<=},
\code{==},
\code{!=},
\code{>}, or
\code{>=} respectively. This is the equivalent of the Python expression
\samp{\var{o1} \emph{op} \var{o2}}, where \emph{op} is the operator
corresponding to \var{op}. Returns the value of the comparison on
success, or \NULL{} on failure.
\end{cfuncdesc}
\begin{cfuncdesc}{int}{PyObject_RichCompareBool}{PyObject *o1,
PyObject *o2, int op}
Compare the values of \var{o1} and \var{o2} using the operation
specified by \var{op}, which must be one of
\constant{Py_LT},
\constant{Py_LE},
\constant{Py_EQ},
\constant{Py_NE},
\constant{Py_GT}, or
\constant{Py_GE}, corresponding to
\code{<},
\code{<=},
\code{==},
\code{!=},
\code{>}, or
\code{>=} respectively. Returns \code{-1} on error, \code{0} if the
result is false, \code{1} otherwise. This is the equivalent of the
Python expression \samp{\var{o1} \emph{op} \var{o2}}, where
\emph{op} is the operator corresponding to \var{op}.
\end{cfuncdesc}
\begin{cfuncdesc}{int}{PyObject_Cmp}{PyObject *o1, PyObject *o2, int *result}
Compare the values of \var{o1} and \var{o2} using a routine provided
by \var{o1}, if one exists, otherwise with a routine provided by