regen docs with examples

This commit is contained in:
holger krekel 2011-02-07 11:45:37 +01:00
parent e7b69a2ac0
commit 98cd8edb71
11 changed files with 80 additions and 76 deletions

View File

@ -50,7 +50,7 @@ of the failing function and hide the other one::
test_module.py:9: AssertionError
----------------------------- Captured stdout ------------------------------
setting up <function test_func2 at 0x15379b0>
setting up <function test_func2 at 0x2897d70>
==================== 1 failed, 1 passed in 0.02 seconds ====================
Setting capturing methods or disabling capturing

View File

@ -49,4 +49,4 @@ then you can just invoke ``py.test`` without command line options::
mymodule.py .
========================= 1 passed in 0.01 seconds =========================
========================= 1 passed in 0.02 seconds =========================

View File

@ -57,7 +57,7 @@ You can now run the test::
================================= FAILURES =================================
_______________________________ test_answer ________________________________
mysetup = <conftest.MySetup instance at 0x1f2bdd0>
mysetup = <conftest.MySetup instance at 0x2526440>
def test_answer(mysetup):
app = mysetup.myapp()
@ -127,7 +127,7 @@ Running it yields::
test_ssh.py s
========================= short test summary info ==========================
SKIP [1] /tmp/doc-exec-77/conftest.py:22: specify ssh host with --ssh
SKIP [1] /tmp/doc-exec-166/conftest.py:22: specify ssh host with --ssh
======================== 1 skipped in 0.02 seconds =========================

View File

@ -37,7 +37,7 @@ now execute the test specification::
usecase execution failed
spec failed: 'some': 'other'
no further details known at this point.
==================== 1 failed, 1 passed in 0.15 seconds ====================
==================== 1 failed, 1 passed in 0.06 seconds ====================
You get one dot for the passing ``sub1: sub1`` check and one failure.
Obviously in the above ``conftest.py`` you'll want to implement a more

View File

@ -46,7 +46,7 @@ the respective settings::
================================= FAILURES =================================
_________________________ TestClass.test_equals[0] _________________________
self = <test_parametrize.TestClass instance at 0x10c1f80>, a = 1, b = 2
self = <test_parametrize.TestClass instance at 0x1521440>, a = 1, b = 2
def test_equals(self, a, b):
> assert a == b
@ -55,7 +55,7 @@ the respective settings::
test_parametrize.py:17: AssertionError
______________________ TestClass.test_zerodivision[1] ______________________
self = <test_parametrize.TestClass instance at 0x10c8bd8>, a = 3, b = 2
self = <test_parametrize.TestClass instance at 0x158aa70>, a = 3, b = 2
def test_zerodivision(self, a, b):
> pytest.raises(ZeroDivisionError, "a/b")
@ -103,7 +103,7 @@ Running it gives similar results as before::
================================= FAILURES =================================
_________________________ TestClass.test_equals[0] _________________________
self = <test_parametrize2.TestClass instance at 0x2484ab8>, a = 1, b = 2
self = <test_parametrize2.TestClass instance at 0x22a77e8>, a = 1, b = 2
@params([dict(a=1, b=2), dict(a=3, b=3), ])
def test_equals(self, a, b):
@ -113,7 +113,7 @@ Running it gives similar results as before::
test_parametrize2.py:19: AssertionError
______________________ TestClass.test_zerodivision[1] ______________________
self = <test_parametrize2.TestClass instance at 0x248da70>, a = 3, b = 2
self = <test_parametrize2.TestClass instance at 0x2332a70>, a = 3, b = 2
@params([dict(a=1, b=0), dict(a=3, b=2)])
def test_zerodivision(self, a, b):
@ -142,4 +142,4 @@ Running it (with Python-2.4 through to Python2.7 installed)::
. $ py.test -q multipython.py
collecting ... collected 75 items
....s....s....s....ssssss....s....s....s....ssssss....s....s....s....ssssss
48 passed, 27 skipped in 2.08 seconds
48 passed, 27 skipped in 2.09 seconds

View File

@ -30,7 +30,7 @@ get on the terminal - we are working on that):
failure_demo.py:15: AssertionError
_________________________ TestFailing.test_simple __________________________
self = <failure_demo.TestFailing object at 0x1deab90>
self = <failure_demo.TestFailing object at 0x1b42950>
def test_simple(self):
def f():
@ -40,13 +40,13 @@ get on the terminal - we are working on that):
> assert f() == g()
E assert 42 == 43
E + where 42 = <function f at 0x1df1c80>()
E + and 43 = <function g at 0x1df1938>()
E + where 42 = <function f at 0x1b33de8>()
E + and 43 = <function g at 0x1b47140>()
failure_demo.py:28: AssertionError
____________________ TestFailing.test_simple_multiline _____________________
self = <failure_demo.TestFailing object at 0x1df58d0>
self = <failure_demo.TestFailing object at 0x1b42c50>
def test_simple_multiline(self):
otherfunc_multi(
@ -66,19 +66,19 @@ get on the terminal - we are working on that):
failure_demo.py:12: AssertionError
___________________________ TestFailing.test_not ___________________________
self = <failure_demo.TestFailing object at 0x1dea390>
self = <failure_demo.TestFailing object at 0x1b42190>
def test_not(self):
def f():
return 42
> assert not f()
E assert not 42
E + where 42 = <function f at 0x1df1c80>()
E + where 42 = <function f at 0x1b47320>()
failure_demo.py:38: AssertionError
_________________ TestSpecialisedExplanations.test_eq_text _________________
self = <failure_demo.TestSpecialisedExplanations object at 0x1df5cd0>
self = <failure_demo.TestSpecialisedExplanations object at 0x1b42150>
def test_eq_text(self):
> assert 'spam' == 'eggs'
@ -89,7 +89,7 @@ get on the terminal - we are working on that):
failure_demo.py:42: AssertionError
_____________ TestSpecialisedExplanations.test_eq_similar_text _____________
self = <failure_demo.TestSpecialisedExplanations object at 0x1e73b50>
self = <failure_demo.TestSpecialisedExplanations object at 0x1b48610>
def test_eq_similar_text(self):
> assert 'foo 1 bar' == 'foo 2 bar'
@ -102,7 +102,7 @@ get on the terminal - we are working on that):
failure_demo.py:45: AssertionError
____________ TestSpecialisedExplanations.test_eq_multiline_text ____________
self = <failure_demo.TestSpecialisedExplanations object at 0x1de4b50>
self = <failure_demo.TestSpecialisedExplanations object at 0x1b38f90>
def test_eq_multiline_text(self):
> assert 'foo\nspam\nbar' == 'foo\neggs\nbar'
@ -115,7 +115,7 @@ get on the terminal - we are working on that):
failure_demo.py:48: AssertionError
______________ TestSpecialisedExplanations.test_eq_long_text _______________
self = <failure_demo.TestSpecialisedExplanations object at 0x1deac90>
self = <failure_demo.TestSpecialisedExplanations object at 0x1b42cd0>
def test_eq_long_text(self):
a = '1'*100 + 'a' + '2'*100
@ -132,7 +132,7 @@ get on the terminal - we are working on that):
failure_demo.py:53: AssertionError
_________ TestSpecialisedExplanations.test_eq_long_text_multiline __________
self = <failure_demo.TestSpecialisedExplanations object at 0x1e73ed0>
self = <failure_demo.TestSpecialisedExplanations object at 0x1ba6a90>
def test_eq_long_text_multiline(self):
a = '1\n'*100 + 'a' + '2\n'*100
@ -156,7 +156,7 @@ get on the terminal - we are working on that):
failure_demo.py:58: AssertionError
_________________ TestSpecialisedExplanations.test_eq_list _________________
self = <failure_demo.TestSpecialisedExplanations object at 0x1e73d10>
self = <failure_demo.TestSpecialisedExplanations object at 0x1ba6bd0>
def test_eq_list(self):
> assert [0, 1, 2] == [0, 1, 3]
@ -166,7 +166,7 @@ get on the terminal - we are working on that):
failure_demo.py:61: AssertionError
______________ TestSpecialisedExplanations.test_eq_list_long _______________
self = <failure_demo.TestSpecialisedExplanations object at 0x1e78850>
self = <failure_demo.TestSpecialisedExplanations object at 0x1b42910>
def test_eq_list_long(self):
a = [0]*100 + [1] + [3]*100
@ -178,7 +178,7 @@ get on the terminal - we are working on that):
failure_demo.py:66: AssertionError
_________________ TestSpecialisedExplanations.test_eq_dict _________________
self = <failure_demo.TestSpecialisedExplanations object at 0x1df5f50>
self = <failure_demo.TestSpecialisedExplanations object at 0x1ba6f90>
def test_eq_dict(self):
> assert {'a': 0, 'b': 1} == {'a': 0, 'b': 2}
@ -191,7 +191,7 @@ get on the terminal - we are working on that):
failure_demo.py:69: AssertionError
_________________ TestSpecialisedExplanations.test_eq_set __________________
self = <failure_demo.TestSpecialisedExplanations object at 0x1e786d0>
self = <failure_demo.TestSpecialisedExplanations object at 0x1b485d0>
def test_eq_set(self):
> assert set([0, 10, 11, 12]) == set([0, 20, 21])
@ -207,7 +207,7 @@ get on the terminal - we are working on that):
failure_demo.py:72: AssertionError
_____________ TestSpecialisedExplanations.test_eq_longer_list ______________
self = <failure_demo.TestSpecialisedExplanations object at 0x1deaa10>
self = <failure_demo.TestSpecialisedExplanations object at 0x1ba2850>
def test_eq_longer_list(self):
> assert [1,2] == [1,2,3]
@ -217,7 +217,7 @@ get on the terminal - we are working on that):
failure_demo.py:75: AssertionError
_________________ TestSpecialisedExplanations.test_in_list _________________
self = <failure_demo.TestSpecialisedExplanations object at 0x1e84110>
self = <failure_demo.TestSpecialisedExplanations object at 0x1ba2f10>
def test_in_list(self):
> assert 1 in [0, 2, 3, 4, 5]
@ -226,7 +226,7 @@ get on the terminal - we are working on that):
failure_demo.py:78: AssertionError
__________ TestSpecialisedExplanations.test_not_in_text_multiline __________
self = <failure_demo.TestSpecialisedExplanations object at 0x1e84890>
self = <failure_demo.TestSpecialisedExplanations object at 0x1ba2990>
def test_not_in_text_multiline(self):
text = 'some multiline\ntext\nwhich\nincludes foo\nand a\ntail'
@ -244,7 +244,7 @@ get on the terminal - we are working on that):
failure_demo.py:82: AssertionError
___________ TestSpecialisedExplanations.test_not_in_text_single ____________
self = <failure_demo.TestSpecialisedExplanations object at 0x1e84d90>
self = <failure_demo.TestSpecialisedExplanations object at 0x1b42110>
def test_not_in_text_single(self):
text = 'single foo line'
@ -257,7 +257,7 @@ get on the terminal - we are working on that):
failure_demo.py:86: AssertionError
_________ TestSpecialisedExplanations.test_not_in_text_single_long _________
self = <failure_demo.TestSpecialisedExplanations object at 0x1e84650>
self = <failure_demo.TestSpecialisedExplanations object at 0x1ba65d0>
def test_not_in_text_single_long(self):
text = 'head ' * 50 + 'foo ' + 'tail ' * 20
@ -270,7 +270,7 @@ get on the terminal - we are working on that):
failure_demo.py:90: AssertionError
______ TestSpecialisedExplanations.test_not_in_text_single_long_term _______
self = <failure_demo.TestSpecialisedExplanations object at 0x1e78fd0>
self = <failure_demo.TestSpecialisedExplanations object at 0x1ba2c50>
def test_not_in_text_single_long_term(self):
text = 'head ' * 50 + 'f'*70 + 'tail ' * 20
@ -289,7 +289,7 @@ get on the terminal - we are working on that):
i = Foo()
> assert i.b == 2
E assert 1 == 2
E + where 1 = <failure_demo.Foo object at 0x1e84fd0>.b
E + where 1 = <failure_demo.Foo object at 0x1ba2ad0>.b
failure_demo.py:101: AssertionError
_________________________ test_attribute_instance __________________________
@ -299,8 +299,8 @@ get on the terminal - we are working on that):
b = 1
> assert Foo().b == 2
E assert 1 == 2
E + where 1 = <failure_demo.Foo object at 0x1e78810>.b
E + where <failure_demo.Foo object at 0x1e78810> = <class 'failure_demo.Foo'>()
E + where 1 = <failure_demo.Foo object at 0x1ba2110>.b
E + where <failure_demo.Foo object at 0x1ba2110> = <class 'failure_demo.Foo'>()
failure_demo.py:107: AssertionError
__________________________ test_attribute_failure __________________________
@ -316,7 +316,7 @@ get on the terminal - we are working on that):
failure_demo.py:116:
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
self = <failure_demo.Foo object at 0x1df5510>
self = <failure_demo.Foo object at 0x1ba2a90>
def _get_b(self):
> raise Exception('Failed to get attrib')
@ -332,15 +332,15 @@ get on the terminal - we are working on that):
b = 2
> assert Foo().b == Bar().b
E assert 1 == 2
E + where 1 = <failure_demo.Foo object at 0x1e78c50>.b
E + where <failure_demo.Foo object at 0x1e78c50> = <class 'failure_demo.Foo'>()
E + and 2 = <failure_demo.Bar object at 0x1e78b10>.b
E + where <failure_demo.Bar object at 0x1e78b10> = <class 'failure_demo.Bar'>()
E + where 1 = <failure_demo.Foo object at 0x1ba2950>.b
E + where <failure_demo.Foo object at 0x1ba2950> = <class 'failure_demo.Foo'>()
E + and 2 = <failure_demo.Bar object at 0x1ba2390>.b
E + where <failure_demo.Bar object at 0x1ba2390> = <class 'failure_demo.Bar'>()
failure_demo.py:124: AssertionError
__________________________ TestRaises.test_raises __________________________
self = <failure_demo.TestRaises instance at 0x1e85ef0>
self = <failure_demo.TestRaises instance at 0x1bb3488>
def test_raises(self):
s = 'qwe'
@ -355,7 +355,7 @@ get on the terminal - we are working on that):
<0-codegen /home/hpk/p/pytest/_pytest/python.py:822>:1: ValueError
______________________ TestRaises.test_raises_doesnt _______________________
self = <failure_demo.TestRaises instance at 0x1e8f710>
self = <failure_demo.TestRaises instance at 0x1bb3098>
def test_raises_doesnt(self):
> raises(IOError, "int('3')")
@ -364,7 +364,7 @@ get on the terminal - we are working on that):
failure_demo.py:136: Failed
__________________________ TestRaises.test_raise ___________________________
self = <failure_demo.TestRaises instance at 0x1e8b950>
self = <failure_demo.TestRaises instance at 0x1ba7d40>
def test_raise(self):
> raise ValueError("demo error")
@ -373,7 +373,7 @@ get on the terminal - we are working on that):
failure_demo.py:139: ValueError
________________________ TestRaises.test_tupleerror ________________________
self = <failure_demo.TestRaises instance at 0x1e80f38>
self = <failure_demo.TestRaises instance at 0x1b5cc68>
def test_tupleerror(self):
> a,b = [1]
@ -382,7 +382,7 @@ get on the terminal - we are working on that):
failure_demo.py:142: ValueError
______ TestRaises.test_reinterpret_fails_with_print_for_the_fun_of_it ______
self = <failure_demo.TestRaises instance at 0x1df4b00>
self = <failure_demo.TestRaises instance at 0x1bb1488>
def test_reinterpret_fails_with_print_for_the_fun_of_it(self):
l = [1,2,3]
@ -395,7 +395,7 @@ get on the terminal - we are working on that):
l is [1, 2, 3]
________________________ TestRaises.test_some_error ________________________
self = <failure_demo.TestRaises instance at 0x1e91878>
self = <failure_demo.TestRaises instance at 0x1bb9128>
def test_some_error(self):
> if namenotexi:
@ -423,7 +423,7 @@ get on the terminal - we are working on that):
<2-codegen 'abc-123' /home/hpk/p/pytest/doc/example/assertion/failure_demo.py:162>:2: AssertionError
____________________ TestMoreErrors.test_complex_error _____________________
self = <failure_demo.TestMoreErrors instance at 0x1e93a28>
self = <failure_demo.TestMoreErrors instance at 0x1bb8f80>
def test_complex_error(self):
def f():
@ -452,7 +452,7 @@ get on the terminal - we are working on that):
failure_demo.py:5: AssertionError
___________________ TestMoreErrors.test_z1_unpack_error ____________________
self = <failure_demo.TestMoreErrors instance at 0x1e916c8>
self = <failure_demo.TestMoreErrors instance at 0x1bab200>
def test_z1_unpack_error(self):
l = []
@ -462,7 +462,7 @@ get on the terminal - we are working on that):
failure_demo.py:179: ValueError
____________________ TestMoreErrors.test_z2_type_error _____________________
self = <failure_demo.TestMoreErrors instance at 0x1e7db00>
self = <failure_demo.TestMoreErrors instance at 0x1bb36c8>
def test_z2_type_error(self):
l = 3
@ -472,19 +472,20 @@ get on the terminal - we are working on that):
failure_demo.py:183: TypeError
______________________ TestMoreErrors.test_startswith ______________________
self = <failure_demo.TestMoreErrors instance at 0x1de3a28>
self = <failure_demo.TestMoreErrors instance at 0x1bbce60>
def test_startswith(self):
s = "123"
g = "456"
> assert s.startswith(g)
E assert <built-in method startswith of str object at 0x1dfa150>('456')
E + where <built-in method startswith of str object at 0x1dfa150> = '123'.startswith
E assert False
E + where False = <built-in method startswith of str object at 0x1ad6bd0>('456')
E + where <built-in method startswith of str object at 0x1ad6bd0> = '123'.startswith
failure_demo.py:188: AssertionError
__________________ TestMoreErrors.test_startswith_nested ___________________
self = <failure_demo.TestMoreErrors instance at 0x1e980e0>
self = <failure_demo.TestMoreErrors instance at 0x1bbeb48>
def test_startswith_nested(self):
def f():
@ -492,37 +493,39 @@ get on the terminal - we are working on that):
def g():
return "456"
> assert f().startswith(g())
E assert <built-in method startswith of str object at 0x1dfa150>('456')
E + where <built-in method startswith of str object at 0x1dfa150> = '123'.startswith
E + where '123' = <function f at 0x1e880c8>()
E + and '456' = <function g at 0x1e88398>()
E assert False
E + where False = <built-in method startswith of str object at 0x1ad6bd0>('456')
E + where <built-in method startswith of str object at 0x1ad6bd0> = '123'.startswith
E + where '123' = <function f at 0x1baade8>()
E + and '456' = <function g at 0x1baad70>()
failure_demo.py:195: AssertionError
_____________________ TestMoreErrors.test_global_func ______________________
self = <failure_demo.TestMoreErrors instance at 0x1e98ea8>
self = <failure_demo.TestMoreErrors instance at 0x1bbe098>
def test_global_func(self):
> assert isinstance(globf(42), float)
E assert isinstance(43, float)
E assert False
E + where False = isinstance(43, float)
E + where 43 = globf(42)
failure_demo.py:198: AssertionError
_______________________ TestMoreErrors.test_instance _______________________
self = <failure_demo.TestMoreErrors instance at 0x1e98518>
self = <failure_demo.TestMoreErrors instance at 0x1ba7bd8>
def test_instance(self):
self.x = 6*7
> assert self.x != 42
E assert 42 != 42
E + where 42 = 42
E + where 42 = <failure_demo.TestMoreErrors instance at 0x1e98518>.x
E + where 42 = <failure_demo.TestMoreErrors instance at 0x1ba7bd8>.x
failure_demo.py:202: AssertionError
_______________________ TestMoreErrors.test_compare ________________________
self = <failure_demo.TestMoreErrors instance at 0x1e80e60>
self = <failure_demo.TestMoreErrors instance at 0x1bbca28>
def test_compare(self):
> assert globf(10) < 5
@ -532,7 +535,7 @@ get on the terminal - we are working on that):
failure_demo.py:205: AssertionError
_____________________ TestMoreErrors.test_try_finally ______________________
self = <failure_demo.TestMoreErrors instance at 0x1e91b00>
self = <failure_demo.TestMoreErrors instance at 0x1bc0908>
def test_try_finally(self):
x = 1

View File

@ -138,7 +138,7 @@ let's run the full monty::
E assert 4 < 4
test_compute.py:3: AssertionError
1 failed, 4 passed in 0.02 seconds
1 failed, 4 passed in 0.03 seconds
As expected when running the full range of ``param1`` values
we'll get an error on the last one.
@ -173,7 +173,7 @@ directory with the above conftest.py::
scheduling tests via LoadScheduling
============================= in 0.31 seconds =============================
============================= in 0.29 seconds =============================
.. _`retrieved by hooks as item keywords`:
@ -219,7 +219,7 @@ and when running it will see a skipped "slow" test::
test_module.py .s
========================= short test summary info ==========================
SKIP [1] /tmp/doc-exec-82/conftest.py:9: need --runslow option to run
SKIP [1] /tmp/doc-exec-171/conftest.py:9: need --runslow option to run
=================== 1 passed, 1 skipped in 0.02 seconds ====================

View File

@ -100,7 +100,7 @@ Running it with, this time in "quiet" reporting mode::
$ py.test -q test_sysexit.py
collecting ... collected 1 items
.
1 passed in 0.00 seconds
1 passed in 0.01 seconds
.. todo:: For further ways to assert exceptions see the `raises`
@ -131,12 +131,13 @@ run the module by passing its filename::
================================= FAILURES =================================
____________________________ TestClass.test_two ____________________________
self = <test_class.TestClass instance at 0x17ab998>
self = <test_class.TestClass instance at 0x178b2d8>
def test_two(self):
x = "hello"
> assert hasattr(x, 'check')
E assert hasattr('hello', 'check')
E assert False
E + where False = hasattr('hello', 'check')
test_class.py:8: AssertionError
1 failed, 1 passed in 0.02 seconds
@ -168,7 +169,7 @@ before performing the test function call. Let's just run it::
================================= FAILURES =================================
_____________________________ test_needsfiles ______________________________
tmpdir = local('/tmp/pytest-9/test_needsfiles0')
tmpdir = local('/tmp/pytest-101/test_needsfiles0')
def test_needsfiles(tmpdir):
print tmpdir
@ -177,8 +178,8 @@ before performing the test function call. Let's just run it::
test_tmpdir.py:3: AssertionError
----------------------------- Captured stdout ------------------------------
/tmp/pytest-9/test_needsfiles0
1 failed in 0.02 seconds
/tmp/pytest-101/test_needsfiles0
1 failed in 0.03 seconds
Before the test runs, a unique-per-test-invocation temporary directory
was created. More info at :ref:`tmpdir handling`.

View File

@ -136,7 +136,7 @@ Running it with the report-on-xfail option gives this output::
XFAIL xfail_demo.py::test_hello5
reason: reason
======================== 5 xfailed in 0.05 seconds =========================
======================== 5 xfailed in 0.04 seconds =========================
imperative xfail from within a test or setup function
------------------------------------------------------

View File

@ -36,7 +36,7 @@ Running this would result in a passed test except for the last
================================= FAILURES =================================
_____________________________ test_create_file _____________________________
tmpdir = local('/tmp/pytest-10/test_create_file0')
tmpdir = local('/tmp/pytest-102/test_create_file0')
def test_create_file(tmpdir):
p = tmpdir.mkdir("sub").join("hello.txt")
@ -47,7 +47,7 @@ Running this would result in a passed test except for the last
E assert 0
test_tmpdir.py:7: AssertionError
========================= 1 failed in 0.02 seconds =========================
========================= 1 failed in 0.03 seconds =========================
.. _`base temporary directory`:

View File

@ -56,7 +56,7 @@ Running it yields::
/usr/lib/python2.6/unittest.py:350: AssertionError
----------------------------- Captured stdout ------------------------------
hello
========================= 1 failed in 0.02 seconds =========================
========================= 1 failed in 0.03 seconds =========================
.. _`unittest.py style`: http://docs.python.org/library/unittest.html