communicate
doesn't contain any code58 def __init__(self, config):
59 pass
60
61 def communicate(self):62 pass
63
64if __name__ == "__main__":
__init__
doesn't contain any code55 pass
56
57class Communication:
58 def __init__(self, config):59 pass
60
61 def communicate(self):
audit
doesn't contain any code51 def __init__(self, config):
52 pass
53
54 def audit(self):55 pass
56
57class Communication:
__init__
doesn't contain any code48 pass
49
50class Auditor:
51 def __init__(self, config):52 pass
53
54 def audit(self):
detect
doesn't contain any code44 def __init__(self, config):
45 pass
46
47 def detect(self):48 pass
49
50class Auditor:
__init__
doesn't contain any code41 pass
42
43class AnomalyDetector:
44 def __init__(self, config):45 pass
46
47 def detect(self):
prevent
doesn't contain any code37 def __init__(self, config):
38 pass
39
40 def prevent(self):41 pass
42
43class AnomalyDetector:
__init__
doesn't contain any code34 pass
35
36class IntrusionPrevention:
37 def __init__(self, config):38 pass
39
40 def prevent(self):
detect
doesn't contain any code30 def __init__(self, config):
31 pass
32
33 def detect(self):34 pass
35
36class IntrusionPrevention:
__init__
doesn't contain any code27 time.sleep(1)
28
29class ThreatDetector:
30 def __init__(self, config):31 pass
32
33 def detect(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.
'''