Function/method with an empty body PTC-W0049
Anti-pattern
Major
2 years ago
—
3 years old
on_message doesn't contain any code200 "hm://collection/collection/" + session.username() + "/json"
201 ])
202
203 def on_message(self, uri: str, headers: typing.Dict[str, str],204 payload: bytes):
205 pass
stored doesn't contain any code1156 hi = buffer.read(1)
1157 return int(lo[0]) & 0x7f | int(hi[0]) << 7
1158
1159 def stored(self):1160 """
1161 TODO: implement function
1162 """close doesn't contain any code253 "Zeroconf HTTP server started successfully on port {}!".format(
254 port))
255
256 def close(self) -> None:257 pass
258
259 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.
'''