Refactor enums to use UnknownEnumMixin for consistent handling and improve module imports

Author: iMicknl

pyoverkiz/enums/__init__.py

@@ -2,12 +2,42 @@
 
 # flake8: noqa: F403
 
-from .command import *
-from .execution import *
-from .gateway import *
-from .general import *
-from .measured_value_type import *
-from .protocol import *
-from .server import *
-from .state import *
-from .ui import *
+from enum import Enum
+
+from pyoverkiz.enums import command as _command
+from pyoverkiz.enums import execution as _execution
+from pyoverkiz.enums import gateway as _gateway
+from pyoverkiz.enums import general as _general
+from pyoverkiz.enums import measured_value_type as _measured_value_type
+from pyoverkiz.enums import protocol as _protocol
+from pyoverkiz.enums import server as _server
+from pyoverkiz.enums import state as _state
+from pyoverkiz.enums import ui as _ui
+from pyoverkiz.enums.command import *
+from pyoverkiz.enums.execution import *
+from pyoverkiz.enums.gateway import *
+from pyoverkiz.enums.general import *
+from pyoverkiz.enums.measured_value_type import *
+from pyoverkiz.enums.protocol import *
+from pyoverkiz.enums.server import *
+from pyoverkiz.enums.state import *
+from pyoverkiz.enums.ui import *
+
+__all__ = sorted(
+    {
+        name
+        for module in (
+            _command,
+            _execution,
+            _gateway,
+            _general,
+            _measured_value_type,
+            _protocol,
+            _server,
+            _state,
+            _ui,
+        )
+        for name, obj in vars(module).items()
+        if isinstance(obj, type) and issubclass(obj, Enum)
+    }
+)

pyoverkiz/enums/gateway.py

@@ -1,13 +1,12 @@
 """Enums for gateway types and related helpers."""
 
-import logging
 from enum import IntEnum, StrEnum, unique
 
-_LOGGER = logging.getLogger(__name__)
+from pyoverkiz.enums.base import UnknownEnumMixin
 
 
 @unique
-class GatewayType(IntEnum):
+class GatewayType(UnknownEnumMixin, IntEnum):
     """Enumeration of known gateway types returned by Overkiz."""
 
     UNKNOWN = -1
@@ -63,11 +62,6 @@ class GatewayType(IntEnum):
     TAHOMA_SWITCH_CH = 126
     TAHOMA_SWITCH_SC = 128
 
-    @classmethod
-    def _missing_(cls, value):  # type: ignore
-        _LOGGER.warning(f"Unsupported value {value} has been returned for {cls}")
-        return cls.UNKNOWN
-
     @property
     def beautify_name(self) -> str:
         """Return a human friendly name for the gateway type."""
@@ -78,7 +72,7 @@ def beautify_name(self) -> str:
 
 
 @unique
-class GatewaySubType(IntEnum):
+class GatewaySubType(UnknownEnumMixin, IntEnum):
     """Sub-type enumeration for gateways to identify specific models/variants."""
 
     UNKNOWN = -1
@@ -100,11 +94,6 @@ class GatewaySubType(IntEnum):
     TAHOMA_SECURITY_PRO = 16
     # TAHOMA_BOX_C_IO = 12  # Note: This is likely 17, but tahomalink.com lists it as 12
 
-    @classmethod
-    def _missing_(cls, value):  # type: ignore
-        _LOGGER.warning(f"Unsupported value {value} has been returned for {cls}")
-        return cls.UNKNOWN
-
     @property
     def beautify_name(self) -> str:
         """Return a human friendly name for the gateway sub-type."""

pyoverkiz/enums/general.py

@@ -3,10 +3,9 @@
 # ruff: noqa: S105
 # Enum values contain "TOKEN" in API event names, not passwords
 
-import logging
 from enum import IntEnum, StrEnum, unique
 
-_LOGGER = logging.getLogger(__name__)
+from pyoverkiz.enums.base import UnknownEnumMixin
 
 
 @unique
@@ -40,7 +39,7 @@ class DataType(IntEnum):
 
 
 @unique
-class FailureType(IntEnum):
+class FailureType(UnknownEnumMixin, IntEnum):
     """Failure type codes returned by the API."""
 
     UNKNOWN = -1
@@ -248,14 +247,8 @@ class FailureType(IntEnum):
     TIME_OUT_ON_COMMAND_PROGRESS = 20003
     DEVICE_NO_ANSWER = 60004
 
-    @classmethod
-    def _missing_(cls, value):  # type: ignore
-        _LOGGER.warning(f"Unsupported value {value} has been returned for {cls}")
-        return cls.UNKNOWN
-
-
 @unique
-class EventName(StrEnum):
+class EventName(UnknownEnumMixin, StrEnum):
     """Enumeration of event names emitted by Overkiz."""
 
     UNKNOWN = "Unknown"

pyoverkiz/enums/ui.py

@@ -3,14 +3,13 @@
 # ruff: noqa: S105
 # Enum values contain "PASS" in API names (e.g. PassAPC), not passwords
 
-import logging
 from enum import StrEnum, unique
 
-_LOGGER = logging.getLogger(__name__)
+from pyoverkiz.enums.base import UnknownEnumMixin
 
 
 @unique
-class UIClass(StrEnum):
+class UIClass(UnknownEnumMixin, StrEnum):
     """Enumeration of UI classes used to describe device categories and behaviors."""
 
     # A list of all defined UI classes from /reference/ui/classes
@@ -84,14 +83,8 @@ class UIClass(StrEnum):
 
     UNKNOWN = "unknown"
 
-    @classmethod
-    def _missing_(cls, value):  # type: ignore
-        _LOGGER.warning(f"Unsupported value {value} has been returned for {cls}")
-        return cls.UNKNOWN
-
-
 @unique
-class UIWidget(StrEnum):
+class UIWidget(UnknownEnumMixin, StrEnum):
     """Enumeration of UI widgets used by Overkiz for device presentation."""
 
     # A list of all defined UI widgets from /reference/ui/widgets