diff options
| author | Inada Naoki <songofacandy@gmail.com> | 2020-06-25 23:07:22 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-06-25 23:07:22 (GMT) |
| commit | 6f8a6ee59cb7f99f68df8ee9c3e8c8cf19af3eed (patch) | |
| tree | b5e8c8e1c6f671b1f39078d0a7dbce48fe307f25 /Doc/c-api | |
| parent | 77ed29b2c2742b694cac6db5976afc31b58e4803 (diff) | |
| download | cpython-6f8a6ee59cb7f99f68df8ee9c3e8c8cf19af3eed.zip cpython-6f8a6ee59cb7f99f68df8ee9c3e8c8cf19af3eed.tar.gz cpython-6f8a6ee59cb7f99f68df8ee9c3e8c8cf19af3eed.tar.bz2 | |
bpo-41103: Remove old buffer protocol support (#21117)
They are deprecated since Python 3.0.
Diffstat (limited to 'Doc/c-api')
| -rw-r--r-- | Doc/c-api/abstract.rst | 1 | ||||
| -rw-r--r-- | Doc/c-api/objbuffer.rst | 55 |
2 files changed, 0 insertions, 56 deletions
diff --git a/Doc/c-api/abstract.rst b/Doc/c-api/abstract.rst index 1823f9d..f5df09f 100644 --- a/Doc/c-api/abstract.rst +++ b/Doc/c-api/abstract.rst @@ -24,4 +24,3 @@ but whose items have not been set to some non-\ ``NULL`` value yet. mapping.rst iter.rst buffer.rst - objbuffer.rst diff --git a/Doc/c-api/objbuffer.rst b/Doc/c-api/objbuffer.rst deleted file mode 100644 index 6b82a64..0000000 --- a/Doc/c-api/objbuffer.rst +++ /dev/null @@ -1,55 +0,0 @@ -.. highlight:: c - -Old Buffer Protocol -------------------- - -.. deprecated:: 3.0 - -These functions were part of the "old buffer protocol" API in Python 2. -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 :c:func:`PyObject_GetBuffer` -(or the ``y*`` or ``w*`` :ref:`format codes <arg-parsing>` with the -:c:func:`PyArg_ParseTuple` family of functions) to get a buffer view over -an object, and :c:func:`PyBuffer_Release` when the buffer view can be released. - - -.. c:function:: 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 - input. The *obj* argument must support the single-segment character buffer - interface. On success, returns ``0``, sets *buffer* to the memory location - and *buffer_len* to the buffer length. Returns ``-1`` and sets a - :exc:`TypeError` on error. - - -.. c:function:: int PyObject_AsReadBuffer(PyObject *obj, const void **buffer, Py_ssize_t *buffer_len) - - Returns a pointer to a read-only memory location containing arbitrary data. - The *obj* argument must support the single-segment readable buffer - interface. On success, returns ``0``, sets *buffer* to the memory location - and *buffer_len* to the buffer length. Returns ``-1`` and sets a - :exc:`TypeError` on error. - - -.. c:function:: int PyObject_CheckReadBuffer(PyObject *o) - - Returns ``1`` if *o* supports the single-segment readable buffer interface. - Otherwise returns ``0``. This function always succeeds. - - Note that this function tries to get and release a buffer, and exceptions - which occur while calling corresponding functions will get suppressed. - To get error reporting use :c:func:`PyObject_GetBuffer()` instead. - - -.. c:function:: int PyObject_AsWriteBuffer(PyObject *obj, void **buffer, Py_ssize_t *buffer_len) - - Returns a pointer to a writable memory location. The *obj* argument must - support the single-segment, character buffer interface. On success, - returns ``0``, sets *buffer* to the memory location and *buffer_len* to the - buffer length. Returns ``-1`` and sets a :exc:`TypeError` on error. - |