ノンブロッキングサブプロセスでコマンドを非同期に実行するPythonの方法は何ですか

1. asyncio.subprocess.Process とは

asyncio からコマンドを実行できます。このコマンドは、読み取りおよび書き込み操作にノンブロッキング I/O の使用が許可されている子プロセスで実行されます。

asyncio モジュールのサブプロセス モジュールは、asyncio によって実行されるサブプロセスを表す Process クラスを提供します。 asyncio プログラムでは、子プロセスにハンドルを提供し、待機や終了などの操作を子プロセス上で実行できるようにします。

API は multiprocessing.Process クラスに非常に似ており、おそらく subprocess.Popen クラスにより似ています。具体的には、wait()、communicator()、send_signal() などのメソッドと、stdin、stdout、stderr などのプロパティを subprocess.Popen と共有します。

asyncio.subprocess.Process クラスが何であるかがわかったので、asyncio プログラムでそれを使用する方法を見てみましょう。

asyncio.subprocess.Process インスタンスは直接生成しません。対照的に、asyncio プログラムでサブプロセスを実行すると、クラスのインスタンスが自動的に作成されます。

外部プログラムをサブプロセスとして実行してプロセス インスタンスを取得するには、次の 2 つの方法があります。

• asyncio.create_subprocess_exec() は、コマンドの実行に使用されます。直接。

• asyncio.create_subprocess_shell() 関数を使用して、シェルを使用してコマンドを実行します。

各例を順番に見てみましょう。

2. コマンドを直接実行する方法

コマンドは、コマンド ライン (ターミナルまたはコマンド プロンプト) で実行されるプログラムです。これは直接実行される別のプログラムです。

Linux および macOS での一般的な例は次のとおりです:

• ‘ls’ ディレクトリの内容の一覧表示

• &lsquo ;cat’レポート ファイルの内容

• 「データ」レポートの日付

• ‘echo’文字列をレポート

• ‘sleep’ 数秒間スリープします

create_subprocess_exec() 関数を使用すると、asyncio プログラムでコマンドを実行できます。

asyncio.create_subprocess_exec() 関数はコマンドを受け取り、それを直接実行します。

これは、コマンドを子プロセスで実行できるようにし、asyncio コルーチンがそのコマンドを読み取り、書き込み、待機できるようにするため便利です。

asyncio.create_subprocess_shell() 関数とは異なり、asyncio.create_subprocess_exec() はコマンドの実行にシェルを使用しません。

これは、シェル変数、スクリプト、ワイルドカードなどのシェルによって提供される機能が、コマンドの実行時に使用できないことを意味します。

これは、シェル インジェクションの機会がないため、コマンドの実行がより安全である可能性があることも意味します。

asyncio.create_subprocess_exec() が何をするのかがわかったので、その使用方法を見てみましょう。

2.1. Asyncio create_subprocess_exec() の使用方法

asyncio.create_subprocess_exec() 関数は、サブプロセスで指定された文字列コマンドを実行します。

サブプロセスを表す asyncio.subprocess.Process オブジェクトを返します。

create_subprocess_exec() 関数はコルーチンであるため、それを待つ必要があります。サブプロセスが完了したときではなく、サブプロセスが開始された後に戻ります。

...
# execute a command in a subprocess
process = await asyncio.create_subprocess_exec('ls')

create_subprocess_exec() 関数を使用する場合、コマンドの引数を後続の引数として指定する必要があります。

...
# execute a command with arguments in a subprocess
process = await asyncio.create_subprocess_exec('ls', '-l')

wait() メソッドを待つことで、子プロセスが完了するのを待つことができます。

...
# wait for the subprocess to terminate
await process.wait()

terminate() または kill() メソッドを呼び出すことで、子プロセスを直接停止できます。これにより、子プロセスでシグナルが発生します。

...
# terminate the subprocess
process.terminate()

標準入力、出力、およびエラーは、stdin、stderr、および stdout を通じて処理されます。 asyncio プログラムに子プロセスの入力または出力を処理させることができます。

これは、入力または出力ストリームを指定し、asyncio.subprocess.PIPE などのリダイレクトする定数を指定することで実現できます。

たとえば、コマンドの出力を asyncio プログラムにリダイレクトできます。

...
# start a subprocess and redirect output
process = await asyncio.create_subprocess_exec('ls', stdout=asyncio.subprocess.PIPE)

次に、asyncio.subprocess の communication() メソッドを通じてプログラムの出力を読み取ることができます。プロセスインスタンス。

このメソッドはコルーチンであるため、待機する必要があります。サブプロセスを通じてデータを送受信するために使用されます。

...
# read data from the subprocess
line = process.communicate()

「input」パラメータをバイト単位で設定することで、communication() メソッドを通じて子プロセスにデータを送信することもできます。

...
# start a subprocess and redirect input
process = await asyncio.create_subprocess_exec('ls', stdin=asyncio.subprocess.PIPE)
# send data to the subprocess
process.communicate(input=b'Hello\n')

バックグラウンドで、asyncio.subprocess.PIPE は、サブプロセスとの間でデータを送信するための StreamReader または StreamWriter を指すようにサブプロセスを構成します。また、communicator() メソッドは、構成されたデータから読み取ります。プロセッサーは、またはバイトを書き込みます。

stdin、stdout、stderr プロパティを介してサブプロセスを通じて StreamReader または StreamWriter と直接対話できます。

...
# read a line from the subprocess output stream
line = await process.stdout.readline()

create_subprocess_exec() 関数の使用方法を理解したところで、実際の使用例をいくつか見てみましょう。

2.2. Asyncio create_subprocess_exec() の例

asyncio のサブプロセスでコマンドを実行する方法を調べます。この例では、「echo」コマンドを実行して文字列をレポートします。

echo コマンドは、指定された文字列を標準出力に直接報告します。完全な例を以下に示します。

この例は、「echo」コマンドにアクセスできることを前提としていることに注意してください。Windows で機能するかどうかはわかりません。 ###

# SuperFastPython.com
# example of executing a command as a subprocess with asyncio
import asyncio
 
# main coroutine
async def main():
    # start executing a command in a subprocess
    process = await asyncio.create_subprocess_exec('echo', 'Hello World')
    # report the details of the subprocess
    print(f'subprocess: {process}')
 
# entry point
asyncio.run(main())

运行示例首先创建 main() 协程并将其作为 asyncio 程序的入口点执行。

main() 协程运行并调用 create_subprocess_exec() 函数来执行命令。

main() 协程在创建子进程时挂起。返回一个 Process 实例。

main() 协程恢复并报告子进程的详细信息。 main() 进程终止，asyncio 程序终止。

echo 命令的输出在命令行上报告。这突出了我们如何从 asyncio 程序执行命令。

Hello World
subprocess: <Process 50249>

3. 如何通过 Shell 运行命令

我们可以使用 shell 执行命令。称为命令行解释器 (CLI)，shell 是用来操作命令行界面的用户界面。它将代表用户解释和执行命令。

它还提供诸如用于脚本、通配符、管道、shell 变量（例如 PATH）等的原始编程语言等功能。

例如，我们可以将一条命令的输出重定向为另一条命令的输入，比如将“/etc/services”文件的内容重定向到word count命令“wc”中，统计行数：

cat /etc/services | wc -l

基于 Unix 的操作系统中的 shell 示例包括：

shell 已经在运行，它被用来启动 Python 程序。您无需执行任何特殊操作即可获取或访问 shell。

我们可以通过 create_subprocess_shell() 函数从 asyncio 程序执行命令。

asyncio.create_subprocess_shell() 函数接受一个命令并使用当前用户 shell 执行它。

这很有用，因为它不仅允许执行命令，还允许使用 shell 的功能，例如重定向、通配符等。

该命令将在执行 asyncio 程序的进程的子进程中执行。重要的是，asyncio 程序能够与子进程异步交互，例如通过协程。

通过 shell 而不是直接执行命令时，可能会有安全考虑。

这是因为请求执行命令和正在执行的命令之间至少存在一层间接和解释，允许可能的恶意注入。

现在我们知道了 asyncio.create_subprocess_shell() 的作用，让我们看看如何使用它。

3.1. 如何使用 Asyncio create_subprocess_shell()

asyncio.create_subprocess_shell() 函数将通过当前 shell 执行给定的字符串命令。

它返回一个表示进程的 asyncio.subprocess.Process 对象。

它和上一节中介绍的 create_subprocess_shell() 函数非常类似。不过，我们将回顾如何使用该函数以及如何通过 Process 实例与流程交互（以防您直接跳到本节）。

我们需要等待create_subprocess_shell()函数完成，因为它是一个协程。它会在子流程启动后返回，而不是在子流程完成时返回。

...
# start a subprocess
process = await asyncio.create_subprocess_shell('ls')

我们可以通过等待 wait() 方法来等待子进程完成。

...
# wait for the subprocess to terminate
await process.wait()

我们可以通过调用 terminate() 或 kill() 方法直接停止子进程，这将在子进程中引发一个信号。

命令的输入和输出将由 shell 处理，例如标准输入、标准错误和标准输出。

我们可以让 asyncio 程序处理子进程的输入或输出。

这可以通过指定输入或输出流并指定要重定向的常量来实现，例如 asyncio.subprocess.PIPE。

例如，我们可以将命令的输出重定向到 asyncio 程序：

...
# start a subprocess and redirect output
process = await asyncio.create_subprocess_shell('ls', stdout=asyncio.subprocess.PIPE)

然后我们可以通过 asyncio.subprocess.Process 实例通过 communicate() 方法读取程序的输出。

此方法是协程，必须等待。它用于通过子流程发送和接收数据。

...
# read data from the subprocess
line = process.communicate()

我们还可以通过以字节为单位设置“input”参数，通过 communicate() 方法将数据发送到子进程。

...
# start a subprocess and redirect input
process = await asyncio.create_subprocess_shell('ls', stdin=asyncio.subprocess.PIPE)
# send data to the subprocess
process.communicate(input=b'Hello\n')

在后台，asyncio.subprocess.PIPE 将子进程配置为指向 StreamReader 或 StreamWriter，用于向子进程发送数据或从子进程发送数据，并且 communicate() 方法将从配置的读取器读取或写入字节。

我们可以通过子进程通过 stdin、stdout 和 stderr 属性直接与 StreamReader 或 StreamWriter 交互。

...
# read a line from the subprocess output stream
line = await process.stdout.readline()

现在我们已经掌握了如何使用 create_subprocess_shell() 函数，接下来让我们查看一些实际工作示例。

3.2. Asyncio create_subprocess_shell() 示例

我们可以尝试用 shell 在 asyncio 的子进程中执行指令。在这个例子中，我们将执行“echo”命令来报告一个字符串。

echo 命令将直接在标准输出上报告提供的字符串。下面列出了完整的示例。

请注意，此示例假设您可以访问“echo”命令，我不确定它是否适用于 Windows。

# SuperFastPython.com
# example of executing a shell command as a subprocess with asyncio
import asyncio
 
# main coroutine
async def main():
    # start executing a shell command in a subprocess
    process = await asyncio.create_subprocess_shell('echo Hello World')
    # report the details of the subprocess
    print(f'subprocess: {process}')
 
# entry point
asyncio.run(main())

首先创建 main() 协程并将其作为入口点运行的是 asyncio 程序的示例。在 main() 协程中，通过调用 create_subprocess_shell() 函数来执行命令。

main() 协程在运行时调用 create_subprocess_shell() 函数来执行命令。main() 协程恢复并报告子进程的详细信息。 main() 进程终止，asyncio 程序终止。

echo 命令的输出在命令行上报告。这个例子清晰地展示了我们如何利用 shell 从 asyncio 程序中运行命令。

subprocess: <Process 43916>
Hello World

以上がノンブロッキングサブプロセスでコマンドを非同期に実行するPythonの方法は何ですかの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。