mirror of
https://github.com/python/cpython.git
synced 2025-09-26 10:19:53 +00:00
gh-128041: Add terminate_workers
and kill_workers
methods to ProcessPoolExecutor (GH-128043)
This adds two new methods to `multiprocessing`'s `ProcessPoolExecutor`: - **`terminate_workers()`**: forcefully terminates worker processes using `Process.terminate()` - **`kill_workers()`**: forcefully kills worker processes using `Process.kill()` These methods provide users with a direct way to stop worker processes without `shutdown()` or relying on implementation details, addressing situations where immediate termination is needed. Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com> Commit-message-mostly-authored-by: Claude Sonnet 3.7 (because why not -greg)
This commit is contained in:
parent
7afa476874
commit
f97e4098ff
5 changed files with 201 additions and 0 deletions
|
@ -1,13 +1,17 @@
|
|||
import os
|
||||
import queue
|
||||
import signal
|
||||
import sys
|
||||
import threading
|
||||
import time
|
||||
import unittest
|
||||
import unittest.mock
|
||||
from concurrent import futures
|
||||
from concurrent.futures.process import BrokenProcessPool
|
||||
|
||||
from test import support
|
||||
from test.support import hashlib_helper
|
||||
from test.test_importlib.metadata.fixtures import parameterize
|
||||
|
||||
from .executor import ExecutorTest, mul
|
||||
from .util import (
|
||||
|
@ -22,6 +26,19 @@ class EventfulGCObj():
|
|||
def __del__(self):
|
||||
self.event.set()
|
||||
|
||||
TERMINATE_WORKERS = futures.ProcessPoolExecutor.terminate_workers.__name__
|
||||
KILL_WORKERS = futures.ProcessPoolExecutor.kill_workers.__name__
|
||||
FORCE_SHUTDOWN_PARAMS = [
|
||||
dict(function_name=TERMINATE_WORKERS),
|
||||
dict(function_name=KILL_WORKERS),
|
||||
]
|
||||
|
||||
def _put_sleep_put(queue):
|
||||
""" Used as part of test_terminate_workers """
|
||||
queue.put('started')
|
||||
time.sleep(2)
|
||||
queue.put('finished')
|
||||
|
||||
|
||||
class ProcessPoolExecutorTest(ExecutorTest):
|
||||
|
||||
|
@ -218,6 +235,86 @@ class ProcessPoolExecutorTest(ExecutorTest):
|
|||
list(executor.map(mul, [(2, 3)] * 10))
|
||||
executor.shutdown()
|
||||
|
||||
def test_terminate_workers(self):
|
||||
mock_fn = unittest.mock.Mock()
|
||||
with self.executor_type(max_workers=1) as executor:
|
||||
executor._force_shutdown = mock_fn
|
||||
executor.terminate_workers()
|
||||
|
||||
mock_fn.assert_called_once_with(operation=futures.process._TERMINATE)
|
||||
|
||||
def test_kill_workers(self):
|
||||
mock_fn = unittest.mock.Mock()
|
||||
with self.executor_type(max_workers=1) as executor:
|
||||
executor._force_shutdown = mock_fn
|
||||
executor.kill_workers()
|
||||
|
||||
mock_fn.assert_called_once_with(operation=futures.process._KILL)
|
||||
|
||||
def test_force_shutdown_workers_invalid_op(self):
|
||||
with self.executor_type(max_workers=1) as executor:
|
||||
self.assertRaises(ValueError,
|
||||
executor._force_shutdown,
|
||||
operation='invalid operation'),
|
||||
|
||||
@parameterize(*FORCE_SHUTDOWN_PARAMS)
|
||||
def test_force_shutdown_workers(self, function_name):
|
||||
manager = self.get_context().Manager()
|
||||
q = manager.Queue()
|
||||
|
||||
with self.executor_type(max_workers=1) as executor:
|
||||
executor.submit(_put_sleep_put, q)
|
||||
|
||||
# We should get started, but not finished since we'll terminate the
|
||||
# workers just after
|
||||
self.assertEqual(q.get(timeout=5), 'started')
|
||||
|
||||
worker_process = list(executor._processes.values())[0]
|
||||
getattr(executor, function_name)()
|
||||
worker_process.join()
|
||||
|
||||
if function_name == TERMINATE_WORKERS or \
|
||||
sys.platform == 'win32':
|
||||
# On windows, kill and terminate both send SIGTERM
|
||||
self.assertEqual(worker_process.exitcode, -signal.SIGTERM)
|
||||
elif function_name == KILL_WORKERS:
|
||||
self.assertEqual(worker_process.exitcode, -signal.SIGKILL)
|
||||
else:
|
||||
self.fail(f"Unknown operation: {function_name}")
|
||||
|
||||
self.assertRaises(queue.Empty, q.get, timeout=1)
|
||||
|
||||
@parameterize(*FORCE_SHUTDOWN_PARAMS)
|
||||
def test_force_shutdown_workers_dead_workers(self, function_name):
|
||||
with self.executor_type(max_workers=1) as executor:
|
||||
future = executor.submit(os._exit, 1)
|
||||
self.assertRaises(BrokenProcessPool, future.result)
|
||||
|
||||
# even though the pool is broken, this shouldn't raise
|
||||
getattr(executor, function_name)()
|
||||
|
||||
@parameterize(*FORCE_SHUTDOWN_PARAMS)
|
||||
def test_force_shutdown_workers_not_started_yet(self, function_name):
|
||||
ctx = self.get_context()
|
||||
with unittest.mock.patch.object(ctx, 'Process') as mock_process:
|
||||
with self.executor_type(max_workers=1, mp_context=ctx) as executor:
|
||||
# The worker has not been started yet, terminate/kill_workers
|
||||
# should basically no-op
|
||||
getattr(executor, function_name)()
|
||||
|
||||
mock_process.return_value.kill.assert_not_called()
|
||||
mock_process.return_value.terminate.assert_not_called()
|
||||
|
||||
@parameterize(*FORCE_SHUTDOWN_PARAMS)
|
||||
def test_force_shutdown_workers_stops_pool(self, function_name):
|
||||
with self.executor_type(max_workers=1) as executor:
|
||||
task = executor.submit(time.sleep, 0)
|
||||
self.assertIsNone(task.result())
|
||||
|
||||
getattr(executor, function_name)()
|
||||
|
||||
self.assertRaises(RuntimeError, executor.submit, time.sleep, 0)
|
||||
|
||||
|
||||
create_executor_tests(globals(), ProcessPoolExecutorTest,
|
||||
executor_mixins=(ProcessPoolForkMixin,
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue