Migrate quirks out of zigpy and provide direct entity access

pyproject.toml

@@ -14,13 +14,14 @@ readme = "README.md"
 license = {text = "Apache-2.0"}
 requires-python = ">=3.12"
 dependencies = [
-    "zigpy==1.6.0",
+    "attrs",
+    "frozendict",
     "bellows==0.49.2",
     "zigpy-znp==1.1.0",
     "zigpy-deconz==0.25.5",
     "zigpy-xbee==0.21.1",
     "zigpy-zigate==0.14.0",
-    "zha-quirks==1.2.0",
+    "zigpy==2.0.0",
 ]
 
 [tool.setuptools.packages.find]
@@ -30,7 +31,8 @@ exclude = ["tests", "tests.*"]
 testing = [
     "pytest",
     "coloredlogs",
-    "python-slugify"
+    "python-slugify",
+    "homeassistant",
 ]
 
 [dependency-groups]
@@ -51,6 +53,7 @@ testing = [
     "python-slugify",
     "ruff==0.15.16",
     "uv>=0.11.16",
+    "zha-quirks>=2.0.0",
 ]
 ci = [
     {include-group = "testing"},
@@ -61,6 +64,16 @@ ci = [
 [tool.uv]
 default-groups = ["testing"]
 
+# `zha` and `zha-quirks` mutually pin `>=2.0.0`, but neither is tagged 2.0.0 yet. Drop
+# those bounds for the dev lock so resolution succeeds. Will be fixed in 2.0.1.
+[[tool.uv.dependency-metadata]]
+name = "zha-quirks"
+version = "2.0.0"
+requires-dist = ["zigpy>=2.0.0", "zha"]
+
+[tool.uv.sources]
+zha-quirks = { git = "https://github.com/puddly/zha-device-handlers", rev = "7ac5b603cec5ae12fd24a7f40522aeb607aa4b1a" }
+
 [tool.setuptools-git-versioning]
 enabled = true
 
@@ -96,209 +109,193 @@ non_interactive = true
 # first; clean up a module's errors and re-run the tool to shrink the list.
 # Autogenerated mypy overrides: start
 [[tool.mypy.overrides]]
-module = "zha.application.discovery"
+module = "zha.application.platforms.button"
 disable_error_code = [
-    "no-any-return",  # 3
+    "assignment",  # 1
 ]
 
 [[tool.mypy.overrides]]
 module = "zha.application.platforms.update"
 disable_error_code = [
-    "arg-type",  # 3
+    "arg-type",  # 1
 ]
 
 [[tool.mypy.overrides]]
-module = "zha.async_"
+module = "zha.application.platforms.virtual"
 disable_error_code = [
-    "arg-type",  # 2
-    "no-untyped-def",  # 1
+    "no-any-return",  # 1
 ]
 
 [[tool.mypy.overrides]]
-module = "zha.zigbee.cluster_config"
+module = "zha.quirks"
 disable_error_code = [
-    "arg-type",  # 2
-    "no-untyped-call",  # 1
+    "no-any-return",  # 1
 ]
 
 [[tool.mypy.overrides]]
-module = "zha.application.platforms.lock"
+module = "zha.application.platforms.number"
 disable_error_code = [
-    "arg-type",  # 3
-    "no-untyped-def",  # 1
+    "no-any-return",  # 2
 ]
 
 [[tool.mypy.overrides]]
 module = "zha.application.platforms.siren"
 disable_error_code = [
-    "arg-type",  # 2
     "assignment",  # 2
 ]
 
 [[tool.mypy.overrides]]
-module = "zha.event"
+module = "zha.application.discovery"
 disable_error_code = [
-    "no-untyped-def",  # 4
+    "no-any-return",  # 3
 ]
 
 [[tool.mypy.overrides]]
-module = "zha.application.platforms.device_tracker"
+module = "zha.application.platforms.binary_sensor"
+disable_error_code = [
+    "no-any-return",  # 1
+    "no-untyped-call",  # 1
+    "no-untyped-def",  # 1
+]
+
+[[tool.mypy.overrides]]
+module = "zha.application.platforms.lock"
 disable_error_code = [
     "arg-type",  # 2
-    "no-untyped-def",  # 3
+    "no-untyped-def",  # 1
 ]
 
 [[tool.mypy.overrides]]
-module = "zha.zigbee.group"
+module = "zha.async_"
 disable_error_code = [
-    "no-untyped-def",  # 3
-    "return-value",  # 2
+    "arg-type",  # 2
+    "no-untyped-def",  # 1
+]
+
+[[tool.mypy.overrides]]
+module = "zha.zigbee.cluster_config"
+disable_error_code = [
+    "arg-type",  # 2
+    "no-untyped-call",  # 1
 ]
 
 [[tool.mypy.overrides]]
 module = "zha.application.platforms"
 disable_error_code = [
     "arg-type",  # 1
     "assignment",  # 1
-    "attr-defined",  # 2
     "no-any-return",  # 2
 ]
 
 [[tool.mypy.overrides]]
-module = "zha.application.platforms.button"
+module = "zha.application.platforms.device_tracker"
 disable_error_code = [
-    "arg-type",  # 5
-    "assignment",  # 2
-    "override",  # 2
+    "arg-type",  # 1
+    "no-untyped-def",  # 3
 ]
 
 [[tool.mypy.overrides]]
-module = "zha.application.gateway"
+module = "zha.application.platforms.switch"
 disable_error_code = [
-    "arg-type",  # 3
-    "assignment",  # 2
-    "no-untyped-call",  # 4
-    "return-value",  # 1
+    "arg-type",  # 1
+    "no-any-return",  # 1
+    "no-untyped-call",  # 2
+]
+
+[[tool.mypy.overrides]]
+module = "zha.event"
+disable_error_code = [
+    "no-untyped-def",  # 4
+]
+
+[[tool.mypy.overrides]]
+module = "zha.zigbee.group"
+disable_error_code = [
+    "no-untyped-def",  # 3
+    "return-value",  # 2
 ]
 
 [[tool.mypy.overrides]]
 module = "zha.application.platforms.fan"
 disable_error_code = [
-    "arg-type",  # 5
+    "arg-type",  # 2
     "index",  # 1
     "no-any-return",  # 3
     "no-untyped-def",  # 1
 ]
 
 [[tool.mypy.overrides]]
-module = "zha.application.platforms.alarm_control_panel"
+module = "zha.application.gateway"
 disable_error_code = [
-    "arg-type",  # 1
-    "no-untyped-call",  # 1
-    "no-untyped-def",  # 11
+    "arg-type",  # 3
+    "assignment",  # 2
+    "no-untyped-call",  # 4
+    "return-value",  # 1
 ]
 
 [[tool.mypy.overrides]]
-module = "zha.application.helpers"
+module = "zha.application.platforms.alarm_control_panel"
 disable_error_code = [
-    "arg-type",  # 2
-    "no-untyped-call",  # 4
-    "no-untyped-def",  # 10
+    "no-untyped-call",  # 1
+    "no-untyped-def",  # 11
 ]
 
 [[tool.mypy.overrides]]
 module = "zha.application.platforms.cover"
 disable_error_code = [
-    "arg-type",  # 3
     "no-any-return",  # 3
     "no-untyped-call",  # 6
     "no-untyped-def",  # 5
 ]
 
 [[tool.mypy.overrides]]
-module = "zha.application.platforms.binary_sensor"
+module = "zha.application.helpers"
 disable_error_code = [
-    "arg-type",  # 22
-    "no-any-return",  # 1
-    "no-untyped-call",  # 1
-    "no-untyped-def",  # 1
-    "override",  # 1
+    "arg-type",  # 2
+    "no-untyped-call",  # 4
+    "no-untyped-def",  # 10
 ]
 
 [[tool.mypy.overrides]]
 module = "zha.application.platforms.light"
 disable_error_code = [
-    "arg-type",  # 9
+    "arg-type",  # 5
     "no-any-return",  # 4
     "no-untyped-call",  # 11
     "no-untyped-def",  # 8
     "type-var",  # 2
 ]
 
-[[tool.mypy.overrides]]
-module = "zha.application.platforms.select"
-disable_error_code = [
-    "arg-type",  # 33
-    "override",  # 1
-]
-
-[[tool.mypy.overrides]]
-module = "zha.application.platforms.virtual"
-disable_error_code = [
-    "arg-type",  # 40
-    "no-any-return",  # 1
-]
-
 [[tool.mypy.overrides]]
 module = "zha.application.platforms.climate"
 disable_error_code = [
-    "arg-type",  # 9
     "call-overload",  # 4
     "no-any-return",  # 23
     "no-untyped-def",  # 8
 ]
 
 [[tool.mypy.overrides]]
-module = "zha.application.platforms.switch"
+module = "zha.application.platforms.sensor"
 disable_error_code = [
-    "arg-type",  # 41
-    "no-any-return",  # 1
-    "no-untyped-call",  # 2
-    "override",  # 1
+    "arg-type",  # 10
+    "assignment",  # 3
+    "attr-defined",  # 5
+    "no-any-return",  # 9
+    "no-untyped-call",  # 4
+    "no-untyped-def",  # 3
+    "operator",  # 4
 ]
 
 [[tool.mypy.overrides]]
 module = "zha.zigbee.device"
 disable_error_code = [
     "arg-type",  # 12
-    "assignment",  # 2
     "no-any-return",  # 4
-    "no-untyped-call",  # 4
+    "no-untyped-call",  # 3
     "no-untyped-def",  # 10
     "return-value",  # 1
     "union-attr",  # 18
 ]
-
-[[tool.mypy.overrides]]
-module = "zha.application.platforms.number"
-disable_error_code = [
-    "arg-type",  # 56
-    "no-any-return",  # 2
-    "override",  # 1
-]
-
-[[tool.mypy.overrides]]
-module = "zha.application.platforms.sensor"
-disable_error_code = [
-    "arg-type",  # 88
-    "assignment",  # 1
-    "attr-defined",  # 5
-    "no-any-return",  # 9
-    "no-untyped-call",  # 4
-    "no-untyped-def",  # 3
-    "operator",  # 4
-    "override",  # 3
-]
 # Autogenerated mypy overrides: end
 
 [[tool.mypy.overrides]]
@@ -461,6 +458,7 @@ split-on-trailing-comma = false
 
 # Allow for main entry & scripts to write to stdout
 "script/*" = ["T20"]
+"tools/*" = ["T20"]
 
 [tool.ruff.lint.mccabe]
 max-complexity = 25

tests/common.py

@@ -13,7 +13,6 @@
 
 from zigpy.application import ControllerApplication
 from zigpy.const import SIG_EP_INPUT, SIG_EP_OUTPUT, SIG_EP_PROFILE, SIG_EP_TYPE
-from zigpy.quirks import get_device as quirks_get_device
 import zigpy.types as t
 import zigpy.zcl
 import zigpy.zcl.foundation as zcl_f
@@ -22,6 +21,7 @@
 from zha.application import Platform
 from zha.application.gateway import Gateway
 from zha.application.platforms import BaseEntity, GroupEntity, PlatformEntity
+from zha.quirks import DEVICE_REGISTRY, DeviceRegistry
 from zha.zigbee.device import Device
 from zha.zigbee.group import Group
 
@@ -363,6 +363,7 @@ def zigpy_device_from_device_data(
     device_data: dict,
     patch_cluster: bool = True,
     quirk: Callable | None = None,
+    registry: DeviceRegistry = DEVICE_REGISTRY,
 ) -> zigpy.device.Device:
     """Make a fake device using the specified cluster classes."""
 
@@ -423,7 +424,7 @@ def zigpy_device_from_device_data(
     if quirk:
         device = quirk(app, device.ieee, device.nwk, device)
     else:
-        device = quirks_get_device(device)
+        device = registry.resolve(device)
 
     for epid, ep in device_data["endpoints"].items():
         try:
@@ -557,6 +558,7 @@ def create_mock_zigpy_device(
     patch_cluster: bool = True,
     quirk: Callable | None = None,
     attributes: dict[int, dict[str, dict[str, Any]]] = None,
+    registry: DeviceRegistry = DEVICE_REGISTRY,
 ) -> zigpy.device.Device:
     """Make a fake device using the specified cluster classes."""
     zigpy_app_controller = zha_gateway.application_controller
@@ -601,7 +603,7 @@ def create_mock_zigpy_device(
     if quirk:
         device = quirk(zigpy_app_controller, device.ieee, device.nwk, device)
     else:
-        device = quirks_get_device(device)
+        device = registry.resolve(device)
 
     if patch_cluster:
         for endpoint in (ep for epid, ep in device.endpoints.items() if epid):