-
-
Notifications
You must be signed in to change notification settings - Fork 33.2k
gh-109070: Document that multiprocessing.get_context() sets the global context
#109488
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from 2 commits
1697860
27108e2
6efbf9e
8eef516
9c2148c
c547404
479a722
673c786
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1049,27 +1049,25 @@ Miscellaneous | |
|
|
||
| .. function:: get_context(method=None) | ||
|
|
||
| Return a context object which has the same attributes as the | ||
| :mod:`multiprocessing` module. | ||
| Return a context object with the same attributes as the :mod:`multiprocessing` module. | ||
|
|
||
| If *method* is ``None`` then the default context is returned. | ||
| Otherwise *method* should be ``'fork'``, ``'spawn'``, | ||
| ``'forkserver'``. :exc:`ValueError` is raised if the specified | ||
| start method is not available. See :ref:`multiprocessing-start-methods`. | ||
| If *method* is ``None``, the default context is returned. Be aware that calling this function with *method=None* sets the default context globally, potentially affecting future usage of :func:`set_start_method`. To change the method later, it is recommended to explicitly specify a method other than ``None`` when calling this function. Otherwise, it may lead to unexpected behavior. | ||
|
||
|
|
||
| *method* should be one of the following: ``'fork'``, ``'spawn'``, or ``'forkserver'``. A :exc:`ValueError` is raised if the specified start method is unavailable. See :ref:`multiprocessing-start-methods`. | ||
|
|
||
| .. versionadded:: 3.4 | ||
|
|
||
| .. function:: get_start_method(allow_none=False) | ||
|
|
||
| Return the name of start method used for starting processes. | ||
| Return the name of the start method used for initiating processes. | ||
|
||
|
|
||
| If the start method has not been explicitly set (e.g., using :func:`set_start_method`) and *allow_none* is false, then the start method is fixed to the default, and the name of the default method is returned. If the start method has not been explicitly set and *allow_none* is true, then ``None`` is returned, indicating that the method has not been explicitly set. | ||
|
|
||
| The return value can be one of the following: ``'fork'``, ``'spawn'``, ``'forkserver'``, or ``None``. | ||
|
|
||
| If the start method has not been fixed and *allow_none* is false, | ||
| then the start method is fixed to the default and the name is | ||
| returned. If the start method has not been fixed and *allow_none* | ||
| is true then ``None`` is returned. | ||
| .. note:: Exercise caution when changing the start method using ``multiprocessing.set_start_method`` after using ``multiprocessing.get_start_method`` with *allow_none* set to ``False``, as it may raise a ``RuntimeError``. | ||
|
|
||
| The return value can be ``'fork'``, ``'spawn'``, ``'forkserver'`` | ||
| or ``None``. See :ref:`multiprocessing-start-methods`. | ||
| See :ref:`multiprocessing-start-methods` for more information on multiprocessing start methods and their implications. | ||
|
||
|
|
||
| .. versionchanged:: 3.8 | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We tend to avoid unrelated changes, pleas revert the change to the summary line.