##// END OF EJS Templates
Logger.py => core/logger.py and updated imports.
Brian Granger -
Show More
@@ -1,2864 +1,2864 b''
1 1 # -*- coding: utf-8 -*-
2 2 """
3 3 IPython -- An enhanced Interactive Python
4 4
5 5 Requires Python 2.4 or newer.
6 6
7 7 This file contains all the classes and helper functions specific to IPython.
8 8 """
9 9
10 10 #*****************************************************************************
11 11 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and
12 12 # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu>
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 # Note: this code originally subclassed code.InteractiveConsole from the
18 18 # Python standard library. Over time, all of that class has been copied
19 19 # verbatim here for modifications which could not be accomplished by
20 20 # subclassing. At this point, there are no dependencies at all on the code
21 21 # module anymore (it is not even imported). The Python License (sec. 2)
22 22 # allows for this, but it's always nice to acknowledge credit where credit is
23 23 # due.
24 24 #*****************************************************************************
25 25
26 26 #****************************************************************************
27 27 # Modules and globals
28 28
29 29 # Python standard modules
30 30 import __main__
31 31 import __builtin__
32 32 import StringIO
33 33 import bdb
34 34 import codeop
35 35 import exceptions
36 36 import glob
37 37 import keyword
38 38 import new
39 39 import os
40 40 import re
41 41 import shutil
42 42 import string
43 43 import sys
44 44 import tempfile
45 45
46 46 # IPython's own modules
47 47 #import IPython
48 48 from IPython import OInspect,PyColorize,ultraTB
49 49 from IPython.core import debugger
50 50 from IPython.Extensions import pickleshare
51 51 from IPython.core.fakemodule import FakeModule, init_fakemod_dict
52 52 from IPython.external.Itpl import ItplNS
53 from IPython.Logger import Logger
53 from IPython.core.logger import Logger
54 54 from IPython.Magic import Magic
55 55 from IPython.Prompts import CachedOutput
56 56 from IPython.utils.ipstruct import Struct
57 57 from IPython.lib.backgroundjobs import BackgroundJobManager
58 58 from IPython.utils.genutils import *
59 59 from IPython.strdispatch import StrDispatch
60 60 from IPython.core import ipapi
61 61 import IPython.core.history
62 62 import IPython.prefilter as prefilter
63 63 import IPython.shadowns
64 64 # Globals
65 65
66 66 # store the builtin raw_input globally, and use this always, in case user code
67 67 # overwrites it (like wx.py.PyShell does)
68 68 raw_input_original = raw_input
69 69
70 70 # compiled regexps for autoindent management
71 71 dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass')
72 72
73 73
74 74 #****************************************************************************
75 75 # Some utility function definitions
76 76
77 77 ini_spaces_re = re.compile(r'^(\s+)')
78 78
79 79 def num_ini_spaces(strng):
80 80 """Return the number of initial spaces in a string"""
81 81
82 82 ini_spaces = ini_spaces_re.match(strng)
83 83 if ini_spaces:
84 84 return ini_spaces.end()
85 85 else:
86 86 return 0
87 87
88 88 def softspace(file, newvalue):
89 89 """Copied from code.py, to remove the dependency"""
90 90
91 91 oldvalue = 0
92 92 try:
93 93 oldvalue = file.softspace
94 94 except AttributeError:
95 95 pass
96 96 try:
97 97 file.softspace = newvalue
98 98 except (AttributeError, TypeError):
99 99 # "attribute-less object" or "read-only attributes"
100 100 pass
101 101 return oldvalue
102 102
103 103
104 104 def user_setup(ipythondir,rc_suffix,mode='install',interactive=True):
105 105 """Install or upgrade the user configuration directory.
106 106
107 107 Can be called when running for the first time or to upgrade the user's
108 108 .ipython/ directory.
109 109
110 110 Parameters
111 111 ----------
112 112 ipythondir : path
113 113 The directory to be used for installation/upgrade. In 'install' mode,
114 114 if this path already exists, the function exits immediately.
115 115
116 116 rc_suffix : str
117 117 Extension for the config files. On *nix platforms it is typically the
118 118 empty string, while Windows normally uses '.ini'.
119 119
120 120 mode : str, optional
121 121 Valid modes are 'install' and 'upgrade'.
122 122
123 123 interactive : bool, optional
124 124 If False, do not wait for user input on any errors. Normally after
125 125 printing its status information, this function waits for the user to
126 126 hit Return before proceeding. This is because the default use case is
127 127 when first installing the IPython configuration, so we want the user to
128 128 acknowledge the initial message, which contains some useful
129 129 information.
130 130 """
131 131
132 132 # For automatic use, deactivate all i/o
133 133 if interactive:
134 134 def wait():
135 135 try:
136 136 raw_input("Please press <RETURN> to start IPython.")
137 137 except EOFError:
138 138 print >> Term.cout
139 139 print '*'*70
140 140
141 141 def printf(s):
142 142 print s
143 143 else:
144 144 wait = lambda : None
145 145 printf = lambda s : None
146 146
147 147 # Install mode should be re-entrant: if the install dir already exists,
148 148 # bail out cleanly.
149 149 # XXX. This is too hasty to return. We need to check to make sure that
150 150 # all the expected config files and directories are actually there. We
151 151 # currently have a failure mode if someone deletes a needed config file
152 152 # but still has the ipythondir.
153 153 if mode == 'install' and os.path.isdir(ipythondir):
154 154 return
155 155
156 156 cwd = os.getcwd() # remember where we started
157 157 glb = glob.glob
158 158
159 159 printf('*'*70)
160 160 if mode == 'install':
161 161 printf(
162 162 """Welcome to IPython. I will try to create a personal configuration directory
163 163 where you can customize many aspects of IPython's functionality in:\n""")
164 164 else:
165 165 printf('I am going to upgrade your configuration in:')
166 166
167 167 printf(ipythondir)
168 168
169 169 rcdirend = os.path.join('IPython','UserConfig')
170 170 cfg = lambda d: os.path.join(d,rcdirend)
171 171 try:
172 172 rcdir = filter(os.path.isdir,map(cfg,sys.path))[0]
173 173 printf("Initializing from configuration: %s" % rcdir)
174 174 except IndexError:
175 175 warning = """
176 176 Installation error. IPython's directory was not found.
177 177
178 178 Check the following:
179 179
180 180 The ipython/IPython directory should be in a directory belonging to your
181 181 PYTHONPATH environment variable (that is, it should be in a directory
182 182 belonging to sys.path). You can copy it explicitly there or just link to it.
183 183
184 184 IPython will create a minimal default configuration for you.
185 185
186 186 """
187 187 warn(warning)
188 188 wait()
189 189
190 190 if sys.platform =='win32':
191 191 inif = 'ipythonrc.ini'
192 192 else:
193 193 inif = 'ipythonrc'
194 194 minimal_setup = {'ipy_user_conf.py' : 'import ipy_defaults',
195 195 inif : '# intentionally left blank' }
196 196 os.makedirs(ipythondir, mode = 0777)
197 197 for f, cont in minimal_setup.items():
198 198 # In 2.5, this can be more cleanly done using 'with'
199 199 fobj = file(ipythondir + '/' + f,'w')
200 200 fobj.write(cont)
201 201 fobj.close()
202 202
203 203 return
204 204
205 205 if mode == 'install':
206 206 try:
207 207 shutil.copytree(rcdir,ipythondir)
208 208 os.chdir(ipythondir)
209 209 rc_files = glb("ipythonrc*")
210 210 for rc_file in rc_files:
211 211 os.rename(rc_file,rc_file+rc_suffix)
212 212 except:
213 213 warning = """
214 214
215 215 There was a problem with the installation:
216 216 %s
217 217 Try to correct it or contact the developers if you think it's a bug.
218 218 IPython will proceed with builtin defaults.""" % sys.exc_info()[1]
219 219 warn(warning)
220 220 wait()
221 221 return
222 222
223 223 elif mode == 'upgrade':
224 224 try:
225 225 os.chdir(ipythondir)
226 226 except:
227 227 printf("""
228 228 Can not upgrade: changing to directory %s failed. Details:
229 229 %s
230 230 """ % (ipythondir,sys.exc_info()[1]) )
231 231 wait()
232 232 return
233 233 else:
234 234 sources = glb(os.path.join(rcdir,'[A-Za-z]*'))
235 235 for new_full_path in sources:
236 236 new_filename = os.path.basename(new_full_path)
237 237 if new_filename.startswith('ipythonrc'):
238 238 new_filename = new_filename + rc_suffix
239 239 # The config directory should only contain files, skip any
240 240 # directories which may be there (like CVS)
241 241 if os.path.isdir(new_full_path):
242 242 continue
243 243 if os.path.exists(new_filename):
244 244 old_file = new_filename+'.old'
245 245 if os.path.exists(old_file):
246 246 os.remove(old_file)
247 247 os.rename(new_filename,old_file)
248 248 shutil.copy(new_full_path,new_filename)
249 249 else:
250 250 raise ValueError('unrecognized mode for install: %r' % mode)
251 251
252 252 # Fix line-endings to those native to each platform in the config
253 253 # directory.
254 254 try:
255 255 os.chdir(ipythondir)
256 256 except:
257 257 printf("""
258 258 Problem: changing to directory %s failed.
259 259 Details:
260 260 %s
261 261
262 262 Some configuration files may have incorrect line endings. This should not
263 263 cause any problems during execution. """ % (ipythondir,sys.exc_info()[1]) )
264 264 wait()
265 265 else:
266 266 for fname in glb('ipythonrc*'):
267 267 try:
268 268 native_line_ends(fname,backup=0)
269 269 except IOError:
270 270 pass
271 271
272 272 if mode == 'install':
273 273 printf("""
274 274 Successful installation!
275 275
276 276 Please read the sections 'Initial Configuration' and 'Quick Tips' in the
277 277 IPython manual (there are both HTML and PDF versions supplied with the
278 278 distribution) to make sure that your system environment is properly configured
279 279 to take advantage of IPython's features.
280 280
281 281 Important note: the configuration system has changed! The old system is
282 282 still in place, but its setting may be partly overridden by the settings in
283 283 "~/.ipython/ipy_user_conf.py" config file. Please take a look at the file
284 284 if some of the new settings bother you.
285 285
286 286 """)
287 287 else:
288 288 printf("""
289 289 Successful upgrade!
290 290
291 291 All files in your directory:
292 292 %(ipythondir)s
293 293 which would have been overwritten by the upgrade were backed up with a .old
294 294 extension. If you had made particular customizations in those files you may
295 295 want to merge them back into the new files.""" % locals() )
296 296 wait()
297 297 os.chdir(cwd)
298 298
299 299 #****************************************************************************
300 300 # Local use exceptions
301 301 class SpaceInInput(exceptions.Exception): pass
302 302
303 303
304 304 #****************************************************************************
305 305 # Local use classes
306 306 class Bunch: pass
307 307
308 308 class Undefined: pass
309 309
310 310 class Quitter(object):
311 311 """Simple class to handle exit, similar to Python 2.5's.
312 312
313 313 It handles exiting in an ipython-safe manner, which the one in Python 2.5
314 314 doesn't do (obviously, since it doesn't know about ipython)."""
315 315
316 316 def __init__(self,shell,name):
317 317 self.shell = shell
318 318 self.name = name
319 319
320 320 def __repr__(self):
321 321 return 'Type %s() to exit.' % self.name
322 322 __str__ = __repr__
323 323
324 324 def __call__(self):
325 325 self.shell.exit()
326 326
327 327 class InputList(list):
328 328 """Class to store user input.
329 329
330 330 It's basically a list, but slices return a string instead of a list, thus
331 331 allowing things like (assuming 'In' is an instance):
332 332
333 333 exec In[4:7]
334 334
335 335 or
336 336
337 337 exec In[5:9] + In[14] + In[21:25]"""
338 338
339 339 def __getslice__(self,i,j):
340 340 return ''.join(list.__getslice__(self,i,j))
341 341
342 342 class SyntaxTB(ultraTB.ListTB):
343 343 """Extension which holds some state: the last exception value"""
344 344
345 345 def __init__(self,color_scheme = 'NoColor'):
346 346 ultraTB.ListTB.__init__(self,color_scheme)
347 347 self.last_syntax_error = None
348 348
349 349 def __call__(self, etype, value, elist):
350 350 self.last_syntax_error = value
351 351 ultraTB.ListTB.__call__(self,etype,value,elist)
352 352
353 353 def clear_err_state(self):
354 354 """Return the current error state and clear it"""
355 355 e = self.last_syntax_error
356 356 self.last_syntax_error = None
357 357 return e
358 358
359 359 #****************************************************************************
360 360 # Main IPython class
361 361
362 362 # FIXME: the Magic class is a mixin for now, and will unfortunately remain so
363 363 # until a full rewrite is made. I've cleaned all cross-class uses of
364 364 # attributes and methods, but too much user code out there relies on the
365 365 # equlity %foo == __IP.magic_foo, so I can't actually remove the mixin usage.
366 366 #
367 367 # But at least now, all the pieces have been separated and we could, in
368 368 # principle, stop using the mixin. This will ease the transition to the
369 369 # chainsaw branch.
370 370
371 371 # For reference, the following is the list of 'self.foo' uses in the Magic
372 372 # class as of 2005-12-28. These are names we CAN'T use in the main ipython
373 373 # class, to prevent clashes.
374 374
375 375 # ['self.__class__', 'self.__dict__', 'self._inspect', 'self._ofind',
376 376 # 'self.arg_err', 'self.extract_input', 'self.format_', 'self.lsmagic',
377 377 # 'self.magic_', 'self.options_table', 'self.parse', 'self.shell',
378 378 # 'self.value']
379 379
380 380 class InteractiveShell(object,Magic):
381 381 """An enhanced console for Python."""
382 382
383 383 # class attribute to indicate whether the class supports threads or not.
384 384 # Subclasses with thread support should override this as needed.
385 385 isthreaded = False
386 386
387 387 def __init__(self,name,usage=None,rc=Struct(opts=None,args=None),
388 388 user_ns=None,user_global_ns=None,banner2='',
389 389 custom_exceptions=((),None),embedded=False):
390 390
391 391 # log system
392 392 self.logger = Logger(self,logfname='ipython_log.py',logmode='rotate')
393 393
394 394 # Job manager (for jobs run as background threads)
395 395 self.jobs = BackgroundJobManager()
396 396
397 397 # Store the actual shell's name
398 398 self.name = name
399 399 self.more = False
400 400
401 401 # We need to know whether the instance is meant for embedding, since
402 402 # global/local namespaces need to be handled differently in that case
403 403 self.embedded = embedded
404 404 if embedded:
405 405 # Control variable so users can, from within the embedded instance,
406 406 # permanently deactivate it.
407 407 self.embedded_active = True
408 408
409 409 # command compiler
410 410 self.compile = codeop.CommandCompiler()
411 411
412 412 # User input buffer
413 413 self.buffer = []
414 414
415 415 # Default name given in compilation of code
416 416 self.filename = '<ipython console>'
417 417
418 418 # Install our own quitter instead of the builtins. For python2.3-2.4,
419 419 # this brings in behavior like 2.5, and for 2.5 it's identical.
420 420 __builtin__.exit = Quitter(self,'exit')
421 421 __builtin__.quit = Quitter(self,'quit')
422 422
423 423 # Make an empty namespace, which extension writers can rely on both
424 424 # existing and NEVER being used by ipython itself. This gives them a
425 425 # convenient location for storing additional information and state
426 426 # their extensions may require, without fear of collisions with other
427 427 # ipython names that may develop later.
428 428 self.meta = Struct()
429 429
430 430 # Create the namespace where the user will operate. user_ns is
431 431 # normally the only one used, and it is passed to the exec calls as
432 432 # the locals argument. But we do carry a user_global_ns namespace
433 433 # given as the exec 'globals' argument, This is useful in embedding
434 434 # situations where the ipython shell opens in a context where the
435 435 # distinction between locals and globals is meaningful. For
436 436 # non-embedded contexts, it is just the same object as the user_ns dict.
437 437
438 438 # FIXME. For some strange reason, __builtins__ is showing up at user
439 439 # level as a dict instead of a module. This is a manual fix, but I
440 440 # should really track down where the problem is coming from. Alex
441 441 # Schmolck reported this problem first.
442 442
443 443 # A useful post by Alex Martelli on this topic:
444 444 # Re: inconsistent value from __builtins__
445 445 # Von: Alex Martelli <aleaxit@yahoo.com>
446 446 # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends
447 447 # Gruppen: comp.lang.python
448 448
449 449 # Michael Hohn <hohn@hooknose.lbl.gov> wrote:
450 450 # > >>> print type(builtin_check.get_global_binding('__builtins__'))
451 451 # > <type 'dict'>
452 452 # > >>> print type(__builtins__)
453 453 # > <type 'module'>
454 454 # > Is this difference in return value intentional?
455 455
456 456 # Well, it's documented that '__builtins__' can be either a dictionary
457 457 # or a module, and it's been that way for a long time. Whether it's
458 458 # intentional (or sensible), I don't know. In any case, the idea is
459 459 # that if you need to access the built-in namespace directly, you
460 460 # should start with "import __builtin__" (note, no 's') which will
461 461 # definitely give you a module. Yeah, it's somewhat confusing:-(.
462 462
463 463 # These routines return properly built dicts as needed by the rest of
464 464 # the code, and can also be used by extension writers to generate
465 465 # properly initialized namespaces.
466 466 user_ns, user_global_ns = ipapi.make_user_namespaces(user_ns,
467 467 user_global_ns)
468 468
469 469 # Assign namespaces
470 470 # This is the namespace where all normal user variables live
471 471 self.user_ns = user_ns
472 472 self.user_global_ns = user_global_ns
473 473
474 474 # An auxiliary namespace that checks what parts of the user_ns were
475 475 # loaded at startup, so we can list later only variables defined in
476 476 # actual interactive use. Since it is always a subset of user_ns, it
477 477 # doesn't need to be seaparately tracked in the ns_table
478 478 self.user_config_ns = {}
479 479
480 480 # A namespace to keep track of internal data structures to prevent
481 481 # them from cluttering user-visible stuff. Will be updated later
482 482 self.internal_ns = {}
483 483
484 484 # Namespace of system aliases. Each entry in the alias
485 485 # table must be a 2-tuple of the form (N,name), where N is the number
486 486 # of positional arguments of the alias.
487 487 self.alias_table = {}
488 488
489 489 # Now that FakeModule produces a real module, we've run into a nasty
490 490 # problem: after script execution (via %run), the module where the user
491 491 # code ran is deleted. Now that this object is a true module (needed
492 492 # so docetst and other tools work correctly), the Python module
493 493 # teardown mechanism runs over it, and sets to None every variable
494 494 # present in that module. Top-level references to objects from the
495 495 # script survive, because the user_ns is updated with them. However,
496 496 # calling functions defined in the script that use other things from
497 497 # the script will fail, because the function's closure had references
498 498 # to the original objects, which are now all None. So we must protect
499 499 # these modules from deletion by keeping a cache.
500 500 #
501 501 # To avoid keeping stale modules around (we only need the one from the
502 502 # last run), we use a dict keyed with the full path to the script, so
503 503 # only the last version of the module is held in the cache. Note,
504 504 # however, that we must cache the module *namespace contents* (their
505 505 # __dict__). Because if we try to cache the actual modules, old ones
506 506 # (uncached) could be destroyed while still holding references (such as
507 507 # those held by GUI objects that tend to be long-lived)>
508 508 #
509 509 # The %reset command will flush this cache. See the cache_main_mod()
510 510 # and clear_main_mod_cache() methods for details on use.
511 511
512 512 # This is the cache used for 'main' namespaces
513 513 self._main_ns_cache = {}
514 514 # And this is the single instance of FakeModule whose __dict__ we keep
515 515 # copying and clearing for reuse on each %run
516 516 self._user_main_module = FakeModule()
517 517
518 518 # A table holding all the namespaces IPython deals with, so that
519 519 # introspection facilities can search easily.
520 520 self.ns_table = {'user':user_ns,
521 521 'user_global':user_global_ns,
522 522 'alias':self.alias_table,
523 523 'internal':self.internal_ns,
524 524 'builtin':__builtin__.__dict__
525 525 }
526 526
527 527 # Similarly, track all namespaces where references can be held and that
528 528 # we can safely clear (so it can NOT include builtin). This one can be
529 529 # a simple list.
530 530 self.ns_refs_table = [ user_ns, user_global_ns, self.user_config_ns,
531 531 self.alias_table, self.internal_ns,
532 532 self._main_ns_cache ]
533 533
534 534 # We need to insert into sys.modules something that looks like a
535 535 # module but which accesses the IPython namespace, for shelve and
536 536 # pickle to work interactively. Normally they rely on getting
537 537 # everything out of __main__, but for embedding purposes each IPython
538 538 # instance has its own private namespace, so we can't go shoving
539 539 # everything into __main__.
540 540
541 541 # note, however, that we should only do this for non-embedded
542 542 # ipythons, which really mimic the __main__.__dict__ with their own
543 543 # namespace. Embedded instances, on the other hand, should not do
544 544 # this because they need to manage the user local/global namespaces
545 545 # only, but they live within a 'normal' __main__ (meaning, they
546 546 # shouldn't overtake the execution environment of the script they're
547 547 # embedded in).
548 548
549 549 if not embedded:
550 550 try:
551 551 main_name = self.user_ns['__name__']
552 552 except KeyError:
553 553 raise KeyError,'user_ns dictionary MUST have a "__name__" key'
554 554 else:
555 555 #print "pickle hack in place" # dbg
556 556 #print 'main_name:',main_name # dbg
557 557 sys.modules[main_name] = FakeModule(self.user_ns)
558 558
559 559 # List of input with multi-line handling.
560 560 self.input_hist = InputList()
561 561 # This one will hold the 'raw' input history, without any
562 562 # pre-processing. This will allow users to retrieve the input just as
563 563 # it was exactly typed in by the user, with %hist -r.
564 564 self.input_hist_raw = InputList()
565 565
566 566 # list of visited directories
567 567 try:
568 568 self.dir_hist = [os.getcwd()]
569 569 except OSError:
570 570 self.dir_hist = []
571 571
572 572 # dict of output history
573 573 self.output_hist = {}
574 574
575 575 # Get system encoding at startup time. Certain terminals (like Emacs
576 576 # under Win32 have it set to None, and we need to have a known valid
577 577 # encoding to use in the raw_input() method
578 578 try:
579 579 self.stdin_encoding = sys.stdin.encoding or 'ascii'
580 580 except AttributeError:
581 581 self.stdin_encoding = 'ascii'
582 582
583 583 # dict of things NOT to alias (keywords, builtins and some magics)
584 584 no_alias = {}
585 585 no_alias_magics = ['cd','popd','pushd','dhist','alias','unalias']
586 586 for key in keyword.kwlist + no_alias_magics:
587 587 no_alias[key] = 1
588 588 no_alias.update(__builtin__.__dict__)
589 589 self.no_alias = no_alias
590 590
591 591 # Object variable to store code object waiting execution. This is
592 592 # used mainly by the multithreaded shells, but it can come in handy in
593 593 # other situations. No need to use a Queue here, since it's a single
594 594 # item which gets cleared once run.
595 595 self.code_to_run = None
596 596
597 597 # escapes for automatic behavior on the command line
598 598 self.ESC_SHELL = '!'
599 599 self.ESC_SH_CAP = '!!'
600 600 self.ESC_HELP = '?'
601 601 self.ESC_MAGIC = '%'
602 602 self.ESC_QUOTE = ','
603 603 self.ESC_QUOTE2 = ';'
604 604 self.ESC_PAREN = '/'
605 605
606 606 # And their associated handlers
607 607 self.esc_handlers = {self.ESC_PAREN : self.handle_auto,
608 608 self.ESC_QUOTE : self.handle_auto,
609 609 self.ESC_QUOTE2 : self.handle_auto,
610 610 self.ESC_MAGIC : self.handle_magic,
611 611 self.ESC_HELP : self.handle_help,
612 612 self.ESC_SHELL : self.handle_shell_escape,
613 613 self.ESC_SH_CAP : self.handle_shell_escape,
614 614 }
615 615
616 616 # class initializations
617 617 Magic.__init__(self,self)
618 618
619 619 # Python source parser/formatter for syntax highlighting
620 620 pyformat = PyColorize.Parser().format
621 621 self.pycolorize = lambda src: pyformat(src,'str',self.rc['colors'])
622 622
623 623 # hooks holds pointers used for user-side customizations
624 624 self.hooks = Struct()
625 625
626 626 self.strdispatchers = {}
627 627
628 628 # Set all default hooks, defined in the IPython.hooks module.
629 629 import IPython.core.hooks
630 630 hooks = IPython.core.hooks
631 631 for hook_name in hooks.__all__:
632 632 # default hooks have priority 100, i.e. low; user hooks should have
633 633 # 0-100 priority
634 634 self.set_hook(hook_name,getattr(hooks,hook_name), 100)
635 635 #print "bound hook",hook_name
636 636
637 637 # Flag to mark unconditional exit
638 638 self.exit_now = False
639 639
640 640 self.usage_min = """\
641 641 An enhanced console for Python.
642 642 Some of its features are:
643 643 - Readline support if the readline library is present.
644 644 - Tab completion in the local namespace.
645 645 - Logging of input, see command-line options.
646 646 - System shell escape via ! , eg !ls.
647 647 - Magic commands, starting with a % (like %ls, %pwd, %cd, etc.)
648 648 - Keeps track of locally defined variables via %who, %whos.
649 649 - Show object information with a ? eg ?x or x? (use ?? for more info).
650 650 """
651 651 if usage: self.usage = usage
652 652 else: self.usage = self.usage_min
653 653
654 654 # Storage
655 655 self.rc = rc # This will hold all configuration information
656 656 self.pager = 'less'
657 657 # temporary files used for various purposes. Deleted at exit.
658 658 self.tempfiles = []
659 659
660 660 # Keep track of readline usage (later set by init_readline)
661 661 self.has_readline = False
662 662
663 663 # template for logfile headers. It gets resolved at runtime by the
664 664 # logstart method.
665 665 self.loghead_tpl = \
666 666 """#log# Automatic Logger file. *** THIS MUST BE THE FIRST LINE ***
667 667 #log# DO NOT CHANGE THIS LINE OR THE TWO BELOW
668 668 #log# opts = %s
669 669 #log# args = %s
670 670 #log# It is safe to make manual edits below here.
671 671 #log#-----------------------------------------------------------------------
672 672 """
673 673 # for pushd/popd management
674 674 try:
675 675 self.home_dir = get_home_dir()
676 676 except HomeDirError,msg:
677 677 fatal(msg)
678 678
679 679 self.dir_stack = []
680 680
681 681 # Functions to call the underlying shell.
682 682
683 683 # The first is similar to os.system, but it doesn't return a value,
684 684 # and it allows interpolation of variables in the user's namespace.
685 685 self.system = lambda cmd: \
686 686 self.hooks.shell_hook(self.var_expand(cmd,depth=2))
687 687
688 688 # These are for getoutput and getoutputerror:
689 689 self.getoutput = lambda cmd: \
690 690 getoutput(self.var_expand(cmd,depth=2),
691 691 header=self.rc.system_header,
692 692 verbose=self.rc.system_verbose)
693 693
694 694 self.getoutputerror = lambda cmd: \
695 695 getoutputerror(self.var_expand(cmd,depth=2),
696 696 header=self.rc.system_header,
697 697 verbose=self.rc.system_verbose)
698 698
699 699
700 700 # keep track of where we started running (mainly for crash post-mortem)
701 701 self.starting_dir = os.getcwd()
702 702
703 703 # Various switches which can be set
704 704 self.CACHELENGTH = 5000 # this is cheap, it's just text
705 705 self.BANNER = "Python %(version)s on %(platform)s\n" % sys.__dict__
706 706 self.banner2 = banner2
707 707
708 708 # TraceBack handlers:
709 709
710 710 # Syntax error handler.
711 711 self.SyntaxTB = SyntaxTB(color_scheme='NoColor')
712 712
713 713 # The interactive one is initialized with an offset, meaning we always
714 714 # want to remove the topmost item in the traceback, which is our own
715 715 # internal code. Valid modes: ['Plain','Context','Verbose']
716 716 self.InteractiveTB = ultraTB.AutoFormattedTB(mode = 'Plain',
717 717 color_scheme='NoColor',
718 718 tb_offset = 1)
719 719
720 720 # IPython itself shouldn't crash. This will produce a detailed
721 721 # post-mortem if it does. But we only install the crash handler for
722 722 # non-threaded shells, the threaded ones use a normal verbose reporter
723 723 # and lose the crash handler. This is because exceptions in the main
724 724 # thread (such as in GUI code) propagate directly to sys.excepthook,
725 725 # and there's no point in printing crash dumps for every user exception.
726 726 if self.isthreaded:
727 727 ipCrashHandler = ultraTB.FormattedTB()
728 728 else:
729 729 from IPython.core import crashhandler
730 730 ipCrashHandler = crashhandler.IPythonCrashHandler(self)
731 731 self.set_crash_handler(ipCrashHandler)
732 732
733 733 # and add any custom exception handlers the user may have specified
734 734 self.set_custom_exc(*custom_exceptions)
735 735
736 736 # indentation management
737 737 self.autoindent = False
738 738 self.indent_current_nsp = 0
739 739
740 740 # Make some aliases automatically
741 741 # Prepare list of shell aliases to auto-define
742 742 if os.name == 'posix':
743 743 auto_alias = ('mkdir mkdir', 'rmdir rmdir',
744 744 'mv mv -i','rm rm -i','cp cp -i',
745 745 'cat cat','less less','clear clear',
746 746 # a better ls
747 747 'ls ls -F',
748 748 # long ls
749 749 'll ls -lF')
750 750 # Extra ls aliases with color, which need special treatment on BSD
751 751 # variants
752 752 ls_extra = ( # color ls
753 753 'lc ls -F -o --color',
754 754 # ls normal files only
755 755 'lf ls -F -o --color %l | grep ^-',
756 756 # ls symbolic links
757 757 'lk ls -F -o --color %l | grep ^l',
758 758 # directories or links to directories,
759 759 'ldir ls -F -o --color %l | grep /$',
760 760 # things which are executable
761 761 'lx ls -F -o --color %l | grep ^-..x',
762 762 )
763 763 # The BSDs don't ship GNU ls, so they don't understand the
764 764 # --color switch out of the box
765 765 if 'bsd' in sys.platform:
766 766 ls_extra = ( # ls normal files only
767 767 'lf ls -lF | grep ^-',
768 768 # ls symbolic links
769 769 'lk ls -lF | grep ^l',
770 770 # directories or links to directories,
771 771 'ldir ls -lF | grep /$',
772 772 # things which are executable
773 773 'lx ls -lF | grep ^-..x',
774 774 )
775 775 auto_alias = auto_alias + ls_extra
776 776 elif os.name in ['nt','dos']:
777 777 auto_alias = ('ls dir /on',
778 778 'ddir dir /ad /on', 'ldir dir /ad /on',
779 779 'mkdir mkdir','rmdir rmdir','echo echo',
780 780 'ren ren','cls cls','copy copy')
781 781 else:
782 782 auto_alias = ()
783 783 self.auto_alias = [s.split(None,1) for s in auto_alias]
784 784
785 785 # Produce a public API instance
786 786 self.api = ipapi.IPApi(self)
787 787
788 788 # Initialize all user-visible namespaces
789 789 self.init_namespaces()
790 790
791 791 # Call the actual (public) initializer
792 792 self.init_auto_alias()
793 793
794 794 # track which builtins we add, so we can clean up later
795 795 self.builtins_added = {}
796 796 # This method will add the necessary builtins for operation, but
797 797 # tracking what it did via the builtins_added dict.
798 798
799 799 #TODO: remove this, redundant
800 800 self.add_builtins()
801 801 # end __init__
802 802
803 803 def var_expand(self,cmd,depth=0):
804 804 """Expand python variables in a string.
805 805
806 806 The depth argument indicates how many frames above the caller should
807 807 be walked to look for the local namespace where to expand variables.
808 808
809 809 The global namespace for expansion is always the user's interactive
810 810 namespace.
811 811 """
812 812
813 813 return str(ItplNS(cmd,
814 814 self.user_ns, # globals
815 815 # Skip our own frame in searching for locals:
816 816 sys._getframe(depth+1).f_locals # locals
817 817 ))
818 818
819 819 def pre_config_initialization(self):
820 820 """Pre-configuration init method
821 821
822 822 This is called before the configuration files are processed to
823 823 prepare the services the config files might need.
824 824
825 825 self.rc already has reasonable default values at this point.
826 826 """
827 827 rc = self.rc
828 828 try:
829 829 self.db = pickleshare.PickleShareDB(rc.ipythondir + "/db")
830 830 except exceptions.UnicodeDecodeError:
831 831 print "Your ipythondir can't be decoded to unicode!"
832 832 print "Please set HOME environment variable to something that"
833 833 print r"only has ASCII characters, e.g. c:\home"
834 834 print "Now it is",rc.ipythondir
835 835 sys.exit()
836 836 self.shadowhist = IPython.core.history.ShadowHist(self.db)
837 837
838 838 def post_config_initialization(self):
839 839 """Post configuration init method
840 840
841 841 This is called after the configuration files have been processed to
842 842 'finalize' the initialization."""
843 843
844 844 rc = self.rc
845 845
846 846 # Object inspector
847 847 self.inspector = OInspect.Inspector(OInspect.InspectColors,
848 848 PyColorize.ANSICodeColors,
849 849 'NoColor',
850 850 rc.object_info_string_level)
851 851
852 852 self.rl_next_input = None
853 853 self.rl_do_indent = False
854 854 # Load readline proper
855 855 if rc.readline:
856 856 self.init_readline()
857 857
858 858 # local shortcut, this is used a LOT
859 859 self.log = self.logger.log
860 860
861 861 # Initialize cache, set in/out prompts and printing system
862 862 self.outputcache = CachedOutput(self,
863 863 rc.cache_size,
864 864 rc.pprint,
865 865 input_sep = rc.separate_in,
866 866 output_sep = rc.separate_out,
867 867 output_sep2 = rc.separate_out2,
868 868 ps1 = rc.prompt_in1,
869 869 ps2 = rc.prompt_in2,
870 870 ps_out = rc.prompt_out,
871 871 pad_left = rc.prompts_pad_left)
872 872
873 873 # user may have over-ridden the default print hook:
874 874 try:
875 875 self.outputcache.__class__.display = self.hooks.display
876 876 except AttributeError:
877 877 pass
878 878
879 879 # I don't like assigning globally to sys, because it means when
880 880 # embedding instances, each embedded instance overrides the previous
881 881 # choice. But sys.displayhook seems to be called internally by exec,
882 882 # so I don't see a way around it. We first save the original and then
883 883 # overwrite it.
884 884 self.sys_displayhook = sys.displayhook
885 885 sys.displayhook = self.outputcache
886 886
887 887 # Do a proper resetting of doctest, including the necessary displayhook
888 888 # monkeypatching
889 889 try:
890 890 doctest_reload()
891 891 except ImportError:
892 892 warn("doctest module does not exist.")
893 893
894 894 # Set user colors (don't do it in the constructor above so that it
895 895 # doesn't crash if colors option is invalid)
896 896 self.magic_colors(rc.colors)
897 897
898 898 # Set calling of pdb on exceptions
899 899 self.call_pdb = rc.pdb
900 900
901 901 # Load user aliases
902 902 for alias in rc.alias:
903 903 self.magic_alias(alias)
904 904
905 905 self.hooks.late_startup_hook()
906 906
907 907 for cmd in self.rc.autoexec:
908 908 #print "autoexec>",cmd #dbg
909 909 self.api.runlines(cmd)
910 910
911 911 batchrun = False
912 912 for batchfile in [path(arg) for arg in self.rc.args
913 913 if arg.lower().endswith('.ipy')]:
914 914 if not batchfile.isfile():
915 915 print "No such batch file:", batchfile
916 916 continue
917 917 self.api.runlines(batchfile.text())
918 918 batchrun = True
919 919 # without -i option, exit after running the batch file
920 920 if batchrun and not self.rc.interact:
921 921 self.ask_exit()
922 922
923 923 def init_namespaces(self):
924 924 """Initialize all user-visible namespaces to their minimum defaults.
925 925
926 926 Certain history lists are also initialized here, as they effectively
927 927 act as user namespaces.
928 928
929 929 Note
930 930 ----
931 931 All data structures here are only filled in, they are NOT reset by this
932 932 method. If they were not empty before, data will simply be added to
933 933 therm.
934 934 """
935 935 # The user namespace MUST have a pointer to the shell itself.
936 936 self.user_ns[self.name] = self
937 937
938 938 # Store the public api instance
939 939 self.user_ns['_ip'] = self.api
940 940
941 941 # make global variables for user access to the histories
942 942 self.user_ns['_ih'] = self.input_hist
943 943 self.user_ns['_oh'] = self.output_hist
944 944 self.user_ns['_dh'] = self.dir_hist
945 945
946 946 # user aliases to input and output histories
947 947 self.user_ns['In'] = self.input_hist
948 948 self.user_ns['Out'] = self.output_hist
949 949
950 950 self.user_ns['_sh'] = IPython.shadowns
951 951
952 952 # Fill the history zero entry, user counter starts at 1
953 953 self.input_hist.append('\n')
954 954 self.input_hist_raw.append('\n')
955 955
956 956 def add_builtins(self):
957 957 """Store ipython references into the builtin namespace.
958 958
959 959 Some parts of ipython operate via builtins injected here, which hold a
960 960 reference to IPython itself."""
961 961
962 962 # TODO: deprecate all of these, they are unsafe
963 963 builtins_new = dict(__IPYTHON__ = self,
964 964 ip_set_hook = self.set_hook,
965 965 jobs = self.jobs,
966 966 ipmagic = wrap_deprecated(self.ipmagic,'_ip.magic()'),
967 967 ipalias = wrap_deprecated(self.ipalias),
968 968 ipsystem = wrap_deprecated(self.ipsystem,'_ip.system()'),
969 969 #_ip = self.api
970 970 )
971 971 for biname,bival in builtins_new.items():
972 972 try:
973 973 # store the orignal value so we can restore it
974 974 self.builtins_added[biname] = __builtin__.__dict__[biname]
975 975 except KeyError:
976 976 # or mark that it wasn't defined, and we'll just delete it at
977 977 # cleanup
978 978 self.builtins_added[biname] = Undefined
979 979 __builtin__.__dict__[biname] = bival
980 980
981 981 # Keep in the builtins a flag for when IPython is active. We set it
982 982 # with setdefault so that multiple nested IPythons don't clobber one
983 983 # another. Each will increase its value by one upon being activated,
984 984 # which also gives us a way to determine the nesting level.
985 985 __builtin__.__dict__.setdefault('__IPYTHON__active',0)
986 986
987 987 def clean_builtins(self):
988 988 """Remove any builtins which might have been added by add_builtins, or
989 989 restore overwritten ones to their previous values."""
990 990 for biname,bival in self.builtins_added.items():
991 991 if bival is Undefined:
992 992 del __builtin__.__dict__[biname]
993 993 else:
994 994 __builtin__.__dict__[biname] = bival
995 995 self.builtins_added.clear()
996 996
997 997 def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None):
998 998 """set_hook(name,hook) -> sets an internal IPython hook.
999 999
1000 1000 IPython exposes some of its internal API as user-modifiable hooks. By
1001 1001 adding your function to one of these hooks, you can modify IPython's
1002 1002 behavior to call at runtime your own routines."""
1003 1003
1004 1004 # At some point in the future, this should validate the hook before it
1005 1005 # accepts it. Probably at least check that the hook takes the number
1006 1006 # of args it's supposed to.
1007 1007
1008 1008 f = new.instancemethod(hook,self,self.__class__)
1009 1009
1010 1010 # check if the hook is for strdispatcher first
1011 1011 if str_key is not None:
1012 1012 sdp = self.strdispatchers.get(name, StrDispatch())
1013 1013 sdp.add_s(str_key, f, priority )
1014 1014 self.strdispatchers[name] = sdp
1015 1015 return
1016 1016 if re_key is not None:
1017 1017 sdp = self.strdispatchers.get(name, StrDispatch())
1018 1018 sdp.add_re(re.compile(re_key), f, priority )
1019 1019 self.strdispatchers[name] = sdp
1020 1020 return
1021 1021
1022 1022 dp = getattr(self.hooks, name, None)
1023 1023 if name not in IPython.core.hooks.__all__:
1024 1024 print "Warning! Hook '%s' is not one of %s" % (name, IPython.core.hooks.__all__ )
1025 1025 if not dp:
1026 1026 dp = IPython.core.hooks.CommandChainDispatcher()
1027 1027
1028 1028 try:
1029 1029 dp.add(f,priority)
1030 1030 except AttributeError:
1031 1031 # it was not commandchain, plain old func - replace
1032 1032 dp = f
1033 1033
1034 1034 setattr(self.hooks,name, dp)
1035 1035
1036 1036
1037 1037 #setattr(self.hooks,name,new.instancemethod(hook,self,self.__class__))
1038 1038
1039 1039 def set_crash_handler(self,crashHandler):
1040 1040 """Set the IPython crash handler.
1041 1041
1042 1042 This must be a callable with a signature suitable for use as
1043 1043 sys.excepthook."""
1044 1044
1045 1045 # Install the given crash handler as the Python exception hook
1046 1046 sys.excepthook = crashHandler
1047 1047
1048 1048 # The instance will store a pointer to this, so that runtime code
1049 1049 # (such as magics) can access it. This is because during the
1050 1050 # read-eval loop, it gets temporarily overwritten (to deal with GUI
1051 1051 # frameworks).
1052 1052 self.sys_excepthook = sys.excepthook
1053 1053
1054 1054
1055 1055 def set_custom_exc(self,exc_tuple,handler):
1056 1056 """set_custom_exc(exc_tuple,handler)
1057 1057
1058 1058 Set a custom exception handler, which will be called if any of the
1059 1059 exceptions in exc_tuple occur in the mainloop (specifically, in the
1060 1060 runcode() method.
1061 1061
1062 1062 Inputs:
1063 1063
1064 1064 - exc_tuple: a *tuple* of valid exceptions to call the defined
1065 1065 handler for. It is very important that you use a tuple, and NOT A
1066 1066 LIST here, because of the way Python's except statement works. If
1067 1067 you only want to trap a single exception, use a singleton tuple:
1068 1068
1069 1069 exc_tuple == (MyCustomException,)
1070 1070
1071 1071 - handler: this must be defined as a function with the following
1072 1072 basic interface: def my_handler(self,etype,value,tb).
1073 1073
1074 1074 This will be made into an instance method (via new.instancemethod)
1075 1075 of IPython itself, and it will be called if any of the exceptions
1076 1076 listed in the exc_tuple are caught. If the handler is None, an
1077 1077 internal basic one is used, which just prints basic info.
1078 1078
1079 1079 WARNING: by putting in your own exception handler into IPython's main
1080 1080 execution loop, you run a very good chance of nasty crashes. This
1081 1081 facility should only be used if you really know what you are doing."""
1082 1082
1083 1083 assert type(exc_tuple)==type(()) , \
1084 1084 "The custom exceptions must be given AS A TUPLE."
1085 1085
1086 1086 def dummy_handler(self,etype,value,tb):
1087 1087 print '*** Simple custom exception handler ***'
1088 1088 print 'Exception type :',etype
1089 1089 print 'Exception value:',value
1090 1090 print 'Traceback :',tb
1091 1091 print 'Source code :','\n'.join(self.buffer)
1092 1092
1093 1093 if handler is None: handler = dummy_handler
1094 1094
1095 1095 self.CustomTB = new.instancemethod(handler,self,self.__class__)
1096 1096 self.custom_exceptions = exc_tuple
1097 1097
1098 1098 def set_custom_completer(self,completer,pos=0):
1099 1099 """set_custom_completer(completer,pos=0)
1100 1100
1101 1101 Adds a new custom completer function.
1102 1102
1103 1103 The position argument (defaults to 0) is the index in the completers
1104 1104 list where you want the completer to be inserted."""
1105 1105
1106 1106 newcomp = new.instancemethod(completer,self.Completer,
1107 1107 self.Completer.__class__)
1108 1108 self.Completer.matchers.insert(pos,newcomp)
1109 1109
1110 1110 def set_completer(self):
1111 1111 """reset readline's completer to be our own."""
1112 1112 self.readline.set_completer(self.Completer.complete)
1113 1113
1114 1114 def _get_call_pdb(self):
1115 1115 return self._call_pdb
1116 1116
1117 1117 def _set_call_pdb(self,val):
1118 1118
1119 1119 if val not in (0,1,False,True):
1120 1120 raise ValueError,'new call_pdb value must be boolean'
1121 1121
1122 1122 # store value in instance
1123 1123 self._call_pdb = val
1124 1124
1125 1125 # notify the actual exception handlers
1126 1126 self.InteractiveTB.call_pdb = val
1127 1127 if self.isthreaded:
1128 1128 try:
1129 1129 self.sys_excepthook.call_pdb = val
1130 1130 except:
1131 1131 warn('Failed to activate pdb for threaded exception handler')
1132 1132
1133 1133 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
1134 1134 'Control auto-activation of pdb at exceptions')
1135 1135
1136 1136 # These special functions get installed in the builtin namespace, to
1137 1137 # provide programmatic (pure python) access to magics, aliases and system
1138 1138 # calls. This is important for logging, user scripting, and more.
1139 1139
1140 1140 # We are basically exposing, via normal python functions, the three
1141 1141 # mechanisms in which ipython offers special call modes (magics for
1142 1142 # internal control, aliases for direct system access via pre-selected
1143 1143 # names, and !cmd for calling arbitrary system commands).
1144 1144
1145 1145 def ipmagic(self,arg_s):
1146 1146 """Call a magic function by name.
1147 1147
1148 1148 Input: a string containing the name of the magic function to call and any
1149 1149 additional arguments to be passed to the magic.
1150 1150
1151 1151 ipmagic('name -opt foo bar') is equivalent to typing at the ipython
1152 1152 prompt:
1153 1153
1154 1154 In[1]: %name -opt foo bar
1155 1155
1156 1156 To call a magic without arguments, simply use ipmagic('name').
1157 1157
1158 1158 This provides a proper Python function to call IPython's magics in any
1159 1159 valid Python code you can type at the interpreter, including loops and
1160 1160 compound statements. It is added by IPython to the Python builtin
1161 1161 namespace upon initialization."""
1162 1162
1163 1163 args = arg_s.split(' ',1)
1164 1164 magic_name = args[0]
1165 1165 magic_name = magic_name.lstrip(self.ESC_MAGIC)
1166 1166
1167 1167 try:
1168 1168 magic_args = args[1]
1169 1169 except IndexError:
1170 1170 magic_args = ''
1171 1171 fn = getattr(self,'magic_'+magic_name,None)
1172 1172 if fn is None:
1173 1173 error("Magic function `%s` not found." % magic_name)
1174 1174 else:
1175 1175 magic_args = self.var_expand(magic_args,1)
1176 1176 return fn(magic_args)
1177 1177
1178 1178 def ipalias(self,arg_s):
1179 1179 """Call an alias by name.
1180 1180
1181 1181 Input: a string containing the name of the alias to call and any
1182 1182 additional arguments to be passed to the magic.
1183 1183
1184 1184 ipalias('name -opt foo bar') is equivalent to typing at the ipython
1185 1185 prompt:
1186 1186
1187 1187 In[1]: name -opt foo bar
1188 1188
1189 1189 To call an alias without arguments, simply use ipalias('name').
1190 1190
1191 1191 This provides a proper Python function to call IPython's aliases in any
1192 1192 valid Python code you can type at the interpreter, including loops and
1193 1193 compound statements. It is added by IPython to the Python builtin
1194 1194 namespace upon initialization."""
1195 1195
1196 1196 args = arg_s.split(' ',1)
1197 1197 alias_name = args[0]
1198 1198 try:
1199 1199 alias_args = args[1]
1200 1200 except IndexError:
1201 1201 alias_args = ''
1202 1202 if alias_name in self.alias_table:
1203 1203 self.call_alias(alias_name,alias_args)
1204 1204 else:
1205 1205 error("Alias `%s` not found." % alias_name)
1206 1206
1207 1207 def ipsystem(self,arg_s):
1208 1208 """Make a system call, using IPython."""
1209 1209
1210 1210 self.system(arg_s)
1211 1211
1212 1212 def complete(self,text):
1213 1213 """Return a sorted list of all possible completions on text.
1214 1214
1215 1215 Inputs:
1216 1216
1217 1217 - text: a string of text to be completed on.
1218 1218
1219 1219 This is a wrapper around the completion mechanism, similar to what
1220 1220 readline does at the command line when the TAB key is hit. By
1221 1221 exposing it as a method, it can be used by other non-readline
1222 1222 environments (such as GUIs) for text completion.
1223 1223
1224 1224 Simple usage example:
1225 1225
1226 1226 In [7]: x = 'hello'
1227 1227
1228 1228 In [8]: x
1229 1229 Out[8]: 'hello'
1230 1230
1231 1231 In [9]: print x
1232 1232 hello
1233 1233
1234 1234 In [10]: _ip.IP.complete('x.l')
1235 1235 Out[10]: ['x.ljust', 'x.lower', 'x.lstrip']
1236 1236 """
1237 1237
1238 1238 complete = self.Completer.complete
1239 1239 state = 0
1240 1240 # use a dict so we get unique keys, since ipyhton's multiple
1241 1241 # completers can return duplicates. When we make 2.4 a requirement,
1242 1242 # start using sets instead, which are faster.
1243 1243 comps = {}
1244 1244 while True:
1245 1245 newcomp = complete(text,state,line_buffer=text)
1246 1246 if newcomp is None:
1247 1247 break
1248 1248 comps[newcomp] = 1
1249 1249 state += 1
1250 1250 outcomps = comps.keys()
1251 1251 outcomps.sort()
1252 1252 #print "T:",text,"OC:",outcomps # dbg
1253 1253 #print "vars:",self.user_ns.keys()
1254 1254 return outcomps
1255 1255
1256 1256 def set_completer_frame(self, frame=None):
1257 1257 if frame:
1258 1258 self.Completer.namespace = frame.f_locals
1259 1259 self.Completer.global_namespace = frame.f_globals
1260 1260 else:
1261 1261 self.Completer.namespace = self.user_ns
1262 1262 self.Completer.global_namespace = self.user_global_ns
1263 1263
1264 1264 def init_auto_alias(self):
1265 1265 """Define some aliases automatically.
1266 1266
1267 1267 These are ALL parameter-less aliases"""
1268 1268
1269 1269 for alias,cmd in self.auto_alias:
1270 1270 self.getapi().defalias(alias,cmd)
1271 1271
1272 1272
1273 1273 def alias_table_validate(self,verbose=0):
1274 1274 """Update information about the alias table.
1275 1275
1276 1276 In particular, make sure no Python keywords/builtins are in it."""
1277 1277
1278 1278 no_alias = self.no_alias
1279 1279 for k in self.alias_table.keys():
1280 1280 if k in no_alias:
1281 1281 del self.alias_table[k]
1282 1282 if verbose:
1283 1283 print ("Deleting alias <%s>, it's a Python "
1284 1284 "keyword or builtin." % k)
1285 1285
1286 1286 def set_autoindent(self,value=None):
1287 1287 """Set the autoindent flag, checking for readline support.
1288 1288
1289 1289 If called with no arguments, it acts as a toggle."""
1290 1290
1291 1291 if not self.has_readline:
1292 1292 if os.name == 'posix':
1293 1293 warn("The auto-indent feature requires the readline library")
1294 1294 self.autoindent = 0
1295 1295 return
1296 1296 if value is None:
1297 1297 self.autoindent = not self.autoindent
1298 1298 else:
1299 1299 self.autoindent = value
1300 1300
1301 1301 def rc_set_toggle(self,rc_field,value=None):
1302 1302 """Set or toggle a field in IPython's rc config. structure.
1303 1303
1304 1304 If called with no arguments, it acts as a toggle.
1305 1305
1306 1306 If called with a non-existent field, the resulting AttributeError
1307 1307 exception will propagate out."""
1308 1308
1309 1309 rc_val = getattr(self.rc,rc_field)
1310 1310 if value is None:
1311 1311 value = not rc_val
1312 1312 setattr(self.rc,rc_field,value)
1313 1313
1314 1314 def user_setup(self,ipythondir,rc_suffix,mode='install'):
1315 1315 """Install the user configuration directory.
1316 1316
1317 1317 Note
1318 1318 ----
1319 1319 DEPRECATED: use the top-level user_setup() function instead.
1320 1320 """
1321 1321 return user_setup(ipythondir,rc_suffix,mode)
1322 1322
1323 1323 def atexit_operations(self):
1324 1324 """This will be executed at the time of exit.
1325 1325
1326 1326 Saving of persistent data should be performed here. """
1327 1327
1328 1328 #print '*** IPython exit cleanup ***' # dbg
1329 1329 # input history
1330 1330 self.savehist()
1331 1331
1332 1332 # Cleanup all tempfiles left around
1333 1333 for tfile in self.tempfiles:
1334 1334 try:
1335 1335 os.unlink(tfile)
1336 1336 except OSError:
1337 1337 pass
1338 1338
1339 1339 # Clear all user namespaces to release all references cleanly.
1340 1340 self.reset()
1341 1341
1342 1342 # Run user hooks
1343 1343 self.hooks.shutdown_hook()
1344 1344
1345 1345 def reset(self):
1346 1346 """Clear all internal namespaces.
1347 1347
1348 1348 Note that this is much more aggressive than %reset, since it clears
1349 1349 fully all namespaces, as well as all input/output lists.
1350 1350 """
1351 1351 for ns in self.ns_refs_table:
1352 1352 ns.clear()
1353 1353
1354 1354 # Clear input and output histories
1355 1355 self.input_hist[:] = []
1356 1356 self.input_hist_raw[:] = []
1357 1357 self.output_hist.clear()
1358 1358 # Restore the user namespaces to minimal usability
1359 1359 self.init_namespaces()
1360 1360
1361 1361 def savehist(self):
1362 1362 """Save input history to a file (via readline library)."""
1363 1363
1364 1364 if not self.has_readline:
1365 1365 return
1366 1366
1367 1367 try:
1368 1368 self.readline.write_history_file(self.histfile)
1369 1369 except:
1370 1370 print 'Unable to save IPython command history to file: ' + \
1371 1371 `self.histfile`
1372 1372
1373 1373 def reloadhist(self):
1374 1374 """Reload the input history from disk file."""
1375 1375
1376 1376 if self.has_readline:
1377 1377 try:
1378 1378 self.readline.clear_history()
1379 1379 self.readline.read_history_file(self.shell.histfile)
1380 1380 except AttributeError:
1381 1381 pass
1382 1382
1383 1383
1384 1384 def history_saving_wrapper(self, func):
1385 1385 """ Wrap func for readline history saving
1386 1386
1387 1387 Convert func into callable that saves & restores
1388 1388 history around the call """
1389 1389
1390 1390 if not self.has_readline:
1391 1391 return func
1392 1392
1393 1393 def wrapper():
1394 1394 self.savehist()
1395 1395 try:
1396 1396 func()
1397 1397 finally:
1398 1398 readline.read_history_file(self.histfile)
1399 1399 return wrapper
1400 1400
1401 1401 def pre_readline(self):
1402 1402 """readline hook to be used at the start of each line.
1403 1403
1404 1404 Currently it handles auto-indent only."""
1405 1405
1406 1406 #debugx('self.indent_current_nsp','pre_readline:')
1407 1407
1408 1408 if self.rl_do_indent:
1409 1409 self.readline.insert_text(self.indent_current_str())
1410 1410 if self.rl_next_input is not None:
1411 1411 self.readline.insert_text(self.rl_next_input)
1412 1412 self.rl_next_input = None
1413 1413
1414 1414 def init_readline(self):
1415 1415 """Command history completion/saving/reloading."""
1416 1416
1417 1417
1418 1418 import IPython.rlineimpl as readline
1419 1419
1420 1420 if not readline.have_readline:
1421 1421 self.has_readline = 0
1422 1422 self.readline = None
1423 1423 # no point in bugging windows users with this every time:
1424 1424 warn('Readline services not available on this platform.')
1425 1425 else:
1426 1426 sys.modules['readline'] = readline
1427 1427 import atexit
1428 1428 from IPython.core.completer import IPCompleter
1429 1429 self.Completer = IPCompleter(self,
1430 1430 self.user_ns,
1431 1431 self.user_global_ns,
1432 1432 self.rc.readline_omit__names,
1433 1433 self.alias_table)
1434 1434 sdisp = self.strdispatchers.get('complete_command', StrDispatch())
1435 1435 self.strdispatchers['complete_command'] = sdisp
1436 1436 self.Completer.custom_completers = sdisp
1437 1437 # Platform-specific configuration
1438 1438 if os.name == 'nt':
1439 1439 self.readline_startup_hook = readline.set_pre_input_hook
1440 1440 else:
1441 1441 self.readline_startup_hook = readline.set_startup_hook
1442 1442
1443 1443 # Load user's initrc file (readline config)
1444 1444 # Or if libedit is used, load editrc.
1445 1445 inputrc_name = os.environ.get('INPUTRC')
1446 1446 if inputrc_name is None:
1447 1447 home_dir = get_home_dir()
1448 1448 if home_dir is not None:
1449 1449 inputrc_name = '.inputrc'
1450 1450 if readline.uses_libedit:
1451 1451 inputrc_name = '.editrc'
1452 1452 inputrc_name = os.path.join(home_dir, inputrc_name)
1453 1453 if os.path.isfile(inputrc_name):
1454 1454 try:
1455 1455 readline.read_init_file(inputrc_name)
1456 1456 except:
1457 1457 warn('Problems reading readline initialization file <%s>'
1458 1458 % inputrc_name)
1459 1459
1460 1460 self.has_readline = 1
1461 1461 self.readline = readline
1462 1462 # save this in sys so embedded copies can restore it properly
1463 1463 sys.ipcompleter = self.Completer.complete
1464 1464 self.set_completer()
1465 1465
1466 1466 # Configure readline according to user's prefs
1467 1467 # This is only done if GNU readline is being used. If libedit
1468 1468 # is being used (as on Leopard) the readline config is
1469 1469 # not run as the syntax for libedit is different.
1470 1470 if not readline.uses_libedit:
1471 1471 for rlcommand in self.rc.readline_parse_and_bind:
1472 1472 #print "loading rl:",rlcommand # dbg
1473 1473 readline.parse_and_bind(rlcommand)
1474 1474
1475 1475 # Remove some chars from the delimiters list. If we encounter
1476 1476 # unicode chars, discard them.
1477 1477 delims = readline.get_completer_delims().encode("ascii", "ignore")
1478 1478 delims = delims.translate(string._idmap,
1479 1479 self.rc.readline_remove_delims)
1480 1480 readline.set_completer_delims(delims)
1481 1481 # otherwise we end up with a monster history after a while:
1482 1482 readline.set_history_length(1000)
1483 1483 try:
1484 1484 #print '*** Reading readline history' # dbg
1485 1485 readline.read_history_file(self.histfile)
1486 1486 except IOError:
1487 1487 pass # It doesn't exist yet.
1488 1488
1489 1489 atexit.register(self.atexit_operations)
1490 1490 del atexit
1491 1491
1492 1492 # Configure auto-indent for all platforms
1493 1493 self.set_autoindent(self.rc.autoindent)
1494 1494
1495 1495 def ask_yes_no(self,prompt,default=True):
1496 1496 if self.rc.quiet:
1497 1497 return True
1498 1498 return ask_yes_no(prompt,default)
1499 1499
1500 1500 def new_main_mod(self,ns=None):
1501 1501 """Return a new 'main' module object for user code execution.
1502 1502 """
1503 1503 main_mod = self._user_main_module
1504 1504 init_fakemod_dict(main_mod,ns)
1505 1505 return main_mod
1506 1506
1507 1507 def cache_main_mod(self,ns,fname):
1508 1508 """Cache a main module's namespace.
1509 1509
1510 1510 When scripts are executed via %run, we must keep a reference to the
1511 1511 namespace of their __main__ module (a FakeModule instance) around so
1512 1512 that Python doesn't clear it, rendering objects defined therein
1513 1513 useless.
1514 1514
1515 1515 This method keeps said reference in a private dict, keyed by the
1516 1516 absolute path of the module object (which corresponds to the script
1517 1517 path). This way, for multiple executions of the same script we only
1518 1518 keep one copy of the namespace (the last one), thus preventing memory
1519 1519 leaks from old references while allowing the objects from the last
1520 1520 execution to be accessible.
1521 1521
1522 1522 Note: we can not allow the actual FakeModule instances to be deleted,
1523 1523 because of how Python tears down modules (it hard-sets all their
1524 1524 references to None without regard for reference counts). This method
1525 1525 must therefore make a *copy* of the given namespace, to allow the
1526 1526 original module's __dict__ to be cleared and reused.
1527 1527
1528 1528
1529 1529 Parameters
1530 1530 ----------
1531 1531 ns : a namespace (a dict, typically)
1532 1532
1533 1533 fname : str
1534 1534 Filename associated with the namespace.
1535 1535
1536 1536 Examples
1537 1537 --------
1538 1538
1539 1539 In [10]: import IPython
1540 1540
1541 1541 In [11]: _ip.IP.cache_main_mod(IPython.__dict__,IPython.__file__)
1542 1542
1543 1543 In [12]: IPython.__file__ in _ip.IP._main_ns_cache
1544 1544 Out[12]: True
1545 1545 """
1546 1546 self._main_ns_cache[os.path.abspath(fname)] = ns.copy()
1547 1547
1548 1548 def clear_main_mod_cache(self):
1549 1549 """Clear the cache of main modules.
1550 1550
1551 1551 Mainly for use by utilities like %reset.
1552 1552
1553 1553 Examples
1554 1554 --------
1555 1555
1556 1556 In [15]: import IPython
1557 1557
1558 1558 In [16]: _ip.IP.cache_main_mod(IPython.__dict__,IPython.__file__)
1559 1559
1560 1560 In [17]: len(_ip.IP._main_ns_cache) > 0
1561 1561 Out[17]: True
1562 1562
1563 1563 In [18]: _ip.IP.clear_main_mod_cache()
1564 1564
1565 1565 In [19]: len(_ip.IP._main_ns_cache) == 0
1566 1566 Out[19]: True
1567 1567 """
1568 1568 self._main_ns_cache.clear()
1569 1569
1570 1570 def _should_recompile(self,e):
1571 1571 """Utility routine for edit_syntax_error"""
1572 1572
1573 1573 if e.filename in ('<ipython console>','<input>','<string>',
1574 1574 '<console>','<BackgroundJob compilation>',
1575 1575 None):
1576 1576
1577 1577 return False
1578 1578 try:
1579 1579 if (self.rc.autoedit_syntax and
1580 1580 not self.ask_yes_no('Return to editor to correct syntax error? '
1581 1581 '[Y/n] ','y')):
1582 1582 return False
1583 1583 except EOFError:
1584 1584 return False
1585 1585
1586 1586 def int0(x):
1587 1587 try:
1588 1588 return int(x)
1589 1589 except TypeError:
1590 1590 return 0
1591 1591 # always pass integer line and offset values to editor hook
1592 1592 try:
1593 1593 self.hooks.fix_error_editor(e.filename,
1594 1594 int0(e.lineno),int0(e.offset),e.msg)
1595 1595 except ipapi.TryNext:
1596 1596 warn('Could not open editor')
1597 1597 return False
1598 1598 return True
1599 1599
1600 1600 def edit_syntax_error(self):
1601 1601 """The bottom half of the syntax error handler called in the main loop.
1602 1602
1603 1603 Loop until syntax error is fixed or user cancels.
1604 1604 """
1605 1605
1606 1606 while self.SyntaxTB.last_syntax_error:
1607 1607 # copy and clear last_syntax_error
1608 1608 err = self.SyntaxTB.clear_err_state()
1609 1609 if not self._should_recompile(err):
1610 1610 return
1611 1611 try:
1612 1612 # may set last_syntax_error again if a SyntaxError is raised
1613 1613 self.safe_execfile(err.filename,self.user_ns)
1614 1614 except:
1615 1615 self.showtraceback()
1616 1616 else:
1617 1617 try:
1618 1618 f = file(err.filename)
1619 1619 try:
1620 1620 sys.displayhook(f.read())
1621 1621 finally:
1622 1622 f.close()
1623 1623 except:
1624 1624 self.showtraceback()
1625 1625
1626 1626 def showsyntaxerror(self, filename=None):
1627 1627 """Display the syntax error that just occurred.
1628 1628
1629 1629 This doesn't display a stack trace because there isn't one.
1630 1630
1631 1631 If a filename is given, it is stuffed in the exception instead
1632 1632 of what was there before (because Python's parser always uses
1633 1633 "<string>" when reading from a string).
1634 1634 """
1635 1635 etype, value, last_traceback = sys.exc_info()
1636 1636
1637 1637 # See note about these variables in showtraceback() below
1638 1638 sys.last_type = etype
1639 1639 sys.last_value = value
1640 1640 sys.last_traceback = last_traceback
1641 1641
1642 1642 if filename and etype is SyntaxError:
1643 1643 # Work hard to stuff the correct filename in the exception
1644 1644 try:
1645 1645 msg, (dummy_filename, lineno, offset, line) = value
1646 1646 except:
1647 1647 # Not the format we expect; leave it alone
1648 1648 pass
1649 1649 else:
1650 1650 # Stuff in the right filename
1651 1651 try:
1652 1652 # Assume SyntaxError is a class exception
1653 1653 value = SyntaxError(msg, (filename, lineno, offset, line))
1654 1654 except:
1655 1655 # If that failed, assume SyntaxError is a string
1656 1656 value = msg, (filename, lineno, offset, line)
1657 1657 self.SyntaxTB(etype,value,[])
1658 1658
1659 1659 def debugger(self,force=False):
1660 1660 """Call the pydb/pdb debugger.
1661 1661
1662 1662 Keywords:
1663 1663
1664 1664 - force(False): by default, this routine checks the instance call_pdb
1665 1665 flag and does not actually invoke the debugger if the flag is false.
1666 1666 The 'force' option forces the debugger to activate even if the flag
1667 1667 is false.
1668 1668 """
1669 1669
1670 1670 if not (force or self.call_pdb):
1671 1671 return
1672 1672
1673 1673 if not hasattr(sys,'last_traceback'):
1674 1674 error('No traceback has been produced, nothing to debug.')
1675 1675 return
1676 1676
1677 1677 # use pydb if available
1678 1678 if debugger.has_pydb:
1679 1679 from pydb import pm
1680 1680 else:
1681 1681 # fallback to our internal debugger
1682 1682 pm = lambda : self.InteractiveTB.debugger(force=True)
1683 1683 self.history_saving_wrapper(pm)()
1684 1684
1685 1685 def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None):
1686 1686 """Display the exception that just occurred.
1687 1687
1688 1688 If nothing is known about the exception, this is the method which
1689 1689 should be used throughout the code for presenting user tracebacks,
1690 1690 rather than directly invoking the InteractiveTB object.
1691 1691
1692 1692 A specific showsyntaxerror() also exists, but this method can take
1693 1693 care of calling it if needed, so unless you are explicitly catching a
1694 1694 SyntaxError exception, don't try to analyze the stack manually and
1695 1695 simply call this method."""
1696 1696
1697 1697
1698 1698 # Though this won't be called by syntax errors in the input line,
1699 1699 # there may be SyntaxError cases whith imported code.
1700 1700
1701 1701 try:
1702 1702 if exc_tuple is None:
1703 1703 etype, value, tb = sys.exc_info()
1704 1704 else:
1705 1705 etype, value, tb = exc_tuple
1706 1706
1707 1707 if etype is SyntaxError:
1708 1708 self.showsyntaxerror(filename)
1709 1709 elif etype is ipapi.UsageError:
1710 1710 print "UsageError:", value
1711 1711 else:
1712 1712 # WARNING: these variables are somewhat deprecated and not
1713 1713 # necessarily safe to use in a threaded environment, but tools
1714 1714 # like pdb depend on their existence, so let's set them. If we
1715 1715 # find problems in the field, we'll need to revisit their use.
1716 1716 sys.last_type = etype
1717 1717 sys.last_value = value
1718 1718 sys.last_traceback = tb
1719 1719
1720 1720 if etype in self.custom_exceptions:
1721 1721 self.CustomTB(etype,value,tb)
1722 1722 else:
1723 1723 self.InteractiveTB(etype,value,tb,tb_offset=tb_offset)
1724 1724 if self.InteractiveTB.call_pdb and self.has_readline:
1725 1725 # pdb mucks up readline, fix it back
1726 1726 self.set_completer()
1727 1727 except KeyboardInterrupt:
1728 1728 self.write("\nKeyboardInterrupt\n")
1729 1729
1730 1730 def mainloop(self,banner=None):
1731 1731 """Creates the local namespace and starts the mainloop.
1732 1732
1733 1733 If an optional banner argument is given, it will override the
1734 1734 internally created default banner."""
1735 1735
1736 1736 if self.rc.c: # Emulate Python's -c option
1737 1737 self.exec_init_cmd()
1738 1738 if banner is None:
1739 1739 if not self.rc.banner:
1740 1740 banner = ''
1741 1741 # banner is string? Use it directly!
1742 1742 elif isinstance(self.rc.banner,basestring):
1743 1743 banner = self.rc.banner
1744 1744 else:
1745 1745 banner = self.BANNER+self.banner2
1746 1746
1747 1747 # if you run stuff with -c <cmd>, raw hist is not updated
1748 1748 # ensure that it's in sync
1749 1749 if len(self.input_hist) != len (self.input_hist_raw):
1750 1750 self.input_hist_raw = InputList(self.input_hist)
1751 1751
1752 1752 while 1:
1753 1753 try:
1754 1754 self.interact(banner)
1755 1755 #self.interact_with_readline()
1756 1756
1757 1757 # XXX for testing of a readline-decoupled repl loop, call
1758 1758 # interact_with_readline above
1759 1759
1760 1760 break
1761 1761 except KeyboardInterrupt:
1762 1762 # this should not be necessary, but KeyboardInterrupt
1763 1763 # handling seems rather unpredictable...
1764 1764 self.write("\nKeyboardInterrupt in interact()\n")
1765 1765
1766 1766 def exec_init_cmd(self):
1767 1767 """Execute a command given at the command line.
1768 1768
1769 1769 This emulates Python's -c option."""
1770 1770
1771 1771 #sys.argv = ['-c']
1772 1772 self.push(self.prefilter(self.rc.c, False))
1773 1773 if not self.rc.interact:
1774 1774 self.ask_exit()
1775 1775
1776 1776 def embed_mainloop(self,header='',local_ns=None,global_ns=None,stack_depth=0):
1777 1777 """Embeds IPython into a running python program.
1778 1778
1779 1779 Input:
1780 1780
1781 1781 - header: An optional header message can be specified.
1782 1782
1783 1783 - local_ns, global_ns: working namespaces. If given as None, the
1784 1784 IPython-initialized one is updated with __main__.__dict__, so that
1785 1785 program variables become visible but user-specific configuration
1786 1786 remains possible.
1787 1787
1788 1788 - stack_depth: specifies how many levels in the stack to go to
1789 1789 looking for namespaces (when local_ns and global_ns are None). This
1790 1790 allows an intermediate caller to make sure that this function gets
1791 1791 the namespace from the intended level in the stack. By default (0)
1792 1792 it will get its locals and globals from the immediate caller.
1793 1793
1794 1794 Warning: it's possible to use this in a program which is being run by
1795 1795 IPython itself (via %run), but some funny things will happen (a few
1796 1796 globals get overwritten). In the future this will be cleaned up, as
1797 1797 there is no fundamental reason why it can't work perfectly."""
1798 1798
1799 1799 # Get locals and globals from caller
1800 1800 if local_ns is None or global_ns is None:
1801 1801 call_frame = sys._getframe(stack_depth).f_back
1802 1802
1803 1803 if local_ns is None:
1804 1804 local_ns = call_frame.f_locals
1805 1805 if global_ns is None:
1806 1806 global_ns = call_frame.f_globals
1807 1807
1808 1808 # Update namespaces and fire up interpreter
1809 1809
1810 1810 # The global one is easy, we can just throw it in
1811 1811 self.user_global_ns = global_ns
1812 1812
1813 1813 # but the user/local one is tricky: ipython needs it to store internal
1814 1814 # data, but we also need the locals. We'll copy locals in the user
1815 1815 # one, but will track what got copied so we can delete them at exit.
1816 1816 # This is so that a later embedded call doesn't see locals from a
1817 1817 # previous call (which most likely existed in a separate scope).
1818 1818 local_varnames = local_ns.keys()
1819 1819 self.user_ns.update(local_ns)
1820 1820 #self.user_ns['local_ns'] = local_ns # dbg
1821 1821
1822 1822 # Patch for global embedding to make sure that things don't overwrite
1823 1823 # user globals accidentally. Thanks to Richard <rxe@renre-europe.com>
1824 1824 # FIXME. Test this a bit more carefully (the if.. is new)
1825 1825 if local_ns is None and global_ns is None:
1826 1826 self.user_global_ns.update(__main__.__dict__)
1827 1827
1828 1828 # make sure the tab-completer has the correct frame information, so it
1829 1829 # actually completes using the frame's locals/globals
1830 1830 self.set_completer_frame()
1831 1831
1832 1832 # before activating the interactive mode, we need to make sure that
1833 1833 # all names in the builtin namespace needed by ipython point to
1834 1834 # ourselves, and not to other instances.
1835 1835 self.add_builtins()
1836 1836
1837 1837 self.interact(header)
1838 1838
1839 1839 # now, purge out the user namespace from anything we might have added
1840 1840 # from the caller's local namespace
1841 1841 delvar = self.user_ns.pop
1842 1842 for var in local_varnames:
1843 1843 delvar(var,None)
1844 1844 # and clean builtins we may have overridden
1845 1845 self.clean_builtins()
1846 1846
1847 1847 def interact_prompt(self):
1848 1848 """ Print the prompt (in read-eval-print loop)
1849 1849
1850 1850 Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not
1851 1851 used in standard IPython flow.
1852 1852 """
1853 1853 if self.more:
1854 1854 try:
1855 1855 prompt = self.hooks.generate_prompt(True)
1856 1856 except:
1857 1857 self.showtraceback()
1858 1858 if self.autoindent:
1859 1859 self.rl_do_indent = True
1860 1860
1861 1861 else:
1862 1862 try:
1863 1863 prompt = self.hooks.generate_prompt(False)
1864 1864 except:
1865 1865 self.showtraceback()
1866 1866 self.write(prompt)
1867 1867
1868 1868 def interact_handle_input(self,line):
1869 1869 """ Handle the input line (in read-eval-print loop)
1870 1870
1871 1871 Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not
1872 1872 used in standard IPython flow.
1873 1873 """
1874 1874 if line.lstrip() == line:
1875 1875 self.shadowhist.add(line.strip())
1876 1876 lineout = self.prefilter(line,self.more)
1877 1877
1878 1878 if line.strip():
1879 1879 if self.more:
1880 1880 self.input_hist_raw[-1] += '%s\n' % line
1881 1881 else:
1882 1882 self.input_hist_raw.append('%s\n' % line)
1883 1883
1884 1884
1885 1885 self.more = self.push(lineout)
1886 1886 if (self.SyntaxTB.last_syntax_error and
1887 1887 self.rc.autoedit_syntax):
1888 1888 self.edit_syntax_error()
1889 1889
1890 1890 def interact_with_readline(self):
1891 1891 """ Demo of using interact_handle_input, interact_prompt
1892 1892
1893 1893 This is the main read-eval-print loop. If you need to implement your own (e.g. for GUI),
1894 1894 it should work like this.
1895 1895 """
1896 1896 self.readline_startup_hook(self.pre_readline)
1897 1897 while not self.exit_now:
1898 1898 self.interact_prompt()
1899 1899 if self.more:
1900 1900 self.rl_do_indent = True
1901 1901 else:
1902 1902 self.rl_do_indent = False
1903 1903 line = raw_input_original().decode(self.stdin_encoding)
1904 1904 self.interact_handle_input(line)
1905 1905
1906 1906
1907 1907 def interact(self, banner=None):
1908 1908 """Closely emulate the interactive Python console.
1909 1909
1910 1910 The optional banner argument specify the banner to print
1911 1911 before the first interaction; by default it prints a banner
1912 1912 similar to the one printed by the real Python interpreter,
1913 1913 followed by the current class name in parentheses (so as not
1914 1914 to confuse this with the real interpreter -- since it's so
1915 1915 close!).
1916 1916
1917 1917 """
1918 1918
1919 1919 if self.exit_now:
1920 1920 # batch run -> do not interact
1921 1921 return
1922 1922 cprt = 'Type "copyright", "credits" or "license" for more information.'
1923 1923 if banner is None:
1924 1924 self.write("Python %s on %s\n%s\n(%s)\n" %
1925 1925 (sys.version, sys.platform, cprt,
1926 1926 self.__class__.__name__))
1927 1927 else:
1928 1928 self.write(banner)
1929 1929
1930 1930 more = 0
1931 1931
1932 1932 # Mark activity in the builtins
1933 1933 __builtin__.__dict__['__IPYTHON__active'] += 1
1934 1934
1935 1935 if self.has_readline:
1936 1936 self.readline_startup_hook(self.pre_readline)
1937 1937 # exit_now is set by a call to %Exit or %Quit, through the
1938 1938 # ask_exit callback.
1939 1939
1940 1940 while not self.exit_now:
1941 1941 self.hooks.pre_prompt_hook()
1942 1942 if more:
1943 1943 try:
1944 1944 prompt = self.hooks.generate_prompt(True)
1945 1945 except:
1946 1946 self.showtraceback()
1947 1947 if self.autoindent:
1948 1948 self.rl_do_indent = True
1949 1949
1950 1950 else:
1951 1951 try:
1952 1952 prompt = self.hooks.generate_prompt(False)
1953 1953 except:
1954 1954 self.showtraceback()
1955 1955 try:
1956 1956 line = self.raw_input(prompt,more)
1957 1957 if self.exit_now:
1958 1958 # quick exit on sys.std[in|out] close
1959 1959 break
1960 1960 if self.autoindent:
1961 1961 self.rl_do_indent = False
1962 1962
1963 1963 except KeyboardInterrupt:
1964 1964 #double-guard against keyboardinterrupts during kbdint handling
1965 1965 try:
1966 1966 self.write('\nKeyboardInterrupt\n')
1967 1967 self.resetbuffer()
1968 1968 # keep cache in sync with the prompt counter:
1969 1969 self.outputcache.prompt_count -= 1
1970 1970
1971 1971 if self.autoindent:
1972 1972 self.indent_current_nsp = 0
1973 1973 more = 0
1974 1974 except KeyboardInterrupt:
1975 1975 pass
1976 1976 except EOFError:
1977 1977 if self.autoindent:
1978 1978 self.rl_do_indent = False
1979 1979 self.readline_startup_hook(None)
1980 1980 self.write('\n')
1981 1981 self.exit()
1982 1982 except bdb.BdbQuit:
1983 1983 warn('The Python debugger has exited with a BdbQuit exception.\n'
1984 1984 'Because of how pdb handles the stack, it is impossible\n'
1985 1985 'for IPython to properly format this particular exception.\n'
1986 1986 'IPython will resume normal operation.')
1987 1987 except:
1988 1988 # exceptions here are VERY RARE, but they can be triggered
1989 1989 # asynchronously by signal handlers, for example.
1990 1990 self.showtraceback()
1991 1991 else:
1992 1992 more = self.push(line)
1993 1993 if (self.SyntaxTB.last_syntax_error and
1994 1994 self.rc.autoedit_syntax):
1995 1995 self.edit_syntax_error()
1996 1996
1997 1997 # We are off again...
1998 1998 __builtin__.__dict__['__IPYTHON__active'] -= 1
1999 1999
2000 2000 def excepthook(self, etype, value, tb):
2001 2001 """One more defense for GUI apps that call sys.excepthook.
2002 2002
2003 2003 GUI frameworks like wxPython trap exceptions and call
2004 2004 sys.excepthook themselves. I guess this is a feature that
2005 2005 enables them to keep running after exceptions that would
2006 2006 otherwise kill their mainloop. This is a bother for IPython
2007 2007 which excepts to catch all of the program exceptions with a try:
2008 2008 except: statement.
2009 2009
2010 2010 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
2011 2011 any app directly invokes sys.excepthook, it will look to the user like
2012 2012 IPython crashed. In order to work around this, we can disable the
2013 2013 CrashHandler and replace it with this excepthook instead, which prints a
2014 2014 regular traceback using our InteractiveTB. In this fashion, apps which
2015 2015 call sys.excepthook will generate a regular-looking exception from
2016 2016 IPython, and the CrashHandler will only be triggered by real IPython
2017 2017 crashes.
2018 2018
2019 2019 This hook should be used sparingly, only in places which are not likely
2020 2020 to be true IPython errors.
2021 2021 """
2022 2022 self.showtraceback((etype,value,tb),tb_offset=0)
2023 2023
2024 2024 def expand_aliases(self,fn,rest):
2025 2025 """ Expand multiple levels of aliases:
2026 2026
2027 2027 if:
2028 2028
2029 2029 alias foo bar /tmp
2030 2030 alias baz foo
2031 2031
2032 2032 then:
2033 2033
2034 2034 baz huhhahhei -> bar /tmp huhhahhei
2035 2035
2036 2036 """
2037 2037 line = fn + " " + rest
2038 2038
2039 2039 done = set()
2040 2040 while 1:
2041 2041 pre,fn,rest = prefilter.splitUserInput(line,
2042 2042 prefilter.shell_line_split)
2043 2043 if fn in self.alias_table:
2044 2044 if fn in done:
2045 2045 warn("Cyclic alias definition, repeated '%s'" % fn)
2046 2046 return ""
2047 2047 done.add(fn)
2048 2048
2049 2049 l2 = self.transform_alias(fn,rest)
2050 2050 # dir -> dir
2051 2051 # print "alias",line, "->",l2 #dbg
2052 2052 if l2 == line:
2053 2053 break
2054 2054 # ls -> ls -F should not recurse forever
2055 2055 if l2.split(None,1)[0] == line.split(None,1)[0]:
2056 2056 line = l2
2057 2057 break
2058 2058
2059 2059 line=l2
2060 2060
2061 2061
2062 2062 # print "al expand to",line #dbg
2063 2063 else:
2064 2064 break
2065 2065
2066 2066 return line
2067 2067
2068 2068 def transform_alias(self, alias,rest=''):
2069 2069 """ Transform alias to system command string.
2070 2070 """
2071 2071 trg = self.alias_table[alias]
2072 2072
2073 2073 nargs,cmd = trg
2074 2074 # print trg #dbg
2075 2075 if ' ' in cmd and os.path.isfile(cmd):
2076 2076 cmd = '"%s"' % cmd
2077 2077
2078 2078 # Expand the %l special to be the user's input line
2079 2079 if cmd.find('%l') >= 0:
2080 2080 cmd = cmd.replace('%l',rest)
2081 2081 rest = ''
2082 2082 if nargs==0:
2083 2083 # Simple, argument-less aliases
2084 2084 cmd = '%s %s' % (cmd,rest)
2085 2085 else:
2086 2086 # Handle aliases with positional arguments
2087 2087 args = rest.split(None,nargs)
2088 2088 if len(args)< nargs:
2089 2089 error('Alias <%s> requires %s arguments, %s given.' %
2090 2090 (alias,nargs,len(args)))
2091 2091 return None
2092 2092 cmd = '%s %s' % (cmd % tuple(args[:nargs]),' '.join(args[nargs:]))
2093 2093 # Now call the macro, evaluating in the user's namespace
2094 2094 #print 'new command: <%r>' % cmd # dbg
2095 2095 return cmd
2096 2096
2097 2097 def call_alias(self,alias,rest=''):
2098 2098 """Call an alias given its name and the rest of the line.
2099 2099
2100 2100 This is only used to provide backwards compatibility for users of
2101 2101 ipalias(), use of which is not recommended for anymore."""
2102 2102
2103 2103 # Now call the macro, evaluating in the user's namespace
2104 2104 cmd = self.transform_alias(alias, rest)
2105 2105 try:
2106 2106 self.system(cmd)
2107 2107 except:
2108 2108 self.showtraceback()
2109 2109
2110 2110 def indent_current_str(self):
2111 2111 """return the current level of indentation as a string"""
2112 2112 return self.indent_current_nsp * ' '
2113 2113
2114 2114 def autoindent_update(self,line):
2115 2115 """Keep track of the indent level."""
2116 2116
2117 2117 #debugx('line')
2118 2118 #debugx('self.indent_current_nsp')
2119 2119 if self.autoindent:
2120 2120 if line:
2121 2121 inisp = num_ini_spaces(line)
2122 2122 if inisp < self.indent_current_nsp:
2123 2123 self.indent_current_nsp = inisp
2124 2124
2125 2125 if line[-1] == ':':
2126 2126 self.indent_current_nsp += 4
2127 2127 elif dedent_re.match(line):
2128 2128 self.indent_current_nsp -= 4
2129 2129 else:
2130 2130 self.indent_current_nsp = 0
2131 2131
2132 2132 def runlines(self,lines):
2133 2133 """Run a string of one or more lines of source.
2134 2134
2135 2135 This method is capable of running a string containing multiple source
2136 2136 lines, as if they had been entered at the IPython prompt. Since it
2137 2137 exposes IPython's processing machinery, the given strings can contain
2138 2138 magic calls (%magic), special shell access (!cmd), etc."""
2139 2139
2140 2140 # We must start with a clean buffer, in case this is run from an
2141 2141 # interactive IPython session (via a magic, for example).
2142 2142 self.resetbuffer()
2143 2143 lines = lines.split('\n')
2144 2144 more = 0
2145 2145
2146 2146 for line in lines:
2147 2147 # skip blank lines so we don't mess up the prompt counter, but do
2148 2148 # NOT skip even a blank line if we are in a code block (more is
2149 2149 # true)
2150 2150
2151 2151 if line or more:
2152 2152 # push to raw history, so hist line numbers stay in sync
2153 2153 self.input_hist_raw.append("# " + line + "\n")
2154 2154 more = self.push(self.prefilter(line,more))
2155 2155 # IPython's runsource returns None if there was an error
2156 2156 # compiling the code. This allows us to stop processing right
2157 2157 # away, so the user gets the error message at the right place.
2158 2158 if more is None:
2159 2159 break
2160 2160 else:
2161 2161 self.input_hist_raw.append("\n")
2162 2162 # final newline in case the input didn't have it, so that the code
2163 2163 # actually does get executed
2164 2164 if more:
2165 2165 self.push('\n')
2166 2166
2167 2167 def runsource(self, source, filename='<input>', symbol='single'):
2168 2168 """Compile and run some source in the interpreter.
2169 2169
2170 2170 Arguments are as for compile_command().
2171 2171
2172 2172 One several things can happen:
2173 2173
2174 2174 1) The input is incorrect; compile_command() raised an
2175 2175 exception (SyntaxError or OverflowError). A syntax traceback
2176 2176 will be printed by calling the showsyntaxerror() method.
2177 2177
2178 2178 2) The input is incomplete, and more input is required;
2179 2179 compile_command() returned None. Nothing happens.
2180 2180
2181 2181 3) The input is complete; compile_command() returned a code
2182 2182 object. The code is executed by calling self.runcode() (which
2183 2183 also handles run-time exceptions, except for SystemExit).
2184 2184
2185 2185 The return value is:
2186 2186
2187 2187 - True in case 2
2188 2188
2189 2189 - False in the other cases, unless an exception is raised, where
2190 2190 None is returned instead. This can be used by external callers to
2191 2191 know whether to continue feeding input or not.
2192 2192
2193 2193 The return value can be used to decide whether to use sys.ps1 or
2194 2194 sys.ps2 to prompt the next line."""
2195 2195
2196 2196 # if the source code has leading blanks, add 'if 1:\n' to it
2197 2197 # this allows execution of indented pasted code. It is tempting
2198 2198 # to add '\n' at the end of source to run commands like ' a=1'
2199 2199 # directly, but this fails for more complicated scenarios
2200 2200 source=source.encode(self.stdin_encoding)
2201 2201 if source[:1] in [' ', '\t']:
2202 2202 source = 'if 1:\n%s' % source
2203 2203
2204 2204 try:
2205 2205 code = self.compile(source,filename,symbol)
2206 2206 except (OverflowError, SyntaxError, ValueError, TypeError, MemoryError):
2207 2207 # Case 1
2208 2208 self.showsyntaxerror(filename)
2209 2209 return None
2210 2210
2211 2211 if code is None:
2212 2212 # Case 2
2213 2213 return True
2214 2214
2215 2215 # Case 3
2216 2216 # We store the code object so that threaded shells and
2217 2217 # custom exception handlers can access all this info if needed.
2218 2218 # The source corresponding to this can be obtained from the
2219 2219 # buffer attribute as '\n'.join(self.buffer).
2220 2220 self.code_to_run = code
2221 2221 # now actually execute the code object
2222 2222 if self.runcode(code) == 0:
2223 2223 return False
2224 2224 else:
2225 2225 return None
2226 2226
2227 2227 def runcode(self,code_obj):
2228 2228 """Execute a code object.
2229 2229
2230 2230 When an exception occurs, self.showtraceback() is called to display a
2231 2231 traceback.
2232 2232
2233 2233 Return value: a flag indicating whether the code to be run completed
2234 2234 successfully:
2235 2235
2236 2236 - 0: successful execution.
2237 2237 - 1: an error occurred.
2238 2238 """
2239 2239
2240 2240 # Set our own excepthook in case the user code tries to call it
2241 2241 # directly, so that the IPython crash handler doesn't get triggered
2242 2242 old_excepthook,sys.excepthook = sys.excepthook, self.excepthook
2243 2243
2244 2244 # we save the original sys.excepthook in the instance, in case config
2245 2245 # code (such as magics) needs access to it.
2246 2246 self.sys_excepthook = old_excepthook
2247 2247 outflag = 1 # happens in more places, so it's easier as default
2248 2248 try:
2249 2249 try:
2250 2250 self.hooks.pre_runcode_hook()
2251 2251 exec code_obj in self.user_global_ns, self.user_ns
2252 2252 finally:
2253 2253 # Reset our crash handler in place
2254 2254 sys.excepthook = old_excepthook
2255 2255 except SystemExit:
2256 2256 self.resetbuffer()
2257 2257 self.showtraceback()
2258 2258 warn("Type %exit or %quit to exit IPython "
2259 2259 "(%Exit or %Quit do so unconditionally).",level=1)
2260 2260 except self.custom_exceptions:
2261 2261 etype,value,tb = sys.exc_info()
2262 2262 self.CustomTB(etype,value,tb)
2263 2263 except:
2264 2264 self.showtraceback()
2265 2265 else:
2266 2266 outflag = 0
2267 2267 if softspace(sys.stdout, 0):
2268 2268 print
2269 2269 # Flush out code object which has been run (and source)
2270 2270 self.code_to_run = None
2271 2271 return outflag
2272 2272
2273 2273 def push(self, line):
2274 2274 """Push a line to the interpreter.
2275 2275
2276 2276 The line should not have a trailing newline; it may have
2277 2277 internal newlines. The line is appended to a buffer and the
2278 2278 interpreter's runsource() method is called with the
2279 2279 concatenated contents of the buffer as source. If this
2280 2280 indicates that the command was executed or invalid, the buffer
2281 2281 is reset; otherwise, the command is incomplete, and the buffer
2282 2282 is left as it was after the line was appended. The return
2283 2283 value is 1 if more input is required, 0 if the line was dealt
2284 2284 with in some way (this is the same as runsource()).
2285 2285 """
2286 2286
2287 2287 # autoindent management should be done here, and not in the
2288 2288 # interactive loop, since that one is only seen by keyboard input. We
2289 2289 # need this done correctly even for code run via runlines (which uses
2290 2290 # push).
2291 2291
2292 2292 #print 'push line: <%s>' % line # dbg
2293 2293 for subline in line.splitlines():
2294 2294 self.autoindent_update(subline)
2295 2295 self.buffer.append(line)
2296 2296 more = self.runsource('\n'.join(self.buffer), self.filename)
2297 2297 if not more:
2298 2298 self.resetbuffer()
2299 2299 return more
2300 2300
2301 2301 def split_user_input(self, line):
2302 2302 # This is really a hold-over to support ipapi and some extensions
2303 2303 return prefilter.splitUserInput(line)
2304 2304
2305 2305 def resetbuffer(self):
2306 2306 """Reset the input buffer."""
2307 2307 self.buffer[:] = []
2308 2308
2309 2309 def raw_input(self,prompt='',continue_prompt=False):
2310 2310 """Write a prompt and read a line.
2311 2311
2312 2312 The returned line does not include the trailing newline.
2313 2313 When the user enters the EOF key sequence, EOFError is raised.
2314 2314
2315 2315 Optional inputs:
2316 2316
2317 2317 - prompt(''): a string to be printed to prompt the user.
2318 2318
2319 2319 - continue_prompt(False): whether this line is the first one or a
2320 2320 continuation in a sequence of inputs.
2321 2321 """
2322 2322
2323 2323 # Code run by the user may have modified the readline completer state.
2324 2324 # We must ensure that our completer is back in place.
2325 2325 if self.has_readline:
2326 2326 self.set_completer()
2327 2327
2328 2328 try:
2329 2329 line = raw_input_original(prompt).decode(self.stdin_encoding)
2330 2330 except ValueError:
2331 2331 warn("\n********\nYou or a %run:ed script called sys.stdin.close()"
2332 2332 " or sys.stdout.close()!\nExiting IPython!")
2333 2333 self.ask_exit()
2334 2334 return ""
2335 2335
2336 2336 # Try to be reasonably smart about not re-indenting pasted input more
2337 2337 # than necessary. We do this by trimming out the auto-indent initial
2338 2338 # spaces, if the user's actual input started itself with whitespace.
2339 2339 #debugx('self.buffer[-1]')
2340 2340
2341 2341 if self.autoindent:
2342 2342 if num_ini_spaces(line) > self.indent_current_nsp:
2343 2343 line = line[self.indent_current_nsp:]
2344 2344 self.indent_current_nsp = 0
2345 2345
2346 2346 # store the unfiltered input before the user has any chance to modify
2347 2347 # it.
2348 2348 if line.strip():
2349 2349 if continue_prompt:
2350 2350 self.input_hist_raw[-1] += '%s\n' % line
2351 2351 if self.has_readline: # and some config option is set?
2352 2352 try:
2353 2353 histlen = self.readline.get_current_history_length()
2354 2354 if histlen > 1:
2355 2355 newhist = self.input_hist_raw[-1].rstrip()
2356 2356 self.readline.remove_history_item(histlen-1)
2357 2357 self.readline.replace_history_item(histlen-2,
2358 2358 newhist.encode(self.stdin_encoding))
2359 2359 except AttributeError:
2360 2360 pass # re{move,place}_history_item are new in 2.4.
2361 2361 else:
2362 2362 self.input_hist_raw.append('%s\n' % line)
2363 2363 # only entries starting at first column go to shadow history
2364 2364 if line.lstrip() == line:
2365 2365 self.shadowhist.add(line.strip())
2366 2366 elif not continue_prompt:
2367 2367 self.input_hist_raw.append('\n')
2368 2368 try:
2369 2369 lineout = self.prefilter(line,continue_prompt)
2370 2370 except:
2371 2371 # blanket except, in case a user-defined prefilter crashes, so it
2372 2372 # can't take all of ipython with it.
2373 2373 self.showtraceback()
2374 2374 return ''
2375 2375 else:
2376 2376 return lineout
2377 2377
2378 2378 def _prefilter(self, line, continue_prompt):
2379 2379 """Calls different preprocessors, depending on the form of line."""
2380 2380
2381 2381 # All handlers *must* return a value, even if it's blank ('').
2382 2382
2383 2383 # Lines are NOT logged here. Handlers should process the line as
2384 2384 # needed, update the cache AND log it (so that the input cache array
2385 2385 # stays synced).
2386 2386
2387 2387 #.....................................................................
2388 2388 # Code begins
2389 2389
2390 2390 #if line.startswith('%crash'): raise RuntimeError,'Crash now!' # dbg
2391 2391
2392 2392 # save the line away in case we crash, so the post-mortem handler can
2393 2393 # record it
2394 2394 self._last_input_line = line
2395 2395
2396 2396 #print '***line: <%s>' % line # dbg
2397 2397
2398 2398 if not line:
2399 2399 # Return immediately on purely empty lines, so that if the user
2400 2400 # previously typed some whitespace that started a continuation
2401 2401 # prompt, he can break out of that loop with just an empty line.
2402 2402 # This is how the default python prompt works.
2403 2403
2404 2404 # Only return if the accumulated input buffer was just whitespace!
2405 2405 if ''.join(self.buffer).isspace():
2406 2406 self.buffer[:] = []
2407 2407 return ''
2408 2408
2409 2409 line_info = prefilter.LineInfo(line, continue_prompt)
2410 2410
2411 2411 # the input history needs to track even empty lines
2412 2412 stripped = line.strip()
2413 2413
2414 2414 if not stripped:
2415 2415 if not continue_prompt:
2416 2416 self.outputcache.prompt_count -= 1
2417 2417 return self.handle_normal(line_info)
2418 2418
2419 2419 # print '***cont',continue_prompt # dbg
2420 2420 # special handlers are only allowed for single line statements
2421 2421 if continue_prompt and not self.rc.multi_line_specials:
2422 2422 return self.handle_normal(line_info)
2423 2423
2424 2424
2425 2425 # See whether any pre-existing handler can take care of it
2426 2426 rewritten = self.hooks.input_prefilter(stripped)
2427 2427 if rewritten != stripped: # ok, some prefilter did something
2428 2428 rewritten = line_info.pre + rewritten # add indentation
2429 2429 return self.handle_normal(prefilter.LineInfo(rewritten,
2430 2430 continue_prompt))
2431 2431
2432 2432 #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg
2433 2433
2434 2434 return prefilter.prefilter(line_info, self)
2435 2435
2436 2436
2437 2437 def _prefilter_dumb(self, line, continue_prompt):
2438 2438 """simple prefilter function, for debugging"""
2439 2439 return self.handle_normal(line,continue_prompt)
2440 2440
2441 2441
2442 2442 def multiline_prefilter(self, line, continue_prompt):
2443 2443 """ Run _prefilter for each line of input
2444 2444
2445 2445 Covers cases where there are multiple lines in the user entry,
2446 2446 which is the case when the user goes back to a multiline history
2447 2447 entry and presses enter.
2448 2448
2449 2449 """
2450 2450 out = []
2451 2451 for l in line.rstrip('\n').split('\n'):
2452 2452 out.append(self._prefilter(l, continue_prompt))
2453 2453 return '\n'.join(out)
2454 2454
2455 2455 # Set the default prefilter() function (this can be user-overridden)
2456 2456 prefilter = multiline_prefilter
2457 2457
2458 2458 def handle_normal(self,line_info):
2459 2459 """Handle normal input lines. Use as a template for handlers."""
2460 2460
2461 2461 # With autoindent on, we need some way to exit the input loop, and I
2462 2462 # don't want to force the user to have to backspace all the way to
2463 2463 # clear the line. The rule will be in this case, that either two
2464 2464 # lines of pure whitespace in a row, or a line of pure whitespace but
2465 2465 # of a size different to the indent level, will exit the input loop.
2466 2466 line = line_info.line
2467 2467 continue_prompt = line_info.continue_prompt
2468 2468
2469 2469 if (continue_prompt and self.autoindent and line.isspace() and
2470 2470 (0 < abs(len(line) - self.indent_current_nsp) <= 2 or
2471 2471 (self.buffer[-1]).isspace() )):
2472 2472 line = ''
2473 2473
2474 2474 self.log(line,line,continue_prompt)
2475 2475 return line
2476 2476
2477 2477 def handle_alias(self,line_info):
2478 2478 """Handle alias input lines. """
2479 2479 tgt = self.alias_table[line_info.iFun]
2480 2480 # print "=>",tgt #dbg
2481 2481 if callable(tgt):
2482 2482 if '$' in line_info.line:
2483 2483 call_meth = '(_ip, _ip.itpl(%s))'
2484 2484 else:
2485 2485 call_meth = '(_ip,%s)'
2486 2486 line_out = ("%s_sh.%s" + call_meth) % (line_info.preWhitespace,
2487 2487 line_info.iFun,
2488 2488 make_quoted_expr(line_info.line))
2489 2489 else:
2490 2490 transformed = self.expand_aliases(line_info.iFun,line_info.theRest)
2491 2491
2492 2492 # pre is needed, because it carries the leading whitespace. Otherwise
2493 2493 # aliases won't work in indented sections.
2494 2494 line_out = '%s_ip.system(%s)' % (line_info.preWhitespace,
2495 2495 make_quoted_expr( transformed ))
2496 2496
2497 2497 self.log(line_info.line,line_out,line_info.continue_prompt)
2498 2498 #print 'line out:',line_out # dbg
2499 2499 return line_out
2500 2500
2501 2501 def handle_shell_escape(self, line_info):
2502 2502 """Execute the line in a shell, empty return value"""
2503 2503 #print 'line in :', `line` # dbg
2504 2504 line = line_info.line
2505 2505 if line.lstrip().startswith('!!'):
2506 2506 # rewrite LineInfo's line, iFun and theRest to properly hold the
2507 2507 # call to %sx and the actual command to be executed, so
2508 2508 # handle_magic can work correctly. Note that this works even if
2509 2509 # the line is indented, so it handles multi_line_specials
2510 2510 # properly.
2511 2511 new_rest = line.lstrip()[2:]
2512 2512 line_info.line = '%ssx %s' % (self.ESC_MAGIC,new_rest)
2513 2513 line_info.iFun = 'sx'
2514 2514 line_info.theRest = new_rest
2515 2515 return self.handle_magic(line_info)
2516 2516 else:
2517 2517 cmd = line.lstrip().lstrip('!')
2518 2518 line_out = '%s_ip.system(%s)' % (line_info.preWhitespace,
2519 2519 make_quoted_expr(cmd))
2520 2520 # update cache/log and return
2521 2521 self.log(line,line_out,line_info.continue_prompt)
2522 2522 return line_out
2523 2523
2524 2524 def handle_magic(self, line_info):
2525 2525 """Execute magic functions."""
2526 2526 iFun = line_info.iFun
2527 2527 theRest = line_info.theRest
2528 2528 cmd = '%s_ip.magic(%s)' % (line_info.preWhitespace,
2529 2529 make_quoted_expr(iFun + " " + theRest))
2530 2530 self.log(line_info.line,cmd,line_info.continue_prompt)
2531 2531 #print 'in handle_magic, cmd=<%s>' % cmd # dbg
2532 2532 return cmd
2533 2533
2534 2534 def handle_auto(self, line_info):
2535 2535 """Hande lines which can be auto-executed, quoting if requested."""
2536 2536
2537 2537 line = line_info.line
2538 2538 iFun = line_info.iFun
2539 2539 theRest = line_info.theRest
2540 2540 pre = line_info.pre
2541 2541 continue_prompt = line_info.continue_prompt
2542 2542 obj = line_info.ofind(self)['obj']
2543 2543
2544 2544 #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg
2545 2545
2546 2546 # This should only be active for single-line input!
2547 2547 if continue_prompt:
2548 2548 self.log(line,line,continue_prompt)
2549 2549 return line
2550 2550
2551 2551 force_auto = isinstance(obj, ipapi.IPyAutocall)
2552 2552 auto_rewrite = True
2553 2553
2554 2554 if pre == self.ESC_QUOTE:
2555 2555 # Auto-quote splitting on whitespace
2556 2556 newcmd = '%s("%s")' % (iFun,'", "'.join(theRest.split()) )
2557 2557 elif pre == self.ESC_QUOTE2:
2558 2558 # Auto-quote whole string
2559 2559 newcmd = '%s("%s")' % (iFun,theRest)
2560 2560 elif pre == self.ESC_PAREN:
2561 2561 newcmd = '%s(%s)' % (iFun,",".join(theRest.split()))
2562 2562 else:
2563 2563 # Auto-paren.
2564 2564 # We only apply it to argument-less calls if the autocall
2565 2565 # parameter is set to 2. We only need to check that autocall is <
2566 2566 # 2, since this function isn't called unless it's at least 1.
2567 2567 if not theRest and (self.rc.autocall < 2) and not force_auto:
2568 2568 newcmd = '%s %s' % (iFun,theRest)
2569 2569 auto_rewrite = False
2570 2570 else:
2571 2571 if not force_auto and theRest.startswith('['):
2572 2572 if hasattr(obj,'__getitem__'):
2573 2573 # Don't autocall in this case: item access for an object
2574 2574 # which is BOTH callable and implements __getitem__.
2575 2575 newcmd = '%s %s' % (iFun,theRest)
2576 2576 auto_rewrite = False
2577 2577 else:
2578 2578 # if the object doesn't support [] access, go ahead and
2579 2579 # autocall
2580 2580 newcmd = '%s(%s)' % (iFun.rstrip(),theRest)
2581 2581 elif theRest.endswith(';'):
2582 2582 newcmd = '%s(%s);' % (iFun.rstrip(),theRest[:-1])
2583 2583 else:
2584 2584 newcmd = '%s(%s)' % (iFun.rstrip(), theRest)
2585 2585
2586 2586 if auto_rewrite:
2587 2587 rw = self.outputcache.prompt1.auto_rewrite() + newcmd
2588 2588
2589 2589 try:
2590 2590 # plain ascii works better w/ pyreadline, on some machines, so
2591 2591 # we use it and only print uncolored rewrite if we have unicode
2592 2592 rw = str(rw)
2593 2593 print >>Term.cout, rw
2594 2594 except UnicodeEncodeError:
2595 2595 print "-------------->" + newcmd
2596 2596
2597 2597 # log what is now valid Python, not the actual user input (without the
2598 2598 # final newline)
2599 2599 self.log(line,newcmd,continue_prompt)
2600 2600 return newcmd
2601 2601
2602 2602 def handle_help(self, line_info):
2603 2603 """Try to get some help for the object.
2604 2604
2605 2605 obj? or ?obj -> basic information.
2606 2606 obj?? or ??obj -> more details.
2607 2607 """
2608 2608
2609 2609 line = line_info.line
2610 2610 # We need to make sure that we don't process lines which would be
2611 2611 # otherwise valid python, such as "x=1 # what?"
2612 2612 try:
2613 2613 codeop.compile_command(line)
2614 2614 except SyntaxError:
2615 2615 # We should only handle as help stuff which is NOT valid syntax
2616 2616 if line[0]==self.ESC_HELP:
2617 2617 line = line[1:]
2618 2618 elif line[-1]==self.ESC_HELP:
2619 2619 line = line[:-1]
2620 2620 self.log(line,'#?'+line,line_info.continue_prompt)
2621 2621 if line:
2622 2622 #print 'line:<%r>' % line # dbg
2623 2623 self.magic_pinfo(line)
2624 2624 else:
2625 2625 page(self.usage,screen_lines=self.rc.screen_length)
2626 2626 return '' # Empty string is needed here!
2627 2627 except:
2628 2628 # Pass any other exceptions through to the normal handler
2629 2629 return self.handle_normal(line_info)
2630 2630 else:
2631 2631 # If the code compiles ok, we should handle it normally
2632 2632 return self.handle_normal(line_info)
2633 2633
2634 2634 def getapi(self):
2635 2635 """ Get an IPApi object for this shell instance
2636 2636
2637 2637 Getting an IPApi object is always preferable to accessing the shell
2638 2638 directly, but this holds true especially for extensions.
2639 2639
2640 2640 It should always be possible to implement an extension with IPApi
2641 2641 alone. If not, contact maintainer to request an addition.
2642 2642
2643 2643 """
2644 2644 return self.api
2645 2645
2646 2646 def handle_emacs(self, line_info):
2647 2647 """Handle input lines marked by python-mode."""
2648 2648
2649 2649 # Currently, nothing is done. Later more functionality can be added
2650 2650 # here if needed.
2651 2651
2652 2652 # The input cache shouldn't be updated
2653 2653 return line_info.line
2654 2654
2655 2655
2656 2656 def mktempfile(self,data=None):
2657 2657 """Make a new tempfile and return its filename.
2658 2658
2659 2659 This makes a call to tempfile.mktemp, but it registers the created
2660 2660 filename internally so ipython cleans it up at exit time.
2661 2661
2662 2662 Optional inputs:
2663 2663
2664 2664 - data(None): if data is given, it gets written out to the temp file
2665 2665 immediately, and the file is closed again."""
2666 2666
2667 2667 filename = tempfile.mktemp('.py','ipython_edit_')
2668 2668 self.tempfiles.append(filename)
2669 2669
2670 2670 if data:
2671 2671 tmp_file = open(filename,'w')
2672 2672 tmp_file.write(data)
2673 2673 tmp_file.close()
2674 2674 return filename
2675 2675
2676 2676 def write(self,data):
2677 2677 """Write a string to the default output"""
2678 2678 Term.cout.write(data)
2679 2679
2680 2680 def write_err(self,data):
2681 2681 """Write a string to the default error output"""
2682 2682 Term.cerr.write(data)
2683 2683
2684 2684 def ask_exit(self):
2685 2685 """ Call for exiting. Can be overiden and used as a callback. """
2686 2686 self.exit_now = True
2687 2687
2688 2688 def exit(self):
2689 2689 """Handle interactive exit.
2690 2690
2691 2691 This method calls the ask_exit callback."""
2692 2692
2693 2693 if self.rc.confirm_exit:
2694 2694 if self.ask_yes_no('Do you really want to exit ([y]/n)?','y'):
2695 2695 self.ask_exit()
2696 2696 else:
2697 2697 self.ask_exit()
2698 2698
2699 2699 def safe_execfile(self,fname,*where,**kw):
2700 2700 """A safe version of the builtin execfile().
2701 2701
2702 2702 This version will never throw an exception, and knows how to handle
2703 2703 ipython logs as well.
2704 2704
2705 2705 :Parameters:
2706 2706 fname : string
2707 2707 Name of the file to be executed.
2708 2708
2709 2709 where : tuple
2710 2710 One or two namespaces, passed to execfile() as (globals,locals).
2711 2711 If only one is given, it is passed as both.
2712 2712
2713 2713 :Keywords:
2714 2714 islog : boolean (False)
2715 2715
2716 2716 quiet : boolean (True)
2717 2717
2718 2718 exit_ignore : boolean (False)
2719 2719 """
2720 2720
2721 2721 def syspath_cleanup():
2722 2722 """Internal cleanup routine for sys.path."""
2723 2723 if add_dname:
2724 2724 try:
2725 2725 sys.path.remove(dname)
2726 2726 except ValueError:
2727 2727 # For some reason the user has already removed it, ignore.
2728 2728 pass
2729 2729
2730 2730 fname = os.path.expanduser(fname)
2731 2731
2732 2732 # Find things also in current directory. This is needed to mimic the
2733 2733 # behavior of running a script from the system command line, where
2734 2734 # Python inserts the script's directory into sys.path
2735 2735 dname = os.path.dirname(os.path.abspath(fname))
2736 2736 add_dname = False
2737 2737 if dname not in sys.path:
2738 2738 sys.path.insert(0,dname)
2739 2739 add_dname = True
2740 2740
2741 2741 try:
2742 2742 xfile = open(fname)
2743 2743 except:
2744 2744 print >> Term.cerr, \
2745 2745 'Could not open file <%s> for safe execution.' % fname
2746 2746 syspath_cleanup()
2747 2747 return None
2748 2748
2749 2749 kw.setdefault('islog',0)
2750 2750 kw.setdefault('quiet',1)
2751 2751 kw.setdefault('exit_ignore',0)
2752 2752
2753 2753 first = xfile.readline()
2754 2754 loghead = str(self.loghead_tpl).split('\n',1)[0].strip()
2755 2755 xfile.close()
2756 2756 # line by line execution
2757 2757 if first.startswith(loghead) or kw['islog']:
2758 2758 print 'Loading log file <%s> one line at a time...' % fname
2759 2759 if kw['quiet']:
2760 2760 stdout_save = sys.stdout
2761 2761 sys.stdout = StringIO.StringIO()
2762 2762 try:
2763 2763 globs,locs = where[0:2]
2764 2764 except:
2765 2765 try:
2766 2766 globs = locs = where[0]
2767 2767 except:
2768 2768 globs = locs = globals()
2769 2769 badblocks = []
2770 2770
2771 2771 # we also need to identify indented blocks of code when replaying
2772 2772 # logs and put them together before passing them to an exec
2773 2773 # statement. This takes a bit of regexp and look-ahead work in the
2774 2774 # file. It's easiest if we swallow the whole thing in memory
2775 2775 # first, and manually walk through the lines list moving the
2776 2776 # counter ourselves.
2777 2777 indent_re = re.compile('\s+\S')
2778 2778 xfile = open(fname)
2779 2779 filelines = xfile.readlines()
2780 2780 xfile.close()
2781 2781 nlines = len(filelines)
2782 2782 lnum = 0
2783 2783 while lnum < nlines:
2784 2784 line = filelines[lnum]
2785 2785 lnum += 1
2786 2786 # don't re-insert logger status info into cache
2787 2787 if line.startswith('#log#'):
2788 2788 continue
2789 2789 else:
2790 2790 # build a block of code (maybe a single line) for execution
2791 2791 block = line
2792 2792 try:
2793 2793 next = filelines[lnum] # lnum has already incremented
2794 2794 except:
2795 2795 next = None
2796 2796 while next and indent_re.match(next):
2797 2797 block += next
2798 2798 lnum += 1
2799 2799 try:
2800 2800 next = filelines[lnum]
2801 2801 except:
2802 2802 next = None
2803 2803 # now execute the block of one or more lines
2804 2804 try:
2805 2805 exec block in globs,locs
2806 2806 except SystemExit:
2807 2807 pass
2808 2808 except:
2809 2809 badblocks.append(block.rstrip())
2810 2810 if kw['quiet']: # restore stdout
2811 2811 sys.stdout.close()
2812 2812 sys.stdout = stdout_save
2813 2813 print 'Finished replaying log file <%s>' % fname
2814 2814 if badblocks:
2815 2815 print >> sys.stderr, ('\nThe following lines/blocks in file '
2816 2816 '<%s> reported errors:' % fname)
2817 2817
2818 2818 for badline in badblocks:
2819 2819 print >> sys.stderr, badline
2820 2820 else: # regular file execution
2821 2821 try:
2822 2822 if sys.platform == 'win32' and sys.version_info < (2,5,1):
2823 2823 # Work around a bug in Python for Windows. The bug was
2824 2824 # fixed in in Python 2.5 r54159 and 54158, but that's still
2825 2825 # SVN Python as of March/07. For details, see:
2826 2826 # http://projects.scipy.org/ipython/ipython/ticket/123
2827 2827 try:
2828 2828 globs,locs = where[0:2]
2829 2829 except:
2830 2830 try:
2831 2831 globs = locs = where[0]
2832 2832 except:
2833 2833 globs = locs = globals()
2834 2834 exec file(fname) in globs,locs
2835 2835 else:
2836 2836 execfile(fname,*where)
2837 2837 except SyntaxError:
2838 2838 self.showsyntaxerror()
2839 2839 warn('Failure executing file: <%s>' % fname)
2840 2840 except SystemExit,status:
2841 2841 # Code that correctly sets the exit status flag to success (0)
2842 2842 # shouldn't be bothered with a traceback. Note that a plain
2843 2843 # sys.exit() does NOT set the message to 0 (it's empty) so that
2844 2844 # will still get a traceback. Note that the structure of the
2845 2845 # SystemExit exception changed between Python 2.4 and 2.5, so
2846 2846 # the checks must be done in a version-dependent way.
2847 2847 show = False
2848 2848
2849 2849 if sys.version_info[:2] > (2,5):
2850 2850 if status.message!=0 and not kw['exit_ignore']:
2851 2851 show = True
2852 2852 else:
2853 2853 if status.code and not kw['exit_ignore']:
2854 2854 show = True
2855 2855 if show:
2856 2856 self.showtraceback()
2857 2857 warn('Failure executing file: <%s>' % fname)
2858 2858 except:
2859 2859 self.showtraceback()
2860 2860 warn('Failure executing file: <%s>' % fname)
2861 2861
2862 2862 syspath_cleanup()
2863 2863
2864 2864 #************************* end of file <iplib.py> *****************************
1 NO CONTENT: file renamed from IPython/Logger.py to IPython/core/logger.py
@@ -1,35 +1,38 b''
1 1 #!/usr/bin/env python
2 2 # encoding: utf-8
3 3
4 4 def test_import_completer():
5 5 from IPython.core import completer
6 6
7 7 def test_import_crashhandler():
8 8 from IPython.core import crashhandler
9 9
10 10 def test_import_debugger():
11 11 from IPython.core import debugger
12 12
13 13 def test_import_fakemodule():
14 14 from IPython.core import fakemodule
15 15
16 16 def test_import_excolors():
17 17 from IPython.core import excolors
18 18
19 19 def test_import_history():
20 20 from IPython.core import history
21 21
22 22 def test_import_hooks():
23 23 from IPython.core import hooks
24 24
25 25 def test_import_ipapi():
26 26 from IPython.core import ipapi
27 27
28 def test_imort_iplib():
28 def test_import_iplib():
29 29 from IPython.core import iplib
30 30
31 def test_imort_ipmaker():
31 def test_import_ipmaker():
32 32 from IPython.core import ipmaker
33 33
34 def test_import_logger():
35 from IPython.core import logger
36
34 37
35 38
@@ -1,300 +1,300 b''
1 1 # -*- coding: utf-8 -*-
2 2 """IPython Test Suite Runner.
3 3
4 4 This module provides a main entry point to a user script to test IPython
5 5 itself from the command line. There are two ways of running this script:
6 6
7 7 1. With the syntax `iptest all`. This runs our entire test suite by
8 8 calling this script (with different arguments) or trial recursively. This
9 9 causes modules and package to be tested in different processes, using nose
10 10 or trial where appropriate.
11 11 2. With the regular nose syntax, like `iptest -vvs IPython`. In this form
12 12 the script simply calls nose, but with special command line flags and
13 13 plugins loaded.
14 14
15 15 For now, this script requires that both nose and twisted are installed. This
16 16 will change in the future.
17 17 """
18 18
19 19 #-----------------------------------------------------------------------------
20 20 # Module imports
21 21 #-----------------------------------------------------------------------------
22 22
23 23 import os
24 24 import os.path as path
25 25 import sys
26 26 import subprocess
27 27 import time
28 28 import warnings
29 29
30 30 import nose.plugins.builtin
31 31 from nose.core import TestProgram
32 32
33 33 from IPython.platutils import find_cmd
34 34 from IPython.testing.plugin.ipdoctest import IPythonDoctest
35 35
36 36 pjoin = path.join
37 37
38 38 #-----------------------------------------------------------------------------
39 39 # Logic for skipping doctests
40 40 #-----------------------------------------------------------------------------
41 41
42 42 def test_for(mod):
43 43 """Test to see if mod is importable."""
44 44 try:
45 45 __import__(mod)
46 46 except ImportError:
47 47 return False
48 48 else:
49 49 return True
50 50
51 51 have_curses = test_for('_curses')
52 52 have_wx = test_for('wx')
53 53 have_zi = test_for('zope.interface')
54 54 have_twisted = test_for('twisted')
55 55 have_foolscap = test_for('foolscap')
56 56 have_objc = test_for('objc')
57 57 have_pexpect = test_for('pexpect')
58 58
59 59 # For the IPythonDoctest plugin, we need to exclude certain patterns that cause
60 60 # testing problems. We should strive to minimize the number of skipped
61 61 # modules, since this means untested code. As the testing machinery
62 62 # solidifies, this list should eventually become empty.
63 63 EXCLUDE = [pjoin('IPython', 'external'),
64 64 pjoin('IPython', 'frontend', 'process', 'winprocess.py'),
65 65 pjoin('IPython_doctest_plugin'),
66 66 pjoin('IPython', 'Gnuplot'),
67 67 pjoin('IPython', 'Extensions', 'ipy_'),
68 68 pjoin('IPython', 'Extensions', 'clearcmd'),
69 69 pjoin('IPython', 'Extensions', 'PhysicalQInteractive'),
70 70 pjoin('IPython', 'Extensions', 'scitedirector'),
71 71 pjoin('IPython', 'Extensions', 'numeric_formats'),
72 72 pjoin('IPython', 'testing', 'attic'),
73 73 pjoin('IPython', 'testing', 'tutils'),
74 74 pjoin('IPython', 'testing', 'tools'),
75 75 pjoin('IPython', 'testing', 'mkdoctests')
76 76 ]
77 77
78 78 if not have_wx:
79 79 EXCLUDE.append(pjoin('IPython', 'Extensions', 'igrid'))
80 80 EXCLUDE.append(pjoin('IPython', 'gui'))
81 81 EXCLUDE.append(pjoin('IPython', 'frontend', 'wx'))
82 82
83 83 if not have_objc:
84 84 EXCLUDE.append(pjoin('IPython', 'frontend', 'cocoa'))
85 85
86 86 if not have_curses:
87 87 EXCLUDE.append(pjoin('IPython', 'Extensions', 'ibrowse'))
88 88
89 89 if not sys.platform == 'win32':
90 90 EXCLUDE.append(pjoin('IPython', 'platutils_win32'))
91 91
92 92 # These have to be skipped on win32 because the use echo, rm, cd, etc.
93 93 # See ticket https://bugs.launchpad.net/bugs/366982
94 94 if sys.platform == 'win32':
95 95 EXCLUDE.append(pjoin('IPython', 'testing', 'plugin', 'test_exampleip'))
96 96 EXCLUDE.append(pjoin('IPython', 'testing', 'plugin', 'dtexample'))
97 97
98 98 if not os.name == 'posix':
99 99 EXCLUDE.append(pjoin('IPython', 'platutils_posix'))
100 100
101 101 if not have_pexpect:
102 102 EXCLUDE.append(pjoin('IPython', 'irunner'))
103 103
104 104 # This is needed for the reg-exp to match on win32 in the ipdoctest plugin.
105 105 if sys.platform == 'win32':
106 106 EXCLUDE = [s.replace('\\','\\\\') for s in EXCLUDE]
107 107
108 108
109 109 #-----------------------------------------------------------------------------
110 110 # Functions and classes
111 111 #-----------------------------------------------------------------------------
112 112
113 113 def run_iptest():
114 114 """Run the IPython test suite using nose.
115 115
116 116 This function is called when this script is **not** called with the form
117 117 `iptest all`. It simply calls nose with appropriate command line flags
118 118 and accepts all of the standard nose arguments.
119 119 """
120 120
121 121 warnings.filterwarnings('ignore',
122 122 'This will be removed soon. Use IPython.testing.util instead')
123 123
124 124 argv = sys.argv + [
125 125 # Loading ipdoctest causes problems with Twisted.
126 126 # I am removing this as a temporary fix to get the
127 127 # test suite back into working shape. Our nose
128 128 # plugin needs to be gone through with a fine
129 129 # toothed comb to find what is causing the problem.
130 130 '--with-ipdoctest',
131 131 '--ipdoctest-tests','--ipdoctest-extension=txt',
132 132 '--detailed-errors',
133 133
134 134 # We add --exe because of setuptools' imbecility (it
135 135 # blindly does chmod +x on ALL files). Nose does the
136 136 # right thing and it tries to avoid executables,
137 137 # setuptools unfortunately forces our hand here. This
138 138 # has been discussed on the distutils list and the
139 139 # setuptools devs refuse to fix this problem!
140 140 '--exe',
141 141 ]
142 142
143 143 # Detect if any tests were required by explicitly calling an IPython
144 144 # submodule or giving a specific path
145 145 has_tests = False
146 146 for arg in sys.argv:
147 147 if 'IPython' in arg or arg.endswith('.py') or \
148 148 (':' in arg and '.py' in arg):
149 149 has_tests = True
150 150 break
151 151
152 152 # If nothing was specifically requested, test full IPython
153 153 if not has_tests:
154 154 argv.append('IPython')
155 155
156 156 # Construct list of plugins, omitting the existing doctest plugin, which
157 157 # ours replaces (and extends).
158 158 plugins = [IPythonDoctest(EXCLUDE)]
159 159 for p in nose.plugins.builtin.plugins:
160 160 plug = p()
161 161 if plug.name == 'doctest':
162 162 continue
163 163
164 164 #print '*** adding plugin:',plug.name # dbg
165 165 plugins.append(plug)
166 166
167 167 TestProgram(argv=argv,plugins=plugins)
168 168
169 169
170 170 class IPTester(object):
171 171 """Call that calls iptest or trial in a subprocess.
172 172 """
173 173 def __init__(self,runner='iptest',params=None):
174 174 """ """
175 175 if runner == 'iptest':
176 176 self.runner = ['iptest','-v']
177 177 else:
178 178 self.runner = [find_cmd('trial')]
179 179 if params is None:
180 180 params = []
181 181 if isinstance(params,str):
182 182 params = [params]
183 183 self.params = params
184 184
185 185 # Assemble call
186 186 self.call_args = self.runner+self.params
187 187
188 188 def run(self):
189 189 """Run the stored commands"""
190 190 return subprocess.call(self.call_args)
191 191
192 192
193 193 def make_runners():
194 194 """Define the modules and packages that need to be tested.
195 195 """
196 196
197 197 # This omits additional top-level modules that should not be doctested.
198 198 # XXX: Shell.py is also ommited because of a bug in the skip_doctest
199 199 # decorator. See ticket https://bugs.launchpad.net/bugs/366209
200 200 top_mod = \
201 201 ['backgroundjobs.py', 'coloransi.py', 'completer.py', 'configloader.py',
202 202 'crashhandler.py', 'debugger.py', 'deepreload.py', 'demo.py',
203 203 'DPyGetOpt.py', 'dtutils.py', 'excolors.py', 'fakemodule.py',
204 204 'generics.py', 'genutils.py', 'history.py', 'hooks.py', 'ipapi.py',
205 205 'iplib.py', 'ipmaker.py', 'ipstruct.py', 'Itpl.py',
206 'Logger.py', 'macro.py', 'Magic.py', 'OInspect.py',
206 'logger.py', 'macro.py', 'Magic.py', 'OInspect.py',
207 207 'OutputTrap.py', 'platutils.py', 'prefilter.py', 'Prompts.py',
208 208 'PyColorize.py', 'Release.py', 'rlineimpl.py', 'shadowns.py',
209 209 'shellglobals.py', 'strdispatch.py', 'twshell.py',
210 210 'ultraTB.py', 'upgrade_dir.py', 'usage.py', 'wildcard.py',
211 211 # See note above for why this is skipped
212 212 # 'Shell.py',
213 213 'winconsole.py']
214 214
215 215 if have_pexpect:
216 216 top_mod.append('irunner.py')
217 217
218 218 if sys.platform == 'win32':
219 219 top_mod.append('platutils_win32.py')
220 220 elif os.name == 'posix':
221 221 top_mod.append('platutils_posix.py')
222 222 else:
223 223 top_mod.append('platutils_dummy.py')
224 224
225 225 # These are tested by nose, so skip IPython.kernel
226 226 top_pack = ['config','Extensions','frontend',
227 227 'testing','tests','tools','UserConfig']
228 228
229 229 if have_wx:
230 230 top_pack.append('gui')
231 231
232 232 modules = ['IPython.%s' % m[:-3] for m in top_mod ]
233 233 packages = ['IPython.%s' % m for m in top_pack ]
234 234
235 235 # Make runners
236 236 runners = dict(zip(top_pack, [IPTester(params=v) for v in packages]))
237 237
238 238 # Test IPython.kernel using trial if twisted is installed
239 239 if have_zi and have_twisted and have_foolscap:
240 240 runners['trial'] = IPTester('trial',['IPython'])
241 241
242 242 runners['modules'] = IPTester(params=modules)
243 243
244 244 return runners
245 245
246 246
247 247 def run_iptestall():
248 248 """Run the entire IPython test suite by calling nose and trial.
249 249
250 250 This function constructs :class:`IPTester` instances for all IPython
251 251 modules and package and then runs each of them. This causes the modules
252 252 and packages of IPython to be tested each in their own subprocess using
253 253 nose or twisted.trial appropriately.
254 254 """
255 255 runners = make_runners()
256 256 # Run all test runners, tracking execution time
257 257 failed = {}
258 258 t_start = time.time()
259 259 for name,runner in runners.iteritems():
260 260 print '*'*77
261 261 print 'IPython test set:',name
262 262 res = runner.run()
263 263 if res:
264 264 failed[name] = res
265 265 t_end = time.time()
266 266 t_tests = t_end - t_start
267 267 nrunners = len(runners)
268 268 nfail = len(failed)
269 269 # summarize results
270 270 print
271 271 print '*'*77
272 272 print 'Ran %s test sets in %.3fs' % (nrunners, t_tests)
273 273 print
274 274 if not failed:
275 275 print 'OK'
276 276 else:
277 277 # If anything went wrong, point out what command to rerun manually to
278 278 # see the actual errors and individual summary
279 279 print 'ERROR - %s out of %s test sets failed.' % (nfail, nrunners)
280 280 for name in failed:
281 281 failed_runner = runners[name]
282 282 print '-'*40
283 283 print 'Runner failed:',name
284 284 print 'You may wish to rerun this one individually, with:'
285 285 print ' '.join(failed_runner.call_args)
286 286 print
287 287
288 288
289 289 def main():
290 290 if len(sys.argv) == 1:
291 291 run_iptestall()
292 292 else:
293 293 if sys.argv[1] == 'all':
294 294 run_iptestall()
295 295 else:
296 296 run_iptest()
297 297
298 298
299 299 if __name__ == '__main__':
300 300 main() No newline at end of file
General Comments 0
You need to be logged in to leave comments. Login now