Pythonのsubprocessモジュールでコマンドをバックグラウンドで実行する方法を現役エンジニアが解説【初心者向け】

初心者向けにPythonのsubprocessモジュールでコマンドをバックグラウンドで実行する方法について現役エンジニアが解説しています。subprocessモジュールは、別プロセス(コマンド)を起動するためのモジュールです。

TechAcademyマガジンは受講者数No.1のオンラインプログラミングスクールTechAcademy [テックアカデミー]が運営。初心者向けに解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。

Pythonのsubprocessモジュールでコマンドをバックグラウンドで実行する方法について、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して、初心者向けに解説します。

 

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

 

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

 

田島悠介

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

大石ゆかり

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

田島悠介

Pythonのsubprocessモジュールでコマンドをバックグラウンドで実行する方法について詳しく説明していくね!

大石ゆかり

お願いします!

 

目次

 

subprocessモジュールとは

subprocessとは、PythonスクリプトからOS上の別プロセス(コマンド)を起動するためのモジュールです。

 

[PR] Pythonで挫折しない学習方法を動画で公開中

subprocessモジュールを利用してコマンドをバックグラウンド実行する方法

subprocessモジュールでコマンドを実行する標準的な方法は、subprocess.runを使用することです。

runは実行したコマンドの終了を待機します。

例えば、以下のコードでは、コメントの箇所でコマンド終了を待機します。

import datetime
import subprocess

print(datetime.datetime.now())
subprocess.run(["sleep", "10"]) # この行の実行直後でコマンド終了を待機する
print(datetime.datetime.now())

 

そのため実行結果は以下のようになり、コードの実行によって10秒経過していることがわかります。

2020-04-01 08:47:22.342884
2020-04-01 08:47:32.362239

コマンドをバックグラウンドで実行するにはsubprocess.Popenを使います。

これは、runと異なり、Popenで実行した場合にはコマンドの終了を待機しません。

poll()を使ってコマンドが終了を確認するか、wait()で明示的に終了を待機します。

(注)
この記事のプログラムはLinux環境で動作確認をしており、subprocessはOSに依存します。

そのため、別のOS(WindowsやMac)では動作しない・挙動が異なる場合があることには注意が必要です。

 

実際に書いてみよう

同様のコードをPopenを用いて記述してみました。

ソースコード

import datetime
import subprocess
import time

print(datetime.datetime.now())
proc = subprocess.Popen(["sleep", "10"])
print(datetime.datetime.now())

while True:
    ret = proc.poll()
    if ret is None:
        print('waiting for finish')
        time.sleep(1)
    else:
        break

 

実行結果

2020-04-01 08:51:44.813678
2020-04-01 08:51:44.814715
waiting for finish
waiting for finish
waiting for finish
waiting for finish
waiting for finish
waiting for finish
waiting for finish
waiting for finish
waiting for finish
waiting for finish

 

解説

Popenはコマンド終了を待機しないため、時刻表示の差分はほぼゼロです。

コマンドが終了したか判定するため、whileループで定期的にpoll()を呼び出しました。

まとめ

この記事ではsubprocessモジュールを用いて、コマンドをバックグラウンドで実行する方法を紹介しました。

subprocessモジュールの使用によって他のプログラムから結果を得ることが用意になります。

執筆してくれたメンター

橋本紘希(はしもとひろき)

システムインテグレータ企業勤務のシステムエンジニア。

開発実績: Javaプログラムを用いた業務用Webアプリケーションや、基幹システム用バッチアプリケーションなどの設計構築試験。

 

大石ゆかり

Pythonのsubprocessモジュールでコマンドをバックグラウンドで実行する方法がよく分かったので良かったです!

田島悠介

ゆかりちゃん、これからも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

 

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

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