Support files with type comment syntax errors (#3594)

diff --git a/CHANGES.md b/CHANGES.md
index 029d0bcbd3f4edcbb46de9c61a84c1e81a00bd60..f5c039f6509aa05226890f3152ed9babb26dd8bc 100644 (file)
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -38,6 +38,8 @@
 
 <!-- Changes to the parser or to version autodetection -->
 
 
 <!-- Changes to the parser or to version autodetection -->
 

+- Added support for formatting files with invalid type comments (#3594)
+

 ### Performance
 
 <!-- Changes that improve Black's performance. -->
 ### Performance
 
 <!-- Changes that improve Black's performance. -->

diff --git a/src/black/parsing.py b/src/black/parsing.py
index ba474c5e047cabb0776abc139b96b204f3c58e77..eaa3c367e54876982a4b3836ea999fb0ccb5cb65 100644 (file)
--- a/src/black/parsing.py
+++ b/src/black/parsing.py
@@ -148,24 +148,29 @@ def lib2to3_unparse(node: Node) -> str:
 
 
 def parse_single_version(
 
 
 def parse_single_version(

-    src: str, version: Tuple[int, int]
+    src: str, version: Tuple[int, int], *, type_comments: bool

 ) -> Union[ast.AST, ast3.AST]:
     filename = "<unknown>"
     # typed-ast is needed because of feature version limitations in the builtin ast 3.8>
     if sys.version_info >= (3, 8) and version >= (3,):
 ) -> Union[ast.AST, ast3.AST]:
     filename = "<unknown>"
     # typed-ast is needed because of feature version limitations in the builtin ast 3.8>
     if sys.version_info >= (3, 8) and version >= (3,):

-        return ast.parse(src, filename, feature_version=version, type_comments=True)
+        return ast.parse(
+            src, filename, feature_version=version, type_comments=type_comments
+        )

 
     if _IS_PYPY:
         # PyPy 3.7 doesn't support type comment tracking which is not ideal, but there's
         # not much we can do as typed-ast won't work either.
         if sys.version_info >= (3, 8):
 
     if _IS_PYPY:
         # PyPy 3.7 doesn't support type comment tracking which is not ideal, but there's
         # not much we can do as typed-ast won't work either.
         if sys.version_info >= (3, 8):

-            return ast3.parse(src, filename, type_comments=True)
+            return ast3.parse(src, filename, type_comments=type_comments)

         else:
             return ast3.parse(src, filename)
     else:
         else:
             return ast3.parse(src, filename)
     else:

-        # Typed-ast is guaranteed to be used here and automatically tracks type
-        # comments separately.
-        return ast3.parse(src, filename, feature_version=version[1])
+        if type_comments:
+            # Typed-ast is guaranteed to be used here and automatically tracks type
+            # comments separately.
+            return ast3.parse(src, filename, feature_version=version[1])
+        else:
+            return ast.parse(src, filename)

 
 
 def parse_ast(src: str) -> Union[ast.AST, ast3.AST]:
 
 
 def parse_ast(src: str) -> Union[ast.AST, ast3.AST]:


@@ -175,11 +180,18 @@ def parse_ast(src: str) -> Union[ast.AST, ast3.AST]:
     first_error = ""
     for version in sorted(versions, reverse=True):
         try:
     first_error = ""
     for version in sorted(versions, reverse=True):
         try:

-            return parse_single_version(src, version)
+            return parse_single_version(src, version, type_comments=True)

         except SyntaxError as e:
             if not first_error:
                 first_error = str(e)
 
         except SyntaxError as e:
             if not first_error:
                 first_error = str(e)
 

+    # Try to parse without type comments
+    for version in sorted(versions, reverse=True):
+        try:
+            return parse_single_version(src, version, type_comments=False)
+        except SyntaxError:
+            pass
+

     raise SyntaxError(first_error)
 
 
     raise SyntaxError(first_error)
 
 

diff --git a/tests/data/type_comments/type_comment_syntax_error.py b/tests/data/type_comments/type_comment_syntax_error.py
new file mode 100644 (file)
index 0000000..2e5ca2e
--- /dev/null
+++ b/tests/data/type_comments/type_comment_syntax_error.py
@@ -0,0 +1,11 @@
+def foo(
+    # type: Foo
+    x): pass
+
+# output
+
+def foo(
+    # type: Foo
+    x,
+):
+    pass

diff --git a/tests/test_format.py b/tests/test_format.py
index 3a6cbc9e2e936a144b2dc0b478eebffb1ec2a51f..5a7b3bb67627c5f1f8f043174f8abe48e8cd1988 100644 (file)
--- a/tests/test_format.py
+++ b/tests/test_format.py
@@ -196,3 +196,10 @@ def test_power_op_newline() -> None:
     # requires line_length=0
     source, expected = read_data("miscellaneous", "power_op_newline")
     assert_format(source, expected, mode=black.Mode(line_length=0))
     # requires line_length=0
     source, expected = read_data("miscellaneous", "power_op_newline")
     assert_format(source, expected, mode=black.Mode(line_length=0))

+
+
+def test_type_comment_syntax_error() -> None:
+    """Test that black is able to format python code with type comment syntax errors."""
+    source, expected = read_data("type_comments", "type_comment_syntax_error")
+    assert_format(source, expected)
+    black.assert_equivalent(source, expected)