Apply review feedback from vstinner and markshannon

itamaro · Andrew Frost · commit 89cb4b25271b · 2022-06-21T22:33:31.000-07:00
diff --git a/Doc/c-api/function.rst b/Doc/c-api/function.rst
@@ -87,6 +87,7 @@ There are a few functions specific to Python functions.
 
    Set the vectorcall field of a given function object *func*
 
+   .. versionadded:: 3.12
 
 .. c:function:: PyObject* PyFunction_GetClosure(PyObject *op)
 
diff --git a/Doc/whatsnew/3.12.rst b/Doc/whatsnew/3.12.rst
@@ -237,7 +237,9 @@ New Features
   (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 PyFunctionObject
+  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`.)
 
 Porting to Python 3.12
diff --git a/Lib/test/test_call.py b/Lib/test/test_call.py
@@ -673,7 +673,7 @@ def f(num): return num + 1
         function_setvectorcall(f)
         # make sure specializer is triggered by running > 50 times
         for _ in range(51):
-            self.assertIsNone(f(num))
+            self.assertEqual("overridden", f(num))
 
 class A:
     def method_two_args(self, x, y):
diff --git a/Misc/NEWS.d/next/C API/2022-05-03-19-35-37.gh-issue-92193.61VoFL.rst b/Misc/NEWS.d/next/C API/2022-05-03-19-35-37.gh-issue-92193.61VoFL.rst
@@ -1,6 +1,5 @@
-CPython extensions providing optimized execution of Python bytecode (like Cinder JIT and Pyjion)
-can benefit from being able to modify the vectorcall field on instances of PyFunctionObject to allow calling the optimized path (e.g. JIT-compiled) directly.
+Add new function :c:func:`PyFunction_SetVectorcall` to the C API
+which sets the vectorcall field of a given :c:type:`PyFunctionObject`
 
-This PR introduces an API call where vectorcall field can be modified like so:
-
-`void PyFunction_SetVectorcall(PyFunctionObject *func, vectorcallfunc vectorcall);`
+Warning: extensions using this API must preserve the behavior
+of the unaltered function!
diff --git a/Modules/_testcapimodule.c b/Modules/_testcapimodule.c
@@ -5359,7 +5359,7 @@ test_pyobject_vectorcall(PyObject *self, PyObject *args)
 static PyObject *
 override_vectorcall(
     PyObject *callable, PyObject *const *args, size_t nargsf, PyObject *kwnames) {
-    Py_RETURN_NONE;
+    return PyUnicode_FromString("overridden");
 }
 
 static PyObject *

Original file line number	Diff line number	Diff line change
`@@ -87,6 +87,7 @@ There are a few functions specific to Python functions.`
`87`	`87`
`88`	`88`	`Set the vectorcall field of a given function object func`
`89`	`89`
	`90`	`+ .. versionadded:: 3.12`
`90`	`91`
`91`	`92`	`.. c:function:: PyObject* PyFunction_GetClosure(PyObject *op)`
`92`	`93`
Original file line number	Diff line number	Diff line change
`@@ -5359,7 +5359,7 @@ test_pyobject_vectorcall(PyObject self, PyObject args)`
`5359`	`5359`	`static PyObject *`
`5360`	`5360`	`override_vectorcall(`
`5361`	`5361`	`PyObject callable, PyObject const args, size_t nargsf, PyObject kwnames) {`
`5362`		`- Py_RETURN_NONE;`
	`5362`	`+ return PyUnicode_FromString("overridden");`
`5363`	`5363`	`}`
`5364`	`5364`
`5365`	`5365`	`static PyObject *`