Merge branch 'main' into gh-91049-set-vectorcall

python · markshannon · Sep 15, 2022 · May 3, 2022 · May 3, 2022 · May 3, 2022
commit 3387d4ac65b42ea534105ee0716a2b75ae67b96d
diff --git a/Doc/whatsnew/3.12.rst b/Doc/whatsnew/3.12.rst
@@ -437,8 +437,30 @@ New Features
   an additional metaclass argument.
   (Contributed by Wenzel Jakob in :gh:`93012`.)
 
-* Add new function :c:func:`PyFunction_SetVectorcall` to the C API
-  which sets the vectorcall field of a given :c:type:`PyFunctionObject`
+* API for creating objects that can be called using
+  :ref:`the vectorcall protocol <vectorcall>` was added to the
+  :ref:`Limited API <stable>`:
+
+  * :const:`Py_TPFLAGS_HAVE_VECTORCALL`
+  * :c:func:`PyVectorcall_NARGS`
+  * :c:func:`PyVectorcall_Call`
+  * :c:type:`vectorcallfunc`
+
+  The :const:`Py_TPFLAGS_HAVE_VECTORCALL` flag is now removed from a class
+  when the class's :py:meth:`~object.__call__` method is reassigned.
+  This makes vectorcall safe to use with mutable types (i.e. heap types
+  without the :const:`immutable <Py_TPFLAGS_IMMUTABLETYPE>` flag).
+  Mutable types that do not override :c:member:`~PyTypeObject.tp_call` now
+  inherit the ``Py_TPFLAGS_HAVE_VECTORCALL`` flag.
+  (Contributed by Petr Viktorin in :gh:`93274`.)
+
+  The :const:`Py_TPFLAGS_MANAGED_DICT` and :const:`Py_TPFLAGS_MANAGED_WEAKREF`
+  flags have been added. This allows extensions classes to support object
+  ``__dict__`` and weakrefs with less bookkeeping,
+  using less memory and with faster access.
+
+* Added new function :c:func:`PyFunction_SetVectorcall` to the C API
+  which sets the vectorcall field of a given :c:type:`PyFunctionObject`.
   Warning: extensions using this API must preserve the behavior
   of the unaltered function!
   (Contributed by Andrew Frost in :gh:`92257`.)

diff --git a/Lib/test/test_call.py b/Lib/test/test_call.py
@@ -770,6 +770,13 @@ def f(num): return num + 1
         for _ in range(51):
             self.assertEqual("overridden", f(num))
 
+    @requires_limited_api
+    def test_vectorcall_limited(self):
+        from _testcapi import pyobject_vectorcall
+        obj = _testcapi.LimitedVectorCallClass()
+        self.assertEqual(pyobject_vectorcall(obj, (), ()), "vectorcall called")
+
+
 class A:
     def method_two_args(self, x, y):
         pass

diff --git a/Modules/_testcapi/vectorcall.c b/Modules/_testcapi/vectorcall.c
@@ -102,6 +102,23 @@ test_pyobject_vectorcall(PyObject *self, PyObject *args)
     return PyObject_Vectorcall(func, stack, nargs, kwnames);
 }
 
+static PyObject *
+override_vectorcall(
+    PyObject *callable, PyObject *const *args, size_t nargsf, PyObject *kwnames) {
+    return PyUnicode_FromString("overridden");
+}
+
+static PyObject *
+function_setvectorcall(PyObject *self, PyObject *func)
+{
+    if (!PyFunction_Check(func)) {
+        PyErr_BadInternalCall();
+        return NULL;
+    }
+    PyFunction_SetVectorcall((PyFunctionObject *)func, (vectorcallfunc)override_vectorcall);
+    Py_RETURN_NONE;
+}
+
 static PyObject *
 test_pyvectorcall_call(PyObject *self, PyObject *args)
 {
@@ -244,6 +261,7 @@ static PyMethodDef TestMethods[] = {
     {"pyobject_fastcall", test_pyobject_fastcall, METH_VARARGS},
     {"pyobject_fastcalldict", test_pyobject_fastcalldict, METH_VARARGS},
     {"pyobject_vectorcall", test_pyobject_vectorcall, METH_VARARGS},
+    {"function_setvectorcall", function_setvectorcall, METH_O},
     {"pyvectorcall_call", test_pyvectorcall_call, METH_VARARGS},
     _TESTCAPI_MAKE_VECTORCALL_CLASS_METHODDEF
     _TESTCAPI_HAS_VECTORCALL_FLAG_METHODDEF

diff --git a/Modules/_testcapimodule.c b/Modules/_testcapimodule.c
@@ -4650,145 +4650,6 @@ raise_SIGINT_then_send_None(PyObject *self, PyObject *args)
 }
 
 
-static int
-fastcall_args(PyObject *args, PyObject ***stack, Py_ssize_t *nargs)
-{
-    if (args == Py_None) {
-        *stack = NULL;
-        *nargs = 0;
-    }
-    else if (PyTuple_Check(args)) {
-        *stack = ((PyTupleObject *)args)->ob_item;
-        *nargs = PyTuple_GET_SIZE(args);
-    }
-    else {
-        PyErr_SetString(PyExc_TypeError, "args must be None or a tuple");
-        return -1;
-    }
-    return 0;
-}
-
-
-static PyObject *
-test_pyobject_fastcall(PyObject *self, PyObject *args)
-{
-    PyObject *func, *func_args;
-    PyObject **stack;
-    Py_ssize_t nargs;
-
-    if (!PyArg_ParseTuple(args, "OO", &func, &func_args)) {
-        return NULL;
-    }
-
-    if (fastcall_args(func_args, &stack, &nargs) < 0) {
-        return NULL;
-    }
-    return _PyObject_FastCall(func, stack, nargs);
-}
-
-
-static PyObject *
-test_pyobject_fastcalldict(PyObject *self, PyObject *args)
-{
-    PyObject *func, *func_args, *kwargs;
-    PyObject **stack;
-    Py_ssize_t nargs;
-
-    if (!PyArg_ParseTuple(args, "OOO", &func, &func_args, &kwargs)) {
-        return NULL;
-    }
-
-    if (fastcall_args(func_args, &stack, &nargs) < 0) {
-        return NULL;
-    }
-
-    if (kwargs == Py_None) {
-        kwargs = NULL;
-    }
-    else if (!PyDict_Check(kwargs)) {
-        PyErr_SetString(PyExc_TypeError, "kwnames must be None or a dict");
-        return NULL;
-    }
-
-    return PyObject_VectorcallDict(func, stack, nargs, kwargs);
-}
-
-
-static PyObject *
-test_pyobject_vectorcall(PyObject *self, PyObject *args)
-{
-    PyObject *func, *func_args, *kwnames = NULL;
-    PyObject **stack;
-    Py_ssize_t nargs, nkw;
-
-    if (!PyArg_ParseTuple(args, "OOO", &func, &func_args, &kwnames)) {
-        return NULL;
-    }
-
-    if (fastcall_args(func_args, &stack, &nargs) < 0) {
-        return NULL;
-    }
-
-    if (kwnames == Py_None) {
-        kwnames = NULL;
-    }
-    else if (PyTuple_Check(kwnames)) {
-        nkw = PyTuple_GET_SIZE(kwnames);
-        if (nargs < nkw) {
-            PyErr_SetString(PyExc_ValueError, "kwnames longer than args");
-            return NULL;
-        }
-        nargs -= nkw;
-    }
-    else {
-        PyErr_SetString(PyExc_TypeError, "kwnames must be None or a tuple");
-        return NULL;
-    }
-    return PyObject_Vectorcall(func, stack, nargs, kwnames);
-}
-
-
-static PyObject *
-override_vectorcall(
-    PyObject *callable, PyObject *const *args, size_t nargsf, PyObject *kwnames) {
-    return PyUnicode_FromString("overridden");
-}
-
-static PyObject *
-function_setvectorcall(PyObject *self, PyObject *func)
-{
-    if (!PyFunction_Check(func)) {
-        PyErr_BadInternalCall();
-        return NULL;
-    }
-    PyFunction_SetVectorcall((PyFunctionObject *)func, (vectorcallfunc)override_vectorcall);
-    Py_RETURN_NONE;
-}
-
-static PyObject *
-test_pyvectorcall_call(PyObject *self, PyObject *args)
-{
-    PyObject *func;
-    PyObject *argstuple;
-    PyObject *kwargs = NULL;
-
-    if (!PyArg_ParseTuple(args, "OO|O", &func, &argstuple, &kwargs)) {
-        return NULL;
-    }
-
-    if (!PyTuple_Check(argstuple)) {
-        PyErr_SetString(PyExc_TypeError, "args must be a tuple");
-        return NULL;
-    }
-    if (kwargs != NULL && !PyDict_Check(kwargs)) {
-        PyErr_SetString(PyExc_TypeError, "kwargs must be a dict");
-        return NULL;
-    }
-
-    return PyVectorcall_Call(func, argstuple, kwargs);
-}
-
-
 static PyObject*
 stack_pointer(PyObject *self, PyObject *args)
 {
@@ -5828,11 +5689,6 @@ static PyMethodDef TestMethods[] = {
     {"tracemalloc_get_traceback", tracemalloc_get_traceback, METH_VARARGS},
     {"dict_get_version", dict_get_version, METH_VARARGS},
     {"raise_SIGINT_then_send_None", raise_SIGINT_then_send_None, METH_VARARGS},
-    {"pyobject_fastcall", test_pyobject_fastcall, METH_VARARGS},
-    {"pyobject_fastcalldict", test_pyobject_fastcalldict, METH_VARARGS},
-    {"pyobject_vectorcall", test_pyobject_vectorcall, METH_VARARGS},
-    {"function_setvectorcall", function_setvectorcall, METH_O},
-    {"pyvectorcall_call", test_pyvectorcall_call, METH_VARARGS},
     {"stack_pointer", stack_pointer, METH_NOARGS},
 #ifdef W_STOPCODE
     {"W_STOPCODE", py_w_stopcode, METH_VARARGS},