Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 1 | from contextlib import contextmanager |
Brett Cannon | 905c31c | 2007-12-20 10:09:52 +0000 | [diff] [blame] | 2 | import linecache |
Raymond Hettinger | dc9dcf1 | 2003-07-13 06:15:11 +0000 | [diff] [blame] | 3 | import os |
Brett Cannon | 905c31c | 2007-12-20 10:09:52 +0000 | [diff] [blame] | 4 | import StringIO |
Brett Cannon | 855da6c | 2007-08-17 20:16:15 +0000 | [diff] [blame] | 5 | import sys |
Raymond Hettinger | d6f6e50 | 2003-07-13 08:37:40 +0000 | [diff] [blame] | 6 | import unittest |
Philip Jenvey | aebbaeb | 2010-04-06 23:24:45 +0000 | [diff] [blame] | 7 | import subprocess |
Raymond Hettinger | d6f6e50 | 2003-07-13 08:37:40 +0000 | [diff] [blame] | 8 | from test import test_support |
Antoine Pitrou | 9c9e1b9 | 2010-11-10 14:03:31 +0000 | [diff] [blame] | 9 | from test.script_helper import assert_python_ok |
Jeremy Hylton | 8501466 | 2003-07-11 15:37:59 +0000 | [diff] [blame] | 10 | |
Walter Dörwald | e1a9b42 | 2007-04-03 16:53:43 +0000 | [diff] [blame] | 11 | import warning_tests |
| 12 | |
Brett Cannon | 667bb4f | 2008-04-13 02:42:36 +0000 | [diff] [blame] | 13 | import warnings as original_warnings |
| 14 | |
Nick Coghlan | 5533ff6 | 2009-04-22 15:26:04 +0000 | [diff] [blame] | 15 | py_warnings = test_support.import_fresh_module('warnings', blocked=['_warnings']) |
| 16 | c_warnings = test_support.import_fresh_module('warnings', fresh=['_warnings']) |
Brett Cannon | 667bb4f | 2008-04-13 02:42:36 +0000 | [diff] [blame] | 17 | |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 18 | @contextmanager |
| 19 | def warnings_state(module): |
| 20 | """Use a specific warnings implementation in warning_tests.""" |
| 21 | global __warningregistry__ |
| 22 | for to_clear in (sys, warning_tests): |
| 23 | try: |
| 24 | to_clear.__warningregistry__.clear() |
| 25 | except AttributeError: |
| 26 | pass |
| 27 | try: |
| 28 | __warningregistry__.clear() |
| 29 | except NameError: |
| 30 | pass |
| 31 | original_warnings = warning_tests.warnings |
Florent Xicluna | fd37dd4 | 2010-03-25 20:39:10 +0000 | [diff] [blame] | 32 | original_filters = module.filters |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 33 | try: |
Florent Xicluna | fd37dd4 | 2010-03-25 20:39:10 +0000 | [diff] [blame] | 34 | module.filters = original_filters[:] |
| 35 | module.simplefilter("once") |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 36 | warning_tests.warnings = module |
| 37 | yield |
| 38 | finally: |
| 39 | warning_tests.warnings = original_warnings |
Florent Xicluna | fd37dd4 | 2010-03-25 20:39:10 +0000 | [diff] [blame] | 40 | module.filters = original_filters |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 41 | |
| 42 | |
Brett Cannon | 667bb4f | 2008-04-13 02:42:36 +0000 | [diff] [blame] | 43 | class BaseTest(unittest.TestCase): |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 44 | |
Brett Cannon | 667bb4f | 2008-04-13 02:42:36 +0000 | [diff] [blame] | 45 | """Basic bookkeeping required for testing.""" |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 46 | |
| 47 | def setUp(self): |
Brett Cannon | 667bb4f | 2008-04-13 02:42:36 +0000 | [diff] [blame] | 48 | # The __warningregistry__ needs to be in a pristine state for tests |
| 49 | # to work properly. |
| 50 | if '__warningregistry__' in globals(): |
| 51 | del globals()['__warningregistry__'] |
| 52 | if hasattr(warning_tests, '__warningregistry__'): |
| 53 | del warning_tests.__warningregistry__ |
| 54 | if hasattr(sys, '__warningregistry__'): |
| 55 | del sys.__warningregistry__ |
| 56 | # The 'warnings' module must be explicitly set so that the proper |
| 57 | # interaction between _warnings and 'warnings' can be controlled. |
| 58 | sys.modules['warnings'] = self.module |
| 59 | super(BaseTest, self).setUp() |
| 60 | |
| 61 | def tearDown(self): |
| 62 | sys.modules['warnings'] = original_warnings |
| 63 | super(BaseTest, self).tearDown() |
| 64 | |
| 65 | |
| 66 | class FilterTests(object): |
| 67 | |
| 68 | """Testing the filtering functionality.""" |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 69 | |
| 70 | def test_error(self): |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 71 | with original_warnings.catch_warnings(module=self.module) as w: |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 72 | self.module.resetwarnings() |
| 73 | self.module.filterwarnings("error", category=UserWarning) |
| 74 | self.assertRaises(UserWarning, self.module.warn, |
| 75 | "FilterTests.test_error") |
| 76 | |
| 77 | def test_ignore(self): |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 78 | with original_warnings.catch_warnings(record=True, |
| 79 | module=self.module) as w: |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 80 | self.module.resetwarnings() |
| 81 | self.module.filterwarnings("ignore", category=UserWarning) |
| 82 | self.module.warn("FilterTests.test_ignore", UserWarning) |
Ezio Melotti | 2623a37 | 2010-11-21 13:34:58 +0000 | [diff] [blame] | 83 | self.assertEqual(len(w), 0) |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 84 | |
| 85 | def test_always(self): |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 86 | with original_warnings.catch_warnings(record=True, |
| 87 | module=self.module) as w: |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 88 | self.module.resetwarnings() |
| 89 | self.module.filterwarnings("always", category=UserWarning) |
| 90 | message = "FilterTests.test_always" |
| 91 | self.module.warn(message, UserWarning) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 92 | self.assertTrue(message, w[-1].message) |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 93 | self.module.warn(message, UserWarning) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 94 | self.assertTrue(w[-1].message, message) |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 95 | |
| 96 | def test_default(self): |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 97 | with original_warnings.catch_warnings(record=True, |
| 98 | module=self.module) as w: |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 99 | self.module.resetwarnings() |
| 100 | self.module.filterwarnings("default", category=UserWarning) |
| 101 | message = UserWarning("FilterTests.test_default") |
| 102 | for x in xrange(2): |
| 103 | self.module.warn(message, UserWarning) |
| 104 | if x == 0: |
Ezio Melotti | 2623a37 | 2010-11-21 13:34:58 +0000 | [diff] [blame] | 105 | self.assertEqual(w[-1].message, message) |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 106 | del w[:] |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 107 | elif x == 1: |
Ezio Melotti | 2623a37 | 2010-11-21 13:34:58 +0000 | [diff] [blame] | 108 | self.assertEqual(len(w), 0) |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 109 | else: |
| 110 | raise ValueError("loop variant unhandled") |
| 111 | |
| 112 | def test_module(self): |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 113 | with original_warnings.catch_warnings(record=True, |
| 114 | module=self.module) as w: |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 115 | self.module.resetwarnings() |
| 116 | self.module.filterwarnings("module", category=UserWarning) |
| 117 | message = UserWarning("FilterTests.test_module") |
| 118 | self.module.warn(message, UserWarning) |
Ezio Melotti | 2623a37 | 2010-11-21 13:34:58 +0000 | [diff] [blame] | 119 | self.assertEqual(w[-1].message, message) |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 120 | del w[:] |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 121 | self.module.warn(message, UserWarning) |
Ezio Melotti | 2623a37 | 2010-11-21 13:34:58 +0000 | [diff] [blame] | 122 | self.assertEqual(len(w), 0) |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 123 | |
| 124 | def test_once(self): |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 125 | with original_warnings.catch_warnings(record=True, |
| 126 | module=self.module) as w: |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 127 | self.module.resetwarnings() |
| 128 | self.module.filterwarnings("once", category=UserWarning) |
| 129 | message = UserWarning("FilterTests.test_once") |
| 130 | self.module.warn_explicit(message, UserWarning, "test_warnings.py", |
| 131 | 42) |
Ezio Melotti | 2623a37 | 2010-11-21 13:34:58 +0000 | [diff] [blame] | 132 | self.assertEqual(w[-1].message, message) |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 133 | del w[:] |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 134 | self.module.warn_explicit(message, UserWarning, "test_warnings.py", |
| 135 | 13) |
Ezio Melotti | 2623a37 | 2010-11-21 13:34:58 +0000 | [diff] [blame] | 136 | self.assertEqual(len(w), 0) |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 137 | self.module.warn_explicit(message, UserWarning, "test_warnings2.py", |
| 138 | 42) |
Ezio Melotti | 2623a37 | 2010-11-21 13:34:58 +0000 | [diff] [blame] | 139 | self.assertEqual(len(w), 0) |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 140 | |
| 141 | def test_inheritance(self): |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 142 | with original_warnings.catch_warnings(module=self.module) as w: |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 143 | self.module.resetwarnings() |
| 144 | self.module.filterwarnings("error", category=Warning) |
| 145 | self.assertRaises(UserWarning, self.module.warn, |
| 146 | "FilterTests.test_inheritance", UserWarning) |
| 147 | |
| 148 | def test_ordering(self): |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 149 | with original_warnings.catch_warnings(record=True, |
| 150 | module=self.module) as w: |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 151 | self.module.resetwarnings() |
| 152 | self.module.filterwarnings("ignore", category=UserWarning) |
| 153 | self.module.filterwarnings("error", category=UserWarning, |
| 154 | append=True) |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 155 | del w[:] |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 156 | try: |
| 157 | self.module.warn("FilterTests.test_ordering", UserWarning) |
| 158 | except UserWarning: |
| 159 | self.fail("order handling for actions failed") |
Ezio Melotti | 2623a37 | 2010-11-21 13:34:58 +0000 | [diff] [blame] | 160 | self.assertEqual(len(w), 0) |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 161 | |
| 162 | def test_filterwarnings(self): |
| 163 | # Test filterwarnings(). |
| 164 | # Implicitly also tests resetwarnings(). |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 165 | with original_warnings.catch_warnings(record=True, |
| 166 | module=self.module) as w: |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 167 | self.module.filterwarnings("error", "", Warning, "", 0) |
| 168 | self.assertRaises(UserWarning, self.module.warn, 'convert to error') |
| 169 | |
| 170 | self.module.resetwarnings() |
| 171 | text = 'handle normally' |
| 172 | self.module.warn(text) |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 173 | self.assertEqual(str(w[-1].message), text) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 174 | self.assertTrue(w[-1].category is UserWarning) |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 175 | |
| 176 | self.module.filterwarnings("ignore", "", Warning, "", 0) |
| 177 | text = 'filtered out' |
| 178 | self.module.warn(text) |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 179 | self.assertNotEqual(str(w[-1].message), text) |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 180 | |
| 181 | self.module.resetwarnings() |
| 182 | self.module.filterwarnings("error", "hex*", Warning, "", 0) |
| 183 | self.assertRaises(UserWarning, self.module.warn, 'hex/oct') |
| 184 | text = 'nonmatching text' |
| 185 | self.module.warn(text) |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 186 | self.assertEqual(str(w[-1].message), text) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 187 | self.assertTrue(w[-1].category is UserWarning) |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 188 | |
Brett Cannon | 667bb4f | 2008-04-13 02:42:36 +0000 | [diff] [blame] | 189 | class CFilterTests(BaseTest, FilterTests): |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 190 | module = c_warnings |
| 191 | |
Brett Cannon | 667bb4f | 2008-04-13 02:42:36 +0000 | [diff] [blame] | 192 | class PyFilterTests(BaseTest, FilterTests): |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 193 | module = py_warnings |
| 194 | |
| 195 | |
| 196 | class WarnTests(unittest.TestCase): |
| 197 | |
| 198 | """Test warnings.warn() and warnings.warn_explicit().""" |
| 199 | |
| 200 | def test_message(self): |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 201 | with original_warnings.catch_warnings(record=True, |
| 202 | module=self.module) as w: |
Florent Xicluna | fd37dd4 | 2010-03-25 20:39:10 +0000 | [diff] [blame] | 203 | self.module.simplefilter("once") |
Walter Dörwald | e6dae6c | 2007-04-03 18:33:29 +0000 | [diff] [blame] | 204 | for i in range(4): |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 205 | text = 'multi %d' %i # Different text on each call. |
| 206 | self.module.warn(text) |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 207 | self.assertEqual(str(w[-1].message), text) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 208 | self.assertTrue(w[-1].category is UserWarning) |
Raymond Hettinger | d6f6e50 | 2003-07-13 08:37:40 +0000 | [diff] [blame] | 209 | |
Walter Dörwald | e1a9b42 | 2007-04-03 16:53:43 +0000 | [diff] [blame] | 210 | def test_filename(self): |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 211 | with warnings_state(self.module): |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 212 | with original_warnings.catch_warnings(record=True, |
| 213 | module=self.module) as w: |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 214 | warning_tests.inner("spam1") |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 215 | self.assertEqual(os.path.basename(w[-1].filename), |
| 216 | "warning_tests.py") |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 217 | warning_tests.outer("spam2") |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 218 | self.assertEqual(os.path.basename(w[-1].filename), |
| 219 | "warning_tests.py") |
Walter Dörwald | e1a9b42 | 2007-04-03 16:53:43 +0000 | [diff] [blame] | 220 | |
| 221 | def test_stacklevel(self): |
| 222 | # Test stacklevel argument |
| 223 | # make sure all messages are different, so the warning won't be skipped |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 224 | with warnings_state(self.module): |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 225 | with original_warnings.catch_warnings(record=True, |
| 226 | module=self.module) as w: |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 227 | warning_tests.inner("spam3", stacklevel=1) |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 228 | self.assertEqual(os.path.basename(w[-1].filename), |
| 229 | "warning_tests.py") |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 230 | warning_tests.outer("spam4", stacklevel=1) |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 231 | self.assertEqual(os.path.basename(w[-1].filename), |
| 232 | "warning_tests.py") |
Walter Dörwald | e1a9b42 | 2007-04-03 16:53:43 +0000 | [diff] [blame] | 233 | |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 234 | warning_tests.inner("spam5", stacklevel=2) |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 235 | self.assertEqual(os.path.basename(w[-1].filename), |
| 236 | "test_warnings.py") |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 237 | warning_tests.outer("spam6", stacklevel=2) |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 238 | self.assertEqual(os.path.basename(w[-1].filename), |
| 239 | "warning_tests.py") |
Brett Cannon | e3dcb01 | 2008-05-06 04:37:31 +0000 | [diff] [blame] | 240 | warning_tests.outer("spam6.5", stacklevel=3) |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 241 | self.assertEqual(os.path.basename(w[-1].filename), |
| 242 | "test_warnings.py") |
Walter Dörwald | e1a9b42 | 2007-04-03 16:53:43 +0000 | [diff] [blame] | 243 | |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 244 | warning_tests.inner("spam7", stacklevel=9999) |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 245 | self.assertEqual(os.path.basename(w[-1].filename), |
| 246 | "sys") |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 247 | |
Brett Cannon | 64a4bbe | 2008-05-03 03:19:39 +0000 | [diff] [blame] | 248 | def test_missing_filename_not_main(self): |
| 249 | # If __file__ is not specified and __main__ is not the module name, |
| 250 | # then __file__ should be set to the module name. |
| 251 | filename = warning_tests.__file__ |
| 252 | try: |
| 253 | del warning_tests.__file__ |
| 254 | with warnings_state(self.module): |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 255 | with original_warnings.catch_warnings(record=True, |
| 256 | module=self.module) as w: |
Brett Cannon | 64a4bbe | 2008-05-03 03:19:39 +0000 | [diff] [blame] | 257 | warning_tests.inner("spam8", stacklevel=1) |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 258 | self.assertEqual(w[-1].filename, warning_tests.__name__) |
Brett Cannon | 64a4bbe | 2008-05-03 03:19:39 +0000 | [diff] [blame] | 259 | finally: |
| 260 | warning_tests.__file__ = filename |
| 261 | |
| 262 | def test_missing_filename_main_with_argv(self): |
| 263 | # If __file__ is not specified and the caller is __main__ and sys.argv |
| 264 | # exists, then use sys.argv[0] as the file. |
| 265 | if not hasattr(sys, 'argv'): |
| 266 | return |
| 267 | filename = warning_tests.__file__ |
| 268 | module_name = warning_tests.__name__ |
| 269 | try: |
| 270 | del warning_tests.__file__ |
| 271 | warning_tests.__name__ = '__main__' |
| 272 | with warnings_state(self.module): |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 273 | with original_warnings.catch_warnings(record=True, |
| 274 | module=self.module) as w: |
Brett Cannon | 64a4bbe | 2008-05-03 03:19:39 +0000 | [diff] [blame] | 275 | warning_tests.inner('spam9', stacklevel=1) |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 276 | self.assertEqual(w[-1].filename, sys.argv[0]) |
Brett Cannon | 64a4bbe | 2008-05-03 03:19:39 +0000 | [diff] [blame] | 277 | finally: |
| 278 | warning_tests.__file__ = filename |
| 279 | warning_tests.__name__ = module_name |
| 280 | |
| 281 | def test_missing_filename_main_without_argv(self): |
| 282 | # If __file__ is not specified, the caller is __main__, and sys.argv |
| 283 | # is not set, then '__main__' is the file name. |
| 284 | filename = warning_tests.__file__ |
| 285 | module_name = warning_tests.__name__ |
| 286 | argv = sys.argv |
| 287 | try: |
| 288 | del warning_tests.__file__ |
| 289 | warning_tests.__name__ = '__main__' |
| 290 | del sys.argv |
| 291 | with warnings_state(self.module): |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 292 | with original_warnings.catch_warnings(record=True, |
| 293 | module=self.module) as w: |
Brett Cannon | 64a4bbe | 2008-05-03 03:19:39 +0000 | [diff] [blame] | 294 | warning_tests.inner('spam10', stacklevel=1) |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 295 | self.assertEqual(w[-1].filename, '__main__') |
Brett Cannon | 64a4bbe | 2008-05-03 03:19:39 +0000 | [diff] [blame] | 296 | finally: |
| 297 | warning_tests.__file__ = filename |
| 298 | warning_tests.__name__ = module_name |
| 299 | sys.argv = argv |
| 300 | |
| 301 | def test_missing_filename_main_with_argv_empty_string(self): |
| 302 | # If __file__ is not specified, the caller is __main__, and sys.argv[0] |
| 303 | # is the empty string, then '__main__ is the file name. |
| 304 | # Tests issue 2743. |
| 305 | file_name = warning_tests.__file__ |
| 306 | module_name = warning_tests.__name__ |
| 307 | argv = sys.argv |
| 308 | try: |
| 309 | del warning_tests.__file__ |
| 310 | warning_tests.__name__ = '__main__' |
| 311 | sys.argv = [''] |
| 312 | with warnings_state(self.module): |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 313 | with original_warnings.catch_warnings(record=True, |
| 314 | module=self.module) as w: |
Brett Cannon | 64a4bbe | 2008-05-03 03:19:39 +0000 | [diff] [blame] | 315 | warning_tests.inner('spam11', stacklevel=1) |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 316 | self.assertEqual(w[-1].filename, '__main__') |
Brett Cannon | 64a4bbe | 2008-05-03 03:19:39 +0000 | [diff] [blame] | 317 | finally: |
| 318 | warning_tests.__file__ = file_name |
| 319 | warning_tests.__name__ = module_name |
| 320 | sys.argv = argv |
| 321 | |
Brett Cannon | dea1b56 | 2008-06-27 00:31:13 +0000 | [diff] [blame] | 322 | def test_warn_explicit_type_errors(self): |
Ezio Melotti | c2077b0 | 2011-03-16 12:34:31 +0200 | [diff] [blame] | 323 | # warn_explicit() should error out gracefully if it is given objects |
Brett Cannon | dea1b56 | 2008-06-27 00:31:13 +0000 | [diff] [blame] | 324 | # of the wrong types. |
| 325 | # lineno is expected to be an integer. |
| 326 | self.assertRaises(TypeError, self.module.warn_explicit, |
| 327 | None, UserWarning, None, None) |
| 328 | # Either 'message' needs to be an instance of Warning or 'category' |
| 329 | # needs to be a subclass. |
| 330 | self.assertRaises(TypeError, self.module.warn_explicit, |
| 331 | None, None, None, 1) |
| 332 | # 'registry' must be a dict or None. |
| 333 | self.assertRaises((TypeError, AttributeError), |
| 334 | self.module.warn_explicit, |
| 335 | None, Warning, None, 1, registry=42) |
| 336 | |
Hirokazu Yamamoto | e78e5d2 | 2009-07-17 06:20:46 +0000 | [diff] [blame] | 337 | def test_bad_str(self): |
| 338 | # issue 6415 |
| 339 | # Warnings instance with a bad format string for __str__ should not |
| 340 | # trigger a bus error. |
| 341 | class BadStrWarning(Warning): |
| 342 | """Warning with a bad format string for __str__.""" |
| 343 | def __str__(self): |
| 344 | return ("A bad formatted string %(err)" % |
| 345 | {"err" : "there is no %(err)s"}) |
| 346 | |
| 347 | with self.assertRaises(ValueError): |
| 348 | self.module.warn(BadStrWarning()) |
| 349 | |
Brett Cannon | 64a4bbe | 2008-05-03 03:19:39 +0000 | [diff] [blame] | 350 | |
Brett Cannon | 667bb4f | 2008-04-13 02:42:36 +0000 | [diff] [blame] | 351 | class CWarnTests(BaseTest, WarnTests): |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 352 | module = c_warnings |
| 353 | |
Nick Coghlan | cd2e704 | 2009-04-11 13:31:31 +0000 | [diff] [blame] | 354 | # As an early adopter, we sanity check the |
| 355 | # test_support.import_fresh_module utility function |
| 356 | def test_accelerated(self): |
| 357 | self.assertFalse(original_warnings is self.module) |
| 358 | self.assertFalse(hasattr(self.module.warn, 'func_code')) |
| 359 | |
Brett Cannon | 667bb4f | 2008-04-13 02:42:36 +0000 | [diff] [blame] | 360 | class PyWarnTests(BaseTest, WarnTests): |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 361 | module = py_warnings |
| 362 | |
Nick Coghlan | cd2e704 | 2009-04-11 13:31:31 +0000 | [diff] [blame] | 363 | # As an early adopter, we sanity check the |
| 364 | # test_support.import_fresh_module utility function |
| 365 | def test_pure_python(self): |
| 366 | self.assertFalse(original_warnings is self.module) |
| 367 | self.assertTrue(hasattr(self.module.warn, 'func_code')) |
| 368 | |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 369 | |
| 370 | class WCmdLineTests(unittest.TestCase): |
| 371 | |
| 372 | def test_improper_input(self): |
| 373 | # Uses the private _setoption() function to test the parsing |
| 374 | # of command-line warning arguments |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 375 | with original_warnings.catch_warnings(module=self.module): |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 376 | self.assertRaises(self.module._OptionError, |
| 377 | self.module._setoption, '1:2:3:4:5:6') |
| 378 | self.assertRaises(self.module._OptionError, |
| 379 | self.module._setoption, 'bogus::Warning') |
| 380 | self.assertRaises(self.module._OptionError, |
| 381 | self.module._setoption, 'ignore:2::4:-5') |
| 382 | self.module._setoption('error::Warning::0') |
| 383 | self.assertRaises(UserWarning, self.module.warn, 'convert to error') |
| 384 | |
Antoine Pitrou | 9c9e1b9 | 2010-11-10 14:03:31 +0000 | [diff] [blame] | 385 | def test_improper_option(self): |
| 386 | # Same as above, but check that the message is printed out when |
| 387 | # the interpreter is executed. This also checks that options are |
| 388 | # actually parsed at all. |
| 389 | rc, out, err = assert_python_ok("-Wxxx", "-c", "pass") |
| 390 | self.assertIn(b"Invalid -W option ignored: invalid action: 'xxx'", err) |
| 391 | |
| 392 | def test_warnings_bootstrap(self): |
| 393 | # Check that the warnings module does get loaded when -W<some option> |
| 394 | # is used (see issue #10372 for an example of silent bootstrap failure). |
| 395 | rc, out, err = assert_python_ok("-Wi", "-c", |
| 396 | "import sys; sys.modules['warnings'].warn('foo', RuntimeWarning)") |
| 397 | # '-Wi' was observed |
| 398 | self.assertFalse(out.strip()) |
| 399 | self.assertNotIn(b'RuntimeWarning', err) |
| 400 | |
Brett Cannon | 667bb4f | 2008-04-13 02:42:36 +0000 | [diff] [blame] | 401 | class CWCmdLineTests(BaseTest, WCmdLineTests): |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 402 | module = c_warnings |
| 403 | |
Brett Cannon | 667bb4f | 2008-04-13 02:42:36 +0000 | [diff] [blame] | 404 | class PyWCmdLineTests(BaseTest, WCmdLineTests): |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 405 | module = py_warnings |
| 406 | |
| 407 | |
Brett Cannon | 667bb4f | 2008-04-13 02:42:36 +0000 | [diff] [blame] | 408 | class _WarningsTests(BaseTest): |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 409 | |
| 410 | """Tests specific to the _warnings module.""" |
| 411 | |
| 412 | module = c_warnings |
| 413 | |
| 414 | def test_filter(self): |
| 415 | # Everything should function even if 'filters' is not in warnings. |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 416 | with original_warnings.catch_warnings(module=self.module) as w: |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 417 | self.module.filterwarnings("error", "", Warning, "", 0) |
| 418 | self.assertRaises(UserWarning, self.module.warn, |
| 419 | 'convert to error') |
| 420 | del self.module.filters |
| 421 | self.assertRaises(UserWarning, self.module.warn, |
| 422 | 'convert to error') |
| 423 | |
| 424 | def test_onceregistry(self): |
| 425 | # Replacing or removing the onceregistry should be okay. |
| 426 | global __warningregistry__ |
| 427 | message = UserWarning('onceregistry test') |
| 428 | try: |
| 429 | original_registry = self.module.onceregistry |
| 430 | __warningregistry__ = {} |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 431 | with original_warnings.catch_warnings(record=True, |
| 432 | module=self.module) as w: |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 433 | self.module.resetwarnings() |
| 434 | self.module.filterwarnings("once", category=UserWarning) |
| 435 | self.module.warn_explicit(message, UserWarning, "file", 42) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 436 | self.assertEqual(w[-1].message, message) |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 437 | del w[:] |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 438 | self.module.warn_explicit(message, UserWarning, "file", 42) |
Ezio Melotti | 2623a37 | 2010-11-21 13:34:58 +0000 | [diff] [blame] | 439 | self.assertEqual(len(w), 0) |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 440 | # Test the resetting of onceregistry. |
| 441 | self.module.onceregistry = {} |
| 442 | __warningregistry__ = {} |
| 443 | self.module.warn('onceregistry test') |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 444 | self.assertEqual(w[-1].message.args, message.args) |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 445 | # Removal of onceregistry is okay. |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 446 | del w[:] |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 447 | del self.module.onceregistry |
| 448 | __warningregistry__ = {} |
| 449 | self.module.warn_explicit(message, UserWarning, "file", 42) |
Ezio Melotti | 2623a37 | 2010-11-21 13:34:58 +0000 | [diff] [blame] | 450 | self.assertEqual(len(w), 0) |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 451 | finally: |
| 452 | self.module.onceregistry = original_registry |
| 453 | |
Brett Cannon | 15ba4da | 2009-04-01 18:03:59 +0000 | [diff] [blame] | 454 | def test_default_action(self): |
| 455 | # Replacing or removing defaultaction should be okay. |
| 456 | message = UserWarning("defaultaction test") |
| 457 | original = self.module.defaultaction |
| 458 | try: |
| 459 | with original_warnings.catch_warnings(record=True, |
| 460 | module=self.module) as w: |
| 461 | self.module.resetwarnings() |
| 462 | registry = {} |
| 463 | self.module.warn_explicit(message, UserWarning, "<test>", 42, |
| 464 | registry=registry) |
| 465 | self.assertEqual(w[-1].message, message) |
| 466 | self.assertEqual(len(w), 1) |
| 467 | self.assertEqual(len(registry), 1) |
| 468 | del w[:] |
| 469 | # Test removal. |
| 470 | del self.module.defaultaction |
| 471 | __warningregistry__ = {} |
| 472 | registry = {} |
| 473 | self.module.warn_explicit(message, UserWarning, "<test>", 43, |
| 474 | registry=registry) |
| 475 | self.assertEqual(w[-1].message, message) |
| 476 | self.assertEqual(len(w), 1) |
| 477 | self.assertEqual(len(registry), 1) |
| 478 | del w[:] |
| 479 | # Test setting. |
| 480 | self.module.defaultaction = "ignore" |
| 481 | __warningregistry__ = {} |
| 482 | registry = {} |
| 483 | self.module.warn_explicit(message, UserWarning, "<test>", 44, |
| 484 | registry=registry) |
| 485 | self.assertEqual(len(w), 0) |
| 486 | finally: |
| 487 | self.module.defaultaction = original |
| 488 | |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 489 | def test_showwarning_missing(self): |
| 490 | # Test that showwarning() missing is okay. |
| 491 | text = 'del showwarning test' |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 492 | with original_warnings.catch_warnings(module=self.module): |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 493 | self.module.filterwarnings("always", category=UserWarning) |
| 494 | del self.module.showwarning |
| 495 | with test_support.captured_output('stderr') as stream: |
| 496 | self.module.warn(text) |
| 497 | result = stream.getvalue() |
Ezio Melotti | aa98058 | 2010-01-23 23:04:36 +0000 | [diff] [blame] | 498 | self.assertIn(text, result) |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 499 | |
Benjamin Peterson | d295032 | 2008-05-06 22:18:11 +0000 | [diff] [blame] | 500 | def test_showwarning_not_callable(self): |
Brett Cannon | ce3d221 | 2009-04-01 20:25:48 +0000 | [diff] [blame] | 501 | with original_warnings.catch_warnings(module=self.module): |
| 502 | self.module.filterwarnings("always", category=UserWarning) |
| 503 | old_showwarning = self.module.showwarning |
| 504 | self.module.showwarning = 23 |
| 505 | try: |
| 506 | self.assertRaises(TypeError, self.module.warn, "Warning!") |
| 507 | finally: |
| 508 | self.module.showwarning = old_showwarning |
Benjamin Peterson | d295032 | 2008-05-06 22:18:11 +0000 | [diff] [blame] | 509 | |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 510 | def test_show_warning_output(self): |
| 511 | # With showarning() missing, make sure that output is okay. |
| 512 | text = 'test show_warning' |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 513 | with original_warnings.catch_warnings(module=self.module): |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 514 | self.module.filterwarnings("always", category=UserWarning) |
| 515 | del self.module.showwarning |
| 516 | with test_support.captured_output('stderr') as stream: |
| 517 | warning_tests.inner(text) |
| 518 | result = stream.getvalue() |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 519 | self.assertEqual(result.count('\n'), 2, |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 520 | "Too many newlines in %r" % result) |
| 521 | first_line, second_line = result.split('\n', 1) |
| 522 | expected_file = os.path.splitext(warning_tests.__file__)[0] + '.py' |
Brett Cannon | c477427 | 2008-04-13 17:41:31 +0000 | [diff] [blame] | 523 | first_line_parts = first_line.rsplit(':', 3) |
Brett Cannon | 25bb818 | 2008-04-13 17:09:43 +0000 | [diff] [blame] | 524 | path, line, warning_class, message = first_line_parts |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 525 | line = int(line) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 526 | self.assertEqual(expected_file, path) |
| 527 | self.assertEqual(warning_class, ' ' + UserWarning.__name__) |
| 528 | self.assertEqual(message, ' ' + text) |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 529 | expected_line = ' ' + linecache.getline(path, line).strip() + '\n' |
| 530 | assert expected_line |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 531 | self.assertEqual(second_line, expected_line) |
Walter Dörwald | e1a9b42 | 2007-04-03 16:53:43 +0000 | [diff] [blame] | 532 | |
Victor Stinner | 65c1535 | 2011-07-04 03:05:37 +0200 | [diff] [blame] | 533 | def test_filename_none(self): |
| 534 | # issue #12467: race condition if a warning is emitted at shutdown |
| 535 | globals_dict = globals() |
| 536 | oldfile = globals_dict['__file__'] |
| 537 | try: |
| 538 | with original_warnings.catch_warnings(module=self.module) as w: |
| 539 | self.module.filterwarnings("always", category=UserWarning) |
| 540 | globals_dict['__file__'] = None |
| 541 | self.module.warn('test', UserWarning) |
| 542 | finally: |
| 543 | globals_dict['__file__'] = oldfile |
| 544 | |
Brett Cannon | 53ab5b7 | 2006-06-22 16:49:14 +0000 | [diff] [blame] | 545 | |
Brett Cannon | 905c31c | 2007-12-20 10:09:52 +0000 | [diff] [blame] | 546 | class WarningsDisplayTests(unittest.TestCase): |
| 547 | |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 548 | """Test the displaying of warnings and the ability to overload functions |
| 549 | related to displaying warnings.""" |
| 550 | |
Brett Cannon | 905c31c | 2007-12-20 10:09:52 +0000 | [diff] [blame] | 551 | def test_formatwarning(self): |
| 552 | message = "msg" |
| 553 | category = Warning |
| 554 | file_name = os.path.splitext(warning_tests.__file__)[0] + '.py' |
| 555 | line_num = 3 |
| 556 | file_line = linecache.getline(file_name, line_num).strip() |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 557 | format = "%s:%s: %s: %s\n %s\n" |
| 558 | expect = format % (file_name, line_num, category.__name__, message, |
| 559 | file_line) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 560 | self.assertEqual(expect, self.module.formatwarning(message, |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 561 | category, file_name, line_num)) |
| 562 | # Test the 'line' argument. |
| 563 | file_line += " for the win!" |
| 564 | expect = format % (file_name, line_num, category.__name__, message, |
| 565 | file_line) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 566 | self.assertEqual(expect, self.module.formatwarning(message, |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 567 | category, file_name, line_num, file_line)) |
Brett Cannon | 905c31c | 2007-12-20 10:09:52 +0000 | [diff] [blame] | 568 | |
| 569 | def test_showwarning(self): |
| 570 | file_name = os.path.splitext(warning_tests.__file__)[0] + '.py' |
| 571 | line_num = 3 |
| 572 | expected_file_line = linecache.getline(file_name, line_num).strip() |
| 573 | message = 'msg' |
| 574 | category = Warning |
| 575 | file_object = StringIO.StringIO() |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 576 | expect = self.module.formatwarning(message, category, file_name, |
| 577 | line_num) |
| 578 | self.module.showwarning(message, category, file_name, line_num, |
Brett Cannon | 905c31c | 2007-12-20 10:09:52 +0000 | [diff] [blame] | 579 | file_object) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 580 | self.assertEqual(file_object.getvalue(), expect) |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 581 | # Test 'line' argument. |
| 582 | expected_file_line += "for the win!" |
| 583 | expect = self.module.formatwarning(message, category, file_name, |
| 584 | line_num, expected_file_line) |
| 585 | file_object = StringIO.StringIO() |
| 586 | self.module.showwarning(message, category, file_name, line_num, |
| 587 | file_object, expected_file_line) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 588 | self.assertEqual(expect, file_object.getvalue()) |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 589 | |
Brett Cannon | 667bb4f | 2008-04-13 02:42:36 +0000 | [diff] [blame] | 590 | class CWarningsDisplayTests(BaseTest, WarningsDisplayTests): |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 591 | module = c_warnings |
| 592 | |
Brett Cannon | 667bb4f | 2008-04-13 02:42:36 +0000 | [diff] [blame] | 593 | class PyWarningsDisplayTests(BaseTest, WarningsDisplayTests): |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 594 | module = py_warnings |
Brett Cannon | 905c31c | 2007-12-20 10:09:52 +0000 | [diff] [blame] | 595 | |
| 596 | |
Brett Cannon | 1eaf074 | 2008-09-02 01:25:16 +0000 | [diff] [blame] | 597 | class CatchWarningTests(BaseTest): |
Nick Coghlan | 38469e2 | 2008-07-13 12:23:47 +0000 | [diff] [blame] | 598 | |
Brett Cannon | 1eaf074 | 2008-09-02 01:25:16 +0000 | [diff] [blame] | 599 | """Test catch_warnings().""" |
| 600 | |
| 601 | def test_catch_warnings_restore(self): |
Nick Coghlan | 38469e2 | 2008-07-13 12:23:47 +0000 | [diff] [blame] | 602 | wmod = self.module |
| 603 | orig_filters = wmod.filters |
| 604 | orig_showwarning = wmod.showwarning |
Nick Coghlan | d2e0938 | 2008-09-11 12:11:06 +0000 | [diff] [blame] | 605 | # Ensure both showwarning and filters are restored when recording |
| 606 | with wmod.catch_warnings(module=wmod, record=True): |
Nick Coghlan | 38469e2 | 2008-07-13 12:23:47 +0000 | [diff] [blame] | 607 | wmod.filters = wmod.showwarning = object() |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 608 | self.assertTrue(wmod.filters is orig_filters) |
| 609 | self.assertTrue(wmod.showwarning is orig_showwarning) |
Nick Coghlan | d2e0938 | 2008-09-11 12:11:06 +0000 | [diff] [blame] | 610 | # Same test, but with recording disabled |
Brett Cannon | 1eaf074 | 2008-09-02 01:25:16 +0000 | [diff] [blame] | 611 | with wmod.catch_warnings(module=wmod, record=False): |
Nick Coghlan | 38469e2 | 2008-07-13 12:23:47 +0000 | [diff] [blame] | 612 | wmod.filters = wmod.showwarning = object() |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 613 | self.assertTrue(wmod.filters is orig_filters) |
| 614 | self.assertTrue(wmod.showwarning is orig_showwarning) |
Nick Coghlan | 38469e2 | 2008-07-13 12:23:47 +0000 | [diff] [blame] | 615 | |
Brett Cannon | 1eaf074 | 2008-09-02 01:25:16 +0000 | [diff] [blame] | 616 | def test_catch_warnings_recording(self): |
Nick Coghlan | 38469e2 | 2008-07-13 12:23:47 +0000 | [diff] [blame] | 617 | wmod = self.module |
Nick Coghlan | d2e0938 | 2008-09-11 12:11:06 +0000 | [diff] [blame] | 618 | # Ensure warnings are recorded when requested |
Brett Cannon | 1eaf074 | 2008-09-02 01:25:16 +0000 | [diff] [blame] | 619 | with wmod.catch_warnings(module=wmod, record=True) as w: |
| 620 | self.assertEqual(w, []) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 621 | self.assertTrue(type(w) is list) |
Nick Coghlan | 38469e2 | 2008-07-13 12:23:47 +0000 | [diff] [blame] | 622 | wmod.simplefilter("always") |
| 623 | wmod.warn("foo") |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 624 | self.assertEqual(str(w[-1].message), "foo") |
Nick Coghlan | 38469e2 | 2008-07-13 12:23:47 +0000 | [diff] [blame] | 625 | wmod.warn("bar") |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 626 | self.assertEqual(str(w[-1].message), "bar") |
Brett Cannon | 1eaf074 | 2008-09-02 01:25:16 +0000 | [diff] [blame] | 627 | self.assertEqual(str(w[0].message), "foo") |
| 628 | self.assertEqual(str(w[1].message), "bar") |
Brett Cannon | 672237d | 2008-09-09 00:49:16 +0000 | [diff] [blame] | 629 | del w[:] |
Brett Cannon | 1eaf074 | 2008-09-02 01:25:16 +0000 | [diff] [blame] | 630 | self.assertEqual(w, []) |
Nick Coghlan | d2e0938 | 2008-09-11 12:11:06 +0000 | [diff] [blame] | 631 | # Ensure warnings are not recorded when not requested |
Nick Coghlan | 38469e2 | 2008-07-13 12:23:47 +0000 | [diff] [blame] | 632 | orig_showwarning = wmod.showwarning |
Brett Cannon | 1eaf074 | 2008-09-02 01:25:16 +0000 | [diff] [blame] | 633 | with wmod.catch_warnings(module=wmod, record=False) as w: |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 634 | self.assertTrue(w is None) |
| 635 | self.assertTrue(wmod.showwarning is orig_showwarning) |
Nick Coghlan | 38469e2 | 2008-07-13 12:23:47 +0000 | [diff] [blame] | 636 | |
Nick Coghlan | d2e0938 | 2008-09-11 12:11:06 +0000 | [diff] [blame] | 637 | def test_catch_warnings_reentry_guard(self): |
| 638 | wmod = self.module |
| 639 | # Ensure catch_warnings is protected against incorrect usage |
| 640 | x = wmod.catch_warnings(module=wmod, record=True) |
| 641 | self.assertRaises(RuntimeError, x.__exit__) |
| 642 | with x: |
| 643 | self.assertRaises(RuntimeError, x.__enter__) |
| 644 | # Same test, but with recording disabled |
| 645 | x = wmod.catch_warnings(module=wmod, record=False) |
| 646 | self.assertRaises(RuntimeError, x.__exit__) |
| 647 | with x: |
| 648 | self.assertRaises(RuntimeError, x.__enter__) |
| 649 | |
| 650 | def test_catch_warnings_defaults(self): |
| 651 | wmod = self.module |
| 652 | orig_filters = wmod.filters |
| 653 | orig_showwarning = wmod.showwarning |
| 654 | # Ensure default behaviour is not to record warnings |
| 655 | with wmod.catch_warnings(module=wmod) as w: |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 656 | self.assertTrue(w is None) |
| 657 | self.assertTrue(wmod.showwarning is orig_showwarning) |
| 658 | self.assertTrue(wmod.filters is not orig_filters) |
| 659 | self.assertTrue(wmod.filters is orig_filters) |
Nick Coghlan | d2e0938 | 2008-09-11 12:11:06 +0000 | [diff] [blame] | 660 | if wmod is sys.modules['warnings']: |
| 661 | # Ensure the default module is this one |
| 662 | with wmod.catch_warnings() as w: |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 663 | self.assertTrue(w is None) |
| 664 | self.assertTrue(wmod.showwarning is orig_showwarning) |
| 665 | self.assertTrue(wmod.filters is not orig_filters) |
| 666 | self.assertTrue(wmod.filters is orig_filters) |
Nick Coghlan | d2e0938 | 2008-09-11 12:11:06 +0000 | [diff] [blame] | 667 | |
| 668 | def test_check_warnings(self): |
| 669 | # Explicit tests for the test_support convenience wrapper |
| 670 | wmod = self.module |
Florent Xicluna | 7358854 | 2010-03-18 19:51:47 +0000 | [diff] [blame] | 671 | if wmod is not sys.modules['warnings']: |
| 672 | return |
| 673 | with test_support.check_warnings(quiet=False) as w: |
| 674 | self.assertEqual(w.warnings, []) |
| 675 | wmod.simplefilter("always") |
| 676 | wmod.warn("foo") |
| 677 | self.assertEqual(str(w.message), "foo") |
| 678 | wmod.warn("bar") |
| 679 | self.assertEqual(str(w.message), "bar") |
| 680 | self.assertEqual(str(w.warnings[0].message), "foo") |
| 681 | self.assertEqual(str(w.warnings[1].message), "bar") |
| 682 | w.reset() |
| 683 | self.assertEqual(w.warnings, []) |
Nick Coghlan | d2e0938 | 2008-09-11 12:11:06 +0000 | [diff] [blame] | 684 | |
Florent Xicluna | 7358854 | 2010-03-18 19:51:47 +0000 | [diff] [blame] | 685 | with test_support.check_warnings(): |
| 686 | # defaults to quiet=True without argument |
| 687 | pass |
| 688 | with test_support.check_warnings(('foo', UserWarning)): |
| 689 | wmod.warn("foo") |
| 690 | |
| 691 | with self.assertRaises(AssertionError): |
| 692 | with test_support.check_warnings(('', RuntimeWarning)): |
| 693 | # defaults to quiet=False with argument |
| 694 | pass |
| 695 | with self.assertRaises(AssertionError): |
| 696 | with test_support.check_warnings(('foo', RuntimeWarning)): |
| 697 | wmod.warn("foo") |
Nick Coghlan | d2e0938 | 2008-09-11 12:11:06 +0000 | [diff] [blame] | 698 | |
| 699 | |
Brett Cannon | 1eaf074 | 2008-09-02 01:25:16 +0000 | [diff] [blame] | 700 | class CCatchWarningTests(CatchWarningTests): |
Nick Coghlan | 38469e2 | 2008-07-13 12:23:47 +0000 | [diff] [blame] | 701 | module = c_warnings |
| 702 | |
Brett Cannon | 1eaf074 | 2008-09-02 01:25:16 +0000 | [diff] [blame] | 703 | class PyCatchWarningTests(CatchWarningTests): |
Nick Coghlan | 38469e2 | 2008-07-13 12:23:47 +0000 | [diff] [blame] | 704 | module = py_warnings |
| 705 | |
| 706 | |
Philip Jenvey | aebbaeb | 2010-04-06 23:24:45 +0000 | [diff] [blame] | 707 | class EnvironmentVariableTests(BaseTest): |
| 708 | |
| 709 | def test_single_warning(self): |
| 710 | newenv = os.environ.copy() |
| 711 | newenv["PYTHONWARNINGS"] = "ignore::DeprecationWarning" |
| 712 | p = subprocess.Popen([sys.executable, |
| 713 | "-c", "import sys; sys.stdout.write(str(sys.warnoptions))"], |
| 714 | stdout=subprocess.PIPE, env=newenv) |
Philip Jenvey | cdd98fb | 2010-04-10 20:27:15 +0000 | [diff] [blame] | 715 | self.assertEqual(p.communicate()[0], "['ignore::DeprecationWarning']") |
| 716 | self.assertEqual(p.wait(), 0) |
Philip Jenvey | aebbaeb | 2010-04-06 23:24:45 +0000 | [diff] [blame] | 717 | |
| 718 | def test_comma_separated_warnings(self): |
| 719 | newenv = os.environ.copy() |
| 720 | newenv["PYTHONWARNINGS"] = ("ignore::DeprecationWarning," |
| 721 | "ignore::UnicodeWarning") |
| 722 | p = subprocess.Popen([sys.executable, |
| 723 | "-c", "import sys; sys.stdout.write(str(sys.warnoptions))"], |
| 724 | stdout=subprocess.PIPE, env=newenv) |
Philip Jenvey | cdd98fb | 2010-04-10 20:27:15 +0000 | [diff] [blame] | 725 | self.assertEqual(p.communicate()[0], |
Philip Jenvey | aebbaeb | 2010-04-06 23:24:45 +0000 | [diff] [blame] | 726 | "['ignore::DeprecationWarning', 'ignore::UnicodeWarning']") |
Philip Jenvey | cdd98fb | 2010-04-10 20:27:15 +0000 | [diff] [blame] | 727 | self.assertEqual(p.wait(), 0) |
Philip Jenvey | aebbaeb | 2010-04-06 23:24:45 +0000 | [diff] [blame] | 728 | |
| 729 | def test_envvar_and_command_line(self): |
| 730 | newenv = os.environ.copy() |
| 731 | newenv["PYTHONWARNINGS"] = "ignore::DeprecationWarning" |
| 732 | p = subprocess.Popen([sys.executable, "-W" "ignore::UnicodeWarning", |
| 733 | "-c", "import sys; sys.stdout.write(str(sys.warnoptions))"], |
| 734 | stdout=subprocess.PIPE, env=newenv) |
Philip Jenvey | cdd98fb | 2010-04-10 20:27:15 +0000 | [diff] [blame] | 735 | self.assertEqual(p.communicate()[0], |
Philip Jenvey | aebbaeb | 2010-04-06 23:24:45 +0000 | [diff] [blame] | 736 | "['ignore::UnicodeWarning', 'ignore::DeprecationWarning']") |
Philip Jenvey | cdd98fb | 2010-04-10 20:27:15 +0000 | [diff] [blame] | 737 | self.assertEqual(p.wait(), 0) |
Philip Jenvey | aebbaeb | 2010-04-06 23:24:45 +0000 | [diff] [blame] | 738 | |
| 739 | class CEnvironmentVariableTests(EnvironmentVariableTests): |
| 740 | module = c_warnings |
| 741 | |
| 742 | class PyEnvironmentVariableTests(EnvironmentVariableTests): |
| 743 | module = py_warnings |
| 744 | |
| 745 | |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 746 | def test_main(): |
Amaury Forgeot d'Arc | 607bff1 | 2008-04-18 23:31:33 +0000 | [diff] [blame] | 747 | py_warnings.onceregistry.clear() |
| 748 | c_warnings.onceregistry.clear() |
Brett Cannon | 1eaf074 | 2008-09-02 01:25:16 +0000 | [diff] [blame] | 749 | test_support.run_unittest(CFilterTests, PyFilterTests, |
| 750 | CWarnTests, PyWarnTests, |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 751 | CWCmdLineTests, PyWCmdLineTests, |
| 752 | _WarningsTests, |
| 753 | CWarningsDisplayTests, PyWarningsDisplayTests, |
Brett Cannon | 1eaf074 | 2008-09-02 01:25:16 +0000 | [diff] [blame] | 754 | CCatchWarningTests, PyCatchWarningTests, |
Philip Jenvey | aebbaeb | 2010-04-06 23:24:45 +0000 | [diff] [blame] | 755 | CEnvironmentVariableTests, |
| 756 | PyEnvironmentVariableTests |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 757 | ) |
| 758 | |
| 759 | |
Raymond Hettinger | d6f6e50 | 2003-07-13 08:37:40 +0000 | [diff] [blame] | 760 | if __name__ == "__main__": |
Brett Cannon | e974689 | 2008-04-12 23:44:07 +0000 | [diff] [blame] | 761 | test_main() |