pyproject.tomlのバージョン管理問題をなんとかしたい

[Hiroshiba]

内容

現在、バージョン情報が2箇所に定義されており、混乱や誤用の原因となる問題があります：

• pyproject.toml:3 → version = "0.24.0" # TODO: できればversionを自動管理する
• voicevox_engine/__init__.py:3 → __version__ = "latest"

ビルドワークフロー（.github/workflows/build-engine.yml:401）では__init__.pyの__version__が実際のバージョンに置き換えられ、真のバージョン管理は__init__.pyで行われています。

問題点：
pyproject.tomlに固定のバージョン値（現在0.24.0）が存在するため、誤ってこちらを参照するコードを書いてしまう危険性があります。

Pros 良くなる点

• バージョン管理の混乱解消
• 誤用による予期しないバグの防止
• 開発者の認識統一

Cons 悪くなる点

• 良い解決策が見つからない
• PEP 621の制約により理想的な実装が困難

実現方法

1. 調べる: より良い解決策を調査・検討する
2. 暫定対応: pyproject.tomlのversionを0.0.0などのダミー値に変更し、コメントで意図を明記する（誤用した場合に問題が明確になる）

VOICEVOXのバージョン

engine 0.24.0

その他

この問題は過去のPR #1658 でも議論されていました。

いくつかの解決策を試してみましたが、いずれも問題がありました：

• versionのコメントアウト → PEP 621の仕様によりエラー（[project]テーブル使用時はversion必須）
• uvの非パッケージモード → 設定の複雑化と既存システムへの影響

PEP 621の制約により根本的な解決は困難ですが、現状の混乱を放置するわけにもいかないため、何らかの対策が必要です。

[sevenc-nanashi]

既存のソリューションを知ってる限りで出すとこんな感じですね：

• Rust：ビルド時にenv!("CARGO_PKG_VERSION")で参照できる
• Ruby：そもそもpyproject.toml相当がRubyのDSLなので、内部の__version__相当をインポートできる

うーん、

• なんらかの形（tomlをパースする？）でpyproject.tomlをパースする
• project.versionが__version__と一致してるかどうかを確認する
  • 不一致だったらexit 1
• これをリリース後テストに組み込む

とか…？

[sabonerune]

engine_manifest.jsonもありますね。
厄介なことに開発時は__version__と異なり999.999.999となっています。

個人的にpyproject.tomlのversionは完全に使わないことにしたほうがいい気がします。
そもそもこのファイルは元々バンドルしていないので実行時に参照するのは単純に無駄が増えます。

Pythonの__version__は単によく使われているだけで標準ではありません。
確実に取得するにはimportlib.metadata等を使う必要があります。
パッケージをビルドする側ではビルド時にソースコード側の__version__を書きかえることもあれば逆にビルド時に__version__を読み取ってパッケージのメタデータに設定することもあります。

[Hiroshiba]

@sabonerune engine_manifest.jsonもありましたね！！
このissue見返す感じ、「__version__は使わない。代わりにengine_manifest.jsonのversionを使う」となってそう。

---

いろいろ考えたんですが、pyproject.tomlのversionは、せめて値を異常なもの（0.0.0とか999.999.999とか）にして、使わないことを意識するのが良いかなぁと思いました。

@sabonerune さんの仰るとおり

pyproject.tomlのversionは完全に使わない

のが良いのですが、とはいえ間違って使えてしまいうるのが怖いんですよね。。

まーーーーとりあえずダミー値に変更して様子見かなぁ！
engine_manifest.jsonと揃えてダミー値は999.999.999で良さそう感！

（@tarepan さん的になにかコメントあれば！！）

[sabonerune]

engine_manifest.jsonと揃えてダミー値は999.999.999で良さそう感！

engine_manifest.jsonと同じだとここも置き換えて使うのではと思われそうなので0.0.0+DO_NOT_USE_THIS_STRINGのように明らかに使いそうもない値にするとか?
(コメントだけで十分かもしれませんが)

[Hiroshiba]

コメントだけで十分･･･というより、まあ何やっても不十分という気もしてきますね！！

project.versionはPEP440に従ってればよく、PEP440的には 0 とかも合法らしいので、使おうとした人が流石におかしいと気づきやすそうな 0 が良いかな～～～とか思いました！！

[github-actions]

本 Issue は直近 180 日間で活動がありません。今後の方針について VOICEVOX チームによる再検討がおこなわれる予定です。