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 #141473
This commit is contained in:
Gregory P. Smith 2025-11-30 18:50:05 -08:00 committed by GitHub
parent 981ce0cf3a
commit 3e2c557493
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -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