qmk/qmk_firmware

[Bug] qmk command failure

Open

#13.079 aperta il 2 giu 2021

Vedi su GitHub
 (21 commenti) (0 reazioni) (0 assegnatari)C (43.867 fork)batch import
bughelp wanted

Metriche repository

Star
 (20.368 star)
Metriche merge PR
 (Merge medio 20g 9h) (27 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina la gestione degli errori in lib/python/qmk/cli/ init .py e nel modulo console.py. Il bug si verifica perché lo script non gestisce correttamente i moduli hid e pyusb mancanti. Osserva come altri moduli nella CLI gestiscono le dipendenze opzionali. Considera di implementare un try except per fornire un messaggio di errore user friendly. Il commento del maintainer nell'issue #12455 potrebbe fornire ulteriore contesto.
Tech stack
python
Dominio
cli
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitPython
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65