Add optional error code

Author: cdce8p

CHANGELOG.md

@@ -32,6 +32,26 @@ necessary.
 Contributed by Marc Mueller (PR [20410](https://github.com/python/mypy/pull/20410))
 and (PR [20405](https://github.com/python/mypy/pull/20405)).
 
+### Added optional error code `type-comment`
+
+A new disabled by default error code `type-comment` was added. If enabled with
+`--enable-error-code type-comment`, mypy will generate errors if legacy type comments instead of
+type annotations are used.
+
+```py
+a = 2  # type: int
+a: int = 2
+
+def func(a, b):
+    # type: (int, str) -> bool
+    ...
+
+def func(a: int, b: str) -> bool:
+    ...
+```
+
+Contributed by Marc Mueller (PR [20616](https://github.com/python/mypy/pull/20616)).
+
 ## Mypy 1.19
 
 We’ve just uploaded mypy 1.19.0 to the Python Package Index ([PyPI](https://pypi.org/project/mypy/)).

docs/source/error_code_list2.rst

@@ -699,3 +699,29 @@ Example:
         @printing_decorator  # E: Untyped decorator makes function "add_forty_two" untyped  [untyped-decorator]
         def add_forty_two(value: int) -> int:
             return value + 42
+
+.. _code-type-comment:
+
+Check that no legacy type comments are used [type-comment]
+----------------------------------------------------------
+
+If enabled with :option:`--enable-error-code type-comment <mypy --enable-error-code>`,
+mypy generates an error if legacy type comments are used. Tools like
+[com2ann](https://github.com/ilevkivskyi/com2ann) can help with translating type comments to
+type annotations.
+
+More information about type comments are available in the
+[typing specification](https://typing.python.org/en/latest/spec/historical.html#type-comments).
+
+Example:
+
+.. code-block:: python
+
+    o = 2  # type: int
+
+    for x, y in points:  # type: float, float
+        ...
+
+    def func(a, b):
+        # type: (str, int) -> bool
+        ...

mypy/errorcodes.py

@@ -280,6 +280,12 @@ def __hash__(self) -> int:
     "Error when a string is used where a TypeForm is expected but a string annotation cannot be recognized",
     "General",
 )
+TYPE_COMMENT: Final = ErrorCode(
+    "type-comment",
+    "Error when legacy type comments are used instead of type annotations",
+    "General",
+    default_enabled=False,
+)
 
 # Syntax errors are often blocking.
 SYNTAX: Final = ErrorCode("syntax", "Report syntax errors", "General")

mypy/fastparse.py

@@ -928,7 +928,7 @@ def do_func_def(
             return_type = None
         elif n.type_comment is not None:
             self.fail(
-                message_registry.TYPE_COMMENT_DEPRECATED, lineno, n.col_offset, blocker=False
+                message_registry.TYPE_COMMENT_SOFT_DEPRECATED, lineno, n.col_offset, blocker=False
             )
             try:
                 func_type_ast = ast3_parse(n.type_comment, "<func_type>", "func_type")
@@ -1143,7 +1143,7 @@ def make_argument(
                 arg_type = TypeConverter(self.errors, line=arg.lineno).visit(annotation)
             elif type_comment is not None:
                 self.fail(
-                    message_registry.TYPE_COMMENT_DEPRECATED,
+                    message_registry.TYPE_COMMENT_SOFT_DEPRECATED,
                     arg.lineno,
                     arg.col_offset,
                     blocker=False,
@@ -1277,7 +1277,10 @@ def visit_Assign(self, n: ast3.Assign) -> AssignmentStmt:
         rvalue = self.visit(n.value)
         if n.type_comment is not None:
             self.fail(
-                message_registry.TYPE_COMMENT_DEPRECATED, n.lineno, n.col_offset, blocker=False
+                message_registry.TYPE_COMMENT_SOFT_DEPRECATED,
+                n.lineno,
+                n.col_offset,
+                blocker=False,
             )
         typ = self.translate_type_comment(n, n.type_comment)
         s = AssignmentStmt(lvalues, rvalue, type=typ, new_syntax=False)
@@ -1308,7 +1311,10 @@ def visit_AugAssign(self, n: ast3.AugAssign) -> OperatorAssignmentStmt:
     def visit_For(self, n: ast3.For) -> ForStmt:
         if n.type_comment is not None:
             self.fail(
-                message_registry.TYPE_COMMENT_DEPRECATED, n.lineno, n.col_offset, blocker=False
+                message_registry.TYPE_COMMENT_SOFT_DEPRECATED,
+                n.lineno,
+                n.col_offset,
+                blocker=False,
             )
         target_type = self.translate_type_comment(n, n.type_comment)
         node = ForStmt(
@@ -1324,7 +1330,10 @@ def visit_For(self, n: ast3.For) -> ForStmt:
     def visit_AsyncFor(self, n: ast3.AsyncFor) -> ForStmt:
         if n.type_comment is not None:
             self.fail(
-                message_registry.TYPE_COMMENT_DEPRECATED, n.lineno, n.col_offset, blocker=False
+                message_registry.TYPE_COMMENT_SOFT_DEPRECATED,
+                n.lineno,
+                n.col_offset,
+                blocker=False,
             )
         target_type = self.translate_type_comment(n, n.type_comment)
         node = ForStmt(
@@ -1355,7 +1364,10 @@ def visit_If(self, n: ast3.If) -> IfStmt:
     def visit_With(self, n: ast3.With) -> WithStmt:
         if n.type_comment is not None:
             self.fail(
-                message_registry.TYPE_COMMENT_DEPRECATED, n.lineno, n.col_offset, blocker=False
+                message_registry.TYPE_COMMENT_SOFT_DEPRECATED,
+                n.lineno,
+                n.col_offset,
+                blocker=False,
             )
         target_type = self.translate_type_comment(n, n.type_comment)
         node = WithStmt(
@@ -1370,7 +1382,10 @@ def visit_With(self, n: ast3.With) -> WithStmt:
     def visit_AsyncWith(self, n: ast3.AsyncWith) -> WithStmt:
         if n.type_comment is not None:
             self.fail(
-                message_registry.TYPE_COMMENT_DEPRECATED, n.lineno, n.col_offset, blocker=False
+                message_registry.TYPE_COMMENT_SOFT_DEPRECATED,
+                n.lineno,
+                n.col_offset,
+                blocker=False,
             )
         target_type = self.translate_type_comment(n, n.type_comment)
         s = WithStmt(

mypy/message_registry.py

@@ -311,8 +311,9 @@ def with_additional_msg(self, info: str) -> ErrorMessage:
 TYPE_COMMENT_SYNTAX_ERROR_VALUE: Final = ErrorMessage(
     'Syntax error in type comment "{}"', codes.SYNTAX
 )
-TYPE_COMMENT_DEPRECATED: Final = ErrorMessage(
-    "Using type comments with mypy is deprecated, use inline annotations instead", codes.MISC
+TYPE_COMMENT_SOFT_DEPRECATED: Final = ErrorMessage(
+    "Using type comments with mypy is (soft-)deprecated, use inline annotations instead",
+    codes.TYPE_COMMENT,
 )
 ELLIPSIS_WITH_OTHER_TYPEPARAMS: Final = ErrorMessage(
     "Ellipses cannot accompany other parameter types in function type signature", codes.SYNTAX

test-data/unit/check-errorcodes.test

@@ -1335,3 +1335,25 @@ def process(response1: int,response2: int) -> int: # E: Overloaded function sign
 
 def process(response1,response2)-> Union[float,int]:
    return response1 + response2
+
+[case testLegacyTypeComments]
+# flags: --enable-error-code type-comment
+a = 2  # type: int  # E: Using type comments with mypy is (soft-)deprecated, use inline annotations instead  [type-comment]
+
+for b in ():  # type: int  # E: Using type comments with mypy is (soft-)deprecated, use inline annotations instead  [type-comment]
+    ...
+
+with f() as foo:  # type: int  # type: ignore[name-defined]  # E: Using type comments with mypy is (soft-)deprecated, use inline annotations instead  [type-comment]
+    ...
+
+def func(d, e):  # E: Using type comments with mypy is (soft-)deprecated, use inline annotations instead  [type-comment]
+    # type: (str, int) -> bool
+    ...
+
+async def func2():  # E: Using type comments with mypy is (soft-)deprecated, use inline annotations instead  [type-comment]
+    # type: () -> None
+
+    async for c in g():  # type: int  # type: ignore[name-defined]  # E: Using type comments with mypy is (soft-)deprecated, use inline annotations instead  [type-comment]
+        ...
+
+[builtins fixtures/tuple.pyi]