【Python】Windowsコマンドプロンプトのコマンドを実行する方法（subprocessモジュール）

コマンドプロンプトとは

コマンドプロンプト（command prompt）とは、コマンド（命令文）を用いてファイル操作やWindows情報の取得、ネットワーク管理を行うためのツールです。

CUI（Character User Interface）なので、マウス操作は必要とせず、キーボードのみでコマンドを入力して操作します。

Windowsにおけるコマンドプロンプトは、UnixやMacではターミナルと呼ばれるツールです。

コマンドについて

コマンドは非常に多くの種類があります。
ネットワーク系コマンド（ipconfig、ping、nslookupなど）やファイル操作系コマンド（ls、dir、cdなど）、パソコン情報取得系（ver、wmicなど）といった種類があります。

WindowsのコマンドとLinux系のコマンドは同じものもあれば、異なるコマンドもたくさんありますので注意してください。

パソコンのハードウェア情報やシステム構成情報を取得するコマンドについては以下記事を参考にしてください。

【Windows10】コマンドプロンプト：パソコン情報（スペック、システム構成）取得コマンド一覧

os.system()

os.system()ではUnix系コマンドを実行できます。

osモジュールを使用するにはスクリプトの先頭でインポートする必要があります。
lsコマンドを使用するプログラムを以下に記します。

import os

os.system('ls')

しかし上述しているように、現在はsubprocessモジュールがありますので、subprocessモジュールを使用するのが良いです。

subprocessモジュールとは

subprocessモジュールはPythonスクリプトから他のプログラム（アプリケーション）を起動するために使用されます。

標準モジュールなのでpipで別途インストールする必要はないです。

subprocessモジュールについては以下記事をご参照ください。

【Python】subprocess.Popen()関数で他のプログラムを起動する

subprocessモジュールでWindowsコマンドプロンプトのコマンドを実行するメソッドは以下５つあります。

• subprocess.call()
• subprocess.check_call()
• subprocess.check_output()
• subprocess.run()
• subprocess.Popen()

Windows Build in コマンドの実行

subprocessモジュールの各メソッドは、コマンドの後にオプションを指定することができます。

オプションにshell=Trueを指定することでWindows built-inコマンド（echo、wmic、dirなど）が実行できるようになります。

shell=Trueにより、コマンドをコマンドプロンプトから実行する形になります。

shell=False（デフォルト）では「指定されたファイルは見つかりません」というエラーが表示されます。
このエラーが表示されたらshell=Trueにしなければならないと思ってください。

subprocess.call()

subprocess.call()はコマンドをただ単に実行するだけのメソッドです。

返り値は終了ステータス（０が正常終了）です。
call()では実行したコマンドによる出力を取得することはできません。

lsコマンドをスクリプトで実行するプログラムを以下に記します。

import subprocess

subprocess.call('ls')

subprocess.check_call()

subprocess.check_call()はcall()とは違い、コマンドが失敗した場合の処理をexcept文で例外処理ができます。

コマンドが正常に終了すれば返り値0を、異常終了すればCalledProcessErrorを返します。
check_call()では実行したコマンドによる出力を取得することはできません。

以下にsubprocess.check_call()を使用した、tryとexcept文で処理を行うプログラムを記します。

import subprocess

try:
    subprocess.check_call("ls")
except:
    print("失敗")

subprocess.check_output()

subprocess.check_output()はコマンドを実行して、かつコマンドによる標準出力を返します。

標準出力はエンコードされたバイトで返されますので、デコードする必要があります。

check_call()と同様に、コマンドが異常終了すればCalledProcessErrorを返します。

import subprocess

try:
    print(subprocess.check_output('echo %computername%', shell=True).decode())

except:
    print('失敗')

subprocess.run()について

subprocess.run()は上記で説明した3つのsubprocessメソッドが統合されたメソッドです。
上記３つのメソッドの用法がrun()でできます。

そのためsubprocess.run()はPython3.5以降から使用を推奨されています。

基本的にコマンドの実行はrun()メソッドで行えばいいです。

import subprocess

try:
    print(subprocess.run(['ver'], shell=True, stdout=subprocess.PIPE , stderr=subprocess.STDOUT))

except:
    print('失敗')

subprocess.run()の返り値は今までのメソッドとは異なります。
CompletedProcessインスタンスを返します。

上記出力より、run()による返り値CompletedProcessで一通りの結果を取得できることがわかります。

run()のオプション引数にstdout=subprocess.PIPEを指定することで標準出力を取得でき、stderr=subprocess.STDOUTで標準エラー出力が取得できます。

CompletedProcessから標準出力を取り出す場合は、以下のようにstdoutを指定します。

import subprocess

stdout = subprocess.run(['ver'], shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT).stdout
print(stdout)

標準出力はエンコードされたバイトで返されますので、デコードする必要があります。

その他の結果も同様の方法で取り出すことができます。

subprocess.run()では以下のように指定するコマンドはパラメータごとに分割してリストで渡します。

以上のようにrun()ではコマンドを指定して使用します。

subprocess.Popen()について

subprocess.Popen()でもrun()と同様にコマンドを実行できます。
ですがrun()とPopen()では処理に違いがあります。

Popen()の特徴として、Popen()で起動したプログラムの終了を待たないことです。
つまりPopen()で起動したプログラムの終了結果を待たずに次の処理を行うことができます。

run()とPopen()のどちらを使うかは、作成するプログラムによって決めてください。