summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2021-09-10 16:16:51 (GMT)
committerGitHub <noreply@github.com>2021-09-10 16:16:51 (GMT)
commitb045174a6dbf1060f092265853f0c78f0704a21a (patch)
tree9d313288a0a222bdeee258154cbd366a10fe4c35 /Doc
parent60ddf499e14cc7daba3804e5a3460e4224dacc5c (diff)
downloadcpython-b045174a6dbf1060f092265853f0c78f0704a21a.zip
cpython-b045174a6dbf1060f092265853f0c78f0704a21a.tar.gz
cpython-b045174a6dbf1060f092265853f0c78f0704a21a.tar.bz2
bpo-44964: Correct the note about the f_lasti field (GH-28208) (GH-28276)
(cherry picked from commit ab327f2929589407595a3de95727c8ab34ddd4af) Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
Diffstat (limited to 'Doc')
-rw-r--r--Doc/reference/datamodel.rst5
-rw-r--r--Doc/whatsnew/3.10.rst3
2 files changed, 4 insertions, 4 deletions
diff --git a/Doc/reference/datamodel.rst b/Doc/reference/datamodel.rst
index 7b54f44..d3cf983 100644
--- a/Doc/reference/datamodel.rst
+++ b/Doc/reference/datamodel.rst
@@ -1034,9 +1034,8 @@ Internal types
:attr:`f_code` is the code object being executed in this frame; :attr:`f_locals`
is the dictionary used to look up local variables; :attr:`f_globals` is used for
global variables; :attr:`f_builtins` is used for built-in (intrinsic) names;
- :attr:`f_lasti` gives the precise instruction (it represents a wordcode index, which
- means that to get an index into the bytecode string of the code object it needs to be
- multiplied by 2).
+ :attr:`f_lasti` gives the precise instruction (this is an index into the
+ bytecode string of the code object).
Accessing ``f_code`` raises an :ref:`auditing event <auditing>`
``object.__getattr__`` with arguments ``obj`` and ``"f_code"``.
diff --git a/Doc/whatsnew/3.10.rst b/Doc/whatsnew/3.10.rst
index 5a5f4a3..2f08b9f 100644
--- a/Doc/whatsnew/3.10.rst
+++ b/Doc/whatsnew/3.10.rst
@@ -1948,7 +1948,8 @@ Changes in the C API
offset instead of a simple offset into the bytecode string. This means that this
number needs to be multiplied by 2 to be used with APIs that expect a byte offset
instead (like :c:func:`PyCode_Addr2Line` for example). Notice as well that the
- ``f_lasti`` member of ``FrameObject`` objects is not considered stable.
+ ``f_lasti`` member of ``FrameObject`` objects is not considered stable: please
+ use :c:func:`PyFrame_GetLineNumber` instead.
CPython bytecode changes
========================