Infer end position for Pylint diagnostics #547
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
Pylint only supplies the start position of markers, but not the end.
Always extending the marker until the end of the line leads to
undesirable highlighting in editors, for example:
```python
def my_func(unused_arg, used_arg):
print(used_arg)
```
Starting an "unused argument" diagnostic at `unused_arg` and extending
It until EOL would also highlight `used_arg`, even though the diagnostic
doesn't apply there.
With this commit, the end position sent to the editor is automatically
determined by looking for an identifier at the indicated start position.
If there is no valid identifier at that position, the entire line is
highlighted as before.
ccordoba12
approved these changes
Aug 22, 2024
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.
Pylint only supplies the start position of markers, but not the end. Always extending the marker until the end of the line leads to undesirable highlighting in editors, for example:
Starting an "unused argument" diagnostic at
unused_argand extending It until EOL would also highlightused_arg, even though the diagnostic doesn't apply there.With this commit, the end position sent to the editor is automatically determined by looking for an identifier at the indicated start position. If there is no valid identifier at that position, the entire line is highlighted as before.
Note that in some cases, Pylint doesn't supply the start position of the token of interest, but instead marks the first non-whitespace character. I noticed this on import statements and except clauses, where the
import(orfrom) and theexceptkeywords then are what gets highlighted, instead of the module or variable in question. However, I think these are only minor issues in comparison to the original issue with the example above.