completion.py 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
  1. import sys
  2. import textwrap
  3. from optparse import Values
  4. from typing import List
  5. from pip._internal.cli.base_command import Command
  6. from pip._internal.cli.status_codes import SUCCESS
  7. from pip._internal.utils.misc import get_prog
  8. BASE_COMPLETION = """
  9. # pip {shell} completion start{script}# pip {shell} completion end
  10. """
  11. COMPLETION_SCRIPTS = {
  12. 'bash': """
  13. _pip_completion()
  14. {{
  15. COMPREPLY=( $( COMP_WORDS="${{COMP_WORDS[*]}}" \\
  16. COMP_CWORD=$COMP_CWORD \\
  17. PIP_AUTO_COMPLETE=1 $1 2>/dev/null ) )
  18. }}
  19. complete -o default -F _pip_completion {prog}
  20. """,
  21. 'zsh': """
  22. function _pip_completion {{
  23. local words cword
  24. read -Ac words
  25. read -cn cword
  26. reply=( $( COMP_WORDS="$words[*]" \\
  27. COMP_CWORD=$(( cword-1 )) \\
  28. PIP_AUTO_COMPLETE=1 $words[1] 2>/dev/null ))
  29. }}
  30. compctl -K _pip_completion {prog}
  31. """,
  32. 'fish': """
  33. function __fish_complete_pip
  34. set -lx COMP_WORDS (commandline -o) ""
  35. set -lx COMP_CWORD ( \\
  36. math (contains -i -- (commandline -t) $COMP_WORDS)-1 \\
  37. )
  38. set -lx PIP_AUTO_COMPLETE 1
  39. string split \\ -- (eval $COMP_WORDS[1])
  40. end
  41. complete -fa "(__fish_complete_pip)" -c {prog}
  42. """,
  43. }
  44. class CompletionCommand(Command):
  45. """A helper command to be used for command completion."""
  46. ignore_require_venv = True
  47. def add_options(self):
  48. # type: () -> None
  49. self.cmd_opts.add_option(
  50. '--bash', '-b',
  51. action='store_const',
  52. const='bash',
  53. dest='shell',
  54. help='Emit completion code for bash')
  55. self.cmd_opts.add_option(
  56. '--zsh', '-z',
  57. action='store_const',
  58. const='zsh',
  59. dest='shell',
  60. help='Emit completion code for zsh')
  61. self.cmd_opts.add_option(
  62. '--fish', '-f',
  63. action='store_const',
  64. const='fish',
  65. dest='shell',
  66. help='Emit completion code for fish')
  67. self.parser.insert_option_group(0, self.cmd_opts)
  68. def run(self, options, args):
  69. # type: (Values, List[str]) -> int
  70. """Prints the completion code of the given shell"""
  71. shells = COMPLETION_SCRIPTS.keys()
  72. shell_options = ['--' + shell for shell in sorted(shells)]
  73. if options.shell in shells:
  74. script = textwrap.dedent(
  75. COMPLETION_SCRIPTS.get(options.shell, '').format(
  76. prog=get_prog())
  77. )
  78. print(BASE_COMPLETION.format(script=script, shell=options.shell))
  79. return SUCCESS
  80. else:
  81. sys.stderr.write(
  82. 'ERROR: You must pass {}\n' .format(' or '.join(shell_options))
  83. )
  84. return SUCCESS