diff options
| author | Antoine Pitrou <solipsis@pitrou.net> | 2010-09-28 21:53:46 (GMT) |
|---|---|---|
| committer | Antoine Pitrou <solipsis@pitrou.net> | 2010-09-28 21:53:46 (GMT) |
| commit | 6db43fdb3bbe3fc470f51f3674818f925b8f130c (patch) | |
| tree | c59b1910b60d51567110c3ba5ca76a0ff03d3618 /Doc/c-api | |
| parent | 1ec68b132e7aa54d0f5f09f3c7a098294994cd4e (diff) | |
| download | cpython-6db43fdb3bbe3fc470f51f3674818f925b8f130c.zip cpython-6db43fdb3bbe3fc470f51f3674818f925b8f130c.tar.gz cpython-6db43fdb3bbe3fc470f51f3674818f925b8f130c.tar.bz2 | |
Merged revisions 85075 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r85075 | antoine.pitrou | 2010-09-28 23:52:30 +0200 (mar., 28 sept. 2010) | 3 lines
Discourage use of the old buffer API funcs
........
Diffstat (limited to 'Doc/c-api')
| -rw-r--r-- | Doc/c-api/objbuffer.rst | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/Doc/c-api/objbuffer.rst b/Doc/c-api/objbuffer.rst index 0973aad..ef4e4ea 100644 --- a/Doc/c-api/objbuffer.rst +++ b/Doc/c-api/objbuffer.rst @@ -1,6 +1,21 @@ .. highlightlang:: c -.. _abstract-buffer: +Old buffer API +-------------- + +.. 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. + +Therefore, it is recommended that you call :cfunc:`PyObject_GetBuffer` +(or the ``y*`` or ``w*`` :ref:`format codes <arg-parsing>` with the +:cfunc:`PyArg_ParseTuple` family of functions) to get a buffer view over +an object, and :cfunc:`PyBuffer_Release` when the buffer view can be released. + Buffer Protocol =============== |