mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-10-04 06:15:09 +00:00
* ci: mypy ratchet -- keep type-clean modules clean mypy-clean.txt lists the 71 modules under src/ that type-check clean; scripts/check_types.py runs mypy (--follow-imports=silent) on exactly those files and fails on any error or a missing/unsorted/duplicate entry. A new "Type check (mypy ratchet)" CI job runs it with mypy 1.20.2 and pinned stubs; the manual pre-commit mypy hook now runs the same script (a local hook, so mypy sees the installed requirements like CI does). 35 modules were made clean with annotation-only fixes: hints, typing.cast, TYPE_CHECKING imports, implicit-Optional defaults made explicit, and annotations widened (never guards removed) where mypy called a defensive isinstance check unreachable. No runtime behaviour change. mypy.ini: numpy and orjson are treated as Any (follow_imports=skip, also for stubs). numpy 2.3+ stubs use 3.12 `type` statements that mypy won't parse at python_version 3.10, and orjson is optional, so seeing its stubs made the result depend on whether it was installed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * chore: annotate check_types.py's list-form mypy subprocess Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
122 lines
4.1 KiB
Python
122 lines
4.1 KiB
Python
"""
|
|
Custom exception hierarchy for LEDMatrix.
|
|
|
|
Provides specific exception types for different error categories,
|
|
enabling better error handling and debugging.
|
|
"""
|
|
|
|
from typing import Optional
|
|
|
|
|
|
class LEDMatrixError(Exception):
|
|
"""Base exception for all LEDMatrix errors."""
|
|
|
|
def __init__(self, message: str, context: Optional[dict] = None):
|
|
"""
|
|
Initialize the exception.
|
|
|
|
Args:
|
|
message: Error message
|
|
context: Optional context dictionary with additional error details
|
|
"""
|
|
super().__init__(message)
|
|
self.message = message
|
|
self.context = context or {}
|
|
|
|
def __str__(self) -> str:
|
|
"""Return formatted error message with context."""
|
|
if self.context:
|
|
context_str = ", ".join(f"{k}={v}" for k, v in self.context.items())
|
|
return f"{self.message} ({context_str})"
|
|
return self.message
|
|
|
|
|
|
class CacheError(LEDMatrixError):
|
|
"""Exception raised for cache-related errors."""
|
|
|
|
def __init__(self, message: str, cache_key: Optional[str] = None, context: Optional[dict] = None):
|
|
"""
|
|
Initialize cache error.
|
|
|
|
Args:
|
|
message: Error message
|
|
cache_key: Optional cache key that caused the error
|
|
context: Optional context dictionary
|
|
"""
|
|
if cache_key:
|
|
# Copy so the caller's dict isn't mutated (a reused context
|
|
# dict would otherwise collect every error's keys).
|
|
context = dict(context or {})
|
|
context['cache_key'] = cache_key
|
|
super().__init__(message, context)
|
|
self.cache_key = cache_key
|
|
|
|
|
|
class ConfigError(LEDMatrixError):
|
|
"""Exception raised for configuration-related errors."""
|
|
|
|
def __init__(self, message: str, config_path: Optional[str] = None, field: Optional[str] = None, context: Optional[dict] = None):
|
|
"""
|
|
Initialize config error.
|
|
|
|
Args:
|
|
message: Error message
|
|
config_path: Optional path to config file
|
|
field: Optional field name that caused the error
|
|
context: Optional context dictionary
|
|
"""
|
|
if config_path or field:
|
|
# Copy so the caller's dict isn't mutated (a reused context
|
|
# dict would otherwise collect every error's keys).
|
|
context = dict(context or {})
|
|
if config_path:
|
|
context['config_path'] = config_path
|
|
if field:
|
|
context['field'] = field
|
|
super().__init__(message, context)
|
|
self.config_path = config_path
|
|
self.field = field
|
|
|
|
|
|
class PluginError(LEDMatrixError):
|
|
"""Exception raised for plugin-related errors."""
|
|
|
|
def __init__(self, message: str, plugin_id: Optional[str] = None, context: Optional[dict] = None):
|
|
"""
|
|
Initialize plugin error.
|
|
|
|
Args:
|
|
message: Error message
|
|
plugin_id: Optional plugin ID that caused the error
|
|
context: Optional context dictionary
|
|
"""
|
|
if plugin_id:
|
|
# Copy so the caller's dict isn't mutated (a reused context
|
|
# dict would otherwise collect every error's keys).
|
|
context = dict(context or {})
|
|
context['plugin_id'] = plugin_id
|
|
super().__init__(message, context)
|
|
self.plugin_id = plugin_id
|
|
|
|
|
|
class DisplayError(LEDMatrixError):
|
|
"""Exception raised for display-related errors."""
|
|
|
|
def __init__(self, message: str, display_mode: Optional[str] = None, context: Optional[dict] = None):
|
|
"""
|
|
Initialize display error.
|
|
|
|
Args:
|
|
message: Error message
|
|
display_mode: Optional display mode that caused the error
|
|
context: Optional context dictionary
|
|
"""
|
|
if display_mode:
|
|
# Copy so the caller's dict isn't mutated (a reused context
|
|
# dict would otherwise collect every error's keys).
|
|
context = dict(context or {})
|
|
context['display_mode'] = display_mode
|
|
super().__init__(message, context)
|
|
self.display_mode = display_mode
|
|
|