スレッド

[Python] subprocess.popen関数の使い方 – 別のプログラムを実行する

subprocess.popen関数は、Pythonで外部プログラムやコマンドを実行するために使用されます。

この関数は非同期的にプロセスを生成し、標準入力・出力・エラーのストリームを操作できます。

基本的な使い方はsubprocess.Popen([コマンド, 引数], options)の形式で、stdoutやstderrを指定して出力を取得可能です。

プロセス終了を待つにはp.wait()を使用します。

目次から探す

subprocess.popen関数とは

subprocess.popen関数は、Pythonの標準ライブラリであるsubprocessモジュールに含まれており、別のプログラムを実行するための強力なツールです。

この関数を使用することで、外部コマンドやスクリプトをPythonから呼び出し、その実行結果を取得したり、標準入力や標準出力を制御したりすることができます。

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

特徴	説明
外部プログラムの実行	他のプログラムやスクリプトを実行できる。
標準入出力の制御	実行したプログラムの標準入力、標準出力を操作できる。
非同期処理のサポート	プログラムを非同期に実行し、他の処理を続行できる。
エラー処理の柔軟性	実行中のエラーを捕捉し、適切に処理できる。

この関数を使うことで、Pythonのスクリプトからシステムコマンドを実行したり、他のプログラムと連携したりすることが容易になります。

次のセクションでは、popen関数の基本的な使い方について詳しく見ていきます。

基本的な使い方

subprocess.popen関数を使用することで、外部プログラムを実行する基本的な方法を理解できます。

以下に、popen関数の基本的な構文とサンプルコードを示します。

構文

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)

以下のコードは、lsコマンドを実行し、その出力を取得する例です。

import subprocess
# lsコマンドを実行
process = subprocess.Popen(['ls', '-l'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
# 実行結果を取得
stdout, stderr = process.communicate()
# 出力結果を表示
print("標準")
print(stdout.decode('utf-8'))
if stderr:
    print("エラー")
    print(stderr.decode('utf-8'))

標準
total 0
-rw-r--r--  1 user  group  0 date time filename
...
エラー
# エラーがあればここに表示される

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

stdout=subprocess.PIPEを指定することで、コマンドの出力をPythonで受け取ることができます。

process.communicate()メソッドを使用して、実行が完了するまで待機し、出力を取得します。

次のセクションでは、popen関数のオプションについて詳しく説明します。

popen関数のオプション

subprocess.popen関数には、外部プログラムの実行を制御するためのさまざまなオプションがあります。

これらのオプションを適切に使用することで、より柔軟にプログラムを実行できます。

以下に、主なオプションをまとめました。

オプション名	説明
`args`	実行するコマンドとその引数をリスト形式で指定します。
`stdin`	プロセスの標準入力を指定します。`subprocess.PIPE`を指定すると、Pythonから入力できます。
`stdout`	プロセスの標準出力を指定します。`subprocess.PIPE`を指定すると、出力をPythonで受け取れます。
`stderr`	プロセスの標準エラー出力を指定します。`subprocess.PIPE`を指定すると、エラー出力を受け取れます。
`shell`	`True`に設定すると、コマンドをシェル経由で実行します。シェルの機能を利用できますが、セキュリティリスクがあるため注意が必要です。
`cwd`	プロセスの作業ディレクトリを指定します。指定したディレクトリでコマンドが実行されます。
`env`	環境変数を指定します。辞書形式で環境変数を設定できます。
`universal_newlines`	`True`に設定すると、出力をテキストとして扱います。デフォルトではバイナリとして扱われます。

以下のコードは、shellオプションを使用してシェルコマンドを実行する例です。

import subprocess
# シェルコマンドを実行
process = subprocess.Popen('echo Hello, World!', shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
# 実行結果を取得
stdout, stderr = process.communicate()
# 出力結果を表示
print("標準")
print(stdout.decode('utf-8'))
if stderr:
    print("エラー")
    print(stderr.decode('utf-8'))

標準
Hello, World!
エラー
# エラーがあればここに表示される

この例では、shell=Trueを指定することで、シェルコマンドを直接実行しています。

echoコマンドを使って、”Hello, World!”というメッセージを出力しています。

次のセクションでは、実行結果の処理方法について詳しく説明します。

実行結果の処理方法

subprocess.popen関数を使用して外部プログラムを実行した後、その実行結果を適切に処理することが重要です。

主に、標準出力と標準エラー出力を取得し、必要に応じてエラーハンドリングを行います。

以下に、実行結果の処理方法を詳しく説明します。

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

Popenオブジェクトのcommunicate()メソッドを使用することで、標準出力と標準エラー出力を同時に取得できます。

このメソッドは、プロセスが終了するまで待機し、出力を返します。

以下のコードは、lsコマンドを実行し、標準出力と標準エラー出力を処理する例です。

import subprocess
# lsコマンドを実行
process = subprocess.Popen(['ls', '-l', '/nonexistent_directory'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
# 実行結果を取得
stdout, stderr = process.communicate()
# 標準出力を表示
print("標準")
print(stdout.decode('utf-8'))
# 標準エラー出力を表示
if stderr:
    print("エラー")
    print(stderr.decode('utf-8'))

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

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

標準出力は空ですが、標準エラー出力にはエラーメッセージが表示されます。

エラーハンドリング

実行結果を処理する際には、エラーが発生した場合の処理も考慮する必要があります。

returncode属性を使用して、プロセスの終了コードを確認できます。

終了コードが0であれば正常終了、それ以外の場合はエラーが発生したことを示します。

サンプルコード(エラーハンドリング)

import subprocess
# lsコマンドを実行
process = subprocess.Popen(['ls', '-l', '/nonexistent_directory'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
# 実行結果を取得
stdout, stderr = process.communicate()
# 終了コードを確認
if process.returncode == 0:
    print("標準")
    print(stdout.decode('utf-8'))
else:
    print("エラーが発生しました。")
    print("エラー")
    print(stderr.decode('utf-8'))

エラーが発生しました。
エラー
ls: cannot access '/nonexistent_directory': No such file or directory

このように、returncodeを確認することで、エラーが発生した場合に適切な処理を行うことができます。

次のセクションでは、popen関数を使った実用例について説明します。

実用例

subprocess.popen関数は、さまざまなシナリオで活用できます。

ここでは、いくつかの実用的な例を紹介します。

これらの例を通じて、popen関数の使い方を具体的に理解できるでしょう。

外部プログラムの実行と結果のログ

外部プログラムを実行し、その結果をログファイルに保存する例です。

以下のコードでは、pingコマンドを使用して特定のホストに対してpingを実行し、その結果をファイルに書き込みます。

import subprocess
# pingコマンドを実行
host = 'google.com'
with open('ping_log.txt', 'w') as log_file:
    process = subprocess.Popen(['ping', '-c', '4', host], stdout=log_file, stderr=subprocess.PIPE)
    process.communicate()
print("pingの結果をping_log.txtに保存しました。")

複数のコマンドをパイプで接続

複数のコマンドをパイプで接続して実行する例です。

以下のコードでは、psコマンドでプロセスリストを取得し、その結果をgrepコマンドでフィルタリングします。

import subprocess
# psコマンドでプロセスリストを取得し、grepでフィルタリング
process1 = subprocess.Popen(['ps', 'aux'], stdout=subprocess.PIPE)
process2 = subprocess.Popen(['grep', 'python'], stdin=process1.stdout, stdout=subprocess.PIPE)
# プロセスの標準出力を取得
stdout, stderr = process2.communicate()
# 結果を表示
print("Pythonプロセスのリスト:")
print(stdout.decode('utf-8'))

Pythonスクリプトの実行

Pythonスクリプトを別のPythonスクリプトから実行する例です。

以下のコードでは、hello.pyというスクリプトを実行し、その出力を取得します。

import subprocess
# hello.pyスクリプトを実行
process = subprocess.Popen(['python3', 'hello.py'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
stdout, stderr = process.communicate()
# 結果を表示
print("hello.pyの")
print(stdout.decode('utf-8'))
if stderr:
    print("エラー")
    print(stderr.decode('utf-8'))

環境変数の設定

外部プログラムを実行する際に、特定の環境変数を設定する例です。

以下のコードでは、MY_VARという環境変数を設定してenvコマンドを実行します。

import subprocess
import os
# 環境変数を設定
my_env = os.environ.copy()
my_env['MY_VAR'] = 'Hello, World!'
# envコマンドを実行
process = subprocess.Popen(['env'], env=my_env, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
stdout, stderr = process.communicate()
# 結果を表示
print("環境変数のリスト:")
print(stdout.decode('utf-8'))
if stderr:
    print("エラー")
    print(stderr.decode('utf-8'))

これらの実用例を通じて、subprocess.popen関数の多様な使い方を理解し、実際のプロジェクトに応用できるようになるでしょう。

次のセクションでは、エラー処理と注意点について説明します。

エラー処理と注意点

subprocess.popen関数を使用する際には、エラー処理や注意点を理解しておくことが重要です。

外部プログラムの実行は、さまざまな理由で失敗する可能性があるため、適切なエラーハンドリングを行うことで、プログラムの安定性を向上させることができます。

以下に、エラー処理の方法と注意点をまとめます。

終了コードの確認

外部プログラムが正常に終了したかどうかを確認するために、returncode属性を使用します。

終了コードが0であれば正常終了、それ以外の場合はエラーが発生したことを示します。

以下のコードは、終了コードを確認する例です。

import subprocess
# lsコマンドを実行
process = subprocess.Popen(['ls', '/nonexistent_directory'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
stdout, stderr = process.communicate()
# 終了コードを確認
if process.returncode != 0:
    print("エラーが発生しました。")
    print("エラー")
    print(stderr.decode('utf-8'))
else:
    print("標準")
    print(stdout.decode('utf-8'))

標準エラー出力の確認

エラーが発生した場合、標準エラー出力を確認することで、問題の詳細を把握できます。

stderrを使用してエラーメッセージを取得し、適切に処理することが重要です。

シェルの使用に関する注意

shell=Trueを指定してシェル経由でコマンドを実行する場合、セキュリティリスクが伴います。

特に、ユーザーからの入力をそのままコマンドに渡すと、コマンドインジェクションの脆弱性が生じる可能性があります。

信頼できる入力のみを使用するか、shell=Falseを使用することを推奨します。

タイムアウトの設定

外部プログラムが長時間実行される場合、タイムアウトを設定することで、無限に待機することを防げます。

communicate()メソッドにはtimeout引数を指定できます。

以下のコードは、タイムアウトを設定する例です。

import subprocess
try:
    process = subprocess.Popen(['sleep', '10'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
    stdout, stderr = process.communicate(timeout=5)  # 5秒でタイムアウト
except subprocess.TimeoutExpired:
    process.kill()
    stdout, stderr = process.communicate()
    print("タイムアウトが発生しました。")
    print("エラー")
    print(stderr.decode('utf-8'))

リソースの解放

プロセスを実行した後は、リソースを適切に解放することが重要です。

Popenオブジェクトを使用した後は、process.wait()やprocess.communicate()を呼び出して、プロセスが終了するのを待つことが推奨されます。

これにより、リソースリークを防ぐことができます。

これらのエラー処理と注意点を考慮することで、subprocess.popen関数をより安全かつ効果的に使用できるようになります。

次のセクションでは、popen関数を使った応用例について説明します。

popen関数を使った応用例

subprocess.popen関数は、さまざまな応用シナリオで活用できます。

ここでは、実際のプロジェクトで役立ついくつかの応用例を紹介します。

これらの例を通じて、popen関数の柔軟性と強力さを理解できるでしょう。

ファイルの内容を外部プログラムで処理

ファイルの内容を外部プログラムに渡して処理する例です。

以下のコードでは、catコマンドを使用してファイルの内容を表示します。

import subprocess
# ファイルを作成
with open('sample.txt', 'w') as f:
    f.write("Hello, World!\nThis is a sample file.")
# catコマンドを実行
process = subprocess.Popen(['cat', 'sample.txt'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
stdout, stderr = process.communicate()
# 結果を表示
print("ファイルの内容:")
print(stdout.decode('utf-8'))
if stderr:
    print("エラー")
    print(stderr.decode('utf-8'))

画像の変換

画像処理ツールを使用して画像を変換する例です。

以下のコードでは、convertコマンドを使用してJPEG画像をPNG形式に変換します。

import subprocess
# 画像を変換
input_image = 'input.jpg'
output_image = 'output.png'
process = subprocess.Popen(['convert', input_image, output_image], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
stdout, stderr = process.communicate()
# 結果を表示
if process.returncode == 0:
    print(f"{input_image}を{output_image}に変換しました。")
else:
    print("エラーが発生しました。")
    print("エラー")
    print(stderr.decode('utf-8'))

データの収集と分析

外部プログラムを使用してデータを収集し、その結果を分析する例です。

以下のコードでは、curlコマンドを使用してウェブページのHTMLを取得し、grepコマンドで特定の情報を抽出します。

import subprocess
# curlコマンドでウェブページのHTMLを取得
url = 'https://www.example.com'
process1 = subprocess.Popen(['curl', url], stdout=subprocess.PIPE)
process2 = subprocess.Popen(['grep', 'Example Domain'], stdin=process1.stdout, stdout=subprocess.PIPE)
# 結果を取得
stdout, stderr = process2.communicate()
# 結果を表示
print("抽出した情報:")
print(stdout.decode('utf-8'))
if stderr:
    print("エラー")
    print(stderr.decode('utf-8'))

バッチ処理の自動化

複数のコマンドを自動的に実行するバッチ処理の例です。

以下のコードでは、複数のファイルを一括で圧縮するためにtarコマンドを使用します。

import subprocess
# 複数のファイルを圧縮
files_to_compress = ['file1.txt', 'file2.txt']
output_archive = 'archive.tar.gz'
process = subprocess.Popen(['tar', '-czf', output_archive] + files_to_compress, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
stdout, stderr = process.communicate()
# 結果を表示
if process.returncode == 0:
    print(f"{output_archive}にファイルを圧縮しました。")
else:
    print("エラーが発生しました。")
    print("エラー")
    print(stderr.decode('utf-8'))

これらの応用例を通じて、subprocess.popen関数の多様な使い方を理解し、実際のプロジェクトに応用できるようになるでしょう。

popen関数は、外部プログラムとの連携を強化し、Pythonのスクリプトをより強力にするための重要なツールです。