PythonでOSコマンドを扱う：os.systemからsubprocessへ

os.systemとは

os.systemはPythonの標準ライブラリosに含まれる関数で、シェルコマンドを実行するためのものです。この関数は引数として渡された文字列をシェルコマンドとして実行し、その結果を返します。

以下に簡単な使用例を示します：

import os

# 'ls'コマンドを実行
os.system('ls')

このコードはカレントディレクトリの内容をリスト表示します。os.systemはコマンドの終了ステータスを返すことに注意してください。これはコマンドが正常に終了したかどうかを示します。

しかし、os.systemは古い関数であり、現在ではより強力で柔軟性のあるsubprocessモジュールが推奨されています。subprocessはos.systemよりも詳細な制御を提供し、より安全な方法でシェルコマンドを実行することができます。次のセクションでは、subprocessの基本的な使い方について説明します。

subprocessの登場

Pythonのsubprocessモジュールは、新しいプロセスを生成し、そのプロセスの入出力を扱い、その終了コードを取得するための強力な手段を提供します。これは、Pythonからシェルコマンドを実行するための推奨される方法です。

subprocessはos.systemとos.spawn*の代替として導入されました。これらの関数はシェルコマンドを実行するための基本的な手段を提供していましたが、subprocessはそれらよりもはるかに強力で柔軟性があります。

subprocessモジュールは、プロセスの生成、標準入出力の接続、エラーハンドリングなど、プロセス管理に関連する多くのタスクを扱うことができます。これにより、Pythonプログラムはシェルスクリプトのように振る舞うことができ、また、他のプログラムとの間でデータをパイプすることも可能になります。

次のセクションでは、subprocessの基本的な使い方について詳しく説明します。このモジュールの使用方法を理解することで、PythonからOSコマンドをより効果的に扱うことができるようになります。

subprocessの基本的な使い方

Pythonのsubprocessモジュールは、新しいプロセスを生成し、そのプロセスの入出力を扱い、その終了コードを取得するための強力な手段を提供します。以下に基本的な使用例を示します：

import subprocess

# 'ls'コマンドを実行
subprocess.run(['ls'])

このコードはカレントディレクトリの内容をリスト表示します。subprocess.runはCompletedProcessインスタンスを返します。これには、コマンドの終了ステータス（returncode）、標準出力（stdout）、標準エラー出力（stderr）などの情報が含まれています。

subprocess.run関数の引数はリスト形式で指定します。これは、シェルがコマンドラインを解析するのではなく、Pythonがそれを行うためです。これにより、シェルの特殊文字（ワイルドカード、パイプ、リダイレクトなど）を気にすることなくコマンドを実行できます。

また、subprocess.runには様々なオプションがあります。例えば、stdoutやstderrをキャプチャするためのcapture_output、コマンドのタイムアウトを設定するためのtimeoutなどがあります。これらの詳細については次のセクションで説明します。

subprocess.runの詳細

Pythonのsubprocess.run関数は、新しいプロセスを生成し、そのプロセスの入出力を扱い、その終了コードを取得するための強力な手段を提供します。以下に詳細な使用例を示します：

import subprocess

# 'ls'コマンドを実行し、標準出力と標準エラー出力をキャプチャ
result = subprocess.run(['ls'], capture_output=True, text=True)

# 結果を表示
print('returncode:', result.returncode)
print('stdout:', result.stdout)
print('stderr:', result.stderr)

このコードはカレントディレクトリの内容をリスト表示し、その結果をキャプチャします。subprocess.runはCompletedProcessインスタンスを返します。これには、コマンドの終了ステータス（returncode）、標準出力（stdout）、標準エラー出力（stderr）などの情報が含まれています。

subprocess.run関数のcapture_outputオプションをTrueに設定すると、標準出力と標準エラー出力がキャプチャされます。これらの出力はCompletedProcessインスタンスのstdoutおよびstderr属性からアクセスできます。

また、textオプションをTrueに設定すると、出力はバイト列ではなく文字列として扱われます。

subprocess.runには他にも様々なオプションがあります。例えば、inputオプションを使用すると、標準入力を提供することができます。また、timeoutオプションを使用すると、コマンドのタイムアウトを設定することができます。

これらのオプションを適切に使用することで、PythonからOSコマンドをより効果的に扱うことができます。次のセクションでは、例外処理とsubprocessの関連性について説明します。

例外処理とsubprocess

Pythonのsubprocessモジュールを使用する際には、例外処理が重要な役割を果たします。特に、subprocess.run関数は、コマンドの実行が失敗した場合に例外を発生させることができます。

以下に例を示します：

import subprocess

try:
    # 'ls /nonexistent'コマンドを実行
    subprocess.run(['ls', '/nonexistent'], check=True)
except subprocess.CalledProcessError as e:
    print(f'コマンドが失敗しました: {e.returncode}')

このコードは存在しないディレクトリ/nonexistentの内容をリスト表示しようとします。subprocess.run関数のcheckオプションをTrueに設定すると、コマンドの実行が失敗した（つまり、終了ステータスが0でない）場合にCalledProcessError例外が発生します。

この例外はtry/exceptブロックで捕捉できます。CalledProcessErrorオブジェクトは、コマンドの終了ステータス（returncode）、標準出力（stdout）、標準エラー出力（stderr）などの情報を含んでいます。

このように、subprocessモジュールと例外処理を組み合わせることで、PythonからOSコマンドをより安全に、かつ効果的に扱うことができます。これにより、コマンドの実行結果に基づいて適切なエラーハンドリングを行うことが可能になります。この知識を活用して、Pythonでのシェルコマンドの扱い方をさらに理解し、効果的に利用してください。