Field duplicates the name of its containing class PTC-W0052
Anti-pattern
Minor
9 days ago
—
2 months old
Class member
logger has same name as its encolising class Logger 43 level (str): Logging level as a string. Default is 'DEBUG'.
44 """
45 name = "NEXTCORD_AUTHGUARD"
46 self.logger = logging.getLogger(name) 47 self.logger.setLevel(self._get_logging_level(level)) # Set the logger level
48
49 self._configure_console_handler()Class member
jackpot has same name as its encolising class Jackpot24
25class Jackpot:
26 def __init__(self):
27 self.jackpot = 028
29 def invest(self, amount):
30 self.jackpot += amountClass member
logger has same name as its encolising class Logger 30 Initializes the Logger instance by setting up a logger with a specific name and configuring the console handler.
31 """
32 name = "nextcord_jukebox"
33 self.logger = logging.getLogger(name) 34 self.logger.setLevel(logging.DEBUG) # Set the logger level to DEBUG
35
36 self._configure_console_handler()Class member
queue has same name as its encolising class Queue31
32class Queue:
33 def __init__(self, loop):
34 self.queue = []35 self.lock = asyncio.Lock()
36 self.loop = loop
37 self.executor = concurrent.futures.ThreadPoolExecutor(max_workers=3)Class member
logger has same name as its encolising class Logger 43 level (str): Logging level as a string. Default is 'DEBUG'.
44 """
45 name = "NEXTCORD_JUKEBOX"
46 self.logger = logging.getLogger(name) 47 self.logger.setLevel(self._get_logging_level(level)) # Set the logger level
48
49 self._configure_console_handler()
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