Function/method with an empty body PTC-W0049
Anti-pattern
Major
6 months ago
—
3 years old
session_clear doesn't contain any code71 def session_get(self, request, name, default=None, decode=True, secure=True):
72 pass
73
74 def session_clear(self, request, name):75 pass
76
77 def clean_sso_application_name(self, name):session_get doesn't contain any code68 def session_set(self, request, name, value, secure=True):
69 pass
70
71 def session_get(self, request, name, default=None, decode=True, secure=True):72 pass
73
74 def session_clear(self, request, name):session_set doesn't contain any code65 def media_url(self, path, request):
66 pass
67
68 def session_set(self, request, name, value, secure=True):69 pass
70
71 def session_get(self, request, name, default=None, decode=True, secure=True):media_url doesn't contain any code62 def media_delete(self, path):
63 pass
64
65 def media_url(self, path, request):66 pass
67
68 def session_set(self, request, name, value, secure=True):media_delete doesn't contain any code59 def media_save(self, path, content):
60 pass
61
62 def media_delete(self, path):63 pass
64
65 def media_url(self, path, request):
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.
'''