Bad async magic method PTC-W0045
Bug risk
Major
2 years ago
—
2 years old
Magic method
__aiter__ can not be made async 938 def __iter__(self) -> t.Iterator[t.Any]:
939 yield from ()
940
941 async def __aiter__(self) -> t.AsyncIterator[t.Any]: 942 for _ in ():
943 yield
944
Description
Magic methods that are not supposed to be asynchronous would not work as expected if they are made async.
It is recommend to not make this magic method async.
Follwing magic methods should not asynchronous:
__lshift____bytes____new____del____abs____eq____trunc____truediv____exit____getattr____repr____gt____and____dir____ifloordiv____rand____pow____set_name____format____rtruediv____complex____getitem____init_subclass____get____await____sub____ne____or____rmul____rxor____mod____rmod____subclasscheck____pos____int____round____add____ixor____mul____ipow____itruediv____missing____lt____hash____instancecheck____ror____aiter____xor____imul____delete____delitem____setitem____divmod____invert____contains____rpow____floor____len____iand____class_getitem____floordiv____setattr____enter____irshift____le____ilshift____init____rmatmul____rdivmod____radd____imod____iter____delattr____bool____length_hint____reversed____getattribute____isub____imatmul____rsub____rrshift____matmul____float____neg____str____rfloordiv____index____rlshift____ge____ior____iadd____rshift____set____ceil__
Bad practice
class BadClass:
async def __lt__(self, other):
...
Recommended
class GoodClass:
def __lt__(self, other):
...