Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Document PyCode_Addr2Line function. (GH-25111) 

* Document PyCode_Addr2Line function.

* Clarify when to use PEP 626 line iterators.
This commit is contained in:
Mark Shannon 2021-04-02 13:24:57 +01:00 committed by GitHub
parent bec8c787ec
commit 58384c6ab0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Doc/c-api/code.rst
View File

@ -51,3 +51,11 @@ bound into a function.
Return a new empty code object with the specified filename,
function name, and first line number. It is illegal to
:func:`exec` or :func:`eval` the resulting code object.
.. 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.
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 `the API described in PEP 626
<https://www.python.org/dev/peps/pep-0626/#out-of-process-debuggers-and-profilers>`_.