MemoryView objects

Amemoryview object exposes the C levelbuffer interface as a Python object which can then be passed around likeany other object.

PyTypeObjectPyMemoryView_Type
Part of theStable ABI.

This instance ofPyTypeObject represents the Python memoryviewtype. This is the same object asmemoryview in the Python layer.

PyObject*PyMemoryView_FromObject(PyObject*obj)
Return value: New reference. Part of theStable ABI.

Create a memoryview object from an object that provides the buffer interface.Ifobj supports writable buffer exports, the memoryview object will beread/write, otherwise it may be either read-only or read/write at thediscretion of the exporter.

PyBUF_READ
Part of theStable ABI since version 3.11.

Flag to request a readonly buffer.

PyBUF_WRITE
Part of theStable ABI since version 3.11.

Flag to request a writable buffer.

PyObject*PyMemoryView_FromMemory(char*mem,Py_ssize_tsize,intflags)
Return value: New reference. Part of theStable ABI since version 3.7.

Create a memoryview object usingmem as the underlying buffer.flags can be one ofPyBUF_READ orPyBUF_WRITE.

Added in version 3.3.

PyObject*PyMemoryView_FromBuffer(constPy_buffer*view)
Return value: New reference. Part of theStable ABI since version 3.11.

Create a memoryview object wrapping the given buffer structureview.For simple byte buffers,PyMemoryView_FromMemory() is the preferredfunction.

PyObject*PyMemoryView_GetContiguous(PyObject*obj,intbuffertype,charorder)
Return value: New reference. Part of theStable ABI.

Create a memoryview object to acontiguous chunk of memory (in either‘C’ or ‘F’ortranorder) from an object that defines the bufferinterface. If memory is contiguous, the memoryview object points to theoriginal memory. Otherwise, a copy is made and the memoryview points to anew bytes object.

buffertype can be one ofPyBUF_READ orPyBUF_WRITE.

intPyMemoryView_Check(PyObject*obj)

Return true if the objectobj is a memoryview object. It is notcurrently allowed to create subclasses ofmemoryview. Thisfunction always succeeds.

Py_buffer*PyMemoryView_GET_BUFFER(PyObject*mview)

Return a pointer to the memoryview’s private copy of the exporter’s buffer.mviewmust be a memoryview instance; this macro doesn’t check its type,you must do it yourself or you will risk crashes.

PyObject*PyMemoryView_GET_BASE(PyObject*mview)

Return either a pointer to the exporting object that the memoryview is basedon orNULL if the memoryview has been created by one of the functionsPyMemoryView_FromMemory() orPyMemoryView_FromBuffer().mviewmust be a memoryview instance.