缓冲协议 ¶

缓冲结构 ¶

Buffer structures (or simply “buffers”) are useful as a way to expose the binary data from another object to the Python programmer. They can also be used as a zero-copy slicing mechanism. Using their ability to reference a block of memory, it is possible to expose any data to the Python programmer quite easily. The memory could be a large, constant array in a C extension, it could be a raw block of memory for manipulation before passing to an operating system library, or it could be used to pass around structured data in its native, in-memory format.

Contrary to most data types exposed by the Python interpreter, buffers are not PyObject pointers but rather simple C structures. This allows them to be created and copied very simply. When a generic wrapper around a buffer is needed, a memoryview object can be created.

For short instructions how to write an exporting object, see 缓冲对象结构 . For obtaining a buffer, see PyObject_GetBuffer() .

Py_buffer ¶

void * buf ¶

A pointer to the start of the logical structure described by the buffer fields. This can be any location within the underlying physical memory block of the exporter. For example, with negative strides the value may point to the end of the memory block.

For contiguous arrays, the value points to the beginning of the memory block.

void * obj ¶

A new reference to the exporting object. The reference is owned by the consumer and automatically decremented and set to NULL by PyBuffer_Release() . The field is the equivalent of the return value of any standard C-API function.

As a special case, for temporary buffers that are wrapped by PyMemoryView_FromBuffer() or PyBuffer_FillInfo() this field is NULL . In general, exporting objects MUST NOT use this scheme.

Py_ssize_t len ¶

product(shape) * itemsize . For contiguous arrays, this is the length of the underlying memory block. For non-contiguous arrays, it is the length that the logical structure would have if it were copied to a contiguous representation.

访问 ((char *)buf)[0] up to ((char *)buf)[len-1] is only valid if the buffer has been obtained by a request that guarantees contiguity. In most cases such a request will be PyBUF_SIMPLE or PyBUF_WRITABLE .

int readonly ¶

An indicator of whether the buffer is read-only. This field is controlled by the PyBUF_WRITABLE 标志。

Py_ssize_t itemsize ¶

Item size in bytes of a single element. Same as the value of struct.calcsize() called on non-NULL format 值。

Important exception: If a consumer requests a buffer without the PyBUF_FORMAT flag, format 会被设为 NULL ，但 itemsize still has the value for the original format.

若 shape is present, the equality product(shape) * itemsize == len still holds and the consumer can use itemsize to navigate the buffer.

若 shape is NULL as a result of a PyBUF_SIMPLE 或 PyBUF_WRITABLE request, the consumer must disregard itemsize and assume itemsize == 1 .

const char * format ¶

A NUL terminated string in struct module style syntax describing the contents of a single item. If this is NULL , "B" (unsigned bytes) is assumed.

This field is controlled by the PyBUF_FORMAT 标志。

int ndim ¶

The number of dimensions the memory represents as an n-dimensional array. If it is 0 , buf points to a single item representing a scalar. In this case, shape , strides and suboffsets MUST be NULL .

The macro PyBUF_MAX_NDIM limits the maximum number of dimensions to 64. Exporters MUST respect this limit, consumers of multi-dimensional buffers SHOULD be able to handle up to PyBUF_MAX_NDIM dimensions.

Py_ssize_t * shape ¶

An array of Py_ssize_t of length ndim indicating the shape of the memory as an n-dimensional array. Note that shape[0] * ... * shape[ndim-1] * itemsize MUST be equal to len .

Shape values are restricted to shape[n] >= 0 . The case shape[n] == 0 requires special attention. See complex arrays for further information.

The shape array is read-only for the consumer.

Py_ssize_t * strides ¶

An array of Py_ssize_t of length ndim giving the number of bytes to skip to get to a new element in each dimension.

Stride values can be any integer. For regular arrays, strides are usually positive, but a consumer MUST be able to handle the case strides[n] <= 0 。见 complex arrays for further information.

The strides array is read-only for the consumer.

Py_ssize_t * suboffsets ¶

An array of Py_ssize_t of length ndim 。若 suboffsets[n] >= 0 , the values stored along the nth dimension are pointers and the suboffset value dictates how many bytes to add to each pointer after de-referencing. A suboffset value that is negative indicates that no de-referencing should occur (striding in a contiguous memory block).

If all suboffsets are negative (i.e. no de-referencing is needed), then this field must be NULL (the default value).

This type of array representation is used by the Python Imaging Library (PIL). See complex arrays for further information how to access elements of such an array.

The suboffsets array is read-only for the consumer.

void * internal ¶

This is for use internally by the exporting object. For example, this might be re-cast as an integer by the exporter and used to store flags about whether or not the shape, strides, and suboffsets arrays must be freed when the buffer is released. The consumer MUST NOT alter this value.

缓冲请求类型 ¶

Buffers are usually obtained by sending a buffer request to an exporting object via PyObject_GetBuffer() . Since the complexity of the logical structure of the memory can vary drastically, the consumer uses the flags argument to specify the exact buffer type it can handle.

所有 Py_buffer fields are unambiguously defined by the request type.

复杂数组 ¶

def verify_structure(memlen, itemsize, ndim, shape, strides, offset):
    """Verify that the parameters represent a valid array within
       the bounds of the allocated memory:
           char *mem: start of the physical memory block
           memlen: length of the physical memory block
           offset: (char *)buf - mem
    """
    if offset % itemsize:
        return False
    if offset < 0 or offset+itemsize > memlen:
        return False
    if any(v % itemsize for v in strides):
        return False
    if ndim <= 0:
        return ndim == 0 and not shape and not strides
    if 0 in shape:
        return True
    imin = sum(strides[j]*(shape[j]-1) for j in range(ndim)
               if strides[j] <= 0)
    imax = sum(strides[j]*(shape[j]-1) for j in range(ndim)
               if strides[j] > 0)
    return 0 <= offset+imin and offset+imax+itemsize <= memlen
									

void *get_item_pointer(int ndim, void *buf, Py_ssize_t *strides,
                       Py_ssize_t *suboffsets, Py_ssize_t *indices) {
    char *pointer = (char*)buf;
    int i;
    for (i = 0; i < ndim; i++) {
        pointer += strides[i] * indices[i];
        if (suboffsets[i] >=0 ) {
            pointer = *((char**)pointer) + suboffsets[i];
        }
    }
    return (void*)pointer;
}
									

缓冲相关函数 ¶

int PyObject_CheckBuffer ( PyObject  *obj ) ¶

返回 1 if obj supports the buffer interface otherwise 0 。当 1 is returned, it doesn’t guarantee that PyObject_GetBuffer() will succeed. This function always succeeds.

int PyObject_GetBuffer ( PyObject  *exporter , Py_buffer  *view , int  flags ) ¶

Send a request to exporter to fill in view as specified by flags . If the exporter cannot provide a buffer of the exact type, it MUST raise PyExc_BufferError , set view->obj to NULL 并返回 -1 .

On success, fill in view , set view->obj to a new reference to exporter and return 0. In the case of chained buffer providers that redirect requests to a single object, view->obj MAY refer to this object instead of exporter (见 缓冲对象结构 ).

Successful calls to PyObject_GetBuffer() must be paired with calls to PyBuffer_Release() ，类似 malloc() and free() . Thus, after the consumer is done with the buffer, PyBuffer_Release() must be called exactly once.

void PyBuffer_Release ( Py_buffer  *view ) ¶

Release the buffer view and decrement the reference count for view->obj . This function MUST be called when the buffer is no longer being used, otherwise reference leaks may occur.

It is an error to call this function on a buffer that was not obtained via PyObject_GetBuffer() .

Py_ssize_t PyBuffer_SizeFromFormat ( const char  * ) ¶

Return the implied itemsize from format . This function is not yet implemented.

int PyBuffer_IsContiguous ( Py_buffer  *view , char  order ) ¶

返回 1 if the memory defined by the view is C-style ( order is 'C' ) or Fortran-style ( order is 'F' ) contiguous or either one ( order is 'A' ). Return 0 otherwise. This function always succeeds.

int PyBuffer_ToContiguous ( void  *buf , Py_buffer  *src , Py_ssize_t  len , char  order ) ¶

拷贝 len 字节来自 src to its contiguous representation in buf . order 可以是 'C' or 'F' (for C-style or Fortran-style ordering). 0 is returned on success, -1 当出错时。

This function fails if len != src->len .

void PyBuffer_FillContiguousStrides ( int  ndims , Py_ssize_t  *shape , Py_ssize_t  *strides , int  itemsize , char  order ) ¶

Fill the strides array with byte-strides of a contiguous (C-style if order is 'C' or Fortran-style if order is 'F' ) array of the given shape with the given number of bytes per element.

int PyBuffer_FillInfo ( Py_buffer  *view , PyObject  *exporter , void  *buf , Py_ssize_t  len , int  readonly , int  flags ) ¶

Handle buffer requests for an exporter that wants to expose buf of size len with writability set according to readonly . buf is interpreted as a sequence of unsigned bytes.

flags argument indicates the request type. This function always fills in view as specified by flags, unless buf has been designated as read-only and PyBUF_WRITABLE is set in flags .

On success, set view->obj to a new reference to exporter and return 0. Otherwise, raise PyExc_BufferError , set view->obj to NULL 并返回 -1 ;

If this function is used as part of a getbufferproc , exporter MUST be set to the exporting object and flags must be passed unmodified. Otherwise, exporter MUST be NULL.