crytic/slither

Rename IR classes so names do not clash with others.

Open

#1,059 opened on 2022年2月15日

GitHub で見る
 (1 comment) (0 reactions) (0 assignees)Python (886 forks)batch import
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (4,769 stars)
PR merge metrics
 (平均マージ 54d 9h) (30d で 2 merged PRs)

説明

I noticed that the TypeConversion class from Slither IR

https://github.com/crytic/slither/blob/5021f3e7a04e46dd32655f8d168b43a8bb000770/slither/slithir/operations/type_conversion.py#L7

has the same name as another class from Slither Core

https://github.com/crytic/slither/blob/5021f3e7a04e46dd32655f8d168b43a8bb000770/slither/core/expressions/type_conversion.py#L6

This makes it so that, if you are not extra careful, you can import the wrong class.

I think that it would be a good idea to go through all the classes and look for those that have name clashes across different "packages" and rename them, for example by adding an IR suffix to them (TypeConversionIR).

NOTE:

This might apply to different packages i.e not only SlitherIR, in which case a different suffix would need to be added.

コントリビューターガイド

調査方針
slither/slithir/operations と slither/core/expressions ディレクトリ内で、TypeConversion など同じ名前を持つクラスを確認します。IR クラスの名前の末尾に 'IR' を追加してリネームします（例：TypeConversion > TypeConversionIR）。コードベース全体のすべてのインポートと参照を更新します。この課題では、他のパッケージにも同様の衝突がある可能性があると指摘されているため、必要に応じて検索範囲を拡張してください。
技術スタック
python
領域
backenddeveloper experiencetooling
Issue 種別
リファクタリング
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
GitPython
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70