スレッド

[Python] subprocessモジュールの使い方 – 外部コマンドの実行

subprocessモジュールは、Pythonから外部コマンドやシェルコマンドを実行するための標準ライブラリです。

主にsubprocess.run()が使用され、コマンドをリスト形式で指定します。

例えば、subprocess.run(["ls", "-l"])でls -lを実行可能です。

capture_output=Trueを指定すると、標準出力や標準エラーを取得できます。

シェルを介して実行する場合はshell=Trueを指定しますが、セキュリティリスクがあるため注意が必要です。

目次から探す

subprocessモジュールとは

subprocessモジュールは、Pythonから外部コマンドを実行するための強力なツールです。

このモジュールを使用することで、シェルコマンドや他のプログラムをPythonスクリプト内から呼び出し、その結果を取得したり、エラーを処理したりすることができます。

主な特徴は以下の通りです。

特徴	説明
外部コマンドの実行	シェルコマンドや他のプログラムを実行可能
標準入出力の制御	標準出力や標準エラーを簡単に扱える
非同期処理	プロセスを非同期に実行することができる
エラー処理	実行中のエラーを捕捉し、適切に処理可能

このモジュールを使うことで、Pythonのスクリプトに外部プログラムの機能を組み込むことができ、より柔軟で強力なアプリケーションを作成することが可能になります。

基本的な使い方

subprocessモジュールを使用する基本的な方法は、subprocess.run()関数を利用することです。

この関数は、指定したコマンドを実行し、その結果を返します。

以下に、基本的な使い方の例を示します。

import subprocess
# 'ls'コマンドを実行して、結果を取得する
result = subprocess.run(['ls', '-l'], capture_output=True, text=True)
# 実行結果を表示する
print("標準")
print(result.stdout)
print("標準エラー:")
print(result.stderr)

このコードでは、ls -lコマンドを実行し、その結果を取得しています。

capture_output=Trueを指定することで、標準出力と標準エラーをキャプチャし、text=Trueを指定することで、出力を文字列として扱います。

実行結果の例は以下の通りです(実際の環境によって異なる場合があります)。

標準
total 0
-rw-r--r--  1 user  group  0 Jan  1 00:00 file1.txt
-rw-r--r--  1 user  group  0 Jan  1 00:00 file2.txt
標準エラー:

このように、subprocess.run()を使うことで、簡単に外部コマンドを実行し、その結果を取得することができます。

標準出力と標準エラーの扱い

subprocessモジュールを使用する際、外部コマンドの実行結果は主に標準出力(stdout)と標準エラー(stderr)に分かれます。

これらを適切に扱うことで、コマンドの実行結果を効果的に利用できます。

標準出力と標準エラーの取得

subprocess.run()関数を使用する際に、capture_output=Trueを指定することで、標準出力と標準エラーをキャプチャできます。

以下にその例を示します。

import subprocess
# 'ls'コマンドを実行して、結果を取得する
result = subprocess.run(['ls', '-l', '/nonexistent'], capture_output=True, text=True)
# 標準出力と標準エラーを表示する
print("標準")
print(result.stdout)  # 標準出力は空になる
print("標準エラー:")
print(result.stderr)   # エラーメッセージが表示される

このコードでは、存在しないディレクトリを指定してls -lコマンドを実行しています。

実行結果は以下のようになります。

標準
標準エラー:
ls: cannot access '/nonexistent': No such file or directory

標準出力と標準エラーの分離

標準出力と標準エラーは、result.stdoutとresult.stderrでそれぞれ取得できます。

これにより、エラーが発生した場合でも、標準出力の内容を確認することができます。

エラーコードの確認

コマンドの実行結果は、result.returncodeで確認できます。

0の場合は成功、0以外の場合はエラーを示します。

以下にその例を示します。

import subprocess
# 'ls'コマンドを実行して、結果を取得する
result = subprocess.run(['ls', '-l', '/nonexistent'], capture_output=True, text=True)
# エラーコードを表示する
print("エラーコード:", result.returncode)  # 0以外の値が表示される

このように、subprocessモジュールを使用することで、標準出力と標準エラーを簡単に扱うことができ、エラー処理を行う際にも役立ちます。

シェルコマンドの実行

subprocessモジュールを使用すると、シェルコマンドを直接実行することができます。

シェルコマンドを実行する際には、subprocess.run()関数にshell=Trueを指定することで、シェルを介してコマンドを実行できます。

以下にその例を示します。

シェルコマンドの実行例

import subprocess
# シェルコマンドを実行する
result = subprocess.run('echo "Hello, World!"', shell=True, capture_output=True, text=True)
# 実行結果を表示する
print("標準")
print(result.stdout)
print("標準エラー:")
print(result.stderr)

このコードでは、echoコマンドを使用して Hello, World! というメッセージを表示しています。

実行結果は以下のようになります。

標準
Hello, World!
標準エラー:

複数のコマンドの実行

シェルを使用することで、パイプやリダイレクトなどの複雑なコマンドも実行できます。

以下に、複数のコマンドをパイプでつなげる例を示します。

import subprocess
# 'ls'コマンドの結果を'grep'でフィルタリングする
result = subprocess.run('ls -l | grep ".txt"', shell=True, capture_output=True, text=True)
# 実行結果を表示する
print("標準")
print(result.stdout)
print("標準エラー:")
print(result.stderr)

このコードでは、ls -lコマンドの結果から.txtファイルをフィルタリングしています。

実行結果は、存在する.txtファイルのリストが表示されます。

注意点

shell=Trueを使用する際は、コマンドインジェクションのリスクがあるため、外部からの入力を直接コマンドに渡さないように注意が必要です。
シェルコマンドを実行する場合、コマンドの構文やオプションに注意を払い、正確に記述することが重要です。

このように、subprocessモジュールを使用することで、シェルコマンドを簡単に実行し、結果を取得することができます。

実行結果の詳細な制御

subprocessモジュールを使用すると、外部コマンドの実行結果を詳細に制御することができます。

これにより、標準出力や標準エラーの取得、タイムアウトの設定、環境変数の指定などが可能になります。

以下に、いくつかの重要な機能を紹介します。

標準出力と標準エラーのリダイレクト

subprocess.run()関数では、標準出力や標準エラーをファイルにリダイレクトすることもできます。

以下にその例を示します。

import subprocess
# 標準出力をファイルにリダイレクトする
with open('output.txt', 'w') as output_file:
    result = subprocess.run(['ls', '-l'], stdout=output_file, stderr=subprocess.PIPE, text=True)
# 標準エラーを表示する
print("標準エラー:")
print(result.stderr)

このコードでは、ls -lコマンドの標準出力をoutput.txtファイルに書き込み、標準エラーはコンソールに表示します。

タイムアウトの設定

コマンドの実行に時間がかかる場合、タイムアウトを設定することで、指定した時間内にコマンドが終了しない場合にエラーを発生させることができます。

以下にその例を示します。

import subprocess
try:
    # タイムアウトを5秒に設定してコマンドを実行
    result = subprocess.run(['sleep', '10'], timeout=5)
except subprocess.TimeoutExpired:
    print("コマンドがタイムアウトしました。")

このコードでは、sleep 10コマンドを実行しようとしますが、5秒のタイムアウトを設定しているため、タイムアウトが発生します。

環境変数の指定

コマンドを実行する際に、特定の環境変数を設定することも可能です。

以下にその例を示します。

import subprocess
import os
# 環境変数を設定
my_env = os.environ.copy()
my_env["MY_VAR"] = "Hello, World!"
# 環境変数を使用してコマンドを実行
result = subprocess.run(['printenv', 'MY_VAR'], env=my_env, capture_output=True, text=True)
# 実行結果を表示する
print("環境変数の値:")
print(result.stdout)

このコードでは、MY_VARという環境変数を設定し、その値をprintenvコマンドで表示しています。

実行結果は以下のようになります。

環境変数の値:
Hello, World!

これらの機能を活用することで、subprocessモジュールを使用した外部コマンドの実行結果をより詳細に制御し、柔軟なプログラムを作成することができます。

非同期実行と高度な操作

subprocessモジュールでは、外部コマンドを非同期に実行することができ、これによりプログラムの他の部分をブロックせずに処理を進めることが可能です。

非同期実行を行うためには、subprocess.Popenクラスを使用します。

以下に、非同期実行の基本的な使い方と高度な操作の例を示します。

非同期実行の基本

subprocess.Popenを使用すると、コマンドを非同期に実行し、プロセスの制御を行うことができます。

以下にその例を示します。

import subprocess
import time
# 非同期にコマンドを実行
process = subprocess.Popen(['sleep', '5'])
# プロセスが実行中の間、他の処理を行う
print("プロセスが実行中です...")
for i in range(5):
    print(f"{i + 1}秒経過")
    time.sleep(1)
# プロセスの終了を待つ
process.wait()
print("プロセスが終了しました。")

このコードでは、sleep 5コマンドを非同期に実行し、その間に他の処理(1秒ごとのカウント)を行っています。

プロセスが終了するまで待機し、終了後にメッセージを表示します。

プロセスの標準出力と標準エラーの取得

非同期実行中に標準出力や標準エラーを取得することも可能です。

以下にその例を示します。

import subprocess
# 非同期にコマンドを実行
process = subprocess.Popen(['ls', '-l'], stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
# 標準出力と標準エラーを取得
stdout, stderr = process.communicate()
# 実行結果を表示する
print("標準")
print(stdout)
print("標準エラー:")
print(stderr)

このコードでは、ls -lコマンドを非同期に実行し、communicate()メソッドを使用して標準出力と標準エラーを取得しています。

プロセスの終了確認とタイムアウト

非同期実行中にプロセスの状態を確認したり、タイムアウトを設定することもできます。

以下にその例を示します。

import subprocess
import time
# 非同期にコマンドを実行
process = subprocess.Popen(['sleep', '10'])
# プロセスの状態を確認
while True:
    retcode = process.poll()  # プロセスの終了コードを取得
    if retcode is not None:  # プロセスが終了している場合
        print("プロセスが終了しました。")
        break
    print("プロセスはまだ実行中です...")
    time.sleep(1)  # 1秒待機

このコードでは、poll()メソッドを使用してプロセスの状態を確認し、プロセスが終了するまでループを続けます。

subprocessモジュールを使用することで、外部コマンドを非同期に実行し、標準出力や標準エラーを取得することができます。

これにより、プログラムの効率を向上させ、より高度な操作が可能になります。

エラー処理

subprocessモジュールを使用して外部コマンドを実行する際には、エラー処理が重要です。

コマンドの実行中に発生する可能性のあるエラーを適切に捕捉し、処理することで、プログラムの安定性を向上させることができます。

以下に、エラー処理の方法をいくつか紹介します。

エラーコードの確認

コマンドの実行結果は、returncode属性を使用して確認できます。

0以外の値はエラーを示します。

以下にその例を示します。

import subprocess
# 存在しないコマンドを実行
result = subprocess.run(['nonexistent_command'], capture_output=True, text=True)
# エラーコードを確認
if result.returncode != 0:
    print("エラーが発生しました。")
    print("エラーコード:", result.returncode)
    print("標準エラー:", result.stderr)
else:
    print("コマンドが成功しました。")
    print("標準", result.stdout)

このコードでは、存在しないコマンドを実行し、エラーコードを確認しています。

エラーが発生した場合は、エラーメッセージを表示します。

例外処理を使用したエラー捕捉

subprocessモジュールでは、特定の例外を捕捉することで、エラー処理を行うこともできます。

以下にその例を示します。

import subprocess
try:
    # 存在しないコマンドを実行
    result = subprocess.run(['nonexistent_command'], check=True, capture_output=True, text=True)
except subprocess.CalledProcessError as e:
    print("コマンドの実行中にエラーが発生しました。")
    print("エラーコード:", e.returncode)
    print("標準エラー:", e.stderr)
else:
    print("コマンドが成功しました。")
    print("標準", result.stdout)

このコードでは、check=Trueを指定することで、コマンドが失敗した場合にsubprocess.CalledProcessError例外が発生します。

この例外を捕捉して、エラー情報を表示します。

タイムアウトによるエラー処理

コマンドの実行に時間がかかる場合、タイムアウトを設定してエラー処理を行うこともできます。

以下にその例を示します。

import subprocess
try:
    # タイムアウトを5秒に設定してコマンドを実行
    result = subprocess.run(['sleep', '10'], timeout=5)
except subprocess.TimeoutExpired:
    print("コマンドがタイムアウトしました。")
except subprocess.CalledProcessError as e:
    print("コマンドの実行中にエラーが発生しました。")
    print("エラーコード:", e.returncode)
else:
    print("コマンドが成功しました。")
    print("標準", result.stdout)

このコードでは、sleep 10コマンドを実行し、5秒のタイムアウトを設定しています。

タイムアウトが発生した場合は、subprocess.TimeoutExpired例外が捕捉され、エラーメッセージが表示されます。

subprocessモジュールを使用する際のエラー処理は、プログラムの安定性を確保するために重要です。

エラーコードの確認、例外処理、タイムアウトによるエラー処理を適切に行うことで、外部コマンドの実行に伴うリスクを軽減することができます。

実用例

subprocessモジュールは、さまざまな実用的なシナリオで活用できます。

ここでは、いくつかの具体的な例を示し、どのようにこのモジュールを利用できるかを解説します。

ファイルのバックアップ

特定のディレクトリの内容をバックアップするために、tarコマンドを使用する例です。

import subprocess
import datetime
# バックアップ用のファイル名を作成
backup_file = f"backup_{datetime.datetime.now().strftime('%Y%m%d_%H%M%S')}.tar.gz"
# tarコマンドを使用してディレクトリをバックアップ
result = subprocess.run(['tar', '-czf', backup_file, '/path/to/directory'], capture_output=True, text=True)
# 実行結果を確認
if result.returncode == 0:
    print(f"バックアップが成功しました: {backup_file}")
else:
    print("バックアップ中にエラーが発生しました。")
    print("標準エラー:", result.stderr)

このコードでは、指定したディレクトリを圧縮してバックアップファイルを作成します。

成功した場合はバックアップファイル名を表示し、エラーが発生した場合はエラーメッセージを表示します。

システム情報の取得

unameコマンドを使用して、システムの情報を取得する例です。

import subprocess
# unameコマンドを実行してシステム情報を取得
result = subprocess.run(['uname', '-a'], capture_output=True, text=True)
# 実行結果を表示
if result.returncode == 0:
    print("システム情報:")
    print(result.stdout)
else:
    print("システム情報の取得中にエラーが発生しました。")
    print("標準エラー:", result.stderr)

このコードでは、uname -aコマンドを実行してシステムの詳細情報を取得し、表示します。

プロセスの監視

特定のプロセスが実行中かどうかを確認するために、pgrepコマンドを使用する例です。

import subprocess
# プロセス名を指定
process_name = "python"
# pgrepコマンドを使用してプロセスを検索
result = subprocess.run(['pgrep', process_name], capture_output=True, text=True)
# 実行結果を確認
if result.returncode == 0:
    print(f"{process_name}プロセスが実行中です。")
    print("プロセスID:", result.stdout.strip())
else:
    print(f"{process_name}プロセスは実行されていません。")

このコードでは、指定したプロセス名が実行中かどうかを確認し、実行中であればプロセスIDを表示します。

HTTPリクエストの実行

curlコマンドを使用して、HTTPリクエストを実行する例です。

import subprocess
# curlコマンドを使用してHTTPリクエストを実行
url = "https://api.example.com/data"
result = subprocess.run(['curl', '-s', url], capture_output=True, text=True)
# 実行結果を表示
if result.returncode == 0:
    print("HTTPリクエストの結果:")
    print(result.stdout)
else:
    print("HTTPリクエスト中にエラーが発生しました。")
    print("標準エラー:", result.stderr)

このコードでは、指定したURLに対してHTTPリクエストを実行し、結果を表示します。

-sオプションを使用することで、進行状況を表示せずに実行します。

これらの実用例を通じて、subprocessモジュールがどのように役立つかを理解できたと思います。

外部コマンドを実行することで、Pythonスクリプトにさまざまな機能を追加し、より強力なアプリケーションを作成することが可能です。