Function/method with an empty body PTC-W0049
Anti-pattern
Major
a year ago
—
a year old
setUp doesn't contain any code23class TestWorkerPool(unittest.TestCase):
24 """WorkerPool unit test stubs"""
25
26 def setUp(self):27 pass
28
29 def tearDown(self):tearDown doesn't contain any code26 def setUp(self):
27 pass
28
29 def tearDown(self):30 pass
31
32 def testWorkerPool(self):tearDown doesn't contain any code26 def setUp(self):
27 pass
28
29 def tearDown(self):30 pass
31
32 def testWorker(self):setUp doesn't contain any code23class TestWorker(unittest.TestCase):
24 """Worker unit test stubs"""
25
26 def setUp(self):27 pass
28
29 def tearDown(self):tearDown doesn't contain any code26 def setUp(self):
27 self.api = api.usergroup_api.UsergroupApi() # noqa: E501
28
29 def tearDown(self):30 pass
31
32 def test_create_user_group(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.
'''