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

Add CoverEntity to pylint checks (#74036)

Browse source 
* Add CoverEntity to pylint checks

* Avoid false positivies on device_class

* Adjust device_class handling

* Adjust device_class again using a singleton

* Adjust device_class (again)

* Simplify DEVICE_CLASS check

* Keep device_class in base class
This commit is contained in:
epenet 2022-06-27 14:58:23 +02:00 • committed by GitHub
parent 10ea88e0ea
commit f9c83dd991
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 114 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

115
pylint/plugins/hass_enforce_type_hints.py
View file

@ -10,6 +10,7 @@ from pylint.lint import PyLinter
from homeassistant.const import Platform from homeassistant.const import Platform
DEVICE_CLASS = object()
UNDEFINED = object() UNDEFINED = object()
_PLATFORMS: set[str] = {platform.value for platform in Platform} _PLATFORMS: set[str] = {platform.value for platform in Platform}
@ -474,7 +475,7 @@ _ENTITY_MATCH: list[TypeHintMatch] = [
), ),
TypeHintMatch( TypeHintMatch(
function_name="device_class", function_name="device_class",
return_type=["str", None], return_type=[DEVICE_CLASS, "str", None],
), ),
TypeHintMatch( TypeHintMatch(
function_name="unit_of_measurement", function_name="unit_of_measurement",
@ -571,6 +572,101 @@ _TOGGLE_ENTITY_MATCH: list[TypeHintMatch] = [
), ),
] ]
_INHERITANCE_MATCH: dict[str, list[ClassTypeHintMatch]] = { _INHERITANCE_MATCH: dict[str, list[ClassTypeHintMatch]] = {
"cover": [
ClassTypeHintMatch(
base_class="Entity",
matches=_ENTITY_MATCH,
),
ClassTypeHintMatch(
base_class="CoverEntity",
matches=[
TypeHintMatch(
function_name="device_class",
return_type=["CoverDeviceClass", "str", None],
),
TypeHintMatch(
function_name="current_cover_position",
return_type=["int", None],
),
TypeHintMatch(
function_name="current_cover_tilt_position",
return_type=["int", None],
),
TypeHintMatch(
function_name="is_opening",
return_type=["bool", None],
),
TypeHintMatch(
function_name="is_closing",
return_type=["bool", None],
),
TypeHintMatch(
function_name="is_closed",
return_type=["bool", None],
),
TypeHintMatch(
function_name="open_cover",
kwargs_type="Any",
return_type=None,
has_async_counterpart=True,
),
TypeHintMatch(
function_name="close_cover",
kwargs_type="Any",
return_type=None,
has_async_counterpart=True,
),
TypeHintMatch(
function_name="toggle",
kwargs_type="Any",
return_type=None,
has_async_counterpart=True,
),
TypeHintMatch(
function_name="set_cover_position",
kwargs_type="Any",
return_type=None,
has_async_counterpart=True,
),
TypeHintMatch(
function_name="stop_cover",
kwargs_type="Any",
return_type=None,
has_async_counterpart=True,
),
TypeHintMatch(
function_name="open_cover_tilt",
kwargs_type="Any",
return_type=None,
has_async_counterpart=True,
),
TypeHintMatch(
function_name="close_cover_tilt",
kwargs_type="Any",
return_type=None,
has_async_counterpart=True,
),
TypeHintMatch(
function_name="set_cover_tilt_position",
kwargs_type="Any",
return_type=None,
has_async_counterpart=True,
),
TypeHintMatch(
function_name="stop_cover_tilt",
kwargs_type="Any",
return_type=None,
has_async_counterpart=True,
),
TypeHintMatch(
function_name="toggle_tilt",
kwargs_type="Any",
return_type=None,
has_async_counterpart=True,
),
],
),
],
"fan": [ "fan": [
ClassTypeHintMatch( ClassTypeHintMatch(
base_class="Entity", base_class="Entity",
@ -583,6 +679,10 @@ _INHERITANCE_MATCH: dict[str, list[ClassTypeHintMatch]] = {
ClassTypeHintMatch( ClassTypeHintMatch(
base_class="FanEntity", base_class="FanEntity",
matches=[ matches=[
TypeHintMatch(
function_name="device_class",
return_type=["str", None],
),
TypeHintMatch( TypeHintMatch(
function_name="percentage", function_name="percentage",
return_type=["int", None], return_type=["int", None],
@ -656,6 +756,10 @@ _INHERITANCE_MATCH: dict[str, list[ClassTypeHintMatch]] = {
ClassTypeHintMatch( ClassTypeHintMatch(
base_class="LockEntity", base_class="LockEntity",
matches=[ matches=[
TypeHintMatch(
function_name="device_class",
return_type=["str", None],
),
TypeHintMatch( TypeHintMatch(
function_name="changed_by", function_name="changed_by",
return_type=["str", None], return_type=["str", None],
@ -713,6 +817,15 @@ def _is_valid_type(
if expected_type is UNDEFINED: if expected_type is UNDEFINED:
return True return True
# Special case for device_class
if expected_type == DEVICE_CLASS and in_return:
return (
isinstance(node, nodes.Name)
and node.name.endswith("DeviceClass")
or isinstance(node, nodes.Attribute)
and node.attrname.endswith("DeviceClass")
)
if isinstance(expected_type, list): if isinstance(expected_type, list):
for expected_type_item in expected_type: for expected_type_item in expected_type:
if _is_valid_type(expected_type_item, node, in_return): if _is_valid_type(expected_type_item, node, in_return):