FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Add PyCode_GetCode() function by vstinner · Pull Request #34 · python/pythoncapi-compat · GitHub

/ pythoncapi-compat Public

Add PyCode_GetCode() function #34

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

Merged
vstinner merged 2 commits into from
May 3, 2022
Conversation 8 Commits 2 Checks 0 Files changed
Merged

Add PyCode_GetCode() function #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d3e2f86
Add PyCode_GetCode() function
vstinner May 3, 2022
98cde84
Update
vstinner May 3, 2022
File filter

Filter by extension

Filter by extension .c  (1) .h  (1) .py  (1) .rst  (2) All 4 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
6 changes: 6 additions & 0 deletions docs/api.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ Latest version of the header file:
Python 3.11
-----------

.. c:function:: PyObject* PyCode_GetCode(PyObject *code)

Fidget-Spinner May 3, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Nit: PyCodeObject *code not PyObject *code :)

vstinner May 3, 2022

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Fixed in commit bed155e.

See `PyCode_GetCode() documentation <https://docs.python.org/dev/c-api/code.html#c.PyCode_GetCode>`__.

Not available on PyPy.

.. c:function:: PyObject* PyFrame_GetBuiltins(PyFrameObject *frame)

See `PyFrame_GetBuiltins() documentation <https://docs.python.org/dev/c-api/frame.html#c.PyFrame_GetBuiltins>`__.
Expand Down
1 change: 1 addition & 0 deletions docs/changelog.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
Changelog
=========

* 2022-05-03: Add ``PyCode_GetCode()`` function.
* 2022-04-26: Rename the project from ``pythoncapi_compat`` to
``pythoncapi-compat``: replace the underscore separator with a dash.
* 2022-04-08: Add functions ``PyFrame_GetLocals()``, ``PyFrame_GetGlobals()``
Expand Down
11 changes: 10 additions & 1 deletion pythoncapi_compat.h
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ _PyFrame_GetCodeBorrow(PyFrameObject *frame)
}


// bpo-40421 added PyFrame_GetCode() to Python 3.9.0b1
// bpo-40421 added PyFrame_GetBack() to Python 3.9.0b1
#if PY_VERSION_HEX < 0x030900B1 && !defined(PYPY_VERSION)
PYCAPI_COMPAT_STATIC_INLINE(PyFrameObject*)
PyFrame_GetBack(PyFrameObject *frame)
Expand Down Expand Up @@ -487,6 +487,15 @@ PyFloat_Unpack8(const char *p, int le)
#endif


// gh-92154 added PyCode_GetCode() to Python 3.11.0b1
#if PY_VERSION_HEX < 0x030B00B1 && !defined(PYPY_VERSION)

Fidget-Spinner May 3, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Not sure if it matters, but this code will fail on one version: 3.11a7. In that version, co_code was removed, but there is no PyCode_GetCode.

I don't know what you should do here. Maybe exclude that version?

erlend-aasland May 3, 2022

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Perhaps #error with an explanatory message.

vstinner May 3, 2022

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I don't know what you should do here. Maybe exclude that version?

Alpha versions of Python 3.11 are not supported:

pythoncapi-compat/tests/test_pythoncapi_compat.py

Lines 152 to 157 in c9764f5

# Implementing PyFrame_GetLocals() and PyCode_GetCode() require the
# internal C API in Python 3.11 alpha versions
if 0x30b0000 <= sys.hexversion < 0x30b00b1:
version = sys.version.split()[0]
print("SKIP TESTS: Python %s is not supported" % version)
return

It's a deliberate choice to not pollute pythoncapi_compat.h with ugly code to tons of compatibility layers, whereas there are few users of Python alpha versions.

Perhaps #error with an explanatory message.

What I suggested to users who want to upgrade pythoncapi_compat.h before Python 3.11 beta1 is to copy the file and then remove the functions which cause compilation errors. It's being discussed at: #32

erlend-aasland May 3, 2022

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Ok, makes sense.

vstinner May 3, 2022

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I'm not against adding an #error if you consider that it will help users impacted by this issue.

Python 3.11 beta1 is scheduled in a few days.

Python 3.11 breaks tons of C API: https://docs.python.org/dev/whatsnew/3.11.html#c-api-changes

In the past, I tried first to add getter functions in one Python version, and only change the structure in the following Python version. Well, the optimization work broke many structures (PyThreadState, PyFrameObject, PyCodeObject). But after beta1, the API should be stable.
PyObject *PyCode_GetCode(PyCodeObject *code)
{
return Py_NewRef(code->co_code);
}
#endif


// Py_UNUSED() was added to Python 3.4.0b2.
#if PY_VERSION_HEX < 0x030400B2 && !defined(Py_UNUSED)
# if defined(__GNUC__) || defined(__clang__)
Expand Down
6 changes: 3 additions & 3 deletions tests/test_pythoncapi_compat.py
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -149,9 +149,9 @@ def main():
global VERBOSE
VERBOSE = ("-v" in sys.argv[1:] or "--verbose" in sys.argv[1:])

# Implementing PyFrame_GetLocals() requires the internal C API in Python
# 3.11 alpha versions
if 0x30b0000 <= sys.hexversion < 0x30b00a7:
# Implementing PyFrame_GetLocals() and PyCode_GetCode() require the
# internal C API in Python 3.11 alpha versions
if 0x30b0000 <= sys.hexversion < 0x30b00b1:
version = sys.version.split()[0]
print("SKIP TESTS: Python %s is not supported" % version)
return
Expand Down
27 changes: 27 additions & 0 deletions tests/test_pythoncapi_compat_cext.c
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -489,6 +489,30 @@ test_float_pack(PyObject *Py_UNUSED(module), PyObject* Py_UNUSED(ignored))
#endif


#if !defined(PYPY_VERSION)
static PyObject *
test_code(PyObject *Py_UNUSED(module), PyObject* Py_UNUSED(ignored))
{
PyThreadState *tstate = PyThreadState_Get();
PyFrameObject *frame = PyThreadState_GetFrame(tstate);
if (frame == NULL) {
PyErr_SetString(PyExc_AssertionError, "PyThreadState_GetFrame failed");
return NULL;
}
PyCodeObject *code = PyFrame_GetCode(frame);

PyObject *co_code = PyCode_GetCode(code);
assert(co_code != NULL);
assert(PyBytes_Check(co_code));
Py_DECREF(co_code);

Py_DECREF(code);
Py_DECREF(frame);
Py_RETURN_NONE;
}
#endif


static struct PyMethodDef methods[] = {
{"test_object", test_object, METH_NOARGS, NULL},
{"test_py_is", test_py_is, METH_NOARGS, NULL},
Expand All @@ -503,6 +527,9 @@ static struct PyMethodDef methods[] = {
{"test_module", test_module, METH_NOARGS, NULL},
#if (PY_VERSION_HEX <= 0x030B00A1 || 0x030B00A7 <= PY_VERSION_HEX) && !defined(PYPY_VERSION)
{"test_float_pack", test_float_pack, METH_NOARGS, NULL},
#endif
#if !defined(PYPY_VERSION)
{"test_code", test_code, METH_NOARGS, NULL},
#endif
{NULL, NULL, 0, NULL}
};
Expand Down
Back | FazBrowse Home | New Git URL