summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorAntoine Pitrou <solipsis@pitrou.net>2010-09-28 15:29:16 (GMT)
committerAntoine Pitrou <solipsis@pitrou.net>2010-09-28 15:29:16 (GMT)
commit826903ece32752015ae4a0a6f9d65d6f1f904a32 (patch)
treebcb18f0e22ef95eeb2f297f0f8b6e5e6eb228fc2 /Doc
parent01c428999a7051f197ef1d56b70c385e0ea95cbd (diff)
downloadcpython-826903ece32752015ae4a0a6f9d65d6f1f904a32.zip
cpython-826903ece32752015ae4a0a6f9d65d6f1f904a32.tar.gz
cpython-826903ece32752015ae4a0a6f9d65d6f1f904a32.tar.bz2
Issue #9970: improve C API documentation for memoryview objects
Diffstat (limited to 'Doc')
-rw-r--r--Doc/c-api/buffer.rst34
1 files changed, 28 insertions, 6 deletions
diff --git a/Doc/c-api/buffer.rst b/Doc/c-api/buffer.rst
index c2bc3e3..a4c8e52 100644
--- a/Doc/c-api/buffer.rst
+++ b/Doc/c-api/buffer.rst
@@ -303,18 +303,40 @@ Buffer related functions
MemoryView objects
==================
-A memoryview object exposes the C level buffer interface to Python.
+A :class:`memoryview` object exposes the C level buffer interface as a
+Python object which can then be passed around like any other object.
-.. cfunction:: PyObject* PyMemoryView_FromObject(PyObject *obj)
+.. cfunction:: PyObject *PyMemoryView_FromObject(PyObject *obj)
- Return a memoryview object from an object that defines the buffer interface.
+ Create a memoryview object from an object that defines the buffer interface.
-.. cfunction:: PyObject * PyMemoryView_GetContiguous(PyObject *obj, int buffertype, char order)
+.. cfunction:: PyObject *PyMemoryView_FromBuffer(Py_buffer *view)
- Return a memoryview object to a contiguous chunk of memory (in either
- 'C' or 'F'ortran order) from an object that defines the buffer
+ Create a memoryview object wrapping the given buffer-info structure *view*.
+ The memoryview object then owns the buffer, which means you shouldn't
+ try to release it yourself: it will be released on deallocation of the
+ memoryview object.
+
+
+.. cfunction:: PyObject *PyMemoryView_GetContiguous(PyObject *obj, int buffertype, char order)
+
+ Create a memoryview object to a contiguous chunk of memory (in either
+ 'C' or 'F'ortran *order*) from an object that defines the buffer
interface. If memory is contiguous, the memoryview object points to the
original memory. Otherwise copy is made and the memoryview points to a
new bytes object.
+
+
+.. cfunction:: int PyMemoryView_Check(PyObject *obj)
+
+ Return true if the object *obj* is a memoryview object. It is not
+ currently allowed to create subclasses of :class:`memoryview`.
+
+
+.. cfunction:: Py_buffer *PyMemoryView_GET_BUFFER(PyObject *obj)
+
+ Return a pointer to the buffer-info structure wrapped by the given
+ object. The object **must** be a memoryview instance; this macro doesn't
+ check its type, you must do it yourself or you will risk crashes.