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