yield would not work as expected in the magic method PTC-W0059
Bug risk
Critical
2 years ago
—
2 years old
Special method
__aiter__ cannot be converted into a generator 940
941 async def __aiter__(self) -> t.AsyncIterator[t.Any]:
942 for _ in ():
943 yield 944
945 def __bool__(self) -> bool:
946 return False
Description
Not all magic method can used as generator function as Python's datamodel is strict.
A function or method which uses the yield statement is called a generator function. Magic methods in Python are the special methods that start and end with the double underscores.
Use of yield inside following magic methods in forbidden:
__ixor____rrshift____lt____round____init____invert____pos____rdivmod____ceil____rsub____mul____eq____iadd____enter____index____aiter____radd____init_subclass____imul____matmul____ilshift____del____set____ne____truediv____sub____rmatmul____floordiv____rfloordiv____rxor____rpow____complex____iand____rmul____le____gt____contains____itruediv____missing____rtruediv____floor____get____int____imod____getattribute____new____len____getattr____imatmul____rlshift____instancecheck____divmod____isub____or____neg____bytes____ior____aexit____setattr____length_hint____rand____rshift____exit____lshift____delattr____subclasscheck____delete____pow____set_name____irshift____format____repr____anext____float____aenter____rmod____class_getitem____setitem____await____str____and____getitem____ifloordiv____delitem____ipow____hash____ge____trunc____dir____mod____ror____reversed____xor____abs____add____bool__
You can remove yield from the magic method or rename it to be a custom method.
Bad practice
class MyClass:
def __init__(self):
yield 1
Recommended
class MyClass:
def __init__(self):
pass