Adjust inconsistent dataclasses plugin error messages (#14637)

wesleywright · web-flow · commit f6a8037cccac · 2023-02-07T18:24:45.000Z
This commit adds quotes around Python identifiers in two
error messages, and points the error for `"eq" must be True if "order"
is True` more directly at the decorator that triggers the error message.
diff --git a/mypy/plugins/dataclasses.py b/mypy/plugins/dataclasses.py
@@ -229,7 +229,7 @@ def transform(self) -> bool:
         # Add <, >, <=, >=, but only if the class has an eq method.
         if decorator_arguments["order"]:
             if not decorator_arguments["eq"]:
-                ctx.api.fail("eq must be True if order is True", ctx.cls)
+                ctx.api.fail('"eq" must be True if "order" is True', ctx.reason)
 
             for method_name in ["__lt__", "__gt__", "__le__", "__ge__"]:
                 # Like for __eq__ and __ne__, we want "other" to match
@@ -247,7 +247,7 @@ def transform(self) -> bool:
                 if existing_method is not None and not existing_method.plugin_generated:
                     assert existing_method.node
                     ctx.api.fail(
-                        f"You may not have a custom {method_name} method when order=True",
+                        f'You may not have a custom "{method_name}" method when "order" is True',
                         existing_method.node,
                     )
 
diff --git a/test-data/unit/check-dataclass-transform.test b/test-data/unit/check-dataclass-transform.test
@@ -55,8 +55,8 @@ def my_dataclass(*, eq: bool, order: bool) -> Callable[[Type], Type]:
         return cls
     return transform
 
-@my_dataclass(eq=False, order=True)
-class Person:  # E: eq must be True if order is True
+@my_dataclass(eq=False, order=True)  # E: "eq" must be True if "order" is True
+class Person:
     name: str
     age: int
 
diff --git a/test-data/unit/check-dataclasses.test b/test-data/unit/check-dataclasses.test
@@ -672,8 +672,8 @@ app1 >= app3
 # flags: --python-version 3.7
 from dataclasses import dataclass
 
-@dataclass(eq=False, order=True)
-class Application:  # E: eq must be True if order is True
+@dataclass(eq=False, order=True)  # E: "eq" must be True if "order" is True
+class Application:
    ...
 
 [builtins fixtures/dataclasses.pyi]
@@ -684,7 +684,7 @@ from dataclasses import dataclass
 
 @dataclass(order=True)
 class Application:
-  def __lt__(self, other: 'Application') -> bool: # E: You may not have a custom __lt__ method when order=True
+  def __lt__(self, other: 'Application') -> bool: # E: You may not have a custom "__lt__" method when "order" is True
     ...
 
 [builtins fixtures/dataclasses.pyi]
