Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
be39f2f
scripts: add an assert-rewrite diff tool
RonnyPfannschmidt Aug 22, 2026
a39f739
fix(rewrite): prevent walrus operator double evaluation in assertions
RonnyPfannschmidt May 8, 2026
5167153
Add changelog fragment for #14445
RonnyPfannschmidt May 8, 2026
b83ae76
test(rewrite): add xfail tests for remaining walrus edge cases
RonnyPfannschmidt May 8, 2026
8fe2b3a
fix(rewrite): avoid double evaluation of walrus in BoolOp condition
RonnyPfannschmidt May 8, 2026
c5c9443
fix(rewrite): assign walrus comparators to temps in chained comparisons
RonnyPfannschmidt May 8, 2026
555a1a2
fix(rewrite): show correct walrus values in BoolOp explanations
RonnyPfannschmidt Jun 3, 2026
d115f0e
refactor(rewrite): minimal snapshots in BoolOp for walrus conflicts
RonnyPfannschmidt Jun 3, 2026
5fe5987
fix(rewrite): freeze operands a later walrus would clobber
RonnyPfannschmidt Jul 31, 2026
242d582
fix(rewrite): freeze walrus and starred operands too
RonnyPfannschmidt Jul 31, 2026
14cbbbf
refactor(rewrite): drop the walrus snapshot visit_Compare no longer n…
RonnyPfannschmidt Aug 10, 2026
9967057
refactor(rewrite): drop the unreachable Load guard in visit_Attribute
RonnyPfannschmidt Aug 10, 2026
58e0526
feat(rewrite): introspect container[key] in failure messages
RonnyPfannschmidt Jul 31, 2026
dfe9e00
feat(rewrite): introspect the condition of a ternary
RonnyPfannschmidt Jul 31, 2026
008a2f4
feat(rewrite): show a method call on one line
RonnyPfannschmidt Jul 31, 2026
798a6d1
fix(rewrite): freeze operands against any later side effect (#14820)
RonnyPfannschmidt Jul 31, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions changelog/14445.bugfix.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Fixed assertion rewriting evaluating walrus operator (``:=``) expressions multiple times, causing incorrect test results when the expression had side effects (e.g., incrementing a counter or calling a function).

Operands preceding a walrus operator are now evaluated -- and reported -- before it rebinds their name, so ``assert value != identity(value := value.lower())`` keeps Python's left-to-right evaluation order.
1 change: 1 addition & 0 deletions changelog/14814.bugfix.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fixed assertion rewriting evaluating a walrus operator (``:=``) or a starred argument out of order when a later argument assigned to the same name, so ``assert collect(*items, identity(items := [9]))`` now passes the pre-assignment ``items``.
4 changes: 4 additions & 0 deletions changelog/14815.improvement.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Assertion failure messages now decompose subscript expressions, showing the container and the key that produced a value::

assert 1 == 99
+ where 1 = {'a': 1, 'b': 2}['a']
4 changes: 4 additions & 0 deletions changelog/14816.improvement.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Assertion failure messages now show the condition of a conditional expression::

assert 0 == 99
+ where 0 = (... if True else ...)
4 changes: 4 additions & 0 deletions changelog/14817.improvement.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Assertion failure messages now show a method call on a single line, without the bound method as a separate intermediate::

assert 42 == 100
+ where 42 = Obj().compute()
1 change: 1 addition & 0 deletions changelog/14821.bugfix.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fixed assertion rewriting reading an operand after a later call had rebound its name, so ``assert count == bump()`` compares the ``count`` Python would have compared even when ``bump()`` assigns to it via ``global`` or ``nonlocal``.
1 change: 1 addition & 0 deletions changelog/14921.contrib.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added `scripts/diff-assert-rewrite.py`, which diffs the assert-rewritten form of a snippet between the plain source, this checkout and released pytest versions.
130 changes: 130 additions & 0 deletions scripts/diff-assert-rewrite.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
"""Show what assertion rewriting does to a snippet, as a diff.

Each side is one of ``plain`` (the source as written), ``worktree`` (this
checkout's ``src/``) or a released pytest version, which is fetched on demand
with ``uv run --with pytest==VERSION``. Sides are dumped as rewritten source
(``ast.unparse``) or as an AST, then diffed.

Usage::

# what rewriting does to a snippet -- plain vs worktree, as source:
python scripts/diff-assert-rewrite.py -c 'assert (x := f()) and (x := False)'

# a behaviour change against a release, over a whole file:
python scripts/diff-assert-rewrite.py --left 8.3.4 testing/example.py

# same, as AST, when the source form hides the difference:
python scripts/diff-assert-rewrite.py --left 8.3.4 --format ast -c 'assert a == b'

Exits 1 when the two sides differ, 0 when they do not.
"""

from __future__ import annotations

import argparse
import difflib
import os
from pathlib import Path
import subprocess
import sys
import tempfile


# Runs inside the environment of the pytest version under inspection: reads
# the source file named on its command line, writes the dump to stdout.
_WORKER = """
import ast, sys
fmt, mode, path = sys.argv[1:4]
source = open(path, "rb").read()
tree = ast.parse(source)
if mode == "rewrite":
from _pytest.assertion.rewrite import rewrite_asserts
rewrite_asserts(tree, source)
ast.fix_missing_locations(tree)
print(ast.unparse(tree) if fmt == "source" else ast.dump(tree, indent=2))
"""

_COLORS = {"-": "\033[31m", "+": "\033[32m", "@": "\033[36m"}


def spawn(spec: str, fmt: str, path: Path) -> subprocess.Popen[bytes]:
"""Start the dump of one side -- callers start both, then collect."""
args = [fmt, "plain" if spec == "plain" else "rewrite", str(path)]
env = None
if spec in ("plain", "worktree"):
cmd = [sys.executable, "-c", _WORKER, *args]
if spec == "worktree":
src = Path(__file__).parent.parent / "src"
env = os.environ | {"PYTHONPATH": str(src)}
else:
cmd = ["uv", "run", "--no-project", "--with", f"pytest=={spec}"]
cmd += ["--", "python", "-c", _WORKER, *args]
try:
return subprocess.Popen(cmd, env=env, stdout=subprocess.PIPE)
except FileNotFoundError as exc:
raise SystemExit(
f"{exc.filename} not found (uv: https://docs.astral.sh/uv/)"
) from None


def collect(spec: str, proc: subprocess.Popen[bytes]) -> list[str]:
assert proc.stdout is not None
out: bytes = proc.stdout.read()
if proc.wait():
raise SystemExit(f"dumping {spec} failed")
return out.decode().splitlines()


def main(argv: list[str] | None = None) -> None:
parser = argparse.ArgumentParser(
description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter
)
parser.add_argument(
"file", type=Path, nargs="?", help="file to rewrite (default: stdin)"
)
parser.add_argument("-c", "--code", help="snippet to rewrite instead of a file")
parser.add_argument(
"--left",
default="plain",
metavar="SPEC",
help="'plain', 'worktree' or a pytest version",
)
parser.add_argument(
"--right", default="worktree", metavar="SPEC", help="the same, other side"
)
parser.add_argument("--format", choices=("source", "ast"), default="source")
parser.add_argument("--no-color", action="store_true")
args = parser.parse_args(argv)

if args.code is not None:
source = args.code.encode()
elif args.file is not None:
source = args.file.read_bytes()
else:
source = sys.stdin.buffer.read()

with tempfile.TemporaryDirectory() as tmp:
path = Path(tmp, "snippet.py")
path.write_bytes(source)
procs = [
(side, spawn(side, args.format, path)) for side in (args.left, args.right)
]
left, right = [collect(side, proc) for side, proc in procs]
diff = list(
difflib.unified_diff(
left, right, fromfile=args.left, tofile=args.right, lineterm=""
)
)
if not diff:
print(f"{args.left} and {args.right} agree on the {args.format} form")
return

color = not args.no_color and sys.stdout.isatty()
for line in diff:
prefix = _COLORS.get(line[:1], "") if color else ""
print(f"{prefix}{line}\033[0m" if prefix else line)
raise SystemExit(1)


if __name__ == "__main__":
main()
Loading