From 9d47521cf0a294a661ffdfe66806c8181cf6b7a5 Mon Sep 17 00:00:00 2001 From: holger krekel Date: Thu, 8 Jul 2010 15:28:54 +0200 Subject: [PATCH] finalizing docs --HG-- branch : trunk --- CHANGELOG | 16 +++++++--------- doc/announce/release-1.3.2.txt | 23 +++++++++++------------ doc/test/features.txt | 16 ++++++++++++---- 3 files changed, 30 insertions(+), 25 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index a4e1f2fd3..95023a6f6 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,4 +1,4 @@ -Changes between 1.3.1 and 1.3.2a +Changes between 1.3.1 and 1.3.2 ================================================== New features @@ -18,8 +18,8 @@ New features (thanks Ronny Pfannschmidt) - Funcarg factories can now dynamically apply a marker to a - test invocation. This is for example useful if a factory - provides parameters to a test which are expected-to-fail: + test invocation. This is for example useful if a factory + provides parameters to a test which are expected-to-fail:: def pytest_funcarg__arg(request): request.applymarker(py.test.mark.xfail(reason="flaky config")) @@ -28,9 +28,9 @@ New features def test_function(arg): ... -- improved error reporting when collection errors appear. - In general, for custom (test and particularly collection) - nodes ``node.repr_failure(excinfo)`` is now called so that you can +- improved error reporting on collection and import errors. This makes + use of a more general mechanism, namely that for custom test item/collect + nodes ``node.repr_failure(excinfo)`` is now uniformly called so that you can override it to return a string error representation of your choice which is going to be reported as a (red) string. @@ -40,11 +40,9 @@ New features Bug fixes / Maintenance ++++++++++++++++++++++++++ -- make tests and the ``pytest_recwarn`` plugin in paricular fully compatible +- make tests and the ``pytest_recwarn`` plugin in particular fully compatible to Python2.7 (if you use the ``recwarn`` funcarg warnings will be enabled so that you can properly check for their existence in a cross-python manner). -- improve error messages if importing a test module failed (ImportError, - import file mismatches, syntax errors) - refine --pdb: ignore xfailed tests, unify its TB-reporting and don't display failures again at the end. - fix assertion interpretation with the ** operator (thanks Benjamin Peterson) diff --git a/doc/announce/release-1.3.2.txt b/doc/announce/release-1.3.2.txt index 6a20dd825..6c1642aa6 100644 --- a/doc/announce/release-1.3.2.txt +++ b/doc/announce/release-1.3.2.txt @@ -1,9 +1,9 @@ py.test/pylib 1.3.2: API and reporting refinements, many fixes =========================================================================== -The pylib/py.test 1.3.2 release brings many bug fixes and a few new -features and was refined for and tested against the recently released -Python2.7 besides remaining compatibile to the usual armada of interpreters +The pylib/py.test 1.3.2 release brings many bug fixes and some new +features. It was refined for and tested against the recently released +Python2.7 and remains compatibile to the usual armada of interpreters (Python2.4 through to Python3.1.2, Jython and PyPy). Note that for using distributed testing features you'll need to upgrade to the jointly released pytest-xdist-1.4 because of some internal refactorings. @@ -16,7 +16,6 @@ and all issue and patch contributors, holger krekel - Changes between 1.3.1 and 1.3.2 ================================================== @@ -37,8 +36,8 @@ New features (thanks Ronny Pfannschmidt) - Funcarg factories can now dynamically apply a marker to a - test invocation. This is for example useful if a factory - provides parameters to a test which are expected-to-fail: + test invocation. This is for example useful if a factory + provides parameters to a test which are expected-to-fail:: def pytest_funcarg__arg(request): request.applymarker(py.test.mark.xfail(reason="flaky config")) @@ -47,9 +46,9 @@ New features def test_function(arg): ... -- improved error reporting when collection errors appear. - In general, for custom (test and particularly collection) - nodes ``node.repr_failure(excinfo)`` is now called so that you can +- improved error reporting on collection and import errors. This makes + use of a more general mechanism, namely that for custom test item/collect + nodes ``node.repr_failure(excinfo)`` is now uniformly called so that you can override it to return a string error representation of your choice which is going to be reported as a (red) string. @@ -59,11 +58,9 @@ New features Bug fixes / Maintenance ++++++++++++++++++++++++++ -- make tests and the ``pytest_recwarn`` plugin in paricular fully compatible +- make tests and the ``pytest_recwarn`` plugin in particular fully compatible to Python2.7 (if you use the ``recwarn`` funcarg warnings will be enabled so that you can properly check for their existence in a cross-python manner). -- improve error messages if importing a test module failed (ImportError, - import file mismatches, syntax errors) - refine --pdb: ignore xfailed tests, unify its TB-reporting and don't display failures again at the end. - fix assertion interpretation with the ** operator (thanks Benjamin Peterson) @@ -91,6 +88,8 @@ Bug fixes / Maintenance - perform distributed testing related reporting in the xdist-plugin rather than having dist-related code in the generic py.test distribution +- fix homedir detection on Windows +- ship distribute_setup.py version 0.6.13 Changes between 1.3.0 and 1.3.1 ================================================== diff --git a/doc/test/features.txt b/doc/test/features.txt index ac296943a..16a646baa 100644 --- a/doc/test/features.txt +++ b/doc/test/features.txt @@ -131,12 +131,16 @@ asserting expected exceptions ---------------------------------------- In order to write assertions about exceptions, you can use -``py.test.raises`` as a context manager like this:: +``py.test.raises`` as a context manager like this: + +.. sourcecode:: python with py.test.raises(ZeroDivisionError): 1 / 0 -and if you need to have access to the actual exception info you may use:: +and if you need to have access to the actual exception info you may use: + +.. sourcecode:: python with py.test.raises(RuntimeError) as excinfo: def f(): @@ -146,7 +150,9 @@ and if you need to have access to the actual exception info you may use:: # do checks related to excinfo.type, excinfo.value, excinfo.traceback If you want to write test code that works on Python2.4 as well, -you may also use two other ways to test for an expected exception:: +you may also use two other ways to test for an expected exception: + +.. sourcecode:: python py.test.raises(ExpectedException, func, *args, **kwargs) py.test.raises(ExpectedException, "func(*args, **kwargs)") @@ -217,7 +223,9 @@ keyword. By default, all filename parts and class/function names of a test function are put into the set of keywords for a given test. You can specify additional -kewords like this:: +kewords like this: + +.. sourcecode:: python @py.test.mark.webtest def test_send_http():