Function/method with an empty body PTC-W0049
Anti-pattern
Major
2 months ago
—
6 months old
new_instance_window doesn't contain any code239 )
240 open_directory_button.grid(row=2, column=0, pady=5, sticky="nsew")
241
242 def new_instance_window():243 pass
244
245 open_new_window = C.CTkButton(new_instance_window doesn't contain any code239 )
240 open_directory_button.grid(row=2, column=0, pady=5, sticky="nsew")
241
242 def new_instance_window():243 pass
244
245 open_new_window = C.CTkButton(color_schemes doesn't contain any code498 # Show the context menu at the mouse cursor's position
499 context_menu.post(self.x_root, self.y_root)
500
501 def color_schemes():502 pass
new_file doesn't contain any code478 def git_integration(self):
479 pass
480
481 def new_file(self):482 pass
483
484 @staticmethodgit_integration doesn't contain any code475 def auto_complete(self):
476 pass
477
478 def git_integration(self):479 pass
480
481 def new_file(self):
Description
The function/method has been left empty here, without any comment or docstring. This can cause confusion later on why this was left empty.
- If it is intentionally left blank, a nested comment should explain the reason why it is being done.
- If this is not yet, or never will be, supported, an exception should be thrown rather than leaving it blank.
Not preferred:
def myfunc1(foo="Noncompliant"):
pass
class MyClass:
def mymethod1(self, foo="Noncompliant"):
pass
Preferred:
def myfunc1():
pass # comment explaining why this function is empty
def myfunc2():
raise NotImplementedError()
def myfunc3():
'''
Docstring explaining why this function is empty.
'''
class MyClass:
def mymethod1(self):
pass # comment explaining why this function is empty
def mymethod2(self):
raise NotImplementedError()
def mymethod3(self):
'''
Docstring explaining why this method is empty. Note that this is not recommended for classes
which are meant to be subclassed.
'''