From 68beef66335707f8d0daac208dcf56bfcece8315 Mon Sep 17 00:00:00 2001 From: Ezio Melotti Date: Sun, 28 Feb 2010 03:11:07 +0000 Subject: [PATCH] Pep8ify test names in the examples. --- Doc/library/unittest.rst | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst index 67e711c05dc..68ad8ccbf2d 100644 --- a/Doc/library/unittest.rst +++ b/Doc/library/unittest.rst @@ -165,9 +165,9 @@ command line. For example, the last two lines may be replaced with:: Running the revised script from the interpreter or another script produces the following output:: - testchoice (__main__.TestSequenceFunctions) ... ok - testsample (__main__.TestSequenceFunctions) ... ok - testshuffle (__main__.TestSequenceFunctions) ... ok + test_choice (__main__.TestSequenceFunctions) ... ok + test_sample (__main__.TestSequenceFunctions) ... ok + test_shuffle (__main__.TestSequenceFunctions) ... ok ---------------------------------------------------------------------- Ran 3 tests in 0.110s @@ -351,32 +351,32 @@ mechanism:: self.widget.dispose() self.widget = None - def testDefaultSize(self): + def test_default_size(self): self.assertEqual(self.widget.size(), (50,50), 'incorrect default size') - def testResize(self): + def test_resize(self): self.widget.resize(100,150) self.assertEqual(self.widget.size(), (100,150), 'wrong size after resize') Here we have not provided a :meth:`~TestCase.runTest` method, but have instead provided two different test methods. Class instances will now each run one of -the :meth:`test\*` methods, with ``self.widget`` created and destroyed +the :meth:`test_\*` methods, with ``self.widget`` created and destroyed separately for each instance. When creating an instance we must specify the test method it is to run. We do this by passing the method name in the constructor:: - defaultSizeTestCase = WidgetTestCase('testDefaultSize') - resizeTestCase = WidgetTestCase('testResize') + defaultSizeTestCase = WidgetTestCase('test_default_size') + resizeTestCase = WidgetTestCase('test_resize') Test case instances are grouped together according to the features they test. :mod:`unittest` provides a mechanism for this: the :dfn:`test suite`, represented by :mod:`unittest`'s :class:`TestSuite` class:: widgetTestSuite = unittest.TestSuite() - widgetTestSuite.addTest(WidgetTestCase('testDefaultSize')) - widgetTestSuite.addTest(WidgetTestCase('testResize')) + widgetTestSuite.addTest(WidgetTestCase('test_default_size')) + widgetTestSuite.addTest(WidgetTestCase('test_resize')) For the ease of running tests, as we will see later, it is a good idea to provide in each test module a callable object that returns a pre-built test @@ -384,14 +384,14 @@ suite:: def suite(): suite = unittest.TestSuite() - suite.addTest(WidgetTestCase('testDefaultSize')) - suite.addTest(WidgetTestCase('testResize')) + suite.addTest(WidgetTestCase('test_default_size')) + suite.addTest(WidgetTestCase('test_resize')) return suite or even:: def suite(): - tests = ['testDefaultSize', 'testResize'] + tests = ['test_default_size', 'test_resize'] return unittest.TestSuite(map(WidgetTestCase, tests)) @@ -402,8 +402,8 @@ populating it with individual tests. For example, :: suite = unittest.TestLoader().loadTestsFromTestCase(WidgetTestCase) -will create a test suite that will run ``WidgetTestCase.testDefaultSize()`` and -``WidgetTestCase.testResize``. :class:`TestLoader` uses the ``'test'`` method +will create a test suite that will run ``WidgetTestCase.test_default_size()`` and +``WidgetTestCase.test_resize``. :class:`TestLoader` uses the ``'test'`` method name prefix to identify test methods automatically. Note that the order in which the various test cases will be run is determined by @@ -610,8 +610,8 @@ Test cases def suite(): suite = unittest.TestSuite() - suite.addTest(WidgetTestCase('testDefaultSize')) - suite.addTest(WidgetTestCase('testResize')) + suite.addTest(WidgetTestCase('test_default_size')) + suite.addTest(WidgetTestCase('test_resize')) return suite Here, we create two instances of :class:`WidgetTestCase`, each of which runs a