mirror of
https://github.com/qmk/qmk_cli.git
synced 2026-07-25 16:42:55 -04:00
fauxpark
120 lines
4.0 KiB
Python
120 lines
4.0 KiB
Python
#!/usr/bin/env python3
|
|
"""CLI wrapper for running QMK commands.
|
|
|
|
This program can be run from anywhere, with or without a qmk_firmware repository. If a qmk_firmware repository can be located we will use that to augment our available subcommands.
|
|
"""
|
|
import argparse
|
|
import os
|
|
import subprocess
|
|
import sys
|
|
from functools import lru_cache
|
|
from pathlib import Path
|
|
import platform
|
|
|
|
import milc
|
|
|
|
milc.EMOJI_LOGLEVELS['INFO'] = '{fg_blue}Ψ{style_reset_all}'
|
|
|
|
|
|
@milc.cli.entrypoint('CLI wrapper for running QMK commands.')
|
|
def qmk_main(cli):
|
|
"""The function that gets run when there's no subcommand.
|
|
"""
|
|
cli.print_help()
|
|
|
|
|
|
@lru_cache(maxsize=2)
|
|
def in_qmk_firmware():
|
|
"""Returns the path to the qmk_firmware we are currently in, or None if we are not inside qmk_firmware.
|
|
"""
|
|
cur_dir = Path.cwd()
|
|
while len(cur_dir.parents) > 0:
|
|
found_bin = cur_dir / 'bin' / 'qmk'
|
|
# An additional check for something that exists in the root of qmk_firmware,
|
|
# but not in the script's install directory, to avoid recursive execution,
|
|
# if started from install directory.
|
|
# e.g.: cd ~/.local/bin && ./qmk
|
|
found_quantum = cur_dir / 'quantum'
|
|
if found_bin.is_file() and found_quantum.is_dir():
|
|
command = [sys.executable, found_bin.as_posix()]
|
|
result = subprocess.run(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
|
|
|
if result.returncode == 0:
|
|
return cur_dir
|
|
|
|
# Move up a directory before the next iteration
|
|
cur_dir = cur_dir / '..'
|
|
cur_dir = cur_dir.resolve()
|
|
|
|
|
|
def find_qmk_firmware():
|
|
"""Look for qmk_firmware in the usual places.
|
|
|
|
This function returns the path to qmk_firmware, or the default location if one does not exist.
|
|
"""
|
|
if in_qmk_firmware():
|
|
return in_qmk_firmware()
|
|
|
|
if milc.cli.config.user.qmk_home:
|
|
return Path(milc.cli.config.user.qmk_home).expanduser().resolve()
|
|
|
|
if 'QMK_HOME' in os.environ:
|
|
path = Path(os.environ['QMK_HOME']).expanduser()
|
|
if path.exists():
|
|
return path.resolve()
|
|
return path
|
|
|
|
return Path.home() / 'qmk_firmware'
|
|
|
|
|
|
def main():
|
|
"""Setup the environment before dispatching to the entrypoint.
|
|
"""
|
|
# Warn if they use an outdated python version
|
|
if sys.version_info < (3, 6):
|
|
print('Warning: Your Python version is out of date! Some subcommands may not work!')
|
|
print('Please upgrade to Python 3.6 or later.')
|
|
|
|
if 'windows' in platform.platform().lower():
|
|
if 'mingw64' not in sys.executable or 'mingw64' not in os.environ.get('MSYSTEM_PREFIX', ''):
|
|
print('Warning: It seems you are not using the MINGW64 terminal.')
|
|
print('While the MSYS one can work, too, we recommend/support you start "MSYS2 MinGW 64-bit".\n')
|
|
|
|
# Environment setup
|
|
import qmk_cli
|
|
milc.cli.version = qmk_cli.__version__
|
|
qmk_firmware = find_qmk_firmware()
|
|
os.environ['QMK_HOME'] = str(qmk_firmware)
|
|
os.environ['ORIG_CWD'] = os.getcwd()
|
|
|
|
# Import the subcommand modules
|
|
import qmk_cli.subcommands
|
|
|
|
if qmk_firmware.exists():
|
|
os.chdir(str(qmk_firmware))
|
|
sys.path.append(str(qmk_firmware / 'lib' / 'python'))
|
|
try:
|
|
import qmk.cli
|
|
except ImportError:
|
|
if qmk_firmware.name != 'qmk_firmware':
|
|
print('Warning: %s does not end in "qmk_firmware". Do you need to set QMK_HOME to "%s/qmk_firmware"?' % (qmk_firmware,qmk_firmware))
|
|
|
|
print('Error: %s is too old or not set up correctly!' % qmk_firmware)
|
|
print('Please update it or remove it completely before continuing.')
|
|
sys.exit(1)
|
|
|
|
# Call the entrypoint
|
|
return_code = milc.cli()
|
|
|
|
if return_code is False:
|
|
exit(1)
|
|
|
|
elif return_code is not True and isinstance(return_code, int):
|
|
if return_code < 0 or return_code > 255:
|
|
milc.cli.log.error('Invalid return_code: %d', return_code)
|
|
exit(255)
|
|
|
|
exit(return_code)
|
|
|
|
exit(0)
|