Help us understand the problem. What is going on with this article?

Pythonでsubprocessを使ってコマンドを実行する方法

More than 3 years have passed since last update.

概要

Pythonでsubprocessモジュールを使用し、コマンドを実行する方法を紹介します。

なぜsubprocessか

Pythonのバージョンが上がるにつれ、以前のcommandsモジュールが使われなくなったり、osモジュールではなくSubprocessモジュールを使用することが公式でも推奨されるようになってきました。

そこで今回、Qiita上にはSubprocessモジュールを使用してPythonでコマンド実行する方法に関する簡単な記事があまりなかったため書いてみました。

コマンドを実行するメソッド

subprocess内にはコマンドを実行するメソッドがいくつかあります。
最初にそのメソッドについて見ていきます。

call(cmd)

引数のコマンドを実行し、実行が成功すると0を返します。

check_call(cmd)

call同様の動作に加えて、実行が失敗したらCalledProcessErrorという例外を投げます。

check_output(cmd)

コマンドの実行結果の出力をバイト文字列として返します。こちらも実行が失敗したらCalledProcessErrorという例外を投げます。

※他のメソッドもあるので興味のある方はこちらをご参照ください。

サンプルコード

import subprocess

subprocess.call( ["ls", "-l"] ) 

※引数にshellのboolean値を設定できます。デフォルトではFalseです。
Trueは公式では推奨されていません。なぜならコマンド文字列が外部入力される場合、信頼出来ないソースを使うことによって任意のシェルコマンドが実行される可能性があり(シェルインジェクション)、セキュリティ面で問題があるからです。

使用例

Pythonスクリプトからjarファイルを実行する際に使用しました。

参考サイト

「17.1. subprocess — サブプロセス管理」
http://docs.python.jp/2/library/subprocess.html
「17.5. subprocess — サブプロセス管理」http://docs.python.jp/3/library/subprocess.html
「Pythonでコマンド実行するには」http://takuya-1st.hatenablog.jp/entry/2014/08/23/022031
「Subprocess モジュール」http://www-he.scphys.kyoto-u.ac.jp/member/shotakaha/dokuwiki/doku.php?id=toolbox:python:subprocess
「Learning 1 documentation SUBPROCESS」http://her0.web.fc2.com/python/standard/subprocess.html

Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Comments
No comments
Sign up for free and join this conversation.
If you already have a Qiita account
Why do not you register as a user and use Qiita more conveniently?
You need to log in to use this function. Qiita can be used more conveniently after logging in.
You seem to be reading articles frequently this month. Qiita can be used more conveniently after logging in.
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
ユーザーは見つかりませんでした