crytic/slither

Rename IR classes so names do not clash with others.

Open

#1,059 opened on Feb 15, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (4,769 stars) (886 forks)batch import
enhancementgood first issuehelp wanted

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.

Contributor guide

Tech stack
python
Domain
developer experience
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
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.