Mercurial > cpython-lru_cache-weakref

diff Doc/c-api/objbuffer.rst @ 64990:6c8adc200ee0 3.1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 ........
author Antoine Pitrou <solipsis@pitrou.net>
date Tue, 28 Sep 2010 21:53:46 +0000
parents d0594e7a45d6
children 4cf77d193f57
line wrap: on
line diff
--- a/Doc/c-api/objbuffer.rst	Tue Sep 28 15:33:25 2010 +0000
+++ b/Doc/c-api/objbuffer.rst	Tue Sep 28 21:53:46 2010 +0000
@@ -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
 ===============