How do I skip a whole Python 'unittest' module at run time?

Question

I would like my Python unittest module to tell the test runner to skip it entirety under some situations (such as being unable to import a module or locate a critical resource).

I can use @unittest.skipIf(...) to skip a unittest.TestCase class, but how do I skip the entire module? Applying skips to every class is not sufficient because the class definitions themselves could cause exceptions if a module fails to import.

Answer 1

If you look at the definition of unittest.skipIf and unittest.skip, you can see that the key is doing raise unittest.SkipTest(reason) when the test is executed. If you're okay with having it show up as one skipped test instead of several in the testrunner, you can simply raise unittest.SkipTest yourself on import:

import unittest try:     # do thing except SomeException:     raise unittest.SkipTest("Such-and-such failed. Skipping all tests in foo.py") 

Running with nosetests -v gives:

Failure: SkipTest (Such-and-such failed. Skipping all tests in foo.py) ... SKIP: Such-and-such failed. Skipping all tests in foo.py  ---------------------------------------------------------------------- Ran 1 test in 0.002s  OK (SKIP=1) 

Answer 2

I found that using skipTest in setUp worked well. If you need a module imported, you use a try block to set e.g. module_failed = True, and in setUp call skipTest if it's set. This reports the correct number of test skips with only a short try block needed:

import unittest  try:     import my_module     module_failed = False except ImportError:     module_failed = True  class MyTests(unittest.TestCase):     def setUp(self):         if module_failed:             self.skipTest('module not tested')      def test_something(self):             #...