Field duplicates the name of its containing class PTC-W0052
Anti-pattern
Minor
a year ago
—
a year old
Class member
schedule has same name as its encolising class Schedule 82 if update_time is not None:
83 self.update_time = update_time
84 if schedule is not None:
85 self.schedule = schedule 86 if parameters is not None:
87 self.parameters = parameters
88Class member
errors has same name as its encolising class Errors 46 self.discriminator = None
47
48 if errors is not None:
49 self.errors = errors 50
51 @property
52 def errors(self):
Description
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