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