[Python-checkins] cpython (3.2): #17329: document unittest.SkipTest. Initial patch by Zachary Ware.

Wed Mar 27 19:16:47 CET 2013

http://hg.python.org/cpython/rev/cd5c23583fa5
changeset: 82974:cd5c23583fa5
branch: 3.2
parent: 82970:e7795a178b0a
user: Ezio Melotti <ezio.melotti at gmail.com>
date: Wed Mar 27 20:11:55 2013 +0200
summary:
 #17329: document unittest.SkipTest. Initial patch by Zachary Ware.
files:
 Doc/library/unittest.rst | 13 ++++++++++---
 Lib/unittest/case.py | 2 +-
 2 files changed, 11 insertions(+), 4 deletions(-)

diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst
--- a/Doc/library/unittest.rst
+++ b/Doc/library/unittest.rst
@@ -663,7 +663,7 @@
 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:
 
@@ -685,6 +685,13 @@
 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.
 
@@ -2105,7 +2112,7 @@
 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.
 
 
@@ -2122,7 +2129,7 @@
 
 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
--- a/Lib/unittest/case.py
+++ b/Lib/unittest/case.py
@@ -23,7 +23,7 @@
 """
 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.
 """
 
-- 
Repository URL: http://hg.python.org/cpython
