This repository was archived by the owner on Jan 24, 2025. It is now read-only.
Repository navigation
Expand file tree
/
Copy pathtest_completion.py
More file actions
598 lines (472 loc) · 20.3 KB
/
Copy pathtest_completion.py
File metadata and controls
598 lines (472 loc) · 20.3 KB
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
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# Copyright 2017-2020 Palantir Technologies, Inc.
# Copyright 2021- Python Language Server Contributors.
import math
import os
import sys
from pathlib import Path
from typing import Dict, NamedTuple
import pytest
from pylsp import lsp, uris
from pylsp._utils import JEDI_VERSION
from pylsp.plugins.jedi_completion import (
pylsp_completion_item_resolve as pylsp_jedi_completion_item_resolve,
)
from pylsp.plugins.jedi_completion import pylsp_completions as pylsp_jedi_completions
from pylsp.plugins.rope_completion import pylsp_completions as pylsp_rope_completions
from pylsp.workspace import Document
PY2 = sys.version[0] == "2"
LINUX = sys.platform.startswith("linux")
CI = os.environ.get("CI")
LOCATION = os.path.realpath(os.path.join(os.getcwd(), os.path.dirname(__file__)))
DOC_URI = uris.from_fs_path(__file__)
DOC = """import os
print os.path.isabs("/tmp")
def hello():
pass
def _a_hello():
pass
class Hello():
@property
def world(self):
return None
def everyone(self, a, b, c=None, d=2):
pass
print Hello().world
print Hello().every
def documented_hello():
\"\"\"Sends a polite greeting\"\"\"
pass
"""
def test_rope_import_completion(config, workspace) -> None:
com_position = {"line": 0, "character": 7}
doc = Document(DOC_URI, workspace, DOC)
items = pylsp_rope_completions(config, workspace, doc, com_position)
assert items is None
class TypeCase(NamedTuple):
document: str
position: dict
label: str
expected: lsp.CompletionItemKind
TYPE_CASES: Dict[str, TypeCase] = {
"variable": TypeCase(
document="test = 1\ntes",
position={"line": 1, "character": 3},
label="test",
expected=lsp.CompletionItemKind.Variable,
),
"function": TypeCase(
document="def test():\n pass\ntes",
position={"line": 2, "character": 3},
label="test()",
expected=lsp.CompletionItemKind.Function,
),
"keyword": TypeCase(
document="fro",
position={"line": 0, "character": 3},
label="from",
expected=lsp.CompletionItemKind.Keyword,
),
"file": TypeCase(
document='"' + __file__[:-2].replace('"', '\\"') + '"',
position={"line": 0, "character": len(__file__) - 2},
label=Path(__file__).name + '"',
expected=lsp.CompletionItemKind.File,
),
"module": TypeCase(
document="import statis",
position={"line": 0, "character": 13},
label="statistics",
expected=lsp.CompletionItemKind.Module,
),
"class": TypeCase(
document="KeyErr",
position={"line": 0, "character": 6},
label="KeyError",
expected=lsp.CompletionItemKind.Class,
),
"property": TypeCase(
document=(
"class A:\n"
" @property\n"
" def test(self):\n"
" pass\n"
"A().tes"
),
position={"line": 4, "character": 5},
label="test",
expected=lsp.CompletionItemKind.Property,
),
}
@pytest.mark.parametrize("case", list(TYPE_CASES.values()), ids=list(TYPE_CASES.keys()))
def test_jedi_completion_type(case, config, workspace):
# property support was introduced in 0.18
if case.expected == lsp.CompletionItemKind.Property and JEDI_VERSION.startswith(
"0.17"
):
return
doc = Document(DOC_URI, workspace, case.document)
items = pylsp_jedi_completions(config, doc, case.position)
items = {i["label"]: i for i in items}
assert items[case.label]["kind"] == case.expected
def test_jedi_completion(config, workspace) -> None:
# Over 'i' in os.path.isabs(...)
com_position = {"line": 1, "character": 15}
doc = Document(DOC_URI, workspace, DOC)
items = pylsp_jedi_completions(config, doc, com_position)
assert items
labels = [i["label"] for i in items]
assert "isfile(path)" in labels
# Test we don't throw with big character
pylsp_jedi_completions(config, doc, {"line": 1, "character": 1000})
def test_jedi_completion_item_resolve(config, workspace) -> None:
# Over the blank line
com_position = {"line": 8, "character": 0}
doc = Document(DOC_URI, workspace, DOC)
config.update({"plugins": {"jedi_completion": {"resolve_at_most": math.inf}}})
completions = pylsp_jedi_completions(config, doc, com_position)
items = {c["label"]: c for c in completions}
documented_hello_item = items["documented_hello()"]
assert "documentation" not in documented_hello_item
assert "detail" not in documented_hello_item
resolved_documented_hello = pylsp_jedi_completion_item_resolve(
doc._config, completion_item=documented_hello_item, document=doc
)
expected_doc = {
"kind": "markdown",
"value": "```python\ndocumented_hello()\n```\n\n\nSends a polite greeting",
}
assert resolved_documented_hello["documentation"] == expected_doc
def test_jedi_completion_with_fuzzy_enabled(config, workspace) -> None:
# Over 'i' in os.path.isabs(...)
config.update({"plugins": {"jedi_completion": {"fuzzy": True}}})
com_position = {"line": 1, "character": 15}
doc = Document(DOC_URI, workspace, DOC)
items = pylsp_jedi_completions(config, doc, com_position)
assert items
expected = "commonprefix(m)"
if JEDI_VERSION == "0.18.0":
expected = "commonprefix(list)"
assert items[0]["label"] == expected
# Test we don't throw with big character
pylsp_jedi_completions(config, doc, {"line": 1, "character": 1000})
def test_jedi_completion_resolve_at_most(config, workspace) -> None:
# Over 'i' in os.path.isabs(...)
com_position = {"line": 1, "character": 15}
doc = Document(DOC_URI, workspace, DOC)
# Do not resolve any labels
config.update({"plugins": {"jedi_completion": {"resolve_at_most": 0}}})
items = pylsp_jedi_completions(config, doc, com_position)
labels = {i["label"] for i in items}
assert "isabs" in labels
# Resolve all items
config.update({"plugins": {"jedi_completion": {"resolve_at_most": math.inf}}})
items = pylsp_jedi_completions(config, doc, com_position)
labels = {i["label"] for i in items}
assert "isfile(path)" in labels
def test_rope_completion(config, workspace) -> None:
# Over 'i' in os.path.isabs(...)
com_position = {"line": 1, "character": 15}
workspace.put_document(DOC_URI, source=DOC)
doc = workspace.get_document(DOC_URI)
items = pylsp_rope_completions(config, workspace, doc, com_position)
assert items
assert items[0]["label"] == "isabs"
def test_jedi_completion_ordering(config, workspace) -> None:
# Over the blank line
com_position = {"line": 8, "character": 0}
doc = Document(DOC_URI, workspace, DOC)
config.update({"plugins": {"jedi_completion": {"resolve_at_most": math.inf}}})
completions = pylsp_jedi_completions(config, doc, com_position)
items = {c["label"]: c["sortText"] for c in completions}
# And that 'hidden' functions come after unhidden ones
assert items["hello()"] < items["_a_hello()"]
def test_jedi_property_completion(config, workspace) -> None:
# Over the 'w' in 'print Hello().world'
com_position = {"line": 18, "character": 15}
doc = Document(DOC_URI, workspace, DOC)
completions = pylsp_jedi_completions(config, doc, com_position)
items = {c["label"]: c["sortText"] for c in completions}
# Ensure we can complete the 'world' property
assert "world" in list(items.keys())[0]
def test_jedi_method_completion(config, workspace) -> None:
# Over the 'y' in 'print Hello().every'
com_position = {"line": 20, "character": 19}
doc = Document(DOC_URI, workspace, DOC)
config.capabilities["textDocument"] = {
"completion": {"completionItem": {"snippetSupport": True}}
}
config.update({"plugins": {"jedi_completion": {"include_params": True}}})
completions = pylsp_jedi_completions(config, doc, com_position)
everyone_method = [
completion
for completion in completions
if completion["label"] == "everyone(a, b, c, d)"
][0]
# Ensure we only generate snippets for positional args
assert everyone_method["insertTextFormat"] == lsp.InsertTextFormat.Snippet
assert everyone_method["insertText"] == "everyone(${1:a}, ${2:b})$0"
# Disable param snippets
config.update({"plugins": {"jedi_completion": {"include_params": False}}})
completions = pylsp_jedi_completions(config, doc, com_position)
everyone_method = [
completion
for completion in completions
if completion["label"] == "everyone(a, b, c, d)"
][0]
assert "insertTextFormat" not in everyone_method
assert everyone_method["insertText"] == "everyone"
@pytest.mark.skipif(
PY2 or (sys.platform.startswith("linux") and os.environ.get("CI") is not None),
reason="Test in Python 3 and not on CIs on Linux because wheels don't work on them.",
)
def test_pyqt_completion(config, workspace) -> None:
# Over 'QA' in 'from PyQt5.QtWidgets import QApplication'
doc_pyqt = "from PyQt5.QtWidgets import QA"
com_position = {"line": 0, "character": len(doc_pyqt)}
doc = Document(DOC_URI, workspace, doc_pyqt)
completions = pylsp_jedi_completions(config, doc, com_position)
assert completions is not None
def test_numpy_completions(config, workspace) -> None:
doc_numpy = "import numpy as np; np."
com_position = {"line": 0, "character": len(doc_numpy)}
doc = Document(DOC_URI, workspace, doc_numpy)
items = pylsp_jedi_completions(config, doc, com_position)
assert items
assert any("array" in i["label"] for i in items)
def test_pandas_completions(config, workspace) -> None:
doc_pandas = "import pandas as pd; pd."
com_position = {"line": 0, "character": len(doc_pandas)}
doc = Document(DOC_URI, workspace, doc_pandas)
items = pylsp_jedi_completions(config, doc, com_position)
assert items
assert any("DataFrame" in i["label"] for i in items)
def test_matplotlib_completions(config, workspace) -> None:
doc_mpl = "import matplotlib.pyplot as plt; plt."
com_position = {"line": 0, "character": len(doc_mpl)}
doc = Document(DOC_URI, workspace, doc_mpl)
items = pylsp_jedi_completions(config, doc, com_position)
assert items
assert any("plot" in i["label"] for i in items)
def test_snippets_completion(config, workspace) -> None:
doc_snippets = "from collections import defaultdict \na=defaultdict"
com_position = {"line": 0, "character": 35}
doc = Document(DOC_URI, workspace, doc_snippets)
config.capabilities["textDocument"] = {
"completion": {"completionItem": {"snippetSupport": True}}
}
config.update({"plugins": {"jedi_completion": {"include_params": True}}})
completions = pylsp_jedi_completions(config, doc, com_position)
assert completions[0]["insertText"] == "defaultdict"
com_position = {"line": 1, "character": len(doc_snippets)}
completions = pylsp_jedi_completions(config, doc, com_position)
assert completions[0]["insertText"] == "defaultdict($0)"
assert completions[0]["insertTextFormat"] == lsp.InsertTextFormat.Snippet
def test_snippets_completion_at_most(config, workspace) -> None:
doc_snippets = "from collections import defaultdict \na=defaultdict"
doc = Document(DOC_URI, workspace, doc_snippets)
config.capabilities["textDocument"] = {
"completion": {"completionItem": {"snippetSupport": True}}
}
config.update({"plugins": {"jedi_completion": {"include_params": True}}})
config.update({"plugins": {"jedi_completion": {"resolve_at_most": 0}}})
com_position = {"line": 1, "character": len(doc_snippets)}
completions = pylsp_jedi_completions(config, doc, com_position)
assert completions[0]["insertText"] == "defaultdict"
assert not completions[0].get("insertTextFormat", None)
def test_completion_with_class_objects(config, workspace) -> None:
doc_text = "class FOOBAR(Object): pass\nFOOB"
com_position = {"line": 1, "character": 4}
doc = Document(DOC_URI, workspace, doc_text)
config.capabilities["textDocument"] = {
"completion": {"completionItem": {"snippetSupport": True}}
}
config.update(
{
"plugins": {
"jedi_completion": {
"include_params": True,
"include_class_objects": True,
}
}
}
)
completions = pylsp_jedi_completions(config, doc, com_position)
assert len(completions) == 2
assert completions[0]["label"] == "FOOBAR"
assert completions[0]["kind"] == lsp.CompletionItemKind.Class
assert completions[1]["label"] == "FOOBAR object"
assert completions[1]["kind"] == lsp.CompletionItemKind.TypeParameter
def test_completion_with_function_objects(config, workspace) -> None:
doc_text = "def foobar(): pass\nfoob"
com_position = {"line": 1, "character": 4}
doc = Document(DOC_URI, workspace, doc_text)
config.capabilities["textDocument"] = {
"completion": {"completionItem": {"snippetSupport": True}}
}
config.update(
{
"plugins": {
"jedi_completion": {
"include_params": True,
"include_function_objects": True,
}
}
}
)
completions = pylsp_jedi_completions(config, doc, com_position)
assert len(completions) == 2
assert completions[0]["label"] == "foobar()"
assert completions[0]["kind"] == lsp.CompletionItemKind.Function
assert completions[1]["label"] == "foobar() object"
assert completions[1]["kind"] == lsp.CompletionItemKind.TypeParameter
def test_snippet_parsing(config, workspace) -> None:
doc = "divmod"
completion_position = {"line": 0, "character": 6}
doc = Document(DOC_URI, workspace, doc)
config.capabilities["textDocument"] = {
"completion": {"completionItem": {"snippetSupport": True}}
}
config.update({"plugins": {"jedi_completion": {"include_params": True}}})
completions = pylsp_jedi_completions(config, doc, completion_position)
out = "divmod(${1:x}, ${2:y})$0"
if JEDI_VERSION == "0.18.0":
out = "divmod(${1:a}, ${2:b})$0"
assert completions[0]["insertText"] == out
def test_multiline_import_snippets(config, workspace) -> None:
document = "from datetime import(\n date,\n datetime)\na=date"
doc = Document(DOC_URI, workspace, document)
config.capabilities["textDocument"] = {
"completion": {"completionItem": {"snippetSupport": True}}
}
config.update({"plugins": {"jedi_completion": {"include_params": True}}})
position = {"line": 1, "character": 5}
completions = pylsp_jedi_completions(config, doc, position)
assert completions[0]["insertText"] == "date"
position = {"line": 2, "character": 9}
completions = pylsp_jedi_completions(config, doc, position)
assert completions[0]["insertText"] == "datetime"
def test_multiline_snippets(config, workspace) -> None:
document = "from datetime import\\\n date,\\\n datetime \na=date"
doc = Document(DOC_URI, workspace, document)
config.capabilities["textDocument"] = {
"completion": {"completionItem": {"snippetSupport": True}}
}
config.update({"plugins": {"jedi_completion": {"include_params": True}}})
position = {"line": 1, "character": 5}
completions = pylsp_jedi_completions(config, doc, position)
assert completions[0]["insertText"] == "date"
position = {"line": 2, "character": 9}
completions = pylsp_jedi_completions(config, doc, position)
assert completions[0]["insertText"] == "datetime"
def test_multistatement_snippet(config, workspace) -> None:
config.capabilities["textDocument"] = {
"completion": {"completionItem": {"snippetSupport": True}}
}
config.update({"plugins": {"jedi_completion": {"include_params": True}}})
document = "a = 1; from datetime import date"
doc = Document(DOC_URI, workspace, document)
position = {"line": 0, "character": len(document)}
completions = pylsp_jedi_completions(config, doc, position)
assert completions[0]["insertText"] == "date"
document = "from math import fmod; a = fmod"
doc = Document(DOC_URI, workspace, document)
position = {"line": 0, "character": len(document)}
completions = pylsp_jedi_completions(config, doc, position)
assert completions[0]["insertText"] == "fmod(${1:x}, ${2:y})$0"
def test_jedi_completion_extra_paths(tmpdir, workspace) -> None:
# Create a tempfile with some content and pass to extra_paths
temp_doc_content = """
def spam():
pass
"""
p = tmpdir.mkdir("extra_path")
extra_paths = [str(p)]
p = p.join("foo.py")
p.write(temp_doc_content)
# Content of doc to test completion
doc_content = """import foo
foo.s"""
doc = Document(DOC_URI, workspace, doc_content)
# After 'foo.s' without extra paths
com_position = {"line": 1, "character": 5}
completions = pylsp_jedi_completions(doc._config, doc, com_position)
assert completions is None
# Update config extra paths
settings = {"pylsp": {"plugins": {"jedi": {"extra_paths": extra_paths}}}}
doc.update_config(settings)
# After 'foo.s' with extra paths
com_position = {"line": 1, "character": 5}
completions = pylsp_jedi_completions(doc._config, doc, com_position)
assert completions[0]["label"] == "spam()"
@pytest.mark.skipif(
PY2 or not LINUX or not CI, reason="tested on linux and python 3 only"
)
def test_jedi_completion_environment(workspace) -> None:
# Content of doc to test completion
doc_content = """import logh
"""
doc = Document(DOC_URI, workspace, doc_content)
# After 'import logh' with default environment
com_position = {"line": 0, "character": 11}
assert os.path.isdir("/tmp/pyenv/")
settings = {"pylsp": {"plugins": {"jedi": {"environment": None}}}}
doc.update_config(settings)
completions = pylsp_jedi_completions(doc._config, doc, com_position)
assert completions is None
# Update config extra environment
env_path = "/tmp/pyenv/bin/python"
settings = {"pylsp": {"plugins": {"jedi": {"environment": env_path}}}}
doc.update_config(settings)
# After 'import logh' with new environment
completions = pylsp_jedi_completions(doc._config, doc, com_position)
assert completions[0]["label"] == "loghub"
resolved = pylsp_jedi_completion_item_resolve(doc._config, completions[0], doc)
assert "changelog generator" in resolved["documentation"]["value"].lower()
def test_document_path_completions(tmpdir, workspace_other_root_path) -> None:
# Create a dummy module out of the workspace's root_path and try to get
# completions for it in another file placed next to it.
module_content = """
def foo():
pass
"""
p = tmpdir.join("mymodule.py")
p.write(module_content)
# Content of doc to test completion
doc_content = """import mymodule
mymodule.f"""
doc_path = str(tmpdir) + os.path.sep + "myfile.py"
doc_uri = uris.from_fs_path(doc_path)
doc = Document(doc_uri, workspace_other_root_path, doc_content)
com_position = {"line": 1, "character": 10}
completions = pylsp_jedi_completions(doc._config, doc, com_position)
assert completions[0]["label"] == "foo()"
def test_file_completions(workspace, tmpdir) -> None:
# Create directory and a file to get completions for them.
# Note: `tmpdir`` is the root dir of the `workspace` fixture. That's why we use
# it here.
tmpdir.mkdir("bar")
file = tmpdir.join("foo.txt")
file.write("baz")
# Content of doc to test completion
doc_content = '"'
doc = Document(DOC_URI, workspace, doc_content)
# Request for completions
com_position = {"line": 0, "character": 1}
completions = pylsp_jedi_completions(doc._config, doc, com_position)
# Check completions
assert len(completions) == 2
assert [c["kind"] == lsp.CompletionItemKind.File for c in completions]
assert completions[0]["insertText"] == (
("bar" + "\\") if os.name == "nt" else ("bar" + "/")
)
assert completions[1]["insertText"] == 'foo.txt"'
# When snippets are supported, ensure that path separators are escaped.
support_snippet = {
"textDocument": {"completion": {"completionItem": {"snippetSupport": True}}}
}
doc._config.capabilities.update(support_snippet)
completions = pylsp_jedi_completions(doc._config, doc, com_position)
assert completions[0]["insertText"] == (
("bar" + "\\\\") if os.name == "nt" else ("bar" + "\\/")
)
assert completions[1]["insertText"] == 'foo.txt"'