Skip to content
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.

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

SIM108 autofix changes quote style of nested f-string #9660

Open
Gjgarr opened this issue Jan 28, 2024 · 1 comment
Open

SIM108 autofix changes quote style of nested f-string #9660

Gjgarr opened this issue Jan 28, 2024 · 1 comment
Assignees

Comments

@Gjgarr
Copy link

Gjgarr commented Jan 28, 2024

Description

SIM108 auto-fix changes quote style of nested f-string unnecessarily.

Versions

Python version: 3.12
Ruff version: v0.1.14

Reproduce

Playground link: https://play.ruff.rs/1519e519-94fc-412f-abbb-c8c838a698e7

Given the following:

if 1:
    a = f"# {"".join([])}"
else: 
    a = ""

SIM108 autofix converts this to:

a = f"# {''.join([])}" if 1 else ""

Expected:

a = f"# {"".join([])}" if 1 else ""
@AlexWaygood AlexWaygood self-assigned this Jan 28, 2024
@AlexWaygood
Copy link
Member

AlexWaygood commented Jan 28, 2024

This is a symptom of a more general problem with the way our "expression generator" for creating autofixes works — it often doesn't preserve stylistic details such as quoting style etc. (#7799)

However, in this specific case, I think it should be pretty easy to preserve more stylistic details for this rule

@AlexWaygood AlexWaygood removed their assignment Jan 25, 2025
@ntBre ntBre self-assigned this Jan 28, 2025
ntBre added a commit that referenced this issue Jan 29, 2025
## Summary

This is another follow-up to #15726 and #15778, extending the
quote-preserving behavior to f-strings and deleting the now-unused
`Generator::quote` field.

## Details
I also made one unrelated change to `rules/flynt/helpers.rs` to remove a
`to_string` call for making a `Box<str>` and tweaked some arguments to
some of the `Generator::unparse_f_string` methods to make the code
easier to follow, in my opinion. Happy to revert especially the latter
of these if needed.

Unfortunately this still does not fix the issue in #9660, which appears
to be more of an escaping issue than a quote-preservation issue. After
#15726, the result is now `a = f'# {"".join([])}' if 1 else ""` instead
of `a = f"# {''.join([])}" if 1 else ""` (single quotes on the outside
now), but we still don't have the desired behavior of double quotes
everywhere on Python 3.12+. I added a test for this but split it off
into another branch since it ended up being unaddressed here, but my
`dbg!` statements showed the correct preferred quotes going into
[`UnicodeEscape::with_preferred_quote`](https://github.com/astral-sh/ruff/blob/main/crates/ruff_python_literal/src/escape.rs#L54).

## Test Plan

Existing rule and `Generator` tests.

---------

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants