Rename IR classes so names do not clash with others. · crytic/slither#1059

(1 留言) (0 反應) (0 負責人)Python (4,769 star) (886 fork)batch import

enhancementgood first issuehelp wanted

描述

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.

貢獻者指南

技術棧: python
領域: developer experience
議題類型: refactor
難度: 3
預計時間: 1-3 hours
活動狀態: stale
清晰度: clear
前置要求: Python
新手友善度: 75
研究方向: Review the slither/slithir/operations and slither/core/expressions directories for classes with identical names, such as TypeConversion. Rename the IR classes by appending 'IR' to their names (e.g., TypeConversion > TypeConversionIR). Update all imports and references across the codebase. The issue notes that other packages may have similar clashes, so extend the search as needed.