この記事では、Pythonの標準ライブラリであるsubprocess
モジュールを使い、Pythonスクリプトから外部のアプリケーション(電卓やメモ帳など)やコマンドを実行する方法について解説します。
subprocess.Popen
による非同期なプログラムの起動
subprocess.Popen()
関数は、新しいプロセスを生成して外部プログラムを起動します。Popen
(Process Open)の特徴は、プログラムを起動した後、その終了を待たずに、Pythonスクリプトの次の処理へと進むことです(非同期実行)。
Popen()
は、起動したプロセスを操作するためのPopen
オブジェクトを返します。
import subprocess
import time
# Windowsの場合: 電卓を起動
# calculator_process = subprocess.Popen('C:\\Windows\\System32\\calc.exe')
# macOSの場合: 電卓を起動
calculator_process = subprocess.Popen('/System/Applications/Calculator.app/Contents/MacOS/Calculator')
print(f"電卓プロセスの状態(起動直後): {calculator_process.poll()}")
# Popenオブジェクトのメソッド
# .poll() : プロセスが終了したか確認する。実行中ならNoneを返す。
# .wait() : プロセスが終了するまで待機する。
time.sleep(5) # 5秒間、メインスクリプトは他の処理を実行できる
print(f"電卓プロセスの状態(5秒後): {calculator_process.poll()}")
# calculator_process.wait() # この行を実行すると電卓を閉じるまで待機する
# print("電卓が終了しました。")
poll()
がNone
を返している間は、そのプロセスがまだ実行中であることを意味します。
subprocess.run()
によるシンプルなプログラムの実行
多くの場合、コマンドを実行し、その終了を待ってから次の処理に進みたいだけです。このような単純なケースでは、Python 3.5以降で導入されたsubprocess.run()
関数が推奨されます。この関数は、外部プログラムが終了するまで待機する(同期実行)ため、よりシンプルに扱えます。
import subprocess
# pingコマンドを実行し、その終了を待つ
# check=Trueを指定すると、コマンドがエラーで終了した場合に例外が発生する
subprocess.run(['ping', '-c', '4', 'google.com'], check=True)
print("pingコマンドが完了しました。")
コマンドライン引数を渡す
外部プログラムにファイルパスなどの引数を渡すには、コマンドと引数を要素とするリストを渡します。
import subprocess
# メモ帳で特定のファイルを開く(Windowsの場合)
# subprocess.Popen(['C:\\Windows\\notepad.exe', 'C:\\Users\\Default\\Documents\\my_note.txt'])
リストの最初の要素が実行するプログラム、2番目以降がそのプログラムに渡す引数となります。
OSの既定アプリケーションでファイルを開く
特定のアプリケーションを指定するのではなく、OSに設定された既定のアプリケーションでファイルを開くことも可能です。この方法はOSに依存します。
import subprocess
from pathlib import Path
# 'sample.txt'というファイルを作成
Path("sample.txt").write_text("Hello, world!")
# Windowsの場合: 'start'コマンドを使う
# subprocess.Popen(['start', 'sample.txt'], shell=True)
# macOSの場合: 'open'コマンドを使う
subprocess.Popen(['open', 'sample.txt'])
# Linuxの場合: 'xdg-open'コマンドを使う
# subprocess.Popen(['xdg-open', 'sample.txt'])
Windowsのstart
のようなシェル組み込みコマンドを実行するには、shell=True
引数が必要な点に注意してください。
まとめ
subprocess
モジュールは、Pythonから外部のプロセスを制御するための標準的な方法です。単純にコマンドを実行してその終了を待ちたい場合は、subprocess.run()
がシンプルで推奨されます。プログラムの終了を待たずに並行して処理を続けたい場合や、実行中のプロセスをより細かく制御したい場合には、subprocess.Popen()
を使用します。