diff options
| author | Antoine Pitrou <solipsis@pitrou.net> | 2010-09-28 21:52:30 (GMT) |
|---|---|---|
| committer | Antoine Pitrou <solipsis@pitrou.net> | 2010-09-28 21:52:30 (GMT) |
| commit | a0b6873d476789270934ddb9d187323f4edbdd2b (patch) | |
| tree | bb68b5c91b1ea12fda675d23aa4cdcfbf9d33e91 /Doc | |
| parent | 3e1fd27b74af4f1f040f8b11379015140240deff (diff) | |
| download | cpython-a0b6873d476789270934ddb9d187323f4edbdd2b.zip cpython-a0b6873d476789270934ddb9d187323f4edbdd2b.tar.gz cpython-a0b6873d476789270934ddb9d187323f4edbdd2b.tar.bz2 | |
Discourage use of the old buffer API funcs
Diffstat (limited to 'Doc')
| -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 =============== |