Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
cpython
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kirill Smelkov
cpython
Commits
826903ec
Commit
826903ec
authored
Sep 28, 2010
by
Antoine Pitrou
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Issue #9970: improve C API documentation for memoryview objects
parent
01c42899
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
28 additions
and
6 deletions
+28
-6
Doc/c-api/buffer.rst
Doc/c-api/buffer.rst
+28
-6
No files found.
Doc/c-api/buffer.rst
View file @
826903ec
...
...
@@ -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.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment