PythonでImagemagickを使ったら出力がNoneになってしまう

Question

目的

imagemagickを用いて画像の差分を取るプログラムをpythonで制作しています。画像の枚数は多数です(今回はテストとして8回計算させたいです)

発生している問題

関数で差分を取り、その差分をリストに格納したいのですが、リストの中身が[none]になってしまいます。
また、関数はfor文内に入れているはずなのですが、この関数の計算だけ先に回数分(8回分)先に終わらせてから差分のリスト(diff_list)をfor文に従って表示するという良く分からない出力になっています。

どのように解決すればよいのでしょうか？(´・ω・)

10.8885240.8668640.8768520.8786140.8689920.8724130.89801[None]
[None, None]
[None, None, None]
[None, None, None, None]
[None, None, None, None, None]
[None, None, None, None, None, None]
[None, None, None, None, None, None, None]
[None, None, None, None, None, None, None, None]

該当のソースコード

import subprocess
import os

def compare_SSIM(i):
    cmd = "compare -metric SSIM /Users/xxxx/Desktop/imagemagick/image_SS/0.png " + "/Users/xxxx/Desktop/imagemagick/image_SS/" + str(i) + ".png NULL"
    proc = subprocess.run(cmd,shell=True, stdout=subprocess.PIPE)


diff_list = []

for i in range(8):
 diff_list.append(compare_SSIM(i))
 print(diff_list)

試したこと

コマンドを単体でコマンドプロンプトで実行した場合、きちんと出力が表示されます。(0.876852などです)。
関数ではなく以下を単体でpythonで実行した場合、数値+何かが出力されます...(´・ω・)

cmd = "compare -metric SSIM /Users/xxxx/Desktop/imagemagick/image_SS/0.png " + "/Users/xxxx/Desktop/imagemagick/image_SS/1.png NULL"
proc = subprocess.run(cmd,shell=True, stdout=subprocess.PIPE)

print(proc)
--------------------------------------------------------------------------
出力↓
0.888524CompletedProcess(args='compare -metric SSIM /Users/xxxx/Desktop/imagemagick/image_SS/0.png /Users/xxxx/Desktop/imagemagick/image_SS/1.png NULL', returncode=1, stdout=b'')

補足情報（FW/ツールのバージョンなど）

pythonのバージョンは3.7.1です。

Answer 1

「subprocess python 出力」と検索したらこちらが出ました。
この内容の場合バイト列で返りますが、それを文字列に変換し、スペースで区切り、数値に変換すればよいです。

Comments

[oriori_K]

そのサイトを以前拝見させていただいたのですが、私の知識不足であまり理解出来ませんでした..
バイト列で出力が来るとありますが、
def compare_SSIM_test():
cmd = "compare -metric SSIM 1.png 2.png NULL"
proc = subprocess.run(cmd,shell=True, stdout=subprocess.PIPE)

a = compare_SSIM_test()
print(type(a))
print(a)
という形でテストしてみたところ、
0.872098<class 'NoneType'>
None
という関数を作ってテストしてみたところこのような結果が出力されました。これは...バイト列なのでしょうか(´・ω・)
プログラミング初心者で申し訳ありません...

[fiveHundred]

とりあえず、y_waiwaiさんの指摘を100回読み直してください。
compare_SSIM_test()にreturn文（＝返り値）が無い時点でおかしいです。
私の提示したサイトにある「subprocess.check_output」や「Popen.communicate」ではなく、「subprocess.run」のままですし、まずは自分で考えてから発言してください。

[oriori_K]

返り値を付けると
0.888524CompletedProcess(args='compare -metric SSIM /Users/xxxxx/Desktop/imagemagick/image_SS/0.png /Users/xxxxx/Desktop/imagemagick/image_SS/1.png NULL', returncode=1, stdout=b'')
という出力が得られます。return分がなくても出力が出ているのでreturn文は不要かと考えているのですが違うのでしょうか？return文が必要ならその理由とは何なのでしょうか？
また、subprocess.runを用いている理由に関してですが、現在python3系では.runを用いる形が一番安定かつ高機能らしいからです。
一応自分でもかなり調べた結果詰まったのでここで質問しています。
よろしくお願いいたします。

[fiveHundred]

> return分がなくても出力が出ているのでreturn文は不要かと考えているのですが違うのでしょうか？return文が必要ならその理由とは何なのでしょうか？

そもそも、「出力＝return文」という認識が間違っています。
return文が無い場合は、どんな出力があろうと返り値は常にNoneになります。
この場合、0.888524は出力されているだけで、どこにも格納されていません。

> また、subprocess.runを用いている理由に関してですが、現在python3系では.runを用いる形が一番安定かつ高機能らしいからです。

上記の点、私の理解不足でした。
しかしながら、subprocess.runの返り値が何なのか分かっていないのは、そもそも高機能とか語る以前の問題です。

出力内容や以下のサイトを見るに、subprocess.runの返り値はCompletedProcessだそうです。
https://docs.python.org/ja/3/library/subprocess.html
CompletedProcessの使い方もこのサイトに載っていますので、確認してみてください。

Answer 2

その関数は戻り値を返してません。なのでNoneしか得られません

Comments

[oriori_K]

戻り値ありの場合というのはこういうことでしょうか？
def compare_SSIM(i):
cmd = "compare -metric SSIM /Users/xxxx/Desktop/imagemagick/image_SS/0.png " + "/Users/xxxx/Desktop/imagemagick/image_SS/" + str(i) + ".png NULL"
proc = subprocess.run(cmd,shell=True, stdout=subprocess.PIPE)
return proc

a = compare_SSIM(1)
print(a)

この場合ですと出力が
0.888524CompletedProcess(args='compare -metric SSIM /Users/xxxxx/Desktop/imagemagick/image_SS/0.png /Users/xxxxx/Desktop/imagemagick/image_SS/1.png NULL', returncode=1, stdout=b'')

となってしまい、リストに格納できないみたいです...

[y_waiwai]

あなたがなにをしようとしてるのかはこちらからはわかりません。
ただ、Noneになる理由を答えているだけです。

なにを聞きたいんでしょうか。

[oriori_K]

Imagemagickを用いて、python上で画像の差分を取るプログラムを制作しています。imagemagickコマンドはsubprocessを用いてpython上で実行します。

compare_SSIM関数の出力(0.888524など）をリストに格納したいのに、リストに格納すると出力がnoneになってしまい困っている状況です。
理想はリストに[0.888524, 0.521351,0.631......]のように格納することです。

Answer 3

解決しました。y_waiwai様,fiveHundred様非常に参考になりました。ありがとうございました。

subprocessで標準出力を取る場合、stdout = subprocess.PIPEで取るらしいのでstdoutを用いて色々テストを繰り返していましたが、結局 stderr = subprocess.PIPEの標準エラー出力の方を取る事で欲しい出力が得られました(厳密には出力はbytes型なのでstr型にしてリストに格納しました).

以下が解決したコードです。

import subprocess
import sys

def compare_SSIM(i):
    cmd = "compare -metric SSIM 0.png " + str(i) + ".png NULL"
    result = subprocess.run(cmd,shell=True, stderr=subprocess.PIPE)
    return result

diff_list = []

for i in range(8):
 result = compare_SSIM(i)
 result_str = result.stderr.decode()
 diff_list.append(result_str)
 print(diff_list)

出力は以下です

['1']
['1', '0.888524']
['1', '0.888524', '0.866864']
['1', '0.888524', '0.866864', '0.10999']
['1', '0.888524', '0.866864', '0.10999', '0.878614']
['1', '0.888524', '0.866864', '0.10999', '0.878614', '0.868992']
['1', '0.888524', '0.866864', '0.10999', '0.878614', '0.868992', '0.872413']
['1', '0.888524', '0.866864', '0.10999', '0.878614', '0.868992', '0.872413', '0.89801']