-
Notifications
You must be signed in to change notification settings - Fork 11
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
Use tb_lineno to point to correct line in traceback #17
Conversation
try: | ||
return x / y | ||
finally: | ||
str(y) |
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.
This is the line where the traceback would point without the change, as it's the last line the frame executed. tb_lineno points to where the exception happened, two lines up.
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.
Otherwise LGTM.
@@ -54,7 +54,7 @@ def test_find_run_examples(example: CodeExample, eval_example: EvalExample): | |||
|
|||
# assert 'my_file_9_13.py:12: AssertionError' in '\n'.join(result.outlines) | |||
assert result.outlines[-8:-3] == [ | |||
'', | |||
' b = 2', |
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.
This is caused by changing to f_code.co_firstlineno
, which seems to help pytest include more context from the original markdown file.
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.
I understand this properly now. Previously, setting co_firstlineno to frame.f_lineno + example.start_line
was saying that the code started at the problematic line (ignoring the nuance about f_lineno vs tb_lineno) so pytest would show the failing line (so things appeared to work) but it thought that was the start of the code so it didn't show any context before that.
Leaving co_firstlineno
unchanged meant it included more context, but too much.
f_code.co_firstlineno + example.start_line
works correctly as you'd expect. That's the only way that this expanded test passes, with pytest showing the exact correct context.
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.
#19 doesn't pass this test because the code in line_adjusted_source
still starts at the first line, even if it's just padding comments, so the full example file gets included as context for the top level frame.
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.
LGTM 👍 thanks for the contribution!
Tracebacks should generally use
tb_lineno/lasti
instead off_lineno/lasti
. From https://docs.python.org/3/reference/datamodel.html#traceback-objects: