Coverage for typer/_completion_classes.py: 100%

1import os 8 ctx1habcdefg

2import re 8 ctx1habcdefg

3import sys 8 ctx1habcdefg

4from typing import Any, Dict, List, Tuple 8 ctx1habcdefg

5 

6import click 8 ctx1habcdefg

7import click.parser 8 ctx1habcdefg

8import click.shell_completion 8 ctx1habcdefg

9 

10from ._completion_shared import ( 8 ctx1habcdefg

11 COMPLETION_SCRIPT_BASH, 

12 COMPLETION_SCRIPT_FISH, 

13 COMPLETION_SCRIPT_POWER_SHELL, 

14 COMPLETION_SCRIPT_ZSH, 

15 Shells, 

16) 

17 

18try: 8 ctx1habcdefg

19 import shellingham 8 ctx1habcdefg

20except ImportError: # pragma: no cover 

21 shellingham = None 

22 

23 

24class BashComplete(click.shell_completion.BashComplete): 8 ctx1habcdefg

25 name = Shells.bash.value 8 ctx1habcdefg

26 source_template = COMPLETION_SCRIPT_BASH 8 ctx1habcdefg

27 

28 def source_vars(self) -> Dict[str, Any]: 8 ctx1habcdefg

29 return { 7 ctx1abcdefg

30 "complete_func": self.func_name, 

31 "autocomplete_var": self.complete_var, 

32 "prog_name": self.prog_name, 

33 } 

34 

35 def get_completion_args(self) -> Tuple[List[str], str]: 8 ctx1habcdefg

36 cwords = click.parser.split_arg_string(os.environ["COMP_WORDS"]) 8 ctx1habcdefg

37 cword = int(os.environ["COMP_CWORD"]) 8 ctx1habcdefg

38 args = cwords[1:cword] 8 ctx1habcdefg

39 

40 try: 8 ctx1habcdefg

41 incomplete = cwords[cword] 8 ctx1habcdefg

42 except IndexError: 8 ctx1habcdefg

43 incomplete = "" 8 ctx1habcdefg

44 

45 return args, incomplete 8 ctx1habcdefg

46 

47 def format_completion(self, item: click.shell_completion.CompletionItem) -> str: 8 ctx1habcdefg

48 # TODO: Explore replicating the new behavior from Click, with item types and 

49 # triggering completion for files and directories 

50 # return f"{item.type},{item.value}" 

51 return f"{item.value}" 8 ctx1habcdefg

52 

53 def complete(self) -> str: 8 ctx1habcdefg

54 args, incomplete = self.get_completion_args() 8 ctx1habcdefg

55 completions = self.get_completions(args, incomplete) 8 ctx1habcdefg

56 out = [self.format_completion(item) for item in completions] 8 ctx1habcdefg

57 return "\n".join(out) 8 ctx1habcdefg

58 

59 

60class ZshComplete(click.shell_completion.ZshComplete): 8 ctx1habcdefg

61 name = Shells.zsh.value 8 ctx1habcdefg

62 source_template = COMPLETION_SCRIPT_ZSH 8 ctx1habcdefg

63 

64 def source_vars(self) -> Dict[str, Any]: 8 ctx1habcdefg

65 return { 7 ctx1abcdefg

66 "complete_func": self.func_name, 

67 "autocomplete_var": self.complete_var, 

68 "prog_name": self.prog_name, 

69 } 

70 

71 def get_completion_args(self) -> Tuple[List[str], str]: 8 ctx1habcdefg

72 completion_args = os.getenv("_TYPER_COMPLETE_ARGS", "") 8 ctx1habcdefg

73 cwords = click.parser.split_arg_string(completion_args) 8 ctx1habcdefg

74 args = cwords[1:] 8 ctx1habcdefg

75 if args and not completion_args.endswith(" "): 8 ctx1habcdefg

76 incomplete = args[-1] 8 ctx1habcdefg

77 args = args[:-1] 8 ctx1habcdefg

78 else: 

79 incomplete = "" 8 ctx1habcdefg

80 return args, incomplete 8 ctx1habcdefg

81 

82 def format_completion(self, item: click.shell_completion.CompletionItem) -> str: 8 ctx1habcdefg

83 def escape(s: str) -> str: 8 ctx1habcdefg

84 return ( 7 ctx1abcdefg

85 s.replace('"', '""') 

86 .replace("'", "''") 

87 .replace("$", "\\$") 

88 .replace("`", "\\`") 

89 ) 

90 

91 # TODO: Explore replicating the new behavior from Click, pay attention to 

92 # the difference with and without escape 

93 # return f"{item.type}\n{item.value}\n{item.help if item.help else '_'}" 

94 if item.help: 8 ctx1habcdefg

95 return f'"{escape(item.value)}":"{escape(item.help)}"' 8 ctx1habcdefg

96 else: 

97 return f'"{escape(item.value)}"' 8 ctx1habcdefg

98 

99 def complete(self) -> str: 8 ctx1habcdefg

100 args, incomplete = self.get_completion_args() 8 ctx1habcdefg

101 completions = self.get_completions(args, incomplete) 8 ctx1habcdefg

102 res = [self.format_completion(item) for item in completions] 8 ctx1habcdefg

103 if res: 8 ctx1habcdefg

104 args_str = "\n".join(res) 8 ctx1habcdefg

105 return f"_arguments '*: :(({args_str}))'" 8 ctx1habcdefg

106 else: 

107 return "_files" 8 ctx1habcdefg

108 

109 

110class FishComplete(click.shell_completion.FishComplete): 8 ctx1habcdefg

111 name = Shells.fish.value 8 ctx1habcdefg

112 source_template = COMPLETION_SCRIPT_FISH 8 ctx1habcdefg

113 

114 def source_vars(self) -> Dict[str, Any]: 8 ctx1habcdefg

115 return { 7 ctx1abcdefg

116 "complete_func": self.func_name, 

117 "autocomplete_var": self.complete_var, 

118 "prog_name": self.prog_name, 

119 } 

120 

121 def get_completion_args(self) -> Tuple[List[str], str]: 8 ctx1habcdefg

122 completion_args = os.getenv("_TYPER_COMPLETE_ARGS", "") 8 ctx1habcdefg

123 cwords = click.parser.split_arg_string(completion_args) 8 ctx1habcdefg

124 args = cwords[1:] 8 ctx1habcdefg

125 if args and not completion_args.endswith(" "): 8 ctx1habcdefg

126 incomplete = args[-1] 8 ctx1habcdefg

127 args = args[:-1] 8 ctx1habcdefg

128 else: 

129 incomplete = "" 8 ctx1habcdefg

130 return args, incomplete 8 ctx1habcdefg

131 

132 def format_completion(self, item: click.shell_completion.CompletionItem) -> str: 8 ctx1habcdefg

133 # TODO: Explore replicating the new behavior from Click, pay attention to 

134 # the difference with and without formatted help 

135 # if item.help: 

136 # return f"{item.type},{item.value}\t{item.help}" 

137 

138 # return f"{item.type},{item.value} 

139 if item.help: 8 ctx1habcdefg

140 formatted_help = re.sub(r"\s", " ", item.help) 8 ctx1habcdefg

141 return f"{item.value}\t{formatted_help}" 8 ctx1habcdefg

142 else: 

143 return f"{item.value}" 8 ctx1habcdefg

144 

145 def complete(self) -> str: 8 ctx1habcdefg

146 complete_action = os.getenv("_TYPER_COMPLETE_FISH_ACTION", "") 8 ctx1habcdefg

147 args, incomplete = self.get_completion_args() 8 ctx1habcdefg

148 completions = self.get_completions(args, incomplete) 8 ctx1habcdefg

149 show_args = [self.format_completion(item) for item in completions] 8 ctx1habcdefg

150 if complete_action == "get-args": 8 ctx1habcdefg

151 if show_args: 8 ctx1habcdefg

152 return "\n".join(show_args) 8 ctx1habcdefg

153 elif complete_action == "is-args": 8 ctx1habcdefg

154 if show_args: 8 ctx1habcdefg

155 # Activate complete args (no files) 

156 sys.exit(0) 8 ctx1habcdefg

157 else: 

158 # Deactivate complete args (allow files) 

159 sys.exit(1) 8 ctx1habcdefg

160 return "" # pragma: no cover 

161 

162 

163class PowerShellComplete(click.shell_completion.ShellComplete): 8 ctx1habcdefg

164 name = Shells.powershell.value 8 ctx1habcdefg

165 source_template = COMPLETION_SCRIPT_POWER_SHELL 8 ctx1habcdefg

166 

167 def source_vars(self) -> Dict[str, Any]: 8 ctx1habcdefg

168 return { 7 ctx1abcdefg

169 "complete_func": self.func_name, 

170 "autocomplete_var": self.complete_var, 

171 "prog_name": self.prog_name, 

172 } 

173 

174 def get_completion_args(self) -> Tuple[List[str], str]: 8 ctx1habcdefg

175 completion_args = os.getenv("_TYPER_COMPLETE_ARGS", "") 8 ctx1habcdefg

176 incomplete = os.getenv("_TYPER_COMPLETE_WORD_TO_COMPLETE", "") 8 ctx1habcdefg

177 cwords = click.parser.split_arg_string(completion_args) 8 ctx1habcdefg

178 args = cwords[1:-1] if incomplete else cwords[1:] 8 ctx1habcdefg

179 return args, incomplete 8 ctx1habcdefg

180 

181 def format_completion(self, item: click.shell_completion.CompletionItem) -> str: 8 ctx1habcdefg

182 return f"{item.value}:::{item.help or ' '}" 8 ctx1habcdefg

183 

184 

185def completion_init() -> None: 8 ctx1habcdefg

186 click.shell_completion.add_completion_class(BashComplete, Shells.bash.value) 8 ctx1habcdefg

187 click.shell_completion.add_completion_class(ZshComplete, Shells.zsh.value) 8 ctx1habcdefg

188 click.shell_completion.add_completion_class(FishComplete, Shells.fish.value) 8 ctx1habcdefg

189 click.shell_completion.add_completion_class( 8 ctx1habcdefg

190 PowerShellComplete, Shells.powershell.value 

191 ) 

192 click.shell_completion.add_completion_class(PowerShellComplete, Shells.pwsh.value) 8 ctx1habcdefg