##// END OF EJS Templates
Fix exec statements for Py 3...
Thomas Kluyver -
Show More
@@ -1,821 +1,821 b''
1 1 """A simple configuration system.
2 2
3 3 Inheritance diagram:
4 4
5 5 .. inheritance-diagram:: IPython.config.loader
6 6 :parts: 3
7 7
8 8 Authors
9 9 -------
10 10 * Brian Granger
11 11 * Fernando Perez
12 12 * Min RK
13 13 """
14 14
15 15 #-----------------------------------------------------------------------------
16 16 # Copyright (C) 2008-2011 The IPython Development Team
17 17 #
18 18 # Distributed under the terms of the BSD License. The full license is in
19 19 # the file COPYING, distributed as part of this software.
20 20 #-----------------------------------------------------------------------------
21 21
22 22 #-----------------------------------------------------------------------------
23 23 # Imports
24 24 #-----------------------------------------------------------------------------
25 25
26 26 import __builtin__ as builtin_mod
27 27 import argparse
28 28 import copy
29 29 import os
30 30 import re
31 31 import sys
32 32
33 33 from IPython.utils.path import filefind, get_ipython_dir
34 34 from IPython.utils import py3compat, warn
35 35 from IPython.utils.encoding import DEFAULT_ENCODING
36 36 from IPython.utils.traitlets import HasTraits, List, Any, TraitError
37 37
38 38 #-----------------------------------------------------------------------------
39 39 # Exceptions
40 40 #-----------------------------------------------------------------------------
41 41
42 42
43 43 class ConfigError(Exception):
44 44 pass
45 45
46 46 class ConfigLoaderError(ConfigError):
47 47 pass
48 48
49 49 class ConfigFileNotFound(ConfigError):
50 50 pass
51 51
52 52 class ArgumentError(ConfigLoaderError):
53 53 pass
54 54
55 55 #-----------------------------------------------------------------------------
56 56 # Argparse fix
57 57 #-----------------------------------------------------------------------------
58 58
59 59 # Unfortunately argparse by default prints help messages to stderr instead of
60 60 # stdout. This makes it annoying to capture long help screens at the command
61 61 # line, since one must know how to pipe stderr, which many users don't know how
62 62 # to do. So we override the print_help method with one that defaults to
63 63 # stdout and use our class instead.
64 64
65 65 class ArgumentParser(argparse.ArgumentParser):
66 66 """Simple argparse subclass that prints help to stdout by default."""
67 67
68 68 def print_help(self, file=None):
69 69 if file is None:
70 70 file = sys.stdout
71 71 return super(ArgumentParser, self).print_help(file)
72 72
73 73 print_help.__doc__ = argparse.ArgumentParser.print_help.__doc__
74 74
75 75 #-----------------------------------------------------------------------------
76 76 # Config class for holding config information
77 77 #-----------------------------------------------------------------------------
78 78
79 79 class LazyConfigValue(HasTraits):
80 80 """Proxy object for exposing methods on configurable containers
81 81
82 82 Exposes:
83 83
84 84 - append, extend, insert on lists
85 85 - update on dicts
86 86 - update, add on sets
87 87 """
88 88
89 89 _value = None
90 90
91 91 # list methods
92 92 _extend = List()
93 93 _prepend = List()
94 94
95 95 def append(self, obj):
96 96 self._extend.append(obj)
97 97
98 98 def extend(self, other):
99 99 self._extend.extend(other)
100 100
101 101 def prepend(self, other):
102 102 """like list.extend, but for the front"""
103 103 self._prepend[:0] = other
104 104
105 105 _inserts = List()
106 106 def insert(self, index, other):
107 107 if not isinstance(index, int):
108 108 raise TypeError("An integer is required")
109 109 self._inserts.append((index, other))
110 110
111 111 # dict methods
112 112 # update is used for both dict and set
113 113 _update = Any()
114 114 def update(self, other):
115 115 if self._update is None:
116 116 if isinstance(other, dict):
117 117 self._update = {}
118 118 else:
119 119 self._update = set()
120 120 self._update.update(other)
121 121
122 122 # set methods
123 123 def add(self, obj):
124 124 self.update({obj})
125 125
126 126 def get_value(self, initial):
127 127 """construct the value from the initial one
128 128
129 129 after applying any insert / extend / update changes
130 130 """
131 131 if self._value is not None:
132 132 return self._value
133 133 value = copy.deepcopy(initial)
134 134 if isinstance(value, list):
135 135 for idx, obj in self._inserts:
136 136 value.insert(idx, obj)
137 137 value[:0] = self._prepend
138 138 value.extend(self._extend)
139 139
140 140 elif isinstance(value, dict):
141 141 if self._update:
142 142 value.update(self._update)
143 143 elif isinstance(value, set):
144 144 if self._update:
145 145 value.update(self._update)
146 146 self._value = value
147 147 return value
148 148
149 149 def to_dict(self):
150 150 """return JSONable dict form of my data
151 151
152 152 Currently update as dict or set, extend, prepend as lists, and inserts as list of tuples.
153 153 """
154 154 d = {}
155 155 if self._update:
156 156 d['update'] = self._update
157 157 if self._extend:
158 158 d['extend'] = self._extend
159 159 if self._prepend:
160 160 d['prepend'] = self._prepend
161 161 elif self._inserts:
162 162 d['inserts'] = self._inserts
163 163 return d
164 164
165 165
166 166 class Config(dict):
167 167 """An attribute based dict that can do smart merges."""
168 168
169 169 def __init__(self, *args, **kwds):
170 170 dict.__init__(self, *args, **kwds)
171 171 # This sets self.__dict__ = self, but it has to be done this way
172 172 # because we are also overriding __setattr__.
173 173 dict.__setattr__(self, '__dict__', self)
174 174 self._ensure_subconfig()
175 175
176 176 def _ensure_subconfig(self):
177 177 """ensure that sub-dicts that should be Config objects are
178 178
179 179 casts dicts that are under section keys to Config objects,
180 180 which is necessary for constructing Config objects from dict literals.
181 181 """
182 182 for key in self:
183 183 obj = self[key]
184 184 if self._is_section_key(key) \
185 185 and isinstance(obj, dict) \
186 186 and not isinstance(obj, Config):
187 187 dict.__setattr__(self, key, Config(obj))
188 188
189 189 def _merge(self, other):
190 190 """deprecated alias, use Config.merge()"""
191 191 self.merge(other)
192 192
193 193 def merge(self, other):
194 194 """merge another config object into this one"""
195 195 to_update = {}
196 196 for k, v in other.iteritems():
197 197 if k not in self:
198 198 to_update[k] = v
199 199 else: # I have this key
200 200 if isinstance(v, Config) and isinstance(self[k], Config):
201 201 # Recursively merge common sub Configs
202 202 self[k].merge(v)
203 203 else:
204 204 # Plain updates for non-Configs
205 205 to_update[k] = v
206 206
207 207 self.update(to_update)
208 208
209 209 def _is_section_key(self, key):
210 210 if key[0].upper()==key[0] and not key.startswith('_'):
211 211 return True
212 212 else:
213 213 return False
214 214
215 215 def __contains__(self, key):
216 216 # allow nested contains of the form `"Section.key" in config`
217 217 if '.' in key:
218 218 first, remainder = key.split('.', 1)
219 219 if first not in self:
220 220 return False
221 221 return remainder in self[first]
222 222
223 223 # we always have Sections
224 224 if self._is_section_key(key):
225 225 return True
226 226 else:
227 227 return super(Config, self).__contains__(key)
228 228 # .has_key is deprecated for dictionaries.
229 229 has_key = __contains__
230 230
231 231 def _has_section(self, key):
232 232 if self._is_section_key(key):
233 233 if super(Config, self).__contains__(key):
234 234 return True
235 235 return False
236 236
237 237 def copy(self):
238 238 return type(self)(dict.copy(self))
239 239
240 240 def __copy__(self):
241 241 return self.copy()
242 242
243 243 def __deepcopy__(self, memo):
244 244 import copy
245 245 return type(self)(copy.deepcopy(self.items()))
246 246
247 247 def __getitem__(self, key):
248 248 # We cannot use directly self._is_section_key, because it triggers
249 249 # infinite recursion on top of PyPy. Instead, we manually fish the
250 250 # bound method.
251 251 is_section_key = self.__class__._is_section_key.__get__(self)
252 252
253 253 # Because we use this for an exec namespace, we need to delegate
254 254 # the lookup of names in __builtin__ to itself. This means
255 255 # that you can't have section or attribute names that are
256 256 # builtins.
257 257 try:
258 258 return getattr(builtin_mod, key)
259 259 except AttributeError:
260 260 pass
261 261 if is_section_key(key):
262 262 try:
263 263 return dict.__getitem__(self, key)
264 264 except KeyError:
265 265 c = Config()
266 266 dict.__setitem__(self, key, c)
267 267 return c
268 268 else:
269 269 try:
270 270 return dict.__getitem__(self, key)
271 271 except KeyError:
272 272 # undefined
273 273 v = LazyConfigValue()
274 274 dict.__setitem__(self, key, v)
275 275 return v
276 276
277 277
278 278 def __setitem__(self, key, value):
279 279 if self._is_section_key(key):
280 280 if not isinstance(value, Config):
281 281 raise ValueError('values whose keys begin with an uppercase '
282 282 'char must be Config instances: %r, %r' % (key, value))
283 283 else:
284 284 dict.__setitem__(self, key, value)
285 285
286 286 def __getattr__(self, key):
287 287 try:
288 288 return self.__getitem__(key)
289 289 except KeyError as e:
290 290 raise AttributeError(e)
291 291
292 292 def __setattr__(self, key, value):
293 293 try:
294 294 self.__setitem__(key, value)
295 295 except KeyError as e:
296 296 raise AttributeError(e)
297 297
298 298 def __delattr__(self, key):
299 299 try:
300 300 dict.__delitem__(self, key)
301 301 except KeyError as e:
302 302 raise AttributeError(e)
303 303
304 304
305 305 #-----------------------------------------------------------------------------
306 306 # Config loading classes
307 307 #-----------------------------------------------------------------------------
308 308
309 309
310 310 class ConfigLoader(object):
311 311 """A object for loading configurations from just about anywhere.
312 312
313 313 The resulting configuration is packaged as a :class:`Struct`.
314 314
315 315 Notes
316 316 -----
317 317 A :class:`ConfigLoader` does one thing: load a config from a source
318 318 (file, command line arguments) and returns the data as a :class:`Struct`.
319 319 There are lots of things that :class:`ConfigLoader` does not do. It does
320 320 not implement complex logic for finding config files. It does not handle
321 321 default values or merge multiple configs. These things need to be
322 322 handled elsewhere.
323 323 """
324 324
325 325 def __init__(self):
326 326 """A base class for config loaders.
327 327
328 328 Examples
329 329 --------
330 330
331 331 >>> cl = ConfigLoader()
332 332 >>> config = cl.load_config()
333 333 >>> config
334 334 {}
335 335 """
336 336 self.clear()
337 337
338 338 def clear(self):
339 339 self.config = Config()
340 340
341 341 def load_config(self):
342 342 """Load a config from somewhere, return a :class:`Config` instance.
343 343
344 344 Usually, this will cause self.config to be set and then returned.
345 345 However, in most cases, :meth:`ConfigLoader.clear` should be called
346 346 to erase any previous state.
347 347 """
348 348 self.clear()
349 349 return self.config
350 350
351 351
352 352 class FileConfigLoader(ConfigLoader):
353 353 """A base class for file based configurations.
354 354
355 355 As we add more file based config loaders, the common logic should go
356 356 here.
357 357 """
358 358 pass
359 359
360 360
361 361 class PyFileConfigLoader(FileConfigLoader):
362 362 """A config loader for pure python files.
363 363
364 364 This calls execfile on a plain python file and looks for attributes
365 365 that are all caps. These attribute are added to the config Struct.
366 366 """
367 367
368 368 def __init__(self, filename, path=None):
369 369 """Build a config loader for a filename and path.
370 370
371 371 Parameters
372 372 ----------
373 373 filename : str
374 374 The file name of the config file.
375 375 path : str, list, tuple
376 376 The path to search for the config file on, or a sequence of
377 377 paths to try in order.
378 378 """
379 379 super(PyFileConfigLoader, self).__init__()
380 380 self.filename = filename
381 381 self.path = path
382 382 self.full_filename = ''
383 383 self.data = None
384 384
385 385 def load_config(self):
386 386 """Load the config from a file and return it as a Struct."""
387 387 self.clear()
388 388 try:
389 389 self._find_file()
390 390 except IOError as e:
391 391 raise ConfigFileNotFound(str(e))
392 392 self._read_file_as_dict()
393 393 self._convert_to_config()
394 394 return self.config
395 395
396 396 def _find_file(self):
397 397 """Try to find the file by searching the paths."""
398 398 self.full_filename = filefind(self.filename, self.path)
399 399
400 400 def _read_file_as_dict(self):
401 401 """Load the config file into self.config, with recursive loading."""
402 402 # This closure is made available in the namespace that is used
403 403 # to exec the config file. It allows users to call
404 404 # load_subconfig('myconfig.py') to load config files recursively.
405 405 # It needs to be a closure because it has references to self.path
406 406 # and self.config. The sub-config is loaded with the same path
407 407 # as the parent, but it uses an empty config which is then merged
408 408 # with the parents.
409 409
410 410 # If a profile is specified, the config file will be loaded
411 411 # from that profile
412 412
413 413 def load_subconfig(fname, profile=None):
414 414 # import here to prevent circular imports
415 415 from IPython.core.profiledir import ProfileDir, ProfileDirError
416 416 if profile is not None:
417 417 try:
418 418 profile_dir = ProfileDir.find_profile_dir_by_name(
419 419 get_ipython_dir(),
420 420 profile,
421 421 )
422 422 except ProfileDirError:
423 423 return
424 424 path = profile_dir.location
425 425 else:
426 426 path = self.path
427 427 loader = PyFileConfigLoader(fname, path)
428 428 try:
429 429 sub_config = loader.load_config()
430 430 except ConfigFileNotFound:
431 431 # Pass silently if the sub config is not there. This happens
432 432 # when a user s using a profile, but not the default config.
433 433 pass
434 434 else:
435 435 self.config.merge(sub_config)
436 436
437 437 # Again, this needs to be a closure and should be used in config
438 438 # files to get the config being loaded.
439 439 def get_config():
440 440 return self.config
441 441
442 442 namespace = dict(
443 443 load_subconfig=load_subconfig,
444 444 get_config=get_config,
445 445 __file__=self.full_filename,
446 446 )
447 447 fs_encoding = sys.getfilesystemencoding() or 'ascii'
448 448 conf_filename = self.full_filename.encode(fs_encoding)
449 449 py3compat.execfile(conf_filename, namespace)
450 450
451 451 def _convert_to_config(self):
452 452 if self.data is None:
453 453 ConfigLoaderError('self.data does not exist')
454 454
455 455
456 456 class CommandLineConfigLoader(ConfigLoader):
457 457 """A config loader for command line arguments.
458 458
459 459 As we add more command line based loaders, the common logic should go
460 460 here.
461 461 """
462 462
463 463 def _exec_config_str(self, lhs, rhs):
464 464 """execute self.config.<lhs> = <rhs>
465 465
466 466 * expands ~ with expanduser
467 467 * tries to assign with raw eval, otherwise assigns with just the string,
468 468 allowing `--C.a=foobar` and `--C.a="foobar"` to be equivalent. *Not*
469 469 equivalent are `--C.a=4` and `--C.a='4'`.
470 470 """
471 471 rhs = os.path.expanduser(rhs)
472 472 try:
473 473 # Try to see if regular Python syntax will work. This
474 474 # won't handle strings as the quote marks are removed
475 475 # by the system shell.
476 476 value = eval(rhs)
477 477 except (NameError, SyntaxError):
478 478 # This case happens if the rhs is a string.
479 479 value = rhs
480 480
481 exec u'self.config.%s = value' % lhs
481 exec(u'self.config.%s = value' % lhs)
482 482
483 483 def _load_flag(self, cfg):
484 484 """update self.config from a flag, which can be a dict or Config"""
485 485 if isinstance(cfg, (dict, Config)):
486 486 # don't clobber whole config sections, update
487 487 # each section from config:
488 488 for sec,c in cfg.iteritems():
489 489 self.config[sec].update(c)
490 490 else:
491 491 raise TypeError("Invalid flag: %r" % cfg)
492 492
493 493 # raw --identifier=value pattern
494 494 # but *also* accept '-' as wordsep, for aliases
495 495 # accepts: --foo=a
496 496 # --Class.trait=value
497 497 # --alias-name=value
498 498 # rejects: -foo=value
499 499 # --foo
500 500 # --Class.trait
501 501 kv_pattern = re.compile(r'\-\-[A-Za-z][\w\-]*(\.[\w\-]+)*\=.*')
502 502
503 503 # just flags, no assignments, with two *or one* leading '-'
504 504 # accepts: --foo
505 505 # -foo-bar-again
506 506 # rejects: --anything=anything
507 507 # --two.word
508 508
509 509 flag_pattern = re.compile(r'\-\-?\w+[\-\w]*$')
510 510
511 511 class KeyValueConfigLoader(CommandLineConfigLoader):
512 512 """A config loader that loads key value pairs from the command line.
513 513
514 514 This allows command line options to be gives in the following form::
515 515
516 516 ipython --profile="foo" --InteractiveShell.autocall=False
517 517 """
518 518
519 519 def __init__(self, argv=None, aliases=None, flags=None):
520 520 """Create a key value pair config loader.
521 521
522 522 Parameters
523 523 ----------
524 524 argv : list
525 525 A list that has the form of sys.argv[1:] which has unicode
526 526 elements of the form u"key=value". If this is None (default),
527 527 then sys.argv[1:] will be used.
528 528 aliases : dict
529 529 A dict of aliases for configurable traits.
530 530 Keys are the short aliases, Values are the resolved trait.
531 531 Of the form: `{'alias' : 'Configurable.trait'}`
532 532 flags : dict
533 533 A dict of flags, keyed by str name. Vaues can be Config objects,
534 534 dicts, or "key=value" strings. If Config or dict, when the flag
535 535 is triggered, The flag is loaded as `self.config.update(m)`.
536 536
537 537 Returns
538 538 -------
539 539 config : Config
540 540 The resulting Config object.
541 541
542 542 Examples
543 543 --------
544 544
545 545 >>> from IPython.config.loader import KeyValueConfigLoader
546 546 >>> cl = KeyValueConfigLoader()
547 547 >>> d = cl.load_config(["--A.name='brian'","--B.number=0"])
548 548 >>> sorted(d.items())
549 549 [('A', {'name': 'brian'}), ('B', {'number': 0})]
550 550 """
551 551 self.clear()
552 552 if argv is None:
553 553 argv = sys.argv[1:]
554 554 self.argv = argv
555 555 self.aliases = aliases or {}
556 556 self.flags = flags or {}
557 557
558 558
559 559 def clear(self):
560 560 super(KeyValueConfigLoader, self).clear()
561 561 self.extra_args = []
562 562
563 563
564 564 def _decode_argv(self, argv, enc=None):
565 565 """decode argv if bytes, using stin.encoding, falling back on default enc"""
566 566 uargv = []
567 567 if enc is None:
568 568 enc = DEFAULT_ENCODING
569 569 for arg in argv:
570 570 if not isinstance(arg, unicode):
571 571 # only decode if not already decoded
572 572 arg = arg.decode(enc)
573 573 uargv.append(arg)
574 574 return uargv
575 575
576 576
577 577 def load_config(self, argv=None, aliases=None, flags=None):
578 578 """Parse the configuration and generate the Config object.
579 579
580 580 After loading, any arguments that are not key-value or
581 581 flags will be stored in self.extra_args - a list of
582 582 unparsed command-line arguments. This is used for
583 583 arguments such as input files or subcommands.
584 584
585 585 Parameters
586 586 ----------
587 587 argv : list, optional
588 588 A list that has the form of sys.argv[1:] which has unicode
589 589 elements of the form u"key=value". If this is None (default),
590 590 then self.argv will be used.
591 591 aliases : dict
592 592 A dict of aliases for configurable traits.
593 593 Keys are the short aliases, Values are the resolved trait.
594 594 Of the form: `{'alias' : 'Configurable.trait'}`
595 595 flags : dict
596 596 A dict of flags, keyed by str name. Values can be Config objects
597 597 or dicts. When the flag is triggered, The config is loaded as
598 598 `self.config.update(cfg)`.
599 599 """
600 600 self.clear()
601 601 if argv is None:
602 602 argv = self.argv
603 603 if aliases is None:
604 604 aliases = self.aliases
605 605 if flags is None:
606 606 flags = self.flags
607 607
608 608 # ensure argv is a list of unicode strings:
609 609 uargv = self._decode_argv(argv)
610 610 for idx,raw in enumerate(uargv):
611 611 # strip leading '-'
612 612 item = raw.lstrip('-')
613 613
614 614 if raw == '--':
615 615 # don't parse arguments after '--'
616 616 # this is useful for relaying arguments to scripts, e.g.
617 617 # ipython -i foo.py --matplotlib=qt -- args after '--' go-to-foo.py
618 618 self.extra_args.extend(uargv[idx+1:])
619 619 break
620 620
621 621 if kv_pattern.match(raw):
622 622 lhs,rhs = item.split('=',1)
623 623 # Substitute longnames for aliases.
624 624 if lhs in aliases:
625 625 lhs = aliases[lhs]
626 626 if '.' not in lhs:
627 627 # probably a mistyped alias, but not technically illegal
628 628 warn.warn("Unrecognized alias: '%s', it will probably have no effect."%lhs)
629 629 try:
630 630 self._exec_config_str(lhs, rhs)
631 631 except Exception:
632 632 raise ArgumentError("Invalid argument: '%s'" % raw)
633 633
634 634 elif flag_pattern.match(raw):
635 635 if item in flags:
636 636 cfg,help = flags[item]
637 637 self._load_flag(cfg)
638 638 else:
639 639 raise ArgumentError("Unrecognized flag: '%s'"%raw)
640 640 elif raw.startswith('-'):
641 641 kv = '--'+item
642 642 if kv_pattern.match(kv):
643 643 raise ArgumentError("Invalid argument: '%s', did you mean '%s'?"%(raw, kv))
644 644 else:
645 645 raise ArgumentError("Invalid argument: '%s'"%raw)
646 646 else:
647 647 # keep all args that aren't valid in a list,
648 648 # in case our parent knows what to do with them.
649 649 self.extra_args.append(item)
650 650 return self.config
651 651
652 652 class ArgParseConfigLoader(CommandLineConfigLoader):
653 653 """A loader that uses the argparse module to load from the command line."""
654 654
655 655 def __init__(self, argv=None, aliases=None, flags=None, *parser_args, **parser_kw):
656 656 """Create a config loader for use with argparse.
657 657
658 658 Parameters
659 659 ----------
660 660
661 661 argv : optional, list
662 662 If given, used to read command-line arguments from, otherwise
663 663 sys.argv[1:] is used.
664 664
665 665 parser_args : tuple
666 666 A tuple of positional arguments that will be passed to the
667 667 constructor of :class:`argparse.ArgumentParser`.
668 668
669 669 parser_kw : dict
670 670 A tuple of keyword arguments that will be passed to the
671 671 constructor of :class:`argparse.ArgumentParser`.
672 672
673 673 Returns
674 674 -------
675 675 config : Config
676 676 The resulting Config object.
677 677 """
678 678 super(CommandLineConfigLoader, self).__init__()
679 679 self.clear()
680 680 if argv is None:
681 681 argv = sys.argv[1:]
682 682 self.argv = argv
683 683 self.aliases = aliases or {}
684 684 self.flags = flags or {}
685 685
686 686 self.parser_args = parser_args
687 687 self.version = parser_kw.pop("version", None)
688 688 kwargs = dict(argument_default=argparse.SUPPRESS)
689 689 kwargs.update(parser_kw)
690 690 self.parser_kw = kwargs
691 691
692 692 def load_config(self, argv=None, aliases=None, flags=None):
693 693 """Parse command line arguments and return as a Config object.
694 694
695 695 Parameters
696 696 ----------
697 697
698 698 args : optional, list
699 699 If given, a list with the structure of sys.argv[1:] to parse
700 700 arguments from. If not given, the instance's self.argv attribute
701 701 (given at construction time) is used."""
702 702 self.clear()
703 703 if argv is None:
704 704 argv = self.argv
705 705 if aliases is None:
706 706 aliases = self.aliases
707 707 if flags is None:
708 708 flags = self.flags
709 709 self._create_parser(aliases, flags)
710 710 self._parse_args(argv)
711 711 self._convert_to_config()
712 712 return self.config
713 713
714 714 def get_extra_args(self):
715 715 if hasattr(self, 'extra_args'):
716 716 return self.extra_args
717 717 else:
718 718 return []
719 719
720 720 def _create_parser(self, aliases=None, flags=None):
721 721 self.parser = ArgumentParser(*self.parser_args, **self.parser_kw)
722 722 self._add_arguments(aliases, flags)
723 723
724 724 def _add_arguments(self, aliases=None, flags=None):
725 725 raise NotImplementedError("subclasses must implement _add_arguments")
726 726
727 727 def _parse_args(self, args):
728 728 """self.parser->self.parsed_data"""
729 729 # decode sys.argv to support unicode command-line options
730 730 enc = DEFAULT_ENCODING
731 731 uargs = [py3compat.cast_unicode(a, enc) for a in args]
732 732 self.parsed_data, self.extra_args = self.parser.parse_known_args(uargs)
733 733
734 734 def _convert_to_config(self):
735 735 """self.parsed_data->self.config"""
736 736 for k, v in vars(self.parsed_data).iteritems():
737 exec "self.config.%s = v"%k in locals(), globals()
737 exec("self.config.%s = v"%k, locals(), globals())
738 738
739 739 class KVArgParseConfigLoader(ArgParseConfigLoader):
740 740 """A config loader that loads aliases and flags with argparse,
741 741 but will use KVLoader for the rest. This allows better parsing
742 742 of common args, such as `ipython -c 'print 5'`, but still gets
743 743 arbitrary config with `ipython --InteractiveShell.use_readline=False`"""
744 744
745 745 def _add_arguments(self, aliases=None, flags=None):
746 746 self.alias_flags = {}
747 747 # print aliases, flags
748 748 if aliases is None:
749 749 aliases = self.aliases
750 750 if flags is None:
751 751 flags = self.flags
752 752 paa = self.parser.add_argument
753 753 for key,value in aliases.iteritems():
754 754 if key in flags:
755 755 # flags
756 756 nargs = '?'
757 757 else:
758 758 nargs = None
759 759 if len(key) is 1:
760 760 paa('-'+key, '--'+key, type=unicode, dest=value, nargs=nargs)
761 761 else:
762 762 paa('--'+key, type=unicode, dest=value, nargs=nargs)
763 763 for key, (value, help) in flags.iteritems():
764 764 if key in self.aliases:
765 765 #
766 766 self.alias_flags[self.aliases[key]] = value
767 767 continue
768 768 if len(key) is 1:
769 769 paa('-'+key, '--'+key, action='append_const', dest='_flags', const=value)
770 770 else:
771 771 paa('--'+key, action='append_const', dest='_flags', const=value)
772 772
773 773 def _convert_to_config(self):
774 774 """self.parsed_data->self.config, parse unrecognized extra args via KVLoader."""
775 775 # remove subconfigs list from namespace before transforming the Namespace
776 776 if '_flags' in self.parsed_data:
777 777 subcs = self.parsed_data._flags
778 778 del self.parsed_data._flags
779 779 else:
780 780 subcs = []
781 781
782 782 for k, v in vars(self.parsed_data).iteritems():
783 783 if v is None:
784 784 # it was a flag that shares the name of an alias
785 785 subcs.append(self.alias_flags[k])
786 786 else:
787 787 # eval the KV assignment
788 788 self._exec_config_str(k, v)
789 789
790 790 for subc in subcs:
791 791 self._load_flag(subc)
792 792
793 793 if self.extra_args:
794 794 sub_parser = KeyValueConfigLoader()
795 795 sub_parser.load_config(self.extra_args)
796 796 self.config.merge(sub_parser.config)
797 797 self.extra_args = sub_parser.extra_args
798 798
799 799
800 800 def load_pyconfig_files(config_files, path):
801 801 """Load multiple Python config files, merging each of them in turn.
802 802
803 803 Parameters
804 804 ==========
805 805 config_files : list of str
806 806 List of config files names to load and merge into the config.
807 807 path : unicode
808 808 The full path to the location of the config files.
809 809 """
810 810 config = Config()
811 811 for cf in config_files:
812 812 loader = PyFileConfigLoader(cf, path=path)
813 813 try:
814 814 next_config = loader.load_config()
815 815 except ConfigFileNotFound:
816 816 pass
817 817 except:
818 818 raise
819 819 else:
820 820 config.merge(next_config)
821 821 return config
@@ -1,292 +1,292 b''
1 1 # encoding: utf-8
2 2 """
3 3 Tests for IPython.config.loader
4 4
5 5 Authors:
6 6
7 7 * Brian Granger
8 8 * Fernando Perez (design help)
9 9 """
10 10
11 11 #-----------------------------------------------------------------------------
12 12 # Copyright (C) 2008 The IPython Development Team
13 13 #
14 14 # Distributed under the terms of the BSD License. The full license is in
15 15 # the file COPYING, distributed as part of this software.
16 16 #-----------------------------------------------------------------------------
17 17
18 18 #-----------------------------------------------------------------------------
19 19 # Imports
20 20 #-----------------------------------------------------------------------------
21 21
22 22 import os
23 23 import sys
24 24 from tempfile import mkstemp
25 25 from unittest import TestCase
26 26
27 27 from nose import SkipTest
28 28
29 29 from IPython.testing.tools import mute_warn
30 30
31 31 from IPython.config.loader import (
32 32 Config,
33 33 PyFileConfigLoader,
34 34 KeyValueConfigLoader,
35 35 ArgParseConfigLoader,
36 36 KVArgParseConfigLoader,
37 37 ConfigError
38 38 )
39 39
40 40 #-----------------------------------------------------------------------------
41 41 # Actual tests
42 42 #-----------------------------------------------------------------------------
43 43
44 44
45 45 pyfile = """
46 46 c = get_config()
47 47 c.a=10
48 48 c.b=20
49 49 c.Foo.Bar.value=10
50 50 c.Foo.Bam.value=list(range(10)) # list() is just so it's the same on Python 3
51 51 c.D.C.value='hi there'
52 52 """
53 53
54 54 class TestPyFileCL(TestCase):
55 55
56 56 def test_basic(self):
57 57 fd, fname = mkstemp('.py')
58 58 f = os.fdopen(fd, 'w')
59 59 f.write(pyfile)
60 60 f.close()
61 61 # Unlink the file
62 62 cl = PyFileConfigLoader(fname)
63 63 config = cl.load_config()
64 64 self.assertEqual(config.a, 10)
65 65 self.assertEqual(config.b, 20)
66 66 self.assertEqual(config.Foo.Bar.value, 10)
67 67 self.assertEqual(config.Foo.Bam.value, range(10))
68 68 self.assertEqual(config.D.C.value, 'hi there')
69 69
70 70 class MyLoader1(ArgParseConfigLoader):
71 71 def _add_arguments(self, aliases=None, flags=None):
72 72 p = self.parser
73 73 p.add_argument('-f', '--foo', dest='Global.foo', type=str)
74 74 p.add_argument('-b', dest='MyClass.bar', type=int)
75 75 p.add_argument('-n', dest='n', action='store_true')
76 76 p.add_argument('Global.bam', type=str)
77 77
78 78 class MyLoader2(ArgParseConfigLoader):
79 79 def _add_arguments(self, aliases=None, flags=None):
80 80 subparsers = self.parser.add_subparsers(dest='subparser_name')
81 81 subparser1 = subparsers.add_parser('1')
82 82 subparser1.add_argument('-x',dest='Global.x')
83 83 subparser2 = subparsers.add_parser('2')
84 84 subparser2.add_argument('y')
85 85
86 86 class TestArgParseCL(TestCase):
87 87
88 88 def test_basic(self):
89 89 cl = MyLoader1()
90 90 config = cl.load_config('-f hi -b 10 -n wow'.split())
91 91 self.assertEqual(config.Global.foo, 'hi')
92 92 self.assertEqual(config.MyClass.bar, 10)
93 93 self.assertEqual(config.n, True)
94 94 self.assertEqual(config.Global.bam, 'wow')
95 95 config = cl.load_config(['wow'])
96 96 self.assertEqual(config.keys(), ['Global'])
97 97 self.assertEqual(config.Global.keys(), ['bam'])
98 98 self.assertEqual(config.Global.bam, 'wow')
99 99
100 100 def test_add_arguments(self):
101 101 cl = MyLoader2()
102 102 config = cl.load_config('2 frobble'.split())
103 103 self.assertEqual(config.subparser_name, '2')
104 104 self.assertEqual(config.y, 'frobble')
105 105 config = cl.load_config('1 -x frobble'.split())
106 106 self.assertEqual(config.subparser_name, '1')
107 107 self.assertEqual(config.Global.x, 'frobble')
108 108
109 109 def test_argv(self):
110 110 cl = MyLoader1(argv='-f hi -b 10 -n wow'.split())
111 111 config = cl.load_config()
112 112 self.assertEqual(config.Global.foo, 'hi')
113 113 self.assertEqual(config.MyClass.bar, 10)
114 114 self.assertEqual(config.n, True)
115 115 self.assertEqual(config.Global.bam, 'wow')
116 116
117 117
118 118 class TestKeyValueCL(TestCase):
119 119 klass = KeyValueConfigLoader
120 120
121 121 def test_basic(self):
122 122 cl = self.klass()
123 123 argv = ['--'+s.strip('c.') for s in pyfile.split('\n')[2:-1]]
124 124 with mute_warn():
125 125 config = cl.load_config(argv)
126 126 self.assertEqual(config.a, 10)
127 127 self.assertEqual(config.b, 20)
128 128 self.assertEqual(config.Foo.Bar.value, 10)
129 129 self.assertEqual(config.Foo.Bam.value, range(10))
130 130 self.assertEqual(config.D.C.value, 'hi there')
131 131
132 132 def test_expanduser(self):
133 133 cl = self.klass()
134 134 argv = ['--a=~/1/2/3', '--b=~', '--c=~/', '--d="~/"']
135 135 with mute_warn():
136 136 config = cl.load_config(argv)
137 137 self.assertEqual(config.a, os.path.expanduser('~/1/2/3'))
138 138 self.assertEqual(config.b, os.path.expanduser('~'))
139 139 self.assertEqual(config.c, os.path.expanduser('~/'))
140 140 self.assertEqual(config.d, '~/')
141 141
142 142 def test_extra_args(self):
143 143 cl = self.klass()
144 144 with mute_warn():
145 145 config = cl.load_config(['--a=5', 'b', '--c=10', 'd'])
146 146 self.assertEqual(cl.extra_args, ['b', 'd'])
147 147 self.assertEqual(config.a, 5)
148 148 self.assertEqual(config.c, 10)
149 149 with mute_warn():
150 150 config = cl.load_config(['--', '--a=5', '--c=10'])
151 151 self.assertEqual(cl.extra_args, ['--a=5', '--c=10'])
152 152
153 153 def test_unicode_args(self):
154 154 cl = self.klass()
155 155 argv = [u'--a=épsîlön']
156 156 with mute_warn():
157 157 config = cl.load_config(argv)
158 158 self.assertEqual(config.a, u'épsîlön')
159 159
160 160 def test_unicode_bytes_args(self):
161 161 uarg = u'--a=é'
162 162 try:
163 163 barg = uarg.encode(sys.stdin.encoding)
164 164 except (TypeError, UnicodeEncodeError):
165 165 raise SkipTest("sys.stdin.encoding can't handle 'é'")
166 166
167 167 cl = self.klass()
168 168 with mute_warn():
169 169 config = cl.load_config([barg])
170 170 self.assertEqual(config.a, u'é')
171 171
172 172 def test_unicode_alias(self):
173 173 cl = self.klass()
174 174 argv = [u'--a=épsîlön']
175 175 with mute_warn():
176 176 config = cl.load_config(argv, aliases=dict(a='A.a'))
177 177 self.assertEqual(config.A.a, u'épsîlön')
178 178
179 179
180 180 class TestArgParseKVCL(TestKeyValueCL):
181 181 klass = KVArgParseConfigLoader
182 182
183 183 def test_expanduser2(self):
184 184 cl = self.klass()
185 185 argv = ['-a', '~/1/2/3', '--b', "'~/1/2/3'"]
186 186 with mute_warn():
187 187 config = cl.load_config(argv, aliases=dict(a='A.a', b='A.b'))
188 188 self.assertEqual(config.A.a, os.path.expanduser('~/1/2/3'))
189 189 self.assertEqual(config.A.b, '~/1/2/3')
190 190
191 191 def test_eval(self):
192 192 cl = self.klass()
193 193 argv = ['-c', 'a=5']
194 194 with mute_warn():
195 195 config = cl.load_config(argv, aliases=dict(c='A.c'))
196 196 self.assertEqual(config.A.c, u"a=5")
197 197
198 198
199 199 class TestConfig(TestCase):
200 200
201 201 def test_setget(self):
202 202 c = Config()
203 203 c.a = 10
204 204 self.assertEqual(c.a, 10)
205 205 self.assertEqual('b' in c, False)
206 206
207 207 def test_auto_section(self):
208 208 c = Config()
209 209 self.assertEqual('A' in c, True)
210 210 self.assertEqual(c._has_section('A'), False)
211 211 A = c.A
212 212 A.foo = 'hi there'
213 213 self.assertEqual(c._has_section('A'), True)
214 214 self.assertEqual(c.A.foo, 'hi there')
215 215 del c.A
216 216 self.assertEqual(len(c.A.keys()),0)
217 217
218 218 def test_merge_doesnt_exist(self):
219 219 c1 = Config()
220 220 c2 = Config()
221 221 c2.bar = 10
222 222 c2.Foo.bar = 10
223 223 c1.merge(c2)
224 224 self.assertEqual(c1.Foo.bar, 10)
225 225 self.assertEqual(c1.bar, 10)
226 226 c2.Bar.bar = 10
227 227 c1.merge(c2)
228 228 self.assertEqual(c1.Bar.bar, 10)
229 229
230 230 def test_merge_exists(self):
231 231 c1 = Config()
232 232 c2 = Config()
233 233 c1.Foo.bar = 10
234 234 c1.Foo.bam = 30
235 235 c2.Foo.bar = 20
236 236 c2.Foo.wow = 40
237 237 c1.merge(c2)
238 238 self.assertEqual(c1.Foo.bam, 30)
239 239 self.assertEqual(c1.Foo.bar, 20)
240 240 self.assertEqual(c1.Foo.wow, 40)
241 241 c2.Foo.Bam.bam = 10
242 242 c1.merge(c2)
243 243 self.assertEqual(c1.Foo.Bam.bam, 10)
244 244
245 245 def test_deepcopy(self):
246 246 c1 = Config()
247 247 c1.Foo.bar = 10
248 248 c1.Foo.bam = 30
249 249 c1.a = 'asdf'
250 250 c1.b = range(10)
251 251 import copy
252 252 c2 = copy.deepcopy(c1)
253 253 self.assertEqual(c1, c2)
254 254 self.assertTrue(c1 is not c2)
255 255 self.assertTrue(c1.Foo is not c2.Foo)
256 256
257 257 def test_builtin(self):
258 258 c1 = Config()
259 exec 'foo = True' in c1
259 exec('foo = True', c1)
260 260 self.assertEqual(c1.foo, True)
261 261 c1.format = "json"
262 262
263 263 def test_fromdict(self):
264 264 c1 = Config({'Foo' : {'bar' : 1}})
265 265 self.assertEqual(c1.Foo.__class__, Config)
266 266 self.assertEqual(c1.Foo.bar, 1)
267 267
268 268 def test_fromdictmerge(self):
269 269 c1 = Config()
270 270 c2 = Config({'Foo' : {'bar' : 1}})
271 271 c1.merge(c2)
272 272 self.assertEqual(c1.Foo.__class__, Config)
273 273 self.assertEqual(c1.Foo.bar, 1)
274 274
275 275 def test_fromdictmerge2(self):
276 276 c1 = Config({'Foo' : {'baz' : 2}})
277 277 c2 = Config({'Foo' : {'bar' : 1}})
278 278 c1.merge(c2)
279 279 self.assertEqual(c1.Foo.__class__, Config)
280 280 self.assertEqual(c1.Foo.bar, 1)
281 281 self.assertEqual(c1.Foo.baz, 2)
282 282 self.assertNotIn('baz', c2.Foo)
283 283
284 284 def test_contains(self):
285 285 c1 = Config({'Foo' : {'baz' : 2}})
286 286 c2 = Config({'Foo' : {'bar' : 1}})
287 287 self.assertIn('Foo', c1)
288 288 self.assertIn('Foo.baz', c1)
289 289 self.assertIn('Foo.bar', c2)
290 290 self.assertNotIn('Foo.bar', c1)
291 291
292 292
@@ -1,3164 +1,3164 b''
1 1 # -*- coding: utf-8 -*-
2 2 """Main IPython class."""
3 3
4 4 #-----------------------------------------------------------------------------
5 5 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de>
6 6 # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu>
7 7 # Copyright (C) 2008-2011 The IPython Development Team
8 8 #
9 9 # Distributed under the terms of the BSD License. The full license is in
10 10 # the file COPYING, distributed as part of this software.
11 11 #-----------------------------------------------------------------------------
12 12
13 13 #-----------------------------------------------------------------------------
14 14 # Imports
15 15 #-----------------------------------------------------------------------------
16 16
17 17 from __future__ import absolute_import
18 18 from __future__ import print_function
19 19
20 20 import __builtin__ as builtin_mod
21 21 import __future__
22 22 import abc
23 23 import ast
24 24 import atexit
25 25 import functools
26 26 import os
27 27 import re
28 28 import runpy
29 29 import sys
30 30 import tempfile
31 31 import types
32 32 import subprocess
33 33 from io import open as io_open
34 34
35 35 from IPython.config.configurable import SingletonConfigurable
36 36 from IPython.core import debugger, oinspect
37 37 from IPython.core import magic
38 38 from IPython.core import page
39 39 from IPython.core import prefilter
40 40 from IPython.core import shadowns
41 41 from IPython.core import ultratb
42 42 from IPython.core.alias import AliasManager, AliasError
43 43 from IPython.core.autocall import ExitAutocall
44 44 from IPython.core.builtin_trap import BuiltinTrap
45 45 from IPython.core.compilerop import CachingCompiler, check_linecache_ipython
46 46 from IPython.core.display_trap import DisplayTrap
47 47 from IPython.core.displayhook import DisplayHook
48 48 from IPython.core.displaypub import DisplayPublisher
49 49 from IPython.core.error import UsageError
50 50 from IPython.core.extensions import ExtensionManager
51 51 from IPython.core.formatters import DisplayFormatter
52 52 from IPython.core.history import HistoryManager
53 53 from IPython.core.inputsplitter import IPythonInputSplitter, ESC_MAGIC, ESC_MAGIC2
54 54 from IPython.core.logger import Logger
55 55 from IPython.core.macro import Macro
56 56 from IPython.core.payload import PayloadManager
57 57 from IPython.core.prefilter import PrefilterManager
58 58 from IPython.core.profiledir import ProfileDir
59 59 from IPython.core.prompts import PromptManager
60 60 from IPython.lib.latextools import LaTeXTool
61 61 from IPython.testing.skipdoctest import skip_doctest
62 62 from IPython.utils import PyColorize
63 63 from IPython.utils import io
64 64 from IPython.utils import py3compat
65 65 from IPython.utils import openpy
66 66 from IPython.utils.decorators import undoc
67 67 from IPython.utils.io import ask_yes_no
68 68 from IPython.utils.ipstruct import Struct
69 69 from IPython.utils.path import get_home_dir, get_ipython_dir, get_py_filename, unquote_filename
70 70 from IPython.utils.pickleshare import PickleShareDB
71 71 from IPython.utils.process import system, getoutput
72 72 from IPython.utils.strdispatch import StrDispatch
73 73 from IPython.utils.syspathcontext import prepended_to_syspath
74 74 from IPython.utils.text import (format_screen, LSString, SList,
75 75 DollarFormatter)
76 76 from IPython.utils.traitlets import (Integer, CBool, CaselessStrEnum, Enum,
77 77 List, Unicode, Instance, Type)
78 78 from IPython.utils.warn import warn, error
79 79 import IPython.core.hooks
80 80
81 81 #-----------------------------------------------------------------------------
82 82 # Globals
83 83 #-----------------------------------------------------------------------------
84 84
85 85 # compiled regexps for autoindent management
86 86 dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass')
87 87
88 88 #-----------------------------------------------------------------------------
89 89 # Utilities
90 90 #-----------------------------------------------------------------------------
91 91
92 92 @undoc
93 93 def softspace(file, newvalue):
94 94 """Copied from code.py, to remove the dependency"""
95 95
96 96 oldvalue = 0
97 97 try:
98 98 oldvalue = file.softspace
99 99 except AttributeError:
100 100 pass
101 101 try:
102 102 file.softspace = newvalue
103 103 except (AttributeError, TypeError):
104 104 # "attribute-less object" or "read-only attributes"
105 105 pass
106 106 return oldvalue
107 107
108 108 @undoc
109 109 def no_op(*a, **kw): pass
110 110
111 111 @undoc
112 112 class NoOpContext(object):
113 113 def __enter__(self): pass
114 114 def __exit__(self, type, value, traceback): pass
115 115 no_op_context = NoOpContext()
116 116
117 117 class SpaceInInput(Exception): pass
118 118
119 119 @undoc
120 120 class Bunch: pass
121 121
122 122
123 123 def get_default_colors():
124 124 if sys.platform=='darwin':
125 125 return "LightBG"
126 126 elif os.name=='nt':
127 127 return 'Linux'
128 128 else:
129 129 return 'Linux'
130 130
131 131
132 132 class SeparateUnicode(Unicode):
133 133 """A Unicode subclass to validate separate_in, separate_out, etc.
134 134
135 135 This is a Unicode based trait that converts '0'->'' and '\\n'->'\n'.
136 136 """
137 137
138 138 def validate(self, obj, value):
139 139 if value == '0': value = ''
140 140 value = value.replace('\\n','\n')
141 141 return super(SeparateUnicode, self).validate(obj, value)
142 142
143 143
144 144 class ReadlineNoRecord(object):
145 145 """Context manager to execute some code, then reload readline history
146 146 so that interactive input to the code doesn't appear when pressing up."""
147 147 def __init__(self, shell):
148 148 self.shell = shell
149 149 self._nested_level = 0
150 150
151 151 def __enter__(self):
152 152 if self._nested_level == 0:
153 153 try:
154 154 self.orig_length = self.current_length()
155 155 self.readline_tail = self.get_readline_tail()
156 156 except (AttributeError, IndexError): # Can fail with pyreadline
157 157 self.orig_length, self.readline_tail = 999999, []
158 158 self._nested_level += 1
159 159
160 160 def __exit__(self, type, value, traceback):
161 161 self._nested_level -= 1
162 162 if self._nested_level == 0:
163 163 # Try clipping the end if it's got longer
164 164 try:
165 165 e = self.current_length() - self.orig_length
166 166 if e > 0:
167 167 for _ in range(e):
168 168 self.shell.readline.remove_history_item(self.orig_length)
169 169
170 170 # If it still doesn't match, just reload readline history.
171 171 if self.current_length() != self.orig_length \
172 172 or self.get_readline_tail() != self.readline_tail:
173 173 self.shell.refill_readline_hist()
174 174 except (AttributeError, IndexError):
175 175 pass
176 176 # Returning False will cause exceptions to propagate
177 177 return False
178 178
179 179 def current_length(self):
180 180 return self.shell.readline.get_current_history_length()
181 181
182 182 def get_readline_tail(self, n=10):
183 183 """Get the last n items in readline history."""
184 184 end = self.shell.readline.get_current_history_length() + 1
185 185 start = max(end-n, 1)
186 186 ghi = self.shell.readline.get_history_item
187 187 return [ghi(x) for x in range(start, end)]
188 188
189 189
190 190 @undoc
191 191 class DummyMod(object):
192 192 """A dummy module used for IPython's interactive module when
193 193 a namespace must be assigned to the module's __dict__."""
194 194 pass
195 195
196 196 #-----------------------------------------------------------------------------
197 197 # Main IPython class
198 198 #-----------------------------------------------------------------------------
199 199
200 200 class InteractiveShell(SingletonConfigurable):
201 201 """An enhanced, interactive shell for Python."""
202 202
203 203 _instance = None
204 204
205 205 ast_transformers = List([], config=True, help=
206 206 """
207 207 A list of ast.NodeTransformer subclass instances, which will be applied
208 208 to user input before code is run.
209 209 """
210 210 )
211 211
212 212 autocall = Enum((0,1,2), default_value=0, config=True, help=
213 213 """
214 214 Make IPython automatically call any callable object even if you didn't
215 215 type explicit parentheses. For example, 'str 43' becomes 'str(43)'
216 216 automatically. The value can be '0' to disable the feature, '1' for
217 217 'smart' autocall, where it is not applied if there are no more
218 218 arguments on the line, and '2' for 'full' autocall, where all callable
219 219 objects are automatically called (even if no arguments are present).
220 220 """
221 221 )
222 222 # TODO: remove all autoindent logic and put into frontends.
223 223 # We can't do this yet because even runlines uses the autoindent.
224 224 autoindent = CBool(True, config=True, help=
225 225 """
226 226 Autoindent IPython code entered interactively.
227 227 """
228 228 )
229 229 automagic = CBool(True, config=True, help=
230 230 """
231 231 Enable magic commands to be called without the leading %.
232 232 """
233 233 )
234 234 cache_size = Integer(1000, config=True, help=
235 235 """
236 236 Set the size of the output cache. The default is 1000, you can
237 237 change it permanently in your config file. Setting it to 0 completely
238 238 disables the caching system, and the minimum value accepted is 20 (if
239 239 you provide a value less than 20, it is reset to 0 and a warning is
240 240 issued). This limit is defined because otherwise you'll spend more
241 241 time re-flushing a too small cache than working
242 242 """
243 243 )
244 244 color_info = CBool(True, config=True, help=
245 245 """
246 246 Use colors for displaying information about objects. Because this
247 247 information is passed through a pager (like 'less'), and some pagers
248 248 get confused with color codes, this capability can be turned off.
249 249 """
250 250 )
251 251 colors = CaselessStrEnum(('NoColor','LightBG','Linux'),
252 252 default_value=get_default_colors(), config=True,
253 253 help="Set the color scheme (NoColor, Linux, or LightBG)."
254 254 )
255 255 colors_force = CBool(False, help=
256 256 """
257 257 Force use of ANSI color codes, regardless of OS and readline
258 258 availability.
259 259 """
260 260 # FIXME: This is essentially a hack to allow ZMQShell to show colors
261 261 # without readline on Win32. When the ZMQ formatting system is
262 262 # refactored, this should be removed.
263 263 )
264 264 debug = CBool(False, config=True)
265 265 deep_reload = CBool(False, config=True, help=
266 266 """
267 267 Enable deep (recursive) reloading by default. IPython can use the
268 268 deep_reload module which reloads changes in modules recursively (it
269 269 replaces the reload() function, so you don't need to change anything to
270 270 use it). deep_reload() forces a full reload of modules whose code may
271 271 have changed, which the default reload() function does not. When
272 272 deep_reload is off, IPython will use the normal reload(), but
273 273 deep_reload will still be available as dreload().
274 274 """
275 275 )
276 276 disable_failing_post_execute = CBool(False, config=True,
277 277 help="Don't call post-execute functions that have failed in the past."
278 278 )
279 279 display_formatter = Instance(DisplayFormatter)
280 280 displayhook_class = Type(DisplayHook)
281 281 display_pub_class = Type(DisplayPublisher)
282 282 data_pub_class = None
283 283
284 284 exit_now = CBool(False)
285 285 exiter = Instance(ExitAutocall)
286 286 def _exiter_default(self):
287 287 return ExitAutocall(self)
288 288 # Monotonically increasing execution counter
289 289 execution_count = Integer(1)
290 290 filename = Unicode("<ipython console>")
291 291 ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__
292 292
293 293 # Input splitter, to transform input line by line and detect when a block
294 294 # is ready to be executed.
295 295 input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter',
296 296 (), {'line_input_checker': True})
297 297
298 298 # This InputSplitter instance is used to transform completed cells before
299 299 # running them. It allows cell magics to contain blank lines.
300 300 input_transformer_manager = Instance('IPython.core.inputsplitter.IPythonInputSplitter',
301 301 (), {'line_input_checker': False})
302 302
303 303 logstart = CBool(False, config=True, help=
304 304 """
305 305 Start logging to the default log file.
306 306 """
307 307 )
308 308 logfile = Unicode('', config=True, help=
309 309 """
310 310 The name of the logfile to use.
311 311 """
312 312 )
313 313 logappend = Unicode('', config=True, help=
314 314 """
315 315 Start logging to the given file in append mode.
316 316 """
317 317 )
318 318 object_info_string_level = Enum((0,1,2), default_value=0,
319 319 config=True)
320 320 pdb = CBool(False, config=True, help=
321 321 """
322 322 Automatically call the pdb debugger after every exception.
323 323 """
324 324 )
325 325 multiline_history = CBool(sys.platform != 'win32', config=True,
326 326 help="Save multi-line entries as one entry in readline history"
327 327 )
328 328
329 329 # deprecated prompt traits:
330 330
331 331 prompt_in1 = Unicode('In [\\#]: ', config=True,
332 332 help="Deprecated, use PromptManager.in_template")
333 333 prompt_in2 = Unicode(' .\\D.: ', config=True,
334 334 help="Deprecated, use PromptManager.in2_template")
335 335 prompt_out = Unicode('Out[\\#]: ', config=True,
336 336 help="Deprecated, use PromptManager.out_template")
337 337 prompts_pad_left = CBool(True, config=True,
338 338 help="Deprecated, use PromptManager.justify")
339 339
340 340 def _prompt_trait_changed(self, name, old, new):
341 341 table = {
342 342 'prompt_in1' : 'in_template',
343 343 'prompt_in2' : 'in2_template',
344 344 'prompt_out' : 'out_template',
345 345 'prompts_pad_left' : 'justify',
346 346 }
347 347 warn("InteractiveShell.{name} is deprecated, use PromptManager.{newname}".format(
348 348 name=name, newname=table[name])
349 349 )
350 350 # protect against weird cases where self.config may not exist:
351 351 if self.config is not None:
352 352 # propagate to corresponding PromptManager trait
353 353 setattr(self.config.PromptManager, table[name], new)
354 354
355 355 _prompt_in1_changed = _prompt_trait_changed
356 356 _prompt_in2_changed = _prompt_trait_changed
357 357 _prompt_out_changed = _prompt_trait_changed
358 358 _prompt_pad_left_changed = _prompt_trait_changed
359 359
360 360 show_rewritten_input = CBool(True, config=True,
361 361 help="Show rewritten input, e.g. for autocall."
362 362 )
363 363
364 364 quiet = CBool(False, config=True)
365 365
366 366 history_length = Integer(10000, config=True)
367 367
368 368 # The readline stuff will eventually be moved to the terminal subclass
369 369 # but for now, we can't do that as readline is welded in everywhere.
370 370 readline_use = CBool(True, config=True)
371 371 readline_remove_delims = Unicode('-/~', config=True)
372 372 readline_delims = Unicode() # set by init_readline()
373 373 # don't use \M- bindings by default, because they
374 374 # conflict with 8-bit encodings. See gh-58,gh-88
375 375 readline_parse_and_bind = List([
376 376 'tab: complete',
377 377 '"\C-l": clear-screen',
378 378 'set show-all-if-ambiguous on',
379 379 '"\C-o": tab-insert',
380 380 '"\C-r": reverse-search-history',
381 381 '"\C-s": forward-search-history',
382 382 '"\C-p": history-search-backward',
383 383 '"\C-n": history-search-forward',
384 384 '"\e[A": history-search-backward',
385 385 '"\e[B": history-search-forward',
386 386 '"\C-k": kill-line',
387 387 '"\C-u": unix-line-discard',
388 388 ], allow_none=False, config=True)
389 389
390 390 ast_node_interactivity = Enum(['all', 'last', 'last_expr', 'none'],
391 391 default_value='last_expr', config=True,
392 392 help="""
393 393 'all', 'last', 'last_expr' or 'none', specifying which nodes should be
394 394 run interactively (displaying output from expressions).""")
395 395
396 396 # TODO: this part of prompt management should be moved to the frontends.
397 397 # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n'
398 398 separate_in = SeparateUnicode('\n', config=True)
399 399 separate_out = SeparateUnicode('', config=True)
400 400 separate_out2 = SeparateUnicode('', config=True)
401 401 wildcards_case_sensitive = CBool(True, config=True)
402 402 xmode = CaselessStrEnum(('Context','Plain', 'Verbose'),
403 403 default_value='Context', config=True)
404 404
405 405 # Subcomponents of InteractiveShell
406 406 alias_manager = Instance('IPython.core.alias.AliasManager')
407 407 prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager')
408 408 builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap')
409 409 display_trap = Instance('IPython.core.display_trap.DisplayTrap')
410 410 extension_manager = Instance('IPython.core.extensions.ExtensionManager')
411 411 payload_manager = Instance('IPython.core.payload.PayloadManager')
412 412 history_manager = Instance('IPython.core.history.HistoryManager')
413 413 magics_manager = Instance('IPython.core.magic.MagicsManager')
414 414
415 415 profile_dir = Instance('IPython.core.application.ProfileDir')
416 416 @property
417 417 def profile(self):
418 418 if self.profile_dir is not None:
419 419 name = os.path.basename(self.profile_dir.location)
420 420 return name.replace('profile_','')
421 421
422 422
423 423 # Private interface
424 424 _post_execute = Instance(dict)
425 425
426 426 # Tracks any GUI loop loaded for pylab
427 427 pylab_gui_select = None
428 428
429 429 def __init__(self, ipython_dir=None, profile_dir=None,
430 430 user_module=None, user_ns=None,
431 431 custom_exceptions=((), None), **kwargs):
432 432
433 433 # This is where traits with a config_key argument are updated
434 434 # from the values on config.
435 435 super(InteractiveShell, self).__init__(**kwargs)
436 436 self.configurables = [self]
437 437
438 438 # These are relatively independent and stateless
439 439 self.init_ipython_dir(ipython_dir)
440 440 self.init_profile_dir(profile_dir)
441 441 self.init_instance_attrs()
442 442 self.init_environment()
443 443
444 444 # Check if we're in a virtualenv, and set up sys.path.
445 445 self.init_virtualenv()
446 446
447 447 # Create namespaces (user_ns, user_global_ns, etc.)
448 448 self.init_create_namespaces(user_module, user_ns)
449 449 # This has to be done after init_create_namespaces because it uses
450 450 # something in self.user_ns, but before init_sys_modules, which
451 451 # is the first thing to modify sys.
452 452 # TODO: When we override sys.stdout and sys.stderr before this class
453 453 # is created, we are saving the overridden ones here. Not sure if this
454 454 # is what we want to do.
455 455 self.save_sys_module_state()
456 456 self.init_sys_modules()
457 457
458 458 # While we're trying to have each part of the code directly access what
459 459 # it needs without keeping redundant references to objects, we have too
460 460 # much legacy code that expects ip.db to exist.
461 461 self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db'))
462 462
463 463 self.init_history()
464 464 self.init_encoding()
465 465 self.init_prefilter()
466 466
467 467 self.init_syntax_highlighting()
468 468 self.init_hooks()
469 469 self.init_pushd_popd_magic()
470 470 # self.init_traceback_handlers use to be here, but we moved it below
471 471 # because it and init_io have to come after init_readline.
472 472 self.init_user_ns()
473 473 self.init_logger()
474 474 self.init_builtins()
475 475
476 476 # The following was in post_config_initialization
477 477 self.init_inspector()
478 478 # init_readline() must come before init_io(), because init_io uses
479 479 # readline related things.
480 480 self.init_readline()
481 481 # We save this here in case user code replaces raw_input, but it needs
482 482 # to be after init_readline(), because PyPy's readline works by replacing
483 483 # raw_input.
484 484 if py3compat.PY3:
485 485 self.raw_input_original = input
486 486 else:
487 487 self.raw_input_original = raw_input
488 488 # init_completer must come after init_readline, because it needs to
489 489 # know whether readline is present or not system-wide to configure the
490 490 # completers, since the completion machinery can now operate
491 491 # independently of readline (e.g. over the network)
492 492 self.init_completer()
493 493 # TODO: init_io() needs to happen before init_traceback handlers
494 494 # because the traceback handlers hardcode the stdout/stderr streams.
495 495 # This logic in in debugger.Pdb and should eventually be changed.
496 496 self.init_io()
497 497 self.init_traceback_handlers(custom_exceptions)
498 498 self.init_prompts()
499 499 self.init_display_formatter()
500 500 self.init_display_pub()
501 501 self.init_data_pub()
502 502 self.init_displayhook()
503 503 self.init_latextool()
504 504 self.init_magics()
505 505 self.init_alias()
506 506 self.init_logstart()
507 507 self.init_pdb()
508 508 self.init_extension_manager()
509 509 self.init_payload()
510 510 self.init_comms()
511 511 self.hooks.late_startup_hook()
512 512 atexit.register(self.atexit_operations)
513 513
514 514 def get_ipython(self):
515 515 """Return the currently running IPython instance."""
516 516 return self
517 517
518 518 #-------------------------------------------------------------------------
519 519 # Trait changed handlers
520 520 #-------------------------------------------------------------------------
521 521
522 522 def _ipython_dir_changed(self, name, new):
523 523 if not os.path.isdir(new):
524 524 os.makedirs(new, mode = 0o777)
525 525
526 526 def set_autoindent(self,value=None):
527 527 """Set the autoindent flag, checking for readline support.
528 528
529 529 If called with no arguments, it acts as a toggle."""
530 530
531 531 if value != 0 and not self.has_readline:
532 532 if os.name == 'posix':
533 533 warn("The auto-indent feature requires the readline library")
534 534 self.autoindent = 0
535 535 return
536 536 if value is None:
537 537 self.autoindent = not self.autoindent
538 538 else:
539 539 self.autoindent = value
540 540
541 541 #-------------------------------------------------------------------------
542 542 # init_* methods called by __init__
543 543 #-------------------------------------------------------------------------
544 544
545 545 def init_ipython_dir(self, ipython_dir):
546 546 if ipython_dir is not None:
547 547 self.ipython_dir = ipython_dir
548 548 return
549 549
550 550 self.ipython_dir = get_ipython_dir()
551 551
552 552 def init_profile_dir(self, profile_dir):
553 553 if profile_dir is not None:
554 554 self.profile_dir = profile_dir
555 555 return
556 556 self.profile_dir =\
557 557 ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default')
558 558
559 559 def init_instance_attrs(self):
560 560 self.more = False
561 561
562 562 # command compiler
563 563 self.compile = CachingCompiler()
564 564
565 565 # Make an empty namespace, which extension writers can rely on both
566 566 # existing and NEVER being used by ipython itself. This gives them a
567 567 # convenient location for storing additional information and state
568 568 # their extensions may require, without fear of collisions with other
569 569 # ipython names that may develop later.
570 570 self.meta = Struct()
571 571
572 572 # Temporary files used for various purposes. Deleted at exit.
573 573 self.tempfiles = []
574 574
575 575 # Keep track of readline usage (later set by init_readline)
576 576 self.has_readline = False
577 577
578 578 # keep track of where we started running (mainly for crash post-mortem)
579 579 # This is not being used anywhere currently.
580 580 self.starting_dir = os.getcwdu()
581 581
582 582 # Indentation management
583 583 self.indent_current_nsp = 0
584 584
585 585 # Dict to track post-execution functions that have been registered
586 586 self._post_execute = {}
587 587
588 588 def init_environment(self):
589 589 """Any changes we need to make to the user's environment."""
590 590 pass
591 591
592 592 def init_encoding(self):
593 593 # Get system encoding at startup time. Certain terminals (like Emacs
594 594 # under Win32 have it set to None, and we need to have a known valid
595 595 # encoding to use in the raw_input() method
596 596 try:
597 597 self.stdin_encoding = sys.stdin.encoding or 'ascii'
598 598 except AttributeError:
599 599 self.stdin_encoding = 'ascii'
600 600
601 601 def init_syntax_highlighting(self):
602 602 # Python source parser/formatter for syntax highlighting
603 603 pyformat = PyColorize.Parser().format
604 604 self.pycolorize = lambda src: pyformat(src,'str',self.colors)
605 605
606 606 def init_pushd_popd_magic(self):
607 607 # for pushd/popd management
608 608 self.home_dir = get_home_dir()
609 609
610 610 self.dir_stack = []
611 611
612 612 def init_logger(self):
613 613 self.logger = Logger(self.home_dir, logfname='ipython_log.py',
614 614 logmode='rotate')
615 615
616 616 def init_logstart(self):
617 617 """Initialize logging in case it was requested at the command line.
618 618 """
619 619 if self.logappend:
620 620 self.magic('logstart %s append' % self.logappend)
621 621 elif self.logfile:
622 622 self.magic('logstart %s' % self.logfile)
623 623 elif self.logstart:
624 624 self.magic('logstart')
625 625
626 626 def init_builtins(self):
627 627 # A single, static flag that we set to True. Its presence indicates
628 628 # that an IPython shell has been created, and we make no attempts at
629 629 # removing on exit or representing the existence of more than one
630 630 # IPython at a time.
631 631 builtin_mod.__dict__['__IPYTHON__'] = True
632 632
633 633 # In 0.11 we introduced '__IPYTHON__active' as an integer we'd try to
634 634 # manage on enter/exit, but with all our shells it's virtually
635 635 # impossible to get all the cases right. We're leaving the name in for
636 636 # those who adapted their codes to check for this flag, but will
637 637 # eventually remove it after a few more releases.
638 638 builtin_mod.__dict__['__IPYTHON__active'] = \
639 639 'Deprecated, check for __IPYTHON__'
640 640
641 641 self.builtin_trap = BuiltinTrap(shell=self)
642 642
643 643 def init_inspector(self):
644 644 # Object inspector
645 645 self.inspector = oinspect.Inspector(oinspect.InspectColors,
646 646 PyColorize.ANSICodeColors,
647 647 'NoColor',
648 648 self.object_info_string_level)
649 649
650 650 def init_io(self):
651 651 # This will just use sys.stdout and sys.stderr. If you want to
652 652 # override sys.stdout and sys.stderr themselves, you need to do that
653 653 # *before* instantiating this class, because io holds onto
654 654 # references to the underlying streams.
655 655 if (sys.platform == 'win32' or sys.platform == 'cli') and self.has_readline:
656 656 io.stdout = io.stderr = io.IOStream(self.readline._outputfile)
657 657 else:
658 658 io.stdout = io.IOStream(sys.stdout)
659 659 io.stderr = io.IOStream(sys.stderr)
660 660
661 661 def init_prompts(self):
662 662 self.prompt_manager = PromptManager(shell=self, parent=self)
663 663 self.configurables.append(self.prompt_manager)
664 664 # Set system prompts, so that scripts can decide if they are running
665 665 # interactively.
666 666 sys.ps1 = 'In : '
667 667 sys.ps2 = '...: '
668 668 sys.ps3 = 'Out: '
669 669
670 670 def init_display_formatter(self):
671 671 self.display_formatter = DisplayFormatter(parent=self)
672 672 self.configurables.append(self.display_formatter)
673 673
674 674 def init_display_pub(self):
675 675 self.display_pub = self.display_pub_class(parent=self)
676 676 self.configurables.append(self.display_pub)
677 677
678 678 def init_data_pub(self):
679 679 if not self.data_pub_class:
680 680 self.data_pub = None
681 681 return
682 682 self.data_pub = self.data_pub_class(parent=self)
683 683 self.configurables.append(self.data_pub)
684 684
685 685 def init_displayhook(self):
686 686 # Initialize displayhook, set in/out prompts and printing system
687 687 self.displayhook = self.displayhook_class(
688 688 parent=self,
689 689 shell=self,
690 690 cache_size=self.cache_size,
691 691 )
692 692 self.configurables.append(self.displayhook)
693 693 # This is a context manager that installs/revmoes the displayhook at
694 694 # the appropriate time.
695 695 self.display_trap = DisplayTrap(hook=self.displayhook)
696 696
697 697 def init_latextool(self):
698 698 """Configure LaTeXTool."""
699 699 cfg = LaTeXTool.instance(parent=self)
700 700 if cfg not in self.configurables:
701 701 self.configurables.append(cfg)
702 702
703 703 def init_virtualenv(self):
704 704 """Add a virtualenv to sys.path so the user can import modules from it.
705 705 This isn't perfect: it doesn't use the Python interpreter with which the
706 706 virtualenv was built, and it ignores the --no-site-packages option. A
707 707 warning will appear suggesting the user installs IPython in the
708 708 virtualenv, but for many cases, it probably works well enough.
709 709
710 710 Adapted from code snippets online.
711 711
712 712 http://blog.ufsoft.org/2009/1/29/ipython-and-virtualenv
713 713 """
714 714 if 'VIRTUAL_ENV' not in os.environ:
715 715 # Not in a virtualenv
716 716 return
717 717
718 718 if sys.executable.startswith(os.environ['VIRTUAL_ENV']):
719 719 # Running properly in the virtualenv, don't need to do anything
720 720 return
721 721
722 722 warn("Attempting to work in a virtualenv. If you encounter problems, please "
723 723 "install IPython inside the virtualenv.")
724 724 if sys.platform == "win32":
725 725 virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'Lib', 'site-packages')
726 726 else:
727 727 virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'lib',
728 728 'python%d.%d' % sys.version_info[:2], 'site-packages')
729 729
730 730 import site
731 731 sys.path.insert(0, virtual_env)
732 732 site.addsitedir(virtual_env)
733 733
734 734 #-------------------------------------------------------------------------
735 735 # Things related to injections into the sys module
736 736 #-------------------------------------------------------------------------
737 737
738 738 def save_sys_module_state(self):
739 739 """Save the state of hooks in the sys module.
740 740
741 741 This has to be called after self.user_module is created.
742 742 """
743 743 self._orig_sys_module_state = {}
744 744 self._orig_sys_module_state['stdin'] = sys.stdin
745 745 self._orig_sys_module_state['stdout'] = sys.stdout
746 746 self._orig_sys_module_state['stderr'] = sys.stderr
747 747 self._orig_sys_module_state['excepthook'] = sys.excepthook
748 748 self._orig_sys_modules_main_name = self.user_module.__name__
749 749 self._orig_sys_modules_main_mod = sys.modules.get(self.user_module.__name__)
750 750
751 751 def restore_sys_module_state(self):
752 752 """Restore the state of the sys module."""
753 753 try:
754 754 for k, v in self._orig_sys_module_state.iteritems():
755 755 setattr(sys, k, v)
756 756 except AttributeError:
757 757 pass
758 758 # Reset what what done in self.init_sys_modules
759 759 if self._orig_sys_modules_main_mod is not None:
760 760 sys.modules[self._orig_sys_modules_main_name] = self._orig_sys_modules_main_mod
761 761
762 762 #-------------------------------------------------------------------------
763 763 # Things related to hooks
764 764 #-------------------------------------------------------------------------
765 765
766 766 def init_hooks(self):
767 767 # hooks holds pointers used for user-side customizations
768 768 self.hooks = Struct()
769 769
770 770 self.strdispatchers = {}
771 771
772 772 # Set all default hooks, defined in the IPython.hooks module.
773 773 hooks = IPython.core.hooks
774 774 for hook_name in hooks.__all__:
775 775 # default hooks have priority 100, i.e. low; user hooks should have
776 776 # 0-100 priority
777 777 self.set_hook(hook_name,getattr(hooks,hook_name), 100)
778 778
779 779 def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None):
780 780 """set_hook(name,hook) -> sets an internal IPython hook.
781 781
782 782 IPython exposes some of its internal API as user-modifiable hooks. By
783 783 adding your function to one of these hooks, you can modify IPython's
784 784 behavior to call at runtime your own routines."""
785 785
786 786 # At some point in the future, this should validate the hook before it
787 787 # accepts it. Probably at least check that the hook takes the number
788 788 # of args it's supposed to.
789 789
790 790 f = types.MethodType(hook,self)
791 791
792 792 # check if the hook is for strdispatcher first
793 793 if str_key is not None:
794 794 sdp = self.strdispatchers.get(name, StrDispatch())
795 795 sdp.add_s(str_key, f, priority )
796 796 self.strdispatchers[name] = sdp
797 797 return
798 798 if re_key is not None:
799 799 sdp = self.strdispatchers.get(name, StrDispatch())
800 800 sdp.add_re(re.compile(re_key), f, priority )
801 801 self.strdispatchers[name] = sdp
802 802 return
803 803
804 804 dp = getattr(self.hooks, name, None)
805 805 if name not in IPython.core.hooks.__all__:
806 806 print("Warning! Hook '%s' is not one of %s" % \
807 807 (name, IPython.core.hooks.__all__ ))
808 808 if not dp:
809 809 dp = IPython.core.hooks.CommandChainDispatcher()
810 810
811 811 try:
812 812 dp.add(f,priority)
813 813 except AttributeError:
814 814 # it was not commandchain, plain old func - replace
815 815 dp = f
816 816
817 817 setattr(self.hooks,name, dp)
818 818
819 819 def register_post_execute(self, func):
820 820 """Register a function for calling after code execution.
821 821 """
822 822 if not callable(func):
823 823 raise ValueError('argument %s must be callable' % func)
824 824 self._post_execute[func] = True
825 825
826 826 #-------------------------------------------------------------------------
827 827 # Things related to the "main" module
828 828 #-------------------------------------------------------------------------
829 829
830 830 def new_main_mod(self, filename, modname):
831 831 """Return a new 'main' module object for user code execution.
832 832
833 833 ``filename`` should be the path of the script which will be run in the
834 834 module. Requests with the same filename will get the same module, with
835 835 its namespace cleared.
836 836
837 837 ``modname`` should be the module name - normally either '__main__' or
838 838 the basename of the file without the extension.
839 839
840 840 When scripts are executed via %run, we must keep a reference to their
841 841 __main__ module around so that Python doesn't
842 842 clear it, rendering references to module globals useless.
843 843
844 844 This method keeps said reference in a private dict, keyed by the
845 845 absolute path of the script. This way, for multiple executions of the
846 846 same script we only keep one copy of the namespace (the last one),
847 847 thus preventing memory leaks from old references while allowing the
848 848 objects from the last execution to be accessible.
849 849 """
850 850 filename = os.path.abspath(filename)
851 851 try:
852 852 main_mod = self._main_mod_cache[filename]
853 853 except KeyError:
854 854 main_mod = self._main_mod_cache[filename] = types.ModuleType(modname,
855 855 doc="Module created for script run in IPython")
856 856 else:
857 857 main_mod.__dict__.clear()
858 858 main_mod.__name__ = modname
859 859
860 860 main_mod.__file__ = filename
861 861 # It seems pydoc (and perhaps others) needs any module instance to
862 862 # implement a __nonzero__ method
863 863 main_mod.__nonzero__ = lambda : True
864 864
865 865 return main_mod
866 866
867 867 def clear_main_mod_cache(self):
868 868 """Clear the cache of main modules.
869 869
870 870 Mainly for use by utilities like %reset.
871 871
872 872 Examples
873 873 --------
874 874
875 875 In [15]: import IPython
876 876
877 877 In [16]: m = _ip.new_main_mod(IPython.__file__, 'IPython')
878 878
879 879 In [17]: len(_ip._main_mod_cache) > 0
880 880 Out[17]: True
881 881
882 882 In [18]: _ip.clear_main_mod_cache()
883 883
884 884 In [19]: len(_ip._main_mod_cache) == 0
885 885 Out[19]: True
886 886 """
887 887 self._main_mod_cache.clear()
888 888
889 889 #-------------------------------------------------------------------------
890 890 # Things related to debugging
891 891 #-------------------------------------------------------------------------
892 892
893 893 def init_pdb(self):
894 894 # Set calling of pdb on exceptions
895 895 # self.call_pdb is a property
896 896 self.call_pdb = self.pdb
897 897
898 898 def _get_call_pdb(self):
899 899 return self._call_pdb
900 900
901 901 def _set_call_pdb(self,val):
902 902
903 903 if val not in (0,1,False,True):
904 904 raise ValueError('new call_pdb value must be boolean')
905 905
906 906 # store value in instance
907 907 self._call_pdb = val
908 908
909 909 # notify the actual exception handlers
910 910 self.InteractiveTB.call_pdb = val
911 911
912 912 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
913 913 'Control auto-activation of pdb at exceptions')
914 914
915 915 def debugger(self,force=False):
916 916 """Call the pydb/pdb debugger.
917 917
918 918 Keywords:
919 919
920 920 - force(False): by default, this routine checks the instance call_pdb
921 921 flag and does not actually invoke the debugger if the flag is false.
922 922 The 'force' option forces the debugger to activate even if the flag
923 923 is false.
924 924 """
925 925
926 926 if not (force or self.call_pdb):
927 927 return
928 928
929 929 if not hasattr(sys,'last_traceback'):
930 930 error('No traceback has been produced, nothing to debug.')
931 931 return
932 932
933 933 # use pydb if available
934 934 if debugger.has_pydb:
935 935 from pydb import pm
936 936 else:
937 937 # fallback to our internal debugger
938 938 pm = lambda : self.InteractiveTB.debugger(force=True)
939 939
940 940 with self.readline_no_record:
941 941 pm()
942 942
943 943 #-------------------------------------------------------------------------
944 944 # Things related to IPython's various namespaces
945 945 #-------------------------------------------------------------------------
946 946 default_user_namespaces = True
947 947
948 948 def init_create_namespaces(self, user_module=None, user_ns=None):
949 949 # Create the namespace where the user will operate. user_ns is
950 950 # normally the only one used, and it is passed to the exec calls as
951 951 # the locals argument. But we do carry a user_global_ns namespace
952 952 # given as the exec 'globals' argument, This is useful in embedding
953 953 # situations where the ipython shell opens in a context where the
954 954 # distinction between locals and globals is meaningful. For
955 955 # non-embedded contexts, it is just the same object as the user_ns dict.
956 956
957 957 # FIXME. For some strange reason, __builtins__ is showing up at user
958 958 # level as a dict instead of a module. This is a manual fix, but I
959 959 # should really track down where the problem is coming from. Alex
960 960 # Schmolck reported this problem first.
961 961
962 962 # A useful post by Alex Martelli on this topic:
963 963 # Re: inconsistent value from __builtins__
964 964 # Von: Alex Martelli <aleaxit@yahoo.com>
965 965 # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends
966 966 # Gruppen: comp.lang.python
967 967
968 968 # Michael Hohn <hohn@hooknose.lbl.gov> wrote:
969 969 # > >>> print type(builtin_check.get_global_binding('__builtins__'))
970 970 # > <type 'dict'>
971 971 # > >>> print type(__builtins__)
972 972 # > <type 'module'>
973 973 # > Is this difference in return value intentional?
974 974
975 975 # Well, it's documented that '__builtins__' can be either a dictionary
976 976 # or a module, and it's been that way for a long time. Whether it's
977 977 # intentional (or sensible), I don't know. In any case, the idea is
978 978 # that if you need to access the built-in namespace directly, you
979 979 # should start with "import __builtin__" (note, no 's') which will
980 980 # definitely give you a module. Yeah, it's somewhat confusing:-(.
981 981
982 982 # These routines return a properly built module and dict as needed by
983 983 # the rest of the code, and can also be used by extension writers to
984 984 # generate properly initialized namespaces.
985 985 if (user_ns is not None) or (user_module is not None):
986 986 self.default_user_namespaces = False
987 987 self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns)
988 988
989 989 # A record of hidden variables we have added to the user namespace, so
990 990 # we can list later only variables defined in actual interactive use.
991 991 self.user_ns_hidden = {}
992 992
993 993 # Now that FakeModule produces a real module, we've run into a nasty
994 994 # problem: after script execution (via %run), the module where the user
995 995 # code ran is deleted. Now that this object is a true module (needed
996 996 # so docetst and other tools work correctly), the Python module
997 997 # teardown mechanism runs over it, and sets to None every variable
998 998 # present in that module. Top-level references to objects from the
999 999 # script survive, because the user_ns is updated with them. However,
1000 1000 # calling functions defined in the script that use other things from
1001 1001 # the script will fail, because the function's closure had references
1002 1002 # to the original objects, which are now all None. So we must protect
1003 1003 # these modules from deletion by keeping a cache.
1004 1004 #
1005 1005 # To avoid keeping stale modules around (we only need the one from the
1006 1006 # last run), we use a dict keyed with the full path to the script, so
1007 1007 # only the last version of the module is held in the cache. Note,
1008 1008 # however, that we must cache the module *namespace contents* (their
1009 1009 # __dict__). Because if we try to cache the actual modules, old ones
1010 1010 # (uncached) could be destroyed while still holding references (such as
1011 1011 # those held by GUI objects that tend to be long-lived)>
1012 1012 #
1013 1013 # The %reset command will flush this cache. See the cache_main_mod()
1014 1014 # and clear_main_mod_cache() methods for details on use.
1015 1015
1016 1016 # This is the cache used for 'main' namespaces
1017 1017 self._main_mod_cache = {}
1018 1018
1019 1019 # A table holding all the namespaces IPython deals with, so that
1020 1020 # introspection facilities can search easily.
1021 1021 self.ns_table = {'user_global':self.user_module.__dict__,
1022 1022 'user_local':self.user_ns,
1023 1023 'builtin':builtin_mod.__dict__
1024 1024 }
1025 1025
1026 1026 @property
1027 1027 def user_global_ns(self):
1028 1028 return self.user_module.__dict__
1029 1029
1030 1030 def prepare_user_module(self, user_module=None, user_ns=None):
1031 1031 """Prepare the module and namespace in which user code will be run.
1032 1032
1033 1033 When IPython is started normally, both parameters are None: a new module
1034 1034 is created automatically, and its __dict__ used as the namespace.
1035 1035
1036 1036 If only user_module is provided, its __dict__ is used as the namespace.
1037 1037 If only user_ns is provided, a dummy module is created, and user_ns
1038 1038 becomes the global namespace. If both are provided (as they may be
1039 1039 when embedding), user_ns is the local namespace, and user_module
1040 1040 provides the global namespace.
1041 1041
1042 1042 Parameters
1043 1043 ----------
1044 1044 user_module : module, optional
1045 1045 The current user module in which IPython is being run. If None,
1046 1046 a clean module will be created.
1047 1047 user_ns : dict, optional
1048 1048 A namespace in which to run interactive commands.
1049 1049
1050 1050 Returns
1051 1051 -------
1052 1052 A tuple of user_module and user_ns, each properly initialised.
1053 1053 """
1054 1054 if user_module is None and user_ns is not None:
1055 1055 user_ns.setdefault("__name__", "__main__")
1056 1056 user_module = DummyMod()
1057 1057 user_module.__dict__ = user_ns
1058 1058
1059 1059 if user_module is None:
1060 1060 user_module = types.ModuleType("__main__",
1061 1061 doc="Automatically created module for IPython interactive environment")
1062 1062
1063 1063 # We must ensure that __builtin__ (without the final 's') is always
1064 1064 # available and pointing to the __builtin__ *module*. For more details:
1065 1065 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1066 1066 user_module.__dict__.setdefault('__builtin__', builtin_mod)
1067 1067 user_module.__dict__.setdefault('__builtins__', builtin_mod)
1068 1068
1069 1069 if user_ns is None:
1070 1070 user_ns = user_module.__dict__
1071 1071
1072 1072 return user_module, user_ns
1073 1073
1074 1074 def init_sys_modules(self):
1075 1075 # We need to insert into sys.modules something that looks like a
1076 1076 # module but which accesses the IPython namespace, for shelve and
1077 1077 # pickle to work interactively. Normally they rely on getting
1078 1078 # everything out of __main__, but for embedding purposes each IPython
1079 1079 # instance has its own private namespace, so we can't go shoving
1080 1080 # everything into __main__.
1081 1081
1082 1082 # note, however, that we should only do this for non-embedded
1083 1083 # ipythons, which really mimic the __main__.__dict__ with their own
1084 1084 # namespace. Embedded instances, on the other hand, should not do
1085 1085 # this because they need to manage the user local/global namespaces
1086 1086 # only, but they live within a 'normal' __main__ (meaning, they
1087 1087 # shouldn't overtake the execution environment of the script they're
1088 1088 # embedded in).
1089 1089
1090 1090 # This is overridden in the InteractiveShellEmbed subclass to a no-op.
1091 1091 main_name = self.user_module.__name__
1092 1092 sys.modules[main_name] = self.user_module
1093 1093
1094 1094 def init_user_ns(self):
1095 1095 """Initialize all user-visible namespaces to their minimum defaults.
1096 1096
1097 1097 Certain history lists are also initialized here, as they effectively
1098 1098 act as user namespaces.
1099 1099
1100 1100 Notes
1101 1101 -----
1102 1102 All data structures here are only filled in, they are NOT reset by this
1103 1103 method. If they were not empty before, data will simply be added to
1104 1104 therm.
1105 1105 """
1106 1106 # This function works in two parts: first we put a few things in
1107 1107 # user_ns, and we sync that contents into user_ns_hidden so that these
1108 1108 # initial variables aren't shown by %who. After the sync, we add the
1109 1109 # rest of what we *do* want the user to see with %who even on a new
1110 1110 # session (probably nothing, so theye really only see their own stuff)
1111 1111
1112 1112 # The user dict must *always* have a __builtin__ reference to the
1113 1113 # Python standard __builtin__ namespace, which must be imported.
1114 1114 # This is so that certain operations in prompt evaluation can be
1115 1115 # reliably executed with builtins. Note that we can NOT use
1116 1116 # __builtins__ (note the 's'), because that can either be a dict or a
1117 1117 # module, and can even mutate at runtime, depending on the context
1118 1118 # (Python makes no guarantees on it). In contrast, __builtin__ is
1119 1119 # always a module object, though it must be explicitly imported.
1120 1120
1121 1121 # For more details:
1122 1122 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1123 1123 ns = dict()
1124 1124
1125 1125 # Put 'help' in the user namespace
1126 1126 try:
1127 1127 from site import _Helper
1128 1128 ns['help'] = _Helper()
1129 1129 except ImportError:
1130 1130 warn('help() not available - check site.py')
1131 1131
1132 1132 # make global variables for user access to the histories
1133 1133 ns['_ih'] = self.history_manager.input_hist_parsed
1134 1134 ns['_oh'] = self.history_manager.output_hist
1135 1135 ns['_dh'] = self.history_manager.dir_hist
1136 1136
1137 1137 ns['_sh'] = shadowns
1138 1138
1139 1139 # user aliases to input and output histories. These shouldn't show up
1140 1140 # in %who, as they can have very large reprs.
1141 1141 ns['In'] = self.history_manager.input_hist_parsed
1142 1142 ns['Out'] = self.history_manager.output_hist
1143 1143
1144 1144 # Store myself as the public api!!!
1145 1145 ns['get_ipython'] = self.get_ipython
1146 1146
1147 1147 ns['exit'] = self.exiter
1148 1148 ns['quit'] = self.exiter
1149 1149
1150 1150 # Sync what we've added so far to user_ns_hidden so these aren't seen
1151 1151 # by %who
1152 1152 self.user_ns_hidden.update(ns)
1153 1153
1154 1154 # Anything put into ns now would show up in %who. Think twice before
1155 1155 # putting anything here, as we really want %who to show the user their
1156 1156 # stuff, not our variables.
1157 1157
1158 1158 # Finally, update the real user's namespace
1159 1159 self.user_ns.update(ns)
1160 1160
1161 1161 @property
1162 1162 def all_ns_refs(self):
1163 1163 """Get a list of references to all the namespace dictionaries in which
1164 1164 IPython might store a user-created object.
1165 1165
1166 1166 Note that this does not include the displayhook, which also caches
1167 1167 objects from the output."""
1168 1168 return [self.user_ns, self.user_global_ns, self.user_ns_hidden] + \
1169 1169 [m.__dict__ for m in self._main_mod_cache.values()]
1170 1170
1171 1171 def reset(self, new_session=True):
1172 1172 """Clear all internal namespaces, and attempt to release references to
1173 1173 user objects.
1174 1174
1175 1175 If new_session is True, a new history session will be opened.
1176 1176 """
1177 1177 # Clear histories
1178 1178 self.history_manager.reset(new_session)
1179 1179 # Reset counter used to index all histories
1180 1180 if new_session:
1181 1181 self.execution_count = 1
1182 1182
1183 1183 # Flush cached output items
1184 1184 if self.displayhook.do_full_cache:
1185 1185 self.displayhook.flush()
1186 1186
1187 1187 # The main execution namespaces must be cleared very carefully,
1188 1188 # skipping the deletion of the builtin-related keys, because doing so
1189 1189 # would cause errors in many object's __del__ methods.
1190 1190 if self.user_ns is not self.user_global_ns:
1191 1191 self.user_ns.clear()
1192 1192 ns = self.user_global_ns
1193 1193 drop_keys = set(ns.keys())
1194 1194 drop_keys.discard('__builtin__')
1195 1195 drop_keys.discard('__builtins__')
1196 1196 drop_keys.discard('__name__')
1197 1197 for k in drop_keys:
1198 1198 del ns[k]
1199 1199
1200 1200 self.user_ns_hidden.clear()
1201 1201
1202 1202 # Restore the user namespaces to minimal usability
1203 1203 self.init_user_ns()
1204 1204
1205 1205 # Restore the default and user aliases
1206 1206 self.alias_manager.clear_aliases()
1207 1207 self.alias_manager.init_aliases()
1208 1208
1209 1209 # Flush the private list of module references kept for script
1210 1210 # execution protection
1211 1211 self.clear_main_mod_cache()
1212 1212
1213 1213 def del_var(self, varname, by_name=False):
1214 1214 """Delete a variable from the various namespaces, so that, as
1215 1215 far as possible, we're not keeping any hidden references to it.
1216 1216
1217 1217 Parameters
1218 1218 ----------
1219 1219 varname : str
1220 1220 The name of the variable to delete.
1221 1221 by_name : bool
1222 1222 If True, delete variables with the given name in each
1223 1223 namespace. If False (default), find the variable in the user
1224 1224 namespace, and delete references to it.
1225 1225 """
1226 1226 if varname in ('__builtin__', '__builtins__'):
1227 1227 raise ValueError("Refusing to delete %s" % varname)
1228 1228
1229 1229 ns_refs = self.all_ns_refs
1230 1230
1231 1231 if by_name: # Delete by name
1232 1232 for ns in ns_refs:
1233 1233 try:
1234 1234 del ns[varname]
1235 1235 except KeyError:
1236 1236 pass
1237 1237 else: # Delete by object
1238 1238 try:
1239 1239 obj = self.user_ns[varname]
1240 1240 except KeyError:
1241 1241 raise NameError("name '%s' is not defined" % varname)
1242 1242 # Also check in output history
1243 1243 ns_refs.append(self.history_manager.output_hist)
1244 1244 for ns in ns_refs:
1245 1245 to_delete = [n for n, o in ns.iteritems() if o is obj]
1246 1246 for name in to_delete:
1247 1247 del ns[name]
1248 1248
1249 1249 # displayhook keeps extra references, but not in a dictionary
1250 1250 for name in ('_', '__', '___'):
1251 1251 if getattr(self.displayhook, name) is obj:
1252 1252 setattr(self.displayhook, name, None)
1253 1253
1254 1254 def reset_selective(self, regex=None):
1255 1255 """Clear selective variables from internal namespaces based on a
1256 1256 specified regular expression.
1257 1257
1258 1258 Parameters
1259 1259 ----------
1260 1260 regex : string or compiled pattern, optional
1261 1261 A regular expression pattern that will be used in searching
1262 1262 variable names in the users namespaces.
1263 1263 """
1264 1264 if regex is not None:
1265 1265 try:
1266 1266 m = re.compile(regex)
1267 1267 except TypeError:
1268 1268 raise TypeError('regex must be a string or compiled pattern')
1269 1269 # Search for keys in each namespace that match the given regex
1270 1270 # If a match is found, delete the key/value pair.
1271 1271 for ns in self.all_ns_refs:
1272 1272 for var in ns:
1273 1273 if m.search(var):
1274 1274 del ns[var]
1275 1275
1276 1276 def push(self, variables, interactive=True):
1277 1277 """Inject a group of variables into the IPython user namespace.
1278 1278
1279 1279 Parameters
1280 1280 ----------
1281 1281 variables : dict, str or list/tuple of str
1282 1282 The variables to inject into the user's namespace. If a dict, a
1283 1283 simple update is done. If a str, the string is assumed to have
1284 1284 variable names separated by spaces. A list/tuple of str can also
1285 1285 be used to give the variable names. If just the variable names are
1286 1286 give (list/tuple/str) then the variable values looked up in the
1287 1287 callers frame.
1288 1288 interactive : bool
1289 1289 If True (default), the variables will be listed with the ``who``
1290 1290 magic.
1291 1291 """
1292 1292 vdict = None
1293 1293
1294 1294 # We need a dict of name/value pairs to do namespace updates.
1295 1295 if isinstance(variables, dict):
1296 1296 vdict = variables
1297 1297 elif isinstance(variables, (basestring, list, tuple)):
1298 1298 if isinstance(variables, basestring):
1299 1299 vlist = variables.split()
1300 1300 else:
1301 1301 vlist = variables
1302 1302 vdict = {}
1303 1303 cf = sys._getframe(1)
1304 1304 for name in vlist:
1305 1305 try:
1306 1306 vdict[name] = eval(name, cf.f_globals, cf.f_locals)
1307 1307 except:
1308 1308 print('Could not get variable %s from %s' %
1309 1309 (name,cf.f_code.co_name))
1310 1310 else:
1311 1311 raise ValueError('variables must be a dict/str/list/tuple')
1312 1312
1313 1313 # Propagate variables to user namespace
1314 1314 self.user_ns.update(vdict)
1315 1315
1316 1316 # And configure interactive visibility
1317 1317 user_ns_hidden = self.user_ns_hidden
1318 1318 if interactive:
1319 1319 for name in vdict:
1320 1320 user_ns_hidden.pop(name, None)
1321 1321 else:
1322 1322 user_ns_hidden.update(vdict)
1323 1323
1324 1324 def drop_by_id(self, variables):
1325 1325 """Remove a dict of variables from the user namespace, if they are the
1326 1326 same as the values in the dictionary.
1327 1327
1328 1328 This is intended for use by extensions: variables that they've added can
1329 1329 be taken back out if they are unloaded, without removing any that the
1330 1330 user has overwritten.
1331 1331
1332 1332 Parameters
1333 1333 ----------
1334 1334 variables : dict
1335 1335 A dictionary mapping object names (as strings) to the objects.
1336 1336 """
1337 1337 for name, obj in variables.iteritems():
1338 1338 if name in self.user_ns and self.user_ns[name] is obj:
1339 1339 del self.user_ns[name]
1340 1340 self.user_ns_hidden.pop(name, None)
1341 1341
1342 1342 #-------------------------------------------------------------------------
1343 1343 # Things related to object introspection
1344 1344 #-------------------------------------------------------------------------
1345 1345
1346 1346 def _ofind(self, oname, namespaces=None):
1347 1347 """Find an object in the available namespaces.
1348 1348
1349 1349 self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic
1350 1350
1351 1351 Has special code to detect magic functions.
1352 1352 """
1353 1353 oname = oname.strip()
1354 1354 #print '1- oname: <%r>' % oname # dbg
1355 1355 if not oname.startswith(ESC_MAGIC) and \
1356 1356 not oname.startswith(ESC_MAGIC2) and \
1357 1357 not py3compat.isidentifier(oname, dotted=True):
1358 1358 return dict(found=False)
1359 1359
1360 1360 alias_ns = None
1361 1361 if namespaces is None:
1362 1362 # Namespaces to search in:
1363 1363 # Put them in a list. The order is important so that we
1364 1364 # find things in the same order that Python finds them.
1365 1365 namespaces = [ ('Interactive', self.user_ns),
1366 1366 ('Interactive (global)', self.user_global_ns),
1367 1367 ('Python builtin', builtin_mod.__dict__),
1368 1368 ]
1369 1369
1370 1370 # initialize results to 'null'
1371 1371 found = False; obj = None; ospace = None; ds = None;
1372 1372 ismagic = False; isalias = False; parent = None
1373 1373
1374 1374 # We need to special-case 'print', which as of python2.6 registers as a
1375 1375 # function but should only be treated as one if print_function was
1376 1376 # loaded with a future import. In this case, just bail.
1377 1377 if (oname == 'print' and not py3compat.PY3 and not \
1378 1378 (self.compile.compiler_flags & __future__.CO_FUTURE_PRINT_FUNCTION)):
1379 1379 return {'found':found, 'obj':obj, 'namespace':ospace,
1380 1380 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1381 1381
1382 1382 # Look for the given name by splitting it in parts. If the head is
1383 1383 # found, then we look for all the remaining parts as members, and only
1384 1384 # declare success if we can find them all.
1385 1385 oname_parts = oname.split('.')
1386 1386 oname_head, oname_rest = oname_parts[0],oname_parts[1:]
1387 1387 for nsname,ns in namespaces:
1388 1388 try:
1389 1389 obj = ns[oname_head]
1390 1390 except KeyError:
1391 1391 continue
1392 1392 else:
1393 1393 #print 'oname_rest:', oname_rest # dbg
1394 1394 for part in oname_rest:
1395 1395 try:
1396 1396 parent = obj
1397 1397 obj = getattr(obj,part)
1398 1398 except:
1399 1399 # Blanket except b/c some badly implemented objects
1400 1400 # allow __getattr__ to raise exceptions other than
1401 1401 # AttributeError, which then crashes IPython.
1402 1402 break
1403 1403 else:
1404 1404 # If we finish the for loop (no break), we got all members
1405 1405 found = True
1406 1406 ospace = nsname
1407 1407 break # namespace loop
1408 1408
1409 1409 # Try to see if it's magic
1410 1410 if not found:
1411 1411 obj = None
1412 1412 if oname.startswith(ESC_MAGIC2):
1413 1413 oname = oname.lstrip(ESC_MAGIC2)
1414 1414 obj = self.find_cell_magic(oname)
1415 1415 elif oname.startswith(ESC_MAGIC):
1416 1416 oname = oname.lstrip(ESC_MAGIC)
1417 1417 obj = self.find_line_magic(oname)
1418 1418 else:
1419 1419 # search without prefix, so run? will find %run?
1420 1420 obj = self.find_line_magic(oname)
1421 1421 if obj is None:
1422 1422 obj = self.find_cell_magic(oname)
1423 1423 if obj is not None:
1424 1424 found = True
1425 1425 ospace = 'IPython internal'
1426 1426 ismagic = True
1427 1427
1428 1428 # Last try: special-case some literals like '', [], {}, etc:
1429 1429 if not found and oname_head in ["''",'""','[]','{}','()']:
1430 1430 obj = eval(oname_head)
1431 1431 found = True
1432 1432 ospace = 'Interactive'
1433 1433
1434 1434 return {'found':found, 'obj':obj, 'namespace':ospace,
1435 1435 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1436 1436
1437 1437 def _ofind_property(self, oname, info):
1438 1438 """Second part of object finding, to look for property details."""
1439 1439 if info.found:
1440 1440 # Get the docstring of the class property if it exists.
1441 1441 path = oname.split('.')
1442 1442 root = '.'.join(path[:-1])
1443 1443 if info.parent is not None:
1444 1444 try:
1445 1445 target = getattr(info.parent, '__class__')
1446 1446 # The object belongs to a class instance.
1447 1447 try:
1448 1448 target = getattr(target, path[-1])
1449 1449 # The class defines the object.
1450 1450 if isinstance(target, property):
1451 1451 oname = root + '.__class__.' + path[-1]
1452 1452 info = Struct(self._ofind(oname))
1453 1453 except AttributeError: pass
1454 1454 except AttributeError: pass
1455 1455
1456 1456 # We return either the new info or the unmodified input if the object
1457 1457 # hadn't been found
1458 1458 return info
1459 1459
1460 1460 def _object_find(self, oname, namespaces=None):
1461 1461 """Find an object and return a struct with info about it."""
1462 1462 inf = Struct(self._ofind(oname, namespaces))
1463 1463 return Struct(self._ofind_property(oname, inf))
1464 1464
1465 1465 def _inspect(self, meth, oname, namespaces=None, **kw):
1466 1466 """Generic interface to the inspector system.
1467 1467
1468 1468 This function is meant to be called by pdef, pdoc & friends."""
1469 1469 info = self._object_find(oname, namespaces)
1470 1470 if info.found:
1471 1471 pmethod = getattr(self.inspector, meth)
1472 1472 formatter = format_screen if info.ismagic else None
1473 1473 if meth == 'pdoc':
1474 1474 pmethod(info.obj, oname, formatter)
1475 1475 elif meth == 'pinfo':
1476 1476 pmethod(info.obj, oname, formatter, info, **kw)
1477 1477 else:
1478 1478 pmethod(info.obj, oname)
1479 1479 else:
1480 1480 print('Object `%s` not found.' % oname)
1481 1481 return 'not found' # so callers can take other action
1482 1482
1483 1483 def object_inspect(self, oname, detail_level=0):
1484 1484 with self.builtin_trap:
1485 1485 info = self._object_find(oname)
1486 1486 if info.found:
1487 1487 return self.inspector.info(info.obj, oname, info=info,
1488 1488 detail_level=detail_level
1489 1489 )
1490 1490 else:
1491 1491 return oinspect.object_info(name=oname, found=False)
1492 1492
1493 1493 #-------------------------------------------------------------------------
1494 1494 # Things related to history management
1495 1495 #-------------------------------------------------------------------------
1496 1496
1497 1497 def init_history(self):
1498 1498 """Sets up the command history, and starts regular autosaves."""
1499 1499 self.history_manager = HistoryManager(shell=self, parent=self)
1500 1500 self.configurables.append(self.history_manager)
1501 1501
1502 1502 #-------------------------------------------------------------------------
1503 1503 # Things related to exception handling and tracebacks (not debugging)
1504 1504 #-------------------------------------------------------------------------
1505 1505
1506 1506 def init_traceback_handlers(self, custom_exceptions):
1507 1507 # Syntax error handler.
1508 1508 self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor')
1509 1509
1510 1510 # The interactive one is initialized with an offset, meaning we always
1511 1511 # want to remove the topmost item in the traceback, which is our own
1512 1512 # internal code. Valid modes: ['Plain','Context','Verbose']
1513 1513 self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain',
1514 1514 color_scheme='NoColor',
1515 1515 tb_offset = 1,
1516 1516 check_cache=check_linecache_ipython)
1517 1517
1518 1518 # The instance will store a pointer to the system-wide exception hook,
1519 1519 # so that runtime code (such as magics) can access it. This is because
1520 1520 # during the read-eval loop, it may get temporarily overwritten.
1521 1521 self.sys_excepthook = sys.excepthook
1522 1522
1523 1523 # and add any custom exception handlers the user may have specified
1524 1524 self.set_custom_exc(*custom_exceptions)
1525 1525
1526 1526 # Set the exception mode
1527 1527 self.InteractiveTB.set_mode(mode=self.xmode)
1528 1528
1529 1529 def set_custom_exc(self, exc_tuple, handler):
1530 1530 """set_custom_exc(exc_tuple,handler)
1531 1531
1532 1532 Set a custom exception handler, which will be called if any of the
1533 1533 exceptions in exc_tuple occur in the mainloop (specifically, in the
1534 1534 run_code() method).
1535 1535
1536 1536 Parameters
1537 1537 ----------
1538 1538
1539 1539 exc_tuple : tuple of exception classes
1540 1540 A *tuple* of exception classes, for which to call the defined
1541 1541 handler. It is very important that you use a tuple, and NOT A
1542 1542 LIST here, because of the way Python's except statement works. If
1543 1543 you only want to trap a single exception, use a singleton tuple::
1544 1544
1545 1545 exc_tuple == (MyCustomException,)
1546 1546
1547 1547 handler : callable
1548 1548 handler must have the following signature::
1549 1549
1550 1550 def my_handler(self, etype, value, tb, tb_offset=None):
1551 1551 ...
1552 1552 return structured_traceback
1553 1553
1554 1554 Your handler must return a structured traceback (a list of strings),
1555 1555 or None.
1556 1556
1557 1557 This will be made into an instance method (via types.MethodType)
1558 1558 of IPython itself, and it will be called if any of the exceptions
1559 1559 listed in the exc_tuple are caught. If the handler is None, an
1560 1560 internal basic one is used, which just prints basic info.
1561 1561
1562 1562 To protect IPython from crashes, if your handler ever raises an
1563 1563 exception or returns an invalid result, it will be immediately
1564 1564 disabled.
1565 1565
1566 1566 WARNING: by putting in your own exception handler into IPython's main
1567 1567 execution loop, you run a very good chance of nasty crashes. This
1568 1568 facility should only be used if you really know what you are doing."""
1569 1569
1570 1570 assert type(exc_tuple)==type(()) , \
1571 1571 "The custom exceptions must be given AS A TUPLE."
1572 1572
1573 1573 def dummy_handler(self,etype,value,tb,tb_offset=None):
1574 1574 print('*** Simple custom exception handler ***')
1575 1575 print('Exception type :',etype)
1576 1576 print('Exception value:',value)
1577 1577 print('Traceback :',tb)
1578 1578 #print 'Source code :','\n'.join(self.buffer)
1579 1579
1580 1580 def validate_stb(stb):
1581 1581 """validate structured traceback return type
1582 1582
1583 1583 return type of CustomTB *should* be a list of strings, but allow
1584 1584 single strings or None, which are harmless.
1585 1585
1586 1586 This function will *always* return a list of strings,
1587 1587 and will raise a TypeError if stb is inappropriate.
1588 1588 """
1589 1589 msg = "CustomTB must return list of strings, not %r" % stb
1590 1590 if stb is None:
1591 1591 return []
1592 1592 elif isinstance(stb, basestring):
1593 1593 return [stb]
1594 1594 elif not isinstance(stb, list):
1595 1595 raise TypeError(msg)
1596 1596 # it's a list
1597 1597 for line in stb:
1598 1598 # check every element
1599 1599 if not isinstance(line, basestring):
1600 1600 raise TypeError(msg)
1601 1601 return stb
1602 1602
1603 1603 if handler is None:
1604 1604 wrapped = dummy_handler
1605 1605 else:
1606 1606 def wrapped(self,etype,value,tb,tb_offset=None):
1607 1607 """wrap CustomTB handler, to protect IPython from user code
1608 1608
1609 1609 This makes it harder (but not impossible) for custom exception
1610 1610 handlers to crash IPython.
1611 1611 """
1612 1612 try:
1613 1613 stb = handler(self,etype,value,tb,tb_offset=tb_offset)
1614 1614 return validate_stb(stb)
1615 1615 except:
1616 1616 # clear custom handler immediately
1617 1617 self.set_custom_exc((), None)
1618 1618 print("Custom TB Handler failed, unregistering", file=io.stderr)
1619 1619 # show the exception in handler first
1620 1620 stb = self.InteractiveTB.structured_traceback(*sys.exc_info())
1621 1621 print(self.InteractiveTB.stb2text(stb), file=io.stdout)
1622 1622 print("The original exception:", file=io.stdout)
1623 1623 stb = self.InteractiveTB.structured_traceback(
1624 1624 (etype,value,tb), tb_offset=tb_offset
1625 1625 )
1626 1626 return stb
1627 1627
1628 1628 self.CustomTB = types.MethodType(wrapped,self)
1629 1629 self.custom_exceptions = exc_tuple
1630 1630
1631 1631 def excepthook(self, etype, value, tb):
1632 1632 """One more defense for GUI apps that call sys.excepthook.
1633 1633
1634 1634 GUI frameworks like wxPython trap exceptions and call
1635 1635 sys.excepthook themselves. I guess this is a feature that
1636 1636 enables them to keep running after exceptions that would
1637 1637 otherwise kill their mainloop. This is a bother for IPython
1638 1638 which excepts to catch all of the program exceptions with a try:
1639 1639 except: statement.
1640 1640
1641 1641 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
1642 1642 any app directly invokes sys.excepthook, it will look to the user like
1643 1643 IPython crashed. In order to work around this, we can disable the
1644 1644 CrashHandler and replace it with this excepthook instead, which prints a
1645 1645 regular traceback using our InteractiveTB. In this fashion, apps which
1646 1646 call sys.excepthook will generate a regular-looking exception from
1647 1647 IPython, and the CrashHandler will only be triggered by real IPython
1648 1648 crashes.
1649 1649
1650 1650 This hook should be used sparingly, only in places which are not likely
1651 1651 to be true IPython errors.
1652 1652 """
1653 1653 self.showtraceback((etype,value,tb),tb_offset=0)
1654 1654
1655 1655 def _get_exc_info(self, exc_tuple=None):
1656 1656 """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc.
1657 1657
1658 1658 Ensures sys.last_type,value,traceback hold the exc_info we found,
1659 1659 from whichever source.
1660 1660
1661 1661 raises ValueError if none of these contain any information
1662 1662 """
1663 1663 if exc_tuple is None:
1664 1664 etype, value, tb = sys.exc_info()
1665 1665 else:
1666 1666 etype, value, tb = exc_tuple
1667 1667
1668 1668 if etype is None:
1669 1669 if hasattr(sys, 'last_type'):
1670 1670 etype, value, tb = sys.last_type, sys.last_value, \
1671 1671 sys.last_traceback
1672 1672
1673 1673 if etype is None:
1674 1674 raise ValueError("No exception to find")
1675 1675
1676 1676 # Now store the exception info in sys.last_type etc.
1677 1677 # WARNING: these variables are somewhat deprecated and not
1678 1678 # necessarily safe to use in a threaded environment, but tools
1679 1679 # like pdb depend on their existence, so let's set them. If we
1680 1680 # find problems in the field, we'll need to revisit their use.
1681 1681 sys.last_type = etype
1682 1682 sys.last_value = value
1683 1683 sys.last_traceback = tb
1684 1684
1685 1685 return etype, value, tb
1686 1686
1687 1687 def show_usage_error(self, exc):
1688 1688 """Show a short message for UsageErrors
1689 1689
1690 1690 These are special exceptions that shouldn't show a traceback.
1691 1691 """
1692 1692 self.write_err("UsageError: %s" % exc)
1693 1693
1694 1694 def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None,
1695 1695 exception_only=False):
1696 1696 """Display the exception that just occurred.
1697 1697
1698 1698 If nothing is known about the exception, this is the method which
1699 1699 should be used throughout the code for presenting user tracebacks,
1700 1700 rather than directly invoking the InteractiveTB object.
1701 1701
1702 1702 A specific showsyntaxerror() also exists, but this method can take
1703 1703 care of calling it if needed, so unless you are explicitly catching a
1704 1704 SyntaxError exception, don't try to analyze the stack manually and
1705 1705 simply call this method."""
1706 1706
1707 1707 try:
1708 1708 try:
1709 1709 etype, value, tb = self._get_exc_info(exc_tuple)
1710 1710 except ValueError:
1711 1711 self.write_err('No traceback available to show.\n')
1712 1712 return
1713 1713
1714 1714 if issubclass(etype, SyntaxError):
1715 1715 # Though this won't be called by syntax errors in the input
1716 1716 # line, there may be SyntaxError cases with imported code.
1717 1717 self.showsyntaxerror(filename)
1718 1718 elif etype is UsageError:
1719 1719 self.show_usage_error(value)
1720 1720 else:
1721 1721 if exception_only:
1722 1722 stb = ['An exception has occurred, use %tb to see '
1723 1723 'the full traceback.\n']
1724 1724 stb.extend(self.InteractiveTB.get_exception_only(etype,
1725 1725 value))
1726 1726 else:
1727 1727 try:
1728 1728 # Exception classes can customise their traceback - we
1729 1729 # use this in IPython.parallel for exceptions occurring
1730 1730 # in the engines. This should return a list of strings.
1731 1731 stb = value._render_traceback_()
1732 1732 except Exception:
1733 1733 stb = self.InteractiveTB.structured_traceback(etype,
1734 1734 value, tb, tb_offset=tb_offset)
1735 1735
1736 1736 self._showtraceback(etype, value, stb)
1737 1737 if self.call_pdb:
1738 1738 # drop into debugger
1739 1739 self.debugger(force=True)
1740 1740 return
1741 1741
1742 1742 # Actually show the traceback
1743 1743 self._showtraceback(etype, value, stb)
1744 1744
1745 1745 except KeyboardInterrupt:
1746 1746 self.write_err("\nKeyboardInterrupt\n")
1747 1747
1748 1748 def _showtraceback(self, etype, evalue, stb):
1749 1749 """Actually show a traceback.
1750 1750
1751 1751 Subclasses may override this method to put the traceback on a different
1752 1752 place, like a side channel.
1753 1753 """
1754 1754 print(self.InteractiveTB.stb2text(stb), file=io.stdout)
1755 1755
1756 1756 def showsyntaxerror(self, filename=None):
1757 1757 """Display the syntax error that just occurred.
1758 1758
1759 1759 This doesn't display a stack trace because there isn't one.
1760 1760
1761 1761 If a filename is given, it is stuffed in the exception instead
1762 1762 of what was there before (because Python's parser always uses
1763 1763 "<string>" when reading from a string).
1764 1764 """
1765 1765 etype, value, last_traceback = self._get_exc_info()
1766 1766
1767 1767 if filename and issubclass(etype, SyntaxError):
1768 1768 try:
1769 1769 value.filename = filename
1770 1770 except:
1771 1771 # Not the format we expect; leave it alone
1772 1772 pass
1773 1773
1774 1774 stb = self.SyntaxTB.structured_traceback(etype, value, [])
1775 1775 self._showtraceback(etype, value, stb)
1776 1776
1777 1777 # This is overridden in TerminalInteractiveShell to show a message about
1778 1778 # the %paste magic.
1779 1779 def showindentationerror(self):
1780 1780 """Called by run_cell when there's an IndentationError in code entered
1781 1781 at the prompt.
1782 1782
1783 1783 This is overridden in TerminalInteractiveShell to show a message about
1784 1784 the %paste magic."""
1785 1785 self.showsyntaxerror()
1786 1786
1787 1787 #-------------------------------------------------------------------------
1788 1788 # Things related to readline
1789 1789 #-------------------------------------------------------------------------
1790 1790
1791 1791 def init_readline(self):
1792 1792 """Command history completion/saving/reloading."""
1793 1793
1794 1794 if self.readline_use:
1795 1795 import IPython.utils.rlineimpl as readline
1796 1796
1797 1797 self.rl_next_input = None
1798 1798 self.rl_do_indent = False
1799 1799
1800 1800 if not self.readline_use or not readline.have_readline:
1801 1801 self.has_readline = False
1802 1802 self.readline = None
1803 1803 # Set a number of methods that depend on readline to be no-op
1804 1804 self.readline_no_record = no_op_context
1805 1805 self.set_readline_completer = no_op
1806 1806 self.set_custom_completer = no_op
1807 1807 if self.readline_use:
1808 1808 warn('Readline services not available or not loaded.')
1809 1809 else:
1810 1810 self.has_readline = True
1811 1811 self.readline = readline
1812 1812 sys.modules['readline'] = readline
1813 1813
1814 1814 # Platform-specific configuration
1815 1815 if os.name == 'nt':
1816 1816 # FIXME - check with Frederick to see if we can harmonize
1817 1817 # naming conventions with pyreadline to avoid this
1818 1818 # platform-dependent check
1819 1819 self.readline_startup_hook = readline.set_pre_input_hook
1820 1820 else:
1821 1821 self.readline_startup_hook = readline.set_startup_hook
1822 1822
1823 1823 # Load user's initrc file (readline config)
1824 1824 # Or if libedit is used, load editrc.
1825 1825 inputrc_name = os.environ.get('INPUTRC')
1826 1826 if inputrc_name is None:
1827 1827 inputrc_name = '.inputrc'
1828 1828 if readline.uses_libedit:
1829 1829 inputrc_name = '.editrc'
1830 1830 inputrc_name = os.path.join(self.home_dir, inputrc_name)
1831 1831 if os.path.isfile(inputrc_name):
1832 1832 try:
1833 1833 readline.read_init_file(inputrc_name)
1834 1834 except:
1835 1835 warn('Problems reading readline initialization file <%s>'
1836 1836 % inputrc_name)
1837 1837
1838 1838 # Configure readline according to user's prefs
1839 1839 # This is only done if GNU readline is being used. If libedit
1840 1840 # is being used (as on Leopard) the readline config is
1841 1841 # not run as the syntax for libedit is different.
1842 1842 if not readline.uses_libedit:
1843 1843 for rlcommand in self.readline_parse_and_bind:
1844 1844 #print "loading rl:",rlcommand # dbg
1845 1845 readline.parse_and_bind(rlcommand)
1846 1846
1847 1847 # Remove some chars from the delimiters list. If we encounter
1848 1848 # unicode chars, discard them.
1849 1849 delims = readline.get_completer_delims()
1850 1850 if not py3compat.PY3:
1851 1851 delims = delims.encode("ascii", "ignore")
1852 1852 for d in self.readline_remove_delims:
1853 1853 delims = delims.replace(d, "")
1854 1854 delims = delims.replace(ESC_MAGIC, '')
1855 1855 readline.set_completer_delims(delims)
1856 1856 # Store these so we can restore them if something like rpy2 modifies
1857 1857 # them.
1858 1858 self.readline_delims = delims
1859 1859 # otherwise we end up with a monster history after a while:
1860 1860 readline.set_history_length(self.history_length)
1861 1861
1862 1862 self.refill_readline_hist()
1863 1863 self.readline_no_record = ReadlineNoRecord(self)
1864 1864
1865 1865 # Configure auto-indent for all platforms
1866 1866 self.set_autoindent(self.autoindent)
1867 1867
1868 1868 def refill_readline_hist(self):
1869 1869 # Load the last 1000 lines from history
1870 1870 self.readline.clear_history()
1871 1871 stdin_encoding = sys.stdin.encoding or "utf-8"
1872 1872 last_cell = u""
1873 1873 for _, _, cell in self.history_manager.get_tail(1000,
1874 1874 include_latest=True):
1875 1875 # Ignore blank lines and consecutive duplicates
1876 1876 cell = cell.rstrip()
1877 1877 if cell and (cell != last_cell):
1878 1878 try:
1879 1879 if self.multiline_history:
1880 1880 self.readline.add_history(py3compat.unicode_to_str(cell,
1881 1881 stdin_encoding))
1882 1882 else:
1883 1883 for line in cell.splitlines():
1884 1884 self.readline.add_history(py3compat.unicode_to_str(line,
1885 1885 stdin_encoding))
1886 1886 last_cell = cell
1887 1887
1888 1888 except TypeError:
1889 1889 # The history DB can get corrupted so it returns strings
1890 1890 # containing null bytes, which readline objects to.
1891 1891 continue
1892 1892
1893 1893 @skip_doctest
1894 1894 def set_next_input(self, s):
1895 1895 """ Sets the 'default' input string for the next command line.
1896 1896
1897 1897 Requires readline.
1898 1898
1899 1899 Example::
1900 1900
1901 1901 In [1]: _ip.set_next_input("Hello Word")
1902 1902 In [2]: Hello Word_ # cursor is here
1903 1903 """
1904 1904 self.rl_next_input = py3compat.cast_bytes_py2(s)
1905 1905
1906 1906 # Maybe move this to the terminal subclass?
1907 1907 def pre_readline(self):
1908 1908 """readline hook to be used at the start of each line.
1909 1909
1910 1910 Currently it handles auto-indent only."""
1911 1911
1912 1912 if self.rl_do_indent:
1913 1913 self.readline.insert_text(self._indent_current_str())
1914 1914 if self.rl_next_input is not None:
1915 1915 self.readline.insert_text(self.rl_next_input)
1916 1916 self.rl_next_input = None
1917 1917
1918 1918 def _indent_current_str(self):
1919 1919 """return the current level of indentation as a string"""
1920 1920 return self.input_splitter.indent_spaces * ' '
1921 1921
1922 1922 #-------------------------------------------------------------------------
1923 1923 # Things related to text completion
1924 1924 #-------------------------------------------------------------------------
1925 1925
1926 1926 def init_completer(self):
1927 1927 """Initialize the completion machinery.
1928 1928
1929 1929 This creates completion machinery that can be used by client code,
1930 1930 either interactively in-process (typically triggered by the readline
1931 1931 library), programatically (such as in test suites) or out-of-prcess
1932 1932 (typically over the network by remote frontends).
1933 1933 """
1934 1934 from IPython.core.completer import IPCompleter
1935 1935 from IPython.core.completerlib import (module_completer,
1936 1936 magic_run_completer, cd_completer, reset_completer)
1937 1937
1938 1938 self.Completer = IPCompleter(shell=self,
1939 1939 namespace=self.user_ns,
1940 1940 global_namespace=self.user_global_ns,
1941 1941 use_readline=self.has_readline,
1942 1942 parent=self,
1943 1943 )
1944 1944 self.configurables.append(self.Completer)
1945 1945
1946 1946 # Add custom completers to the basic ones built into IPCompleter
1947 1947 sdisp = self.strdispatchers.get('complete_command', StrDispatch())
1948 1948 self.strdispatchers['complete_command'] = sdisp
1949 1949 self.Completer.custom_completers = sdisp
1950 1950
1951 1951 self.set_hook('complete_command', module_completer, str_key = 'import')
1952 1952 self.set_hook('complete_command', module_completer, str_key = 'from')
1953 1953 self.set_hook('complete_command', magic_run_completer, str_key = '%run')
1954 1954 self.set_hook('complete_command', cd_completer, str_key = '%cd')
1955 1955 self.set_hook('complete_command', reset_completer, str_key = '%reset')
1956 1956
1957 1957 # Only configure readline if we truly are using readline. IPython can
1958 1958 # do tab-completion over the network, in GUIs, etc, where readline
1959 1959 # itself may be absent
1960 1960 if self.has_readline:
1961 1961 self.set_readline_completer()
1962 1962
1963 1963 def complete(self, text, line=None, cursor_pos=None):
1964 1964 """Return the completed text and a list of completions.
1965 1965
1966 1966 Parameters
1967 1967 ----------
1968 1968
1969 1969 text : string
1970 1970 A string of text to be completed on. It can be given as empty and
1971 1971 instead a line/position pair are given. In this case, the
1972 1972 completer itself will split the line like readline does.
1973 1973
1974 1974 line : string, optional
1975 1975 The complete line that text is part of.
1976 1976
1977 1977 cursor_pos : int, optional
1978 1978 The position of the cursor on the input line.
1979 1979
1980 1980 Returns
1981 1981 -------
1982 1982 text : string
1983 1983 The actual text that was completed.
1984 1984
1985 1985 matches : list
1986 1986 A sorted list with all possible completions.
1987 1987
1988 1988 The optional arguments allow the completion to take more context into
1989 1989 account, and are part of the low-level completion API.
1990 1990
1991 1991 This is a wrapper around the completion mechanism, similar to what
1992 1992 readline does at the command line when the TAB key is hit. By
1993 1993 exposing it as a method, it can be used by other non-readline
1994 1994 environments (such as GUIs) for text completion.
1995 1995
1996 1996 Simple usage example:
1997 1997
1998 1998 In [1]: x = 'hello'
1999 1999
2000 2000 In [2]: _ip.complete('x.l')
2001 2001 Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip'])
2002 2002 """
2003 2003
2004 2004 # Inject names into __builtin__ so we can complete on the added names.
2005 2005 with self.builtin_trap:
2006 2006 return self.Completer.complete(text, line, cursor_pos)
2007 2007
2008 2008 def set_custom_completer(self, completer, pos=0):
2009 2009 """Adds a new custom completer function.
2010 2010
2011 2011 The position argument (defaults to 0) is the index in the completers
2012 2012 list where you want the completer to be inserted."""
2013 2013
2014 2014 newcomp = types.MethodType(completer,self.Completer)
2015 2015 self.Completer.matchers.insert(pos,newcomp)
2016 2016
2017 2017 def set_readline_completer(self):
2018 2018 """Reset readline's completer to be our own."""
2019 2019 self.readline.set_completer(self.Completer.rlcomplete)
2020 2020
2021 2021 def set_completer_frame(self, frame=None):
2022 2022 """Set the frame of the completer."""
2023 2023 if frame:
2024 2024 self.Completer.namespace = frame.f_locals
2025 2025 self.Completer.global_namespace = frame.f_globals
2026 2026 else:
2027 2027 self.Completer.namespace = self.user_ns
2028 2028 self.Completer.global_namespace = self.user_global_ns
2029 2029
2030 2030 #-------------------------------------------------------------------------
2031 2031 # Things related to magics
2032 2032 #-------------------------------------------------------------------------
2033 2033
2034 2034 def init_magics(self):
2035 2035 from IPython.core import magics as m
2036 2036 self.magics_manager = magic.MagicsManager(shell=self,
2037 2037 parent=self,
2038 2038 user_magics=m.UserMagics(self))
2039 2039 self.configurables.append(self.magics_manager)
2040 2040
2041 2041 # Expose as public API from the magics manager
2042 2042 self.register_magics = self.magics_manager.register
2043 2043 self.define_magic = self.magics_manager.define_magic
2044 2044
2045 2045 self.register_magics(m.AutoMagics, m.BasicMagics, m.CodeMagics,
2046 2046 m.ConfigMagics, m.DeprecatedMagics, m.DisplayMagics, m.ExecutionMagics,
2047 2047 m.ExtensionMagics, m.HistoryMagics, m.LoggingMagics,
2048 2048 m.NamespaceMagics, m.OSMagics, m.PylabMagics, m.ScriptMagics,
2049 2049 )
2050 2050
2051 2051 # Register Magic Aliases
2052 2052 mman = self.magics_manager
2053 2053 # FIXME: magic aliases should be defined by the Magics classes
2054 2054 # or in MagicsManager, not here
2055 2055 mman.register_alias('ed', 'edit')
2056 2056 mman.register_alias('hist', 'history')
2057 2057 mman.register_alias('rep', 'recall')
2058 2058 mman.register_alias('SVG', 'svg', 'cell')
2059 2059 mman.register_alias('HTML', 'html', 'cell')
2060 2060 mman.register_alias('file', 'writefile', 'cell')
2061 2061
2062 2062 # FIXME: Move the color initialization to the DisplayHook, which
2063 2063 # should be split into a prompt manager and displayhook. We probably
2064 2064 # even need a centralize colors management object.
2065 2065 self.magic('colors %s' % self.colors)
2066 2066
2067 2067 # Defined here so that it's included in the documentation
2068 2068 @functools.wraps(magic.MagicsManager.register_function)
2069 2069 def register_magic_function(self, func, magic_kind='line', magic_name=None):
2070 2070 self.magics_manager.register_function(func,
2071 2071 magic_kind=magic_kind, magic_name=magic_name)
2072 2072
2073 2073 def run_line_magic(self, magic_name, line):
2074 2074 """Execute the given line magic.
2075 2075
2076 2076 Parameters
2077 2077 ----------
2078 2078 magic_name : str
2079 2079 Name of the desired magic function, without '%' prefix.
2080 2080
2081 2081 line : str
2082 2082 The rest of the input line as a single string.
2083 2083 """
2084 2084 fn = self.find_line_magic(magic_name)
2085 2085 if fn is None:
2086 2086 cm = self.find_cell_magic(magic_name)
2087 2087 etpl = "Line magic function `%%%s` not found%s."
2088 2088 extra = '' if cm is None else (' (But cell magic `%%%%%s` exists, '
2089 2089 'did you mean that instead?)' % magic_name )
2090 2090 error(etpl % (magic_name, extra))
2091 2091 else:
2092 2092 # Note: this is the distance in the stack to the user's frame.
2093 2093 # This will need to be updated if the internal calling logic gets
2094 2094 # refactored, or else we'll be expanding the wrong variables.
2095 2095 stack_depth = 2
2096 2096 magic_arg_s = self.var_expand(line, stack_depth)
2097 2097 # Put magic args in a list so we can call with f(*a) syntax
2098 2098 args = [magic_arg_s]
2099 2099 kwargs = {}
2100 2100 # Grab local namespace if we need it:
2101 2101 if getattr(fn, "needs_local_scope", False):
2102 2102 kwargs['local_ns'] = sys._getframe(stack_depth).f_locals
2103 2103 with self.builtin_trap:
2104 2104 result = fn(*args,**kwargs)
2105 2105 return result
2106 2106
2107 2107 def run_cell_magic(self, magic_name, line, cell):
2108 2108 """Execute the given cell magic.
2109 2109
2110 2110 Parameters
2111 2111 ----------
2112 2112 magic_name : str
2113 2113 Name of the desired magic function, without '%' prefix.
2114 2114
2115 2115 line : str
2116 2116 The rest of the first input line as a single string.
2117 2117
2118 2118 cell : str
2119 2119 The body of the cell as a (possibly multiline) string.
2120 2120 """
2121 2121 fn = self.find_cell_magic(magic_name)
2122 2122 if fn is None:
2123 2123 lm = self.find_line_magic(magic_name)
2124 2124 etpl = "Cell magic `%%{0}` not found{1}."
2125 2125 extra = '' if lm is None else (' (But line magic `%{0}` exists, '
2126 2126 'did you mean that instead?)'.format(magic_name))
2127 2127 error(etpl.format(magic_name, extra))
2128 2128 elif cell == '':
2129 2129 message = '%%{0} is a cell magic, but the cell body is empty.'.format(magic_name)
2130 2130 if self.find_line_magic(magic_name) is not None:
2131 2131 message += ' Did you mean the line magic %{0} (single %)?'.format(magic_name)
2132 2132 raise UsageError(message)
2133 2133 else:
2134 2134 # Note: this is the distance in the stack to the user's frame.
2135 2135 # This will need to be updated if the internal calling logic gets
2136 2136 # refactored, or else we'll be expanding the wrong variables.
2137 2137 stack_depth = 2
2138 2138 magic_arg_s = self.var_expand(line, stack_depth)
2139 2139 with self.builtin_trap:
2140 2140 result = fn(magic_arg_s, cell)
2141 2141 return result
2142 2142
2143 2143 def find_line_magic(self, magic_name):
2144 2144 """Find and return a line magic by name.
2145 2145
2146 2146 Returns None if the magic isn't found."""
2147 2147 return self.magics_manager.magics['line'].get(magic_name)
2148 2148
2149 2149 def find_cell_magic(self, magic_name):
2150 2150 """Find and return a cell magic by name.
2151 2151
2152 2152 Returns None if the magic isn't found."""
2153 2153 return self.magics_manager.magics['cell'].get(magic_name)
2154 2154
2155 2155 def find_magic(self, magic_name, magic_kind='line'):
2156 2156 """Find and return a magic of the given type by name.
2157 2157
2158 2158 Returns None if the magic isn't found."""
2159 2159 return self.magics_manager.magics[magic_kind].get(magic_name)
2160 2160
2161 2161 def magic(self, arg_s):
2162 2162 """DEPRECATED. Use run_line_magic() instead.
2163 2163
2164 2164 Call a magic function by name.
2165 2165
2166 2166 Input: a string containing the name of the magic function to call and
2167 2167 any additional arguments to be passed to the magic.
2168 2168
2169 2169 magic('name -opt foo bar') is equivalent to typing at the ipython
2170 2170 prompt:
2171 2171
2172 2172 In[1]: %name -opt foo bar
2173 2173
2174 2174 To call a magic without arguments, simply use magic('name').
2175 2175
2176 2176 This provides a proper Python function to call IPython's magics in any
2177 2177 valid Python code you can type at the interpreter, including loops and
2178 2178 compound statements.
2179 2179 """
2180 2180 # TODO: should we issue a loud deprecation warning here?
2181 2181 magic_name, _, magic_arg_s = arg_s.partition(' ')
2182 2182 magic_name = magic_name.lstrip(prefilter.ESC_MAGIC)
2183 2183 return self.run_line_magic(magic_name, magic_arg_s)
2184 2184
2185 2185 #-------------------------------------------------------------------------
2186 2186 # Things related to macros
2187 2187 #-------------------------------------------------------------------------
2188 2188
2189 2189 def define_macro(self, name, themacro):
2190 2190 """Define a new macro
2191 2191
2192 2192 Parameters
2193 2193 ----------
2194 2194 name : str
2195 2195 The name of the macro.
2196 2196 themacro : str or Macro
2197 2197 The action to do upon invoking the macro. If a string, a new
2198 2198 Macro object is created by passing the string to it.
2199 2199 """
2200 2200
2201 2201 from IPython.core import macro
2202 2202
2203 2203 if isinstance(themacro, basestring):
2204 2204 themacro = macro.Macro(themacro)
2205 2205 if not isinstance(themacro, macro.Macro):
2206 2206 raise ValueError('A macro must be a string or a Macro instance.')
2207 2207 self.user_ns[name] = themacro
2208 2208
2209 2209 #-------------------------------------------------------------------------
2210 2210 # Things related to the running of system commands
2211 2211 #-------------------------------------------------------------------------
2212 2212
2213 2213 def system_piped(self, cmd):
2214 2214 """Call the given cmd in a subprocess, piping stdout/err
2215 2215
2216 2216 Parameters
2217 2217 ----------
2218 2218 cmd : str
2219 2219 Command to execute (can not end in '&', as background processes are
2220 2220 not supported. Should not be a command that expects input
2221 2221 other than simple text.
2222 2222 """
2223 2223 if cmd.rstrip().endswith('&'):
2224 2224 # this is *far* from a rigorous test
2225 2225 # We do not support backgrounding processes because we either use
2226 2226 # pexpect or pipes to read from. Users can always just call
2227 2227 # os.system() or use ip.system=ip.system_raw
2228 2228 # if they really want a background process.
2229 2229 raise OSError("Background processes not supported.")
2230 2230
2231 2231 # we explicitly do NOT return the subprocess status code, because
2232 2232 # a non-None value would trigger :func:`sys.displayhook` calls.
2233 2233 # Instead, we store the exit_code in user_ns.
2234 2234 self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=1))
2235 2235
2236 2236 def system_raw(self, cmd):
2237 2237 """Call the given cmd in a subprocess using os.system on Windows or
2238 2238 subprocess.call using the system shell on other platforms.
2239 2239
2240 2240 Parameters
2241 2241 ----------
2242 2242 cmd : str
2243 2243 Command to execute.
2244 2244 """
2245 2245 cmd = self.var_expand(cmd, depth=1)
2246 2246 # protect os.system from UNC paths on Windows, which it can't handle:
2247 2247 if sys.platform == 'win32':
2248 2248 from IPython.utils._process_win32 import AvoidUNCPath
2249 2249 with AvoidUNCPath() as path:
2250 2250 if path is not None:
2251 2251 cmd = '"pushd %s &&"%s' % (path, cmd)
2252 2252 cmd = py3compat.unicode_to_str(cmd)
2253 2253 ec = os.system(cmd)
2254 2254 else:
2255 2255 cmd = py3compat.unicode_to_str(cmd)
2256 2256 # Call the cmd using the OS shell, instead of the default /bin/sh, if set.
2257 2257 ec = subprocess.call(cmd, shell=True, executable=os.environ.get('SHELL', None))
2258 2258 # exit code is positive for program failure, or negative for
2259 2259 # terminating signal number.
2260 2260
2261 2261 # We explicitly do NOT return the subprocess status code, because
2262 2262 # a non-None value would trigger :func:`sys.displayhook` calls.
2263 2263 # Instead, we store the exit_code in user_ns.
2264 2264 self.user_ns['_exit_code'] = ec
2265 2265
2266 2266 # use piped system by default, because it is better behaved
2267 2267 system = system_piped
2268 2268
2269 2269 def getoutput(self, cmd, split=True, depth=0):
2270 2270 """Get output (possibly including stderr) from a subprocess.
2271 2271
2272 2272 Parameters
2273 2273 ----------
2274 2274 cmd : str
2275 2275 Command to execute (can not end in '&', as background processes are
2276 2276 not supported.
2277 2277 split : bool, optional
2278 2278 If True, split the output into an IPython SList. Otherwise, an
2279 2279 IPython LSString is returned. These are objects similar to normal
2280 2280 lists and strings, with a few convenience attributes for easier
2281 2281 manipulation of line-based output. You can use '?' on them for
2282 2282 details.
2283 2283 depth : int, optional
2284 2284 How many frames above the caller are the local variables which should
2285 2285 be expanded in the command string? The default (0) assumes that the
2286 2286 expansion variables are in the stack frame calling this function.
2287 2287 """
2288 2288 if cmd.rstrip().endswith('&'):
2289 2289 # this is *far* from a rigorous test
2290 2290 raise OSError("Background processes not supported.")
2291 2291 out = getoutput(self.var_expand(cmd, depth=depth+1))
2292 2292 if split:
2293 2293 out = SList(out.splitlines())
2294 2294 else:
2295 2295 out = LSString(out)
2296 2296 return out
2297 2297
2298 2298 #-------------------------------------------------------------------------
2299 2299 # Things related to aliases
2300 2300 #-------------------------------------------------------------------------
2301 2301
2302 2302 def init_alias(self):
2303 2303 self.alias_manager = AliasManager(shell=self, parent=self)
2304 2304 self.configurables.append(self.alias_manager)
2305 2305
2306 2306 #-------------------------------------------------------------------------
2307 2307 # Things related to extensions
2308 2308 #-------------------------------------------------------------------------
2309 2309
2310 2310 def init_extension_manager(self):
2311 2311 self.extension_manager = ExtensionManager(shell=self, parent=self)
2312 2312 self.configurables.append(self.extension_manager)
2313 2313
2314 2314 #-------------------------------------------------------------------------
2315 2315 # Things related to payloads
2316 2316 #-------------------------------------------------------------------------
2317 2317
2318 2318 def init_payload(self):
2319 2319 self.payload_manager = PayloadManager(parent=self)
2320 2320 self.configurables.append(self.payload_manager)
2321 2321
2322 2322 #-------------------------------------------------------------------------
2323 2323 # Things related to widgets
2324 2324 #-------------------------------------------------------------------------
2325 2325
2326 2326 def init_comms(self):
2327 2327 # not implemented in the base class
2328 2328 pass
2329 2329
2330 2330 #-------------------------------------------------------------------------
2331 2331 # Things related to the prefilter
2332 2332 #-------------------------------------------------------------------------
2333 2333
2334 2334 def init_prefilter(self):
2335 2335 self.prefilter_manager = PrefilterManager(shell=self, parent=self)
2336 2336 self.configurables.append(self.prefilter_manager)
2337 2337 # Ultimately this will be refactored in the new interpreter code, but
2338 2338 # for now, we should expose the main prefilter method (there's legacy
2339 2339 # code out there that may rely on this).
2340 2340 self.prefilter = self.prefilter_manager.prefilter_lines
2341 2341
2342 2342 def auto_rewrite_input(self, cmd):
2343 2343 """Print to the screen the rewritten form of the user's command.
2344 2344
2345 2345 This shows visual feedback by rewriting input lines that cause
2346 2346 automatic calling to kick in, like::
2347 2347
2348 2348 /f x
2349 2349
2350 2350 into::
2351 2351
2352 2352 ------> f(x)
2353 2353
2354 2354 after the user's input prompt. This helps the user understand that the
2355 2355 input line was transformed automatically by IPython.
2356 2356 """
2357 2357 if not self.show_rewritten_input:
2358 2358 return
2359 2359
2360 2360 rw = self.prompt_manager.render('rewrite') + cmd
2361 2361
2362 2362 try:
2363 2363 # plain ascii works better w/ pyreadline, on some machines, so
2364 2364 # we use it and only print uncolored rewrite if we have unicode
2365 2365 rw = str(rw)
2366 2366 print(rw, file=io.stdout)
2367 2367 except UnicodeEncodeError:
2368 2368 print("------> " + cmd)
2369 2369
2370 2370 #-------------------------------------------------------------------------
2371 2371 # Things related to extracting values/expressions from kernel and user_ns
2372 2372 #-------------------------------------------------------------------------
2373 2373
2374 2374 def _user_obj_error(self):
2375 2375 """return simple exception dict
2376 2376
2377 2377 for use in user_variables / expressions
2378 2378 """
2379 2379
2380 2380 etype, evalue, tb = self._get_exc_info()
2381 2381 stb = self.InteractiveTB.get_exception_only(etype, evalue)
2382 2382
2383 2383 exc_info = {
2384 2384 u'status' : 'error',
2385 2385 u'traceback' : stb,
2386 2386 u'ename' : unicode(etype.__name__),
2387 2387 u'evalue' : py3compat.safe_unicode(evalue),
2388 2388 }
2389 2389
2390 2390 return exc_info
2391 2391
2392 2392 def _format_user_obj(self, obj):
2393 2393 """format a user object to display dict
2394 2394
2395 2395 for use in user_expressions / variables
2396 2396 """
2397 2397
2398 2398 data, md = self.display_formatter.format(obj)
2399 2399 value = {
2400 2400 'status' : 'ok',
2401 2401 'data' : data,
2402 2402 'metadata' : md,
2403 2403 }
2404 2404 return value
2405 2405
2406 2406 def user_variables(self, names):
2407 2407 """Get a list of variable names from the user's namespace.
2408 2408
2409 2409 Parameters
2410 2410 ----------
2411 2411 names : list of strings
2412 2412 A list of names of variables to be read from the user namespace.
2413 2413
2414 2414 Returns
2415 2415 -------
2416 2416 A dict, keyed by the input names and with the rich mime-type repr(s) of each value.
2417 2417 Each element will be a sub-dict of the same form as a display_data message.
2418 2418 """
2419 2419 out = {}
2420 2420 user_ns = self.user_ns
2421 2421
2422 2422 for varname in names:
2423 2423 try:
2424 2424 value = self._format_user_obj(user_ns[varname])
2425 2425 except:
2426 2426 value = self._user_obj_error()
2427 2427 out[varname] = value
2428 2428 return out
2429 2429
2430 2430 def user_expressions(self, expressions):
2431 2431 """Evaluate a dict of expressions in the user's namespace.
2432 2432
2433 2433 Parameters
2434 2434 ----------
2435 2435 expressions : dict
2436 2436 A dict with string keys and string values. The expression values
2437 2437 should be valid Python expressions, each of which will be evaluated
2438 2438 in the user namespace.
2439 2439
2440 2440 Returns
2441 2441 -------
2442 2442 A dict, keyed like the input expressions dict, with the rich mime-typed
2443 2443 display_data of each value.
2444 2444 """
2445 2445 out = {}
2446 2446 user_ns = self.user_ns
2447 2447 global_ns = self.user_global_ns
2448 2448
2449 2449 for key, expr in expressions.iteritems():
2450 2450 try:
2451 2451 value = self._format_user_obj(eval(expr, global_ns, user_ns))
2452 2452 except:
2453 2453 value = self._user_obj_error()
2454 2454 out[key] = value
2455 2455 return out
2456 2456
2457 2457 #-------------------------------------------------------------------------
2458 2458 # Things related to the running of code
2459 2459 #-------------------------------------------------------------------------
2460 2460
2461 2461 def ex(self, cmd):
2462 2462 """Execute a normal python statement in user namespace."""
2463 2463 with self.builtin_trap:
2464 exec cmd in self.user_global_ns, self.user_ns
2464 exec(cmd, self.user_global_ns, self.user_ns)
2465 2465
2466 2466 def ev(self, expr):
2467 2467 """Evaluate python expression expr in user namespace.
2468 2468
2469 2469 Returns the result of evaluation
2470 2470 """
2471 2471 with self.builtin_trap:
2472 2472 return eval(expr, self.user_global_ns, self.user_ns)
2473 2473
2474 2474 def safe_execfile(self, fname, *where, **kw):
2475 2475 """A safe version of the builtin execfile().
2476 2476
2477 2477 This version will never throw an exception, but instead print
2478 2478 helpful error messages to the screen. This only works on pure
2479 2479 Python files with the .py extension.
2480 2480
2481 2481 Parameters
2482 2482 ----------
2483 2483 fname : string
2484 2484 The name of the file to be executed.
2485 2485 where : tuple
2486 2486 One or two namespaces, passed to execfile() as (globals,locals).
2487 2487 If only one is given, it is passed as both.
2488 2488 exit_ignore : bool (False)
2489 2489 If True, then silence SystemExit for non-zero status (it is always
2490 2490 silenced for zero status, as it is so common).
2491 2491 raise_exceptions : bool (False)
2492 2492 If True raise exceptions everywhere. Meant for testing.
2493 2493
2494 2494 """
2495 2495 kw.setdefault('exit_ignore', False)
2496 2496 kw.setdefault('raise_exceptions', False)
2497 2497
2498 2498 fname = os.path.abspath(os.path.expanduser(fname))
2499 2499
2500 2500 # Make sure we can open the file
2501 2501 try:
2502 2502 with open(fname) as thefile:
2503 2503 pass
2504 2504 except:
2505 2505 warn('Could not open file <%s> for safe execution.' % fname)
2506 2506 return
2507 2507
2508 2508 # Find things also in current directory. This is needed to mimic the
2509 2509 # behavior of running a script from the system command line, where
2510 2510 # Python inserts the script's directory into sys.path
2511 2511 dname = os.path.dirname(fname)
2512 2512
2513 2513 with prepended_to_syspath(dname):
2514 2514 try:
2515 2515 py3compat.execfile(fname,*where)
2516 2516 except SystemExit as status:
2517 2517 # If the call was made with 0 or None exit status (sys.exit(0)
2518 2518 # or sys.exit() ), don't bother showing a traceback, as both of
2519 2519 # these are considered normal by the OS:
2520 2520 # > python -c'import sys;sys.exit(0)'; echo $?
2521 2521 # 0
2522 2522 # > python -c'import sys;sys.exit()'; echo $?
2523 2523 # 0
2524 2524 # For other exit status, we show the exception unless
2525 2525 # explicitly silenced, but only in short form.
2526 2526 if kw['raise_exceptions']:
2527 2527 raise
2528 2528 if status.code and not kw['exit_ignore']:
2529 2529 self.showtraceback(exception_only=True)
2530 2530 except:
2531 2531 if kw['raise_exceptions']:
2532 2532 raise
2533 2533 self.showtraceback()
2534 2534
2535 2535 def safe_execfile_ipy(self, fname):
2536 2536 """Like safe_execfile, but for .ipy files with IPython syntax.
2537 2537
2538 2538 Parameters
2539 2539 ----------
2540 2540 fname : str
2541 2541 The name of the file to execute. The filename must have a
2542 2542 .ipy extension.
2543 2543 """
2544 2544 fname = os.path.abspath(os.path.expanduser(fname))
2545 2545
2546 2546 # Make sure we can open the file
2547 2547 try:
2548 2548 with open(fname) as thefile:
2549 2549 pass
2550 2550 except:
2551 2551 warn('Could not open file <%s> for safe execution.' % fname)
2552 2552 return
2553 2553
2554 2554 # Find things also in current directory. This is needed to mimic the
2555 2555 # behavior of running a script from the system command line, where
2556 2556 # Python inserts the script's directory into sys.path
2557 2557 dname = os.path.dirname(fname)
2558 2558
2559 2559 with prepended_to_syspath(dname):
2560 2560 try:
2561 2561 with open(fname) as thefile:
2562 2562 # self.run_cell currently captures all exceptions
2563 2563 # raised in user code. It would be nice if there were
2564 2564 # versions of runlines, execfile that did raise, so
2565 2565 # we could catch the errors.
2566 2566 self.run_cell(thefile.read(), store_history=False, shell_futures=False)
2567 2567 except:
2568 2568 self.showtraceback()
2569 2569 warn('Unknown failure executing file: <%s>' % fname)
2570 2570
2571 2571 def safe_run_module(self, mod_name, where):
2572 2572 """A safe version of runpy.run_module().
2573 2573
2574 2574 This version will never throw an exception, but instead print
2575 2575 helpful error messages to the screen.
2576 2576
2577 2577 `SystemExit` exceptions with status code 0 or None are ignored.
2578 2578
2579 2579 Parameters
2580 2580 ----------
2581 2581 mod_name : string
2582 2582 The name of the module to be executed.
2583 2583 where : dict
2584 2584 The globals namespace.
2585 2585 """
2586 2586 try:
2587 2587 try:
2588 2588 where.update(
2589 2589 runpy.run_module(str(mod_name), run_name="__main__",
2590 2590 alter_sys=True)
2591 2591 )
2592 2592 except SystemExit as status:
2593 2593 if status.code:
2594 2594 raise
2595 2595 except:
2596 2596 self.showtraceback()
2597 2597 warn('Unknown failure executing module: <%s>' % mod_name)
2598 2598
2599 2599 def _run_cached_cell_magic(self, magic_name, line):
2600 2600 """Special method to call a cell magic with the data stored in self.
2601 2601 """
2602 2602 cell = self._current_cell_magic_body
2603 2603 self._current_cell_magic_body = None
2604 2604 return self.run_cell_magic(magic_name, line, cell)
2605 2605
2606 2606 def run_cell(self, raw_cell, store_history=False, silent=False, shell_futures=True):
2607 2607 """Run a complete IPython cell.
2608 2608
2609 2609 Parameters
2610 2610 ----------
2611 2611 raw_cell : str
2612 2612 The code (including IPython code such as %magic functions) to run.
2613 2613 store_history : bool
2614 2614 If True, the raw and translated cell will be stored in IPython's
2615 2615 history. For user code calling back into IPython's machinery, this
2616 2616 should be set to False.
2617 2617 silent : bool
2618 2618 If True, avoid side-effects, such as implicit displayhooks and
2619 2619 and logging. silent=True forces store_history=False.
2620 2620 shell_futures : bool
2621 2621 If True, the code will share future statements with the interactive
2622 2622 shell. It will both be affected by previous __future__ imports, and
2623 2623 any __future__ imports in the code will affect the shell. If False,
2624 2624 __future__ imports are not shared in either direction.
2625 2625 """
2626 2626 if (not raw_cell) or raw_cell.isspace():
2627 2627 return
2628 2628
2629 2629 if silent:
2630 2630 store_history = False
2631 2631
2632 2632 self.input_transformer_manager.push(raw_cell)
2633 2633 cell = self.input_transformer_manager.source_reset()
2634 2634
2635 2635 # Our own compiler remembers the __future__ environment. If we want to
2636 2636 # run code with a separate __future__ environment, use the default
2637 2637 # compiler
2638 2638 compiler = self.compile if shell_futures else CachingCompiler()
2639 2639
2640 2640 with self.builtin_trap:
2641 2641 prefilter_failed = False
2642 2642 if len(cell.splitlines()) == 1:
2643 2643 try:
2644 2644 # use prefilter_lines to handle trailing newlines
2645 2645 # restore trailing newline for ast.parse
2646 2646 cell = self.prefilter_manager.prefilter_lines(cell) + '\n'
2647 2647 except AliasError as e:
2648 2648 error(e)
2649 2649 prefilter_failed = True
2650 2650 except Exception:
2651 2651 # don't allow prefilter errors to crash IPython
2652 2652 self.showtraceback()
2653 2653 prefilter_failed = True
2654 2654
2655 2655 # Store raw and processed history
2656 2656 if store_history:
2657 2657 self.history_manager.store_inputs(self.execution_count,
2658 2658 cell, raw_cell)
2659 2659 if not silent:
2660 2660 self.logger.log(cell, raw_cell)
2661 2661
2662 2662 if not prefilter_failed:
2663 2663 # don't run if prefilter failed
2664 2664 cell_name = self.compile.cache(cell, self.execution_count)
2665 2665
2666 2666 with self.display_trap:
2667 2667 try:
2668 2668 code_ast = compiler.ast_parse(cell, filename=cell_name)
2669 2669 except IndentationError:
2670 2670 self.showindentationerror()
2671 2671 if store_history:
2672 2672 self.execution_count += 1
2673 2673 return None
2674 2674 except (OverflowError, SyntaxError, ValueError, TypeError,
2675 2675 MemoryError):
2676 2676 self.showsyntaxerror()
2677 2677 if store_history:
2678 2678 self.execution_count += 1
2679 2679 return None
2680 2680
2681 2681 code_ast = self.transform_ast(code_ast)
2682 2682
2683 2683 interactivity = "none" if silent else self.ast_node_interactivity
2684 2684 self.run_ast_nodes(code_ast.body, cell_name,
2685 2685 interactivity=interactivity, compiler=compiler)
2686 2686
2687 2687 # Execute any registered post-execution functions.
2688 2688 # unless we are silent
2689 2689 post_exec = [] if silent else self._post_execute.iteritems()
2690 2690
2691 2691 for func, status in post_exec:
2692 2692 if self.disable_failing_post_execute and not status:
2693 2693 continue
2694 2694 try:
2695 2695 func()
2696 2696 except KeyboardInterrupt:
2697 2697 print("\nKeyboardInterrupt", file=io.stderr)
2698 2698 except Exception:
2699 2699 # register as failing:
2700 2700 self._post_execute[func] = False
2701 2701 self.showtraceback()
2702 2702 print('\n'.join([
2703 2703 "post-execution function %r produced an error." % func,
2704 2704 "If this problem persists, you can disable failing post-exec functions with:",
2705 2705 "",
2706 2706 " get_ipython().disable_failing_post_execute = True"
2707 2707 ]), file=io.stderr)
2708 2708
2709 2709 if store_history:
2710 2710 # Write output to the database. Does nothing unless
2711 2711 # history output logging is enabled.
2712 2712 self.history_manager.store_output(self.execution_count)
2713 2713 # Each cell is a *single* input, regardless of how many lines it has
2714 2714 self.execution_count += 1
2715 2715
2716 2716 def transform_ast(self, node):
2717 2717 """Apply the AST transformations from self.ast_transformers
2718 2718
2719 2719 Parameters
2720 2720 ----------
2721 2721 node : ast.Node
2722 2722 The root node to be transformed. Typically called with the ast.Module
2723 2723 produced by parsing user input.
2724 2724
2725 2725 Returns
2726 2726 -------
2727 2727 An ast.Node corresponding to the node it was called with. Note that it
2728 2728 may also modify the passed object, so don't rely on references to the
2729 2729 original AST.
2730 2730 """
2731 2731 for transformer in self.ast_transformers:
2732 2732 try:
2733 2733 node = transformer.visit(node)
2734 2734 except Exception:
2735 2735 warn("AST transformer %r threw an error. It will be unregistered." % transformer)
2736 2736 self.ast_transformers.remove(transformer)
2737 2737
2738 2738 if self.ast_transformers:
2739 2739 ast.fix_missing_locations(node)
2740 2740 return node
2741 2741
2742 2742
2743 2743 def run_ast_nodes(self, nodelist, cell_name, interactivity='last_expr',
2744 2744 compiler=compile):
2745 2745 """Run a sequence of AST nodes. The execution mode depends on the
2746 2746 interactivity parameter.
2747 2747
2748 2748 Parameters
2749 2749 ----------
2750 2750 nodelist : list
2751 2751 A sequence of AST nodes to run.
2752 2752 cell_name : str
2753 2753 Will be passed to the compiler as the filename of the cell. Typically
2754 2754 the value returned by ip.compile.cache(cell).
2755 2755 interactivity : str
2756 2756 'all', 'last', 'last_expr' or 'none', specifying which nodes should be
2757 2757 run interactively (displaying output from expressions). 'last_expr'
2758 2758 will run the last node interactively only if it is an expression (i.e.
2759 2759 expressions in loops or other blocks are not displayed. Other values
2760 2760 for this parameter will raise a ValueError.
2761 2761 compiler : callable
2762 2762 A function with the same interface as the built-in compile(), to turn
2763 2763 the AST nodes into code objects. Default is the built-in compile().
2764 2764 """
2765 2765 if not nodelist:
2766 2766 return
2767 2767
2768 2768 if interactivity == 'last_expr':
2769 2769 if isinstance(nodelist[-1], ast.Expr):
2770 2770 interactivity = "last"
2771 2771 else:
2772 2772 interactivity = "none"
2773 2773
2774 2774 if interactivity == 'none':
2775 2775 to_run_exec, to_run_interactive = nodelist, []
2776 2776 elif interactivity == 'last':
2777 2777 to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:]
2778 2778 elif interactivity == 'all':
2779 2779 to_run_exec, to_run_interactive = [], nodelist
2780 2780 else:
2781 2781 raise ValueError("Interactivity was %r" % interactivity)
2782 2782
2783 2783 exec_count = self.execution_count
2784 2784
2785 2785 try:
2786 2786 for i, node in enumerate(to_run_exec):
2787 2787 mod = ast.Module([node])
2788 2788 code = compiler(mod, cell_name, "exec")
2789 2789 if self.run_code(code):
2790 2790 return True
2791 2791
2792 2792 for i, node in enumerate(to_run_interactive):
2793 2793 mod = ast.Interactive([node])
2794 2794 code = compiler(mod, cell_name, "single")
2795 2795 if self.run_code(code):
2796 2796 return True
2797 2797
2798 2798 # Flush softspace
2799 2799 if softspace(sys.stdout, 0):
2800 2800 print()
2801 2801
2802 2802 except:
2803 2803 # It's possible to have exceptions raised here, typically by
2804 2804 # compilation of odd code (such as a naked 'return' outside a
2805 2805 # function) that did parse but isn't valid. Typically the exception
2806 2806 # is a SyntaxError, but it's safest just to catch anything and show
2807 2807 # the user a traceback.
2808 2808
2809 2809 # We do only one try/except outside the loop to minimize the impact
2810 2810 # on runtime, and also because if any node in the node list is
2811 2811 # broken, we should stop execution completely.
2812 2812 self.showtraceback()
2813 2813
2814 2814 return False
2815 2815
2816 2816 def run_code(self, code_obj):
2817 2817 """Execute a code object.
2818 2818
2819 2819 When an exception occurs, self.showtraceback() is called to display a
2820 2820 traceback.
2821 2821
2822 2822 Parameters
2823 2823 ----------
2824 2824 code_obj : code object
2825 2825 A compiled code object, to be executed
2826 2826
2827 2827 Returns
2828 2828 -------
2829 2829 False : successful execution.
2830 2830 True : an error occurred.
2831 2831 """
2832 2832
2833 2833 # Set our own excepthook in case the user code tries to call it
2834 2834 # directly, so that the IPython crash handler doesn't get triggered
2835 2835 old_excepthook,sys.excepthook = sys.excepthook, self.excepthook
2836 2836
2837 2837 # we save the original sys.excepthook in the instance, in case config
2838 2838 # code (such as magics) needs access to it.
2839 2839 self.sys_excepthook = old_excepthook
2840 2840 outflag = 1 # happens in more places, so it's easier as default
2841 2841 try:
2842 2842 try:
2843 2843 self.hooks.pre_run_code_hook()
2844 2844 #rprint('Running code', repr(code_obj)) # dbg
2845 exec code_obj in self.user_global_ns, self.user_ns
2845 exec(code_obj, self.user_global_ns, self.user_ns)
2846 2846 finally:
2847 2847 # Reset our crash handler in place
2848 2848 sys.excepthook = old_excepthook
2849 2849 except SystemExit:
2850 2850 self.showtraceback(exception_only=True)
2851 2851 warn("To exit: use 'exit', 'quit', or Ctrl-D.", level=1)
2852 2852 except self.custom_exceptions:
2853 2853 etype,value,tb = sys.exc_info()
2854 2854 self.CustomTB(etype,value,tb)
2855 2855 except:
2856 2856 self.showtraceback()
2857 2857 else:
2858 2858 outflag = 0
2859 2859 return outflag
2860 2860
2861 2861 # For backwards compatibility
2862 2862 runcode = run_code
2863 2863
2864 2864 #-------------------------------------------------------------------------
2865 2865 # Things related to GUI support and pylab
2866 2866 #-------------------------------------------------------------------------
2867 2867
2868 2868 def enable_gui(self, gui=None):
2869 2869 raise NotImplementedError('Implement enable_gui in a subclass')
2870 2870
2871 2871 def enable_matplotlib(self, gui=None):
2872 2872 """Enable interactive matplotlib and inline figure support.
2873 2873
2874 2874 This takes the following steps:
2875 2875
2876 2876 1. select the appropriate eventloop and matplotlib backend
2877 2877 2. set up matplotlib for interactive use with that backend
2878 2878 3. configure formatters for inline figure display
2879 2879 4. enable the selected gui eventloop
2880 2880
2881 2881 Parameters
2882 2882 ----------
2883 2883 gui : optional, string
2884 2884 If given, dictates the choice of matplotlib GUI backend to use
2885 2885 (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
2886 2886 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
2887 2887 matplotlib (as dictated by the matplotlib build-time options plus the
2888 2888 user's matplotlibrc configuration file). Note that not all backends
2889 2889 make sense in all contexts, for example a terminal ipython can't
2890 2890 display figures inline.
2891 2891 """
2892 2892 from IPython.core import pylabtools as pt
2893 2893 gui, backend = pt.find_gui_and_backend(gui, self.pylab_gui_select)
2894 2894
2895 2895 if gui != 'inline':
2896 2896 # If we have our first gui selection, store it
2897 2897 if self.pylab_gui_select is None:
2898 2898 self.pylab_gui_select = gui
2899 2899 # Otherwise if they are different
2900 2900 elif gui != self.pylab_gui_select:
2901 2901 print ('Warning: Cannot change to a different GUI toolkit: %s.'
2902 2902 ' Using %s instead.' % (gui, self.pylab_gui_select))
2903 2903 gui, backend = pt.find_gui_and_backend(self.pylab_gui_select)
2904 2904
2905 2905 pt.activate_matplotlib(backend)
2906 2906 pt.configure_inline_support(self, backend)
2907 2907
2908 2908 # Now we must activate the gui pylab wants to use, and fix %run to take
2909 2909 # plot updates into account
2910 2910 self.enable_gui(gui)
2911 2911 self.magics_manager.registry['ExecutionMagics'].default_runner = \
2912 2912 pt.mpl_runner(self.safe_execfile)
2913 2913
2914 2914 return gui, backend
2915 2915
2916 2916 def enable_pylab(self, gui=None, import_all=True, welcome_message=False):
2917 2917 """Activate pylab support at runtime.
2918 2918
2919 2919 This turns on support for matplotlib, preloads into the interactive
2920 2920 namespace all of numpy and pylab, and configures IPython to correctly
2921 2921 interact with the GUI event loop. The GUI backend to be used can be
2922 2922 optionally selected with the optional ``gui`` argument.
2923 2923
2924 2924 This method only adds preloading the namespace to InteractiveShell.enable_matplotlib.
2925 2925
2926 2926 Parameters
2927 2927 ----------
2928 2928 gui : optional, string
2929 2929 If given, dictates the choice of matplotlib GUI backend to use
2930 2930 (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
2931 2931 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
2932 2932 matplotlib (as dictated by the matplotlib build-time options plus the
2933 2933 user's matplotlibrc configuration file). Note that not all backends
2934 2934 make sense in all contexts, for example a terminal ipython can't
2935 2935 display figures inline.
2936 2936 import_all : optional, bool, default: True
2937 2937 Whether to do `from numpy import *` and `from pylab import *`
2938 2938 in addition to module imports.
2939 2939 welcome_message : deprecated
2940 2940 This argument is ignored, no welcome message will be displayed.
2941 2941 """
2942 2942 from IPython.core.pylabtools import import_pylab
2943 2943
2944 2944 gui, backend = self.enable_matplotlib(gui)
2945 2945
2946 2946 # We want to prevent the loading of pylab to pollute the user's
2947 2947 # namespace as shown by the %who* magics, so we execute the activation
2948 2948 # code in an empty namespace, and we update *both* user_ns and
2949 2949 # user_ns_hidden with this information.
2950 2950 ns = {}
2951 2951 import_pylab(ns, import_all)
2952 2952 # warn about clobbered names
2953 2953 ignored = set(["__builtins__"])
2954 2954 both = set(ns).intersection(self.user_ns).difference(ignored)
2955 2955 clobbered = [ name for name in both if self.user_ns[name] is not ns[name] ]
2956 2956 self.user_ns.update(ns)
2957 2957 self.user_ns_hidden.update(ns)
2958 2958 return gui, backend, clobbered
2959 2959
2960 2960 #-------------------------------------------------------------------------
2961 2961 # Utilities
2962 2962 #-------------------------------------------------------------------------
2963 2963
2964 2964 def var_expand(self, cmd, depth=0, formatter=DollarFormatter()):
2965 2965 """Expand python variables in a string.
2966 2966
2967 2967 The depth argument indicates how many frames above the caller should
2968 2968 be walked to look for the local namespace where to expand variables.
2969 2969
2970 2970 The global namespace for expansion is always the user's interactive
2971 2971 namespace.
2972 2972 """
2973 2973 ns = self.user_ns.copy()
2974 2974 ns.update(sys._getframe(depth+1).f_locals)
2975 2975 try:
2976 2976 # We have to use .vformat() here, because 'self' is a valid and common
2977 2977 # name, and expanding **ns for .format() would make it collide with
2978 2978 # the 'self' argument of the method.
2979 2979 cmd = formatter.vformat(cmd, args=[], kwargs=ns)
2980 2980 except Exception:
2981 2981 # if formatter couldn't format, just let it go untransformed
2982 2982 pass
2983 2983 return cmd
2984 2984
2985 2985 def mktempfile(self, data=None, prefix='ipython_edit_'):
2986 2986 """Make a new tempfile and return its filename.
2987 2987
2988 2988 This makes a call to tempfile.mktemp, but it registers the created
2989 2989 filename internally so ipython cleans it up at exit time.
2990 2990
2991 2991 Optional inputs:
2992 2992
2993 2993 - data(None): if data is given, it gets written out to the temp file
2994 2994 immediately, and the file is closed again."""
2995 2995
2996 2996 filename = tempfile.mktemp('.py', prefix)
2997 2997 self.tempfiles.append(filename)
2998 2998
2999 2999 if data:
3000 3000 tmp_file = open(filename,'w')
3001 3001 tmp_file.write(data)
3002 3002 tmp_file.close()
3003 3003 return filename
3004 3004
3005 3005 # TODO: This should be removed when Term is refactored.
3006 3006 def write(self,data):
3007 3007 """Write a string to the default output"""
3008 3008 io.stdout.write(data)
3009 3009
3010 3010 # TODO: This should be removed when Term is refactored.
3011 3011 def write_err(self,data):
3012 3012 """Write a string to the default error output"""
3013 3013 io.stderr.write(data)
3014 3014
3015 3015 def ask_yes_no(self, prompt, default=None):
3016 3016 if self.quiet:
3017 3017 return True
3018 3018 return ask_yes_no(prompt,default)
3019 3019
3020 3020 def show_usage(self):
3021 3021 """Show a usage message"""
3022 3022 page.page(IPython.core.usage.interactive_usage)
3023 3023
3024 3024 def extract_input_lines(self, range_str, raw=False):
3025 3025 """Return as a string a set of input history slices.
3026 3026
3027 3027 Parameters
3028 3028 ----------
3029 3029 range_str : string
3030 3030 The set of slices is given as a string, like "~5/6-~4/2 4:8 9",
3031 3031 since this function is for use by magic functions which get their
3032 3032 arguments as strings. The number before the / is the session
3033 3033 number: ~n goes n back from the current session.
3034 3034
3035 3035 Optional Parameters:
3036 3036 - raw(False): by default, the processed input is used. If this is
3037 3037 true, the raw input history is used instead.
3038 3038
3039 3039 Note that slices can be called with two notations:
3040 3040
3041 3041 N:M -> standard python form, means including items N...(M-1).
3042 3042
3043 3043 N-M -> include items N..M (closed endpoint).
3044 3044 """
3045 3045 lines = self.history_manager.get_range_by_str(range_str, raw=raw)
3046 3046 return "\n".join(x for _, _, x in lines)
3047 3047
3048 3048 def find_user_code(self, target, raw=True, py_only=False, skip_encoding_cookie=True):
3049 3049 """Get a code string from history, file, url, or a string or macro.
3050 3050
3051 3051 This is mainly used by magic functions.
3052 3052
3053 3053 Parameters
3054 3054 ----------
3055 3055
3056 3056 target : str
3057 3057
3058 3058 A string specifying code to retrieve. This will be tried respectively
3059 3059 as: ranges of input history (see %history for syntax), url,
3060 3060 correspnding .py file, filename, or an expression evaluating to a
3061 3061 string or Macro in the user namespace.
3062 3062
3063 3063 raw : bool
3064 3064 If true (default), retrieve raw history. Has no effect on the other
3065 3065 retrieval mechanisms.
3066 3066
3067 3067 py_only : bool (default False)
3068 3068 Only try to fetch python code, do not try alternative methods to decode file
3069 3069 if unicode fails.
3070 3070
3071 3071 Returns
3072 3072 -------
3073 3073 A string of code.
3074 3074
3075 3075 ValueError is raised if nothing is found, and TypeError if it evaluates
3076 3076 to an object of another type. In each case, .args[0] is a printable
3077 3077 message.
3078 3078 """
3079 3079 code = self.extract_input_lines(target, raw=raw) # Grab history
3080 3080 if code:
3081 3081 return code
3082 3082 utarget = unquote_filename(target)
3083 3083 try:
3084 3084 if utarget.startswith(('http://', 'https://')):
3085 3085 return openpy.read_py_url(utarget, skip_encoding_cookie=skip_encoding_cookie)
3086 3086 except UnicodeDecodeError:
3087 3087 if not py_only :
3088 3088 from urllib import urlopen # Deferred import
3089 3089 response = urlopen(target)
3090 3090 return response.read().decode('latin1')
3091 3091 raise ValueError(("'%s' seem to be unreadable.") % utarget)
3092 3092
3093 3093 potential_target = [target]
3094 3094 try :
3095 3095 potential_target.insert(0,get_py_filename(target))
3096 3096 except IOError:
3097 3097 pass
3098 3098
3099 3099 for tgt in potential_target :
3100 3100 if os.path.isfile(tgt): # Read file
3101 3101 try :
3102 3102 return openpy.read_py_file(tgt, skip_encoding_cookie=skip_encoding_cookie)
3103 3103 except UnicodeDecodeError :
3104 3104 if not py_only :
3105 3105 with io_open(tgt,'r', encoding='latin1') as f :
3106 3106 return f.read()
3107 3107 raise ValueError(("'%s' seem to be unreadable.") % target)
3108 3108 elif os.path.isdir(os.path.expanduser(tgt)):
3109 3109 raise ValueError("'%s' is a directory, not a regular file." % target)
3110 3110
3111 3111 try: # User namespace
3112 3112 codeobj = eval(target, self.user_ns)
3113 3113 except Exception:
3114 3114 raise ValueError(("'%s' was not found in history, as a file, url, "
3115 3115 "nor in the user namespace.") % target)
3116 3116 if isinstance(codeobj, basestring):
3117 3117 return codeobj
3118 3118 elif isinstance(codeobj, Macro):
3119 3119 return codeobj.value
3120 3120
3121 3121 raise TypeError("%s is neither a string nor a macro." % target,
3122 3122 codeobj)
3123 3123
3124 3124 #-------------------------------------------------------------------------
3125 3125 # Things related to IPython exiting
3126 3126 #-------------------------------------------------------------------------
3127 3127 def atexit_operations(self):
3128 3128 """This will be executed at the time of exit.
3129 3129
3130 3130 Cleanup operations and saving of persistent data that is done
3131 3131 unconditionally by IPython should be performed here.
3132 3132
3133 3133 For things that may depend on startup flags or platform specifics (such
3134 3134 as having readline or not), register a separate atexit function in the
3135 3135 code that has the appropriate information, rather than trying to
3136 3136 clutter
3137 3137 """
3138 3138 # Close the history session (this stores the end time and line count)
3139 3139 # this must be *before* the tempfile cleanup, in case of temporary
3140 3140 # history db
3141 3141 self.history_manager.end_session()
3142 3142
3143 3143 # Cleanup all tempfiles left around
3144 3144 for tfile in self.tempfiles:
3145 3145 try:
3146 3146 os.unlink(tfile)
3147 3147 except OSError:
3148 3148 pass
3149 3149
3150 3150 # Clear all user namespaces to release all references cleanly.
3151 3151 self.reset(new_session=False)
3152 3152
3153 3153 # Run user hooks
3154 3154 self.hooks.shutdown_hook()
3155 3155
3156 3156 def cleanup(self):
3157 3157 self.restore_sys_module_state()
3158 3158
3159 3159
3160 3160 class InteractiveShellABC(object):
3161 3161 """An abstract base class for InteractiveShell."""
3162 3162 __metaclass__ = abc.ABCMeta
3163 3163
3164 3164 InteractiveShellABC.register(InteractiveShell)
@@ -1,159 +1,159 b''
1 1 """Implementation of configuration-related magic functions.
2 2 """
3 3 from __future__ import print_function
4 4 #-----------------------------------------------------------------------------
5 5 # Copyright (c) 2012 The IPython Development Team.
6 6 #
7 7 # Distributed under the terms of the Modified BSD License.
8 8 #
9 9 # The full license is in the file COPYING.txt, distributed with this software.
10 10 #-----------------------------------------------------------------------------
11 11
12 12 #-----------------------------------------------------------------------------
13 13 # Imports
14 14 #-----------------------------------------------------------------------------
15 15
16 16 # Stdlib
17 17 import re
18 18
19 19 # Our own packages
20 20 from IPython.core.error import UsageError
21 21 from IPython.core.magic import Magics, magics_class, line_magic
22 22 from IPython.utils.warn import error
23 23
24 24 #-----------------------------------------------------------------------------
25 25 # Magic implementation classes
26 26 #-----------------------------------------------------------------------------
27 27
28 28 reg = re.compile('^\w+\.\w+$')
29 29 @magics_class
30 30 class ConfigMagics(Magics):
31 31
32 32 def __init__(self, shell):
33 33 super(ConfigMagics, self).__init__(shell)
34 34 self.configurables = []
35 35
36 36 @line_magic
37 37 def config(self, s):
38 38 """configure IPython
39 39
40 40 %config Class[.trait=value]
41 41
42 42 This magic exposes most of the IPython config system. Any
43 43 Configurable class should be able to be configured with the simple
44 44 line::
45 45
46 46 %config Class.trait=value
47 47
48 48 Where `value` will be resolved in the user's namespace, if it is an
49 49 expression or variable name.
50 50
51 51 Examples
52 52 --------
53 53
54 54 To see what classes are available for config, pass no arguments::
55 55
56 56 In [1]: %config
57 57 Available objects for config:
58 58 TerminalInteractiveShell
59 59 HistoryManager
60 60 PrefilterManager
61 61 AliasManager
62 62 IPCompleter
63 63 PromptManager
64 64 DisplayFormatter
65 65
66 66 To view what is configurable on a given class, just pass the class
67 67 name::
68 68
69 69 In [2]: %config IPCompleter
70 70 IPCompleter options
71 71 -----------------
72 72 IPCompleter.omit__names=<Enum>
73 73 Current: 2
74 74 Choices: (0, 1, 2)
75 75 Instruct the completer to omit private method names
76 76 Specifically, when completing on ``object.<tab>``.
77 77 When 2 [default]: all names that start with '_' will be excluded.
78 78 When 1: all 'magic' names (``__foo__``) will be excluded.
79 79 When 0: nothing will be excluded.
80 80 IPCompleter.merge_completions=<CBool>
81 81 Current: True
82 82 Whether to merge completion results into a single list
83 83 If False, only the completion results from the first non-empty
84 84 completer will be returned.
85 85 IPCompleter.limit_to__all__=<CBool>
86 86 Current: False
87 87 Instruct the completer to use __all__ for the completion
88 88 Specifically, when completing on ``object.<tab>``.
89 89 When True: only those names in obj.__all__ will be included.
90 90 When False [default]: the __all__ attribute is ignored
91 91 IPCompleter.greedy=<CBool>
92 92 Current: False
93 93 Activate greedy completion
94 94 This will enable completion on elements of lists, results of
95 95 function calls, etc., but can be unsafe because the code is
96 96 actually evaluated on TAB.
97 97
98 98 but the real use is in setting values::
99 99
100 100 In [3]: %config IPCompleter.greedy = True
101 101
102 102 and these values are read from the user_ns if they are variables::
103 103
104 104 In [4]: feeling_greedy=False
105 105
106 106 In [5]: %config IPCompleter.greedy = feeling_greedy
107 107
108 108 """
109 109 from IPython.config.loader import Config
110 110 # some IPython objects are Configurable, but do not yet have
111 111 # any configurable traits. Exclude them from the effects of
112 112 # this magic, as their presence is just noise:
113 113 configurables = [ c for c in self.shell.configurables
114 114 if c.__class__.class_traits(config=True) ]
115 115 classnames = [ c.__class__.__name__ for c in configurables ]
116 116
117 117 line = s.strip()
118 118 if not line:
119 119 # print available configurable names
120 120 print("Available objects for config:")
121 121 for name in classnames:
122 122 print(" ", name)
123 123 return
124 124 elif line in classnames:
125 125 # `%config TerminalInteractiveShell` will print trait info for
126 126 # TerminalInteractiveShell
127 127 c = configurables[classnames.index(line)]
128 128 cls = c.__class__
129 129 help = cls.class_get_help(c)
130 130 # strip leading '--' from cl-args:
131 131 help = re.sub(re.compile(r'^--', re.MULTILINE), '', help)
132 132 print(help)
133 133 return
134 134 elif reg.match(line):
135 135 cls, attr = line.split('.')
136 136 return getattr(configurables[classnames.index(cls)],attr)
137 137 elif '=' not in line:
138 138 msg = "Invalid config statement: %r, "\
139 139 "should be `Class.trait = value`."
140 140
141 141 ll = line.lower()
142 142 for classname in classnames:
143 143 if ll == classname.lower():
144 144 msg = msg + '\nDid you mean %s (note the case)?' % classname
145 145 break
146 146
147 147 raise UsageError( msg % line)
148 148
149 149 # otherwise, assume we are setting configurables.
150 150 # leave quotes on args when splitting, because we want
151 151 # unquoted args to eval in user_ns
152 152 cfg = Config()
153 exec "cfg."+line in locals(), self.shell.user_ns
153 exec("cfg."+line, locals(), self.shell.user_ns)
154 154
155 155 for configurable in configurables:
156 156 try:
157 157 configurable.update_config(cfg)
158 158 except Exception as e:
159 159 error(e)
@@ -1,1288 +1,1288 b''
1 1 # -*- coding: utf-8 -*-
2 2 """Implementation of execution-related magic functions.
3 3 """
4 4 from __future__ import print_function
5 5 #-----------------------------------------------------------------------------
6 6 # Copyright (c) 2012 The IPython Development Team.
7 7 #
8 8 # Distributed under the terms of the Modified BSD License.
9 9 #
10 10 # The full license is in the file COPYING.txt, distributed with this software.
11 11 #-----------------------------------------------------------------------------
12 12
13 13 #-----------------------------------------------------------------------------
14 14 # Imports
15 15 #-----------------------------------------------------------------------------
16 16
17 17 # Stdlib
18 18 import __builtin__ as builtin_mod
19 19 import ast
20 20 import bdb
21 21 import os
22 22 import sys
23 23 import time
24 24 from StringIO import StringIO
25 25
26 26 # cProfile was added in Python2.5
27 27 try:
28 28 import cProfile as profile
29 29 import pstats
30 30 except ImportError:
31 31 # profile isn't bundled by default in Debian for license reasons
32 32 try:
33 33 import profile, pstats
34 34 except ImportError:
35 35 profile = pstats = None
36 36
37 37 # Our own packages
38 38 from IPython.core import debugger, oinspect
39 39 from IPython.core import magic_arguments
40 40 from IPython.core import page
41 41 from IPython.core.error import UsageError
42 42 from IPython.core.macro import Macro
43 43 from IPython.core.magic import (Magics, magics_class, line_magic, cell_magic,
44 44 line_cell_magic, on_off, needs_local_scope)
45 45 from IPython.testing.skipdoctest import skip_doctest
46 46 from IPython.utils import py3compat
47 47 from IPython.utils.contexts import preserve_keys
48 48 from IPython.utils.io import capture_output
49 49 from IPython.utils.ipstruct import Struct
50 50 from IPython.utils.module_paths import find_mod
51 51 from IPython.utils.path import get_py_filename, unquote_filename, shellglob
52 52 from IPython.utils.timing import clock, clock2
53 53 from IPython.utils.warn import warn, error
54 54
55 55
56 56 #-----------------------------------------------------------------------------
57 57 # Magic implementation classes
58 58 #-----------------------------------------------------------------------------
59 59
60 60
61 61 class TimeitResult(object):
62 62 """
63 63 Object returned by the timeit magic with info about the run.
64 64
65 65 Contain the following attributes :
66 66
67 67 loops: (int) number of loop done per measurement
68 68 repeat: (int) number of time the mesurement has been repeated
69 69 best: (float) best execusion time / number
70 70 all_runs: (list of float) execusion time of each run (in s)
71 71 compile_time: (float) time of statement compilation (s)
72 72
73 73 """
74 74
75 75 def __init__(self, loops, repeat, best, all_runs, compile_time, precision):
76 76 self.loops = loops
77 77 self.repeat = repeat
78 78 self.best = best
79 79 self.all_runs = all_runs
80 80 self.compile_time = compile_time
81 81 self._precision = precision
82 82
83 83 def _repr_pretty_(self, p , cycle):
84 84 unic = u"%d loops, best of %d: %s per loop" % (self.loops, self.repeat,
85 85 _format_time(self.best, self._precision))
86 86 p.text(u'<TimeitResult : '+unic+u'>')
87 87
88 88
89 89
90 90
91 91 @magics_class
92 92 class ExecutionMagics(Magics):
93 93 """Magics related to code execution, debugging, profiling, etc.
94 94
95 95 """
96 96
97 97 def __init__(self, shell):
98 98 super(ExecutionMagics, self).__init__(shell)
99 99 if profile is None:
100 100 self.prun = self.profile_missing_notice
101 101 # Default execution function used to actually run user code.
102 102 self.default_runner = None
103 103
104 104 def profile_missing_notice(self, *args, **kwargs):
105 105 error("""\
106 106 The profile module could not be found. It has been removed from the standard
107 107 python packages because of its non-free license. To use profiling, install the
108 108 python-profiler package from non-free.""")
109 109
110 110 @skip_doctest
111 111 @line_cell_magic
112 112 def prun(self, parameter_s='', cell=None):
113 113
114 114 """Run a statement through the python code profiler.
115 115
116 116 Usage, in line mode:
117 117 %prun [options] statement
118 118
119 119 Usage, in cell mode:
120 120 %%prun [options] [statement]
121 121 code...
122 122 code...
123 123
124 124 In cell mode, the additional code lines are appended to the (possibly
125 125 empty) statement in the first line. Cell mode allows you to easily
126 126 profile multiline blocks without having to put them in a separate
127 127 function.
128 128
129 129 The given statement (which doesn't require quote marks) is run via the
130 130 python profiler in a manner similar to the profile.run() function.
131 131 Namespaces are internally managed to work correctly; profile.run
132 132 cannot be used in IPython because it makes certain assumptions about
133 133 namespaces which do not hold under IPython.
134 134
135 135 Options:
136 136
137 137 -l <limit>
138 138 you can place restrictions on what or how much of the
139 139 profile gets printed. The limit value can be:
140 140
141 141 * A string: only information for function names containing this string
142 142 is printed.
143 143
144 144 * An integer: only these many lines are printed.
145 145
146 146 * A float (between 0 and 1): this fraction of the report is printed
147 147 (for example, use a limit of 0.4 to see the topmost 40% only).
148 148
149 149 You can combine several limits with repeated use of the option. For
150 150 example, ``-l __init__ -l 5`` will print only the topmost 5 lines of
151 151 information about class constructors.
152 152
153 153 -r
154 154 return the pstats.Stats object generated by the profiling. This
155 155 object has all the information about the profile in it, and you can
156 156 later use it for further analysis or in other functions.
157 157
158 158 -s <key>
159 159 sort profile by given key. You can provide more than one key
160 160 by using the option several times: '-s key1 -s key2 -s key3...'. The
161 161 default sorting key is 'time'.
162 162
163 163 The following is copied verbatim from the profile documentation
164 164 referenced below:
165 165
166 166 When more than one key is provided, additional keys are used as
167 167 secondary criteria when the there is equality in all keys selected
168 168 before them.
169 169
170 170 Abbreviations can be used for any key names, as long as the
171 171 abbreviation is unambiguous. The following are the keys currently
172 172 defined:
173 173
174 174 ============ =====================
175 175 Valid Arg Meaning
176 176 ============ =====================
177 177 "calls" call count
178 178 "cumulative" cumulative time
179 179 "file" file name
180 180 "module" file name
181 181 "pcalls" primitive call count
182 182 "line" line number
183 183 "name" function name
184 184 "nfl" name/file/line
185 185 "stdname" standard name
186 186 "time" internal time
187 187 ============ =====================
188 188
189 189 Note that all sorts on statistics are in descending order (placing
190 190 most time consuming items first), where as name, file, and line number
191 191 searches are in ascending order (i.e., alphabetical). The subtle
192 192 distinction between "nfl" and "stdname" is that the standard name is a
193 193 sort of the name as printed, which means that the embedded line
194 194 numbers get compared in an odd way. For example, lines 3, 20, and 40
195 195 would (if the file names were the same) appear in the string order
196 196 "20" "3" and "40". In contrast, "nfl" does a numeric compare of the
197 197 line numbers. In fact, sort_stats("nfl") is the same as
198 198 sort_stats("name", "file", "line").
199 199
200 200 -T <filename>
201 201 save profile results as shown on screen to a text
202 202 file. The profile is still shown on screen.
203 203
204 204 -D <filename>
205 205 save (via dump_stats) profile statistics to given
206 206 filename. This data is in a format understood by the pstats module, and
207 207 is generated by a call to the dump_stats() method of profile
208 208 objects. The profile is still shown on screen.
209 209
210 210 -q
211 211 suppress output to the pager. Best used with -T and/or -D above.
212 212
213 213 If you want to run complete programs under the profiler's control, use
214 214 ``%run -p [prof_opts] filename.py [args to program]`` where prof_opts
215 215 contains profiler specific options as described here.
216 216
217 217 You can read the complete documentation for the profile module with::
218 218
219 219 In [1]: import profile; profile.help()
220 220 """
221 221 opts, arg_str = self.parse_options(parameter_s, 'D:l:rs:T:q',
222 222 list_all=True, posix=False)
223 223 if cell is not None:
224 224 arg_str += '\n' + cell
225 225 arg_str = self.shell.input_splitter.transform_cell(arg_str)
226 226 return self._run_with_profiler(arg_str, opts, self.shell.user_ns)
227 227
228 228 def _run_with_profiler(self, code, opts, namespace):
229 229 """
230 230 Run `code` with profiler. Used by ``%prun`` and ``%run -p``.
231 231
232 232 Parameters
233 233 ----------
234 234 code : str
235 235 Code to be executed.
236 236 opts : Struct
237 237 Options parsed by `self.parse_options`.
238 238 namespace : dict
239 239 A dictionary for Python namespace (e.g., `self.shell.user_ns`).
240 240
241 241 """
242 242
243 243 # Fill default values for unspecified options:
244 244 opts.merge(Struct(D=[''], l=[], s=['time'], T=['']))
245 245
246 246 prof = profile.Profile()
247 247 try:
248 248 prof = prof.runctx(code, namespace, namespace)
249 249 sys_exit = ''
250 250 except SystemExit:
251 251 sys_exit = """*** SystemExit exception caught in code being profiled."""
252 252
253 253 stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s)
254 254
255 255 lims = opts.l
256 256 if lims:
257 257 lims = [] # rebuild lims with ints/floats/strings
258 258 for lim in opts.l:
259 259 try:
260 260 lims.append(int(lim))
261 261 except ValueError:
262 262 try:
263 263 lims.append(float(lim))
264 264 except ValueError:
265 265 lims.append(lim)
266 266
267 267 # Trap output.
268 268 stdout_trap = StringIO()
269 269 stats_stream = stats.stream
270 270 try:
271 271 stats.stream = stdout_trap
272 272 stats.print_stats(*lims)
273 273 finally:
274 274 stats.stream = stats_stream
275 275
276 276 output = stdout_trap.getvalue()
277 277 output = output.rstrip()
278 278
279 279 if 'q' not in opts:
280 280 page.page(output)
281 281 print(sys_exit, end=' ')
282 282
283 283 dump_file = opts.D[0]
284 284 text_file = opts.T[0]
285 285 if dump_file:
286 286 dump_file = unquote_filename(dump_file)
287 287 prof.dump_stats(dump_file)
288 288 print('\n*** Profile stats marshalled to file',\
289 289 repr(dump_file)+'.',sys_exit)
290 290 if text_file:
291 291 text_file = unquote_filename(text_file)
292 292 pfile = open(text_file,'w')
293 293 pfile.write(output)
294 294 pfile.close()
295 295 print('\n*** Profile printout saved to text file',\
296 296 repr(text_file)+'.',sys_exit)
297 297
298 298 if 'r' in opts:
299 299 return stats
300 300 else:
301 301 return None
302 302
303 303 @line_magic
304 304 def pdb(self, parameter_s=''):
305 305 """Control the automatic calling of the pdb interactive debugger.
306 306
307 307 Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without
308 308 argument it works as a toggle.
309 309
310 310 When an exception is triggered, IPython can optionally call the
311 311 interactive pdb debugger after the traceback printout. %pdb toggles
312 312 this feature on and off.
313 313
314 314 The initial state of this feature is set in your configuration
315 315 file (the option is ``InteractiveShell.pdb``).
316 316
317 317 If you want to just activate the debugger AFTER an exception has fired,
318 318 without having to type '%pdb on' and rerunning your code, you can use
319 319 the %debug magic."""
320 320
321 321 par = parameter_s.strip().lower()
322 322
323 323 if par:
324 324 try:
325 325 new_pdb = {'off':0,'0':0,'on':1,'1':1}[par]
326 326 except KeyError:
327 327 print ('Incorrect argument. Use on/1, off/0, '
328 328 'or nothing for a toggle.')
329 329 return
330 330 else:
331 331 # toggle
332 332 new_pdb = not self.shell.call_pdb
333 333
334 334 # set on the shell
335 335 self.shell.call_pdb = new_pdb
336 336 print('Automatic pdb calling has been turned',on_off(new_pdb))
337 337
338 338 @skip_doctest
339 339 @magic_arguments.magic_arguments()
340 340 @magic_arguments.argument('--breakpoint', '-b', metavar='FILE:LINE',
341 341 help="""
342 342 Set break point at LINE in FILE.
343 343 """
344 344 )
345 345 @magic_arguments.argument('statement', nargs='*',
346 346 help="""
347 347 Code to run in debugger.
348 348 You can omit this in cell magic mode.
349 349 """
350 350 )
351 351 @line_cell_magic
352 352 def debug(self, line='', cell=None):
353 353 """Activate the interactive debugger.
354 354
355 355 This magic command support two ways of activating debugger.
356 356 One is to activate debugger before executing code. This way, you
357 357 can set a break point, to step through the code from the point.
358 358 You can use this mode by giving statements to execute and optionally
359 359 a breakpoint.
360 360
361 361 The other one is to activate debugger in post-mortem mode. You can
362 362 activate this mode simply running %debug without any argument.
363 363 If an exception has just occurred, this lets you inspect its stack
364 364 frames interactively. Note that this will always work only on the last
365 365 traceback that occurred, so you must call this quickly after an
366 366 exception that you wish to inspect has fired, because if another one
367 367 occurs, it clobbers the previous one.
368 368
369 369 If you want IPython to automatically do this on every exception, see
370 370 the %pdb magic for more details.
371 371 """
372 372 args = magic_arguments.parse_argstring(self.debug, line)
373 373
374 374 if not (args.breakpoint or args.statement or cell):
375 375 self._debug_post_mortem()
376 376 else:
377 377 code = "\n".join(args.statement)
378 378 if cell:
379 379 code += "\n" + cell
380 380 self._debug_exec(code, args.breakpoint)
381 381
382 382 def _debug_post_mortem(self):
383 383 self.shell.debugger(force=True)
384 384
385 385 def _debug_exec(self, code, breakpoint):
386 386 if breakpoint:
387 387 (filename, bp_line) = breakpoint.split(':', 1)
388 388 bp_line = int(bp_line)
389 389 else:
390 390 (filename, bp_line) = (None, None)
391 391 self._run_with_debugger(code, self.shell.user_ns, filename, bp_line)
392 392
393 393 @line_magic
394 394 def tb(self, s):
395 395 """Print the last traceback with the currently active exception mode.
396 396
397 397 See %xmode for changing exception reporting modes."""
398 398 self.shell.showtraceback()
399 399
400 400 @skip_doctest
401 401 @line_magic
402 402 def run(self, parameter_s='', runner=None,
403 403 file_finder=get_py_filename):
404 404 """Run the named file inside IPython as a program.
405 405
406 406 Usage::
407 407
408 408 %run [-n -i -e -G]
409 409 [( -t [-N<N>] | -d [-b<N>] | -p [profile options] )]
410 410 ( -m mod | file ) [args]
411 411
412 412 Parameters after the filename are passed as command-line arguments to
413 413 the program (put in sys.argv). Then, control returns to IPython's
414 414 prompt.
415 415
416 416 This is similar to running at a system prompt ``python file args``,
417 417 but with the advantage of giving you IPython's tracebacks, and of
418 418 loading all variables into your interactive namespace for further use
419 419 (unless -p is used, see below).
420 420
421 421 The file is executed in a namespace initially consisting only of
422 422 ``__name__=='__main__'`` and sys.argv constructed as indicated. It thus
423 423 sees its environment as if it were being run as a stand-alone program
424 424 (except for sharing global objects such as previously imported
425 425 modules). But after execution, the IPython interactive namespace gets
426 426 updated with all variables defined in the program (except for __name__
427 427 and sys.argv). This allows for very convenient loading of code for
428 428 interactive work, while giving each program a 'clean sheet' to run in.
429 429
430 430 Arguments are expanded using shell-like glob match. Patterns
431 431 '*', '?', '[seq]' and '[!seq]' can be used. Additionally,
432 432 tilde '~' will be expanded into user's home directory. Unlike
433 433 real shells, quotation does not suppress expansions. Use
434 434 *two* back slashes (e.g. ``\\\\*``) to suppress expansions.
435 435 To completely disable these expansions, you can use -G flag.
436 436
437 437 Options:
438 438
439 439 -n
440 440 __name__ is NOT set to '__main__', but to the running file's name
441 441 without extension (as python does under import). This allows running
442 442 scripts and reloading the definitions in them without calling code
443 443 protected by an ``if __name__ == "__main__"`` clause.
444 444
445 445 -i
446 446 run the file in IPython's namespace instead of an empty one. This
447 447 is useful if you are experimenting with code written in a text editor
448 448 which depends on variables defined interactively.
449 449
450 450 -e
451 451 ignore sys.exit() calls or SystemExit exceptions in the script
452 452 being run. This is particularly useful if IPython is being used to
453 453 run unittests, which always exit with a sys.exit() call. In such
454 454 cases you are interested in the output of the test results, not in
455 455 seeing a traceback of the unittest module.
456 456
457 457 -t
458 458 print timing information at the end of the run. IPython will give
459 459 you an estimated CPU time consumption for your script, which under
460 460 Unix uses the resource module to avoid the wraparound problems of
461 461 time.clock(). Under Unix, an estimate of time spent on system tasks
462 462 is also given (for Windows platforms this is reported as 0.0).
463 463
464 464 If -t is given, an additional ``-N<N>`` option can be given, where <N>
465 465 must be an integer indicating how many times you want the script to
466 466 run. The final timing report will include total and per run results.
467 467
468 468 For example (testing the script uniq_stable.py)::
469 469
470 470 In [1]: run -t uniq_stable
471 471
472 472 IPython CPU timings (estimated):
473 473 User : 0.19597 s.
474 474 System: 0.0 s.
475 475
476 476 In [2]: run -t -N5 uniq_stable
477 477
478 478 IPython CPU timings (estimated):
479 479 Total runs performed: 5
480 480 Times : Total Per run
481 481 User : 0.910862 s, 0.1821724 s.
482 482 System: 0.0 s, 0.0 s.
483 483
484 484 -d
485 485 run your program under the control of pdb, the Python debugger.
486 486 This allows you to execute your program step by step, watch variables,
487 487 etc. Internally, what IPython does is similar to calling::
488 488
489 489 pdb.run('execfile("YOURFILENAME")')
490 490
491 491 with a breakpoint set on line 1 of your file. You can change the line
492 492 number for this automatic breakpoint to be <N> by using the -bN option
493 493 (where N must be an integer). For example::
494 494
495 495 %run -d -b40 myscript
496 496
497 497 will set the first breakpoint at line 40 in myscript.py. Note that
498 498 the first breakpoint must be set on a line which actually does
499 499 something (not a comment or docstring) for it to stop execution.
500 500
501 501 Or you can specify a breakpoint in a different file::
502 502
503 503 %run -d -b myotherfile.py:20 myscript
504 504
505 505 When the pdb debugger starts, you will see a (Pdb) prompt. You must
506 506 first enter 'c' (without quotes) to start execution up to the first
507 507 breakpoint.
508 508
509 509 Entering 'help' gives information about the use of the debugger. You
510 510 can easily see pdb's full documentation with "import pdb;pdb.help()"
511 511 at a prompt.
512 512
513 513 -p
514 514 run program under the control of the Python profiler module (which
515 515 prints a detailed report of execution times, function calls, etc).
516 516
517 517 You can pass other options after -p which affect the behavior of the
518 518 profiler itself. See the docs for %prun for details.
519 519
520 520 In this mode, the program's variables do NOT propagate back to the
521 521 IPython interactive namespace (because they remain in the namespace
522 522 where the profiler executes them).
523 523
524 524 Internally this triggers a call to %prun, see its documentation for
525 525 details on the options available specifically for profiling.
526 526
527 527 There is one special usage for which the text above doesn't apply:
528 528 if the filename ends with .ipy, the file is run as ipython script,
529 529 just as if the commands were written on IPython prompt.
530 530
531 531 -m
532 532 specify module name to load instead of script path. Similar to
533 533 the -m option for the python interpreter. Use this option last if you
534 534 want to combine with other %run options. Unlike the python interpreter
535 535 only source modules are allowed no .pyc or .pyo files.
536 536 For example::
537 537
538 538 %run -m example
539 539
540 540 will run the example module.
541 541
542 542 -G
543 543 disable shell-like glob expansion of arguments.
544 544
545 545 """
546 546
547 547 # get arguments and set sys.argv for program to be run.
548 548 opts, arg_lst = self.parse_options(parameter_s,
549 549 'nidtN:b:pD:l:rs:T:em:G',
550 550 mode='list', list_all=1)
551 551 if "m" in opts:
552 552 modulename = opts["m"][0]
553 553 modpath = find_mod(modulename)
554 554 if modpath is None:
555 555 warn('%r is not a valid modulename on sys.path'%modulename)
556 556 return
557 557 arg_lst = [modpath] + arg_lst
558 558 try:
559 559 filename = file_finder(arg_lst[0])
560 560 except IndexError:
561 561 warn('you must provide at least a filename.')
562 562 print('\n%run:\n', oinspect.getdoc(self.run))
563 563 return
564 564 except IOError as e:
565 565 try:
566 566 msg = str(e)
567 567 except UnicodeError:
568 568 msg = e.message
569 569 error(msg)
570 570 return
571 571
572 572 if filename.lower().endswith('.ipy'):
573 573 with preserve_keys(self.shell.user_ns, '__file__'):
574 574 self.shell.user_ns['__file__'] = filename
575 575 self.shell.safe_execfile_ipy(filename)
576 576 return
577 577
578 578 # Control the response to exit() calls made by the script being run
579 579 exit_ignore = 'e' in opts
580 580
581 581 # Make sure that the running script gets a proper sys.argv as if it
582 582 # were run from a system shell.
583 583 save_argv = sys.argv # save it for later restoring
584 584
585 585 if 'G' in opts:
586 586 args = arg_lst[1:]
587 587 else:
588 588 # tilde and glob expansion
589 589 args = shellglob(map(os.path.expanduser, arg_lst[1:]))
590 590
591 591 sys.argv = [filename] + args # put in the proper filename
592 592 # protect sys.argv from potential unicode strings on Python 2:
593 593 if not py3compat.PY3:
594 594 sys.argv = [ py3compat.cast_bytes(a) for a in sys.argv ]
595 595
596 596 if 'i' in opts:
597 597 # Run in user's interactive namespace
598 598 prog_ns = self.shell.user_ns
599 599 __name__save = self.shell.user_ns['__name__']
600 600 prog_ns['__name__'] = '__main__'
601 601 main_mod = self.shell.user_module
602 602
603 603 # Since '%run foo' emulates 'python foo.py' at the cmd line, we must
604 604 # set the __file__ global in the script's namespace
605 605 # TK: Is this necessary in interactive mode?
606 606 prog_ns['__file__'] = filename
607 607 else:
608 608 # Run in a fresh, empty namespace
609 609 if 'n' in opts:
610 610 name = os.path.splitext(os.path.basename(filename))[0]
611 611 else:
612 612 name = '__main__'
613 613
614 614 # The shell MUST hold a reference to prog_ns so after %run
615 615 # exits, the python deletion mechanism doesn't zero it out
616 616 # (leaving dangling references). See interactiveshell for details
617 617 main_mod = self.shell.new_main_mod(filename, name)
618 618 prog_ns = main_mod.__dict__
619 619
620 620 # pickle fix. See interactiveshell for an explanation. But we need to
621 621 # make sure that, if we overwrite __main__, we replace it at the end
622 622 main_mod_name = prog_ns['__name__']
623 623
624 624 if main_mod_name == '__main__':
625 625 restore_main = sys.modules['__main__']
626 626 else:
627 627 restore_main = False
628 628
629 629 # This needs to be undone at the end to prevent holding references to
630 630 # every single object ever created.
631 631 sys.modules[main_mod_name] = main_mod
632 632
633 633 if 'p' in opts or 'd' in opts:
634 634 if 'm' in opts:
635 635 code = 'run_module(modulename, prog_ns)'
636 636 code_ns = {
637 637 'run_module': self.shell.safe_run_module,
638 638 'prog_ns': prog_ns,
639 639 'modulename': modulename,
640 640 }
641 641 else:
642 642 code = 'execfile(filename, prog_ns)'
643 643 code_ns = {
644 644 'execfile': self.shell.safe_execfile,
645 645 'prog_ns': prog_ns,
646 646 'filename': get_py_filename(filename),
647 647 }
648 648
649 649 try:
650 650 stats = None
651 651 with self.shell.readline_no_record:
652 652 if 'p' in opts:
653 653 stats = self._run_with_profiler(code, opts, code_ns)
654 654 else:
655 655 if 'd' in opts:
656 656 bp_file, bp_line = parse_breakpoint(
657 657 opts.get('b', ['1'])[0], filename)
658 658 self._run_with_debugger(
659 659 code, code_ns, filename, bp_line, bp_file)
660 660 else:
661 661 if 'm' in opts:
662 662 def run():
663 663 self.shell.safe_run_module(modulename, prog_ns)
664 664 else:
665 665 if runner is None:
666 666 runner = self.default_runner
667 667 if runner is None:
668 668 runner = self.shell.safe_execfile
669 669
670 670 def run():
671 671 runner(filename, prog_ns, prog_ns,
672 672 exit_ignore=exit_ignore)
673 673
674 674 if 't' in opts:
675 675 # timed execution
676 676 try:
677 677 nruns = int(opts['N'][0])
678 678 if nruns < 1:
679 679 error('Number of runs must be >=1')
680 680 return
681 681 except (KeyError):
682 682 nruns = 1
683 683 self._run_with_timing(run, nruns)
684 684 else:
685 685 # regular execution
686 686 run()
687 687
688 688 if 'i' in opts:
689 689 self.shell.user_ns['__name__'] = __name__save
690 690 else:
691 691 # update IPython interactive namespace
692 692
693 693 # Some forms of read errors on the file may mean the
694 694 # __name__ key was never set; using pop we don't have to
695 695 # worry about a possible KeyError.
696 696 prog_ns.pop('__name__', None)
697 697
698 698 with preserve_keys(self.shell.user_ns, '__file__'):
699 699 self.shell.user_ns.update(prog_ns)
700 700 finally:
701 701 # It's a bit of a mystery why, but __builtins__ can change from
702 702 # being a module to becoming a dict missing some key data after
703 703 # %run. As best I can see, this is NOT something IPython is doing
704 704 # at all, and similar problems have been reported before:
705 705 # http://coding.derkeiler.com/Archive/Python/comp.lang.python/2004-10/0188.html
706 706 # Since this seems to be done by the interpreter itself, the best
707 707 # we can do is to at least restore __builtins__ for the user on
708 708 # exit.
709 709 self.shell.user_ns['__builtins__'] = builtin_mod
710 710
711 711 # Ensure key global structures are restored
712 712 sys.argv = save_argv
713 713 if restore_main:
714 714 sys.modules['__main__'] = restore_main
715 715 else:
716 716 # Remove from sys.modules the reference to main_mod we'd
717 717 # added. Otherwise it will trap references to objects
718 718 # contained therein.
719 719 del sys.modules[main_mod_name]
720 720
721 721 return stats
722 722
723 723 def _run_with_debugger(self, code, code_ns, filename=None,
724 724 bp_line=None, bp_file=None):
725 725 """
726 726 Run `code` in debugger with a break point.
727 727
728 728 Parameters
729 729 ----------
730 730 code : str
731 731 Code to execute.
732 732 code_ns : dict
733 733 A namespace in which `code` is executed.
734 734 filename : str
735 735 `code` is ran as if it is in `filename`.
736 736 bp_line : int, optional
737 737 Line number of the break point.
738 738 bp_file : str, optional
739 739 Path to the file in which break point is specified.
740 740 `filename` is used if not given.
741 741
742 742 Raises
743 743 ------
744 744 UsageError
745 745 If the break point given by `bp_line` is not valid.
746 746
747 747 """
748 748 deb = debugger.Pdb(self.shell.colors)
749 749 # reset Breakpoint state, which is moronically kept
750 750 # in a class
751 751 bdb.Breakpoint.next = 1
752 752 bdb.Breakpoint.bplist = {}
753 753 bdb.Breakpoint.bpbynumber = [None]
754 754 if bp_line is not None:
755 755 # Set an initial breakpoint to stop execution
756 756 maxtries = 10
757 757 bp_file = bp_file or filename
758 758 checkline = deb.checkline(bp_file, bp_line)
759 759 if not checkline:
760 760 for bp in range(bp_line + 1, bp_line + maxtries + 1):
761 761 if deb.checkline(bp_file, bp):
762 762 break
763 763 else:
764 764 msg = ("\nI failed to find a valid line to set "
765 765 "a breakpoint\n"
766 766 "after trying up to line: %s.\n"
767 767 "Please set a valid breakpoint manually "
768 768 "with the -b option." % bp)
769 769 raise UsageError(msg)
770 770 # if we find a good linenumber, set the breakpoint
771 771 deb.do_break('%s:%s' % (bp_file, bp_line))
772 772
773 773 if filename:
774 774 # Mimic Pdb._runscript(...)
775 775 deb._wait_for_mainpyfile = True
776 776 deb.mainpyfile = deb.canonic(filename)
777 777
778 778 # Start file run
779 779 print("NOTE: Enter 'c' at the %s prompt to continue execution." % deb.prompt)
780 780 try:
781 781 if filename:
782 782 # save filename so it can be used by methods on the deb object
783 783 deb._exec_filename = filename
784 784 deb.run(code, code_ns)
785 785
786 786 except:
787 787 etype, value, tb = sys.exc_info()
788 788 # Skip three frames in the traceback: the %run one,
789 789 # one inside bdb.py, and the command-line typed by the
790 790 # user (run by exec in pdb itself).
791 791 self.shell.InteractiveTB(etype, value, tb, tb_offset=3)
792 792
793 793 @staticmethod
794 794 def _run_with_timing(run, nruns):
795 795 """
796 796 Run function `run` and print timing information.
797 797
798 798 Parameters
799 799 ----------
800 800 run : callable
801 801 Any callable object which takes no argument.
802 802 nruns : int
803 803 Number of times to execute `run`.
804 804
805 805 """
806 806 twall0 = time.time()
807 807 if nruns == 1:
808 808 t0 = clock2()
809 809 run()
810 810 t1 = clock2()
811 811 t_usr = t1[0] - t0[0]
812 812 t_sys = t1[1] - t0[1]
813 813 print("\nIPython CPU timings (estimated):")
814 814 print(" User : %10.2f s." % t_usr)
815 815 print(" System : %10.2f s." % t_sys)
816 816 else:
817 817 runs = range(nruns)
818 818 t0 = clock2()
819 819 for nr in runs:
820 820 run()
821 821 t1 = clock2()
822 822 t_usr = t1[0] - t0[0]
823 823 t_sys = t1[1] - t0[1]
824 824 print("\nIPython CPU timings (estimated):")
825 825 print("Total runs performed:", nruns)
826 826 print(" Times : %10s %10s" % ('Total', 'Per run'))
827 827 print(" User : %10.2f s, %10.2f s." % (t_usr, t_usr / nruns))
828 828 print(" System : %10.2f s, %10.2f s." % (t_sys, t_sys / nruns))
829 829 twall1 = time.time()
830 830 print("Wall time: %10.2f s." % (twall1 - twall0))
831 831
832 832 @skip_doctest
833 833 @line_cell_magic
834 834 def timeit(self, line='', cell=None):
835 835 """Time execution of a Python statement or expression
836 836
837 837 Usage, in line mode:
838 838 %timeit [-n<N> -r<R> [-t|-c] -q -p<P> -o] statement
839 839 or in cell mode:
840 840 %%timeit [-n<N> -r<R> [-t|-c] -q -p<P> -o] setup_code
841 841 code
842 842 code...
843 843
844 844 Time execution of a Python statement or expression using the timeit
845 845 module. This function can be used both as a line and cell magic:
846 846
847 847 - In line mode you can time a single-line statement (though multiple
848 848 ones can be chained with using semicolons).
849 849
850 850 - In cell mode, the statement in the first line is used as setup code
851 851 (executed but not timed) and the body of the cell is timed. The cell
852 852 body has access to any variables created in the setup code.
853 853
854 854 Options:
855 855 -n<N>: execute the given statement <N> times in a loop. If this value
856 856 is not given, a fitting value is chosen.
857 857
858 858 -r<R>: repeat the loop iteration <R> times and take the best result.
859 859 Default: 3
860 860
861 861 -t: use time.time to measure the time, which is the default on Unix.
862 862 This function measures wall time.
863 863
864 864 -c: use time.clock to measure the time, which is the default on
865 865 Windows and measures wall time. On Unix, resource.getrusage is used
866 866 instead and returns the CPU user time.
867 867
868 868 -p<P>: use a precision of <P> digits to display the timing result.
869 869 Default: 3
870 870
871 871 -q: Quiet, do not print result.
872 872
873 873 -o: return a TimeitResult that can be stored in a variable to inspect
874 874 the result in more details.
875 875
876 876
877 877 Examples
878 878 --------
879 879 ::
880 880
881 881 In [1]: %timeit pass
882 882 10000000 loops, best of 3: 53.3 ns per loop
883 883
884 884 In [2]: u = None
885 885
886 886 In [3]: %timeit u is None
887 887 10000000 loops, best of 3: 184 ns per loop
888 888
889 889 In [4]: %timeit -r 4 u == None
890 890 1000000 loops, best of 4: 242 ns per loop
891 891
892 892 In [5]: import time
893 893
894 894 In [6]: %timeit -n1 time.sleep(2)
895 895 1 loops, best of 3: 2 s per loop
896 896
897 897
898 898 The times reported by %timeit will be slightly higher than those
899 899 reported by the timeit.py script when variables are accessed. This is
900 900 due to the fact that %timeit executes the statement in the namespace
901 901 of the shell, compared with timeit.py, which uses a single setup
902 902 statement to import function or create variables. Generally, the bias
903 903 does not matter as long as results from timeit.py are not mixed with
904 904 those from %timeit."""
905 905
906 906 import timeit
907 907
908 908 opts, stmt = self.parse_options(line,'n:r:tcp:qo',
909 909 posix=False, strict=False)
910 910 if stmt == "" and cell is None:
911 911 return
912 912
913 913 timefunc = timeit.default_timer
914 914 number = int(getattr(opts, "n", 0))
915 915 repeat = int(getattr(opts, "r", timeit.default_repeat))
916 916 precision = int(getattr(opts, "p", 3))
917 917 quiet = 'q' in opts
918 918 return_result = 'o' in opts
919 919 if hasattr(opts, "t"):
920 920 timefunc = time.time
921 921 if hasattr(opts, "c"):
922 922 timefunc = clock
923 923
924 924 timer = timeit.Timer(timer=timefunc)
925 925 # this code has tight coupling to the inner workings of timeit.Timer,
926 926 # but is there a better way to achieve that the code stmt has access
927 927 # to the shell namespace?
928 928 transform = self.shell.input_splitter.transform_cell
929 929
930 930 if cell is None:
931 931 # called as line magic
932 932 ast_setup = ast.parse("pass")
933 933 ast_stmt = ast.parse(transform(stmt))
934 934 else:
935 935 ast_setup = ast.parse(transform(stmt))
936 936 ast_stmt = ast.parse(transform(cell))
937 937
938 938 ast_setup = self.shell.transform_ast(ast_setup)
939 939 ast_stmt = self.shell.transform_ast(ast_stmt)
940 940
941 941 # This codestring is taken from timeit.template - we fill it in as an
942 942 # AST, so that we can apply our AST transformations to the user code
943 943 # without affecting the timing code.
944 944 timeit_ast_template = ast.parse('def inner(_it, _timer):\n'
945 945 ' setup\n'
946 946 ' _t0 = _timer()\n'
947 947 ' for _i in _it:\n'
948 948 ' stmt\n'
949 949 ' _t1 = _timer()\n'
950 950 ' return _t1 - _t0\n')
951 951
952 952 class TimeitTemplateFiller(ast.NodeTransformer):
953 953 "This is quite tightly tied to the template definition above."
954 954 def visit_FunctionDef(self, node):
955 955 "Fill in the setup statement"
956 956 self.generic_visit(node)
957 957 if node.name == "inner":
958 958 node.body[:1] = ast_setup.body
959 959
960 960 return node
961 961
962 962 def visit_For(self, node):
963 963 "Fill in the statement to be timed"
964 964 if getattr(getattr(node.body[0], 'value', None), 'id', None) == 'stmt':
965 965 node.body = ast_stmt.body
966 966 return node
967 967
968 968 timeit_ast = TimeitTemplateFiller().visit(timeit_ast_template)
969 969 timeit_ast = ast.fix_missing_locations(timeit_ast)
970 970
971 971 # Track compilation time so it can be reported if too long
972 972 # Minimum time above which compilation time will be reported
973 973 tc_min = 0.1
974 974
975 975 t0 = clock()
976 976 code = compile(timeit_ast, "<magic-timeit>", "exec")
977 977 tc = clock()-t0
978 978
979 979 ns = {}
980 exec code in self.shell.user_ns, ns
980 exec(code, self.shell.user_ns, ns)
981 981 timer.inner = ns["inner"]
982 982
983 983 if number == 0:
984 984 # determine number so that 0.2 <= total time < 2.0
985 985 number = 1
986 986 for _ in range(1, 10):
987 987 if timer.timeit(number) >= 0.2:
988 988 break
989 989 number *= 10
990 990 all_runs = timer.repeat(repeat, number)
991 991 best = min(all_runs) / number
992 992 if not quiet :
993 993 print(u"%d loops, best of %d: %s per loop" % (number, repeat,
994 994 _format_time(best, precision)))
995 995 if tc > tc_min:
996 996 print("Compiler time: %.2f s" % tc)
997 997 if return_result:
998 998 return TimeitResult(number, repeat, best, all_runs, tc, precision)
999 999
1000 1000 @skip_doctest
1001 1001 @needs_local_scope
1002 1002 @line_cell_magic
1003 1003 def time(self,line='', cell=None, local_ns=None):
1004 1004 """Time execution of a Python statement or expression.
1005 1005
1006 1006 The CPU and wall clock times are printed, and the value of the
1007 1007 expression (if any) is returned. Note that under Win32, system time
1008 1008 is always reported as 0, since it can not be measured.
1009 1009
1010 1010 This function can be used both as a line and cell magic:
1011 1011
1012 1012 - In line mode you can time a single-line statement (though multiple
1013 1013 ones can be chained with using semicolons).
1014 1014
1015 1015 - In cell mode, you can time the cell body (a directly
1016 1016 following statement raises an error).
1017 1017
1018 1018 This function provides very basic timing functionality. Use the timeit
1019 1019 magic for more controll over the measurement.
1020 1020
1021 1021 Examples
1022 1022 --------
1023 1023 ::
1024 1024
1025 1025 In [1]: %time 2**128
1026 1026 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1027 1027 Wall time: 0.00
1028 1028 Out[1]: 340282366920938463463374607431768211456L
1029 1029
1030 1030 In [2]: n = 1000000
1031 1031
1032 1032 In [3]: %time sum(range(n))
1033 1033 CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s
1034 1034 Wall time: 1.37
1035 1035 Out[3]: 499999500000L
1036 1036
1037 1037 In [4]: %time print 'hello world'
1038 1038 hello world
1039 1039 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1040 1040 Wall time: 0.00
1041 1041
1042 1042 Note that the time needed by Python to compile the given expression
1043 1043 will be reported if it is more than 0.1s. In this example, the
1044 1044 actual exponentiation is done by Python at compilation time, so while
1045 1045 the expression can take a noticeable amount of time to compute, that
1046 1046 time is purely due to the compilation:
1047 1047
1048 1048 In [5]: %time 3**9999;
1049 1049 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1050 1050 Wall time: 0.00 s
1051 1051
1052 1052 In [6]: %time 3**999999;
1053 1053 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1054 1054 Wall time: 0.00 s
1055 1055 Compiler : 0.78 s
1056 1056 """
1057 1057
1058 1058 # fail immediately if the given expression can't be compiled
1059 1059
1060 1060 if line and cell:
1061 1061 raise UsageError("Can't use statement directly after '%%time'!")
1062 1062
1063 1063 if cell:
1064 1064 expr = self.shell.input_transformer_manager.transform_cell(cell)
1065 1065 else:
1066 1066 expr = self.shell.input_transformer_manager.transform_cell(line)
1067 1067
1068 1068 # Minimum time above which parse time will be reported
1069 1069 tp_min = 0.1
1070 1070
1071 1071 t0 = clock()
1072 1072 expr_ast = ast.parse(expr)
1073 1073 tp = clock()-t0
1074 1074
1075 1075 # Apply AST transformations
1076 1076 expr_ast = self.shell.transform_ast(expr_ast)
1077 1077
1078 1078 # Minimum time above which compilation time will be reported
1079 1079 tc_min = 0.1
1080 1080
1081 1081 if len(expr_ast.body)==1 and isinstance(expr_ast.body[0], ast.Expr):
1082 1082 mode = 'eval'
1083 1083 source = '<timed eval>'
1084 1084 expr_ast = ast.Expression(expr_ast.body[0].value)
1085 1085 else:
1086 1086 mode = 'exec'
1087 1087 source = '<timed exec>'
1088 1088 t0 = clock()
1089 1089 code = compile(expr_ast, source, mode)
1090 1090 tc = clock()-t0
1091 1091
1092 1092 # skew measurement as little as possible
1093 1093 glob = self.shell.user_ns
1094 1094 wtime = time.time
1095 1095 # time execution
1096 1096 wall_st = wtime()
1097 1097 if mode=='eval':
1098 1098 st = clock2()
1099 1099 out = eval(code, glob, local_ns)
1100 1100 end = clock2()
1101 1101 else:
1102 1102 st = clock2()
1103 exec code in glob, local_ns
1103 exec(code, glob, local_ns)
1104 1104 end = clock2()
1105 1105 out = None
1106 1106 wall_end = wtime()
1107 1107 # Compute actual times and report
1108 1108 wall_time = wall_end-wall_st
1109 1109 cpu_user = end[0]-st[0]
1110 1110 cpu_sys = end[1]-st[1]
1111 1111 cpu_tot = cpu_user+cpu_sys
1112 1112 # On windows cpu_sys is always zero, so no new information to the next print
1113 1113 if sys.platform != 'win32':
1114 1114 print("CPU times: user %s, sys: %s, total: %s" % \
1115 1115 (_format_time(cpu_user),_format_time(cpu_sys),_format_time(cpu_tot)))
1116 1116 print("Wall time: %s" % _format_time(wall_time))
1117 1117 if tc > tc_min:
1118 1118 print("Compiler : %s" % _format_time(tc))
1119 1119 if tp > tp_min:
1120 1120 print("Parser : %s" % _format_time(tp))
1121 1121 return out
1122 1122
1123 1123 @skip_doctest
1124 1124 @line_magic
1125 1125 def macro(self, parameter_s=''):
1126 1126 """Define a macro for future re-execution. It accepts ranges of history,
1127 1127 filenames or string objects.
1128 1128
1129 1129 Usage:\\
1130 1130 %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ...
1131 1131
1132 1132 Options:
1133 1133
1134 1134 -r: use 'raw' input. By default, the 'processed' history is used,
1135 1135 so that magics are loaded in their transformed version to valid
1136 1136 Python. If this option is given, the raw input as typed at the
1137 1137 command line is used instead.
1138 1138
1139 1139 -q: quiet macro definition. By default, a tag line is printed
1140 1140 to indicate the macro has been created, and then the contents of
1141 1141 the macro are printed. If this option is given, then no printout
1142 1142 is produced once the macro is created.
1143 1143
1144 1144 This will define a global variable called `name` which is a string
1145 1145 made of joining the slices and lines you specify (n1,n2,... numbers
1146 1146 above) from your input history into a single string. This variable
1147 1147 acts like an automatic function which re-executes those lines as if
1148 1148 you had typed them. You just type 'name' at the prompt and the code
1149 1149 executes.
1150 1150
1151 1151 The syntax for indicating input ranges is described in %history.
1152 1152
1153 1153 Note: as a 'hidden' feature, you can also use traditional python slice
1154 1154 notation, where N:M means numbers N through M-1.
1155 1155
1156 1156 For example, if your history contains (print using %hist -n )::
1157 1157
1158 1158 44: x=1
1159 1159 45: y=3
1160 1160 46: z=x+y
1161 1161 47: print x
1162 1162 48: a=5
1163 1163 49: print 'x',x,'y',y
1164 1164
1165 1165 you can create a macro with lines 44 through 47 (included) and line 49
1166 1166 called my_macro with::
1167 1167
1168 1168 In [55]: %macro my_macro 44-47 49
1169 1169
1170 1170 Now, typing `my_macro` (without quotes) will re-execute all this code
1171 1171 in one pass.
1172 1172
1173 1173 You don't need to give the line-numbers in order, and any given line
1174 1174 number can appear multiple times. You can assemble macros with any
1175 1175 lines from your input history in any order.
1176 1176
1177 1177 The macro is a simple object which holds its value in an attribute,
1178 1178 but IPython's display system checks for macros and executes them as
1179 1179 code instead of printing them when you type their name.
1180 1180
1181 1181 You can view a macro's contents by explicitly printing it with::
1182 1182
1183 1183 print macro_name
1184 1184
1185 1185 """
1186 1186 opts,args = self.parse_options(parameter_s,'rq',mode='list')
1187 1187 if not args: # List existing macros
1188 1188 return sorted(k for k,v in self.shell.user_ns.iteritems() if\
1189 1189 isinstance(v, Macro))
1190 1190 if len(args) == 1:
1191 1191 raise UsageError(
1192 1192 "%macro insufficient args; usage '%macro name n1-n2 n3-4...")
1193 1193 name, codefrom = args[0], " ".join(args[1:])
1194 1194
1195 1195 #print 'rng',ranges # dbg
1196 1196 try:
1197 1197 lines = self.shell.find_user_code(codefrom, 'r' in opts)
1198 1198 except (ValueError, TypeError) as e:
1199 1199 print(e.args[0])
1200 1200 return
1201 1201 macro = Macro(lines)
1202 1202 self.shell.define_macro(name, macro)
1203 1203 if not ( 'q' in opts) :
1204 1204 print('Macro `%s` created. To execute, type its name (without quotes).' % name)
1205 1205 print('=== Macro contents: ===')
1206 1206 print(macro, end=' ')
1207 1207
1208 1208 @magic_arguments.magic_arguments()
1209 1209 @magic_arguments.argument('output', type=str, default='', nargs='?',
1210 1210 help="""The name of the variable in which to store output.
1211 1211 This is a utils.io.CapturedIO object with stdout/err attributes
1212 1212 for the text of the captured output.
1213 1213
1214 1214 CapturedOutput also has a show() method for displaying the output,
1215 1215 and __call__ as well, so you can use that to quickly display the
1216 1216 output.
1217 1217
1218 1218 If unspecified, captured output is discarded.
1219 1219 """
1220 1220 )
1221 1221 @magic_arguments.argument('--no-stderr', action="store_true",
1222 1222 help="""Don't capture stderr."""
1223 1223 )
1224 1224 @magic_arguments.argument('--no-stdout', action="store_true",
1225 1225 help="""Don't capture stdout."""
1226 1226 )
1227 1227 @magic_arguments.argument('--no-display', action="store_true",
1228 1228 help="""Don't capture IPython's rich display."""
1229 1229 )
1230 1230 @cell_magic
1231 1231 def capture(self, line, cell):
1232 1232 """run the cell, capturing stdout, stderr, and IPython's rich display() calls."""
1233 1233 args = magic_arguments.parse_argstring(self.capture, line)
1234 1234 out = not args.no_stdout
1235 1235 err = not args.no_stderr
1236 1236 disp = not args.no_display
1237 1237 with capture_output(out, err, disp) as io:
1238 1238 self.shell.run_cell(cell)
1239 1239 if args.output:
1240 1240 self.shell.user_ns[args.output] = io
1241 1241
1242 1242 def parse_breakpoint(text, current_file):
1243 1243 '''Returns (file, line) for file:line and (current_file, line) for line'''
1244 1244 colon = text.find(':')
1245 1245 if colon == -1:
1246 1246 return current_file, int(text)
1247 1247 else:
1248 1248 return text[:colon], int(text[colon+1:])
1249 1249
1250 1250 def _format_time(timespan, precision=3):
1251 1251 """Formats the timespan in a human readable form"""
1252 1252 import math
1253 1253
1254 1254 if timespan >= 60.0:
1255 1255 # we have more than a minute, format that in a human readable form
1256 1256 # Idea from http://snipplr.com/view/5713/
1257 1257 parts = [("d", 60*60*24),("h", 60*60),("min", 60), ("s", 1)]
1258 1258 time = []
1259 1259 leftover = timespan
1260 1260 for suffix, length in parts:
1261 1261 value = int(leftover / length)
1262 1262 if value > 0:
1263 1263 leftover = leftover % length
1264 1264 time.append(u'%s%s' % (str(value), suffix))
1265 1265 if leftover < 1:
1266 1266 break
1267 1267 return " ".join(time)
1268 1268
1269 1269
1270 1270 # Unfortunately the unicode 'micro' symbol can cause problems in
1271 1271 # certain terminals.
1272 1272 # See bug: https://bugs.launchpad.net/ipython/+bug/348466
1273 1273 # Try to prevent crashes by being more secure than it needs to
1274 1274 # E.g. eclipse is able to print a µ, but has no sys.stdout.encoding set.
1275 1275 units = [u"s", u"ms",u'us',"ns"] # the save value
1276 1276 if hasattr(sys.stdout, 'encoding') and sys.stdout.encoding:
1277 1277 try:
1278 1278 u'\xb5'.encode(sys.stdout.encoding)
1279 1279 units = [u"s", u"ms",u'\xb5s',"ns"]
1280 1280 except:
1281 1281 pass
1282 1282 scaling = [1, 1e3, 1e6, 1e9]
1283 1283
1284 1284 if timespan > 0.0:
1285 1285 order = min(-int(math.floor(math.log10(timespan)) // 3), 3)
1286 1286 else:
1287 1287 order = 3
1288 1288 return u"%.*g %s" % (precision, timespan * scaling[order], units[order])
@@ -1,340 +1,340 b''
1 1 # -*- coding: utf-8 -*-
2 2 """Pylab (matplotlib) support utilities.
3 3
4 4 Authors
5 5 -------
6 6
7 7 * Fernando Perez.
8 8 * Brian Granger
9 9 """
10 10 from __future__ import print_function
11 11
12 12 #-----------------------------------------------------------------------------
13 13 # Copyright (C) 2009 The IPython Development Team
14 14 #
15 15 # Distributed under the terms of the BSD License. The full license is in
16 16 # the file COPYING, distributed as part of this software.
17 17 #-----------------------------------------------------------------------------
18 18
19 19 #-----------------------------------------------------------------------------
20 20 # Imports
21 21 #-----------------------------------------------------------------------------
22 22
23 23 import sys
24 24 from io import BytesIO
25 25
26 26 from IPython.core.display import _pngxy
27 27 from IPython.utils.decorators import flag_calls
28 28
29 29 # If user specifies a GUI, that dictates the backend, otherwise we read the
30 30 # user's mpl default from the mpl rc structure
31 31 backends = {'tk': 'TkAgg',
32 32 'gtk': 'GTKAgg',
33 33 'wx': 'WXAgg',
34 34 'qt': 'Qt4Agg', # qt3 not supported
35 35 'qt4': 'Qt4Agg',
36 36 'osx': 'MacOSX',
37 37 'inline' : 'module://IPython.kernel.zmq.pylab.backend_inline'}
38 38
39 39 # We also need a reverse backends2guis mapping that will properly choose which
40 40 # GUI support to activate based on the desired matplotlib backend. For the
41 41 # most part it's just a reverse of the above dict, but we also need to add a
42 42 # few others that map to the same GUI manually:
43 43 backend2gui = dict(zip(backends.values(), backends.keys()))
44 44 # Our tests expect backend2gui to just return 'qt'
45 45 backend2gui['Qt4Agg'] = 'qt'
46 46 # In the reverse mapping, there are a few extra valid matplotlib backends that
47 47 # map to the same GUI support
48 48 backend2gui['GTK'] = backend2gui['GTKCairo'] = 'gtk'
49 49 backend2gui['WX'] = 'wx'
50 50 backend2gui['CocoaAgg'] = 'osx'
51 51
52 52 #-----------------------------------------------------------------------------
53 53 # Matplotlib utilities
54 54 #-----------------------------------------------------------------------------
55 55
56 56
57 57 def getfigs(*fig_nums):
58 58 """Get a list of matplotlib figures by figure numbers.
59 59
60 60 If no arguments are given, all available figures are returned. If the
61 61 argument list contains references to invalid figures, a warning is printed
62 62 but the function continues pasting further figures.
63 63
64 64 Parameters
65 65 ----------
66 66 figs : tuple
67 67 A tuple of ints giving the figure numbers of the figures to return.
68 68 """
69 69 from matplotlib._pylab_helpers import Gcf
70 70 if not fig_nums:
71 71 fig_managers = Gcf.get_all_fig_managers()
72 72 return [fm.canvas.figure for fm in fig_managers]
73 73 else:
74 74 figs = []
75 75 for num in fig_nums:
76 76 f = Gcf.figs.get(num)
77 77 if f is None:
78 78 print(('Warning: figure %s not available.' % num))
79 79 else:
80 80 figs.append(f.canvas.figure)
81 81 return figs
82 82
83 83
84 84 def figsize(sizex, sizey):
85 85 """Set the default figure size to be [sizex, sizey].
86 86
87 87 This is just an easy to remember, convenience wrapper that sets::
88 88
89 89 matplotlib.rcParams['figure.figsize'] = [sizex, sizey]
90 90 """
91 91 import matplotlib
92 92 matplotlib.rcParams['figure.figsize'] = [sizex, sizey]
93 93
94 94
95 95 def print_figure(fig, fmt='png'):
96 96 """Convert a figure to svg or png for inline display."""
97 97 from matplotlib import rcParams
98 98 # When there's an empty figure, we shouldn't return anything, otherwise we
99 99 # get big blank areas in the qt console.
100 100 if not fig.axes and not fig.lines:
101 101 return
102 102
103 103 fc = fig.get_facecolor()
104 104 ec = fig.get_edgecolor()
105 105 bytes_io = BytesIO()
106 106 dpi = rcParams['savefig.dpi']
107 107 if fmt == 'retina':
108 108 dpi = dpi * 2
109 109 fmt = 'png'
110 110 fig.canvas.print_figure(bytes_io, format=fmt, bbox_inches='tight',
111 111 facecolor=fc, edgecolor=ec, dpi=dpi)
112 112 data = bytes_io.getvalue()
113 113 return data
114 114
115 115 def retina_figure(fig):
116 116 """format a figure as a pixel-doubled (retina) PNG"""
117 117 pngdata = print_figure(fig, fmt='retina')
118 118 w, h = _pngxy(pngdata)
119 119 metadata = dict(width=w//2, height=h//2)
120 120 return pngdata, metadata
121 121
122 122 # We need a little factory function here to create the closure where
123 123 # safe_execfile can live.
124 124 def mpl_runner(safe_execfile):
125 125 """Factory to return a matplotlib-enabled runner for %run.
126 126
127 127 Parameters
128 128 ----------
129 129 safe_execfile : function
130 130 This must be a function with the same interface as the
131 131 :meth:`safe_execfile` method of IPython.
132 132
133 133 Returns
134 134 -------
135 135 A function suitable for use as the ``runner`` argument of the %run magic
136 136 function.
137 137 """
138 138
139 139 def mpl_execfile(fname,*where,**kw):
140 140 """matplotlib-aware wrapper around safe_execfile.
141 141
142 142 Its interface is identical to that of the :func:`execfile` builtin.
143 143
144 144 This is ultimately a call to execfile(), but wrapped in safeties to
145 145 properly handle interactive rendering."""
146 146
147 147 import matplotlib
148 148 import matplotlib.pylab as pylab
149 149
150 150 #print '*** Matplotlib runner ***' # dbg
151 151 # turn off rendering until end of script
152 152 is_interactive = matplotlib.rcParams['interactive']
153 153 matplotlib.interactive(False)
154 154 safe_execfile(fname,*where,**kw)
155 155 matplotlib.interactive(is_interactive)
156 156 # make rendering call now, if the user tried to do it
157 157 if pylab.draw_if_interactive.called:
158 158 pylab.draw()
159 159 pylab.draw_if_interactive.called = False
160 160
161 161 return mpl_execfile
162 162
163 163
164 164 def select_figure_format(shell, fmt):
165 165 """Select figure format for inline backend, can be 'png', 'retina', or 'svg'.
166 166
167 167 Using this method ensures only one figure format is active at a time.
168 168 """
169 169 from matplotlib.figure import Figure
170 170 from IPython.kernel.zmq.pylab import backend_inline
171 171
172 172 svg_formatter = shell.display_formatter.formatters['image/svg+xml']
173 173 png_formatter = shell.display_formatter.formatters['image/png']
174 174
175 175 if fmt == 'png':
176 176 svg_formatter.type_printers.pop(Figure, None)
177 177 png_formatter.for_type(Figure, lambda fig: print_figure(fig, 'png'))
178 178 elif fmt in ('png2x', 'retina'):
179 179 svg_formatter.type_printers.pop(Figure, None)
180 180 png_formatter.for_type(Figure, retina_figure)
181 181 elif fmt == 'svg':
182 182 png_formatter.type_printers.pop(Figure, None)
183 183 svg_formatter.for_type(Figure, lambda fig: print_figure(fig, 'svg'))
184 184 else:
185 185 raise ValueError("supported formats are: 'png', 'retina', 'svg', not %r" % fmt)
186 186
187 187 # set the format to be used in the backend()
188 188 backend_inline._figure_format = fmt
189 189
190 190 #-----------------------------------------------------------------------------
191 191 # Code for initializing matplotlib and importing pylab
192 192 #-----------------------------------------------------------------------------
193 193
194 194
195 195 def find_gui_and_backend(gui=None, gui_select=None):
196 196 """Given a gui string return the gui and mpl backend.
197 197
198 198 Parameters
199 199 ----------
200 200 gui : str
201 201 Can be one of ('tk','gtk','wx','qt','qt4','inline').
202 202 gui_select : str
203 203 Can be one of ('tk','gtk','wx','qt','qt4','inline').
204 204 This is any gui already selected by the shell.
205 205
206 206 Returns
207 207 -------
208 208 A tuple of (gui, backend) where backend is one of ('TkAgg','GTKAgg',
209 209 'WXAgg','Qt4Agg','module://IPython.kernel.zmq.pylab.backend_inline').
210 210 """
211 211
212 212 import matplotlib
213 213
214 214 if gui and gui != 'auto':
215 215 # select backend based on requested gui
216 216 backend = backends[gui]
217 217 else:
218 218 # We need to read the backend from the original data structure, *not*
219 219 # from mpl.rcParams, since a prior invocation of %matplotlib may have
220 220 # overwritten that.
221 221 # WARNING: this assumes matplotlib 1.1 or newer!!
222 222 backend = matplotlib.rcParamsOrig['backend']
223 223 # In this case, we need to find what the appropriate gui selection call
224 224 # should be for IPython, so we can activate inputhook accordingly
225 225 gui = backend2gui.get(backend, None)
226 226
227 227 # If we have already had a gui active, we need it and inline are the
228 228 # ones allowed.
229 229 if gui_select and gui != gui_select:
230 230 gui = gui_select
231 231 backend = backends[gui]
232 232
233 233 return gui, backend
234 234
235 235
236 236 def activate_matplotlib(backend):
237 237 """Activate the given backend and set interactive to True."""
238 238
239 239 import matplotlib
240 240 matplotlib.interactive(True)
241 241
242 242 # Matplotlib had a bug where even switch_backend could not force
243 243 # the rcParam to update. This needs to be set *before* the module
244 244 # magic of switch_backend().
245 245 matplotlib.rcParams['backend'] = backend
246 246
247 247 import matplotlib.pyplot
248 248 matplotlib.pyplot.switch_backend(backend)
249 249
250 250 # This must be imported last in the matplotlib series, after
251 251 # backend/interactivity choices have been made
252 252 import matplotlib.pylab as pylab
253 253
254 254 pylab.show._needmain = False
255 255 # We need to detect at runtime whether show() is called by the user.
256 256 # For this, we wrap it into a decorator which adds a 'called' flag.
257 257 pylab.draw_if_interactive = flag_calls(pylab.draw_if_interactive)
258 258
259 259
260 260 def import_pylab(user_ns, import_all=True):
261 261 """Populate the namespace with pylab-related values.
262 262
263 263 Imports matplotlib, pylab, numpy, and everything from pylab and numpy.
264 264
265 265 Also imports a few names from IPython (figsize, display, getfigs)
266 266
267 267 """
268 268
269 269 # Import numpy as np/pyplot as plt are conventions we're trying to
270 270 # somewhat standardize on. Making them available to users by default
271 271 # will greatly help this.
272 272 s = ("import numpy\n"
273 273 "import matplotlib\n"
274 274 "from matplotlib import pylab, mlab, pyplot\n"
275 275 "np = numpy\n"
276 276 "plt = pyplot\n"
277 277 )
278 exec s in user_ns
278 exec(s, user_ns)
279 279
280 280 if import_all:
281 281 s = ("from matplotlib.pylab import *\n"
282 282 "from numpy import *\n")
283 exec s in user_ns
283 exec(s, user_ns)
284 284
285 285 # IPython symbols to add
286 286 user_ns['figsize'] = figsize
287 287 from IPython.core.display import display
288 288 # Add display and getfigs to the user's namespace
289 289 user_ns['display'] = display
290 290 user_ns['getfigs'] = getfigs
291 291
292 292
293 293 def configure_inline_support(shell, backend):
294 294 """Configure an IPython shell object for matplotlib use.
295 295
296 296 Parameters
297 297 ----------
298 298 shell : InteractiveShell instance
299 299
300 300 backend : matplotlib backend
301 301 """
302 302 # If using our svg payload backend, register the post-execution
303 303 # function that will pick up the results for display. This can only be
304 304 # done with access to the real shell object.
305 305
306 306 # Note: if we can't load the inline backend, then there's no point
307 307 # continuing (such as in terminal-only shells in environments without
308 308 # zeromq available).
309 309 try:
310 310 from IPython.kernel.zmq.pylab.backend_inline import InlineBackend
311 311 except ImportError:
312 312 return
313 313 from matplotlib import pyplot
314 314
315 315 cfg = InlineBackend.instance(parent=shell)
316 316 cfg.shell = shell
317 317 if cfg not in shell.configurables:
318 318 shell.configurables.append(cfg)
319 319
320 320 if backend == backends['inline']:
321 321 from IPython.kernel.zmq.pylab.backend_inline import flush_figures
322 322 shell.register_post_execute(flush_figures)
323 323
324 324 # Save rcParams that will be overwrittern
325 325 shell._saved_rcParams = dict()
326 326 for k in cfg.rc:
327 327 shell._saved_rcParams[k] = pyplot.rcParams[k]
328 328 # load inline_rc
329 329 pyplot.rcParams.update(cfg.rc)
330 330 else:
331 331 from IPython.kernel.zmq.pylab.backend_inline import flush_figures
332 332 if flush_figures in shell._post_execute:
333 333 shell._post_execute.pop(flush_figures)
334 334 if hasattr(shell, '_saved_rcParams'):
335 335 pyplot.rcParams.update(shell._saved_rcParams)
336 336 del shell._saved_rcParams
337 337
338 338 # Setup the default figure format
339 339 select_figure_format(shell, cfg.figure_format)
340 340
@@ -1,583 +1,583 b''
1 1 # -*- coding: utf-8 -*-
2 2 """Tests for the inputsplitter module.
3 3
4 4 Authors
5 5 -------
6 6 * Fernando Perez
7 7 * Robert Kern
8 8 """
9 9 from __future__ import print_function
10 10 #-----------------------------------------------------------------------------
11 11 # Copyright (C) 2010-2011 The IPython Development Team
12 12 #
13 13 # Distributed under the terms of the BSD License. The full license is in
14 14 # the file COPYING, distributed as part of this software.
15 15 #-----------------------------------------------------------------------------
16 16
17 17 #-----------------------------------------------------------------------------
18 18 # Imports
19 19 #-----------------------------------------------------------------------------
20 20 # stdlib
21 21 import unittest
22 22 import sys
23 23
24 24 # Third party
25 25 import nose.tools as nt
26 26
27 27 # Our own
28 28 from IPython.core import inputsplitter as isp
29 29 from IPython.core.tests.test_inputtransformer import syntax, syntax_ml
30 30 from IPython.testing import tools as tt
31 31 from IPython.utils import py3compat
32 32
33 33 #-----------------------------------------------------------------------------
34 34 # Semi-complete examples (also used as tests)
35 35 #-----------------------------------------------------------------------------
36 36
37 37 # Note: at the bottom, there's a slightly more complete version of this that
38 38 # can be useful during development of code here.
39 39
40 40 def mini_interactive_loop(input_func):
41 41 """Minimal example of the logic of an interactive interpreter loop.
42 42
43 43 This serves as an example, and it is used by the test system with a fake
44 44 raw_input that simulates interactive input."""
45 45
46 46 from IPython.core.inputsplitter import InputSplitter
47 47
48 48 isp = InputSplitter()
49 49 # In practice, this input loop would be wrapped in an outside loop to read
50 50 # input indefinitely, until some exit/quit command was issued. Here we
51 51 # only illustrate the basic inner loop.
52 52 while isp.push_accepts_more():
53 53 indent = ' '*isp.indent_spaces
54 54 prompt = '>>> ' + indent
55 55 line = indent + input_func(prompt)
56 56 isp.push(line)
57 57
58 58 # Here we just return input so we can use it in a test suite, but a real
59 59 # interpreter would instead send it for execution somewhere.
60 60 src = isp.source_reset()
61 61 #print 'Input source was:\n', src # dbg
62 62 return src
63 63
64 64 #-----------------------------------------------------------------------------
65 65 # Test utilities, just for local use
66 66 #-----------------------------------------------------------------------------
67 67
68 68 def assemble(block):
69 69 """Assemble a block into multi-line sub-blocks."""
70 70 return ['\n'.join(sub_block)+'\n' for sub_block in block]
71 71
72 72
73 73 def pseudo_input(lines):
74 74 """Return a function that acts like raw_input but feeds the input list."""
75 75 ilines = iter(lines)
76 76 def raw_in(prompt):
77 77 try:
78 78 return next(ilines)
79 79 except StopIteration:
80 80 return ''
81 81 return raw_in
82 82
83 83 #-----------------------------------------------------------------------------
84 84 # Tests
85 85 #-----------------------------------------------------------------------------
86 86 def test_spaces():
87 87 tests = [('', 0),
88 88 (' ', 1),
89 89 ('\n', 0),
90 90 (' \n', 1),
91 91 ('x', 0),
92 92 (' x', 1),
93 93 (' x',2),
94 94 (' x',4),
95 95 # Note: tabs are counted as a single whitespace!
96 96 ('\tx', 1),
97 97 ('\t x', 2),
98 98 ]
99 99 tt.check_pairs(isp.num_ini_spaces, tests)
100 100
101 101
102 102 def test_remove_comments():
103 103 tests = [('text', 'text'),
104 104 ('text # comment', 'text '),
105 105 ('text # comment\n', 'text \n'),
106 106 ('text # comment \n', 'text \n'),
107 107 ('line # c \nline\n','line \nline\n'),
108 108 ('line # c \nline#c2 \nline\nline #c\n\n',
109 109 'line \nline\nline\nline \n\n'),
110 110 ]
111 111 tt.check_pairs(isp.remove_comments, tests)
112 112
113 113
114 114 def test_get_input_encoding():
115 115 encoding = isp.get_input_encoding()
116 116 nt.assert_true(isinstance(encoding, basestring))
117 117 # simple-minded check that at least encoding a simple string works with the
118 118 # encoding we got.
119 119 nt.assert_equal(u'test'.encode(encoding), b'test')
120 120
121 121
122 122 class NoInputEncodingTestCase(unittest.TestCase):
123 123 def setUp(self):
124 124 self.old_stdin = sys.stdin
125 125 class X: pass
126 126 fake_stdin = X()
127 127 sys.stdin = fake_stdin
128 128
129 129 def test(self):
130 130 # Verify that if sys.stdin has no 'encoding' attribute we do the right
131 131 # thing
132 132 enc = isp.get_input_encoding()
133 133 self.assertEqual(enc, 'ascii')
134 134
135 135 def tearDown(self):
136 136 sys.stdin = self.old_stdin
137 137
138 138
139 139 class InputSplitterTestCase(unittest.TestCase):
140 140 def setUp(self):
141 141 self.isp = isp.InputSplitter()
142 142
143 143 def test_reset(self):
144 144 isp = self.isp
145 145 isp.push('x=1')
146 146 isp.reset()
147 147 self.assertEqual(isp._buffer, [])
148 148 self.assertEqual(isp.indent_spaces, 0)
149 149 self.assertEqual(isp.source, '')
150 150 self.assertEqual(isp.code, None)
151 151 self.assertEqual(isp._is_complete, False)
152 152
153 153 def test_source(self):
154 154 self.isp._store('1')
155 155 self.isp._store('2')
156 156 self.assertEqual(self.isp.source, '1\n2\n')
157 157 self.assertTrue(len(self.isp._buffer)>0)
158 158 self.assertEqual(self.isp.source_reset(), '1\n2\n')
159 159 self.assertEqual(self.isp._buffer, [])
160 160 self.assertEqual(self.isp.source, '')
161 161
162 162 def test_indent(self):
163 163 isp = self.isp # shorthand
164 164 isp.push('x=1')
165 165 self.assertEqual(isp.indent_spaces, 0)
166 166 isp.push('if 1:\n x=1')
167 167 self.assertEqual(isp.indent_spaces, 4)
168 168 isp.push('y=2\n')
169 169 self.assertEqual(isp.indent_spaces, 0)
170 170
171 171 def test_indent2(self):
172 172 isp = self.isp
173 173 isp.push('if 1:')
174 174 self.assertEqual(isp.indent_spaces, 4)
175 175 isp.push(' x=1')
176 176 self.assertEqual(isp.indent_spaces, 4)
177 177 # Blank lines shouldn't change the indent level
178 178 isp.push(' '*2)
179 179 self.assertEqual(isp.indent_spaces, 4)
180 180
181 181 def test_indent3(self):
182 182 isp = self.isp
183 183 # When a multiline statement contains parens or multiline strings, we
184 184 # shouldn't get confused.
185 185 isp.push("if 1:")
186 186 isp.push(" x = (1+\n 2)")
187 187 self.assertEqual(isp.indent_spaces, 4)
188 188
189 189 def test_indent4(self):
190 190 isp = self.isp
191 191 # whitespace after ':' should not screw up indent level
192 192 isp.push('if 1: \n x=1')
193 193 self.assertEqual(isp.indent_spaces, 4)
194 194 isp.push('y=2\n')
195 195 self.assertEqual(isp.indent_spaces, 0)
196 196 isp.push('if 1:\t\n x=1')
197 197 self.assertEqual(isp.indent_spaces, 4)
198 198 isp.push('y=2\n')
199 199 self.assertEqual(isp.indent_spaces, 0)
200 200
201 201 def test_dedent_pass(self):
202 202 isp = self.isp # shorthand
203 203 # should NOT cause dedent
204 204 isp.push('if 1:\n passes = 5')
205 205 self.assertEqual(isp.indent_spaces, 4)
206 206 isp.push('if 1:\n pass')
207 207 self.assertEqual(isp.indent_spaces, 0)
208 208 isp.push('if 1:\n pass ')
209 209 self.assertEqual(isp.indent_spaces, 0)
210 210
211 211 def test_dedent_break(self):
212 212 isp = self.isp # shorthand
213 213 # should NOT cause dedent
214 214 isp.push('while 1:\n breaks = 5')
215 215 self.assertEqual(isp.indent_spaces, 4)
216 216 isp.push('while 1:\n break')
217 217 self.assertEqual(isp.indent_spaces, 0)
218 218 isp.push('while 1:\n break ')
219 219 self.assertEqual(isp.indent_spaces, 0)
220 220
221 221 def test_dedent_continue(self):
222 222 isp = self.isp # shorthand
223 223 # should NOT cause dedent
224 224 isp.push('while 1:\n continues = 5')
225 225 self.assertEqual(isp.indent_spaces, 4)
226 226 isp.push('while 1:\n continue')
227 227 self.assertEqual(isp.indent_spaces, 0)
228 228 isp.push('while 1:\n continue ')
229 229 self.assertEqual(isp.indent_spaces, 0)
230 230
231 231 def test_dedent_raise(self):
232 232 isp = self.isp # shorthand
233 233 # should NOT cause dedent
234 234 isp.push('if 1:\n raised = 4')
235 235 self.assertEqual(isp.indent_spaces, 4)
236 236 isp.push('if 1:\n raise TypeError()')
237 237 self.assertEqual(isp.indent_spaces, 0)
238 238 isp.push('if 1:\n raise')
239 239 self.assertEqual(isp.indent_spaces, 0)
240 240 isp.push('if 1:\n raise ')
241 241 self.assertEqual(isp.indent_spaces, 0)
242 242
243 243 def test_dedent_return(self):
244 244 isp = self.isp # shorthand
245 245 # should NOT cause dedent
246 246 isp.push('if 1:\n returning = 4')
247 247 self.assertEqual(isp.indent_spaces, 4)
248 248 isp.push('if 1:\n return 5 + 493')
249 249 self.assertEqual(isp.indent_spaces, 0)
250 250 isp.push('if 1:\n return')
251 251 self.assertEqual(isp.indent_spaces, 0)
252 252 isp.push('if 1:\n return ')
253 253 self.assertEqual(isp.indent_spaces, 0)
254 254 isp.push('if 1:\n return(0)')
255 255 self.assertEqual(isp.indent_spaces, 0)
256 256
257 257 def test_push(self):
258 258 isp = self.isp
259 259 self.assertTrue(isp.push('x=1'))
260 260
261 261 def test_push2(self):
262 262 isp = self.isp
263 263 self.assertFalse(isp.push('if 1:'))
264 264 for line in [' x=1', '# a comment', ' y=2']:
265 265 print(line)
266 266 self.assertTrue(isp.push(line))
267 267
268 268 def test_push3(self):
269 269 isp = self.isp
270 270 isp.push('if True:')
271 271 isp.push(' a = 1')
272 272 self.assertFalse(isp.push('b = [1,'))
273 273
274 274 def test_push_accepts_more(self):
275 275 isp = self.isp
276 276 isp.push('x=1')
277 277 self.assertFalse(isp.push_accepts_more())
278 278
279 279 def test_push_accepts_more2(self):
280 280 isp = self.isp
281 281 isp.push('if 1:')
282 282 self.assertTrue(isp.push_accepts_more())
283 283 isp.push(' x=1')
284 284 self.assertTrue(isp.push_accepts_more())
285 285 isp.push('')
286 286 self.assertFalse(isp.push_accepts_more())
287 287
288 288 def test_push_accepts_more3(self):
289 289 isp = self.isp
290 290 isp.push("x = (2+\n3)")
291 291 self.assertFalse(isp.push_accepts_more())
292 292
293 293 def test_push_accepts_more4(self):
294 294 isp = self.isp
295 295 # When a multiline statement contains parens or multiline strings, we
296 296 # shouldn't get confused.
297 297 # FIXME: we should be able to better handle de-dents in statements like
298 298 # multiline strings and multiline expressions (continued with \ or
299 299 # parens). Right now we aren't handling the indentation tracking quite
300 300 # correctly with this, though in practice it may not be too much of a
301 301 # problem. We'll need to see.
302 302 isp.push("if 1:")
303 303 isp.push(" x = (2+")
304 304 isp.push(" 3)")
305 305 self.assertTrue(isp.push_accepts_more())
306 306 isp.push(" y = 3")
307 307 self.assertTrue(isp.push_accepts_more())
308 308 isp.push('')
309 309 self.assertFalse(isp.push_accepts_more())
310 310
311 311 def test_push_accepts_more5(self):
312 312 isp = self.isp
313 313 isp.push('try:')
314 314 isp.push(' a = 5')
315 315 isp.push('except:')
316 316 isp.push(' raise')
317 317 # We want to be able to add an else: block at this point, so it should
318 318 # wait for a blank line.
319 319 self.assertTrue(isp.push_accepts_more())
320 320
321 321 def test_continuation(self):
322 322 isp = self.isp
323 323 isp.push("import os, \\")
324 324 self.assertTrue(isp.push_accepts_more())
325 325 isp.push("sys")
326 326 self.assertFalse(isp.push_accepts_more())
327 327
328 328 def test_syntax_error(self):
329 329 isp = self.isp
330 330 # Syntax errors immediately produce a 'ready' block, so the invalid
331 331 # Python can be sent to the kernel for evaluation with possible ipython
332 332 # special-syntax conversion.
333 333 isp.push('run foo')
334 334 self.assertFalse(isp.push_accepts_more())
335 335
336 336 def test_unicode(self):
337 337 self.isp.push(u"Pérez")
338 338 self.isp.push(u'\xc3\xa9')
339 339 self.isp.push(u"u'\xc3\xa9'")
340 340
341 341 def test_line_continuation(self):
342 342 """ Test issue #2108."""
343 343 isp = self.isp
344 344 # A blank line after a line continuation should not accept more
345 345 isp.push("1 \\\n\n")
346 346 self.assertFalse(isp.push_accepts_more())
347 347 # Whitespace after a \ is a SyntaxError. The only way to test that
348 348 # here is to test that push doesn't accept more (as with
349 349 # test_syntax_error() above).
350 350 isp.push(r"1 \ ")
351 351 self.assertFalse(isp.push_accepts_more())
352 352 # Even if the line is continuable (c.f. the regular Python
353 353 # interpreter)
354 354 isp.push(r"(1 \ ")
355 355 self.assertFalse(isp.push_accepts_more())
356 356
357 357 class InteractiveLoopTestCase(unittest.TestCase):
358 358 """Tests for an interactive loop like a python shell.
359 359 """
360 360 def check_ns(self, lines, ns):
361 361 """Validate that the given input lines produce the resulting namespace.
362 362
363 363 Note: the input lines are given exactly as they would be typed in an
364 364 auto-indenting environment, as mini_interactive_loop above already does
365 365 auto-indenting and prepends spaces to the input.
366 366 """
367 367 src = mini_interactive_loop(pseudo_input(lines))
368 368 test_ns = {}
369 exec src in test_ns
369 exec(src, test_ns)
370 370 # We can't check that the provided ns is identical to the test_ns,
371 371 # because Python fills test_ns with extra keys (copyright, etc). But
372 372 # we can check that the given dict is *contained* in test_ns
373 373 for k,v in ns.iteritems():
374 374 self.assertEqual(test_ns[k], v)
375 375
376 376 def test_simple(self):
377 377 self.check_ns(['x=1'], dict(x=1))
378 378
379 379 def test_simple2(self):
380 380 self.check_ns(['if 1:', 'x=2'], dict(x=2))
381 381
382 382 def test_xy(self):
383 383 self.check_ns(['x=1; y=2'], dict(x=1, y=2))
384 384
385 385 def test_abc(self):
386 386 self.check_ns(['if 1:','a=1','b=2','c=3'], dict(a=1, b=2, c=3))
387 387
388 388 def test_multi(self):
389 389 self.check_ns(['x =(1+','1+','2)'], dict(x=4))
390 390
391 391
392 392 class IPythonInputTestCase(InputSplitterTestCase):
393 393 """By just creating a new class whose .isp is a different instance, we
394 394 re-run the same test battery on the new input splitter.
395 395
396 396 In addition, this runs the tests over the syntax and syntax_ml dicts that
397 397 were tested by individual functions, as part of the OO interface.
398 398
399 399 It also makes some checks on the raw buffer storage.
400 400 """
401 401
402 402 def setUp(self):
403 403 self.isp = isp.IPythonInputSplitter()
404 404
405 405 def test_syntax(self):
406 406 """Call all single-line syntax tests from the main object"""
407 407 isp = self.isp
408 408 for example in syntax.itervalues():
409 409 for raw, out_t in example:
410 410 if raw.startswith(' '):
411 411 continue
412 412
413 413 isp.push(raw+'\n')
414 414 out, out_raw = isp.source_raw_reset()
415 415 self.assertEqual(out.rstrip(), out_t,
416 416 tt.pair_fail_msg.format("inputsplitter",raw, out_t, out))
417 417 self.assertEqual(out_raw.rstrip(), raw.rstrip())
418 418
419 419 def test_syntax_multiline(self):
420 420 isp = self.isp
421 421 for example in syntax_ml.itervalues():
422 422 for line_pairs in example:
423 423 out_t_parts = []
424 424 raw_parts = []
425 425 for lraw, out_t_part in line_pairs:
426 426 if out_t_part is not None:
427 427 out_t_parts.append(out_t_part)
428 428
429 429 if lraw is not None:
430 430 isp.push(lraw)
431 431 raw_parts.append(lraw)
432 432
433 433 out, out_raw = isp.source_raw_reset()
434 434 out_t = '\n'.join(out_t_parts).rstrip()
435 435 raw = '\n'.join(raw_parts).rstrip()
436 436 self.assertEqual(out.rstrip(), out_t)
437 437 self.assertEqual(out_raw.rstrip(), raw)
438 438
439 439 def test_syntax_multiline_cell(self):
440 440 isp = self.isp
441 441 for example in syntax_ml.itervalues():
442 442
443 443 out_t_parts = []
444 444 for line_pairs in example:
445 445 raw = '\n'.join(r for r, _ in line_pairs if r is not None)
446 446 out_t = '\n'.join(t for _,t in line_pairs if t is not None)
447 447 out = isp.transform_cell(raw)
448 448 # Match ignoring trailing whitespace
449 449 self.assertEqual(out.rstrip(), out_t.rstrip())
450 450
451 451 def test_cellmagic_preempt(self):
452 452 isp = self.isp
453 453 for raw, name, line, cell in [
454 454 ("%%cellm a\nIn[1]:", u'cellm', u'a', u'In[1]:'),
455 455 ("%%cellm \nline\n>>>hi", u'cellm', u'', u'line\n>>>hi'),
456 456 (">>>%%cellm \nline\n>>>hi", u'cellm', u'', u'line\nhi'),
457 457 ("%%cellm \n>>>hi", u'cellm', u'', u'hi'),
458 458 ("%%cellm \nline1\nline2", u'cellm', u'', u'line1\nline2'),
459 459 ("%%cellm \nline1\\\\\nline2", u'cellm', u'', u'line1\\\\\nline2'),
460 460 ]:
461 461 expected = "get_ipython().run_cell_magic(%r, %r, %r)" % (
462 462 name, line, cell
463 463 )
464 464 out = isp.transform_cell(raw)
465 465 self.assertEqual(out.rstrip(), expected.rstrip())
466 466
467 467
468 468
469 469 #-----------------------------------------------------------------------------
470 470 # Main - use as a script, mostly for developer experiments
471 471 #-----------------------------------------------------------------------------
472 472
473 473 if __name__ == '__main__':
474 474 # A simple demo for interactive experimentation. This code will not get
475 475 # picked up by any test suite.
476 476 from IPython.core.inputsplitter import InputSplitter, IPythonInputSplitter
477 477
478 478 # configure here the syntax to use, prompt and whether to autoindent
479 479 #isp, start_prompt = InputSplitter(), '>>> '
480 480 isp, start_prompt = IPythonInputSplitter(), 'In> '
481 481
482 482 autoindent = True
483 483 #autoindent = False
484 484
485 485 try:
486 486 while True:
487 487 prompt = start_prompt
488 488 while isp.push_accepts_more():
489 489 indent = ' '*isp.indent_spaces
490 490 if autoindent:
491 491 line = indent + raw_input(prompt+indent)
492 492 else:
493 493 line = raw_input(prompt)
494 494 isp.push(line)
495 495 prompt = '... '
496 496
497 497 # Here we just return input so we can use it in a test suite, but a
498 498 # real interpreter would instead send it for execution somewhere.
499 499 #src = isp.source; raise EOFError # dbg
500 500 src, raw = isp.source_raw_reset()
501 501 print('Input source was:\n', src)
502 502 print('Raw source was:\n', raw)
503 503 except EOFError:
504 504 print('Bye')
505 505
506 506 # Tests for cell magics support
507 507
508 508 def test_last_blank():
509 509 nt.assert_false(isp.last_blank(''))
510 510 nt.assert_false(isp.last_blank('abc'))
511 511 nt.assert_false(isp.last_blank('abc\n'))
512 512 nt.assert_false(isp.last_blank('abc\na'))
513 513
514 514 nt.assert_true(isp.last_blank('\n'))
515 515 nt.assert_true(isp.last_blank('\n '))
516 516 nt.assert_true(isp.last_blank('abc\n '))
517 517 nt.assert_true(isp.last_blank('abc\n\n'))
518 518 nt.assert_true(isp.last_blank('abc\nd\n\n'))
519 519 nt.assert_true(isp.last_blank('abc\nd\ne\n\n'))
520 520 nt.assert_true(isp.last_blank('abc \n \n \n\n'))
521 521
522 522
523 523 def test_last_two_blanks():
524 524 nt.assert_false(isp.last_two_blanks(''))
525 525 nt.assert_false(isp.last_two_blanks('abc'))
526 526 nt.assert_false(isp.last_two_blanks('abc\n'))
527 527 nt.assert_false(isp.last_two_blanks('abc\n\na'))
528 528 nt.assert_false(isp.last_two_blanks('abc\n \n'))
529 529 nt.assert_false(isp.last_two_blanks('abc\n\n'))
530 530
531 531 nt.assert_true(isp.last_two_blanks('\n\n'))
532 532 nt.assert_true(isp.last_two_blanks('\n\n '))
533 533 nt.assert_true(isp.last_two_blanks('\n \n'))
534 534 nt.assert_true(isp.last_two_blanks('abc\n\n '))
535 535 nt.assert_true(isp.last_two_blanks('abc\n\n\n'))
536 536 nt.assert_true(isp.last_two_blanks('abc\n\n \n'))
537 537 nt.assert_true(isp.last_two_blanks('abc\n\n \n '))
538 538 nt.assert_true(isp.last_two_blanks('abc\n\n \n \n'))
539 539 nt.assert_true(isp.last_two_blanks('abc\nd\n\n\n'))
540 540 nt.assert_true(isp.last_two_blanks('abc\nd\ne\nf\n\n\n'))
541 541
542 542
543 543 class CellMagicsCommon(object):
544 544
545 545 def test_whole_cell(self):
546 546 src = "%%cellm line\nbody\n"
547 547 sp = self.sp
548 548 sp.push(src)
549 549 out = sp.source_reset()
550 550 ref = u"get_ipython().run_cell_magic({u}'cellm', {u}'line', {u}'body')\n"
551 551 nt.assert_equal(out, py3compat.u_format(ref))
552 552
553 553 def test_cellmagic_help(self):
554 554 self.sp.push('%%cellm?')
555 555 nt.assert_false(self.sp.push_accepts_more())
556 556
557 557 def tearDown(self):
558 558 self.sp.reset()
559 559
560 560
561 561 class CellModeCellMagics(CellMagicsCommon, unittest.TestCase):
562 562 sp = isp.IPythonInputSplitter(line_input_checker=False)
563 563
564 564 def test_incremental(self):
565 565 sp = self.sp
566 566 sp.push('%%cellm firstline\n')
567 567 nt.assert_true(sp.push_accepts_more()) #1
568 568 sp.push('line2\n')
569 569 nt.assert_true(sp.push_accepts_more()) #2
570 570 sp.push('\n')
571 571 # This should accept a blank line and carry on until the cell is reset
572 572 nt.assert_true(sp.push_accepts_more()) #3
573 573
574 574 class LineModeCellMagics(CellMagicsCommon, unittest.TestCase):
575 575 sp = isp.IPythonInputSplitter(line_input_checker=True)
576 576
577 577 def test_incremental(self):
578 578 sp = self.sp
579 579 sp.push('%%cellm line2\n')
580 580 nt.assert_true(sp.push_accepts_more()) #1
581 581 sp.push('\n')
582 582 # In this case, a blank line should end the cell magic
583 583 nt.assert_false(sp.push_accepts_more()) #2
@@ -1,317 +1,317 b''
1 1 """Tests for autoreload extension.
2 2 """
3 3 #-----------------------------------------------------------------------------
4 4 # Copyright (c) 2012 IPython Development Team.
5 5 #
6 6 # Distributed under the terms of the Modified BSD License.
7 7 #
8 8 # The full license is in the file COPYING.txt, distributed with this software.
9 9 #-----------------------------------------------------------------------------
10 10
11 11 #-----------------------------------------------------------------------------
12 12 # Imports
13 13 #-----------------------------------------------------------------------------
14 14
15 15 import os
16 16 import sys
17 17 import tempfile
18 18 import shutil
19 19 import random
20 20 import time
21 21 from StringIO import StringIO
22 22
23 23 import nose.tools as nt
24 24 import IPython.testing.tools as tt
25 25
26 26 from IPython.extensions.autoreload import AutoreloadMagics
27 27 from IPython.core.hooks import TryNext
28 28
29 29 #-----------------------------------------------------------------------------
30 30 # Test fixture
31 31 #-----------------------------------------------------------------------------
32 32
33 33 noop = lambda *a, **kw: None
34 34
35 35 class FakeShell(object):
36 36
37 37 def __init__(self):
38 38 self.ns = {}
39 39 self.auto_magics = AutoreloadMagics(shell=self)
40 40
41 41 register_magics = set_hook = noop
42 42
43 43 def run_code(self, code):
44 44 try:
45 45 self.auto_magics.pre_run_code_hook(self)
46 46 except TryNext:
47 47 pass
48 exec code in self.ns
48 exec(code, self.ns)
49 49
50 50 def push(self, items):
51 51 self.ns.update(items)
52 52
53 53 def magic_autoreload(self, parameter):
54 54 self.auto_magics.autoreload(parameter)
55 55
56 56 def magic_aimport(self, parameter, stream=None):
57 57 self.auto_magics.aimport(parameter, stream=stream)
58 58
59 59
60 60 class Fixture(object):
61 61 """Fixture for creating test module files"""
62 62
63 63 test_dir = None
64 64 old_sys_path = None
65 65 filename_chars = "abcdefghijklmopqrstuvwxyz0123456789"
66 66
67 67 def setUp(self):
68 68 self.test_dir = tempfile.mkdtemp()
69 69 self.old_sys_path = list(sys.path)
70 70 sys.path.insert(0, self.test_dir)
71 71 self.shell = FakeShell()
72 72
73 73 def tearDown(self):
74 74 shutil.rmtree(self.test_dir)
75 75 sys.path = self.old_sys_path
76 76
77 77 self.test_dir = None
78 78 self.old_sys_path = None
79 79 self.shell = None
80 80
81 81 def get_module(self):
82 82 module_name = "tmpmod_" + "".join(random.sample(self.filename_chars,20))
83 83 if module_name in sys.modules:
84 84 del sys.modules[module_name]
85 85 file_name = os.path.join(self.test_dir, module_name + ".py")
86 86 return module_name, file_name
87 87
88 88 def write_file(self, filename, content):
89 89 """
90 90 Write a file, and force a timestamp difference of at least one second
91 91
92 92 Notes
93 93 -----
94 94 Python's .pyc files record the timestamp of their compilation
95 95 with a time resolution of one second.
96 96
97 97 Therefore, we need to force a timestamp difference between .py
98 98 and .pyc, without having the .py file be timestamped in the
99 99 future, and without changing the timestamp of the .pyc file
100 100 (because that is stored in the file). The only reliable way
101 101 to achieve this seems to be to sleep.
102 102 """
103 103
104 104 # Sleep one second + eps
105 105 time.sleep(1.05)
106 106
107 107 # Write
108 108 f = open(filename, 'w')
109 109 try:
110 110 f.write(content)
111 111 finally:
112 112 f.close()
113 113
114 114 def new_module(self, code):
115 115 mod_name, mod_fn = self.get_module()
116 116 f = open(mod_fn, 'w')
117 117 try:
118 118 f.write(code)
119 119 finally:
120 120 f.close()
121 121 return mod_name, mod_fn
122 122
123 123 #-----------------------------------------------------------------------------
124 124 # Test automatic reloading
125 125 #-----------------------------------------------------------------------------
126 126
127 127 class TestAutoreload(Fixture):
128 128 def _check_smoketest(self, use_aimport=True):
129 129 """
130 130 Functional test for the automatic reloader using either
131 131 '%autoreload 1' or '%autoreload 2'
132 132 """
133 133
134 134 mod_name, mod_fn = self.new_module("""
135 135 x = 9
136 136
137 137 z = 123 # this item will be deleted
138 138
139 139 def foo(y):
140 140 return y + 3
141 141
142 142 class Baz(object):
143 143 def __init__(self, x):
144 144 self.x = x
145 145 def bar(self, y):
146 146 return self.x + y
147 147 @property
148 148 def quux(self):
149 149 return 42
150 150 def zzz(self):
151 151 '''This method will be deleted below'''
152 152 return 99
153 153
154 154 class Bar: # old-style class: weakref doesn't work for it on Python < 2.7
155 155 def foo(self):
156 156 return 1
157 157 """)
158 158
159 159 #
160 160 # Import module, and mark for reloading
161 161 #
162 162 if use_aimport:
163 163 self.shell.magic_autoreload("1")
164 164 self.shell.magic_aimport(mod_name)
165 165 stream = StringIO()
166 166 self.shell.magic_aimport("", stream=stream)
167 167 nt.assert_true(("Modules to reload:\n%s" % mod_name) in
168 168 stream.getvalue())
169 169
170 170 nt.assert_raises(
171 171 ImportError,
172 172 self.shell.magic_aimport, "tmpmod_as318989e89ds")
173 173 else:
174 174 self.shell.magic_autoreload("2")
175 175 self.shell.run_code("import %s" % mod_name)
176 176 stream = StringIO()
177 177 self.shell.magic_aimport("", stream=stream)
178 178 nt.assert_true("Modules to reload:\nall-except-skipped" in
179 179 stream.getvalue())
180 180 nt.assert_in(mod_name, self.shell.ns)
181 181
182 182 mod = sys.modules[mod_name]
183 183
184 184 #
185 185 # Test module contents
186 186 #
187 187 old_foo = mod.foo
188 188 old_obj = mod.Baz(9)
189 189 old_obj2 = mod.Bar()
190 190
191 191 def check_module_contents():
192 192 nt.assert_equal(mod.x, 9)
193 193 nt.assert_equal(mod.z, 123)
194 194
195 195 nt.assert_equal(old_foo(0), 3)
196 196 nt.assert_equal(mod.foo(0), 3)
197 197
198 198 obj = mod.Baz(9)
199 199 nt.assert_equal(old_obj.bar(1), 10)
200 200 nt.assert_equal(obj.bar(1), 10)
201 201 nt.assert_equal(obj.quux, 42)
202 202 nt.assert_equal(obj.zzz(), 99)
203 203
204 204 obj2 = mod.Bar()
205 205 nt.assert_equal(old_obj2.foo(), 1)
206 206 nt.assert_equal(obj2.foo(), 1)
207 207
208 208 check_module_contents()
209 209
210 210 #
211 211 # Simulate a failed reload: no reload should occur and exactly
212 212 # one error message should be printed
213 213 #
214 214 self.write_file(mod_fn, """
215 215 a syntax error
216 216 """)
217 217
218 218 with tt.AssertPrints(('[autoreload of %s failed:' % mod_name), channel='stderr'):
219 219 self.shell.run_code("pass") # trigger reload
220 220 with tt.AssertNotPrints(('[autoreload of %s failed:' % mod_name), channel='stderr'):
221 221 self.shell.run_code("pass") # trigger another reload
222 222 check_module_contents()
223 223
224 224 #
225 225 # Rewrite module (this time reload should succeed)
226 226 #
227 227 self.write_file(mod_fn, """
228 228 x = 10
229 229
230 230 def foo(y):
231 231 return y + 4
232 232
233 233 class Baz(object):
234 234 def __init__(self, x):
235 235 self.x = x
236 236 def bar(self, y):
237 237 return self.x + y + 1
238 238 @property
239 239 def quux(self):
240 240 return 43
241 241
242 242 class Bar: # old-style class
243 243 def foo(self):
244 244 return 2
245 245 """)
246 246
247 247 def check_module_contents():
248 248 nt.assert_equal(mod.x, 10)
249 249 nt.assert_false(hasattr(mod, 'z'))
250 250
251 251 nt.assert_equal(old_foo(0), 4) # superreload magic!
252 252 nt.assert_equal(mod.foo(0), 4)
253 253
254 254 obj = mod.Baz(9)
255 255 nt.assert_equal(old_obj.bar(1), 11) # superreload magic!
256 256 nt.assert_equal(obj.bar(1), 11)
257 257
258 258 nt.assert_equal(old_obj.quux, 43)
259 259 nt.assert_equal(obj.quux, 43)
260 260
261 261 nt.assert_false(hasattr(old_obj, 'zzz'))
262 262 nt.assert_false(hasattr(obj, 'zzz'))
263 263
264 264 obj2 = mod.Bar()
265 265 nt.assert_equal(old_obj2.foo(), 2)
266 266 nt.assert_equal(obj2.foo(), 2)
267 267
268 268 self.shell.run_code("pass") # trigger reload
269 269 check_module_contents()
270 270
271 271 #
272 272 # Another failure case: deleted file (shouldn't reload)
273 273 #
274 274 os.unlink(mod_fn)
275 275
276 276 self.shell.run_code("pass") # trigger reload
277 277 check_module_contents()
278 278
279 279 #
280 280 # Disable autoreload and rewrite module: no reload should occur
281 281 #
282 282 if use_aimport:
283 283 self.shell.magic_aimport("-" + mod_name)
284 284 stream = StringIO()
285 285 self.shell.magic_aimport("", stream=stream)
286 286 nt.assert_true(("Modules to skip:\n%s" % mod_name) in
287 287 stream.getvalue())
288 288
289 289 # This should succeed, although no such module exists
290 290 self.shell.magic_aimport("-tmpmod_as318989e89ds")
291 291 else:
292 292 self.shell.magic_autoreload("0")
293 293
294 294 self.write_file(mod_fn, """
295 295 x = -99
296 296 """)
297 297
298 298 self.shell.run_code("pass") # trigger reload
299 299 self.shell.run_code("pass")
300 300 check_module_contents()
301 301
302 302 #
303 303 # Re-enable autoreload: reload should now occur
304 304 #
305 305 if use_aimport:
306 306 self.shell.magic_aimport(mod_name)
307 307 else:
308 308 self.shell.magic_autoreload("")
309 309
310 310 self.shell.run_code("pass") # trigger reload
311 311 nt.assert_equal(mod.x, -99)
312 312
313 313 def test_smoketest_aimport(self):
314 314 self._check_smoketest(use_aimport=True)
315 315
316 316 def test_smoketest_autoreload(self):
317 317 self._check_smoketest(use_aimport=False)
@@ -1,221 +1,221 b''
1 1 ########################## LICENCE ###############################
2 2
3 3 # Copyright (c) 2005-2012, Michele Simionato
4 4 # All rights reserved.
5 5
6 6 # Redistribution and use in source and binary forms, with or without
7 7 # modification, are permitted provided that the following conditions are
8 8 # met:
9 9
10 10 # Redistributions of source code must retain the above copyright
11 11 # notice, this list of conditions and the following disclaimer.
12 12 # Redistributions in bytecode form must reproduce the above copyright
13 13 # notice, this list of conditions and the following disclaimer in
14 14 # the documentation and/or other materials provided with the
15 15 # distribution.
16 16
17 17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 21 # HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
22 22 # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
23 23 # BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
24 24 # OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25 25 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
26 26 # TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
27 27 # USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
28 28 # DAMAGE.
29 29
30 30 """
31 31 Decorator module, see http://pypi.python.org/pypi/decorator
32 32 for the documentation.
33 33 """
34 34 from __future__ import print_function
35 35
36 36 __version__ = '3.3.3'
37 37
38 38 __all__ = ["decorator", "FunctionMaker", "partial"]
39 39
40 40 import sys, re, inspect
41 41
42 42 try:
43 43 from functools import partial
44 44 except ImportError: # for Python version < 2.5
45 45 class partial(object):
46 46 "A simple replacement of functools.partial"
47 47 def __init__(self, func, *args, **kw):
48 48 self.func = func
49 49 self.args = args
50 50 self.keywords = kw
51 51 def __call__(self, *otherargs, **otherkw):
52 52 kw = self.keywords.copy()
53 53 kw.update(otherkw)
54 54 return self.func(*(self.args + otherargs), **kw)
55 55
56 56 if sys.version >= '3':
57 57 from inspect import getfullargspec
58 58 else:
59 59 class getfullargspec(object):
60 60 "A quick and dirty replacement for getfullargspec for Python 2.X"
61 61 def __init__(self, f):
62 62 self.args, self.varargs, self.varkw, self.defaults = \
63 63 inspect.getargspec(f)
64 64 self.kwonlyargs = []
65 65 self.kwonlydefaults = None
66 66 def __iter__(self):
67 67 yield self.args
68 68 yield self.varargs
69 69 yield self.varkw
70 70 yield self.defaults
71 71
72 72 DEF = re.compile('\s*def\s*([_\w][_\w\d]*)\s*\(')
73 73
74 74 # basic functionality
75 75 class FunctionMaker(object):
76 76 """
77 77 An object with the ability to create functions with a given signature.
78 78 It has attributes name, doc, module, signature, defaults, dict and
79 79 methods update and make.
80 80 """
81 81 def __init__(self, func=None, name=None, signature=None,
82 82 defaults=None, doc=None, module=None, funcdict=None):
83 83 self.shortsignature = signature
84 84 if func:
85 85 # func can be a class or a callable, but not an instance method
86 86 self.name = func.__name__
87 87 if self.name == '<lambda>': # small hack for lambda functions
88 88 self.name = '_lambda_'
89 89 self.doc = func.__doc__
90 90 self.module = func.__module__
91 91 if inspect.isfunction(func):
92 92 argspec = getfullargspec(func)
93 93 self.annotations = getattr(func, '__annotations__', {})
94 94 for a in ('args', 'varargs', 'varkw', 'defaults', 'kwonlyargs',
95 95 'kwonlydefaults'):
96 96 setattr(self, a, getattr(argspec, a))
97 97 for i, arg in enumerate(self.args):
98 98 setattr(self, 'arg%d' % i, arg)
99 99 if sys.version < '3': # easy way
100 100 self.shortsignature = self.signature = \
101 101 inspect.formatargspec(
102 102 formatvalue=lambda val: "", *argspec)[1:-1]
103 103 else: # Python 3 way
104 104 self.signature = self.shortsignature = ', '.join(self.args)
105 105 if self.varargs:
106 106 self.signature += ', *' + self.varargs
107 107 self.shortsignature += ', *' + self.varargs
108 108 if self.kwonlyargs:
109 109 for a in self.kwonlyargs:
110 110 self.signature += ', %s=None' % a
111 111 self.shortsignature += ', %s=%s' % (a, a)
112 112 if self.varkw:
113 113 self.signature += ', **' + self.varkw
114 114 self.shortsignature += ', **' + self.varkw
115 115 self.dict = func.__dict__.copy()
116 116 # func=None happens when decorating a caller
117 117 if name:
118 118 self.name = name
119 119 if signature is not None:
120 120 self.signature = signature
121 121 if defaults:
122 122 self.defaults = defaults
123 123 if doc:
124 124 self.doc = doc
125 125 if module:
126 126 self.module = module
127 127 if funcdict:
128 128 self.dict = funcdict
129 129 # check existence required attributes
130 130 assert hasattr(self, 'name')
131 131 if not hasattr(self, 'signature'):
132 132 raise TypeError('You are decorating a non function: %s' % func)
133 133
134 134 def update(self, func, **kw):
135 135 "Update the signature of func with the data in self"
136 136 func.__name__ = self.name
137 137 func.__doc__ = getattr(self, 'doc', None)
138 138 func.__dict__ = getattr(self, 'dict', {})
139 139 func.func_defaults = getattr(self, 'defaults', ())
140 140 func.__kwdefaults__ = getattr(self, 'kwonlydefaults', None)
141 141 func.__annotations__ = getattr(self, 'annotations', None)
142 142 callermodule = sys._getframe(3).f_globals.get('__name__', '?')
143 143 func.__module__ = getattr(self, 'module', callermodule)
144 144 func.__dict__.update(kw)
145 145
146 146 def make(self, src_templ, evaldict=None, addsource=False, **attrs):
147 147 "Make a new function from a given template and update the signature"
148 148 src = src_templ % vars(self) # expand name and signature
149 149 evaldict = evaldict or {}
150 150 mo = DEF.match(src)
151 151 if mo is None:
152 152 raise SyntaxError('not a valid function template\n%s' % src)
153 153 name = mo.group(1) # extract the function name
154 154 names = set([name] + [arg.strip(' *') for arg in
155 155 self.shortsignature.split(',')])
156 156 for n in names:
157 157 if n in ('_func_', '_call_'):
158 158 raise NameError('%s is overridden in\n%s' % (n, src))
159 159 if not src.endswith('\n'): # add a newline just for safety
160 160 src += '\n' # this is needed in old versions of Python
161 161 try:
162 162 code = compile(src, '<string>', 'single')
163 163 # print >> sys.stderr, 'Compiling %s' % src
164 exec code in evaldict
164 exec(code, evaldict)
165 165 except:
166 166 print('Error in generated code:', file=sys.stderr)
167 167 print(src, file=sys.stderr)
168 168 raise
169 169 func = evaldict[name]
170 170 if addsource:
171 171 attrs['__source__'] = src
172 172 self.update(func, **attrs)
173 173 return func
174 174
175 175 @classmethod
176 176 def create(cls, obj, body, evaldict, defaults=None,
177 177 doc=None, module=None, addsource=True, **attrs):
178 178 """
179 179 Create a function from the strings name, signature and body.
180 180 evaldict is the evaluation dictionary. If addsource is true an attribute
181 181 __source__ is added to the result. The attributes attrs are added,
182 182 if any.
183 183 """
184 184 if isinstance(obj, str): # "name(signature)"
185 185 name, rest = obj.strip().split('(', 1)
186 186 signature = rest[:-1] #strip a right parens
187 187 func = None
188 188 else: # a function
189 189 name = None
190 190 signature = None
191 191 func = obj
192 192 self = cls(func, name, signature, defaults, doc, module)
193 193 ibody = '\n'.join(' ' + line for line in body.splitlines())
194 194 return self.make('def %(name)s(%(signature)s):\n' + ibody,
195 195 evaldict, addsource, **attrs)
196 196
197 197 def decorator(caller, func=None):
198 198 """
199 199 decorator(caller) converts a caller function into a decorator;
200 200 decorator(caller, func) decorates a function using a caller.
201 201 """
202 202 if func is not None: # returns a decorated function
203 203 evaldict = func.func_globals.copy()
204 204 evaldict['_call_'] = caller
205 205 evaldict['_func_'] = func
206 206 return FunctionMaker.create(
207 207 func, "return _call_(_func_, %(shortsignature)s)",
208 208 evaldict, undecorated=func, __wrapped__=func)
209 209 else: # returns a decorator
210 210 if isinstance(caller, partial):
211 211 return partial(decorator, caller)
212 212 # otherwise assume caller is a function
213 213 first = inspect.getargspec(caller)[0][0] # first arg
214 214 evaldict = caller.func_globals.copy()
215 215 evaldict['_call_'] = caller
216 216 evaldict['decorator'] = decorator
217 217 return FunctionMaker.create(
218 218 '%s(%s)' % (caller.__name__, first),
219 219 'return decorator(_call_, %s)' % first,
220 220 evaldict, undecorated=caller, __wrapped__=caller,
221 221 doc=caller.__doc__, module=caller.__module__)
@@ -1,789 +1,789 b''
1 1 #!/usr/bin/env python
2 2 """An interactive kernel that talks to frontends over 0MQ."""
3 3
4 4 #-----------------------------------------------------------------------------
5 5 # Imports
6 6 #-----------------------------------------------------------------------------
7 7 from __future__ import print_function
8 8
9 9 # Standard library imports
10 10 import __builtin__
11 11 import sys
12 12 import time
13 13 import traceback
14 14 import logging
15 15 import uuid
16 16
17 17 from datetime import datetime
18 18 from signal import (
19 19 signal, default_int_handler, SIGINT
20 20 )
21 21
22 22 # System library imports
23 23 import zmq
24 24 from zmq.eventloop import ioloop
25 25 from zmq.eventloop.zmqstream import ZMQStream
26 26
27 27 # Local imports
28 28 from IPython.config.configurable import Configurable
29 29 from IPython.core.error import StdinNotImplementedError
30 30 from IPython.core import release
31 31 from IPython.utils import py3compat
32 32 from IPython.utils.jsonutil import json_clean
33 33 from IPython.utils.traitlets import (
34 34 Any, Instance, Float, Dict, List, Set, Integer, Unicode,
35 35 Type
36 36 )
37 37
38 38 from .serialize import serialize_object, unpack_apply_message
39 39 from .session import Session
40 40 from .zmqshell import ZMQInteractiveShell
41 41
42 42
43 43 #-----------------------------------------------------------------------------
44 44 # Main kernel class
45 45 #-----------------------------------------------------------------------------
46 46
47 47 protocol_version = list(release.kernel_protocol_version_info)
48 48 ipython_version = list(release.version_info)
49 49 language_version = list(sys.version_info[:3])
50 50
51 51
52 52 class Kernel(Configurable):
53 53
54 54 #---------------------------------------------------------------------------
55 55 # Kernel interface
56 56 #---------------------------------------------------------------------------
57 57
58 58 # attribute to override with a GUI
59 59 eventloop = Any(None)
60 60 def _eventloop_changed(self, name, old, new):
61 61 """schedule call to eventloop from IOLoop"""
62 62 loop = ioloop.IOLoop.instance()
63 63 loop.add_timeout(time.time()+0.1, self.enter_eventloop)
64 64
65 65 shell = Instance('IPython.core.interactiveshell.InteractiveShellABC')
66 66 shell_class = Type(ZMQInteractiveShell)
67 67
68 68 session = Instance(Session)
69 69 profile_dir = Instance('IPython.core.profiledir.ProfileDir')
70 70 shell_streams = List()
71 71 control_stream = Instance(ZMQStream)
72 72 iopub_socket = Instance(zmq.Socket)
73 73 stdin_socket = Instance(zmq.Socket)
74 74 log = Instance(logging.Logger)
75 75
76 76 user_module = Any()
77 77 def _user_module_changed(self, name, old, new):
78 78 if self.shell is not None:
79 79 self.shell.user_module = new
80 80
81 81 user_ns = Instance(dict, args=None, allow_none=True)
82 82 def _user_ns_changed(self, name, old, new):
83 83 if self.shell is not None:
84 84 self.shell.user_ns = new
85 85 self.shell.init_user_ns()
86 86
87 87 # identities:
88 88 int_id = Integer(-1)
89 89 ident = Unicode()
90 90
91 91 def _ident_default(self):
92 92 return unicode(uuid.uuid4())
93 93
94 94
95 95 # Private interface
96 96
97 97 # Time to sleep after flushing the stdout/err buffers in each execute
98 98 # cycle. While this introduces a hard limit on the minimal latency of the
99 99 # execute cycle, it helps prevent output synchronization problems for
100 100 # clients.
101 101 # Units are in seconds. The minimum zmq latency on local host is probably
102 102 # ~150 microseconds, set this to 500us for now. We may need to increase it
103 103 # a little if it's not enough after more interactive testing.
104 104 _execute_sleep = Float(0.0005, config=True)
105 105
106 106 # Frequency of the kernel's event loop.
107 107 # Units are in seconds, kernel subclasses for GUI toolkits may need to
108 108 # adapt to milliseconds.
109 109 _poll_interval = Float(0.05, config=True)
110 110
111 111 # If the shutdown was requested over the network, we leave here the
112 112 # necessary reply message so it can be sent by our registered atexit
113 113 # handler. This ensures that the reply is only sent to clients truly at
114 114 # the end of our shutdown process (which happens after the underlying
115 115 # IPython shell's own shutdown).
116 116 _shutdown_message = None
117 117
118 118 # This is a dict of port number that the kernel is listening on. It is set
119 119 # by record_ports and used by connect_request.
120 120 _recorded_ports = Dict()
121 121
122 122 # A reference to the Python builtin 'raw_input' function.
123 123 # (i.e., __builtin__.raw_input for Python 2.7, builtins.input for Python 3)
124 124 _sys_raw_input = Any()
125 125 _sys_eval_input = Any()
126 126
127 127 # set of aborted msg_ids
128 128 aborted = Set()
129 129
130 130
131 131 def __init__(self, **kwargs):
132 132 super(Kernel, self).__init__(**kwargs)
133 133
134 134 # Initialize the InteractiveShell subclass
135 135 self.shell = self.shell_class.instance(parent=self,
136 136 profile_dir = self.profile_dir,
137 137 user_module = self.user_module,
138 138 user_ns = self.user_ns,
139 139 kernel = self,
140 140 )
141 141 self.shell.displayhook.session = self.session
142 142 self.shell.displayhook.pub_socket = self.iopub_socket
143 143 self.shell.displayhook.topic = self._topic('pyout')
144 144 self.shell.display_pub.session = self.session
145 145 self.shell.display_pub.pub_socket = self.iopub_socket
146 146 self.shell.data_pub.session = self.session
147 147 self.shell.data_pub.pub_socket = self.iopub_socket
148 148
149 149 # TMP - hack while developing
150 150 self.shell._reply_content = None
151 151
152 152 # Build dict of handlers for message types
153 153 msg_types = [ 'execute_request', 'complete_request',
154 154 'object_info_request', 'history_request',
155 155 'kernel_info_request',
156 156 'connect_request', 'shutdown_request',
157 157 'apply_request',
158 158 ]
159 159 self.shell_handlers = {}
160 160 for msg_type in msg_types:
161 161 self.shell_handlers[msg_type] = getattr(self, msg_type)
162 162
163 163 comm_msg_types = [ 'comm_open', 'comm_msg', 'comm_close' ]
164 164 comm_manager = self.shell.comm_manager
165 165 for msg_type in comm_msg_types:
166 166 self.shell_handlers[msg_type] = getattr(comm_manager, msg_type)
167 167
168 168 control_msg_types = msg_types + [ 'clear_request', 'abort_request' ]
169 169 self.control_handlers = {}
170 170 for msg_type in control_msg_types:
171 171 self.control_handlers[msg_type] = getattr(self, msg_type)
172 172
173 173
174 174 def dispatch_control(self, msg):
175 175 """dispatch control requests"""
176 176 idents,msg = self.session.feed_identities(msg, copy=False)
177 177 try:
178 178 msg = self.session.unserialize(msg, content=True, copy=False)
179 179 except:
180 180 self.log.error("Invalid Control Message", exc_info=True)
181 181 return
182 182
183 183 self.log.debug("Control received: %s", msg)
184 184
185 185 header = msg['header']
186 186 msg_id = header['msg_id']
187 187 msg_type = header['msg_type']
188 188
189 189 handler = self.control_handlers.get(msg_type, None)
190 190 if handler is None:
191 191 self.log.error("UNKNOWN CONTROL MESSAGE TYPE: %r", msg_type)
192 192 else:
193 193 try:
194 194 handler(self.control_stream, idents, msg)
195 195 except Exception:
196 196 self.log.error("Exception in control handler:", exc_info=True)
197 197
198 198 def dispatch_shell(self, stream, msg):
199 199 """dispatch shell requests"""
200 200 # flush control requests first
201 201 if self.control_stream:
202 202 self.control_stream.flush()
203 203
204 204 idents,msg = self.session.feed_identities(msg, copy=False)
205 205 try:
206 206 msg = self.session.unserialize(msg, content=True, copy=False)
207 207 except:
208 208 self.log.error("Invalid Message", exc_info=True)
209 209 return
210 210
211 211 header = msg['header']
212 212 msg_id = header['msg_id']
213 213 msg_type = msg['header']['msg_type']
214 214
215 215 # Print some info about this message and leave a '--->' marker, so it's
216 216 # easier to trace visually the message chain when debugging. Each
217 217 # handler prints its message at the end.
218 218 self.log.debug('\n*** MESSAGE TYPE:%s***', msg_type)
219 219 self.log.debug(' Content: %s\n --->\n ', msg['content'])
220 220
221 221 if msg_id in self.aborted:
222 222 self.aborted.remove(msg_id)
223 223 # is it safe to assume a msg_id will not be resubmitted?
224 224 reply_type = msg_type.split('_')[0] + '_reply'
225 225 status = {'status' : 'aborted'}
226 226 md = {'engine' : self.ident}
227 227 md.update(status)
228 228 reply_msg = self.session.send(stream, reply_type, metadata=md,
229 229 content=status, parent=msg, ident=idents)
230 230 return
231 231
232 232 handler = self.shell_handlers.get(msg_type, None)
233 233 if handler is None:
234 234 self.log.error("UNKNOWN MESSAGE TYPE: %r", msg_type)
235 235 else:
236 236 # ensure default_int_handler during handler call
237 237 sig = signal(SIGINT, default_int_handler)
238 238 try:
239 239 handler(stream, idents, msg)
240 240 except Exception:
241 241 self.log.error("Exception in message handler:", exc_info=True)
242 242 finally:
243 243 signal(SIGINT, sig)
244 244
245 245 def enter_eventloop(self):
246 246 """enter eventloop"""
247 247 self.log.info("entering eventloop")
248 248 # restore default_int_handler
249 249 signal(SIGINT, default_int_handler)
250 250 while self.eventloop is not None:
251 251 try:
252 252 self.eventloop(self)
253 253 except KeyboardInterrupt:
254 254 # Ctrl-C shouldn't crash the kernel
255 255 self.log.error("KeyboardInterrupt caught in kernel")
256 256 continue
257 257 else:
258 258 # eventloop exited cleanly, this means we should stop (right?)
259 259 self.eventloop = None
260 260 break
261 261 self.log.info("exiting eventloop")
262 262
263 263 def start(self):
264 264 """register dispatchers for streams"""
265 265 self.shell.exit_now = False
266 266 if self.control_stream:
267 267 self.control_stream.on_recv(self.dispatch_control, copy=False)
268 268
269 269 def make_dispatcher(stream):
270 270 def dispatcher(msg):
271 271 return self.dispatch_shell(stream, msg)
272 272 return dispatcher
273 273
274 274 for s in self.shell_streams:
275 275 s.on_recv(make_dispatcher(s), copy=False)
276 276
277 277 # publish idle status
278 278 self._publish_status('starting')
279 279
280 280 def do_one_iteration(self):
281 281 """step eventloop just once"""
282 282 if self.control_stream:
283 283 self.control_stream.flush()
284 284 for stream in self.shell_streams:
285 285 # handle at most one request per iteration
286 286 stream.flush(zmq.POLLIN, 1)
287 287 stream.flush(zmq.POLLOUT)
288 288
289 289
290 290 def record_ports(self, ports):
291 291 """Record the ports that this kernel is using.
292 292
293 293 The creator of the Kernel instance must call this methods if they
294 294 want the :meth:`connect_request` method to return the port numbers.
295 295 """
296 296 self._recorded_ports = ports
297 297
298 298 #---------------------------------------------------------------------------
299 299 # Kernel request handlers
300 300 #---------------------------------------------------------------------------
301 301
302 302 def _make_metadata(self, other=None):
303 303 """init metadata dict, for execute/apply_reply"""
304 304 new_md = {
305 305 'dependencies_met' : True,
306 306 'engine' : self.ident,
307 307 'started': datetime.now(),
308 308 }
309 309 if other:
310 310 new_md.update(other)
311 311 return new_md
312 312
313 313 def _publish_pyin(self, code, parent, execution_count):
314 314 """Publish the code request on the pyin stream."""
315 315
316 316 self.session.send(self.iopub_socket, u'pyin',
317 317 {u'code':code, u'execution_count': execution_count},
318 318 parent=parent, ident=self._topic('pyin')
319 319 )
320 320
321 321 def _publish_status(self, status, parent=None):
322 322 """send status (busy/idle) on IOPub"""
323 323 self.session.send(self.iopub_socket,
324 324 u'status',
325 325 {u'execution_state': status},
326 326 parent=parent,
327 327 ident=self._topic('status'),
328 328 )
329 329
330 330
331 331 def execute_request(self, stream, ident, parent):
332 332 """handle an execute_request"""
333 333
334 334 self._publish_status(u'busy', parent)
335 335
336 336 try:
337 337 content = parent[u'content']
338 338 code = content[u'code']
339 339 silent = content[u'silent']
340 340 store_history = content.get(u'store_history', not silent)
341 341 except:
342 342 self.log.error("Got bad msg: ")
343 343 self.log.error("%s", parent)
344 344 return
345 345
346 346 md = self._make_metadata(parent['metadata'])
347 347
348 348 shell = self.shell # we'll need this a lot here
349 349
350 350 # Replace raw_input. Note that is not sufficient to replace
351 351 # raw_input in the user namespace.
352 352 if content.get('allow_stdin', False):
353 353 raw_input = lambda prompt='': self._raw_input(prompt, ident, parent)
354 354 input = lambda prompt='': eval(raw_input(prompt))
355 355 else:
356 356 raw_input = input = lambda prompt='' : self._no_raw_input()
357 357
358 358 if py3compat.PY3:
359 359 self._sys_raw_input = __builtin__.input
360 360 __builtin__.input = raw_input
361 361 else:
362 362 self._sys_raw_input = __builtin__.raw_input
363 363 self._sys_eval_input = __builtin__.input
364 364 __builtin__.raw_input = raw_input
365 365 __builtin__.input = input
366 366
367 367 # Set the parent message of the display hook and out streams.
368 368 shell.set_parent(parent)
369 369
370 370 # Re-broadcast our input for the benefit of listening clients, and
371 371 # start computing output
372 372 if not silent:
373 373 self._publish_pyin(code, parent, shell.execution_count)
374 374
375 375 reply_content = {}
376 376 try:
377 377 # FIXME: the shell calls the exception handler itself.
378 378 shell.run_cell(code, store_history=store_history, silent=silent)
379 379 except:
380 380 status = u'error'
381 381 # FIXME: this code right now isn't being used yet by default,
382 382 # because the run_cell() call above directly fires off exception
383 383 # reporting. This code, therefore, is only active in the scenario
384 384 # where runlines itself has an unhandled exception. We need to
385 385 # uniformize this, for all exception construction to come from a
386 386 # single location in the codbase.
387 387 etype, evalue, tb = sys.exc_info()
388 388 tb_list = traceback.format_exception(etype, evalue, tb)
389 389 reply_content.update(shell._showtraceback(etype, evalue, tb_list))
390 390 else:
391 391 status = u'ok'
392 392 finally:
393 393 # Restore raw_input.
394 394 if py3compat.PY3:
395 395 __builtin__.input = self._sys_raw_input
396 396 else:
397 397 __builtin__.raw_input = self._sys_raw_input
398 398 __builtin__.input = self._sys_eval_input
399 399
400 400 reply_content[u'status'] = status
401 401
402 402 # Return the execution counter so clients can display prompts
403 403 reply_content['execution_count'] = shell.execution_count - 1
404 404
405 405 # FIXME - fish exception info out of shell, possibly left there by
406 406 # runlines. We'll need to clean up this logic later.
407 407 if shell._reply_content is not None:
408 408 reply_content.update(shell._reply_content)
409 409 e_info = dict(engine_uuid=self.ident, engine_id=self.int_id, method='execute')
410 410 reply_content['engine_info'] = e_info
411 411 # reset after use
412 412 shell._reply_content = None
413 413
414 414 if 'traceback' in reply_content:
415 415 self.log.info("Exception in execute request:\n%s", '\n'.join(reply_content['traceback']))
416 416
417 417
418 418 # At this point, we can tell whether the main code execution succeeded
419 419 # or not. If it did, we proceed to evaluate user_variables/expressions
420 420 if reply_content['status'] == 'ok':
421 421 reply_content[u'user_variables'] = \
422 422 shell.user_variables(content.get(u'user_variables', []))
423 423 reply_content[u'user_expressions'] = \
424 424 shell.user_expressions(content.get(u'user_expressions', {}))
425 425 else:
426 426 # If there was an error, don't even try to compute variables or
427 427 # expressions
428 428 reply_content[u'user_variables'] = {}
429 429 reply_content[u'user_expressions'] = {}
430 430
431 431 # Payloads should be retrieved regardless of outcome, so we can both
432 432 # recover partial output (that could have been generated early in a
433 433 # block, before an error) and clear the payload system always.
434 434 reply_content[u'payload'] = shell.payload_manager.read_payload()
435 435 # Be agressive about clearing the payload because we don't want
436 436 # it to sit in memory until the next execute_request comes in.
437 437 shell.payload_manager.clear_payload()
438 438
439 439 # Flush output before sending the reply.
440 440 sys.stdout.flush()
441 441 sys.stderr.flush()
442 442 # FIXME: on rare occasions, the flush doesn't seem to make it to the
443 443 # clients... This seems to mitigate the problem, but we definitely need
444 444 # to better understand what's going on.
445 445 if self._execute_sleep:
446 446 time.sleep(self._execute_sleep)
447 447
448 448 # Send the reply.
449 449 reply_content = json_clean(reply_content)
450 450
451 451 md['status'] = reply_content['status']
452 452 if reply_content['status'] == 'error' and \
453 453 reply_content['ename'] == 'UnmetDependency':
454 454 md['dependencies_met'] = False
455 455
456 456 reply_msg = self.session.send(stream, u'execute_reply',
457 457 reply_content, parent, metadata=md,
458 458 ident=ident)
459 459
460 460 self.log.debug("%s", reply_msg)
461 461
462 462 if not silent and reply_msg['content']['status'] == u'error':
463 463 self._abort_queues()
464 464
465 465 self._publish_status(u'idle', parent)
466 466
467 467 def complete_request(self, stream, ident, parent):
468 468 txt, matches = self._complete(parent)
469 469 matches = {'matches' : matches,
470 470 'matched_text' : txt,
471 471 'status' : 'ok'}
472 472 matches = json_clean(matches)
473 473 completion_msg = self.session.send(stream, 'complete_reply',
474 474 matches, parent, ident)
475 475 self.log.debug("%s", completion_msg)
476 476
477 477 def object_info_request(self, stream, ident, parent):
478 478 content = parent['content']
479 479 object_info = self.shell.object_inspect(content['oname'],
480 480 detail_level = content.get('detail_level', 0)
481 481 )
482 482 # Before we send this object over, we scrub it for JSON usage
483 483 oinfo = json_clean(object_info)
484 484 msg = self.session.send(stream, 'object_info_reply',
485 485 oinfo, parent, ident)
486 486 self.log.debug("%s", msg)
487 487
488 488 def history_request(self, stream, ident, parent):
489 489 # We need to pull these out, as passing **kwargs doesn't work with
490 490 # unicode keys before Python 2.6.5.
491 491 hist_access_type = parent['content']['hist_access_type']
492 492 raw = parent['content']['raw']
493 493 output = parent['content']['output']
494 494 if hist_access_type == 'tail':
495 495 n = parent['content']['n']
496 496 hist = self.shell.history_manager.get_tail(n, raw=raw, output=output,
497 497 include_latest=True)
498 498
499 499 elif hist_access_type == 'range':
500 500 session = parent['content']['session']
501 501 start = parent['content']['start']
502 502 stop = parent['content']['stop']
503 503 hist = self.shell.history_manager.get_range(session, start, stop,
504 504 raw=raw, output=output)
505 505
506 506 elif hist_access_type == 'search':
507 507 n = parent['content'].get('n')
508 508 unique = parent['content'].get('unique', False)
509 509 pattern = parent['content']['pattern']
510 510 hist = self.shell.history_manager.search(
511 511 pattern, raw=raw, output=output, n=n, unique=unique)
512 512
513 513 else:
514 514 hist = []
515 515 hist = list(hist)
516 516 content = {'history' : hist}
517 517 content = json_clean(content)
518 518 msg = self.session.send(stream, 'history_reply',
519 519 content, parent, ident)
520 520 self.log.debug("Sending history reply with %i entries", len(hist))
521 521
522 522 def connect_request(self, stream, ident, parent):
523 523 if self._recorded_ports is not None:
524 524 content = self._recorded_ports.copy()
525 525 else:
526 526 content = {}
527 527 msg = self.session.send(stream, 'connect_reply',
528 528 content, parent, ident)
529 529 self.log.debug("%s", msg)
530 530
531 531 def kernel_info_request(self, stream, ident, parent):
532 532 vinfo = {
533 533 'protocol_version': protocol_version,
534 534 'ipython_version': ipython_version,
535 535 'language_version': language_version,
536 536 'language': 'python',
537 537 }
538 538 msg = self.session.send(stream, 'kernel_info_reply',
539 539 vinfo, parent, ident)
540 540 self.log.debug("%s", msg)
541 541
542 542 def shutdown_request(self, stream, ident, parent):
543 543 self.shell.exit_now = True
544 544 content = dict(status='ok')
545 545 content.update(parent['content'])
546 546 self.session.send(stream, u'shutdown_reply', content, parent, ident=ident)
547 547 # same content, but different msg_id for broadcasting on IOPub
548 548 self._shutdown_message = self.session.msg(u'shutdown_reply',
549 549 content, parent
550 550 )
551 551
552 552 self._at_shutdown()
553 553 # call sys.exit after a short delay
554 554 loop = ioloop.IOLoop.instance()
555 555 loop.add_timeout(time.time()+0.1, loop.stop)
556 556
557 557 #---------------------------------------------------------------------------
558 558 # Engine methods
559 559 #---------------------------------------------------------------------------
560 560
561 561 def apply_request(self, stream, ident, parent):
562 562 try:
563 563 content = parent[u'content']
564 564 bufs = parent[u'buffers']
565 565 msg_id = parent['header']['msg_id']
566 566 except:
567 567 self.log.error("Got bad msg: %s", parent, exc_info=True)
568 568 return
569 569
570 570 self._publish_status(u'busy', parent)
571 571
572 572 # Set the parent message of the display hook and out streams.
573 573 shell = self.shell
574 574 shell.set_parent(parent)
575 575
576 576 # pyin_msg = self.session.msg(u'pyin',{u'code':code}, parent=parent)
577 577 # self.iopub_socket.send(pyin_msg)
578 578 # self.session.send(self.iopub_socket, u'pyin', {u'code':code},parent=parent)
579 579 md = self._make_metadata(parent['metadata'])
580 580 try:
581 581 working = shell.user_ns
582 582
583 583 prefix = "_"+str(msg_id).replace("-","")+"_"
584 584
585 585 f,args,kwargs = unpack_apply_message(bufs, working, copy=False)
586 586
587 587 fname = getattr(f, '__name__', 'f')
588 588
589 589 fname = prefix+"f"
590 590 argname = prefix+"args"
591 591 kwargname = prefix+"kwargs"
592 592 resultname = prefix+"result"
593 593
594 594 ns = { fname : f, argname : args, kwargname : kwargs , resultname : None }
595 595 # print ns
596 596 working.update(ns)
597 597 code = "%s = %s(*%s,**%s)" % (resultname, fname, argname, kwargname)
598 598 try:
599 exec code in shell.user_global_ns, shell.user_ns
599 exec(code, shell.user_global_ns, shell.user_ns)
600 600 result = working.get(resultname)
601 601 finally:
602 602 for key in ns.iterkeys():
603 603 working.pop(key)
604 604
605 605 result_buf = serialize_object(result,
606 606 buffer_threshold=self.session.buffer_threshold,
607 607 item_threshold=self.session.item_threshold,
608 608 )
609 609
610 610 except:
611 611 # invoke IPython traceback formatting
612 612 shell.showtraceback()
613 613 # FIXME - fish exception info out of shell, possibly left there by
614 614 # run_code. We'll need to clean up this logic later.
615 615 reply_content = {}
616 616 if shell._reply_content is not None:
617 617 reply_content.update(shell._reply_content)
618 618 e_info = dict(engine_uuid=self.ident, engine_id=self.int_id, method='apply')
619 619 reply_content['engine_info'] = e_info
620 620 # reset after use
621 621 shell._reply_content = None
622 622
623 623 self.session.send(self.iopub_socket, u'pyerr', reply_content, parent=parent,
624 624 ident=self._topic('pyerr'))
625 625 self.log.info("Exception in apply request:\n%s", '\n'.join(reply_content['traceback']))
626 626 result_buf = []
627 627
628 628 if reply_content['ename'] == 'UnmetDependency':
629 629 md['dependencies_met'] = False
630 630 else:
631 631 reply_content = {'status' : 'ok'}
632 632
633 633 # put 'ok'/'error' status in header, for scheduler introspection:
634 634 md['status'] = reply_content['status']
635 635
636 636 # flush i/o
637 637 sys.stdout.flush()
638 638 sys.stderr.flush()
639 639
640 640 reply_msg = self.session.send(stream, u'apply_reply', reply_content,
641 641 parent=parent, ident=ident,buffers=result_buf, metadata=md)
642 642
643 643 self._publish_status(u'idle', parent)
644 644
645 645 #---------------------------------------------------------------------------
646 646 # Control messages
647 647 #---------------------------------------------------------------------------
648 648
649 649 def abort_request(self, stream, ident, parent):
650 650 """abort a specifig msg by id"""
651 651 msg_ids = parent['content'].get('msg_ids', None)
652 652 if isinstance(msg_ids, basestring):
653 653 msg_ids = [msg_ids]
654 654 if not msg_ids:
655 655 self.abort_queues()
656 656 for mid in msg_ids:
657 657 self.aborted.add(str(mid))
658 658
659 659 content = dict(status='ok')
660 660 reply_msg = self.session.send(stream, 'abort_reply', content=content,
661 661 parent=parent, ident=ident)
662 662 self.log.debug("%s", reply_msg)
663 663
664 664 def clear_request(self, stream, idents, parent):
665 665 """Clear our namespace."""
666 666 self.shell.reset(False)
667 667 msg = self.session.send(stream, 'clear_reply', ident=idents, parent=parent,
668 668 content = dict(status='ok'))
669 669
670 670
671 671 #---------------------------------------------------------------------------
672 672 # Protected interface
673 673 #---------------------------------------------------------------------------
674 674
675 675 def _wrap_exception(self, method=None):
676 676 # import here, because _wrap_exception is only used in parallel,
677 677 # and parallel has higher min pyzmq version
678 678 from IPython.parallel.error import wrap_exception
679 679 e_info = dict(engine_uuid=self.ident, engine_id=self.int_id, method=method)
680 680 content = wrap_exception(e_info)
681 681 return content
682 682
683 683 def _topic(self, topic):
684 684 """prefixed topic for IOPub messages"""
685 685 if self.int_id >= 0:
686 686 base = "engine.%i" % self.int_id
687 687 else:
688 688 base = "kernel.%s" % self.ident
689 689
690 690 return py3compat.cast_bytes("%s.%s" % (base, topic))
691 691
692 692 def _abort_queues(self):
693 693 for stream in self.shell_streams:
694 694 if stream:
695 695 self._abort_queue(stream)
696 696
697 697 def _abort_queue(self, stream):
698 698 poller = zmq.Poller()
699 699 poller.register(stream.socket, zmq.POLLIN)
700 700 while True:
701 701 idents,msg = self.session.recv(stream, zmq.NOBLOCK, content=True)
702 702 if msg is None:
703 703 return
704 704
705 705 self.log.info("Aborting:")
706 706 self.log.info("%s", msg)
707 707 msg_type = msg['header']['msg_type']
708 708 reply_type = msg_type.split('_')[0] + '_reply'
709 709
710 710 status = {'status' : 'aborted'}
711 711 md = {'engine' : self.ident}
712 712 md.update(status)
713 713 reply_msg = self.session.send(stream, reply_type, metadata=md,
714 714 content=status, parent=msg, ident=idents)
715 715 self.log.debug("%s", reply_msg)
716 716 # We need to wait a bit for requests to come in. This can probably
717 717 # be set shorter for true asynchronous clients.
718 718 poller.poll(50)
719 719
720 720
721 721 def _no_raw_input(self):
722 722 """Raise StdinNotImplentedError if active frontend doesn't support
723 723 stdin."""
724 724 raise StdinNotImplementedError("raw_input was called, but this "
725 725 "frontend does not support stdin.")
726 726
727 727 def _raw_input(self, prompt, ident, parent):
728 728 # Flush output before making the request.
729 729 sys.stderr.flush()
730 730 sys.stdout.flush()
731 731 # flush the stdin socket, to purge stale replies
732 732 while True:
733 733 try:
734 734 self.stdin_socket.recv_multipart(zmq.NOBLOCK)
735 735 except zmq.ZMQError as e:
736 736 if e.errno == zmq.EAGAIN:
737 737 break
738 738 else:
739 739 raise
740 740
741 741 # Send the input request.
742 742 content = json_clean(dict(prompt=prompt))
743 743 self.session.send(self.stdin_socket, u'input_request', content, parent,
744 744 ident=ident)
745 745
746 746 # Await a response.
747 747 while True:
748 748 try:
749 749 ident, reply = self.session.recv(self.stdin_socket, 0)
750 750 except Exception:
751 751 self.log.warn("Invalid Message:", exc_info=True)
752 752 except KeyboardInterrupt:
753 753 # re-raise KeyboardInterrupt, to truncate traceback
754 754 raise KeyboardInterrupt
755 755 else:
756 756 break
757 757 try:
758 758 value = py3compat.unicode_to_str(reply['content']['value'])
759 759 except:
760 760 self.log.error("Got bad raw_input reply: ")
761 761 self.log.error("%s", parent)
762 762 value = ''
763 763 if value == '\x04':
764 764 # EOF
765 765 raise EOFError
766 766 return value
767 767
768 768 def _complete(self, msg):
769 769 c = msg['content']
770 770 try:
771 771 cpos = int(c['cursor_pos'])
772 772 except:
773 773 # If we don't get something that we can convert to an integer, at
774 774 # least attempt the completion guessing the cursor is at the end of
775 775 # the text, if there's any, and otherwise of the line
776 776 cpos = len(c['text'])
777 777 if cpos==0:
778 778 cpos = len(c['line'])
779 779 return self.shell.complete(c['text'], c['line'], cpos)
780 780
781 781 def _at_shutdown(self):
782 782 """Actions taken at shutdown by the kernel, called by python's atexit.
783 783 """
784 784 # io.rprint("Kernel at_shutdown") # dbg
785 785 if self._shutdown_message is not None:
786 786 self.session.send(self.iopub_socket, self._shutdown_message, ident=self._topic('shutdown'))
787 787 self.log.debug("%s", self._shutdown_message)
788 788 [ s.flush(zmq.POLLOUT) for s in self.shell_streams ]
789 789
@@ -1,582 +1,582 b''
1 1 """Module for interactive demos using IPython.
2 2
3 3 This module implements a few classes for running Python scripts interactively
4 4 in IPython for demonstrations. With very simple markup (a few tags in
5 5 comments), you can control points where the script stops executing and returns
6 6 control to IPython.
7 7
8 8
9 9 Provided classes
10 10 ----------------
11 11
12 12 The classes are (see their docstrings for further details):
13 13
14 14 - Demo: pure python demos
15 15
16 16 - IPythonDemo: demos with input to be processed by IPython as if it had been
17 17 typed interactively (so magics work, as well as any other special syntax you
18 18 may have added via input prefilters).
19 19
20 20 - LineDemo: single-line version of the Demo class. These demos are executed
21 21 one line at a time, and require no markup.
22 22
23 23 - IPythonLineDemo: IPython version of the LineDemo class (the demo is
24 24 executed a line at a time, but processed via IPython).
25 25
26 26 - ClearMixin: mixin to make Demo classes with less visual clutter. It
27 27 declares an empty marquee and a pre_cmd that clears the screen before each
28 28 block (see Subclassing below).
29 29
30 30 - ClearDemo, ClearIPDemo: mixin-enabled versions of the Demo and IPythonDemo
31 31 classes.
32 32
33 33 Inheritance diagram:
34 34
35 35 .. inheritance-diagram:: IPython.lib.demo
36 36 :parts: 3
37 37
38 38 Subclassing
39 39 -----------
40 40
41 41 The classes here all include a few methods meant to make customization by
42 42 subclassing more convenient. Their docstrings below have some more details:
43 43
44 44 - marquee(): generates a marquee to provide visible on-screen markers at each
45 45 block start and end.
46 46
47 47 - pre_cmd(): run right before the execution of each block.
48 48
49 49 - post_cmd(): run right after the execution of each block. If the block
50 50 raises an exception, this is NOT called.
51 51
52 52
53 53 Operation
54 54 ---------
55 55
56 56 The file is run in its own empty namespace (though you can pass it a string of
57 57 arguments as if in a command line environment, and it will see those as
58 58 sys.argv). But at each stop, the global IPython namespace is updated with the
59 59 current internal demo namespace, so you can work interactively with the data
60 60 accumulated so far.
61 61
62 62 By default, each block of code is printed (with syntax highlighting) before
63 63 executing it and you have to confirm execution. This is intended to show the
64 64 code to an audience first so you can discuss it, and only proceed with
65 65 execution once you agree. There are a few tags which allow you to modify this
66 66 behavior.
67 67
68 68 The supported tags are:
69 69
70 70 # <demo> stop
71 71
72 72 Defines block boundaries, the points where IPython stops execution of the
73 73 file and returns to the interactive prompt.
74 74
75 75 You can optionally mark the stop tag with extra dashes before and after the
76 76 word 'stop', to help visually distinguish the blocks in a text editor:
77 77
78 78 # <demo> --- stop ---
79 79
80 80
81 81 # <demo> silent
82 82
83 83 Make a block execute silently (and hence automatically). Typically used in
84 84 cases where you have some boilerplate or initialization code which you need
85 85 executed but do not want to be seen in the demo.
86 86
87 87 # <demo> auto
88 88
89 89 Make a block execute automatically, but still being printed. Useful for
90 90 simple code which does not warrant discussion, since it avoids the extra
91 91 manual confirmation.
92 92
93 93 # <demo> auto_all
94 94
95 95 This tag can _only_ be in the first block, and if given it overrides the
96 96 individual auto tags to make the whole demo fully automatic (no block asks
97 97 for confirmation). It can also be given at creation time (or the attribute
98 98 set later) to override what's in the file.
99 99
100 100 While _any_ python file can be run as a Demo instance, if there are no stop
101 101 tags the whole file will run in a single block (no different that calling
102 102 first %pycat and then %run). The minimal markup to make this useful is to
103 103 place a set of stop tags; the other tags are only there to let you fine-tune
104 104 the execution.
105 105
106 106 This is probably best explained with the simple example file below. You can
107 107 copy this into a file named ex_demo.py, and try running it via::
108 108
109 109 from IPython.demo import Demo
110 110 d = Demo('ex_demo.py')
111 111 d()
112 112
113 113 Each time you call the demo object, it runs the next block. The demo object
114 114 has a few useful methods for navigation, like again(), edit(), jump(), seek()
115 115 and back(). It can be reset for a new run via reset() or reloaded from disk
116 116 (in case you've edited the source) via reload(). See their docstrings below.
117 117
118 118 Note: To make this simpler to explore, a file called "demo-exercizer.py" has
119 119 been added to the "docs/examples/core" directory. Just cd to this directory in
120 120 an IPython session, and type::
121 121
122 122 %run demo-exercizer.py
123 123
124 124 and then follow the directions.
125 125
126 126 Example
127 127 -------
128 128
129 129 The following is a very simple example of a valid demo file.
130 130
131 131 ::
132 132
133 133 #################### EXAMPLE DEMO <ex_demo.py> ###############################
134 134 '''A simple interactive demo to illustrate the use of IPython's Demo class.'''
135 135
136 136 print 'Hello, welcome to an interactive IPython demo.'
137 137
138 138 # The mark below defines a block boundary, which is a point where IPython will
139 139 # stop execution and return to the interactive prompt. The dashes are actually
140 140 # optional and used only as a visual aid to clearly separate blocks while
141 141 # editing the demo code.
142 142 # <demo> stop
143 143
144 144 x = 1
145 145 y = 2
146 146
147 147 # <demo> stop
148 148
149 149 # the mark below makes this block as silent
150 150 # <demo> silent
151 151
152 152 print 'This is a silent block, which gets executed but not printed.'
153 153
154 154 # <demo> stop
155 155 # <demo> auto
156 156 print 'This is an automatic block.'
157 157 print 'It is executed without asking for confirmation, but printed.'
158 158 z = x+y
159 159
160 160 print 'z=',x
161 161
162 162 # <demo> stop
163 163 # This is just another normal block.
164 164 print 'z is now:', z
165 165
166 166 print 'bye!'
167 167 ################### END EXAMPLE DEMO <ex_demo.py> ############################
168 168 """
169 169
170 170 from __future__ import unicode_literals
171 171
172 172 #*****************************************************************************
173 173 # Copyright (C) 2005-2006 Fernando Perez. <Fernando.Perez@colorado.edu>
174 174 #
175 175 # Distributed under the terms of the BSD License. The full license is in
176 176 # the file COPYING, distributed as part of this software.
177 177 #
178 178 #*****************************************************************************
179 179 from __future__ import print_function
180 180
181 181 import os
182 182 import re
183 183 import shlex
184 184 import sys
185 185
186 186 from IPython.utils import io
187 187 from IPython.utils.text import marquee
188 188 from IPython.utils import openpy
189 189 __all__ = ['Demo','IPythonDemo','LineDemo','IPythonLineDemo','DemoError']
190 190
191 191 class DemoError(Exception): pass
192 192
193 193 def re_mark(mark):
194 194 return re.compile(r'^\s*#\s+<demo>\s+%s\s*$' % mark,re.MULTILINE)
195 195
196 196 class Demo(object):
197 197
198 198 re_stop = re_mark('-*\s?stop\s?-*')
199 199 re_silent = re_mark('silent')
200 200 re_auto = re_mark('auto')
201 201 re_auto_all = re_mark('auto_all')
202 202
203 203 def __init__(self,src,title='',arg_str='',auto_all=None):
204 204 """Make a new demo object. To run the demo, simply call the object.
205 205
206 206 See the module docstring for full details and an example (you can use
207 207 IPython.Demo? in IPython to see it).
208 208
209 209 Inputs:
210 210
211 211 - src is either a file, or file-like object, or a
212 212 string that can be resolved to a filename.
213 213
214 214 Optional inputs:
215 215
216 216 - title: a string to use as the demo name. Of most use when the demo
217 217 you are making comes from an object that has no filename, or if you
218 218 want an alternate denotation distinct from the filename.
219 219
220 220 - arg_str(''): a string of arguments, internally converted to a list
221 221 just like sys.argv, so the demo script can see a similar
222 222 environment.
223 223
224 224 - auto_all(None): global flag to run all blocks automatically without
225 225 confirmation. This attribute overrides the block-level tags and
226 226 applies to the whole demo. It is an attribute of the object, and
227 227 can be changed at runtime simply by reassigning it to a boolean
228 228 value.
229 229 """
230 230 if hasattr(src, "read"):
231 231 # It seems to be a file or a file-like object
232 232 self.fname = "from a file-like object"
233 233 if title == '':
234 234 self.title = "from a file-like object"
235 235 else:
236 236 self.title = title
237 237 else:
238 238 # Assume it's a string or something that can be converted to one
239 239 self.fname = src
240 240 if title == '':
241 241 (filepath, filename) = os.path.split(src)
242 242 self.title = filename
243 243 else:
244 244 self.title = title
245 245 self.sys_argv = [src] + shlex.split(arg_str)
246 246 self.auto_all = auto_all
247 247 self.src = src
248 248
249 249 # get a few things from ipython. While it's a bit ugly design-wise,
250 250 # it ensures that things like color scheme and the like are always in
251 251 # sync with the ipython mode being used. This class is only meant to
252 252 # be used inside ipython anyways, so it's OK.
253 253 ip = get_ipython() # this is in builtins whenever IPython is running
254 254 self.ip_ns = ip.user_ns
255 255 self.ip_colorize = ip.pycolorize
256 256 self.ip_showtb = ip.showtraceback
257 257 self.ip_run_cell = ip.run_cell
258 258 self.shell = ip
259 259
260 260 # load user data and initialize data structures
261 261 self.reload()
262 262
263 263 def fload(self):
264 264 """Load file object."""
265 265 # read data and parse into blocks
266 266 if hasattr(self, 'fobj') and self.fobj is not None:
267 267 self.fobj.close()
268 268 if hasattr(self.src, "read"):
269 269 # It seems to be a file or a file-like object
270 270 self.fobj = self.src
271 271 else:
272 272 # Assume it's a string or something that can be converted to one
273 273 self.fobj = openpy.open(self.fname)
274 274
275 275 def reload(self):
276 276 """Reload source from disk and initialize state."""
277 277 self.fload()
278 278
279 279 self.src = "".join(openpy.strip_encoding_cookie(self.fobj))
280 280 src_b = [b.strip() for b in self.re_stop.split(self.src) if b]
281 281 self._silent = [bool(self.re_silent.findall(b)) for b in src_b]
282 282 self._auto = [bool(self.re_auto.findall(b)) for b in src_b]
283 283
284 284 # if auto_all is not given (def. None), we read it from the file
285 285 if self.auto_all is None:
286 286 self.auto_all = bool(self.re_auto_all.findall(src_b[0]))
287 287 else:
288 288 self.auto_all = bool(self.auto_all)
289 289
290 290 # Clean the sources from all markup so it doesn't get displayed when
291 291 # running the demo
292 292 src_blocks = []
293 293 auto_strip = lambda s: self.re_auto.sub('',s)
294 294 for i,b in enumerate(src_b):
295 295 if self._auto[i]:
296 296 src_blocks.append(auto_strip(b))
297 297 else:
298 298 src_blocks.append(b)
299 299 # remove the auto_all marker
300 300 src_blocks[0] = self.re_auto_all.sub('',src_blocks[0])
301 301
302 302 self.nblocks = len(src_blocks)
303 303 self.src_blocks = src_blocks
304 304
305 305 # also build syntax-highlighted source
306 306 self.src_blocks_colored = map(self.ip_colorize,self.src_blocks)
307 307
308 308 # ensure clean namespace and seek offset
309 309 self.reset()
310 310
311 311 def reset(self):
312 312 """Reset the namespace and seek pointer to restart the demo"""
313 313 self.user_ns = {}
314 314 self.finished = False
315 315 self.block_index = 0
316 316
317 317 def _validate_index(self,index):
318 318 if index<0 or index>=self.nblocks:
319 319 raise ValueError('invalid block index %s' % index)
320 320
321 321 def _get_index(self,index):
322 322 """Get the current block index, validating and checking status.
323 323
324 324 Returns None if the demo is finished"""
325 325
326 326 if index is None:
327 327 if self.finished:
328 328 print('Demo finished. Use <demo_name>.reset() if you want to rerun it.', file=io.stdout)
329 329 return None
330 330 index = self.block_index
331 331 else:
332 332 self._validate_index(index)
333 333 return index
334 334
335 335 def seek(self,index):
336 336 """Move the current seek pointer to the given block.
337 337
338 338 You can use negative indices to seek from the end, with identical
339 339 semantics to those of Python lists."""
340 340 if index<0:
341 341 index = self.nblocks + index
342 342 self._validate_index(index)
343 343 self.block_index = index
344 344 self.finished = False
345 345
346 346 def back(self,num=1):
347 347 """Move the seek pointer back num blocks (default is 1)."""
348 348 self.seek(self.block_index-num)
349 349
350 350 def jump(self,num=1):
351 351 """Jump a given number of blocks relative to the current one.
352 352
353 353 The offset can be positive or negative, defaults to 1."""
354 354 self.seek(self.block_index+num)
355 355
356 356 def again(self):
357 357 """Move the seek pointer back one block and re-execute."""
358 358 self.back(1)
359 359 self()
360 360
361 361 def edit(self,index=None):
362 362 """Edit a block.
363 363
364 364 If no number is given, use the last block executed.
365 365
366 366 This edits the in-memory copy of the demo, it does NOT modify the
367 367 original source file. If you want to do that, simply open the file in
368 368 an editor and use reload() when you make changes to the file. This
369 369 method is meant to let you change a block during a demonstration for
370 370 explanatory purposes, without damaging your original script."""
371 371
372 372 index = self._get_index(index)
373 373 if index is None:
374 374 return
375 375 # decrease the index by one (unless we're at the very beginning), so
376 376 # that the default demo.edit() call opens up the sblock we've last run
377 377 if index>0:
378 378 index -= 1
379 379
380 380 filename = self.shell.mktempfile(self.src_blocks[index])
381 381 self.shell.hooks.editor(filename,1)
382 382 with open(filename, 'r') as f:
383 383 new_block = f.read()
384 384 # update the source and colored block
385 385 self.src_blocks[index] = new_block
386 386 self.src_blocks_colored[index] = self.ip_colorize(new_block)
387 387 self.block_index = index
388 388 # call to run with the newly edited index
389 389 self()
390 390
391 391 def show(self,index=None):
392 392 """Show a single block on screen"""
393 393
394 394 index = self._get_index(index)
395 395 if index is None:
396 396 return
397 397
398 398 print(self.marquee('<%s> block # %s (%s remaining)' %
399 399 (self.title,index,self.nblocks-index-1)), file=io.stdout)
400 400 print((self.src_blocks_colored[index]), file=io.stdout)
401 401 sys.stdout.flush()
402 402
403 403 def show_all(self):
404 404 """Show entire demo on screen, block by block"""
405 405
406 406 fname = self.title
407 407 title = self.title
408 408 nblocks = self.nblocks
409 409 silent = self._silent
410 410 marquee = self.marquee
411 411 for index,block in enumerate(self.src_blocks_colored):
412 412 if silent[index]:
413 413 print(marquee('<%s> SILENT block # %s (%s remaining)' %
414 414 (title,index,nblocks-index-1)), file=io.stdout)
415 415 else:
416 416 print(marquee('<%s> block # %s (%s remaining)' %
417 417 (title,index,nblocks-index-1)), file=io.stdout)
418 418 print(block, end=' ', file=io.stdout)
419 419 sys.stdout.flush()
420 420
421 421 def run_cell(self,source):
422 422 """Execute a string with one or more lines of code"""
423 423
424 exec source in self.user_ns
424 exec(source, self.user_ns)
425 425
426 426 def __call__(self,index=None):
427 427 """run a block of the demo.
428 428
429 429 If index is given, it should be an integer >=1 and <= nblocks. This
430 430 means that the calling convention is one off from typical Python
431 431 lists. The reason for the inconsistency is that the demo always
432 432 prints 'Block n/N, and N is the total, so it would be very odd to use
433 433 zero-indexing here."""
434 434
435 435 index = self._get_index(index)
436 436 if index is None:
437 437 return
438 438 try:
439 439 marquee = self.marquee
440 440 next_block = self.src_blocks[index]
441 441 self.block_index += 1
442 442 if self._silent[index]:
443 443 print(marquee('Executing silent block # %s (%s remaining)' %
444 444 (index,self.nblocks-index-1)), file=io.stdout)
445 445 else:
446 446 self.pre_cmd()
447 447 self.show(index)
448 448 if self.auto_all or self._auto[index]:
449 449 print(marquee('output:'), file=io.stdout)
450 450 else:
451 451 print(marquee('Press <q> to quit, <Enter> to execute...'), end=' ', file=io.stdout)
452 452 ans = raw_input().strip()
453 453 if ans:
454 454 print(marquee('Block NOT executed'), file=io.stdout)
455 455 return
456 456 try:
457 457 save_argv = sys.argv
458 458 sys.argv = self.sys_argv
459 459 self.run_cell(next_block)
460 460 self.post_cmd()
461 461 finally:
462 462 sys.argv = save_argv
463 463
464 464 except:
465 465 self.ip_showtb(filename=self.fname)
466 466 else:
467 467 self.ip_ns.update(self.user_ns)
468 468
469 469 if self.block_index == self.nblocks:
470 470 mq1 = self.marquee('END OF DEMO')
471 471 if mq1:
472 472 # avoid spurious print >>io.stdout,s if empty marquees are used
473 473 print(file=io.stdout)
474 474 print(mq1, file=io.stdout)
475 475 print(self.marquee('Use <demo_name>.reset() if you want to rerun it.'), file=io.stdout)
476 476 self.finished = True
477 477
478 478 # These methods are meant to be overridden by subclasses who may wish to
479 479 # customize the behavior of of their demos.
480 480 def marquee(self,txt='',width=78,mark='*'):
481 481 """Return the input string centered in a 'marquee'."""
482 482 return marquee(txt,width,mark)
483 483
484 484 def pre_cmd(self):
485 485 """Method called before executing each block."""
486 486 pass
487 487
488 488 def post_cmd(self):
489 489 """Method called after executing each block."""
490 490 pass
491 491
492 492
493 493 class IPythonDemo(Demo):
494 494 """Class for interactive demos with IPython's input processing applied.
495 495
496 496 This subclasses Demo, but instead of executing each block by the Python
497 497 interpreter (via exec), it actually calls IPython on it, so that any input
498 498 filters which may be in place are applied to the input block.
499 499
500 500 If you have an interactive environment which exposes special input
501 501 processing, you can use this class instead to write demo scripts which
502 502 operate exactly as if you had typed them interactively. The default Demo
503 503 class requires the input to be valid, pure Python code.
504 504 """
505 505
506 506 def run_cell(self,source):
507 507 """Execute a string with one or more lines of code"""
508 508
509 509 self.shell.run_cell(source)
510 510
511 511 class LineDemo(Demo):
512 512 """Demo where each line is executed as a separate block.
513 513
514 514 The input script should be valid Python code.
515 515
516 516 This class doesn't require any markup at all, and it's meant for simple
517 517 scripts (with no nesting or any kind of indentation) which consist of
518 518 multiple lines of input to be executed, one at a time, as if they had been
519 519 typed in the interactive prompt.
520 520
521 521 Note: the input can not have *any* indentation, which means that only
522 522 single-lines of input are accepted, not even function definitions are
523 523 valid."""
524 524
525 525 def reload(self):
526 526 """Reload source from disk and initialize state."""
527 527 # read data and parse into blocks
528 528 self.fload()
529 529 lines = self.fobj.readlines()
530 530 src_b = [l for l in lines if l.strip()]
531 531 nblocks = len(src_b)
532 532 self.src = ''.join(lines)
533 533 self._silent = [False]*nblocks
534 534 self._auto = [True]*nblocks
535 535 self.auto_all = True
536 536 self.nblocks = nblocks
537 537 self.src_blocks = src_b
538 538
539 539 # also build syntax-highlighted source
540 540 self.src_blocks_colored = map(self.ip_colorize,self.src_blocks)
541 541
542 542 # ensure clean namespace and seek offset
543 543 self.reset()
544 544
545 545
546 546 class IPythonLineDemo(IPythonDemo,LineDemo):
547 547 """Variant of the LineDemo class whose input is processed by IPython."""
548 548 pass
549 549
550 550
551 551 class ClearMixin(object):
552 552 """Use this mixin to make Demo classes with less visual clutter.
553 553
554 554 Demos using this mixin will clear the screen before every block and use
555 555 blank marquees.
556 556
557 557 Note that in order for the methods defined here to actually override those
558 558 of the classes it's mixed with, it must go /first/ in the inheritance
559 559 tree. For example:
560 560
561 561 class ClearIPDemo(ClearMixin,IPythonDemo): pass
562 562
563 563 will provide an IPythonDemo class with the mixin's features.
564 564 """
565 565
566 566 def marquee(self,txt='',width=78,mark='*'):
567 567 """Blank marquee that returns '' no matter what the input."""
568 568 return ''
569 569
570 570 def pre_cmd(self):
571 571 """Method called before executing each block.
572 572
573 573 This one simply clears the screen."""
574 574 from IPython.utils.terminal import term_clear
575 575 term_clear()
576 576
577 577 class ClearDemo(ClearMixin,Demo):
578 578 pass
579 579
580 580
581 581 class ClearIPDemo(ClearMixin,IPythonDemo):
582 582 pass
@@ -1,547 +1,547 b''
1 1 #!/usr/bin/env python
2 2 # encoding: utf-8
3 3 """
4 4 The IPython controller application.
5 5
6 6 Authors:
7 7
8 8 * Brian Granger
9 9 * MinRK
10 10
11 11 """
12 12
13 13 #-----------------------------------------------------------------------------
14 14 # Copyright (C) 2008 The IPython Development Team
15 15 #
16 16 # Distributed under the terms of the BSD License. The full license is in
17 17 # the file COPYING, distributed as part of this software.
18 18 #-----------------------------------------------------------------------------
19 19
20 20 #-----------------------------------------------------------------------------
21 21 # Imports
22 22 #-----------------------------------------------------------------------------
23 23
24 24 from __future__ import with_statement
25 25
26 26 import json
27 27 import os
28 28 import stat
29 29 import sys
30 30
31 31 from multiprocessing import Process
32 32 from signal import signal, SIGINT, SIGABRT, SIGTERM
33 33
34 34 import zmq
35 35 from zmq.devices import ProcessMonitoredQueue
36 36 from zmq.log.handlers import PUBHandler
37 37
38 38 from IPython.core.profiledir import ProfileDir
39 39
40 40 from IPython.parallel.apps.baseapp import (
41 41 BaseParallelApplication,
42 42 base_aliases,
43 43 base_flags,
44 44 catch_config_error,
45 45 )
46 46 from IPython.utils.importstring import import_item
47 47 from IPython.utils.localinterfaces import localhost, public_ips
48 48 from IPython.utils.traitlets import Instance, Unicode, Bool, List, Dict, TraitError
49 49
50 50 from IPython.kernel.zmq.session import (
51 51 Session, session_aliases, session_flags, default_secure
52 52 )
53 53
54 54 from IPython.parallel.controller.heartmonitor import HeartMonitor
55 55 from IPython.parallel.controller.hub import HubFactory
56 56 from IPython.parallel.controller.scheduler import TaskScheduler,launch_scheduler
57 57 from IPython.parallel.controller.dictdb import DictDB
58 58
59 59 from IPython.parallel.util import split_url, disambiguate_url, set_hwm
60 60
61 61 # conditional import of SQLiteDB / MongoDB backend class
62 62 real_dbs = []
63 63
64 64 try:
65 65 from IPython.parallel.controller.sqlitedb import SQLiteDB
66 66 except ImportError:
67 67 pass
68 68 else:
69 69 real_dbs.append(SQLiteDB)
70 70
71 71 try:
72 72 from IPython.parallel.controller.mongodb import MongoDB
73 73 except ImportError:
74 74 pass
75 75 else:
76 76 real_dbs.append(MongoDB)
77 77
78 78
79 79
80 80 #-----------------------------------------------------------------------------
81 81 # Module level variables
82 82 #-----------------------------------------------------------------------------
83 83
84 84
85 85 _description = """Start the IPython controller for parallel computing.
86 86
87 87 The IPython controller provides a gateway between the IPython engines and
88 88 clients. The controller needs to be started before the engines and can be
89 89 configured using command line options or using a cluster directory. Cluster
90 90 directories contain config, log and security files and are usually located in
91 91 your ipython directory and named as "profile_name". See the `profile`
92 92 and `profile-dir` options for details.
93 93 """
94 94
95 95 _examples = """
96 96 ipcontroller --ip=192.168.0.1 --port=1000 # listen on ip, port for engines
97 97 ipcontroller --scheme=pure # use the pure zeromq scheduler
98 98 """
99 99
100 100
101 101 #-----------------------------------------------------------------------------
102 102 # The main application
103 103 #-----------------------------------------------------------------------------
104 104 flags = {}
105 105 flags.update(base_flags)
106 106 flags.update({
107 107 'usethreads' : ( {'IPControllerApp' : {'use_threads' : True}},
108 108 'Use threads instead of processes for the schedulers'),
109 109 'sqlitedb' : ({'HubFactory' : {'db_class' : 'IPython.parallel.controller.sqlitedb.SQLiteDB'}},
110 110 'use the SQLiteDB backend'),
111 111 'mongodb' : ({'HubFactory' : {'db_class' : 'IPython.parallel.controller.mongodb.MongoDB'}},
112 112 'use the MongoDB backend'),
113 113 'dictdb' : ({'HubFactory' : {'db_class' : 'IPython.parallel.controller.dictdb.DictDB'}},
114 114 'use the in-memory DictDB backend'),
115 115 'nodb' : ({'HubFactory' : {'db_class' : 'IPython.parallel.controller.dictdb.NoDB'}},
116 116 """use dummy DB backend, which doesn't store any information.
117 117
118 118 This is the default as of IPython 0.13.
119 119
120 120 To enable delayed or repeated retrieval of results from the Hub,
121 121 select one of the true db backends.
122 122 """),
123 123 'reuse' : ({'IPControllerApp' : {'reuse_files' : True}},
124 124 'reuse existing json connection files'),
125 125 'restore' : ({'IPControllerApp' : {'restore_engines' : True, 'reuse_files' : True}},
126 126 'Attempt to restore engines from a JSON file. '
127 127 'For use when resuming a crashed controller'),
128 128 })
129 129
130 130 flags.update(session_flags)
131 131
132 132 aliases = dict(
133 133 ssh = 'IPControllerApp.ssh_server',
134 134 enginessh = 'IPControllerApp.engine_ssh_server',
135 135 location = 'IPControllerApp.location',
136 136
137 137 url = 'HubFactory.url',
138 138 ip = 'HubFactory.ip',
139 139 transport = 'HubFactory.transport',
140 140 port = 'HubFactory.regport',
141 141
142 142 ping = 'HeartMonitor.period',
143 143
144 144 scheme = 'TaskScheduler.scheme_name',
145 145 hwm = 'TaskScheduler.hwm',
146 146 )
147 147 aliases.update(base_aliases)
148 148 aliases.update(session_aliases)
149 149
150 150 class IPControllerApp(BaseParallelApplication):
151 151
152 152 name = u'ipcontroller'
153 153 description = _description
154 154 examples = _examples
155 155 classes = [ProfileDir, Session, HubFactory, TaskScheduler, HeartMonitor, DictDB] + real_dbs
156 156
157 157 # change default to True
158 158 auto_create = Bool(True, config=True,
159 159 help="""Whether to create profile dir if it doesn't exist.""")
160 160
161 161 reuse_files = Bool(False, config=True,
162 162 help="""Whether to reuse existing json connection files.
163 163 If False, connection files will be removed on a clean exit.
164 164 """
165 165 )
166 166 restore_engines = Bool(False, config=True,
167 167 help="""Reload engine state from JSON file
168 168 """
169 169 )
170 170 ssh_server = Unicode(u'', config=True,
171 171 help="""ssh url for clients to use when connecting to the Controller
172 172 processes. It should be of the form: [user@]server[:port]. The
173 173 Controller's listening addresses must be accessible from the ssh server""",
174 174 )
175 175 engine_ssh_server = Unicode(u'', config=True,
176 176 help="""ssh url for engines to use when connecting to the Controller
177 177 processes. It should be of the form: [user@]server[:port]. The
178 178 Controller's listening addresses must be accessible from the ssh server""",
179 179 )
180 180 location = Unicode(u'', config=True,
181 181 help="""The external IP or domain name of the Controller, used for disambiguating
182 182 engine and client connections.""",
183 183 )
184 184 import_statements = List([], config=True,
185 185 help="import statements to be run at startup. Necessary in some environments"
186 186 )
187 187
188 188 use_threads = Bool(False, config=True,
189 189 help='Use threads instead of processes for the schedulers',
190 190 )
191 191
192 192 engine_json_file = Unicode('ipcontroller-engine.json', config=True,
193 193 help="JSON filename where engine connection info will be stored.")
194 194 client_json_file = Unicode('ipcontroller-client.json', config=True,
195 195 help="JSON filename where client connection info will be stored.")
196 196
197 197 def _cluster_id_changed(self, name, old, new):
198 198 super(IPControllerApp, self)._cluster_id_changed(name, old, new)
199 199 self.engine_json_file = "%s-engine.json" % self.name
200 200 self.client_json_file = "%s-client.json" % self.name
201 201
202 202
203 203 # internal
204 204 children = List()
205 205 mq_class = Unicode('zmq.devices.ProcessMonitoredQueue')
206 206
207 207 def _use_threads_changed(self, name, old, new):
208 208 self.mq_class = 'zmq.devices.%sMonitoredQueue'%('Thread' if new else 'Process')
209 209
210 210 write_connection_files = Bool(True,
211 211 help="""Whether to write connection files to disk.
212 212 True in all cases other than runs with `reuse_files=True` *after the first*
213 213 """
214 214 )
215 215
216 216 aliases = Dict(aliases)
217 217 flags = Dict(flags)
218 218
219 219
220 220 def save_connection_dict(self, fname, cdict):
221 221 """save a connection dict to json file."""
222 222 c = self.config
223 223 url = cdict['registration']
224 224 location = cdict['location']
225 225
226 226 if not location:
227 227 if public_ips():
228 228 location = public_ips()[-1]
229 229 else:
230 230 self.log.warn("Could not identify this machine's IP, assuming %s."
231 231 " You may need to specify '--location=<external_ip_address>' to help"
232 232 " IPython decide when to connect via loopback." % localhost() )
233 233 location = localhost()
234 234 cdict['location'] = location
235 235 fname = os.path.join(self.profile_dir.security_dir, fname)
236 236 self.log.info("writing connection info to %s", fname)
237 237 with open(fname, 'w') as f:
238 238 f.write(json.dumps(cdict, indent=2))
239 239 os.chmod(fname, stat.S_IRUSR|stat.S_IWUSR)
240 240
241 241 def load_config_from_json(self):
242 242 """load config from existing json connector files."""
243 243 c = self.config
244 244 self.log.debug("loading config from JSON")
245 245
246 246 # load engine config
247 247
248 248 fname = os.path.join(self.profile_dir.security_dir, self.engine_json_file)
249 249 self.log.info("loading connection info from %s", fname)
250 250 with open(fname) as f:
251 251 ecfg = json.loads(f.read())
252 252
253 253 # json gives unicode, Session.key wants bytes
254 254 c.Session.key = ecfg['key'].encode('ascii')
255 255
256 256 xport,ip = ecfg['interface'].split('://')
257 257
258 258 c.HubFactory.engine_ip = ip
259 259 c.HubFactory.engine_transport = xport
260 260
261 261 self.location = ecfg['location']
262 262 if not self.engine_ssh_server:
263 263 self.engine_ssh_server = ecfg['ssh']
264 264
265 265 # load client config
266 266
267 267 fname = os.path.join(self.profile_dir.security_dir, self.client_json_file)
268 268 self.log.info("loading connection info from %s", fname)
269 269 with open(fname) as f:
270 270 ccfg = json.loads(f.read())
271 271
272 272 for key in ('key', 'registration', 'pack', 'unpack', 'signature_scheme'):
273 273 assert ccfg[key] == ecfg[key], "mismatch between engine and client info: %r" % key
274 274
275 275 xport,addr = ccfg['interface'].split('://')
276 276
277 277 c.HubFactory.client_transport = xport
278 278 c.HubFactory.client_ip = ip
279 279 if not self.ssh_server:
280 280 self.ssh_server = ccfg['ssh']
281 281
282 282 # load port config:
283 283 c.HubFactory.regport = ecfg['registration']
284 284 c.HubFactory.hb = (ecfg['hb_ping'], ecfg['hb_pong'])
285 285 c.HubFactory.control = (ccfg['control'], ecfg['control'])
286 286 c.HubFactory.mux = (ccfg['mux'], ecfg['mux'])
287 287 c.HubFactory.task = (ccfg['task'], ecfg['task'])
288 288 c.HubFactory.iopub = (ccfg['iopub'], ecfg['iopub'])
289 289 c.HubFactory.notifier_port = ccfg['notification']
290 290
291 291 def cleanup_connection_files(self):
292 292 if self.reuse_files:
293 293 self.log.debug("leaving JSON connection files for reuse")
294 294 return
295 295 self.log.debug("cleaning up JSON connection files")
296 296 for f in (self.client_json_file, self.engine_json_file):
297 297 f = os.path.join(self.profile_dir.security_dir, f)
298 298 try:
299 299 os.remove(f)
300 300 except Exception as e:
301 301 self.log.error("Failed to cleanup connection file: %s", e)
302 302 else:
303 303 self.log.debug(u"removed %s", f)
304 304
305 305 def load_secondary_config(self):
306 306 """secondary config, loading from JSON and setting defaults"""
307 307 if self.reuse_files:
308 308 try:
309 309 self.load_config_from_json()
310 310 except (AssertionError,IOError) as e:
311 311 self.log.error("Could not load config from JSON: %s" % e)
312 312 else:
313 313 # successfully loaded config from JSON, and reuse=True
314 314 # no need to wite back the same file
315 315 self.write_connection_files = False
316 316
317 317 # switch Session.key default to secure
318 318 default_secure(self.config)
319 319 self.log.debug("Config changed")
320 320 self.log.debug(repr(self.config))
321 321
322 322 def init_hub(self):
323 323 c = self.config
324 324
325 325 self.do_import_statements()
326 326
327 327 try:
328 328 self.factory = HubFactory(config=c, log=self.log)
329 329 # self.start_logging()
330 330 self.factory.init_hub()
331 331 except TraitError:
332 332 raise
333 333 except Exception:
334 334 self.log.error("Couldn't construct the Controller", exc_info=True)
335 335 self.exit(1)
336 336
337 337 if self.write_connection_files:
338 338 # save to new json config files
339 339 f = self.factory
340 340 base = {
341 341 'key' : f.session.key.decode('ascii'),
342 342 'location' : self.location,
343 343 'pack' : f.session.packer,
344 344 'unpack' : f.session.unpacker,
345 345 'signature_scheme' : f.session.signature_scheme,
346 346 }
347 347
348 348 cdict = {'ssh' : self.ssh_server}
349 349 cdict.update(f.client_info)
350 350 cdict.update(base)
351 351 self.save_connection_dict(self.client_json_file, cdict)
352 352
353 353 edict = {'ssh' : self.engine_ssh_server}
354 354 edict.update(f.engine_info)
355 355 edict.update(base)
356 356 self.save_connection_dict(self.engine_json_file, edict)
357 357
358 358 fname = "engines%s.json" % self.cluster_id
359 359 self.factory.hub.engine_state_file = os.path.join(self.profile_dir.log_dir, fname)
360 360 if self.restore_engines:
361 361 self.factory.hub._load_engine_state()
362 362
363 363 def init_schedulers(self):
364 364 children = self.children
365 365 mq = import_item(str(self.mq_class))
366 366
367 367 f = self.factory
368 368 ident = f.session.bsession
369 369 # disambiguate url, in case of *
370 370 monitor_url = disambiguate_url(f.monitor_url)
371 371 # maybe_inproc = 'inproc://monitor' if self.use_threads else monitor_url
372 372 # IOPub relay (in a Process)
373 373 q = mq(zmq.PUB, zmq.SUB, zmq.PUB, b'N/A',b'iopub')
374 374 q.bind_in(f.client_url('iopub'))
375 375 q.setsockopt_in(zmq.IDENTITY, ident + b"_iopub")
376 376 q.bind_out(f.engine_url('iopub'))
377 377 q.setsockopt_out(zmq.SUBSCRIBE, b'')
378 378 q.connect_mon(monitor_url)
379 379 q.daemon=True
380 380 children.append(q)
381 381
382 382 # Multiplexer Queue (in a Process)
383 383 q = mq(zmq.ROUTER, zmq.ROUTER, zmq.PUB, b'in', b'out')
384 384
385 385 q.bind_in(f.client_url('mux'))
386 386 q.setsockopt_in(zmq.IDENTITY, b'mux_in')
387 387 q.bind_out(f.engine_url('mux'))
388 388 q.setsockopt_out(zmq.IDENTITY, b'mux_out')
389 389 q.connect_mon(monitor_url)
390 390 q.daemon=True
391 391 children.append(q)
392 392
393 393 # Control Queue (in a Process)
394 394 q = mq(zmq.ROUTER, zmq.ROUTER, zmq.PUB, b'incontrol', b'outcontrol')
395 395 q.bind_in(f.client_url('control'))
396 396 q.setsockopt_in(zmq.IDENTITY, b'control_in')
397 397 q.bind_out(f.engine_url('control'))
398 398 q.setsockopt_out(zmq.IDENTITY, b'control_out')
399 399 q.connect_mon(monitor_url)
400 400 q.daemon=True
401 401 children.append(q)
402 402 if 'TaskScheduler.scheme_name' in self.config:
403 403 scheme = self.config.TaskScheduler.scheme_name
404 404 else:
405 405 scheme = TaskScheduler.scheme_name.get_default_value()
406 406 # Task Queue (in a Process)
407 407 if scheme == 'pure':
408 408 self.log.warn("task::using pure DEALER Task scheduler")
409 409 q = mq(zmq.ROUTER, zmq.DEALER, zmq.PUB, b'intask', b'outtask')
410 410 # q.setsockopt_out(zmq.HWM, hub.hwm)
411 411 q.bind_in(f.client_url('task'))
412 412 q.setsockopt_in(zmq.IDENTITY, b'task_in')
413 413 q.bind_out(f.engine_url('task'))
414 414 q.setsockopt_out(zmq.IDENTITY, b'task_out')
415 415 q.connect_mon(monitor_url)
416 416 q.daemon=True
417 417 children.append(q)
418 418 elif scheme == 'none':
419 419 self.log.warn("task::using no Task scheduler")
420 420
421 421 else:
422 422 self.log.info("task::using Python %s Task scheduler"%scheme)
423 423 sargs = (f.client_url('task'), f.engine_url('task'),
424 424 monitor_url, disambiguate_url(f.client_url('notification')),
425 425 disambiguate_url(f.client_url('registration')),
426 426 )
427 427 kwargs = dict(logname='scheduler', loglevel=self.log_level,
428 428 log_url = self.log_url, config=dict(self.config))
429 429 if 'Process' in self.mq_class:
430 430 # run the Python scheduler in a Process
431 431 q = Process(target=launch_scheduler, args=sargs, kwargs=kwargs)
432 432 q.daemon=True
433 433 children.append(q)
434 434 else:
435 435 # single-threaded Controller
436 436 kwargs['in_thread'] = True
437 437 launch_scheduler(*sargs, **kwargs)
438 438
439 439 # set unlimited HWM for all relay devices
440 440 if hasattr(zmq, 'SNDHWM'):
441 441 q = children[0]
442 442 q.setsockopt_in(zmq.RCVHWM, 0)
443 443 q.setsockopt_out(zmq.SNDHWM, 0)
444 444
445 445 for q in children[1:]:
446 446 if not hasattr(q, 'setsockopt_in'):
447 447 continue
448 448 q.setsockopt_in(zmq.SNDHWM, 0)
449 449 q.setsockopt_in(zmq.RCVHWM, 0)
450 450 q.setsockopt_out(zmq.SNDHWM, 0)
451 451 q.setsockopt_out(zmq.RCVHWM, 0)
452 452 q.setsockopt_mon(zmq.SNDHWM, 0)
453 453
454 454
455 455 def terminate_children(self):
456 456 child_procs = []
457 457 for child in self.children:
458 458 if isinstance(child, ProcessMonitoredQueue):
459 459 child_procs.append(child.launcher)
460 460 elif isinstance(child, Process):
461 461 child_procs.append(child)
462 462 if child_procs:
463 463 self.log.critical("terminating children...")
464 464 for child in child_procs:
465 465 try:
466 466 child.terminate()
467 467 except OSError:
468 468 # already dead
469 469 pass
470 470
471 471 def handle_signal(self, sig, frame):
472 472 self.log.critical("Received signal %i, shutting down", sig)
473 473 self.terminate_children()
474 474 self.loop.stop()
475 475
476 476 def init_signal(self):
477 477 for sig in (SIGINT, SIGABRT, SIGTERM):
478 478 signal(sig, self.handle_signal)
479 479
480 480 def do_import_statements(self):
481 481 statements = self.import_statements
482 482 for s in statements:
483 483 try:
484 484 self.log.msg("Executing statement: '%s'" % s)
485 exec s in globals(), locals()
485 exec(s, globals(), locals())
486 486 except:
487 487 self.log.msg("Error running statement: %s" % s)
488 488
489 489 def forward_logging(self):
490 490 if self.log_url:
491 491 self.log.info("Forwarding logging to %s"%self.log_url)
492 492 context = zmq.Context.instance()
493 493 lsock = context.socket(zmq.PUB)
494 494 lsock.connect(self.log_url)
495 495 handler = PUBHandler(lsock)
496 496 handler.root_topic = 'controller'
497 497 handler.setLevel(self.log_level)
498 498 self.log.addHandler(handler)
499 499
500 500 @catch_config_error
501 501 def initialize(self, argv=None):
502 502 super(IPControllerApp, self).initialize(argv)
503 503 self.forward_logging()
504 504 self.load_secondary_config()
505 505 self.init_hub()
506 506 self.init_schedulers()
507 507
508 508 def start(self):
509 509 # Start the subprocesses:
510 510 self.factory.start()
511 511 # children must be started before signals are setup,
512 512 # otherwise signal-handling will fire multiple times
513 513 for child in self.children:
514 514 child.start()
515 515 self.init_signal()
516 516
517 517 self.write_pid_file(overwrite=True)
518 518
519 519 try:
520 520 self.factory.loop.start()
521 521 except KeyboardInterrupt:
522 522 self.log.critical("Interrupted, Exiting...\n")
523 523 finally:
524 524 self.cleanup_connection_files()
525 525
526 526
527 527 def launch_new_instance(*args, **kwargs):
528 528 """Create and run the IPython controller"""
529 529 if sys.platform == 'win32':
530 530 # make sure we don't get called from a multiprocessing subprocess
531 531 # this can result in infinite Controllers being started on Windows
532 532 # which doesn't have a proper fork, so multiprocessing is wonky
533 533
534 534 # this only comes up when IPython has been installed using vanilla
535 535 # setuptools, and *not* distribute.
536 536 import multiprocessing
537 537 p = multiprocessing.current_process()
538 538 # the main process has name 'MainProcess'
539 539 # subprocesses will have names like 'Process-1'
540 540 if p.name != 'MainProcess':
541 541 # we are a subprocess, don't start another Controller!
542 542 return
543 543 return IPControllerApp.launch_instance(*args, **kwargs)
544 544
545 545
546 546 if __name__ == '__main__':
547 547 launch_new_instance()
@@ -1,384 +1,384 b''
1 1 #!/usr/bin/env python
2 2 # encoding: utf-8
3 3 """
4 4 The IPython engine application
5 5
6 6 Authors:
7 7
8 8 * Brian Granger
9 9 * MinRK
10 10
11 11 """
12 12
13 13 #-----------------------------------------------------------------------------
14 14 # Copyright (C) 2008-2011 The IPython Development Team
15 15 #
16 16 # Distributed under the terms of the BSD License. The full license is in
17 17 # the file COPYING, distributed as part of this software.
18 18 #-----------------------------------------------------------------------------
19 19
20 20 #-----------------------------------------------------------------------------
21 21 # Imports
22 22 #-----------------------------------------------------------------------------
23 23
24 24 import json
25 25 import os
26 26 import sys
27 27 import time
28 28
29 29 import zmq
30 30 from zmq.eventloop import ioloop
31 31
32 32 from IPython.core.profiledir import ProfileDir
33 33 from IPython.parallel.apps.baseapp import (
34 34 BaseParallelApplication,
35 35 base_aliases,
36 36 base_flags,
37 37 catch_config_error,
38 38 )
39 39 from IPython.kernel.zmq.log import EnginePUBHandler
40 40 from IPython.kernel.zmq.ipkernel import Kernel
41 41 from IPython.kernel.zmq.kernelapp import IPKernelApp
42 42 from IPython.kernel.zmq.session import (
43 43 Session, session_aliases, session_flags
44 44 )
45 45 from IPython.kernel.zmq.zmqshell import ZMQInteractiveShell
46 46
47 47 from IPython.config.configurable import Configurable
48 48
49 49 from IPython.parallel.engine.engine import EngineFactory
50 50 from IPython.parallel.util import disambiguate_ip_address
51 51
52 52 from IPython.utils.importstring import import_item
53 53 from IPython.utils.py3compat import cast_bytes
54 54 from IPython.utils.traitlets import Bool, Unicode, Dict, List, Float, Instance
55 55
56 56
57 57 #-----------------------------------------------------------------------------
58 58 # Module level variables
59 59 #-----------------------------------------------------------------------------
60 60
61 61 _description = """Start an IPython engine for parallel computing.
62 62
63 63 IPython engines run in parallel and perform computations on behalf of a client
64 64 and controller. A controller needs to be started before the engines. The
65 65 engine can be configured using command line options or using a cluster
66 66 directory. Cluster directories contain config, log and security files and are
67 67 usually located in your ipython directory and named as "profile_name".
68 68 See the `profile` and `profile-dir` options for details.
69 69 """
70 70
71 71 _examples = """
72 72 ipengine --ip=192.168.0.1 --port=1000 # connect to hub at ip and port
73 73 ipengine --log-to-file --log-level=DEBUG # log to a file with DEBUG verbosity
74 74 """
75 75
76 76 #-----------------------------------------------------------------------------
77 77 # MPI configuration
78 78 #-----------------------------------------------------------------------------
79 79
80 80 mpi4py_init = """from mpi4py import MPI as mpi
81 81 mpi.size = mpi.COMM_WORLD.Get_size()
82 82 mpi.rank = mpi.COMM_WORLD.Get_rank()
83 83 """
84 84
85 85
86 86 pytrilinos_init = """from PyTrilinos import Epetra
87 87 class SimpleStruct:
88 88 pass
89 89 mpi = SimpleStruct()
90 90 mpi.rank = 0
91 91 mpi.size = 0
92 92 """
93 93
94 94 class MPI(Configurable):
95 95 """Configurable for MPI initialization"""
96 96 use = Unicode('', config=True,
97 97 help='How to enable MPI (mpi4py, pytrilinos, or empty string to disable).'
98 98 )
99 99
100 100 def _use_changed(self, name, old, new):
101 101 # load default init script if it's not set
102 102 if not self.init_script:
103 103 self.init_script = self.default_inits.get(new, '')
104 104
105 105 init_script = Unicode('', config=True,
106 106 help="Initialization code for MPI")
107 107
108 108 default_inits = Dict({'mpi4py' : mpi4py_init, 'pytrilinos':pytrilinos_init},
109 109 config=True)
110 110
111 111
112 112 #-----------------------------------------------------------------------------
113 113 # Main application
114 114 #-----------------------------------------------------------------------------
115 115 aliases = dict(
116 116 file = 'IPEngineApp.url_file',
117 117 c = 'IPEngineApp.startup_command',
118 118 s = 'IPEngineApp.startup_script',
119 119
120 120 url = 'EngineFactory.url',
121 121 ssh = 'EngineFactory.sshserver',
122 122 sshkey = 'EngineFactory.sshkey',
123 123 ip = 'EngineFactory.ip',
124 124 transport = 'EngineFactory.transport',
125 125 port = 'EngineFactory.regport',
126 126 location = 'EngineFactory.location',
127 127
128 128 timeout = 'EngineFactory.timeout',
129 129
130 130 mpi = 'MPI.use',
131 131
132 132 )
133 133 aliases.update(base_aliases)
134 134 aliases.update(session_aliases)
135 135 flags = {}
136 136 flags.update(base_flags)
137 137 flags.update(session_flags)
138 138
139 139 class IPEngineApp(BaseParallelApplication):
140 140
141 141 name = 'ipengine'
142 142 description = _description
143 143 examples = _examples
144 144 classes = List([ZMQInteractiveShell, ProfileDir, Session, EngineFactory, Kernel, MPI])
145 145
146 146 startup_script = Unicode(u'', config=True,
147 147 help='specify a script to be run at startup')
148 148 startup_command = Unicode('', config=True,
149 149 help='specify a command to be run at startup')
150 150
151 151 url_file = Unicode(u'', config=True,
152 152 help="""The full location of the file containing the connection information for
153 153 the controller. If this is not given, the file must be in the
154 154 security directory of the cluster directory. This location is
155 155 resolved using the `profile` or `profile_dir` options.""",
156 156 )
157 157 wait_for_url_file = Float(5, config=True,
158 158 help="""The maximum number of seconds to wait for url_file to exist.
159 159 This is useful for batch-systems and shared-filesystems where the
160 160 controller and engine are started at the same time and it
161 161 may take a moment for the controller to write the connector files.""")
162 162
163 163 url_file_name = Unicode(u'ipcontroller-engine.json', config=True)
164 164
165 165 def _cluster_id_changed(self, name, old, new):
166 166 if new:
167 167 base = 'ipcontroller-%s' % new
168 168 else:
169 169 base = 'ipcontroller'
170 170 self.url_file_name = "%s-engine.json" % base
171 171
172 172 log_url = Unicode('', config=True,
173 173 help="""The URL for the iploggerapp instance, for forwarding
174 174 logging to a central location.""")
175 175
176 176 # an IPKernelApp instance, used to setup listening for shell frontends
177 177 kernel_app = Instance(IPKernelApp)
178 178
179 179 aliases = Dict(aliases)
180 180 flags = Dict(flags)
181 181
182 182 @property
183 183 def kernel(self):
184 184 """allow access to the Kernel object, so I look like IPKernelApp"""
185 185 return self.engine.kernel
186 186
187 187 def find_url_file(self):
188 188 """Set the url file.
189 189
190 190 Here we don't try to actually see if it exists for is valid as that
191 191 is hadled by the connection logic.
192 192 """
193 193 config = self.config
194 194 # Find the actual controller key file
195 195 if not self.url_file:
196 196 self.url_file = os.path.join(
197 197 self.profile_dir.security_dir,
198 198 self.url_file_name
199 199 )
200 200
201 201 def load_connector_file(self):
202 202 """load config from a JSON connector file,
203 203 at a *lower* priority than command-line/config files.
204 204 """
205 205
206 206 self.log.info("Loading url_file %r", self.url_file)
207 207 config = self.config
208 208
209 209 with open(self.url_file) as f:
210 210 d = json.loads(f.read())
211 211
212 212 # allow hand-override of location for disambiguation
213 213 # and ssh-server
214 214 if 'EngineFactory.location' not in config:
215 215 config.EngineFactory.location = d['location']
216 216 if 'EngineFactory.sshserver' not in config:
217 217 config.EngineFactory.sshserver = d.get('ssh')
218 218
219 219 location = config.EngineFactory.location
220 220
221 221 proto, ip = d['interface'].split('://')
222 222 ip = disambiguate_ip_address(ip, location)
223 223 d['interface'] = '%s://%s' % (proto, ip)
224 224
225 225 # DO NOT allow override of basic URLs, serialization, or key
226 226 # JSON file takes top priority there
227 227 config.Session.key = cast_bytes(d['key'])
228 228 config.Session.signature_scheme = d['signature_scheme']
229 229
230 230 config.EngineFactory.url = d['interface'] + ':%i' % d['registration']
231 231
232 232 config.Session.packer = d['pack']
233 233 config.Session.unpacker = d['unpack']
234 234
235 235 self.log.debug("Config changed:")
236 236 self.log.debug("%r", config)
237 237 self.connection_info = d
238 238
239 239 def bind_kernel(self, **kwargs):
240 240 """Promote engine to listening kernel, accessible to frontends."""
241 241 if self.kernel_app is not None:
242 242 return
243 243
244 244 self.log.info("Opening ports for direct connections as an IPython kernel")
245 245
246 246 kernel = self.kernel
247 247
248 248 kwargs.setdefault('config', self.config)
249 249 kwargs.setdefault('log', self.log)
250 250 kwargs.setdefault('profile_dir', self.profile_dir)
251 251 kwargs.setdefault('session', self.engine.session)
252 252
253 253 app = self.kernel_app = IPKernelApp(**kwargs)
254 254
255 255 # allow IPKernelApp.instance():
256 256 IPKernelApp._instance = app
257 257
258 258 app.init_connection_file()
259 259 # relevant contents of init_sockets:
260 260
261 261 app.shell_port = app._bind_socket(kernel.shell_streams[0], app.shell_port)
262 262 app.log.debug("shell ROUTER Channel on port: %i", app.shell_port)
263 263
264 264 app.iopub_port = app._bind_socket(kernel.iopub_socket, app.iopub_port)
265 265 app.log.debug("iopub PUB Channel on port: %i", app.iopub_port)
266 266
267 267 kernel.stdin_socket = self.engine.context.socket(zmq.ROUTER)
268 268 app.stdin_port = app._bind_socket(kernel.stdin_socket, app.stdin_port)
269 269 app.log.debug("stdin ROUTER Channel on port: %i", app.stdin_port)
270 270
271 271 # start the heartbeat, and log connection info:
272 272
273 273 app.init_heartbeat()
274 274
275 275 app.log_connection_info()
276 276 app.write_connection_file()
277 277
278 278
279 279 def init_engine(self):
280 280 # This is the working dir by now.
281 281 sys.path.insert(0, '')
282 282 config = self.config
283 283 # print config
284 284 self.find_url_file()
285 285
286 286 # was the url manually specified?
287 287 keys = set(self.config.EngineFactory.keys())
288 288 keys = keys.union(set(self.config.RegistrationFactory.keys()))
289 289
290 290 if keys.intersection(set(['ip', 'url', 'port'])):
291 291 # Connection info was specified, don't wait for the file
292 292 url_specified = True
293 293 self.wait_for_url_file = 0
294 294 else:
295 295 url_specified = False
296 296
297 297 if self.wait_for_url_file and not os.path.exists(self.url_file):
298 298 self.log.warn("url_file %r not found", self.url_file)
299 299 self.log.warn("Waiting up to %.1f seconds for it to arrive.", self.wait_for_url_file)
300 300 tic = time.time()
301 301 while not os.path.exists(self.url_file) and (time.time()-tic < self.wait_for_url_file):
302 302 # wait for url_file to exist, or until time limit
303 303 time.sleep(0.1)
304 304
305 305 if os.path.exists(self.url_file):
306 306 self.load_connector_file()
307 307 elif not url_specified:
308 308 self.log.fatal("Fatal: url file never arrived: %s", self.url_file)
309 309 self.exit(1)
310 310
311 311 exec_lines = []
312 312 for app in ('IPKernelApp', 'InteractiveShellApp'):
313 313 if '%s.exec_lines' in config:
314 314 exec_lines = config.IPKernelApp.exec_lines = config[app].exec_lines
315 315 break
316 316
317 317 exec_files = []
318 318 for app in ('IPKernelApp', 'InteractiveShellApp'):
319 319 if '%s.exec_files' in config:
320 320 exec_files = config.IPKernelApp.exec_files = config[app].exec_files
321 321 break
322 322
323 323 if self.startup_script:
324 324 exec_files.append(self.startup_script)
325 325 if self.startup_command:
326 326 exec_lines.append(self.startup_command)
327 327
328 328 # Create the underlying shell class and Engine
329 329 # shell_class = import_item(self.master_config.Global.shell_class)
330 330 # print self.config
331 331 try:
332 332 self.engine = EngineFactory(config=config, log=self.log,
333 333 connection_info=self.connection_info,
334 334 )
335 335 except:
336 336 self.log.error("Couldn't start the Engine", exc_info=True)
337 337 self.exit(1)
338 338
339 339 def forward_logging(self):
340 340 if self.log_url:
341 341 self.log.info("Forwarding logging to %s", self.log_url)
342 342 context = self.engine.context
343 343 lsock = context.socket(zmq.PUB)
344 344 lsock.connect(self.log_url)
345 345 handler = EnginePUBHandler(self.engine, lsock)
346 346 handler.setLevel(self.log_level)
347 347 self.log.addHandler(handler)
348 348
349 349 def init_mpi(self):
350 350 global mpi
351 351 self.mpi = MPI(parent=self)
352 352
353 353 mpi_import_statement = self.mpi.init_script
354 354 if mpi_import_statement:
355 355 try:
356 356 self.log.info("Initializing MPI:")
357 357 self.log.info(mpi_import_statement)
358 exec mpi_import_statement in globals()
358 exec(mpi_import_statement, globals())
359 359 except:
360 360 mpi = None
361 361 else:
362 362 mpi = None
363 363
364 364 @catch_config_error
365 365 def initialize(self, argv=None):
366 366 super(IPEngineApp, self).initialize(argv)
367 367 self.init_mpi()
368 368 self.init_engine()
369 369 self.forward_logging()
370 370
371 371 def start(self):
372 372 self.engine.start()
373 373 try:
374 374 self.engine.loop.start()
375 375 except KeyboardInterrupt:
376 376 self.log.critical("Engine Interrupted, shutting down...\n")
377 377
378 378
379 379 launch_new_instance = IPEngineApp.launch_instance
380 380
381 381
382 382 if __name__ == '__main__':
383 383 launch_new_instance()
384 384
@@ -1,225 +1,225 b''
1 1 """Dependency utilities
2 2
3 3 Authors:
4 4
5 5 * Min RK
6 6 """
7 7 #-----------------------------------------------------------------------------
8 8 # Copyright (C) 2013 The IPython Development Team
9 9 #
10 10 # Distributed under the terms of the BSD License. The full license is in
11 11 # the file COPYING, distributed as part of this software.
12 12 #-----------------------------------------------------------------------------
13 13
14 14 from types import ModuleType
15 15
16 16 from IPython.parallel.client.asyncresult import AsyncResult
17 17 from IPython.parallel.error import UnmetDependency
18 18 from IPython.parallel.util import interactive
19 19 from IPython.utils import py3compat
20 20 from IPython.utils.pickleutil import can, uncan
21 21
22 22 class depend(object):
23 23 """Dependency decorator, for use with tasks.
24 24
25 25 `@depend` lets you define a function for engine dependencies
26 26 just like you use `apply` for tasks.
27 27
28 28
29 29 Examples
30 30 --------
31 31 ::
32 32
33 33 @depend(df, a,b, c=5)
34 34 def f(m,n,p)
35 35
36 36 view.apply(f, 1,2,3)
37 37
38 38 will call df(a,b,c=5) on the engine, and if it returns False or
39 39 raises an UnmetDependency error, then the task will not be run
40 40 and another engine will be tried.
41 41 """
42 42 def __init__(self, f, *args, **kwargs):
43 43 self.f = f
44 44 self.args = args
45 45 self.kwargs = kwargs
46 46
47 47 def __call__(self, f):
48 48 return dependent(f, self.f, *self.args, **self.kwargs)
49 49
50 50 class dependent(object):
51 51 """A function that depends on another function.
52 52 This is an object to prevent the closure used
53 53 in traditional decorators, which are not picklable.
54 54 """
55 55
56 56 def __init__(self, f, df, *dargs, **dkwargs):
57 57 self.f = f
58 58 self.func_name = getattr(f, '__name__', 'f')
59 59 self.df = df
60 60 self.dargs = dargs
61 61 self.dkwargs = dkwargs
62 62
63 63 def check_dependency(self):
64 64 if self.df(*self.dargs, **self.dkwargs) is False:
65 65 raise UnmetDependency()
66 66
67 67 def __call__(self, *args, **kwargs):
68 68 return self.f(*args, **kwargs)
69 69
70 70 if not py3compat.PY3:
71 71 @property
72 72 def __name__(self):
73 73 return self.func_name
74 74
75 75 @interactive
76 76 def _require(*modules, **mapping):
77 77 """Helper for @require decorator."""
78 78 from IPython.parallel.error import UnmetDependency
79 79 from IPython.utils.pickleutil import uncan
80 80 user_ns = globals()
81 81 for name in modules:
82 82 try:
83 exec 'import %s' % name in user_ns
83 exec('import %s' % name, user_ns)
84 84 except ImportError:
85 85 raise UnmetDependency(name)
86 86
87 87 for name, cobj in mapping.items():
88 88 user_ns[name] = uncan(cobj, user_ns)
89 89 return True
90 90
91 91 def require(*objects, **mapping):
92 92 """Simple decorator for requiring local objects and modules to be available
93 93 when the decorated function is called on the engine.
94 94
95 95 Modules specified by name or passed directly will be imported
96 96 prior to calling the decorated function.
97 97
98 98 Objects other than modules will be pushed as a part of the task.
99 99 Functions can be passed positionally,
100 100 and will be pushed to the engine with their __name__.
101 101 Other objects can be passed by keyword arg.
102 102
103 103 Examples
104 104 --------
105 105
106 106 In [1]: @require('numpy')
107 107 ...: def norm(a):
108 108 ...: return numpy.linalg.norm(a,2)
109 109
110 110 In [2]: foo = lambda x: x*x
111 111 In [3]: @require(foo)
112 112 ...: def bar(a):
113 113 ...: return foo(1-a)
114 114 """
115 115 names = []
116 116 for obj in objects:
117 117 if isinstance(obj, ModuleType):
118 118 obj = obj.__name__
119 119
120 120 if isinstance(obj, basestring):
121 121 names.append(obj)
122 122 elif hasattr(obj, '__name__'):
123 123 mapping[obj.__name__] = obj
124 124 else:
125 125 raise TypeError("Objects other than modules and functions "
126 126 "must be passed by kwarg, but got: %s" % type(obj)
127 127 )
128 128
129 129 for name, obj in mapping.items():
130 130 mapping[name] = can(obj)
131 131 return depend(_require, *names, **mapping)
132 132
133 133 class Dependency(set):
134 134 """An object for representing a set of msg_id dependencies.
135 135
136 136 Subclassed from set().
137 137
138 138 Parameters
139 139 ----------
140 140 dependencies: list/set of msg_ids or AsyncResult objects or output of Dependency.as_dict()
141 141 The msg_ids to depend on
142 142 all : bool [default True]
143 143 Whether the dependency should be considered met when *all* depending tasks have completed
144 144 or only when *any* have been completed.
145 145 success : bool [default True]
146 146 Whether to consider successes as fulfilling dependencies.
147 147 failure : bool [default False]
148 148 Whether to consider failures as fulfilling dependencies.
149 149
150 150 If `all=success=True` and `failure=False`, then the task will fail with an ImpossibleDependency
151 151 as soon as the first depended-upon task fails.
152 152 """
153 153
154 154 all=True
155 155 success=True
156 156 failure=True
157 157
158 158 def __init__(self, dependencies=[], all=True, success=True, failure=False):
159 159 if isinstance(dependencies, dict):
160 160 # load from dict
161 161 all = dependencies.get('all', True)
162 162 success = dependencies.get('success', success)
163 163 failure = dependencies.get('failure', failure)
164 164 dependencies = dependencies.get('dependencies', [])
165 165 ids = []
166 166
167 167 # extract ids from various sources:
168 168 if isinstance(dependencies, (basestring, AsyncResult)):
169 169 dependencies = [dependencies]
170 170 for d in dependencies:
171 171 if isinstance(d, basestring):
172 172 ids.append(d)
173 173 elif isinstance(d, AsyncResult):
174 174 ids.extend(d.msg_ids)
175 175 else:
176 176 raise TypeError("invalid dependency type: %r"%type(d))
177 177
178 178 set.__init__(self, ids)
179 179 self.all = all
180 180 if not (success or failure):
181 181 raise ValueError("Must depend on at least one of successes or failures!")
182 182 self.success=success
183 183 self.failure = failure
184 184
185 185 def check(self, completed, failed=None):
186 186 """check whether our dependencies have been met."""
187 187 if len(self) == 0:
188 188 return True
189 189 against = set()
190 190 if self.success:
191 191 against = completed
192 192 if failed is not None and self.failure:
193 193 against = against.union(failed)
194 194 if self.all:
195 195 return self.issubset(against)
196 196 else:
197 197 return not self.isdisjoint(against)
198 198
199 199 def unreachable(self, completed, failed=None):
200 200 """return whether this dependency has become impossible."""
201 201 if len(self) == 0:
202 202 return False
203 203 against = set()
204 204 if not self.success:
205 205 against = completed
206 206 if failed is not None and not self.failure:
207 207 against = against.union(failed)
208 208 if self.all:
209 209 return not self.isdisjoint(against)
210 210 else:
211 211 return self.issubset(against)
212 212
213 213
214 214 def as_dict(self):
215 215 """Represent this dependency as a dict. For json compatibility."""
216 216 return dict(
217 217 dependencies=list(self),
218 218 all=self.all,
219 219 success=self.success,
220 220 failure=self.failure
221 221 )
222 222
223 223
224 224 __all__ = ['depend', 'require', 'dependent', 'Dependency']
225 225
@@ -1,368 +1,368 b''
1 1 """some generic utilities for dealing with classes, urls, and serialization
2 2
3 3 Authors:
4 4
5 5 * Min RK
6 6 """
7 7 #-----------------------------------------------------------------------------
8 8 # Copyright (C) 2010-2011 The IPython Development Team
9 9 #
10 10 # Distributed under the terms of the BSD License. The full license is in
11 11 # the file COPYING, distributed as part of this software.
12 12 #-----------------------------------------------------------------------------
13 13
14 14 #-----------------------------------------------------------------------------
15 15 # Imports
16 16 #-----------------------------------------------------------------------------
17 17
18 18 # Standard library imports.
19 19 import logging
20 20 import os
21 21 import re
22 22 import stat
23 23 import socket
24 24 import sys
25 25 from signal import signal, SIGINT, SIGABRT, SIGTERM
26 26 try:
27 27 from signal import SIGKILL
28 28 except ImportError:
29 29 SIGKILL=None
30 30
31 31 try:
32 32 import cPickle
33 33 pickle = cPickle
34 34 except:
35 35 cPickle = None
36 36 import pickle
37 37
38 38 # System library imports
39 39 import zmq
40 40 from zmq.log import handlers
41 41
42 42 from IPython.external.decorator import decorator
43 43
44 44 # IPython imports
45 45 from IPython.config.application import Application
46 46 from IPython.utils.localinterfaces import localhost, is_public_ip, public_ips
47 47 from IPython.kernel.zmq.log import EnginePUBHandler
48 48 from IPython.kernel.zmq.serialize import (
49 49 unserialize_object, serialize_object, pack_apply_message, unpack_apply_message
50 50 )
51 51
52 52 #-----------------------------------------------------------------------------
53 53 # Classes
54 54 #-----------------------------------------------------------------------------
55 55
56 56 class Namespace(dict):
57 57 """Subclass of dict for attribute access to keys."""
58 58
59 59 def __getattr__(self, key):
60 60 """getattr aliased to getitem"""
61 61 if key in self.iterkeys():
62 62 return self[key]
63 63 else:
64 64 raise NameError(key)
65 65
66 66 def __setattr__(self, key, value):
67 67 """setattr aliased to setitem, with strict"""
68 68 if hasattr(dict, key):
69 69 raise KeyError("Cannot override dict keys %r"%key)
70 70 self[key] = value
71 71
72 72
73 73 class ReverseDict(dict):
74 74 """simple double-keyed subset of dict methods."""
75 75
76 76 def __init__(self, *args, **kwargs):
77 77 dict.__init__(self, *args, **kwargs)
78 78 self._reverse = dict()
79 79 for key, value in self.iteritems():
80 80 self._reverse[value] = key
81 81
82 82 def __getitem__(self, key):
83 83 try:
84 84 return dict.__getitem__(self, key)
85 85 except KeyError:
86 86 return self._reverse[key]
87 87
88 88 def __setitem__(self, key, value):
89 89 if key in self._reverse:
90 90 raise KeyError("Can't have key %r on both sides!"%key)
91 91 dict.__setitem__(self, key, value)
92 92 self._reverse[value] = key
93 93
94 94 def pop(self, key):
95 95 value = dict.pop(self, key)
96 96 self._reverse.pop(value)
97 97 return value
98 98
99 99 def get(self, key, default=None):
100 100 try:
101 101 return self[key]
102 102 except KeyError:
103 103 return default
104 104
105 105 #-----------------------------------------------------------------------------
106 106 # Functions
107 107 #-----------------------------------------------------------------------------
108 108
109 109 @decorator
110 110 def log_errors(f, self, *args, **kwargs):
111 111 """decorator to log unhandled exceptions raised in a method.
112 112
113 113 For use wrapping on_recv callbacks, so that exceptions
114 114 do not cause the stream to be closed.
115 115 """
116 116 try:
117 117 return f(self, *args, **kwargs)
118 118 except Exception:
119 119 self.log.error("Uncaught exception in %r" % f, exc_info=True)
120 120
121 121
122 122 def is_url(url):
123 123 """boolean check for whether a string is a zmq url"""
124 124 if '://' not in url:
125 125 return False
126 126 proto, addr = url.split('://', 1)
127 127 if proto.lower() not in ['tcp','pgm','epgm','ipc','inproc']:
128 128 return False
129 129 return True
130 130
131 131 def validate_url(url):
132 132 """validate a url for zeromq"""
133 133 if not isinstance(url, basestring):
134 134 raise TypeError("url must be a string, not %r"%type(url))
135 135 url = url.lower()
136 136
137 137 proto_addr = url.split('://')
138 138 assert len(proto_addr) == 2, 'Invalid url: %r'%url
139 139 proto, addr = proto_addr
140 140 assert proto in ['tcp','pgm','epgm','ipc','inproc'], "Invalid protocol: %r"%proto
141 141
142 142 # domain pattern adapted from http://www.regexlib.com/REDetails.aspx?regexp_id=391
143 143 # author: Remi Sabourin
144 144 pat = re.compile(r'^([\w\d]([\w\d\-]{0,61}[\w\d])?\.)*[\w\d]([\w\d\-]{0,61}[\w\d])?$')
145 145
146 146 if proto == 'tcp':
147 147 lis = addr.split(':')
148 148 assert len(lis) == 2, 'Invalid url: %r'%url
149 149 addr,s_port = lis
150 150 try:
151 151 port = int(s_port)
152 152 except ValueError:
153 153 raise AssertionError("Invalid port %r in url: %r"%(port, url))
154 154
155 155 assert addr == '*' or pat.match(addr) is not None, 'Invalid url: %r'%url
156 156
157 157 else:
158 158 # only validate tcp urls currently
159 159 pass
160 160
161 161 return True
162 162
163 163
164 164 def validate_url_container(container):
165 165 """validate a potentially nested collection of urls."""
166 166 if isinstance(container, basestring):
167 167 url = container
168 168 return validate_url(url)
169 169 elif isinstance(container, dict):
170 170 container = container.itervalues()
171 171
172 172 for element in container:
173 173 validate_url_container(element)
174 174
175 175
176 176 def split_url(url):
177 177 """split a zmq url (tcp://ip:port) into ('tcp','ip','port')."""
178 178 proto_addr = url.split('://')
179 179 assert len(proto_addr) == 2, 'Invalid url: %r'%url
180 180 proto, addr = proto_addr
181 181 lis = addr.split(':')
182 182 assert len(lis) == 2, 'Invalid url: %r'%url
183 183 addr,s_port = lis
184 184 return proto,addr,s_port
185 185
186 186 def disambiguate_ip_address(ip, location=None):
187 187 """turn multi-ip interfaces '0.0.0.0' and '*' into connectable
188 188 ones, based on the location (default interpretation of location is localhost)."""
189 189 if ip in ('0.0.0.0', '*'):
190 190 if location is None or is_public_ip(location) or not public_ips():
191 191 # If location is unspecified or cannot be determined, assume local
192 192 ip = localhost()
193 193 elif location:
194 194 return location
195 195 return ip
196 196
197 197 def disambiguate_url(url, location=None):
198 198 """turn multi-ip interfaces '0.0.0.0' and '*' into connectable
199 199 ones, based on the location (default interpretation is localhost).
200 200
201 201 This is for zeromq urls, such as tcp://*:10101."""
202 202 try:
203 203 proto,ip,port = split_url(url)
204 204 except AssertionError:
205 205 # probably not tcp url; could be ipc, etc.
206 206 return url
207 207
208 208 ip = disambiguate_ip_address(ip,location)
209 209
210 210 return "%s://%s:%s"%(proto,ip,port)
211 211
212 212
213 213 #--------------------------------------------------------------------------
214 214 # helpers for implementing old MEC API via view.apply
215 215 #--------------------------------------------------------------------------
216 216
217 217 def interactive(f):
218 218 """decorator for making functions appear as interactively defined.
219 219 This results in the function being linked to the user_ns as globals()
220 220 instead of the module globals().
221 221 """
222 222 f.__module__ = '__main__'
223 223 return f
224 224
225 225 @interactive
226 226 def _push(**ns):
227 227 """helper method for implementing `client.push` via `client.apply`"""
228 228 user_ns = globals()
229 229 tmp = '_IP_PUSH_TMP_'
230 230 while tmp in user_ns:
231 231 tmp = tmp + '_'
232 232 try:
233 233 for name, value in ns.iteritems():
234 234 user_ns[tmp] = value
235 exec "%s = %s" % (name, tmp) in user_ns
235 exec("%s = %s" % (name, tmp), user_ns)
236 236 finally:
237 237 user_ns.pop(tmp, None)
238 238
239 239 @interactive
240 240 def _pull(keys):
241 241 """helper method for implementing `client.pull` via `client.apply`"""
242 242 if isinstance(keys, (list,tuple, set)):
243 243 return map(lambda key: eval(key, globals()), keys)
244 244 else:
245 245 return eval(keys, globals())
246 246
247 247 @interactive
248 248 def _execute(code):
249 249 """helper method for implementing `client.execute` via `client.apply`"""
250 exec code in globals()
250 exec(code, globals())
251 251
252 252 #--------------------------------------------------------------------------
253 253 # extra process management utilities
254 254 #--------------------------------------------------------------------------
255 255
256 256 _random_ports = set()
257 257
258 258 def select_random_ports(n):
259 259 """Selects and return n random ports that are available."""
260 260 ports = []
261 261 for i in xrange(n):
262 262 sock = socket.socket()
263 263 sock.bind(('', 0))
264 264 while sock.getsockname()[1] in _random_ports:
265 265 sock.close()
266 266 sock = socket.socket()
267 267 sock.bind(('', 0))
268 268 ports.append(sock)
269 269 for i, sock in enumerate(ports):
270 270 port = sock.getsockname()[1]
271 271 sock.close()
272 272 ports[i] = port
273 273 _random_ports.add(port)
274 274 return ports
275 275
276 276 def signal_children(children):
277 277 """Relay interupt/term signals to children, for more solid process cleanup."""
278 278 def terminate_children(sig, frame):
279 279 log = Application.instance().log
280 280 log.critical("Got signal %i, terminating children..."%sig)
281 281 for child in children:
282 282 child.terminate()
283 283
284 284 sys.exit(sig != SIGINT)
285 285 # sys.exit(sig)
286 286 for sig in (SIGINT, SIGABRT, SIGTERM):
287 287 signal(sig, terminate_children)
288 288
289 289 def generate_exec_key(keyfile):
290 290 import uuid
291 291 newkey = str(uuid.uuid4())
292 292 with open(keyfile, 'w') as f:
293 293 # f.write('ipython-key ')
294 294 f.write(newkey+'\n')
295 295 # set user-only RW permissions (0600)
296 296 # this will have no effect on Windows
297 297 os.chmod(keyfile, stat.S_IRUSR|stat.S_IWUSR)
298 298
299 299
300 300 def integer_loglevel(loglevel):
301 301 try:
302 302 loglevel = int(loglevel)
303 303 except ValueError:
304 304 if isinstance(loglevel, str):
305 305 loglevel = getattr(logging, loglevel)
306 306 return loglevel
307 307
308 308 def connect_logger(logname, context, iface, root="ip", loglevel=logging.DEBUG):
309 309 logger = logging.getLogger(logname)
310 310 if any([isinstance(h, handlers.PUBHandler) for h in logger.handlers]):
311 311 # don't add a second PUBHandler
312 312 return
313 313 loglevel = integer_loglevel(loglevel)
314 314 lsock = context.socket(zmq.PUB)
315 315 lsock.connect(iface)
316 316 handler = handlers.PUBHandler(lsock)
317 317 handler.setLevel(loglevel)
318 318 handler.root_topic = root
319 319 logger.addHandler(handler)
320 320 logger.setLevel(loglevel)
321 321
322 322 def connect_engine_logger(context, iface, engine, loglevel=logging.DEBUG):
323 323 logger = logging.getLogger()
324 324 if any([isinstance(h, handlers.PUBHandler) for h in logger.handlers]):
325 325 # don't add a second PUBHandler
326 326 return
327 327 loglevel = integer_loglevel(loglevel)
328 328 lsock = context.socket(zmq.PUB)
329 329 lsock.connect(iface)
330 330 handler = EnginePUBHandler(engine, lsock)
331 331 handler.setLevel(loglevel)
332 332 logger.addHandler(handler)
333 333 logger.setLevel(loglevel)
334 334 return logger
335 335
336 336 def local_logger(logname, loglevel=logging.DEBUG):
337 337 loglevel = integer_loglevel(loglevel)
338 338 logger = logging.getLogger(logname)
339 339 if any([isinstance(h, logging.StreamHandler) for h in logger.handlers]):
340 340 # don't add a second StreamHandler
341 341 return
342 342 handler = logging.StreamHandler()
343 343 handler.setLevel(loglevel)
344 344 formatter = logging.Formatter("%(asctime)s.%(msecs).03d [%(name)s] %(message)s",
345 345 datefmt="%Y-%m-%d %H:%M:%S")
346 346 handler.setFormatter(formatter)
347 347
348 348 logger.addHandler(handler)
349 349 logger.setLevel(loglevel)
350 350 return logger
351 351
352 352 def set_hwm(sock, hwm=0):
353 353 """set zmq High Water Mark on a socket
354 354
355 355 in a way that always works for various pyzmq / libzmq versions.
356 356 """
357 357 import zmq
358 358
359 359 for key in ('HWM', 'SNDHWM', 'RCVHWM'):
360 360 opt = getattr(zmq, key, None)
361 361 if opt is None:
362 362 continue
363 363 try:
364 364 sock.setsockopt(opt, hwm)
365 365 except zmq.ZMQError:
366 366 pass
367 367
368 368 No newline at end of file
@@ -1,206 +1,206 b''
1 1 # coding: utf-8
2 2 """Compatibility tricks for Python 3. Mainly to do with unicode."""
3 3 import __builtin__
4 4 import functools
5 5 import sys
6 6 import re
7 7 import types
8 8
9 9 from .encoding import DEFAULT_ENCODING
10 10
11 11 orig_open = open
12 12
13 13 def no_code(x, encoding=None):
14 14 return x
15 15
16 16 def decode(s, encoding=None):
17 17 encoding = encoding or DEFAULT_ENCODING
18 18 return s.decode(encoding, "replace")
19 19
20 20 def encode(u, encoding=None):
21 21 encoding = encoding or DEFAULT_ENCODING
22 22 return u.encode(encoding, "replace")
23 23
24 24
25 25 def cast_unicode(s, encoding=None):
26 26 if isinstance(s, bytes):
27 27 return decode(s, encoding)
28 28 return s
29 29
30 30 def cast_bytes(s, encoding=None):
31 31 if not isinstance(s, bytes):
32 32 return encode(s, encoding)
33 33 return s
34 34
35 35 def _modify_str_or_docstring(str_change_func):
36 36 @functools.wraps(str_change_func)
37 37 def wrapper(func_or_str):
38 38 if isinstance(func_or_str, basestring):
39 39 func = None
40 40 doc = func_or_str
41 41 else:
42 42 func = func_or_str
43 43 doc = func.__doc__
44 44
45 45 doc = str_change_func(doc)
46 46
47 47 if func:
48 48 func.__doc__ = doc
49 49 return func
50 50 return doc
51 51 return wrapper
52 52
53 53 def safe_unicode(e):
54 54 """unicode(e) with various fallbacks. Used for exceptions, which may not be
55 55 safe to call unicode() on.
56 56 """
57 57 try:
58 58 return unicode(e)
59 59 except UnicodeError:
60 60 pass
61 61
62 62 try:
63 63 return str_to_unicode(str(e))
64 64 except UnicodeError:
65 65 pass
66 66
67 67 try:
68 68 return str_to_unicode(repr(e))
69 69 except UnicodeError:
70 70 pass
71 71
72 72 return u'Unrecoverably corrupt evalue'
73 73
74 74 if sys.version_info[0] >= 3:
75 75 PY3 = True
76 76
77 77 input = input
78 78 builtin_mod_name = "builtins"
79 79
80 80 str_to_unicode = no_code
81 81 unicode_to_str = no_code
82 82 str_to_bytes = encode
83 83 bytes_to_str = decode
84 84 cast_bytes_py2 = no_code
85 85
86 86 string_types = (str,)
87 87 unicode_type = str
88 88
89 89 def isidentifier(s, dotted=False):
90 90 if dotted:
91 91 return all(isidentifier(a) for a in s.split("."))
92 92 return s.isidentifier()
93 93
94 94 open = orig_open
95 95
96 96 MethodType = types.MethodType
97 97
98 98 def execfile(fname, glob, loc=None):
99 99 loc = loc if (loc is not None) else glob
100 100 with open(fname, 'rb') as f:
101 exec compile(f.read(), fname, 'exec') in glob, loc
101 exec(compile(f.read(), fname, 'exec'), glob, loc)
102 102
103 103 # Refactor print statements in doctests.
104 104 _print_statement_re = re.compile(r"\bprint (?P<expr>.*)$", re.MULTILINE)
105 105 def _print_statement_sub(match):
106 106 expr = match.groups('expr')
107 107 return "print(%s)" % expr
108 108
109 109 @_modify_str_or_docstring
110 110 def doctest_refactor_print(doc):
111 111 """Refactor 'print x' statements in a doctest to print(x) style. 2to3
112 112 unfortunately doesn't pick up on our doctests.
113 113
114 114 Can accept a string or a function, so it can be used as a decorator."""
115 115 return _print_statement_re.sub(_print_statement_sub, doc)
116 116
117 117 # Abstract u'abc' syntax:
118 118 @_modify_str_or_docstring
119 119 def u_format(s):
120 120 """"{u}'abc'" --> "'abc'" (Python 3)
121 121
122 122 Accepts a string or a function, so it can be used as a decorator."""
123 123 return s.format(u='')
124 124
125 125 else:
126 126 PY3 = False
127 127
128 128 input = raw_input
129 129 builtin_mod_name = "__builtin__"
130 130
131 131 str_to_unicode = decode
132 132 unicode_to_str = encode
133 133 str_to_bytes = no_code
134 134 bytes_to_str = no_code
135 135 cast_bytes_py2 = cast_bytes
136 136
137 137 string_types = (str, unicode)
138 138 unicode_type = unicode
139 139
140 140 import re
141 141 _name_re = re.compile(r"[a-zA-Z_][a-zA-Z0-9_]*$")
142 142 def isidentifier(s, dotted=False):
143 143 if dotted:
144 144 return all(isidentifier(a) for a in s.split("."))
145 145 return bool(_name_re.match(s))
146 146
147 147 class open(object):
148 148 """Wrapper providing key part of Python 3 open() interface."""
149 149 def __init__(self, fname, mode="r", encoding="utf-8"):
150 150 self.f = orig_open(fname, mode)
151 151 self.enc = encoding
152 152
153 153 def write(self, s):
154 154 return self.f.write(s.encode(self.enc))
155 155
156 156 def read(self, size=-1):
157 157 return self.f.read(size).decode(self.enc)
158 158
159 159 def close(self):
160 160 return self.f.close()
161 161
162 162 def __enter__(self):
163 163 return self
164 164
165 165 def __exit__(self, etype, value, traceback):
166 166 self.f.close()
167 167
168 168 def MethodType(func, instance):
169 169 return types.MethodType(func, instance, type(instance))
170 170
171 171 # don't override system execfile on 2.x:
172 172 execfile = execfile
173 173
174 174 def doctest_refactor_print(func_or_str):
175 175 return func_or_str
176 176
177 177
178 178 # Abstract u'abc' syntax:
179 179 @_modify_str_or_docstring
180 180 def u_format(s):
181 181 """"{u}'abc'" --> "u'abc'" (Python 2)
182 182
183 183 Accepts a string or a function, so it can be used as a decorator."""
184 184 return s.format(u='u')
185 185
186 186 if sys.platform == 'win32':
187 187 def execfile(fname, glob=None, loc=None):
188 188 loc = loc if (loc is not None) else glob
189 189 # The rstrip() is necessary b/c trailing whitespace in files will
190 190 # cause an IndentationError in Python 2.6 (this was fixed in 2.7,
191 191 # but we still support 2.6). See issue 1027.
192 192 scripttext = __builtin__.open(fname).read().rstrip() + '\n'
193 193 # compile converts unicode filename to str assuming
194 194 # ascii. Let's do the conversion before calling compile
195 195 if isinstance(fname, unicode):
196 196 filename = unicode_to_str(fname)
197 197 else:
198 198 filename = fname
199 exec compile(scripttext, filename, 'exec') in glob, loc
199 exec(compile(scripttext, filename, 'exec'), glob, loc)
200 200 else:
201 201 def execfile(fname, *where):
202 202 if isinstance(fname, unicode):
203 203 filename = fname.encode(sys.getfilesystemencoding())
204 204 else:
205 205 filename = fname
206 206 __builtin__.execfile(filename, *where)
General Comments 0
You need to be logged in to leave comments. Login now