Function/method with an empty body PTC-W0049
Anti-pattern
Major
6 months ago
—
3 years old
__init__ doesn't contain any code 42 """]
43
44class InvalidRouteHandler(BaseHttpHandler):
45 def __init__(self, context): 46 pass
47
48 def handle(self, http_context):__init__ doesn't contain any code 13class DeniedRouteHandler(BaseHttpHandler):
14 """If client authentication is forced, and the client certificate is not valid."""
15
16 def __init__(self, context): 17 pass
18
19 def handle(self, http_context):__exit__ doesn't contain any code280 def __enter__(self):
281 self.check()
282
283 def __exit__(self, exc_type, exc_val, exc_tb):284 pass
signout doesn't contain any code171 def update_password(self):
172 pass
173
174 def signout(self):175 pass
176
177update_password doesn't contain any code168 def check_mail(self, mail):
169 return False
170
171 def update_password(self):172 pass
173
174 def signout(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.
'''