MemoryView objects¶
Amemoryview object exposes the C levelbuffer interface as a Python object which can then be passed around likeany other object.
- PyObject *
PyMemoryView_FromObject(PyObject *obj)¶ 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.
- PyObject *
PyMemoryView_FromMemory(char *mem, Py_ssize_t size, int flags)¶ Create a memoryview object usingmem as the underlying buffer.flags can be one of
PyBUF_READorPyBUF_WRITE.New in version 3.3.
- PyObject *
PyMemoryView_FromBuffer(Py_buffer *view)¶ Create a memoryview object wrapping the given buffer structureview.For simple byte buffers,
PyMemoryView_FromMemory()is the preferredfunction.
- PyObject *
PyMemoryView_GetContiguous(PyObject *obj, int buffertype, char order)¶ 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.
- int
PyMemoryView_Check(PyObject *obj)¶ Return true if the objectobj is a memoryview object. It is notcurrently allowed to create subclasses of
memoryview.
- 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.
- Py_buffer *
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 functions
PyMemoryView_FromMemory()orPyMemoryView_FromBuffer().mviewmust be a memoryview instance.