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