Add pylint rule for cached_property (home-assistant#127482)

zxdavb · Oct 3, 2024 · 6eb4999 · 6eb4999
1 parent 1dd5937
commit 6eb4999
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 5 deletions.
diff --git a/homeassistant/backports/functools.py b/homeassistant/backports/functools.py
@@ -9,6 +9,7 @@
 
 from __future__ import annotations
 
+# pylint: disable-next=hass-deprecated-import
 from functools import cached_property as _cached_property, partial
 
 from homeassistant.helpers.deprecation import (

diff --git a/pylint/plugins/hass_imports.py b/pylint/plugins/hass_imports.py
@@ -19,6 +19,12 @@ class ObsoleteImportMatch:
 
 
 _OBSOLETE_IMPORT: dict[str, list[ObsoleteImportMatch]] = {
+    "functools": [
+        ObsoleteImportMatch(
+            reason="replaced by propcache.cached_property",
+            constant=re.compile(r"^cached_property$"),
+        ),
+    ],
     "homeassistant.backports.enum": [
         ObsoleteImportMatch(
             reason="We can now use the Python 3.11 provided enum.StrEnum instead",
@@ -27,10 +33,7 @@ class ObsoleteImportMatch:
     ],
     "homeassistant.backports.functools": [
         ObsoleteImportMatch(
-            reason=(
-                "We can now use the Python 3.12 provided "
-                "functools.cached_property instead"
-            ),
+            reason="replaced by propcache.cached_property",
             constant=re.compile(r"^cached_property$"),
         ),
     ],

diff --git a/tests/test_backports.py b/tests/test_backports.py
@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 from enum import StrEnum
-from functools import cached_property
+from functools import cached_property  # pylint: disable=hass-deprecated-import
 from types import ModuleType
 from typing import Any