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

初心者向けにPythonのsubprocessモジュールの使い方について解説しています。これはサブプロセスの管理に使われるモジュールです。記述方法と各オプション名、その機能について学んでいきましょう。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営する教育×テクノロジーのWebメディアです。初心者でもすぐ勉強できる記事が2,000以上あります。

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

Pythonについてそもそもよく分からないという方は、Pythonとは何なのか解説した記事をまずご覧ください。

 

なお本記事は、TechAcademyのPythonオンライン講座の内容をもとにしています。

 

田島悠介

今回は、Pythonに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

subprocessモジュールの使い方について詳しく説明していくね!

大石ゆかり

お願いします!

 

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] Pythonで挫折しない学習方法を動画で公開中

実際に書いてみよう

今回のサンプルプログラムは、 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を使って機械学習の基礎を学ぶPythonオンライン講座を開催しています。

初心者向けの書籍を使って人工知能(AI)や機械学習について学ぶことができます。

現役エンジニアがパーソナルメンターとして受講生に1人ずつつき、マンツーマンのメンタリングで学習をサポートし、最短4週間で習得することが可能です。

また、現役エンジニアから学べる無料のプログラミング体験会も実施しているので、ぜひ参加してみてください。