[FURB156] Do not consider docstring(s) #16391
Merged
+50
−1
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 26, 2025
Comment on lines
52
to
56
| if !matches!(checker.semantic().current_statement(), &Stmt::Assign(_)) | ||
| && !matches!(checker.semantic().current_statement(), &Stmt::AugAssign(_)) | ||
| { | ||
| return; | ||
| } |
There was a problem hiding this comment.
I think you can use checker.semantic().in_pep_257_docstring() here instead. This should give us consistent behavior to other rules ignoring docstrings.
There was a problem hiding this comment.
Yes, I was that method. The problems with this method are that
"""01234567"""
"01234567"are not considered as docstrings and marked as violations.
To fix all the issues reported in the issue, I had to use the current condition present in the PR.
But I can change it to if checker.semantic().in_pep_257_docstring() {...} if you want to be consistent between docstrings ;-)
There was a problem hiding this comment.
Actually I double checked and just the second string in my above example will be marked as an error as it is not at the top of the module. So it makes sense to use: in_pep_257_docstring().
I will change
|
MichaReiser
approved these changes
Feb 26, 2025
dcreager
added a commit
that referenced
this pull request
Feb 27, 2025
* main: [red-knot] unify LoopState and saved_break_states (#16406) [`pylint`] Also reports `case np.nan`/`case math.nan` (`PLW0177`) (#16378) [FURB156] Do not consider docstring(s) (#16391) Use `is_none_or` in `stdlib-module-shadowing` (#16402) [red-knot] Upgrade salsa to include `AtomicPtr` perf improvement (#16398) [red-knot] Fix file watching for new non-project files (#16395) document MSRV policy (#16384) [red-knot] fix non-callable reporting for unions (#16387) bump MSRV to 1.83 (#16294) Avoid unnecessary info at non-trace server log level (#16389) Expand `ruff.configuration` to allow inline config (#16296) Start detecting version-related syntax errors in the parser (#16090)
dcreager
added a commit
that referenced
this pull request
Feb 27, 2025
* dcreager/dont-have-a-cow: [red-knot] unify LoopState and saved_break_states (#16406) [`pylint`] Also reports `case np.nan`/`case math.nan` (`PLW0177`) (#16378) [FURB156] Do not consider docstring(s) (#16391) Use `is_none_or` in `stdlib-module-shadowing` (#16402) [red-knot] Upgrade salsa to include `AtomicPtr` perf improvement (#16398) [red-knot] Fix file watching for new non-project files (#16395) document MSRV policy (#16384) [red-knot] fix non-callable reporting for unions (#16387) bump MSRV to 1.83 (#16294) Avoid unnecessary info at non-trace server log level (#16389) Expand `ruff.configuration` to allow inline config (#16296) Start detecting version-related syntax errors in the parser (#16090)
dcreager
added a commit
that referenced
this pull request
Feb 27, 2025
* main: [red-knot] unify LoopState and saved_break_states (#16406) [`pylint`] Also reports `case np.nan`/`case math.nan` (`PLW0177`) (#16378) [FURB156] Do not consider docstring(s) (#16391) Use `is_none_or` in `stdlib-module-shadowing` (#16402) [red-knot] Upgrade salsa to include `AtomicPtr` perf improvement (#16398) [red-knot] Fix file watching for new non-project files (#16395) document MSRV policy (#16384) [red-knot] fix non-callable reporting for unions (#16387) bump MSRV to 1.83 (#16294) Avoid unnecessary info at non-trace server log level (#16389) Expand `ruff.configuration` to allow inline config (#16296) Start detecting version-related syntax errors in the parser (#16090)
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.
The PR solves issue #16351
I wanted to take the definition of docstring from PEP PEP257, but it is quite strict, i.e., docstring are always with triple double quotes.
I relaxed the definition to accomodate also docstring just with double quotes. In this way, the bugs presented in the issue are resolved.
Let me know what you think.
PS: I also mentioned in the description of the rule that the rule doesn't consider docstrings.