Brett Cannon | f1cfb62 | 2003-05-04 21:15:27 +0000 | [diff] [blame] | 1 | """Supporting definitions for the Python regression tests.""" |
Guido van Rossum | 3bead09 | 1992-01-27 17:00:37 +0000 | [diff] [blame] | 2 | |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 3 | if __name__ != 'test.support': |
| 4 | raise ImportError('support must be imported from the test package') |
Barry Warsaw | 408b6d3 | 2002-07-30 23:27:12 +0000 | [diff] [blame] | 5 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 6 | import contextlib |
| 7 | import errno |
Benjamin Peterson | fa0d703 | 2009-06-01 22:42:33 +0000 | [diff] [blame] | 8 | import functools |
Benjamin Peterson | 8cc7d88 | 2009-06-01 23:14:51 +0000 | [diff] [blame] | 9 | import gc |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 10 | import socket |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 11 | import sys |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 12 | import os |
Benjamin Peterson | e549ead | 2009-03-28 21:42:05 +0000 | [diff] [blame] | 13 | import platform |
Christian Heimes | 23daade0 | 2008-02-25 12:39:23 +0000 | [diff] [blame] | 14 | import shutil |
Thomas Wouters | 902d6eb | 2007-01-09 23:18:33 +0000 | [diff] [blame] | 15 | import warnings |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 16 | import unittest |
R. David Murray | a21e4ca | 2009-03-31 23:16:50 +0000 | [diff] [blame] | 17 | import importlib |
Raymond Hettinger | 57d1a88 | 2011-02-23 00:46:28 +0000 | [diff] [blame] | 18 | import collections.abc |
Florent Xicluna | b14930c | 2010-03-13 15:26:44 +0000 | [diff] [blame] | 19 | import re |
Brian Curtin | d40e6f7 | 2010-07-08 21:39:08 +0000 | [diff] [blame] | 20 | import subprocess |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 21 | import imp |
Benjamin Peterson | a6590e8 | 2010-04-11 21:22:10 +0000 | [diff] [blame] | 22 | import time |
Benjamin Peterson | 65c66ab | 2010-10-29 21:31:35 +0000 | [diff] [blame] | 23 | import sysconfig |
Antoine Pitrou | b9c73e8 | 2011-07-29 23:53:38 +0200 | [diff] [blame] | 24 | import fnmatch |
Vinay Sajip | 129fd04 | 2010-12-10 08:19:38 +0000 | [diff] [blame] | 25 | import logging.handlers |
Antoine Pitrou | 75e78b6 | 2011-10-04 11:51:23 +0200 | [diff] [blame] | 26 | import struct |
Hynek Schlawack | e02ba10 | 2012-05-23 11:22:44 +0200 | [diff] [blame] | 27 | import tempfile |
Martin v. Löwis | 33f7997 | 2012-07-29 16:33:05 +0200 | [diff] [blame] | 28 | import _testcapi |
Benjamin Peterson | 65c66ab | 2010-10-29 21:31:35 +0000 | [diff] [blame] | 29 | |
Victor Stinner | 45df820 | 2010-04-28 22:31:17 +0000 | [diff] [blame] | 30 | try: |
Antoine Pitrou | 707f228 | 2011-07-15 22:29:44 +0200 | [diff] [blame] | 31 | import _thread, threading |
Victor Stinner | 45df820 | 2010-04-28 22:31:17 +0000 | [diff] [blame] | 32 | except ImportError: |
| 33 | _thread = None |
Antoine Pitrou | 707f228 | 2011-07-15 22:29:44 +0200 | [diff] [blame] | 34 | threading = None |
| 35 | try: |
| 36 | import multiprocessing.process |
| 37 | except ImportError: |
| 38 | multiprocessing = None |
| 39 | |
Antoine Pitrou | 75e78b6 | 2011-10-04 11:51:23 +0200 | [diff] [blame] | 40 | try: |
Ezio Melotti | cad648c | 2011-05-19 21:25:10 +0300 | [diff] [blame] | 41 | import zlib |
| 42 | except ImportError: |
| 43 | zlib = None |
| 44 | |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 45 | try: |
| 46 | import bz2 |
| 47 | except ImportError: |
| 48 | bz2 = None |
| 49 | |
Martin v. Löwis | 7fb79fc | 2012-05-13 10:06:36 +0200 | [diff] [blame] | 50 | try: |
| 51 | import lzma |
| 52 | except ImportError: |
| 53 | lzma = None |
| 54 | |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 55 | __all__ = [ |
Hynek Schlawack | e02ba10 | 2012-05-23 11:22:44 +0200 | [diff] [blame] | 56 | "Error", "TestFailed", "ResourceDenied", "import_module", "verbose", |
| 57 | "use_resources", "max_memuse", "record_original_stdout", |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 58 | "get_original_stdout", "unload", "unlink", "rmtree", "forget", |
Charles-François Natali | 87b3c92 | 2011-10-03 19:40:37 +0200 | [diff] [blame] | 59 | "is_resource_enabled", "requires", "requires_freebsd_version", |
Hynek Schlawack | e02ba10 | 2012-05-23 11:22:44 +0200 | [diff] [blame] | 60 | "requires_linux_version", "requires_mac_ver", "find_unused_port", |
| 61 | "bind_port", "IPV6_ENABLED", "is_jython", "TESTFN", "HOST", "SAVEDCWD", |
| 62 | "temp_cwd", "findfile", "create_empty_file", "sortdict", |
| 63 | "check_syntax_error", "open_urlresource", "check_warnings", "CleanImport", |
| 64 | "EnvironmentVarGuard", "TransientResource", "captured_stdout", |
| 65 | "captured_stdin", "captured_stderr", "time_out", "socket_peer_reset", |
| 66 | "ioerror_peer_reset", "run_with_locale", 'temp_umask', |
Antoine Pitrou | 9c39f3c | 2011-04-28 19:18:10 +0200 | [diff] [blame] | 67 | "transient_internet", "set_memlimit", "bigmemtest", "bigaddrspacetest", |
| 68 | "BasicTestRunner", "run_unittest", "run_doctest", "threading_setup", |
| 69 | "threading_cleanup", "reap_children", "cpython_only", "check_impl_detail", |
| 70 | "get_attribute", "swap_item", "swap_attr", "requires_IEEE_754", |
Benjamin Peterson | 31dc373 | 2011-05-08 15:34:24 -0500 | [diff] [blame] | 71 | "TestHandler", "Matcher", "can_symlink", "skip_unless_symlink", |
Hynek Schlawack | e02ba10 | 2012-05-23 11:22:44 +0200 | [diff] [blame] | 72 | "skip_unless_xattr", "import_fresh_module", "requires_zlib", |
| 73 | "PIPE_MAX_SIZE", "failfast", "anticipate_failure", "run_with_tz", |
| 74 | "requires_bz2", "requires_lzma" |
Antoine Pitrou | 4d7979b | 2010-09-07 21:22:56 +0000 | [diff] [blame] | 75 | ] |
Florent Xicluna | f089fd6 | 2010-03-19 14:25:03 +0000 | [diff] [blame] | 76 | |
Fred Drake | 1790dd4 | 2000-07-24 06:55:00 +0000 | [diff] [blame] | 77 | class Error(Exception): |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 78 | """Base class for regression test exceptions.""" |
Fred Drake | 1790dd4 | 2000-07-24 06:55:00 +0000 | [diff] [blame] | 79 | |
| 80 | class TestFailed(Error): |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 81 | """Test failed.""" |
Fred Drake | 1790dd4 | 2000-07-24 06:55:00 +0000 | [diff] [blame] | 82 | |
Benjamin Peterson | e549ead | 2009-03-28 21:42:05 +0000 | [diff] [blame] | 83 | class ResourceDenied(unittest.SkipTest): |
Fred Drake | 9a0db07 | 2003-02-03 15:19:30 +0000 | [diff] [blame] | 84 | """Test skipped because it requested a disallowed resource. |
| 85 | |
| 86 | This is raised when a test calls requires() for a resource that |
| 87 | has not be enabled. It is used to distinguish between expected |
| 88 | and unexpected skips. |
| 89 | """ |
| 90 | |
Nick Coghlan | fce769e | 2009-04-11 14:30:59 +0000 | [diff] [blame] | 91 | @contextlib.contextmanager |
| 92 | def _ignore_deprecated_imports(ignore=True): |
| 93 | """Context manager to suppress package and module deprecation |
| 94 | warnings when importing them. |
| 95 | |
| 96 | If ignore is False, this context manager has no effect.""" |
| 97 | if ignore: |
| 98 | with warnings.catch_warnings(): |
| 99 | warnings.filterwarnings("ignore", ".+ (module|package)", |
| 100 | DeprecationWarning) |
| 101 | yield |
| 102 | else: |
| 103 | yield |
| 104 | |
| 105 | |
Benjamin Peterson | 699adb9 | 2008-05-08 22:27:58 +0000 | [diff] [blame] | 106 | def import_module(name, deprecated=False): |
R. David Murray | a21e4ca | 2009-03-31 23:16:50 +0000 | [diff] [blame] | 107 | """Import and return the module to be tested, raising SkipTest if |
| 108 | it is not available. |
| 109 | |
| 110 | If deprecated is True, any module or package deprecation messages |
| 111 | will be suppressed.""" |
Nick Coghlan | fce769e | 2009-04-11 14:30:59 +0000 | [diff] [blame] | 112 | with _ignore_deprecated_imports(deprecated): |
Benjamin Peterson | 699adb9 | 2008-05-08 22:27:58 +0000 | [diff] [blame] | 113 | try: |
Nick Coghlan | fce769e | 2009-04-11 14:30:59 +0000 | [diff] [blame] | 114 | return importlib.import_module(name) |
R. David Murray | a21e4ca | 2009-03-31 23:16:50 +0000 | [diff] [blame] | 115 | except ImportError as msg: |
| 116 | raise unittest.SkipTest(str(msg)) |
Nick Coghlan | fce769e | 2009-04-11 14:30:59 +0000 | [diff] [blame] | 117 | |
| 118 | |
Nick Coghlan | 4738470 | 2009-04-22 16:13:36 +0000 | [diff] [blame] | 119 | def _save_and_remove_module(name, orig_modules): |
| 120 | """Helper function to save and remove a module from sys.modules |
| 121 | |
Ezio Melotti | 199e085 | 2011-05-09 06:41:55 +0300 | [diff] [blame] | 122 | Raise ImportError if the module can't be imported.""" |
Ezio Melotti | fec3ad1 | 2011-05-14 06:02:25 +0300 | [diff] [blame] | 123 | # try to import the module and raise an error if it can't be imported |
| 124 | if name not in sys.modules: |
Ezio Melotti | 199e085 | 2011-05-09 06:41:55 +0300 | [diff] [blame] | 125 | __import__(name) |
Nick Coghlan | 4738470 | 2009-04-22 16:13:36 +0000 | [diff] [blame] | 126 | del sys.modules[name] |
Ezio Melotti | fec3ad1 | 2011-05-14 06:02:25 +0300 | [diff] [blame] | 127 | for modname in list(sys.modules): |
| 128 | if modname == name or modname.startswith(name + '.'): |
| 129 | orig_modules[modname] = sys.modules[modname] |
| 130 | del sys.modules[modname] |
Nick Coghlan | 4738470 | 2009-04-22 16:13:36 +0000 | [diff] [blame] | 131 | |
| 132 | def _save_and_block_module(name, orig_modules): |
| 133 | """Helper function to save and block a module in sys.modules |
| 134 | |
Ezio Melotti | 199e085 | 2011-05-09 06:41:55 +0300 | [diff] [blame] | 135 | Return True if the module was in sys.modules, False otherwise.""" |
Nick Coghlan | 4738470 | 2009-04-22 16:13:36 +0000 | [diff] [blame] | 136 | saved = True |
| 137 | try: |
| 138 | orig_modules[name] = sys.modules[name] |
| 139 | except KeyError: |
| 140 | saved = False |
Alexander Belopolsky | 903396e | 2010-07-13 14:50:16 +0000 | [diff] [blame] | 141 | sys.modules[name] = None |
Nick Coghlan | 4738470 | 2009-04-22 16:13:36 +0000 | [diff] [blame] | 142 | return saved |
| 143 | |
| 144 | |
Nick Coghlan | 2496f33 | 2011-09-19 20:26:31 +1000 | [diff] [blame] | 145 | def anticipate_failure(condition): |
| 146 | """Decorator to mark a test that is known to be broken in some cases |
| 147 | |
| 148 | Any use of this decorator should have a comment identifying the |
| 149 | associated tracker issue. |
| 150 | """ |
| 151 | if condition: |
| 152 | return unittest.expectedFailure |
| 153 | return lambda f: f |
| 154 | |
| 155 | |
Nick Coghlan | 4738470 | 2009-04-22 16:13:36 +0000 | [diff] [blame] | 156 | def import_fresh_module(name, fresh=(), blocked=(), deprecated=False): |
Nick Coghlan | fce769e | 2009-04-11 14:30:59 +0000 | [diff] [blame] | 157 | """Imports and returns a module, deliberately bypassing the sys.modules cache |
| 158 | and importing a fresh copy of the module. Once the import is complete, |
| 159 | the sys.modules cache is restored to its original state. |
| 160 | |
Nick Coghlan | 4738470 | 2009-04-22 16:13:36 +0000 | [diff] [blame] | 161 | Modules named in fresh are also imported anew if needed by the import. |
Ezio Melotti | 199e085 | 2011-05-09 06:41:55 +0300 | [diff] [blame] | 162 | If one of these modules can't be imported, None is returned. |
Nick Coghlan | 4738470 | 2009-04-22 16:13:36 +0000 | [diff] [blame] | 163 | |
| 164 | Importing of modules named in blocked is prevented while the fresh import |
Nick Coghlan | fce769e | 2009-04-11 14:30:59 +0000 | [diff] [blame] | 165 | takes place. |
| 166 | |
| 167 | If deprecated is True, any module or package deprecation messages |
| 168 | will be suppressed.""" |
Ezio Melotti | 6b60fb9 | 2011-05-14 06:47:51 +0300 | [diff] [blame] | 169 | # NOTE: test_heapq, test_json and test_warnings include extra sanity checks |
| 170 | # to make sure that this utility function is working as expected |
Nick Coghlan | fce769e | 2009-04-11 14:30:59 +0000 | [diff] [blame] | 171 | with _ignore_deprecated_imports(deprecated): |
Nick Coghlan | 4738470 | 2009-04-22 16:13:36 +0000 | [diff] [blame] | 172 | # Keep track of modules saved for later restoration as well |
| 173 | # as those which just need a blocking entry removed |
Nick Coghlan | fce769e | 2009-04-11 14:30:59 +0000 | [diff] [blame] | 174 | orig_modules = {} |
Nick Coghlan | 4738470 | 2009-04-22 16:13:36 +0000 | [diff] [blame] | 175 | names_to_remove = [] |
| 176 | _save_and_remove_module(name, orig_modules) |
Nick Coghlan | fce769e | 2009-04-11 14:30:59 +0000 | [diff] [blame] | 177 | try: |
Nick Coghlan | 4738470 | 2009-04-22 16:13:36 +0000 | [diff] [blame] | 178 | for fresh_name in fresh: |
| 179 | _save_and_remove_module(fresh_name, orig_modules) |
| 180 | for blocked_name in blocked: |
| 181 | if not _save_and_block_module(blocked_name, orig_modules): |
| 182 | names_to_remove.append(blocked_name) |
| 183 | fresh_module = importlib.import_module(name) |
Ezio Melotti | 199e085 | 2011-05-09 06:41:55 +0300 | [diff] [blame] | 184 | except ImportError: |
| 185 | fresh_module = None |
Nick Coghlan | fce769e | 2009-04-11 14:30:59 +0000 | [diff] [blame] | 186 | finally: |
Nick Coghlan | 4738470 | 2009-04-22 16:13:36 +0000 | [diff] [blame] | 187 | for orig_name, module in orig_modules.items(): |
| 188 | sys.modules[orig_name] = module |
| 189 | for name_to_remove in names_to_remove: |
| 190 | del sys.modules[name_to_remove] |
| 191 | return fresh_module |
Nick Coghlan | fce769e | 2009-04-11 14:30:59 +0000 | [diff] [blame] | 192 | |
Benjamin Peterson | 699adb9 | 2008-05-08 22:27:58 +0000 | [diff] [blame] | 193 | |
R. David Murray | a21e4ca | 2009-03-31 23:16:50 +0000 | [diff] [blame] | 194 | def get_attribute(obj, name): |
| 195 | """Get an attribute, raising SkipTest if AttributeError is raised.""" |
| 196 | try: |
| 197 | attribute = getattr(obj, name) |
| 198 | except AttributeError: |
Éric Araujo | 4300f69 | 2011-10-05 01:50:22 +0200 | [diff] [blame] | 199 | raise unittest.SkipTest("object %r has no attribute %r" % (obj, name)) |
R. David Murray | a21e4ca | 2009-03-31 23:16:50 +0000 | [diff] [blame] | 200 | else: |
| 201 | return attribute |
| 202 | |
Barry Warsaw | c0fb605 | 2001-08-20 22:29:23 +0000 | [diff] [blame] | 203 | verbose = 1 # Flag set to 0 by regrtest.py |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 204 | use_resources = None # Flag set to [] by regrtest.py |
| 205 | max_memuse = 0 # Disable bigmem tests (they will still be run with |
| 206 | # small sizes, to make sure they work.) |
Neal Norwitz | 3ce5d92 | 2008-08-24 07:08:55 +0000 | [diff] [blame] | 207 | real_max_memuse = 0 |
Antoine Pitrou | 216a3bc | 2011-07-23 22:33:39 +0200 | [diff] [blame] | 208 | failfast = False |
Antoine Pitrou | b9c73e8 | 2011-07-29 23:53:38 +0200 | [diff] [blame] | 209 | match_tests = None |
Guido van Rossum | 531661c | 1996-12-20 02:58:22 +0000 | [diff] [blame] | 210 | |
Tim Peters | 8dee809 | 2001-09-25 20:05:11 +0000 | [diff] [blame] | 211 | # _original_stdout is meant to hold stdout at the time regrtest began. |
| 212 | # This may be "the real" stdout, or IDLE's emulation of stdout, or whatever. |
| 213 | # The point is to have some flavor of stdout the user can actually see. |
| 214 | _original_stdout = None |
| 215 | def record_original_stdout(stdout): |
| 216 | global _original_stdout |
| 217 | _original_stdout = stdout |
| 218 | |
| 219 | def get_original_stdout(): |
| 220 | return _original_stdout or sys.stdout |
| 221 | |
Guido van Rossum | 3bead09 | 1992-01-27 17:00:37 +0000 | [diff] [blame] | 222 | def unload(name): |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 223 | try: |
| 224 | del sys.modules[name] |
| 225 | except KeyError: |
| 226 | pass |
Guido van Rossum | 3bead09 | 1992-01-27 17:00:37 +0000 | [diff] [blame] | 227 | |
Brian Curtin | 6f5c5cb | 2012-08-13 17:05:57 -0500 | [diff] [blame] | 228 | if sys.platform.startswith("win"): |
| 229 | def _waitfor(func, pathname, waitall=False): |
| 230 | # Peform the operation |
| 231 | func(pathname) |
| 232 | # Now setup the wait loop |
| 233 | if waitall: |
| 234 | dirname = pathname |
| 235 | else: |
| 236 | dirname, name = os.path.split(pathname) |
| 237 | dirname = dirname or '.' |
| 238 | # Check for `pathname` to be removed from the filesystem. |
| 239 | # The exponential backoff of the timeout amounts to a total |
| 240 | # of ~1 second after which the deletion is probably an error |
| 241 | # anyway. |
| 242 | # Testing on a i7@4.3GHz shows that usually only 1 iteration is |
| 243 | # required when contention occurs. |
| 244 | timeout = 0.001 |
| 245 | while timeout < 1.0: |
| 246 | # Note we are only testing for the existance of the file(s) in |
| 247 | # the contents of the directory regardless of any security or |
| 248 | # access rights. If we have made it this far, we have sufficient |
| 249 | # permissions to do that much using Python's equivalent of the |
| 250 | # Windows API FindFirstFile. |
| 251 | # Other Windows APIs can fail or give incorrect results when |
| 252 | # dealing with files that are pending deletion. |
| 253 | L = os.listdir(dirname) |
| 254 | if not (L if waitall else name in L): |
| 255 | return |
| 256 | # Increase the timeout and try again |
| 257 | time.sleep(timeout) |
| 258 | timeout *= 2 |
| 259 | warnings.warn('tests may fail, delete still pending for ' + pathname, |
| 260 | RuntimeWarning, stacklevel=4) |
| 261 | |
| 262 | def _unlink(filename): |
| 263 | _waitfor(os.unlink, filename) |
| 264 | |
| 265 | def _rmdir(dirname): |
| 266 | _waitfor(os.rmdir, dirname) |
| 267 | |
| 268 | def _rmtree(path): |
| 269 | def _rmtree_inner(path): |
| 270 | for name in os.listdir(path): |
| 271 | fullname = os.path.join(path, name) |
| 272 | if os.path.isdir(fullname): |
| 273 | _waitfor(_rmtree_inner, fullname, waitall=True) |
| 274 | os.rmdir(fullname) |
| 275 | else: |
| 276 | os.unlink(fullname) |
| 277 | _waitfor(_rmtree_inner, path, waitall=True) |
| 278 | _waitfor(os.rmdir, path) |
| 279 | else: |
| 280 | _unlink = os.unlink |
| 281 | _rmdir = os.rmdir |
| 282 | _rmtree = shutil.rmtree |
| 283 | |
Neal Norwitz | 0e17f8c | 2006-01-23 07:51:27 +0000 | [diff] [blame] | 284 | def unlink(filename): |
Neal Norwitz | 0e17f8c | 2006-01-23 07:51:27 +0000 | [diff] [blame] | 285 | try: |
Brian Curtin | 6f5c5cb | 2012-08-13 17:05:57 -0500 | [diff] [blame] | 286 | _unlink(filename) |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 287 | except OSError as error: |
| 288 | # The filename need not exist. |
Michael Foord | 2d9c2d5 | 2010-05-04 22:29:10 +0000 | [diff] [blame] | 289 | if error.errno not in (errno.ENOENT, errno.ENOTDIR): |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 290 | raise |
Neal Norwitz | 0e17f8c | 2006-01-23 07:51:27 +0000 | [diff] [blame] | 291 | |
Brian Curtin | 6f5c5cb | 2012-08-13 17:05:57 -0500 | [diff] [blame] | 292 | def rmdir(dirname): |
| 293 | try: |
| 294 | _rmdir(dirname) |
| 295 | except OSError as error: |
| 296 | # The directory need not exist. |
| 297 | if error.errno != errno.ENOENT: |
| 298 | raise |
| 299 | |
Christian Heimes | 23daade0 | 2008-02-25 12:39:23 +0000 | [diff] [blame] | 300 | def rmtree(path): |
| 301 | try: |
Brian Curtin | 6f5c5cb | 2012-08-13 17:05:57 -0500 | [diff] [blame] | 302 | _rmtree(path) |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 303 | except OSError as error: |
Antoine Pitrou | 7a18d21 | 2011-08-30 18:34:47 +0200 | [diff] [blame] | 304 | if error.errno != errno.ENOENT: |
Christian Heimes | 23daade0 | 2008-02-25 12:39:23 +0000 | [diff] [blame] | 305 | raise |
| 306 | |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 307 | def make_legacy_pyc(source): |
| 308 | """Move a PEP 3147 pyc/pyo file to its legacy pyc/pyo location. |
| 309 | |
| 310 | The choice of .pyc or .pyo extension is done based on the __debug__ flag |
| 311 | value. |
| 312 | |
| 313 | :param source: The file system path to the source file. The source file |
| 314 | does not need to exist, however the PEP 3147 pyc file must exist. |
| 315 | :return: The file system path to the legacy pyc file. |
| 316 | """ |
| 317 | pyc_file = imp.cache_from_source(source) |
| 318 | up_one = os.path.dirname(os.path.abspath(source)) |
| 319 | legacy_pyc = os.path.join(up_one, source + ('c' if __debug__ else 'o')) |
| 320 | os.rename(pyc_file, legacy_pyc) |
| 321 | return legacy_pyc |
| 322 | |
Guido van Rossum | 3bead09 | 1992-01-27 17:00:37 +0000 | [diff] [blame] | 323 | def forget(modname): |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 324 | """'Forget' a module was ever imported. |
| 325 | |
| 326 | This removes the module from sys.modules and deletes any PEP 3147 or |
| 327 | legacy .pyc and .pyo files. |
| 328 | """ |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 329 | unload(modname) |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 330 | for dirname in sys.path: |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 331 | source = os.path.join(dirname, modname + '.py') |
| 332 | # It doesn't matter if they exist or not, unlink all possible |
| 333 | # combinations of PEP 3147 and legacy pyc and pyo files. |
| 334 | unlink(source + 'c') |
| 335 | unlink(source + 'o') |
| 336 | unlink(imp.cache_from_source(source, debug_override=True)) |
| 337 | unlink(imp.cache_from_source(source, debug_override=False)) |
Guido van Rossum | 3bead09 | 1992-01-27 17:00:37 +0000 | [diff] [blame] | 338 | |
Antoine Pitrou | d20a5f6 | 2011-02-26 15:58:05 +0000 | [diff] [blame] | 339 | # On some platforms, should not run gui test even if it is allowed |
| 340 | # in `use_resources'. |
| 341 | if sys.platform.startswith('win'): |
| 342 | import ctypes |
| 343 | import ctypes.wintypes |
| 344 | def _is_gui_available(): |
| 345 | UOI_FLAGS = 1 |
| 346 | WSF_VISIBLE = 0x0001 |
| 347 | class USEROBJECTFLAGS(ctypes.Structure): |
| 348 | _fields_ = [("fInherit", ctypes.wintypes.BOOL), |
| 349 | ("fReserved", ctypes.wintypes.BOOL), |
| 350 | ("dwFlags", ctypes.wintypes.DWORD)] |
| 351 | dll = ctypes.windll.user32 |
| 352 | h = dll.GetProcessWindowStation() |
| 353 | if not h: |
| 354 | raise ctypes.WinError() |
| 355 | uof = USEROBJECTFLAGS() |
| 356 | needed = ctypes.wintypes.DWORD() |
| 357 | res = dll.GetUserObjectInformationW(h, |
| 358 | UOI_FLAGS, |
| 359 | ctypes.byref(uof), |
| 360 | ctypes.sizeof(uof), |
| 361 | ctypes.byref(needed)) |
| 362 | if not res: |
| 363 | raise ctypes.WinError() |
| 364 | return bool(uof.dwFlags & WSF_VISIBLE) |
| 365 | else: |
| 366 | def _is_gui_available(): |
| 367 | return True |
| 368 | |
Tim Peters | b4ee4eb | 2002-12-04 03:26:57 +0000 | [diff] [blame] | 369 | def is_resource_enabled(resource): |
Brett Cannon | f1cfb62 | 2003-05-04 21:15:27 +0000 | [diff] [blame] | 370 | """Test whether a resource is enabled. Known resources are set by |
| 371 | regrtest.py.""" |
Tim Peters | b4ee4eb | 2002-12-04 03:26:57 +0000 | [diff] [blame] | 372 | return use_resources is not None and resource in use_resources |
| 373 | |
Barry Warsaw | c0fb605 | 2001-08-20 22:29:23 +0000 | [diff] [blame] | 374 | def requires(resource, msg=None): |
Brett Cannon | f1cfb62 | 2003-05-04 21:15:27 +0000 | [diff] [blame] | 375 | """Raise ResourceDenied if the specified resource is not available. |
| 376 | |
| 377 | If the caller's module is __main__ then automatically return True. The |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 378 | possibility of False being returned occurs when regrtest.py is |
| 379 | executing. |
| 380 | """ |
Antoine Pitrou | d20a5f6 | 2011-02-26 15:58:05 +0000 | [diff] [blame] | 381 | if resource == 'gui' and not _is_gui_available(): |
| 382 | raise unittest.SkipTest("Cannot use the 'gui' resource") |
Skip Montanaro | d839ecd | 2003-04-24 19:06:57 +0000 | [diff] [blame] | 383 | # see if the caller's module is __main__ - if so, treat as if |
| 384 | # the resource was set |
Benjamin Peterson | e549ead | 2009-03-28 21:42:05 +0000 | [diff] [blame] | 385 | if sys._getframe(1).f_globals.get("__name__") == "__main__": |
Skip Montanaro | d839ecd | 2003-04-24 19:06:57 +0000 | [diff] [blame] | 386 | return |
Tim Peters | b4ee4eb | 2002-12-04 03:26:57 +0000 | [diff] [blame] | 387 | if not is_resource_enabled(resource): |
Barry Warsaw | c0fb605 | 2001-08-20 22:29:23 +0000 | [diff] [blame] | 388 | if msg is None: |
Éric Araujo | af5bacf | 2011-07-15 17:50:15 +0200 | [diff] [blame] | 389 | msg = "Use of the %r resource not enabled" % resource |
Fred Drake | 9a0db07 | 2003-02-03 15:19:30 +0000 | [diff] [blame] | 390 | raise ResourceDenied(msg) |
Barry Warsaw | c0fb605 | 2001-08-20 22:29:23 +0000 | [diff] [blame] | 391 | |
Charles-François Natali | 87b3c92 | 2011-10-03 19:40:37 +0200 | [diff] [blame] | 392 | def _requires_unix_version(sysname, min_version): |
| 393 | """Decorator raising SkipTest if the OS is `sysname` and the version is less |
| 394 | than `min_version`. |
Charles-François Natali | 239bb96 | 2011-06-03 12:55:15 +0200 | [diff] [blame] | 395 | |
Charles-François Natali | 87b3c92 | 2011-10-03 19:40:37 +0200 | [diff] [blame] | 396 | For example, @_requires_unix_version('FreeBSD', (7, 2)) raises SkipTest if |
| 397 | the FreeBSD version is less than 7.2. |
Charles-François Natali | 239bb96 | 2011-06-03 12:55:15 +0200 | [diff] [blame] | 398 | """ |
| 399 | def decorator(func): |
| 400 | @functools.wraps(func) |
| 401 | def wrapper(*args, **kw): |
Charles-François Natali | 87b3c92 | 2011-10-03 19:40:37 +0200 | [diff] [blame] | 402 | if platform.system() == sysname: |
Charles-François Natali | 239bb96 | 2011-06-03 12:55:15 +0200 | [diff] [blame] | 403 | version_txt = platform.release().split('-', 1)[0] |
| 404 | try: |
| 405 | version = tuple(map(int, version_txt.split('.'))) |
| 406 | except ValueError: |
| 407 | pass |
| 408 | else: |
| 409 | if version < min_version: |
| 410 | min_version_txt = '.'.join(map(str, min_version)) |
| 411 | raise unittest.SkipTest( |
Charles-François Natali | 87b3c92 | 2011-10-03 19:40:37 +0200 | [diff] [blame] | 412 | "%s version %s or higher required, not %s" |
| 413 | % (sysname, min_version_txt, version_txt)) |
Charles-François Natali | 239bb96 | 2011-06-03 12:55:15 +0200 | [diff] [blame] | 414 | return wrapper |
| 415 | return decorator |
Victor Stinner | fea0f4d | 2011-05-24 00:24:19 +0200 | [diff] [blame] | 416 | |
Charles-François Natali | 87b3c92 | 2011-10-03 19:40:37 +0200 | [diff] [blame] | 417 | def requires_freebsd_version(*min_version): |
| 418 | """Decorator raising SkipTest if the OS is FreeBSD and the FreeBSD version is |
| 419 | less than `min_version`. |
| 420 | |
| 421 | For example, @requires_freebsd_version(7, 2) raises SkipTest if the FreeBSD |
| 422 | version is less than 7.2. |
| 423 | """ |
| 424 | return _requires_unix_version('FreeBSD', min_version) |
| 425 | |
| 426 | def requires_linux_version(*min_version): |
| 427 | """Decorator raising SkipTest if the OS is Linux and the Linux version is |
| 428 | less than `min_version`. |
| 429 | |
| 430 | For example, @requires_linux_version(2, 6, 32) raises SkipTest if the Linux |
| 431 | version is less than 2.6.32. |
| 432 | """ |
| 433 | return _requires_unix_version('Linux', min_version) |
| 434 | |
Victor Stinner | fce9233 | 2011-06-01 12:28:04 +0200 | [diff] [blame] | 435 | def requires_mac_ver(*min_version): |
Victor Stinner | 88701e2 | 2011-06-01 13:13:04 +0200 | [diff] [blame] | 436 | """Decorator raising SkipTest if the OS is Mac OS X and the OS X |
| 437 | version if less than min_version. |
Victor Stinner | fce9233 | 2011-06-01 12:28:04 +0200 | [diff] [blame] | 438 | |
Victor Stinner | 88701e2 | 2011-06-01 13:13:04 +0200 | [diff] [blame] | 439 | For example, @requires_mac_ver(10, 5) raises SkipTest if the OS X version |
| 440 | is lesser than 10.5. |
Victor Stinner | fce9233 | 2011-06-01 12:28:04 +0200 | [diff] [blame] | 441 | """ |
Victor Stinner | 88701e2 | 2011-06-01 13:13:04 +0200 | [diff] [blame] | 442 | def decorator(func): |
| 443 | @functools.wraps(func) |
| 444 | def wrapper(*args, **kw): |
| 445 | if sys.platform == 'darwin': |
| 446 | version_txt = platform.mac_ver()[0] |
| 447 | try: |
| 448 | version = tuple(map(int, version_txt.split('.'))) |
| 449 | except ValueError: |
| 450 | pass |
| 451 | else: |
| 452 | if version < min_version: |
| 453 | min_version_txt = '.'.join(map(str, min_version)) |
| 454 | raise unittest.SkipTest( |
| 455 | "Mac OS X %s or higher required, not %s" |
| 456 | % (min_version_txt, version_txt)) |
| 457 | return func(*args, **kw) |
| 458 | wrapper.min_version = min_version |
| 459 | return wrapper |
| 460 | return decorator |
| 461 | |
Victor Stinner | fce9233 | 2011-06-01 12:28:04 +0200 | [diff] [blame] | 462 | |
Christian Heimes | 5e69685 | 2008-04-09 08:37:03 +0000 | [diff] [blame] | 463 | HOST = 'localhost' |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 464 | |
Christian Heimes | 5e69685 | 2008-04-09 08:37:03 +0000 | [diff] [blame] | 465 | def find_unused_port(family=socket.AF_INET, socktype=socket.SOCK_STREAM): |
| 466 | """Returns an unused port that should be suitable for binding. This is |
| 467 | achieved by creating a temporary socket with the same family and type as |
| 468 | the 'sock' parameter (default is AF_INET, SOCK_STREAM), and binding it to |
| 469 | the specified host address (defaults to 0.0.0.0) with the port set to 0, |
| 470 | eliciting an unused ephemeral port from the OS. The temporary socket is |
| 471 | then closed and deleted, and the ephemeral port is returned. |
| 472 | |
| 473 | Either this method or bind_port() should be used for any tests where a |
| 474 | server socket needs to be bound to a particular port for the duration of |
| 475 | the test. Which one to use depends on whether the calling code is creating |
| 476 | a python socket, or if an unused port needs to be provided in a constructor |
| 477 | or passed to an external program (i.e. the -accept argument to openssl's |
| 478 | s_server mode). Always prefer bind_port() over find_unused_port() where |
| 479 | possible. Hard coded ports should *NEVER* be used. As soon as a server |
| 480 | socket is bound to a hard coded port, the ability to run multiple instances |
| 481 | of the test simultaneously on the same host is compromised, which makes the |
| 482 | test a ticking time bomb in a buildbot environment. On Unix buildbots, this |
| 483 | may simply manifest as a failed test, which can be recovered from without |
| 484 | intervention in most cases, but on Windows, the entire python process can |
| 485 | completely and utterly wedge, requiring someone to log in to the buildbot |
| 486 | and manually kill the affected process. |
| 487 | |
| 488 | (This is easy to reproduce on Windows, unfortunately, and can be traced to |
| 489 | the SO_REUSEADDR socket option having different semantics on Windows versus |
| 490 | Unix/Linux. On Unix, you can't have two AF_INET SOCK_STREAM sockets bind, |
| 491 | listen and then accept connections on identical host/ports. An EADDRINUSE |
| 492 | socket.error will be raised at some point (depending on the platform and |
| 493 | the order bind and listen were called on each socket). |
| 494 | |
| 495 | However, on Windows, if SO_REUSEADDR is set on the sockets, no EADDRINUSE |
| 496 | will ever be raised when attempting to bind two identical host/ports. When |
| 497 | accept() is called on each socket, the second caller's process will steal |
| 498 | the port from the first caller, leaving them both in an awkwardly wedged |
| 499 | state where they'll no longer respond to any signals or graceful kills, and |
| 500 | must be forcibly killed via OpenProcess()/TerminateProcess(). |
| 501 | |
| 502 | The solution on Windows is to use the SO_EXCLUSIVEADDRUSE socket option |
| 503 | instead of SO_REUSEADDR, which effectively affords the same semantics as |
| 504 | SO_REUSEADDR on Unix. Given the propensity of Unix developers in the Open |
| 505 | Source world compared to Windows ones, this is a common mistake. A quick |
| 506 | look over OpenSSL's 0.9.8g source shows that they use SO_REUSEADDR when |
| 507 | openssl.exe is called with the 's_server' option, for example. See |
| 508 | http://bugs.python.org/issue2550 for more info. The following site also |
| 509 | has a very thorough description about the implications of both REUSEADDR |
| 510 | and EXCLUSIVEADDRUSE on Windows: |
| 511 | http://msdn2.microsoft.com/en-us/library/ms740621(VS.85).aspx) |
| 512 | |
| 513 | XXX: although this approach is a vast improvement on previous attempts to |
| 514 | elicit unused ports, it rests heavily on the assumption that the ephemeral |
| 515 | port returned to us by the OS won't immediately be dished back out to some |
| 516 | other process when we close and delete our temporary socket but before our |
| 517 | calling code has a chance to bind the returned port. We can deal with this |
| 518 | issue if/when we come across it. |
| 519 | """ |
| 520 | |
| 521 | tempsock = socket.socket(family, socktype) |
| 522 | port = bind_port(tempsock) |
| 523 | tempsock.close() |
| 524 | del tempsock |
| 525 | return port |
| 526 | |
| 527 | def bind_port(sock, host=HOST): |
| 528 | """Bind the socket to a free port and return the port number. Relies on |
| 529 | ephemeral ports in order to ensure we are using an unbound port. This is |
| 530 | important as many tests may be running simultaneously, especially in a |
| 531 | buildbot environment. This method raises an exception if the sock.family |
| 532 | is AF_INET and sock.type is SOCK_STREAM, *and* the socket has SO_REUSEADDR |
| 533 | or SO_REUSEPORT set on it. Tests should *never* set these socket options |
| 534 | for TCP/IP sockets. The only case for setting these options is testing |
| 535 | multicasting via multiple UDP sockets. |
| 536 | |
| 537 | Additionally, if the SO_EXCLUSIVEADDRUSE socket option is available (i.e. |
| 538 | on Windows), it will be set on the socket. This will prevent anyone else |
| 539 | from bind()'ing to our host/port for the duration of the test. |
| 540 | """ |
| 541 | |
| 542 | if sock.family == socket.AF_INET and sock.type == socket.SOCK_STREAM: |
| 543 | if hasattr(socket, 'SO_REUSEADDR'): |
| 544 | if sock.getsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR) == 1: |
| 545 | raise TestFailed("tests should never set the SO_REUSEADDR " \ |
| 546 | "socket option on TCP/IP sockets!") |
| 547 | if hasattr(socket, 'SO_REUSEPORT'): |
| 548 | if sock.getsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT) == 1: |
| 549 | raise TestFailed("tests should never set the SO_REUSEPORT " \ |
| 550 | "socket option on TCP/IP sockets!") |
| 551 | if hasattr(socket, 'SO_EXCLUSIVEADDRUSE'): |
| 552 | sock.setsockopt(socket.SOL_SOCKET, socket.SO_EXCLUSIVEADDRUSE, 1) |
| 553 | |
| 554 | sock.bind((host, 0)) |
| 555 | port = sock.getsockname()[1] |
| 556 | return port |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 557 | |
Antoine Pitrou | 9c39f3c | 2011-04-28 19:18:10 +0200 | [diff] [blame] | 558 | def _is_ipv6_enabled(): |
| 559 | """Check whether IPv6 is enabled on this host.""" |
| 560 | if socket.has_ipv6: |
Ross Lagerwall | 121d59f | 2012-07-07 18:40:32 +0200 | [diff] [blame] | 561 | sock = None |
Antoine Pitrou | 9c39f3c | 2011-04-28 19:18:10 +0200 | [diff] [blame] | 562 | try: |
| 563 | sock = socket.socket(socket.AF_INET6, socket.SOCK_STREAM) |
| 564 | sock.bind(('::1', 0)) |
Ross Lagerwall | 121d59f | 2012-07-07 18:40:32 +0200 | [diff] [blame] | 565 | return True |
Antoine Pitrou | 9c39f3c | 2011-04-28 19:18:10 +0200 | [diff] [blame] | 566 | except (socket.error, socket.gaierror): |
| 567 | pass |
Ross Lagerwall | 121d59f | 2012-07-07 18:40:32 +0200 | [diff] [blame] | 568 | finally: |
| 569 | if sock: |
| 570 | sock.close() |
Antoine Pitrou | 9c39f3c | 2011-04-28 19:18:10 +0200 | [diff] [blame] | 571 | return False |
| 572 | |
| 573 | IPV6_ENABLED = _is_ipv6_enabled() |
| 574 | |
Charles-François Natali | 2d51721 | 2011-05-29 16:36:44 +0200 | [diff] [blame] | 575 | |
| 576 | # A constant likely larger than the underlying OS pipe buffer size. |
| 577 | # Windows limit seems to be around 512B, and most Unix kernels have a 64K pipe |
| 578 | # buffer size: take 1M to be sure. |
| 579 | PIPE_MAX_SIZE = 1024 * 1024 |
| 580 | |
| 581 | |
Eric Smith | f24a0d9 | 2010-12-04 13:32:18 +0000 | [diff] [blame] | 582 | # decorator for skipping tests on non-IEEE 754 platforms |
| 583 | requires_IEEE_754 = unittest.skipUnless( |
| 584 | float.__getformat__("double").startswith("IEEE"), |
| 585 | "test requires IEEE 754 doubles") |
| 586 | |
Ezio Melotti | cad648c | 2011-05-19 21:25:10 +0300 | [diff] [blame] | 587 | requires_zlib = unittest.skipUnless(zlib, 'requires zlib') |
| 588 | |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 589 | requires_bz2 = unittest.skipUnless(bz2, 'requires bz2') |
| 590 | |
Martin v. Löwis | 7fb79fc | 2012-05-13 10:06:36 +0200 | [diff] [blame] | 591 | requires_lzma = unittest.skipUnless(lzma, 'requires lzma') |
| 592 | |
Finn Bock | 57bc5fa | 2002-11-01 18:02:03 +0000 | [diff] [blame] | 593 | is_jython = sys.platform.startswith('java') |
| 594 | |
Barry Warsaw | 559f668 | 2001-03-23 18:04:02 +0000 | [diff] [blame] | 595 | # Filename used for testing |
| 596 | if os.name == 'java': |
| 597 | # Jython disallows @ in module names |
| 598 | TESTFN = '$test' |
Martin v. Löwis | a94568a | 2003-05-10 07:36:56 +0000 | [diff] [blame] | 599 | else: |
Barry Warsaw | 559f668 | 2001-03-23 18:04:02 +0000 | [diff] [blame] | 600 | TESTFN = '@test' |
Walter Dörwald | 9b77553 | 2007-06-08 14:30:53 +0000 | [diff] [blame] | 601 | |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 602 | # Disambiguate TESTFN for parallel testing, while letting it remain a valid |
| 603 | # module name. |
Ezio Melotti | 184bdfb | 2010-02-18 09:37:05 +0000 | [diff] [blame] | 604 | TESTFN = "{}_{}_tmp".format(TESTFN, os.getpid()) |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 605 | |
Victor Stinner | e667e98 | 2012-11-12 01:23:15 +0100 | [diff] [blame] | 606 | # FS_NONASCII: non-ASCII character encodable by os.fsencode(), |
| 607 | # or None if there is no such character. |
| 608 | FS_NONASCII = None |
| 609 | for character in ( |
| 610 | # First try printable and common characters to have a readable filename. |
| 611 | # For each character, the encoding list are just example of encodings able |
| 612 | # to encode the character (the list is not exhaustive). |
| 613 | |
| 614 | # U+00E6 (Latin Small Letter Ae): cp1252, iso-8859-1 |
| 615 | '\u00E6', |
| 616 | # U+0130 (Latin Capital Letter I With Dot Above): cp1254, iso8859_3 |
| 617 | '\u0130', |
| 618 | # U+0141 (Latin Capital Letter L With Stroke): cp1250, cp1257 |
| 619 | '\u0141', |
| 620 | # U+03C6 (Greek Small Letter Phi): cp1253 |
| 621 | '\u03C6', |
| 622 | # U+041A (Cyrillic Capital Letter Ka): cp1251 |
| 623 | '\u041A', |
| 624 | # U+05D0 (Hebrew Letter Alef): Encodable to cp424 |
| 625 | '\u05D0', |
| 626 | # U+060C (Arabic Comma): cp864, cp1006, iso8859_6, mac_arabic |
| 627 | '\u060C', |
| 628 | # U+062A (Arabic Letter Teh): cp720 |
| 629 | '\u062A', |
| 630 | # U+0E01 (Thai Character Ko Kai): cp874 |
| 631 | '\u0E01', |
| 632 | |
| 633 | # Then try more "special" characters. "special" because they may be |
| 634 | # interpreted or displayed differently depending on the exact locale |
| 635 | # encoding and the font. |
| 636 | |
| 637 | # U+00A0 (No-Break Space) |
| 638 | '\u00A0', |
| 639 | # U+20AC (Euro Sign) |
| 640 | '\u20AC', |
| 641 | ): |
| 642 | try: |
| 643 | os.fsdecode(os.fsencode(character)) |
| 644 | except UnicodeError: |
| 645 | pass |
| 646 | else: |
| 647 | FS_NONASCII = character |
| 648 | break |
Michael Foord | 2d9c2d5 | 2010-05-04 22:29:10 +0000 | [diff] [blame] | 649 | |
Victor Stinner | d91df1a | 2010-08-18 10:56:19 +0000 | [diff] [blame] | 650 | # TESTFN_UNICODE is a non-ascii filename |
| 651 | TESTFN_UNICODE = TESTFN + "-\xe0\xf2\u0258\u0141\u011f" |
Victor Stinner | 74a833f | 2010-08-18 21:06:23 +0000 | [diff] [blame] | 652 | if sys.platform == 'darwin': |
| 653 | # In Mac OS X's VFS API file names are, by definition, canonically |
| 654 | # decomposed Unicode, encoded using UTF-8. See QA1173: |
| 655 | # http://developer.apple.com/mac/library/qa/qa2001/qa1173.html |
| 656 | import unicodedata |
| 657 | TESTFN_UNICODE = unicodedata.normalize('NFD', TESTFN_UNICODE) |
Antoine Pitrou | 8890954 | 2009-06-29 13:54:42 +0000 | [diff] [blame] | 658 | TESTFN_ENCODING = sys.getfilesystemencoding() |
Victor Stinner | 3d85a6f | 2010-08-13 13:02:04 +0000 | [diff] [blame] | 659 | |
Victor Stinner | 09c449c | 2010-08-13 22:23:24 +0000 | [diff] [blame] | 660 | # TESTFN_UNENCODABLE is a filename (str type) that should *not* be able to be |
Victor Stinner | 3d85a6f | 2010-08-13 13:02:04 +0000 | [diff] [blame] | 661 | # encoded by the filesystem encoding (in strict mode). It can be None if we |
| 662 | # cannot generate such filename. |
Victor Stinner | a0241c8 | 2010-08-15 19:28:21 +0000 | [diff] [blame] | 663 | TESTFN_UNENCODABLE = None |
Victor Stinner | 3d85a6f | 2010-08-13 13:02:04 +0000 | [diff] [blame] | 664 | if os.name in ('nt', 'ce'): |
Victor Stinner | a0241c8 | 2010-08-15 19:28:21 +0000 | [diff] [blame] | 665 | # skip win32s (0) or Windows 9x/ME (1) |
| 666 | if sys.getwindowsversion().platform >= 2: |
Victor Stinner | 8ce7df6 | 2010-09-10 11:19:59 +0000 | [diff] [blame] | 667 | # Different kinds of characters from various languages to minimize the |
| 668 | # probability that the whole name is encodable to MBCS (issue #9819) |
| 669 | TESTFN_UNENCODABLE = TESTFN + "-\u5171\u0141\u2661\u0363\uDC80" |
Victor Stinner | 3d85a6f | 2010-08-13 13:02:04 +0000 | [diff] [blame] | 670 | try: |
Victor Stinner | 09c449c | 2010-08-13 22:23:24 +0000 | [diff] [blame] | 671 | TESTFN_UNENCODABLE.encode(TESTFN_ENCODING) |
Victor Stinner | 3d85a6f | 2010-08-13 13:02:04 +0000 | [diff] [blame] | 672 | except UnicodeEncodeError: |
| 673 | pass |
| 674 | else: |
| 675 | print('WARNING: The filename %r CAN be encoded by the filesystem encoding (%s). ' |
| 676 | 'Unicode filename tests may not be effective' |
Victor Stinner | 09c449c | 2010-08-13 22:23:24 +0000 | [diff] [blame] | 677 | % (TESTFN_UNENCODABLE, TESTFN_ENCODING)) |
| 678 | TESTFN_UNENCODABLE = None |
Victor Stinner | a0241c8 | 2010-08-15 19:28:21 +0000 | [diff] [blame] | 679 | # Mac OS X denies unencodable filenames (invalid utf-8) |
Victor Stinner | 03c9e1d | 2010-08-14 17:35:20 +0000 | [diff] [blame] | 680 | elif sys.platform != 'darwin': |
Victor Stinner | 3d85a6f | 2010-08-13 13:02:04 +0000 | [diff] [blame] | 681 | try: |
| 682 | # ascii and utf-8 cannot encode the byte 0xff |
| 683 | b'\xff'.decode(TESTFN_ENCODING) |
| 684 | except UnicodeDecodeError: |
| 685 | # 0xff will be encoded using the surrogate character u+DCFF |
Victor Stinner | 09c449c | 2010-08-13 22:23:24 +0000 | [diff] [blame] | 686 | TESTFN_UNENCODABLE = TESTFN \ |
Victor Stinner | 3d85a6f | 2010-08-13 13:02:04 +0000 | [diff] [blame] | 687 | + b'-\xff'.decode(TESTFN_ENCODING, 'surrogateescape') |
| 688 | else: |
| 689 | # File system encoding (eg. ISO-8859-* encodings) can encode |
| 690 | # the byte 0xff. Skip some unicode filename tests. |
Victor Stinner | a0241c8 | 2010-08-15 19:28:21 +0000 | [diff] [blame] | 691 | pass |
Neal Norwitz | 26a1eef | 2002-11-03 00:35:53 +0000 | [diff] [blame] | 692 | |
Victor Stinner | e667e98 | 2012-11-12 01:23:15 +0100 | [diff] [blame] | 693 | # TESTFN_UNDECODABLE is a filename (bytes type) that should *not* be able to be |
| 694 | # decoded from the filesystem encoding (in strict mode). It can be None if we |
| 695 | # cannot generate such filename (ex: the latin1 encoding can decode any byte |
| 696 | # sequence). On UNIX, TESTFN_UNDECODABLE can be decoded by os.fsdecode() thanks |
| 697 | # to the surrogateescape error handler (PEP 383), but not from the filesystem |
| 698 | # encoding in strict mode. |
| 699 | TESTFN_UNDECODABLE = None |
| 700 | for name in ( |
| 701 | # b'\xff' is not decodable by os.fsdecode() with code page 932. Windows |
| 702 | # accepts it to create a file or a directory, or don't accept to enter to |
| 703 | # such directory (when the bytes name is used). So test b'\xe7' first: it is |
| 704 | # not decodable from cp932. |
| 705 | b'\xe7w\xf0', |
| 706 | # undecodable from ASCII, UTF-8 |
| 707 | b'\xff', |
| 708 | # undecodable from iso8859-3, iso8859-6, iso8859-7, cp424, iso8859-8, cp856 |
| 709 | # and cp857 |
| 710 | b'\xae\xd5' |
| 711 | # undecodable from UTF-8 (UNIX and Mac OS X) |
| 712 | b'\xed\xb2\x80', b'\xed\xb4\x80', |
Victor Stinner | 0af71aa | 2013-01-03 01:50:30 +0100 | [diff] [blame] | 713 | # undecodable from shift_jis, cp869, cp874, cp932, cp1250, cp1251, cp1252, |
| 714 | # cp1253, cp1254, cp1255, cp1257, cp1258 |
| 715 | b'\x81\x98', |
Victor Stinner | e667e98 | 2012-11-12 01:23:15 +0100 | [diff] [blame] | 716 | ): |
| 717 | try: |
| 718 | name.decode(TESTFN_ENCODING) |
| 719 | except UnicodeDecodeError: |
| 720 | TESTFN_UNDECODABLE = os.fsencode(TESTFN) + name |
| 721 | break |
| 722 | |
| 723 | if FS_NONASCII: |
| 724 | TESTFN_NONASCII = TESTFN + '-' + FS_NONASCII |
| 725 | else: |
| 726 | TESTFN_NONASCII = None |
| 727 | |
Ezio Melotti | 184bdfb | 2010-02-18 09:37:05 +0000 | [diff] [blame] | 728 | # Save the initial cwd |
| 729 | SAVEDCWD = os.getcwd() |
| 730 | |
| 731 | @contextlib.contextmanager |
Nick Coghlan | d26c18a | 2010-08-17 13:06:11 +0000 | [diff] [blame] | 732 | def temp_cwd(name='tempcwd', quiet=False, path=None): |
Ezio Melotti | 184bdfb | 2010-02-18 09:37:05 +0000 | [diff] [blame] | 733 | """ |
Nick Coghlan | d26c18a | 2010-08-17 13:06:11 +0000 | [diff] [blame] | 734 | Context manager that temporarily changes the CWD. |
Ezio Melotti | 184bdfb | 2010-02-18 09:37:05 +0000 | [diff] [blame] | 735 | |
Nick Coghlan | d26c18a | 2010-08-17 13:06:11 +0000 | [diff] [blame] | 736 | An existing path may be provided as *path*, in which case this |
| 737 | function makes no changes to the file system. |
| 738 | |
| 739 | Otherwise, the new CWD is created in the current directory and it's |
| 740 | named *name*. If *quiet* is False (default) and it's not possible to |
| 741 | create or change the CWD, an error is raised. If it's True, only a |
| 742 | warning is raised and the original CWD is used. |
Ezio Melotti | 184bdfb | 2010-02-18 09:37:05 +0000 | [diff] [blame] | 743 | """ |
| 744 | saved_dir = os.getcwd() |
| 745 | is_temporary = False |
Nick Coghlan | d26c18a | 2010-08-17 13:06:11 +0000 | [diff] [blame] | 746 | if path is None: |
| 747 | path = name |
| 748 | try: |
| 749 | os.mkdir(name) |
| 750 | is_temporary = True |
| 751 | except OSError: |
| 752 | if not quiet: |
| 753 | raise |
| 754 | warnings.warn('tests may fail, unable to create temp CWD ' + name, |
| 755 | RuntimeWarning, stacklevel=3) |
Neal Norwitz | 26a1eef | 2002-11-03 00:35:53 +0000 | [diff] [blame] | 756 | try: |
Nick Coghlan | d26c18a | 2010-08-17 13:06:11 +0000 | [diff] [blame] | 757 | os.chdir(path) |
Ezio Melotti | 184bdfb | 2010-02-18 09:37:05 +0000 | [diff] [blame] | 758 | except OSError: |
| 759 | if not quiet: |
| 760 | raise |
Ezio Melotti | e418d76 | 2012-09-21 16:48:12 +0300 | [diff] [blame] | 761 | warnings.warn('tests may fail, unable to change the CWD to ' + path, |
Ezio Melotti | 184bdfb | 2010-02-18 09:37:05 +0000 | [diff] [blame] | 762 | RuntimeWarning, stacklevel=3) |
| 763 | try: |
| 764 | yield os.getcwd() |
| 765 | finally: |
| 766 | os.chdir(saved_dir) |
| 767 | if is_temporary: |
| 768 | rmtree(name) |
| 769 | |
Guido van Rossum | a8f7e59 | 2001-03-13 09:31:07 +0000 | [diff] [blame] | 770 | |
Eli Bendersky | 6c51999 | 2011-07-23 08:48:53 +0300 | [diff] [blame] | 771 | if hasattr(os, "umask"): |
| 772 | @contextlib.contextmanager |
| 773 | def temp_umask(umask): |
| 774 | """Context manager that temporarily sets the process umask.""" |
| 775 | oldmask = os.umask(umask) |
| 776 | try: |
| 777 | yield |
| 778 | finally: |
| 779 | os.umask(oldmask) |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 780 | |
| 781 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 782 | def findfile(file, here=__file__, subdir=None): |
Brett Cannon | f1cfb62 | 2003-05-04 21:15:27 +0000 | [diff] [blame] | 783 | """Try to find a file on sys.path and the working directory. If it is not |
| 784 | found the argument passed to the function is returned (this does not |
| 785 | necessarily signal failure; could still be the legitimate path).""" |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 786 | if os.path.isabs(file): |
| 787 | return file |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 788 | if subdir is not None: |
| 789 | file = os.path.join(subdir, file) |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 790 | path = sys.path |
| 791 | path = [os.path.dirname(here)] + path |
| 792 | for dn in path: |
| 793 | fn = os.path.join(dn, file) |
| 794 | if os.path.exists(fn): return fn |
| 795 | return file |
Marc-André Lemburg | 3661908 | 2001-01-17 19:11:13 +0000 | [diff] [blame] | 796 | |
Victor Stinner | bf81622 | 2011-06-30 23:25:47 +0200 | [diff] [blame] | 797 | def create_empty_file(filename): |
| 798 | """Create an empty file. If the file already exists, truncate it.""" |
| 799 | fd = os.open(filename, os.O_WRONLY | os.O_CREAT | os.O_TRUNC) |
| 800 | os.close(fd) |
| 801 | |
Tim Peters | 2f228e7 | 2001-05-13 00:19:31 +0000 | [diff] [blame] | 802 | def sortdict(dict): |
| 803 | "Like repr(dict), but in sorted order." |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 804 | items = sorted(dict.items()) |
Tim Peters | 2f228e7 | 2001-05-13 00:19:31 +0000 | [diff] [blame] | 805 | reprpairs = ["%r: %r" % pair for pair in items] |
| 806 | withcommas = ", ".join(reprpairs) |
| 807 | return "{%s}" % withcommas |
| 808 | |
Benjamin Peterson | 7522c74 | 2009-01-19 21:00:09 +0000 | [diff] [blame] | 809 | def make_bad_fd(): |
| 810 | """ |
| 811 | Create an invalid file descriptor by opening and closing a file and return |
| 812 | its fd. |
| 813 | """ |
| 814 | file = open(TESTFN, "wb") |
| 815 | try: |
| 816 | return file.fileno() |
| 817 | finally: |
| 818 | file.close() |
| 819 | unlink(TESTFN) |
| 820 | |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 821 | def check_syntax_error(testcase, statement): |
Benjamin Peterson | e549ead | 2009-03-28 21:42:05 +0000 | [diff] [blame] | 822 | testcase.assertRaises(SyntaxError, compile, statement, |
| 823 | '<test string>', 'exec') |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 824 | |
Martin v. Löwis | 234a34a | 2007-08-30 20:58:02 +0000 | [diff] [blame] | 825 | def open_urlresource(url, *args, **kw): |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 826 | import urllib.request, urllib.parse |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 827 | |
Florent Xicluna | f089fd6 | 2010-03-19 14:25:03 +0000 | [diff] [blame] | 828 | check = kw.pop('check', None) |
| 829 | |
Jeremy Hylton | 1afc169 | 2008-06-18 20:49:58 +0000 | [diff] [blame] | 830 | filename = urllib.parse.urlparse(url)[2].split('/')[-1] # '/': it's URL! |
Hye-Shik Chang | aaa2f1d | 2005-12-10 17:44:27 +0000 | [diff] [blame] | 831 | |
Alexandre Vassalotti | 711ed4a | 2009-07-17 10:42:05 +0000 | [diff] [blame] | 832 | fn = os.path.join(os.path.dirname(__file__), "data", filename) |
Florent Xicluna | f089fd6 | 2010-03-19 14:25:03 +0000 | [diff] [blame] | 833 | |
| 834 | def check_valid_file(fn): |
| 835 | f = open(fn, *args, **kw) |
| 836 | if check is None: |
| 837 | return f |
| 838 | elif check(f): |
| 839 | f.seek(0) |
| 840 | return f |
| 841 | f.close() |
| 842 | |
Alexandre Vassalotti | 711ed4a | 2009-07-17 10:42:05 +0000 | [diff] [blame] | 843 | if os.path.exists(fn): |
Florent Xicluna | f089fd6 | 2010-03-19 14:25:03 +0000 | [diff] [blame] | 844 | f = check_valid_file(fn) |
| 845 | if f is not None: |
| 846 | return f |
| 847 | unlink(fn) |
| 848 | |
| 849 | # Verify the requirement before downloading the file |
| 850 | requires('urlfetch') |
Hye-Shik Chang | aaa2f1d | 2005-12-10 17:44:27 +0000 | [diff] [blame] | 851 | |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 852 | print('\tfetching %s ...' % url, file=get_original_stdout()) |
Antoine Pitrou | fd0680b | 2009-11-01 22:13:48 +0000 | [diff] [blame] | 853 | f = urllib.request.urlopen(url, timeout=15) |
| 854 | try: |
| 855 | with open(fn, "wb") as out: |
| 856 | s = f.read() |
| 857 | while s: |
| 858 | out.write(s) |
| 859 | s = f.read() |
| 860 | finally: |
| 861 | f.close() |
Florent Xicluna | f089fd6 | 2010-03-19 14:25:03 +0000 | [diff] [blame] | 862 | |
| 863 | f = check_valid_file(fn) |
| 864 | if f is not None: |
| 865 | return f |
Éric Araujo | af5bacf | 2011-07-15 17:50:15 +0200 | [diff] [blame] | 866 | raise TestFailed('invalid resource %r' % fn) |
Florent Xicluna | f089fd6 | 2010-03-19 14:25:03 +0000 | [diff] [blame] | 867 | |
Thomas Wouters | 9fe394c | 2007-02-05 01:24:16 +0000 | [diff] [blame] | 868 | |
Benjamin Peterson | fcf5d63 | 2008-10-16 23:24:44 +0000 | [diff] [blame] | 869 | class WarningsRecorder(object): |
| 870 | """Convenience wrapper for the warnings list returned on |
| 871 | entry to the warnings.catch_warnings() context manager. |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 872 | """ |
Benjamin Peterson | fcf5d63 | 2008-10-16 23:24:44 +0000 | [diff] [blame] | 873 | def __init__(self, warnings_list): |
Florent Xicluna | b14930c | 2010-03-13 15:26:44 +0000 | [diff] [blame] | 874 | self._warnings = warnings_list |
| 875 | self._last = 0 |
Benjamin Peterson | fcf5d63 | 2008-10-16 23:24:44 +0000 | [diff] [blame] | 876 | |
| 877 | def __getattr__(self, attr): |
Florent Xicluna | b14930c | 2010-03-13 15:26:44 +0000 | [diff] [blame] | 878 | if len(self._warnings) > self._last: |
| 879 | return getattr(self._warnings[-1], attr) |
Benjamin Peterson | fcf5d63 | 2008-10-16 23:24:44 +0000 | [diff] [blame] | 880 | elif attr in warnings.WarningMessage._WARNING_DETAILS: |
| 881 | return None |
| 882 | raise AttributeError("%r has no attribute %r" % (self, attr)) |
| 883 | |
Florent Xicluna | b14930c | 2010-03-13 15:26:44 +0000 | [diff] [blame] | 884 | @property |
| 885 | def warnings(self): |
| 886 | return self._warnings[self._last:] |
| 887 | |
Benjamin Peterson | fcf5d63 | 2008-10-16 23:24:44 +0000 | [diff] [blame] | 888 | def reset(self): |
Florent Xicluna | b14930c | 2010-03-13 15:26:44 +0000 | [diff] [blame] | 889 | self._last = len(self._warnings) |
| 890 | |
| 891 | |
| 892 | def _filterwarnings(filters, quiet=False): |
| 893 | """Catch the warnings, then check if all the expected |
| 894 | warnings have been raised and re-raise unexpected warnings. |
| 895 | If 'quiet' is True, only re-raise the unexpected warnings. |
| 896 | """ |
| 897 | # Clear the warning registry of the calling module |
| 898 | # in order to re-raise the warnings. |
| 899 | frame = sys._getframe(2) |
| 900 | registry = frame.f_globals.get('__warningregistry__') |
| 901 | if registry: |
| 902 | registry.clear() |
| 903 | with warnings.catch_warnings(record=True) as w: |
| 904 | # Set filter "always" to record all warnings. Because |
| 905 | # test_warnings swap the module, we need to look up in |
| 906 | # the sys.modules dictionary. |
| 907 | sys.modules['warnings'].simplefilter("always") |
| 908 | yield WarningsRecorder(w) |
| 909 | # Filter the recorded warnings |
Antoine Pitrou | 31e08a4 | 2010-10-29 11:54:03 +0000 | [diff] [blame] | 910 | reraise = list(w) |
Florent Xicluna | b14930c | 2010-03-13 15:26:44 +0000 | [diff] [blame] | 911 | missing = [] |
| 912 | for msg, cat in filters: |
| 913 | seen = False |
Antoine Pitrou | 31e08a4 | 2010-10-29 11:54:03 +0000 | [diff] [blame] | 914 | for w in reraise[:]: |
| 915 | warning = w.message |
Florent Xicluna | b14930c | 2010-03-13 15:26:44 +0000 | [diff] [blame] | 916 | # Filter out the matching messages |
Antoine Pitrou | 31e08a4 | 2010-10-29 11:54:03 +0000 | [diff] [blame] | 917 | if (re.match(msg, str(warning), re.I) and |
| 918 | issubclass(warning.__class__, cat)): |
Florent Xicluna | b14930c | 2010-03-13 15:26:44 +0000 | [diff] [blame] | 919 | seen = True |
Antoine Pitrou | 31e08a4 | 2010-10-29 11:54:03 +0000 | [diff] [blame] | 920 | reraise.remove(w) |
Florent Xicluna | b14930c | 2010-03-13 15:26:44 +0000 | [diff] [blame] | 921 | if not seen and not quiet: |
| 922 | # This filter caught nothing |
| 923 | missing.append((msg, cat.__name__)) |
| 924 | if reraise: |
Antoine Pitrou | 31e08a4 | 2010-10-29 11:54:03 +0000 | [diff] [blame] | 925 | raise AssertionError("unhandled warning %s" % reraise[0]) |
Florent Xicluna | b14930c | 2010-03-13 15:26:44 +0000 | [diff] [blame] | 926 | if missing: |
| 927 | raise AssertionError("filter (%r, %s) did not catch any warning" % |
| 928 | missing[0]) |
| 929 | |
Benjamin Peterson | fcf5d63 | 2008-10-16 23:24:44 +0000 | [diff] [blame] | 930 | |
| 931 | @contextlib.contextmanager |
Florent Xicluna | b14930c | 2010-03-13 15:26:44 +0000 | [diff] [blame] | 932 | def check_warnings(*filters, **kwargs): |
| 933 | """Context manager to silence warnings. |
| 934 | |
| 935 | Accept 2-tuples as positional arguments: |
| 936 | ("message regexp", WarningCategory) |
| 937 | |
| 938 | Optional argument: |
| 939 | - if 'quiet' is True, it does not fail if a filter catches nothing |
Florent Xicluna | 53b506be | 2010-03-18 20:00:57 +0000 | [diff] [blame] | 940 | (default True without argument, |
| 941 | default False if some filters are defined) |
Florent Xicluna | b14930c | 2010-03-13 15:26:44 +0000 | [diff] [blame] | 942 | |
| 943 | Without argument, it defaults to: |
Florent Xicluna | 53b506be | 2010-03-18 20:00:57 +0000 | [diff] [blame] | 944 | check_warnings(("", Warning), quiet=True) |
Florent Xicluna | b14930c | 2010-03-13 15:26:44 +0000 | [diff] [blame] | 945 | """ |
Florent Xicluna | 53b506be | 2010-03-18 20:00:57 +0000 | [diff] [blame] | 946 | quiet = kwargs.get('quiet') |
Florent Xicluna | b14930c | 2010-03-13 15:26:44 +0000 | [diff] [blame] | 947 | if not filters: |
| 948 | filters = (("", Warning),) |
Florent Xicluna | 53b506be | 2010-03-18 20:00:57 +0000 | [diff] [blame] | 949 | # Preserve backward compatibility |
| 950 | if quiet is None: |
| 951 | quiet = True |
| 952 | return _filterwarnings(filters, quiet) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 953 | |
Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 954 | |
| 955 | class CleanImport(object): |
| 956 | """Context manager to force import to return a new module reference. |
| 957 | |
| 958 | This is useful for testing module-level behaviours, such as |
Nick Coghlan | b130493 | 2008-07-13 12:25:08 +0000 | [diff] [blame] | 959 | the emission of a DeprecationWarning on import. |
Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 960 | |
| 961 | Use like this: |
| 962 | |
| 963 | with CleanImport("foo"): |
Brett Cannon | ddb5e70 | 2010-02-03 22:16:11 +0000 | [diff] [blame] | 964 | importlib.import_module("foo") # new reference |
Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 965 | """ |
| 966 | |
| 967 | def __init__(self, *module_names): |
| 968 | self.original_modules = sys.modules.copy() |
| 969 | for module_name in module_names: |
| 970 | if module_name in sys.modules: |
| 971 | module = sys.modules[module_name] |
| 972 | # It is possible that module_name is just an alias for |
| 973 | # another module (e.g. stub for modules renamed in 3.x). |
| 974 | # In that case, we also need delete the real module to clear |
| 975 | # the import cache. |
| 976 | if module.__name__ != module_name: |
| 977 | del sys.modules[module.__name__] |
| 978 | del sys.modules[module_name] |
| 979 | |
| 980 | def __enter__(self): |
| 981 | return self |
| 982 | |
| 983 | def __exit__(self, *ignore_exc): |
| 984 | sys.modules.update(self.original_modules) |
| 985 | |
| 986 | |
Raymond Hettinger | 57d1a88 | 2011-02-23 00:46:28 +0000 | [diff] [blame] | 987 | class EnvironmentVarGuard(collections.abc.MutableMapping): |
Thomas Wouters | 902d6eb | 2007-01-09 23:18:33 +0000 | [diff] [blame] | 988 | |
| 989 | """Class to help protect the environment variable properly. Can be used as |
| 990 | a context manager.""" |
| 991 | |
| 992 | def __init__(self): |
Walter Dörwald | 155374d | 2009-05-01 19:58:58 +0000 | [diff] [blame] | 993 | self._environ = os.environ |
Walter Dörwald | 4ba8013 | 2009-04-25 12:48:43 +0000 | [diff] [blame] | 994 | self._changed = {} |
Thomas Wouters | 902d6eb | 2007-01-09 23:18:33 +0000 | [diff] [blame] | 995 | |
Walter Dörwald | 155374d | 2009-05-01 19:58:58 +0000 | [diff] [blame] | 996 | def __getitem__(self, envvar): |
| 997 | return self._environ[envvar] |
| 998 | |
| 999 | def __setitem__(self, envvar, value): |
Walter Dörwald | 4ba8013 | 2009-04-25 12:48:43 +0000 | [diff] [blame] | 1000 | # Remember the initial value on the first access |
| 1001 | if envvar not in self._changed: |
Walter Dörwald | 155374d | 2009-05-01 19:58:58 +0000 | [diff] [blame] | 1002 | self._changed[envvar] = self._environ.get(envvar) |
| 1003 | self._environ[envvar] = value |
| 1004 | |
| 1005 | def __delitem__(self, envvar): |
| 1006 | # Remember the initial value on the first access |
| 1007 | if envvar not in self._changed: |
| 1008 | self._changed[envvar] = self._environ.get(envvar) |
| 1009 | if envvar in self._environ: |
| 1010 | del self._environ[envvar] |
| 1011 | |
| 1012 | def keys(self): |
| 1013 | return self._environ.keys() |
| 1014 | |
| 1015 | def __iter__(self): |
| 1016 | return iter(self._environ) |
| 1017 | |
| 1018 | def __len__(self): |
| 1019 | return len(self._environ) |
| 1020 | |
| 1021 | def set(self, envvar, value): |
| 1022 | self[envvar] = value |
Thomas Wouters | 902d6eb | 2007-01-09 23:18:33 +0000 | [diff] [blame] | 1023 | |
| 1024 | def unset(self, envvar): |
Walter Dörwald | 155374d | 2009-05-01 19:58:58 +0000 | [diff] [blame] | 1025 | del self[envvar] |
Thomas Wouters | 902d6eb | 2007-01-09 23:18:33 +0000 | [diff] [blame] | 1026 | |
| 1027 | def __enter__(self): |
| 1028 | return self |
| 1029 | |
| 1030 | def __exit__(self, *ignore_exc): |
Walter Dörwald | 4ba8013 | 2009-04-25 12:48:43 +0000 | [diff] [blame] | 1031 | for (k, v) in self._changed.items(): |
| 1032 | if v is None: |
Walter Dörwald | 155374d | 2009-05-01 19:58:58 +0000 | [diff] [blame] | 1033 | if k in self._environ: |
| 1034 | del self._environ[k] |
Walter Dörwald | 4ba8013 | 2009-04-25 12:48:43 +0000 | [diff] [blame] | 1035 | else: |
Walter Dörwald | 155374d | 2009-05-01 19:58:58 +0000 | [diff] [blame] | 1036 | self._environ[k] = v |
Nick Coghlan | 6ead552 | 2009-10-18 13:19:33 +0000 | [diff] [blame] | 1037 | os.environ = self._environ |
| 1038 | |
| 1039 | |
| 1040 | class DirsOnSysPath(object): |
| 1041 | """Context manager to temporarily add directories to sys.path. |
| 1042 | |
| 1043 | This makes a copy of sys.path, appends any directories given |
| 1044 | as positional arguments, then reverts sys.path to the copied |
| 1045 | settings when the context ends. |
| 1046 | |
| 1047 | Note that *all* sys.path modifications in the body of the |
| 1048 | context manager, including replacement of the object, |
| 1049 | will be reverted at the end of the block. |
| 1050 | """ |
| 1051 | |
| 1052 | def __init__(self, *paths): |
| 1053 | self.original_value = sys.path[:] |
| 1054 | self.original_object = sys.path |
| 1055 | sys.path.extend(paths) |
| 1056 | |
| 1057 | def __enter__(self): |
| 1058 | return self |
| 1059 | |
| 1060 | def __exit__(self, *ignore_exc): |
| 1061 | sys.path = self.original_object |
| 1062 | sys.path[:] = self.original_value |
Walter Dörwald | 155374d | 2009-05-01 19:58:58 +0000 | [diff] [blame] | 1063 | |
Thomas Wouters | 902d6eb | 2007-01-09 23:18:33 +0000 | [diff] [blame] | 1064 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1065 | class TransientResource(object): |
| 1066 | |
| 1067 | """Raise ResourceDenied if an exception is raised while the context manager |
| 1068 | is in effect that matches the specified exception and attributes.""" |
| 1069 | |
| 1070 | def __init__(self, exc, **kwargs): |
| 1071 | self.exc = exc |
| 1072 | self.attrs = kwargs |
| 1073 | |
| 1074 | def __enter__(self): |
| 1075 | return self |
| 1076 | |
| 1077 | def __exit__(self, type_=None, value=None, traceback=None): |
| 1078 | """If type_ is a subclass of self.exc and value has attributes matching |
| 1079 | self.attrs, raise ResourceDenied. Otherwise let the exception |
| 1080 | propagate (if any).""" |
| 1081 | if type_ is not None and issubclass(self.exc, type_): |
| 1082 | for attr, attr_value in self.attrs.items(): |
| 1083 | if not hasattr(value, attr): |
| 1084 | break |
| 1085 | if getattr(value, attr) != attr_value: |
| 1086 | break |
| 1087 | else: |
| 1088 | raise ResourceDenied("an optional resource is not available") |
| 1089 | |
Raymond Hettinger | 686057b | 2009-06-04 00:11:54 +0000 | [diff] [blame] | 1090 | # Context managers that raise ResourceDenied when various issues |
| 1091 | # with the Internet connection manifest themselves as exceptions. |
Antoine Pitrou | a88c83c | 2010-09-07 20:42:19 +0000 | [diff] [blame] | 1092 | # XXX deprecate these and use transient_internet() instead |
Raymond Hettinger | 686057b | 2009-06-04 00:11:54 +0000 | [diff] [blame] | 1093 | time_out = TransientResource(IOError, errno=errno.ETIMEDOUT) |
| 1094 | socket_peer_reset = TransientResource(socket.error, errno=errno.ECONNRESET) |
| 1095 | ioerror_peer_reset = TransientResource(IOError, errno=errno.ECONNRESET) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1096 | |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 1097 | |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 1098 | @contextlib.contextmanager |
Antoine Pitrou | a88c83c | 2010-09-07 20:42:19 +0000 | [diff] [blame] | 1099 | def transient_internet(resource_name, *, timeout=30.0, errnos=()): |
Antoine Pitrou | fec12ff | 2010-04-21 19:46:23 +0000 | [diff] [blame] | 1100 | """Return a context manager that raises ResourceDenied when various issues |
| 1101 | with the Internet connection manifest themselves as exceptions.""" |
Antoine Pitrou | 8bc0903 | 2010-09-07 21:09:09 +0000 | [diff] [blame] | 1102 | default_errnos = [ |
| 1103 | ('ECONNREFUSED', 111), |
| 1104 | ('ECONNRESET', 104), |
Antoine Pitrou | 5d938cb | 2011-01-08 10:28:11 +0000 | [diff] [blame] | 1105 | ('EHOSTUNREACH', 113), |
Antoine Pitrou | 8bc0903 | 2010-09-07 21:09:09 +0000 | [diff] [blame] | 1106 | ('ENETUNREACH', 101), |
| 1107 | ('ETIMEDOUT', 110), |
| 1108 | ] |
Antoine Pitrou | 2673c5b | 2010-09-07 21:43:31 +0000 | [diff] [blame] | 1109 | default_gai_errnos = [ |
Antoine Pitrou | 4875c46 | 2011-07-09 02:31:24 +0200 | [diff] [blame] | 1110 | ('EAI_AGAIN', -3), |
Charles-François Natali | 13859bf | 2011-12-10 13:16:44 +0100 | [diff] [blame] | 1111 | ('EAI_FAIL', -4), |
Antoine Pitrou | 2673c5b | 2010-09-07 21:43:31 +0000 | [diff] [blame] | 1112 | ('EAI_NONAME', -2), |
| 1113 | ('EAI_NODATA', -5), |
Antoine Pitrou | 390ea0f | 2011-04-29 00:44:33 +0200 | [diff] [blame] | 1114 | # Encountered when trying to resolve IPv6-only hostnames |
| 1115 | ('WSANO_DATA', 11004), |
Antoine Pitrou | 2673c5b | 2010-09-07 21:43:31 +0000 | [diff] [blame] | 1116 | ] |
Antoine Pitrou | 8bc0903 | 2010-09-07 21:09:09 +0000 | [diff] [blame] | 1117 | |
Éric Araujo | af5bacf | 2011-07-15 17:50:15 +0200 | [diff] [blame] | 1118 | denied = ResourceDenied("Resource %r is not available" % resource_name) |
Antoine Pitrou | 8bc0903 | 2010-09-07 21:09:09 +0000 | [diff] [blame] | 1119 | captured_errnos = errnos |
Antoine Pitrou | 2673c5b | 2010-09-07 21:43:31 +0000 | [diff] [blame] | 1120 | gai_errnos = [] |
Antoine Pitrou | 8bc0903 | 2010-09-07 21:09:09 +0000 | [diff] [blame] | 1121 | if not captured_errnos: |
| 1122 | captured_errnos = [getattr(errno, name, num) |
| 1123 | for (name, num) in default_errnos] |
Antoine Pitrou | 2673c5b | 2010-09-07 21:43:31 +0000 | [diff] [blame] | 1124 | gai_errnos = [getattr(socket, name, num) |
| 1125 | for (name, num) in default_gai_errnos] |
Antoine Pitrou | a88c83c | 2010-09-07 20:42:19 +0000 | [diff] [blame] | 1126 | |
| 1127 | def filter_error(err): |
Antoine Pitrou | 2673c5b | 2010-09-07 21:43:31 +0000 | [diff] [blame] | 1128 | n = getattr(err, 'errno', None) |
Antoine Pitrou | a88c83c | 2010-09-07 20:42:19 +0000 | [diff] [blame] | 1129 | if (isinstance(err, socket.timeout) or |
Antoine Pitrou | 2673c5b | 2010-09-07 21:43:31 +0000 | [diff] [blame] | 1130 | (isinstance(err, socket.gaierror) and n in gai_errnos) or |
| 1131 | n in captured_errnos): |
Antoine Pitrou | a88c83c | 2010-09-07 20:42:19 +0000 | [diff] [blame] | 1132 | if not verbose: |
| 1133 | sys.stderr.write(denied.args[0] + "\n") |
| 1134 | raise denied from err |
| 1135 | |
| 1136 | old_timeout = socket.getdefaulttimeout() |
| 1137 | try: |
| 1138 | if timeout is not None: |
| 1139 | socket.setdefaulttimeout(timeout) |
Antoine Pitrou | fec12ff | 2010-04-21 19:46:23 +0000 | [diff] [blame] | 1140 | yield |
Antoine Pitrou | a88c83c | 2010-09-07 20:42:19 +0000 | [diff] [blame] | 1141 | except IOError as err: |
Antoine Pitrou | 8bc0903 | 2010-09-07 21:09:09 +0000 | [diff] [blame] | 1142 | # urllib can wrap original socket errors multiple times (!), we must |
| 1143 | # unwrap to get at the original error. |
| 1144 | while True: |
| 1145 | a = err.args |
| 1146 | if len(a) >= 1 and isinstance(a[0], IOError): |
| 1147 | err = a[0] |
| 1148 | # The error can also be wrapped as args[1]: |
| 1149 | # except socket.error as msg: |
| 1150 | # raise IOError('socket error', msg).with_traceback(sys.exc_info()[2]) |
| 1151 | elif len(a) >= 2 and isinstance(a[1], IOError): |
| 1152 | err = a[1] |
| 1153 | else: |
| 1154 | break |
Antoine Pitrou | a88c83c | 2010-09-07 20:42:19 +0000 | [diff] [blame] | 1155 | filter_error(err) |
Antoine Pitrou | a88c83c | 2010-09-07 20:42:19 +0000 | [diff] [blame] | 1156 | raise |
| 1157 | # XXX should we catch generic exceptions and look for their |
| 1158 | # __cause__ or __context__? |
| 1159 | finally: |
| 1160 | socket.setdefaulttimeout(old_timeout) |
Antoine Pitrou | fec12ff | 2010-04-21 19:46:23 +0000 | [diff] [blame] | 1161 | |
| 1162 | |
| 1163 | @contextlib.contextmanager |
Benjamin Peterson | ad9d48d | 2008-04-02 21:49:44 +0000 | [diff] [blame] | 1164 | def captured_output(stream_name): |
Ezio Melotti | 07352b0 | 2011-05-14 14:51:18 +0300 | [diff] [blame] | 1165 | """Return a context manager used by captured_stdout/stdin/stderr |
Ezio Melotti | fc778fd | 2011-05-14 08:22:47 +0300 | [diff] [blame] | 1166 | that temporarily replaces the sys stream *stream_name* with a StringIO.""" |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 1167 | import io |
Benjamin Peterson | ad9d48d | 2008-04-02 21:49:44 +0000 | [diff] [blame] | 1168 | orig_stdout = getattr(sys, stream_name) |
| 1169 | setattr(sys, stream_name, io.StringIO()) |
Christian Heimes | 81ee3ef | 2008-05-04 22:42:01 +0000 | [diff] [blame] | 1170 | try: |
| 1171 | yield getattr(sys, stream_name) |
| 1172 | finally: |
| 1173 | setattr(sys, stream_name, orig_stdout) |
Benjamin Peterson | ad9d48d | 2008-04-02 21:49:44 +0000 | [diff] [blame] | 1174 | |
| 1175 | def captured_stdout(): |
Ezio Melotti | fc778fd | 2011-05-14 08:22:47 +0300 | [diff] [blame] | 1176 | """Capture the output of sys.stdout: |
| 1177 | |
| 1178 | with captured_stdout() as s: |
| 1179 | print("hello") |
| 1180 | self.assertEqual(s.getvalue(), "hello") |
| 1181 | """ |
Benjamin Peterson | ad9d48d | 2008-04-02 21:49:44 +0000 | [diff] [blame] | 1182 | return captured_output("stdout") |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 1183 | |
Nick Coghlan | 6b22f3f | 2010-12-12 15:24:21 +0000 | [diff] [blame] | 1184 | def captured_stderr(): |
| 1185 | return captured_output("stderr") |
| 1186 | |
Nick Coghlan | 6ead552 | 2009-10-18 13:19:33 +0000 | [diff] [blame] | 1187 | def captured_stdin(): |
| 1188 | return captured_output("stdin") |
| 1189 | |
Ezio Melotti | 07352b0 | 2011-05-14 14:51:18 +0300 | [diff] [blame] | 1190 | |
Benjamin Peterson | e549ead | 2009-03-28 21:42:05 +0000 | [diff] [blame] | 1191 | def gc_collect(): |
| 1192 | """Force as many objects as possible to be collected. |
| 1193 | |
| 1194 | In non-CPython implementations of Python, this is needed because timely |
| 1195 | deallocation is not guaranteed by the garbage collector. (Even in CPython |
| 1196 | this can be the case in case of reference cycles.) This means that __del__ |
| 1197 | methods may be called later than expected and weakrefs may remain alive for |
| 1198 | longer than expected. This function tries its best to force all garbage |
| 1199 | objects to disappear. |
| 1200 | """ |
Benjamin Peterson | e549ead | 2009-03-28 21:42:05 +0000 | [diff] [blame] | 1201 | gc.collect() |
Benjamin Peterson | a6590e8 | 2010-04-11 21:22:10 +0000 | [diff] [blame] | 1202 | if is_jython: |
| 1203 | time.sleep(0.1) |
Benjamin Peterson | e549ead | 2009-03-28 21:42:05 +0000 | [diff] [blame] | 1204 | gc.collect() |
| 1205 | gc.collect() |
| 1206 | |
Benjamin Peterson | 31f4beb | 2011-07-14 12:48:01 -0500 | [diff] [blame] | 1207 | @contextlib.contextmanager |
| 1208 | def disable_gc(): |
| 1209 | have_gc = gc.isenabled() |
| 1210 | gc.disable() |
| 1211 | try: |
| 1212 | yield |
| 1213 | finally: |
| 1214 | if have_gc: |
| 1215 | gc.enable() |
| 1216 | |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 1217 | |
Benjamin Peterson | 65c66ab | 2010-10-29 21:31:35 +0000 | [diff] [blame] | 1218 | def python_is_optimized(): |
| 1219 | """Find if Python was built with optimizations.""" |
Antoine Pitrou | 6447454 | 2010-10-31 11:34:47 +0000 | [diff] [blame] | 1220 | cflags = sysconfig.get_config_var('PY_CFLAGS') or '' |
Benjamin Peterson | 65c66ab | 2010-10-29 21:31:35 +0000 | [diff] [blame] | 1221 | final_opt = "" |
| 1222 | for opt in cflags.split(): |
| 1223 | if opt.startswith('-O'): |
| 1224 | final_opt = opt |
Eli Bendersky | 6c51999 | 2011-07-23 08:48:53 +0300 | [diff] [blame] | 1225 | return final_opt != '' and final_opt != '-O0' |
Benjamin Peterson | 65c66ab | 2010-10-29 21:31:35 +0000 | [diff] [blame] | 1226 | |
| 1227 | |
Martin v. Löwis | 2b16844 | 2012-07-29 16:38:45 +0200 | [diff] [blame] | 1228 | _header = 'nP' |
| 1229 | _align = '0n' |
Martin v. Löwis | 33f7997 | 2012-07-29 16:33:05 +0200 | [diff] [blame] | 1230 | if hasattr(sys, "gettotalrefcount"): |
| 1231 | _header = '2P' + _header |
Martin v. Löwis | 2b16844 | 2012-07-29 16:38:45 +0200 | [diff] [blame] | 1232 | _align = '0P' |
| 1233 | _vheader = _header + 'n' |
Martin v. Löwis | 33f7997 | 2012-07-29 16:33:05 +0200 | [diff] [blame] | 1234 | |
| 1235 | def calcobjsize(fmt): |
Martin v. Löwis | 2b16844 | 2012-07-29 16:38:45 +0200 | [diff] [blame] | 1236 | return struct.calcsize(_header + fmt + _align) |
Martin v. Löwis | 33f7997 | 2012-07-29 16:33:05 +0200 | [diff] [blame] | 1237 | |
| 1238 | def calcvobjsize(fmt): |
Martin v. Löwis | 2b16844 | 2012-07-29 16:38:45 +0200 | [diff] [blame] | 1239 | return struct.calcsize(_vheader + fmt + _align) |
Martin v. Löwis | 33f7997 | 2012-07-29 16:33:05 +0200 | [diff] [blame] | 1240 | |
| 1241 | |
| 1242 | _TPFLAGS_HAVE_GC = 1<<14 |
| 1243 | _TPFLAGS_HEAPTYPE = 1<<9 |
| 1244 | |
| 1245 | def check_sizeof(test, o, size): |
| 1246 | result = sys.getsizeof(o) |
| 1247 | # add GC header size |
| 1248 | if ((type(o) == type) and (o.__flags__ & _TPFLAGS_HEAPTYPE) or\ |
| 1249 | ((type(o) != type) and (type(o).__flags__ & _TPFLAGS_HAVE_GC))): |
| 1250 | size += _testcapi.SIZEOF_PYGC_HEAD |
| 1251 | msg = 'wrong size for %s: got %d, expected %d' \ |
| 1252 | % (type(o), result, size) |
| 1253 | test.assertEqual(result, size, msg) |
| 1254 | |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 1255 | #======================================================================= |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 1256 | # Decorator for running a function in a different locale, correctly resetting |
| 1257 | # it afterwards. |
| 1258 | |
| 1259 | def run_with_locale(catstr, *locales): |
| 1260 | def decorator(func): |
| 1261 | def inner(*args, **kwds): |
| 1262 | try: |
| 1263 | import locale |
| 1264 | category = getattr(locale, catstr) |
| 1265 | orig_locale = locale.setlocale(category) |
| 1266 | except AttributeError: |
| 1267 | # if the test author gives us an invalid category string |
| 1268 | raise |
| 1269 | except: |
| 1270 | # cannot retrieve original locale, so do nothing |
| 1271 | locale = orig_locale = None |
| 1272 | else: |
| 1273 | for loc in locales: |
| 1274 | try: |
| 1275 | locale.setlocale(category, loc) |
| 1276 | break |
| 1277 | except: |
| 1278 | pass |
| 1279 | |
| 1280 | # now run the function, resetting the locale on exceptions |
| 1281 | try: |
| 1282 | return func(*args, **kwds) |
| 1283 | finally: |
| 1284 | if locale and orig_locale: |
| 1285 | locale.setlocale(category, orig_locale) |
Neal Norwitz | 221085d | 2007-02-25 20:55:47 +0000 | [diff] [blame] | 1286 | inner.__name__ = func.__name__ |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 1287 | inner.__doc__ = func.__doc__ |
| 1288 | return inner |
| 1289 | return decorator |
| 1290 | |
| 1291 | #======================================================================= |
Alexander Belopolsky | 2420d83 | 2012-04-29 15:56:49 -0400 | [diff] [blame] | 1292 | # Decorator for running a function in a specific timezone, correctly |
| 1293 | # resetting it afterwards. |
| 1294 | |
| 1295 | def run_with_tz(tz): |
| 1296 | def decorator(func): |
| 1297 | def inner(*args, **kwds): |
Alexander Belopolsky | b8f02b5 | 2012-04-29 18:16:46 -0400 | [diff] [blame] | 1298 | try: |
| 1299 | tzset = time.tzset |
| 1300 | except AttributeError: |
| 1301 | raise unittest.SkipTest("tzset required") |
Alexander Belopolsky | 2420d83 | 2012-04-29 15:56:49 -0400 | [diff] [blame] | 1302 | if 'TZ' in os.environ: |
| 1303 | orig_tz = os.environ['TZ'] |
| 1304 | else: |
| 1305 | orig_tz = None |
| 1306 | os.environ['TZ'] = tz |
Alexander Belopolsky | b8f02b5 | 2012-04-29 18:16:46 -0400 | [diff] [blame] | 1307 | tzset() |
Alexander Belopolsky | 2420d83 | 2012-04-29 15:56:49 -0400 | [diff] [blame] | 1308 | |
| 1309 | # now run the function, resetting the tz on exceptions |
| 1310 | try: |
| 1311 | return func(*args, **kwds) |
| 1312 | finally: |
Benjamin Peterson | b29614e | 2012-10-09 11:16:03 -0400 | [diff] [blame] | 1313 | if orig_tz is None: |
Alexander Belopolsky | 2420d83 | 2012-04-29 15:56:49 -0400 | [diff] [blame] | 1314 | del os.environ['TZ'] |
| 1315 | else: |
| 1316 | os.environ['TZ'] = orig_tz |
| 1317 | time.tzset() |
| 1318 | |
| 1319 | inner.__name__ = func.__name__ |
| 1320 | inner.__doc__ = func.__doc__ |
| 1321 | return inner |
| 1322 | return decorator |
| 1323 | |
| 1324 | #======================================================================= |
Georg Brandl | db02844 | 2008-02-05 20:48:58 +0000 | [diff] [blame] | 1325 | # Big-memory-test support. Separate from 'resources' because memory use |
| 1326 | # should be configurable. |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 1327 | |
| 1328 | # Some handy shorthands. Note that these are used for byte-limits as well |
| 1329 | # as size-limits, in the various bigmem tests |
| 1330 | _1M = 1024*1024 |
| 1331 | _1G = 1024 * _1M |
| 1332 | _2G = 2 * _1G |
Neal Norwitz | 3ce5d92 | 2008-08-24 07:08:55 +0000 | [diff] [blame] | 1333 | _4G = 4 * _1G |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 1334 | |
Thomas Wouters | d2cf20e | 2007-08-30 22:57:53 +0000 | [diff] [blame] | 1335 | MAX_Py_ssize_t = sys.maxsize |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1336 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 1337 | def set_memlimit(limit): |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 1338 | global max_memuse |
Neal Norwitz | 3ce5d92 | 2008-08-24 07:08:55 +0000 | [diff] [blame] | 1339 | global real_max_memuse |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 1340 | sizes = { |
| 1341 | 'k': 1024, |
| 1342 | 'm': _1M, |
| 1343 | 'g': _1G, |
| 1344 | 't': 1024*_1G, |
| 1345 | } |
| 1346 | m = re.match(r'(\d+(\.\d+)?) (K|M|G|T)b?$', limit, |
| 1347 | re.IGNORECASE | re.VERBOSE) |
| 1348 | if m is None: |
| 1349 | raise ValueError('Invalid memory limit %r' % (limit,)) |
| 1350 | memlimit = int(float(m.group(1)) * sizes[m.group(3).lower()]) |
Neal Norwitz | 3ce5d92 | 2008-08-24 07:08:55 +0000 | [diff] [blame] | 1351 | real_max_memuse = memlimit |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1352 | if memlimit > MAX_Py_ssize_t: |
| 1353 | memlimit = MAX_Py_ssize_t |
| 1354 | if memlimit < _2G - 1: |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 1355 | raise ValueError('Memory limit %r too low to be useful' % (limit,)) |
| 1356 | max_memuse = memlimit |
| 1357 | |
Antoine Pitrou | 75e78b6 | 2011-10-04 11:51:23 +0200 | [diff] [blame] | 1358 | class _MemoryWatchdog: |
| 1359 | """An object which periodically watches the process' memory consumption |
Antoine Pitrou | 94190bb | 2011-10-04 10:22:36 +0200 | [diff] [blame] | 1360 | and prints it out. |
| 1361 | """ |
Antoine Pitrou | 75e78b6 | 2011-10-04 11:51:23 +0200 | [diff] [blame] | 1362 | |
| 1363 | def __init__(self): |
| 1364 | self.procfile = '/proc/{pid}/statm'.format(pid=os.getpid()) |
| 1365 | self.started = False |
Antoine Pitrou | 75e78b6 | 2011-10-04 11:51:23 +0200 | [diff] [blame] | 1366 | |
| 1367 | def start(self): |
Antoine Pitrou | 75e78b6 | 2011-10-04 11:51:23 +0200 | [diff] [blame] | 1368 | try: |
Charles-François Natali | 55bce63 | 2012-03-24 10:06:23 +0100 | [diff] [blame] | 1369 | f = open(self.procfile, 'r') |
Antoine Pitrou | 75e78b6 | 2011-10-04 11:51:23 +0200 | [diff] [blame] | 1370 | except OSError as e: |
| 1371 | warnings.warn('/proc not available for stats: {}'.format(e), |
| 1372 | RuntimeWarning) |
| 1373 | sys.stderr.flush() |
| 1374 | return |
Charles-François Natali | 55bce63 | 2012-03-24 10:06:23 +0100 | [diff] [blame] | 1375 | |
| 1376 | watchdog_script = findfile("memory_watchdog.py") |
| 1377 | self.mem_watchdog = subprocess.Popen([sys.executable, watchdog_script], |
| 1378 | stdin=f, stderr=subprocess.DEVNULL) |
| 1379 | f.close() |
Antoine Pitrou | 75e78b6 | 2011-10-04 11:51:23 +0200 | [diff] [blame] | 1380 | self.started = True |
Antoine Pitrou | 75e78b6 | 2011-10-04 11:51:23 +0200 | [diff] [blame] | 1381 | |
| 1382 | def stop(self): |
Charles-François Natali | 55bce63 | 2012-03-24 10:06:23 +0100 | [diff] [blame] | 1383 | if self.started: |
| 1384 | self.mem_watchdog.terminate() |
| 1385 | self.mem_watchdog.wait() |
Antoine Pitrou | 75e78b6 | 2011-10-04 11:51:23 +0200 | [diff] [blame] | 1386 | |
Antoine Pitrou | 94190bb | 2011-10-04 10:22:36 +0200 | [diff] [blame] | 1387 | |
| 1388 | def bigmemtest(size, memuse, dry_run=True): |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 1389 | """Decorator for bigmem tests. |
| 1390 | |
| 1391 | 'minsize' is the minimum useful size for the test (in arbitrary, |
| 1392 | test-interpreted units.) 'memuse' is the number of 'bytes per size' for |
Antoine Pitrou | aca5fa7 | 2011-01-12 21:19:59 +0000 | [diff] [blame] | 1393 | the test, or a good estimate of it. |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 1394 | |
Antoine Pitrou | 94190bb | 2011-10-04 10:22:36 +0200 | [diff] [blame] | 1395 | if 'dry_run' is False, it means the test doesn't support dummy runs |
| 1396 | when -M is not specified. |
Thomas Wouters | 518b5ae | 2011-03-25 11:42:37 +0100 | [diff] [blame] | 1397 | """ |
Neal Norwitz | 3ce5d92 | 2008-08-24 07:08:55 +0000 | [diff] [blame] | 1398 | def decorator(f): |
| 1399 | def wrapper(self): |
Antoine Pitrou | 7cdb495 | 2009-03-07 23:40:49 +0000 | [diff] [blame] | 1400 | size = wrapper.size |
| 1401 | memuse = wrapper.memuse |
Neal Norwitz | 3ce5d92 | 2008-08-24 07:08:55 +0000 | [diff] [blame] | 1402 | if not real_max_memuse: |
| 1403 | maxsize = 5147 |
| 1404 | else: |
| 1405 | maxsize = size |
| 1406 | |
Antoine Pitrou | 82be19f | 2011-08-29 23:09:33 +0200 | [diff] [blame] | 1407 | if ((real_max_memuse or not dry_run) |
| 1408 | and real_max_memuse < maxsize * memuse): |
| 1409 | raise unittest.SkipTest( |
| 1410 | "not enough memory: %.1fG minimum needed" |
| 1411 | % (size * memuse / (1024 ** 3))) |
Neal Norwitz | 3ce5d92 | 2008-08-24 07:08:55 +0000 | [diff] [blame] | 1412 | |
Charles-François Natali | 55bce63 | 2012-03-24 10:06:23 +0100 | [diff] [blame] | 1413 | if real_max_memuse and verbose: |
Antoine Pitrou | 94190bb | 2011-10-04 10:22:36 +0200 | [diff] [blame] | 1414 | print() |
| 1415 | print(" ... expected peak memory use: {peak:.1f}G" |
| 1416 | .format(peak=size * memuse / (1024 ** 3))) |
Antoine Pitrou | 75e78b6 | 2011-10-04 11:51:23 +0200 | [diff] [blame] | 1417 | watchdog = _MemoryWatchdog() |
| 1418 | watchdog.start() |
Antoine Pitrou | 94190bb | 2011-10-04 10:22:36 +0200 | [diff] [blame] | 1419 | else: |
Antoine Pitrou | 75e78b6 | 2011-10-04 11:51:23 +0200 | [diff] [blame] | 1420 | watchdog = None |
Antoine Pitrou | 94190bb | 2011-10-04 10:22:36 +0200 | [diff] [blame] | 1421 | |
| 1422 | try: |
| 1423 | return f(self, maxsize) |
| 1424 | finally: |
Antoine Pitrou | 75e78b6 | 2011-10-04 11:51:23 +0200 | [diff] [blame] | 1425 | if watchdog: |
| 1426 | watchdog.stop() |
Antoine Pitrou | 94190bb | 2011-10-04 10:22:36 +0200 | [diff] [blame] | 1427 | |
Neal Norwitz | 3ce5d92 | 2008-08-24 07:08:55 +0000 | [diff] [blame] | 1428 | wrapper.size = size |
| 1429 | wrapper.memuse = memuse |
Neal Norwitz | 3ce5d92 | 2008-08-24 07:08:55 +0000 | [diff] [blame] | 1430 | return wrapper |
| 1431 | return decorator |
| 1432 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1433 | def bigaddrspacetest(f): |
| 1434 | """Decorator for tests that fill the address space.""" |
| 1435 | def wrapper(self): |
| 1436 | if max_memuse < MAX_Py_ssize_t: |
Antoine Pitrou | 98c62bd | 2011-01-12 21:58:39 +0000 | [diff] [blame] | 1437 | if MAX_Py_ssize_t >= 2**63 - 1 and max_memuse >= 2**31: |
Antoine Pitrou | e0d3f8a | 2011-01-12 21:50:44 +0000 | [diff] [blame] | 1438 | raise unittest.SkipTest( |
| 1439 | "not enough memory: try a 32-bit build instead") |
| 1440 | else: |
| 1441 | raise unittest.SkipTest( |
| 1442 | "not enough memory: %.1fG minimum needed" |
| 1443 | % (MAX_Py_ssize_t / (1024 ** 3))) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1444 | else: |
| 1445 | return f(self) |
| 1446 | return wrapper |
| 1447 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 1448 | #======================================================================= |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1449 | # unittest integration. |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 1450 | |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 1451 | class BasicTestRunner: |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 1452 | def run(self, test): |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 1453 | result = unittest.TestResult() |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 1454 | test(result) |
| 1455 | return result |
| 1456 | |
Benjamin Peterson | e549ead | 2009-03-28 21:42:05 +0000 | [diff] [blame] | 1457 | def _id(obj): |
| 1458 | return obj |
| 1459 | |
| 1460 | def requires_resource(resource): |
Antoine Pitrou | d20a5f6 | 2011-02-26 15:58:05 +0000 | [diff] [blame] | 1461 | if resource == 'gui' and not _is_gui_available(): |
| 1462 | return unittest.skip("resource 'gui' is not available") |
Antoine Pitrou | 5bc4fa7 | 2010-10-14 15:34:31 +0000 | [diff] [blame] | 1463 | if is_resource_enabled(resource): |
Benjamin Peterson | e549ead | 2009-03-28 21:42:05 +0000 | [diff] [blame] | 1464 | return _id |
| 1465 | else: |
| 1466 | return unittest.skip("resource {0!r} is not enabled".format(resource)) |
| 1467 | |
| 1468 | def cpython_only(test): |
| 1469 | """ |
| 1470 | Decorator for tests only applicable on CPython. |
| 1471 | """ |
| 1472 | return impl_detail(cpython=True)(test) |
| 1473 | |
| 1474 | def impl_detail(msg=None, **guards): |
| 1475 | if check_impl_detail(**guards): |
| 1476 | return _id |
| 1477 | if msg is None: |
| 1478 | guardnames, default = _parse_guards(guards) |
| 1479 | if default: |
| 1480 | msg = "implementation detail not available on {0}" |
| 1481 | else: |
| 1482 | msg = "implementation detail specific to {0}" |
| 1483 | guardnames = sorted(guardnames.keys()) |
| 1484 | msg = msg.format(' or '.join(guardnames)) |
| 1485 | return unittest.skip(msg) |
| 1486 | |
| 1487 | def _parse_guards(guards): |
| 1488 | # Returns a tuple ({platform_name: run_me}, default_value) |
| 1489 | if not guards: |
| 1490 | return ({'cpython': True}, False) |
Eric Smith | 886b40a | 2009-04-26 21:26:45 +0000 | [diff] [blame] | 1491 | is_true = list(guards.values())[0] |
| 1492 | assert list(guards.values()) == [is_true] * len(guards) # all True or all False |
Benjamin Peterson | e549ead | 2009-03-28 21:42:05 +0000 | [diff] [blame] | 1493 | return (guards, not is_true) |
| 1494 | |
| 1495 | # Use the following check to guard CPython's implementation-specific tests -- |
| 1496 | # or to run them only on the implementation(s) guarded by the arguments. |
| 1497 | def check_impl_detail(**guards): |
| 1498 | """This function returns True or False depending on the host platform. |
| 1499 | Examples: |
| 1500 | if check_impl_detail(): # only on CPython (default) |
| 1501 | if check_impl_detail(jython=True): # only on Jython |
| 1502 | if check_impl_detail(cpython=False): # everywhere except on CPython |
| 1503 | """ |
| 1504 | guards, default = _parse_guards(guards) |
| 1505 | return guards.get(platform.python_implementation().lower(), default) |
| 1506 | |
| 1507 | |
Brett Cannon | 31f5929 | 2011-02-21 19:29:56 +0000 | [diff] [blame] | 1508 | def no_tracing(func): |
| 1509 | """Decorator to temporarily turn off tracing for the duration of a test.""" |
| 1510 | if not hasattr(sys, 'gettrace'): |
| 1511 | return func |
| 1512 | else: |
| 1513 | @functools.wraps(func) |
| 1514 | def wrapper(*args, **kwargs): |
| 1515 | original_trace = sys.gettrace() |
| 1516 | try: |
| 1517 | sys.settrace(None) |
| 1518 | return func(*args, **kwargs) |
| 1519 | finally: |
| 1520 | sys.settrace(original_trace) |
| 1521 | return wrapper |
| 1522 | |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 1523 | |
Brett Cannon | 7a54073 | 2011-02-22 03:04:06 +0000 | [diff] [blame] | 1524 | def refcount_test(test): |
| 1525 | """Decorator for tests which involve reference counting. |
| 1526 | |
| 1527 | To start, the decorator does not run the test if is not run by CPython. |
| 1528 | After that, any trace function is unset during the test to prevent |
| 1529 | unexpected refcounts caused by the trace function. |
| 1530 | |
| 1531 | """ |
| 1532 | return no_tracing(cpython_only(test)) |
| 1533 | |
| 1534 | |
Antoine Pitrou | b9c73e8 | 2011-07-29 23:53:38 +0200 | [diff] [blame] | 1535 | def _filter_suite(suite, pred): |
| 1536 | """Recursively filter test cases in a suite based on a predicate.""" |
| 1537 | newtests = [] |
| 1538 | for test in suite._tests: |
| 1539 | if isinstance(test, unittest.TestSuite): |
| 1540 | _filter_suite(test, pred) |
| 1541 | newtests.append(test) |
| 1542 | else: |
| 1543 | if pred(test): |
| 1544 | newtests.append(test) |
| 1545 | suite._tests = newtests |
| 1546 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1547 | def _run_suite(suite): |
Barry Warsaw | c88425e | 2001-09-20 06:31:22 +0000 | [diff] [blame] | 1548 | """Run tests from a unittest.TestSuite-derived class.""" |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 1549 | if verbose: |
Antoine Pitrou | 216a3bc | 2011-07-23 22:33:39 +0200 | [diff] [blame] | 1550 | runner = unittest.TextTestRunner(sys.stdout, verbosity=2, |
| 1551 | failfast=failfast) |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 1552 | else: |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 1553 | runner = BasicTestRunner() |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 1554 | |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 1555 | result = runner.run(suite) |
| 1556 | if not result.wasSuccessful(): |
Fred Drake | 14f6c18 | 2001-07-16 18:51:32 +0000 | [diff] [blame] | 1557 | if len(result.errors) == 1 and not result.failures: |
| 1558 | err = result.errors[0][1] |
| 1559 | elif len(result.failures) == 1 and not result.errors: |
| 1560 | err = result.failures[0][1] |
| 1561 | else: |
R. David Murray | 723357e | 2009-10-19 18:06:17 +0000 | [diff] [blame] | 1562 | err = "multiple errors occurred" |
| 1563 | if not verbose: err += "; run in verbose mode for details" |
Tim Peters | 2d84f2c | 2001-09-08 03:37:56 +0000 | [diff] [blame] | 1564 | raise TestFailed(err) |
Tim Peters | a0a6222 | 2001-09-09 06:12:01 +0000 | [diff] [blame] | 1565 | |
Barry Warsaw | c10d690 | 2001-09-20 06:30:41 +0000 | [diff] [blame] | 1566 | |
Walter Dörwald | 21d3a32 | 2003-05-01 17:45:56 +0000 | [diff] [blame] | 1567 | def run_unittest(*classes): |
| 1568 | """Run tests from unittest.TestCase-derived classes.""" |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1569 | valid_types = (unittest.TestSuite, unittest.TestCase) |
Raymond Hettinger | 9dcbbea | 2003-04-27 07:54:23 +0000 | [diff] [blame] | 1570 | suite = unittest.TestSuite() |
Walter Dörwald | 21d3a32 | 2003-05-01 17:45:56 +0000 | [diff] [blame] | 1571 | for cls in classes: |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 1572 | if isinstance(cls, str): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1573 | if cls in sys.modules: |
| 1574 | suite.addTest(unittest.findTestCases(sys.modules[cls])) |
| 1575 | else: |
| 1576 | raise ValueError("str arguments must be keys in sys.modules") |
| 1577 | elif isinstance(cls, valid_types): |
Raymond Hettinger | 21d9987 | 2003-07-16 02:59:32 +0000 | [diff] [blame] | 1578 | suite.addTest(cls) |
| 1579 | else: |
| 1580 | suite.addTest(unittest.makeSuite(cls)) |
Antoine Pitrou | b9c73e8 | 2011-07-29 23:53:38 +0200 | [diff] [blame] | 1581 | def case_pred(test): |
| 1582 | if match_tests is None: |
| 1583 | return True |
| 1584 | for name in test.id().split("."): |
| 1585 | if fnmatch.fnmatchcase(name, match_tests): |
| 1586 | return True |
| 1587 | return False |
| 1588 | _filter_suite(suite, case_pred) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1589 | _run_suite(suite) |
Raymond Hettinger | 9dcbbea | 2003-04-27 07:54:23 +0000 | [diff] [blame] | 1590 | |
Serhiy Storchaka | 9d0add0 | 2013-01-27 19:47:45 +0200 | [diff] [blame] | 1591 | #======================================================================= |
| 1592 | # Check for the presence of docstrings. |
| 1593 | |
| 1594 | HAVE_DOCSTRINGS = (check_impl_detail(cpython=False) or |
| 1595 | sys.platform == 'win32' or |
| 1596 | sysconfig.get_config_var('WITH_DOC_STRINGS')) |
| 1597 | |
| 1598 | requires_docstrings = unittest.skipUnless(HAVE_DOCSTRINGS, |
| 1599 | "test requires docstrings") |
| 1600 | |
Barry Warsaw | c10d690 | 2001-09-20 06:30:41 +0000 | [diff] [blame] | 1601 | |
Tim Peters | a0a6222 | 2001-09-09 06:12:01 +0000 | [diff] [blame] | 1602 | #======================================================================= |
| 1603 | # doctest driver. |
| 1604 | |
Stefan Krah | 1919b7e | 2012-03-21 18:25:23 +0100 | [diff] [blame] | 1605 | def run_doctest(module, verbosity=None, optionflags=0): |
Tim Peters | 17111f3 | 2001-10-03 04:08:26 +0000 | [diff] [blame] | 1606 | """Run doctest on the given module. Return (#failures, #tests). |
Tim Peters | a0a6222 | 2001-09-09 06:12:01 +0000 | [diff] [blame] | 1607 | |
| 1608 | If optional argument verbosity is not specified (or is None), pass |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 1609 | support's belief about verbosity on to doctest. Else doctest's |
Tim Peters | bea3fb8 | 2001-09-10 01:39:21 +0000 | [diff] [blame] | 1610 | usual behavior is used (it searches sys.argv for -v). |
Tim Peters | a0a6222 | 2001-09-09 06:12:01 +0000 | [diff] [blame] | 1611 | """ |
| 1612 | |
| 1613 | import doctest |
| 1614 | |
| 1615 | if verbosity is None: |
| 1616 | verbosity = verbose |
| 1617 | else: |
| 1618 | verbosity = None |
| 1619 | |
Stefan Krah | 1919b7e | 2012-03-21 18:25:23 +0100 | [diff] [blame] | 1620 | f, t = doctest.testmod(module, verbose=verbosity, optionflags=optionflags) |
Victor Stinner | bddc4d4 | 2011-06-29 15:52:46 +0200 | [diff] [blame] | 1621 | if f: |
| 1622 | raise TestFailed("%d of %d doctests failed" % (f, t)) |
Raymond Hettinger | 35b34bd | 2003-05-17 00:58:33 +0000 | [diff] [blame] | 1623 | if verbose: |
Georg Brandl | db02844 | 2008-02-05 20:48:58 +0000 | [diff] [blame] | 1624 | print('doctest (%s) ... %d tests with zero failures' % |
| 1625 | (module.__name__, t)) |
Raymond Hettinger | 35b34bd | 2003-05-17 00:58:33 +0000 | [diff] [blame] | 1626 | return f, t |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1627 | |
Antoine Pitrou | 060cee2 | 2009-11-13 16:29:04 +0000 | [diff] [blame] | 1628 | |
| 1629 | #======================================================================= |
| 1630 | # Support for saving and restoring the imported modules. |
| 1631 | |
| 1632 | def modules_setup(): |
| 1633 | return sys.modules.copy(), |
| 1634 | |
| 1635 | def modules_cleanup(oldmodules): |
| 1636 | # Encoders/decoders are registered permanently within the internal |
| 1637 | # codec cache. If we destroy the corresponding modules their |
| 1638 | # globals will be set to None which will trip up the cached functions. |
| 1639 | encodings = [(k, v) for k, v in sys.modules.items() |
| 1640 | if k.startswith('encodings.')] |
| 1641 | sys.modules.clear() |
| 1642 | sys.modules.update(encodings) |
Nick Coghlan | 90be5fb | 2011-01-11 10:05:20 +0000 | [diff] [blame] | 1643 | # XXX: This kind of problem can affect more than just encodings. In particular |
Eric Smith | a3e8f3d | 2011-01-11 10:24:34 +0000 | [diff] [blame] | 1644 | # extension modules (such as _ssl) don't cope with reloading properly. |
Nick Coghlan | 90be5fb | 2011-01-11 10:05:20 +0000 | [diff] [blame] | 1645 | # Really, test modules should be cleaning out the test specific modules they |
| 1646 | # know they added (ala test_runpy) rather than relying on this function (as |
| 1647 | # test_importhooks and test_pkg do currently). |
| 1648 | # Implicitly imported *real* modules should be left alone (see issue 10556). |
Antoine Pitrou | 060cee2 | 2009-11-13 16:29:04 +0000 | [diff] [blame] | 1649 | sys.modules.update(oldmodules) |
| 1650 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1651 | #======================================================================= |
| 1652 | # Threading support to prevent reporting refleaks when running regrtest.py -R |
| 1653 | |
Antoine Pitrou | 65c9c64 | 2009-10-30 17:25:12 +0000 | [diff] [blame] | 1654 | # NOTE: we use thread._count() rather than threading.enumerate() (or the |
| 1655 | # moral equivalent thereof) because a threading.Thread object is still alive |
| 1656 | # until its __bootstrap() method has returned, even after it has been |
| 1657 | # unregistered from the threading module. |
| 1658 | # thread._count(), on the other hand, only gets decremented *after* the |
| 1659 | # __bootstrap() method has returned, which gives us reliable reference counts |
| 1660 | # at the end of a test run. |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1661 | |
Antoine Pitrou | 65c9c64 | 2009-10-30 17:25:12 +0000 | [diff] [blame] | 1662 | def threading_setup(): |
Victor Stinner | 45df820 | 2010-04-28 22:31:17 +0000 | [diff] [blame] | 1663 | if _thread: |
Antoine Pitrou | 707f228 | 2011-07-15 22:29:44 +0200 | [diff] [blame] | 1664 | return _thread._count(), threading._dangling.copy() |
Victor Stinner | 45df820 | 2010-04-28 22:31:17 +0000 | [diff] [blame] | 1665 | else: |
Antoine Pitrou | 707f228 | 2011-07-15 22:29:44 +0200 | [diff] [blame] | 1666 | return 1, () |
Antoine Pitrou | 65c9c64 | 2009-10-30 17:25:12 +0000 | [diff] [blame] | 1667 | |
Antoine Pitrou | 707f228 | 2011-07-15 22:29:44 +0200 | [diff] [blame] | 1668 | def threading_cleanup(*original_values): |
Victor Stinner | 45df820 | 2010-04-28 22:31:17 +0000 | [diff] [blame] | 1669 | if not _thread: |
| 1670 | return |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1671 | _MAX_COUNT = 10 |
Antoine Pitrou | 65c9c64 | 2009-10-30 17:25:12 +0000 | [diff] [blame] | 1672 | for count in range(_MAX_COUNT): |
Antoine Pitrou | 707f228 | 2011-07-15 22:29:44 +0200 | [diff] [blame] | 1673 | values = _thread._count(), threading._dangling |
| 1674 | if values == original_values: |
Antoine Pitrou | 65c9c64 | 2009-10-30 17:25:12 +0000 | [diff] [blame] | 1675 | break |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1676 | time.sleep(0.1) |
Antoine Pitrou | 707f228 | 2011-07-15 22:29:44 +0200 | [diff] [blame] | 1677 | gc_collect() |
Antoine Pitrou | 65c9c64 | 2009-10-30 17:25:12 +0000 | [diff] [blame] | 1678 | # XXX print a warning in case of failure? |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1679 | |
Benjamin Peterson | fa0d703 | 2009-06-01 22:42:33 +0000 | [diff] [blame] | 1680 | def reap_threads(func): |
Victor Stinner | 45df820 | 2010-04-28 22:31:17 +0000 | [diff] [blame] | 1681 | """Use this function when threads are being used. This will |
| 1682 | ensure that the threads are cleaned up even when the test fails. |
| 1683 | If threading is unavailable this function does nothing. |
| 1684 | """ |
| 1685 | if not _thread: |
| 1686 | return func |
| 1687 | |
Benjamin Peterson | fa0d703 | 2009-06-01 22:42:33 +0000 | [diff] [blame] | 1688 | @functools.wraps(func) |
| 1689 | def decorator(*args): |
| 1690 | key = threading_setup() |
| 1691 | try: |
| 1692 | return func(*args) |
| 1693 | finally: |
| 1694 | threading_cleanup(*key) |
| 1695 | return decorator |
| 1696 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1697 | def reap_children(): |
| 1698 | """Use this function at the end of test_main() whenever sub-processes |
| 1699 | are started. This will help ensure that no extra children (zombies) |
| 1700 | stick around to hog resources and create problems when looking |
| 1701 | for refleaks. |
| 1702 | """ |
| 1703 | |
| 1704 | # Reap all our dead child processes so we don't leave zombies around. |
| 1705 | # These hog resources and might be causing some of the buildbots to die. |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1706 | if hasattr(os, 'waitpid'): |
| 1707 | any_process = -1 |
| 1708 | while True: |
| 1709 | try: |
| 1710 | # This will raise an exception on Windows. That's ok. |
| 1711 | pid, status = os.waitpid(any_process, os.WNOHANG) |
| 1712 | if pid == 0: |
| 1713 | break |
| 1714 | except: |
| 1715 | break |
Collin Winter | f2bf2b3 | 2010-03-17 00:41:56 +0000 | [diff] [blame] | 1716 | |
| 1717 | @contextlib.contextmanager |
| 1718 | def swap_attr(obj, attr, new_val): |
| 1719 | """Temporary swap out an attribute with a new object. |
| 1720 | |
| 1721 | Usage: |
| 1722 | with swap_attr(obj, "attr", 5): |
| 1723 | ... |
| 1724 | |
| 1725 | This will set obj.attr to 5 for the duration of the with: block, |
| 1726 | restoring the old value at the end of the block. If `attr` doesn't |
| 1727 | exist on `obj`, it will be created and then deleted at the end of the |
| 1728 | block. |
| 1729 | """ |
| 1730 | if hasattr(obj, attr): |
| 1731 | real_val = getattr(obj, attr) |
| 1732 | setattr(obj, attr, new_val) |
| 1733 | try: |
| 1734 | yield |
| 1735 | finally: |
| 1736 | setattr(obj, attr, real_val) |
| 1737 | else: |
| 1738 | setattr(obj, attr, new_val) |
| 1739 | try: |
| 1740 | yield |
| 1741 | finally: |
| 1742 | delattr(obj, attr) |
| 1743 | |
| 1744 | @contextlib.contextmanager |
| 1745 | def swap_item(obj, item, new_val): |
| 1746 | """Temporary swap out an item with a new object. |
| 1747 | |
| 1748 | Usage: |
| 1749 | with swap_item(obj, "item", 5): |
| 1750 | ... |
| 1751 | |
| 1752 | This will set obj["item"] to 5 for the duration of the with: block, |
| 1753 | restoring the old value at the end of the block. If `item` doesn't |
| 1754 | exist on `obj`, it will be created and then deleted at the end of the |
| 1755 | block. |
| 1756 | """ |
| 1757 | if item in obj: |
| 1758 | real_val = obj[item] |
| 1759 | obj[item] = new_val |
| 1760 | try: |
| 1761 | yield |
| 1762 | finally: |
| 1763 | obj[item] = real_val |
| 1764 | else: |
| 1765 | obj[item] = new_val |
| 1766 | try: |
| 1767 | yield |
| 1768 | finally: |
| 1769 | del obj[item] |
Antoine Pitrou | 62f68ed | 2010-08-04 11:48:56 +0000 | [diff] [blame] | 1770 | |
| 1771 | def strip_python_stderr(stderr): |
| 1772 | """Strip the stderr of a Python process from potential debug output |
| 1773 | emitted by the interpreter. |
| 1774 | |
| 1775 | This will typically be run on the result of the communicate() method |
| 1776 | of a subprocess.Popen object. |
| 1777 | """ |
Richard Oudkerk | 73d9a29 | 2012-06-14 15:30:10 +0100 | [diff] [blame] | 1778 | stderr = re.sub(br"\[\d+ refs\]\r?\n?", b"", stderr).strip() |
Antoine Pitrou | 62f68ed | 2010-08-04 11:48:56 +0000 | [diff] [blame] | 1779 | return stderr |
Antoine Pitrou | 1b03f2c | 2010-10-14 11:12:00 +0000 | [diff] [blame] | 1780 | |
| 1781 | def args_from_interpreter_flags(): |
| 1782 | """Return a list of command-line arguments reproducing the current |
Brett Cannon | b880c15 | 2011-03-15 16:03:09 -0400 | [diff] [blame] | 1783 | settings in sys.flags and sys.warnoptions.""" |
Antoine Pitrou | ebdcd85 | 2012-05-18 18:33:07 +0200 | [diff] [blame] | 1784 | return subprocess._args_from_interpreter_flags() |
Vinay Sajip | 129fd04 | 2010-12-10 08:19:38 +0000 | [diff] [blame] | 1785 | |
| 1786 | #============================================================ |
| 1787 | # Support for assertions about logging. |
| 1788 | #============================================================ |
| 1789 | |
| 1790 | class TestHandler(logging.handlers.BufferingHandler): |
| 1791 | def __init__(self, matcher): |
| 1792 | # BufferingHandler takes a "capacity" argument |
| 1793 | # so as to know when to flush. As we're overriding |
| 1794 | # shouldFlush anyway, we can set a capacity of zero. |
| 1795 | # You can call flush() manually to clear out the |
| 1796 | # buffer. |
| 1797 | logging.handlers.BufferingHandler.__init__(self, 0) |
| 1798 | self.matcher = matcher |
| 1799 | |
| 1800 | def shouldFlush(self): |
| 1801 | return False |
| 1802 | |
| 1803 | def emit(self, record): |
| 1804 | self.format(record) |
| 1805 | self.buffer.append(record.__dict__) |
| 1806 | |
| 1807 | def matches(self, **kwargs): |
| 1808 | """ |
| 1809 | Look for a saved dict whose keys/values match the supplied arguments. |
| 1810 | """ |
| 1811 | result = False |
| 1812 | for d in self.buffer: |
| 1813 | if self.matcher.matches(d, **kwargs): |
| 1814 | result = True |
| 1815 | break |
| 1816 | return result |
| 1817 | |
| 1818 | class Matcher(object): |
| 1819 | |
| 1820 | _partial_matches = ('msg', 'message') |
| 1821 | |
| 1822 | def matches(self, d, **kwargs): |
| 1823 | """ |
| 1824 | Try to match a single dict with the supplied arguments. |
| 1825 | |
| 1826 | Keys whose values are strings and which are in self._partial_matches |
| 1827 | will be checked for partial (i.e. substring) matches. You can extend |
| 1828 | this scheme to (for example) do regular expression matching, etc. |
| 1829 | """ |
| 1830 | result = True |
| 1831 | for k in kwargs: |
| 1832 | v = kwargs[k] |
| 1833 | dv = d.get(k) |
| 1834 | if not self.match_value(k, dv, v): |
| 1835 | result = False |
| 1836 | break |
| 1837 | return result |
| 1838 | |
| 1839 | def match_value(self, k, dv, v): |
| 1840 | """ |
| 1841 | Try to match a single stored value (dv) with a supplied value (v). |
| 1842 | """ |
| 1843 | if type(v) != type(dv): |
| 1844 | result = False |
| 1845 | elif type(dv) is not str or k not in self._partial_matches: |
| 1846 | result = (v == dv) |
| 1847 | else: |
| 1848 | result = dv.find(v) >= 0 |
| 1849 | return result |
Brian Curtin | 3b4499c | 2010-12-28 14:31:47 +0000 | [diff] [blame] | 1850 | |
| 1851 | |
| 1852 | _can_symlink = None |
| 1853 | def can_symlink(): |
| 1854 | global _can_symlink |
| 1855 | if _can_symlink is not None: |
| 1856 | return _can_symlink |
Brett Cannon | ee877a0 | 2011-03-15 17:32:14 -0400 | [diff] [blame] | 1857 | symlink_path = TESTFN + "can_symlink" |
Brian Curtin | 3b4499c | 2010-12-28 14:31:47 +0000 | [diff] [blame] | 1858 | try: |
Brett Cannon | ee877a0 | 2011-03-15 17:32:14 -0400 | [diff] [blame] | 1859 | os.symlink(TESTFN, symlink_path) |
Brian Curtin | 3b4499c | 2010-12-28 14:31:47 +0000 | [diff] [blame] | 1860 | can = True |
Brian Curtin | d25aef5 | 2011-06-13 15:16:04 -0500 | [diff] [blame] | 1861 | except (OSError, NotImplementedError, AttributeError): |
Brian Curtin | 3b4499c | 2010-12-28 14:31:47 +0000 | [diff] [blame] | 1862 | can = False |
Victor Stinner | 62ec61f | 2011-06-07 12:17:15 +0200 | [diff] [blame] | 1863 | else: |
| 1864 | os.remove(symlink_path) |
Brian Curtin | 3b4499c | 2010-12-28 14:31:47 +0000 | [diff] [blame] | 1865 | _can_symlink = can |
| 1866 | return can |
| 1867 | |
| 1868 | def skip_unless_symlink(test): |
| 1869 | """Skip decorator for tests that require functional symlink""" |
| 1870 | ok = can_symlink() |
| 1871 | msg = "Requires functional symlink implementation" |
| 1872 | return test if ok else unittest.skip(msg)(test) |
Antoine Pitrou | e870623 | 2011-03-15 21:05:36 +0100 | [diff] [blame] | 1873 | |
Antoine Pitrou | 424246f | 2012-05-12 19:02:01 +0200 | [diff] [blame] | 1874 | _can_xattr = None |
| 1875 | def can_xattr(): |
| 1876 | global _can_xattr |
| 1877 | if _can_xattr is not None: |
| 1878 | return _can_xattr |
| 1879 | if not hasattr(os, "setxattr"): |
| 1880 | can = False |
| 1881 | else: |
Hynek Schlawack | e02ba10 | 2012-05-23 11:22:44 +0200 | [diff] [blame] | 1882 | tmp_fp, tmp_name = tempfile.mkstemp() |
Antoine Pitrou | 424246f | 2012-05-12 19:02:01 +0200 | [diff] [blame] | 1883 | try: |
| 1884 | with open(TESTFN, "wb") as fp: |
| 1885 | try: |
Hynek Schlawack | e02ba10 | 2012-05-23 11:22:44 +0200 | [diff] [blame] | 1886 | # TESTFN & tempfile may use different file systems with |
| 1887 | # different capabilities |
Larry Hastings | 9cf065c | 2012-06-22 16:30:09 -0700 | [diff] [blame] | 1888 | os.setxattr(tmp_fp, b"user.test", b"") |
| 1889 | os.setxattr(fp.fileno(), b"user.test", b"") |
Antoine Pitrou | 424246f | 2012-05-12 19:02:01 +0200 | [diff] [blame] | 1890 | # Kernels < 2.6.39 don't respect setxattr flags. |
| 1891 | kernel_version = platform.release() |
| 1892 | m = re.match("2.6.(\d{1,2})", kernel_version) |
| 1893 | can = m is None or int(m.group(1)) >= 39 |
| 1894 | except OSError: |
| 1895 | can = False |
| 1896 | finally: |
| 1897 | unlink(TESTFN) |
Hynek Schlawack | e02ba10 | 2012-05-23 11:22:44 +0200 | [diff] [blame] | 1898 | unlink(tmp_name) |
Antoine Pitrou | 424246f | 2012-05-12 19:02:01 +0200 | [diff] [blame] | 1899 | _can_xattr = can |
| 1900 | return can |
| 1901 | |
| 1902 | def skip_unless_xattr(test): |
| 1903 | """Skip decorator for tests that require functional extended attributes""" |
| 1904 | ok = can_xattr() |
| 1905 | msg = "no non-broken extended attribute support" |
| 1906 | return test if ok else unittest.skip(msg)(test) |
| 1907 | |
Antoine Pitrou | 2c50a09 | 2011-03-15 21:02:59 +0100 | [diff] [blame] | 1908 | def patch(test_instance, object_to_patch, attr_name, new_value): |
| 1909 | """Override 'object_to_patch'.'attr_name' with 'new_value'. |
| 1910 | |
| 1911 | Also, add a cleanup procedure to 'test_instance' to restore |
| 1912 | 'object_to_patch' value for 'attr_name'. |
| 1913 | The 'attr_name' should be a valid attribute for 'object_to_patch'. |
| 1914 | |
| 1915 | """ |
| 1916 | # check that 'attr_name' is a real attribute for 'object_to_patch' |
| 1917 | # will raise AttributeError if it does not exist |
| 1918 | getattr(object_to_patch, attr_name) |
| 1919 | |
| 1920 | # keep a copy of the old value |
| 1921 | attr_is_local = False |
| 1922 | try: |
| 1923 | old_value = object_to_patch.__dict__[attr_name] |
| 1924 | except (AttributeError, KeyError): |
| 1925 | old_value = getattr(object_to_patch, attr_name, None) |
| 1926 | else: |
| 1927 | attr_is_local = True |
| 1928 | |
| 1929 | # restore the value when the test is done |
| 1930 | def cleanup(): |
| 1931 | if attr_is_local: |
| 1932 | setattr(object_to_patch, attr_name, old_value) |
| 1933 | else: |
| 1934 | delattr(object_to_patch, attr_name) |
| 1935 | |
| 1936 | test_instance.addCleanup(cleanup) |
| 1937 | |
| 1938 | # actually override the attribute |
| 1939 | setattr(object_to_patch, attr_name, new_value) |