crytic/slither

Rename IR classes so names do not clash with others.

Open

#1 059 ouverte le 15 févr. 2022

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)Python (886 forks)batch import
enhancementgood first issuehelp wanted

Métriques du dépôt

Stars
 (4 769 stars)
Métriques de merge PR
 (Merge moyen 54j 9h) (2 PRs mergées en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Examinez les répertoires slither/slithir/operations et slither/core/expressions pour les classes ayant des noms identiques, comme TypeConversion. Renommez les classes IR en ajoutant 'IR' à leurs noms (par exemple, TypeConversion > TypeConversionIR). Mettez à jour toutes les importations et références dans l'ensemble de la base de code. Le problème note que d'autres packages peuvent avoir des conflits similaires, étendez donc la recherche si nécessaire.
Stack technique
python
Domaine
backenddeveloper experiencetooling
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitPython
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70