Skip to content

Switch db to ruff_annotate_snippets' suggestions #27576

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

Draft
epage wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Switch db to ruff_annotate_snippets' suggestions #27576

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ab68bd
fix(db): Switch to annotate-snippets suggestions
epage Jul 31, 2026
f834dfc
WIP
epage Aug 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 0 additions & 1 deletion Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

242 changes: 119 additions & 123 deletions crates/ruff/tests/cli/format.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,18 +56,16 @@ fn default_files() -> Result<()> {
exit_code: 1
----- stdout -----
unformatted: File would be reformatted
--> bar.py:1:7
|
- bar = "needs formatting"
1 + bar = "needs formatting"
|
--> bar.py:1:7
|
1 | bar = "needs formatting"
| ~~~~~~~~~~~~~~~~~~

Comment on lines -59 to 63

@epage epage Aug 7, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

~ is the symbol for "added and removed". In unicode, it uses ±. I could hack that in our "ascii" renderer since it is already a hybrid unicode/ascii renderer until we get proper unicode support

@epage epage Aug 8, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

However, I think in this particular use of ± is a mistake. annotate-snippets assumes that suggestions are in context of an existing snippet. When making formatting changes like this, the suggestion is the annotation and i should never be rendered with ±, only + or full diffs.

unformatted: File would be reformatted
--> foo.py:1:7
|
- foo = "needs formatting"
1 + foo = "needs formatting"
|
--> foo.py:1:7
|
1 | foo = "needs formatting"
| ~~~~~~~~~~~~~~~~~~

2 files would be reformatted

Expand Down Expand Up @@ -466,20 +464,20 @@ OTHER = "OTHER"
exit_code: 1
----- stdout -----
unformatted: File would be reformatted
--> main.py:1:1
|
-
1 | from test import say_hy
|
--> main.py:1:1
|
1 | from test import say_hy
2 |
3 | if __name__ == "__main__":
4 | say_hy("dear Ruff contributor")
|

unformatted: File would be reformatted
--> test.py:1:1
|
-
1 | def say_hy(name: str):
- print(f"Hy {name}")
2 + print(f"Hy {name}")
|
--> test.py:1:1
|
1 + def say_hy(name: str):
2 + print(f"Hy {name}")
|

2 files would be reformatted

Expand Down Expand Up @@ -520,11 +518,10 @@ exclude = ["format_excluded.py"]
exit_code: 1
----- stdout -----
unformatted: File would be reformatted
--> main.py:1:3
|
- x = 1
1 + x = 1
|
--> main.py:1:3
|
1 | x = 1
| ~~~

1 file would be reformatted

Expand All @@ -548,11 +545,10 @@ fn deduplicate_directory_and_explicit_file() -> Result<()> {
exit_code: 1
----- stdout -----
unformatted: File would be reformatted
--> main.py:1:3
|
- x = 1
1 + x = 1
|
--> main.py:1:3
|
1 | x = 1
|

1 file would be reformatted

Expand Down Expand Up @@ -607,21 +603,23 @@ if __name__ == "__main__":
assert_cmd_snapshot!(test.format_command()
.arg("--isolated")
.arg("--check")
.arg("main.py"), @"
.arg("main.py"), @r#"
success: false
exit_code: 1
----- stdout -----
unformatted: File would be reformatted
--> main.py:1:1
|
-
1 | from test import say_hy
|
--> main.py:1:1
|
1 | from test import say_hy
2 |
3 | if __name__ == "__main__":
4 | say_hy("dear Ruff contributor")
|

1 file would be reformatted

----- stderr -----
");
"#);

assert_cmd_snapshot!(test.format_command()
.arg("--isolated")
Expand Down Expand Up @@ -699,35 +697,36 @@ fn output_format_notebook() -> Result<()> {
exit_code: 1
----- stdout -----
unformatted: File would be reformatted
--> CRATE_ROOT/resources/test/fixtures/unformatted.ipynb:cell 1:2:1
::: cell 1
|
1 | import numpy
- maths = (numpy.arange(100)**2).sum()
- stats= numpy.asarray([1,2,3,4]).median()
2 +
3 + maths = (numpy.arange(100) ** 2).sum()
4 + stats = numpy.asarray([1, 2, 3, 4]).median()
|
::: cell 3
|
3 | pass
4 +
5 +
6 | %matplotlib inline
|
::: cell 4
|
1 | foo = %pwd
- def some_function(foo,bar,):
2 +
3 +
4 + def some_function(
5 + foo,
6 + bar,
7 + ):
8 | # Another cell with IPython escape command
|
--> CRATE_ROOT/resources/test/fixtures/unformatted.ipynb:cell 1:2:1
::: cell 1:0:1
|
0 + import numpy
1 +
2 + maths = (numpy.arange(100) ** 2).sum()
3 + stats = numpy.asarray([1, 2, 3, 4]).median()
|
::: cell 3:3:1
|
0 | # A cell with IPython escape command
1 | def some_function(foo, bar):
2 | pass
3 +
4 +
5 | %matplotlib inline
|
::: cell 4:0:1
|
0 + foo = %pwd
1 +
2 +
3 + def some_function(
4 + foo,
5 + bar,
6 + ):
7 + # Another cell with IPython escape command
8 + foo = %pwd
9 + print(foo)
|

1 file would be reformatted

Expand Down Expand Up @@ -834,13 +833,11 @@ fn check_quiet_mode_shows_diagnostics_only() -> Result<()> {
exit_code: 1
----- stdout -----
unformatted: File would be reformatted
--> main.py:1:5
|
- def foo():
- pass
1 + def foo():
2 + pass
|
--> main.py:1:5
|
1 ~ def foo():
2 | pass
|


----- stderr -----
Expand All @@ -858,13 +855,11 @@ fn check_default_mode_shows_diagnostics_and_summary() -> Result<()> {
exit_code: 1
----- stdout -----
unformatted: File would be reformatted
--> main.py:1:5
|
- def foo():
- pass
1 + def foo():
2 + pass
|
--> main.py:1:5
|
1 ~ def foo():
2 | pass
|

1 file would be reformatted

Expand Down Expand Up @@ -918,21 +913,23 @@ OTHER = "OTHER"
// Explicitly pass test.py, should not be formatted because of --force-exclude
.arg("test.py")
// Format all other files in the directory, should respect the `exclude` and `format.exclude` options
.arg("."), @"
.arg("."), @r#"
success: false
exit_code: 1
----- stdout -----
unformatted: File would be reformatted
--> main.py:1:1
|
-
1 | from test import say_hy
|
--> main.py:1:1
|
1 | from test import say_hy
2 |
3 | if __name__ == "__main__":
4 | say_hy("dear Ruff contributor")
|

1 file would be reformatted

----- stderr -----
");
"#);
Ok(())
}

Expand Down Expand Up @@ -2555,27 +2552,25 @@ fn markdown_formatting() -> Result<()> {
exit_code: 1
----- stdout -----
unformatted: File would be reformatted
--> CRATE_ROOT/resources/test/fixtures/unformatted.md:4:7
|
3 | ```py
- print( "hello" )
- def foo(): pass
4 + print("hello")
5 +
6 +
7 + def foo():
8 + pass
9 | ```
10 |
11 | ```pyi
- print( "hello" )
- def foo(): pass
12 + print("hello")
13 +
14 + def foo():
15 + pass
16 | ```
|
--> CRATE_ROOT/resources/test/fixtures/unformatted.md:4:7
|
1 | This is a markdown document with two fenced code blocks:
2 |
3 | ```py
4 ~ print("hello")
5 +
6 +
7 + def foo():
8 + pass
9 + ```
10 +
11 + ```pyi
12 + print("hello")
13 +
14 + def foo():
15 ~ pass
16 | ```
|

1 file would be reformatted

Expand Down Expand Up @@ -2692,21 +2687,22 @@ print( 'hello' )
exit_code: 1
----- stdout -----
unformatted: File would be reformatted
--> test.bar:5:7
|
4 | ```py
- print( 'hello' )
5 + print("hello")
6 | ```
|
--> test.bar:5:7
|
2 | Text string
3 |
4 | ```py
5 ~ print("hello")
6 | ```
|

unformatted: File would be reformatted
--> test.foo:1:1
|
-
- print( 'hello' )
1 + print("hello")
|
--> test.foo:1:1
|
1 -
2 - print( 'hello' )
1 + print("hello")
|

2 files would be reformatted

Expand Down
6 changes: 3 additions & 3 deletions crates/ruff/tests/cli/lint.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4502,7 +4502,7 @@ fn show_fixes_in_full_output_with_preview_enabled() {
| ^^^^
help: Remove unused import: `math`
|
- import math
1 - import math
|

Found 1 error.
Expand Down Expand Up @@ -4566,7 +4566,7 @@ fn rule_panic_mixed_results_full() -> Result<()> {
--> normal.py:1:1

stable-test-rule-safe-fix: [*] Hey this is a stable test rule with a safe fix.
--> normal.py:1:1
--> normal.py:1:1
|
1 + # fix from stable-test-rule-safe-fix
2 | import os
Expand Down Expand Up @@ -5221,7 +5221,7 @@ fn ruff_toml_is_linted() -> Result<()> {
| ^^^^
help: Replace rule code with `unused-import`
|
- lint.select = ["F401"]
1 - lint.select = ["F401"]
1 + lint.select = ["unused-import"]
|

Expand Down
Loading
Loading