Mar 19, 2024 · Feb 21, 2024 · Feb 22, 2024 · Feb 22, 2024 · Feb 29, 2024 · Feb 29, 2024
diff --git a/Doc/c-api/code.rst b/Doc/c-api/code.rst

   Return the number of free variables in a code object.

 ..c:function::intPyCode_GetFirstFree(PyCodeObject *co)
 ..c:function::intPyUnstable_Code_GetFirstFree(PyCodeObject *co)

   Return the position of the first free variable in a code object.

   ..versionchanged::3.13

      Renamed from ``PyCode_GetFirstFree`` as part of:ref:`unstable-c-api`.
      The old name is deprecated, but will remain available until the
      signature changes again.

 ..c:function:: PyCodeObject*PyUnstable_Code_New(int argcount, int kwonlyargcount, int nlocals, int stacksize, int flags, PyObject *code, PyObject *consts, PyObject *names, PyObject *varnames, PyObject *freevars, PyObject *cellvars, PyObject *filename, PyObject *name, PyObject *qualname, int firstlineno, PyObject *linetable, PyObject *exceptiontable)

   Return a new code object.  If you need a dummy code object to create a frame,
diff --git a/Doc/whatsnew/3.13.rst b/Doc/whatsnew/3.13.rst
  than directories only. Users may add a trailing slash to match only
  directories.

 * :c:func:`!PyCode_GetFirstFree` is an ustable API now and has been renamed
  to :c:func:`PyUnstable_Code_GetFirstFree`.
  (Contributed by Bogdan Romanyuk in :gh:`115781`)


 Build Changes
 =============
diff --git a/Include/cpython/code.h b/Include/cpython/code.h
    return op->co_nfreevars;
 }

 static inline intPyCode_GetFirstFree(PyCodeObject *op) {
 static inline intPyUnstable_Code_GetFirstFree(PyCodeObject *op) {
    assert(PyCode_Check(op));
    return op->co_nlocalsplus - op->co_nfreevars;
 }

 Py_DEPRECATED(3.13) static inline int PyCode_GetFirstFree(PyCodeObject *op) {
    return PyUnstable_Code_GetFirstFree(op);
 }

 #define _PyCode_CODE(CO) _Py_RVALUE((_Py_CODEUNIT *)(CO)->co_code_adaptive)
 #define _PyCode_NBYTES(CO) (Py_SIZE(CO) * (Py_ssize_t)sizeof(_Py_CODEUNIT))

diff --git a/Misc/NEWS.d/next/C API/2024-03-19-09-49-04.gh-issue-115756.4Ls_Tl.rst b/Misc/NEWS.d/next/C API/2024-03-19-09-49-04.gh-issue-115756.4Ls_Tl.rst
 :c:func:`!PyCode_GetFirstFree` is an ustable API now and has been renamed to
 :c:func:`PyUnstable_Code_GetFirstFree`. (Contributed by Bogdan Romanyuk in
 :gh:`115781`)
diff --git a/Objects/frameobject.c b/Objects/frameobject.c

 /* Free vars have not been initialized -- Do that */
 PyObject*closure= ((PyFunctionObject*)frame->f_funcobj)->func_closure;
 intoffset=PyCode_GetFirstFree(co);
 intoffset=PyUnstable_Code_GetFirstFree(co);
 for (inti=0;i<co->co_nfreevars;++i) {
 PyObject*o=PyTuple_GET_ITEM(closure,i);
 frame->localsplus[offset+i]=Py_NewRef(o);
diff --git a/Objects/typeobject.c b/Objects/typeobject.c

    // Look for __class__ in the free vars.
    PyTypeObject *type = NULL;
    int i =PyCode_GetFirstFree(co);
    int i =PyUnstable_Code_GetFirstFree(co);
    for (; i < co->co_nlocalsplus; i++) {
        assert((_PyLocals_GetKind(co->co_localspluskinds, i) & CO_FAST_FREE) != 0);
        PyObject *name = PyTuple_GET_ITEM(co->co_localsplusnames, i);
diff --git a/Python/ceval.c b/Python/ceval.c
    if (_PyErr_Occurred(tstate))
        return;
    name = PyTuple_GET_ITEM(co->co_localsplusnames, oparg);
    if (oparg <PyCode_GetFirstFree(co)) {
    if (oparg <PyUnstable_Code_GetFirstFree(co)) {
        _PyEval_FormatExcCheckArg(tstate, PyExc_UnboundLocalError,
                                  UNBOUNDLOCAL_ERROR_MSG, name);
    } else {
diff --git a/Python/compile.c b/Python/compile.c
 PyCodeObject*co,Py_ssize_tflags)
 {
 if (co->co_nfreevars) {
 inti=PyCode_GetFirstFree(co);
 inti=PyUnstable_Code_GetFirstFree(co);
 for (;i<co->co_nlocalsplus;++i) {
 /* Bypass com_addop_varname because it will generate
               LOAD_DEREF but LOAD_CLOSURE is needed.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -34,10 +34,16 @@ bound into a function.

		Return the number of free variables in a code object.

		..c:function::intPyCode_GetFirstFree(PyCodeObject *co)
		..c:function::intPyUnstable_Code_GetFirstFree(PyCodeObject *co)

		Return the position of the first free variable in a code object.

		..versionchanged::3.13

		Renamed from ``PyCode_GetFirstFree`` as part of:ref:`unstable-c-api`.
		The old name is deprecated, but will remain available until the
		signature changes again.

		..c:function:: PyCodeObjectPyUnstable_Code_New(int argcount, int kwonlyargcount, int nlocals, int stacksize, int flags, PyObject code, PyObject consts, PyObject names, PyObject varnames, PyObject freevars, PyObject cellvars, PyObject filename, PyObject name, PyObject qualname, int firstlineno, PyObject linetable, PyObject exceptiontable)

		Return a new code object. If you need a dummy code object to create a frame,
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -1394,6 +1394,10 @@ Changes in the Python API
		than directories only. Users may add a trailing slash to match only
		directories.

		* :c:func:`!PyCode_GetFirstFree` is an ustable API now and has been renamed
		to :c:func:`PyUnstable_Code_GetFirstFree`.
		(Contributed by Bogdan Romanyuk in :gh:`115781`)


		Build Changes
		=============
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -226,11 +226,15 @@ static inline Py_ssize_t PyCode_GetNumFree(PyCodeObject *op) {
		return op->co_nfreevars;
		}

		static inline intPyCode_GetFirstFree(PyCodeObject *op) {
		static inline intPyUnstable_Code_GetFirstFree(PyCodeObject *op) {
		assert(PyCode_Check(op));
		return op->co_nlocalsplus - op->co_nfreevars;
		}

Copy link Member vstinnerMar 19, 2024• edited Loading Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. If the deprecation has no detail, for me, it can be removed as soon as in Python 3.15. But the doc is more specific: "The old name is deprecated, but will remain available until the signature changes again." Please add a comment to explain it here. Copy link Member encukouMar 19, 2024 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. If the deprecation has no detail, for me, it can be removed in Python 3.15. What are you basing this on? Copy link Member vstinnerMar 19, 2024 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. PEP 387: Similarly a feature cannot be removed without notice between any two consecutive releases. Copy link Member encukouMar 19, 2024 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. I'm sorry, I didn't disable automerge after your comment. I didn't mean to ignore you :( But IMO, the “Basic Policy” is just a summary. The“Making Incompatible Changes” section has more detailed instructions. If you disagree with my reading, let's take it to Discourse; this isn't a good place for it. Copy link Member vstinnerMar 19, 2024 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. It's just that this function has a specific comment in the doc, IMO it's worth it to repeat it in the header to avoid future eagger removal. But well, now that the change is merged, it's maybe no longer worth it. encukou reacted with thumbs up emoji
		Py_DEPRECATED(3.13) static inline int PyCode_GetFirstFree(PyCodeObject *op) {
		return PyUnstable_Code_GetFirstFree(op);
		}

		#define _PyCode_CODE(CO) _Py_RVALUE((_Py_CODEUNIT *)(CO)->co_code_adaptive)
		#define _PyCode_NBYTES(CO) (Py_SIZE(CO) * (Py_ssize_t)sizeof(_Py_CODEUNIT))

Expand Down
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		:c:func:`!PyCode_GetFirstFree` is an ustable API now and has been renamed to
		:c:func:`PyUnstable_Code_GetFirstFree`. (Contributed by Bogdan Romanyuk in
		:gh:`115781`)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -1140,7 +1140,7 @@ frame_init_get_vars(_PyInterpreterFrame *frame)

		/* Free vars have not been initialized -- Do that */
		PyObjectclosure= ((PyFunctionObject)frame->f_funcobj)->func_closure;
		intoffset=PyCode_GetFirstFree(co);
		intoffset=PyUnstable_Code_GetFirstFree(co);
		for (inti=0;i<co->co_nfreevars;++i) {
		PyObject*o=PyTuple_GET_ITEM(closure,i);
		frame->localsplus[offset+i]=Py_NewRef(o);
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -10814,7 +10814,7 @@ super_init_without_args(_PyInterpreterFrame cframe, PyCodeObject co,

		// Look for __class__ in the free vars.
		PyTypeObject *type = NULL;
		int i =PyCode_GetFirstFree(co);
		int i =PyUnstable_Code_GetFirstFree(co);
		for (; i < co->co_nlocalsplus; i++) {
		assert((_PyLocals_GetKind(co->co_localspluskinds, i) & CO_FAST_FREE) != 0);
		PyObject *name = PyTuple_GET_ITEM(co->co_localsplusnames, i);
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2898,7 +2898,7 @@ _PyEval_FormatExcUnbound(PyThreadState tstate, PyCodeObject co, int oparg)
		if (_PyErr_Occurred(tstate))
		return;
		name = PyTuple_GET_ITEM(co->co_localsplusnames, oparg);
		if (oparg <PyCode_GetFirstFree(co)) {
		if (oparg <PyUnstable_Code_GetFirstFree(co)) {
		_PyEval_FormatExcCheckArg(tstate, PyExc_UnboundLocalError,
		UNBOUNDLOCAL_ERROR_MSG, name);
		} else {
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -1830,7 +1830,7 @@ compiler_make_closure(struct compiler *c, location loc,
		PyCodeObject*co,Py_ssize_tflags)
		{
		if (co->co_nfreevars) {
		inti=PyCode_GetFirstFree(co);
		inti=PyUnstable_Code_GetFirstFree(co);
		for (;i<co->co_nlocalsplus;++i) {
		/* Bypass com_addop_varname because it will generate
		LOAD_DEREF but LOAD_CLOSURE is needed.
Expand Down