Pythonの文字列テンプレートクラス（string.Template）の使い方を徹底解説

Pythonのstring.Templateクラスは、シンプルなテンプレート文字列を作成するための機能です。Python 2.4で初めて導入されました。テンプレートは、コンストラクタにテンプレート文字列を引数として渡すことで生成します。

従来の%記号を使う文字列フォーマット演算子とは異なり、Templateオブジェクトではドル記号（$）をプレースホルダーの目印として使用する点が特徴です。

Templateクラスの主なメソッド

Templateクラスには、テンプレートから文字列を生成するためのメソッドが用意されています。

• string.Template(template) ― コンストラクタです。テンプレート文字列を1つの引数として受け取ります。

• substitute(mapping, **keywords) ― テンプレート内のプレースホルダーを、マッピング（辞書風オブジェクト）やキーワード引数で渡した値に置き換えます。マッピングとキーワード引数を同時に指定した場合は、キーワード引数が優先されます。プレースホルダーに対応する値が存在しない場合はKeyErrorが発生します。

• safe_substitute(mapping, **keywords) ― 基本的な動作はsubstitute()と同じですが、対応する値が見つからない場合でもエラーにならず、元のプレースホルダーがそのまま残ります。これによりKeyErrorを回避できます。

公開属性：template

Templateオブジェクトには、公開されている属性が1つあります。

• template ― コンストラクタに渡されたテンプレート文字列そのものです。読み取り専用が厳密に強制されているわけではありませんが、プログラム内でこの属性を書き換えることは推奨されません。

Pythonテンプレート文字列の基本例

from string import Template

t = Template('$when, $who $action $what.')
s = t.substitute(when='In the winter', who='Rajesh', action='drinks', what='Coffee')
print(s)

# 辞書をsubstituteの引数として渡す例

d = {"when": "In the winter", "who": "Rajesh", "action": "drinks", "what": "Coffee"}
s = t.substitute(**d)
print(s)

実行結果

In the winter, Rajesh drinks Coffee.
In the winter, Rajesh drinks Coffee.

safe_substitute()の使用例

from string import Template

t = Template('$when, $who $action $what.')
s = t.safe_substitute(when='In the winter', who='Rajesh', action='drinks', what='Coffee')
print(s)

実行結果

In the winter, Rajesh drinks Coffee.

テンプレート文字列の表示

Templateオブジェクトのtemplate属性を参照すると、元のテンプレート文字列を取得できます。

from string import Template

t = Template('$when, $who $action $what.')
print('Template String: ', t.template)

実行結果

Template String: $when, $who $action $what.

$記号のエスケープ方法

テンプレート内でドル記号そのものを出力したい場合は、$$のように$を2つ重ねてエスケープします。

from string import Template

t = Template('$$ is called $name')
s = t.substitute(name='Dollar')
print(s)

実行結果

$ is called Dollar

${identifier}形式の使い方

${<identifier>}は$<identifier>と同等の意味を持ちます。この波括弧形式が必要になるのは、プレースホルダーの直後に識別子として有効な文字が続くものの、それがプレースホルダーの一部ではない場合です。たとえば${noun}ificationのようなケースが該当します。

from string import Template
t = Template('$noun adjective is ${noun}ing')
s = t.substitute(noun='Test')
print(s)

実行結果

Test adjective is Testing

このように${noun}ingと記述することで、「noun」というプレースホルダーと「ing」という文字列を明確に区別でき、意図した通りの置換結果が得られます。