Enhance errors for exception/warnings matching #8508

RonnyPfannschmidt · 2021-04-01T23:32:16Z

No description provided.

The-Compiler

Might want to use f-strings instead of str.format everywhere?

The-Compiler

Oh, also, why the extra (unneeded) assert before excinfo.match?

RonnyPfannschmidt · 2021-06-08T05:41:22Z

@The-Compiler interesting, pycharm seems to have added those i didn't even note, going to take them off

nicoddemus

LGTM, thanks!

We might want to add a small changelog entry 8508.improvement.rst:

Improve :func:`pytest.raises` and :func:`pytest.warns` error messages.

bluetech

LGTM, just a (preexisting) grammar fix and a suggestion.

src/_pytest/recwarn.py

bluetech · 2021-06-12T16:16:38Z

src/_pytest/_code/code.py

-            msg += " Did you mean to `re.escape()` the regex?"
-        assert re.search(regexp, str(self.value)), msg.format(regexp, str(self.value))
+        value = str(self.value)
+        msg = f"Regex pattern did not match.\n Regex: {regexp!r}\n Input: {value!r}"


I wonder if it wouldn't be better to use a straight str here instead of repr. With the new line format the quoting doesn't seem needed, perhaps the opposite.

(Either way is fine with me)

i believe for the regex it helps to get the escapes printed more nicely readable, my personal opinion is that repr reads slightly better than just the str or the escape

Just to clarify, this will show as

>>> regexp = r'py\.test' >>> value = 'pytest' >>> msg = f"Regex pattern did not match.\n Regex: {regexp!r}\n Input: {value!r}" >>> print(msg) Regex pattern did not match. Regex: 'py\\.test' Input: 'pytest'

I would have preferred py\.test over py\\.test.

i just experimented with this - if there is a simple way to print "raw" strings, i'll happily use that - however even in the pytest testsuite there is a number of cases that would turn confusing without

if there is a simple way to print "raw" strings, i'll happily use that

That would be {regexp} instead of {regexp!r}, unless I'm misunderstanding.

however even in the pytest testsuite there is a number of cases that would turn confusing without

Can you give an example?

Hmm, I'm somewhat undecided here. I agree the double backslashes are a bit confusing, but at the same time I think it's good to print the repr for the input (considering that it can contain whitespace and such, and seeing that whitespace might be essential to find out why the pattern doesn't match).

But then if we use the repr for the input, it might be more consistent and thus less confusing if we use the repr for the pattern as well.

changelog/8508.improvement.rst

RonnyPfannschmidt · 2021-10-10T17:57:15Z

@The-Compiler @nicoddemus i believe this is complete niw, please have another look

nicoddemus

Looks good, thanks!

src/_pytest/recwarn.py

changelog/8508.improvement.rst

bluetech · 2021-10-11T14:39:25Z

src/_pytest/_code/code.py

-            msg += " Did you mean to `re.escape()` the regex?"
-        assert re.search(regexp, str(self.value)), msg.format(regexp, str(self.value))
+        value = str(self.value)
+        msg = f"Regex pattern did not match.\n Regex: {regexp!r}\n Input: {value!r}"


Just to clarify, this will show as

>>> regexp = r'py\.test' >>> value = 'pytest' >>> msg = f"Regex pattern did not match.\n Regex: {regexp!r}\n Input: {value!r}" >>> print(msg) Regex pattern did not match. Regex: 'py\\.test' Input: 'pytest'

I would have preferred py\.test over py\\.test.

src/_pytest/recwarn.py

bluetech

Couple things I noticed about the warns error message. They are preexisting so not meant to block this PR, just if you feel like it.

testing/test_recwarn.py

* use f-strings more * use pformat to ensure multi line print for longer-warning lists while keeping short ones small

* now multiline and compares regexes * warns on forgotten escaping

The-Compiler

Some nice cleanups and output improvements! I added my $0.02 to a couple of things. Nothing blocking, though.

The-Compiler · 2022-03-07T18:51:07Z

src/_pytest/_code/code.py

-            msg += " Did you mean to `re.escape()` the regex?"
-        assert re.search(regexp, str(self.value)), msg.format(regexp, str(self.value))
+        value = str(self.value)
+        msg = f"Regex pattern did not match.\n Regex: {regexp!r}\n Input: {value!r}"


Hmm, I'm somewhat undecided here. I agree the double backslashes are a bit confusing, but at the same time I think it's good to print the repr for the input (considering that it can contain whitespace and such, and seeing that whitespace might be essential to find out why the pattern doesn't match).

But then if we use the repr for the input, it might be more consistent and thus less confusing if we use the repr for the pattern as well.

src/_pytest/recwarn.py

Co-authored-by: Florian Bruhin <me@the-compiler.org>

RonnyPfannschmidt force-pushed the fixups branch 2 times, most recently from f5f0b12 to 9000f94 Compare June 7, 2021 22:21

RonnyPfannschmidt changed the title ~~wip: enhance errors of some internal utilities~~ enhance errors of some internal utilities Jun 7, 2021

RonnyPfannschmidt requested review from nicoddemus and The-Compiler June 7, 2021 22:22

The-Compiler requested changes Jun 7, 2021

View changes

RonnyPfannschmidt force-pushed the fixups branch 3 times, most recently from f679304 to c7328e5 Compare June 8, 2021 06:32

RonnyPfannschmidt requested a review from The-Compiler June 8, 2021 06:32

nicoddemus approved these changes Jun 12, 2021

View changes

bluetech approved these changes Jun 12, 2021

View changes

RonnyPfannschmidt force-pushed the fixups branch from c7328e5 to 3e6ab2d Compare June 13, 2021 12:23

RonnyPfannschmidt force-pushed the fixups branch from 3e6ab2d to 096c043 Compare October 2, 2021 18:47

RonnyPfannschmidt marked this pull request as draft October 3, 2021 18:29

RonnyPfannschmidt force-pushed the fixups branch 2 times, most recently from 211ea2b to a212945 Compare October 4, 2021 07:30

RonnyPfannschmidt marked this pull request as ready for review October 4, 2021 07:30

RonnyPfannschmidt force-pushed the fixups branch 2 times, most recently from 9d8a0e1 to 7db2330 Compare October 4, 2021 08:22

nicoddemus reviewed Oct 4, 2021

View changes

changelog/8508.improvement.rst Outdated Show resolved Hide resolved

changelog/8508.improvement.rst Outdated Show resolved Hide resolved

RonnyPfannschmidt force-pushed the fixups branch from 7db2330 to 13e52e0 Compare October 10, 2021 14:06

RonnyPfannschmidt mentioned this pull request Oct 10, 2021

deprecate hook configuration via marks/attributes #9118

Merged

RonnyPfannschmidt force-pushed the fixups branch from a47b971 to 62107fb Compare October 10, 2021 14:44

RonnyPfannschmidt changed the title ~~enhance errors of some internal utilities~~ enhance errors for exception/warnings matching Oct 11, 2021

nicoddemus self-requested a review October 11, 2021 12:27

nicoddemus approved these changes Oct 11, 2021

View changes

src/_pytest/recwarn.py Show resolved Hide resolved

bluetech reviewed Oct 11, 2021

View changes

bluetech mentioned this pull request Oct 24, 2021

Deprecate Node constuctor fspath argument, and other small changes/fixes #9232

Merged

bluetech reviewed Oct 24, 2021

View changes

testing/test_recwarn.py Outdated Show resolved Hide resolved

testing/test_recwarn.py Show resolved Hide resolved

RonnyPfannschmidt force-pushed the fixups branch from 62107fb to a6da838 Compare November 16, 2021 14:17

RonnyPfannschmidt force-pushed the fixups branch from c9e312e to 06d2435 Compare December 12, 2021 16:51

RonnyPfannschmidt marked this pull request as draft December 12, 2021 17:00

RonnyPfannschmidt force-pushed the fixups branch from 06d2435 to 53c2331 Compare December 31, 2021 14:11

RonnyPfannschmidt marked this pull request as ready for review December 31, 2021 14:11

RonnyPfannschmidt force-pushed the fixups branch from 53c2331 to 282e030 Compare February 26, 2022 19:42

RonnyPfannschmidt marked this pull request as draft February 27, 2022 07:34

RonnyPfannschmidt added 3 commits March 6, 2022 16:02

recwarn code cleanup and output enhancements

1ddb069

* use f-strings more * use pformat to ensure multi line print for longer-warning lists while keeping short ones small

enhance excinfo.match failure output

f434783

* now multiline and compares regexes * warns on forgotten escaping

changelog

995d833

RonnyPfannschmidt force-pushed the fixups branch from 282e030 to 995d833 Compare March 6, 2022 15:02

RonnyPfannschmidt marked this pull request as ready for review March 6, 2022 15:22

The-Compiler reviewed Mar 7, 2022

View changes

adopt review on compact output

414e18f

Co-authored-by: Florian Bruhin <me@the-compiler.org>

The-Compiler approved these changes Mar 7, 2022

View changes

nicoddemus changed the title ~~enhance errors for exception/warnings matching~~ Enhance errors for exception/warnings matching Mar 21, 2022

nicoddemus merged commit e9dd3df into pytest-dev:main Mar 21, 2022
25 checks passed

Enhance errors for exception/warnings matching #8508

Enhance errors for exception/warnings matching #8508

RonnyPfannschmidt commented Apr 1, 2021

The-Compiler left a comment

The-Compiler left a comment

RonnyPfannschmidt commented Jun 8, 2021

nicoddemus left a comment

bluetech left a comment

bluetech Jun 12, 2021

RonnyPfannschmidt Jun 13, 2021

bluetech Oct 11, 2021

RonnyPfannschmidt Nov 16, 2021

bluetech Dec 8, 2021

The-Compiler Mar 7, 2022

RonnyPfannschmidt commented Oct 10, 2021

nicoddemus left a comment

bluetech Oct 11, 2021

bluetech left a comment

The-Compiler left a comment

The-Compiler Mar 7, 2022

Enhance errors for exception/warnings matching #8508

Enhance errors for exception/warnings matching #8508

Conversation

RonnyPfannschmidt commented Apr 1, 2021

The-Compiler left a comment

Choose a reason for hiding this comment

The-Compiler left a comment

Choose a reason for hiding this comment

RonnyPfannschmidt commented Jun 8, 2021

nicoddemus left a comment

Choose a reason for hiding this comment

bluetech left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RonnyPfannschmidt commented Oct 10, 2021

nicoddemus left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bluetech left a comment

Choose a reason for hiding this comment

The-Compiler left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment