Function/method with an empty body PTC-W0049
Anti-pattern
Major
2 years ago
—
2 years old
custom_signup doesn't contain any code 57
58 return data
59
60 def custom_signup(self, request, user): 61 pass
62
63 def get_cleaned_data(self):get_indirect_match doesn't contain any code 85 return transformed_profile
86
87
88def get_indirect_match(user, number_of_matches_to_make=1): 89 pass
90
91
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.
'''