Feedback on hugging parentheses with braces and brackets preview style

[dylwil3]

For quite a while, Ruff has offered the following preview style:

--- stable
+++ preview

 def foo_brackets(request):
-    return JsonResponse(
-        {
-            "var_1": foo,
-            "var_2": bar,
-        }
-    )
+    return JsonResponse({
+        "var_1": foo,
+        "var_2": bar,
+    })

We have hesitated to stabilize it because it creates quite a large diff and because it is not stabilized in Black.

The purpose of this discussion is to solicit feedback from the community about this style and whether we should stabilize it. The main questions (which I will put as comments below that you can upvote) are essentially:

1. Do you like this preview style, and would you adopt it in your codebase?
2. Would you not upgrade Ruff if this style were stabilized in the next minor version?

The third possibility is that you like this style but think it has some bugs or needs refinement (perhaps one of these open issues), in which case please comment below!

For reference, here is the original issue and the PR implementing the style.

[dylwil3]

Upvote this comment if you like this preview style and would adopt it in your codebase.

[dylwil3]

Upvote this comment if stabilizing this style would cause you not to upgrade Ruff to the next minor version.

[dylwil3]

The reason for this wording is to gauge whether we should prioritize decoupling the version of the formatter from the version of the linter (which we might like to do in any case - but if the parent comment is heavily upvoted then maybe it is a signal that we would not want to make any movement on stabilizing this preview style until after performing this decoupling).

[tpgillam]

The third possibility is that you like this style but think it has some bugs or needs refinement

I think there is another reasonable position not covered above:

Preferring the currently stable style (*), but also not wanting to miss out on bugfixes and other new features in new versions of ruff. So still upgrading on balance, but perhaps less-than-eagerly.

(*) or maybe just preferring not to change the style, due to large diffs.

[mhicks-cfs]

I have been waiting for this style to stabilize for several years now, and would like to start using it even though it is not yet stable, as it has major readability benefits for some of our code.

Is it possible to ONLY enable this one rule in preview mode?
I tried doing this with https://docs.astral.sh/ruff/preview/#selecting-single-preview-rules but cannot find a specific rule that would enable this in the list: https://docs.astral.sh/ruff/rules/

[mhicks-cfs]

Unfortunately I don't want to introduce the instability of using all preview formatting, that is not an acceptable tradeoff for my use case.

One of the reasons I moved off Black is that this preview formatting option had existed for years without stabilizing, it is unfortunate to see that Black is preventing this from stabilizing elsewhere as well.

[ntBre]

I don't think Black's decision prevented us from stabilizing this. Instead, we were concerned by the very large ecosystem impact in #22737 (comment) relative to other preview styles. This prompted us to gather more feedback before pushing for stabilization.

[mhicks-cfs]

I would encourage you to not let preview styles linger for this long in the future, they should be stabilized or abandoned, dragging changes out over multiple years makes these changes more difficult, not less.

[Avasam]

Imo large diffs should be a non-issue. https://git-scm.com/docs/git-blame#Documentation/git-blame.txt---ignore-revs-filefile exists for such purposes and should be best practice for format-only commits. Formatting PRs themselves should be easy to review if you trust the contributor to have made no manual change outside bumping ruff.

tl;dr:

1. Create a .git-blame-ignore-revs file in your repo, list commits that are formatting-only (example: https://github.com/mhammond/pywin32/blob/main/.git-blame-ignore-revs)
2. Run git config blame.ignoreRevsFile .git-blame-ignore-revs
3. In VSCode, if using the gitlens extension for inline blame, you can add in .vscode/settings.json:

  // In case the dev never ran `git config --local blame.ignoreRevsFile .git-blame-ignore-revs`
  "gitlens.advanced.blame.customArguments": [
    "--ignore-revs-file",
    ".git-blame-ignore-revs",
  ],

[mhicks-cfs]

Agree @Avasam, this method mitigates much of the argument against "large diffs" with only format-only commits.

[falkben]

If this rule were stabilized, it's not going to prevent me upgrading ruff, but I do find this new preview rule less readable as it makes it harder for me to see the data structure within the parentheses.