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 .replace(":", r"\\:") 

90 ) 

91 

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

93 # the difference with and without escape 

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

95 if item.help: 8 ctx1habcdefg

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

97 else: 

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

99 

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

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

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

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

104 if res: 8 ctx1habcdefg

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

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

107 else: 

108 return "_files" 8 ctx1habcdefg

109 

110 

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

112 name = Shells.fish.value 8 ctx1habcdefg

113 source_template = COMPLETION_SCRIPT_FISH 8 ctx1habcdefg

114 

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

116 return { 7 ctx1abcdefg

117 "complete_func": self.func_name, 

118 "autocomplete_var": self.complete_var, 

119 "prog_name": self.prog_name, 

120 } 

121 

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

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

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

125 args = cwords[1:] 8 ctx1habcdefg

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

127 incomplete = args[-1] 8 ctx1habcdefg

128 args = args[:-1] 8 ctx1habcdefg

129 else: 

130 incomplete = "" 8 ctx1habcdefg

131 return args, incomplete 8 ctx1habcdefg

132 

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

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

135 # the difference with and without formatted help 

136 # if item.help: 

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

138 

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

140 if item.help: 8 ctx1habcdefg

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

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

143 else: 

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

145 

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

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

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

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

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

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

152 if show_args: 8 ctx1habcdefg

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

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

155 if show_args: 8 ctx1habcdefg

156 # Activate complete args (no files) 

157 sys.exit(0) 8 ctx1habcdefg

158 else: 

159 # Deactivate complete args (allow files) 

160 sys.exit(1) 8 ctx1habcdefg

161 return "" # pragma: no cover 

162 

163 

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

165 name = Shells.powershell.value 8 ctx1habcdefg

166 source_template = COMPLETION_SCRIPT_POWER_SHELL 8 ctx1habcdefg

167 

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

169 return { 7 ctx1abcdefg

170 "complete_func": self.func_name, 

171 "autocomplete_var": self.complete_var, 

172 "prog_name": self.prog_name, 

173 } 

174 

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

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

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

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

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

180 return args, incomplete 8 ctx1habcdefg

181 

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

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

184 

185 

186def completion_init() -> None: 8 ctx1habcdefg

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

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

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

190 click.shell_completion.add_completion_class( 8 ctx1habcdefg

191 PowerShellComplete, Shells.powershell.value 

192 ) 

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