GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Undocumented 3.13 C API · Issue #118915 · python/cpython

Undocumented 3.13 C API #118915

New issue
Copy link
New issue
Copy link
Open
Open
Undocumented 3.13 C API#118915
Copy link
Labels
docsDocumentation in the Doc dirDocumentation in the Doc dirtopic-C-API

Description

@encukou
encukou
opened on May 10, 2024
Issue body actions

The following public C API is new in 3.13 (beta 1, relative to 3.12), and as of this writing it looks either

  • undocumented, or
  • documented incorrectly. See the docs search page for what Sphinx thinks the type and fully-quilfied name of the symbol are; it should be a C entry without extraneous namespaces. (The details tend to matter for search, URLs, and Intersphinx links.)

See also: 3.14

  • PY_MACCONFIG_H in Include/pymacconfig.h (header guards don't need docs)
  • PY_MONITORING_EVENT_BRANCH in Include/cpython/monitoring.h
  • PY_MONITORING_EVENT_CALL in Include/cpython/monitoring.h
  • PY_MONITORING_EVENT_C_RAISE in Include/cpython/monitoring.h
  • PY_MONITORING_EVENT_C_RETURN in Include/cpython/monitoring.h
  • PY_MONITORING_EVENT_EXCEPTION_HANDLED in Include/cpython/monitoring.h
  • PY_MONITORING_EVENT_INSTRUCTION in Include/cpython/monitoring.h
  • PY_MONITORING_EVENT_JUMP in Include/cpython/monitoring.h
  • PY_MONITORING_EVENT_LINE in Include/cpython/monitoring.h
  • PY_MONITORING_EVENT_PY_RESUME in Include/cpython/monitoring.h
  • PY_MONITORING_EVENT_PY_RETURN in Include/cpython/monitoring.h
  • PY_MONITORING_EVENT_PY_START in Include/cpython/monitoring.h
  • PY_MONITORING_EVENT_PY_THROW in Include/cpython/monitoring.h
  • PY_MONITORING_EVENT_PY_UNWIND in Include/cpython/monitoring.h
  • PY_MONITORING_EVENT_PY_YIELD in Include/cpython/monitoring.h
  • PY_MONITORING_EVENT_RAISE in Include/cpython/monitoring.h
  • PY_MONITORING_EVENT_RERAISE in Include/cpython/monitoring.h
  • PY_MONITORING_EVENT_STOP_ITERATION in Include/cpython/monitoring.h
  • PY_MONITORING_IS_INSTRUMENTED_EVENT in Include/cpython/monitoring.h
  • PyCF_OPTIMIZED_AST in Include/cpython/compile.h
  • PyEval_GetFrameBuiltins in Include/ceval.h:25
  • PyEval_GetFrameGlobals in Include/ceval.h:26
  • PyEval_GetFrameLocals in Include/ceval.h:27
  • PyExc_IncompleteInputError in Include/pyerrors.h:111
  • PyExc_PythonFinalizationError in Include/cpython/pyerrors.h:129
  • PyFrameLocalsProxy_Check in Include/cpython/pyframe.h
  • PyFrameLocalsProxy_Type in Include/cpython/pyframe.h:6
  • PyMonitoring_EnterScope in Include/cpython/monitoring.h:44
  • PyMonitoring_ExitScope in Include/cpython/monitoring.h:48
  • PyRefTracerEvent in Include/cpython/object.h:516, Include/cpython/object.h:519
  • PyUnstable_AtExit in Include/cpython/pylifecycle.h:91
  • PyUnstable_CopyPerfMapFile in Include/cpython/sysmodule.h:20
  • PyUnstable_EXECUTABLE_KINDS in Include/cpython/pyframe.h
  • PyUnstable_EXECUTABLE_KIND_BUILTIN_FUNCTION in Include/cpython/pyframe.h
  • PyUnstable_EXECUTABLE_KIND_METHOD_DESCRIPTOR in Include/cpython/pyframe.h
  • PyUnstable_EXECUTABLE_KIND_PY_FUNCTION in Include/cpython/pyframe.h
  • PyUnstable_EXECUTABLE_KIND_SKIP in Include/cpython/pyframe.h
  • PyUnstable_ExecutableKinds in Include/cpython/pyframe.h:45
  • PyUnstable_GetExecutor in Include/cpython/optimizer.h:137 (now removed)
  • PyUnstable_GetOptimizer in Include/cpython/optimizer.h:135 (now removed)
  • PyUnstable_InterpreterState_GetMainModule in Include/cpython/pystate.h:11
  • PyUnstable_Optimizer_NewCounter in Include/cpython/optimizer.h:145 (now removed)
  • PyUnstable_Optimizer_NewUOpOptimizer in Include/cpython/optimizer.h:146 (now removed)
  • PyUnstable_PerfTrampoline_CompileCode in Include/cpython/sysmodule.h:21
  • PyUnstable_PerfTrampoline_SetPersistAfterFork in Include/cpython/sysmodule.h:22
  • PyUnstable_Replace_Executor in Include/cpython/optimizer.h:129 (now removed)
  • PyUnstable_SetOptimizer in Include/cpython/optimizer.h:133 (now removed)
  • Py_ASNATIVEBYTES_BIG_ENDIAN in Include/cpython/longobject.h
  • Py_ASNATIVEBYTES_DEFAULTS in Include/cpython/longobject.h
  • Py_ASNATIVEBYTES_LITTLE_ENDIAN in Include/cpython/longobject.h
  • Py_ASNATIVEBYTES_NATIVE_ENDIAN in Include/cpython/longobject.h
  • Py_ASNATIVEBYTES_REJECT_NEGATIVE in Include/cpython/longobject.h
  • Py_ASNATIVEBYTES_UNSIGNED_BUFFER in Include/cpython/longobject.h
  • Py_ATOMIC_H in Include/pyatomic.h (header guards don't need docs)
  • Py_CAN_START_THREADS in Include/pyport.h:463
  • Py_C_RECURSION_LIMIT in Include/cpython/pystate.h:215 (removed in 3.14)
  • Py_MOD_GIL_NOT_USED in Include/moduleobject.h:69
  • Py_MOD_GIL_USED in Include/moduleobject.h:69
  • Py_MONITORING_H in Include/monitoring.h (header guards don't need docs)
  • Py_OPTIMIZER_H in Include/cpython/optimizer.h (header guards don't need docs)
  • Py_TPFLAGS_INLINE_VALUES in Include/object.h:632
  • Py_TRASHCAN_HEADROOM in Include/cpython/object.h:463 (removed in GH-124715: Move trashcan mechanism into Py_Dealloc #132280)
  • CO_NO_MONITORING_EVENTS in Include/cpython/code.h:192

Some more are generated by configure, I guess that's low priority:

  • HAVE_CLOCK_T in ./pyconfig.h:138
  • HAVE_CLOSEFROM in ./pyconfig.h:138
  • HAVE_GETGRENT in ./pyconfig.h:138
  • HAVE_GRANTPT in ./pyconfig.h:515
  • HAVE_POSIX_OPENPT in ./pyconfig.h:849
  • HAVE_POSIX_SPAWN_FILE_ACTIONS_ADDCLOSEFROM_NP in ./pyconfig.h:849
  • HAVE_PROCESS_VM_READV in ./pyconfig.h:849
  • HAVE_PTSNAME in ./pyconfig.h:957
  • HAVE_PTSNAME_R in ./pyconfig.h:957
  • HAVE_SOCKLEN_T in ./pyconfig.h:957
  • HAVE_SYS_TIMERFD_H in ./pyconfig.h:1406
  • HAVE_TIMERFD_CREATE in ./pyconfig.h:1406
  • HAVE_UNLOCKPT in ./pyconfig.h:1406
  • HAVE___UINT128_T in ./pyconfig.h:1582
  • WITH_MIMALLOC in ./pyconfig.h:1867

Linked PRs

  • gh-118915: Add/fix docs entries for some new 3.13 C API #124134
  • [3.13] gh-118915: Add/fix docs entries for some new 3.13 C API (GH-124134) #124244
  • gh-118915: C API: Document frame locals proxies. #127720
  • [3.13] gh-118915: C API: Document frame locals proxies. (GH-127720) #127831
  • gh-118915: Add document of PY_MONITORING_IS_INSTRUMENTED_EVENT #128026
  • gh-118915: Document PyUnstable_InterpreterState_GetMainModule #128483
  • [3.13] gh-118915: Document PyUnstable_InterpreterState_GetMainModule (GH-128483) #128677
  • gh-118915: C API: Document compiler flag macros #129028
  • [3.13] gh-118915: C API: Document compiler flag macros (GH-129028) #129086
  • gh-118915: Fix bad link in documentation #129691
  • [3.13] gh-118915: Fix bad link in documentation (GH-129691) #129723
  • [3.13] gh-118915: Document PY_MONITORING_IS_INSTRUMENTED_EVENT (GH-128026) #131424
Reacted by Erlend E. Aasland and Savannah Ostrowski

Activity

Next
  1. encukou
    added
    docsDocumentation in the Doc dirDocumentation in the Doc dir
    topic-C-API
    on May 10, 2024
  2. ronaldoussoren commented on May 11, 2024

    @ronaldoussoren
    ronaldoussoren
    on May 11, 2024
    Contributor
    More actions

    PY_MACCONFIG_H was almost certainly introduced by me, and almost matches the pattern used in other headers (other headers use Py_ as the prefix and not PY_. Its just there to make it safe to include the header more than once and does not have to be documented.

    Reacted by Petr Viktorin
  3. encukou
    added 3 commits that reference this issue on Sep 16, 2024

    pythongh-118915: Add/fix docs entries for some new 3.13 C API

    4294a83

    gh-118915: Add/fix docs entries for some new 3.13 C API (GH-124134)

    32119fc

    pythongh-118915: Add/fix docs entries for some new 3.13 C API (python…

    fba5316
  4. savannahostrowski
    added a commit that references this issue on Sep 22, 2024

    pythongh-118915: Add/fix docs entries for some new 3.13 C API (python…

    cd84222
  5. AA-Turner
    added a commit that references this issue on Sep 23, 2024

    pythongh-118915: Add/fix docs entries for some new 3.13 C API (python…

    84fdad1
  6. Yhg1s
    added 2 commits that reference this issue on Sep 23, 2024

    [3.13] GH-109975: Copyedit 3.13 What's New: C API (GH-124313) (#124334)

    86f30dd

    [3.13] gh-118915: Add/fix docs entries for some new 3.13 C API (GH-12…

    a439f85
  7. vstinner
    added a commit that references this issue on Dec 11, 2024

    gh-118915: C API: Document frame locals proxies. (#127720)

    dd9da73
  8. miss-islington
    added a commit that references this issue on Dec 11, 2024

    pythongh-118915: C API: Document frame locals proxies. (pythonGH-127720)

    f86cf73
  9. vstinner
    added a commit that references this issue on Dec 11, 2024

    [3.13] gh-118915: C API: Document frame locals proxies. (GH-127720) (#…

    8b24d04
  10. srinivasreddy
    added a commit that references this issue on Jan 8, 2025

    pythongh-118915: C API: Document frame locals proxies. (python#127720)

    606869b
  11. encukou
    added a commit that references this issue on Jan 9, 2025

    gh-118915: Document `PyUnstable_InterpreterState_GetMainModule` (GH-1…

    ea39c8b
  12. 1 remaining item

  13. encukou
    added a commit that references this issue on Jan 10, 2025

    [3.13] gh-118915: Document `PyUnstable_InterpreterState_GetMainModule` (

    65da5db
  14. encukou
    added a commit that references this issue on Jan 20, 2025

    gh-118915: C API: Document compiler flag macros (GH-129028)

    6e02096
  15. miss-islington
    added a commit that references this issue on Jan 20, 2025

    pythongh-118915: C API: Document compiler flag macros (pythonGH-129028)

    468c4e2
  16. srinivasreddy
    added a commit that references this issue on Jan 21, 2025

    pythongh-118915: C API: Document compiler flag macros (pythonGH-129028)

    45316fc
  17. encukou
    added a commit that references this issue on Jan 21, 2025

    [3.13] gh-118915: C API: Document compiler flag macros (GH-129028) (G…

    972d953
  18. hroncok
    added a commit that references this issue on Feb 5, 2025

    pythongh-118915: Fix bad link in documentation

    45c91e9
  19. encukou
    added a commit that references this issue on Feb 6, 2025

    gh-118915: Fix bad link in documentation (GH-129691)

    779d069
  20. miss-islington
    added a commit that references this issue on Feb 6, 2025

    pythongh-118915: Fix bad link in documentation (pythonGH-129691)

    1a034bd
  21. encukou
    added a commit that references this issue on Feb 6, 2025

    [3.13] gh-118915: Fix bad link in documentation (GH-129691) (GH-129723)

    fc78ed9
  22. srinivasreddy
    added a commit that references this issue on Feb 7, 2025

    pythongh-118915: Fix bad link in documentation (pythonGH-129691)

    eb9e7ac
  23. cmaloney
    added a commit that references this issue on Feb 8, 2025

    pythongh-118915: Fix bad link in documentation (pythonGH-129691)

    aed8460
  24. encukou
    added a commit that references this issue on Mar 18, 2025

    gh-118915: Document `PY_MONITORING_IS_INSTRUMENTED_EVENT` (GH-128026)

    f819900
  25. miss-islington
    added a commit that references this issue on Mar 18, 2025

    pythongh-118915: Document `PY_MONITORING_IS_INSTRUMENTED_EVENT` (pyth…

    44d7dce
  26. encukou
    added a commit that references this issue on Mar 19, 2025

    [3.13] gh-118915: Document `PY_MONITORING_IS_INSTRUMENTED_EVENT` (GH-…

    49efc41
  27. colesbury
    added a commit that references this issue on Mar 20, 2025

    pythongh-118915: Document `PY_MONITORING_IS_INSTRUMENTED_EVENT` (pyth…

    43810f7
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

    docsDocumentation in the Doc dirDocumentation in the Doc dirtopic-C-API

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      You are visitor 01402503 — GeezerVison does not store the pages you look up.
      Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.