##// END OF EJS Templates
Use pathlib comparison over string comparison
Mithil Poojary -
Show More
@@ -1,3880 +1,3879 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 if str(p_venv).startswith("\\cygdrive"):
927 p_venv = Path(str(p_venv))
926 if p_venv.parts[1] == "cygdrive":
928 927 drive_name = p_venv.parts[2]
929 928 p_venv = (drive_name + ":/") / Path(*p_venv.parts[3:])
930 929
931 930 if any(p_venv == p.parents[1] for p in paths):
932 931 # Our exe is inside or has access to the virtualenv, don't need to do anything.
933 932 return
934 933
935 934 if sys.platform == "win32":
936 935 virtual_env = Path(os.environ["VIRTUAL_ENV"], "Lib", "site-packages")
937 936 else:
938 937 virtual_env_path = Path(
939 938 os.environ["VIRTUAL_ENV"], "lib", "python{}.{}", "site-packages"
940 939 )
941 940 p_ver = sys.version_info[:2]
942 941
943 942 # Predict version from py[thon]-x.x in the $VIRTUAL_ENV
944 943 re_m = re.search(r"\bpy(?:thon)?([23])\.(\d+)\b", os.environ["VIRTUAL_ENV"])
945 944 if re_m:
946 945 predicted_path = Path(str(virtual_env_path).format(*re_m.groups()))
947 946 if predicted_path.exists():
948 947 p_ver = re_m.groups()
949 948
950 949 virtual_env = str(virtual_env_path).format(*p_ver)
951 950
952 951 warn(
953 952 "Attempting to work in a virtualenv. If you encounter problems, "
954 953 "please install IPython inside the virtualenv."
955 954 )
956 955 import site
957 956 sys.path.insert(0, virtual_env)
958 957 site.addsitedir(virtual_env)
959 958
960 959 #-------------------------------------------------------------------------
961 960 # Things related to injections into the sys module
962 961 #-------------------------------------------------------------------------
963 962
964 963 def save_sys_module_state(self):
965 964 """Save the state of hooks in the sys module.
966 965
967 966 This has to be called after self.user_module is created.
968 967 """
969 968 self._orig_sys_module_state = {'stdin': sys.stdin,
970 969 'stdout': sys.stdout,
971 970 'stderr': sys.stderr,
972 971 'excepthook': sys.excepthook}
973 972 self._orig_sys_modules_main_name = self.user_module.__name__
974 973 self._orig_sys_modules_main_mod = sys.modules.get(self.user_module.__name__)
975 974
976 975 def restore_sys_module_state(self):
977 976 """Restore the state of the sys module."""
978 977 try:
979 978 for k, v in self._orig_sys_module_state.items():
980 979 setattr(sys, k, v)
981 980 except AttributeError:
982 981 pass
983 982 # Reset what what done in self.init_sys_modules
984 983 if self._orig_sys_modules_main_mod is not None:
985 984 sys.modules[self._orig_sys_modules_main_name] = self._orig_sys_modules_main_mod
986 985
987 986 #-------------------------------------------------------------------------
988 987 # Things related to the banner
989 988 #-------------------------------------------------------------------------
990 989
991 990 @property
992 991 def banner(self):
993 992 banner = self.banner1
994 993 if self.profile and self.profile != 'default':
995 994 banner += '\nIPython profile: %s\n' % self.profile
996 995 if self.banner2:
997 996 banner += '\n' + self.banner2
998 997 return banner
999 998
1000 999 def show_banner(self, banner=None):
1001 1000 if banner is None:
1002 1001 banner = self.banner
1003 1002 sys.stdout.write(banner)
1004 1003
1005 1004 #-------------------------------------------------------------------------
1006 1005 # Things related to hooks
1007 1006 #-------------------------------------------------------------------------
1008 1007
1009 1008 def init_hooks(self):
1010 1009 # hooks holds pointers used for user-side customizations
1011 1010 self.hooks = Struct()
1012 1011
1013 1012 self.strdispatchers = {}
1014 1013
1015 1014 # Set all default hooks, defined in the IPython.hooks module.
1016 1015 hooks = IPython.core.hooks
1017 1016 for hook_name in hooks.__all__:
1018 1017 # default hooks have priority 100, i.e. low; user hooks should have
1019 1018 # 0-100 priority
1020 1019 self.set_hook(hook_name,getattr(hooks,hook_name), 100, _warn_deprecated=False)
1021 1020
1022 1021 if self.display_page:
1023 1022 self.set_hook('show_in_pager', page.as_hook(page.display_page), 90)
1024 1023
1025 1024 def set_hook(self,name,hook, priority=50, str_key=None, re_key=None,
1026 1025 _warn_deprecated=True):
1027 1026 """set_hook(name,hook) -> sets an internal IPython hook.
1028 1027
1029 1028 IPython exposes some of its internal API as user-modifiable hooks. By
1030 1029 adding your function to one of these hooks, you can modify IPython's
1031 1030 behavior to call at runtime your own routines."""
1032 1031
1033 1032 # At some point in the future, this should validate the hook before it
1034 1033 # accepts it. Probably at least check that the hook takes the number
1035 1034 # of args it's supposed to.
1036 1035
1037 1036 f = types.MethodType(hook,self)
1038 1037
1039 1038 # check if the hook is for strdispatcher first
1040 1039 if str_key is not None:
1041 1040 sdp = self.strdispatchers.get(name, StrDispatch())
1042 1041 sdp.add_s(str_key, f, priority )
1043 1042 self.strdispatchers[name] = sdp
1044 1043 return
1045 1044 if re_key is not None:
1046 1045 sdp = self.strdispatchers.get(name, StrDispatch())
1047 1046 sdp.add_re(re.compile(re_key), f, priority )
1048 1047 self.strdispatchers[name] = sdp
1049 1048 return
1050 1049
1051 1050 dp = getattr(self.hooks, name, None)
1052 1051 if name not in IPython.core.hooks.__all__:
1053 1052 print("Warning! Hook '%s' is not one of %s" % \
1054 1053 (name, IPython.core.hooks.__all__ ))
1055 1054
1056 1055 if _warn_deprecated and (name in IPython.core.hooks.deprecated):
1057 1056 alternative = IPython.core.hooks.deprecated[name]
1058 1057 warn("Hook {} is deprecated. Use {} instead.".format(name, alternative), stacklevel=2)
1059 1058
1060 1059 if not dp:
1061 1060 dp = IPython.core.hooks.CommandChainDispatcher()
1062 1061
1063 1062 try:
1064 1063 dp.add(f,priority)
1065 1064 except AttributeError:
1066 1065 # it was not commandchain, plain old func - replace
1067 1066 dp = f
1068 1067
1069 1068 setattr(self.hooks,name, dp)
1070 1069
1071 1070 #-------------------------------------------------------------------------
1072 1071 # Things related to events
1073 1072 #-------------------------------------------------------------------------
1074 1073
1075 1074 def init_events(self):
1076 1075 self.events = EventManager(self, available_events)
1077 1076
1078 1077 self.events.register("pre_execute", self._clear_warning_registry)
1079 1078
1080 1079 def register_post_execute(self, func):
1081 1080 """DEPRECATED: Use ip.events.register('post_run_cell', func)
1082 1081
1083 1082 Register a function for calling after code execution.
1084 1083 """
1085 1084 warn("ip.register_post_execute is deprecated, use "
1086 1085 "ip.events.register('post_run_cell', func) instead.", stacklevel=2)
1087 1086 self.events.register('post_run_cell', func)
1088 1087
1089 1088 def _clear_warning_registry(self):
1090 1089 # clear the warning registry, so that different code blocks with
1091 1090 # overlapping line number ranges don't cause spurious suppression of
1092 1091 # warnings (see gh-6611 for details)
1093 1092 if "__warningregistry__" in self.user_global_ns:
1094 1093 del self.user_global_ns["__warningregistry__"]
1095 1094
1096 1095 #-------------------------------------------------------------------------
1097 1096 # Things related to the "main" module
1098 1097 #-------------------------------------------------------------------------
1099 1098
1100 1099 def new_main_mod(self, filename, modname):
1101 1100 """Return a new 'main' module object for user code execution.
1102 1101
1103 1102 ``filename`` should be the path of the script which will be run in the
1104 1103 module. Requests with the same filename will get the same module, with
1105 1104 its namespace cleared.
1106 1105
1107 1106 ``modname`` should be the module name - normally either '__main__' or
1108 1107 the basename of the file without the extension.
1109 1108
1110 1109 When scripts are executed via %run, we must keep a reference to their
1111 1110 __main__ module around so that Python doesn't
1112 1111 clear it, rendering references to module globals useless.
1113 1112
1114 1113 This method keeps said reference in a private dict, keyed by the
1115 1114 absolute path of the script. This way, for multiple executions of the
1116 1115 same script we only keep one copy of the namespace (the last one),
1117 1116 thus preventing memory leaks from old references while allowing the
1118 1117 objects from the last execution to be accessible.
1119 1118 """
1120 1119 filename = os.path.abspath(filename)
1121 1120 try:
1122 1121 main_mod = self._main_mod_cache[filename]
1123 1122 except KeyError:
1124 1123 main_mod = self._main_mod_cache[filename] = types.ModuleType(
1125 1124 modname,
1126 1125 doc="Module created for script run in IPython")
1127 1126 else:
1128 1127 main_mod.__dict__.clear()
1129 1128 main_mod.__name__ = modname
1130 1129
1131 1130 main_mod.__file__ = filename
1132 1131 # It seems pydoc (and perhaps others) needs any module instance to
1133 1132 # implement a __nonzero__ method
1134 1133 main_mod.__nonzero__ = lambda : True
1135 1134
1136 1135 return main_mod
1137 1136
1138 1137 def clear_main_mod_cache(self):
1139 1138 """Clear the cache of main modules.
1140 1139
1141 1140 Mainly for use by utilities like %reset.
1142 1141
1143 1142 Examples
1144 1143 --------
1145 1144 In [15]: import IPython
1146 1145
1147 1146 In [16]: m = _ip.new_main_mod(IPython.__file__, 'IPython')
1148 1147
1149 1148 In [17]: len(_ip._main_mod_cache) > 0
1150 1149 Out[17]: True
1151 1150
1152 1151 In [18]: _ip.clear_main_mod_cache()
1153 1152
1154 1153 In [19]: len(_ip._main_mod_cache) == 0
1155 1154 Out[19]: True
1156 1155 """
1157 1156 self._main_mod_cache.clear()
1158 1157
1159 1158 #-------------------------------------------------------------------------
1160 1159 # Things related to debugging
1161 1160 #-------------------------------------------------------------------------
1162 1161
1163 1162 def init_pdb(self):
1164 1163 # Set calling of pdb on exceptions
1165 1164 # self.call_pdb is a property
1166 1165 self.call_pdb = self.pdb
1167 1166
1168 1167 def _get_call_pdb(self):
1169 1168 return self._call_pdb
1170 1169
1171 1170 def _set_call_pdb(self,val):
1172 1171
1173 1172 if val not in (0,1,False,True):
1174 1173 raise ValueError('new call_pdb value must be boolean')
1175 1174
1176 1175 # store value in instance
1177 1176 self._call_pdb = val
1178 1177
1179 1178 # notify the actual exception handlers
1180 1179 self.InteractiveTB.call_pdb = val
1181 1180
1182 1181 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
1183 1182 'Control auto-activation of pdb at exceptions')
1184 1183
1185 1184 def debugger(self,force=False):
1186 1185 """Call the pdb debugger.
1187 1186
1188 1187 Keywords:
1189 1188
1190 1189 - force(False): by default, this routine checks the instance call_pdb
1191 1190 flag and does not actually invoke the debugger if the flag is false.
1192 1191 The 'force' option forces the debugger to activate even if the flag
1193 1192 is false.
1194 1193 """
1195 1194
1196 1195 if not (force or self.call_pdb):
1197 1196 return
1198 1197
1199 1198 if not hasattr(sys,'last_traceback'):
1200 1199 error('No traceback has been produced, nothing to debug.')
1201 1200 return
1202 1201
1203 1202 self.InteractiveTB.debugger(force=True)
1204 1203
1205 1204 #-------------------------------------------------------------------------
1206 1205 # Things related to IPython's various namespaces
1207 1206 #-------------------------------------------------------------------------
1208 1207 default_user_namespaces = True
1209 1208
1210 1209 def init_create_namespaces(self, user_module=None, user_ns=None):
1211 1210 # Create the namespace where the user will operate. user_ns is
1212 1211 # normally the only one used, and it is passed to the exec calls as
1213 1212 # the locals argument. But we do carry a user_global_ns namespace
1214 1213 # given as the exec 'globals' argument, This is useful in embedding
1215 1214 # situations where the ipython shell opens in a context where the
1216 1215 # distinction between locals and globals is meaningful. For
1217 1216 # non-embedded contexts, it is just the same object as the user_ns dict.
1218 1217
1219 1218 # FIXME. For some strange reason, __builtins__ is showing up at user
1220 1219 # level as a dict instead of a module. This is a manual fix, but I
1221 1220 # should really track down where the problem is coming from. Alex
1222 1221 # Schmolck reported this problem first.
1223 1222
1224 1223 # A useful post by Alex Martelli on this topic:
1225 1224 # Re: inconsistent value from __builtins__
1226 1225 # Von: Alex Martelli <aleaxit@yahoo.com>
1227 1226 # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends
1228 1227 # Gruppen: comp.lang.python
1229 1228
1230 1229 # Michael Hohn <hohn@hooknose.lbl.gov> wrote:
1231 1230 # > >>> print type(builtin_check.get_global_binding('__builtins__'))
1232 1231 # > <type 'dict'>
1233 1232 # > >>> print type(__builtins__)
1234 1233 # > <type 'module'>
1235 1234 # > Is this difference in return value intentional?
1236 1235
1237 1236 # Well, it's documented that '__builtins__' can be either a dictionary
1238 1237 # or a module, and it's been that way for a long time. Whether it's
1239 1238 # intentional (or sensible), I don't know. In any case, the idea is
1240 1239 # that if you need to access the built-in namespace directly, you
1241 1240 # should start with "import __builtin__" (note, no 's') which will
1242 1241 # definitely give you a module. Yeah, it's somewhat confusing:-(.
1243 1242
1244 1243 # These routines return a properly built module and dict as needed by
1245 1244 # the rest of the code, and can also be used by extension writers to
1246 1245 # generate properly initialized namespaces.
1247 1246 if (user_ns is not None) or (user_module is not None):
1248 1247 self.default_user_namespaces = False
1249 1248 self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns)
1250 1249
1251 1250 # A record of hidden variables we have added to the user namespace, so
1252 1251 # we can list later only variables defined in actual interactive use.
1253 1252 self.user_ns_hidden = {}
1254 1253
1255 1254 # Now that FakeModule produces a real module, we've run into a nasty
1256 1255 # problem: after script execution (via %run), the module where the user
1257 1256 # code ran is deleted. Now that this object is a true module (needed
1258 1257 # so doctest and other tools work correctly), the Python module
1259 1258 # teardown mechanism runs over it, and sets to None every variable
1260 1259 # present in that module. Top-level references to objects from the
1261 1260 # script survive, because the user_ns is updated with them. However,
1262 1261 # calling functions defined in the script that use other things from
1263 1262 # the script will fail, because the function's closure had references
1264 1263 # to the original objects, which are now all None. So we must protect
1265 1264 # these modules from deletion by keeping a cache.
1266 1265 #
1267 1266 # To avoid keeping stale modules around (we only need the one from the
1268 1267 # last run), we use a dict keyed with the full path to the script, so
1269 1268 # only the last version of the module is held in the cache. Note,
1270 1269 # however, that we must cache the module *namespace contents* (their
1271 1270 # __dict__). Because if we try to cache the actual modules, old ones
1272 1271 # (uncached) could be destroyed while still holding references (such as
1273 1272 # those held by GUI objects that tend to be long-lived)>
1274 1273 #
1275 1274 # The %reset command will flush this cache. See the cache_main_mod()
1276 1275 # and clear_main_mod_cache() methods for details on use.
1277 1276
1278 1277 # This is the cache used for 'main' namespaces
1279 1278 self._main_mod_cache = {}
1280 1279
1281 1280 # A table holding all the namespaces IPython deals with, so that
1282 1281 # introspection facilities can search easily.
1283 1282 self.ns_table = {'user_global':self.user_module.__dict__,
1284 1283 'user_local':self.user_ns,
1285 1284 'builtin':builtin_mod.__dict__
1286 1285 }
1287 1286
1288 1287 @property
1289 1288 def user_global_ns(self):
1290 1289 return self.user_module.__dict__
1291 1290
1292 1291 def prepare_user_module(self, user_module=None, user_ns=None):
1293 1292 """Prepare the module and namespace in which user code will be run.
1294 1293
1295 1294 When IPython is started normally, both parameters are None: a new module
1296 1295 is created automatically, and its __dict__ used as the namespace.
1297 1296
1298 1297 If only user_module is provided, its __dict__ is used as the namespace.
1299 1298 If only user_ns is provided, a dummy module is created, and user_ns
1300 1299 becomes the global namespace. If both are provided (as they may be
1301 1300 when embedding), user_ns is the local namespace, and user_module
1302 1301 provides the global namespace.
1303 1302
1304 1303 Parameters
1305 1304 ----------
1306 1305 user_module : module, optional
1307 1306 The current user module in which IPython is being run. If None,
1308 1307 a clean module will be created.
1309 1308 user_ns : dict, optional
1310 1309 A namespace in which to run interactive commands.
1311 1310
1312 1311 Returns
1313 1312 -------
1314 1313 A tuple of user_module and user_ns, each properly initialised.
1315 1314 """
1316 1315 if user_module is None and user_ns is not None:
1317 1316 user_ns.setdefault("__name__", "__main__")
1318 1317 user_module = DummyMod()
1319 1318 user_module.__dict__ = user_ns
1320 1319
1321 1320 if user_module is None:
1322 1321 user_module = types.ModuleType("__main__",
1323 1322 doc="Automatically created module for IPython interactive environment")
1324 1323
1325 1324 # We must ensure that __builtin__ (without the final 's') is always
1326 1325 # available and pointing to the __builtin__ *module*. For more details:
1327 1326 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1328 1327 user_module.__dict__.setdefault('__builtin__', builtin_mod)
1329 1328 user_module.__dict__.setdefault('__builtins__', builtin_mod)
1330 1329
1331 1330 if user_ns is None:
1332 1331 user_ns = user_module.__dict__
1333 1332
1334 1333 return user_module, user_ns
1335 1334
1336 1335 def init_sys_modules(self):
1337 1336 # We need to insert into sys.modules something that looks like a
1338 1337 # module but which accesses the IPython namespace, for shelve and
1339 1338 # pickle to work interactively. Normally they rely on getting
1340 1339 # everything out of __main__, but for embedding purposes each IPython
1341 1340 # instance has its own private namespace, so we can't go shoving
1342 1341 # everything into __main__.
1343 1342
1344 1343 # note, however, that we should only do this for non-embedded
1345 1344 # ipythons, which really mimic the __main__.__dict__ with their own
1346 1345 # namespace. Embedded instances, on the other hand, should not do
1347 1346 # this because they need to manage the user local/global namespaces
1348 1347 # only, but they live within a 'normal' __main__ (meaning, they
1349 1348 # shouldn't overtake the execution environment of the script they're
1350 1349 # embedded in).
1351 1350
1352 1351 # This is overridden in the InteractiveShellEmbed subclass to a no-op.
1353 1352 main_name = self.user_module.__name__
1354 1353 sys.modules[main_name] = self.user_module
1355 1354
1356 1355 def init_user_ns(self):
1357 1356 """Initialize all user-visible namespaces to their minimum defaults.
1358 1357
1359 1358 Certain history lists are also initialized here, as they effectively
1360 1359 act as user namespaces.
1361 1360
1362 1361 Notes
1363 1362 -----
1364 1363 All data structures here are only filled in, they are NOT reset by this
1365 1364 method. If they were not empty before, data will simply be added to
1366 1365 them.
1367 1366 """
1368 1367 # This function works in two parts: first we put a few things in
1369 1368 # user_ns, and we sync that contents into user_ns_hidden so that these
1370 1369 # initial variables aren't shown by %who. After the sync, we add the
1371 1370 # rest of what we *do* want the user to see with %who even on a new
1372 1371 # session (probably nothing, so they really only see their own stuff)
1373 1372
1374 1373 # The user dict must *always* have a __builtin__ reference to the
1375 1374 # Python standard __builtin__ namespace, which must be imported.
1376 1375 # This is so that certain operations in prompt evaluation can be
1377 1376 # reliably executed with builtins. Note that we can NOT use
1378 1377 # __builtins__ (note the 's'), because that can either be a dict or a
1379 1378 # module, and can even mutate at runtime, depending on the context
1380 1379 # (Python makes no guarantees on it). In contrast, __builtin__ is
1381 1380 # always a module object, though it must be explicitly imported.
1382 1381
1383 1382 # For more details:
1384 1383 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1385 1384 ns = {}
1386 1385
1387 1386 # make global variables for user access to the histories
1388 1387 ns['_ih'] = self.history_manager.input_hist_parsed
1389 1388 ns['_oh'] = self.history_manager.output_hist
1390 1389 ns['_dh'] = self.history_manager.dir_hist
1391 1390
1392 1391 # user aliases to input and output histories. These shouldn't show up
1393 1392 # in %who, as they can have very large reprs.
1394 1393 ns['In'] = self.history_manager.input_hist_parsed
1395 1394 ns['Out'] = self.history_manager.output_hist
1396 1395
1397 1396 # Store myself as the public api!!!
1398 1397 ns['get_ipython'] = self.get_ipython
1399 1398
1400 1399 ns['exit'] = self.exiter
1401 1400 ns['quit'] = self.exiter
1402 1401
1403 1402 # Sync what we've added so far to user_ns_hidden so these aren't seen
1404 1403 # by %who
1405 1404 self.user_ns_hidden.update(ns)
1406 1405
1407 1406 # Anything put into ns now would show up in %who. Think twice before
1408 1407 # putting anything here, as we really want %who to show the user their
1409 1408 # stuff, not our variables.
1410 1409
1411 1410 # Finally, update the real user's namespace
1412 1411 self.user_ns.update(ns)
1413 1412
1414 1413 @property
1415 1414 def all_ns_refs(self):
1416 1415 """Get a list of references to all the namespace dictionaries in which
1417 1416 IPython might store a user-created object.
1418 1417
1419 1418 Note that this does not include the displayhook, which also caches
1420 1419 objects from the output."""
1421 1420 return [self.user_ns, self.user_global_ns, self.user_ns_hidden] + \
1422 1421 [m.__dict__ for m in self._main_mod_cache.values()]
1423 1422
1424 1423 def reset(self, new_session=True, aggressive=False):
1425 1424 """Clear all internal namespaces, and attempt to release references to
1426 1425 user objects.
1427 1426
1428 1427 If new_session is True, a new history session will be opened.
1429 1428 """
1430 1429 # Clear histories
1431 1430 self.history_manager.reset(new_session)
1432 1431 # Reset counter used to index all histories
1433 1432 if new_session:
1434 1433 self.execution_count = 1
1435 1434
1436 1435 # Reset last execution result
1437 1436 self.last_execution_succeeded = True
1438 1437 self.last_execution_result = None
1439 1438
1440 1439 # Flush cached output items
1441 1440 if self.displayhook.do_full_cache:
1442 1441 self.displayhook.flush()
1443 1442
1444 1443 # The main execution namespaces must be cleared very carefully,
1445 1444 # skipping the deletion of the builtin-related keys, because doing so
1446 1445 # would cause errors in many object's __del__ methods.
1447 1446 if self.user_ns is not self.user_global_ns:
1448 1447 self.user_ns.clear()
1449 1448 ns = self.user_global_ns
1450 1449 drop_keys = set(ns.keys())
1451 1450 drop_keys.discard('__builtin__')
1452 1451 drop_keys.discard('__builtins__')
1453 1452 drop_keys.discard('__name__')
1454 1453 for k in drop_keys:
1455 1454 del ns[k]
1456 1455
1457 1456 self.user_ns_hidden.clear()
1458 1457
1459 1458 # Restore the user namespaces to minimal usability
1460 1459 self.init_user_ns()
1461 1460 if aggressive and not hasattr(self, "_sys_modules_keys"):
1462 1461 print("Cannot restore sys.module, no snapshot")
1463 1462 elif aggressive:
1464 1463 print("culling sys module...")
1465 1464 current_keys = set(sys.modules.keys())
1466 1465 for k in current_keys - self._sys_modules_keys:
1467 1466 if k.startswith("multiprocessing"):
1468 1467 continue
1469 1468 del sys.modules[k]
1470 1469
1471 1470 # Restore the default and user aliases
1472 1471 self.alias_manager.clear_aliases()
1473 1472 self.alias_manager.init_aliases()
1474 1473
1475 1474 # Now define aliases that only make sense on the terminal, because they
1476 1475 # need direct access to the console in a way that we can't emulate in
1477 1476 # GUI or web frontend
1478 1477 if os.name == 'posix':
1479 1478 for cmd in ('clear', 'more', 'less', 'man'):
1480 1479 if cmd not in self.magics_manager.magics['line']:
1481 1480 self.alias_manager.soft_define_alias(cmd, cmd)
1482 1481
1483 1482 # Flush the private list of module references kept for script
1484 1483 # execution protection
1485 1484 self.clear_main_mod_cache()
1486 1485
1487 1486 def del_var(self, varname, by_name=False):
1488 1487 """Delete a variable from the various namespaces, so that, as
1489 1488 far as possible, we're not keeping any hidden references to it.
1490 1489
1491 1490 Parameters
1492 1491 ----------
1493 1492 varname : str
1494 1493 The name of the variable to delete.
1495 1494 by_name : bool
1496 1495 If True, delete variables with the given name in each
1497 1496 namespace. If False (default), find the variable in the user
1498 1497 namespace, and delete references to it.
1499 1498 """
1500 1499 if varname in ('__builtin__', '__builtins__'):
1501 1500 raise ValueError("Refusing to delete %s" % varname)
1502 1501
1503 1502 ns_refs = self.all_ns_refs
1504 1503
1505 1504 if by_name: # Delete by name
1506 1505 for ns in ns_refs:
1507 1506 try:
1508 1507 del ns[varname]
1509 1508 except KeyError:
1510 1509 pass
1511 1510 else: # Delete by object
1512 1511 try:
1513 1512 obj = self.user_ns[varname]
1514 1513 except KeyError as e:
1515 1514 raise NameError("name '%s' is not defined" % varname) from e
1516 1515 # Also check in output history
1517 1516 ns_refs.append(self.history_manager.output_hist)
1518 1517 for ns in ns_refs:
1519 1518 to_delete = [n for n, o in ns.items() if o is obj]
1520 1519 for name in to_delete:
1521 1520 del ns[name]
1522 1521
1523 1522 # Ensure it is removed from the last execution result
1524 1523 if self.last_execution_result.result is obj:
1525 1524 self.last_execution_result = None
1526 1525
1527 1526 # displayhook keeps extra references, but not in a dictionary
1528 1527 for name in ('_', '__', '___'):
1529 1528 if getattr(self.displayhook, name) is obj:
1530 1529 setattr(self.displayhook, name, None)
1531 1530
1532 1531 def reset_selective(self, regex=None):
1533 1532 """Clear selective variables from internal namespaces based on a
1534 1533 specified regular expression.
1535 1534
1536 1535 Parameters
1537 1536 ----------
1538 1537 regex : string or compiled pattern, optional
1539 1538 A regular expression pattern that will be used in searching
1540 1539 variable names in the users namespaces.
1541 1540 """
1542 1541 if regex is not None:
1543 1542 try:
1544 1543 m = re.compile(regex)
1545 1544 except TypeError as e:
1546 1545 raise TypeError('regex must be a string or compiled pattern') from e
1547 1546 # Search for keys in each namespace that match the given regex
1548 1547 # If a match is found, delete the key/value pair.
1549 1548 for ns in self.all_ns_refs:
1550 1549 for var in ns:
1551 1550 if m.search(var):
1552 1551 del ns[var]
1553 1552
1554 1553 def push(self, variables, interactive=True):
1555 1554 """Inject a group of variables into the IPython user namespace.
1556 1555
1557 1556 Parameters
1558 1557 ----------
1559 1558 variables : dict, str or list/tuple of str
1560 1559 The variables to inject into the user's namespace. If a dict, a
1561 1560 simple update is done. If a str, the string is assumed to have
1562 1561 variable names separated by spaces. A list/tuple of str can also
1563 1562 be used to give the variable names. If just the variable names are
1564 1563 give (list/tuple/str) then the variable values looked up in the
1565 1564 callers frame.
1566 1565 interactive : bool
1567 1566 If True (default), the variables will be listed with the ``who``
1568 1567 magic.
1569 1568 """
1570 1569 vdict = None
1571 1570
1572 1571 # We need a dict of name/value pairs to do namespace updates.
1573 1572 if isinstance(variables, dict):
1574 1573 vdict = variables
1575 1574 elif isinstance(variables, (str, list, tuple)):
1576 1575 if isinstance(variables, str):
1577 1576 vlist = variables.split()
1578 1577 else:
1579 1578 vlist = variables
1580 1579 vdict = {}
1581 1580 cf = sys._getframe(1)
1582 1581 for name in vlist:
1583 1582 try:
1584 1583 vdict[name] = eval(name, cf.f_globals, cf.f_locals)
1585 1584 except:
1586 1585 print('Could not get variable %s from %s' %
1587 1586 (name,cf.f_code.co_name))
1588 1587 else:
1589 1588 raise ValueError('variables must be a dict/str/list/tuple')
1590 1589
1591 1590 # Propagate variables to user namespace
1592 1591 self.user_ns.update(vdict)
1593 1592
1594 1593 # And configure interactive visibility
1595 1594 user_ns_hidden = self.user_ns_hidden
1596 1595 if interactive:
1597 1596 for name in vdict:
1598 1597 user_ns_hidden.pop(name, None)
1599 1598 else:
1600 1599 user_ns_hidden.update(vdict)
1601 1600
1602 1601 def drop_by_id(self, variables):
1603 1602 """Remove a dict of variables from the user namespace, if they are the
1604 1603 same as the values in the dictionary.
1605 1604
1606 1605 This is intended for use by extensions: variables that they've added can
1607 1606 be taken back out if they are unloaded, without removing any that the
1608 1607 user has overwritten.
1609 1608
1610 1609 Parameters
1611 1610 ----------
1612 1611 variables : dict
1613 1612 A dictionary mapping object names (as strings) to the objects.
1614 1613 """
1615 1614 for name, obj in variables.items():
1616 1615 if name in self.user_ns and self.user_ns[name] is obj:
1617 1616 del self.user_ns[name]
1618 1617 self.user_ns_hidden.pop(name, None)
1619 1618
1620 1619 #-------------------------------------------------------------------------
1621 1620 # Things related to object introspection
1622 1621 #-------------------------------------------------------------------------
1623 1622
1624 1623 def _ofind(self, oname, namespaces=None):
1625 1624 """Find an object in the available namespaces.
1626 1625
1627 1626 self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic
1628 1627
1629 1628 Has special code to detect magic functions.
1630 1629 """
1631 1630 oname = oname.strip()
1632 1631 if not oname.startswith(ESC_MAGIC) and \
1633 1632 not oname.startswith(ESC_MAGIC2) and \
1634 1633 not all(a.isidentifier() for a in oname.split(".")):
1635 1634 return {'found': False}
1636 1635
1637 1636 if namespaces is None:
1638 1637 # Namespaces to search in:
1639 1638 # Put them in a list. The order is important so that we
1640 1639 # find things in the same order that Python finds them.
1641 1640 namespaces = [ ('Interactive', self.user_ns),
1642 1641 ('Interactive (global)', self.user_global_ns),
1643 1642 ('Python builtin', builtin_mod.__dict__),
1644 1643 ]
1645 1644
1646 1645 ismagic = False
1647 1646 isalias = False
1648 1647 found = False
1649 1648 ospace = None
1650 1649 parent = None
1651 1650 obj = None
1652 1651
1653 1652
1654 1653 # Look for the given name by splitting it in parts. If the head is
1655 1654 # found, then we look for all the remaining parts as members, and only
1656 1655 # declare success if we can find them all.
1657 1656 oname_parts = oname.split('.')
1658 1657 oname_head, oname_rest = oname_parts[0],oname_parts[1:]
1659 1658 for nsname,ns in namespaces:
1660 1659 try:
1661 1660 obj = ns[oname_head]
1662 1661 except KeyError:
1663 1662 continue
1664 1663 else:
1665 1664 for idx, part in enumerate(oname_rest):
1666 1665 try:
1667 1666 parent = obj
1668 1667 # The last part is looked up in a special way to avoid
1669 1668 # descriptor invocation as it may raise or have side
1670 1669 # effects.
1671 1670 if idx == len(oname_rest) - 1:
1672 1671 obj = self._getattr_property(obj, part)
1673 1672 else:
1674 1673 obj = getattr(obj, part)
1675 1674 except:
1676 1675 # Blanket except b/c some badly implemented objects
1677 1676 # allow __getattr__ to raise exceptions other than
1678 1677 # AttributeError, which then crashes IPython.
1679 1678 break
1680 1679 else:
1681 1680 # If we finish the for loop (no break), we got all members
1682 1681 found = True
1683 1682 ospace = nsname
1684 1683 break # namespace loop
1685 1684
1686 1685 # Try to see if it's magic
1687 1686 if not found:
1688 1687 obj = None
1689 1688 if oname.startswith(ESC_MAGIC2):
1690 1689 oname = oname.lstrip(ESC_MAGIC2)
1691 1690 obj = self.find_cell_magic(oname)
1692 1691 elif oname.startswith(ESC_MAGIC):
1693 1692 oname = oname.lstrip(ESC_MAGIC)
1694 1693 obj = self.find_line_magic(oname)
1695 1694 else:
1696 1695 # search without prefix, so run? will find %run?
1697 1696 obj = self.find_line_magic(oname)
1698 1697 if obj is None:
1699 1698 obj = self.find_cell_magic(oname)
1700 1699 if obj is not None:
1701 1700 found = True
1702 1701 ospace = 'IPython internal'
1703 1702 ismagic = True
1704 1703 isalias = isinstance(obj, Alias)
1705 1704
1706 1705 # Last try: special-case some literals like '', [], {}, etc:
1707 1706 if not found and oname_head in ["''",'""','[]','{}','()']:
1708 1707 obj = eval(oname_head)
1709 1708 found = True
1710 1709 ospace = 'Interactive'
1711 1710
1712 1711 return {
1713 1712 'obj':obj,
1714 1713 'found':found,
1715 1714 'parent':parent,
1716 1715 'ismagic':ismagic,
1717 1716 'isalias':isalias,
1718 1717 'namespace':ospace
1719 1718 }
1720 1719
1721 1720 @staticmethod
1722 1721 def _getattr_property(obj, attrname):
1723 1722 """Property-aware getattr to use in object finding.
1724 1723
1725 1724 If attrname represents a property, return it unevaluated (in case it has
1726 1725 side effects or raises an error.
1727 1726
1728 1727 """
1729 1728 if not isinstance(obj, type):
1730 1729 try:
1731 1730 # `getattr(type(obj), attrname)` is not guaranteed to return
1732 1731 # `obj`, but does so for property:
1733 1732 #
1734 1733 # property.__get__(self, None, cls) -> self
1735 1734 #
1736 1735 # The universal alternative is to traverse the mro manually
1737 1736 # searching for attrname in class dicts.
1738 1737 attr = getattr(type(obj), attrname)
1739 1738 except AttributeError:
1740 1739 pass
1741 1740 else:
1742 1741 # This relies on the fact that data descriptors (with both
1743 1742 # __get__ & __set__ magic methods) take precedence over
1744 1743 # instance-level attributes:
1745 1744 #
1746 1745 # class A(object):
1747 1746 # @property
1748 1747 # def foobar(self): return 123
1749 1748 # a = A()
1750 1749 # a.__dict__['foobar'] = 345
1751 1750 # a.foobar # == 123
1752 1751 #
1753 1752 # So, a property may be returned right away.
1754 1753 if isinstance(attr, property):
1755 1754 return attr
1756 1755
1757 1756 # Nothing helped, fall back.
1758 1757 return getattr(obj, attrname)
1759 1758
1760 1759 def _object_find(self, oname, namespaces=None):
1761 1760 """Find an object and return a struct with info about it."""
1762 1761 return Struct(self._ofind(oname, namespaces))
1763 1762
1764 1763 def _inspect(self, meth, oname, namespaces=None, **kw):
1765 1764 """Generic interface to the inspector system.
1766 1765
1767 1766 This function is meant to be called by pdef, pdoc & friends.
1768 1767 """
1769 1768 info = self._object_find(oname, namespaces)
1770 1769 docformat = sphinxify if self.sphinxify_docstring else None
1771 1770 if info.found:
1772 1771 pmethod = getattr(self.inspector, meth)
1773 1772 # TODO: only apply format_screen to the plain/text repr of the mime
1774 1773 # bundle.
1775 1774 formatter = format_screen if info.ismagic else docformat
1776 1775 if meth == 'pdoc':
1777 1776 pmethod(info.obj, oname, formatter)
1778 1777 elif meth == 'pinfo':
1779 1778 pmethod(
1780 1779 info.obj,
1781 1780 oname,
1782 1781 formatter,
1783 1782 info,
1784 1783 enable_html_pager=self.enable_html_pager,
1785 1784 **kw
1786 1785 )
1787 1786 else:
1788 1787 pmethod(info.obj, oname)
1789 1788 else:
1790 1789 print('Object `%s` not found.' % oname)
1791 1790 return 'not found' # so callers can take other action
1792 1791
1793 1792 def object_inspect(self, oname, detail_level=0):
1794 1793 """Get object info about oname"""
1795 1794 with self.builtin_trap:
1796 1795 info = self._object_find(oname)
1797 1796 if info.found:
1798 1797 return self.inspector.info(info.obj, oname, info=info,
1799 1798 detail_level=detail_level
1800 1799 )
1801 1800 else:
1802 1801 return oinspect.object_info(name=oname, found=False)
1803 1802
1804 1803 def object_inspect_text(self, oname, detail_level=0):
1805 1804 """Get object info as formatted text"""
1806 1805 return self.object_inspect_mime(oname, detail_level)['text/plain']
1807 1806
1808 1807 def object_inspect_mime(self, oname, detail_level=0):
1809 1808 """Get object info as a mimebundle of formatted representations.
1810 1809
1811 1810 A mimebundle is a dictionary, keyed by mime-type.
1812 1811 It must always have the key `'text/plain'`.
1813 1812 """
1814 1813 with self.builtin_trap:
1815 1814 info = self._object_find(oname)
1816 1815 if info.found:
1817 1816 return self.inspector._get_info(info.obj, oname, info=info,
1818 1817 detail_level=detail_level
1819 1818 )
1820 1819 else:
1821 1820 raise KeyError(oname)
1822 1821
1823 1822 #-------------------------------------------------------------------------
1824 1823 # Things related to history management
1825 1824 #-------------------------------------------------------------------------
1826 1825
1827 1826 def init_history(self):
1828 1827 """Sets up the command history, and starts regular autosaves."""
1829 1828 self.history_manager = HistoryManager(shell=self, parent=self)
1830 1829 self.configurables.append(self.history_manager)
1831 1830
1832 1831 #-------------------------------------------------------------------------
1833 1832 # Things related to exception handling and tracebacks (not debugging)
1834 1833 #-------------------------------------------------------------------------
1835 1834
1836 1835 debugger_cls = Pdb
1837 1836
1838 1837 def init_traceback_handlers(self, custom_exceptions):
1839 1838 # Syntax error handler.
1840 1839 self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor', parent=self)
1841 1840
1842 1841 # The interactive one is initialized with an offset, meaning we always
1843 1842 # want to remove the topmost item in the traceback, which is our own
1844 1843 # internal code. Valid modes: ['Plain','Context','Verbose','Minimal']
1845 1844 self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain',
1846 1845 color_scheme='NoColor',
1847 1846 tb_offset = 1,
1848 1847 check_cache=check_linecache_ipython,
1849 1848 debugger_cls=self.debugger_cls, parent=self)
1850 1849
1851 1850 # The instance will store a pointer to the system-wide exception hook,
1852 1851 # so that runtime code (such as magics) can access it. This is because
1853 1852 # during the read-eval loop, it may get temporarily overwritten.
1854 1853 self.sys_excepthook = sys.excepthook
1855 1854
1856 1855 # and add any custom exception handlers the user may have specified
1857 1856 self.set_custom_exc(*custom_exceptions)
1858 1857
1859 1858 # Set the exception mode
1860 1859 self.InteractiveTB.set_mode(mode=self.xmode)
1861 1860
1862 1861 def set_custom_exc(self, exc_tuple, handler):
1863 1862 """set_custom_exc(exc_tuple, handler)
1864 1863
1865 1864 Set a custom exception handler, which will be called if any of the
1866 1865 exceptions in exc_tuple occur in the mainloop (specifically, in the
1867 1866 run_code() method).
1868 1867
1869 1868 Parameters
1870 1869 ----------
1871 1870
1872 1871 exc_tuple : tuple of exception classes
1873 1872 A *tuple* of exception classes, for which to call the defined
1874 1873 handler. It is very important that you use a tuple, and NOT A
1875 1874 LIST here, because of the way Python's except statement works. If
1876 1875 you only want to trap a single exception, use a singleton tuple::
1877 1876
1878 1877 exc_tuple == (MyCustomException,)
1879 1878
1880 1879 handler : callable
1881 1880 handler must have the following signature::
1882 1881
1883 1882 def my_handler(self, etype, value, tb, tb_offset=None):
1884 1883 ...
1885 1884 return structured_traceback
1886 1885
1887 1886 Your handler must return a structured traceback (a list of strings),
1888 1887 or None.
1889 1888
1890 1889 This will be made into an instance method (via types.MethodType)
1891 1890 of IPython itself, and it will be called if any of the exceptions
1892 1891 listed in the exc_tuple are caught. If the handler is None, an
1893 1892 internal basic one is used, which just prints basic info.
1894 1893
1895 1894 To protect IPython from crashes, if your handler ever raises an
1896 1895 exception or returns an invalid result, it will be immediately
1897 1896 disabled.
1898 1897
1899 1898 Notes
1900 1899 -----
1901 1900
1902 1901 WARNING: by putting in your own exception handler into IPython's main
1903 1902 execution loop, you run a very good chance of nasty crashes. This
1904 1903 facility should only be used if you really know what you are doing.
1905 1904 """
1906 1905
1907 1906 if not isinstance(exc_tuple, tuple):
1908 1907 raise TypeError("The custom exceptions must be given as a tuple.")
1909 1908
1910 1909 def dummy_handler(self, etype, value, tb, tb_offset=None):
1911 1910 print('*** Simple custom exception handler ***')
1912 1911 print('Exception type :', etype)
1913 1912 print('Exception value:', value)
1914 1913 print('Traceback :', tb)
1915 1914
1916 1915 def validate_stb(stb):
1917 1916 """validate structured traceback return type
1918 1917
1919 1918 return type of CustomTB *should* be a list of strings, but allow
1920 1919 single strings or None, which are harmless.
1921 1920
1922 1921 This function will *always* return a list of strings,
1923 1922 and will raise a TypeError if stb is inappropriate.
1924 1923 """
1925 1924 msg = "CustomTB must return list of strings, not %r" % stb
1926 1925 if stb is None:
1927 1926 return []
1928 1927 elif isinstance(stb, str):
1929 1928 return [stb]
1930 1929 elif not isinstance(stb, list):
1931 1930 raise TypeError(msg)
1932 1931 # it's a list
1933 1932 for line in stb:
1934 1933 # check every element
1935 1934 if not isinstance(line, str):
1936 1935 raise TypeError(msg)
1937 1936 return stb
1938 1937
1939 1938 if handler is None:
1940 1939 wrapped = dummy_handler
1941 1940 else:
1942 1941 def wrapped(self,etype,value,tb,tb_offset=None):
1943 1942 """wrap CustomTB handler, to protect IPython from user code
1944 1943
1945 1944 This makes it harder (but not impossible) for custom exception
1946 1945 handlers to crash IPython.
1947 1946 """
1948 1947 try:
1949 1948 stb = handler(self,etype,value,tb,tb_offset=tb_offset)
1950 1949 return validate_stb(stb)
1951 1950 except:
1952 1951 # clear custom handler immediately
1953 1952 self.set_custom_exc((), None)
1954 1953 print("Custom TB Handler failed, unregistering", file=sys.stderr)
1955 1954 # show the exception in handler first
1956 1955 stb = self.InteractiveTB.structured_traceback(*sys.exc_info())
1957 1956 print(self.InteractiveTB.stb2text(stb))
1958 1957 print("The original exception:")
1959 1958 stb = self.InteractiveTB.structured_traceback(
1960 1959 (etype,value,tb), tb_offset=tb_offset
1961 1960 )
1962 1961 return stb
1963 1962
1964 1963 self.CustomTB = types.MethodType(wrapped,self)
1965 1964 self.custom_exceptions = exc_tuple
1966 1965
1967 1966 def excepthook(self, etype, value, tb):
1968 1967 """One more defense for GUI apps that call sys.excepthook.
1969 1968
1970 1969 GUI frameworks like wxPython trap exceptions and call
1971 1970 sys.excepthook themselves. I guess this is a feature that
1972 1971 enables them to keep running after exceptions that would
1973 1972 otherwise kill their mainloop. This is a bother for IPython
1974 1973 which expects to catch all of the program exceptions with a try:
1975 1974 except: statement.
1976 1975
1977 1976 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
1978 1977 any app directly invokes sys.excepthook, it will look to the user like
1979 1978 IPython crashed. In order to work around this, we can disable the
1980 1979 CrashHandler and replace it with this excepthook instead, which prints a
1981 1980 regular traceback using our InteractiveTB. In this fashion, apps which
1982 1981 call sys.excepthook will generate a regular-looking exception from
1983 1982 IPython, and the CrashHandler will only be triggered by real IPython
1984 1983 crashes.
1985 1984
1986 1985 This hook should be used sparingly, only in places which are not likely
1987 1986 to be true IPython errors.
1988 1987 """
1989 1988 self.showtraceback((etype, value, tb), tb_offset=0)
1990 1989
1991 1990 def _get_exc_info(self, exc_tuple=None):
1992 1991 """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc.
1993 1992
1994 1993 Ensures sys.last_type,value,traceback hold the exc_info we found,
1995 1994 from whichever source.
1996 1995
1997 1996 raises ValueError if none of these contain any information
1998 1997 """
1999 1998 if exc_tuple is None:
2000 1999 etype, value, tb = sys.exc_info()
2001 2000 else:
2002 2001 etype, value, tb = exc_tuple
2003 2002
2004 2003 if etype is None:
2005 2004 if hasattr(sys, 'last_type'):
2006 2005 etype, value, tb = sys.last_type, sys.last_value, \
2007 2006 sys.last_traceback
2008 2007
2009 2008 if etype is None:
2010 2009 raise ValueError("No exception to find")
2011 2010
2012 2011 # Now store the exception info in sys.last_type etc.
2013 2012 # WARNING: these variables are somewhat deprecated and not
2014 2013 # necessarily safe to use in a threaded environment, but tools
2015 2014 # like pdb depend on their existence, so let's set them. If we
2016 2015 # find problems in the field, we'll need to revisit their use.
2017 2016 sys.last_type = etype
2018 2017 sys.last_value = value
2019 2018 sys.last_traceback = tb
2020 2019
2021 2020 return etype, value, tb
2022 2021
2023 2022 def show_usage_error(self, exc):
2024 2023 """Show a short message for UsageErrors
2025 2024
2026 2025 These are special exceptions that shouldn't show a traceback.
2027 2026 """
2028 2027 print("UsageError: %s" % exc, file=sys.stderr)
2029 2028
2030 2029 def get_exception_only(self, exc_tuple=None):
2031 2030 """
2032 2031 Return as a string (ending with a newline) the exception that
2033 2032 just occurred, without any traceback.
2034 2033 """
2035 2034 etype, value, tb = self._get_exc_info(exc_tuple)
2036 2035 msg = traceback.format_exception_only(etype, value)
2037 2036 return ''.join(msg)
2038 2037
2039 2038 def showtraceback(self, exc_tuple=None, filename=None, tb_offset=None,
2040 2039 exception_only=False, running_compiled_code=False):
2041 2040 """Display the exception that just occurred.
2042 2041
2043 2042 If nothing is known about the exception, this is the method which
2044 2043 should be used throughout the code for presenting user tracebacks,
2045 2044 rather than directly invoking the InteractiveTB object.
2046 2045
2047 2046 A specific showsyntaxerror() also exists, but this method can take
2048 2047 care of calling it if needed, so unless you are explicitly catching a
2049 2048 SyntaxError exception, don't try to analyze the stack manually and
2050 2049 simply call this method."""
2051 2050
2052 2051 try:
2053 2052 try:
2054 2053 etype, value, tb = self._get_exc_info(exc_tuple)
2055 2054 except ValueError:
2056 2055 print('No traceback available to show.', file=sys.stderr)
2057 2056 return
2058 2057
2059 2058 if issubclass(etype, SyntaxError):
2060 2059 # Though this won't be called by syntax errors in the input
2061 2060 # line, there may be SyntaxError cases with imported code.
2062 2061 self.showsyntaxerror(filename, running_compiled_code)
2063 2062 elif etype is UsageError:
2064 2063 self.show_usage_error(value)
2065 2064 else:
2066 2065 if exception_only:
2067 2066 stb = ['An exception has occurred, use %tb to see '
2068 2067 'the full traceback.\n']
2069 2068 stb.extend(self.InteractiveTB.get_exception_only(etype,
2070 2069 value))
2071 2070 else:
2072 2071 try:
2073 2072 # Exception classes can customise their traceback - we
2074 2073 # use this in IPython.parallel for exceptions occurring
2075 2074 # in the engines. This should return a list of strings.
2076 2075 stb = value._render_traceback_()
2077 2076 except Exception:
2078 2077 stb = self.InteractiveTB.structured_traceback(etype,
2079 2078 value, tb, tb_offset=tb_offset)
2080 2079
2081 2080 self._showtraceback(etype, value, stb)
2082 2081 if self.call_pdb:
2083 2082 # drop into debugger
2084 2083 self.debugger(force=True)
2085 2084 return
2086 2085
2087 2086 # Actually show the traceback
2088 2087 self._showtraceback(etype, value, stb)
2089 2088
2090 2089 except KeyboardInterrupt:
2091 2090 print('\n' + self.get_exception_only(), file=sys.stderr)
2092 2091
2093 2092 def _showtraceback(self, etype, evalue, stb: str):
2094 2093 """Actually show a traceback.
2095 2094
2096 2095 Subclasses may override this method to put the traceback on a different
2097 2096 place, like a side channel.
2098 2097 """
2099 2098 val = self.InteractiveTB.stb2text(stb)
2100 2099 try:
2101 2100 print(val)
2102 2101 except UnicodeEncodeError:
2103 2102 print(val.encode("utf-8", "backslashreplace").decode())
2104 2103
2105 2104 def showsyntaxerror(self, filename=None, running_compiled_code=False):
2106 2105 """Display the syntax error that just occurred.
2107 2106
2108 2107 This doesn't display a stack trace because there isn't one.
2109 2108
2110 2109 If a filename is given, it is stuffed in the exception instead
2111 2110 of what was there before (because Python's parser always uses
2112 2111 "<string>" when reading from a string).
2113 2112
2114 2113 If the syntax error occurred when running a compiled code (i.e. running_compile_code=True),
2115 2114 longer stack trace will be displayed.
2116 2115 """
2117 2116 etype, value, last_traceback = self._get_exc_info()
2118 2117
2119 2118 if filename and issubclass(etype, SyntaxError):
2120 2119 try:
2121 2120 value.filename = filename
2122 2121 except:
2123 2122 # Not the format we expect; leave it alone
2124 2123 pass
2125 2124
2126 2125 # If the error occurred when executing compiled code, we should provide full stacktrace.
2127 2126 elist = traceback.extract_tb(last_traceback) if running_compiled_code else []
2128 2127 stb = self.SyntaxTB.structured_traceback(etype, value, elist)
2129 2128 self._showtraceback(etype, value, stb)
2130 2129
2131 2130 # This is overridden in TerminalInteractiveShell to show a message about
2132 2131 # the %paste magic.
2133 2132 def showindentationerror(self):
2134 2133 """Called by _run_cell when there's an IndentationError in code entered
2135 2134 at the prompt.
2136 2135
2137 2136 This is overridden in TerminalInteractiveShell to show a message about
2138 2137 the %paste magic."""
2139 2138 self.showsyntaxerror()
2140 2139
2141 2140 #-------------------------------------------------------------------------
2142 2141 # Things related to readline
2143 2142 #-------------------------------------------------------------------------
2144 2143
2145 2144 def init_readline(self):
2146 2145 """DEPRECATED
2147 2146
2148 2147 Moved to terminal subclass, here only to simplify the init logic."""
2149 2148 # Set a number of methods that depend on readline to be no-op
2150 2149 warnings.warn('`init_readline` is no-op since IPython 5.0 and is Deprecated',
2151 2150 DeprecationWarning, stacklevel=2)
2152 2151 self.set_custom_completer = no_op
2153 2152
2154 2153 @skip_doctest
2155 2154 def set_next_input(self, s, replace=False):
2156 2155 """ Sets the 'default' input string for the next command line.
2157 2156
2158 2157 Example::
2159 2158
2160 2159 In [1]: _ip.set_next_input("Hello Word")
2161 2160 In [2]: Hello Word_ # cursor is here
2162 2161 """
2163 2162 self.rl_next_input = s
2164 2163
2165 2164 def _indent_current_str(self):
2166 2165 """return the current level of indentation as a string"""
2167 2166 return self.input_splitter.get_indent_spaces() * ' '
2168 2167
2169 2168 #-------------------------------------------------------------------------
2170 2169 # Things related to text completion
2171 2170 #-------------------------------------------------------------------------
2172 2171
2173 2172 def init_completer(self):
2174 2173 """Initialize the completion machinery.
2175 2174
2176 2175 This creates completion machinery that can be used by client code,
2177 2176 either interactively in-process (typically triggered by the readline
2178 2177 library), programmatically (such as in test suites) or out-of-process
2179 2178 (typically over the network by remote frontends).
2180 2179 """
2181 2180 from IPython.core.completer import IPCompleter
2182 2181 from IPython.core.completerlib import (module_completer,
2183 2182 magic_run_completer, cd_completer, reset_completer)
2184 2183
2185 2184 self.Completer = IPCompleter(shell=self,
2186 2185 namespace=self.user_ns,
2187 2186 global_namespace=self.user_global_ns,
2188 2187 parent=self,
2189 2188 )
2190 2189 self.configurables.append(self.Completer)
2191 2190
2192 2191 # Add custom completers to the basic ones built into IPCompleter
2193 2192 sdisp = self.strdispatchers.get('complete_command', StrDispatch())
2194 2193 self.strdispatchers['complete_command'] = sdisp
2195 2194 self.Completer.custom_completers = sdisp
2196 2195
2197 2196 self.set_hook('complete_command', module_completer, str_key = 'import')
2198 2197 self.set_hook('complete_command', module_completer, str_key = 'from')
2199 2198 self.set_hook('complete_command', module_completer, str_key = '%aimport')
2200 2199 self.set_hook('complete_command', magic_run_completer, str_key = '%run')
2201 2200 self.set_hook('complete_command', cd_completer, str_key = '%cd')
2202 2201 self.set_hook('complete_command', reset_completer, str_key = '%reset')
2203 2202
2204 2203 @skip_doctest
2205 2204 def complete(self, text, line=None, cursor_pos=None):
2206 2205 """Return the completed text and a list of completions.
2207 2206
2208 2207 Parameters
2209 2208 ----------
2210 2209
2211 2210 text : string
2212 2211 A string of text to be completed on. It can be given as empty and
2213 2212 instead a line/position pair are given. In this case, the
2214 2213 completer itself will split the line like readline does.
2215 2214
2216 2215 line : string, optional
2217 2216 The complete line that text is part of.
2218 2217
2219 2218 cursor_pos : int, optional
2220 2219 The position of the cursor on the input line.
2221 2220
2222 2221 Returns
2223 2222 -------
2224 2223 text : string
2225 2224 The actual text that was completed.
2226 2225
2227 2226 matches : list
2228 2227 A sorted list with all possible completions.
2229 2228
2230 2229
2231 2230 Notes
2232 2231 -----
2233 2232 The optional arguments allow the completion to take more context into
2234 2233 account, and are part of the low-level completion API.
2235 2234
2236 2235 This is a wrapper around the completion mechanism, similar to what
2237 2236 readline does at the command line when the TAB key is hit. By
2238 2237 exposing it as a method, it can be used by other non-readline
2239 2238 environments (such as GUIs) for text completion.
2240 2239
2241 2240 Examples
2242 2241 --------
2243 2242
2244 2243 In [1]: x = 'hello'
2245 2244
2246 2245 In [2]: _ip.complete('x.l')
2247 2246 Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip'])
2248 2247 """
2249 2248
2250 2249 # Inject names into __builtin__ so we can complete on the added names.
2251 2250 with self.builtin_trap:
2252 2251 return self.Completer.complete(text, line, cursor_pos)
2253 2252
2254 2253 def set_custom_completer(self, completer, pos=0) -> None:
2255 2254 """Adds a new custom completer function.
2256 2255
2257 2256 The position argument (defaults to 0) is the index in the completers
2258 2257 list where you want the completer to be inserted.
2259 2258
2260 2259 `completer` should have the following signature::
2261 2260
2262 2261 def completion(self: Completer, text: string) -> List[str]:
2263 2262 raise NotImplementedError
2264 2263
2265 2264 It will be bound to the current Completer instance and pass some text
2266 2265 and return a list with current completions to suggest to the user.
2267 2266 """
2268 2267
2269 2268 newcomp = types.MethodType(completer, self.Completer)
2270 2269 self.Completer.custom_matchers.insert(pos,newcomp)
2271 2270
2272 2271 def set_completer_frame(self, frame=None):
2273 2272 """Set the frame of the completer."""
2274 2273 if frame:
2275 2274 self.Completer.namespace = frame.f_locals
2276 2275 self.Completer.global_namespace = frame.f_globals
2277 2276 else:
2278 2277 self.Completer.namespace = self.user_ns
2279 2278 self.Completer.global_namespace = self.user_global_ns
2280 2279
2281 2280 #-------------------------------------------------------------------------
2282 2281 # Things related to magics
2283 2282 #-------------------------------------------------------------------------
2284 2283
2285 2284 def init_magics(self):
2286 2285 from IPython.core import magics as m
2287 2286 self.magics_manager = magic.MagicsManager(shell=self,
2288 2287 parent=self,
2289 2288 user_magics=m.UserMagics(self))
2290 2289 self.configurables.append(self.magics_manager)
2291 2290
2292 2291 # Expose as public API from the magics manager
2293 2292 self.register_magics = self.magics_manager.register
2294 2293
2295 2294 self.register_magics(m.AutoMagics, m.BasicMagics, m.CodeMagics,
2296 2295 m.ConfigMagics, m.DisplayMagics, m.ExecutionMagics,
2297 2296 m.ExtensionMagics, m.HistoryMagics, m.LoggingMagics,
2298 2297 m.NamespaceMagics, m.OSMagics, m.PackagingMagics,
2299 2298 m.PylabMagics, m.ScriptMagics,
2300 2299 )
2301 2300 self.register_magics(m.AsyncMagics)
2302 2301
2303 2302 # Register Magic Aliases
2304 2303 mman = self.magics_manager
2305 2304 # FIXME: magic aliases should be defined by the Magics classes
2306 2305 # or in MagicsManager, not here
2307 2306 mman.register_alias('ed', 'edit')
2308 2307 mman.register_alias('hist', 'history')
2309 2308 mman.register_alias('rep', 'recall')
2310 2309 mman.register_alias('SVG', 'svg', 'cell')
2311 2310 mman.register_alias('HTML', 'html', 'cell')
2312 2311 mman.register_alias('file', 'writefile', 'cell')
2313 2312
2314 2313 # FIXME: Move the color initialization to the DisplayHook, which
2315 2314 # should be split into a prompt manager and displayhook. We probably
2316 2315 # even need a centralize colors management object.
2317 2316 self.run_line_magic('colors', self.colors)
2318 2317
2319 2318 # Defined here so that it's included in the documentation
2320 2319 @functools.wraps(magic.MagicsManager.register_function)
2321 2320 def register_magic_function(self, func, magic_kind='line', magic_name=None):
2322 2321 self.magics_manager.register_function(
2323 2322 func, magic_kind=magic_kind, magic_name=magic_name
2324 2323 )
2325 2324
2326 2325 def run_line_magic(self, magic_name, line, _stack_depth=1):
2327 2326 """Execute the given line magic.
2328 2327
2329 2328 Parameters
2330 2329 ----------
2331 2330 magic_name : str
2332 2331 Name of the desired magic function, without '%' prefix.
2333 2332 line : str
2334 2333 The rest of the input line as a single string.
2335 2334 _stack_depth : int
2336 2335 If run_line_magic() is called from magic() then _stack_depth=2.
2337 2336 This is added to ensure backward compatibility for use of 'get_ipython().magic()'
2338 2337 """
2339 2338 fn = self.find_line_magic(magic_name)
2340 2339 if fn is None:
2341 2340 cm = self.find_cell_magic(magic_name)
2342 2341 etpl = "Line magic function `%%%s` not found%s."
2343 2342 extra = '' if cm is None else (' (But cell magic `%%%%%s` exists, '
2344 2343 'did you mean that instead?)' % magic_name )
2345 2344 raise UsageError(etpl % (magic_name, extra))
2346 2345 else:
2347 2346 # Note: this is the distance in the stack to the user's frame.
2348 2347 # This will need to be updated if the internal calling logic gets
2349 2348 # refactored, or else we'll be expanding the wrong variables.
2350 2349
2351 2350 # Determine stack_depth depending on where run_line_magic() has been called
2352 2351 stack_depth = _stack_depth
2353 2352 if getattr(fn, magic.MAGIC_NO_VAR_EXPAND_ATTR, False):
2354 2353 # magic has opted out of var_expand
2355 2354 magic_arg_s = line
2356 2355 else:
2357 2356 magic_arg_s = self.var_expand(line, stack_depth)
2358 2357 # Put magic args in a list so we can call with f(*a) syntax
2359 2358 args = [magic_arg_s]
2360 2359 kwargs = {}
2361 2360 # Grab local namespace if we need it:
2362 2361 if getattr(fn, "needs_local_scope", False):
2363 2362 kwargs['local_ns'] = self.get_local_scope(stack_depth)
2364 2363 with self.builtin_trap:
2365 2364 result = fn(*args, **kwargs)
2366 2365 return result
2367 2366
2368 2367 def get_local_scope(self, stack_depth):
2369 2368 """Get local scope at given stack depth.
2370 2369
2371 2370 Parameters
2372 2371 ----------
2373 2372 stack_depth : int
2374 2373 Depth relative to calling frame
2375 2374 """
2376 2375 return sys._getframe(stack_depth + 1).f_locals
2377 2376
2378 2377 def run_cell_magic(self, magic_name, line, cell):
2379 2378 """Execute the given cell magic.
2380 2379
2381 2380 Parameters
2382 2381 ----------
2383 2382 magic_name : str
2384 2383 Name of the desired magic function, without '%' prefix.
2385 2384 line : str
2386 2385 The rest of the first input line as a single string.
2387 2386 cell : str
2388 2387 The body of the cell as a (possibly multiline) string.
2389 2388 """
2390 2389 fn = self.find_cell_magic(magic_name)
2391 2390 if fn is None:
2392 2391 lm = self.find_line_magic(magic_name)
2393 2392 etpl = "Cell magic `%%{0}` not found{1}."
2394 2393 extra = '' if lm is None else (' (But line magic `%{0}` exists, '
2395 2394 'did you mean that instead?)'.format(magic_name))
2396 2395 raise UsageError(etpl.format(magic_name, extra))
2397 2396 elif cell == '':
2398 2397 message = '%%{0} is a cell magic, but the cell body is empty.'.format(magic_name)
2399 2398 if self.find_line_magic(magic_name) is not None:
2400 2399 message += ' Did you mean the line magic %{0} (single %)?'.format(magic_name)
2401 2400 raise UsageError(message)
2402 2401 else:
2403 2402 # Note: this is the distance in the stack to the user's frame.
2404 2403 # This will need to be updated if the internal calling logic gets
2405 2404 # refactored, or else we'll be expanding the wrong variables.
2406 2405 stack_depth = 2
2407 2406 if getattr(fn, magic.MAGIC_NO_VAR_EXPAND_ATTR, False):
2408 2407 # magic has opted out of var_expand
2409 2408 magic_arg_s = line
2410 2409 else:
2411 2410 magic_arg_s = self.var_expand(line, stack_depth)
2412 2411 kwargs = {}
2413 2412 if getattr(fn, "needs_local_scope", False):
2414 2413 kwargs['local_ns'] = self.user_ns
2415 2414
2416 2415 with self.builtin_trap:
2417 2416 args = (magic_arg_s, cell)
2418 2417 result = fn(*args, **kwargs)
2419 2418 return result
2420 2419
2421 2420 def find_line_magic(self, magic_name):
2422 2421 """Find and return a line magic by name.
2423 2422
2424 2423 Returns None if the magic isn't found."""
2425 2424 return self.magics_manager.magics['line'].get(magic_name)
2426 2425
2427 2426 def find_cell_magic(self, magic_name):
2428 2427 """Find and return a cell magic by name.
2429 2428
2430 2429 Returns None if the magic isn't found."""
2431 2430 return self.magics_manager.magics['cell'].get(magic_name)
2432 2431
2433 2432 def find_magic(self, magic_name, magic_kind='line'):
2434 2433 """Find and return a magic of the given type by name.
2435 2434
2436 2435 Returns None if the magic isn't found."""
2437 2436 return self.magics_manager.magics[magic_kind].get(magic_name)
2438 2437
2439 2438 def magic(self, arg_s):
2440 2439 """DEPRECATED. Use run_line_magic() instead.
2441 2440
2442 2441 Call a magic function by name.
2443 2442
2444 2443 Input: a string containing the name of the magic function to call and
2445 2444 any additional arguments to be passed to the magic.
2446 2445
2447 2446 magic('name -opt foo bar') is equivalent to typing at the ipython
2448 2447 prompt:
2449 2448
2450 2449 In[1]: %name -opt foo bar
2451 2450
2452 2451 To call a magic without arguments, simply use magic('name').
2453 2452
2454 2453 This provides a proper Python function to call IPython's magics in any
2455 2454 valid Python code you can type at the interpreter, including loops and
2456 2455 compound statements.
2457 2456 """
2458 2457 # TODO: should we issue a loud deprecation warning here?
2459 2458 magic_name, _, magic_arg_s = arg_s.partition(' ')
2460 2459 magic_name = magic_name.lstrip(prefilter.ESC_MAGIC)
2461 2460 return self.run_line_magic(magic_name, magic_arg_s, _stack_depth=2)
2462 2461
2463 2462 #-------------------------------------------------------------------------
2464 2463 # Things related to macros
2465 2464 #-------------------------------------------------------------------------
2466 2465
2467 2466 def define_macro(self, name, themacro):
2468 2467 """Define a new macro
2469 2468
2470 2469 Parameters
2471 2470 ----------
2472 2471 name : str
2473 2472 The name of the macro.
2474 2473 themacro : str or Macro
2475 2474 The action to do upon invoking the macro. If a string, a new
2476 2475 Macro object is created by passing the string to it.
2477 2476 """
2478 2477
2479 2478 from IPython.core import macro
2480 2479
2481 2480 if isinstance(themacro, str):
2482 2481 themacro = macro.Macro(themacro)
2483 2482 if not isinstance(themacro, macro.Macro):
2484 2483 raise ValueError('A macro must be a string or a Macro instance.')
2485 2484 self.user_ns[name] = themacro
2486 2485
2487 2486 #-------------------------------------------------------------------------
2488 2487 # Things related to the running of system commands
2489 2488 #-------------------------------------------------------------------------
2490 2489
2491 2490 def system_piped(self, cmd):
2492 2491 """Call the given cmd in a subprocess, piping stdout/err
2493 2492
2494 2493 Parameters
2495 2494 ----------
2496 2495 cmd : str
2497 2496 Command to execute (can not end in '&', as background processes are
2498 2497 not supported. Should not be a command that expects input
2499 2498 other than simple text.
2500 2499 """
2501 2500 if cmd.rstrip().endswith('&'):
2502 2501 # this is *far* from a rigorous test
2503 2502 # We do not support backgrounding processes because we either use
2504 2503 # pexpect or pipes to read from. Users can always just call
2505 2504 # os.system() or use ip.system=ip.system_raw
2506 2505 # if they really want a background process.
2507 2506 raise OSError("Background processes not supported.")
2508 2507
2509 2508 # we explicitly do NOT return the subprocess status code, because
2510 2509 # a non-None value would trigger :func:`sys.displayhook` calls.
2511 2510 # Instead, we store the exit_code in user_ns.
2512 2511 self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=1))
2513 2512
2514 2513 def system_raw(self, cmd):
2515 2514 """Call the given cmd in a subprocess using os.system on Windows or
2516 2515 subprocess.call using the system shell on other platforms.
2517 2516
2518 2517 Parameters
2519 2518 ----------
2520 2519 cmd : str
2521 2520 Command to execute.
2522 2521 """
2523 2522 cmd = self.var_expand(cmd, depth=1)
2524 2523 # warn if there is an IPython magic alternative.
2525 2524 main_cmd = cmd.split()[0]
2526 2525 has_magic_alternatives = ("pip", "conda", "cd", "ls")
2527 2526
2528 2527 # had to check if the command was an alias expanded because of `ls`
2529 2528 is_alias_expanded = self.alias_manager.is_alias(main_cmd) and (
2530 2529 self.alias_manager.retrieve_alias(main_cmd).strip() == cmd.strip()
2531 2530 )
2532 2531
2533 2532 if main_cmd in has_magic_alternatives and not is_alias_expanded:
2534 2533 warnings.warn(
2535 2534 (
2536 2535 "You executed the system command !{0} which may not work "
2537 2536 "as expected. Try the IPython magic %{0} instead."
2538 2537 ).format(main_cmd)
2539 2538 )
2540 2539
2541 2540 # protect os.system from UNC paths on Windows, which it can't handle:
2542 2541 if sys.platform == 'win32':
2543 2542 from IPython.utils._process_win32 import AvoidUNCPath
2544 2543 with AvoidUNCPath() as path:
2545 2544 if path is not None:
2546 2545 cmd = '"pushd %s &&"%s' % (path, cmd)
2547 2546 try:
2548 2547 ec = os.system(cmd)
2549 2548 except KeyboardInterrupt:
2550 2549 print('\n' + self.get_exception_only(), file=sys.stderr)
2551 2550 ec = -2
2552 2551 else:
2553 2552 # For posix the result of the subprocess.call() below is an exit
2554 2553 # code, which by convention is zero for success, positive for
2555 2554 # program failure. Exit codes above 128 are reserved for signals,
2556 2555 # and the formula for converting a signal to an exit code is usually
2557 2556 # signal_number+128. To more easily differentiate between exit
2558 2557 # codes and signals, ipython uses negative numbers. For instance
2559 2558 # since control-c is signal 2 but exit code 130, ipython's
2560 2559 # _exit_code variable will read -2. Note that some shells like
2561 2560 # csh and fish don't follow sh/bash conventions for exit codes.
2562 2561 executable = os.environ.get('SHELL', None)
2563 2562 try:
2564 2563 # Use env shell instead of default /bin/sh
2565 2564 ec = subprocess.call(cmd, shell=True, executable=executable)
2566 2565 except KeyboardInterrupt:
2567 2566 # intercept control-C; a long traceback is not useful here
2568 2567 print('\n' + self.get_exception_only(), file=sys.stderr)
2569 2568 ec = 130
2570 2569 if ec > 128:
2571 2570 ec = -(ec - 128)
2572 2571
2573 2572 # We explicitly do NOT return the subprocess status code, because
2574 2573 # a non-None value would trigger :func:`sys.displayhook` calls.
2575 2574 # Instead, we store the exit_code in user_ns. Note the semantics
2576 2575 # of _exit_code: for control-c, _exit_code == -signal.SIGNIT,
2577 2576 # but raising SystemExit(_exit_code) will give status 254!
2578 2577 self.user_ns['_exit_code'] = ec
2579 2578
2580 2579 # use piped system by default, because it is better behaved
2581 2580 system = system_piped
2582 2581
2583 2582 def getoutput(self, cmd, split=True, depth=0):
2584 2583 """Get output (possibly including stderr) from a subprocess.
2585 2584
2586 2585 Parameters
2587 2586 ----------
2588 2587 cmd : str
2589 2588 Command to execute (can not end in '&', as background processes are
2590 2589 not supported.
2591 2590 split : bool, optional
2592 2591 If True, split the output into an IPython SList. Otherwise, an
2593 2592 IPython LSString is returned. These are objects similar to normal
2594 2593 lists and strings, with a few convenience attributes for easier
2595 2594 manipulation of line-based output. You can use '?' on them for
2596 2595 details.
2597 2596 depth : int, optional
2598 2597 How many frames above the caller are the local variables which should
2599 2598 be expanded in the command string? The default (0) assumes that the
2600 2599 expansion variables are in the stack frame calling this function.
2601 2600 """
2602 2601 if cmd.rstrip().endswith('&'):
2603 2602 # this is *far* from a rigorous test
2604 2603 raise OSError("Background processes not supported.")
2605 2604 out = getoutput(self.var_expand(cmd, depth=depth+1))
2606 2605 if split:
2607 2606 out = SList(out.splitlines())
2608 2607 else:
2609 2608 out = LSString(out)
2610 2609 return out
2611 2610
2612 2611 #-------------------------------------------------------------------------
2613 2612 # Things related to aliases
2614 2613 #-------------------------------------------------------------------------
2615 2614
2616 2615 def init_alias(self):
2617 2616 self.alias_manager = AliasManager(shell=self, parent=self)
2618 2617 self.configurables.append(self.alias_manager)
2619 2618
2620 2619 #-------------------------------------------------------------------------
2621 2620 # Things related to extensions
2622 2621 #-------------------------------------------------------------------------
2623 2622
2624 2623 def init_extension_manager(self):
2625 2624 self.extension_manager = ExtensionManager(shell=self, parent=self)
2626 2625 self.configurables.append(self.extension_manager)
2627 2626
2628 2627 #-------------------------------------------------------------------------
2629 2628 # Things related to payloads
2630 2629 #-------------------------------------------------------------------------
2631 2630
2632 2631 def init_payload(self):
2633 2632 self.payload_manager = PayloadManager(parent=self)
2634 2633 self.configurables.append(self.payload_manager)
2635 2634
2636 2635 #-------------------------------------------------------------------------
2637 2636 # Things related to the prefilter
2638 2637 #-------------------------------------------------------------------------
2639 2638
2640 2639 def init_prefilter(self):
2641 2640 self.prefilter_manager = PrefilterManager(shell=self, parent=self)
2642 2641 self.configurables.append(self.prefilter_manager)
2643 2642 # Ultimately this will be refactored in the new interpreter code, but
2644 2643 # for now, we should expose the main prefilter method (there's legacy
2645 2644 # code out there that may rely on this).
2646 2645 self.prefilter = self.prefilter_manager.prefilter_lines
2647 2646
2648 2647 def auto_rewrite_input(self, cmd):
2649 2648 """Print to the screen the rewritten form of the user's command.
2650 2649
2651 2650 This shows visual feedback by rewriting input lines that cause
2652 2651 automatic calling to kick in, like::
2653 2652
2654 2653 /f x
2655 2654
2656 2655 into::
2657 2656
2658 2657 ------> f(x)
2659 2658
2660 2659 after the user's input prompt. This helps the user understand that the
2661 2660 input line was transformed automatically by IPython.
2662 2661 """
2663 2662 if not self.show_rewritten_input:
2664 2663 return
2665 2664
2666 2665 # This is overridden in TerminalInteractiveShell to use fancy prompts
2667 2666 print("------> " + cmd)
2668 2667
2669 2668 #-------------------------------------------------------------------------
2670 2669 # Things related to extracting values/expressions from kernel and user_ns
2671 2670 #-------------------------------------------------------------------------
2672 2671
2673 2672 def _user_obj_error(self):
2674 2673 """return simple exception dict
2675 2674
2676 2675 for use in user_expressions
2677 2676 """
2678 2677
2679 2678 etype, evalue, tb = self._get_exc_info()
2680 2679 stb = self.InteractiveTB.get_exception_only(etype, evalue)
2681 2680
2682 2681 exc_info = {
2683 2682 "status": "error",
2684 2683 "traceback": stb,
2685 2684 "ename": etype.__name__,
2686 2685 "evalue": py3compat.safe_unicode(evalue),
2687 2686 }
2688 2687
2689 2688 return exc_info
2690 2689
2691 2690 def _format_user_obj(self, obj):
2692 2691 """format a user object to display dict
2693 2692
2694 2693 for use in user_expressions
2695 2694 """
2696 2695
2697 2696 data, md = self.display_formatter.format(obj)
2698 2697 value = {
2699 2698 'status' : 'ok',
2700 2699 'data' : data,
2701 2700 'metadata' : md,
2702 2701 }
2703 2702 return value
2704 2703
2705 2704 def user_expressions(self, expressions):
2706 2705 """Evaluate a dict of expressions in the user's namespace.
2707 2706
2708 2707 Parameters
2709 2708 ----------
2710 2709 expressions : dict
2711 2710 A dict with string keys and string values. The expression values
2712 2711 should be valid Python expressions, each of which will be evaluated
2713 2712 in the user namespace.
2714 2713
2715 2714 Returns
2716 2715 -------
2717 2716 A dict, keyed like the input expressions dict, with the rich mime-typed
2718 2717 display_data of each value.
2719 2718 """
2720 2719 out = {}
2721 2720 user_ns = self.user_ns
2722 2721 global_ns = self.user_global_ns
2723 2722
2724 2723 for key, expr in expressions.items():
2725 2724 try:
2726 2725 value = self._format_user_obj(eval(expr, global_ns, user_ns))
2727 2726 except:
2728 2727 value = self._user_obj_error()
2729 2728 out[key] = value
2730 2729 return out
2731 2730
2732 2731 #-------------------------------------------------------------------------
2733 2732 # Things related to the running of code
2734 2733 #-------------------------------------------------------------------------
2735 2734
2736 2735 def ex(self, cmd):
2737 2736 """Execute a normal python statement in user namespace."""
2738 2737 with self.builtin_trap:
2739 2738 exec(cmd, self.user_global_ns, self.user_ns)
2740 2739
2741 2740 def ev(self, expr):
2742 2741 """Evaluate python expression expr in user namespace.
2743 2742
2744 2743 Returns the result of evaluation
2745 2744 """
2746 2745 with self.builtin_trap:
2747 2746 return eval(expr, self.user_global_ns, self.user_ns)
2748 2747
2749 2748 def safe_execfile(self, fname, *where, exit_ignore=False, raise_exceptions=False, shell_futures=False):
2750 2749 """A safe version of the builtin execfile().
2751 2750
2752 2751 This version will never throw an exception, but instead print
2753 2752 helpful error messages to the screen. This only works on pure
2754 2753 Python files with the .py extension.
2755 2754
2756 2755 Parameters
2757 2756 ----------
2758 2757 fname : string
2759 2758 The name of the file to be executed.
2760 2759 where : tuple
2761 2760 One or two namespaces, passed to execfile() as (globals,locals).
2762 2761 If only one is given, it is passed as both.
2763 2762 exit_ignore : bool (False)
2764 2763 If True, then silence SystemExit for non-zero status (it is always
2765 2764 silenced for zero status, as it is so common).
2766 2765 raise_exceptions : bool (False)
2767 2766 If True raise exceptions everywhere. Meant for testing.
2768 2767 shell_futures : bool (False)
2769 2768 If True, the code will share future statements with the interactive
2770 2769 shell. It will both be affected by previous __future__ imports, and
2771 2770 any __future__ imports in the code will affect the shell. If False,
2772 2771 __future__ imports are not shared in either direction.
2773 2772
2774 2773 """
2775 2774 fname = Path(fname).expanduser().resolve()
2776 2775
2777 2776 # Make sure we can open the file
2778 2777 try:
2779 2778 with fname.open():
2780 2779 pass
2781 2780 except:
2782 2781 warn('Could not open file <%s> for safe execution.' % fname)
2783 2782 return
2784 2783
2785 2784 # Find things also in current directory. This is needed to mimic the
2786 2785 # behavior of running a script from the system command line, where
2787 2786 # Python inserts the script's directory into sys.path
2788 2787 dname = str(fname.parent)
2789 2788
2790 2789 with prepended_to_syspath(dname), self.builtin_trap:
2791 2790 try:
2792 2791 glob, loc = (where + (None, ))[:2]
2793 2792 py3compat.execfile(
2794 2793 fname, glob, loc,
2795 2794 self.compile if shell_futures else None)
2796 2795 except SystemExit as status:
2797 2796 # If the call was made with 0 or None exit status (sys.exit(0)
2798 2797 # or sys.exit() ), don't bother showing a traceback, as both of
2799 2798 # these are considered normal by the OS:
2800 2799 # > python -c'import sys;sys.exit(0)'; echo $?
2801 2800 # 0
2802 2801 # > python -c'import sys;sys.exit()'; echo $?
2803 2802 # 0
2804 2803 # For other exit status, we show the exception unless
2805 2804 # explicitly silenced, but only in short form.
2806 2805 if status.code:
2807 2806 if raise_exceptions:
2808 2807 raise
2809 2808 if not exit_ignore:
2810 2809 self.showtraceback(exception_only=True)
2811 2810 except:
2812 2811 if raise_exceptions:
2813 2812 raise
2814 2813 # tb offset is 2 because we wrap execfile
2815 2814 self.showtraceback(tb_offset=2)
2816 2815
2817 2816 def safe_execfile_ipy(self, fname, shell_futures=False, raise_exceptions=False):
2818 2817 """Like safe_execfile, but for .ipy or .ipynb files with IPython syntax.
2819 2818
2820 2819 Parameters
2821 2820 ----------
2822 2821 fname : str
2823 2822 The name of the file to execute. The filename must have a
2824 2823 .ipy or .ipynb extension.
2825 2824 shell_futures : bool (False)
2826 2825 If True, the code will share future statements with the interactive
2827 2826 shell. It will both be affected by previous __future__ imports, and
2828 2827 any __future__ imports in the code will affect the shell. If False,
2829 2828 __future__ imports are not shared in either direction.
2830 2829 raise_exceptions : bool (False)
2831 2830 If True raise exceptions everywhere. Meant for testing.
2832 2831 """
2833 2832 fname = Path(fname).expanduser().resolve()
2834 2833
2835 2834 # Make sure we can open the file
2836 2835 try:
2837 2836 with fname.open():
2838 2837 pass
2839 2838 except:
2840 2839 warn('Could not open file <%s> for safe execution.' % fname)
2841 2840 return
2842 2841
2843 2842 # Find things also in current directory. This is needed to mimic the
2844 2843 # behavior of running a script from the system command line, where
2845 2844 # Python inserts the script's directory into sys.path
2846 2845 dname = str(fname.parent)
2847 2846
2848 2847 def get_cells():
2849 2848 """generator for sequence of code blocks to run"""
2850 2849 if fname.suffix == ".ipynb":
2851 2850 from nbformat import read
2852 2851 nb = read(fname, as_version=4)
2853 2852 if not nb.cells:
2854 2853 return
2855 2854 for cell in nb.cells:
2856 2855 if cell.cell_type == 'code':
2857 2856 yield cell.source
2858 2857 else:
2859 2858 yield fname.read_text()
2860 2859
2861 2860 with prepended_to_syspath(dname):
2862 2861 try:
2863 2862 for cell in get_cells():
2864 2863 result = self.run_cell(cell, silent=True, shell_futures=shell_futures)
2865 2864 if raise_exceptions:
2866 2865 result.raise_error()
2867 2866 elif not result.success:
2868 2867 break
2869 2868 except:
2870 2869 if raise_exceptions:
2871 2870 raise
2872 2871 self.showtraceback()
2873 2872 warn('Unknown failure executing file: <%s>' % fname)
2874 2873
2875 2874 def safe_run_module(self, mod_name, where):
2876 2875 """A safe version of runpy.run_module().
2877 2876
2878 2877 This version will never throw an exception, but instead print
2879 2878 helpful error messages to the screen.
2880 2879
2881 2880 `SystemExit` exceptions with status code 0 or None are ignored.
2882 2881
2883 2882 Parameters
2884 2883 ----------
2885 2884 mod_name : string
2886 2885 The name of the module to be executed.
2887 2886 where : dict
2888 2887 The globals namespace.
2889 2888 """
2890 2889 try:
2891 2890 try:
2892 2891 where.update(
2893 2892 runpy.run_module(str(mod_name), run_name="__main__",
2894 2893 alter_sys=True)
2895 2894 )
2896 2895 except SystemExit as status:
2897 2896 if status.code:
2898 2897 raise
2899 2898 except:
2900 2899 self.showtraceback()
2901 2900 warn('Unknown failure executing module: <%s>' % mod_name)
2902 2901
2903 2902 def run_cell(self, raw_cell, store_history=False, silent=False, shell_futures=True):
2904 2903 """Run a complete IPython cell.
2905 2904
2906 2905 Parameters
2907 2906 ----------
2908 2907 raw_cell : str
2909 2908 The code (including IPython code such as %magic functions) to run.
2910 2909 store_history : bool
2911 2910 If True, the raw and translated cell will be stored in IPython's
2912 2911 history. For user code calling back into IPython's machinery, this
2913 2912 should be set to False.
2914 2913 silent : bool
2915 2914 If True, avoid side-effects, such as implicit displayhooks and
2916 2915 and logging. silent=True forces store_history=False.
2917 2916 shell_futures : bool
2918 2917 If True, the code will share future statements with the interactive
2919 2918 shell. It will both be affected by previous __future__ imports, and
2920 2919 any __future__ imports in the code will affect the shell. If False,
2921 2920 __future__ imports are not shared in either direction.
2922 2921
2923 2922 Returns
2924 2923 -------
2925 2924 result : :class:`ExecutionResult`
2926 2925 """
2927 2926 result = None
2928 2927 try:
2929 2928 result = self._run_cell(
2930 2929 raw_cell, store_history, silent, shell_futures)
2931 2930 finally:
2932 2931 self.events.trigger('post_execute')
2933 2932 if not silent:
2934 2933 self.events.trigger('post_run_cell', result)
2935 2934 return result
2936 2935
2937 2936 def _run_cell(self, raw_cell:str, store_history:bool, silent:bool, shell_futures:bool) -> ExecutionResult:
2938 2937 """Internal method to run a complete IPython cell."""
2939 2938
2940 2939 # we need to avoid calling self.transform_cell multiple time on the same thing
2941 2940 # so we need to store some results:
2942 2941 preprocessing_exc_tuple = None
2943 2942 try:
2944 2943 transformed_cell = self.transform_cell(raw_cell)
2945 2944 except Exception:
2946 2945 transformed_cell = raw_cell
2947 2946 preprocessing_exc_tuple = sys.exc_info()
2948 2947
2949 2948 assert transformed_cell is not None
2950 2949 coro = self.run_cell_async(
2951 2950 raw_cell,
2952 2951 store_history=store_history,
2953 2952 silent=silent,
2954 2953 shell_futures=shell_futures,
2955 2954 transformed_cell=transformed_cell,
2956 2955 preprocessing_exc_tuple=preprocessing_exc_tuple,
2957 2956 )
2958 2957
2959 2958 # run_cell_async is async, but may not actually need an eventloop.
2960 2959 # when this is the case, we want to run it using the pseudo_sync_runner
2961 2960 # so that code can invoke eventloops (for example via the %run , and
2962 2961 # `%paste` magic.
2963 2962 if self.trio_runner:
2964 2963 runner = self.trio_runner
2965 2964 elif self.should_run_async(
2966 2965 raw_cell,
2967 2966 transformed_cell=transformed_cell,
2968 2967 preprocessing_exc_tuple=preprocessing_exc_tuple,
2969 2968 ):
2970 2969 runner = self.loop_runner
2971 2970 else:
2972 2971 runner = _pseudo_sync_runner
2973 2972
2974 2973 try:
2975 2974 return runner(coro)
2976 2975 except BaseException as e:
2977 2976 info = ExecutionInfo(raw_cell, store_history, silent, shell_futures)
2978 2977 result = ExecutionResult(info)
2979 2978 result.error_in_exec = e
2980 2979 self.showtraceback(running_compiled_code=True)
2981 2980 return result
2982 2981
2983 2982 def should_run_async(
2984 2983 self, raw_cell: str, *, transformed_cell=None, preprocessing_exc_tuple=None
2985 2984 ) -> bool:
2986 2985 """Return whether a cell should be run asynchronously via a coroutine runner
2987 2986
2988 2987 Parameters
2989 2988 ----------
2990 2989 raw_cell: str
2991 2990 The code to be executed
2992 2991
2993 2992 Returns
2994 2993 -------
2995 2994 result: bool
2996 2995 Whether the code needs to be run with a coroutine runner or not
2997 2996
2998 2997 .. versionadded: 7.0
2999 2998 """
3000 2999 if not self.autoawait:
3001 3000 return False
3002 3001 if preprocessing_exc_tuple is not None:
3003 3002 return False
3004 3003 assert preprocessing_exc_tuple is None
3005 3004 if transformed_cell is None:
3006 3005 warnings.warn(
3007 3006 "`should_run_async` will not call `transform_cell`"
3008 3007 " automatically in the future. Please pass the result to"
3009 3008 " `transformed_cell` argument and any exception that happen"
3010 3009 " during the"
3011 3010 "transform in `preprocessing_exc_tuple` in"
3012 3011 " IPython 7.17 and above.",
3013 3012 DeprecationWarning,
3014 3013 stacklevel=2,
3015 3014 )
3016 3015 try:
3017 3016 cell = self.transform_cell(raw_cell)
3018 3017 except Exception:
3019 3018 # any exception during transform will be raised
3020 3019 # prior to execution
3021 3020 return False
3022 3021 else:
3023 3022 cell = transformed_cell
3024 3023 return _should_be_async(cell)
3025 3024
3026 3025 async def run_cell_async(
3027 3026 self,
3028 3027 raw_cell: str,
3029 3028 store_history=False,
3030 3029 silent=False,
3031 3030 shell_futures=True,
3032 3031 *,
3033 3032 transformed_cell: Optional[str] = None,
3034 3033 preprocessing_exc_tuple: Optional[Any] = None
3035 3034 ) -> ExecutionResult:
3036 3035 """Run a complete IPython cell asynchronously.
3037 3036
3038 3037 Parameters
3039 3038 ----------
3040 3039 raw_cell : str
3041 3040 The code (including IPython code such as %magic functions) to run.
3042 3041 store_history : bool
3043 3042 If True, the raw and translated cell will be stored in IPython's
3044 3043 history. For user code calling back into IPython's machinery, this
3045 3044 should be set to False.
3046 3045 silent : bool
3047 3046 If True, avoid side-effects, such as implicit displayhooks and
3048 3047 and logging. silent=True forces store_history=False.
3049 3048 shell_futures : bool
3050 3049 If True, the code will share future statements with the interactive
3051 3050 shell. It will both be affected by previous __future__ imports, and
3052 3051 any __future__ imports in the code will affect the shell. If False,
3053 3052 __future__ imports are not shared in either direction.
3054 3053 transformed_cell: str
3055 3054 cell that was passed through transformers
3056 3055 preprocessing_exc_tuple:
3057 3056 trace if the transformation failed.
3058 3057
3059 3058 Returns
3060 3059 -------
3061 3060 result : :class:`ExecutionResult`
3062 3061
3063 3062 .. versionadded: 7.0
3064 3063 """
3065 3064 info = ExecutionInfo(
3066 3065 raw_cell, store_history, silent, shell_futures)
3067 3066 result = ExecutionResult(info)
3068 3067
3069 3068 if (not raw_cell) or raw_cell.isspace():
3070 3069 self.last_execution_succeeded = True
3071 3070 self.last_execution_result = result
3072 3071 return result
3073 3072
3074 3073 if silent:
3075 3074 store_history = False
3076 3075
3077 3076 if store_history:
3078 3077 result.execution_count = self.execution_count
3079 3078
3080 3079 def error_before_exec(value):
3081 3080 if store_history:
3082 3081 self.execution_count += 1
3083 3082 result.error_before_exec = value
3084 3083 self.last_execution_succeeded = False
3085 3084 self.last_execution_result = result
3086 3085 return result
3087 3086
3088 3087 self.events.trigger('pre_execute')
3089 3088 if not silent:
3090 3089 self.events.trigger('pre_run_cell', info)
3091 3090
3092 3091 if transformed_cell is None:
3093 3092 warnings.warn(
3094 3093 "`run_cell_async` will not call `transform_cell`"
3095 3094 " automatically in the future. Please pass the result to"
3096 3095 " `transformed_cell` argument and any exception that happen"
3097 3096 " during the"
3098 3097 "transform in `preprocessing_exc_tuple` in"
3099 3098 " IPython 7.17 and above.",
3100 3099 DeprecationWarning,
3101 3100 stacklevel=2,
3102 3101 )
3103 3102 # If any of our input transformation (input_transformer_manager or
3104 3103 # prefilter_manager) raises an exception, we store it in this variable
3105 3104 # so that we can display the error after logging the input and storing
3106 3105 # it in the history.
3107 3106 try:
3108 3107 cell = self.transform_cell(raw_cell)
3109 3108 except Exception:
3110 3109 preprocessing_exc_tuple = sys.exc_info()
3111 3110 cell = raw_cell # cell has to exist so it can be stored/logged
3112 3111 else:
3113 3112 preprocessing_exc_tuple = None
3114 3113 else:
3115 3114 if preprocessing_exc_tuple is None:
3116 3115 cell = transformed_cell
3117 3116 else:
3118 3117 cell = raw_cell
3119 3118
3120 3119 # Store raw and processed history
3121 3120 if store_history:
3122 3121 self.history_manager.store_inputs(self.execution_count,
3123 3122 cell, raw_cell)
3124 3123 if not silent:
3125 3124 self.logger.log(cell, raw_cell)
3126 3125
3127 3126 # Display the exception if input processing failed.
3128 3127 if preprocessing_exc_tuple is not None:
3129 3128 self.showtraceback(preprocessing_exc_tuple)
3130 3129 if store_history:
3131 3130 self.execution_count += 1
3132 3131 return error_before_exec(preprocessing_exc_tuple[1])
3133 3132
3134 3133 # Our own compiler remembers the __future__ environment. If we want to
3135 3134 # run code with a separate __future__ environment, use the default
3136 3135 # compiler
3137 3136 compiler = self.compile if shell_futures else self.compiler_class()
3138 3137
3139 3138 _run_async = False
3140 3139
3141 3140 with self.builtin_trap:
3142 3141 cell_name = compiler.cache(cell, self.execution_count, raw_code=raw_cell)
3143 3142
3144 3143 with self.display_trap:
3145 3144 # Compile to bytecode
3146 3145 try:
3147 3146 if sys.version_info < (3,8) and self.autoawait:
3148 3147 if _should_be_async(cell):
3149 3148 # the code AST below will not be user code: we wrap it
3150 3149 # in an `async def`. This will likely make some AST
3151 3150 # transformer below miss some transform opportunity and
3152 3151 # introduce a small coupling to run_code (in which we
3153 3152 # bake some assumptions of what _ast_asyncify returns.
3154 3153 # they are ways around (like grafting part of the ast
3155 3154 # later:
3156 3155 # - Here, return code_ast.body[0].body[1:-1], as well
3157 3156 # as last expression in return statement which is
3158 3157 # the user code part.
3159 3158 # - Let it go through the AST transformers, and graft
3160 3159 # - it back after the AST transform
3161 3160 # But that seem unreasonable, at least while we
3162 3161 # do not need it.
3163 3162 code_ast = _ast_asyncify(cell, 'async-def-wrapper')
3164 3163 _run_async = True
3165 3164 else:
3166 3165 code_ast = compiler.ast_parse(cell, filename=cell_name)
3167 3166 else:
3168 3167 code_ast = compiler.ast_parse(cell, filename=cell_name)
3169 3168 except self.custom_exceptions as e:
3170 3169 etype, value, tb = sys.exc_info()
3171 3170 self.CustomTB(etype, value, tb)
3172 3171 return error_before_exec(e)
3173 3172 except IndentationError as e:
3174 3173 self.showindentationerror()
3175 3174 return error_before_exec(e)
3176 3175 except (OverflowError, SyntaxError, ValueError, TypeError,
3177 3176 MemoryError) as e:
3178 3177 self.showsyntaxerror()
3179 3178 return error_before_exec(e)
3180 3179
3181 3180 # Apply AST transformations
3182 3181 try:
3183 3182 code_ast = self.transform_ast(code_ast)
3184 3183 except InputRejected as e:
3185 3184 self.showtraceback()
3186 3185 return error_before_exec(e)
3187 3186
3188 3187 # Give the displayhook a reference to our ExecutionResult so it
3189 3188 # can fill in the output value.
3190 3189 self.displayhook.exec_result = result
3191 3190
3192 3191 # Execute the user code
3193 3192 interactivity = "none" if silent else self.ast_node_interactivity
3194 3193 if _run_async:
3195 3194 interactivity = 'async'
3196 3195
3197 3196 has_raised = await self.run_ast_nodes(code_ast.body, cell_name,
3198 3197 interactivity=interactivity, compiler=compiler, result=result)
3199 3198
3200 3199 self.last_execution_succeeded = not has_raised
3201 3200 self.last_execution_result = result
3202 3201
3203 3202 # Reset this so later displayed values do not modify the
3204 3203 # ExecutionResult
3205 3204 self.displayhook.exec_result = None
3206 3205
3207 3206 if store_history:
3208 3207 # Write output to the database. Does nothing unless
3209 3208 # history output logging is enabled.
3210 3209 self.history_manager.store_output(self.execution_count)
3211 3210 # Each cell is a *single* input, regardless of how many lines it has
3212 3211 self.execution_count += 1
3213 3212
3214 3213 return result
3215 3214
3216 3215 def transform_cell(self, raw_cell):
3217 3216 """Transform an input cell before parsing it.
3218 3217
3219 3218 Static transformations, implemented in IPython.core.inputtransformer2,
3220 3219 deal with things like ``%magic`` and ``!system`` commands.
3221 3220 These run on all input.
3222 3221 Dynamic transformations, for things like unescaped magics and the exit
3223 3222 autocall, depend on the state of the interpreter.
3224 3223 These only apply to single line inputs.
3225 3224
3226 3225 These string-based transformations are followed by AST transformations;
3227 3226 see :meth:`transform_ast`.
3228 3227 """
3229 3228 # Static input transformations
3230 3229 cell = self.input_transformer_manager.transform_cell(raw_cell)
3231 3230
3232 3231 if len(cell.splitlines()) == 1:
3233 3232 # Dynamic transformations - only applied for single line commands
3234 3233 with self.builtin_trap:
3235 3234 # use prefilter_lines to handle trailing newlines
3236 3235 # restore trailing newline for ast.parse
3237 3236 cell = self.prefilter_manager.prefilter_lines(cell) + '\n'
3238 3237
3239 3238 lines = cell.splitlines(keepends=True)
3240 3239 for transform in self.input_transformers_post:
3241 3240 lines = transform(lines)
3242 3241 cell = ''.join(lines)
3243 3242
3244 3243 return cell
3245 3244
3246 3245 def transform_ast(self, node):
3247 3246 """Apply the AST transformations from self.ast_transformers
3248 3247
3249 3248 Parameters
3250 3249 ----------
3251 3250 node : ast.Node
3252 3251 The root node to be transformed. Typically called with the ast.Module
3253 3252 produced by parsing user input.
3254 3253
3255 3254 Returns
3256 3255 -------
3257 3256 An ast.Node corresponding to the node it was called with. Note that it
3258 3257 may also modify the passed object, so don't rely on references to the
3259 3258 original AST.
3260 3259 """
3261 3260 for transformer in self.ast_transformers:
3262 3261 try:
3263 3262 node = transformer.visit(node)
3264 3263 except InputRejected:
3265 3264 # User-supplied AST transformers can reject an input by raising
3266 3265 # an InputRejected. Short-circuit in this case so that we
3267 3266 # don't unregister the transform.
3268 3267 raise
3269 3268 except Exception:
3270 3269 warn("AST transformer %r threw an error. It will be unregistered." % transformer)
3271 3270 self.ast_transformers.remove(transformer)
3272 3271
3273 3272 if self.ast_transformers:
3274 3273 ast.fix_missing_locations(node)
3275 3274 return node
3276 3275
3277 3276 async def run_ast_nodes(self, nodelist:ListType[AST], cell_name:str, interactivity='last_expr',
3278 3277 compiler=compile, result=None):
3279 3278 """Run a sequence of AST nodes. The execution mode depends on the
3280 3279 interactivity parameter.
3281 3280
3282 3281 Parameters
3283 3282 ----------
3284 3283 nodelist : list
3285 3284 A sequence of AST nodes to run.
3286 3285 cell_name : str
3287 3286 Will be passed to the compiler as the filename of the cell. Typically
3288 3287 the value returned by ip.compile.cache(cell).
3289 3288 interactivity : str
3290 3289 'all', 'last', 'last_expr' , 'last_expr_or_assign' or 'none',
3291 3290 specifying which nodes should be run interactively (displaying output
3292 3291 from expressions). 'last_expr' will run the last node interactively
3293 3292 only if it is an expression (i.e. expressions in loops or other blocks
3294 3293 are not displayed) 'last_expr_or_assign' will run the last expression
3295 3294 or the last assignment. Other values for this parameter will raise a
3296 3295 ValueError.
3297 3296
3298 3297 Experimental value: 'async' Will try to run top level interactive
3299 3298 async/await code in default runner, this will not respect the
3300 3299 interactivity setting and will only run the last node if it is an
3301 3300 expression.
3302 3301
3303 3302 compiler : callable
3304 3303 A function with the same interface as the built-in compile(), to turn
3305 3304 the AST nodes into code objects. Default is the built-in compile().
3306 3305 result : ExecutionResult, optional
3307 3306 An object to store exceptions that occur during execution.
3308 3307
3309 3308 Returns
3310 3309 -------
3311 3310 True if an exception occurred while running code, False if it finished
3312 3311 running.
3313 3312 """
3314 3313 if not nodelist:
3315 3314 return
3316 3315
3317 3316 if interactivity == 'last_expr_or_assign':
3318 3317 if isinstance(nodelist[-1], _assign_nodes):
3319 3318 asg = nodelist[-1]
3320 3319 if isinstance(asg, ast.Assign) and len(asg.targets) == 1:
3321 3320 target = asg.targets[0]
3322 3321 elif isinstance(asg, _single_targets_nodes):
3323 3322 target = asg.target
3324 3323 else:
3325 3324 target = None
3326 3325 if isinstance(target, ast.Name):
3327 3326 nnode = ast.Expr(ast.Name(target.id, ast.Load()))
3328 3327 ast.fix_missing_locations(nnode)
3329 3328 nodelist.append(nnode)
3330 3329 interactivity = 'last_expr'
3331 3330
3332 3331 _async = False
3333 3332 if interactivity == 'last_expr':
3334 3333 if isinstance(nodelist[-1], ast.Expr):
3335 3334 interactivity = "last"
3336 3335 else:
3337 3336 interactivity = "none"
3338 3337
3339 3338 if interactivity == 'none':
3340 3339 to_run_exec, to_run_interactive = nodelist, []
3341 3340 elif interactivity == 'last':
3342 3341 to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:]
3343 3342 elif interactivity == 'all':
3344 3343 to_run_exec, to_run_interactive = [], nodelist
3345 3344 elif interactivity == 'async':
3346 3345 to_run_exec, to_run_interactive = [], nodelist
3347 3346 _async = True
3348 3347 else:
3349 3348 raise ValueError("Interactivity was %r" % interactivity)
3350 3349
3351 3350 try:
3352 3351 if _async and sys.version_info > (3,8):
3353 3352 raise ValueError("This branch should never happen on Python 3.8 and above, "
3354 3353 "please try to upgrade IPython and open a bug report with your case.")
3355 3354 if _async:
3356 3355 # If interactivity is async the semantics of run_code are
3357 3356 # completely different Skip usual machinery.
3358 3357 mod = Module(nodelist, [])
3359 3358 async_wrapper_code = compiler(mod, cell_name, 'exec')
3360 3359 exec(async_wrapper_code, self.user_global_ns, self.user_ns)
3361 3360 async_code = removed_co_newlocals(self.user_ns.pop('async-def-wrapper')).__code__
3362 3361 if (await self.run_code(async_code, result, async_=True)):
3363 3362 return True
3364 3363 else:
3365 3364 if sys.version_info > (3, 8):
3366 3365 def compare(code):
3367 3366 is_async = (inspect.CO_COROUTINE & code.co_flags == inspect.CO_COROUTINE)
3368 3367 return is_async
3369 3368 else:
3370 3369 def compare(code):
3371 3370 return _async
3372 3371
3373 3372 # refactor that to just change the mod constructor.
3374 3373 to_run = []
3375 3374 for node in to_run_exec:
3376 3375 to_run.append((node, 'exec'))
3377 3376
3378 3377 for node in to_run_interactive:
3379 3378 to_run.append((node, 'single'))
3380 3379
3381 3380 for node,mode in to_run:
3382 3381 if mode == 'exec':
3383 3382 mod = Module([node], [])
3384 3383 elif mode == 'single':
3385 3384 mod = ast.Interactive([node])
3386 3385 with compiler.extra_flags(getattr(ast, 'PyCF_ALLOW_TOP_LEVEL_AWAIT', 0x0) if self.autoawait else 0x0):
3387 3386 code = compiler(mod, cell_name, mode)
3388 3387 asy = compare(code)
3389 3388 if (await self.run_code(code, result, async_=asy)):
3390 3389 return True
3391 3390
3392 3391 # Flush softspace
3393 3392 if softspace(sys.stdout, 0):
3394 3393 print()
3395 3394
3396 3395 except:
3397 3396 # It's possible to have exceptions raised here, typically by
3398 3397 # compilation of odd code (such as a naked 'return' outside a
3399 3398 # function) that did parse but isn't valid. Typically the exception
3400 3399 # is a SyntaxError, but it's safest just to catch anything and show
3401 3400 # the user a traceback.
3402 3401
3403 3402 # We do only one try/except outside the loop to minimize the impact
3404 3403 # on runtime, and also because if any node in the node list is
3405 3404 # broken, we should stop execution completely.
3406 3405 if result:
3407 3406 result.error_before_exec = sys.exc_info()[1]
3408 3407 self.showtraceback()
3409 3408 return True
3410 3409
3411 3410 return False
3412 3411
3413 3412 def _async_exec(self, code_obj: types.CodeType, user_ns: dict):
3414 3413 """
3415 3414 Evaluate an asynchronous code object using a code runner
3416 3415
3417 3416 Fake asynchronous execution of code_object in a namespace via a proxy namespace.
3418 3417
3419 3418 Returns coroutine object, which can be executed via async loop runner
3420 3419
3421 3420 WARNING: The semantics of `async_exec` are quite different from `exec`,
3422 3421 in particular you can only pass a single namespace. It also return a
3423 3422 handle to the value of the last things returned by code_object.
3424 3423 """
3425 3424
3426 3425 return eval(code_obj, user_ns)
3427 3426
3428 3427 async def run_code(self, code_obj, result=None, *, async_=False):
3429 3428 """Execute a code object.
3430 3429
3431 3430 When an exception occurs, self.showtraceback() is called to display a
3432 3431 traceback.
3433 3432
3434 3433 Parameters
3435 3434 ----------
3436 3435 code_obj : code object
3437 3436 A compiled code object, to be executed
3438 3437 result : ExecutionResult, optional
3439 3438 An object to store exceptions that occur during execution.
3440 3439 async_ : Bool (Experimental)
3441 3440 Attempt to run top-level asynchronous code in a default loop.
3442 3441
3443 3442 Returns
3444 3443 -------
3445 3444 False : successful execution.
3446 3445 True : an error occurred.
3447 3446 """
3448 3447 # special value to say that anything above is IPython and should be
3449 3448 # hidden.
3450 3449 __tracebackhide__ = "__ipython_bottom__"
3451 3450 # Set our own excepthook in case the user code tries to call it
3452 3451 # directly, so that the IPython crash handler doesn't get triggered
3453 3452 old_excepthook, sys.excepthook = sys.excepthook, self.excepthook
3454 3453
3455 3454 # we save the original sys.excepthook in the instance, in case config
3456 3455 # code (such as magics) needs access to it.
3457 3456 self.sys_excepthook = old_excepthook
3458 3457 outflag = True # happens in more places, so it's easier as default
3459 3458 try:
3460 3459 try:
3461 3460 self.hooks.pre_run_code_hook()
3462 3461 if async_ and sys.version_info < (3,8):
3463 3462 last_expr = (await self._async_exec(code_obj, self.user_ns))
3464 3463 code = compile('last_expr', 'fake', "single")
3465 3464 exec(code, {'last_expr': last_expr})
3466 3465 elif async_ :
3467 3466 await eval(code_obj, self.user_global_ns, self.user_ns)
3468 3467 else:
3469 3468 exec(code_obj, self.user_global_ns, self.user_ns)
3470 3469 finally:
3471 3470 # Reset our crash handler in place
3472 3471 sys.excepthook = old_excepthook
3473 3472 except SystemExit as e:
3474 3473 if result is not None:
3475 3474 result.error_in_exec = e
3476 3475 self.showtraceback(exception_only=True)
3477 3476 warn("To exit: use 'exit', 'quit', or Ctrl-D.", stacklevel=1)
3478 3477 except self.custom_exceptions:
3479 3478 etype, value, tb = sys.exc_info()
3480 3479 if result is not None:
3481 3480 result.error_in_exec = value
3482 3481 self.CustomTB(etype, value, tb)
3483 3482 except:
3484 3483 if result is not None:
3485 3484 result.error_in_exec = sys.exc_info()[1]
3486 3485 self.showtraceback(running_compiled_code=True)
3487 3486 else:
3488 3487 outflag = False
3489 3488 return outflag
3490 3489
3491 3490 # For backwards compatibility
3492 3491 runcode = run_code
3493 3492
3494 3493 def check_complete(self, code: str) -> Tuple[str, str]:
3495 3494 """Return whether a block of code is ready to execute, or should be continued
3496 3495
3497 3496 Parameters
3498 3497 ----------
3499 3498 source : string
3500 3499 Python input code, which can be multiline.
3501 3500
3502 3501 Returns
3503 3502 -------
3504 3503 status : str
3505 3504 One of 'complete', 'incomplete', or 'invalid' if source is not a
3506 3505 prefix of valid code.
3507 3506 indent : str
3508 3507 When status is 'incomplete', this is some whitespace to insert on
3509 3508 the next line of the prompt.
3510 3509 """
3511 3510 status, nspaces = self.input_transformer_manager.check_complete(code)
3512 3511 return status, ' ' * (nspaces or 0)
3513 3512
3514 3513 #-------------------------------------------------------------------------
3515 3514 # Things related to GUI support and pylab
3516 3515 #-------------------------------------------------------------------------
3517 3516
3518 3517 active_eventloop = None
3519 3518
3520 3519 def enable_gui(self, gui=None):
3521 3520 raise NotImplementedError('Implement enable_gui in a subclass')
3522 3521
3523 3522 def enable_matplotlib(self, gui=None):
3524 3523 """Enable interactive matplotlib and inline figure support.
3525 3524
3526 3525 This takes the following steps:
3527 3526
3528 3527 1. select the appropriate eventloop and matplotlib backend
3529 3528 2. set up matplotlib for interactive use with that backend
3530 3529 3. configure formatters for inline figure display
3531 3530 4. enable the selected gui eventloop
3532 3531
3533 3532 Parameters
3534 3533 ----------
3535 3534 gui : optional, string
3536 3535 If given, dictates the choice of matplotlib GUI backend to use
3537 3536 (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
3538 3537 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
3539 3538 matplotlib (as dictated by the matplotlib build-time options plus the
3540 3539 user's matplotlibrc configuration file). Note that not all backends
3541 3540 make sense in all contexts, for example a terminal ipython can't
3542 3541 display figures inline.
3543 3542 """
3544 3543 from IPython.core import pylabtools as pt
3545 3544 from matplotlib_inline.backend_inline import configure_inline_support
3546 3545 gui, backend = pt.find_gui_and_backend(gui, self.pylab_gui_select)
3547 3546
3548 3547 if gui != 'inline':
3549 3548 # If we have our first gui selection, store it
3550 3549 if self.pylab_gui_select is None:
3551 3550 self.pylab_gui_select = gui
3552 3551 # Otherwise if they are different
3553 3552 elif gui != self.pylab_gui_select:
3554 3553 print('Warning: Cannot change to a different GUI toolkit: %s.'
3555 3554 ' Using %s instead.' % (gui, self.pylab_gui_select))
3556 3555 gui, backend = pt.find_gui_and_backend(self.pylab_gui_select)
3557 3556
3558 3557 pt.activate_matplotlib(backend)
3559 3558 configure_inline_support(self, backend)
3560 3559
3561 3560 # Now we must activate the gui pylab wants to use, and fix %run to take
3562 3561 # plot updates into account
3563 3562 self.enable_gui(gui)
3564 3563 self.magics_manager.registry['ExecutionMagics'].default_runner = \
3565 3564 pt.mpl_runner(self.safe_execfile)
3566 3565
3567 3566 return gui, backend
3568 3567
3569 3568 def enable_pylab(self, gui=None, import_all=True, welcome_message=False):
3570 3569 """Activate pylab support at runtime.
3571 3570
3572 3571 This turns on support for matplotlib, preloads into the interactive
3573 3572 namespace all of numpy and pylab, and configures IPython to correctly
3574 3573 interact with the GUI event loop. The GUI backend to be used can be
3575 3574 optionally selected with the optional ``gui`` argument.
3576 3575
3577 3576 This method only adds preloading the namespace to InteractiveShell.enable_matplotlib.
3578 3577
3579 3578 Parameters
3580 3579 ----------
3581 3580 gui : optional, string
3582 3581 If given, dictates the choice of matplotlib GUI backend to use
3583 3582 (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
3584 3583 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
3585 3584 matplotlib (as dictated by the matplotlib build-time options plus the
3586 3585 user's matplotlibrc configuration file). Note that not all backends
3587 3586 make sense in all contexts, for example a terminal ipython can't
3588 3587 display figures inline.
3589 3588 import_all : optional, bool, default: True
3590 3589 Whether to do `from numpy import *` and `from pylab import *`
3591 3590 in addition to module imports.
3592 3591 welcome_message : deprecated
3593 3592 This argument is ignored, no welcome message will be displayed.
3594 3593 """
3595 3594 from IPython.core.pylabtools import import_pylab
3596 3595
3597 3596 gui, backend = self.enable_matplotlib(gui)
3598 3597
3599 3598 # We want to prevent the loading of pylab to pollute the user's
3600 3599 # namespace as shown by the %who* magics, so we execute the activation
3601 3600 # code in an empty namespace, and we update *both* user_ns and
3602 3601 # user_ns_hidden with this information.
3603 3602 ns = {}
3604 3603 import_pylab(ns, import_all)
3605 3604 # warn about clobbered names
3606 3605 ignored = {"__builtins__"}
3607 3606 both = set(ns).intersection(self.user_ns).difference(ignored)
3608 3607 clobbered = [ name for name in both if self.user_ns[name] is not ns[name] ]
3609 3608 self.user_ns.update(ns)
3610 3609 self.user_ns_hidden.update(ns)
3611 3610 return gui, backend, clobbered
3612 3611
3613 3612 #-------------------------------------------------------------------------
3614 3613 # Utilities
3615 3614 #-------------------------------------------------------------------------
3616 3615
3617 3616 def var_expand(self, cmd, depth=0, formatter=DollarFormatter()):
3618 3617 """Expand python variables in a string.
3619 3618
3620 3619 The depth argument indicates how many frames above the caller should
3621 3620 be walked to look for the local namespace where to expand variables.
3622 3621
3623 3622 The global namespace for expansion is always the user's interactive
3624 3623 namespace.
3625 3624 """
3626 3625 ns = self.user_ns.copy()
3627 3626 try:
3628 3627 frame = sys._getframe(depth+1)
3629 3628 except ValueError:
3630 3629 # This is thrown if there aren't that many frames on the stack,
3631 3630 # e.g. if a script called run_line_magic() directly.
3632 3631 pass
3633 3632 else:
3634 3633 ns.update(frame.f_locals)
3635 3634
3636 3635 try:
3637 3636 # We have to use .vformat() here, because 'self' is a valid and common
3638 3637 # name, and expanding **ns for .format() would make it collide with
3639 3638 # the 'self' argument of the method.
3640 3639 cmd = formatter.vformat(cmd, args=[], kwargs=ns)
3641 3640 except Exception:
3642 3641 # if formatter couldn't format, just let it go untransformed
3643 3642 pass
3644 3643 return cmd
3645 3644
3646 3645 def mktempfile(self, data=None, prefix='ipython_edit_'):
3647 3646 """Make a new tempfile and return its filename.
3648 3647
3649 3648 This makes a call to tempfile.mkstemp (created in a tempfile.mkdtemp),
3650 3649 but it registers the created filename internally so ipython cleans it up
3651 3650 at exit time.
3652 3651
3653 3652 Optional inputs:
3654 3653
3655 3654 - data(None): if data is given, it gets written out to the temp file
3656 3655 immediately, and the file is closed again."""
3657 3656
3658 3657 dir_path = Path(tempfile.mkdtemp(prefix=prefix))
3659 3658 self.tempdirs.append(dir_path)
3660 3659
3661 3660 handle, filename = tempfile.mkstemp(".py", prefix, dir=str(dir_path))
3662 3661 os.close(handle) # On Windows, there can only be one open handle on a file
3663 3662
3664 3663 file_path = Path(filename)
3665 3664 self.tempfiles.append(file_path)
3666 3665
3667 3666 if data:
3668 3667 file_path.write_text(data)
3669 3668 return filename
3670 3669
3671 3670 @undoc
3672 3671 def write(self,data):
3673 3672 """DEPRECATED: Write a string to the default output"""
3674 3673 warn('InteractiveShell.write() is deprecated, use sys.stdout instead',
3675 3674 DeprecationWarning, stacklevel=2)
3676 3675 sys.stdout.write(data)
3677 3676
3678 3677 @undoc
3679 3678 def write_err(self,data):
3680 3679 """DEPRECATED: Write a string to the default error output"""
3681 3680 warn('InteractiveShell.write_err() is deprecated, use sys.stderr instead',
3682 3681 DeprecationWarning, stacklevel=2)
3683 3682 sys.stderr.write(data)
3684 3683
3685 3684 def ask_yes_no(self, prompt, default=None, interrupt=None):
3686 3685 if self.quiet:
3687 3686 return True
3688 3687 return ask_yes_no(prompt,default,interrupt)
3689 3688
3690 3689 def show_usage(self):
3691 3690 """Show a usage message"""
3692 3691 page.page(IPython.core.usage.interactive_usage)
3693 3692
3694 3693 def extract_input_lines(self, range_str, raw=False):
3695 3694 """Return as a string a set of input history slices.
3696 3695
3697 3696 Parameters
3698 3697 ----------
3699 3698 range_str : str
3700 3699 The set of slices is given as a string, like "~5/6-~4/2 4:8 9",
3701 3700 since this function is for use by magic functions which get their
3702 3701 arguments as strings. The number before the / is the session
3703 3702 number: ~n goes n back from the current session.
3704 3703
3705 3704 If empty string is given, returns history of current session
3706 3705 without the last input.
3707 3706
3708 3707 raw : bool, optional
3709 3708 By default, the processed input is used. If this is true, the raw
3710 3709 input history is used instead.
3711 3710
3712 3711 Notes
3713 3712 -----
3714 3713
3715 3714 Slices can be described with two notations:
3716 3715
3717 3716 * ``N:M`` -> standard python form, means including items N...(M-1).
3718 3717 * ``N-M`` -> include items N..M (closed endpoint).
3719 3718 """
3720 3719 lines = self.history_manager.get_range_by_str(range_str, raw=raw)
3721 3720 text = "\n".join(x for _, _, x in lines)
3722 3721
3723 3722 # Skip the last line, as it's probably the magic that called this
3724 3723 if not range_str:
3725 3724 if "\n" not in text:
3726 3725 text = ""
3727 3726 else:
3728 3727 text = text[: text.rfind("\n")]
3729 3728
3730 3729 return text
3731 3730
3732 3731 def find_user_code(self, target, raw=True, py_only=False, skip_encoding_cookie=True, search_ns=False):
3733 3732 """Get a code string from history, file, url, or a string or macro.
3734 3733
3735 3734 This is mainly used by magic functions.
3736 3735
3737 3736 Parameters
3738 3737 ----------
3739 3738 target : str
3740 3739 A string specifying code to retrieve. This will be tried respectively
3741 3740 as: ranges of input history (see %history for syntax), url,
3742 3741 corresponding .py file, filename, or an expression evaluating to a
3743 3742 string or Macro in the user namespace.
3744 3743
3745 3744 If empty string is given, returns complete history of current
3746 3745 session, without the last line.
3747 3746
3748 3747 raw : bool
3749 3748 If true (default), retrieve raw history. Has no effect on the other
3750 3749 retrieval mechanisms.
3751 3750
3752 3751 py_only : bool (default False)
3753 3752 Only try to fetch python code, do not try alternative methods to decode file
3754 3753 if unicode fails.
3755 3754
3756 3755 Returns
3757 3756 -------
3758 3757 A string of code.
3759 3758
3760 3759 ValueError is raised if nothing is found, and TypeError if it evaluates
3761 3760 to an object of another type. In each case, .args[0] is a printable
3762 3761 message.
3763 3762 """
3764 3763 code = self.extract_input_lines(target, raw=raw) # Grab history
3765 3764 if code:
3766 3765 return code
3767 3766 try:
3768 3767 if target.startswith(('http://', 'https://')):
3769 3768 return openpy.read_py_url(target, skip_encoding_cookie=skip_encoding_cookie)
3770 3769 except UnicodeDecodeError as e:
3771 3770 if not py_only :
3772 3771 # Deferred import
3773 3772 from urllib.request import urlopen
3774 3773 response = urlopen(target)
3775 3774 return response.read().decode('latin1')
3776 3775 raise ValueError(("'%s' seem to be unreadable.") % target) from e
3777 3776
3778 3777 potential_target = [target]
3779 3778 try :
3780 3779 potential_target.insert(0,get_py_filename(target))
3781 3780 except IOError:
3782 3781 pass
3783 3782
3784 3783 for tgt in potential_target :
3785 3784 if os.path.isfile(tgt): # Read file
3786 3785 try :
3787 3786 return openpy.read_py_file(tgt, skip_encoding_cookie=skip_encoding_cookie)
3788 3787 except UnicodeDecodeError as e:
3789 3788 if not py_only :
3790 3789 with io_open(tgt,'r', encoding='latin1') as f :
3791 3790 return f.read()
3792 3791 raise ValueError(("'%s' seem to be unreadable.") % target) from e
3793 3792 elif os.path.isdir(os.path.expanduser(tgt)):
3794 3793 raise ValueError("'%s' is a directory, not a regular file." % target)
3795 3794
3796 3795 if search_ns:
3797 3796 # Inspect namespace to load object source
3798 3797 object_info = self.object_inspect(target, detail_level=1)
3799 3798 if object_info['found'] and object_info['source']:
3800 3799 return object_info['source']
3801 3800
3802 3801 try: # User namespace
3803 3802 codeobj = eval(target, self.user_ns)
3804 3803 except Exception as e:
3805 3804 raise ValueError(("'%s' was not found in history, as a file, url, "
3806 3805 "nor in the user namespace.") % target) from e
3807 3806
3808 3807 if isinstance(codeobj, str):
3809 3808 return codeobj
3810 3809 elif isinstance(codeobj, Macro):
3811 3810 return codeobj.value
3812 3811
3813 3812 raise TypeError("%s is neither a string nor a macro." % target,
3814 3813 codeobj)
3815 3814
3816 3815 def _atexit_once(self):
3817 3816 """
3818 3817 At exist operation that need to be called at most once.
3819 3818 Second call to this function per instance will do nothing.
3820 3819 """
3821 3820
3822 3821 if not getattr(self, "_atexit_once_called", False):
3823 3822 self._atexit_once_called = True
3824 3823 # Clear all user namespaces to release all references cleanly.
3825 3824 self.reset(new_session=False)
3826 3825 # Close the history session (this stores the end time and line count)
3827 3826 # this must be *before* the tempfile cleanup, in case of temporary
3828 3827 # history db
3829 3828 self.history_manager.end_session()
3830 3829 self.history_manager = None
3831 3830
3832 3831 #-------------------------------------------------------------------------
3833 3832 # Things related to IPython exiting
3834 3833 #-------------------------------------------------------------------------
3835 3834 def atexit_operations(self):
3836 3835 """This will be executed at the time of exit.
3837 3836
3838 3837 Cleanup operations and saving of persistent data that is done
3839 3838 unconditionally by IPython should be performed here.
3840 3839
3841 3840 For things that may depend on startup flags or platform specifics (such
3842 3841 as having readline or not), register a separate atexit function in the
3843 3842 code that has the appropriate information, rather than trying to
3844 3843 clutter
3845 3844 """
3846 3845 self._atexit_once()
3847 3846
3848 3847 # Cleanup all tempfiles and folders left around
3849 3848 for tfile in self.tempfiles:
3850 3849 try:
3851 3850 tfile.unlink()
3852 3851 self.tempfiles.remove(tfile)
3853 3852 except FileNotFoundError:
3854 3853 pass
3855 3854 del self.tempfiles
3856 3855 for tdir in self.tempdirs:
3857 3856 try:
3858 3857 tdir.rmdir()
3859 3858 self.tempdirs.remove(tdir)
3860 3859 except FileNotFoundError:
3861 3860 pass
3862 3861 del self.tempdirs
3863 3862
3864 3863
3865 3864 # Run user hooks
3866 3865 self.hooks.shutdown_hook()
3867 3866
3868 3867 def cleanup(self):
3869 3868 self.restore_sys_module_state()
3870 3869
3871 3870
3872 3871 # Overridden in terminal subclass to change prompts
3873 3872 def switch_doctest_mode(self, mode):
3874 3873 pass
3875 3874
3876 3875
3877 3876 class InteractiveShellABC(metaclass=abc.ABCMeta):
3878 3877 """An abstract base class for InteractiveShell."""
3879 3878
3880 3879 InteractiveShellABC.register(InteractiveShell)
General Comments 0
You need to be logged in to leave comments. Login now