Rename Py_INCREF_assign to Py_NewRef (#58)

Rename Py_INCREF_assign and Py_INCREF_return to Py_NewRef.

Author: vstinner

docs/changelog.rst

@@ -2,7 +2,7 @@ Changelog
 =========
 
 * 2022-11-15: Add experimental operations to the upgrade_pythoncapi script:
-  ``Py_INCREF_return``, ``Py_INCREF_assign``, ``Py_CLEAR`` and ``Py_SETREF``.
+  ``Py_NewRef``, ``Py_CLEAR`` and ``Py_SETREF``.
 * 2022-11-09: Fix ``Py_SETREF()`` and ``Py_XSETREF()`` macros
   for `gh-98724 <https://github.com/python/cpython/issues/98724>`_.
 * 2022-11-04: Add ``PyFrame_GetVar()`` and ``PyFrame_GetVarString()``

docs/upgrade.rst

@@ -151,12 +151,9 @@ Example: ``-o all,Py_SETREF``.
 
 Experimental operations:
 
-* ``Py_INCREF_return``:
+* ``Py_NewRef``:
 
   * Replace ``Py_INCREF(res); return res;`` with ``return Py_NewRef(res);``
-
-* ``Py_INCREF_assign``:
-
   * Replace ``x = y; Py_INCREF(x);`` with ``x = Py_NewRef(y);``
   * Replace ``x = y; Py_INCREF(y);`` with ``x = Py_NewRef(y);``
   * Replace ``Py_INCREF(y); x = y;`` with ``x = Py_NewRef(y);``

tests/test_upgrade_pythoncapi.py

@@ -408,7 +408,7 @@ def test_pythreadstate_getframe(self):
             { return _PyThreadState_GetFrameBorrow(tstate); }
         """)
 
-    def test_py_incref_return(self):
+    def test_py_newref_return(self):
         self.check_replace("""
             PyObject* new_ref(PyObject *obj) {
                 Py_INCREF(obj);
@@ -448,7 +448,7 @@ def test_py_incref_return(self):
             }
         """)
 
-    def test_py_incref_assign(self):
+    def test_py_newref(self):
         # INCREF, assign
         self.check_replace("""
             void set_attr(MyStruct *obj, PyObject *value, int test)

upgrade_pythoncapi.py

@@ -245,8 +245,8 @@ class PyThreadState_GetFrame(Operation):
     NEED_PYTHONCAPI_COMPAT = (MIN_PYTHON < (3, 9))
 
 
-class Py_INCREF_return(Operation):
-    NAME = "Py_INCREF_return"
+class Py_NewRef(Operation):
+    NAME = "Py_NewRef"
     REPLACE = (
         # "Py_INCREF(x); return x;" => "return Py_NewRef(x);"
         # "Py_XINCREF(x); return x;" => "return Py_XNewRef(x);"
@@ -266,17 +266,11 @@ class Py_INCREF_return(Operation):
                     + fr'return {OPT_CAST_REGEX}\2;',
                     re.MULTILINE),
          r'return Py_\1NewRef(\2);'),
-    )
-    # Need Py_NewRef(): new in Python 3.10
-    NEED_PYTHONCAPI_COMPAT = (MIN_PYTHON < (3, 10))
 
+        # "Py_INCREF(x); y = x;" must be replaced before
+        # "y = x; Py_INCREF(y);", to not miss consecutive
+        # "Py_INCREF; assign; Py_INCREF; assign; ..." (see unit tests).
 
-class Py_INCREF_assign(Operation):
-    NAME = "Py_INCREF_assign"
-    # "Py_INCREF(x); y = x;" must be replaced before "y = x; Py_INCREF(y);",
-    # to not miss consecutive "Py_INCREF; assign; Py_INCREF; assign; ..."
-    # (see unit tests)
-    REPLACE = (
         # "Py_INCREF(x); y = x;" => "y = Py_NewRef(x)"
         # "Py_XINCREF(x); y = x;" => "y = Py_XNewRef(x)"
         # The two statements must have the same indentation, otherwise the
@@ -488,15 +482,13 @@ def replace2(regs):
     PyThreadState_GetFrame,
 
     # Code style: excluded from "all"
-    Py_INCREF_return,
-    Py_INCREF_assign,
+    Py_NewRef,
     Py_CLEAR,
     Py_SETREF,
 )
 
 EXCLUDE_FROM_ALL = (
-    Py_INCREF_return,
-    Py_INCREF_assign,
+    Py_NewRef,
     Py_CLEAR,
     Py_SETREF,
 )