summaryrefslogtreecommitdiffstats
path: root/Doc/c-api/objbuffer.rst
diff options
context:
space:
mode:
authorAntoine Pitrou <solipsis@pitrou.net>2010-09-28 23:39:41 (GMT)
committerAntoine Pitrou <solipsis@pitrou.net>2010-09-28 23:39:41 (GMT)
commitf7ba2fa3d663c5755af0932e0d8fe820fb7de8af (patch)
treecc20c969386846e73237f146de64f9cd9372ab81 /Doc/c-api/objbuffer.rst
parent99a00a455c186873cf23adde0c6c1bab4d14a4c0 (diff)
downloadcpython-f7ba2fa3d663c5755af0932e0d8fe820fb7de8af.zip
cpython-f7ba2fa3d663c5755af0932e0d8fe820fb7de8af.tar.gz
cpython-f7ba2fa3d663c5755af0932e0d8fe820fb7de8af.tar.bz2
Buffers are not sequence objects (!). Put them in the abstract objects layers
instead.
Diffstat (limited to 'Doc/c-api/objbuffer.rst')
-rw-r--r--Doc/c-api/objbuffer.rst17
1 files changed, 7 insertions, 10 deletions
diff --git a/Doc/c-api/objbuffer.rst b/Doc/c-api/objbuffer.rst
index ef4e4ea..728d383 100644
--- a/Doc/c-api/objbuffer.rst
+++ b/Doc/c-api/objbuffer.rst
@@ -1,15 +1,16 @@
.. highlightlang:: c
-Old buffer API
---------------
+Old Buffer Protocol
+-------------------
.. deprecated:: 3.0
These functions were part of the "old buffer protocol" API in Python 2.
-In Python 3, these functions are still exposed for ease of porting code.
-They act as a compatibility wrapper around the :ref:`new buffer API
-<bufferobjects>`, but they don't give you control over the lifetime of
-the resources acquired when a buffer is exported.
+In Python 3, this protocol doesn't exist anymore but the functions are still
+exposed to ease porting 2.x code. They act as a compatibility wrapper
+around the :ref:`new buffer protocol <bufferobjects>`, but they don't give
+you control over the lifetime of the resources acquired when a buffer is
+exported.
Therefore, it is recommended that you call :cfunc:`PyObject_GetBuffer`
(or the ``y*`` or ``w*`` :ref:`format codes <arg-parsing>` with the
@@ -17,10 +18,6 @@ Therefore, it is recommended that you call :cfunc:`PyObject_GetBuffer`
an object, and :cfunc:`PyBuffer_Release` when the buffer view can be released.
-Buffer Protocol
-===============
-
-
.. cfunction:: int PyObject_AsCharBuffer(PyObject *obj, const char **buffer, Py_ssize_t *buffer_len)
Returns a pointer to a read-only memory location usable as character-based