Separate StringNormalizer from StringPart
#9954
Merged
Conversation
This file contains 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
MichaReiser
reviewed
Feb 12, 2024
There was a problem hiding this comment.
Could you add an explanation to your PR explaining what motivates extracting the normalisation. E.g., what's difficult with the current design?I read that you want to use StringPart without the normalization. I understand this is possible today, for as long as you don't call part.normalze?
55195fd to
8627f40
Compare
|
d3402d7 to
a431f6a
Compare
MichaReiser
approved these changes
Feb 13, 2024
a431f6a to
334616d
Compare
nkxxll
pushed a commit
to nkxxll/ruff
that referenced
this pull request
Mar 10, 2024
## Summary
This PR is a small refactor to extract out the logic for normalizing
string in the formatter from the `StringPart` struct. It also separates
the quote selection into a separate method on the new
`StringNormalizer`. Both of these will help in the f-string formatting
to use `StringPart` and `choose_quotes` irrespective of normalization.
The reason for having separate quote selection and normalization step is
so that the f-string formatting can perform quote selection on its own.
Unlike string and byte literals, the f-string formatting would require
that the normalization happens only for the literal elements of it i.e.,
the "foo" and "bar" in `f"foo {x + y} bar"`. This will automatically be
handled by the already separate `normalize_string` function.
Another use-case in the f-string formatting is to extract out the
relevant information from the `StringPart` like quotes and prefix which
is to be passed as context while formatting each element of an f-string.
## Test Plan
Ensure that clippy is happy and all tests pass.
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 PR is a small refactor to extract out the logic for normalizing string in the formatter from the
StringPartstruct. It also separates the quote selection into a separate method on the newStringNormalizer. Both of these will help in the f-string formatting to useStringPartandchoose_quotesirrespective of normalization.The reason for having separate quote selection and normalization step is so that the f-string formatting can perform quote selection on its own.
Unlike string and byte literals, the f-string formatting would require that the normalization happens only for the literal elements of it i.e., the "foo" and "bar" in
f"foo {x + y} bar". This will automatically be handled by the already separatenormalize_stringfunction.Another use-case in the f-string formatting is to extract out the relevant information from the
StringPartlike quotes and prefix which is to be passed as context while formatting each element of an f-string.Test Plan
Ensure that clippy is happy and all tests pass.