There is a class member with the same name (not considering the case difference) as its enclosing class.

This can cause confusion while reading the code later on keeping a track of what the field represents. It is strongly recommended to provide self-explanatory names so that someone who's reading the code doesn't have to spend time keeping a track of the variable/method names.

Not preferred:

class Orange:
    '''We mean, the fruit.'''
    orange = "#FFA500"

    # Other class implementations

    def get_orange(self):
        return abc

fruit = Orange()
render_to_frontend(fruit.orange)  # Rendering a color, but one can get confused with the fruit
render_bg(fruit.get_orange)  # Not clear that `get_orange` is returning a color

Preferred:

class Orange:
    '''We mean, the fruit.'''
    color = "#FFA500"

    # Other class implementations

    def get_color(self):
        return abc

fruit = Orange()
render_to_frontend(fruit.color)  # Evident that we are working with color
render_bg(fruit.get_color)  # Evident that we are fetching the fruit's color

parazeeknova / nyxtext

No ignore rules found