【Python】subprocess｜使い方・サンプルコードで外部コマンドを自由自在に操る！

Pythonで外部コマンドを実行するなら、subprocessモジュールを活用しましょう。

subprocessモジュールを使えば、OSのコマンドや他のプログラムをPythonから簡単に実行できます。

この記事では、subprocessモジュールの基本的な使い方から、run()、call()、Popen()といった主要な関数の違い、そして具体的なサンプルコードまで詳しく解説します。

セキュリティに関する注意点や、エラー処理の方法も理解できます。

外部コマンドを実行するのに、どうしてsubprocessモジュールを使う必要があるんだろう？

subprocessモジュールは、外部コマンド実行をより安全かつ柔軟に行うための機能を提供します。

この記事でわかることは以下のとおりです。

subprocessモジュールの基本的な使い方
run()、call()、Popen()関数の違いと使い分け
サンプルコードを使った具体的なコマンド実行例
エラー処理とセキュリティ対策
コマンドインジェクション対策

subprocessとは？Pythonでの外部コマンド実行

Pythonのsubprocessモジュールは、Pythonスクリプトから外部コマンドを実行し、その結果をプログラム内で利用するための標準ライブラリです。

OSのコマンドや他の実行ファイルを呼び出すことができ、自動化スクリプトやシステム管理ツールなど、幅広い分野で活用できます。

Pythonにおけるsubprocessの位置づけ

subprocessモジュールは、Pythonにおける外部プロセスとの連携機能の中核を担っています。

subprocessモジュールを使うと、PythonスクリプトからOSのコマンドラインツールや他のプログラムを呼び出し、その実行結果をPythonのデータとして扱えます。

外部コマンドを実行するのに、どうしてsubprocessモジュールを使う必要があるんだろう？

subprocessモジュールは、外部コマンド実行をより安全かつ柔軟に行うための機能を提供します。

subprocessモジュール利用のメリット

subprocessモジュールを利用することで、Pythonスクリプトの可能性が大きく広がります。

メリット	説明
OSコマンドの利用	PythonからOSの標準コマンド（`ls`, `grep`など）を利用できる
外部プログラム連携	他のプログラミング言語で書かれたプログラムや実行ファイルを呼び出せる
処理の自動化	定期的なタスクやバッチ処理を自動化できる
実行結果の取得	外部コマンドの実行結果（標準出力、標準エラー出力、終了コード）をPythonで取得できる
柔軟な制御	プロセスの起動、実行、終了を細かく制御できる

類似モジュール(os.systemなど)との違い

Pythonで外部コマンドを実行する方法は、subprocessモジュールだけではありません。

代表的なものとしてos.system関数がありますが、subprocessモジュールの方がより高機能で、安全に外部プロセスを扱えるため、推奨されています。

os.system関数でも外部コマンドを実行できるのに、どうしてsubprocessモジュールを使う方がいいの？

subprocessモジュールは、os.system関数よりも柔軟な制御が可能で、セキュリティ面でも優れています。

比較項目	`subprocess`モジュール	`os.system`関数
柔軟性	高い: 引数の指定、標準出力の取得、エラー処理など、詳細な制御が可能	低い: 単純なコマンド実行のみ
セキュリティ	高い: コマンドインジェクション対策が容易	低い: コマンドインジェクションのリスクが高い
機能	豊富: 非同期実行、パイプ処理など、高度な機能を利用可能	限定的: 単純なコマンド実行のみ
戻り値	`CompletedProcess`オブジェクト: 終了コード、標準出力、標準エラー出力を含む	終了コードのみ
推奨度	推奨	非推奨

subprocessの基本操作：run/call/Popen

Pythonで外部コマンドを実行する上で、subprocessモジュールは重要な役割を果たします。

中でもrun(),call(),Popen()は、外部プロセスを起動し、制御するための基本的な関数です。

subprocess.run()：シンプルで高機能な実行

subprocess.run()は、外部コマンドを実行するための推奨される方法です。

この関数は、コマンドの実行を待ち、完了後にはCompletedProcessインスタンスを返します。

subprocess.run()って何ができるの？

subprocess.run()は、外部コマンドを実行し、その結果をPythonで扱えるようにする関数です。

subprocess.run()を使うことで、lsコマンドでファイル情報を取得したり、grepコマンドで文字列を検索したりできます。

また、catコマンドでファイル内容を出力したり、wcコマンドで文字数をカウントすることも可能です。

さらに、dateコマンドで現在日時を表示することもできます。

subprocess.call()：run()以前の記述方法

subprocess.call()は、subprocess.run()が導入される以前によく使われていた方法です。

現在では、subprocess.run()の方が高機能であるため、新規のコードではsubprocess.run()の使用が推奨されます。

比較項目	subprocess.run()	subprocess.call()
戻り値	CompletedProcessオブジェクト	終了コード
エラーハンドリング	check=Trueで例外発生	終了コードで判断
機能	より高機能、標準出力/標準エラー出力の取得が容易	基本的なコマンド実行のみ
推奨	推奨	非推奨

subprocess.call()は、簡単なコマンドを実行する場合には便利ですが、エラー処理や出力の取得など、より複雑な処理を行う場合にはsubprocess.run()の方が適しています。

subprocess.Popen()：柔軟なプロセス制御

subprocess.Popen()は、より低レベルなインターフェースを提供し、プロセスの起動、入出力のパイプ処理、非同期実行など、より詳細な制御が必要な場合に適しています。

Popen()を使うメリットは何？

Popen()を使うと、外部プロセスをより細かく制御できるので、複雑な処理が必要な場合に便利です。

subprocess.Popen()を使用すると、バックグラウンドでコマンドを実行したり、複数のコマンドをパイプで繋いだりできます。

非同期処理や並列処理にも適しており、より高度な制御が可能です。

サンプルコードでsubprocessの使い方をマスター

Pythonのsubprocessモジュールを利用することで、Pythonスクリプトから外部のプログラムやコマンドを実行できます。

ここでは、subprocessを使った具体的なサンプルコードを紹介し、コマンド実行の基本をマスターします。

lsコマンドでファイル情報を取得

lsコマンドは、ディレクトリ内のファイルやディレクトリの一覧を表示するために使用されます。

subprocessを使うことで、その結果をPython内で処理することが可能になり、ファイル操作を自動化できます。

import subprocess

result = subprocess.run([&#039;ls&#039;, &#039;-l&#039;], capture_output=True, text=True)
print(result.stdout)

ls -lコマンドの結果をPythonで取得すると、何に活用できるでしょうか？

ファイルサイズや更新日時を基に、特定のファイルを抽出したり、容量の大きいファイルを特定したりするのに役立ちます。

grepコマンドで文字列を検索

grepコマンドは、指定したパターンに一致する行をファイルから検索する際に利用されます。

subprocessと組み合わせることで、特定のログファイルからエラーメッセージを抽出したり、必要な情報を効率的に取得できます。

import subprocess

result = subprocess.run([&#039;grep&#039;, &#039;example&#039;, &#039;sample.txt&#039;], capture_output=True, text=True)
print(result.stdout)

grepコマンドの結果を使うと、何ができますか？

特定のエラーメッセージを含むログ行を抽出してエラー発生状況を分析したり、設定ファイルから特定のパラメータを抽出したりできます。

catコマンドでファイル内容を出力

catコマンドは、ファイルの内容を標準出力に表示するために使用されます。

subprocess経由でcatコマンドを使うことで、ファイルの内容をPythonスクリプト内で読み込み、処理できます。

import subprocess

result = subprocess.run([&#039;cat&#039;, &#039;sample.txt&#039;], capture_output=True, text=True)
print(result.stdout)

catコマンドで取得したファイルの内容は、Pythonでどう活用できるでしょうか？

取得したテキストデータを解析して特定のパターンを検出したり、必要な情報を抽出したり、他の処理に利用したりできます。

wcコマンドで文字数をカウント

wcコマンドは、ファイル内の単語数、行数、バイト数などをカウントするために使用されます。

subprocessを利用することで、ドキュメントやテキストファイルの統計情報を簡単に取得できます。

import subprocess

result = subprocess.run([&#039;wc&#039;, &#039;sample.txt&#039;], capture_output=True, text=True)
print(result.stdout)

wcコマンドの結果を使うと、具体的にどんな分析ができますか？

ファイルのサイズを把握したり、テキストファイルの行数や単語数をカウントして、コンテンツの量を分析したりできます。

dateコマンドで現在日時を表示

dateコマンドは、システムの日付と時刻を表示するために使用されます。

subprocessを通してdateコマンドを実行することで、スクリプト内で現在時刻を取得し、ログファイルに記録したり、処理のタイムスタンプとして利用できます。

import subprocess

result = subprocess.run([&#039;date&#039;], capture_output=True, text=True)
print(result.stdout)

dateコマンドで取得した日時情報は、どのように活用できるでしょうか？

スクリプトの実行時間や処理のタイミングを記録したり、ファイル名に日時情報を付加してバックアップを作成したりするのに役立ちます。

応用：複数のコマンドをパイプで繋ぐ

パイプ処理は、あるコマンドの出力を別のコマンドの入力として渡すテクニックです。

subprocessでは、Popenオブジェクトと.communicate()メソッドを組み合わせることで、複雑なデータ処理を実現できます。

import subprocess

process1 = subprocess.Popen([&#039;ls&#039;, &#039;-l&#039;], stdout=subprocess.PIPE)
process2 = subprocess.Popen([&#039;grep&#039;, &#039;txt&#039;], stdin=process1.stdout, stdout=subprocess.PIPE)
process1.stdout.close()
output, error = process2.communicate()

print(output.decode())

複数のコマンドをパイプで繋ぐと、どんなメリットがありますか？

複数のコマンドを組み合わせることで複雑な処理を効率的に実行したり、中間ファイルを生成せずにデータ処理を完結させたりできます。

応用：バックグラウンドでコマンドを実行

バックグラウンドでコマンドを実行することで、時間のかかる処理を非同期に行い、スクリプトの応答性を維持できます。

subprocessでは、Popenオブジェクトを使ってバックグラウンド実行を実現し、.poll()や.wait()メソッドで状態を監視できます。

import subprocess
import time

process = subprocess.Popen([&#039;sleep&#039;, &#039;10&#039;])
print(&#039;バックグラウンドで実行開始&#039;)

while process.poll() is None:
    print(&#039;処理中...&#039;)
    time.sleep(1)

print(&#039;処理完了&#039;)

バックグラウンドでコマンドを実行する際に、注意すべきことはありますか？

バックグラウンドで実行されるプロセスが完了するまで、リソースを適切に管理する必要があります。また、プロセスが予期せぬエラーで終了した場合の対応も検討しましょう。

これらのサンプルコードを参考に、subprocessモジュールを活用して、Pythonスクリプトから外部コマンドを自由に操り、システム管理や自動化タスクを効率化しましょう。

subprocess利用時の注意点：エラー処理とセキュリティ

subprocessモジュールを利用する際は、エラー処理とセキュリティ対策が不可欠です。

適切な対策を講じることで、プログラムの安定性と安全性を向上させられます。

終了ステータスで成否を判断

外部コマンドの実行結果は、終了ステータスで確認できます。

終了ステータスは、コマンドが正常に完了したかどうかを示す数値です。

終了ステータスが0である場合、コマンドは正常に完了したことを意味します。

0以外の場合は、何らかのエラーが発生したことを示します。

終了ステータスは、どうやって確認するのでしょうか？

subprocess.run() の戻り値である CompletedProcess オブジェクトの returncode 属性で確認できます。

例外処理でエラーをキャッチ

コマンド実行時にエラーが発生した場合に備え、例外処理を実装します。

try...except構文を使用することで、エラー発生時にプログラムが停止するのを防ぎ、適切なエラーメッセージを表示できます。

具体的にどんな例外をキャッチすればよいでしょうか？

subprocess.CalledProcessError は、コマンドが失敗した場合に発生する例外です。これ以外にも、OSError や ValueError など、状況に応じて適切な例外をキャッチする必要があります。

コマンドインジェクション対策：shlex.quote()

ユーザーからの入力値を外部コマンドに組み込む場合、コマンドインジェクションというセキュリティリスクが生じます。

shlex.quote()関数を使用することで、入力値を適切にエスケープし、コマンドとして悪用されるのを防ぐことができます。

shlex.quote()とは、どんな関数でしょうか？

shlex.quote() は、文字列を安全にクォートするための関数です。これにより、文字列がシェルコマンドの一部として解釈される際に、意図しない動作を防ぐことができます。

shell=True利用は必要最低限に

subprocess.run()の引数shell=Trueを使用すると、シェルを介してコマンドが実行されます。

このオプションは、ワイルドカードやパイプを使用する場合に便利ですが、セキュリティリスクを高める可能性があります。

shell=Trueの利用は必要最低限にとどめ、可能な限り、引数をリスト形式で指定するようにしましょう。

shell=True は、なぜ危険なのでしょうか？

shell=True を使用すると、シェルがコマンド文字列全体を解釈するため、コマンドインジェクションのリスクが高まります。特に、ユーザーからの入力を含むコマンドを実行する場合は、注意が必要です。

環境変数の扱いにも注意

subprocessで外部コマンドを実行する際、環境変数の扱いにも注意が必要です。

環境変数は、プログラムの動作に影響を与える可能性があるため、意図しない環境変数が設定されていると、予期せぬ動作を引き起こす可能性があります。

環境変数は、どうやって制御すればよいでしょうか？

subprocess.run() の env 引数を使用することで、環境変数を制御できます。必要な環境変数のみを明示的に指定することで、セキュリティリスクを低減できます。

外部コマンド実行を安全に！subprocess活用術

subprocessモジュールを安全に利用するためには、セキュリティリスクを理解し、適切な対策を講じることが重要です。

subprocessのセキュリティリスクを理解

subprocessを利用する上で最も重要なセキュリティリスクは、コマンドインジェクションです。

これは、外部からの入力をそのままコマンドとして実行してしまうことで発生する脆弱性です。

安全なsubprocess利用のためのベストプラクティス

subprocessを安全に利用するための対策としては、shlex.quote()によるエスケープ処理が挙げられます。

shlex.quote()は、文字列を安全にクォートし、シェルによる解釈を防ぎます。

コマンドインジェクションの脅威と対策

ユーザーが入力した文字列をそのままコマンドに組み込んで実行するのは危険ということですか？

その通りです。コマンドインジェクション攻撃を防ぐために、shlex.quote()を使いましょう。

コマンドインジェクションは、悪意のあるユーザーがOSコマンドを不正に実行することを可能にします。

shlex.quote()を使用することで、攻撃者が意図しないコマンドを実行することを防ぎます。

脆弱性を生まないコーディング作法

脆弱性を生まないためには、ユーザーからの入力を直接コマンドに含めないことが重要です。

また、shell=Trueの使用は避け、必要な場合は入力のエスケープを徹底してください。

対策	説明
入力のエスケープ	`shlex.quote()`を使用して、ユーザー入力を安全にエスケープする
`shell=True`の回避	可能であれば`shell=True`の使用を避け、引数をリスト形式で渡す
権限の制限	実行するコマンドの権限を必要最低限に制限する
入力値の検証	ユーザーからの入力値を事前に検証し、不正な値が含まれていないか確認する

これらの対策を講じることで、subprocess利用時のセキュリティリスクを大幅に軽減できます。

よくある質問（FAQ）

Pythonのsubprocessモジュールで外部コマンドを実行する際、どのような点に注意すべきですか？

セキュリティ上の注意点として、shell=Trueの使用を避け、ユーザーからの入力は必ずエスケープ処理することが重要です。

また、エラーハンドリングを適切に行い、予期せぬ事態に備えることも大切です。

`subprocess.run()`、`subprocess.call()`、`subprocess.Popen()`の違いは何ですか？

subprocess.run()はコマンドを実行して完了を待つ、最も推奨される方法です。

subprocess.call()はrun()以前の記述方法であり、subprocess.Popen()はより低レベルなインターフェースで、非同期処理やパイプ処理に適しています。

コマンドインジェクションとは何ですか？また、どのような対策が必要ですか？

コマンドインジェクションとは、ユーザーからの入力を悪用して、意図しないコマンドを実行させる攻撃手法です。

対策としては、shlex.quote()を使用して入力をエスケープし、shell=Trueの使用を避けることが効果的です。

`subprocess`モジュールでパイプ処理を行うにはどうすればいいですか？

subprocess.Popen()を使用して複数のプロセスを起動し、各プロセスの標準入出力にパイプを設定します。

そして、.communicate()メソッドでプロセス間でのデータのやり取りを行います。

外部コマンドの実行結果（終了ステータス、標準出力、標準エラー出力）はどのように取得できますか？

subprocess.run()の場合、CompletedProcessオブジェクトのreturncode属性で終了ステータスを、stdoutとstderr属性で標準出力と標準エラー出力を取得できます。

`subprocess`モジュールでタイムアウトを設定する方法はありますか？

subprocess.run()のtimeout引数を使用することで、コマンド実行に時間制限を設けることができます。

指定した時間を超えた場合、TimeoutExpired例外が発生します。

まとめ

subprocessモジュールは、Pythonから外部コマンドを実行するための強力なツールであり、安全かつ効率的な外部プロセス制御を実現する上で不可欠です。

subprocessモジュールを使用すると、OSコマンドや外部プログラムをPythonから実行できます。
run()、call()、Popen()といった関数を使い分けることで、さまざまなニーズに対応できます。
コマンドインジェクション対策やエラー処理を適切に行うことで、セキュリティと安定性を高められます。

subprocessモジュールをマスターして、Pythonスクリプトの可能性を広げ、システム管理や自動化タスクを効率化するために、今回紹介したサンプルコードや注意点を参考に、ぜひsubprocessモジュールを活用してみてください。