ruff check --fix

Author: ArnoutD

plugwise_usb/connection/manager.py

@@ -38,9 +38,24 @@ def __init__(self) -> None:
 
     @property
     def queue_depth(self) -> int:
+        """Calculate and return the current depth of the message queue.
+
+        Returns:
+            int: The number of expected responses that have not yet been processed.
+
+        """
         return self._sender.expected_responses - self._receiver.processed_messages
 
     def correct_received_messages(self, correction: int) -> None:
+        """Adjusts the count of received messages by applying a correction value.
+
+        Args:
+            correction (int): The number to adjust the processed messages count by. Positive values increase the count, negative values decrease it.
+
+        Returns:
+            None
+
+        """
         self._receiver.correct_processed_messages(correction)
 
     @property

plugwise_usb/connection/queue.py

@@ -76,7 +76,6 @@ async def stop(self) -> None:
 
     async def submit(self, request: PlugwiseRequest) -> PlugwiseResponse | None:
         """Add request to queue and return the received node-response when applicable.
-        
         Raises an error when something fails.
         """
         if request.waiting_for_response:

plugwise_usb/connection/sender.py

@@ -48,7 +48,7 @@ def __init__(self, stick_receiver: StickReceiver, transport: Transport) -> None:
     def expected_responses(self) -> int:
         """Return the number of processed messages."""
         return self._expected_responses
-    
+
     async def start(self) -> None:
         """Start the sender."""
         # Subscribe to ACCEPT stick responses, which contain the seq_id we need.

plugwise_usb/helpers/cache.py

@@ -59,7 +59,7 @@ async def initialize_cache(self, create_root_folder: bool = False) -> None:
             cache_dir = self._get_writable_os_dir()
         await makedirs(cache_dir, exist_ok=True)
         self._cache_path = cache_dir
-        
+
         self._cache_file = os_path_join(self._cache_path, self._file_name)
         self._cache_file_exists = await ospath.exists(self._cache_file)
         self._initialized = True

plugwise_usb/messages/properties.py

@@ -391,7 +391,7 @@ def serialize(self) -> bytes:
     def deserialize(self, val: bytes) -> None:
         """Convert data into integer value based on log address formatted data."""
         if val == b"00000000":
-            self._value = int(0)
+            self._value = 0
             return
         Int.deserialize(self, val)
         self._value = (self.value - LOGADDR_OFFSET) // 32

plugwise_usb/messages/requests.py

@@ -1263,7 +1263,7 @@ class CircleMeasureIntervalRequest(PlugwiseRequest):
 
     FIXME: Make sure production interval is a multiply of consumption !!
 
-    Response message: NodeResponse with ack-type POWER_LOG_INTERVAL_ACCEPTED 
+    Response message: NodeResponse with ack-type POWER_LOG_INTERVAL_ACCEPTED
     """
 
     _identifier = b"0057"

plugwise_usb/nodes/circle.py

@@ -5,10 +5,10 @@
 from asyncio import Task, create_task, gather
 from collections.abc import Awaitable, Callable
 from dataclasses import replace
-from math import floor
 from datetime import UTC, datetime
 from functools import wraps
 import logging
+from math import floor
 from typing import Any, TypeVar, cast
 
 from ..api import (
@@ -444,7 +444,7 @@ async def get_missing_energy_logs(self) -> None:
                 "Start with initial energy request for the last 10 log addresses for node %s.",
                 self._mac_in_str,
             )
-            
+
             total_addresses = int(floor(datetime.now(tz=UTC).hour / 4) + 1)
             log_address = self._current_log_address
             while total_addresses > 0:

plugwise_usb/nodes/helpers/pulses.py

@@ -7,7 +7,7 @@
 import logging
 from typing import Final
 
-from ...constants import LOGADDR_MAX, MINUTE_IN_SECONDS, DAY_IN_HOURS
+from ...constants import DAY_IN_HOURS, LOGADDR_MAX, MINUTE_IN_SECONDS
 from ...exceptions import EnergyError
 
 _LOGGER = logging.getLogger(__name__)

plugwise_usb/nodes/helpers/subscription.py

@@ -7,7 +7,6 @@
 from dataclasses import dataclass
 from typing import Any
 
-
 from ...api import NodeFeature
 
 
@@ -21,7 +20,13 @@ class NodeFeatureSubscription:
 
 class FeaturePublisher:
     """Base Class to call awaitable of subscription when event happens."""
+
     def __init__(self) -> None:
+        """Initializes the instance with an empty dictionary to store feature update subscribers.
+
+        The dictionary maps callback functions (Callable[[], None]) to their corresponding
+        NodeFeatureSubscription objects, allowing management of feature update subscriptions.
+        """
         self._feature_update_subscribers: dict[
             Callable[[], None],
             NodeFeatureSubscription,

plugwise_usb/nodes/scan.py

@@ -49,7 +49,7 @@
 
 # Sensitivity values for motion sensor configuration
 SENSITIVITY_HIGH_VALUE = 20  # 0x14
-SENSITIVITY_MEDIUM_VALUE = 30  # 0x1E  
+SENSITIVITY_MEDIUM_VALUE = 30  # 0x1E
 SENSITIVITY_OFF_VALUE = 255  # 0xFF
 
 # endregion

plugwise_usb/nodes/sed.py

@@ -239,7 +239,7 @@ async def set_awake_duration(self, seconds: int) -> bool:
 
         if self._battery_config.awake_duration == seconds:
              return False
- 
+
         self._new_battery_config = replace(
             self._new_battery_config, awake_duration=seconds
         )

pyproject.toml

@@ -258,8 +258,7 @@ lint.select = [
     "S316",  # suspicious-xml-expat-builder-usage
     "S317",  # suspicious-xml-sax-usage
     "S318",  # suspicious-xml-mini-dom-usage
-    "S319",  # suspicious-xml-pull-dom-usage
-    "S320",  # suspicious-xmle-tree-usage
+    "S319",  # suspicious-xml-pull-dom-usag
     "S601",  # paramiko-call
     "S602",  # subprocess-popen-with-shell-equals-true
     "S604",  # call-with-shell-equals-true
@@ -278,15 +277,17 @@ lint.select = [
     "TID251", # Banned imports
     "TRY004", # Prefer TypeError exception for invalid type
     # "TRY200", # TRY200 has been remapped to B904
-    "TRY302", # Remove exception handler; error is immediately re-raised
+    "TRY203", # Remove exception handler; error is immediately re-raised
     "UP",  # pyupgrade
     "W",  # pycodestyle
 ]
 
 lint.ignore = [
     "D202",  # No blank lines allowed after function docstring
     "D203",  # 1 blank line required before class docstring
+    "D205",  # 1 blank line required between summary line and description
     "D213",  # Multi-line docstring summary should start at the second line
+    "D401",  # First line of docstring should be in imperative mood
     "D406",  # Section name should end with a newline
     "D407",  # Section name underlining
     "E501",  # line too long

tests/test_usb.py

@@ -590,7 +590,7 @@ async def test_stick_node_discovered_subscription(
         )
         assert stick.nodes["5555555555555555"].node_info.version == "080007"
         assert stick.nodes["5555555555555555"].node_info.model == "Scan"
-        assert stick.nodes["5555555555555555"].node_info.model_type == None
+        assert stick.nodes["5555555555555555"].node_info.model_type is None
         assert stick.nodes["5555555555555555"].available
         assert stick.nodes["5555555555555555"].node_info.is_battery_powered
         assert sorted(stick.nodes["5555555555555555"].features) == sorted(
@@ -1147,7 +1147,7 @@ def test_pulse_collection_consumption(
         # Collected pulses last day:
         assert tst_consumption.collected_pulses(
             test_timestamp - td(hours=24), is_consumption=True
-        ) == (45 + 22861, pulse_update_4)  
+        ) == (45 + 22861, pulse_update_4)
         # pulse-count of 2500 is ignored, the code does not export this incorrect value
 
         tst_consumption.add_log(100, 2, (fixed_this_hour + td(hours=1)), 2222)
@@ -2572,7 +2572,7 @@ async def test_node_discovery_and_load(
         )
         assert stick.nodes["5555555555555555"].node_info.version == "080007"
         assert stick.nodes["5555555555555555"].node_info.model == "Scan"
-        assert stick.nodes["5555555555555555"].node_info.model_type == None
+        assert stick.nodes["5555555555555555"].node_info.model_type is None
         assert stick.nodes["5555555555555555"].available
         assert stick.nodes["5555555555555555"].node_info.is_battery_powered
         assert sorted(stick.nodes["5555555555555555"].features) == sorted(
@@ -2637,7 +2637,7 @@ async def test_node_discovery_and_load(
         )
         assert stick.nodes["8888888888888888"].node_info.version == "070051"
         assert stick.nodes["8888888888888888"].node_info.model == "Switch"
-        assert stick.nodes["8888888888888888"].node_info.model_type == None
+        assert stick.nodes["8888888888888888"].node_info.model_type is None
         assert stick.nodes["8888888888888888"].available
         assert stick.nodes["8888888888888888"].node_info.is_battery_powered
         assert sorted(stick.nodes["8888888888888888"].features) == sorted(