From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Mon, 1 Dec 2025 02:56:30 +0000 (+0100)
Subject: [3.13] gh-141473: Document not calling Popen.wait after Popen.communicate times out... 
X-Git-Tag: v3.13.10~11
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6871aa160f33b4d9e73428a761615aa0f7a1091b;p=thirdparty%2FPython%2Fcpython.git

[3.13] gh-141473: Document not calling Popen.wait after Popen.communicate times out. (GH-142101) (#142125)

gh-141473: Document not calling Popen.wait after Popen.communicate times out. (GH-142101)

Document not calling Popen.wait after Popen.communicate times out.

Closes GH-141473
(cherry picked from commit 3e2c55749326809a2fc76b9f2cb87a6f89037ebe)

Co-authored-by: Gregory P. Smith <68491+gpshead@users.noreply.github.com>
---

diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst
index 45dfd9ed0258..f6d9a6133fa8 100644
--- a/Doc/library/subprocess.rst
+++ b/Doc/library/subprocess.rst
@@ -846,6 +846,11 @@ Instances of the :class:`Popen` class have the following methods:
           proc.kill()
           outs, errs = proc.communicate()
 
+   After a call to :meth:`~Popen.communicate` raises :exc:`TimeoutExpired`, do
+   not call :meth:`~Popen.wait`. Use an additional :meth:`~Popen.communicate`
+   call to finish handling pipes and populate the :attr:`~Popen.returncode`
+   attribute.
+
    .. note::
 
       The data read is buffered in memory, so do not use this method if the data