summaryrefslogtreecommitdiffstats
path: root/Doc/api
diff options
context:
space:
mode:
authorRaymond Hettinger <python@rcn.com>2005-08-17 10:05:22 (GMT)
committerRaymond Hettinger <python@rcn.com>2005-08-17 10:05:22 (GMT)
commit0c230b9dacae8bc4c6088689db1dd085fada6b3a (patch)
treeb915f499059b6c64524c1a5b8265f66a4ecbcdd3 /Doc/api
parentf81e45023e114dded93cb1745c01552d8309c39f (diff)
downloadcpython-0c230b9dacae8bc4c6088689db1dd085fada6b3a.zip
cpython-0c230b9dacae8bc4c6088689db1dd085fada6b3a.tar.gz
cpython-0c230b9dacae8bc4c6088689db1dd085fada6b3a.tar.bz2
Note that the PyNumber protocol can access most set methods directly.
Diffstat (limited to 'Doc/api')
-rw-r--r--Doc/api/concrete.tex13
1 files changed, 10 insertions, 3 deletions
diff --git a/Doc/api/concrete.tex b/Doc/api/concrete.tex
index 6c7721d..a385ffd 100644
--- a/Doc/api/concrete.tex
+++ b/Doc/api/concrete.tex
@@ -1144,7 +1144,7 @@ These are the UTF-16 codec APIs:
If \var{consumed} is \NULL{}, behaves like
\cfunction{PyUnicode_DecodeUTF16()}. If \var{consumed} is not \NULL{},
\cfunction{PyUnicode_DecodeUTF16Stateful()} will not treat trailing incomplete
- UTF-16 byte sequences (i.e. an odd number of bytes or a split surrogate pair)
+ UTF-16 byte sequences (such as an odd number of bytes or a split surrogate pair)
as an error. Those bytes will not be decoded and the number of bytes that
have been decoded will be stored in \var{consumed}.
\versionadded{2.4}
@@ -2908,11 +2908,18 @@ Macros for the convenience of modules implementing the DB API:
This section details the public API for \class{set} and \class{frozenset}
objects. Any functionality not listed below is best accessed using the
-abstract object API (including
+either the abstract object protocol (including
\cfunction{PyObject_CallMethod()}, \cfunction{PyObject_RichCompareBool()},
\cfunction{PyObject_Hash()}, \cfunction{PyObject_Repr()},
\cfunction{PyObject_IsTrue()}, \cfunction{PyObject_Print()}, and
-\cfunction{PyObject_GetIter()}).
+\cfunction{PyObject_GetIter()})
+or the abstract number protocol (including
+\cfunction{PyNumber_Add()}, \cfunction{PyNumber_Subtract()},
+\cfunction{PyNumber_Or()}, \cfunction{PyNumber_Xor()},
+\cfunction{PyNumber_InplaceAdd()}, \cfunction{PyNumber_InplaceSubtract()},
+\cfunction{PyNumber_InplaceOr()}, and \cfunction{PyNumber_InplaceXor()}).
+Note, the latter are also useful for copying (\code{c=s+s}) and clearing
+(\code{s-=s}).
\begin{ctypedesc}{PySetObject}
This subtype of \ctype{PyObject} is used to hold the internal data for