-
-
Notifications
You must be signed in to change notification settings - Fork 37.2k
gh-156725: document O(N) behavior of PyCode_Addr2Line and the private line-table API #156736
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.
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
Open
Himesh-rupchandani
wants to merge
2
commits into
python:main
Choose a base branch
from
Himesh-rupchandani:gh-156725-code-addrtoline-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -94,11 +94,27 @@ bound into a function. | |
|
|
||
| .. c:function:: int PyCode_Addr2Line(PyCodeObject *co, int byte_offset) | ||
|
|
||
| Return the line number of the instruction that occurs on or before ``byte_offset`` and ends after it. | ||
| Return the line number of the instruction that occurs on or before | ||
| ``byte_offset`` and ends after it. This is ``O(N)`` in the number of | ||
| instructions in the code object, so it is not suitable for iterating over | ||
| all the line numbers in a code object. | ||
|
|
||
| If you just need the line number of a frame, use :c:func:`PyFrame_GetLineNumber` instead. | ||
|
|
||
| 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 | ||
| ``Include/internal/pycore_code.h``: | ||
|
|
||
| * ``_PyCode_InitAddressRange`` initializes a ``PyCodeAddressRange`` for a code object. | ||
| * ``_PyLineTable_NextAddressRange`` advances the range to the next | ||
| line-number entry. | ||
| * ``_PyLineTable_PreviousAddressRange`` retreats the range to the | ||
| previous entry. | ||
|
|
||
| .. 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. | ||
|
Comment on lines
+114
to
+117
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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 |
||
|
|
||
| .. c:function:: int PyCode_Addr2Location(PyObject *co, int byte_offset, int *start_line, int *start_column, int *end_line, int *end_column) | ||
|
|
||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unstable has specific meaning:
https://docs.python.org/3/c-api/stable.html#unstable-c-api