Pythonのsubprocessでコマンドを実行する

Pythonからコマンドを実行するためのモジュールとしてsubprocessがある。使う機会があって調べたのでまとめておく。

環境

Ubuntu 18.04(WSL)とPython3.6.5。
$ cat /etc/os-release | grep PRETTY_NAME PRETTY_NAME="Ubuntu 18.04.1 LTS" $ python3 -V Python 3.6.5

コマンドの実行

とりあえずコマンドを実行してみる。run関数にオプションや引数を含めてリストにして渡すだけ。
>>> import subprocess >>> subprocess.run(['cat', '/etc/os-release']) NAME="Ubuntu" VERSION="18.04.1 LTS (Bionic Beaver)" ID=ubuntu ID_LIKE=debian PRETTY_NAME="Ubuntu 18.04.1 LTS" VERSION_ID="18.04" HOME_URL="https://www.ubuntu.com/" SUPPORT_URL="https://help.ubuntu.com/" BUG_REPORT_URL="https://bugs.launchpad.net/ubuntu/" PRIVACY_POLICY_URL="https://www.ubuntu.com/legal/terms-and-policies/privacy-policy" VERSION_CODENAME=bionic UBUNTU_CODENAME=bionic CompletedProcess(args=['cat', '/etc/os-release'], returncode=0)

ただ、パイプを使ったコマンドは期待通りに動作しない。
>>> import subprocess >>> subprocess.run(['cat', '/etc/os-release', '|', 'grep', 'PRETTY_NAME']) NAME="Ubuntu" VERSION="18.04.1 LTS (Bionic Beaver)" ID=ubuntu ID_LIKE=debian PRETTY_NAME="Ubuntu 18.04.1 LTS" VERSION_ID="18.04" HOME_URL="https://www.ubuntu.com/" SUPPORT_URL="https://help.ubuntu.com/" BUG_REPORT_URL="https://bugs.launchpad.net/ubuntu/" PRIVACY_POLICY_URL="https://www.ubuntu.com/legal/terms-and-policies/privacy-policy" VERSION_CODENAME=bionic UBUNTU_CODENAME=bionic cat: '|': No such file or directory cat: grep: No such file or directory cat: PRETTY_NAME: No such file or directory CompletedProcess(args=['cat', '/etc/os-release', '|', 'grep', 'PRETTY_NAME'], returncode=1)

パイプを使ったコマンドの実行

パイプを使う方法としては２つある。ひとつはオプションshell=Trueとしてコマンドをシェルで実行する方法。このときはコマンドをリストではなく文字列として渡す。
>>> import subprocess >>> subprocess.run('cat /etc/os-release | grep PRETTY_NAME', shell=True) PRETTY_NAME="Ubuntu 18.04.1 LTS" CompletedProcess(args='cat /etc/os-release | grep PRETTY_NAME', returncode=0)

ただしshell=Trueはセキュリティ上問題になる場合があるので使うには注意が必要（セキュリティで考慮すべき点）。

もうひとつの方法は、パイプでつなぐコマンドごとにPopenクラスのインスタンスを作成し、出力をsubprocess.PIPEを使って受け渡す。
>>> import subprocess >>> >>> ps1 = subprocess.Popen(['cat', '/etc/os-release'], stdout=subprocess.PIPE) >>> ps2 = subprocess.Popen(['grep', 'PRETTY_NAME'], stdin=ps1.stdout, stdout=subprocess.PIPE) >>> ps1.stdout.close() >>> outs, errs = ps2.communicate() >>> print(outs.decode('utf-8')) PRETTY_NAME="Ubuntu 18.04.1 LTS"

エイリアスの実行

エイリアスもオプションshell=Trueで動作するかと思ったがそうはいかない（llは~/.bashrcで定義済みのエイリアスとする）。
>>> import subprocess >>> subprocess.run('ll', shell=True) /bin/sh: 1: ll: not found CompletedProcess(args='ll', returncode=127)

理由はPython subprocess.call a bash aliasに説明があって、shell=Trueオプションではシェルとしてbashではなく/bin/shが使われる。さらに「shell=True, executable='/bin/bash'」オプションでbash上で動作させるようにしても、bashでは対話的（interactive）に動作するときにしか~/.bashrcの設定が反映されない。そこで、bashのオプションで対話的に動作させ、かつエイリアスコマンドを指定して実行する。Pythonの対話モードだと実行後に対話モードが終了してしまうが、llの結果はちゃんと出力される。
>>> import subprocess >>> subprocess.run(['/bin/bash', '-i', '-c', 'll'])