私は最近、Pythonライブラリに出会いました。ライブラリは素晴らしいですが、関数名に1つの明白なタイプミスが含まれています。それをdummy_fuction()
と呼びましょう。 dummy_function()
。この関数は間違いなく「実際に」あり、組み込みシステムで最もよく使用されます。
最初に思い浮かぶのは、正しい名前の関数の2番目のバージョンを追加し、次のリリースの最初のバージョンに非推奨警告を追加することです。
3つの質問:
何よりもまず、ポリシーはメンテナーに依存します。
あなたの質問は興味深いと思いますが、ほとんど意見に基づいています。
私の個人的な意見では、あなたのアプローチは健全です-関数の名前を変更し、スペルミスのバージョンを非推奨のアーティファクトとして残し、正しいものにリダイレクトします。
上記のアプローチは意図しない結果をもたらす可能性がありますか?
たとえば、コードが壊れる可能性があります。誰かがスペルミスにも我慢できず、名前を変更した独自のバージョンを実装した場合。ライブラリを更新すると、名前の衝突が発生します。
この種の問題に対する標準的なアプローチはありますか?
ライブラリを作成するときにスペルミスをしないでください;)
廃止の警告はいつまで残しておくべきですか?
私は、次のメジャーリリース(バージョン番号の最初の桁が増える)まで非推奨を維持する必要があると思います。
これは、一部の-正当化された-下位互換性の破壊が許容できる場合であり、コードが引き続き正常にビルドされることを保証するのはライブラリユーザーの責任です。
変更ログで必ず指摘してください。皆さん、dummy_fuction
を使用している場合は、どこでもdummy_function
に置き換えれば問題ありません。
ライブラリがバージョン管理されていない場合は、バージョン管理を開始することをお勧めします。