Inconsistent overridden method PYL-W0236
Bug risk
Major
4 years ago
—
4 years old
Method 'name' was expected to be 'property', found it instead as 'method'
10 def __init__(self):
11 super(UserWarehouseSearchesFeature, self).__init__()
12
13 def name(self):14 return inflection.underscore(UserWarehouseSearchesFeature.__name__)
15
16 def key(self):Method 'key' was expected to be 'property', found it instead as 'method'
13 def name(self):
14 return inflection.underscore(UserWarehouseSearchesFeature.__name__)
15
16 def key(self):17 return ['user_id', 'warehouse_id']
18
19 def serialization(self):
Description
You're changing the method's type while overriding it in the child class. This may lead to unintentional bugs during runtime because of the incinsistency. Some of the cases where this issue would be raised are:
- Overriding a method as a property, or the other way around.
- Changing a method to async during overriding, or vice versa.
class BaseClass(metaclass=abc.ABCMeta):
@property
@abc.abstractmethod
def prop(self):
...
@abc.abstractmethod
def credit(self):
...
async def yell(self):
...
Bad practice
class InvalidDerived(BaseClass):
def prop(self): # Method was a property in the base class.
...
@property
def credit(self): # Method is being overridden as a `property`
...
def yell(self): # This was async in the base class
...
Recommended
class ValidDerived(BaseClass):
@property
def prop(self):
return None
def credit(self):
return None
async def yell(self):
...