Skip to content

bpo-37094: Add example for TestCase.skipTest in unittest doc #13645

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 31, 2019
Merged

bpo-37094: Add example for TestCase.skipTest in unittest doc #13645

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bedbc1b
Add example for TestCase.skipTest in unittest doc
MakDon May 29, 2019
8116824
update output example
MakDon May 29, 2019
6164b9a
Update unittest.rst
MakDon May 29, 2019
88bd144
Apply suggestions from code review
MakDon May 31, 2019
4aeb772
Update unittest.rst
MakDon May 31, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions Doc/library/unittest.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::

Expand All @@ -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::

Expand Down Expand Up @@ -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)

Expand Down