crytic/slither

Rename IR classes so names do not clash with others.

Open

#1059 aperta il 15 feb 2022

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Python (886 fork)batch import
enhancementgood first issuehelp wanted

Metriche repository

Star
 (4769 star)
Metriche merge PR
 (Merge medio 54g 9h) (2 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Esamina le directory slither/slithir/operations e slither/core/expressions per classi con nomi identici, come TypeConversion. Rinomina le classi IR aggiungendo 'IR' ai loro nomi (ad esempio, TypeConversion > TypeConversionIR). Aggiorna tutte le importazioni e i riferimenti nell'intera codebase. Il problema nota che altri pacchetti potrebbero avere conflitti simili, quindi estendi la ricerca secondo necessità.
Tech stack
python
Dominio
backenddeveloper experiencetooling
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitPython
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70