pythongh-98966: Handle stdout=subprocess.STDOUT (pythonGH-98967)

ptsneves · diegorusso · commit 7f6ae1e67af3 · 2024-04-17T11:30:33.000+01:00
Explicitly handle the case where stdout=STDOUT
as otherwise the existing error handling gets
confused and reports hard to understand errors.

Signed-off-by: Paulo Neves &lt;ptsneves@gmail.com&gt;
diff --git a/Lib/subprocess.py b/Lib/subprocess.py
@@ -839,6 +839,9 @@ def __init__(self, args, bufsize=-1, executable=None,
         if not isinstance(bufsize, int):
             raise TypeError("bufsize must be an integer")
 
+        if stdout is STDOUT:
+             raise ValueError("STDOUT can only be used for stderr")
+
         if pipesize is None:
             pipesize = -1  # Restore default
         if not isinstance(pipesize, int):
diff --git a/Lib/test/test_subprocess.py b/Lib/test/test_subprocess.py
@@ -1763,6 +1763,13 @@ def test_capture_output(self):
         self.assertIn(b'BDFL', cp.stdout)
         self.assertIn(b'FLUFL', cp.stderr)
 
+    def test_stdout_stdout(self):
+        # run() refuses to accept stdout=STDOUT
+        with self.assertRaises(ValueError,
+                msg=("STDOUT can only be used for stderr")):
+            self.run_python("print('will not be run')",
+                            stdout=subprocess.STDOUT)
+
     def test_stdout_with_capture_output_arg(self):
         # run() refuses to accept 'stdout' with 'capture_output'
         tf = tempfile.TemporaryFile()
diff --git a/Misc/NEWS.d/next/Library/2024-03-26-11-48-39.gh-issue-98966.SayV9y.rst b/Misc/NEWS.d/next/Library/2024-03-26-11-48-39.gh-issue-98966.SayV9y.rst
@@ -0,0 +1,2 @@
+In :mod:`subprocess`, raise a more informative message when
+``stdout=STDOUT``.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	+In :mod:`subprocess`, raise a more informative message when
	`2`	+``stdout=STDOUT``.