summaryrefslogtreecommitdiff
path: root/Doc
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2019-05-31 09:31:53 -0700
committerGitHub <noreply@github.com>2019-05-31 09:31:53 -0700
commit8135455c840b9e169a6cd527cb1ee922cafb9109 (patch)
tree7c086048f1482b7a6ffb47a87462f1e819b886c9 /Doc
parentee114d7795d3490a98d9a788dc11e6da221b0b9f (diff)
downloadcpython-git-8135455c840b9e169a6cd527cb1ee922cafb9109.tar.gz
bpo-37094: Add example for TestCase.skipTest in unittest doc (GH-13645)
Also includes other minor test skipping doc improvements. https://bugs.python.org/issue37094 (cherry picked from commit ffed76b6fc4d7dd0244b662d6e5738eb496d9def) Co-authored-by: Makdon <makdon@makdon.me>
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/unittest.rst16
1 files changed, 12 insertions, 4 deletions
diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst
index 13230daf85..bbe14299ed 100644
--- a/Doc/library/unittest.rst
+++ b/Doc/library/unittest.rst
@@ -510,7 +510,8 @@ that is broken and will fail, but shouldn't be counted as a failure on a
:class:`TestResult`.
Skipping a test is simply a matter of using the :func:`skip` :term:`decorator`
-or one of its conditional variants.
+or one of its conditional variants, calling :meth:`TestCase.skipTest` within a
+:meth:`~TestCase.setUp` or test method, or raising :exc:`SkipTest` directly.
Basic skipping looks like this::
@@ -531,16 +532,23 @@ Basic skipping looks like this::
# windows specific testing code
pass
+ def test_maybe_skipped(self):
+ if not external_resource_available():
+ self.skipTest("external resource not available")
+ # test code that depends on the external resource
+ pass
+
This is the output of running the example above in verbose mode::
test_format (__main__.MyTestCase) ... skipped 'not supported in this library version'
test_nothing (__main__.MyTestCase) ... skipped 'demonstrating skipping'
+ test_maybe_skipped (__main__.MyTestCase) ... skipped 'external resource not available'
test_windows_support (__main__.MyTestCase) ... skipped 'requires Windows'
----------------------------------------------------------------------
- Ran 3 tests in 0.005s
+ Ran 4 tests in 0.005s
- OK (skipped=3)
+ OK (skipped=4)
Classes can be skipped just like methods::
@@ -568,7 +576,7 @@ the test unless the passed object has a certain attribute::
return lambda func: func
return unittest.skip("{!r} doesn't have {!r}".format(obj, attr))
-The following decorators implement test skipping and expected failures:
+The following decorators and exception implement test skipping and expected failures:
.. decorator:: skip(reason)