Function/method with an empty body PTC-W0049
Anti-pattern
Major
3 months ago
—
3 years old
__setstate__ doesn't contain any code 82 def __getstate__(self):
83 return {}
84
85 def __setstate__(self, state): 86 pass
87
88 def __eq__(self, other):quit doesn't contain any code159 def set_trigger(self):
160 pass
161
162 def quit(self):163 pass
set_trigger doesn't contain any code156 def disconnect(self):
157 pass
158
159 def set_trigger(self):160 pass
161
162 def quit(self):disconnect doesn't contain any code153 def connect(self):
154 pass
155
156 def disconnect(self):157 pass
158
159 def set_trigger(self):connect doesn't contain any code150 def debug(self):
151 return self.model.shortname, self.coords.name
152
153 def connect(self):154 pass
155
156 def disconnect(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.
'''