Add insert_pytest_raises()

[zmievsa]

Every time I used insert_assert I was ecstatic with my new productivity but something was missing: it was always painful to catch and match exceptions. Only recently have I realized that same tooling and approach could be used to solve that problem as well.

Note that this is only a working prototype without tests or proper structure/naming.

If you like the idea -- I'll be happy to provide the rest :)

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.12%. Comparing base (1172e81) to head (0a8ac24).
⚠️ Report is 11 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #131      +/-   ##
==========================================
+ Coverage   96.27%   97.12%   +0.85%     
==========================================
  Files           8        8              
  Lines         725      766      +41     
  Branches      110      121      +11     
==========================================
+ Hits          698      744      +46     
+ Misses         21       17       -4     
+ Partials        6        5       -1     

Files with missing lines	Coverage Δ
devtools/pytest_plugin.py	92.52% <100.00%> (+4.38%)	⬆️

... and 1 file with indirect coverage changes

---

Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1172e81...0a8ac24. Read the comment docs.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[samuelcolvin]

thanks so much for the PR. I think I like it, please could you explain exactly how it works?

[zmievsa]

@samuelcolvin

The mechanism is exactly the same as in insert_assert, except that it's a context manager that catches the error and then replaces itself with a pytest.raises that captures the main error details. re.escape is used because pytest.raises checks using regexes by default so we avoid "invalid regex" errors using re.escape. I have been using it ever since I made this pull request and loved every second of it: it amazingly complements insert_assert. I'd like to write sections on it and on insert_assert in README/docs of this repo as I think that more people should know about these tools. But let's do it in a separate PR.

Demonstration

Before running the test:

After running the test:

I am not a huge fan of my naming but I can't come up with a better name for this function.
I am happy that you like the idea. I'll write the tests and comments now so that it's closer to being ready to be merged.

Update

Added tests. Mostly just copying the insert_assert tests

[zmievsa]

@samuelcolvin A gentle reminder to review this feature whenever you have a minute

[samuelcolvin]

Thank you, sorry for the long delay. The pytest plugin (and insert_assert) was removed in #174 in favour of inline-snapshot, which covers this use case, so closing.