Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Separate the various parts of the error report with newlines #11659

Merged
merged 5 commits into from
Dec 6, 2023
Merged

Separate the various parts of the error report with newlines #11659

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ed9e5ee
Separate the various parts of the error report with newlines
BenjaminSchubert Dec 3, 2023
69e91bc
fixup! Separate the various parts of the error report with newlines
BenjaminSchubert Dec 3, 2023
775e67a
fixup! fixup! Separate the various parts of the error report with new…
BenjaminSchubert Dec 3, 2023
19e3cfe
Merge branch 'main' into bschubert/separate-diff-report
BenjaminSchubert Dec 3, 2023
e0c51ec
Merge branch 'main' into bschubert/separate-diff-report
BenjaminSchubert Dec 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions changelog/11520.improvement.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
Improved very verbose diff output to color it as a diff instead of only red.

Improved the error reporting to better separate each section.
4 changes: 3 additions & 1 deletion src/_pytest/assertion/util.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,8 @@
if not explanation:
return None

if explanation[0] != "":
explanation = [""] + explanation
return [summary] + explanation


Expand Down Expand Up @@ -332,7 +334,7 @@
left_formatting = PrettyPrinter().pformat(left).splitlines()
right_formatting = PrettyPrinter().pformat(right).splitlines()

explanation = ["Full diff:"]
explanation = ["", "Full diff:"]

Check warning on line 337 in src/_pytest/assertion/util.py

View check run for this annotation

Codecov / codecov/patch

src/_pytest/assertion/util.py#L337 

Added line #L337 was not covered by tests
# "right" is the expected base against which we compare "left",
# see https://github.com/pytest-dev/pytest/issues/3333
explanation.extend(
Expand Down
18 changes: 16 additions & 2 deletions testing/python/approx.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ def test_error_messages_native_dtypes(self, assert_approx_raises_regex):
2.0,
1.0,
[
"",
" comparison failed",
f" Obtained: {SOME_FLOAT}",
f" Expected: {SOME_FLOAT} ± {SOME_FLOAT}",
Expand All @@ -113,6 +114,7 @@ def test_error_messages_native_dtypes(self, assert_approx_raises_regex):
"c": 3000000.0,
},
[
r"",
r" comparison failed. Mismatched elements: 2 / 3:",
rf" Max absolute difference: {SOME_FLOAT}",
rf" Max relative difference: {SOME_FLOAT}",
Expand All @@ -130,6 +132,7 @@ def test_error_messages_native_dtypes(self, assert_approx_raises_regex):
"c": None,
},
[
r"",
r" comparison failed. Mismatched elements: 2 / 3:",
r" Max absolute difference: -inf",
r" Max relative difference: -inf",
Expand All @@ -143,6 +146,7 @@ def test_error_messages_native_dtypes(self, assert_approx_raises_regex):
[1.0, 2.0, 3.0, 4.0],
[1.0, 3.0, 3.0, 5.0],
[
r"",
r" comparison failed. Mismatched elements: 2 / 4:",
rf" Max absolute difference: {SOME_FLOAT}",
rf" Max relative difference: {SOME_FLOAT}",
Expand All @@ -156,6 +160,7 @@ def test_error_messages_native_dtypes(self, assert_approx_raises_regex):
(1, 2.2, 4),
(1, 3.2, 4),
[
r"",
r" comparison failed. Mismatched elements: 1 / 3:",
rf" Max absolute difference: {SOME_FLOAT}",
rf" Max relative difference: {SOME_FLOAT}",
Expand All @@ -169,6 +174,7 @@ def test_error_messages_native_dtypes(self, assert_approx_raises_regex):
[0.0],
[1.0],
[
r"",
r" comparison failed. Mismatched elements: 1 / 1:",
rf" Max absolute difference: {SOME_FLOAT}",
r" Max relative difference: inf",
Expand All @@ -187,6 +193,7 @@ def test_error_messages_numpy_dtypes(self, assert_approx_raises_regex):
a,
b,
[
r"",
r" comparison failed. Mismatched elements: 1 / 20:",
rf" Max absolute difference: {SOME_FLOAT}",
rf" Max relative difference: {SOME_FLOAT}",
Expand All @@ -209,6 +216,7 @@ def test_error_messages_numpy_dtypes(self, assert_approx_raises_regex):
]
),
[
r"",
r" comparison failed. Mismatched elements: 3 / 8:",
rf" Max absolute difference: {SOME_FLOAT}",
rf" Max relative difference: {SOME_FLOAT}",
Expand All @@ -224,6 +232,7 @@ def test_error_messages_numpy_dtypes(self, assert_approx_raises_regex):
np.array([0.0]),
np.array([1.0]),
[
r"",
r" comparison failed. Mismatched elements: 1 / 1:",
rf" Max absolute difference: {SOME_FLOAT}",
r" Max relative difference: inf",
Expand All @@ -241,6 +250,7 @@ def test_error_messages_invalid_args(self, assert_approx_raises_regex):
message = "\n".join(str(e.value).split("\n")[1:])
assert message == "\n".join(
[
" ",
" Impossible to compare arrays with different shapes.",
" Shapes: (2, 1) and (2, 2)",
]
Expand All @@ -251,6 +261,7 @@ def test_error_messages_invalid_args(self, assert_approx_raises_regex):
message = "\n".join(str(e.value).split("\n")[1:])
assert message == "\n".join(
[
" ",
" Impossible to compare lists with different sizes.",
" Lengths: 2 and 3",
]
Expand All @@ -264,6 +275,7 @@ def test_error_messages_with_different_verbosity(self, assert_approx_raises_rege
2.0,
1.0,
[
"",
" comparison failed",
f" Obtained: {SOME_FLOAT}",
f" Expected: {SOME_FLOAT} ± {SOME_FLOAT}",
Expand All @@ -277,13 +289,13 @@ def test_error_messages_with_different_verbosity(self, assert_approx_raises_rege
a,
b,
[
r" ",
r" comparison failed. Mismatched elements: 20 / 20:",
rf" Max absolute difference: {SOME_FLOAT}",
rf" Max relative difference: {SOME_FLOAT}",
r" Index \| Obtained\s+\| Expected",
rf" \(0,\)\s+\| {SOME_FLOAT} \| {SOME_FLOAT} ± {SOME_FLOAT}",
rf" \(1,\)\s+\| {SOME_FLOAT} \| {SOME_FLOAT} ± {SOME_FLOAT}",
rf" \(2,\)\s+\| {SOME_FLOAT} \| {SOME_FLOAT} ± {SOME_FLOAT}...",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume the ... here is added by pytest to indicate truncation. If so, shouldn't it be now on the previous line?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Woops good catch. I've updated the test to add it back

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to make sure, these are literal dots, and the assert is a regex, right? If so, it would be nice to escape the .s to make it clear and not overmatch: \.\.\.. And maybe also add anchors ^ and $.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, I've made the whole test regexes more restrictive. Mind having another look at that part?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The regex is good 👍

rf" \(1,\)\s+\| {SOME_FLOAT} \| {SOME_FLOAT} ± {SOME_FLOAT}...",
"",
rf"\s*...Full output truncated \({SOME_INT} lines hidden\), use '-vv' to show",
],
Expand All @@ -294,6 +306,7 @@ def test_error_messages_with_different_verbosity(self, assert_approx_raises_rege
a,
b,
[
r" ",
r" comparison failed. Mismatched elements: 20 / 20:",
rf" Max absolute difference: {SOME_FLOAT}",
rf" Max relative difference: {SOME_FLOAT}",
Expand Down Expand Up @@ -652,6 +665,7 @@ def test_dict_for_div_by_zero(self, assert_approx_raises_regex):
{"foo": 42.0},
{"foo": 0.0},
[
r"",
r" comparison failed. Mismatched elements: 1 / 1:",
rf" Max absolute difference: {SOME_FLOAT}",
r" Max relative difference: inf",
Expand Down
Loading