Field duplicates the name of its containing class PTC-W0052
Anti-pattern
Minor
8 months ago
—
a year old
Class member
cab has same name as its encolising class CAB 812 def __init__(self, num_feat, compress_ratio=3, squeeze_factor=30):
813 super().__init__()
814
815 self.cab = nn.Sequential( 816 nn.Conv2d(num_feat, num_feat // compress_ratio, 3, 1, 1),
817 nn.GELU(),
818 nn.Conv2d(num_feat // compress_ratio, num_feat, 3, 1, 1),
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