[ruff] re and regex calls with unraw string as first argument (RUF039)#14446
Merged
MichaReiser merged 11 commits intoastral-sh:mainfrom Nov 19, 2024
Merged
[ruff] re and regex calls with unraw string as first argument (RUF039)#14446MichaReiser merged 11 commits intoastral-sh:mainfrom
ruff] re and regex calls with unraw string as first argument (RUF039)#14446MichaReiser merged 11 commits intoastral-sh:mainfrom
Conversation
Contributor
|
| code | total | + violation | - violation | + fix | - fix |
|---|---|---|---|---|---|
| RUF039 | 199 | 199 | 0 | 0 | 0 |
MichaReiser
reviewed
Nov 19, 2024
Member
There was a problem hiding this comment.
Thanks. This overall looks good. I'm interested in your and @AlexWaygood's opinion on flagging non-raw strings for all regex patterns or if we should make the rule slightly more clever, e.g. by allowing regex patterns containing an escape sequence that can't be written as a raw string (e.g. \n)
MichaReiser
added
rule
Contributor
Author
|
I think this should be a blanket enforcement. # It's too easy to use a normal string as the pattern...
re.compile('uv') # `uv` anywhere (`uv`, `uvicorn`, `dhruv`, `juvenile`, etc.)
# ...then forget to switch to a raw string when the pattern changes.
re.compile('\buv\b') # `uv` not within a word? |
Member
|
I don't disagree with this overall, but it does mean that it gives you false positives for e.g. |
Member
|
So maybe that's specific to escape sequences. Python regex support all other common escape sequences (with the exception of |
Member
|
Oh,
|
MichaReiser
approved these changes
Nov 19, 2024
AlexWaygood
reviewed
Nov 19, 2024
Member
|
I haven't studied this in depth, but it overall seems reasonable to me, both in concept and implementation. I wondered if we needed to take account of this footgun to do with raw strings (they cannot end with an odd number of backslashes). But I think we should be fine, since that documentation states:
|
InSyncWithFoo
changed the title
ruff] re and regex calls with unraw string as first argument (RUF051)ruff] re and regex calls with unraw string as first argument (RUF039)
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
Resolves #11167.
Test Plan
cargo nextest runandcargo insta test.