jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-22 20:57:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add function/property name to pylint message (#75913)

Browse Source
This commit is contained in:
epenet 2022-08-01 14:09:47 +02:00 committed by GitHub
parent 826de707e4
commit 1a40d400dc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 27 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
pylint/plugins/hass_enforce_type_hints.py
View File

@ -1577,12 +1577,12 @@ class HassTypeHintChecker(BaseChecker): # type: ignore[misc]
priority = -1 priority = -1
msgs = { msgs = {
"W7431": ( "W7431": (
"Argument %s should be of type %s", "Argument %s should be of type %s in %s",
"hass-argument-type", "hass-argument-type",
"Used when method argument type is incorrect", "Used when method argument type is incorrect",
), ),
"W7432": ( "W7432": (
"Return type should be %s", "Return type should be %s in %s",
"hass-return-type", "hass-return-type",
"Used when method return type is incorrect", "Used when method return type is incorrect",
), ),
@ -1669,7 +1669,7 @@ class HassTypeHintChecker(BaseChecker): # type: ignore[misc]
self.add_message( self.add_message(
"hass-argument-type", "hass-argument-type",
node=node.args.args[key], node=node.args.args[key],
args=(key + 1, expected_type), args=(key + 1, expected_type, node.name),
) )
# Check that all keyword arguments are correctly annotated. # Check that all keyword arguments are correctly annotated.
@ -1680,7 +1680,7 @@ class HassTypeHintChecker(BaseChecker): # type: ignore[misc]
self.add_message( self.add_message(
"hass-argument-type", "hass-argument-type",
node=arg_node, node=arg_node,
args=(arg_name, expected_type), args=(arg_name, expected_type, node.name),
) )
# Check that kwargs is correctly annotated. # Check that kwargs is correctly annotated.
@ -1690,13 +1690,15 @@ class HassTypeHintChecker(BaseChecker): # type: ignore[misc]
self.add_message( self.add_message(
"hass-argument-type", "hass-argument-type",
node=node, node=node,
args=(node.args.kwarg, match.kwargs_type), args=(node.args.kwarg, match.kwargs_type, node.name),
) )
# Check the return type. # Check the return type.
if not _is_valid_return_type(match, node.returns): if not _is_valid_return_type(match, node.returns):
self.add_message( self.add_message(
"hass-return-type", node=node, args=match.return_type or "None" "hass-return-type",
node=node,
args=(match.return_type or "None", node.name),
) )

35
tests/pylint/test_enforce_type_hints.py
View File

@ -215,7 +215,7 @@ def test_invalid_discovery_info(
pylint.testutils.MessageTest( pylint.testutils.MessageTest(
msg_id="hass-argument-type", msg_id="hass-argument-type",
node=discovery_info_node, node=discovery_info_node,
args=(4, "DiscoveryInfoType | None"), args=(4, "DiscoveryInfoType | None", "async_setup_scanner"),
line=6, line=6,
col_offset=4, col_offset=4,
end_line=6, end_line=6,
@ -268,7 +268,10 @@ def test_invalid_list_dict_str_any(
pylint.testutils.MessageTest( pylint.testutils.MessageTest(
msg_id="hass-return-type", msg_id="hass-return-type",
node=func_node, node=func_node,
args=["list[dict[str, str]]", "list[dict[str, Any]]"], args=(
["list[dict[str, str]]", "list[dict[str, Any]]"],
"async_get_triggers",
),
line=2, line=2,
col_offset=0, col_offset=0,
end_line=2, end_line=2,
@ -325,7 +328,7 @@ def test_invalid_config_flow_step(
pylint.testutils.MessageTest( pylint.testutils.MessageTest(
msg_id="hass-argument-type", msg_id="hass-argument-type",
node=arg_node, node=arg_node,
args=(2, "ZeroconfServiceInfo"), args=(2, "ZeroconfServiceInfo", "async_step_zeroconf"),
line=10, line=10,
col_offset=8, col_offset=8,
end_line=10, end_line=10,
@ -334,7 +337,7 @@ def test_invalid_config_flow_step(
pylint.testutils.MessageTest( pylint.testutils.MessageTest(
msg_id="hass-return-type", msg_id="hass-return-type",
node=func_node, node=func_node,
args="FlowResult", args=("FlowResult", "async_step_zeroconf"),
line=8, line=8,
col_offset=4, col_offset=4,
end_line=8, end_line=8,
@ -399,7 +402,7 @@ def test_invalid_config_flow_async_get_options_flow(
pylint.testutils.MessageTest( pylint.testutils.MessageTest(
msg_id="hass-argument-type", msg_id="hass-argument-type",
node=arg_node, node=arg_node,
args=(1, "ConfigEntry"), args=(1, "ConfigEntry", "async_get_options_flow"),
line=12, line=12,
col_offset=8, col_offset=8,
end_line=12, end_line=12,
@ -408,7 +411,7 @@ def test_invalid_config_flow_async_get_options_flow(
pylint.testutils.MessageTest( pylint.testutils.MessageTest(
msg_id="hass-return-type", msg_id="hass-return-type",
node=func_node, node=func_node,
args="OptionsFlow", args=("OptionsFlow", "async_get_options_flow"),
line=11, line=11,
col_offset=4, col_offset=4,
end_line=11, end_line=11,
@ -491,7 +494,7 @@ def test_invalid_entity_properties(
pylint.testutils.MessageTest( pylint.testutils.MessageTest(
msg_id="hass-return-type", msg_id="hass-return-type",
node=prop_node, node=prop_node,
args=["str", None], args=(["str", None], "changed_by"),
line=9, line=9,
col_offset=4, col_offset=4,
end_line=9, end_line=9,
@ -500,7 +503,7 @@ def test_invalid_entity_properties(
pylint.testutils.MessageTest( pylint.testutils.MessageTest(
msg_id="hass-argument-type", msg_id="hass-argument-type",
node=func_node, node=func_node,
args=("kwargs", "Any"), args=("kwargs", "Any", "async_lock"),
line=14, line=14,
col_offset=4, col_offset=4,
end_line=14, end_line=14,
@ -509,7 +512,7 @@ def test_invalid_entity_properties(
pylint.testutils.MessageTest( pylint.testutils.MessageTest(
msg_id="hass-return-type", msg_id="hass-return-type",
node=func_node, node=func_node,
args="None", args=("None", "async_lock"),
line=14, line=14,
col_offset=4, col_offset=4,
end_line=14, end_line=14,
@ -587,7 +590,7 @@ def test_named_arguments(
pylint.testutils.MessageTest( pylint.testutils.MessageTest(
msg_id="hass-argument-type", msg_id="hass-argument-type",
node=percentage_node, node=percentage_node,
args=("percentage", "int | None"), args=("percentage", "int | None", "async_turn_on"),
line=10, line=10,
col_offset=8, col_offset=8,
end_line=10, end_line=10,
@ -596,7 +599,7 @@ def test_named_arguments(
pylint.testutils.MessageTest( pylint.testutils.MessageTest(
msg_id="hass-argument-type", msg_id="hass-argument-type",
node=preset_mode_node, node=preset_mode_node,
args=("preset_mode", "str | None"), args=("preset_mode", "str | None", "async_turn_on"),
line=12, line=12,
col_offset=8, col_offset=8,
end_line=12, end_line=12,
@ -605,7 +608,7 @@ def test_named_arguments(
pylint.testutils.MessageTest( pylint.testutils.MessageTest(
msg_id="hass-argument-type", msg_id="hass-argument-type",
node=func_node, node=func_node,
args=("kwargs", "Any"), args=("kwargs", "Any", "async_turn_on"),
line=8, line=8,
col_offset=4, col_offset=4,
end_line=8, end_line=8,
@ -614,7 +617,7 @@ def test_named_arguments(
pylint.testutils.MessageTest( pylint.testutils.MessageTest(
msg_id="hass-return-type", msg_id="hass-return-type",
node=func_node, node=func_node,
args="None", args=("None", "async_turn_on"),
line=8, line=8,
col_offset=4, col_offset=4,
end_line=8, end_line=8,
@ -670,7 +673,7 @@ def test_invalid_mapping_return_type(
pylint.testutils.MessageTest( pylint.testutils.MessageTest(
msg_id="hass-return-type", msg_id="hass-return-type",
node=property_node, node=property_node,
args=["Mapping[str, Any]", None], args=(["Mapping[str, Any]", None], "capability_attributes"),
line=15, line=15,
col_offset=4, col_offset=4,
end_line=15, end_line=15,
@ -809,7 +812,7 @@ def test_invalid_long_tuple(
pylint.testutils.MessageTest( pylint.testutils.MessageTest(
msg_id="hass-return-type", msg_id="hass-return-type",
node=rgbw_node, node=rgbw_node,
args=["tuple[int, int, int, int]", None], args=(["tuple[int, int, int, int]", None], "rgbw_color"),
line=15, line=15,
col_offset=4, col_offset=4,
end_line=15, end_line=15,
@ -818,7 +821,7 @@ def test_invalid_long_tuple(
pylint.testutils.MessageTest( pylint.testutils.MessageTest(
msg_id="hass-return-type", msg_id="hass-return-type",
node=rgbww_node, node=rgbww_node,
args=["tuple[int, int, int, int, int]", None], args=(["tuple[int, int, int, int, int]", None], "rgbww_color"),
line=21, line=21,
col_offset=4, col_offset=4,
end_line=21, end_line=21,