Something went wrong. Try again.
keyboard stuff
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289"""QMK CLI Subcommands
We list each subcommand here explicitly because all the reliable ways of searching for modules are slow and delay startup."""import osimport platformimport platformdirsimport shleximport sysfrom importlib.util import find_specfrom pathlib import Pathfrom subprocess import run
from milc import cli, __VERSION__from milc.questions import yesno
def _get_default_distrib_path(): if 'windows' in platform.platform().lower(): try: result = cli.run(['cygpath', '-w', '/opt/qmk']) if result.returncode == 0: return result.stdout.strip() except Exception: pass
return platformdirs.user_data_dir('qmk')
# Ensure the QMK distribution is on the `$PATH` if present. This must be kept in sync with qmk/qmk_cli.QMK_DISTRIB_DIR = Path(os.environ.get('QMK_DISTRIB_DIR', _get_default_distrib_path()))if QMK_DISTRIB_DIR.exists(): os.environ['PATH'] = str(QMK_DISTRIB_DIR / 'bin') + os.pathsep + os.environ['PATH']
# Prepend any user-defined path prefixif 'QMK_PATH_PREFIX' in os.environ: os.environ['PATH'] = os.environ['QMK_PATH_PREFIX'] + os.pathsep + os.environ['PATH']
import_names = { # A mapping of package name to importable name 'pep8-naming': 'pep8ext_naming', 'pyserial': 'serial', 'pyusb': 'usb.core', 'qmk-dotty-dict': 'dotty_dict', 'pillow': 'PIL'}
safe_commands = [ # A list of subcommands we always run, even when the module imports fail 'clone', 'config', 'doctor', 'env', 'setup',]
subcommands = [ 'qmk.cli.ci.validate_aliases', 'qmk.cli.bux', 'qmk.cli.c2json', 'qmk.cli.cd', 'qmk.cli.chibios.confmigrate', 'qmk.cli.clean', 'qmk.cli.compile', 'qmk.cli.docs', 'qmk.cli.doctor', 'qmk.cli.find', 'qmk.cli.flash', 'qmk.cli.format.c', 'qmk.cli.format.json', 'qmk.cli.format.python', 'qmk.cli.format.text', 'qmk.cli.generate.api', 'qmk.cli.generate.autocorrect_data', 'qmk.cli.generate.compilation_database', 'qmk.cli.generate.community_modules', 'qmk.cli.generate.config_h', 'qmk.cli.generate.develop_pr_list', 'qmk.cli.generate.dfu_header', 'qmk.cli.generate.docs', 'qmk.cli.generate.info_json', 'qmk.cli.generate.keyboard_c', 'qmk.cli.generate.keyboard_h', 'qmk.cli.generate.keycodes', 'qmk.cli.generate.keymap_h', 'qmk.cli.generate.make_dependencies', 'qmk.cli.generate.rgb_breathe_table', 'qmk.cli.generate.rules_mk', 'qmk.cli.generate.version_h', 'qmk.cli.git.submodule', 'qmk.cli.hello', 'qmk.cli.import.kbfirmware', 'qmk.cli.import.keyboard', 'qmk.cli.import.keymap', 'qmk.cli.info', 'qmk.cli.json2c', 'qmk.cli.license_check', 'qmk.cli.lint', 'qmk.cli.kle2json', 'qmk.cli.list.keyboards', 'qmk.cli.list.keymaps', 'qmk.cli.list.layouts', 'qmk.cli.mass_compile', 'qmk.cli.migrate', 'qmk.cli.new.keyboard', 'qmk.cli.new.keymap', 'qmk.cli.painter', 'qmk.cli.pytest', 'qmk.cli.resolve_alias', 'qmk.cli.test.c', 'qmk.cli.userspace.add', 'qmk.cli.userspace.compile', 'qmk.cli.userspace.doctor', 'qmk.cli.userspace.list', 'qmk.cli.userspace.path', 'qmk.cli.userspace.remove', 'qmk.cli.via2json',]
def _install_deps(requirements): """Perform the installation of missing requirements.
If we detect that we are running in a virtualenv we can't write into we'll use sudo to perform the pip install. """ command = [sys.executable, '-m', 'pip', 'install']
if sys.prefix != sys.base_prefix: # We are in a virtualenv, check to see if we need to use sudo to write to it if not os.access(sys.prefix, os.W_OK): print('Notice: Using sudo to install modules to location owned by root:', sys.prefix) command.insert(0, 'sudo')
elif not os.access(sys.prefix, os.W_OK): # We can't write to sys.prefix, attempt to install locally command.append('--user')
return _run_cmd(*command, '-r', requirements)
def _run_cmd(*command): """Run a command in a subshell. """ if 'windows' in cli.platform.lower(): safecmd = map(shlex.quote, command) safecmd = ' '.join(safecmd) command = [os.environ['SHELL'], '-c', safecmd]
return run(command)
def _find_broken_requirements(requirements): """ Check if the modules in the given requirements.txt are available.
Args:
requirements The path to a requirements.txt file
Returns a list of modules that couldn't be imported """ with Path(requirements).open() as fd: broken_modules = []
for line in fd.readlines(): line = line.strip().replace('<', '=').replace('>', '=')
if len(line) == 0 or line[0] == '#' or line.startswith('-r'): continue
if '#' in line: line = line.split('#')[0]
module_name = line.split('=')[0] if '=' in line else line module_import = module_name.replace('-', '_')
# Not every module is importable by its own name. if module_name in import_names: module_import = import_names[module_name]
if not find_spec(module_import): broken_modules.append(module_name)
return broken_modules
def _broken_module_imports(requirements): """Make sure we can import all the python modules. """ broken_modules = _find_broken_requirements(requirements)
for module in broken_modules: print('Could not find module %s!' % module)
if broken_modules: return True
return False
def _yesno(*args): """Wrapper to only prompt if interactive """ return sys.stdout.isatty() and yesno(*args)
def _eprint(errmsg): """Wrapper to print to stderr """ print(errmsg, file=sys.stderr)
# Make sure our python is new enough## Supported version information## Based on the OSes we support these are the minimum python version available by default.# Last update: 2024 Jun 24## Arch: 3.12# Debian 11: 3.9# Debian 12: 3.11# Fedora 39: 3.12# Fedora 40: 3.12# FreeBSD: 3.11# Gentoo: 3.12# macOS: 3.12 (from homebrew)# msys2: 3.11# Slackware: 3.9# solus: 3.10# Ubuntu 22.04: 3.10# Ubuntu 24.04: 3.12# void: 3.12
if sys.version_info[0] != 3 or sys.version_info[1] < 9: _eprint('Error: Your Python is too old! Please upgrade to Python 3.9 or later.') exit(127)
milc_version = __VERSION__.split('.')
if int(milc_version[0]) < 2 and int(milc_version[1]) < 9: requirements = Path('requirements.txt').resolve()
_eprint(f'Your MILC library is too old! Please upgrade: python3 -m pip install -U -r {str(requirements)}') exit(127)
# Make sure we can run binaries in the same directory as our Python interpreterpython_dir = os.path.dirname(sys.executable)
if python_dir not in os.environ['PATH'].split(os.pathsep): os.environ['PATH'] = os.pathsep.join((python_dir, os.environ['PATH']))
# Check to make sure we have all our dependenciesmsg_install = f'\nPlease run `{sys.executable} -m pip install -r %s` to install required python dependencies.'args = sys.argv[1:]while args and args[0][0] == '-': del args[0]
safe_command = args and args[0] in safe_commands
if not safe_command: if _broken_module_imports('requirements.txt'): if _yesno('Would you like to install the required Python modules?'): _install_deps('requirements.txt') else: _eprint(msg_install % (str(Path('requirements.txt').resolve()),)) exit(1)
if cli.config.user.developer and _broken_module_imports('requirements-dev.txt'): if _yesno('Would you like to install the required developer Python modules?'): _install_deps('requirements-dev.txt') elif _yesno('Would you like to disable developer mode?'): _run_cmd(sys.argv[0], 'config', 'user.developer=None') else: _eprint(msg_install % (str(Path('requirements-dev.txt').resolve()),)) _eprint('You can also turn off developer mode: qmk config user.developer=None') exit(1)
# Import our subcommandsfor subcommand in subcommands: try: __import__(subcommand)
except (ImportError, ModuleNotFoundError) as e: if safe_command: _eprint(f'Warning: Could not import {subcommand}: {e.__class__.__name__}, {e}') else: raise