subprocess モジュールを使用すると、新しいプロセスを起動し、その入力/出力/エラーパイプに接続して、戻り値を取得できます。

subprocess モジュールを使用する

subprocess モジュールでは、まず run メソッドの使用が推奨されます。より高度な使い方では、Popen インターフェースを直接使用できます。

run メソッドの構文は次のとおりです：

subprocess.run(args, *, stdin=None, input=None, stdout=None, stderr=None, capture_output=False, shell=False, cwd=None, timeout=None, check=False, encoding=None, errors=None, text=None, env=None, universal_newlines=None)
  • args：実行するコマンドを表します。文字列または文字列の引数リストである必要があります。
  • stdin、stdout、stderr：子プロセスの標準入力、出力、エラーです。値には subprocess.PIPE、subprocess.DEVNULL、既存のファイル記述子、開いているファイルオブジェクト、または None を指定できます。subprocess.PIPE は子プロセス用に新しいパイプを作成することを示します。subprocess.DEVNULL は os.devnull を使用することを示します。デフォルトは None で、何も行わないことを示します。また、stderr は stdout に結合して出力できます。
  • timeout：コマンドのタイムアウト時間を設定します。コマンドの実行がタイムアウトすると、子プロセスは強制終了され、TimeoutExpired 例外が送出されます。
  • check：このパラメータが True に設定され、プロセスの終了ステータスコードが 0 でない場合、CalledProcessError 例外が送出されます。
  • encoding：このパラメータを指定すると、stdin、stdout、stderr は文字列データを受け取ることができ、そのエンコーディング方式でエンコードされます。指定しない場合、bytes 型のデータのみを受け取ります。
  • shell：このパラメータが True の場合、オペレーティングシステムのシェルを介して指定されたコマンドを実行します。

run メソッドの呼び出しは CompletedProcess インスタンスを返します。直接 Popen を使用するのとほぼ同じで、実装も同じです。実際には Popen を呼び出しており、Popen コンストラクタとほぼ同じです。例：

例

# ls -l /dev/null コマンドを実行
>>> subprocess.run(["ls", "-l", "/dev/null"])
crw-rw-rw-  1 root  wheel    3,   2  5  4 13:34 /dev/null
CompletedProcess(args=['ls', '-l', '/dev/null'], returncode=0)

returncode: 子プロセス実行後の状態。通常、戻りステータスが 0 であれば実行が完了したことを示します。値が負の値 "-N" の場合、子プロセスが終了させられたことを示します。

簡単な例：

例

import subprocess
def runcmd(command):
    ret = subprocess.run(command,shell=True,stdout=subprocess.PIPE,stderr=subprocess.PIPE,encoding="utf-8",timeout=1)
    if ret.returncode == 0:
        print("success:",ret)
    else:
        print("error:",ret)


runcmd(["dir","/b"])# シーケンス引数
runcmd("exit 1")# 文字列引数

出力結果は次のとおりです：

success: CompletedProcess(args=['dir', '/b'], returncode=0, stdout='test.py\n', stderr='')
error: CompletedProcess(args='exit 1', returncode=1, stdout='', stderr='')

Popen() メソッド

Popen は subprocess の中核であり、子プロセスの作成と管理はすべてこれによって処理されます。

コンストラクタ：

class subprocess.Popen(args, bufsize=-1, executable=None, stdin=None, stdout=None, stderr=None, 
preexec_fn=None, close_fds=True, shell=False, cwd=None, env=None, universal_newlines=False, 
startupinfo=None, creationflags=0,restore_signals=True, start_new_session=False, pass_fds=(),
*, encoding=None, errors=None)

よく使われるパラメータ：

  • args：シェルコマンド。文字列またはシーケンス型（例：リスト、タプル）を指定できます。
  • bufsize：バッファサイズ。標準ストリームのパイプオブジェクトを作成するときに使用します。デフォルトは -1 です。
    0：バッファを使用しない
    1：行バッファリングを表します。universal_newlines=True のときのみ使用可能です。つまりテキストモードです。
    正数：バッファサイズを表します
    負数：システムデフォルトのバッファサイズを使用することを表します。
  • stdin, stdout, stderr：それぞれプログラムの標準入力、出力、エラーハンドルを表します。
  • preexec_fn：Unix プラットフォームでのみ有効です。子プロセスが実行される前に呼び出される呼び出し可能オブジェクト（callable object）を指定するために使用します。
  • shell：このパラメータが True の場合、オペレーティングシステムのシェルを介して指定されたコマンドを実行します。
  • cwd：子プロセスの現在のディレクトリを設定するために使用します。
  • env：子プロセスの環境変数を指定するために使用します。env=None の場合、子プロセスの環境変数は親プロセスから継承されます。

子プロセスを作成し、簡単なコマンドを実行します：

例

>>> import subprocess
>>> p = subprocess.Popen('ls -l', shell=True)
>>> total 164
-rw-r--r--  1 root root   133 Jul  4 16:25 admin-openrc.sh
-rw-r--r--  1 root root   268 Jul 10 15:55 admin-openrc-v3.sh
...
>>> p.returncode
>>> p.wait()
0
>>> p.returncode

ここでも使用できますp = subprocess.Popen(['ls', '-cl'])子プロセスを作成するために。

Popen オブジェクトのメソッド

  • poll(): プロセスが終了したかどうかを確認します。終了した場合は returncode を返し、そうでない場合は None を返します。
  • wait(timeout): 子プロセスが終了するまで待機します。
  • communicate(input,timeout): 子プロセスと対話し、データの送信と読み取りを行います。
  • send_signal(singnal): 子プロセスにシグナルを送信します。
  • terminate(): 子プロセスを停止します。つまり SIGTERM シグナルを子プロセスに送信します。
  • kill(): 子プロセスを強制終了します。SIGKILL シグナルを子プロセスに送信します。

例

import time
import subprocess

def cmd(command):
    subp = subprocess.Popen(command,shell=True,stdout=subprocess.PIPE,stderr=subprocess.PIPE,encoding="utf-8")
    subp.wait(2)
    if subp.poll() == 0:
        print(subp.communicate()[1])
    else:
        print("失敗")



cmd("java -version")
cmd("exit 1")

出力結果は次のとおりです：

java version "1.8.0_31"
Java(TM) SE Runtime Environment (build 1.8.0_31-b13)
Java HotSpot(TM) 64-Bit Server VM (build 25.31-b07, mixed mode)

失败

参考記事：

https://blog.csdn.net/weixin_42547344/article/details/80894760

https://blog.csdn.net/maosijunzi/article/details/80138458