cpython-lru_cache-weakref: Include/memoryobject.h annotate

annotate Include/memoryobject.h @ 56121:ea697cde6882 3.1

Merged revisions 74881-74885,74888,74891-74895,74900,74905-74906,74931-74932,74934,74941-74942,74944,74956 via svnmerge from svn+ssh://pythondev@svn.python.org/python/branches/py3k ........ r74881 | r.david.murray | 2009-09-17 15:12:49 -0400 (Thu, 17 Sep 2009) | 2 lines Check in first draft of maintainers.rst. ........ r74882 | eric.smith | 2009-09-17 15:22:30 -0400 (Thu, 17 Sep 2009) | 1 line Typo. ........ r74883 | mark.dickinson | 2009-09-17 15:37:28 -0400 (Thu, 17 Sep 2009) | 1 line Add some more module maintainers. ........ r74884 | mark.dickinson | 2009-09-17 15:39:12 -0400 (Thu, 17 Sep 2009) | 1 line Revert accidental changes to Objects/longobject.c ........ r74885 | mark.dickinson | 2009-09-17 16:20:01 -0400 (Thu, 17 Sep 2009) | 1 line Add decimal maintainers ........ r74888 | r.david.murray | 2009-09-17 18:10:48 -0400 (Thu, 17 Sep 2009) | 2 lines Maintainer additions from MAL. ........ r74891 | georg.brandl | 2009-09-17 18:18:01 -0400 (Thu, 17 Sep 2009) | 1 line Some more maintainers. ........ r74892 | r.david.murray | 2009-09-17 19:23:56 -0400 (Thu, 17 Sep 2009) | 2 lines Add a couple interest areas for Nick per his request. ........ r74893 | r.david.murray | 2009-09-17 19:43:20 -0400 (Thu, 17 Sep 2009) | 2 lines Benajmin is also compiler-knowledgeable. ........ r74894 | alexandre.vassalotti | 2009-09-17 20:59:05 -0400 (Thu, 17 Sep 2009) | 2 lines Added myself to my areas of interest. ........ r74895 | brett.cannon | 2009-09-17 21:03:35 -0400 (Thu, 17 Sep 2009) | 1 line Add myself to a couple places as maintainer. ........ r74900 | georg.brandl | 2009-09-18 05:06:37 -0400 (Fri, 18 Sep 2009) | 1 line Add myself in interest areas. ........ r74905 | ezio.melotti | 2009-09-18 05:58:43 -0400 (Fri, 18 Sep 2009) | 1 line Add myself in interest areas and mark effbot as inactive in winsound ........ r74906 | antoine.pitrou | 2009-09-18 09:15:23 -0400 (Fri, 18 Sep 2009) | 3 lines Add myself in a couple of places ........ r74931 | r.david.murray | 2009-09-18 17:25:36 -0400 (Fri, 18 Sep 2009) | 5 lines Add some names gleaned from the "Tracker Archeology" thread on python-dev from back in February. Also consolidate the autoconf and makefiles topics into one, and add tracker and svn/hg topics. ........ r74932 | r.david.murray | 2009-09-18 17:32:16 -0400 (Fri, 18 Sep 2009) | 2 lines Remove non-committer mistakenly added. ........ r74934 | r.david.murray | 2009-09-18 17:40:30 -0400 (Fri, 18 Sep 2009) | 2 lines More descriptive/generic name for the svn/hg entry (version control) ........ r74941 | benjamin.peterson | 2009-09-18 18:45:59 -0400 (Fri, 18 Sep 2009) | 1 line add a new category for myself ........ r74942 | benjamin.peterson | 2009-09-18 18:50:55 -0400 (Fri, 18 Sep 2009) | 1 line add myself for symtable ........ r74944 | georg.brandl | 2009-09-19 03:39:05 -0400 (Sat, 19 Sep 2009) | 1 line I would like to maintain the token module! ........ r74956 | r.david.murray | 2009-09-19 14:40:08 -0400 (Sat, 19 Sep 2009) | 3 lines Add everyone who we know has been a release manager as a resource for the 'release management' topic. ........

author	R. David Murray <rdmurray@bitdance.com>
date	Sat, 19 Sep 2009 19:04:37 +0000
parents	de2771070d85
children	3292cc222d5c

rev	line source
48770 7511f3e672a2 #3560: cleanup C memoryview API Antoine Pitrou <solipsis@pitrou.net> parents: 44351 diff changeset	1 /* Memory view object. In Python this is available as "memoryview". */
42665 85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: diff changeset	2
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: diff changeset	3 #ifndef Py_MEMORYOBJECT_H
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: diff changeset	4 #define Py_MEMORYOBJECT_H
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: diff changeset	5 #ifdef __cplusplus
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: diff changeset	6 extern "C" {
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: diff changeset	7 #endif
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: diff changeset	8
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: diff changeset	9 PyAPI_DATA(PyTypeObject) PyMemoryView_Type;
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: diff changeset	10
48770 7511f3e672a2 #3560: cleanup C memoryview API Antoine Pitrou <solipsis@pitrou.net> parents: 44351 diff changeset	11 #define PyMemoryView_Check(op) (Py_TYPE(op) == &PyMemoryView_Type)
42665 85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: diff changeset	12
48770 7511f3e672a2 #3560: cleanup C memoryview API Antoine Pitrou <solipsis@pitrou.net> parents: 44351 diff changeset	13 /* Get a pointer to the underlying Py_buffer of a memoryview object. */
7511f3e672a2 #3560: cleanup C memoryview API Antoine Pitrou <solipsis@pitrou.net> parents: 44351 diff changeset	14 #define PyMemoryView_GET_BUFFER(op) (&((PyMemoryViewObject *)(op))->view)
7511f3e672a2 #3560: cleanup C memoryview API Antoine Pitrou <solipsis@pitrou.net> parents: 44351 diff changeset	15 /* Get a pointer to the PyObject from which originates a memoryview object. */
7511f3e672a2 #3560: cleanup C memoryview API Antoine Pitrou <solipsis@pitrou.net> parents: 44351 diff changeset	16 #define PyMemoryView_GET_BASE(op) (((PyMemoryViewObject *)(op))->view.obj)
7511f3e672a2 #3560: cleanup C memoryview API Antoine Pitrou <solipsis@pitrou.net> parents: 44351 diff changeset	17
42665 85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: diff changeset	18
43550 4ea945cbbb6d Fix problems with memoryview object. There is still more to do to finish PEP 3118. The memory-view object needs to be fleshed out and the struct module needs to be modified. Travis E. Oliphant <oliphant@enthought.com> parents: 43423 diff changeset	19 PyAPI_FUNC(PyObject ) PyMemoryView_GetContiguous(PyObject base,
4ea945cbbb6d Fix problems with memoryview object. There is still more to do to finish PEP 3118. The memory-view object needs to be fleshed out and the struct module needs to be modified. Travis E. Oliphant <oliphant@enthought.com> parents: 43423 diff changeset	20 int buffertype,
4ea945cbbb6d Fix problems with memoryview object. There is still more to do to finish PEP 3118. The memory-view object needs to be fleshed out and the struct module needs to be modified. Travis E. Oliphant <oliphant@enthought.com> parents: 43423 diff changeset	21 char fort);
42665 85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: diff changeset	22
50501 de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	23 /* Return a contiguous chunk of memory representing the buffer
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	24 from an object in a memory view object. If a copy is made then the
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	25 base object for the memory view will be a new bytes object.
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	26
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	27 Otherwise, the base-object will be the object itself and no
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	28 data-copying will be done.
42665 85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: diff changeset	29
50501 de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	30 The buffertype argument can be PyBUF_READ, PyBUF_WRITE,
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	31 PyBUF_SHADOW to determine whether the returned buffer
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	32 should be READONLY, WRITABLE, or set to update the
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	33 original buffer if a copy must be made. If buffertype is
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	34 PyBUF_WRITE and the buffer is not contiguous an error will
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	35 be raised. In this circumstance, the user can use
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	36 PyBUF_SHADOW to ensure that a a writable temporary
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	37 contiguous buffer is returned. The contents of this
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	38 contiguous buffer will be copied back into the original
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	39 object after the memoryview object is deleted as long as
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	40 the original object is writable and allows setting an
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	41 exclusive write lock. If this is not allowed by the
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	42 original object, then a BufferError is raised.
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	43
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	44 If the object is multi-dimensional and if fortran is 'F',
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	45 the first dimension of the underlying array will vary the
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	46 fastest in the buffer. If fortran is 'C', then the last
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	47 dimension will vary the fastest (C-style contiguous). If
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	48 fortran is 'A', then it does not matter and you will get
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	49 whatever the object decides is more efficient.
42665 85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: diff changeset	50
50501 de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	51 A new reference is returned that must be DECREF'd when finished.
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	52 */
42665 85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: diff changeset	53
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: diff changeset	54 PyAPI_FUNC(PyObject ) PyMemoryView_FromObject(PyObject base);
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: diff changeset	55
48770 7511f3e672a2 #3560: cleanup C memoryview API Antoine Pitrou <solipsis@pitrou.net> parents: 44351 diff changeset	56 PyAPI_FUNC(PyObject ) PyMemoryView_FromBuffer(Py_buffer info);
50501 de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	57 /* create new if bufptr is NULL
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	58 will be a new bytesobject in base */
42665 85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: diff changeset	59
50501 de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	60
48770 7511f3e672a2 #3560: cleanup C memoryview API Antoine Pitrou <solipsis@pitrou.net> parents: 44351 diff changeset	61 /* The struct is declared here so that macros can work, but it shouldn't
7511f3e672a2 #3560: cleanup C memoryview API Antoine Pitrou <solipsis@pitrou.net> parents: 44351 diff changeset	62 be considered public. Don't access those fields directly, use the macros
7511f3e672a2 #3560: cleanup C memoryview API Antoine Pitrou <solipsis@pitrou.net> parents: 44351 diff changeset	63 and functions instead! */
7511f3e672a2 #3560: cleanup C memoryview API Antoine Pitrou <solipsis@pitrou.net> parents: 44351 diff changeset	64 typedef struct {
50501 de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	65 PyObject_HEAD
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	66 PyObject *base;
de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	67 Py_buffer view;
48770 7511f3e672a2 #3560: cleanup C memoryview API Antoine Pitrou <solipsis@pitrou.net> parents: 44351 diff changeset	68 } PyMemoryViewObject;
50501 de2771070d85 Merged revisions 68212 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 48770 diff changeset	69
48770 7511f3e672a2 #3560: cleanup C memoryview API Antoine Pitrou <solipsis@pitrou.net> parents: 44351 diff changeset	70
42665 85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: diff changeset	71 #ifdef __cplusplus
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: diff changeset	72 }
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: diff changeset	73 #endif
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: diff changeset	74 #endif /* !Py_MEMORYOBJECT_H */

Mercurial > cpython-lru_cache-weakref

annotate Include/memoryobject.h @ 56121:ea697cde6882 3.1