evlli/hass-core
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Small performance improvement to pylint plugin (#118475)

Browse source 
* Small improvement to pylint plugin

* Adjust

* Improve

* Rename variable and drop used argument
This commit is contained in:
epenet 2024-05-31 12:03:29 +02:00 • committed by GitHub
parent 8a3b49434e
commit ec4545ce4a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 9 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
pylint/plugins/hass_enforce_type_hints.py
View file

@ -3092,11 +3092,6 @@ def _get_module_platform(module_name: str) -> str | None:
return platform.lstrip(".") if platform else "__init__" return platform.lstrip(".") if platform else "__init__"
def _is_test_function(module_name: str, node: nodes.FunctionDef) -> bool:
"""Return True if function is a pytest function."""
return module_name.startswith("tests.") and node.name.startswith("test_")
class HassTypeHintChecker(BaseChecker): class HassTypeHintChecker(BaseChecker):
"""Checker for setup type hints.""" """Checker for setup type hints."""
@ -3136,12 +3131,14 @@ class HassTypeHintChecker(BaseChecker):
_class_matchers: list[ClassTypeHintMatch] _class_matchers: list[ClassTypeHintMatch]
_function_matchers: list[TypeHintMatch] _function_matchers: list[TypeHintMatch]
_module_name: str _module_name: str
_in_test_module: bool
def visit_module(self, node: nodes.Module) -> None: def visit_module(self, node: nodes.Module) -> None:
"""Populate matchers for a Module node.""" """Populate matchers for a Module node."""
self._class_matchers = [] self._class_matchers = []
self._function_matchers = [] self._function_matchers = []
self._module_name = node.name self._module_name = node.name
self._in_test_module = self._module_name.startswith("tests.")
if (module_platform := _get_module_platform(node.name)) is None: if (module_platform := _get_module_platform(node.name)) is None:
return return
@ -3233,8 +3230,10 @@ class HassTypeHintChecker(BaseChecker):
matchers = _METHOD_MATCH matchers = _METHOD_MATCH
else: else:
matchers = self._function_matchers matchers = self._function_matchers
if _is_test_function(self._module_name, node): if self._in_test_module and node.name.startswith("test_"):
self._check_test_function(node, annotations) self._check_test_function(node)
return
for match in matchers: for match in matchers:
if not match.need_to_check_function(node): if not match.need_to_check_function(node):
continue continue
@ -3251,11 +3250,7 @@ class HassTypeHintChecker(BaseChecker):
# Check that all positional arguments are correctly annotated. # Check that all positional arguments are correctly annotated.
if match.arg_types: if match.arg_types:
for key, expected_type in match.arg_types.items(): for key, expected_type in match.arg_types.items():
if ( if node.args.args[key].name in _COMMON_ARGUMENTS:
node.args.args[key].name in _COMMON_ARGUMENTS
or _is_test_function(self._module_name, node)
and node.args.args[key].name in _TEST_FIXTURES
):
# It has already been checked, avoid double-message # It has already been checked, avoid double-message
continue continue
if not _is_valid_type(expected_type, annotations[key]): if not _is_valid_type(expected_type, annotations[key]):
@ -3268,11 +3263,7 @@ class HassTypeHintChecker(BaseChecker):
# Check that all keyword arguments are correctly annotated. # Check that all keyword arguments are correctly annotated.
if match.named_arg_types is not None: if match.named_arg_types is not None:
for arg_name, expected_type in match.named_arg_types.items(): for arg_name, expected_type in match.named_arg_types.items():
if ( if arg_name in _COMMON_ARGUMENTS:
arg_name in _COMMON_ARGUMENTS
or _is_test_function(self._module_name, node)
and arg_name in _TEST_FIXTURES
):
# It has already been checked, avoid double-message # It has already been checked, avoid double-message
continue continue
arg_node, annotation = _get_named_annotation(node, arg_name) arg_node, annotation = _get_named_annotation(node, arg_name)
@ -3301,9 +3292,7 @@ class HassTypeHintChecker(BaseChecker):
args=(match.return_type or "None", node.name), args=(match.return_type or "None", node.name),
) )
def _check_test_function( def _check_test_function(self, node: nodes.FunctionDef) -> None:
self, node: nodes.FunctionDef, annotations: list[nodes.NodeNG | None]
) -> None:
# Check the return type, should always be `None` for test_*** functions. # Check the return type, should always be `None` for test_*** functions.
if not _is_valid_type(None, node.returns, True): if not _is_valid_type(None, node.returns, True):
self.add_message( self.add_message(