qmk/qmk_firmware

[Bug] qmk command failure

Open

#13,079 opened on Jun 2, 2021

View on GitHub
 (21 comments) (0 reactions) (0 assignees)C (43,867 forks)batch import
bughelp wanted

Repository metrics

Stars
 (20,368 stars)
PR merge metrics
 (Avg merge 20d 9h) (27 merged PRs in 30d)

Description

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 direction
Inspect the failing import of 'hid' in cli/console.py and trace the module loading logic in cli/ init .py to understand why the missing module is not handled gracefully.
Tech stack
python
Domain
cli
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65