##// END OF EJS Templates
update darker/black (#14567)
M Bussonnier -
r28952:39c7d0e0 merge
parent child Browse files
Show More
@@ -1,40 +1,40
1 # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
1 # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
2 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
2 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
3
3
4 name: Python package
4 name: Python package
5
5
6 permissions:
6 permissions:
7 contents: read
7 contents: read
8
8
9 on:
9 on:
10 push:
10 push:
11 branches: [ main, 7.x ]
11 branches: [ main, 7.x ]
12 pull_request:
12 pull_request:
13 branches: [ main, 7.x ]
13 branches: [ main, 7.x ]
14
14
15 jobs:
15 jobs:
16 formatting:
16 formatting:
17
17
18 runs-on: ubuntu-latest
18 runs-on: ubuntu-latest
19 timeout-minutes: 5
19 timeout-minutes: 5
20 steps:
20 steps:
21 - uses: actions/checkout@v4
21 - uses: actions/checkout@v4
22 with:
22 with:
23 fetch-depth: 0
23 fetch-depth: 0
24 - name: Set up Python
24 - name: Set up Python
25 uses: actions/setup-python@v5
25 uses: actions/setup-python@v5
26 with:
26 with:
27 python-version: 3.x
27 python-version: 3.x
28 - name: Install dependencies
28 - name: Install dependencies
29 run: |
29 run: |
30 python -m pip install --upgrade pip
30 python -m pip install --upgrade pip
31 # when changing the versions please update CONTRIBUTING.md too
31 # when changing the versions please update CONTRIBUTING.md too
32 pip install --only-binary ':all:' darker==1.5.1 black==22.10.0
32 pip install --only-binary ':all:' darker==2.1.1 black==24.10.0
33 - name: Lint with darker
33 - name: Lint with darker
34 run: |
34 run: |
35 darker -r 60625f241f298b5039cb2debc365db38aa7bb522 --check --diff . || (
35 darker -r 60625f241f298b5039cb2debc365db38aa7bb522 --check --diff . || (
36 echo "Changes need auto-formatting. Run:"
36 echo "Changes need auto-formatting. Run:"
37 echo " darker -r 60625f241f298b5039cb2debc365db38aa7bb522 ."
37 echo " darker -r 60625f241f298b5039cb2debc365db38aa7bb522 ."
38 echo "then commit and push changes to fix."
38 echo "then commit and push changes to fix."
39 exit 1
39 exit 1
40 )
40 )
@@ -1,3389 +1,3389
1 """Completion for IPython.
1 """Completion for IPython.
2
2
3 This module started as fork of the rlcompleter module in the Python standard
3 This module started as fork of the rlcompleter module in the Python standard
4 library. The original enhancements made to rlcompleter have been sent
4 library. The original enhancements made to rlcompleter have been sent
5 upstream and were accepted as of Python 2.3,
5 upstream and were accepted as of Python 2.3,
6
6
7 This module now support a wide variety of completion mechanism both available
7 This module now support a wide variety of completion mechanism both available
8 for normal classic Python code, as well as completer for IPython specific
8 for normal classic Python code, as well as completer for IPython specific
9 Syntax like magics.
9 Syntax like magics.
10
10
11 Latex and Unicode completion
11 Latex and Unicode completion
12 ============================
12 ============================
13
13
14 IPython and compatible frontends not only can complete your code, but can help
14 IPython and compatible frontends not only can complete your code, but can help
15 you to input a wide range of characters. In particular we allow you to insert
15 you to input a wide range of characters. In particular we allow you to insert
16 a unicode character using the tab completion mechanism.
16 a unicode character using the tab completion mechanism.
17
17
18 Forward latex/unicode completion
18 Forward latex/unicode completion
19 --------------------------------
19 --------------------------------
20
20
21 Forward completion allows you to easily type a unicode character using its latex
21 Forward completion allows you to easily type a unicode character using its latex
22 name, or unicode long description. To do so type a backslash follow by the
22 name, or unicode long description. To do so type a backslash follow by the
23 relevant name and press tab:
23 relevant name and press tab:
24
24
25
25
26 Using latex completion:
26 Using latex completion:
27
27
28 .. code::
28 .. code::
29
29
30 \\alpha<tab>
30 \\alpha<tab>
31 Ξ±
31 Ξ±
32
32
33 or using unicode completion:
33 or using unicode completion:
34
34
35
35
36 .. code::
36 .. code::
37
37
38 \\GREEK SMALL LETTER ALPHA<tab>
38 \\GREEK SMALL LETTER ALPHA<tab>
39 Ξ±
39 Ξ±
40
40
41
41
42 Only valid Python identifiers will complete. Combining characters (like arrow or
42 Only valid Python identifiers will complete. Combining characters (like arrow or
43 dots) are also available, unlike latex they need to be put after the their
43 dots) are also available, unlike latex they need to be put after the their
44 counterpart that is to say, ``F\\\\vec<tab>`` is correct, not ``\\\\vec<tab>F``.
44 counterpart that is to say, ``F\\\\vec<tab>`` is correct, not ``\\\\vec<tab>F``.
45
45
46 Some browsers are known to display combining characters incorrectly.
46 Some browsers are known to display combining characters incorrectly.
47
47
48 Backward latex completion
48 Backward latex completion
49 -------------------------
49 -------------------------
50
50
51 It is sometime challenging to know how to type a character, if you are using
51 It is sometime challenging to know how to type a character, if you are using
52 IPython, or any compatible frontend you can prepend backslash to the character
52 IPython, or any compatible frontend you can prepend backslash to the character
53 and press :kbd:`Tab` to expand it to its latex form.
53 and press :kbd:`Tab` to expand it to its latex form.
54
54
55 .. code::
55 .. code::
56
56
57 \\Ξ±<tab>
57 \\Ξ±<tab>
58 \\alpha
58 \\alpha
59
59
60
60
61 Both forward and backward completions can be deactivated by setting the
61 Both forward and backward completions can be deactivated by setting the
62 :std:configtrait:`Completer.backslash_combining_completions` option to
62 :std:configtrait:`Completer.backslash_combining_completions` option to
63 ``False``.
63 ``False``.
64
64
65
65
66 Experimental
66 Experimental
67 ============
67 ============
68
68
69 Starting with IPython 6.0, this module can make use of the Jedi library to
69 Starting with IPython 6.0, this module can make use of the Jedi library to
70 generate completions both using static analysis of the code, and dynamically
70 generate completions both using static analysis of the code, and dynamically
71 inspecting multiple namespaces. Jedi is an autocompletion and static analysis
71 inspecting multiple namespaces. Jedi is an autocompletion and static analysis
72 for Python. The APIs attached to this new mechanism is unstable and will
72 for Python. The APIs attached to this new mechanism is unstable and will
73 raise unless use in an :any:`provisionalcompleter` context manager.
73 raise unless use in an :any:`provisionalcompleter` context manager.
74
74
75 You will find that the following are experimental:
75 You will find that the following are experimental:
76
76
77 - :any:`provisionalcompleter`
77 - :any:`provisionalcompleter`
78 - :any:`IPCompleter.completions`
78 - :any:`IPCompleter.completions`
79 - :any:`Completion`
79 - :any:`Completion`
80 - :any:`rectify_completions`
80 - :any:`rectify_completions`
81
81
82 .. note::
82 .. note::
83
83
84 better name for :any:`rectify_completions` ?
84 better name for :any:`rectify_completions` ?
85
85
86 We welcome any feedback on these new API, and we also encourage you to try this
86 We welcome any feedback on these new API, and we also encourage you to try this
87 module in debug mode (start IPython with ``--Completer.debug=True``) in order
87 module in debug mode (start IPython with ``--Completer.debug=True``) in order
88 to have extra logging information if :any:`jedi` is crashing, or if current
88 to have extra logging information if :any:`jedi` is crashing, or if current
89 IPython completer pending deprecations are returning results not yet handled
89 IPython completer pending deprecations are returning results not yet handled
90 by :any:`jedi`
90 by :any:`jedi`
91
91
92 Using Jedi for tab completion allow snippets like the following to work without
92 Using Jedi for tab completion allow snippets like the following to work without
93 having to execute any code:
93 having to execute any code:
94
94
95 >>> myvar = ['hello', 42]
95 >>> myvar = ['hello', 42]
96 ... myvar[1].bi<tab>
96 ... myvar[1].bi<tab>
97
97
98 Tab completion will be able to infer that ``myvar[1]`` is a real number without
98 Tab completion will be able to infer that ``myvar[1]`` is a real number without
99 executing almost any code unlike the deprecated :any:`IPCompleter.greedy`
99 executing almost any code unlike the deprecated :any:`IPCompleter.greedy`
100 option.
100 option.
101
101
102 Be sure to update :any:`jedi` to the latest stable version or to try the
102 Be sure to update :any:`jedi` to the latest stable version or to try the
103 current development version to get better completions.
103 current development version to get better completions.
104
104
105 Matchers
105 Matchers
106 ========
106 ========
107
107
108 All completions routines are implemented using unified *Matchers* API.
108 All completions routines are implemented using unified *Matchers* API.
109 The matchers API is provisional and subject to change without notice.
109 The matchers API is provisional and subject to change without notice.
110
110
111 The built-in matchers include:
111 The built-in matchers include:
112
112
113 - :any:`IPCompleter.dict_key_matcher`: dictionary key completions,
113 - :any:`IPCompleter.dict_key_matcher`: dictionary key completions,
114 - :any:`IPCompleter.magic_matcher`: completions for magics,
114 - :any:`IPCompleter.magic_matcher`: completions for magics,
115 - :any:`IPCompleter.unicode_name_matcher`,
115 - :any:`IPCompleter.unicode_name_matcher`,
116 :any:`IPCompleter.fwd_unicode_matcher`
116 :any:`IPCompleter.fwd_unicode_matcher`
117 and :any:`IPCompleter.latex_name_matcher`: see `Forward latex/unicode completion`_,
117 and :any:`IPCompleter.latex_name_matcher`: see `Forward latex/unicode completion`_,
118 - :any:`back_unicode_name_matcher` and :any:`back_latex_name_matcher`: see `Backward latex completion`_,
118 - :any:`back_unicode_name_matcher` and :any:`back_latex_name_matcher`: see `Backward latex completion`_,
119 - :any:`IPCompleter.file_matcher`: paths to files and directories,
119 - :any:`IPCompleter.file_matcher`: paths to files and directories,
120 - :any:`IPCompleter.python_func_kw_matcher` - function keywords,
120 - :any:`IPCompleter.python_func_kw_matcher` - function keywords,
121 - :any:`IPCompleter.python_matches` - globals and attributes (v1 API),
121 - :any:`IPCompleter.python_matches` - globals and attributes (v1 API),
122 - ``IPCompleter.jedi_matcher`` - static analysis with Jedi,
122 - ``IPCompleter.jedi_matcher`` - static analysis with Jedi,
123 - :any:`IPCompleter.custom_completer_matcher` - pluggable completer with a default
123 - :any:`IPCompleter.custom_completer_matcher` - pluggable completer with a default
124 implementation in :any:`InteractiveShell` which uses IPython hooks system
124 implementation in :any:`InteractiveShell` which uses IPython hooks system
125 (`complete_command`) with string dispatch (including regular expressions).
125 (`complete_command`) with string dispatch (including regular expressions).
126 Differently to other matchers, ``custom_completer_matcher`` will not suppress
126 Differently to other matchers, ``custom_completer_matcher`` will not suppress
127 Jedi results to match behaviour in earlier IPython versions.
127 Jedi results to match behaviour in earlier IPython versions.
128
128
129 Custom matchers can be added by appending to ``IPCompleter.custom_matchers`` list.
129 Custom matchers can be added by appending to ``IPCompleter.custom_matchers`` list.
130
130
131 Matcher API
131 Matcher API
132 -----------
132 -----------
133
133
134 Simplifying some details, the ``Matcher`` interface can described as
134 Simplifying some details, the ``Matcher`` interface can described as
135
135
136 .. code-block::
136 .. code-block::
137
137
138 MatcherAPIv1 = Callable[[str], list[str]]
138 MatcherAPIv1 = Callable[[str], list[str]]
139 MatcherAPIv2 = Callable[[CompletionContext], SimpleMatcherResult]
139 MatcherAPIv2 = Callable[[CompletionContext], SimpleMatcherResult]
140
140
141 Matcher = MatcherAPIv1 | MatcherAPIv2
141 Matcher = MatcherAPIv1 | MatcherAPIv2
142
142
143 The ``MatcherAPIv1`` reflects the matcher API as available prior to IPython 8.6.0
143 The ``MatcherAPIv1`` reflects the matcher API as available prior to IPython 8.6.0
144 and remains supported as a simplest way for generating completions. This is also
144 and remains supported as a simplest way for generating completions. This is also
145 currently the only API supported by the IPython hooks system `complete_command`.
145 currently the only API supported by the IPython hooks system `complete_command`.
146
146
147 To distinguish between matcher versions ``matcher_api_version`` attribute is used.
147 To distinguish between matcher versions ``matcher_api_version`` attribute is used.
148 More precisely, the API allows to omit ``matcher_api_version`` for v1 Matchers,
148 More precisely, the API allows to omit ``matcher_api_version`` for v1 Matchers,
149 and requires a literal ``2`` for v2 Matchers.
149 and requires a literal ``2`` for v2 Matchers.
150
150
151 Once the API stabilises future versions may relax the requirement for specifying
151 Once the API stabilises future versions may relax the requirement for specifying
152 ``matcher_api_version`` by switching to :any:`functools.singledispatch`, therefore
152 ``matcher_api_version`` by switching to :any:`functools.singledispatch`, therefore
153 please do not rely on the presence of ``matcher_api_version`` for any purposes.
153 please do not rely on the presence of ``matcher_api_version`` for any purposes.
154
154
155 Suppression of competing matchers
155 Suppression of competing matchers
156 ---------------------------------
156 ---------------------------------
157
157
158 By default results from all matchers are combined, in the order determined by
158 By default results from all matchers are combined, in the order determined by
159 their priority. Matchers can request to suppress results from subsequent
159 their priority. Matchers can request to suppress results from subsequent
160 matchers by setting ``suppress`` to ``True`` in the ``MatcherResult``.
160 matchers by setting ``suppress`` to ``True`` in the ``MatcherResult``.
161
161
162 When multiple matchers simultaneously request suppression, the results from of
162 When multiple matchers simultaneously request suppression, the results from of
163 the matcher with higher priority will be returned.
163 the matcher with higher priority will be returned.
164
164
165 Sometimes it is desirable to suppress most but not all other matchers;
165 Sometimes it is desirable to suppress most but not all other matchers;
166 this can be achieved by adding a set of identifiers of matchers which
166 this can be achieved by adding a set of identifiers of matchers which
167 should not be suppressed to ``MatcherResult`` under ``do_not_suppress`` key.
167 should not be suppressed to ``MatcherResult`` under ``do_not_suppress`` key.
168
168
169 The suppression behaviour can is user-configurable via
169 The suppression behaviour can is user-configurable via
170 :std:configtrait:`IPCompleter.suppress_competing_matchers`.
170 :std:configtrait:`IPCompleter.suppress_competing_matchers`.
171 """
171 """
172
172
173
173
174 # Copyright (c) IPython Development Team.
174 # Copyright (c) IPython Development Team.
175 # Distributed under the terms of the Modified BSD License.
175 # Distributed under the terms of the Modified BSD License.
176 #
176 #
177 # Some of this code originated from rlcompleter in the Python standard library
177 # Some of this code originated from rlcompleter in the Python standard library
178 # Copyright (C) 2001 Python Software Foundation, www.python.org
178 # Copyright (C) 2001 Python Software Foundation, www.python.org
179
179
180 from __future__ import annotations
180 from __future__ import annotations
181 import builtins as builtin_mod
181 import builtins as builtin_mod
182 import enum
182 import enum
183 import glob
183 import glob
184 import inspect
184 import inspect
185 import itertools
185 import itertools
186 import keyword
186 import keyword
187 import os
187 import os
188 import re
188 import re
189 import string
189 import string
190 import sys
190 import sys
191 import tokenize
191 import tokenize
192 import time
192 import time
193 import unicodedata
193 import unicodedata
194 import uuid
194 import uuid
195 import warnings
195 import warnings
196 from ast import literal_eval
196 from ast import literal_eval
197 from collections import defaultdict
197 from collections import defaultdict
198 from contextlib import contextmanager
198 from contextlib import contextmanager
199 from dataclasses import dataclass
199 from dataclasses import dataclass
200 from functools import cached_property, partial
200 from functools import cached_property, partial
201 from types import SimpleNamespace
201 from types import SimpleNamespace
202 from typing import (
202 from typing import (
203 Iterable,
203 Iterable,
204 Iterator,
204 Iterator,
205 List,
205 List,
206 Tuple,
206 Tuple,
207 Union,
207 Union,
208 Any,
208 Any,
209 Sequence,
209 Sequence,
210 Dict,
210 Dict,
211 Optional,
211 Optional,
212 TYPE_CHECKING,
212 TYPE_CHECKING,
213 Set,
213 Set,
214 Sized,
214 Sized,
215 TypeVar,
215 TypeVar,
216 Literal,
216 Literal,
217 )
217 )
218
218
219 from IPython.core.guarded_eval import guarded_eval, EvaluationContext
219 from IPython.core.guarded_eval import guarded_eval, EvaluationContext
220 from IPython.core.error import TryNext
220 from IPython.core.error import TryNext
221 from IPython.core.inputtransformer2 import ESC_MAGIC
221 from IPython.core.inputtransformer2 import ESC_MAGIC
222 from IPython.core.latex_symbols import latex_symbols, reverse_latex_symbol
222 from IPython.core.latex_symbols import latex_symbols, reverse_latex_symbol
223 from IPython.core.oinspect import InspectColors
223 from IPython.core.oinspect import InspectColors
224 from IPython.testing.skipdoctest import skip_doctest
224 from IPython.testing.skipdoctest import skip_doctest
225 from IPython.utils import generics
225 from IPython.utils import generics
226 from IPython.utils.decorators import sphinx_options
226 from IPython.utils.decorators import sphinx_options
227 from IPython.utils.dir2 import dir2, get_real_method
227 from IPython.utils.dir2 import dir2, get_real_method
228 from IPython.utils.docs import GENERATING_DOCUMENTATION
228 from IPython.utils.docs import GENERATING_DOCUMENTATION
229 from IPython.utils.path import ensure_dir_exists
229 from IPython.utils.path import ensure_dir_exists
230 from IPython.utils.process import arg_split
230 from IPython.utils.process import arg_split
231 from traitlets import (
231 from traitlets import (
232 Bool,
232 Bool,
233 Enum,
233 Enum,
234 Int,
234 Int,
235 List as ListTrait,
235 List as ListTrait,
236 Unicode,
236 Unicode,
237 Dict as DictTrait,
237 Dict as DictTrait,
238 Union as UnionTrait,
238 Union as UnionTrait,
239 observe,
239 observe,
240 )
240 )
241 from traitlets.config.configurable import Configurable
241 from traitlets.config.configurable import Configurable
242
242
243 import __main__
243 import __main__
244
244
245 # skip module docstests
245 # skip module docstests
246 __skip_doctest__ = True
246 __skip_doctest__ = True
247
247
248
248
249 try:
249 try:
250 import jedi
250 import jedi
251 jedi.settings.case_insensitive_completion = False
251 jedi.settings.case_insensitive_completion = False
252 import jedi.api.helpers
252 import jedi.api.helpers
253 import jedi.api.classes
253 import jedi.api.classes
254 JEDI_INSTALLED = True
254 JEDI_INSTALLED = True
255 except ImportError:
255 except ImportError:
256 JEDI_INSTALLED = False
256 JEDI_INSTALLED = False
257
257
258
258
259 if TYPE_CHECKING or GENERATING_DOCUMENTATION and sys.version_info >= (3, 11):
259 if TYPE_CHECKING or GENERATING_DOCUMENTATION and sys.version_info >= (3, 11):
260 from typing import cast
260 from typing import cast
261 from typing_extensions import TypedDict, NotRequired, Protocol, TypeAlias, TypeGuard
261 from typing_extensions import TypedDict, NotRequired, Protocol, TypeAlias, TypeGuard
262 else:
262 else:
263 from typing import Generic
263 from typing import Generic
264
264
265 def cast(type_, obj):
265 def cast(type_, obj):
266 """Workaround for `TypeError: MatcherAPIv2() takes no arguments`"""
266 """Workaround for `TypeError: MatcherAPIv2() takes no arguments`"""
267 return obj
267 return obj
268
268
269 # do not require on runtime
269 # do not require on runtime
270 NotRequired = Tuple # requires Python >=3.11
270 NotRequired = Tuple # requires Python >=3.11
271 TypedDict = Dict # by extension of `NotRequired` requires 3.11 too
271 TypedDict = Dict # by extension of `NotRequired` requires 3.11 too
272 Protocol = object # requires Python >=3.8
272 Protocol = object # requires Python >=3.8
273 TypeAlias = Any # requires Python >=3.10
273 TypeAlias = Any # requires Python >=3.10
274 TypeGuard = Generic # requires Python >=3.10
274 TypeGuard = Generic # requires Python >=3.10
275 if GENERATING_DOCUMENTATION:
275 if GENERATING_DOCUMENTATION:
276 from typing import TypedDict
276 from typing import TypedDict
277
277
278 # -----------------------------------------------------------------------------
278 # -----------------------------------------------------------------------------
279 # Globals
279 # Globals
280 #-----------------------------------------------------------------------------
280 #-----------------------------------------------------------------------------
281
281
282 # ranges where we have most of the valid unicode names. We could be more finer
282 # ranges where we have most of the valid unicode names. We could be more finer
283 # grained but is it worth it for performance While unicode have character in the
283 # grained but is it worth it for performance While unicode have character in the
284 # range 0, 0x110000, we seem to have name for about 10% of those. (131808 as I
284 # range 0, 0x110000, we seem to have name for about 10% of those. (131808 as I
285 # write this). With below range we cover them all, with a density of ~67%
285 # write this). With below range we cover them all, with a density of ~67%
286 # biggest next gap we consider only adds up about 1% density and there are 600
286 # biggest next gap we consider only adds up about 1% density and there are 600
287 # gaps that would need hard coding.
287 # gaps that would need hard coding.
288 _UNICODE_RANGES = [(32, 0x323B0), (0xE0001, 0xE01F0)]
288 _UNICODE_RANGES = [(32, 0x323B0), (0xE0001, 0xE01F0)]
289
289
290 # Public API
290 # Public API
291 __all__ = ["Completer", "IPCompleter"]
291 __all__ = ["Completer", "IPCompleter"]
292
292
293 if sys.platform == 'win32':
293 if sys.platform == 'win32':
294 PROTECTABLES = ' '
294 PROTECTABLES = ' '
295 else:
295 else:
296 PROTECTABLES = ' ()[]{}?=\\|;:\'#*"^&'
296 PROTECTABLES = ' ()[]{}?=\\|;:\'#*"^&'
297
297
298 # Protect against returning an enormous number of completions which the frontend
298 # Protect against returning an enormous number of completions which the frontend
299 # may have trouble processing.
299 # may have trouble processing.
300 MATCHES_LIMIT = 500
300 MATCHES_LIMIT = 500
301
301
302 # Completion type reported when no type can be inferred.
302 # Completion type reported when no type can be inferred.
303 _UNKNOWN_TYPE = "<unknown>"
303 _UNKNOWN_TYPE = "<unknown>"
304
304
305 # sentinel value to signal lack of a match
305 # sentinel value to signal lack of a match
306 not_found = object()
306 not_found = object()
307
307
308 class ProvisionalCompleterWarning(FutureWarning):
308 class ProvisionalCompleterWarning(FutureWarning):
309 """
309 """
310 Exception raise by an experimental feature in this module.
310 Exception raise by an experimental feature in this module.
311
311
312 Wrap code in :any:`provisionalcompleter` context manager if you
312 Wrap code in :any:`provisionalcompleter` context manager if you
313 are certain you want to use an unstable feature.
313 are certain you want to use an unstable feature.
314 """
314 """
315 pass
315 pass
316
316
317 warnings.filterwarnings('error', category=ProvisionalCompleterWarning)
317 warnings.filterwarnings('error', category=ProvisionalCompleterWarning)
318
318
319
319
320 @skip_doctest
320 @skip_doctest
321 @contextmanager
321 @contextmanager
322 def provisionalcompleter(action='ignore'):
322 def provisionalcompleter(action='ignore'):
323 """
323 """
324 This context manager has to be used in any place where unstable completer
324 This context manager has to be used in any place where unstable completer
325 behavior and API may be called.
325 behavior and API may be called.
326
326
327 >>> with provisionalcompleter():
327 >>> with provisionalcompleter():
328 ... completer.do_experimental_things() # works
328 ... completer.do_experimental_things() # works
329
329
330 >>> completer.do_experimental_things() # raises.
330 >>> completer.do_experimental_things() # raises.
331
331
332 .. note::
332 .. note::
333
333
334 Unstable
334 Unstable
335
335
336 By using this context manager you agree that the API in use may change
336 By using this context manager you agree that the API in use may change
337 without warning, and that you won't complain if they do so.
337 without warning, and that you won't complain if they do so.
338
338
339 You also understand that, if the API is not to your liking, you should report
339 You also understand that, if the API is not to your liking, you should report
340 a bug to explain your use case upstream.
340 a bug to explain your use case upstream.
341
341
342 We'll be happy to get your feedback, feature requests, and improvements on
342 We'll be happy to get your feedback, feature requests, and improvements on
343 any of the unstable APIs!
343 any of the unstable APIs!
344 """
344 """
345 with warnings.catch_warnings():
345 with warnings.catch_warnings():
346 warnings.filterwarnings(action, category=ProvisionalCompleterWarning)
346 warnings.filterwarnings(action, category=ProvisionalCompleterWarning)
347 yield
347 yield
348
348
349
349
350 def has_open_quotes(s):
350 def has_open_quotes(s):
351 """Return whether a string has open quotes.
351 """Return whether a string has open quotes.
352
352
353 This simply counts whether the number of quote characters of either type in
353 This simply counts whether the number of quote characters of either type in
354 the string is odd.
354 the string is odd.
355
355
356 Returns
356 Returns
357 -------
357 -------
358 If there is an open quote, the quote character is returned. Else, return
358 If there is an open quote, the quote character is returned. Else, return
359 False.
359 False.
360 """
360 """
361 # We check " first, then ', so complex cases with nested quotes will get
361 # We check " first, then ', so complex cases with nested quotes will get
362 # the " to take precedence.
362 # the " to take precedence.
363 if s.count('"') % 2:
363 if s.count('"') % 2:
364 return '"'
364 return '"'
365 elif s.count("'") % 2:
365 elif s.count("'") % 2:
366 return "'"
366 return "'"
367 else:
367 else:
368 return False
368 return False
369
369
370
370
371 def protect_filename(s, protectables=PROTECTABLES):
371 def protect_filename(s, protectables=PROTECTABLES):
372 """Escape a string to protect certain characters."""
372 """Escape a string to protect certain characters."""
373 if set(s) & set(protectables):
373 if set(s) & set(protectables):
374 if sys.platform == "win32":
374 if sys.platform == "win32":
375 return '"' + s + '"'
375 return '"' + s + '"'
376 else:
376 else:
377 return "".join(("\\" + c if c in protectables else c) for c in s)
377 return "".join(("\\" + c if c in protectables else c) for c in s)
378 else:
378 else:
379 return s
379 return s
380
380
381
381
382 def expand_user(path:str) -> Tuple[str, bool, str]:
382 def expand_user(path:str) -> Tuple[str, bool, str]:
383 """Expand ``~``-style usernames in strings.
383 """Expand ``~``-style usernames in strings.
384
384
385 This is similar to :func:`os.path.expanduser`, but it computes and returns
385 This is similar to :func:`os.path.expanduser`, but it computes and returns
386 extra information that will be useful if the input was being used in
386 extra information that will be useful if the input was being used in
387 computing completions, and you wish to return the completions with the
387 computing completions, and you wish to return the completions with the
388 original '~' instead of its expanded value.
388 original '~' instead of its expanded value.
389
389
390 Parameters
390 Parameters
391 ----------
391 ----------
392 path : str
392 path : str
393 String to be expanded. If no ~ is present, the output is the same as the
393 String to be expanded. If no ~ is present, the output is the same as the
394 input.
394 input.
395
395
396 Returns
396 Returns
397 -------
397 -------
398 newpath : str
398 newpath : str
399 Result of ~ expansion in the input path.
399 Result of ~ expansion in the input path.
400 tilde_expand : bool
400 tilde_expand : bool
401 Whether any expansion was performed or not.
401 Whether any expansion was performed or not.
402 tilde_val : str
402 tilde_val : str
403 The value that ~ was replaced with.
403 The value that ~ was replaced with.
404 """
404 """
405 # Default values
405 # Default values
406 tilde_expand = False
406 tilde_expand = False
407 tilde_val = ''
407 tilde_val = ''
408 newpath = path
408 newpath = path
409
409
410 if path.startswith('~'):
410 if path.startswith('~'):
411 tilde_expand = True
411 tilde_expand = True
412 rest = len(path)-1
412 rest = len(path)-1
413 newpath = os.path.expanduser(path)
413 newpath = os.path.expanduser(path)
414 if rest:
414 if rest:
415 tilde_val = newpath[:-rest]
415 tilde_val = newpath[:-rest]
416 else:
416 else:
417 tilde_val = newpath
417 tilde_val = newpath
418
418
419 return newpath, tilde_expand, tilde_val
419 return newpath, tilde_expand, tilde_val
420
420
421
421
422 def compress_user(path:str, tilde_expand:bool, tilde_val:str) -> str:
422 def compress_user(path:str, tilde_expand:bool, tilde_val:str) -> str:
423 """Does the opposite of expand_user, with its outputs.
423 """Does the opposite of expand_user, with its outputs.
424 """
424 """
425 if tilde_expand:
425 if tilde_expand:
426 return path.replace(tilde_val, '~')
426 return path.replace(tilde_val, '~')
427 else:
427 else:
428 return path
428 return path
429
429
430
430
431 def completions_sorting_key(word):
431 def completions_sorting_key(word):
432 """key for sorting completions
432 """key for sorting completions
433
433
434 This does several things:
434 This does several things:
435
435
436 - Demote any completions starting with underscores to the end
436 - Demote any completions starting with underscores to the end
437 - Insert any %magic and %%cellmagic completions in the alphabetical order
437 - Insert any %magic and %%cellmagic completions in the alphabetical order
438 by their name
438 by their name
439 """
439 """
440 prio1, prio2 = 0, 0
440 prio1, prio2 = 0, 0
441
441
442 if word.startswith('__'):
442 if word.startswith('__'):
443 prio1 = 2
443 prio1 = 2
444 elif word.startswith('_'):
444 elif word.startswith('_'):
445 prio1 = 1
445 prio1 = 1
446
446
447 if word.endswith('='):
447 if word.endswith('='):
448 prio1 = -1
448 prio1 = -1
449
449
450 if word.startswith('%%'):
450 if word.startswith('%%'):
451 # If there's another % in there, this is something else, so leave it alone
451 # If there's another % in there, this is something else, so leave it alone
452 if not "%" in word[2:]:
452 if not "%" in word[2:]:
453 word = word[2:]
453 word = word[2:]
454 prio2 = 2
454 prio2 = 2
455 elif word.startswith('%'):
455 elif word.startswith('%'):
456 if not "%" in word[1:]:
456 if not "%" in word[1:]:
457 word = word[1:]
457 word = word[1:]
458 prio2 = 1
458 prio2 = 1
459
459
460 return prio1, word, prio2
460 return prio1, word, prio2
461
461
462
462
463 class _FakeJediCompletion:
463 class _FakeJediCompletion:
464 """
464 """
465 This is a workaround to communicate to the UI that Jedi has crashed and to
465 This is a workaround to communicate to the UI that Jedi has crashed and to
466 report a bug. Will be used only id :any:`IPCompleter.debug` is set to true.
466 report a bug. Will be used only id :any:`IPCompleter.debug` is set to true.
467
467
468 Added in IPython 6.0 so should likely be removed for 7.0
468 Added in IPython 6.0 so should likely be removed for 7.0
469
469
470 """
470 """
471
471
472 def __init__(self, name):
472 def __init__(self, name):
473
473
474 self.name = name
474 self.name = name
475 self.complete = name
475 self.complete = name
476 self.type = 'crashed'
476 self.type = 'crashed'
477 self.name_with_symbols = name
477 self.name_with_symbols = name
478 self.signature = ""
478 self.signature = ""
479 self._origin = "fake"
479 self._origin = "fake"
480 self.text = "crashed"
480 self.text = "crashed"
481
481
482 def __repr__(self):
482 def __repr__(self):
483 return '<Fake completion object jedi has crashed>'
483 return '<Fake completion object jedi has crashed>'
484
484
485
485
486 _JediCompletionLike = Union["jedi.api.Completion", _FakeJediCompletion]
486 _JediCompletionLike = Union["jedi.api.Completion", _FakeJediCompletion]
487
487
488
488
489 class Completion:
489 class Completion:
490 """
490 """
491 Completion object used and returned by IPython completers.
491 Completion object used and returned by IPython completers.
492
492
493 .. warning::
493 .. warning::
494
494
495 Unstable
495 Unstable
496
496
497 This function is unstable, API may change without warning.
497 This function is unstable, API may change without warning.
498 It will also raise unless use in proper context manager.
498 It will also raise unless use in proper context manager.
499
499
500 This act as a middle ground :any:`Completion` object between the
500 This act as a middle ground :any:`Completion` object between the
501 :any:`jedi.api.classes.Completion` object and the Prompt Toolkit completion
501 :any:`jedi.api.classes.Completion` object and the Prompt Toolkit completion
502 object. While Jedi need a lot of information about evaluator and how the
502 object. While Jedi need a lot of information about evaluator and how the
503 code should be ran/inspected, PromptToolkit (and other frontend) mostly
503 code should be ran/inspected, PromptToolkit (and other frontend) mostly
504 need user facing information.
504 need user facing information.
505
505
506 - Which range should be replaced replaced by what.
506 - Which range should be replaced replaced by what.
507 - Some metadata (like completion type), or meta information to displayed to
507 - Some metadata (like completion type), or meta information to displayed to
508 the use user.
508 the use user.
509
509
510 For debugging purpose we can also store the origin of the completion (``jedi``,
510 For debugging purpose we can also store the origin of the completion (``jedi``,
511 ``IPython.python_matches``, ``IPython.magics_matches``...).
511 ``IPython.python_matches``, ``IPython.magics_matches``...).
512 """
512 """
513
513
514 __slots__ = ['start', 'end', 'text', 'type', 'signature', '_origin']
514 __slots__ = ['start', 'end', 'text', 'type', 'signature', '_origin']
515
515
516 def __init__(
516 def __init__(
517 self,
517 self,
518 start: int,
518 start: int,
519 end: int,
519 end: int,
520 text: str,
520 text: str,
521 *,
521 *,
522 type: Optional[str] = None,
522 type: Optional[str] = None,
523 _origin="",
523 _origin="",
524 signature="",
524 signature="",
525 ) -> None:
525 ) -> None:
526 warnings.warn(
526 warnings.warn(
527 "``Completion`` is a provisional API (as of IPython 6.0). "
527 "``Completion`` is a provisional API (as of IPython 6.0). "
528 "It may change without warnings. "
528 "It may change without warnings. "
529 "Use in corresponding context manager.",
529 "Use in corresponding context manager.",
530 category=ProvisionalCompleterWarning,
530 category=ProvisionalCompleterWarning,
531 stacklevel=2,
531 stacklevel=2,
532 )
532 )
533
533
534 self.start = start
534 self.start = start
535 self.end = end
535 self.end = end
536 self.text = text
536 self.text = text
537 self.type = type
537 self.type = type
538 self.signature = signature
538 self.signature = signature
539 self._origin = _origin
539 self._origin = _origin
540
540
541 def __repr__(self):
541 def __repr__(self):
542 return '<Completion start=%s end=%s text=%r type=%r, signature=%r,>' % \
542 return '<Completion start=%s end=%s text=%r type=%r, signature=%r,>' % \
543 (self.start, self.end, self.text, self.type or '?', self.signature or '?')
543 (self.start, self.end, self.text, self.type or '?', self.signature or '?')
544
544
545 def __eq__(self, other) -> bool:
545 def __eq__(self, other) -> bool:
546 """
546 """
547 Equality and hash do not hash the type (as some completer may not be
547 Equality and hash do not hash the type (as some completer may not be
548 able to infer the type), but are use to (partially) de-duplicate
548 able to infer the type), but are use to (partially) de-duplicate
549 completion.
549 completion.
550
550
551 Completely de-duplicating completion is a bit tricker that just
551 Completely de-duplicating completion is a bit tricker that just
552 comparing as it depends on surrounding text, which Completions are not
552 comparing as it depends on surrounding text, which Completions are not
553 aware of.
553 aware of.
554 """
554 """
555 return self.start == other.start and \
555 return self.start == other.start and \
556 self.end == other.end and \
556 self.end == other.end and \
557 self.text == other.text
557 self.text == other.text
558
558
559 def __hash__(self):
559 def __hash__(self):
560 return hash((self.start, self.end, self.text))
560 return hash((self.start, self.end, self.text))
561
561
562
562
563 class SimpleCompletion:
563 class SimpleCompletion:
564 """Completion item to be included in the dictionary returned by new-style Matcher (API v2).
564 """Completion item to be included in the dictionary returned by new-style Matcher (API v2).
565
565
566 .. warning::
566 .. warning::
567
567
568 Provisional
568 Provisional
569
569
570 This class is used to describe the currently supported attributes of
570 This class is used to describe the currently supported attributes of
571 simple completion items, and any additional implementation details
571 simple completion items, and any additional implementation details
572 should not be relied on. Additional attributes may be included in
572 should not be relied on. Additional attributes may be included in
573 future versions, and meaning of text disambiguated from the current
573 future versions, and meaning of text disambiguated from the current
574 dual meaning of "text to insert" and "text to used as a label".
574 dual meaning of "text to insert" and "text to used as a label".
575 """
575 """
576
576
577 __slots__ = ["text", "type"]
577 __slots__ = ["text", "type"]
578
578
579 def __init__(self, text: str, *, type: Optional[str] = None):
579 def __init__(self, text: str, *, type: Optional[str] = None):
580 self.text = text
580 self.text = text
581 self.type = type
581 self.type = type
582
582
583 def __repr__(self):
583 def __repr__(self):
584 return f"<SimpleCompletion text={self.text!r} type={self.type!r}>"
584 return f"<SimpleCompletion text={self.text!r} type={self.type!r}>"
585
585
586
586
587 class _MatcherResultBase(TypedDict):
587 class _MatcherResultBase(TypedDict):
588 """Definition of dictionary to be returned by new-style Matcher (API v2)."""
588 """Definition of dictionary to be returned by new-style Matcher (API v2)."""
589
589
590 #: Suffix of the provided ``CompletionContext.token``, if not given defaults to full token.
590 #: Suffix of the provided ``CompletionContext.token``, if not given defaults to full token.
591 matched_fragment: NotRequired[str]
591 matched_fragment: NotRequired[str]
592
592
593 #: Whether to suppress results from all other matchers (True), some
593 #: Whether to suppress results from all other matchers (True), some
594 #: matchers (set of identifiers) or none (False); default is False.
594 #: matchers (set of identifiers) or none (False); default is False.
595 suppress: NotRequired[Union[bool, Set[str]]]
595 suppress: NotRequired[Union[bool, Set[str]]]
596
596
597 #: Identifiers of matchers which should NOT be suppressed when this matcher
597 #: Identifiers of matchers which should NOT be suppressed when this matcher
598 #: requests to suppress all other matchers; defaults to an empty set.
598 #: requests to suppress all other matchers; defaults to an empty set.
599 do_not_suppress: NotRequired[Set[str]]
599 do_not_suppress: NotRequired[Set[str]]
600
600
601 #: Are completions already ordered and should be left as-is? default is False.
601 #: Are completions already ordered and should be left as-is? default is False.
602 ordered: NotRequired[bool]
602 ordered: NotRequired[bool]
603
603
604
604
605 @sphinx_options(show_inherited_members=True, exclude_inherited_from=["dict"])
605 @sphinx_options(show_inherited_members=True, exclude_inherited_from=["dict"])
606 class SimpleMatcherResult(_MatcherResultBase, TypedDict):
606 class SimpleMatcherResult(_MatcherResultBase, TypedDict):
607 """Result of new-style completion matcher."""
607 """Result of new-style completion matcher."""
608
608
609 # note: TypedDict is added again to the inheritance chain
609 # note: TypedDict is added again to the inheritance chain
610 # in order to get __orig_bases__ for documentation
610 # in order to get __orig_bases__ for documentation
611
611
612 #: List of candidate completions
612 #: List of candidate completions
613 completions: Sequence[SimpleCompletion] | Iterator[SimpleCompletion]
613 completions: Sequence[SimpleCompletion] | Iterator[SimpleCompletion]
614
614
615
615
616 class _JediMatcherResult(_MatcherResultBase):
616 class _JediMatcherResult(_MatcherResultBase):
617 """Matching result returned by Jedi (will be processed differently)"""
617 """Matching result returned by Jedi (will be processed differently)"""
618
618
619 #: list of candidate completions
619 #: list of candidate completions
620 completions: Iterator[_JediCompletionLike]
620 completions: Iterator[_JediCompletionLike]
621
621
622
622
623 AnyMatcherCompletion = Union[_JediCompletionLike, SimpleCompletion]
623 AnyMatcherCompletion = Union[_JediCompletionLike, SimpleCompletion]
624 AnyCompletion = TypeVar("AnyCompletion", AnyMatcherCompletion, Completion)
624 AnyCompletion = TypeVar("AnyCompletion", AnyMatcherCompletion, Completion)
625
625
626
626
627 @dataclass
627 @dataclass
628 class CompletionContext:
628 class CompletionContext:
629 """Completion context provided as an argument to matchers in the Matcher API v2."""
629 """Completion context provided as an argument to matchers in the Matcher API v2."""
630
630
631 # rationale: many legacy matchers relied on completer state (`self.text_until_cursor`)
631 # rationale: many legacy matchers relied on completer state (`self.text_until_cursor`)
632 # which was not explicitly visible as an argument of the matcher, making any refactor
632 # which was not explicitly visible as an argument of the matcher, making any refactor
633 # prone to errors; by explicitly passing `cursor_position` we can decouple the matchers
633 # prone to errors; by explicitly passing `cursor_position` we can decouple the matchers
634 # from the completer, and make substituting them in sub-classes easier.
634 # from the completer, and make substituting them in sub-classes easier.
635
635
636 #: Relevant fragment of code directly preceding the cursor.
636 #: Relevant fragment of code directly preceding the cursor.
637 #: The extraction of token is implemented via splitter heuristic
637 #: The extraction of token is implemented via splitter heuristic
638 #: (following readline behaviour for legacy reasons), which is user configurable
638 #: (following readline behaviour for legacy reasons), which is user configurable
639 #: (by switching the greedy mode).
639 #: (by switching the greedy mode).
640 token: str
640 token: str
641
641
642 #: The full available content of the editor or buffer
642 #: The full available content of the editor or buffer
643 full_text: str
643 full_text: str
644
644
645 #: Cursor position in the line (the same for ``full_text`` and ``text``).
645 #: Cursor position in the line (the same for ``full_text`` and ``text``).
646 cursor_position: int
646 cursor_position: int
647
647
648 #: Cursor line in ``full_text``.
648 #: Cursor line in ``full_text``.
649 cursor_line: int
649 cursor_line: int
650
650
651 #: The maximum number of completions that will be used downstream.
651 #: The maximum number of completions that will be used downstream.
652 #: Matchers can use this information to abort early.
652 #: Matchers can use this information to abort early.
653 #: The built-in Jedi matcher is currently excepted from this limit.
653 #: The built-in Jedi matcher is currently excepted from this limit.
654 # If not given, return all possible completions.
654 # If not given, return all possible completions.
655 limit: Optional[int]
655 limit: Optional[int]
656
656
657 @cached_property
657 @cached_property
658 def text_until_cursor(self) -> str:
658 def text_until_cursor(self) -> str:
659 return self.line_with_cursor[: self.cursor_position]
659 return self.line_with_cursor[: self.cursor_position]
660
660
661 @cached_property
661 @cached_property
662 def line_with_cursor(self) -> str:
662 def line_with_cursor(self) -> str:
663 return self.full_text.split("\n")[self.cursor_line]
663 return self.full_text.split("\n")[self.cursor_line]
664
664
665
665
666 #: Matcher results for API v2.
666 #: Matcher results for API v2.
667 MatcherResult = Union[SimpleMatcherResult, _JediMatcherResult]
667 MatcherResult = Union[SimpleMatcherResult, _JediMatcherResult]
668
668
669
669
670 class _MatcherAPIv1Base(Protocol):
670 class _MatcherAPIv1Base(Protocol):
671 def __call__(self, text: str) -> List[str]:
671 def __call__(self, text: str) -> List[str]:
672 """Call signature."""
672 """Call signature."""
673 ...
673 ...
674
674
675 #: Used to construct the default matcher identifier
675 #: Used to construct the default matcher identifier
676 __qualname__: str
676 __qualname__: str
677
677
678
678
679 class _MatcherAPIv1Total(_MatcherAPIv1Base, Protocol):
679 class _MatcherAPIv1Total(_MatcherAPIv1Base, Protocol):
680 #: API version
680 #: API version
681 matcher_api_version: Optional[Literal[1]]
681 matcher_api_version: Optional[Literal[1]]
682
682
683 def __call__(self, text: str) -> List[str]:
683 def __call__(self, text: str) -> List[str]:
684 """Call signature."""
684 """Call signature."""
685 ...
685 ...
686
686
687
687
688 #: Protocol describing Matcher API v1.
688 #: Protocol describing Matcher API v1.
689 MatcherAPIv1: TypeAlias = Union[_MatcherAPIv1Base, _MatcherAPIv1Total]
689 MatcherAPIv1: TypeAlias = Union[_MatcherAPIv1Base, _MatcherAPIv1Total]
690
690
691
691
692 class MatcherAPIv2(Protocol):
692 class MatcherAPIv2(Protocol):
693 """Protocol describing Matcher API v2."""
693 """Protocol describing Matcher API v2."""
694
694
695 #: API version
695 #: API version
696 matcher_api_version: Literal[2] = 2
696 matcher_api_version: Literal[2] = 2
697
697
698 def __call__(self, context: CompletionContext) -> MatcherResult:
698 def __call__(self, context: CompletionContext) -> MatcherResult:
699 """Call signature."""
699 """Call signature."""
700 ...
700 ...
701
701
702 #: Used to construct the default matcher identifier
702 #: Used to construct the default matcher identifier
703 __qualname__: str
703 __qualname__: str
704
704
705
705
706 Matcher: TypeAlias = Union[MatcherAPIv1, MatcherAPIv2]
706 Matcher: TypeAlias = Union[MatcherAPIv1, MatcherAPIv2]
707
707
708
708
709 def _is_matcher_v1(matcher: Matcher) -> TypeGuard[MatcherAPIv1]:
709 def _is_matcher_v1(matcher: Matcher) -> TypeGuard[MatcherAPIv1]:
710 api_version = _get_matcher_api_version(matcher)
710 api_version = _get_matcher_api_version(matcher)
711 return api_version == 1
711 return api_version == 1
712
712
713
713
714 def _is_matcher_v2(matcher: Matcher) -> TypeGuard[MatcherAPIv2]:
714 def _is_matcher_v2(matcher: Matcher) -> TypeGuard[MatcherAPIv2]:
715 api_version = _get_matcher_api_version(matcher)
715 api_version = _get_matcher_api_version(matcher)
716 return api_version == 2
716 return api_version == 2
717
717
718
718
719 def _is_sizable(value: Any) -> TypeGuard[Sized]:
719 def _is_sizable(value: Any) -> TypeGuard[Sized]:
720 """Determines whether objects is sizable"""
720 """Determines whether objects is sizable"""
721 return hasattr(value, "__len__")
721 return hasattr(value, "__len__")
722
722
723
723
724 def _is_iterator(value: Any) -> TypeGuard[Iterator]:
724 def _is_iterator(value: Any) -> TypeGuard[Iterator]:
725 """Determines whether objects is sizable"""
725 """Determines whether objects is sizable"""
726 return hasattr(value, "__next__")
726 return hasattr(value, "__next__")
727
727
728
728
729 def has_any_completions(result: MatcherResult) -> bool:
729 def has_any_completions(result: MatcherResult) -> bool:
730 """Check if any result includes any completions."""
730 """Check if any result includes any completions."""
731 completions = result["completions"]
731 completions = result["completions"]
732 if _is_sizable(completions):
732 if _is_sizable(completions):
733 return len(completions) != 0
733 return len(completions) != 0
734 if _is_iterator(completions):
734 if _is_iterator(completions):
735 try:
735 try:
736 old_iterator = completions
736 old_iterator = completions
737 first = next(old_iterator)
737 first = next(old_iterator)
738 result["completions"] = cast(
738 result["completions"] = cast(
739 Iterator[SimpleCompletion],
739 Iterator[SimpleCompletion],
740 itertools.chain([first], old_iterator),
740 itertools.chain([first], old_iterator),
741 )
741 )
742 return True
742 return True
743 except StopIteration:
743 except StopIteration:
744 return False
744 return False
745 raise ValueError(
745 raise ValueError(
746 "Completions returned by matcher need to be an Iterator or a Sizable"
746 "Completions returned by matcher need to be an Iterator or a Sizable"
747 )
747 )
748
748
749
749
750 def completion_matcher(
750 def completion_matcher(
751 *,
751 *,
752 priority: Optional[float] = None,
752 priority: Optional[float] = None,
753 identifier: Optional[str] = None,
753 identifier: Optional[str] = None,
754 api_version: int = 1,
754 api_version: int = 1,
755 ):
755 ):
756 """Adds attributes describing the matcher.
756 """Adds attributes describing the matcher.
757
757
758 Parameters
758 Parameters
759 ----------
759 ----------
760 priority : Optional[float]
760 priority : Optional[float]
761 The priority of the matcher, determines the order of execution of matchers.
761 The priority of the matcher, determines the order of execution of matchers.
762 Higher priority means that the matcher will be executed first. Defaults to 0.
762 Higher priority means that the matcher will be executed first. Defaults to 0.
763 identifier : Optional[str]
763 identifier : Optional[str]
764 identifier of the matcher allowing users to modify the behaviour via traitlets,
764 identifier of the matcher allowing users to modify the behaviour via traitlets,
765 and also used to for debugging (will be passed as ``origin`` with the completions).
765 and also used to for debugging (will be passed as ``origin`` with the completions).
766
766
767 Defaults to matcher function's ``__qualname__`` (for example,
767 Defaults to matcher function's ``__qualname__`` (for example,
768 ``IPCompleter.file_matcher`` for the built-in matched defined
768 ``IPCompleter.file_matcher`` for the built-in matched defined
769 as a ``file_matcher`` method of the ``IPCompleter`` class).
769 as a ``file_matcher`` method of the ``IPCompleter`` class).
770 api_version: Optional[int]
770 api_version: Optional[int]
771 version of the Matcher API used by this matcher.
771 version of the Matcher API used by this matcher.
772 Currently supported values are 1 and 2.
772 Currently supported values are 1 and 2.
773 Defaults to 1.
773 Defaults to 1.
774 """
774 """
775
775
776 def wrapper(func: Matcher):
776 def wrapper(func: Matcher):
777 func.matcher_priority = priority or 0 # type: ignore
777 func.matcher_priority = priority or 0 # type: ignore
778 func.matcher_identifier = identifier or func.__qualname__ # type: ignore
778 func.matcher_identifier = identifier or func.__qualname__ # type: ignore
779 func.matcher_api_version = api_version # type: ignore
779 func.matcher_api_version = api_version # type: ignore
780 if TYPE_CHECKING:
780 if TYPE_CHECKING:
781 if api_version == 1:
781 if api_version == 1:
782 func = cast(MatcherAPIv1, func)
782 func = cast(MatcherAPIv1, func)
783 elif api_version == 2:
783 elif api_version == 2:
784 func = cast(MatcherAPIv2, func)
784 func = cast(MatcherAPIv2, func)
785 return func
785 return func
786
786
787 return wrapper
787 return wrapper
788
788
789
789
790 def _get_matcher_priority(matcher: Matcher):
790 def _get_matcher_priority(matcher: Matcher):
791 return getattr(matcher, "matcher_priority", 0)
791 return getattr(matcher, "matcher_priority", 0)
792
792
793
793
794 def _get_matcher_id(matcher: Matcher):
794 def _get_matcher_id(matcher: Matcher):
795 return getattr(matcher, "matcher_identifier", matcher.__qualname__)
795 return getattr(matcher, "matcher_identifier", matcher.__qualname__)
796
796
797
797
798 def _get_matcher_api_version(matcher):
798 def _get_matcher_api_version(matcher):
799 return getattr(matcher, "matcher_api_version", 1)
799 return getattr(matcher, "matcher_api_version", 1)
800
800
801
801
802 context_matcher = partial(completion_matcher, api_version=2)
802 context_matcher = partial(completion_matcher, api_version=2)
803
803
804
804
805 _IC = Iterable[Completion]
805 _IC = Iterable[Completion]
806
806
807
807
808 def _deduplicate_completions(text: str, completions: _IC)-> _IC:
808 def _deduplicate_completions(text: str, completions: _IC)-> _IC:
809 """
809 """
810 Deduplicate a set of completions.
810 Deduplicate a set of completions.
811
811
812 .. warning::
812 .. warning::
813
813
814 Unstable
814 Unstable
815
815
816 This function is unstable, API may change without warning.
816 This function is unstable, API may change without warning.
817
817
818 Parameters
818 Parameters
819 ----------
819 ----------
820 text : str
820 text : str
821 text that should be completed.
821 text that should be completed.
822 completions : Iterator[Completion]
822 completions : Iterator[Completion]
823 iterator over the completions to deduplicate
823 iterator over the completions to deduplicate
824
824
825 Yields
825 Yields
826 ------
826 ------
827 `Completions` objects
827 `Completions` objects
828 Completions coming from multiple sources, may be different but end up having
828 Completions coming from multiple sources, may be different but end up having
829 the same effect when applied to ``text``. If this is the case, this will
829 the same effect when applied to ``text``. If this is the case, this will
830 consider completions as equal and only emit the first encountered.
830 consider completions as equal and only emit the first encountered.
831 Not folded in `completions()` yet for debugging purpose, and to detect when
831 Not folded in `completions()` yet for debugging purpose, and to detect when
832 the IPython completer does return things that Jedi does not, but should be
832 the IPython completer does return things that Jedi does not, but should be
833 at some point.
833 at some point.
834 """
834 """
835 completions = list(completions)
835 completions = list(completions)
836 if not completions:
836 if not completions:
837 return
837 return
838
838
839 new_start = min(c.start for c in completions)
839 new_start = min(c.start for c in completions)
840 new_end = max(c.end for c in completions)
840 new_end = max(c.end for c in completions)
841
841
842 seen = set()
842 seen = set()
843 for c in completions:
843 for c in completions:
844 new_text = text[new_start:c.start] + c.text + text[c.end:new_end]
844 new_text = text[new_start:c.start] + c.text + text[c.end:new_end]
845 if new_text not in seen:
845 if new_text not in seen:
846 yield c
846 yield c
847 seen.add(new_text)
847 seen.add(new_text)
848
848
849
849
850 def rectify_completions(text: str, completions: _IC, *, _debug: bool = False) -> _IC:
850 def rectify_completions(text: str, completions: _IC, *, _debug: bool = False) -> _IC:
851 """
851 """
852 Rectify a set of completions to all have the same ``start`` and ``end``
852 Rectify a set of completions to all have the same ``start`` and ``end``
853
853
854 .. warning::
854 .. warning::
855
855
856 Unstable
856 Unstable
857
857
858 This function is unstable, API may change without warning.
858 This function is unstable, API may change without warning.
859 It will also raise unless use in proper context manager.
859 It will also raise unless use in proper context manager.
860
860
861 Parameters
861 Parameters
862 ----------
862 ----------
863 text : str
863 text : str
864 text that should be completed.
864 text that should be completed.
865 completions : Iterator[Completion]
865 completions : Iterator[Completion]
866 iterator over the completions to rectify
866 iterator over the completions to rectify
867 _debug : bool
867 _debug : bool
868 Log failed completion
868 Log failed completion
869
869
870 Notes
870 Notes
871 -----
871 -----
872 :any:`jedi.api.classes.Completion` s returned by Jedi may not have the same start and end, though
872 :any:`jedi.api.classes.Completion` s returned by Jedi may not have the same start and end, though
873 the Jupyter Protocol requires them to behave like so. This will readjust
873 the Jupyter Protocol requires them to behave like so. This will readjust
874 the completion to have the same ``start`` and ``end`` by padding both
874 the completion to have the same ``start`` and ``end`` by padding both
875 extremities with surrounding text.
875 extremities with surrounding text.
876
876
877 During stabilisation should support a ``_debug`` option to log which
877 During stabilisation should support a ``_debug`` option to log which
878 completion are return by the IPython completer and not found in Jedi in
878 completion are return by the IPython completer and not found in Jedi in
879 order to make upstream bug report.
879 order to make upstream bug report.
880 """
880 """
881 warnings.warn("`rectify_completions` is a provisional API (as of IPython 6.0). "
881 warnings.warn("`rectify_completions` is a provisional API (as of IPython 6.0). "
882 "It may change without warnings. "
882 "It may change without warnings. "
883 "Use in corresponding context manager.",
883 "Use in corresponding context manager.",
884 category=ProvisionalCompleterWarning, stacklevel=2)
884 category=ProvisionalCompleterWarning, stacklevel=2)
885
885
886 completions = list(completions)
886 completions = list(completions)
887 if not completions:
887 if not completions:
888 return
888 return
889 starts = (c.start for c in completions)
889 starts = (c.start for c in completions)
890 ends = (c.end for c in completions)
890 ends = (c.end for c in completions)
891
891
892 new_start = min(starts)
892 new_start = min(starts)
893 new_end = max(ends)
893 new_end = max(ends)
894
894
895 seen_jedi = set()
895 seen_jedi = set()
896 seen_python_matches = set()
896 seen_python_matches = set()
897 for c in completions:
897 for c in completions:
898 new_text = text[new_start:c.start] + c.text + text[c.end:new_end]
898 new_text = text[new_start:c.start] + c.text + text[c.end:new_end]
899 if c._origin == 'jedi':
899 if c._origin == 'jedi':
900 seen_jedi.add(new_text)
900 seen_jedi.add(new_text)
901 elif c._origin == "IPCompleter.python_matcher":
901 elif c._origin == "IPCompleter.python_matcher":
902 seen_python_matches.add(new_text)
902 seen_python_matches.add(new_text)
903 yield Completion(new_start, new_end, new_text, type=c.type, _origin=c._origin, signature=c.signature)
903 yield Completion(new_start, new_end, new_text, type=c.type, _origin=c._origin, signature=c.signature)
904 diff = seen_python_matches.difference(seen_jedi)
904 diff = seen_python_matches.difference(seen_jedi)
905 if diff and _debug:
905 if diff and _debug:
906 print('IPython.python matches have extras:', diff)
906 print('IPython.python matches have extras:', diff)
907
907
908
908
909 if sys.platform == 'win32':
909 if sys.platform == 'win32':
910 DELIMS = ' \t\n`!@#$^&*()=+[{]}|;\'",<>?'
910 DELIMS = ' \t\n`!@#$^&*()=+[{]}|;\'",<>?'
911 else:
911 else:
912 DELIMS = ' \t\n`!@#$^&*()=+[{]}\\|;:\'",<>?'
912 DELIMS = ' \t\n`!@#$^&*()=+[{]}\\|;:\'",<>?'
913
913
914 GREEDY_DELIMS = ' =\r\n'
914 GREEDY_DELIMS = ' =\r\n'
915
915
916
916
917 class CompletionSplitter(object):
917 class CompletionSplitter(object):
918 """An object to split an input line in a manner similar to readline.
918 """An object to split an input line in a manner similar to readline.
919
919
920 By having our own implementation, we can expose readline-like completion in
920 By having our own implementation, we can expose readline-like completion in
921 a uniform manner to all frontends. This object only needs to be given the
921 a uniform manner to all frontends. This object only needs to be given the
922 line of text to be split and the cursor position on said line, and it
922 line of text to be split and the cursor position on said line, and it
923 returns the 'word' to be completed on at the cursor after splitting the
923 returns the 'word' to be completed on at the cursor after splitting the
924 entire line.
924 entire line.
925
925
926 What characters are used as splitting delimiters can be controlled by
926 What characters are used as splitting delimiters can be controlled by
927 setting the ``delims`` attribute (this is a property that internally
927 setting the ``delims`` attribute (this is a property that internally
928 automatically builds the necessary regular expression)"""
928 automatically builds the necessary regular expression)"""
929
929
930 # Private interface
930 # Private interface
931
931
932 # A string of delimiter characters. The default value makes sense for
932 # A string of delimiter characters. The default value makes sense for
933 # IPython's most typical usage patterns.
933 # IPython's most typical usage patterns.
934 _delims = DELIMS
934 _delims = DELIMS
935
935
936 # The expression (a normal string) to be compiled into a regular expression
936 # The expression (a normal string) to be compiled into a regular expression
937 # for actual splitting. We store it as an attribute mostly for ease of
937 # for actual splitting. We store it as an attribute mostly for ease of
938 # debugging, since this type of code can be so tricky to debug.
938 # debugging, since this type of code can be so tricky to debug.
939 _delim_expr = None
939 _delim_expr = None
940
940
941 # The regular expression that does the actual splitting
941 # The regular expression that does the actual splitting
942 _delim_re = None
942 _delim_re = None
943
943
944 def __init__(self, delims=None):
944 def __init__(self, delims=None):
945 delims = CompletionSplitter._delims if delims is None else delims
945 delims = CompletionSplitter._delims if delims is None else delims
946 self.delims = delims
946 self.delims = delims
947
947
948 @property
948 @property
949 def delims(self):
949 def delims(self):
950 """Return the string of delimiter characters."""
950 """Return the string of delimiter characters."""
951 return self._delims
951 return self._delims
952
952
953 @delims.setter
953 @delims.setter
954 def delims(self, delims):
954 def delims(self, delims):
955 """Set the delimiters for line splitting."""
955 """Set the delimiters for line splitting."""
956 expr = '[' + ''.join('\\'+ c for c in delims) + ']'
956 expr = '[' + ''.join('\\'+ c for c in delims) + ']'
957 self._delim_re = re.compile(expr)
957 self._delim_re = re.compile(expr)
958 self._delims = delims
958 self._delims = delims
959 self._delim_expr = expr
959 self._delim_expr = expr
960
960
961 def split_line(self, line, cursor_pos=None):
961 def split_line(self, line, cursor_pos=None):
962 """Split a line of text with a cursor at the given position.
962 """Split a line of text with a cursor at the given position.
963 """
963 """
964 l = line if cursor_pos is None else line[:cursor_pos]
964 l = line if cursor_pos is None else line[:cursor_pos]
965 return self._delim_re.split(l)[-1]
965 return self._delim_re.split(l)[-1]
966
966
967
967
968
968
969 class Completer(Configurable):
969 class Completer(Configurable):
970
970
971 greedy = Bool(
971 greedy = Bool(
972 False,
972 False,
973 help="""Activate greedy completion.
973 help="""Activate greedy completion.
974
974
975 .. deprecated:: 8.8
975 .. deprecated:: 8.8
976 Use :std:configtrait:`Completer.evaluation` and :std:configtrait:`Completer.auto_close_dict_keys` instead.
976 Use :std:configtrait:`Completer.evaluation` and :std:configtrait:`Completer.auto_close_dict_keys` instead.
977
977
978 When enabled in IPython 8.8 or newer, changes configuration as follows:
978 When enabled in IPython 8.8 or newer, changes configuration as follows:
979
979
980 - ``Completer.evaluation = 'unsafe'``
980 - ``Completer.evaluation = 'unsafe'``
981 - ``Completer.auto_close_dict_keys = True``
981 - ``Completer.auto_close_dict_keys = True``
982 """,
982 """,
983 ).tag(config=True)
983 ).tag(config=True)
984
984
985 evaluation = Enum(
985 evaluation = Enum(
986 ("forbidden", "minimal", "limited", "unsafe", "dangerous"),
986 ("forbidden", "minimal", "limited", "unsafe", "dangerous"),
987 default_value="limited",
987 default_value="limited",
988 help="""Policy for code evaluation under completion.
988 help="""Policy for code evaluation under completion.
989
989
990 Successive options allow to enable more eager evaluation for better
990 Successive options allow to enable more eager evaluation for better
991 completion suggestions, including for nested dictionaries, nested lists,
991 completion suggestions, including for nested dictionaries, nested lists,
992 or even results of function calls.
992 or even results of function calls.
993 Setting ``unsafe`` or higher can lead to evaluation of arbitrary user
993 Setting ``unsafe`` or higher can lead to evaluation of arbitrary user
994 code on :kbd:`Tab` with potentially unwanted or dangerous side effects.
994 code on :kbd:`Tab` with potentially unwanted or dangerous side effects.
995
995
996 Allowed values are:
996 Allowed values are:
997
997
998 - ``forbidden``: no evaluation of code is permitted,
998 - ``forbidden``: no evaluation of code is permitted,
999 - ``minimal``: evaluation of literals and access to built-in namespace;
999 - ``minimal``: evaluation of literals and access to built-in namespace;
1000 no item/attribute evaluationm no access to locals/globals,
1000 no item/attribute evaluationm no access to locals/globals,
1001 no evaluation of any operations or comparisons.
1001 no evaluation of any operations or comparisons.
1002 - ``limited``: access to all namespaces, evaluation of hard-coded methods
1002 - ``limited``: access to all namespaces, evaluation of hard-coded methods
1003 (for example: :any:`dict.keys`, :any:`object.__getattr__`,
1003 (for example: :any:`dict.keys`, :any:`object.__getattr__`,
1004 :any:`object.__getitem__`) on allow-listed objects (for example:
1004 :any:`object.__getitem__`) on allow-listed objects (for example:
1005 :any:`dict`, :any:`list`, :any:`tuple`, ``pandas.Series``),
1005 :any:`dict`, :any:`list`, :any:`tuple`, ``pandas.Series``),
1006 - ``unsafe``: evaluation of all methods and function calls but not of
1006 - ``unsafe``: evaluation of all methods and function calls but not of
1007 syntax with side-effects like `del x`,
1007 syntax with side-effects like `del x`,
1008 - ``dangerous``: completely arbitrary evaluation.
1008 - ``dangerous``: completely arbitrary evaluation.
1009 """,
1009 """,
1010 ).tag(config=True)
1010 ).tag(config=True)
1011
1011
1012 use_jedi = Bool(default_value=JEDI_INSTALLED,
1012 use_jedi = Bool(default_value=JEDI_INSTALLED,
1013 help="Experimental: Use Jedi to generate autocompletions. "
1013 help="Experimental: Use Jedi to generate autocompletions. "
1014 "Default to True if jedi is installed.").tag(config=True)
1014 "Default to True if jedi is installed.").tag(config=True)
1015
1015
1016 jedi_compute_type_timeout = Int(default_value=400,
1016 jedi_compute_type_timeout = Int(default_value=400,
1017 help="""Experimental: restrict time (in milliseconds) during which Jedi can compute types.
1017 help="""Experimental: restrict time (in milliseconds) during which Jedi can compute types.
1018 Set to 0 to stop computing types. Non-zero value lower than 100ms may hurt
1018 Set to 0 to stop computing types. Non-zero value lower than 100ms may hurt
1019 performance by preventing jedi to build its cache.
1019 performance by preventing jedi to build its cache.
1020 """).tag(config=True)
1020 """).tag(config=True)
1021
1021
1022 debug = Bool(default_value=False,
1022 debug = Bool(default_value=False,
1023 help='Enable debug for the Completer. Mostly print extra '
1023 help='Enable debug for the Completer. Mostly print extra '
1024 'information for experimental jedi integration.')\
1024 'information for experimental jedi integration.')\
1025 .tag(config=True)
1025 .tag(config=True)
1026
1026
1027 backslash_combining_completions = Bool(True,
1027 backslash_combining_completions = Bool(True,
1028 help="Enable unicode completions, e.g. \\alpha<tab> . "
1028 help="Enable unicode completions, e.g. \\alpha<tab> . "
1029 "Includes completion of latex commands, unicode names, and expanding "
1029 "Includes completion of latex commands, unicode names, and expanding "
1030 "unicode characters back to latex commands.").tag(config=True)
1030 "unicode characters back to latex commands.").tag(config=True)
1031
1031
1032 auto_close_dict_keys = Bool(
1032 auto_close_dict_keys = Bool(
1033 False,
1033 False,
1034 help="""
1034 help="""
1035 Enable auto-closing dictionary keys.
1035 Enable auto-closing dictionary keys.
1036
1036
1037 When enabled string keys will be suffixed with a final quote
1037 When enabled string keys will be suffixed with a final quote
1038 (matching the opening quote), tuple keys will also receive a
1038 (matching the opening quote), tuple keys will also receive a
1039 separating comma if needed, and keys which are final will
1039 separating comma if needed, and keys which are final will
1040 receive a closing bracket (``]``).
1040 receive a closing bracket (``]``).
1041 """,
1041 """,
1042 ).tag(config=True)
1042 ).tag(config=True)
1043
1043
1044 def __init__(self, namespace=None, global_namespace=None, **kwargs):
1044 def __init__(self, namespace=None, global_namespace=None, **kwargs):
1045 """Create a new completer for the command line.
1045 """Create a new completer for the command line.
1046
1046
1047 Completer(namespace=ns, global_namespace=ns2) -> completer instance.
1047 Completer(namespace=ns, global_namespace=ns2) -> completer instance.
1048
1048
1049 If unspecified, the default namespace where completions are performed
1049 If unspecified, the default namespace where completions are performed
1050 is __main__ (technically, __main__.__dict__). Namespaces should be
1050 is __main__ (technically, __main__.__dict__). Namespaces should be
1051 given as dictionaries.
1051 given as dictionaries.
1052
1052
1053 An optional second namespace can be given. This allows the completer
1053 An optional second namespace can be given. This allows the completer
1054 to handle cases where both the local and global scopes need to be
1054 to handle cases where both the local and global scopes need to be
1055 distinguished.
1055 distinguished.
1056 """
1056 """
1057
1057
1058 # Don't bind to namespace quite yet, but flag whether the user wants a
1058 # Don't bind to namespace quite yet, but flag whether the user wants a
1059 # specific namespace or to use __main__.__dict__. This will allow us
1059 # specific namespace or to use __main__.__dict__. This will allow us
1060 # to bind to __main__.__dict__ at completion time, not now.
1060 # to bind to __main__.__dict__ at completion time, not now.
1061 if namespace is None:
1061 if namespace is None:
1062 self.use_main_ns = True
1062 self.use_main_ns = True
1063 else:
1063 else:
1064 self.use_main_ns = False
1064 self.use_main_ns = False
1065 self.namespace = namespace
1065 self.namespace = namespace
1066
1066
1067 # The global namespace, if given, can be bound directly
1067 # The global namespace, if given, can be bound directly
1068 if global_namespace is None:
1068 if global_namespace is None:
1069 self.global_namespace = {}
1069 self.global_namespace = {}
1070 else:
1070 else:
1071 self.global_namespace = global_namespace
1071 self.global_namespace = global_namespace
1072
1072
1073 self.custom_matchers = []
1073 self.custom_matchers = []
1074
1074
1075 super(Completer, self).__init__(**kwargs)
1075 super(Completer, self).__init__(**kwargs)
1076
1076
1077 def complete(self, text, state):
1077 def complete(self, text, state):
1078 """Return the next possible completion for 'text'.
1078 """Return the next possible completion for 'text'.
1079
1079
1080 This is called successively with state == 0, 1, 2, ... until it
1080 This is called successively with state == 0, 1, 2, ... until it
1081 returns None. The completion should begin with 'text'.
1081 returns None. The completion should begin with 'text'.
1082
1082
1083 """
1083 """
1084 if self.use_main_ns:
1084 if self.use_main_ns:
1085 self.namespace = __main__.__dict__
1085 self.namespace = __main__.__dict__
1086
1086
1087 if state == 0:
1087 if state == 0:
1088 if "." in text:
1088 if "." in text:
1089 self.matches = self.attr_matches(text)
1089 self.matches = self.attr_matches(text)
1090 else:
1090 else:
1091 self.matches = self.global_matches(text)
1091 self.matches = self.global_matches(text)
1092 try:
1092 try:
1093 return self.matches[state]
1093 return self.matches[state]
1094 except IndexError:
1094 except IndexError:
1095 return None
1095 return None
1096
1096
1097 def global_matches(self, text):
1097 def global_matches(self, text):
1098 """Compute matches when text is a simple name.
1098 """Compute matches when text is a simple name.
1099
1099
1100 Return a list of all keywords, built-in functions and names currently
1100 Return a list of all keywords, built-in functions and names currently
1101 defined in self.namespace or self.global_namespace that match.
1101 defined in self.namespace or self.global_namespace that match.
1102
1102
1103 """
1103 """
1104 matches = []
1104 matches = []
1105 match_append = matches.append
1105 match_append = matches.append
1106 n = len(text)
1106 n = len(text)
1107 for lst in [
1107 for lst in [
1108 keyword.kwlist,
1108 keyword.kwlist,
1109 builtin_mod.__dict__.keys(),
1109 builtin_mod.__dict__.keys(),
1110 list(self.namespace.keys()),
1110 list(self.namespace.keys()),
1111 list(self.global_namespace.keys()),
1111 list(self.global_namespace.keys()),
1112 ]:
1112 ]:
1113 for word in lst:
1113 for word in lst:
1114 if word[:n] == text and word != "__builtins__":
1114 if word[:n] == text and word != "__builtins__":
1115 match_append(word)
1115 match_append(word)
1116
1116
1117 snake_case_re = re.compile(r"[^_]+(_[^_]+)+?\Z")
1117 snake_case_re = re.compile(r"[^_]+(_[^_]+)+?\Z")
1118 for lst in [list(self.namespace.keys()), list(self.global_namespace.keys())]:
1118 for lst in [list(self.namespace.keys()), list(self.global_namespace.keys())]:
1119 shortened = {
1119 shortened = {
1120 "_".join([sub[0] for sub in word.split("_")]): word
1120 "_".join([sub[0] for sub in word.split("_")]): word
1121 for word in lst
1121 for word in lst
1122 if snake_case_re.match(word)
1122 if snake_case_re.match(word)
1123 }
1123 }
1124 for word in shortened.keys():
1124 for word in shortened.keys():
1125 if word[:n] == text and word != "__builtins__":
1125 if word[:n] == text and word != "__builtins__":
1126 match_append(shortened[word])
1126 match_append(shortened[word])
1127 return matches
1127 return matches
1128
1128
1129 def attr_matches(self, text):
1129 def attr_matches(self, text):
1130 """Compute matches when text contains a dot.
1130 """Compute matches when text contains a dot.
1131
1131
1132 Assuming the text is of the form NAME.NAME....[NAME], and is
1132 Assuming the text is of the form NAME.NAME....[NAME], and is
1133 evaluatable in self.namespace or self.global_namespace, it will be
1133 evaluatable in self.namespace or self.global_namespace, it will be
1134 evaluated and its attributes (as revealed by dir()) are used as
1134 evaluated and its attributes (as revealed by dir()) are used as
1135 possible completions. (For class instances, class members are
1135 possible completions. (For class instances, class members are
1136 also considered.)
1136 also considered.)
1137
1137
1138 WARNING: this can still invoke arbitrary C code, if an object
1138 WARNING: this can still invoke arbitrary C code, if an object
1139 with a __getattr__ hook is evaluated.
1139 with a __getattr__ hook is evaluated.
1140
1140
1141 """
1141 """
1142 return self._attr_matches(text)[0]
1142 return self._attr_matches(text)[0]
1143
1143
1144 def _attr_matches(self, text, include_prefix=True) -> Tuple[Sequence[str], str]:
1144 def _attr_matches(self, text, include_prefix=True) -> Tuple[Sequence[str], str]:
1145 m2 = re.match(r"(.+)\.(\w*)$", self.line_buffer)
1145 m2 = re.match(r"(.+)\.(\w*)$", self.line_buffer)
1146 if not m2:
1146 if not m2:
1147 return [], ""
1147 return [], ""
1148 expr, attr = m2.group(1, 2)
1148 expr, attr = m2.group(1, 2)
1149
1149
1150 obj = self._evaluate_expr(expr)
1150 obj = self._evaluate_expr(expr)
1151
1151
1152 if obj is not_found:
1152 if obj is not_found:
1153 return [], ""
1153 return [], ""
1154
1154
1155 if self.limit_to__all__ and hasattr(obj, '__all__'):
1155 if self.limit_to__all__ and hasattr(obj, '__all__'):
1156 words = get__all__entries(obj)
1156 words = get__all__entries(obj)
1157 else:
1157 else:
1158 words = dir2(obj)
1158 words = dir2(obj)
1159
1159
1160 try:
1160 try:
1161 words = generics.complete_object(obj, words)
1161 words = generics.complete_object(obj, words)
1162 except TryNext:
1162 except TryNext:
1163 pass
1163 pass
1164 except AssertionError:
1164 except AssertionError:
1165 raise
1165 raise
1166 except Exception:
1166 except Exception:
1167 # Silence errors from completion function
1167 # Silence errors from completion function
1168 pass
1168 pass
1169 # Build match list to return
1169 # Build match list to return
1170 n = len(attr)
1170 n = len(attr)
1171
1171
1172 # Note: ideally we would just return words here and the prefix
1172 # Note: ideally we would just return words here and the prefix
1173 # reconciliator would know that we intend to append to rather than
1173 # reconciliator would know that we intend to append to rather than
1174 # replace the input text; this requires refactoring to return range
1174 # replace the input text; this requires refactoring to return range
1175 # which ought to be replaced (as does jedi).
1175 # which ought to be replaced (as does jedi).
1176 if include_prefix:
1176 if include_prefix:
1177 tokens = _parse_tokens(expr)
1177 tokens = _parse_tokens(expr)
1178 rev_tokens = reversed(tokens)
1178 rev_tokens = reversed(tokens)
1179 skip_over = {tokenize.ENDMARKER, tokenize.NEWLINE}
1179 skip_over = {tokenize.ENDMARKER, tokenize.NEWLINE}
1180 name_turn = True
1180 name_turn = True
1181
1181
1182 parts = []
1182 parts = []
1183 for token in rev_tokens:
1183 for token in rev_tokens:
1184 if token.type in skip_over:
1184 if token.type in skip_over:
1185 continue
1185 continue
1186 if token.type == tokenize.NAME and name_turn:
1186 if token.type == tokenize.NAME and name_turn:
1187 parts.append(token.string)
1187 parts.append(token.string)
1188 name_turn = False
1188 name_turn = False
1189 elif (
1189 elif (
1190 token.type == tokenize.OP and token.string == "." and not name_turn
1190 token.type == tokenize.OP and token.string == "." and not name_turn
1191 ):
1191 ):
1192 parts.append(token.string)
1192 parts.append(token.string)
1193 name_turn = True
1193 name_turn = True
1194 else:
1194 else:
1195 # short-circuit if not empty nor name token
1195 # short-circuit if not empty nor name token
1196 break
1196 break
1197
1197
1198 prefix_after_space = "".join(reversed(parts))
1198 prefix_after_space = "".join(reversed(parts))
1199 else:
1199 else:
1200 prefix_after_space = ""
1200 prefix_after_space = ""
1201
1201
1202 return (
1202 return (
1203 ["%s.%s" % (prefix_after_space, w) for w in words if w[:n] == attr],
1203 ["%s.%s" % (prefix_after_space, w) for w in words if w[:n] == attr],
1204 "." + attr,
1204 "." + attr,
1205 )
1205 )
1206
1206
1207 def _evaluate_expr(self, expr):
1207 def _evaluate_expr(self, expr):
1208 obj = not_found
1208 obj = not_found
1209 done = False
1209 done = False
1210 while not done and expr:
1210 while not done and expr:
1211 try:
1211 try:
1212 obj = guarded_eval(
1212 obj = guarded_eval(
1213 expr,
1213 expr,
1214 EvaluationContext(
1214 EvaluationContext(
1215 globals=self.global_namespace,
1215 globals=self.global_namespace,
1216 locals=self.namespace,
1216 locals=self.namespace,
1217 evaluation=self.evaluation,
1217 evaluation=self.evaluation,
1218 ),
1218 ),
1219 )
1219 )
1220 done = True
1220 done = True
1221 except Exception as e:
1221 except Exception as e:
1222 if self.debug:
1222 if self.debug:
1223 print("Evaluation exception", e)
1223 print("Evaluation exception", e)
1224 # trim the expression to remove any invalid prefix
1224 # trim the expression to remove any invalid prefix
1225 # e.g. user starts `(d[`, so we get `expr = '(d'`,
1225 # e.g. user starts `(d[`, so we get `expr = '(d'`,
1226 # where parenthesis is not closed.
1226 # where parenthesis is not closed.
1227 # TODO: make this faster by reusing parts of the computation?
1227 # TODO: make this faster by reusing parts of the computation?
1228 expr = expr[1:]
1228 expr = expr[1:]
1229 return obj
1229 return obj
1230
1230
1231 def get__all__entries(obj):
1231 def get__all__entries(obj):
1232 """returns the strings in the __all__ attribute"""
1232 """returns the strings in the __all__ attribute"""
1233 try:
1233 try:
1234 words = getattr(obj, '__all__')
1234 words = getattr(obj, '__all__')
1235 except:
1235 except:
1236 return []
1236 return []
1237
1237
1238 return [w for w in words if isinstance(w, str)]
1238 return [w for w in words if isinstance(w, str)]
1239
1239
1240
1240
1241 class _DictKeyState(enum.Flag):
1241 class _DictKeyState(enum.Flag):
1242 """Represent state of the key match in context of other possible matches.
1242 """Represent state of the key match in context of other possible matches.
1243
1243
1244 - given `d1 = {'a': 1}` completion on `d1['<tab>` will yield `{'a': END_OF_ITEM}` as there is no tuple.
1244 - given `d1 = {'a': 1}` completion on `d1['<tab>` will yield `{'a': END_OF_ITEM}` as there is no tuple.
1245 - given `d2 = {('a', 'b'): 1}`: `d2['a', '<tab>` will yield `{'b': END_OF_TUPLE}` as there is no tuple members to add beyond `'b'`.
1245 - given `d2 = {('a', 'b'): 1}`: `d2['a', '<tab>` will yield `{'b': END_OF_TUPLE}` as there is no tuple members to add beyond `'b'`.
1246 - given `d3 = {('a', 'b'): 1}`: `d3['<tab>` will yield `{'a': IN_TUPLE}` as `'a'` can be added.
1246 - given `d3 = {('a', 'b'): 1}`: `d3['<tab>` will yield `{'a': IN_TUPLE}` as `'a'` can be added.
1247 - given `d4 = {'a': 1, ('a', 'b'): 2}`: `d4['<tab>` will yield `{'a': END_OF_ITEM & END_OF_TUPLE}`
1247 - given `d4 = {'a': 1, ('a', 'b'): 2}`: `d4['<tab>` will yield `{'a': END_OF_ITEM & END_OF_TUPLE}`
1248 """
1248 """
1249
1249
1250 BASELINE = 0
1250 BASELINE = 0
1251 END_OF_ITEM = enum.auto()
1251 END_OF_ITEM = enum.auto()
1252 END_OF_TUPLE = enum.auto()
1252 END_OF_TUPLE = enum.auto()
1253 IN_TUPLE = enum.auto()
1253 IN_TUPLE = enum.auto()
1254
1254
1255
1255
1256 def _parse_tokens(c):
1256 def _parse_tokens(c):
1257 """Parse tokens even if there is an error."""
1257 """Parse tokens even if there is an error."""
1258 tokens = []
1258 tokens = []
1259 token_generator = tokenize.generate_tokens(iter(c.splitlines()).__next__)
1259 token_generator = tokenize.generate_tokens(iter(c.splitlines()).__next__)
1260 while True:
1260 while True:
1261 try:
1261 try:
1262 tokens.append(next(token_generator))
1262 tokens.append(next(token_generator))
1263 except tokenize.TokenError:
1263 except tokenize.TokenError:
1264 return tokens
1264 return tokens
1265 except StopIteration:
1265 except StopIteration:
1266 return tokens
1266 return tokens
1267
1267
1268
1268
1269 def _match_number_in_dict_key_prefix(prefix: str) -> Union[str, None]:
1269 def _match_number_in_dict_key_prefix(prefix: str) -> Union[str, None]:
1270 """Match any valid Python numeric literal in a prefix of dictionary keys.
1270 """Match any valid Python numeric literal in a prefix of dictionary keys.
1271
1271
1272 References:
1272 References:
1273 - https://docs.python.org/3/reference/lexical_analysis.html#numeric-literals
1273 - https://docs.python.org/3/reference/lexical_analysis.html#numeric-literals
1274 - https://docs.python.org/3/library/tokenize.html
1274 - https://docs.python.org/3/library/tokenize.html
1275 """
1275 """
1276 if prefix[-1].isspace():
1276 if prefix[-1].isspace():
1277 # if user typed a space we do not have anything to complete
1277 # if user typed a space we do not have anything to complete
1278 # even if there was a valid number token before
1278 # even if there was a valid number token before
1279 return None
1279 return None
1280 tokens = _parse_tokens(prefix)
1280 tokens = _parse_tokens(prefix)
1281 rev_tokens = reversed(tokens)
1281 rev_tokens = reversed(tokens)
1282 skip_over = {tokenize.ENDMARKER, tokenize.NEWLINE}
1282 skip_over = {tokenize.ENDMARKER, tokenize.NEWLINE}
1283 number = None
1283 number = None
1284 for token in rev_tokens:
1284 for token in rev_tokens:
1285 if token.type in skip_over:
1285 if token.type in skip_over:
1286 continue
1286 continue
1287 if number is None:
1287 if number is None:
1288 if token.type == tokenize.NUMBER:
1288 if token.type == tokenize.NUMBER:
1289 number = token.string
1289 number = token.string
1290 continue
1290 continue
1291 else:
1291 else:
1292 # we did not match a number
1292 # we did not match a number
1293 return None
1293 return None
1294 if token.type == tokenize.OP:
1294 if token.type == tokenize.OP:
1295 if token.string == ",":
1295 if token.string == ",":
1296 break
1296 break
1297 if token.string in {"+", "-"}:
1297 if token.string in {"+", "-"}:
1298 number = token.string + number
1298 number = token.string + number
1299 else:
1299 else:
1300 return None
1300 return None
1301 return number
1301 return number
1302
1302
1303
1303
1304 _INT_FORMATS = {
1304 _INT_FORMATS = {
1305 "0b": bin,
1305 "0b": bin,
1306 "0o": oct,
1306 "0o": oct,
1307 "0x": hex,
1307 "0x": hex,
1308 }
1308 }
1309
1309
1310
1310
1311 def match_dict_keys(
1311 def match_dict_keys(
1312 keys: List[Union[str, bytes, Tuple[Union[str, bytes], ...]]],
1312 keys: List[Union[str, bytes, Tuple[Union[str, bytes], ...]]],
1313 prefix: str,
1313 prefix: str,
1314 delims: str,
1314 delims: str,
1315 extra_prefix: Optional[Tuple[Union[str, bytes], ...]] = None,
1315 extra_prefix: Optional[Tuple[Union[str, bytes], ...]] = None,
1316 ) -> Tuple[str, int, Dict[str, _DictKeyState]]:
1316 ) -> Tuple[str, int, Dict[str, _DictKeyState]]:
1317 """Used by dict_key_matches, matching the prefix to a list of keys
1317 """Used by dict_key_matches, matching the prefix to a list of keys
1318
1318
1319 Parameters
1319 Parameters
1320 ----------
1320 ----------
1321 keys
1321 keys
1322 list of keys in dictionary currently being completed.
1322 list of keys in dictionary currently being completed.
1323 prefix
1323 prefix
1324 Part of the text already typed by the user. E.g. `mydict[b'fo`
1324 Part of the text already typed by the user. E.g. `mydict[b'fo`
1325 delims
1325 delims
1326 String of delimiters to consider when finding the current key.
1326 String of delimiters to consider when finding the current key.
1327 extra_prefix : optional
1327 extra_prefix : optional
1328 Part of the text already typed in multi-key index cases. E.g. for
1328 Part of the text already typed in multi-key index cases. E.g. for
1329 `mydict['foo', "bar", 'b`, this would be `('foo', 'bar')`.
1329 `mydict['foo', "bar", 'b`, this would be `('foo', 'bar')`.
1330
1330
1331 Returns
1331 Returns
1332 -------
1332 -------
1333 A tuple of three elements: ``quote``, ``token_start``, ``matched``, with
1333 A tuple of three elements: ``quote``, ``token_start``, ``matched``, with
1334 ``quote`` being the quote that need to be used to close current string.
1334 ``quote`` being the quote that need to be used to close current string.
1335 ``token_start`` the position where the replacement should start occurring,
1335 ``token_start`` the position where the replacement should start occurring,
1336 ``matches`` a dictionary of replacement/completion keys on keys and values
1336 ``matches`` a dictionary of replacement/completion keys on keys and values
1337 indicating whether the state.
1337 indicating whether the state.
1338 """
1338 """
1339 prefix_tuple = extra_prefix if extra_prefix else ()
1339 prefix_tuple = extra_prefix if extra_prefix else ()
1340
1340
1341 prefix_tuple_size = sum(
1341 prefix_tuple_size = sum(
1342 [
1342 [
1343 # for pandas, do not count slices as taking space
1343 # for pandas, do not count slices as taking space
1344 not isinstance(k, slice)
1344 not isinstance(k, slice)
1345 for k in prefix_tuple
1345 for k in prefix_tuple
1346 ]
1346 ]
1347 )
1347 )
1348 text_serializable_types = (str, bytes, int, float, slice)
1348 text_serializable_types = (str, bytes, int, float, slice)
1349
1349
1350 def filter_prefix_tuple(key):
1350 def filter_prefix_tuple(key):
1351 # Reject too short keys
1351 # Reject too short keys
1352 if len(key) <= prefix_tuple_size:
1352 if len(key) <= prefix_tuple_size:
1353 return False
1353 return False
1354 # Reject keys which cannot be serialised to text
1354 # Reject keys which cannot be serialised to text
1355 for k in key:
1355 for k in key:
1356 if not isinstance(k, text_serializable_types):
1356 if not isinstance(k, text_serializable_types):
1357 return False
1357 return False
1358 # Reject keys that do not match the prefix
1358 # Reject keys that do not match the prefix
1359 for k, pt in zip(key, prefix_tuple):
1359 for k, pt in zip(key, prefix_tuple):
1360 if k != pt and not isinstance(pt, slice):
1360 if k != pt and not isinstance(pt, slice):
1361 return False
1361 return False
1362 # All checks passed!
1362 # All checks passed!
1363 return True
1363 return True
1364
1364
1365 filtered_key_is_final: Dict[
1365 filtered_key_is_final: Dict[Union[str, bytes, int, float], _DictKeyState] = (
1366 Union[str, bytes, int, float], _DictKeyState
1366 defaultdict(lambda: _DictKeyState.BASELINE)
1367 ] = defaultdict(lambda: _DictKeyState.BASELINE)
1367 )
1368
1368
1369 for k in keys:
1369 for k in keys:
1370 # If at least one of the matches is not final, mark as undetermined.
1370 # If at least one of the matches is not final, mark as undetermined.
1371 # This can happen with `d = {111: 'b', (111, 222): 'a'}` where
1371 # This can happen with `d = {111: 'b', (111, 222): 'a'}` where
1372 # `111` appears final on first match but is not final on the second.
1372 # `111` appears final on first match but is not final on the second.
1373
1373
1374 if isinstance(k, tuple):
1374 if isinstance(k, tuple):
1375 if filter_prefix_tuple(k):
1375 if filter_prefix_tuple(k):
1376 key_fragment = k[prefix_tuple_size]
1376 key_fragment = k[prefix_tuple_size]
1377 filtered_key_is_final[key_fragment] |= (
1377 filtered_key_is_final[key_fragment] |= (
1378 _DictKeyState.END_OF_TUPLE
1378 _DictKeyState.END_OF_TUPLE
1379 if len(k) == prefix_tuple_size + 1
1379 if len(k) == prefix_tuple_size + 1
1380 else _DictKeyState.IN_TUPLE
1380 else _DictKeyState.IN_TUPLE
1381 )
1381 )
1382 elif prefix_tuple_size > 0:
1382 elif prefix_tuple_size > 0:
1383 # we are completing a tuple but this key is not a tuple,
1383 # we are completing a tuple but this key is not a tuple,
1384 # so we should ignore it
1384 # so we should ignore it
1385 pass
1385 pass
1386 else:
1386 else:
1387 if isinstance(k, text_serializable_types):
1387 if isinstance(k, text_serializable_types):
1388 filtered_key_is_final[k] |= _DictKeyState.END_OF_ITEM
1388 filtered_key_is_final[k] |= _DictKeyState.END_OF_ITEM
1389
1389
1390 filtered_keys = filtered_key_is_final.keys()
1390 filtered_keys = filtered_key_is_final.keys()
1391
1391
1392 if not prefix:
1392 if not prefix:
1393 return "", 0, {repr(k): v for k, v in filtered_key_is_final.items()}
1393 return "", 0, {repr(k): v for k, v in filtered_key_is_final.items()}
1394
1394
1395 quote_match = re.search("(?:\"|')", prefix)
1395 quote_match = re.search("(?:\"|')", prefix)
1396 is_user_prefix_numeric = False
1396 is_user_prefix_numeric = False
1397
1397
1398 if quote_match:
1398 if quote_match:
1399 quote = quote_match.group()
1399 quote = quote_match.group()
1400 valid_prefix = prefix + quote
1400 valid_prefix = prefix + quote
1401 try:
1401 try:
1402 prefix_str = literal_eval(valid_prefix)
1402 prefix_str = literal_eval(valid_prefix)
1403 except Exception:
1403 except Exception:
1404 return "", 0, {}
1404 return "", 0, {}
1405 else:
1405 else:
1406 # If it does not look like a string, let's assume
1406 # If it does not look like a string, let's assume
1407 # we are dealing with a number or variable.
1407 # we are dealing with a number or variable.
1408 number_match = _match_number_in_dict_key_prefix(prefix)
1408 number_match = _match_number_in_dict_key_prefix(prefix)
1409
1409
1410 # We do not want the key matcher to suggest variable names so we yield:
1410 # We do not want the key matcher to suggest variable names so we yield:
1411 if number_match is None:
1411 if number_match is None:
1412 # The alternative would be to assume that user forgort the quote
1412 # The alternative would be to assume that user forgort the quote
1413 # and if the substring matches, suggest adding it at the start.
1413 # and if the substring matches, suggest adding it at the start.
1414 return "", 0, {}
1414 return "", 0, {}
1415
1415
1416 prefix_str = number_match
1416 prefix_str = number_match
1417 is_user_prefix_numeric = True
1417 is_user_prefix_numeric = True
1418 quote = ""
1418 quote = ""
1419
1419
1420 pattern = '[^' + ''.join('\\' + c for c in delims) + ']*$'
1420 pattern = '[^' + ''.join('\\' + c for c in delims) + ']*$'
1421 token_match = re.search(pattern, prefix, re.UNICODE)
1421 token_match = re.search(pattern, prefix, re.UNICODE)
1422 assert token_match is not None # silence mypy
1422 assert token_match is not None # silence mypy
1423 token_start = token_match.start()
1423 token_start = token_match.start()
1424 token_prefix = token_match.group()
1424 token_prefix = token_match.group()
1425
1425
1426 matched: Dict[str, _DictKeyState] = {}
1426 matched: Dict[str, _DictKeyState] = {}
1427
1427
1428 str_key: Union[str, bytes]
1428 str_key: Union[str, bytes]
1429
1429
1430 for key in filtered_keys:
1430 for key in filtered_keys:
1431 if isinstance(key, (int, float)):
1431 if isinstance(key, (int, float)):
1432 # User typed a number but this key is not a number.
1432 # User typed a number but this key is not a number.
1433 if not is_user_prefix_numeric:
1433 if not is_user_prefix_numeric:
1434 continue
1434 continue
1435 str_key = str(key)
1435 str_key = str(key)
1436 if isinstance(key, int):
1436 if isinstance(key, int):
1437 int_base = prefix_str[:2].lower()
1437 int_base = prefix_str[:2].lower()
1438 # if user typed integer using binary/oct/hex notation:
1438 # if user typed integer using binary/oct/hex notation:
1439 if int_base in _INT_FORMATS:
1439 if int_base in _INT_FORMATS:
1440 int_format = _INT_FORMATS[int_base]
1440 int_format = _INT_FORMATS[int_base]
1441 str_key = int_format(key)
1441 str_key = int_format(key)
1442 else:
1442 else:
1443 # User typed a string but this key is a number.
1443 # User typed a string but this key is a number.
1444 if is_user_prefix_numeric:
1444 if is_user_prefix_numeric:
1445 continue
1445 continue
1446 str_key = key
1446 str_key = key
1447 try:
1447 try:
1448 if not str_key.startswith(prefix_str):
1448 if not str_key.startswith(prefix_str):
1449 continue
1449 continue
1450 except (AttributeError, TypeError, UnicodeError) as e:
1450 except (AttributeError, TypeError, UnicodeError) as e:
1451 # Python 3+ TypeError on b'a'.startswith('a') or vice-versa
1451 # Python 3+ TypeError on b'a'.startswith('a') or vice-versa
1452 continue
1452 continue
1453
1453
1454 # reformat remainder of key to begin with prefix
1454 # reformat remainder of key to begin with prefix
1455 rem = str_key[len(prefix_str) :]
1455 rem = str_key[len(prefix_str) :]
1456 # force repr wrapped in '
1456 # force repr wrapped in '
1457 rem_repr = repr(rem + '"') if isinstance(rem, str) else repr(rem + b'"')
1457 rem_repr = repr(rem + '"') if isinstance(rem, str) else repr(rem + b'"')
1458 rem_repr = rem_repr[1 + rem_repr.index("'"):-2]
1458 rem_repr = rem_repr[1 + rem_repr.index("'"):-2]
1459 if quote == '"':
1459 if quote == '"':
1460 # The entered prefix is quoted with ",
1460 # The entered prefix is quoted with ",
1461 # but the match is quoted with '.
1461 # but the match is quoted with '.
1462 # A contained " hence needs escaping for comparison:
1462 # A contained " hence needs escaping for comparison:
1463 rem_repr = rem_repr.replace('"', '\\"')
1463 rem_repr = rem_repr.replace('"', '\\"')
1464
1464
1465 # then reinsert prefix from start of token
1465 # then reinsert prefix from start of token
1466 match = "%s%s" % (token_prefix, rem_repr)
1466 match = "%s%s" % (token_prefix, rem_repr)
1467
1467
1468 matched[match] = filtered_key_is_final[key]
1468 matched[match] = filtered_key_is_final[key]
1469 return quote, token_start, matched
1469 return quote, token_start, matched
1470
1470
1471
1471
1472 def cursor_to_position(text:str, line:int, column:int)->int:
1472 def cursor_to_position(text:str, line:int, column:int)->int:
1473 """
1473 """
1474 Convert the (line,column) position of the cursor in text to an offset in a
1474 Convert the (line,column) position of the cursor in text to an offset in a
1475 string.
1475 string.
1476
1476
1477 Parameters
1477 Parameters
1478 ----------
1478 ----------
1479 text : str
1479 text : str
1480 The text in which to calculate the cursor offset
1480 The text in which to calculate the cursor offset
1481 line : int
1481 line : int
1482 Line of the cursor; 0-indexed
1482 Line of the cursor; 0-indexed
1483 column : int
1483 column : int
1484 Column of the cursor 0-indexed
1484 Column of the cursor 0-indexed
1485
1485
1486 Returns
1486 Returns
1487 -------
1487 -------
1488 Position of the cursor in ``text``, 0-indexed.
1488 Position of the cursor in ``text``, 0-indexed.
1489
1489
1490 See Also
1490 See Also
1491 --------
1491 --------
1492 position_to_cursor : reciprocal of this function
1492 position_to_cursor : reciprocal of this function
1493
1493
1494 """
1494 """
1495 lines = text.split('\n')
1495 lines = text.split('\n')
1496 assert line <= len(lines), '{} <= {}'.format(str(line), str(len(lines)))
1496 assert line <= len(lines), '{} <= {}'.format(str(line), str(len(lines)))
1497
1497
1498 return sum(len(l) + 1 for l in lines[:line]) + column
1498 return sum(len(l) + 1 for l in lines[:line]) + column
1499
1499
1500 def position_to_cursor(text:str, offset:int)->Tuple[int, int]:
1500 def position_to_cursor(text:str, offset:int)->Tuple[int, int]:
1501 """
1501 """
1502 Convert the position of the cursor in text (0 indexed) to a line
1502 Convert the position of the cursor in text (0 indexed) to a line
1503 number(0-indexed) and a column number (0-indexed) pair
1503 number(0-indexed) and a column number (0-indexed) pair
1504
1504
1505 Position should be a valid position in ``text``.
1505 Position should be a valid position in ``text``.
1506
1506
1507 Parameters
1507 Parameters
1508 ----------
1508 ----------
1509 text : str
1509 text : str
1510 The text in which to calculate the cursor offset
1510 The text in which to calculate the cursor offset
1511 offset : int
1511 offset : int
1512 Position of the cursor in ``text``, 0-indexed.
1512 Position of the cursor in ``text``, 0-indexed.
1513
1513
1514 Returns
1514 Returns
1515 -------
1515 -------
1516 (line, column) : (int, int)
1516 (line, column) : (int, int)
1517 Line of the cursor; 0-indexed, column of the cursor 0-indexed
1517 Line of the cursor; 0-indexed, column of the cursor 0-indexed
1518
1518
1519 See Also
1519 See Also
1520 --------
1520 --------
1521 cursor_to_position : reciprocal of this function
1521 cursor_to_position : reciprocal of this function
1522
1522
1523 """
1523 """
1524
1524
1525 assert 0 <= offset <= len(text) , "0 <= %s <= %s" % (offset , len(text))
1525 assert 0 <= offset <= len(text) , "0 <= %s <= %s" % (offset , len(text))
1526
1526
1527 before = text[:offset]
1527 before = text[:offset]
1528 blines = before.split('\n') # ! splitnes trim trailing \n
1528 blines = before.split('\n') # ! splitnes trim trailing \n
1529 line = before.count('\n')
1529 line = before.count('\n')
1530 col = len(blines[-1])
1530 col = len(blines[-1])
1531 return line, col
1531 return line, col
1532
1532
1533
1533
1534 def _safe_isinstance(obj, module, class_name, *attrs):
1534 def _safe_isinstance(obj, module, class_name, *attrs):
1535 """Checks if obj is an instance of module.class_name if loaded
1535 """Checks if obj is an instance of module.class_name if loaded
1536 """
1536 """
1537 if module in sys.modules:
1537 if module in sys.modules:
1538 m = sys.modules[module]
1538 m = sys.modules[module]
1539 for attr in [class_name, *attrs]:
1539 for attr in [class_name, *attrs]:
1540 m = getattr(m, attr)
1540 m = getattr(m, attr)
1541 return isinstance(obj, m)
1541 return isinstance(obj, m)
1542
1542
1543
1543
1544 @context_matcher()
1544 @context_matcher()
1545 def back_unicode_name_matcher(context: CompletionContext):
1545 def back_unicode_name_matcher(context: CompletionContext):
1546 """Match Unicode characters back to Unicode name
1546 """Match Unicode characters back to Unicode name
1547
1547
1548 Same as :any:`back_unicode_name_matches`, but adopted to new Matcher API.
1548 Same as :any:`back_unicode_name_matches`, but adopted to new Matcher API.
1549 """
1549 """
1550 fragment, matches = back_unicode_name_matches(context.text_until_cursor)
1550 fragment, matches = back_unicode_name_matches(context.text_until_cursor)
1551 return _convert_matcher_v1_result_to_v2(
1551 return _convert_matcher_v1_result_to_v2(
1552 matches, type="unicode", fragment=fragment, suppress_if_matches=True
1552 matches, type="unicode", fragment=fragment, suppress_if_matches=True
1553 )
1553 )
1554
1554
1555
1555
1556 def back_unicode_name_matches(text: str) -> Tuple[str, Sequence[str]]:
1556 def back_unicode_name_matches(text: str) -> Tuple[str, Sequence[str]]:
1557 """Match Unicode characters back to Unicode name
1557 """Match Unicode characters back to Unicode name
1558
1558
1559 This does ``β˜ƒ`` -> ``\\snowman``
1559 This does ``β˜ƒ`` -> ``\\snowman``
1560
1560
1561 Note that snowman is not a valid python3 combining character but will be expanded.
1561 Note that snowman is not a valid python3 combining character but will be expanded.
1562 Though it will not recombine back to the snowman character by the completion machinery.
1562 Though it will not recombine back to the snowman character by the completion machinery.
1563
1563
1564 This will not either back-complete standard sequences like \\n, \\b ...
1564 This will not either back-complete standard sequences like \\n, \\b ...
1565
1565
1566 .. deprecated:: 8.6
1566 .. deprecated:: 8.6
1567 You can use :meth:`back_unicode_name_matcher` instead.
1567 You can use :meth:`back_unicode_name_matcher` instead.
1568
1568
1569 Returns
1569 Returns
1570 =======
1570 =======
1571
1571
1572 Return a tuple with two elements:
1572 Return a tuple with two elements:
1573
1573
1574 - The Unicode character that was matched (preceded with a backslash), or
1574 - The Unicode character that was matched (preceded with a backslash), or
1575 empty string,
1575 empty string,
1576 - a sequence (of 1), name for the match Unicode character, preceded by
1576 - a sequence (of 1), name for the match Unicode character, preceded by
1577 backslash, or empty if no match.
1577 backslash, or empty if no match.
1578 """
1578 """
1579 if len(text)<2:
1579 if len(text)<2:
1580 return '', ()
1580 return '', ()
1581 maybe_slash = text[-2]
1581 maybe_slash = text[-2]
1582 if maybe_slash != '\\':
1582 if maybe_slash != '\\':
1583 return '', ()
1583 return '', ()
1584
1584
1585 char = text[-1]
1585 char = text[-1]
1586 # no expand on quote for completion in strings.
1586 # no expand on quote for completion in strings.
1587 # nor backcomplete standard ascii keys
1587 # nor backcomplete standard ascii keys
1588 if char in string.ascii_letters or char in ('"',"'"):
1588 if char in string.ascii_letters or char in ('"',"'"):
1589 return '', ()
1589 return '', ()
1590 try :
1590 try :
1591 unic = unicodedata.name(char)
1591 unic = unicodedata.name(char)
1592 return '\\'+char,('\\'+unic,)
1592 return '\\'+char,('\\'+unic,)
1593 except KeyError:
1593 except KeyError:
1594 pass
1594 pass
1595 return '', ()
1595 return '', ()
1596
1596
1597
1597
1598 @context_matcher()
1598 @context_matcher()
1599 def back_latex_name_matcher(context: CompletionContext):
1599 def back_latex_name_matcher(context: CompletionContext):
1600 """Match latex characters back to unicode name
1600 """Match latex characters back to unicode name
1601
1601
1602 Same as :any:`back_latex_name_matches`, but adopted to new Matcher API.
1602 Same as :any:`back_latex_name_matches`, but adopted to new Matcher API.
1603 """
1603 """
1604 fragment, matches = back_latex_name_matches(context.text_until_cursor)
1604 fragment, matches = back_latex_name_matches(context.text_until_cursor)
1605 return _convert_matcher_v1_result_to_v2(
1605 return _convert_matcher_v1_result_to_v2(
1606 matches, type="latex", fragment=fragment, suppress_if_matches=True
1606 matches, type="latex", fragment=fragment, suppress_if_matches=True
1607 )
1607 )
1608
1608
1609
1609
1610 def back_latex_name_matches(text: str) -> Tuple[str, Sequence[str]]:
1610 def back_latex_name_matches(text: str) -> Tuple[str, Sequence[str]]:
1611 """Match latex characters back to unicode name
1611 """Match latex characters back to unicode name
1612
1612
1613 This does ``\\β„΅`` -> ``\\aleph``
1613 This does ``\\β„΅`` -> ``\\aleph``
1614
1614
1615 .. deprecated:: 8.6
1615 .. deprecated:: 8.6
1616 You can use :meth:`back_latex_name_matcher` instead.
1616 You can use :meth:`back_latex_name_matcher` instead.
1617 """
1617 """
1618 if len(text)<2:
1618 if len(text)<2:
1619 return '', ()
1619 return '', ()
1620 maybe_slash = text[-2]
1620 maybe_slash = text[-2]
1621 if maybe_slash != '\\':
1621 if maybe_slash != '\\':
1622 return '', ()
1622 return '', ()
1623
1623
1624
1624
1625 char = text[-1]
1625 char = text[-1]
1626 # no expand on quote for completion in strings.
1626 # no expand on quote for completion in strings.
1627 # nor backcomplete standard ascii keys
1627 # nor backcomplete standard ascii keys
1628 if char in string.ascii_letters or char in ('"',"'"):
1628 if char in string.ascii_letters or char in ('"',"'"):
1629 return '', ()
1629 return '', ()
1630 try :
1630 try :
1631 latex = reverse_latex_symbol[char]
1631 latex = reverse_latex_symbol[char]
1632 # '\\' replace the \ as well
1632 # '\\' replace the \ as well
1633 return '\\'+char,[latex]
1633 return '\\'+char,[latex]
1634 except KeyError:
1634 except KeyError:
1635 pass
1635 pass
1636 return '', ()
1636 return '', ()
1637
1637
1638
1638
1639 def _formatparamchildren(parameter) -> str:
1639 def _formatparamchildren(parameter) -> str:
1640 """
1640 """
1641 Get parameter name and value from Jedi Private API
1641 Get parameter name and value from Jedi Private API
1642
1642
1643 Jedi does not expose a simple way to get `param=value` from its API.
1643 Jedi does not expose a simple way to get `param=value` from its API.
1644
1644
1645 Parameters
1645 Parameters
1646 ----------
1646 ----------
1647 parameter
1647 parameter
1648 Jedi's function `Param`
1648 Jedi's function `Param`
1649
1649
1650 Returns
1650 Returns
1651 -------
1651 -------
1652 A string like 'a', 'b=1', '*args', '**kwargs'
1652 A string like 'a', 'b=1', '*args', '**kwargs'
1653
1653
1654 """
1654 """
1655 description = parameter.description
1655 description = parameter.description
1656 if not description.startswith('param '):
1656 if not description.startswith('param '):
1657 raise ValueError('Jedi function parameter description have change format.'
1657 raise ValueError('Jedi function parameter description have change format.'
1658 'Expected "param ...", found %r".' % description)
1658 'Expected "param ...", found %r".' % description)
1659 return description[6:]
1659 return description[6:]
1660
1660
1661 def _make_signature(completion)-> str:
1661 def _make_signature(completion)-> str:
1662 """
1662 """
1663 Make the signature from a jedi completion
1663 Make the signature from a jedi completion
1664
1664
1665 Parameters
1665 Parameters
1666 ----------
1666 ----------
1667 completion : jedi.Completion
1667 completion : jedi.Completion
1668 object does not complete a function type
1668 object does not complete a function type
1669
1669
1670 Returns
1670 Returns
1671 -------
1671 -------
1672 a string consisting of the function signature, with the parenthesis but
1672 a string consisting of the function signature, with the parenthesis but
1673 without the function name. example:
1673 without the function name. example:
1674 `(a, *args, b=1, **kwargs)`
1674 `(a, *args, b=1, **kwargs)`
1675
1675
1676 """
1676 """
1677
1677
1678 # it looks like this might work on jedi 0.17
1678 # it looks like this might work on jedi 0.17
1679 if hasattr(completion, 'get_signatures'):
1679 if hasattr(completion, 'get_signatures'):
1680 signatures = completion.get_signatures()
1680 signatures = completion.get_signatures()
1681 if not signatures:
1681 if not signatures:
1682 return '(?)'
1682 return '(?)'
1683
1683
1684 c0 = completion.get_signatures()[0]
1684 c0 = completion.get_signatures()[0]
1685 return '('+c0.to_string().split('(', maxsplit=1)[1]
1685 return '('+c0.to_string().split('(', maxsplit=1)[1]
1686
1686
1687 return '(%s)'% ', '.join([f for f in (_formatparamchildren(p) for signature in completion.get_signatures()
1687 return '(%s)'% ', '.join([f for f in (_formatparamchildren(p) for signature in completion.get_signatures()
1688 for p in signature.defined_names()) if f])
1688 for p in signature.defined_names()) if f])
1689
1689
1690
1690
1691 _CompleteResult = Dict[str, MatcherResult]
1691 _CompleteResult = Dict[str, MatcherResult]
1692
1692
1693
1693
1694 DICT_MATCHER_REGEX = re.compile(
1694 DICT_MATCHER_REGEX = re.compile(
1695 r"""(?x)
1695 r"""(?x)
1696 ( # match dict-referring - or any get item object - expression
1696 ( # match dict-referring - or any get item object - expression
1697 .+
1697 .+
1698 )
1698 )
1699 \[ # open bracket
1699 \[ # open bracket
1700 \s* # and optional whitespace
1700 \s* # and optional whitespace
1701 # Capture any number of serializable objects (e.g. "a", "b", 'c')
1701 # Capture any number of serializable objects (e.g. "a", "b", 'c')
1702 # and slices
1702 # and slices
1703 ((?:(?:
1703 ((?:(?:
1704 (?: # closed string
1704 (?: # closed string
1705 [uUbB]? # string prefix (r not handled)
1705 [uUbB]? # string prefix (r not handled)
1706 (?:
1706 (?:
1707 '(?:[^']|(?<!\\)\\')*'
1707 '(?:[^']|(?<!\\)\\')*'
1708 |
1708 |
1709 "(?:[^"]|(?<!\\)\\")*"
1709 "(?:[^"]|(?<!\\)\\")*"
1710 )
1710 )
1711 )
1711 )
1712 |
1712 |
1713 # capture integers and slices
1713 # capture integers and slices
1714 (?:[-+]?\d+)?(?::(?:[-+]?\d+)?){0,2}
1714 (?:[-+]?\d+)?(?::(?:[-+]?\d+)?){0,2}
1715 |
1715 |
1716 # integer in bin/hex/oct notation
1716 # integer in bin/hex/oct notation
1717 0[bBxXoO]_?(?:\w|\d)+
1717 0[bBxXoO]_?(?:\w|\d)+
1718 )
1718 )
1719 \s*,\s*
1719 \s*,\s*
1720 )*)
1720 )*)
1721 ((?:
1721 ((?:
1722 (?: # unclosed string
1722 (?: # unclosed string
1723 [uUbB]? # string prefix (r not handled)
1723 [uUbB]? # string prefix (r not handled)
1724 (?:
1724 (?:
1725 '(?:[^']|(?<!\\)\\')*
1725 '(?:[^']|(?<!\\)\\')*
1726 |
1726 |
1727 "(?:[^"]|(?<!\\)\\")*
1727 "(?:[^"]|(?<!\\)\\")*
1728 )
1728 )
1729 )
1729 )
1730 |
1730 |
1731 # unfinished integer
1731 # unfinished integer
1732 (?:[-+]?\d+)
1732 (?:[-+]?\d+)
1733 |
1733 |
1734 # integer in bin/hex/oct notation
1734 # integer in bin/hex/oct notation
1735 0[bBxXoO]_?(?:\w|\d)+
1735 0[bBxXoO]_?(?:\w|\d)+
1736 )
1736 )
1737 )?
1737 )?
1738 $
1738 $
1739 """
1739 """
1740 )
1740 )
1741
1741
1742
1742
1743 def _convert_matcher_v1_result_to_v2(
1743 def _convert_matcher_v1_result_to_v2(
1744 matches: Sequence[str],
1744 matches: Sequence[str],
1745 type: str,
1745 type: str,
1746 fragment: Optional[str] = None,
1746 fragment: Optional[str] = None,
1747 suppress_if_matches: bool = False,
1747 suppress_if_matches: bool = False,
1748 ) -> SimpleMatcherResult:
1748 ) -> SimpleMatcherResult:
1749 """Utility to help with transition"""
1749 """Utility to help with transition"""
1750 result = {
1750 result = {
1751 "completions": [SimpleCompletion(text=match, type=type) for match in matches],
1751 "completions": [SimpleCompletion(text=match, type=type) for match in matches],
1752 "suppress": (True if matches else False) if suppress_if_matches else False,
1752 "suppress": (True if matches else False) if suppress_if_matches else False,
1753 }
1753 }
1754 if fragment is not None:
1754 if fragment is not None:
1755 result["matched_fragment"] = fragment
1755 result["matched_fragment"] = fragment
1756 return cast(SimpleMatcherResult, result)
1756 return cast(SimpleMatcherResult, result)
1757
1757
1758
1758
1759 class IPCompleter(Completer):
1759 class IPCompleter(Completer):
1760 """Extension of the completer class with IPython-specific features"""
1760 """Extension of the completer class with IPython-specific features"""
1761
1761
1762 @observe('greedy')
1762 @observe('greedy')
1763 def _greedy_changed(self, change):
1763 def _greedy_changed(self, change):
1764 """update the splitter and readline delims when greedy is changed"""
1764 """update the splitter and readline delims when greedy is changed"""
1765 if change["new"]:
1765 if change["new"]:
1766 self.evaluation = "unsafe"
1766 self.evaluation = "unsafe"
1767 self.auto_close_dict_keys = True
1767 self.auto_close_dict_keys = True
1768 self.splitter.delims = GREEDY_DELIMS
1768 self.splitter.delims = GREEDY_DELIMS
1769 else:
1769 else:
1770 self.evaluation = "limited"
1770 self.evaluation = "limited"
1771 self.auto_close_dict_keys = False
1771 self.auto_close_dict_keys = False
1772 self.splitter.delims = DELIMS
1772 self.splitter.delims = DELIMS
1773
1773
1774 dict_keys_only = Bool(
1774 dict_keys_only = Bool(
1775 False,
1775 False,
1776 help="""
1776 help="""
1777 Whether to show dict key matches only.
1777 Whether to show dict key matches only.
1778
1778
1779 (disables all matchers except for `IPCompleter.dict_key_matcher`).
1779 (disables all matchers except for `IPCompleter.dict_key_matcher`).
1780 """,
1780 """,
1781 )
1781 )
1782
1782
1783 suppress_competing_matchers = UnionTrait(
1783 suppress_competing_matchers = UnionTrait(
1784 [Bool(allow_none=True), DictTrait(Bool(None, allow_none=True))],
1784 [Bool(allow_none=True), DictTrait(Bool(None, allow_none=True))],
1785 default_value=None,
1785 default_value=None,
1786 help="""
1786 help="""
1787 Whether to suppress completions from other *Matchers*.
1787 Whether to suppress completions from other *Matchers*.
1788
1788
1789 When set to ``None`` (default) the matchers will attempt to auto-detect
1789 When set to ``None`` (default) the matchers will attempt to auto-detect
1790 whether suppression of other matchers is desirable. For example, at
1790 whether suppression of other matchers is desirable. For example, at
1791 the beginning of a line followed by `%` we expect a magic completion
1791 the beginning of a line followed by `%` we expect a magic completion
1792 to be the only applicable option, and after ``my_dict['`` we usually
1792 to be the only applicable option, and after ``my_dict['`` we usually
1793 expect a completion with an existing dictionary key.
1793 expect a completion with an existing dictionary key.
1794
1794
1795 If you want to disable this heuristic and see completions from all matchers,
1795 If you want to disable this heuristic and see completions from all matchers,
1796 set ``IPCompleter.suppress_competing_matchers = False``.
1796 set ``IPCompleter.suppress_competing_matchers = False``.
1797 To disable the heuristic for specific matchers provide a dictionary mapping:
1797 To disable the heuristic for specific matchers provide a dictionary mapping:
1798 ``IPCompleter.suppress_competing_matchers = {'IPCompleter.dict_key_matcher': False}``.
1798 ``IPCompleter.suppress_competing_matchers = {'IPCompleter.dict_key_matcher': False}``.
1799
1799
1800 Set ``IPCompleter.suppress_competing_matchers = True`` to limit
1800 Set ``IPCompleter.suppress_competing_matchers = True`` to limit
1801 completions to the set of matchers with the highest priority;
1801 completions to the set of matchers with the highest priority;
1802 this is equivalent to ``IPCompleter.merge_completions`` and
1802 this is equivalent to ``IPCompleter.merge_completions`` and
1803 can be beneficial for performance, but will sometimes omit relevant
1803 can be beneficial for performance, but will sometimes omit relevant
1804 candidates from matchers further down the priority list.
1804 candidates from matchers further down the priority list.
1805 """,
1805 """,
1806 ).tag(config=True)
1806 ).tag(config=True)
1807
1807
1808 merge_completions = Bool(
1808 merge_completions = Bool(
1809 True,
1809 True,
1810 help="""Whether to merge completion results into a single list
1810 help="""Whether to merge completion results into a single list
1811
1811
1812 If False, only the completion results from the first non-empty
1812 If False, only the completion results from the first non-empty
1813 completer will be returned.
1813 completer will be returned.
1814
1814
1815 As of version 8.6.0, setting the value to ``False`` is an alias for:
1815 As of version 8.6.0, setting the value to ``False`` is an alias for:
1816 ``IPCompleter.suppress_competing_matchers = True.``.
1816 ``IPCompleter.suppress_competing_matchers = True.``.
1817 """,
1817 """,
1818 ).tag(config=True)
1818 ).tag(config=True)
1819
1819
1820 disable_matchers = ListTrait(
1820 disable_matchers = ListTrait(
1821 Unicode(),
1821 Unicode(),
1822 help="""List of matchers to disable.
1822 help="""List of matchers to disable.
1823
1823
1824 The list should contain matcher identifiers (see :any:`completion_matcher`).
1824 The list should contain matcher identifiers (see :any:`completion_matcher`).
1825 """,
1825 """,
1826 ).tag(config=True)
1826 ).tag(config=True)
1827
1827
1828 omit__names = Enum(
1828 omit__names = Enum(
1829 (0, 1, 2),
1829 (0, 1, 2),
1830 default_value=2,
1830 default_value=2,
1831 help="""Instruct the completer to omit private method names
1831 help="""Instruct the completer to omit private method names
1832
1832
1833 Specifically, when completing on ``object.<tab>``.
1833 Specifically, when completing on ``object.<tab>``.
1834
1834
1835 When 2 [default]: all names that start with '_' will be excluded.
1835 When 2 [default]: all names that start with '_' will be excluded.
1836
1836
1837 When 1: all 'magic' names (``__foo__``) will be excluded.
1837 When 1: all 'magic' names (``__foo__``) will be excluded.
1838
1838
1839 When 0: nothing will be excluded.
1839 When 0: nothing will be excluded.
1840 """
1840 """
1841 ).tag(config=True)
1841 ).tag(config=True)
1842 limit_to__all__ = Bool(False,
1842 limit_to__all__ = Bool(False,
1843 help="""
1843 help="""
1844 DEPRECATED as of version 5.0.
1844 DEPRECATED as of version 5.0.
1845
1845
1846 Instruct the completer to use __all__ for the completion
1846 Instruct the completer to use __all__ for the completion
1847
1847
1848 Specifically, when completing on ``object.<tab>``.
1848 Specifically, when completing on ``object.<tab>``.
1849
1849
1850 When True: only those names in obj.__all__ will be included.
1850 When True: only those names in obj.__all__ will be included.
1851
1851
1852 When False [default]: the __all__ attribute is ignored
1852 When False [default]: the __all__ attribute is ignored
1853 """,
1853 """,
1854 ).tag(config=True)
1854 ).tag(config=True)
1855
1855
1856 profile_completions = Bool(
1856 profile_completions = Bool(
1857 default_value=False,
1857 default_value=False,
1858 help="If True, emit profiling data for completion subsystem using cProfile."
1858 help="If True, emit profiling data for completion subsystem using cProfile."
1859 ).tag(config=True)
1859 ).tag(config=True)
1860
1860
1861 profiler_output_dir = Unicode(
1861 profiler_output_dir = Unicode(
1862 default_value=".completion_profiles",
1862 default_value=".completion_profiles",
1863 help="Template for path at which to output profile data for completions."
1863 help="Template for path at which to output profile data for completions."
1864 ).tag(config=True)
1864 ).tag(config=True)
1865
1865
1866 @observe('limit_to__all__')
1866 @observe('limit_to__all__')
1867 def _limit_to_all_changed(self, change):
1867 def _limit_to_all_changed(self, change):
1868 warnings.warn('`IPython.core.IPCompleter.limit_to__all__` configuration '
1868 warnings.warn('`IPython.core.IPCompleter.limit_to__all__` configuration '
1869 'value has been deprecated since IPython 5.0, will be made to have '
1869 'value has been deprecated since IPython 5.0, will be made to have '
1870 'no effects and then removed in future version of IPython.',
1870 'no effects and then removed in future version of IPython.',
1871 UserWarning)
1871 UserWarning)
1872
1872
1873 def __init__(
1873 def __init__(
1874 self, shell=None, namespace=None, global_namespace=None, config=None, **kwargs
1874 self, shell=None, namespace=None, global_namespace=None, config=None, **kwargs
1875 ):
1875 ):
1876 """IPCompleter() -> completer
1876 """IPCompleter() -> completer
1877
1877
1878 Return a completer object.
1878 Return a completer object.
1879
1879
1880 Parameters
1880 Parameters
1881 ----------
1881 ----------
1882 shell
1882 shell
1883 a pointer to the ipython shell itself. This is needed
1883 a pointer to the ipython shell itself. This is needed
1884 because this completer knows about magic functions, and those can
1884 because this completer knows about magic functions, and those can
1885 only be accessed via the ipython instance.
1885 only be accessed via the ipython instance.
1886 namespace : dict, optional
1886 namespace : dict, optional
1887 an optional dict where completions are performed.
1887 an optional dict where completions are performed.
1888 global_namespace : dict, optional
1888 global_namespace : dict, optional
1889 secondary optional dict for completions, to
1889 secondary optional dict for completions, to
1890 handle cases (such as IPython embedded inside functions) where
1890 handle cases (such as IPython embedded inside functions) where
1891 both Python scopes are visible.
1891 both Python scopes are visible.
1892 config : Config
1892 config : Config
1893 traitlet's config object
1893 traitlet's config object
1894 **kwargs
1894 **kwargs
1895 passed to super class unmodified.
1895 passed to super class unmodified.
1896 """
1896 """
1897
1897
1898 self.magic_escape = ESC_MAGIC
1898 self.magic_escape = ESC_MAGIC
1899 self.splitter = CompletionSplitter()
1899 self.splitter = CompletionSplitter()
1900
1900
1901 # _greedy_changed() depends on splitter and readline being defined:
1901 # _greedy_changed() depends on splitter and readline being defined:
1902 super().__init__(
1902 super().__init__(
1903 namespace=namespace,
1903 namespace=namespace,
1904 global_namespace=global_namespace,
1904 global_namespace=global_namespace,
1905 config=config,
1905 config=config,
1906 **kwargs,
1906 **kwargs,
1907 )
1907 )
1908
1908
1909 # List where completion matches will be stored
1909 # List where completion matches will be stored
1910 self.matches = []
1910 self.matches = []
1911 self.shell = shell
1911 self.shell = shell
1912 # Regexp to split filenames with spaces in them
1912 # Regexp to split filenames with spaces in them
1913 self.space_name_re = re.compile(r'([^\\] )')
1913 self.space_name_re = re.compile(r'([^\\] )')
1914 # Hold a local ref. to glob.glob for speed
1914 # Hold a local ref. to glob.glob for speed
1915 self.glob = glob.glob
1915 self.glob = glob.glob
1916
1916
1917 # Determine if we are running on 'dumb' terminals, like (X)Emacs
1917 # Determine if we are running on 'dumb' terminals, like (X)Emacs
1918 # buffers, to avoid completion problems.
1918 # buffers, to avoid completion problems.
1919 term = os.environ.get('TERM','xterm')
1919 term = os.environ.get('TERM','xterm')
1920 self.dumb_terminal = term in ['dumb','emacs']
1920 self.dumb_terminal = term in ['dumb','emacs']
1921
1921
1922 # Special handling of backslashes needed in win32 platforms
1922 # Special handling of backslashes needed in win32 platforms
1923 if sys.platform == "win32":
1923 if sys.platform == "win32":
1924 self.clean_glob = self._clean_glob_win32
1924 self.clean_glob = self._clean_glob_win32
1925 else:
1925 else:
1926 self.clean_glob = self._clean_glob
1926 self.clean_glob = self._clean_glob
1927
1927
1928 #regexp to parse docstring for function signature
1928 #regexp to parse docstring for function signature
1929 self.docstring_sig_re = re.compile(r'^[\w|\s.]+\(([^)]*)\).*')
1929 self.docstring_sig_re = re.compile(r'^[\w|\s.]+\(([^)]*)\).*')
1930 self.docstring_kwd_re = re.compile(r'[\s|\[]*(\w+)(?:\s*=\s*.*)')
1930 self.docstring_kwd_re = re.compile(r'[\s|\[]*(\w+)(?:\s*=\s*.*)')
1931 #use this if positional argument name is also needed
1931 #use this if positional argument name is also needed
1932 #= re.compile(r'[\s|\[]*(\w+)(?:\s*=?\s*.*)')
1932 #= re.compile(r'[\s|\[]*(\w+)(?:\s*=?\s*.*)')
1933
1933
1934 self.magic_arg_matchers = [
1934 self.magic_arg_matchers = [
1935 self.magic_config_matcher,
1935 self.magic_config_matcher,
1936 self.magic_color_matcher,
1936 self.magic_color_matcher,
1937 ]
1937 ]
1938
1938
1939 # This is set externally by InteractiveShell
1939 # This is set externally by InteractiveShell
1940 self.custom_completers = None
1940 self.custom_completers = None
1941
1941
1942 # This is a list of names of unicode characters that can be completed
1942 # This is a list of names of unicode characters that can be completed
1943 # into their corresponding unicode value. The list is large, so we
1943 # into their corresponding unicode value. The list is large, so we
1944 # lazily initialize it on first use. Consuming code should access this
1944 # lazily initialize it on first use. Consuming code should access this
1945 # attribute through the `@unicode_names` property.
1945 # attribute through the `@unicode_names` property.
1946 self._unicode_names = None
1946 self._unicode_names = None
1947
1947
1948 self._backslash_combining_matchers = [
1948 self._backslash_combining_matchers = [
1949 self.latex_name_matcher,
1949 self.latex_name_matcher,
1950 self.unicode_name_matcher,
1950 self.unicode_name_matcher,
1951 back_latex_name_matcher,
1951 back_latex_name_matcher,
1952 back_unicode_name_matcher,
1952 back_unicode_name_matcher,
1953 self.fwd_unicode_matcher,
1953 self.fwd_unicode_matcher,
1954 ]
1954 ]
1955
1955
1956 if not self.backslash_combining_completions:
1956 if not self.backslash_combining_completions:
1957 for matcher in self._backslash_combining_matchers:
1957 for matcher in self._backslash_combining_matchers:
1958 self.disable_matchers.append(_get_matcher_id(matcher))
1958 self.disable_matchers.append(_get_matcher_id(matcher))
1959
1959
1960 if not self.merge_completions:
1960 if not self.merge_completions:
1961 self.suppress_competing_matchers = True
1961 self.suppress_competing_matchers = True
1962
1962
1963 @property
1963 @property
1964 def matchers(self) -> List[Matcher]:
1964 def matchers(self) -> List[Matcher]:
1965 """All active matcher routines for completion"""
1965 """All active matcher routines for completion"""
1966 if self.dict_keys_only:
1966 if self.dict_keys_only:
1967 return [self.dict_key_matcher]
1967 return [self.dict_key_matcher]
1968
1968
1969 if self.use_jedi:
1969 if self.use_jedi:
1970 return [
1970 return [
1971 *self.custom_matchers,
1971 *self.custom_matchers,
1972 *self._backslash_combining_matchers,
1972 *self._backslash_combining_matchers,
1973 *self.magic_arg_matchers,
1973 *self.magic_arg_matchers,
1974 self.custom_completer_matcher,
1974 self.custom_completer_matcher,
1975 self.magic_matcher,
1975 self.magic_matcher,
1976 self._jedi_matcher,
1976 self._jedi_matcher,
1977 self.dict_key_matcher,
1977 self.dict_key_matcher,
1978 self.file_matcher,
1978 self.file_matcher,
1979 ]
1979 ]
1980 else:
1980 else:
1981 return [
1981 return [
1982 *self.custom_matchers,
1982 *self.custom_matchers,
1983 *self._backslash_combining_matchers,
1983 *self._backslash_combining_matchers,
1984 *self.magic_arg_matchers,
1984 *self.magic_arg_matchers,
1985 self.custom_completer_matcher,
1985 self.custom_completer_matcher,
1986 self.dict_key_matcher,
1986 self.dict_key_matcher,
1987 self.magic_matcher,
1987 self.magic_matcher,
1988 self.python_matcher,
1988 self.python_matcher,
1989 self.file_matcher,
1989 self.file_matcher,
1990 self.python_func_kw_matcher,
1990 self.python_func_kw_matcher,
1991 ]
1991 ]
1992
1992
1993 def all_completions(self, text:str) -> List[str]:
1993 def all_completions(self, text:str) -> List[str]:
1994 """
1994 """
1995 Wrapper around the completion methods for the benefit of emacs.
1995 Wrapper around the completion methods for the benefit of emacs.
1996 """
1996 """
1997 prefix = text.rpartition('.')[0]
1997 prefix = text.rpartition('.')[0]
1998 with provisionalcompleter():
1998 with provisionalcompleter():
1999 return ['.'.join([prefix, c.text]) if prefix and self.use_jedi else c.text
1999 return ['.'.join([prefix, c.text]) if prefix and self.use_jedi else c.text
2000 for c in self.completions(text, len(text))]
2000 for c in self.completions(text, len(text))]
2001
2001
2002 return self.complete(text)[1]
2002 return self.complete(text)[1]
2003
2003
2004 def _clean_glob(self, text:str):
2004 def _clean_glob(self, text:str):
2005 return self.glob("%s*" % text)
2005 return self.glob("%s*" % text)
2006
2006
2007 def _clean_glob_win32(self, text:str):
2007 def _clean_glob_win32(self, text:str):
2008 return [f.replace("\\","/")
2008 return [f.replace("\\","/")
2009 for f in self.glob("%s*" % text)]
2009 for f in self.glob("%s*" % text)]
2010
2010
2011 @context_matcher()
2011 @context_matcher()
2012 def file_matcher(self, context: CompletionContext) -> SimpleMatcherResult:
2012 def file_matcher(self, context: CompletionContext) -> SimpleMatcherResult:
2013 """Same as :any:`file_matches`, but adopted to new Matcher API."""
2013 """Same as :any:`file_matches`, but adopted to new Matcher API."""
2014 matches = self.file_matches(context.token)
2014 matches = self.file_matches(context.token)
2015 # TODO: add a heuristic for suppressing (e.g. if it has OS-specific delimiter,
2015 # TODO: add a heuristic for suppressing (e.g. if it has OS-specific delimiter,
2016 # starts with `/home/`, `C:\`, etc)
2016 # starts with `/home/`, `C:\`, etc)
2017 return _convert_matcher_v1_result_to_v2(matches, type="path")
2017 return _convert_matcher_v1_result_to_v2(matches, type="path")
2018
2018
2019 def file_matches(self, text: str) -> List[str]:
2019 def file_matches(self, text: str) -> List[str]:
2020 """Match filenames, expanding ~USER type strings.
2020 """Match filenames, expanding ~USER type strings.
2021
2021
2022 Most of the seemingly convoluted logic in this completer is an
2022 Most of the seemingly convoluted logic in this completer is an
2023 attempt to handle filenames with spaces in them. And yet it's not
2023 attempt to handle filenames with spaces in them. And yet it's not
2024 quite perfect, because Python's readline doesn't expose all of the
2024 quite perfect, because Python's readline doesn't expose all of the
2025 GNU readline details needed for this to be done correctly.
2025 GNU readline details needed for this to be done correctly.
2026
2026
2027 For a filename with a space in it, the printed completions will be
2027 For a filename with a space in it, the printed completions will be
2028 only the parts after what's already been typed (instead of the
2028 only the parts after what's already been typed (instead of the
2029 full completions, as is normally done). I don't think with the
2029 full completions, as is normally done). I don't think with the
2030 current (as of Python 2.3) Python readline it's possible to do
2030 current (as of Python 2.3) Python readline it's possible to do
2031 better.
2031 better.
2032
2032
2033 .. deprecated:: 8.6
2033 .. deprecated:: 8.6
2034 You can use :meth:`file_matcher` instead.
2034 You can use :meth:`file_matcher` instead.
2035 """
2035 """
2036
2036
2037 # chars that require escaping with backslash - i.e. chars
2037 # chars that require escaping with backslash - i.e. chars
2038 # that readline treats incorrectly as delimiters, but we
2038 # that readline treats incorrectly as delimiters, but we
2039 # don't want to treat as delimiters in filename matching
2039 # don't want to treat as delimiters in filename matching
2040 # when escaped with backslash
2040 # when escaped with backslash
2041 if text.startswith('!'):
2041 if text.startswith('!'):
2042 text = text[1:]
2042 text = text[1:]
2043 text_prefix = u'!'
2043 text_prefix = u'!'
2044 else:
2044 else:
2045 text_prefix = u''
2045 text_prefix = u''
2046
2046
2047 text_until_cursor = self.text_until_cursor
2047 text_until_cursor = self.text_until_cursor
2048 # track strings with open quotes
2048 # track strings with open quotes
2049 open_quotes = has_open_quotes(text_until_cursor)
2049 open_quotes = has_open_quotes(text_until_cursor)
2050
2050
2051 if '(' in text_until_cursor or '[' in text_until_cursor:
2051 if '(' in text_until_cursor or '[' in text_until_cursor:
2052 lsplit = text
2052 lsplit = text
2053 else:
2053 else:
2054 try:
2054 try:
2055 # arg_split ~ shlex.split, but with unicode bugs fixed by us
2055 # arg_split ~ shlex.split, but with unicode bugs fixed by us
2056 lsplit = arg_split(text_until_cursor)[-1]
2056 lsplit = arg_split(text_until_cursor)[-1]
2057 except ValueError:
2057 except ValueError:
2058 # typically an unmatched ", or backslash without escaped char.
2058 # typically an unmatched ", or backslash without escaped char.
2059 if open_quotes:
2059 if open_quotes:
2060 lsplit = text_until_cursor.split(open_quotes)[-1]
2060 lsplit = text_until_cursor.split(open_quotes)[-1]
2061 else:
2061 else:
2062 return []
2062 return []
2063 except IndexError:
2063 except IndexError:
2064 # tab pressed on empty line
2064 # tab pressed on empty line
2065 lsplit = ""
2065 lsplit = ""
2066
2066
2067 if not open_quotes and lsplit != protect_filename(lsplit):
2067 if not open_quotes and lsplit != protect_filename(lsplit):
2068 # if protectables are found, do matching on the whole escaped name
2068 # if protectables are found, do matching on the whole escaped name
2069 has_protectables = True
2069 has_protectables = True
2070 text0,text = text,lsplit
2070 text0,text = text,lsplit
2071 else:
2071 else:
2072 has_protectables = False
2072 has_protectables = False
2073 text = os.path.expanduser(text)
2073 text = os.path.expanduser(text)
2074
2074
2075 if text == "":
2075 if text == "":
2076 return [text_prefix + protect_filename(f) for f in self.glob("*")]
2076 return [text_prefix + protect_filename(f) for f in self.glob("*")]
2077
2077
2078 # Compute the matches from the filesystem
2078 # Compute the matches from the filesystem
2079 if sys.platform == 'win32':
2079 if sys.platform == 'win32':
2080 m0 = self.clean_glob(text)
2080 m0 = self.clean_glob(text)
2081 else:
2081 else:
2082 m0 = self.clean_glob(text.replace('\\', ''))
2082 m0 = self.clean_glob(text.replace('\\', ''))
2083
2083
2084 if has_protectables:
2084 if has_protectables:
2085 # If we had protectables, we need to revert our changes to the
2085 # If we had protectables, we need to revert our changes to the
2086 # beginning of filename so that we don't double-write the part
2086 # beginning of filename so that we don't double-write the part
2087 # of the filename we have so far
2087 # of the filename we have so far
2088 len_lsplit = len(lsplit)
2088 len_lsplit = len(lsplit)
2089 matches = [text_prefix + text0 +
2089 matches = [text_prefix + text0 +
2090 protect_filename(f[len_lsplit:]) for f in m0]
2090 protect_filename(f[len_lsplit:]) for f in m0]
2091 else:
2091 else:
2092 if open_quotes:
2092 if open_quotes:
2093 # if we have a string with an open quote, we don't need to
2093 # if we have a string with an open quote, we don't need to
2094 # protect the names beyond the quote (and we _shouldn't_, as
2094 # protect the names beyond the quote (and we _shouldn't_, as
2095 # it would cause bugs when the filesystem call is made).
2095 # it would cause bugs when the filesystem call is made).
2096 matches = m0 if sys.platform == "win32" else\
2096 matches = m0 if sys.platform == "win32" else\
2097 [protect_filename(f, open_quotes) for f in m0]
2097 [protect_filename(f, open_quotes) for f in m0]
2098 else:
2098 else:
2099 matches = [text_prefix +
2099 matches = [text_prefix +
2100 protect_filename(f) for f in m0]
2100 protect_filename(f) for f in m0]
2101
2101
2102 # Mark directories in input list by appending '/' to their names.
2102 # Mark directories in input list by appending '/' to their names.
2103 return [x+'/' if os.path.isdir(x) else x for x in matches]
2103 return [x+'/' if os.path.isdir(x) else x for x in matches]
2104
2104
2105 @context_matcher()
2105 @context_matcher()
2106 def magic_matcher(self, context: CompletionContext) -> SimpleMatcherResult:
2106 def magic_matcher(self, context: CompletionContext) -> SimpleMatcherResult:
2107 """Match magics."""
2107 """Match magics."""
2108 text = context.token
2108 text = context.token
2109 matches = self.magic_matches(text)
2109 matches = self.magic_matches(text)
2110 result = _convert_matcher_v1_result_to_v2(matches, type="magic")
2110 result = _convert_matcher_v1_result_to_v2(matches, type="magic")
2111 is_magic_prefix = len(text) > 0 and text[0] == "%"
2111 is_magic_prefix = len(text) > 0 and text[0] == "%"
2112 result["suppress"] = is_magic_prefix and bool(result["completions"])
2112 result["suppress"] = is_magic_prefix and bool(result["completions"])
2113 return result
2113 return result
2114
2114
2115 def magic_matches(self, text: str):
2115 def magic_matches(self, text: str):
2116 """Match magics.
2116 """Match magics.
2117
2117
2118 .. deprecated:: 8.6
2118 .. deprecated:: 8.6
2119 You can use :meth:`magic_matcher` instead.
2119 You can use :meth:`magic_matcher` instead.
2120 """
2120 """
2121 # Get all shell magics now rather than statically, so magics loaded at
2121 # Get all shell magics now rather than statically, so magics loaded at
2122 # runtime show up too.
2122 # runtime show up too.
2123 lsm = self.shell.magics_manager.lsmagic()
2123 lsm = self.shell.magics_manager.lsmagic()
2124 line_magics = lsm['line']
2124 line_magics = lsm['line']
2125 cell_magics = lsm['cell']
2125 cell_magics = lsm['cell']
2126 pre = self.magic_escape
2126 pre = self.magic_escape
2127 pre2 = pre+pre
2127 pre2 = pre+pre
2128
2128
2129 explicit_magic = text.startswith(pre)
2129 explicit_magic = text.startswith(pre)
2130
2130
2131 # Completion logic:
2131 # Completion logic:
2132 # - user gives %%: only do cell magics
2132 # - user gives %%: only do cell magics
2133 # - user gives %: do both line and cell magics
2133 # - user gives %: do both line and cell magics
2134 # - no prefix: do both
2134 # - no prefix: do both
2135 # In other words, line magics are skipped if the user gives %% explicitly
2135 # In other words, line magics are skipped if the user gives %% explicitly
2136 #
2136 #
2137 # We also exclude magics that match any currently visible names:
2137 # We also exclude magics that match any currently visible names:
2138 # https://github.com/ipython/ipython/issues/4877, unless the user has
2138 # https://github.com/ipython/ipython/issues/4877, unless the user has
2139 # typed a %:
2139 # typed a %:
2140 # https://github.com/ipython/ipython/issues/10754
2140 # https://github.com/ipython/ipython/issues/10754
2141 bare_text = text.lstrip(pre)
2141 bare_text = text.lstrip(pre)
2142 global_matches = self.global_matches(bare_text)
2142 global_matches = self.global_matches(bare_text)
2143 if not explicit_magic:
2143 if not explicit_magic:
2144 def matches(magic):
2144 def matches(magic):
2145 """
2145 """
2146 Filter magics, in particular remove magics that match
2146 Filter magics, in particular remove magics that match
2147 a name present in global namespace.
2147 a name present in global namespace.
2148 """
2148 """
2149 return ( magic.startswith(bare_text) and
2149 return ( magic.startswith(bare_text) and
2150 magic not in global_matches )
2150 magic not in global_matches )
2151 else:
2151 else:
2152 def matches(magic):
2152 def matches(magic):
2153 return magic.startswith(bare_text)
2153 return magic.startswith(bare_text)
2154
2154
2155 comp = [ pre2+m for m in cell_magics if matches(m)]
2155 comp = [ pre2+m for m in cell_magics if matches(m)]
2156 if not text.startswith(pre2):
2156 if not text.startswith(pre2):
2157 comp += [ pre+m for m in line_magics if matches(m)]
2157 comp += [ pre+m for m in line_magics if matches(m)]
2158
2158
2159 return comp
2159 return comp
2160
2160
2161 @context_matcher()
2161 @context_matcher()
2162 def magic_config_matcher(self, context: CompletionContext) -> SimpleMatcherResult:
2162 def magic_config_matcher(self, context: CompletionContext) -> SimpleMatcherResult:
2163 """Match class names and attributes for %config magic."""
2163 """Match class names and attributes for %config magic."""
2164 # NOTE: uses `line_buffer` equivalent for compatibility
2164 # NOTE: uses `line_buffer` equivalent for compatibility
2165 matches = self.magic_config_matches(context.line_with_cursor)
2165 matches = self.magic_config_matches(context.line_with_cursor)
2166 return _convert_matcher_v1_result_to_v2(matches, type="param")
2166 return _convert_matcher_v1_result_to_v2(matches, type="param")
2167
2167
2168 def magic_config_matches(self, text: str) -> List[str]:
2168 def magic_config_matches(self, text: str) -> List[str]:
2169 """Match class names and attributes for %config magic.
2169 """Match class names and attributes for %config magic.
2170
2170
2171 .. deprecated:: 8.6
2171 .. deprecated:: 8.6
2172 You can use :meth:`magic_config_matcher` instead.
2172 You can use :meth:`magic_config_matcher` instead.
2173 """
2173 """
2174 texts = text.strip().split()
2174 texts = text.strip().split()
2175
2175
2176 if len(texts) > 0 and (texts[0] == 'config' or texts[0] == '%config'):
2176 if len(texts) > 0 and (texts[0] == 'config' or texts[0] == '%config'):
2177 # get all configuration classes
2177 # get all configuration classes
2178 classes = sorted(set([ c for c in self.shell.configurables
2178 classes = sorted(set([ c for c in self.shell.configurables
2179 if c.__class__.class_traits(config=True)
2179 if c.__class__.class_traits(config=True)
2180 ]), key=lambda x: x.__class__.__name__)
2180 ]), key=lambda x: x.__class__.__name__)
2181 classnames = [ c.__class__.__name__ for c in classes ]
2181 classnames = [ c.__class__.__name__ for c in classes ]
2182
2182
2183 # return all classnames if config or %config is given
2183 # return all classnames if config or %config is given
2184 if len(texts) == 1:
2184 if len(texts) == 1:
2185 return classnames
2185 return classnames
2186
2186
2187 # match classname
2187 # match classname
2188 classname_texts = texts[1].split('.')
2188 classname_texts = texts[1].split('.')
2189 classname = classname_texts[0]
2189 classname = classname_texts[0]
2190 classname_matches = [ c for c in classnames
2190 classname_matches = [ c for c in classnames
2191 if c.startswith(classname) ]
2191 if c.startswith(classname) ]
2192
2192
2193 # return matched classes or the matched class with attributes
2193 # return matched classes or the matched class with attributes
2194 if texts[1].find('.') < 0:
2194 if texts[1].find('.') < 0:
2195 return classname_matches
2195 return classname_matches
2196 elif len(classname_matches) == 1 and \
2196 elif len(classname_matches) == 1 and \
2197 classname_matches[0] == classname:
2197 classname_matches[0] == classname:
2198 cls = classes[classnames.index(classname)].__class__
2198 cls = classes[classnames.index(classname)].__class__
2199 help = cls.class_get_help()
2199 help = cls.class_get_help()
2200 # strip leading '--' from cl-args:
2200 # strip leading '--' from cl-args:
2201 help = re.sub(re.compile(r'^--', re.MULTILINE), '', help)
2201 help = re.sub(re.compile(r'^--', re.MULTILINE), '', help)
2202 return [ attr.split('=')[0]
2202 return [ attr.split('=')[0]
2203 for attr in help.strip().splitlines()
2203 for attr in help.strip().splitlines()
2204 if attr.startswith(texts[1]) ]
2204 if attr.startswith(texts[1]) ]
2205 return []
2205 return []
2206
2206
2207 @context_matcher()
2207 @context_matcher()
2208 def magic_color_matcher(self, context: CompletionContext) -> SimpleMatcherResult:
2208 def magic_color_matcher(self, context: CompletionContext) -> SimpleMatcherResult:
2209 """Match color schemes for %colors magic."""
2209 """Match color schemes for %colors magic."""
2210 # NOTE: uses `line_buffer` equivalent for compatibility
2210 # NOTE: uses `line_buffer` equivalent for compatibility
2211 matches = self.magic_color_matches(context.line_with_cursor)
2211 matches = self.magic_color_matches(context.line_with_cursor)
2212 return _convert_matcher_v1_result_to_v2(matches, type="param")
2212 return _convert_matcher_v1_result_to_v2(matches, type="param")
2213
2213
2214 def magic_color_matches(self, text: str) -> List[str]:
2214 def magic_color_matches(self, text: str) -> List[str]:
2215 """Match color schemes for %colors magic.
2215 """Match color schemes for %colors magic.
2216
2216
2217 .. deprecated:: 8.6
2217 .. deprecated:: 8.6
2218 You can use :meth:`magic_color_matcher` instead.
2218 You can use :meth:`magic_color_matcher` instead.
2219 """
2219 """
2220 texts = text.split()
2220 texts = text.split()
2221 if text.endswith(' '):
2221 if text.endswith(' '):
2222 # .split() strips off the trailing whitespace. Add '' back
2222 # .split() strips off the trailing whitespace. Add '' back
2223 # so that: '%colors ' -> ['%colors', '']
2223 # so that: '%colors ' -> ['%colors', '']
2224 texts.append('')
2224 texts.append('')
2225
2225
2226 if len(texts) == 2 and (texts[0] == 'colors' or texts[0] == '%colors'):
2226 if len(texts) == 2 and (texts[0] == 'colors' or texts[0] == '%colors'):
2227 prefix = texts[1]
2227 prefix = texts[1]
2228 return [ color for color in InspectColors.keys()
2228 return [ color for color in InspectColors.keys()
2229 if color.startswith(prefix) ]
2229 if color.startswith(prefix) ]
2230 return []
2230 return []
2231
2231
2232 @context_matcher(identifier="IPCompleter.jedi_matcher")
2232 @context_matcher(identifier="IPCompleter.jedi_matcher")
2233 def _jedi_matcher(self, context: CompletionContext) -> _JediMatcherResult:
2233 def _jedi_matcher(self, context: CompletionContext) -> _JediMatcherResult:
2234 matches = self._jedi_matches(
2234 matches = self._jedi_matches(
2235 cursor_column=context.cursor_position,
2235 cursor_column=context.cursor_position,
2236 cursor_line=context.cursor_line,
2236 cursor_line=context.cursor_line,
2237 text=context.full_text,
2237 text=context.full_text,
2238 )
2238 )
2239 return {
2239 return {
2240 "completions": matches,
2240 "completions": matches,
2241 # static analysis should not suppress other matchers
2241 # static analysis should not suppress other matchers
2242 "suppress": False,
2242 "suppress": False,
2243 }
2243 }
2244
2244
2245 def _jedi_matches(
2245 def _jedi_matches(
2246 self, cursor_column: int, cursor_line: int, text: str
2246 self, cursor_column: int, cursor_line: int, text: str
2247 ) -> Iterator[_JediCompletionLike]:
2247 ) -> Iterator[_JediCompletionLike]:
2248 """
2248 """
2249 Return a list of :any:`jedi.api.Completion`\\s object from a ``text`` and
2249 Return a list of :any:`jedi.api.Completion`\\s object from a ``text`` and
2250 cursor position.
2250 cursor position.
2251
2251
2252 Parameters
2252 Parameters
2253 ----------
2253 ----------
2254 cursor_column : int
2254 cursor_column : int
2255 column position of the cursor in ``text``, 0-indexed.
2255 column position of the cursor in ``text``, 0-indexed.
2256 cursor_line : int
2256 cursor_line : int
2257 line position of the cursor in ``text``, 0-indexed
2257 line position of the cursor in ``text``, 0-indexed
2258 text : str
2258 text : str
2259 text to complete
2259 text to complete
2260
2260
2261 Notes
2261 Notes
2262 -----
2262 -----
2263 If ``IPCompleter.debug`` is ``True`` may return a :any:`_FakeJediCompletion`
2263 If ``IPCompleter.debug`` is ``True`` may return a :any:`_FakeJediCompletion`
2264 object containing a string with the Jedi debug information attached.
2264 object containing a string with the Jedi debug information attached.
2265
2265
2266 .. deprecated:: 8.6
2266 .. deprecated:: 8.6
2267 You can use :meth:`_jedi_matcher` instead.
2267 You can use :meth:`_jedi_matcher` instead.
2268 """
2268 """
2269 namespaces = [self.namespace]
2269 namespaces = [self.namespace]
2270 if self.global_namespace is not None:
2270 if self.global_namespace is not None:
2271 namespaces.append(self.global_namespace)
2271 namespaces.append(self.global_namespace)
2272
2272
2273 completion_filter = lambda x:x
2273 completion_filter = lambda x:x
2274 offset = cursor_to_position(text, cursor_line, cursor_column)
2274 offset = cursor_to_position(text, cursor_line, cursor_column)
2275 # filter output if we are completing for object members
2275 # filter output if we are completing for object members
2276 if offset:
2276 if offset:
2277 pre = text[offset-1]
2277 pre = text[offset-1]
2278 if pre == '.':
2278 if pre == '.':
2279 if self.omit__names == 2:
2279 if self.omit__names == 2:
2280 completion_filter = lambda c:not c.name.startswith('_')
2280 completion_filter = lambda c:not c.name.startswith('_')
2281 elif self.omit__names == 1:
2281 elif self.omit__names == 1:
2282 completion_filter = lambda c:not (c.name.startswith('__') and c.name.endswith('__'))
2282 completion_filter = lambda c:not (c.name.startswith('__') and c.name.endswith('__'))
2283 elif self.omit__names == 0:
2283 elif self.omit__names == 0:
2284 completion_filter = lambda x:x
2284 completion_filter = lambda x:x
2285 else:
2285 else:
2286 raise ValueError("Don't understand self.omit__names == {}".format(self.omit__names))
2286 raise ValueError("Don't understand self.omit__names == {}".format(self.omit__names))
2287
2287
2288 interpreter = jedi.Interpreter(text[:offset], namespaces)
2288 interpreter = jedi.Interpreter(text[:offset], namespaces)
2289 try_jedi = True
2289 try_jedi = True
2290
2290
2291 try:
2291 try:
2292 # find the first token in the current tree -- if it is a ' or " then we are in a string
2292 # find the first token in the current tree -- if it is a ' or " then we are in a string
2293 completing_string = False
2293 completing_string = False
2294 try:
2294 try:
2295 first_child = next(c for c in interpreter._get_module().tree_node.children if hasattr(c, 'value'))
2295 first_child = next(c for c in interpreter._get_module().tree_node.children if hasattr(c, 'value'))
2296 except StopIteration:
2296 except StopIteration:
2297 pass
2297 pass
2298 else:
2298 else:
2299 # note the value may be ', ", or it may also be ''' or """, or
2299 # note the value may be ', ", or it may also be ''' or """, or
2300 # in some cases, """what/you/typed..., but all of these are
2300 # in some cases, """what/you/typed..., but all of these are
2301 # strings.
2301 # strings.
2302 completing_string = len(first_child.value) > 0 and first_child.value[0] in {"'", '"'}
2302 completing_string = len(first_child.value) > 0 and first_child.value[0] in {"'", '"'}
2303
2303
2304 # if we are in a string jedi is likely not the right candidate for
2304 # if we are in a string jedi is likely not the right candidate for
2305 # now. Skip it.
2305 # now. Skip it.
2306 try_jedi = not completing_string
2306 try_jedi = not completing_string
2307 except Exception as e:
2307 except Exception as e:
2308 # many of things can go wrong, we are using private API just don't crash.
2308 # many of things can go wrong, we are using private API just don't crash.
2309 if self.debug:
2309 if self.debug:
2310 print("Error detecting if completing a non-finished string :", e, '|')
2310 print("Error detecting if completing a non-finished string :", e, '|')
2311
2311
2312 if not try_jedi:
2312 if not try_jedi:
2313 return iter([])
2313 return iter([])
2314 try:
2314 try:
2315 return filter(completion_filter, interpreter.complete(column=cursor_column, line=cursor_line + 1))
2315 return filter(completion_filter, interpreter.complete(column=cursor_column, line=cursor_line + 1))
2316 except Exception as e:
2316 except Exception as e:
2317 if self.debug:
2317 if self.debug:
2318 return iter(
2318 return iter(
2319 [
2319 [
2320 _FakeJediCompletion(
2320 _FakeJediCompletion(
2321 'Oops Jedi has crashed, please report a bug with the following:\n"""\n%s\ns"""'
2321 'Oops Jedi has crashed, please report a bug with the following:\n"""\n%s\ns"""'
2322 % (e)
2322 % (e)
2323 )
2323 )
2324 ]
2324 ]
2325 )
2325 )
2326 else:
2326 else:
2327 return iter([])
2327 return iter([])
2328
2328
2329 @context_matcher()
2329 @context_matcher()
2330 def python_matcher(self, context: CompletionContext) -> SimpleMatcherResult:
2330 def python_matcher(self, context: CompletionContext) -> SimpleMatcherResult:
2331 """Match attributes or global python names"""
2331 """Match attributes or global python names"""
2332 text = context.line_with_cursor
2332 text = context.line_with_cursor
2333 if "." in text:
2333 if "." in text:
2334 try:
2334 try:
2335 matches, fragment = self._attr_matches(text, include_prefix=False)
2335 matches, fragment = self._attr_matches(text, include_prefix=False)
2336 if text.endswith(".") and self.omit__names:
2336 if text.endswith(".") and self.omit__names:
2337 if self.omit__names == 1:
2337 if self.omit__names == 1:
2338 # true if txt is _not_ a __ name, false otherwise:
2338 # true if txt is _not_ a __ name, false otherwise:
2339 no__name = lambda txt: re.match(r".*\.__.*?__", txt) is None
2339 no__name = lambda txt: re.match(r".*\.__.*?__", txt) is None
2340 else:
2340 else:
2341 # true if txt is _not_ a _ name, false otherwise:
2341 # true if txt is _not_ a _ name, false otherwise:
2342 no__name = (
2342 no__name = (
2343 lambda txt: re.match(r"\._.*?", txt[txt.rindex(".") :])
2343 lambda txt: re.match(r"\._.*?", txt[txt.rindex(".") :])
2344 is None
2344 is None
2345 )
2345 )
2346 matches = filter(no__name, matches)
2346 matches = filter(no__name, matches)
2347 return _convert_matcher_v1_result_to_v2(
2347 return _convert_matcher_v1_result_to_v2(
2348 matches, type="attribute", fragment=fragment
2348 matches, type="attribute", fragment=fragment
2349 )
2349 )
2350 except NameError:
2350 except NameError:
2351 # catches <undefined attributes>.<tab>
2351 # catches <undefined attributes>.<tab>
2352 matches = []
2352 matches = []
2353 return _convert_matcher_v1_result_to_v2(matches, type="attribute")
2353 return _convert_matcher_v1_result_to_v2(matches, type="attribute")
2354 else:
2354 else:
2355 matches = self.global_matches(context.token)
2355 matches = self.global_matches(context.token)
2356 # TODO: maybe distinguish between functions, modules and just "variables"
2356 # TODO: maybe distinguish between functions, modules and just "variables"
2357 return _convert_matcher_v1_result_to_v2(matches, type="variable")
2357 return _convert_matcher_v1_result_to_v2(matches, type="variable")
2358
2358
2359 @completion_matcher(api_version=1)
2359 @completion_matcher(api_version=1)
2360 def python_matches(self, text: str) -> Iterable[str]:
2360 def python_matches(self, text: str) -> Iterable[str]:
2361 """Match attributes or global python names.
2361 """Match attributes or global python names.
2362
2362
2363 .. deprecated:: 8.27
2363 .. deprecated:: 8.27
2364 You can use :meth:`python_matcher` instead."""
2364 You can use :meth:`python_matcher` instead."""
2365 if "." in text:
2365 if "." in text:
2366 try:
2366 try:
2367 matches = self.attr_matches(text)
2367 matches = self.attr_matches(text)
2368 if text.endswith('.') and self.omit__names:
2368 if text.endswith('.') and self.omit__names:
2369 if self.omit__names == 1:
2369 if self.omit__names == 1:
2370 # true if txt is _not_ a __ name, false otherwise:
2370 # true if txt is _not_ a __ name, false otherwise:
2371 no__name = (lambda txt:
2371 no__name = (lambda txt:
2372 re.match(r'.*\.__.*?__',txt) is None)
2372 re.match(r'.*\.__.*?__',txt) is None)
2373 else:
2373 else:
2374 # true if txt is _not_ a _ name, false otherwise:
2374 # true if txt is _not_ a _ name, false otherwise:
2375 no__name = (lambda txt:
2375 no__name = (lambda txt:
2376 re.match(r'\._.*?',txt[txt.rindex('.'):]) is None)
2376 re.match(r'\._.*?',txt[txt.rindex('.'):]) is None)
2377 matches = filter(no__name, matches)
2377 matches = filter(no__name, matches)
2378 except NameError:
2378 except NameError:
2379 # catches <undefined attributes>.<tab>
2379 # catches <undefined attributes>.<tab>
2380 matches = []
2380 matches = []
2381 else:
2381 else:
2382 matches = self.global_matches(text)
2382 matches = self.global_matches(text)
2383 return matches
2383 return matches
2384
2384
2385 def _default_arguments_from_docstring(self, doc):
2385 def _default_arguments_from_docstring(self, doc):
2386 """Parse the first line of docstring for call signature.
2386 """Parse the first line of docstring for call signature.
2387
2387
2388 Docstring should be of the form 'min(iterable[, key=func])\n'.
2388 Docstring should be of the form 'min(iterable[, key=func])\n'.
2389 It can also parse cython docstring of the form
2389 It can also parse cython docstring of the form
2390 'Minuit.migrad(self, int ncall=10000, resume=True, int nsplit=1)'.
2390 'Minuit.migrad(self, int ncall=10000, resume=True, int nsplit=1)'.
2391 """
2391 """
2392 if doc is None:
2392 if doc is None:
2393 return []
2393 return []
2394
2394
2395 #care only the firstline
2395 #care only the firstline
2396 line = doc.lstrip().splitlines()[0]
2396 line = doc.lstrip().splitlines()[0]
2397
2397
2398 #p = re.compile(r'^[\w|\s.]+\(([^)]*)\).*')
2398 #p = re.compile(r'^[\w|\s.]+\(([^)]*)\).*')
2399 #'min(iterable[, key=func])\n' -> 'iterable[, key=func]'
2399 #'min(iterable[, key=func])\n' -> 'iterable[, key=func]'
2400 sig = self.docstring_sig_re.search(line)
2400 sig = self.docstring_sig_re.search(line)
2401 if sig is None:
2401 if sig is None:
2402 return []
2402 return []
2403 # iterable[, key=func]' -> ['iterable[' ,' key=func]']
2403 # iterable[, key=func]' -> ['iterable[' ,' key=func]']
2404 sig = sig.groups()[0].split(',')
2404 sig = sig.groups()[0].split(',')
2405 ret = []
2405 ret = []
2406 for s in sig:
2406 for s in sig:
2407 #re.compile(r'[\s|\[]*(\w+)(?:\s*=\s*.*)')
2407 #re.compile(r'[\s|\[]*(\w+)(?:\s*=\s*.*)')
2408 ret += self.docstring_kwd_re.findall(s)
2408 ret += self.docstring_kwd_re.findall(s)
2409 return ret
2409 return ret
2410
2410
2411 def _default_arguments(self, obj):
2411 def _default_arguments(self, obj):
2412 """Return the list of default arguments of obj if it is callable,
2412 """Return the list of default arguments of obj if it is callable,
2413 or empty list otherwise."""
2413 or empty list otherwise."""
2414 call_obj = obj
2414 call_obj = obj
2415 ret = []
2415 ret = []
2416 if inspect.isbuiltin(obj):
2416 if inspect.isbuiltin(obj):
2417 pass
2417 pass
2418 elif not (inspect.isfunction(obj) or inspect.ismethod(obj)):
2418 elif not (inspect.isfunction(obj) or inspect.ismethod(obj)):
2419 if inspect.isclass(obj):
2419 if inspect.isclass(obj):
2420 #for cython embedsignature=True the constructor docstring
2420 #for cython embedsignature=True the constructor docstring
2421 #belongs to the object itself not __init__
2421 #belongs to the object itself not __init__
2422 ret += self._default_arguments_from_docstring(
2422 ret += self._default_arguments_from_docstring(
2423 getattr(obj, '__doc__', ''))
2423 getattr(obj, '__doc__', ''))
2424 # for classes, check for __init__,__new__
2424 # for classes, check for __init__,__new__
2425 call_obj = (getattr(obj, '__init__', None) or
2425 call_obj = (getattr(obj, '__init__', None) or
2426 getattr(obj, '__new__', None))
2426 getattr(obj, '__new__', None))
2427 # for all others, check if they are __call__able
2427 # for all others, check if they are __call__able
2428 elif hasattr(obj, '__call__'):
2428 elif hasattr(obj, '__call__'):
2429 call_obj = obj.__call__
2429 call_obj = obj.__call__
2430 ret += self._default_arguments_from_docstring(
2430 ret += self._default_arguments_from_docstring(
2431 getattr(call_obj, '__doc__', ''))
2431 getattr(call_obj, '__doc__', ''))
2432
2432
2433 _keeps = (inspect.Parameter.KEYWORD_ONLY,
2433 _keeps = (inspect.Parameter.KEYWORD_ONLY,
2434 inspect.Parameter.POSITIONAL_OR_KEYWORD)
2434 inspect.Parameter.POSITIONAL_OR_KEYWORD)
2435
2435
2436 try:
2436 try:
2437 sig = inspect.signature(obj)
2437 sig = inspect.signature(obj)
2438 ret.extend(k for k, v in sig.parameters.items() if
2438 ret.extend(k for k, v in sig.parameters.items() if
2439 v.kind in _keeps)
2439 v.kind in _keeps)
2440 except ValueError:
2440 except ValueError:
2441 pass
2441 pass
2442
2442
2443 return list(set(ret))
2443 return list(set(ret))
2444
2444
2445 @context_matcher()
2445 @context_matcher()
2446 def python_func_kw_matcher(self, context: CompletionContext) -> SimpleMatcherResult:
2446 def python_func_kw_matcher(self, context: CompletionContext) -> SimpleMatcherResult:
2447 """Match named parameters (kwargs) of the last open function."""
2447 """Match named parameters (kwargs) of the last open function."""
2448 matches = self.python_func_kw_matches(context.token)
2448 matches = self.python_func_kw_matches(context.token)
2449 return _convert_matcher_v1_result_to_v2(matches, type="param")
2449 return _convert_matcher_v1_result_to_v2(matches, type="param")
2450
2450
2451 def python_func_kw_matches(self, text):
2451 def python_func_kw_matches(self, text):
2452 """Match named parameters (kwargs) of the last open function.
2452 """Match named parameters (kwargs) of the last open function.
2453
2453
2454 .. deprecated:: 8.6
2454 .. deprecated:: 8.6
2455 You can use :meth:`python_func_kw_matcher` instead.
2455 You can use :meth:`python_func_kw_matcher` instead.
2456 """
2456 """
2457
2457
2458 if "." in text: # a parameter cannot be dotted
2458 if "." in text: # a parameter cannot be dotted
2459 return []
2459 return []
2460 try: regexp = self.__funcParamsRegex
2460 try: regexp = self.__funcParamsRegex
2461 except AttributeError:
2461 except AttributeError:
2462 regexp = self.__funcParamsRegex = re.compile(r'''
2462 regexp = self.__funcParamsRegex = re.compile(r'''
2463 '.*?(?<!\\)' | # single quoted strings or
2463 '.*?(?<!\\)' | # single quoted strings or
2464 ".*?(?<!\\)" | # double quoted strings or
2464 ".*?(?<!\\)" | # double quoted strings or
2465 \w+ | # identifier
2465 \w+ | # identifier
2466 \S # other characters
2466 \S # other characters
2467 ''', re.VERBOSE | re.DOTALL)
2467 ''', re.VERBOSE | re.DOTALL)
2468 # 1. find the nearest identifier that comes before an unclosed
2468 # 1. find the nearest identifier that comes before an unclosed
2469 # parenthesis before the cursor
2469 # parenthesis before the cursor
2470 # e.g. for "foo (1+bar(x), pa<cursor>,a=1)", the candidate is "foo"
2470 # e.g. for "foo (1+bar(x), pa<cursor>,a=1)", the candidate is "foo"
2471 tokens = regexp.findall(self.text_until_cursor)
2471 tokens = regexp.findall(self.text_until_cursor)
2472 iterTokens = reversed(tokens); openPar = 0
2472 iterTokens = reversed(tokens); openPar = 0
2473
2473
2474 for token in iterTokens:
2474 for token in iterTokens:
2475 if token == ')':
2475 if token == ')':
2476 openPar -= 1
2476 openPar -= 1
2477 elif token == '(':
2477 elif token == '(':
2478 openPar += 1
2478 openPar += 1
2479 if openPar > 0:
2479 if openPar > 0:
2480 # found the last unclosed parenthesis
2480 # found the last unclosed parenthesis
2481 break
2481 break
2482 else:
2482 else:
2483 return []
2483 return []
2484 # 2. Concatenate dotted names ("foo.bar" for "foo.bar(x, pa" )
2484 # 2. Concatenate dotted names ("foo.bar" for "foo.bar(x, pa" )
2485 ids = []
2485 ids = []
2486 isId = re.compile(r'\w+$').match
2486 isId = re.compile(r'\w+$').match
2487
2487
2488 while True:
2488 while True:
2489 try:
2489 try:
2490 ids.append(next(iterTokens))
2490 ids.append(next(iterTokens))
2491 if not isId(ids[-1]):
2491 if not isId(ids[-1]):
2492 ids.pop(); break
2492 ids.pop(); break
2493 if not next(iterTokens) == '.':
2493 if not next(iterTokens) == '.':
2494 break
2494 break
2495 except StopIteration:
2495 except StopIteration:
2496 break
2496 break
2497
2497
2498 # Find all named arguments already assigned to, as to avoid suggesting
2498 # Find all named arguments already assigned to, as to avoid suggesting
2499 # them again
2499 # them again
2500 usedNamedArgs = set()
2500 usedNamedArgs = set()
2501 par_level = -1
2501 par_level = -1
2502 for token, next_token in zip(tokens, tokens[1:]):
2502 for token, next_token in zip(tokens, tokens[1:]):
2503 if token == '(':
2503 if token == '(':
2504 par_level += 1
2504 par_level += 1
2505 elif token == ')':
2505 elif token == ')':
2506 par_level -= 1
2506 par_level -= 1
2507
2507
2508 if par_level != 0:
2508 if par_level != 0:
2509 continue
2509 continue
2510
2510
2511 if next_token != '=':
2511 if next_token != '=':
2512 continue
2512 continue
2513
2513
2514 usedNamedArgs.add(token)
2514 usedNamedArgs.add(token)
2515
2515
2516 argMatches = []
2516 argMatches = []
2517 try:
2517 try:
2518 callableObj = '.'.join(ids[::-1])
2518 callableObj = '.'.join(ids[::-1])
2519 namedArgs = self._default_arguments(eval(callableObj,
2519 namedArgs = self._default_arguments(eval(callableObj,
2520 self.namespace))
2520 self.namespace))
2521
2521
2522 # Remove used named arguments from the list, no need to show twice
2522 # Remove used named arguments from the list, no need to show twice
2523 for namedArg in set(namedArgs) - usedNamedArgs:
2523 for namedArg in set(namedArgs) - usedNamedArgs:
2524 if namedArg.startswith(text):
2524 if namedArg.startswith(text):
2525 argMatches.append("%s=" %namedArg)
2525 argMatches.append("%s=" %namedArg)
2526 except:
2526 except:
2527 pass
2527 pass
2528
2528
2529 return argMatches
2529 return argMatches
2530
2530
2531 @staticmethod
2531 @staticmethod
2532 def _get_keys(obj: Any) -> List[Any]:
2532 def _get_keys(obj: Any) -> List[Any]:
2533 # Objects can define their own completions by defining an
2533 # Objects can define their own completions by defining an
2534 # _ipy_key_completions_() method.
2534 # _ipy_key_completions_() method.
2535 method = get_real_method(obj, '_ipython_key_completions_')
2535 method = get_real_method(obj, '_ipython_key_completions_')
2536 if method is not None:
2536 if method is not None:
2537 return method()
2537 return method()
2538
2538
2539 # Special case some common in-memory dict-like types
2539 # Special case some common in-memory dict-like types
2540 if isinstance(obj, dict) or _safe_isinstance(obj, "pandas", "DataFrame"):
2540 if isinstance(obj, dict) or _safe_isinstance(obj, "pandas", "DataFrame"):
2541 try:
2541 try:
2542 return list(obj.keys())
2542 return list(obj.keys())
2543 except Exception:
2543 except Exception:
2544 return []
2544 return []
2545 elif _safe_isinstance(obj, "pandas", "core", "indexing", "_LocIndexer"):
2545 elif _safe_isinstance(obj, "pandas", "core", "indexing", "_LocIndexer"):
2546 try:
2546 try:
2547 return list(obj.obj.keys())
2547 return list(obj.obj.keys())
2548 except Exception:
2548 except Exception:
2549 return []
2549 return []
2550 elif _safe_isinstance(obj, 'numpy', 'ndarray') or\
2550 elif _safe_isinstance(obj, 'numpy', 'ndarray') or\
2551 _safe_isinstance(obj, 'numpy', 'void'):
2551 _safe_isinstance(obj, 'numpy', 'void'):
2552 return obj.dtype.names or []
2552 return obj.dtype.names or []
2553 return []
2553 return []
2554
2554
2555 @context_matcher()
2555 @context_matcher()
2556 def dict_key_matcher(self, context: CompletionContext) -> SimpleMatcherResult:
2556 def dict_key_matcher(self, context: CompletionContext) -> SimpleMatcherResult:
2557 """Match string keys in a dictionary, after e.g. ``foo[``."""
2557 """Match string keys in a dictionary, after e.g. ``foo[``."""
2558 matches = self.dict_key_matches(context.token)
2558 matches = self.dict_key_matches(context.token)
2559 return _convert_matcher_v1_result_to_v2(
2559 return _convert_matcher_v1_result_to_v2(
2560 matches, type="dict key", suppress_if_matches=True
2560 matches, type="dict key", suppress_if_matches=True
2561 )
2561 )
2562
2562
2563 def dict_key_matches(self, text: str) -> List[str]:
2563 def dict_key_matches(self, text: str) -> List[str]:
2564 """Match string keys in a dictionary, after e.g. ``foo[``.
2564 """Match string keys in a dictionary, after e.g. ``foo[``.
2565
2565
2566 .. deprecated:: 8.6
2566 .. deprecated:: 8.6
2567 You can use :meth:`dict_key_matcher` instead.
2567 You can use :meth:`dict_key_matcher` instead.
2568 """
2568 """
2569
2569
2570 # Short-circuit on closed dictionary (regular expression would
2570 # Short-circuit on closed dictionary (regular expression would
2571 # not match anyway, but would take quite a while).
2571 # not match anyway, but would take quite a while).
2572 if self.text_until_cursor.strip().endswith("]"):
2572 if self.text_until_cursor.strip().endswith("]"):
2573 return []
2573 return []
2574
2574
2575 match = DICT_MATCHER_REGEX.search(self.text_until_cursor)
2575 match = DICT_MATCHER_REGEX.search(self.text_until_cursor)
2576
2576
2577 if match is None:
2577 if match is None:
2578 return []
2578 return []
2579
2579
2580 expr, prior_tuple_keys, key_prefix = match.groups()
2580 expr, prior_tuple_keys, key_prefix = match.groups()
2581
2581
2582 obj = self._evaluate_expr(expr)
2582 obj = self._evaluate_expr(expr)
2583
2583
2584 if obj is not_found:
2584 if obj is not_found:
2585 return []
2585 return []
2586
2586
2587 keys = self._get_keys(obj)
2587 keys = self._get_keys(obj)
2588 if not keys:
2588 if not keys:
2589 return keys
2589 return keys
2590
2590
2591 tuple_prefix = guarded_eval(
2591 tuple_prefix = guarded_eval(
2592 prior_tuple_keys,
2592 prior_tuple_keys,
2593 EvaluationContext(
2593 EvaluationContext(
2594 globals=self.global_namespace,
2594 globals=self.global_namespace,
2595 locals=self.namespace,
2595 locals=self.namespace,
2596 evaluation=self.evaluation, # type: ignore
2596 evaluation=self.evaluation, # type: ignore
2597 in_subscript=True,
2597 in_subscript=True,
2598 ),
2598 ),
2599 )
2599 )
2600
2600
2601 closing_quote, token_offset, matches = match_dict_keys(
2601 closing_quote, token_offset, matches = match_dict_keys(
2602 keys, key_prefix, self.splitter.delims, extra_prefix=tuple_prefix
2602 keys, key_prefix, self.splitter.delims, extra_prefix=tuple_prefix
2603 )
2603 )
2604 if not matches:
2604 if not matches:
2605 return []
2605 return []
2606
2606
2607 # get the cursor position of
2607 # get the cursor position of
2608 # - the text being completed
2608 # - the text being completed
2609 # - the start of the key text
2609 # - the start of the key text
2610 # - the start of the completion
2610 # - the start of the completion
2611 text_start = len(self.text_until_cursor) - len(text)
2611 text_start = len(self.text_until_cursor) - len(text)
2612 if key_prefix:
2612 if key_prefix:
2613 key_start = match.start(3)
2613 key_start = match.start(3)
2614 completion_start = key_start + token_offset
2614 completion_start = key_start + token_offset
2615 else:
2615 else:
2616 key_start = completion_start = match.end()
2616 key_start = completion_start = match.end()
2617
2617
2618 # grab the leading prefix, to make sure all completions start with `text`
2618 # grab the leading prefix, to make sure all completions start with `text`
2619 if text_start > key_start:
2619 if text_start > key_start:
2620 leading = ''
2620 leading = ''
2621 else:
2621 else:
2622 leading = text[text_start:completion_start]
2622 leading = text[text_start:completion_start]
2623
2623
2624 # append closing quote and bracket as appropriate
2624 # append closing quote and bracket as appropriate
2625 # this is *not* appropriate if the opening quote or bracket is outside
2625 # this is *not* appropriate if the opening quote or bracket is outside
2626 # the text given to this method, e.g. `d["""a\nt
2626 # the text given to this method, e.g. `d["""a\nt
2627 can_close_quote = False
2627 can_close_quote = False
2628 can_close_bracket = False
2628 can_close_bracket = False
2629
2629
2630 continuation = self.line_buffer[len(self.text_until_cursor) :].strip()
2630 continuation = self.line_buffer[len(self.text_until_cursor) :].strip()
2631
2631
2632 if continuation.startswith(closing_quote):
2632 if continuation.startswith(closing_quote):
2633 # do not close if already closed, e.g. `d['a<tab>'`
2633 # do not close if already closed, e.g. `d['a<tab>'`
2634 continuation = continuation[len(closing_quote) :]
2634 continuation = continuation[len(closing_quote) :]
2635 else:
2635 else:
2636 can_close_quote = True
2636 can_close_quote = True
2637
2637
2638 continuation = continuation.strip()
2638 continuation = continuation.strip()
2639
2639
2640 # e.g. `pandas.DataFrame` has different tuple indexer behaviour,
2640 # e.g. `pandas.DataFrame` has different tuple indexer behaviour,
2641 # handling it is out of scope, so let's avoid appending suffixes.
2641 # handling it is out of scope, so let's avoid appending suffixes.
2642 has_known_tuple_handling = isinstance(obj, dict)
2642 has_known_tuple_handling = isinstance(obj, dict)
2643
2643
2644 can_close_bracket = (
2644 can_close_bracket = (
2645 not continuation.startswith("]") and self.auto_close_dict_keys
2645 not continuation.startswith("]") and self.auto_close_dict_keys
2646 )
2646 )
2647 can_close_tuple_item = (
2647 can_close_tuple_item = (
2648 not continuation.startswith(",")
2648 not continuation.startswith(",")
2649 and has_known_tuple_handling
2649 and has_known_tuple_handling
2650 and self.auto_close_dict_keys
2650 and self.auto_close_dict_keys
2651 )
2651 )
2652 can_close_quote = can_close_quote and self.auto_close_dict_keys
2652 can_close_quote = can_close_quote and self.auto_close_dict_keys
2653
2653
2654 # fast path if closing quote should be appended but not suffix is allowed
2654 # fast path if closing quote should be appended but not suffix is allowed
2655 if not can_close_quote and not can_close_bracket and closing_quote:
2655 if not can_close_quote and not can_close_bracket and closing_quote:
2656 return [leading + k for k in matches]
2656 return [leading + k for k in matches]
2657
2657
2658 results = []
2658 results = []
2659
2659
2660 end_of_tuple_or_item = _DictKeyState.END_OF_TUPLE | _DictKeyState.END_OF_ITEM
2660 end_of_tuple_or_item = _DictKeyState.END_OF_TUPLE | _DictKeyState.END_OF_ITEM
2661
2661
2662 for k, state_flag in matches.items():
2662 for k, state_flag in matches.items():
2663 result = leading + k
2663 result = leading + k
2664 if can_close_quote and closing_quote:
2664 if can_close_quote and closing_quote:
2665 result += closing_quote
2665 result += closing_quote
2666
2666
2667 if state_flag == end_of_tuple_or_item:
2667 if state_flag == end_of_tuple_or_item:
2668 # We do not know which suffix to add,
2668 # We do not know which suffix to add,
2669 # e.g. both tuple item and string
2669 # e.g. both tuple item and string
2670 # match this item.
2670 # match this item.
2671 pass
2671 pass
2672
2672
2673 if state_flag in end_of_tuple_or_item and can_close_bracket:
2673 if state_flag in end_of_tuple_or_item and can_close_bracket:
2674 result += "]"
2674 result += "]"
2675 if state_flag == _DictKeyState.IN_TUPLE and can_close_tuple_item:
2675 if state_flag == _DictKeyState.IN_TUPLE and can_close_tuple_item:
2676 result += ", "
2676 result += ", "
2677 results.append(result)
2677 results.append(result)
2678 return results
2678 return results
2679
2679
2680 @context_matcher()
2680 @context_matcher()
2681 def unicode_name_matcher(self, context: CompletionContext):
2681 def unicode_name_matcher(self, context: CompletionContext):
2682 """Same as :any:`unicode_name_matches`, but adopted to new Matcher API."""
2682 """Same as :any:`unicode_name_matches`, but adopted to new Matcher API."""
2683 fragment, matches = self.unicode_name_matches(context.text_until_cursor)
2683 fragment, matches = self.unicode_name_matches(context.text_until_cursor)
2684 return _convert_matcher_v1_result_to_v2(
2684 return _convert_matcher_v1_result_to_v2(
2685 matches, type="unicode", fragment=fragment, suppress_if_matches=True
2685 matches, type="unicode", fragment=fragment, suppress_if_matches=True
2686 )
2686 )
2687
2687
2688 @staticmethod
2688 @staticmethod
2689 def unicode_name_matches(text: str) -> Tuple[str, List[str]]:
2689 def unicode_name_matches(text: str) -> Tuple[str, List[str]]:
2690 """Match Latex-like syntax for unicode characters base
2690 """Match Latex-like syntax for unicode characters base
2691 on the name of the character.
2691 on the name of the character.
2692
2692
2693 This does ``\\GREEK SMALL LETTER ETA`` -> ``Ξ·``
2693 This does ``\\GREEK SMALL LETTER ETA`` -> ``Ξ·``
2694
2694
2695 Works only on valid python 3 identifier, or on combining characters that
2695 Works only on valid python 3 identifier, or on combining characters that
2696 will combine to form a valid identifier.
2696 will combine to form a valid identifier.
2697 """
2697 """
2698 slashpos = text.rfind('\\')
2698 slashpos = text.rfind('\\')
2699 if slashpos > -1:
2699 if slashpos > -1:
2700 s = text[slashpos+1:]
2700 s = text[slashpos+1:]
2701 try :
2701 try :
2702 unic = unicodedata.lookup(s)
2702 unic = unicodedata.lookup(s)
2703 # allow combining chars
2703 # allow combining chars
2704 if ('a'+unic).isidentifier():
2704 if ('a'+unic).isidentifier():
2705 return '\\'+s,[unic]
2705 return '\\'+s,[unic]
2706 except KeyError:
2706 except KeyError:
2707 pass
2707 pass
2708 return '', []
2708 return '', []
2709
2709
2710 @context_matcher()
2710 @context_matcher()
2711 def latex_name_matcher(self, context: CompletionContext):
2711 def latex_name_matcher(self, context: CompletionContext):
2712 """Match Latex syntax for unicode characters.
2712 """Match Latex syntax for unicode characters.
2713
2713
2714 This does both ``\\alp`` -> ``\\alpha`` and ``\\alpha`` -> ``Ξ±``
2714 This does both ``\\alp`` -> ``\\alpha`` and ``\\alpha`` -> ``Ξ±``
2715 """
2715 """
2716 fragment, matches = self.latex_matches(context.text_until_cursor)
2716 fragment, matches = self.latex_matches(context.text_until_cursor)
2717 return _convert_matcher_v1_result_to_v2(
2717 return _convert_matcher_v1_result_to_v2(
2718 matches, type="latex", fragment=fragment, suppress_if_matches=True
2718 matches, type="latex", fragment=fragment, suppress_if_matches=True
2719 )
2719 )
2720
2720
2721 def latex_matches(self, text: str) -> Tuple[str, Sequence[str]]:
2721 def latex_matches(self, text: str) -> Tuple[str, Sequence[str]]:
2722 """Match Latex syntax for unicode characters.
2722 """Match Latex syntax for unicode characters.
2723
2723
2724 This does both ``\\alp`` -> ``\\alpha`` and ``\\alpha`` -> ``Ξ±``
2724 This does both ``\\alp`` -> ``\\alpha`` and ``\\alpha`` -> ``Ξ±``
2725
2725
2726 .. deprecated:: 8.6
2726 .. deprecated:: 8.6
2727 You can use :meth:`latex_name_matcher` instead.
2727 You can use :meth:`latex_name_matcher` instead.
2728 """
2728 """
2729 slashpos = text.rfind('\\')
2729 slashpos = text.rfind('\\')
2730 if slashpos > -1:
2730 if slashpos > -1:
2731 s = text[slashpos:]
2731 s = text[slashpos:]
2732 if s in latex_symbols:
2732 if s in latex_symbols:
2733 # Try to complete a full latex symbol to unicode
2733 # Try to complete a full latex symbol to unicode
2734 # \\alpha -> Ξ±
2734 # \\alpha -> Ξ±
2735 return s, [latex_symbols[s]]
2735 return s, [latex_symbols[s]]
2736 else:
2736 else:
2737 # If a user has partially typed a latex symbol, give them
2737 # If a user has partially typed a latex symbol, give them
2738 # a full list of options \al -> [\aleph, \alpha]
2738 # a full list of options \al -> [\aleph, \alpha]
2739 matches = [k for k in latex_symbols if k.startswith(s)]
2739 matches = [k for k in latex_symbols if k.startswith(s)]
2740 if matches:
2740 if matches:
2741 return s, matches
2741 return s, matches
2742 return '', ()
2742 return '', ()
2743
2743
2744 @context_matcher()
2744 @context_matcher()
2745 def custom_completer_matcher(self, context):
2745 def custom_completer_matcher(self, context):
2746 """Dispatch custom completer.
2746 """Dispatch custom completer.
2747
2747
2748 If a match is found, suppresses all other matchers except for Jedi.
2748 If a match is found, suppresses all other matchers except for Jedi.
2749 """
2749 """
2750 matches = self.dispatch_custom_completer(context.token) or []
2750 matches = self.dispatch_custom_completer(context.token) or []
2751 result = _convert_matcher_v1_result_to_v2(
2751 result = _convert_matcher_v1_result_to_v2(
2752 matches, type=_UNKNOWN_TYPE, suppress_if_matches=True
2752 matches, type=_UNKNOWN_TYPE, suppress_if_matches=True
2753 )
2753 )
2754 result["ordered"] = True
2754 result["ordered"] = True
2755 result["do_not_suppress"] = {_get_matcher_id(self._jedi_matcher)}
2755 result["do_not_suppress"] = {_get_matcher_id(self._jedi_matcher)}
2756 return result
2756 return result
2757
2757
2758 def dispatch_custom_completer(self, text):
2758 def dispatch_custom_completer(self, text):
2759 """
2759 """
2760 .. deprecated:: 8.6
2760 .. deprecated:: 8.6
2761 You can use :meth:`custom_completer_matcher` instead.
2761 You can use :meth:`custom_completer_matcher` instead.
2762 """
2762 """
2763 if not self.custom_completers:
2763 if not self.custom_completers:
2764 return
2764 return
2765
2765
2766 line = self.line_buffer
2766 line = self.line_buffer
2767 if not line.strip():
2767 if not line.strip():
2768 return None
2768 return None
2769
2769
2770 # Create a little structure to pass all the relevant information about
2770 # Create a little structure to pass all the relevant information about
2771 # the current completion to any custom completer.
2771 # the current completion to any custom completer.
2772 event = SimpleNamespace()
2772 event = SimpleNamespace()
2773 event.line = line
2773 event.line = line
2774 event.symbol = text
2774 event.symbol = text
2775 cmd = line.split(None,1)[0]
2775 cmd = line.split(None,1)[0]
2776 event.command = cmd
2776 event.command = cmd
2777 event.text_until_cursor = self.text_until_cursor
2777 event.text_until_cursor = self.text_until_cursor
2778
2778
2779 # for foo etc, try also to find completer for %foo
2779 # for foo etc, try also to find completer for %foo
2780 if not cmd.startswith(self.magic_escape):
2780 if not cmd.startswith(self.magic_escape):
2781 try_magic = self.custom_completers.s_matches(
2781 try_magic = self.custom_completers.s_matches(
2782 self.magic_escape + cmd)
2782 self.magic_escape + cmd)
2783 else:
2783 else:
2784 try_magic = []
2784 try_magic = []
2785
2785
2786 for c in itertools.chain(self.custom_completers.s_matches(cmd),
2786 for c in itertools.chain(self.custom_completers.s_matches(cmd),
2787 try_magic,
2787 try_magic,
2788 self.custom_completers.flat_matches(self.text_until_cursor)):
2788 self.custom_completers.flat_matches(self.text_until_cursor)):
2789 try:
2789 try:
2790 res = c(event)
2790 res = c(event)
2791 if res:
2791 if res:
2792 # first, try case sensitive match
2792 # first, try case sensitive match
2793 withcase = [r for r in res if r.startswith(text)]
2793 withcase = [r for r in res if r.startswith(text)]
2794 if withcase:
2794 if withcase:
2795 return withcase
2795 return withcase
2796 # if none, then case insensitive ones are ok too
2796 # if none, then case insensitive ones are ok too
2797 text_low = text.lower()
2797 text_low = text.lower()
2798 return [r for r in res if r.lower().startswith(text_low)]
2798 return [r for r in res if r.lower().startswith(text_low)]
2799 except TryNext:
2799 except TryNext:
2800 pass
2800 pass
2801 except KeyboardInterrupt:
2801 except KeyboardInterrupt:
2802 """
2802 """
2803 If custom completer take too long,
2803 If custom completer take too long,
2804 let keyboard interrupt abort and return nothing.
2804 let keyboard interrupt abort and return nothing.
2805 """
2805 """
2806 break
2806 break
2807
2807
2808 return None
2808 return None
2809
2809
2810 def completions(self, text: str, offset: int)->Iterator[Completion]:
2810 def completions(self, text: str, offset: int)->Iterator[Completion]:
2811 """
2811 """
2812 Returns an iterator over the possible completions
2812 Returns an iterator over the possible completions
2813
2813
2814 .. warning::
2814 .. warning::
2815
2815
2816 Unstable
2816 Unstable
2817
2817
2818 This function is unstable, API may change without warning.
2818 This function is unstable, API may change without warning.
2819 It will also raise unless use in proper context manager.
2819 It will also raise unless use in proper context manager.
2820
2820
2821 Parameters
2821 Parameters
2822 ----------
2822 ----------
2823 text : str
2823 text : str
2824 Full text of the current input, multi line string.
2824 Full text of the current input, multi line string.
2825 offset : int
2825 offset : int
2826 Integer representing the position of the cursor in ``text``. Offset
2826 Integer representing the position of the cursor in ``text``. Offset
2827 is 0-based indexed.
2827 is 0-based indexed.
2828
2828
2829 Yields
2829 Yields
2830 ------
2830 ------
2831 Completion
2831 Completion
2832
2832
2833 Notes
2833 Notes
2834 -----
2834 -----
2835 The cursor on a text can either be seen as being "in between"
2835 The cursor on a text can either be seen as being "in between"
2836 characters or "On" a character depending on the interface visible to
2836 characters or "On" a character depending on the interface visible to
2837 the user. For consistency the cursor being on "in between" characters X
2837 the user. For consistency the cursor being on "in between" characters X
2838 and Y is equivalent to the cursor being "on" character Y, that is to say
2838 and Y is equivalent to the cursor being "on" character Y, that is to say
2839 the character the cursor is on is considered as being after the cursor.
2839 the character the cursor is on is considered as being after the cursor.
2840
2840
2841 Combining characters may span more that one position in the
2841 Combining characters may span more that one position in the
2842 text.
2842 text.
2843
2843
2844 .. note::
2844 .. note::
2845
2845
2846 If ``IPCompleter.debug`` is :any:`True` will yield a ``--jedi/ipython--``
2846 If ``IPCompleter.debug`` is :any:`True` will yield a ``--jedi/ipython--``
2847 fake Completion token to distinguish completion returned by Jedi
2847 fake Completion token to distinguish completion returned by Jedi
2848 and usual IPython completion.
2848 and usual IPython completion.
2849
2849
2850 .. note::
2850 .. note::
2851
2851
2852 Completions are not completely deduplicated yet. If identical
2852 Completions are not completely deduplicated yet. If identical
2853 completions are coming from different sources this function does not
2853 completions are coming from different sources this function does not
2854 ensure that each completion object will only be present once.
2854 ensure that each completion object will only be present once.
2855 """
2855 """
2856 warnings.warn("_complete is a provisional API (as of IPython 6.0). "
2856 warnings.warn("_complete is a provisional API (as of IPython 6.0). "
2857 "It may change without warnings. "
2857 "It may change without warnings. "
2858 "Use in corresponding context manager.",
2858 "Use in corresponding context manager.",
2859 category=ProvisionalCompleterWarning, stacklevel=2)
2859 category=ProvisionalCompleterWarning, stacklevel=2)
2860
2860
2861 seen = set()
2861 seen = set()
2862 profiler:Optional[cProfile.Profile]
2862 profiler:Optional[cProfile.Profile]
2863 try:
2863 try:
2864 if self.profile_completions:
2864 if self.profile_completions:
2865 import cProfile
2865 import cProfile
2866 profiler = cProfile.Profile()
2866 profiler = cProfile.Profile()
2867 profiler.enable()
2867 profiler.enable()
2868 else:
2868 else:
2869 profiler = None
2869 profiler = None
2870
2870
2871 for c in self._completions(text, offset, _timeout=self.jedi_compute_type_timeout/1000):
2871 for c in self._completions(text, offset, _timeout=self.jedi_compute_type_timeout/1000):
2872 if c and (c in seen):
2872 if c and (c in seen):
2873 continue
2873 continue
2874 yield c
2874 yield c
2875 seen.add(c)
2875 seen.add(c)
2876 except KeyboardInterrupt:
2876 except KeyboardInterrupt:
2877 """if completions take too long and users send keyboard interrupt,
2877 """if completions take too long and users send keyboard interrupt,
2878 do not crash and return ASAP. """
2878 do not crash and return ASAP. """
2879 pass
2879 pass
2880 finally:
2880 finally:
2881 if profiler is not None:
2881 if profiler is not None:
2882 profiler.disable()
2882 profiler.disable()
2883 ensure_dir_exists(self.profiler_output_dir)
2883 ensure_dir_exists(self.profiler_output_dir)
2884 output_path = os.path.join(self.profiler_output_dir, str(uuid.uuid4()))
2884 output_path = os.path.join(self.profiler_output_dir, str(uuid.uuid4()))
2885 print("Writing profiler output to", output_path)
2885 print("Writing profiler output to", output_path)
2886 profiler.dump_stats(output_path)
2886 profiler.dump_stats(output_path)
2887
2887
2888 def _completions(self, full_text: str, offset: int, *, _timeout) -> Iterator[Completion]:
2888 def _completions(self, full_text: str, offset: int, *, _timeout) -> Iterator[Completion]:
2889 """
2889 """
2890 Core completion module.Same signature as :any:`completions`, with the
2890 Core completion module.Same signature as :any:`completions`, with the
2891 extra `timeout` parameter (in seconds).
2891 extra `timeout` parameter (in seconds).
2892
2892
2893 Computing jedi's completion ``.type`` can be quite expensive (it is a
2893 Computing jedi's completion ``.type`` can be quite expensive (it is a
2894 lazy property) and can require some warm-up, more warm up than just
2894 lazy property) and can require some warm-up, more warm up than just
2895 computing the ``name`` of a completion. The warm-up can be :
2895 computing the ``name`` of a completion. The warm-up can be :
2896
2896
2897 - Long warm-up the first time a module is encountered after
2897 - Long warm-up the first time a module is encountered after
2898 install/update: actually build parse/inference tree.
2898 install/update: actually build parse/inference tree.
2899
2899
2900 - first time the module is encountered in a session: load tree from
2900 - first time the module is encountered in a session: load tree from
2901 disk.
2901 disk.
2902
2902
2903 We don't want to block completions for tens of seconds so we give the
2903 We don't want to block completions for tens of seconds so we give the
2904 completer a "budget" of ``_timeout`` seconds per invocation to compute
2904 completer a "budget" of ``_timeout`` seconds per invocation to compute
2905 completions types, the completions that have not yet been computed will
2905 completions types, the completions that have not yet been computed will
2906 be marked as "unknown" an will have a chance to be computed next round
2906 be marked as "unknown" an will have a chance to be computed next round
2907 are things get cached.
2907 are things get cached.
2908
2908
2909 Keep in mind that Jedi is not the only thing treating the completion so
2909 Keep in mind that Jedi is not the only thing treating the completion so
2910 keep the timeout short-ish as if we take more than 0.3 second we still
2910 keep the timeout short-ish as if we take more than 0.3 second we still
2911 have lots of processing to do.
2911 have lots of processing to do.
2912
2912
2913 """
2913 """
2914 deadline = time.monotonic() + _timeout
2914 deadline = time.monotonic() + _timeout
2915
2915
2916 before = full_text[:offset]
2916 before = full_text[:offset]
2917 cursor_line, cursor_column = position_to_cursor(full_text, offset)
2917 cursor_line, cursor_column = position_to_cursor(full_text, offset)
2918
2918
2919 jedi_matcher_id = _get_matcher_id(self._jedi_matcher)
2919 jedi_matcher_id = _get_matcher_id(self._jedi_matcher)
2920
2920
2921 def is_non_jedi_result(
2921 def is_non_jedi_result(
2922 result: MatcherResult, identifier: str
2922 result: MatcherResult, identifier: str
2923 ) -> TypeGuard[SimpleMatcherResult]:
2923 ) -> TypeGuard[SimpleMatcherResult]:
2924 return identifier != jedi_matcher_id
2924 return identifier != jedi_matcher_id
2925
2925
2926 results = self._complete(
2926 results = self._complete(
2927 full_text=full_text, cursor_line=cursor_line, cursor_pos=cursor_column
2927 full_text=full_text, cursor_line=cursor_line, cursor_pos=cursor_column
2928 )
2928 )
2929
2929
2930 non_jedi_results: Dict[str, SimpleMatcherResult] = {
2930 non_jedi_results: Dict[str, SimpleMatcherResult] = {
2931 identifier: result
2931 identifier: result
2932 for identifier, result in results.items()
2932 for identifier, result in results.items()
2933 if is_non_jedi_result(result, identifier)
2933 if is_non_jedi_result(result, identifier)
2934 }
2934 }
2935
2935
2936 jedi_matches = (
2936 jedi_matches = (
2937 cast(_JediMatcherResult, results[jedi_matcher_id])["completions"]
2937 cast(_JediMatcherResult, results[jedi_matcher_id])["completions"]
2938 if jedi_matcher_id in results
2938 if jedi_matcher_id in results
2939 else ()
2939 else ()
2940 )
2940 )
2941
2941
2942 iter_jm = iter(jedi_matches)
2942 iter_jm = iter(jedi_matches)
2943 if _timeout:
2943 if _timeout:
2944 for jm in iter_jm:
2944 for jm in iter_jm:
2945 try:
2945 try:
2946 type_ = jm.type
2946 type_ = jm.type
2947 except Exception:
2947 except Exception:
2948 if self.debug:
2948 if self.debug:
2949 print("Error in Jedi getting type of ", jm)
2949 print("Error in Jedi getting type of ", jm)
2950 type_ = None
2950 type_ = None
2951 delta = len(jm.name_with_symbols) - len(jm.complete)
2951 delta = len(jm.name_with_symbols) - len(jm.complete)
2952 if type_ == 'function':
2952 if type_ == 'function':
2953 signature = _make_signature(jm)
2953 signature = _make_signature(jm)
2954 else:
2954 else:
2955 signature = ''
2955 signature = ''
2956 yield Completion(start=offset - delta,
2956 yield Completion(start=offset - delta,
2957 end=offset,
2957 end=offset,
2958 text=jm.name_with_symbols,
2958 text=jm.name_with_symbols,
2959 type=type_,
2959 type=type_,
2960 signature=signature,
2960 signature=signature,
2961 _origin='jedi')
2961 _origin='jedi')
2962
2962
2963 if time.monotonic() > deadline:
2963 if time.monotonic() > deadline:
2964 break
2964 break
2965
2965
2966 for jm in iter_jm:
2966 for jm in iter_jm:
2967 delta = len(jm.name_with_symbols) - len(jm.complete)
2967 delta = len(jm.name_with_symbols) - len(jm.complete)
2968 yield Completion(
2968 yield Completion(
2969 start=offset - delta,
2969 start=offset - delta,
2970 end=offset,
2970 end=offset,
2971 text=jm.name_with_symbols,
2971 text=jm.name_with_symbols,
2972 type=_UNKNOWN_TYPE, # don't compute type for speed
2972 type=_UNKNOWN_TYPE, # don't compute type for speed
2973 _origin="jedi",
2973 _origin="jedi",
2974 signature="",
2974 signature="",
2975 )
2975 )
2976
2976
2977 # TODO:
2977 # TODO:
2978 # Suppress this, right now just for debug.
2978 # Suppress this, right now just for debug.
2979 if jedi_matches and non_jedi_results and self.debug:
2979 if jedi_matches and non_jedi_results and self.debug:
2980 some_start_offset = before.rfind(
2980 some_start_offset = before.rfind(
2981 next(iter(non_jedi_results.values()))["matched_fragment"]
2981 next(iter(non_jedi_results.values()))["matched_fragment"]
2982 )
2982 )
2983 yield Completion(
2983 yield Completion(
2984 start=some_start_offset,
2984 start=some_start_offset,
2985 end=offset,
2985 end=offset,
2986 text="--jedi/ipython--",
2986 text="--jedi/ipython--",
2987 _origin="debug",
2987 _origin="debug",
2988 type="none",
2988 type="none",
2989 signature="",
2989 signature="",
2990 )
2990 )
2991
2991
2992 ordered: List[Completion] = []
2992 ordered: List[Completion] = []
2993 sortable: List[Completion] = []
2993 sortable: List[Completion] = []
2994
2994
2995 for origin, result in non_jedi_results.items():
2995 for origin, result in non_jedi_results.items():
2996 matched_text = result["matched_fragment"]
2996 matched_text = result["matched_fragment"]
2997 start_offset = before.rfind(matched_text)
2997 start_offset = before.rfind(matched_text)
2998 is_ordered = result.get("ordered", False)
2998 is_ordered = result.get("ordered", False)
2999 container = ordered if is_ordered else sortable
2999 container = ordered if is_ordered else sortable
3000
3000
3001 # I'm unsure if this is always true, so let's assert and see if it
3001 # I'm unsure if this is always true, so let's assert and see if it
3002 # crash
3002 # crash
3003 assert before.endswith(matched_text)
3003 assert before.endswith(matched_text)
3004
3004
3005 for simple_completion in result["completions"]:
3005 for simple_completion in result["completions"]:
3006 completion = Completion(
3006 completion = Completion(
3007 start=start_offset,
3007 start=start_offset,
3008 end=offset,
3008 end=offset,
3009 text=simple_completion.text,
3009 text=simple_completion.text,
3010 _origin=origin,
3010 _origin=origin,
3011 signature="",
3011 signature="",
3012 type=simple_completion.type or _UNKNOWN_TYPE,
3012 type=simple_completion.type or _UNKNOWN_TYPE,
3013 )
3013 )
3014 container.append(completion)
3014 container.append(completion)
3015
3015
3016 yield from list(self._deduplicate(ordered + self._sort(sortable)))[
3016 yield from list(self._deduplicate(ordered + self._sort(sortable)))[
3017 :MATCHES_LIMIT
3017 :MATCHES_LIMIT
3018 ]
3018 ]
3019
3019
3020 def complete(self, text=None, line_buffer=None, cursor_pos=None) -> Tuple[str, Sequence[str]]:
3020 def complete(self, text=None, line_buffer=None, cursor_pos=None) -> Tuple[str, Sequence[str]]:
3021 """Find completions for the given text and line context.
3021 """Find completions for the given text and line context.
3022
3022
3023 Note that both the text and the line_buffer are optional, but at least
3023 Note that both the text and the line_buffer are optional, but at least
3024 one of them must be given.
3024 one of them must be given.
3025
3025
3026 Parameters
3026 Parameters
3027 ----------
3027 ----------
3028 text : string, optional
3028 text : string, optional
3029 Text to perform the completion on. If not given, the line buffer
3029 Text to perform the completion on. If not given, the line buffer
3030 is split using the instance's CompletionSplitter object.
3030 is split using the instance's CompletionSplitter object.
3031 line_buffer : string, optional
3031 line_buffer : string, optional
3032 If not given, the completer attempts to obtain the current line
3032 If not given, the completer attempts to obtain the current line
3033 buffer via readline. This keyword allows clients which are
3033 buffer via readline. This keyword allows clients which are
3034 requesting for text completions in non-readline contexts to inform
3034 requesting for text completions in non-readline contexts to inform
3035 the completer of the entire text.
3035 the completer of the entire text.
3036 cursor_pos : int, optional
3036 cursor_pos : int, optional
3037 Index of the cursor in the full line buffer. Should be provided by
3037 Index of the cursor in the full line buffer. Should be provided by
3038 remote frontends where kernel has no access to frontend state.
3038 remote frontends where kernel has no access to frontend state.
3039
3039
3040 Returns
3040 Returns
3041 -------
3041 -------
3042 Tuple of two items:
3042 Tuple of two items:
3043 text : str
3043 text : str
3044 Text that was actually used in the completion.
3044 Text that was actually used in the completion.
3045 matches : list
3045 matches : list
3046 A list of completion matches.
3046 A list of completion matches.
3047
3047
3048 Notes
3048 Notes
3049 -----
3049 -----
3050 This API is likely to be deprecated and replaced by
3050 This API is likely to be deprecated and replaced by
3051 :any:`IPCompleter.completions` in the future.
3051 :any:`IPCompleter.completions` in the future.
3052
3052
3053 """
3053 """
3054 warnings.warn('`Completer.complete` is pending deprecation since '
3054 warnings.warn('`Completer.complete` is pending deprecation since '
3055 'IPython 6.0 and will be replaced by `Completer.completions`.',
3055 'IPython 6.0 and will be replaced by `Completer.completions`.',
3056 PendingDeprecationWarning)
3056 PendingDeprecationWarning)
3057 # potential todo, FOLD the 3rd throw away argument of _complete
3057 # potential todo, FOLD the 3rd throw away argument of _complete
3058 # into the first 2 one.
3058 # into the first 2 one.
3059 # TODO: Q: does the above refer to jedi completions (i.e. 0-indexed?)
3059 # TODO: Q: does the above refer to jedi completions (i.e. 0-indexed?)
3060 # TODO: should we deprecate now, or does it stay?
3060 # TODO: should we deprecate now, or does it stay?
3061
3061
3062 results = self._complete(
3062 results = self._complete(
3063 line_buffer=line_buffer, cursor_pos=cursor_pos, text=text, cursor_line=0
3063 line_buffer=line_buffer, cursor_pos=cursor_pos, text=text, cursor_line=0
3064 )
3064 )
3065
3065
3066 jedi_matcher_id = _get_matcher_id(self._jedi_matcher)
3066 jedi_matcher_id = _get_matcher_id(self._jedi_matcher)
3067
3067
3068 return self._arrange_and_extract(
3068 return self._arrange_and_extract(
3069 results,
3069 results,
3070 # TODO: can we confirm that excluding Jedi here was a deliberate choice in previous version?
3070 # TODO: can we confirm that excluding Jedi here was a deliberate choice in previous version?
3071 skip_matchers={jedi_matcher_id},
3071 skip_matchers={jedi_matcher_id},
3072 # this API does not support different start/end positions (fragments of token).
3072 # this API does not support different start/end positions (fragments of token).
3073 abort_if_offset_changes=True,
3073 abort_if_offset_changes=True,
3074 )
3074 )
3075
3075
3076 def _arrange_and_extract(
3076 def _arrange_and_extract(
3077 self,
3077 self,
3078 results: Dict[str, MatcherResult],
3078 results: Dict[str, MatcherResult],
3079 skip_matchers: Set[str],
3079 skip_matchers: Set[str],
3080 abort_if_offset_changes: bool,
3080 abort_if_offset_changes: bool,
3081 ):
3081 ):
3082 sortable: List[AnyMatcherCompletion] = []
3082 sortable: List[AnyMatcherCompletion] = []
3083 ordered: List[AnyMatcherCompletion] = []
3083 ordered: List[AnyMatcherCompletion] = []
3084 most_recent_fragment = None
3084 most_recent_fragment = None
3085 for identifier, result in results.items():
3085 for identifier, result in results.items():
3086 if identifier in skip_matchers:
3086 if identifier in skip_matchers:
3087 continue
3087 continue
3088 if not result["completions"]:
3088 if not result["completions"]:
3089 continue
3089 continue
3090 if not most_recent_fragment:
3090 if not most_recent_fragment:
3091 most_recent_fragment = result["matched_fragment"]
3091 most_recent_fragment = result["matched_fragment"]
3092 if (
3092 if (
3093 abort_if_offset_changes
3093 abort_if_offset_changes
3094 and result["matched_fragment"] != most_recent_fragment
3094 and result["matched_fragment"] != most_recent_fragment
3095 ):
3095 ):
3096 break
3096 break
3097 if result.get("ordered", False):
3097 if result.get("ordered", False):
3098 ordered.extend(result["completions"])
3098 ordered.extend(result["completions"])
3099 else:
3099 else:
3100 sortable.extend(result["completions"])
3100 sortable.extend(result["completions"])
3101
3101
3102 if not most_recent_fragment:
3102 if not most_recent_fragment:
3103 most_recent_fragment = "" # to satisfy typechecker (and just in case)
3103 most_recent_fragment = "" # to satisfy typechecker (and just in case)
3104
3104
3105 return most_recent_fragment, [
3105 return most_recent_fragment, [
3106 m.text for m in self._deduplicate(ordered + self._sort(sortable))
3106 m.text for m in self._deduplicate(ordered + self._sort(sortable))
3107 ]
3107 ]
3108
3108
3109 def _complete(self, *, cursor_line, cursor_pos, line_buffer=None, text=None,
3109 def _complete(self, *, cursor_line, cursor_pos, line_buffer=None, text=None,
3110 full_text=None) -> _CompleteResult:
3110 full_text=None) -> _CompleteResult:
3111 """
3111 """
3112 Like complete but can also returns raw jedi completions as well as the
3112 Like complete but can also returns raw jedi completions as well as the
3113 origin of the completion text. This could (and should) be made much
3113 origin of the completion text. This could (and should) be made much
3114 cleaner but that will be simpler once we drop the old (and stateful)
3114 cleaner but that will be simpler once we drop the old (and stateful)
3115 :any:`complete` API.
3115 :any:`complete` API.
3116
3116
3117 With current provisional API, cursor_pos act both (depending on the
3117 With current provisional API, cursor_pos act both (depending on the
3118 caller) as the offset in the ``text`` or ``line_buffer``, or as the
3118 caller) as the offset in the ``text`` or ``line_buffer``, or as the
3119 ``column`` when passing multiline strings this could/should be renamed
3119 ``column`` when passing multiline strings this could/should be renamed
3120 but would add extra noise.
3120 but would add extra noise.
3121
3121
3122 Parameters
3122 Parameters
3123 ----------
3123 ----------
3124 cursor_line
3124 cursor_line
3125 Index of the line the cursor is on. 0 indexed.
3125 Index of the line the cursor is on. 0 indexed.
3126 cursor_pos
3126 cursor_pos
3127 Position of the cursor in the current line/line_buffer/text. 0
3127 Position of the cursor in the current line/line_buffer/text. 0
3128 indexed.
3128 indexed.
3129 line_buffer : optional, str
3129 line_buffer : optional, str
3130 The current line the cursor is in, this is mostly due to legacy
3130 The current line the cursor is in, this is mostly due to legacy
3131 reason that readline could only give a us the single current line.
3131 reason that readline could only give a us the single current line.
3132 Prefer `full_text`.
3132 Prefer `full_text`.
3133 text : str
3133 text : str
3134 The current "token" the cursor is in, mostly also for historical
3134 The current "token" the cursor is in, mostly also for historical
3135 reasons. as the completer would trigger only after the current line
3135 reasons. as the completer would trigger only after the current line
3136 was parsed.
3136 was parsed.
3137 full_text : str
3137 full_text : str
3138 Full text of the current cell.
3138 Full text of the current cell.
3139
3139
3140 Returns
3140 Returns
3141 -------
3141 -------
3142 An ordered dictionary where keys are identifiers of completion
3142 An ordered dictionary where keys are identifiers of completion
3143 matchers and values are ``MatcherResult``s.
3143 matchers and values are ``MatcherResult``s.
3144 """
3144 """
3145
3145
3146 # if the cursor position isn't given, the only sane assumption we can
3146 # if the cursor position isn't given, the only sane assumption we can
3147 # make is that it's at the end of the line (the common case)
3147 # make is that it's at the end of the line (the common case)
3148 if cursor_pos is None:
3148 if cursor_pos is None:
3149 cursor_pos = len(line_buffer) if text is None else len(text)
3149 cursor_pos = len(line_buffer) if text is None else len(text)
3150
3150
3151 if self.use_main_ns:
3151 if self.use_main_ns:
3152 self.namespace = __main__.__dict__
3152 self.namespace = __main__.__dict__
3153
3153
3154 # if text is either None or an empty string, rely on the line buffer
3154 # if text is either None or an empty string, rely on the line buffer
3155 if (not line_buffer) and full_text:
3155 if (not line_buffer) and full_text:
3156 line_buffer = full_text.split('\n')[cursor_line]
3156 line_buffer = full_text.split('\n')[cursor_line]
3157 if not text: # issue #11508: check line_buffer before calling split_line
3157 if not text: # issue #11508: check line_buffer before calling split_line
3158 text = (
3158 text = (
3159 self.splitter.split_line(line_buffer, cursor_pos) if line_buffer else ""
3159 self.splitter.split_line(line_buffer, cursor_pos) if line_buffer else ""
3160 )
3160 )
3161
3161
3162 # If no line buffer is given, assume the input text is all there was
3162 # If no line buffer is given, assume the input text is all there was
3163 if line_buffer is None:
3163 if line_buffer is None:
3164 line_buffer = text
3164 line_buffer = text
3165
3165
3166 # deprecated - do not use `line_buffer` in new code.
3166 # deprecated - do not use `line_buffer` in new code.
3167 self.line_buffer = line_buffer
3167 self.line_buffer = line_buffer
3168 self.text_until_cursor = self.line_buffer[:cursor_pos]
3168 self.text_until_cursor = self.line_buffer[:cursor_pos]
3169
3169
3170 if not full_text:
3170 if not full_text:
3171 full_text = line_buffer
3171 full_text = line_buffer
3172
3172
3173 context = CompletionContext(
3173 context = CompletionContext(
3174 full_text=full_text,
3174 full_text=full_text,
3175 cursor_position=cursor_pos,
3175 cursor_position=cursor_pos,
3176 cursor_line=cursor_line,
3176 cursor_line=cursor_line,
3177 token=text,
3177 token=text,
3178 limit=MATCHES_LIMIT,
3178 limit=MATCHES_LIMIT,
3179 )
3179 )
3180
3180
3181 # Start with a clean slate of completions
3181 # Start with a clean slate of completions
3182 results: Dict[str, MatcherResult] = {}
3182 results: Dict[str, MatcherResult] = {}
3183
3183
3184 jedi_matcher_id = _get_matcher_id(self._jedi_matcher)
3184 jedi_matcher_id = _get_matcher_id(self._jedi_matcher)
3185
3185
3186 suppressed_matchers: Set[str] = set()
3186 suppressed_matchers: Set[str] = set()
3187
3187
3188 matchers = {
3188 matchers = {
3189 _get_matcher_id(matcher): matcher
3189 _get_matcher_id(matcher): matcher
3190 for matcher in sorted(
3190 for matcher in sorted(
3191 self.matchers, key=_get_matcher_priority, reverse=True
3191 self.matchers, key=_get_matcher_priority, reverse=True
3192 )
3192 )
3193 }
3193 }
3194
3194
3195 for matcher_id, matcher in matchers.items():
3195 for matcher_id, matcher in matchers.items():
3196 matcher_id = _get_matcher_id(matcher)
3196 matcher_id = _get_matcher_id(matcher)
3197
3197
3198 if matcher_id in self.disable_matchers:
3198 if matcher_id in self.disable_matchers:
3199 continue
3199 continue
3200
3200
3201 if matcher_id in results:
3201 if matcher_id in results:
3202 warnings.warn(f"Duplicate matcher ID: {matcher_id}.")
3202 warnings.warn(f"Duplicate matcher ID: {matcher_id}.")
3203
3203
3204 if matcher_id in suppressed_matchers:
3204 if matcher_id in suppressed_matchers:
3205 continue
3205 continue
3206
3206
3207 result: MatcherResult
3207 result: MatcherResult
3208 try:
3208 try:
3209 if _is_matcher_v1(matcher):
3209 if _is_matcher_v1(matcher):
3210 result = _convert_matcher_v1_result_to_v2(
3210 result = _convert_matcher_v1_result_to_v2(
3211 matcher(text), type=_UNKNOWN_TYPE
3211 matcher(text), type=_UNKNOWN_TYPE
3212 )
3212 )
3213 elif _is_matcher_v2(matcher):
3213 elif _is_matcher_v2(matcher):
3214 result = matcher(context)
3214 result = matcher(context)
3215 else:
3215 else:
3216 api_version = _get_matcher_api_version(matcher)
3216 api_version = _get_matcher_api_version(matcher)
3217 raise ValueError(f"Unsupported API version {api_version}")
3217 raise ValueError(f"Unsupported API version {api_version}")
3218 except:
3218 except:
3219 # Show the ugly traceback if the matcher causes an
3219 # Show the ugly traceback if the matcher causes an
3220 # exception, but do NOT crash the kernel!
3220 # exception, but do NOT crash the kernel!
3221 sys.excepthook(*sys.exc_info())
3221 sys.excepthook(*sys.exc_info())
3222 continue
3222 continue
3223
3223
3224 # set default value for matched fragment if suffix was not selected.
3224 # set default value for matched fragment if suffix was not selected.
3225 result["matched_fragment"] = result.get("matched_fragment", context.token)
3225 result["matched_fragment"] = result.get("matched_fragment", context.token)
3226
3226
3227 if not suppressed_matchers:
3227 if not suppressed_matchers:
3228 suppression_recommended: Union[bool, Set[str]] = result.get(
3228 suppression_recommended: Union[bool, Set[str]] = result.get(
3229 "suppress", False
3229 "suppress", False
3230 )
3230 )
3231
3231
3232 suppression_config = (
3232 suppression_config = (
3233 self.suppress_competing_matchers.get(matcher_id, None)
3233 self.suppress_competing_matchers.get(matcher_id, None)
3234 if isinstance(self.suppress_competing_matchers, dict)
3234 if isinstance(self.suppress_competing_matchers, dict)
3235 else self.suppress_competing_matchers
3235 else self.suppress_competing_matchers
3236 )
3236 )
3237 should_suppress = (
3237 should_suppress = (
3238 (suppression_config is True)
3238 (suppression_config is True)
3239 or (suppression_recommended and (suppression_config is not False))
3239 or (suppression_recommended and (suppression_config is not False))
3240 ) and has_any_completions(result)
3240 ) and has_any_completions(result)
3241
3241
3242 if should_suppress:
3242 if should_suppress:
3243 suppression_exceptions: Set[str] = result.get(
3243 suppression_exceptions: Set[str] = result.get(
3244 "do_not_suppress", set()
3244 "do_not_suppress", set()
3245 )
3245 )
3246 if isinstance(suppression_recommended, Iterable):
3246 if isinstance(suppression_recommended, Iterable):
3247 to_suppress = set(suppression_recommended)
3247 to_suppress = set(suppression_recommended)
3248 else:
3248 else:
3249 to_suppress = set(matchers)
3249 to_suppress = set(matchers)
3250 suppressed_matchers = to_suppress - suppression_exceptions
3250 suppressed_matchers = to_suppress - suppression_exceptions
3251
3251
3252 new_results = {}
3252 new_results = {}
3253 for previous_matcher_id, previous_result in results.items():
3253 for previous_matcher_id, previous_result in results.items():
3254 if previous_matcher_id not in suppressed_matchers:
3254 if previous_matcher_id not in suppressed_matchers:
3255 new_results[previous_matcher_id] = previous_result
3255 new_results[previous_matcher_id] = previous_result
3256 results = new_results
3256 results = new_results
3257
3257
3258 results[matcher_id] = result
3258 results[matcher_id] = result
3259
3259
3260 _, matches = self._arrange_and_extract(
3260 _, matches = self._arrange_and_extract(
3261 results,
3261 results,
3262 # TODO Jedi completions non included in legacy stateful API; was this deliberate or omission?
3262 # TODO Jedi completions non included in legacy stateful API; was this deliberate or omission?
3263 # if it was omission, we can remove the filtering step, otherwise remove this comment.
3263 # if it was omission, we can remove the filtering step, otherwise remove this comment.
3264 skip_matchers={jedi_matcher_id},
3264 skip_matchers={jedi_matcher_id},
3265 abort_if_offset_changes=False,
3265 abort_if_offset_changes=False,
3266 )
3266 )
3267
3267
3268 # populate legacy stateful API
3268 # populate legacy stateful API
3269 self.matches = matches
3269 self.matches = matches
3270
3270
3271 return results
3271 return results
3272
3272
3273 @staticmethod
3273 @staticmethod
3274 def _deduplicate(
3274 def _deduplicate(
3275 matches: Sequence[AnyCompletion],
3275 matches: Sequence[AnyCompletion],
3276 ) -> Iterable[AnyCompletion]:
3276 ) -> Iterable[AnyCompletion]:
3277 filtered_matches: Dict[str, AnyCompletion] = {}
3277 filtered_matches: Dict[str, AnyCompletion] = {}
3278 for match in matches:
3278 for match in matches:
3279 text = match.text
3279 text = match.text
3280 if (
3280 if (
3281 text not in filtered_matches
3281 text not in filtered_matches
3282 or filtered_matches[text].type == _UNKNOWN_TYPE
3282 or filtered_matches[text].type == _UNKNOWN_TYPE
3283 ):
3283 ):
3284 filtered_matches[text] = match
3284 filtered_matches[text] = match
3285
3285
3286 return filtered_matches.values()
3286 return filtered_matches.values()
3287
3287
3288 @staticmethod
3288 @staticmethod
3289 def _sort(matches: Sequence[AnyCompletion]):
3289 def _sort(matches: Sequence[AnyCompletion]):
3290 return sorted(matches, key=lambda x: completions_sorting_key(x.text))
3290 return sorted(matches, key=lambda x: completions_sorting_key(x.text))
3291
3291
3292 @context_matcher()
3292 @context_matcher()
3293 def fwd_unicode_matcher(self, context: CompletionContext):
3293 def fwd_unicode_matcher(self, context: CompletionContext):
3294 """Same as :any:`fwd_unicode_match`, but adopted to new Matcher API."""
3294 """Same as :any:`fwd_unicode_match`, but adopted to new Matcher API."""
3295 # TODO: use `context.limit` to terminate early once we matched the maximum
3295 # TODO: use `context.limit` to terminate early once we matched the maximum
3296 # number that will be used downstream; can be added as an optional to
3296 # number that will be used downstream; can be added as an optional to
3297 # `fwd_unicode_match(text: str, limit: int = None)` or we could re-implement here.
3297 # `fwd_unicode_match(text: str, limit: int = None)` or we could re-implement here.
3298 fragment, matches = self.fwd_unicode_match(context.text_until_cursor)
3298 fragment, matches = self.fwd_unicode_match(context.text_until_cursor)
3299 return _convert_matcher_v1_result_to_v2(
3299 return _convert_matcher_v1_result_to_v2(
3300 matches, type="unicode", fragment=fragment, suppress_if_matches=True
3300 matches, type="unicode", fragment=fragment, suppress_if_matches=True
3301 )
3301 )
3302
3302
3303 def fwd_unicode_match(self, text: str) -> Tuple[str, Sequence[str]]:
3303 def fwd_unicode_match(self, text: str) -> Tuple[str, Sequence[str]]:
3304 """
3304 """
3305 Forward match a string starting with a backslash with a list of
3305 Forward match a string starting with a backslash with a list of
3306 potential Unicode completions.
3306 potential Unicode completions.
3307
3307
3308 Will compute list of Unicode character names on first call and cache it.
3308 Will compute list of Unicode character names on first call and cache it.
3309
3309
3310 .. deprecated:: 8.6
3310 .. deprecated:: 8.6
3311 You can use :meth:`fwd_unicode_matcher` instead.
3311 You can use :meth:`fwd_unicode_matcher` instead.
3312
3312
3313 Returns
3313 Returns
3314 -------
3314 -------
3315 At tuple with:
3315 At tuple with:
3316 - matched text (empty if no matches)
3316 - matched text (empty if no matches)
3317 - list of potential completions, empty tuple otherwise)
3317 - list of potential completions, empty tuple otherwise)
3318 """
3318 """
3319 # TODO: self.unicode_names is here a list we traverse each time with ~100k elements.
3319 # TODO: self.unicode_names is here a list we traverse each time with ~100k elements.
3320 # We could do a faster match using a Trie.
3320 # We could do a faster match using a Trie.
3321
3321
3322 # Using pygtrie the following seem to work:
3322 # Using pygtrie the following seem to work:
3323
3323
3324 # s = PrefixSet()
3324 # s = PrefixSet()
3325
3325
3326 # for c in range(0,0x10FFFF + 1):
3326 # for c in range(0,0x10FFFF + 1):
3327 # try:
3327 # try:
3328 # s.add(unicodedata.name(chr(c)))
3328 # s.add(unicodedata.name(chr(c)))
3329 # except ValueError:
3329 # except ValueError:
3330 # pass
3330 # pass
3331 # [''.join(k) for k in s.iter(prefix)]
3331 # [''.join(k) for k in s.iter(prefix)]
3332
3332
3333 # But need to be timed and adds an extra dependency.
3333 # But need to be timed and adds an extra dependency.
3334
3334
3335 slashpos = text.rfind('\\')
3335 slashpos = text.rfind('\\')
3336 # if text starts with slash
3336 # if text starts with slash
3337 if slashpos > -1:
3337 if slashpos > -1:
3338 # PERF: It's important that we don't access self._unicode_names
3338 # PERF: It's important that we don't access self._unicode_names
3339 # until we're inside this if-block. _unicode_names is lazily
3339 # until we're inside this if-block. _unicode_names is lazily
3340 # initialized, and it takes a user-noticeable amount of time to
3340 # initialized, and it takes a user-noticeable amount of time to
3341 # initialize it, so we don't want to initialize it unless we're
3341 # initialize it, so we don't want to initialize it unless we're
3342 # actually going to use it.
3342 # actually going to use it.
3343 s = text[slashpos + 1 :]
3343 s = text[slashpos + 1 :]
3344 sup = s.upper()
3344 sup = s.upper()
3345 candidates = [x for x in self.unicode_names if x.startswith(sup)]
3345 candidates = [x for x in self.unicode_names if x.startswith(sup)]
3346 if candidates:
3346 if candidates:
3347 return s, candidates
3347 return s, candidates
3348 candidates = [x for x in self.unicode_names if sup in x]
3348 candidates = [x for x in self.unicode_names if sup in x]
3349 if candidates:
3349 if candidates:
3350 return s, candidates
3350 return s, candidates
3351 splitsup = sup.split(" ")
3351 splitsup = sup.split(" ")
3352 candidates = [
3352 candidates = [
3353 x for x in self.unicode_names if all(u in x for u in splitsup)
3353 x for x in self.unicode_names if all(u in x for u in splitsup)
3354 ]
3354 ]
3355 if candidates:
3355 if candidates:
3356 return s, candidates
3356 return s, candidates
3357
3357
3358 return "", ()
3358 return "", ()
3359
3359
3360 # if text does not start with slash
3360 # if text does not start with slash
3361 else:
3361 else:
3362 return '', ()
3362 return '', ()
3363
3363
3364 @property
3364 @property
3365 def unicode_names(self) -> List[str]:
3365 def unicode_names(self) -> List[str]:
3366 """List of names of unicode code points that can be completed.
3366 """List of names of unicode code points that can be completed.
3367
3367
3368 The list is lazily initialized on first access.
3368 The list is lazily initialized on first access.
3369 """
3369 """
3370 if self._unicode_names is None:
3370 if self._unicode_names is None:
3371 names = []
3371 names = []
3372 for c in range(0,0x10FFFF + 1):
3372 for c in range(0,0x10FFFF + 1):
3373 try:
3373 try:
3374 names.append(unicodedata.name(chr(c)))
3374 names.append(unicodedata.name(chr(c)))
3375 except ValueError:
3375 except ValueError:
3376 pass
3376 pass
3377 self._unicode_names = _unicode_name_compute(_UNICODE_RANGES)
3377 self._unicode_names = _unicode_name_compute(_UNICODE_RANGES)
3378
3378
3379 return self._unicode_names
3379 return self._unicode_names
3380
3380
3381 def _unicode_name_compute(ranges:List[Tuple[int,int]]) -> List[str]:
3381 def _unicode_name_compute(ranges:List[Tuple[int,int]]) -> List[str]:
3382 names = []
3382 names = []
3383 for start,stop in ranges:
3383 for start,stop in ranges:
3384 for c in range(start, stop) :
3384 for c in range(start, stop) :
3385 try:
3385 try:
3386 names.append(unicodedata.name(chr(c)))
3386 names.append(unicodedata.name(chr(c)))
3387 except ValueError:
3387 except ValueError:
3388 pass
3388 pass
3389 return names
3389 return names
@@ -1,898 +1,895
1 from inspect import isclass, signature, Signature
1 from inspect import isclass, signature, Signature
2 from typing import (
2 from typing import (
3 Annotated,
3 Annotated,
4 AnyStr,
4 AnyStr,
5 Callable,
5 Callable,
6 Dict,
6 Dict,
7 Literal,
7 Literal,
8 NamedTuple,
8 NamedTuple,
9 NewType,
9 NewType,
10 Optional,
10 Optional,
11 Protocol,
11 Protocol,
12 Set,
12 Set,
13 Sequence,
13 Sequence,
14 Tuple,
14 Tuple,
15 Type,
15 Type,
16 TypeGuard,
16 TypeGuard,
17 Union,
17 Union,
18 get_args,
18 get_args,
19 get_origin,
19 get_origin,
20 is_typeddict,
20 is_typeddict,
21 )
21 )
22 import ast
22 import ast
23 import builtins
23 import builtins
24 import collections
24 import collections
25 import operator
25 import operator
26 import sys
26 import sys
27 from functools import cached_property
27 from functools import cached_property
28 from dataclasses import dataclass, field
28 from dataclasses import dataclass, field
29 from types import MethodDescriptorType, ModuleType
29 from types import MethodDescriptorType, ModuleType
30
30
31 from IPython.utils.decorators import undoc
31 from IPython.utils.decorators import undoc
32
32
33
33
34 if sys.version_info < (3, 11):
34 if sys.version_info < (3, 11):
35 from typing_extensions import Self, LiteralString
35 from typing_extensions import Self, LiteralString
36 else:
36 else:
37 from typing import Self, LiteralString
37 from typing import Self, LiteralString
38
38
39 if sys.version_info < (3, 12):
39 if sys.version_info < (3, 12):
40 from typing_extensions import TypeAliasType
40 from typing_extensions import TypeAliasType
41 else:
41 else:
42 from typing import TypeAliasType
42 from typing import TypeAliasType
43
43
44
44
45 @undoc
45 @undoc
46 class HasGetItem(Protocol):
46 class HasGetItem(Protocol):
47 def __getitem__(self, key) -> None:
47 def __getitem__(self, key) -> None: ...
48 ...
49
48
50
49
51 @undoc
50 @undoc
52 class InstancesHaveGetItem(Protocol):
51 class InstancesHaveGetItem(Protocol):
53 def __call__(self, *args, **kwargs) -> HasGetItem:
52 def __call__(self, *args, **kwargs) -> HasGetItem: ...
54 ...
55
53
56
54
57 @undoc
55 @undoc
58 class HasGetAttr(Protocol):
56 class HasGetAttr(Protocol):
59 def __getattr__(self, key) -> None:
57 def __getattr__(self, key) -> None: ...
60 ...
61
58
62
59
63 @undoc
60 @undoc
64 class DoesNotHaveGetAttr(Protocol):
61 class DoesNotHaveGetAttr(Protocol):
65 pass
62 pass
66
63
67
64
68 # By default `__getattr__` is not explicitly implemented on most objects
65 # By default `__getattr__` is not explicitly implemented on most objects
69 MayHaveGetattr = Union[HasGetAttr, DoesNotHaveGetAttr]
66 MayHaveGetattr = Union[HasGetAttr, DoesNotHaveGetAttr]
70
67
71
68
72 def _unbind_method(func: Callable) -> Union[Callable, None]:
69 def _unbind_method(func: Callable) -> Union[Callable, None]:
73 """Get unbound method for given bound method.
70 """Get unbound method for given bound method.
74
71
75 Returns None if cannot get unbound method, or method is already unbound.
72 Returns None if cannot get unbound method, or method is already unbound.
76 """
73 """
77 owner = getattr(func, "__self__", None)
74 owner = getattr(func, "__self__", None)
78 owner_class = type(owner)
75 owner_class = type(owner)
79 name = getattr(func, "__name__", None)
76 name = getattr(func, "__name__", None)
80 instance_dict_overrides = getattr(owner, "__dict__", None)
77 instance_dict_overrides = getattr(owner, "__dict__", None)
81 if (
78 if (
82 owner is not None
79 owner is not None
83 and name
80 and name
84 and (
81 and (
85 not instance_dict_overrides
82 not instance_dict_overrides
86 or (instance_dict_overrides and name not in instance_dict_overrides)
83 or (instance_dict_overrides and name not in instance_dict_overrides)
87 )
84 )
88 ):
85 ):
89 return getattr(owner_class, name)
86 return getattr(owner_class, name)
90 return None
87 return None
91
88
92
89
93 @undoc
90 @undoc
94 @dataclass
91 @dataclass
95 class EvaluationPolicy:
92 class EvaluationPolicy:
96 """Definition of evaluation policy."""
93 """Definition of evaluation policy."""
97
94
98 allow_locals_access: bool = False
95 allow_locals_access: bool = False
99 allow_globals_access: bool = False
96 allow_globals_access: bool = False
100 allow_item_access: bool = False
97 allow_item_access: bool = False
101 allow_attr_access: bool = False
98 allow_attr_access: bool = False
102 allow_builtins_access: bool = False
99 allow_builtins_access: bool = False
103 allow_all_operations: bool = False
100 allow_all_operations: bool = False
104 allow_any_calls: bool = False
101 allow_any_calls: bool = False
105 allowed_calls: Set[Callable] = field(default_factory=set)
102 allowed_calls: Set[Callable] = field(default_factory=set)
106
103
107 def can_get_item(self, value, item):
104 def can_get_item(self, value, item):
108 return self.allow_item_access
105 return self.allow_item_access
109
106
110 def can_get_attr(self, value, attr):
107 def can_get_attr(self, value, attr):
111 return self.allow_attr_access
108 return self.allow_attr_access
112
109
113 def can_operate(self, dunders: Tuple[str, ...], a, b=None):
110 def can_operate(self, dunders: Tuple[str, ...], a, b=None):
114 if self.allow_all_operations:
111 if self.allow_all_operations:
115 return True
112 return True
116
113
117 def can_call(self, func):
114 def can_call(self, func):
118 if self.allow_any_calls:
115 if self.allow_any_calls:
119 return True
116 return True
120
117
121 if func in self.allowed_calls:
118 if func in self.allowed_calls:
122 return True
119 return True
123
120
124 owner_method = _unbind_method(func)
121 owner_method = _unbind_method(func)
125
122
126 if owner_method and owner_method in self.allowed_calls:
123 if owner_method and owner_method in self.allowed_calls:
127 return True
124 return True
128
125
129
126
130 def _get_external(module_name: str, access_path: Sequence[str]):
127 def _get_external(module_name: str, access_path: Sequence[str]):
131 """Get value from external module given a dotted access path.
128 """Get value from external module given a dotted access path.
132
129
133 Raises:
130 Raises:
134 * `KeyError` if module is removed not found, and
131 * `KeyError` if module is removed not found, and
135 * `AttributeError` if access path does not match an exported object
132 * `AttributeError` if access path does not match an exported object
136 """
133 """
137 member_type = sys.modules[module_name]
134 member_type = sys.modules[module_name]
138 for attr in access_path:
135 for attr in access_path:
139 member_type = getattr(member_type, attr)
136 member_type = getattr(member_type, attr)
140 return member_type
137 return member_type
141
138
142
139
143 def _has_original_dunder_external(
140 def _has_original_dunder_external(
144 value,
141 value,
145 module_name: str,
142 module_name: str,
146 access_path: Sequence[str],
143 access_path: Sequence[str],
147 method_name: str,
144 method_name: str,
148 ):
145 ):
149 if module_name not in sys.modules:
146 if module_name not in sys.modules:
150 # LBYLB as it is faster
147 # LBYLB as it is faster
151 return False
148 return False
152 try:
149 try:
153 member_type = _get_external(module_name, access_path)
150 member_type = _get_external(module_name, access_path)
154 value_type = type(value)
151 value_type = type(value)
155 if type(value) == member_type:
152 if type(value) == member_type:
156 return True
153 return True
157 if method_name == "__getattribute__":
154 if method_name == "__getattribute__":
158 # we have to short-circuit here due to an unresolved issue in
155 # we have to short-circuit here due to an unresolved issue in
159 # `isinstance` implementation: https://bugs.python.org/issue32683
156 # `isinstance` implementation: https://bugs.python.org/issue32683
160 return False
157 return False
161 if isinstance(value, member_type):
158 if isinstance(value, member_type):
162 method = getattr(value_type, method_name, None)
159 method = getattr(value_type, method_name, None)
163 member_method = getattr(member_type, method_name, None)
160 member_method = getattr(member_type, method_name, None)
164 if member_method == method:
161 if member_method == method:
165 return True
162 return True
166 except (AttributeError, KeyError):
163 except (AttributeError, KeyError):
167 return False
164 return False
168
165
169
166
170 def _has_original_dunder(
167 def _has_original_dunder(
171 value, allowed_types, allowed_methods, allowed_external, method_name
168 value, allowed_types, allowed_methods, allowed_external, method_name
172 ):
169 ):
173 # note: Python ignores `__getattr__`/`__getitem__` on instances,
170 # note: Python ignores `__getattr__`/`__getitem__` on instances,
174 # we only need to check at class level
171 # we only need to check at class level
175 value_type = type(value)
172 value_type = type(value)
176
173
177 # strict type check passes β†’ no need to check method
174 # strict type check passes β†’ no need to check method
178 if value_type in allowed_types:
175 if value_type in allowed_types:
179 return True
176 return True
180
177
181 method = getattr(value_type, method_name, None)
178 method = getattr(value_type, method_name, None)
182
179
183 if method is None:
180 if method is None:
184 return None
181 return None
185
182
186 if method in allowed_methods:
183 if method in allowed_methods:
187 return True
184 return True
188
185
189 for module_name, *access_path in allowed_external:
186 for module_name, *access_path in allowed_external:
190 if _has_original_dunder_external(value, module_name, access_path, method_name):
187 if _has_original_dunder_external(value, module_name, access_path, method_name):
191 return True
188 return True
192
189
193 return False
190 return False
194
191
195
192
196 @undoc
193 @undoc
197 @dataclass
194 @dataclass
198 class SelectivePolicy(EvaluationPolicy):
195 class SelectivePolicy(EvaluationPolicy):
199 allowed_getitem: Set[InstancesHaveGetItem] = field(default_factory=set)
196 allowed_getitem: Set[InstancesHaveGetItem] = field(default_factory=set)
200 allowed_getitem_external: Set[Tuple[str, ...]] = field(default_factory=set)
197 allowed_getitem_external: Set[Tuple[str, ...]] = field(default_factory=set)
201
198
202 allowed_getattr: Set[MayHaveGetattr] = field(default_factory=set)
199 allowed_getattr: Set[MayHaveGetattr] = field(default_factory=set)
203 allowed_getattr_external: Set[Tuple[str, ...]] = field(default_factory=set)
200 allowed_getattr_external: Set[Tuple[str, ...]] = field(default_factory=set)
204
201
205 allowed_operations: Set = field(default_factory=set)
202 allowed_operations: Set = field(default_factory=set)
206 allowed_operations_external: Set[Tuple[str, ...]] = field(default_factory=set)
203 allowed_operations_external: Set[Tuple[str, ...]] = field(default_factory=set)
207
204
208 _operation_methods_cache: Dict[str, Set[Callable]] = field(
205 _operation_methods_cache: Dict[str, Set[Callable]] = field(
209 default_factory=dict, init=False
206 default_factory=dict, init=False
210 )
207 )
211
208
212 def can_get_attr(self, value, attr):
209 def can_get_attr(self, value, attr):
213 has_original_attribute = _has_original_dunder(
210 has_original_attribute = _has_original_dunder(
214 value,
211 value,
215 allowed_types=self.allowed_getattr,
212 allowed_types=self.allowed_getattr,
216 allowed_methods=self._getattribute_methods,
213 allowed_methods=self._getattribute_methods,
217 allowed_external=self.allowed_getattr_external,
214 allowed_external=self.allowed_getattr_external,
218 method_name="__getattribute__",
215 method_name="__getattribute__",
219 )
216 )
220 has_original_attr = _has_original_dunder(
217 has_original_attr = _has_original_dunder(
221 value,
218 value,
222 allowed_types=self.allowed_getattr,
219 allowed_types=self.allowed_getattr,
223 allowed_methods=self._getattr_methods,
220 allowed_methods=self._getattr_methods,
224 allowed_external=self.allowed_getattr_external,
221 allowed_external=self.allowed_getattr_external,
225 method_name="__getattr__",
222 method_name="__getattr__",
226 )
223 )
227
224
228 accept = False
225 accept = False
229
226
230 # Many objects do not have `__getattr__`, this is fine.
227 # Many objects do not have `__getattr__`, this is fine.
231 if has_original_attr is None and has_original_attribute:
228 if has_original_attr is None and has_original_attribute:
232 accept = True
229 accept = True
233 else:
230 else:
234 # Accept objects without modifications to `__getattr__` and `__getattribute__`
231 # Accept objects without modifications to `__getattr__` and `__getattribute__`
235 accept = has_original_attr and has_original_attribute
232 accept = has_original_attr and has_original_attribute
236
233
237 if accept:
234 if accept:
238 # We still need to check for overridden properties.
235 # We still need to check for overridden properties.
239
236
240 value_class = type(value)
237 value_class = type(value)
241 if not hasattr(value_class, attr):
238 if not hasattr(value_class, attr):
242 return True
239 return True
243
240
244 class_attr_val = getattr(value_class, attr)
241 class_attr_val = getattr(value_class, attr)
245 is_property = isinstance(class_attr_val, property)
242 is_property = isinstance(class_attr_val, property)
246
243
247 if not is_property:
244 if not is_property:
248 return True
245 return True
249
246
250 # Properties in allowed types are ok (although we do not include any
247 # Properties in allowed types are ok (although we do not include any
251 # properties in our default allow list currently).
248 # properties in our default allow list currently).
252 if type(value) in self.allowed_getattr:
249 if type(value) in self.allowed_getattr:
253 return True # pragma: no cover
250 return True # pragma: no cover
254
251
255 # Properties in subclasses of allowed types may be ok if not changed
252 # Properties in subclasses of allowed types may be ok if not changed
256 for module_name, *access_path in self.allowed_getattr_external:
253 for module_name, *access_path in self.allowed_getattr_external:
257 try:
254 try:
258 external_class = _get_external(module_name, access_path)
255 external_class = _get_external(module_name, access_path)
259 external_class_attr_val = getattr(external_class, attr)
256 external_class_attr_val = getattr(external_class, attr)
260 except (KeyError, AttributeError):
257 except (KeyError, AttributeError):
261 return False # pragma: no cover
258 return False # pragma: no cover
262 return class_attr_val == external_class_attr_val
259 return class_attr_val == external_class_attr_val
263
260
264 return False
261 return False
265
262
266 def can_get_item(self, value, item):
263 def can_get_item(self, value, item):
267 """Allow accessing `__getiitem__` of allow-listed instances unless it was not modified."""
264 """Allow accessing `__getiitem__` of allow-listed instances unless it was not modified."""
268 return _has_original_dunder(
265 return _has_original_dunder(
269 value,
266 value,
270 allowed_types=self.allowed_getitem,
267 allowed_types=self.allowed_getitem,
271 allowed_methods=self._getitem_methods,
268 allowed_methods=self._getitem_methods,
272 allowed_external=self.allowed_getitem_external,
269 allowed_external=self.allowed_getitem_external,
273 method_name="__getitem__",
270 method_name="__getitem__",
274 )
271 )
275
272
276 def can_operate(self, dunders: Tuple[str, ...], a, b=None):
273 def can_operate(self, dunders: Tuple[str, ...], a, b=None):
277 objects = [a]
274 objects = [a]
278 if b is not None:
275 if b is not None:
279 objects.append(b)
276 objects.append(b)
280 return all(
277 return all(
281 [
278 [
282 _has_original_dunder(
279 _has_original_dunder(
283 obj,
280 obj,
284 allowed_types=self.allowed_operations,
281 allowed_types=self.allowed_operations,
285 allowed_methods=self._operator_dunder_methods(dunder),
282 allowed_methods=self._operator_dunder_methods(dunder),
286 allowed_external=self.allowed_operations_external,
283 allowed_external=self.allowed_operations_external,
287 method_name=dunder,
284 method_name=dunder,
288 )
285 )
289 for dunder in dunders
286 for dunder in dunders
290 for obj in objects
287 for obj in objects
291 ]
288 ]
292 )
289 )
293
290
294 def _operator_dunder_methods(self, dunder: str) -> Set[Callable]:
291 def _operator_dunder_methods(self, dunder: str) -> Set[Callable]:
295 if dunder not in self._operation_methods_cache:
292 if dunder not in self._operation_methods_cache:
296 self._operation_methods_cache[dunder] = self._safe_get_methods(
293 self._operation_methods_cache[dunder] = self._safe_get_methods(
297 self.allowed_operations, dunder
294 self.allowed_operations, dunder
298 )
295 )
299 return self._operation_methods_cache[dunder]
296 return self._operation_methods_cache[dunder]
300
297
301 @cached_property
298 @cached_property
302 def _getitem_methods(self) -> Set[Callable]:
299 def _getitem_methods(self) -> Set[Callable]:
303 return self._safe_get_methods(self.allowed_getitem, "__getitem__")
300 return self._safe_get_methods(self.allowed_getitem, "__getitem__")
304
301
305 @cached_property
302 @cached_property
306 def _getattr_methods(self) -> Set[Callable]:
303 def _getattr_methods(self) -> Set[Callable]:
307 return self._safe_get_methods(self.allowed_getattr, "__getattr__")
304 return self._safe_get_methods(self.allowed_getattr, "__getattr__")
308
305
309 @cached_property
306 @cached_property
310 def _getattribute_methods(self) -> Set[Callable]:
307 def _getattribute_methods(self) -> Set[Callable]:
311 return self._safe_get_methods(self.allowed_getattr, "__getattribute__")
308 return self._safe_get_methods(self.allowed_getattr, "__getattribute__")
312
309
313 def _safe_get_methods(self, classes, name) -> Set[Callable]:
310 def _safe_get_methods(self, classes, name) -> Set[Callable]:
314 return {
311 return {
315 method
312 method
316 for class_ in classes
313 for class_ in classes
317 for method in [getattr(class_, name, None)]
314 for method in [getattr(class_, name, None)]
318 if method
315 if method
319 }
316 }
320
317
321
318
322 class _DummyNamedTuple(NamedTuple):
319 class _DummyNamedTuple(NamedTuple):
323 """Used internally to retrieve methods of named tuple instance."""
320 """Used internally to retrieve methods of named tuple instance."""
324
321
325
322
326 class EvaluationContext(NamedTuple):
323 class EvaluationContext(NamedTuple):
327 #: Local namespace
324 #: Local namespace
328 locals: dict
325 locals: dict
329 #: Global namespace
326 #: Global namespace
330 globals: dict
327 globals: dict
331 #: Evaluation policy identifier
328 #: Evaluation policy identifier
332 evaluation: Literal[
329 evaluation: Literal["forbidden", "minimal", "limited", "unsafe", "dangerous"] = (
333 "forbidden", "minimal", "limited", "unsafe", "dangerous"
330 "forbidden"
334 ] = "forbidden"
331 )
335 #: Whether the evaluation of code takes place inside of a subscript.
332 #: Whether the evaluation of code takes place inside of a subscript.
336 #: Useful for evaluating ``:-1, 'col'`` in ``df[:-1, 'col']``.
333 #: Useful for evaluating ``:-1, 'col'`` in ``df[:-1, 'col']``.
337 in_subscript: bool = False
334 in_subscript: bool = False
338
335
339
336
340 class _IdentitySubscript:
337 class _IdentitySubscript:
341 """Returns the key itself when item is requested via subscript."""
338 """Returns the key itself when item is requested via subscript."""
342
339
343 def __getitem__(self, key):
340 def __getitem__(self, key):
344 return key
341 return key
345
342
346
343
347 IDENTITY_SUBSCRIPT = _IdentitySubscript()
344 IDENTITY_SUBSCRIPT = _IdentitySubscript()
348 SUBSCRIPT_MARKER = "__SUBSCRIPT_SENTINEL__"
345 SUBSCRIPT_MARKER = "__SUBSCRIPT_SENTINEL__"
349 UNKNOWN_SIGNATURE = Signature()
346 UNKNOWN_SIGNATURE = Signature()
350 NOT_EVALUATED = object()
347 NOT_EVALUATED = object()
351
348
352
349
353 class GuardRejection(Exception):
350 class GuardRejection(Exception):
354 """Exception raised when guard rejects evaluation attempt."""
351 """Exception raised when guard rejects evaluation attempt."""
355
352
356 pass
353 pass
357
354
358
355
359 def guarded_eval(code: str, context: EvaluationContext):
356 def guarded_eval(code: str, context: EvaluationContext):
360 """Evaluate provided code in the evaluation context.
357 """Evaluate provided code in the evaluation context.
361
358
362 If evaluation policy given by context is set to ``forbidden``
359 If evaluation policy given by context is set to ``forbidden``
363 no evaluation will be performed; if it is set to ``dangerous``
360 no evaluation will be performed; if it is set to ``dangerous``
364 standard :func:`eval` will be used; finally, for any other,
361 standard :func:`eval` will be used; finally, for any other,
365 policy :func:`eval_node` will be called on parsed AST.
362 policy :func:`eval_node` will be called on parsed AST.
366 """
363 """
367 locals_ = context.locals
364 locals_ = context.locals
368
365
369 if context.evaluation == "forbidden":
366 if context.evaluation == "forbidden":
370 raise GuardRejection("Forbidden mode")
367 raise GuardRejection("Forbidden mode")
371
368
372 # note: not using `ast.literal_eval` as it does not implement
369 # note: not using `ast.literal_eval` as it does not implement
373 # getitem at all, for example it fails on simple `[0][1]`
370 # getitem at all, for example it fails on simple `[0][1]`
374
371
375 if context.in_subscript:
372 if context.in_subscript:
376 # syntactic sugar for ellipsis (:) is only available in subscripts
373 # syntactic sugar for ellipsis (:) is only available in subscripts
377 # so we need to trick the ast parser into thinking that we have
374 # so we need to trick the ast parser into thinking that we have
378 # a subscript, but we need to be able to later recognise that we did
375 # a subscript, but we need to be able to later recognise that we did
379 # it so we can ignore the actual __getitem__ operation
376 # it so we can ignore the actual __getitem__ operation
380 if not code:
377 if not code:
381 return tuple()
378 return tuple()
382 locals_ = locals_.copy()
379 locals_ = locals_.copy()
383 locals_[SUBSCRIPT_MARKER] = IDENTITY_SUBSCRIPT
380 locals_[SUBSCRIPT_MARKER] = IDENTITY_SUBSCRIPT
384 code = SUBSCRIPT_MARKER + "[" + code + "]"
381 code = SUBSCRIPT_MARKER + "[" + code + "]"
385 context = EvaluationContext(**{**context._asdict(), **{"locals": locals_}})
382 context = EvaluationContext(**{**context._asdict(), **{"locals": locals_}})
386
383
387 if context.evaluation == "dangerous":
384 if context.evaluation == "dangerous":
388 return eval(code, context.globals, context.locals)
385 return eval(code, context.globals, context.locals)
389
386
390 expression = ast.parse(code, mode="eval")
387 expression = ast.parse(code, mode="eval")
391
388
392 return eval_node(expression, context)
389 return eval_node(expression, context)
393
390
394
391
395 BINARY_OP_DUNDERS: Dict[Type[ast.operator], Tuple[str]] = {
392 BINARY_OP_DUNDERS: Dict[Type[ast.operator], Tuple[str]] = {
396 ast.Add: ("__add__",),
393 ast.Add: ("__add__",),
397 ast.Sub: ("__sub__",),
394 ast.Sub: ("__sub__",),
398 ast.Mult: ("__mul__",),
395 ast.Mult: ("__mul__",),
399 ast.Div: ("__truediv__",),
396 ast.Div: ("__truediv__",),
400 ast.FloorDiv: ("__floordiv__",),
397 ast.FloorDiv: ("__floordiv__",),
401 ast.Mod: ("__mod__",),
398 ast.Mod: ("__mod__",),
402 ast.Pow: ("__pow__",),
399 ast.Pow: ("__pow__",),
403 ast.LShift: ("__lshift__",),
400 ast.LShift: ("__lshift__",),
404 ast.RShift: ("__rshift__",),
401 ast.RShift: ("__rshift__",),
405 ast.BitOr: ("__or__",),
402 ast.BitOr: ("__or__",),
406 ast.BitXor: ("__xor__",),
403 ast.BitXor: ("__xor__",),
407 ast.BitAnd: ("__and__",),
404 ast.BitAnd: ("__and__",),
408 ast.MatMult: ("__matmul__",),
405 ast.MatMult: ("__matmul__",),
409 }
406 }
410
407
411 COMP_OP_DUNDERS: Dict[Type[ast.cmpop], Tuple[str, ...]] = {
408 COMP_OP_DUNDERS: Dict[Type[ast.cmpop], Tuple[str, ...]] = {
412 ast.Eq: ("__eq__",),
409 ast.Eq: ("__eq__",),
413 ast.NotEq: ("__ne__", "__eq__"),
410 ast.NotEq: ("__ne__", "__eq__"),
414 ast.Lt: ("__lt__", "__gt__"),
411 ast.Lt: ("__lt__", "__gt__"),
415 ast.LtE: ("__le__", "__ge__"),
412 ast.LtE: ("__le__", "__ge__"),
416 ast.Gt: ("__gt__", "__lt__"),
413 ast.Gt: ("__gt__", "__lt__"),
417 ast.GtE: ("__ge__", "__le__"),
414 ast.GtE: ("__ge__", "__le__"),
418 ast.In: ("__contains__",),
415 ast.In: ("__contains__",),
419 # Note: ast.Is, ast.IsNot, ast.NotIn are handled specially
416 # Note: ast.Is, ast.IsNot, ast.NotIn are handled specially
420 }
417 }
421
418
422 UNARY_OP_DUNDERS: Dict[Type[ast.unaryop], Tuple[str, ...]] = {
419 UNARY_OP_DUNDERS: Dict[Type[ast.unaryop], Tuple[str, ...]] = {
423 ast.USub: ("__neg__",),
420 ast.USub: ("__neg__",),
424 ast.UAdd: ("__pos__",),
421 ast.UAdd: ("__pos__",),
425 # we have to check both __inv__ and __invert__!
422 # we have to check both __inv__ and __invert__!
426 ast.Invert: ("__invert__", "__inv__"),
423 ast.Invert: ("__invert__", "__inv__"),
427 ast.Not: ("__not__",),
424 ast.Not: ("__not__",),
428 }
425 }
429
426
430
427
431 class ImpersonatingDuck:
428 class ImpersonatingDuck:
432 """A dummy class used to create objects of other classes without calling their ``__init__``"""
429 """A dummy class used to create objects of other classes without calling their ``__init__``"""
433
430
434 # no-op: override __class__ to impersonate
431 # no-op: override __class__ to impersonate
435
432
436
433
437 class _Duck:
434 class _Duck:
438 """A dummy class used to create objects pretending to have given attributes"""
435 """A dummy class used to create objects pretending to have given attributes"""
439
436
440 def __init__(self, attributes: Optional[dict] = None, items: Optional[dict] = None):
437 def __init__(self, attributes: Optional[dict] = None, items: Optional[dict] = None):
441 self.attributes = attributes or {}
438 self.attributes = attributes or {}
442 self.items = items or {}
439 self.items = items or {}
443
440
444 def __getattr__(self, attr: str):
441 def __getattr__(self, attr: str):
445 return self.attributes[attr]
442 return self.attributes[attr]
446
443
447 def __hasattr__(self, attr: str):
444 def __hasattr__(self, attr: str):
448 return attr in self.attributes
445 return attr in self.attributes
449
446
450 def __dir__(self):
447 def __dir__(self):
451 return [*dir(super), *self.attributes]
448 return [*dir(super), *self.attributes]
452
449
453 def __getitem__(self, key: str):
450 def __getitem__(self, key: str):
454 return self.items[key]
451 return self.items[key]
455
452
456 def __hasitem__(self, key: str):
453 def __hasitem__(self, key: str):
457 return self.items[key]
454 return self.items[key]
458
455
459 def _ipython_key_completions_(self):
456 def _ipython_key_completions_(self):
460 return self.items.keys()
457 return self.items.keys()
461
458
462
459
463 def _find_dunder(node_op, dunders) -> Union[Tuple[str, ...], None]:
460 def _find_dunder(node_op, dunders) -> Union[Tuple[str, ...], None]:
464 dunder = None
461 dunder = None
465 for op, candidate_dunder in dunders.items():
462 for op, candidate_dunder in dunders.items():
466 if isinstance(node_op, op):
463 if isinstance(node_op, op):
467 dunder = candidate_dunder
464 dunder = candidate_dunder
468 return dunder
465 return dunder
469
466
470
467
471 def eval_node(node: Union[ast.AST, None], context: EvaluationContext):
468 def eval_node(node: Union[ast.AST, None], context: EvaluationContext):
472 """Evaluate AST node in provided context.
469 """Evaluate AST node in provided context.
473
470
474 Applies evaluation restrictions defined in the context. Currently does not support evaluation of functions with keyword arguments.
471 Applies evaluation restrictions defined in the context. Currently does not support evaluation of functions with keyword arguments.
475
472
476 Does not evaluate actions that always have side effects:
473 Does not evaluate actions that always have side effects:
477
474
478 - class definitions (``class sth: ...``)
475 - class definitions (``class sth: ...``)
479 - function definitions (``def sth: ...``)
476 - function definitions (``def sth: ...``)
480 - variable assignments (``x = 1``)
477 - variable assignments (``x = 1``)
481 - augmented assignments (``x += 1``)
478 - augmented assignments (``x += 1``)
482 - deletions (``del x``)
479 - deletions (``del x``)
483
480
484 Does not evaluate operations which do not return values:
481 Does not evaluate operations which do not return values:
485
482
486 - assertions (``assert x``)
483 - assertions (``assert x``)
487 - pass (``pass``)
484 - pass (``pass``)
488 - imports (``import x``)
485 - imports (``import x``)
489 - control flow:
486 - control flow:
490
487
491 - conditionals (``if x:``) except for ternary IfExp (``a if x else b``)
488 - conditionals (``if x:``) except for ternary IfExp (``a if x else b``)
492 - loops (``for`` and ``while``)
489 - loops (``for`` and ``while``)
493 - exception handling
490 - exception handling
494
491
495 The purpose of this function is to guard against unwanted side-effects;
492 The purpose of this function is to guard against unwanted side-effects;
496 it does not give guarantees on protection from malicious code execution.
493 it does not give guarantees on protection from malicious code execution.
497 """
494 """
498 policy = EVALUATION_POLICIES[context.evaluation]
495 policy = EVALUATION_POLICIES[context.evaluation]
499 if node is None:
496 if node is None:
500 return None
497 return None
501 if isinstance(node, ast.Expression):
498 if isinstance(node, ast.Expression):
502 return eval_node(node.body, context)
499 return eval_node(node.body, context)
503 if isinstance(node, ast.BinOp):
500 if isinstance(node, ast.BinOp):
504 left = eval_node(node.left, context)
501 left = eval_node(node.left, context)
505 right = eval_node(node.right, context)
502 right = eval_node(node.right, context)
506 dunders = _find_dunder(node.op, BINARY_OP_DUNDERS)
503 dunders = _find_dunder(node.op, BINARY_OP_DUNDERS)
507 if dunders:
504 if dunders:
508 if policy.can_operate(dunders, left, right):
505 if policy.can_operate(dunders, left, right):
509 return getattr(left, dunders[0])(right)
506 return getattr(left, dunders[0])(right)
510 else:
507 else:
511 raise GuardRejection(
508 raise GuardRejection(
512 f"Operation (`{dunders}`) for",
509 f"Operation (`{dunders}`) for",
513 type(left),
510 type(left),
514 f"not allowed in {context.evaluation} mode",
511 f"not allowed in {context.evaluation} mode",
515 )
512 )
516 if isinstance(node, ast.Compare):
513 if isinstance(node, ast.Compare):
517 left = eval_node(node.left, context)
514 left = eval_node(node.left, context)
518 all_true = True
515 all_true = True
519 negate = False
516 negate = False
520 for op, right in zip(node.ops, node.comparators):
517 for op, right in zip(node.ops, node.comparators):
521 right = eval_node(right, context)
518 right = eval_node(right, context)
522 dunder = None
519 dunder = None
523 dunders = _find_dunder(op, COMP_OP_DUNDERS)
520 dunders = _find_dunder(op, COMP_OP_DUNDERS)
524 if not dunders:
521 if not dunders:
525 if isinstance(op, ast.NotIn):
522 if isinstance(op, ast.NotIn):
526 dunders = COMP_OP_DUNDERS[ast.In]
523 dunders = COMP_OP_DUNDERS[ast.In]
527 negate = True
524 negate = True
528 if isinstance(op, ast.Is):
525 if isinstance(op, ast.Is):
529 dunder = "is_"
526 dunder = "is_"
530 if isinstance(op, ast.IsNot):
527 if isinstance(op, ast.IsNot):
531 dunder = "is_"
528 dunder = "is_"
532 negate = True
529 negate = True
533 if not dunder and dunders:
530 if not dunder and dunders:
534 dunder = dunders[0]
531 dunder = dunders[0]
535 if dunder:
532 if dunder:
536 a, b = (right, left) if dunder == "__contains__" else (left, right)
533 a, b = (right, left) if dunder == "__contains__" else (left, right)
537 if dunder == "is_" or dunders and policy.can_operate(dunders, a, b):
534 if dunder == "is_" or dunders and policy.can_operate(dunders, a, b):
538 result = getattr(operator, dunder)(a, b)
535 result = getattr(operator, dunder)(a, b)
539 if negate:
536 if negate:
540 result = not result
537 result = not result
541 if not result:
538 if not result:
542 all_true = False
539 all_true = False
543 left = right
540 left = right
544 else:
541 else:
545 raise GuardRejection(
542 raise GuardRejection(
546 f"Comparison (`{dunder}`) for",
543 f"Comparison (`{dunder}`) for",
547 type(left),
544 type(left),
548 f"not allowed in {context.evaluation} mode",
545 f"not allowed in {context.evaluation} mode",
549 )
546 )
550 else:
547 else:
551 raise ValueError(
548 raise ValueError(
552 f"Comparison `{dunder}` not supported"
549 f"Comparison `{dunder}` not supported"
553 ) # pragma: no cover
550 ) # pragma: no cover
554 return all_true
551 return all_true
555 if isinstance(node, ast.Constant):
552 if isinstance(node, ast.Constant):
556 return node.value
553 return node.value
557 if isinstance(node, ast.Tuple):
554 if isinstance(node, ast.Tuple):
558 return tuple(eval_node(e, context) for e in node.elts)
555 return tuple(eval_node(e, context) for e in node.elts)
559 if isinstance(node, ast.List):
556 if isinstance(node, ast.List):
560 return [eval_node(e, context) for e in node.elts]
557 return [eval_node(e, context) for e in node.elts]
561 if isinstance(node, ast.Set):
558 if isinstance(node, ast.Set):
562 return {eval_node(e, context) for e in node.elts}
559 return {eval_node(e, context) for e in node.elts}
563 if isinstance(node, ast.Dict):
560 if isinstance(node, ast.Dict):
564 return dict(
561 return dict(
565 zip(
562 zip(
566 [eval_node(k, context) for k in node.keys],
563 [eval_node(k, context) for k in node.keys],
567 [eval_node(v, context) for v in node.values],
564 [eval_node(v, context) for v in node.values],
568 )
565 )
569 )
566 )
570 if isinstance(node, ast.Slice):
567 if isinstance(node, ast.Slice):
571 return slice(
568 return slice(
572 eval_node(node.lower, context),
569 eval_node(node.lower, context),
573 eval_node(node.upper, context),
570 eval_node(node.upper, context),
574 eval_node(node.step, context),
571 eval_node(node.step, context),
575 )
572 )
576 if isinstance(node, ast.UnaryOp):
573 if isinstance(node, ast.UnaryOp):
577 value = eval_node(node.operand, context)
574 value = eval_node(node.operand, context)
578 dunders = _find_dunder(node.op, UNARY_OP_DUNDERS)
575 dunders = _find_dunder(node.op, UNARY_OP_DUNDERS)
579 if dunders:
576 if dunders:
580 if policy.can_operate(dunders, value):
577 if policy.can_operate(dunders, value):
581 return getattr(value, dunders[0])()
578 return getattr(value, dunders[0])()
582 else:
579 else:
583 raise GuardRejection(
580 raise GuardRejection(
584 f"Operation (`{dunders}`) for",
581 f"Operation (`{dunders}`) for",
585 type(value),
582 type(value),
586 f"not allowed in {context.evaluation} mode",
583 f"not allowed in {context.evaluation} mode",
587 )
584 )
588 if isinstance(node, ast.Subscript):
585 if isinstance(node, ast.Subscript):
589 value = eval_node(node.value, context)
586 value = eval_node(node.value, context)
590 slice_ = eval_node(node.slice, context)
587 slice_ = eval_node(node.slice, context)
591 if policy.can_get_item(value, slice_):
588 if policy.can_get_item(value, slice_):
592 return value[slice_]
589 return value[slice_]
593 raise GuardRejection(
590 raise GuardRejection(
594 "Subscript access (`__getitem__`) for",
591 "Subscript access (`__getitem__`) for",
595 type(value), # not joined to avoid calling `repr`
592 type(value), # not joined to avoid calling `repr`
596 f" not allowed in {context.evaluation} mode",
593 f" not allowed in {context.evaluation} mode",
597 )
594 )
598 if isinstance(node, ast.Name):
595 if isinstance(node, ast.Name):
599 return _eval_node_name(node.id, context)
596 return _eval_node_name(node.id, context)
600 if isinstance(node, ast.Attribute):
597 if isinstance(node, ast.Attribute):
601 value = eval_node(node.value, context)
598 value = eval_node(node.value, context)
602 if policy.can_get_attr(value, node.attr):
599 if policy.can_get_attr(value, node.attr):
603 return getattr(value, node.attr)
600 return getattr(value, node.attr)
604 raise GuardRejection(
601 raise GuardRejection(
605 "Attribute access (`__getattr__`) for",
602 "Attribute access (`__getattr__`) for",
606 type(value), # not joined to avoid calling `repr`
603 type(value), # not joined to avoid calling `repr`
607 f"not allowed in {context.evaluation} mode",
604 f"not allowed in {context.evaluation} mode",
608 )
605 )
609 if isinstance(node, ast.IfExp):
606 if isinstance(node, ast.IfExp):
610 test = eval_node(node.test, context)
607 test = eval_node(node.test, context)
611 if test:
608 if test:
612 return eval_node(node.body, context)
609 return eval_node(node.body, context)
613 else:
610 else:
614 return eval_node(node.orelse, context)
611 return eval_node(node.orelse, context)
615 if isinstance(node, ast.Call):
612 if isinstance(node, ast.Call):
616 func = eval_node(node.func, context)
613 func = eval_node(node.func, context)
617 if policy.can_call(func) and not node.keywords:
614 if policy.can_call(func) and not node.keywords:
618 args = [eval_node(arg, context) for arg in node.args]
615 args = [eval_node(arg, context) for arg in node.args]
619 return func(*args)
616 return func(*args)
620 if isclass(func):
617 if isclass(func):
621 # this code path gets entered when calling class e.g. `MyClass()`
618 # this code path gets entered when calling class e.g. `MyClass()`
622 # or `my_instance.__class__()` - in both cases `func` is `MyClass`.
619 # or `my_instance.__class__()` - in both cases `func` is `MyClass`.
623 # Should return `MyClass` if `__new__` is not overridden,
620 # Should return `MyClass` if `__new__` is not overridden,
624 # otherwise whatever `__new__` return type is.
621 # otherwise whatever `__new__` return type is.
625 overridden_return_type = _eval_return_type(func.__new__, node, context)
622 overridden_return_type = _eval_return_type(func.__new__, node, context)
626 if overridden_return_type is not NOT_EVALUATED:
623 if overridden_return_type is not NOT_EVALUATED:
627 return overridden_return_type
624 return overridden_return_type
628 return _create_duck_for_heap_type(func)
625 return _create_duck_for_heap_type(func)
629 else:
626 else:
630 return_type = _eval_return_type(func, node, context)
627 return_type = _eval_return_type(func, node, context)
631 if return_type is not NOT_EVALUATED:
628 if return_type is not NOT_EVALUATED:
632 return return_type
629 return return_type
633 raise GuardRejection(
630 raise GuardRejection(
634 "Call for",
631 "Call for",
635 func, # not joined to avoid calling `repr`
632 func, # not joined to avoid calling `repr`
636 f"not allowed in {context.evaluation} mode",
633 f"not allowed in {context.evaluation} mode",
637 )
634 )
638 raise ValueError("Unhandled node", ast.dump(node))
635 raise ValueError("Unhandled node", ast.dump(node))
639
636
640
637
641 def _eval_return_type(func: Callable, node: ast.Call, context: EvaluationContext):
638 def _eval_return_type(func: Callable, node: ast.Call, context: EvaluationContext):
642 """Evaluate return type of a given callable function.
639 """Evaluate return type of a given callable function.
643
640
644 Returns the built-in type, a duck or NOT_EVALUATED sentinel.
641 Returns the built-in type, a duck or NOT_EVALUATED sentinel.
645 """
642 """
646 try:
643 try:
647 sig = signature(func)
644 sig = signature(func)
648 except ValueError:
645 except ValueError:
649 sig = UNKNOWN_SIGNATURE
646 sig = UNKNOWN_SIGNATURE
650 # if annotation was not stringized, or it was stringized
647 # if annotation was not stringized, or it was stringized
651 # but resolved by signature call we know the return type
648 # but resolved by signature call we know the return type
652 not_empty = sig.return_annotation is not Signature.empty
649 not_empty = sig.return_annotation is not Signature.empty
653 if not_empty:
650 if not_empty:
654 return _resolve_annotation(sig.return_annotation, sig, func, node, context)
651 return _resolve_annotation(sig.return_annotation, sig, func, node, context)
655 return NOT_EVALUATED
652 return NOT_EVALUATED
656
653
657
654
658 def _resolve_annotation(
655 def _resolve_annotation(
659 annotation,
656 annotation,
660 sig: Signature,
657 sig: Signature,
661 func: Callable,
658 func: Callable,
662 node: ast.Call,
659 node: ast.Call,
663 context: EvaluationContext,
660 context: EvaluationContext,
664 ):
661 ):
665 """Resolve annotation created by user with `typing` module and custom objects."""
662 """Resolve annotation created by user with `typing` module and custom objects."""
666 annotation = (
663 annotation = (
667 _eval_node_name(annotation, context)
664 _eval_node_name(annotation, context)
668 if isinstance(annotation, str)
665 if isinstance(annotation, str)
669 else annotation
666 else annotation
670 )
667 )
671 origin = get_origin(annotation)
668 origin = get_origin(annotation)
672 if annotation is Self and hasattr(func, "__self__"):
669 if annotation is Self and hasattr(func, "__self__"):
673 return func.__self__
670 return func.__self__
674 elif origin is Literal:
671 elif origin is Literal:
675 type_args = get_args(annotation)
672 type_args = get_args(annotation)
676 if len(type_args) == 1:
673 if len(type_args) == 1:
677 return type_args[0]
674 return type_args[0]
678 elif annotation is LiteralString:
675 elif annotation is LiteralString:
679 return ""
676 return ""
680 elif annotation is AnyStr:
677 elif annotation is AnyStr:
681 index = None
678 index = None
682 for i, (key, value) in enumerate(sig.parameters.items()):
679 for i, (key, value) in enumerate(sig.parameters.items()):
683 if value.annotation is AnyStr:
680 if value.annotation is AnyStr:
684 index = i
681 index = i
685 break
682 break
686 if index is not None and index < len(node.args):
683 if index is not None and index < len(node.args):
687 return eval_node(node.args[index], context)
684 return eval_node(node.args[index], context)
688 elif origin is TypeGuard:
685 elif origin is TypeGuard:
689 return bool()
686 return bool()
690 elif origin is Union:
687 elif origin is Union:
691 attributes = [
688 attributes = [
692 attr
689 attr
693 for type_arg in get_args(annotation)
690 for type_arg in get_args(annotation)
694 for attr in dir(_resolve_annotation(type_arg, sig, func, node, context))
691 for attr in dir(_resolve_annotation(type_arg, sig, func, node, context))
695 ]
692 ]
696 return _Duck(attributes=dict.fromkeys(attributes))
693 return _Duck(attributes=dict.fromkeys(attributes))
697 elif is_typeddict(annotation):
694 elif is_typeddict(annotation):
698 return _Duck(
695 return _Duck(
699 attributes=dict.fromkeys(dir(dict())),
696 attributes=dict.fromkeys(dir(dict())),
700 items={
697 items={
701 k: _resolve_annotation(v, sig, func, node, context)
698 k: _resolve_annotation(v, sig, func, node, context)
702 for k, v in annotation.__annotations__.items()
699 for k, v in annotation.__annotations__.items()
703 },
700 },
704 )
701 )
705 elif hasattr(annotation, "_is_protocol"):
702 elif hasattr(annotation, "_is_protocol"):
706 return _Duck(attributes=dict.fromkeys(dir(annotation)))
703 return _Duck(attributes=dict.fromkeys(dir(annotation)))
707 elif origin is Annotated:
704 elif origin is Annotated:
708 type_arg = get_args(annotation)[0]
705 type_arg = get_args(annotation)[0]
709 return _resolve_annotation(type_arg, sig, func, node, context)
706 return _resolve_annotation(type_arg, sig, func, node, context)
710 elif isinstance(annotation, NewType):
707 elif isinstance(annotation, NewType):
711 return _eval_or_create_duck(annotation.__supertype__, node, context)
708 return _eval_or_create_duck(annotation.__supertype__, node, context)
712 elif isinstance(annotation, TypeAliasType):
709 elif isinstance(annotation, TypeAliasType):
713 return _eval_or_create_duck(annotation.__value__, node, context)
710 return _eval_or_create_duck(annotation.__value__, node, context)
714 else:
711 else:
715 return _eval_or_create_duck(annotation, node, context)
712 return _eval_or_create_duck(annotation, node, context)
716
713
717
714
718 def _eval_node_name(node_id: str, context: EvaluationContext):
715 def _eval_node_name(node_id: str, context: EvaluationContext):
719 policy = EVALUATION_POLICIES[context.evaluation]
716 policy = EVALUATION_POLICIES[context.evaluation]
720 if policy.allow_locals_access and node_id in context.locals:
717 if policy.allow_locals_access and node_id in context.locals:
721 return context.locals[node_id]
718 return context.locals[node_id]
722 if policy.allow_globals_access and node_id in context.globals:
719 if policy.allow_globals_access and node_id in context.globals:
723 return context.globals[node_id]
720 return context.globals[node_id]
724 if policy.allow_builtins_access and hasattr(builtins, node_id):
721 if policy.allow_builtins_access and hasattr(builtins, node_id):
725 # note: do not use __builtins__, it is implementation detail of cPython
722 # note: do not use __builtins__, it is implementation detail of cPython
726 return getattr(builtins, node_id)
723 return getattr(builtins, node_id)
727 if not policy.allow_globals_access and not policy.allow_locals_access:
724 if not policy.allow_globals_access and not policy.allow_locals_access:
728 raise GuardRejection(
725 raise GuardRejection(
729 f"Namespace access not allowed in {context.evaluation} mode"
726 f"Namespace access not allowed in {context.evaluation} mode"
730 )
727 )
731 else:
728 else:
732 raise NameError(f"{node_id} not found in locals, globals, nor builtins")
729 raise NameError(f"{node_id} not found in locals, globals, nor builtins")
733
730
734
731
735 def _eval_or_create_duck(duck_type, node: ast.Call, context: EvaluationContext):
732 def _eval_or_create_duck(duck_type, node: ast.Call, context: EvaluationContext):
736 policy = EVALUATION_POLICIES[context.evaluation]
733 policy = EVALUATION_POLICIES[context.evaluation]
737 # if allow-listed builtin is on type annotation, instantiate it
734 # if allow-listed builtin is on type annotation, instantiate it
738 if policy.can_call(duck_type) and not node.keywords:
735 if policy.can_call(duck_type) and not node.keywords:
739 args = [eval_node(arg, context) for arg in node.args]
736 args = [eval_node(arg, context) for arg in node.args]
740 return duck_type(*args)
737 return duck_type(*args)
741 # if custom class is in type annotation, mock it
738 # if custom class is in type annotation, mock it
742 return _create_duck_for_heap_type(duck_type)
739 return _create_duck_for_heap_type(duck_type)
743
740
744
741
745 def _create_duck_for_heap_type(duck_type):
742 def _create_duck_for_heap_type(duck_type):
746 """Create an imitation of an object of a given type (a duck).
743 """Create an imitation of an object of a given type (a duck).
747
744
748 Returns the duck or NOT_EVALUATED sentinel if duck could not be created.
745 Returns the duck or NOT_EVALUATED sentinel if duck could not be created.
749 """
746 """
750 duck = ImpersonatingDuck()
747 duck = ImpersonatingDuck()
751 try:
748 try:
752 # this only works for heap types, not builtins
749 # this only works for heap types, not builtins
753 duck.__class__ = duck_type
750 duck.__class__ = duck_type
754 return duck
751 return duck
755 except TypeError:
752 except TypeError:
756 pass
753 pass
757 return NOT_EVALUATED
754 return NOT_EVALUATED
758
755
759
756
760 SUPPORTED_EXTERNAL_GETITEM = {
757 SUPPORTED_EXTERNAL_GETITEM = {
761 ("pandas", "core", "indexing", "_iLocIndexer"),
758 ("pandas", "core", "indexing", "_iLocIndexer"),
762 ("pandas", "core", "indexing", "_LocIndexer"),
759 ("pandas", "core", "indexing", "_LocIndexer"),
763 ("pandas", "DataFrame"),
760 ("pandas", "DataFrame"),
764 ("pandas", "Series"),
761 ("pandas", "Series"),
765 ("numpy", "ndarray"),
762 ("numpy", "ndarray"),
766 ("numpy", "void"),
763 ("numpy", "void"),
767 }
764 }
768
765
769
766
770 BUILTIN_GETITEM: Set[InstancesHaveGetItem] = {
767 BUILTIN_GETITEM: Set[InstancesHaveGetItem] = {
771 dict,
768 dict,
772 str, # type: ignore[arg-type]
769 str, # type: ignore[arg-type]
773 bytes, # type: ignore[arg-type]
770 bytes, # type: ignore[arg-type]
774 list,
771 list,
775 tuple,
772 tuple,
776 collections.defaultdict,
773 collections.defaultdict,
777 collections.deque,
774 collections.deque,
778 collections.OrderedDict,
775 collections.OrderedDict,
779 collections.ChainMap,
776 collections.ChainMap,
780 collections.UserDict,
777 collections.UserDict,
781 collections.UserList,
778 collections.UserList,
782 collections.UserString, # type: ignore[arg-type]
779 collections.UserString, # type: ignore[arg-type]
783 _DummyNamedTuple,
780 _DummyNamedTuple,
784 _IdentitySubscript,
781 _IdentitySubscript,
785 }
782 }
786
783
787
784
788 def _list_methods(cls, source=None):
785 def _list_methods(cls, source=None):
789 """For use on immutable objects or with methods returning a copy"""
786 """For use on immutable objects or with methods returning a copy"""
790 return [getattr(cls, k) for k in (source if source else dir(cls))]
787 return [getattr(cls, k) for k in (source if source else dir(cls))]
791
788
792
789
793 dict_non_mutating_methods = ("copy", "keys", "values", "items")
790 dict_non_mutating_methods = ("copy", "keys", "values", "items")
794 list_non_mutating_methods = ("copy", "index", "count")
791 list_non_mutating_methods = ("copy", "index", "count")
795 set_non_mutating_methods = set(dir(set)) & set(dir(frozenset))
792 set_non_mutating_methods = set(dir(set)) & set(dir(frozenset))
796
793
797
794
798 dict_keys: Type[collections.abc.KeysView] = type({}.keys())
795 dict_keys: Type[collections.abc.KeysView] = type({}.keys())
799
796
800 NUMERICS = {int, float, complex}
797 NUMERICS = {int, float, complex}
801
798
802 ALLOWED_CALLS = {
799 ALLOWED_CALLS = {
803 bytes,
800 bytes,
804 *_list_methods(bytes),
801 *_list_methods(bytes),
805 dict,
802 dict,
806 *_list_methods(dict, dict_non_mutating_methods),
803 *_list_methods(dict, dict_non_mutating_methods),
807 dict_keys.isdisjoint,
804 dict_keys.isdisjoint,
808 list,
805 list,
809 *_list_methods(list, list_non_mutating_methods),
806 *_list_methods(list, list_non_mutating_methods),
810 set,
807 set,
811 *_list_methods(set, set_non_mutating_methods),
808 *_list_methods(set, set_non_mutating_methods),
812 frozenset,
809 frozenset,
813 *_list_methods(frozenset),
810 *_list_methods(frozenset),
814 range,
811 range,
815 str,
812 str,
816 *_list_methods(str),
813 *_list_methods(str),
817 tuple,
814 tuple,
818 *_list_methods(tuple),
815 *_list_methods(tuple),
819 *NUMERICS,
816 *NUMERICS,
820 *[method for numeric_cls in NUMERICS for method in _list_methods(numeric_cls)],
817 *[method for numeric_cls in NUMERICS for method in _list_methods(numeric_cls)],
821 collections.deque,
818 collections.deque,
822 *_list_methods(collections.deque, list_non_mutating_methods),
819 *_list_methods(collections.deque, list_non_mutating_methods),
823 collections.defaultdict,
820 collections.defaultdict,
824 *_list_methods(collections.defaultdict, dict_non_mutating_methods),
821 *_list_methods(collections.defaultdict, dict_non_mutating_methods),
825 collections.OrderedDict,
822 collections.OrderedDict,
826 *_list_methods(collections.OrderedDict, dict_non_mutating_methods),
823 *_list_methods(collections.OrderedDict, dict_non_mutating_methods),
827 collections.UserDict,
824 collections.UserDict,
828 *_list_methods(collections.UserDict, dict_non_mutating_methods),
825 *_list_methods(collections.UserDict, dict_non_mutating_methods),
829 collections.UserList,
826 collections.UserList,
830 *_list_methods(collections.UserList, list_non_mutating_methods),
827 *_list_methods(collections.UserList, list_non_mutating_methods),
831 collections.UserString,
828 collections.UserString,
832 *_list_methods(collections.UserString, dir(str)),
829 *_list_methods(collections.UserString, dir(str)),
833 collections.Counter,
830 collections.Counter,
834 *_list_methods(collections.Counter, dict_non_mutating_methods),
831 *_list_methods(collections.Counter, dict_non_mutating_methods),
835 collections.Counter.elements,
832 collections.Counter.elements,
836 collections.Counter.most_common,
833 collections.Counter.most_common,
837 }
834 }
838
835
839 BUILTIN_GETATTR: Set[MayHaveGetattr] = {
836 BUILTIN_GETATTR: Set[MayHaveGetattr] = {
840 *BUILTIN_GETITEM,
837 *BUILTIN_GETITEM,
841 set,
838 set,
842 frozenset,
839 frozenset,
843 object,
840 object,
844 type, # `type` handles a lot of generic cases, e.g. numbers as in `int.real`.
841 type, # `type` handles a lot of generic cases, e.g. numbers as in `int.real`.
845 *NUMERICS,
842 *NUMERICS,
846 dict_keys,
843 dict_keys,
847 MethodDescriptorType,
844 MethodDescriptorType,
848 ModuleType,
845 ModuleType,
849 }
846 }
850
847
851
848
852 BUILTIN_OPERATIONS = {*BUILTIN_GETATTR}
849 BUILTIN_OPERATIONS = {*BUILTIN_GETATTR}
853
850
854 EVALUATION_POLICIES = {
851 EVALUATION_POLICIES = {
855 "minimal": EvaluationPolicy(
852 "minimal": EvaluationPolicy(
856 allow_builtins_access=True,
853 allow_builtins_access=True,
857 allow_locals_access=False,
854 allow_locals_access=False,
858 allow_globals_access=False,
855 allow_globals_access=False,
859 allow_item_access=False,
856 allow_item_access=False,
860 allow_attr_access=False,
857 allow_attr_access=False,
861 allowed_calls=set(),
858 allowed_calls=set(),
862 allow_any_calls=False,
859 allow_any_calls=False,
863 allow_all_operations=False,
860 allow_all_operations=False,
864 ),
861 ),
865 "limited": SelectivePolicy(
862 "limited": SelectivePolicy(
866 allowed_getitem=BUILTIN_GETITEM,
863 allowed_getitem=BUILTIN_GETITEM,
867 allowed_getitem_external=SUPPORTED_EXTERNAL_GETITEM,
864 allowed_getitem_external=SUPPORTED_EXTERNAL_GETITEM,
868 allowed_getattr=BUILTIN_GETATTR,
865 allowed_getattr=BUILTIN_GETATTR,
869 allowed_getattr_external={
866 allowed_getattr_external={
870 # pandas Series/Frame implements custom `__getattr__`
867 # pandas Series/Frame implements custom `__getattr__`
871 ("pandas", "DataFrame"),
868 ("pandas", "DataFrame"),
872 ("pandas", "Series"),
869 ("pandas", "Series"),
873 },
870 },
874 allowed_operations=BUILTIN_OPERATIONS,
871 allowed_operations=BUILTIN_OPERATIONS,
875 allow_builtins_access=True,
872 allow_builtins_access=True,
876 allow_locals_access=True,
873 allow_locals_access=True,
877 allow_globals_access=True,
874 allow_globals_access=True,
878 allowed_calls=ALLOWED_CALLS,
875 allowed_calls=ALLOWED_CALLS,
879 ),
876 ),
880 "unsafe": EvaluationPolicy(
877 "unsafe": EvaluationPolicy(
881 allow_builtins_access=True,
878 allow_builtins_access=True,
882 allow_locals_access=True,
879 allow_locals_access=True,
883 allow_globals_access=True,
880 allow_globals_access=True,
884 allow_attr_access=True,
881 allow_attr_access=True,
885 allow_item_access=True,
882 allow_item_access=True,
886 allow_any_calls=True,
883 allow_any_calls=True,
887 allow_all_operations=True,
884 allow_all_operations=True,
888 ),
885 ),
889 }
886 }
890
887
891
888
892 __all__ = [
889 __all__ = [
893 "guarded_eval",
890 "guarded_eval",
894 "eval_node",
891 "eval_node",
895 "GuardRejection",
892 "GuardRejection",
896 "EvaluationContext",
893 "EvaluationContext",
897 "_unbind_method",
894 "_unbind_method",
898 ]
895 ]
@@ -1,21 +1,23
1 # -*- coding: utf-8 -*-
1 # -*- coding: utf-8 -*-
2 """Being removed
2 """Being removed
3 """
3 """
4
4
5
5 class LazyEvaluate(object):
6 class LazyEvaluate(object):
6 """This is used for formatting strings with values that need to be updated
7 """This is used for formatting strings with values that need to be updated
7 at that time, such as the current time or working directory."""
8 at that time, such as the current time or working directory."""
9
8 def __init__(self, func, *args, **kwargs):
10 def __init__(self, func, *args, **kwargs):
9 self.func = func
11 self.func = func
10 self.args = args
12 self.args = args
11 self.kwargs = kwargs
13 self.kwargs = kwargs
12
14
13 def __call__(self, **kwargs):
15 def __call__(self, **kwargs):
14 self.kwargs.update(kwargs)
16 self.kwargs.update(kwargs)
15 return self.func(*self.args, **self.kwargs)
17 return self.func(*self.args, **self.kwargs)
16
18
17 def __str__(self):
19 def __str__(self):
18 return str(self())
20 return str(self())
19
21
20 def __format__(self, format_spec):
22 def __format__(self, format_spec):
21 return format(self(), format_spec)
23 return format(self(), format_spec)
@@ -1,4 +1,4
1 # coding: iso-8859-5
1 # coding: iso-8859-5
2 # (Unlikely to be the default encoding for most testers.)
2 # (Unlikely to be the default encoding for most testers.)
3 # Π‘Π–ΡŸΡ€ΡΡ‚ΡƒΡ„Ρ…Ρ†Ρ‡ΡˆΡ‰ΡŠΡ‹ΡŒΡΡŽΡ <- Cyrillic characters
3 # οΏ½οΏ½οΏ½οΏ½οΏ½οΏ½οΏ½οΏ½οΏ½οΏ½οΏ½οΏ½οΏ½οΏ½οΏ½οΏ½οΏ½οΏ½οΏ½ <- Cyrillic characters
4 'ΠŽΡ‚β„–Π€'
4 "οΏ½οΏ½οΏ½οΏ½"
@@ -1,546 +1,545
1 """Tests for the Formatters."""
1 """Tests for the Formatters."""
2
2
3 from math import pi
3 from math import pi
4
4
5 try:
5 try:
6 import numpy
6 import numpy
7 except:
7 except:
8 numpy = None
8 numpy = None
9 import pytest
9 import pytest
10
10
11 from IPython import get_ipython
11 from IPython import get_ipython
12 from traitlets.config import Config
12 from traitlets.config import Config
13 from IPython.core.formatters import (
13 from IPython.core.formatters import (
14 PlainTextFormatter, HTMLFormatter, PDFFormatter, _mod_name_key,
14 PlainTextFormatter, HTMLFormatter, PDFFormatter, _mod_name_key,
15 DisplayFormatter, JSONFormatter,
15 DisplayFormatter, JSONFormatter,
16 )
16 )
17 from IPython.utils.io import capture_output
17 from IPython.utils.io import capture_output
18
18
19 class A(object):
19 class A(object):
20 def __repr__(self):
20 def __repr__(self):
21 return 'A()'
21 return 'A()'
22
22
23 class B(A):
23 class B(A):
24 def __repr__(self):
24 def __repr__(self):
25 return 'B()'
25 return 'B()'
26
26
27 class C:
27 class C:
28 pass
28 pass
29
29
30 class BadRepr(object):
30 class BadRepr(object):
31 def __repr__(self):
31 def __repr__(self):
32 raise ValueError("bad repr")
32 raise ValueError("bad repr")
33
33
34 class BadPretty(object):
34 class BadPretty(object):
35 _repr_pretty_ = None
35 _repr_pretty_ = None
36
36
37 class GoodPretty(object):
37 class GoodPretty(object):
38 def _repr_pretty_(self, pp, cycle):
38 def _repr_pretty_(self, pp, cycle):
39 pp.text('foo')
39 pp.text('foo')
40
40
41 def __repr__(self):
41 def __repr__(self):
42 return 'GoodPretty()'
42 return 'GoodPretty()'
43
43
44 def foo_printer(obj, pp, cycle):
44 def foo_printer(obj, pp, cycle):
45 pp.text('foo')
45 pp.text('foo')
46
46
47 def test_pretty():
47 def test_pretty():
48 f = PlainTextFormatter()
48 f = PlainTextFormatter()
49 f.for_type(A, foo_printer)
49 f.for_type(A, foo_printer)
50 assert f(A()) == "foo"
50 assert f(A()) == "foo"
51 assert f(B()) == "B()"
51 assert f(B()) == "B()"
52 assert f(GoodPretty()) == "foo"
52 assert f(GoodPretty()) == "foo"
53 # Just don't raise an exception for the following:
53 # Just don't raise an exception for the following:
54 f(BadPretty())
54 f(BadPretty())
55
55
56 f.pprint = False
56 f.pprint = False
57 assert f(A()) == "A()"
57 assert f(A()) == "A()"
58 assert f(B()) == "B()"
58 assert f(B()) == "B()"
59 assert f(GoodPretty()) == "GoodPretty()"
59 assert f(GoodPretty()) == "GoodPretty()"
60
60
61
61
62 def test_deferred():
62 def test_deferred():
63 f = PlainTextFormatter()
63 f = PlainTextFormatter()
64
64
65 def test_precision():
65 def test_precision():
66 """test various values for float_precision."""
66 """test various values for float_precision."""
67 f = PlainTextFormatter()
67 f = PlainTextFormatter()
68 assert f(pi) == repr(pi)
68 assert f(pi) == repr(pi)
69 f.float_precision = 0
69 f.float_precision = 0
70 if numpy:
70 if numpy:
71 po = numpy.get_printoptions()
71 po = numpy.get_printoptions()
72 assert po["precision"] == 0
72 assert po["precision"] == 0
73 assert f(pi) == "3"
73 assert f(pi) == "3"
74 f.float_precision = 2
74 f.float_precision = 2
75 if numpy:
75 if numpy:
76 po = numpy.get_printoptions()
76 po = numpy.get_printoptions()
77 assert po["precision"] == 2
77 assert po["precision"] == 2
78 assert f(pi) == "3.14"
78 assert f(pi) == "3.14"
79 f.float_precision = "%g"
79 f.float_precision = "%g"
80 if numpy:
80 if numpy:
81 po = numpy.get_printoptions()
81 po = numpy.get_printoptions()
82 assert po["precision"] == 2
82 assert po["precision"] == 2
83 assert f(pi) == "3.14159"
83 assert f(pi) == "3.14159"
84 f.float_precision = "%e"
84 f.float_precision = "%e"
85 assert f(pi) == "3.141593e+00"
85 assert f(pi) == "3.141593e+00"
86 f.float_precision = ""
86 f.float_precision = ""
87 if numpy:
87 if numpy:
88 po = numpy.get_printoptions()
88 po = numpy.get_printoptions()
89 assert po["precision"] == 8
89 assert po["precision"] == 8
90 assert f(pi) == repr(pi)
90 assert f(pi) == repr(pi)
91
91
92
92
93 def test_bad_precision():
93 def test_bad_precision():
94 """test various invalid values for float_precision."""
94 """test various invalid values for float_precision."""
95 f = PlainTextFormatter()
95 f = PlainTextFormatter()
96 def set_fp(p):
96 def set_fp(p):
97 f.float_precision = p
97 f.float_precision = p
98
98
99 pytest.raises(ValueError, set_fp, "%")
99 pytest.raises(ValueError, set_fp, "%")
100 pytest.raises(ValueError, set_fp, "%.3f%i")
100 pytest.raises(ValueError, set_fp, "%.3f%i")
101 pytest.raises(ValueError, set_fp, "foo")
101 pytest.raises(ValueError, set_fp, "foo")
102 pytest.raises(ValueError, set_fp, -1)
102 pytest.raises(ValueError, set_fp, -1)
103
103
104 def test_for_type():
104 def test_for_type():
105 f = PlainTextFormatter()
105 f = PlainTextFormatter()
106
106
107 # initial return, None
107 # initial return, None
108 assert f.for_type(C, foo_printer) is None
108 assert f.for_type(C, foo_printer) is None
109 # no func queries
109 # no func queries
110 assert f.for_type(C) is foo_printer
110 assert f.for_type(C) is foo_printer
111 # shouldn't change anything
111 # shouldn't change anything
112 assert f.for_type(C) is foo_printer
112 assert f.for_type(C) is foo_printer
113 # None should do the same
113 # None should do the same
114 assert f.for_type(C, None) is foo_printer
114 assert f.for_type(C, None) is foo_printer
115 assert f.for_type(C, None) is foo_printer
115 assert f.for_type(C, None) is foo_printer
116
116
117 def test_for_type_string():
117 def test_for_type_string():
118 f = PlainTextFormatter()
118 f = PlainTextFormatter()
119
119
120 type_str = '%s.%s' % (C.__module__, 'C')
120 type_str = '%s.%s' % (C.__module__, 'C')
121
121
122 # initial return, None
122 # initial return, None
123 assert f.for_type(type_str, foo_printer) is None
123 assert f.for_type(type_str, foo_printer) is None
124 # no func queries
124 # no func queries
125 assert f.for_type(type_str) is foo_printer
125 assert f.for_type(type_str) is foo_printer
126 assert _mod_name_key(C) in f.deferred_printers
126 assert _mod_name_key(C) in f.deferred_printers
127 assert f.for_type(C) is foo_printer
127 assert f.for_type(C) is foo_printer
128 assert _mod_name_key(C) not in f.deferred_printers
128 assert _mod_name_key(C) not in f.deferred_printers
129 assert C in f.type_printers
129 assert C in f.type_printers
130
130
131 def test_for_type_by_name():
131 def test_for_type_by_name():
132 f = PlainTextFormatter()
132 f = PlainTextFormatter()
133
133
134 mod = C.__module__
134 mod = C.__module__
135
135
136 # initial return, None
136 # initial return, None
137 assert f.for_type_by_name(mod, "C", foo_printer) is None
137 assert f.for_type_by_name(mod, "C", foo_printer) is None
138 # no func queries
138 # no func queries
139 assert f.for_type_by_name(mod, "C") is foo_printer
139 assert f.for_type_by_name(mod, "C") is foo_printer
140 # shouldn't change anything
140 # shouldn't change anything
141 assert f.for_type_by_name(mod, "C") is foo_printer
141 assert f.for_type_by_name(mod, "C") is foo_printer
142 # None should do the same
142 # None should do the same
143 assert f.for_type_by_name(mod, "C", None) is foo_printer
143 assert f.for_type_by_name(mod, "C", None) is foo_printer
144 assert f.for_type_by_name(mod, "C", None) is foo_printer
144 assert f.for_type_by_name(mod, "C", None) is foo_printer
145
145
146
146
147 def test_lookup():
147 def test_lookup():
148 f = PlainTextFormatter()
148 f = PlainTextFormatter()
149
149
150 f.for_type(C, foo_printer)
150 f.for_type(C, foo_printer)
151 assert f.lookup(C()) is foo_printer
151 assert f.lookup(C()) is foo_printer
152 with pytest.raises(KeyError):
152 with pytest.raises(KeyError):
153 f.lookup(A())
153 f.lookup(A())
154
154
155 def test_lookup_string():
155 def test_lookup_string():
156 f = PlainTextFormatter()
156 f = PlainTextFormatter()
157 type_str = '%s.%s' % (C.__module__, 'C')
157 type_str = '%s.%s' % (C.__module__, 'C')
158
158
159 f.for_type(type_str, foo_printer)
159 f.for_type(type_str, foo_printer)
160 assert f.lookup(C()) is foo_printer
160 assert f.lookup(C()) is foo_printer
161 # should move from deferred to imported dict
161 # should move from deferred to imported dict
162 assert _mod_name_key(C) not in f.deferred_printers
162 assert _mod_name_key(C) not in f.deferred_printers
163 assert C in f.type_printers
163 assert C in f.type_printers
164
164
165 def test_lookup_by_type():
165 def test_lookup_by_type():
166 f = PlainTextFormatter()
166 f = PlainTextFormatter()
167 f.for_type(C, foo_printer)
167 f.for_type(C, foo_printer)
168 assert f.lookup_by_type(C) is foo_printer
168 assert f.lookup_by_type(C) is foo_printer
169 with pytest.raises(KeyError):
169 with pytest.raises(KeyError):
170 f.lookup_by_type(A)
170 f.lookup_by_type(A)
171
171
172 def test_lookup_by_type_string():
172 def test_lookup_by_type_string():
173 f = PlainTextFormatter()
173 f = PlainTextFormatter()
174 type_str = '%s.%s' % (C.__module__, 'C')
174 type_str = '%s.%s' % (C.__module__, 'C')
175 f.for_type(type_str, foo_printer)
175 f.for_type(type_str, foo_printer)
176
176
177 # verify insertion
177 # verify insertion
178 assert _mod_name_key(C) in f.deferred_printers
178 assert _mod_name_key(C) in f.deferred_printers
179 assert C not in f.type_printers
179 assert C not in f.type_printers
180
180
181 assert f.lookup_by_type(type_str) is foo_printer
181 assert f.lookup_by_type(type_str) is foo_printer
182 # lookup by string doesn't cause import
182 # lookup by string doesn't cause import
183 assert _mod_name_key(C) in f.deferred_printers
183 assert _mod_name_key(C) in f.deferred_printers
184 assert C not in f.type_printers
184 assert C not in f.type_printers
185
185
186 assert f.lookup_by_type(C) is foo_printer
186 assert f.lookup_by_type(C) is foo_printer
187 # should move from deferred to imported dict
187 # should move from deferred to imported dict
188 assert _mod_name_key(C) not in f.deferred_printers
188 assert _mod_name_key(C) not in f.deferred_printers
189 assert C in f.type_printers
189 assert C in f.type_printers
190
190
191 def test_in_formatter():
191 def test_in_formatter():
192 f = PlainTextFormatter()
192 f = PlainTextFormatter()
193 f.for_type(C, foo_printer)
193 f.for_type(C, foo_printer)
194 type_str = '%s.%s' % (C.__module__, 'C')
194 type_str = '%s.%s' % (C.__module__, 'C')
195 assert C in f
195 assert C in f
196 assert type_str in f
196 assert type_str in f
197
197
198 def test_string_in_formatter():
198 def test_string_in_formatter():
199 f = PlainTextFormatter()
199 f = PlainTextFormatter()
200 type_str = '%s.%s' % (C.__module__, 'C')
200 type_str = '%s.%s' % (C.__module__, 'C')
201 f.for_type(type_str, foo_printer)
201 f.for_type(type_str, foo_printer)
202 assert type_str in f
202 assert type_str in f
203 assert C in f
203 assert C in f
204
204
205 def test_pop():
205 def test_pop():
206 f = PlainTextFormatter()
206 f = PlainTextFormatter()
207 f.for_type(C, foo_printer)
207 f.for_type(C, foo_printer)
208 assert f.lookup_by_type(C) is foo_printer
208 assert f.lookup_by_type(C) is foo_printer
209 assert f.pop(C, None) is foo_printer
209 assert f.pop(C, None) is foo_printer
210 f.for_type(C, foo_printer)
210 f.for_type(C, foo_printer)
211 assert f.pop(C) is foo_printer
211 assert f.pop(C) is foo_printer
212 with pytest.raises(KeyError):
212 with pytest.raises(KeyError):
213 f.lookup_by_type(C)
213 f.lookup_by_type(C)
214 with pytest.raises(KeyError):
214 with pytest.raises(KeyError):
215 f.pop(C)
215 f.pop(C)
216 with pytest.raises(KeyError):
216 with pytest.raises(KeyError):
217 f.pop(A)
217 f.pop(A)
218 assert f.pop(A, None) is None
218 assert f.pop(A, None) is None
219
219
220 def test_pop_string():
220 def test_pop_string():
221 f = PlainTextFormatter()
221 f = PlainTextFormatter()
222 type_str = '%s.%s' % (C.__module__, 'C')
222 type_str = '%s.%s' % (C.__module__, 'C')
223
223
224 with pytest.raises(KeyError):
224 with pytest.raises(KeyError):
225 f.pop(type_str)
225 f.pop(type_str)
226
226
227 f.for_type(type_str, foo_printer)
227 f.for_type(type_str, foo_printer)
228 f.pop(type_str)
228 f.pop(type_str)
229 with pytest.raises(KeyError):
229 with pytest.raises(KeyError):
230 f.lookup_by_type(C)
230 f.lookup_by_type(C)
231 with pytest.raises(KeyError):
231 with pytest.raises(KeyError):
232 f.pop(type_str)
232 f.pop(type_str)
233
233
234 f.for_type(C, foo_printer)
234 f.for_type(C, foo_printer)
235 assert f.pop(type_str, None) is foo_printer
235 assert f.pop(type_str, None) is foo_printer
236 with pytest.raises(KeyError):
236 with pytest.raises(KeyError):
237 f.lookup_by_type(C)
237 f.lookup_by_type(C)
238 with pytest.raises(KeyError):
238 with pytest.raises(KeyError):
239 f.pop(type_str)
239 f.pop(type_str)
240 assert f.pop(type_str, None) is None
240 assert f.pop(type_str, None) is None
241
241
242
242
243 def test_error_method():
243 def test_error_method():
244 f = HTMLFormatter()
244 f = HTMLFormatter()
245 class BadHTML(object):
245 class BadHTML(object):
246 def _repr_html_(self):
246 def _repr_html_(self):
247 raise ValueError("Bad HTML")
247 raise ValueError("Bad HTML")
248 bad = BadHTML()
248 bad = BadHTML()
249 with capture_output() as captured:
249 with capture_output() as captured:
250 result = f(bad)
250 result = f(bad)
251 assert result is None
251 assert result is None
252 assert "Traceback" in captured.stdout
252 assert "Traceback" in captured.stdout
253 assert "Bad HTML" in captured.stdout
253 assert "Bad HTML" in captured.stdout
254 assert "_repr_html_" in captured.stdout
254 assert "_repr_html_" in captured.stdout
255
255
256 def test_nowarn_notimplemented():
256 def test_nowarn_notimplemented():
257 f = HTMLFormatter()
257 f = HTMLFormatter()
258 class HTMLNotImplemented(object):
258 class HTMLNotImplemented(object):
259 def _repr_html_(self):
259 def _repr_html_(self):
260 raise NotImplementedError
260 raise NotImplementedError
261 h = HTMLNotImplemented()
261 h = HTMLNotImplemented()
262 with capture_output() as captured:
262 with capture_output() as captured:
263 result = f(h)
263 result = f(h)
264 assert result is None
264 assert result is None
265 assert "" == captured.stderr
265 assert "" == captured.stderr
266 assert "" == captured.stdout
266 assert "" == captured.stdout
267
267
268
268
269 def test_warn_error_for_type():
269 def test_warn_error_for_type():
270 f = HTMLFormatter()
270 f = HTMLFormatter()
271 f.for_type(int, lambda i: name_error)
271 f.for_type(int, lambda i: name_error)
272 with capture_output() as captured:
272 with capture_output() as captured:
273 result = f(5)
273 result = f(5)
274 assert result is None
274 assert result is None
275 assert "Traceback" in captured.stdout
275 assert "Traceback" in captured.stdout
276 assert "NameError" in captured.stdout
276 assert "NameError" in captured.stdout
277 assert "name_error" in captured.stdout
277 assert "name_error" in captured.stdout
278
278
279 def test_error_pretty_method():
279 def test_error_pretty_method():
280 f = PlainTextFormatter()
280 f = PlainTextFormatter()
281 class BadPretty(object):
281 class BadPretty(object):
282 def _repr_pretty_(self):
282 def _repr_pretty_(self):
283 return "hello"
283 return "hello"
284 bad = BadPretty()
284 bad = BadPretty()
285 with capture_output() as captured:
285 with capture_output() as captured:
286 result = f(bad)
286 result = f(bad)
287 assert result is None
287 assert result is None
288 assert "Traceback" in captured.stdout
288 assert "Traceback" in captured.stdout
289 assert "_repr_pretty_" in captured.stdout
289 assert "_repr_pretty_" in captured.stdout
290 assert "given" in captured.stdout
290 assert "given" in captured.stdout
291 assert "argument" in captured.stdout
291 assert "argument" in captured.stdout
292
292
293
293
294 def test_bad_repr_traceback():
294 def test_bad_repr_traceback():
295 f = PlainTextFormatter()
295 f = PlainTextFormatter()
296 bad = BadRepr()
296 bad = BadRepr()
297 with capture_output() as captured:
297 with capture_output() as captured:
298 result = f(bad)
298 result = f(bad)
299 # catches error, returns None
299 # catches error, returns None
300 assert result is None
300 assert result is None
301 assert "Traceback" in captured.stdout
301 assert "Traceback" in captured.stdout
302 assert "__repr__" in captured.stdout
302 assert "__repr__" in captured.stdout
303 assert "ValueError" in captured.stdout
303 assert "ValueError" in captured.stdout
304
304
305
305
306 class MakePDF(object):
306 class MakePDF(object):
307 def _repr_pdf_(self):
307 def _repr_pdf_(self):
308 return 'PDF'
308 return 'PDF'
309
309
310 def test_pdf_formatter():
310 def test_pdf_formatter():
311 pdf = MakePDF()
311 pdf = MakePDF()
312 f = PDFFormatter()
312 f = PDFFormatter()
313 assert f(pdf) == "PDF"
313 assert f(pdf) == "PDF"
314
314
315
315
316 def test_print_method_bound():
316 def test_print_method_bound():
317 f = HTMLFormatter()
317 f = HTMLFormatter()
318 class MyHTML(object):
318 class MyHTML(object):
319 def _repr_html_(self):
319 def _repr_html_(self):
320 return "hello"
320 return "hello"
321 with capture_output() as captured:
321 with capture_output() as captured:
322 result = f(MyHTML)
322 result = f(MyHTML)
323 assert result is None
323 assert result is None
324 assert "FormatterWarning" not in captured.stderr
324 assert "FormatterWarning" not in captured.stderr
325
325
326 with capture_output() as captured:
326 with capture_output() as captured:
327 result = f(MyHTML())
327 result = f(MyHTML())
328 assert result == "hello"
328 assert result == "hello"
329 assert captured.stderr == ""
329 assert captured.stderr == ""
330
330
331
331
332 def test_print_method_weird():
332 def test_print_method_weird():
333
333
334 class TextMagicHat(object):
334 class TextMagicHat(object):
335 def __getattr__(self, key):
335 def __getattr__(self, key):
336 return key
336 return key
337
337
338 f = HTMLFormatter()
338 f = HTMLFormatter()
339
339
340 text_hat = TextMagicHat()
340 text_hat = TextMagicHat()
341 assert text_hat._repr_html_ == "_repr_html_"
341 assert text_hat._repr_html_ == "_repr_html_"
342 with capture_output() as captured:
342 with capture_output() as captured:
343 result = f(text_hat)
343 result = f(text_hat)
344
344
345 assert result is None
345 assert result is None
346 assert "FormatterWarning" not in captured.stderr
346 assert "FormatterWarning" not in captured.stderr
347
347
348 class CallableMagicHat(object):
348 class CallableMagicHat(object):
349 def __getattr__(self, key):
349 def __getattr__(self, key):
350 return lambda : key
350 return lambda : key
351
351
352 call_hat = CallableMagicHat()
352 call_hat = CallableMagicHat()
353 with capture_output() as captured:
353 with capture_output() as captured:
354 result = f(call_hat)
354 result = f(call_hat)
355
355
356 assert result is None
356 assert result is None
357
357
358 class BadReprArgs(object):
358 class BadReprArgs(object):
359 def _repr_html_(self, extra, args):
359 def _repr_html_(self, extra, args):
360 return "html"
360 return "html"
361
361
362 bad = BadReprArgs()
362 bad = BadReprArgs()
363 with capture_output() as captured:
363 with capture_output() as captured:
364 result = f(bad)
364 result = f(bad)
365
365
366 assert result is None
366 assert result is None
367 assert "FormatterWarning" not in captured.stderr
367 assert "FormatterWarning" not in captured.stderr
368
368
369
369
370 def test_format_config():
370 def test_format_config():
371 """config objects don't pretend to support fancy reprs with lazy attrs"""
371 """config objects don't pretend to support fancy reprs with lazy attrs"""
372 f = HTMLFormatter()
372 f = HTMLFormatter()
373 cfg = Config()
373 cfg = Config()
374 with capture_output() as captured:
374 with capture_output() as captured:
375 result = f(cfg)
375 result = f(cfg)
376 assert result is None
376 assert result is None
377 assert captured.stderr == ""
377 assert captured.stderr == ""
378
378
379 with capture_output() as captured:
379 with capture_output() as captured:
380 result = f(Config)
380 result = f(Config)
381 assert result is None
381 assert result is None
382 assert captured.stderr == ""
382 assert captured.stderr == ""
383
383
384
384
385 def test_pretty_max_seq_length():
385 def test_pretty_max_seq_length():
386 f = PlainTextFormatter(max_seq_length=1)
386 f = PlainTextFormatter(max_seq_length=1)
387 lis = list(range(3))
387 lis = list(range(3))
388 text = f(lis)
388 text = f(lis)
389 assert text == "[0, ...]"
389 assert text == "[0, ...]"
390 f.max_seq_length = 0
390 f.max_seq_length = 0
391 text = f(lis)
391 text = f(lis)
392 assert text == "[0, 1, 2]"
392 assert text == "[0, 1, 2]"
393 text = f(list(range(1024)))
393 text = f(list(range(1024)))
394 lines = text.splitlines()
394 lines = text.splitlines()
395 assert len(lines) == 1024
395 assert len(lines) == 1024
396
396
397
397
398 def test_ipython_display_formatter():
398 def test_ipython_display_formatter():
399 """Objects with _ipython_display_ defined bypass other formatters"""
399 """Objects with _ipython_display_ defined bypass other formatters"""
400 f = get_ipython().display_formatter
400 f = get_ipython().display_formatter
401 catcher = []
401 catcher = []
402 class SelfDisplaying(object):
402 class SelfDisplaying(object):
403 def _ipython_display_(self):
403 def _ipython_display_(self):
404 catcher.append(self)
404 catcher.append(self)
405
405
406 class NotSelfDisplaying(object):
406 class NotSelfDisplaying(object):
407 def __repr__(self):
407 def __repr__(self):
408 return "NotSelfDisplaying"
408 return "NotSelfDisplaying"
409
409
410 def _ipython_display_(self):
410 def _ipython_display_(self):
411 raise NotImplementedError
411 raise NotImplementedError
412
412
413 save_enabled = f.ipython_display_formatter.enabled
413 save_enabled = f.ipython_display_formatter.enabled
414 f.ipython_display_formatter.enabled = True
414 f.ipython_display_formatter.enabled = True
415
415
416 yes = SelfDisplaying()
416 yes = SelfDisplaying()
417 no = NotSelfDisplaying()
417 no = NotSelfDisplaying()
418
418
419 d, md = f.format(no)
419 d, md = f.format(no)
420 assert d == {"text/plain": repr(no)}
420 assert d == {"text/plain": repr(no)}
421 assert md == {}
421 assert md == {}
422 assert catcher == []
422 assert catcher == []
423
423
424 d, md = f.format(yes)
424 d, md = f.format(yes)
425 assert d == {}
425 assert d == {}
426 assert md == {}
426 assert md == {}
427 assert catcher == [yes]
427 assert catcher == [yes]
428
428
429 f.ipython_display_formatter.enabled = save_enabled
429 f.ipython_display_formatter.enabled = save_enabled
430
430
431
431
432 def test_repr_mime():
432 def test_repr_mime():
433 class HasReprMime(object):
433 class HasReprMime(object):
434 def _repr_mimebundle_(self, include=None, exclude=None):
434 def _repr_mimebundle_(self, include=None, exclude=None):
435 return {
435 return {
436 'application/json+test.v2': {
436 'application/json+test.v2': {
437 'x': 'y'
437 'x': 'y'
438 },
438 },
439 'plain/text' : '<HasReprMime>',
439 'plain/text' : '<HasReprMime>',
440 'image/png' : 'i-overwrite'
440 'image/png' : 'i-overwrite'
441 }
441 }
442
442
443 def _repr_png_(self):
443 def _repr_png_(self):
444 return 'should-be-overwritten'
444 return 'should-be-overwritten'
445 def _repr_html_(self):
445 def _repr_html_(self):
446 return '<b>hi!</b>'
446 return '<b>hi!</b>'
447
447
448 f = get_ipython().display_formatter
448 f = get_ipython().display_formatter
449 html_f = f.formatters['text/html']
449 html_f = f.formatters['text/html']
450 save_enabled = html_f.enabled
450 save_enabled = html_f.enabled
451 html_f.enabled = True
451 html_f.enabled = True
452 obj = HasReprMime()
452 obj = HasReprMime()
453 d, md = f.format(obj)
453 d, md = f.format(obj)
454 html_f.enabled = save_enabled
454 html_f.enabled = save_enabled
455
455
456 assert sorted(d) == [
456 assert sorted(d) == [
457 "application/json+test.v2",
457 "application/json+test.v2",
458 "image/png",
458 "image/png",
459 "plain/text",
459 "plain/text",
460 "text/html",
460 "text/html",
461 "text/plain",
461 "text/plain",
462 ]
462 ]
463 assert md == {}
463 assert md == {}
464
464
465 d, md = f.format(obj, include={"image/png"})
465 d, md = f.format(obj, include={"image/png"})
466 assert list(d.keys()) == [
466 assert list(d.keys()) == [
467 "image/png"
467 "image/png"
468 ], "Include should filter out even things from repr_mimebundle"
468 ], "Include should filter out even things from repr_mimebundle"
469
469
470 assert d["image/png"] == "i-overwrite", "_repr_mimebundle_ take precedence"
470 assert d["image/png"] == "i-overwrite", "_repr_mimebundle_ take precedence"
471
471
472
472
473 def test_pass_correct_include_exclude():
473 def test_pass_correct_include_exclude():
474 class Tester(object):
474 class Tester(object):
475
475
476 def __init__(self, include=None, exclude=None):
476 def __init__(self, include=None, exclude=None):
477 self.include = include
477 self.include = include
478 self.exclude = exclude
478 self.exclude = exclude
479
479
480 def _repr_mimebundle_(self, include, exclude, **kwargs):
480 def _repr_mimebundle_(self, include, exclude, **kwargs):
481 if include and (include != self.include):
481 if include and (include != self.include):
482 raise ValueError('include got modified: display() may be broken.')
482 raise ValueError('include got modified: display() may be broken.')
483 if exclude and (exclude != self.exclude):
483 if exclude and (exclude != self.exclude):
484 raise ValueError('exclude got modified: display() may be broken.')
484 raise ValueError('exclude got modified: display() may be broken.')
485
485
486 return None
486 return None
487
487
488 include = {'a', 'b', 'c'}
488 include = {'a', 'b', 'c'}
489 exclude = {'c', 'e' , 'f'}
489 exclude = {'c', 'e' , 'f'}
490
490
491 f = get_ipython().display_formatter
491 f = get_ipython().display_formatter
492 f.format(Tester(include=include, exclude=exclude), include=include, exclude=exclude)
492 f.format(Tester(include=include, exclude=exclude), include=include, exclude=exclude)
493 f.format(Tester(exclude=exclude), exclude=exclude)
493 f.format(Tester(exclude=exclude), exclude=exclude)
494 f.format(Tester(include=include), include=include)
494 f.format(Tester(include=include), include=include)
495
495
496
496
497 def test_repr_mime_meta():
497 def test_repr_mime_meta():
498 class HasReprMimeMeta(object):
498 class HasReprMimeMeta(object):
499 def _repr_mimebundle_(self, include=None, exclude=None):
499 def _repr_mimebundle_(self, include=None, exclude=None):
500 data = {
500 data = {
501 'image/png': 'base64-image-data',
501 'image/png': 'base64-image-data',
502 }
502 }
503 metadata = {
503 metadata = {
504 'image/png': {
504 'image/png': {
505 'width': 5,
505 'width': 5,
506 'height': 10,
506 'height': 10,
507 }
507 }
508 }
508 }
509 return (data, metadata)
509 return (data, metadata)
510
510
511 f = get_ipython().display_formatter
511 f = get_ipython().display_formatter
512 obj = HasReprMimeMeta()
512 obj = HasReprMimeMeta()
513 d, md = f.format(obj)
513 d, md = f.format(obj)
514 assert sorted(d) == ["image/png", "text/plain"]
514 assert sorted(d) == ["image/png", "text/plain"]
515 assert md == {
515 assert md == {
516 "image/png": {
516 "image/png": {
517 "width": 5,
517 "width": 5,
518 "height": 10,
518 "height": 10,
519 }
519 }
520 }
520 }
521
521
522
522
523 def test_repr_mime_failure():
523 def test_repr_mime_failure():
524 class BadReprMime(object):
524 class BadReprMime(object):
525 def _repr_mimebundle_(self, include=None, exclude=None):
525 def _repr_mimebundle_(self, include=None, exclude=None):
526 raise RuntimeError
526 raise RuntimeError
527
527
528 f = get_ipython().display_formatter
528 f = get_ipython().display_formatter
529 obj = BadReprMime()
529 obj = BadReprMime()
530 d, md = f.format(obj)
530 d, md = f.format(obj)
531 assert "text/plain" in d
531 assert "text/plain" in d
532
532
533
533
534 def test_custom_repr_namedtuple_partialmethod():
534 def test_custom_repr_namedtuple_partialmethod():
535 from functools import partialmethod
535 from functools import partialmethod
536 from typing import NamedTuple
536 from typing import NamedTuple
537
537
538 class Foo(NamedTuple):
538 class Foo(NamedTuple): ...
539 ...
540
539
541 Foo.__repr__ = partialmethod(lambda obj: "Hello World")
540 Foo.__repr__ = partialmethod(lambda obj: "Hello World")
542 foo = Foo()
541 foo = Foo()
543
542
544 f = PlainTextFormatter()
543 f = PlainTextFormatter()
545 assert f.pprint
544 assert f.pprint
546 assert f(foo) == "Hello World"
545 assert f(foo) == "Hello World"
@@ -1,11 +1,11
1 # encoding: utf-8
1 # encoding: utf-8
2 """
2 """
3 Extra capabilities for IPython
3 Extra capabilities for IPython
4 """
4 """
5
5
6 #-----------------------------------------------------------------------------
6 # -----------------------------------------------------------------------------
7 # Copyright (C) 2008-2011 The IPython Development Team
7 # Copyright (C) 2008-2011 The IPython Development Team
8 #
8 #
9 # Distributed under the terms of the BSD License. The full license is in
9 # Distributed under the terms of the BSD License. The full license is in
10 # the file COPYING, distributed as part of this software.
10 # the file COPYING, distributed as part of this software.
11 #-----------------------------------------------------------------------------
11 # -----------------------------------------------------------------------------
@@ -1,10 +1,10
1 # encoding: utf-8
1 # encoding: utf-8
2 __docformat__ = "restructuredtext en"
2 __docformat__ = "restructuredtext en"
3 #-------------------------------------------------------------------------------
3 # -------------------------------------------------------------------------------
4 # Copyright (C) 2005 Fernando Perez <fperez@colorado.edu>
4 # Copyright (C) 2005 Fernando Perez <fperez@colorado.edu>
5 # Brian E Granger <ellisonbg@gmail.com>
5 # Brian E Granger <ellisonbg@gmail.com>
6 # Benjamin Ragan-Kelley <benjaminrk@gmail.com>
6 # Benjamin Ragan-Kelley <benjaminrk@gmail.com>
7 #
7 #
8 # Distributed under the terms of the BSD License. The full license is in
8 # Distributed under the terms of the BSD License. The full license is in
9 # the file COPYING, distributed as part of this software.
9 # the file COPYING, distributed as part of this software.
10 #-------------------------------------------------------------------------------
10 # -------------------------------------------------------------------------------
@@ -1,69 +1,71
1 """cli-specific implementation of process utilities.
1 """cli-specific implementation of process utilities.
2
2
3 cli - Common Language Infrastructure for IronPython. Code
3 cli - Common Language Infrastructure for IronPython. Code
4 can run on any operating system. Check os.name for os-
4 can run on any operating system. Check os.name for os-
5 specific settings.
5 specific settings.
6
6
7 This file is only meant to be imported by process.py, not by end-users.
7 This file is only meant to be imported by process.py, not by end-users.
8
8
9 This file is largely untested. To become a full drop-in process
9 This file is largely untested. To become a full drop-in process
10 interface for IronPython will probably require you to help fill
10 interface for IronPython will probably require you to help fill
11 in the details.
11 in the details.
12 """
12 """
13
13
14 # Import cli libraries:
14 # Import cli libraries:
15 import clr
15 import clr
16 import System
16 import System
17
17
18 # Import Python libraries:
18 # Import Python libraries:
19 import os
19 import os
20
20
21 # Import IPython libraries:
21 # Import IPython libraries:
22 from ._process_common import arg_split
22 from ._process_common import arg_split
23
23
24
24
25 def system(cmd):
25 def system(cmd):
26 """
26 """
27 system(cmd) should work in a cli environment on Mac OSX, Linux,
27 system(cmd) should work in a cli environment on Mac OSX, Linux,
28 and Windows
28 and Windows
29 """
29 """
30 psi = System.Diagnostics.ProcessStartInfo(cmd)
30 psi = System.Diagnostics.ProcessStartInfo(cmd)
31 psi.RedirectStandardOutput = True
31 psi.RedirectStandardOutput = True
32 psi.RedirectStandardError = True
32 psi.RedirectStandardError = True
33 psi.WindowStyle = System.Diagnostics.ProcessWindowStyle.Normal
33 psi.WindowStyle = System.Diagnostics.ProcessWindowStyle.Normal
34 psi.UseShellExecute = False
34 psi.UseShellExecute = False
35 # Start up process:
35 # Start up process:
36 reg = System.Diagnostics.Process.Start(psi)
36 reg = System.Diagnostics.Process.Start(psi)
37
37
38
38 def getoutput(cmd):
39 def getoutput(cmd):
39 """
40 """
40 getoutput(cmd) should work in a cli environment on Mac OSX, Linux,
41 getoutput(cmd) should work in a cli environment on Mac OSX, Linux,
41 and Windows
42 and Windows
42 """
43 """
43 psi = System.Diagnostics.ProcessStartInfo(cmd)
44 psi = System.Diagnostics.ProcessStartInfo(cmd)
44 psi.RedirectStandardOutput = True
45 psi.RedirectStandardOutput = True
45 psi.RedirectStandardError = True
46 psi.RedirectStandardError = True
46 psi.WindowStyle = System.Diagnostics.ProcessWindowStyle.Normal
47 psi.WindowStyle = System.Diagnostics.ProcessWindowStyle.Normal
47 psi.UseShellExecute = False
48 psi.UseShellExecute = False
48 # Start up process:
49 # Start up process:
49 reg = System.Diagnostics.Process.Start(psi)
50 reg = System.Diagnostics.Process.Start(psi)
50 myOutput = reg.StandardOutput
51 myOutput = reg.StandardOutput
51 output = myOutput.ReadToEnd()
52 output = myOutput.ReadToEnd()
52 myError = reg.StandardError
53 myError = reg.StandardError
53 error = myError.ReadToEnd()
54 error = myError.ReadToEnd()
54 return output
55 return output
55
56
57
56 def check_pid(pid):
58 def check_pid(pid):
57 """
59 """
58 Check if a process with the given PID (pid) exists
60 Check if a process with the given PID (pid) exists
59 """
61 """
60 try:
62 try:
61 System.Diagnostics.Process.GetProcessById(pid)
63 System.Diagnostics.Process.GetProcessById(pid)
62 # process with given pid is running
64 # process with given pid is running
63 return True
65 return True
64 except System.InvalidOperationException:
66 except System.InvalidOperationException:
65 # process wasn't started by this object (but is running)
67 # process wasn't started by this object (but is running)
66 return True
68 return True
67 except System.ArgumentException:
69 except System.ArgumentException:
68 # process with given pid isn't running
70 # process with given pid isn't running
69 return False
71 return False
@@ -1,84 +1,84
1 # encoding: utf-8
1 # encoding: utf-8
2 """A fancy version of Python's builtin :func:`dir` function.
2 """A fancy version of Python's builtin :func:`dir` function.
3 """
3 """
4
4
5 # Copyright (c) IPython Development Team.
5 # Copyright (c) IPython Development Team.
6 # Distributed under the terms of the Modified BSD License.
6 # Distributed under the terms of the Modified BSD License.
7
7
8 import inspect
8 import inspect
9 import types
9 import types
10
10
11
11
12 def safe_hasattr(obj, attr):
12 def safe_hasattr(obj, attr):
13 """In recent versions of Python, hasattr() only catches AttributeError.
13 """In recent versions of Python, hasattr() only catches AttributeError.
14 This catches all errors.
14 This catches all errors.
15 """
15 """
16 try:
16 try:
17 getattr(obj, attr)
17 getattr(obj, attr)
18 return True
18 return True
19 except:
19 except:
20 return False
20 return False
21
21
22
22
23 def dir2(obj):
23 def dir2(obj):
24 """dir2(obj) -> list of strings
24 """dir2(obj) -> list of strings
25
25
26 Extended version of the Python builtin dir(), which does a few extra
26 Extended version of the Python builtin dir(), which does a few extra
27 checks.
27 checks.
28
28
29 This version is guaranteed to return only a list of true strings, whereas
29 This version is guaranteed to return only a list of true strings, whereas
30 dir() returns anything that objects inject into themselves, even if they
30 dir() returns anything that objects inject into themselves, even if they
31 are later not really valid for attribute access (many extension libraries
31 are later not really valid for attribute access (many extension libraries
32 have such bugs).
32 have such bugs).
33 """
33 """
34
34
35 # Start building the attribute list via dir(), and then complete it
35 # Start building the attribute list via dir(), and then complete it
36 # with a few extra special-purpose calls.
36 # with a few extra special-purpose calls.
37
37
38 try:
38 try:
39 words = set(dir(obj))
39 words = set(dir(obj))
40 except Exception:
40 except Exception:
41 # TypeError: dir(obj) does not return a list
41 # TypeError: dir(obj) does not return a list
42 words = set()
42 words = set()
43
43
44 if safe_hasattr(obj, '__class__'):
44 if safe_hasattr(obj, "__class__"):
45 words |= set(dir(obj.__class__))
45 words |= set(dir(obj.__class__))
46
46
47 # filter out non-string attributes which may be stuffed by dir() calls
47 # filter out non-string attributes which may be stuffed by dir() calls
48 # and poor coding in third-party modules
48 # and poor coding in third-party modules
49
49
50 words = [w for w in words if isinstance(w, str)]
50 words = [w for w in words if isinstance(w, str)]
51 return sorted(words)
51 return sorted(words)
52
52
53
53
54 def get_real_method(obj, name):
54 def get_real_method(obj, name):
55 """Like getattr, but with a few extra sanity checks:
55 """Like getattr, but with a few extra sanity checks:
56
56
57 - If obj is a class, ignore everything except class methods
57 - If obj is a class, ignore everything except class methods
58 - Check if obj is a proxy that claims to have all attributes
58 - Check if obj is a proxy that claims to have all attributes
59 - Catch attribute access failing with any exception
59 - Catch attribute access failing with any exception
60 - Check that the attribute is a callable object
60 - Check that the attribute is a callable object
61
61
62 Returns the method or None.
62 Returns the method or None.
63 """
63 """
64 try:
64 try:
65 canary = getattr(obj, '_ipython_canary_method_should_not_exist_', None)
65 canary = getattr(obj, "_ipython_canary_method_should_not_exist_", None)
66 except Exception:
66 except Exception:
67 return None
67 return None
68
68
69 if canary is not None:
69 if canary is not None:
70 # It claimed to have an attribute it should never have
70 # It claimed to have an attribute it should never have
71 return None
71 return None
72
72
73 try:
73 try:
74 m = getattr(obj, name, None)
74 m = getattr(obj, name, None)
75 except Exception:
75 except Exception:
76 return None
76 return None
77
77
78 if inspect.isclass(obj) and not isinstance(m, types.MethodType):
78 if inspect.isclass(obj) and not isinstance(m, types.MethodType):
79 return None
79 return None
80
80
81 if callable(m):
81 if callable(m):
82 return m
82 return m
83
83
84 return None
84 return None
General Comments 0
You need to be logged in to leave comments. Login now