diff options
| author | jpellerin <devnull@localhost> | 2010-11-19 10:06:00 -0500 |
|---|---|---|
| committer | jpellerin <devnull@localhost> | 2010-11-19 10:06:00 -0500 |
| commit | 271c9a6473409a3d6d8fb2267e7215de3658179e (patch) | |
| tree | 3bb1bc01189c9a2d5590a2026522dc8f4cb2c950 | |
| parent | fe1d21bd7bc6259da55e91ee9745a31dd41ca131 (diff) | |
| download | nose-271c9a6473409a3d6d8fb2267e7215de3658179e.tar.gz | |
Updated multiprocessing module docs and main doc link page
| -rw-r--r-- | README.txt | 8 | ||||
| -rw-r--r-- | doc/index.html | 4 | ||||
| -rw-r--r-- | functional_tests/doc_tests/test_multiprocess/multiprocess.rst | 21 | ||||
| -rw-r--r-- | nose/plugins/multiprocess.py | 11 | ||||
| -rw-r--r-- | nosetests.1 | 8 |
5 files changed, 23 insertions, 29 deletions
@@ -141,7 +141,7 @@ plugins keyword argument. 0.9 plugins ----------- -nose 0.11 can use SOME plugins that were written for nose 0.9. The +nose 1.0 can use SOME plugins that were written for nose 0.9. The default plugin manager inserts a compatibility wrapper around 0.9 plugins that adapts the changed plugin api calls. However, plugins that access nose internals are likely to fail, especially if they @@ -153,10 +153,10 @@ plugin is trying to find out if the test is an instance of a class that no longer exists. -0.10 plugins ------------- +0.10 and 0.11 plugins +--------------------- -All plugins written for nose 0.10 should work with nose 0.11. +All plugins written for nose 0.10 and 0.11 should work with nose 1.0. Options diff --git a/doc/index.html b/doc/index.html index ad4c2cb..cd80895 100644 --- a/doc/index.html +++ b/doc/index.html @@ -1,8 +1,8 @@ <html> <head><title>Redirecting to nose 0.11 docs</title> - <meta http-equiv="refresh" content="0; ./0.11.2/"/> + <meta http-equiv="refresh" content="0; ./1.0.0/"/> </head> <body> - <p>Redirecting to <a href="./0.11.2/">nose 0.11 docs</a></p> + <p>Redirecting to <a href="./1.0.0/">nose 1.0 docs</a></p> </body> </html> diff --git a/functional_tests/doc_tests/test_multiprocess/multiprocess.rst b/functional_tests/doc_tests/test_multiprocess/multiprocess.rst index c1ba530..8de2802 100644 --- a/functional_tests/doc_tests/test_multiprocess/multiprocess.rst +++ b/functional_tests/doc_tests/test_multiprocess/multiprocess.rst @@ -3,8 +3,9 @@ Parallel Testing with nose .. Note :: - The multiprocess plugin requires the multiprocessing_ module, available from - PyPI and at http://code.google.com/p/python-multiprocessing/. + Use of the multiprocess plugin on python 2.5 or earlier requires + the multiprocessing_ module, available from PyPI and at + http://code.google.com/p/python-multiprocessing/. .. @@ -14,10 +15,6 @@ speed up CPU-bound test runs, it is mainly useful for IO-bound tests that spend most of their time waiting for data to arrive from someplace else and can benefit from parallelization. -.. warning :: - - The multiprocess plugin is not available on Windows. - .. _multiprocessing : http://code.google.com/p/python-multiprocessing/ How tests are distributed @@ -66,7 +63,7 @@ A class might look like:: @classmethod def setup_class(cls): ... - + Alternatively, If a context's fixtures may only be run once, or may not run concurrently, but *may* be shared by tests running in different processes -- for instance a package-level fixture that starts an external http server or @@ -106,11 +103,11 @@ and the third is unmarked. They all define the same fixtures: def setup(): print "setup called" called.append('setup') - + def teardown(): print "teardown called" called.append('teardown') - + And each has two tests that just test that ``setup()`` has been called once and only once. @@ -135,7 +132,7 @@ all tests pass. >>> test_can_split = os.path.join(support, 'test_can_split.py') The module with shared fixtures passes. - + >>> run(argv=['nosetests', '-v', test_shared]) #doctest: +REPORT_NDIFF setup called test_shared.TestMe.test_one ... ok @@ -149,7 +146,7 @@ The module with shared fixtures passes. OK As does the module with no fixture annotations. - + >>> run(argv=['nosetests', '-v', test_not_shared]) #doctest: +REPORT_NDIFF setup called test_not_shared.TestMe.test_one ... ok @@ -163,7 +160,7 @@ As does the module with no fixture annotations. OK And the module that marks its fixtures as re-entrant. - + >>> run(argv=['nosetests', '-v', test_can_split]) #doctest: +REPORT_NDIFF setup called test_can_split.TestMe.test_one ... ok diff --git a/nose/plugins/multiprocess.py b/nose/plugins/multiprocess.py index 5f1f3a7..1c4dac5 100644 --- a/nose/plugins/multiprocess.py +++ b/nose/plugins/multiprocess.py @@ -2,10 +2,6 @@ Overview ======== -.. warning :: - - The multiprocess plugin is not available on Windows. - The multiprocess plugin enables you to distribute your test run among a set of worker processes that run tests in parallel. This can speed up CPU-bound test runs (as long as the number of work processeses is around the number of @@ -14,9 +10,10 @@ spend most of their time waiting for data to arrive from someplace else. .. note :: - See :doc:`../doc_tests/test_multiprocess/multiprocess` for additional - documentation and examples. Use of this plugin requires the - multiprocessing_ module, also available from PyPI. + See :doc:`../doc_tests/test_multiprocess/multiprocess` for + additional documentation and examples. Use of this plugin on python + 2.5 or earlier requires the multiprocessing_ module, also available + from PyPI. .. _multiprocessing : http://code.google.com/p/python-multiprocessing/ diff --git a/nosetests.1 b/nosetests.1 index 709596c..e3683bb 100644 --- a/nosetests.1 +++ b/nosetests.1 @@ -117,7 +117,7 @@ with the plugins keyword argument. .SS 0.9 plugins -nose 0.11 can use SOME plugins that were written for nose 0.9. The +nose 1.0 can use SOME plugins that were written for nose 0.9. The default plugin manager inserts a compatibility wrapper around 0.9 plugins that adapts the changed plugin api calls. However, plugins that access nose internals are likely to fail, especially if they @@ -129,8 +129,8 @@ plugin is trying to find out if the test is an instance of a class that no longer exists. -.SS 0.10 plugins -All plugins written for nose 0.10 should work with nose 0.11. +.SS 0.10 and 0.11 plugins +All plugins written for nose 0.10 and 0.11 should work with nose 1.0. .SS Options @@ -466,5 +466,5 @@ jpellerin+nose@gmail.com .SH COPYRIGHT LGPL -.\" Generated by docutils manpage writer on 2010-11-15 09:17. +.\" Generated by docutils manpage writer on 2010-11-19 10:05. .\" |