Unify imports in logitech package

Related #2273

lib/logitech_receiver/common.py

@@ -14,16 +14,16 @@
 ## You should have received a copy of the GNU General Public License along
 ## with this program; if not, write to the Free Software Foundation, Inc.,
 ## 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+from __future__ import annotations
 
-# Some common functions and types.
+import binascii
+import dataclasses
 
-from binascii import hexlify as _hexlify
 from collections import namedtuple
-from dataclasses import dataclass
 from typing import Optional
 from typing import Union
 
-import yaml as _yaml
+import yaml
 
 from solaar.i18n import _
 
@@ -357,8 +357,8 @@ def to_yaml(cls, dumper, data):
         return dumper.represent_mapping("!NamedInt", {"value": int(data), "name": data.name}, flow_style=True)
 
 
-_yaml.SafeLoader.add_constructor("!NamedInt", NamedInt.from_yaml)
-_yaml.add_representer(NamedInt, NamedInt.to_yaml)
+yaml.SafeLoader.add_constructor("!NamedInt", NamedInt.from_yaml)
+yaml.add_representer(NamedInt, NamedInt.to_yaml)
 
 
 class NamedInts:
@@ -521,7 +521,7 @@ def __or__(self, other):
 def strhex(x):
     assert x is not None
     """Produce a hex-string representation of a sequence of bytes."""
-    return _hexlify(x).decode("ascii").upper()
+    return binascii.hexlify(x).decode("ascii").upper()
 
 
 def bytes2int(x, signed=False):
@@ -554,7 +554,7 @@ def __getattr__(self, k):
 FirmwareInfo = namedtuple("FirmwareInfo", ["kind", "name", "version", "extras"])
 
 
-@dataclass
+@dataclasses.dataclass
 class Battery:
     """Information about the current state of a battery"""
 

lib/logitech_receiver/descriptors.py

@@ -22,12 +22,8 @@
 # - the device uses a USB interface other than 2
 # - the name or codename should be different from what the device reports
 
-from .hidpp10_constants import DEVICE_KIND as _DK
-from .hidpp10_constants import REGISTERS as _R
-
-#
-#
-#
+from .hidpp10_constants import DEVICE_KIND
+from .hidpp10_constants import REGISTERS as REG
 
 
 class _DeviceDescriptor:
@@ -73,15 +69,15 @@ def _D(
 ):
     if kind is None:
         kind = (
-            _DK.mouse
+            DEVICE_KIND.mouse
             if "Mouse" in name
-            else _DK.keyboard
+            else DEVICE_KIND.keyboard
             if "Keyboard" in name
-            else _DK.numpad
+            else DEVICE_KIND.numpad
             if "Number Pad" in name
-            else _DK.touchpad
+            else DEVICE_KIND.touchpad
             if "Touchpad" in name
-            else _DK.trackball
+            else DEVICE_KIND.trackball
             if "Trackball" in name
             else None
         )
@@ -94,9 +90,12 @@ def _D(
                     assert w[0:1] == "4", f"{name} has protocol {protocol:0.1f}, wpid {w}"
                 else:
                     if w[0:1] == "1":
-                        assert kind == _DK.mouse, f"{name} has protocol {protocol:0.1f}, wpid {w}"
+                        assert kind == DEVICE_KIND.mouse, f"{name} has protocol {protocol:0.1f}, wpid {w}"
                     elif w[0:1] == "2":
-                        assert kind in (_DK.keyboard, _DK.numpad), f"{name} has protocol {protocol:0.1f}, wpid {w}"
+                        assert kind in (
+                            DEVICE_KIND.keyboard,
+                            DEVICE_KIND.numpad,
+                        ), f"{name} has protocol {protocol:0.1f}, wpid {w}"
 
     device_descriptor = _DeviceDescriptor(
         name=name,
@@ -192,24 +191,24 @@ def get_btid(btid):
 
 # Keyboards
 
-_D("Wireless Keyboard EX110", codename="EX110", protocol=1.0, wpid="0055", registers=(_R.battery_status,))
-_D("Wireless Keyboard S510", codename="S510", protocol=1.0, wpid="0056", registers=(_R.battery_status,))
-_D("Wireless Wave Keyboard K550", codename="K550", protocol=1.0, wpid="0060", registers=(_R.battery_status,))
-_D("Wireless Keyboard EX100", codename="EX100", protocol=1.0, wpid="0065", registers=(_R.battery_status,))
-_D("Wireless Keyboard MK300", codename="MK300", protocol=1.0, wpid="0068", registers=(_R.battery_status,))
-_D("Number Pad N545", codename="N545", protocol=1.0, wpid="2006", registers=(_R.battery_status,))
-_D("Wireless Compact Keyboard K340", codename="K340", protocol=1.0, wpid="2007", registers=(_R.battery_status,))
-_D("Wireless Keyboard MK700", codename="MK700", protocol=1.0, wpid="2008", registers=(_R.battery_status,))
-_D("Wireless Wave Keyboard K350", codename="K350", protocol=1.0, wpid="200A", registers=(_R.battery_status,))
-_D("Wireless Keyboard MK320", codename="MK320", protocol=1.0, wpid="200F", registers=(_R.battery_status,))
+_D("Wireless Keyboard EX110", codename="EX110", protocol=1.0, wpid="0055", registers=(REG.battery_status,))
+_D("Wireless Keyboard S510", codename="S510", protocol=1.0, wpid="0056", registers=(REG.battery_status,))
+_D("Wireless Wave Keyboard K550", codename="K550", protocol=1.0, wpid="0060", registers=(REG.battery_status,))
+_D("Wireless Keyboard EX100", codename="EX100", protocol=1.0, wpid="0065", registers=(REG.battery_status,))
+_D("Wireless Keyboard MK300", codename="MK300", protocol=1.0, wpid="0068", registers=(REG.battery_status,))
+_D("Number Pad N545", codename="N545", protocol=1.0, wpid="2006", registers=(REG.battery_status,))
+_D("Wireless Compact Keyboard K340", codename="K340", protocol=1.0, wpid="2007", registers=(REG.battery_status,))
+_D("Wireless Keyboard MK700", codename="MK700", protocol=1.0, wpid="2008", registers=(REG.battery_status,))
+_D("Wireless Wave Keyboard K350", codename="K350", protocol=1.0, wpid="200A", registers=(REG.battery_status,))
+_D("Wireless Keyboard MK320", codename="MK320", protocol=1.0, wpid="200F", registers=(REG.battery_status,))
 _D(
     "Wireless Illuminated Keyboard K800",
     codename="K800",
     protocol=1.0,
     wpid="2010",
-    registers=(_R.battery_status, _R.three_leds),
+    registers=(REG.battery_status, REG.three_leds),
 )
-_D("Wireless Keyboard K520", codename="K520", protocol=1.0, wpid="2011", registers=(_R.battery_status,))
+_D("Wireless Keyboard K520", codename="K520", protocol=1.0, wpid="2011", registers=(REG.battery_status,))
 _D("Wireless Solar Keyboard K750", codename="K750", protocol=2.0, wpid="4002")
 _D("Wireless Keyboard K270 (unifying)", codename="K270", protocol=2.0, wpid="4003")
 _D("Wireless Keyboard K360", codename="K360", protocol=2.0, wpid="4004")
@@ -234,51 +233,57 @@ def get_btid(btid):
 
 # Mice
 
-_D("LX5 Cordless Mouse", codename="LX5", protocol=1.0, wpid="0036", registers=(_R.battery_status,))
-_D("LX7 Cordless Laser Mouse", codename="LX7", protocol=1.0, wpid="0039", registers=(_R.battery_status,))
-_D("Wireless Wave Mouse M550", codename="M550", protocol=1.0, wpid="003C", registers=(_R.battery_status,))
-_D("Wireless Mouse EX100", codename="EX100m", protocol=1.0, wpid="003F", registers=(_R.battery_status,))
-_D("Wireless Mouse M30", codename="M30", protocol=1.0, wpid="0085", registers=(_R.battery_status,))
-_D("MX610 Laser Cordless Mouse", codename="MX610", protocol=1.0, wpid="1001", registers=(_R.battery_status,))
-_D("G7 Cordless Laser Mouse", codename="G7", protocol=1.0, wpid="1002", registers=(_R.battery_status,))
-_D("V400 Laser Cordless Mouse", codename="V400", protocol=1.0, wpid="1003", registers=(_R.battery_status,))
-_D("MX610 Left-Handled Mouse", codename="MX610L", protocol=1.0, wpid="1004", registers=(_R.battery_status,))
-_D("V450 Laser Cordless Mouse", codename="V450", protocol=1.0, wpid="1005", registers=(_R.battery_status,))
+_D("LX5 Cordless Mouse", codename="LX5", protocol=1.0, wpid="0036", registers=(REG.battery_status,))
+_D("LX7 Cordless Laser Mouse", codename="LX7", protocol=1.0, wpid="0039", registers=(REG.battery_status,))
+_D("Wireless Wave Mouse M550", codename="M550", protocol=1.0, wpid="003C", registers=(REG.battery_status,))
+_D("Wireless Mouse EX100", codename="EX100m", protocol=1.0, wpid="003F", registers=(REG.battery_status,))
+_D("Wireless Mouse M30", codename="M30", protocol=1.0, wpid="0085", registers=(REG.battery_status,))
+_D("MX610 Laser Cordless Mouse", codename="MX610", protocol=1.0, wpid="1001", registers=(REG.battery_status,))
+_D("G7 Cordless Laser Mouse", codename="G7", protocol=1.0, wpid="1002", registers=(REG.battery_status,))
+_D("V400 Laser Cordless Mouse", codename="V400", protocol=1.0, wpid="1003", registers=(REG.battery_status,))
+_D("MX610 Left-Handled Mouse", codename="MX610L", protocol=1.0, wpid="1004", registers=(REG.battery_status,))
+_D("V450 Laser Cordless Mouse", codename="V450", protocol=1.0, wpid="1005", registers=(REG.battery_status,))
 _D(
     "VX Revolution",
     codename="VX Revolution",
-    kind=_DK.mouse,
+    kind=DEVICE_KIND.mouse,
     protocol=1.0,
     wpid=("1006", "100D", "0612"),
-    registers=(_R.battery_charge,),
+    registers=(REG.battery_charge,),
 )
-_D("MX Air", codename="MX Air", protocol=1.0, kind=_DK.mouse, wpid=("1007", "100E"), registers=(_R.battery_charge,))
+_D("MX Air", codename="MX Air", protocol=1.0, kind=DEVICE_KIND.mouse, wpid=("1007", "100E"), registers=(REG.battery_charge,))
 _D(
     "MX Revolution",
     codename="MX Revolution",
     protocol=1.0,
-    kind=_DK.mouse,
+    kind=DEVICE_KIND.mouse,
     wpid=("1008", "100C"),
-    registers=(_R.battery_charge,),
+    registers=(REG.battery_charge,),
 )
-_D("MX620 Laser Cordless Mouse", codename="MX620", protocol=1.0, wpid=("100A", "1016"), registers=(_R.battery_charge,))
-_D("VX Nano Cordless Laser Mouse", codename="VX Nano", protocol=1.0, wpid=("100B", "100F"), registers=(_R.battery_charge,))
-_D("V450 Nano Cordless Laser Mouse", codename="V450 Nano", protocol=1.0, wpid="1011", registers=(_R.battery_charge,))
-_D("V550 Nano Cordless Laser Mouse", codename="V550 Nano", protocol=1.0, wpid="1013", registers=(_R.battery_charge,))
+_D("MX620 Laser Cordless Mouse", codename="MX620", protocol=1.0, wpid=("100A", "1016"), registers=(REG.battery_charge,))
+_D("VX Nano Cordless Laser Mouse", codename="VX Nano", protocol=1.0, wpid=("100B", "100F"), registers=(REG.battery_charge,))
+_D("V450 Nano Cordless Laser Mouse", codename="V450 Nano", protocol=1.0, wpid="1011", registers=(REG.battery_charge,))
+_D("V550 Nano Cordless Laser Mouse", codename="V550 Nano", protocol=1.0, wpid="1013", registers=(REG.battery_charge,))
 _D(
     "MX 1100 Cordless Laser Mouse",
     codename="MX 1100",
     protocol=1.0,
-    kind=_DK.mouse,
+    kind=DEVICE_KIND.mouse,
     wpid="1014",
-    registers=(_R.battery_charge,),
+    registers=(REG.battery_charge,),
 )
-_D("Anywhere Mouse MX", codename="Anywhere MX", protocol=1.0, wpid="1017", registers=(_R.battery_charge,))
-_D("Performance Mouse MX", codename="Performance MX", protocol=1.0, wpid="101A", registers=(_R.battery_status, _R.three_leds))
-_D("Marathon Mouse M705 (M-R0009)", codename="M705 (M-R0009)", protocol=1.0, wpid="101B", registers=(_R.battery_charge,))
-_D("Wireless Mouse M350", codename="M350", protocol=1.0, wpid="101C", registers=(_R.battery_charge,))
-_D("Wireless Mouse M505", codename="M505/B605", protocol=1.0, wpid="101D", registers=(_R.battery_charge,))
-_D("Wireless Mouse M305", codename="M305", protocol=1.0, wpid="101F", registers=(_R.battery_status,))
+_D("Anywhere Mouse MX", codename="Anywhere MX", protocol=1.0, wpid="1017", registers=(REG.battery_charge,))
+_D(
+    "Performance Mouse MX",
+    codename="Performance MX",
+    protocol=1.0,
+    wpid="101A",
+    registers=(REG.battery_status, REG.three_leds),
+)
+_D("Marathon Mouse M705 (M-R0009)", codename="M705 (M-R0009)", protocol=1.0, wpid="101B", registers=(REG.battery_charge,))
+_D("Wireless Mouse M350", codename="M350", protocol=1.0, wpid="101C", registers=(REG.battery_charge,))
+_D("Wireless Mouse M505", codename="M505/B605", protocol=1.0, wpid="101D", registers=(REG.battery_charge,))
+_D("Wireless Mouse M305", codename="M305", protocol=1.0, wpid="101F", registers=(REG.battery_status,))
 _D("Wireless Mouse M215", codename="M215", protocol=1.0, wpid="1020")
 _D(
     "G700 Gaming Mouse",
@@ -288,12 +293,12 @@ def get_btid(btid):
     usbid=0xC06B,
     interface=1,
     registers=(
-        _R.battery_status,
-        _R.three_leds,
+        REG.battery_status,
+        REG.three_leds,
     ),
 )
-_D("Wireless Mouse M310", codename="M310", protocol=1.0, wpid="1024", registers=(_R.battery_status,))
-_D("Wireless Mouse M510", codename="M510", protocol=1.0, wpid="1025", registers=(_R.battery_status,))
+_D("Wireless Mouse M310", codename="M310", protocol=1.0, wpid="1024", registers=(REG.battery_status,))
+_D("Wireless Mouse M510", codename="M510", protocol=1.0, wpid="1025", registers=(REG.battery_status,))
 _D("Fujitsu Sonic Mouse", codename="Sonic", protocol=1.0, wpid="1029")
 _D(
     "G700s Gaming Mouse",
@@ -303,8 +308,8 @@ def get_btid(btid):
     usbid=0xC07C,
     interface=1,
     registers=(
-        _R.battery_status,
-        _R.three_leds,
+        REG.battery_status,
+        REG.three_leds,
     ),
 )
 _D("Couch Mouse M515", codename="M515", protocol=2.0, wpid="4007")
@@ -348,7 +353,7 @@ def get_btid(btid):
 _D("MX518 Gaming Mouse", codename="MX518", usbid=0xC08E, interface=1)
 _D("G703 Hero Gaming Mouse", codename="G703 Hero", usbid=0xC090)
 _D("G903 Hero Gaming Mouse", codename="G903 Hero", usbid=0xC091)
-_D(None, kind=_DK.mouse, usbid=0xC092, interface=1)  # two mice share this ID
+_D(None, kind=DEVICE_KIND.mouse, usbid=0xC092, interface=1)  # two mice share this ID
 _D("M500S Mouse", codename="M500S", usbid=0xC093, interface=1)
 # _D('G600 Gaming Mouse', codename='G600 Gaming', usbid=0xc24a, interface=1) # not an HID++ device
 _D("G500s Gaming Mouse", codename="G500s Gaming", usbid=0xC24E, interface=1, protocol=1.0)
@@ -365,13 +370,15 @@ def get_btid(btid):
 
 _D("Wireless Touchpad", codename="Wireless Touch", protocol=2.0, wpid="4011")
 _D("Wireless Rechargeable Touchpad T650", codename="T650", protocol=2.0, wpid="4101")
-_D("G Powerplay", codename="Powerplay", protocol=2.0, kind=_DK.touchpad, wpid="405F")  # To override self-identification
+_D(
+    "G Powerplay", codename="Powerplay", protocol=2.0, kind=DEVICE_KIND.touchpad, wpid="405F"
+)  # To override self-identification
 
 # Headset
 
-_D("G533 Gaming Headset", codename="G533 Headset", protocol=2.0, interface=3, kind=_DK.headset, usbid=0x0A66)
-_D("G535 Gaming Headset", codename="G535 Headset", protocol=2.0, interface=3, kind=_DK.headset, usbid=0x0AC4)
-_D("G935 Gaming Headset", codename="G935 Headset", protocol=2.0, interface=3, kind=_DK.headset, usbid=0x0A87)
-_D("G733 Gaming Headset", codename="G733 Headset", protocol=2.0, interface=3, kind=_DK.headset, usbid=0x0AB5)
-_D("G733 Gaming Headset", codename="G733 Headset New", protocol=2.0, interface=3, kind=_DK.headset, usbid=0x0AFE)
-_D("PRO X Wireless Gaming Headset", codename="PRO Headset", protocol=2.0, interface=3, kind=_DK.headset, usbid=0x0ABA)
+_D("G533 Gaming Headset", codename="G533 Headset", protocol=2.0, interface=3, kind=DEVICE_KIND.headset, usbid=0x0A66)
+_D("G535 Gaming Headset", codename="G535 Headset", protocol=2.0, interface=3, kind=DEVICE_KIND.headset, usbid=0x0AC4)
+_D("G935 Gaming Headset", codename="G935 Headset", protocol=2.0, interface=3, kind=DEVICE_KIND.headset, usbid=0x0A87)
+_D("G733 Gaming Headset", codename="G733 Headset", protocol=2.0, interface=3, kind=DEVICE_KIND.headset, usbid=0x0AB5)
+_D("G733 Gaming Headset", codename="G733 Headset New", protocol=2.0, interface=3, kind=DEVICE_KIND.headset, usbid=0x0AFE)
+_D("PRO X Wireless Gaming Headset", codename="PRO Headset", protocol=2.0, interface=3, kind=DEVICE_KIND.headset, usbid=0x0ABA)

lib/logitech_receiver/device.py

@@ -14,16 +14,16 @@
 ## You should have received a copy of the GNU General Public License along
 ## with this program; if not, write to the Free Software Foundation, Inc.,
 ## 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-
-import errno as _errno
+import errno
 import logging
-import threading as _threading
+import threading
 import time
 
 from typing import Optional
 
-import hidapi as _hid
-import solaar.configuration as _configuration
+import hidapi
+
+from solaar import configuration
 
 from . import base
 from . import descriptors
@@ -33,9 +33,9 @@
 from . import hidpp20
 from . import hidpp20_constants
 from . import settings
+from . import settings_templates
 from .common import ALERT
 from .common import Battery
-from .settings_templates import check_feature_settings as _check_feature_settings
 
 logger = logging.getLogger(__name__)
 
@@ -58,7 +58,7 @@ def create_device(device_info, setting_callback=None):
                 return Device(None, None, None, handle=handle, device_info=device_info, setting_callback=setting_callback)
         except OSError as e:
             logger.exception("open %s", device_info)
-            if e.errno == _errno.EACCES:
+            if e.errno == errno.EACCES:
                 raise
         except Exception:
             logger.exception("open %s", device_info)
@@ -69,7 +69,16 @@ class Device:
     read_register = hidpp10.read_register
     write_register = hidpp10.write_register
 
-    def __init__(self, receiver, number, online, pairing_info=None, handle=None, device_info=None, setting_callback=None):
+    def __init__(
+        self,
+        receiver,
+        number,
+        online,
+        pairing_info=None,
+        handle=None,
+        device_info=None,
+        setting_callback=None,
+    ):
         assert receiver or device_info
         if receiver:
             assert 0 < number <= 15  # some receivers have devices past their max # of devices
@@ -109,14 +118,14 @@ def __init__(self, receiver, number, online, pairing_info=None, handle=None, dev
         self._active = None  # lags self.online - is used to help determine when to setup devices
 
         self._feature_settings_checked = False
-        self._gestures_lock = _threading.Lock()
-        self._settings_lock = _threading.Lock()
-        self._persister_lock = _threading.Lock()
+        self._gestures_lock = threading.Lock()
+        self._settings_lock = threading.Lock()
+        self._persister_lock = threading.Lock()
         self._notification_handlers = {}  # See `add_notification_handler`
         self.cleanups = []  # functions to run on the device when it is closed
 
         if not self.path:
-            self.path = _hid.find_paired_node(receiver.path, number, 1) if receiver else None
+            self.path = hidapi.find_paired_node(receiver.path, number, 1) if receiver else None
         if not self.handle:
             try:
                 self.handle = base.open_path(self.path) if self.path else None
@@ -308,9 +317,9 @@ def profiles(self):
                 self._profiles = _hidpp20.get_profiles(self)
         return self._profiles
 
-    def set_configuration(self, configuration, no_reply=False):
+    def set_configuration(self, configuration_, no_reply=False):
         if self.online and self.protocol >= 2.0:
-            _hidpp20.config_change(self, configuration, no_reply=no_reply)
+            _hidpp20.config_change(self, configuration_, no_reply=no_reply)
 
     def reset(self, no_reply=False):
         self.set_configuration(0, no_reply)
@@ -320,7 +329,7 @@ def persister(self):
         if not self._persister:
             with self._persister_lock:
                 if not self._persister:
-                    self._persister = _configuration.persister(self)
+                    self._persister = configuration.persister(self)
         return self._persister
 
     @property
@@ -343,7 +352,7 @@ def settings(self):
         if not self._feature_settings_checked:
             with self._settings_lock:
                 if not self._feature_settings_checked:
-                    self._feature_settings_checked = _check_feature_settings(self, self._settings)
+                    self._feature_settings_checked = settings_templates.check_feature_settings(self, self._settings)
         return self._settings
 
     def battery(self):  # None  or  level, next, status, voltage