summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEzio Melotti <ezio.melotti@gmail.com>2013-03-27 18:13:59 (GMT)
committerEzio Melotti <ezio.melotti@gmail.com>2013-03-27 18:13:59 (GMT)
commit67ddccafc39c49b53bf1166c6fda603406d59640 (patch)
treed210b67ca7c08610eb9dcad4164e2034fa38d7ec
parent9869e60dc2e7803f31af47a37fcc6392262496d8 (diff)
parent184e59357e1444d32938d6f2b829b618f1eb8790 (diff)
downloadcpython-67ddccafc39c49b53bf1166c6fda603406d59640.zip
cpython-67ddccafc39c49b53bf1166c6fda603406d59640.tar.gz
cpython-67ddccafc39c49b53bf1166c6fda603406d59640.tar.bz2
#17329: merge with 3.3.
-rw-r--r--Doc/library/unittest.rst19
-rw-r--r--Lib/unittest/case.py2
2 files changed, 14 insertions, 7 deletions
diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst
index 92dd8dc..766122b 100644
--- a/Doc/library/unittest.rst
+++ b/Doc/library/unittest.rst
@@ -530,7 +530,7 @@ the test unless the passed object has a certain attribute::
def skipUnlessHasattr(obj, attr):
if hasattr(obj, attr):
return lambda func: func
- return unittest.skip("{0!r} doesn't have {1!r}".format(obj, attr))
+ return unittest.skip("{!r} doesn't have {!r}".format(obj, attr))
The following decorators implement test skipping and expected failures:
@@ -552,6 +552,13 @@ The following decorators implement test skipping and expected failures:
Mark the test as an expected failure. If the test fails when run, the test
is not counted as a failure.
+.. exception:: SkipTest(reason)
+
+ This exception is raised to skip a test.
+
+ Usually you can use :meth:`TestCase.skipTest` or one of the skipping
+ decorators instead of raising this directly.
+
Skipped tests will not have :meth:`setUp` or :meth:`tearDown` run around them.
Skipped classes will not have :meth:`setUpClass` or :meth:`tearDownClass` run.
@@ -1571,7 +1578,7 @@ Loading and running tests
If importing a module fails, for example due to a syntax error, then this
will be recorded as a single error and discovery will continue. If the
- import failure is due to ``SkipTest`` being raised, it will be recorded
+ import failure is due to :exc:`SkipTest` being raised, it will be recorded
as a skip instead of an error.
If a test package name (directory with :file:`__init__.py`) matches the
@@ -1592,8 +1599,8 @@ Loading and running tests
.. versionadded:: 3.2
.. versionchanged:: 3.4
- Modules that raise ``SkipTest`` on import are recorded as skips, not
- errors.
+ Modules that raise :exc:`SkipTest` on import are recorded as skips,
+ not errors.
.. versionchanged:: 3.4
Paths are sorted before being imported to ensure execution order for a
@@ -2066,7 +2073,7 @@ then you must call up to them yourself. The implementations in
If an exception is raised during a ``setUpClass`` then the tests in the class
are not run and the ``tearDownClass`` is not run. Skipped classes will not
have ``setUpClass`` or ``tearDownClass`` run. If the exception is a
-``SkipTest`` exception then the class will be reported as having been skipped
+:exc:`SkipTest` exception then the class will be reported as having been skipped
instead of as an error.
@@ -2083,7 +2090,7 @@ These should be implemented as functions::
If an exception is raised in a ``setUpModule`` then none of the tests in the
module will be run and the ``tearDownModule`` will not be run. If the exception is a
-``SkipTest`` exception then the module will be reported as having been skipped
+:exc:`SkipTest` exception then the module will be reported as having been skipped
instead of as an error.
diff --git a/Lib/unittest/case.py b/Lib/unittest/case.py
index cf7301b..881a690 100644
--- a/Lib/unittest/case.py
+++ b/Lib/unittest/case.py
@@ -23,7 +23,7 @@ class SkipTest(Exception):
"""
Raise this exception in a test to skip it.
- Usually you can use TestResult.skip() or one of the skipping decorators
+ Usually you can use TestCase.skipTest() or one of the skipping decorators
instead of raising this directly.
"""