I wanted to ask to document properly that PyCode_Addr2Line() uses a byte offset, but the function is not documented! Can you please document the function at:
https://docs.python.org/dev/c-api/code.html

Please document f_lasti unit and the change at: https://docs.python.org/dev/library/inspect.html

The comment on PyCode_Addr2Line() says
"If you just need the line number of a frame, use PyFrame_GetLineNumber() instead."
PEP 626 provides a faster way to extract line numbers: https://www.python.org/dev/peps/pep-0626/#out-of-process-debuggers-and-profilers
So I think we should keep PyCode_Addr2Line() undocumented, unless you want to document it as "don't use this."

There are no changes to the inspect module.

So I think we should keep PyCode_Addr2Line() undocumented, unless you want to document it as "don't use this."

It's part of the public C API, so people uses it (for good or bad reasons). A search on the top 4000 PyPI projects give me:

vstinner@apu$ ./search.sh PyCode_Addr2Line
2021-02-18/uWSGI-2.0.19.1.tar.gz
2021-02-18/rook-0.1.138.tar.gz
2021-02-18/pyuwsgi-2.0.19.1.post0.tar.gz
2021-02-18/Pygments-2.8.0.tar.gz
2021-02-18/pydevd-2.2.0.tar.gz
2021-02-18/pydevd-pycharm-211.5538.22.tar.gz
2021-02-18/pyelftools-0.27.tar.gz
2021-02-18/mod_wsgi-4.7.1.tar.gz
2021-02-18/line_profiler-3.1.0.tar.gz
2021-02-18/graphene-federation-0.1.0.tar.gz
2021-02-18/faulthandler-3.2.tar.gz
2021-02-18/Cython-0.29.21.tar.gz

Hopefully, the list is short. The documentation should describes the behavior, and it's ok to strongly advice to use another function instead ;-)

@vstinner I'm fine with documenting PyCode_Addr2Line() but it hasn't been changed in this PR, so that is out of scope for this PR. I'll make another PR.

@markshannon markshannon closed this 8 hours ago
@markshannon markshannon reopened this 8 hours ago

You should be allowed to click on the CI to "Re-run all jobs" to avoid closing/reopening the PR. Sadly, it's not possible to only re-run a single job.