diff options
| -rw-r--r-- | .pyenchant_pylint_custom_dict.txt | 1 | ||||
| -rw-r--r-- | doc/whatsnew/fragments/3822.false_positive | 3 | ||||
| -rw-r--r-- | pylint/checkers/format.py | 30 | ||||
| -rw-r--r-- | tests/functional/t/trailing_whitespaces.py | 21 |
4 files changed, 39 insertions, 16 deletions
diff --git a/.pyenchant_pylint_custom_dict.txt b/.pyenchant_pylint_custom_dict.txt index f37c3ad63..a17cb040f 100644 --- a/.pyenchant_pylint_custom_dict.txt +++ b/.pyenchant_pylint_custom_dict.txt @@ -357,6 +357,7 @@ vcg's vectorisation virtualized wc +whitespaces xfails xml xyz diff --git a/doc/whatsnew/fragments/3822.false_positive b/doc/whatsnew/fragments/3822.false_positive new file mode 100644 index 000000000..00a2143cf --- /dev/null +++ b/doc/whatsnew/fragments/3822.false_positive @@ -0,0 +1,3 @@ +``trailing-whitespaces`` is no longer reported within strings. + +Closes #3822 diff --git a/pylint/checkers/format.py b/pylint/checkers/format.py index 5d9a854b9..d33def5b5 100644 --- a/pylint/checkers/format.py +++ b/pylint/checkers/format.py @@ -273,7 +273,7 @@ class FormatChecker(BaseTokenChecker, BaseRawFileChecker): line = tokens.line(line_start) if tokens.type(line_start) not in _JUNK_TOKENS: self._lines[line_num] = line.split("\n")[0] - self.check_lines(line, line_num) + self.check_lines(tokens, line_start, line, line_num) def process_module(self, node: nodes.Module) -> None: pass @@ -404,12 +404,6 @@ class FormatChecker(BaseTokenChecker, BaseRawFileChecker): # the full line; therefore we check the next token on the line. if tok_type == tokenize.INDENT: self.new_line(TokenWrapper(tokens), idx - 1, idx + 1) - # A tokenizer oddity: if a line contains a multi-line string, - # the NEWLINE also gets its own token which we already checked in - # the multi-line docstring case. - # See https://github.com/PyCQA/pylint/issues/6936 - elif tok_type == tokenize.NEWLINE: - pass else: self.new_line(TokenWrapper(tokens), idx - 1, idx) @@ -580,13 +574,8 @@ class FormatChecker(BaseTokenChecker, BaseRawFileChecker): self.add_message("multiple-statements", node=node) self._visited_lines[line] = 2 - def check_line_ending(self, line: str, i: int) -> None: - """Check that the final newline is not missing and that there is no trailing - white-space. - """ - if not line.endswith("\n"): - self.add_message("missing-final-newline", line=i) - return + def check_trailing_whitespace_ending(self, line: str, i: int) -> None: + """Check that there is no trailing white-space.""" # exclude \f (formfeed) from the rstrip stripped_line = line.rstrip("\t\n\r\v ") if line[len(stripped_line) :] not in ("\n", "\r\n"): @@ -655,7 +644,9 @@ class FormatChecker(BaseTokenChecker, BaseRawFileChecker): buffer += atomic_line return res - def check_lines(self, lines: str, lineno: int) -> None: + def check_lines( + self, tokens: TokenWrapper, line_start: int, lines: str, lineno: int + ) -> None: """Check given lines for potential messages. Check if lines have: @@ -676,7 +667,14 @@ class FormatChecker(BaseTokenChecker, BaseRawFileChecker): split_lines = self.specific_splitlines(lines) for offset, line in enumerate(split_lines): - self.check_line_ending(line, lineno + offset) + if not line.endswith("\n"): + self.add_message("missing-final-newline", line=lineno + offset) + continue + # We don't test for trailing whitespaces in strings + # See https://github.com/PyCQA/pylint/issues/6936 + # and https://github.com/PyCQA/pylint/issues/3822 + if tokens.type(line_start) != tokenize.STRING: + self.check_trailing_whitespace_ending(line, lineno + offset) # hold onto the initial lineno for later potential_line_length_warning = False diff --git a/tests/functional/t/trailing_whitespaces.py b/tests/functional/t/trailing_whitespaces.py index cb9d642ee..c88b7ea62 100644 --- a/tests/functional/t/trailing_whitespaces.py +++ b/tests/functional/t/trailing_whitespaces.py @@ -18,3 +18,24 @@ print('but trailing whitespace on win is not') """ This module has the Board class. It's a very nice Board. """ + +# Regression test for https://github.com/PyCQA/pylint/issues/3822 +def example(*args): + """Example function.""" + print(*args) + + +example( + "bob", """ + foobar + more text +""", +) + +example( + "bob", + """ + foobar2 + more text +""", +) |