Skip to content

Commit

Permalink
Possible fix for issue with indentation and fmt: skip (#2281)
Browse files Browse the repository at this point in the history
Not sure the fix is right.  Here is what I found: issue is connected
with line

    first.prefix = prefix[comment.consumed :]

in `comments.py`.  `first.prefix` is a prefix of the line, that ends
with `# fmt: skip`, but `comment.consumed` is the length of the
`"  # fmt: skip"` string.  If prefix length is greater than 14,
`first.prefix` will grow every time we apply formatting.

Fixes #2254
  • Loading branch information
enzet committed Jun 8, 2021
1 parent c1c2418 commit 40fae18
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 1 deletion.
1 change: 1 addition & 0 deletions CHANGES.md
Expand Up @@ -4,6 +4,7 @@

### _Black_

- Fix failure caused by `fmt: skip` and indentation (#2281)
- Account for += assignment when deciding whether to split string (#2312)
- Correct max string length calculation when there are string operators (#2292)
- Fixed option usage when using the `--code` flag (#2259)
Expand Down
5 changes: 4 additions & 1 deletion src/black/comments.py
Expand Up @@ -159,7 +159,10 @@ def convert_one_fmt_off_pair(node: Node) -> bool:
first = ignored_nodes[0] # Can be a container node with the `leaf`.
parent = first.parent
prefix = first.prefix
first.prefix = prefix[comment.consumed :]
if comment.value in FMT_OFF:
first.prefix = prefix[comment.consumed :]
if comment.value in FMT_SKIP:
first.prefix = ""
hidden_value = "".join(str(n) for n in ignored_nodes)
if comment.value in FMT_OFF:
hidden_value = comment.value + "\n" + hidden_value
Expand Down
13 changes: 13 additions & 0 deletions tests/data/fmtskip6.py
@@ -0,0 +1,13 @@
class A:
def f(self):
for line in range(10):
if True:
pass # fmt: skip

# output

class A:
def f(self):
for line in range(10):
if True:
pass # fmt: skip
1 change: 1 addition & 0 deletions tests/test_format.py
Expand Up @@ -41,6 +41,7 @@
"fmtskip3",
"fmtskip4",
"fmtskip5",
"fmtskip6",
"fstring",
"function",
"function2",
Expand Down

0 comments on commit 40fae18

Please sign in to comment.