On Windows, the default event loop is
SelectorEventLoop
which does not support subprocesses.
ProactorEventLoop
should be used instead. Example to use it on Windows:
import asyncio, sys if sys.platform == 'win32': loop = asyncio.ProactorEventLoop() asyncio.set_event_loop(loop)
另请参阅
Available event loops and Platform support .
asyncio.
create_subprocess_exec
(
*args
,
stdin=None
,
stdout=None
,
stderr=None
,
loop=None
,
limit=None
,
**kwds
)
¶
创建子进程。
The
limit
parameter sets the buffer limit passed to the
StreamReader
。见
AbstractEventLoop.subprocess_exec()
了解其它参数。
返回
Process
实例。
此函数是 协程 .
asyncio.
create_subprocess_shell
(
cmd
,
stdin=None
,
stdout=None
,
stderr=None
,
loop=None
,
limit=None
,
**kwds
)
¶
Run the shell command cmd .
The
limit
parameter sets the buffer limit passed to the
StreamReader
。见
AbstractEventLoop.subprocess_shell()
了解其它参数。
返回
Process
实例。
It is the application’s responsibility to ensure that all whitespace and metacharacters are quoted appropriately to avoid
shell injection
vulnerabilities. The
shlex.quote()
function can be used to properly escape whitespace and shell metacharacters in strings that are going to be used to construct shell commands.
此函数是 协程 .
使用
AbstractEventLoop.connect_read_pipe()
and
AbstractEventLoop.connect_write_pipe()
methods to connect pipes.
Run subprocesses asynchronously using the
subprocess
模块。
AbstractEventLoop.
subprocess_exec
(
protocol_factory
,
*args
,
stdin=subprocess.PIPE
,
stdout=subprocess.PIPE
,
stderr=subprocess.PIPE
,
**kwargs
)
¶
Create a subprocess from one or more string arguments (character strings or bytes strings encoded to the
文件系统编码
), where the first string specifies the program to execute, and the remaining strings specify the program’s arguments. (Thus, together the string arguments form the
sys.argv
value of the program, assuming it is a Python script.) This is similar to the standard library
subprocess.Popen
class called with shell=False and the list of strings passed as the first argument; however, where
Popen
takes a single argument which is list of strings,
subprocess_exec()
takes multiple string arguments.
The
protocol_factory
must instantiate a subclass of the
asyncio.SubprocessProtocol
类。
其它参数:
connect_write_pipe()
, or the constant
subprocess.PIPE
(the default). By default a new pipe will be
created and connected.
connect_read_pipe()
, or the constant
subprocess.PIPE
(the default). By default a new pipe will be
created and connected.
connect_read_pipe()
, or one of the constants
subprocess.PIPE
(默认) 或
subprocess.STDOUT
.
By default a new pipe will be created and connected. When
subprocess.STDOUT
is specified, the subprocess’s standard error
stream will be connected to the same pipe as the standard output stream.
subprocess.Popen
without interpretation, except for
bufsize
,
universal_newlines
and
shell
, which should not be specified at all.
Returns a pair of
(transport, protocol)
,其中
transport
是实例化的
BaseSubprocessTransport
.
此方法是 协程 .
See the constructor of the
subprocess.Popen
class for parameters.
AbstractEventLoop.
subprocess_shell
(
protocol_factory
,
cmd
,
*
,
stdin=subprocess.PIPE
,
stdout=subprocess.PIPE
,
stderr=subprocess.PIPE
,
**kwargs
)
¶
创建子进程从
cmd
, which is a character string or a bytes string encoded to the
文件系统编码
, using the platform’s “shell” syntax. This is similar to the standard library
subprocess.Popen
class called with
shell=True
.
The
protocol_factory
must instantiate a subclass of the
asyncio.SubprocessProtocol
类。
见
subprocess_exec()
for more details about the remaining arguments.
Returns a pair of
(transport, protocol)
,其中
transport
是实例化的
BaseSubprocessTransport
.
It is the application’s responsibility to ensure that all whitespace and metacharacters are quoted appropriately to avoid
shell injection
vulnerabilities. The
shlex.quote()
function can be used to properly escape whitespace and shell metacharacters in strings that are going to be used to construct shell commands.
此方法是 协程 .
另请参阅
The
AbstractEventLoop.connect_read_pipe()
and
AbstractEventLoop.connect_write_pipe()
方法。
asyncio.subprocess.
PIPE
¶
Special value that can be used as the
stdin
,
stdout
or
stderr
自变量对于
create_subprocess_shell()
and
create_subprocess_exec()
and indicates that a pipe to the standard stream should be opened.
asyncio.subprocess.
STDOUT
¶
Special value that can be used as the
stderr
自变量对于
create_subprocess_shell()
and
create_subprocess_exec()
and indicates that standard error should go into the same handle as standard output.
asyncio.subprocess.
DEVNULL
¶
Special value that can be used as the
stdin
,
stdout
or
stderr
自变量对于
create_subprocess_shell()
and
create_subprocess_exec()
and indicates that the special file
os.devnull
会被使用。
asyncio.subprocess.
Process
¶
A subprocess created by the
create_subprocess_exec()
或
create_subprocess_shell()
函数。
The API of the
Process
class was designed to be close to the API of the
subprocess.Popen
class, but there are some differences:
poll()
方法
communicate()
and
wait()
methods don’t take a
timeout
parameter:
使用
wait_for()
function
wait()
方法为
the
Process
class is asynchronous whereas the
wait()
方法在
Popen
class is implemented as a busy loop.
此类是 非线程安全 。另请参阅 Subprocess and threads 章节。
wait
(
)
¶
等待子级进程终止。设置并返回
returncode
属性。
此方法是 协程 .
注意
这会死锁,当使用
stdout=PIPE
or
stderr=PIPE
and the child process generates enough output to a pipe such that it blocks waiting for the OS pipe buffer to accept more data. Use the
communicate()
method when using pipes to avoid that.
communicate
(
input=None
)
¶
Interact with process: Send data to stdin. Read data from stdout and stderr, until end-of-file is reached. Wait for process to terminate. The optional
input
参数应该是要发送给子级进程的数据,或为
None
, if no data should be sent to the child. The type of
input
must be bytes.
communicate()
返回元组
(stdout_data, stderr_data)
.
若
BrokenPipeError
or
ConnectionResetError
exception is raised when writing
input
into stdin, the exception is ignored. It occurs when the process exits before all data are written into stdin.
Note that if you want to send data to the process’s stdin, you need to create the Process object with
stdin=PIPE
。同样,要获取任何东西除了
None
在结果元组,需要给出
stdout=PIPE
and/or
stderr=PIPE
也。
此方法是 协程 .
注意
读取数据缓冲在内存中,所以不要使用此方法若数据尺寸很大 (或不受限制)。
3.4.2 版改变:
The method now ignores
BrokenPipeError
and
ConnectionResetError
.
send_signal
(
signal
)
¶
发送信号 signal to the child process.
注意
在 Windows,
SIGTERM
是别名化的
terminate()
.
CTRL_C_EVENT
and
CTRL_BREAK_EVENT
can be sent to processes started with a
creationflags
参数包括
CREATE_NEW_PROCESS_GROUP
.
terminate
(
)
¶
Stop the child. On Posix OSs the method sends
signal.SIGTERM
to the child. On Windows the Win32 API function
TerminateProcess()
被调用以停止子级。
kill
(
)
¶
Kills the child. On Posix OSs the function sends
SIGKILL
to the child. On Windows
kill()
是别名化的
terminate()
.
stdin
¶
标准输入流 (
StreamWriter
),
None
if the process was created with
stdin=None
.
stdout
¶
标准输出流 (
StreamReader
),
None
if the process was created with
stdout=None
.
stderr
¶
标准错误流 (
StreamReader
),
None
if the process was created with
stderr=None
.
警告
使用
communicate()
method rather than
.stdin.write
,
.stdout.read
or
.stderr.read
to avoid deadlocks due to streams pausing reading or writing and blocking the child process.
pid
¶
The identifier of the process.
Note that for processes created by the
create_subprocess_shell()
function, this attribute is the process identifier of the spawned shell.
returncode
¶
Return code of the process when it exited. A
None
value indicates that the process has not terminated yet.
负值
-N
指示子级被终止,通过信号
N
(Unix only).
asyncio supports running subprocesses from different threads, but there are limits:
get_child_watcher()
function in the main thread to instantiate the child watcher.
The
asyncio.subprocess.Process
class is not thread safe.
另请参阅
The asyncio 中的并发和多线程 章节。
Example of a subprocess protocol using to get the output of a subprocess and to wait for the subprocess exit. The subprocess is created by the
AbstractEventLoop.subprocess_exec()
方法:
import asyncio import sys class DateProtocol(asyncio.SubprocessProtocol): def __init__(self, exit_future): self.exit_future = exit_future self.output = bytearray() def pipe_data_received(self, fd, data): self.output.extend(data) def process_exited(self): self.exit_future.set_result(True) @asyncio.coroutine def get_date(loop): code = 'import datetime; print(datetime.datetime.now())' exit_future = asyncio.Future(loop=loop) # Create the subprocess controlled by the protocol DateProtocol, # redirect the standard output into a pipe create = loop.subprocess_exec(lambda: DateProtocol(exit_future), sys.executable, '-c', code, stdin=None, stderr=None) transport, protocol = yield from create # Wait for the subprocess exit using the process_exited() method # of the protocol yield from exit_future # Close the stdout pipe transport.close() # Read the output which was collected by the pipe_data_received() # method of the protocol data = bytes(protocol.output) return data.decode('ascii').rstrip() if sys.platform == "win32": loop = asyncio.ProactorEventLoop() asyncio.set_event_loop(loop) else: loop = asyncio.get_event_loop() date = loop.run_until_complete(get_date(loop)) print("Current date: %s" % date) loop.close()
Example using the
Process
class to control the subprocess and the
StreamReader
class to read from the standard output. The subprocess is created by the
create_subprocess_exec()
函数:
import asyncio.subprocess import sys @asyncio.coroutine def get_date(): code = 'import datetime; print(datetime.datetime.now())' # Create the subprocess, redirect the standard output into a pipe create = asyncio.create_subprocess_exec(sys.executable, '-c', code, stdout=asyncio.subprocess.PIPE) proc = yield from create # Read one line of output data = yield from proc.stdout.readline() line = data.decode('ascii').rstrip() # Wait for the subprocess exit yield from proc.wait() return line if sys.platform == "win32": loop = asyncio.ProactorEventLoop() asyncio.set_event_loop(loop) else: loop = asyncio.get_event_loop() date = loop.run_until_complete(get_date()) print("Current date: %s" % date) loop.close()