Repository navigation
Trailing whitespace changes are made outside of --lines #613
Description
Description
Trailing whitespace is removed from the whole file when attempting to format a subset of a file.
Steps to reproduce
-
pip install yapf==0.23 -
Run the following script:
from yapf.yapflib.yapf_api import FormatCode
source = """\
def with_trailing_whitespace():
pass
def without_trailing_whitespace(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbb):
return aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbb
"""
reformatted_diff, changed = FormatCode(source, lines=[(4, 5)], print_diff=True)
print(reformatted_diff)Expected output
--- <unknown> (original)
+++ <unknown> (reformatted)
@@ -1,5 +1,7 @@
def with_trailing_whitespace():
pass
-def without_trailing_whitespace(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbb):
+
+def without_trailing_whitespace(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,
+ bbbbbbbbbb):
return aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbbActual output
--- <unknown> (original)
+++ <unknown> (reformatted)
@@ -1,5 +1,7 @@
-def with_trailing_whitespace():
- pass
+def with_trailing_whitespace():
+ pass
-def without_trailing_whitespace(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbb):
+
+def without_trailing_whitespace(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,
+ bbbbbbbbbb):
return aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbbb
Activity
braineo commentedon Jan 2, 2019
I also ran into this issue.
wwade commentedon Mar 24, 2020
It appears to be a problem in the
PyTreeVisitorimplmentation. When building theuwlinesfor the file, for examplewith_trailing_whitespace():will lose the trailing whitespace as part of theVisit_suitemethod:Here,
node.children[ 0 ]will have a value of\nand a prefix of the trailing whitespace contents, but those trailing whitespace contents will not be added to the_cur_unwrapped_linebefore finalizing it in_StartNewLine().SkyeNygaard commentedon Nov 4, 2022
This is still an issue and it is preventing me from using yapf on my projects.
limwz01 commentedon Jun 5, 2023
@SkyeNygaard @braineo @dmytrokyrychuk
I've created a fork (PR 1102) that fixes this bug, but it needs extensive testing as making this right is quite difficult. It still wouldn't fix the test case in the initial post, as the whitespace before line 4 will be changed, but at least majority of the issue is fixed.
For convenience, here's the patch: yapf_restrict_lines.diff.txt