Function/method with an empty body PTC-W0049
Anti-pattern
Major
5 months ago
—
3 years old
close doesn't contain any code 81 """Method to test uploading of multiple files"""
82
83 class FileObj(BytesIO):
84 def close(self): 85 pass
86
87 class MyRequest(Request):close doesn't contain any code 46 """Method to test uploading of single file"""
47
48 class FileObj(BytesIO):
49 def close(self): 50 pass
51
52 class MyRequest(Request):__init__ doesn't contain any code102
103
104class BlueprintsManager:
105 def __init__(self):106 pass
107
108 @staticmethod__init__ doesn't contain any code 4
5
6class Environment:
7 def __init__(self): 8 pass
9
10 DEVELOPMENT = 'development'__init__ doesn't contain any code20
21
22class Environment:
23 def __init__(self):24 pass
25
26 DEVELOPMENT = 'development'
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.
'''