Merge remote-tracking branch 'upstream/main' into fix-2388-syntax-error-crash-line

Author: SemTiOne

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 minimum_pre_commit_version: "4.4.0"
 repos:
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: "v0.16.2"
+  rev: "v0.16.3"
   hooks:
     - id: ruff-check
       args: ["--fix"]
@@ -34,7 +34,7 @@ repos:
     hooks:
     -   id: python-use-type-annotations
 -   repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v2.3.0
+    rev: v2.3.1
     hooks:
     -   id: mypy
         files: ^(src/|testing/|scripts/)

AUTHORS

@@ -422,6 +422,7 @@ Roland Puntaier
 Romain Dorgueil
 Roman Bolshakov
 Ronny Pfannschmidt
+Roqia Salah
 Ross Lawley
 Ruaridh Williamson
 Russel Winder

changelog/14828.bugfix.rst

@@ -0,0 +1 @@
+Exception groups raised from another exception now print their cause chain only once in the traceback output.

changelog/6997.bugfix.rst

@@ -0,0 +1,2 @@
+XFAIL reports from teardown phases now include the phase in the short test
+summary.

doc/en/reference/plugin_list.rst

@@ -113,7 +113,7 @@ src = [
     "src",
 ]
 format.docstring-code-format = true
-lint.select = [
+lint.extend-select = [
     "B",       # bugbear
     "D",       # pydocstyle
     "E",       # pycodestyle
@@ -134,13 +134,24 @@ lint.select = [
     "W",       # pycodestyle
 ]
 lint.ignore = [
+    # flake8-async ignore
+    "ASYNC115", # Use `lowlevel.checkpoint()` instead of `sleep(0)`
     # bugbear ignore
     "B004", # Using `hasattr(x, "__call__")` to test if x is callable is unreliable.
     "B007", # Loop control variable `i` not used within loop body
     "B009", # Do not call `getattr` with a constant attribute value
     "B010", # [*] Do not call `setattr` with a constant attribute value.
     "B011", # Do not `assert False` (`python -O` removes these calls)
     "B028", # No explicit `stacklevel` keyword argument found
+    # flake8-blind-except ignore
+    "BLE001", # Do not catch blind exception
+    # flake8-comprehensions ignore
+    "C400", # Unnecessary generator (rewrite using `list()`)
+    "C408", # Unnecessary `dict()`/`list()`/`tuple()` call (rewrite as a literal)
+    "C409", # Unnecessary list literal passed to `tuple()` (rewrite as a tuple literal)
+    "C410", # Unnecessary list literal passed to `list()` (remove the outer call to `list()`)
+    "C414", # Unnecessary double cast or process
+    "C417", # Unnecessary `map()` usage (rewrite using a comprehension)
     # pydocstyle ignore
     "D100", # Missing docstring in public module
     "D101", # Missing docstring in public class
@@ -157,9 +168,30 @@ lint.ignore = [
     "D402", # First line should not be the function's signature
     "D404", # First word of the docstring should not be "This"
     "D415", # First line should end with a period, question mark, or exclamation point
+    # flake8-datetimez ignore
+    "DTZ001", # `datetime.datetime()` called without a `tzinfo` argument
+    "DTZ005", # `datetime.datetime.now()` called without a `tz` argument
     # pytest can do weird low-level things, and we usually know
     # what we're doing when we use type(..) is ...
     "E721", # Do not compare types, use `isinstance()`
+    # flake8-future-annotations ignore
+    "FA102", # Missing `from __future__ import annotations`, but uses PEP 585/604 syntax
+    # flynt ignore
+    "FLY002", # Consider an f-string instead of string join
+    # refurb ignore
+    "FURB157", # Verbose expression in `Decimal` constructor
+    "FURB188", # Prefer `str.removeprefix()` over conditionally replacing with slice
+    # flake8-implicit-str-concat ignore
+    "ISC004", # Unparenthesized implicit string concatenation in collection
+    # flake8-logging ignore
+    "LOG009", # Use of undocumented `logging.WARN` constant
+    "LOG015", # Call on root logger
+    # pep8-naming ignore
+    "N999", # Invalid module name
+    # perflint ignore
+    "PERF102", # When using only the keys or values of a dict use the `keys()`/`values()` method
+    # pygrep-hooks ignore
+    "PGH005", # Mock method should be called
     # pylint ignore
     "PLC0105", # `TypeVar` name "E" does not reflect its covariance;
     "PLC0414", # Import alias does not rename original package
@@ -179,9 +211,41 @@ lint.ignore = [
     "PLW0603", # Using the global statement
     "PLW1641", # Does not implement the __hash__ method
     "PLW2901", # for loop variable overwritten by assignment target
+    # flake8-pytest-style ignore
+    "PT020", # `@pytest.yield_fixture` is deprecated, use `@pytest.fixture`
+    "PT025", # `pytest.mark.usefixtures` has no effect on fixtures
+    "PT031", # `pytest.warns()` block should contain a single simple statement
+    # flake8-use-pathlib ignore
+    "PTH124", # `py.path` is in maintenance mode, use `pathlib` instead
+    "PTH210", # Invalid suffix passed to `.with_suffix()`
+    # flake8-return ignore
+    "RET501", # Do not explicitly `return None` in function if it is the only possible return value
     # ruff ignore
     "RUF012", # Mutable class attributes should be annotated with `typing.ClassVar`
     "RUF061", # Use context-manager form of `pytest.raises()`
+    # flake8-bandit ignore
+    "S102", # Use of `exec` detected
+    "S110", # `try`-`except`-`pass` detected, consider logging the exception
+    "S112", # `try`-`except`-`continue` detected, consider logging the exception
+    # flake8-simplify ignore
+    "SIM102", # Use a single `if` statement instead of nested `if` statements
+    "SIM103", # Return the condition directly
+    "SIM114", # Combine `if` branches using logical `or` operator
+    "SIM115", # Use a context manager for opening files
+    "SIM117", # Use a single `with` statement with multiple contexts instead of nested `with` statements
+    "SIM118", # Use `key in dict` instead of `key in dict.keys()`
+    "SIM201", # Use `!=` instead of `not ... == ...`
+    "SIM202", # Use `==` instead of `not ... != ...`
+    "SIM210", # Remove unnecessary `True if ... else False`
+    "SIM211", # Use `not ...` instead of `False if ... else True`
+    "SIM222", # Use the simplified expression instead of `... or True`
+    "SIM223", # Use the simplified expression instead of `... and False`
+    "SIM905", # Consider using a list literal instead of `str.split()`
+    # flake8-type-checking ignore
+    "TC005", # Found empty type-checking block
+    # tryceratops ignore
+    "TRY002", # Create your own exception
+    "TRY004", # Prefer `TypeError` exception for invalid type
 ]
 lint.per-file-ignores."doc/**/*.py" = [
     "PLR0133", # Two constants compared in a comparison,

pyproject.toml

@@ -1241,7 +1241,9 @@ def repr_excinfo(self, excinfo: ExceptionInfo[BaseException]) -> ExceptionChainR
                 reprcrash = None
             repr_chain.append((reprtraceback, reprcrash, description))
 
-            if e.__cause__ is not None and self.chain:
+            if isinstance(e, BaseExceptionGroup) and self.chain:
+                e = None
+            elif e.__cause__ is not None and self.chain:
                 e = e.__cause__
                 excinfo_ = ExceptionInfo.from_exception(e) if e.__traceback__ else None
                 description = "The above exception was the direct cause of the following exception:"

src/_pytest/_code/code.py

@@ -6,6 +6,7 @@
 from collections.abc import Callable
 from collections.abc import Iterator
 from collections.abc import Sequence
+from collections.abc import Set as AbstractSet
 from unicodedata import normalize
 
 from _pytest import outcomes
@@ -14,8 +15,6 @@
 from _pytest._io.saferepr import saferepr_unlimited
 from _pytest.assertion._compare_any import _compare_eq_any
 from _pytest.assertion._compare_set import SET_COMPARISON_FUNCTIONS
-from _pytest.assertion._guards import isset
-from _pytest.assertion._guards import istext
 from _pytest.assertion._typing import _AssertionTextDiffStyle
 from _pytest.assertion._typing import _HighlightFunc
 from _pytest.assertion._typing import NO_TRUNCATION_BUDGET
@@ -151,21 +150,22 @@ def assertrepr_compare(
     summary = f"{left_repr} {op} {right_repr}"
 
     try:
-        if op == "==":
-            source = _compare_eq_any(
-                left,
-                right,
-                highlighter,
-                verbose,
-                assertion_text_diff_style,
-                truncation_budget,
-            )
-        elif op == "not in" and istext(left) and istext(right):
-            source = _notin_text(left, right, verbose, truncation_budget)
-        elif op in {"!=", ">=", "<=", ">", "<"} and isset(left) and isset(right):
-            source = SET_COMPARISON_FUNCTIONS[op](left, right, highlighter, verbose)
-        else:
-            source = iter(())
+        match (left, op, right):
+            case (_, "==", _):
+                source = _compare_eq_any(
+                    left,
+                    right,
+                    highlighter,
+                    verbose,
+                    assertion_text_diff_style,
+                    truncation_budget,
+                )
+            case (str(), "not in", str()):
+                source = _notin_text(left, right, verbose, truncation_budget)
+            case (AbstractSet(), "!=" | ">=" | "<=" | ">" | "<", AbstractSet()):
+                source = SET_COMPARISON_FUNCTIONS[op](left, right, highlighter, verbose)
+            case _:
+                source = iter(())
 
         # Only yield the summary if there is a detailed explanation.
         # Make sure there's a separating empty line after the summary.

src/_pytest/assertion/util.py

@@ -1328,7 +1328,12 @@ def show_xfailed(lines: list[str]) -> None:
                 )
                 markup_word = self._tw.markup(verbose_word, **verbose_markup)
                 nodeid = _get_node_id_with_markup(self._tw, self.config, rep)
-                line = f"{markup_word} {nodeid}"
+
+                if rep.when == "call":
+                    line = f"{markup_word} {nodeid}"
+                else:
+                    line = f"{markup_word} at {rep.when} of {nodeid}"
+
                 reason = rep.wasxfail
                 if reason:
                     line += " - " + str(reason)

src/_pytest/terminal.py

@@ -1631,6 +1631,66 @@ def g():
             ]
         )
 
+    def _render_output(self, excinfo: ExceptionInfo[BaseException]) -> str:
+        r = excinfo.getrepr()
+        file = io.StringIO()
+        tw = TerminalWriter(file=file)
+        tw.hasmarkup = False
+        r.toterminal(tw)
+        return file.getvalue()
+
+    def test_exc_chain_repr_exception_group_with_cause(self) -> None:
+        """An exception group raised from another exception must not print that
+        exception's cause chain twice."""
+        try:
+            try:
+                raise RuntimeError("original cause")
+            except RuntimeError as exc:
+                raise ExceptionGroup("group", [ValueError("inner")]) from exc
+        except ExceptionGroup:
+            excinfo = ExceptionInfo.from_current()
+
+        output = self._render_output(excinfo)
+        assert output.count("RuntimeError: original cause") == 1
+        assert output.count("ExceptionGroup: group") == 1
+        assert output.count("ValueError: inner") == 1
+        assert output.count("The above exception was the direct cause") == 1
+
+    def test_exc_chain_repr_exception_group_with_context(self) -> None:
+        """An exception group raised during handling must not print the
+        implicit context chain twice."""
+        exc1 = RuntimeError("implicit context")
+        try:
+            raise exc1
+        except RuntimeError as exc:
+            group = ExceptionGroup("group", [ValueError("inner")])
+            group.__context__ = exc
+        try:
+            raise group
+        except ExceptionGroup:
+            excinfo = ExceptionInfo.from_current()
+
+        output = self._render_output(excinfo)
+        assert output.count("RuntimeError: implicit context") == 1
+        assert output.count("During handling of the above exception") == 1
+
+    def test_exc_chain_repr_nested_exception_group_with_cause(self) -> None:
+        """A nested exception group raised from another exception must not
+        print the cause chain twice."""
+        try:
+            try:
+                raise RuntimeError("root cause")
+            except RuntimeError as exc:
+                raise ExceptionGroup(
+                    "outer", [ExceptionGroup("inner", [ValueError("v")])]
+                ) from exc
+        except ExceptionGroup:
+            excinfo = ExceptionInfo.from_current()
+
+        output = self._render_output(excinfo)
+        assert output.count("RuntimeError: root cause") == 1
+        assert output.count("The above exception was the direct cause") == 1
+
     def test_exc_chain_repr_without_traceback_multiple_links(self) -> None:
         """
         Exceptions without a traceback that are themselves part of a longer
@@ -1652,13 +1712,7 @@ def test_exc_chain_repr_without_traceback_multiple_links(self) -> None:
         except ValueError:
             excinfo = ExceptionInfo.from_current()
 
-        r = excinfo.getrepr()
-        file = io.StringIO()
-        tw = TerminalWriter(file=file)
-        tw.hasmarkup = False
-        r.toterminal(tw)
-
-        output = file.getvalue()
+        output = self._render_output(excinfo)
         for message in (
             "ValueError: abcd",
             "IndexError: efgh",
@@ -1687,13 +1741,7 @@ def test_exc_chain_repr_mixed_traceback(self) -> None:
         except ValueError:
             excinfo = ExceptionInfo.from_current()
 
-        r = excinfo.getrepr()
-        file = io.StringIO()
-        tw = TerminalWriter(file=file)
-        tw.hasmarkup = False
-        r.toterminal(tw)
-
-        output = file.getvalue()
+        output = self._render_output(excinfo)
         assert output.count("ValueError: outer without traceback") == 1
         assert output.count("RuntimeError: inner with traceback") == 1
         assert output.count("The above exception was the direct cause") == 1