Blender 上での翻訳において、文字列フォーマットを利用する方法

参考1：公式のAPI Document

参考2：ぬっち氏の「Blenderスクリプトを多言語対応させる方法」 　

Blender 2.91 での結論

---

• %演算子、 str.format()、 f 文字列の3つとも利用可能

• 通常の場所、つまりlabel(text="")では、bpy.app.translations.pgettext_iface()を使う
  ツールチップ(多分description)ではbpy.app.translations.pgettext_tip()を使う
  bpy.app.translations.pgettext()でも可能だが、公式側は推奨していない

• %演算子や str.format()を使う方法

   # 辞書のイメージ(%演算子)： "Active Object is %s"　→　"アクティブオブジェクトは %s です"
   # 　　　　　　(format())： "Active Object is {}"　→　"アクティブオブジェクトは {} です"
   
   # 翻訳結果にフォーマットを適用するので、pgettext_iface() の外に "% (~)" や ".format(~)"を記述する
   label(text = bpy.app.translations.pgettext_iface("Active Object is %s") % (context.active_object.name) )
   label(text = bpy.app.translations.pgettext_iface("Active Object is {}").format(context.active_object.name) )

  • 長所：記述量が少ない
  • 短所：辞書側の記述が "{} を削除しました" のようになり、少し情報不足

• f 文字列を使う方法

  • その1： 'f"{~}"'のように f を含めて文章を翻訳(置換)し、eval()を使ってf 文字列として評価する
  • その2：　"{~}"のように f は含めず文章を翻訳(置換)し、f を追加した上でeval()で評価を使ってf 文字列として評価する

   # 辞書のイメージ(その1)： 'f"Active Object is {name}"'　→　'f"アクティブオブジェクトは {name} です"'
   # 　　　　　　　(その2)： "Active Object is {name}"　→　"アクティブオブジェクトは {name} です"
   
   # その1  eval( 'f"名前は {name} です"' ) のようなもの
   label(text = eval(
   	bpy.app.translations.pgettext_iface('f"Active Object is {context.active_object.name}"' )
   	))
   
   # その2  eval( f'f"{名前は {name} です}"' ) のようなもの
   label(text = eval(
   	f'f"{ bpy.app.translations.pgettext_iface("Active Object is {name}") }"'
   	))

  • 長所："{object.name} を削除しました" のようになるので、結果が想像しやすい
  • 短所：必要な処理が増え、クォーテーションが多用されるのでコードが読みづらい

結果

---

アドオンを読み込み、Testingタブからアドオンの詳細を表示させると、以下のような表示となる
アクティブなオブジェクトを変更し、アドオンの詳細の上にマウスを動かすなどして再度 draw() を実行させると、翻訳結果も変わることが確認できるはず

◇仕組みの自分なりの理解

• 文字列フォーマットを直接使った場合：
  「英文に対応する日本語」の取得よりも前に、英語文章に対してフォーマットが適用されてしまう
  　"Object is {name}"　→　フォーマット適用　→　"Object is Cube"　→　対応する日本語の取得に失敗する(訳されない)

• pgettext_iface()を経由した場合：
  「英文に対応する日本語」の取得が先に行われるので、日本語文章に対してフォーマットを適用できる
  　"Object is {name}"　→　"オブジェクトは {name} です"　→　フォーマット適用　→　"オブジェクトは Cube です"

◇感想

• 手軽なのは.format()だが、空の"{}"が入った文章を扱いたくない
• f 文字列その1は悪くないが、f を入れ忘れる自分が想像できるのであまり使いたくない
• f 文字列その2は、2行に分ければ記述は整理できるが、ミスが多発しそうなのは変わらず

   text = bpy.app.translations.pgettext_iface("4: Active Object is {name}")
   self.layout.label(text = eval(f"f'{text}'"))