[Python-checkins] CVS: python/dist/src/Doc/api api.tex,1.149,1.150
Fred L. Drake
fdrake@users.sourceforge.net
Mon, 24 Sep 2001 08:31:52 -0700
Update of /cvsroot/python/python/dist/src/Doc/api
In directory usw-pr-cvs1:/tmp/cvs-serv15999/api
Modified Files:
api.tex
Log Message:
Add more signature information and some descriptions for the new APIs
introduced in Python 2.2.
Add documentation for the slice object interface (not complete).
Added version annotations for several of the Python 2.2 APIs already
documented.
Index: api.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/api/api.tex,v
retrieving revision 1.149
retrieving revision 1.150
diff -C2 -d -r1.149 -r1.150
*** api.tex 2001/09/23 02:05:26 1.149
--- api.tex 2001/09/24 15:31:50 1.150
***************
*** 1691,1694 ****
--- 1691,1695 ----
Return true if the object \var{o} is of type \var{type} or a subtype
of \var{type}. Both parameters must be non-\NULL.
+ \versionadded{2.2}
\end{cfuncdesc}
***************
*** 2340,2351 ****
--- 2341,2359 ----
\begin{cfuncdesc}{int}{PyType_IsSubtype}{PyTypeObject *a, PyTypeObject *b}
Returns true if \var{a} is a subtype of \var{b}.
+ \versionadded{2.2}
\end{cfuncdesc}
\begin{cfuncdesc}{PyObject*}{PyType_GenericAlloc}{PyTypeObject *type,
int nitems}
+ \versionadded{2.2}
\end{cfuncdesc}
\begin{cfuncdesc}{PyObject*}{PyType_GenericNew}{PyTypeObject *type,
PyObject *args, PyObject *kwds}
+ \versionadded{2.2}
+ \end{cfuncdesc}
+
+ \begin{cfuncdesc}{int}{PyType_Ready}{PyTypeObject *type}
+ \versionadded{2.2}
\end{cfuncdesc}
***************
*** 3956,3959 ****
--- 3964,3974 ----
\end{cfuncdesc}
+ \begin{cfuncdesc}{PyObject*}{PyDictProxy_New}{PyObject *dict}
+ Return a proxy object for a mapping which enforces read-only
+ behavior. This is normally used to create a proxy to prevent
+ modification of the dictionary for non-dynamic class types.
+ \versionadded{2.2}
+ \end{cfuncdesc}
+
\begin{cfuncdesc}{void}{PyDict_Clear}{PyObject *p}
Empties an existing dictionary of all key-value pairs.
***************
*** 4382,4389 ****
--- 4397,4406 ----
\cfunction{PySeqIter_New()} and the one-argument form of the
\function{iter()} built-in function for built-in sequence types.
+ \versionadded{2.2}
\end{cvardesc}
\begin{cfuncdesc}{int}{PySeqIter_Check}{op}
Return true if the type of \var{op} is \cdata{PySeqIter_Type}.
+ \versionadded{2.2}
\end{cfuncdesc}
***************
*** 4392,4406 ****
\var{seq}. The iteration ends when the sequence raises
\exception{IndexError} for the subscripting operation.
\end{cfuncdesc}
-
\begin{cvardesc}{PyTypeObject}{PyCallIter_Type}
Type object for iterator objects returned by
\cfunction{PyCallIter_New()} and the two-argument form of the
\function{iter()} built-in function.
\end{cvardesc}
\begin{cfuncdesc}{int}{PyCallIter_Check}{op}
Return true if the type of \var{op} is \cdata{PyCallIter_Type}.
\end{cfuncdesc}
--- 4409,4425 ----
\var{seq}. The iteration ends when the sequence raises
\exception{IndexError} for the subscripting operation.
+ \versionadded{2.2}
\end{cfuncdesc}
\begin{cvardesc}{PyTypeObject}{PyCallIter_Type}
Type object for iterator objects returned by
\cfunction{PyCallIter_New()} and the two-argument form of the
\function{iter()} built-in function.
+ \versionadded{2.2}
\end{cvardesc}
\begin{cfuncdesc}{int}{PyCallIter_Check}{op}
Return true if the type of \var{op} is \cdata{PyCallIter_Type}.
+ \versionadded{2.2}
\end{cfuncdesc}
***************
*** 4412,4415 ****
--- 4431,4503 ----
\var{callable} returns a value equal to \var{sentinel}, the
iteration will be terminated.
+ \versionadded{2.2}
+ \end{cfuncdesc}
+
+
+ \subsection{Descriptor Objects \label{descriptor-objects}}
+
+ \begin{cvardesc}{PyTypeObject}{PyProperty_Type}
+ The type object for a descriptor.
+ \versionadded{2.2}
+ \end{cvardesc}
+
+ \begin{cfuncdesc}{PyObject*}{PyDescr_NewGetSet}{PyTypeObject *type,
+ PyGetSetDef *getset}
+ \versionadded{2.2}
+ \end{cfuncdesc}
+
+ \begin{cfuncdesc}{PyObject*}{PyDescr_NewMember}{PyTypeObject *type,
+ PyMemberDef *meth}
+ \versionadded{2.2}
+ \end{cfuncdesc}
+
+ \begin{cfuncdesc}{PyObject*}{PyDescr_NewMethod}{PyTypeObject *type,
+ PyMethodDef *meth}
+ \versionadded{2.2}
+ \end{cfuncdesc}
+
+ \begin{cfuncdesc}{PyObject*}{PyDescr_NewWrapper}{PyTypeObject *type,
+ struct wrapperbase *wrapper,
+ void *wrapped}
+ \versionadded{2.2}
+ \end{cfuncdesc}
+
+ \begin{cfuncdesc}{int}{PyDescr_IsData}{PyObject *descr}
+ Returns true if the descriptor objects \var{descr} describes a data
+ attribute, or false if it describes a method. \var{descr} must be a
+ descriptor object; there is no error checking.
+ \versionadded{2.2}
+ \end{cfuncdesc}
+
+ \begin{cfuncdesc}{PyObject*}{PyWrapper_New}{PyObject *, PyObject *}
+ \versionadded{2.2}
+ \end{cfuncdesc}
+
+
+ \subsection{Slice Objects \label{slice-objects}}
+
+ \begin{cvardesc}{PyTypeObject}{PySlice_Type}
+ The type object for slice objects. This is the same as
+ \code{types.SliceType}.
+ \withsubitem{(in module types)}{\ttindex{SliceType}}
+ \end{cvardesc}
+
+ \begin{cfuncdesc}{int}{PySlice_Check}{PyObject *ob}
+ Returns true if \var{ob} is a slice object; \var{ob} must not be
+ \NULL.
+ \end{cfuncdesc}
+
+ \begin{cfuncdesc}{PyObject*}{PySlice_New}{PyObject *start, PyObject *stop,
+ PyObject *step}
+ Return a new slice object with the given values. The \var{start},
+ \var{stop}, and \var{step} parameters are used as the values of the
+ slice object attributes of the same names. Any of the values may be
+ \NULL, in which case the \code{None} will be used for the
+ corresponding attribute. Returns \NULL{} if the new object could
+ not be allocated.
+ \end{cfuncdesc}
+
+ \begin{cfuncdesc}{int}{PySlice_GetIndices}{PySliceObject *slice, int length,
+ int *start, int *stop, int *step}
\end{cfuncdesc}