Skip to content

bpo-45459: Add Py_buffer to limited API #29991

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
miss-islington merged 12 commits into from
Feb 2, 2022
Merged

bpo-45459: Add Py_buffer to limited API #29991

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
549fcdb
bpo-45459: Add Py_buffer to limited API
tiran Oct 18, 2021
526c58c
Move Py_buffer APIs to buffer.h
tiran Oct 18, 2021
1440b94
Hide typo alias with limited API
tiran Oct 18, 2021
cf98a23
Make Py_buffer public
tiran Dec 8, 2021
0e67e2c
Update stable_abi.txt and run make regen-limited-abi
tiran Dec 8, 2021
d516781
Add simple tests for Py_buffer stable ABI
tiran Dec 8, 2021
c1391cf
Add PyMemoryView_FromBuffer to limited API
tiran Dec 8, 2021
92d2ea5
Add docs
tiran Dec 8, 2021
7df9317
Document PyObject_CopyData
tiran Feb 2, 2022
0ab2a44
Address Petr's code review of xxlimited.c
tiran Feb 2, 2022
98a4ee5
Make Py_Buffer struct anon
tiran Feb 2, 2022
6119c2b
Remove forward declaration of Py_Buffer
tiran Feb 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add simple tests for Py_buffer stable ABI
  • Loading branch information
@tiran
tiran committed Feb 2, 2022
commit d5167819b1195de97ec85e347c14c05ba73b19cf
11 changes: 11 additions & 0 deletions Lib/test/test_xxlimited.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,17 @@ def test_error(self):
with self.assertRaises(self.module.Error):
raise self.module.Error

def test_buffer(self):
xxo = self.module.Xxo()
self.assertEqual(xxo.x_exports, 0)
b1 = memoryview(xxo)
self.assertEqual(xxo.x_exports, 1)
b2 = memoryview(xxo)
self.assertEqual(xxo.x_exports, 2)
b1[0] = 1
self.assertEqual(b1[0], 1)
self.assertEqual(b2[0], 1)


class TestXXLimited35(CommonTests, unittest.TestCase):
module = xxlimited_35
Expand Down
50 changes: 49 additions & 1 deletion Modules/xxlimited.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
def __init__(self):
# In the C class, "_x_attr" is not accessible from Python code
self._x_attr = {}
self._x_buffer = bytesarray(10)
self._x_exports = 0
Comment thread
tiran marked this conversation as resolved.
Outdated

def __getattr__(self, name):
return self._x_attr[name]
Expand All @@ -29,6 +31,10 @@
def __delattr__(self, name):
del self._x_attr[name]

@property
def x_exports(self):
return self._x_exports

Comment thread
tiran marked this conversation as resolved.
Outdated
def demo(o, /):
if isinstance(o, str):
return o
Expand Down Expand Up @@ -57,6 +63,9 @@
#define Py_LIMITED_API 0x030b0000

#include "Python.h"
#include <string.h>

#define BUFSIZE 10

// Module state
typedef struct {
Expand All @@ -70,7 +79,9 @@ typedef struct {
// Instance state
typedef struct {
PyObject_HEAD
PyObject *x_attr; /* Attributes dictionary */
PyObject *x_attr; /* Attributes dictionary */
char x_buffer[BUFSIZE]; /* buffer for Py_buffer */
Py_ssize_t x_exports; /* how many buffer are exported */
} XxoObject;

// XXX: no good way to do this yet
Expand All @@ -89,6 +100,8 @@ newXxoObject(PyObject *module)
return NULL;
}
self->x_attr = NULL;
memset(self->x_buffer, 0, BUFSIZE);
self->x_exports = 0;
return self;
}

Expand Down Expand Up @@ -212,11 +225,43 @@ static PyMethodDef Xxo_methods[] = {
{NULL, NULL} /* sentinel */
};

/* Xxo buffer interface */

static int
Xxo_getbuffer(XxoObject *self, Py_buffer *view, int flags)
{
int res = PyBuffer_FillInfo(view, (PyObject*)self,
(void *)self->x_buffer, BUFSIZE,
0, flags);
if (res == 0) {
self->x_exports++;
}
return res;
}

static void
Xxo_releasebuffer(XxoObject *self, Py_buffer *view)
{
self->x_exports--;
}

static PyObject *
Xxo_get_x_exports(XxoObject *self, void *c)
{
return PyLong_FromSsize_t(self->x_exports);
}

/* Xxo type definition */

PyDoc_STRVAR(Xxo_doc,
"A class that explicitly stores attributes in an internal dict");

static PyGetSetDef Xxo_getsetlist[] = {
{"x_exports", (getter) Xxo_get_x_exports, NULL, NULL},
{NULL},
};


static PyType_Slot Xxo_Type_slots[] = {
{Py_tp_doc, (char *)Xxo_doc},
{Py_tp_traverse, Xxo_traverse},
Expand All @@ -226,6 +271,9 @@ static PyType_Slot Xxo_Type_slots[] = {
{Py_tp_getattro, Xxo_getattro},
{Py_tp_setattro, Xxo_setattro},
{Py_tp_methods, Xxo_methods},
{Py_bf_getbuffer, Xxo_getbuffer},
{Py_bf_releasebuffer, Xxo_releasebuffer},
{Py_tp_getset, Xxo_getsetlist},
{0, 0}, /* sentinel */
};

Expand Down