[Python-checkins] python/dist/src/Doc/api concrete.tex,1.62,1.63
rhettinger@users.sourceforge.net
rhettinger at users.sourceforge.net
Tue Aug 16 12:44:25 CEST 2005
Update of /cvsroot/python/python/dist/src/Doc/api
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv10493/Doc/api
Modified Files:
concrete.tex
Log Message:
Numerous fix-ups to C API and docs. Added tests for C API.
Index: concrete.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/api/concrete.tex,v
retrieving revision 1.62
retrieving revision 1.63
diff -u -d -r1.62 -r1.63
--- concrete.tex 16 Aug 2005 03:47:51 -0000 1.62
+++ concrete.tex 16 Aug 2005 10:44:12 -0000 1.63
@@ -2959,14 +2959,16 @@
Returns a new \class{set} containing objects returned by the
\var{iterable}. The \var{iterable} may be \NULL{} to create a
new empty set. Returns the new set on success or \NULL{} on
- failure.
+ failure. Raises \exception{TypeError} if \var{iterable} is
+ not actually iterable.
\end{cfuncdesc}
\begin{cfuncdesc}{PyObject*}{PyFrozenSet_New}{PyObject *iterable}
Returns a new \class{frozenset} containing objects returned by the
\var{iterable}. The \var{iterable} may be \NULL{} to create a
new empty frozenset. Returns the new set on success or \NULL{} on
- failure.
+ failure. Raises \exception{TypeError} if \var{iterable} is
+ not actually iterable.
\end{cfuncdesc}
@@ -2976,7 +2978,7 @@
\begin{cfuncdesc}{int}{PySet_Size}{PyObject *anyset}
Returns the length of a \class{set} or \class{frozenset} object.
Equivalent to \samp{len(\var{anyset})}. Raises a
- \exception{PyExc_SystemError} if the argument is not a \class{set},
+ \exception{PyExc_SystemError} if \var{anyset} is not a \class{set},
\class{frozenset}, or an instance of a subtype.
\bifuncindex{len}
\end{cfuncdesc}
@@ -2989,15 +2991,9 @@
Returns 1 if found, 0 if not found, and -1 if an error is
encountered. Unlike the Python \method{__contains__()} method, this
function does not automatically convert unhashable sets into temporary
- frozensets. Raises a \exception{TypeError} if the key is unhashable.
-\end{cfuncdesc}
-
-\begin{cfuncdesc}{int}{PySet_Discard}{PyObject *anyset, PyObject *key}
- Returns 1 if found and removed, 0 if not found (no action taken),
- and -1 if an error is encountered. Does not raise \exception{KeyError}
- for missing keys. Raises a \exception{TypeError} if the key is unhashable.
- Unlike the Python \method{discard()} method, this function does
- not automatically convert unhashable sets into temporary frozensets.
+ frozensets. Raises a \exception{TypeError} if the \var{key} is unhashable.
+ Raises \exception{PyExc_SystemError} if \var{anyset} is not a \class{set},
+ \class{frozenset}, or an instance of a subtype.
\end{cfuncdesc}
@@ -3007,17 +3003,27 @@
\begin{cfuncdesc}{int}{PySet_Add}{PyObject *set, PyObject *key}
Adds \var{key} to a \class{set} instance. Does not apply to
\class{frozenset} instances. Returns 0 on success or -1 on failure.
- Raises a \exception{TypeError} if the key is unhashable.
+ Raises a \exception{TypeError} if the \var{key} is unhashable.
Raises a \exception{MemoryError} if there is no room to grow.
- Raises a \exception{SystemError} if \var{key} is an not an instance
+ Raises a \exception{SystemError} if \var{set} is an not an instance
of \class{set} or its subtype.
\end{cfuncdesc}
+\begin{cfuncdesc}{int}{PySet_Discard}{PyObject *set, PyObject *key}
+ Returns 1 if found and removed, 0 if not found (no action taken),
+ and -1 if an error is encountered. Does not raise \exception{KeyError}
+ for missing keys. Raises a \exception{TypeError} if the \var{key} is
+ unhashable. Unlike the Python \method{discard()} method, this function
+ does not automatically convert unhashable sets into temporary frozensets.
+ Raises \exception{PyExc_SystemError} if \var{set} is an not an instance
+ of \class{set} or its subtype.
+\end{cfuncdesc}
+
\begin{cfuncdesc}{PyObject*}{PySet_Pop}{PyObject *set}
Returns a new reference to an arbitrary object in the \var{set},
and removes the object from the \var{set}. Returns \NULL{} on
failure. Raises \exception{KeyError} if the set is empty.
- Raises a \exception{SystemError} if \var{key} is an not an instance
+ Raises a \exception{SystemError} if \var{set} is an not an instance
of \class{set} or its subtype.
\end{cfuncdesc}
More information about the Python-checkins
mailing list