Skip to content

Commit

Permalink
Add setup, clone, and env to the list of commands we allow even with …
Browse files Browse the repository at this point in the history
…broken modules (#12868)
  • Loading branch information
skullydazed authored May 12, 2021
1 parent 3a1ce81 commit 6da60d4
Showing 1 changed file with 42 additions and 30 deletions.
72 changes: 42 additions & 30 deletions lib/python/qmk/cli/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,21 @@
from milc.questions import yesno


import_names = {
# A mapping of package name to importable name
'pep8-naming': 'pep8ext_naming',
'pyusb': 'usb.core',
}

safe_commands = [
# A list of subcommands we always run, even when the module imports fail
'clone',
'config',
'env',
'setup',
]


def _run_cmd(*command):
"""Run a command in a subshell.
"""
Expand Down Expand Up @@ -50,10 +65,8 @@ def _find_broken_requirements(requirements):
module_import = module_name.replace('-', '_')

# Not every module is importable by its own name.
if module_name == "pep8-naming":
module_import = "pep8ext_naming"
elif module_name == 'pyusb':
module_import = 'usb.core'
if module_name in import_names:
module_import = import_names[module_name]

if not find_spec(module_import):
broken_modules.append(module_name)
Expand Down Expand Up @@ -109,32 +122,31 @@ def _broken_module_imports(requirements):

# Check to make sure we have all our dependencies
msg_install = 'Please run `python3 -m pip install -r %s` to install required python dependencies.'

if _broken_module_imports('requirements.txt'):
if yesno('Would you like to install the required Python modules?'):
_run_cmd(sys.executable, '-m', 'pip', 'install', '-r', 'requirements.txt')
else:
print()
print(msg_install % (str(Path('requirements.txt').resolve()),))
print()
exit(1)

if cli.config.user.developer:
args = sys.argv[1:]
while args and args[0][0] == '-':
del args[0]
if not args or args[0] != 'config':
if _broken_module_imports('requirements-dev.txt'):
if yesno('Would you like to install the required developer Python modules?'):
_run_cmd(sys.executable, '-m', 'pip', 'install', '-r', 'requirements-dev.txt')
elif yesno('Would you like to disable developer mode?'):
_run_cmd(sys.argv[0], 'config', 'user.developer=None')
else:
print()
print(msg_install % (str(Path('requirements-dev.txt').resolve()),))
print('You can also turn off developer mode: qmk config user.developer=None')
print()
exit(1)
args = sys.argv[1:]
while args and args[0][0] == '-':
del args[0]

if not args or args[0] not in safe_commands:
if _broken_module_imports('requirements.txt'):
if yesno('Would you like to install the required Python modules?'):
_run_cmd(sys.executable, '-m', 'pip', 'install', '-r', 'requirements.txt')
else:
print()
print(msg_install % (str(Path('requirements.txt').resolve()),))
print()
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?'):
_run_cmd(sys.executable, '-m', 'pip', 'install', '-r', 'requirements-dev.txt')
elif yesno('Would you like to disable developer mode?'):
_run_cmd(sys.argv[0], 'config', 'user.developer=None')
else:
print()
print(msg_install % (str(Path('requirements-dev.txt').resolve()),))
print('You can also turn off developer mode: qmk config user.developer=None')
print()
exit(1)

# Import our subcommands
from . import c2json # noqa
Expand Down

0 comments on commit 6da60d4

Please sign in to comment.