Skip to content

[C API] Move PyFrame_* API to <Python.h> #93937

Closed
Closed
[C API] Move PyFrame_* API to <Python.h>#93937
Labels
topic-C-APItype-bugAn unexpected behavior, bug, or error

Description

@vstinner
vstinner
opened on Jun 17, 2022

Currently, getter functions of a Python frame object (PyFrameObject) are only accessible if the frameobject.h header is included explicitly. It's not documented in the frame doc: https://docs.python.org/dev/c-api/frame.html

In Python 3.11, the PyFrameObject structure was moved to the internal C API. Third party C extensions now must only use getter functions, as explained in What's New in Python 3.11: https://docs.python.org/dev/whatsnew/3.11.html#id6

Problem: functions like PyFrame_GetBack() requires to include frameobject.h. I propose to move these getter functions to Python.h (to pyframe.h in practice) to make these functions less special.

Linked PRs

Activity

  1. vstinner
    added
    type-bugAn unexpected behavior, bug, or error
    topic-C-API
    on Jun 17, 2022
  2. vstinner
    added 3 commits that reference this issue on Jun 19, 2022

    gh-93937, C API: Move PyFrame_GetBack() to Python.h (#93938)

    27b9894

    gh-93937, C API: Move PyFrame_GetBack() to Python.h (#93938) (#94000)

    96254a9

    gh-93937: PyOS_StdioReadline() uses PyConfig.legacy_windows_stdio (#9…

    cfb986a

  3. vstinner commented on Jun 20, 2022

    @vstinner
    vstinner
    on Jun 20, 2022
    MemberAuthor

    Done:

  4. serhiy-storchaka
    added a commit that references this issue on Jun 26, 2022

    Revert 30935 defer bpo45162 to 312 (#94285)

    1ffde3e

  5. kumaraditya303 commented on Sep 17, 2022

    @kumaraditya303
    kumaraditya303
    on Sep 17, 2022
    Contributor

    This is fixed, closing.

  6. kumaraditya303
    closed this as completedon Sep 17, 2022
  7. encukou
    changed the title [-][C API] Move PyFrame_GetBack() function to <Python.h>[/-] [+][C API] Move PyFrame_* API to <Python.h>[/+] on Nov 22, 2022

  8. encukou commented on Nov 22, 2022

    @encukou
    encukou
    on Nov 22, 2022
    Member

    I'll reuse this issue to add missing docs.

  9. encukou
    reopened this on Nov 22, 2022
  10. encukou
    added 2 commits that reference this issue on Nov 22, 2022

    pythongh-93937: Document PyFrame_Check and PyFrame_Type

    50ae35d

    gh-93937: Document PyFrame_Check and PyFrame_Type (GH-99695)

    d15b9f1
  11. miss-islington
    added 2 commits that reference this issue on Nov 22, 2022

    pythongh-93937: Document PyFrame_Check and PyFrame_Type (pythonGH-99695)

    e6bc093

    gh-93937: Document PyFrame_Check and PyFrame_Type (GH-99695)

    9a4b2f4
  12. encukou
    closed this as completedon Nov 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    topic-C-APItype-bugAn unexpected behavior, bug, or error

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions