Refactor the base module and make it an API for low level commands

.coveragerc

@@ -0,0 +1,22 @@
+[run]
+branch = True
+
+source =
+    hid_parser
+    hidapi
+    keysyms
+    logitech_receiver
+    solaar
+
+omit =
+    */tests/*
+    */setup.py
+    */__main__.py
+
+[report]
+exclude_lines =
+    pragma: no cover
+    if __name__ == '__main__':
+    if typing.TYPE_CHECKING
+
+fail_under = 40

.github/workflows/tests.yml

@@ -31,6 +31,17 @@ jobs:
       run: |
         make test
 
+    - name: Upload coverage to Codecov
+      if: github.ref == 'refs/heads/master'
+      uses: codecov/[email protected]
+      with:
+        directory: ./coverage/reports/
+        env_vars: OS, PYTHON
+        files: ./coverage.xml
+        flags: unittests
+        name: codecov-umbrella
+        token: ${{ secrets.CODECOV_TOKEN }}
+
   macos-tests:
     runs-on: macos-latest
 
@@ -55,4 +66,14 @@ jobs:
         make install_pip PIP_ARGS='.["test"]'
     - name: Run tests on macOS
       run: |
-        export DYLD_LIBRARY_PATH=$(brew --prefix hidapi)/lib:$DYLD_LIBRARY_PATH && pytest --cov=lib/ tests/
+        export DYLD_LIBRARY_PATH=$(brew --prefix hidapi)/lib:$DYLD_LIBRARY_PATH && pytest --cov --cov-report=xml
+    - name: Upload coverage to Codecov
+      if: github.ref == 'refs/heads/master'
+      uses: codecov/[email protected]
+      with:
+        directory: ./coverage/reports/
+        env_vars: OS, PYTHON
+        files: ./coverage.xml
+        flags: unittests
+        name: codecov-umbrella
+        token: ${{ secrets.CODECOV_TOKEN }}

Makefile

@@ -66,4 +66,4 @@ lint:
 
 test:
 	@echo "Running Solaar tests"
-	pytest --cov=lib/ tests/
+	pytest --cov --cov-report=xml

README.md

@@ -13,6 +13,7 @@ that are otherwise ignored by the Linux input system.
 <a href="https://pwr-solaar.github.io/Solaar/installation">Manual Installation</a>
 
 
+[![codecov](https://codecov.io/gh/pwr-Solaar/Solaar/graph/badge.svg?token=D7YWFEWID6)](https://codecov.io/gh/pwr-Solaar/Solaar)
 [![License: GPL v2](https://img.shields.io/badge/License-GPL%20v2+-blue.svg)](../LICENSE.txt)
 
 <p align="center">

lib/hidapi/__init__.py

@@ -1,47 +0,0 @@
-## Copyright (C) 2012-2013  Daniel Pavel
-##
-## This program is free software; you can redistribute it and/or modify
-## it under the terms of the GNU General Public License as published by
-## the Free Software Foundation; either version 2 of the License, or
-## (at your option) any later version.
-##
-## This program is distributed in the hope that it will be useful,
-## but WITHOUT ANY WARRANTY; without even the implied warranty of
-## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-## GNU General Public License for more details.
-##
-## 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.
-"""Generic Human Interface Device API."""
-
-import platform
-
-if platform.system() in ("Darwin", "Windows"):
-    from hidapi.hidapi_impl import close  # noqa: F401
-    from hidapi.hidapi_impl import enumerate  # noqa: F401
-    from hidapi.hidapi_impl import find_paired_node  # noqa: F401
-    from hidapi.hidapi_impl import find_paired_node_wpid  # noqa: F401
-    from hidapi.hidapi_impl import get_manufacturer  # noqa: F401
-    from hidapi.hidapi_impl import get_product  # noqa: F401
-    from hidapi.hidapi_impl import get_serial  # noqa: F401
-    from hidapi.hidapi_impl import monitor_glib  # noqa: F401
-    from hidapi.hidapi_impl import open  # noqa: F401
-    from hidapi.hidapi_impl import open_path  # noqa: F401
-    from hidapi.hidapi_impl import read  # noqa: F401
-    from hidapi.hidapi_impl import write  # noqa: F401
-else:
-    from hidapi.udev_impl import close  # noqa: F401
-    from hidapi.udev_impl import enumerate  # noqa: F401
-    from hidapi.udev_impl import find_paired_node  # noqa: F401
-    from hidapi.udev_impl import find_paired_node_wpid  # noqa: F401
-    from hidapi.udev_impl import get_manufacturer  # noqa: F401
-    from hidapi.udev_impl import get_product  # noqa: F401
-    from hidapi.udev_impl import get_serial  # noqa: F401
-    from hidapi.udev_impl import monitor_glib  # noqa: F401
-    from hidapi.udev_impl import open  # noqa: F401
-    from hidapi.udev_impl import open_path  # noqa: F401
-    from hidapi.udev_impl import read  # noqa: F401
-    from hidapi.udev_impl import write  # noqa: F401
-
-__version__ = "0.9"

lib/hidapi/hidapi_impl.py

@@ -34,11 +34,11 @@
 from threading import Thread
 from time import sleep
 
-import gi
-
 from hidapi.common import DeviceInfo
 
 if typing.TYPE_CHECKING:
+    import gi
+
     gi.require_version("Gdk", "3.0")
     from gi.repository import GLib  # NOQA: E402
 
@@ -263,10 +263,10 @@ def _match(action, device, filterfn):
     if not device["hidpp_short"] and not device["hidpp_long"]:
         return None
 
-    filter = filterfn(bus_id, vid, pid, device["hidpp_short"], device["hidpp_long"])
-    if not filter:
+    filter_func = filterfn(bus_id, vid, pid, device["hidpp_short"], device["hidpp_long"])
+    if not filter_func:
         return
-    isDevice = filter.get("isDevice")
+    isDevice = filter_func.get("isDevice")
 
     if action == "add":
         d_info = DeviceInfo(
@@ -305,12 +305,12 @@ def _match(action, device, filterfn):
         return d_info
 
 
-def find_paired_node(receiver_path, index, timeout):
+def find_paired_node(receiver_path: str, index: int, timeout: int):
     """Find the node of a device paired with a receiver"""
     return None
 
 
-def find_paired_node_wpid(receiver_path, index):
+def find_paired_node_wpid(receiver_path: str, index: int):
     """Find the node of a device paired with a receiver, get wpid from udev"""
     return None
 

lib/hidapi/hidconsole.py

@@ -17,6 +17,7 @@
 import argparse
 import os
 import os.path
+import platform
 import readline
 import sys
 import time
@@ -27,7 +28,10 @@
 from threading import Lock
 from threading import Thread
 
-import hidapi
+if platform.system() == "Linux":
+    import hidapi.udev_impl as hidapi
+else:
+    import hidapi.hidapi_impl as hidapi
 
 LOGITECH_VENDOR_ID = 0x046D
 

lib/hidapi/udev_impl.py

@@ -37,12 +37,13 @@
 from time import sleep
 from time import time
 
-import gi
 import pyudev
 
 from hidapi.common import DeviceInfo
 
 if typing.TYPE_CHECKING:
+    import gi
+
     gi.require_version("Gdk", "3.0")
     from gi.repository import GLib  # NOQA: E402
 
@@ -77,7 +78,7 @@ def exit():
 # The filterfn is used to determine whether this is a device of interest to Solaar.
 # It is given the bus id, vendor id, and product id and returns a dictionary
 # with the required hid_driver and usb_interface and whether this is a receiver or device.
-def _match(action, device, filterfn):
+def _match(action, device, filter_func: typing.Callable[[int, int, int, bool, bool], dict[str, typing.Any]]):
     if logger.isEnabledFor(logging.DEBUG):
         logger.debug(f"Dbus event {action} {device}")
     hid_device = device.find_parent("hid")
@@ -112,11 +113,11 @@ def _match(action, device, filterfn):
             "Report Descriptor not processed for DEVICE %s BID %s VID %s PID %s: %s", device.device_node, bid, vid, pid, e
         )
 
-    filter = filterfn(int(bid, 16), int(vid, 16), int(pid, 16), hidpp_short, hidpp_long)
-    if not filter:
+    filtered_result = filter_func(int(bid, 16), int(vid, 16), int(pid, 16), hidpp_short, hidpp_long)
+    if not filtered_result:
         return
-    interface_number = filter.get("usb_interface")
-    isDevice = filter.get("isDevice")
+    interface_number = filtered_result.get("usb_interface")
+    isDevice = filtered_result.get("isDevice")
 
     if action == "add":
         hid_driver_name = hid_device.properties.get("DRIVER")
@@ -175,7 +176,7 @@ def _match(action, device, filterfn):
         return d_info
 
 
-def find_paired_node(receiver_path, index, timeout):
+def find_paired_node(receiver_path: str, index: int, timeout: int):
     """Find the node of a device paired with a receiver"""
     context = pyudev.Context()
     receiver_phys = pyudev.Devices.from_device_file(context, receiver_path).find_parent("hid").get("HID_PHYS")
@@ -259,7 +260,7 @@ def _process_udev_event(monitor, condition, cb, filterfn):
     m.start()
 
 
-def enumerate(filterfn):
+def enumerate(filter_func: typing.Callable[[int, int, int, bool, bool], dict[str, typing.Any]]):
     """Enumerate the HID Devices.
 
     List all the HID devices attached to the system, optionally filtering by
@@ -271,7 +272,7 @@ def enumerate(filterfn):
     if logger.isEnabledFor(logging.DEBUG):
         logger.debug("Starting dbus enumeration")
     for dev in pyudev.Context().list_devices(subsystem="hidraw"):
-        dev_info = _match("add", dev, filterfn)
+        dev_info = _match("add", dev, filter_func)
         if dev_info:
             yield dev_info
 

lib/keysyms/generate.py

@@ -1,41 +1,37 @@
 #!/usr/bin/env python3
+"""Extract key symbol encodings from X11 header files."""
+
 from pathlib import Path
 from pprint import pprint
 from re import findall
 from subprocess import run
 from tempfile import TemporaryDirectory
 
-repo = "https://github.com/freedesktop/xorg-proto-x11proto.git"
-xx = "https://gitlab.freedesktop.org/xorg/proto/xorgproto/-/tree/master/include/X11/"
 repo = "https://gitlab.freedesktop.org/xorg/proto/xorgproto.git"
 pattern = r"#define XK_(\w+)\s+0x(\w+)(?:\s+/\*\s+U\+(\w+))?"
 xf86pattern = r"#define XF86XK_(\w+)\s+0x(\w+)(?:\s+/\*\s+U\+(\w+))?"
 
 
 def main():
     keysymdef = {}
+    keysym_files = [
+        ("include/X11/keysymdef.h", pattern, ""),
+        ("include/X11/XF86keysym.h", xf86pattern, "XF86_"),
+    ]
 
     with TemporaryDirectory() as temp:
         run(["git", "clone", repo, "."], cwd=temp)
-        # text = Path(temp, 'keysymdef.h').read_text()
-        text = Path(temp, "include/X11/keysymdef.h").read_text()
-        for name, sym, uni in findall(pattern, text):
-            sym = int(sym, 16)
-            uni = int(uni, 16) if uni else None
-            if keysymdef.get(name, None):
-                print("KEY DUP", name)
-            keysymdef[name] = sym
-        # text = Path(temp, 'keysymdef.h').read_text()
-        text = Path(temp, "include/X11/XF86keysym.h").read_text()
-        for name, sym, uni in findall(xf86pattern, text):
-            sym = int(sym, 16)
-            uni = int(uni, 16) if uni else None
-            if keysymdef.get("XF86_" + name, None):
-                print("KEY DUP", "XF86_" + name)
-            keysymdef["XF86_" + name] = sym
+
+        for filename, extraction_pattern, prefix in keysym_files:
+            text = Path(temp, filename).read_text()
+            for name, sym, _ in findall(extraction_pattern, text):
+                sym = int(sym, 16)
+                if keysymdef.get(f"{prefix}{name}", None):
+                    print(f"KEY DUP {prefix}{name}")
+                keysymdef[f"{prefix}{name}"] = sym
 
     with open("keysymdef.py", "w") as f:
-        f.write("# flake8: noqa\nkeysymdef = \\\n")
+        f.write("# flake8: noqa\nkey_symbols = \\\n")
         pprint(keysymdef, f)
 
 

lib/keysyms/keysymdef.py

@@ -1,5 +1,5 @@
 # flake8: noqa
-keysymdef = {
+key_symbols = {
     "0": 48,
     "1": 49,
     "2": 50,