mirror of https://github.com/astral-sh/ruff.git synced 2025-10-19 23:07:19 +00:00

History

Brent Westbrook 0115fd3757 Some checks are pending CI / cargo test (linux, release) (push) Blocked by required conditions Details CI / Determine changes (push) Waiting to run Details CI / cargo fmt (push) Waiting to run Details CI / cargo clippy (push) Blocked by required conditions Details CI / cargo test (linux) (push) Blocked by required conditions Details CI / cargo test (windows) (push) Blocked by required conditions Details CI / cargo test (macos) (push) Blocked by required conditions Details CI / cargo test (wasm) (push) Blocked by required conditions Details CI / cargo build (msrv) (push) Blocked by required conditions Details CI / cargo fuzz build (push) Blocked by required conditions Details CI / fuzz parser (push) Blocked by required conditions Details CI / test scripts (push) Blocked by required conditions Details CI / ecosystem (push) Blocked by required conditions Details CI / Fuzz for new ty panics (push) Blocked by required conditions Details CI / cargo shear (push) Blocked by required conditions Details CI / ty completion evaluation (push) Blocked by required conditions Details CI / python package (push) Waiting to run Details CI / pre-commit (push) Waiting to run Details CI / mkdocs (push) Waiting to run Details CI / formatter instabilities and black similarity (push) Blocked by required conditions Details CI / test ruff-lsp (push) Blocked by required conditions Details CI / check playground (push) Blocked by required conditions Details CI / benchmarks instrumented (ruff) (push) Blocked by required conditions Details CI / benchmarks instrumented (ty) (push) Blocked by required conditions Details CI / benchmarks walltime (medium\|multithreaded) (push) Blocked by required conditions Details CI / benchmarks walltime (small\|large) (push) Blocked by required conditions Details [ty Playground] Release / publish (push) Waiting to run Details Avoid reusing nested, interpolated quotes before Python 3.12 (#20930 ) ## Summary Fixes #20774 by tracking whether an `InterpolatedStringState` element is nested inside of another interpolated element. This feels like kind of a naive fix, so I'm welcome to other ideas. But it resolves the problem in the issue and clears up the syntax error in the black compatibility test, without affecting many other cases. The other affected case is actually interesting too because the [input](`96b156303b/crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/fstring.py (L707)`) is invalid, but the previous quote selection fixed the invalid syntax: ```pycon Python 3.11.13 (main, Sep 2 2025, 14:20:25) [Clang 20.1.4 ] on linux Type "help", "copyright", "credits" or "license" for more information. >>> f'{1: abcd "{'aa'}" }' # input File "<stdin>", line 1 f'{1: abcd "{'aa'}" }' ^^ SyntaxError: f-string: expecting '}' >>> f'{1: abcd "{"aa"}" }' # old output Traceback (most recent call last): File "<stdin>", line 1, in <module> ValueError: Invalid format specifier ' abcd "aa" ' for object of type 'int' >>> f'{1: abcd "{'aa'}" }' # new output File "<stdin>", line 1 f'{1: abcd "{'aa'}" }' ^^ SyntaxError: f-string: expecting '}' ``` We now preserve the invalid syntax in the input. Unfortunately, this also seems to be another edge case I didn't consider in https://github.com/astral-sh/ruff/pull/20867 because we don't flag this as a syntax error after 0.14.1: <details><summary>Shell output</summary> <p> ``` > uvx ruff@0.14.0 check --ignore ALL --target-version py311 - <<EOF f'{1: abcd "{'aa'}" }' EOF invalid-syntax: Cannot reuse outer quote character in f-strings on Python 3.11 (syntax was added in Python 3.12) --> -:1:14 \| 1 \| f'{1: abcd "{'aa'}" }' \| ^ \| Found 1 error. > uvx ruff@0.14.1 check --ignore ALL --target-version py311 - <<EOF f'{1: abcd "{'aa'}" }' EOF All checks passed! > uvx python@3.11 -m ast <<EOF f'{1: abcd "{'aa'}" }' EOF Traceback (most recent call last): File "<frozen runpy>", line 198, in _run_module_as_main File "<frozen runpy>", line 88, in _run_code File "/home/brent/.local/share/uv/python/cpython-3.11.13-linux-x86_64-gnu/lib/python3.11/ast.py", line 1752, in <module> main() File "/home/brent/.local/share/uv/python/cpython-3.11.13-linux-x86_64-gnu/lib/python3.11/ast.py", line 1748, in main tree = parse(source, args.infile.name, args.mode, type_comments=args.no_type_comments) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/home/brent/.local/share/uv/python/cpython-3.11.13-linux-x86_64-gnu/lib/python3.11/ast.py", line 50, in parse return compile(source, filename, mode, flags, ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "<stdin>", line 1 f'{1: abcd "{'aa'}" }' ^^ SyntaxError: f-string: expecting '}' ``` </p> </details> I assumed that was the same `ParseError` as the one caused by `f"{1:""}"`, but this is a nested interpolation inside of the format spec. ## Test Plan New test copied from the black compatibility test. I guess this is a duplicate now, I started working on this branch before the new black tests were imported, so I could delete the separate test in our fixtures if that's preferable.		2025-10-17 08:49:16 -04:00
..
resources/test/fixtures	Avoid reusing nested, interpolated quotes before Python 3.12 (#20930 )	2025-10-17 08:49:16 -04:00
src	Avoid reusing nested, interpolated quotes before Python 3.12 (#20930 )	2025-10-17 08:49:16 -04:00
tests	Avoid reusing nested, interpolated quotes before Python 3.12 (#20930 )	2025-10-17 08:49:16 -04:00
Cargo.toml	[red-knot] Add 'Format document' to playground (#17217 )	2025-04-07 09:26:03 +02:00
CONTRIBUTING.md	[ty] AST garbage collection (#18482 )	2025-06-13 08:40:11 -04:00
generate.py	Implement template strings (#17851 )	2025-05-30 15:00:56 -05:00
orphan_rules_in_the_formatter.svg	Generate FormatRule definitions (#4724 )	2023-06-01 08:38:53 +02:00
README.md	Add f-string formatting to the docs (#15367 )	2025-01-09 10:20:06 +01:00

README.md

Ruff Formatter

The Ruff formatter is an extremely fast Python code formatter that ships as part of the ruff CLI.

Goals

The formatter is designed to be a drop-in replacement for Black, but with an excessive focus on performance and direct integration with Ruff.

Specifically, the formatter is intended to emit near-identical output when run over Black-formatted code. When run over extensive Black-formatted projects like Django and Zulip, > 99.9% of lines are formatted identically. When migrating an existing project from Black to Ruff, you should expect to see a few differences on the margins, but the vast majority of your code should be unchanged.

If you identify deviations in your project, spot-check them against the intentional deviations enumerated below, as well as the unintentional deviations filed in the issue tracker. If you've identified a new deviation, please file an issue.

When run over non-Black-formatted code, the formatter makes some different decisions than Black, and so more deviations should be expected, especially around the treatment of end-of-line comments. For details, see Style Guide.

Getting started

Head to The Ruff Formatter for usage instructions and a comparison to Black.