def _generate_command_reply(cmd):
"""Recursively generate completion reply for this command and subcommands.
Parameters
----------
cmd : click.Command
Command to generate completion replies for (including its subcommands).
"""
import textwrap
import click
ctx = None
options = ['--help']
for param in cmd.params:
if isinstance(param, click.Option):
options.extend(param.opts)
options.extend(param.secondary_opts)
subcmd_names = []
if isinstance(cmd, click.MultiCommand):
subcmd_names.extend(cmd.list_commands(ctx))
subcmd_cases = []
for subcmd_name in subcmd_names:
subcmd_reply = _generate_command_reply(
cmd.get_command(ctx, subcmd_name))
subcmd_reply = textwrap.indent(subcmd_reply, ' ')
case = SUBCOMMAND_CASE_TEMPLATE.format(
subcmd_name=subcmd_name, subcmd_reply=subcmd_reply)
subcmd_cases.append(case)
subcmd_cases = textwrap.indent('\n'.join(subcmd_cases), ' ' * 6)
cmd_reply = COMMAND_REPLY_TEMPLATE.format(
options=' '.join(options), subcmd_names=' '.join(subcmd_names),
subcmd_cases=subcmd_cases)
return cmd_reply
# NOTE: using double braces to avoid `str.format` interpolation when bash needs
# curly braces in the generated code.
#
# NOTE: the handling of a negative COMP_CWORD is necessary in certain versions
# of bash (e.g. at least the bash shipped with OS X 10.9.5). When adding
# whitespace to the end of a command, and then moving the cursor backwards in
# the command and hitting <tab>, COMP_CWORD can be negative (I've only seen -2
# as its value). This is a bash bug and is not documented behavior. Other CLIs
# with tab completion suffer from the same issue, and each one deals with this
# bug differently (some not at all, e.g. `git`). The workaround used below
# seems to provide the least destructive completion behavior for our CLI.
#
# Bug report reference:
# https://lists.gnu.org/archive/html/bug-bash/2009-07/msg00108.html
评论列表
文章目录
