Function/method with an empty body PTC-W0049
Anti-pattern
Major
6 months ago
—
3 years old
validate_name doesn't contain any code923 pass
924
925 @classmethod
926 def validate_name(cls, bundle, name):927 """
928 Raise BundleError if the given name is not valid (e.g. contains
929 invalid characters for this kind of item.validate_attributes doesn't contain any code913 pass
914
915 @classmethod
916 def validate_attributes(cls, bundle, item_id, attributes):917 """
918 Raises BundleError if something is amiss with the user-specified
919 attributes.test doesn't contain any code902 """
903 raise NotImplementedError()
904
905 def test(self):906 """
907 Used by `bw repo test`. Should do as much as possible to detect
908 what would become a runtime error during a `bw apply`. Files
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.
'''