1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
|
# This file is part of Pebble.
# Copyright (c) 2013-2025, Matteo Cafasso
# Pebble is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License
# as published by the Free Software Foundation,
# either version 3 of the License, or (at your option) any later version.
# Pebble is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
# You should have received a copy of the GNU Lesser General Public License
# along with Pebble. If not, see <http://www.gnu.org/licenses/>.
import os
import sys
import types
import pickle
import signal
import multiprocessing
from traceback import format_exc
from typing import Any, Callable
from pebble.common.types import Result, ResultStatus, RemoteException, CONSTS
def launch_process(
name: str,
function: Callable,
daemon: bool, mp_context: multiprocessing.context,
*args,
**kwargs
) -> multiprocessing.Process:
process = mp_context.Process(
target=function, name=name, args=args, kwargs=kwargs)
process.daemon = daemon
process.start()
return process
def stop_process(process: multiprocessing.Process):
"""Does its best to stop the process."""
process.terminate()
process.join(CONSTS.term_timeout)
if process.is_alive() and os.name != 'nt':
try:
os.kill(process.pid, signal.SIGKILL)
process.join()
except OSError:
return
if process.is_alive():
raise RuntimeError("Unable to terminate PID %d" % os.getpid())
def process_execute(function: Callable, *args, **kwargs) -> Result:
"""Runs the given function returning its results or exception."""
try:
return Result(ResultStatus.SUCCESS, function(*args, **kwargs))
except BaseException as error:
return Result(ResultStatus.FAILURE, RemoteException(error, format_exc()))
def send_result(pipe: multiprocessing.Pipe, data: Any):
"""Send result handling pickling and communication errors."""
try:
pipe.send(data)
except (pickle.PicklingError, TypeError) as error:
pipe.send(Result(ResultStatus.ERROR, RemoteException(error, format_exc())))
def function_handler(
function: Callable,
args: list,
kwargs: dict,
pipe: multiprocessing.Pipe
):
"""Runs the actual function in separate process and returns its result."""
signal.signal(signal.SIGINT, signal.SIG_IGN)
signal.signal(signal.SIGTERM, signal.SIG_DFL)
reader, writer = pipe
reader.close()
result = process_execute(function, *args, **kwargs)
send_result(writer, result)
################################################################################
# Spawn process start method handling logic. #
# #
# Processes created via Spawn will load the modules anew. As a consequence, #
# @concurrent/@asynchronous decorated functions will be decorated again #
# making the child process unable to execute them. #
################################################################################
_registered_functions = {}
def register_function(function: Callable) -> Callable:
"""Registers the function to be used within the trampoline."""
_registered_functions[function.__qualname__] = function
return function
def maybe_install_trampoline(
function: Callable,
args: list,
start_method: str
) -> tuple:
"""Install the trampoline on the right process start methods."""
if isinstance(function, types.FunctionType) and start_method != 'fork':
target = _trampoline
args = [function.__qualname__, function.__module__] + list(args)
else:
target = function
return target, args
def _trampoline(name: str, module: Any, *args, **kwargs) -> Any:
"""Trampoline function for decorators.
Lookups the function between the registered ones;
if not found, forces its registering and then executes it.
"""
function = _function_lookup(name, module)
return function(*args, **kwargs)
def _function_lookup(name: str, module: Any) -> Callable:
"""Searches the function between the registered ones.
If not found, it imports the module forcing its registration.
"""
try:
return _registered_functions[name]
except KeyError: # force function registering
__import__(module)
mod = sys.modules[module]
function = getattr(mod, name)
try:
return _registered_functions[name]
except KeyError: # decorator without @pie syntax
return register_function(function)
|