bpo-36686: Improve the documentation of the std* params in loop.subprocess_exec (GH-13586)
https://bugs.python.org/issue36686
diff --git a/Lib/asyncio/base_events.py b/Lib/asyncio/base_events.py
index e5cd14b..68105ee 100644
--- a/Lib/asyncio/base_events.py
+++ b/Lib/asyncio/base_events.py
@@ -1555,6 +1555,7 @@
stderr=subprocess.PIPE,
universal_newlines=False,
shell=True, bufsize=0,
+ encoding=None, errors=None, text=None,
**kwargs):
if not isinstance(cmd, (bytes, str)):
raise ValueError("cmd must be a string")
@@ -1564,6 +1565,13 @@
raise ValueError("shell must be True")
if bufsize != 0:
raise ValueError("bufsize must be 0")
+ if text:
+ raise ValueError("text must be False")
+ if encoding is not None:
+ raise ValueError("encoding must be None")
+ if errors is not None:
+ raise ValueError("errors must be None")
+
protocol = protocol_factory()
debug_log = None
if self._debug:
@@ -1580,13 +1588,22 @@
async def subprocess_exec(self, protocol_factory, program, *args,
stdin=subprocess.PIPE, stdout=subprocess.PIPE,
stderr=subprocess.PIPE, universal_newlines=False,
- shell=False, bufsize=0, **kwargs):
+ shell=False, bufsize=0,
+ encoding=None, errors=None, text=None,
+ **kwargs):
if universal_newlines:
raise ValueError("universal_newlines must be False")
if shell:
raise ValueError("shell must be False")
if bufsize != 0:
raise ValueError("bufsize must be 0")
+ if text:
+ raise ValueError("text must be False")
+ if encoding is not None:
+ raise ValueError("encoding must be None")
+ if errors is not None:
+ raise ValueError("errors must be None")
+
popen_args = (program,) + args
for arg in popen_args:
if not isinstance(arg, (str, bytes)):
diff --git a/Lib/test/test_asyncio/test_subprocess.py b/Lib/test/test_asyncio/test_subprocess.py
index 551974a..f1ab039 100644
--- a/Lib/test/test_asyncio/test_subprocess.py
+++ b/Lib/test/test_asyncio/test_subprocess.py
@@ -335,6 +335,63 @@
self.assertEqual(output.rstrip(), b'0')
self.assertEqual(exitcode, 0)
+ def test_devnull_input(self):
+
+ async def empty_input():
+ code = 'import sys; data = sys.stdin.read(); print(len(data))'
+ proc = await asyncio.create_subprocess_exec(
+ sys.executable, '-c', code,
+ stdin=asyncio.subprocess.DEVNULL,
+ stdout=asyncio.subprocess.PIPE,
+ stderr=asyncio.subprocess.PIPE,
+ close_fds=False,
+ loop=self.loop)
+ stdout, stderr = await proc.communicate()
+ exitcode = await proc.wait()
+ return (stdout, exitcode)
+
+ output, exitcode = self.loop.run_until_complete(empty_input())
+ self.assertEqual(output.rstrip(), b'0')
+ self.assertEqual(exitcode, 0)
+
+ def test_devnull_output(self):
+
+ async def empty_output():
+ code = 'import sys; data = sys.stdin.read(); print(len(data))'
+ proc = await asyncio.create_subprocess_exec(
+ sys.executable, '-c', code,
+ stdin=asyncio.subprocess.PIPE,
+ stdout=asyncio.subprocess.DEVNULL,
+ stderr=asyncio.subprocess.PIPE,
+ close_fds=False,
+ loop=self.loop)
+ stdout, stderr = await proc.communicate(b"abc")
+ exitcode = await proc.wait()
+ return (stdout, exitcode)
+
+ output, exitcode = self.loop.run_until_complete(empty_output())
+ self.assertEqual(output, None)
+ self.assertEqual(exitcode, 0)
+
+ def test_devnull_error(self):
+
+ async def empty_error():
+ code = 'import sys; data = sys.stdin.read(); print(len(data))'
+ proc = await asyncio.create_subprocess_exec(
+ sys.executable, '-c', code,
+ stdin=asyncio.subprocess.PIPE,
+ stdout=asyncio.subprocess.PIPE,
+ stderr=asyncio.subprocess.DEVNULL,
+ close_fds=False,
+ loop=self.loop)
+ stdout, stderr = await proc.communicate(b"abc")
+ exitcode = await proc.wait()
+ return (stderr, exitcode)
+
+ output, exitcode = self.loop.run_until_complete(empty_error())
+ self.assertEqual(output, None)
+ self.assertEqual(exitcode, 0)
+
def test_cancel_process_wait(self):
# Issue #23140: cancel Process.wait()
@@ -531,6 +588,39 @@
with self.assertWarns(DeprecationWarning):
subprocess.Process(transp, proto, loop=self.loop)
+ def test_create_subprocess_exec_text_mode_fails(self):
+ async def execute():
+ with self.assertRaises(ValueError):
+ await subprocess.create_subprocess_exec(sys.executable,
+ text=True)
+
+ with self.assertRaises(ValueError):
+ await subprocess.create_subprocess_exec(sys.executable,
+ encoding="utf-8")
+
+ with self.assertRaises(ValueError):
+ await subprocess.create_subprocess_exec(sys.executable,
+ errors="strict")
+
+ self.loop.run_until_complete(execute())
+
+ def test_create_subprocess_shell_text_mode_fails(self):
+
+ async def execute():
+ with self.assertRaises(ValueError):
+ await subprocess.create_subprocess_shell(sys.executable,
+ text=True)
+
+ with self.assertRaises(ValueError):
+ await subprocess.create_subprocess_shell(sys.executable,
+ encoding="utf-8")
+
+ with self.assertRaises(ValueError):
+ await subprocess.create_subprocess_shell(sys.executable,
+ errors="strict")
+
+ self.loop.run_until_complete(execute())
+
if sys.platform != 'win32':
# Unix