1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
|
import os
import sys
from pathlib import Path
from typing import TYPE_CHECKING, Tuple, Union
import pytest
from tests.conftest import ScriptFactory
from tests.lib import PipTestEnvironment, TestData, TestPipResult
if TYPE_CHECKING:
from typing import Protocol
else:
# TODO: Protocol was introduced in Python 3.8. Remove this branch when
# dropping support for Python 3.7.
Protocol = object
COMPLETION_FOR_SUPPORTED_SHELLS_TESTS = (
(
"bash",
"""\
_pip_completion()
{
COMPREPLY=( $( COMP_WORDS="${COMP_WORDS[*]}" \\
COMP_CWORD=$COMP_CWORD \\
PIP_AUTO_COMPLETE=1 $1 2>/dev/null ) )
}
complete -o default -F _pip_completion pip""",
),
(
"fish",
"""\
function __fish_complete_pip
set -lx COMP_WORDS (commandline -o) ""
set -lx COMP_CWORD ( \\
math (contains -i -- (commandline -t) $COMP_WORDS)-1 \\
)
set -lx PIP_AUTO_COMPLETE 1
string split \\ -- (eval $COMP_WORDS[1])
end
complete -fa "(__fish_complete_pip)" -c pip""",
),
(
"zsh",
"""\
function _pip_completion {
local words cword
read -Ac words
read -cn cword
reply=( $( COMP_WORDS="$words[*]" \\
COMP_CWORD=$(( cword-1 )) \\
PIP_AUTO_COMPLETE=1 $words[1] 2>/dev/null ))
}
compctl -K _pip_completion pip""",
),
(
"powershell",
"""\
if ((Test-Path Function:\\TabExpansion) -and -not `
(Test-Path Function:\\_pip_completeBackup)) {
Rename-Item Function:\\TabExpansion _pip_completeBackup
}
function TabExpansion($line, $lastWord) {
$lastBlock = [regex]::Split($line, '[|;]')[-1].TrimStart()
if ($lastBlock.StartsWith("pip ")) {
$Env:COMP_WORDS=$lastBlock
$Env:COMP_CWORD=$lastBlock.Split().Length - 1
$Env:PIP_AUTO_COMPLETE=1
(& pip).Split()
Remove-Item Env:COMP_WORDS
Remove-Item Env:COMP_CWORD
Remove-Item Env:PIP_AUTO_COMPLETE
}
elseif (Test-Path Function:\\_pip_completeBackup) {
# Fall back on existing tab expansion
_pip_completeBackup $line $lastWord
}
}""",
),
)
@pytest.fixture(scope="session")
def script_with_launchers(
tmpdir_factory: pytest.TempPathFactory,
script_factory: ScriptFactory,
common_wheels: Path,
pip_src: Path,
) -> PipTestEnvironment:
tmpdir = tmpdir_factory.mktemp("script_with_launchers")
script = script_factory(tmpdir.joinpath("workspace"))
# Re-install pip so we get the launchers.
script.pip_install_local("-f", common_wheels, pip_src)
return script
@pytest.mark.parametrize(
"shell, completion",
COMPLETION_FOR_SUPPORTED_SHELLS_TESTS,
ids=[t[0] for t in COMPLETION_FOR_SUPPORTED_SHELLS_TESTS],
)
def test_completion_for_supported_shells(
script_with_launchers: PipTestEnvironment, shell: str, completion: str
) -> None:
"""
Test getting completion for bash shell
"""
result = script_with_launchers.pip("completion", "--" + shell, use_module=False)
actual = str(result.stdout)
if script_with_launchers.zipapp:
# The zipapp reports its name as "pip.pyz", but the expected
# output assumes "pip"
actual = actual.replace("pip.pyz", "pip")
assert completion in actual, actual
@pytest.fixture(scope="session")
def autocomplete_script(
tmpdir_factory: pytest.TempPathFactory, script_factory: ScriptFactory
) -> PipTestEnvironment:
tmpdir = tmpdir_factory.mktemp("autocomplete_script")
return script_factory(tmpdir.joinpath("workspace"))
class DoAutocomplete(Protocol):
def __call__(
self, words: str, cword: str, cwd: Union[Path, str, None] = None
) -> Tuple[TestPipResult, PipTestEnvironment]:
...
@pytest.fixture
def autocomplete(
autocomplete_script: PipTestEnvironment, monkeypatch: pytest.MonkeyPatch
) -> DoAutocomplete:
monkeypatch.setattr(autocomplete_script, "environ", os.environ.copy())
autocomplete_script.environ["PIP_AUTO_COMPLETE"] = "1"
def do_autocomplete(
words: str, cword: str, cwd: Union[Path, str, None] = None
) -> Tuple[TestPipResult, PipTestEnvironment]:
autocomplete_script.environ["COMP_WORDS"] = words
autocomplete_script.environ["COMP_CWORD"] = cword
result = autocomplete_script.run(
"python",
"-c",
"from pip._internal.cli.autocompletion import autocomplete;"
"autocomplete()",
expect_error=True,
cwd=cwd,
)
return result, autocomplete_script
return do_autocomplete
def test_completion_for_unknown_shell(autocomplete_script: PipTestEnvironment) -> None:
"""
Test getting completion for an unknown shell
"""
error_msg = "no such option: --myfooshell"
result = autocomplete_script.pip("completion", "--myfooshell", expect_error=True)
assert error_msg in result.stderr, "tests for an unknown shell failed"
def test_completion_alone(autocomplete_script: PipTestEnvironment) -> None:
"""
Test getting completion for none shell, just pip completion
"""
result = autocomplete_script.pip("completion", allow_stderr_error=True)
assert (
"ERROR: You must pass --bash or --fish or --powershell or --zsh"
in result.stderr
), ("completion alone failed -- " + result.stderr)
def test_completion_for_un_snippet(autocomplete: DoAutocomplete) -> None:
"""
Test getting completion for ``un`` should return uninstall
"""
res, env = autocomplete("pip un", "1")
assert res.stdout.strip().split() == ["uninstall"], res.stdout
def test_completion_for_default_parameters(autocomplete: DoAutocomplete) -> None:
"""
Test getting completion for ``--`` should contain --help
"""
res, env = autocomplete("pip --", "1")
assert "--help" in res.stdout, "autocomplete function could not complete ``--``"
def test_completion_option_for_command(autocomplete: DoAutocomplete) -> None:
"""
Test getting completion for ``--`` in command (e.g. ``pip search --``)
"""
res, env = autocomplete("pip search --", "2")
assert "--help" in res.stdout, "autocomplete function could not complete ``--``"
def test_completion_short_option(autocomplete: DoAutocomplete) -> None:
"""
Test getting completion for short options after ``-`` (eg. pip -)
"""
res, env = autocomplete("pip -", "1")
assert (
"-h" in res.stdout.split()
), "autocomplete function could not complete short options after ``-``"
def test_completion_short_option_for_command(autocomplete: DoAutocomplete) -> None:
"""
Test getting completion for short options after ``-`` in command
(eg. pip search -)
"""
res, env = autocomplete("pip search -", "2")
assert (
"-h" in res.stdout.split()
), "autocomplete function could not complete short options after ``-``"
def test_completion_files_after_option(
autocomplete: DoAutocomplete, data: TestData
) -> None:
"""
Test getting completion for <file> or <dir> after options in command
(e.g. ``pip install -r``)
"""
res, env = autocomplete(
words=("pip install -r r"),
cword="3",
cwd=data.completion_paths,
)
assert (
"requirements.txt" in res.stdout
), "autocomplete function could not complete <file> after options in command"
assert (
os.path.join("resources", "") in res.stdout
), "autocomplete function could not complete <dir> after options in command"
assert not any(
out in res.stdout for out in (os.path.join("REPLAY", ""), "README.txt")
), (
"autocomplete function completed <file> or <dir> that "
"should not be completed"
)
if sys.platform != "win32":
return
assert (
"readme.txt" in res.stdout
), "autocomplete function could not complete <file> after options in command"
assert (
os.path.join("replay", "") in res.stdout
), "autocomplete function could not complete <dir> after options in command"
def test_completion_not_files_after_option(
autocomplete: DoAutocomplete, data: TestData
) -> None:
"""
Test not getting completion files after options which not applicable
(e.g. ``pip wheel``)
"""
res, env = autocomplete(
words=("pip wheel r"),
cword="2",
cwd=data.completion_paths,
)
assert not any(
out in res.stdout
for out in (
"requirements.txt",
"readme.txt",
)
), "autocomplete function completed <file> when it should not complete"
assert not any(
os.path.join(out, "") in res.stdout for out in ("replay", "resources")
), "autocomplete function completed <dir> when it should not complete"
def test_pip_install_complete_files(
autocomplete: DoAutocomplete, data: TestData
) -> None:
"""``pip install`` autocompletes wheel and sdist files."""
res, env = autocomplete(
words=("pip install r"),
cword="2",
cwd=data.completion_paths,
)
assert all(
out in res.stdout
for out in (
"requirements.txt",
"resources",
)
), "autocomplete function could not complete <path>"
@pytest.mark.parametrize("cl_opts", ["-U", "--user", "-h"])
def test_completion_not_files_after_nonexpecting_option(
autocomplete: DoAutocomplete, data: TestData, cl_opts: str
) -> None:
"""
Test not getting completion files after options which not applicable
(e.g. ``pip install``)
"""
res, env = autocomplete(
words=(f"pip install {cl_opts} r"),
cword="2",
cwd=data.completion_paths,
)
assert not any(
out in res.stdout
for out in (
"requirements.txt",
"readme.txt",
)
), "autocomplete function completed <file> when it should not complete"
assert not any(
os.path.join(out, "") in res.stdout for out in ("replay", "resources")
), "autocomplete function completed <dir> when it should not complete"
def test_completion_directories_after_option(
autocomplete: DoAutocomplete, data: TestData
) -> None:
"""
Test getting completion <dir> after options in command
(e.g. ``pip --cache-dir``)
"""
res, env = autocomplete(
words=("pip --cache-dir r"),
cword="2",
cwd=data.completion_paths,
)
assert (
os.path.join("resources", "") in res.stdout
), "autocomplete function could not complete <dir> after options"
assert not any(
out in res.stdout
for out in ("requirements.txt", "README.txt", os.path.join("REPLAY", ""))
), "autocomplete function completed <dir> when it should not complete"
if sys.platform == "win32":
assert (
os.path.join("replay", "") in res.stdout
), "autocomplete function could not complete <dir> after options"
def test_completion_subdirectories_after_option(
autocomplete: DoAutocomplete, data: TestData
) -> None:
"""
Test getting completion <dir> after options in command
given path of a directory
"""
res, env = autocomplete(
words=("pip --cache-dir " + os.path.join("resources", "")),
cword="2",
cwd=data.completion_paths,
)
assert os.path.join("resources", os.path.join("images", "")) in res.stdout, (
"autocomplete function could not complete <dir> "
"given path of a directory after options"
)
def test_completion_path_after_option(
autocomplete: DoAutocomplete, data: TestData
) -> None:
"""
Test getting completion <path> after options in command
given absolute path
"""
res, env = autocomplete(
words=("pip install -e " + os.path.join(data.completion_paths, "R")),
cword="3",
)
assert all(
os.path.normcase(os.path.join(data.completion_paths, out)) in res.stdout
for out in ("README.txt", os.path.join("REPLAY", ""))
), (
"autocomplete function could not complete <path> "
"after options in command given absolute path"
)
@pytest.mark.parametrize("flag", ["--bash", "--zsh", "--fish", "--powershell"])
def test_completion_uses_same_executable_name(
autocomplete_script: PipTestEnvironment, flag: str, deprecated_python: bool
) -> None:
executable_name = "pip{}".format(sys.version_info[0])
# Deprecated python versions produce an extra deprecation warning
result = autocomplete_script.run(
executable_name,
"completion",
flag,
expect_stderr=deprecated_python,
)
assert executable_name in result.stdout
|