Pythonのsubprocessモジュールを使った入力制御

subprocessモジュールの概要

Pythonのsubprocessモジュールは、新しいプロセスを生成し、そのプロセスの入出力を扱い、その終了ステータスを取得するための強力なツールです。このモジュールは、Pythonからシェルコマンドを実行するための主要な手段となっています。

subprocessモジュールは、Pythonの標準ライブラリの一部であり、Pythonのバージョン2.4から利用可能です。それ以前のos.systemやos.spawn*などの関数を置き換えるために導入されました。

このモジュールの主な機能は、新しいプロセスを開始し、そのプロセスの標準入力、標準出力、および標準エラーを（オプションで）接続することです。これにより、Pythonプログラムは他のプログラムと「対話」することができます。

次のセクションでは、subprocess.run()関数の使用方法について詳しく説明します。この関数は、subprocessモジュールの中心的な部分であり、最も頻繁に使用される関数の一つです。この関数を使うと、新しいプロセスを簡単に起動し、その出力を取得することができます。また、この関数はプロセスが終了するまで待機し、その終了ステータスを返します。これにより、Pythonプログラムは子プロセスの完了を待つことができます。この関数の詳細な使い方については、次のセクションで説明します。

subprocess.run()とは

Pythonのsubprocessモジュールのrun()関数は、新しいプロセスを起動し、そのプロセスの終了を待つための便利な方法を提供します。この関数は、コマンドライン引数を受け取り、新しいプロセスを起動します。また、この関数はプロセスが終了するまで待機し、その終了ステータスを返します。

run()関数の基本的な使用方法は次の通りです。

import subprocess

result = subprocess.run(['ls', '-l'])

上記のコードは、ls -lコマンドを実行します。このコマンドは、現在のディレクトリの内容を詳細表示します。

run()関数は、subprocess.CompletedProcessオブジェクトを返します。このオブジェクトには、プロセスの終了ステータス（returncode）、標準出力（stdout）、および標準エラー出力（stderr）が含まれます。

次のセクションでは、subprocess.run()を使用して標準入力へのデータを送信する方法について説明します。

標準入力へのデータの送信

Pythonのsubprocess.run()関数を使用して、新しいプロセスにデータを送信することも可能です。これは、新しいプロセスが標準入力からデータを読み取る場合に特に便利です。

run()関数のinput引数を使用して、新しいプロセスの標準入力にデータを送信できます。この引数は、バイト列または文字列を受け取ります。

以下に、input引数を使用してデータを送信する例を示します。

import subprocess

# プロセスに送信するデータ
data = 'Hello, World!'

# データをバイト列に変換
data_bytes = data.encode('utf-8')

# プロセスを起動し、データを送信
result = subprocess.run(['cat'], input=data_bytes, text=True)

# プロセスの出力を表示
print(result.stdout)

上記のコードは、catコマンドを実行し、そのコマンドにデータを送信します。catコマンドは、標準入力からデータを読み取り、そのデータをそのまま標準出力に書き出します。したがって、このコードはHello, World!というメッセージを表示します。

次のセクションでは、subprocess.run()を使用してエラーハンドリングを行う方法について説明します。

エラーハンドリング

Pythonのsubprocess.run()関数を使用する際には、エラーハンドリングも重要な要素となります。特に、起動したプロセスがエラーで終了した場合や、存在しないコマンドを実行しようとした場合などには、適切なエラーハンドリングが必要となります。

subprocess.run()関数は、起動したプロセスがエラーで終了した場合には、subprocess.CalledProcessErrorという例外を発生させます。この例外は、プロセスの終了ステータスと、標準出力および標準エラー出力を含んでいます。

以下に、subprocess.run()関数のエラーハンドリングの例を示します。

import subprocess

try:
    # 存在しないコマンドを実行しようとする
    result = subprocess.run(['no_such_command'], check=True)
except subprocess.CalledProcessError as e:
    print(f'エラー: {e.returncode}, {e.output}')

上記のコードは、存在しないコマンド（no_such_command）を実行しようとします。このコマンドは存在しないため、subprocess.run()関数はsubprocess.CalledProcessError例外を発生させます。この例外は、try/exceptブロックで捕捉され、エラーメッセージが表示されます。

このように、subprocess.run()関数を使用する際には、適切なエラーハンドリングを行うことが重要です。これにより、予期しないエラーが発生した場合でも、プログラムが適切に対応できるようになります。

実用的な例

Pythonのsubprocessモジュールを使用して、外部コマンドを実行し、その出力を取得する実用的な例を以下に示します。

import subprocess

# 外部コマンドを実行
result = subprocess.run(['ls', '-l'], capture_output=True, text=True)

# コマンドの出力を表示
print(result.stdout)

上記のコードは、ls -lコマンドを実行し、その出力を取得します。ls -lコマンドは、現在のディレクトリの内容を詳細表示します。

subprocess.run()関数のcapture_output引数をTrueに設定すると、コマンドの標準出力と標準エラー出力がキャプチャされます。これらの出力は、subprocess.CompletedProcessオブジェクトのstdoutおよびstderr属性に格納されます。

また、text引数をTrueに設定すると、出力はテキスト（文字列）として解釈されます。この引数がFalse（デフォルト）の場合、出力はバイト列として解釈されます。

このように、Pythonのsubprocessモジュールを使用すると、Pythonプログラムから外部コマンドを簡単に実行し、その出力を取得することができます。これは、Pythonプログラムが他のプログラムと「対話」するための強力な手段です。

まとめ

この記事では、Pythonのsubprocessモジュールとその主要な関数であるrun()関数について詳しく説明しました。subprocessモジュールは、新しいプロセスを生成し、そのプロセスの入出力を扱い、その終了ステータスを取得するための強力なツールです。

また、subprocess.run()関数を使用して、新しいプロセスにデータを送信する方法や、エラーハンドリングを行う方法についても説明しました。これらの機能は、Pythonプログラムが他のプログラムと「対話」するための重要な手段です。

最後に、subprocess.run()関数を使用して外部コマンドを実行し、その出力を取得する実用的な例を示しました。これらの知識を活用することで、Pythonプログラムの可能性をさらに広げることができます。

Pythonのsubprocessモジュールは、その強力な機能と柔軟性により、多くの異なるタスクを効率的に実行するための重要なツールです。これらの機能を理解し、適切に使用することで、Pythonプログラミングのスキルをさらに向上させることができます。