Coverage for typer / _completion_classes.py: 100%
128 statements
« prev ^ index » next coverage.py v7.13.1, created at 2026-11-18 11:12 +0000
« prev ^ index » next coverage.py v7.13.1, created at 2026-11-18 11:12 +0000
1import importlib.util 1defghijabc
2import os 1defghijabc
3import re 1defghijabc
4import sys 1defghijabc
5from typing import Any 1defghijabc
7from . import _click 1defghijabc
8from ._click.shell_completion import CompletionItem, ShellComplete, add_completion_class 1defghijabc
9from ._click.shell_completion import split_arg_string as click_split_arg_string 1defghijabc
10from ._completion_shared import ( 1defghijabc
11 COMPLETION_SCRIPT_BASH,
12 COMPLETION_SCRIPT_FISH,
13 COMPLETION_SCRIPT_POWER_SHELL,
14 COMPLETION_SCRIPT_ZSH,
15 Shells,
16)
19def _sanitize_help_text(text: str) -> str: 1defghijabc
20 """Sanitizes the help text by removing rich tags"""
21 if not importlib.util.find_spec("rich"): 1defghijabc
22 return text 1defghijabc
23 from . import rich_utils 1defghijabc
25 return rich_utils.rich_render_text(text) 1defghijabc
28class BashComplete(ShellComplete): 1defghijabc
29 name = Shells.bash.value 1defghijabc
30 source_template = COMPLETION_SCRIPT_BASH 1defghijabc
32 def source_vars(self) -> dict[str, Any]: 1defghijabc
33 return { 1defghijabc
34 "complete_func": self.func_name,
35 "autocomplete_var": self.complete_var,
36 "prog_name": self.prog_name,
37 }
39 def get_completion_args(self) -> tuple[list[str], str]: 1defghijabc
40 cwords = click_split_arg_string(os.environ["COMP_WORDS"]) 1defghijabc
41 cword = int(os.environ["COMP_CWORD"]) 1defghijabc
42 args = cwords[1:cword] 1defghijabc
44 try: 1defghijabc
45 incomplete = cwords[cword] 1defghijabc
46 except IndexError: 1defghijabc
47 incomplete = "" 1defghijabc
49 return args, incomplete 1defghijabc
51 def format_completion(self, item: CompletionItem) -> str: 1defghijabc
52 # TODO: Explore replicating the new behavior from Click, with item types and
53 # triggering completion for files and directories
54 # return f"{item.type},{item.value}"
55 return f"{item.value}" 1defghijabc
57 def complete(self) -> str: 1defghijabc
58 args, incomplete = self.get_completion_args() 1defghijabc
59 completions = self.get_completions(args, incomplete) 1defghijabc
60 out = [self.format_completion(item) for item in completions] 1defghijabc
61 return "\n".join(out) 1defghijabc
63 @staticmethod 1defghijabc
64 def _check_version() -> None: 1defghijabc
65 import shutil 1defghijabc
66 import subprocess 1defghijabc
68 bash_exe = shutil.which("bash") 1defghijabc
70 if bash_exe is None: 1defghijabc
71 match = None # pragma: no cover
72 else:
73 output = subprocess.run( 1defghijabc
74 [bash_exe, "--norc", "-c", 'echo "${BASH_VERSION}"'],
75 stdout=subprocess.PIPE,
76 )
77 match = re.search(r"^(\d+)\.(\d+)\.\d+", output.stdout.decode()) 1defghijabc
79 if match is not None: 1defghijabc
80 major, minor = match.groups() 1defghijabc
82 if major < "4" or major == "4" and minor < "4": 1defghijabc
83 _click.utils.echo( 1abc
84 "Shell completion is not supported for Bash versions older than 4.4.",
85 err=True,
86 )
87 else:
88 _click.utils.echo(
89 "Couldn't detect Bash version, shell completion is not supported.",
90 err=True,
91 ) # pragma: no cover
93 def source(self) -> str: 1defghijabc
94 self._check_version() 1defghijabc
95 return super().source() 1defghijabc
98class ZshComplete(ShellComplete): 1defghijabc
99 name = Shells.zsh.value 1defghijabc
100 source_template = COMPLETION_SCRIPT_ZSH 1defghijabc
102 def source_vars(self) -> dict[str, Any]: 1defghijabc
103 return { 1defghijabc
104 "complete_func": self.func_name,
105 "autocomplete_var": self.complete_var,
106 "prog_name": self.prog_name,
107 }
109 def get_completion_args(self) -> tuple[list[str], str]: 1defghijabc
110 completion_args = os.getenv("_TYPER_COMPLETE_ARGS", "") 1defghijabc
111 cwords = click_split_arg_string(completion_args) 1defghijabc
112 args = cwords[1:] 1defghijabc
113 if args and not completion_args.endswith(" "): 1defghijabc
114 incomplete = args[-1] 1defghijabc
115 args = args[:-1] 1defghijabc
116 else:
117 incomplete = "" 1defghijabc
118 return args, incomplete 1defghijabc
120 def format_completion(self, item: CompletionItem) -> str: 1defghijabc
121 def escape(s: str) -> str: 1defghijabc
122 return ( 1defghijabc
123 s.replace('"', '""')
124 .replace("'", "''")
125 .replace("$", "\\$")
126 .replace("`", "\\`")
127 .replace(":", r"\\:")
128 )
130 # TODO: Explore replicating the new behavior from Click, pay attention to
131 # the difference with and without escape
132 # return f"{item.type}\n{item.value}\n{item.help if item.help else '_'}"
133 if item.help: 1defghijabc
134 return f'"{escape(item.value)}":"{_sanitize_help_text(escape(item.help))}"' 1defghijabc
135 else:
136 return f'"{escape(item.value)}"' 1defghijabc
138 def complete(self) -> str: 1defghijabc
139 args, incomplete = self.get_completion_args() 1defghijabc
140 completions = self.get_completions(args, incomplete) 1defghijabc
141 res = [self.format_completion(item) for item in completions] 1defghijabc
142 if res: 1defghijabc
143 args_str = "\n".join(res) 1defghijabc
144 return f"_arguments '*: :(({args_str}))'" 1defghijabc
145 else:
146 return "_files" 1defghijabc
149class FishComplete(ShellComplete): 1defghijabc
150 name = Shells.fish.value 1defghijabc
151 source_template = COMPLETION_SCRIPT_FISH 1defghijabc
153 def source_vars(self) -> dict[str, Any]: 1defghijabc
154 return { 1defghijabc
155 "complete_func": self.func_name,
156 "autocomplete_var": self.complete_var,
157 "prog_name": self.prog_name,
158 }
160 def get_completion_args(self) -> tuple[list[str], str]: 1defghijabc
161 completion_args = os.getenv("_TYPER_COMPLETE_ARGS", "") 1defghijabc
162 cwords = click_split_arg_string(completion_args) 1defghijabc
163 args = cwords[1:] 1defghijabc
164 if args and not completion_args.endswith(" "): 1defghijabc
165 incomplete = args[-1] 1defghijabc
166 args = args[:-1] 1defghijabc
167 else:
168 incomplete = "" 1defghijabc
169 return args, incomplete 1defghijabc
171 def format_completion(self, item: CompletionItem) -> str: 1defghijabc
172 # TODO: Explore replicating the new behavior from Click, pay attention to
173 # the difference with and without formatted help
174 # if item.help:
175 # return f"{item.type},{item.value}\t{item.help}"
177 # return f"{item.type},{item.value}
178 if item.help: 1defghijabc
179 formatted_help = re.sub(r"\s", " ", item.help) 1defghijabc
180 return f"{item.value}\t{_sanitize_help_text(formatted_help)}" 1defghijabc
181 else:
182 return f"{item.value}" 1defghijabc
184 def complete(self) -> str: 1defghijabc
185 complete_action = os.getenv("_TYPER_COMPLETE_FISH_ACTION", "") 1defghijabc
186 args, incomplete = self.get_completion_args() 1defghijabc
187 completions = self.get_completions(args, incomplete) 1defghijabc
188 show_args = [self.format_completion(item) for item in completions] 1defghijabc
189 if complete_action == "get-args": 1defghijabc
190 if show_args: 1defghijabc
191 return "\n".join(show_args) 1defghijabc
192 elif complete_action == "is-args": 1defghijabc
193 if show_args: 1defghijabc
194 # Activate complete args (no files)
195 sys.exit(0) 1defghijabc
196 else:
197 # Deactivate complete args (allow files)
198 sys.exit(1) 1defghijabc
199 return "" # pragma: no cover
202class PowerShellComplete(ShellComplete): 1defghijabc
203 name = Shells.powershell.value 1defghijabc
204 source_template = COMPLETION_SCRIPT_POWER_SHELL 1defghijabc
206 def source_vars(self) -> dict[str, Any]: 1defghijabc
207 return { 1defghijabc
208 "complete_func": self.func_name,
209 "autocomplete_var": self.complete_var,
210 "prog_name": self.prog_name,
211 }
213 def get_completion_args(self) -> tuple[list[str], str]: 1defghijabc
214 completion_args = os.getenv("_TYPER_COMPLETE_ARGS", "") 1defghijabc
215 incomplete = os.getenv("_TYPER_COMPLETE_WORD_TO_COMPLETE", "") 1defghijabc
216 cwords = click_split_arg_string(completion_args) 1defghijabc
217 args = cwords[1:-1] if incomplete else cwords[1:] 1defghijabc
218 return args, incomplete 1defghijabc
220 def format_completion(self, item: CompletionItem) -> str: 1defghijabc
221 return f"{item.value}:::{_sanitize_help_text(item.help) if item.help else ' '}" 1defghijabc
224def completion_init() -> None: 1defghijabc
225 add_completion_class(BashComplete, Shells.bash.value) 1defghijabc
226 add_completion_class(ZshComplete, Shells.zsh.value) 1defghijabc
227 add_completion_class(FishComplete, Shells.fish.value) 1defghijabc
228 add_completion_class(PowerShellComplete, Shells.powershell.value) 1defghijabc
229 add_completion_class(PowerShellComplete, Shells.pwsh.value) 1defghijabc