/
test_completer.py
1124 lines (935 loc) · 39.6 KB
/
test_completer.py
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
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# encoding: utf-8
"""Tests for the IPython tab-completion machinery."""
# Copyright (c) IPython Development Team.
# Distributed under the terms of the Modified BSD License.
import os
import sys
import textwrap
import unittest
from contextlib import contextmanager
import nose.tools as nt
import pytest
from traitlets.config.loader import Config
from IPython import get_ipython
from IPython.core import completer
from IPython.external import decorators
from IPython.utils.tempdir import TemporaryDirectory, TemporaryWorkingDirectory
from IPython.utils.generics import complete_object
from IPython.testing import decorators as dec
from IPython.core.completer import (
Completion,
provisionalcompleter,
match_dict_keys,
_deduplicate_completions,
)
from nose.tools import assert_in, assert_not_in
if sys.version_info >= (3, 10):
import jedi
from pkg_resources import parse_version
# Requires https://github.com/davidhalter/jedi/pull/1795
jedi_issue = parse_version(jedi.__version__) <= parse_version("0.18.0")
else:
jedi_issue = False
# -----------------------------------------------------------------------------
# Test functions
# -----------------------------------------------------------------------------
@contextmanager
def greedy_completion():
ip = get_ipython()
greedy_original = ip.Completer.greedy
try:
ip.Completer.greedy = True
yield
finally:
ip.Completer.greedy = greedy_original
def test_protect_filename():
if sys.platform == "win32":
pairs = [
("abc", "abc"),
(" abc", '" abc"'),
("a bc", '"a bc"'),
("a bc", '"a bc"'),
(" bc", '" bc"'),
]
else:
pairs = [
("abc", "abc"),
(" abc", r"\ abc"),
("a bc", r"a\ bc"),
("a bc", r"a\ \ bc"),
(" bc", r"\ \ bc"),
# On posix, we also protect parens and other special characters.
("a(bc", r"a\(bc"),
("a)bc", r"a\)bc"),
("a( )bc", r"a\(\ \)bc"),
("a[1]bc", r"a\[1\]bc"),
("a{1}bc", r"a\{1\}bc"),
("a#bc", r"a\#bc"),
("a?bc", r"a\?bc"),
("a=bc", r"a\=bc"),
("a\\bc", r"a\\bc"),
("a|bc", r"a\|bc"),
("a;bc", r"a\;bc"),
("a:bc", r"a\:bc"),
("a'bc", r"a\'bc"),
("a*bc", r"a\*bc"),
('a"bc', r"a\"bc"),
("a^bc", r"a\^bc"),
("a&bc", r"a\&bc"),
]
# run the actual tests
for s1, s2 in pairs:
s1p = completer.protect_filename(s1)
nt.assert_equal(s1p, s2)
def check_line_split(splitter, test_specs):
for part1, part2, split in test_specs:
cursor_pos = len(part1)
line = part1 + part2
out = splitter.split_line(line, cursor_pos)
nt.assert_equal(out, split)
def test_line_split():
"""Basic line splitter test with default specs."""
sp = completer.CompletionSplitter()
# The format of the test specs is: part1, part2, expected answer. Parts 1
# and 2 are joined into the 'line' sent to the splitter, as if the cursor
# was at the end of part1. So an empty part2 represents someone hitting
# tab at the end of the line, the most common case.
t = [
("run some/scrip", "", "some/scrip"),
("run scripts/er", "ror.py foo", "scripts/er"),
("echo $HOM", "", "HOM"),
("print sys.pa", "", "sys.pa"),
("print(sys.pa", "", "sys.pa"),
("execfile('scripts/er", "", "scripts/er"),
("a[x.", "", "x."),
("a[x.", "y", "x."),
('cd "some_file/', "", "some_file/"),
]
check_line_split(sp, t)
# Ensure splitting works OK with unicode by re-running the tests with
# all inputs turned into unicode
check_line_split(sp, [map(str, p) for p in t])
class NamedInstanceMetaclass(type):
def __getitem__(cls, item):
return cls.get_instance(item)
class NamedInstanceClass(metaclass=NamedInstanceMetaclass):
def __init__(self, name):
if not hasattr(self.__class__, "instances"):
self.__class__.instances = {}
self.__class__.instances[name] = self
@classmethod
def _ipython_key_completions_(cls):
return cls.instances.keys()
@classmethod
def get_instance(cls, name):
return cls.instances[name]
class KeyCompletable:
def __init__(self, things=()):
self.things = things
def _ipython_key_completions_(self):
return list(self.things)
class TestCompleter(unittest.TestCase):
def setUp(self):
"""
We want to silence all PendingDeprecationWarning when testing the completer
"""
self._assertwarns = self.assertWarns(PendingDeprecationWarning)
self._assertwarns.__enter__()
def tearDown(self):
try:
self._assertwarns.__exit__(None, None, None)
except AssertionError:
pass
def test_custom_completion_error(self):
"""Test that errors from custom attribute completers are silenced."""
ip = get_ipython()
class A:
pass
ip.user_ns["x"] = A()
@complete_object.register(A)
def complete_A(a, existing_completions):
raise TypeError("this should be silenced")
ip.complete("x.")
def test_custom_completion_ordering(self):
"""Test that errors from custom attribute completers are silenced."""
ip = get_ipython()
_, matches = ip.complete('in')
assert matches.index('input') < matches.index('int')
def complete_example(a):
return ['example2', 'example1']
ip.Completer.custom_completers.add_re('ex*', complete_example)
_, matches = ip.complete('ex')
assert matches.index('example2') < matches.index('example1')
def test_unicode_completions(self):
ip = get_ipython()
# Some strings that trigger different types of completion. Check them both
# in str and unicode forms
s = ["ru", "%ru", "cd /", "floa", "float(x)/"]
for t in s + list(map(str, s)):
# We don't need to check exact completion values (they may change
# depending on the state of the namespace, but at least no exceptions
# should be thrown and the return value should be a pair of text, list
# values.
text, matches = ip.complete(t)
nt.assert_true(isinstance(text, str))
nt.assert_true(isinstance(matches, list))
def test_latex_completions(self):
from IPython.core.latex_symbols import latex_symbols
import random
ip = get_ipython()
# Test some random unicode symbols
keys = random.sample(latex_symbols.keys(), 10)
for k in keys:
text, matches = ip.complete(k)
nt.assert_equal(len(matches), 1)
nt.assert_equal(text, k)
nt.assert_equal(matches[0], latex_symbols[k])
# Test a more complex line
text, matches = ip.complete("print(\\alpha")
nt.assert_equal(text, "\\alpha")
nt.assert_equal(matches[0], latex_symbols["\\alpha"])
# Test multiple matching latex symbols
text, matches = ip.complete("\\al")
nt.assert_in("\\alpha", matches)
nt.assert_in("\\aleph", matches)
def test_latex_no_results(self):
"""
forward latex should really return nothing in either field if nothing is found.
"""
ip = get_ipython()
text, matches = ip.Completer.latex_matches("\\really_i_should_match_nothing")
nt.assert_equal(text, "")
nt.assert_equal(matches, [])
def test_back_latex_completion(self):
ip = get_ipython()
# do not return more than 1 matches fro \beta, only the latex one.
name, matches = ip.complete("\\β")
nt.assert_equal(matches, ['\\beta'])
def test_back_unicode_completion(self):
ip = get_ipython()
name, matches = ip.complete("\\Ⅴ")
nt.assert_equal(matches, ["\\ROMAN NUMERAL FIVE"])
def test_forward_unicode_completion(self):
ip = get_ipython()
name, matches = ip.complete("\\ROMAN NUMERAL FIVE")
nt.assert_equal(len(matches), 1)
nt.assert_equal(matches[0], "Ⅴ")
@nt.nottest # now we have a completion for \jmath
@decorators.knownfailureif(
sys.platform == "win32", "Fails if there is a C:\\j... path"
)
def test_no_ascii_back_completion(self):
ip = get_ipython()
with TemporaryWorkingDirectory(): # Avoid any filename completions
# single ascii letter that don't have yet completions
for letter in "jJ":
name, matches = ip.complete("\\" + letter)
nt.assert_equal(matches, [])
class CompletionSplitterTestCase(unittest.TestCase):
def setUp(self):
self.sp = completer.CompletionSplitter()
def test_delim_setting(self):
self.sp.delims = " "
nt.assert_equal(self.sp.delims, " ")
nt.assert_equal(self.sp._delim_expr, r"[\ ]")
def test_spaces(self):
"""Test with only spaces as split chars."""
self.sp.delims = " "
t = [("foo", "", "foo"), ("run foo", "", "foo"), ("run foo", "bar", "foo")]
check_line_split(self.sp, t)
def test_has_open_quotes1(self):
for s in ["'", "'''", "'hi' '"]:
nt.assert_equal(completer.has_open_quotes(s), "'")
def test_has_open_quotes2(self):
for s in ['"', '"""', '"hi" "']:
nt.assert_equal(completer.has_open_quotes(s), '"')
def test_has_open_quotes3(self):
for s in ["''", "''' '''", "'hi' 'ipython'"]:
nt.assert_false(completer.has_open_quotes(s))
def test_has_open_quotes4(self):
for s in ['""', '""" """', '"hi" "ipython"']:
nt.assert_false(completer.has_open_quotes(s))
@decorators.knownfailureif(
sys.platform == "win32", "abspath completions fail on Windows"
)
def test_abspath_file_completions(self):
ip = get_ipython()
with TemporaryDirectory() as tmpdir:
prefix = os.path.join(tmpdir, "foo")
suffixes = ["1", "2"]
names = [prefix + s for s in suffixes]
for n in names:
open(n, "w").close()
# Check simple completion
c = ip.complete(prefix)[1]
nt.assert_equal(c, names)
# Now check with a function call
cmd = 'a = f("%s' % prefix
c = ip.complete(prefix, cmd)[1]
comp = [prefix + s for s in suffixes]
nt.assert_equal(c, comp)
def test_local_file_completions(self):
ip = get_ipython()
with TemporaryWorkingDirectory():
prefix = "./foo"
suffixes = ["1", "2"]
names = [prefix + s for s in suffixes]
for n in names:
open(n, "w").close()
# Check simple completion
c = ip.complete(prefix)[1]
nt.assert_equal(c, names)
# Now check with a function call
cmd = 'a = f("%s' % prefix
c = ip.complete(prefix, cmd)[1]
comp = {prefix + s for s in suffixes}
nt.assert_true(comp.issubset(set(c)))
def test_quoted_file_completions(self):
ip = get_ipython()
with TemporaryWorkingDirectory():
name = "foo'bar"
open(name, "w").close()
# Don't escape Windows
escaped = name if sys.platform == "win32" else "foo\\'bar"
# Single quote matches embedded single quote
text = "open('foo"
c = ip.Completer._complete(
cursor_line=0, cursor_pos=len(text), full_text=text
)[1]
nt.assert_equal(c, [escaped])
# Double quote requires no escape
text = 'open("foo'
c = ip.Completer._complete(
cursor_line=0, cursor_pos=len(text), full_text=text
)[1]
nt.assert_equal(c, [name])
# No quote requires an escape
text = "%ls foo"
c = ip.Completer._complete(
cursor_line=0, cursor_pos=len(text), full_text=text
)[1]
nt.assert_equal(c, [escaped])
def test_all_completions_dups(self):
"""
Make sure the output of `IPCompleter.all_completions` does not have
duplicated prefixes.
"""
ip = get_ipython()
c = ip.Completer
ip.ex("class TestClass():\n\ta=1\n\ta1=2")
for jedi_status in [True, False]:
with provisionalcompleter():
ip.Completer.use_jedi = jedi_status
matches = c.all_completions("TestCl")
assert matches == ['TestClass'], jedi_status
matches = c.all_completions("TestClass.")
if jedi_status and jedi_issue:
continue
assert len(matches) > 2, jedi_status
matches = c.all_completions("TestClass.a")
assert matches == ['TestClass.a', 'TestClass.a1'], jedi_status
def test_jedi(self):
"""
A couple of issue we had with Jedi
"""
ip = get_ipython()
def _test_complete(reason, s, comp, start=None, end=None):
l = len(s)
start = start if start is not None else l
end = end if end is not None else l
with provisionalcompleter():
ip.Completer.use_jedi = True
completions = set(ip.Completer.completions(s, l))
ip.Completer.use_jedi = False
assert_in(Completion(start, end, comp), completions, reason)
def _test_not_complete(reason, s, comp):
l = len(s)
with provisionalcompleter():
ip.Completer.use_jedi = True
completions = set(ip.Completer.completions(s, l))
ip.Completer.use_jedi = False
assert_not_in(Completion(l, l, comp), completions, reason)
import jedi
jedi_version = tuple(int(i) for i in jedi.__version__.split(".")[:3])
if jedi_version > (0, 10):
yield _test_complete, "jedi >0.9 should complete and not crash", "a=1;a.", "real"
yield _test_complete, "can infer first argument", 'a=(1,"foo");a[0].', "real"
yield _test_complete, "can infer second argument", 'a=(1,"foo");a[1].', "capitalize"
yield _test_complete, "cover duplicate completions", "im", "import", 0, 2
yield _test_not_complete, "does not mix types", 'a=(1,"foo");a[0].', "capitalize"
def test_completion_have_signature(self):
"""
Lets make sure jedi is capable of pulling out the signature of the function we are completing.
"""
ip = get_ipython()
with provisionalcompleter():
ip.Completer.use_jedi = True
completions = ip.Completer.completions("ope", 3)
c = next(completions) # should be `open`
ip.Completer.use_jedi = False
assert "file" in c.signature, "Signature of function was not found by completer"
assert (
"encoding" in c.signature
), "Signature of function was not found by completer"
@pytest.mark.xfail(jedi_issue, reason="Known failure on jedi<=0.18.0")
def test_deduplicate_completions(self):
"""
Test that completions are correctly deduplicated (even if ranges are not the same)
"""
ip = get_ipython()
ip.ex(
textwrap.dedent(
"""
class Z:
zoo = 1
"""
)
)
with provisionalcompleter():
ip.Completer.use_jedi = True
l = list(
_deduplicate_completions("Z.z", ip.Completer.completions("Z.z", 3))
)
ip.Completer.use_jedi = False
assert len(l) == 1, "Completions (Z.z<tab>) correctly deduplicate: %s " % l
assert l[0].text == "zoo" # and not `it.accumulate`
def test_greedy_completions(self):
"""
Test the capability of the Greedy completer.
Most of the test here does not really show off the greedy completer, for proof
each of the text below now pass with Jedi. The greedy completer is capable of more.
See the :any:`test_dict_key_completion_contexts`
"""
ip = get_ipython()
ip.ex("a=list(range(5))")
_, c = ip.complete(".", line="a[0].")
nt.assert_false(".real" in c, "Shouldn't have completed on a[0]: %s" % c)
def _(line, cursor_pos, expect, message, completion):
with greedy_completion(), provisionalcompleter():
ip.Completer.use_jedi = False
_, c = ip.complete(".", line=line, cursor_pos=cursor_pos)
nt.assert_in(expect, c, message % c)
ip.Completer.use_jedi = True
with provisionalcompleter():
completions = ip.Completer.completions(line, cursor_pos)
nt.assert_in(completion, completions)
with provisionalcompleter():
yield _, "a[0].", 5, "a[0].real", "Should have completed on a[0].: %s", Completion(
5, 5, "real"
)
yield _, "a[0].r", 6, "a[0].real", "Should have completed on a[0].r: %s", Completion(
5, 6, "real"
)
yield _, "a[0].from_", 10, "a[0].from_bytes", "Should have completed on a[0].from_: %s", Completion(
5, 10, "from_bytes"
)
def test_omit__names(self):
# also happens to test IPCompleter as a configurable
ip = get_ipython()
ip._hidden_attr = 1
ip._x = {}
c = ip.Completer
ip.ex("ip=get_ipython()")
cfg = Config()
cfg.IPCompleter.omit__names = 0
c.update_config(cfg)
with provisionalcompleter():
c.use_jedi = False
s, matches = c.complete("ip.")
nt.assert_in("ip.__str__", matches)
nt.assert_in("ip._hidden_attr", matches)
# c.use_jedi = True
# completions = set(c.completions('ip.', 3))
# nt.assert_in(Completion(3, 3, '__str__'), completions)
# nt.assert_in(Completion(3,3, "_hidden_attr"), completions)
cfg = Config()
cfg.IPCompleter.omit__names = 1
c.update_config(cfg)
with provisionalcompleter():
c.use_jedi = False
s, matches = c.complete("ip.")
nt.assert_not_in("ip.__str__", matches)
# nt.assert_in('ip._hidden_attr', matches)
# c.use_jedi = True
# completions = set(c.completions('ip.', 3))
# nt.assert_not_in(Completion(3,3,'__str__'), completions)
# nt.assert_in(Completion(3,3, "_hidden_attr"), completions)
cfg = Config()
cfg.IPCompleter.omit__names = 2
c.update_config(cfg)
with provisionalcompleter():
c.use_jedi = False
s, matches = c.complete("ip.")
nt.assert_not_in("ip.__str__", matches)
nt.assert_not_in("ip._hidden_attr", matches)
# c.use_jedi = True
# completions = set(c.completions('ip.', 3))
# nt.assert_not_in(Completion(3,3,'__str__'), completions)
# nt.assert_not_in(Completion(3,3, "_hidden_attr"), completions)
with provisionalcompleter():
c.use_jedi = False
s, matches = c.complete("ip._x.")
nt.assert_in("ip._x.keys", matches)
# c.use_jedi = True
# completions = set(c.completions('ip._x.', 6))
# nt.assert_in(Completion(6,6, "keys"), completions)
del ip._hidden_attr
del ip._x
def test_limit_to__all__False_ok(self):
"""
Limit to all is deprecated, once we remove it this test can go away.
"""
ip = get_ipython()
c = ip.Completer
c.use_jedi = False
ip.ex("class D: x=24")
ip.ex("d=D()")
cfg = Config()
cfg.IPCompleter.limit_to__all__ = False
c.update_config(cfg)
s, matches = c.complete("d.")
nt.assert_in("d.x", matches)
def test_get__all__entries_ok(self):
class A:
__all__ = ["x", 1]
words = completer.get__all__entries(A())
nt.assert_equal(words, ["x"])
def test_get__all__entries_no__all__ok(self):
class A:
pass
words = completer.get__all__entries(A())
nt.assert_equal(words, [])
def test_func_kw_completions(self):
ip = get_ipython()
c = ip.Completer
c.use_jedi = False
ip.ex("def myfunc(a=1,b=2): return a+b")
s, matches = c.complete(None, "myfunc(1,b")
nt.assert_in("b=", matches)
# Simulate completing with cursor right after b (pos==10):
s, matches = c.complete(None, "myfunc(1,b)", 10)
nt.assert_in("b=", matches)
s, matches = c.complete(None, 'myfunc(a="escaped\\")string",b')
nt.assert_in("b=", matches)
# builtin function
s, matches = c.complete(None, "min(k, k")
nt.assert_in("key=", matches)
def test_default_arguments_from_docstring(self):
ip = get_ipython()
c = ip.Completer
kwd = c._default_arguments_from_docstring("min(iterable[, key=func]) -> value")
nt.assert_equal(kwd, ["key"])
# with cython type etc
kwd = c._default_arguments_from_docstring(
"Minuit.migrad(self, int ncall=10000, resume=True, int nsplit=1)\n"
)
nt.assert_equal(kwd, ["ncall", "resume", "nsplit"])
# white spaces
kwd = c._default_arguments_from_docstring(
"\n Minuit.migrad(self, int ncall=10000, resume=True, int nsplit=1)\n"
)
nt.assert_equal(kwd, ["ncall", "resume", "nsplit"])
def test_line_magics(self):
ip = get_ipython()
c = ip.Completer
s, matches = c.complete(None, "lsmag")
nt.assert_in("%lsmagic", matches)
s, matches = c.complete(None, "%lsmag")
nt.assert_in("%lsmagic", matches)
def test_cell_magics(self):
from IPython.core.magic import register_cell_magic
@register_cell_magic
def _foo_cellm(line, cell):
pass
ip = get_ipython()
c = ip.Completer
s, matches = c.complete(None, "_foo_ce")
nt.assert_in("%%_foo_cellm", matches)
s, matches = c.complete(None, "%%_foo_ce")
nt.assert_in("%%_foo_cellm", matches)
def test_line_cell_magics(self):
from IPython.core.magic import register_line_cell_magic
@register_line_cell_magic
def _bar_cellm(line, cell):
pass
ip = get_ipython()
c = ip.Completer
# The policy here is trickier, see comments in completion code. The
# returned values depend on whether the user passes %% or not explicitly,
# and this will show a difference if the same name is both a line and cell
# magic.
s, matches = c.complete(None, "_bar_ce")
nt.assert_in("%_bar_cellm", matches)
nt.assert_in("%%_bar_cellm", matches)
s, matches = c.complete(None, "%_bar_ce")
nt.assert_in("%_bar_cellm", matches)
nt.assert_in("%%_bar_cellm", matches)
s, matches = c.complete(None, "%%_bar_ce")
nt.assert_not_in("%_bar_cellm", matches)
nt.assert_in("%%_bar_cellm", matches)
def test_magic_completion_order(self):
ip = get_ipython()
c = ip.Completer
# Test ordering of line and cell magics.
text, matches = c.complete("timeit")
nt.assert_equal(matches, ["%timeit", "%%timeit"])
def test_magic_completion_shadowing(self):
ip = get_ipython()
c = ip.Completer
c.use_jedi = False
# Before importing matplotlib, %matplotlib magic should be the only option.
text, matches = c.complete("mat")
nt.assert_equal(matches, ["%matplotlib"])
# The newly introduced name should shadow the magic.
ip.run_cell("matplotlib = 1")
text, matches = c.complete("mat")
nt.assert_equal(matches, ["matplotlib"])
# After removing matplotlib from namespace, the magic should again be
# the only option.
del ip.user_ns["matplotlib"]
text, matches = c.complete("mat")
nt.assert_equal(matches, ["%matplotlib"])
def test_magic_completion_shadowing_explicit(self):
"""
If the user try to complete a shadowed magic, and explicit % start should
still return the completions.
"""
ip = get_ipython()
c = ip.Completer
# Before importing matplotlib, %matplotlib magic should be the only option.
text, matches = c.complete("%mat")
nt.assert_equal(matches, ["%matplotlib"])
ip.run_cell("matplotlib = 1")
# After removing matplotlib from namespace, the magic should still be
# the only option.
text, matches = c.complete("%mat")
nt.assert_equal(matches, ["%matplotlib"])
def test_magic_config(self):
ip = get_ipython()
c = ip.Completer
s, matches = c.complete(None, "conf")
nt.assert_in("%config", matches)
s, matches = c.complete(None, "conf")
nt.assert_not_in("AliasManager", matches)
s, matches = c.complete(None, "config ")
nt.assert_in("AliasManager", matches)
s, matches = c.complete(None, "%config ")
nt.assert_in("AliasManager", matches)
s, matches = c.complete(None, "config Ali")
nt.assert_list_equal(["AliasManager"], matches)
s, matches = c.complete(None, "%config Ali")
nt.assert_list_equal(["AliasManager"], matches)
s, matches = c.complete(None, "config AliasManager")
nt.assert_list_equal(["AliasManager"], matches)
s, matches = c.complete(None, "%config AliasManager")
nt.assert_list_equal(["AliasManager"], matches)
s, matches = c.complete(None, "config AliasManager.")
nt.assert_in("AliasManager.default_aliases", matches)
s, matches = c.complete(None, "%config AliasManager.")
nt.assert_in("AliasManager.default_aliases", matches)
s, matches = c.complete(None, "config AliasManager.de")
nt.assert_list_equal(["AliasManager.default_aliases"], matches)
s, matches = c.complete(None, "config AliasManager.de")
nt.assert_list_equal(["AliasManager.default_aliases"], matches)
def test_magic_color(self):
ip = get_ipython()
c = ip.Completer
s, matches = c.complete(None, "colo")
nt.assert_in("%colors", matches)
s, matches = c.complete(None, "colo")
nt.assert_not_in("NoColor", matches)
s, matches = c.complete(None, "%colors") # No trailing space
nt.assert_not_in("NoColor", matches)
s, matches = c.complete(None, "colors ")
nt.assert_in("NoColor", matches)
s, matches = c.complete(None, "%colors ")
nt.assert_in("NoColor", matches)
s, matches = c.complete(None, "colors NoCo")
nt.assert_list_equal(["NoColor"], matches)
s, matches = c.complete(None, "%colors NoCo")
nt.assert_list_equal(["NoColor"], matches)
def test_match_dict_keys(self):
"""
Test that match_dict_keys works on a couple of use case does return what
expected, and does not crash
"""
delims = " \t\n`!@#$^&*()=+[{]}\\|;:'\",<>?"
keys = ["foo", b"far"]
assert match_dict_keys(keys, "b'", delims=delims) == ("'", 2, ["far"])
assert match_dict_keys(keys, "b'f", delims=delims) == ("'", 2, ["far"])
assert match_dict_keys(keys, 'b"', delims=delims) == ('"', 2, ["far"])
assert match_dict_keys(keys, 'b"f', delims=delims) == ('"', 2, ["far"])
assert match_dict_keys(keys, "'", delims=delims) == ("'", 1, ["foo"])
assert match_dict_keys(keys, "'f", delims=delims) == ("'", 1, ["foo"])
assert match_dict_keys(keys, '"', delims=delims) == ('"', 1, ["foo"])
assert match_dict_keys(keys, '"f', delims=delims) == ('"', 1, ["foo"])
match_dict_keys
def test_dict_key_completion_string(self):
"""Test dictionary key completion for string keys"""
ip = get_ipython()
complete = ip.Completer.complete
ip.user_ns["d"] = {"abc": None}
# check completion at different stages
_, matches = complete(line_buffer="d[")
nt.assert_in("'abc'", matches)
nt.assert_not_in("'abc']", matches)
_, matches = complete(line_buffer="d['")
nt.assert_in("abc", matches)
nt.assert_not_in("abc']", matches)
_, matches = complete(line_buffer="d['a")
nt.assert_in("abc", matches)
nt.assert_not_in("abc']", matches)
# check use of different quoting
_, matches = complete(line_buffer='d["')
nt.assert_in("abc", matches)
nt.assert_not_in('abc"]', matches)
_, matches = complete(line_buffer='d["a')
nt.assert_in("abc", matches)
nt.assert_not_in('abc"]', matches)
# check sensitivity to following context
_, matches = complete(line_buffer="d[]", cursor_pos=2)
nt.assert_in("'abc'", matches)
_, matches = complete(line_buffer="d['']", cursor_pos=3)
nt.assert_in("abc", matches)
nt.assert_not_in("abc'", matches)
nt.assert_not_in("abc']", matches)
# check multiple solutions are correctly returned and that noise is not
ip.user_ns["d"] = {
"abc": None,
"abd": None,
"bad": None,
object(): None,
5: None,
}
_, matches = complete(line_buffer="d['a")
nt.assert_in("abc", matches)
nt.assert_in("abd", matches)
nt.assert_not_in("bad", matches)
assert not any(m.endswith(("]", '"', "'")) for m in matches), matches
# check escaping and whitespace
ip.user_ns["d"] = {"a\nb": None, "a'b": None, 'a"b': None, "a word": None}
_, matches = complete(line_buffer="d['a")
nt.assert_in("a\\nb", matches)
nt.assert_in("a\\'b", matches)
nt.assert_in('a"b', matches)
nt.assert_in("a word", matches)
assert not any(m.endswith(("]", '"', "'")) for m in matches), matches
# - can complete on non-initial word of the string
_, matches = complete(line_buffer="d['a w")
nt.assert_in("word", matches)
# - understands quote escaping
_, matches = complete(line_buffer="d['a\\'")
nt.assert_in("b", matches)
# - default quoting should work like repr
_, matches = complete(line_buffer="d[")
nt.assert_in('"a\'b"', matches)
# - when opening quote with ", possible to match with unescaped apostrophe
_, matches = complete(line_buffer="d[\"a'")
nt.assert_in("b", matches)
# need to not split at delims that readline won't split at
if "-" not in ip.Completer.splitter.delims:
ip.user_ns["d"] = {"before-after": None}
_, matches = complete(line_buffer="d['before-af")
nt.assert_in("before-after", matches)
def test_dict_key_completion_contexts(self):
"""Test expression contexts in which dict key completion occurs"""
ip = get_ipython()
complete = ip.Completer.complete
d = {"abc": None}
ip.user_ns["d"] = d
class C:
data = d
ip.user_ns["C"] = C
ip.user_ns["get"] = lambda: d
def assert_no_completion(**kwargs):
_, matches = complete(**kwargs)
nt.assert_not_in("abc", matches)
nt.assert_not_in("abc'", matches)
nt.assert_not_in("abc']", matches)
nt.assert_not_in("'abc'", matches)
nt.assert_not_in("'abc']", matches)
def assert_completion(**kwargs):
_, matches = complete(**kwargs)
nt.assert_in("'abc'", matches)
nt.assert_not_in("'abc']", matches)
# no completion after string closed, even if reopened
assert_no_completion(line_buffer="d['a'")
assert_no_completion(line_buffer='d["a"')
assert_no_completion(line_buffer="d['a' + ")
assert_no_completion(line_buffer="d['a' + '")
# completion in non-trivial expressions
assert_completion(line_buffer="+ d[")
assert_completion(line_buffer="(d[")
assert_completion(line_buffer="C.data[")
# greedy flag
def assert_completion(**kwargs):
_, matches = complete(**kwargs)
nt.assert_in("get()['abc']", matches)
assert_no_completion(line_buffer="get()[")
with greedy_completion():
assert_completion(line_buffer="get()[")
assert_completion(line_buffer="get()['")
assert_completion(line_buffer="get()['a")
assert_completion(line_buffer="get()['ab")
assert_completion(line_buffer="get()['abc")
def test_dict_key_completion_bytes(self):
"""Test handling of bytes in dict key completion"""
ip = get_ipython()
complete = ip.Completer.complete
ip.user_ns["d"] = {"abc": None, b"abd": None}
_, matches = complete(line_buffer="d[")
nt.assert_in("'abc'", matches)
nt.assert_in("b'abd'", matches)
if False: # not currently implemented
_, matches = complete(line_buffer="d[b")
nt.assert_in("b'abd'", matches)
nt.assert_not_in("b'abc'", matches)
_, matches = complete(line_buffer="d[b'")
nt.assert_in("abd", matches)
nt.assert_not_in("abc", matches)
_, matches = complete(line_buffer="d[B'")
nt.assert_in("abd", matches)
nt.assert_not_in("abc", matches)
_, matches = complete(line_buffer="d['")
nt.assert_in("abc", matches)
nt.assert_not_in("abd", matches)
def test_dict_key_completion_unicode_py3(self):
"""Test handling of unicode in dict key completion"""
ip = get_ipython()
complete = ip.Completer.complete
ip.user_ns["d"] = {"a\u05d0": None}
# query using escape
if sys.platform != "win32":
# Known failure on Windows
_, matches = complete(line_buffer="d['a\\u05d0")
nt.assert_in("u05d0", matches) # tokenized after \\
# query using character
_, matches = complete(line_buffer="d['a\u05d0")
nt.assert_in("a\u05d0", matches)
with greedy_completion():
# query using escape
_, matches = complete(line_buffer="d['a\\u05d0")
nt.assert_in("d['a\\u05d0']", matches) # tokenized after \\
# query using character
_, matches = complete(line_buffer="d['a\u05d0")
nt.assert_in("d['a\u05d0']", matches)
@dec.skip_without("numpy")
def test_struct_array_key_completion(self):
"""Test dict key completion applies to numpy struct arrays"""
import numpy
ip = get_ipython()
complete = ip.Completer.complete
ip.user_ns["d"] = numpy.array([], dtype=[("hello", "f"), ("world", "f")])
_, matches = complete(line_buffer="d['")
nt.assert_in("hello", matches)
nt.assert_in("world", matches)
# complete on the numpy struct itself
dt = numpy.dtype(
[("my_head", [("my_dt", ">u4"), ("my_df", ">u4")]), ("my_data", ">f4", 5)]
)
x = numpy.zeros(2, dtype=dt)
ip.user_ns["d"] = x[1]