Add test and basic implementation for formatter preview mode#8044
Add test and basic implementation for formatter preview mode#8044
Conversation
PR Check ResultsEcosystem✅ ecosystem check detected no changes. |
| --- | ||
| source: crates/ruff_python_formatter/tests/fixtures.rs | ||
| input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/assign_breaking.py | ||
| input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/preview.py |
There was a problem hiding this comment.
Should we instead run every test under preview and non-preview?
There was a problem hiding this comment.
If the cost is not too high that seems ideal
There was a problem hiding this comment.
hyperfine "cargo test -p ruff_python_formatter" goes from 500ms to 580ms on my machine, acceptable for me.
Having both versions makes it hard to see what actually changed given our large snapshots, so i opted for instead adding the diff as separate code block if there is one. I also changed all non-function/class tests to use pass instead as real code generally does, which i split out to #8049 to keep the diff readable.
There was a problem hiding this comment.
I would like to keep preview.py as-is though, it's a useful tool for tracking progress and comparing to black (i can diff both snapshots with what the black playground does)
68990b5 to
cf0efb9
Compare
|
Current dependencies on/for this PR:
This comment was auto-generated by Graphite. |
| ) | ||
| .unwrap(); | ||
| // We want to capture the differences in the preview style in our fixtures | ||
| let options_preview = options.with_preview(PreviewMode::Enabled); |
There was a problem hiding this comment.
Should we skip this if options.preview == Enabled when using a test specific options file?
There was a problem hiding this comment.
This is the no-options-file branch; i think it's better to not mix them to avoid combinatorial explosion
| ``` | ||
|
|
||
|
|
||
| ## Preview changes |
There was a problem hiding this comment.
I wonder how noisy this gets once we start having many preview style rules. But let's see how it goes.
Split out of #8044: In preview style, ellipsis are also collapsed in non-stub files. This should only affect function/class contexts since for other statements stub are generally not used. I've updated our tests to use `pass` instead to reflect this, which makes tracking the preview style changes much easier.
cf0efb9 to
f2c60db
Compare
|
@konstin - Is this good to merge? |
f2c60db to
a6ae408
Compare
|
yep |
Summary Prepare for the black preview style becoming the black stable style at the end of the year.
This adds a new test file to compare stable and preview on some relevant preview options in black, and makes
format_devunderstand the black preview flag. I've added poetry as a project that uses preview.I've implemented one specific deviation (collapsing of stub implementation in non-stub files) which showed up in poetry for testing. This also improves poetry compatibility from 0.99891 to 0.99919.
Fixes #7440
New compatibility stats: