jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-11-09 02:49:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adjust pylint plugin for absolute/relative imports (#77219)

Browse Source 
* Adjust pylint plugin for absolute/relative imports

* Adjust components

* One more

* Adjust mqtt

* Adjust mqtt.DOMAIN import

* Adjust internal import

* Add tests for valid local component imports

* Adjust relative path check

* Fixes

* Fixes
This commit is contained in:
epenet
2022-08-26 14:27:13 +02:00
committed by GitHub
parent 1fb8fbf5de
commit 38ca74b547
7 changed files with 176 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
pylint/plugins/hass_imports.py
View File

@@ -41,15 +41,15 @@ _OBSOLETE_IMPORT: dict[str, list[ObsoleteImportMatch]] = {
"homeassistant.components.automation": [
ObsoleteImportMatch(
reason="replaced by TriggerActionType from helpers.trigger",
constant=re.compile(r"^AutomationActionType$")
constant=re.compile(r"^AutomationActionType$"),
),
ObsoleteImportMatch(
reason="replaced by TriggerData from helpers.trigger",
constant=re.compile(r"^AutomationTriggerData$")
constant=re.compile(r"^AutomationTriggerData$"),
),
ObsoleteImportMatch(
reason="replaced by TriggerInfo from helpers.trigger",
constant=re.compile(r"^AutomationTriggerInfo$")
constant=re.compile(r"^AutomationTriggerInfo$"),
),
],
"homeassistant.components.binary_sensor": [
@@ -111,13 +111,13 @@ _OBSOLETE_IMPORT: dict[str, list[ObsoleteImportMatch]] = {
"homeassistant.components.device_tracker": [
ObsoleteImportMatch(
reason="replaced by SourceType enum",
constant=re.compile(r"^SOURCE_TYPE_\w+$")
constant=re.compile(r"^SOURCE_TYPE_\w+$"),
),
],
"homeassistant.components.device_tracker.const": [
ObsoleteImportMatch(
reason="replaced by SourceType enum",
constant=re.compile(r"^SOURCE_TYPE_\w+$")
constant=re.compile(r"^SOURCE_TYPE_\w+$"),
),
],
"homeassistant.components.fan": [
@@ -277,6 +277,11 @@ class HassImportsFormatChecker(BaseChecker): # type: ignore[misc]
"hass-deprecated-import",
"Used when import is deprecated",
),
"W7423": (
"Absolute import should be used",
"hass-absolute-import",
"Used when relative import should be replaced with absolute import",
),
}
options = ()
@@ -298,9 +303,27 @@ class HassImportsFormatChecker(BaseChecker): # type: ignore[misc]
if module.startswith(f"{self.current_package}."):
self.add_message("hass-relative-import", node=node)
def _visit_importfrom_relative(self, current_package: str, node: nodes.ImportFrom) -> None:
"""Called when a ImportFrom node is visited."""
if node.level <= 1 or not current_package.startswith("homeassistant.components"):
return
split_package = current_package.split(".")
if not node.modname and len(split_package) == node.level + 1:
for name in node.names:
# Allow relative import to component root
if name[0] != split_package[2]:
self.add_message("hass-absolute-import", node=node)
return
return
if len(split_package) < node.level + 2:
self.add_message("hass-absolute-import", node=node)
def visit_importfrom(self, node: nodes.ImportFrom) -> None:
"""Called when a ImportFrom node is visited."""
if not self.current_package:
return
if node.level is not None:
self._visit_importfrom_relative(self.current_package, node)
return
if node.modname == self.current_package or node.modname.startswith(
f"{self.current_package}."