Merge pull request #38 from maresb/fix-permissions-instructions

Fix permissions instructions

Author: maresb

src/labelle/lib/devices/usb_device.py

@@ -2,7 +2,8 @@
 
 import logging
 import platform
-from typing import NoReturn
+from textwrap import dedent
+from typing import Any, NoReturn
 
 import usb
 
@@ -35,59 +36,57 @@ def __init__(self, dev: usb.core.Device) -> None:
         self._devout = None
 
     @property
-    def hash(self):
-        try:
-            return (
-                f"<{self._dev.manufacturer}|{self._dev.product}"
-                f"|{self._dev.serial_number}>"
-            )
-        except (ValueError, usb.core.USBError):
-            return None
+    def hash(self) -> str:
+        return self.usb_id
 
-    def _get_dev_attribute(self, attr):
+    def _get_dev_attribute(self, attr: str) -> Any:
         try:
             return getattr(self._dev, attr)
         except (ValueError, usb.core.USBError):
             return None
 
     @property
-    def manufacturer(self):
+    def manufacturer(self) -> str | None:
         return self._get_dev_attribute("manufacturer")
 
     @property
-    def product(self):
+    def product(self) -> str | None:
         return self._get_dev_attribute("product")
 
     @property
-    def serial_number(self):
+    def serial_number(self) -> str | None:
         return self._get_dev_attribute("serial_number")
 
     @property
-    def id_vendor(self):
-        return self._get_dev_attribute("idVendor")
+    def id_vendor(self) -> int:
+        id_ = self._get_dev_attribute("idVendor")
+        if id_ is None:
+            raise UsbDeviceError("Could not get idVendor")
+        return id_
 
     @property
-    def id_product(self):
-        return self._get_dev_attribute("idProduct")
+    def id_product(self) -> int:
+        id_ = self._get_dev_attribute("idProduct")
+        if id_ is None:
+            raise UsbDeviceError("Could not get idProduct")
+        return id_
 
     @property
-    def vendor_product_id(self):
-        vendor_id = int(self.id_vendor)
-        product_id = int(self.id_product)
-        return f"{vendor_id:04x}:{product_id:04x}"
+    def vendor_product_id(self) -> str:
+        return f"{self.id_vendor:04x}:{self.id_product:04x}"
 
     @property
-    def usb_id(self):
+    def usb_id(self) -> str:
         bus = self._get_dev_attribute("bus")
         address = self._get_dev_attribute("address")
         return f"Bus {bus:03} Device {address:03}: ID {self.vendor_product_id}"
 
     @staticmethod
-    def _is_supported_vendor(dev: usb.core.Device):
+    def _is_supported_vendor(dev: usb.core.Device) -> bool:
         return dev.idVendor == DEV_VENDOR
 
     @property
-    def is_supported(self):
+    def is_supported(self) -> bool:
         return (
             self._is_supported_vendor(self._dev)
             and self.id_product in SUPPORTED_PRODUCTS
@@ -165,26 +164,28 @@ def _instruct_on_access_denied_linux(self) -> NoReturn:
         # else:
         #     restart_udev_command = None
 
-        udev_rule = ", ".join(
+        udev_rule = ",'\\\n                     '".join(
             [
                 'ACTION=="add"',
                 'SUBSYSTEMS=="usb"',
-                f'ATTRS{{idVendor}}=="{self._dev.idVendor:04x}"',
-                f'ATTRS{{idProduct}}=="{self._dev.idProduct:04x}"',
+                f'ATTRS{{idVendor}}=="{self.id_vendor:04x}"',
+                f'ATTRS{{idProduct}}=="{self.id_product:04x}"',
                 'MODE="0666"',
             ]
         )
 
         msg = f"""
+
             You do not have sufficient access to the device. You probably want to add the a udev
             rule in /etc/udev/rules.d with the following command:
 
-            echo '{udev_rule}' | sudo tee /etc/udev/rules.d/91-labelle-{self._dev.idProduct:x}.rules
+                echo '{udev_rule}' \\
+                  | sudo tee /etc/udev/rules.d/91-labelle-{self.id_vendor:04x}-{self.id_product:04x}.rules
 
             Next, refresh udev with:
 
-            sudo udevadm control --reload-rules
-            sudo udevadm trigger --attr-match=idVendor="0922"
+                sudo udevadm control --reload-rules
+                sudo udevadm trigger --attr-match=idVendor="0922"
 
             Finally, turn your device off and back on again to activate the new permissions.
 
@@ -194,8 +195,8 @@ def _instruct_on_access_denied_linux(self) -> NoReturn:
             In case you still cannot connect, or if you have any information or ideas, please
             post them at that link.
         """  # noqa: E501
-        LOG.error(msg)
-        raise UsbDeviceError("Insufficient access to the device")
+        msg = dedent(msg)
+        raise UsbDeviceError(msg)
 
     def _set_configuration(self) -> None:
         try:
@@ -282,9 +283,9 @@ def is_match(self, patterns: list[str] | None) -> bool:
         for pattern in patterns:
             pattern = pattern.lower()
             match &= (
-                pattern in self.manufacturer.lower()
-                or pattern in self.product.lower()
-                or pattern in self.serial_number.lower()
+                pattern in (self.manufacturer or "").lower()
+                or pattern in (self.product or "").lower()
+                or pattern in (self.serial_number or "").lower()
             )
         return match