Function/method with an empty body PTC-W0049
Anti-pattern
Major
a year ago
—
a year old
update doesn't contain any code 80 docs_icon = EZ.load_image("Resources/Images/docs_icon.png")
81 EZ.draw_image(docs_icon, x + 20, y + (height - docs_icon.get_height()) / 2)
82
83 def update(self): 84 pass
85
86 def run(self):check_events doesn't contain any code195 self.working_directory = os.getcwd()
196 self.explore_app_ui = UI.explore_UI.ExploreUI(self)
197
198 def check_events(self):199 pass
200
201 @staticmethodcheck_events doesn't contain any code195 self.working_directory = os.getcwd()
196 self.explore_app_ui = UI.explore_UI.ExploreUI(self)
197
198 def check_events(self):199 pass
200
201 @staticmethodupdate doesn't contain any code 80 docs_icon = EZ.load_image("Resources/Images/docs_icon.png")
81 EZ.draw_image(docs_icon, x + 20, y + (height - docs_icon.get_height()) / 2)
82
83 def update(self): 84 pass
85
86 def run(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.
'''