From: Fred Drake <fdrake@acm.org>
Date: Tue, 12 Sep 2000 15:22:05 +0000 (+0000)
Subject: Added documentation for PySequence_Fast() and PySequence_Fast_GET_ITEM().
X-Git-Tag: v2.0b2~366
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=81cccb7563bdffacc475e50510951a0c3eaf31ef;p=thirdparty%2FPython%2Fcpython.git

Added documentation for PySequence_Fast() and PySequence_Fast_GET_ITEM().
---

diff --git a/Doc/api/api.tex b/Doc/api/api.tex
index 836d677e4d96..fe56705f9494 100644
--- a/Doc/api/api.tex
+++ b/Doc/api/api.tex
@@ -1780,6 +1780,23 @@ otherwise a tuple will be constructed with the appropriate contents.
 \end{cfuncdesc}
 
 
+\begin{cfuncdesc}{PyObject*}{PySequence_Fast}{PyObject *o, const char *m}
+Returns the sequence \var{o} as a tuple, unless it is already a
+tuple or list, in which case \var{o} is returned.  Use
+\cfunction{PySequence_Fast_GET_ITEM()} to access the members of the
+result.  Returns \NULL{} on failure.  If the object is not a sequence,
+raises \exception{TypeError} with \var{m} as the message text.
+\end{cfuncdesc}
+
+\begin{cfuncdesc}{PyObject*}{PySequence_Fast_GET_ITEM}{PyObject *o, int i}
+Return the \var{i}th element of \var{o}, assuming that \var{o} was
+returned by \cfunction{PySequence_Fast()}, and that \var{i} is within
+bounds.  The caller is expected to get the length of the sequence by
+calling \cfunction{PyObject_Size()} on \var{o}, since lists and tuples
+are guaranteed to always return their true length.
+\end{cfuncdesc}
+
+
 \section{Mapping Protocol \label{mapping}}
 
 \begin{cfuncdesc}{int}{PyMapping_Check}{PyObject *o}
diff --git a/Doc/api/refcounts.dat b/Doc/api/refcounts.dat
index bb71d717e461..09a727e50d49 100644
--- a/Doc/api/refcounts.dat
+++ b/Doc/api/refcounts.dat
@@ -702,6 +702,14 @@ PySequence_DelSlice:PyObject*:o:0:
 PySequence_DelSlice:int:i1::
 PySequence_DelSlice:int:i2::
 
+PySequence_Fast:PyObject*::+1:
+PySequence_Fast:PyObject*:v:0:
+PySequence_Fast:const char*:m::
+
+PySequence_Fast_GET_ITEM:PyObject*::0:
+PySequence_Fast_GET_ITEM:PyObject*:o:0:
+PySequence_Fast_GET_ITEM:int:i::
+
 PySequence_GetItem:PyObject*::+1:
 PySequence_GetItem:PyObject*:o:0:
 PySequence_GetItem:int:i::