##// END OF EJS Templates
Adapt to all sorts of drive names...
Mithil Poojary -
Show More
@@ -1,3878 +1,3880 b''
1 1 # -*- coding: utf-8 -*-
2 2 """Main IPython class."""
3 3
4 4 #-----------------------------------------------------------------------------
5 5 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de>
6 6 # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu>
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 import abc
15 15 import ast
16 16 import atexit
17 17 import builtins as builtin_mod
18 18 import functools
19 19 import inspect
20 20 import os
21 21 import re
22 22 import runpy
23 23 import sys
24 24 import tempfile
25 25 import traceback
26 26 import types
27 27 import subprocess
28 28 import warnings
29 29 from io import open as io_open
30 30
31 31 from pathlib import Path
32 32 from pickleshare import PickleShareDB
33 33
34 34 from traitlets.config.configurable import SingletonConfigurable
35 35 from traitlets.utils.importstring import import_item
36 36 from IPython.core import oinspect
37 37 from IPython.core import magic
38 38 from IPython.core import page
39 39 from IPython.core import prefilter
40 40 from IPython.core import ultratb
41 41 from IPython.core.alias import Alias, AliasManager
42 42 from IPython.core.autocall import ExitAutocall
43 43 from IPython.core.builtin_trap import BuiltinTrap
44 44 from IPython.core.events import EventManager, available_events
45 45 from IPython.core.compilerop import CachingCompiler, check_linecache_ipython
46 46 from IPython.core.debugger import Pdb
47 47 from IPython.core.display_trap import DisplayTrap
48 48 from IPython.core.displayhook import DisplayHook
49 49 from IPython.core.displaypub import DisplayPublisher
50 50 from IPython.core.error import InputRejected, UsageError
51 51 from IPython.core.extensions import ExtensionManager
52 52 from IPython.core.formatters import DisplayFormatter
53 53 from IPython.core.history import HistoryManager
54 54 from IPython.core.inputtransformer2 import ESC_MAGIC, ESC_MAGIC2
55 55 from IPython.core.logger import Logger
56 56 from IPython.core.macro import Macro
57 57 from IPython.core.payload import PayloadManager
58 58 from IPython.core.prefilter import PrefilterManager
59 59 from IPython.core.profiledir import ProfileDir
60 60 from IPython.core.usage import default_banner
61 61 from IPython.display import display
62 62 from IPython.testing.skipdoctest import skip_doctest
63 63 from IPython.utils import PyColorize
64 64 from IPython.utils import io
65 65 from IPython.utils import py3compat
66 66 from IPython.utils import openpy
67 67 from IPython.utils.decorators import undoc
68 68 from IPython.utils.io import ask_yes_no
69 69 from IPython.utils.ipstruct import Struct
70 70 from IPython.paths import get_ipython_dir
71 71 from IPython.utils.path import get_home_dir, get_py_filename, ensure_dir_exists
72 72 from IPython.utils.process import system, getoutput
73 73 from IPython.utils.strdispatch import StrDispatch
74 74 from IPython.utils.syspathcontext import prepended_to_syspath
75 75 from IPython.utils.text import format_screen, LSString, SList, DollarFormatter
76 76 from IPython.utils.tempdir import TemporaryDirectory
77 77 from traitlets import (
78 78 Integer, Bool, CaselessStrEnum, Enum, List, Dict, Unicode, Instance, Type,
79 79 observe, default, validate, Any
80 80 )
81 81 from warnings import warn
82 82 from logging import error
83 83 import IPython.core.hooks
84 84
85 85 from typing import List as ListType, Tuple, Optional
86 86 from ast import AST
87 87
88 88 # NoOpContext is deprecated, but ipykernel imports it from here.
89 89 # See https://github.com/ipython/ipykernel/issues/157
90 90 # (2016, let's try to remove than in IPython 8.0)
91 91 from IPython.utils.contexts import NoOpContext
92 92
93 93 try:
94 94 import docrepr.sphinxify as sphx
95 95
96 96 def sphinxify(doc):
97 97 with TemporaryDirectory() as dirname:
98 98 return {
99 99 'text/html': sphx.sphinxify(doc, dirname),
100 100 'text/plain': doc
101 101 }
102 102 except ImportError:
103 103 sphinxify = None
104 104
105 105
106 106 class ProvisionalWarning(DeprecationWarning):
107 107 """
108 108 Warning class for unstable features
109 109 """
110 110 pass
111 111
112 112 if sys.version_info > (3,8):
113 113 from ast import Module
114 114 else :
115 115 # mock the new API, ignore second argument
116 116 # see https://github.com/ipython/ipython/issues/11590
117 117 from ast import Module as OriginalModule
118 118 Module = lambda nodelist, type_ignores: OriginalModule(nodelist)
119 119
120 120 if sys.version_info > (3,6):
121 121 _assign_nodes = (ast.AugAssign, ast.AnnAssign, ast.Assign)
122 122 _single_targets_nodes = (ast.AugAssign, ast.AnnAssign)
123 123 else:
124 124 _assign_nodes = (ast.AugAssign, ast.Assign )
125 125 _single_targets_nodes = (ast.AugAssign, )
126 126
127 127 #-----------------------------------------------------------------------------
128 128 # Await Helpers
129 129 #-----------------------------------------------------------------------------
130 130
131 131 def removed_co_newlocals(function:types.FunctionType) -> types.FunctionType:
132 132 """Return a function that do not create a new local scope.
133 133
134 134 Given a function, create a clone of this function where the co_newlocal flag
135 135 has been removed, making this function code actually run in the sourounding
136 136 scope.
137 137
138 138 We need this in order to run asynchronous code in user level namespace.
139 139 """
140 140 from types import CodeType, FunctionType
141 141 CO_NEWLOCALS = 0x0002
142 142 code = function.__code__
143 143 new_co_flags = code.co_flags & ~CO_NEWLOCALS
144 144 if sys.version_info > (3, 8, 0, 'alpha', 3):
145 145 new_code = code.replace(co_flags=new_co_flags)
146 146 else:
147 147 new_code = CodeType(
148 148 code.co_argcount,
149 149 code.co_kwonlyargcount,
150 150 code.co_nlocals,
151 151 code.co_stacksize,
152 152 new_co_flags,
153 153 code.co_code,
154 154 code.co_consts,
155 155 code.co_names,
156 156 code.co_varnames,
157 157 code.co_filename,
158 158 code.co_name,
159 159 code.co_firstlineno,
160 160 code.co_lnotab,
161 161 code.co_freevars,
162 162 code.co_cellvars
163 163 )
164 164 return FunctionType(new_code, globals(), function.__name__, function.__defaults__)
165 165
166 166
167 167 # we still need to run things using the asyncio eventloop, but there is no
168 168 # async integration
169 169 from .async_helpers import (_asyncio_runner, _asyncify, _pseudo_sync_runner)
170 170 from .async_helpers import _curio_runner, _trio_runner, _should_be_async
171 171
172 172
173 173 def _ast_asyncify(cell:str, wrapper_name:str) -> ast.Module:
174 174 """
175 175 Parse a cell with top-level await and modify the AST to be able to run it later.
176 176
177 177 Parameters
178 178 ----------
179 179 cell: str
180 180 The code cell to asyncronify
181 181 wrapper_name: str
182 182 The name of the function to be used to wrap the passed `cell`. It is
183 183 advised to **not** use a python identifier in order to not pollute the
184 184 global namespace in which the function will be ran.
185 185
186 186 Returns
187 187 -------
188 188 ModuleType:
189 189 A module object AST containing **one** function named `wrapper_name`.
190 190
191 191 The given code is wrapped in a async-def function, parsed into an AST, and
192 192 the resulting function definition AST is modified to return the last
193 193 expression.
194 194
195 195 The last expression or await node is moved into a return statement at the
196 196 end of the function, and removed from its original location. If the last
197 197 node is not Expr or Await nothing is done.
198 198
199 199 The function `__code__` will need to be later modified (by
200 200 ``removed_co_newlocals``) in a subsequent step to not create new `locals()`
201 201 meaning that the local and global scope are the same, ie as if the body of
202 202 the function was at module level.
203 203
204 204 Lastly a call to `locals()` is made just before the last expression of the
205 205 function, or just after the last assignment or statement to make sure the
206 206 global dict is updated as python function work with a local fast cache which
207 207 is updated only on `local()` calls.
208 208 """
209 209
210 210 from ast import Expr, Await, Return
211 211 if sys.version_info >= (3,8):
212 212 return ast.parse(cell)
213 213 tree = ast.parse(_asyncify(cell))
214 214
215 215 function_def = tree.body[0]
216 216 function_def.name = wrapper_name
217 217 try_block = function_def.body[0]
218 218 lastexpr = try_block.body[-1]
219 219 if isinstance(lastexpr, (Expr, Await)):
220 220 try_block.body[-1] = Return(lastexpr.value)
221 221 ast.fix_missing_locations(tree)
222 222 return tree
223 223 #-----------------------------------------------------------------------------
224 224 # Globals
225 225 #-----------------------------------------------------------------------------
226 226
227 227 # compiled regexps for autoindent management
228 228 dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass')
229 229
230 230 #-----------------------------------------------------------------------------
231 231 # Utilities
232 232 #-----------------------------------------------------------------------------
233 233
234 234 @undoc
235 235 def softspace(file, newvalue):
236 236 """Copied from code.py, to remove the dependency"""
237 237
238 238 oldvalue = 0
239 239 try:
240 240 oldvalue = file.softspace
241 241 except AttributeError:
242 242 pass
243 243 try:
244 244 file.softspace = newvalue
245 245 except (AttributeError, TypeError):
246 246 # "attribute-less object" or "read-only attributes"
247 247 pass
248 248 return oldvalue
249 249
250 250 @undoc
251 251 def no_op(*a, **kw):
252 252 pass
253 253
254 254
255 255 class SpaceInInput(Exception): pass
256 256
257 257
258 258 def get_default_colors():
259 259 "DEPRECATED"
260 260 warn('get_default_color is deprecated since IPython 5.0, and returns `Neutral` on all platforms.',
261 261 DeprecationWarning, stacklevel=2)
262 262 return 'Neutral'
263 263
264 264
265 265 class SeparateUnicode(Unicode):
266 266 r"""A Unicode subclass to validate separate_in, separate_out, etc.
267 267
268 268 This is a Unicode based trait that converts '0'->'' and ``'\\n'->'\n'``.
269 269 """
270 270
271 271 def validate(self, obj, value):
272 272 if value == '0': value = ''
273 273 value = value.replace('\\n','\n')
274 274 return super(SeparateUnicode, self).validate(obj, value)
275 275
276 276
277 277 @undoc
278 278 class DummyMod(object):
279 279 """A dummy module used for IPython's interactive module when
280 280 a namespace must be assigned to the module's __dict__."""
281 281 __spec__ = None
282 282
283 283
284 284 class ExecutionInfo(object):
285 285 """The arguments used for a call to :meth:`InteractiveShell.run_cell`
286 286
287 287 Stores information about what is going to happen.
288 288 """
289 289 raw_cell = None
290 290 store_history = False
291 291 silent = False
292 292 shell_futures = True
293 293
294 294 def __init__(self, raw_cell, store_history, silent, shell_futures):
295 295 self.raw_cell = raw_cell
296 296 self.store_history = store_history
297 297 self.silent = silent
298 298 self.shell_futures = shell_futures
299 299
300 300 def __repr__(self):
301 301 name = self.__class__.__qualname__
302 302 raw_cell = ((self.raw_cell[:50] + '..')
303 303 if len(self.raw_cell) > 50 else self.raw_cell)
304 304 return '<%s object at %x, raw_cell="%s" store_history=%s silent=%s shell_futures=%s>' %\
305 305 (name, id(self), raw_cell, self.store_history, self.silent, self.shell_futures)
306 306
307 307
308 308 class ExecutionResult(object):
309 309 """The result of a call to :meth:`InteractiveShell.run_cell`
310 310
311 311 Stores information about what took place.
312 312 """
313 313 execution_count = None
314 314 error_before_exec = None
315 315 error_in_exec = None
316 316 info = None
317 317 result = None
318 318
319 319 def __init__(self, info):
320 320 self.info = info
321 321
322 322 @property
323 323 def success(self):
324 324 return (self.error_before_exec is None) and (self.error_in_exec is None)
325 325
326 326 def raise_error(self):
327 327 """Reraises error if `success` is `False`, otherwise does nothing"""
328 328 if self.error_before_exec is not None:
329 329 raise self.error_before_exec
330 330 if self.error_in_exec is not None:
331 331 raise self.error_in_exec
332 332
333 333 def __repr__(self):
334 334 name = self.__class__.__qualname__
335 335 return '<%s object at %x, execution_count=%s error_before_exec=%s error_in_exec=%s info=%s result=%s>' %\
336 336 (name, id(self), self.execution_count, self.error_before_exec, self.error_in_exec, repr(self.info), repr(self.result))
337 337
338 338
339 339 class InteractiveShell(SingletonConfigurable):
340 340 """An enhanced, interactive shell for Python."""
341 341
342 342 _instance = None
343 343
344 344 ast_transformers = List([], help=
345 345 """
346 346 A list of ast.NodeTransformer subclass instances, which will be applied
347 347 to user input before code is run.
348 348 """
349 349 ).tag(config=True)
350 350
351 351 autocall = Enum((0,1,2), default_value=0, help=
352 352 """
353 353 Make IPython automatically call any callable object even if you didn't
354 354 type explicit parentheses. For example, 'str 43' becomes 'str(43)'
355 355 automatically. The value can be '0' to disable the feature, '1' for
356 356 'smart' autocall, where it is not applied if there are no more
357 357 arguments on the line, and '2' for 'full' autocall, where all callable
358 358 objects are automatically called (even if no arguments are present).
359 359 """
360 360 ).tag(config=True)
361 361
362 362 autoindent = Bool(True, help=
363 363 """
364 364 Autoindent IPython code entered interactively.
365 365 """
366 366 ).tag(config=True)
367 367
368 368 autoawait = Bool(True, help=
369 369 """
370 370 Automatically run await statement in the top level repl.
371 371 """
372 372 ).tag(config=True)
373 373
374 374 loop_runner_map ={
375 375 'asyncio':(_asyncio_runner, True),
376 376 'curio':(_curio_runner, True),
377 377 'trio':(_trio_runner, True),
378 378 'sync': (_pseudo_sync_runner, False)
379 379 }
380 380
381 381 loop_runner = Any(default_value="IPython.core.interactiveshell._asyncio_runner",
382 382 allow_none=True,
383 383 help="""Select the loop runner that will be used to execute top-level asynchronous code"""
384 384 ).tag(config=True)
385 385
386 386 @default('loop_runner')
387 387 def _default_loop_runner(self):
388 388 return import_item("IPython.core.interactiveshell._asyncio_runner")
389 389
390 390 @validate('loop_runner')
391 391 def _import_runner(self, proposal):
392 392 if isinstance(proposal.value, str):
393 393 if proposal.value in self.loop_runner_map:
394 394 runner, autoawait = self.loop_runner_map[proposal.value]
395 395 self.autoawait = autoawait
396 396 return runner
397 397 runner = import_item(proposal.value)
398 398 if not callable(runner):
399 399 raise ValueError('loop_runner must be callable')
400 400 return runner
401 401 if not callable(proposal.value):
402 402 raise ValueError('loop_runner must be callable')
403 403 return proposal.value
404 404
405 405 automagic = Bool(True, help=
406 406 """
407 407 Enable magic commands to be called without the leading %.
408 408 """
409 409 ).tag(config=True)
410 410
411 411 banner1 = Unicode(default_banner,
412 412 help="""The part of the banner to be printed before the profile"""
413 413 ).tag(config=True)
414 414 banner2 = Unicode('',
415 415 help="""The part of the banner to be printed after the profile"""
416 416 ).tag(config=True)
417 417
418 418 cache_size = Integer(1000, help=
419 419 """
420 420 Set the size of the output cache. The default is 1000, you can
421 421 change it permanently in your config file. Setting it to 0 completely
422 422 disables the caching system, and the minimum value accepted is 3 (if
423 423 you provide a value less than 3, it is reset to 0 and a warning is
424 424 issued). This limit is defined because otherwise you'll spend more
425 425 time re-flushing a too small cache than working
426 426 """
427 427 ).tag(config=True)
428 428 color_info = Bool(True, help=
429 429 """
430 430 Use colors for displaying information about objects. Because this
431 431 information is passed through a pager (like 'less'), and some pagers
432 432 get confused with color codes, this capability can be turned off.
433 433 """
434 434 ).tag(config=True)
435 435 colors = CaselessStrEnum(('Neutral', 'NoColor','LightBG','Linux'),
436 436 default_value='Neutral',
437 437 help="Set the color scheme (NoColor, Neutral, Linux, or LightBG)."
438 438 ).tag(config=True)
439 439 debug = Bool(False).tag(config=True)
440 440 disable_failing_post_execute = Bool(False,
441 441 help="Don't call post-execute functions that have failed in the past."
442 442 ).tag(config=True)
443 443 display_formatter = Instance(DisplayFormatter, allow_none=True)
444 444 displayhook_class = Type(DisplayHook)
445 445 display_pub_class = Type(DisplayPublisher)
446 446 compiler_class = Type(CachingCompiler)
447 447
448 448 sphinxify_docstring = Bool(False, help=
449 449 """
450 450 Enables rich html representation of docstrings. (This requires the
451 451 docrepr module).
452 452 """).tag(config=True)
453 453
454 454 @observe("sphinxify_docstring")
455 455 def _sphinxify_docstring_changed(self, change):
456 456 if change['new']:
457 457 warn("`sphinxify_docstring` is provisional since IPython 5.0 and might change in future versions." , ProvisionalWarning)
458 458
459 459 enable_html_pager = Bool(False, help=
460 460 """
461 461 (Provisional API) enables html representation in mime bundles sent
462 462 to pagers.
463 463 """).tag(config=True)
464 464
465 465 @observe("enable_html_pager")
466 466 def _enable_html_pager_changed(self, change):
467 467 if change['new']:
468 468 warn("`enable_html_pager` is provisional since IPython 5.0 and might change in future versions.", ProvisionalWarning)
469 469
470 470 data_pub_class = None
471 471
472 472 exit_now = Bool(False)
473 473 exiter = Instance(ExitAutocall)
474 474 @default('exiter')
475 475 def _exiter_default(self):
476 476 return ExitAutocall(self)
477 477 # Monotonically increasing execution counter
478 478 execution_count = Integer(1)
479 479 filename = Unicode("<ipython console>")
480 480 ipython_dir= Unicode('').tag(config=True) # Set to get_ipython_dir() in __init__
481 481
482 482 # Used to transform cells before running them, and check whether code is complete
483 483 input_transformer_manager = Instance('IPython.core.inputtransformer2.TransformerManager',
484 484 ())
485 485
486 486 @property
487 487 def input_transformers_cleanup(self):
488 488 return self.input_transformer_manager.cleanup_transforms
489 489
490 490 input_transformers_post = List([],
491 491 help="A list of string input transformers, to be applied after IPython's "
492 492 "own input transformations."
493 493 )
494 494
495 495 @property
496 496 def input_splitter(self):
497 497 """Make this available for backward compatibility (pre-7.0 release) with existing code.
498 498
499 499 For example, ipykernel ipykernel currently uses
500 500 `shell.input_splitter.check_complete`
501 501 """
502 502 from warnings import warn
503 503 warn("`input_splitter` is deprecated since IPython 7.0, prefer `input_transformer_manager`.",
504 504 DeprecationWarning, stacklevel=2
505 505 )
506 506 return self.input_transformer_manager
507 507
508 508 logstart = Bool(False, help=
509 509 """
510 510 Start logging to the default log file in overwrite mode.
511 511 Use `logappend` to specify a log file to **append** logs to.
512 512 """
513 513 ).tag(config=True)
514 514 logfile = Unicode('', help=
515 515 """
516 516 The name of the logfile to use.
517 517 """
518 518 ).tag(config=True)
519 519 logappend = Unicode('', help=
520 520 """
521 521 Start logging to the given file in append mode.
522 522 Use `logfile` to specify a log file to **overwrite** logs to.
523 523 """
524 524 ).tag(config=True)
525 525 object_info_string_level = Enum((0,1,2), default_value=0,
526 526 ).tag(config=True)
527 527 pdb = Bool(False, help=
528 528 """
529 529 Automatically call the pdb debugger after every exception.
530 530 """
531 531 ).tag(config=True)
532 532 display_page = Bool(False,
533 533 help="""If True, anything that would be passed to the pager
534 534 will be displayed as regular output instead."""
535 535 ).tag(config=True)
536 536
537 537 # deprecated prompt traits:
538 538
539 539 prompt_in1 = Unicode('In [\\#]: ',
540 540 help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly."
541 541 ).tag(config=True)
542 542 prompt_in2 = Unicode(' .\\D.: ',
543 543 help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly."
544 544 ).tag(config=True)
545 545 prompt_out = Unicode('Out[\\#]: ',
546 546 help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly."
547 547 ).tag(config=True)
548 548 prompts_pad_left = Bool(True,
549 549 help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly."
550 550 ).tag(config=True)
551 551
552 552 @observe('prompt_in1', 'prompt_in2', 'prompt_out', 'prompt_pad_left')
553 553 def _prompt_trait_changed(self, change):
554 554 name = change['name']
555 555 warn("InteractiveShell.{name} is deprecated since IPython 4.0"
556 556 " and ignored since 5.0, set TerminalInteractiveShell.prompts"
557 557 " object directly.".format(name=name))
558 558
559 559 # protect against weird cases where self.config may not exist:
560 560
561 561 show_rewritten_input = Bool(True,
562 562 help="Show rewritten input, e.g. for autocall."
563 563 ).tag(config=True)
564 564
565 565 quiet = Bool(False).tag(config=True)
566 566
567 567 history_length = Integer(10000,
568 568 help='Total length of command history'
569 569 ).tag(config=True)
570 570
571 571 history_load_length = Integer(1000, help=
572 572 """
573 573 The number of saved history entries to be loaded
574 574 into the history buffer at startup.
575 575 """
576 576 ).tag(config=True)
577 577
578 578 ast_node_interactivity = Enum(['all', 'last', 'last_expr', 'none', 'last_expr_or_assign'],
579 579 default_value='last_expr',
580 580 help="""
581 581 'all', 'last', 'last_expr' or 'none', 'last_expr_or_assign' specifying
582 582 which nodes should be run interactively (displaying output from expressions).
583 583 """
584 584 ).tag(config=True)
585 585
586 586 # TODO: this part of prompt management should be moved to the frontends.
587 587 # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n'
588 588 separate_in = SeparateUnicode('\n').tag(config=True)
589 589 separate_out = SeparateUnicode('').tag(config=True)
590 590 separate_out2 = SeparateUnicode('').tag(config=True)
591 591 wildcards_case_sensitive = Bool(True).tag(config=True)
592 592 xmode = CaselessStrEnum(('Context', 'Plain', 'Verbose', 'Minimal'),
593 593 default_value='Context',
594 594 help="Switch modes for the IPython exception handlers."
595 595 ).tag(config=True)
596 596
597 597 # Subcomponents of InteractiveShell
598 598 alias_manager = Instance('IPython.core.alias.AliasManager', allow_none=True)
599 599 prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager', allow_none=True)
600 600 builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap', allow_none=True)
601 601 display_trap = Instance('IPython.core.display_trap.DisplayTrap', allow_none=True)
602 602 extension_manager = Instance('IPython.core.extensions.ExtensionManager', allow_none=True)
603 603 payload_manager = Instance('IPython.core.payload.PayloadManager', allow_none=True)
604 604 history_manager = Instance('IPython.core.history.HistoryAccessorBase', allow_none=True)
605 605 magics_manager = Instance('IPython.core.magic.MagicsManager', allow_none=True)
606 606
607 607 profile_dir = Instance('IPython.core.application.ProfileDir', allow_none=True)
608 608 @property
609 609 def profile(self):
610 610 if self.profile_dir is not None:
611 611 name = os.path.basename(self.profile_dir.location)
612 612 return name.replace('profile_','')
613 613
614 614
615 615 # Private interface
616 616 _post_execute = Dict()
617 617
618 618 # Tracks any GUI loop loaded for pylab
619 619 pylab_gui_select = None
620 620
621 621 last_execution_succeeded = Bool(True, help='Did last executed command succeeded')
622 622
623 623 last_execution_result = Instance('IPython.core.interactiveshell.ExecutionResult', help='Result of executing the last command', allow_none=True)
624 624
625 625 def __init__(self, ipython_dir=None, profile_dir=None,
626 626 user_module=None, user_ns=None,
627 627 custom_exceptions=((), None), **kwargs):
628 628
629 629 # This is where traits with a config_key argument are updated
630 630 # from the values on config.
631 631 super(InteractiveShell, self).__init__(**kwargs)
632 632 if 'PromptManager' in self.config:
633 633 warn('As of IPython 5.0 `PromptManager` config will have no effect'
634 634 ' and has been replaced by TerminalInteractiveShell.prompts_class')
635 635 self.configurables = [self]
636 636
637 637 # These are relatively independent and stateless
638 638 self.init_ipython_dir(ipython_dir)
639 639 self.init_profile_dir(profile_dir)
640 640 self.init_instance_attrs()
641 641 self.init_environment()
642 642
643 643 # Check if we're in a virtualenv, and set up sys.path.
644 644 self.init_virtualenv()
645 645
646 646 # Create namespaces (user_ns, user_global_ns, etc.)
647 647 self.init_create_namespaces(user_module, user_ns)
648 648 # This has to be done after init_create_namespaces because it uses
649 649 # something in self.user_ns, but before init_sys_modules, which
650 650 # is the first thing to modify sys.
651 651 # TODO: When we override sys.stdout and sys.stderr before this class
652 652 # is created, we are saving the overridden ones here. Not sure if this
653 653 # is what we want to do.
654 654 self.save_sys_module_state()
655 655 self.init_sys_modules()
656 656
657 657 # While we're trying to have each part of the code directly access what
658 658 # it needs without keeping redundant references to objects, we have too
659 659 # much legacy code that expects ip.db to exist.
660 660 self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db'))
661 661
662 662 self.init_history()
663 663 self.init_encoding()
664 664 self.init_prefilter()
665 665
666 666 self.init_syntax_highlighting()
667 667 self.init_hooks()
668 668 self.init_events()
669 669 self.init_pushd_popd_magic()
670 670 self.init_user_ns()
671 671 self.init_logger()
672 672 self.init_builtins()
673 673
674 674 # The following was in post_config_initialization
675 675 self.init_inspector()
676 676 self.raw_input_original = input
677 677 self.init_completer()
678 678 # TODO: init_io() needs to happen before init_traceback handlers
679 679 # because the traceback handlers hardcode the stdout/stderr streams.
680 680 # This logic in in debugger.Pdb and should eventually be changed.
681 681 self.init_io()
682 682 self.init_traceback_handlers(custom_exceptions)
683 683 self.init_prompts()
684 684 self.init_display_formatter()
685 685 self.init_display_pub()
686 686 self.init_data_pub()
687 687 self.init_displayhook()
688 688 self.init_magics()
689 689 self.init_alias()
690 690 self.init_logstart()
691 691 self.init_pdb()
692 692 self.init_extension_manager()
693 693 self.init_payload()
694 694 self.init_deprecation_warnings()
695 695 self.hooks.late_startup_hook()
696 696 self.events.trigger('shell_initialized', self)
697 697 atexit.register(self.atexit_operations)
698 698
699 699 # The trio runner is used for running Trio in the foreground thread. It
700 700 # is different from `_trio_runner(async_fn)` in `async_helpers.py`
701 701 # which calls `trio.run()` for every cell. This runner runs all cells
702 702 # inside a single Trio event loop. If used, it is set from
703 703 # `ipykernel.kernelapp`.
704 704 self.trio_runner = None
705 705
706 706 def get_ipython(self):
707 707 """Return the currently running IPython instance."""
708 708 return self
709 709
710 710 #-------------------------------------------------------------------------
711 711 # Trait changed handlers
712 712 #-------------------------------------------------------------------------
713 713 @observe('ipython_dir')
714 714 def _ipython_dir_changed(self, change):
715 715 ensure_dir_exists(change['new'])
716 716
717 717 def set_autoindent(self,value=None):
718 718 """Set the autoindent flag.
719 719
720 720 If called with no arguments, it acts as a toggle."""
721 721 if value is None:
722 722 self.autoindent = not self.autoindent
723 723 else:
724 724 self.autoindent = value
725 725
726 726 def set_trio_runner(self, tr):
727 727 self.trio_runner = tr
728 728
729 729 #-------------------------------------------------------------------------
730 730 # init_* methods called by __init__
731 731 #-------------------------------------------------------------------------
732 732
733 733 def init_ipython_dir(self, ipython_dir):
734 734 if ipython_dir is not None:
735 735 self.ipython_dir = ipython_dir
736 736 return
737 737
738 738 self.ipython_dir = get_ipython_dir()
739 739
740 740 def init_profile_dir(self, profile_dir):
741 741 if profile_dir is not None:
742 742 self.profile_dir = profile_dir
743 743 return
744 744 self.profile_dir = ProfileDir.create_profile_dir_by_name(
745 745 self.ipython_dir, "default"
746 746 )
747 747
748 748 def init_instance_attrs(self):
749 749 self.more = False
750 750
751 751 # command compiler
752 752 self.compile = self.compiler_class()
753 753
754 754 # Make an empty namespace, which extension writers can rely on both
755 755 # existing and NEVER being used by ipython itself. This gives them a
756 756 # convenient location for storing additional information and state
757 757 # their extensions may require, without fear of collisions with other
758 758 # ipython names that may develop later.
759 759 self.meta = Struct()
760 760
761 761 # Temporary files used for various purposes. Deleted at exit.
762 762 # The files here are stored with Path from Pathlib
763 763 self.tempfiles = []
764 764 self.tempdirs = []
765 765
766 766 # keep track of where we started running (mainly for crash post-mortem)
767 767 # This is not being used anywhere currently.
768 768 self.starting_dir = os.getcwd()
769 769
770 770 # Indentation management
771 771 self.indent_current_nsp = 0
772 772
773 773 # Dict to track post-execution functions that have been registered
774 774 self._post_execute = {}
775 775
776 776 def init_environment(self):
777 777 """Any changes we need to make to the user's environment."""
778 778 pass
779 779
780 780 def init_encoding(self):
781 781 # Get system encoding at startup time. Certain terminals (like Emacs
782 782 # under Win32 have it set to None, and we need to have a known valid
783 783 # encoding to use in the raw_input() method
784 784 try:
785 785 self.stdin_encoding = sys.stdin.encoding or 'ascii'
786 786 except AttributeError:
787 787 self.stdin_encoding = 'ascii'
788 788
789 789
790 790 @observe('colors')
791 791 def init_syntax_highlighting(self, changes=None):
792 792 # Python source parser/formatter for syntax highlighting
793 793 pyformat = PyColorize.Parser(style=self.colors, parent=self).format
794 794 self.pycolorize = lambda src: pyformat(src,'str')
795 795
796 796 def refresh_style(self):
797 797 # No-op here, used in subclass
798 798 pass
799 799
800 800 def init_pushd_popd_magic(self):
801 801 # for pushd/popd management
802 802 self.home_dir = get_home_dir()
803 803
804 804 self.dir_stack = []
805 805
806 806 def init_logger(self):
807 807 self.logger = Logger(self.home_dir, logfname='ipython_log.py',
808 808 logmode='rotate')
809 809
810 810 def init_logstart(self):
811 811 """Initialize logging in case it was requested at the command line.
812 812 """
813 813 if self.logappend:
814 814 self.magic('logstart %s append' % self.logappend)
815 815 elif self.logfile:
816 816 self.magic('logstart %s' % self.logfile)
817 817 elif self.logstart:
818 818 self.magic('logstart')
819 819
820 820 def init_deprecation_warnings(self):
821 821 """
822 822 register default filter for deprecation warning.
823 823
824 824 This will allow deprecation warning of function used interactively to show
825 825 warning to users, and still hide deprecation warning from libraries import.
826 826 """
827 827 if sys.version_info < (3,7):
828 828 warnings.filterwarnings("default", category=DeprecationWarning, module=self.user_ns.get("__name__"))
829 829
830 830
831 831 def init_builtins(self):
832 832 # A single, static flag that we set to True. Its presence indicates
833 833 # that an IPython shell has been created, and we make no attempts at
834 834 # removing on exit or representing the existence of more than one
835 835 # IPython at a time.
836 836 builtin_mod.__dict__['__IPYTHON__'] = True
837 837 builtin_mod.__dict__['display'] = display
838 838
839 839 self.builtin_trap = BuiltinTrap(shell=self)
840 840
841 841 @observe('colors')
842 842 def init_inspector(self, changes=None):
843 843 # Object inspector
844 844 self.inspector = oinspect.Inspector(oinspect.InspectColors,
845 845 PyColorize.ANSICodeColors,
846 846 self.colors,
847 847 self.object_info_string_level)
848 848
849 849 def init_io(self):
850 850 # This will just use sys.stdout and sys.stderr. If you want to
851 851 # override sys.stdout and sys.stderr themselves, you need to do that
852 852 # *before* instantiating this class, because io holds onto
853 853 # references to the underlying streams.
854 854 # io.std* are deprecated, but don't show our own deprecation warnings
855 855 # during initialization of the deprecated API.
856 856 with warnings.catch_warnings():
857 857 warnings.simplefilter('ignore', DeprecationWarning)
858 858 io.stdout = io.IOStream(sys.stdout)
859 859 io.stderr = io.IOStream(sys.stderr)
860 860
861 861 def init_prompts(self):
862 862 # Set system prompts, so that scripts can decide if they are running
863 863 # interactively.
864 864 sys.ps1 = 'In : '
865 865 sys.ps2 = '...: '
866 866 sys.ps3 = 'Out: '
867 867
868 868 def init_display_formatter(self):
869 869 self.display_formatter = DisplayFormatter(parent=self)
870 870 self.configurables.append(self.display_formatter)
871 871
872 872 def init_display_pub(self):
873 873 self.display_pub = self.display_pub_class(parent=self, shell=self)
874 874 self.configurables.append(self.display_pub)
875 875
876 876 def init_data_pub(self):
877 877 if not self.data_pub_class:
878 878 self.data_pub = None
879 879 return
880 880 self.data_pub = self.data_pub_class(parent=self)
881 881 self.configurables.append(self.data_pub)
882 882
883 883 def init_displayhook(self):
884 884 # Initialize displayhook, set in/out prompts and printing system
885 885 self.displayhook = self.displayhook_class(
886 886 parent=self,
887 887 shell=self,
888 888 cache_size=self.cache_size,
889 889 )
890 890 self.configurables.append(self.displayhook)
891 891 # This is a context manager that installs/revmoes the displayhook at
892 892 # the appropriate time.
893 893 self.display_trap = DisplayTrap(hook=self.displayhook)
894 894
895 895 def init_virtualenv(self):
896 896 """Add the current virtualenv to sys.path so the user can import modules from it.
897 897 This isn't perfect: it doesn't use the Python interpreter with which the
898 898 virtualenv was built, and it ignores the --no-site-packages option. A
899 899 warning will appear suggesting the user installs IPython in the
900 900 virtualenv, but for many cases, it probably works well enough.
901 901
902 902 Adapted from code snippets online.
903 903
904 904 http://blog.ufsoft.org/2009/1/29/ipython-and-virtualenv
905 905 """
906 906 if 'VIRTUAL_ENV' not in os.environ:
907 907 # Not in a virtualenv
908 908 return
909 909 elif os.environ["VIRTUAL_ENV"] == "":
910 910 warn("Virtual env path set to '', please check if this is intended.")
911 911 return
912 912
913 913 p = Path(sys.executable)
914 914 p_venv = Path(os.environ["VIRTUAL_ENV"])
915 915
916 916 # fallback venv detection:
917 917 # stdlib venv may symlink sys.executable, so we can't use realpath.
918 918 # but others can symlink *to* the venv Python, so we can't just use sys.executable.
919 919 # So we just check every item in the symlink tree (generally <= 3)
920 920 paths = [p]
921 921 while p.is_symlink():
922 922 p = Path(os.readlink(p))
923 923 paths.append(p.resolve())
924 924
925 925 # In Cygwin paths like "c:\..." and '\cygdrive\c\...' are possible
926 926 if str(p_venv).startswith("\\cygdrive"):
927 p_venv = "C:" / Path(str(p_venv)[11:])
927 p_venv = Path(str(p_venv))
928 drive_name = p_venv.parts[2]
929 p_venv = (drive_name + ":/") / Path(*p_venv.parts[3:])
928 930
929 931 if any(p_venv == p.parents[1] for p in paths):
930 932 # Our exe is inside or has access to the virtualenv, don't need to do anything.
931 933 return
932 934
933 935 if sys.platform == "win32":
934 936 virtual_env = Path(os.environ["VIRTUAL_ENV"], "Lib", "site-packages")
935 937 else:
936 938 virtual_env_path = Path(
937 939 os.environ["VIRTUAL_ENV"], "lib", "python{}.{}", "site-packages"
938 940 )
939 941 p_ver = sys.version_info[:2]
940 942
941 943 # Predict version from py[thon]-x.x in the $VIRTUAL_ENV
942 944 re_m = re.search(r"\bpy(?:thon)?([23])\.(\d+)\b", os.environ["VIRTUAL_ENV"])
943 945 if re_m:
944 946 predicted_path = Path(str(virtual_env_path).format(*re_m.groups()))
945 947 if predicted_path.exists():
946 948 p_ver = re_m.groups()
947 949
948 950 virtual_env = str(virtual_env_path).format(*p_ver)
949 951
950 952 warn(
951 953 "Attempting to work in a virtualenv. If you encounter problems, "
952 954 "please install IPython inside the virtualenv."
953 955 )
954 956 import site
955 957 sys.path.insert(0, virtual_env)
956 958 site.addsitedir(virtual_env)
957 959
958 960 #-------------------------------------------------------------------------
959 961 # Things related to injections into the sys module
960 962 #-------------------------------------------------------------------------
961 963
962 964 def save_sys_module_state(self):
963 965 """Save the state of hooks in the sys module.
964 966
965 967 This has to be called after self.user_module is created.
966 968 """
967 969 self._orig_sys_module_state = {'stdin': sys.stdin,
968 970 'stdout': sys.stdout,
969 971 'stderr': sys.stderr,
970 972 'excepthook': sys.excepthook}
971 973 self._orig_sys_modules_main_name = self.user_module.__name__
972 974 self._orig_sys_modules_main_mod = sys.modules.get(self.user_module.__name__)
973 975
974 976 def restore_sys_module_state(self):
975 977 """Restore the state of the sys module."""
976 978 try:
977 979 for k, v in self._orig_sys_module_state.items():
978 980 setattr(sys, k, v)
979 981 except AttributeError:
980 982 pass
981 983 # Reset what what done in self.init_sys_modules
982 984 if self._orig_sys_modules_main_mod is not None:
983 985 sys.modules[self._orig_sys_modules_main_name] = self._orig_sys_modules_main_mod
984 986
985 987 #-------------------------------------------------------------------------
986 988 # Things related to the banner
987 989 #-------------------------------------------------------------------------
988 990
989 991 @property
990 992 def banner(self):
991 993 banner = self.banner1
992 994 if self.profile and self.profile != 'default':
993 995 banner += '\nIPython profile: %s\n' % self.profile
994 996 if self.banner2:
995 997 banner += '\n' + self.banner2
996 998 return banner
997 999
998 1000 def show_banner(self, banner=None):
999 1001 if banner is None:
1000 1002 banner = self.banner
1001 1003 sys.stdout.write(banner)
1002 1004
1003 1005 #-------------------------------------------------------------------------
1004 1006 # Things related to hooks
1005 1007 #-------------------------------------------------------------------------
1006 1008
1007 1009 def init_hooks(self):
1008 1010 # hooks holds pointers used for user-side customizations
1009 1011 self.hooks = Struct()
1010 1012
1011 1013 self.strdispatchers = {}
1012 1014
1013 1015 # Set all default hooks, defined in the IPython.hooks module.
1014 1016 hooks = IPython.core.hooks
1015 1017 for hook_name in hooks.__all__:
1016 1018 # default hooks have priority 100, i.e. low; user hooks should have
1017 1019 # 0-100 priority
1018 1020 self.set_hook(hook_name,getattr(hooks,hook_name), 100, _warn_deprecated=False)
1019 1021
1020 1022 if self.display_page:
1021 1023 self.set_hook('show_in_pager', page.as_hook(page.display_page), 90)
1022 1024
1023 1025 def set_hook(self,name,hook, priority=50, str_key=None, re_key=None,
1024 1026 _warn_deprecated=True):
1025 1027 """set_hook(name,hook) -> sets an internal IPython hook.
1026 1028
1027 1029 IPython exposes some of its internal API as user-modifiable hooks. By
1028 1030 adding your function to one of these hooks, you can modify IPython's
1029 1031 behavior to call at runtime your own routines."""
1030 1032
1031 1033 # At some point in the future, this should validate the hook before it
1032 1034 # accepts it. Probably at least check that the hook takes the number
1033 1035 # of args it's supposed to.
1034 1036
1035 1037 f = types.MethodType(hook,self)
1036 1038
1037 1039 # check if the hook is for strdispatcher first
1038 1040 if str_key is not None:
1039 1041 sdp = self.strdispatchers.get(name, StrDispatch())
1040 1042 sdp.add_s(str_key, f, priority )
1041 1043 self.strdispatchers[name] = sdp
1042 1044 return
1043 1045 if re_key is not None:
1044 1046 sdp = self.strdispatchers.get(name, StrDispatch())
1045 1047 sdp.add_re(re.compile(re_key), f, priority )
1046 1048 self.strdispatchers[name] = sdp
1047 1049 return
1048 1050
1049 1051 dp = getattr(self.hooks, name, None)
1050 1052 if name not in IPython.core.hooks.__all__:
1051 1053 print("Warning! Hook '%s' is not one of %s" % \
1052 1054 (name, IPython.core.hooks.__all__ ))
1053 1055
1054 1056 if _warn_deprecated and (name in IPython.core.hooks.deprecated):
1055 1057 alternative = IPython.core.hooks.deprecated[name]
1056 1058 warn("Hook {} is deprecated. Use {} instead.".format(name, alternative), stacklevel=2)
1057 1059
1058 1060 if not dp:
1059 1061 dp = IPython.core.hooks.CommandChainDispatcher()
1060 1062
1061 1063 try:
1062 1064 dp.add(f,priority)
1063 1065 except AttributeError:
1064 1066 # it was not commandchain, plain old func - replace
1065 1067 dp = f
1066 1068
1067 1069 setattr(self.hooks,name, dp)
1068 1070
1069 1071 #-------------------------------------------------------------------------
1070 1072 # Things related to events
1071 1073 #-------------------------------------------------------------------------
1072 1074
1073 1075 def init_events(self):
1074 1076 self.events = EventManager(self, available_events)
1075 1077
1076 1078 self.events.register("pre_execute", self._clear_warning_registry)
1077 1079
1078 1080 def register_post_execute(self, func):
1079 1081 """DEPRECATED: Use ip.events.register('post_run_cell', func)
1080 1082
1081 1083 Register a function for calling after code execution.
1082 1084 """
1083 1085 warn("ip.register_post_execute is deprecated, use "
1084 1086 "ip.events.register('post_run_cell', func) instead.", stacklevel=2)
1085 1087 self.events.register('post_run_cell', func)
1086 1088
1087 1089 def _clear_warning_registry(self):
1088 1090 # clear the warning registry, so that different code blocks with
1089 1091 # overlapping line number ranges don't cause spurious suppression of
1090 1092 # warnings (see gh-6611 for details)
1091 1093 if "__warningregistry__" in self.user_global_ns:
1092 1094 del self.user_global_ns["__warningregistry__"]
1093 1095
1094 1096 #-------------------------------------------------------------------------
1095 1097 # Things related to the "main" module
1096 1098 #-------------------------------------------------------------------------
1097 1099
1098 1100 def new_main_mod(self, filename, modname):
1099 1101 """Return a new 'main' module object for user code execution.
1100 1102
1101 1103 ``filename`` should be the path of the script which will be run in the
1102 1104 module. Requests with the same filename will get the same module, with
1103 1105 its namespace cleared.
1104 1106
1105 1107 ``modname`` should be the module name - normally either '__main__' or
1106 1108 the basename of the file without the extension.
1107 1109
1108 1110 When scripts are executed via %run, we must keep a reference to their
1109 1111 __main__ module around so that Python doesn't
1110 1112 clear it, rendering references to module globals useless.
1111 1113
1112 1114 This method keeps said reference in a private dict, keyed by the
1113 1115 absolute path of the script. This way, for multiple executions of the
1114 1116 same script we only keep one copy of the namespace (the last one),
1115 1117 thus preventing memory leaks from old references while allowing the
1116 1118 objects from the last execution to be accessible.
1117 1119 """
1118 1120 filename = os.path.abspath(filename)
1119 1121 try:
1120 1122 main_mod = self._main_mod_cache[filename]
1121 1123 except KeyError:
1122 1124 main_mod = self._main_mod_cache[filename] = types.ModuleType(
1123 1125 modname,
1124 1126 doc="Module created for script run in IPython")
1125 1127 else:
1126 1128 main_mod.__dict__.clear()
1127 1129 main_mod.__name__ = modname
1128 1130
1129 1131 main_mod.__file__ = filename
1130 1132 # It seems pydoc (and perhaps others) needs any module instance to
1131 1133 # implement a __nonzero__ method
1132 1134 main_mod.__nonzero__ = lambda : True
1133 1135
1134 1136 return main_mod
1135 1137
1136 1138 def clear_main_mod_cache(self):
1137 1139 """Clear the cache of main modules.
1138 1140
1139 1141 Mainly for use by utilities like %reset.
1140 1142
1141 1143 Examples
1142 1144 --------
1143 1145 In [15]: import IPython
1144 1146
1145 1147 In [16]: m = _ip.new_main_mod(IPython.__file__, 'IPython')
1146 1148
1147 1149 In [17]: len(_ip._main_mod_cache) > 0
1148 1150 Out[17]: True
1149 1151
1150 1152 In [18]: _ip.clear_main_mod_cache()
1151 1153
1152 1154 In [19]: len(_ip._main_mod_cache) == 0
1153 1155 Out[19]: True
1154 1156 """
1155 1157 self._main_mod_cache.clear()
1156 1158
1157 1159 #-------------------------------------------------------------------------
1158 1160 # Things related to debugging
1159 1161 #-------------------------------------------------------------------------
1160 1162
1161 1163 def init_pdb(self):
1162 1164 # Set calling of pdb on exceptions
1163 1165 # self.call_pdb is a property
1164 1166 self.call_pdb = self.pdb
1165 1167
1166 1168 def _get_call_pdb(self):
1167 1169 return self._call_pdb
1168 1170
1169 1171 def _set_call_pdb(self,val):
1170 1172
1171 1173 if val not in (0,1,False,True):
1172 1174 raise ValueError('new call_pdb value must be boolean')
1173 1175
1174 1176 # store value in instance
1175 1177 self._call_pdb = val
1176 1178
1177 1179 # notify the actual exception handlers
1178 1180 self.InteractiveTB.call_pdb = val
1179 1181
1180 1182 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
1181 1183 'Control auto-activation of pdb at exceptions')
1182 1184
1183 1185 def debugger(self,force=False):
1184 1186 """Call the pdb debugger.
1185 1187
1186 1188 Keywords:
1187 1189
1188 1190 - force(False): by default, this routine checks the instance call_pdb
1189 1191 flag and does not actually invoke the debugger if the flag is false.
1190 1192 The 'force' option forces the debugger to activate even if the flag
1191 1193 is false.
1192 1194 """
1193 1195
1194 1196 if not (force or self.call_pdb):
1195 1197 return
1196 1198
1197 1199 if not hasattr(sys,'last_traceback'):
1198 1200 error('No traceback has been produced, nothing to debug.')
1199 1201 return
1200 1202
1201 1203 self.InteractiveTB.debugger(force=True)
1202 1204
1203 1205 #-------------------------------------------------------------------------
1204 1206 # Things related to IPython's various namespaces
1205 1207 #-------------------------------------------------------------------------
1206 1208 default_user_namespaces = True
1207 1209
1208 1210 def init_create_namespaces(self, user_module=None, user_ns=None):
1209 1211 # Create the namespace where the user will operate. user_ns is
1210 1212 # normally the only one used, and it is passed to the exec calls as
1211 1213 # the locals argument. But we do carry a user_global_ns namespace
1212 1214 # given as the exec 'globals' argument, This is useful in embedding
1213 1215 # situations where the ipython shell opens in a context where the
1214 1216 # distinction between locals and globals is meaningful. For
1215 1217 # non-embedded contexts, it is just the same object as the user_ns dict.
1216 1218
1217 1219 # FIXME. For some strange reason, __builtins__ is showing up at user
1218 1220 # level as a dict instead of a module. This is a manual fix, but I
1219 1221 # should really track down where the problem is coming from. Alex
1220 1222 # Schmolck reported this problem first.
1221 1223
1222 1224 # A useful post by Alex Martelli on this topic:
1223 1225 # Re: inconsistent value from __builtins__
1224 1226 # Von: Alex Martelli <aleaxit@yahoo.com>
1225 1227 # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends
1226 1228 # Gruppen: comp.lang.python
1227 1229
1228 1230 # Michael Hohn <hohn@hooknose.lbl.gov> wrote:
1229 1231 # > >>> print type(builtin_check.get_global_binding('__builtins__'))
1230 1232 # > <type 'dict'>
1231 1233 # > >>> print type(__builtins__)
1232 1234 # > <type 'module'>
1233 1235 # > Is this difference in return value intentional?
1234 1236
1235 1237 # Well, it's documented that '__builtins__' can be either a dictionary
1236 1238 # or a module, and it's been that way for a long time. Whether it's
1237 1239 # intentional (or sensible), I don't know. In any case, the idea is
1238 1240 # that if you need to access the built-in namespace directly, you
1239 1241 # should start with "import __builtin__" (note, no 's') which will
1240 1242 # definitely give you a module. Yeah, it's somewhat confusing:-(.
1241 1243
1242 1244 # These routines return a properly built module and dict as needed by
1243 1245 # the rest of the code, and can also be used by extension writers to
1244 1246 # generate properly initialized namespaces.
1245 1247 if (user_ns is not None) or (user_module is not None):
1246 1248 self.default_user_namespaces = False
1247 1249 self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns)
1248 1250
1249 1251 # A record of hidden variables we have added to the user namespace, so
1250 1252 # we can list later only variables defined in actual interactive use.
1251 1253 self.user_ns_hidden = {}
1252 1254
1253 1255 # Now that FakeModule produces a real module, we've run into a nasty
1254 1256 # problem: after script execution (via %run), the module where the user
1255 1257 # code ran is deleted. Now that this object is a true module (needed
1256 1258 # so doctest and other tools work correctly), the Python module
1257 1259 # teardown mechanism runs over it, and sets to None every variable
1258 1260 # present in that module. Top-level references to objects from the
1259 1261 # script survive, because the user_ns is updated with them. However,
1260 1262 # calling functions defined in the script that use other things from
1261 1263 # the script will fail, because the function's closure had references
1262 1264 # to the original objects, which are now all None. So we must protect
1263 1265 # these modules from deletion by keeping a cache.
1264 1266 #
1265 1267 # To avoid keeping stale modules around (we only need the one from the
1266 1268 # last run), we use a dict keyed with the full path to the script, so
1267 1269 # only the last version of the module is held in the cache. Note,
1268 1270 # however, that we must cache the module *namespace contents* (their
1269 1271 # __dict__). Because if we try to cache the actual modules, old ones
1270 1272 # (uncached) could be destroyed while still holding references (such as
1271 1273 # those held by GUI objects that tend to be long-lived)>
1272 1274 #
1273 1275 # The %reset command will flush this cache. See the cache_main_mod()
1274 1276 # and clear_main_mod_cache() methods for details on use.
1275 1277
1276 1278 # This is the cache used for 'main' namespaces
1277 1279 self._main_mod_cache = {}
1278 1280
1279 1281 # A table holding all the namespaces IPython deals with, so that
1280 1282 # introspection facilities can search easily.
1281 1283 self.ns_table = {'user_global':self.user_module.__dict__,
1282 1284 'user_local':self.user_ns,
1283 1285 'builtin':builtin_mod.__dict__
1284 1286 }
1285 1287
1286 1288 @property
1287 1289 def user_global_ns(self):
1288 1290 return self.user_module.__dict__
1289 1291
1290 1292 def prepare_user_module(self, user_module=None, user_ns=None):
1291 1293 """Prepare the module and namespace in which user code will be run.
1292 1294
1293 1295 When IPython is started normally, both parameters are None: a new module
1294 1296 is created automatically, and its __dict__ used as the namespace.
1295 1297
1296 1298 If only user_module is provided, its __dict__ is used as the namespace.
1297 1299 If only user_ns is provided, a dummy module is created, and user_ns
1298 1300 becomes the global namespace. If both are provided (as they may be
1299 1301 when embedding), user_ns is the local namespace, and user_module
1300 1302 provides the global namespace.
1301 1303
1302 1304 Parameters
1303 1305 ----------
1304 1306 user_module : module, optional
1305 1307 The current user module in which IPython is being run. If None,
1306 1308 a clean module will be created.
1307 1309 user_ns : dict, optional
1308 1310 A namespace in which to run interactive commands.
1309 1311
1310 1312 Returns
1311 1313 -------
1312 1314 A tuple of user_module and user_ns, each properly initialised.
1313 1315 """
1314 1316 if user_module is None and user_ns is not None:
1315 1317 user_ns.setdefault("__name__", "__main__")
1316 1318 user_module = DummyMod()
1317 1319 user_module.__dict__ = user_ns
1318 1320
1319 1321 if user_module is None:
1320 1322 user_module = types.ModuleType("__main__",
1321 1323 doc="Automatically created module for IPython interactive environment")
1322 1324
1323 1325 # We must ensure that __builtin__ (without the final 's') is always
1324 1326 # available and pointing to the __builtin__ *module*. For more details:
1325 1327 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1326 1328 user_module.__dict__.setdefault('__builtin__', builtin_mod)
1327 1329 user_module.__dict__.setdefault('__builtins__', builtin_mod)
1328 1330
1329 1331 if user_ns is None:
1330 1332 user_ns = user_module.__dict__
1331 1333
1332 1334 return user_module, user_ns
1333 1335
1334 1336 def init_sys_modules(self):
1335 1337 # We need to insert into sys.modules something that looks like a
1336 1338 # module but which accesses the IPython namespace, for shelve and
1337 1339 # pickle to work interactively. Normally they rely on getting
1338 1340 # everything out of __main__, but for embedding purposes each IPython
1339 1341 # instance has its own private namespace, so we can't go shoving
1340 1342 # everything into __main__.
1341 1343
1342 1344 # note, however, that we should only do this for non-embedded
1343 1345 # ipythons, which really mimic the __main__.__dict__ with their own
1344 1346 # namespace. Embedded instances, on the other hand, should not do
1345 1347 # this because they need to manage the user local/global namespaces
1346 1348 # only, but they live within a 'normal' __main__ (meaning, they
1347 1349 # shouldn't overtake the execution environment of the script they're
1348 1350 # embedded in).
1349 1351
1350 1352 # This is overridden in the InteractiveShellEmbed subclass to a no-op.
1351 1353 main_name = self.user_module.__name__
1352 1354 sys.modules[main_name] = self.user_module
1353 1355
1354 1356 def init_user_ns(self):
1355 1357 """Initialize all user-visible namespaces to their minimum defaults.
1356 1358
1357 1359 Certain history lists are also initialized here, as they effectively
1358 1360 act as user namespaces.
1359 1361
1360 1362 Notes
1361 1363 -----
1362 1364 All data structures here are only filled in, they are NOT reset by this
1363 1365 method. If they were not empty before, data will simply be added to
1364 1366 them.
1365 1367 """
1366 1368 # This function works in two parts: first we put a few things in
1367 1369 # user_ns, and we sync that contents into user_ns_hidden so that these
1368 1370 # initial variables aren't shown by %who. After the sync, we add the
1369 1371 # rest of what we *do* want the user to see with %who even on a new
1370 1372 # session (probably nothing, so they really only see their own stuff)
1371 1373
1372 1374 # The user dict must *always* have a __builtin__ reference to the
1373 1375 # Python standard __builtin__ namespace, which must be imported.
1374 1376 # This is so that certain operations in prompt evaluation can be
1375 1377 # reliably executed with builtins. Note that we can NOT use
1376 1378 # __builtins__ (note the 's'), because that can either be a dict or a
1377 1379 # module, and can even mutate at runtime, depending on the context
1378 1380 # (Python makes no guarantees on it). In contrast, __builtin__ is
1379 1381 # always a module object, though it must be explicitly imported.
1380 1382
1381 1383 # For more details:
1382 1384 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1383 1385 ns = {}
1384 1386
1385 1387 # make global variables for user access to the histories
1386 1388 ns['_ih'] = self.history_manager.input_hist_parsed
1387 1389 ns['_oh'] = self.history_manager.output_hist
1388 1390 ns['_dh'] = self.history_manager.dir_hist
1389 1391
1390 1392 # user aliases to input and output histories. These shouldn't show up
1391 1393 # in %who, as they can have very large reprs.
1392 1394 ns['In'] = self.history_manager.input_hist_parsed
1393 1395 ns['Out'] = self.history_manager.output_hist
1394 1396
1395 1397 # Store myself as the public api!!!
1396 1398 ns['get_ipython'] = self.get_ipython
1397 1399
1398 1400 ns['exit'] = self.exiter
1399 1401 ns['quit'] = self.exiter
1400 1402
1401 1403 # Sync what we've added so far to user_ns_hidden so these aren't seen
1402 1404 # by %who
1403 1405 self.user_ns_hidden.update(ns)
1404 1406
1405 1407 # Anything put into ns now would show up in %who. Think twice before
1406 1408 # putting anything here, as we really want %who to show the user their
1407 1409 # stuff, not our variables.
1408 1410
1409 1411 # Finally, update the real user's namespace
1410 1412 self.user_ns.update(ns)
1411 1413
1412 1414 @property
1413 1415 def all_ns_refs(self):
1414 1416 """Get a list of references to all the namespace dictionaries in which
1415 1417 IPython might store a user-created object.
1416 1418
1417 1419 Note that this does not include the displayhook, which also caches
1418 1420 objects from the output."""
1419 1421 return [self.user_ns, self.user_global_ns, self.user_ns_hidden] + \
1420 1422 [m.__dict__ for m in self._main_mod_cache.values()]
1421 1423
1422 1424 def reset(self, new_session=True, aggressive=False):
1423 1425 """Clear all internal namespaces, and attempt to release references to
1424 1426 user objects.
1425 1427
1426 1428 If new_session is True, a new history session will be opened.
1427 1429 """
1428 1430 # Clear histories
1429 1431 self.history_manager.reset(new_session)
1430 1432 # Reset counter used to index all histories
1431 1433 if new_session:
1432 1434 self.execution_count = 1
1433 1435
1434 1436 # Reset last execution result
1435 1437 self.last_execution_succeeded = True
1436 1438 self.last_execution_result = None
1437 1439
1438 1440 # Flush cached output items
1439 1441 if self.displayhook.do_full_cache:
1440 1442 self.displayhook.flush()
1441 1443
1442 1444 # The main execution namespaces must be cleared very carefully,
1443 1445 # skipping the deletion of the builtin-related keys, because doing so
1444 1446 # would cause errors in many object's __del__ methods.
1445 1447 if self.user_ns is not self.user_global_ns:
1446 1448 self.user_ns.clear()
1447 1449 ns = self.user_global_ns
1448 1450 drop_keys = set(ns.keys())
1449 1451 drop_keys.discard('__builtin__')
1450 1452 drop_keys.discard('__builtins__')
1451 1453 drop_keys.discard('__name__')
1452 1454 for k in drop_keys:
1453 1455 del ns[k]
1454 1456
1455 1457 self.user_ns_hidden.clear()
1456 1458
1457 1459 # Restore the user namespaces to minimal usability
1458 1460 self.init_user_ns()
1459 1461 if aggressive and not hasattr(self, "_sys_modules_keys"):
1460 1462 print("Cannot restore sys.module, no snapshot")
1461 1463 elif aggressive:
1462 1464 print("culling sys module...")
1463 1465 current_keys = set(sys.modules.keys())
1464 1466 for k in current_keys - self._sys_modules_keys:
1465 1467 if k.startswith("multiprocessing"):
1466 1468 continue
1467 1469 del sys.modules[k]
1468 1470
1469 1471 # Restore the default and user aliases
1470 1472 self.alias_manager.clear_aliases()
1471 1473 self.alias_manager.init_aliases()
1472 1474
1473 1475 # Now define aliases that only make sense on the terminal, because they
1474 1476 # need direct access to the console in a way that we can't emulate in
1475 1477 # GUI or web frontend
1476 1478 if os.name == 'posix':
1477 1479 for cmd in ('clear', 'more', 'less', 'man'):
1478 1480 if cmd not in self.magics_manager.magics['line']:
1479 1481 self.alias_manager.soft_define_alias(cmd, cmd)
1480 1482
1481 1483 # Flush the private list of module references kept for script
1482 1484 # execution protection
1483 1485 self.clear_main_mod_cache()
1484 1486
1485 1487 def del_var(self, varname, by_name=False):
1486 1488 """Delete a variable from the various namespaces, so that, as
1487 1489 far as possible, we're not keeping any hidden references to it.
1488 1490
1489 1491 Parameters
1490 1492 ----------
1491 1493 varname : str
1492 1494 The name of the variable to delete.
1493 1495 by_name : bool
1494 1496 If True, delete variables with the given name in each
1495 1497 namespace. If False (default), find the variable in the user
1496 1498 namespace, and delete references to it.
1497 1499 """
1498 1500 if varname in ('__builtin__', '__builtins__'):
1499 1501 raise ValueError("Refusing to delete %s" % varname)
1500 1502
1501 1503 ns_refs = self.all_ns_refs
1502 1504
1503 1505 if by_name: # Delete by name
1504 1506 for ns in ns_refs:
1505 1507 try:
1506 1508 del ns[varname]
1507 1509 except KeyError:
1508 1510 pass
1509 1511 else: # Delete by object
1510 1512 try:
1511 1513 obj = self.user_ns[varname]
1512 1514 except KeyError as e:
1513 1515 raise NameError("name '%s' is not defined" % varname) from e
1514 1516 # Also check in output history
1515 1517 ns_refs.append(self.history_manager.output_hist)
1516 1518 for ns in ns_refs:
1517 1519 to_delete = [n for n, o in ns.items() if o is obj]
1518 1520 for name in to_delete:
1519 1521 del ns[name]
1520 1522
1521 1523 # Ensure it is removed from the last execution result
1522 1524 if self.last_execution_result.result is obj:
1523 1525 self.last_execution_result = None
1524 1526
1525 1527 # displayhook keeps extra references, but not in a dictionary
1526 1528 for name in ('_', '__', '___'):
1527 1529 if getattr(self.displayhook, name) is obj:
1528 1530 setattr(self.displayhook, name, None)
1529 1531
1530 1532 def reset_selective(self, regex=None):
1531 1533 """Clear selective variables from internal namespaces based on a
1532 1534 specified regular expression.
1533 1535
1534 1536 Parameters
1535 1537 ----------
1536 1538 regex : string or compiled pattern, optional
1537 1539 A regular expression pattern that will be used in searching
1538 1540 variable names in the users namespaces.
1539 1541 """
1540 1542 if regex is not None:
1541 1543 try:
1542 1544 m = re.compile(regex)
1543 1545 except TypeError as e:
1544 1546 raise TypeError('regex must be a string or compiled pattern') from e
1545 1547 # Search for keys in each namespace that match the given regex
1546 1548 # If a match is found, delete the key/value pair.
1547 1549 for ns in self.all_ns_refs:
1548 1550 for var in ns:
1549 1551 if m.search(var):
1550 1552 del ns[var]
1551 1553
1552 1554 def push(self, variables, interactive=True):
1553 1555 """Inject a group of variables into the IPython user namespace.
1554 1556
1555 1557 Parameters
1556 1558 ----------
1557 1559 variables : dict, str or list/tuple of str
1558 1560 The variables to inject into the user's namespace. If a dict, a
1559 1561 simple update is done. If a str, the string is assumed to have
1560 1562 variable names separated by spaces. A list/tuple of str can also
1561 1563 be used to give the variable names. If just the variable names are
1562 1564 give (list/tuple/str) then the variable values looked up in the
1563 1565 callers frame.
1564 1566 interactive : bool
1565 1567 If True (default), the variables will be listed with the ``who``
1566 1568 magic.
1567 1569 """
1568 1570 vdict = None
1569 1571
1570 1572 # We need a dict of name/value pairs to do namespace updates.
1571 1573 if isinstance(variables, dict):
1572 1574 vdict = variables
1573 1575 elif isinstance(variables, (str, list, tuple)):
1574 1576 if isinstance(variables, str):
1575 1577 vlist = variables.split()
1576 1578 else:
1577 1579 vlist = variables
1578 1580 vdict = {}
1579 1581 cf = sys._getframe(1)
1580 1582 for name in vlist:
1581 1583 try:
1582 1584 vdict[name] = eval(name, cf.f_globals, cf.f_locals)
1583 1585 except:
1584 1586 print('Could not get variable %s from %s' %
1585 1587 (name,cf.f_code.co_name))
1586 1588 else:
1587 1589 raise ValueError('variables must be a dict/str/list/tuple')
1588 1590
1589 1591 # Propagate variables to user namespace
1590 1592 self.user_ns.update(vdict)
1591 1593
1592 1594 # And configure interactive visibility
1593 1595 user_ns_hidden = self.user_ns_hidden
1594 1596 if interactive:
1595 1597 for name in vdict:
1596 1598 user_ns_hidden.pop(name, None)
1597 1599 else:
1598 1600 user_ns_hidden.update(vdict)
1599 1601
1600 1602 def drop_by_id(self, variables):
1601 1603 """Remove a dict of variables from the user namespace, if they are the
1602 1604 same as the values in the dictionary.
1603 1605
1604 1606 This is intended for use by extensions: variables that they've added can
1605 1607 be taken back out if they are unloaded, without removing any that the
1606 1608 user has overwritten.
1607 1609
1608 1610 Parameters
1609 1611 ----------
1610 1612 variables : dict
1611 1613 A dictionary mapping object names (as strings) to the objects.
1612 1614 """
1613 1615 for name, obj in variables.items():
1614 1616 if name in self.user_ns and self.user_ns[name] is obj:
1615 1617 del self.user_ns[name]
1616 1618 self.user_ns_hidden.pop(name, None)
1617 1619
1618 1620 #-------------------------------------------------------------------------
1619 1621 # Things related to object introspection
1620 1622 #-------------------------------------------------------------------------
1621 1623
1622 1624 def _ofind(self, oname, namespaces=None):
1623 1625 """Find an object in the available namespaces.
1624 1626
1625 1627 self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic
1626 1628
1627 1629 Has special code to detect magic functions.
1628 1630 """
1629 1631 oname = oname.strip()
1630 1632 if not oname.startswith(ESC_MAGIC) and \
1631 1633 not oname.startswith(ESC_MAGIC2) and \
1632 1634 not all(a.isidentifier() for a in oname.split(".")):
1633 1635 return {'found': False}
1634 1636
1635 1637 if namespaces is None:
1636 1638 # Namespaces to search in:
1637 1639 # Put them in a list. The order is important so that we
1638 1640 # find things in the same order that Python finds them.
1639 1641 namespaces = [ ('Interactive', self.user_ns),
1640 1642 ('Interactive (global)', self.user_global_ns),
1641 1643 ('Python builtin', builtin_mod.__dict__),
1642 1644 ]
1643 1645
1644 1646 ismagic = False
1645 1647 isalias = False
1646 1648 found = False
1647 1649 ospace = None
1648 1650 parent = None
1649 1651 obj = None
1650 1652
1651 1653
1652 1654 # Look for the given name by splitting it in parts. If the head is
1653 1655 # found, then we look for all the remaining parts as members, and only
1654 1656 # declare success if we can find them all.
1655 1657 oname_parts = oname.split('.')
1656 1658 oname_head, oname_rest = oname_parts[0],oname_parts[1:]
1657 1659 for nsname,ns in namespaces:
1658 1660 try:
1659 1661 obj = ns[oname_head]
1660 1662 except KeyError:
1661 1663 continue
1662 1664 else:
1663 1665 for idx, part in enumerate(oname_rest):
1664 1666 try:
1665 1667 parent = obj
1666 1668 # The last part is looked up in a special way to avoid
1667 1669 # descriptor invocation as it may raise or have side
1668 1670 # effects.
1669 1671 if idx == len(oname_rest) - 1:
1670 1672 obj = self._getattr_property(obj, part)
1671 1673 else:
1672 1674 obj = getattr(obj, part)
1673 1675 except:
1674 1676 # Blanket except b/c some badly implemented objects
1675 1677 # allow __getattr__ to raise exceptions other than
1676 1678 # AttributeError, which then crashes IPython.
1677 1679 break
1678 1680 else:
1679 1681 # If we finish the for loop (no break), we got all members
1680 1682 found = True
1681 1683 ospace = nsname
1682 1684 break # namespace loop
1683 1685
1684 1686 # Try to see if it's magic
1685 1687 if not found:
1686 1688 obj = None
1687 1689 if oname.startswith(ESC_MAGIC2):
1688 1690 oname = oname.lstrip(ESC_MAGIC2)
1689 1691 obj = self.find_cell_magic(oname)
1690 1692 elif oname.startswith(ESC_MAGIC):
1691 1693 oname = oname.lstrip(ESC_MAGIC)
1692 1694 obj = self.find_line_magic(oname)
1693 1695 else:
1694 1696 # search without prefix, so run? will find %run?
1695 1697 obj = self.find_line_magic(oname)
1696 1698 if obj is None:
1697 1699 obj = self.find_cell_magic(oname)
1698 1700 if obj is not None:
1699 1701 found = True
1700 1702 ospace = 'IPython internal'
1701 1703 ismagic = True
1702 1704 isalias = isinstance(obj, Alias)
1703 1705
1704 1706 # Last try: special-case some literals like '', [], {}, etc:
1705 1707 if not found and oname_head in ["''",'""','[]','{}','()']:
1706 1708 obj = eval(oname_head)
1707 1709 found = True
1708 1710 ospace = 'Interactive'
1709 1711
1710 1712 return {
1711 1713 'obj':obj,
1712 1714 'found':found,
1713 1715 'parent':parent,
1714 1716 'ismagic':ismagic,
1715 1717 'isalias':isalias,
1716 1718 'namespace':ospace
1717 1719 }
1718 1720
1719 1721 @staticmethod
1720 1722 def _getattr_property(obj, attrname):
1721 1723 """Property-aware getattr to use in object finding.
1722 1724
1723 1725 If attrname represents a property, return it unevaluated (in case it has
1724 1726 side effects or raises an error.
1725 1727
1726 1728 """
1727 1729 if not isinstance(obj, type):
1728 1730 try:
1729 1731 # `getattr(type(obj), attrname)` is not guaranteed to return
1730 1732 # `obj`, but does so for property:
1731 1733 #
1732 1734 # property.__get__(self, None, cls) -> self
1733 1735 #
1734 1736 # The universal alternative is to traverse the mro manually
1735 1737 # searching for attrname in class dicts.
1736 1738 attr = getattr(type(obj), attrname)
1737 1739 except AttributeError:
1738 1740 pass
1739 1741 else:
1740 1742 # This relies on the fact that data descriptors (with both
1741 1743 # __get__ & __set__ magic methods) take precedence over
1742 1744 # instance-level attributes:
1743 1745 #
1744 1746 # class A(object):
1745 1747 # @property
1746 1748 # def foobar(self): return 123
1747 1749 # a = A()
1748 1750 # a.__dict__['foobar'] = 345
1749 1751 # a.foobar # == 123
1750 1752 #
1751 1753 # So, a property may be returned right away.
1752 1754 if isinstance(attr, property):
1753 1755 return attr
1754 1756
1755 1757 # Nothing helped, fall back.
1756 1758 return getattr(obj, attrname)
1757 1759
1758 1760 def _object_find(self, oname, namespaces=None):
1759 1761 """Find an object and return a struct with info about it."""
1760 1762 return Struct(self._ofind(oname, namespaces))
1761 1763
1762 1764 def _inspect(self, meth, oname, namespaces=None, **kw):
1763 1765 """Generic interface to the inspector system.
1764 1766
1765 1767 This function is meant to be called by pdef, pdoc & friends.
1766 1768 """
1767 1769 info = self._object_find(oname, namespaces)
1768 1770 docformat = sphinxify if self.sphinxify_docstring else None
1769 1771 if info.found:
1770 1772 pmethod = getattr(self.inspector, meth)
1771 1773 # TODO: only apply format_screen to the plain/text repr of the mime
1772 1774 # bundle.
1773 1775 formatter = format_screen if info.ismagic else docformat
1774 1776 if meth == 'pdoc':
1775 1777 pmethod(info.obj, oname, formatter)
1776 1778 elif meth == 'pinfo':
1777 1779 pmethod(
1778 1780 info.obj,
1779 1781 oname,
1780 1782 formatter,
1781 1783 info,
1782 1784 enable_html_pager=self.enable_html_pager,
1783 1785 **kw
1784 1786 )
1785 1787 else:
1786 1788 pmethod(info.obj, oname)
1787 1789 else:
1788 1790 print('Object `%s` not found.' % oname)
1789 1791 return 'not found' # so callers can take other action
1790 1792
1791 1793 def object_inspect(self, oname, detail_level=0):
1792 1794 """Get object info about oname"""
1793 1795 with self.builtin_trap:
1794 1796 info = self._object_find(oname)
1795 1797 if info.found:
1796 1798 return self.inspector.info(info.obj, oname, info=info,
1797 1799 detail_level=detail_level
1798 1800 )
1799 1801 else:
1800 1802 return oinspect.object_info(name=oname, found=False)
1801 1803
1802 1804 def object_inspect_text(self, oname, detail_level=0):
1803 1805 """Get object info as formatted text"""
1804 1806 return self.object_inspect_mime(oname, detail_level)['text/plain']
1805 1807
1806 1808 def object_inspect_mime(self, oname, detail_level=0):
1807 1809 """Get object info as a mimebundle of formatted representations.
1808 1810
1809 1811 A mimebundle is a dictionary, keyed by mime-type.
1810 1812 It must always have the key `'text/plain'`.
1811 1813 """
1812 1814 with self.builtin_trap:
1813 1815 info = self._object_find(oname)
1814 1816 if info.found:
1815 1817 return self.inspector._get_info(info.obj, oname, info=info,
1816 1818 detail_level=detail_level
1817 1819 )
1818 1820 else:
1819 1821 raise KeyError(oname)
1820 1822
1821 1823 #-------------------------------------------------------------------------
1822 1824 # Things related to history management
1823 1825 #-------------------------------------------------------------------------
1824 1826
1825 1827 def init_history(self):
1826 1828 """Sets up the command history, and starts regular autosaves."""
1827 1829 self.history_manager = HistoryManager(shell=self, parent=self)
1828 1830 self.configurables.append(self.history_manager)
1829 1831
1830 1832 #-------------------------------------------------------------------------
1831 1833 # Things related to exception handling and tracebacks (not debugging)
1832 1834 #-------------------------------------------------------------------------
1833 1835
1834 1836 debugger_cls = Pdb
1835 1837
1836 1838 def init_traceback_handlers(self, custom_exceptions):
1837 1839 # Syntax error handler.
1838 1840 self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor', parent=self)
1839 1841
1840 1842 # The interactive one is initialized with an offset, meaning we always
1841 1843 # want to remove the topmost item in the traceback, which is our own
1842 1844 # internal code. Valid modes: ['Plain','Context','Verbose','Minimal']
1843 1845 self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain',
1844 1846 color_scheme='NoColor',
1845 1847 tb_offset = 1,
1846 1848 check_cache=check_linecache_ipython,
1847 1849 debugger_cls=self.debugger_cls, parent=self)
1848 1850
1849 1851 # The instance will store a pointer to the system-wide exception hook,
1850 1852 # so that runtime code (such as magics) can access it. This is because
1851 1853 # during the read-eval loop, it may get temporarily overwritten.
1852 1854 self.sys_excepthook = sys.excepthook
1853 1855
1854 1856 # and add any custom exception handlers the user may have specified
1855 1857 self.set_custom_exc(*custom_exceptions)
1856 1858
1857 1859 # Set the exception mode
1858 1860 self.InteractiveTB.set_mode(mode=self.xmode)
1859 1861
1860 1862 def set_custom_exc(self, exc_tuple, handler):
1861 1863 """set_custom_exc(exc_tuple, handler)
1862 1864
1863 1865 Set a custom exception handler, which will be called if any of the
1864 1866 exceptions in exc_tuple occur in the mainloop (specifically, in the
1865 1867 run_code() method).
1866 1868
1867 1869 Parameters
1868 1870 ----------
1869 1871
1870 1872 exc_tuple : tuple of exception classes
1871 1873 A *tuple* of exception classes, for which to call the defined
1872 1874 handler. It is very important that you use a tuple, and NOT A
1873 1875 LIST here, because of the way Python's except statement works. If
1874 1876 you only want to trap a single exception, use a singleton tuple::
1875 1877
1876 1878 exc_tuple == (MyCustomException,)
1877 1879
1878 1880 handler : callable
1879 1881 handler must have the following signature::
1880 1882
1881 1883 def my_handler(self, etype, value, tb, tb_offset=None):
1882 1884 ...
1883 1885 return structured_traceback
1884 1886
1885 1887 Your handler must return a structured traceback (a list of strings),
1886 1888 or None.
1887 1889
1888 1890 This will be made into an instance method (via types.MethodType)
1889 1891 of IPython itself, and it will be called if any of the exceptions
1890 1892 listed in the exc_tuple are caught. If the handler is None, an
1891 1893 internal basic one is used, which just prints basic info.
1892 1894
1893 1895 To protect IPython from crashes, if your handler ever raises an
1894 1896 exception or returns an invalid result, it will be immediately
1895 1897 disabled.
1896 1898
1897 1899 Notes
1898 1900 -----
1899 1901
1900 1902 WARNING: by putting in your own exception handler into IPython's main
1901 1903 execution loop, you run a very good chance of nasty crashes. This
1902 1904 facility should only be used if you really know what you are doing.
1903 1905 """
1904 1906
1905 1907 if not isinstance(exc_tuple, tuple):
1906 1908 raise TypeError("The custom exceptions must be given as a tuple.")
1907 1909
1908 1910 def dummy_handler(self, etype, value, tb, tb_offset=None):
1909 1911 print('*** Simple custom exception handler ***')
1910 1912 print('Exception type :', etype)
1911 1913 print('Exception value:', value)
1912 1914 print('Traceback :', tb)
1913 1915
1914 1916 def validate_stb(stb):
1915 1917 """validate structured traceback return type
1916 1918
1917 1919 return type of CustomTB *should* be a list of strings, but allow
1918 1920 single strings or None, which are harmless.
1919 1921
1920 1922 This function will *always* return a list of strings,
1921 1923 and will raise a TypeError if stb is inappropriate.
1922 1924 """
1923 1925 msg = "CustomTB must return list of strings, not %r" % stb
1924 1926 if stb is None:
1925 1927 return []
1926 1928 elif isinstance(stb, str):
1927 1929 return [stb]
1928 1930 elif not isinstance(stb, list):
1929 1931 raise TypeError(msg)
1930 1932 # it's a list
1931 1933 for line in stb:
1932 1934 # check every element
1933 1935 if not isinstance(line, str):
1934 1936 raise TypeError(msg)
1935 1937 return stb
1936 1938
1937 1939 if handler is None:
1938 1940 wrapped = dummy_handler
1939 1941 else:
1940 1942 def wrapped(self,etype,value,tb,tb_offset=None):
1941 1943 """wrap CustomTB handler, to protect IPython from user code
1942 1944
1943 1945 This makes it harder (but not impossible) for custom exception
1944 1946 handlers to crash IPython.
1945 1947 """
1946 1948 try:
1947 1949 stb = handler(self,etype,value,tb,tb_offset=tb_offset)
1948 1950 return validate_stb(stb)
1949 1951 except:
1950 1952 # clear custom handler immediately
1951 1953 self.set_custom_exc((), None)
1952 1954 print("Custom TB Handler failed, unregistering", file=sys.stderr)
1953 1955 # show the exception in handler first
1954 1956 stb = self.InteractiveTB.structured_traceback(*sys.exc_info())
1955 1957 print(self.InteractiveTB.stb2text(stb))
1956 1958 print("The original exception:")
1957 1959 stb = self.InteractiveTB.structured_traceback(
1958 1960 (etype,value,tb), tb_offset=tb_offset
1959 1961 )
1960 1962 return stb
1961 1963
1962 1964 self.CustomTB = types.MethodType(wrapped,self)
1963 1965 self.custom_exceptions = exc_tuple
1964 1966
1965 1967 def excepthook(self, etype, value, tb):
1966 1968 """One more defense for GUI apps that call sys.excepthook.
1967 1969
1968 1970 GUI frameworks like wxPython trap exceptions and call
1969 1971 sys.excepthook themselves. I guess this is a feature that
1970 1972 enables them to keep running after exceptions that would
1971 1973 otherwise kill their mainloop. This is a bother for IPython
1972 1974 which expects to catch all of the program exceptions with a try:
1973 1975 except: statement.
1974 1976
1975 1977 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
1976 1978 any app directly invokes sys.excepthook, it will look to the user like
1977 1979 IPython crashed. In order to work around this, we can disable the
1978 1980 CrashHandler and replace it with this excepthook instead, which prints a
1979 1981 regular traceback using our InteractiveTB. In this fashion, apps which
1980 1982 call sys.excepthook will generate a regular-looking exception from
1981 1983 IPython, and the CrashHandler will only be triggered by real IPython
1982 1984 crashes.
1983 1985
1984 1986 This hook should be used sparingly, only in places which are not likely
1985 1987 to be true IPython errors.
1986 1988 """
1987 1989 self.showtraceback((etype, value, tb), tb_offset=0)
1988 1990
1989 1991 def _get_exc_info(self, exc_tuple=None):
1990 1992 """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc.
1991 1993
1992 1994 Ensures sys.last_type,value,traceback hold the exc_info we found,
1993 1995 from whichever source.
1994 1996
1995 1997 raises ValueError if none of these contain any information
1996 1998 """
1997 1999 if exc_tuple is None:
1998 2000 etype, value, tb = sys.exc_info()
1999 2001 else:
2000 2002 etype, value, tb = exc_tuple
2001 2003
2002 2004 if etype is None:
2003 2005 if hasattr(sys, 'last_type'):
2004 2006 etype, value, tb = sys.last_type, sys.last_value, \
2005 2007 sys.last_traceback
2006 2008
2007 2009 if etype is None:
2008 2010 raise ValueError("No exception to find")
2009 2011
2010 2012 # Now store the exception info in sys.last_type etc.
2011 2013 # WARNING: these variables are somewhat deprecated and not
2012 2014 # necessarily safe to use in a threaded environment, but tools
2013 2015 # like pdb depend on their existence, so let's set them. If we
2014 2016 # find problems in the field, we'll need to revisit their use.
2015 2017 sys.last_type = etype
2016 2018 sys.last_value = value
2017 2019 sys.last_traceback = tb
2018 2020
2019 2021 return etype, value, tb
2020 2022
2021 2023 def show_usage_error(self, exc):
2022 2024 """Show a short message for UsageErrors
2023 2025
2024 2026 These are special exceptions that shouldn't show a traceback.
2025 2027 """
2026 2028 print("UsageError: %s" % exc, file=sys.stderr)
2027 2029
2028 2030 def get_exception_only(self, exc_tuple=None):
2029 2031 """
2030 2032 Return as a string (ending with a newline) the exception that
2031 2033 just occurred, without any traceback.
2032 2034 """
2033 2035 etype, value, tb = self._get_exc_info(exc_tuple)
2034 2036 msg = traceback.format_exception_only(etype, value)
2035 2037 return ''.join(msg)
2036 2038
2037 2039 def showtraceback(self, exc_tuple=None, filename=None, tb_offset=None,
2038 2040 exception_only=False, running_compiled_code=False):
2039 2041 """Display the exception that just occurred.
2040 2042
2041 2043 If nothing is known about the exception, this is the method which
2042 2044 should be used throughout the code for presenting user tracebacks,
2043 2045 rather than directly invoking the InteractiveTB object.
2044 2046
2045 2047 A specific showsyntaxerror() also exists, but this method can take
2046 2048 care of calling it if needed, so unless you are explicitly catching a
2047 2049 SyntaxError exception, don't try to analyze the stack manually and
2048 2050 simply call this method."""
2049 2051
2050 2052 try:
2051 2053 try:
2052 2054 etype, value, tb = self._get_exc_info(exc_tuple)
2053 2055 except ValueError:
2054 2056 print('No traceback available to show.', file=sys.stderr)
2055 2057 return
2056 2058
2057 2059 if issubclass(etype, SyntaxError):
2058 2060 # Though this won't be called by syntax errors in the input
2059 2061 # line, there may be SyntaxError cases with imported code.
2060 2062 self.showsyntaxerror(filename, running_compiled_code)
2061 2063 elif etype is UsageError:
2062 2064 self.show_usage_error(value)
2063 2065 else:
2064 2066 if exception_only:
2065 2067 stb = ['An exception has occurred, use %tb to see '
2066 2068 'the full traceback.\n']
2067 2069 stb.extend(self.InteractiveTB.get_exception_only(etype,
2068 2070 value))
2069 2071 else:
2070 2072 try:
2071 2073 # Exception classes can customise their traceback - we
2072 2074 # use this in IPython.parallel for exceptions occurring
2073 2075 # in the engines. This should return a list of strings.
2074 2076 stb = value._render_traceback_()
2075 2077 except Exception:
2076 2078 stb = self.InteractiveTB.structured_traceback(etype,
2077 2079 value, tb, tb_offset=tb_offset)
2078 2080
2079 2081 self._showtraceback(etype, value, stb)
2080 2082 if self.call_pdb:
2081 2083 # drop into debugger
2082 2084 self.debugger(force=True)
2083 2085 return
2084 2086
2085 2087 # Actually show the traceback
2086 2088 self._showtraceback(etype, value, stb)
2087 2089
2088 2090 except KeyboardInterrupt:
2089 2091 print('\n' + self.get_exception_only(), file=sys.stderr)
2090 2092
2091 2093 def _showtraceback(self, etype, evalue, stb: str):
2092 2094 """Actually show a traceback.
2093 2095
2094 2096 Subclasses may override this method to put the traceback on a different
2095 2097 place, like a side channel.
2096 2098 """
2097 2099 val = self.InteractiveTB.stb2text(stb)
2098 2100 try:
2099 2101 print(val)
2100 2102 except UnicodeEncodeError:
2101 2103 print(val.encode("utf-8", "backslashreplace").decode())
2102 2104
2103 2105 def showsyntaxerror(self, filename=None, running_compiled_code=False):
2104 2106 """Display the syntax error that just occurred.
2105 2107
2106 2108 This doesn't display a stack trace because there isn't one.
2107 2109
2108 2110 If a filename is given, it is stuffed in the exception instead
2109 2111 of what was there before (because Python's parser always uses
2110 2112 "<string>" when reading from a string).
2111 2113
2112 2114 If the syntax error occurred when running a compiled code (i.e. running_compile_code=True),
2113 2115 longer stack trace will be displayed.
2114 2116 """
2115 2117 etype, value, last_traceback = self._get_exc_info()
2116 2118
2117 2119 if filename and issubclass(etype, SyntaxError):
2118 2120 try:
2119 2121 value.filename = filename
2120 2122 except:
2121 2123 # Not the format we expect; leave it alone
2122 2124 pass
2123 2125
2124 2126 # If the error occurred when executing compiled code, we should provide full stacktrace.
2125 2127 elist = traceback.extract_tb(last_traceback) if running_compiled_code else []
2126 2128 stb = self.SyntaxTB.structured_traceback(etype, value, elist)
2127 2129 self._showtraceback(etype, value, stb)
2128 2130
2129 2131 # This is overridden in TerminalInteractiveShell to show a message about
2130 2132 # the %paste magic.
2131 2133 def showindentationerror(self):
2132 2134 """Called by _run_cell when there's an IndentationError in code entered
2133 2135 at the prompt.
2134 2136
2135 2137 This is overridden in TerminalInteractiveShell to show a message about
2136 2138 the %paste magic."""
2137 2139 self.showsyntaxerror()
2138 2140
2139 2141 #-------------------------------------------------------------------------
2140 2142 # Things related to readline
2141 2143 #-------------------------------------------------------------------------
2142 2144
2143 2145 def init_readline(self):
2144 2146 """DEPRECATED
2145 2147
2146 2148 Moved to terminal subclass, here only to simplify the init logic."""
2147 2149 # Set a number of methods that depend on readline to be no-op
2148 2150 warnings.warn('`init_readline` is no-op since IPython 5.0 and is Deprecated',
2149 2151 DeprecationWarning, stacklevel=2)
2150 2152 self.set_custom_completer = no_op
2151 2153
2152 2154 @skip_doctest
2153 2155 def set_next_input(self, s, replace=False):
2154 2156 """ Sets the 'default' input string for the next command line.
2155 2157
2156 2158 Example::
2157 2159
2158 2160 In [1]: _ip.set_next_input("Hello Word")
2159 2161 In [2]: Hello Word_ # cursor is here
2160 2162 """
2161 2163 self.rl_next_input = s
2162 2164
2163 2165 def _indent_current_str(self):
2164 2166 """return the current level of indentation as a string"""
2165 2167 return self.input_splitter.get_indent_spaces() * ' '
2166 2168
2167 2169 #-------------------------------------------------------------------------
2168 2170 # Things related to text completion
2169 2171 #-------------------------------------------------------------------------
2170 2172
2171 2173 def init_completer(self):
2172 2174 """Initialize the completion machinery.
2173 2175
2174 2176 This creates completion machinery that can be used by client code,
2175 2177 either interactively in-process (typically triggered by the readline
2176 2178 library), programmatically (such as in test suites) or out-of-process
2177 2179 (typically over the network by remote frontends).
2178 2180 """
2179 2181 from IPython.core.completer import IPCompleter
2180 2182 from IPython.core.completerlib import (module_completer,
2181 2183 magic_run_completer, cd_completer, reset_completer)
2182 2184
2183 2185 self.Completer = IPCompleter(shell=self,
2184 2186 namespace=self.user_ns,
2185 2187 global_namespace=self.user_global_ns,
2186 2188 parent=self,
2187 2189 )
2188 2190 self.configurables.append(self.Completer)
2189 2191
2190 2192 # Add custom completers to the basic ones built into IPCompleter
2191 2193 sdisp = self.strdispatchers.get('complete_command', StrDispatch())
2192 2194 self.strdispatchers['complete_command'] = sdisp
2193 2195 self.Completer.custom_completers = sdisp
2194 2196
2195 2197 self.set_hook('complete_command', module_completer, str_key = 'import')
2196 2198 self.set_hook('complete_command', module_completer, str_key = 'from')
2197 2199 self.set_hook('complete_command', module_completer, str_key = '%aimport')
2198 2200 self.set_hook('complete_command', magic_run_completer, str_key = '%run')
2199 2201 self.set_hook('complete_command', cd_completer, str_key = '%cd')
2200 2202 self.set_hook('complete_command', reset_completer, str_key = '%reset')
2201 2203
2202 2204 @skip_doctest
2203 2205 def complete(self, text, line=None, cursor_pos=None):
2204 2206 """Return the completed text and a list of completions.
2205 2207
2206 2208 Parameters
2207 2209 ----------
2208 2210
2209 2211 text : string
2210 2212 A string of text to be completed on. It can be given as empty and
2211 2213 instead a line/position pair are given. In this case, the
2212 2214 completer itself will split the line like readline does.
2213 2215
2214 2216 line : string, optional
2215 2217 The complete line that text is part of.
2216 2218
2217 2219 cursor_pos : int, optional
2218 2220 The position of the cursor on the input line.
2219 2221
2220 2222 Returns
2221 2223 -------
2222 2224 text : string
2223 2225 The actual text that was completed.
2224 2226
2225 2227 matches : list
2226 2228 A sorted list with all possible completions.
2227 2229
2228 2230
2229 2231 Notes
2230 2232 -----
2231 2233 The optional arguments allow the completion to take more context into
2232 2234 account, and are part of the low-level completion API.
2233 2235
2234 2236 This is a wrapper around the completion mechanism, similar to what
2235 2237 readline does at the command line when the TAB key is hit. By
2236 2238 exposing it as a method, it can be used by other non-readline
2237 2239 environments (such as GUIs) for text completion.
2238 2240
2239 2241 Examples
2240 2242 --------
2241 2243
2242 2244 In [1]: x = 'hello'
2243 2245
2244 2246 In [2]: _ip.complete('x.l')
2245 2247 Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip'])
2246 2248 """
2247 2249
2248 2250 # Inject names into __builtin__ so we can complete on the added names.
2249 2251 with self.builtin_trap:
2250 2252 return self.Completer.complete(text, line, cursor_pos)
2251 2253
2252 2254 def set_custom_completer(self, completer, pos=0) -> None:
2253 2255 """Adds a new custom completer function.
2254 2256
2255 2257 The position argument (defaults to 0) is the index in the completers
2256 2258 list where you want the completer to be inserted.
2257 2259
2258 2260 `completer` should have the following signature::
2259 2261
2260 2262 def completion(self: Completer, text: string) -> List[str]:
2261 2263 raise NotImplementedError
2262 2264
2263 2265 It will be bound to the current Completer instance and pass some text
2264 2266 and return a list with current completions to suggest to the user.
2265 2267 """
2266 2268
2267 2269 newcomp = types.MethodType(completer, self.Completer)
2268 2270 self.Completer.custom_matchers.insert(pos,newcomp)
2269 2271
2270 2272 def set_completer_frame(self, frame=None):
2271 2273 """Set the frame of the completer."""
2272 2274 if frame:
2273 2275 self.Completer.namespace = frame.f_locals
2274 2276 self.Completer.global_namespace = frame.f_globals
2275 2277 else:
2276 2278 self.Completer.namespace = self.user_ns
2277 2279 self.Completer.global_namespace = self.user_global_ns
2278 2280
2279 2281 #-------------------------------------------------------------------------
2280 2282 # Things related to magics
2281 2283 #-------------------------------------------------------------------------
2282 2284
2283 2285 def init_magics(self):
2284 2286 from IPython.core import magics as m
2285 2287 self.magics_manager = magic.MagicsManager(shell=self,
2286 2288 parent=self,
2287 2289 user_magics=m.UserMagics(self))
2288 2290 self.configurables.append(self.magics_manager)
2289 2291
2290 2292 # Expose as public API from the magics manager
2291 2293 self.register_magics = self.magics_manager.register
2292 2294
2293 2295 self.register_magics(m.AutoMagics, m.BasicMagics, m.CodeMagics,
2294 2296 m.ConfigMagics, m.DisplayMagics, m.ExecutionMagics,
2295 2297 m.ExtensionMagics, m.HistoryMagics, m.LoggingMagics,
2296 2298 m.NamespaceMagics, m.OSMagics, m.PackagingMagics,
2297 2299 m.PylabMagics, m.ScriptMagics,
2298 2300 )
2299 2301 self.register_magics(m.AsyncMagics)
2300 2302
2301 2303 # Register Magic Aliases
2302 2304 mman = self.magics_manager
2303 2305 # FIXME: magic aliases should be defined by the Magics classes
2304 2306 # or in MagicsManager, not here
2305 2307 mman.register_alias('ed', 'edit')
2306 2308 mman.register_alias('hist', 'history')
2307 2309 mman.register_alias('rep', 'recall')
2308 2310 mman.register_alias('SVG', 'svg', 'cell')
2309 2311 mman.register_alias('HTML', 'html', 'cell')
2310 2312 mman.register_alias('file', 'writefile', 'cell')
2311 2313
2312 2314 # FIXME: Move the color initialization to the DisplayHook, which
2313 2315 # should be split into a prompt manager and displayhook. We probably
2314 2316 # even need a centralize colors management object.
2315 2317 self.run_line_magic('colors', self.colors)
2316 2318
2317 2319 # Defined here so that it's included in the documentation
2318 2320 @functools.wraps(magic.MagicsManager.register_function)
2319 2321 def register_magic_function(self, func, magic_kind='line', magic_name=None):
2320 2322 self.magics_manager.register_function(
2321 2323 func, magic_kind=magic_kind, magic_name=magic_name
2322 2324 )
2323 2325
2324 2326 def run_line_magic(self, magic_name, line, _stack_depth=1):
2325 2327 """Execute the given line magic.
2326 2328
2327 2329 Parameters
2328 2330 ----------
2329 2331 magic_name : str
2330 2332 Name of the desired magic function, without '%' prefix.
2331 2333 line : str
2332 2334 The rest of the input line as a single string.
2333 2335 _stack_depth : int
2334 2336 If run_line_magic() is called from magic() then _stack_depth=2.
2335 2337 This is added to ensure backward compatibility for use of 'get_ipython().magic()'
2336 2338 """
2337 2339 fn = self.find_line_magic(magic_name)
2338 2340 if fn is None:
2339 2341 cm = self.find_cell_magic(magic_name)
2340 2342 etpl = "Line magic function `%%%s` not found%s."
2341 2343 extra = '' if cm is None else (' (But cell magic `%%%%%s` exists, '
2342 2344 'did you mean that instead?)' % magic_name )
2343 2345 raise UsageError(etpl % (magic_name, extra))
2344 2346 else:
2345 2347 # Note: this is the distance in the stack to the user's frame.
2346 2348 # This will need to be updated if the internal calling logic gets
2347 2349 # refactored, or else we'll be expanding the wrong variables.
2348 2350
2349 2351 # Determine stack_depth depending on where run_line_magic() has been called
2350 2352 stack_depth = _stack_depth
2351 2353 if getattr(fn, magic.MAGIC_NO_VAR_EXPAND_ATTR, False):
2352 2354 # magic has opted out of var_expand
2353 2355 magic_arg_s = line
2354 2356 else:
2355 2357 magic_arg_s = self.var_expand(line, stack_depth)
2356 2358 # Put magic args in a list so we can call with f(*a) syntax
2357 2359 args = [magic_arg_s]
2358 2360 kwargs = {}
2359 2361 # Grab local namespace if we need it:
2360 2362 if getattr(fn, "needs_local_scope", False):
2361 2363 kwargs['local_ns'] = self.get_local_scope(stack_depth)
2362 2364 with self.builtin_trap:
2363 2365 result = fn(*args, **kwargs)
2364 2366 return result
2365 2367
2366 2368 def get_local_scope(self, stack_depth):
2367 2369 """Get local scope at given stack depth.
2368 2370
2369 2371 Parameters
2370 2372 ----------
2371 2373 stack_depth : int
2372 2374 Depth relative to calling frame
2373 2375 """
2374 2376 return sys._getframe(stack_depth + 1).f_locals
2375 2377
2376 2378 def run_cell_magic(self, magic_name, line, cell):
2377 2379 """Execute the given cell magic.
2378 2380
2379 2381 Parameters
2380 2382 ----------
2381 2383 magic_name : str
2382 2384 Name of the desired magic function, without '%' prefix.
2383 2385 line : str
2384 2386 The rest of the first input line as a single string.
2385 2387 cell : str
2386 2388 The body of the cell as a (possibly multiline) string.
2387 2389 """
2388 2390 fn = self.find_cell_magic(magic_name)
2389 2391 if fn is None:
2390 2392 lm = self.find_line_magic(magic_name)
2391 2393 etpl = "Cell magic `%%{0}` not found{1}."
2392 2394 extra = '' if lm is None else (' (But line magic `%{0}` exists, '
2393 2395 'did you mean that instead?)'.format(magic_name))
2394 2396 raise UsageError(etpl.format(magic_name, extra))
2395 2397 elif cell == '':
2396 2398 message = '%%{0} is a cell magic, but the cell body is empty.'.format(magic_name)
2397 2399 if self.find_line_magic(magic_name) is not None:
2398 2400 message += ' Did you mean the line magic %{0} (single %)?'.format(magic_name)
2399 2401 raise UsageError(message)
2400 2402 else:
2401 2403 # Note: this is the distance in the stack to the user's frame.
2402 2404 # This will need to be updated if the internal calling logic gets
2403 2405 # refactored, or else we'll be expanding the wrong variables.
2404 2406 stack_depth = 2
2405 2407 if getattr(fn, magic.MAGIC_NO_VAR_EXPAND_ATTR, False):
2406 2408 # magic has opted out of var_expand
2407 2409 magic_arg_s = line
2408 2410 else:
2409 2411 magic_arg_s = self.var_expand(line, stack_depth)
2410 2412 kwargs = {}
2411 2413 if getattr(fn, "needs_local_scope", False):
2412 2414 kwargs['local_ns'] = self.user_ns
2413 2415
2414 2416 with self.builtin_trap:
2415 2417 args = (magic_arg_s, cell)
2416 2418 result = fn(*args, **kwargs)
2417 2419 return result
2418 2420
2419 2421 def find_line_magic(self, magic_name):
2420 2422 """Find and return a line magic by name.
2421 2423
2422 2424 Returns None if the magic isn't found."""
2423 2425 return self.magics_manager.magics['line'].get(magic_name)
2424 2426
2425 2427 def find_cell_magic(self, magic_name):
2426 2428 """Find and return a cell magic by name.
2427 2429
2428 2430 Returns None if the magic isn't found."""
2429 2431 return self.magics_manager.magics['cell'].get(magic_name)
2430 2432
2431 2433 def find_magic(self, magic_name, magic_kind='line'):
2432 2434 """Find and return a magic of the given type by name.
2433 2435
2434 2436 Returns None if the magic isn't found."""
2435 2437 return self.magics_manager.magics[magic_kind].get(magic_name)
2436 2438
2437 2439 def magic(self, arg_s):
2438 2440 """DEPRECATED. Use run_line_magic() instead.
2439 2441
2440 2442 Call a magic function by name.
2441 2443
2442 2444 Input: a string containing the name of the magic function to call and
2443 2445 any additional arguments to be passed to the magic.
2444 2446
2445 2447 magic('name -opt foo bar') is equivalent to typing at the ipython
2446 2448 prompt:
2447 2449
2448 2450 In[1]: %name -opt foo bar
2449 2451
2450 2452 To call a magic without arguments, simply use magic('name').
2451 2453
2452 2454 This provides a proper Python function to call IPython's magics in any
2453 2455 valid Python code you can type at the interpreter, including loops and
2454 2456 compound statements.
2455 2457 """
2456 2458 # TODO: should we issue a loud deprecation warning here?
2457 2459 magic_name, _, magic_arg_s = arg_s.partition(' ')
2458 2460 magic_name = magic_name.lstrip(prefilter.ESC_MAGIC)
2459 2461 return self.run_line_magic(magic_name, magic_arg_s, _stack_depth=2)
2460 2462
2461 2463 #-------------------------------------------------------------------------
2462 2464 # Things related to macros
2463 2465 #-------------------------------------------------------------------------
2464 2466
2465 2467 def define_macro(self, name, themacro):
2466 2468 """Define a new macro
2467 2469
2468 2470 Parameters
2469 2471 ----------
2470 2472 name : str
2471 2473 The name of the macro.
2472 2474 themacro : str or Macro
2473 2475 The action to do upon invoking the macro. If a string, a new
2474 2476 Macro object is created by passing the string to it.
2475 2477 """
2476 2478
2477 2479 from IPython.core import macro
2478 2480
2479 2481 if isinstance(themacro, str):
2480 2482 themacro = macro.Macro(themacro)
2481 2483 if not isinstance(themacro, macro.Macro):
2482 2484 raise ValueError('A macro must be a string or a Macro instance.')
2483 2485 self.user_ns[name] = themacro
2484 2486
2485 2487 #-------------------------------------------------------------------------
2486 2488 # Things related to the running of system commands
2487 2489 #-------------------------------------------------------------------------
2488 2490
2489 2491 def system_piped(self, cmd):
2490 2492 """Call the given cmd in a subprocess, piping stdout/err
2491 2493
2492 2494 Parameters
2493 2495 ----------
2494 2496 cmd : str
2495 2497 Command to execute (can not end in '&', as background processes are
2496 2498 not supported. Should not be a command that expects input
2497 2499 other than simple text.
2498 2500 """
2499 2501 if cmd.rstrip().endswith('&'):
2500 2502 # this is *far* from a rigorous test
2501 2503 # We do not support backgrounding processes because we either use
2502 2504 # pexpect or pipes to read from. Users can always just call
2503 2505 # os.system() or use ip.system=ip.system_raw
2504 2506 # if they really want a background process.
2505 2507 raise OSError("Background processes not supported.")
2506 2508
2507 2509 # we explicitly do NOT return the subprocess status code, because
2508 2510 # a non-None value would trigger :func:`sys.displayhook` calls.
2509 2511 # Instead, we store the exit_code in user_ns.
2510 2512 self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=1))
2511 2513
2512 2514 def system_raw(self, cmd):
2513 2515 """Call the given cmd in a subprocess using os.system on Windows or
2514 2516 subprocess.call using the system shell on other platforms.
2515 2517
2516 2518 Parameters
2517 2519 ----------
2518 2520 cmd : str
2519 2521 Command to execute.
2520 2522 """
2521 2523 cmd = self.var_expand(cmd, depth=1)
2522 2524 # warn if there is an IPython magic alternative.
2523 2525 main_cmd = cmd.split()[0]
2524 2526 has_magic_alternatives = ("pip", "conda", "cd", "ls")
2525 2527
2526 2528 # had to check if the command was an alias expanded because of `ls`
2527 2529 is_alias_expanded = self.alias_manager.is_alias(main_cmd) and (
2528 2530 self.alias_manager.retrieve_alias(main_cmd).strip() == cmd.strip()
2529 2531 )
2530 2532
2531 2533 if main_cmd in has_magic_alternatives and not is_alias_expanded:
2532 2534 warnings.warn(
2533 2535 (
2534 2536 "You executed the system command !{0} which may not work "
2535 2537 "as expected. Try the IPython magic %{0} instead."
2536 2538 ).format(main_cmd)
2537 2539 )
2538 2540
2539 2541 # protect os.system from UNC paths on Windows, which it can't handle:
2540 2542 if sys.platform == 'win32':
2541 2543 from IPython.utils._process_win32 import AvoidUNCPath
2542 2544 with AvoidUNCPath() as path:
2543 2545 if path is not None:
2544 2546 cmd = '"pushd %s &&"%s' % (path, cmd)
2545 2547 try:
2546 2548 ec = os.system(cmd)
2547 2549 except KeyboardInterrupt:
2548 2550 print('\n' + self.get_exception_only(), file=sys.stderr)
2549 2551 ec = -2
2550 2552 else:
2551 2553 # For posix the result of the subprocess.call() below is an exit
2552 2554 # code, which by convention is zero for success, positive for
2553 2555 # program failure. Exit codes above 128 are reserved for signals,
2554 2556 # and the formula for converting a signal to an exit code is usually
2555 2557 # signal_number+128. To more easily differentiate between exit
2556 2558 # codes and signals, ipython uses negative numbers. For instance
2557 2559 # since control-c is signal 2 but exit code 130, ipython's
2558 2560 # _exit_code variable will read -2. Note that some shells like
2559 2561 # csh and fish don't follow sh/bash conventions for exit codes.
2560 2562 executable = os.environ.get('SHELL', None)
2561 2563 try:
2562 2564 # Use env shell instead of default /bin/sh
2563 2565 ec = subprocess.call(cmd, shell=True, executable=executable)
2564 2566 except KeyboardInterrupt:
2565 2567 # intercept control-C; a long traceback is not useful here
2566 2568 print('\n' + self.get_exception_only(), file=sys.stderr)
2567 2569 ec = 130
2568 2570 if ec > 128:
2569 2571 ec = -(ec - 128)
2570 2572
2571 2573 # We explicitly do NOT return the subprocess status code, because
2572 2574 # a non-None value would trigger :func:`sys.displayhook` calls.
2573 2575 # Instead, we store the exit_code in user_ns. Note the semantics
2574 2576 # of _exit_code: for control-c, _exit_code == -signal.SIGNIT,
2575 2577 # but raising SystemExit(_exit_code) will give status 254!
2576 2578 self.user_ns['_exit_code'] = ec
2577 2579
2578 2580 # use piped system by default, because it is better behaved
2579 2581 system = system_piped
2580 2582
2581 2583 def getoutput(self, cmd, split=True, depth=0):
2582 2584 """Get output (possibly including stderr) from a subprocess.
2583 2585
2584 2586 Parameters
2585 2587 ----------
2586 2588 cmd : str
2587 2589 Command to execute (can not end in '&', as background processes are
2588 2590 not supported.
2589 2591 split : bool, optional
2590 2592 If True, split the output into an IPython SList. Otherwise, an
2591 2593 IPython LSString is returned. These are objects similar to normal
2592 2594 lists and strings, with a few convenience attributes for easier
2593 2595 manipulation of line-based output. You can use '?' on them for
2594 2596 details.
2595 2597 depth : int, optional
2596 2598 How many frames above the caller are the local variables which should
2597 2599 be expanded in the command string? The default (0) assumes that the
2598 2600 expansion variables are in the stack frame calling this function.
2599 2601 """
2600 2602 if cmd.rstrip().endswith('&'):
2601 2603 # this is *far* from a rigorous test
2602 2604 raise OSError("Background processes not supported.")
2603 2605 out = getoutput(self.var_expand(cmd, depth=depth+1))
2604 2606 if split:
2605 2607 out = SList(out.splitlines())
2606 2608 else:
2607 2609 out = LSString(out)
2608 2610 return out
2609 2611
2610 2612 #-------------------------------------------------------------------------
2611 2613 # Things related to aliases
2612 2614 #-------------------------------------------------------------------------
2613 2615
2614 2616 def init_alias(self):
2615 2617 self.alias_manager = AliasManager(shell=self, parent=self)
2616 2618 self.configurables.append(self.alias_manager)
2617 2619
2618 2620 #-------------------------------------------------------------------------
2619 2621 # Things related to extensions
2620 2622 #-------------------------------------------------------------------------
2621 2623
2622 2624 def init_extension_manager(self):
2623 2625 self.extension_manager = ExtensionManager(shell=self, parent=self)
2624 2626 self.configurables.append(self.extension_manager)
2625 2627
2626 2628 #-------------------------------------------------------------------------
2627 2629 # Things related to payloads
2628 2630 #-------------------------------------------------------------------------
2629 2631
2630 2632 def init_payload(self):
2631 2633 self.payload_manager = PayloadManager(parent=self)
2632 2634 self.configurables.append(self.payload_manager)
2633 2635
2634 2636 #-------------------------------------------------------------------------
2635 2637 # Things related to the prefilter
2636 2638 #-------------------------------------------------------------------------
2637 2639
2638 2640 def init_prefilter(self):
2639 2641 self.prefilter_manager = PrefilterManager(shell=self, parent=self)
2640 2642 self.configurables.append(self.prefilter_manager)
2641 2643 # Ultimately this will be refactored in the new interpreter code, but
2642 2644 # for now, we should expose the main prefilter method (there's legacy
2643 2645 # code out there that may rely on this).
2644 2646 self.prefilter = self.prefilter_manager.prefilter_lines
2645 2647
2646 2648 def auto_rewrite_input(self, cmd):
2647 2649 """Print to the screen the rewritten form of the user's command.
2648 2650
2649 2651 This shows visual feedback by rewriting input lines that cause
2650 2652 automatic calling to kick in, like::
2651 2653
2652 2654 /f x
2653 2655
2654 2656 into::
2655 2657
2656 2658 ------> f(x)
2657 2659
2658 2660 after the user's input prompt. This helps the user understand that the
2659 2661 input line was transformed automatically by IPython.
2660 2662 """
2661 2663 if not self.show_rewritten_input:
2662 2664 return
2663 2665
2664 2666 # This is overridden in TerminalInteractiveShell to use fancy prompts
2665 2667 print("------> " + cmd)
2666 2668
2667 2669 #-------------------------------------------------------------------------
2668 2670 # Things related to extracting values/expressions from kernel and user_ns
2669 2671 #-------------------------------------------------------------------------
2670 2672
2671 2673 def _user_obj_error(self):
2672 2674 """return simple exception dict
2673 2675
2674 2676 for use in user_expressions
2675 2677 """
2676 2678
2677 2679 etype, evalue, tb = self._get_exc_info()
2678 2680 stb = self.InteractiveTB.get_exception_only(etype, evalue)
2679 2681
2680 2682 exc_info = {
2681 2683 "status": "error",
2682 2684 "traceback": stb,
2683 2685 "ename": etype.__name__,
2684 2686 "evalue": py3compat.safe_unicode(evalue),
2685 2687 }
2686 2688
2687 2689 return exc_info
2688 2690
2689 2691 def _format_user_obj(self, obj):
2690 2692 """format a user object to display dict
2691 2693
2692 2694 for use in user_expressions
2693 2695 """
2694 2696
2695 2697 data, md = self.display_formatter.format(obj)
2696 2698 value = {
2697 2699 'status' : 'ok',
2698 2700 'data' : data,
2699 2701 'metadata' : md,
2700 2702 }
2701 2703 return value
2702 2704
2703 2705 def user_expressions(self, expressions):
2704 2706 """Evaluate a dict of expressions in the user's namespace.
2705 2707
2706 2708 Parameters
2707 2709 ----------
2708 2710 expressions : dict
2709 2711 A dict with string keys and string values. The expression values
2710 2712 should be valid Python expressions, each of which will be evaluated
2711 2713 in the user namespace.
2712 2714
2713 2715 Returns
2714 2716 -------
2715 2717 A dict, keyed like the input expressions dict, with the rich mime-typed
2716 2718 display_data of each value.
2717 2719 """
2718 2720 out = {}
2719 2721 user_ns = self.user_ns
2720 2722 global_ns = self.user_global_ns
2721 2723
2722 2724 for key, expr in expressions.items():
2723 2725 try:
2724 2726 value = self._format_user_obj(eval(expr, global_ns, user_ns))
2725 2727 except:
2726 2728 value = self._user_obj_error()
2727 2729 out[key] = value
2728 2730 return out
2729 2731
2730 2732 #-------------------------------------------------------------------------
2731 2733 # Things related to the running of code
2732 2734 #-------------------------------------------------------------------------
2733 2735
2734 2736 def ex(self, cmd):
2735 2737 """Execute a normal python statement in user namespace."""
2736 2738 with self.builtin_trap:
2737 2739 exec(cmd, self.user_global_ns, self.user_ns)
2738 2740
2739 2741 def ev(self, expr):
2740 2742 """Evaluate python expression expr in user namespace.
2741 2743
2742 2744 Returns the result of evaluation
2743 2745 """
2744 2746 with self.builtin_trap:
2745 2747 return eval(expr, self.user_global_ns, self.user_ns)
2746 2748
2747 2749 def safe_execfile(self, fname, *where, exit_ignore=False, raise_exceptions=False, shell_futures=False):
2748 2750 """A safe version of the builtin execfile().
2749 2751
2750 2752 This version will never throw an exception, but instead print
2751 2753 helpful error messages to the screen. This only works on pure
2752 2754 Python files with the .py extension.
2753 2755
2754 2756 Parameters
2755 2757 ----------
2756 2758 fname : string
2757 2759 The name of the file to be executed.
2758 2760 where : tuple
2759 2761 One or two namespaces, passed to execfile() as (globals,locals).
2760 2762 If only one is given, it is passed as both.
2761 2763 exit_ignore : bool (False)
2762 2764 If True, then silence SystemExit for non-zero status (it is always
2763 2765 silenced for zero status, as it is so common).
2764 2766 raise_exceptions : bool (False)
2765 2767 If True raise exceptions everywhere. Meant for testing.
2766 2768 shell_futures : bool (False)
2767 2769 If True, the code will share future statements with the interactive
2768 2770 shell. It will both be affected by previous __future__ imports, and
2769 2771 any __future__ imports in the code will affect the shell. If False,
2770 2772 __future__ imports are not shared in either direction.
2771 2773
2772 2774 """
2773 2775 fname = Path(fname).expanduser().resolve()
2774 2776
2775 2777 # Make sure we can open the file
2776 2778 try:
2777 2779 with fname.open():
2778 2780 pass
2779 2781 except:
2780 2782 warn('Could not open file <%s> for safe execution.' % fname)
2781 2783 return
2782 2784
2783 2785 # Find things also in current directory. This is needed to mimic the
2784 2786 # behavior of running a script from the system command line, where
2785 2787 # Python inserts the script's directory into sys.path
2786 2788 dname = str(fname.parent)
2787 2789
2788 2790 with prepended_to_syspath(dname), self.builtin_trap:
2789 2791 try:
2790 2792 glob, loc = (where + (None, ))[:2]
2791 2793 py3compat.execfile(
2792 2794 fname, glob, loc,
2793 2795 self.compile if shell_futures else None)
2794 2796 except SystemExit as status:
2795 2797 # If the call was made with 0 or None exit status (sys.exit(0)
2796 2798 # or sys.exit() ), don't bother showing a traceback, as both of
2797 2799 # these are considered normal by the OS:
2798 2800 # > python -c'import sys;sys.exit(0)'; echo $?
2799 2801 # 0
2800 2802 # > python -c'import sys;sys.exit()'; echo $?
2801 2803 # 0
2802 2804 # For other exit status, we show the exception unless
2803 2805 # explicitly silenced, but only in short form.
2804 2806 if status.code:
2805 2807 if raise_exceptions:
2806 2808 raise
2807 2809 if not exit_ignore:
2808 2810 self.showtraceback(exception_only=True)
2809 2811 except:
2810 2812 if raise_exceptions:
2811 2813 raise
2812 2814 # tb offset is 2 because we wrap execfile
2813 2815 self.showtraceback(tb_offset=2)
2814 2816
2815 2817 def safe_execfile_ipy(self, fname, shell_futures=False, raise_exceptions=False):
2816 2818 """Like safe_execfile, but for .ipy or .ipynb files with IPython syntax.
2817 2819
2818 2820 Parameters
2819 2821 ----------
2820 2822 fname : str
2821 2823 The name of the file to execute. The filename must have a
2822 2824 .ipy or .ipynb extension.
2823 2825 shell_futures : bool (False)
2824 2826 If True, the code will share future statements with the interactive
2825 2827 shell. It will both be affected by previous __future__ imports, and
2826 2828 any __future__ imports in the code will affect the shell. If False,
2827 2829 __future__ imports are not shared in either direction.
2828 2830 raise_exceptions : bool (False)
2829 2831 If True raise exceptions everywhere. Meant for testing.
2830 2832 """
2831 2833 fname = Path(fname).expanduser().resolve()
2832 2834
2833 2835 # Make sure we can open the file
2834 2836 try:
2835 2837 with fname.open():
2836 2838 pass
2837 2839 except:
2838 2840 warn('Could not open file <%s> for safe execution.' % fname)
2839 2841 return
2840 2842
2841 2843 # Find things also in current directory. This is needed to mimic the
2842 2844 # behavior of running a script from the system command line, where
2843 2845 # Python inserts the script's directory into sys.path
2844 2846 dname = str(fname.parent)
2845 2847
2846 2848 def get_cells():
2847 2849 """generator for sequence of code blocks to run"""
2848 2850 if fname.suffix == ".ipynb":
2849 2851 from nbformat import read
2850 2852 nb = read(fname, as_version=4)
2851 2853 if not nb.cells:
2852 2854 return
2853 2855 for cell in nb.cells:
2854 2856 if cell.cell_type == 'code':
2855 2857 yield cell.source
2856 2858 else:
2857 2859 yield fname.read_text()
2858 2860
2859 2861 with prepended_to_syspath(dname):
2860 2862 try:
2861 2863 for cell in get_cells():
2862 2864 result = self.run_cell(cell, silent=True, shell_futures=shell_futures)
2863 2865 if raise_exceptions:
2864 2866 result.raise_error()
2865 2867 elif not result.success:
2866 2868 break
2867 2869 except:
2868 2870 if raise_exceptions:
2869 2871 raise
2870 2872 self.showtraceback()
2871 2873 warn('Unknown failure executing file: <%s>' % fname)
2872 2874
2873 2875 def safe_run_module(self, mod_name, where):
2874 2876 """A safe version of runpy.run_module().
2875 2877
2876 2878 This version will never throw an exception, but instead print
2877 2879 helpful error messages to the screen.
2878 2880
2879 2881 `SystemExit` exceptions with status code 0 or None are ignored.
2880 2882
2881 2883 Parameters
2882 2884 ----------
2883 2885 mod_name : string
2884 2886 The name of the module to be executed.
2885 2887 where : dict
2886 2888 The globals namespace.
2887 2889 """
2888 2890 try:
2889 2891 try:
2890 2892 where.update(
2891 2893 runpy.run_module(str(mod_name), run_name="__main__",
2892 2894 alter_sys=True)
2893 2895 )
2894 2896 except SystemExit as status:
2895 2897 if status.code:
2896 2898 raise
2897 2899 except:
2898 2900 self.showtraceback()
2899 2901 warn('Unknown failure executing module: <%s>' % mod_name)
2900 2902
2901 2903 def run_cell(self, raw_cell, store_history=False, silent=False, shell_futures=True):
2902 2904 """Run a complete IPython cell.
2903 2905
2904 2906 Parameters
2905 2907 ----------
2906 2908 raw_cell : str
2907 2909 The code (including IPython code such as %magic functions) to run.
2908 2910 store_history : bool
2909 2911 If True, the raw and translated cell will be stored in IPython's
2910 2912 history. For user code calling back into IPython's machinery, this
2911 2913 should be set to False.
2912 2914 silent : bool
2913 2915 If True, avoid side-effects, such as implicit displayhooks and
2914 2916 and logging. silent=True forces store_history=False.
2915 2917 shell_futures : bool
2916 2918 If True, the code will share future statements with the interactive
2917 2919 shell. It will both be affected by previous __future__ imports, and
2918 2920 any __future__ imports in the code will affect the shell. If False,
2919 2921 __future__ imports are not shared in either direction.
2920 2922
2921 2923 Returns
2922 2924 -------
2923 2925 result : :class:`ExecutionResult`
2924 2926 """
2925 2927 result = None
2926 2928 try:
2927 2929 result = self._run_cell(
2928 2930 raw_cell, store_history, silent, shell_futures)
2929 2931 finally:
2930 2932 self.events.trigger('post_execute')
2931 2933 if not silent:
2932 2934 self.events.trigger('post_run_cell', result)
2933 2935 return result
2934 2936
2935 2937 def _run_cell(self, raw_cell:str, store_history:bool, silent:bool, shell_futures:bool) -> ExecutionResult:
2936 2938 """Internal method to run a complete IPython cell."""
2937 2939
2938 2940 # we need to avoid calling self.transform_cell multiple time on the same thing
2939 2941 # so we need to store some results:
2940 2942 preprocessing_exc_tuple = None
2941 2943 try:
2942 2944 transformed_cell = self.transform_cell(raw_cell)
2943 2945 except Exception:
2944 2946 transformed_cell = raw_cell
2945 2947 preprocessing_exc_tuple = sys.exc_info()
2946 2948
2947 2949 assert transformed_cell is not None
2948 2950 coro = self.run_cell_async(
2949 2951 raw_cell,
2950 2952 store_history=store_history,
2951 2953 silent=silent,
2952 2954 shell_futures=shell_futures,
2953 2955 transformed_cell=transformed_cell,
2954 2956 preprocessing_exc_tuple=preprocessing_exc_tuple,
2955 2957 )
2956 2958
2957 2959 # run_cell_async is async, but may not actually need an eventloop.
2958 2960 # when this is the case, we want to run it using the pseudo_sync_runner
2959 2961 # so that code can invoke eventloops (for example via the %run , and
2960 2962 # `%paste` magic.
2961 2963 if self.trio_runner:
2962 2964 runner = self.trio_runner
2963 2965 elif self.should_run_async(
2964 2966 raw_cell,
2965 2967 transformed_cell=transformed_cell,
2966 2968 preprocessing_exc_tuple=preprocessing_exc_tuple,
2967 2969 ):
2968 2970 runner = self.loop_runner
2969 2971 else:
2970 2972 runner = _pseudo_sync_runner
2971 2973
2972 2974 try:
2973 2975 return runner(coro)
2974 2976 except BaseException as e:
2975 2977 info = ExecutionInfo(raw_cell, store_history, silent, shell_futures)
2976 2978 result = ExecutionResult(info)
2977 2979 result.error_in_exec = e
2978 2980 self.showtraceback(running_compiled_code=True)
2979 2981 return result
2980 2982
2981 2983 def should_run_async(
2982 2984 self, raw_cell: str, *, transformed_cell=None, preprocessing_exc_tuple=None
2983 2985 ) -> bool:
2984 2986 """Return whether a cell should be run asynchronously via a coroutine runner
2985 2987
2986 2988 Parameters
2987 2989 ----------
2988 2990 raw_cell: str
2989 2991 The code to be executed
2990 2992
2991 2993 Returns
2992 2994 -------
2993 2995 result: bool
2994 2996 Whether the code needs to be run with a coroutine runner or not
2995 2997
2996 2998 .. versionadded: 7.0
2997 2999 """
2998 3000 if not self.autoawait:
2999 3001 return False
3000 3002 if preprocessing_exc_tuple is not None:
3001 3003 return False
3002 3004 assert preprocessing_exc_tuple is None
3003 3005 if transformed_cell is None:
3004 3006 warnings.warn(
3005 3007 "`should_run_async` will not call `transform_cell`"
3006 3008 " automatically in the future. Please pass the result to"
3007 3009 " `transformed_cell` argument and any exception that happen"
3008 3010 " during the"
3009 3011 "transform in `preprocessing_exc_tuple` in"
3010 3012 " IPython 7.17 and above.",
3011 3013 DeprecationWarning,
3012 3014 stacklevel=2,
3013 3015 )
3014 3016 try:
3015 3017 cell = self.transform_cell(raw_cell)
3016 3018 except Exception:
3017 3019 # any exception during transform will be raised
3018 3020 # prior to execution
3019 3021 return False
3020 3022 else:
3021 3023 cell = transformed_cell
3022 3024 return _should_be_async(cell)
3023 3025
3024 3026 async def run_cell_async(
3025 3027 self,
3026 3028 raw_cell: str,
3027 3029 store_history=False,
3028 3030 silent=False,
3029 3031 shell_futures=True,
3030 3032 *,
3031 3033 transformed_cell: Optional[str] = None,
3032 3034 preprocessing_exc_tuple: Optional[Any] = None
3033 3035 ) -> ExecutionResult:
3034 3036 """Run a complete IPython cell asynchronously.
3035 3037
3036 3038 Parameters
3037 3039 ----------
3038 3040 raw_cell : str
3039 3041 The code (including IPython code such as %magic functions) to run.
3040 3042 store_history : bool
3041 3043 If True, the raw and translated cell will be stored in IPython's
3042 3044 history. For user code calling back into IPython's machinery, this
3043 3045 should be set to False.
3044 3046 silent : bool
3045 3047 If True, avoid side-effects, such as implicit displayhooks and
3046 3048 and logging. silent=True forces store_history=False.
3047 3049 shell_futures : bool
3048 3050 If True, the code will share future statements with the interactive
3049 3051 shell. It will both be affected by previous __future__ imports, and
3050 3052 any __future__ imports in the code will affect the shell. If False,
3051 3053 __future__ imports are not shared in either direction.
3052 3054 transformed_cell: str
3053 3055 cell that was passed through transformers
3054 3056 preprocessing_exc_tuple:
3055 3057 trace if the transformation failed.
3056 3058
3057 3059 Returns
3058 3060 -------
3059 3061 result : :class:`ExecutionResult`
3060 3062
3061 3063 .. versionadded: 7.0
3062 3064 """
3063 3065 info = ExecutionInfo(
3064 3066 raw_cell, store_history, silent, shell_futures)
3065 3067 result = ExecutionResult(info)
3066 3068
3067 3069 if (not raw_cell) or raw_cell.isspace():
3068 3070 self.last_execution_succeeded = True
3069 3071 self.last_execution_result = result
3070 3072 return result
3071 3073
3072 3074 if silent:
3073 3075 store_history = False
3074 3076
3075 3077 if store_history:
3076 3078 result.execution_count = self.execution_count
3077 3079
3078 3080 def error_before_exec(value):
3079 3081 if store_history:
3080 3082 self.execution_count += 1
3081 3083 result.error_before_exec = value
3082 3084 self.last_execution_succeeded = False
3083 3085 self.last_execution_result = result
3084 3086 return result
3085 3087
3086 3088 self.events.trigger('pre_execute')
3087 3089 if not silent:
3088 3090 self.events.trigger('pre_run_cell', info)
3089 3091
3090 3092 if transformed_cell is None:
3091 3093 warnings.warn(
3092 3094 "`run_cell_async` will not call `transform_cell`"
3093 3095 " automatically in the future. Please pass the result to"
3094 3096 " `transformed_cell` argument and any exception that happen"
3095 3097 " during the"
3096 3098 "transform in `preprocessing_exc_tuple` in"
3097 3099 " IPython 7.17 and above.",
3098 3100 DeprecationWarning,
3099 3101 stacklevel=2,
3100 3102 )
3101 3103 # If any of our input transformation (input_transformer_manager or
3102 3104 # prefilter_manager) raises an exception, we store it in this variable
3103 3105 # so that we can display the error after logging the input and storing
3104 3106 # it in the history.
3105 3107 try:
3106 3108 cell = self.transform_cell(raw_cell)
3107 3109 except Exception:
3108 3110 preprocessing_exc_tuple = sys.exc_info()
3109 3111 cell = raw_cell # cell has to exist so it can be stored/logged
3110 3112 else:
3111 3113 preprocessing_exc_tuple = None
3112 3114 else:
3113 3115 if preprocessing_exc_tuple is None:
3114 3116 cell = transformed_cell
3115 3117 else:
3116 3118 cell = raw_cell
3117 3119
3118 3120 # Store raw and processed history
3119 3121 if store_history:
3120 3122 self.history_manager.store_inputs(self.execution_count,
3121 3123 cell, raw_cell)
3122 3124 if not silent:
3123 3125 self.logger.log(cell, raw_cell)
3124 3126
3125 3127 # Display the exception if input processing failed.
3126 3128 if preprocessing_exc_tuple is not None:
3127 3129 self.showtraceback(preprocessing_exc_tuple)
3128 3130 if store_history:
3129 3131 self.execution_count += 1
3130 3132 return error_before_exec(preprocessing_exc_tuple[1])
3131 3133
3132 3134 # Our own compiler remembers the __future__ environment. If we want to
3133 3135 # run code with a separate __future__ environment, use the default
3134 3136 # compiler
3135 3137 compiler = self.compile if shell_futures else self.compiler_class()
3136 3138
3137 3139 _run_async = False
3138 3140
3139 3141 with self.builtin_trap:
3140 3142 cell_name = compiler.cache(cell, self.execution_count, raw_code=raw_cell)
3141 3143
3142 3144 with self.display_trap:
3143 3145 # Compile to bytecode
3144 3146 try:
3145 3147 if sys.version_info < (3,8) and self.autoawait:
3146 3148 if _should_be_async(cell):
3147 3149 # the code AST below will not be user code: we wrap it
3148 3150 # in an `async def`. This will likely make some AST
3149 3151 # transformer below miss some transform opportunity and
3150 3152 # introduce a small coupling to run_code (in which we
3151 3153 # bake some assumptions of what _ast_asyncify returns.
3152 3154 # they are ways around (like grafting part of the ast
3153 3155 # later:
3154 3156 # - Here, return code_ast.body[0].body[1:-1], as well
3155 3157 # as last expression in return statement which is
3156 3158 # the user code part.
3157 3159 # - Let it go through the AST transformers, and graft
3158 3160 # - it back after the AST transform
3159 3161 # But that seem unreasonable, at least while we
3160 3162 # do not need it.
3161 3163 code_ast = _ast_asyncify(cell, 'async-def-wrapper')
3162 3164 _run_async = True
3163 3165 else:
3164 3166 code_ast = compiler.ast_parse(cell, filename=cell_name)
3165 3167 else:
3166 3168 code_ast = compiler.ast_parse(cell, filename=cell_name)
3167 3169 except self.custom_exceptions as e:
3168 3170 etype, value, tb = sys.exc_info()
3169 3171 self.CustomTB(etype, value, tb)
3170 3172 return error_before_exec(e)
3171 3173 except IndentationError as e:
3172 3174 self.showindentationerror()
3173 3175 return error_before_exec(e)
3174 3176 except (OverflowError, SyntaxError, ValueError, TypeError,
3175 3177 MemoryError) as e:
3176 3178 self.showsyntaxerror()
3177 3179 return error_before_exec(e)
3178 3180
3179 3181 # Apply AST transformations
3180 3182 try:
3181 3183 code_ast = self.transform_ast(code_ast)
3182 3184 except InputRejected as e:
3183 3185 self.showtraceback()
3184 3186 return error_before_exec(e)
3185 3187
3186 3188 # Give the displayhook a reference to our ExecutionResult so it
3187 3189 # can fill in the output value.
3188 3190 self.displayhook.exec_result = result
3189 3191
3190 3192 # Execute the user code
3191 3193 interactivity = "none" if silent else self.ast_node_interactivity
3192 3194 if _run_async:
3193 3195 interactivity = 'async'
3194 3196
3195 3197 has_raised = await self.run_ast_nodes(code_ast.body, cell_name,
3196 3198 interactivity=interactivity, compiler=compiler, result=result)
3197 3199
3198 3200 self.last_execution_succeeded = not has_raised
3199 3201 self.last_execution_result = result
3200 3202
3201 3203 # Reset this so later displayed values do not modify the
3202 3204 # ExecutionResult
3203 3205 self.displayhook.exec_result = None
3204 3206
3205 3207 if store_history:
3206 3208 # Write output to the database. Does nothing unless
3207 3209 # history output logging is enabled.
3208 3210 self.history_manager.store_output(self.execution_count)
3209 3211 # Each cell is a *single* input, regardless of how many lines it has
3210 3212 self.execution_count += 1
3211 3213
3212 3214 return result
3213 3215
3214 3216 def transform_cell(self, raw_cell):
3215 3217 """Transform an input cell before parsing it.
3216 3218
3217 3219 Static transformations, implemented in IPython.core.inputtransformer2,
3218 3220 deal with things like ``%magic`` and ``!system`` commands.
3219 3221 These run on all input.
3220 3222 Dynamic transformations, for things like unescaped magics and the exit
3221 3223 autocall, depend on the state of the interpreter.
3222 3224 These only apply to single line inputs.
3223 3225
3224 3226 These string-based transformations are followed by AST transformations;
3225 3227 see :meth:`transform_ast`.
3226 3228 """
3227 3229 # Static input transformations
3228 3230 cell = self.input_transformer_manager.transform_cell(raw_cell)
3229 3231
3230 3232 if len(cell.splitlines()) == 1:
3231 3233 # Dynamic transformations - only applied for single line commands
3232 3234 with self.builtin_trap:
3233 3235 # use prefilter_lines to handle trailing newlines
3234 3236 # restore trailing newline for ast.parse
3235 3237 cell = self.prefilter_manager.prefilter_lines(cell) + '\n'
3236 3238
3237 3239 lines = cell.splitlines(keepends=True)
3238 3240 for transform in self.input_transformers_post:
3239 3241 lines = transform(lines)
3240 3242 cell = ''.join(lines)
3241 3243
3242 3244 return cell
3243 3245
3244 3246 def transform_ast(self, node):
3245 3247 """Apply the AST transformations from self.ast_transformers
3246 3248
3247 3249 Parameters
3248 3250 ----------
3249 3251 node : ast.Node
3250 3252 The root node to be transformed. Typically called with the ast.Module
3251 3253 produced by parsing user input.
3252 3254
3253 3255 Returns
3254 3256 -------
3255 3257 An ast.Node corresponding to the node it was called with. Note that it
3256 3258 may also modify the passed object, so don't rely on references to the
3257 3259 original AST.
3258 3260 """
3259 3261 for transformer in self.ast_transformers:
3260 3262 try:
3261 3263 node = transformer.visit(node)
3262 3264 except InputRejected:
3263 3265 # User-supplied AST transformers can reject an input by raising
3264 3266 # an InputRejected. Short-circuit in this case so that we
3265 3267 # don't unregister the transform.
3266 3268 raise
3267 3269 except Exception:
3268 3270 warn("AST transformer %r threw an error. It will be unregistered." % transformer)
3269 3271 self.ast_transformers.remove(transformer)
3270 3272
3271 3273 if self.ast_transformers:
3272 3274 ast.fix_missing_locations(node)
3273 3275 return node
3274 3276
3275 3277 async def run_ast_nodes(self, nodelist:ListType[AST], cell_name:str, interactivity='last_expr',
3276 3278 compiler=compile, result=None):
3277 3279 """Run a sequence of AST nodes. The execution mode depends on the
3278 3280 interactivity parameter.
3279 3281
3280 3282 Parameters
3281 3283 ----------
3282 3284 nodelist : list
3283 3285 A sequence of AST nodes to run.
3284 3286 cell_name : str
3285 3287 Will be passed to the compiler as the filename of the cell. Typically
3286 3288 the value returned by ip.compile.cache(cell).
3287 3289 interactivity : str
3288 3290 'all', 'last', 'last_expr' , 'last_expr_or_assign' or 'none',
3289 3291 specifying which nodes should be run interactively (displaying output
3290 3292 from expressions). 'last_expr' will run the last node interactively
3291 3293 only if it is an expression (i.e. expressions in loops or other blocks
3292 3294 are not displayed) 'last_expr_or_assign' will run the last expression
3293 3295 or the last assignment. Other values for this parameter will raise a
3294 3296 ValueError.
3295 3297
3296 3298 Experimental value: 'async' Will try to run top level interactive
3297 3299 async/await code in default runner, this will not respect the
3298 3300 interactivity setting and will only run the last node if it is an
3299 3301 expression.
3300 3302
3301 3303 compiler : callable
3302 3304 A function with the same interface as the built-in compile(), to turn
3303 3305 the AST nodes into code objects. Default is the built-in compile().
3304 3306 result : ExecutionResult, optional
3305 3307 An object to store exceptions that occur during execution.
3306 3308
3307 3309 Returns
3308 3310 -------
3309 3311 True if an exception occurred while running code, False if it finished
3310 3312 running.
3311 3313 """
3312 3314 if not nodelist:
3313 3315 return
3314 3316
3315 3317 if interactivity == 'last_expr_or_assign':
3316 3318 if isinstance(nodelist[-1], _assign_nodes):
3317 3319 asg = nodelist[-1]
3318 3320 if isinstance(asg, ast.Assign) and len(asg.targets) == 1:
3319 3321 target = asg.targets[0]
3320 3322 elif isinstance(asg, _single_targets_nodes):
3321 3323 target = asg.target
3322 3324 else:
3323 3325 target = None
3324 3326 if isinstance(target, ast.Name):
3325 3327 nnode = ast.Expr(ast.Name(target.id, ast.Load()))
3326 3328 ast.fix_missing_locations(nnode)
3327 3329 nodelist.append(nnode)
3328 3330 interactivity = 'last_expr'
3329 3331
3330 3332 _async = False
3331 3333 if interactivity == 'last_expr':
3332 3334 if isinstance(nodelist[-1], ast.Expr):
3333 3335 interactivity = "last"
3334 3336 else:
3335 3337 interactivity = "none"
3336 3338
3337 3339 if interactivity == 'none':
3338 3340 to_run_exec, to_run_interactive = nodelist, []
3339 3341 elif interactivity == 'last':
3340 3342 to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:]
3341 3343 elif interactivity == 'all':
3342 3344 to_run_exec, to_run_interactive = [], nodelist
3343 3345 elif interactivity == 'async':
3344 3346 to_run_exec, to_run_interactive = [], nodelist
3345 3347 _async = True
3346 3348 else:
3347 3349 raise ValueError("Interactivity was %r" % interactivity)
3348 3350
3349 3351 try:
3350 3352 if _async and sys.version_info > (3,8):
3351 3353 raise ValueError("This branch should never happen on Python 3.8 and above, "
3352 3354 "please try to upgrade IPython and open a bug report with your case.")
3353 3355 if _async:
3354 3356 # If interactivity is async the semantics of run_code are
3355 3357 # completely different Skip usual machinery.
3356 3358 mod = Module(nodelist, [])
3357 3359 async_wrapper_code = compiler(mod, cell_name, 'exec')
3358 3360 exec(async_wrapper_code, self.user_global_ns, self.user_ns)
3359 3361 async_code = removed_co_newlocals(self.user_ns.pop('async-def-wrapper')).__code__
3360 3362 if (await self.run_code(async_code, result, async_=True)):
3361 3363 return True
3362 3364 else:
3363 3365 if sys.version_info > (3, 8):
3364 3366 def compare(code):
3365 3367 is_async = (inspect.CO_COROUTINE & code.co_flags == inspect.CO_COROUTINE)
3366 3368 return is_async
3367 3369 else:
3368 3370 def compare(code):
3369 3371 return _async
3370 3372
3371 3373 # refactor that to just change the mod constructor.
3372 3374 to_run = []
3373 3375 for node in to_run_exec:
3374 3376 to_run.append((node, 'exec'))
3375 3377
3376 3378 for node in to_run_interactive:
3377 3379 to_run.append((node, 'single'))
3378 3380
3379 3381 for node,mode in to_run:
3380 3382 if mode == 'exec':
3381 3383 mod = Module([node], [])
3382 3384 elif mode == 'single':
3383 3385 mod = ast.Interactive([node])
3384 3386 with compiler.extra_flags(getattr(ast, 'PyCF_ALLOW_TOP_LEVEL_AWAIT', 0x0) if self.autoawait else 0x0):
3385 3387 code = compiler(mod, cell_name, mode)
3386 3388 asy = compare(code)
3387 3389 if (await self.run_code(code, result, async_=asy)):
3388 3390 return True
3389 3391
3390 3392 # Flush softspace
3391 3393 if softspace(sys.stdout, 0):
3392 3394 print()
3393 3395
3394 3396 except:
3395 3397 # It's possible to have exceptions raised here, typically by
3396 3398 # compilation of odd code (such as a naked 'return' outside a
3397 3399 # function) that did parse but isn't valid. Typically the exception
3398 3400 # is a SyntaxError, but it's safest just to catch anything and show
3399 3401 # the user a traceback.
3400 3402
3401 3403 # We do only one try/except outside the loop to minimize the impact
3402 3404 # on runtime, and also because if any node in the node list is
3403 3405 # broken, we should stop execution completely.
3404 3406 if result:
3405 3407 result.error_before_exec = sys.exc_info()[1]
3406 3408 self.showtraceback()
3407 3409 return True
3408 3410
3409 3411 return False
3410 3412
3411 3413 def _async_exec(self, code_obj: types.CodeType, user_ns: dict):
3412 3414 """
3413 3415 Evaluate an asynchronous code object using a code runner
3414 3416
3415 3417 Fake asynchronous execution of code_object in a namespace via a proxy namespace.
3416 3418
3417 3419 Returns coroutine object, which can be executed via async loop runner
3418 3420
3419 3421 WARNING: The semantics of `async_exec` are quite different from `exec`,
3420 3422 in particular you can only pass a single namespace. It also return a
3421 3423 handle to the value of the last things returned by code_object.
3422 3424 """
3423 3425
3424 3426 return eval(code_obj, user_ns)
3425 3427
3426 3428 async def run_code(self, code_obj, result=None, *, async_=False):
3427 3429 """Execute a code object.
3428 3430
3429 3431 When an exception occurs, self.showtraceback() is called to display a
3430 3432 traceback.
3431 3433
3432 3434 Parameters
3433 3435 ----------
3434 3436 code_obj : code object
3435 3437 A compiled code object, to be executed
3436 3438 result : ExecutionResult, optional
3437 3439 An object to store exceptions that occur during execution.
3438 3440 async_ : Bool (Experimental)
3439 3441 Attempt to run top-level asynchronous code in a default loop.
3440 3442
3441 3443 Returns
3442 3444 -------
3443 3445 False : successful execution.
3444 3446 True : an error occurred.
3445 3447 """
3446 3448 # special value to say that anything above is IPython and should be
3447 3449 # hidden.
3448 3450 __tracebackhide__ = "__ipython_bottom__"
3449 3451 # Set our own excepthook in case the user code tries to call it
3450 3452 # directly, so that the IPython crash handler doesn't get triggered
3451 3453 old_excepthook, sys.excepthook = sys.excepthook, self.excepthook
3452 3454
3453 3455 # we save the original sys.excepthook in the instance, in case config
3454 3456 # code (such as magics) needs access to it.
3455 3457 self.sys_excepthook = old_excepthook
3456 3458 outflag = True # happens in more places, so it's easier as default
3457 3459 try:
3458 3460 try:
3459 3461 self.hooks.pre_run_code_hook()
3460 3462 if async_ and sys.version_info < (3,8):
3461 3463 last_expr = (await self._async_exec(code_obj, self.user_ns))
3462 3464 code = compile('last_expr', 'fake', "single")
3463 3465 exec(code, {'last_expr': last_expr})
3464 3466 elif async_ :
3465 3467 await eval(code_obj, self.user_global_ns, self.user_ns)
3466 3468 else:
3467 3469 exec(code_obj, self.user_global_ns, self.user_ns)
3468 3470 finally:
3469 3471 # Reset our crash handler in place
3470 3472 sys.excepthook = old_excepthook
3471 3473 except SystemExit as e:
3472 3474 if result is not None:
3473 3475 result.error_in_exec = e
3474 3476 self.showtraceback(exception_only=True)
3475 3477 warn("To exit: use 'exit', 'quit', or Ctrl-D.", stacklevel=1)
3476 3478 except self.custom_exceptions:
3477 3479 etype, value, tb = sys.exc_info()
3478 3480 if result is not None:
3479 3481 result.error_in_exec = value
3480 3482 self.CustomTB(etype, value, tb)
3481 3483 except:
3482 3484 if result is not None:
3483 3485 result.error_in_exec = sys.exc_info()[1]
3484 3486 self.showtraceback(running_compiled_code=True)
3485 3487 else:
3486 3488 outflag = False
3487 3489 return outflag
3488 3490
3489 3491 # For backwards compatibility
3490 3492 runcode = run_code
3491 3493
3492 3494 def check_complete(self, code: str) -> Tuple[str, str]:
3493 3495 """Return whether a block of code is ready to execute, or should be continued
3494 3496
3495 3497 Parameters
3496 3498 ----------
3497 3499 source : string
3498 3500 Python input code, which can be multiline.
3499 3501
3500 3502 Returns
3501 3503 -------
3502 3504 status : str
3503 3505 One of 'complete', 'incomplete', or 'invalid' if source is not a
3504 3506 prefix of valid code.
3505 3507 indent : str
3506 3508 When status is 'incomplete', this is some whitespace to insert on
3507 3509 the next line of the prompt.
3508 3510 """
3509 3511 status, nspaces = self.input_transformer_manager.check_complete(code)
3510 3512 return status, ' ' * (nspaces or 0)
3511 3513
3512 3514 #-------------------------------------------------------------------------
3513 3515 # Things related to GUI support and pylab
3514 3516 #-------------------------------------------------------------------------
3515 3517
3516 3518 active_eventloop = None
3517 3519
3518 3520 def enable_gui(self, gui=None):
3519 3521 raise NotImplementedError('Implement enable_gui in a subclass')
3520 3522
3521 3523 def enable_matplotlib(self, gui=None):
3522 3524 """Enable interactive matplotlib and inline figure support.
3523 3525
3524 3526 This takes the following steps:
3525 3527
3526 3528 1. select the appropriate eventloop and matplotlib backend
3527 3529 2. set up matplotlib for interactive use with that backend
3528 3530 3. configure formatters for inline figure display
3529 3531 4. enable the selected gui eventloop
3530 3532
3531 3533 Parameters
3532 3534 ----------
3533 3535 gui : optional, string
3534 3536 If given, dictates the choice of matplotlib GUI backend to use
3535 3537 (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
3536 3538 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
3537 3539 matplotlib (as dictated by the matplotlib build-time options plus the
3538 3540 user's matplotlibrc configuration file). Note that not all backends
3539 3541 make sense in all contexts, for example a terminal ipython can't
3540 3542 display figures inline.
3541 3543 """
3542 3544 from IPython.core import pylabtools as pt
3543 3545 from matplotlib_inline.backend_inline import configure_inline_support
3544 3546 gui, backend = pt.find_gui_and_backend(gui, self.pylab_gui_select)
3545 3547
3546 3548 if gui != 'inline':
3547 3549 # If we have our first gui selection, store it
3548 3550 if self.pylab_gui_select is None:
3549 3551 self.pylab_gui_select = gui
3550 3552 # Otherwise if they are different
3551 3553 elif gui != self.pylab_gui_select:
3552 3554 print('Warning: Cannot change to a different GUI toolkit: %s.'
3553 3555 ' Using %s instead.' % (gui, self.pylab_gui_select))
3554 3556 gui, backend = pt.find_gui_and_backend(self.pylab_gui_select)
3555 3557
3556 3558 pt.activate_matplotlib(backend)
3557 3559 configure_inline_support(self, backend)
3558 3560
3559 3561 # Now we must activate the gui pylab wants to use, and fix %run to take
3560 3562 # plot updates into account
3561 3563 self.enable_gui(gui)
3562 3564 self.magics_manager.registry['ExecutionMagics'].default_runner = \
3563 3565 pt.mpl_runner(self.safe_execfile)
3564 3566
3565 3567 return gui, backend
3566 3568
3567 3569 def enable_pylab(self, gui=None, import_all=True, welcome_message=False):
3568 3570 """Activate pylab support at runtime.
3569 3571
3570 3572 This turns on support for matplotlib, preloads into the interactive
3571 3573 namespace all of numpy and pylab, and configures IPython to correctly
3572 3574 interact with the GUI event loop. The GUI backend to be used can be
3573 3575 optionally selected with the optional ``gui`` argument.
3574 3576
3575 3577 This method only adds preloading the namespace to InteractiveShell.enable_matplotlib.
3576 3578
3577 3579 Parameters
3578 3580 ----------
3579 3581 gui : optional, string
3580 3582 If given, dictates the choice of matplotlib GUI backend to use
3581 3583 (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
3582 3584 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
3583 3585 matplotlib (as dictated by the matplotlib build-time options plus the
3584 3586 user's matplotlibrc configuration file). Note that not all backends
3585 3587 make sense in all contexts, for example a terminal ipython can't
3586 3588 display figures inline.
3587 3589 import_all : optional, bool, default: True
3588 3590 Whether to do `from numpy import *` and `from pylab import *`
3589 3591 in addition to module imports.
3590 3592 welcome_message : deprecated
3591 3593 This argument is ignored, no welcome message will be displayed.
3592 3594 """
3593 3595 from IPython.core.pylabtools import import_pylab
3594 3596
3595 3597 gui, backend = self.enable_matplotlib(gui)
3596 3598
3597 3599 # We want to prevent the loading of pylab to pollute the user's
3598 3600 # namespace as shown by the %who* magics, so we execute the activation
3599 3601 # code in an empty namespace, and we update *both* user_ns and
3600 3602 # user_ns_hidden with this information.
3601 3603 ns = {}
3602 3604 import_pylab(ns, import_all)
3603 3605 # warn about clobbered names
3604 3606 ignored = {"__builtins__"}
3605 3607 both = set(ns).intersection(self.user_ns).difference(ignored)
3606 3608 clobbered = [ name for name in both if self.user_ns[name] is not ns[name] ]
3607 3609 self.user_ns.update(ns)
3608 3610 self.user_ns_hidden.update(ns)
3609 3611 return gui, backend, clobbered
3610 3612
3611 3613 #-------------------------------------------------------------------------
3612 3614 # Utilities
3613 3615 #-------------------------------------------------------------------------
3614 3616
3615 3617 def var_expand(self, cmd, depth=0, formatter=DollarFormatter()):
3616 3618 """Expand python variables in a string.
3617 3619
3618 3620 The depth argument indicates how many frames above the caller should
3619 3621 be walked to look for the local namespace where to expand variables.
3620 3622
3621 3623 The global namespace for expansion is always the user's interactive
3622 3624 namespace.
3623 3625 """
3624 3626 ns = self.user_ns.copy()
3625 3627 try:
3626 3628 frame = sys._getframe(depth+1)
3627 3629 except ValueError:
3628 3630 # This is thrown if there aren't that many frames on the stack,
3629 3631 # e.g. if a script called run_line_magic() directly.
3630 3632 pass
3631 3633 else:
3632 3634 ns.update(frame.f_locals)
3633 3635
3634 3636 try:
3635 3637 # We have to use .vformat() here, because 'self' is a valid and common
3636 3638 # name, and expanding **ns for .format() would make it collide with
3637 3639 # the 'self' argument of the method.
3638 3640 cmd = formatter.vformat(cmd, args=[], kwargs=ns)
3639 3641 except Exception:
3640 3642 # if formatter couldn't format, just let it go untransformed
3641 3643 pass
3642 3644 return cmd
3643 3645
3644 3646 def mktempfile(self, data=None, prefix='ipython_edit_'):
3645 3647 """Make a new tempfile and return its filename.
3646 3648
3647 3649 This makes a call to tempfile.mkstemp (created in a tempfile.mkdtemp),
3648 3650 but it registers the created filename internally so ipython cleans it up
3649 3651 at exit time.
3650 3652
3651 3653 Optional inputs:
3652 3654
3653 3655 - data(None): if data is given, it gets written out to the temp file
3654 3656 immediately, and the file is closed again."""
3655 3657
3656 3658 dir_path = Path(tempfile.mkdtemp(prefix=prefix))
3657 3659 self.tempdirs.append(dir_path)
3658 3660
3659 3661 handle, filename = tempfile.mkstemp(".py", prefix, dir=str(dir_path))
3660 3662 os.close(handle) # On Windows, there can only be one open handle on a file
3661 3663
3662 3664 file_path = Path(filename)
3663 3665 self.tempfiles.append(file_path)
3664 3666
3665 3667 if data:
3666 3668 file_path.write_text(data)
3667 3669 return filename
3668 3670
3669 3671 @undoc
3670 3672 def write(self,data):
3671 3673 """DEPRECATED: Write a string to the default output"""
3672 3674 warn('InteractiveShell.write() is deprecated, use sys.stdout instead',
3673 3675 DeprecationWarning, stacklevel=2)
3674 3676 sys.stdout.write(data)
3675 3677
3676 3678 @undoc
3677 3679 def write_err(self,data):
3678 3680 """DEPRECATED: Write a string to the default error output"""
3679 3681 warn('InteractiveShell.write_err() is deprecated, use sys.stderr instead',
3680 3682 DeprecationWarning, stacklevel=2)
3681 3683 sys.stderr.write(data)
3682 3684
3683 3685 def ask_yes_no(self, prompt, default=None, interrupt=None):
3684 3686 if self.quiet:
3685 3687 return True
3686 3688 return ask_yes_no(prompt,default,interrupt)
3687 3689
3688 3690 def show_usage(self):
3689 3691 """Show a usage message"""
3690 3692 page.page(IPython.core.usage.interactive_usage)
3691 3693
3692 3694 def extract_input_lines(self, range_str, raw=False):
3693 3695 """Return as a string a set of input history slices.
3694 3696
3695 3697 Parameters
3696 3698 ----------
3697 3699 range_str : str
3698 3700 The set of slices is given as a string, like "~5/6-~4/2 4:8 9",
3699 3701 since this function is for use by magic functions which get their
3700 3702 arguments as strings. The number before the / is the session
3701 3703 number: ~n goes n back from the current session.
3702 3704
3703 3705 If empty string is given, returns history of current session
3704 3706 without the last input.
3705 3707
3706 3708 raw : bool, optional
3707 3709 By default, the processed input is used. If this is true, the raw
3708 3710 input history is used instead.
3709 3711
3710 3712 Notes
3711 3713 -----
3712 3714
3713 3715 Slices can be described with two notations:
3714 3716
3715 3717 * ``N:M`` -> standard python form, means including items N...(M-1).
3716 3718 * ``N-M`` -> include items N..M (closed endpoint).
3717 3719 """
3718 3720 lines = self.history_manager.get_range_by_str(range_str, raw=raw)
3719 3721 text = "\n".join(x for _, _, x in lines)
3720 3722
3721 3723 # Skip the last line, as it's probably the magic that called this
3722 3724 if not range_str:
3723 3725 if "\n" not in text:
3724 3726 text = ""
3725 3727 else:
3726 3728 text = text[: text.rfind("\n")]
3727 3729
3728 3730 return text
3729 3731
3730 3732 def find_user_code(self, target, raw=True, py_only=False, skip_encoding_cookie=True, search_ns=False):
3731 3733 """Get a code string from history, file, url, or a string or macro.
3732 3734
3733 3735 This is mainly used by magic functions.
3734 3736
3735 3737 Parameters
3736 3738 ----------
3737 3739 target : str
3738 3740 A string specifying code to retrieve. This will be tried respectively
3739 3741 as: ranges of input history (see %history for syntax), url,
3740 3742 corresponding .py file, filename, or an expression evaluating to a
3741 3743 string or Macro in the user namespace.
3742 3744
3743 3745 If empty string is given, returns complete history of current
3744 3746 session, without the last line.
3745 3747
3746 3748 raw : bool
3747 3749 If true (default), retrieve raw history. Has no effect on the other
3748 3750 retrieval mechanisms.
3749 3751
3750 3752 py_only : bool (default False)
3751 3753 Only try to fetch python code, do not try alternative methods to decode file
3752 3754 if unicode fails.
3753 3755
3754 3756 Returns
3755 3757 -------
3756 3758 A string of code.
3757 3759
3758 3760 ValueError is raised if nothing is found, and TypeError if it evaluates
3759 3761 to an object of another type. In each case, .args[0] is a printable
3760 3762 message.
3761 3763 """
3762 3764 code = self.extract_input_lines(target, raw=raw) # Grab history
3763 3765 if code:
3764 3766 return code
3765 3767 try:
3766 3768 if target.startswith(('http://', 'https://')):
3767 3769 return openpy.read_py_url(target, skip_encoding_cookie=skip_encoding_cookie)
3768 3770 except UnicodeDecodeError as e:
3769 3771 if not py_only :
3770 3772 # Deferred import
3771 3773 from urllib.request import urlopen
3772 3774 response = urlopen(target)
3773 3775 return response.read().decode('latin1')
3774 3776 raise ValueError(("'%s' seem to be unreadable.") % target) from e
3775 3777
3776 3778 potential_target = [target]
3777 3779 try :
3778 3780 potential_target.insert(0,get_py_filename(target))
3779 3781 except IOError:
3780 3782 pass
3781 3783
3782 3784 for tgt in potential_target :
3783 3785 if os.path.isfile(tgt): # Read file
3784 3786 try :
3785 3787 return openpy.read_py_file(tgt, skip_encoding_cookie=skip_encoding_cookie)
3786 3788 except UnicodeDecodeError as e:
3787 3789 if not py_only :
3788 3790 with io_open(tgt,'r', encoding='latin1') as f :
3789 3791 return f.read()
3790 3792 raise ValueError(("'%s' seem to be unreadable.") % target) from e
3791 3793 elif os.path.isdir(os.path.expanduser(tgt)):
3792 3794 raise ValueError("'%s' is a directory, not a regular file." % target)
3793 3795
3794 3796 if search_ns:
3795 3797 # Inspect namespace to load object source
3796 3798 object_info = self.object_inspect(target, detail_level=1)
3797 3799 if object_info['found'] and object_info['source']:
3798 3800 return object_info['source']
3799 3801
3800 3802 try: # User namespace
3801 3803 codeobj = eval(target, self.user_ns)
3802 3804 except Exception as e:
3803 3805 raise ValueError(("'%s' was not found in history, as a file, url, "
3804 3806 "nor in the user namespace.") % target) from e
3805 3807
3806 3808 if isinstance(codeobj, str):
3807 3809 return codeobj
3808 3810 elif isinstance(codeobj, Macro):
3809 3811 return codeobj.value
3810 3812
3811 3813 raise TypeError("%s is neither a string nor a macro." % target,
3812 3814 codeobj)
3813 3815
3814 3816 def _atexit_once(self):
3815 3817 """
3816 3818 At exist operation that need to be called at most once.
3817 3819 Second call to this function per instance will do nothing.
3818 3820 """
3819 3821
3820 3822 if not getattr(self, "_atexit_once_called", False):
3821 3823 self._atexit_once_called = True
3822 3824 # Clear all user namespaces to release all references cleanly.
3823 3825 self.reset(new_session=False)
3824 3826 # Close the history session (this stores the end time and line count)
3825 3827 # this must be *before* the tempfile cleanup, in case of temporary
3826 3828 # history db
3827 3829 self.history_manager.end_session()
3828 3830 self.history_manager = None
3829 3831
3830 3832 #-------------------------------------------------------------------------
3831 3833 # Things related to IPython exiting
3832 3834 #-------------------------------------------------------------------------
3833 3835 def atexit_operations(self):
3834 3836 """This will be executed at the time of exit.
3835 3837
3836 3838 Cleanup operations and saving of persistent data that is done
3837 3839 unconditionally by IPython should be performed here.
3838 3840
3839 3841 For things that may depend on startup flags or platform specifics (such
3840 3842 as having readline or not), register a separate atexit function in the
3841 3843 code that has the appropriate information, rather than trying to
3842 3844 clutter
3843 3845 """
3844 3846 self._atexit_once()
3845 3847
3846 3848 # Cleanup all tempfiles and folders left around
3847 3849 for tfile in self.tempfiles:
3848 3850 try:
3849 3851 tfile.unlink()
3850 3852 self.tempfiles.remove(tfile)
3851 3853 except FileNotFoundError:
3852 3854 pass
3853 3855 del self.tempfiles
3854 3856 for tdir in self.tempdirs:
3855 3857 try:
3856 3858 tdir.rmdir()
3857 3859 self.tempdirs.remove(tdir)
3858 3860 except FileNotFoundError:
3859 3861 pass
3860 3862 del self.tempdirs
3861 3863
3862 3864
3863 3865 # Run user hooks
3864 3866 self.hooks.shutdown_hook()
3865 3867
3866 3868 def cleanup(self):
3867 3869 self.restore_sys_module_state()
3868 3870
3869 3871
3870 3872 # Overridden in terminal subclass to change prompts
3871 3873 def switch_doctest_mode(self, mode):
3872 3874 pass
3873 3875
3874 3876
3875 3877 class InteractiveShellABC(metaclass=abc.ABCMeta):
3876 3878 """An abstract base class for InteractiveShell."""
3877 3879
3878 3880 InteractiveShellABC.register(InteractiveShell)
General Comments 0
You need to be logged in to leave comments. Login now