.. _`tbreportdemo`: Demo of Python failure reports with pytest ========================================== Here is a nice run of several failures and how ``pytest`` presents things: .. code-block:: pytest assertion $ pytest failure_demo.py =========================== test session starts ============================ platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y cachedir: $PYTHON_PREFIX/.pytest_cache rootdir: $REGENDOC_TMPDIR/assertion collected 44 items failure_demo.py FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF [100%] ================================= FAILURES ================================= ___________________________ test_generative[3-6] ___________________________ param1 = 3, param2 = 6 @pytest.mark.parametrize("param1, param2", [(3, 6)]) def test_generative(param1, param2): > assert param1 * 2 < param2 E assert (3 * 2) < 6 failure_demo.py:20: AssertionError _________________________ TestFailing.test_simple __________________________ self = def test_simple(self): def f(): return 42 def g(): return 43 > assert f() == g() E assert 42 == 43 E + where 42 = .f at 0xdeadbeef>() E + and 43 = .g at 0xdeadbeef>() failure_demo.py:31: AssertionError ____________________ TestFailing.test_simple_multiline _____________________ self = def test_simple_multiline(self): > otherfunc_multi(42, 6 * 9) failure_demo.py:34: _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ a = 42, b = 54 def otherfunc_multi(a, b): > assert a == b E assert 42 == 54 failure_demo.py:15: AssertionError ___________________________ TestFailing.test_not ___________________________ self = def test_not(self): def f(): return 42 > assert not f() E assert not 42 E + where 42 = .f at 0xdeadbeef>() failure_demo.py:40: AssertionError _________________ TestSpecialisedExplanations.test_eq_text _________________ self = def test_eq_text(self): > assert "spam" == "eggs" E AssertionError: assert 'spam' == 'eggs' E - eggs E + spam failure_demo.py:45: AssertionError _____________ TestSpecialisedExplanations.test_eq_similar_text _____________ self = def test_eq_similar_text(self): > assert "foo 1 bar" == "foo 2 bar" E AssertionError: assert 'foo 1 bar' == 'foo 2 bar' E - foo 2 bar E ? ^ E + foo 1 bar E ? ^ failure_demo.py:48: AssertionError ____________ TestSpecialisedExplanations.test_eq_multiline_text ____________ self = def test_eq_multiline_text(self): > assert "foo\nspam\nbar" == "foo\neggs\nbar" E AssertionError: assert 'foo\nspam\nbar' == 'foo\neggs\nbar' E foo E - eggs E + spam E bar failure_demo.py:51: AssertionError ______________ TestSpecialisedExplanations.test_eq_long_text _______________ self = def test_eq_long_text(self): a = "1" * 100 + "a" + "2" * 100 b = "1" * 100 + "b" + "2" * 100 > assert a == b E AssertionError: assert '111111111111...2222222222222' == '111111111111...2222222222222' E Skipping 90 identical leading characters in diff, use -v to show E Skipping 91 identical trailing characters in diff, use -v to show E - 1111111111b222222222 E ? ^ E + 1111111111a222222222 E ? ^ failure_demo.py:56: AssertionError _________ TestSpecialisedExplanations.test_eq_long_text_multiline __________ self = def test_eq_long_text_multiline(self): a = "1\n" * 100 + "a" + "2\n" * 100 b = "1\n" * 100 + "b" + "2\n" * 100 > assert a == b E AssertionError: assert '1\n1\n1\n1\n...n2\n2\n2\n2\n' == '1\n1\n1\n1\n...n2\n2\n2\n2\n' E Skipping 190 identical leading characters in diff, use -v to show E Skipping 191 identical trailing characters in diff, use -v to show E 1 E 1 E 1 E 1 E 1... E E ...Full output truncated (7 lines hidden), use '-vv' to show failure_demo.py:61: AssertionError _________________ TestSpecialisedExplanations.test_eq_list _________________ self = def test_eq_list(self): > assert [0, 1, 2] == [0, 1, 3] E assert [0, 1, 2] == [0, 1, 3] E At index 2 diff: 2 != 3 E Use -v to get the full diff failure_demo.py:64: AssertionError ______________ TestSpecialisedExplanations.test_eq_list_long _______________ self = def test_eq_list_long(self): a = [0] * 100 + [1] + [3] * 100 b = [0] * 100 + [2] + [3] * 100 > assert a == b E assert [0, 0, 0, 0, 0, 0, ...] == [0, 0, 0, 0, 0, 0, ...] E At index 100 diff: 1 != 2 E Use -v to get the full diff failure_demo.py:69: AssertionError _________________ TestSpecialisedExplanations.test_eq_dict _________________ self = def test_eq_dict(self): > assert {"a": 0, "b": 1, "c": 0} == {"a": 0, "b": 2, "d": 0} E AssertionError: assert {'a': 0, 'b': 1, 'c': 0} == {'a': 0, 'b': 2, 'd': 0} E Omitting 1 identical items, use -vv to show E Differing items: E {'b': 1} != {'b': 2} E Left contains 1 more item: E {'c': 0} E Right contains 1 more item: E {'d': 0}... E E ...Full output truncated (2 lines hidden), use '-vv' to show failure_demo.py:72: AssertionError _________________ TestSpecialisedExplanations.test_eq_set __________________ self = def test_eq_set(self): > assert {0, 10, 11, 12} == {0, 20, 21} E AssertionError: assert {0, 10, 11, 12} == {0, 20, 21} E Extra items in the left set: E 10 E 11 E 12 E Extra items in the right set: E 20 E 21... E E ...Full output truncated (2 lines hidden), use '-vv' to show failure_demo.py:75: AssertionError _____________ TestSpecialisedExplanations.test_eq_longer_list ______________ self = def test_eq_longer_list(self): > assert [1, 2] == [1, 2, 3] E assert [1, 2] == [1, 2, 3] E Right contains one more item: 3 E Use -v to get the full diff failure_demo.py:78: AssertionError _________________ TestSpecialisedExplanations.test_in_list _________________ self = def test_in_list(self): > assert 1 in [0, 2, 3, 4, 5] E assert 1 in [0, 2, 3, 4, 5] failure_demo.py:81: AssertionError __________ TestSpecialisedExplanations.test_not_in_text_multiline __________ self = def test_not_in_text_multiline(self): text = "some multiline\ntext\nwhich\nincludes foo\nand a\ntail" > assert "foo" not in text E AssertionError: assert 'foo' not in 'some multil...nand a\ntail' E 'foo' is contained here: E some multiline E text E which E includes foo E ? +++ E and a... E E ...Full output truncated (2 lines hidden), use '-vv' to show failure_demo.py:85: AssertionError ___________ TestSpecialisedExplanations.test_not_in_text_single ____________ self = def test_not_in_text_single(self): text = "single foo line" > assert "foo" not in text E AssertionError: assert 'foo' not in 'single foo line' E 'foo' is contained here: E single foo line E ? +++ failure_demo.py:89: AssertionError _________ TestSpecialisedExplanations.test_not_in_text_single_long _________ self = def test_not_in_text_single_long(self): text = "head " * 50 + "foo " + "tail " * 20 > assert "foo" not in text E AssertionError: assert 'foo' not in 'head head h...l tail tail ' E 'foo' is contained here: E head head foo tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail E ? +++ failure_demo.py:93: AssertionError ______ TestSpecialisedExplanations.test_not_in_text_single_long_term _______ self = def test_not_in_text_single_long_term(self): text = "head " * 50 + "f" * 70 + "tail " * 20 > assert "f" * 70 not in text E AssertionError: assert 'fffffffffff...ffffffffffff' not in 'head head h...l tail tail ' E 'ffffffffffffffffff...fffffffffffffffffff' is contained here: E head head fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffftail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail E ? ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ failure_demo.py:97: AssertionError ______________ TestSpecialisedExplanations.test_eq_dataclass _______________ self = def test_eq_dataclass(self): from dataclasses import dataclass @dataclass class Foo: a: int b: str left = Foo(1, "b") right = Foo(1, "c") > assert left == right E AssertionError: assert TestSpecialis...oo(a=1, b='b') == TestSpecialis...oo(a=1, b='c') E Omitting 1 identical items, use -vv to show E Differing attributes: E b: 'b' != 'c' failure_demo.py:109: AssertionError ________________ TestSpecialisedExplanations.test_eq_attrs _________________ self = def test_eq_attrs(self): import attr @attr.s class Foo: a = attr.ib() b = attr.ib() left = Foo(1, "b") right = Foo(1, "c") > assert left == right E AssertionError: assert Foo(a=1, b='b') == Foo(a=1, b='c') E Omitting 1 identical items, use -vv to show E Differing attributes: E b: 'b' != 'c' failure_demo.py:121: AssertionError ______________________________ test_attribute ______________________________ def test_attribute(): class Foo: b = 1 i = Foo() > assert i.b == 2 E assert 1 == 2 E + where 1 = .Foo object at 0xdeadbeef>.b failure_demo.py:129: AssertionError _________________________ test_attribute_instance __________________________ def test_attribute_instance(): class Foo: b = 1 > assert Foo().b == 2 E AssertionError: assert 1 == 2 E + where 1 = .Foo object at 0xdeadbeef>.b E + where .Foo object at 0xdeadbeef> = .Foo'>() failure_demo.py:136: AssertionError __________________________ test_attribute_failure __________________________ def test_attribute_failure(): class Foo: def _get_b(self): raise Exception("Failed to get attrib") b = property(_get_b) i = Foo() > assert i.b == 2 failure_demo.py:147: _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ self = .Foo object at 0xdeadbeef> def _get_b(self): > raise Exception("Failed to get attrib") E Exception: Failed to get attrib failure_demo.py:142: Exception _________________________ test_attribute_multiple __________________________ def test_attribute_multiple(): class Foo: b = 1 class Bar: b = 2 > assert Foo().b == Bar().b E AssertionError: assert 1 == 2 E + where 1 = .Foo object at 0xdeadbeef>.b E + where .Foo object at 0xdeadbeef> = .Foo'>() E + and 2 = .Bar object at 0xdeadbeef>.b E + where .Bar object at 0xdeadbeef> = .Bar'>() failure_demo.py:157: AssertionError __________________________ TestRaises.test_raises __________________________ self = def test_raises(self): s = "qwe" > raises(TypeError, int, s) E ValueError: invalid literal for int() with base 10: 'qwe' failure_demo.py:167: ValueError ______________________ TestRaises.test_raises_doesnt _______________________ self = def test_raises_doesnt(self): > raises(OSError, int, "3") E Failed: DID NOT RAISE failure_demo.py:170: Failed __________________________ TestRaises.test_raise ___________________________ self = def test_raise(self): > raise ValueError("demo error") E ValueError: demo error failure_demo.py:173: ValueError ________________________ TestRaises.test_tupleerror ________________________ self = def test_tupleerror(self): > a, b = [1] # NOQA E ValueError: not enough values to unpack (expected 2, got 1) failure_demo.py:176: ValueError ______ TestRaises.test_reinterpret_fails_with_print_for_the_fun_of_it ______ self = def test_reinterpret_fails_with_print_for_the_fun_of_it(self): items = [1, 2, 3] print("items is {!r}".format(items)) > a, b = items.pop() E TypeError: cannot unpack non-iterable int object failure_demo.py:181: TypeError --------------------------- Captured stdout call --------------------------- items is [1, 2, 3] ________________________ TestRaises.test_some_error ________________________ self = def test_some_error(self): > if namenotexi: # NOQA E NameError: name 'namenotexi' is not defined failure_demo.py:184: NameError ____________________ test_dynamic_compile_shows_nicely _____________________ def test_dynamic_compile_shows_nicely(): import importlib.util import sys src = "def foo():\n assert 1 == 0\n" name = "abc-123" spec = importlib.util.spec_from_loader(name, loader=None) module = importlib.util.module_from_spec(spec) code = _pytest._code.compile(src, name, "exec") exec(code, module.__dict__) sys.modules[name] = module > module.foo() failure_demo.py:203: _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ def foo(): > assert 1 == 0 E AssertionError <0-codegen 'abc-123' $REGENDOC_TMPDIR/assertion/failure_demo.py:200>:2: AssertionError ____________________ TestMoreErrors.test_complex_error _____________________ self = def test_complex_error(self): def f(): return 44 def g(): return 43 > somefunc(f(), g()) failure_demo.py:214: _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ failure_demo.py:11: in somefunc otherfunc(x, y) _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ a = 44, b = 43 def otherfunc(a, b): > assert a == b E assert 44 == 43 failure_demo.py:7: AssertionError ___________________ TestMoreErrors.test_z1_unpack_error ____________________ self = def test_z1_unpack_error(self): items = [] > a, b = items E ValueError: not enough values to unpack (expected 2, got 0) failure_demo.py:218: ValueError ____________________ TestMoreErrors.test_z2_type_error _____________________ self = def test_z2_type_error(self): items = 3 > a, b = items E TypeError: cannot unpack non-iterable int object failure_demo.py:222: TypeError ______________________ TestMoreErrors.test_startswith ______________________ self = def test_startswith(self): s = "123" g = "456" > assert s.startswith(g) E AssertionError: assert False E + where False = ('456') E + where = '123'.startswith failure_demo.py:227: AssertionError __________________ TestMoreErrors.test_startswith_nested ___________________ self = def test_startswith_nested(self): def f(): return "123" def g(): return "456" > assert f().startswith(g()) E AssertionError: assert False E + where False = ('456') E + where = '123'.startswith E + where '123' = .f at 0xdeadbeef>() E + and '456' = .g at 0xdeadbeef>() failure_demo.py:236: AssertionError _____________________ TestMoreErrors.test_global_func ______________________ self = def test_global_func(self): > assert isinstance(globf(42), float) E assert False E + where False = isinstance(43, float) E + where 43 = globf(42) failure_demo.py:239: AssertionError _______________________ TestMoreErrors.test_instance _______________________ self = def test_instance(self): self.x = 6 * 7 > assert self.x != 42 E assert 42 != 42 E + where 42 = .x failure_demo.py:243: AssertionError _______________________ TestMoreErrors.test_compare ________________________ self = def test_compare(self): > assert globf(10) < 5 E assert 11 < 5 E + where 11 = globf(10) failure_demo.py:246: AssertionError _____________________ TestMoreErrors.test_try_finally ______________________ self = def test_try_finally(self): x = 1 try: > assert x == 0 E assert 1 == 0 failure_demo.py:251: AssertionError ___________________ TestCustomAssertMsg.test_single_line ___________________ self = def test_single_line(self): class A: a = 1 b = 2 > assert A.a == b, "A.a appears not to be b" E AssertionError: A.a appears not to be b E assert 1 == 2 E + where 1 = .A'>.a failure_demo.py:262: AssertionError ____________________ TestCustomAssertMsg.test_multiline ____________________ self = def test_multiline(self): class A: a = 1 b = 2 > assert ( A.a == b ), "A.a appears not to be b\nor does not appear to be b\none of those" E AssertionError: A.a appears not to be b E or does not appear to be b E one of those E assert 1 == 2 E + where 1 = .A'>.a failure_demo.py:269: AssertionError ___________________ TestCustomAssertMsg.test_custom_repr ___________________ self = def test_custom_repr(self): class JSON: a = 1 def __repr__(self): return "This is JSON\n{\n 'foo': 'bar'\n}" a = JSON() b = 2 > assert a.a == b, a E AssertionError: This is JSON E { E 'foo': 'bar' E } E assert 1 == 2 E + where 1 = This is JSON\n{\n 'foo': 'bar'\n}.a failure_demo.py:282: AssertionError ========================= short test summary info ========================== FAILED failure_demo.py::test_generative[3-6] - assert (3 * 2) < 6 FAILED failure_demo.py::TestFailing::test_simple - assert 42 == 43 FAILED failure_demo.py::TestFailing::test_simple_multiline - assert 42 == 54 FAILED failure_demo.py::TestFailing::test_not - assert not 42 FAILED failure_demo.py::TestSpecialisedExplanations::test_eq_text - Asser... FAILED failure_demo.py::TestSpecialisedExplanations::test_eq_similar_text FAILED failure_demo.py::TestSpecialisedExplanations::test_eq_multiline_text FAILED failure_demo.py::TestSpecialisedExplanations::test_eq_long_text - ... FAILED failure_demo.py::TestSpecialisedExplanations::test_eq_long_text_multiline FAILED failure_demo.py::TestSpecialisedExplanations::test_eq_list - asser... FAILED failure_demo.py::TestSpecialisedExplanations::test_eq_list_long - ... FAILED failure_demo.py::TestSpecialisedExplanations::test_eq_dict - Asser... FAILED failure_demo.py::TestSpecialisedExplanations::test_eq_set - Assert... FAILED failure_demo.py::TestSpecialisedExplanations::test_eq_longer_list FAILED failure_demo.py::TestSpecialisedExplanations::test_in_list - asser... FAILED failure_demo.py::TestSpecialisedExplanations::test_not_in_text_multiline FAILED failure_demo.py::TestSpecialisedExplanations::test_not_in_text_single FAILED failure_demo.py::TestSpecialisedExplanations::test_not_in_text_single_long FAILED failure_demo.py::TestSpecialisedExplanations::test_not_in_text_single_long_term FAILED failure_demo.py::TestSpecialisedExplanations::test_eq_dataclass - ... FAILED failure_demo.py::TestSpecialisedExplanations::test_eq_attrs - Asse... FAILED failure_demo.py::test_attribute - assert 1 == 2 FAILED failure_demo.py::test_attribute_instance - AssertionError: assert ... FAILED failure_demo.py::test_attribute_failure - Exception: Failed to get... FAILED failure_demo.py::test_attribute_multiple - AssertionError: assert ... FAILED failure_demo.py::TestRaises::test_raises - ValueError: invalid lit... FAILED failure_demo.py::TestRaises::test_raises_doesnt - Failed: DID NOT ... FAILED failure_demo.py::TestRaises::test_raise - ValueError: demo error FAILED failure_demo.py::TestRaises::test_tupleerror - ValueError: not eno... FAILED failure_demo.py::TestRaises::test_reinterpret_fails_with_print_for_the_fun_of_it FAILED failure_demo.py::TestRaises::test_some_error - NameError: name 'na... FAILED failure_demo.py::test_dynamic_compile_shows_nicely - AssertionError FAILED failure_demo.py::TestMoreErrors::test_complex_error - assert 44 == 43 FAILED failure_demo.py::TestMoreErrors::test_z1_unpack_error - ValueError... FAILED failure_demo.py::TestMoreErrors::test_z2_type_error - TypeError: c... FAILED failure_demo.py::TestMoreErrors::test_startswith - AssertionError:... FAILED failure_demo.py::TestMoreErrors::test_startswith_nested - Assertio... FAILED failure_demo.py::TestMoreErrors::test_global_func - assert False FAILED failure_demo.py::TestMoreErrors::test_instance - assert 42 != 42 FAILED failure_demo.py::TestMoreErrors::test_compare - assert 11 < 5 FAILED failure_demo.py::TestMoreErrors::test_try_finally - assert 1 == 0 FAILED failure_demo.py::TestCustomAssertMsg::test_single_line - Assertion... FAILED failure_demo.py::TestCustomAssertMsg::test_multiline - AssertionEr... FAILED failure_demo.py::TestCustomAssertMsg::test_custom_repr - Assertion... ============================ 44 failed in 0.12s ============================