-
-
Notifications
You must be signed in to change notification settings - Fork 34.8k
gh-119710: Let asyncio Process.wait() finish on only process exit. #151983
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
Open
tapetersen
wants to merge
2
commits into
python:main
Choose a base branch
from
tapetersen:gh-119710-subprocess-wait-hang
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+56
−19
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
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 |
|---|---|---|
|
|
@@ -128,9 +128,6 @@ def test_proc_exited_no_invalid_state_error_on_exit_waiters(self): | |
| exit_waiter = self.loop.create_future() | ||
| transport._exit_waiters.append(exit_waiter) | ||
|
|
||
| # _connect_pipes hasn't completed, so _pipes_connected is False. | ||
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. My inclination would be to remove this test fully since it should be covered by |
||
| self.assertFalse(transport._pipes_connected) | ||
|
|
||
| # Simulate process exit. _try_finish() will set the result on | ||
| # exit_waiter because _pipes_connected is False, and then schedule | ||
| # _call_connection_lost() because _pipes is empty (vacuously all | ||
|
|
@@ -436,6 +433,47 @@ async def len_message(message): | |
| self.assertEqual(output.rstrip(), b'3') | ||
| self.assertEqual(exitcode, 0) | ||
|
|
||
| def test_wait_even_if_pipe_is_open(self): | ||
| # gh-119710: Process.wait() must return once the process exits even | ||
| # if its stdout pipe is inherited by a grandchild that keeps it open, | ||
| # so the pipe never reaches EOF. Otherwise wait() hangs forever | ||
| # despite the returncode being known. | ||
|
|
||
| async def run(): | ||
| # Just setup a pipe to pass to the grandchild for reading to ensure it dies. | ||
| # Inheritable is to allow it to be passed on windows | ||
| r, w = os.pipe() | ||
| os.set_inheritable(r, True) | ||
|
|
||
| code = textwrap.dedent(f"""\ | ||
| import subprocess, sys | ||
| subprocess.run([sys.executable, "-c", "import sys;sys.stdin.read()"]) | ||
| """) | ||
|
|
||
| proc = await asyncio.create_subprocess_exec( | ||
| sys.executable, "-c", code, | ||
| # This will be inherited by granchild and should not prevent | ||
| # *this* process from firing .wait(). | ||
| stdout=subprocess.PIPE, | ||
| stdin=r, | ||
| pass_fds=(r,) if sys.platform != "win32" else (), | ||
| close_fds=False if sys.platform == "win32" else True, | ||
| ) | ||
| os.close(r) | ||
|
|
||
| try: | ||
| # Ensure we start waiting before the process is killed. | ||
| wait_proc = asyncio.create_task(proc.wait()) | ||
| await asyncio.sleep(0.1) | ||
| proc.kill() | ||
| await asyncio.wait_for(wait_proc, timeout=2.0) | ||
| finally: | ||
| os.close(w) # Allows the grandchild to exit | ||
| if proc.stdout is not None: | ||
| await proc.stdout.read() | ||
|
|
||
| self.loop.run_until_complete(run()) | ||
|
|
||
| def test_empty_input(self): | ||
|
|
||
| async def empty_input(): | ||
|
|
||
4 changes: 4 additions & 0 deletions
4
Misc/NEWS.d/next/Library/2026-06-11-10-00-00.gh-issue-119710.Qz7Kp2.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,4 @@ | ||
| Fix :mod:`asyncio` subprocess :meth:`~asyncio.subprocess.Process.wait` | ||
| hanging when the process has exited but one of its pipes is kept open by an | ||
| inherited child process (so the pipe never reaches EOF). ``wait()`` now | ||
| returns as soon as the process exits, regardless of the pipes' state. |
Oops, something went wrong.
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.
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.
This could be changed back to
not waiter.cancelled()(reverting that part of #145554) since this should now be the only place they are otherwise resolved.