Python には文字列を整形する方法がいくつかある。 ここでいう整形というのは、定数や変数を元にお目当ての文字列を手に入れるまでの作業を指す。 今回は、それぞれのやり方を紹介しつつメリット・デメリットについて見ていく。
使った環境は次の通り。
$ sw_vers ProductName: Mac OS X ProductVersion: 10.14.4 BuildVersion: 18E226 $ python -V Python 3.7.3
+ 演算子 (plus operator)
一番シンプルなのが、この + 演算子を使ったやり方だと思う。
文字列同士を + を使うことで連結できる。
>>> 'Hello, ' + 'World!' 'Hello, World!'
ただ、このやり方は文字列同士でないと使えない。 例えば文字列と整数をプラス演算子で連結しようとすると、以下のような例外になる。
>>> 'Hello, ' + 100 Traceback (most recent call last): File "<stdin>", line 1, in <module> TypeError: can only concatenate str (not "int") to str
そのため、連結する前には明示的に文字列にキャストする必要がある。
>>> 'Hello, ' + str(100) 'Hello, 100'
また、このやり方は上述の問題と併せて、長い文字列を作ろうとしたときにコードが煩雑になりがち。 一つか二つの要素の連結でなければ、別のやり方を検討した方が良いと思う。
% 演算子 (%-formatting)
続いては、以前は主流だった % 演算子を使ったやり方。
これは、書式指定子を埋め込んだ文字列に % 演算子を使って値を埋め込んでいくやり方。
>>> 'Hello, %s' % 'World!' 'Hello, World!'
複数の文字列を埋め込むときは、次のようにタプルで渡す。
>>> '%s, %s' % ('Hello', 'World!') 'Hello, World!'
このやり方の欠点は、タプルの扱いに難があること。 例えば、本当にタプルを渡したいときに次のような例外になる。
>>> t = ('this', 'is', 'a', 'tuple') >>> '%s' % t Traceback (most recent call last): File "<stdin>", line 1, in <module> TypeError: not all arguments converted during string formatting
問題を回避するためには、文字列に明示的にキャストしたり、タプルでタプルを包む必要がある。
>>> '%s' % str(t) "('this', 'is', 'a', 'tuple')" >>> '%s' % (t, ) "('this', 'is', 'a', 'tuple')"
% 演算子は、過去に利用が推奨されず将来的に削除される予定だった時期もあった (その後、色々あって撤回された)。
なので、以前から Python を積極的に利用している人たちの中では、過去の手法と捉えている人が多いと思う。
個人的にも % 演算子を使っているコードを見ると、やや古めかしいコードという印象を受ける。
string.Template
続いてはちょっと変化球的な string.Template を使うやり方。
これを使っている場面はほとんど見たことがない。
個人的にも、簡易的なテンプレートエンジン代わりに使ったことしかない。
あらかじめ string.Template をインポートする必要がある。
めんどくさいね。
>>> from string import Template
基本的には書式指定子を文字列に埋め込んで使う点は、先ほどの % 演算子を使う場合と同じ。
>>> s = Template('$greet, $message') >>> s.substitute(greet='Hello', message='World!') 'Hello, World!'
単なる文字列の整形で使う場面はないかな。
str.format()
続いては、現在の主流といえる文字列の format() メソッド。
このやり方は Python 2.6 から導入された。
ここまで見てきたやり方と同じように、文字列に書式指定子を埋め込んで使う。
>>> 'Hello, {}'.format('World!') 'Hello, World!'
% 演算子にあったタプル周りの問題もない。
>>> '{}'.format(t) "('this', 'is', 'a', 'tuple')"
同じ変数を複数回使いたいときもばっちり。
>>> '{0}, {0}, {1}'.format('Hello', 'World!') 'Hello, Hello, World!'
大抵は、上記のように空のブラケットや数字を使うよりも以下のように明示的に名前をつけると思う。
>>> '{a}, {b}'.format(a='Hello', b='World!') 'Hello, World!'
また、変数の数が多いときは、次のように辞書と組み合わせると可読性の低下を防げると思う。
>>> args = {
... 'a': 'Hello',
... 'b': 'World!'
... }
>>> '{a}, {b}'.format(**args)
'Hello, World!'
後述する f-string が使えない環境では、基本的にはこれを使っておけば良いと思う。
f-string
続いては Python 3.6 から導入された最も新しいやり方である f-string について。
このやり方ではスコープに定義済みの変数をそのまま文字列に埋め込める。
>>> greet, message = 'Hello', 'World!' >>> f'{greet}, {message}' 'Hello, World!'
f-string には変数だけでなく、式を含めることもできる。
>>> f'1 + 1 = {1 + 1}' '1 + 1 = 2'
ただ、あまり複雑な式を含めると可読性の低下につながるので注意しよう。
ちなみに f-string の導入前は str.format() と locals() を組み合わせた以下のようなハックが知られていた。
locals() はローカルスコープで定義されている全ての変数を辞書で返す組み込み関数。
>>> greet, message = 'Hello', 'World!' >>> '{greet}, {message}'.format(**locals()) 'Hello, World!'
ちょっと乱暴なやり方といえる。
バージョンに制約があることを除けば f-string は使い勝手が良い。
まとめ
- Python の文字列を整形する方法はいくつかある
- 現在は
str.format()と f-string が主流
