Python APIではpanic=unwindにする

[qryxip]

内容

Python APIをpanic=unwindでビルドすることにより、ユーザー環境で万が一パニックが発生した際の挙動を「プロセスのabort」ではなく「例外の発生」に変えます。

C APIおよびPython APIでは現在(#218 によって)パニック発生時の動作がデフォルトのpanic=unwindからpanic=abort、すなわち「問答無用でのプロセスの強制終了」となっています。

提供するのがC APIのみならこれはバイナリサイズ縮小の効果しかありませんでした。なぜならパニックはそもそもextern "C"の境界を越えられないからです(リンク先のextern "C-unwind"はまだnightly-onlyです)。
(なのでsh1ma/voicevoxcore.go#5のようなことはおそらく不可能です)

しかしPyO3であれば話は別です。PyO3はRustのパニックをpyo3_runtime.PanicExceptionというC Pythonの例外に変換してくれます。例外はCPythonのAPIを通じて外に出るため、DLLの壁を越えることができます。

panic=abort:

thread '<unnamed>' panicked at 'パニックメッセージ', crates/voicevox_core/src/publish.rs:36:9
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
zsh: IOT instruction (core dumped)  python ./run.py

panic=unwind:

 thread '<unnamed>' panicked at 'パニックメッセージ', crates/voicevox_core/src/publish.rs:36:9
 note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
-zsh: IOT instruction (core dumped)  python ./run.py
+Traceback (most recent call last):
+  File "./run.py", line 86, in <module>
+    main()
+  File "./run.py", line 25, in main
+    core = VoicevoxCore(
+pyo3_runtime.PanicException: パニックメッセージ
 ❯ echo $?
-134
+1

バイナリサイズの微妙な減少と例外への変換を比べたとき、ユーザーにとってどちらが望ましいかですが、個人的には後者だと思っています。

• Cargo.tomlでpanic=abortを指定するのをやめる
• Actionsを更新し、C APIだけこれまで通りpanic=abortでビルドされるようにする

関連 Issue

なし

その他

[Hiroshiba]

LGTM！！

[PickledChair]

LGTM！

[qryxip]

提供するのがC APIのみならこれはバイナリサイズ縮小の効果しかありませんでした。なぜならパニックはそもそもextern "C"の境界を越えられないからです(リンク先のextern "C-unwind"はまだnightly-onlyです)。
(なのでsh1ma/voicevoxcore.go#5のようなことはおそらく不可能です)

7/13にリリースされるRust 1.71にextern "C-unwind"が入っていますね。まだ試していませんが、これでC APIからもパニックを送出できるはず。

rust-lang/blog.rust-lang.org#1118