【PySide】ソフト文字列をQTranslatorで翻訳・多言語化する手順を解説！

アプリ・ソフトをPySideで開発する時。

グローバルなソフトを作りたい、
日本語以外の多言語に翻訳したい、
最低限英語だけにも対応したい

そういう時はQTranslatorを使います。
ただその手順が思いのほかに難しかったです。

そこでここでは　英語 => 日本語のように、
PySideソフトを多言語化する手順を解説します。

※ 開発にはPySide6を使用

このページの目次

１．pythonコード内で翻訳文字列をtr()で囲む
２．lupdateコマンドからtsファイルを生成
３．linguistを使ってtsファイルの文字列翻訳
４．lreleaseを使って .ts → .qm に変換する
５．QTranslatorからqmファイルを読んで翻訳
確実に手順を踏んでいけば翻訳も簡単

１．pythonコード内で翻訳文字列をtr()で囲む

翻訳文字列を tr() で囲みます。

▼ QObject.tr()について

PySide6.QtCore.QObject.tr(sourceText[, disambiguation=None[, n=-1]])
PARAMETERS
- sourceText - str
- disambiguation - str
- n - int
RETURN TYPE
str
引用元　：　https://doc.qt.io/qtforpython-6/PySide6/QtCore/QObject.html?highlight=qobject#PySide6.QtCore.PySide6.QtCore.QObject.tr

リファレンスでの言及はこれだけ。

第１引数が翻訳対象の文字列です。また翻訳言語に対応するものがなかった場合に返されるデフォルトの値でもあります。このデフォルトは英語(en)にするのが無難。
日本語だとデフォでja_JPになっちゃいます。

▼ 実際には次のようなコードで翻訳する

from PySide6.QtCore import QObject, QTranslator, QLocale

class App(QObject):
    def __init__(self):
        ## 翻訳文字列
        msg = QObject.tr("Select a image file")
        print("msg : "+msg)
        
if __name__ == "__main__":
    app = App()

from PySide6.QtCore import QObject, QTranslator, QLocale

class App(QObject):

def __init__(self):

## 翻訳文字列

msg = QObject.tr("Select a image file")

print("msg : "+msg)

if __name__ == "__main__":

app = App()

上記のようにpythonコード内で QObject.tr("Select a image file") と文字列を囲んでいくだけです。ひたすら翻訳対象を tr() していってください。

２．lupdateコマンドからtsファイルを生成

次にpyコードからtsファイルを作ります。

これはバイナリのqmファイルの材料みたいなもの

その生成に使うのが pyside6-lupdateコマンドです。

▼ 例えば次のようにコマンド実行

> pyside6-lupdate app.py -ts app.ja_JP.ts

1	> pyside6-lupdate app.py -ts app.ja_JP.ts

▼ 生成されたapp.ja_JP.tsの中身

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE TS>
<TS version="2.1" language="ja_JP">
<context>
    <name>QObject</name>
    <message>
        <location filename="launcher.py" line="232"/>
        <source>Select a image file</source>
        <translation type="unfinished"></translation>
    </message>
</context>
</TS>

<?xml version="1.0" encoding="utf-8"?>

<!DOCTYPE TS>

<name>QObject</name>

<source>Select a image file</source>

</message>

</context>

</TS>

ご覧の通り普通のXMLファイルです。

３．linguistを使ってtsファイルの文字列翻訳

そしたら次にLinguistを使っての翻訳作業

GUIを使って翻訳できるので、この部分は楽です。

▼ 生成したtsファイルをLinguistをコマンドから起動

>pyside6-linguist app.ja_JP.ts

1	>pyside6-linguist app.ja_JP.ts

▼ GUIが起動したら翻訳していけばOK

翻訳が終わったらtsファイルを一旦保存します。

４．lreleaseを使って .ts → .qm に変換する

そして翻訳が終わったらqmファイルとして保存します。

※ このqmはバイナリ形式

それにはlreleaseコマンドというもので変換可能です。

▼ 例えば以下のように変換する

pyside6-lrelease app.ja_JP.ts -qm translations/app.ja_JP.qm

1	pyside6-lrelease app.ja_JP.ts -qm translations/app.ja_JP.qm

場所は pyside6-lrelease を実行した場所に translations という名前のフォルダを作り、そこに app.ja_JP.qm のファイル名で保存しました。

このqmファイルは命名規則を決めておくべきです。

ここでは上記のように名前を付けました。

qmファイル名　：　app.ja_JP.qm

何でもいいですが、次の独自ルールにしてます。

app.py の翻訳なら接頭辞は app にする
名前・言語コードはドット（.）で区切る
拡張子は必ず .qm にすること

後述するようにqmファイル読み込みは少し厄介です。

だから独自でも何でも命名規則を決めておくのがグッド

ここでは以上のようにして命名しました。

５．QTranslatorからqmファイルを読んで翻訳

いよいよ翻訳作業も大詰め

翻訳をQTranslatorから行ってみます。

▼ 次のようなpythonコードで試してみた

from PySide6.QtCore import QObject, QTranslator, QLocale

class App(QObject):
    def __init__(self):
        ## 翻訳用qmファイルを読み込み
        translator = QTranslator(app)
        # qmファイルのあるディレクトリパス
        path = "/path/to/translations"
        if translator.load(QLocale.system(), 'app', '.', path):
            ## ローカルからqmファイル読み込み
            app.installTranslator(translator)
        translator = QTranslator(app)
        path = ':/translations'
        if translator.load(QLocale.system(), 'app', '_', './translations'):
            ## リソースからqmファイル読み込み
            app.installTranslator(translator)
    
        ## 翻訳文字列
        msg = QObject.tr("Select a image file")
        print("msg : "+msg)
        
if __name__ == "__main__":
    app = App()

from PySide6.QtCore import QObject, QTranslator, QLocale

class App(QObject):

def __init__(self):

## 翻訳用qmファイルを読み込み

translator = QTranslator(app)

# qmファイルのあるディレクトリパス

path = "/path/to/translations"

if translator.load(QLocale.system(), 'app', '.', path):

## ローカルからqmファイル読み込み

app.installTranslator(translator)

translator = QTranslator(app)

path = ':/translations'

if translator.load(QLocale.system(), 'app', '_', './translations'):

## リソースからqmファイル読み込み

app.installTranslator(translator)

## 翻訳文字列

msg = QObject.tr("Select a image file")

print("msg : "+msg)

if __name__ == "__main__":

app = App()

▼ 上手くいけばソフト文字列が翻訳される

引っかかるのはQTranslator.loadでの読み込み

translator.load(QLocale.system(), 'app', '.', path)

1	translator.load(QLocale.system(), 'app', '.', path)

各引数は次のような意味を持ってます。

第１引数はロケール
ここではシステム固有のロケール（QLocale.system()）を使う。このロケールは日本語だったら ja__JP であることがほとんど（値は QLocale.system().name() から確認できる）
第２引数はqmファイルの名前
例えば app.ja_JP.qm だったら 'app' という値を指定する。ファイルパスは含める必要はないし、含めてはいけない。
第３引数は区切り文字
例えば app.ja_JP.qm だったら '.' という値を指定する。つまりqmファイルの名前と言語コード(ja_JP)を隔てる区切り文字を指定するってこと
第４引数はqmファイルの場所
実際にqmファイルがあるディレクトリパスを指定する。ただしディレクトリ区切り文字にはバックスラッシュ(\)ではなくスラッシュ(/)を使うこと。特にWindowsでは注意！

これだけ押さえておけば大丈夫

もし翻訳されないなら変換手順が間違ってます。