Pythonのformatの小数点の桁数指定について

Question

前提・実現したいこと

Pythonでformatをつかい、桁数指定をしたいです。

発生している問題・エラーメッセージ

unsupported format string passed to numpy.ndarray.__format__

該当のソースコード

print("Decision function: \n {:.3f}".format(gbrt.decision_function(X_test)[:6, :]))

試したこと

np.set_printoptions(precision=3)
print("Decision function: \n {}".format(gbrt.decision_function(X_test)[:6, :]))

としたら、できたのですが、なぜ{:.3f}ではできないのか教えていただきたいです。

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

Answer 1

なぜ{:.3f}ではできないのか教えていただきたいです。

フォーマット .3f が浮動小数を要求するのに対し、NumPyアレイを渡しているからです。
勝手に各要素に対してフォーマットを適用してくれるような便利機能は無いです。

>>> '{:.3f}'.format(3.141592)
'3.142'
>>> '{:.3f}'.format([3.141592, 2.718281])
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: unsupported format string passed to list.__format__

np.set_printoptions [中略] としたら、できた

フォーマット書式を省略した場合、オブジェクトの__str__メソッドが呼ばれます。
numpy.set_printoptionsを用いれば、NumPy側で指示通りの書式を適用してくれるのです。

実験

オレオレクラスで実験。

class MyArray:
    def __init__(self, lst):
        self._lst = lst
        self._format = '{:.5f}'
        
    def set_precision(self, precision):
        self._format = '{{:.{}f}}'.format(precision)
        
    def __str__(self):
        return ' '.join(
            self._format.format(e) for e in self._lst
        )
    
    
arr = MyArray([3.141592, 2.718281])
print('arr is {} !'.format(arr))

arr.set_precision(3)
print('arr is {} !'.format(arr))

print('arr is {:.2f} !'.format(arr))

実行結果 Wandbox

arr is 3.14159 2.71828 !
arr is 3.142 2.718 !
Traceback (most recent call last):
  File "prog.py", line 21, in <module>
    print('arr is {:.2f} !'.format(arr))
TypeError: unsupported format string passed to MyArray.__format__

Comments

[fuma3]

詳しくありがとうございます！
高評価が多かったので、ベストアンサーにさせていただきました！

Answer 2

なぜ{:.3f}ではできないのか

'{:フォーマット文字列}'.format(x)

の実際の動作はビルトイン関数format(x, フォーマット文字列)やそこから呼び出されるx.__format__(フォーマット文字列)が返すものと決まっているようですが、Pythonの基本的なデータ型(intとかfloat)あるいはビルトインライブラリーに含まれるデータ型についてはPython言語の開発をしているチームが仕様を決めていると思います。

一方numpyはPythonのビルトインライブラリーではなくサードパーティーライブラリとでもいうべきものなので、なぜ{:.3f}でフォーマットできないかといえばnumpyの設計者が「できない仕様」と決めたからといえましょう。

numpy設計者は例えば次のような感じにndarrayをフォーマットする仕組みにもできたと思います。

# 非常に大雑把な例
class Array:
    def __init__(self, a):
        self.a = a

    def __str__(self):
        return str(self.a)

    def __format__(self, format_spec):
        return '[' + ', '.join(map(lambda x: format(x, format_spec), self.a)) + ']'


a = Array([1.1, 2.2, 3.3, 3+1j])
print(a)                   # => [1.1, 2.2, 3.3, (3+1j)]
print('{:.3f}'.format(a))  # => [1.100, 2.200, 3.300, 3.000+1.000j]

なぜそうしなかったか自分はテキトーに想像することしかできませんが、例えば

・配列のフォーマットには単に値の精度をどうするかだけでなく、行方向や列方向の最大行数・最大文字数を制限したいだとか様々な要求がある
・numpy.ndarrayは基本的に同じ列の要素の印字幅(文字数)を自動的に合わせようとする。.3fのような全体桁数を曖昧にできるstr.formatの仕様とは充分マッチしないかも知れない。
・それらの要求を満たし、しかも標準のフォーマット文字列の仕様からおおきく逸脱しないようにうまくformat文字列の仕様をnumpyで決めるのはなかなか大変だった
・そういうわけでnumpy独自のAPIを用意した
・APIでフォーマットの詳細を決めることにしたため、仕様の統一性のためstr.formatに精度のみ指定できるという(よく言えば便利、悪く言えば中途半端な)仕様は導入しなかった

・・・なんて思いました。

Comments

[fuma3]

詳しくありがとうございます！