mirror of
https://github.com/trezor/trezor-firmware.git
synced 2024-12-18 04:18:10 +00:00
f0d6539d3d
for now, it catches the following incorrect function:
async def show_foo() -> Awaitable[None]:
return show_something_else("foo")
because to correctly show the result, the caller would have to "await (await show_foo())"
(this should either be "async def show_foo() -> None", or "def show_foo() -> Awaitable[None]")
30 lines
1.0 KiB
Python
30 lines
1.0 KiB
Python
from astroid import AsyncFunctionDef
|
|
from pylint.checkers import BaseChecker
|
|
from pylint.checkers.utils import check_messages
|
|
from pylint.interfaces import IAstroidChecker
|
|
|
|
|
|
class AsyncAwaitableChecker(BaseChecker):
|
|
__implements__ = IAstroidChecker
|
|
|
|
name = "async-awaitable-checker"
|
|
priority = -1
|
|
msgs = {
|
|
"W9999": (
|
|
'Async function "%s" is likely not meant to return an Awaitable.',
|
|
"async-awaitable-return",
|
|
"Used when an async function returns an Awaitable instead of the result.",
|
|
),
|
|
}
|
|
|
|
@check_messages("async-awaitable-return")
|
|
def visit_asyncfunctiondef(self, node: AsyncFunctionDef):
|
|
# Check if the return type is explicitly an Awaitable
|
|
if node.returns and "Awaitable" in node.returns.as_string():
|
|
self.add_message("async-awaitable-return", node=node, args=(node.name,))
|
|
|
|
|
|
def register(linter):
|
|
"""Required method to auto register this checker."""
|
|
linter.register_checker(AsyncAwaitableChecker(linter))
|