gh-156725: document O(N) behavior of PyCode_Addr2Line and the private line-table API - #156736
Open
Himesh-rupchandani wants to merge 2 commits into
Open
Himesh-rupchandani wants to merge 2 commits into
Himesh-rupchandani wants to merge 2 commits into
Conversation
|
All commit authors signed the Contributor License Agreement. |
Documentation build overview
130 files changed ·
|
…rivate line-table API The C-API docs for PyCode_Addr2Line pointed to the PEP 626 section that describes PyLineTable_InitAddressRange / PyLineTable_NextAddressRange / PyLineTable_PreviousAddressRange, but those functions have since been renamed with a leading underscore and moved to the private header Include/internal/pycore_code.h. Point to the current private names, note that they are not a stable public API, and document that PyCode_Addr2Line is O(N).
Himesh-rupchandani
force-pushed
the
gh-156725-code-addrtoline-docs
branch
from
August 31, 2026 19:07
3f8d96b to
7707506
Compare
maurycy
reviewed
Sep 2, 2026
Comment on lines
+114
to
+117
| .. warning:: | ||
| These functions are **internal and not a public C-API**. They are | ||
| declared in a private header, may change or be removed without notice, | ||
| and are not exported as stable symbols. |
Contributor
There was a problem hiding this comment.
I'm not sure if we should document internal. Users should not be calling them, and pointing it from the docs might send the wrong message.
https://docs.python.org/3/c-api/stable.html#:~:text=Names%20prefixed%20by%20an%20underscore
maurycy
reviewed
Sep 2, 2026
| For efficiently iterating over the line numbers in a code object, use :pep:`the API described in PEP 626 | ||
| <0626#out-of-process-debuggers-and-profilers>`. | ||
| To iterate efficiently over the line numbers in a code object, use the | ||
| private, unstable line-table iteration APIs declared in the private header |
Contributor
There was a problem hiding this comment.
Unstable has specific meaning:
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes gh-156725.
Summary
The C-API docs for
PyCode_Addr2Linepointed to the PEP 626 section describingPyLineTable_InitAddressRange,PyLineTable_NextAddressRange, andPyLineTable_PreviousAddressRange. Those functions were renamed with a leadingunderscore and moved to the private header
Include/internal/pycore_code.h; theyare no longer a public C-API.
This docs PR:
PyCode_Addr2Lineis O(N) in the number of instructions;_PyCode_InitAddressRange,_PyLineTable_NextAddressRange,_PyLineTable_PreviousAddressRange) and flagsthem as internal/unstable.
I left the request to expose these as PyUnstable public APIs as a separate feature
proposal, per the issue.