brent/standardize-syntax-error-message - Branch - astral-sh/ruff

Standardize syntax error construction

#20903Merged

Comparing

brent/standardize-syntax-error-message

(

d2e8d76

) with

main

(

9de34e7

)

+7%

Improvements: 1

Untouched: 49

Archived: 2

No successful run was found on main ( fd568f0) during the generation of this report, so 9de34e7 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

Benchmarks

2 archived benchmarks were run. If they were deleted in another branch, consider rebasing to remove them from the report. .

Improved

medium[colour-science]

crates/ruff_benchmark/benches/ty_walltime.rs

+7%

11.2 s10.5 s

Passed

attrs

crates/ruff_benchmark/benches/ty.rs::project::attrs::project

+1%

384.2 ms381.9 ms

linter/all-with-preview-rules[numpy/globals.py]

crates/ruff_benchmark/benches/linter.rs::preview_rules::benchmark_preview_rules

+1%

735.3 µs731.3 µs

hydra-zen

crates/ruff_benchmark/benches/ty.rs::project::hydra::project

+1%

856.3 ms851.8 ms

linter/all-with-preview-rules[numpy/ctypeslib.py]

crates/ruff_benchmark/benches/linter.rs::preview_rules::benchmark_preview_rules

4.6 ms4.6 ms

linter/all-rules[numpy/ctypeslib.py]

crates/ruff_benchmark/benches/linter.rs::all_rules::benchmark_all_rules

3.9 ms3.9 ms

linter/all-rules[numpy/globals.py]

crates/ruff_benchmark/benches/linter.rs::all_rules::benchmark_all_rules

651.1 µs648.6 µs

linter/all-with-preview-rules[unicode/pypinyin.py]

crates/ruff_benchmark/benches/linter.rs::preview_rules::benchmark_preview_rules

1.9 ms1.9 ms

linter/default-rules[unicode/pypinyin.py]

crates/ruff_benchmark/benches/linter.rs::default_rules::benchmark_default_rules

393.3 µs392.3 µs

linter/all-with-preview-rules[pydantic/types.py]

crates/ruff_benchmark/benches/linter.rs::preview_rules::benchmark_preview_rules

8.9 ms8.9 ms

linter/all-rules[unicode/pypinyin.py]

crates/ruff_benchmark/benches/linter.rs::all_rules::benchmark_all_rules

1.7 ms1.7 ms

medium[static-frame]

crates/ruff_benchmark/benches/ty_walltime.rs

8.8 s8.8 s

linter/all-rules[pydantic/types.py]

crates/ruff_benchmark/benches/linter.rs::all_rules::benchmark_all_rules

7.5 ms7.5 ms

ty_check_file[incremental]

crates/ruff_benchmark/benches/ty.rs::check_file::benchmark_incremental

4.4 ms4.4 ms

linter/default-rules[numpy/globals.py]

crates/ruff_benchmark/benches/linter.rs::default_rules::benchmark_default_rules

205.3 µs205 µs

DateType

crates/ruff_benchmark/benches/ty.rs::project::datetype::project

182.5 ms182.3 ms

small[freqtrade]

crates/ruff_benchmark/benches/ty_walltime.rs

4.5 s4.5 s

linter/default-rules[numpy/ctypeslib.py]

crates/ruff_benchmark/benches/linter.rs::default_rules::benchmark_default_rules

991 µs990.2 µs

anyio

crates/ruff_benchmark/benches/ty.rs::project::anyio::project

830.7 ms830.1 ms

linter/default-rules[pydantic/types.py]

crates/ruff_benchmark/benches/linter.rs::default_rules::benchmark_default_rules

2.1 ms2.1 ms

linter/all-with-preview-rules[large/dataset.py]

crates/ruff_benchmark/benches/linter.rs::preview_rules::benchmark_preview_rules

19.6 ms19.6 ms

linter/all-rules[large/dataset.py]

crates/ruff_benchmark/benches/linter.rs::all_rules::benchmark_all_rules

16.3 ms16.3 ms

ty_check_file[cold]

crates/ruff_benchmark/benches/ty.rs::check_file::benchmark_cold

115 ms115 ms

ty_micro[many_enum_members]

crates/ruff_benchmark/benches/ty.rs::micro::benchmark_many_enum_members

88.3 ms88.3 ms

parser[large/dataset.py]

crates/ruff_benchmark/benches/parser.rs::parser::benchmark_parser

4.9 ms4.9 ms

parser[numpy/globals.py]

crates/ruff_benchmark/benches/parser.rs::parser::benchmark_parser

105.2 µs105.2 µs

formatter[unicode/pypinyin.py]

crates/ruff_benchmark/benches/formatter.rs::formatter::benchmark_formatter

652.1 µs652.1 µs

formatter[pydantic/types.py]

crates/ruff_benchmark/benches/formatter.rs::formatter::benchmark_formatter

3.5 ms3.5 ms

formatter[numpy/globals.py]

crates/ruff_benchmark/benches/formatter.rs::formatter::benchmark_formatter

233.9 µs233.9 µs

parser[pydantic/types.py]

crates/ruff_benchmark/benches/parser.rs::parser::benchmark_parser

1.9 ms1.9 ms

lexer[numpy/globals.py]

crates/ruff_benchmark/benches/lexer.rs::lexer::benchmark_lexer

29 µs29 µs

lexer[large/dataset.py]

crates/ruff_benchmark/benches/lexer.rs::lexer::benchmark_lexer

1.1 ms1.1 ms

lexer[pydantic/types.py]

crates/ruff_benchmark/benches/lexer.rs::lexer::benchmark_lexer

486.2 µs486.2 µs

lexer[numpy/ctypeslib.py]

crates/ruff_benchmark/benches/lexer.rs::lexer::benchmark_lexer

217.6 µs217.6 µs

lexer[unicode/pypinyin.py]

crates/ruff_benchmark/benches/lexer.rs::lexer::benchmark_lexer

74.8 µs74.8 µs

formatter[numpy/ctypeslib.py]

crates/ruff_benchmark/benches/formatter.rs::formatter::benchmark_formatter

1.9 ms1.9 ms

small[tanjun]

crates/ruff_benchmark/benches/ty_walltime.rs

1.6 s1.6 s

formatter[large/dataset.py]

crates/ruff_benchmark/benches/formatter.rs::formatter::benchmark_formatter

9.4 ms9.4 ms

parser[numpy/ctypeslib.py]

crates/ruff_benchmark/benches/parser.rs::parser::benchmark_parser

919.6 µs919.6 µs

parser[unicode/pypinyin.py]

crates/ruff_benchmark/benches/parser.rs::parser::benchmark_parser

317.8 µs317.9 µs

ty_micro[many_string_assignments]

crates/ruff_benchmark/benches/ty.rs::micro::benchmark_many_string_assignments

70.2 ms70.2 ms

ty_micro[complex_constrained_attributes_3]

crates/ruff_benchmark/benches/ty.rs::micro::benchmark_complex_constrained_attributes_3

64.8 ms64.8 ms

ty_micro[many_tuple_assignments]

crates/ruff_benchmark/benches/ty.rs::micro::benchmark_tuple_implicit_instance_attributes

61.8 ms61.9 ms

ty_micro[complex_constrained_attributes_2]

crates/ruff_benchmark/benches/ty.rs::micro::benchmark_complex_constrained_attributes_2

61.9 ms62 ms

linter/default-rules[large/dataset.py]

crates/ruff_benchmark/benches/linter.rs::default_rules::benchmark_default_rules

4.2 ms4.2 ms

large[sympy]

crates/ruff_benchmark/benches/ty_walltime.rs

38.9 s39 s

ty_micro[many_tuple_assignments]

crates/ruff_benchmark/benches/ty.rs::micro::benchmark_many_tuple_assignments

60.7 ms60.7 ms

ty_micro[complex_constrained_attributes_1]

crates/ruff_benchmark/benches/ty.rs::micro::benchmark_complex_constrained_attributes_1

62 ms62 ms

medium[pandas]

crates/ruff_benchmark/benches/ty_walltime.rs

31.5 s31.5 s

small[altair]

crates/ruff_benchmark/benches/ty_walltime.rs

-1%

2.4 s2.5 s

Commits

Click on a commit to change the comparison range

Base

main

9de34e7

+6.51%

Standardize syntax error construction Summary -- This PR unifies the two different ways Ruff and ty construct syntax errors. Ruff has been storing the primary message in the diagnostic itself, while ty attached the message to the primary annotation: ``` > ruff check try.py invalid-syntax: name capture `x` makes remaining patterns unreachable --> try.py:2:10 | 1 | match 42: 2 | case x: ... | ^ 3 | case y: ... | Found 1 error. > uvx ty check try.py WARN ty is pre-release software and not ready for production use. Expect to encounter bugs, missing features, and fatal errors. Checking ------------------------------------------------------------ 1/1 files error[invalid-syntax] --> try.py:2:10 | 1 | match 42: 2 | case x: ... | ^ name capture `x` makes remaining patterns unreachable 3 | case y: ... | Found 1 diagnostic ``` I think there are benefits to both approaches, and I do like ty's version, but I feel like we should pick one (and it might help with #20901 eventually). I slightly prefer Ruff's version, so I went with that. Hopefully this isn't too controversial, but I'm happy to close this if it is. Note that this shouldn't change any other diagnostic formats in ty because [`Diagnostic::primary_message`](https://github.com/astral-sh/ruff/blob/98d27c412810e157f8a65ea75726d66676628225/crates/ruff_db/src/diagnostic/mod.rs#L174) was already falling back to the primary annotation message if the diagnostic message was empty. As a result, I think this change will partially resolve the FIXME therein. Test Plan -- Existing tests with updated snapshots

d2e8d76

1 month ago

by ntBre

Home Terms Privacy Docs