alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

idf.py: Add help subcommand

Browse Source
This commit is contained in:
Sergei Silnov 2020-07-14 17:07:32 +02:00
parent 1fa7454f5e
commit 435c5564f4
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
tools/idf.py
View File

@ -144,7 +144,6 @@ def init_cli(verbose_output=None):
class Deprecation(object): class Deprecation(object):
"""Construct deprecation notice for help messages""" """Construct deprecation notice for help messages"""
def __init__(self, deprecated=False): def __init__(self, deprecated=False):
self.deprecated = deprecated self.deprecated = deprecated
self.since = None self.since = None
@ -292,7 +291,6 @@ def init_cli(verbose_output=None):
names - alias of 'param_decls' names - alias of 'param_decls'
""" """
def __init__(self, **kwargs): def __init__(self, **kwargs):
names = kwargs.pop("names") names = kwargs.pop("names")
super(Argument, self).__init__(names, **kwargs) super(Argument, self).__init__(names, **kwargs)
@ -331,7 +329,6 @@ def init_cli(verbose_output=None):
class Option(click.Option): class Option(click.Option):
"""Option that knows whether it should be global""" """Option that knows whether it should be global"""
def __init__(self, scope=None, deprecated=False, hidden=False, **kwargs): def __init__(self, scope=None, deprecated=False, hidden=False, **kwargs):
""" """
Keyword arguments additional to Click's Option class: Keyword arguments additional to Click's Option class:
@ -367,7 +364,6 @@ def init_cli(verbose_output=None):
class CLI(click.MultiCommand): class CLI(click.MultiCommand):
"""Action list contains all actions with options available for CLI""" """Action list contains all actions with options available for CLI"""
def __init__(self, all_actions=None, verbose_output=None, help=None): def __init__(self, all_actions=None, verbose_output=None, help=None):
super(CLI, self).__init__( super(CLI, self).__init__(
chain=True, chain=True,
@ -518,6 +514,10 @@ def init_cli(verbose_output=None):
ctx = click.get_current_context() ctx = click.get_current_context()
global_args = PropertyDict(kwargs) global_args = PropertyDict(kwargs)
def _help_and_exit():
print(ctx.get_help())
ctx.exit()
# Show warning if some tasks are present several times in the list # Show warning if some tasks are present several times in the list
dupplicated_tasks = sorted( dupplicated_tasks = sorted(
[item for item, count in Counter(task.name for task in tasks).items() if count > 1]) [item for item, count in Counter(task.name for task in tasks).items() if count > 1])
@ -528,9 +528,13 @@ def init_cli(verbose_output=None):
("s %s are" % dupes if len(dupplicated_tasks) > 1 else " %s is" % dupes) + ("s %s are" % dupes if len(dupplicated_tasks) > 1 else " %s is" % dupes) +
"Only first occurence will be executed.") "Only first occurence will be executed.")
for task in tasks:
# Show help and exit if help is in the list of commands
if task.name == 'help':
_help_and_exit()
# Set propagated global options. # Set propagated global options.
# These options may be set on one subcommand, but available in the list of global arguments # These options may be set on one subcommand, but available in the list of global arguments
for task in tasks:
for key in list(task.action_args): for key in list(task.action_args):
option = next((o for o in ctx.command.params if o.name == key), None) option = next((o for o in ctx.command.params if o.name == key), None)
@ -558,8 +562,7 @@ def init_cli(verbose_output=None):
# Always show help when command is not provided # Always show help when command is not provided
if not tasks: if not tasks:
print(ctx.get_help()) _help_and_exit()
ctx.exit()
# Build full list of tasks to and deal with dependencies and order dependencies # Build full list of tasks to and deal with dependencies and order dependencies
tasks_to_run = OrderedDict() tasks_to_run = OrderedDict()