• Home
  • プログラミング
  • Pythonで外部コマンドを実行！subprocessモジュールの基礎から応用まで徹底解説

Pythonで外部コマンドを実行！subprocessモジュールの基礎から応用まで徹底解説

schedule update
Tags: Python

はじめに：Pythonで外部コマンドを操る力を手に入れよう！

今回は、Pythonの強力なモジュールの一つであるsubprocessモジュールについて、深く掘り下げて解説させていただきます。

Pythonは、その豊富なライブラリと柔軟性から、Web制作だけでなく、データ分析、機械学習など、幅広い分野で利用されています。subprocessモジュールは、Pythonスクリプトから外部のプログラムやコマンドを実行する際に非常に役立ちます。例えば、画像処理ツールをPythonスクリプトから実行したり、システムの情報を取得したりすることが可能です。

この記事では、subprocessモジュールの基本的な使い方から、少し高度な応用まで、具体的なコード例を交えながら、わかりやすく解説いたします。「外部コマンドを実行する」と聞くと難しそうに感じるかもしれませんが、ご安心ください。この記事を読めば、きっとsubprocessモジュールを使いこなせるようになります。それでは、subprocessの世界へ飛び込んでいきましょう！

subprocessモジュールの基本的な使い方：まずはここから！

subprocessモジュールを使う上で、最も基本的な関数の一つがsubprocess.run()です。この関数は、指定されたコマンドを実行し、その結果を返します。

subprocess.run()を使うには、まず実行したいコマンドをリスト形式で指定します。例えば、ls -lコマンドを実行したい場合は、["ls", "-l"]のように指定します。そして、このリストをsubprocess.run()関数の引数に渡します。

import subprocess

result = subprocess.run(["ls", "-l"], capture_output=True, text=True)

print(result.stdout)

上記の例では、capture_output=Trueとtext=Trueという引数を指定しています。capture_output=Trueは、コマンドの標準出力と標準エラー出力をキャプチャするために指定します。text=Trueは、キャプチャされた出力を文字列として扱うために指定します。これらの引数を指定することで、コマンドの実行結果をPythonスクリプト内で簡単に扱うことができます。

subprocess.run()関数は、CompletedProcessオブジェクトを返します。このオブジェクトには、コマンドの終了コード、標準出力、標準エラー出力などの情報が含まれています。result.stdoutで標準出力を、result.stderrで標準エラー出力をそれぞれ取得できます。

このように、subprocess.run()関数を使うことで、Pythonスクリプトから簡単に外部コマンドを実行し、その結果を取得することができます。

コマンドの実行結果を詳しく見てみよう：戻り値とエラー処理

subprocess.run()関数が返すCompletedProcessオブジェクトは、コマンドの実行結果に関する様々な情報を提供してくれます。特に重要なのは、returncode属性です。これは、コマンドの終了コードを表しており、正常終了した場合は0、エラーが発生した場合は0以外の値が設定されます。

例えば、存在しないファイルを指定してlsコマンドを実行した場合、終了コードは0以外の値になります。この終了コードを確認することで、コマンドが正常に実行されたかどうかを判断することができます。

import subprocess

result = subprocess.run(["ls", "nonexistent_file"], capture_output=True, text=True)

if result.returncode != 0:
    print("エラーが発生しました")
    print(result.stderr)
else:
    print(result.stdout)

上記の例では、result.returncodeが0でない場合に、エラーメッセージを表示するようにしています。このように、終了コードを確認することで、コマンド実行時のエラーを適切に処理することができます。

さらに、subprocess.run()関数には、check=Trueという引数があります。この引数を指定すると、コマンドの終了コードが0以外の場合に、subprocess.CalledProcessError例外が発生します。この例外をキャッチすることで、エラーが発生した場合の処理をより簡単に記述することができます。

import subprocess

try:
    result = subprocess.run(["ls", "nonexistent_file"], capture_output=True, text=True, check=True)
    print(result.stdout)
except subprocess.CalledProcessError as e:
    print("エラーが発生しました")
    print(e.stderr)

パイプ処理を実装してみよう：複数のコマンドを繋げる

subprocessモジュールを使うと、複数のコマンドをパイプで繋げることもできます。パイプ処理とは、あるコマンドの出力を別のコマンドの入力として渡す処理のことです。

例えば、ls -lコマンドの出力をgrepコマンドに渡し、特定の文字列を含む行を抽出したい場合、以下のように記述します。

import subprocess

process1 = subprocess.Popen(["ls", "-l"], stdout=subprocess.PIPE)
process2 = subprocess.Popen(["grep", "txt"], stdin=process1.stdout, stdout=subprocess.PIPE, text=True)

process1.stdout.close()  # process1の標準出力を閉じる

output, error = process2.communicate()

print(output)

上記の例では、subprocess.Popen()関数を使っています。subprocess.run()関数と異なり、subprocess.Popen()関数は、コマンドを非同期的に実行します。

まず、ls -lコマンドを実行するprocess1を作成し、その標準出力をsubprocess.PIPEに設定します。次に、grep txtコマンドを実行するprocess2を作成し、その標準入力をprocess1の標準出力に設定します。

process1.stdout.close()は、process1の標準出力を閉じるための処理です。これを忘れると、デッドロックが発生する可能性があります。

最後に、process2.communicate()を呼び出して、process2の実行を待ち、その標準出力と標準エラー出力を取得します。

このように、subprocess.Popen()関数とパイプを使うことで、複数のコマンドを連携させた複雑な処理をPythonスクリプトから実行することができます。

まとめ：subprocessモジュールを使いこなして、Pythonの可能性を広げよう！

今回は、Pythonのsubprocessモジュールについて、基本的な使い方から、エラー処理、パイプ処理まで、幅広く解説いたしました。

subprocessモジュールは、Pythonスクリプトから外部コマンドを実行するための強力なツールです。このモジュールを使いこなすことで、Pythonの可能性をさらに広げることができます。

Web制作の現場では、画像処理、ファイル操作、システム管理など、様々な場面でsubprocessモジュールが活躍します。ぜひ、この記事を参考に、subprocessモジュールをマスターして、より効率的な開発を目指してください。

これからも、皆様のWeb制作のお役に立てるような情報を提供していきたいと思います。ご清聴いただき、ありがとうございました。

関連記事