♻️ Modernize code with Python 3.11 type hints and exception handling

Upgrade codebase with improved type annotations and error handling

This comprehensive refactoring embraces Python 3.11 features:

- Update type hints using modern union syntax (str | None) and collection
types
- Improve exception handling with proper error chaining and more specific
errors
- Replace LRU cache with explicit caching in SignalRGBClient for better
control
- Enhance logging in example code with structured error handling
- Convert assertions to pytest-style in tests for better diagnostics
- Rename SignalRGBException to SignalRGBError for consistency
- Fix command naming in CLI to use explicit names (next_effect vs next)
- Improve error propagation with proper exception context
- Add proper file encoding handling for better compatibility

Author: hyperb1iss

examples/effect_cycler.py

@@ -1,56 +1,54 @@
+import contextlib
+import logging
 import time
 
-from signalrgb.client import SignalRGBClient
+from signalrgb.client import SignalRGBClient, SignalRGBException
+from signalrgb.model import Effect
 
 
-def cycle_effects(client, duration=10):
+def cycle_effects(client: SignalRGBClient, duration: int = 10) -> None:
     """
     Cycle through all available effects, applying each for a specified duration.
 
     Args:
         client (SignalRGBClient): An initialized SignalRGBClient object.
         duration (int): The duration in seconds to apply each effect. Defaults to 10 seconds.
     """
-    print("Fetching available effects...")
     effects = client.get_effects()
 
-    print(f"Found {len(effects)} effects. Starting cycle...")
     for effect in effects:
         effect_name = effect.attributes.name
-        print(f"Applying effect: {effect_name}")
 
         try:
             client.apply_effect_by_name(effect_name)
-            print(
-                f"Effect '{effect_name}' applied successfully. Waiting for {duration} seconds..."
-            )
             time.sleep(duration)
-        except Exception as e:
-            print(f"Error applying effect '{effect_name}': {str(e)}")
+        except SignalRGBException as e:
+            logging.warning("Failed to apply effect %s: %s", effect_name, e)
 
 
-def main():
+def main() -> None:
     # Initialize the SignalRGB client
     client = SignalRGBClient(host="hyperia.home", port=16038)
+    logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s")
+
+    # Initialize initial_effect to None
+    initial_effect: Effect | None = None
 
     try:
         # Get the initial effect
         initial_effect = client.get_current_effect()
-        print(f"Initial effect: {initial_effect.attributes.name}")
 
         # Cycle through effects
         cycle_effects(client, duration=5)  # Change duration as needed
 
-    except Exception as e:
-        print(f"An error occurred: {str(e)}")
+    except SignalRGBException as e:
+        logging.exception("Error during effect cycling: %s", e)
 
     finally:
         # Restore the initial effect
-        try:
-            client.apply_effect_by_name(initial_effect.attributes.name)
-            print(f"Restored initial effect: {initial_effect.attributes.name}")
-        except Exception as e:
-            print(f"Error restoring initial effect: {str(e)}")
+        with contextlib.suppress(SignalRGBException):
+            if initial_effect:
+                client.apply_effect_by_name(initial_effect.attributes.name)
 
 
 if __name__ == "__main__":

pyproject.toml

@@ -3,7 +3,7 @@ name = "signalrgb"
 version = "0.9.7"
 description = "A Python client for SignalRGB"
 readme = "README.md"
-requires-python = ">=3.9"
+requires-python = ">=3.11"
 license = { text = "Apache-2.0" }
 authors = [{ name = "Stefanie Jane", email = "[email protected]" }]
 dependencies = [
@@ -25,6 +25,7 @@ dev = [
     "mkdocstrings[python]>=0.29.0",
     "mypy>=1.15.0",
     "pytest-cov>=6.0.0",
+    "types-requests>=2.31.0.6",
     "types-setuptools>=75.8.2.20250305",
     "semver>=3.0.4",
 ]
@@ -63,7 +64,7 @@ exclude_lines = [
 
 # Type checking configuration
 [tool.mypy]
-python_version = "3.9"
+python_version = "3.11"
 # Basic type checking
 warn_return_any = true
 warn_unused_configs = true
@@ -110,7 +111,7 @@ check_untyped_defs = false
 [tool.ruff]
 # General settings
 line-length = 120
-target-version = "py39"
+target-version = "py311"
 src = ["signalrgb", "tests"]
 extend-exclude = [".venv", "docs"]
 
@@ -241,7 +242,7 @@ docstring-code-line-length = 80
 
 # Pylint configuration - only for things Ruff can't handle
 [tool.pylint]
-py-version = "3.9"
+py-version = "3.11"
 jobs = 2
 max-line-length = 120
 disable = [
@@ -271,6 +272,7 @@ disable = [
     "wrong-import-position",
     "import-outside-toplevel",
     "too-many-positional-arguments",
+    "redefined-builtin", # ConnectionError shadows requests.ConnectionError, it's fine
     "fixme",
 
     # Additional suppressions for practicality