Consider the new f-string tokens for flake8-commas
#8582
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
Author
|
Current dependencies on/for this PR: This stack of pull requests is managed by Graphite. |
dhruvmanila
force-pushed
the
dhruv/fstring-comma
branch
from
781aef7 to
0c12b82
Compare
dhruvmanila
commented
Nov 9, 2023
Comment on lines
-32
to
+35
| struct Token<'tok> { | ||
| type_: TokenType, | ||
| // Underlying token. | ||
| spanned: Option<&'tok Spanned>, | ||
| struct Token { | ||
| r#type: TokenType, | ||
| range: TextRange, |
Member
Author
There was a problem hiding this comment.
The raw token was never used, so let's simplify this a bit.
I've also renamed type_ to r#type. This is just a personal preference and I can revert if the former is better.
Comment on lines
+243
to
+271
| .filter_map(|spanned @ (tok, tok_range)| match tok { | ||
| // Completely ignore comments -- they just interfere with the logic. | ||
| Tok::Comment(_) => None, | ||
| // F-strings are handled as `String` token type with the complete range | ||
| // of the outermost f-string. This means that the expression inside the | ||
| // f-string is not checked for trailing commas. | ||
| Tok::FStringStart => { | ||
| fstrings = fstrings.saturating_add(1); | ||
| None | ||
| } | ||
| Tok::FStringEnd => { | ||
| fstrings = fstrings.saturating_sub(1); | ||
| if fstrings == 0 { | ||
| indexer | ||
| .fstring_ranges() | ||
| .outermost(tok_range.start()) | ||
| .map(|range| Token::new(TokenType::String, range)) | ||
| } else { | ||
| None | ||
| } | ||
| } | ||
| _ => { | ||
| if fstrings == 0 { | ||
| Some(Token::from(spanned)) | ||
| } else { | ||
| None | ||
| } | ||
| } | ||
| }); |
Member
Author
There was a problem hiding this comment.
This is the main change.
Contributor
|
| code | total | + violation | - violation | + fix | - fix |
|---|---|---|---|---|---|
| COM819 | 1 | 0 | 1 | 0 | 0 |
Linter (preview)
ℹ️ ecosystem check detected linter changes. (+0 -1 violations, +0 -0 fixes in 41 projects)
sphinx-doc/sphinx (+0 -1 violations, +0 -0 fixes)
ruff check --no-cache --exit-zero --preview
- sphinx/writers/texinfo.py:433:68: COM819 [*] Trailing comma prohibited
Changes by rule (1 rules affected)
| code | total | + violation | - violation | + fix | - fix |
|---|---|---|---|---|---|
| COM819 | 1 | 0 | 1 | 0 | 0 |
dhruvmanila
commented
Nov 9, 2023
Comment on lines
+256
to
+259
| indexer | ||
| .fstring_ranges() | ||
| .outermost(tok_range.start()) | ||
| .map(|range| Token::new(TokenType::String, range)) |
Member
Author
There was a problem hiding this comment.
We're getting the range on FStringEnd, so the None case isn't possible.
Member
Author
|
The ecosystem change is the fact that we've stopped checking for trailing comma within the expression part of f-strings. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This fixes the bug where the
flake8-commasrules weren't taking the new f-string tokens into account.Test Plan
Add new test cases around f-strings for all of
flake8-commas's rules.fixes: #8556