Skip to content

Commit 4c696aa

Browse files
xionghulcursoragent
andcommitted
gh-161799: Address review comments on the position lookup
Use PyLong_AsInt for the bytecode offset, and test the three lookup paths the same way. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent f45a24d commit 4c696aa

5 files changed

Lines changed: 39 additions & 32 deletions

File tree

‎Lib/inspect.py‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1610,12 +1610,11 @@ def _get_code_position_from_tb(tb):
16101610
return _get_code_position(code, instruction_index)
16111611

16121612
def _get_code_position(code, instruction_index):
1613+
# Keep this in sync with traceback._get_code_position.
1614+
# The offset is a byte offset. Real code objects look it up directly.
1615+
# Duck-typed code objects only implement co_positions().
16131616
if instruction_index < 0:
16141617
return (None, None, None, None)
1615-
# Byte offset, the same value traceback.c passes to PyCode_Addr2Location.
1616-
# co_positions() builds a tuple per earlier instruction. Real code objects
1617-
# can look the one offset up directly. Duck-typed code objects only
1618-
# implement co_positions().
16191618
if isinstance(code, types.CodeType):
16201619
return code._co_position_at(instruction_index)
16211620
positions_gen = code.co_positions()

‎Lib/test/test_code.py‎

Lines changed: 28 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -195,10 +195,12 @@
195195
"""
196196

197197
import copy
198+
import functools
198199
import inspect
199200
import sys
200201
import threading
201202
import doctest
203+
import traceback
202204
import unittest
203205
import textwrap
204206
import weakref
@@ -586,9 +588,6 @@ def func():
586588
def test_co_position_at_matches_co_positions(self):
587589
# _co_position_at is the single-offset form of co_positions().
588590
# The argument is a byte offset, and each instruction is 2 bytes.
589-
import inspect
590-
import traceback
591-
592591
def func(x):
593592
return x + 1
594593

@@ -598,23 +597,35 @@ def func(x):
598597
func.__code__.replace(co_linetable=b''),
599598
]
600599
for code in samples:
600+
lookups = (
601+
("code._co_position_at", code._co_position_at),
602+
("inspect._get_code_position",
603+
functools.partial(inspect._get_code_position, code)),
604+
("traceback._get_code_position",
605+
functools.partial(traceback._get_code_position, code)),
606+
)
601607
with self.subTest(code=code):
602608
for index, expected in enumerate(code.co_positions()):
603609
offset = index * 2
604-
self.assertEqual(code._co_position_at(offset), expected)
605-
self.assertEqual(
606-
inspect._get_code_position(code, offset), expected)
607-
self.assertEqual(
608-
traceback._get_code_position(code, offset), expected)
609-
self.assertEqual(
610-
inspect._get_code_position(code, -1),
611-
(None, None, None, None))
612-
with self.assertRaises(ValueError):
613-
code._co_position_at(-1)
614-
with self.assertRaises(ValueError):
615-
code._co_position_at(len(code.co_code))
616-
with self.assertRaises(TypeError):
617-
code._co_position_at(None)
610+
for name, lookup in lookups:
611+
with self.subTest(lookup=name, offset=offset):
612+
self.assertEqual(lookup(offset), expected)
613+
614+
def test_co_position_at_rejects_bad_offsets(self):
615+
def func(x):
616+
return x + 1
617+
618+
code = func.__code__
619+
co_position_at = code._co_position_at
620+
# Negative indexes stay in the Python wrappers. The C method rejects them.
621+
self.assertEqual(inspect._get_code_position(code, -1),
622+
(None, None, None, None))
623+
self.assertEqual(traceback._get_code_position(code, -1),
624+
(None, None, None, None))
625+
self.assertRaises(ValueError, co_position_at, -1)
626+
self.assertRaises(ValueError, co_position_at, len(code.co_code))
627+
self.assertRaises(TypeError, co_position_at, None)
628+
self.assertRaises(OverflowError, co_position_at, 2**100)
618629

619630
def test_code_equality(self):
620631
def f():

‎Lib/test/test_inspect/test_inspect.py‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -587,17 +587,15 @@ def test_trace(self):
587587
self.assertEqual(frame3.positions, dis.Positions(18, 18, 8, 13))
588588

589589
def test_stack_context_zero_keeps_positions(self):
590-
# context=0 drops source lines. Column positions stay filled, and
591-
# the filename still comes from getsourcefile().
590+
# context=0 drops source lines. Column positions stay filled.
591+
# The frame is this test function, so the filename is this module.
592592
stack = inspect.stack(0)
593593
top = stack[0]
594594
self.assertIsNone(top.code_context)
595595
self.assertIsNone(top.index)
596+
self.assertEqual(top.filename, __file__)
596597
self.assertIn(tuple(top.positions),
597598
list(top.frame.f_code.co_positions()))
598-
self.assertEqual(
599-
top.filename,
600-
inspect.getsourcefile(top.frame) or inspect.getfile(top.frame))
601599

602600
def test_frame(self):
603601
args, varargs, varkw, locals = inspect.getargvalues(mod.fr)

‎Lib/traceback.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -469,10 +469,9 @@ def _walk_tb_with_full_positions(tb):
469469

470470

471471
def _get_code_position(code, instruction_index):
472+
# Keep this in sync with inspect._get_code_position.
472473
if instruction_index < 0:
473474
return (None, None, None, None)
474-
# Byte offset. See inspect._get_code_position. Objects that only
475-
# implement co_positions() keep the iterator path.
476475
if isinstance(code, types.CodeType):
477476
return code._co_position_at(instruction_index)
478477
positions_gen = code.co_positions()

‎Objects/codeobject.c‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1513,19 +1513,19 @@ code_co_position_at(PyObject *self, PyObject *indexobj)
15131513
{
15141514
PyCodeObject *code = (PyCodeObject *)self;
15151515
int start_line, end_line, start_column, end_column;
1516-
long addrq;
1516+
int addrq;
15171517
Py_ssize_t nbytes;
15181518

1519-
addrq = PyLong_AsLong(indexobj);
1519+
addrq = PyLong_AsInt(indexobj);
15201520
if (addrq == -1 && PyErr_Occurred()) {
15211521
return NULL;
15221522
}
15231523
nbytes = _PyCode_NBYTES(code);
1524-
if (addrq < 0 || addrq >= nbytes || addrq > INT_MAX) {
1524+
if (addrq < 0 || addrq >= nbytes) {
15251525
PyErr_SetString(PyExc_ValueError, "bytecode offset out of range");
15261526
return NULL;
15271527
}
1528-
if (!PyCode_Addr2Location(code, (int)addrq, &start_line, &start_column,
1528+
if (!PyCode_Addr2Location(code, addrq, &start_line, &start_column,
15291529
&end_line, &end_column)) {
15301530
PyErr_SetString(PyExc_SystemError, "PyCode_Addr2Location failed");
15311531
return NULL;

0 commit comments

Comments
 (0)