qmk/qmk_firmware

[Bug] qmk command failure

Open

#13.079 geöffnet am 2. Juni 2021

Auf GitHub ansehen
 (21 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C (43.867 Forks)batch import
bughelp wanted

Repository-Metriken

Stars
 (20.368 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 20T 9h) (27 gemergte PRs in 30 T)

Beschreibung

Describe the Bug

edited after seeing rgoulter's comment qmk script does not properly detect absence of required modules, namely hid and pyusb.

the error message looks like this.

File "${HOME}/qmk_firmware/lib/python/qmk/cli/console.py", line 9, in import hid ModuleNotFoundError: No module named 'hid'

this occurs after renewing a repository across the last breaking change.

How to reproduce

condition 1: make sure user.developer is set to None or False with qmk config. ex. qmk config user.developer=None condition 2: make sure hid module is not installed. ex. pip3 uninstall hid

then qmk hello to test its behaviour.

Quick fix

manually install required modules for now. pip3 install hid pyusb

or

comment out this line > # from . import console

System Information

Additional Context

https://github.com/qmk/qmk_firmware/issues/12455#issuecomment-852427803

Contributor Guide

Research-Richtung
Untersuche die Fehlerbehandlung in lib/python/qmk/cli/ init .py und dem console.py Modul. Der Fehler tritt auf, weil das Skript fehlende hid und pyusb Module nicht angemessen behandelt. Sieh dir an, wie andere Module in der CLI optionale Abhängigkeiten handhaben. Erwäge die Implementierung eines try except, um eine benutzerfreundliche Fehlermeldung auszugeben. Der Kommentar des Maintainers in Issue #12455 könnte zusätzlichen Kontext liefern.
Tech Stack
python
Domain
cli
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitPython
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65