Add ASYNC401 for pytest.raises(ExceptionGroup) (#466)

* Add ASYNC401 pytest RaisesGroup rule

* Address ASYNC401 review feedback

---------

Co-authored-by: paranoa233 <paranoa233@users.noreply.github.com>

Author: paranoa233

docs/changelog.rst

@@ -4,6 +4,10 @@ Changelog
 
 `CalVer, YY.month.patch <https://calver.org/>`_
 
+27.7.1
+======
+- Add :ref:`ASYNC401 <async401>` pytest-raises-exception-group, recommending ``pytest.RaisesGroup`` over ``pytest.raises(ExceptionGroup)``. `(issue #430) <https://github.com/python-trio/flake8-async/issues/430>`_
+
 26.6.1
 ======
 - Add :ref:`ASYNC127 <async127>` unmaintained-httpx: use ``httpx2`` instead of ``httpx``, which is no longer maintained, to get security updates. `(issue #460) <https://github.com/python-trio/flake8-async/issues/460>`_

docs/rules.rst

@@ -220,6 +220,9 @@ ExceptionGroup rules
 _`ASYNC400` : except-star-invalid-attribute
     When converting a codebase to use `except* <except_star>` it's easy to miss that the caught exception(s) are wrapped in a group, so accessing attributes on the caught exception must now check the contained exceptions. This checks for any attribute access on a caught ``except*`` that's not a known valid attribute on `ExceptionGroup`. This can be safely disabled on a type-checked or coverage-covered code base.
 
+_`ASYNC401` : pytest-raises-exception-group
+    ``pytest.raises(ExceptionGroup)`` and ``pytest.raises(BaseExceptionGroup)`` usually hide the structure of exception groups. Prefer ``pytest.RaisesGroup``.
+
 Optional rules disabled by default
 ==================================
 

flake8_async/visitors/visitor4xx.py

@@ -1,6 +1,7 @@
 """4XX error classes, which handle exception groups.
 
 ASYNC400 except-star-invalid-attribute checks for invalid attribute access on except*
+ASYNC401 pytest-raises-exception-group checks for pytest.raises(ExceptionGroup)
 """
 
 from __future__ import annotations
@@ -96,3 +97,51 @@ def visit_FunctionDef(
 
     visit_AsyncFunctionDef = visit_FunctionDef
     visit_Lambda = visit_FunctionDef
+
+
+EXCGROUP_QUALNAMES = (
+    "ExceptionGroup",
+    "BaseExceptionGroup",
+    "builtins.ExceptionGroup",
+    "builtins.BaseExceptionGroup",
+    "exceptiongroup.ExceptionGroup",
+    "exceptiongroup.BaseExceptionGroup",
+)
+
+
+@error_class
+class Visitor401(Flake8AsyncVisitor):
+    error_codes: Mapping[str, str] = {
+        "ASYNC401": (
+            "Use `pytest.RaisesGroup` instead of `pytest.raises({})` when expecting"
+            " exception groups."
+        )
+    }
+
+    def _exception_group_name(self, node: ast.expr) -> str | None:
+        if isinstance(node, ast.Tuple):
+            for elt in node.elts:
+                if name := self._exception_group_name(elt):
+                    return name
+            return None
+
+        canonical = self.canonical_name(node)
+        if canonical in EXCGROUP_QUALNAMES:
+            return ast.unparse(node)
+        return None
+
+    def _expected_exception_arg(self, node: ast.Call) -> ast.expr | None:
+        if node.args:
+            return node.args[0]
+        for kw in node.keywords:
+            if kw.arg == "expected_exception":
+                return kw.value
+        return None
+
+    def visit_Call(self, node: ast.Call):
+        if (
+            self.canonical_name(node.func) == "pytest.raises"
+            and (expected_exception := self._expected_exception_arg(node)) is not None
+            and (exception_group := self._exception_group_name(expected_exception))
+        ):
+            self.error(node, exception_group)

tests/eval_files/async401.py

@@ -0,0 +1,34 @@
+import builtins
+import sys
+
+import pytest
+from exceptiongroup import BaseExceptionGroup as BackportBaseExceptionGroup
+from exceptiongroup import ExceptionGroup as BackportExceptionGroup
+from pytest import raises
+from pytest import raises as pytest_raises
+
+if sys.version_info < (3, 11):
+    from exceptiongroup import BaseExceptionGroup, ExceptionGroup
+
+
+class _NotPytest:
+    def raises(self, expected_exception):
+        pass
+
+
+not_pytest = _NotPytest()
+
+pytest.raises(ExceptionGroup)  # error: 0, "ExceptionGroup"
+pytest.raises(BaseExceptionGroup)  # error: 0, "BaseExceptionGroup"
+pytest.raises(expected_exception=ExceptionGroup)  # error: 0, "ExceptionGroup"
+pytest.raises((ValueError, ExceptionGroup))  # error: 0, "ExceptionGroup"
+pytest.raises(builtins.ExceptionGroup)  # type: ignore[attr-defined]  # error: 0, "builtins.ExceptionGroup"
+pytest.raises(BackportExceptionGroup)  # error: 0, "BackportExceptionGroup"
+pytest.raises(BackportBaseExceptionGroup)  # error: 0, "BackportBaseExceptionGroup"
+raises(ExceptionGroup)  # error: 0, "ExceptionGroup"
+pytest_raises(ExceptionGroup)  # error: 0, "ExceptionGroup"
+
+pytest.raises(ValueError)
+pytest.RaisesGroup(ValueError)
+raises(ValueError)
+not_pytest.raises(ExceptionGroup)

tests/test_flake8_async.py

@@ -543,6 +543,7 @@ def _parse_eval_file(
     "ASYNC127",
     "ASYNC300",
     "ASYNC400",
+    "ASYNC401",
     "ASYNC912",
 }