Fix a crash when a colon line is marked between `# fmt: off` and `# fmt: on` (#3439)

diff --git a/CHANGES.md b/CHANGES.md
index f6040359623db9401dc29427a3dad9682270b258..1a7c320baf8d79271a208734fad9e2569a746073 100644 (file)
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -10,6 +10,8 @@
 
 <!-- Changes that affect Black's stable style -->
 
 
 <!-- Changes that affect Black's stable style -->
 

+- Fix a crash when a colon line is marked between `# fmt: off` and `# fmt: on` (#3439)
+

 ### Preview style
 
 <!-- Changes that affect Black's preview style -->
 ### Preview style
 
 <!-- Changes that affect Black's preview style -->

diff --git a/src/black/comments.py b/src/black/comments.py
index dce83abf1bbdba33bf8aa2eab9a3462b8c96a054..e733dccd8441198325b3e99061689a6e2f0c0e6c 100644 (file)
--- a/src/black/comments.py
+++ b/src/black/comments.py
@@ -232,7 +232,7 @@ def generate_ignored_nodes(
 
         # fix for fmt: on in children
         if children_contains_fmt_on(container, preview=preview):
 
         # fix for fmt: on in children
         if children_contains_fmt_on(container, preview=preview):

-            for child in container.children:
+            for index, child in enumerate(container.children):

                 if isinstance(child, Leaf) and is_fmt_on(child, preview=preview):
                     if child.type in CLOSING_BRACKETS:
                         # This means `# fmt: on` is placed at a different bracket level
                 if isinstance(child, Leaf) and is_fmt_on(child, preview=preview):
                     if child.type in CLOSING_BRACKETS:
                         # This means `# fmt: on` is placed at a different bracket level


@@ -241,6 +241,16 @@ def generate_ignored_nodes(
                         # The alternative is to fail the formatting.
                         yield child
                     return
                         # The alternative is to fail the formatting.
                         yield child
                     return

+                if (
+                    child.type == token.INDENT
+                    and index < len(container.children) - 1
+                    and children_contains_fmt_on(
+                        container.children[index + 1], preview=preview
+                    )
+                ):
+                    # This means `# fmt: on` is placed right after an indentation
+                    # level, and we shouldn't swallow the previous INDENT token.
+                    return

                 if children_contains_fmt_on(child, preview=preview):
                     return
                 yield child
                 if children_contains_fmt_on(child, preview=preview):
                     return
                 yield child

diff --git a/tests/data/simple_cases/fmtonoff5.py b/tests/data/simple_cases/fmtonoff5.py
index 71b1381ed0dc6d99ce6a4067b44fc88f78e50a73..181151b6bd6114d677b233e363c9606315e877da 100644 (file)
--- a/tests/data/simple_cases/fmtonoff5.py
+++ b/tests/data/simple_cases/fmtonoff5.py
@@ -64,7 +64,7 @@ class A:
         print ( "This will be formatted" )
 
 
         print ( "This will be formatted" )
 
 

-# Regression test for https://github.com/psf/black/issues/2985
+# Regression test for https://github.com/psf/black/issues/2985.

 class Named(t.Protocol):
     # fmt: off
     @property
 class Named(t.Protocol):
     # fmt: off
     @property


@@ -75,6 +75,15 @@ class Factory(t.Protocol):
     # fmt: on
 
 
     # fmt: on
 
 

+# Regression test for https://github.com/psf/black/issues/3436.
+if x:
+    return x
+# fmt: off
+elif   unformatted:
+# fmt: on
+    will_be_formatted  ()
+
+

 # output
 
 
 # output
 
 


@@ -144,7 +153,7 @@ class A:
         print("This will be formatted")
 
 
         print("This will be formatted")
 
 

-# Regression test for https://github.com/psf/black/issues/2985
+# Regression test for https://github.com/psf/black/issues/2985.

 class Named(t.Protocol):
     # fmt: off
     @property
 class Named(t.Protocol):
     # fmt: off
     @property


@@ -156,3 +165,12 @@ class Factory(t.Protocol):
         ...
 
     # fmt: on
         ...
 
     # fmt: on

+
+
+# Regression test for https://github.com/psf/black/issues/3436.
+if x:
+    return x
+# fmt: off
+elif   unformatted:
+    # fmt: on
+    will_be_formatted()