add support for printing the diff of AST trees when running tests #3902
Conversation
JelleZijlstra
added
the
skip news
|
This is a good, idea, thanks! The full AST is indeed insanely long. A few thoughts:
|
I just realized, this would be much easier to use if added as a CLI option in
yeah, let's rename them at the same time. |
…t variable to a pytest option, add test and update old test to work with patching, remove py37 from tox default envlist
tests/util.py
Outdated
| ast_print = not os.environ.get("SKIP_AST_PRINT") | ||
| ast_print_diff = not os.environ.get("SKIP_AST_PRINT_DIFF") | ||
| if actual != expected and (ast_print or ast_print_diff): | ||
| # need to import inside the function for the monkeypatching tests to work |
There was a problem hiding this comment.
Another approach which should work and I think is cleaner is to do from . import conftest in the global scope, and then use the qualified names like conftest.PRINT_FULL_TREE here.
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
for more information, see https://pre-commit.ci
|
The CI fail seem unrelated to this PR |
Description
As I've been working more on Black, I found the full printing of AST trees to be cumbersome and insanely long, but it regardless often containing necessary info, so I ended up modifying the value of that variable a lot and/or temporarily splitting tests into shorter files. But realized that diff-printing would solve that issue, and while not as simple as I'd initially hoped it wasn't too tricky to work out and is turning out very useful.
Checklist - did you ...
CHANGES.mdif necessary?I don't think changes to test QoL warrants entries in
CHANGES.mdGiven the precedence of
test_assertFormatEqualI should probably write one."SKIP_AST_PRINT"isn't documented anywhere, but it and this should probably be inCONTRIBUTING.mdand/or the contributing documentation on RTD - it took me a while to find myself.