add default_complete option (Sourcery refactored)
#84
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -162,7 +162,6 @@ def get_option_strings(parser): | |
| def recurse(parser, prefix): | ||
| """recurse through subparsers, appending to the return lists""" | ||
| subparsers = [] | ||
| compgens = [] | ||
| choices = [] | ||
| nargs = [] | ||
|
|
@@ -180,24 +179,26 @@ def recurse(parser, prefix): | |
| if positional.help == SUPPRESS: | ||
| continue | ||
|
|
||
| if positional_complete := getattr( | ||
| positional, "complete", {"bash": default_complete} | ||
| ): | ||
| # shtab `.complete = ...` functions | ||
| compgens.append( | ||
| f'{prefix}_pos_{i}_COMPGEN={complete2pattern(positional_complete, "bash", choice_type2fn)}' | ||
| ) | ||
|
|
||
|
|
||
| if positional.choices: | ||
| # choices (including subparsers & shtab `.complete` functions) | ||
| log.debug(f"choices:{prefix}:{sorted(positional.choices)}") | ||
|
|
||
| this_positional_choices = [] | ||
| for choice in positional.choices: | ||
| if isinstance(choice, Choice): | ||
| # append special completion type to `compgens` | ||
| # NOTE: overrides `.complete` attribute | ||
| log.debug(f"Choice.{choice.type}:{prefix}:{positional.dest}") | ||
| compgens.append(f"{prefix}_pos_{i}_COMPGEN={choice_type2fn[choice.type]}") | ||
| elif isinstance(positional.choices, dict): | ||
| # subparser, so append to list of subparsers & recurse | ||
| log.debug("subcommand:%s", choice) | ||
|
|
@@ -213,8 +214,9 @@ def recurse(parser, prefix): | |
| new_nargs, | ||
| ) = recurse( | ||
| positional.choices[choice], | ||
| f"{prefix}_{wordify(choice)}", | ||
| ) | ||
|
|
||
| sub_subparsers.extend(new_subparsers) | ||
| sub_option_strings.extend(new_option_strings) | ||
| sub_compgens.extend(new_compgens) | ||
|
|
@@ -232,26 +234,30 @@ def recurse(parser, prefix): | |
|
|
||
| # skip default `nargs` values | ||
| if positional.nargs not in (None, "1", "?"): | ||
| nargs.append(f"{prefix}_pos_{i}_nargs={positional.nargs}") | ||
|
|
||
| if discovered_subparsers: | ||
| subparsers.append(u"{}_subparsers=('{}')".format(prefix, | ||
| "' '".join(discovered_subparsers))) | ||
| log.debug(f"subcommands:{prefix}:{discovered_subparsers}") | ||
|
|
||
| option_strings = [ | ||
| u"{}_option_strings=('{}')".format( | ||
| prefix, "' '".join(get_option_strings(parser)) | ||
| ) | ||
| ] | ||
|
|
||
| for optional in parser._get_optional_actions(): | ||
| if optional == SUPPRESS: | ||
| continue | ||
|
|
||
| for option_string in optional.option_strings: | ||
| if hasattr(optional, "complete"): | ||
| # shtab `.complete = ...` functions | ||
| compgens.append( | ||
| f'{prefix}_{wordify(option_string)}_COMPGEN={complete2pattern(optional.complete, "bash", choice_type2fn)}' | ||
| ) | ||
|
|
||
|
|
||
| if optional.choices: | ||
| # choices (including shtab `.complete` functions) | ||
|
|
@@ -260,9 +266,11 @@ def recurse(parser, prefix): | |
| # append special completion type to `compgens` | ||
| # NOTE: overrides `.complete` attribute | ||
| if isinstance(choice, Choice): | ||
| log.debug(f"Choice.{choice.type}:{prefix}:{optional.dest}") | ||
| compgens.append( | ||
| f"{prefix}_{wordify(option_string)}_COMPGEN={choice_type2fn[choice.type]}" | ||
| ) | ||
|
|
||
| else: | ||
| # simple choice | ||
| this_optional_choices.append(str(choice)) | ||
|
|
@@ -273,8 +281,7 @@ def recurse(parser, prefix): | |
|
|
||
| # Check for nargs. | ||
| if optional.nargs is not None and optional.nargs != 1: | ||
| nargs.append(f"{prefix}_{wordify(option_string)}_nargs={optional.nargs}") | ||
|
|
||
| # append recursion results | ||
| subparsers.extend(sub_subparsers) | ||
|
|
@@ -466,29 +473,53 @@ def complete_zsh(parser, root_prefix=None, preamble="", default_complete="", | |
| choice_type2fn.update(choice_functions) | ||
|
|
||
| def format_optional(opt): | ||
| return ( | ||
| ( | ||
| '{nargs}{options}"[{help}]"' | ||
| if isinstance(opt, FLAG_OPTION) | ||
| else '{nargs}{options}"[{help}]:{dest}:{pattern}"' | ||
| ) | ||
| .format( | ||
| nargs=( | ||
| '"(- :)"' | ||
| if isinstance(opt, OPTION_END) | ||
| else '"*"' | ||
| if isinstance(opt, OPTION_MULTI) | ||
| else "" | ||
| ), | ||
| options=( | ||
| "{{{}}}".format(",".join(opt.option_strings)) | ||
| if len(opt.option_strings) > 1 | ||
| else '"{}"'.format("".join(opt.option_strings)) | ||
| ), | ||
| help=escape_zsh(opt.help or ""), | ||
| dest=opt.dest, | ||
| pattern=complete2pattern(opt.complete, "zsh", choice_type2fn) | ||
| if hasattr(opt, "complete") | ||
| else ( | ||
| choice_type2fn[opt.choices[0].type] | ||
| if isinstance(opt.choices[0], Choice) | ||
| else f'({" ".join(map(str, opt.choices))})' | ||
| ) | ||
| if opt.choices | ||
| else "", | ||
| ) | ||
| .replace('""', "") | ||
| ) | ||
|
Comment on lines
-469
to
+508
There was a problem hiding this comment. Function
|
||
|
|
||
| def format_positional(opt): | ||
| return '"{nargs}:{help}:{pattern}"'.format( | ||
| nargs={"+": "(*)", "*": "(*):"}.get(opt.nargs, ""), | ||
| help=escape_zsh((opt.help or opt.dest).strip().split("\n")[0]), | ||
| pattern=complete2pattern(opt.complete, "zsh", choice_type2fn) | ||
| if hasattr(opt, "complete") | ||
| else ( | ||
| choice_type2fn[opt.choices[0].type] | ||
| if isinstance(opt.choices[0], Choice) | ||
| else f'({" ".join(map(str, opt.choices))})' | ||
| ) | ||
| if opt.choices | ||
| else default_complete, | ||
|
Comment on lines
-488
to
+522
There was a problem hiding this comment. Function
|
||
| ) | ||
|
|
||
| # {cmd: {"help": help, "arguments": [arguments]}} | ||
|
|
@@ -506,11 +537,11 @@ def recurse(parser, prefix, paths=None): | |
| for sub in parser._get_positional_actions(): | ||
| if sub.help == SUPPRESS or not sub.choices: | ||
| continue | ||
| if not isinstance(sub.choices, dict): | ||
| # positional argument | ||
| all_commands[prefix]["arguments"].append(format_positional(sub)) | ||
| else: # subparser | ||
| log.debug(f"choices:{prefix}:{sorted(sub.choices)}") | ||
|
Comment on lines
-509
to
+544
There was a problem hiding this comment. Function
|
||
| public_cmds = get_public_subcommands(sub) | ||
| for cmd, subparser in sub.choices.items(): | ||
| if cmd not in public_cmds: | ||
|
|
@@ -528,7 +559,7 @@ def recurse(parser, prefix, paths=None): | |
| format_positional(opt) for opt in subparser._get_positional_actions() | ||
| if not isinstance(opt.choices, dict) if opt.help != SUPPRESS) | ||
|
|
||
| new_pref = f"{prefix}_{wordify(cmd)}" | ||
| options = all_commands[new_pref] = { | ||
| "cmd": cmd, "help": (subparser.description or "").strip().split("\n")[0], | ||
| "arguments": arguments, "paths": [*paths, cmd]} | ||
|
|
@@ -592,8 +623,11 @@ def command_option(prefix, options): | |
|
|
||
| def command_list(prefix, options): | ||
| name = " ".join([prog, *options["paths"]]) | ||
| commands = "\n ".join( | ||
| f'"{cmd}:{escape_zsh(opt["help"])}"' | ||
| for cmd, opt in sorted(options["commands"].items()) | ||
| ) | ||
|
|
||
|
Comment on lines
-595
to
+630
There was a problem hiding this comment. Function
|
||
| return """ | ||
| {prefix}_commands() {{ | ||
| local _commands=( | ||
|
|
@@ -657,17 +691,12 @@ def complete_tcsh(parser, root_prefix=None, preamble="", default_complete="", | |
| def get_specials(arg, arg_type, arg_sel): | ||
| if arg.choices: | ||
| choice_strs = ' '.join(map(str, arg.choices)) | ||
| yield f"'{arg_type}/{arg_sel}/({choice_strs})/'" | ||
| elif arg_complete := getattr(arg, "complete", default_complete): | ||
| if complete_fn := complete2pattern( | ||
| arg_complete, 'tcsh', choice_type2fn | ||
| ): | ||
| yield f"'{arg_type}/{arg_sel}/{complete_fn}/'" | ||
|
Comment on lines
-660
to
+699
There was a problem hiding this comment. Function
|
||
|
|
||
| def recurse_parser(cparser, positional_idx, requirements=None): | ||
| log_prefix = '| ' * positional_idx | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Function
get_bash_commands.recurserefactored with the following changes:merge-list-append)move-assign-in-block)use-named-expression)use-fstring-for-formatting)use-fstring-for-concatenation)This removes the following comments ( why? ):