Skip to content

bpo-44800: rename _PyInterpreterFrame to _Py_frame #31987

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

Closed
ncoghlan wants to merge 16 commits into from
Closed

bpo-44800: rename _PyInterpreterFrame to _Py_frame #31987

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
ee2b513
bpo-44800: Rename _PyInterpreterFrame to _Py_frame
ncoghlan Mar 19, 2022
5326da8
Rename fdata->f_func to fdata->func
ncoghlan Mar 19, 2022
c878951
Rename fdata->f_globals to fdata->globals
ncoghlan Mar 19, 2022
bcafd65
Rename fdata->f_builtins to fdata->builtins
ncoghlan Mar 19, 2022
c324b81
Rename fdata->f_locals to fdata->locals
ncoghlan Mar 19, 2022
c16b2c4
Rename fdata->f_code to fdata->code
ncoghlan Mar 19, 2022
d26dca8
Rename fdata->f_lasti to fdata->lasti
ncoghlan Mar 19, 2022
40156aa
Rename fdata->f_state to fdata->state
ncoghlan Mar 19, 2022
a47e554
Fix misleading use of 'cframe' name in typeobject.c
ncoghlan Mar 19, 2022
37b1447
f_frame is not public, don't mention in What's New
ncoghlan Mar 19, 2022
75326d6
Rename frame->f_frame to frame->f_fdata
ncoghlan Mar 19, 2022
612a8e9
Rename frame->_f_frame_data to frame->_f_owned_fdata
ncoghlan Mar 19, 2022
11653cc
Add NEWS entry
ncoghlan Mar 19, 2022
2775bf1
Fix another use of cframe in typeoject.c
ncoghlan Mar 19, 2022
d2bc844
ReST is not Markdown
ncoghlan Mar 19, 2022
b275999
Compatibility workaround to match 3.11a6 API
ncoghlan Mar 20, 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
Compatibility workaround to match 3.11a6 API
  • Loading branch information
@ncoghlan
ncoghlan committed Mar 20, 2022
commit b2759999e3751c37e77bb4dafc1e5d6ef6bfee49
30 changes: 30 additions & 0 deletions Include/internal/pycore_frame.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,36 @@ typedef struct _Py_frame {
PyObject *localsplus[1];
} _Py_frame;

#if !defined(_PY_FRAME_API_DISABLE_INTERIM_COMPAT_3_11a6)
/* Interim compatibility for the internal frame API as shipped in 3.11a6
* Some projects (Cython, gevent, greenlet) are known to access the private
* frame API in CPython. This API has already changed twice for 3.11 (first
* with the structural split, then with the full object structure becoming
* opaque and internal struct gaining the `_Py` prefix). The recommended
* resolution is expected to change again once a proper public API for the
* required frame operations is defined (as discussed in
* https://github.com/faster-cpython/ideas/issues/309).
*
* This interim compatibility workaround enables the bpo-44800 struct and field
* name changes for CPython maintainability without forcing yet another interim
* code update on the affected projects. Since the workaround affects symbols
* without the `Py` or `_Py` prefix, a preprocessor symbol can be declared to
* disable the workaround: _PY_FRAME_API_DISABLE_INTERIM_COMPAT_3_11a6
*/
// Renamed frame data struct and fields
typedef _Py_frame _PyInterpreterFrame;
#define f_func func
#define f_globals globals
#define f_builtins builtins
#define f_locals locals
#define f_code code
#define f_lasti lasti
#define f_state state
// Renamed frame object fields
#define f_frame f_fdata
#define _f_frame_data _f_owned_fdata
#endif // End internal frame API compatibilty workaround

static inline int _PyFrame_IsRunnable(_Py_frame *f) {
return f->state < FRAME_EXECUTING;
}
Expand Down
17 changes: 17 additions & 0 deletions Objects/frameobject.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,23 @@ static PyMemberDef frame_memberlist[] = {
{NULL} /* Sentinel */
};

// Compile time check of interim Python 3.11a6 API compatibility aliases
// Can be removed once the aliases are removed
static_assert(OFF(f_fdata) == OFF(f_frame), "Incorrect alias for f_frame");
static_assert(OFF(_f_owned_fdata) == OFF(_f_frame_data), "Incorrect alias for _f_frame_data");

#define INTERIM_FRAME_DATA_ALIAS_CHECK(new_field) \
static_assert(offsetof(_Py_frame, new_field) == offsetof(_PyInterpreterFrame, f_##new_field), \
"Incorrect alias for f_" #new_field )

INTERIM_FRAME_DATA_ALIAS_CHECK(func);
INTERIM_FRAME_DATA_ALIAS_CHECK(builtins);
INTERIM_FRAME_DATA_ALIAS_CHECK(globals);
INTERIM_FRAME_DATA_ALIAS_CHECK(locals);
INTERIM_FRAME_DATA_ALIAS_CHECK(code);
INTERIM_FRAME_DATA_ALIAS_CHECK(lasti);
INTERIM_FRAME_DATA_ALIAS_CHECK(state);
// End compatiblity alias check

static PyObject *
frame_getlocals(PyFrameObject *f, void *closure)
Expand Down