From dfc2732a57e3ea6603d62f769d4f9c80be726fa4 Mon Sep 17 00:00:00 2001 From: Sam Ezeh <sam.z.ezeh@gmail.com> Date: Sun, 27 Nov 2022 17:58:39 +0000 Subject: [PATCH] gh-91340: Document multiprocessing.set_start_method force parameter (GH-32339) #91340 https://bugs.python.org/issue47184 Automerge-Triggered-By: GH:kumaraditya303 --- Doc/library/multiprocessing.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst index 55160847806..b5ceeb796f8 100644 --- a/Doc/library/multiprocessing.rst +++ b/Doc/library/multiprocessing.rst @@ -1089,10 +1089,14 @@ Miscellaneous .. versionchanged:: 3.11 Accepts a :term:`path-like object`. -.. function:: set_start_method(method) +.. function:: set_start_method(method, force=False) Set the method which should be used to start child processes. - *method* can be ``'fork'``, ``'spawn'`` or ``'forkserver'``. + The *method* argument can be ``'fork'``, ``'spawn'`` or ``'forkserver'``. + Raises :exc:`RuntimeError` if the start method has already been set and *force* + is not ``True``. If *method* is ``None`` and *force* is ``True`` then the start + method is set to ``None``. If *method* is ``None`` and *force* is ``False`` + then the context is set to the default context. Note that this should be called at most once, and it should be protected inside the ``if __name__ == '__main__'`` clause of the -- GitLab