diff options
author | Antoine Pitrou <solipsis@pitrou.net> | 2010-09-28 23:59:51 (GMT) |
---|---|---|
committer | Antoine Pitrou <solipsis@pitrou.net> | 2010-09-28 23:59:51 (GMT) |
commit | c663b58c9a29c1c5c05c6d33a05a04f7c4fc18fd (patch) | |
tree | 8cb7aa7a80c3134aded5674330606763304f20b6 /Doc | |
parent | f7ba2fa3d663c5755af0932e0d8fe820fb7de8af (diff) | |
download | cpython-c663b58c9a29c1c5c05c6d33a05a04f7c4fc18fd.zip cpython-c663b58c9a29c1c5c05c6d33a05a04f7c4fc18fd.tar.gz cpython-c663b58c9a29c1c5c05c6d33a05a04f7c4fc18fd.tar.bz2 |
Give a dedicated page to memoryview objects, so that they can be part
of the concrete objects layer, while the buffer protocol is part of
the abstract objects layer.
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/c-api/buffer.rst | 50 | ||||
-rw-r--r-- | Doc/c-api/concrete.rst | 1 | ||||
-rw-r--r-- | Doc/c-api/memoryview.rst | 52 |
3 files changed, 55 insertions, 48 deletions
diff --git a/Doc/c-api/buffer.rst b/Doc/c-api/buffer.rst index dbd1e4d..a211ba6 100644 --- a/Doc/c-api/buffer.rst +++ b/Doc/c-api/buffer.rst @@ -65,7 +65,7 @@ in its native, in-memory format. Contrary to most data types exposed by the Python interpreter, buffers are not :ctype:`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 :ref:`memoryview <memoryviewobjects>` object +around a buffer is needed, a :ref:`memoryview <memoryview-objects>` object can be created. @@ -154,7 +154,7 @@ can be created. value. -Buffer related functions +Buffer-related functions ======================== @@ -330,49 +330,3 @@ Buffer related functions only share a contiguous chunk of memory of "unsigned bytes" of the given length. Return 0 on success and -1 (with raising an error) on error. - -.. index:: - object: memoryview - -.. _memoryviewobjects: - -MemoryView objects -================== - -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) - - Create a memoryview object from an object that defines the buffer interface. - - -.. cfunction:: PyObject *PyMemoryView_FromBuffer(Py_buffer *view) - - 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. diff --git a/Doc/c-api/concrete.rst b/Doc/c-api/concrete.rst index 7e8f08c..dc08967 100644 --- a/Doc/c-api/concrete.rst +++ b/Doc/c-api/concrete.rst @@ -99,6 +99,7 @@ Other Objects iterator.rst descriptor.rst slice.rst + memoryview.rst weakref.rst capsule.rst cell.rst diff --git a/Doc/c-api/memoryview.rst b/Doc/c-api/memoryview.rst new file mode 100644 index 0000000..9003d3e --- /dev/null +++ b/Doc/c-api/memoryview.rst @@ -0,0 +1,52 @@ +.. highlightlang:: c + +.. _memoryview-objects: + +.. index:: + object: memoryview + +MemoryView objects +------------------ + +A :class:`memoryview` object exposes the C level :ref:`buffer interface +<bufferobjects>` as a Python object which can then be passed around like +any other object. + + +.. cfunction:: PyObject *PyMemoryView_FromObject(PyObject *obj) + + Create a memoryview object from an object that provides the buffer interface. + If *obj* supports writable buffer exports, the memoryview object will be + readable and writable, other it will be read-only. + + +.. cfunction:: PyObject *PyMemoryView_FromBuffer(Py_buffer *view) + + Create a memoryview object wrapping the given buffer structure *view*. + The memoryview object then owns the buffer represented by *view*, which + means you shouldn't try to call :cfunc:`PyBuffer_Release` yourself: it + will be done 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 structure wrapped by the given + memoryview 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. + |