refactor: enable stricter ruff lints and broad exception checking (#956)

Author: allenporter

pyproject.toml

@@ -106,14 +106,40 @@ allowed_tags = [
 major_tags= ["refactor"]
 
 [tool.ruff]
-lint.ignore = ["F403", "E741"]
-lint.select=["E", "F", "UP", "I"]
+lint.ignore = []
+# TODO: Enable ASYNC (flake8-async) in a dedicated follow-up PR once async open() and timeout parameters are refactored.
+lint.select = [
+    "A",
+    "B",
+    "BLE",
+    "C4",
+    "E",
+    "F",
+    "FA",
+    "I",
+    "ICN",
+    "ISC",
+    "PGH",
+    "PIE",
+    "UP",
+    "W",
+    "YTT",
+]
 line-length = 120
 extend-exclude = ["roborock/map/proto/*_pb2.py"]
 
 [tool.ruff.lint.per-file-ignores]
 "*/__init__.py" = ["F401"]
+"roborock/__init__.py" = ["F403"]
+"roborock/data/__init__.py" = ["F403"]
+"roborock/data/b01_q7/__init__.py" = ["F403"]
+"roborock/data/b01_q10/__init__.py" = ["F403"]
+"roborock/data/dyad/__init__.py" = ["F403"]
+"roborock/data/mower/__init__.py" = ["F403"]
+"roborock/data/v1/__init__.py" = ["F403"]
+"roborock/data/zeo/__init__.py" = ["F403"]
 "roborock/map/proto/*_pb2.py" = ["E501", "I001", "UP009"]
+"tests/*" = ["B010"]
 
 [[tool.mypy.overrides]]
 module = ["roborock.map.proto.*"]

roborock/broadcast_protocol.py

@@ -4,7 +4,7 @@
 import logging
 from asyncio import BaseTransport, Lock
 
-from construct import (  # type: ignore
+from construct import (  # type: ignore[import-untyped]
     Bytes,
     Checksum,
     GreedyBytes,
@@ -63,7 +63,7 @@ def datagram_received(self, data: bytes, _):
                     parsed_message = BroadcastMessage(duid=json_payload["duid"], ip=json_payload["ip"], version=version)
                     _LOGGER.debug(f"Received broadcast: {parsed_message}")
                     self.devices_found.append(parsed_message)
-        except Exception as e:
+        except Exception as e:  # noqa: BLE001
             _LOGGER.warning(f"Failed to decode message: {data!r}. Error: {e}")
 
     async def discover(self) -> list[BroadcastMessage]:

roborock/cli.py

@@ -22,6 +22,8 @@
 ```
 """
 
+# ruff: noqa: BLE001
+
 import asyncio
 import datetime
 import functools
@@ -38,9 +40,9 @@
     import click
     import click_shell
     import yaml
-    from pyshark import FileCapture  # type: ignore
-    from pyshark.capture.live_capture import LiveCapture, UnknownInterfaceException  # type: ignore
-    from pyshark.packet.packet import Packet  # type: ignore
+    from pyshark import FileCapture  # type: ignore[import-untyped]
+    from pyshark.capture.live_capture import LiveCapture, UnknownInterfaceException  # type: ignore[import-untyped]
+    from pyshark.packet.packet import Packet  # type: ignore[import-untyped]
 except ImportError as err:
     raise SystemExit(
         f"The 'roborock' command line tool requires extra dependencies that are not installed ({err.name}).\n"
@@ -307,7 +309,7 @@ async def set(self, value: CacheData) -> None:
 @click.pass_context
 def cli(ctx, debug: int):
     logging_config: dict[str, Any] = {"level": logging.DEBUG if debug > 0 else logging.INFO}
-    logging.basicConfig(**logging_config)  # type: ignore
+    logging.basicConfig(**logging_config)  # type: ignore[call-overload]
     ctx.obj = RoborockContext()
 
 
@@ -988,26 +990,24 @@ def on_package(packet: Packet):
                                     local_key,
                                 )
                                 print(f"Received request: {f}")
-                            except BaseException as e:
+                            except Exception as e:
                                 print(e)
-                                pass
                         elif packet.ip.src == device_ip:
                             try:
                                 f, buffer["data"] = MessageParser.parse(
                                     buffer["data"] + bytes.fromhex(packet.DATA.data),
                                     local_key,
                                 )
                                 print(f"Received response: {f}")
-                            except BaseException as e:
+                            except Exception as e:
                                 print(e)
-                                pass
 
     try:
         await capture.packets_from_tshark(on_package, close_tshark=not file_provided)
-    except UnknownInterfaceException:
+    except UnknownInterfaceException as err:
         raise RoborockException(
             "You need to run 'rvictl -s XXXXXXXX-XXXXXXXXXXXXXXXX' first, with an iPhone connected to usb port"
-        )
+        ) from err
 
 
 def _parse_diagnostic_file(diagnostic_path: Path) -> dict[str, dict[str, Any]]:
@@ -1319,7 +1319,7 @@ def write_markdown_table(product_features: dict[str, dict[str, any]], all_featur
         ]
         # Regular features are the remaining keys, sorted alphabetically
         # We filter out the special rows to avoid duplicating them.
-        sorted_features = sorted(list(all_features - set(special_rows)))
+        sorted_features = sorted(all_features - set(special_rows))
 
         header = ["Feature"] + sorted_products
 

roborock/data/code_mappings.py

@@ -33,7 +33,7 @@ def _missing_(cls: type[Self], key) -> Self:
             if warning not in completed_warnings:
                 completed_warnings.add(warning)
                 _LOGGER.warning(warning)
-            return cls.unknown  # type: ignore
+            return cls.unknown  # type: ignore[attr-defined]
         default_value = next(item for item in cls)
         warning = f"Missing {cls.__name__} code: {key} - defaulting to {default_value}"
         if warning not in completed_warnings:

roborock/data/containers.py

@@ -52,7 +52,7 @@ def _attr_repr(obj: Any) -> str:
             continue
         try:
             v = getattr(obj, k)
-        except (RuntimeError, Exception):
+        except Exception:  # noqa: BLE001
             continue
         if callable(v):
             continue
@@ -210,7 +210,7 @@ class Reference(RoborockBase):
     r: str | None = None
     a: str | None = None
     m: str | None = None
-    l: str | None = None
+    l: str | None = None  # noqa: E741
 
 
 @dataclass
@@ -379,9 +379,9 @@ class HomeDataSchedule(RoborockBase):
 class HomeData(RoborockBase):
     id: int
     name: str
-    products: list[HomeDataProduct] = field(default_factory=lambda: [])
-    devices: list[HomeDataDevice] = field(default_factory=lambda: [])
-    received_devices: list[HomeDataDevice] = field(default_factory=lambda: [])
+    products: list[HomeDataProduct] = field(default_factory=list)
+    devices: list[HomeDataDevice] = field(default_factory=list)
+    received_devices: list[HomeDataDevice] = field(default_factory=list)
     lon: Any | None = None
     lat: Any | None = None
     geo_name: Any | None = None

roborock/data/v1/v1_code_mappings.py

@@ -151,7 +151,7 @@ class RoborockDssCodes(RoborockEnum):
     def _missing_(cls: type[Self], key) -> Self:
         # If the calculated value is not provided, then it should be viewed as okay.
         # As the math will sometimes result in you getting numbers that don't matter.
-        return cls.okay  # type: ignore
+        return cls.okay  # type: ignore[attr-defined]
 
 
 class ClearWaterBoxStatus(RoborockDssCodes):

roborock/device_features.py

@@ -643,7 +643,7 @@ def from_feature_flags(
             elif (product_features := f.metadata.get("product_features")) is not None:
                 if product_nickname is not None:
                     available_features = PRODUCT_FEATURE_MAP.get(product_nickname, [])
-                    if any(feat in available_features for feat in product_features):  # type: ignore
+                    if any(feat in available_features for feat in product_features):
                         kwargs[f.name] = True
 
         # The app combines runtime shake-mop, model shake/spin, and roller-mop

roborock/devices/rpc/b01_q7_channel.py

@@ -84,7 +84,7 @@ def on_message(response_message: RoborockMessage) -> None:
             return
         try:
             response = response_matcher(response_message)
-        except Exception as ex:
+        except Exception as ex:  # noqa: BLE001
             future.set_exception(ex)
             return
         if response is not None:

roborock/devices/traits/__init__.py

@@ -24,5 +24,5 @@
 ]
 
 
-class Trait(ABC):
+class Trait(ABC):  # noqa: B024
     """Base class for all traits."""

roborock/devices/traits/v1/clean_summary.py

@@ -56,7 +56,7 @@ def convert(self, response: common.V1ResponseData) -> CleanRecord:
                             rec.square_meter_area or 0
                         )
                     return final_record
-                except Exception:
+                except Exception:  # noqa: BLE001
                     # Return final record when an exception occurred
                     return final_record
             # There are still a few unknown variables in this.