some more improvements and updates to docs, add release announcements

doc/announce/index.txt

@@ -0,0 +1,22 @@
+
+Release announcements
+===========================================
+
+.. toctree::
+   :maxdepth: 2
+
+   release-2.0.0
+   release-1.3.4
+   release-1.3.3
+   release-1.3.2
+   release-1.3.1
+   release-1.3.0
+   release-1.2.1
+   release-1.2.0
+   release-1.1.1
+   release-1.1.0
+   release-1.0.2
+   release-1.0.1
+   release-1.0.0
+   release-0.9.2
+   release-0.9.0

doc/announce/release-2.0.0.txt

@@ -0,0 +1,50 @@
+py.test 2.0.0: standalone, features++, implementation++, docs++
+===========================================================================
+
+XXX PENDING
+
+Welcome to pytest-2.0.0!  With this release py.test becomes its own standalone
+PyPI distribution, named ``pytest``, installing the ``py.test`` command line
+tool.  Apart from a great internal cleanup this release comes with tons
+of improvements and new features and a completely revamped extensive
+documentation, including many continously tested examples. See
+
+    http://pytest.org
+
+New Features
+-----------------------
+
+- new invocations through Python interpreter and from Python::
+
+    python -m pytest      # on all pythons >= 2.7
+    python -m pytest.main # on all pythons >= 2.5
+    import pytest ; pytest.main(args, plugins)
+
+  see http://pytest.org/2.0.0/invoke.html for details.
+
+- new configuration through ini-files (setup.cfg or tox.ini recognized),
+  for example::
+
+    [pytest]
+    norecursedirs = .hg _build
+    python_collect_funcprefix = test_
+    python_collect_classprefix = Test
+
+  see http://pytest.org/2.0.0/customize.html
+
+-
+
+Thanks to issue reporters, people asking questions, complaining and
+generally to Ronny Pfannschmidt for his awesome help on many issues.
+
+cheers,
+holger krekel
+
+Changes between 1.3.3 and 1.3.4
+==================================================
+
+- fix issue111: improve install documentation for windows
+- fix issue119: fix custom collectability of __init__.py as a module
+- fix issue116: --doctestmodules work with __init__.py files as well
+- fix issue115: unify internal exception passthrough/catching/GeneratorExit
+- fix issue118: new --tb=native for presenting cpython-standard exceptions

doc/announce/releases.txt

@@ -1,16 +0,0 @@
-=============
-Release notes
-=============
-
-Contents:
-
-.. toctree::
-   :maxdepth: 2
-
-.. include: release-1.1.0
-.. include: release-1.0.2
-
-   release-1.0.1
-   release-1.0.0
-   release-0.9.2
-   release-0.9.0

doc/apiref.txt

@@ -20,5 +20,6 @@ py.test reference documentation
    mark.txt
    recwarn.txt
    unittest.txt
+   nose.txt
    doctest.txt
 

doc/assert.txt

@@ -21,7 +21,7 @@ assertion fails you will see the value of ``x``::
 
     $ py.test test_assert1.py
     =========================== test session starts ============================
-    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev17
+    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev19
     test path 1: test_assert1.py
     
     test_assert1.py F
@@ -101,7 +101,7 @@ if you run this module::
 
     $ py.test test_assert2.py
     =========================== test session starts ============================
-    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev17
+    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev19
     test path 1: test_assert2.py
     
     test_assert2.py F

doc/conf.py

@@ -25,7 +25,7 @@ import sys, os
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo',
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.autosummary',
     'sphinx.ext.intersphinx', 'sphinx.ext.viewcode']
 
 # Add any paths that contain templates here, relative to this directory.
@@ -65,7 +65,7 @@ release = '2.0.0dev0'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['links.inc', '_build', 'test', 'announce'] # XXX
+exclude_patterns = ['links.inc', '_build', 'test', ] # XXX
 
 # The reST default role (used for this markup: `text`) to use for all documents.
 #default_role = None

doc/contact.txt

@@ -1,11 +1,13 @@
 
 .. _`contact channels`:
+.. _`contact`:
 
 Contact channels
 ===================================
 
-- `new issue tracker`_ to report bugs or suggest features.
+- `new issue tracker`_ to report bugs or suggest features (for version
-  See also the `old issue tracker`_ but don't submit bugs there.
+  2.0 and above).  You may also peek at the `old issue tracker`_ but please
+  don't submit bugs there anymore.
 
 - `Testing In Python`_: a mailing list for Python testing tools and discussion.
 

doc/doctest.txt

@@ -44,7 +44,7 @@ then you can just invoke ``py.test`` without command line options::
 
     $ py.test
     =========================== test session starts ============================
-    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev17
+    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev19
-    test path 1: /tmp/doc-exec-197
+    test path 1: /tmp/doc-exec-400
     
     =============================  in 0.00 seconds =============================

doc/example/builtin.txt

@@ -3,8 +3,9 @@ writing well integrated assertion helpers
 ========================================================
 
 If you have a test helper function called from a test you can
-use the ``pytest.fail``_ builtin to cleanly fail a test with a message.
+use the ``pytest.fail`` marker to fail a test with a certain message.
-The test support function will never itself show up in the traceback.
+The test support function will not show up in the traceback if you
+set the ``__tracebackhide__`` option somewhere in the helper function.
 Example::
 
     # content of test_checkconfig.py
@@ -33,4 +34,3 @@ Let's run our little function::
 
     test_checkconfig.py:8: Failed
     1 failed in 0.02 seconds
-

doc/example/controlskip.txt

@@ -36,12 +36,12 @@ and when running it will see a skipped "slow" test::
 
     $ py.test test_module.py -rs    # "-rs" means report on the little 's'
     =========================== test session starts ============================
-    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev17
+    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev19
     test path 1: test_module.py
     
     test_module.py .s
     ========================= short test summary info ==========================
-    SKIP [1] /tmp/doc-exec-195/conftest.py:9: 'need --runslow option to run'
+    SKIP [1] /tmp/doc-exec-435/conftest.py:9: need --runslow option to run
     
     =================== 1 passed, 1 skipped in 0.02 seconds ====================
 
@@ -49,7 +49,7 @@ Or run it including the ``slow`` marked test::
 
     $ py.test test_module.py --runslow
     =========================== test session starts ============================
-    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev17
+    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev19
     test path 1: test_module.py
     
     test_module.py ..

doc/example/index.txt

@@ -4,6 +4,9 @@
 Usages and Examples
 ===========================================
 
+This is a (growing) list of examples. :ref:`Contact <contact>` us if you
+need more examples or have questions.
+
 .. toctree::
    :maxdepth: 2
 
@@ -14,3 +17,4 @@ Usages and Examples
    detectpytest.txt
    nonpython.txt
    simple.txt
+   xunit_setup.txt

doc/example/mysetup.txt

@@ -49,7 +49,7 @@ You can now run the test::
 
     $ py.test test_sample.py
     =========================== test session starts ============================
-    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev17
+    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev19
     test path 1: test_sample.py
     
     test_sample.py F
@@ -57,7 +57,7 @@ You can now run the test::
     ================================= FAILURES =================================
     _______________________________ test_answer ________________________________
     
-    mysetup = <conftest.MySetup instance at 0x2809a70>
+    mysetup = <conftest.MySetup instance at 0x1cf6b90>
     
         def test_answer(mysetup):
             app = mysetup.myapp()
@@ -122,12 +122,12 @@ Running it yields::
 
     $ py.test test_ssh.py -rs
     =========================== test session starts ============================
-    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev17
+    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev19
     test path 1: test_ssh.py
     
     test_ssh.py s
     ========================= short test summary info ==========================
-    SKIP [1] /tmp/doc-exec-198/conftest.py:22: 'specify ssh host with --ssh'
+    SKIP [1] /tmp/doc-exec-438/conftest.py:22: specify ssh host with --ssh
     
     ======================== 1 skipped in 0.02 seconds =========================
 

doc/example/nonpython.txt

@@ -27,7 +27,7 @@ now execute the test specification::
 
     nonpython $ py.test test_simple.yml
     =========================== test session starts ============================
-    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev17
+    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev19
     test path 1: test_simple.yml
 
     test_simple.yml .F
@@ -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.37 seconds ====================
+    ==================== 1 failed, 1 passed in 0.42 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
@@ -51,17 +51,16 @@ your own domain specific testing language this way.
     representation string of your choice.  It
     will be reported as a (red) string.
 
-    ``reportinfo()``
+``reportinfo()`` is used for representing the test location and is also consulted for
-is used for representing the test location and is also consulted for
 reporting in ``verbose`` mode::
 
     nonpython $ py.test -v
     =========================== test session starts ============================
-    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev17 -- /home/hpk/venv/0/bin/python
+    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev19 -- /home/hpk/venv/0/bin/python
     test path 1: /home/hpk/p/pytest/doc/example/nonpython
 
-    test_simple.yml:1: usecase: ok PASSED
+    test_simple.yml <- test_simple.yml:1: usecase: ok PASSED
-    test_simple.yml:1: usecase: hello FAILED
+    test_simple.yml <- test_simple.yml:1: usecase: hello FAILED
 
     ================================= FAILURES =================================
     ______________________________ usecase: hello ______________________________
@@ -74,7 +73,7 @@ While developing your custom test collection and execution it's also
 interesting to just look at the collection tree::
 
     nonpython $ py.test --collectonly
-    <Directory 'nonpython'>
+    <Collection 'nonpython'>
-      <YamlFile 'test_simple.yml'>
+    <YamlFile 'test_simple.yml'>
-        <UsecaseItem 'ok'>
+      <YamlItem 'ok'>
-        <UsecaseItem 'hello'>
+      <YamlItem 'hello'>

doc/example/pythoncollection.txt

@@ -18,12 +18,11 @@ finding out what is collected
 
 You can always peek at the collection tree without running tests like this::
 
-    $ py.test --collectonly collectonly.py
+    . $ py.test --collectonly collectonly.py
-    <Directory 'example'>
+    <Collection 'example'>
-      <Module 'test_collectonly.py'>
+    <Module 'collectonly.py'>
-        <Function 'test_function'>
+      <Function 'test_function'>
-        <Class 'TestClass'>
+      <Class 'TestClass'>
-          <Instance '()'>
+        <Instance '()'>
-            <Function 'test_method'>
+          <Function 'test_method'>
-            <Function 'test_anothermethod'>
+          <Function 'test_anothermethod'>
-

doc/example/simple.txt

@@ -130,8 +130,7 @@ let's run the full monty::
     E       assert 4 < 4
     
     test_compute.py:3: AssertionError
-    1 failed, 4 passed in 0.03 seconds
+    1 failed, 4 passed in 0.02 seconds
-
 
 As expected when running the full range of ``param1`` values
 we'll get an error on the last one.

doc/example/xunit_setup.txt

@@ -19,8 +19,8 @@ custom options::
 
 .. _optparse: http://docs.python.org/library/optparse.html
 
-Working Examples
+order of setup/teardown module/class/item methods
-================
+====================================================
 
 managing state at module, class and method level
 ------------------------------------------------------------

doc/funcargs.txt

@@ -34,7 +34,7 @@ Running the test looks like this::
 
     $ py.test test_simplefactory.py
     =========================== test session starts ============================
-    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev17
+    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev19
     test path 1: test_simplefactory.py
     
     test_simplefactory.py F
@@ -136,7 +136,7 @@ Running this::
 
     $ py.test test_example.py
     =========================== test session starts ============================
-    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev17
+    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev19
     test path 1: test_example.py
     
     test_example.py .........F
@@ -151,55 +151,37 @@ Running this::
     E       assert 9 < 9
     
     test_example.py:7: AssertionError
-    ==================== 1 failed, 9 passed in 0.03 seconds ====================
+    ==================== 1 failed, 9 passed in 0.04 seconds ====================
 
 Note that the ``pytest_generate_tests(metafunc)`` hook is called during
 the test collection phase which is separate from the actual test running.
 Let's just look at what is collected::
 
     $ py.test --collectonly test_example.py
-    <Directory 'doc-exec-167'>
+    <Collection 'doc-exec-403'>
-      <Module 'test_example.py'>
+    <Module 'test_example.py'>
-        <Function 'test_func[0]'>
+      <Function 'test_func[0]'>
-        <Function 'test_func[1]'>
+      <Function 'test_func[1]'>
-        <Function 'test_func[2]'>
+      <Function 'test_func[2]'>
-        <Function 'test_func[3]'>
+      <Function 'test_func[3]'>
-        <Function 'test_func[4]'>
+      <Function 'test_func[4]'>
-        <Function 'test_func[5]'>
+      <Function 'test_func[5]'>
-        <Function 'test_func[6]'>
+      <Function 'test_func[6]'>
-        <Function 'test_func[7]'>
+      <Function 'test_func[7]'>
-        <Function 'test_func[8]'>
+      <Function 'test_func[8]'>
-        <Function 'test_func[9]'>
+      <Function 'test_func[9]'>
 
 If you want to select only the run with the value ``7`` you could do::
 
     $ py.test -v -k 7 test_example.py  # or -k test_func[7]
     =========================== test session starts ============================
-    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev17 -- /home/hpk/venv/0/bin/python
+    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev19 -- /home/hpk/venv/0/bin/python
     test path 1: test_example.py
     
-    test_example.py:6: test_func[0] PASSED
+    test_example.py <- test_example.py:6: test_func[7] PASSED
-    test_example.py:6: test_func[1] PASSED
-    test_example.py:6: test_func[2] PASSED
-    test_example.py:6: test_func[3] PASSED
-    test_example.py:6: test_func[4] PASSED
-    test_example.py:6: test_func[5] PASSED
-    test_example.py:6: test_func[6] PASSED
-    test_example.py:6: test_func[7] PASSED
-    test_example.py:6: test_func[8] PASSED
-    test_example.py:6: test_func[9] FAILED
     
-    ================================= FAILURES =================================
+    ======================== 9 tests deselected by '7' =========================
-    _______________________________ test_func[9] _______________________________
+    ================== 1 passed, 9 deselected in 0.01 seconds ==================
-
-    numiter = 9
-
-        def test_func(numiter):
-    >       assert numiter < 9
-    E       assert 9 < 9
-
-    test_example.py:7: AssertionError
-    ==================== 1 failed, 9 passed in 0.04 seconds ====================
 
 .. _`metafunc object`:
 

doc/getting-started.txt

@@ -14,6 +14,7 @@ Installation options::
 To check your installation has installed the correct version::
 
     $ py.test --version
+    This is py.test version 2.0.0.dev19, imported from /home/hpk/p/pytest/pytest
 
 If you get an error checkout :ref:`installation issues`.
 
@@ -33,8 +34,8 @@ That's it. You can execute the test function now::
 
     $ py.test
     =========================== test session starts ============================
-    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev18
+    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev19
-    test path 1: /tmp/doc-exec-211
+    test path 1: /tmp/doc-exec-404
     
     test_sample.py F
     
@@ -120,7 +121,7 @@ run the module by passing its filename::
     ================================= FAILURES =================================
     ____________________________ TestClass.test_two ____________________________
     
-    self = <test_class.TestClass instance at 0x19c6638>
+    self = <test_class.TestClass instance at 0x2c2c560>
     
         def test_two(self):
             x = "hello"
@@ -156,7 +157,7 @@ before performing the test function call.  Let's just run it::
     ================================= FAILURES =================================
     _____________________________ test_needsfiles ______________________________
     
-    tmpdir = local('/tmp/pytest-1306/test_needsfiles0')
+    tmpdir = local('/tmp/pytest-240/test_needsfiles0')
     
         def test_needsfiles(tmpdir):
             print tmpdir
@@ -165,7 +166,7 @@ before performing the test function call.  Let's just run it::
     
     test_tmpdir.py:3: AssertionError
     ----------------------------- Captured stdout ------------------------------
-    /tmp/pytest-1306/test_needsfiles0
+    /tmp/pytest-240/test_needsfiles0
     1 failed in 0.04 seconds
 
 Before the test runs, a unique-per-test-invocation temporary directory

doc/index.txt

@@ -19,6 +19,7 @@ Welcome to ``py.test`` documentation:
    example/index
    talks
    develop
+   announce/index
 
 .. toctree::
    :hidden:

doc/mark.txt

@@ -88,8 +88,8 @@ You can use the ``-k`` command line option to select tests::
 
     $ py.test -k webtest  # running with the above defined examples yields
     =========================== test session starts ============================
-    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev17
+    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev19
-    test path 1: /tmp/doc-exec-171
+    test path 1: /tmp/doc-exec-407
     
     test_mark.py ..
     test_mark_classlevel.py ..
@@ -100,8 +100,8 @@ And you can also run all tests except the ones that match the keyword::
 
     $ py.test -k-webtest
     =========================== test session starts ============================
-    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev17
+    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev19
-    test path 1: /tmp/doc-exec-171
+    test path 1: /tmp/doc-exec-407
     
     ===================== 4 tests deselected by '-webtest' =====================
     ======================= 4 deselected in 0.01 seconds =======================
@@ -110,8 +110,8 @@ Or to only select the class::
 
     $ py.test -kTestClass
     =========================== test session starts ============================
-    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev17
+    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev19
-    test path 1: /tmp/doc-exec-171
+    test path 1: /tmp/doc-exec-407
     
     test_mark_classlevel.py ..
     

doc/monkeypatch.txt

@@ -39,8 +39,8 @@ will be undone.
 .. background check:
    $ py.test
    =========================== test session starts ============================
-   platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev17
+   platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev19
-   test path 1: /tmp/doc-exec-172
+   test path 1: /tmp/doc-exec-408
    
    =============================  in 0.00 seconds =============================
 

doc/nose.txt

@@ -0,0 +1,42 @@
+Running test written for nose
+=======================================
+
+.. include:: links.inc
+
+py.test has basic support for running tests written for nose_.
+This is implemented in :pymod:`pytest.plugin.nose`.
+
+Usage
+-------------
+
+type::
+
+    py.test  # instead of 'nosetests'
+
+and you should be able to run your nose style tests and at the same
+make full use of py.test's capabilities.
+
+Supported nose Idioms
+----------------------
+
+* setup and teardown at module/class/method level
+* SkipTest exceptions and markers
+* setup/teardown decorators
+* yield-based tests and their setup
+* general usage of nose utilities
+
+Unsupported idioms / issues
+----------------------------------
+
+- nose-style doctests are not collected and executed correctly,
+  also fixtures don't work.
+
+- no nose-configuration is recognized
+
+If you find other issues or have suggestions please run::
+
+    py.test --pastebin=all
+
+and send the resulting URL to a py.test contact channel,
+at best to the mailing list.
+"""

doc/plugins.txt

@@ -5,7 +5,7 @@ Writing, managing and understanding plugins
 
 py.test implements all aspects of configuration, collection, running and reporting by calling `well specified hooks`_.  Virtually any Python module can be registered as a plugin.  It can implement any number of hook functions (usually two or three) which all have a ``pytest_`` prefix, making hook functions easy to distinguish and find.  There are three basic locations types:
 
-* builtin plugins: loaded from py.test's own `pytest/plugin`_ directory.
+* `builtin plugins`_: loaded from py.test's own ``pytest/plugin`` directory.
 * `external plugins`_: modules discovered through `setuptools entry points`_
 * `conftest.py plugins`_: modules auto-discovered in test directories
 
@@ -90,6 +90,7 @@ to implement their wide-ranging functionality.
 
 .. _`setuptools entry points`:
 
+
 Making your plugin installable by others
 -----------------------------------------------
 
@@ -171,6 +172,37 @@ the plugin manager like this:
 If you want to look at the names of existing plugins, use
 the ``--traceconfig`` option.
 
+
+.. _`builtin plugins`:
+
+py.test default plugin reference
+====================================
+
+.. autosummary::
+
+    pytest.plugin.assertion
+    pytest.plugin.capture
+    pytest.plugin.config
+    pytest.plugin.doctest
+    pytest.plugin.genscript
+    pytest.plugin.helpconfig
+    pytest.plugin.junitxml
+    pytest.plugin.mark
+    pytest.plugin.monkeypatch
+    pytest.plugin.nose
+    pytest.plugin.pastebin
+    pytest.plugin.pdb
+    pytest.plugin.pytester
+    pytest.plugin.python
+    pytest.plugin.recwarn
+    pytest.plugin.resultlog
+    pytest.plugin.runner
+    pytest.plugin.session
+    pytest.plugin.skipping
+    pytest.plugin.terminal
+    pytest.plugin.tmpdir
+    pytest.plugin.unittest
+
 .. _`well specified hooks`:
 
 py.test hook reference

doc/tmpdir.txt

@@ -20,7 +20,7 @@ and more.  Here is an example test usage::
         p = tmpdir.mkdir("sub").join("hello.txt")
         p.write("content")
         assert p.read() == "content"
-        assert tmpdir.listdir() == 1
+        assert len(tmpdir.listdir()) == 1
         assert 0
 
 Running this would result in a passed test except for the last
@@ -28,7 +28,7 @@ Running this would result in a passed test except for the last
 
     $ py.test test_tmpdir.py
     =========================== test session starts ============================
-    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev17
+    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev19
     test path 1: test_tmpdir.py
     
     test_tmpdir.py F
@@ -36,13 +36,15 @@ Running this would result in a passed test except for the last
     ================================= FAILURES =================================
     _____________________________ test_create_file _____________________________
     
-    tmpdir = local('/tmp/pytest-1248/test_create_file0')
+    tmpdir = local('/tmp/pytest-243/test_create_file0')
     
         def test_create_file(tmpdir):
             p = tmpdir.mkdir("sub").join("hello.txt")
             p.write("content")
             assert p.read() == "content"
-            assert len(os.listdir(str(tmpdir))) == 1
+            assert len(tmpdir.listdir()) == 1
+    >       assert 0
+    E       assert 0
     
     test_tmpdir.py:7: AssertionError
     ========================= 1 failed in 0.04 seconds =========================

doc/unittest.txt

@@ -24,7 +24,7 @@ Running it yields::
 
     $ py.test test_unittest.py
     =========================== test session starts ============================
-    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev17
+    platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev19
     test path 1: test_unittest.py
     
     test_unittest.py F
@@ -32,7 +32,7 @@ Running it yields::
     ================================= FAILURES =================================
     ____________________________ MyTest.test_method ____________________________
     
-    self = <test_unittest.MyTest testMethod=run>
+    self = <test_unittest.MyTest testMethod=test_method>
     
         def test_method(self):
             x = 1
@@ -41,7 +41,7 @@ Running it yields::
     test_unittest.py:8: 
     _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 
     
-    self = <test_unittest.MyTest testMethod=run>, first = 1, second = 3
+    self = <test_unittest.MyTest testMethod=test_method>, first = 1, second = 3
     msg = None
     
         def failUnlessEqual(self, first, second, msg=None):

pytest/plugin/assertion.py

@@ -1,3 +1,6 @@
+"""
+support for presented detailed information in failing assertions.
+"""
 import py
 import sys
 

pytest/plugin/capture.py

@@ -1,6 +1,4 @@
-""" plugin for configurable per-test stdout/stderr capturing mechanisms and
+""" per-test stdout/stderr capturing mechanisms, ``capsys`` and ``capfd`` function arguments.  """
-``capsys`` and ``capfd`` function arguments.
-"""
 
 import py
 import os

pytest/plugin/config.py

@@ -1,10 +1,10 @@
+""" command line configuration, ini-file and conftest.py processing. """
 
 import py
 import sys, os
 from pytest.main import PluginManager
 import pytest
 
-
 def pytest_cmdline_parse(pluginmanager, args):
     config = Config(pluginmanager)
     config.parse(args)

pytest/plugin/doctest.py

@@ -1,4 +1,4 @@
-""" collect and execute doctests from modules and test files."""
+""" discover and run doctests in modules and test files."""
 
 import py
 from py._code.code import TerminalRepr, ReprFileLocation

pytest/plugin/genscript.py

@@ -1,3 +1,4 @@
+""" generate a single-file self-contained version of py.test """
 import py
 import pickle
 import zlib

pytest/plugin/helpconfig.py

@@ -1,5 +1,4 @@
-""" provide version info, conftest/environment config names.
+""" version info, help messages, tracing configuration.  """
-"""
 import py
 import pytest
 import inspect, sys

pytest/plugin/junitxml.py

@@ -1,5 +1,6 @@
-""" logging of test results in JUnit-XML format, for use with Hudson
+""" report test results in JUnit-XML format, for use with Hudson and build integration servers.
-   and build integration servers.  Based on initial code from Ross Lawley.
+
+Based on initial code from Ross Lawley.
 """
 
 import py

pytest/plugin/nose.py

@@ -1,42 +1,5 @@
-"""nose-compatibility plugin: allow to run nose test suites natively.
+"""run test suites written for nose. """
 
-This is an experimental plugin for allowing to run tests written
-in 'nosetests style with py.test.
-
-Usage
--------------
-
-type::
-
-    py.test  # instead of 'nosetests'
-
-and you should be able to run nose style tests and at the same
-time can make full use of py.test's capabilities.
-
-Supported nose Idioms
-----------------------
-
-* setup and teardown at module/class/method level
-* SkipTest exceptions and markers
-* setup/teardown decorators
-* yield-based tests and their setup
-* general usage of nose utilities
-
-Unsupported idioms / issues
-----------------------------------
-
-- nose-style doctests are not collected and executed correctly,
-  also fixtures don't work.
-
-- no nose-configuration is recognized
-
-If you find other issues or have suggestions please run::
-
-    py.test --pastebin=all
-
-and send the resulting URL to a py.test contact channel,
-at best to the mailing list.
-"""
 import py
 import inspect
 import sys

pytest/plugin/pdb.py

@@ -1,6 +1,5 @@
-"""
+""" interactive debugging with PDB, the Python Debugger. """
-interactive debugging with the Python Debugger.
+
-"""
 import py
 import sys
 

pytest/plugin/pytester.py

@@ -1,6 +1,4 @@
-"""
+""" (disabled by default) support for testing py.test and py.test plugins. """
-funcargs and support code for testing py.test's own functionality.
-"""
 
 import py, pytest
 import sys, os

pytest/plugin/python.py

@@ -1,6 +1,4 @@
-"""
+""" Python test discovery, setup and run of test functions. """
-Python related collection nodes.
-"""
 import py
 import inspect
 import sys

pytest/plugin/recwarn.py

@@ -1,4 +1,4 @@
-""" record warnings to allow assertions about them.  """
+""" recording warnings during test function execution. """
 
 import py
 import sys, os

pytest/plugin/resultlog.py

@@ -1,4 +1,4 @@
-""" create machine readable plain text file with results.  """
+""" (disabled by default) create result information in a plain text file. """
 
 import py
 from py.builtin import print_

pytest/plugin/runner.py

@@ -1,6 +1,4 @@
-"""
+""" basic collect and runtest protocol implementations """
-collect and run test items and create reports.
-"""
 
 import py, sys
 from py._code.code import TerminalRepr
@@ -92,11 +90,12 @@ def call_runtest_hook(item, when):
     return CallInfo(lambda: ihook(item=item), when=when)
 
 class CallInfo:
-    """ Call Information about a hook call. """
+    """ Result/Exception info a function invocation. """
     #: None or ExceptionInfo object.
     excinfo = None
     def __init__(self, func, when):
-        #: one of "setup", "call", "teardown" specifying the runtest phase.
+        #: context of invocation: one of "setup", "call",
+        #: "teardown", "memocollect"
         self.when = when
         try:
             self.result = func()

pytest/plugin/session.py

@@ -1,8 +1,4 @@
-""" basic test session implementation.
+""" core implementation of testing process: init, collection, runtest loop. """
-
-* drives collection of tests
-* triggers executions of tests
-"""
 
 import py
 import pytest
@@ -174,10 +170,10 @@ class Node(object):
         #: the test config object
         self.config = config or parent.config
 
-        #: the collection this node is part of.
+        #: the collection this node is part of
         self.collection = collection or parent.collection
         
-        #: the file where this item is contained/collected from.
+        #: filesystem path where this node was collected from
         self.fspath = getattr(parent, 'fspath', None)
         self.ihook = self.collection.gethookproxy(self.fspath)
         self.keywords = {self.name: True}

pytest/plugin/skipping.py

@@ -1,6 +1,4 @@
-"""
+""" support for skip/xfail functions and markers. """
-plugin providing skip and xfail functionality.
-"""
 
 import py, pytest
 

pytest/plugin/terminal.py

@@ -1,5 +1,4 @@
-"""
+""" terminal reporting of the full testing process.
-Implements terminal reporting of the full testing process.
 
 This is a good source for looking at the various reporting hooks.
 """

pytest/plugin/tmpdir.py

@@ -1,13 +1,4 @@
-"""provide temporary directories to test functions.
+""" support for providing temporary directories to test functions.  """
-
-usage example::
-
-    def test_plugin(tmpdir):
-        tmpdir.join("hello").write("hello")
-
-.. _`py.path.local`: ../../path.html
-
-"""
 import pytest, py
 
 def pytest_configure(config):

pytest/plugin/unittest.py

@@ -1,6 +1,4 @@
-"""
+""" support discovery and running of traditional "unittest.py" style tests. """
-automatically discover and run traditional "unittest.py" style tests.
-"""
 import py
 import sys