fix: do not return Assert nodes, because they are caused by pytest assert rewriting

carterjsmarter · carterjsmarter · commit 4fbbe45d9e08 · 2022-08-12T21:52:55.000+02:00
This affects also chained comparisons inside normal assertions because of python/cpython#95921. This is also the reason for the changes in sample results. once that is fixed we could revert the changes in the sample_results
diff --git a/executing/executing.py b/executing/executing.py
@@ -584,6 +584,14 @@ def __init__(self, frame, stmts, tree, lasti, source):
                 else:
                     raise
 
+        if isinstance(node, ast.Assert):
+            # pytest assigns the position of the assertion to all expressions of the rewritten assertion.
+            # All the rewritten expressions get mapped to ast.Assert, which is the wrong ast-node.
+            # We don't report this wrong result.
+            self.result = None
+            self.decorator = None
+            return
+
         # find decorators
         if (
             isinstance(node.parent, (ast.ClassDef, function_node_types))
diff --git a/tests/sample_results/3.11.json b/tests/sample_results/3.11.json
@@ -18148,19 +18148,19 @@
         ],
         [
             "COMPARE_OP",
-            "assert 1 <= month <= 12, month"
+            ""
         ],
         [
             "COMPARE_OP",
-            "assert 1 <= month <= 12, month"
+            ""
         ],
         [
             "LOAD_FAST",
             "month"
         ],
         [
             "CALL",
-            "assert 1 <= month <= 12, month"
+            ""
         ],
         [
             "LOAD_FAST",
@@ -18200,15 +18200,15 @@
         ],
         [
             "COMPARE_OP",
-            "assert 1 <= month <= 12, 'month must be in 1..12'"
+            ""
         ],
         [
             "COMPARE_OP",
-            "assert 1 <= month <= 12, 'month must be in 1..12'"
+            ""
         ],
         [
             "CALL",
-            "assert 1 <= month <= 12, 'month must be in 1..12'"
+            ""
         ],
         [
             "LOAD_GLOBAL",
@@ -18252,15 +18252,15 @@
         ],
         [
             "COMPARE_OP",
-            "assert 1 <= month <= 12, 'month must be in 1..12'"
+            ""
         ],
         [
             "COMPARE_OP",
-            "assert 1 <= month <= 12, 'month must be in 1..12'"
+            ""
         ],
         [
             "CALL",
-            "assert 1 <= month <= 12, 'month must be in 1..12'"
+            ""
         ],
         [
             "LOAD_GLOBAL",
@@ -18288,15 +18288,15 @@
         ],
         [
             "COMPARE_OP",
-            "assert 1 <= day <= dim, ('day must be in 1..%d' % dim)"
+            ""
         ],
         [
             "LOAD_FAST",
             "dim"
         ],
         [
             "COMPARE_OP",
-            "assert 1 <= day <= dim, ('day must be in 1..%d' % dim)"
+            ""
         ],
         [
             "LOAD_FAST",
@@ -18308,7 +18308,7 @@
         ],
         [
             "CALL",
-            "assert 1 <= day <= dim, ('day must be in 1..%d' % dim)"
+            ""
         ],
         [
             "LOAD_GLOBAL",
@@ -18724,7 +18724,7 @@
         ],
         [
             "COMPARE_OP",
-            "assert 0 <= n < _days_in_month(year, month)"
+            ""
         ],
         [
             "LOAD_GLOBAL",
@@ -18744,7 +18744,7 @@
         ],
         [
             "COMPARE_OP",
-            "assert 0 <= n < _days_in_month(year, month)"
+            ""
         ],
         [
             "LOAD_FAST",
@@ -23388,11 +23388,11 @@
         ],
         [
             "COMPARE_OP",
-            "assert isinstance(s, int) and 0 <= s < 24*3600"
+            ""
         ],
         [
             "COMPARE_OP",
-            "assert isinstance(s, int) and 0 <= s < 24*3600"
+            ""
         ],
         [
             "LOAD_GLOBAL",
@@ -23416,11 +23416,11 @@
         ],
         [
             "COMPARE_OP",
-            "assert isinstance(us, int) and 0 <= us < 1000000"
+            ""
         ],
         [
             "COMPARE_OP",
-            "assert isinstance(us, int) and 0 <= us < 1000000"
+            ""
         ],
         [
             "LOAD_GLOBAL",
@@ -29076,7 +29076,7 @@
         ],
         [
             "CALL",
-            "assert not m % timedelta(minutes=1), \"whole minute\""
+            ""
         ],
         [
             "LOAD_FAST",
@@ -50008,11 +50008,11 @@
         ],
         [
             "COMPARE_OP",
-            "assert list(gen()) == list(gen2) == [1, 2]"
+            ""
         ],
         [
             "COMPARE_OP",
-            "assert list(gen()) == list(gen2) == [1, 2]"
+            ""
         ],
         [
             "STORE_FAST",
@@ -51900,7 +51900,7 @@
         ],
         [
             "CALL",
-            "assert isinstance(node, typ), (node, typ)"
+            ""
         ],
         [
             "LOAD_FAST",
@@ -52016,7 +52016,7 @@
         ],
         [
             "CALL",
-            "assert result == value, (result, value)"
+            ""
         ],
         [
             "LOAD_FAST",
@@ -54970,7 +54970,7 @@
         ],
         [
             "CALL",
-            "assert isinstance(result, ChangeValue), \"after_expr must return None or an instance of ChangeValue\""
+            ""
         ],
         [
             "LOAD_FAST",
@@ -58044,7 +58044,7 @@
         ],
         [
             "CALL",
-            "assert len(pair) == 2, \"Watch extra must return pair or None\""
+            ""
         ],
         [
             "LOAD_FAST",
diff --git a/tests/test_pytest.py b/tests/test_pytest.py
@@ -1,10 +1,14 @@
 import os
 import sys
+import inspect
+import ast
 
 from littleutils import SimpleNamespace
 
 from executing.executing import is_ipython_cell_code
 
+from executing import Source,NotOneValueFound
+
 sys.path.append(os.path.dirname(os.path.dirname(__file__)))
 
 
@@ -23,6 +27,18 @@ def test_pytest():
     assert x is tester
 
 
+def this_expression():
+    try:
+        return Source.executing(inspect.currentframe().f_back).node
+    except NotOneValueFound:
+        # TODO: python < 3.11 raises an exception. Should we do the same for the PositionNodeFinder instead of returning None?
+        return None
+
+
+def test_assert():
+    assert isinstance(this_expression(),(ast.Call, type(None)))
+
+
 def test_ipython_cell_code():
     assert is_ipython_cell_code(
         SimpleNamespace(

Original file line number	Diff line number	Diff line change
`@@ -18148,19 +18148,19 @@`
`18148`	`18148`	`],`
`18149`	`18149`	`[`
`18150`	`18150`	`"COMPARE_OP",`
`18151`		`- "assert 1 <= month <= 12, month"`
	`18151`	`+ ""`
`18152`	`18152`	`],`
`18153`	`18153`	`[`
`18154`	`18154`	`"COMPARE_OP",`
`18155`		`- "assert 1 <= month <= 12, month"`
	`18155`	`+ ""`
`18156`	`18156`	`],`
`18157`	`18157`	`[`
`18158`	`18158`	`"LOAD_FAST",`
`18159`	`18159`	`"month"`
`18160`	`18160`	`],`
`18161`	`18161`	`[`
`18162`	`18162`	`"CALL",`
`18163`		`- "assert 1 <= month <= 12, month"`
	`18163`	`+ ""`
`18164`	`18164`	`],`
`18165`	`18165`	`[`
`18166`	`18166`	`"LOAD_FAST",`
`@@ -18200,15 +18200,15 @@`
`18200`	`18200`	`],`
`18201`	`18201`	`[`
`18202`	`18202`	`"COMPARE_OP",`
`18203`		`- "assert 1 <= month <= 12, 'month must be in 1..12'"`
	`18203`	`+ ""`
`18204`	`18204`	`],`
`18205`	`18205`	`[`
`18206`	`18206`	`"COMPARE_OP",`
`18207`		`- "assert 1 <= month <= 12, 'month must be in 1..12'"`
	`18207`	`+ ""`
`18208`	`18208`	`],`
`18209`	`18209`	`[`
`18210`	`18210`	`"CALL",`
`18211`		`- "assert 1 <= month <= 12, 'month must be in 1..12'"`
	`18211`	`+ ""`
`18212`	`18212`	`],`
`18213`	`18213`	`[`
`18214`	`18214`	`"LOAD_GLOBAL",`
`@@ -18252,15 +18252,15 @@`
`18252`	`18252`	`],`
`18253`	`18253`	`[`
`18254`	`18254`	`"COMPARE_OP",`
`18255`		`- "assert 1 <= month <= 12, 'month must be in 1..12'"`
	`18255`	`+ ""`
`18256`	`18256`	`],`
`18257`	`18257`	`[`
`18258`	`18258`	`"COMPARE_OP",`
`18259`		`- "assert 1 <= month <= 12, 'month must be in 1..12'"`
	`18259`	`+ ""`
`18260`	`18260`	`],`
`18261`	`18261`	`[`
`18262`	`18262`	`"CALL",`
`18263`		`- "assert 1 <= month <= 12, 'month must be in 1..12'"`
	`18263`	`+ ""`
`18264`	`18264`	`],`
`18265`	`18265`	`[`
`18266`	`18266`	`"LOAD_GLOBAL",`
`@@ -18288,15 +18288,15 @@`
`18288`	`18288`	`],`
`18289`	`18289`	`[`
`18290`	`18290`	`"COMPARE_OP",`
`18291`		`- "assert 1 <= day <= dim, ('day must be in 1..%d' % dim)"`
	`18291`	`+ ""`
`18292`	`18292`	`],`
`18293`	`18293`	`[`
`18294`	`18294`	`"LOAD_FAST",`
`18295`	`18295`	`"dim"`
`18296`	`18296`	`],`
`18297`	`18297`	`[`
`18298`	`18298`	`"COMPARE_OP",`
`18299`		`- "assert 1 <= day <= dim, ('day must be in 1..%d' % dim)"`
	`18299`	`+ ""`
`18300`	`18300`	`],`
`18301`	`18301`	`[`
`18302`	`18302`	`"LOAD_FAST",`
`@@ -18308,7 +18308,7 @@`
`18308`	`18308`	`],`
`18309`	`18309`	`[`
`18310`	`18310`	`"CALL",`
`18311`		`- "assert 1 <= day <= dim, ('day must be in 1..%d' % dim)"`
	`18311`	`+ ""`
`18312`	`18312`	`],`
`18313`	`18313`	`[`
`18314`	`18314`	`"LOAD_GLOBAL",`
`@@ -18724,7 +18724,7 @@`
`18724`	`18724`	`],`
`18725`	`18725`	`[`
`18726`	`18726`	`"COMPARE_OP",`
`18727`		`- "assert 0 <= n < _days_in_month(year, month)"`
	`18727`	`+ ""`
`18728`	`18728`	`],`
`18729`	`18729`	`[`
`18730`	`18730`	`"LOAD_GLOBAL",`
`@@ -18744,7 +18744,7 @@`
`18744`	`18744`	`],`
`18745`	`18745`	`[`
`18746`	`18746`	`"COMPARE_OP",`
`18747`		`- "assert 0 <= n < _days_in_month(year, month)"`
	`18747`	`+ ""`
`18748`	`18748`	`],`
`18749`	`18749`	`[`
`18750`	`18750`	`"LOAD_FAST",`
`@@ -23388,11 +23388,11 @@`
`23388`	`23388`	`],`
`23389`	`23389`	`[`
`23390`	`23390`	`"COMPARE_OP",`
`23391`		`- "assert isinstance(s, int) and 0 <= s < 24*3600"`
	`23391`	`+ ""`
`23392`	`23392`	`],`
`23393`	`23393`	`[`
`23394`	`23394`	`"COMPARE_OP",`
`23395`		`- "assert isinstance(s, int) and 0 <= s < 24*3600"`
	`23395`	`+ ""`
`23396`	`23396`	`],`
`23397`	`23397`	`[`
`23398`	`23398`	`"LOAD_GLOBAL",`
`@@ -23416,11 +23416,11 @@`
`23416`	`23416`	`],`
`23417`	`23417`	`[`
`23418`	`23418`	`"COMPARE_OP",`
`23419`		`- "assert isinstance(us, int) and 0 <= us < 1000000"`
	`23419`	`+ ""`
`23420`	`23420`	`],`
`23421`	`23421`	`[`
`23422`	`23422`	`"COMPARE_OP",`
`23423`		`- "assert isinstance(us, int) and 0 <= us < 1000000"`
	`23423`	`+ ""`
`23424`	`23424`	`],`
`23425`	`23425`	`[`
`23426`	`23426`	`"LOAD_GLOBAL",`
`@@ -29076,7 +29076,7 @@`
`29076`	`29076`	`],`
`29077`	`29077`	`[`
`29078`	`29078`	`"CALL",`
`29079`		`- "assert not m % timedelta(minutes=1), \"whole minute\""`
	`29079`	`+ ""`
`29080`	`29080`	`],`
`29081`	`29081`	`[`
`29082`	`29082`	`"LOAD_FAST",`
`@@ -50008,11 +50008,11 @@`
`50008`	`50008`	`],`
`50009`	`50009`	`[`
`50010`	`50010`	`"COMPARE_OP",`
`50011`		`- "assert list(gen()) == list(gen2) == [1, 2]"`
	`50011`	`+ ""`
`50012`	`50012`	`],`
`50013`	`50013`	`[`
`50014`	`50014`	`"COMPARE_OP",`
`50015`		`- "assert list(gen()) == list(gen2) == [1, 2]"`
	`50015`	`+ ""`
`50016`	`50016`	`],`
`50017`	`50017`	`[`
`50018`	`50018`	`"STORE_FAST",`
`@@ -51900,7 +51900,7 @@`
`51900`	`51900`	`],`
`51901`	`51901`	`[`
`51902`	`51902`	`"CALL",`
`51903`		`- "assert isinstance(node, typ), (node, typ)"`
	`51903`	`+ ""`
`51904`	`51904`	`],`
`51905`	`51905`	`[`
`51906`	`51906`	`"LOAD_FAST",`
`@@ -52016,7 +52016,7 @@`
`52016`	`52016`	`],`
`52017`	`52017`	`[`
`52018`	`52018`	`"CALL",`
`52019`		`- "assert result == value, (result, value)"`
	`52019`	`+ ""`
`52020`	`52020`	`],`
`52021`	`52021`	`[`
`52022`	`52022`	`"LOAD_FAST",`
`@@ -54970,7 +54970,7 @@`
`54970`	`54970`	`],`
`54971`	`54971`	`[`
`54972`	`54972`	`"CALL",`
`54973`		`- "assert isinstance(result, ChangeValue), \"after_expr must return None or an instance of ChangeValue\""`
	`54973`	`+ ""`
`54974`	`54974`	`],`
`54975`	`54975`	`[`
`54976`	`54976`	`"LOAD_FAST",`
`@@ -58044,7 +58044,7 @@`
`58044`	`58044`	`],`
`58045`	`58045`	`[`
`58046`	`58046`	`"CALL",`
`58047`		`- "assert len(pair) == 2, \"Watch extra must return pair or None\""`
	`58047`	`+ ""`
`58048`	`58048`	`],`
`58049`	`58049`	`[`
`58050`	`58050`	`"LOAD_FAST",`