crytic/slither

Rename IR classes so names do not clash with others.

Open

#1.059 aberto em 15 de fev. de 2022

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)Python (886 forks)batch import
enhancementgood first issuehelp wanted

Métricas do repositório

Stars
 (4.769 stars)
Métricas de merge de PR
 (Mesclagem média 54d 9h) (2 fundiu PRs em 30d)

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.

Guia do colaborador

Direção de pesquisa
Revise os diretórios slither/slithir/operations e slither/core/expressions em busca de classes com nomes idênticos, como TypeConversion. Renomeie as classes IR adicionando 'IR' aos seus nomes (por exemplo, TypeConversion > TypeConversionIR). Atualize todas as importações e referências em toda a base de código. O problema observa que outros pacotes podem ter conflitos semelhantes, portanto, estenda a busca conforme necessário.
Pilha de tecnologia
python
Domain
backenddeveloper experiencetooling
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitPython
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70