Show More
The requested changes are too big and content was truncated. Show full diff
@@ -1,2089 +1,2089 b'' | |||
|
1 | 1 | """Completion for IPython. |
|
2 | 2 | |
|
3 | 3 | This module started as fork of the rlcompleter module in the Python standard |
|
4 | 4 | library. The original enhancements made to rlcompleter have been sent |
|
5 | 5 | upstream and were accepted as of Python 2.3, |
|
6 | 6 | |
|
7 | 7 | This module now support a wide variety of completion mechanism both available |
|
8 | 8 | for normal classic Python code, as well as completer for IPython specific |
|
9 | 9 | Syntax like magics. |
|
10 | 10 | |
|
11 | 11 | Latex and Unicode completion |
|
12 | 12 | ============================ |
|
13 | 13 | |
|
14 | 14 | IPython and compatible frontends not only can complete your code, but can help |
|
15 | 15 | you to input a wide range of characters. In particular we allow you to insert |
|
16 | 16 | a unicode character using the tab completion mechanism. |
|
17 | 17 | |
|
18 | 18 | Forward latex/unicode completion |
|
19 | 19 | -------------------------------- |
|
20 | 20 | |
|
21 | 21 | Forward completion allows you to easily type a unicode character using its latex |
|
22 | 22 | name, or unicode long description. To do so type a backslash follow by the |
|
23 | 23 | relevant name and press tab: |
|
24 | 24 | |
|
25 | 25 | |
|
26 | 26 | Using latex completion: |
|
27 | 27 | |
|
28 | 28 | .. code:: |
|
29 | 29 | |
|
30 | 30 | \\alpha<tab> |
|
31 | 31 | Ξ± |
|
32 | 32 | |
|
33 | 33 | or using unicode completion: |
|
34 | 34 | |
|
35 | 35 | |
|
36 | 36 | .. code:: |
|
37 | 37 | |
|
38 | 38 | \\greek small letter alpha<tab> |
|
39 | 39 | Ξ± |
|
40 | 40 | |
|
41 | 41 | |
|
42 | 42 | Only valid Python identifiers will complete. Combining characters (like arrow or |
|
43 | 43 | dots) are also available, unlike latex they need to be put after the their |
|
44 | 44 | counterpart that is to say, `F\\\\vec<tab>` is correct, not `\\\\vec<tab>F`. |
|
45 | 45 | |
|
46 | 46 | Some browsers are known to display combining characters incorrectly. |
|
47 | 47 | |
|
48 | 48 | Backward latex completion |
|
49 | 49 | ------------------------- |
|
50 | 50 | |
|
51 | 51 | It is sometime challenging to know how to type a character, if you are using |
|
52 | 52 | IPython, or any compatible frontend you can prepend backslash to the character |
|
53 | 53 | and press `<tab>` to expand it to its latex form. |
|
54 | 54 | |
|
55 | 55 | .. code:: |
|
56 | 56 | |
|
57 | 57 | \\Ξ±<tab> |
|
58 | 58 | \\alpha |
|
59 | 59 | |
|
60 | 60 | |
|
61 | 61 | Both forward and backward completions can be deactivated by setting the |
|
62 | 62 | ``Completer.backslash_combining_completions`` option to ``False``. |
|
63 | 63 | |
|
64 | 64 | |
|
65 | 65 | Experimental |
|
66 | 66 | ============ |
|
67 | 67 | |
|
68 | 68 | Starting with IPython 6.0, this module can make use of the Jedi library to |
|
69 | 69 | generate completions both using static analysis of the code, and dynamically |
|
70 | 70 | inspecting multiple namespaces. Jedi is an autocompletion and static analysis |
|
71 | 71 | for Python. The APIs attached to this new mechanism is unstable and will |
|
72 | 72 | raise unless use in an :any:`provisionalcompleter` context manager. |
|
73 | 73 | |
|
74 | 74 | You will find that the following are experimental: |
|
75 | 75 | |
|
76 | 76 | - :any:`provisionalcompleter` |
|
77 | 77 | - :any:`IPCompleter.completions` |
|
78 | 78 | - :any:`Completion` |
|
79 | 79 | - :any:`rectify_completions` |
|
80 | 80 | |
|
81 | 81 | .. note:: |
|
82 | 82 | |
|
83 | 83 | better name for :any:`rectify_completions` ? |
|
84 | 84 | |
|
85 | 85 | We welcome any feedback on these new API, and we also encourage you to try this |
|
86 | 86 | module in debug mode (start IPython with ``--Completer.debug=True``) in order |
|
87 | 87 | to have extra logging information if :any:`jedi` is crashing, or if current |
|
88 | 88 | IPython completer pending deprecations are returning results not yet handled |
|
89 | 89 | by :any:`jedi` |
|
90 | 90 | |
|
91 | 91 | Using Jedi for tab completion allow snippets like the following to work without |
|
92 | 92 | having to execute any code: |
|
93 | 93 | |
|
94 | 94 | >>> myvar = ['hello', 42] |
|
95 | 95 | ... myvar[1].bi<tab> |
|
96 | 96 | |
|
97 | 97 | Tab completion will be able to infer that ``myvar[1]`` is a real number without |
|
98 | 98 | executing any code unlike the previously available ``IPCompleter.greedy`` |
|
99 | 99 | option. |
|
100 | 100 | |
|
101 | 101 | Be sure to update :any:`jedi` to the latest stable version or to try the |
|
102 | 102 | current development version to get better completions. |
|
103 | 103 | """ |
|
104 | 104 | |
|
105 | 105 | |
|
106 | 106 | # Copyright (c) IPython Development Team. |
|
107 | 107 | # Distributed under the terms of the Modified BSD License. |
|
108 | 108 | # |
|
109 | 109 | # Some of this code originated from rlcompleter in the Python standard library |
|
110 | 110 | # Copyright (C) 2001 Python Software Foundation, www.python.org |
|
111 | 111 | |
|
112 | 112 | |
|
113 | 113 | import __main__ |
|
114 | 114 | import builtins as builtin_mod |
|
115 | 115 | import glob |
|
116 | 116 | import time |
|
117 | 117 | import inspect |
|
118 | 118 | import itertools |
|
119 | 119 | import keyword |
|
120 | 120 | import os |
|
121 | 121 | import re |
|
122 | 122 | import sys |
|
123 | 123 | import unicodedata |
|
124 | 124 | import string |
|
125 | 125 | import warnings |
|
126 | 126 | |
|
127 | 127 | from contextlib import contextmanager |
|
128 | 128 | from importlib import import_module |
|
129 |
from typing import Iterator, List, Tuple, Iterable |
|
|
129 | from typing import Iterator, List, Tuple, Iterable | |
|
130 | 130 | from types import SimpleNamespace |
|
131 | 131 | |
|
132 | 132 | from traitlets.config.configurable import Configurable |
|
133 | 133 | from IPython.core.error import TryNext |
|
134 | 134 | from IPython.core.inputtransformer2 import ESC_MAGIC |
|
135 | 135 | from IPython.core.latex_symbols import latex_symbols, reverse_latex_symbol |
|
136 | 136 | from IPython.core.oinspect import InspectColors |
|
137 | 137 | from IPython.utils import generics |
|
138 | 138 | from IPython.utils.dir2 import dir2, get_real_method |
|
139 | 139 | from IPython.utils.process import arg_split |
|
140 | 140 | from traitlets import Bool, Enum, observe, Int |
|
141 | 141 | |
|
142 | 142 | # skip module docstests |
|
143 | 143 | skip_doctest = True |
|
144 | 144 | |
|
145 | 145 | try: |
|
146 | 146 | import jedi |
|
147 | 147 | jedi.settings.case_insensitive_completion = False |
|
148 | 148 | import jedi.api.helpers |
|
149 | 149 | import jedi.api.classes |
|
150 | 150 | JEDI_INSTALLED = True |
|
151 | 151 | except ImportError: |
|
152 | 152 | JEDI_INSTALLED = False |
|
153 | 153 | #----------------------------------------------------------------------------- |
|
154 | 154 | # Globals |
|
155 | 155 | #----------------------------------------------------------------------------- |
|
156 | 156 | |
|
157 | 157 | # Public API |
|
158 | 158 | __all__ = ['Completer','IPCompleter'] |
|
159 | 159 | |
|
160 | 160 | if sys.platform == 'win32': |
|
161 | 161 | PROTECTABLES = ' ' |
|
162 | 162 | else: |
|
163 | 163 | PROTECTABLES = ' ()[]{}?=\\|;:\'#*"^&' |
|
164 | 164 | |
|
165 | 165 | # Protect against returning an enormous number of completions which the frontend |
|
166 | 166 | # may have trouble processing. |
|
167 | 167 | MATCHES_LIMIT = 500 |
|
168 | 168 | |
|
169 | 169 | _deprecation_readline_sentinel = object() |
|
170 | 170 | |
|
171 | 171 | |
|
172 | 172 | class ProvisionalCompleterWarning(FutureWarning): |
|
173 | 173 | """ |
|
174 | 174 | Exception raise by an experimental feature in this module. |
|
175 | 175 | |
|
176 | 176 | Wrap code in :any:`provisionalcompleter` context manager if you |
|
177 | 177 | are certain you want to use an unstable feature. |
|
178 | 178 | """ |
|
179 | 179 | pass |
|
180 | 180 | |
|
181 | 181 | warnings.filterwarnings('error', category=ProvisionalCompleterWarning) |
|
182 | 182 | |
|
183 | 183 | @contextmanager |
|
184 | 184 | def provisionalcompleter(action='ignore'): |
|
185 | 185 | """ |
|
186 | 186 | |
|
187 | 187 | |
|
188 | 188 | This context manager has to be used in any place where unstable completer |
|
189 | 189 | behavior and API may be called. |
|
190 | 190 | |
|
191 | 191 | >>> with provisionalcompleter(): |
|
192 | 192 | ... completer.do_experimental_things() # works |
|
193 | 193 | |
|
194 | 194 | >>> completer.do_experimental_things() # raises. |
|
195 | 195 | |
|
196 | 196 | .. note:: Unstable |
|
197 | 197 | |
|
198 | 198 | By using this context manager you agree that the API in use may change |
|
199 | 199 | without warning, and that you won't complain if they do so. |
|
200 | 200 | |
|
201 | 201 | You also understand that, if the API is not to your liking, you should report |
|
202 | 202 | a bug to explain your use case upstream. |
|
203 | 203 | |
|
204 | 204 | We'll be happy to get your feedback, feature requests, and improvements on |
|
205 | 205 | any of the unstable APIs! |
|
206 | 206 | """ |
|
207 | 207 | with warnings.catch_warnings(): |
|
208 | 208 | warnings.filterwarnings(action, category=ProvisionalCompleterWarning) |
|
209 | 209 | yield |
|
210 | 210 | |
|
211 | 211 | |
|
212 | 212 | def has_open_quotes(s): |
|
213 | 213 | """Return whether a string has open quotes. |
|
214 | 214 | |
|
215 | 215 | This simply counts whether the number of quote characters of either type in |
|
216 | 216 | the string is odd. |
|
217 | 217 | |
|
218 | 218 | Returns |
|
219 | 219 | ------- |
|
220 | 220 | If there is an open quote, the quote character is returned. Else, return |
|
221 | 221 | False. |
|
222 | 222 | """ |
|
223 | 223 | # We check " first, then ', so complex cases with nested quotes will get |
|
224 | 224 | # the " to take precedence. |
|
225 | 225 | if s.count('"') % 2: |
|
226 | 226 | return '"' |
|
227 | 227 | elif s.count("'") % 2: |
|
228 | 228 | return "'" |
|
229 | 229 | else: |
|
230 | 230 | return False |
|
231 | 231 | |
|
232 | 232 | |
|
233 | 233 | def protect_filename(s, protectables=PROTECTABLES): |
|
234 | 234 | """Escape a string to protect certain characters.""" |
|
235 | 235 | if set(s) & set(protectables): |
|
236 | 236 | if sys.platform == "win32": |
|
237 | 237 | return '"' + s + '"' |
|
238 | 238 | else: |
|
239 | 239 | return "".join(("\\" + c if c in protectables else c) for c in s) |
|
240 | 240 | else: |
|
241 | 241 | return s |
|
242 | 242 | |
|
243 | 243 | |
|
244 | 244 | def expand_user(path:str) -> Tuple[str, bool, str]: |
|
245 | 245 | """Expand ``~``-style usernames in strings. |
|
246 | 246 | |
|
247 | 247 | This is similar to :func:`os.path.expanduser`, but it computes and returns |
|
248 | 248 | extra information that will be useful if the input was being used in |
|
249 | 249 | computing completions, and you wish to return the completions with the |
|
250 | 250 | original '~' instead of its expanded value. |
|
251 | 251 | |
|
252 | 252 | Parameters |
|
253 | 253 | ---------- |
|
254 | 254 | path : str |
|
255 | 255 | String to be expanded. If no ~ is present, the output is the same as the |
|
256 | 256 | input. |
|
257 | 257 | |
|
258 | 258 | Returns |
|
259 | 259 | ------- |
|
260 | 260 | newpath : str |
|
261 | 261 | Result of ~ expansion in the input path. |
|
262 | 262 | tilde_expand : bool |
|
263 | 263 | Whether any expansion was performed or not. |
|
264 | 264 | tilde_val : str |
|
265 | 265 | The value that ~ was replaced with. |
|
266 | 266 | """ |
|
267 | 267 | # Default values |
|
268 | 268 | tilde_expand = False |
|
269 | 269 | tilde_val = '' |
|
270 | 270 | newpath = path |
|
271 | 271 | |
|
272 | 272 | if path.startswith('~'): |
|
273 | 273 | tilde_expand = True |
|
274 | 274 | rest = len(path)-1 |
|
275 | 275 | newpath = os.path.expanduser(path) |
|
276 | 276 | if rest: |
|
277 | 277 | tilde_val = newpath[:-rest] |
|
278 | 278 | else: |
|
279 | 279 | tilde_val = newpath |
|
280 | 280 | |
|
281 | 281 | return newpath, tilde_expand, tilde_val |
|
282 | 282 | |
|
283 | 283 | |
|
284 | 284 | def compress_user(path:str, tilde_expand:bool, tilde_val:str) -> str: |
|
285 | 285 | """Does the opposite of expand_user, with its outputs. |
|
286 | 286 | """ |
|
287 | 287 | if tilde_expand: |
|
288 | 288 | return path.replace(tilde_val, '~') |
|
289 | 289 | else: |
|
290 | 290 | return path |
|
291 | 291 | |
|
292 | 292 | |
|
293 | 293 | def completions_sorting_key(word): |
|
294 | 294 | """key for sorting completions |
|
295 | 295 | |
|
296 | 296 | This does several things: |
|
297 | 297 | |
|
298 | 298 | - Demote any completions starting with underscores to the end |
|
299 | 299 | - Insert any %magic and %%cellmagic completions in the alphabetical order |
|
300 | 300 | by their name |
|
301 | 301 | """ |
|
302 | 302 | prio1, prio2 = 0, 0 |
|
303 | 303 | |
|
304 | 304 | if word.startswith('__'): |
|
305 | 305 | prio1 = 2 |
|
306 | 306 | elif word.startswith('_'): |
|
307 | 307 | prio1 = 1 |
|
308 | 308 | |
|
309 | 309 | if word.endswith('='): |
|
310 | 310 | prio1 = -1 |
|
311 | 311 | |
|
312 | 312 | if word.startswith('%%'): |
|
313 | 313 | # If there's another % in there, this is something else, so leave it alone |
|
314 | 314 | if not "%" in word[2:]: |
|
315 | 315 | word = word[2:] |
|
316 | 316 | prio2 = 2 |
|
317 | 317 | elif word.startswith('%'): |
|
318 | 318 | if not "%" in word[1:]: |
|
319 | 319 | word = word[1:] |
|
320 | 320 | prio2 = 1 |
|
321 | 321 | |
|
322 | 322 | return prio1, word, prio2 |
|
323 | 323 | |
|
324 | 324 | |
|
325 | 325 | class _FakeJediCompletion: |
|
326 | 326 | """ |
|
327 | 327 | This is a workaround to communicate to the UI that Jedi has crashed and to |
|
328 | 328 | report a bug. Will be used only id :any:`IPCompleter.debug` is set to true. |
|
329 | 329 | |
|
330 | 330 | Added in IPython 6.0 so should likely be removed for 7.0 |
|
331 | 331 | |
|
332 | 332 | """ |
|
333 | 333 | |
|
334 | 334 | def __init__(self, name): |
|
335 | 335 | |
|
336 | 336 | self.name = name |
|
337 | 337 | self.complete = name |
|
338 | 338 | self.type = 'crashed' |
|
339 | 339 | self.name_with_symbols = name |
|
340 | 340 | self.signature = '' |
|
341 | 341 | self._origin = 'fake' |
|
342 | 342 | |
|
343 | 343 | def __repr__(self): |
|
344 | 344 | return '<Fake completion object jedi has crashed>' |
|
345 | 345 | |
|
346 | 346 | |
|
347 | 347 | class Completion: |
|
348 | 348 | """ |
|
349 | 349 | Completion object used and return by IPython completers. |
|
350 | 350 | |
|
351 | 351 | .. warning:: Unstable |
|
352 | 352 | |
|
353 | 353 | This function is unstable, API may change without warning. |
|
354 | 354 | It will also raise unless use in proper context manager. |
|
355 | 355 | |
|
356 | 356 | This act as a middle ground :any:`Completion` object between the |
|
357 | 357 | :any:`jedi.api.classes.Completion` object and the Prompt Toolkit completion |
|
358 | 358 | object. While Jedi need a lot of information about evaluator and how the |
|
359 | 359 | code should be ran/inspected, PromptToolkit (and other frontend) mostly |
|
360 | 360 | need user facing information. |
|
361 | 361 | |
|
362 | 362 | - Which range should be replaced replaced by what. |
|
363 | 363 | - Some metadata (like completion type), or meta information to displayed to |
|
364 | 364 | the use user. |
|
365 | 365 | |
|
366 | 366 | For debugging purpose we can also store the origin of the completion (``jedi``, |
|
367 | 367 | ``IPython.python_matches``, ``IPython.magics_matches``...). |
|
368 | 368 | """ |
|
369 | 369 | |
|
370 | 370 | __slots__ = ['start', 'end', 'text', 'type', 'signature', '_origin'] |
|
371 | 371 | |
|
372 | 372 | def __init__(self, start: int, end: int, text: str, *, type: str=None, _origin='', signature='') -> None: |
|
373 | 373 | warnings.warn("``Completion`` is a provisional API (as of IPython 6.0). " |
|
374 | 374 | "It may change without warnings. " |
|
375 | 375 | "Use in corresponding context manager.", |
|
376 | 376 | category=ProvisionalCompleterWarning, stacklevel=2) |
|
377 | 377 | |
|
378 | 378 | self.start = start |
|
379 | 379 | self.end = end |
|
380 | 380 | self.text = text |
|
381 | 381 | self.type = type |
|
382 | 382 | self.signature = signature |
|
383 | 383 | self._origin = _origin |
|
384 | 384 | |
|
385 | 385 | def __repr__(self): |
|
386 | 386 | return '<Completion start=%s end=%s text=%r type=%r, signature=%r,>' % \ |
|
387 | 387 | (self.start, self.end, self.text, self.type or '?', self.signature or '?') |
|
388 | 388 | |
|
389 | 389 | def __eq__(self, other)->Bool: |
|
390 | 390 | """ |
|
391 | 391 | Equality and hash do not hash the type (as some completer may not be |
|
392 | 392 | able to infer the type), but are use to (partially) de-duplicate |
|
393 | 393 | completion. |
|
394 | 394 | |
|
395 | 395 | Completely de-duplicating completion is a bit tricker that just |
|
396 | 396 | comparing as it depends on surrounding text, which Completions are not |
|
397 | 397 | aware of. |
|
398 | 398 | """ |
|
399 | 399 | return self.start == other.start and \ |
|
400 | 400 | self.end == other.end and \ |
|
401 | 401 | self.text == other.text |
|
402 | 402 | |
|
403 | 403 | def __hash__(self): |
|
404 | 404 | return hash((self.start, self.end, self.text)) |
|
405 | 405 | |
|
406 | 406 | |
|
407 | 407 | _IC = Iterable[Completion] |
|
408 | 408 | |
|
409 | 409 | |
|
410 | 410 | def _deduplicate_completions(text: str, completions: _IC)-> _IC: |
|
411 | 411 | """ |
|
412 | 412 | Deduplicate a set of completions. |
|
413 | 413 | |
|
414 | 414 | .. warning:: Unstable |
|
415 | 415 | |
|
416 | 416 | This function is unstable, API may change without warning. |
|
417 | 417 | |
|
418 | 418 | Parameters |
|
419 | 419 | ---------- |
|
420 | 420 | text: str |
|
421 | 421 | text that should be completed. |
|
422 | 422 | completions: Iterator[Completion] |
|
423 | 423 | iterator over the completions to deduplicate |
|
424 | 424 | |
|
425 | 425 | Yields |
|
426 | 426 | ------ |
|
427 | 427 | `Completions` objects |
|
428 | 428 | |
|
429 | 429 | |
|
430 | 430 | Completions coming from multiple sources, may be different but end up having |
|
431 | 431 | the same effect when applied to ``text``. If this is the case, this will |
|
432 | 432 | consider completions as equal and only emit the first encountered. |
|
433 | 433 | |
|
434 | 434 | Not folded in `completions()` yet for debugging purpose, and to detect when |
|
435 | 435 | the IPython completer does return things that Jedi does not, but should be |
|
436 | 436 | at some point. |
|
437 | 437 | """ |
|
438 | 438 | completions = list(completions) |
|
439 | 439 | if not completions: |
|
440 | 440 | return |
|
441 | 441 | |
|
442 | 442 | new_start = min(c.start for c in completions) |
|
443 | 443 | new_end = max(c.end for c in completions) |
|
444 | 444 | |
|
445 | 445 | seen = set() |
|
446 | 446 | for c in completions: |
|
447 | 447 | new_text = text[new_start:c.start] + c.text + text[c.end:new_end] |
|
448 | 448 | if new_text not in seen: |
|
449 | 449 | yield c |
|
450 | 450 | seen.add(new_text) |
|
451 | 451 | |
|
452 | 452 | |
|
453 | 453 | def rectify_completions(text: str, completions: _IC, *, _debug=False)->_IC: |
|
454 | 454 | """ |
|
455 | 455 | Rectify a set of completions to all have the same ``start`` and ``end`` |
|
456 | 456 | |
|
457 | 457 | .. warning:: Unstable |
|
458 | 458 | |
|
459 | 459 | This function is unstable, API may change without warning. |
|
460 | 460 | It will also raise unless use in proper context manager. |
|
461 | 461 | |
|
462 | 462 | Parameters |
|
463 | 463 | ---------- |
|
464 | 464 | text: str |
|
465 | 465 | text that should be completed. |
|
466 | 466 | completions: Iterator[Completion] |
|
467 | 467 | iterator over the completions to rectify |
|
468 | 468 | |
|
469 | 469 | |
|
470 | 470 | :any:`jedi.api.classes.Completion` s returned by Jedi may not have the same start and end, though |
|
471 | 471 | the Jupyter Protocol requires them to behave like so. This will readjust |
|
472 | 472 | the completion to have the same ``start`` and ``end`` by padding both |
|
473 | 473 | extremities with surrounding text. |
|
474 | 474 | |
|
475 | 475 | During stabilisation should support a ``_debug`` option to log which |
|
476 | 476 | completion are return by the IPython completer and not found in Jedi in |
|
477 | 477 | order to make upstream bug report. |
|
478 | 478 | """ |
|
479 | 479 | warnings.warn("`rectify_completions` is a provisional API (as of IPython 6.0). " |
|
480 | 480 | "It may change without warnings. " |
|
481 | 481 | "Use in corresponding context manager.", |
|
482 | 482 | category=ProvisionalCompleterWarning, stacklevel=2) |
|
483 | 483 | |
|
484 | 484 | completions = list(completions) |
|
485 | 485 | if not completions: |
|
486 | 486 | return |
|
487 | 487 | starts = (c.start for c in completions) |
|
488 | 488 | ends = (c.end for c in completions) |
|
489 | 489 | |
|
490 | 490 | new_start = min(starts) |
|
491 | 491 | new_end = max(ends) |
|
492 | 492 | |
|
493 | 493 | seen_jedi = set() |
|
494 | 494 | seen_python_matches = set() |
|
495 | 495 | for c in completions: |
|
496 | 496 | new_text = text[new_start:c.start] + c.text + text[c.end:new_end] |
|
497 | 497 | if c._origin == 'jedi': |
|
498 | 498 | seen_jedi.add(new_text) |
|
499 | 499 | elif c._origin == 'IPCompleter.python_matches': |
|
500 | 500 | seen_python_matches.add(new_text) |
|
501 | 501 | yield Completion(new_start, new_end, new_text, type=c.type, _origin=c._origin, signature=c.signature) |
|
502 | 502 | diff = seen_python_matches.difference(seen_jedi) |
|
503 | 503 | if diff and _debug: |
|
504 | 504 | print('IPython.python matches have extras:', diff) |
|
505 | 505 | |
|
506 | 506 | |
|
507 | 507 | if sys.platform == 'win32': |
|
508 | 508 | DELIMS = ' \t\n`!@#$^&*()=+[{]}|;\'",<>?' |
|
509 | 509 | else: |
|
510 | 510 | DELIMS = ' \t\n`!@#$^&*()=+[{]}\\|;:\'",<>?' |
|
511 | 511 | |
|
512 | 512 | GREEDY_DELIMS = ' =\r\n' |
|
513 | 513 | |
|
514 | 514 | |
|
515 | 515 | class CompletionSplitter(object): |
|
516 | 516 | """An object to split an input line in a manner similar to readline. |
|
517 | 517 | |
|
518 | 518 | By having our own implementation, we can expose readline-like completion in |
|
519 | 519 | a uniform manner to all frontends. This object only needs to be given the |
|
520 | 520 | line of text to be split and the cursor position on said line, and it |
|
521 | 521 | returns the 'word' to be completed on at the cursor after splitting the |
|
522 | 522 | entire line. |
|
523 | 523 | |
|
524 | 524 | What characters are used as splitting delimiters can be controlled by |
|
525 | 525 | setting the ``delims`` attribute (this is a property that internally |
|
526 | 526 | automatically builds the necessary regular expression)""" |
|
527 | 527 | |
|
528 | 528 | # Private interface |
|
529 | 529 | |
|
530 | 530 | # A string of delimiter characters. The default value makes sense for |
|
531 | 531 | # IPython's most typical usage patterns. |
|
532 | 532 | _delims = DELIMS |
|
533 | 533 | |
|
534 | 534 | # The expression (a normal string) to be compiled into a regular expression |
|
535 | 535 | # for actual splitting. We store it as an attribute mostly for ease of |
|
536 | 536 | # debugging, since this type of code can be so tricky to debug. |
|
537 | 537 | _delim_expr = None |
|
538 | 538 | |
|
539 | 539 | # The regular expression that does the actual splitting |
|
540 | 540 | _delim_re = None |
|
541 | 541 | |
|
542 | 542 | def __init__(self, delims=None): |
|
543 | 543 | delims = CompletionSplitter._delims if delims is None else delims |
|
544 | 544 | self.delims = delims |
|
545 | 545 | |
|
546 | 546 | @property |
|
547 | 547 | def delims(self): |
|
548 | 548 | """Return the string of delimiter characters.""" |
|
549 | 549 | return self._delims |
|
550 | 550 | |
|
551 | 551 | @delims.setter |
|
552 | 552 | def delims(self, delims): |
|
553 | 553 | """Set the delimiters for line splitting.""" |
|
554 | 554 | expr = '[' + ''.join('\\'+ c for c in delims) + ']' |
|
555 | 555 | self._delim_re = re.compile(expr) |
|
556 | 556 | self._delims = delims |
|
557 | 557 | self._delim_expr = expr |
|
558 | 558 | |
|
559 | 559 | def split_line(self, line, cursor_pos=None): |
|
560 | 560 | """Split a line of text with a cursor at the given position. |
|
561 | 561 | """ |
|
562 | 562 | l = line if cursor_pos is None else line[:cursor_pos] |
|
563 | 563 | return self._delim_re.split(l)[-1] |
|
564 | 564 | |
|
565 | 565 | |
|
566 | 566 | |
|
567 | 567 | class Completer(Configurable): |
|
568 | 568 | |
|
569 | 569 | greedy = Bool(False, |
|
570 | 570 | help="""Activate greedy completion |
|
571 | 571 | PENDING DEPRECTION. this is now mostly taken care of with Jedi. |
|
572 | 572 | |
|
573 | 573 | This will enable completion on elements of lists, results of function calls, etc., |
|
574 | 574 | but can be unsafe because the code is actually evaluated on TAB. |
|
575 | 575 | """ |
|
576 | 576 | ).tag(config=True) |
|
577 | 577 | |
|
578 | 578 | use_jedi = Bool(default_value=JEDI_INSTALLED, |
|
579 | 579 | help="Experimental: Use Jedi to generate autocompletions. " |
|
580 | 580 | "Default to True if jedi is installed.").tag(config=True) |
|
581 | 581 | |
|
582 | 582 | jedi_compute_type_timeout = Int(default_value=400, |
|
583 | 583 | help="""Experimental: restrict time (in milliseconds) during which Jedi can compute types. |
|
584 | 584 | Set to 0 to stop computing types. Non-zero value lower than 100ms may hurt |
|
585 | 585 | performance by preventing jedi to build its cache. |
|
586 | 586 | """).tag(config=True) |
|
587 | 587 | |
|
588 | 588 | debug = Bool(default_value=False, |
|
589 | 589 | help='Enable debug for the Completer. Mostly print extra ' |
|
590 | 590 | 'information for experimental jedi integration.')\ |
|
591 | 591 | .tag(config=True) |
|
592 | 592 | |
|
593 | 593 | backslash_combining_completions = Bool(True, |
|
594 | 594 | help="Enable unicode completions, e.g. \\alpha<tab> . " |
|
595 | 595 | "Includes completion of latex commands, unicode names, and expanding " |
|
596 | 596 | "unicode characters back to latex commands.").tag(config=True) |
|
597 | 597 | |
|
598 | 598 | |
|
599 | 599 | |
|
600 | 600 | def __init__(self, namespace=None, global_namespace=None, **kwargs): |
|
601 | 601 | """Create a new completer for the command line. |
|
602 | 602 | |
|
603 | 603 | Completer(namespace=ns, global_namespace=ns2) -> completer instance. |
|
604 | 604 | |
|
605 | 605 | If unspecified, the default namespace where completions are performed |
|
606 | 606 | is __main__ (technically, __main__.__dict__). Namespaces should be |
|
607 | 607 | given as dictionaries. |
|
608 | 608 | |
|
609 | 609 | An optional second namespace can be given. This allows the completer |
|
610 | 610 | to handle cases where both the local and global scopes need to be |
|
611 | 611 | distinguished. |
|
612 | 612 | """ |
|
613 | 613 | |
|
614 | 614 | # Don't bind to namespace quite yet, but flag whether the user wants a |
|
615 | 615 | # specific namespace or to use __main__.__dict__. This will allow us |
|
616 | 616 | # to bind to __main__.__dict__ at completion time, not now. |
|
617 | 617 | if namespace is None: |
|
618 | 618 | self.use_main_ns = True |
|
619 | 619 | else: |
|
620 | 620 | self.use_main_ns = False |
|
621 | 621 | self.namespace = namespace |
|
622 | 622 | |
|
623 | 623 | # The global namespace, if given, can be bound directly |
|
624 | 624 | if global_namespace is None: |
|
625 | 625 | self.global_namespace = {} |
|
626 | 626 | else: |
|
627 | 627 | self.global_namespace = global_namespace |
|
628 | 628 | |
|
629 | 629 | super(Completer, self).__init__(**kwargs) |
|
630 | 630 | |
|
631 | 631 | def complete(self, text, state): |
|
632 | 632 | """Return the next possible completion for 'text'. |
|
633 | 633 | |
|
634 | 634 | This is called successively with state == 0, 1, 2, ... until it |
|
635 | 635 | returns None. The completion should begin with 'text'. |
|
636 | 636 | |
|
637 | 637 | """ |
|
638 | 638 | if self.use_main_ns: |
|
639 | 639 | self.namespace = __main__.__dict__ |
|
640 | 640 | |
|
641 | 641 | if state == 0: |
|
642 | 642 | if "." in text: |
|
643 | 643 | self.matches = self.attr_matches(text) |
|
644 | 644 | else: |
|
645 | 645 | self.matches = self.global_matches(text) |
|
646 | 646 | try: |
|
647 | 647 | return self.matches[state] |
|
648 | 648 | except IndexError: |
|
649 | 649 | return None |
|
650 | 650 | |
|
651 | 651 | def global_matches(self, text): |
|
652 | 652 | """Compute matches when text is a simple name. |
|
653 | 653 | |
|
654 | 654 | Return a list of all keywords, built-in functions and names currently |
|
655 | 655 | defined in self.namespace or self.global_namespace that match. |
|
656 | 656 | |
|
657 | 657 | """ |
|
658 | 658 | matches = [] |
|
659 | 659 | match_append = matches.append |
|
660 | 660 | n = len(text) |
|
661 | 661 | for lst in [keyword.kwlist, |
|
662 | 662 | builtin_mod.__dict__.keys(), |
|
663 | 663 | self.namespace.keys(), |
|
664 | 664 | self.global_namespace.keys()]: |
|
665 | 665 | for word in lst: |
|
666 | 666 | if word[:n] == text and word != "__builtins__": |
|
667 | 667 | match_append(word) |
|
668 | 668 | |
|
669 | 669 | snake_case_re = re.compile(r"[^_]+(_[^_]+)+?\Z") |
|
670 | 670 | for lst in [self.namespace.keys(), |
|
671 | 671 | self.global_namespace.keys()]: |
|
672 | 672 | shortened = {"_".join([sub[0] for sub in word.split('_')]) : word |
|
673 | 673 | for word in lst if snake_case_re.match(word)} |
|
674 | 674 | for word in shortened.keys(): |
|
675 | 675 | if word[:n] == text and word != "__builtins__": |
|
676 | 676 | match_append(shortened[word]) |
|
677 | 677 | return matches |
|
678 | 678 | |
|
679 | 679 | def attr_matches(self, text): |
|
680 | 680 | """Compute matches when text contains a dot. |
|
681 | 681 | |
|
682 | 682 | Assuming the text is of the form NAME.NAME....[NAME], and is |
|
683 | 683 | evaluatable in self.namespace or self.global_namespace, it will be |
|
684 | 684 | evaluated and its attributes (as revealed by dir()) are used as |
|
685 | 685 | possible completions. (For class instances, class members are |
|
686 | 686 | also considered.) |
|
687 | 687 | |
|
688 | 688 | WARNING: this can still invoke arbitrary C code, if an object |
|
689 | 689 | with a __getattr__ hook is evaluated. |
|
690 | 690 | |
|
691 | 691 | """ |
|
692 | 692 | |
|
693 | 693 | # Another option, seems to work great. Catches things like ''.<tab> |
|
694 | 694 | m = re.match(r"(\S+(\.\w+)*)\.(\w*)$", text) |
|
695 | 695 | |
|
696 | 696 | if m: |
|
697 | 697 | expr, attr = m.group(1, 3) |
|
698 | 698 | elif self.greedy: |
|
699 | 699 | m2 = re.match(r"(.+)\.(\w*)$", self.line_buffer) |
|
700 | 700 | if not m2: |
|
701 | 701 | return [] |
|
702 | 702 | expr, attr = m2.group(1,2) |
|
703 | 703 | else: |
|
704 | 704 | return [] |
|
705 | 705 | |
|
706 | 706 | try: |
|
707 | 707 | obj = eval(expr, self.namespace) |
|
708 | 708 | except: |
|
709 | 709 | try: |
|
710 | 710 | obj = eval(expr, self.global_namespace) |
|
711 | 711 | except: |
|
712 | 712 | return [] |
|
713 | 713 | |
|
714 | 714 | if self.limit_to__all__ and hasattr(obj, '__all__'): |
|
715 | 715 | words = get__all__entries(obj) |
|
716 | 716 | else: |
|
717 | 717 | words = dir2(obj) |
|
718 | 718 | |
|
719 | 719 | try: |
|
720 | 720 | words = generics.complete_object(obj, words) |
|
721 | 721 | except TryNext: |
|
722 | 722 | pass |
|
723 | 723 | except AssertionError: |
|
724 | 724 | raise |
|
725 | 725 | except Exception: |
|
726 | 726 | # Silence errors from completion function |
|
727 | 727 | #raise # dbg |
|
728 | 728 | pass |
|
729 | 729 | # Build match list to return |
|
730 | 730 | n = len(attr) |
|
731 | 731 | return [u"%s.%s" % (expr, w) for w in words if w[:n] == attr ] |
|
732 | 732 | |
|
733 | 733 | |
|
734 | 734 | def get__all__entries(obj): |
|
735 | 735 | """returns the strings in the __all__ attribute""" |
|
736 | 736 | try: |
|
737 | 737 | words = getattr(obj, '__all__') |
|
738 | 738 | except: |
|
739 | 739 | return [] |
|
740 | 740 | |
|
741 | 741 | return [w for w in words if isinstance(w, str)] |
|
742 | 742 | |
|
743 | 743 | |
|
744 | 744 | def match_dict_keys(keys: List[str], prefix: str, delims: str): |
|
745 | 745 | """Used by dict_key_matches, matching the prefix to a list of keys |
|
746 | 746 | |
|
747 | 747 | Parameters |
|
748 | 748 | ========== |
|
749 | 749 | keys: |
|
750 | 750 | list of keys in dictionary currently being completed. |
|
751 | 751 | prefix: |
|
752 | 752 | Part of the text already typed by the user. e.g. `mydict[b'fo` |
|
753 | 753 | delims: |
|
754 | 754 | String of delimiters to consider when finding the current key. |
|
755 | 755 | |
|
756 | 756 | Returns |
|
757 | 757 | ======= |
|
758 | 758 | |
|
759 | 759 | A tuple of three elements: ``quote``, ``token_start``, ``matched``, with |
|
760 | 760 | ``quote`` being the quote that need to be used to close current string. |
|
761 | 761 | ``token_start`` the position where the replacement should start occurring, |
|
762 | 762 | ``matches`` a list of replacement/completion |
|
763 | 763 | |
|
764 | 764 | """ |
|
765 | 765 | if not prefix: |
|
766 | 766 | return None, 0, [repr(k) for k in keys |
|
767 | 767 | if isinstance(k, (str, bytes))] |
|
768 | 768 | quote_match = re.search('["\']', prefix) |
|
769 | 769 | quote = quote_match.group() |
|
770 | 770 | try: |
|
771 | 771 | prefix_str = eval(prefix + quote, {}) |
|
772 | 772 | except Exception: |
|
773 | 773 | return None, 0, [] |
|
774 | 774 | |
|
775 | 775 | pattern = '[^' + ''.join('\\' + c for c in delims) + ']*$' |
|
776 | 776 | token_match = re.search(pattern, prefix, re.UNICODE) |
|
777 | 777 | token_start = token_match.start() |
|
778 | 778 | token_prefix = token_match.group() |
|
779 | 779 | |
|
780 | 780 | matched = [] |
|
781 | 781 | for key in keys: |
|
782 | 782 | try: |
|
783 | 783 | if not key.startswith(prefix_str): |
|
784 | 784 | continue |
|
785 | 785 | except (AttributeError, TypeError, UnicodeError): |
|
786 | 786 | # Python 3+ TypeError on b'a'.startswith('a') or vice-versa |
|
787 | 787 | continue |
|
788 | 788 | |
|
789 | 789 | # reformat remainder of key to begin with prefix |
|
790 | 790 | rem = key[len(prefix_str):] |
|
791 | 791 | # force repr wrapped in ' |
|
792 | 792 | rem_repr = repr(rem + '"') if isinstance(rem, str) else repr(rem + b'"') |
|
793 | 793 | if rem_repr.startswith('u') and prefix[0] not in 'uU': |
|
794 | 794 | # Found key is unicode, but prefix is Py2 string. |
|
795 | 795 | # Therefore attempt to interpret key as string. |
|
796 | 796 | try: |
|
797 | 797 | rem_repr = repr(rem.encode('ascii') + '"') |
|
798 | 798 | except UnicodeEncodeError: |
|
799 | 799 | continue |
|
800 | 800 | |
|
801 | 801 | rem_repr = rem_repr[1 + rem_repr.index("'"):-2] |
|
802 | 802 | if quote == '"': |
|
803 | 803 | # The entered prefix is quoted with ", |
|
804 | 804 | # but the match is quoted with '. |
|
805 | 805 | # A contained " hence needs escaping for comparison: |
|
806 | 806 | rem_repr = rem_repr.replace('"', '\\"') |
|
807 | 807 | |
|
808 | 808 | # then reinsert prefix from start of token |
|
809 | 809 | matched.append('%s%s' % (token_prefix, rem_repr)) |
|
810 | 810 | return quote, token_start, matched |
|
811 | 811 | |
|
812 | 812 | |
|
813 | 813 | def cursor_to_position(text:str, line:int, column:int)->int: |
|
814 | 814 | """ |
|
815 | 815 | |
|
816 | 816 | Convert the (line,column) position of the cursor in text to an offset in a |
|
817 | 817 | string. |
|
818 | 818 | |
|
819 | 819 | Parameters |
|
820 | 820 | ---------- |
|
821 | 821 | |
|
822 | 822 | text : str |
|
823 | 823 | The text in which to calculate the cursor offset |
|
824 | 824 | line : int |
|
825 | 825 | Line of the cursor; 0-indexed |
|
826 | 826 | column : int |
|
827 | 827 | Column of the cursor 0-indexed |
|
828 | 828 | |
|
829 | 829 | Return |
|
830 | 830 | ------ |
|
831 | 831 | Position of the cursor in ``text``, 0-indexed. |
|
832 | 832 | |
|
833 | 833 | See Also |
|
834 | 834 | -------- |
|
835 | 835 | position_to_cursor: reciprocal of this function |
|
836 | 836 | |
|
837 | 837 | """ |
|
838 | 838 | lines = text.split('\n') |
|
839 | 839 | assert line <= len(lines), '{} <= {}'.format(str(line), str(len(lines))) |
|
840 | 840 | |
|
841 | 841 | return sum(len(l) + 1 for l in lines[:line]) + column |
|
842 | 842 | |
|
843 | 843 | def position_to_cursor(text:str, offset:int)->Tuple[int, int]: |
|
844 | 844 | """ |
|
845 | 845 | Convert the position of the cursor in text (0 indexed) to a line |
|
846 | 846 | number(0-indexed) and a column number (0-indexed) pair |
|
847 | 847 | |
|
848 | 848 | Position should be a valid position in ``text``. |
|
849 | 849 | |
|
850 | 850 | Parameters |
|
851 | 851 | ---------- |
|
852 | 852 | |
|
853 | 853 | text : str |
|
854 | 854 | The text in which to calculate the cursor offset |
|
855 | 855 | offset : int |
|
856 | 856 | Position of the cursor in ``text``, 0-indexed. |
|
857 | 857 | |
|
858 | 858 | Return |
|
859 | 859 | ------ |
|
860 | 860 | (line, column) : (int, int) |
|
861 | 861 | Line of the cursor; 0-indexed, column of the cursor 0-indexed |
|
862 | 862 | |
|
863 | 863 | |
|
864 | 864 | See Also |
|
865 | 865 | -------- |
|
866 | 866 | cursor_to_position : reciprocal of this function |
|
867 | 867 | |
|
868 | 868 | |
|
869 | 869 | """ |
|
870 | 870 | |
|
871 | 871 | assert 0 <= offset <= len(text) , "0 <= %s <= %s" % (offset , len(text)) |
|
872 | 872 | |
|
873 | 873 | before = text[:offset] |
|
874 | 874 | blines = before.split('\n') # ! splitnes trim trailing \n |
|
875 | 875 | line = before.count('\n') |
|
876 | 876 | col = len(blines[-1]) |
|
877 | 877 | return line, col |
|
878 | 878 | |
|
879 | 879 | |
|
880 | 880 | def _safe_isinstance(obj, module, class_name): |
|
881 | 881 | """Checks if obj is an instance of module.class_name if loaded |
|
882 | 882 | """ |
|
883 | 883 | return (module in sys.modules and |
|
884 | 884 | isinstance(obj, getattr(import_module(module), class_name))) |
|
885 | 885 | |
|
886 | 886 | |
|
887 | 887 | def back_unicode_name_matches(text): |
|
888 | 888 | u"""Match unicode characters back to unicode name |
|
889 | 889 | |
|
890 | 890 | This does ``β`` -> ``\\snowman`` |
|
891 | 891 | |
|
892 | 892 | Note that snowman is not a valid python3 combining character but will be expanded. |
|
893 | 893 | Though it will not recombine back to the snowman character by the completion machinery. |
|
894 | 894 | |
|
895 | 895 | This will not either back-complete standard sequences like \\n, \\b ... |
|
896 | 896 | |
|
897 | 897 | Used on Python 3 only. |
|
898 | 898 | """ |
|
899 | 899 | if len(text)<2: |
|
900 | 900 | return u'', () |
|
901 | 901 | maybe_slash = text[-2] |
|
902 | 902 | if maybe_slash != '\\': |
|
903 | 903 | return u'', () |
|
904 | 904 | |
|
905 | 905 | char = text[-1] |
|
906 | 906 | # no expand on quote for completion in strings. |
|
907 | 907 | # nor backcomplete standard ascii keys |
|
908 | 908 | if char in string.ascii_letters or char in ['"',"'"]: |
|
909 | 909 | return u'', () |
|
910 | 910 | try : |
|
911 | 911 | unic = unicodedata.name(char) |
|
912 | 912 | return '\\'+char,['\\'+unic] |
|
913 | 913 | except KeyError: |
|
914 | 914 | pass |
|
915 | 915 | return u'', () |
|
916 | 916 | |
|
917 | 917 | def back_latex_name_matches(text:str): |
|
918 | 918 | """Match latex characters back to unicode name |
|
919 | 919 | |
|
920 | 920 | This does ``\\β΅`` -> ``\\aleph`` |
|
921 | 921 | |
|
922 | 922 | Used on Python 3 only. |
|
923 | 923 | """ |
|
924 | 924 | if len(text)<2: |
|
925 | 925 | return u'', () |
|
926 | 926 | maybe_slash = text[-2] |
|
927 | 927 | if maybe_slash != '\\': |
|
928 | 928 | return u'', () |
|
929 | 929 | |
|
930 | 930 | |
|
931 | 931 | char = text[-1] |
|
932 | 932 | # no expand on quote for completion in strings. |
|
933 | 933 | # nor backcomplete standard ascii keys |
|
934 | 934 | if char in string.ascii_letters or char in ['"',"'"]: |
|
935 | 935 | return u'', () |
|
936 | 936 | try : |
|
937 | 937 | latex = reverse_latex_symbol[char] |
|
938 | 938 | # '\\' replace the \ as well |
|
939 | 939 | return '\\'+char,[latex] |
|
940 | 940 | except KeyError: |
|
941 | 941 | pass |
|
942 | 942 | return u'', () |
|
943 | 943 | |
|
944 | 944 | |
|
945 | 945 | def _formatparamchildren(parameter) -> str: |
|
946 | 946 | """ |
|
947 | 947 | Get parameter name and value from Jedi Private API |
|
948 | 948 | |
|
949 | 949 | Jedi does not expose a simple way to get `param=value` from its API. |
|
950 | 950 | |
|
951 | 951 | Parameter |
|
952 | 952 | ========= |
|
953 | 953 | |
|
954 | 954 | parameter: |
|
955 | 955 | Jedi's function `Param` |
|
956 | 956 | |
|
957 | 957 | Returns |
|
958 | 958 | ======= |
|
959 | 959 | |
|
960 | 960 | A string like 'a', 'b=1', '*args', '**kwargs' |
|
961 | 961 | |
|
962 | 962 | |
|
963 | 963 | """ |
|
964 | 964 | description = parameter.description |
|
965 | 965 | if not description.startswith('param '): |
|
966 | 966 | raise ValueError('Jedi function parameter description have change format.' |
|
967 | 967 | 'Expected "param ...", found %r".' % description) |
|
968 | 968 | return description[6:] |
|
969 | 969 | |
|
970 | 970 | def _make_signature(completion)-> str: |
|
971 | 971 | """ |
|
972 | 972 | Make the signature from a jedi completion |
|
973 | 973 | |
|
974 | 974 | Parameter |
|
975 | 975 | ========= |
|
976 | 976 | |
|
977 | 977 | completion: jedi.Completion |
|
978 | 978 | object does not complete a function type |
|
979 | 979 | |
|
980 | 980 | Returns |
|
981 | 981 | ======= |
|
982 | 982 | |
|
983 | 983 | a string consisting of the function signature, with the parenthesis but |
|
984 | 984 | without the function name. example: |
|
985 | 985 | `(a, *args, b=1, **kwargs)` |
|
986 | 986 | |
|
987 | 987 | """ |
|
988 | 988 | |
|
989 | 989 | return '(%s)'% ', '.join([f for f in (_formatparamchildren(p) for p in completion.params) if f]) |
|
990 | 990 | |
|
991 | 991 | class IPCompleter(Completer): |
|
992 | 992 | """Extension of the completer class with IPython-specific features""" |
|
993 | 993 | |
|
994 | 994 | _names = None |
|
995 | 995 | |
|
996 | 996 | @observe('greedy') |
|
997 | 997 | def _greedy_changed(self, change): |
|
998 | 998 | """update the splitter and readline delims when greedy is changed""" |
|
999 | 999 | if change['new']: |
|
1000 | 1000 | self.splitter.delims = GREEDY_DELIMS |
|
1001 | 1001 | else: |
|
1002 | 1002 | self.splitter.delims = DELIMS |
|
1003 | 1003 | |
|
1004 | 1004 | dict_keys_only = Bool(False, |
|
1005 | 1005 | help="""Whether to show dict key matches only""") |
|
1006 | 1006 | |
|
1007 | 1007 | merge_completions = Bool(True, |
|
1008 | 1008 | help="""Whether to merge completion results into a single list |
|
1009 | 1009 | |
|
1010 | 1010 | If False, only the completion results from the first non-empty |
|
1011 | 1011 | completer will be returned. |
|
1012 | 1012 | """ |
|
1013 | 1013 | ).tag(config=True) |
|
1014 | 1014 | omit__names = Enum((0,1,2), default_value=2, |
|
1015 | 1015 | help="""Instruct the completer to omit private method names |
|
1016 | 1016 | |
|
1017 | 1017 | Specifically, when completing on ``object.<tab>``. |
|
1018 | 1018 | |
|
1019 | 1019 | When 2 [default]: all names that start with '_' will be excluded. |
|
1020 | 1020 | |
|
1021 | 1021 | When 1: all 'magic' names (``__foo__``) will be excluded. |
|
1022 | 1022 | |
|
1023 | 1023 | When 0: nothing will be excluded. |
|
1024 | 1024 | """ |
|
1025 | 1025 | ).tag(config=True) |
|
1026 | 1026 | limit_to__all__ = Bool(False, |
|
1027 | 1027 | help=""" |
|
1028 | 1028 | DEPRECATED as of version 5.0. |
|
1029 | 1029 | |
|
1030 | 1030 | Instruct the completer to use __all__ for the completion |
|
1031 | 1031 | |
|
1032 | 1032 | Specifically, when completing on ``object.<tab>``. |
|
1033 | 1033 | |
|
1034 | 1034 | When True: only those names in obj.__all__ will be included. |
|
1035 | 1035 | |
|
1036 | 1036 | When False [default]: the __all__ attribute is ignored |
|
1037 | 1037 | """, |
|
1038 | 1038 | ).tag(config=True) |
|
1039 | 1039 | |
|
1040 | 1040 | @observe('limit_to__all__') |
|
1041 | 1041 | def _limit_to_all_changed(self, change): |
|
1042 | 1042 | warnings.warn('`IPython.core.IPCompleter.limit_to__all__` configuration ' |
|
1043 | 1043 | 'value has been deprecated since IPython 5.0, will be made to have ' |
|
1044 | 1044 | 'no effects and then removed in future version of IPython.', |
|
1045 | 1045 | UserWarning) |
|
1046 | 1046 | |
|
1047 | 1047 | def __init__(self, shell=None, namespace=None, global_namespace=None, |
|
1048 | 1048 | use_readline=_deprecation_readline_sentinel, config=None, **kwargs): |
|
1049 | 1049 | """IPCompleter() -> completer |
|
1050 | 1050 | |
|
1051 | 1051 | Return a completer object. |
|
1052 | 1052 | |
|
1053 | 1053 | Parameters |
|
1054 | 1054 | ---------- |
|
1055 | 1055 | |
|
1056 | 1056 | shell |
|
1057 | 1057 | a pointer to the ipython shell itself. This is needed |
|
1058 | 1058 | because this completer knows about magic functions, and those can |
|
1059 | 1059 | only be accessed via the ipython instance. |
|
1060 | 1060 | |
|
1061 | 1061 | namespace : dict, optional |
|
1062 | 1062 | an optional dict where completions are performed. |
|
1063 | 1063 | |
|
1064 | 1064 | global_namespace : dict, optional |
|
1065 | 1065 | secondary optional dict for completions, to |
|
1066 | 1066 | handle cases (such as IPython embedded inside functions) where |
|
1067 | 1067 | both Python scopes are visible. |
|
1068 | 1068 | |
|
1069 | 1069 | use_readline : bool, optional |
|
1070 | 1070 | DEPRECATED, ignored since IPython 6.0, will have no effects |
|
1071 | 1071 | """ |
|
1072 | 1072 | |
|
1073 | 1073 | self.magic_escape = ESC_MAGIC |
|
1074 | 1074 | self.splitter = CompletionSplitter() |
|
1075 | 1075 | |
|
1076 | 1076 | if use_readline is not _deprecation_readline_sentinel: |
|
1077 | 1077 | warnings.warn('The `use_readline` parameter is deprecated and ignored since IPython 6.0.', |
|
1078 | 1078 | DeprecationWarning, stacklevel=2) |
|
1079 | 1079 | |
|
1080 | 1080 | # _greedy_changed() depends on splitter and readline being defined: |
|
1081 | 1081 | Completer.__init__(self, namespace=namespace, global_namespace=global_namespace, |
|
1082 | 1082 | config=config, **kwargs) |
|
1083 | 1083 | |
|
1084 | 1084 | # List where completion matches will be stored |
|
1085 | 1085 | self.matches = [] |
|
1086 | 1086 | self.shell = shell |
|
1087 | 1087 | # Regexp to split filenames with spaces in them |
|
1088 | 1088 | self.space_name_re = re.compile(r'([^\\] )') |
|
1089 | 1089 | # Hold a local ref. to glob.glob for speed |
|
1090 | 1090 | self.glob = glob.glob |
|
1091 | 1091 | |
|
1092 | 1092 | # Determine if we are running on 'dumb' terminals, like (X)Emacs |
|
1093 | 1093 | # buffers, to avoid completion problems. |
|
1094 | 1094 | term = os.environ.get('TERM','xterm') |
|
1095 | 1095 | self.dumb_terminal = term in ['dumb','emacs'] |
|
1096 | 1096 | |
|
1097 | 1097 | # Special handling of backslashes needed in win32 platforms |
|
1098 | 1098 | if sys.platform == "win32": |
|
1099 | 1099 | self.clean_glob = self._clean_glob_win32 |
|
1100 | 1100 | else: |
|
1101 | 1101 | self.clean_glob = self._clean_glob |
|
1102 | 1102 | |
|
1103 | 1103 | #regexp to parse docstring for function signature |
|
1104 | 1104 | self.docstring_sig_re = re.compile(r'^[\w|\s.]+\(([^)]*)\).*') |
|
1105 | 1105 | self.docstring_kwd_re = re.compile(r'[\s|\[]*(\w+)(?:\s*=\s*.*)') |
|
1106 | 1106 | #use this if positional argument name is also needed |
|
1107 | 1107 | #= re.compile(r'[\s|\[]*(\w+)(?:\s*=?\s*.*)') |
|
1108 | 1108 | |
|
1109 | 1109 | self.magic_arg_matchers = [ |
|
1110 | 1110 | self.magic_config_matches, |
|
1111 | 1111 | self.magic_color_matches, |
|
1112 | 1112 | ] |
|
1113 | 1113 | |
|
1114 | 1114 | # This is set externally by InteractiveShell |
|
1115 | 1115 | self.custom_completers = None |
|
1116 | 1116 | |
|
1117 | 1117 | @property |
|
1118 | 1118 | def matchers(self): |
|
1119 | 1119 | """All active matcher routines for completion""" |
|
1120 | 1120 | if self.dict_keys_only: |
|
1121 | 1121 | return [self.dict_key_matches] |
|
1122 | 1122 | |
|
1123 | 1123 | if self.use_jedi: |
|
1124 | 1124 | return [ |
|
1125 | 1125 | self.file_matches, |
|
1126 | 1126 | self.magic_matches, |
|
1127 | 1127 | self.dict_key_matches, |
|
1128 | 1128 | ] |
|
1129 | 1129 | else: |
|
1130 | 1130 | return [ |
|
1131 | 1131 | self.python_matches, |
|
1132 | 1132 | self.file_matches, |
|
1133 | 1133 | self.magic_matches, |
|
1134 | 1134 | self.python_func_kw_matches, |
|
1135 | 1135 | self.dict_key_matches, |
|
1136 | 1136 | ] |
|
1137 | 1137 | |
|
1138 | 1138 | def all_completions(self, text) -> List[str]: |
|
1139 | 1139 | """ |
|
1140 | 1140 | Wrapper around the completion methods for the benefit of emacs. |
|
1141 | 1141 | """ |
|
1142 | 1142 | prefix = text.rpartition('.')[0] |
|
1143 | 1143 | with provisionalcompleter(): |
|
1144 | 1144 | return ['.'.join([prefix, c.text]) if prefix and self.use_jedi else c.text |
|
1145 | 1145 | for c in self.completions(text, len(text))] |
|
1146 | 1146 | |
|
1147 | 1147 | return self.complete(text)[1] |
|
1148 | 1148 | |
|
1149 | 1149 | def _clean_glob(self, text): |
|
1150 | 1150 | return self.glob("%s*" % text) |
|
1151 | 1151 | |
|
1152 | 1152 | def _clean_glob_win32(self,text): |
|
1153 | 1153 | return [f.replace("\\","/") |
|
1154 | 1154 | for f in self.glob("%s*" % text)] |
|
1155 | 1155 | |
|
1156 | 1156 | def file_matches(self, text): |
|
1157 | 1157 | """Match filenames, expanding ~USER type strings. |
|
1158 | 1158 | |
|
1159 | 1159 | Most of the seemingly convoluted logic in this completer is an |
|
1160 | 1160 | attempt to handle filenames with spaces in them. And yet it's not |
|
1161 | 1161 | quite perfect, because Python's readline doesn't expose all of the |
|
1162 | 1162 | GNU readline details needed for this to be done correctly. |
|
1163 | 1163 | |
|
1164 | 1164 | For a filename with a space in it, the printed completions will be |
|
1165 | 1165 | only the parts after what's already been typed (instead of the |
|
1166 | 1166 | full completions, as is normally done). I don't think with the |
|
1167 | 1167 | current (as of Python 2.3) Python readline it's possible to do |
|
1168 | 1168 | better.""" |
|
1169 | 1169 | |
|
1170 | 1170 | # chars that require escaping with backslash - i.e. chars |
|
1171 | 1171 | # that readline treats incorrectly as delimiters, but we |
|
1172 | 1172 | # don't want to treat as delimiters in filename matching |
|
1173 | 1173 | # when escaped with backslash |
|
1174 | 1174 | if text.startswith('!'): |
|
1175 | 1175 | text = text[1:] |
|
1176 | 1176 | text_prefix = u'!' |
|
1177 | 1177 | else: |
|
1178 | 1178 | text_prefix = u'' |
|
1179 | 1179 | |
|
1180 | 1180 | text_until_cursor = self.text_until_cursor |
|
1181 | 1181 | # track strings with open quotes |
|
1182 | 1182 | open_quotes = has_open_quotes(text_until_cursor) |
|
1183 | 1183 | |
|
1184 | 1184 | if '(' in text_until_cursor or '[' in text_until_cursor: |
|
1185 | 1185 | lsplit = text |
|
1186 | 1186 | else: |
|
1187 | 1187 | try: |
|
1188 | 1188 | # arg_split ~ shlex.split, but with unicode bugs fixed by us |
|
1189 | 1189 | lsplit = arg_split(text_until_cursor)[-1] |
|
1190 | 1190 | except ValueError: |
|
1191 | 1191 | # typically an unmatched ", or backslash without escaped char. |
|
1192 | 1192 | if open_quotes: |
|
1193 | 1193 | lsplit = text_until_cursor.split(open_quotes)[-1] |
|
1194 | 1194 | else: |
|
1195 | 1195 | return [] |
|
1196 | 1196 | except IndexError: |
|
1197 | 1197 | # tab pressed on empty line |
|
1198 | 1198 | lsplit = "" |
|
1199 | 1199 | |
|
1200 | 1200 | if not open_quotes and lsplit != protect_filename(lsplit): |
|
1201 | 1201 | # if protectables are found, do matching on the whole escaped name |
|
1202 | 1202 | has_protectables = True |
|
1203 | 1203 | text0,text = text,lsplit |
|
1204 | 1204 | else: |
|
1205 | 1205 | has_protectables = False |
|
1206 | 1206 | text = os.path.expanduser(text) |
|
1207 | 1207 | |
|
1208 | 1208 | if text == "": |
|
1209 | 1209 | return [text_prefix + protect_filename(f) for f in self.glob("*")] |
|
1210 | 1210 | |
|
1211 | 1211 | # Compute the matches from the filesystem |
|
1212 | 1212 | if sys.platform == 'win32': |
|
1213 | 1213 | m0 = self.clean_glob(text) |
|
1214 | 1214 | else: |
|
1215 | 1215 | m0 = self.clean_glob(text.replace('\\', '')) |
|
1216 | 1216 | |
|
1217 | 1217 | if has_protectables: |
|
1218 | 1218 | # If we had protectables, we need to revert our changes to the |
|
1219 | 1219 | # beginning of filename so that we don't double-write the part |
|
1220 | 1220 | # of the filename we have so far |
|
1221 | 1221 | len_lsplit = len(lsplit) |
|
1222 | 1222 | matches = [text_prefix + text0 + |
|
1223 | 1223 | protect_filename(f[len_lsplit:]) for f in m0] |
|
1224 | 1224 | else: |
|
1225 | 1225 | if open_quotes: |
|
1226 | 1226 | # if we have a string with an open quote, we don't need to |
|
1227 | 1227 | # protect the names beyond the quote (and we _shouldn't_, as |
|
1228 | 1228 | # it would cause bugs when the filesystem call is made). |
|
1229 | 1229 | matches = m0 if sys.platform == "win32" else\ |
|
1230 | 1230 | [protect_filename(f, open_quotes) for f in m0] |
|
1231 | 1231 | else: |
|
1232 | 1232 | matches = [text_prefix + |
|
1233 | 1233 | protect_filename(f) for f in m0] |
|
1234 | 1234 | |
|
1235 | 1235 | # Mark directories in input list by appending '/' to their names. |
|
1236 | 1236 | return [x+'/' if os.path.isdir(x) else x for x in matches] |
|
1237 | 1237 | |
|
1238 | 1238 | def magic_matches(self, text): |
|
1239 | 1239 | """Match magics""" |
|
1240 | 1240 | # Get all shell magics now rather than statically, so magics loaded at |
|
1241 | 1241 | # runtime show up too. |
|
1242 | 1242 | lsm = self.shell.magics_manager.lsmagic() |
|
1243 | 1243 | line_magics = lsm['line'] |
|
1244 | 1244 | cell_magics = lsm['cell'] |
|
1245 | 1245 | pre = self.magic_escape |
|
1246 | 1246 | pre2 = pre+pre |
|
1247 | 1247 | |
|
1248 | 1248 | explicit_magic = text.startswith(pre) |
|
1249 | 1249 | |
|
1250 | 1250 | # Completion logic: |
|
1251 | 1251 | # - user gives %%: only do cell magics |
|
1252 | 1252 | # - user gives %: do both line and cell magics |
|
1253 | 1253 | # - no prefix: do both |
|
1254 | 1254 | # In other words, line magics are skipped if the user gives %% explicitly |
|
1255 | 1255 | # |
|
1256 | 1256 | # We also exclude magics that match any currently visible names: |
|
1257 | 1257 | # https://github.com/ipython/ipython/issues/4877, unless the user has |
|
1258 | 1258 | # typed a %: |
|
1259 | 1259 | # https://github.com/ipython/ipython/issues/10754 |
|
1260 | 1260 | bare_text = text.lstrip(pre) |
|
1261 | 1261 | global_matches = self.global_matches(bare_text) |
|
1262 | 1262 | if not explicit_magic: |
|
1263 | 1263 | def matches(magic): |
|
1264 | 1264 | """ |
|
1265 | 1265 | Filter magics, in particular remove magics that match |
|
1266 | 1266 | a name present in global namespace. |
|
1267 | 1267 | """ |
|
1268 | 1268 | return ( magic.startswith(bare_text) and |
|
1269 | 1269 | magic not in global_matches ) |
|
1270 | 1270 | else: |
|
1271 | 1271 | def matches(magic): |
|
1272 | 1272 | return magic.startswith(bare_text) |
|
1273 | 1273 | |
|
1274 | 1274 | comp = [ pre2+m for m in cell_magics if matches(m)] |
|
1275 | 1275 | if not text.startswith(pre2): |
|
1276 | 1276 | comp += [ pre+m for m in line_magics if matches(m)] |
|
1277 | 1277 | |
|
1278 | 1278 | return comp |
|
1279 | 1279 | |
|
1280 | 1280 | def magic_config_matches(self, text:str) -> List[str]: |
|
1281 | 1281 | """ Match class names and attributes for %config magic """ |
|
1282 | 1282 | texts = text.strip().split() |
|
1283 | 1283 | |
|
1284 | 1284 | if len(texts) > 0 and (texts[0] == 'config' or texts[0] == '%config'): |
|
1285 | 1285 | # get all configuration classes |
|
1286 | 1286 | classes = sorted(set([ c for c in self.shell.configurables |
|
1287 | 1287 | if c.__class__.class_traits(config=True) |
|
1288 | 1288 | ]), key=lambda x: x.__class__.__name__) |
|
1289 | 1289 | classnames = [ c.__class__.__name__ for c in classes ] |
|
1290 | 1290 | |
|
1291 | 1291 | # return all classnames if config or %config is given |
|
1292 | 1292 | if len(texts) == 1: |
|
1293 | 1293 | return classnames |
|
1294 | 1294 | |
|
1295 | 1295 | # match classname |
|
1296 | 1296 | classname_texts = texts[1].split('.') |
|
1297 | 1297 | classname = classname_texts[0] |
|
1298 | 1298 | classname_matches = [ c for c in classnames |
|
1299 | 1299 | if c.startswith(classname) ] |
|
1300 | 1300 | |
|
1301 | 1301 | # return matched classes or the matched class with attributes |
|
1302 | 1302 | if texts[1].find('.') < 0: |
|
1303 | 1303 | return classname_matches |
|
1304 | 1304 | elif len(classname_matches) == 1 and \ |
|
1305 | 1305 | classname_matches[0] == classname: |
|
1306 | 1306 | cls = classes[classnames.index(classname)].__class__ |
|
1307 | 1307 | help = cls.class_get_help() |
|
1308 | 1308 | # strip leading '--' from cl-args: |
|
1309 | 1309 | help = re.sub(re.compile(r'^--', re.MULTILINE), '', help) |
|
1310 | 1310 | return [ attr.split('=')[0] |
|
1311 | 1311 | for attr in help.strip().splitlines() |
|
1312 | 1312 | if attr.startswith(texts[1]) ] |
|
1313 | 1313 | return [] |
|
1314 | 1314 | |
|
1315 | 1315 | def magic_color_matches(self, text:str) -> List[str] : |
|
1316 | 1316 | """ Match color schemes for %colors magic""" |
|
1317 | 1317 | texts = text.split() |
|
1318 | 1318 | if text.endswith(' '): |
|
1319 | 1319 | # .split() strips off the trailing whitespace. Add '' back |
|
1320 | 1320 | # so that: '%colors ' -> ['%colors', ''] |
|
1321 | 1321 | texts.append('') |
|
1322 | 1322 | |
|
1323 | 1323 | if len(texts) == 2 and (texts[0] == 'colors' or texts[0] == '%colors'): |
|
1324 | 1324 | prefix = texts[1] |
|
1325 | 1325 | return [ color for color in InspectColors.keys() |
|
1326 | 1326 | if color.startswith(prefix) ] |
|
1327 | 1327 | return [] |
|
1328 | 1328 | |
|
1329 | 1329 | def _jedi_matches(self, cursor_column:int, cursor_line:int, text:str): |
|
1330 | 1330 | """ |
|
1331 | 1331 | |
|
1332 | 1332 | Return a list of :any:`jedi.api.Completions` object from a ``text`` and |
|
1333 | 1333 | cursor position. |
|
1334 | 1334 | |
|
1335 | 1335 | Parameters |
|
1336 | 1336 | ---------- |
|
1337 | 1337 | cursor_column : int |
|
1338 | 1338 | column position of the cursor in ``text``, 0-indexed. |
|
1339 | 1339 | cursor_line : int |
|
1340 | 1340 | line position of the cursor in ``text``, 0-indexed |
|
1341 | 1341 | text : str |
|
1342 | 1342 | text to complete |
|
1343 | 1343 | |
|
1344 | 1344 | Debugging |
|
1345 | 1345 | --------- |
|
1346 | 1346 | |
|
1347 | 1347 | If ``IPCompleter.debug`` is ``True`` may return a :any:`_FakeJediCompletion` |
|
1348 | 1348 | object containing a string with the Jedi debug information attached. |
|
1349 | 1349 | """ |
|
1350 | 1350 | namespaces = [self.namespace] |
|
1351 | 1351 | if self.global_namespace is not None: |
|
1352 | 1352 | namespaces.append(self.global_namespace) |
|
1353 | 1353 | |
|
1354 | 1354 | completion_filter = lambda x:x |
|
1355 | 1355 | offset = cursor_to_position(text, cursor_line, cursor_column) |
|
1356 | 1356 | # filter output if we are completing for object members |
|
1357 | 1357 | if offset: |
|
1358 | 1358 | pre = text[offset-1] |
|
1359 | 1359 | if pre == '.': |
|
1360 | 1360 | if self.omit__names == 2: |
|
1361 | 1361 | completion_filter = lambda c:not c.name.startswith('_') |
|
1362 | 1362 | elif self.omit__names == 1: |
|
1363 | 1363 | completion_filter = lambda c:not (c.name.startswith('__') and c.name.endswith('__')) |
|
1364 | 1364 | elif self.omit__names == 0: |
|
1365 | 1365 | completion_filter = lambda x:x |
|
1366 | 1366 | else: |
|
1367 | 1367 | raise ValueError("Don't understand self.omit__names == {}".format(self.omit__names)) |
|
1368 | 1368 | |
|
1369 | 1369 | interpreter = jedi.Interpreter( |
|
1370 | 1370 | text[:offset], namespaces, column=cursor_column, line=cursor_line + 1) |
|
1371 | 1371 | try_jedi = True |
|
1372 | 1372 | |
|
1373 | 1373 | try: |
|
1374 | 1374 | # should we check the type of the node is Error ? |
|
1375 | 1375 | try: |
|
1376 | 1376 | # jedi < 0.11 |
|
1377 | 1377 | from jedi.parser.tree import ErrorLeaf |
|
1378 | 1378 | except ImportError: |
|
1379 | 1379 | # jedi >= 0.11 |
|
1380 | 1380 | from parso.tree import ErrorLeaf |
|
1381 | 1381 | |
|
1382 | 1382 | next_to_last_tree = interpreter._get_module().tree_node.children[-2] |
|
1383 | 1383 | completing_string = False |
|
1384 | 1384 | if isinstance(next_to_last_tree, ErrorLeaf): |
|
1385 | 1385 | completing_string = next_to_last_tree.value.lstrip()[0] in {'"', "'"} |
|
1386 | 1386 | # if we are in a string jedi is likely not the right candidate for |
|
1387 | 1387 | # now. Skip it. |
|
1388 | 1388 | try_jedi = not completing_string |
|
1389 | 1389 | except Exception as e: |
|
1390 | 1390 | # many of things can go wrong, we are using private API just don't crash. |
|
1391 | 1391 | if self.debug: |
|
1392 | 1392 | print("Error detecting if completing a non-finished string :", e, '|') |
|
1393 | 1393 | |
|
1394 | 1394 | if not try_jedi: |
|
1395 | 1395 | return [] |
|
1396 | 1396 | try: |
|
1397 | 1397 | return filter(completion_filter, interpreter.completions()) |
|
1398 | 1398 | except Exception as e: |
|
1399 | 1399 | if self.debug: |
|
1400 | 1400 | return [_FakeJediCompletion('Oops Jedi has crashed, please report a bug with the following:\n"""\n%s\ns"""' % (e))] |
|
1401 | 1401 | else: |
|
1402 | 1402 | return [] |
|
1403 | 1403 | |
|
1404 | 1404 | def python_matches(self, text): |
|
1405 | 1405 | """Match attributes or global python names""" |
|
1406 | 1406 | if "." in text: |
|
1407 | 1407 | try: |
|
1408 | 1408 | matches = self.attr_matches(text) |
|
1409 | 1409 | if text.endswith('.') and self.omit__names: |
|
1410 | 1410 | if self.omit__names == 1: |
|
1411 | 1411 | # true if txt is _not_ a __ name, false otherwise: |
|
1412 | 1412 | no__name = (lambda txt: |
|
1413 | 1413 | re.match(r'.*\.__.*?__',txt) is None) |
|
1414 | 1414 | else: |
|
1415 | 1415 | # true if txt is _not_ a _ name, false otherwise: |
|
1416 | 1416 | no__name = (lambda txt: |
|
1417 | 1417 | re.match(r'\._.*?',txt[txt.rindex('.'):]) is None) |
|
1418 | 1418 | matches = filter(no__name, matches) |
|
1419 | 1419 | except NameError: |
|
1420 | 1420 | # catches <undefined attributes>.<tab> |
|
1421 | 1421 | matches = [] |
|
1422 | 1422 | else: |
|
1423 | 1423 | matches = self.global_matches(text) |
|
1424 | 1424 | return matches |
|
1425 | 1425 | |
|
1426 | 1426 | def _default_arguments_from_docstring(self, doc): |
|
1427 | 1427 | """Parse the first line of docstring for call signature. |
|
1428 | 1428 | |
|
1429 | 1429 | Docstring should be of the form 'min(iterable[, key=func])\n'. |
|
1430 | 1430 | It can also parse cython docstring of the form |
|
1431 | 1431 | 'Minuit.migrad(self, int ncall=10000, resume=True, int nsplit=1)'. |
|
1432 | 1432 | """ |
|
1433 | 1433 | if doc is None: |
|
1434 | 1434 | return [] |
|
1435 | 1435 | |
|
1436 | 1436 | #care only the firstline |
|
1437 | 1437 | line = doc.lstrip().splitlines()[0] |
|
1438 | 1438 | |
|
1439 | 1439 | #p = re.compile(r'^[\w|\s.]+\(([^)]*)\).*') |
|
1440 | 1440 | #'min(iterable[, key=func])\n' -> 'iterable[, key=func]' |
|
1441 | 1441 | sig = self.docstring_sig_re.search(line) |
|
1442 | 1442 | if sig is None: |
|
1443 | 1443 | return [] |
|
1444 | 1444 | # iterable[, key=func]' -> ['iterable[' ,' key=func]'] |
|
1445 | 1445 | sig = sig.groups()[0].split(',') |
|
1446 | 1446 | ret = [] |
|
1447 | 1447 | for s in sig: |
|
1448 | 1448 | #re.compile(r'[\s|\[]*(\w+)(?:\s*=\s*.*)') |
|
1449 | 1449 | ret += self.docstring_kwd_re.findall(s) |
|
1450 | 1450 | return ret |
|
1451 | 1451 | |
|
1452 | 1452 | def _default_arguments(self, obj): |
|
1453 | 1453 | """Return the list of default arguments of obj if it is callable, |
|
1454 | 1454 | or empty list otherwise.""" |
|
1455 | 1455 | call_obj = obj |
|
1456 | 1456 | ret = [] |
|
1457 | 1457 | if inspect.isbuiltin(obj): |
|
1458 | 1458 | pass |
|
1459 | 1459 | elif not (inspect.isfunction(obj) or inspect.ismethod(obj)): |
|
1460 | 1460 | if inspect.isclass(obj): |
|
1461 | 1461 | #for cython embedsignature=True the constructor docstring |
|
1462 | 1462 | #belongs to the object itself not __init__ |
|
1463 | 1463 | ret += self._default_arguments_from_docstring( |
|
1464 | 1464 | getattr(obj, '__doc__', '')) |
|
1465 | 1465 | # for classes, check for __init__,__new__ |
|
1466 | 1466 | call_obj = (getattr(obj, '__init__', None) or |
|
1467 | 1467 | getattr(obj, '__new__', None)) |
|
1468 | 1468 | # for all others, check if they are __call__able |
|
1469 | 1469 | elif hasattr(obj, '__call__'): |
|
1470 | 1470 | call_obj = obj.__call__ |
|
1471 | 1471 | ret += self._default_arguments_from_docstring( |
|
1472 | 1472 | getattr(call_obj, '__doc__', '')) |
|
1473 | 1473 | |
|
1474 | 1474 | _keeps = (inspect.Parameter.KEYWORD_ONLY, |
|
1475 | 1475 | inspect.Parameter.POSITIONAL_OR_KEYWORD) |
|
1476 | 1476 | |
|
1477 | 1477 | try: |
|
1478 | 1478 | sig = inspect.signature(call_obj) |
|
1479 | 1479 | ret.extend(k for k, v in sig.parameters.items() if |
|
1480 | 1480 | v.kind in _keeps) |
|
1481 | 1481 | except ValueError: |
|
1482 | 1482 | pass |
|
1483 | 1483 | |
|
1484 | 1484 | return list(set(ret)) |
|
1485 | 1485 | |
|
1486 | 1486 | def python_func_kw_matches(self,text): |
|
1487 | 1487 | """Match named parameters (kwargs) of the last open function""" |
|
1488 | 1488 | |
|
1489 | 1489 | if "." in text: # a parameter cannot be dotted |
|
1490 | 1490 | return [] |
|
1491 | 1491 | try: regexp = self.__funcParamsRegex |
|
1492 | 1492 | except AttributeError: |
|
1493 | 1493 | regexp = self.__funcParamsRegex = re.compile(r''' |
|
1494 | 1494 | '.*?(?<!\\)' | # single quoted strings or |
|
1495 | 1495 | ".*?(?<!\\)" | # double quoted strings or |
|
1496 | 1496 | \w+ | # identifier |
|
1497 | 1497 | \S # other characters |
|
1498 | 1498 | ''', re.VERBOSE | re.DOTALL) |
|
1499 | 1499 | # 1. find the nearest identifier that comes before an unclosed |
|
1500 | 1500 | # parenthesis before the cursor |
|
1501 | 1501 | # e.g. for "foo (1+bar(x), pa<cursor>,a=1)", the candidate is "foo" |
|
1502 | 1502 | tokens = regexp.findall(self.text_until_cursor) |
|
1503 | 1503 | iterTokens = reversed(tokens); openPar = 0 |
|
1504 | 1504 | |
|
1505 | 1505 | for token in iterTokens: |
|
1506 | 1506 | if token == ')': |
|
1507 | 1507 | openPar -= 1 |
|
1508 | 1508 | elif token == '(': |
|
1509 | 1509 | openPar += 1 |
|
1510 | 1510 | if openPar > 0: |
|
1511 | 1511 | # found the last unclosed parenthesis |
|
1512 | 1512 | break |
|
1513 | 1513 | else: |
|
1514 | 1514 | return [] |
|
1515 | 1515 | # 2. Concatenate dotted names ("foo.bar" for "foo.bar(x, pa" ) |
|
1516 | 1516 | ids = [] |
|
1517 | 1517 | isId = re.compile(r'\w+$').match |
|
1518 | 1518 | |
|
1519 | 1519 | while True: |
|
1520 | 1520 | try: |
|
1521 | 1521 | ids.append(next(iterTokens)) |
|
1522 | 1522 | if not isId(ids[-1]): |
|
1523 | 1523 | ids.pop(); break |
|
1524 | 1524 | if not next(iterTokens) == '.': |
|
1525 | 1525 | break |
|
1526 | 1526 | except StopIteration: |
|
1527 | 1527 | break |
|
1528 | 1528 | |
|
1529 | 1529 | # Find all named arguments already assigned to, as to avoid suggesting |
|
1530 | 1530 | # them again |
|
1531 | 1531 | usedNamedArgs = set() |
|
1532 | 1532 | par_level = -1 |
|
1533 | 1533 | for token, next_token in zip(tokens, tokens[1:]): |
|
1534 | 1534 | if token == '(': |
|
1535 | 1535 | par_level += 1 |
|
1536 | 1536 | elif token == ')': |
|
1537 | 1537 | par_level -= 1 |
|
1538 | 1538 | |
|
1539 | 1539 | if par_level != 0: |
|
1540 | 1540 | continue |
|
1541 | 1541 | |
|
1542 | 1542 | if next_token != '=': |
|
1543 | 1543 | continue |
|
1544 | 1544 | |
|
1545 | 1545 | usedNamedArgs.add(token) |
|
1546 | 1546 | |
|
1547 | 1547 | argMatches = [] |
|
1548 | 1548 | try: |
|
1549 | 1549 | callableObj = '.'.join(ids[::-1]) |
|
1550 | 1550 | namedArgs = self._default_arguments(eval(callableObj, |
|
1551 | 1551 | self.namespace)) |
|
1552 | 1552 | |
|
1553 | 1553 | # Remove used named arguments from the list, no need to show twice |
|
1554 | 1554 | for namedArg in set(namedArgs) - usedNamedArgs: |
|
1555 | 1555 | if namedArg.startswith(text): |
|
1556 | 1556 | argMatches.append(u"%s=" %namedArg) |
|
1557 | 1557 | except: |
|
1558 | 1558 | pass |
|
1559 | 1559 | |
|
1560 | 1560 | return argMatches |
|
1561 | 1561 | |
|
1562 | 1562 | def dict_key_matches(self, text): |
|
1563 | 1563 | "Match string keys in a dictionary, after e.g. 'foo[' " |
|
1564 | 1564 | def get_keys(obj): |
|
1565 | 1565 | # Objects can define their own completions by defining an |
|
1566 | 1566 | # _ipy_key_completions_() method. |
|
1567 | 1567 | method = get_real_method(obj, '_ipython_key_completions_') |
|
1568 | 1568 | if method is not None: |
|
1569 | 1569 | return method() |
|
1570 | 1570 | |
|
1571 | 1571 | # Special case some common in-memory dict-like types |
|
1572 | 1572 | if isinstance(obj, dict) or\ |
|
1573 | 1573 | _safe_isinstance(obj, 'pandas', 'DataFrame'): |
|
1574 | 1574 | try: |
|
1575 | 1575 | return list(obj.keys()) |
|
1576 | 1576 | except Exception: |
|
1577 | 1577 | return [] |
|
1578 | 1578 | elif _safe_isinstance(obj, 'numpy', 'ndarray') or\ |
|
1579 | 1579 | _safe_isinstance(obj, 'numpy', 'void'): |
|
1580 | 1580 | return obj.dtype.names or [] |
|
1581 | 1581 | return [] |
|
1582 | 1582 | |
|
1583 | 1583 | try: |
|
1584 | 1584 | regexps = self.__dict_key_regexps |
|
1585 | 1585 | except AttributeError: |
|
1586 | 1586 | dict_key_re_fmt = r'''(?x) |
|
1587 | 1587 | ( # match dict-referring expression wrt greedy setting |
|
1588 | 1588 | %s |
|
1589 | 1589 | ) |
|
1590 | 1590 | \[ # open bracket |
|
1591 | 1591 | \s* # and optional whitespace |
|
1592 | 1592 | ([uUbB]? # string prefix (r not handled) |
|
1593 | 1593 | (?: # unclosed string |
|
1594 | 1594 | '(?:[^']|(?<!\\)\\')* |
|
1595 | 1595 | | |
|
1596 | 1596 | "(?:[^"]|(?<!\\)\\")* |
|
1597 | 1597 | ) |
|
1598 | 1598 | )? |
|
1599 | 1599 | $ |
|
1600 | 1600 | ''' |
|
1601 | 1601 | regexps = self.__dict_key_regexps = { |
|
1602 | 1602 | False: re.compile(dict_key_re_fmt % r''' |
|
1603 | 1603 | # identifiers separated by . |
|
1604 | 1604 | (?!\d)\w+ |
|
1605 | 1605 | (?:\.(?!\d)\w+)* |
|
1606 | 1606 | '''), |
|
1607 | 1607 | True: re.compile(dict_key_re_fmt % ''' |
|
1608 | 1608 | .+ |
|
1609 | 1609 | ''') |
|
1610 | 1610 | } |
|
1611 | 1611 | |
|
1612 | 1612 | match = regexps[self.greedy].search(self.text_until_cursor) |
|
1613 | 1613 | if match is None: |
|
1614 | 1614 | return [] |
|
1615 | 1615 | |
|
1616 | 1616 | expr, prefix = match.groups() |
|
1617 | 1617 | try: |
|
1618 | 1618 | obj = eval(expr, self.namespace) |
|
1619 | 1619 | except Exception: |
|
1620 | 1620 | try: |
|
1621 | 1621 | obj = eval(expr, self.global_namespace) |
|
1622 | 1622 | except Exception: |
|
1623 | 1623 | return [] |
|
1624 | 1624 | |
|
1625 | 1625 | keys = get_keys(obj) |
|
1626 | 1626 | if not keys: |
|
1627 | 1627 | return keys |
|
1628 | 1628 | closing_quote, token_offset, matches = match_dict_keys(keys, prefix, self.splitter.delims) |
|
1629 | 1629 | if not matches: |
|
1630 | 1630 | return matches |
|
1631 | 1631 | |
|
1632 | 1632 | # get the cursor position of |
|
1633 | 1633 | # - the text being completed |
|
1634 | 1634 | # - the start of the key text |
|
1635 | 1635 | # - the start of the completion |
|
1636 | 1636 | text_start = len(self.text_until_cursor) - len(text) |
|
1637 | 1637 | if prefix: |
|
1638 | 1638 | key_start = match.start(2) |
|
1639 | 1639 | completion_start = key_start + token_offset |
|
1640 | 1640 | else: |
|
1641 | 1641 | key_start = completion_start = match.end() |
|
1642 | 1642 | |
|
1643 | 1643 | # grab the leading prefix, to make sure all completions start with `text` |
|
1644 | 1644 | if text_start > key_start: |
|
1645 | 1645 | leading = '' |
|
1646 | 1646 | else: |
|
1647 | 1647 | leading = text[text_start:completion_start] |
|
1648 | 1648 | |
|
1649 | 1649 | # the index of the `[` character |
|
1650 | 1650 | bracket_idx = match.end(1) |
|
1651 | 1651 | |
|
1652 | 1652 | # append closing quote and bracket as appropriate |
|
1653 | 1653 | # this is *not* appropriate if the opening quote or bracket is outside |
|
1654 | 1654 | # the text given to this method |
|
1655 | 1655 | suf = '' |
|
1656 | 1656 | continuation = self.line_buffer[len(self.text_until_cursor):] |
|
1657 | 1657 | if key_start > text_start and closing_quote: |
|
1658 | 1658 | # quotes were opened inside text, maybe close them |
|
1659 | 1659 | if continuation.startswith(closing_quote): |
|
1660 | 1660 | continuation = continuation[len(closing_quote):] |
|
1661 | 1661 | else: |
|
1662 | 1662 | suf += closing_quote |
|
1663 | 1663 | if bracket_idx > text_start: |
|
1664 | 1664 | # brackets were opened inside text, maybe close them |
|
1665 | 1665 | if not continuation.startswith(']'): |
|
1666 | 1666 | suf += ']' |
|
1667 | 1667 | |
|
1668 | 1668 | return [leading + k + suf for k in matches] |
|
1669 | 1669 | |
|
1670 | 1670 | def unicode_name_matches(self, text): |
|
1671 | 1671 | u"""Match Latex-like syntax for unicode characters base |
|
1672 | 1672 | on the name of the character. |
|
1673 | 1673 | |
|
1674 | 1674 | This does ``\\GREEK SMALL LETTER ETA`` -> ``Ξ·`` |
|
1675 | 1675 | |
|
1676 | 1676 | Works only on valid python 3 identifier, or on combining characters that |
|
1677 | 1677 | will combine to form a valid identifier. |
|
1678 | 1678 | |
|
1679 | 1679 | Used on Python 3 only. |
|
1680 | 1680 | """ |
|
1681 | 1681 | slashpos = text.rfind('\\') |
|
1682 | 1682 | if slashpos > -1: |
|
1683 | 1683 | s = text[slashpos+1:] |
|
1684 | 1684 | try : |
|
1685 | 1685 | unic = unicodedata.lookup(s) |
|
1686 | 1686 | # allow combining chars |
|
1687 | 1687 | if ('a'+unic).isidentifier(): |
|
1688 | 1688 | return '\\'+s,[unic] |
|
1689 | 1689 | except KeyError: |
|
1690 | 1690 | pass |
|
1691 | 1691 | return u'', [] |
|
1692 | 1692 | |
|
1693 | 1693 | |
|
1694 | 1694 | def latex_matches(self, text): |
|
1695 | 1695 | u"""Match Latex syntax for unicode characters. |
|
1696 | 1696 | |
|
1697 | 1697 | This does both ``\\alp`` -> ``\\alpha`` and ``\\alpha`` -> ``Ξ±`` |
|
1698 | 1698 | |
|
1699 | 1699 | Used on Python 3 only. |
|
1700 | 1700 | """ |
|
1701 | 1701 | slashpos = text.rfind('\\') |
|
1702 | 1702 | if slashpos > -1: |
|
1703 | 1703 | s = text[slashpos:] |
|
1704 | 1704 | if s in latex_symbols: |
|
1705 | 1705 | # Try to complete a full latex symbol to unicode |
|
1706 | 1706 | # \\alpha -> Ξ± |
|
1707 | 1707 | return s, [latex_symbols[s]] |
|
1708 | 1708 | else: |
|
1709 | 1709 | # If a user has partially typed a latex symbol, give them |
|
1710 | 1710 | # a full list of options \al -> [\aleph, \alpha] |
|
1711 | 1711 | matches = [k for k in latex_symbols if k.startswith(s)] |
|
1712 | 1712 | return s, matches |
|
1713 | 1713 | return u'', [] |
|
1714 | 1714 | |
|
1715 | 1715 | def dispatch_custom_completer(self, text): |
|
1716 | 1716 | if not self.custom_completers: |
|
1717 | 1717 | return |
|
1718 | 1718 | |
|
1719 | 1719 | line = self.line_buffer |
|
1720 | 1720 | if not line.strip(): |
|
1721 | 1721 | return None |
|
1722 | 1722 | |
|
1723 | 1723 | # Create a little structure to pass all the relevant information about |
|
1724 | 1724 | # the current completion to any custom completer. |
|
1725 | 1725 | event = SimpleNamespace() |
|
1726 | 1726 | event.line = line |
|
1727 | 1727 | event.symbol = text |
|
1728 | 1728 | cmd = line.split(None,1)[0] |
|
1729 | 1729 | event.command = cmd |
|
1730 | 1730 | event.text_until_cursor = self.text_until_cursor |
|
1731 | 1731 | |
|
1732 | 1732 | # for foo etc, try also to find completer for %foo |
|
1733 | 1733 | if not cmd.startswith(self.magic_escape): |
|
1734 | 1734 | try_magic = self.custom_completers.s_matches( |
|
1735 | 1735 | self.magic_escape + cmd) |
|
1736 | 1736 | else: |
|
1737 | 1737 | try_magic = [] |
|
1738 | 1738 | |
|
1739 | 1739 | for c in itertools.chain(self.custom_completers.s_matches(cmd), |
|
1740 | 1740 | try_magic, |
|
1741 | 1741 | self.custom_completers.flat_matches(self.text_until_cursor)): |
|
1742 | 1742 | try: |
|
1743 | 1743 | res = c(event) |
|
1744 | 1744 | if res: |
|
1745 | 1745 | # first, try case sensitive match |
|
1746 | 1746 | withcase = [r for r in res if r.startswith(text)] |
|
1747 | 1747 | if withcase: |
|
1748 | 1748 | return withcase |
|
1749 | 1749 | # if none, then case insensitive ones are ok too |
|
1750 | 1750 | text_low = text.lower() |
|
1751 | 1751 | return [r for r in res if r.lower().startswith(text_low)] |
|
1752 | 1752 | except TryNext: |
|
1753 | 1753 | pass |
|
1754 | 1754 | except KeyboardInterrupt: |
|
1755 | 1755 | """ |
|
1756 | 1756 | If custom completer take too long, |
|
1757 | 1757 | let keyboard interrupt abort and return nothing. |
|
1758 | 1758 | """ |
|
1759 | 1759 | break |
|
1760 | 1760 | |
|
1761 | 1761 | return None |
|
1762 | 1762 | |
|
1763 | 1763 | def completions(self, text: str, offset: int)->Iterator[Completion]: |
|
1764 | 1764 | """ |
|
1765 | 1765 | Returns an iterator over the possible completions |
|
1766 | 1766 | |
|
1767 | 1767 | .. warning:: Unstable |
|
1768 | 1768 | |
|
1769 | 1769 | This function is unstable, API may change without warning. |
|
1770 | 1770 | It will also raise unless use in proper context manager. |
|
1771 | 1771 | |
|
1772 | 1772 | Parameters |
|
1773 | 1773 | ---------- |
|
1774 | 1774 | |
|
1775 | 1775 | text:str |
|
1776 | 1776 | Full text of the current input, multi line string. |
|
1777 | 1777 | offset:int |
|
1778 | 1778 | Integer representing the position of the cursor in ``text``. Offset |
|
1779 | 1779 | is 0-based indexed. |
|
1780 | 1780 | |
|
1781 | 1781 | Yields |
|
1782 | 1782 | ------ |
|
1783 | 1783 | :any:`Completion` object |
|
1784 | 1784 | |
|
1785 | 1785 | |
|
1786 | 1786 | The cursor on a text can either be seen as being "in between" |
|
1787 | 1787 | characters or "On" a character depending on the interface visible to |
|
1788 | 1788 | the user. For consistency the cursor being on "in between" characters X |
|
1789 | 1789 | and Y is equivalent to the cursor being "on" character Y, that is to say |
|
1790 | 1790 | the character the cursor is on is considered as being after the cursor. |
|
1791 | 1791 | |
|
1792 | 1792 | Combining characters may span more that one position in the |
|
1793 | 1793 | text. |
|
1794 | 1794 | |
|
1795 | 1795 | |
|
1796 | 1796 | .. note:: |
|
1797 | 1797 | |
|
1798 | 1798 | If ``IPCompleter.debug`` is :any:`True` will yield a ``--jedi/ipython--`` |
|
1799 | 1799 | fake Completion token to distinguish completion returned by Jedi |
|
1800 | 1800 | and usual IPython completion. |
|
1801 | 1801 | |
|
1802 | 1802 | .. note:: |
|
1803 | 1803 | |
|
1804 | 1804 | Completions are not completely deduplicated yet. If identical |
|
1805 | 1805 | completions are coming from different sources this function does not |
|
1806 | 1806 | ensure that each completion object will only be present once. |
|
1807 | 1807 | """ |
|
1808 | 1808 | warnings.warn("_complete is a provisional API (as of IPython 6.0). " |
|
1809 | 1809 | "It may change without warnings. " |
|
1810 | 1810 | "Use in corresponding context manager.", |
|
1811 | 1811 | category=ProvisionalCompleterWarning, stacklevel=2) |
|
1812 | 1812 | |
|
1813 | 1813 | seen = set() |
|
1814 | 1814 | try: |
|
1815 | 1815 | for c in self._completions(text, offset, _timeout=self.jedi_compute_type_timeout/1000): |
|
1816 | 1816 | if c and (c in seen): |
|
1817 | 1817 | continue |
|
1818 | 1818 | yield c |
|
1819 | 1819 | seen.add(c) |
|
1820 | 1820 | except KeyboardInterrupt: |
|
1821 | 1821 | """if completions take too long and users send keyboard interrupt, |
|
1822 | 1822 | do not crash and return ASAP. """ |
|
1823 | 1823 | pass |
|
1824 | 1824 | |
|
1825 | 1825 | def _completions(self, full_text: str, offset: int, *, _timeout)->Iterator[Completion]: |
|
1826 | 1826 | """ |
|
1827 | 1827 | Core completion module.Same signature as :any:`completions`, with the |
|
1828 | 1828 | extra `timeout` parameter (in seconds). |
|
1829 | 1829 | |
|
1830 | 1830 | |
|
1831 | 1831 | Computing jedi's completion ``.type`` can be quite expensive (it is a |
|
1832 | 1832 | lazy property) and can require some warm-up, more warm up than just |
|
1833 | 1833 | computing the ``name`` of a completion. The warm-up can be : |
|
1834 | 1834 | |
|
1835 | 1835 | - Long warm-up the first time a module is encountered after |
|
1836 | 1836 | install/update: actually build parse/inference tree. |
|
1837 | 1837 | |
|
1838 | 1838 | - first time the module is encountered in a session: load tree from |
|
1839 | 1839 | disk. |
|
1840 | 1840 | |
|
1841 | 1841 | We don't want to block completions for tens of seconds so we give the |
|
1842 | 1842 | completer a "budget" of ``_timeout`` seconds per invocation to compute |
|
1843 | 1843 | completions types, the completions that have not yet been computed will |
|
1844 | 1844 | be marked as "unknown" an will have a chance to be computed next round |
|
1845 | 1845 | are things get cached. |
|
1846 | 1846 | |
|
1847 | 1847 | Keep in mind that Jedi is not the only thing treating the completion so |
|
1848 | 1848 | keep the timeout short-ish as if we take more than 0.3 second we still |
|
1849 | 1849 | have lots of processing to do. |
|
1850 | 1850 | |
|
1851 | 1851 | """ |
|
1852 | 1852 | deadline = time.monotonic() + _timeout |
|
1853 | 1853 | |
|
1854 | 1854 | |
|
1855 | 1855 | before = full_text[:offset] |
|
1856 | 1856 | cursor_line, cursor_column = position_to_cursor(full_text, offset) |
|
1857 | 1857 | |
|
1858 | 1858 | matched_text, matches, matches_origin, jedi_matches = self._complete( |
|
1859 | 1859 | full_text=full_text, cursor_line=cursor_line, cursor_pos=cursor_column) |
|
1860 | 1860 | |
|
1861 | 1861 | iter_jm = iter(jedi_matches) |
|
1862 | 1862 | if _timeout: |
|
1863 | 1863 | for jm in iter_jm: |
|
1864 | 1864 | try: |
|
1865 | 1865 | type_ = jm.type |
|
1866 | 1866 | except Exception: |
|
1867 | 1867 | if self.debug: |
|
1868 | 1868 | print("Error in Jedi getting type of ", jm) |
|
1869 | 1869 | type_ = None |
|
1870 | 1870 | delta = len(jm.name_with_symbols) - len(jm.complete) |
|
1871 | 1871 | if type_ == 'function': |
|
1872 | 1872 | signature = _make_signature(jm) |
|
1873 | 1873 | else: |
|
1874 | 1874 | signature = '' |
|
1875 | 1875 | yield Completion(start=offset - delta, |
|
1876 | 1876 | end=offset, |
|
1877 | 1877 | text=jm.name_with_symbols, |
|
1878 | 1878 | type=type_, |
|
1879 | 1879 | signature=signature, |
|
1880 | 1880 | _origin='jedi') |
|
1881 | 1881 | |
|
1882 | 1882 | if time.monotonic() > deadline: |
|
1883 | 1883 | break |
|
1884 | 1884 | |
|
1885 | 1885 | for jm in iter_jm: |
|
1886 | 1886 | delta = len(jm.name_with_symbols) - len(jm.complete) |
|
1887 | 1887 | yield Completion(start=offset - delta, |
|
1888 | 1888 | end=offset, |
|
1889 | 1889 | text=jm.name_with_symbols, |
|
1890 | 1890 | type='<unknown>', # don't compute type for speed |
|
1891 | 1891 | _origin='jedi', |
|
1892 | 1892 | signature='') |
|
1893 | 1893 | |
|
1894 | 1894 | |
|
1895 | 1895 | start_offset = before.rfind(matched_text) |
|
1896 | 1896 | |
|
1897 | 1897 | # TODO: |
|
1898 | 1898 | # Suppress this, right now just for debug. |
|
1899 | 1899 | if jedi_matches and matches and self.debug: |
|
1900 | 1900 | yield Completion(start=start_offset, end=offset, text='--jedi/ipython--', |
|
1901 | 1901 | _origin='debug', type='none', signature='') |
|
1902 | 1902 | |
|
1903 | 1903 | # I'm unsure if this is always true, so let's assert and see if it |
|
1904 | 1904 | # crash |
|
1905 | 1905 | assert before.endswith(matched_text) |
|
1906 | 1906 | for m, t in zip(matches, matches_origin): |
|
1907 | 1907 | yield Completion(start=start_offset, end=offset, text=m, _origin=t, signature='', type='<unknown>') |
|
1908 | 1908 | |
|
1909 | 1909 | |
|
1910 | 1910 | def complete(self, text=None, line_buffer=None, cursor_pos=None): |
|
1911 | 1911 | """Find completions for the given text and line context. |
|
1912 | 1912 | |
|
1913 | 1913 | Note that both the text and the line_buffer are optional, but at least |
|
1914 | 1914 | one of them must be given. |
|
1915 | 1915 | |
|
1916 | 1916 | Parameters |
|
1917 | 1917 | ---------- |
|
1918 | 1918 | text : string, optional |
|
1919 | 1919 | Text to perform the completion on. If not given, the line buffer |
|
1920 | 1920 | is split using the instance's CompletionSplitter object. |
|
1921 | 1921 | |
|
1922 | 1922 | line_buffer : string, optional |
|
1923 | 1923 | If not given, the completer attempts to obtain the current line |
|
1924 | 1924 | buffer via readline. This keyword allows clients which are |
|
1925 | 1925 | requesting for text completions in non-readline contexts to inform |
|
1926 | 1926 | the completer of the entire text. |
|
1927 | 1927 | |
|
1928 | 1928 | cursor_pos : int, optional |
|
1929 | 1929 | Index of the cursor in the full line buffer. Should be provided by |
|
1930 | 1930 | remote frontends where kernel has no access to frontend state. |
|
1931 | 1931 | |
|
1932 | 1932 | Returns |
|
1933 | 1933 | ------- |
|
1934 | 1934 | text : str |
|
1935 | 1935 | Text that was actually used in the completion. |
|
1936 | 1936 | |
|
1937 | 1937 | matches : list |
|
1938 | 1938 | A list of completion matches. |
|
1939 | 1939 | |
|
1940 | 1940 | |
|
1941 | 1941 | .. note:: |
|
1942 | 1942 | |
|
1943 | 1943 | This API is likely to be deprecated and replaced by |
|
1944 | 1944 | :any:`IPCompleter.completions` in the future. |
|
1945 | 1945 | |
|
1946 | 1946 | |
|
1947 | 1947 | """ |
|
1948 | 1948 | warnings.warn('`Completer.complete` is pending deprecation since ' |
|
1949 | 1949 | 'IPython 6.0 and will be replaced by `Completer.completions`.', |
|
1950 | 1950 | PendingDeprecationWarning) |
|
1951 | 1951 | # potential todo, FOLD the 3rd throw away argument of _complete |
|
1952 | 1952 | # into the first 2 one. |
|
1953 | 1953 | return self._complete(line_buffer=line_buffer, cursor_pos=cursor_pos, text=text, cursor_line=0)[:2] |
|
1954 | 1954 | |
|
1955 | 1955 | def _complete(self, *, cursor_line, cursor_pos, line_buffer=None, text=None, |
|
1956 | 1956 | full_text=None) -> Tuple[str, List[str], List[str], Iterable[_FakeJediCompletion]]: |
|
1957 | 1957 | """ |
|
1958 | 1958 | |
|
1959 | 1959 | Like complete but can also returns raw jedi completions as well as the |
|
1960 | 1960 | origin of the completion text. This could (and should) be made much |
|
1961 | 1961 | cleaner but that will be simpler once we drop the old (and stateful) |
|
1962 | 1962 | :any:`complete` API. |
|
1963 | 1963 | |
|
1964 | 1964 | |
|
1965 | 1965 | With current provisional API, cursor_pos act both (depending on the |
|
1966 | 1966 | caller) as the offset in the ``text`` or ``line_buffer``, or as the |
|
1967 | 1967 | ``column`` when passing multiline strings this could/should be renamed |
|
1968 | 1968 | but would add extra noise. |
|
1969 | 1969 | """ |
|
1970 | 1970 | |
|
1971 | 1971 | # if the cursor position isn't given, the only sane assumption we can |
|
1972 | 1972 | # make is that it's at the end of the line (the common case) |
|
1973 | 1973 | if cursor_pos is None: |
|
1974 | 1974 | cursor_pos = len(line_buffer) if text is None else len(text) |
|
1975 | 1975 | |
|
1976 | 1976 | if self.use_main_ns: |
|
1977 | 1977 | self.namespace = __main__.__dict__ |
|
1978 | 1978 | |
|
1979 | 1979 | # if text is either None or an empty string, rely on the line buffer |
|
1980 | 1980 | if (not line_buffer) and full_text: |
|
1981 | 1981 | line_buffer = full_text.split('\n')[cursor_line] |
|
1982 | 1982 | if not text: |
|
1983 | 1983 | text = self.splitter.split_line(line_buffer, cursor_pos) |
|
1984 | 1984 | |
|
1985 | 1985 | if self.backslash_combining_completions: |
|
1986 | 1986 | # allow deactivation of these on windows. |
|
1987 | 1987 | base_text = text if not line_buffer else line_buffer[:cursor_pos] |
|
1988 | 1988 | latex_text, latex_matches = self.latex_matches(base_text) |
|
1989 | 1989 | if latex_matches: |
|
1990 | 1990 | return latex_text, latex_matches, ['latex_matches']*len(latex_matches), () |
|
1991 | 1991 | name_text = '' |
|
1992 | 1992 | name_matches = [] |
|
1993 | 1993 | # need to add self.fwd_unicode_match() function here when done |
|
1994 | 1994 | for meth in (self.unicode_name_matches, back_latex_name_matches, back_unicode_name_matches, self.fwd_unicode_match): |
|
1995 | 1995 | name_text, name_matches = meth(base_text) |
|
1996 | 1996 | if name_text: |
|
1997 | 1997 | return name_text, name_matches[:MATCHES_LIMIT], \ |
|
1998 | 1998 | [meth.__qualname__]*min(len(name_matches), MATCHES_LIMIT), () |
|
1999 | 1999 | |
|
2000 | 2000 | |
|
2001 | 2001 | # If no line buffer is given, assume the input text is all there was |
|
2002 | 2002 | if line_buffer is None: |
|
2003 | 2003 | line_buffer = text |
|
2004 | 2004 | |
|
2005 | 2005 | self.line_buffer = line_buffer |
|
2006 | 2006 | self.text_until_cursor = self.line_buffer[:cursor_pos] |
|
2007 | 2007 | |
|
2008 | 2008 | # Do magic arg matches |
|
2009 | 2009 | for matcher in self.magic_arg_matchers: |
|
2010 | 2010 | matches = list(matcher(line_buffer))[:MATCHES_LIMIT] |
|
2011 | 2011 | if matches: |
|
2012 | 2012 | origins = [matcher.__qualname__] * len(matches) |
|
2013 | 2013 | return text, matches, origins, () |
|
2014 | 2014 | |
|
2015 | 2015 | # Start with a clean slate of completions |
|
2016 | 2016 | matches = [] |
|
2017 | 2017 | |
|
2018 | 2018 | # FIXME: we should extend our api to return a dict with completions for |
|
2019 | 2019 | # different types of objects. The rlcomplete() method could then |
|
2020 | 2020 | # simply collapse the dict into a list for readline, but we'd have |
|
2021 | 2021 | # richer completion semantics in other environments. |
|
2022 | 2022 | completions = () |
|
2023 | 2023 | if self.use_jedi: |
|
2024 | 2024 | if not full_text: |
|
2025 | 2025 | full_text = line_buffer |
|
2026 | 2026 | completions = self._jedi_matches( |
|
2027 | 2027 | cursor_pos, cursor_line, full_text) |
|
2028 | 2028 | |
|
2029 | 2029 | if self.merge_completions: |
|
2030 | 2030 | matches = [] |
|
2031 | 2031 | for matcher in self.matchers: |
|
2032 | 2032 | try: |
|
2033 | 2033 | matches.extend([(m, matcher.__qualname__) |
|
2034 | 2034 | for m in matcher(text)]) |
|
2035 | 2035 | except: |
|
2036 | 2036 | # Show the ugly traceback if the matcher causes an |
|
2037 | 2037 | # exception, but do NOT crash the kernel! |
|
2038 | 2038 | sys.excepthook(*sys.exc_info()) |
|
2039 | 2039 | else: |
|
2040 | 2040 | for matcher in self.matchers: |
|
2041 | 2041 | matches = [(m, matcher.__qualname__) |
|
2042 | 2042 | for m in matcher(text)] |
|
2043 | 2043 | if matches: |
|
2044 | 2044 | break |
|
2045 | 2045 | |
|
2046 | 2046 | seen = set() |
|
2047 | 2047 | filtered_matches = set() |
|
2048 | 2048 | for m in matches: |
|
2049 | 2049 | t, c = m |
|
2050 | 2050 | if t not in seen: |
|
2051 | 2051 | filtered_matches.add(m) |
|
2052 | 2052 | seen.add(t) |
|
2053 | 2053 | |
|
2054 | 2054 | _filtered_matches = sorted(filtered_matches, key=lambda x: completions_sorting_key(x[0])) |
|
2055 | 2055 | |
|
2056 | 2056 | custom_res = [(m, 'custom') for m in self.dispatch_custom_completer(text) or []] |
|
2057 | 2057 | |
|
2058 | 2058 | _filtered_matches = custom_res or _filtered_matches |
|
2059 | 2059 | |
|
2060 | 2060 | _filtered_matches = _filtered_matches[:MATCHES_LIMIT] |
|
2061 | 2061 | _matches = [m[0] for m in _filtered_matches] |
|
2062 | 2062 | origins = [m[1] for m in _filtered_matches] |
|
2063 | 2063 | |
|
2064 | 2064 | self.matches = _matches |
|
2065 | 2065 | |
|
2066 | 2066 | return text, _matches, origins, completions |
|
2067 | 2067 | |
|
2068 | 2068 | def fwd_unicode_match(self, text:str) -> Tuple[str, list]: |
|
2069 | 2069 | if self._names is None: |
|
2070 | 2070 | self._names = [] |
|
2071 | 2071 | for c in range(0,0x10FFFF + 1): |
|
2072 | 2072 | try: |
|
2073 | 2073 | self._names.append(unicodedata.name(chr(c))) |
|
2074 | 2074 | except ValueError: |
|
2075 | 2075 | pass |
|
2076 | 2076 | |
|
2077 | 2077 | slashpos = text.rfind('\\') |
|
2078 | 2078 | # if text starts with slash |
|
2079 | 2079 | if slashpos > -1: |
|
2080 | 2080 | s = text[slashpos+1:] |
|
2081 | 2081 | candidates = [x for x in self._names if x.startswith(s)] |
|
2082 | 2082 | if candidates: |
|
2083 | 2083 | return s, candidates |
|
2084 | 2084 | else: |
|
2085 | 2085 | return '', () |
|
2086 | 2086 | |
|
2087 | 2087 | # if text does not start with slash |
|
2088 | 2088 | else: |
|
2089 | 2089 | return u'', () |
@@ -1,138 +1,138 b'' | |||
|
1 | 1 | """An interface for publishing rich data to frontends. |
|
2 | 2 | |
|
3 | 3 | There are two components of the display system: |
|
4 | 4 | |
|
5 | 5 | * Display formatters, which take a Python object and compute the |
|
6 | 6 | representation of the object in various formats (text, HTML, SVG, etc.). |
|
7 | 7 | * The display publisher that is used to send the representation data to the |
|
8 | 8 | various frontends. |
|
9 | 9 | |
|
10 | 10 | This module defines the logic display publishing. The display publisher uses |
|
11 | 11 | the ``display_data`` message type that is defined in the IPython messaging |
|
12 | 12 | spec. |
|
13 | 13 | """ |
|
14 | 14 | |
|
15 | 15 | # Copyright (c) IPython Development Team. |
|
16 | 16 | # Distributed under the terms of the Modified BSD License. |
|
17 | 17 | |
|
18 | 18 | |
|
19 | 19 | import sys |
|
20 | 20 | |
|
21 | 21 | from traitlets.config.configurable import Configurable |
|
22 |
from traitlets import List |
|
|
22 | from traitlets import List | |
|
23 | 23 | |
|
24 | 24 | # This used to be defined here - it is imported for backwards compatibility |
|
25 | 25 | from .display import publish_display_data |
|
26 | 26 | |
|
27 | 27 | #----------------------------------------------------------------------------- |
|
28 | 28 | # Main payload class |
|
29 | 29 | #----------------------------------------------------------------------------- |
|
30 | 30 | |
|
31 | 31 | |
|
32 | 32 | class DisplayPublisher(Configurable): |
|
33 | 33 | """A traited class that publishes display data to frontends. |
|
34 | 34 | |
|
35 | 35 | Instances of this class are created by the main IPython object and should |
|
36 | 36 | be accessed there. |
|
37 | 37 | """ |
|
38 | 38 | |
|
39 | 39 | def __init__(self, shell=None, *args, **kwargs): |
|
40 | 40 | self.shell = shell |
|
41 | 41 | super().__init__(*args, **kwargs) |
|
42 | 42 | |
|
43 | 43 | def _validate_data(self, data, metadata=None): |
|
44 | 44 | """Validate the display data. |
|
45 | 45 | |
|
46 | 46 | Parameters |
|
47 | 47 | ---------- |
|
48 | 48 | data : dict |
|
49 | 49 | The formata data dictionary. |
|
50 | 50 | metadata : dict |
|
51 | 51 | Any metadata for the data. |
|
52 | 52 | """ |
|
53 | 53 | |
|
54 | 54 | if not isinstance(data, dict): |
|
55 | 55 | raise TypeError('data must be a dict, got: %r' % data) |
|
56 | 56 | if metadata is not None: |
|
57 | 57 | if not isinstance(metadata, dict): |
|
58 | 58 | raise TypeError('metadata must be a dict, got: %r' % data) |
|
59 | 59 | |
|
60 | 60 | # use * to indicate transient, update are keyword-only |
|
61 | 61 | def publish(self, data, metadata=None, source=None, *, transient=None, update=False, **kwargs) -> None: |
|
62 | 62 | """Publish data and metadata to all frontends. |
|
63 | 63 | |
|
64 | 64 | See the ``display_data`` message in the messaging documentation for |
|
65 | 65 | more details about this message type. |
|
66 | 66 | |
|
67 | 67 | The following MIME types are currently implemented: |
|
68 | 68 | |
|
69 | 69 | * text/plain |
|
70 | 70 | * text/html |
|
71 | 71 | * text/markdown |
|
72 | 72 | * text/latex |
|
73 | 73 | * application/json |
|
74 | 74 | * application/javascript |
|
75 | 75 | * image/png |
|
76 | 76 | * image/jpeg |
|
77 | 77 | * image/svg+xml |
|
78 | 78 | |
|
79 | 79 | Parameters |
|
80 | 80 | ---------- |
|
81 | 81 | data : dict |
|
82 | 82 | A dictionary having keys that are valid MIME types (like |
|
83 | 83 | 'text/plain' or 'image/svg+xml') and values that are the data for |
|
84 | 84 | that MIME type. The data itself must be a JSON'able data |
|
85 | 85 | structure. Minimally all data should have the 'text/plain' data, |
|
86 | 86 | which can be displayed by all frontends. If more than the plain |
|
87 | 87 | text is given, it is up to the frontend to decide which |
|
88 | 88 | representation to use. |
|
89 | 89 | metadata : dict |
|
90 | 90 | A dictionary for metadata related to the data. This can contain |
|
91 | 91 | arbitrary key, value pairs that frontends can use to interpret |
|
92 | 92 | the data. Metadata specific to each mime-type can be specified |
|
93 | 93 | in the metadata dict with the same mime-type keys as |
|
94 | 94 | the data itself. |
|
95 | 95 | source : str, deprecated |
|
96 | 96 | Unused. |
|
97 | 97 | transient: dict, keyword-only |
|
98 | 98 | A dictionary for transient data. |
|
99 | 99 | Data in this dictionary should not be persisted as part of saving this output. |
|
100 | 100 | Examples include 'display_id'. |
|
101 | 101 | update: bool, keyword-only, default: False |
|
102 | 102 | If True, only update existing outputs with the same display_id, |
|
103 | 103 | rather than creating a new output. |
|
104 | 104 | """ |
|
105 | 105 | |
|
106 | 106 | handlers = {} |
|
107 | 107 | if self.shell is not None: |
|
108 | 108 | handlers = getattr(self.shell, 'mime_renderers', {}) |
|
109 | 109 | |
|
110 | 110 | for mime, handler in handlers.items(): |
|
111 | 111 | if mime in data: |
|
112 | 112 | handler(data[mime], metadata.get(mime, None)) |
|
113 | 113 | return |
|
114 | 114 | |
|
115 | 115 | if 'text/plain' in data: |
|
116 | 116 | print(data['text/plain']) |
|
117 | 117 | |
|
118 | 118 | def clear_output(self, wait=False): |
|
119 | 119 | """Clear the output of the cell receiving output.""" |
|
120 | 120 | print('\033[2K\r', end='') |
|
121 | 121 | sys.stdout.flush() |
|
122 | 122 | print('\033[2K\r', end='') |
|
123 | 123 | sys.stderr.flush() |
|
124 | 124 | |
|
125 | 125 | |
|
126 | 126 | class CapturingDisplayPublisher(DisplayPublisher): |
|
127 | 127 | """A DisplayPublisher that stores""" |
|
128 | 128 | outputs = List() |
|
129 | 129 | |
|
130 | 130 | def publish(self, data, metadata=None, source=None, *, transient=None, update=False): |
|
131 | 131 | self.outputs.append({'data':data, 'metadata':metadata, |
|
132 | 132 | 'transient':transient, 'update':update}) |
|
133 | 133 | |
|
134 | 134 | def clear_output(self, wait=False): |
|
135 | 135 | super(CapturingDisplayPublisher, self).clear_output(wait) |
|
136 | 136 | |
|
137 | 137 | # empty the list, *do not* reassign a new list |
|
138 | 138 | self.outputs.clear() |
|
1 | NO CONTENT: modified file | |
The requested commit or file is too big and content was truncated. Show full diff |
@@ -1,652 +1,651 b'' | |||
|
1 | 1 | """Implementation of basic magic functions.""" |
|
2 | 2 | |
|
3 | 3 | |
|
4 | 4 | import argparse |
|
5 | 5 | from logging import error |
|
6 | 6 | import io |
|
7 | 7 | from pprint import pformat |
|
8 | import textwrap | |
|
9 | 8 | import sys |
|
10 | 9 | from warnings import warn |
|
11 | 10 | |
|
12 | 11 | from traitlets.utils.importstring import import_item |
|
13 | 12 | from IPython.core import magic_arguments, page |
|
14 | 13 | from IPython.core.error import UsageError |
|
15 | 14 | from IPython.core.magic import Magics, magics_class, line_magic, magic_escapes |
|
16 | 15 | from IPython.utils.text import format_screen, dedent, indent |
|
17 | 16 | from IPython.testing.skipdoctest import skip_doctest |
|
18 | 17 | from IPython.utils.ipstruct import Struct |
|
19 | 18 | |
|
20 | 19 | |
|
21 | 20 | class MagicsDisplay(object): |
|
22 | 21 | def __init__(self, magics_manager, ignore=None): |
|
23 | 22 | self.ignore = ignore if ignore else [] |
|
24 | 23 | self.magics_manager = magics_manager |
|
25 | 24 | |
|
26 | 25 | def _lsmagic(self): |
|
27 | 26 | """The main implementation of the %lsmagic""" |
|
28 | 27 | mesc = magic_escapes['line'] |
|
29 | 28 | cesc = magic_escapes['cell'] |
|
30 | 29 | mman = self.magics_manager |
|
31 | 30 | magics = mman.lsmagic() |
|
32 | 31 | out = ['Available line magics:', |
|
33 | 32 | mesc + (' '+mesc).join(sorted([m for m,v in magics['line'].items() if (v not in self.ignore)])), |
|
34 | 33 | '', |
|
35 | 34 | 'Available cell magics:', |
|
36 | 35 | cesc + (' '+cesc).join(sorted([m for m,v in magics['cell'].items() if (v not in self.ignore)])), |
|
37 | 36 | '', |
|
38 | 37 | mman.auto_status()] |
|
39 | 38 | return '\n'.join(out) |
|
40 | 39 | |
|
41 | 40 | def _repr_pretty_(self, p, cycle): |
|
42 | 41 | p.text(self._lsmagic()) |
|
43 | 42 | |
|
44 | 43 | def __str__(self): |
|
45 | 44 | return self._lsmagic() |
|
46 | 45 | |
|
47 | 46 | def _jsonable(self): |
|
48 | 47 | """turn magics dict into jsonable dict of the same structure |
|
49 | 48 | |
|
50 | 49 | replaces object instances with their class names as strings |
|
51 | 50 | """ |
|
52 | 51 | magic_dict = {} |
|
53 | 52 | mman = self.magics_manager |
|
54 | 53 | magics = mman.lsmagic() |
|
55 | 54 | for key, subdict in magics.items(): |
|
56 | 55 | d = {} |
|
57 | 56 | magic_dict[key] = d |
|
58 | 57 | for name, obj in subdict.items(): |
|
59 | 58 | try: |
|
60 | 59 | classname = obj.__self__.__class__.__name__ |
|
61 | 60 | except AttributeError: |
|
62 | 61 | classname = 'Other' |
|
63 | 62 | |
|
64 | 63 | d[name] = classname |
|
65 | 64 | return magic_dict |
|
66 | 65 | |
|
67 | 66 | def _repr_json_(self): |
|
68 | 67 | return self._jsonable() |
|
69 | 68 | |
|
70 | 69 | |
|
71 | 70 | @magics_class |
|
72 | 71 | class BasicMagics(Magics): |
|
73 | 72 | """Magics that provide central IPython functionality. |
|
74 | 73 | |
|
75 | 74 | These are various magics that don't fit into specific categories but that |
|
76 | 75 | are all part of the base 'IPython experience'.""" |
|
77 | 76 | |
|
78 | 77 | @magic_arguments.magic_arguments() |
|
79 | 78 | @magic_arguments.argument( |
|
80 | 79 | '-l', '--line', action='store_true', |
|
81 | 80 | help="""Create a line magic alias.""" |
|
82 | 81 | ) |
|
83 | 82 | @magic_arguments.argument( |
|
84 | 83 | '-c', '--cell', action='store_true', |
|
85 | 84 | help="""Create a cell magic alias.""" |
|
86 | 85 | ) |
|
87 | 86 | @magic_arguments.argument( |
|
88 | 87 | 'name', |
|
89 | 88 | help="""Name of the magic to be created.""" |
|
90 | 89 | ) |
|
91 | 90 | @magic_arguments.argument( |
|
92 | 91 | 'target', |
|
93 | 92 | help="""Name of the existing line or cell magic.""" |
|
94 | 93 | ) |
|
95 | 94 | @magic_arguments.argument( |
|
96 | 95 | '-p', '--params', default=None, |
|
97 | 96 | help="""Parameters passed to the magic function.""" |
|
98 | 97 | ) |
|
99 | 98 | @line_magic |
|
100 | 99 | def alias_magic(self, line=''): |
|
101 | 100 | """Create an alias for an existing line or cell magic. |
|
102 | 101 | |
|
103 | 102 | Examples |
|
104 | 103 | -------- |
|
105 | 104 | :: |
|
106 | 105 | |
|
107 | 106 | In [1]: %alias_magic t timeit |
|
108 | 107 | Created `%t` as an alias for `%timeit`. |
|
109 | 108 | Created `%%t` as an alias for `%%timeit`. |
|
110 | 109 | |
|
111 | 110 | In [2]: %t -n1 pass |
|
112 | 111 | 1 loops, best of 3: 954 ns per loop |
|
113 | 112 | |
|
114 | 113 | In [3]: %%t -n1 |
|
115 | 114 | ...: pass |
|
116 | 115 | ...: |
|
117 | 116 | 1 loops, best of 3: 954 ns per loop |
|
118 | 117 | |
|
119 | 118 | In [4]: %alias_magic --cell whereami pwd |
|
120 | 119 | UsageError: Cell magic function `%%pwd` not found. |
|
121 | 120 | In [5]: %alias_magic --line whereami pwd |
|
122 | 121 | Created `%whereami` as an alias for `%pwd`. |
|
123 | 122 | |
|
124 | 123 | In [6]: %whereami |
|
125 | 124 | Out[6]: u'/home/testuser' |
|
126 | 125 | |
|
127 | 126 | In [7]: %alias_magic h history "-p -l 30" --line |
|
128 | 127 | Created `%h` as an alias for `%history -l 30`. |
|
129 | 128 | """ |
|
130 | 129 | |
|
131 | 130 | args = magic_arguments.parse_argstring(self.alias_magic, line) |
|
132 | 131 | shell = self.shell |
|
133 | 132 | mman = self.shell.magics_manager |
|
134 | 133 | escs = ''.join(magic_escapes.values()) |
|
135 | 134 | |
|
136 | 135 | target = args.target.lstrip(escs) |
|
137 | 136 | name = args.name.lstrip(escs) |
|
138 | 137 | |
|
139 | 138 | params = args.params |
|
140 | 139 | if (params and |
|
141 | 140 | ((params.startswith('"') and params.endswith('"')) |
|
142 | 141 | or (params.startswith("'") and params.endswith("'")))): |
|
143 | 142 | params = params[1:-1] |
|
144 | 143 | |
|
145 | 144 | # Find the requested magics. |
|
146 | 145 | m_line = shell.find_magic(target, 'line') |
|
147 | 146 | m_cell = shell.find_magic(target, 'cell') |
|
148 | 147 | if args.line and m_line is None: |
|
149 | 148 | raise UsageError('Line magic function `%s%s` not found.' % |
|
150 | 149 | (magic_escapes['line'], target)) |
|
151 | 150 | if args.cell and m_cell is None: |
|
152 | 151 | raise UsageError('Cell magic function `%s%s` not found.' % |
|
153 | 152 | (magic_escapes['cell'], target)) |
|
154 | 153 | |
|
155 | 154 | # If --line and --cell are not specified, default to the ones |
|
156 | 155 | # that are available. |
|
157 | 156 | if not args.line and not args.cell: |
|
158 | 157 | if not m_line and not m_cell: |
|
159 | 158 | raise UsageError( |
|
160 | 159 | 'No line or cell magic with name `%s` found.' % target |
|
161 | 160 | ) |
|
162 | 161 | args.line = bool(m_line) |
|
163 | 162 | args.cell = bool(m_cell) |
|
164 | 163 | |
|
165 | 164 | params_str = "" if params is None else " " + params |
|
166 | 165 | |
|
167 | 166 | if args.line: |
|
168 | 167 | mman.register_alias(name, target, 'line', params) |
|
169 | 168 | print('Created `%s%s` as an alias for `%s%s%s`.' % ( |
|
170 | 169 | magic_escapes['line'], name, |
|
171 | 170 | magic_escapes['line'], target, params_str)) |
|
172 | 171 | |
|
173 | 172 | if args.cell: |
|
174 | 173 | mman.register_alias(name, target, 'cell', params) |
|
175 | 174 | print('Created `%s%s` as an alias for `%s%s%s`.' % ( |
|
176 | 175 | magic_escapes['cell'], name, |
|
177 | 176 | magic_escapes['cell'], target, params_str)) |
|
178 | 177 | |
|
179 | 178 | @line_magic |
|
180 | 179 | def lsmagic(self, parameter_s=''): |
|
181 | 180 | """List currently available magic functions.""" |
|
182 | 181 | return MagicsDisplay(self.shell.magics_manager, ignore=[]) |
|
183 | 182 | |
|
184 | 183 | def _magic_docs(self, brief=False, rest=False): |
|
185 | 184 | """Return docstrings from magic functions.""" |
|
186 | 185 | mman = self.shell.magics_manager |
|
187 | 186 | docs = mman.lsmagic_docs(brief, missing='No documentation') |
|
188 | 187 | |
|
189 | 188 | if rest: |
|
190 | 189 | format_string = '**%s%s**::\n\n%s\n\n' |
|
191 | 190 | else: |
|
192 | 191 | format_string = '%s%s:\n%s\n' |
|
193 | 192 | |
|
194 | 193 | return ''.join( |
|
195 | 194 | [format_string % (magic_escapes['line'], fname, |
|
196 | 195 | indent(dedent(fndoc))) |
|
197 | 196 | for fname, fndoc in sorted(docs['line'].items())] |
|
198 | 197 | + |
|
199 | 198 | [format_string % (magic_escapes['cell'], fname, |
|
200 | 199 | indent(dedent(fndoc))) |
|
201 | 200 | for fname, fndoc in sorted(docs['cell'].items())] |
|
202 | 201 | ) |
|
203 | 202 | |
|
204 | 203 | @line_magic |
|
205 | 204 | def magic(self, parameter_s=''): |
|
206 | 205 | """Print information about the magic function system. |
|
207 | 206 | |
|
208 | 207 | Supported formats: -latex, -brief, -rest |
|
209 | 208 | """ |
|
210 | 209 | |
|
211 | 210 | mode = '' |
|
212 | 211 | try: |
|
213 | 212 | mode = parameter_s.split()[0][1:] |
|
214 | 213 | except IndexError: |
|
215 | 214 | pass |
|
216 | 215 | |
|
217 | 216 | brief = (mode == 'brief') |
|
218 | 217 | rest = (mode == 'rest') |
|
219 | 218 | magic_docs = self._magic_docs(brief, rest) |
|
220 | 219 | |
|
221 | 220 | if mode == 'latex': |
|
222 | 221 | print(self.format_latex(magic_docs)) |
|
223 | 222 | return |
|
224 | 223 | else: |
|
225 | 224 | magic_docs = format_screen(magic_docs) |
|
226 | 225 | |
|
227 | 226 | out = [""" |
|
228 | 227 | IPython's 'magic' functions |
|
229 | 228 | =========================== |
|
230 | 229 | |
|
231 | 230 | The magic function system provides a series of functions which allow you to |
|
232 | 231 | control the behavior of IPython itself, plus a lot of system-type |
|
233 | 232 | features. There are two kinds of magics, line-oriented and cell-oriented. |
|
234 | 233 | |
|
235 | 234 | Line magics are prefixed with the % character and work much like OS |
|
236 | 235 | command-line calls: they get as an argument the rest of the line, where |
|
237 | 236 | arguments are passed without parentheses or quotes. For example, this will |
|
238 | 237 | time the given statement:: |
|
239 | 238 | |
|
240 | 239 | %timeit range(1000) |
|
241 | 240 | |
|
242 | 241 | Cell magics are prefixed with a double %%, and they are functions that get as |
|
243 | 242 | an argument not only the rest of the line, but also the lines below it in a |
|
244 | 243 | separate argument. These magics are called with two arguments: the rest of the |
|
245 | 244 | call line and the body of the cell, consisting of the lines below the first. |
|
246 | 245 | For example:: |
|
247 | 246 | |
|
248 | 247 | %%timeit x = numpy.random.randn((100, 100)) |
|
249 | 248 | numpy.linalg.svd(x) |
|
250 | 249 | |
|
251 | 250 | will time the execution of the numpy svd routine, running the assignment of x |
|
252 | 251 | as part of the setup phase, which is not timed. |
|
253 | 252 | |
|
254 | 253 | In a line-oriented client (the terminal or Qt console IPython), starting a new |
|
255 | 254 | input with %% will automatically enter cell mode, and IPython will continue |
|
256 | 255 | reading input until a blank line is given. In the notebook, simply type the |
|
257 | 256 | whole cell as one entity, but keep in mind that the %% escape can only be at |
|
258 | 257 | the very start of the cell. |
|
259 | 258 | |
|
260 | 259 | NOTE: If you have 'automagic' enabled (via the command line option or with the |
|
261 | 260 | %automagic function), you don't need to type in the % explicitly for line |
|
262 | 261 | magics; cell magics always require an explicit '%%' escape. By default, |
|
263 | 262 | IPython ships with automagic on, so you should only rarely need the % escape. |
|
264 | 263 | |
|
265 | 264 | Example: typing '%cd mydir' (without the quotes) changes your working directory |
|
266 | 265 | to 'mydir', if it exists. |
|
267 | 266 | |
|
268 | 267 | For a list of the available magic functions, use %lsmagic. For a description |
|
269 | 268 | of any of them, type %magic_name?, e.g. '%cd?'. |
|
270 | 269 | |
|
271 | 270 | Currently the magic system has the following functions:""", |
|
272 | 271 | magic_docs, |
|
273 | 272 | "Summary of magic functions (from %slsmagic):" % magic_escapes['line'], |
|
274 | 273 | str(self.lsmagic()), |
|
275 | 274 | ] |
|
276 | 275 | page.page('\n'.join(out)) |
|
277 | 276 | |
|
278 | 277 | |
|
279 | 278 | @line_magic |
|
280 | 279 | def page(self, parameter_s=''): |
|
281 | 280 | """Pretty print the object and display it through a pager. |
|
282 | 281 | |
|
283 | 282 | %page [options] OBJECT |
|
284 | 283 | |
|
285 | 284 | If no object is given, use _ (last output). |
|
286 | 285 | |
|
287 | 286 | Options: |
|
288 | 287 | |
|
289 | 288 | -r: page str(object), don't pretty-print it.""" |
|
290 | 289 | |
|
291 | 290 | # After a function contributed by Olivier Aubert, slightly modified. |
|
292 | 291 | |
|
293 | 292 | # Process options/args |
|
294 | 293 | opts, args = self.parse_options(parameter_s, 'r') |
|
295 | 294 | raw = 'r' in opts |
|
296 | 295 | |
|
297 | 296 | oname = args and args or '_' |
|
298 | 297 | info = self.shell._ofind(oname) |
|
299 | 298 | if info['found']: |
|
300 | 299 | txt = (raw and str or pformat)( info['obj'] ) |
|
301 | 300 | page.page(txt) |
|
302 | 301 | else: |
|
303 | 302 | print('Object `%s` not found' % oname) |
|
304 | 303 | |
|
305 | 304 | @line_magic |
|
306 | 305 | def pprint(self, parameter_s=''): |
|
307 | 306 | """Toggle pretty printing on/off.""" |
|
308 | 307 | ptformatter = self.shell.display_formatter.formatters['text/plain'] |
|
309 | 308 | ptformatter.pprint = bool(1 - ptformatter.pprint) |
|
310 | 309 | print('Pretty printing has been turned', |
|
311 | 310 | ['OFF','ON'][ptformatter.pprint]) |
|
312 | 311 | |
|
313 | 312 | @line_magic |
|
314 | 313 | def colors(self, parameter_s=''): |
|
315 | 314 | """Switch color scheme for prompts, info system and exception handlers. |
|
316 | 315 | |
|
317 | 316 | Currently implemented schemes: NoColor, Linux, LightBG. |
|
318 | 317 | |
|
319 | 318 | Color scheme names are not case-sensitive. |
|
320 | 319 | |
|
321 | 320 | Examples |
|
322 | 321 | -------- |
|
323 | 322 | To get a plain black and white terminal:: |
|
324 | 323 | |
|
325 | 324 | %colors nocolor |
|
326 | 325 | """ |
|
327 | 326 | def color_switch_err(name): |
|
328 | 327 | warn('Error changing %s color schemes.\n%s' % |
|
329 | 328 | (name, sys.exc_info()[1]), stacklevel=2) |
|
330 | 329 | |
|
331 | 330 | |
|
332 | 331 | new_scheme = parameter_s.strip() |
|
333 | 332 | if not new_scheme: |
|
334 | 333 | raise UsageError( |
|
335 | 334 | "%colors: you must specify a color scheme. See '%colors?'") |
|
336 | 335 | # local shortcut |
|
337 | 336 | shell = self.shell |
|
338 | 337 | |
|
339 | 338 | # Set shell colour scheme |
|
340 | 339 | try: |
|
341 | 340 | shell.colors = new_scheme |
|
342 | 341 | shell.refresh_style() |
|
343 | 342 | except: |
|
344 | 343 | color_switch_err('shell') |
|
345 | 344 | |
|
346 | 345 | # Set exception colors |
|
347 | 346 | try: |
|
348 | 347 | shell.InteractiveTB.set_colors(scheme = new_scheme) |
|
349 | 348 | shell.SyntaxTB.set_colors(scheme = new_scheme) |
|
350 | 349 | except: |
|
351 | 350 | color_switch_err('exception') |
|
352 | 351 | |
|
353 | 352 | # Set info (for 'object?') colors |
|
354 | 353 | if shell.color_info: |
|
355 | 354 | try: |
|
356 | 355 | shell.inspector.set_active_scheme(new_scheme) |
|
357 | 356 | except: |
|
358 | 357 | color_switch_err('object inspector') |
|
359 | 358 | else: |
|
360 | 359 | shell.inspector.set_active_scheme('NoColor') |
|
361 | 360 | |
|
362 | 361 | @line_magic |
|
363 | 362 | def xmode(self, parameter_s=''): |
|
364 | 363 | """Switch modes for the exception handlers. |
|
365 | 364 | |
|
366 | 365 | Valid modes: Plain, Context, Verbose, and Minimal. |
|
367 | 366 | |
|
368 | 367 | If called without arguments, acts as a toggle.""" |
|
369 | 368 | |
|
370 | 369 | def xmode_switch_err(name): |
|
371 | 370 | warn('Error changing %s exception modes.\n%s' % |
|
372 | 371 | (name,sys.exc_info()[1])) |
|
373 | 372 | |
|
374 | 373 | shell = self.shell |
|
375 | 374 | new_mode = parameter_s.strip().capitalize() |
|
376 | 375 | try: |
|
377 | 376 | shell.InteractiveTB.set_mode(mode=new_mode) |
|
378 | 377 | print('Exception reporting mode:',shell.InteractiveTB.mode) |
|
379 | 378 | except: |
|
380 | 379 | xmode_switch_err('user') |
|
381 | 380 | |
|
382 | 381 | @line_magic |
|
383 | 382 | def quickref(self, arg): |
|
384 | 383 | """ Show a quick reference sheet """ |
|
385 | 384 | from IPython.core.usage import quick_reference |
|
386 | 385 | qr = quick_reference + self._magic_docs(brief=True) |
|
387 | 386 | page.page(qr) |
|
388 | 387 | |
|
389 | 388 | @line_magic |
|
390 | 389 | def doctest_mode(self, parameter_s=''): |
|
391 | 390 | """Toggle doctest mode on and off. |
|
392 | 391 | |
|
393 | 392 | This mode is intended to make IPython behave as much as possible like a |
|
394 | 393 | plain Python shell, from the perspective of how its prompts, exceptions |
|
395 | 394 | and output look. This makes it easy to copy and paste parts of a |
|
396 | 395 | session into doctests. It does so by: |
|
397 | 396 | |
|
398 | 397 | - Changing the prompts to the classic ``>>>`` ones. |
|
399 | 398 | - Changing the exception reporting mode to 'Plain'. |
|
400 | 399 | - Disabling pretty-printing of output. |
|
401 | 400 | |
|
402 | 401 | Note that IPython also supports the pasting of code snippets that have |
|
403 | 402 | leading '>>>' and '...' prompts in them. This means that you can paste |
|
404 | 403 | doctests from files or docstrings (even if they have leading |
|
405 | 404 | whitespace), and the code will execute correctly. You can then use |
|
406 | 405 | '%history -t' to see the translated history; this will give you the |
|
407 | 406 | input after removal of all the leading prompts and whitespace, which |
|
408 | 407 | can be pasted back into an editor. |
|
409 | 408 | |
|
410 | 409 | With these features, you can switch into this mode easily whenever you |
|
411 | 410 | need to do testing and changes to doctests, without having to leave |
|
412 | 411 | your existing IPython session. |
|
413 | 412 | """ |
|
414 | 413 | |
|
415 | 414 | # Shorthands |
|
416 | 415 | shell = self.shell |
|
417 | 416 | meta = shell.meta |
|
418 | 417 | disp_formatter = self.shell.display_formatter |
|
419 | 418 | ptformatter = disp_formatter.formatters['text/plain'] |
|
420 | 419 | # dstore is a data store kept in the instance metadata bag to track any |
|
421 | 420 | # changes we make, so we can undo them later. |
|
422 | 421 | dstore = meta.setdefault('doctest_mode',Struct()) |
|
423 | 422 | save_dstore = dstore.setdefault |
|
424 | 423 | |
|
425 | 424 | # save a few values we'll need to recover later |
|
426 | 425 | mode = save_dstore('mode',False) |
|
427 | 426 | save_dstore('rc_pprint',ptformatter.pprint) |
|
428 | 427 | save_dstore('xmode',shell.InteractiveTB.mode) |
|
429 | 428 | save_dstore('rc_separate_out',shell.separate_out) |
|
430 | 429 | save_dstore('rc_separate_out2',shell.separate_out2) |
|
431 | 430 | save_dstore('rc_separate_in',shell.separate_in) |
|
432 | 431 | save_dstore('rc_active_types',disp_formatter.active_types) |
|
433 | 432 | |
|
434 | 433 | if not mode: |
|
435 | 434 | # turn on |
|
436 | 435 | |
|
437 | 436 | # Prompt separators like plain python |
|
438 | 437 | shell.separate_in = '' |
|
439 | 438 | shell.separate_out = '' |
|
440 | 439 | shell.separate_out2 = '' |
|
441 | 440 | |
|
442 | 441 | |
|
443 | 442 | ptformatter.pprint = False |
|
444 | 443 | disp_formatter.active_types = ['text/plain'] |
|
445 | 444 | |
|
446 | 445 | shell.magic('xmode Plain') |
|
447 | 446 | else: |
|
448 | 447 | # turn off |
|
449 | 448 | shell.separate_in = dstore.rc_separate_in |
|
450 | 449 | |
|
451 | 450 | shell.separate_out = dstore.rc_separate_out |
|
452 | 451 | shell.separate_out2 = dstore.rc_separate_out2 |
|
453 | 452 | |
|
454 | 453 | ptformatter.pprint = dstore.rc_pprint |
|
455 | 454 | disp_formatter.active_types = dstore.rc_active_types |
|
456 | 455 | |
|
457 | 456 | shell.magic('xmode ' + dstore.xmode) |
|
458 | 457 | |
|
459 | 458 | # mode here is the state before we switch; switch_doctest_mode takes |
|
460 | 459 | # the mode we're switching to. |
|
461 | 460 | shell.switch_doctest_mode(not mode) |
|
462 | 461 | |
|
463 | 462 | # Store new mode and inform |
|
464 | 463 | dstore.mode = bool(not mode) |
|
465 | 464 | mode_label = ['OFF','ON'][dstore.mode] |
|
466 | 465 | print('Doctest mode is:', mode_label) |
|
467 | 466 | |
|
468 | 467 | @line_magic |
|
469 | 468 | def gui(self, parameter_s=''): |
|
470 | 469 | """Enable or disable IPython GUI event loop integration. |
|
471 | 470 | |
|
472 | 471 | %gui [GUINAME] |
|
473 | 472 | |
|
474 | 473 | This magic replaces IPython's threaded shells that were activated |
|
475 | 474 | using the (pylab/wthread/etc.) command line flags. GUI toolkits |
|
476 | 475 | can now be enabled at runtime and keyboard |
|
477 | 476 | interrupts should work without any problems. The following toolkits |
|
478 | 477 | are supported: wxPython, PyQt4, PyGTK, Tk and Cocoa (OSX):: |
|
479 | 478 | |
|
480 | 479 | %gui wx # enable wxPython event loop integration |
|
481 | 480 | %gui qt4|qt # enable PyQt4 event loop integration |
|
482 | 481 | %gui qt5 # enable PyQt5 event loop integration |
|
483 | 482 | %gui gtk # enable PyGTK event loop integration |
|
484 | 483 | %gui gtk3 # enable Gtk3 event loop integration |
|
485 | 484 | %gui tk # enable Tk event loop integration |
|
486 | 485 | %gui osx # enable Cocoa event loop integration |
|
487 | 486 | # (requires %matplotlib 1.1) |
|
488 | 487 | %gui # disable all event loop integration |
|
489 | 488 | |
|
490 | 489 | WARNING: after any of these has been called you can simply create |
|
491 | 490 | an application object, but DO NOT start the event loop yourself, as |
|
492 | 491 | we have already handled that. |
|
493 | 492 | """ |
|
494 | 493 | opts, arg = self.parse_options(parameter_s, '') |
|
495 | 494 | if arg=='': arg = None |
|
496 | 495 | try: |
|
497 | 496 | return self.shell.enable_gui(arg) |
|
498 | 497 | except Exception as e: |
|
499 | 498 | # print simple error message, rather than traceback if we can't |
|
500 | 499 | # hook up the GUI |
|
501 | 500 | error(str(e)) |
|
502 | 501 | |
|
503 | 502 | @skip_doctest |
|
504 | 503 | @line_magic |
|
505 | 504 | def precision(self, s=''): |
|
506 | 505 | """Set floating point precision for pretty printing. |
|
507 | 506 | |
|
508 | 507 | Can set either integer precision or a format string. |
|
509 | 508 | |
|
510 | 509 | If numpy has been imported and precision is an int, |
|
511 | 510 | numpy display precision will also be set, via ``numpy.set_printoptions``. |
|
512 | 511 | |
|
513 | 512 | If no argument is given, defaults will be restored. |
|
514 | 513 | |
|
515 | 514 | Examples |
|
516 | 515 | -------- |
|
517 | 516 | :: |
|
518 | 517 | |
|
519 | 518 | In [1]: from math import pi |
|
520 | 519 | |
|
521 | 520 | In [2]: %precision 3 |
|
522 | 521 | Out[2]: u'%.3f' |
|
523 | 522 | |
|
524 | 523 | In [3]: pi |
|
525 | 524 | Out[3]: 3.142 |
|
526 | 525 | |
|
527 | 526 | In [4]: %precision %i |
|
528 | 527 | Out[4]: u'%i' |
|
529 | 528 | |
|
530 | 529 | In [5]: pi |
|
531 | 530 | Out[5]: 3 |
|
532 | 531 | |
|
533 | 532 | In [6]: %precision %e |
|
534 | 533 | Out[6]: u'%e' |
|
535 | 534 | |
|
536 | 535 | In [7]: pi**10 |
|
537 | 536 | Out[7]: 9.364805e+04 |
|
538 | 537 | |
|
539 | 538 | In [8]: %precision |
|
540 | 539 | Out[8]: u'%r' |
|
541 | 540 | |
|
542 | 541 | In [9]: pi**10 |
|
543 | 542 | Out[9]: 93648.047476082982 |
|
544 | 543 | """ |
|
545 | 544 | ptformatter = self.shell.display_formatter.formatters['text/plain'] |
|
546 | 545 | ptformatter.float_precision = s |
|
547 | 546 | return ptformatter.float_format |
|
548 | 547 | |
|
549 | 548 | @magic_arguments.magic_arguments() |
|
550 | 549 | @magic_arguments.argument( |
|
551 | 550 | '-e', '--export', action='store_true', default=False, |
|
552 | 551 | help=argparse.SUPPRESS |
|
553 | 552 | ) |
|
554 | 553 | @magic_arguments.argument( |
|
555 | 554 | 'filename', type=str, |
|
556 | 555 | help='Notebook name or filename' |
|
557 | 556 | ) |
|
558 | 557 | @line_magic |
|
559 | 558 | def notebook(self, s): |
|
560 | 559 | """Export and convert IPython notebooks. |
|
561 | 560 | |
|
562 | 561 | This function can export the current IPython history to a notebook file. |
|
563 | 562 | For example, to export the history to "foo.ipynb" do "%notebook foo.ipynb". |
|
564 | 563 | |
|
565 | 564 | The -e or --export flag is deprecated in IPython 5.2, and will be |
|
566 | 565 | removed in the future. |
|
567 | 566 | """ |
|
568 | 567 | args = magic_arguments.parse_argstring(self.notebook, s) |
|
569 | 568 | |
|
570 | 569 | from nbformat import write, v4 |
|
571 | 570 | |
|
572 | 571 | cells = [] |
|
573 | 572 | hist = list(self.shell.history_manager.get_range()) |
|
574 | 573 | if(len(hist)<=1): |
|
575 | 574 | raise ValueError('History is empty, cannot export') |
|
576 | 575 | for session, execution_count, source in hist[:-1]: |
|
577 | 576 | cells.append(v4.new_code_cell( |
|
578 | 577 | execution_count=execution_count, |
|
579 | 578 | source=source |
|
580 | 579 | )) |
|
581 | 580 | nb = v4.new_notebook(cells=cells) |
|
582 | 581 | with io.open(args.filename, 'w', encoding='utf-8') as f: |
|
583 | 582 | write(nb, f, version=4) |
|
584 | 583 | |
|
585 | 584 | @magics_class |
|
586 | 585 | class AsyncMagics(BasicMagics): |
|
587 | 586 | |
|
588 | 587 | @line_magic |
|
589 | 588 | def autoawait(self, parameter_s): |
|
590 | 589 | """ |
|
591 | 590 | Allow to change the status of the autoawait option. |
|
592 | 591 | |
|
593 | 592 | This allow you to set a specific asynchronous code runner. |
|
594 | 593 | |
|
595 | 594 | If no value is passed, print the currently used asynchronous integration |
|
596 | 595 | and whether it is activated. |
|
597 | 596 | |
|
598 | 597 | It can take a number of value evaluated in the following order: |
|
599 | 598 | |
|
600 | 599 | - False/false/off deactivate autoawait integration |
|
601 | 600 | - True/true/on activate autoawait integration using configured default |
|
602 | 601 | loop |
|
603 | 602 | - asyncio/curio/trio activate autoawait integration and use integration |
|
604 | 603 | with said library. |
|
605 | 604 | |
|
606 | 605 | - `sync` turn on the pseudo-sync integration (mostly used for |
|
607 | 606 | `IPython.embed()` which does not run IPython with a real eventloop and |
|
608 | 607 | deactivate running asynchronous code. Turning on Asynchronous code with |
|
609 | 608 | the pseudo sync loop is undefined behavior and may lead IPython to crash. |
|
610 | 609 | |
|
611 | 610 | If the passed parameter does not match any of the above and is a python |
|
612 | 611 | identifier, get said object from user namespace and set it as the |
|
613 | 612 | runner, and activate autoawait. |
|
614 | 613 | |
|
615 | 614 | If the object is a fully qualified object name, attempt to import it and |
|
616 | 615 | set it as the runner, and activate autoawait. |
|
617 | 616 | |
|
618 | 617 | |
|
619 | 618 | The exact behavior of autoawait is experimental and subject to change |
|
620 | 619 | across version of IPython and Python. |
|
621 | 620 | """ |
|
622 | 621 | |
|
623 | 622 | param = parameter_s.strip() |
|
624 | 623 | d = {True: "on", False: "off"} |
|
625 | 624 | |
|
626 | 625 | if not param: |
|
627 | 626 | print("IPython autoawait is `{}`, and set to use `{}`".format( |
|
628 | 627 | d[self.shell.autoawait], |
|
629 | 628 | self.shell.loop_runner |
|
630 | 629 | )) |
|
631 | 630 | return None |
|
632 | 631 | |
|
633 | 632 | if param.lower() in ('false', 'off'): |
|
634 | 633 | self.shell.autoawait = False |
|
635 | 634 | return None |
|
636 | 635 | if param.lower() in ('true', 'on'): |
|
637 | 636 | self.shell.autoawait = True |
|
638 | 637 | return None |
|
639 | 638 | |
|
640 | 639 | if param in self.shell.loop_runner_map: |
|
641 | 640 | self.shell.loop_runner, self.shell.autoawait = self.shell.loop_runner_map[param] |
|
642 | 641 | return None |
|
643 | 642 | |
|
644 | 643 | if param in self.shell.user_ns : |
|
645 | 644 | self.shell.loop_runner = self.shell.user_ns[param] |
|
646 | 645 | self.shell.autoawait = True |
|
647 | 646 | return None |
|
648 | 647 | |
|
649 | 648 | runner = import_item(param) |
|
650 | 649 | |
|
651 | 650 | self.shell.loop_runner = runner |
|
652 | 651 | self.shell.autoawait = True |
@@ -1,104 +1,103 b'' | |||
|
1 | 1 | """Implementation of packaging-related magic functions. |
|
2 | 2 | """ |
|
3 | 3 | #----------------------------------------------------------------------------- |
|
4 | 4 | # Copyright (c) 2018 The IPython Development Team. |
|
5 | 5 | # |
|
6 | 6 | # Distributed under the terms of the Modified BSD License. |
|
7 | 7 | # |
|
8 | 8 | # The full license is in the file COPYING.txt, distributed with this software. |
|
9 | 9 | #----------------------------------------------------------------------------- |
|
10 | 10 | |
|
11 | 11 | import os |
|
12 | 12 | import re |
|
13 | 13 | import shlex |
|
14 | 14 | import sys |
|
15 | from subprocess import Popen, PIPE | |
|
16 | 15 | |
|
17 | 16 | from IPython.core.magic import Magics, magics_class, line_magic |
|
18 | 17 | |
|
19 | 18 | |
|
20 | 19 | def _is_conda_environment(): |
|
21 | 20 | """Return True if the current Python executable is in a conda env""" |
|
22 | 21 | # TODO: does this need to change on windows? |
|
23 | 22 | conda_history = os.path.join(sys.prefix, 'conda-meta', 'history') |
|
24 | 23 | return os.path.exists(conda_history) |
|
25 | 24 | |
|
26 | 25 | |
|
27 | 26 | def _get_conda_executable(): |
|
28 | 27 | """Find the path to the conda executable""" |
|
29 | 28 | # Check if there is a conda executable in the same directory as the Python executable. |
|
30 | 29 | # This is the case within conda's root environment. |
|
31 | 30 | conda = os.path.join(os.path.dirname(sys.executable), 'conda') |
|
32 | 31 | if os.path.isfile(conda): |
|
33 | 32 | return conda |
|
34 | 33 | |
|
35 | 34 | # Otherwise, attempt to extract the executable from conda history. |
|
36 | 35 | # This applies in any conda environment. |
|
37 | 36 | R = re.compile(r"^#\s*cmd:\s*(?P<command>.*conda)\s[create|install]") |
|
38 | 37 | with open(os.path.join(sys.prefix, 'conda-meta', 'history')) as f: |
|
39 | 38 | for line in f: |
|
40 | 39 | match = R.match(line) |
|
41 | 40 | if match: |
|
42 | 41 | return match.groupdict()['command'] |
|
43 | 42 | |
|
44 | 43 | # Fallback: assume conda is available on the system path. |
|
45 | 44 | return "conda" |
|
46 | 45 | |
|
47 | 46 | |
|
48 | 47 | CONDA_COMMANDS_REQUIRING_PREFIX = { |
|
49 | 48 | 'install', 'list', 'remove', 'uninstall', 'update', 'upgrade', |
|
50 | 49 | } |
|
51 | 50 | CONDA_COMMANDS_REQUIRING_YES = { |
|
52 | 51 | 'install', 'remove', 'uninstall', 'update', 'upgrade', |
|
53 | 52 | } |
|
54 | 53 | CONDA_ENV_FLAGS = {'-p', '--prefix', '-n', '--name'} |
|
55 | 54 | CONDA_YES_FLAGS = {'-y', '--y'} |
|
56 | 55 | |
|
57 | 56 | |
|
58 | 57 | @magics_class |
|
59 | 58 | class PackagingMagics(Magics): |
|
60 | 59 | """Magics related to packaging & installation""" |
|
61 | 60 | |
|
62 | 61 | @line_magic |
|
63 | 62 | def pip(self, line): |
|
64 | 63 | """Run the pip package manager within the current kernel. |
|
65 | 64 | |
|
66 | 65 | Usage: |
|
67 | 66 | %pip install [pkgs] |
|
68 | 67 | """ |
|
69 | 68 | self.shell.system(' '.join([sys.executable, '-m', 'pip', line])) |
|
70 | 69 | print("Note: you may need to restart the kernel to use updated packages.") |
|
71 | 70 | |
|
72 | 71 | @line_magic |
|
73 | 72 | def conda(self, line): |
|
74 | 73 | """Run the conda package manager within the current kernel. |
|
75 | 74 | |
|
76 | 75 | Usage: |
|
77 | 76 | %conda install [pkgs] |
|
78 | 77 | """ |
|
79 | 78 | if not _is_conda_environment(): |
|
80 | 79 | raise ValueError("The python kernel does not appear to be a conda environment. " |
|
81 | 80 | "Please use ``%pip install`` instead.") |
|
82 | 81 | |
|
83 | 82 | conda = _get_conda_executable() |
|
84 | 83 | args = shlex.split(line) |
|
85 | 84 | command = args[0] |
|
86 | 85 | args = args[1:] |
|
87 | 86 | extra_args = [] |
|
88 | 87 | |
|
89 | 88 | # When the subprocess does not allow us to respond "yes" during the installation, |
|
90 | 89 | # we need to insert --yes in the argument list for some commands |
|
91 | 90 | stdin_disabled = getattr(self.shell, 'kernel', None) is not None |
|
92 | 91 | needs_yes = command in CONDA_COMMANDS_REQUIRING_YES |
|
93 | 92 | has_yes = set(args).intersection(CONDA_YES_FLAGS) |
|
94 | 93 | if stdin_disabled and needs_yes and not has_yes: |
|
95 | 94 | extra_args.append("--yes") |
|
96 | 95 | |
|
97 | 96 | # Add --prefix to point conda installation to the current environment |
|
98 | 97 | needs_prefix = command in CONDA_COMMANDS_REQUIRING_PREFIX |
|
99 | 98 | has_prefix = set(args).intersection(CONDA_ENV_FLAGS) |
|
100 | 99 | if needs_prefix and not has_prefix: |
|
101 | 100 | extra_args.extend(["--prefix", sys.prefix]) |
|
102 | 101 | |
|
103 | 102 | self.shell.system(' '.join([conda, command] + extra_args + args)) |
|
104 | print("\nNote: you may need to restart the kernel to use updated packages.") No newline at end of file | |
|
103 | print("\nNote: you may need to restart the kernel to use updated packages.") |
@@ -1,47 +1,46 b'' | |||
|
1 | 1 | """Minimal script to reproduce our nasty reference counting bug. |
|
2 | 2 | |
|
3 | 3 | The problem is related to https://github.com/ipython/ipython/issues/141 |
|
4 | 4 | |
|
5 | 5 | The original fix for that appeared to work, but John D. Hunter found a |
|
6 | 6 | matplotlib example which, when run twice in a row, would break. The problem |
|
7 | 7 | were references held by open figures to internals of Tkinter. |
|
8 | 8 | |
|
9 | 9 | This code reproduces the problem that John saw, without matplotlib. |
|
10 | 10 | |
|
11 | 11 | This script is meant to be called by other parts of the test suite that call it |
|
12 | 12 | via %run as if it were executed interactively by the user. As of 2011-05-29, |
|
13 | 13 | test_run.py calls it. |
|
14 | 14 | """ |
|
15 | 15 | |
|
16 | 16 | #----------------------------------------------------------------------------- |
|
17 | 17 | # Module imports |
|
18 | 18 | #----------------------------------------------------------------------------- |
|
19 | import sys | |
|
20 | 19 | |
|
21 | 20 | from IPython import get_ipython |
|
22 | 21 | |
|
23 | 22 | #----------------------------------------------------------------------------- |
|
24 | 23 | # Globals |
|
25 | 24 | #----------------------------------------------------------------------------- |
|
26 | 25 | |
|
27 | 26 | # This needs to be here because nose and other test runners will import |
|
28 | 27 | # this module. Importing this module has potential side effects that we |
|
29 | 28 | # want to prevent. |
|
30 | 29 | if __name__ == '__main__': |
|
31 | 30 | |
|
32 | 31 | ip = get_ipython() |
|
33 | 32 | |
|
34 | 33 | if not '_refbug_cache' in ip.user_ns: |
|
35 | 34 | ip.user_ns['_refbug_cache'] = [] |
|
36 | 35 | |
|
37 | 36 | |
|
38 | 37 | aglobal = 'Hello' |
|
39 | 38 | def f(): |
|
40 | 39 | return aglobal |
|
41 | 40 | |
|
42 | 41 | cache = ip.user_ns['_refbug_cache'] |
|
43 | 42 | cache.append(f) |
|
44 | 43 | |
|
45 | 44 | def call_f(): |
|
46 | 45 | for func in cache: |
|
47 | 46 | print('lowercased:',func().lower()) |
@@ -1,310 +1,309 b'' | |||
|
1 | 1 | """ |
|
2 | 2 | Test for async helpers. |
|
3 | 3 | |
|
4 | 4 | Should only trigger on python 3.5+ or will have syntax errors. |
|
5 | 5 | """ |
|
6 | import sys | |
|
7 | 6 | from itertools import chain, repeat |
|
8 | 7 | import nose.tools as nt |
|
9 | 8 | from textwrap import dedent, indent |
|
10 | 9 | from unittest import TestCase |
|
11 | 10 | from IPython.testing.decorators import skip_without |
|
12 | 11 | |
|
13 | 12 | |
|
14 | 13 | iprc = lambda x: ip.run_cell(dedent(x)).raise_error() |
|
15 | 14 | iprc_nr = lambda x: ip.run_cell(dedent(x)) |
|
16 | 15 | |
|
17 | 16 | from IPython.core.async_helpers import _should_be_async |
|
18 | 17 | |
|
19 | 18 | class AsyncTest(TestCase): |
|
20 | 19 | def test_should_be_async(self): |
|
21 | 20 | nt.assert_false(_should_be_async("False")) |
|
22 | 21 | nt.assert_true(_should_be_async("await bar()")) |
|
23 | 22 | nt.assert_true(_should_be_async("x = await bar()")) |
|
24 | 23 | nt.assert_false( |
|
25 | 24 | _should_be_async( |
|
26 | 25 | dedent( |
|
27 | 26 | """ |
|
28 | 27 | async def awaitable(): |
|
29 | 28 | pass |
|
30 | 29 | """ |
|
31 | 30 | ) |
|
32 | 31 | ) |
|
33 | 32 | ) |
|
34 | 33 | |
|
35 | 34 | def _get_top_level_cases(self): |
|
36 | 35 | # These are test cases that should be valid in a function |
|
37 | 36 | # but invalid outside of a function. |
|
38 | 37 | test_cases = [] |
|
39 | 38 | test_cases.append(('basic', "{val}")) |
|
40 | 39 | |
|
41 | 40 | # Note, in all conditional cases, I use True instead of |
|
42 | 41 | # False so that the peephole optimizer won't optimize away |
|
43 | 42 | # the return, so CPython will see this as a syntax error: |
|
44 | 43 | # |
|
45 | 44 | # while True: |
|
46 | 45 | # break |
|
47 | 46 | # return |
|
48 | 47 | # |
|
49 | 48 | # But not this: |
|
50 | 49 | # |
|
51 | 50 | # while False: |
|
52 | 51 | # return |
|
53 | 52 | # |
|
54 | 53 | # See https://bugs.python.org/issue1875 |
|
55 | 54 | |
|
56 | 55 | test_cases.append(('if', dedent(""" |
|
57 | 56 | if True: |
|
58 | 57 | {val} |
|
59 | 58 | """))) |
|
60 | 59 | |
|
61 | 60 | test_cases.append(('while', dedent(""" |
|
62 | 61 | while True: |
|
63 | 62 | {val} |
|
64 | 63 | break |
|
65 | 64 | """))) |
|
66 | 65 | |
|
67 | 66 | test_cases.append(('try', dedent(""" |
|
68 | 67 | try: |
|
69 | 68 | {val} |
|
70 | 69 | except: |
|
71 | 70 | pass |
|
72 | 71 | """))) |
|
73 | 72 | |
|
74 | 73 | test_cases.append(('except', dedent(""" |
|
75 | 74 | try: |
|
76 | 75 | pass |
|
77 | 76 | except: |
|
78 | 77 | {val} |
|
79 | 78 | """))) |
|
80 | 79 | |
|
81 | 80 | test_cases.append(('finally', dedent(""" |
|
82 | 81 | try: |
|
83 | 82 | pass |
|
84 | 83 | except: |
|
85 | 84 | pass |
|
86 | 85 | finally: |
|
87 | 86 | {val} |
|
88 | 87 | """))) |
|
89 | 88 | |
|
90 | 89 | test_cases.append(('for', dedent(""" |
|
91 | 90 | for _ in range(4): |
|
92 | 91 | {val} |
|
93 | 92 | """))) |
|
94 | 93 | |
|
95 | 94 | |
|
96 | 95 | test_cases.append(('nested', dedent(""" |
|
97 | 96 | if True: |
|
98 | 97 | while True: |
|
99 | 98 | {val} |
|
100 | 99 | break |
|
101 | 100 | """))) |
|
102 | 101 | |
|
103 | 102 | test_cases.append(('deep-nested', dedent(""" |
|
104 | 103 | if True: |
|
105 | 104 | while True: |
|
106 | 105 | break |
|
107 | 106 | for x in range(3): |
|
108 | 107 | if True: |
|
109 | 108 | while True: |
|
110 | 109 | for x in range(3): |
|
111 | 110 | {val} |
|
112 | 111 | """))) |
|
113 | 112 | |
|
114 | 113 | return test_cases |
|
115 | 114 | |
|
116 | 115 | def _get_ry_syntax_errors(self): |
|
117 | 116 | # This is a mix of tests that should be a syntax error if |
|
118 | 117 | # return or yield whether or not they are in a function |
|
119 | 118 | |
|
120 | 119 | test_cases = [] |
|
121 | 120 | |
|
122 | 121 | test_cases.append(('class', dedent(""" |
|
123 | 122 | class V: |
|
124 | 123 | {val} |
|
125 | 124 | """))) |
|
126 | 125 | |
|
127 | 126 | test_cases.append(('nested-class', dedent(""" |
|
128 | 127 | class V: |
|
129 | 128 | class C: |
|
130 | 129 | {val} |
|
131 | 130 | """))) |
|
132 | 131 | |
|
133 | 132 | return test_cases |
|
134 | 133 | |
|
135 | 134 | |
|
136 | 135 | def test_top_level_return_error(self): |
|
137 | 136 | tl_err_test_cases = self._get_top_level_cases() |
|
138 | 137 | tl_err_test_cases.extend(self._get_ry_syntax_errors()) |
|
139 | 138 | |
|
140 | 139 | vals = ('return', 'yield', 'yield from (_ for _ in range(3))', |
|
141 | 140 | dedent(''' |
|
142 | 141 | def f(): |
|
143 | 142 | pass |
|
144 | 143 | return |
|
145 | 144 | '''), |
|
146 | 145 | ) |
|
147 | 146 | |
|
148 | 147 | for test_name, test_case in tl_err_test_cases: |
|
149 | 148 | # This example should work if 'pass' is used as the value |
|
150 | 149 | with self.subTest((test_name, 'pass')): |
|
151 | 150 | iprc(test_case.format(val='pass')) |
|
152 | 151 | |
|
153 | 152 | # It should fail with all the values |
|
154 | 153 | for val in vals: |
|
155 | 154 | with self.subTest((test_name, val)): |
|
156 | 155 | msg = "Syntax error not raised for %s, %s" % (test_name, val) |
|
157 | 156 | with self.assertRaises(SyntaxError, msg=msg): |
|
158 | 157 | iprc(test_case.format(val=val)) |
|
159 | 158 | |
|
160 | 159 | def test_in_func_no_error(self): |
|
161 | 160 | # Test that the implementation of top-level return/yield |
|
162 | 161 | # detection isn't *too* aggressive, and works inside a function |
|
163 | 162 | func_contexts = [] |
|
164 | 163 | |
|
165 | 164 | func_contexts.append(('func', False, dedent(""" |
|
166 | 165 | def f():"""))) |
|
167 | 166 | |
|
168 | 167 | func_contexts.append(('method', False, dedent(""" |
|
169 | 168 | class MyClass: |
|
170 | 169 | def __init__(self): |
|
171 | 170 | """))) |
|
172 | 171 | |
|
173 | 172 | func_contexts.append(('async-func', True, dedent(""" |
|
174 | 173 | async def f():"""))) |
|
175 | 174 | |
|
176 | 175 | func_contexts.append(('async-method', True, dedent(""" |
|
177 | 176 | class MyClass: |
|
178 | 177 | async def f(self):"""))) |
|
179 | 178 | |
|
180 | 179 | func_contexts.append(('closure', False, dedent(""" |
|
181 | 180 | def f(): |
|
182 | 181 | def g(): |
|
183 | 182 | """))) |
|
184 | 183 | |
|
185 | 184 | def nest_case(context, case): |
|
186 | 185 | # Detect indentation |
|
187 | 186 | lines = context.strip().splitlines() |
|
188 | 187 | prefix_len = 0 |
|
189 | 188 | for c in lines[-1]: |
|
190 | 189 | if c != ' ': |
|
191 | 190 | break |
|
192 | 191 | prefix_len += 1 |
|
193 | 192 | |
|
194 | 193 | indented_case = indent(case, ' ' * (prefix_len + 4)) |
|
195 | 194 | return context + '\n' + indented_case |
|
196 | 195 | |
|
197 | 196 | # Gather and run the tests |
|
198 | 197 | |
|
199 | 198 | # yield is allowed in async functions, starting in Python 3.6, |
|
200 | 199 | # and yield from is not allowed in any version |
|
201 | 200 | vals = ('return', 'yield', 'yield from (_ for _ in range(3))') |
|
202 | 201 | async_safe = (True, |
|
203 | 202 | True, |
|
204 | 203 | False) |
|
205 | 204 | vals = tuple(zip(vals, async_safe)) |
|
206 | 205 | |
|
207 | 206 | success_tests = zip(self._get_top_level_cases(), repeat(False)) |
|
208 | 207 | failure_tests = zip(self._get_ry_syntax_errors(), repeat(True)) |
|
209 | 208 | |
|
210 | 209 | tests = chain(success_tests, failure_tests) |
|
211 | 210 | |
|
212 | 211 | for context_name, async_func, context in func_contexts: |
|
213 | 212 | for (test_name, test_case), should_fail in tests: |
|
214 | 213 | nested_case = nest_case(context, test_case) |
|
215 | 214 | |
|
216 | 215 | for val, async_safe in vals: |
|
217 | 216 | val_should_fail = (should_fail or |
|
218 | 217 | (async_func and not async_safe)) |
|
219 | 218 | |
|
220 | 219 | test_id = (context_name, test_name, val) |
|
221 | 220 | cell = nested_case.format(val=val) |
|
222 | 221 | |
|
223 | 222 | with self.subTest(test_id): |
|
224 | 223 | if val_should_fail: |
|
225 | 224 | msg = ("SyntaxError not raised for %s" % |
|
226 | 225 | str(test_id)) |
|
227 | 226 | with self.assertRaises(SyntaxError, msg=msg): |
|
228 | 227 | iprc(cell) |
|
229 | 228 | |
|
230 | 229 | print(cell) |
|
231 | 230 | else: |
|
232 | 231 | iprc(cell) |
|
233 | 232 | |
|
234 | 233 | def test_nonlocal(self): |
|
235 | 234 | # fails if outer scope is not a function scope or if var not defined |
|
236 | 235 | with self.assertRaises(SyntaxError): |
|
237 | 236 | iprc("nonlocal x") |
|
238 | 237 | iprc(""" |
|
239 | 238 | x = 1 |
|
240 | 239 | def f(): |
|
241 | 240 | nonlocal x |
|
242 | 241 | x = 10000 |
|
243 | 242 | yield x |
|
244 | 243 | """) |
|
245 | 244 | iprc(""" |
|
246 | 245 | def f(): |
|
247 | 246 | def g(): |
|
248 | 247 | nonlocal x |
|
249 | 248 | x = 10000 |
|
250 | 249 | yield x |
|
251 | 250 | """) |
|
252 | 251 | |
|
253 | 252 | # works if outer scope is a function scope and var exists |
|
254 | 253 | iprc(""" |
|
255 | 254 | def f(): |
|
256 | 255 | x = 20 |
|
257 | 256 | def g(): |
|
258 | 257 | nonlocal x |
|
259 | 258 | x = 10000 |
|
260 | 259 | yield x |
|
261 | 260 | """) |
|
262 | 261 | |
|
263 | 262 | |
|
264 | 263 | def test_execute(self): |
|
265 | 264 | iprc(""" |
|
266 | 265 | import asyncio |
|
267 | 266 | await asyncio.sleep(0.001) |
|
268 | 267 | """ |
|
269 | 268 | ) |
|
270 | 269 | |
|
271 | 270 | def test_autoawait(self): |
|
272 | 271 | iprc("%autoawait False") |
|
273 | 272 | iprc("%autoawait True") |
|
274 | 273 | iprc(""" |
|
275 | 274 | from asyncio import sleep |
|
276 | 275 | await sleep(0.1) |
|
277 | 276 | """ |
|
278 | 277 | ) |
|
279 | 278 | |
|
280 | 279 | @skip_without('curio') |
|
281 | 280 | def test_autoawait_curio(self): |
|
282 | 281 | iprc("%autoawait curio") |
|
283 | 282 | |
|
284 | 283 | @skip_without('trio') |
|
285 | 284 | def test_autoawait_trio(self): |
|
286 | 285 | iprc("%autoawait trio") |
|
287 | 286 | |
|
288 | 287 | @skip_without('trio') |
|
289 | 288 | def test_autoawait_trio_wrong_sleep(self): |
|
290 | 289 | iprc("%autoawait trio") |
|
291 | 290 | res = iprc_nr(""" |
|
292 | 291 | import asyncio |
|
293 | 292 | await asyncio.sleep(0) |
|
294 | 293 | """) |
|
295 | 294 | with nt.assert_raises(TypeError): |
|
296 | 295 | res.raise_error() |
|
297 | 296 | |
|
298 | 297 | @skip_without('trio') |
|
299 | 298 | def test_autoawait_asyncio_wrong_sleep(self): |
|
300 | 299 | iprc("%autoawait asyncio") |
|
301 | 300 | res = iprc_nr(""" |
|
302 | 301 | import trio |
|
303 | 302 | await trio.sleep(0) |
|
304 | 303 | """) |
|
305 | 304 | with nt.assert_raises(RuntimeError): |
|
306 | 305 | res.raise_error() |
|
307 | 306 | |
|
308 | 307 | |
|
309 | 308 | def tearDown(self): |
|
310 | 309 | ip.loop_runner = "asyncio" |
@@ -1,421 +1,421 b'' | |||
|
1 | 1 | # Copyright (c) IPython Development Team. |
|
2 | 2 | # Distributed under the terms of the Modified BSD License. |
|
3 | 3 | |
|
4 | 4 | import json |
|
5 | 5 | import os |
|
6 | 6 | import warnings |
|
7 | 7 | |
|
8 | 8 | from unittest import mock |
|
9 | 9 | |
|
10 | 10 | import nose.tools as nt |
|
11 | 11 | |
|
12 | 12 | from IPython.core import display |
|
13 | 13 | from IPython.core.getipython import get_ipython |
|
14 | 14 | from IPython.utils.io import capture_output |
|
15 | 15 | from IPython.utils.tempdir import NamedFileInTemporaryDirectory |
|
16 | 16 | from IPython import paths as ipath |
|
17 |
from IPython.testing.tools import |
|
|
17 | from IPython.testing.tools import AssertNotPrints | |
|
18 | 18 | |
|
19 | 19 | import IPython.testing.decorators as dec |
|
20 | 20 | |
|
21 | 21 | def test_image_size(): |
|
22 | 22 | """Simple test for display.Image(args, width=x,height=y)""" |
|
23 | 23 | thisurl = 'http://www.google.fr/images/srpr/logo3w.png' |
|
24 | 24 | img = display.Image(url=thisurl, width=200, height=200) |
|
25 | 25 | nt.assert_equal(u'<img src="%s" width="200" height="200"/>' % (thisurl), img._repr_html_()) |
|
26 | 26 | img = display.Image(url=thisurl, metadata={'width':200, 'height':200}) |
|
27 | 27 | nt.assert_equal(u'<img src="%s" width="200" height="200"/>' % (thisurl), img._repr_html_()) |
|
28 | 28 | img = display.Image(url=thisurl, width=200) |
|
29 | 29 | nt.assert_equal(u'<img src="%s" width="200"/>' % (thisurl), img._repr_html_()) |
|
30 | 30 | img = display.Image(url=thisurl) |
|
31 | 31 | nt.assert_equal(u'<img src="%s"/>' % (thisurl), img._repr_html_()) |
|
32 | 32 | img = display.Image(url=thisurl, unconfined=True) |
|
33 | 33 | nt.assert_equal(u'<img src="%s" class="unconfined"/>' % (thisurl), img._repr_html_()) |
|
34 | 34 | |
|
35 | 35 | |
|
36 | 36 | def test_image_mimes(): |
|
37 | 37 | fmt = get_ipython().display_formatter.format |
|
38 | 38 | for format in display.Image._ACCEPTABLE_EMBEDDINGS: |
|
39 | 39 | mime = display.Image._MIMETYPES[format] |
|
40 | 40 | img = display.Image(b'garbage', format=format) |
|
41 | 41 | data, metadata = fmt(img) |
|
42 | 42 | nt.assert_equal(sorted(data), sorted([mime, 'text/plain'])) |
|
43 | 43 | |
|
44 | 44 | |
|
45 | 45 | def test_geojson(): |
|
46 | 46 | |
|
47 | 47 | gj = display.GeoJSON(data={ |
|
48 | 48 | "type": "Feature", |
|
49 | 49 | "geometry": { |
|
50 | 50 | "type": "Point", |
|
51 | 51 | "coordinates": [-81.327, 296.038] |
|
52 | 52 | }, |
|
53 | 53 | "properties": { |
|
54 | 54 | "name": "Inca City" |
|
55 | 55 | } |
|
56 | 56 | }, |
|
57 | 57 | url_template="http://s3-eu-west-1.amazonaws.com/whereonmars.cartodb.net/{basemap_id}/{z}/{x}/{y}.png", |
|
58 | 58 | layer_options={ |
|
59 | 59 | "basemap_id": "celestia_mars-shaded-16k_global", |
|
60 | 60 | "attribution": "Celestia/praesepe", |
|
61 | 61 | "minZoom": 0, |
|
62 | 62 | "maxZoom": 18, |
|
63 | 63 | }) |
|
64 | 64 | nt.assert_equal(u'<IPython.core.display.GeoJSON object>', str(gj)) |
|
65 | 65 | |
|
66 | 66 | def test_retina_png(): |
|
67 | 67 | here = os.path.dirname(__file__) |
|
68 | 68 | img = display.Image(os.path.join(here, "2x2.png"), retina=True) |
|
69 | 69 | nt.assert_equal(img.height, 1) |
|
70 | 70 | nt.assert_equal(img.width, 1) |
|
71 | 71 | data, md = img._repr_png_() |
|
72 | 72 | nt.assert_equal(md['width'], 1) |
|
73 | 73 | nt.assert_equal(md['height'], 1) |
|
74 | 74 | |
|
75 | 75 | def test_retina_jpeg(): |
|
76 | 76 | here = os.path.dirname(__file__) |
|
77 | 77 | img = display.Image(os.path.join(here, "2x2.jpg"), retina=True) |
|
78 | 78 | nt.assert_equal(img.height, 1) |
|
79 | 79 | nt.assert_equal(img.width, 1) |
|
80 | 80 | data, md = img._repr_jpeg_() |
|
81 | 81 | nt.assert_equal(md['width'], 1) |
|
82 | 82 | nt.assert_equal(md['height'], 1) |
|
83 | 83 | |
|
84 | 84 | def test_base64image(): |
|
85 | 85 | display.Image("iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEUAAACnej3aAAAAAWJLR0QAiAUdSAAAAAlwSFlzAAALEwAACxMBAJqcGAAAAAd0SU1FB94BCRQnOqNu0b4AAAAKSURBVAjXY2AAAAACAAHiIbwzAAAAAElFTkSuQmCC") |
|
86 | 86 | |
|
87 | 87 | def test_image_filename_defaults(): |
|
88 | 88 | '''test format constraint, and validity of jpeg and png''' |
|
89 | 89 | tpath = ipath.get_ipython_package_dir() |
|
90 | 90 | nt.assert_raises(ValueError, display.Image, filename=os.path.join(tpath, 'testing/tests/badformat.zip'), |
|
91 | 91 | embed=True) |
|
92 | 92 | nt.assert_raises(ValueError, display.Image) |
|
93 | 93 | nt.assert_raises(ValueError, display.Image, data='this is not an image', format='badformat', embed=True) |
|
94 | 94 | # check boths paths to allow packages to test at build and install time |
|
95 | 95 | imgfile = os.path.join(tpath, 'core/tests/2x2.png') |
|
96 | 96 | img = display.Image(filename=imgfile) |
|
97 | 97 | nt.assert_equal('png', img.format) |
|
98 | 98 | nt.assert_is_not_none(img._repr_png_()) |
|
99 | 99 | img = display.Image(filename=os.path.join(tpath, 'testing/tests/logo.jpg'), embed=False) |
|
100 | 100 | nt.assert_equal('jpeg', img.format) |
|
101 | 101 | nt.assert_is_none(img._repr_jpeg_()) |
|
102 | 102 | |
|
103 | 103 | def _get_inline_config(): |
|
104 | 104 | from ipykernel.pylab.config import InlineBackend |
|
105 | 105 | return InlineBackend.instance() |
|
106 | 106 | |
|
107 | 107 | @dec.skip_without('matplotlib') |
|
108 | 108 | def test_set_matplotlib_close(): |
|
109 | 109 | cfg = _get_inline_config() |
|
110 | 110 | cfg.close_figures = False |
|
111 | 111 | display.set_matplotlib_close() |
|
112 | 112 | assert cfg.close_figures |
|
113 | 113 | display.set_matplotlib_close(False) |
|
114 | 114 | assert not cfg.close_figures |
|
115 | 115 | |
|
116 | 116 | _fmt_mime_map = { |
|
117 | 117 | 'png': 'image/png', |
|
118 | 118 | 'jpeg': 'image/jpeg', |
|
119 | 119 | 'pdf': 'application/pdf', |
|
120 | 120 | 'retina': 'image/png', |
|
121 | 121 | 'svg': 'image/svg+xml', |
|
122 | 122 | } |
|
123 | 123 | |
|
124 | 124 | @dec.skip_without('matplotlib') |
|
125 | 125 | def test_set_matplotlib_formats(): |
|
126 | 126 | from matplotlib.figure import Figure |
|
127 | 127 | formatters = get_ipython().display_formatter.formatters |
|
128 | 128 | for formats in [ |
|
129 | 129 | ('png',), |
|
130 | 130 | ('pdf', 'svg'), |
|
131 | 131 | ('jpeg', 'retina', 'png'), |
|
132 | 132 | (), |
|
133 | 133 | ]: |
|
134 | 134 | active_mimes = {_fmt_mime_map[fmt] for fmt in formats} |
|
135 | 135 | display.set_matplotlib_formats(*formats) |
|
136 | 136 | for mime, f in formatters.items(): |
|
137 | 137 | if mime in active_mimes: |
|
138 | 138 | nt.assert_in(Figure, f) |
|
139 | 139 | else: |
|
140 | 140 | nt.assert_not_in(Figure, f) |
|
141 | 141 | |
|
142 | 142 | @dec.skip_without('matplotlib') |
|
143 | 143 | def test_set_matplotlib_formats_kwargs(): |
|
144 | 144 | from matplotlib.figure import Figure |
|
145 | 145 | ip = get_ipython() |
|
146 | 146 | cfg = _get_inline_config() |
|
147 | 147 | cfg.print_figure_kwargs.update(dict(foo='bar')) |
|
148 | 148 | kwargs = dict(quality=10) |
|
149 | 149 | display.set_matplotlib_formats('png', **kwargs) |
|
150 | 150 | formatter = ip.display_formatter.formatters['image/png'] |
|
151 | 151 | f = formatter.lookup_by_type(Figure) |
|
152 | 152 | cell = f.__closure__[0].cell_contents |
|
153 | 153 | expected = kwargs |
|
154 | 154 | expected.update(cfg.print_figure_kwargs) |
|
155 | 155 | nt.assert_equal(cell, expected) |
|
156 | 156 | |
|
157 | 157 | def test_display_available(): |
|
158 | 158 | """ |
|
159 | 159 | Test that display is available without import |
|
160 | 160 | |
|
161 | 161 | We don't really care if it's in builtin or anything else, but it should |
|
162 | 162 | always be available. |
|
163 | 163 | """ |
|
164 | 164 | ip = get_ipython() |
|
165 | 165 | with AssertNotPrints('NameError'): |
|
166 | 166 | ip.run_cell('display') |
|
167 | 167 | try: |
|
168 | 168 | ip.run_cell('del display') |
|
169 | 169 | except NameError: |
|
170 | 170 | pass # it's ok, it might be in builtins |
|
171 | 171 | # even if deleted it should be back |
|
172 | 172 | with AssertNotPrints('NameError'): |
|
173 | 173 | ip.run_cell('display') |
|
174 | 174 | |
|
175 | 175 | def test_textdisplayobj_pretty_repr(): |
|
176 | 176 | p = display.Pretty("This is a simple test") |
|
177 | 177 | nt.assert_equal(repr(p), '<IPython.core.display.Pretty object>') |
|
178 | 178 | nt.assert_equal(p.data, 'This is a simple test') |
|
179 | 179 | |
|
180 | 180 | p._show_mem_addr = True |
|
181 | 181 | nt.assert_equal(repr(p), object.__repr__(p)) |
|
182 | 182 | |
|
183 | 183 | def test_displayobject_repr(): |
|
184 | 184 | h = display.HTML('<br />') |
|
185 | 185 | nt.assert_equal(repr(h), '<IPython.core.display.HTML object>') |
|
186 | 186 | h._show_mem_addr = True |
|
187 | 187 | nt.assert_equal(repr(h), object.__repr__(h)) |
|
188 | 188 | h._show_mem_addr = False |
|
189 | 189 | nt.assert_equal(repr(h), '<IPython.core.display.HTML object>') |
|
190 | 190 | |
|
191 | 191 | j = display.Javascript('') |
|
192 | 192 | nt.assert_equal(repr(j), '<IPython.core.display.Javascript object>') |
|
193 | 193 | j._show_mem_addr = True |
|
194 | 194 | nt.assert_equal(repr(j), object.__repr__(j)) |
|
195 | 195 | j._show_mem_addr = False |
|
196 | 196 | nt.assert_equal(repr(j), '<IPython.core.display.Javascript object>') |
|
197 | 197 | |
|
198 | 198 | @mock.patch('warnings.warn') |
|
199 | 199 | def test_encourage_iframe_over_html(m_warn): |
|
200 | 200 | display.HTML() |
|
201 | 201 | m_warn.assert_not_called() |
|
202 | 202 | |
|
203 | 203 | display.HTML('<br />') |
|
204 | 204 | m_warn.assert_not_called() |
|
205 | 205 | |
|
206 | 206 | display.HTML('<html><p>Lots of content here</p><iframe src="http://a.com"></iframe>') |
|
207 | 207 | m_warn.assert_not_called() |
|
208 | 208 | |
|
209 | 209 | display.HTML('<iframe src="http://a.com"></iframe>') |
|
210 | 210 | m_warn.assert_called_with('Consider using IPython.display.IFrame instead') |
|
211 | 211 | |
|
212 | 212 | m_warn.reset_mock() |
|
213 | 213 | display.HTML('<IFRAME SRC="http://a.com"></IFRAME>') |
|
214 | 214 | m_warn.assert_called_with('Consider using IPython.display.IFrame instead') |
|
215 | 215 | |
|
216 | 216 | def test_progress(): |
|
217 | 217 | p = display.ProgressBar(10) |
|
218 | 218 | nt.assert_in('0/10',repr(p)) |
|
219 | 219 | p.html_width = '100%' |
|
220 | 220 | p.progress = 5 |
|
221 | 221 | nt.assert_equal(p._repr_html_(), "<progress style='width:100%' max='10' value='5'></progress>") |
|
222 | 222 | |
|
223 | 223 | def test_progress_iter(): |
|
224 | 224 | with capture_output(display=False) as captured: |
|
225 | 225 | for i in display.ProgressBar(5): |
|
226 | 226 | out = captured.stdout |
|
227 | 227 | nt.assert_in('{0}/5'.format(i), out) |
|
228 | 228 | out = captured.stdout |
|
229 | 229 | nt.assert_in('5/5', out) |
|
230 | 230 | |
|
231 | 231 | def test_json(): |
|
232 | 232 | d = {'a': 5} |
|
233 | 233 | lis = [d] |
|
234 | 234 | metadata = [ |
|
235 | 235 | {'expanded': False, 'root': 'root'}, |
|
236 | 236 | {'expanded': True, 'root': 'root'}, |
|
237 | 237 | {'expanded': False, 'root': 'custom'}, |
|
238 | 238 | {'expanded': True, 'root': 'custom'}, |
|
239 | 239 | ] |
|
240 | 240 | json_objs = [ |
|
241 | 241 | display.JSON(d), |
|
242 | 242 | display.JSON(d, expanded=True), |
|
243 | 243 | display.JSON(d, root='custom'), |
|
244 | 244 | display.JSON(d, expanded=True, root='custom'), |
|
245 | 245 | ] |
|
246 | 246 | for j, md in zip(json_objs, metadata): |
|
247 | 247 | nt.assert_equal(j._repr_json_(), (d, md)) |
|
248 | 248 | |
|
249 | 249 | with warnings.catch_warnings(record=True) as w: |
|
250 | 250 | warnings.simplefilter("always") |
|
251 | 251 | j = display.JSON(json.dumps(d)) |
|
252 | 252 | nt.assert_equal(len(w), 1) |
|
253 | 253 | nt.assert_equal(j._repr_json_(), (d, metadata[0])) |
|
254 | 254 | |
|
255 | 255 | json_objs = [ |
|
256 | 256 | display.JSON(lis), |
|
257 | 257 | display.JSON(lis, expanded=True), |
|
258 | 258 | display.JSON(lis, root='custom'), |
|
259 | 259 | display.JSON(lis, expanded=True, root='custom'), |
|
260 | 260 | ] |
|
261 | 261 | for j, md in zip(json_objs, metadata): |
|
262 | 262 | nt.assert_equal(j._repr_json_(), (lis, md)) |
|
263 | 263 | |
|
264 | 264 | with warnings.catch_warnings(record=True) as w: |
|
265 | 265 | warnings.simplefilter("always") |
|
266 | 266 | j = display.JSON(json.dumps(lis)) |
|
267 | 267 | nt.assert_equal(len(w), 1) |
|
268 | 268 | nt.assert_equal(j._repr_json_(), (lis, metadata[0])) |
|
269 | 269 | |
|
270 | 270 | def test_video_embedding(): |
|
271 | 271 | """use a tempfile, with dummy-data, to ensure that video embedding doesn't crash""" |
|
272 | 272 | v = display.Video("http://ignored") |
|
273 | 273 | assert not v.embed |
|
274 | 274 | html = v._repr_html_() |
|
275 | 275 | nt.assert_not_in('src="data:', html) |
|
276 | 276 | nt.assert_in('src="http://ignored"', html) |
|
277 | 277 | |
|
278 | 278 | with nt.assert_raises(ValueError): |
|
279 | 279 | v = display.Video(b'abc') |
|
280 | 280 | |
|
281 | 281 | with NamedFileInTemporaryDirectory('test.mp4') as f: |
|
282 | 282 | f.write(b'abc') |
|
283 | 283 | f.close() |
|
284 | 284 | |
|
285 | 285 | v = display.Video(f.name) |
|
286 | 286 | assert not v.embed |
|
287 | 287 | html = v._repr_html_() |
|
288 | 288 | nt.assert_not_in('src="data:', html) |
|
289 | 289 | |
|
290 | 290 | v = display.Video(f.name, embed=True) |
|
291 | 291 | html = v._repr_html_() |
|
292 | 292 | nt.assert_in('src="data:video/mp4;base64,YWJj"',html) |
|
293 | 293 | |
|
294 | 294 | v = display.Video(f.name, embed=True, mimetype='video/other') |
|
295 | 295 | html = v._repr_html_() |
|
296 | 296 | nt.assert_in('src="data:video/other;base64,YWJj"',html) |
|
297 | 297 | |
|
298 | 298 | v = display.Video(b'abc', embed=True, mimetype='video/mp4') |
|
299 | 299 | html = v._repr_html_() |
|
300 | 300 | nt.assert_in('src="data:video/mp4;base64,YWJj"',html) |
|
301 | 301 | |
|
302 | 302 | v = display.Video(u'YWJj', embed=True, mimetype='video/xyz') |
|
303 | 303 | html = v._repr_html_() |
|
304 | 304 | nt.assert_in('src="data:video/xyz;base64,YWJj"',html) |
|
305 | 305 | |
|
306 | 306 | def test_html_metadata(): |
|
307 | 307 | s = "<h1>Test</h1>" |
|
308 | 308 | h = display.HTML(s, metadata={"isolated": True}) |
|
309 | 309 | nt.assert_equal(h._repr_html_(), (s, {"isolated": True})) |
|
310 | 310 | |
|
311 | 311 | def test_display_id(): |
|
312 | 312 | ip = get_ipython() |
|
313 | 313 | with mock.patch.object(ip.display_pub, 'publish') as pub: |
|
314 | 314 | handle = display.display('x') |
|
315 | 315 | nt.assert_is(handle, None) |
|
316 | 316 | handle = display.display('y', display_id='secret') |
|
317 | 317 | nt.assert_is_instance(handle, display.DisplayHandle) |
|
318 | 318 | handle2 = display.display('z', display_id=True) |
|
319 | 319 | nt.assert_is_instance(handle2, display.DisplayHandle) |
|
320 | 320 | nt.assert_not_equal(handle.display_id, handle2.display_id) |
|
321 | 321 | |
|
322 | 322 | nt.assert_equal(pub.call_count, 3) |
|
323 | 323 | args, kwargs = pub.call_args_list[0] |
|
324 | 324 | nt.assert_equal(args, ()) |
|
325 | 325 | nt.assert_equal(kwargs, { |
|
326 | 326 | 'data': { |
|
327 | 327 | 'text/plain': repr('x') |
|
328 | 328 | }, |
|
329 | 329 | 'metadata': {}, |
|
330 | 330 | }) |
|
331 | 331 | args, kwargs = pub.call_args_list[1] |
|
332 | 332 | nt.assert_equal(args, ()) |
|
333 | 333 | nt.assert_equal(kwargs, { |
|
334 | 334 | 'data': { |
|
335 | 335 | 'text/plain': repr('y') |
|
336 | 336 | }, |
|
337 | 337 | 'metadata': {}, |
|
338 | 338 | 'transient': { |
|
339 | 339 | 'display_id': handle.display_id, |
|
340 | 340 | }, |
|
341 | 341 | }) |
|
342 | 342 | args, kwargs = pub.call_args_list[2] |
|
343 | 343 | nt.assert_equal(args, ()) |
|
344 | 344 | nt.assert_equal(kwargs, { |
|
345 | 345 | 'data': { |
|
346 | 346 | 'text/plain': repr('z') |
|
347 | 347 | }, |
|
348 | 348 | 'metadata': {}, |
|
349 | 349 | 'transient': { |
|
350 | 350 | 'display_id': handle2.display_id, |
|
351 | 351 | }, |
|
352 | 352 | }) |
|
353 | 353 | |
|
354 | 354 | |
|
355 | 355 | def test_update_display(): |
|
356 | 356 | ip = get_ipython() |
|
357 | 357 | with mock.patch.object(ip.display_pub, 'publish') as pub: |
|
358 | 358 | with nt.assert_raises(TypeError): |
|
359 | 359 | display.update_display('x') |
|
360 | 360 | display.update_display('x', display_id='1') |
|
361 | 361 | display.update_display('y', display_id='2') |
|
362 | 362 | args, kwargs = pub.call_args_list[0] |
|
363 | 363 | nt.assert_equal(args, ()) |
|
364 | 364 | nt.assert_equal(kwargs, { |
|
365 | 365 | 'data': { |
|
366 | 366 | 'text/plain': repr('x') |
|
367 | 367 | }, |
|
368 | 368 | 'metadata': {}, |
|
369 | 369 | 'transient': { |
|
370 | 370 | 'display_id': '1', |
|
371 | 371 | }, |
|
372 | 372 | 'update': True, |
|
373 | 373 | }) |
|
374 | 374 | args, kwargs = pub.call_args_list[1] |
|
375 | 375 | nt.assert_equal(args, ()) |
|
376 | 376 | nt.assert_equal(kwargs, { |
|
377 | 377 | 'data': { |
|
378 | 378 | 'text/plain': repr('y') |
|
379 | 379 | }, |
|
380 | 380 | 'metadata': {}, |
|
381 | 381 | 'transient': { |
|
382 | 382 | 'display_id': '2', |
|
383 | 383 | }, |
|
384 | 384 | 'update': True, |
|
385 | 385 | }) |
|
386 | 386 | |
|
387 | 387 | |
|
388 | 388 | def test_display_handle(): |
|
389 | 389 | ip = get_ipython() |
|
390 | 390 | handle = display.DisplayHandle() |
|
391 | 391 | nt.assert_is_instance(handle.display_id, str) |
|
392 | 392 | handle = display.DisplayHandle('my-id') |
|
393 | 393 | nt.assert_equal(handle.display_id, 'my-id') |
|
394 | 394 | with mock.patch.object(ip.display_pub, 'publish') as pub: |
|
395 | 395 | handle.display('x') |
|
396 | 396 | handle.update('y') |
|
397 | 397 | |
|
398 | 398 | args, kwargs = pub.call_args_list[0] |
|
399 | 399 | nt.assert_equal(args, ()) |
|
400 | 400 | nt.assert_equal(kwargs, { |
|
401 | 401 | 'data': { |
|
402 | 402 | 'text/plain': repr('x') |
|
403 | 403 | }, |
|
404 | 404 | 'metadata': {}, |
|
405 | 405 | 'transient': { |
|
406 | 406 | 'display_id': handle.display_id, |
|
407 | 407 | } |
|
408 | 408 | }) |
|
409 | 409 | args, kwargs = pub.call_args_list[1] |
|
410 | 410 | nt.assert_equal(args, ()) |
|
411 | 411 | nt.assert_equal(kwargs, { |
|
412 | 412 | 'data': { |
|
413 | 413 | 'text/plain': repr('y') |
|
414 | 414 | }, |
|
415 | 415 | 'metadata': {}, |
|
416 | 416 | 'transient': { |
|
417 | 417 | 'display_id': handle.display_id, |
|
418 | 418 | }, |
|
419 | 419 | 'update': True, |
|
420 | 420 | }) |
|
421 | 421 |
@@ -1,93 +1,92 b'' | |||
|
1 | from backcall import callback_prototype | |
|
2 | 1 |
|
|
3 | 2 | from unittest.mock import Mock |
|
4 | 3 | import nose.tools as nt |
|
5 | 4 | |
|
6 | 5 | from IPython.core import events |
|
7 | 6 | import IPython.testing.tools as tt |
|
8 | 7 | |
|
9 | 8 | |
|
10 | 9 | @events._define_event |
|
11 | 10 | def ping_received(): |
|
12 | 11 | pass |
|
13 | 12 | |
|
14 | 13 | |
|
15 | 14 | @events._define_event |
|
16 | 15 | def event_with_argument(argument): |
|
17 | 16 | pass |
|
18 | 17 | |
|
19 | 18 | |
|
20 | 19 | class CallbackTests(unittest.TestCase): |
|
21 | 20 | def setUp(self): |
|
22 | 21 | self.em = events.EventManager(get_ipython(), |
|
23 | 22 | {'ping_received': ping_received, |
|
24 | 23 | 'event_with_argument': event_with_argument}) |
|
25 | 24 | |
|
26 | 25 | def test_register_unregister(self): |
|
27 | 26 | cb = Mock() |
|
28 | 27 | |
|
29 | 28 | self.em.register('ping_received', cb) |
|
30 | 29 | self.em.trigger('ping_received') |
|
31 | 30 | self.assertEqual(cb.call_count, 1) |
|
32 | 31 | |
|
33 | 32 | self.em.unregister('ping_received', cb) |
|
34 | 33 | self.em.trigger('ping_received') |
|
35 | 34 | self.assertEqual(cb.call_count, 1) |
|
36 | 35 | |
|
37 | 36 | def test_bare_function_missed_unregister(self): |
|
38 | 37 | def cb1(): |
|
39 | 38 | ... |
|
40 | 39 | |
|
41 | 40 | def cb2(): |
|
42 | 41 | ... |
|
43 | 42 | |
|
44 | 43 | self.em.register('ping_received', cb1) |
|
45 | 44 | nt.assert_raises(ValueError, self.em.unregister, 'ping_received', cb2) |
|
46 | 45 | self.em.unregister('ping_received', cb1) |
|
47 | 46 | |
|
48 | 47 | def test_cb_error(self): |
|
49 | 48 | cb = Mock(side_effect=ValueError) |
|
50 | 49 | self.em.register('ping_received', cb) |
|
51 | 50 | with tt.AssertPrints("Error in callback"): |
|
52 | 51 | self.em.trigger('ping_received') |
|
53 | 52 | |
|
54 | 53 | def test_cb_keyboard_interrupt(self): |
|
55 | 54 | cb = Mock(side_effect=KeyboardInterrupt) |
|
56 | 55 | self.em.register('ping_received', cb) |
|
57 | 56 | with tt.AssertPrints("Error in callback"): |
|
58 | 57 | self.em.trigger('ping_received') |
|
59 | 58 | |
|
60 | 59 | def test_unregister_during_callback(self): |
|
61 | 60 | invoked = [False] * 3 |
|
62 | 61 | |
|
63 | 62 | def func1(*_): |
|
64 | 63 | invoked[0] = True |
|
65 | 64 | self.em.unregister('ping_received', func1) |
|
66 | 65 | self.em.register('ping_received', func3) |
|
67 | 66 | |
|
68 | 67 | def func2(*_): |
|
69 | 68 | invoked[1] = True |
|
70 | 69 | self.em.unregister('ping_received', func2) |
|
71 | 70 | |
|
72 | 71 | def func3(*_): |
|
73 | 72 | invoked[2] = True |
|
74 | 73 | |
|
75 | 74 | self.em.register('ping_received', func1) |
|
76 | 75 | self.em.register('ping_received', func2) |
|
77 | 76 | |
|
78 | 77 | self.em.trigger('ping_received') |
|
79 | 78 | self.assertEqual([True, True, False], invoked) |
|
80 | 79 | self.assertEqual([func3], self.em.callbacks['ping_received']) |
|
81 | 80 | |
|
82 | 81 | def test_ignore_event_arguments_if_no_argument_required(self): |
|
83 | 82 | call_count = [0] |
|
84 | 83 | def event_with_no_argument(): |
|
85 | 84 | call_count[0] += 1 |
|
86 | 85 | |
|
87 | 86 | self.em.register('event_with_argument', event_with_no_argument) |
|
88 | 87 | self.em.trigger('event_with_argument', 'the argument') |
|
89 | 88 | self.assertEqual(call_count[0], 1) |
|
90 | 89 | |
|
91 | 90 | self.em.unregister('event_with_argument', event_with_no_argument) |
|
92 | 91 | self.em.trigger('ping_received') |
|
93 | 92 | self.assertEqual(call_count[0], 1) |
@@ -1,95 +1,94 b'' | |||
|
1 | 1 | """Tests for input handlers. |
|
2 | 2 | """ |
|
3 | 3 | #----------------------------------------------------------------------------- |
|
4 | 4 | # Module imports |
|
5 | 5 | #----------------------------------------------------------------------------- |
|
6 | 6 | |
|
7 | 7 | # third party |
|
8 | 8 | import nose.tools as nt |
|
9 | 9 | |
|
10 | 10 | # our own packages |
|
11 | 11 | from IPython.core import autocall |
|
12 | 12 | from IPython.testing import tools as tt |
|
13 | from IPython.utils import py3compat | |
|
14 | 13 | |
|
15 | 14 | #----------------------------------------------------------------------------- |
|
16 | 15 | # Globals |
|
17 | 16 | #----------------------------------------------------------------------------- |
|
18 | 17 | |
|
19 | 18 | # Get the public instance of IPython |
|
20 | 19 | |
|
21 | 20 | failures = [] |
|
22 | 21 | num_tests = 0 |
|
23 | 22 | |
|
24 | 23 | #----------------------------------------------------------------------------- |
|
25 | 24 | # Test functions |
|
26 | 25 | #----------------------------------------------------------------------------- |
|
27 | 26 | |
|
28 | 27 | class CallableIndexable(object): |
|
29 | 28 | def __getitem__(self, idx): return True |
|
30 | 29 | def __call__(self, *args, **kws): return True |
|
31 | 30 | |
|
32 | 31 | |
|
33 | 32 | class Autocallable(autocall.IPyAutocall): |
|
34 | 33 | def __call__(self): |
|
35 | 34 | return "called" |
|
36 | 35 | |
|
37 | 36 | |
|
38 | 37 | def run(tests): |
|
39 | 38 | """Loop through a list of (pre, post) inputs, where pre is the string |
|
40 | 39 | handed to ipython, and post is how that string looks after it's been |
|
41 | 40 | transformed (i.e. ipython's notion of _i)""" |
|
42 | 41 | tt.check_pairs(ip.prefilter_manager.prefilter_lines, tests) |
|
43 | 42 | |
|
44 | 43 | |
|
45 | 44 | def test_handlers(): |
|
46 | 45 | call_idx = CallableIndexable() |
|
47 | 46 | ip.user_ns['call_idx'] = call_idx |
|
48 | 47 | |
|
49 | 48 | # For many of the below, we're also checking that leading whitespace |
|
50 | 49 | # turns off the esc char, which it should unless there is a continuation |
|
51 | 50 | # line. |
|
52 | 51 | run( |
|
53 | 52 | [('"no change"', '"no change"'), # normal |
|
54 | 53 | (u"lsmagic", "get_ipython().run_line_magic('lsmagic', '')"), # magic |
|
55 | 54 | #("a = b # PYTHON-MODE", '_i'), # emacs -- avoids _in cache |
|
56 | 55 | ]) |
|
57 | 56 | |
|
58 | 57 | # Objects which are instances of IPyAutocall are *always* autocalled |
|
59 | 58 | autocallable = Autocallable() |
|
60 | 59 | ip.user_ns['autocallable'] = autocallable |
|
61 | 60 | |
|
62 | 61 | # auto |
|
63 | 62 | ip.magic('autocall 0') |
|
64 | 63 | # Only explicit escapes or instances of IPyAutocallable should get |
|
65 | 64 | # expanded |
|
66 | 65 | run([ |
|
67 | 66 | ('len "abc"', 'len "abc"'), |
|
68 | 67 | ('autocallable', 'autocallable()'), |
|
69 | 68 | # Don't add extra brackets (gh-1117) |
|
70 | 69 | ('autocallable()', 'autocallable()'), |
|
71 | 70 | ]) |
|
72 | 71 | ip.magic('autocall 1') |
|
73 | 72 | run([ |
|
74 | 73 | ('len "abc"', 'len("abc")'), |
|
75 | 74 | ('len "abc";', 'len("abc");'), # ; is special -- moves out of parens |
|
76 | 75 | # Autocall is turned off if first arg is [] and the object |
|
77 | 76 | # is both callable and indexable. Like so: |
|
78 | 77 | ('len [1,2]', 'len([1,2])'), # len doesn't support __getitem__... |
|
79 | 78 | ('call_idx [1]', 'call_idx [1]'), # call_idx *does*.. |
|
80 | 79 | ('call_idx 1', 'call_idx(1)'), |
|
81 | 80 | ('len', 'len'), # only at 2 does it auto-call on single args |
|
82 | 81 | ]) |
|
83 | 82 | ip.magic('autocall 2') |
|
84 | 83 | run([ |
|
85 | 84 | ('len "abc"', 'len("abc")'), |
|
86 | 85 | ('len "abc";', 'len("abc");'), |
|
87 | 86 | ('len [1,2]', 'len([1,2])'), |
|
88 | 87 | ('call_idx [1]', 'call_idx [1]'), |
|
89 | 88 | ('call_idx 1', 'call_idx(1)'), |
|
90 | 89 | # This is what's different: |
|
91 | 90 | ('len', 'len()'), # only at 2 does it auto-call on single args |
|
92 | 91 | ]) |
|
93 | 92 | ip.magic('autocall 1') |
|
94 | 93 | |
|
95 | 94 | nt.assert_equal(failures, []) |
@@ -1,450 +1,447 b'' | |||
|
1 | 1 | """Tests for autoreload extension. |
|
2 | 2 | """ |
|
3 | 3 | #----------------------------------------------------------------------------- |
|
4 | 4 | # Copyright (c) 2012 IPython Development Team. |
|
5 | 5 | # |
|
6 | 6 | # Distributed under the terms of the Modified BSD License. |
|
7 | 7 | # |
|
8 | 8 | # The full license is in the file COPYING.txt, distributed with this software. |
|
9 | 9 | #----------------------------------------------------------------------------- |
|
10 | 10 | |
|
11 | 11 | #----------------------------------------------------------------------------- |
|
12 | 12 | # Imports |
|
13 | 13 | #----------------------------------------------------------------------------- |
|
14 | 14 | |
|
15 | 15 | import os |
|
16 | 16 | import sys |
|
17 | 17 | import tempfile |
|
18 | 18 | import textwrap |
|
19 | 19 | import shutil |
|
20 | 20 | import random |
|
21 | 21 | import time |
|
22 | 22 | from io import StringIO |
|
23 | 23 | |
|
24 | 24 | import nose.tools as nt |
|
25 | 25 | import IPython.testing.tools as tt |
|
26 | 26 | |
|
27 | 27 | from unittest import TestCase |
|
28 | 28 | |
|
29 | from IPython.testing.decorators import skipif | |
|
30 | ||
|
31 | 29 | from IPython.extensions.autoreload import AutoreloadMagics |
|
32 | 30 | from IPython.core.events import EventManager, pre_run_cell |
|
33 | 31 | |
|
34 | 32 | #----------------------------------------------------------------------------- |
|
35 | 33 | # Test fixture |
|
36 | 34 | #----------------------------------------------------------------------------- |
|
37 | 35 | |
|
38 | 36 | noop = lambda *a, **kw: None |
|
39 | 37 | |
|
40 | 38 | class FakeShell: |
|
41 | 39 | |
|
42 | 40 | def __init__(self): |
|
43 | 41 | self.ns = {} |
|
44 | 42 | self.user_ns = self.ns |
|
45 | 43 | self.user_ns_hidden = {} |
|
46 | 44 | self.events = EventManager(self, {'pre_run_cell', pre_run_cell}) |
|
47 | 45 | self.auto_magics = AutoreloadMagics(shell=self) |
|
48 | 46 | self.events.register('pre_run_cell', self.auto_magics.pre_run_cell) |
|
49 | 47 | |
|
50 | 48 | register_magics = set_hook = noop |
|
51 | 49 | |
|
52 | 50 | def run_code(self, code): |
|
53 | 51 | self.events.trigger('pre_run_cell') |
|
54 | 52 | exec(code, self.user_ns) |
|
55 | 53 | self.auto_magics.post_execute_hook() |
|
56 | 54 | |
|
57 | 55 | def push(self, items): |
|
58 | 56 | self.ns.update(items) |
|
59 | 57 | |
|
60 | 58 | def magic_autoreload(self, parameter): |
|
61 | 59 | self.auto_magics.autoreload(parameter) |
|
62 | 60 | |
|
63 | 61 | def magic_aimport(self, parameter, stream=None): |
|
64 | 62 | self.auto_magics.aimport(parameter, stream=stream) |
|
65 | 63 | self.auto_magics.post_execute_hook() |
|
66 | 64 | |
|
67 | 65 | |
|
68 | 66 | class Fixture(TestCase): |
|
69 | 67 | """Fixture for creating test module files""" |
|
70 | 68 | |
|
71 | 69 | test_dir = None |
|
72 | 70 | old_sys_path = None |
|
73 | 71 | filename_chars = "abcdefghijklmopqrstuvwxyz0123456789" |
|
74 | 72 | |
|
75 | 73 | def setUp(self): |
|
76 | 74 | self.test_dir = tempfile.mkdtemp() |
|
77 | 75 | self.old_sys_path = list(sys.path) |
|
78 | 76 | sys.path.insert(0, self.test_dir) |
|
79 | 77 | self.shell = FakeShell() |
|
80 | 78 | |
|
81 | 79 | def tearDown(self): |
|
82 | 80 | shutil.rmtree(self.test_dir) |
|
83 | 81 | sys.path = self.old_sys_path |
|
84 | 82 | |
|
85 | 83 | self.test_dir = None |
|
86 | 84 | self.old_sys_path = None |
|
87 | 85 | self.shell = None |
|
88 | 86 | |
|
89 | 87 | def get_module(self): |
|
90 | 88 | module_name = "tmpmod_" + "".join(random.sample(self.filename_chars,20)) |
|
91 | 89 | if module_name in sys.modules: |
|
92 | 90 | del sys.modules[module_name] |
|
93 | 91 | file_name = os.path.join(self.test_dir, module_name + ".py") |
|
94 | 92 | return module_name, file_name |
|
95 | 93 | |
|
96 | 94 | def write_file(self, filename, content): |
|
97 | 95 | """ |
|
98 | 96 | Write a file, and force a timestamp difference of at least one second |
|
99 | 97 | |
|
100 | 98 | Notes |
|
101 | 99 | ----- |
|
102 | 100 | Python's .pyc files record the timestamp of their compilation |
|
103 | 101 | with a time resolution of one second. |
|
104 | 102 | |
|
105 | 103 | Therefore, we need to force a timestamp difference between .py |
|
106 | 104 | and .pyc, without having the .py file be timestamped in the |
|
107 | 105 | future, and without changing the timestamp of the .pyc file |
|
108 | 106 | (because that is stored in the file). The only reliable way |
|
109 | 107 | to achieve this seems to be to sleep. |
|
110 | 108 | """ |
|
111 | 109 | content = textwrap.dedent(content) |
|
112 | 110 | # Sleep one second + eps |
|
113 | 111 | time.sleep(1.05) |
|
114 | 112 | |
|
115 | 113 | # Write |
|
116 | 114 | with open(filename, 'w') as f: |
|
117 | 115 | f.write(content) |
|
118 | 116 | |
|
119 | 117 | def new_module(self, code): |
|
120 | 118 | code = textwrap.dedent(code) |
|
121 | 119 | mod_name, mod_fn = self.get_module() |
|
122 | 120 | with open(mod_fn, 'w') as f: |
|
123 | 121 | f.write(code) |
|
124 | 122 | return mod_name, mod_fn |
|
125 | 123 | |
|
126 | 124 | #----------------------------------------------------------------------------- |
|
127 | 125 | # Test automatic reloading |
|
128 | 126 | #----------------------------------------------------------------------------- |
|
129 | 127 | |
|
130 | 128 | def pickle_get_current_class(obj): |
|
131 | 129 | """ |
|
132 | 130 | Original issue comes from pickle; hence the name. |
|
133 | 131 | """ |
|
134 | 132 | name = obj.__class__.__name__ |
|
135 | 133 | module_name = getattr(obj, "__module__", None) |
|
136 | 134 | obj2 = sys.modules[module_name] |
|
137 | 135 | for subpath in name.split("."): |
|
138 | 136 | obj2 = getattr(obj2, subpath) |
|
139 | 137 | return obj2 |
|
140 | 138 | |
|
141 | 139 | class TestAutoreload(Fixture): |
|
142 | 140 | |
|
143 | 141 | def test_reload_enums(self): |
|
144 | import enum | |
|
145 | 142 | mod_name, mod_fn = self.new_module(textwrap.dedent(""" |
|
146 | 143 | from enum import Enum |
|
147 | 144 | class MyEnum(Enum): |
|
148 | 145 | A = 'A' |
|
149 | 146 | B = 'B' |
|
150 | 147 | """)) |
|
151 | 148 | self.shell.magic_autoreload("2") |
|
152 | 149 | self.shell.magic_aimport(mod_name) |
|
153 | 150 | self.write_file(mod_fn, textwrap.dedent(""" |
|
154 | 151 | from enum import Enum |
|
155 | 152 | class MyEnum(Enum): |
|
156 | 153 | A = 'A' |
|
157 | 154 | B = 'B' |
|
158 | 155 | C = 'C' |
|
159 | 156 | """)) |
|
160 | 157 | with tt.AssertNotPrints(('[autoreload of %s failed:' % mod_name), channel='stderr'): |
|
161 | 158 | self.shell.run_code("pass") # trigger another reload |
|
162 | 159 | |
|
163 | 160 | def test_reload_class_type(self): |
|
164 | 161 | self.shell.magic_autoreload("2") |
|
165 | 162 | mod_name, mod_fn = self.new_module( |
|
166 | 163 | """ |
|
167 | 164 | class Test(): |
|
168 | 165 | def meth(self): |
|
169 | 166 | return "old" |
|
170 | 167 | """ |
|
171 | 168 | ) |
|
172 | 169 | assert "test" not in self.shell.ns |
|
173 | 170 | assert "result" not in self.shell.ns |
|
174 | 171 | |
|
175 | 172 | self.shell.run_code("from %s import Test" % mod_name) |
|
176 | 173 | self.shell.run_code("test = Test()") |
|
177 | 174 | |
|
178 | 175 | self.write_file( |
|
179 | 176 | mod_fn, |
|
180 | 177 | """ |
|
181 | 178 | class Test(): |
|
182 | 179 | def meth(self): |
|
183 | 180 | return "new" |
|
184 | 181 | """, |
|
185 | 182 | ) |
|
186 | 183 | |
|
187 | 184 | test_object = self.shell.ns["test"] |
|
188 | 185 | |
|
189 | 186 | # important to trigger autoreload logic ! |
|
190 | 187 | self.shell.run_code("pass") |
|
191 | 188 | |
|
192 | 189 | test_class = pickle_get_current_class(test_object) |
|
193 | 190 | assert isinstance(test_object, test_class) |
|
194 | 191 | |
|
195 | 192 | # extra check. |
|
196 | 193 | self.shell.run_code("import pickle") |
|
197 | 194 | self.shell.run_code("p = pickle.dumps(test)") |
|
198 | 195 | |
|
199 | 196 | def test_reload_class_attributes(self): |
|
200 | 197 | self.shell.magic_autoreload("2") |
|
201 | 198 | mod_name, mod_fn = self.new_module(textwrap.dedent(""" |
|
202 | 199 | class MyClass: |
|
203 | 200 | |
|
204 | 201 | def __init__(self, a=10): |
|
205 | 202 | self.a = a |
|
206 | 203 | self.b = 22 |
|
207 | 204 | # self.toto = 33 |
|
208 | 205 | |
|
209 | 206 | def square(self): |
|
210 | 207 | print('compute square') |
|
211 | 208 | return self.a*self.a |
|
212 | 209 | """ |
|
213 | 210 | ) |
|
214 | 211 | ) |
|
215 | 212 | self.shell.run_code("from %s import MyClass" % mod_name) |
|
216 | 213 | self.shell.run_code("first = MyClass(5)") |
|
217 | 214 | self.shell.run_code("first.square()") |
|
218 | 215 | with nt.assert_raises(AttributeError): |
|
219 | 216 | self.shell.run_code("first.cube()") |
|
220 | 217 | with nt.assert_raises(AttributeError): |
|
221 | 218 | self.shell.run_code("first.power(5)") |
|
222 | 219 | self.shell.run_code("first.b") |
|
223 | 220 | with nt.assert_raises(AttributeError): |
|
224 | 221 | self.shell.run_code("first.toto") |
|
225 | 222 | |
|
226 | 223 | # remove square, add power |
|
227 | 224 | |
|
228 | 225 | self.write_file( |
|
229 | 226 | mod_fn, |
|
230 | 227 | textwrap.dedent( |
|
231 | 228 | """ |
|
232 | 229 | class MyClass: |
|
233 | 230 | |
|
234 | 231 | def __init__(self, a=10): |
|
235 | 232 | self.a = a |
|
236 | 233 | self.b = 11 |
|
237 | 234 | |
|
238 | 235 | def power(self, p): |
|
239 | 236 | print('compute power '+str(p)) |
|
240 | 237 | return self.a**p |
|
241 | 238 | """ |
|
242 | 239 | ), |
|
243 | 240 | ) |
|
244 | 241 | |
|
245 | 242 | self.shell.run_code("second = MyClass(5)") |
|
246 | 243 | |
|
247 | 244 | for object_name in {'first', 'second'}: |
|
248 | 245 | self.shell.run_code("{object_name}.power(5)".format(object_name=object_name)) |
|
249 | 246 | with nt.assert_raises(AttributeError): |
|
250 | 247 | self.shell.run_code("{object_name}.cube()".format(object_name=object_name)) |
|
251 | 248 | with nt.assert_raises(AttributeError): |
|
252 | 249 | self.shell.run_code("{object_name}.square()".format(object_name=object_name)) |
|
253 | 250 | self.shell.run_code("{object_name}.b".format(object_name=object_name)) |
|
254 | 251 | self.shell.run_code("{object_name}.a".format(object_name=object_name)) |
|
255 | 252 | with nt.assert_raises(AttributeError): |
|
256 | 253 | self.shell.run_code("{object_name}.toto".format(object_name=object_name)) |
|
257 | 254 | |
|
258 | 255 | def _check_smoketest(self, use_aimport=True): |
|
259 | 256 | """ |
|
260 | 257 | Functional test for the automatic reloader using either |
|
261 | 258 | '%autoreload 1' or '%autoreload 2' |
|
262 | 259 | """ |
|
263 | 260 | |
|
264 | 261 | mod_name, mod_fn = self.new_module(""" |
|
265 | 262 | x = 9 |
|
266 | 263 | |
|
267 | 264 | z = 123 # this item will be deleted |
|
268 | 265 | |
|
269 | 266 | def foo(y): |
|
270 | 267 | return y + 3 |
|
271 | 268 | |
|
272 | 269 | class Baz(object): |
|
273 | 270 | def __init__(self, x): |
|
274 | 271 | self.x = x |
|
275 | 272 | def bar(self, y): |
|
276 | 273 | return self.x + y |
|
277 | 274 | @property |
|
278 | 275 | def quux(self): |
|
279 | 276 | return 42 |
|
280 | 277 | def zzz(self): |
|
281 | 278 | '''This method will be deleted below''' |
|
282 | 279 | return 99 |
|
283 | 280 | |
|
284 | 281 | class Bar: # old-style class: weakref doesn't work for it on Python < 2.7 |
|
285 | 282 | def foo(self): |
|
286 | 283 | return 1 |
|
287 | 284 | """) |
|
288 | 285 | |
|
289 | 286 | # |
|
290 | 287 | # Import module, and mark for reloading |
|
291 | 288 | # |
|
292 | 289 | if use_aimport: |
|
293 | 290 | self.shell.magic_autoreload("1") |
|
294 | 291 | self.shell.magic_aimport(mod_name) |
|
295 | 292 | stream = StringIO() |
|
296 | 293 | self.shell.magic_aimport("", stream=stream) |
|
297 | 294 | nt.assert_in(("Modules to reload:\n%s" % mod_name), stream.getvalue()) |
|
298 | 295 | |
|
299 | 296 | with nt.assert_raises(ImportError): |
|
300 | 297 | self.shell.magic_aimport("tmpmod_as318989e89ds") |
|
301 | 298 | else: |
|
302 | 299 | self.shell.magic_autoreload("2") |
|
303 | 300 | self.shell.run_code("import %s" % mod_name) |
|
304 | 301 | stream = StringIO() |
|
305 | 302 | self.shell.magic_aimport("", stream=stream) |
|
306 | 303 | nt.assert_true("Modules to reload:\nall-except-skipped" in |
|
307 | 304 | stream.getvalue()) |
|
308 | 305 | nt.assert_in(mod_name, self.shell.ns) |
|
309 | 306 | |
|
310 | 307 | mod = sys.modules[mod_name] |
|
311 | 308 | |
|
312 | 309 | # |
|
313 | 310 | # Test module contents |
|
314 | 311 | # |
|
315 | 312 | old_foo = mod.foo |
|
316 | 313 | old_obj = mod.Baz(9) |
|
317 | 314 | old_obj2 = mod.Bar() |
|
318 | 315 | |
|
319 | 316 | def check_module_contents(): |
|
320 | 317 | nt.assert_equal(mod.x, 9) |
|
321 | 318 | nt.assert_equal(mod.z, 123) |
|
322 | 319 | |
|
323 | 320 | nt.assert_equal(old_foo(0), 3) |
|
324 | 321 | nt.assert_equal(mod.foo(0), 3) |
|
325 | 322 | |
|
326 | 323 | obj = mod.Baz(9) |
|
327 | 324 | nt.assert_equal(old_obj.bar(1), 10) |
|
328 | 325 | nt.assert_equal(obj.bar(1), 10) |
|
329 | 326 | nt.assert_equal(obj.quux, 42) |
|
330 | 327 | nt.assert_equal(obj.zzz(), 99) |
|
331 | 328 | |
|
332 | 329 | obj2 = mod.Bar() |
|
333 | 330 | nt.assert_equal(old_obj2.foo(), 1) |
|
334 | 331 | nt.assert_equal(obj2.foo(), 1) |
|
335 | 332 | |
|
336 | 333 | check_module_contents() |
|
337 | 334 | |
|
338 | 335 | # |
|
339 | 336 | # Simulate a failed reload: no reload should occur and exactly |
|
340 | 337 | # one error message should be printed |
|
341 | 338 | # |
|
342 | 339 | self.write_file(mod_fn, """ |
|
343 | 340 | a syntax error |
|
344 | 341 | """) |
|
345 | 342 | |
|
346 | 343 | with tt.AssertPrints(('[autoreload of %s failed:' % mod_name), channel='stderr'): |
|
347 | 344 | self.shell.run_code("pass") # trigger reload |
|
348 | 345 | with tt.AssertNotPrints(('[autoreload of %s failed:' % mod_name), channel='stderr'): |
|
349 | 346 | self.shell.run_code("pass") # trigger another reload |
|
350 | 347 | check_module_contents() |
|
351 | 348 | |
|
352 | 349 | # |
|
353 | 350 | # Rewrite module (this time reload should succeed) |
|
354 | 351 | # |
|
355 | 352 | self.write_file(mod_fn, """ |
|
356 | 353 | x = 10 |
|
357 | 354 | |
|
358 | 355 | def foo(y): |
|
359 | 356 | return y + 4 |
|
360 | 357 | |
|
361 | 358 | class Baz(object): |
|
362 | 359 | def __init__(self, x): |
|
363 | 360 | self.x = x |
|
364 | 361 | def bar(self, y): |
|
365 | 362 | return self.x + y + 1 |
|
366 | 363 | @property |
|
367 | 364 | def quux(self): |
|
368 | 365 | return 43 |
|
369 | 366 | |
|
370 | 367 | class Bar: # old-style class |
|
371 | 368 | def foo(self): |
|
372 | 369 | return 2 |
|
373 | 370 | """) |
|
374 | 371 | |
|
375 | 372 | def check_module_contents(): |
|
376 | 373 | nt.assert_equal(mod.x, 10) |
|
377 | 374 | nt.assert_false(hasattr(mod, 'z')) |
|
378 | 375 | |
|
379 | 376 | nt.assert_equal(old_foo(0), 4) # superreload magic! |
|
380 | 377 | nt.assert_equal(mod.foo(0), 4) |
|
381 | 378 | |
|
382 | 379 | obj = mod.Baz(9) |
|
383 | 380 | nt.assert_equal(old_obj.bar(1), 11) # superreload magic! |
|
384 | 381 | nt.assert_equal(obj.bar(1), 11) |
|
385 | 382 | |
|
386 | 383 | nt.assert_equal(old_obj.quux, 43) |
|
387 | 384 | nt.assert_equal(obj.quux, 43) |
|
388 | 385 | |
|
389 | 386 | nt.assert_false(hasattr(old_obj, 'zzz')) |
|
390 | 387 | nt.assert_false(hasattr(obj, 'zzz')) |
|
391 | 388 | |
|
392 | 389 | obj2 = mod.Bar() |
|
393 | 390 | nt.assert_equal(old_obj2.foo(), 2) |
|
394 | 391 | nt.assert_equal(obj2.foo(), 2) |
|
395 | 392 | |
|
396 | 393 | self.shell.run_code("pass") # trigger reload |
|
397 | 394 | check_module_contents() |
|
398 | 395 | |
|
399 | 396 | # |
|
400 | 397 | # Another failure case: deleted file (shouldn't reload) |
|
401 | 398 | # |
|
402 | 399 | os.unlink(mod_fn) |
|
403 | 400 | |
|
404 | 401 | self.shell.run_code("pass") # trigger reload |
|
405 | 402 | check_module_contents() |
|
406 | 403 | |
|
407 | 404 | # |
|
408 | 405 | # Disable autoreload and rewrite module: no reload should occur |
|
409 | 406 | # |
|
410 | 407 | if use_aimport: |
|
411 | 408 | self.shell.magic_aimport("-" + mod_name) |
|
412 | 409 | stream = StringIO() |
|
413 | 410 | self.shell.magic_aimport("", stream=stream) |
|
414 | 411 | nt.assert_true(("Modules to skip:\n%s" % mod_name) in |
|
415 | 412 | stream.getvalue()) |
|
416 | 413 | |
|
417 | 414 | # This should succeed, although no such module exists |
|
418 | 415 | self.shell.magic_aimport("-tmpmod_as318989e89ds") |
|
419 | 416 | else: |
|
420 | 417 | self.shell.magic_autoreload("0") |
|
421 | 418 | |
|
422 | 419 | self.write_file(mod_fn, """ |
|
423 | 420 | x = -99 |
|
424 | 421 | """) |
|
425 | 422 | |
|
426 | 423 | self.shell.run_code("pass") # trigger reload |
|
427 | 424 | self.shell.run_code("pass") |
|
428 | 425 | check_module_contents() |
|
429 | 426 | |
|
430 | 427 | # |
|
431 | 428 | # Re-enable autoreload: reload should now occur |
|
432 | 429 | # |
|
433 | 430 | if use_aimport: |
|
434 | 431 | self.shell.magic_aimport(mod_name) |
|
435 | 432 | else: |
|
436 | 433 | self.shell.magic_autoreload("") |
|
437 | 434 | |
|
438 | 435 | self.shell.run_code("pass") # trigger reload |
|
439 | 436 | nt.assert_equal(mod.x, -99) |
|
440 | 437 | |
|
441 | 438 | def test_smoketest_aimport(self): |
|
442 | 439 | self._check_smoketest(use_aimport=True) |
|
443 | 440 | |
|
444 | 441 | def test_smoketest_autoreload(self): |
|
445 | 442 | self._check_smoketest(use_aimport=False) |
|
446 | 443 | |
|
447 | 444 | |
|
448 | 445 | |
|
449 | 446 | |
|
450 | 447 |
@@ -1,4 +1,4 b'' | |||
|
1 | 1 | from warnings import warn |
|
2 | 2 | |
|
3 | warn("IPython.utils.daemonize has moved to ipyparallel.apps.daemonize", stacklevel=2) | |
|
3 | warn("IPython.utils.daemonize has moved to ipyparallel.apps.daemonize since IPython 4.0", DeprecationWarning, stacklevel=2) | |
|
4 | 4 | from ipyparallel.apps.daemonize import daemonize |
@@ -1,95 +1,94 b'' | |||
|
1 | 1 | # encoding: utf-8 |
|
2 | 2 | """ |
|
3 | 3 | Utilities for working with stack frames. |
|
4 | 4 | """ |
|
5 | 5 | |
|
6 | 6 | #----------------------------------------------------------------------------- |
|
7 | 7 | # Copyright (C) 2008-2011 The IPython Development Team |
|
8 | 8 | # |
|
9 | 9 | # Distributed under the terms of the BSD License. The full license is in |
|
10 | 10 | # the file COPYING, distributed as part of this software. |
|
11 | 11 | #----------------------------------------------------------------------------- |
|
12 | 12 | |
|
13 | 13 | #----------------------------------------------------------------------------- |
|
14 | 14 | # Imports |
|
15 | 15 | #----------------------------------------------------------------------------- |
|
16 | 16 | |
|
17 | 17 | import sys |
|
18 | from IPython.utils import py3compat | |
|
19 | 18 | |
|
20 | 19 | #----------------------------------------------------------------------------- |
|
21 | 20 | # Code |
|
22 | 21 | #----------------------------------------------------------------------------- |
|
23 | 22 | |
|
24 | 23 | def extract_vars(*names,**kw): |
|
25 | 24 | """Extract a set of variables by name from another frame. |
|
26 | 25 | |
|
27 | 26 | Parameters |
|
28 | 27 | ---------- |
|
29 | 28 | *names : str |
|
30 | 29 | One or more variable names which will be extracted from the caller's |
|
31 | 30 | frame. |
|
32 | 31 | |
|
33 | 32 | depth : integer, optional |
|
34 | 33 | How many frames in the stack to walk when looking for your variables. |
|
35 | 34 | The default is 0, which will use the frame where the call was made. |
|
36 | 35 | |
|
37 | 36 | |
|
38 | 37 | Examples |
|
39 | 38 | -------- |
|
40 | 39 | :: |
|
41 | 40 | |
|
42 | 41 | In [2]: def func(x): |
|
43 | 42 | ...: y = 1 |
|
44 | 43 | ...: print(sorted(extract_vars('x','y').items())) |
|
45 | 44 | ...: |
|
46 | 45 | |
|
47 | 46 | In [3]: func('hello') |
|
48 | 47 | [('x', 'hello'), ('y', 1)] |
|
49 | 48 | """ |
|
50 | 49 | |
|
51 | 50 | depth = kw.get('depth',0) |
|
52 | 51 | |
|
53 | 52 | callerNS = sys._getframe(depth+1).f_locals |
|
54 | 53 | return dict((k,callerNS[k]) for k in names) |
|
55 | 54 | |
|
56 | 55 | |
|
57 | 56 | def extract_vars_above(*names): |
|
58 | 57 | """Extract a set of variables by name from another frame. |
|
59 | 58 | |
|
60 | 59 | Similar to extractVars(), but with a specified depth of 1, so that names |
|
61 | 60 | are extracted exactly from above the caller. |
|
62 | 61 | |
|
63 | 62 | This is simply a convenience function so that the very common case (for us) |
|
64 | 63 | of skipping exactly 1 frame doesn't have to construct a special dict for |
|
65 | 64 | keyword passing.""" |
|
66 | 65 | |
|
67 | 66 | callerNS = sys._getframe(2).f_locals |
|
68 | 67 | return dict((k,callerNS[k]) for k in names) |
|
69 | 68 | |
|
70 | 69 | |
|
71 | 70 | def debugx(expr,pre_msg=''): |
|
72 | 71 | """Print the value of an expression from the caller's frame. |
|
73 | 72 | |
|
74 | 73 | Takes an expression, evaluates it in the caller's frame and prints both |
|
75 | 74 | the given expression and the resulting value (as well as a debug mark |
|
76 | 75 | indicating the name of the calling function. The input must be of a form |
|
77 | 76 | suitable for eval(). |
|
78 | 77 | |
|
79 | 78 | An optional message can be passed, which will be prepended to the printed |
|
80 | 79 | expr->value pair.""" |
|
81 | 80 | |
|
82 | 81 | cf = sys._getframe(1) |
|
83 | 82 | print('[DBG:%s] %s%s -> %r' % (cf.f_code.co_name,pre_msg,expr, |
|
84 | 83 | eval(expr,cf.f_globals,cf.f_locals))) |
|
85 | 84 | |
|
86 | 85 | |
|
87 | 86 | # deactivate it by uncommenting the following line, which makes it a no-op |
|
88 | 87 | #def debugx(expr,pre_msg=''): pass |
|
89 | 88 | |
|
90 | 89 | def extract_module_locals(depth=0): |
|
91 | 90 | """Returns (module, locals) of the function `depth` frames away from the caller""" |
|
92 | 91 | f = sys._getframe(depth + 1) |
|
93 | 92 | global_ns = f.f_globals |
|
94 | 93 | module = sys.modules[global_ns['__name__']] |
|
95 | 94 | return (module, f.f_locals) |
@@ -1,94 +1,89 b'' | |||
|
1 | 1 | # encoding: utf-8 |
|
2 | 2 | """Tests for io.py""" |
|
3 | 3 | |
|
4 | 4 | # Copyright (c) IPython Development Team. |
|
5 | 5 | # Distributed under the terms of the Modified BSD License. |
|
6 | 6 | |
|
7 | 7 | |
|
8 | import io as stdlib_io | |
|
9 | import os.path | |
|
10 | import stat | |
|
11 | 8 | import sys |
|
12 | 9 | from io import StringIO |
|
13 | 10 | |
|
14 | 11 | from subprocess import Popen, PIPE |
|
15 | 12 | import unittest |
|
16 | 13 | |
|
17 | 14 | import nose.tools as nt |
|
18 | 15 | |
|
19 | from IPython.testing.decorators import skipif, skip_win32 | |
|
20 | 16 | from IPython.utils.io import IOStream, Tee, capture_output |
|
21 | from IPython.utils.tempdir import TemporaryDirectory | |
|
22 | 17 | |
|
23 | 18 | |
|
24 | 19 | def test_tee_simple(): |
|
25 | 20 | "Very simple check with stdout only" |
|
26 | 21 | chan = StringIO() |
|
27 | 22 | text = 'Hello' |
|
28 | 23 | tee = Tee(chan, channel='stdout') |
|
29 | 24 | print(text, file=chan) |
|
30 | 25 | nt.assert_equal(chan.getvalue(), text+"\n") |
|
31 | 26 | |
|
32 | 27 | |
|
33 | 28 | class TeeTestCase(unittest.TestCase): |
|
34 | 29 | |
|
35 | 30 | def tchan(self, channel): |
|
36 | 31 | trap = StringIO() |
|
37 | 32 | chan = StringIO() |
|
38 | 33 | text = 'Hello' |
|
39 | 34 | |
|
40 | 35 | std_ori = getattr(sys, channel) |
|
41 | 36 | setattr(sys, channel, trap) |
|
42 | 37 | |
|
43 | 38 | tee = Tee(chan, channel=channel) |
|
44 | 39 | |
|
45 | 40 | print(text, end='', file=chan) |
|
46 | 41 | trap_val = trap.getvalue() |
|
47 | 42 | nt.assert_equal(chan.getvalue(), text) |
|
48 | 43 | |
|
49 | 44 | tee.close() |
|
50 | 45 | |
|
51 | 46 | setattr(sys, channel, std_ori) |
|
52 | 47 | assert getattr(sys, channel) == std_ori |
|
53 | 48 | |
|
54 | 49 | def test(self): |
|
55 | 50 | for chan in ['stdout', 'stderr']: |
|
56 | 51 | self.tchan(chan) |
|
57 | 52 | |
|
58 | 53 | def test_io_init(): |
|
59 | 54 | """Test that io.stdin/out/err exist at startup""" |
|
60 | 55 | for name in ('stdin', 'stdout', 'stderr'): |
|
61 | 56 | cmd = "from IPython.utils import io;print(io.%s.__class__)"%name |
|
62 | 57 | with Popen([sys.executable, '-c', cmd], stdout=PIPE) as p: |
|
63 | 58 | p.wait() |
|
64 | 59 | classname = p.stdout.read().strip().decode('ascii') |
|
65 | 60 | # __class__ is a reference to the class object in Python 3, so we can't |
|
66 | 61 | # just test for string equality. |
|
67 | 62 | assert 'IPython.utils.io.IOStream' in classname, classname |
|
68 | 63 | |
|
69 | 64 | class TestIOStream(unittest.TestCase): |
|
70 | 65 | |
|
71 | 66 | def test_IOStream_init(self): |
|
72 | 67 | """IOStream initializes from a file-like object missing attributes. """ |
|
73 | 68 | # Cause a failure from getattr and dir(). (Issue #6386) |
|
74 | 69 | class BadStringIO(StringIO): |
|
75 | 70 | def __dir__(self): |
|
76 | 71 | attrs = super().__dir__() |
|
77 | 72 | attrs.append('name') |
|
78 | 73 | return attrs |
|
79 | 74 | with self.assertWarns(DeprecationWarning): |
|
80 | 75 | iostream = IOStream(BadStringIO()) |
|
81 | 76 | iostream.write('hi, bad iostream\n') |
|
82 | 77 | |
|
83 | 78 | assert not hasattr(iostream, 'name') |
|
84 | 79 | iostream.close() |
|
85 | 80 | |
|
86 | 81 | def test_capture_output(self): |
|
87 | 82 | """capture_output() context works""" |
|
88 | 83 | |
|
89 | 84 | with capture_output() as io: |
|
90 | 85 | print('hi, stdout') |
|
91 | 86 | print('hi, stderr', file=sys.stderr) |
|
92 | 87 | |
|
93 | 88 | nt.assert_equal(io.stdout, 'hi, stdout\n') |
|
94 | 89 | nt.assert_equal(io.stderr, 'hi, stderr\n') |
@@ -1,492 +1,492 b'' | |||
|
1 | 1 | # encoding: utf-8 |
|
2 | 2 | """Tests for IPython.utils.path.py""" |
|
3 | 3 | |
|
4 | 4 | # Copyright (c) IPython Development Team. |
|
5 | 5 | # Distributed under the terms of the Modified BSD License. |
|
6 | 6 | |
|
7 | 7 | import os |
|
8 | 8 | import shutil |
|
9 | 9 | import sys |
|
10 | 10 | import tempfile |
|
11 | 11 | import unittest |
|
12 | 12 | from contextlib import contextmanager |
|
13 | 13 | from unittest.mock import patch |
|
14 | 14 | from os.path import join, abspath |
|
15 | 15 | from imp import reload |
|
16 | 16 | |
|
17 | 17 | from nose import SkipTest, with_setup |
|
18 | 18 | import nose.tools as nt |
|
19 | 19 | |
|
20 | 20 | import IPython |
|
21 | 21 | from IPython import paths |
|
22 | 22 | from IPython.testing import decorators as dec |
|
23 | 23 | from IPython.testing.decorators import (skip_if_not_win32, skip_win32, |
|
24 |
onlyif_unicode_paths, |
|
|
24 | onlyif_unicode_paths, | |
|
25 | 25 | skip_win32_py38,) |
|
26 |
from IPython.testing.tools import make_tempfile |
|
|
26 | from IPython.testing.tools import make_tempfile | |
|
27 | 27 | from IPython.utils import path |
|
28 | 28 | from IPython.utils.tempdir import TemporaryDirectory |
|
29 | 29 | |
|
30 | 30 | |
|
31 | 31 | # Platform-dependent imports |
|
32 | 32 | try: |
|
33 | 33 | import winreg as wreg |
|
34 | 34 | except ImportError: |
|
35 | 35 | #Fake _winreg module on non-windows platforms |
|
36 | 36 | import types |
|
37 | 37 | wr_name = "winreg" |
|
38 | 38 | sys.modules[wr_name] = types.ModuleType(wr_name) |
|
39 | 39 | try: |
|
40 | 40 | import winreg as wreg |
|
41 | 41 | except ImportError: |
|
42 | 42 | import _winreg as wreg |
|
43 | 43 | #Add entries that needs to be stubbed by the testing code |
|
44 | 44 | (wreg.OpenKey, wreg.QueryValueEx,) = (None, None) |
|
45 | 45 | |
|
46 | 46 | #----------------------------------------------------------------------------- |
|
47 | 47 | # Globals |
|
48 | 48 | #----------------------------------------------------------------------------- |
|
49 | 49 | env = os.environ |
|
50 | 50 | TMP_TEST_DIR = tempfile.mkdtemp() |
|
51 | 51 | HOME_TEST_DIR = join(TMP_TEST_DIR, "home_test_dir") |
|
52 | 52 | # |
|
53 | 53 | # Setup/teardown functions/decorators |
|
54 | 54 | # |
|
55 | 55 | |
|
56 | 56 | def setup_module(): |
|
57 | 57 | """Setup testenvironment for the module: |
|
58 | 58 | |
|
59 | 59 | - Adds dummy home dir tree |
|
60 | 60 | """ |
|
61 | 61 | # Do not mask exceptions here. In particular, catching WindowsError is a |
|
62 | 62 | # problem because that exception is only defined on Windows... |
|
63 | 63 | os.makedirs(os.path.join(HOME_TEST_DIR, 'ipython')) |
|
64 | 64 | |
|
65 | 65 | |
|
66 | 66 | def teardown_module(): |
|
67 | 67 | """Teardown testenvironment for the module: |
|
68 | 68 | |
|
69 | 69 | - Remove dummy home dir tree |
|
70 | 70 | """ |
|
71 | 71 | # Note: we remove the parent test dir, which is the root of all test |
|
72 | 72 | # subdirs we may have created. Use shutil instead of os.removedirs, so |
|
73 | 73 | # that non-empty directories are all recursively removed. |
|
74 | 74 | shutil.rmtree(TMP_TEST_DIR) |
|
75 | 75 | |
|
76 | 76 | |
|
77 | 77 | def setup_environment(): |
|
78 | 78 | """Setup testenvironment for some functions that are tested |
|
79 | 79 | in this module. In particular this functions stores attributes |
|
80 | 80 | and other things that we need to stub in some test functions. |
|
81 | 81 | This needs to be done on a function level and not module level because |
|
82 | 82 | each testfunction needs a pristine environment. |
|
83 | 83 | """ |
|
84 | 84 | global oldstuff, platformstuff |
|
85 | 85 | oldstuff = (env.copy(), os.name, sys.platform, path.get_home_dir, IPython.__file__, os.getcwd()) |
|
86 | 86 | |
|
87 | 87 | def teardown_environment(): |
|
88 | 88 | """Restore things that were remembered by the setup_environment function |
|
89 | 89 | """ |
|
90 | 90 | (oldenv, os.name, sys.platform, path.get_home_dir, IPython.__file__, old_wd) = oldstuff |
|
91 | 91 | os.chdir(old_wd) |
|
92 | 92 | reload(path) |
|
93 | 93 | |
|
94 | 94 | for key in list(env): |
|
95 | 95 | if key not in oldenv: |
|
96 | 96 | del env[key] |
|
97 | 97 | env.update(oldenv) |
|
98 | 98 | if hasattr(sys, 'frozen'): |
|
99 | 99 | del sys.frozen |
|
100 | 100 | |
|
101 | 101 | # Build decorator that uses the setup_environment/setup_environment |
|
102 | 102 | with_environment = with_setup(setup_environment, teardown_environment) |
|
103 | 103 | |
|
104 | 104 | @skip_if_not_win32 |
|
105 | 105 | @with_environment |
|
106 | 106 | def test_get_home_dir_1(): |
|
107 | 107 | """Testcase for py2exe logic, un-compressed lib |
|
108 | 108 | """ |
|
109 | 109 | unfrozen = path.get_home_dir() |
|
110 | 110 | sys.frozen = True |
|
111 | 111 | |
|
112 | 112 | #fake filename for IPython.__init__ |
|
113 | 113 | IPython.__file__ = abspath(join(HOME_TEST_DIR, "Lib/IPython/__init__.py")) |
|
114 | 114 | |
|
115 | 115 | home_dir = path.get_home_dir() |
|
116 | 116 | nt.assert_equal(home_dir, unfrozen) |
|
117 | 117 | |
|
118 | 118 | |
|
119 | 119 | @skip_if_not_win32 |
|
120 | 120 | @with_environment |
|
121 | 121 | def test_get_home_dir_2(): |
|
122 | 122 | """Testcase for py2exe logic, compressed lib |
|
123 | 123 | """ |
|
124 | 124 | unfrozen = path.get_home_dir() |
|
125 | 125 | sys.frozen = True |
|
126 | 126 | #fake filename for IPython.__init__ |
|
127 | 127 | IPython.__file__ = abspath(join(HOME_TEST_DIR, "Library.zip/IPython/__init__.py")).lower() |
|
128 | 128 | |
|
129 | 129 | home_dir = path.get_home_dir(True) |
|
130 | 130 | nt.assert_equal(home_dir, unfrozen) |
|
131 | 131 | |
|
132 | 132 | |
|
133 | 133 | @skip_win32_py38 |
|
134 | 134 | @with_environment |
|
135 | 135 | def test_get_home_dir_3(): |
|
136 | 136 | """get_home_dir() uses $HOME if set""" |
|
137 | 137 | env["HOME"] = HOME_TEST_DIR |
|
138 | 138 | home_dir = path.get_home_dir(True) |
|
139 | 139 | # get_home_dir expands symlinks |
|
140 | 140 | nt.assert_equal(home_dir, os.path.realpath(env["HOME"])) |
|
141 | 141 | |
|
142 | 142 | |
|
143 | 143 | @with_environment |
|
144 | 144 | def test_get_home_dir_4(): |
|
145 | 145 | """get_home_dir() still works if $HOME is not set""" |
|
146 | 146 | |
|
147 | 147 | if 'HOME' in env: del env['HOME'] |
|
148 | 148 | # this should still succeed, but we don't care what the answer is |
|
149 | 149 | home = path.get_home_dir(False) |
|
150 | 150 | |
|
151 | 151 | @skip_win32_py38 |
|
152 | 152 | @with_environment |
|
153 | 153 | def test_get_home_dir_5(): |
|
154 | 154 | """raise HomeDirError if $HOME is specified, but not a writable dir""" |
|
155 | 155 | env['HOME'] = abspath(HOME_TEST_DIR+'garbage') |
|
156 | 156 | # set os.name = posix, to prevent My Documents fallback on Windows |
|
157 | 157 | os.name = 'posix' |
|
158 | 158 | nt.assert_raises(path.HomeDirError, path.get_home_dir, True) |
|
159 | 159 | |
|
160 | 160 | # Should we stub wreg fully so we can run the test on all platforms? |
|
161 | 161 | @skip_if_not_win32 |
|
162 | 162 | @with_environment |
|
163 | 163 | def test_get_home_dir_8(): |
|
164 | 164 | """Using registry hack for 'My Documents', os=='nt' |
|
165 | 165 | |
|
166 | 166 | HOMESHARE, HOMEDRIVE, HOMEPATH, USERPROFILE and others are missing. |
|
167 | 167 | """ |
|
168 | 168 | os.name = 'nt' |
|
169 | 169 | # Remove from stub environment all keys that may be set |
|
170 | 170 | for key in ['HOME', 'HOMESHARE', 'HOMEDRIVE', 'HOMEPATH', 'USERPROFILE']: |
|
171 | 171 | env.pop(key, None) |
|
172 | 172 | |
|
173 | 173 | class key: |
|
174 | 174 | def __enter__(self): |
|
175 | 175 | pass |
|
176 | 176 | def Close(self): |
|
177 | 177 | pass |
|
178 | 178 | def __exit__(*args, **kwargs): |
|
179 | 179 | pass |
|
180 | 180 | |
|
181 | 181 | with patch.object(wreg, 'OpenKey', return_value=key()), \ |
|
182 | 182 | patch.object(wreg, 'QueryValueEx', return_value=[abspath(HOME_TEST_DIR)]): |
|
183 | 183 | home_dir = path.get_home_dir() |
|
184 | 184 | nt.assert_equal(home_dir, abspath(HOME_TEST_DIR)) |
|
185 | 185 | |
|
186 | 186 | @with_environment |
|
187 | 187 | def test_get_xdg_dir_0(): |
|
188 | 188 | """test_get_xdg_dir_0, check xdg_dir""" |
|
189 | 189 | reload(path) |
|
190 | 190 | path._writable_dir = lambda path: True |
|
191 | 191 | path.get_home_dir = lambda : 'somewhere' |
|
192 | 192 | os.name = "posix" |
|
193 | 193 | sys.platform = "linux2" |
|
194 | 194 | env.pop('IPYTHON_DIR', None) |
|
195 | 195 | env.pop('IPYTHONDIR', None) |
|
196 | 196 | env.pop('XDG_CONFIG_HOME', None) |
|
197 | 197 | |
|
198 | 198 | nt.assert_equal(path.get_xdg_dir(), os.path.join('somewhere', '.config')) |
|
199 | 199 | |
|
200 | 200 | |
|
201 | 201 | @with_environment |
|
202 | 202 | def test_get_xdg_dir_1(): |
|
203 | 203 | """test_get_xdg_dir_1, check nonexistent xdg_dir""" |
|
204 | 204 | reload(path) |
|
205 | 205 | path.get_home_dir = lambda : HOME_TEST_DIR |
|
206 | 206 | os.name = "posix" |
|
207 | 207 | sys.platform = "linux2" |
|
208 | 208 | env.pop('IPYTHON_DIR', None) |
|
209 | 209 | env.pop('IPYTHONDIR', None) |
|
210 | 210 | env.pop('XDG_CONFIG_HOME', None) |
|
211 | 211 | nt.assert_equal(path.get_xdg_dir(), None) |
|
212 | 212 | |
|
213 | 213 | @with_environment |
|
214 | 214 | def test_get_xdg_dir_2(): |
|
215 | 215 | """test_get_xdg_dir_2, check xdg_dir default to ~/.config""" |
|
216 | 216 | reload(path) |
|
217 | 217 | path.get_home_dir = lambda : HOME_TEST_DIR |
|
218 | 218 | os.name = "posix" |
|
219 | 219 | sys.platform = "linux2" |
|
220 | 220 | env.pop('IPYTHON_DIR', None) |
|
221 | 221 | env.pop('IPYTHONDIR', None) |
|
222 | 222 | env.pop('XDG_CONFIG_HOME', None) |
|
223 | 223 | cfgdir=os.path.join(path.get_home_dir(), '.config') |
|
224 | 224 | if not os.path.exists(cfgdir): |
|
225 | 225 | os.makedirs(cfgdir) |
|
226 | 226 | |
|
227 | 227 | nt.assert_equal(path.get_xdg_dir(), cfgdir) |
|
228 | 228 | |
|
229 | 229 | @with_environment |
|
230 | 230 | def test_get_xdg_dir_3(): |
|
231 | 231 | """test_get_xdg_dir_3, check xdg_dir not used on OS X""" |
|
232 | 232 | reload(path) |
|
233 | 233 | path.get_home_dir = lambda : HOME_TEST_DIR |
|
234 | 234 | os.name = "posix" |
|
235 | 235 | sys.platform = "darwin" |
|
236 | 236 | env.pop('IPYTHON_DIR', None) |
|
237 | 237 | env.pop('IPYTHONDIR', None) |
|
238 | 238 | env.pop('XDG_CONFIG_HOME', None) |
|
239 | 239 | cfgdir=os.path.join(path.get_home_dir(), '.config') |
|
240 | 240 | if not os.path.exists(cfgdir): |
|
241 | 241 | os.makedirs(cfgdir) |
|
242 | 242 | |
|
243 | 243 | nt.assert_equal(path.get_xdg_dir(), None) |
|
244 | 244 | |
|
245 | 245 | def test_filefind(): |
|
246 | 246 | """Various tests for filefind""" |
|
247 | 247 | f = tempfile.NamedTemporaryFile() |
|
248 | 248 | # print 'fname:',f.name |
|
249 | 249 | alt_dirs = paths.get_ipython_dir() |
|
250 | 250 | t = path.filefind(f.name, alt_dirs) |
|
251 | 251 | # print 'found:',t |
|
252 | 252 | |
|
253 | 253 | |
|
254 | 254 | @dec.skip_if_not_win32 |
|
255 | 255 | def test_get_long_path_name_win32(): |
|
256 | 256 | with TemporaryDirectory() as tmpdir: |
|
257 | 257 | |
|
258 | 258 | # Make a long path. Expands the path of tmpdir prematurely as it may already have a long |
|
259 | 259 | # path component, so ensure we include the long form of it |
|
260 | 260 | long_path = os.path.join(path.get_long_path_name(tmpdir), 'this is my long path name') |
|
261 | 261 | os.makedirs(long_path) |
|
262 | 262 | |
|
263 | 263 | # Test to see if the short path evaluates correctly. |
|
264 | 264 | short_path = os.path.join(tmpdir, 'THISIS~1') |
|
265 | 265 | evaluated_path = path.get_long_path_name(short_path) |
|
266 | 266 | nt.assert_equal(evaluated_path.lower(), long_path.lower()) |
|
267 | 267 | |
|
268 | 268 | |
|
269 | 269 | @dec.skip_win32 |
|
270 | 270 | def test_get_long_path_name(): |
|
271 | 271 | p = path.get_long_path_name('/usr/local') |
|
272 | 272 | nt.assert_equal(p,'/usr/local') |
|
273 | 273 | |
|
274 | 274 | |
|
275 | 275 | class TestRaiseDeprecation(unittest.TestCase): |
|
276 | 276 | |
|
277 | 277 | @dec.skip_win32 # can't create not-user-writable dir on win |
|
278 | 278 | @with_environment |
|
279 | 279 | def test_not_writable_ipdir(self): |
|
280 | 280 | tmpdir = tempfile.mkdtemp() |
|
281 | 281 | os.name = "posix" |
|
282 | 282 | env.pop('IPYTHON_DIR', None) |
|
283 | 283 | env.pop('IPYTHONDIR', None) |
|
284 | 284 | env.pop('XDG_CONFIG_HOME', None) |
|
285 | 285 | env['HOME'] = tmpdir |
|
286 | 286 | ipdir = os.path.join(tmpdir, '.ipython') |
|
287 | 287 | os.mkdir(ipdir, 0o555) |
|
288 | 288 | try: |
|
289 | 289 | open(os.path.join(ipdir, "_foo_"), 'w').close() |
|
290 | 290 | except IOError: |
|
291 | 291 | pass |
|
292 | 292 | else: |
|
293 | 293 | # I can still write to an unwritable dir, |
|
294 | 294 | # assume I'm root and skip the test |
|
295 | 295 | raise SkipTest("I can't create directories that I can't write to") |
|
296 | 296 | with self.assertWarnsRegex(UserWarning, 'is not a writable location'): |
|
297 | 297 | ipdir = paths.get_ipython_dir() |
|
298 | 298 | env.pop('IPYTHON_DIR', None) |
|
299 | 299 | |
|
300 | 300 | @with_environment |
|
301 | 301 | def test_get_py_filename(): |
|
302 | 302 | os.chdir(TMP_TEST_DIR) |
|
303 | 303 | with make_tempfile('foo.py'): |
|
304 | 304 | nt.assert_equal(path.get_py_filename('foo.py'), 'foo.py') |
|
305 | 305 | nt.assert_equal(path.get_py_filename('foo'), 'foo.py') |
|
306 | 306 | with make_tempfile('foo'): |
|
307 | 307 | nt.assert_equal(path.get_py_filename('foo'), 'foo') |
|
308 | 308 | nt.assert_raises(IOError, path.get_py_filename, 'foo.py') |
|
309 | 309 | nt.assert_raises(IOError, path.get_py_filename, 'foo') |
|
310 | 310 | nt.assert_raises(IOError, path.get_py_filename, 'foo.py') |
|
311 | 311 | true_fn = 'foo with spaces.py' |
|
312 | 312 | with make_tempfile(true_fn): |
|
313 | 313 | nt.assert_equal(path.get_py_filename('foo with spaces'), true_fn) |
|
314 | 314 | nt.assert_equal(path.get_py_filename('foo with spaces.py'), true_fn) |
|
315 | 315 | nt.assert_raises(IOError, path.get_py_filename, '"foo with spaces.py"') |
|
316 | 316 | nt.assert_raises(IOError, path.get_py_filename, "'foo with spaces.py'") |
|
317 | 317 | |
|
318 | 318 | @onlyif_unicode_paths |
|
319 | 319 | def test_unicode_in_filename(): |
|
320 | 320 | """When a file doesn't exist, the exception raised should be safe to call |
|
321 | 321 | str() on - i.e. in Python 2 it must only have ASCII characters. |
|
322 | 322 | |
|
323 | 323 | https://github.com/ipython/ipython/issues/875 |
|
324 | 324 | """ |
|
325 | 325 | try: |
|
326 | 326 | # these calls should not throw unicode encode exceptions |
|
327 | 327 | path.get_py_filename('fooéè.py') |
|
328 | 328 | except IOError as ex: |
|
329 | 329 | str(ex) |
|
330 | 330 | |
|
331 | 331 | |
|
332 | 332 | class TestShellGlob(unittest.TestCase): |
|
333 | 333 | |
|
334 | 334 | @classmethod |
|
335 | 335 | def setUpClass(cls): |
|
336 | 336 | cls.filenames_start_with_a = ['a0', 'a1', 'a2'] |
|
337 | 337 | cls.filenames_end_with_b = ['0b', '1b', '2b'] |
|
338 | 338 | cls.filenames = cls.filenames_start_with_a + cls.filenames_end_with_b |
|
339 | 339 | cls.tempdir = TemporaryDirectory() |
|
340 | 340 | td = cls.tempdir.name |
|
341 | 341 | |
|
342 | 342 | with cls.in_tempdir(): |
|
343 | 343 | # Create empty files |
|
344 | 344 | for fname in cls.filenames: |
|
345 | 345 | open(os.path.join(td, fname), 'w').close() |
|
346 | 346 | |
|
347 | 347 | @classmethod |
|
348 | 348 | def tearDownClass(cls): |
|
349 | 349 | cls.tempdir.cleanup() |
|
350 | 350 | |
|
351 | 351 | @classmethod |
|
352 | 352 | @contextmanager |
|
353 | 353 | def in_tempdir(cls): |
|
354 | 354 | save = os.getcwd() |
|
355 | 355 | try: |
|
356 | 356 | os.chdir(cls.tempdir.name) |
|
357 | 357 | yield |
|
358 | 358 | finally: |
|
359 | 359 | os.chdir(save) |
|
360 | 360 | |
|
361 | 361 | def check_match(self, patterns, matches): |
|
362 | 362 | with self.in_tempdir(): |
|
363 | 363 | # glob returns unordered list. that's why sorted is required. |
|
364 | 364 | nt.assert_equal(sorted(path.shellglob(patterns)), |
|
365 | 365 | sorted(matches)) |
|
366 | 366 | |
|
367 | 367 | def common_cases(self): |
|
368 | 368 | return [ |
|
369 | 369 | (['*'], self.filenames), |
|
370 | 370 | (['a*'], self.filenames_start_with_a), |
|
371 | 371 | (['*c'], ['*c']), |
|
372 | 372 | (['*', 'a*', '*b', '*c'], self.filenames |
|
373 | 373 | + self.filenames_start_with_a |
|
374 | 374 | + self.filenames_end_with_b |
|
375 | 375 | + ['*c']), |
|
376 | 376 | (['a[012]'], self.filenames_start_with_a), |
|
377 | 377 | ] |
|
378 | 378 | |
|
379 | 379 | @skip_win32 |
|
380 | 380 | def test_match_posix(self): |
|
381 | 381 | for (patterns, matches) in self.common_cases() + [ |
|
382 | 382 | ([r'\*'], ['*']), |
|
383 | 383 | ([r'a\*', 'a*'], ['a*'] + self.filenames_start_with_a), |
|
384 | 384 | ([r'a\[012]'], ['a[012]']), |
|
385 | 385 | ]: |
|
386 | 386 | yield (self.check_match, patterns, matches) |
|
387 | 387 | |
|
388 | 388 | @skip_if_not_win32 |
|
389 | 389 | def test_match_windows(self): |
|
390 | 390 | for (patterns, matches) in self.common_cases() + [ |
|
391 | 391 | # In windows, backslash is interpreted as path |
|
392 | 392 | # separator. Therefore, you can't escape glob |
|
393 | 393 | # using it. |
|
394 | 394 | ([r'a\*', 'a*'], [r'a\*'] + self.filenames_start_with_a), |
|
395 | 395 | ([r'a\[012]'], [r'a\[012]']), |
|
396 | 396 | ]: |
|
397 | 397 | yield (self.check_match, patterns, matches) |
|
398 | 398 | |
|
399 | 399 | |
|
400 | 400 | def test_unescape_glob(): |
|
401 | 401 | nt.assert_equal(path.unescape_glob(r'\*\[\!\]\?'), '*[!]?') |
|
402 | 402 | nt.assert_equal(path.unescape_glob(r'\\*'), r'\*') |
|
403 | 403 | nt.assert_equal(path.unescape_glob(r'\\\*'), r'\*') |
|
404 | 404 | nt.assert_equal(path.unescape_glob(r'\\a'), r'\a') |
|
405 | 405 | nt.assert_equal(path.unescape_glob(r'\a'), r'\a') |
|
406 | 406 | |
|
407 | 407 | |
|
408 | 408 | @onlyif_unicode_paths |
|
409 | 409 | def test_ensure_dir_exists(): |
|
410 | 410 | with TemporaryDirectory() as td: |
|
411 | 411 | d = os.path.join(td, 'βir') |
|
412 | 412 | path.ensure_dir_exists(d) # create it |
|
413 | 413 | assert os.path.isdir(d) |
|
414 | 414 | path.ensure_dir_exists(d) # no-op |
|
415 | 415 | f = os.path.join(td, 'Ζile') |
|
416 | 416 | open(f, 'w').close() # touch |
|
417 | 417 | with nt.assert_raises(IOError): |
|
418 | 418 | path.ensure_dir_exists(f) |
|
419 | 419 | |
|
420 | 420 | class TestLinkOrCopy(unittest.TestCase): |
|
421 | 421 | def setUp(self): |
|
422 | 422 | self.tempdir = TemporaryDirectory() |
|
423 | 423 | self.src = self.dst("src") |
|
424 | 424 | with open(self.src, "w") as f: |
|
425 | 425 | f.write("Hello, world!") |
|
426 | 426 | |
|
427 | 427 | def tearDown(self): |
|
428 | 428 | self.tempdir.cleanup() |
|
429 | 429 | |
|
430 | 430 | def dst(self, *args): |
|
431 | 431 | return os.path.join(self.tempdir.name, *args) |
|
432 | 432 | |
|
433 | 433 | def assert_inode_not_equal(self, a, b): |
|
434 | 434 | nt.assert_not_equal(os.stat(a).st_ino, os.stat(b).st_ino, |
|
435 | 435 | "%r and %r do reference the same indoes" %(a, b)) |
|
436 | 436 | |
|
437 | 437 | def assert_inode_equal(self, a, b): |
|
438 | 438 | nt.assert_equal(os.stat(a).st_ino, os.stat(b).st_ino, |
|
439 | 439 | "%r and %r do not reference the same indoes" %(a, b)) |
|
440 | 440 | |
|
441 | 441 | def assert_content_equal(self, a, b): |
|
442 | 442 | with open(a) as a_f: |
|
443 | 443 | with open(b) as b_f: |
|
444 | 444 | nt.assert_equal(a_f.read(), b_f.read()) |
|
445 | 445 | |
|
446 | 446 | @skip_win32 |
|
447 | 447 | def test_link_successful(self): |
|
448 | 448 | dst = self.dst("target") |
|
449 | 449 | path.link_or_copy(self.src, dst) |
|
450 | 450 | self.assert_inode_equal(self.src, dst) |
|
451 | 451 | |
|
452 | 452 | @skip_win32 |
|
453 | 453 | def test_link_into_dir(self): |
|
454 | 454 | dst = self.dst("some_dir") |
|
455 | 455 | os.mkdir(dst) |
|
456 | 456 | path.link_or_copy(self.src, dst) |
|
457 | 457 | expected_dst = self.dst("some_dir", os.path.basename(self.src)) |
|
458 | 458 | self.assert_inode_equal(self.src, expected_dst) |
|
459 | 459 | |
|
460 | 460 | @skip_win32 |
|
461 | 461 | def test_target_exists(self): |
|
462 | 462 | dst = self.dst("target") |
|
463 | 463 | open(dst, "w").close() |
|
464 | 464 | path.link_or_copy(self.src, dst) |
|
465 | 465 | self.assert_inode_equal(self.src, dst) |
|
466 | 466 | |
|
467 | 467 | @skip_win32 |
|
468 | 468 | def test_no_link(self): |
|
469 | 469 | real_link = os.link |
|
470 | 470 | try: |
|
471 | 471 | del os.link |
|
472 | 472 | dst = self.dst("target") |
|
473 | 473 | path.link_or_copy(self.src, dst) |
|
474 | 474 | self.assert_content_equal(self.src, dst) |
|
475 | 475 | self.assert_inode_not_equal(self.src, dst) |
|
476 | 476 | finally: |
|
477 | 477 | os.link = real_link |
|
478 | 478 | |
|
479 | 479 | @skip_if_not_win32 |
|
480 | 480 | def test_windows(self): |
|
481 | 481 | dst = self.dst("target") |
|
482 | 482 | path.link_or_copy(self.src, dst) |
|
483 | 483 | self.assert_content_equal(self.src, dst) |
|
484 | 484 | |
|
485 | 485 | def test_link_twice(self): |
|
486 | 486 | # Linking the same file twice shouldn't leave duplicates around. |
|
487 | 487 | # See https://github.com/ipython/ipython/issues/6450 |
|
488 | 488 | dst = self.dst('target') |
|
489 | 489 | path.link_or_copy(self.src, dst) |
|
490 | 490 | path.link_or_copy(self.src, dst) |
|
491 | 491 | self.assert_inode_equal(self.src, dst) |
|
492 | 492 | nt.assert_equal(sorted(os.listdir(self.tempdir.name)), ['src', 'target']) |
@@ -1,145 +1,144 b'' | |||
|
1 | 1 | # encoding: utf-8 |
|
2 | 2 | """ |
|
3 | 3 | Tests for platutils.py |
|
4 | 4 | """ |
|
5 | 5 | |
|
6 | 6 | #----------------------------------------------------------------------------- |
|
7 | 7 | # Copyright (C) 2008-2011 The IPython Development Team |
|
8 | 8 | # |
|
9 | 9 | # Distributed under the terms of the BSD License. The full license is in |
|
10 | 10 | # the file COPYING, distributed as part of this software. |
|
11 | 11 | #----------------------------------------------------------------------------- |
|
12 | 12 | |
|
13 | 13 | #----------------------------------------------------------------------------- |
|
14 | 14 | # Imports |
|
15 | 15 | #----------------------------------------------------------------------------- |
|
16 | 16 | |
|
17 | 17 | import sys |
|
18 | 18 | import os |
|
19 | from unittest import TestCase | |
|
20 | 19 | |
|
21 | 20 | import nose.tools as nt |
|
22 | 21 | |
|
23 | 22 | from IPython.utils.process import (find_cmd, FindCmdError, arg_split, |
|
24 | 23 | system, getoutput, getoutputerror, |
|
25 | 24 | get_output_error_code) |
|
26 | 25 | from IPython.testing import decorators as dec |
|
27 | 26 | from IPython.testing import tools as tt |
|
28 | 27 | |
|
29 | 28 | python = os.path.basename(sys.executable) |
|
30 | 29 | |
|
31 | 30 | #----------------------------------------------------------------------------- |
|
32 | 31 | # Tests |
|
33 | 32 | #----------------------------------------------------------------------------- |
|
34 | 33 | |
|
35 | 34 | |
|
36 | 35 | @dec.skip_win32 |
|
37 | 36 | def test_find_cmd_ls(): |
|
38 | 37 | """Make sure we can find the full path to ls.""" |
|
39 | 38 | path = find_cmd('ls') |
|
40 | 39 | nt.assert_true(path.endswith('ls')) |
|
41 | 40 | |
|
42 | 41 | |
|
43 | 42 | def has_pywin32(): |
|
44 | 43 | try: |
|
45 | 44 | import win32api |
|
46 | 45 | except ImportError: |
|
47 | 46 | return False |
|
48 | 47 | return True |
|
49 | 48 | |
|
50 | 49 | |
|
51 | 50 | @dec.onlyif(has_pywin32, "This test requires win32api to run") |
|
52 | 51 | def test_find_cmd_pythonw(): |
|
53 | 52 | """Try to find pythonw on Windows.""" |
|
54 | 53 | path = find_cmd('pythonw') |
|
55 | 54 | assert path.lower().endswith('pythonw.exe'), path |
|
56 | 55 | |
|
57 | 56 | |
|
58 | 57 | @dec.onlyif(lambda : sys.platform != 'win32' or has_pywin32(), |
|
59 | 58 | "This test runs on posix or in win32 with win32api installed") |
|
60 | 59 | def test_find_cmd_fail(): |
|
61 | 60 | """Make sure that FindCmdError is raised if we can't find the cmd.""" |
|
62 | 61 | nt.assert_raises(FindCmdError,find_cmd,'asdfasdf') |
|
63 | 62 | |
|
64 | 63 | |
|
65 | 64 | @dec.skip_win32 |
|
66 | 65 | def test_arg_split(): |
|
67 | 66 | """Ensure that argument lines are correctly split like in a shell.""" |
|
68 | 67 | tests = [['hi', ['hi']], |
|
69 | 68 | [u'hi', [u'hi']], |
|
70 | 69 | ['hello there', ['hello', 'there']], |
|
71 | 70 | # \u01ce == \N{LATIN SMALL LETTER A WITH CARON} |
|
72 | 71 | # Do not use \N because the tests crash with syntax error in |
|
73 | 72 | # some cases, for example windows python2.6. |
|
74 | 73 | [u'h\u01cello', [u'h\u01cello']], |
|
75 | 74 | ['something "with quotes"', ['something', '"with quotes"']], |
|
76 | 75 | ] |
|
77 | 76 | for argstr, argv in tests: |
|
78 | 77 | nt.assert_equal(arg_split(argstr), argv) |
|
79 | 78 | |
|
80 | 79 | @dec.skip_if_not_win32 |
|
81 | 80 | def test_arg_split_win32(): |
|
82 | 81 | """Ensure that argument lines are correctly split like in a shell.""" |
|
83 | 82 | tests = [['hi', ['hi']], |
|
84 | 83 | [u'hi', [u'hi']], |
|
85 | 84 | ['hello there', ['hello', 'there']], |
|
86 | 85 | [u'h\u01cello', [u'h\u01cello']], |
|
87 | 86 | ['something "with quotes"', ['something', 'with quotes']], |
|
88 | 87 | ] |
|
89 | 88 | for argstr, argv in tests: |
|
90 | 89 | nt.assert_equal(arg_split(argstr), argv) |
|
91 | 90 | |
|
92 | 91 | |
|
93 | 92 | class SubProcessTestCase(tt.TempFileMixin): |
|
94 | 93 | def setUp(self): |
|
95 | 94 | """Make a valid python temp file.""" |
|
96 | 95 | lines = [ "import sys", |
|
97 | 96 | "print('on stdout', end='', file=sys.stdout)", |
|
98 | 97 | "print('on stderr', end='', file=sys.stderr)", |
|
99 | 98 | "sys.stdout.flush()", |
|
100 | 99 | "sys.stderr.flush()"] |
|
101 | 100 | self.mktmp('\n'.join(lines)) |
|
102 | 101 | |
|
103 | 102 | def test_system(self): |
|
104 | 103 | status = system('%s "%s"' % (python, self.fname)) |
|
105 | 104 | self.assertEqual(status, 0) |
|
106 | 105 | |
|
107 | 106 | def test_system_quotes(self): |
|
108 | 107 | status = system('%s -c "import sys"' % python) |
|
109 | 108 | self.assertEqual(status, 0) |
|
110 | 109 | |
|
111 | 110 | def test_getoutput(self): |
|
112 | 111 | out = getoutput('%s "%s"' % (python, self.fname)) |
|
113 | 112 | # we can't rely on the order the line buffered streams are flushed |
|
114 | 113 | try: |
|
115 | 114 | self.assertEqual(out, 'on stderron stdout') |
|
116 | 115 | except AssertionError: |
|
117 | 116 | self.assertEqual(out, 'on stdouton stderr') |
|
118 | 117 | |
|
119 | 118 | def test_getoutput_quoted(self): |
|
120 | 119 | out = getoutput('%s -c "print (1)"' % python) |
|
121 | 120 | self.assertEqual(out.strip(), '1') |
|
122 | 121 | |
|
123 | 122 | #Invalid quoting on windows |
|
124 | 123 | @dec.skip_win32 |
|
125 | 124 | def test_getoutput_quoted2(self): |
|
126 | 125 | out = getoutput("%s -c 'print (1)'" % python) |
|
127 | 126 | self.assertEqual(out.strip(), '1') |
|
128 | 127 | out = getoutput("%s -c 'print (\"1\")'" % python) |
|
129 | 128 | self.assertEqual(out.strip(), '1') |
|
130 | 129 | |
|
131 | 130 | def test_getoutput_error(self): |
|
132 | 131 | out, err = getoutputerror('%s "%s"' % (python, self.fname)) |
|
133 | 132 | self.assertEqual(out, 'on stdout') |
|
134 | 133 | self.assertEqual(err, 'on stderr') |
|
135 | 134 | |
|
136 | 135 | def test_get_output_error_code(self): |
|
137 | 136 | quiet_exit = '%s -c "import sys; sys.exit(1)"' % python |
|
138 | 137 | out, err, code = get_output_error_code(quiet_exit) |
|
139 | 138 | self.assertEqual(out, '') |
|
140 | 139 | self.assertEqual(err, '') |
|
141 | 140 | self.assertEqual(code, 1) |
|
142 | 141 | out, err, code = get_output_error_code('%s "%s"' % (python, self.fname)) |
|
143 | 142 | self.assertEqual(out, 'on stdout') |
|
144 | 143 | self.assertEqual(err, 'on stderr') |
|
145 | 144 | self.assertEqual(code, 0) |
General Comments 0
You need to be logged in to leave comments.
Login now