.

Author: spacemanspiff2007

.ruff.toml

@@ -102,4 +102,15 @@ lines-after-imports = 2     # https://docs.astral.sh/ruff/settings/#lint_isort_l
 
     # https://docs.astral.sh/ruff/rules/#flake8-boolean-trap-fbt
     "FBT003",  # Boolean positional value in function call
+
+    # https://docs.astral.sh/ruff/rules/#flake8-unused-arguments-arg
+    "ARG001",  # Unused function argument {name}
+    "ARG002",  # Unused method argument {name}
+    "ARG003",  # Unused class method argument: {name}
+    "ARG004",  # Unused static method argument: {name}
+    "ARG005",  # Unused lambda argument: {name}
+]
+
+"src/pyartnet/*" = [
+    "PLR2004"   # Magic value used in comparison, consider replacing `0.01` with a constant variable
 ]

src/pyartnet/base/background_task.py

@@ -30,15 +30,16 @@ def __init__(self, coro: Callable[[], Coroutine], name: str) -> None:
         self.name: Final = name
         self.task: Task | None = None
 
-    def start(self):
+    def start(self) -> None:
         if self.task is not None:
             return None
 
         self.task = task = CREATE_TASK(self.coro_wrap(), name=self.name)
         _BACKGROUND_TASKS.add(task)
         task.add_done_callback(_BACKGROUND_TASKS.discard)
+        return None
 
-    def cancel(self):
+    def cancel(self) -> None:
         if self.task is None:
             return None
 

src/pyartnet/base/channel.py

@@ -3,11 +3,14 @@
 import logging
 import warnings
 from array import array
-from collections.abc import Callable, Collection
 from logging import DEBUG as LVL_DEBUG
 from math import ceil
-from typing import TYPE_CHECKING, Any, Final, Literal, Union
+from typing import TYPE_CHECKING, Any, Final, Generator, Literal
 
+from typing_extensions import Self
+
+from pyartnet.base.channel_fade import ChannelBoundFade
+from pyartnet.base.output_correction import OutputCorrection
 from pyartnet.errors import (
     ChannelOutOfUniverseError,
     ChannelValueOutOfBoundsError,
@@ -17,11 +20,10 @@
 from pyartnet.fades import FadeBase, LinearFade
 from pyartnet.output_correction import linear
 
-from .channel_fade import ChannelBoundFade
-from .output_correction import OutputCorrection
-
 
 if TYPE_CHECKING:
+    from collections.abc import Callable, Collection
+
     from .universe import BaseUniverse
 
 
@@ -93,7 +95,7 @@ def __init__(self, universe: BaseUniverse,
         # Callbacks
         self.callback_fade_finished: Callable[[Channel], Any] | None = None
 
-    def _apply_output_correction(self):
+    def _apply_output_correction(self) -> None:
         # default correction is linear
         self._correction_current = linear
 
@@ -102,6 +104,7 @@ def _apply_output_correction(self):
             if obj._correction_output is not None:
                 self._correction_current = obj._correction_output
                 return None
+        return None
 
     def get_values(self) -> list[int]:
         """Get the current (uncorrected) channel values
@@ -110,7 +113,7 @@ def get_values(self) -> list[int]:
         """
         return self._values_raw.tolist()
 
-    def set_values(self, values: Collection[Union[int, float]]):
+    def set_values(self, values: Collection[int | float]) -> Self:
         """Set values for a channel without a fade
 
         :param values: Iterable of values with the same size as the channel width
@@ -141,7 +144,7 @@ def set_values(self, values: Collection[Union[int, float]]):
             self._parent_universe.channel_changed(self)
         return self
 
-    def to_buffer(self, buf: bytearray):
+    def to_buffer(self, buf: bytearray) -> Self:
         byte_order = self._byte_order
         byte_size = self._byte_size
 
@@ -151,15 +154,17 @@ def to_buffer(self, buf: bytearray):
             start += byte_size
         return self
 
-    def add_fade(self, values: Collection[Union[int, FadeBase]], duration_ms: int,
-                 fade_class: type[FadeBase] = LinearFade):
+    def add_fade(self, values: Collection[int | FadeBase], duration_ms: int,
+                 fade_class: type[FadeBase] = LinearFade) -> Self:
         warnings.warn(
-            f'{self.set_fade.__name__:s} is deprecated, use {self.set_fade.__name__:s} instead', DeprecationWarning)
+            f'{self.set_fade.__name__:s} is deprecated, use {self.set_fade.__name__:s} instead',
+            DeprecationWarning, stacklevel=2
+        )
         return self.set_fade(values, duration_ms, fade_class)
 
     # noinspection PyProtectedMember
-    def set_fade(self, values: Collection[Union[int, FadeBase]], duration_ms: int,
-                 fade_class: type[FadeBase] = LinearFade):
+    def set_fade(self, values: Collection[int | FadeBase], duration_ms: int,
+                 fade_class: type[FadeBase] = LinearFade) -> Self:
         """Add and schedule a new fade for the channel
 
         :param values: Target values for the fade
@@ -207,7 +212,7 @@ def set_fade(self, values: Collection[Union[int, FadeBase]], duration_ms: int,
                 log.debug(f'CH {self._start + i}: {fade.debug_initialize():s}')
         return self
 
-    def __await__(self):
+    def __await__(self) -> Generator[None, None, bool]:
         if self._current_fade is None:
             return False
         yield from self._current_fade.event.wait().__await__()

src/pyartnet/fades/fade_base.py

@@ -4,7 +4,7 @@ class FadeBase:
     def __init__(self) -> None:
         self.is_done = False
 
-    def initialize(self, current: int, target: int, steps: int):
+    def initialize(self, current: int, target: int, steps: int) -> None:
         raise NotImplementedError()
 
     def debug_initialize(self) -> str:

src/pyartnet/fades/fade_linear.py

@@ -1,3 +1,5 @@
+from typing_extensions import override
+
 from .fade_base import FadeBase
 
 
@@ -9,14 +11,17 @@ def __init__(self) -> None:
         self.current: float = 0.0       # Current Value
         self.factor: float = 1.0
 
+    @override
     def debug_initialize(self) -> str:
         return f'{self.current:03.0f} -> {self.target:03d} | step: {self.factor:+5.1f}'
 
+    @override
     def initialize(self, start: int, target: int, steps: int) -> None:
         self.current = start
         self.target = target
         self.factor = (self.target - start) / steps
 
+    @override
     def calc_next_value(self) -> float:
         self.current += self.factor
 

src/pyartnet/output_correction.py

@@ -1,4 +1,4 @@
-def linear(val: float, max_val: int = 0xFF) -> float:
+def linear(val: float, max_val: int = 0xFF) -> float:  # noqa: ARG001
     """linear output correction"""
     return val
 

tests/channel/test_boundaries.py

@@ -50,7 +50,7 @@ def get_node_universe_mock():
     ((1, 1, -1, 255), (1, 1, 256, 255), (3, 1, 256, 255),
      (1, 2, -1, 65535), (1, 2, 65536, 65535), (3, 2, 65536, 65535), ))
 def test_set_invalid(width, byte_size, invalid, valid) -> None:
-    node, universe = get_node_universe_mock()
+    _, universe = get_node_universe_mock()
 
     invalid_values = [0] * (width - 1) + [invalid]
     valid_values = [0] * (width - 1) + [valid]
@@ -71,7 +71,7 @@ def test_set_invalid(width, byte_size, invalid, valid) -> None:
 
 
 async def test_set_missing() -> None:
-    node, universe = get_node_universe_mock()
+    _, universe = get_node_universe_mock()
 
     c = Channel(universe, 1, 1)
     with pytest.raises(ValueCountDoesNotMatchChannelWidthError) as e:

tests/conftest.py

@@ -55,13 +55,12 @@ def test_patched_socket(patched_socket) -> None:
     assert node._socket.sendto is patched_socket
 
 
-@pytest.fixture()
+@pytest.fixture
 def node():
-    node = TestingNode('IP', 9999)
-    return node
+    return TestingNode('IP', 9999)
 
 
-@pytest.fixture()
+@pytest.fixture
 def universe(node: BaseNode):
     return node.add_universe()