-
-
Notifications
You must be signed in to change notification settings - Fork 34.5k
gh-117378: Fix multiprocessing forkserver preload sys.path inheritance. #126538
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
Merged
gpshead
merged 7 commits into
python:main
from
gpshead:bug/multiprocessing-forkserver-preload-sys-path
Nov 9, 2024
Merged
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
c40b26d
gh-117378: Fix multiprocessing forkserver preload sys.path inheritance.
gpshead 702e0b7
NEWS entry
gpshead 7ad114f
move sys.path setting up per review.
gpshead cf07467
Redo the test as an sys.path integration test.
gpshead 4fe3389
avoid := for readability
gpshead 3f486f8
reword NEWS
gpshead 2444519
news sphinx-lint fix
gpshead File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
57 changes: 57 additions & 0 deletions
57
Lib/test/test_multiprocessing_forkserver/test_forkserver_main.py
|
gpshead marked this conversation as resolved.
Outdated
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| import os | ||
| import sys | ||
| import unittest | ||
| from unittest import mock | ||
|
|
||
| from multiprocessing import forkserver | ||
|
|
||
|
|
||
| class TestForkserverMain(unittest.TestCase): | ||
|
|
||
| def setUp(self): | ||
| self._orig_sys_path = list(sys.path) | ||
|
|
||
| def tearDown(self): | ||
| sys.path[:] = self._orig_sys_path | ||
|
|
||
| @mock.patch("multiprocessing.process.current_process") | ||
| @mock.patch("multiprocessing.spawn.import_main_path") | ||
| @mock.patch("multiprocessing.util._close_stdin") | ||
| def test_preload_kwargs( | ||
| self, | ||
| mock_close_stdin, | ||
| mock_import_main_path, | ||
| mock_current_process, | ||
| ): | ||
| # Very much a whitebox test of the first stanza of main before | ||
| # we start diddling with file descriptors and pipes. | ||
| mock_close_stdin.side_effect = RuntimeError("stop test") | ||
| self.assertNotIn( | ||
| "colorsys", | ||
| sys.modules.keys(), | ||
| msg="Thie test requires a module that has not yet been imported.", | ||
| ) | ||
|
|
||
| with self.assertRaisesRegex(RuntimeError, "stop test"): | ||
| forkserver.main(None, None, ["sys", "colorsys"]) | ||
| mock_current_process.assert_not_called() | ||
| mock_import_main_path.assert_not_called() | ||
| self.assertIn("colorsys", sys.modules.keys()) | ||
| self.assertEqual(sys.path, self._orig_sys_path) # unmodified | ||
|
|
||
| del sys.modules["colorsys"] # unimport | ||
| fake_path = os.path.dirname(__file__) | ||
| with self.assertRaisesRegex(RuntimeError, "stop test"): | ||
| forkserver.main(None, None, ["sys", "colorsys"], sys_path=[fake_path]) | ||
| self.assertEqual( | ||
| sys.path, [fake_path], msg="sys.path should have been overridden" | ||
| ) | ||
| self.assertNotIn( | ||
| "colorsys", | ||
| sys.modules.keys(), | ||
| msg="import of colorsys should have failed with unusual sys.path", | ||
| ) | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| unittest.main() |
11 changes: 11 additions & 0 deletions
11
Misc/NEWS.d/next/Library/2024-11-07-01-40-11.gh-issue-117378.o9O5uM.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| Fixed the :mod:`multiprocessing` ``"forkserver"`` start method forkserver | ||
| process was to correctly inherit the parent's :data:`sys.path` during the | ||
| importing of :func:`multiprocessing.set_forkserver_preload` modules in the | ||
| same manner as :data:`sys.path` is configured when executing work items in | ||
| the worker processes. | ||
|
|
||
| This bug could cause some forkserver module preloading to silently fail to | ||
| be preloaded, leading to a performance degration in child processes due to | ||
| additional repeated work. It could also have led to a side effect of ``""`` | ||
| still being in :data:`sys.path` during forkserver preload imports instead of | ||
| the absolute path of the directory that workers see. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.