Coverage for typer / _completion_classes.py: 100%

1import importlib.util 8 ctx1abcdefgh

2import os 8 ctx1abcdefgh

3import re 8 ctx1abcdefgh

4import sys 8 ctx1abcdefgh

5from typing import Any 8 ctx1abcdefgh

6 

7import click 8 ctx1abcdefgh

8import click.parser 8 ctx1abcdefgh

9import click.shell_completion 8 ctx1abcdefgh

10 

11from ._completion_shared import ( 8 ctx1abcdefgh

12 COMPLETION_SCRIPT_BASH, 

13 COMPLETION_SCRIPT_FISH, 

14 COMPLETION_SCRIPT_POWER_SHELL, 

15 COMPLETION_SCRIPT_ZSH, 

16 Shells, 

17) 

18 

19try: 8 ctx1abcdefgh

20 from click.shell_completion import split_arg_string as click_split_arg_string 8 ctx1abcdefgh

21except ImportError: # pragma: no cover 

22 # TODO: when removing support for Click < 8.2, remove this import 

23 from click.parser import ( # type: ignore[no-redef] 

24 split_arg_string as click_split_arg_string, 

25 ) 

26 

27 

28def _sanitize_help_text(text: str) -> str: 8 ctx1abcdefgh

29 """Sanitizes the help text by removing rich tags""" 

30 if not importlib.util.find_spec("rich"): 8 ctx1abcdefgh

31 return text 8 ctx1abcdefgh

32 from . import rich_utils 8 ctx1abcdefgh

33 

34 return rich_utils.rich_render_text(text) 8 ctx1abcdefgh

35 

36 

37class BashComplete(click.shell_completion.BashComplete): 8 ctx1abcdefgh

38 name = Shells.bash.value 8 ctx1abcdefgh

39 source_template = COMPLETION_SCRIPT_BASH 8 ctx1abcdefgh

40 

41 def source_vars(self) -> dict[str, Any]: 8 ctx1abcdefgh

42 return { 8 ctx1abcdefgh

43 "complete_func": self.func_name, 

44 "autocomplete_var": self.complete_var, 

45 "prog_name": self.prog_name, 

46 } 

47 

48 def get_completion_args(self) -> tuple[list[str], str]: 8 ctx1abcdefgh

49 cwords = click_split_arg_string(os.environ["COMP_WORDS"]) 8 ctx1abcdefgh

50 cword = int(os.environ["COMP_CWORD"]) 8 ctx1abcdefgh

51 args = cwords[1:cword] 8 ctx1abcdefgh

52 

53 try: 8 ctx1abcdefgh

54 incomplete = cwords[cword] 8 ctx1abcdefgh

55 except IndexError: 8 ctx1abcdefgh

56 incomplete = "" 8 ctx1abcdefgh

57 

58 return args, incomplete 8 ctx1abcdefgh

59 

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

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

62 # triggering completion for files and directories 

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

64 return f"{item.value}" 8 ctx1abcdefgh

65 

66 def complete(self) -> str: 8 ctx1abcdefgh

67 args, incomplete = self.get_completion_args() 8 ctx1abcdefgh

68 completions = self.get_completions(args, incomplete) 8 ctx1abcdefgh

69 out = [self.format_completion(item) for item in completions] 8 ctx1abcdefgh

70 return "\n".join(out) 8 ctx1abcdefgh

71 

72 

73class ZshComplete(click.shell_completion.ZshComplete): 8 ctx1abcdefgh

74 name = Shells.zsh.value 8 ctx1abcdefgh

75 source_template = COMPLETION_SCRIPT_ZSH 8 ctx1abcdefgh

76 

77 def source_vars(self) -> dict[str, Any]: 8 ctx1abcdefgh

78 return { 8 ctx1abcdefgh

79 "complete_func": self.func_name, 

80 "autocomplete_var": self.complete_var, 

81 "prog_name": self.prog_name, 

82 } 

83 

84 def get_completion_args(self) -> tuple[list[str], str]: 8 ctx1abcdefgh

85 completion_args = os.getenv("_TYPER_COMPLETE_ARGS", "") 8 ctx1abcdefgh

86 cwords = click_split_arg_string(completion_args) 8 ctx1abcdefgh

87 args = cwords[1:] 8 ctx1abcdefgh

88 if args and not completion_args.endswith(" "): 8 ctx1abcdefgh

89 incomplete = args[-1] 8 ctx1abcdefgh

90 args = args[:-1] 8 ctx1abcdefgh

91 else: 

92 incomplete = "" 8 ctx1abcdefgh

93 return args, incomplete 8 ctx1abcdefgh

94 

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

96 def escape(s: str) -> str: 8 ctx1abcdefgh

97 return ( 8 ctx1abcdefgh

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

99 .replace("'", "''") 

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

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

102 .replace(":", r"\\:") 

103 ) 

104 

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

106 # the difference with and without escape 

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

108 if item.help: 8 ctx1abcdefgh

109 return f'"{escape(item.value)}":"{_sanitize_help_text(escape(item.help))}"' 8 ctx1abcdefgh

110 else: 

111 return f'"{escape(item.value)}"' 8 ctx1abcdefgh

112 

113 def complete(self) -> str: 8 ctx1abcdefgh

114 args, incomplete = self.get_completion_args() 8 ctx1abcdefgh

115 completions = self.get_completions(args, incomplete) 8 ctx1abcdefgh

116 res = [self.format_completion(item) for item in completions] 8 ctx1abcdefgh

117 if res: 8 ctx1abcdefgh

118 args_str = "\n".join(res) 8 ctx1abcdefgh

119 return f"_arguments '*: :(({args_str}))'" 8 ctx1abcdefgh

120 else: 

121 return "_files" 8 ctx1abcdefgh

122 

123 

124class FishComplete(click.shell_completion.FishComplete): 8 ctx1abcdefgh

125 name = Shells.fish.value 8 ctx1abcdefgh

126 source_template = COMPLETION_SCRIPT_FISH 8 ctx1abcdefgh

127 

128 def source_vars(self) -> dict[str, Any]: 8 ctx1abcdefgh

129 return { 8 ctx1abcdefgh

130 "complete_func": self.func_name, 

131 "autocomplete_var": self.complete_var, 

132 "prog_name": self.prog_name, 

133 } 

134 

135 def get_completion_args(self) -> tuple[list[str], str]: 8 ctx1abcdefgh

136 completion_args = os.getenv("_TYPER_COMPLETE_ARGS", "") 8 ctx1abcdefgh

137 cwords = click_split_arg_string(completion_args) 8 ctx1abcdefgh

138 args = cwords[1:] 8 ctx1abcdefgh

139 if args and not completion_args.endswith(" "): 8 ctx1abcdefgh

140 incomplete = args[-1] 8 ctx1abcdefgh

141 args = args[:-1] 8 ctx1abcdefgh

142 else: 

143 incomplete = "" 8 ctx1abcdefgh

144 return args, incomplete 8 ctx1abcdefgh

145 

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

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

148 # the difference with and without formatted help 

149 # if item.help: 

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

151 

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

153 if item.help: 8 ctx1abcdefgh

154 formatted_help = re.sub(r"\s", " ", item.help) 8 ctx1abcdefgh

155 return f"{item.value}\t{_sanitize_help_text(formatted_help)}" 8 ctx1abcdefgh

156 else: 

157 return f"{item.value}" 8 ctx1abcdefgh

158 

159 def complete(self) -> str: 8 ctx1abcdefgh

160 complete_action = os.getenv("_TYPER_COMPLETE_FISH_ACTION", "") 8 ctx1abcdefgh

161 args, incomplete = self.get_completion_args() 8 ctx1abcdefgh

162 completions = self.get_completions(args, incomplete) 8 ctx1abcdefgh

163 show_args = [self.format_completion(item) for item in completions] 8 ctx1abcdefgh

164 if complete_action == "get-args": 8 ctx1abcdefgh

165 if show_args: 8 ctx1abcdefgh

166 return "\n".join(show_args) 8 ctx1abcdefgh

167 elif complete_action == "is-args": 8 ctx1abcdefgh

168 if show_args: 8 ctx1abcdefgh

169 # Activate complete args (no files) 

170 sys.exit(0) 8 ctx1abcdefgh

171 else: 

172 # Deactivate complete args (allow files) 

173 sys.exit(1) 8 ctx1abcdefgh

174 return "" # pragma: no cover 

175 

176 

177class PowerShellComplete(click.shell_completion.ShellComplete): 8 ctx1abcdefgh

178 name = Shells.powershell.value 8 ctx1abcdefgh

179 source_template = COMPLETION_SCRIPT_POWER_SHELL 8 ctx1abcdefgh

180 

181 def source_vars(self) -> dict[str, Any]: 8 ctx1abcdefgh

182 return { 8 ctx1abcdefgh

183 "complete_func": self.func_name, 

184 "autocomplete_var": self.complete_var, 

185 "prog_name": self.prog_name, 

186 } 

187 

188 def get_completion_args(self) -> tuple[list[str], str]: 8 ctx1abcdefgh

189 completion_args = os.getenv("_TYPER_COMPLETE_ARGS", "") 8 ctx1abcdefgh

190 incomplete = os.getenv("_TYPER_COMPLETE_WORD_TO_COMPLETE", "") 8 ctx1abcdefgh

191 cwords = click_split_arg_string(completion_args) 8 ctx1abcdefgh

192 args = cwords[1:-1] if incomplete else cwords[1:] 8 ctx1abcdefgh

193 return args, incomplete 8 ctx1abcdefgh

194 

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

196 return f"{item.value}:::{_sanitize_help_text(item.help) if item.help else ' '}" 8 ctx1abcdefgh

197 

198 

199def completion_init() -> None: 8 ctx1abcdefgh

200 click.shell_completion.add_completion_class(BashComplete, Shells.bash.value) 8 ctx1abcdefgh

201 click.shell_completion.add_completion_class(ZshComplete, Shells.zsh.value) 8 ctx1abcdefgh

202 click.shell_completion.add_completion_class(FishComplete, Shells.fish.value) 8 ctx1abcdefgh

203 click.shell_completion.add_completion_class( 8 ctx1abcdefgh

204 PowerShellComplete, Shells.powershell.value 

205 ) 

206 click.shell_completion.add_completion_class(PowerShellComplete, Shells.pwsh.value) 8 ctx1abcdefgh