Current File : //proc/thread-self/root/opt/cloudlinux/venv/lib64/python3.11/site-packages/pylint/checkers/async.py
# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
# Copyright (c) https://github.com/PyCQA/pylint/blob/main/CONTRIBUTORS.txt
"""Checker for anything related to the async protocol (PEP 492)."""
from __future__ import annotations
import sys
from typing import TYPE_CHECKING
import astroid
from astroid import nodes, util
from pylint import checkers
from pylint.checkers import utils as checker_utils
from pylint.checkers.utils import decorated_with
if TYPE_CHECKING:
from pylint.lint import PyLinter
class AsyncChecker(checkers.BaseChecker):
name = "async"
msgs = {
"E1700": (
"Yield inside async function",
"yield-inside-async-function",
"Used when an `yield` or `yield from` statement is "
"found inside an async function.",
{"minversion": (3, 5)},
),
"E1701": (
"Async context manager '%s' doesn't implement __aenter__ and __aexit__.",
"not-async-context-manager",
"Used when an async context manager is used with an object "
"that does not implement the async context management protocol.",
{"minversion": (3, 5)},
),
}
def open(self) -> None:
self._mixin_class_rgx = self.linter.config.mixin_class_rgx
self._async_generators = ["contextlib.asynccontextmanager"]
@checker_utils.only_required_for_messages("yield-inside-async-function")
def visit_asyncfunctiondef(self, node: nodes.AsyncFunctionDef) -> None:
for child in node.nodes_of_class(nodes.Yield):
if child.scope() is node and (
sys.version_info[:2] == (3, 5) or isinstance(child, nodes.YieldFrom)
):
self.add_message("yield-inside-async-function", node=child)
@checker_utils.only_required_for_messages("not-async-context-manager")
def visit_asyncwith(self, node: nodes.AsyncWith) -> None:
for ctx_mgr, _ in node.items:
inferred = checker_utils.safe_infer(ctx_mgr)
if inferred is None or isinstance(inferred, util.UninferableBase):
continue
if isinstance(inferred, nodes.AsyncFunctionDef):
# Check if we are dealing with a function decorated
# with contextlib.asynccontextmanager.
if decorated_with(inferred, self._async_generators):
continue
elif isinstance(inferred, astroid.bases.AsyncGenerator):
# Check if we are dealing with a function decorated
# with contextlib.asynccontextmanager.
if decorated_with(inferred.parent, self._async_generators):
continue
else:
try:
inferred.getattr("__aenter__")
inferred.getattr("__aexit__")
except astroid.exceptions.NotFoundError:
if isinstance(inferred, astroid.Instance):
# If we do not know the bases of this class,
# just skip it.
if not checker_utils.has_known_bases(inferred):
continue
# Ignore mixin classes if they match the rgx option.
if (
"not-async-context-manager"
in self.linter.config.ignored_checks_for_mixins
and self._mixin_class_rgx.match(inferred.name)
):
continue
else:
continue
self.add_message(
"not-async-context-manager", node=node, args=(inferred.name,)
)
def register(linter: PyLinter) -> None:
linter.register_checker(AsyncChecker(linter))
Mini Shell