Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1 | # |
| 2 | # Unit tests for the multiprocessing package |
| 3 | # |
| 4 | |
| 5 | import unittest |
Julien Palard | 5d236ca | 2018-11-04 23:40:32 +0100 | [diff] [blame] | 6 | import unittest.mock |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 7 | import queue as pyqueue |
| 8 | import time |
Alexandre Vassalotti | c57a84f | 2009-07-17 12:07:01 +0000 | [diff] [blame] | 9 | import io |
Antoine Pitrou | de911b2 | 2011-12-21 11:03:24 +0100 | [diff] [blame] | 10 | import itertools |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 11 | import sys |
| 12 | import os |
| 13 | import gc |
Antoine Pitrou | c824e9a | 2011-04-05 18:11:33 +0200 | [diff] [blame] | 14 | import errno |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 15 | import signal |
| 16 | import array |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 17 | import socket |
| 18 | import random |
| 19 | import logging |
Pierre Glaser | b1dfcad | 2019-05-13 21:15:32 +0200 | [diff] [blame] | 20 | import subprocess |
Richard Oudkerk | 3730a17 | 2012-06-15 18:26:07 +0100 | [diff] [blame] | 21 | import struct |
Richard Oudkerk | fc7b0ec | 2012-10-08 14:56:24 +0100 | [diff] [blame] | 22 | import operator |
Davin Potts | e895de3 | 2019-02-23 22:08:16 -0600 | [diff] [blame] | 23 | import pickle |
Antoine Pitrou | 8988945 | 2017-03-24 13:52:11 +0100 | [diff] [blame] | 24 | import weakref |
Pablo Galindo | ec74d18 | 2018-09-04 09:53:54 +0100 | [diff] [blame] | 25 | import warnings |
R. David Murray | a21e4ca | 2009-03-31 23:16:50 +0000 | [diff] [blame] | 26 | import test.support |
Berker Peksag | 076dbd0 | 2015-05-06 07:01:52 +0300 | [diff] [blame] | 27 | import test.support.script_helper |
Victor Stinner | b9b6900 | 2017-09-14 14:40:56 -0700 | [diff] [blame] | 28 | from test import support |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 29 | |
Benjamin Peterson | e5384b0 | 2008-10-04 22:00:42 +0000 | [diff] [blame] | 30 | |
R. David Murray | a21e4ca | 2009-03-31 23:16:50 +0000 | [diff] [blame] | 31 | # Skip tests if _multiprocessing wasn't built. |
| 32 | _multiprocessing = test.support.import_module('_multiprocessing') |
| 33 | # Skip tests if sem_open implementation is broken. |
| 34 | test.support.import_module('multiprocessing.synchronize') |
Victor Stinner | 45df820 | 2010-04-28 22:31:17 +0000 | [diff] [blame] | 35 | import threading |
Benjamin Peterson | e5384b0 | 2008-10-04 22:00:42 +0000 | [diff] [blame] | 36 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 37 | import multiprocessing.connection |
Victor Stinner | d7e64d9 | 2017-07-25 00:33:56 +0200 | [diff] [blame] | 38 | import multiprocessing.dummy |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 39 | import multiprocessing.heap |
Victor Stinner | d7e64d9 | 2017-07-25 00:33:56 +0200 | [diff] [blame] | 40 | import multiprocessing.managers |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 41 | import multiprocessing.pool |
Victor Stinner | d7e64d9 | 2017-07-25 00:33:56 +0200 | [diff] [blame] | 42 | import multiprocessing.queues |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 43 | |
Charles-François Natali | bc8f082 | 2011-09-20 20:36:51 +0200 | [diff] [blame] | 44 | from multiprocessing import util |
| 45 | |
| 46 | try: |
| 47 | from multiprocessing import reduction |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 48 | HAS_REDUCTION = reduction.HAVE_SEND_HANDLE |
Charles-François Natali | bc8f082 | 2011-09-20 20:36:51 +0200 | [diff] [blame] | 49 | except ImportError: |
| 50 | HAS_REDUCTION = False |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 51 | |
Brian Curtin | afa88b5 | 2010-10-07 01:12:19 +0000 | [diff] [blame] | 52 | try: |
| 53 | from multiprocessing.sharedctypes import Value, copy |
| 54 | HAS_SHAREDCTYPES = True |
| 55 | except ImportError: |
| 56 | HAS_SHAREDCTYPES = False |
| 57 | |
Antoine Pitrou | bcb39d4 | 2011-08-23 19:46:22 +0200 | [diff] [blame] | 58 | try: |
Davin Potts | e895de3 | 2019-02-23 22:08:16 -0600 | [diff] [blame] | 59 | from multiprocessing import shared_memory |
| 60 | HAS_SHMEM = True |
| 61 | except ImportError: |
| 62 | HAS_SHMEM = False |
| 63 | |
| 64 | try: |
Antoine Pitrou | bcb39d4 | 2011-08-23 19:46:22 +0200 | [diff] [blame] | 65 | import msvcrt |
| 66 | except ImportError: |
| 67 | msvcrt = None |
| 68 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 69 | # |
| 70 | # |
| 71 | # |
| 72 | |
Victor Stinner | 11f0807 | 2017-09-15 06:55:31 -0700 | [diff] [blame] | 73 | # Timeout to wait until a process completes |
Pablo Galindo | 40b6907 | 2019-03-22 07:36:56 +0000 | [diff] [blame] | 74 | TIMEOUT = 60.0 # seconds |
Victor Stinner | 11f0807 | 2017-09-15 06:55:31 -0700 | [diff] [blame] | 75 | |
Benjamin Peterson | 2bc91df | 2008-07-13 18:45:30 +0000 | [diff] [blame] | 76 | def latin(s): |
| 77 | return s.encode('latin') |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 78 | |
Victor Stinner | d7e64d9 | 2017-07-25 00:33:56 +0200 | [diff] [blame] | 79 | |
| 80 | def close_queue(queue): |
| 81 | if isinstance(queue, multiprocessing.queues.Queue): |
| 82 | queue.close() |
| 83 | queue.join_thread() |
| 84 | |
| 85 | |
Victor Stinner | 11f0807 | 2017-09-15 06:55:31 -0700 | [diff] [blame] | 86 | def join_process(process): |
Victor Stinner | b9b6900 | 2017-09-14 14:40:56 -0700 | [diff] [blame] | 87 | # Since multiprocessing.Process has the same API than threading.Thread |
| 88 | # (join() and is_alive(), the support function can be reused |
Victor Stinner | 11f0807 | 2017-09-15 06:55:31 -0700 | [diff] [blame] | 89 | support.join_thread(process, timeout=TIMEOUT) |
Victor Stinner | b9b6900 | 2017-09-14 14:40:56 -0700 | [diff] [blame] | 90 | |
| 91 | |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 92 | if os.name == "posix": |
| 93 | from multiprocessing import resource_tracker |
| 94 | |
| 95 | def _resource_unlink(name, rtype): |
| 96 | resource_tracker._CLEANUP_FUNCS[rtype](name) |
| 97 | |
| 98 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 99 | # |
| 100 | # Constants |
| 101 | # |
| 102 | |
| 103 | LOG_LEVEL = util.SUBWARNING |
Jesse Noller | 1f0b658 | 2010-01-27 03:36:01 +0000 | [diff] [blame] | 104 | #LOG_LEVEL = logging.DEBUG |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 105 | |
| 106 | DELTA = 0.1 |
| 107 | CHECK_TIMINGS = False # making true makes tests take a lot longer |
| 108 | # and can sometimes cause some non-serious |
| 109 | # failures because some calls block a bit |
| 110 | # longer than expected |
| 111 | if CHECK_TIMINGS: |
| 112 | TIMEOUT1, TIMEOUT2, TIMEOUT3 = 0.82, 0.35, 1.4 |
| 113 | else: |
| 114 | TIMEOUT1, TIMEOUT2, TIMEOUT3 = 0.1, 0.1, 0.1 |
| 115 | |
| 116 | HAVE_GETVALUE = not getattr(_multiprocessing, |
| 117 | 'HAVE_BROKEN_SEM_GETVALUE', False) |
| 118 | |
Victor Stinner | 937ee9e | 2018-06-26 02:11:06 +0200 | [diff] [blame] | 119 | WIN32 = (sys.platform == "win32") |
| 120 | |
Richard Oudkerk | 59d5404 | 2012-05-10 16:11:12 +0100 | [diff] [blame] | 121 | from multiprocessing.connection import wait |
Antoine Pitrou | 176f07d | 2011-06-06 19:35:31 +0200 | [diff] [blame] | 122 | |
Richard Oudkerk | 59d5404 | 2012-05-10 16:11:12 +0100 | [diff] [blame] | 123 | def wait_for_handle(handle, timeout): |
| 124 | if timeout is not None and timeout < 0.0: |
| 125 | timeout = None |
| 126 | return wait([handle], timeout) |
Jesse Noller | 6214edd | 2009-01-19 16:23:53 +0000 | [diff] [blame] | 127 | |
Antoine Pitrou | bcb39d4 | 2011-08-23 19:46:22 +0200 | [diff] [blame] | 128 | try: |
| 129 | MAXFD = os.sysconf("SC_OPEN_MAX") |
| 130 | except: |
| 131 | MAXFD = 256 |
| 132 | |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 133 | # To speed up tests when using the forkserver, we can preload these: |
| 134 | PRELOAD = ['__main__', 'test.test_multiprocessing_forkserver'] |
| 135 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 136 | # |
Florent Xicluna | fd1b093 | 2010-03-28 00:25:02 +0000 | [diff] [blame] | 137 | # Some tests require ctypes |
| 138 | # |
| 139 | |
| 140 | try: |
Gareth Rees | 3913bad | 2017-07-21 11:35:33 +0100 | [diff] [blame] | 141 | from ctypes import Structure, c_int, c_double, c_longlong |
Florent Xicluna | fd1b093 | 2010-03-28 00:25:02 +0000 | [diff] [blame] | 142 | except ImportError: |
| 143 | Structure = object |
Antoine Pitrou | ff92ff5 | 2017-07-21 13:24:05 +0200 | [diff] [blame] | 144 | c_int = c_double = c_longlong = None |
Florent Xicluna | fd1b093 | 2010-03-28 00:25:02 +0000 | [diff] [blame] | 145 | |
Charles-François Natali | 221ef67 | 2011-11-22 18:55:22 +0100 | [diff] [blame] | 146 | |
| 147 | def check_enough_semaphores(): |
| 148 | """Check that the system supports enough semaphores to run the test.""" |
| 149 | # minimum number of semaphores available according to POSIX |
| 150 | nsems_min = 256 |
| 151 | try: |
| 152 | nsems = os.sysconf("SC_SEM_NSEMS_MAX") |
| 153 | except (AttributeError, ValueError): |
| 154 | # sysconf not available or setting not available |
| 155 | return |
| 156 | if nsems == -1 or nsems >= nsems_min: |
| 157 | return |
| 158 | raise unittest.SkipTest("The OS doesn't support enough semaphores " |
| 159 | "to run the test (required: %d)." % nsems_min) |
| 160 | |
| 161 | |
Florent Xicluna | fd1b093 | 2010-03-28 00:25:02 +0000 | [diff] [blame] | 162 | # |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 163 | # Creates a wrapper for a function which records the time it takes to finish |
| 164 | # |
| 165 | |
| 166 | class TimingWrapper(object): |
| 167 | |
| 168 | def __init__(self, func): |
| 169 | self.func = func |
| 170 | self.elapsed = None |
| 171 | |
| 172 | def __call__(self, *args, **kwds): |
Victor Stinner | 2cf4c20 | 2018-12-17 09:36:36 +0100 | [diff] [blame] | 173 | t = time.monotonic() |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 174 | try: |
| 175 | return self.func(*args, **kwds) |
| 176 | finally: |
Victor Stinner | 2cf4c20 | 2018-12-17 09:36:36 +0100 | [diff] [blame] | 177 | self.elapsed = time.monotonic() - t |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 178 | |
| 179 | # |
| 180 | # Base class for test cases |
| 181 | # |
| 182 | |
| 183 | class BaseTestCase(object): |
| 184 | |
| 185 | ALLOWED_TYPES = ('processes', 'manager', 'threads') |
| 186 | |
| 187 | def assertTimingAlmostEqual(self, a, b): |
| 188 | if CHECK_TIMINGS: |
| 189 | self.assertAlmostEqual(a, b, 1) |
| 190 | |
| 191 | def assertReturnsIfImplemented(self, value, func, *args): |
| 192 | try: |
| 193 | res = func(*args) |
| 194 | except NotImplementedError: |
| 195 | pass |
| 196 | else: |
| 197 | return self.assertEqual(value, res) |
| 198 | |
Antoine Pitrou | 0d1b38c | 2010-11-02 23:50:11 +0000 | [diff] [blame] | 199 | # For the sanity of Windows users, rather than crashing or freezing in |
| 200 | # multiple ways. |
| 201 | def __reduce__(self, *args): |
| 202 | raise NotImplementedError("shouldn't try to pickle a test case") |
| 203 | |
| 204 | __reduce_ex__ = __reduce__ |
| 205 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 206 | # |
| 207 | # Return the value of a semaphore |
| 208 | # |
| 209 | |
| 210 | def get_value(self): |
| 211 | try: |
| 212 | return self.get_value() |
| 213 | except AttributeError: |
| 214 | try: |
| 215 | return self._Semaphore__value |
| 216 | except AttributeError: |
| 217 | try: |
| 218 | return self._value |
| 219 | except AttributeError: |
| 220 | raise NotImplementedError |
| 221 | |
| 222 | # |
| 223 | # Testcases |
| 224 | # |
| 225 | |
Antoine Pitrou | 79d37ae | 2017-06-28 12:29:08 +0200 | [diff] [blame] | 226 | class DummyCallable: |
| 227 | def __call__(self, q, c): |
| 228 | assert isinstance(c, DummyCallable) |
| 229 | q.put(5) |
| 230 | |
| 231 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 232 | class _TestProcess(BaseTestCase): |
| 233 | |
| 234 | ALLOWED_TYPES = ('processes', 'threads') |
| 235 | |
| 236 | def test_current(self): |
| 237 | if self.TYPE == 'threads': |
Zachary Ware | 9fe6d86 | 2013-12-08 00:20:35 -0600 | [diff] [blame] | 238 | self.skipTest('test not appropriate for {}'.format(self.TYPE)) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 239 | |
| 240 | current = self.current_process() |
Benjamin Peterson | 58ea9fe | 2008-08-19 19:17:39 +0000 | [diff] [blame] | 241 | authkey = current.authkey |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 242 | |
| 243 | self.assertTrue(current.is_alive()) |
Benjamin Peterson | 58ea9fe | 2008-08-19 19:17:39 +0000 | [diff] [blame] | 244 | self.assertTrue(not current.daemon) |
Ezio Melotti | e961593 | 2010-01-24 19:26:24 +0000 | [diff] [blame] | 245 | self.assertIsInstance(authkey, bytes) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 246 | self.assertTrue(len(authkey) > 0) |
Benjamin Peterson | 58ea9fe | 2008-08-19 19:17:39 +0000 | [diff] [blame] | 247 | self.assertEqual(current.ident, os.getpid()) |
| 248 | self.assertEqual(current.exitcode, None) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 249 | |
Antoine Pitrou | 0bd4deb | 2011-02-25 22:07:43 +0000 | [diff] [blame] | 250 | def test_daemon_argument(self): |
| 251 | if self.TYPE == "threads": |
Zachary Ware | 9fe6d86 | 2013-12-08 00:20:35 -0600 | [diff] [blame] | 252 | self.skipTest('test not appropriate for {}'.format(self.TYPE)) |
Antoine Pitrou | 0bd4deb | 2011-02-25 22:07:43 +0000 | [diff] [blame] | 253 | |
| 254 | # By default uses the current process's daemon flag. |
| 255 | proc0 = self.Process(target=self._test) |
Antoine Pitrou | ec78522 | 2011-03-02 00:15:44 +0000 | [diff] [blame] | 256 | self.assertEqual(proc0.daemon, self.current_process().daemon) |
Antoine Pitrou | 0bd4deb | 2011-02-25 22:07:43 +0000 | [diff] [blame] | 257 | proc1 = self.Process(target=self._test, daemon=True) |
| 258 | self.assertTrue(proc1.daemon) |
| 259 | proc2 = self.Process(target=self._test, daemon=False) |
| 260 | self.assertFalse(proc2.daemon) |
| 261 | |
Antoine Pitrou | 0d1b38c | 2010-11-02 23:50:11 +0000 | [diff] [blame] | 262 | @classmethod |
| 263 | def _test(cls, q, *args, **kwds): |
| 264 | current = cls.current_process() |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 265 | q.put(args) |
| 266 | q.put(kwds) |
Benjamin Peterson | 58ea9fe | 2008-08-19 19:17:39 +0000 | [diff] [blame] | 267 | q.put(current.name) |
Antoine Pitrou | 0d1b38c | 2010-11-02 23:50:11 +0000 | [diff] [blame] | 268 | if cls.TYPE != 'threads': |
Benjamin Peterson | 58ea9fe | 2008-08-19 19:17:39 +0000 | [diff] [blame] | 269 | q.put(bytes(current.authkey)) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 270 | q.put(current.pid) |
| 271 | |
| 272 | def test_process(self): |
| 273 | q = self.Queue(1) |
| 274 | e = self.Event() |
| 275 | args = (q, 1, 2) |
| 276 | kwargs = {'hello':23, 'bye':2.54} |
| 277 | name = 'SomeProcess' |
| 278 | p = self.Process( |
| 279 | target=self._test, args=args, kwargs=kwargs, name=name |
| 280 | ) |
Benjamin Peterson | 58ea9fe | 2008-08-19 19:17:39 +0000 | [diff] [blame] | 281 | p.daemon = True |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 282 | current = self.current_process() |
| 283 | |
| 284 | if self.TYPE != 'threads': |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 285 | self.assertEqual(p.authkey, current.authkey) |
| 286 | self.assertEqual(p.is_alive(), False) |
| 287 | self.assertEqual(p.daemon, True) |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 288 | self.assertNotIn(p, self.active_children()) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 289 | self.assertTrue(type(self.active_children()) is list) |
Benjamin Peterson | 58ea9fe | 2008-08-19 19:17:39 +0000 | [diff] [blame] | 290 | self.assertEqual(p.exitcode, None) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 291 | |
| 292 | p.start() |
| 293 | |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 294 | self.assertEqual(p.exitcode, None) |
| 295 | self.assertEqual(p.is_alive(), True) |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 296 | self.assertIn(p, self.active_children()) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 297 | |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 298 | self.assertEqual(q.get(), args[1:]) |
| 299 | self.assertEqual(q.get(), kwargs) |
| 300 | self.assertEqual(q.get(), p.name) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 301 | if self.TYPE != 'threads': |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 302 | self.assertEqual(q.get(), current.authkey) |
| 303 | self.assertEqual(q.get(), p.pid) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 304 | |
| 305 | p.join() |
| 306 | |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 307 | self.assertEqual(p.exitcode, 0) |
| 308 | self.assertEqual(p.is_alive(), False) |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 309 | self.assertNotIn(p, self.active_children()) |
Victor Stinner | b4c5296 | 2017-07-25 02:40:55 +0200 | [diff] [blame] | 310 | close_queue(q) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 311 | |
Antoine Pitrou | 0d1b38c | 2010-11-02 23:50:11 +0000 | [diff] [blame] | 312 | @classmethod |
Vitor Pereira | ba75af7 | 2017-07-18 16:34:23 +0100 | [diff] [blame] | 313 | def _sleep_some(cls): |
Richard Oudkerk | 4f35079 | 2013-10-13 00:49:27 +0100 | [diff] [blame] | 314 | time.sleep(100) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 315 | |
Antoine Pitrou | dfd5f34 | 2017-06-12 15:28:19 +0200 | [diff] [blame] | 316 | @classmethod |
| 317 | def _test_sleep(cls, delay): |
| 318 | time.sleep(delay) |
| 319 | |
Vitor Pereira | ba75af7 | 2017-07-18 16:34:23 +0100 | [diff] [blame] | 320 | def _kill_process(self, meth): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 321 | if self.TYPE == 'threads': |
Zachary Ware | 9fe6d86 | 2013-12-08 00:20:35 -0600 | [diff] [blame] | 322 | self.skipTest('test not appropriate for {}'.format(self.TYPE)) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 323 | |
Vitor Pereira | ba75af7 | 2017-07-18 16:34:23 +0100 | [diff] [blame] | 324 | p = self.Process(target=self._sleep_some) |
Benjamin Peterson | 58ea9fe | 2008-08-19 19:17:39 +0000 | [diff] [blame] | 325 | p.daemon = True |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 326 | p.start() |
| 327 | |
| 328 | self.assertEqual(p.is_alive(), True) |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 329 | self.assertIn(p, self.active_children()) |
Benjamin Peterson | 58ea9fe | 2008-08-19 19:17:39 +0000 | [diff] [blame] | 330 | self.assertEqual(p.exitcode, None) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 331 | |
Richard Oudkerk | 59d5404 | 2012-05-10 16:11:12 +0100 | [diff] [blame] | 332 | join = TimingWrapper(p.join) |
| 333 | |
| 334 | self.assertEqual(join(0), None) |
| 335 | self.assertTimingAlmostEqual(join.elapsed, 0.0) |
| 336 | self.assertEqual(p.is_alive(), True) |
| 337 | |
| 338 | self.assertEqual(join(-1), None) |
| 339 | self.assertTimingAlmostEqual(join.elapsed, 0.0) |
| 340 | self.assertEqual(p.is_alive(), True) |
| 341 | |
Richard Oudkerk | 26f9268 | 2013-10-17 13:56:18 +0100 | [diff] [blame] | 342 | # XXX maybe terminating too soon causes the problems on Gentoo... |
| 343 | time.sleep(1) |
| 344 | |
Vitor Pereira | ba75af7 | 2017-07-18 16:34:23 +0100 | [diff] [blame] | 345 | meth(p) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 346 | |
Richard Oudkerk | 4f35079 | 2013-10-13 00:49:27 +0100 | [diff] [blame] | 347 | if hasattr(signal, 'alarm'): |
Richard Oudkerk | d44500a | 2013-10-17 10:38:37 +0100 | [diff] [blame] | 348 | # On the Gentoo buildbot waitpid() often seems to block forever. |
Richard Oudkerk | 26f9268 | 2013-10-17 13:56:18 +0100 | [diff] [blame] | 349 | # We use alarm() to interrupt it if it blocks for too long. |
Richard Oudkerk | 4f35079 | 2013-10-13 00:49:27 +0100 | [diff] [blame] | 350 | def handler(*args): |
Richard Oudkerk | b46fe79 | 2013-10-15 16:48:51 +0100 | [diff] [blame] | 351 | raise RuntimeError('join took too long: %s' % p) |
Richard Oudkerk | 4f35079 | 2013-10-13 00:49:27 +0100 | [diff] [blame] | 352 | old_handler = signal.signal(signal.SIGALRM, handler) |
| 353 | try: |
| 354 | signal.alarm(10) |
| 355 | self.assertEqual(join(), None) |
Richard Oudkerk | 4f35079 | 2013-10-13 00:49:27 +0100 | [diff] [blame] | 356 | finally: |
Richard Oudkerk | 1e2f67c | 2013-10-17 14:24:06 +0100 | [diff] [blame] | 357 | signal.alarm(0) |
Richard Oudkerk | 4f35079 | 2013-10-13 00:49:27 +0100 | [diff] [blame] | 358 | signal.signal(signal.SIGALRM, old_handler) |
| 359 | else: |
| 360 | self.assertEqual(join(), None) |
| 361 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 362 | self.assertTimingAlmostEqual(join.elapsed, 0.0) |
| 363 | |
| 364 | self.assertEqual(p.is_alive(), False) |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 365 | self.assertNotIn(p, self.active_children()) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 366 | |
| 367 | p.join() |
| 368 | |
Vitor Pereira | ba75af7 | 2017-07-18 16:34:23 +0100 | [diff] [blame] | 369 | return p.exitcode |
| 370 | |
| 371 | def test_terminate(self): |
| 372 | exitcode = self._kill_process(multiprocessing.Process.terminate) |
Antoine Pitrou | dfd5f34 | 2017-06-12 15:28:19 +0200 | [diff] [blame] | 373 | if os.name != 'nt': |
Vitor Pereira | ba75af7 | 2017-07-18 16:34:23 +0100 | [diff] [blame] | 374 | self.assertEqual(exitcode, -signal.SIGTERM) |
| 375 | |
| 376 | def test_kill(self): |
| 377 | exitcode = self._kill_process(multiprocessing.Process.kill) |
| 378 | if os.name != 'nt': |
| 379 | self.assertEqual(exitcode, -signal.SIGKILL) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 380 | |
| 381 | def test_cpu_count(self): |
| 382 | try: |
| 383 | cpus = multiprocessing.cpu_count() |
| 384 | except NotImplementedError: |
| 385 | cpus = 1 |
| 386 | self.assertTrue(type(cpus) is int) |
| 387 | self.assertTrue(cpus >= 1) |
| 388 | |
| 389 | def test_active_children(self): |
| 390 | self.assertEqual(type(self.active_children()), list) |
| 391 | |
| 392 | p = self.Process(target=time.sleep, args=(DELTA,)) |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 393 | self.assertNotIn(p, self.active_children()) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 394 | |
Jesus Cea | 94f964f | 2011-09-09 20:26:57 +0200 | [diff] [blame] | 395 | p.daemon = True |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 396 | p.start() |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 397 | self.assertIn(p, self.active_children()) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 398 | |
| 399 | p.join() |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 400 | self.assertNotIn(p, self.active_children()) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 401 | |
Antoine Pitrou | 0d1b38c | 2010-11-02 23:50:11 +0000 | [diff] [blame] | 402 | @classmethod |
| 403 | def _test_recursion(cls, wconn, id): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 404 | wconn.send(id) |
| 405 | if len(id) < 2: |
| 406 | for i in range(2): |
Antoine Pitrou | 0d1b38c | 2010-11-02 23:50:11 +0000 | [diff] [blame] | 407 | p = cls.Process( |
| 408 | target=cls._test_recursion, args=(wconn, id+[i]) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 409 | ) |
| 410 | p.start() |
| 411 | p.join() |
| 412 | |
| 413 | def test_recursion(self): |
| 414 | rconn, wconn = self.Pipe(duplex=False) |
| 415 | self._test_recursion(wconn, []) |
| 416 | |
| 417 | time.sleep(DELTA) |
| 418 | result = [] |
| 419 | while rconn.poll(): |
| 420 | result.append(rconn.recv()) |
| 421 | |
| 422 | expected = [ |
| 423 | [], |
| 424 | [0], |
| 425 | [0, 0], |
| 426 | [0, 1], |
| 427 | [1], |
| 428 | [1, 0], |
| 429 | [1, 1] |
| 430 | ] |
| 431 | self.assertEqual(result, expected) |
| 432 | |
Antoine Pitrou | 176f07d | 2011-06-06 19:35:31 +0200 | [diff] [blame] | 433 | @classmethod |
| 434 | def _test_sentinel(cls, event): |
| 435 | event.wait(10.0) |
| 436 | |
| 437 | def test_sentinel(self): |
| 438 | if self.TYPE == "threads": |
Zachary Ware | 9fe6d86 | 2013-12-08 00:20:35 -0600 | [diff] [blame] | 439 | self.skipTest('test not appropriate for {}'.format(self.TYPE)) |
Antoine Pitrou | 176f07d | 2011-06-06 19:35:31 +0200 | [diff] [blame] | 440 | event = self.Event() |
| 441 | p = self.Process(target=self._test_sentinel, args=(event,)) |
| 442 | with self.assertRaises(ValueError): |
| 443 | p.sentinel |
| 444 | p.start() |
| 445 | self.addCleanup(p.join) |
| 446 | sentinel = p.sentinel |
| 447 | self.assertIsInstance(sentinel, int) |
| 448 | self.assertFalse(wait_for_handle(sentinel, timeout=0.0)) |
| 449 | event.set() |
| 450 | p.join() |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 451 | self.assertTrue(wait_for_handle(sentinel, timeout=1)) |
Antoine Pitrou | 176f07d | 2011-06-06 19:35:31 +0200 | [diff] [blame] | 452 | |
Antoine Pitrou | 13e96cc | 2017-06-24 19:22:23 +0200 | [diff] [blame] | 453 | @classmethod |
| 454 | def _test_close(cls, rc=0, q=None): |
| 455 | if q is not None: |
| 456 | q.get() |
| 457 | sys.exit(rc) |
| 458 | |
| 459 | def test_close(self): |
| 460 | if self.TYPE == "threads": |
| 461 | self.skipTest('test not appropriate for {}'.format(self.TYPE)) |
| 462 | q = self.Queue() |
| 463 | p = self.Process(target=self._test_close, kwargs={'q': q}) |
| 464 | p.daemon = True |
| 465 | p.start() |
| 466 | self.assertEqual(p.is_alive(), True) |
| 467 | # Child is still alive, cannot close |
| 468 | with self.assertRaises(ValueError): |
| 469 | p.close() |
| 470 | |
| 471 | q.put(None) |
| 472 | p.join() |
| 473 | self.assertEqual(p.is_alive(), False) |
| 474 | self.assertEqual(p.exitcode, 0) |
| 475 | p.close() |
| 476 | with self.assertRaises(ValueError): |
| 477 | p.is_alive() |
| 478 | with self.assertRaises(ValueError): |
| 479 | p.join() |
| 480 | with self.assertRaises(ValueError): |
| 481 | p.terminate() |
| 482 | p.close() |
| 483 | |
| 484 | wr = weakref.ref(p) |
| 485 | del p |
| 486 | gc.collect() |
| 487 | self.assertIs(wr(), None) |
| 488 | |
Victor Stinner | b4c5296 | 2017-07-25 02:40:55 +0200 | [diff] [blame] | 489 | close_queue(q) |
| 490 | |
Antoine Pitrou | dfd5f34 | 2017-06-12 15:28:19 +0200 | [diff] [blame] | 491 | def test_many_processes(self): |
| 492 | if self.TYPE == 'threads': |
| 493 | self.skipTest('test not appropriate for {}'.format(self.TYPE)) |
| 494 | |
| 495 | sm = multiprocessing.get_start_method() |
| 496 | N = 5 if sm == 'spawn' else 100 |
| 497 | |
| 498 | # Try to overwhelm the forkserver loop with events |
| 499 | procs = [self.Process(target=self._test_sleep, args=(0.01,)) |
| 500 | for i in range(N)] |
| 501 | for p in procs: |
| 502 | p.start() |
| 503 | for p in procs: |
Victor Stinner | 11f0807 | 2017-09-15 06:55:31 -0700 | [diff] [blame] | 504 | join_process(p) |
Antoine Pitrou | dfd5f34 | 2017-06-12 15:28:19 +0200 | [diff] [blame] | 505 | for p in procs: |
| 506 | self.assertEqual(p.exitcode, 0) |
| 507 | |
Vitor Pereira | ba75af7 | 2017-07-18 16:34:23 +0100 | [diff] [blame] | 508 | procs = [self.Process(target=self._sleep_some) |
Antoine Pitrou | dfd5f34 | 2017-06-12 15:28:19 +0200 | [diff] [blame] | 509 | for i in range(N)] |
| 510 | for p in procs: |
| 511 | p.start() |
| 512 | time.sleep(0.001) # let the children start... |
| 513 | for p in procs: |
| 514 | p.terminate() |
| 515 | for p in procs: |
Victor Stinner | 11f0807 | 2017-09-15 06:55:31 -0700 | [diff] [blame] | 516 | join_process(p) |
Antoine Pitrou | dfd5f34 | 2017-06-12 15:28:19 +0200 | [diff] [blame] | 517 | if os.name != 'nt': |
Victor Stinner | e6cfdef | 2017-10-02 08:27:34 -0700 | [diff] [blame] | 518 | exitcodes = [-signal.SIGTERM] |
| 519 | if sys.platform == 'darwin': |
| 520 | # bpo-31510: On macOS, killing a freshly started process with |
| 521 | # SIGTERM sometimes kills the process with SIGKILL. |
| 522 | exitcodes.append(-signal.SIGKILL) |
Antoine Pitrou | dfd5f34 | 2017-06-12 15:28:19 +0200 | [diff] [blame] | 523 | for p in procs: |
Victor Stinner | e6cfdef | 2017-10-02 08:27:34 -0700 | [diff] [blame] | 524 | self.assertIn(p.exitcode, exitcodes) |
Antoine Pitrou | dfd5f34 | 2017-06-12 15:28:19 +0200 | [diff] [blame] | 525 | |
Antoine Pitrou | 79d37ae | 2017-06-28 12:29:08 +0200 | [diff] [blame] | 526 | def test_lose_target_ref(self): |
| 527 | c = DummyCallable() |
| 528 | wr = weakref.ref(c) |
| 529 | q = self.Queue() |
| 530 | p = self.Process(target=c, args=(q, c)) |
| 531 | del c |
| 532 | p.start() |
| 533 | p.join() |
| 534 | self.assertIs(wr(), None) |
| 535 | self.assertEqual(q.get(), 5) |
Victor Stinner | b4c5296 | 2017-07-25 02:40:55 +0200 | [diff] [blame] | 536 | close_queue(q) |
Antoine Pitrou | 79d37ae | 2017-06-28 12:29:08 +0200 | [diff] [blame] | 537 | |
Antoine Pitrou | 896145d | 2017-07-22 13:22:54 +0200 | [diff] [blame] | 538 | @classmethod |
| 539 | def _test_child_fd_inflation(self, evt, q): |
| 540 | q.put(test.support.fd_count()) |
| 541 | evt.wait() |
| 542 | |
| 543 | def test_child_fd_inflation(self): |
| 544 | # Number of fds in child processes should not grow with the |
| 545 | # number of running children. |
| 546 | if self.TYPE == 'threads': |
| 547 | self.skipTest('test not appropriate for {}'.format(self.TYPE)) |
| 548 | |
| 549 | sm = multiprocessing.get_start_method() |
| 550 | if sm == 'fork': |
| 551 | # The fork method by design inherits all fds from the parent, |
| 552 | # trying to go against it is a lost battle |
| 553 | self.skipTest('test not appropriate for {}'.format(sm)) |
| 554 | |
| 555 | N = 5 |
| 556 | evt = self.Event() |
| 557 | q = self.Queue() |
| 558 | |
| 559 | procs = [self.Process(target=self._test_child_fd_inflation, args=(evt, q)) |
| 560 | for i in range(N)] |
| 561 | for p in procs: |
| 562 | p.start() |
| 563 | |
| 564 | try: |
| 565 | fd_counts = [q.get() for i in range(N)] |
| 566 | self.assertEqual(len(set(fd_counts)), 1, fd_counts) |
| 567 | |
| 568 | finally: |
| 569 | evt.set() |
| 570 | for p in procs: |
| 571 | p.join() |
Victor Stinner | b4c5296 | 2017-07-25 02:40:55 +0200 | [diff] [blame] | 572 | close_queue(q) |
Antoine Pitrou | 79d37ae | 2017-06-28 12:29:08 +0200 | [diff] [blame] | 573 | |
Antoine Pitrou | ee84a60 | 2017-08-16 20:53:28 +0200 | [diff] [blame] | 574 | @classmethod |
| 575 | def _test_wait_for_threads(self, evt): |
| 576 | def func1(): |
| 577 | time.sleep(0.5) |
| 578 | evt.set() |
| 579 | |
| 580 | def func2(): |
| 581 | time.sleep(20) |
| 582 | evt.clear() |
| 583 | |
| 584 | threading.Thread(target=func1).start() |
| 585 | threading.Thread(target=func2, daemon=True).start() |
| 586 | |
| 587 | def test_wait_for_threads(self): |
| 588 | # A child process should wait for non-daemonic threads to end |
| 589 | # before exiting |
| 590 | if self.TYPE == 'threads': |
| 591 | self.skipTest('test not appropriate for {}'.format(self.TYPE)) |
| 592 | |
| 593 | evt = self.Event() |
| 594 | proc = self.Process(target=self._test_wait_for_threads, args=(evt,)) |
| 595 | proc.start() |
| 596 | proc.join() |
| 597 | self.assertTrue(evt.is_set()) |
| 598 | |
Antoine Pitrou | daeefd2 | 2017-10-22 11:40:31 +0200 | [diff] [blame] | 599 | @classmethod |
Antoine Pitrou | e756f66 | 2018-03-11 19:21:38 +0100 | [diff] [blame] | 600 | def _test_error_on_stdio_flush(self, evt, break_std_streams={}): |
| 601 | for stream_name, action in break_std_streams.items(): |
| 602 | if action == 'close': |
| 603 | stream = io.StringIO() |
| 604 | stream.close() |
| 605 | else: |
| 606 | assert action == 'remove' |
| 607 | stream = None |
| 608 | setattr(sys, stream_name, None) |
Antoine Pitrou | daeefd2 | 2017-10-22 11:40:31 +0200 | [diff] [blame] | 609 | evt.set() |
| 610 | |
Antoine Pitrou | e756f66 | 2018-03-11 19:21:38 +0100 | [diff] [blame] | 611 | def test_error_on_stdio_flush_1(self): |
| 612 | # Check that Process works with broken standard streams |
Antoine Pitrou | daeefd2 | 2017-10-22 11:40:31 +0200 | [diff] [blame] | 613 | streams = [io.StringIO(), None] |
| 614 | streams[0].close() |
| 615 | for stream_name in ('stdout', 'stderr'): |
| 616 | for stream in streams: |
| 617 | old_stream = getattr(sys, stream_name) |
| 618 | setattr(sys, stream_name, stream) |
| 619 | try: |
| 620 | evt = self.Event() |
| 621 | proc = self.Process(target=self._test_error_on_stdio_flush, |
| 622 | args=(evt,)) |
| 623 | proc.start() |
| 624 | proc.join() |
| 625 | self.assertTrue(evt.is_set()) |
Antoine Pitrou | e756f66 | 2018-03-11 19:21:38 +0100 | [diff] [blame] | 626 | self.assertEqual(proc.exitcode, 0) |
| 627 | finally: |
| 628 | setattr(sys, stream_name, old_stream) |
| 629 | |
| 630 | def test_error_on_stdio_flush_2(self): |
| 631 | # Same as test_error_on_stdio_flush_1(), but standard streams are |
| 632 | # broken by the child process |
| 633 | for stream_name in ('stdout', 'stderr'): |
| 634 | for action in ('close', 'remove'): |
| 635 | old_stream = getattr(sys, stream_name) |
| 636 | try: |
| 637 | evt = self.Event() |
| 638 | proc = self.Process(target=self._test_error_on_stdio_flush, |
| 639 | args=(evt, {stream_name: action})) |
| 640 | proc.start() |
| 641 | proc.join() |
| 642 | self.assertTrue(evt.is_set()) |
| 643 | self.assertEqual(proc.exitcode, 0) |
Antoine Pitrou | daeefd2 | 2017-10-22 11:40:31 +0200 | [diff] [blame] | 644 | finally: |
| 645 | setattr(sys, stream_name, old_stream) |
| 646 | |
Antoine Pitrou | fc6b348 | 2017-11-03 13:34:22 +0100 | [diff] [blame] | 647 | @classmethod |
| 648 | def _sleep_and_set_event(self, evt, delay=0.0): |
| 649 | time.sleep(delay) |
| 650 | evt.set() |
| 651 | |
| 652 | def check_forkserver_death(self, signum): |
| 653 | # bpo-31308: if the forkserver process has died, we should still |
| 654 | # be able to create and run new Process instances (the forkserver |
| 655 | # is implicitly restarted). |
| 656 | if self.TYPE == 'threads': |
| 657 | self.skipTest('test not appropriate for {}'.format(self.TYPE)) |
| 658 | sm = multiprocessing.get_start_method() |
| 659 | if sm != 'forkserver': |
| 660 | # The fork method by design inherits all fds from the parent, |
| 661 | # trying to go against it is a lost battle |
| 662 | self.skipTest('test not appropriate for {}'.format(sm)) |
| 663 | |
| 664 | from multiprocessing.forkserver import _forkserver |
| 665 | _forkserver.ensure_running() |
| 666 | |
Victor Stinner | 07888e1 | 2018-07-04 11:49:41 +0200 | [diff] [blame] | 667 | # First process sleeps 500 ms |
| 668 | delay = 0.5 |
| 669 | |
Antoine Pitrou | fc6b348 | 2017-11-03 13:34:22 +0100 | [diff] [blame] | 670 | evt = self.Event() |
Victor Stinner | 07888e1 | 2018-07-04 11:49:41 +0200 | [diff] [blame] | 671 | proc = self.Process(target=self._sleep_and_set_event, args=(evt, delay)) |
Antoine Pitrou | fc6b348 | 2017-11-03 13:34:22 +0100 | [diff] [blame] | 672 | proc.start() |
| 673 | |
| 674 | pid = _forkserver._forkserver_pid |
| 675 | os.kill(pid, signum) |
Victor Stinner | 07888e1 | 2018-07-04 11:49:41 +0200 | [diff] [blame] | 676 | # give time to the fork server to die and time to proc to complete |
| 677 | time.sleep(delay * 2.0) |
Antoine Pitrou | fc6b348 | 2017-11-03 13:34:22 +0100 | [diff] [blame] | 678 | |
| 679 | evt2 = self.Event() |
| 680 | proc2 = self.Process(target=self._sleep_and_set_event, args=(evt2,)) |
| 681 | proc2.start() |
| 682 | proc2.join() |
| 683 | self.assertTrue(evt2.is_set()) |
| 684 | self.assertEqual(proc2.exitcode, 0) |
| 685 | |
| 686 | proc.join() |
| 687 | self.assertTrue(evt.is_set()) |
| 688 | self.assertIn(proc.exitcode, (0, 255)) |
| 689 | |
| 690 | def test_forkserver_sigint(self): |
| 691 | # Catchable signal |
| 692 | self.check_forkserver_death(signal.SIGINT) |
| 693 | |
| 694 | def test_forkserver_sigkill(self): |
| 695 | # Uncatchable signal |
| 696 | if os.name != 'nt': |
| 697 | self.check_forkserver_death(signal.SIGKILL) |
| 698 | |
Antoine Pitrou | ee84a60 | 2017-08-16 20:53:28 +0200 | [diff] [blame] | 699 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 700 | # |
| 701 | # |
| 702 | # |
| 703 | |
| 704 | class _UpperCaser(multiprocessing.Process): |
| 705 | |
| 706 | def __init__(self): |
| 707 | multiprocessing.Process.__init__(self) |
| 708 | self.child_conn, self.parent_conn = multiprocessing.Pipe() |
| 709 | |
| 710 | def run(self): |
| 711 | self.parent_conn.close() |
| 712 | for s in iter(self.child_conn.recv, None): |
| 713 | self.child_conn.send(s.upper()) |
| 714 | self.child_conn.close() |
| 715 | |
| 716 | def submit(self, s): |
| 717 | assert type(s) is str |
| 718 | self.parent_conn.send(s) |
| 719 | return self.parent_conn.recv() |
| 720 | |
| 721 | def stop(self): |
| 722 | self.parent_conn.send(None) |
| 723 | self.parent_conn.close() |
| 724 | self.child_conn.close() |
| 725 | |
| 726 | class _TestSubclassingProcess(BaseTestCase): |
| 727 | |
| 728 | ALLOWED_TYPES = ('processes',) |
| 729 | |
| 730 | def test_subclassing(self): |
| 731 | uppercaser = _UpperCaser() |
Jesus Cea | 94f964f | 2011-09-09 20:26:57 +0200 | [diff] [blame] | 732 | uppercaser.daemon = True |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 733 | uppercaser.start() |
| 734 | self.assertEqual(uppercaser.submit('hello'), 'HELLO') |
| 735 | self.assertEqual(uppercaser.submit('world'), 'WORLD') |
| 736 | uppercaser.stop() |
| 737 | uppercaser.join() |
| 738 | |
Antoine Pitrou | 84a0fbf | 2012-01-27 10:52:37 +0100 | [diff] [blame] | 739 | def test_stderr_flush(self): |
| 740 | # sys.stderr is flushed at process shutdown (issue #13812) |
| 741 | if self.TYPE == "threads": |
Zachary Ware | 9fe6d86 | 2013-12-08 00:20:35 -0600 | [diff] [blame] | 742 | self.skipTest('test not appropriate for {}'.format(self.TYPE)) |
Antoine Pitrou | 84a0fbf | 2012-01-27 10:52:37 +0100 | [diff] [blame] | 743 | |
| 744 | testfn = test.support.TESTFN |
| 745 | self.addCleanup(test.support.unlink, testfn) |
| 746 | proc = self.Process(target=self._test_stderr_flush, args=(testfn,)) |
| 747 | proc.start() |
| 748 | proc.join() |
| 749 | with open(testfn, 'r') as f: |
| 750 | err = f.read() |
| 751 | # The whole traceback was printed |
| 752 | self.assertIn("ZeroDivisionError", err) |
| 753 | self.assertIn("test_multiprocessing.py", err) |
| 754 | self.assertIn("1/0 # MARKER", err) |
| 755 | |
| 756 | @classmethod |
| 757 | def _test_stderr_flush(cls, testfn): |
Victor Stinner | a6d865c | 2016-03-25 09:29:50 +0100 | [diff] [blame] | 758 | fd = os.open(testfn, os.O_WRONLY | os.O_CREAT | os.O_EXCL) |
| 759 | sys.stderr = open(fd, 'w', closefd=False) |
Antoine Pitrou | 84a0fbf | 2012-01-27 10:52:37 +0100 | [diff] [blame] | 760 | 1/0 # MARKER |
| 761 | |
| 762 | |
Richard Oudkerk | 29471de | 2012-06-06 19:04:57 +0100 | [diff] [blame] | 763 | @classmethod |
| 764 | def _test_sys_exit(cls, reason, testfn): |
Victor Stinner | a6d865c | 2016-03-25 09:29:50 +0100 | [diff] [blame] | 765 | fd = os.open(testfn, os.O_WRONLY | os.O_CREAT | os.O_EXCL) |
| 766 | sys.stderr = open(fd, 'w', closefd=False) |
Richard Oudkerk | 29471de | 2012-06-06 19:04:57 +0100 | [diff] [blame] | 767 | sys.exit(reason) |
| 768 | |
| 769 | def test_sys_exit(self): |
| 770 | # See Issue 13854 |
| 771 | if self.TYPE == 'threads': |
Zachary Ware | 9fe6d86 | 2013-12-08 00:20:35 -0600 | [diff] [blame] | 772 | self.skipTest('test not appropriate for {}'.format(self.TYPE)) |
Richard Oudkerk | 29471de | 2012-06-06 19:04:57 +0100 | [diff] [blame] | 773 | |
| 774 | testfn = test.support.TESTFN |
| 775 | self.addCleanup(test.support.unlink, testfn) |
| 776 | |
Victor Stinner | a6d865c | 2016-03-25 09:29:50 +0100 | [diff] [blame] | 777 | for reason in ( |
| 778 | [1, 2, 3], |
| 779 | 'ignore this', |
| 780 | ): |
Richard Oudkerk | 29471de | 2012-06-06 19:04:57 +0100 | [diff] [blame] | 781 | p = self.Process(target=self._test_sys_exit, args=(reason, testfn)) |
| 782 | p.daemon = True |
| 783 | p.start() |
Victor Stinner | 11f0807 | 2017-09-15 06:55:31 -0700 | [diff] [blame] | 784 | join_process(p) |
Victor Stinner | a6d865c | 2016-03-25 09:29:50 +0100 | [diff] [blame] | 785 | self.assertEqual(p.exitcode, 1) |
Richard Oudkerk | 29471de | 2012-06-06 19:04:57 +0100 | [diff] [blame] | 786 | |
| 787 | with open(testfn, 'r') as f: |
Victor Stinner | a6d865c | 2016-03-25 09:29:50 +0100 | [diff] [blame] | 788 | content = f.read() |
| 789 | self.assertEqual(content.rstrip(), str(reason)) |
| 790 | |
| 791 | os.unlink(testfn) |
Richard Oudkerk | 29471de | 2012-06-06 19:04:57 +0100 | [diff] [blame] | 792 | |
| 793 | for reason in (True, False, 8): |
| 794 | p = self.Process(target=sys.exit, args=(reason,)) |
| 795 | p.daemon = True |
| 796 | p.start() |
Victor Stinner | 11f0807 | 2017-09-15 06:55:31 -0700 | [diff] [blame] | 797 | join_process(p) |
Richard Oudkerk | 29471de | 2012-06-06 19:04:57 +0100 | [diff] [blame] | 798 | self.assertEqual(p.exitcode, reason) |
| 799 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 800 | # |
| 801 | # |
| 802 | # |
| 803 | |
| 804 | def queue_empty(q): |
| 805 | if hasattr(q, 'empty'): |
| 806 | return q.empty() |
| 807 | else: |
| 808 | return q.qsize() == 0 |
| 809 | |
| 810 | def queue_full(q, maxsize): |
| 811 | if hasattr(q, 'full'): |
| 812 | return q.full() |
| 813 | else: |
| 814 | return q.qsize() == maxsize |
| 815 | |
| 816 | |
| 817 | class _TestQueue(BaseTestCase): |
| 818 | |
| 819 | |
Antoine Pitrou | 0d1b38c | 2010-11-02 23:50:11 +0000 | [diff] [blame] | 820 | @classmethod |
| 821 | def _test_put(cls, queue, child_can_start, parent_can_continue): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 822 | child_can_start.wait() |
| 823 | for i in range(6): |
| 824 | queue.get() |
| 825 | parent_can_continue.set() |
| 826 | |
| 827 | def test_put(self): |
| 828 | MAXSIZE = 6 |
| 829 | queue = self.Queue(maxsize=MAXSIZE) |
| 830 | child_can_start = self.Event() |
| 831 | parent_can_continue = self.Event() |
| 832 | |
| 833 | proc = self.Process( |
| 834 | target=self._test_put, |
| 835 | args=(queue, child_can_start, parent_can_continue) |
| 836 | ) |
Benjamin Peterson | 58ea9fe | 2008-08-19 19:17:39 +0000 | [diff] [blame] | 837 | proc.daemon = True |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 838 | proc.start() |
| 839 | |
| 840 | self.assertEqual(queue_empty(queue), True) |
| 841 | self.assertEqual(queue_full(queue, MAXSIZE), False) |
| 842 | |
| 843 | queue.put(1) |
| 844 | queue.put(2, True) |
| 845 | queue.put(3, True, None) |
| 846 | queue.put(4, False) |
| 847 | queue.put(5, False, None) |
| 848 | queue.put_nowait(6) |
| 849 | |
| 850 | # the values may be in buffer but not yet in pipe so sleep a bit |
| 851 | time.sleep(DELTA) |
| 852 | |
| 853 | self.assertEqual(queue_empty(queue), False) |
| 854 | self.assertEqual(queue_full(queue, MAXSIZE), True) |
| 855 | |
| 856 | put = TimingWrapper(queue.put) |
| 857 | put_nowait = TimingWrapper(queue.put_nowait) |
| 858 | |
| 859 | self.assertRaises(pyqueue.Full, put, 7, False) |
| 860 | self.assertTimingAlmostEqual(put.elapsed, 0) |
| 861 | |
| 862 | self.assertRaises(pyqueue.Full, put, 7, False, None) |
| 863 | self.assertTimingAlmostEqual(put.elapsed, 0) |
| 864 | |
| 865 | self.assertRaises(pyqueue.Full, put_nowait, 7) |
| 866 | self.assertTimingAlmostEqual(put_nowait.elapsed, 0) |
| 867 | |
| 868 | self.assertRaises(pyqueue.Full, put, 7, True, TIMEOUT1) |
| 869 | self.assertTimingAlmostEqual(put.elapsed, TIMEOUT1) |
| 870 | |
| 871 | self.assertRaises(pyqueue.Full, put, 7, False, TIMEOUT2) |
| 872 | self.assertTimingAlmostEqual(put.elapsed, 0) |
| 873 | |
| 874 | self.assertRaises(pyqueue.Full, put, 7, True, timeout=TIMEOUT3) |
| 875 | self.assertTimingAlmostEqual(put.elapsed, TIMEOUT3) |
| 876 | |
| 877 | child_can_start.set() |
| 878 | parent_can_continue.wait() |
| 879 | |
| 880 | self.assertEqual(queue_empty(queue), True) |
| 881 | self.assertEqual(queue_full(queue, MAXSIZE), False) |
| 882 | |
| 883 | proc.join() |
Victor Stinner | b4c5296 | 2017-07-25 02:40:55 +0200 | [diff] [blame] | 884 | close_queue(queue) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 885 | |
Antoine Pitrou | 0d1b38c | 2010-11-02 23:50:11 +0000 | [diff] [blame] | 886 | @classmethod |
| 887 | def _test_get(cls, queue, child_can_start, parent_can_continue): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 888 | child_can_start.wait() |
Benjamin Peterson | b29cbbc | 2008-06-16 20:57:14 +0000 | [diff] [blame] | 889 | #queue.put(1) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 890 | queue.put(2) |
| 891 | queue.put(3) |
| 892 | queue.put(4) |
| 893 | queue.put(5) |
| 894 | parent_can_continue.set() |
| 895 | |
| 896 | def test_get(self): |
| 897 | queue = self.Queue() |
| 898 | child_can_start = self.Event() |
| 899 | parent_can_continue = self.Event() |
| 900 | |
| 901 | proc = self.Process( |
| 902 | target=self._test_get, |
| 903 | args=(queue, child_can_start, parent_can_continue) |
| 904 | ) |
Benjamin Peterson | 58ea9fe | 2008-08-19 19:17:39 +0000 | [diff] [blame] | 905 | proc.daemon = True |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 906 | proc.start() |
| 907 | |
| 908 | self.assertEqual(queue_empty(queue), True) |
| 909 | |
| 910 | child_can_start.set() |
| 911 | parent_can_continue.wait() |
| 912 | |
| 913 | time.sleep(DELTA) |
| 914 | self.assertEqual(queue_empty(queue), False) |
| 915 | |
Benjamin Peterson | b29cbbc | 2008-06-16 20:57:14 +0000 | [diff] [blame] | 916 | # Hangs unexpectedly, remove for now |
| 917 | #self.assertEqual(queue.get(), 1) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 918 | self.assertEqual(queue.get(True, None), 2) |
| 919 | self.assertEqual(queue.get(True), 3) |
| 920 | self.assertEqual(queue.get(timeout=1), 4) |
| 921 | self.assertEqual(queue.get_nowait(), 5) |
| 922 | |
| 923 | self.assertEqual(queue_empty(queue), True) |
| 924 | |
| 925 | get = TimingWrapper(queue.get) |
| 926 | get_nowait = TimingWrapper(queue.get_nowait) |
| 927 | |
| 928 | self.assertRaises(pyqueue.Empty, get, False) |
| 929 | self.assertTimingAlmostEqual(get.elapsed, 0) |
| 930 | |
| 931 | self.assertRaises(pyqueue.Empty, get, False, None) |
| 932 | self.assertTimingAlmostEqual(get.elapsed, 0) |
| 933 | |
| 934 | self.assertRaises(pyqueue.Empty, get_nowait) |
| 935 | self.assertTimingAlmostEqual(get_nowait.elapsed, 0) |
| 936 | |
| 937 | self.assertRaises(pyqueue.Empty, get, True, TIMEOUT1) |
| 938 | self.assertTimingAlmostEqual(get.elapsed, TIMEOUT1) |
| 939 | |
| 940 | self.assertRaises(pyqueue.Empty, get, False, TIMEOUT2) |
| 941 | self.assertTimingAlmostEqual(get.elapsed, 0) |
| 942 | |
| 943 | self.assertRaises(pyqueue.Empty, get, timeout=TIMEOUT3) |
| 944 | self.assertTimingAlmostEqual(get.elapsed, TIMEOUT3) |
| 945 | |
| 946 | proc.join() |
Victor Stinner | b4c5296 | 2017-07-25 02:40:55 +0200 | [diff] [blame] | 947 | close_queue(queue) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 948 | |
Antoine Pitrou | 0d1b38c | 2010-11-02 23:50:11 +0000 | [diff] [blame] | 949 | @classmethod |
| 950 | def _test_fork(cls, queue): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 951 | for i in range(10, 20): |
| 952 | queue.put(i) |
| 953 | # note that at this point the items may only be buffered, so the |
| 954 | # process cannot shutdown until the feeder thread has finished |
| 955 | # pushing items onto the pipe. |
| 956 | |
| 957 | def test_fork(self): |
| 958 | # Old versions of Queue would fail to create a new feeder |
| 959 | # thread for a forked process if the original process had its |
| 960 | # own feeder thread. This test checks that this no longer |
| 961 | # happens. |
| 962 | |
| 963 | queue = self.Queue() |
| 964 | |
| 965 | # put items on queue so that main process starts a feeder thread |
| 966 | for i in range(10): |
| 967 | queue.put(i) |
| 968 | |
| 969 | # wait to make sure thread starts before we fork a new process |
| 970 | time.sleep(DELTA) |
| 971 | |
| 972 | # fork process |
| 973 | p = self.Process(target=self._test_fork, args=(queue,)) |
Jesus Cea | 94f964f | 2011-09-09 20:26:57 +0200 | [diff] [blame] | 974 | p.daemon = True |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 975 | p.start() |
| 976 | |
| 977 | # check that all expected items are in the queue |
| 978 | for i in range(20): |
| 979 | self.assertEqual(queue.get(), i) |
| 980 | self.assertRaises(pyqueue.Empty, queue.get, False) |
| 981 | |
| 982 | p.join() |
Victor Stinner | b4c5296 | 2017-07-25 02:40:55 +0200 | [diff] [blame] | 983 | close_queue(queue) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 984 | |
| 985 | def test_qsize(self): |
| 986 | q = self.Queue() |
| 987 | try: |
| 988 | self.assertEqual(q.qsize(), 0) |
| 989 | except NotImplementedError: |
Zachary Ware | 9fe6d86 | 2013-12-08 00:20:35 -0600 | [diff] [blame] | 990 | self.skipTest('qsize method not implemented') |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 991 | q.put(1) |
| 992 | self.assertEqual(q.qsize(), 1) |
| 993 | q.put(5) |
| 994 | self.assertEqual(q.qsize(), 2) |
| 995 | q.get() |
| 996 | self.assertEqual(q.qsize(), 1) |
| 997 | q.get() |
| 998 | self.assertEqual(q.qsize(), 0) |
Victor Stinner | d7e64d9 | 2017-07-25 00:33:56 +0200 | [diff] [blame] | 999 | close_queue(q) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1000 | |
Antoine Pitrou | 0d1b38c | 2010-11-02 23:50:11 +0000 | [diff] [blame] | 1001 | @classmethod |
| 1002 | def _test_task_done(cls, q): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1003 | for obj in iter(q.get, None): |
| 1004 | time.sleep(DELTA) |
| 1005 | q.task_done() |
| 1006 | |
| 1007 | def test_task_done(self): |
| 1008 | queue = self.JoinableQueue() |
| 1009 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1010 | workers = [self.Process(target=self._test_task_done, args=(queue,)) |
| 1011 | for i in range(4)] |
| 1012 | |
| 1013 | for p in workers: |
Jesus Cea | 94f964f | 2011-09-09 20:26:57 +0200 | [diff] [blame] | 1014 | p.daemon = True |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1015 | p.start() |
| 1016 | |
| 1017 | for i in range(10): |
| 1018 | queue.put(i) |
| 1019 | |
| 1020 | queue.join() |
| 1021 | |
| 1022 | for p in workers: |
| 1023 | queue.put(None) |
| 1024 | |
| 1025 | for p in workers: |
| 1026 | p.join() |
Victor Stinner | b4c5296 | 2017-07-25 02:40:55 +0200 | [diff] [blame] | 1027 | close_queue(queue) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1028 | |
Serhiy Storchaka | f8904e9 | 2015-03-06 23:32:54 +0200 | [diff] [blame] | 1029 | def test_no_import_lock_contention(self): |
| 1030 | with test.support.temp_cwd(): |
| 1031 | module_name = 'imported_by_an_imported_module' |
| 1032 | with open(module_name + '.py', 'w') as f: |
| 1033 | f.write("""if 1: |
| 1034 | import multiprocessing |
| 1035 | |
| 1036 | q = multiprocessing.Queue() |
| 1037 | q.put('knock knock') |
| 1038 | q.get(timeout=3) |
| 1039 | q.close() |
| 1040 | del q |
| 1041 | """) |
| 1042 | |
| 1043 | with test.support.DirsOnSysPath(os.getcwd()): |
| 1044 | try: |
| 1045 | __import__(module_name) |
| 1046 | except pyqueue.Empty: |
| 1047 | self.fail("Probable regression on import lock contention;" |
| 1048 | " see Issue #22853") |
| 1049 | |
Giampaolo Rodola' | 3083071 | 2013-04-17 13:12:27 +0200 | [diff] [blame] | 1050 | def test_timeout(self): |
| 1051 | q = multiprocessing.Queue() |
Victor Stinner | 2cf4c20 | 2018-12-17 09:36:36 +0100 | [diff] [blame] | 1052 | start = time.monotonic() |
Victor Stinner | aad7b2e | 2015-02-05 14:25:05 +0100 | [diff] [blame] | 1053 | self.assertRaises(pyqueue.Empty, q.get, True, 0.200) |
Victor Stinner | 2cf4c20 | 2018-12-17 09:36:36 +0100 | [diff] [blame] | 1054 | delta = time.monotonic() - start |
Victor Stinner | 5640d03 | 2018-08-03 02:09:00 +0200 | [diff] [blame] | 1055 | # bpo-30317: Tolerate a delta of 100 ms because of the bad clock |
| 1056 | # resolution on Windows (usually 15.6 ms). x86 Windows7 3.x once |
| 1057 | # failed because the delta was only 135.8 ms. |
| 1058 | self.assertGreaterEqual(delta, 0.100) |
Victor Stinner | b4c5296 | 2017-07-25 02:40:55 +0200 | [diff] [blame] | 1059 | close_queue(q) |
Giampaolo Rodola' | 3083071 | 2013-04-17 13:12:27 +0200 | [diff] [blame] | 1060 | |
grzgrzgrz3 | bc50f03 | 2017-05-25 16:22:57 +0200 | [diff] [blame] | 1061 | def test_queue_feeder_donot_stop_onexc(self): |
| 1062 | # bpo-30414: verify feeder handles exceptions correctly |
| 1063 | if self.TYPE != 'processes': |
| 1064 | self.skipTest('test not appropriate for {}'.format(self.TYPE)) |
| 1065 | |
| 1066 | class NotSerializable(object): |
| 1067 | def __reduce__(self): |
| 1068 | raise AttributeError |
| 1069 | with test.support.captured_stderr(): |
| 1070 | q = self.Queue() |
| 1071 | q.put(NotSerializable()) |
| 1072 | q.put(True) |
Victor Stinner | 8f6eeaf | 2017-06-13 23:48:47 +0200 | [diff] [blame] | 1073 | # bpo-30595: use a timeout of 1 second for slow buildbots |
| 1074 | self.assertTrue(q.get(timeout=1.0)) |
Victor Stinner | d7e64d9 | 2017-07-25 00:33:56 +0200 | [diff] [blame] | 1075 | close_queue(q) |
grzgrzgrz3 | bc50f03 | 2017-05-25 16:22:57 +0200 | [diff] [blame] | 1076 | |
Thomas Moreau | e2f33ad | 2018-03-21 16:50:28 +0100 | [diff] [blame] | 1077 | with test.support.captured_stderr(): |
| 1078 | # bpo-33078: verify that the queue size is correctly handled |
| 1079 | # on errors. |
| 1080 | q = self.Queue(maxsize=1) |
| 1081 | q.put(NotSerializable()) |
| 1082 | q.put(True) |
Thomas Moreau | dec1c77 | 2018-03-21 18:56:27 +0100 | [diff] [blame] | 1083 | try: |
| 1084 | self.assertEqual(q.qsize(), 1) |
| 1085 | except NotImplementedError: |
| 1086 | # qsize is not available on all platform as it |
| 1087 | # relies on sem_getvalue |
| 1088 | pass |
Thomas Moreau | e2f33ad | 2018-03-21 16:50:28 +0100 | [diff] [blame] | 1089 | # bpo-30595: use a timeout of 1 second for slow buildbots |
| 1090 | self.assertTrue(q.get(timeout=1.0)) |
| 1091 | # Check that the size of the queue is correct |
Thomas Moreau | dec1c77 | 2018-03-21 18:56:27 +0100 | [diff] [blame] | 1092 | self.assertTrue(q.empty()) |
Thomas Moreau | e2f33ad | 2018-03-21 16:50:28 +0100 | [diff] [blame] | 1093 | close_queue(q) |
| 1094 | |
Thomas Moreau | 94459fd | 2018-01-05 11:15:54 +0100 | [diff] [blame] | 1095 | def test_queue_feeder_on_queue_feeder_error(self): |
| 1096 | # bpo-30006: verify feeder handles exceptions using the |
| 1097 | # _on_queue_feeder_error hook. |
| 1098 | if self.TYPE != 'processes': |
| 1099 | self.skipTest('test not appropriate for {}'.format(self.TYPE)) |
| 1100 | |
| 1101 | class NotSerializable(object): |
| 1102 | """Mock unserializable object""" |
| 1103 | def __init__(self): |
| 1104 | self.reduce_was_called = False |
| 1105 | self.on_queue_feeder_error_was_called = False |
| 1106 | |
| 1107 | def __reduce__(self): |
| 1108 | self.reduce_was_called = True |
| 1109 | raise AttributeError |
| 1110 | |
| 1111 | class SafeQueue(multiprocessing.queues.Queue): |
| 1112 | """Queue with overloaded _on_queue_feeder_error hook""" |
| 1113 | @staticmethod |
| 1114 | def _on_queue_feeder_error(e, obj): |
| 1115 | if (isinstance(e, AttributeError) and |
| 1116 | isinstance(obj, NotSerializable)): |
| 1117 | obj.on_queue_feeder_error_was_called = True |
| 1118 | |
| 1119 | not_serializable_obj = NotSerializable() |
| 1120 | # The captured_stderr reduces the noise in the test report |
| 1121 | with test.support.captured_stderr(): |
| 1122 | q = SafeQueue(ctx=multiprocessing.get_context()) |
| 1123 | q.put(not_serializable_obj) |
| 1124 | |
Ville Skyttä | 61f82e0 | 2018-04-20 23:08:45 +0300 | [diff] [blame] | 1125 | # Verify that q is still functioning correctly |
Thomas Moreau | 94459fd | 2018-01-05 11:15:54 +0100 | [diff] [blame] | 1126 | q.put(True) |
| 1127 | self.assertTrue(q.get(timeout=1.0)) |
| 1128 | |
| 1129 | # Assert that the serialization and the hook have been called correctly |
| 1130 | self.assertTrue(not_serializable_obj.reduce_was_called) |
| 1131 | self.assertTrue(not_serializable_obj.on_queue_feeder_error_was_called) |
Zackery Spytz | 0461704 | 2018-10-13 03:26:09 -0600 | [diff] [blame] | 1132 | |
| 1133 | def test_closed_queue_put_get_exceptions(self): |
| 1134 | for q in multiprocessing.Queue(), multiprocessing.JoinableQueue(): |
| 1135 | q.close() |
| 1136 | with self.assertRaisesRegex(ValueError, 'is closed'): |
| 1137 | q.put('foo') |
| 1138 | with self.assertRaisesRegex(ValueError, 'is closed'): |
| 1139 | q.get() |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1140 | # |
| 1141 | # |
| 1142 | # |
| 1143 | |
| 1144 | class _TestLock(BaseTestCase): |
| 1145 | |
| 1146 | def test_lock(self): |
| 1147 | lock = self.Lock() |
| 1148 | self.assertEqual(lock.acquire(), True) |
| 1149 | self.assertEqual(lock.acquire(False), False) |
| 1150 | self.assertEqual(lock.release(), None) |
| 1151 | self.assertRaises((ValueError, threading.ThreadError), lock.release) |
| 1152 | |
| 1153 | def test_rlock(self): |
| 1154 | lock = self.RLock() |
| 1155 | self.assertEqual(lock.acquire(), True) |
| 1156 | self.assertEqual(lock.acquire(), True) |
| 1157 | self.assertEqual(lock.acquire(), True) |
| 1158 | self.assertEqual(lock.release(), None) |
| 1159 | self.assertEqual(lock.release(), None) |
| 1160 | self.assertEqual(lock.release(), None) |
| 1161 | self.assertRaises((AssertionError, RuntimeError), lock.release) |
| 1162 | |
Jesse Noller | f8d0085 | 2009-03-31 03:25:07 +0000 | [diff] [blame] | 1163 | def test_lock_context(self): |
| 1164 | with self.Lock(): |
| 1165 | pass |
| 1166 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1167 | |
| 1168 | class _TestSemaphore(BaseTestCase): |
| 1169 | |
| 1170 | def _test_semaphore(self, sem): |
| 1171 | self.assertReturnsIfImplemented(2, get_value, sem) |
| 1172 | self.assertEqual(sem.acquire(), True) |
| 1173 | self.assertReturnsIfImplemented(1, get_value, sem) |
| 1174 | self.assertEqual(sem.acquire(), True) |
| 1175 | self.assertReturnsIfImplemented(0, get_value, sem) |
| 1176 | self.assertEqual(sem.acquire(False), False) |
| 1177 | self.assertReturnsIfImplemented(0, get_value, sem) |
| 1178 | self.assertEqual(sem.release(), None) |
| 1179 | self.assertReturnsIfImplemented(1, get_value, sem) |
| 1180 | self.assertEqual(sem.release(), None) |
| 1181 | self.assertReturnsIfImplemented(2, get_value, sem) |
| 1182 | |
| 1183 | def test_semaphore(self): |
| 1184 | sem = self.Semaphore(2) |
| 1185 | self._test_semaphore(sem) |
| 1186 | self.assertEqual(sem.release(), None) |
| 1187 | self.assertReturnsIfImplemented(3, get_value, sem) |
| 1188 | self.assertEqual(sem.release(), None) |
| 1189 | self.assertReturnsIfImplemented(4, get_value, sem) |
| 1190 | |
| 1191 | def test_bounded_semaphore(self): |
| 1192 | sem = self.BoundedSemaphore(2) |
| 1193 | self._test_semaphore(sem) |
| 1194 | # Currently fails on OS/X |
| 1195 | #if HAVE_GETVALUE: |
| 1196 | # self.assertRaises(ValueError, sem.release) |
| 1197 | # self.assertReturnsIfImplemented(2, get_value, sem) |
| 1198 | |
| 1199 | def test_timeout(self): |
| 1200 | if self.TYPE != 'processes': |
Zachary Ware | 9fe6d86 | 2013-12-08 00:20:35 -0600 | [diff] [blame] | 1201 | self.skipTest('test not appropriate for {}'.format(self.TYPE)) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1202 | |
| 1203 | sem = self.Semaphore(0) |
| 1204 | acquire = TimingWrapper(sem.acquire) |
| 1205 | |
| 1206 | self.assertEqual(acquire(False), False) |
| 1207 | self.assertTimingAlmostEqual(acquire.elapsed, 0.0) |
| 1208 | |
| 1209 | self.assertEqual(acquire(False, None), False) |
| 1210 | self.assertTimingAlmostEqual(acquire.elapsed, 0.0) |
| 1211 | |
| 1212 | self.assertEqual(acquire(False, TIMEOUT1), False) |
| 1213 | self.assertTimingAlmostEqual(acquire.elapsed, 0) |
| 1214 | |
| 1215 | self.assertEqual(acquire(True, TIMEOUT2), False) |
| 1216 | self.assertTimingAlmostEqual(acquire.elapsed, TIMEOUT2) |
| 1217 | |
| 1218 | self.assertEqual(acquire(timeout=TIMEOUT3), False) |
| 1219 | self.assertTimingAlmostEqual(acquire.elapsed, TIMEOUT3) |
| 1220 | |
| 1221 | |
| 1222 | class _TestCondition(BaseTestCase): |
| 1223 | |
Antoine Pitrou | 0d1b38c | 2010-11-02 23:50:11 +0000 | [diff] [blame] | 1224 | @classmethod |
| 1225 | def f(cls, cond, sleeping, woken, timeout=None): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1226 | cond.acquire() |
| 1227 | sleeping.release() |
| 1228 | cond.wait(timeout) |
| 1229 | woken.release() |
| 1230 | cond.release() |
| 1231 | |
Antoine Pitrou | 4835041 | 2017-07-04 08:59:22 +0200 | [diff] [blame] | 1232 | def assertReachesEventually(self, func, value): |
| 1233 | for i in range(10): |
| 1234 | try: |
| 1235 | if func() == value: |
| 1236 | break |
| 1237 | except NotImplementedError: |
| 1238 | break |
| 1239 | time.sleep(DELTA) |
| 1240 | time.sleep(DELTA) |
| 1241 | self.assertReturnsIfImplemented(value, func) |
| 1242 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1243 | def check_invariant(self, cond): |
| 1244 | # this is only supposed to succeed when there are no sleepers |
| 1245 | if self.TYPE == 'processes': |
| 1246 | try: |
| 1247 | sleepers = (cond._sleeping_count.get_value() - |
| 1248 | cond._woken_count.get_value()) |
| 1249 | self.assertEqual(sleepers, 0) |
| 1250 | self.assertEqual(cond._wait_semaphore.get_value(), 0) |
| 1251 | except NotImplementedError: |
| 1252 | pass |
| 1253 | |
| 1254 | def test_notify(self): |
| 1255 | cond = self.Condition() |
| 1256 | sleeping = self.Semaphore(0) |
| 1257 | woken = self.Semaphore(0) |
| 1258 | |
| 1259 | p = self.Process(target=self.f, args=(cond, sleeping, woken)) |
Benjamin Peterson | 58ea9fe | 2008-08-19 19:17:39 +0000 | [diff] [blame] | 1260 | p.daemon = True |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1261 | p.start() |
Victor Stinner | d7e64d9 | 2017-07-25 00:33:56 +0200 | [diff] [blame] | 1262 | self.addCleanup(p.join) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1263 | |
| 1264 | p = threading.Thread(target=self.f, args=(cond, sleeping, woken)) |
Benjamin Peterson | 58ea9fe | 2008-08-19 19:17:39 +0000 | [diff] [blame] | 1265 | p.daemon = True |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1266 | p.start() |
Victor Stinner | d7e64d9 | 2017-07-25 00:33:56 +0200 | [diff] [blame] | 1267 | self.addCleanup(p.join) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1268 | |
| 1269 | # wait for both children to start sleeping |
| 1270 | sleeping.acquire() |
| 1271 | sleeping.acquire() |
| 1272 | |
| 1273 | # check no process/thread has woken up |
| 1274 | time.sleep(DELTA) |
| 1275 | self.assertReturnsIfImplemented(0, get_value, woken) |
| 1276 | |
| 1277 | # wake up one process/thread |
| 1278 | cond.acquire() |
| 1279 | cond.notify() |
| 1280 | cond.release() |
| 1281 | |
| 1282 | # check one process/thread has woken up |
| 1283 | time.sleep(DELTA) |
| 1284 | self.assertReturnsIfImplemented(1, get_value, woken) |
| 1285 | |
| 1286 | # wake up another |
| 1287 | cond.acquire() |
| 1288 | cond.notify() |
| 1289 | cond.release() |
| 1290 | |
| 1291 | # check other has woken up |
| 1292 | time.sleep(DELTA) |
| 1293 | self.assertReturnsIfImplemented(2, get_value, woken) |
| 1294 | |
| 1295 | # check state is not mucked up |
| 1296 | self.check_invariant(cond) |
| 1297 | p.join() |
| 1298 | |
| 1299 | def test_notify_all(self): |
| 1300 | cond = self.Condition() |
| 1301 | sleeping = self.Semaphore(0) |
| 1302 | woken = self.Semaphore(0) |
| 1303 | |
| 1304 | # start some threads/processes which will timeout |
| 1305 | for i in range(3): |
| 1306 | p = self.Process(target=self.f, |
| 1307 | args=(cond, sleeping, woken, TIMEOUT1)) |
Benjamin Peterson | 58ea9fe | 2008-08-19 19:17:39 +0000 | [diff] [blame] | 1308 | p.daemon = True |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1309 | p.start() |
Victor Stinner | d7e64d9 | 2017-07-25 00:33:56 +0200 | [diff] [blame] | 1310 | self.addCleanup(p.join) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1311 | |
| 1312 | t = threading.Thread(target=self.f, |
| 1313 | args=(cond, sleeping, woken, TIMEOUT1)) |
Benjamin Peterson | 7275370 | 2008-08-18 18:09:21 +0000 | [diff] [blame] | 1314 | t.daemon = True |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1315 | t.start() |
Victor Stinner | d7e64d9 | 2017-07-25 00:33:56 +0200 | [diff] [blame] | 1316 | self.addCleanup(t.join) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1317 | |
| 1318 | # wait for them all to sleep |
| 1319 | for i in range(6): |
| 1320 | sleeping.acquire() |
| 1321 | |
| 1322 | # check they have all timed out |
| 1323 | for i in range(6): |
| 1324 | woken.acquire() |
| 1325 | self.assertReturnsIfImplemented(0, get_value, woken) |
| 1326 | |
| 1327 | # check state is not mucked up |
| 1328 | self.check_invariant(cond) |
| 1329 | |
| 1330 | # start some more threads/processes |
| 1331 | for i in range(3): |
| 1332 | p = self.Process(target=self.f, args=(cond, sleeping, woken)) |
Benjamin Peterson | 58ea9fe | 2008-08-19 19:17:39 +0000 | [diff] [blame] | 1333 | p.daemon = True |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1334 | p.start() |
Victor Stinner | d7e64d9 | 2017-07-25 00:33:56 +0200 | [diff] [blame] | 1335 | self.addCleanup(p.join) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1336 | |
| 1337 | t = threading.Thread(target=self.f, args=(cond, sleeping, woken)) |
Benjamin Peterson | 7275370 | 2008-08-18 18:09:21 +0000 | [diff] [blame] | 1338 | t.daemon = True |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1339 | t.start() |
Victor Stinner | d7e64d9 | 2017-07-25 00:33:56 +0200 | [diff] [blame] | 1340 | self.addCleanup(t.join) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1341 | |
| 1342 | # wait for them to all sleep |
| 1343 | for i in range(6): |
| 1344 | sleeping.acquire() |
| 1345 | |
| 1346 | # check no process/thread has woken up |
| 1347 | time.sleep(DELTA) |
| 1348 | self.assertReturnsIfImplemented(0, get_value, woken) |
| 1349 | |
| 1350 | # wake them all up |
| 1351 | cond.acquire() |
| 1352 | cond.notify_all() |
| 1353 | cond.release() |
| 1354 | |
| 1355 | # check they have all woken |
Antoine Pitrou | 4835041 | 2017-07-04 08:59:22 +0200 | [diff] [blame] | 1356 | self.assertReachesEventually(lambda: get_value(woken), 6) |
| 1357 | |
| 1358 | # check state is not mucked up |
| 1359 | self.check_invariant(cond) |
| 1360 | |
| 1361 | def test_notify_n(self): |
| 1362 | cond = self.Condition() |
| 1363 | sleeping = self.Semaphore(0) |
| 1364 | woken = self.Semaphore(0) |
| 1365 | |
| 1366 | # start some threads/processes |
| 1367 | for i in range(3): |
| 1368 | p = self.Process(target=self.f, args=(cond, sleeping, woken)) |
| 1369 | p.daemon = True |
| 1370 | p.start() |
Victor Stinner | d7e64d9 | 2017-07-25 00:33:56 +0200 | [diff] [blame] | 1371 | self.addCleanup(p.join) |
Antoine Pitrou | 4835041 | 2017-07-04 08:59:22 +0200 | [diff] [blame] | 1372 | |
| 1373 | t = threading.Thread(target=self.f, args=(cond, sleeping, woken)) |
| 1374 | t.daemon = True |
| 1375 | t.start() |
Victor Stinner | d7e64d9 | 2017-07-25 00:33:56 +0200 | [diff] [blame] | 1376 | self.addCleanup(t.join) |
Antoine Pitrou | 4835041 | 2017-07-04 08:59:22 +0200 | [diff] [blame] | 1377 | |
| 1378 | # wait for them to all sleep |
| 1379 | for i in range(6): |
| 1380 | sleeping.acquire() |
| 1381 | |
| 1382 | # check no process/thread has woken up |
| 1383 | time.sleep(DELTA) |
| 1384 | self.assertReturnsIfImplemented(0, get_value, woken) |
| 1385 | |
| 1386 | # wake some of them up |
| 1387 | cond.acquire() |
| 1388 | cond.notify(n=2) |
| 1389 | cond.release() |
| 1390 | |
| 1391 | # check 2 have woken |
| 1392 | self.assertReachesEventually(lambda: get_value(woken), 2) |
| 1393 | |
| 1394 | # wake the rest of them |
| 1395 | cond.acquire() |
| 1396 | cond.notify(n=4) |
| 1397 | cond.release() |
| 1398 | |
| 1399 | self.assertReachesEventually(lambda: get_value(woken), 6) |
| 1400 | |
| 1401 | # doesn't do anything more |
| 1402 | cond.acquire() |
| 1403 | cond.notify(n=3) |
| 1404 | cond.release() |
| 1405 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1406 | self.assertReturnsIfImplemented(6, get_value, woken) |
| 1407 | |
| 1408 | # check state is not mucked up |
| 1409 | self.check_invariant(cond) |
| 1410 | |
| 1411 | def test_timeout(self): |
| 1412 | cond = self.Condition() |
| 1413 | wait = TimingWrapper(cond.wait) |
| 1414 | cond.acquire() |
| 1415 | res = wait(TIMEOUT1) |
| 1416 | cond.release() |
Georg Brandl | 65ffae0 | 2010-10-28 09:24:56 +0000 | [diff] [blame] | 1417 | self.assertEqual(res, False) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1418 | self.assertTimingAlmostEqual(wait.elapsed, TIMEOUT1) |
| 1419 | |
Charles-François Natali | c8ce715 | 2012-04-17 18:45:57 +0200 | [diff] [blame] | 1420 | @classmethod |
| 1421 | def _test_waitfor_f(cls, cond, state): |
| 1422 | with cond: |
| 1423 | state.value = 0 |
| 1424 | cond.notify() |
| 1425 | result = cond.wait_for(lambda : state.value==4) |
| 1426 | if not result or state.value != 4: |
| 1427 | sys.exit(1) |
| 1428 | |
| 1429 | @unittest.skipUnless(HAS_SHAREDCTYPES, 'needs sharedctypes') |
| 1430 | def test_waitfor(self): |
| 1431 | # based on test in test/lock_tests.py |
| 1432 | cond = self.Condition() |
| 1433 | state = self.Value('i', -1) |
| 1434 | |
| 1435 | p = self.Process(target=self._test_waitfor_f, args=(cond, state)) |
| 1436 | p.daemon = True |
| 1437 | p.start() |
| 1438 | |
| 1439 | with cond: |
| 1440 | result = cond.wait_for(lambda : state.value==0) |
| 1441 | self.assertTrue(result) |
| 1442 | self.assertEqual(state.value, 0) |
| 1443 | |
| 1444 | for i in range(4): |
| 1445 | time.sleep(0.01) |
| 1446 | with cond: |
| 1447 | state.value += 1 |
| 1448 | cond.notify() |
| 1449 | |
Victor Stinner | 11f0807 | 2017-09-15 06:55:31 -0700 | [diff] [blame] | 1450 | join_process(p) |
Charles-François Natali | c8ce715 | 2012-04-17 18:45:57 +0200 | [diff] [blame] | 1451 | self.assertEqual(p.exitcode, 0) |
| 1452 | |
| 1453 | @classmethod |
Richard Oudkerk | 6dbca36 | 2012-05-06 16:46:36 +0100 | [diff] [blame] | 1454 | def _test_waitfor_timeout_f(cls, cond, state, success, sem): |
| 1455 | sem.release() |
Charles-François Natali | c8ce715 | 2012-04-17 18:45:57 +0200 | [diff] [blame] | 1456 | with cond: |
| 1457 | expected = 0.1 |
Victor Stinner | 2cf4c20 | 2018-12-17 09:36:36 +0100 | [diff] [blame] | 1458 | dt = time.monotonic() |
Charles-François Natali | c8ce715 | 2012-04-17 18:45:57 +0200 | [diff] [blame] | 1459 | result = cond.wait_for(lambda : state.value==4, timeout=expected) |
Victor Stinner | 2cf4c20 | 2018-12-17 09:36:36 +0100 | [diff] [blame] | 1460 | dt = time.monotonic() - dt |
Charles-François Natali | c8ce715 | 2012-04-17 18:45:57 +0200 | [diff] [blame] | 1461 | # borrow logic in assertTimeout() from test/lock_tests.py |
| 1462 | if not result and expected * 0.6 < dt < expected * 10.0: |
| 1463 | success.value = True |
| 1464 | |
| 1465 | @unittest.skipUnless(HAS_SHAREDCTYPES, 'needs sharedctypes') |
| 1466 | def test_waitfor_timeout(self): |
| 1467 | # based on test in test/lock_tests.py |
| 1468 | cond = self.Condition() |
| 1469 | state = self.Value('i', 0) |
| 1470 | success = self.Value('i', False) |
Richard Oudkerk | 6dbca36 | 2012-05-06 16:46:36 +0100 | [diff] [blame] | 1471 | sem = self.Semaphore(0) |
Charles-François Natali | c8ce715 | 2012-04-17 18:45:57 +0200 | [diff] [blame] | 1472 | |
| 1473 | p = self.Process(target=self._test_waitfor_timeout_f, |
Richard Oudkerk | 6dbca36 | 2012-05-06 16:46:36 +0100 | [diff] [blame] | 1474 | args=(cond, state, success, sem)) |
Charles-François Natali | c8ce715 | 2012-04-17 18:45:57 +0200 | [diff] [blame] | 1475 | p.daemon = True |
| 1476 | p.start() |
Victor Stinner | 11f0807 | 2017-09-15 06:55:31 -0700 | [diff] [blame] | 1477 | self.assertTrue(sem.acquire(timeout=TIMEOUT)) |
Charles-François Natali | c8ce715 | 2012-04-17 18:45:57 +0200 | [diff] [blame] | 1478 | |
| 1479 | # Only increment 3 times, so state == 4 is never reached. |
| 1480 | for i in range(3): |
| 1481 | time.sleep(0.01) |
| 1482 | with cond: |
| 1483 | state.value += 1 |
| 1484 | cond.notify() |
| 1485 | |
Victor Stinner | 11f0807 | 2017-09-15 06:55:31 -0700 | [diff] [blame] | 1486 | join_process(p) |
Charles-François Natali | c8ce715 | 2012-04-17 18:45:57 +0200 | [diff] [blame] | 1487 | self.assertTrue(success.value) |
| 1488 | |
Richard Oudkerk | 9844993 | 2012-06-05 13:15:29 +0100 | [diff] [blame] | 1489 | @classmethod |
| 1490 | def _test_wait_result(cls, c, pid): |
| 1491 | with c: |
| 1492 | c.notify() |
| 1493 | time.sleep(1) |
| 1494 | if pid is not None: |
| 1495 | os.kill(pid, signal.SIGINT) |
| 1496 | |
| 1497 | def test_wait_result(self): |
| 1498 | if isinstance(self, ProcessesMixin) and sys.platform != 'win32': |
| 1499 | pid = os.getpid() |
| 1500 | else: |
| 1501 | pid = None |
| 1502 | |
| 1503 | c = self.Condition() |
| 1504 | with c: |
| 1505 | self.assertFalse(c.wait(0)) |
| 1506 | self.assertFalse(c.wait(0.1)) |
| 1507 | |
| 1508 | p = self.Process(target=self._test_wait_result, args=(c, pid)) |
| 1509 | p.start() |
| 1510 | |
Victor Stinner | 4925727 | 2018-06-27 22:24:02 +0200 | [diff] [blame] | 1511 | self.assertTrue(c.wait(60)) |
Richard Oudkerk | 9844993 | 2012-06-05 13:15:29 +0100 | [diff] [blame] | 1512 | if pid is not None: |
Victor Stinner | 4925727 | 2018-06-27 22:24:02 +0200 | [diff] [blame] | 1513 | self.assertRaises(KeyboardInterrupt, c.wait, 60) |
Richard Oudkerk | 9844993 | 2012-06-05 13:15:29 +0100 | [diff] [blame] | 1514 | |
| 1515 | p.join() |
| 1516 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1517 | |
| 1518 | class _TestEvent(BaseTestCase): |
| 1519 | |
Antoine Pitrou | 0d1b38c | 2010-11-02 23:50:11 +0000 | [diff] [blame] | 1520 | @classmethod |
| 1521 | def _test_event(cls, event): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1522 | time.sleep(TIMEOUT2) |
| 1523 | event.set() |
| 1524 | |
| 1525 | def test_event(self): |
| 1526 | event = self.Event() |
| 1527 | wait = TimingWrapper(event.wait) |
| 1528 | |
Ezio Melotti | 1392500 | 2011-03-16 11:05:33 +0200 | [diff] [blame] | 1529 | # Removed temporarily, due to API shear, this does not |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1530 | # work with threading._Event objects. is_set == isSet |
Benjamin Peterson | 965ce87 | 2009-04-05 21:24:58 +0000 | [diff] [blame] | 1531 | self.assertEqual(event.is_set(), False) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1532 | |
Benjamin Peterson | 965ce87 | 2009-04-05 21:24:58 +0000 | [diff] [blame] | 1533 | # Removed, threading.Event.wait() will return the value of the __flag |
| 1534 | # instead of None. API Shear with the semaphore backed mp.Event |
| 1535 | self.assertEqual(wait(0.0), False) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1536 | self.assertTimingAlmostEqual(wait.elapsed, 0.0) |
Benjamin Peterson | 965ce87 | 2009-04-05 21:24:58 +0000 | [diff] [blame] | 1537 | self.assertEqual(wait(TIMEOUT1), False) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1538 | self.assertTimingAlmostEqual(wait.elapsed, TIMEOUT1) |
| 1539 | |
| 1540 | event.set() |
| 1541 | |
| 1542 | # See note above on the API differences |
Benjamin Peterson | 965ce87 | 2009-04-05 21:24:58 +0000 | [diff] [blame] | 1543 | self.assertEqual(event.is_set(), True) |
| 1544 | self.assertEqual(wait(), True) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1545 | self.assertTimingAlmostEqual(wait.elapsed, 0.0) |
Benjamin Peterson | 965ce87 | 2009-04-05 21:24:58 +0000 | [diff] [blame] | 1546 | self.assertEqual(wait(TIMEOUT1), True) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1547 | self.assertTimingAlmostEqual(wait.elapsed, 0.0) |
| 1548 | # self.assertEqual(event.is_set(), True) |
| 1549 | |
| 1550 | event.clear() |
| 1551 | |
| 1552 | #self.assertEqual(event.is_set(), False) |
| 1553 | |
Jesus Cea | 94f964f | 2011-09-09 20:26:57 +0200 | [diff] [blame] | 1554 | p = self.Process(target=self._test_event, args=(event,)) |
| 1555 | p.daemon = True |
| 1556 | p.start() |
Benjamin Peterson | 965ce87 | 2009-04-05 21:24:58 +0000 | [diff] [blame] | 1557 | self.assertEqual(wait(), True) |
Victor Stinner | d7e64d9 | 2017-07-25 00:33:56 +0200 | [diff] [blame] | 1558 | p.join() |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1559 | |
| 1560 | # |
Richard Oudkerk | 3730a17 | 2012-06-15 18:26:07 +0100 | [diff] [blame] | 1561 | # Tests for Barrier - adapted from tests in test/lock_tests.py |
| 1562 | # |
| 1563 | |
| 1564 | # Many of the tests for threading.Barrier use a list as an atomic |
| 1565 | # counter: a value is appended to increment the counter, and the |
| 1566 | # length of the list gives the value. We use the class DummyList |
| 1567 | # for the same purpose. |
| 1568 | |
| 1569 | class _DummyList(object): |
| 1570 | |
| 1571 | def __init__(self): |
| 1572 | wrapper = multiprocessing.heap.BufferWrapper(struct.calcsize('i')) |
| 1573 | lock = multiprocessing.Lock() |
| 1574 | self.__setstate__((wrapper, lock)) |
| 1575 | self._lengthbuf[0] = 0 |
| 1576 | |
| 1577 | def __setstate__(self, state): |
| 1578 | (self._wrapper, self._lock) = state |
| 1579 | self._lengthbuf = self._wrapper.create_memoryview().cast('i') |
| 1580 | |
| 1581 | def __getstate__(self): |
| 1582 | return (self._wrapper, self._lock) |
| 1583 | |
| 1584 | def append(self, _): |
| 1585 | with self._lock: |
| 1586 | self._lengthbuf[0] += 1 |
| 1587 | |
| 1588 | def __len__(self): |
| 1589 | with self._lock: |
| 1590 | return self._lengthbuf[0] |
| 1591 | |
| 1592 | def _wait(): |
| 1593 | # A crude wait/yield function not relying on synchronization primitives. |
| 1594 | time.sleep(0.01) |
| 1595 | |
| 1596 | |
| 1597 | class Bunch(object): |
| 1598 | """ |
| 1599 | A bunch of threads. |
| 1600 | """ |
| 1601 | def __init__(self, namespace, f, args, n, wait_before_exit=False): |
| 1602 | """ |
| 1603 | Construct a bunch of `n` threads running the same function `f`. |
| 1604 | If `wait_before_exit` is True, the threads won't terminate until |
| 1605 | do_finish() is called. |
| 1606 | """ |
| 1607 | self.f = f |
| 1608 | self.args = args |
| 1609 | self.n = n |
| 1610 | self.started = namespace.DummyList() |
| 1611 | self.finished = namespace.DummyList() |
Richard Oudkerk | 0f52346 | 2012-06-15 19:18:30 +0100 | [diff] [blame] | 1612 | self._can_exit = namespace.Event() |
| 1613 | if not wait_before_exit: |
| 1614 | self._can_exit.set() |
Antoine Pitrou | a79f8fa | 2017-06-28 11:21:52 +0200 | [diff] [blame] | 1615 | |
| 1616 | threads = [] |
Richard Oudkerk | 3730a17 | 2012-06-15 18:26:07 +0100 | [diff] [blame] | 1617 | for i in range(n): |
Richard Oudkerk | 0f52346 | 2012-06-15 19:18:30 +0100 | [diff] [blame] | 1618 | p = namespace.Process(target=self.task) |
| 1619 | p.daemon = True |
| 1620 | p.start() |
Antoine Pitrou | a79f8fa | 2017-06-28 11:21:52 +0200 | [diff] [blame] | 1621 | threads.append(p) |
| 1622 | |
| 1623 | def finalize(threads): |
| 1624 | for p in threads: |
| 1625 | p.join() |
| 1626 | |
| 1627 | self._finalizer = weakref.finalize(self, finalize, threads) |
Richard Oudkerk | 3730a17 | 2012-06-15 18:26:07 +0100 | [diff] [blame] | 1628 | |
| 1629 | def task(self): |
| 1630 | pid = os.getpid() |
| 1631 | self.started.append(pid) |
| 1632 | try: |
| 1633 | self.f(*self.args) |
| 1634 | finally: |
| 1635 | self.finished.append(pid) |
Richard Oudkerk | 0f52346 | 2012-06-15 19:18:30 +0100 | [diff] [blame] | 1636 | self._can_exit.wait(30) |
| 1637 | assert self._can_exit.is_set() |
Richard Oudkerk | 3730a17 | 2012-06-15 18:26:07 +0100 | [diff] [blame] | 1638 | |
| 1639 | def wait_for_started(self): |
| 1640 | while len(self.started) < self.n: |
| 1641 | _wait() |
| 1642 | |
| 1643 | def wait_for_finished(self): |
| 1644 | while len(self.finished) < self.n: |
| 1645 | _wait() |
| 1646 | |
| 1647 | def do_finish(self): |
Richard Oudkerk | 0f52346 | 2012-06-15 19:18:30 +0100 | [diff] [blame] | 1648 | self._can_exit.set() |
Richard Oudkerk | 3730a17 | 2012-06-15 18:26:07 +0100 | [diff] [blame] | 1649 | |
Antoine Pitrou | a79f8fa | 2017-06-28 11:21:52 +0200 | [diff] [blame] | 1650 | def close(self): |
| 1651 | self._finalizer() |
| 1652 | |
Richard Oudkerk | 3730a17 | 2012-06-15 18:26:07 +0100 | [diff] [blame] | 1653 | |
| 1654 | class AppendTrue(object): |
| 1655 | def __init__(self, obj): |
| 1656 | self.obj = obj |
| 1657 | def __call__(self): |
| 1658 | self.obj.append(True) |
| 1659 | |
| 1660 | |
| 1661 | class _TestBarrier(BaseTestCase): |
| 1662 | """ |
| 1663 | Tests for Barrier objects. |
| 1664 | """ |
| 1665 | N = 5 |
Richard Oudkerk | 1375884 | 2012-06-18 14:11:10 +0100 | [diff] [blame] | 1666 | defaultTimeout = 30.0 # XXX Slow Windows buildbots need generous timeout |
Richard Oudkerk | 3730a17 | 2012-06-15 18:26:07 +0100 | [diff] [blame] | 1667 | |
| 1668 | def setUp(self): |
| 1669 | self.barrier = self.Barrier(self.N, timeout=self.defaultTimeout) |
| 1670 | |
| 1671 | def tearDown(self): |
| 1672 | self.barrier.abort() |
| 1673 | self.barrier = None |
| 1674 | |
| 1675 | def DummyList(self): |
| 1676 | if self.TYPE == 'threads': |
| 1677 | return [] |
| 1678 | elif self.TYPE == 'manager': |
| 1679 | return self.manager.list() |
| 1680 | else: |
| 1681 | return _DummyList() |
| 1682 | |
| 1683 | def run_threads(self, f, args): |
| 1684 | b = Bunch(self, f, args, self.N-1) |
Antoine Pitrou | a79f8fa | 2017-06-28 11:21:52 +0200 | [diff] [blame] | 1685 | try: |
| 1686 | f(*args) |
| 1687 | b.wait_for_finished() |
| 1688 | finally: |
| 1689 | b.close() |
Richard Oudkerk | 3730a17 | 2012-06-15 18:26:07 +0100 | [diff] [blame] | 1690 | |
| 1691 | @classmethod |
| 1692 | def multipass(cls, barrier, results, n): |
| 1693 | m = barrier.parties |
| 1694 | assert m == cls.N |
| 1695 | for i in range(n): |
| 1696 | results[0].append(True) |
| 1697 | assert len(results[1]) == i * m |
| 1698 | barrier.wait() |
| 1699 | results[1].append(True) |
| 1700 | assert len(results[0]) == (i + 1) * m |
| 1701 | barrier.wait() |
| 1702 | try: |
| 1703 | assert barrier.n_waiting == 0 |
| 1704 | except NotImplementedError: |
| 1705 | pass |
| 1706 | assert not barrier.broken |
| 1707 | |
| 1708 | def test_barrier(self, passes=1): |
| 1709 | """ |
| 1710 | Test that a barrier is passed in lockstep |
| 1711 | """ |
| 1712 | results = [self.DummyList(), self.DummyList()] |
| 1713 | self.run_threads(self.multipass, (self.barrier, results, passes)) |
| 1714 | |
| 1715 | def test_barrier_10(self): |
| 1716 | """ |
| 1717 | Test that a barrier works for 10 consecutive runs |
| 1718 | """ |
| 1719 | return self.test_barrier(10) |
| 1720 | |
| 1721 | @classmethod |
| 1722 | def _test_wait_return_f(cls, barrier, queue): |
| 1723 | res = barrier.wait() |
| 1724 | queue.put(res) |
| 1725 | |
| 1726 | def test_wait_return(self): |
| 1727 | """ |
| 1728 | test the return value from barrier.wait |
| 1729 | """ |
| 1730 | queue = self.Queue() |
| 1731 | self.run_threads(self._test_wait_return_f, (self.barrier, queue)) |
| 1732 | results = [queue.get() for i in range(self.N)] |
| 1733 | self.assertEqual(results.count(0), 1) |
Victor Stinner | b4c5296 | 2017-07-25 02:40:55 +0200 | [diff] [blame] | 1734 | close_queue(queue) |
Richard Oudkerk | 3730a17 | 2012-06-15 18:26:07 +0100 | [diff] [blame] | 1735 | |
| 1736 | @classmethod |
| 1737 | def _test_action_f(cls, barrier, results): |
| 1738 | barrier.wait() |
| 1739 | if len(results) != 1: |
| 1740 | raise RuntimeError |
| 1741 | |
| 1742 | def test_action(self): |
| 1743 | """ |
| 1744 | Test the 'action' callback |
| 1745 | """ |
| 1746 | results = self.DummyList() |
| 1747 | barrier = self.Barrier(self.N, action=AppendTrue(results)) |
| 1748 | self.run_threads(self._test_action_f, (barrier, results)) |
| 1749 | self.assertEqual(len(results), 1) |
| 1750 | |
| 1751 | @classmethod |
| 1752 | def _test_abort_f(cls, barrier, results1, results2): |
| 1753 | try: |
| 1754 | i = barrier.wait() |
| 1755 | if i == cls.N//2: |
| 1756 | raise RuntimeError |
| 1757 | barrier.wait() |
| 1758 | results1.append(True) |
| 1759 | except threading.BrokenBarrierError: |
| 1760 | results2.append(True) |
| 1761 | except RuntimeError: |
| 1762 | barrier.abort() |
| 1763 | |
| 1764 | def test_abort(self): |
| 1765 | """ |
| 1766 | Test that an abort will put the barrier in a broken state |
| 1767 | """ |
| 1768 | results1 = self.DummyList() |
| 1769 | results2 = self.DummyList() |
| 1770 | self.run_threads(self._test_abort_f, |
| 1771 | (self.barrier, results1, results2)) |
| 1772 | self.assertEqual(len(results1), 0) |
| 1773 | self.assertEqual(len(results2), self.N-1) |
| 1774 | self.assertTrue(self.barrier.broken) |
| 1775 | |
| 1776 | @classmethod |
| 1777 | def _test_reset_f(cls, barrier, results1, results2, results3): |
| 1778 | i = barrier.wait() |
| 1779 | if i == cls.N//2: |
| 1780 | # Wait until the other threads are all in the barrier. |
| 1781 | while barrier.n_waiting < cls.N-1: |
| 1782 | time.sleep(0.001) |
| 1783 | barrier.reset() |
| 1784 | else: |
| 1785 | try: |
| 1786 | barrier.wait() |
| 1787 | results1.append(True) |
| 1788 | except threading.BrokenBarrierError: |
| 1789 | results2.append(True) |
| 1790 | # Now, pass the barrier again |
| 1791 | barrier.wait() |
| 1792 | results3.append(True) |
| 1793 | |
| 1794 | def test_reset(self): |
| 1795 | """ |
| 1796 | Test that a 'reset' on a barrier frees the waiting threads |
| 1797 | """ |
| 1798 | results1 = self.DummyList() |
| 1799 | results2 = self.DummyList() |
| 1800 | results3 = self.DummyList() |
| 1801 | self.run_threads(self._test_reset_f, |
| 1802 | (self.barrier, results1, results2, results3)) |
| 1803 | self.assertEqual(len(results1), 0) |
| 1804 | self.assertEqual(len(results2), self.N-1) |
| 1805 | self.assertEqual(len(results3), self.N) |
| 1806 | |
| 1807 | @classmethod |
| 1808 | def _test_abort_and_reset_f(cls, barrier, barrier2, |
| 1809 | results1, results2, results3): |
| 1810 | try: |
| 1811 | i = barrier.wait() |
| 1812 | if i == cls.N//2: |
| 1813 | raise RuntimeError |
| 1814 | barrier.wait() |
| 1815 | results1.append(True) |
| 1816 | except threading.BrokenBarrierError: |
| 1817 | results2.append(True) |
| 1818 | except RuntimeError: |
| 1819 | barrier.abort() |
| 1820 | # Synchronize and reset the barrier. Must synchronize first so |
| 1821 | # that everyone has left it when we reset, and after so that no |
| 1822 | # one enters it before the reset. |
| 1823 | if barrier2.wait() == cls.N//2: |
| 1824 | barrier.reset() |
| 1825 | barrier2.wait() |
| 1826 | barrier.wait() |
| 1827 | results3.append(True) |
| 1828 | |
| 1829 | def test_abort_and_reset(self): |
| 1830 | """ |
| 1831 | Test that a barrier can be reset after being broken. |
| 1832 | """ |
| 1833 | results1 = self.DummyList() |
| 1834 | results2 = self.DummyList() |
| 1835 | results3 = self.DummyList() |
| 1836 | barrier2 = self.Barrier(self.N) |
| 1837 | |
| 1838 | self.run_threads(self._test_abort_and_reset_f, |
| 1839 | (self.barrier, barrier2, results1, results2, results3)) |
| 1840 | self.assertEqual(len(results1), 0) |
| 1841 | self.assertEqual(len(results2), self.N-1) |
| 1842 | self.assertEqual(len(results3), self.N) |
| 1843 | |
| 1844 | @classmethod |
| 1845 | def _test_timeout_f(cls, barrier, results): |
Richard Oudkerk | 1375884 | 2012-06-18 14:11:10 +0100 | [diff] [blame] | 1846 | i = barrier.wait() |
Richard Oudkerk | 3730a17 | 2012-06-15 18:26:07 +0100 | [diff] [blame] | 1847 | if i == cls.N//2: |
| 1848 | # One thread is late! |
Richard Oudkerk | 1375884 | 2012-06-18 14:11:10 +0100 | [diff] [blame] | 1849 | time.sleep(1.0) |
Richard Oudkerk | 3730a17 | 2012-06-15 18:26:07 +0100 | [diff] [blame] | 1850 | try: |
| 1851 | barrier.wait(0.5) |
| 1852 | except threading.BrokenBarrierError: |
| 1853 | results.append(True) |
| 1854 | |
| 1855 | def test_timeout(self): |
| 1856 | """ |
| 1857 | Test wait(timeout) |
| 1858 | """ |
| 1859 | results = self.DummyList() |
| 1860 | self.run_threads(self._test_timeout_f, (self.barrier, results)) |
| 1861 | self.assertEqual(len(results), self.barrier.parties) |
| 1862 | |
| 1863 | @classmethod |
| 1864 | def _test_default_timeout_f(cls, barrier, results): |
Richard Oudkerk | 1375884 | 2012-06-18 14:11:10 +0100 | [diff] [blame] | 1865 | i = barrier.wait(cls.defaultTimeout) |
Richard Oudkerk | 3730a17 | 2012-06-15 18:26:07 +0100 | [diff] [blame] | 1866 | if i == cls.N//2: |
| 1867 | # One thread is later than the default timeout |
Richard Oudkerk | 1375884 | 2012-06-18 14:11:10 +0100 | [diff] [blame] | 1868 | time.sleep(1.0) |
Richard Oudkerk | 3730a17 | 2012-06-15 18:26:07 +0100 | [diff] [blame] | 1869 | try: |
| 1870 | barrier.wait() |
| 1871 | except threading.BrokenBarrierError: |
| 1872 | results.append(True) |
| 1873 | |
| 1874 | def test_default_timeout(self): |
| 1875 | """ |
| 1876 | Test the barrier's default timeout |
| 1877 | """ |
Richard Oudkerk | 1375884 | 2012-06-18 14:11:10 +0100 | [diff] [blame] | 1878 | barrier = self.Barrier(self.N, timeout=0.5) |
Richard Oudkerk | 3730a17 | 2012-06-15 18:26:07 +0100 | [diff] [blame] | 1879 | results = self.DummyList() |
| 1880 | self.run_threads(self._test_default_timeout_f, (barrier, results)) |
| 1881 | self.assertEqual(len(results), barrier.parties) |
| 1882 | |
| 1883 | def test_single_thread(self): |
| 1884 | b = self.Barrier(1) |
| 1885 | b.wait() |
| 1886 | b.wait() |
| 1887 | |
| 1888 | @classmethod |
| 1889 | def _test_thousand_f(cls, barrier, passes, conn, lock): |
| 1890 | for i in range(passes): |
| 1891 | barrier.wait() |
| 1892 | with lock: |
| 1893 | conn.send(i) |
| 1894 | |
| 1895 | def test_thousand(self): |
| 1896 | if self.TYPE == 'manager': |
Zachary Ware | 9fe6d86 | 2013-12-08 00:20:35 -0600 | [diff] [blame] | 1897 | self.skipTest('test not appropriate for {}'.format(self.TYPE)) |
Richard Oudkerk | 3730a17 | 2012-06-15 18:26:07 +0100 | [diff] [blame] | 1898 | passes = 1000 |
| 1899 | lock = self.Lock() |
| 1900 | conn, child_conn = self.Pipe(False) |
| 1901 | for j in range(self.N): |
| 1902 | p = self.Process(target=self._test_thousand_f, |
| 1903 | args=(self.barrier, passes, child_conn, lock)) |
| 1904 | p.start() |
Victor Stinner | d7e64d9 | 2017-07-25 00:33:56 +0200 | [diff] [blame] | 1905 | self.addCleanup(p.join) |
Richard Oudkerk | 3730a17 | 2012-06-15 18:26:07 +0100 | [diff] [blame] | 1906 | |
| 1907 | for i in range(passes): |
| 1908 | for j in range(self.N): |
| 1909 | self.assertEqual(conn.recv(), i) |
| 1910 | |
| 1911 | # |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1912 | # |
| 1913 | # |
| 1914 | |
| 1915 | class _TestValue(BaseTestCase): |
| 1916 | |
Florent Xicluna | fd1b093 | 2010-03-28 00:25:02 +0000 | [diff] [blame] | 1917 | ALLOWED_TYPES = ('processes',) |
| 1918 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1919 | codes_values = [ |
| 1920 | ('i', 4343, 24234), |
| 1921 | ('d', 3.625, -4.25), |
| 1922 | ('h', -232, 234), |
Gareth Rees | 3913bad | 2017-07-21 11:35:33 +0100 | [diff] [blame] | 1923 | ('q', 2 ** 33, 2 ** 34), |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1924 | ('c', latin('x'), latin('y')) |
| 1925 | ] |
| 1926 | |
Antoine Pitrou | 7744e2a | 2010-11-22 16:26:21 +0000 | [diff] [blame] | 1927 | def setUp(self): |
| 1928 | if not HAS_SHAREDCTYPES: |
| 1929 | self.skipTest("requires multiprocessing.sharedctypes") |
| 1930 | |
Antoine Pitrou | 0d1b38c | 2010-11-02 23:50:11 +0000 | [diff] [blame] | 1931 | @classmethod |
| 1932 | def _test(cls, values): |
| 1933 | for sv, cv in zip(values, cls.codes_values): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1934 | sv.value = cv[2] |
| 1935 | |
| 1936 | |
| 1937 | def test_value(self, raw=False): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1938 | if raw: |
| 1939 | values = [self.RawValue(code, value) |
| 1940 | for code, value, _ in self.codes_values] |
| 1941 | else: |
| 1942 | values = [self.Value(code, value) |
| 1943 | for code, value, _ in self.codes_values] |
| 1944 | |
| 1945 | for sv, cv in zip(values, self.codes_values): |
| 1946 | self.assertEqual(sv.value, cv[1]) |
| 1947 | |
| 1948 | proc = self.Process(target=self._test, args=(values,)) |
Jesus Cea | 94f964f | 2011-09-09 20:26:57 +0200 | [diff] [blame] | 1949 | proc.daemon = True |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1950 | proc.start() |
| 1951 | proc.join() |
| 1952 | |
| 1953 | for sv, cv in zip(values, self.codes_values): |
| 1954 | self.assertEqual(sv.value, cv[2]) |
| 1955 | |
| 1956 | def test_rawvalue(self): |
| 1957 | self.test_value(raw=True) |
| 1958 | |
| 1959 | def test_getobj_getlock(self): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1960 | val1 = self.Value('i', 5) |
| 1961 | lock1 = val1.get_lock() |
| 1962 | obj1 = val1.get_obj() |
| 1963 | |
| 1964 | val2 = self.Value('i', 5, lock=None) |
| 1965 | lock2 = val2.get_lock() |
| 1966 | obj2 = val2.get_obj() |
| 1967 | |
| 1968 | lock = self.Lock() |
| 1969 | val3 = self.Value('i', 5, lock=lock) |
| 1970 | lock3 = val3.get_lock() |
| 1971 | obj3 = val3.get_obj() |
| 1972 | self.assertEqual(lock, lock3) |
| 1973 | |
Jesse Noller | b0516a6 | 2009-01-18 03:11:38 +0000 | [diff] [blame] | 1974 | arr4 = self.Value('i', 5, lock=False) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1975 | self.assertFalse(hasattr(arr4, 'get_lock')) |
| 1976 | self.assertFalse(hasattr(arr4, 'get_obj')) |
| 1977 | |
Jesse Noller | b0516a6 | 2009-01-18 03:11:38 +0000 | [diff] [blame] | 1978 | self.assertRaises(AttributeError, self.Value, 'i', 5, lock='navalue') |
| 1979 | |
| 1980 | arr5 = self.RawValue('i', 5) |
| 1981 | self.assertFalse(hasattr(arr5, 'get_lock')) |
| 1982 | self.assertFalse(hasattr(arr5, 'get_obj')) |
| 1983 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1984 | |
| 1985 | class _TestArray(BaseTestCase): |
| 1986 | |
Florent Xicluna | fd1b093 | 2010-03-28 00:25:02 +0000 | [diff] [blame] | 1987 | ALLOWED_TYPES = ('processes',) |
| 1988 | |
Antoine Pitrou | 0d1b38c | 2010-11-02 23:50:11 +0000 | [diff] [blame] | 1989 | @classmethod |
| 1990 | def f(cls, seq): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1991 | for i in range(1, len(seq)): |
| 1992 | seq[i] += seq[i-1] |
| 1993 | |
Florent Xicluna | fd1b093 | 2010-03-28 00:25:02 +0000 | [diff] [blame] | 1994 | @unittest.skipIf(c_int is None, "requires _ctypes") |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1995 | def test_array(self, raw=False): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1996 | seq = [680, 626, 934, 821, 150, 233, 548, 982, 714, 831] |
| 1997 | if raw: |
| 1998 | arr = self.RawArray('i', seq) |
| 1999 | else: |
| 2000 | arr = self.Array('i', seq) |
| 2001 | |
| 2002 | self.assertEqual(len(arr), len(seq)) |
| 2003 | self.assertEqual(arr[3], seq[3]) |
| 2004 | self.assertEqual(list(arr[2:7]), list(seq[2:7])) |
| 2005 | |
| 2006 | arr[4:8] = seq[4:8] = array.array('i', [1, 2, 3, 4]) |
| 2007 | |
| 2008 | self.assertEqual(list(arr[:]), seq) |
| 2009 | |
| 2010 | self.f(seq) |
| 2011 | |
| 2012 | p = self.Process(target=self.f, args=(arr,)) |
Jesus Cea | 94f964f | 2011-09-09 20:26:57 +0200 | [diff] [blame] | 2013 | p.daemon = True |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2014 | p.start() |
| 2015 | p.join() |
| 2016 | |
| 2017 | self.assertEqual(list(arr[:]), seq) |
| 2018 | |
Florent Xicluna | fd1b093 | 2010-03-28 00:25:02 +0000 | [diff] [blame] | 2019 | @unittest.skipIf(c_int is None, "requires _ctypes") |
Mark Dickinson | 89461ef | 2011-03-26 10:19:03 +0000 | [diff] [blame] | 2020 | def test_array_from_size(self): |
| 2021 | size = 10 |
| 2022 | # Test for zeroing (see issue #11675). |
| 2023 | # The repetition below strengthens the test by increasing the chances |
| 2024 | # of previously allocated non-zero memory being used for the new array |
| 2025 | # on the 2nd and 3rd loops. |
| 2026 | for _ in range(3): |
| 2027 | arr = self.Array('i', size) |
| 2028 | self.assertEqual(len(arr), size) |
| 2029 | self.assertEqual(list(arr), [0] * size) |
| 2030 | arr[:] = range(10) |
| 2031 | self.assertEqual(list(arr), list(range(10))) |
| 2032 | del arr |
| 2033 | |
| 2034 | @unittest.skipIf(c_int is None, "requires _ctypes") |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2035 | def test_rawarray(self): |
| 2036 | self.test_array(raw=True) |
| 2037 | |
Florent Xicluna | fd1b093 | 2010-03-28 00:25:02 +0000 | [diff] [blame] | 2038 | @unittest.skipIf(c_int is None, "requires _ctypes") |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2039 | def test_getobj_getlock_obj(self): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2040 | arr1 = self.Array('i', list(range(10))) |
| 2041 | lock1 = arr1.get_lock() |
| 2042 | obj1 = arr1.get_obj() |
| 2043 | |
| 2044 | arr2 = self.Array('i', list(range(10)), lock=None) |
| 2045 | lock2 = arr2.get_lock() |
| 2046 | obj2 = arr2.get_obj() |
| 2047 | |
| 2048 | lock = self.Lock() |
| 2049 | arr3 = self.Array('i', list(range(10)), lock=lock) |
| 2050 | lock3 = arr3.get_lock() |
| 2051 | obj3 = arr3.get_obj() |
| 2052 | self.assertEqual(lock, lock3) |
| 2053 | |
Jesse Noller | b0516a6 | 2009-01-18 03:11:38 +0000 | [diff] [blame] | 2054 | arr4 = self.Array('i', range(10), lock=False) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2055 | self.assertFalse(hasattr(arr4, 'get_lock')) |
| 2056 | self.assertFalse(hasattr(arr4, 'get_obj')) |
Jesse Noller | b0516a6 | 2009-01-18 03:11:38 +0000 | [diff] [blame] | 2057 | self.assertRaises(AttributeError, |
| 2058 | self.Array, 'i', range(10), lock='notalock') |
| 2059 | |
| 2060 | arr5 = self.RawArray('i', range(10)) |
| 2061 | self.assertFalse(hasattr(arr5, 'get_lock')) |
| 2062 | self.assertFalse(hasattr(arr5, 'get_obj')) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2063 | |
| 2064 | # |
| 2065 | # |
| 2066 | # |
| 2067 | |
| 2068 | class _TestContainers(BaseTestCase): |
| 2069 | |
| 2070 | ALLOWED_TYPES = ('manager',) |
| 2071 | |
| 2072 | def test_list(self): |
| 2073 | a = self.list(list(range(10))) |
| 2074 | self.assertEqual(a[:], list(range(10))) |
| 2075 | |
| 2076 | b = self.list() |
| 2077 | self.assertEqual(b[:], []) |
| 2078 | |
| 2079 | b.extend(list(range(5))) |
| 2080 | self.assertEqual(b[:], list(range(5))) |
| 2081 | |
| 2082 | self.assertEqual(b[2], 2) |
| 2083 | self.assertEqual(b[2:10], [2,3,4]) |
| 2084 | |
| 2085 | b *= 2 |
| 2086 | self.assertEqual(b[:], [0, 1, 2, 3, 4, 0, 1, 2, 3, 4]) |
| 2087 | |
| 2088 | self.assertEqual(b + [5, 6], [0, 1, 2, 3, 4, 0, 1, 2, 3, 4, 5, 6]) |
| 2089 | |
| 2090 | self.assertEqual(a[:], list(range(10))) |
| 2091 | |
| 2092 | d = [a, b] |
| 2093 | e = self.list(d) |
| 2094 | self.assertEqual( |
Davin Potts | 86a7668 | 2016-09-07 18:48:01 -0500 | [diff] [blame] | 2095 | [element[:] for element in e], |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2096 | [[0, 1, 2, 3, 4, 5, 6, 7, 8, 9], [0, 1, 2, 3, 4, 0, 1, 2, 3, 4]] |
| 2097 | ) |
| 2098 | |
| 2099 | f = self.list([a]) |
| 2100 | a.append('hello') |
Davin Potts | 86a7668 | 2016-09-07 18:48:01 -0500 | [diff] [blame] | 2101 | self.assertEqual(f[0][:], [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 'hello']) |
| 2102 | |
Serhiy Storchaka | e0e5065 | 2018-09-17 14:24:01 +0300 | [diff] [blame] | 2103 | def test_list_iter(self): |
| 2104 | a = self.list(list(range(10))) |
| 2105 | it = iter(a) |
| 2106 | self.assertEqual(list(it), list(range(10))) |
| 2107 | self.assertEqual(list(it), []) # exhausted |
| 2108 | # list modified during iteration |
| 2109 | it = iter(a) |
| 2110 | a[0] = 100 |
| 2111 | self.assertEqual(next(it), 100) |
| 2112 | |
Davin Potts | 86a7668 | 2016-09-07 18:48:01 -0500 | [diff] [blame] | 2113 | def test_list_proxy_in_list(self): |
| 2114 | a = self.list([self.list(range(3)) for _i in range(3)]) |
| 2115 | self.assertEqual([inner[:] for inner in a], [[0, 1, 2]] * 3) |
| 2116 | |
| 2117 | a[0][-1] = 55 |
| 2118 | self.assertEqual(a[0][:], [0, 1, 55]) |
| 2119 | for i in range(1, 3): |
| 2120 | self.assertEqual(a[i][:], [0, 1, 2]) |
| 2121 | |
| 2122 | self.assertEqual(a[1].pop(), 2) |
| 2123 | self.assertEqual(len(a[1]), 2) |
| 2124 | for i in range(0, 3, 2): |
| 2125 | self.assertEqual(len(a[i]), 3) |
| 2126 | |
| 2127 | del a |
| 2128 | |
| 2129 | b = self.list() |
| 2130 | b.append(b) |
| 2131 | del b |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2132 | |
| 2133 | def test_dict(self): |
| 2134 | d = self.dict() |
| 2135 | indices = list(range(65, 70)) |
| 2136 | for i in indices: |
| 2137 | d[i] = chr(i) |
| 2138 | self.assertEqual(d.copy(), dict((i, chr(i)) for i in indices)) |
| 2139 | self.assertEqual(sorted(d.keys()), indices) |
| 2140 | self.assertEqual(sorted(d.values()), [chr(i) for i in indices]) |
| 2141 | self.assertEqual(sorted(d.items()), [(i, chr(i)) for i in indices]) |
| 2142 | |
Serhiy Storchaka | e0e5065 | 2018-09-17 14:24:01 +0300 | [diff] [blame] | 2143 | def test_dict_iter(self): |
| 2144 | d = self.dict() |
| 2145 | indices = list(range(65, 70)) |
| 2146 | for i in indices: |
| 2147 | d[i] = chr(i) |
| 2148 | it = iter(d) |
| 2149 | self.assertEqual(list(it), indices) |
| 2150 | self.assertEqual(list(it), []) # exhausted |
| 2151 | # dictionary changed size during iteration |
| 2152 | it = iter(d) |
| 2153 | d.clear() |
| 2154 | self.assertRaises(RuntimeError, next, it) |
| 2155 | |
Davin Potts | 86a7668 | 2016-09-07 18:48:01 -0500 | [diff] [blame] | 2156 | def test_dict_proxy_nested(self): |
| 2157 | pets = self.dict(ferrets=2, hamsters=4) |
| 2158 | supplies = self.dict(water=10, feed=3) |
| 2159 | d = self.dict(pets=pets, supplies=supplies) |
| 2160 | |
| 2161 | self.assertEqual(supplies['water'], 10) |
| 2162 | self.assertEqual(d['supplies']['water'], 10) |
| 2163 | |
| 2164 | d['supplies']['blankets'] = 5 |
| 2165 | self.assertEqual(supplies['blankets'], 5) |
| 2166 | self.assertEqual(d['supplies']['blankets'], 5) |
| 2167 | |
| 2168 | d['supplies']['water'] = 7 |
| 2169 | self.assertEqual(supplies['water'], 7) |
| 2170 | self.assertEqual(d['supplies']['water'], 7) |
| 2171 | |
| 2172 | del pets |
| 2173 | del supplies |
| 2174 | self.assertEqual(d['pets']['ferrets'], 2) |
| 2175 | d['supplies']['blankets'] = 11 |
| 2176 | self.assertEqual(d['supplies']['blankets'], 11) |
| 2177 | |
| 2178 | pets = d['pets'] |
| 2179 | supplies = d['supplies'] |
| 2180 | supplies['water'] = 7 |
| 2181 | self.assertEqual(supplies['water'], 7) |
| 2182 | self.assertEqual(d['supplies']['water'], 7) |
| 2183 | |
| 2184 | d.clear() |
| 2185 | self.assertEqual(len(d), 0) |
| 2186 | self.assertEqual(supplies['water'], 7) |
| 2187 | self.assertEqual(pets['hamsters'], 4) |
| 2188 | |
| 2189 | l = self.list([pets, supplies]) |
| 2190 | l[0]['marmots'] = 1 |
| 2191 | self.assertEqual(pets['marmots'], 1) |
| 2192 | self.assertEqual(l[0]['marmots'], 1) |
| 2193 | |
| 2194 | del pets |
| 2195 | del supplies |
| 2196 | self.assertEqual(l[0]['marmots'], 1) |
| 2197 | |
| 2198 | outer = self.list([[88, 99], l]) |
| 2199 | self.assertIsInstance(outer[0], list) # Not a ListProxy |
| 2200 | self.assertEqual(outer[-1][-1]['feed'], 3) |
| 2201 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2202 | def test_namespace(self): |
| 2203 | n = self.Namespace() |
| 2204 | n.name = 'Bob' |
| 2205 | n.job = 'Builder' |
| 2206 | n._hidden = 'hidden' |
| 2207 | self.assertEqual((n.name, n.job), ('Bob', 'Builder')) |
| 2208 | del n.job |
| 2209 | self.assertEqual(str(n), "Namespace(name='Bob')") |
| 2210 | self.assertTrue(hasattr(n, 'name')) |
| 2211 | self.assertTrue(not hasattr(n, 'job')) |
| 2212 | |
| 2213 | # |
| 2214 | # |
| 2215 | # |
| 2216 | |
| 2217 | def sqr(x, wait=0.0): |
| 2218 | time.sleep(wait) |
| 2219 | return x*x |
Ask Solem | 2afcbf2 | 2010-11-09 20:55:52 +0000 | [diff] [blame] | 2220 | |
Antoine Pitrou | de911b2 | 2011-12-21 11:03:24 +0100 | [diff] [blame] | 2221 | def mul(x, y): |
| 2222 | return x*y |
| 2223 | |
Charles-François Natali | 78f55ff | 2016-02-10 22:58:18 +0000 | [diff] [blame] | 2224 | def raise_large_valuerror(wait): |
| 2225 | time.sleep(wait) |
| 2226 | raise ValueError("x" * 1024**2) |
| 2227 | |
Antoine Pitrou | 8988945 | 2017-03-24 13:52:11 +0100 | [diff] [blame] | 2228 | def identity(x): |
| 2229 | return x |
| 2230 | |
| 2231 | class CountedObject(object): |
| 2232 | n_instances = 0 |
| 2233 | |
| 2234 | def __new__(cls): |
| 2235 | cls.n_instances += 1 |
| 2236 | return object.__new__(cls) |
| 2237 | |
| 2238 | def __del__(self): |
| 2239 | type(self).n_instances -= 1 |
| 2240 | |
Serhiy Storchaka | 79fbeee | 2015-03-13 08:25:26 +0200 | [diff] [blame] | 2241 | class SayWhenError(ValueError): pass |
| 2242 | |
| 2243 | def exception_throwing_generator(total, when): |
Xiang Zhang | 794623b | 2017-03-29 11:58:54 +0800 | [diff] [blame] | 2244 | if when == -1: |
| 2245 | raise SayWhenError("Somebody said when") |
Serhiy Storchaka | 79fbeee | 2015-03-13 08:25:26 +0200 | [diff] [blame] | 2246 | for i in range(total): |
| 2247 | if i == when: |
| 2248 | raise SayWhenError("Somebody said when") |
| 2249 | yield i |
| 2250 | |
Antoine Pitrou | 8988945 | 2017-03-24 13:52:11 +0100 | [diff] [blame] | 2251 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2252 | class _TestPool(BaseTestCase): |
| 2253 | |
Richard Oudkerk | fc7b0ec | 2012-10-08 14:56:24 +0100 | [diff] [blame] | 2254 | @classmethod |
| 2255 | def setUpClass(cls): |
| 2256 | super().setUpClass() |
| 2257 | cls.pool = cls.Pool(4) |
| 2258 | |
| 2259 | @classmethod |
| 2260 | def tearDownClass(cls): |
| 2261 | cls.pool.terminate() |
| 2262 | cls.pool.join() |
| 2263 | cls.pool = None |
| 2264 | super().tearDownClass() |
| 2265 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2266 | def test_apply(self): |
| 2267 | papply = self.pool.apply |
| 2268 | self.assertEqual(papply(sqr, (5,)), sqr(5)) |
| 2269 | self.assertEqual(papply(sqr, (), {'x':3}), sqr(x=3)) |
| 2270 | |
| 2271 | def test_map(self): |
| 2272 | pmap = self.pool.map |
| 2273 | self.assertEqual(pmap(sqr, list(range(10))), list(map(sqr, list(range(10))))) |
| 2274 | self.assertEqual(pmap(sqr, list(range(100)), chunksize=20), |
| 2275 | list(map(sqr, list(range(100))))) |
| 2276 | |
Antoine Pitrou | de911b2 | 2011-12-21 11:03:24 +0100 | [diff] [blame] | 2277 | def test_starmap(self): |
| 2278 | psmap = self.pool.starmap |
| 2279 | tuples = list(zip(range(10), range(9,-1, -1))) |
| 2280 | self.assertEqual(psmap(mul, tuples), |
| 2281 | list(itertools.starmap(mul, tuples))) |
| 2282 | tuples = list(zip(range(100), range(99,-1, -1))) |
| 2283 | self.assertEqual(psmap(mul, tuples, chunksize=20), |
| 2284 | list(itertools.starmap(mul, tuples))) |
| 2285 | |
| 2286 | def test_starmap_async(self): |
| 2287 | tuples = list(zip(range(100), range(99,-1, -1))) |
| 2288 | self.assertEqual(self.pool.starmap_async(mul, tuples).get(), |
| 2289 | list(itertools.starmap(mul, tuples))) |
| 2290 | |
Hynek Schlawack | 254af26 | 2012-10-27 12:53:02 +0200 | [diff] [blame] | 2291 | def test_map_async(self): |
| 2292 | self.assertEqual(self.pool.map_async(sqr, list(range(10))).get(), |
| 2293 | list(map(sqr, list(range(10))))) |
| 2294 | |
| 2295 | def test_map_async_callbacks(self): |
| 2296 | call_args = self.manager.list() if self.TYPE == 'manager' else [] |
| 2297 | self.pool.map_async(int, ['1'], |
| 2298 | callback=call_args.append, |
| 2299 | error_callback=call_args.append).wait() |
| 2300 | self.assertEqual(1, len(call_args)) |
| 2301 | self.assertEqual([1], call_args[0]) |
| 2302 | self.pool.map_async(int, ['a'], |
| 2303 | callback=call_args.append, |
| 2304 | error_callback=call_args.append).wait() |
| 2305 | self.assertEqual(2, len(call_args)) |
| 2306 | self.assertIsInstance(call_args[1], ValueError) |
| 2307 | |
Richard Oudkerk | e90cedb | 2013-10-28 23:11:58 +0000 | [diff] [blame] | 2308 | def test_map_unplicklable(self): |
| 2309 | # Issue #19425 -- failure to pickle should not cause a hang |
| 2310 | if self.TYPE == 'threads': |
Zachary Ware | 9fe6d86 | 2013-12-08 00:20:35 -0600 | [diff] [blame] | 2311 | self.skipTest('test not appropriate for {}'.format(self.TYPE)) |
Richard Oudkerk | e90cedb | 2013-10-28 23:11:58 +0000 | [diff] [blame] | 2312 | class A(object): |
| 2313 | def __reduce__(self): |
| 2314 | raise RuntimeError('cannot pickle') |
| 2315 | with self.assertRaises(RuntimeError): |
| 2316 | self.pool.map(sqr, [A()]*10) |
| 2317 | |
Alexandre Vassalotti | e52e378 | 2009-07-17 09:18:18 +0000 | [diff] [blame] | 2318 | def test_map_chunksize(self): |
| 2319 | try: |
| 2320 | self.pool.map_async(sqr, [], chunksize=1).get(timeout=TIMEOUT1) |
| 2321 | except multiprocessing.TimeoutError: |
| 2322 | self.fail("pool.map_async with chunksize stalled on null list") |
| 2323 | |
Xiang Zhang | 794623b | 2017-03-29 11:58:54 +0800 | [diff] [blame] | 2324 | def test_map_handle_iterable_exception(self): |
| 2325 | if self.TYPE == 'manager': |
| 2326 | self.skipTest('test not appropriate for {}'.format(self.TYPE)) |
| 2327 | |
| 2328 | # SayWhenError seen at the very first of the iterable |
| 2329 | with self.assertRaises(SayWhenError): |
| 2330 | self.pool.map(sqr, exception_throwing_generator(1, -1), 1) |
| 2331 | # again, make sure it's reentrant |
| 2332 | with self.assertRaises(SayWhenError): |
| 2333 | self.pool.map(sqr, exception_throwing_generator(1, -1), 1) |
| 2334 | |
| 2335 | with self.assertRaises(SayWhenError): |
| 2336 | self.pool.map(sqr, exception_throwing_generator(10, 3), 1) |
| 2337 | |
| 2338 | class SpecialIterable: |
| 2339 | def __iter__(self): |
| 2340 | return self |
| 2341 | def __next__(self): |
| 2342 | raise SayWhenError |
| 2343 | def __len__(self): |
| 2344 | return 1 |
| 2345 | with self.assertRaises(SayWhenError): |
| 2346 | self.pool.map(sqr, SpecialIterable(), 1) |
| 2347 | with self.assertRaises(SayWhenError): |
| 2348 | self.pool.map(sqr, SpecialIterable(), 1) |
| 2349 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2350 | def test_async(self): |
| 2351 | res = self.pool.apply_async(sqr, (7, TIMEOUT1,)) |
| 2352 | get = TimingWrapper(res.get) |
| 2353 | self.assertEqual(get(), 49) |
| 2354 | self.assertTimingAlmostEqual(get.elapsed, TIMEOUT1) |
| 2355 | |
| 2356 | def test_async_timeout(self): |
Richard Oudkerk | 46b4a5e | 2013-11-17 17:45:16 +0000 | [diff] [blame] | 2357 | res = self.pool.apply_async(sqr, (6, TIMEOUT2 + 1.0)) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2358 | get = TimingWrapper(res.get) |
| 2359 | self.assertRaises(multiprocessing.TimeoutError, get, timeout=TIMEOUT2) |
| 2360 | self.assertTimingAlmostEqual(get.elapsed, TIMEOUT2) |
| 2361 | |
| 2362 | def test_imap(self): |
| 2363 | it = self.pool.imap(sqr, list(range(10))) |
| 2364 | self.assertEqual(list(it), list(map(sqr, list(range(10))))) |
| 2365 | |
| 2366 | it = self.pool.imap(sqr, list(range(10))) |
| 2367 | for i in range(10): |
| 2368 | self.assertEqual(next(it), i*i) |
| 2369 | self.assertRaises(StopIteration, it.__next__) |
| 2370 | |
| 2371 | it = self.pool.imap(sqr, list(range(1000)), chunksize=100) |
| 2372 | for i in range(1000): |
| 2373 | self.assertEqual(next(it), i*i) |
| 2374 | self.assertRaises(StopIteration, it.__next__) |
| 2375 | |
Serhiy Storchaka | 79fbeee | 2015-03-13 08:25:26 +0200 | [diff] [blame] | 2376 | def test_imap_handle_iterable_exception(self): |
| 2377 | if self.TYPE == 'manager': |
| 2378 | self.skipTest('test not appropriate for {}'.format(self.TYPE)) |
| 2379 | |
Xiang Zhang | 794623b | 2017-03-29 11:58:54 +0800 | [diff] [blame] | 2380 | # SayWhenError seen at the very first of the iterable |
| 2381 | it = self.pool.imap(sqr, exception_throwing_generator(1, -1), 1) |
| 2382 | self.assertRaises(SayWhenError, it.__next__) |
| 2383 | # again, make sure it's reentrant |
| 2384 | it = self.pool.imap(sqr, exception_throwing_generator(1, -1), 1) |
| 2385 | self.assertRaises(SayWhenError, it.__next__) |
| 2386 | |
Serhiy Storchaka | 79fbeee | 2015-03-13 08:25:26 +0200 | [diff] [blame] | 2387 | it = self.pool.imap(sqr, exception_throwing_generator(10, 3), 1) |
| 2388 | for i in range(3): |
| 2389 | self.assertEqual(next(it), i*i) |
| 2390 | self.assertRaises(SayWhenError, it.__next__) |
| 2391 | |
| 2392 | # SayWhenError seen at start of problematic chunk's results |
| 2393 | it = self.pool.imap(sqr, exception_throwing_generator(20, 7), 2) |
| 2394 | for i in range(6): |
| 2395 | self.assertEqual(next(it), i*i) |
| 2396 | self.assertRaises(SayWhenError, it.__next__) |
| 2397 | it = self.pool.imap(sqr, exception_throwing_generator(20, 7), 4) |
| 2398 | for i in range(4): |
| 2399 | self.assertEqual(next(it), i*i) |
| 2400 | self.assertRaises(SayWhenError, it.__next__) |
| 2401 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2402 | def test_imap_unordered(self): |
Victor Stinner | 23401fb | 2018-07-03 13:20:35 +0200 | [diff] [blame] | 2403 | it = self.pool.imap_unordered(sqr, list(range(10))) |
| 2404 | self.assertEqual(sorted(it), list(map(sqr, list(range(10))))) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2405 | |
Victor Stinner | 23401fb | 2018-07-03 13:20:35 +0200 | [diff] [blame] | 2406 | it = self.pool.imap_unordered(sqr, list(range(1000)), chunksize=100) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2407 | self.assertEqual(sorted(it), list(map(sqr, list(range(1000))))) |
| 2408 | |
Serhiy Storchaka | 79fbeee | 2015-03-13 08:25:26 +0200 | [diff] [blame] | 2409 | def test_imap_unordered_handle_iterable_exception(self): |
| 2410 | if self.TYPE == 'manager': |
| 2411 | self.skipTest('test not appropriate for {}'.format(self.TYPE)) |
| 2412 | |
Xiang Zhang | 794623b | 2017-03-29 11:58:54 +0800 | [diff] [blame] | 2413 | # SayWhenError seen at the very first of the iterable |
| 2414 | it = self.pool.imap_unordered(sqr, |
| 2415 | exception_throwing_generator(1, -1), |
| 2416 | 1) |
| 2417 | self.assertRaises(SayWhenError, it.__next__) |
| 2418 | # again, make sure it's reentrant |
| 2419 | it = self.pool.imap_unordered(sqr, |
| 2420 | exception_throwing_generator(1, -1), |
| 2421 | 1) |
| 2422 | self.assertRaises(SayWhenError, it.__next__) |
| 2423 | |
Serhiy Storchaka | 79fbeee | 2015-03-13 08:25:26 +0200 | [diff] [blame] | 2424 | it = self.pool.imap_unordered(sqr, |
| 2425 | exception_throwing_generator(10, 3), |
| 2426 | 1) |
Serhiy Storchaka | 71f73ca | 2015-04-23 11:35:59 +0300 | [diff] [blame] | 2427 | expected_values = list(map(sqr, list(range(10)))) |
Serhiy Storchaka | 79fbeee | 2015-03-13 08:25:26 +0200 | [diff] [blame] | 2428 | with self.assertRaises(SayWhenError): |
| 2429 | # imap_unordered makes it difficult to anticipate the SayWhenError |
| 2430 | for i in range(10): |
Serhiy Storchaka | 71f73ca | 2015-04-23 11:35:59 +0300 | [diff] [blame] | 2431 | value = next(it) |
| 2432 | self.assertIn(value, expected_values) |
| 2433 | expected_values.remove(value) |
Serhiy Storchaka | 79fbeee | 2015-03-13 08:25:26 +0200 | [diff] [blame] | 2434 | |
| 2435 | it = self.pool.imap_unordered(sqr, |
| 2436 | exception_throwing_generator(20, 7), |
| 2437 | 2) |
Serhiy Storchaka | 71f73ca | 2015-04-23 11:35:59 +0300 | [diff] [blame] | 2438 | expected_values = list(map(sqr, list(range(20)))) |
Serhiy Storchaka | 79fbeee | 2015-03-13 08:25:26 +0200 | [diff] [blame] | 2439 | with self.assertRaises(SayWhenError): |
| 2440 | for i in range(20): |
Serhiy Storchaka | 71f73ca | 2015-04-23 11:35:59 +0300 | [diff] [blame] | 2441 | value = next(it) |
| 2442 | self.assertIn(value, expected_values) |
| 2443 | expected_values.remove(value) |
Serhiy Storchaka | 79fbeee | 2015-03-13 08:25:26 +0200 | [diff] [blame] | 2444 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2445 | def test_make_pool(self): |
Antoine Pitrou | 62b6a0d | 2016-03-15 10:48:28 +0100 | [diff] [blame] | 2446 | expected_error = (RemoteError if self.TYPE == 'manager' |
| 2447 | else ValueError) |
Victor Stinner | 2fae27b | 2011-06-20 17:53:35 +0200 | [diff] [blame] | 2448 | |
Antoine Pitrou | 62b6a0d | 2016-03-15 10:48:28 +0100 | [diff] [blame] | 2449 | self.assertRaises(expected_error, self.Pool, -1) |
| 2450 | self.assertRaises(expected_error, self.Pool, 0) |
| 2451 | |
| 2452 | if self.TYPE != 'manager': |
| 2453 | p = self.Pool(3) |
| 2454 | try: |
| 2455 | self.assertEqual(3, len(p._pool)) |
| 2456 | finally: |
| 2457 | p.close() |
| 2458 | p.join() |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2459 | |
| 2460 | def test_terminate(self): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2461 | result = self.pool.map_async( |
| 2462 | time.sleep, [0.1 for i in range(10000)], chunksize=1 |
| 2463 | ) |
| 2464 | self.pool.terminate() |
| 2465 | join = TimingWrapper(self.pool.join) |
| 2466 | join() |
Antoine Pitrou | 62b6a0d | 2016-03-15 10:48:28 +0100 | [diff] [blame] | 2467 | # Sanity check the pool didn't wait for all tasks to finish |
| 2468 | self.assertLess(join.elapsed, 2.0) |
Jesse Noller | 1f0b658 | 2010-01-27 03:36:01 +0000 | [diff] [blame] | 2469 | |
Richard Oudkerk | e41682b | 2012-06-06 19:04:57 +0100 | [diff] [blame] | 2470 | def test_empty_iterable(self): |
| 2471 | # See Issue 12157 |
| 2472 | p = self.Pool(1) |
| 2473 | |
| 2474 | self.assertEqual(p.map(sqr, []), []) |
| 2475 | self.assertEqual(list(p.imap(sqr, [])), []) |
| 2476 | self.assertEqual(list(p.imap_unordered(sqr, [])), []) |
| 2477 | self.assertEqual(p.map_async(sqr, []).get(), []) |
| 2478 | |
| 2479 | p.close() |
| 2480 | p.join() |
| 2481 | |
Richard Oudkerk | d69cfe8 | 2012-06-18 17:47:52 +0100 | [diff] [blame] | 2482 | def test_context(self): |
| 2483 | if self.TYPE == 'processes': |
| 2484 | L = list(range(10)) |
| 2485 | expected = [sqr(i) for i in L] |
Antoine Pitrou | 62b6a0d | 2016-03-15 10:48:28 +0100 | [diff] [blame] | 2486 | with self.Pool(2) as p: |
Richard Oudkerk | d69cfe8 | 2012-06-18 17:47:52 +0100 | [diff] [blame] | 2487 | r = p.map_async(sqr, L) |
| 2488 | self.assertEqual(r.get(), expected) |
Victor Stinner | 388c8c2 | 2018-12-06 11:56:52 +0100 | [diff] [blame] | 2489 | p.join() |
Benjamin Peterson | 3095f47 | 2012-09-25 12:45:42 -0400 | [diff] [blame] | 2490 | self.assertRaises(ValueError, p.map_async, sqr, L) |
Richard Oudkerk | d69cfe8 | 2012-06-18 17:47:52 +0100 | [diff] [blame] | 2491 | |
Richard Oudkerk | 8575783 | 2013-05-06 11:38:25 +0100 | [diff] [blame] | 2492 | @classmethod |
| 2493 | def _test_traceback(cls): |
| 2494 | raise RuntimeError(123) # some comment |
| 2495 | |
| 2496 | def test_traceback(self): |
| 2497 | # We want ensure that the traceback from the child process is |
| 2498 | # contained in the traceback raised in the main process. |
| 2499 | if self.TYPE == 'processes': |
| 2500 | with self.Pool(1) as p: |
| 2501 | try: |
| 2502 | p.apply(self._test_traceback) |
| 2503 | except Exception as e: |
| 2504 | exc = e |
| 2505 | else: |
Xiang Zhang | 794623b | 2017-03-29 11:58:54 +0800 | [diff] [blame] | 2506 | self.fail('expected RuntimeError') |
Victor Stinner | 388c8c2 | 2018-12-06 11:56:52 +0100 | [diff] [blame] | 2507 | p.join() |
Richard Oudkerk | 8575783 | 2013-05-06 11:38:25 +0100 | [diff] [blame] | 2508 | self.assertIs(type(exc), RuntimeError) |
| 2509 | self.assertEqual(exc.args, (123,)) |
| 2510 | cause = exc.__cause__ |
| 2511 | self.assertIs(type(cause), multiprocessing.pool.RemoteTraceback) |
| 2512 | self.assertIn('raise RuntimeError(123) # some comment', cause.tb) |
| 2513 | |
| 2514 | with test.support.captured_stderr() as f1: |
| 2515 | try: |
| 2516 | raise exc |
| 2517 | except RuntimeError: |
| 2518 | sys.excepthook(*sys.exc_info()) |
| 2519 | self.assertIn('raise RuntimeError(123) # some comment', |
| 2520 | f1.getvalue()) |
Xiang Zhang | 794623b | 2017-03-29 11:58:54 +0800 | [diff] [blame] | 2521 | # _helper_reraises_exception should not make the error |
| 2522 | # a remote exception |
| 2523 | with self.Pool(1) as p: |
| 2524 | try: |
| 2525 | p.map(sqr, exception_throwing_generator(1, -1), 1) |
| 2526 | except Exception as e: |
| 2527 | exc = e |
| 2528 | else: |
| 2529 | self.fail('expected SayWhenError') |
| 2530 | self.assertIs(type(exc), SayWhenError) |
| 2531 | self.assertIs(exc.__cause__, None) |
Victor Stinner | 388c8c2 | 2018-12-06 11:56:52 +0100 | [diff] [blame] | 2532 | p.join() |
Richard Oudkerk | 8575783 | 2013-05-06 11:38:25 +0100 | [diff] [blame] | 2533 | |
Richard Oudkerk | 80a5be1 | 2014-03-23 12:30:54 +0000 | [diff] [blame] | 2534 | @classmethod |
| 2535 | def _test_wrapped_exception(cls): |
| 2536 | raise RuntimeError('foo') |
| 2537 | |
| 2538 | def test_wrapped_exception(self): |
| 2539 | # Issue #20980: Should not wrap exception when using thread pool |
| 2540 | with self.Pool(1) as p: |
| 2541 | with self.assertRaises(RuntimeError): |
| 2542 | p.apply(self._test_wrapped_exception) |
Victor Stinner | b727873 | 2018-11-28 01:14:31 +0100 | [diff] [blame] | 2543 | p.join() |
Richard Oudkerk | 80a5be1 | 2014-03-23 12:30:54 +0000 | [diff] [blame] | 2544 | |
Charles-François Natali | 78f55ff | 2016-02-10 22:58:18 +0000 | [diff] [blame] | 2545 | def test_map_no_failfast(self): |
| 2546 | # Issue #23992: the fail-fast behaviour when an exception is raised |
| 2547 | # during map() would make Pool.join() deadlock, because a worker |
| 2548 | # process would fill the result queue (after the result handler thread |
| 2549 | # terminated, hence not draining it anymore). |
| 2550 | |
Victor Stinner | 2cf4c20 | 2018-12-17 09:36:36 +0100 | [diff] [blame] | 2551 | t_start = time.monotonic() |
Charles-François Natali | 78f55ff | 2016-02-10 22:58:18 +0000 | [diff] [blame] | 2552 | |
| 2553 | with self.assertRaises(ValueError): |
| 2554 | with self.Pool(2) as p: |
| 2555 | try: |
| 2556 | p.map(raise_large_valuerror, [0, 1]) |
| 2557 | finally: |
| 2558 | time.sleep(0.5) |
| 2559 | p.close() |
| 2560 | p.join() |
| 2561 | |
| 2562 | # check that we indeed waited for all jobs |
Victor Stinner | 2cf4c20 | 2018-12-17 09:36:36 +0100 | [diff] [blame] | 2563 | self.assertGreater(time.monotonic() - t_start, 0.9) |
Charles-François Natali | 78f55ff | 2016-02-10 22:58:18 +0000 | [diff] [blame] | 2564 | |
Antoine Pitrou | 8988945 | 2017-03-24 13:52:11 +0100 | [diff] [blame] | 2565 | def test_release_task_refs(self): |
| 2566 | # Issue #29861: task arguments and results should not be kept |
| 2567 | # alive after we are done with them. |
| 2568 | objs = [CountedObject() for i in range(10)] |
| 2569 | refs = [weakref.ref(o) for o in objs] |
| 2570 | self.pool.map(identity, objs) |
| 2571 | |
| 2572 | del objs |
Antoine Pitrou | 685cdb9 | 2017-04-14 13:10:00 +0200 | [diff] [blame] | 2573 | time.sleep(DELTA) # let threaded cleanup code run |
Antoine Pitrou | 8988945 | 2017-03-24 13:52:11 +0100 | [diff] [blame] | 2574 | self.assertEqual(set(wr() for wr in refs), {None}) |
| 2575 | # With a process pool, copies of the objects are returned, check |
| 2576 | # they were released too. |
| 2577 | self.assertEqual(CountedObject.n_instances, 0) |
| 2578 | |
Victor Stinner | 08c2ba0 | 2018-12-13 02:15:30 +0100 | [diff] [blame] | 2579 | def test_enter(self): |
| 2580 | if self.TYPE == 'manager': |
| 2581 | self.skipTest("test not applicable to manager") |
| 2582 | |
| 2583 | pool = self.Pool(1) |
| 2584 | with pool: |
| 2585 | pass |
| 2586 | # call pool.terminate() |
| 2587 | # pool is no longer running |
| 2588 | |
| 2589 | with self.assertRaises(ValueError): |
| 2590 | # bpo-35477: pool.__enter__() fails if the pool is not running |
| 2591 | with pool: |
| 2592 | pass |
| 2593 | pool.join() |
| 2594 | |
Victor Stinner | 9a8d1d7 | 2018-12-20 20:33:51 +0100 | [diff] [blame] | 2595 | def test_resource_warning(self): |
| 2596 | if self.TYPE == 'manager': |
| 2597 | self.skipTest("test not applicable to manager") |
| 2598 | |
| 2599 | pool = self.Pool(1) |
| 2600 | pool.terminate() |
| 2601 | pool.join() |
| 2602 | |
| 2603 | # force state to RUN to emit ResourceWarning in __del__() |
| 2604 | pool._state = multiprocessing.pool.RUN |
| 2605 | |
| 2606 | with support.check_warnings(('unclosed running multiprocessing pool', |
| 2607 | ResourceWarning)): |
| 2608 | pool = None |
| 2609 | support.gc_collect() |
| 2610 | |
Ask Solem | 2afcbf2 | 2010-11-09 20:55:52 +0000 | [diff] [blame] | 2611 | def raising(): |
| 2612 | raise KeyError("key") |
Jesse Noller | 1f0b658 | 2010-01-27 03:36:01 +0000 | [diff] [blame] | 2613 | |
Ask Solem | 2afcbf2 | 2010-11-09 20:55:52 +0000 | [diff] [blame] | 2614 | def unpickleable_result(): |
| 2615 | return lambda: 42 |
| 2616 | |
| 2617 | class _TestPoolWorkerErrors(BaseTestCase): |
Jesse Noller | 1f0b658 | 2010-01-27 03:36:01 +0000 | [diff] [blame] | 2618 | ALLOWED_TYPES = ('processes', ) |
Ask Solem | 2afcbf2 | 2010-11-09 20:55:52 +0000 | [diff] [blame] | 2619 | |
| 2620 | def test_async_error_callback(self): |
| 2621 | p = multiprocessing.Pool(2) |
| 2622 | |
| 2623 | scratchpad = [None] |
| 2624 | def errback(exc): |
| 2625 | scratchpad[0] = exc |
| 2626 | |
| 2627 | res = p.apply_async(raising, error_callback=errback) |
| 2628 | self.assertRaises(KeyError, res.get) |
| 2629 | self.assertTrue(scratchpad[0]) |
| 2630 | self.assertIsInstance(scratchpad[0], KeyError) |
| 2631 | |
| 2632 | p.close() |
| 2633 | p.join() |
| 2634 | |
| 2635 | def test_unpickleable_result(self): |
| 2636 | from multiprocessing.pool import MaybeEncodingError |
| 2637 | p = multiprocessing.Pool(2) |
| 2638 | |
| 2639 | # Make sure we don't lose pool processes because of encoding errors. |
| 2640 | for iteration in range(20): |
| 2641 | |
| 2642 | scratchpad = [None] |
| 2643 | def errback(exc): |
| 2644 | scratchpad[0] = exc |
| 2645 | |
| 2646 | res = p.apply_async(unpickleable_result, error_callback=errback) |
| 2647 | self.assertRaises(MaybeEncodingError, res.get) |
| 2648 | wrapped = scratchpad[0] |
| 2649 | self.assertTrue(wrapped) |
| 2650 | self.assertIsInstance(scratchpad[0], MaybeEncodingError) |
| 2651 | self.assertIsNotNone(wrapped.exc) |
| 2652 | self.assertIsNotNone(wrapped.value) |
| 2653 | |
| 2654 | p.close() |
| 2655 | p.join() |
| 2656 | |
| 2657 | class _TestPoolWorkerLifetime(BaseTestCase): |
| 2658 | ALLOWED_TYPES = ('processes', ) |
| 2659 | |
Jesse Noller | 1f0b658 | 2010-01-27 03:36:01 +0000 | [diff] [blame] | 2660 | def test_pool_worker_lifetime(self): |
| 2661 | p = multiprocessing.Pool(3, maxtasksperchild=10) |
| 2662 | self.assertEqual(3, len(p._pool)) |
| 2663 | origworkerpids = [w.pid for w in p._pool] |
| 2664 | # Run many tasks so each worker gets replaced (hopefully) |
| 2665 | results = [] |
| 2666 | for i in range(100): |
| 2667 | results.append(p.apply_async(sqr, (i, ))) |
| 2668 | # Fetch the results and verify we got the right answers, |
| 2669 | # also ensuring all the tasks have completed. |
| 2670 | for (j, res) in enumerate(results): |
| 2671 | self.assertEqual(res.get(), sqr(j)) |
| 2672 | # Refill the pool |
| 2673 | p._repopulate_pool() |
Florent Xicluna | fb190f6 | 2010-03-04 16:10:10 +0000 | [diff] [blame] | 2674 | # Wait until all workers are alive |
Antoine Pitrou | 540ab06 | 2011-04-06 22:51:17 +0200 | [diff] [blame] | 2675 | # (countdown * DELTA = 5 seconds max startup process time) |
| 2676 | countdown = 50 |
Florent Xicluna | fb190f6 | 2010-03-04 16:10:10 +0000 | [diff] [blame] | 2677 | while countdown and not all(w.is_alive() for w in p._pool): |
| 2678 | countdown -= 1 |
| 2679 | time.sleep(DELTA) |
Jesse Noller | 1f0b658 | 2010-01-27 03:36:01 +0000 | [diff] [blame] | 2680 | finalworkerpids = [w.pid for w in p._pool] |
Florent Xicluna | fb190f6 | 2010-03-04 16:10:10 +0000 | [diff] [blame] | 2681 | # All pids should be assigned. See issue #7805. |
| 2682 | self.assertNotIn(None, origworkerpids) |
| 2683 | self.assertNotIn(None, finalworkerpids) |
| 2684 | # Finally, check that the worker pids have changed |
Jesse Noller | 1f0b658 | 2010-01-27 03:36:01 +0000 | [diff] [blame] | 2685 | self.assertNotEqual(sorted(origworkerpids), sorted(finalworkerpids)) |
| 2686 | p.close() |
| 2687 | p.join() |
| 2688 | |
Charles-François Natali | f8859e1 | 2011-10-24 18:45:29 +0200 | [diff] [blame] | 2689 | def test_pool_worker_lifetime_early_close(self): |
| 2690 | # Issue #10332: closing a pool whose workers have limited lifetimes |
| 2691 | # before all the tasks completed would make join() hang. |
| 2692 | p = multiprocessing.Pool(3, maxtasksperchild=1) |
| 2693 | results = [] |
| 2694 | for i in range(6): |
| 2695 | results.append(p.apply_async(sqr, (i, 0.3))) |
| 2696 | p.close() |
| 2697 | p.join() |
| 2698 | # check the results |
| 2699 | for (j, res) in enumerate(results): |
| 2700 | self.assertEqual(res.get(), sqr(j)) |
| 2701 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2702 | # |
| 2703 | # Test of creating a customized manager class |
| 2704 | # |
| 2705 | |
| 2706 | from multiprocessing.managers import BaseManager, BaseProxy, RemoteError |
| 2707 | |
| 2708 | class FooBar(object): |
| 2709 | def f(self): |
| 2710 | return 'f()' |
| 2711 | def g(self): |
| 2712 | raise ValueError |
| 2713 | def _h(self): |
| 2714 | return '_h()' |
| 2715 | |
| 2716 | def baz(): |
| 2717 | for i in range(10): |
| 2718 | yield i*i |
| 2719 | |
| 2720 | class IteratorProxy(BaseProxy): |
Florent Xicluna | aa17106 | 2010-08-14 15:56:42 +0000 | [diff] [blame] | 2721 | _exposed_ = ('__next__',) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2722 | def __iter__(self): |
| 2723 | return self |
| 2724 | def __next__(self): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2725 | return self._callmethod('__next__') |
| 2726 | |
| 2727 | class MyManager(BaseManager): |
| 2728 | pass |
| 2729 | |
| 2730 | MyManager.register('Foo', callable=FooBar) |
| 2731 | MyManager.register('Bar', callable=FooBar, exposed=('f', '_h')) |
| 2732 | MyManager.register('baz', callable=baz, proxytype=IteratorProxy) |
| 2733 | |
| 2734 | |
| 2735 | class _TestMyManager(BaseTestCase): |
| 2736 | |
| 2737 | ALLOWED_TYPES = ('manager',) |
| 2738 | |
| 2739 | def test_mymanager(self): |
| 2740 | manager = MyManager() |
| 2741 | manager.start() |
Richard Oudkerk | ac38571 | 2012-06-18 21:29:30 +0100 | [diff] [blame] | 2742 | self.common(manager) |
| 2743 | manager.shutdown() |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2744 | |
Richard Oudkerk | ac38571 | 2012-06-18 21:29:30 +0100 | [diff] [blame] | 2745 | # If the manager process exited cleanly then the exitcode |
| 2746 | # will be zero. Otherwise (after a short timeout) |
| 2747 | # terminate() is used, resulting in an exitcode of -SIGTERM. |
| 2748 | self.assertEqual(manager._process.exitcode, 0) |
| 2749 | |
| 2750 | def test_mymanager_context(self): |
| 2751 | with MyManager() as manager: |
| 2752 | self.common(manager) |
Victor Stinner | fbd7172 | 2018-06-27 18:18:10 +0200 | [diff] [blame] | 2753 | # bpo-30356: BaseManager._finalize_manager() sends SIGTERM |
| 2754 | # to the manager process if it takes longer than 1 second to stop. |
| 2755 | self.assertIn(manager._process.exitcode, (0, -signal.SIGTERM)) |
Richard Oudkerk | ac38571 | 2012-06-18 21:29:30 +0100 | [diff] [blame] | 2756 | |
| 2757 | def test_mymanager_context_prestarted(self): |
| 2758 | manager = MyManager() |
| 2759 | manager.start() |
| 2760 | with manager: |
| 2761 | self.common(manager) |
| 2762 | self.assertEqual(manager._process.exitcode, 0) |
| 2763 | |
| 2764 | def common(self, manager): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2765 | foo = manager.Foo() |
| 2766 | bar = manager.Bar() |
| 2767 | baz = manager.baz() |
| 2768 | |
| 2769 | foo_methods = [name for name in ('f', 'g', '_h') if hasattr(foo, name)] |
| 2770 | bar_methods = [name for name in ('f', 'g', '_h') if hasattr(bar, name)] |
| 2771 | |
| 2772 | self.assertEqual(foo_methods, ['f', 'g']) |
| 2773 | self.assertEqual(bar_methods, ['f', '_h']) |
| 2774 | |
| 2775 | self.assertEqual(foo.f(), 'f()') |
| 2776 | self.assertRaises(ValueError, foo.g) |
| 2777 | self.assertEqual(foo._callmethod('f'), 'f()') |
| 2778 | self.assertRaises(RemoteError, foo._callmethod, '_h') |
| 2779 | |
| 2780 | self.assertEqual(bar.f(), 'f()') |
| 2781 | self.assertEqual(bar._h(), '_h()') |
| 2782 | self.assertEqual(bar._callmethod('f'), 'f()') |
| 2783 | self.assertEqual(bar._callmethod('_h'), '_h()') |
| 2784 | |
| 2785 | self.assertEqual(list(baz), [i*i for i in range(10)]) |
| 2786 | |
Richard Oudkerk | 73d9a29 | 2012-06-14 15:30:10 +0100 | [diff] [blame] | 2787 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2788 | # |
| 2789 | # Test of connecting to a remote server and using xmlrpclib for serialization |
| 2790 | # |
| 2791 | |
| 2792 | _queue = pyqueue.Queue() |
| 2793 | def get_queue(): |
| 2794 | return _queue |
| 2795 | |
| 2796 | class QueueManager(BaseManager): |
| 2797 | '''manager class used by server process''' |
| 2798 | QueueManager.register('get_queue', callable=get_queue) |
| 2799 | |
| 2800 | class QueueManager2(BaseManager): |
| 2801 | '''manager class which specifies the same interface as QueueManager''' |
| 2802 | QueueManager2.register('get_queue') |
| 2803 | |
| 2804 | |
| 2805 | SERIALIZER = 'xmlrpclib' |
| 2806 | |
| 2807 | class _TestRemoteManager(BaseTestCase): |
| 2808 | |
| 2809 | ALLOWED_TYPES = ('manager',) |
Serhiy Storchaka | a25c542 | 2015-02-13 15:13:33 +0200 | [diff] [blame] | 2810 | values = ['hello world', None, True, 2.25, |
| 2811 | 'hall\xe5 v\xe4rlden', |
| 2812 | '\u043f\u0440\u0438\u0432\u0456\u0442 \u0441\u0432\u0456\u0442', |
| 2813 | b'hall\xe5 v\xe4rlden', |
| 2814 | ] |
| 2815 | result = values[:] |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2816 | |
Antoine Pitrou | 0d1b38c | 2010-11-02 23:50:11 +0000 | [diff] [blame] | 2817 | @classmethod |
| 2818 | def _putter(cls, address, authkey): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2819 | manager = QueueManager2( |
| 2820 | address=address, authkey=authkey, serializer=SERIALIZER |
| 2821 | ) |
| 2822 | manager.connect() |
| 2823 | queue = manager.get_queue() |
Serhiy Storchaka | a25c542 | 2015-02-13 15:13:33 +0200 | [diff] [blame] | 2824 | # Note that xmlrpclib will deserialize object as a list not a tuple |
| 2825 | queue.put(tuple(cls.values)) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2826 | |
| 2827 | def test_remote(self): |
| 2828 | authkey = os.urandom(32) |
| 2829 | |
| 2830 | manager = QueueManager( |
Antoine Pitrou | f6fbf56 | 2013-08-22 00:39:46 +0200 | [diff] [blame] | 2831 | address=(test.support.HOST, 0), authkey=authkey, serializer=SERIALIZER |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2832 | ) |
| 2833 | manager.start() |
Pablo Galindo | 7b2a37b | 2019-02-09 17:35:05 +0000 | [diff] [blame] | 2834 | self.addCleanup(manager.shutdown) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2835 | |
| 2836 | p = self.Process(target=self._putter, args=(manager.address, authkey)) |
Jesus Cea | 94f964f | 2011-09-09 20:26:57 +0200 | [diff] [blame] | 2837 | p.daemon = True |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2838 | p.start() |
| 2839 | |
| 2840 | manager2 = QueueManager2( |
| 2841 | address=manager.address, authkey=authkey, serializer=SERIALIZER |
| 2842 | ) |
| 2843 | manager2.connect() |
| 2844 | queue = manager2.get_queue() |
| 2845 | |
Serhiy Storchaka | a25c542 | 2015-02-13 15:13:33 +0200 | [diff] [blame] | 2846 | self.assertEqual(queue.get(), self.result) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2847 | |
| 2848 | # Because we are using xmlrpclib for serialization instead of |
| 2849 | # pickle this will cause a serialization error. |
| 2850 | self.assertRaises(Exception, queue.put, time.sleep) |
| 2851 | |
| 2852 | # Make queue finalizer run before the server is stopped |
| 2853 | del queue |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2854 | |
Jesse Noller | c5d28a0 | 2009-03-30 16:37:36 +0000 | [diff] [blame] | 2855 | class _TestManagerRestart(BaseTestCase): |
| 2856 | |
Antoine Pitrou | 0d1b38c | 2010-11-02 23:50:11 +0000 | [diff] [blame] | 2857 | @classmethod |
| 2858 | def _putter(cls, address, authkey): |
Jesse Noller | c5d28a0 | 2009-03-30 16:37:36 +0000 | [diff] [blame] | 2859 | manager = QueueManager( |
| 2860 | address=address, authkey=authkey, serializer=SERIALIZER) |
| 2861 | manager.connect() |
| 2862 | queue = manager.get_queue() |
| 2863 | queue.put('hello world') |
| 2864 | |
| 2865 | def test_rapid_restart(self): |
| 2866 | authkey = os.urandom(32) |
| 2867 | manager = QueueManager( |
Antoine Pitrou | f6fbf56 | 2013-08-22 00:39:46 +0200 | [diff] [blame] | 2868 | address=(test.support.HOST, 0), authkey=authkey, serializer=SERIALIZER) |
Pablo Galindo | 7b2a37b | 2019-02-09 17:35:05 +0000 | [diff] [blame] | 2869 | try: |
| 2870 | srvr = manager.get_server() |
| 2871 | addr = srvr.address |
| 2872 | # Close the connection.Listener socket which gets opened as a part |
| 2873 | # of manager.get_server(). It's not needed for the test. |
| 2874 | srvr.listener.close() |
| 2875 | manager.start() |
Jesse Noller | c5d28a0 | 2009-03-30 16:37:36 +0000 | [diff] [blame] | 2876 | |
Pablo Galindo | 7b2a37b | 2019-02-09 17:35:05 +0000 | [diff] [blame] | 2877 | p = self.Process(target=self._putter, args=(manager.address, authkey)) |
| 2878 | p.start() |
| 2879 | p.join() |
| 2880 | queue = manager.get_queue() |
| 2881 | self.assertEqual(queue.get(), 'hello world') |
| 2882 | del queue |
| 2883 | finally: |
| 2884 | if hasattr(manager, "shutdown"): |
| 2885 | manager.shutdown() |
Victor Stinner | 17657bb | 2017-08-16 12:46:04 +0200 | [diff] [blame] | 2886 | |
Jesse Noller | c5d28a0 | 2009-03-30 16:37:36 +0000 | [diff] [blame] | 2887 | manager = QueueManager( |
Antoine Pitrou | 043bad0 | 2010-04-30 23:20:15 +0000 | [diff] [blame] | 2888 | address=addr, authkey=authkey, serializer=SERIALIZER) |
Antoine Pitrou | c824e9a | 2011-04-05 18:11:33 +0200 | [diff] [blame] | 2889 | try: |
| 2890 | manager.start() |
Pablo Galindo | 7b2a37b | 2019-02-09 17:35:05 +0000 | [diff] [blame] | 2891 | self.addCleanup(manager.shutdown) |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 2892 | except OSError as e: |
Antoine Pitrou | c824e9a | 2011-04-05 18:11:33 +0200 | [diff] [blame] | 2893 | if e.errno != errno.EADDRINUSE: |
| 2894 | raise |
| 2895 | # Retry after some time, in case the old socket was lingering |
| 2896 | # (sporadic failure on buildbots) |
| 2897 | time.sleep(1.0) |
| 2898 | manager = QueueManager( |
| 2899 | address=addr, authkey=authkey, serializer=SERIALIZER) |
Pablo Galindo | 7b2a37b | 2019-02-09 17:35:05 +0000 | [diff] [blame] | 2900 | if hasattr(manager, "shutdown"): |
| 2901 | self.addCleanup(manager.shutdown) |
Jesse Noller | c5d28a0 | 2009-03-30 16:37:36 +0000 | [diff] [blame] | 2902 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2903 | # |
| 2904 | # |
| 2905 | # |
| 2906 | |
| 2907 | SENTINEL = latin('') |
| 2908 | |
| 2909 | class _TestConnection(BaseTestCase): |
| 2910 | |
| 2911 | ALLOWED_TYPES = ('processes', 'threads') |
| 2912 | |
Antoine Pitrou | 0d1b38c | 2010-11-02 23:50:11 +0000 | [diff] [blame] | 2913 | @classmethod |
| 2914 | def _echo(cls, conn): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2915 | for msg in iter(conn.recv_bytes, SENTINEL): |
| 2916 | conn.send_bytes(msg) |
| 2917 | conn.close() |
| 2918 | |
| 2919 | def test_connection(self): |
| 2920 | conn, child_conn = self.Pipe() |
| 2921 | |
| 2922 | p = self.Process(target=self._echo, args=(child_conn,)) |
Benjamin Peterson | 58ea9fe | 2008-08-19 19:17:39 +0000 | [diff] [blame] | 2923 | p.daemon = True |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2924 | p.start() |
| 2925 | |
| 2926 | seq = [1, 2.25, None] |
| 2927 | msg = latin('hello world') |
| 2928 | longmsg = msg * 10 |
| 2929 | arr = array.array('i', list(range(4))) |
| 2930 | |
| 2931 | if self.TYPE == 'processes': |
| 2932 | self.assertEqual(type(conn.fileno()), int) |
| 2933 | |
| 2934 | self.assertEqual(conn.send(seq), None) |
| 2935 | self.assertEqual(conn.recv(), seq) |
| 2936 | |
| 2937 | self.assertEqual(conn.send_bytes(msg), None) |
| 2938 | self.assertEqual(conn.recv_bytes(), msg) |
| 2939 | |
| 2940 | if self.TYPE == 'processes': |
| 2941 | buffer = array.array('i', [0]*10) |
| 2942 | expected = list(arr) + [0] * (10 - len(arr)) |
| 2943 | self.assertEqual(conn.send_bytes(arr), None) |
| 2944 | self.assertEqual(conn.recv_bytes_into(buffer), |
| 2945 | len(arr) * buffer.itemsize) |
| 2946 | self.assertEqual(list(buffer), expected) |
| 2947 | |
| 2948 | buffer = array.array('i', [0]*10) |
| 2949 | expected = [0] * 3 + list(arr) + [0] * (10 - 3 - len(arr)) |
| 2950 | self.assertEqual(conn.send_bytes(arr), None) |
| 2951 | self.assertEqual(conn.recv_bytes_into(buffer, 3 * buffer.itemsize), |
| 2952 | len(arr) * buffer.itemsize) |
| 2953 | self.assertEqual(list(buffer), expected) |
| 2954 | |
| 2955 | buffer = bytearray(latin(' ' * 40)) |
| 2956 | self.assertEqual(conn.send_bytes(longmsg), None) |
| 2957 | try: |
| 2958 | res = conn.recv_bytes_into(buffer) |
| 2959 | except multiprocessing.BufferTooShort as e: |
| 2960 | self.assertEqual(e.args, (longmsg,)) |
| 2961 | else: |
| 2962 | self.fail('expected BufferTooShort, got %s' % res) |
| 2963 | |
| 2964 | poll = TimingWrapper(conn.poll) |
| 2965 | |
| 2966 | self.assertEqual(poll(), False) |
| 2967 | self.assertTimingAlmostEqual(poll.elapsed, 0) |
| 2968 | |
Richard Oudkerk | 59d5404 | 2012-05-10 16:11:12 +0100 | [diff] [blame] | 2969 | self.assertEqual(poll(-1), False) |
| 2970 | self.assertTimingAlmostEqual(poll.elapsed, 0) |
| 2971 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2972 | self.assertEqual(poll(TIMEOUT1), False) |
| 2973 | self.assertTimingAlmostEqual(poll.elapsed, TIMEOUT1) |
| 2974 | |
| 2975 | conn.send(None) |
Giampaolo Rodola' | 5e844c8 | 2012-12-31 17:23:09 +0100 | [diff] [blame] | 2976 | time.sleep(.1) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 2977 | |
| 2978 | self.assertEqual(poll(TIMEOUT1), True) |
| 2979 | self.assertTimingAlmostEqual(poll.elapsed, 0) |
| 2980 | |
| 2981 | self.assertEqual(conn.recv(), None) |
| 2982 | |
| 2983 | really_big_msg = latin('X') * (1024 * 1024 * 16) # 16Mb |
| 2984 | conn.send_bytes(really_big_msg) |
| 2985 | self.assertEqual(conn.recv_bytes(), really_big_msg) |
| 2986 | |
| 2987 | conn.send_bytes(SENTINEL) # tell child to quit |
| 2988 | child_conn.close() |
| 2989 | |
| 2990 | if self.TYPE == 'processes': |
| 2991 | self.assertEqual(conn.readable, True) |
| 2992 | self.assertEqual(conn.writable, True) |
| 2993 | self.assertRaises(EOFError, conn.recv) |
| 2994 | self.assertRaises(EOFError, conn.recv_bytes) |
| 2995 | |
| 2996 | p.join() |
| 2997 | |
| 2998 | def test_duplex_false(self): |
| 2999 | reader, writer = self.Pipe(duplex=False) |
| 3000 | self.assertEqual(writer.send(1), None) |
| 3001 | self.assertEqual(reader.recv(), 1) |
| 3002 | if self.TYPE == 'processes': |
| 3003 | self.assertEqual(reader.readable, True) |
| 3004 | self.assertEqual(reader.writable, False) |
| 3005 | self.assertEqual(writer.readable, False) |
| 3006 | self.assertEqual(writer.writable, True) |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 3007 | self.assertRaises(OSError, reader.send, 2) |
| 3008 | self.assertRaises(OSError, writer.recv) |
| 3009 | self.assertRaises(OSError, writer.poll) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3010 | |
| 3011 | def test_spawn_close(self): |
| 3012 | # We test that a pipe connection can be closed by parent |
| 3013 | # process immediately after child is spawned. On Windows this |
| 3014 | # would have sometimes failed on old versions because |
| 3015 | # child_conn would be closed before the child got a chance to |
| 3016 | # duplicate it. |
| 3017 | conn, child_conn = self.Pipe() |
| 3018 | |
| 3019 | p = self.Process(target=self._echo, args=(child_conn,)) |
Jesus Cea | 94f964f | 2011-09-09 20:26:57 +0200 | [diff] [blame] | 3020 | p.daemon = True |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3021 | p.start() |
| 3022 | child_conn.close() # this might complete before child initializes |
| 3023 | |
| 3024 | msg = latin('hello') |
| 3025 | conn.send_bytes(msg) |
| 3026 | self.assertEqual(conn.recv_bytes(), msg) |
| 3027 | |
| 3028 | conn.send_bytes(SENTINEL) |
| 3029 | conn.close() |
| 3030 | p.join() |
| 3031 | |
| 3032 | def test_sendbytes(self): |
| 3033 | if self.TYPE != 'processes': |
Zachary Ware | 9fe6d86 | 2013-12-08 00:20:35 -0600 | [diff] [blame] | 3034 | self.skipTest('test not appropriate for {}'.format(self.TYPE)) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3035 | |
| 3036 | msg = latin('abcdefghijklmnopqrstuvwxyz') |
| 3037 | a, b = self.Pipe() |
| 3038 | |
| 3039 | a.send_bytes(msg) |
| 3040 | self.assertEqual(b.recv_bytes(), msg) |
| 3041 | |
| 3042 | a.send_bytes(msg, 5) |
| 3043 | self.assertEqual(b.recv_bytes(), msg[5:]) |
| 3044 | |
| 3045 | a.send_bytes(msg, 7, 8) |
| 3046 | self.assertEqual(b.recv_bytes(), msg[7:7+8]) |
| 3047 | |
| 3048 | a.send_bytes(msg, 26) |
| 3049 | self.assertEqual(b.recv_bytes(), latin('')) |
| 3050 | |
| 3051 | a.send_bytes(msg, 26, 0) |
| 3052 | self.assertEqual(b.recv_bytes(), latin('')) |
| 3053 | |
| 3054 | self.assertRaises(ValueError, a.send_bytes, msg, 27) |
| 3055 | |
| 3056 | self.assertRaises(ValueError, a.send_bytes, msg, 22, 5) |
| 3057 | |
| 3058 | self.assertRaises(ValueError, a.send_bytes, msg, 26, 1) |
| 3059 | |
| 3060 | self.assertRaises(ValueError, a.send_bytes, msg, -1) |
| 3061 | |
| 3062 | self.assertRaises(ValueError, a.send_bytes, msg, 4, -1) |
| 3063 | |
Antoine Pitrou | bcb39d4 | 2011-08-23 19:46:22 +0200 | [diff] [blame] | 3064 | @classmethod |
| 3065 | def _is_fd_assigned(cls, fd): |
| 3066 | try: |
| 3067 | os.fstat(fd) |
| 3068 | except OSError as e: |
| 3069 | if e.errno == errno.EBADF: |
| 3070 | return False |
| 3071 | raise |
| 3072 | else: |
| 3073 | return True |
| 3074 | |
| 3075 | @classmethod |
| 3076 | def _writefd(cls, conn, data, create_dummy_fds=False): |
| 3077 | if create_dummy_fds: |
| 3078 | for i in range(0, 256): |
| 3079 | if not cls._is_fd_assigned(i): |
| 3080 | os.dup2(conn.fileno(), i) |
| 3081 | fd = reduction.recv_handle(conn) |
| 3082 | if msvcrt: |
| 3083 | fd = msvcrt.open_osfhandle(fd, os.O_WRONLY) |
| 3084 | os.write(fd, data) |
| 3085 | os.close(fd) |
| 3086 | |
Charles-François Natali | bc8f082 | 2011-09-20 20:36:51 +0200 | [diff] [blame] | 3087 | @unittest.skipUnless(HAS_REDUCTION, "test needs multiprocessing.reduction") |
Antoine Pitrou | bcb39d4 | 2011-08-23 19:46:22 +0200 | [diff] [blame] | 3088 | def test_fd_transfer(self): |
| 3089 | if self.TYPE != 'processes': |
| 3090 | self.skipTest("only makes sense with processes") |
| 3091 | conn, child_conn = self.Pipe(duplex=True) |
| 3092 | |
| 3093 | p = self.Process(target=self._writefd, args=(child_conn, b"foo")) |
Jesus Cea | 94f964f | 2011-09-09 20:26:57 +0200 | [diff] [blame] | 3094 | p.daemon = True |
Antoine Pitrou | bcb39d4 | 2011-08-23 19:46:22 +0200 | [diff] [blame] | 3095 | p.start() |
Victor Stinner | d0b10a6 | 2011-09-21 01:10:29 +0200 | [diff] [blame] | 3096 | self.addCleanup(test.support.unlink, test.support.TESTFN) |
Antoine Pitrou | bcb39d4 | 2011-08-23 19:46:22 +0200 | [diff] [blame] | 3097 | with open(test.support.TESTFN, "wb") as f: |
| 3098 | fd = f.fileno() |
| 3099 | if msvcrt: |
| 3100 | fd = msvcrt.get_osfhandle(fd) |
| 3101 | reduction.send_handle(conn, fd, p.pid) |
| 3102 | p.join() |
| 3103 | with open(test.support.TESTFN, "rb") as f: |
| 3104 | self.assertEqual(f.read(), b"foo") |
| 3105 | |
Charles-François Natali | bc8f082 | 2011-09-20 20:36:51 +0200 | [diff] [blame] | 3106 | @unittest.skipUnless(HAS_REDUCTION, "test needs multiprocessing.reduction") |
Antoine Pitrou | bcb39d4 | 2011-08-23 19:46:22 +0200 | [diff] [blame] | 3107 | @unittest.skipIf(sys.platform == "win32", |
| 3108 | "test semantics don't make sense on Windows") |
| 3109 | @unittest.skipIf(MAXFD <= 256, |
| 3110 | "largest assignable fd number is too small") |
| 3111 | @unittest.skipUnless(hasattr(os, "dup2"), |
| 3112 | "test needs os.dup2()") |
| 3113 | def test_large_fd_transfer(self): |
| 3114 | # With fd > 256 (issue #11657) |
| 3115 | if self.TYPE != 'processes': |
| 3116 | self.skipTest("only makes sense with processes") |
| 3117 | conn, child_conn = self.Pipe(duplex=True) |
| 3118 | |
| 3119 | p = self.Process(target=self._writefd, args=(child_conn, b"bar", True)) |
Jesus Cea | 94f964f | 2011-09-09 20:26:57 +0200 | [diff] [blame] | 3120 | p.daemon = True |
Antoine Pitrou | bcb39d4 | 2011-08-23 19:46:22 +0200 | [diff] [blame] | 3121 | p.start() |
Victor Stinner | d0b10a6 | 2011-09-21 01:10:29 +0200 | [diff] [blame] | 3122 | self.addCleanup(test.support.unlink, test.support.TESTFN) |
Antoine Pitrou | bcb39d4 | 2011-08-23 19:46:22 +0200 | [diff] [blame] | 3123 | with open(test.support.TESTFN, "wb") as f: |
| 3124 | fd = f.fileno() |
| 3125 | for newfd in range(256, MAXFD): |
| 3126 | if not self._is_fd_assigned(newfd): |
| 3127 | break |
| 3128 | else: |
| 3129 | self.fail("could not find an unassigned large file descriptor") |
| 3130 | os.dup2(fd, newfd) |
| 3131 | try: |
| 3132 | reduction.send_handle(conn, newfd, p.pid) |
| 3133 | finally: |
| 3134 | os.close(newfd) |
| 3135 | p.join() |
| 3136 | with open(test.support.TESTFN, "rb") as f: |
| 3137 | self.assertEqual(f.read(), b"bar") |
| 3138 | |
Jesus Cea | 4507e64 | 2011-09-21 03:53:25 +0200 | [diff] [blame] | 3139 | @classmethod |
| 3140 | def _send_data_without_fd(self, conn): |
| 3141 | os.write(conn.fileno(), b"\0") |
| 3142 | |
Charles-François Natali | e51c8da | 2011-09-21 18:48:21 +0200 | [diff] [blame] | 3143 | @unittest.skipUnless(HAS_REDUCTION, "test needs multiprocessing.reduction") |
Jesus Cea | 4507e64 | 2011-09-21 03:53:25 +0200 | [diff] [blame] | 3144 | @unittest.skipIf(sys.platform == "win32", "doesn't make sense on Windows") |
| 3145 | def test_missing_fd_transfer(self): |
| 3146 | # Check that exception is raised when received data is not |
| 3147 | # accompanied by a file descriptor in ancillary data. |
| 3148 | if self.TYPE != 'processes': |
| 3149 | self.skipTest("only makes sense with processes") |
| 3150 | conn, child_conn = self.Pipe(duplex=True) |
| 3151 | |
| 3152 | p = self.Process(target=self._send_data_without_fd, args=(child_conn,)) |
| 3153 | p.daemon = True |
| 3154 | p.start() |
| 3155 | self.assertRaises(RuntimeError, reduction.recv_handle, conn) |
| 3156 | p.join() |
Antoine Pitrou | bcb39d4 | 2011-08-23 19:46:22 +0200 | [diff] [blame] | 3157 | |
Richard Oudkerk | d69cfe8 | 2012-06-18 17:47:52 +0100 | [diff] [blame] | 3158 | def test_context(self): |
| 3159 | a, b = self.Pipe() |
| 3160 | |
| 3161 | with a, b: |
| 3162 | a.send(1729) |
| 3163 | self.assertEqual(b.recv(), 1729) |
| 3164 | if self.TYPE == 'processes': |
| 3165 | self.assertFalse(a.closed) |
| 3166 | self.assertFalse(b.closed) |
| 3167 | |
| 3168 | if self.TYPE == 'processes': |
| 3169 | self.assertTrue(a.closed) |
| 3170 | self.assertTrue(b.closed) |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 3171 | self.assertRaises(OSError, a.recv) |
| 3172 | self.assertRaises(OSError, b.recv) |
Richard Oudkerk | d69cfe8 | 2012-06-18 17:47:52 +0100 | [diff] [blame] | 3173 | |
Charles-François Natali | ed4a8fc | 2012-02-08 21:15:58 +0100 | [diff] [blame] | 3174 | class _TestListener(BaseTestCase): |
| 3175 | |
Richard Oudkerk | 9125775 | 2012-06-15 21:53:34 +0100 | [diff] [blame] | 3176 | ALLOWED_TYPES = ('processes',) |
Charles-François Natali | ed4a8fc | 2012-02-08 21:15:58 +0100 | [diff] [blame] | 3177 | |
| 3178 | def test_multiple_bind(self): |
| 3179 | for family in self.connection.families: |
| 3180 | l = self.connection.Listener(family=family) |
| 3181 | self.addCleanup(l.close) |
| 3182 | self.assertRaises(OSError, self.connection.Listener, |
| 3183 | l.address, family) |
| 3184 | |
Richard Oudkerk | d69cfe8 | 2012-06-18 17:47:52 +0100 | [diff] [blame] | 3185 | def test_context(self): |
| 3186 | with self.connection.Listener() as l: |
| 3187 | with self.connection.Client(l.address) as c: |
| 3188 | with l.accept() as d: |
| 3189 | c.send(1729) |
| 3190 | self.assertEqual(d.recv(), 1729) |
| 3191 | |
| 3192 | if self.TYPE == 'processes': |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 3193 | self.assertRaises(OSError, l.accept) |
Richard Oudkerk | d69cfe8 | 2012-06-18 17:47:52 +0100 | [diff] [blame] | 3194 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3195 | class _TestListenerClient(BaseTestCase): |
| 3196 | |
| 3197 | ALLOWED_TYPES = ('processes', 'threads') |
| 3198 | |
Antoine Pitrou | 0d1b38c | 2010-11-02 23:50:11 +0000 | [diff] [blame] | 3199 | @classmethod |
| 3200 | def _test(cls, address): |
| 3201 | conn = cls.connection.Client(address) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3202 | conn.send('hello') |
| 3203 | conn.close() |
| 3204 | |
| 3205 | def test_listener_client(self): |
| 3206 | for family in self.connection.families: |
| 3207 | l = self.connection.Listener(family=family) |
| 3208 | p = self.Process(target=self._test, args=(l.address,)) |
Benjamin Peterson | 58ea9fe | 2008-08-19 19:17:39 +0000 | [diff] [blame] | 3209 | p.daemon = True |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3210 | p.start() |
| 3211 | conn = l.accept() |
| 3212 | self.assertEqual(conn.recv(), 'hello') |
| 3213 | p.join() |
| 3214 | l.close() |
Charles-François Natali | ed4a8fc | 2012-02-08 21:15:58 +0100 | [diff] [blame] | 3215 | |
Richard Oudkerk | fdb8dcf | 2012-05-05 19:45:37 +0100 | [diff] [blame] | 3216 | def test_issue14725(self): |
| 3217 | l = self.connection.Listener() |
| 3218 | p = self.Process(target=self._test, args=(l.address,)) |
| 3219 | p.daemon = True |
| 3220 | p.start() |
| 3221 | time.sleep(1) |
| 3222 | # On Windows the client process should by now have connected, |
| 3223 | # written data and closed the pipe handle by now. This causes |
| 3224 | # ConnectNamdedPipe() to fail with ERROR_NO_DATA. See Issue |
| 3225 | # 14725. |
| 3226 | conn = l.accept() |
| 3227 | self.assertEqual(conn.recv(), 'hello') |
| 3228 | conn.close() |
| 3229 | p.join() |
| 3230 | l.close() |
| 3231 | |
Richard Oudkerk | ed9e06c | 2013-01-13 22:46:48 +0000 | [diff] [blame] | 3232 | def test_issue16955(self): |
| 3233 | for fam in self.connection.families: |
| 3234 | l = self.connection.Listener(family=fam) |
| 3235 | c = self.connection.Client(l.address) |
| 3236 | a = l.accept() |
| 3237 | a.send_bytes(b"hello") |
| 3238 | self.assertTrue(c.poll(1)) |
| 3239 | a.close() |
| 3240 | c.close() |
| 3241 | l.close() |
| 3242 | |
Richard Oudkerk | d15642e | 2013-07-16 15:33:41 +0100 | [diff] [blame] | 3243 | class _TestPoll(BaseTestCase): |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 3244 | |
| 3245 | ALLOWED_TYPES = ('processes', 'threads') |
| 3246 | |
| 3247 | def test_empty_string(self): |
| 3248 | a, b = self.Pipe() |
| 3249 | self.assertEqual(a.poll(), False) |
| 3250 | b.send_bytes(b'') |
| 3251 | self.assertEqual(a.poll(), True) |
| 3252 | self.assertEqual(a.poll(), True) |
| 3253 | |
| 3254 | @classmethod |
| 3255 | def _child_strings(cls, conn, strings): |
| 3256 | for s in strings: |
| 3257 | time.sleep(0.1) |
| 3258 | conn.send_bytes(s) |
| 3259 | conn.close() |
| 3260 | |
| 3261 | def test_strings(self): |
| 3262 | strings = (b'hello', b'', b'a', b'b', b'', b'bye', b'', b'lop') |
| 3263 | a, b = self.Pipe() |
| 3264 | p = self.Process(target=self._child_strings, args=(b, strings)) |
| 3265 | p.start() |
| 3266 | |
| 3267 | for s in strings: |
| 3268 | for i in range(200): |
| 3269 | if a.poll(0.01): |
| 3270 | break |
| 3271 | x = a.recv_bytes() |
| 3272 | self.assertEqual(s, x) |
| 3273 | |
| 3274 | p.join() |
| 3275 | |
| 3276 | @classmethod |
| 3277 | def _child_boundaries(cls, r): |
| 3278 | # Polling may "pull" a message in to the child process, but we |
| 3279 | # don't want it to pull only part of a message, as that would |
| 3280 | # corrupt the pipe for any other processes which might later |
| 3281 | # read from it. |
| 3282 | r.poll(5) |
| 3283 | |
| 3284 | def test_boundaries(self): |
| 3285 | r, w = self.Pipe(False) |
| 3286 | p = self.Process(target=self._child_boundaries, args=(r,)) |
| 3287 | p.start() |
| 3288 | time.sleep(2) |
| 3289 | L = [b"first", b"second"] |
| 3290 | for obj in L: |
| 3291 | w.send_bytes(obj) |
| 3292 | w.close() |
| 3293 | p.join() |
| 3294 | self.assertIn(r.recv_bytes(), L) |
| 3295 | |
| 3296 | @classmethod |
| 3297 | def _child_dont_merge(cls, b): |
| 3298 | b.send_bytes(b'a') |
| 3299 | b.send_bytes(b'b') |
| 3300 | b.send_bytes(b'cd') |
| 3301 | |
| 3302 | def test_dont_merge(self): |
| 3303 | a, b = self.Pipe() |
| 3304 | self.assertEqual(a.poll(0.0), False) |
| 3305 | self.assertEqual(a.poll(0.1), False) |
| 3306 | |
| 3307 | p = self.Process(target=self._child_dont_merge, args=(b,)) |
| 3308 | p.start() |
| 3309 | |
| 3310 | self.assertEqual(a.recv_bytes(), b'a') |
| 3311 | self.assertEqual(a.poll(1.0), True) |
| 3312 | self.assertEqual(a.poll(1.0), True) |
| 3313 | self.assertEqual(a.recv_bytes(), b'b') |
| 3314 | self.assertEqual(a.poll(1.0), True) |
| 3315 | self.assertEqual(a.poll(1.0), True) |
| 3316 | self.assertEqual(a.poll(0.0), True) |
| 3317 | self.assertEqual(a.recv_bytes(), b'cd') |
| 3318 | |
| 3319 | p.join() |
| 3320 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3321 | # |
| 3322 | # Test of sending connection and socket objects between processes |
| 3323 | # |
Antoine Pitrou | 5438ed1 | 2012-04-24 22:56:57 +0200 | [diff] [blame] | 3324 | |
| 3325 | @unittest.skipUnless(HAS_REDUCTION, "test needs multiprocessing.reduction") |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3326 | class _TestPicklingConnections(BaseTestCase): |
| 3327 | |
| 3328 | ALLOWED_TYPES = ('processes',) |
| 3329 | |
Antoine Pitrou | 5438ed1 | 2012-04-24 22:56:57 +0200 | [diff] [blame] | 3330 | @classmethod |
Antoine Pitrou | 92ff4e1 | 2012-04-27 23:51:03 +0200 | [diff] [blame] | 3331 | def tearDownClass(cls): |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 3332 | from multiprocessing import resource_sharer |
Victor Stinner | 11f0807 | 2017-09-15 06:55:31 -0700 | [diff] [blame] | 3333 | resource_sharer.stop(timeout=TIMEOUT) |
Antoine Pitrou | 92ff4e1 | 2012-04-27 23:51:03 +0200 | [diff] [blame] | 3334 | |
| 3335 | @classmethod |
Antoine Pitrou | 5438ed1 | 2012-04-24 22:56:57 +0200 | [diff] [blame] | 3336 | def _listener(cls, conn, families): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3337 | for fam in families: |
Antoine Pitrou | 5438ed1 | 2012-04-24 22:56:57 +0200 | [diff] [blame] | 3338 | l = cls.connection.Listener(family=fam) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3339 | conn.send(l.address) |
| 3340 | new_conn = l.accept() |
| 3341 | conn.send(new_conn) |
Antoine Pitrou | 5438ed1 | 2012-04-24 22:56:57 +0200 | [diff] [blame] | 3342 | new_conn.close() |
| 3343 | l.close() |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3344 | |
Giampaolo Rodola | eb7e29f | 2019-04-09 00:34:02 +0200 | [diff] [blame] | 3345 | l = socket.create_server((test.support.HOST, 0)) |
Richard Oudkerk | 5d73c17 | 2012-05-08 22:24:47 +0100 | [diff] [blame] | 3346 | conn.send(l.getsockname()) |
Antoine Pitrou | 5438ed1 | 2012-04-24 22:56:57 +0200 | [diff] [blame] | 3347 | new_conn, addr = l.accept() |
| 3348 | conn.send(new_conn) |
| 3349 | new_conn.close() |
| 3350 | l.close() |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3351 | |
| 3352 | conn.recv() |
| 3353 | |
Antoine Pitrou | 5438ed1 | 2012-04-24 22:56:57 +0200 | [diff] [blame] | 3354 | @classmethod |
| 3355 | def _remote(cls, conn): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3356 | for (address, msg) in iter(conn.recv, None): |
Antoine Pitrou | 5438ed1 | 2012-04-24 22:56:57 +0200 | [diff] [blame] | 3357 | client = cls.connection.Client(address) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3358 | client.send(msg.upper()) |
| 3359 | client.close() |
| 3360 | |
Antoine Pitrou | 5438ed1 | 2012-04-24 22:56:57 +0200 | [diff] [blame] | 3361 | address, msg = conn.recv() |
| 3362 | client = socket.socket() |
| 3363 | client.connect(address) |
| 3364 | client.sendall(msg.upper()) |
| 3365 | client.close() |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3366 | |
| 3367 | conn.close() |
| 3368 | |
| 3369 | def test_pickling(self): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3370 | families = self.connection.families |
| 3371 | |
| 3372 | lconn, lconn0 = self.Pipe() |
| 3373 | lp = self.Process(target=self._listener, args=(lconn0, families)) |
Jesus Cea | 94f964f | 2011-09-09 20:26:57 +0200 | [diff] [blame] | 3374 | lp.daemon = True |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3375 | lp.start() |
| 3376 | lconn0.close() |
| 3377 | |
| 3378 | rconn, rconn0 = self.Pipe() |
| 3379 | rp = self.Process(target=self._remote, args=(rconn0,)) |
Jesus Cea | 94f964f | 2011-09-09 20:26:57 +0200 | [diff] [blame] | 3380 | rp.daemon = True |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3381 | rp.start() |
| 3382 | rconn0.close() |
| 3383 | |
| 3384 | for fam in families: |
| 3385 | msg = ('This connection uses family %s' % fam).encode('ascii') |
| 3386 | address = lconn.recv() |
| 3387 | rconn.send((address, msg)) |
| 3388 | new_conn = lconn.recv() |
| 3389 | self.assertEqual(new_conn.recv(), msg.upper()) |
| 3390 | |
| 3391 | rconn.send(None) |
| 3392 | |
Antoine Pitrou | 5438ed1 | 2012-04-24 22:56:57 +0200 | [diff] [blame] | 3393 | msg = latin('This connection uses a normal socket') |
| 3394 | address = lconn.recv() |
| 3395 | rconn.send((address, msg)) |
| 3396 | new_conn = lconn.recv() |
Richard Oudkerk | 4460c34 | 2012-04-30 14:48:50 +0100 | [diff] [blame] | 3397 | buf = [] |
| 3398 | while True: |
| 3399 | s = new_conn.recv(100) |
| 3400 | if not s: |
| 3401 | break |
| 3402 | buf.append(s) |
| 3403 | buf = b''.join(buf) |
| 3404 | self.assertEqual(buf, msg.upper()) |
Antoine Pitrou | 5438ed1 | 2012-04-24 22:56:57 +0200 | [diff] [blame] | 3405 | new_conn.close() |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3406 | |
| 3407 | lconn.send(None) |
| 3408 | |
| 3409 | rconn.close() |
| 3410 | lconn.close() |
| 3411 | |
| 3412 | lp.join() |
| 3413 | rp.join() |
Antoine Pitrou | 5438ed1 | 2012-04-24 22:56:57 +0200 | [diff] [blame] | 3414 | |
| 3415 | @classmethod |
| 3416 | def child_access(cls, conn): |
| 3417 | w = conn.recv() |
| 3418 | w.send('all is well') |
| 3419 | w.close() |
| 3420 | |
| 3421 | r = conn.recv() |
| 3422 | msg = r.recv() |
| 3423 | conn.send(msg*2) |
| 3424 | |
| 3425 | conn.close() |
| 3426 | |
| 3427 | def test_access(self): |
| 3428 | # On Windows, if we do not specify a destination pid when |
| 3429 | # using DupHandle then we need to be careful to use the |
| 3430 | # correct access flags for DuplicateHandle(), or else |
| 3431 | # DupHandle.detach() will raise PermissionError. For example, |
| 3432 | # for a read only pipe handle we should use |
| 3433 | # access=FILE_GENERIC_READ. (Unfortunately |
| 3434 | # DUPLICATE_SAME_ACCESS does not work.) |
| 3435 | conn, child_conn = self.Pipe() |
| 3436 | p = self.Process(target=self.child_access, args=(child_conn,)) |
| 3437 | p.daemon = True |
| 3438 | p.start() |
| 3439 | child_conn.close() |
| 3440 | |
| 3441 | r, w = self.Pipe(duplex=False) |
| 3442 | conn.send(w) |
| 3443 | w.close() |
| 3444 | self.assertEqual(r.recv(), 'all is well') |
| 3445 | r.close() |
| 3446 | |
| 3447 | r, w = self.Pipe(duplex=False) |
| 3448 | conn.send(r) |
| 3449 | r.close() |
| 3450 | w.send('foobar') |
| 3451 | w.close() |
| 3452 | self.assertEqual(conn.recv(), 'foobar'*2) |
| 3453 | |
Victor Stinner | b4c5296 | 2017-07-25 02:40:55 +0200 | [diff] [blame] | 3454 | p.join() |
| 3455 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3456 | # |
| 3457 | # |
| 3458 | # |
| 3459 | |
| 3460 | class _TestHeap(BaseTestCase): |
| 3461 | |
| 3462 | ALLOWED_TYPES = ('processes',) |
| 3463 | |
Antoine Pitrou | e4679cd | 2018-04-09 17:37:55 +0200 | [diff] [blame] | 3464 | def setUp(self): |
| 3465 | super().setUp() |
| 3466 | # Make pristine heap for these tests |
| 3467 | self.old_heap = multiprocessing.heap.BufferWrapper._heap |
| 3468 | multiprocessing.heap.BufferWrapper._heap = multiprocessing.heap.Heap() |
| 3469 | |
| 3470 | def tearDown(self): |
| 3471 | multiprocessing.heap.BufferWrapper._heap = self.old_heap |
| 3472 | super().tearDown() |
| 3473 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3474 | def test_heap(self): |
| 3475 | iterations = 5000 |
| 3476 | maxblocks = 50 |
| 3477 | blocks = [] |
| 3478 | |
Antoine Pitrou | e4679cd | 2018-04-09 17:37:55 +0200 | [diff] [blame] | 3479 | # get the heap object |
| 3480 | heap = multiprocessing.heap.BufferWrapper._heap |
| 3481 | heap._DISCARD_FREE_SPACE_LARGER_THAN = 0 |
| 3482 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3483 | # create and destroy lots of blocks of different sizes |
| 3484 | for i in range(iterations): |
| 3485 | size = int(random.lognormvariate(0, 1) * 1000) |
| 3486 | b = multiprocessing.heap.BufferWrapper(size) |
| 3487 | blocks.append(b) |
| 3488 | if len(blocks) > maxblocks: |
| 3489 | i = random.randrange(maxblocks) |
| 3490 | del blocks[i] |
Antoine Pitrou | e4679cd | 2018-04-09 17:37:55 +0200 | [diff] [blame] | 3491 | del b |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3492 | |
| 3493 | # verify the state of the heap |
Antoine Pitrou | e4679cd | 2018-04-09 17:37:55 +0200 | [diff] [blame] | 3494 | with heap._lock: |
| 3495 | all = [] |
| 3496 | free = 0 |
| 3497 | occupied = 0 |
| 3498 | for L in list(heap._len_to_seq.values()): |
| 3499 | # count all free blocks in arenas |
| 3500 | for arena, start, stop in L: |
| 3501 | all.append((heap._arenas.index(arena), start, stop, |
| 3502 | stop-start, 'free')) |
| 3503 | free += (stop-start) |
| 3504 | for arena, arena_blocks in heap._allocated_blocks.items(): |
| 3505 | # count all allocated blocks in arenas |
| 3506 | for start, stop in arena_blocks: |
| 3507 | all.append((heap._arenas.index(arena), start, stop, |
| 3508 | stop-start, 'occupied')) |
| 3509 | occupied += (stop-start) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3510 | |
Antoine Pitrou | e4679cd | 2018-04-09 17:37:55 +0200 | [diff] [blame] | 3511 | self.assertEqual(free + occupied, |
| 3512 | sum(arena.size for arena in heap._arenas)) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3513 | |
Antoine Pitrou | e4679cd | 2018-04-09 17:37:55 +0200 | [diff] [blame] | 3514 | all.sort() |
| 3515 | |
| 3516 | for i in range(len(all)-1): |
| 3517 | (arena, start, stop) = all[i][:3] |
| 3518 | (narena, nstart, nstop) = all[i+1][:3] |
| 3519 | if arena != narena: |
| 3520 | # Two different arenas |
| 3521 | self.assertEqual(stop, heap._arenas[arena].size) # last block |
| 3522 | self.assertEqual(nstart, 0) # first block |
| 3523 | else: |
| 3524 | # Same arena: two adjacent blocks |
| 3525 | self.assertEqual(stop, nstart) |
| 3526 | |
| 3527 | # test free'ing all blocks |
| 3528 | random.shuffle(blocks) |
| 3529 | while blocks: |
| 3530 | blocks.pop() |
| 3531 | |
| 3532 | self.assertEqual(heap._n_frees, heap._n_mallocs) |
| 3533 | self.assertEqual(len(heap._pending_free_blocks), 0) |
| 3534 | self.assertEqual(len(heap._arenas), 0) |
| 3535 | self.assertEqual(len(heap._allocated_blocks), 0, heap._allocated_blocks) |
| 3536 | self.assertEqual(len(heap._len_to_seq), 0) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3537 | |
Charles-François Natali | 778db49 | 2011-07-02 14:35:49 +0200 | [diff] [blame] | 3538 | def test_free_from_gc(self): |
| 3539 | # Check that freeing of blocks by the garbage collector doesn't deadlock |
| 3540 | # (issue #12352). |
| 3541 | # Make sure the GC is enabled, and set lower collection thresholds to |
| 3542 | # make collections more frequent (and increase the probability of |
| 3543 | # deadlock). |
| 3544 | if not gc.isenabled(): |
| 3545 | gc.enable() |
| 3546 | self.addCleanup(gc.disable) |
| 3547 | thresholds = gc.get_threshold() |
| 3548 | self.addCleanup(gc.set_threshold, *thresholds) |
| 3549 | gc.set_threshold(10) |
| 3550 | |
| 3551 | # perform numerous block allocations, with cyclic references to make |
| 3552 | # sure objects are collected asynchronously by the gc |
| 3553 | for i in range(5000): |
| 3554 | a = multiprocessing.heap.BufferWrapper(1) |
| 3555 | b = multiprocessing.heap.BufferWrapper(1) |
| 3556 | # circular references |
| 3557 | a.buddy = b |
| 3558 | b.buddy = a |
| 3559 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3560 | # |
| 3561 | # |
| 3562 | # |
| 3563 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3564 | class _Foo(Structure): |
| 3565 | _fields_ = [ |
| 3566 | ('x', c_int), |
Gareth Rees | 3913bad | 2017-07-21 11:35:33 +0100 | [diff] [blame] | 3567 | ('y', c_double), |
| 3568 | ('z', c_longlong,) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3569 | ] |
| 3570 | |
| 3571 | class _TestSharedCTypes(BaseTestCase): |
| 3572 | |
| 3573 | ALLOWED_TYPES = ('processes',) |
| 3574 | |
Antoine Pitrou | 7744e2a | 2010-11-22 16:26:21 +0000 | [diff] [blame] | 3575 | def setUp(self): |
| 3576 | if not HAS_SHAREDCTYPES: |
| 3577 | self.skipTest("requires multiprocessing.sharedctypes") |
| 3578 | |
Antoine Pitrou | 0d1b38c | 2010-11-02 23:50:11 +0000 | [diff] [blame] | 3579 | @classmethod |
Gareth Rees | 3913bad | 2017-07-21 11:35:33 +0100 | [diff] [blame] | 3580 | def _double(cls, x, y, z, foo, arr, string): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3581 | x.value *= 2 |
| 3582 | y.value *= 2 |
Gareth Rees | 3913bad | 2017-07-21 11:35:33 +0100 | [diff] [blame] | 3583 | z.value *= 2 |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3584 | foo.x *= 2 |
| 3585 | foo.y *= 2 |
| 3586 | string.value *= 2 |
| 3587 | for i in range(len(arr)): |
| 3588 | arr[i] *= 2 |
| 3589 | |
| 3590 | def test_sharedctypes(self, lock=False): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3591 | x = Value('i', 7, lock=lock) |
Georg Brandl | 89fad14 | 2010-03-14 10:23:39 +0000 | [diff] [blame] | 3592 | y = Value(c_double, 1.0/3.0, lock=lock) |
Gareth Rees | 3913bad | 2017-07-21 11:35:33 +0100 | [diff] [blame] | 3593 | z = Value(c_longlong, 2 ** 33, lock=lock) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3594 | foo = Value(_Foo, 3, 2, lock=lock) |
Georg Brandl | 89fad14 | 2010-03-14 10:23:39 +0000 | [diff] [blame] | 3595 | arr = self.Array('d', list(range(10)), lock=lock) |
| 3596 | string = self.Array('c', 20, lock=lock) |
Brian Curtin | afa88b5 | 2010-10-07 01:12:19 +0000 | [diff] [blame] | 3597 | string.value = latin('hello') |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3598 | |
Gareth Rees | 3913bad | 2017-07-21 11:35:33 +0100 | [diff] [blame] | 3599 | p = self.Process(target=self._double, args=(x, y, z, foo, arr, string)) |
Jesus Cea | 94f964f | 2011-09-09 20:26:57 +0200 | [diff] [blame] | 3600 | p.daemon = True |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3601 | p.start() |
| 3602 | p.join() |
| 3603 | |
| 3604 | self.assertEqual(x.value, 14) |
| 3605 | self.assertAlmostEqual(y.value, 2.0/3.0) |
Gareth Rees | 3913bad | 2017-07-21 11:35:33 +0100 | [diff] [blame] | 3606 | self.assertEqual(z.value, 2 ** 34) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3607 | self.assertEqual(foo.x, 6) |
| 3608 | self.assertAlmostEqual(foo.y, 4.0) |
| 3609 | for i in range(10): |
| 3610 | self.assertAlmostEqual(arr[i], i*2) |
| 3611 | self.assertEqual(string.value, latin('hellohello')) |
| 3612 | |
| 3613 | def test_synchronize(self): |
| 3614 | self.test_sharedctypes(lock=True) |
| 3615 | |
| 3616 | def test_copy(self): |
Gareth Rees | 3913bad | 2017-07-21 11:35:33 +0100 | [diff] [blame] | 3617 | foo = _Foo(2, 5.0, 2 ** 33) |
Brian Curtin | afa88b5 | 2010-10-07 01:12:19 +0000 | [diff] [blame] | 3618 | bar = copy(foo) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3619 | foo.x = 0 |
| 3620 | foo.y = 0 |
Gareth Rees | 3913bad | 2017-07-21 11:35:33 +0100 | [diff] [blame] | 3621 | foo.z = 0 |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3622 | self.assertEqual(bar.x, 2) |
| 3623 | self.assertAlmostEqual(bar.y, 5.0) |
Gareth Rees | 3913bad | 2017-07-21 11:35:33 +0100 | [diff] [blame] | 3624 | self.assertEqual(bar.z, 2 ** 33) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3625 | |
Davin Potts | e895de3 | 2019-02-23 22:08:16 -0600 | [diff] [blame] | 3626 | |
| 3627 | @unittest.skipUnless(HAS_SHMEM, "requires multiprocessing.shared_memory") |
| 3628 | class _TestSharedMemory(BaseTestCase): |
| 3629 | |
| 3630 | ALLOWED_TYPES = ('processes',) |
| 3631 | |
| 3632 | @staticmethod |
| 3633 | def _attach_existing_shmem_then_write(shmem_name_or_obj, binary_data): |
| 3634 | if isinstance(shmem_name_or_obj, str): |
| 3635 | local_sms = shared_memory.SharedMemory(shmem_name_or_obj) |
| 3636 | else: |
| 3637 | local_sms = shmem_name_or_obj |
| 3638 | local_sms.buf[:len(binary_data)] = binary_data |
| 3639 | local_sms.close() |
| 3640 | |
| 3641 | def test_shared_memory_basics(self): |
| 3642 | sms = shared_memory.SharedMemory('test01_tsmb', create=True, size=512) |
| 3643 | self.addCleanup(sms.unlink) |
| 3644 | |
| 3645 | # Verify attributes are readable. |
| 3646 | self.assertEqual(sms.name, 'test01_tsmb') |
| 3647 | self.assertGreaterEqual(sms.size, 512) |
| 3648 | self.assertGreaterEqual(len(sms.buf), sms.size) |
| 3649 | |
| 3650 | # Modify contents of shared memory segment through memoryview. |
| 3651 | sms.buf[0] = 42 |
| 3652 | self.assertEqual(sms.buf[0], 42) |
| 3653 | |
| 3654 | # Attach to existing shared memory segment. |
| 3655 | also_sms = shared_memory.SharedMemory('test01_tsmb') |
| 3656 | self.assertEqual(also_sms.buf[0], 42) |
| 3657 | also_sms.close() |
| 3658 | |
| 3659 | # Attach to existing shared memory segment but specify a new size. |
| 3660 | same_sms = shared_memory.SharedMemory('test01_tsmb', size=20*sms.size) |
| 3661 | self.assertLess(same_sms.size, 20*sms.size) # Size was ignored. |
| 3662 | same_sms.close() |
| 3663 | |
| 3664 | if shared_memory._USE_POSIX: |
| 3665 | # Posix Shared Memory can only be unlinked once. Here we |
| 3666 | # test an implementation detail that is not observed across |
| 3667 | # all supported platforms (since WindowsNamedSharedMemory |
| 3668 | # manages unlinking on its own and unlink() does nothing). |
| 3669 | # True release of shared memory segment does not necessarily |
| 3670 | # happen until process exits, depending on the OS platform. |
| 3671 | with self.assertRaises(FileNotFoundError): |
| 3672 | sms_uno = shared_memory.SharedMemory( |
| 3673 | 'test01_dblunlink', |
| 3674 | create=True, |
| 3675 | size=5000 |
| 3676 | ) |
| 3677 | |
| 3678 | try: |
| 3679 | self.assertGreaterEqual(sms_uno.size, 5000) |
| 3680 | |
| 3681 | sms_duo = shared_memory.SharedMemory('test01_dblunlink') |
| 3682 | sms_duo.unlink() # First shm_unlink() call. |
| 3683 | sms_duo.close() |
| 3684 | sms_uno.close() |
| 3685 | |
| 3686 | finally: |
| 3687 | sms_uno.unlink() # A second shm_unlink() call is bad. |
| 3688 | |
| 3689 | with self.assertRaises(FileExistsError): |
| 3690 | # Attempting to create a new shared memory segment with a |
| 3691 | # name that is already in use triggers an exception. |
| 3692 | there_can_only_be_one_sms = shared_memory.SharedMemory( |
| 3693 | 'test01_tsmb', |
| 3694 | create=True, |
| 3695 | size=512 |
| 3696 | ) |
| 3697 | |
| 3698 | if shared_memory._USE_POSIX: |
| 3699 | # Requesting creation of a shared memory segment with the option |
| 3700 | # to attach to an existing segment, if that name is currently in |
| 3701 | # use, should not trigger an exception. |
| 3702 | # Note: Using a smaller size could possibly cause truncation of |
| 3703 | # the existing segment but is OS platform dependent. In the |
| 3704 | # case of MacOS/darwin, requesting a smaller size is disallowed. |
| 3705 | class OptionalAttachSharedMemory(shared_memory.SharedMemory): |
| 3706 | _flags = os.O_CREAT | os.O_RDWR |
| 3707 | ok_if_exists_sms = OptionalAttachSharedMemory('test01_tsmb') |
| 3708 | self.assertEqual(ok_if_exists_sms.size, sms.size) |
| 3709 | ok_if_exists_sms.close() |
| 3710 | |
| 3711 | # Attempting to attach to an existing shared memory segment when |
| 3712 | # no segment exists with the supplied name triggers an exception. |
| 3713 | with self.assertRaises(FileNotFoundError): |
| 3714 | nonexisting_sms = shared_memory.SharedMemory('test01_notthere') |
| 3715 | nonexisting_sms.unlink() # Error should occur on prior line. |
| 3716 | |
| 3717 | sms.close() |
| 3718 | |
| 3719 | def test_shared_memory_across_processes(self): |
| 3720 | sms = shared_memory.SharedMemory('test02_tsmap', True, size=512) |
| 3721 | self.addCleanup(sms.unlink) |
| 3722 | |
| 3723 | # Verify remote attachment to existing block by name is working. |
| 3724 | p = self.Process( |
| 3725 | target=self._attach_existing_shmem_then_write, |
| 3726 | args=(sms.name, b'howdy') |
| 3727 | ) |
| 3728 | p.daemon = True |
| 3729 | p.start() |
| 3730 | p.join() |
| 3731 | self.assertEqual(bytes(sms.buf[:5]), b'howdy') |
| 3732 | |
| 3733 | # Verify pickling of SharedMemory instance also works. |
| 3734 | p = self.Process( |
| 3735 | target=self._attach_existing_shmem_then_write, |
| 3736 | args=(sms, b'HELLO') |
| 3737 | ) |
| 3738 | p.daemon = True |
| 3739 | p.start() |
| 3740 | p.join() |
| 3741 | self.assertEqual(bytes(sms.buf[:5]), b'HELLO') |
| 3742 | |
| 3743 | sms.close() |
| 3744 | |
Pierre Glaser | d0d64ad | 2019-05-10 20:42:35 +0200 | [diff] [blame] | 3745 | @unittest.skipIf(os.name != "posix", "not feasible in non-posix platforms") |
| 3746 | def test_shared_memory_SharedMemoryServer_ignores_sigint(self): |
| 3747 | # bpo-36368: protect SharedMemoryManager server process from |
| 3748 | # KeyboardInterrupt signals. |
| 3749 | smm = multiprocessing.managers.SharedMemoryManager() |
| 3750 | smm.start() |
| 3751 | |
| 3752 | # make sure the manager works properly at the beginning |
| 3753 | sl = smm.ShareableList(range(10)) |
| 3754 | |
| 3755 | # the manager's server should ignore KeyboardInterrupt signals, and |
| 3756 | # maintain its connection with the current process, and success when |
| 3757 | # asked to deliver memory segments. |
| 3758 | os.kill(smm._process.pid, signal.SIGINT) |
| 3759 | |
| 3760 | sl2 = smm.ShareableList(range(10)) |
| 3761 | |
| 3762 | # test that the custom signal handler registered in the Manager does |
| 3763 | # not affect signal handling in the parent process. |
| 3764 | with self.assertRaises(KeyboardInterrupt): |
| 3765 | os.kill(os.getpid(), signal.SIGINT) |
| 3766 | |
| 3767 | smm.shutdown() |
| 3768 | |
Pierre Glaser | b1dfcad | 2019-05-13 21:15:32 +0200 | [diff] [blame] | 3769 | @unittest.skipIf(os.name != "posix", "resource_tracker is posix only") |
| 3770 | def test_shared_memory_SharedMemoryManager_reuses_resource_tracker(self): |
| 3771 | # bpo-36867: test that a SharedMemoryManager uses the |
| 3772 | # same resource_tracker process as its parent. |
| 3773 | cmd = '''if 1: |
| 3774 | from multiprocessing.managers import SharedMemoryManager |
| 3775 | |
| 3776 | |
| 3777 | smm = SharedMemoryManager() |
| 3778 | smm.start() |
| 3779 | sl = smm.ShareableList(range(10)) |
| 3780 | smm.shutdown() |
| 3781 | ''' |
| 3782 | rc, out, err = test.support.script_helper.assert_python_ok('-c', cmd) |
| 3783 | |
| 3784 | # Before bpo-36867 was fixed, a SharedMemoryManager not using the same |
| 3785 | # resource_tracker process as its parent would make the parent's |
| 3786 | # tracker complain about sl being leaked even though smm.shutdown() |
| 3787 | # properly released sl. |
| 3788 | self.assertFalse(err) |
| 3789 | |
Davin Potts | e895de3 | 2019-02-23 22:08:16 -0600 | [diff] [blame] | 3790 | def test_shared_memory_SharedMemoryManager_basics(self): |
| 3791 | smm1 = multiprocessing.managers.SharedMemoryManager() |
| 3792 | with self.assertRaises(ValueError): |
| 3793 | smm1.SharedMemory(size=9) # Fails if SharedMemoryServer not started |
| 3794 | smm1.start() |
| 3795 | lol = [ smm1.ShareableList(range(i)) for i in range(5, 10) ] |
| 3796 | lom = [ smm1.SharedMemory(size=j) for j in range(32, 128, 16) ] |
| 3797 | doppleganger_list0 = shared_memory.ShareableList(name=lol[0].shm.name) |
| 3798 | self.assertEqual(len(doppleganger_list0), 5) |
| 3799 | doppleganger_shm0 = shared_memory.SharedMemory(name=lom[0].name) |
| 3800 | self.assertGreaterEqual(len(doppleganger_shm0.buf), 32) |
| 3801 | held_name = lom[0].name |
| 3802 | smm1.shutdown() |
| 3803 | if sys.platform != "win32": |
| 3804 | # Calls to unlink() have no effect on Windows platform; shared |
| 3805 | # memory will only be released once final process exits. |
| 3806 | with self.assertRaises(FileNotFoundError): |
| 3807 | # No longer there to be attached to again. |
| 3808 | absent_shm = shared_memory.SharedMemory(name=held_name) |
| 3809 | |
| 3810 | with multiprocessing.managers.SharedMemoryManager() as smm2: |
| 3811 | sl = smm2.ShareableList("howdy") |
| 3812 | shm = smm2.SharedMemory(size=128) |
| 3813 | held_name = sl.shm.name |
| 3814 | if sys.platform != "win32": |
| 3815 | with self.assertRaises(FileNotFoundError): |
| 3816 | # No longer there to be attached to again. |
| 3817 | absent_sl = shared_memory.ShareableList(name=held_name) |
| 3818 | |
| 3819 | |
| 3820 | def test_shared_memory_ShareableList_basics(self): |
| 3821 | sl = shared_memory.ShareableList( |
| 3822 | ['howdy', b'HoWdY', -273.154, 100, None, True, 42] |
| 3823 | ) |
| 3824 | self.addCleanup(sl.shm.unlink) |
| 3825 | |
| 3826 | # Verify attributes are readable. |
| 3827 | self.assertEqual(sl.format, '8s8sdqxxxxxx?xxxxxxxx?q') |
| 3828 | |
| 3829 | # Exercise len(). |
| 3830 | self.assertEqual(len(sl), 7) |
| 3831 | |
| 3832 | # Exercise index(). |
| 3833 | with warnings.catch_warnings(): |
| 3834 | # Suppress BytesWarning when comparing against b'HoWdY'. |
| 3835 | warnings.simplefilter('ignore') |
| 3836 | with self.assertRaises(ValueError): |
| 3837 | sl.index('100') |
| 3838 | self.assertEqual(sl.index(100), 3) |
| 3839 | |
| 3840 | # Exercise retrieving individual values. |
| 3841 | self.assertEqual(sl[0], 'howdy') |
| 3842 | self.assertEqual(sl[-2], True) |
| 3843 | |
| 3844 | # Exercise iterability. |
| 3845 | self.assertEqual( |
| 3846 | tuple(sl), |
| 3847 | ('howdy', b'HoWdY', -273.154, 100, None, True, 42) |
| 3848 | ) |
| 3849 | |
| 3850 | # Exercise modifying individual values. |
| 3851 | sl[3] = 42 |
| 3852 | self.assertEqual(sl[3], 42) |
| 3853 | sl[4] = 'some' # Change type at a given position. |
| 3854 | self.assertEqual(sl[4], 'some') |
| 3855 | self.assertEqual(sl.format, '8s8sdq8sxxxxxxx?q') |
| 3856 | with self.assertRaises(ValueError): |
| 3857 | sl[4] = 'far too many' # Exceeds available storage. |
| 3858 | self.assertEqual(sl[4], 'some') |
| 3859 | |
| 3860 | # Exercise count(). |
| 3861 | with warnings.catch_warnings(): |
| 3862 | # Suppress BytesWarning when comparing against b'HoWdY'. |
| 3863 | warnings.simplefilter('ignore') |
| 3864 | self.assertEqual(sl.count(42), 2) |
| 3865 | self.assertEqual(sl.count(b'HoWdY'), 1) |
| 3866 | self.assertEqual(sl.count(b'adios'), 0) |
| 3867 | |
| 3868 | # Exercise creating a duplicate. |
| 3869 | sl_copy = shared_memory.ShareableList(sl, name='test03_duplicate') |
| 3870 | try: |
| 3871 | self.assertNotEqual(sl.shm.name, sl_copy.shm.name) |
| 3872 | self.assertEqual('test03_duplicate', sl_copy.shm.name) |
| 3873 | self.assertEqual(list(sl), list(sl_copy)) |
| 3874 | self.assertEqual(sl.format, sl_copy.format) |
| 3875 | sl_copy[-1] = 77 |
| 3876 | self.assertEqual(sl_copy[-1], 77) |
| 3877 | self.assertNotEqual(sl[-1], 77) |
| 3878 | sl_copy.shm.close() |
| 3879 | finally: |
| 3880 | sl_copy.shm.unlink() |
| 3881 | |
| 3882 | # Obtain a second handle on the same ShareableList. |
| 3883 | sl_tethered = shared_memory.ShareableList(name=sl.shm.name) |
| 3884 | self.assertEqual(sl.shm.name, sl_tethered.shm.name) |
| 3885 | sl_tethered[-1] = 880 |
| 3886 | self.assertEqual(sl[-1], 880) |
| 3887 | sl_tethered.shm.close() |
| 3888 | |
| 3889 | sl.shm.close() |
| 3890 | |
| 3891 | # Exercise creating an empty ShareableList. |
| 3892 | empty_sl = shared_memory.ShareableList() |
| 3893 | try: |
| 3894 | self.assertEqual(len(empty_sl), 0) |
| 3895 | self.assertEqual(empty_sl.format, '') |
| 3896 | self.assertEqual(empty_sl.count('any'), 0) |
| 3897 | with self.assertRaises(ValueError): |
| 3898 | empty_sl.index(None) |
| 3899 | empty_sl.shm.close() |
| 3900 | finally: |
| 3901 | empty_sl.shm.unlink() |
| 3902 | |
| 3903 | def test_shared_memory_ShareableList_pickling(self): |
| 3904 | sl = shared_memory.ShareableList(range(10)) |
| 3905 | self.addCleanup(sl.shm.unlink) |
| 3906 | |
| 3907 | serialized_sl = pickle.dumps(sl) |
| 3908 | deserialized_sl = pickle.loads(serialized_sl) |
| 3909 | self.assertTrue( |
| 3910 | isinstance(deserialized_sl, shared_memory.ShareableList) |
| 3911 | ) |
| 3912 | self.assertTrue(deserialized_sl[-1], 9) |
| 3913 | self.assertFalse(sl is deserialized_sl) |
| 3914 | deserialized_sl[4] = "changed" |
| 3915 | self.assertEqual(sl[4], "changed") |
| 3916 | |
| 3917 | # Verify data is not being put into the pickled representation. |
| 3918 | name = 'a' * len(sl.shm.name) |
| 3919 | larger_sl = shared_memory.ShareableList(range(400)) |
| 3920 | self.addCleanup(larger_sl.shm.unlink) |
| 3921 | serialized_larger_sl = pickle.dumps(larger_sl) |
| 3922 | self.assertTrue(len(serialized_sl) == len(serialized_larger_sl)) |
| 3923 | larger_sl.shm.close() |
| 3924 | |
| 3925 | deserialized_sl.shm.close() |
| 3926 | sl.shm.close() |
| 3927 | |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 3928 | def test_shared_memory_cleaned_after_process_termination(self): |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 3929 | cmd = '''if 1: |
| 3930 | import os, time, sys |
| 3931 | from multiprocessing import shared_memory |
| 3932 | |
| 3933 | # Create a shared_memory segment, and send the segment name |
| 3934 | sm = shared_memory.SharedMemory(create=True, size=10) |
| 3935 | sys.stdout.write(sm._name + '\\n') |
| 3936 | sys.stdout.flush() |
| 3937 | time.sleep(100) |
| 3938 | ''' |
Pierre Glaser | b1dfcad | 2019-05-13 21:15:32 +0200 | [diff] [blame] | 3939 | with subprocess.Popen([sys.executable, '-E', '-c', cmd], |
| 3940 | stdout=subprocess.PIPE, |
| 3941 | stderr=subprocess.PIPE) as p: |
| 3942 | name = p.stdout.readline().strip().decode() |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 3943 | |
Pierre Glaser | b1dfcad | 2019-05-13 21:15:32 +0200 | [diff] [blame] | 3944 | # killing abruptly processes holding reference to a shared memory |
| 3945 | # segment should not leak the given memory segment. |
| 3946 | p.terminate() |
| 3947 | p.wait() |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 3948 | |
Pierre Glaser | cbe72d8 | 2019-05-17 20:20:07 +0200 | [diff] [blame] | 3949 | deadline = time.monotonic() + 60 |
| 3950 | t = 0.1 |
| 3951 | while time.monotonic() < deadline: |
| 3952 | time.sleep(t) |
| 3953 | t = min(t*2, 5) |
| 3954 | try: |
| 3955 | smm = shared_memory.SharedMemory(name, create=False) |
| 3956 | except FileNotFoundError: |
| 3957 | break |
| 3958 | else: |
| 3959 | raise AssertionError("A SharedMemory segment was leaked after" |
| 3960 | " a process was abruptly terminated.") |
Pierre Glaser | b1dfcad | 2019-05-13 21:15:32 +0200 | [diff] [blame] | 3961 | |
| 3962 | if os.name == 'posix': |
| 3963 | # A warning was emitted by the subprocess' own |
| 3964 | # resource_tracker (on Windows, shared memory segments |
| 3965 | # are released automatically by the OS). |
| 3966 | err = p.stderr.read().decode() |
| 3967 | self.assertIn( |
| 3968 | "resource_tracker: There appear to be 1 leaked " |
| 3969 | "shared_memory objects to clean up at shutdown", err) |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 3970 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3971 | # |
| 3972 | # |
| 3973 | # |
| 3974 | |
| 3975 | class _TestFinalize(BaseTestCase): |
| 3976 | |
| 3977 | ALLOWED_TYPES = ('processes',) |
| 3978 | |
Antoine Pitrou | 1eb6c00 | 2017-06-13 17:10:39 +0200 | [diff] [blame] | 3979 | def setUp(self): |
| 3980 | self.registry_backup = util._finalizer_registry.copy() |
| 3981 | util._finalizer_registry.clear() |
| 3982 | |
| 3983 | def tearDown(self): |
| 3984 | self.assertFalse(util._finalizer_registry) |
| 3985 | util._finalizer_registry.update(self.registry_backup) |
| 3986 | |
Antoine Pitrou | 0d1b38c | 2010-11-02 23:50:11 +0000 | [diff] [blame] | 3987 | @classmethod |
| 3988 | def _test_finalize(cls, conn): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 3989 | class Foo(object): |
| 3990 | pass |
| 3991 | |
| 3992 | a = Foo() |
| 3993 | util.Finalize(a, conn.send, args=('a',)) |
| 3994 | del a # triggers callback for a |
| 3995 | |
| 3996 | b = Foo() |
| 3997 | close_b = util.Finalize(b, conn.send, args=('b',)) |
| 3998 | close_b() # triggers callback for b |
| 3999 | close_b() # does nothing because callback has already been called |
| 4000 | del b # does nothing because callback has already been called |
| 4001 | |
| 4002 | c = Foo() |
| 4003 | util.Finalize(c, conn.send, args=('c',)) |
| 4004 | |
| 4005 | d10 = Foo() |
| 4006 | util.Finalize(d10, conn.send, args=('d10',), exitpriority=1) |
| 4007 | |
| 4008 | d01 = Foo() |
| 4009 | util.Finalize(d01, conn.send, args=('d01',), exitpriority=0) |
| 4010 | d02 = Foo() |
| 4011 | util.Finalize(d02, conn.send, args=('d02',), exitpriority=0) |
| 4012 | d03 = Foo() |
| 4013 | util.Finalize(d03, conn.send, args=('d03',), exitpriority=0) |
| 4014 | |
| 4015 | util.Finalize(None, conn.send, args=('e',), exitpriority=-10) |
| 4016 | |
| 4017 | util.Finalize(None, conn.send, args=('STOP',), exitpriority=-100) |
| 4018 | |
Ezio Melotti | 1392500 | 2011-03-16 11:05:33 +0200 | [diff] [blame] | 4019 | # call multiprocessing's cleanup function then exit process without |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 4020 | # garbage collecting locals |
| 4021 | util._exit_function() |
| 4022 | conn.close() |
| 4023 | os._exit(0) |
| 4024 | |
| 4025 | def test_finalize(self): |
| 4026 | conn, child_conn = self.Pipe() |
| 4027 | |
| 4028 | p = self.Process(target=self._test_finalize, args=(child_conn,)) |
Jesus Cea | 94f964f | 2011-09-09 20:26:57 +0200 | [diff] [blame] | 4029 | p.daemon = True |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 4030 | p.start() |
| 4031 | p.join() |
| 4032 | |
| 4033 | result = [obj for obj in iter(conn.recv, 'STOP')] |
| 4034 | self.assertEqual(result, ['a', 'b', 'd10', 'd03', 'd02', 'd01', 'e']) |
| 4035 | |
Antoine Pitrou | 1eb6c00 | 2017-06-13 17:10:39 +0200 | [diff] [blame] | 4036 | def test_thread_safety(self): |
| 4037 | # bpo-24484: _run_finalizers() should be thread-safe |
| 4038 | def cb(): |
| 4039 | pass |
| 4040 | |
| 4041 | class Foo(object): |
| 4042 | def __init__(self): |
| 4043 | self.ref = self # create reference cycle |
| 4044 | # insert finalizer at random key |
| 4045 | util.Finalize(self, cb, exitpriority=random.randint(1, 100)) |
| 4046 | |
| 4047 | finish = False |
| 4048 | exc = None |
| 4049 | |
| 4050 | def run_finalizers(): |
| 4051 | nonlocal exc |
| 4052 | while not finish: |
| 4053 | time.sleep(random.random() * 1e-1) |
| 4054 | try: |
| 4055 | # A GC run will eventually happen during this, |
| 4056 | # collecting stale Foo's and mutating the registry |
| 4057 | util._run_finalizers() |
| 4058 | except Exception as e: |
| 4059 | exc = e |
| 4060 | |
| 4061 | def make_finalizers(): |
| 4062 | nonlocal exc |
| 4063 | d = {} |
| 4064 | while not finish: |
| 4065 | try: |
| 4066 | # Old Foo's get gradually replaced and later |
| 4067 | # collected by the GC (because of the cyclic ref) |
| 4068 | d[random.getrandbits(5)] = {Foo() for i in range(10)} |
| 4069 | except Exception as e: |
| 4070 | exc = e |
| 4071 | d.clear() |
| 4072 | |
| 4073 | old_interval = sys.getswitchinterval() |
| 4074 | old_threshold = gc.get_threshold() |
| 4075 | try: |
| 4076 | sys.setswitchinterval(1e-6) |
| 4077 | gc.set_threshold(5, 5, 5) |
| 4078 | threads = [threading.Thread(target=run_finalizers), |
| 4079 | threading.Thread(target=make_finalizers)] |
| 4080 | with test.support.start_threads(threads): |
| 4081 | time.sleep(4.0) # Wait a bit to trigger race condition |
| 4082 | finish = True |
| 4083 | if exc is not None: |
| 4084 | raise exc |
| 4085 | finally: |
| 4086 | sys.setswitchinterval(old_interval) |
| 4087 | gc.set_threshold(*old_threshold) |
| 4088 | gc.collect() # Collect remaining Foo's |
| 4089 | |
| 4090 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 4091 | # |
| 4092 | # Test that from ... import * works for each module |
| 4093 | # |
| 4094 | |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 4095 | class _TestImportStar(unittest.TestCase): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 4096 | |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 4097 | def get_module_names(self): |
| 4098 | import glob |
| 4099 | folder = os.path.dirname(multiprocessing.__file__) |
| 4100 | pattern = os.path.join(folder, '*.py') |
| 4101 | files = glob.glob(pattern) |
| 4102 | modules = [os.path.splitext(os.path.split(f)[1])[0] for f in files] |
| 4103 | modules = ['multiprocessing.' + m for m in modules] |
| 4104 | modules.remove('multiprocessing.__init__') |
| 4105 | modules.append('multiprocessing') |
| 4106 | return modules |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 4107 | |
| 4108 | def test_import(self): |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 4109 | modules = self.get_module_names() |
| 4110 | if sys.platform == 'win32': |
| 4111 | modules.remove('multiprocessing.popen_fork') |
| 4112 | modules.remove('multiprocessing.popen_forkserver') |
| 4113 | modules.remove('multiprocessing.popen_spawn_posix') |
| 4114 | else: |
| 4115 | modules.remove('multiprocessing.popen_spawn_win32') |
| 4116 | if not HAS_REDUCTION: |
| 4117 | modules.remove('multiprocessing.popen_forkserver') |
Florent Xicluna | fd1b093 | 2010-03-28 00:25:02 +0000 | [diff] [blame] | 4118 | |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 4119 | if c_int is None: |
Florent Xicluna | fd1b093 | 2010-03-28 00:25:02 +0000 | [diff] [blame] | 4120 | # This module requires _ctypes |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 4121 | modules.remove('multiprocessing.sharedctypes') |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 4122 | |
| 4123 | for name in modules: |
| 4124 | __import__(name) |
| 4125 | mod = sys.modules[name] |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 4126 | self.assertTrue(hasattr(mod, '__all__'), name) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 4127 | |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 4128 | for attr in mod.__all__: |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 4129 | self.assertTrue( |
| 4130 | hasattr(mod, attr), |
| 4131 | '%r does not have attribute %r' % (mod, attr) |
| 4132 | ) |
| 4133 | |
| 4134 | # |
| 4135 | # Quick test that logging works -- does not test logging output |
| 4136 | # |
| 4137 | |
| 4138 | class _TestLogging(BaseTestCase): |
| 4139 | |
| 4140 | ALLOWED_TYPES = ('processes',) |
| 4141 | |
| 4142 | def test_enable_logging(self): |
| 4143 | logger = multiprocessing.get_logger() |
| 4144 | logger.setLevel(util.SUBWARNING) |
| 4145 | self.assertTrue(logger is not None) |
| 4146 | logger.debug('this will not be printed') |
| 4147 | logger.info('nor will this') |
| 4148 | logger.setLevel(LOG_LEVEL) |
| 4149 | |
Antoine Pitrou | 0d1b38c | 2010-11-02 23:50:11 +0000 | [diff] [blame] | 4150 | @classmethod |
| 4151 | def _test_level(cls, conn): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 4152 | logger = multiprocessing.get_logger() |
| 4153 | conn.send(logger.getEffectiveLevel()) |
| 4154 | |
| 4155 | def test_level(self): |
| 4156 | LEVEL1 = 32 |
| 4157 | LEVEL2 = 37 |
| 4158 | |
| 4159 | logger = multiprocessing.get_logger() |
| 4160 | root_logger = logging.getLogger() |
| 4161 | root_level = root_logger.level |
| 4162 | |
| 4163 | reader, writer = multiprocessing.Pipe(duplex=False) |
| 4164 | |
| 4165 | logger.setLevel(LEVEL1) |
Jesus Cea | 94f964f | 2011-09-09 20:26:57 +0200 | [diff] [blame] | 4166 | p = self.Process(target=self._test_level, args=(writer,)) |
Jesus Cea | 94f964f | 2011-09-09 20:26:57 +0200 | [diff] [blame] | 4167 | p.start() |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 4168 | self.assertEqual(LEVEL1, reader.recv()) |
Victor Stinner | 0663495 | 2017-07-24 13:02:20 +0200 | [diff] [blame] | 4169 | p.join() |
| 4170 | p.close() |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 4171 | |
| 4172 | logger.setLevel(logging.NOTSET) |
| 4173 | root_logger.setLevel(LEVEL2) |
Jesus Cea | 94f964f | 2011-09-09 20:26:57 +0200 | [diff] [blame] | 4174 | p = self.Process(target=self._test_level, args=(writer,)) |
Jesus Cea | 94f964f | 2011-09-09 20:26:57 +0200 | [diff] [blame] | 4175 | p.start() |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 4176 | self.assertEqual(LEVEL2, reader.recv()) |
Victor Stinner | 0663495 | 2017-07-24 13:02:20 +0200 | [diff] [blame] | 4177 | p.join() |
| 4178 | p.close() |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 4179 | |
| 4180 | root_logger.setLevel(root_level) |
| 4181 | logger.setLevel(level=LOG_LEVEL) |
| 4182 | |
Jesse Noller | b9a49b7 | 2009-11-21 18:09:38 +0000 | [diff] [blame] | 4183 | |
Jesse Noller | f4ae35f | 2009-11-24 14:22:24 +0000 | [diff] [blame] | 4184 | # class _TestLoggingProcessName(BaseTestCase): |
| 4185 | # |
| 4186 | # def handle(self, record): |
| 4187 | # assert record.processName == multiprocessing.current_process().name |
| 4188 | # self.__handled = True |
| 4189 | # |
| 4190 | # def test_logging(self): |
| 4191 | # handler = logging.Handler() |
| 4192 | # handler.handle = self.handle |
| 4193 | # self.__handled = False |
| 4194 | # # Bypass getLogger() and side-effects |
| 4195 | # logger = logging.getLoggerClass()( |
| 4196 | # 'multiprocessing.test.TestLoggingProcessName') |
| 4197 | # logger.addHandler(handler) |
| 4198 | # logger.propagate = False |
| 4199 | # |
| 4200 | # logger.warn('foo') |
| 4201 | # assert self.__handled |
Jesse Noller | b9a49b7 | 2009-11-21 18:09:38 +0000 | [diff] [blame] | 4202 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 4203 | # |
Richard Oudkerk | 7aaa1ef | 2013-02-26 12:39:57 +0000 | [diff] [blame] | 4204 | # Check that Process.join() retries if os.waitpid() fails with EINTR |
| 4205 | # |
| 4206 | |
| 4207 | class _TestPollEintr(BaseTestCase): |
| 4208 | |
| 4209 | ALLOWED_TYPES = ('processes',) |
| 4210 | |
| 4211 | @classmethod |
| 4212 | def _killer(cls, pid): |
Richard Oudkerk | 6a53af8 | 2013-08-28 13:50:19 +0100 | [diff] [blame] | 4213 | time.sleep(0.1) |
Richard Oudkerk | 7aaa1ef | 2013-02-26 12:39:57 +0000 | [diff] [blame] | 4214 | os.kill(pid, signal.SIGUSR1) |
| 4215 | |
| 4216 | @unittest.skipUnless(hasattr(signal, 'SIGUSR1'), 'requires SIGUSR1') |
| 4217 | def test_poll_eintr(self): |
| 4218 | got_signal = [False] |
| 4219 | def record(*args): |
| 4220 | got_signal[0] = True |
| 4221 | pid = os.getpid() |
| 4222 | oldhandler = signal.signal(signal.SIGUSR1, record) |
| 4223 | try: |
| 4224 | killer = self.Process(target=self._killer, args=(pid,)) |
| 4225 | killer.start() |
Richard Oudkerk | 6a53af8 | 2013-08-28 13:50:19 +0100 | [diff] [blame] | 4226 | try: |
| 4227 | p = self.Process(target=time.sleep, args=(2,)) |
| 4228 | p.start() |
| 4229 | p.join() |
| 4230 | finally: |
| 4231 | killer.join() |
Richard Oudkerk | 7aaa1ef | 2013-02-26 12:39:57 +0000 | [diff] [blame] | 4232 | self.assertTrue(got_signal[0]) |
| 4233 | self.assertEqual(p.exitcode, 0) |
Richard Oudkerk | 7aaa1ef | 2013-02-26 12:39:57 +0000 | [diff] [blame] | 4234 | finally: |
| 4235 | signal.signal(signal.SIGUSR1, oldhandler) |
| 4236 | |
| 4237 | # |
Jesse Noller | 6214edd | 2009-01-19 16:23:53 +0000 | [diff] [blame] | 4238 | # Test to verify handle verification, see issue 3321 |
| 4239 | # |
| 4240 | |
| 4241 | class TestInvalidHandle(unittest.TestCase): |
| 4242 | |
Victor Stinner | 937ee9e | 2018-06-26 02:11:06 +0200 | [diff] [blame] | 4243 | @unittest.skipIf(WIN32, "skipped on Windows") |
Jesse Noller | 6214edd | 2009-01-19 16:23:53 +0000 | [diff] [blame] | 4244 | def test_invalid_handles(self): |
Antoine Pitrou | 87cf220 | 2011-05-09 17:04:27 +0200 | [diff] [blame] | 4245 | conn = multiprocessing.connection.Connection(44977608) |
Charles-François Natali | 6703bb4 | 2013-09-06 21:12:22 +0200 | [diff] [blame] | 4246 | # check that poll() doesn't crash |
Antoine Pitrou | 87cf220 | 2011-05-09 17:04:27 +0200 | [diff] [blame] | 4247 | try: |
Charles-François Natali | 6703bb4 | 2013-09-06 21:12:22 +0200 | [diff] [blame] | 4248 | conn.poll() |
| 4249 | except (ValueError, OSError): |
| 4250 | pass |
Antoine Pitrou | 87cf220 | 2011-05-09 17:04:27 +0200 | [diff] [blame] | 4251 | finally: |
| 4252 | # Hack private attribute _handle to avoid printing an error |
| 4253 | # in conn.__del__ |
| 4254 | conn._handle = None |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 4255 | self.assertRaises((ValueError, OSError), |
Antoine Pitrou | 87cf220 | 2011-05-09 17:04:27 +0200 | [diff] [blame] | 4256 | multiprocessing.connection.Connection, -1) |
Florent Xicluna | fd1b093 | 2010-03-28 00:25:02 +0000 | [diff] [blame] | 4257 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 4258 | |
Richard Oudkerk | fc7b0ec | 2012-10-08 14:56:24 +0100 | [diff] [blame] | 4259 | |
Neal Norwitz | 5d6415e | 2008-08-25 01:53:32 +0000 | [diff] [blame] | 4260 | class OtherTest(unittest.TestCase): |
| 4261 | # TODO: add more tests for deliver/answer challenge. |
| 4262 | def test_deliver_challenge_auth_failure(self): |
| 4263 | class _FakeConnection(object): |
| 4264 | def recv_bytes(self, size): |
Neal Norwitz | ec105ad | 2008-08-25 03:05:54 +0000 | [diff] [blame] | 4265 | return b'something bogus' |
Neal Norwitz | 5d6415e | 2008-08-25 01:53:32 +0000 | [diff] [blame] | 4266 | def send_bytes(self, data): |
| 4267 | pass |
| 4268 | self.assertRaises(multiprocessing.AuthenticationError, |
| 4269 | multiprocessing.connection.deliver_challenge, |
| 4270 | _FakeConnection(), b'abc') |
| 4271 | |
| 4272 | def test_answer_challenge_auth_failure(self): |
| 4273 | class _FakeConnection(object): |
| 4274 | def __init__(self): |
| 4275 | self.count = 0 |
| 4276 | def recv_bytes(self, size): |
| 4277 | self.count += 1 |
| 4278 | if self.count == 1: |
| 4279 | return multiprocessing.connection.CHALLENGE |
| 4280 | elif self.count == 2: |
Neal Norwitz | ec105ad | 2008-08-25 03:05:54 +0000 | [diff] [blame] | 4281 | return b'something bogus' |
| 4282 | return b'' |
Neal Norwitz | 5d6415e | 2008-08-25 01:53:32 +0000 | [diff] [blame] | 4283 | def send_bytes(self, data): |
| 4284 | pass |
| 4285 | self.assertRaises(multiprocessing.AuthenticationError, |
| 4286 | multiprocessing.connection.answer_challenge, |
| 4287 | _FakeConnection(), b'abc') |
| 4288 | |
Benjamin Peterson | f47ed4a | 2009-04-11 20:45:40 +0000 | [diff] [blame] | 4289 | # |
| 4290 | # Test Manager.start()/Pool.__init__() initializer feature - see issue 5585 |
| 4291 | # |
| 4292 | |
| 4293 | def initializer(ns): |
| 4294 | ns.test += 1 |
| 4295 | |
| 4296 | class TestInitializers(unittest.TestCase): |
| 4297 | def setUp(self): |
| 4298 | self.mgr = multiprocessing.Manager() |
| 4299 | self.ns = self.mgr.Namespace() |
| 4300 | self.ns.test = 0 |
| 4301 | |
| 4302 | def tearDown(self): |
| 4303 | self.mgr.shutdown() |
Richard Oudkerk | a6becaa | 2012-05-03 18:29:02 +0100 | [diff] [blame] | 4304 | self.mgr.join() |
Benjamin Peterson | f47ed4a | 2009-04-11 20:45:40 +0000 | [diff] [blame] | 4305 | |
| 4306 | def test_manager_initializer(self): |
| 4307 | m = multiprocessing.managers.SyncManager() |
| 4308 | self.assertRaises(TypeError, m.start, 1) |
| 4309 | m.start(initializer, (self.ns,)) |
| 4310 | self.assertEqual(self.ns.test, 1) |
| 4311 | m.shutdown() |
Richard Oudkerk | a6becaa | 2012-05-03 18:29:02 +0100 | [diff] [blame] | 4312 | m.join() |
Benjamin Peterson | f47ed4a | 2009-04-11 20:45:40 +0000 | [diff] [blame] | 4313 | |
| 4314 | def test_pool_initializer(self): |
| 4315 | self.assertRaises(TypeError, multiprocessing.Pool, initializer=1) |
| 4316 | p = multiprocessing.Pool(1, initializer, (self.ns,)) |
| 4317 | p.close() |
| 4318 | p.join() |
| 4319 | self.assertEqual(self.ns.test, 1) |
| 4320 | |
Alexandre Vassalotti | c57a84f | 2009-07-17 12:07:01 +0000 | [diff] [blame] | 4321 | # |
| 4322 | # Issue 5155, 5313, 5331: Test process in processes |
| 4323 | # Verifies os.close(sys.stdin.fileno) vs. sys.stdin.close() behavior |
| 4324 | # |
| 4325 | |
Richard Oudkerk | 8b3f5aa | 2013-09-29 17:29:56 +0100 | [diff] [blame] | 4326 | def _this_sub_process(q): |
Alexandre Vassalotti | c57a84f | 2009-07-17 12:07:01 +0000 | [diff] [blame] | 4327 | try: |
| 4328 | item = q.get(block=False) |
| 4329 | except pyqueue.Empty: |
| 4330 | pass |
| 4331 | |
Victor Stinner | b4c5296 | 2017-07-25 02:40:55 +0200 | [diff] [blame] | 4332 | def _test_process(): |
Richard Oudkerk | 8b3f5aa | 2013-09-29 17:29:56 +0100 | [diff] [blame] | 4333 | queue = multiprocessing.Queue() |
| 4334 | subProc = multiprocessing.Process(target=_this_sub_process, args=(queue,)) |
| 4335 | subProc.daemon = True |
| 4336 | subProc.start() |
| 4337 | subProc.join() |
| 4338 | |
Alexandre Vassalotti | c57a84f | 2009-07-17 12:07:01 +0000 | [diff] [blame] | 4339 | def _afunc(x): |
| 4340 | return x*x |
| 4341 | |
| 4342 | def pool_in_process(): |
| 4343 | pool = multiprocessing.Pool(processes=4) |
| 4344 | x = pool.map(_afunc, [1, 2, 3, 4, 5, 6, 7]) |
Richard Oudkerk | 225cb8d | 2012-05-02 19:36:11 +0100 | [diff] [blame] | 4345 | pool.close() |
| 4346 | pool.join() |
Alexandre Vassalotti | c57a84f | 2009-07-17 12:07:01 +0000 | [diff] [blame] | 4347 | |
| 4348 | class _file_like(object): |
| 4349 | def __init__(self, delegate): |
| 4350 | self._delegate = delegate |
| 4351 | self._pid = None |
| 4352 | |
| 4353 | @property |
| 4354 | def cache(self): |
| 4355 | pid = os.getpid() |
| 4356 | # There are no race conditions since fork keeps only the running thread |
| 4357 | if pid != self._pid: |
| 4358 | self._pid = pid |
| 4359 | self._cache = [] |
| 4360 | return self._cache |
| 4361 | |
| 4362 | def write(self, data): |
| 4363 | self.cache.append(data) |
| 4364 | |
| 4365 | def flush(self): |
| 4366 | self._delegate.write(''.join(self.cache)) |
| 4367 | self._cache = [] |
| 4368 | |
| 4369 | class TestStdinBadfiledescriptor(unittest.TestCase): |
| 4370 | |
| 4371 | def test_queue_in_process(self): |
Victor Stinner | b4c5296 | 2017-07-25 02:40:55 +0200 | [diff] [blame] | 4372 | proc = multiprocessing.Process(target=_test_process) |
Alexandre Vassalotti | c57a84f | 2009-07-17 12:07:01 +0000 | [diff] [blame] | 4373 | proc.start() |
| 4374 | proc.join() |
| 4375 | |
| 4376 | def test_pool_in_process(self): |
| 4377 | p = multiprocessing.Process(target=pool_in_process) |
| 4378 | p.start() |
| 4379 | p.join() |
| 4380 | |
| 4381 | def test_flushing(self): |
| 4382 | sio = io.StringIO() |
| 4383 | flike = _file_like(sio) |
| 4384 | flike.write('foo') |
| 4385 | proc = multiprocessing.Process(target=lambda: flike.flush()) |
| 4386 | flike.flush() |
| 4387 | assert sio.getvalue() == 'foo' |
| 4388 | |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4389 | |
| 4390 | class TestWait(unittest.TestCase): |
| 4391 | |
| 4392 | @classmethod |
| 4393 | def _child_test_wait(cls, w, slow): |
| 4394 | for i in range(10): |
| 4395 | if slow: |
| 4396 | time.sleep(random.random()*0.1) |
| 4397 | w.send((i, os.getpid())) |
| 4398 | w.close() |
| 4399 | |
| 4400 | def test_wait(self, slow=False): |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4401 | from multiprocessing.connection import wait |
| 4402 | readers = [] |
| 4403 | procs = [] |
| 4404 | messages = [] |
| 4405 | |
| 4406 | for i in range(4): |
Antoine Pitrou | 5bb9a8f | 2012-03-06 13:43:24 +0100 | [diff] [blame] | 4407 | r, w = multiprocessing.Pipe(duplex=False) |
| 4408 | p = multiprocessing.Process(target=self._child_test_wait, args=(w, slow)) |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4409 | p.daemon = True |
| 4410 | p.start() |
| 4411 | w.close() |
| 4412 | readers.append(r) |
| 4413 | procs.append(p) |
Antoine Pitrou | 6c64cc1 | 2012-03-06 13:42:35 +0100 | [diff] [blame] | 4414 | self.addCleanup(p.join) |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4415 | |
| 4416 | while readers: |
| 4417 | for r in wait(readers): |
| 4418 | try: |
| 4419 | msg = r.recv() |
| 4420 | except EOFError: |
| 4421 | readers.remove(r) |
| 4422 | r.close() |
| 4423 | else: |
| 4424 | messages.append(msg) |
| 4425 | |
| 4426 | messages.sort() |
| 4427 | expected = sorted((i, p.pid) for i in range(10) for p in procs) |
| 4428 | self.assertEqual(messages, expected) |
| 4429 | |
| 4430 | @classmethod |
| 4431 | def _child_test_wait_socket(cls, address, slow): |
| 4432 | s = socket.socket() |
| 4433 | s.connect(address) |
| 4434 | for i in range(10): |
| 4435 | if slow: |
| 4436 | time.sleep(random.random()*0.1) |
| 4437 | s.sendall(('%s\n' % i).encode('ascii')) |
| 4438 | s.close() |
| 4439 | |
| 4440 | def test_wait_socket(self, slow=False): |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4441 | from multiprocessing.connection import wait |
Giampaolo Rodola | eb7e29f | 2019-04-09 00:34:02 +0200 | [diff] [blame] | 4442 | l = socket.create_server((test.support.HOST, 0)) |
Antoine Pitrou | f6fbf56 | 2013-08-22 00:39:46 +0200 | [diff] [blame] | 4443 | addr = l.getsockname() |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4444 | readers = [] |
| 4445 | procs = [] |
| 4446 | dic = {} |
| 4447 | |
| 4448 | for i in range(4): |
Antoine Pitrou | 5bb9a8f | 2012-03-06 13:43:24 +0100 | [diff] [blame] | 4449 | p = multiprocessing.Process(target=self._child_test_wait_socket, |
| 4450 | args=(addr, slow)) |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4451 | p.daemon = True |
| 4452 | p.start() |
| 4453 | procs.append(p) |
Antoine Pitrou | 6c64cc1 | 2012-03-06 13:42:35 +0100 | [diff] [blame] | 4454 | self.addCleanup(p.join) |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4455 | |
| 4456 | for i in range(4): |
| 4457 | r, _ = l.accept() |
| 4458 | readers.append(r) |
| 4459 | dic[r] = [] |
| 4460 | l.close() |
| 4461 | |
| 4462 | while readers: |
| 4463 | for r in wait(readers): |
| 4464 | msg = r.recv(32) |
| 4465 | if not msg: |
| 4466 | readers.remove(r) |
| 4467 | r.close() |
| 4468 | else: |
| 4469 | dic[r].append(msg) |
| 4470 | |
| 4471 | expected = ''.join('%s\n' % i for i in range(10)).encode('ascii') |
| 4472 | for v in dic.values(): |
| 4473 | self.assertEqual(b''.join(v), expected) |
| 4474 | |
| 4475 | def test_wait_slow(self): |
| 4476 | self.test_wait(True) |
| 4477 | |
| 4478 | def test_wait_socket_slow(self): |
Richard Oudkerk | 104b3f4 | 2012-05-08 16:08:07 +0100 | [diff] [blame] | 4479 | self.test_wait_socket(True) |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4480 | |
| 4481 | def test_wait_timeout(self): |
| 4482 | from multiprocessing.connection import wait |
| 4483 | |
Richard Oudkerk | 009b15e | 2012-05-04 09:44:39 +0100 | [diff] [blame] | 4484 | expected = 5 |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4485 | a, b = multiprocessing.Pipe() |
| 4486 | |
Victor Stinner | 2cf4c20 | 2018-12-17 09:36:36 +0100 | [diff] [blame] | 4487 | start = time.monotonic() |
Richard Oudkerk | 009b15e | 2012-05-04 09:44:39 +0100 | [diff] [blame] | 4488 | res = wait([a, b], expected) |
Victor Stinner | 2cf4c20 | 2018-12-17 09:36:36 +0100 | [diff] [blame] | 4489 | delta = time.monotonic() - start |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4490 | |
| 4491 | self.assertEqual(res, []) |
Richard Oudkerk | 6dbca36 | 2012-05-06 16:46:36 +0100 | [diff] [blame] | 4492 | self.assertLess(delta, expected * 2) |
| 4493 | self.assertGreater(delta, expected * 0.5) |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4494 | |
| 4495 | b.send(None) |
| 4496 | |
Victor Stinner | 2cf4c20 | 2018-12-17 09:36:36 +0100 | [diff] [blame] | 4497 | start = time.monotonic() |
Richard Oudkerk | 009b15e | 2012-05-04 09:44:39 +0100 | [diff] [blame] | 4498 | res = wait([a, b], 20) |
Victor Stinner | 2cf4c20 | 2018-12-17 09:36:36 +0100 | [diff] [blame] | 4499 | delta = time.monotonic() - start |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4500 | |
| 4501 | self.assertEqual(res, [a]) |
Antoine Pitrou | 3774977 | 2012-03-09 18:40:15 +0100 | [diff] [blame] | 4502 | self.assertLess(delta, 0.4) |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4503 | |
Richard Oudkerk | 009b15e | 2012-05-04 09:44:39 +0100 | [diff] [blame] | 4504 | @classmethod |
| 4505 | def signal_and_sleep(cls, sem, period): |
| 4506 | sem.release() |
| 4507 | time.sleep(period) |
| 4508 | |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4509 | def test_wait_integer(self): |
| 4510 | from multiprocessing.connection import wait |
| 4511 | |
Richard Oudkerk | 009b15e | 2012-05-04 09:44:39 +0100 | [diff] [blame] | 4512 | expected = 3 |
Giampaolo Rodola' | 0c8ad61 | 2013-01-14 02:24:05 +0100 | [diff] [blame] | 4513 | sorted_ = lambda l: sorted(l, key=lambda x: id(x)) |
Richard Oudkerk | 009b15e | 2012-05-04 09:44:39 +0100 | [diff] [blame] | 4514 | sem = multiprocessing.Semaphore(0) |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4515 | a, b = multiprocessing.Pipe() |
Richard Oudkerk | 009b15e | 2012-05-04 09:44:39 +0100 | [diff] [blame] | 4516 | p = multiprocessing.Process(target=self.signal_and_sleep, |
| 4517 | args=(sem, expected)) |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4518 | |
| 4519 | p.start() |
| 4520 | self.assertIsInstance(p.sentinel, int) |
Richard Oudkerk | 009b15e | 2012-05-04 09:44:39 +0100 | [diff] [blame] | 4521 | self.assertTrue(sem.acquire(timeout=20)) |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4522 | |
Victor Stinner | 2cf4c20 | 2018-12-17 09:36:36 +0100 | [diff] [blame] | 4523 | start = time.monotonic() |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4524 | res = wait([a, p.sentinel, b], expected + 20) |
Victor Stinner | 2cf4c20 | 2018-12-17 09:36:36 +0100 | [diff] [blame] | 4525 | delta = time.monotonic() - start |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4526 | |
| 4527 | self.assertEqual(res, [p.sentinel]) |
Antoine Pitrou | 3774977 | 2012-03-09 18:40:15 +0100 | [diff] [blame] | 4528 | self.assertLess(delta, expected + 2) |
| 4529 | self.assertGreater(delta, expected - 2) |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4530 | |
| 4531 | a.send(None) |
| 4532 | |
Victor Stinner | 2cf4c20 | 2018-12-17 09:36:36 +0100 | [diff] [blame] | 4533 | start = time.monotonic() |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4534 | res = wait([a, p.sentinel, b], 20) |
Victor Stinner | 2cf4c20 | 2018-12-17 09:36:36 +0100 | [diff] [blame] | 4535 | delta = time.monotonic() - start |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4536 | |
Giampaolo Rodola' | 5051ca8 | 2012-12-31 17:38:17 +0100 | [diff] [blame] | 4537 | self.assertEqual(sorted_(res), sorted_([p.sentinel, b])) |
Antoine Pitrou | 3774977 | 2012-03-09 18:40:15 +0100 | [diff] [blame] | 4538 | self.assertLess(delta, 0.4) |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4539 | |
| 4540 | b.send(None) |
| 4541 | |
Victor Stinner | 2cf4c20 | 2018-12-17 09:36:36 +0100 | [diff] [blame] | 4542 | start = time.monotonic() |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4543 | res = wait([a, p.sentinel, b], 20) |
Victor Stinner | 2cf4c20 | 2018-12-17 09:36:36 +0100 | [diff] [blame] | 4544 | delta = time.monotonic() - start |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4545 | |
Giampaolo Rodola' | 5051ca8 | 2012-12-31 17:38:17 +0100 | [diff] [blame] | 4546 | self.assertEqual(sorted_(res), sorted_([a, p.sentinel, b])) |
Antoine Pitrou | 3774977 | 2012-03-09 18:40:15 +0100 | [diff] [blame] | 4547 | self.assertLess(delta, 0.4) |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4548 | |
Richard Oudkerk | 009b15e | 2012-05-04 09:44:39 +0100 | [diff] [blame] | 4549 | p.terminate() |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4550 | p.join() |
| 4551 | |
Richard Oudkerk | 59d5404 | 2012-05-10 16:11:12 +0100 | [diff] [blame] | 4552 | def test_neg_timeout(self): |
| 4553 | from multiprocessing.connection import wait |
| 4554 | a, b = multiprocessing.Pipe() |
Victor Stinner | 2cf4c20 | 2018-12-17 09:36:36 +0100 | [diff] [blame] | 4555 | t = time.monotonic() |
Richard Oudkerk | 59d5404 | 2012-05-10 16:11:12 +0100 | [diff] [blame] | 4556 | res = wait([a], timeout=-1) |
Victor Stinner | 2cf4c20 | 2018-12-17 09:36:36 +0100 | [diff] [blame] | 4557 | t = time.monotonic() - t |
Richard Oudkerk | 59d5404 | 2012-05-10 16:11:12 +0100 | [diff] [blame] | 4558 | self.assertEqual(res, []) |
| 4559 | self.assertLess(t, 1) |
| 4560 | a.close() |
| 4561 | b.close() |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 4562 | |
Antoine Pitrou | 709176f | 2012-04-01 17:19:09 +0200 | [diff] [blame] | 4563 | # |
| 4564 | # Issue 14151: Test invalid family on invalid environment |
| 4565 | # |
| 4566 | |
| 4567 | class TestInvalidFamily(unittest.TestCase): |
| 4568 | |
Victor Stinner | 937ee9e | 2018-06-26 02:11:06 +0200 | [diff] [blame] | 4569 | @unittest.skipIf(WIN32, "skipped on Windows") |
Antoine Pitrou | 709176f | 2012-04-01 17:19:09 +0200 | [diff] [blame] | 4570 | def test_invalid_family(self): |
| 4571 | with self.assertRaises(ValueError): |
| 4572 | multiprocessing.connection.Listener(r'\\.\test') |
| 4573 | |
Victor Stinner | 937ee9e | 2018-06-26 02:11:06 +0200 | [diff] [blame] | 4574 | @unittest.skipUnless(WIN32, "skipped on non-Windows platforms") |
Antoine Pitrou | 6d20cba | 2012-04-03 20:12:23 +0200 | [diff] [blame] | 4575 | def test_invalid_family_win32(self): |
| 4576 | with self.assertRaises(ValueError): |
| 4577 | multiprocessing.connection.Listener('/var/test.pipe') |
Antoine Pitrou | 93bba8f | 2012-04-01 17:25:49 +0200 | [diff] [blame] | 4578 | |
Richard Oudkerk | 77c84f2 | 2012-05-18 14:28:02 +0100 | [diff] [blame] | 4579 | # |
| 4580 | # Issue 12098: check sys.flags of child matches that for parent |
| 4581 | # |
| 4582 | |
| 4583 | class TestFlags(unittest.TestCase): |
| 4584 | @classmethod |
| 4585 | def run_in_grandchild(cls, conn): |
| 4586 | conn.send(tuple(sys.flags)) |
| 4587 | |
| 4588 | @classmethod |
| 4589 | def run_in_child(cls): |
| 4590 | import json |
| 4591 | r, w = multiprocessing.Pipe(duplex=False) |
| 4592 | p = multiprocessing.Process(target=cls.run_in_grandchild, args=(w,)) |
| 4593 | p.start() |
| 4594 | grandchild_flags = r.recv() |
| 4595 | p.join() |
| 4596 | r.close() |
| 4597 | w.close() |
| 4598 | flags = (tuple(sys.flags), grandchild_flags) |
| 4599 | print(json.dumps(flags)) |
| 4600 | |
| 4601 | def test_flags(self): |
Pierre Glaser | b1dfcad | 2019-05-13 21:15:32 +0200 | [diff] [blame] | 4602 | import json |
Richard Oudkerk | 77c84f2 | 2012-05-18 14:28:02 +0100 | [diff] [blame] | 4603 | # start child process using unusual flags |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 4604 | prog = ('from test._test_multiprocessing import TestFlags; ' + |
Richard Oudkerk | 77c84f2 | 2012-05-18 14:28:02 +0100 | [diff] [blame] | 4605 | 'TestFlags.run_in_child()') |
| 4606 | data = subprocess.check_output( |
| 4607 | [sys.executable, '-E', '-S', '-O', '-c', prog]) |
| 4608 | child_flags, grandchild_flags = json.loads(data.decode('ascii')) |
| 4609 | self.assertEqual(child_flags, grandchild_flags) |
| 4610 | |
Richard Oudkerk | b15e622 | 2012-07-27 14:19:00 +0100 | [diff] [blame] | 4611 | # |
| 4612 | # Test interaction with socket timeouts - see Issue #6056 |
| 4613 | # |
| 4614 | |
| 4615 | class TestTimeouts(unittest.TestCase): |
| 4616 | @classmethod |
| 4617 | def _test_timeout(cls, child, address): |
| 4618 | time.sleep(1) |
| 4619 | child.send(123) |
| 4620 | child.close() |
| 4621 | conn = multiprocessing.connection.Client(address) |
| 4622 | conn.send(456) |
| 4623 | conn.close() |
| 4624 | |
| 4625 | def test_timeout(self): |
| 4626 | old_timeout = socket.getdefaulttimeout() |
| 4627 | try: |
| 4628 | socket.setdefaulttimeout(0.1) |
| 4629 | parent, child = multiprocessing.Pipe(duplex=True) |
| 4630 | l = multiprocessing.connection.Listener(family='AF_INET') |
| 4631 | p = multiprocessing.Process(target=self._test_timeout, |
| 4632 | args=(child, l.address)) |
| 4633 | p.start() |
| 4634 | child.close() |
| 4635 | self.assertEqual(parent.recv(), 123) |
| 4636 | parent.close() |
| 4637 | conn = l.accept() |
| 4638 | self.assertEqual(conn.recv(), 456) |
| 4639 | conn.close() |
| 4640 | l.close() |
Victor Stinner | 11f0807 | 2017-09-15 06:55:31 -0700 | [diff] [blame] | 4641 | join_process(p) |
Richard Oudkerk | b15e622 | 2012-07-27 14:19:00 +0100 | [diff] [blame] | 4642 | finally: |
| 4643 | socket.setdefaulttimeout(old_timeout) |
| 4644 | |
Richard Oudkerk | e88a244 | 2012-08-14 11:41:32 +0100 | [diff] [blame] | 4645 | # |
| 4646 | # Test what happens with no "if __name__ == '__main__'" |
| 4647 | # |
| 4648 | |
| 4649 | class TestNoForkBomb(unittest.TestCase): |
| 4650 | def test_noforkbomb(self): |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 4651 | sm = multiprocessing.get_start_method() |
Richard Oudkerk | e88a244 | 2012-08-14 11:41:32 +0100 | [diff] [blame] | 4652 | name = os.path.join(os.path.dirname(__file__), 'mp_fork_bomb.py') |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 4653 | if sm != 'fork': |
Berker Peksag | 076dbd0 | 2015-05-06 07:01:52 +0300 | [diff] [blame] | 4654 | rc, out, err = test.support.script_helper.assert_python_failure(name, sm) |
Serhiy Storchaka | a25c542 | 2015-02-13 15:13:33 +0200 | [diff] [blame] | 4655 | self.assertEqual(out, b'') |
| 4656 | self.assertIn(b'RuntimeError', err) |
Richard Oudkerk | e88a244 | 2012-08-14 11:41:32 +0100 | [diff] [blame] | 4657 | else: |
Berker Peksag | 076dbd0 | 2015-05-06 07:01:52 +0300 | [diff] [blame] | 4658 | rc, out, err = test.support.script_helper.assert_python_ok(name, sm) |
Serhiy Storchaka | a25c542 | 2015-02-13 15:13:33 +0200 | [diff] [blame] | 4659 | self.assertEqual(out.rstrip(), b'123') |
| 4660 | self.assertEqual(err, b'') |
Richard Oudkerk | e88a244 | 2012-08-14 11:41:32 +0100 | [diff] [blame] | 4661 | |
| 4662 | # |
Richard Oudkerk | 409c313 | 2013-04-17 20:58:00 +0100 | [diff] [blame] | 4663 | # Issue #17555: ForkAwareThreadLock |
| 4664 | # |
| 4665 | |
| 4666 | class TestForkAwareThreadLock(unittest.TestCase): |
Mike | 53f7a7c | 2017-12-14 14:04:53 +0300 | [diff] [blame] | 4667 | # We recursively start processes. Issue #17555 meant that the |
Richard Oudkerk | 409c313 | 2013-04-17 20:58:00 +0100 | [diff] [blame] | 4668 | # after fork registry would get duplicate entries for the same |
| 4669 | # lock. The size of the registry at generation n was ~2**n. |
| 4670 | |
| 4671 | @classmethod |
| 4672 | def child(cls, n, conn): |
| 4673 | if n > 1: |
| 4674 | p = multiprocessing.Process(target=cls.child, args=(n-1, conn)) |
| 4675 | p.start() |
Richard Oudkerk | a01fb39 | 2013-08-21 19:45:19 +0100 | [diff] [blame] | 4676 | conn.close() |
Victor Stinner | 11f0807 | 2017-09-15 06:55:31 -0700 | [diff] [blame] | 4677 | join_process(p) |
Richard Oudkerk | 409c313 | 2013-04-17 20:58:00 +0100 | [diff] [blame] | 4678 | else: |
| 4679 | conn.send(len(util._afterfork_registry)) |
| 4680 | conn.close() |
| 4681 | |
| 4682 | def test_lock(self): |
| 4683 | r, w = multiprocessing.Pipe(False) |
| 4684 | l = util.ForkAwareThreadLock() |
| 4685 | old_size = len(util._afterfork_registry) |
| 4686 | p = multiprocessing.Process(target=self.child, args=(5, w)) |
| 4687 | p.start() |
Richard Oudkerk | a01fb39 | 2013-08-21 19:45:19 +0100 | [diff] [blame] | 4688 | w.close() |
Richard Oudkerk | 409c313 | 2013-04-17 20:58:00 +0100 | [diff] [blame] | 4689 | new_size = r.recv() |
Victor Stinner | 11f0807 | 2017-09-15 06:55:31 -0700 | [diff] [blame] | 4690 | join_process(p) |
Richard Oudkerk | 409c313 | 2013-04-17 20:58:00 +0100 | [diff] [blame] | 4691 | self.assertLessEqual(new_size, old_size) |
| 4692 | |
| 4693 | # |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 4694 | # Check that non-forked child processes do not inherit unneeded fds/handles |
| 4695 | # |
| 4696 | |
| 4697 | class TestCloseFds(unittest.TestCase): |
| 4698 | |
| 4699 | def get_high_socket_fd(self): |
Victor Stinner | 937ee9e | 2018-06-26 02:11:06 +0200 | [diff] [blame] | 4700 | if WIN32: |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 4701 | # The child process will not have any socket handles, so |
| 4702 | # calling socket.fromfd() should produce WSAENOTSOCK even |
| 4703 | # if there is a handle of the same number. |
| 4704 | return socket.socket().detach() |
| 4705 | else: |
| 4706 | # We want to produce a socket with an fd high enough that a |
| 4707 | # freshly created child process will not have any fds as high. |
| 4708 | fd = socket.socket().detach() |
| 4709 | to_close = [] |
| 4710 | while fd < 50: |
| 4711 | to_close.append(fd) |
| 4712 | fd = os.dup(fd) |
| 4713 | for x in to_close: |
| 4714 | os.close(x) |
| 4715 | return fd |
| 4716 | |
| 4717 | def close(self, fd): |
Victor Stinner | 937ee9e | 2018-06-26 02:11:06 +0200 | [diff] [blame] | 4718 | if WIN32: |
Christian Heimes | b6e43af | 2018-01-29 22:37:58 +0100 | [diff] [blame] | 4719 | socket.socket(socket.AF_INET, socket.SOCK_STREAM, fileno=fd).close() |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 4720 | else: |
| 4721 | os.close(fd) |
| 4722 | |
| 4723 | @classmethod |
| 4724 | def _test_closefds(cls, conn, fd): |
| 4725 | try: |
| 4726 | s = socket.fromfd(fd, socket.AF_INET, socket.SOCK_STREAM) |
| 4727 | except Exception as e: |
| 4728 | conn.send(e) |
| 4729 | else: |
| 4730 | s.close() |
| 4731 | conn.send(None) |
| 4732 | |
| 4733 | def test_closefd(self): |
| 4734 | if not HAS_REDUCTION: |
| 4735 | raise unittest.SkipTest('requires fd pickling') |
| 4736 | |
| 4737 | reader, writer = multiprocessing.Pipe() |
| 4738 | fd = self.get_high_socket_fd() |
| 4739 | try: |
| 4740 | p = multiprocessing.Process(target=self._test_closefds, |
| 4741 | args=(writer, fd)) |
| 4742 | p.start() |
| 4743 | writer.close() |
| 4744 | e = reader.recv() |
Victor Stinner | 11f0807 | 2017-09-15 06:55:31 -0700 | [diff] [blame] | 4745 | join_process(p) |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 4746 | finally: |
| 4747 | self.close(fd) |
| 4748 | writer.close() |
| 4749 | reader.close() |
| 4750 | |
| 4751 | if multiprocessing.get_start_method() == 'fork': |
| 4752 | self.assertIs(e, None) |
| 4753 | else: |
| 4754 | WSAENOTSOCK = 10038 |
| 4755 | self.assertIsInstance(e, OSError) |
| 4756 | self.assertTrue(e.errno == errno.EBADF or |
| 4757 | e.winerror == WSAENOTSOCK, e) |
| 4758 | |
| 4759 | # |
Richard Oudkerk | cca8c53 | 2013-07-01 18:59:26 +0100 | [diff] [blame] | 4760 | # Issue #17097: EINTR should be ignored by recv(), send(), accept() etc |
| 4761 | # |
| 4762 | |
| 4763 | class TestIgnoreEINTR(unittest.TestCase): |
| 4764 | |
Victor Stinner | 252f6ab | 2018-06-01 16:48:34 +0200 | [diff] [blame] | 4765 | # Sending CONN_MAX_SIZE bytes into a multiprocessing pipe must block |
| 4766 | CONN_MAX_SIZE = max(support.PIPE_MAX_SIZE, support.SOCK_MAX_SIZE) |
| 4767 | |
Richard Oudkerk | cca8c53 | 2013-07-01 18:59:26 +0100 | [diff] [blame] | 4768 | @classmethod |
| 4769 | def _test_ignore(cls, conn): |
| 4770 | def handler(signum, frame): |
| 4771 | pass |
| 4772 | signal.signal(signal.SIGUSR1, handler) |
| 4773 | conn.send('ready') |
| 4774 | x = conn.recv() |
| 4775 | conn.send(x) |
Victor Stinner | 252f6ab | 2018-06-01 16:48:34 +0200 | [diff] [blame] | 4776 | conn.send_bytes(b'x' * cls.CONN_MAX_SIZE) |
Richard Oudkerk | cca8c53 | 2013-07-01 18:59:26 +0100 | [diff] [blame] | 4777 | |
| 4778 | @unittest.skipUnless(hasattr(signal, 'SIGUSR1'), 'requires SIGUSR1') |
| 4779 | def test_ignore(self): |
| 4780 | conn, child_conn = multiprocessing.Pipe() |
| 4781 | try: |
| 4782 | p = multiprocessing.Process(target=self._test_ignore, |
| 4783 | args=(child_conn,)) |
| 4784 | p.daemon = True |
| 4785 | p.start() |
| 4786 | child_conn.close() |
| 4787 | self.assertEqual(conn.recv(), 'ready') |
| 4788 | time.sleep(0.1) |
| 4789 | os.kill(p.pid, signal.SIGUSR1) |
| 4790 | time.sleep(0.1) |
| 4791 | conn.send(1234) |
| 4792 | self.assertEqual(conn.recv(), 1234) |
| 4793 | time.sleep(0.1) |
| 4794 | os.kill(p.pid, signal.SIGUSR1) |
Victor Stinner | 252f6ab | 2018-06-01 16:48:34 +0200 | [diff] [blame] | 4795 | self.assertEqual(conn.recv_bytes(), b'x' * self.CONN_MAX_SIZE) |
Richard Oudkerk | cca8c53 | 2013-07-01 18:59:26 +0100 | [diff] [blame] | 4796 | time.sleep(0.1) |
| 4797 | p.join() |
| 4798 | finally: |
| 4799 | conn.close() |
| 4800 | |
| 4801 | @classmethod |
| 4802 | def _test_ignore_listener(cls, conn): |
| 4803 | def handler(signum, frame): |
| 4804 | pass |
| 4805 | signal.signal(signal.SIGUSR1, handler) |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 4806 | with multiprocessing.connection.Listener() as l: |
| 4807 | conn.send(l.address) |
| 4808 | a = l.accept() |
| 4809 | a.send('welcome') |
Richard Oudkerk | cca8c53 | 2013-07-01 18:59:26 +0100 | [diff] [blame] | 4810 | |
| 4811 | @unittest.skipUnless(hasattr(signal, 'SIGUSR1'), 'requires SIGUSR1') |
| 4812 | def test_ignore_listener(self): |
| 4813 | conn, child_conn = multiprocessing.Pipe() |
| 4814 | try: |
| 4815 | p = multiprocessing.Process(target=self._test_ignore_listener, |
| 4816 | args=(child_conn,)) |
| 4817 | p.daemon = True |
| 4818 | p.start() |
| 4819 | child_conn.close() |
| 4820 | address = conn.recv() |
| 4821 | time.sleep(0.1) |
| 4822 | os.kill(p.pid, signal.SIGUSR1) |
| 4823 | time.sleep(0.1) |
| 4824 | client = multiprocessing.connection.Client(address) |
| 4825 | self.assertEqual(client.recv(), 'welcome') |
| 4826 | p.join() |
| 4827 | finally: |
| 4828 | conn.close() |
| 4829 | |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 4830 | class TestStartMethod(unittest.TestCase): |
Richard Oudkerk | b1694cf | 2013-10-16 16:41:56 +0100 | [diff] [blame] | 4831 | @classmethod |
| 4832 | def _check_context(cls, conn): |
| 4833 | conn.send(multiprocessing.get_start_method()) |
| 4834 | |
| 4835 | def check_context(self, ctx): |
| 4836 | r, w = ctx.Pipe(duplex=False) |
| 4837 | p = ctx.Process(target=self._check_context, args=(w,)) |
| 4838 | p.start() |
| 4839 | w.close() |
| 4840 | child_method = r.recv() |
| 4841 | r.close() |
| 4842 | p.join() |
| 4843 | self.assertEqual(child_method, ctx.get_start_method()) |
| 4844 | |
| 4845 | def test_context(self): |
| 4846 | for method in ('fork', 'spawn', 'forkserver'): |
| 4847 | try: |
| 4848 | ctx = multiprocessing.get_context(method) |
| 4849 | except ValueError: |
| 4850 | continue |
| 4851 | self.assertEqual(ctx.get_start_method(), method) |
| 4852 | self.assertIs(ctx.get_context(), ctx) |
| 4853 | self.assertRaises(ValueError, ctx.set_start_method, 'spawn') |
| 4854 | self.assertRaises(ValueError, ctx.set_start_method, None) |
| 4855 | self.check_context(ctx) |
| 4856 | |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 4857 | def test_set_get(self): |
| 4858 | multiprocessing.set_forkserver_preload(PRELOAD) |
| 4859 | count = 0 |
| 4860 | old_method = multiprocessing.get_start_method() |
Jesse Noller | d00df3c | 2008-06-18 14:22:48 +0000 | [diff] [blame] | 4861 | try: |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 4862 | for method in ('fork', 'spawn', 'forkserver'): |
| 4863 | try: |
Richard Oudkerk | b1694cf | 2013-10-16 16:41:56 +0100 | [diff] [blame] | 4864 | multiprocessing.set_start_method(method, force=True) |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 4865 | except ValueError: |
| 4866 | continue |
| 4867 | self.assertEqual(multiprocessing.get_start_method(), method) |
Richard Oudkerk | b1694cf | 2013-10-16 16:41:56 +0100 | [diff] [blame] | 4868 | ctx = multiprocessing.get_context() |
| 4869 | self.assertEqual(ctx.get_start_method(), method) |
| 4870 | self.assertTrue(type(ctx).__name__.lower().startswith(method)) |
| 4871 | self.assertTrue( |
| 4872 | ctx.Process.__name__.lower().startswith(method)) |
| 4873 | self.check_context(multiprocessing) |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 4874 | count += 1 |
| 4875 | finally: |
Richard Oudkerk | b1694cf | 2013-10-16 16:41:56 +0100 | [diff] [blame] | 4876 | multiprocessing.set_start_method(old_method, force=True) |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 4877 | self.assertGreaterEqual(count, 1) |
| 4878 | |
| 4879 | def test_get_all(self): |
| 4880 | methods = multiprocessing.get_all_start_methods() |
| 4881 | if sys.platform == 'win32': |
| 4882 | self.assertEqual(methods, ['spawn']) |
| 4883 | else: |
| 4884 | self.assertTrue(methods == ['fork', 'spawn'] or |
| 4885 | methods == ['fork', 'spawn', 'forkserver']) |
| 4886 | |
Antoine Pitrou | cd2a201 | 2016-12-10 17:13:16 +0100 | [diff] [blame] | 4887 | def test_preload_resources(self): |
| 4888 | if multiprocessing.get_start_method() != 'forkserver': |
| 4889 | self.skipTest("test only relevant for 'forkserver' method") |
| 4890 | name = os.path.join(os.path.dirname(__file__), 'mp_preload.py') |
| 4891 | rc, out, err = test.support.script_helper.assert_python_ok(name) |
| 4892 | out = out.decode() |
| 4893 | err = err.decode() |
| 4894 | if out.rstrip() != 'ok' or err != '': |
| 4895 | print(out) |
| 4896 | print(err) |
| 4897 | self.fail("failed spawning forkserver or grandchild") |
| 4898 | |
| 4899 | |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 4900 | @unittest.skipIf(sys.platform == "win32", |
| 4901 | "test semantics don't make sense on Windows") |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 4902 | class TestResourceTracker(unittest.TestCase): |
Antoine Pitrou | cbe1756 | 2017-11-03 14:31:38 +0100 | [diff] [blame] | 4903 | |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 4904 | def test_resource_tracker(self): |
Antoine Pitrou | cbe1756 | 2017-11-03 14:31:38 +0100 | [diff] [blame] | 4905 | # |
| 4906 | # Check that killing process does not leak named semaphores |
| 4907 | # |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 4908 | cmd = '''if 1: |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 4909 | import time, os, tempfile |
| 4910 | import multiprocessing as mp |
| 4911 | from multiprocessing import resource_tracker |
| 4912 | from multiprocessing.shared_memory import SharedMemory |
| 4913 | |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 4914 | mp.set_start_method("spawn") |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 4915 | rand = tempfile._RandomNameSequence() |
| 4916 | |
| 4917 | |
| 4918 | def create_and_register_resource(rtype): |
| 4919 | if rtype == "semaphore": |
| 4920 | lock = mp.Lock() |
| 4921 | return lock, lock._semlock.name |
| 4922 | elif rtype == "shared_memory": |
| 4923 | sm = SharedMemory(create=True, size=10) |
| 4924 | return sm, sm._name |
| 4925 | else: |
| 4926 | raise ValueError( |
| 4927 | "Resource type {{}} not understood".format(rtype)) |
| 4928 | |
| 4929 | |
| 4930 | resource1, rname1 = create_and_register_resource("{rtype}") |
| 4931 | resource2, rname2 = create_and_register_resource("{rtype}") |
| 4932 | |
| 4933 | os.write({w}, rname1.encode("ascii") + b"\\n") |
| 4934 | os.write({w}, rname2.encode("ascii") + b"\\n") |
| 4935 | |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 4936 | time.sleep(10) |
| 4937 | ''' |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 4938 | for rtype in resource_tracker._CLEANUP_FUNCS: |
| 4939 | with self.subTest(rtype=rtype): |
| 4940 | if rtype == "noop": |
| 4941 | # Artefact resource type used by the resource_tracker |
| 4942 | continue |
| 4943 | r, w = os.pipe() |
| 4944 | p = subprocess.Popen([sys.executable, |
| 4945 | '-E', '-c', cmd.format(w=w, rtype=rtype)], |
| 4946 | pass_fds=[w], |
| 4947 | stderr=subprocess.PIPE) |
| 4948 | os.close(w) |
| 4949 | with open(r, 'rb', closefd=True) as f: |
| 4950 | name1 = f.readline().rstrip().decode('ascii') |
| 4951 | name2 = f.readline().rstrip().decode('ascii') |
| 4952 | _resource_unlink(name1, rtype) |
| 4953 | p.terminate() |
| 4954 | p.wait() |
| 4955 | time.sleep(2.0) |
| 4956 | with self.assertRaises(OSError) as ctx: |
| 4957 | _resource_unlink(name2, rtype) |
| 4958 | # docs say it should be ENOENT, but OSX seems to give EINVAL |
| 4959 | self.assertIn( |
| 4960 | ctx.exception.errno, (errno.ENOENT, errno.EINVAL)) |
| 4961 | err = p.stderr.read().decode('utf-8') |
| 4962 | p.stderr.close() |
| 4963 | expected = ('resource_tracker: There appear to be 2 leaked {} ' |
| 4964 | 'objects'.format( |
| 4965 | rtype)) |
| 4966 | self.assertRegex(err, expected) |
| 4967 | self.assertRegex(err, r'resource_tracker: %r: \[Errno' % name1) |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 4968 | |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 4969 | def check_resource_tracker_death(self, signum, should_die): |
Antoine Pitrou | cbe1756 | 2017-11-03 14:31:38 +0100 | [diff] [blame] | 4970 | # bpo-31310: if the semaphore tracker process has died, it should |
| 4971 | # be restarted implicitly. |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 4972 | from multiprocessing.resource_tracker import _resource_tracker |
| 4973 | pid = _resource_tracker._pid |
Pablo Galindo | ec74d18 | 2018-09-04 09:53:54 +0100 | [diff] [blame] | 4974 | if pid is not None: |
| 4975 | os.kill(pid, signal.SIGKILL) |
| 4976 | os.waitpid(pid, 0) |
Pablo Galindo | 3058b7d | 2018-10-10 08:40:14 +0100 | [diff] [blame] | 4977 | with warnings.catch_warnings(): |
| 4978 | warnings.simplefilter("ignore") |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 4979 | _resource_tracker.ensure_running() |
| 4980 | pid = _resource_tracker._pid |
Pablo Galindo | ec74d18 | 2018-09-04 09:53:54 +0100 | [diff] [blame] | 4981 | |
Antoine Pitrou | cbe1756 | 2017-11-03 14:31:38 +0100 | [diff] [blame] | 4982 | os.kill(pid, signum) |
| 4983 | time.sleep(1.0) # give it time to die |
| 4984 | |
| 4985 | ctx = multiprocessing.get_context("spawn") |
Pablo Galindo | ec74d18 | 2018-09-04 09:53:54 +0100 | [diff] [blame] | 4986 | with warnings.catch_warnings(record=True) as all_warn: |
Pablo Galindo | 3058b7d | 2018-10-10 08:40:14 +0100 | [diff] [blame] | 4987 | warnings.simplefilter("always") |
Antoine Pitrou | cbe1756 | 2017-11-03 14:31:38 +0100 | [diff] [blame] | 4988 | sem = ctx.Semaphore() |
| 4989 | sem.acquire() |
| 4990 | sem.release() |
| 4991 | wr = weakref.ref(sem) |
| 4992 | # ensure `sem` gets collected, which triggers communication with |
| 4993 | # the semaphore tracker |
| 4994 | del sem |
| 4995 | gc.collect() |
| 4996 | self.assertIsNone(wr()) |
Pablo Galindo | ec74d18 | 2018-09-04 09:53:54 +0100 | [diff] [blame] | 4997 | if should_die: |
| 4998 | self.assertEqual(len(all_warn), 1) |
| 4999 | the_warn = all_warn[0] |
Pablo Galindo | 3058b7d | 2018-10-10 08:40:14 +0100 | [diff] [blame] | 5000 | self.assertTrue(issubclass(the_warn.category, UserWarning)) |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 5001 | self.assertTrue("resource_tracker: process died" |
Pablo Galindo | ec74d18 | 2018-09-04 09:53:54 +0100 | [diff] [blame] | 5002 | in str(the_warn.message)) |
| 5003 | else: |
| 5004 | self.assertEqual(len(all_warn), 0) |
Antoine Pitrou | cbe1756 | 2017-11-03 14:31:38 +0100 | [diff] [blame] | 5005 | |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 5006 | def test_resource_tracker_sigint(self): |
Antoine Pitrou | cbe1756 | 2017-11-03 14:31:38 +0100 | [diff] [blame] | 5007 | # Catchable signal (ignored by semaphore tracker) |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 5008 | self.check_resource_tracker_death(signal.SIGINT, False) |
Antoine Pitrou | cbe1756 | 2017-11-03 14:31:38 +0100 | [diff] [blame] | 5009 | |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 5010 | def test_resource_tracker_sigterm(self): |
Pablo Galindo | ec74d18 | 2018-09-04 09:53:54 +0100 | [diff] [blame] | 5011 | # Catchable signal (ignored by semaphore tracker) |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 5012 | self.check_resource_tracker_death(signal.SIGTERM, False) |
Pablo Galindo | ec74d18 | 2018-09-04 09:53:54 +0100 | [diff] [blame] | 5013 | |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 5014 | def test_resource_tracker_sigkill(self): |
Antoine Pitrou | cbe1756 | 2017-11-03 14:31:38 +0100 | [diff] [blame] | 5015 | # Uncatchable signal. |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 5016 | self.check_resource_tracker_death(signal.SIGKILL, True) |
Antoine Pitrou | cbe1756 | 2017-11-03 14:31:38 +0100 | [diff] [blame] | 5017 | |
Thomas Moreau | 004b93e | 2019-04-24 21:45:52 +0200 | [diff] [blame] | 5018 | @staticmethod |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 5019 | def _is_resource_tracker_reused(conn, pid): |
| 5020 | from multiprocessing.resource_tracker import _resource_tracker |
| 5021 | _resource_tracker.ensure_running() |
Thomas Moreau | 004b93e | 2019-04-24 21:45:52 +0200 | [diff] [blame] | 5022 | # The pid should be None in the child process, expect for the fork |
| 5023 | # context. It should not be a new value. |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 5024 | reused = _resource_tracker._pid in (None, pid) |
| 5025 | reused &= _resource_tracker._check_alive() |
Thomas Moreau | 004b93e | 2019-04-24 21:45:52 +0200 | [diff] [blame] | 5026 | conn.send(reused) |
| 5027 | |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 5028 | def test_resource_tracker_reused(self): |
| 5029 | from multiprocessing.resource_tracker import _resource_tracker |
| 5030 | _resource_tracker.ensure_running() |
| 5031 | pid = _resource_tracker._pid |
Thomas Moreau | 004b93e | 2019-04-24 21:45:52 +0200 | [diff] [blame] | 5032 | |
| 5033 | r, w = multiprocessing.Pipe(duplex=False) |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 5034 | p = multiprocessing.Process(target=self._is_resource_tracker_reused, |
Thomas Moreau | 004b93e | 2019-04-24 21:45:52 +0200 | [diff] [blame] | 5035 | args=(w, pid)) |
| 5036 | p.start() |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 5037 | is_resource_tracker_reused = r.recv() |
Thomas Moreau | 004b93e | 2019-04-24 21:45:52 +0200 | [diff] [blame] | 5038 | |
| 5039 | # Clean up |
| 5040 | p.join() |
| 5041 | w.close() |
| 5042 | r.close() |
| 5043 | |
Pierre Glaser | f22cc69 | 2019-05-10 22:59:08 +0200 | [diff] [blame] | 5044 | self.assertTrue(is_resource_tracker_reused) |
Thomas Moreau | 004b93e | 2019-04-24 21:45:52 +0200 | [diff] [blame] | 5045 | |
Antoine Pitrou | cbe1756 | 2017-11-03 14:31:38 +0100 | [diff] [blame] | 5046 | |
Xiang Zhang | 6f75bc0 | 2017-05-17 21:04:00 +0800 | [diff] [blame] | 5047 | class TestSimpleQueue(unittest.TestCase): |
| 5048 | |
| 5049 | @classmethod |
| 5050 | def _test_empty(cls, queue, child_can_start, parent_can_continue): |
| 5051 | child_can_start.wait() |
| 5052 | # issue 30301, could fail under spawn and forkserver |
| 5053 | try: |
| 5054 | queue.put(queue.empty()) |
| 5055 | queue.put(queue.empty()) |
| 5056 | finally: |
| 5057 | parent_can_continue.set() |
| 5058 | |
| 5059 | def test_empty(self): |
| 5060 | queue = multiprocessing.SimpleQueue() |
| 5061 | child_can_start = multiprocessing.Event() |
| 5062 | parent_can_continue = multiprocessing.Event() |
| 5063 | |
| 5064 | proc = multiprocessing.Process( |
| 5065 | target=self._test_empty, |
| 5066 | args=(queue, child_can_start, parent_can_continue) |
| 5067 | ) |
| 5068 | proc.daemon = True |
| 5069 | proc.start() |
| 5070 | |
| 5071 | self.assertTrue(queue.empty()) |
| 5072 | |
| 5073 | child_can_start.set() |
| 5074 | parent_can_continue.wait() |
| 5075 | |
| 5076 | self.assertFalse(queue.empty()) |
| 5077 | self.assertEqual(queue.get(), True) |
| 5078 | self.assertEqual(queue.get(), False) |
| 5079 | self.assertTrue(queue.empty()) |
| 5080 | |
| 5081 | proc.join() |
| 5082 | |
Derek B. Kim | c40278e | 2018-07-11 19:22:28 +0900 | [diff] [blame] | 5083 | |
Julien Palard | 5d236ca | 2018-11-04 23:40:32 +0100 | [diff] [blame] | 5084 | class TestPoolNotLeakOnFailure(unittest.TestCase): |
| 5085 | |
| 5086 | def test_release_unused_processes(self): |
| 5087 | # Issue #19675: During pool creation, if we can't create a process, |
| 5088 | # don't leak already created ones. |
| 5089 | will_fail_in = 3 |
| 5090 | forked_processes = [] |
| 5091 | |
| 5092 | class FailingForkProcess: |
| 5093 | def __init__(self, **kwargs): |
| 5094 | self.name = 'Fake Process' |
| 5095 | self.exitcode = None |
| 5096 | self.state = None |
| 5097 | forked_processes.append(self) |
| 5098 | |
| 5099 | def start(self): |
| 5100 | nonlocal will_fail_in |
| 5101 | if will_fail_in <= 0: |
| 5102 | raise OSError("Manually induced OSError") |
| 5103 | will_fail_in -= 1 |
| 5104 | self.state = 'started' |
| 5105 | |
| 5106 | def terminate(self): |
| 5107 | self.state = 'stopping' |
| 5108 | |
| 5109 | def join(self): |
| 5110 | if self.state == 'stopping': |
| 5111 | self.state = 'stopped' |
| 5112 | |
| 5113 | def is_alive(self): |
| 5114 | return self.state == 'started' or self.state == 'stopping' |
| 5115 | |
| 5116 | with self.assertRaisesRegex(OSError, 'Manually induced OSError'): |
| 5117 | p = multiprocessing.pool.Pool(5, context=unittest.mock.MagicMock( |
| 5118 | Process=FailingForkProcess)) |
| 5119 | p.close() |
| 5120 | p.join() |
| 5121 | self.assertFalse( |
| 5122 | any(process.is_alive() for process in forked_processes)) |
| 5123 | |
| 5124 | |
Giampaolo Rodola | 2848d9d | 2019-02-07 03:03:11 -0800 | [diff] [blame] | 5125 | class TestSyncManagerTypes(unittest.TestCase): |
| 5126 | """Test all the types which can be shared between a parent and a |
| 5127 | child process by using a manager which acts as an intermediary |
| 5128 | between them. |
| 5129 | |
| 5130 | In the following unit-tests the base type is created in the parent |
| 5131 | process, the @classmethod represents the worker process and the |
| 5132 | shared object is readable and editable between the two. |
| 5133 | |
| 5134 | # The child. |
| 5135 | @classmethod |
| 5136 | def _test_list(cls, obj): |
| 5137 | assert obj[0] == 5 |
| 5138 | assert obj.append(6) |
| 5139 | |
| 5140 | # The parent. |
| 5141 | def test_list(self): |
| 5142 | o = self.manager.list() |
| 5143 | o.append(5) |
| 5144 | self.run_worker(self._test_list, o) |
| 5145 | assert o[1] == 6 |
| 5146 | """ |
| 5147 | manager_class = multiprocessing.managers.SyncManager |
| 5148 | |
| 5149 | def setUp(self): |
| 5150 | self.manager = self.manager_class() |
| 5151 | self.manager.start() |
| 5152 | self.proc = None |
| 5153 | |
| 5154 | def tearDown(self): |
| 5155 | if self.proc is not None and self.proc.is_alive(): |
| 5156 | self.proc.terminate() |
| 5157 | self.proc.join() |
| 5158 | self.manager.shutdown() |
Pablo Galindo | 613f729 | 2019-02-09 17:08:49 +0000 | [diff] [blame] | 5159 | self.manager = None |
| 5160 | self.proc = None |
Giampaolo Rodola | 2848d9d | 2019-02-07 03:03:11 -0800 | [diff] [blame] | 5161 | |
| 5162 | @classmethod |
| 5163 | def setUpClass(cls): |
| 5164 | support.reap_children() |
| 5165 | |
| 5166 | tearDownClass = setUpClass |
| 5167 | |
| 5168 | def wait_proc_exit(self): |
| 5169 | # Only the manager process should be returned by active_children() |
| 5170 | # but this can take a bit on slow machines, so wait a few seconds |
| 5171 | # if there are other children too (see #17395). |
| 5172 | join_process(self.proc) |
| 5173 | start_time = time.monotonic() |
| 5174 | t = 0.01 |
| 5175 | while len(multiprocessing.active_children()) > 1: |
| 5176 | time.sleep(t) |
| 5177 | t *= 2 |
| 5178 | dt = time.monotonic() - start_time |
| 5179 | if dt >= 5.0: |
| 5180 | test.support.environment_altered = True |
| 5181 | print("Warning -- multiprocessing.Manager still has %s active " |
| 5182 | "children after %s seconds" |
| 5183 | % (multiprocessing.active_children(), dt), |
| 5184 | file=sys.stderr) |
| 5185 | break |
| 5186 | |
| 5187 | def run_worker(self, worker, obj): |
| 5188 | self.proc = multiprocessing.Process(target=worker, args=(obj, )) |
| 5189 | self.proc.daemon = True |
| 5190 | self.proc.start() |
| 5191 | self.wait_proc_exit() |
| 5192 | self.assertEqual(self.proc.exitcode, 0) |
| 5193 | |
| 5194 | @classmethod |
Giampaolo Rodola | 2848d9d | 2019-02-07 03:03:11 -0800 | [diff] [blame] | 5195 | def _test_event(cls, obj): |
| 5196 | assert obj.is_set() |
| 5197 | obj.wait() |
| 5198 | obj.clear() |
| 5199 | obj.wait(0.001) |
| 5200 | |
| 5201 | def test_event(self): |
| 5202 | o = self.manager.Event() |
| 5203 | o.set() |
| 5204 | self.run_worker(self._test_event, o) |
| 5205 | assert not o.is_set() |
| 5206 | o.wait(0.001) |
| 5207 | |
| 5208 | @classmethod |
| 5209 | def _test_lock(cls, obj): |
| 5210 | obj.acquire() |
| 5211 | |
| 5212 | def test_lock(self, lname="Lock"): |
| 5213 | o = getattr(self.manager, lname)() |
| 5214 | self.run_worker(self._test_lock, o) |
| 5215 | o.release() |
| 5216 | self.assertRaises(RuntimeError, o.release) # already released |
| 5217 | |
| 5218 | @classmethod |
| 5219 | def _test_rlock(cls, obj): |
| 5220 | obj.acquire() |
| 5221 | obj.release() |
| 5222 | |
| 5223 | def test_rlock(self, lname="Lock"): |
| 5224 | o = getattr(self.manager, lname)() |
| 5225 | self.run_worker(self._test_rlock, o) |
| 5226 | |
| 5227 | @classmethod |
| 5228 | def _test_semaphore(cls, obj): |
| 5229 | obj.acquire() |
| 5230 | |
| 5231 | def test_semaphore(self, sname="Semaphore"): |
| 5232 | o = getattr(self.manager, sname)() |
| 5233 | self.run_worker(self._test_semaphore, o) |
| 5234 | o.release() |
| 5235 | |
| 5236 | def test_bounded_semaphore(self): |
| 5237 | self.test_semaphore(sname="BoundedSemaphore") |
| 5238 | |
| 5239 | @classmethod |
| 5240 | def _test_condition(cls, obj): |
| 5241 | obj.acquire() |
| 5242 | obj.release() |
| 5243 | |
| 5244 | def test_condition(self): |
| 5245 | o = self.manager.Condition() |
| 5246 | self.run_worker(self._test_condition, o) |
| 5247 | |
| 5248 | @classmethod |
| 5249 | def _test_barrier(cls, obj): |
| 5250 | assert obj.parties == 5 |
| 5251 | obj.reset() |
| 5252 | |
| 5253 | def test_barrier(self): |
| 5254 | o = self.manager.Barrier(5) |
| 5255 | self.run_worker(self._test_barrier, o) |
| 5256 | |
| 5257 | @classmethod |
| 5258 | def _test_pool(cls, obj): |
| 5259 | # TODO: fix https://bugs.python.org/issue35919 |
| 5260 | with obj: |
| 5261 | pass |
| 5262 | |
| 5263 | def test_pool(self): |
| 5264 | o = self.manager.Pool(processes=4) |
| 5265 | self.run_worker(self._test_pool, o) |
| 5266 | |
| 5267 | @classmethod |
Davin Potts | e895de3 | 2019-02-23 22:08:16 -0600 | [diff] [blame] | 5268 | def _test_queue(cls, obj): |
| 5269 | assert obj.qsize() == 2 |
| 5270 | assert obj.full() |
| 5271 | assert not obj.empty() |
| 5272 | assert obj.get() == 5 |
| 5273 | assert not obj.empty() |
| 5274 | assert obj.get() == 6 |
| 5275 | assert obj.empty() |
| 5276 | |
| 5277 | def test_queue(self, qname="Queue"): |
| 5278 | o = getattr(self.manager, qname)(2) |
| 5279 | o.put(5) |
| 5280 | o.put(6) |
| 5281 | self.run_worker(self._test_queue, o) |
| 5282 | assert o.empty() |
| 5283 | assert not o.full() |
| 5284 | |
| 5285 | def test_joinable_queue(self): |
| 5286 | self.test_queue("JoinableQueue") |
| 5287 | |
| 5288 | @classmethod |
Giampaolo Rodola | 2848d9d | 2019-02-07 03:03:11 -0800 | [diff] [blame] | 5289 | def _test_list(cls, obj): |
| 5290 | assert obj[0] == 5 |
| 5291 | assert obj.count(5) == 1 |
| 5292 | assert obj.index(5) == 0 |
| 5293 | obj.sort() |
| 5294 | obj.reverse() |
| 5295 | for x in obj: |
| 5296 | pass |
| 5297 | assert len(obj) == 1 |
| 5298 | assert obj.pop(0) == 5 |
| 5299 | |
| 5300 | def test_list(self): |
| 5301 | o = self.manager.list() |
| 5302 | o.append(5) |
| 5303 | self.run_worker(self._test_list, o) |
| 5304 | assert not o |
| 5305 | self.assertEqual(len(o), 0) |
| 5306 | |
| 5307 | @classmethod |
| 5308 | def _test_dict(cls, obj): |
| 5309 | assert len(obj) == 1 |
| 5310 | assert obj['foo'] == 5 |
| 5311 | assert obj.get('foo') == 5 |
Giampaolo Rodola | 2848d9d | 2019-02-07 03:03:11 -0800 | [diff] [blame] | 5312 | assert list(obj.items()) == [('foo', 5)] |
| 5313 | assert list(obj.keys()) == ['foo'] |
| 5314 | assert list(obj.values()) == [5] |
| 5315 | assert obj.copy() == {'foo': 5} |
| 5316 | assert obj.popitem() == ('foo', 5) |
| 5317 | |
| 5318 | def test_dict(self): |
| 5319 | o = self.manager.dict() |
| 5320 | o['foo'] = 5 |
| 5321 | self.run_worker(self._test_dict, o) |
| 5322 | assert not o |
| 5323 | self.assertEqual(len(o), 0) |
| 5324 | |
| 5325 | @classmethod |
| 5326 | def _test_value(cls, obj): |
| 5327 | assert obj.value == 1 |
| 5328 | assert obj.get() == 1 |
| 5329 | obj.set(2) |
| 5330 | |
| 5331 | def test_value(self): |
| 5332 | o = self.manager.Value('i', 1) |
| 5333 | self.run_worker(self._test_value, o) |
| 5334 | self.assertEqual(o.value, 2) |
| 5335 | self.assertEqual(o.get(), 2) |
| 5336 | |
| 5337 | @classmethod |
| 5338 | def _test_array(cls, obj): |
| 5339 | assert obj[0] == 0 |
| 5340 | assert obj[1] == 1 |
| 5341 | assert len(obj) == 2 |
| 5342 | assert list(obj) == [0, 1] |
| 5343 | |
| 5344 | def test_array(self): |
| 5345 | o = self.manager.Array('i', [0, 1]) |
| 5346 | self.run_worker(self._test_array, o) |
| 5347 | |
| 5348 | @classmethod |
| 5349 | def _test_namespace(cls, obj): |
| 5350 | assert obj.x == 0 |
| 5351 | assert obj.y == 1 |
| 5352 | |
| 5353 | def test_namespace(self): |
| 5354 | o = self.manager.Namespace() |
| 5355 | o.x = 0 |
| 5356 | o.y = 1 |
| 5357 | self.run_worker(self._test_namespace, o) |
| 5358 | |
| 5359 | |
Derek B. Kim | c40278e | 2018-07-11 19:22:28 +0900 | [diff] [blame] | 5360 | class MiscTestCase(unittest.TestCase): |
| 5361 | def test__all__(self): |
| 5362 | # Just make sure names in blacklist are excluded |
| 5363 | support.check__all__(self, multiprocessing, extra=multiprocessing.__all__, |
| 5364 | blacklist=['SUBDEBUG', 'SUBWARNING']) |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 5365 | # |
| 5366 | # Mixins |
| 5367 | # |
| 5368 | |
Victor Stinner | ffb4940 | 2017-07-25 01:55:54 +0200 | [diff] [blame] | 5369 | class BaseMixin(object): |
| 5370 | @classmethod |
| 5371 | def setUpClass(cls): |
| 5372 | cls.dangling = (multiprocessing.process._dangling.copy(), |
| 5373 | threading._dangling.copy()) |
| 5374 | |
| 5375 | @classmethod |
| 5376 | def tearDownClass(cls): |
| 5377 | # bpo-26762: Some multiprocessing objects like Pool create reference |
| 5378 | # cycles. Trigger a garbage collection to break these cycles. |
| 5379 | test.support.gc_collect() |
| 5380 | |
| 5381 | processes = set(multiprocessing.process._dangling) - set(cls.dangling[0]) |
| 5382 | if processes: |
Victor Stinner | 957d0e9 | 2017-08-10 17:36:50 +0200 | [diff] [blame] | 5383 | test.support.environment_altered = True |
Victor Stinner | ffb4940 | 2017-07-25 01:55:54 +0200 | [diff] [blame] | 5384 | print('Warning -- Dangling processes: %s' % processes, |
| 5385 | file=sys.stderr) |
| 5386 | processes = None |
| 5387 | |
| 5388 | threads = set(threading._dangling) - set(cls.dangling[1]) |
| 5389 | if threads: |
Victor Stinner | 957d0e9 | 2017-08-10 17:36:50 +0200 | [diff] [blame] | 5390 | test.support.environment_altered = True |
Victor Stinner | ffb4940 | 2017-07-25 01:55:54 +0200 | [diff] [blame] | 5391 | print('Warning -- Dangling threads: %s' % threads, |
| 5392 | file=sys.stderr) |
| 5393 | threads = None |
| 5394 | |
| 5395 | |
| 5396 | class ProcessesMixin(BaseMixin): |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 5397 | TYPE = 'processes' |
| 5398 | Process = multiprocessing.Process |
| 5399 | connection = multiprocessing.connection |
| 5400 | current_process = staticmethod(multiprocessing.current_process) |
| 5401 | active_children = staticmethod(multiprocessing.active_children) |
| 5402 | Pool = staticmethod(multiprocessing.Pool) |
| 5403 | Pipe = staticmethod(multiprocessing.Pipe) |
| 5404 | Queue = staticmethod(multiprocessing.Queue) |
| 5405 | JoinableQueue = staticmethod(multiprocessing.JoinableQueue) |
| 5406 | Lock = staticmethod(multiprocessing.Lock) |
| 5407 | RLock = staticmethod(multiprocessing.RLock) |
| 5408 | Semaphore = staticmethod(multiprocessing.Semaphore) |
| 5409 | BoundedSemaphore = staticmethod(multiprocessing.BoundedSemaphore) |
| 5410 | Condition = staticmethod(multiprocessing.Condition) |
| 5411 | Event = staticmethod(multiprocessing.Event) |
| 5412 | Barrier = staticmethod(multiprocessing.Barrier) |
| 5413 | Value = staticmethod(multiprocessing.Value) |
| 5414 | Array = staticmethod(multiprocessing.Array) |
| 5415 | RawValue = staticmethod(multiprocessing.RawValue) |
| 5416 | RawArray = staticmethod(multiprocessing.RawArray) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 5417 | |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 5418 | |
Victor Stinner | ffb4940 | 2017-07-25 01:55:54 +0200 | [diff] [blame] | 5419 | class ManagerMixin(BaseMixin): |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 5420 | TYPE = 'manager' |
| 5421 | Process = multiprocessing.Process |
| 5422 | Queue = property(operator.attrgetter('manager.Queue')) |
| 5423 | JoinableQueue = property(operator.attrgetter('manager.JoinableQueue')) |
| 5424 | Lock = property(operator.attrgetter('manager.Lock')) |
| 5425 | RLock = property(operator.attrgetter('manager.RLock')) |
| 5426 | Semaphore = property(operator.attrgetter('manager.Semaphore')) |
| 5427 | BoundedSemaphore = property(operator.attrgetter('manager.BoundedSemaphore')) |
| 5428 | Condition = property(operator.attrgetter('manager.Condition')) |
| 5429 | Event = property(operator.attrgetter('manager.Event')) |
| 5430 | Barrier = property(operator.attrgetter('manager.Barrier')) |
| 5431 | Value = property(operator.attrgetter('manager.Value')) |
| 5432 | Array = property(operator.attrgetter('manager.Array')) |
| 5433 | list = property(operator.attrgetter('manager.list')) |
| 5434 | dict = property(operator.attrgetter('manager.dict')) |
| 5435 | Namespace = property(operator.attrgetter('manager.Namespace')) |
| 5436 | |
| 5437 | @classmethod |
| 5438 | def Pool(cls, *args, **kwds): |
| 5439 | return cls.manager.Pool(*args, **kwds) |
| 5440 | |
| 5441 | @classmethod |
| 5442 | def setUpClass(cls): |
Victor Stinner | ffb4940 | 2017-07-25 01:55:54 +0200 | [diff] [blame] | 5443 | super().setUpClass() |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 5444 | cls.manager = multiprocessing.Manager() |
| 5445 | |
| 5446 | @classmethod |
| 5447 | def tearDownClass(cls): |
| 5448 | # only the manager process should be returned by active_children() |
| 5449 | # but this can take a bit on slow machines, so wait a few seconds |
| 5450 | # if there are other children too (see #17395) |
Victor Stinner | ffb4940 | 2017-07-25 01:55:54 +0200 | [diff] [blame] | 5451 | start_time = time.monotonic() |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 5452 | t = 0.01 |
Victor Stinner | ffb4940 | 2017-07-25 01:55:54 +0200 | [diff] [blame] | 5453 | while len(multiprocessing.active_children()) > 1: |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 5454 | time.sleep(t) |
| 5455 | t *= 2 |
Victor Stinner | ffb4940 | 2017-07-25 01:55:54 +0200 | [diff] [blame] | 5456 | dt = time.monotonic() - start_time |
| 5457 | if dt >= 5.0: |
Victor Stinner | 957d0e9 | 2017-08-10 17:36:50 +0200 | [diff] [blame] | 5458 | test.support.environment_altered = True |
Victor Stinner | ffb4940 | 2017-07-25 01:55:54 +0200 | [diff] [blame] | 5459 | print("Warning -- multiprocessing.Manager still has %s active " |
| 5460 | "children after %s seconds" |
| 5461 | % (multiprocessing.active_children(), dt), |
| 5462 | file=sys.stderr) |
| 5463 | break |
| 5464 | |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 5465 | gc.collect() # do garbage collection |
| 5466 | if cls.manager._number_of_objects() != 0: |
| 5467 | # This is not really an error since some tests do not |
| 5468 | # ensure that all processes which hold a reference to a |
| 5469 | # managed object have been joined. |
Victor Stinner | 957d0e9 | 2017-08-10 17:36:50 +0200 | [diff] [blame] | 5470 | test.support.environment_altered = True |
Victor Stinner | ffb4940 | 2017-07-25 01:55:54 +0200 | [diff] [blame] | 5471 | print('Warning -- Shared objects which still exist at manager ' |
| 5472 | 'shutdown:') |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 5473 | print(cls.manager._debug_info()) |
| 5474 | cls.manager.shutdown() |
| 5475 | cls.manager.join() |
| 5476 | cls.manager = None |
Richard Oudkerk | 14f5ee0 | 2013-07-19 22:53:42 +0100 | [diff] [blame] | 5477 | |
Victor Stinner | ffb4940 | 2017-07-25 01:55:54 +0200 | [diff] [blame] | 5478 | super().tearDownClass() |
Richard Oudkerk | 14f5ee0 | 2013-07-19 22:53:42 +0100 | [diff] [blame] | 5479 | |
Victor Stinner | ffb4940 | 2017-07-25 01:55:54 +0200 | [diff] [blame] | 5480 | |
| 5481 | class ThreadsMixin(BaseMixin): |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 5482 | TYPE = 'threads' |
| 5483 | Process = multiprocessing.dummy.Process |
| 5484 | connection = multiprocessing.dummy.connection |
| 5485 | current_process = staticmethod(multiprocessing.dummy.current_process) |
| 5486 | active_children = staticmethod(multiprocessing.dummy.active_children) |
Antoine Pitrou | 62b6a0d | 2016-03-15 10:48:28 +0100 | [diff] [blame] | 5487 | Pool = staticmethod(multiprocessing.dummy.Pool) |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 5488 | Pipe = staticmethod(multiprocessing.dummy.Pipe) |
| 5489 | Queue = staticmethod(multiprocessing.dummy.Queue) |
| 5490 | JoinableQueue = staticmethod(multiprocessing.dummy.JoinableQueue) |
| 5491 | Lock = staticmethod(multiprocessing.dummy.Lock) |
| 5492 | RLock = staticmethod(multiprocessing.dummy.RLock) |
| 5493 | Semaphore = staticmethod(multiprocessing.dummy.Semaphore) |
| 5494 | BoundedSemaphore = staticmethod(multiprocessing.dummy.BoundedSemaphore) |
| 5495 | Condition = staticmethod(multiprocessing.dummy.Condition) |
| 5496 | Event = staticmethod(multiprocessing.dummy.Event) |
| 5497 | Barrier = staticmethod(multiprocessing.dummy.Barrier) |
| 5498 | Value = staticmethod(multiprocessing.dummy.Value) |
| 5499 | Array = staticmethod(multiprocessing.dummy.Array) |
| 5500 | |
| 5501 | # |
| 5502 | # Functions used to create test cases from the base ones in this module |
| 5503 | # |
| 5504 | |
| 5505 | def install_tests_in_module_dict(remote_globs, start_method): |
| 5506 | __module__ = remote_globs['__name__'] |
| 5507 | local_globs = globals() |
| 5508 | ALL_TYPES = {'processes', 'threads', 'manager'} |
| 5509 | |
| 5510 | for name, base in local_globs.items(): |
| 5511 | if not isinstance(base, type): |
| 5512 | continue |
| 5513 | if issubclass(base, BaseTestCase): |
| 5514 | if base is BaseTestCase: |
| 5515 | continue |
| 5516 | assert set(base.ALLOWED_TYPES) <= ALL_TYPES, base.ALLOWED_TYPES |
| 5517 | for type_ in base.ALLOWED_TYPES: |
| 5518 | newname = 'With' + type_.capitalize() + name[1:] |
| 5519 | Mixin = local_globs[type_.capitalize() + 'Mixin'] |
| 5520 | class Temp(base, Mixin, unittest.TestCase): |
| 5521 | pass |
| 5522 | Temp.__name__ = Temp.__qualname__ = newname |
| 5523 | Temp.__module__ = __module__ |
| 5524 | remote_globs[newname] = Temp |
| 5525 | elif issubclass(base, unittest.TestCase): |
| 5526 | class Temp(base, object): |
| 5527 | pass |
| 5528 | Temp.__name__ = Temp.__qualname__ = name |
| 5529 | Temp.__module__ = __module__ |
| 5530 | remote_globs[name] = Temp |
| 5531 | |
Richard Oudkerk | e0d25ce | 2013-08-29 14:37:47 +0100 | [diff] [blame] | 5532 | dangling = [None, None] |
| 5533 | old_start_method = [None] |
| 5534 | |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 5535 | def setUpModule(): |
| 5536 | multiprocessing.set_forkserver_preload(PRELOAD) |
Richard Oudkerk | e0d25ce | 2013-08-29 14:37:47 +0100 | [diff] [blame] | 5537 | multiprocessing.process._cleanup() |
| 5538 | dangling[0] = multiprocessing.process._dangling.copy() |
| 5539 | dangling[1] = threading._dangling.copy() |
Richard Oudkerk | b1694cf | 2013-10-16 16:41:56 +0100 | [diff] [blame] | 5540 | old_start_method[0] = multiprocessing.get_start_method(allow_none=True) |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 5541 | try: |
Richard Oudkerk | b1694cf | 2013-10-16 16:41:56 +0100 | [diff] [blame] | 5542 | multiprocessing.set_start_method(start_method, force=True) |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 5543 | except ValueError: |
| 5544 | raise unittest.SkipTest(start_method + |
| 5545 | ' start method not supported') |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 5546 | |
| 5547 | if sys.platform.startswith("linux"): |
| 5548 | try: |
| 5549 | lock = multiprocessing.RLock() |
| 5550 | except OSError: |
| 5551 | raise unittest.SkipTest("OSError raises on RLock creation, " |
| 5552 | "see issue 3111!") |
| 5553 | check_enough_semaphores() |
| 5554 | util.get_temp_dir() # creates temp directory |
| 5555 | multiprocessing.get_logger().setLevel(LOG_LEVEL) |
| 5556 | |
| 5557 | def tearDownModule(): |
Victor Stinner | ffb4940 | 2017-07-25 01:55:54 +0200 | [diff] [blame] | 5558 | need_sleep = False |
| 5559 | |
| 5560 | # bpo-26762: Some multiprocessing objects like Pool create reference |
| 5561 | # cycles. Trigger a garbage collection to break these cycles. |
| 5562 | test.support.gc_collect() |
| 5563 | |
Richard Oudkerk | b1694cf | 2013-10-16 16:41:56 +0100 | [diff] [blame] | 5564 | multiprocessing.set_start_method(old_start_method[0], force=True) |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 5565 | # pause a bit so we don't get warning about dangling threads/processes |
Victor Stinner | ffb4940 | 2017-07-25 01:55:54 +0200 | [diff] [blame] | 5566 | processes = set(multiprocessing.process._dangling) - set(dangling[0]) |
| 5567 | if processes: |
| 5568 | need_sleep = True |
Victor Stinner | 957d0e9 | 2017-08-10 17:36:50 +0200 | [diff] [blame] | 5569 | test.support.environment_altered = True |
Victor Stinner | ffb4940 | 2017-07-25 01:55:54 +0200 | [diff] [blame] | 5570 | print('Warning -- Dangling processes: %s' % processes, |
| 5571 | file=sys.stderr) |
| 5572 | processes = None |
| 5573 | |
| 5574 | threads = set(threading._dangling) - set(dangling[1]) |
| 5575 | if threads: |
| 5576 | need_sleep = True |
Victor Stinner | 957d0e9 | 2017-08-10 17:36:50 +0200 | [diff] [blame] | 5577 | test.support.environment_altered = True |
Victor Stinner | ffb4940 | 2017-07-25 01:55:54 +0200 | [diff] [blame] | 5578 | print('Warning -- Dangling threads: %s' % threads, |
| 5579 | file=sys.stderr) |
| 5580 | threads = None |
| 5581 | |
| 5582 | # Sleep 500 ms to give time to child processes to complete. |
| 5583 | if need_sleep: |
| 5584 | time.sleep(0.5) |
Richard Oudkerk | e0d25ce | 2013-08-29 14:37:47 +0100 | [diff] [blame] | 5585 | multiprocessing.process._cleanup() |
Victor Stinner | ffb4940 | 2017-07-25 01:55:54 +0200 | [diff] [blame] | 5586 | test.support.gc_collect() |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 5587 | |
| 5588 | remote_globs['setUpModule'] = setUpModule |
| 5589 | remote_globs['tearDownModule'] = tearDownModule |