Pythonのsubprocessモジュールの使い方【初心者向け】

Pythonのsubprocessモジュールの使い方について解説します。

そもそもPythonについてよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。

 

なお本記事は、TechAcademyのオンラインブートキャンプPython講座の内容をもとに紹介しています。

 

 

subprocessモジュールとは

subprocessとは、 Python のプログラムから他のアプリを起動したり、実行結果を得たりするモジュールです。 Python の標準ライブラリに含まれています。

 

subprocessモジュールの使い方

subprocessモジュールを使うには以下のように記述します。

import subprocess
subprocess.run(["実行するコマンド"], オプション)

オプションには主に以下のものがあります。

オプション名	説明	記述例
cwd	実行するディレクトリを指定	cwd=”~/temp”
stdout	標準出力。実行結果を取得する場合に指定	stdout = subprocess.PIPE
stderr	標準エラー。実行結果を取得する場合に指定	stderr = subprocess.PIPE
shell	標準のシェルで実行する場合に指定	shell = True

 

[PR] 未経験からWebエンジニアを目指す方法とは

実際に書いてみよう

今回のサンプルプログラムは、 subprocess を使用して「ls」コマンドを実行し、結果を print メソッドで表示してみます。実行結果は UTF-8 文字列で返ります。

import subprocess
proc = subprocess.run(["ls"],stdout = subprocess.PIPE, stderr = subprocess.PIPE)
print(proc.stdout.decode("utf8"))

実行結果は以下のようになります。実行結果はパソコンによって異なります。

test1.py
test2.py
sampledir

なお、 Windows で実行する場合は「ls」コマンドは「dir」となります。また「shell = True」を付けないとエラーになります。実行結果は CP932(シフトJISの亜種) 文字列で返ります。

import subprocess
 proc = subprocess.run(["dir"], shell=True, stdout = subprocess.PIPE, stderr = subprocess.PIPE)
 print(proc.stdout.decode("cp932"))

実行結果は以下のようになります。実行結果はパソコンによって異なります。

ドライブ C のボリューム ラベルは Windows です
 ボリューム シリアル番号は XXXX-XXXX です

 C:XXXX のディレクトリ

2018/01/01  12:00    <DIR>          .
2018/01/01  12:00    <DIR>          ..
2018/01/01  12:00    <DIR>          sampledir
2018/01/01  12:00                XX test1.py
2018/01/01  12:00                XX test1.py 
               2 個のファイル                 XXX バイト
               1 個のディレクトリ  XXX,XXX,XXX,XXX バイトの空き領域

 

この記事を監修してくれた方 太田和樹（おおたかずき） ITベンチャー企業のPM兼エンジニア 普段は主に、Web系アプリケーション開発のプロジェクトマネージャーとプログラミング講師を行っている。守備範囲はフロントエンド、モバイル、サーバサイド、データサイエンティストと幅広い。その幅広い知見を生かして、複数の領域を組み合わせた新しい提案をするのが得意。 開発実績：画像認識技術を活用した駐車場混雑状況把握（実証実験）、音声認識を活用したヘルプデスク支援システム、Pepperを遠隔操作するアプリの開発、大規模基幹系システムの開発・導入マネジメント 地方在住。仕事のほとんどをリモートオフィスで行う。通勤で消耗する代わりに趣味のDIYや家庭菜園、家族との時間を楽しんでいる。

 

 

TechAcademyでは、初心者でもPythonを使った人工知能（AI）や機械学習の基礎を習得できるオンラインブートキャンプPython講座を開催しています。

挫折しない学習方法を知れる説明動画や、現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。