Mercurial > cpython-lru_cache-weakref
diff Doc/c-api/typeobj.rst @ 75455:da2aaced21bd
Issue #14181: Improve clarity in the documentation for the multi-purpose
Py_buffer.obj field.
| author | Stefan Krah <skrah@bytereef.org> |
|---|---|
| date | Tue, 06 Mar 2012 14:55:06 +0100 |
| parents | 3f9b3b6f7ff0 |
| children | a381721299a3 3f994367a979 |
line wrap: on
line diff
--- a/Doc/c-api/typeobj.rst Tue Mar 06 13:45:57 2012 +0100 +++ b/Doc/c-api/typeobj.rst Tue Mar 06 14:55:06 2012 +0100 @@ -1213,18 +1213,29 @@ int (PyObject *exporter, Py_buffer *view, int flags); Handle a request to *exporter* to fill in *view* as specified by *flags*. - A standard implementation of this function will take these steps: + Except for point (3), an implementation of this function MUST take these + steps: + + (1) Check if the request can be met. If not, raise :c:data:`PyExc_BufferError`, + set :c:data:`view->obj` to *NULL* and return -1. - - Check if the request can be met. If not, raise :c:data:`PyExc_BufferError`, - set :c:data:`view->obj` to *NULL* and return -1. + (2) Fill in the requested fields. + + (3) Increment an internal counter for the number of exports. + + (4) Set :c:data:`view->obj` to *exporter* and increment :c:data:`view->obj`. - - Fill in the requested fields. + (5) Return 0. - - Increment an internal counter for the number of exports. + If *exporter* is part of a chain or tree of buffer providers, two main + schemes can be used: - - Set :c:data:`view->obj` to *exporter* and increment :c:data:`view->obj`. + * Re-export: Each member of the tree acts as the exporting object and + sets :c:data:`view->obj` to a new reference to itself. - - Return 0. + * Redirect: The buffer request is redirected to the root object of the + tree. Here, :c:data:`view->obj` will be a new reference to the root + object. The individual fields of *view* are described in section :ref:`Buffer structure <buffer-structure>`, the rules how an exporter @@ -1233,8 +1244,9 @@ All memory pointed to in the :c:type:`Py_buffer` structure belongs to the exporter and must remain valid until there are no consumers left. - :c:member:`~Py_buffer.shape`, :c:member:`~Py_buffer.strides`, - :c:member:`~Py_buffer.suboffsets` and :c:member:`~Py_buffer.internal` + :c:member:`~Py_buffer.format`, :c:member:`~Py_buffer.shape`, + :c:member:`~Py_buffer.strides`, :c:member:`~Py_buffer.suboffsets` + and :c:member:`~Py_buffer.internal` are read-only for the consumer. :c:func:`PyBuffer_FillInfo` provides an easy way of exposing a simple @@ -1250,21 +1262,23 @@ void (PyObject *exporter, Py_buffer *view); Handle a request to release the resources of the buffer. If no resources - need to be released, this field may be *NULL*. A standard implementation - of this function will take these steps: + need to be released, :c:member:`PyBufferProcs.bf_releasebuffer` may be + *NULL*. Otherwise, a standard implementation of this function will take + these optional steps: - - Decrement an internal counter for the number of exports. + (1) Decrement an internal counter for the number of exports. - - If the counter is 0, free all memory associated with *view*. + (2) If the counter is 0, free all memory associated with *view*. The exporter MUST use the :c:member:`~Py_buffer.internal` field to keep - track of buffer-specific resources (if present). This field is guaranteed - to remain constant, while a consumer MAY pass a copy of the original buffer - as the *view* argument. + track of buffer-specific resources. This field is guaranteed to remain + constant, while a consumer MAY pass a copy of the original buffer as the + *view* argument. This function MUST NOT decrement :c:data:`view->obj`, since that is - done automatically in :c:func:`PyBuffer_Release`. + done automatically in :c:func:`PyBuffer_Release` (this scheme is + useful for breaking reference cycles). :c:func:`PyBuffer_Release` is the interface for the consumer that
