##// END OF EJS Templates
ipalias deprecated/redundant; aliases are converted and called...
vivainio -
Show More

The requested changes are too big and content was truncated. Show full diff

@@ -1,2244 +1,2252 b''
1 1 # -*- coding: utf-8 -*-
2 2 """
3 3 IPython -- An enhanced Interactive Python
4 4
5 5 Requires Python 2.3 or newer.
6 6
7 7 This file contains all the classes and helper functions specific to IPython.
8 8
9 $Id: iplib.py 1107 2006-01-30 19:02:20Z vivainio $
9 $Id: iplib.py 1111 2006-01-30 21:16:07Z vivainio $
10 10 """
11 11
12 12 #*****************************************************************************
13 13 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and
14 14 # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu>
15 15 #
16 16 # Distributed under the terms of the BSD License. The full license is in
17 17 # the file COPYING, distributed as part of this software.
18 18 #
19 19 # Note: this code originally subclassed code.InteractiveConsole from the
20 20 # Python standard library. Over time, all of that class has been copied
21 21 # verbatim here for modifications which could not be accomplished by
22 22 # subclassing. At this point, there are no dependencies at all on the code
23 23 # module anymore (it is not even imported). The Python License (sec. 2)
24 24 # allows for this, but it's always nice to acknowledge credit where credit is
25 25 # due.
26 26 #*****************************************************************************
27 27
28 28 #****************************************************************************
29 29 # Modules and globals
30 30
31 31 from __future__ import generators # for 2.2 backwards-compatibility
32 32
33 33 from IPython import Release
34 34 __author__ = '%s <%s>\n%s <%s>' % \
35 35 ( Release.authors['Janko'] + Release.authors['Fernando'] )
36 36 __license__ = Release.license
37 37 __version__ = Release.version
38 38
39 39 # Python standard modules
40 40 import __main__
41 41 import __builtin__
42 42 import StringIO
43 43 import bdb
44 44 import cPickle as pickle
45 45 import codeop
46 46 import exceptions
47 47 import glob
48 48 import inspect
49 49 import keyword
50 50 import new
51 51 import os
52 52 import pdb
53 53 import pydoc
54 54 import re
55 55 import shutil
56 56 import string
57 57 import sys
58 58 import tempfile
59 59 import traceback
60 60 import types
61 61 import pickleshare
62 62
63 63 from pprint import pprint, pformat
64 64
65 65 # IPython's own modules
66 66 import IPython
67 67 from IPython import OInspect,PyColorize,ultraTB
68 68 from IPython.ColorANSI import ColorScheme,ColorSchemeTable # too long names
69 69 from IPython.FakeModule import FakeModule
70 70 from IPython.Itpl import Itpl,itpl,printpl,ItplNS,itplns
71 71 from IPython.Logger import Logger
72 72 from IPython.Magic import Magic
73 73 from IPython.Prompts import CachedOutput
74 74 from IPython.ipstruct import Struct
75 75 from IPython.background_jobs import BackgroundJobManager
76 76 from IPython.usage import cmd_line_usage,interactive_usage
77 77 from IPython.genutils import *
78 78 import IPython.ipapi
79 79
80 80 # Globals
81 81
82 82 # store the builtin raw_input globally, and use this always, in case user code
83 83 # overwrites it (like wx.py.PyShell does)
84 84 raw_input_original = raw_input
85 85
86 86 # compiled regexps for autoindent management
87 87 dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass')
88 88
89 89
90 90 #****************************************************************************
91 91 # Some utility function definitions
92 92
93 93 ini_spaces_re = re.compile(r'^(\s+)')
94 94
95 95 def num_ini_spaces(strng):
96 96 """Return the number of initial spaces in a string"""
97 97
98 98 ini_spaces = ini_spaces_re.match(strng)
99 99 if ini_spaces:
100 100 return ini_spaces.end()
101 101 else:
102 102 return 0
103 103
104 104 def softspace(file, newvalue):
105 105 """Copied from code.py, to remove the dependency"""
106 106
107 107 oldvalue = 0
108 108 try:
109 109 oldvalue = file.softspace
110 110 except AttributeError:
111 111 pass
112 112 try:
113 113 file.softspace = newvalue
114 114 except (AttributeError, TypeError):
115 115 # "attribute-less object" or "read-only attributes"
116 116 pass
117 117 return oldvalue
118 118
119 119
120 120 #****************************************************************************
121 121 # Local use exceptions
122 122 class SpaceInInput(exceptions.Exception): pass
123 123
124 124
125 125 #****************************************************************************
126 126 # Local use classes
127 127 class Bunch: pass
128 128
129 129 class Undefined: pass
130 130
131 131 class InputList(list):
132 132 """Class to store user input.
133 133
134 134 It's basically a list, but slices return a string instead of a list, thus
135 135 allowing things like (assuming 'In' is an instance):
136 136
137 137 exec In[4:7]
138 138
139 139 or
140 140
141 141 exec In[5:9] + In[14] + In[21:25]"""
142 142
143 143 def __getslice__(self,i,j):
144 144 return ''.join(list.__getslice__(self,i,j))
145 145
146 146 class SyntaxTB(ultraTB.ListTB):
147 147 """Extension which holds some state: the last exception value"""
148 148
149 149 def __init__(self,color_scheme = 'NoColor'):
150 150 ultraTB.ListTB.__init__(self,color_scheme)
151 151 self.last_syntax_error = None
152 152
153 153 def __call__(self, etype, value, elist):
154 154 self.last_syntax_error = value
155 155 ultraTB.ListTB.__call__(self,etype,value,elist)
156 156
157 157 def clear_err_state(self):
158 158 """Return the current error state and clear it"""
159 159 e = self.last_syntax_error
160 160 self.last_syntax_error = None
161 161 return e
162 162
163 163 #****************************************************************************
164 164 # Main IPython class
165 165
166 166 # FIXME: the Magic class is a mixin for now, and will unfortunately remain so
167 167 # until a full rewrite is made. I've cleaned all cross-class uses of
168 168 # attributes and methods, but too much user code out there relies on the
169 169 # equlity %foo == __IP.magic_foo, so I can't actually remove the mixin usage.
170 170 #
171 171 # But at least now, all the pieces have been separated and we could, in
172 172 # principle, stop using the mixin. This will ease the transition to the
173 173 # chainsaw branch.
174 174
175 175 # For reference, the following is the list of 'self.foo' uses in the Magic
176 176 # class as of 2005-12-28. These are names we CAN'T use in the main ipython
177 177 # class, to prevent clashes.
178 178
179 179 # ['self.__class__', 'self.__dict__', 'self._inspect', 'self._ofind',
180 180 # 'self.arg_err', 'self.extract_input', 'self.format_', 'self.lsmagic',
181 181 # 'self.magic_', 'self.options_table', 'self.parse', 'self.shell',
182 182 # 'self.value']
183 183
184 184 class InteractiveShell(object,Magic):
185 185 """An enhanced console for Python."""
186 186
187 187 # class attribute to indicate whether the class supports threads or not.
188 188 # Subclasses with thread support should override this as needed.
189 189 isthreaded = False
190 190
191 191 def __init__(self,name,usage=None,rc=Struct(opts=None,args=None),
192 192 user_ns = None,user_global_ns=None,banner2='',
193 193 custom_exceptions=((),None),embedded=False):
194 194
195 195
196 196 # log system
197 197 self.logger = Logger(self,logfname='ipython_log.py',logmode='rotate')
198 198
199 199 # Produce a public API instance
200 200
201 201 self.api = IPython.ipapi.IPApi(self)
202 202
203 203 # some minimal strict typechecks. For some core data structures, I
204 204 # want actual basic python types, not just anything that looks like
205 205 # one. This is especially true for namespaces.
206 206 for ns in (user_ns,user_global_ns):
207 207 if ns is not None and type(ns) != types.DictType:
208 208 raise TypeError,'namespace must be a dictionary'
209 209
210 210 # Job manager (for jobs run as background threads)
211 211 self.jobs = BackgroundJobManager()
212 212
213 213 # track which builtins we add, so we can clean up later
214 214 self.builtins_added = {}
215 215 # This method will add the necessary builtins for operation, but
216 216 # tracking what it did via the builtins_added dict.
217 217 self.add_builtins()
218 218
219 219 # Do the intuitively correct thing for quit/exit: we remove the
220 220 # builtins if they exist, and our own magics will deal with this
221 221 try:
222 222 del __builtin__.exit, __builtin__.quit
223 223 except AttributeError:
224 224 pass
225 225
226 226 # Store the actual shell's name
227 227 self.name = name
228 228
229 229 # We need to know whether the instance is meant for embedding, since
230 230 # global/local namespaces need to be handled differently in that case
231 231 self.embedded = embedded
232 232
233 233 # command compiler
234 234 self.compile = codeop.CommandCompiler()
235 235
236 236 # User input buffer
237 237 self.buffer = []
238 238
239 239 # Default name given in compilation of code
240 240 self.filename = '<ipython console>'
241 241
242 242 # Make an empty namespace, which extension writers can rely on both
243 243 # existing and NEVER being used by ipython itself. This gives them a
244 244 # convenient location for storing additional information and state
245 245 # their extensions may require, without fear of collisions with other
246 246 # ipython names that may develop later.
247 247 self.meta = Struct()
248 248
249 249 # Create the namespace where the user will operate. user_ns is
250 250 # normally the only one used, and it is passed to the exec calls as
251 251 # the locals argument. But we do carry a user_global_ns namespace
252 252 # given as the exec 'globals' argument, This is useful in embedding
253 253 # situations where the ipython shell opens in a context where the
254 254 # distinction between locals and globals is meaningful.
255 255
256 256 # FIXME. For some strange reason, __builtins__ is showing up at user
257 257 # level as a dict instead of a module. This is a manual fix, but I
258 258 # should really track down where the problem is coming from. Alex
259 259 # Schmolck reported this problem first.
260 260
261 261 # A useful post by Alex Martelli on this topic:
262 262 # Re: inconsistent value from __builtins__
263 263 # Von: Alex Martelli <aleaxit@yahoo.com>
264 264 # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends
265 265 # Gruppen: comp.lang.python
266 266
267 267 # Michael Hohn <hohn@hooknose.lbl.gov> wrote:
268 268 # > >>> print type(builtin_check.get_global_binding('__builtins__'))
269 269 # > <type 'dict'>
270 270 # > >>> print type(__builtins__)
271 271 # > <type 'module'>
272 272 # > Is this difference in return value intentional?
273 273
274 274 # Well, it's documented that '__builtins__' can be either a dictionary
275 275 # or a module, and it's been that way for a long time. Whether it's
276 276 # intentional (or sensible), I don't know. In any case, the idea is
277 277 # that if you need to access the built-in namespace directly, you
278 278 # should start with "import __builtin__" (note, no 's') which will
279 279 # definitely give you a module. Yeah, it's somewhat confusing:-(.
280 280
281 281 if user_ns is None:
282 282 # Set __name__ to __main__ to better match the behavior of the
283 283 # normal interpreter.
284 284 user_ns = {'__name__' :'__main__',
285 285 '__builtins__' : __builtin__,
286 286 }
287 287
288 288 if user_global_ns is None:
289 289 user_global_ns = {}
290 290
291 291 # Assign namespaces
292 292 # This is the namespace where all normal user variables live
293 293 self.user_ns = user_ns
294 294 # Embedded instances require a separate namespace for globals.
295 295 # Normally this one is unused by non-embedded instances.
296 296 self.user_global_ns = user_global_ns
297 297 # A namespace to keep track of internal data structures to prevent
298 298 # them from cluttering user-visible stuff. Will be updated later
299 299 self.internal_ns = {}
300 300
301 301 # Namespace of system aliases. Each entry in the alias
302 302 # table must be a 2-tuple of the form (N,name), where N is the number
303 303 # of positional arguments of the alias.
304 304 self.alias_table = {}
305 305
306 306 # A table holding all the namespaces IPython deals with, so that
307 307 # introspection facilities can search easily.
308 308 self.ns_table = {'user':user_ns,
309 309 'user_global':user_global_ns,
310 310 'alias':self.alias_table,
311 311 'internal':self.internal_ns,
312 312 'builtin':__builtin__.__dict__
313 313 }
314 314
315 315 # The user namespace MUST have a pointer to the shell itself.
316 316 self.user_ns[name] = self
317 317
318 318 # We need to insert into sys.modules something that looks like a
319 319 # module but which accesses the IPython namespace, for shelve and
320 320 # pickle to work interactively. Normally they rely on getting
321 321 # everything out of __main__, but for embedding purposes each IPython
322 322 # instance has its own private namespace, so we can't go shoving
323 323 # everything into __main__.
324 324
325 325 # note, however, that we should only do this for non-embedded
326 326 # ipythons, which really mimic the __main__.__dict__ with their own
327 327 # namespace. Embedded instances, on the other hand, should not do
328 328 # this because they need to manage the user local/global namespaces
329 329 # only, but they live within a 'normal' __main__ (meaning, they
330 330 # shouldn't overtake the execution environment of the script they're
331 331 # embedded in).
332 332
333 333 if not embedded:
334 334 try:
335 335 main_name = self.user_ns['__name__']
336 336 except KeyError:
337 337 raise KeyError,'user_ns dictionary MUST have a "__name__" key'
338 338 else:
339 339 #print "pickle hack in place" # dbg
340 340 #print 'main_name:',main_name # dbg
341 341 sys.modules[main_name] = FakeModule(self.user_ns)
342 342
343 343 # List of input with multi-line handling.
344 344 # Fill its zero entry, user counter starts at 1
345 345 self.input_hist = InputList(['\n'])
346 346 # This one will hold the 'raw' input history, without any
347 347 # pre-processing. This will allow users to retrieve the input just as
348 348 # it was exactly typed in by the user, with %hist -r.
349 349 self.input_hist_raw = InputList(['\n'])
350 350
351 351 # list of visited directories
352 352 try:
353 353 self.dir_hist = [os.getcwd()]
354 354 except IOError, e:
355 355 self.dir_hist = []
356 356
357 357 # dict of output history
358 358 self.output_hist = {}
359 359
360 360 # dict of things NOT to alias (keywords, builtins and some magics)
361 361 no_alias = {}
362 362 no_alias_magics = ['cd','popd','pushd','dhist','alias','unalias']
363 363 for key in keyword.kwlist + no_alias_magics:
364 364 no_alias[key] = 1
365 365 no_alias.update(__builtin__.__dict__)
366 366 self.no_alias = no_alias
367 367
368 368 # make global variables for user access to these
369 369 self.user_ns['_ih'] = self.input_hist
370 370 self.user_ns['_oh'] = self.output_hist
371 371 self.user_ns['_dh'] = self.dir_hist
372 372
373 373 # user aliases to input and output histories
374 374 self.user_ns['In'] = self.input_hist
375 375 self.user_ns['Out'] = self.output_hist
376 376
377 377 # Object variable to store code object waiting execution. This is
378 378 # used mainly by the multithreaded shells, but it can come in handy in
379 379 # other situations. No need to use a Queue here, since it's a single
380 380 # item which gets cleared once run.
381 381 self.code_to_run = None
382 382
383 383 # escapes for automatic behavior on the command line
384 384 self.ESC_SHELL = '!'
385 385 self.ESC_HELP = '?'
386 386 self.ESC_MAGIC = '%'
387 387 self.ESC_QUOTE = ','
388 388 self.ESC_QUOTE2 = ';'
389 389 self.ESC_PAREN = '/'
390 390
391 391 # And their associated handlers
392 392 self.esc_handlers = {self.ESC_PAREN : self.handle_auto,
393 393 self.ESC_QUOTE : self.handle_auto,
394 394 self.ESC_QUOTE2 : self.handle_auto,
395 395 self.ESC_MAGIC : self.handle_magic,
396 396 self.ESC_HELP : self.handle_help,
397 397 self.ESC_SHELL : self.handle_shell_escape,
398 398 }
399 399
400 400 # class initializations
401 401 Magic.__init__(self,self)
402 402
403 403 # Python source parser/formatter for syntax highlighting
404 404 pyformat = PyColorize.Parser().format
405 405 self.pycolorize = lambda src: pyformat(src,'str',self.rc['colors'])
406 406
407 407 # hooks holds pointers used for user-side customizations
408 408 self.hooks = Struct()
409 409
410 410 # Set all default hooks, defined in the IPython.hooks module.
411 411 hooks = IPython.hooks
412 412 for hook_name in hooks.__all__:
413 413 # default hooks have priority 100, i.e. low; user hooks should have 0-100 priority
414 414 self.set_hook(hook_name,getattr(hooks,hook_name), 100)
415 415 #print "bound hook",hook_name
416 416
417 417 # Flag to mark unconditional exit
418 418 self.exit_now = False
419 419
420 420 self.usage_min = """\
421 421 An enhanced console for Python.
422 422 Some of its features are:
423 423 - Readline support if the readline library is present.
424 424 - Tab completion in the local namespace.
425 425 - Logging of input, see command-line options.
426 426 - System shell escape via ! , eg !ls.
427 427 - Magic commands, starting with a % (like %ls, %pwd, %cd, etc.)
428 428 - Keeps track of locally defined variables via %who, %whos.
429 429 - Show object information with a ? eg ?x or x? (use ?? for more info).
430 430 """
431 431 if usage: self.usage = usage
432 432 else: self.usage = self.usage_min
433 433
434 434 # Storage
435 435 self.rc = rc # This will hold all configuration information
436 436 self.pager = 'less'
437 437 # temporary files used for various purposes. Deleted at exit.
438 438 self.tempfiles = []
439 439
440 440 # Keep track of readline usage (later set by init_readline)
441 441 self.has_readline = False
442 442
443 443 # template for logfile headers. It gets resolved at runtime by the
444 444 # logstart method.
445 445 self.loghead_tpl = \
446 446 """#log# Automatic Logger file. *** THIS MUST BE THE FIRST LINE ***
447 447 #log# DO NOT CHANGE THIS LINE OR THE TWO BELOW
448 448 #log# opts = %s
449 449 #log# args = %s
450 450 #log# It is safe to make manual edits below here.
451 451 #log#-----------------------------------------------------------------------
452 452 """
453 453 # for pushd/popd management
454 454 try:
455 455 self.home_dir = get_home_dir()
456 456 except HomeDirError,msg:
457 457 fatal(msg)
458 458
459 459 self.dir_stack = [os.getcwd().replace(self.home_dir,'~')]
460 460
461 461 # Functions to call the underlying shell.
462 462
463 463 # utility to expand user variables via Itpl
464 464 self.var_expand = lambda cmd: str(ItplNS(cmd.replace('#','\#'),
465 465 self.user_ns))
466 466 # The first is similar to os.system, but it doesn't return a value,
467 467 # and it allows interpolation of variables in the user's namespace.
468 468 self.system = lambda cmd: shell(self.var_expand(cmd),
469 469 header='IPython system call: ',
470 470 verbose=self.rc.system_verbose)
471 471 # These are for getoutput and getoutputerror:
472 472 self.getoutput = lambda cmd: \
473 473 getoutput(self.var_expand(cmd),
474 474 header='IPython system call: ',
475 475 verbose=self.rc.system_verbose)
476 476 self.getoutputerror = lambda cmd: \
477 477 getoutputerror(str(ItplNS(cmd.replace('#','\#'),
478 478 self.user_ns)),
479 479 header='IPython system call: ',
480 480 verbose=self.rc.system_verbose)
481 481
482 482 # RegExp for splitting line contents into pre-char//first
483 483 # word-method//rest. For clarity, each group in on one line.
484 484
485 485 # WARNING: update the regexp if the above escapes are changed, as they
486 486 # are hardwired in.
487 487
488 488 # Don't get carried away with trying to make the autocalling catch too
489 489 # much: it's better to be conservative rather than to trigger hidden
490 490 # evals() somewhere and end up causing side effects.
491 491
492 492 self.line_split = re.compile(r'^([\s*,;/])'
493 493 r'([\?\w\.]+\w*\s*)'
494 494 r'(\(?.*$)')
495 495
496 496 # Original re, keep around for a while in case changes break something
497 497 #self.line_split = re.compile(r'(^[\s*!\?%,/]?)'
498 498 # r'(\s*[\?\w\.]+\w*\s*)'
499 499 # r'(\(?.*$)')
500 500
501 501 # RegExp to identify potential function names
502 502 self.re_fun_name = re.compile(r'[a-zA-Z_]([a-zA-Z0-9_.]*) *$')
503 503
504 504 # RegExp to exclude strings with this start from autocalling. In
505 505 # particular, all binary operators should be excluded, so that if foo
506 506 # is callable, foo OP bar doesn't become foo(OP bar), which is
507 507 # invalid. The characters '!=()' don't need to be checked for, as the
508 508 # _prefilter routine explicitely does so, to catch direct calls and
509 509 # rebindings of existing names.
510 510
511 511 # Warning: the '-' HAS TO BE AT THE END of the first group, otherwise
512 512 # it affects the rest of the group in square brackets.
513 513 self.re_exclude_auto = re.compile(r'^[<>,&^\|\*/\+-]'
514 514 '|^is |^not |^in |^and |^or ')
515 515
516 516 # try to catch also methods for stuff in lists/tuples/dicts: off
517 517 # (experimental). For this to work, the line_split regexp would need
518 518 # to be modified so it wouldn't break things at '['. That line is
519 519 # nasty enough that I shouldn't change it until I can test it _well_.
520 520 #self.re_fun_name = re.compile (r'[a-zA-Z_]([a-zA-Z0-9_.\[\]]*) ?$')
521 521
522 522 # keep track of where we started running (mainly for crash post-mortem)
523 523 self.starting_dir = os.getcwd()
524 524
525 525 # Various switches which can be set
526 526 self.CACHELENGTH = 5000 # this is cheap, it's just text
527 527 self.BANNER = "Python %(version)s on %(platform)s\n" % sys.__dict__
528 528 self.banner2 = banner2
529 529
530 530 # TraceBack handlers:
531 531
532 532 # Syntax error handler.
533 533 self.SyntaxTB = SyntaxTB(color_scheme='NoColor')
534 534
535 535 # The interactive one is initialized with an offset, meaning we always
536 536 # want to remove the topmost item in the traceback, which is our own
537 537 # internal code. Valid modes: ['Plain','Context','Verbose']
538 538 self.InteractiveTB = ultraTB.AutoFormattedTB(mode = 'Plain',
539 539 color_scheme='NoColor',
540 540 tb_offset = 1)
541 541
542 542 # IPython itself shouldn't crash. This will produce a detailed
543 543 # post-mortem if it does. But we only install the crash handler for
544 544 # non-threaded shells, the threaded ones use a normal verbose reporter
545 545 # and lose the crash handler. This is because exceptions in the main
546 546 # thread (such as in GUI code) propagate directly to sys.excepthook,
547 547 # and there's no point in printing crash dumps for every user exception.
548 548 if self.isthreaded:
549 549 sys.excepthook = ultraTB.FormattedTB()
550 550 else:
551 551 from IPython import CrashHandler
552 552 sys.excepthook = CrashHandler.CrashHandler(self)
553 553
554 554 # The instance will store a pointer to this, so that runtime code
555 555 # (such as magics) can access it. This is because during the
556 556 # read-eval loop, it gets temporarily overwritten (to deal with GUI
557 557 # frameworks).
558 558 self.sys_excepthook = sys.excepthook
559 559
560 560 # and add any custom exception handlers the user may have specified
561 561 self.set_custom_exc(*custom_exceptions)
562 562
563 563 # Object inspector
564 564 self.inspector = OInspect.Inspector(OInspect.InspectColors,
565 565 PyColorize.ANSICodeColors,
566 566 'NoColor')
567 567 # indentation management
568 568 self.autoindent = False
569 569 self.indent_current_nsp = 0
570 570
571 571 # Make some aliases automatically
572 572 # Prepare list of shell aliases to auto-define
573 573 if os.name == 'posix':
574 574 auto_alias = ('mkdir mkdir', 'rmdir rmdir',
575 575 'mv mv -i','rm rm -i','cp cp -i',
576 576 'cat cat','less less','clear clear',
577 577 # a better ls
578 578 'ls ls -F',
579 579 # long ls
580 580 'll ls -lF',
581 581 # color ls
582 582 'lc ls -F -o --color',
583 583 # ls normal files only
584 584 'lf ls -F -o --color %l | grep ^-',
585 585 # ls symbolic links
586 586 'lk ls -F -o --color %l | grep ^l',
587 587 # directories or links to directories,
588 588 'ldir ls -F -o --color %l | grep /$',
589 589 # things which are executable
590 590 'lx ls -F -o --color %l | grep ^-..x',
591 591 )
592 592 elif os.name in ['nt','dos']:
593 593 auto_alias = ('dir dir /on', 'ls dir /on',
594 594 'ddir dir /ad /on', 'ldir dir /ad /on',
595 595 'mkdir mkdir','rmdir rmdir','echo echo',
596 596 'ren ren','cls cls','copy copy')
597 597 else:
598 598 auto_alias = ()
599 599 self.auto_alias = map(lambda s:s.split(None,1),auto_alias)
600 600 # Call the actual (public) initializer
601 601 self.init_auto_alias()
602 602 # end __init__
603 603
604 604 def post_config_initialization(self):
605 605 """Post configuration init method
606 606
607 607 This is called after the configuration files have been processed to
608 608 'finalize' the initialization."""
609 609
610 610 rc = self.rc
611 611
612 612 self.db = pickleshare.PickleShareDB(rc.ipythondir + "/db")
613 613 # Load readline proper
614 614 if rc.readline:
615 615 self.init_readline()
616 616
617 617 # local shortcut, this is used a LOT
618 618 self.log = self.logger.log
619 619
620 620 # Initialize cache, set in/out prompts and printing system
621 621 self.outputcache = CachedOutput(self,
622 622 rc.cache_size,
623 623 rc.pprint,
624 624 input_sep = rc.separate_in,
625 625 output_sep = rc.separate_out,
626 626 output_sep2 = rc.separate_out2,
627 627 ps1 = rc.prompt_in1,
628 628 ps2 = rc.prompt_in2,
629 629 ps_out = rc.prompt_out,
630 630 pad_left = rc.prompts_pad_left)
631 631
632 632 # user may have over-ridden the default print hook:
633 633 try:
634 634 self.outputcache.__class__.display = self.hooks.display
635 635 except AttributeError:
636 636 pass
637 637
638 638 # I don't like assigning globally to sys, because it means when embedding
639 639 # instances, each embedded instance overrides the previous choice. But
640 640 # sys.displayhook seems to be called internally by exec, so I don't see a
641 641 # way around it.
642 642 sys.displayhook = self.outputcache
643 643
644 644 # Set user colors (don't do it in the constructor above so that it
645 645 # doesn't crash if colors option is invalid)
646 646 self.magic_colors(rc.colors)
647 647
648 648 # Set calling of pdb on exceptions
649 649 self.call_pdb = rc.pdb
650 650
651 651 # Load user aliases
652 652 for alias in rc.alias:
653 653 self.magic_alias(alias)
654 654 self.hooks.late_startup_hook()
655 655
656 656
657 657 def add_builtins(self):
658 658 """Store ipython references into the builtin namespace.
659 659
660 660 Some parts of ipython operate via builtins injected here, which hold a
661 661 reference to IPython itself."""
662 662
663 663 # TODO: deprecate all except _ip; 'jobs' should be installed
664 # by an extension and the rest are under _ip
664 # by an extension and the rest are under _ip, ipalias is redundant
665 665 builtins_new = dict(__IPYTHON__ = self,
666 666 ip_set_hook = self.set_hook,
667 667 jobs = self.jobs,
668 668 ipmagic = self.ipmagic,
669 669 ipalias = self.ipalias,
670 670 ipsystem = self.ipsystem,
671 671 _ip = self.api
672 672 )
673 673 for biname,bival in builtins_new.items():
674 674 try:
675 675 # store the orignal value so we can restore it
676 676 self.builtins_added[biname] = __builtin__.__dict__[biname]
677 677 except KeyError:
678 678 # or mark that it wasn't defined, and we'll just delete it at
679 679 # cleanup
680 680 self.builtins_added[biname] = Undefined
681 681 __builtin__.__dict__[biname] = bival
682 682
683 683 # Keep in the builtins a flag for when IPython is active. We set it
684 684 # with setdefault so that multiple nested IPythons don't clobber one
685 685 # another. Each will increase its value by one upon being activated,
686 686 # which also gives us a way to determine the nesting level.
687 687 __builtin__.__dict__.setdefault('__IPYTHON__active',0)
688 688
689 689 def clean_builtins(self):
690 690 """Remove any builtins which might have been added by add_builtins, or
691 691 restore overwritten ones to their previous values."""
692 692 for biname,bival in self.builtins_added.items():
693 693 if bival is Undefined:
694 694 del __builtin__.__dict__[biname]
695 695 else:
696 696 __builtin__.__dict__[biname] = bival
697 697 self.builtins_added.clear()
698 698
699 699 def set_hook(self,name,hook, priority = 50):
700 700 """set_hook(name,hook) -> sets an internal IPython hook.
701 701
702 702 IPython exposes some of its internal API as user-modifiable hooks. By
703 703 adding your function to one of these hooks, you can modify IPython's
704 704 behavior to call at runtime your own routines."""
705 705
706 706 # At some point in the future, this should validate the hook before it
707 707 # accepts it. Probably at least check that the hook takes the number
708 708 # of args it's supposed to.
709 709 dp = getattr(self.hooks, name, None)
710 710 if name not in IPython.hooks.__all__:
711 711 print "Warning! Hook '%s' is not one of %s" % (name, IPython.hooks.__all__ )
712 712 if not dp:
713 713 dp = IPython.hooks.CommandChainDispatcher()
714 714
715 715 f = new.instancemethod(hook,self,self.__class__)
716 716 try:
717 717 dp.add(f,priority)
718 718 except AttributeError:
719 719 # it was not commandchain, plain old func - replace
720 720 dp = f
721 721
722 722 setattr(self.hooks,name, dp)
723 723
724 724
725 725 #setattr(self.hooks,name,new.instancemethod(hook,self,self.__class__))
726 726
727 727 def set_custom_exc(self,exc_tuple,handler):
728 728 """set_custom_exc(exc_tuple,handler)
729 729
730 730 Set a custom exception handler, which will be called if any of the
731 731 exceptions in exc_tuple occur in the mainloop (specifically, in the
732 732 runcode() method.
733 733
734 734 Inputs:
735 735
736 736 - exc_tuple: a *tuple* of valid exceptions to call the defined
737 737 handler for. It is very important that you use a tuple, and NOT A
738 738 LIST here, because of the way Python's except statement works. If
739 739 you only want to trap a single exception, use a singleton tuple:
740 740
741 741 exc_tuple == (MyCustomException,)
742 742
743 743 - handler: this must be defined as a function with the following
744 744 basic interface: def my_handler(self,etype,value,tb).
745 745
746 746 This will be made into an instance method (via new.instancemethod)
747 747 of IPython itself, and it will be called if any of the exceptions
748 748 listed in the exc_tuple are caught. If the handler is None, an
749 749 internal basic one is used, which just prints basic info.
750 750
751 751 WARNING: by putting in your own exception handler into IPython's main
752 752 execution loop, you run a very good chance of nasty crashes. This
753 753 facility should only be used if you really know what you are doing."""
754 754
755 755 assert type(exc_tuple)==type(()) , \
756 756 "The custom exceptions must be given AS A TUPLE."
757 757
758 758 def dummy_handler(self,etype,value,tb):
759 759 print '*** Simple custom exception handler ***'
760 760 print 'Exception type :',etype
761 761 print 'Exception value:',value
762 762 print 'Traceback :',tb
763 763 print 'Source code :','\n'.join(self.buffer)
764 764
765 765 if handler is None: handler = dummy_handler
766 766
767 767 self.CustomTB = new.instancemethod(handler,self,self.__class__)
768 768 self.custom_exceptions = exc_tuple
769 769
770 770 def set_custom_completer(self,completer,pos=0):
771 771 """set_custom_completer(completer,pos=0)
772 772
773 773 Adds a new custom completer function.
774 774
775 775 The position argument (defaults to 0) is the index in the completers
776 776 list where you want the completer to be inserted."""
777 777
778 778 newcomp = new.instancemethod(completer,self.Completer,
779 779 self.Completer.__class__)
780 780 self.Completer.matchers.insert(pos,newcomp)
781 781
782 782 def _get_call_pdb(self):
783 783 return self._call_pdb
784 784
785 785 def _set_call_pdb(self,val):
786 786
787 787 if val not in (0,1,False,True):
788 788 raise ValueError,'new call_pdb value must be boolean'
789 789
790 790 # store value in instance
791 791 self._call_pdb = val
792 792
793 793 # notify the actual exception handlers
794 794 self.InteractiveTB.call_pdb = val
795 795 if self.isthreaded:
796 796 try:
797 797 self.sys_excepthook.call_pdb = val
798 798 except:
799 799 warn('Failed to activate pdb for threaded exception handler')
800 800
801 801 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
802 802 'Control auto-activation of pdb at exceptions')
803 803
804 804
805 805 # These special functions get installed in the builtin namespace, to
806 806 # provide programmatic (pure python) access to magics, aliases and system
807 807 # calls. This is important for logging, user scripting, and more.
808 808
809 809 # We are basically exposing, via normal python functions, the three
810 810 # mechanisms in which ipython offers special call modes (magics for
811 811 # internal control, aliases for direct system access via pre-selected
812 812 # names, and !cmd for calling arbitrary system commands).
813 813
814 814 def ipmagic(self,arg_s):
815 815 """Call a magic function by name.
816 816
817 817 Input: a string containing the name of the magic function to call and any
818 818 additional arguments to be passed to the magic.
819 819
820 820 ipmagic('name -opt foo bar') is equivalent to typing at the ipython
821 821 prompt:
822 822
823 823 In[1]: %name -opt foo bar
824 824
825 825 To call a magic without arguments, simply use ipmagic('name').
826 826
827 827 This provides a proper Python function to call IPython's magics in any
828 828 valid Python code you can type at the interpreter, including loops and
829 829 compound statements. It is added by IPython to the Python builtin
830 830 namespace upon initialization."""
831 831
832 832 args = arg_s.split(' ',1)
833 833 magic_name = args[0]
834 834 magic_name = magic_name.lstrip(self.ESC_MAGIC)
835 835
836 836 try:
837 837 magic_args = args[1]
838 838 except IndexError:
839 839 magic_args = ''
840 840 fn = getattr(self,'magic_'+magic_name,None)
841 841 if fn is None:
842 842 error("Magic function `%s` not found." % magic_name)
843 843 else:
844 844 magic_args = self.var_expand(magic_args)
845 845 return fn(magic_args)
846 846
847 847 def ipalias(self,arg_s):
848 848 """Call an alias by name.
849 849
850 850 Input: a string containing the name of the alias to call and any
851 851 additional arguments to be passed to the magic.
852 852
853 853 ipalias('name -opt foo bar') is equivalent to typing at the ipython
854 854 prompt:
855 855
856 856 In[1]: name -opt foo bar
857 857
858 858 To call an alias without arguments, simply use ipalias('name').
859 859
860 860 This provides a proper Python function to call IPython's aliases in any
861 861 valid Python code you can type at the interpreter, including loops and
862 862 compound statements. It is added by IPython to the Python builtin
863 863 namespace upon initialization."""
864 864
865 865 args = arg_s.split(' ',1)
866 866 alias_name = args[0]
867 867 try:
868 868 alias_args = args[1]
869 869 except IndexError:
870 870 alias_args = ''
871 871 if alias_name in self.alias_table:
872 872 self.call_alias(alias_name,alias_args)
873 873 else:
874 874 error("Alias `%s` not found." % alias_name)
875 875
876 876 def ipsystem(self,arg_s):
877 877 """Make a system call, using IPython."""
878 878
879 879 self.system(arg_s)
880 880
881 881 def complete(self,text):
882 882 """Return a sorted list of all possible completions on text.
883 883
884 884 Inputs:
885 885
886 886 - text: a string of text to be completed on.
887 887
888 888 This is a wrapper around the completion mechanism, similar to what
889 889 readline does at the command line when the TAB key is hit. By
890 890 exposing it as a method, it can be used by other non-readline
891 891 environments (such as GUIs) for text completion.
892 892
893 893 Simple usage example:
894 894
895 895 In [1]: x = 'hello'
896 896
897 897 In [2]: __IP.complete('x.l')
898 898 Out[2]: ['x.ljust', 'x.lower', 'x.lstrip']"""
899 899
900 900 complete = self.Completer.complete
901 901 state = 0
902 902 # use a dict so we get unique keys, since ipyhton's multiple
903 903 # completers can return duplicates.
904 904 comps = {}
905 905 while True:
906 906 newcomp = complete(text,state)
907 907 if newcomp is None:
908 908 break
909 909 comps[newcomp] = 1
910 910 state += 1
911 911 outcomps = comps.keys()
912 912 outcomps.sort()
913 913 return outcomps
914 914
915 915 def set_completer_frame(self, frame=None):
916 916 if frame:
917 917 self.Completer.namespace = frame.f_locals
918 918 self.Completer.global_namespace = frame.f_globals
919 919 else:
920 920 self.Completer.namespace = self.user_ns
921 921 self.Completer.global_namespace = self.user_global_ns
922 922
923 923 def init_auto_alias(self):
924 924 """Define some aliases automatically.
925 925
926 926 These are ALL parameter-less aliases"""
927 927
928 928 for alias,cmd in self.auto_alias:
929 929 self.alias_table[alias] = (0,cmd)
930 930
931 931 def alias_table_validate(self,verbose=0):
932 932 """Update information about the alias table.
933 933
934 934 In particular, make sure no Python keywords/builtins are in it."""
935 935
936 936 no_alias = self.no_alias
937 937 for k in self.alias_table.keys():
938 938 if k in no_alias:
939 939 del self.alias_table[k]
940 940 if verbose:
941 941 print ("Deleting alias <%s>, it's a Python "
942 942 "keyword or builtin." % k)
943 943
944 944 def set_autoindent(self,value=None):
945 945 """Set the autoindent flag, checking for readline support.
946 946
947 947 If called with no arguments, it acts as a toggle."""
948 948
949 949 if not self.has_readline:
950 950 if os.name == 'posix':
951 951 warn("The auto-indent feature requires the readline library")
952 952 self.autoindent = 0
953 953 return
954 954 if value is None:
955 955 self.autoindent = not self.autoindent
956 956 else:
957 957 self.autoindent = value
958 958
959 959 def rc_set_toggle(self,rc_field,value=None):
960 960 """Set or toggle a field in IPython's rc config. structure.
961 961
962 962 If called with no arguments, it acts as a toggle.
963 963
964 964 If called with a non-existent field, the resulting AttributeError
965 965 exception will propagate out."""
966 966
967 967 rc_val = getattr(self.rc,rc_field)
968 968 if value is None:
969 969 value = not rc_val
970 970 setattr(self.rc,rc_field,value)
971 971
972 972 def user_setup(self,ipythondir,rc_suffix,mode='install'):
973 973 """Install the user configuration directory.
974 974
975 975 Can be called when running for the first time or to upgrade the user's
976 976 .ipython/ directory with the mode parameter. Valid modes are 'install'
977 977 and 'upgrade'."""
978 978
979 979 def wait():
980 980 try:
981 981 raw_input("Please press <RETURN> to start IPython.")
982 982 except EOFError:
983 983 print >> Term.cout
984 984 print '*'*70
985 985
986 986 cwd = os.getcwd() # remember where we started
987 987 glb = glob.glob
988 988 print '*'*70
989 989 if mode == 'install':
990 990 print \
991 991 """Welcome to IPython. I will try to create a personal configuration directory
992 992 where you can customize many aspects of IPython's functionality in:\n"""
993 993 else:
994 994 print 'I am going to upgrade your configuration in:'
995 995
996 996 print ipythondir
997 997
998 998 rcdirend = os.path.join('IPython','UserConfig')
999 999 cfg = lambda d: os.path.join(d,rcdirend)
1000 1000 try:
1001 1001 rcdir = filter(os.path.isdir,map(cfg,sys.path))[0]
1002 1002 except IOError:
1003 1003 warning = """
1004 1004 Installation error. IPython's directory was not found.
1005 1005
1006 1006 Check the following:
1007 1007
1008 1008 The ipython/IPython directory should be in a directory belonging to your
1009 1009 PYTHONPATH environment variable (that is, it should be in a directory
1010 1010 belonging to sys.path). You can copy it explicitly there or just link to it.
1011 1011
1012 1012 IPython will proceed with builtin defaults.
1013 1013 """
1014 1014 warn(warning)
1015 1015 wait()
1016 1016 return
1017 1017
1018 1018 if mode == 'install':
1019 1019 try:
1020 1020 shutil.copytree(rcdir,ipythondir)
1021 1021 os.chdir(ipythondir)
1022 1022 rc_files = glb("ipythonrc*")
1023 1023 for rc_file in rc_files:
1024 1024 os.rename(rc_file,rc_file+rc_suffix)
1025 1025 except:
1026 1026 warning = """
1027 1027
1028 1028 There was a problem with the installation:
1029 1029 %s
1030 1030 Try to correct it or contact the developers if you think it's a bug.
1031 1031 IPython will proceed with builtin defaults.""" % sys.exc_info()[1]
1032 1032 warn(warning)
1033 1033 wait()
1034 1034 return
1035 1035
1036 1036 elif mode == 'upgrade':
1037 1037 try:
1038 1038 os.chdir(ipythondir)
1039 1039 except:
1040 1040 print """
1041 1041 Can not upgrade: changing to directory %s failed. Details:
1042 1042 %s
1043 1043 """ % (ipythondir,sys.exc_info()[1])
1044 1044 wait()
1045 1045 return
1046 1046 else:
1047 1047 sources = glb(os.path.join(rcdir,'[A-Za-z]*'))
1048 1048 for new_full_path in sources:
1049 1049 new_filename = os.path.basename(new_full_path)
1050 1050 if new_filename.startswith('ipythonrc'):
1051 1051 new_filename = new_filename + rc_suffix
1052 1052 # The config directory should only contain files, skip any
1053 1053 # directories which may be there (like CVS)
1054 1054 if os.path.isdir(new_full_path):
1055 1055 continue
1056 1056 if os.path.exists(new_filename):
1057 1057 old_file = new_filename+'.old'
1058 1058 if os.path.exists(old_file):
1059 1059 os.remove(old_file)
1060 1060 os.rename(new_filename,old_file)
1061 1061 shutil.copy(new_full_path,new_filename)
1062 1062 else:
1063 1063 raise ValueError,'unrecognized mode for install:',`mode`
1064 1064
1065 1065 # Fix line-endings to those native to each platform in the config
1066 1066 # directory.
1067 1067 try:
1068 1068 os.chdir(ipythondir)
1069 1069 except:
1070 1070 print """
1071 1071 Problem: changing to directory %s failed.
1072 1072 Details:
1073 1073 %s
1074 1074
1075 1075 Some configuration files may have incorrect line endings. This should not
1076 1076 cause any problems during execution. """ % (ipythondir,sys.exc_info()[1])
1077 1077 wait()
1078 1078 else:
1079 1079 for fname in glb('ipythonrc*'):
1080 1080 try:
1081 1081 native_line_ends(fname,backup=0)
1082 1082 except IOError:
1083 1083 pass
1084 1084
1085 1085 if mode == 'install':
1086 1086 print """
1087 1087 Successful installation!
1088 1088
1089 1089 Please read the sections 'Initial Configuration' and 'Quick Tips' in the
1090 1090 IPython manual (there are both HTML and PDF versions supplied with the
1091 1091 distribution) to make sure that your system environment is properly configured
1092 1092 to take advantage of IPython's features.
1093 1093
1094 1094 Important note: the configuration system has changed! The old system is
1095 1095 still in place, but its setting may be partly overridden by the settings in
1096 1096 "~/.ipython/ipy_user_conf.py" config file. Please take a look at the file
1097 1097 if some of the new settings bother you.
1098 1098
1099 1099 """
1100 1100 else:
1101 1101 print """
1102 1102 Successful upgrade!
1103 1103
1104 1104 All files in your directory:
1105 1105 %(ipythondir)s
1106 1106 which would have been overwritten by the upgrade were backed up with a .old
1107 1107 extension. If you had made particular customizations in those files you may
1108 1108 want to merge them back into the new files.""" % locals()
1109 1109 wait()
1110 1110 os.chdir(cwd)
1111 1111 # end user_setup()
1112 1112
1113 1113 def atexit_operations(self):
1114 1114 """This will be executed at the time of exit.
1115 1115
1116 1116 Saving of persistent data should be performed here. """
1117 1117
1118 1118 #print '*** IPython exit cleanup ***' # dbg
1119 1119 # input history
1120 1120 self.savehist()
1121 1121
1122 1122 # Cleanup all tempfiles left around
1123 1123 for tfile in self.tempfiles:
1124 1124 try:
1125 1125 os.unlink(tfile)
1126 1126 except OSError:
1127 1127 pass
1128 1128
1129 1129 # save the "persistent data" catch-all dictionary
1130 1130 self.hooks.shutdown_hook()
1131 1131
1132 1132 def savehist(self):
1133 1133 """Save input history to a file (via readline library)."""
1134 1134 try:
1135 1135 self.readline.write_history_file(self.histfile)
1136 1136 except:
1137 1137 print 'Unable to save IPython command history to file: ' + \
1138 1138 `self.histfile`
1139 1139
1140 1140 def pre_readline(self):
1141 1141 """readline hook to be used at the start of each line.
1142 1142
1143 1143 Currently it handles auto-indent only."""
1144 1144
1145 1145 #debugx('self.indent_current_nsp','pre_readline:')
1146 1146 self.readline.insert_text(self.indent_current_str())
1147 1147
1148 1148 def init_readline(self):
1149 1149 """Command history completion/saving/reloading."""
1150 1150
1151 1151 import IPython.rlineimpl as readline
1152 1152 if not readline.have_readline:
1153 1153 self.has_readline = 0
1154 1154 self.readline = None
1155 1155 # no point in bugging windows users with this every time:
1156 1156 warn('Readline services not available on this platform.')
1157 1157 else:
1158 1158 sys.modules['readline'] = readline
1159 1159 import atexit
1160 1160 from IPython.completer import IPCompleter
1161 1161 self.Completer = IPCompleter(self,
1162 1162 self.user_ns,
1163 1163 self.user_global_ns,
1164 1164 self.rc.readline_omit__names,
1165 1165 self.alias_table)
1166 1166
1167 1167 # Platform-specific configuration
1168 1168 if os.name == 'nt':
1169 1169 self.readline_startup_hook = readline.set_pre_input_hook
1170 1170 else:
1171 1171 self.readline_startup_hook = readline.set_startup_hook
1172 1172
1173 1173 # Load user's initrc file (readline config)
1174 1174 inputrc_name = os.environ.get('INPUTRC')
1175 1175 if inputrc_name is None:
1176 1176 home_dir = get_home_dir()
1177 1177 if home_dir is not None:
1178 1178 inputrc_name = os.path.join(home_dir,'.inputrc')
1179 1179 if os.path.isfile(inputrc_name):
1180 1180 try:
1181 1181 readline.read_init_file(inputrc_name)
1182 1182 except:
1183 1183 warn('Problems reading readline initialization file <%s>'
1184 1184 % inputrc_name)
1185 1185
1186 1186 self.has_readline = 1
1187 1187 self.readline = readline
1188 1188 # save this in sys so embedded copies can restore it properly
1189 1189 sys.ipcompleter = self.Completer.complete
1190 1190 readline.set_completer(self.Completer.complete)
1191 1191
1192 1192 # Configure readline according to user's prefs
1193 1193 for rlcommand in self.rc.readline_parse_and_bind:
1194 1194 readline.parse_and_bind(rlcommand)
1195 1195
1196 1196 # remove some chars from the delimiters list
1197 1197 delims = readline.get_completer_delims()
1198 1198 delims = delims.translate(string._idmap,
1199 1199 self.rc.readline_remove_delims)
1200 1200 readline.set_completer_delims(delims)
1201 1201 # otherwise we end up with a monster history after a while:
1202 1202 readline.set_history_length(1000)
1203 1203 try:
1204 1204 #print '*** Reading readline history' # dbg
1205 1205 readline.read_history_file(self.histfile)
1206 1206 except IOError:
1207 1207 pass # It doesn't exist yet.
1208 1208
1209 1209 atexit.register(self.atexit_operations)
1210 1210 del atexit
1211 1211
1212 1212 # Configure auto-indent for all platforms
1213 1213 self.set_autoindent(self.rc.autoindent)
1214 1214
1215 1215 def _should_recompile(self,e):
1216 1216 """Utility routine for edit_syntax_error"""
1217 1217
1218 1218 if e.filename in ('<ipython console>','<input>','<string>',
1219 1219 '<console>',None):
1220 1220
1221 1221 return False
1222 1222 try:
1223 1223 if (self.rc.autoedit_syntax != 2 and
1224 1224 not ask_yes_no('Return to editor to correct syntax error? '
1225 1225 '[Y/n] ','y')):
1226 1226 return False
1227 1227 except EOFError:
1228 1228 return False
1229 1229
1230 1230 def int0(x):
1231 1231 try:
1232 1232 return int(x)
1233 1233 except TypeError:
1234 1234 return 0
1235 1235 # always pass integer line and offset values to editor hook
1236 1236 self.hooks.fix_error_editor(e.filename,
1237 1237 int0(e.lineno),int0(e.offset),e.msg)
1238 1238 return True
1239 1239
1240 1240 def edit_syntax_error(self):
1241 1241 """The bottom half of the syntax error handler called in the main loop.
1242 1242
1243 1243 Loop until syntax error is fixed or user cancels.
1244 1244 """
1245 1245
1246 1246 while self.SyntaxTB.last_syntax_error:
1247 1247 # copy and clear last_syntax_error
1248 1248 err = self.SyntaxTB.clear_err_state()
1249 1249 if not self._should_recompile(err):
1250 1250 return
1251 1251 try:
1252 1252 # may set last_syntax_error again if a SyntaxError is raised
1253 1253 self.safe_execfile(err.filename,self.shell.user_ns)
1254 1254 except:
1255 1255 self.showtraceback()
1256 1256 else:
1257 1257 f = file(err.filename)
1258 1258 try:
1259 1259 sys.displayhook(f.read())
1260 1260 finally:
1261 1261 f.close()
1262 1262
1263 1263 def showsyntaxerror(self, filename=None):
1264 1264 """Display the syntax error that just occurred.
1265 1265
1266 1266 This doesn't display a stack trace because there isn't one.
1267 1267
1268 1268 If a filename is given, it is stuffed in the exception instead
1269 1269 of what was there before (because Python's parser always uses
1270 1270 "<string>" when reading from a string).
1271 1271 """
1272 1272 etype, value, last_traceback = sys.exc_info()
1273 1273 if filename and etype is SyntaxError:
1274 1274 # Work hard to stuff the correct filename in the exception
1275 1275 try:
1276 1276 msg, (dummy_filename, lineno, offset, line) = value
1277 1277 except:
1278 1278 # Not the format we expect; leave it alone
1279 1279 pass
1280 1280 else:
1281 1281 # Stuff in the right filename
1282 1282 try:
1283 1283 # Assume SyntaxError is a class exception
1284 1284 value = SyntaxError(msg, (filename, lineno, offset, line))
1285 1285 except:
1286 1286 # If that failed, assume SyntaxError is a string
1287 1287 value = msg, (filename, lineno, offset, line)
1288 1288 self.SyntaxTB(etype,value,[])
1289 1289
1290 1290 def debugger(self):
1291 1291 """Call the pdb debugger."""
1292 1292
1293 1293 if not self.rc.pdb:
1294 1294 return
1295 1295 pdb.pm()
1296 1296
1297 1297 def showtraceback(self,exc_tuple = None,filename=None):
1298 1298 """Display the exception that just occurred."""
1299 1299
1300 1300 # Though this won't be called by syntax errors in the input line,
1301 1301 # there may be SyntaxError cases whith imported code.
1302 1302 if exc_tuple is None:
1303 1303 type, value, tb = sys.exc_info()
1304 1304 else:
1305 1305 type, value, tb = exc_tuple
1306 1306 if type is SyntaxError:
1307 1307 self.showsyntaxerror(filename)
1308 1308 else:
1309 1309 self.InteractiveTB()
1310 1310 if self.InteractiveTB.call_pdb and self.has_readline:
1311 1311 # pdb mucks up readline, fix it back
1312 1312 self.readline.set_completer(self.Completer.complete)
1313 1313
1314 1314 def mainloop(self,banner=None):
1315 1315 """Creates the local namespace and starts the mainloop.
1316 1316
1317 1317 If an optional banner argument is given, it will override the
1318 1318 internally created default banner."""
1319 1319
1320 1320 if self.rc.c: # Emulate Python's -c option
1321 1321 self.exec_init_cmd()
1322 1322 if banner is None:
1323 1323 if self.rc.banner:
1324 1324 banner = self.BANNER+self.banner2
1325 1325 else:
1326 1326 banner = ''
1327 1327 self.interact(banner)
1328 1328
1329 1329 def exec_init_cmd(self):
1330 1330 """Execute a command given at the command line.
1331 1331
1332 1332 This emulates Python's -c option."""
1333 1333
1334 1334 #sys.argv = ['-c']
1335 1335 self.push(self.rc.c)
1336 1336
1337 1337 def embed_mainloop(self,header='',local_ns=None,global_ns=None,stack_depth=0):
1338 1338 """Embeds IPython into a running python program.
1339 1339
1340 1340 Input:
1341 1341
1342 1342 - header: An optional header message can be specified.
1343 1343
1344 1344 - local_ns, global_ns: working namespaces. If given as None, the
1345 1345 IPython-initialized one is updated with __main__.__dict__, so that
1346 1346 program variables become visible but user-specific configuration
1347 1347 remains possible.
1348 1348
1349 1349 - stack_depth: specifies how many levels in the stack to go to
1350 1350 looking for namespaces (when local_ns and global_ns are None). This
1351 1351 allows an intermediate caller to make sure that this function gets
1352 1352 the namespace from the intended level in the stack. By default (0)
1353 1353 it will get its locals and globals from the immediate caller.
1354 1354
1355 1355 Warning: it's possible to use this in a program which is being run by
1356 1356 IPython itself (via %run), but some funny things will happen (a few
1357 1357 globals get overwritten). In the future this will be cleaned up, as
1358 1358 there is no fundamental reason why it can't work perfectly."""
1359 1359
1360 1360 # Get locals and globals from caller
1361 1361 if local_ns is None or global_ns is None:
1362 1362 call_frame = sys._getframe(stack_depth).f_back
1363 1363
1364 1364 if local_ns is None:
1365 1365 local_ns = call_frame.f_locals
1366 1366 if global_ns is None:
1367 1367 global_ns = call_frame.f_globals
1368 1368
1369 1369 # Update namespaces and fire up interpreter
1370 1370
1371 1371 # The global one is easy, we can just throw it in
1372 1372 self.user_global_ns = global_ns
1373 1373
1374 1374 # but the user/local one is tricky: ipython needs it to store internal
1375 1375 # data, but we also need the locals. We'll copy locals in the user
1376 1376 # one, but will track what got copied so we can delete them at exit.
1377 1377 # This is so that a later embedded call doesn't see locals from a
1378 1378 # previous call (which most likely existed in a separate scope).
1379 1379 local_varnames = local_ns.keys()
1380 1380 self.user_ns.update(local_ns)
1381 1381
1382 1382 # Patch for global embedding to make sure that things don't overwrite
1383 1383 # user globals accidentally. Thanks to Richard <rxe@renre-europe.com>
1384 1384 # FIXME. Test this a bit more carefully (the if.. is new)
1385 1385 if local_ns is None and global_ns is None:
1386 1386 self.user_global_ns.update(__main__.__dict__)
1387 1387
1388 1388 # make sure the tab-completer has the correct frame information, so it
1389 1389 # actually completes using the frame's locals/globals
1390 1390 self.set_completer_frame()
1391 1391
1392 1392 # before activating the interactive mode, we need to make sure that
1393 1393 # all names in the builtin namespace needed by ipython point to
1394 1394 # ourselves, and not to other instances.
1395 1395 self.add_builtins()
1396 1396
1397 1397 self.interact(header)
1398 1398
1399 1399 # now, purge out the user namespace from anything we might have added
1400 1400 # from the caller's local namespace
1401 1401 delvar = self.user_ns.pop
1402 1402 for var in local_varnames:
1403 1403 delvar(var,None)
1404 1404 # and clean builtins we may have overridden
1405 1405 self.clean_builtins()
1406 1406
1407 1407 def interact(self, banner=None):
1408 1408 """Closely emulate the interactive Python console.
1409 1409
1410 1410 The optional banner argument specify the banner to print
1411 1411 before the first interaction; by default it prints a banner
1412 1412 similar to the one printed by the real Python interpreter,
1413 1413 followed by the current class name in parentheses (so as not
1414 1414 to confuse this with the real interpreter -- since it's so
1415 1415 close!).
1416 1416
1417 1417 """
1418 1418 cprt = 'Type "copyright", "credits" or "license" for more information.'
1419 1419 if banner is None:
1420 1420 self.write("Python %s on %s\n%s\n(%s)\n" %
1421 1421 (sys.version, sys.platform, cprt,
1422 1422 self.__class__.__name__))
1423 1423 else:
1424 1424 self.write(banner)
1425 1425
1426 1426 more = 0
1427 1427
1428 1428 # Mark activity in the builtins
1429 1429 __builtin__.__dict__['__IPYTHON__active'] += 1
1430 1430
1431 1431 # exit_now is set by a call to %Exit or %Quit
1432 1432 self.exit_now = False
1433 1433 while not self.exit_now:
1434 1434 if more:
1435 1435 prompt = self.outputcache.prompt2
1436 1436 if self.autoindent:
1437 1437 self.readline_startup_hook(self.pre_readline)
1438 1438 else:
1439 1439 prompt = self.outputcache.prompt1
1440 1440 try:
1441 1441 line = self.raw_input(prompt,more)
1442 1442 if self.autoindent:
1443 1443 self.readline_startup_hook(None)
1444 1444 except KeyboardInterrupt:
1445 1445 self.write('\nKeyboardInterrupt\n')
1446 1446 self.resetbuffer()
1447 1447 # keep cache in sync with the prompt counter:
1448 1448 self.outputcache.prompt_count -= 1
1449 1449
1450 1450 if self.autoindent:
1451 1451 self.indent_current_nsp = 0
1452 1452 more = 0
1453 1453 except EOFError:
1454 1454 if self.autoindent:
1455 1455 self.readline_startup_hook(None)
1456 1456 self.write('\n')
1457 1457 self.exit()
1458 1458 except bdb.BdbQuit:
1459 1459 warn('The Python debugger has exited with a BdbQuit exception.\n'
1460 1460 'Because of how pdb handles the stack, it is impossible\n'
1461 1461 'for IPython to properly format this particular exception.\n'
1462 1462 'IPython will resume normal operation.')
1463 1463 except:
1464 1464 # exceptions here are VERY RARE, but they can be triggered
1465 1465 # asynchronously by signal handlers, for example.
1466 1466 self.showtraceback()
1467 1467 else:
1468 1468 more = self.push(line)
1469 1469 if (self.SyntaxTB.last_syntax_error and
1470 1470 self.rc.autoedit_syntax):
1471 1471 self.edit_syntax_error()
1472 1472
1473 1473 # We are off again...
1474 1474 __builtin__.__dict__['__IPYTHON__active'] -= 1
1475 1475
1476 1476 def excepthook(self, type, value, tb):
1477 1477 """One more defense for GUI apps that call sys.excepthook.
1478 1478
1479 1479 GUI frameworks like wxPython trap exceptions and call
1480 1480 sys.excepthook themselves. I guess this is a feature that
1481 1481 enables them to keep running after exceptions that would
1482 1482 otherwise kill their mainloop. This is a bother for IPython
1483 1483 which excepts to catch all of the program exceptions with a try:
1484 1484 except: statement.
1485 1485
1486 1486 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
1487 1487 any app directly invokes sys.excepthook, it will look to the user like
1488 1488 IPython crashed. In order to work around this, we can disable the
1489 1489 CrashHandler and replace it with this excepthook instead, which prints a
1490 1490 regular traceback using our InteractiveTB. In this fashion, apps which
1491 1491 call sys.excepthook will generate a regular-looking exception from
1492 1492 IPython, and the CrashHandler will only be triggered by real IPython
1493 1493 crashes.
1494 1494
1495 1495 This hook should be used sparingly, only in places which are not likely
1496 1496 to be true IPython errors.
1497 1497 """
1498 1498
1499 1499 self.InteractiveTB(type, value, tb, tb_offset=0)
1500 1500 if self.InteractiveTB.call_pdb and self.has_readline:
1501 1501 self.readline.set_completer(self.Completer.complete)
1502 1502
1503 def call_alias(self,alias,rest=''):
1504 """Call an alias given its name and the rest of the line.
1505
1506 This function MUST be given a proper alias, because it doesn't make
1507 any checks when looking up into the alias table. The caller is
1508 responsible for invoking it only with a valid alias."""
1509
1510 #print 'ALIAS: <%s>+<%s>' % (alias,rest) # dbg
1503 def transform_alias(self, alias,rest=''):
1504 """ Transform alias to system command string
1505
1506 """
1511 1507 nargs,cmd = self.alias_table[alias]
1512 1508 # Expand the %l special to be the user's input line
1513 1509 if cmd.find('%l') >= 0:
1514 1510 cmd = cmd.replace('%l',rest)
1515 1511 rest = ''
1516 1512 if nargs==0:
1517 1513 # Simple, argument-less aliases
1518 1514 cmd = '%s %s' % (cmd,rest)
1519 1515 else:
1520 1516 # Handle aliases with positional arguments
1521 1517 args = rest.split(None,nargs)
1522 1518 if len(args)< nargs:
1523 1519 error('Alias <%s> requires %s arguments, %s given.' %
1524 1520 (alias,nargs,len(args)))
1525 return
1521 return None
1526 1522 cmd = '%s %s' % (cmd % tuple(args[:nargs]),' '.join(args[nargs:]))
1527 1523 # Now call the macro, evaluating in the user's namespace
1524
1525 return cmd
1526
1527 def call_alias(self,alias,rest=''):
1528 """Call an alias given its name and the rest of the line.
1529
1530 This is only used to provide backwards compatibility for users of
1531 ipalias(), use of which is not recommended for anymore."""
1532
1533 # Now call the macro, evaluating in the user's namespace
1534 cmd = self.transform_alias(alias, rest)
1528 1535 try:
1529 1536 self.system(cmd)
1530 1537 except:
1531 1538 self.showtraceback()
1532 1539
1533 1540 def indent_current_str(self):
1534 1541 """return the current level of indentation as a string"""
1535 1542 return self.indent_current_nsp * ' '
1536 1543
1537 1544 def autoindent_update(self,line):
1538 1545 """Keep track of the indent level."""
1539 1546
1540 1547 #debugx('line')
1541 1548 #debugx('self.indent_current_nsp')
1542 1549 if self.autoindent:
1543 1550 if line:
1544 1551 inisp = num_ini_spaces(line)
1545 1552 if inisp < self.indent_current_nsp:
1546 1553 self.indent_current_nsp = inisp
1547 1554
1548 1555 if line[-1] == ':':
1549 1556 self.indent_current_nsp += 4
1550 1557 elif dedent_re.match(line):
1551 1558 self.indent_current_nsp -= 4
1552 1559 else:
1553 1560 self.indent_current_nsp = 0
1554 1561
1555 1562 def runlines(self,lines):
1556 1563 """Run a string of one or more lines of source.
1557 1564
1558 1565 This method is capable of running a string containing multiple source
1559 1566 lines, as if they had been entered at the IPython prompt. Since it
1560 1567 exposes IPython's processing machinery, the given strings can contain
1561 1568 magic calls (%magic), special shell access (!cmd), etc."""
1562 1569
1563 1570 # We must start with a clean buffer, in case this is run from an
1564 1571 # interactive IPython session (via a magic, for example).
1565 1572 self.resetbuffer()
1566 1573 lines = lines.split('\n')
1567 1574 more = 0
1568 1575 for line in lines:
1569 1576 # skip blank lines so we don't mess up the prompt counter, but do
1570 1577 # NOT skip even a blank line if we are in a code block (more is
1571 1578 # true)
1572 1579 if line or more:
1573 1580 more = self.push(self.prefilter(line,more))
1574 1581 # IPython's runsource returns None if there was an error
1575 1582 # compiling the code. This allows us to stop processing right
1576 1583 # away, so the user gets the error message at the right place.
1577 1584 if more is None:
1578 1585 break
1579 1586 # final newline in case the input didn't have it, so that the code
1580 1587 # actually does get executed
1581 1588 if more:
1582 1589 self.push('\n')
1583 1590
1584 1591 def runsource(self, source, filename='<input>', symbol='single'):
1585 1592 """Compile and run some source in the interpreter.
1586 1593
1587 1594 Arguments are as for compile_command().
1588 1595
1589 1596 One several things can happen:
1590 1597
1591 1598 1) The input is incorrect; compile_command() raised an
1592 1599 exception (SyntaxError or OverflowError). A syntax traceback
1593 1600 will be printed by calling the showsyntaxerror() method.
1594 1601
1595 1602 2) The input is incomplete, and more input is required;
1596 1603 compile_command() returned None. Nothing happens.
1597 1604
1598 1605 3) The input is complete; compile_command() returned a code
1599 1606 object. The code is executed by calling self.runcode() (which
1600 1607 also handles run-time exceptions, except for SystemExit).
1601 1608
1602 1609 The return value is:
1603 1610
1604 1611 - True in case 2
1605 1612
1606 1613 - False in the other cases, unless an exception is raised, where
1607 1614 None is returned instead. This can be used by external callers to
1608 1615 know whether to continue feeding input or not.
1609 1616
1610 1617 The return value can be used to decide whether to use sys.ps1 or
1611 1618 sys.ps2 to prompt the next line."""
1612 1619
1613 1620 try:
1614 1621 code = self.compile(source,filename,symbol)
1615 1622 except (OverflowError, SyntaxError, ValueError):
1616 1623 # Case 1
1617 1624 self.showsyntaxerror(filename)
1618 1625 return None
1619 1626
1620 1627 if code is None:
1621 1628 # Case 2
1622 1629 return True
1623 1630
1624 1631 # Case 3
1625 1632 # We store the code object so that threaded shells and
1626 1633 # custom exception handlers can access all this info if needed.
1627 1634 # The source corresponding to this can be obtained from the
1628 1635 # buffer attribute as '\n'.join(self.buffer).
1629 1636 self.code_to_run = code
1630 1637 # now actually execute the code object
1631 1638 if self.runcode(code) == 0:
1632 1639 return False
1633 1640 else:
1634 1641 return None
1635 1642
1636 1643 def runcode(self,code_obj):
1637 1644 """Execute a code object.
1638 1645
1639 1646 When an exception occurs, self.showtraceback() is called to display a
1640 1647 traceback.
1641 1648
1642 1649 Return value: a flag indicating whether the code to be run completed
1643 1650 successfully:
1644 1651
1645 1652 - 0: successful execution.
1646 1653 - 1: an error occurred.
1647 1654 """
1648 1655
1649 1656 # Set our own excepthook in case the user code tries to call it
1650 1657 # directly, so that the IPython crash handler doesn't get triggered
1651 1658 old_excepthook,sys.excepthook = sys.excepthook, self.excepthook
1652 1659
1653 1660 # we save the original sys.excepthook in the instance, in case config
1654 1661 # code (such as magics) needs access to it.
1655 1662 self.sys_excepthook = old_excepthook
1656 1663 outflag = 1 # happens in more places, so it's easier as default
1657 1664 try:
1658 1665 try:
1659 1666 # Embedded instances require separate global/local namespaces
1660 1667 # so they can see both the surrounding (local) namespace and
1661 1668 # the module-level globals when called inside another function.
1662 1669 if self.embedded:
1663 1670 exec code_obj in self.user_global_ns, self.user_ns
1664 1671 # Normal (non-embedded) instances should only have a single
1665 1672 # namespace for user code execution, otherwise functions won't
1666 1673 # see interactive top-level globals.
1667 1674 else:
1668 1675 exec code_obj in self.user_ns
1669 1676 finally:
1670 1677 # Reset our crash handler in place
1671 1678 sys.excepthook = old_excepthook
1672 1679 except SystemExit:
1673 1680 self.resetbuffer()
1674 1681 self.showtraceback()
1675 1682 warn("Type exit or quit to exit IPython "
1676 1683 "(%Exit or %Quit do so unconditionally).",level=1)
1677 1684 except self.custom_exceptions:
1678 1685 etype,value,tb = sys.exc_info()
1679 1686 self.CustomTB(etype,value,tb)
1680 1687 except:
1681 1688 self.showtraceback()
1682 1689 else:
1683 1690 outflag = 0
1684 1691 if softspace(sys.stdout, 0):
1685 1692 print
1686 1693 # Flush out code object which has been run (and source)
1687 1694 self.code_to_run = None
1688 1695 return outflag
1689 1696
1690 1697 def push(self, line):
1691 1698 """Push a line to the interpreter.
1692 1699
1693 1700 The line should not have a trailing newline; it may have
1694 1701 internal newlines. The line is appended to a buffer and the
1695 1702 interpreter's runsource() method is called with the
1696 1703 concatenated contents of the buffer as source. If this
1697 1704 indicates that the command was executed or invalid, the buffer
1698 1705 is reset; otherwise, the command is incomplete, and the buffer
1699 1706 is left as it was after the line was appended. The return
1700 1707 value is 1 if more input is required, 0 if the line was dealt
1701 1708 with in some way (this is the same as runsource()).
1702 1709 """
1703 1710
1704 1711 # autoindent management should be done here, and not in the
1705 1712 # interactive loop, since that one is only seen by keyboard input. We
1706 1713 # need this done correctly even for code run via runlines (which uses
1707 1714 # push).
1708 1715
1709 1716 #print 'push line: <%s>' % line # dbg
1710 1717 self.autoindent_update(line)
1711 1718
1712 1719 self.buffer.append(line)
1713 1720 more = self.runsource('\n'.join(self.buffer), self.filename)
1714 1721 if not more:
1715 1722 self.resetbuffer()
1716 1723 return more
1717 1724
1718 1725 def resetbuffer(self):
1719 1726 """Reset the input buffer."""
1720 1727 self.buffer[:] = []
1721 1728
1722 1729 def raw_input(self,prompt='',continue_prompt=False):
1723 1730 """Write a prompt and read a line.
1724 1731
1725 1732 The returned line does not include the trailing newline.
1726 1733 When the user enters the EOF key sequence, EOFError is raised.
1727 1734
1728 1735 Optional inputs:
1729 1736
1730 1737 - prompt(''): a string to be printed to prompt the user.
1731 1738
1732 1739 - continue_prompt(False): whether this line is the first one or a
1733 1740 continuation in a sequence of inputs.
1734 1741 """
1735 1742
1736 1743 line = raw_input_original(prompt)
1737 1744
1738 1745 # Try to be reasonably smart about not re-indenting pasted input more
1739 1746 # than necessary. We do this by trimming out the auto-indent initial
1740 1747 # spaces, if the user's actual input started itself with whitespace.
1741 1748 #debugx('self.buffer[-1]')
1742 1749
1743 1750 if self.autoindent:
1744 1751 if num_ini_spaces(line) > self.indent_current_nsp:
1745 1752 line = line[self.indent_current_nsp:]
1746 1753 self.indent_current_nsp = 0
1747 1754
1748 1755 # store the unfiltered input before the user has any chance to modify
1749 1756 # it.
1750 1757 if line.strip():
1751 1758 if continue_prompt:
1752 1759 self.input_hist_raw[-1] += '%s\n' % line
1753 1760 else:
1754 1761 self.input_hist_raw.append('%s\n' % line)
1755 1762
1756 1763 lineout = self.prefilter(line,continue_prompt)
1757 1764 return lineout
1758 1765
1759 1766 def split_user_input(self,line):
1760 1767 """Split user input into pre-char, function part and rest."""
1761 1768
1762 1769 lsplit = self.line_split.match(line)
1763 1770 if lsplit is None: # no regexp match returns None
1764 1771 try:
1765 1772 iFun,theRest = line.split(None,1)
1766 1773 except ValueError:
1767 1774 iFun,theRest = line,''
1768 1775 pre = re.match('^(\s*)(.*)',line).groups()[0]
1769 1776 else:
1770 1777 pre,iFun,theRest = lsplit.groups()
1771 1778
1772 1779 #print 'line:<%s>' % line # dbg
1773 1780 #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun.strip(),theRest) # dbg
1774 1781 return pre,iFun.strip(),theRest
1775 1782
1776 1783 def _prefilter(self, line, continue_prompt):
1777 1784 """Calls different preprocessors, depending on the form of line."""
1778 1785
1779 1786 # All handlers *must* return a value, even if it's blank ('').
1780 1787
1781 1788 # Lines are NOT logged here. Handlers should process the line as
1782 1789 # needed, update the cache AND log it (so that the input cache array
1783 1790 # stays synced).
1784 1791
1785 1792 # This function is _very_ delicate, and since it's also the one which
1786 1793 # determines IPython's response to user input, it must be as efficient
1787 1794 # as possible. For this reason it has _many_ returns in it, trying
1788 1795 # always to exit as quickly as it can figure out what it needs to do.
1789 1796
1790 1797 # This function is the main responsible for maintaining IPython's
1791 1798 # behavior respectful of Python's semantics. So be _very_ careful if
1792 1799 # making changes to anything here.
1793 1800
1794 1801 #.....................................................................
1795 1802 # Code begins
1796 1803
1797 1804 #if line.startswith('%crash'): raise RuntimeError,'Crash now!' # dbg
1798 1805
1799 1806 # save the line away in case we crash, so the post-mortem handler can
1800 1807 # record it
1801 1808 self._last_input_line = line
1802 1809
1803 1810 #print '***line: <%s>' % line # dbg
1804 1811
1805 1812 # the input history needs to track even empty lines
1806 1813 stripped = line.strip()
1807 1814
1808 1815 if not stripped:
1809 1816 if not continue_prompt:
1810 1817 self.outputcache.prompt_count -= 1
1811 1818 return self.handle_normal(line,continue_prompt)
1812 1819 #return self.handle_normal('',continue_prompt)
1813 1820
1814 1821 # print '***cont',continue_prompt # dbg
1815 1822 # special handlers are only allowed for single line statements
1816 1823 if continue_prompt and not self.rc.multi_line_specials:
1817 1824 return self.handle_normal(line,continue_prompt)
1818 1825
1819 1826
1820 1827 # For the rest, we need the structure of the input
1821 1828 pre,iFun,theRest = self.split_user_input(line)
1822 1829
1823 1830 # See whether any pre-existing handler can take care of it
1824 1831
1825 1832 rewritten = self.hooks.input_prefilter(stripped)
1826 1833 if rewritten != stripped: # ok, some prefilter did something
1827 1834 rewritten = pre + rewritten # add indentation
1828 1835 return self.handle_normal(rewritten)
1829 1836
1830 1837
1831 1838
1832 1839
1833 1840 #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg
1834 1841
1835 1842 # First check for explicit escapes in the last/first character
1836 1843 handler = None
1837 1844 if line[-1] == self.ESC_HELP:
1838 1845 handler = self.esc_handlers.get(line[-1]) # the ? can be at the end
1839 1846 if handler is None:
1840 1847 # look at the first character of iFun, NOT of line, so we skip
1841 1848 # leading whitespace in multiline input
1842 1849 handler = self.esc_handlers.get(iFun[0:1])
1843 1850 if handler is not None:
1844 1851 return handler(line,continue_prompt,pre,iFun,theRest)
1845 1852 # Emacs ipython-mode tags certain input lines
1846 1853 if line.endswith('# PYTHON-MODE'):
1847 1854 return self.handle_emacs(line,continue_prompt)
1848 1855
1849 1856 # Next, check if we can automatically execute this thing
1850 1857
1851 1858 # Allow ! in multi-line statements if multi_line_specials is on:
1852 1859 if continue_prompt and self.rc.multi_line_specials and \
1853 1860 iFun.startswith(self.ESC_SHELL):
1854 1861 return self.handle_shell_escape(line,continue_prompt,
1855 1862 pre=pre,iFun=iFun,
1856 1863 theRest=theRest)
1857 1864
1858 1865 # Let's try to find if the input line is a magic fn
1859 1866 oinfo = None
1860 1867 if hasattr(self,'magic_'+iFun):
1861 1868 # WARNING: _ofind uses getattr(), so it can consume generators and
1862 1869 # cause other side effects.
1863 1870 oinfo = self._ofind(iFun) # FIXME - _ofind is part of Magic
1864 1871 if oinfo['ismagic']:
1865 1872 # Be careful not to call magics when a variable assignment is
1866 1873 # being made (ls='hi', for example)
1867 1874 if self.rc.automagic and \
1868 1875 (len(theRest)==0 or theRest[0] not in '!=()<>,') and \
1869 1876 (self.rc.multi_line_specials or not continue_prompt):
1870 1877 return self.handle_magic(line,continue_prompt,
1871 1878 pre,iFun,theRest)
1872 1879 else:
1873 1880 return self.handle_normal(line,continue_prompt)
1874 1881
1875 1882 # If the rest of the line begins with an (in)equality, assginment or
1876 1883 # function call, we should not call _ofind but simply execute it.
1877 1884 # This avoids spurious geattr() accesses on objects upon assignment.
1878 1885 #
1879 1886 # It also allows users to assign to either alias or magic names true
1880 1887 # python variables (the magic/alias systems always take second seat to
1881 1888 # true python code).
1882 1889 if theRest and theRest[0] in '!=()':
1883 1890 return self.handle_normal(line,continue_prompt)
1884 1891
1885 1892 if oinfo is None:
1886 1893 # let's try to ensure that _oinfo is ONLY called when autocall is
1887 1894 # on. Since it has inevitable potential side effects, at least
1888 1895 # having autocall off should be a guarantee to the user that no
1889 1896 # weird things will happen.
1890 1897
1891 1898 if self.rc.autocall:
1892 1899 oinfo = self._ofind(iFun) # FIXME - _ofind is part of Magic
1893 1900 else:
1894 1901 # in this case, all that's left is either an alias or
1895 1902 # processing the line normally.
1896 1903 if iFun in self.alias_table:
1897 1904 return self.handle_alias(line,continue_prompt,
1898 1905 pre,iFun,theRest)
1899 1906
1900 1907 else:
1901 1908 return self.handle_normal(line,continue_prompt)
1902 1909
1903 1910 if not oinfo['found']:
1904 1911 return self.handle_normal(line,continue_prompt)
1905 1912 else:
1906 1913 #print 'pre<%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg
1907 1914 if oinfo['isalias']:
1908 1915 return self.handle_alias(line,continue_prompt,
1909 1916 pre,iFun,theRest)
1910 1917
1911 1918 if (self.rc.autocall
1912 1919 and
1913 1920 (
1914 1921 #only consider exclusion re if not "," or ";" autoquoting
1915 1922 (pre == self.ESC_QUOTE or pre == self.ESC_QUOTE2
1916 1923 or pre == self.ESC_PAREN) or
1917 1924 (not self.re_exclude_auto.match(theRest)))
1918 1925 and
1919 1926 self.re_fun_name.match(iFun) and
1920 1927 callable(oinfo['obj'])) :
1921 1928 #print 'going auto' # dbg
1922 1929 return self.handle_auto(line,continue_prompt,
1923 1930 pre,iFun,theRest,oinfo['obj'])
1924 1931 else:
1925 1932 #print 'was callable?', callable(oinfo['obj']) # dbg
1926 1933 return self.handle_normal(line,continue_prompt)
1927 1934
1928 1935 # If we get here, we have a normal Python line. Log and return.
1929 1936 return self.handle_normal(line,continue_prompt)
1930 1937
1931 1938 def _prefilter_dumb(self, line, continue_prompt):
1932 1939 """simple prefilter function, for debugging"""
1933 1940 return self.handle_normal(line,continue_prompt)
1934 1941
1935 1942 # Set the default prefilter() function (this can be user-overridden)
1936 1943 prefilter = _prefilter
1937 1944
1938 1945 def handle_normal(self,line,continue_prompt=None,
1939 1946 pre=None,iFun=None,theRest=None):
1940 1947 """Handle normal input lines. Use as a template for handlers."""
1941 1948
1942 1949 # With autoindent on, we need some way to exit the input loop, and I
1943 1950 # don't want to force the user to have to backspace all the way to
1944 1951 # clear the line. The rule will be in this case, that either two
1945 1952 # lines of pure whitespace in a row, or a line of pure whitespace but
1946 1953 # of a size different to the indent level, will exit the input loop.
1947 1954
1948 1955 if (continue_prompt and self.autoindent and line.isspace() and
1949 1956 (0 < abs(len(line) - self.indent_current_nsp) <= 2 or
1950 1957 (self.buffer[-1]).isspace() )):
1951 1958 line = ''
1952 1959
1953 1960 self.log(line,continue_prompt)
1954 1961 return line
1955 1962
1956 1963 def handle_alias(self,line,continue_prompt=None,
1957 1964 pre=None,iFun=None,theRest=None):
1958 1965 """Handle alias input lines. """
1959 1966
1960 1967 # pre is needed, because it carries the leading whitespace. Otherwise
1961 1968 # aliases won't work in indented sections.
1962 line_out = '%sipalias(%s)' % (pre,make_quoted_expr(iFun + " " + theRest))
1969 transformed = self.transform_alias(iFun, theRest)
1970 line_out = '%s_ip.system(%s)' % (pre, make_quoted_expr( transformed ))
1963 1971 self.log(line_out,continue_prompt)
1964 1972 return line_out
1965 1973
1966 1974 def handle_shell_escape(self, line, continue_prompt=None,
1967 1975 pre=None,iFun=None,theRest=None):
1968 1976 """Execute the line in a shell, empty return value"""
1969 1977
1970 1978 #print 'line in :', `line` # dbg
1971 1979 # Example of a special handler. Others follow a similar pattern.
1972 1980 if line.lstrip().startswith('!!'):
1973 1981 # rewrite iFun/theRest to properly hold the call to %sx and
1974 1982 # the actual command to be executed, so handle_magic can work
1975 1983 # correctly
1976 1984 theRest = '%s %s' % (iFun[2:],theRest)
1977 1985 iFun = 'sx'
1978 1986 return self.handle_magic('%ssx %s' % (self.ESC_MAGIC,
1979 1987 line.lstrip()[2:]),
1980 1988 continue_prompt,pre,iFun,theRest)
1981 1989 else:
1982 1990 cmd=line.lstrip().lstrip('!')
1983 1991 line_out = '%s_ip.system(%s)' % (pre,make_quoted_expr(cmd))
1984 1992 # update cache/log and return
1985 1993 self.log(line_out,continue_prompt)
1986 1994 return line_out
1987 1995
1988 1996 def handle_magic(self, line, continue_prompt=None,
1989 1997 pre=None,iFun=None,theRest=None):
1990 1998 """Execute magic functions."""
1991 1999
1992 2000
1993 2001 cmd = '%s_ip.magic(%s)' % (pre,make_quoted_expr(iFun + " " + theRest))
1994 2002 self.log(cmd,continue_prompt)
1995 2003 #print 'in handle_magic, cmd=<%s>' % cmd # dbg
1996 2004 return cmd
1997 2005
1998 2006 def handle_auto(self, line, continue_prompt=None,
1999 2007 pre=None,iFun=None,theRest=None,obj=None):
2000 2008 """Hande lines which can be auto-executed, quoting if requested."""
2001 2009
2002 2010 #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg
2003 2011
2004 2012 # This should only be active for single-line input!
2005 2013 if continue_prompt:
2006 2014 self.log(line,continue_prompt)
2007 2015 return line
2008 2016
2009 2017 auto_rewrite = True
2010 2018
2011 2019 if pre == self.ESC_QUOTE:
2012 2020 # Auto-quote splitting on whitespace
2013 2021 newcmd = '%s("%s")' % (iFun,'", "'.join(theRest.split()) )
2014 2022 elif pre == self.ESC_QUOTE2:
2015 2023 # Auto-quote whole string
2016 2024 newcmd = '%s("%s")' % (iFun,theRest)
2017 2025 elif pre == self.ESC_PAREN:
2018 2026 newcmd = '%s(%s)' % (iFun,",".join(theRest.split()))
2019 2027 else:
2020 2028 # Auto-paren.
2021 2029 # We only apply it to argument-less calls if the autocall
2022 2030 # parameter is set to 2. We only need to check that autocall is <
2023 2031 # 2, since this function isn't called unless it's at least 1.
2024 2032 if not theRest and (self.rc.autocall < 2):
2025 2033 newcmd = '%s %s' % (iFun,theRest)
2026 2034 auto_rewrite = False
2027 2035 else:
2028 2036 if theRest.startswith('['):
2029 2037 if hasattr(obj,'__getitem__'):
2030 2038 # Don't autocall in this case: item access for an object
2031 2039 # which is BOTH callable and implements __getitem__.
2032 2040 newcmd = '%s %s' % (iFun,theRest)
2033 2041 auto_rewrite = False
2034 2042 else:
2035 2043 # if the object doesn't support [] access, go ahead and
2036 2044 # autocall
2037 2045 newcmd = '%s(%s)' % (iFun.rstrip(),",".join(theRest.split()))
2038 2046 elif theRest.endswith(';'):
2039 2047 newcmd = '%s(%s);' % (iFun.rstrip(),theRest[:-1])
2040 2048 else:
2041 2049 newcmd = '%s(%s)' % (iFun.rstrip(),",".join(theRest.split()))
2042 2050
2043 2051 if auto_rewrite:
2044 2052 print >>Term.cout, self.outputcache.prompt1.auto_rewrite() + newcmd
2045 2053 # log what is now valid Python, not the actual user input (without the
2046 2054 # final newline)
2047 2055 self.log(newcmd,continue_prompt)
2048 2056 return newcmd
2049 2057
2050 2058 def handle_help(self, line, continue_prompt=None,
2051 2059 pre=None,iFun=None,theRest=None):
2052 2060 """Try to get some help for the object.
2053 2061
2054 2062 obj? or ?obj -> basic information.
2055 2063 obj?? or ??obj -> more details.
2056 2064 """
2057 2065
2058 2066 # We need to make sure that we don't process lines which would be
2059 2067 # otherwise valid python, such as "x=1 # what?"
2060 2068 try:
2061 2069 codeop.compile_command(line)
2062 2070 except SyntaxError:
2063 2071 # We should only handle as help stuff which is NOT valid syntax
2064 2072 if line[0]==self.ESC_HELP:
2065 2073 line = line[1:]
2066 2074 elif line[-1]==self.ESC_HELP:
2067 2075 line = line[:-1]
2068 2076 self.log('#?'+line)
2069 2077 if line:
2070 2078 self.magic_pinfo(line)
2071 2079 else:
2072 2080 page(self.usage,screen_lines=self.rc.screen_length)
2073 2081 return '' # Empty string is needed here!
2074 2082 except:
2075 2083 # Pass any other exceptions through to the normal handler
2076 2084 return self.handle_normal(line,continue_prompt)
2077 2085 else:
2078 2086 # If the code compiles ok, we should handle it normally
2079 2087 return self.handle_normal(line,continue_prompt)
2080 2088
2081 2089 def getapi(self):
2082 2090 """ Get an IPApi object for this shell instance
2083 2091
2084 2092 Getting an IPApi object is always preferable to accessing the shell
2085 2093 directly, but this holds true especially for extensions.
2086 2094
2087 2095 It should always be possible to implement an extension with IPApi
2088 2096 alone. If not, contact maintainer to request an addition.
2089 2097
2090 2098 """
2091 2099 return self.api
2092 2100
2093 2101 def handle_emacs(self,line,continue_prompt=None,
2094 2102 pre=None,iFun=None,theRest=None):
2095 2103 """Handle input lines marked by python-mode."""
2096 2104
2097 2105 # Currently, nothing is done. Later more functionality can be added
2098 2106 # here if needed.
2099 2107
2100 2108 # The input cache shouldn't be updated
2101 2109
2102 2110 return line
2103 2111
2104 2112 def mktempfile(self,data=None):
2105 2113 """Make a new tempfile and return its filename.
2106 2114
2107 2115 This makes a call to tempfile.mktemp, but it registers the created
2108 2116 filename internally so ipython cleans it up at exit time.
2109 2117
2110 2118 Optional inputs:
2111 2119
2112 2120 - data(None): if data is given, it gets written out to the temp file
2113 2121 immediately, and the file is closed again."""
2114 2122
2115 2123 filename = tempfile.mktemp('.py','ipython_edit_')
2116 2124 self.tempfiles.append(filename)
2117 2125
2118 2126 if data:
2119 2127 tmp_file = open(filename,'w')
2120 2128 tmp_file.write(data)
2121 2129 tmp_file.close()
2122 2130 return filename
2123 2131
2124 2132 def write(self,data):
2125 2133 """Write a string to the default output"""
2126 2134 Term.cout.write(data)
2127 2135
2128 2136 def write_err(self,data):
2129 2137 """Write a string to the default error output"""
2130 2138 Term.cerr.write(data)
2131 2139
2132 2140 def exit(self):
2133 2141 """Handle interactive exit.
2134 2142
2135 2143 This method sets the exit_now attribute."""
2136 2144
2137 2145 if self.rc.confirm_exit:
2138 2146 if ask_yes_no('Do you really want to exit ([y]/n)?','y'):
2139 2147 self.exit_now = True
2140 2148 else:
2141 2149 self.exit_now = True
2142 2150 return self.exit_now
2143 2151
2144 2152 def safe_execfile(self,fname,*where,**kw):
2145 2153 fname = os.path.expanduser(fname)
2146 2154
2147 2155 # find things also in current directory
2148 2156 dname = os.path.dirname(fname)
2149 2157 if not sys.path.count(dname):
2150 2158 sys.path.append(dname)
2151 2159
2152 2160 try:
2153 2161 xfile = open(fname)
2154 2162 except:
2155 2163 print >> Term.cerr, \
2156 2164 'Could not open file <%s> for safe execution.' % fname
2157 2165 return None
2158 2166
2159 2167 kw.setdefault('islog',0)
2160 2168 kw.setdefault('quiet',1)
2161 2169 kw.setdefault('exit_ignore',0)
2162 2170 first = xfile.readline()
2163 2171 loghead = str(self.loghead_tpl).split('\n',1)[0].strip()
2164 2172 xfile.close()
2165 2173 # line by line execution
2166 2174 if first.startswith(loghead) or kw['islog']:
2167 2175 print 'Loading log file <%s> one line at a time...' % fname
2168 2176 if kw['quiet']:
2169 2177 stdout_save = sys.stdout
2170 2178 sys.stdout = StringIO.StringIO()
2171 2179 try:
2172 2180 globs,locs = where[0:2]
2173 2181 except:
2174 2182 try:
2175 2183 globs = locs = where[0]
2176 2184 except:
2177 2185 globs = locs = globals()
2178 2186 badblocks = []
2179 2187
2180 2188 # we also need to identify indented blocks of code when replaying
2181 2189 # logs and put them together before passing them to an exec
2182 2190 # statement. This takes a bit of regexp and look-ahead work in the
2183 2191 # file. It's easiest if we swallow the whole thing in memory
2184 2192 # first, and manually walk through the lines list moving the
2185 2193 # counter ourselves.
2186 2194 indent_re = re.compile('\s+\S')
2187 2195 xfile = open(fname)
2188 2196 filelines = xfile.readlines()
2189 2197 xfile.close()
2190 2198 nlines = len(filelines)
2191 2199 lnum = 0
2192 2200 while lnum < nlines:
2193 2201 line = filelines[lnum]
2194 2202 lnum += 1
2195 2203 # don't re-insert logger status info into cache
2196 2204 if line.startswith('#log#'):
2197 2205 continue
2198 2206 else:
2199 2207 # build a block of code (maybe a single line) for execution
2200 2208 block = line
2201 2209 try:
2202 2210 next = filelines[lnum] # lnum has already incremented
2203 2211 except:
2204 2212 next = None
2205 2213 while next and indent_re.match(next):
2206 2214 block += next
2207 2215 lnum += 1
2208 2216 try:
2209 2217 next = filelines[lnum]
2210 2218 except:
2211 2219 next = None
2212 2220 # now execute the block of one or more lines
2213 2221 try:
2214 2222 exec block in globs,locs
2215 2223 except SystemExit:
2216 2224 pass
2217 2225 except:
2218 2226 badblocks.append(block.rstrip())
2219 2227 if kw['quiet']: # restore stdout
2220 2228 sys.stdout.close()
2221 2229 sys.stdout = stdout_save
2222 2230 print 'Finished replaying log file <%s>' % fname
2223 2231 if badblocks:
2224 2232 print >> sys.stderr, ('\nThe following lines/blocks in file '
2225 2233 '<%s> reported errors:' % fname)
2226 2234
2227 2235 for badline in badblocks:
2228 2236 print >> sys.stderr, badline
2229 2237 else: # regular file execution
2230 2238 try:
2231 2239 execfile(fname,*where)
2232 2240 except SyntaxError:
2233 2241 etype,evalue = sys.exc_info()[:2]
2234 2242 self.SyntaxTB(etype,evalue,[])
2235 2243 warn('Failure executing file: <%s>' % fname)
2236 2244 except SystemExit,status:
2237 2245 if not kw['exit_ignore']:
2238 2246 self.InteractiveTB()
2239 2247 warn('Failure executing file: <%s>' % fname)
2240 2248 except:
2241 2249 self.InteractiveTB()
2242 2250 warn('Failure executing file: <%s>' % fname)
2243 2251
2244 2252 #************************* end of file <iplib.py> *****************************
@@ -1,729 +1,727 b''
1 1 # -*- coding: utf-8 -*-
2 2 """
3 3 IPython -- An enhanced Interactive Python
4 4
5 5 Requires Python 2.1 or better.
6 6
7 7 This file contains the main make_IPython() starter function.
8 8
9 $Id: ipmaker.py 1092 2006-01-27 23:56:32Z vivainio $"""
9 $Id: ipmaker.py 1111 2006-01-30 21:16:07Z vivainio $"""
10 10
11 11 #*****************************************************************************
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
18 18 from IPython import Release
19 19 __author__ = '%s <%s>' % Release.authors['Fernando']
20 20 __license__ = Release.license
21 21 __version__ = Release.version
22 22
23 23 credits._Printer__data = """
24 24 Python: %s
25 25
26 26 IPython: Fernando Perez, Janko Hauser, Nathan Gray, and many users.
27 27 See http://ipython.scipy.org for more information.""" \
28 28 % credits._Printer__data
29 29
30 30 copyright._Printer__data += """
31 31
32 32 Copyright (c) 2001-2004 Fernando Perez, Janko Hauser, Nathan Gray.
33 33 All Rights Reserved."""
34 34
35 35 #****************************************************************************
36 36 # Required modules
37 37
38 38 # From the standard library
39 39 import __main__
40 40 import __builtin__
41 41 import os
42 42 import re
43 43 import sys
44 44 import types
45 45 from pprint import pprint,pformat
46 46
47 47 # Our own
48 48 from IPython import DPyGetOpt
49 49 from IPython.ipstruct import Struct
50 50 from IPython.OutputTrap import OutputTrap
51 51 from IPython.ConfigLoader import ConfigLoader
52 52 from IPython.iplib import InteractiveShell
53 53 from IPython.usage import cmd_line_usage,interactive_usage
54 54 from IPython.genutils import *
55 55
56 56 #-----------------------------------------------------------------------------
57 57 def make_IPython(argv=None,user_ns=None,user_global_ns=None,debug=1,
58 58 rc_override=None,shell_class=InteractiveShell,
59 59 embedded=False,**kw):
60 60 """This is a dump of IPython into a single function.
61 61
62 62 Later it will have to be broken up in a sensible manner.
63 63
64 64 Arguments:
65 65
66 66 - argv: a list similar to sys.argv[1:]. It should NOT contain the desired
67 67 script name, b/c DPyGetOpt strips the first argument only for the real
68 68 sys.argv.
69 69
70 70 - user_ns: a dict to be used as the user's namespace."""
71 71
72 72 #----------------------------------------------------------------------
73 73 # Defaults and initialization
74 74
75 75 # For developer debugging, deactivates crash handler and uses pdb.
76 76 DEVDEBUG = False
77 77
78 78 if argv is None:
79 79 argv = sys.argv
80 80
81 81 # __IP is the main global that lives throughout and represents the whole
82 82 # application. If the user redefines it, all bets are off as to what
83 83 # happens.
84 84
85 85 # __IP is the name of he global which the caller will have accessible as
86 86 # __IP.name. We set its name via the first parameter passed to
87 87 # InteractiveShell:
88 88
89 89 IP = shell_class('__IP',user_ns=user_ns,user_global_ns=user_global_ns,
90 90 embedded=embedded,**kw)
91 91
92 92 # Put 'help' in the user namespace
93 93 from site import _Helper
94 94 IP.user_ns['help'] = _Helper()
95 95
96 96
97 97 if DEVDEBUG:
98 98 # For developer debugging only (global flag)
99 99 from IPython import ultraTB
100 100 sys.excepthook = ultraTB.VerboseTB(call_pdb=1)
101 101
102 102 IP.BANNER_PARTS = ['Python %s\n'
103 103 'Type "copyright", "credits" or "license" '
104 104 'for more information.\n'
105 105 % (sys.version.split('\n')[0],),
106 106 "IPython %s -- An enhanced Interactive Python."
107 107 % (__version__,),
108 108 """? -> Introduction to IPython's features.
109 109 %magic -> Information about IPython's 'magic' % functions.
110 110 help -> Python's own help system.
111 111 object? -> Details about 'object'. ?object also works, ?? prints more.
112 112 """ ]
113 113
114 114 IP.usage = interactive_usage
115 115
116 116 # Platform-dependent suffix and directory names. We use _ipython instead
117 117 # of .ipython under win32 b/c there's software that breaks with .named
118 118 # directories on that platform.
119 119 if os.name == 'posix':
120 120 rc_suffix = ''
121 121 ipdir_def = '.ipython'
122 122 else:
123 123 rc_suffix = '.ini'
124 124 ipdir_def = '_ipython'
125 125
126 126 # default directory for configuration
127 127 ipythondir = os.path.abspath(os.environ.get('IPYTHONDIR',
128 128 os.path.join(IP.home_dir,ipdir_def)))
129 129
130 130 # we need the directory where IPython itself is installed
131 131 import IPython
132 132 IPython_dir = os.path.dirname(IPython.__file__)
133 133 del IPython
134 134
135 135 #-------------------------------------------------------------------------
136 136 # Command line handling
137 137
138 138 # Valid command line options (uses DPyGetOpt syntax, like Perl's
139 139 # GetOpt::Long)
140 140
141 141 # Any key not listed here gets deleted even if in the file (like session
142 142 # or profile). That's deliberate, to maintain the rc namespace clean.
143 143
144 144 # Each set of options appears twice: under _conv only the names are
145 145 # listed, indicating which type they must be converted to when reading the
146 146 # ipythonrc file. And under DPyGetOpt they are listed with the regular
147 147 # DPyGetOpt syntax (=s,=i,:f,etc).
148 148
149 149 # Make sure there's a space before each end of line (they get auto-joined!)
150 150 cmdline_opts = ('autocall=i autoindent! automagic! banner! cache_size|cs=i '
151 151 'c=s classic|cl color_info! colors=s confirm_exit! '
152 152 'debug! deep_reload! editor=s log|l messages! nosep pdb! '
153 153 'pprint! prompt_in1|pi1=s prompt_in2|pi2=s prompt_out|po=s '
154 154 'quick screen_length|sl=i prompts_pad_left=i '
155 155 'logfile|lf=s logplay|lp=s profile|p=s '
156 156 'readline! readline_merge_completions! '
157 157 'readline_omit__names! '
158 158 'rcfile=s separate_in|si=s separate_out|so=s '
159 159 'separate_out2|so2=s xmode=s wildcards_case_sensitive! '
160 160 'magic_docstrings system_verbose! '
161 161 'multi_line_specials! '
162 162 'wxversion=s '
163 163 'autoedit_syntax!')
164 164
165 165 # Options that can *only* appear at the cmd line (not in rcfiles).
166 166
167 167 # The "ignore" option is a kludge so that Emacs buffers don't crash, since
168 168 # the 'C-c !' command in emacs automatically appends a -i option at the end.
169 169 cmdline_only = ('help ignore|i ipythondir=s Version upgrade '
170 170 'gthread! qthread! wthread! pylab! tk!')
171 171
172 172 # Build the actual name list to be used by DPyGetOpt
173 173 opts_names = qw(cmdline_opts) + qw(cmdline_only)
174 174
175 175 # Set sensible command line defaults.
176 176 # This should have everything from cmdline_opts and cmdline_only
177 177 opts_def = Struct(autocall = 1,
178 178 autoedit_syntax = 1,
179 179 autoindent=0,
180 180 automagic = 1,
181 181 banner = 1,
182 182 cache_size = 1000,
183 183 c = '',
184 184 classic = 0,
185 185 colors = 'NoColor',
186 186 color_info = 0,
187 187 confirm_exit = 1,
188 188 debug = 0,
189 189 deep_reload = 0,
190 190 editor = '0',
191 191 help = 0,
192 192 ignore = 0,
193 193 ipythondir = ipythondir,
194 194 log = 0,
195 195 logfile = '',
196 196 logplay = '',
197 197 multi_line_specials = 1,
198 198 messages = 1,
199 199 nosep = 0,
200 200 pdb = 0,
201 201 pprint = 0,
202 202 profile = '',
203 203 prompt_in1 = 'In [\\#]: ',
204 204 prompt_in2 = ' .\\D.: ',
205 205 prompt_out = 'Out[\\#]: ',
206 206 prompts_pad_left = 1,
207 207 quick = 0,
208 208 readline = 1,
209 209 readline_merge_completions = 1,
210 210 readline_omit__names = 0,
211 211 rcfile = 'ipythonrc' + rc_suffix,
212 212 screen_length = 0,
213 213 separate_in = '\n',
214 214 separate_out = '\n',
215 215 separate_out2 = '',
216 216 system_verbose = 0,
217 217 gthread = 0,
218 218 qthread = 0,
219 219 wthread = 0,
220 220 pylab = 0,
221 221 tk = 0,
222 222 upgrade = 0,
223 223 Version = 0,
224 224 xmode = 'Verbose',
225 225 wildcards_case_sensitive = 1,
226 226 wxversion = '0',
227 227 magic_docstrings = 0, # undocumented, for doc generation
228 228 )
229 229
230 230 # Things that will *only* appear in rcfiles (not at the command line).
231 231 # Make sure there's a space before each end of line (they get auto-joined!)
232 232 rcfile_opts = { qwflat: 'include import_mod import_all execfile ',
233 233 qw_lol: 'import_some ',
234 234 # for things with embedded whitespace:
235 235 list_strings:'execute alias readline_parse_and_bind ',
236 236 # Regular strings need no conversion:
237 237 None:'readline_remove_delims ',
238 238 }
239 239 # Default values for these
240 240 rc_def = Struct(include = [],
241 241 import_mod = [],
242 242 import_all = [],
243 243 import_some = [[]],
244 244 execute = [],
245 245 execfile = [],
246 246 alias = [],
247 247 readline_parse_and_bind = [],
248 248 readline_remove_delims = '',
249 249 )
250 250
251 251 # Build the type conversion dictionary from the above tables:
252 252 typeconv = rcfile_opts.copy()
253 253 typeconv.update(optstr2types(cmdline_opts))
254 254
255 255 # FIXME: the None key appears in both, put that back together by hand. Ugly!
256 256 typeconv[None] += ' ' + rcfile_opts[None]
257 257
258 258 # Remove quotes at ends of all strings (used to protect spaces)
259 259 typeconv[unquote_ends] = typeconv[None]
260 260 del typeconv[None]
261 261
262 262 # Build the list we'll use to make all config decisions with defaults:
263 263 opts_all = opts_def.copy()
264 264 opts_all.update(rc_def)
265 265
266 266 # Build conflict resolver for recursive loading of config files:
267 267 # - preserve means the outermost file maintains the value, it is not
268 268 # overwritten if an included file has the same key.
269 269 # - add_flip applies + to the two values, so it better make sense to add
270 270 # those types of keys. But it flips them first so that things loaded
271 271 # deeper in the inclusion chain have lower precedence.
272 272 conflict = {'preserve': ' '.join([ typeconv[int],
273 273 typeconv[unquote_ends] ]),
274 274 'add_flip': ' '.join([ typeconv[qwflat],
275 275 typeconv[qw_lol],
276 276 typeconv[list_strings] ])
277 277 }
278 278
279 279 # Now actually process the command line
280 280 getopt = DPyGetOpt.DPyGetOpt()
281 281 getopt.setIgnoreCase(0)
282 282
283 283 getopt.parseConfiguration(opts_names)
284 284
285 285 try:
286 286 getopt.processArguments(argv)
287 287 except:
288 288 print cmd_line_usage
289 289 warn('\nError in Arguments: ' + `sys.exc_value`)
290 290 sys.exit(1)
291 291
292 292 # convert the options dict to a struct for much lighter syntax later
293 293 opts = Struct(getopt.optionValues)
294 294 args = getopt.freeValues
295 295
296 296 # this is the struct (which has default values at this point) with which
297 297 # we make all decisions:
298 298 opts_all.update(opts)
299 299
300 300 # Options that force an immediate exit
301 301 if opts_all.help:
302 302 page(cmd_line_usage)
303 303 sys.exit()
304 304
305 305 if opts_all.Version:
306 306 print __version__
307 307 sys.exit()
308 308
309 309 if opts_all.magic_docstrings:
310 310 IP.magic_magic('-latex')
311 311 sys.exit()
312 312
313 313 # Create user config directory if it doesn't exist. This must be done
314 314 # *after* getting the cmd line options.
315 315 if not os.path.isdir(opts_all.ipythondir):
316 316 IP.user_setup(opts_all.ipythondir,rc_suffix,'install')
317 317
318 318 # upgrade user config files while preserving a copy of the originals
319 319 if opts_all.upgrade:
320 320 IP.user_setup(opts_all.ipythondir,rc_suffix,'upgrade')
321 321
322 322 # check mutually exclusive options in the *original* command line
323 323 mutex_opts(opts,[qw('log logfile'),qw('rcfile profile'),
324 324 qw('classic profile'),qw('classic rcfile')])
325 325
326 326 #---------------------------------------------------------------------------
327 327 # Log replay
328 328
329 329 # if -logplay, we need to 'become' the other session. That basically means
330 330 # replacing the current command line environment with that of the old
331 331 # session and moving on.
332 332
333 333 # this is needed so that later we know we're in session reload mode, as
334 334 # opts_all will get overwritten:
335 335 load_logplay = 0
336 336
337 337 if opts_all.logplay:
338 338 load_logplay = opts_all.logplay
339 339 opts_debug_save = opts_all.debug
340 340 try:
341 341 logplay = open(opts_all.logplay)
342 342 except IOError:
343 343 if opts_all.debug: IP.InteractiveTB()
344 344 warn('Could not open logplay file '+`opts_all.logplay`)
345 345 # restore state as if nothing had happened and move on, but make
346 346 # sure that later we don't try to actually load the session file
347 347 logplay = None
348 348 load_logplay = 0
349 349 del opts_all.logplay
350 350 else:
351 351 try:
352 352 logplay.readline()
353 353 logplay.readline();
354 354 # this reloads that session's command line
355 355 cmd = logplay.readline()[6:]
356 356 exec cmd
357 357 # restore the true debug flag given so that the process of
358 358 # session loading itself can be monitored.
359 359 opts.debug = opts_debug_save
360 360 # save the logplay flag so later we don't overwrite the log
361 361 opts.logplay = load_logplay
362 362 # now we must update our own structure with defaults
363 363 opts_all.update(opts)
364 364 # now load args
365 365 cmd = logplay.readline()[6:]
366 366 exec cmd
367 367 logplay.close()
368 368 except:
369 369 logplay.close()
370 370 if opts_all.debug: IP.InteractiveTB()
371 371 warn("Logplay file lacking full configuration information.\n"
372 372 "I'll try to read it, but some things may not work.")
373 373
374 374 #-------------------------------------------------------------------------
375 375 # set up output traps: catch all output from files, being run, modules
376 376 # loaded, etc. Then give it to the user in a clean form at the end.
377 377
378 378 msg_out = 'Output messages. '
379 379 msg_err = 'Error messages. '
380 380 msg_sep = '\n'
381 381 msg = Struct(config = OutputTrap('Configuration Loader',msg_out,
382 382 msg_err,msg_sep,debug,
383 383 quiet_out=1),
384 384 user_exec = OutputTrap('User File Execution',msg_out,
385 385 msg_err,msg_sep,debug),
386 386 logplay = OutputTrap('Log Loader',msg_out,
387 387 msg_err,msg_sep,debug),
388 388 summary = ''
389 389 )
390 390
391 391 #-------------------------------------------------------------------------
392 392 # Process user ipythonrc-type configuration files
393 393
394 394 # turn on output trapping and log to msg.config
395 395 # remember that with debug on, trapping is actually disabled
396 396 msg.config.trap_all()
397 397
398 398 # look for rcfile in current or default directory
399 399 try:
400 400 opts_all.rcfile = filefind(opts_all.rcfile,opts_all.ipythondir)
401 401 except IOError:
402 402 if opts_all.debug: IP.InteractiveTB()
403 403 warn('Configuration file %s not found. Ignoring request.'
404 404 % (opts_all.rcfile) )
405 405
406 406 # 'profiles' are a shorthand notation for config filenames
407 407 if opts_all.profile:
408 408
409 409 try:
410 410 opts_all.rcfile = filefind('ipythonrc-' + opts_all.profile
411 411 + rc_suffix,
412 412 opts_all.ipythondir)
413 413 except IOError:
414 414 if opts_all.debug: IP.InteractiveTB()
415 415 opts.profile = '' # remove profile from options if invalid
416 416 warn('Profile configuration file %s not found. Ignoring request.'
417 417 % (opts_all.profile) )
418 418
419 419
420 420 # load the config file
421 421 rcfiledata = None
422 422 if opts_all.quick:
423 423 print 'Launching IPython in quick mode. No config file read.'
424 424 elif opts_all.classic:
425 425 print 'Launching IPython in classic mode. No config file read.'
426 426 elif opts_all.rcfile:
427 427 try:
428 428 cfg_loader = ConfigLoader(conflict)
429 429 rcfiledata = cfg_loader.load(opts_all.rcfile,typeconv,
430 430 'include',opts_all.ipythondir,
431 431 purge = 1,
432 432 unique = conflict['preserve'])
433 433 except:
434 434 IP.InteractiveTB()
435 435 warn('Problems loading configuration file '+
436 436 `opts_all.rcfile`+
437 437 '\nStarting with default -bare bones- configuration.')
438 438 else:
439 439 warn('No valid configuration file found in either currrent directory\n'+
440 440 'or in the IPython config. directory: '+`opts_all.ipythondir`+
441 441 '\nProceeding with internal defaults.')
442 442
443 443 #------------------------------------------------------------------------
444 444 # Set exception handlers in mode requested by user.
445 445 otrap = OutputTrap(trap_out=1) # trap messages from magic_xmode
446 446 IP.magic_xmode(opts_all.xmode)
447 447 otrap.release_out()
448 448
449 449 #------------------------------------------------------------------------
450 450 # Execute user config
451 451
452 452 # Create a valid config structure with the right precedence order:
453 453 # defaults < rcfile < command line. This needs to be in the instance, so
454 454 # that method calls below that rely on it find it.
455 455 IP.rc = rc_def.copy()
456 456
457 457 # Work with a local alias inside this routine to avoid unnecessary
458 458 # attribute lookups.
459 459 IP_rc = IP.rc
460 460
461 461 IP_rc.update(opts_def)
462 462 if rcfiledata:
463 463 # now we can update
464 464 IP_rc.update(rcfiledata)
465 465 IP_rc.update(opts)
466 466 IP_rc.update(rc_override)
467 467
468 468 # Store the original cmd line for reference:
469 469 IP_rc.opts = opts
470 470 IP_rc.args = args
471 471
472 472 # create a *runtime* Struct like rc for holding parameters which may be
473 473 # created and/or modified by runtime user extensions.
474 474 IP.runtime_rc = Struct()
475 475
476 476 # from this point on, all config should be handled through IP_rc,
477 477 # opts* shouldn't be used anymore.
478 478
479 479 # add personal .ipython dir to sys.path so that users can put things in
480 480 # there for customization
481 481 sys.path.append(IP_rc.ipythondir)
482 482
483 483 sys.path.insert(0, '') # add . to sys.path. Fix from Prabhu Ramachandran
484 484
485 485 # update IP_rc with some special things that need manual
486 486 # tweaks. Basically options which affect other options. I guess this
487 487 # should just be written so that options are fully orthogonal and we
488 488 # wouldn't worry about this stuff!
489 489
490 490 if IP_rc.classic:
491 491 IP_rc.quick = 1
492 492 IP_rc.cache_size = 0
493 493 IP_rc.pprint = 0
494 494 IP_rc.prompt_in1 = '>>> '
495 495 IP_rc.prompt_in2 = '... '
496 496 IP_rc.prompt_out = ''
497 497 IP_rc.separate_in = IP_rc.separate_out = IP_rc.separate_out2 = '0'
498 498 IP_rc.colors = 'NoColor'
499 499 IP_rc.xmode = 'Plain'
500 500
501 501 # configure readline
502 502 # Define the history file for saving commands in between sessions
503 503 if IP_rc.profile:
504 504 histfname = 'history-%s' % IP_rc.profile
505 505 else:
506 506 histfname = 'history'
507 507 IP.histfile = os.path.join(opts_all.ipythondir,histfname)
508 508
509 509 # update exception handlers with rc file status
510 510 otrap.trap_out() # I don't want these messages ever.
511 511 IP.magic_xmode(IP_rc.xmode)
512 512 otrap.release_out()
513 513
514 514 # activate logging if requested and not reloading a log
515 515 if IP_rc.logplay:
516 516 IP.magic_logstart(IP_rc.logplay + ' append')
517 517 elif IP_rc.logfile:
518 518 IP.magic_logstart(IP_rc.logfile)
519 519 elif IP_rc.log:
520 520 IP.magic_logstart()
521 521
522 522 # find user editor so that it we don't have to look it up constantly
523 523 if IP_rc.editor.strip()=='0':
524 524 try:
525 525 ed = os.environ['EDITOR']
526 526 except KeyError:
527 527 if os.name == 'posix':
528 528 ed = 'vi' # the only one guaranteed to be there!
529 529 else:
530 530 ed = 'notepad' # same in Windows!
531 531 IP_rc.editor = ed
532 532
533 533 # Keep track of whether this is an embedded instance or not (useful for
534 534 # post-mortems).
535 535 IP_rc.embedded = IP.embedded
536 536
537 537 # Recursive reload
538 538 try:
539 539 from IPython import deep_reload
540 540 if IP_rc.deep_reload:
541 541 __builtin__.reload = deep_reload.reload
542 542 else:
543 543 __builtin__.dreload = deep_reload.reload
544 544 del deep_reload
545 545 except ImportError:
546 546 pass
547 547
548 548 # Save the current state of our namespace so that the interactive shell
549 549 # can later know which variables have been created by us from config files
550 550 # and loading. This way, loading a file (in any way) is treated just like
551 551 # defining things on the command line, and %who works as expected.
552 552
553 553 # DON'T do anything that affects the namespace beyond this point!
554 554 IP.internal_ns.update(__main__.__dict__)
555 555
556 556 #IP.internal_ns.update(locals()) # so our stuff doesn't show up in %who
557 557
558 558 # Now run through the different sections of the users's config
559 559 if IP_rc.debug:
560 560 print 'Trying to execute the following configuration structure:'
561 561 print '(Things listed first are deeper in the inclusion tree and get'
562 562 print 'loaded first).\n'
563 563 pprint(IP_rc.__dict__)
564 564
565 # Make it easy to import extensions
566 sys.path.append(os.path.join(IPython_dir,"Extensions"))
567 565 for mod in IP_rc.import_mod:
568 566 try:
569 567 exec 'import '+mod in IP.user_ns
570 568 except :
571 569 IP.InteractiveTB()
572 570 import_fail_info(mod)
573 571
574 572 for mod_fn in IP_rc.import_some:
575 573 if mod_fn == []: break
576 574 mod,fn = mod_fn[0],','.join(mod_fn[1:])
577 575 try:
578 576 exec 'from '+mod+' import '+fn in IP.user_ns
579 577 except :
580 578 IP.InteractiveTB()
581 579 import_fail_info(mod,fn)
582 580
583 581 for mod in IP_rc.import_all:
584 582 try:
585 583 exec 'from '+mod+' import *' in IP.user_ns
586 584 except :
587 585 IP.InteractiveTB()
588 586 import_fail_info(mod)
589 587
590 588 for code in IP_rc.execute:
591 589 try:
592 590 exec code in IP.user_ns
593 591 except:
594 592 IP.InteractiveTB()
595 593 warn('Failure executing code: ' + `code`)
596 594
597 595 # Execute the files the user wants in ipythonrc
598 596 for file in IP_rc.execfile:
599 597 try:
600 598 file = filefind(file,sys.path+[IPython_dir])
601 599 except IOError:
602 600 warn(itpl('File $file not found. Skipping it.'))
603 601 else:
604 602 IP.safe_execfile(os.path.expanduser(file),IP.user_ns)
605 603
606 604 # finally, try importing ipy_*_conf for final configuration
607 605 try:
608 606 import ipy_system_conf
609 607 except ImportError:
610 608 warn("Could not import 'ipy_system_conf'")
611 609 pass
612 610 if opts_all.profile:
613 611 profmodname = 'ipy_profile_' + opts_all.profile
614 612 try:
615 613 __import__(profmodname)
616 614 except ImportError:
617 615 warn("Could not import '%s'" % profmodname)
618 616 try:
619 617 import ipy_user_conf
620 618 except ImportError:
621 619 warn('Could not import ipy_user_conf')
622 620
623 621 # release stdout and stderr and save config log into a global summary
624 622 msg.config.release_all()
625 623 if IP_rc.messages:
626 624 msg.summary += msg.config.summary_all()
627 625
628 626 #------------------------------------------------------------------------
629 627 # Setup interactive session
630 628
631 629 # Now we should be fully configured. We can then execute files or load
632 630 # things only needed for interactive use. Then we'll open the shell.
633 631
634 632 # Take a snapshot of the user namespace before opening the shell. That way
635 633 # we'll be able to identify which things were interactively defined and
636 634 # which were defined through config files.
637 635 IP.user_config_ns = IP.user_ns.copy()
638 636
639 637 # Force reading a file as if it were a session log. Slower but safer.
640 638 if load_logplay:
641 639 print 'Replaying log...'
642 640 try:
643 641 if IP_rc.debug:
644 642 logplay_quiet = 0
645 643 else:
646 644 logplay_quiet = 1
647 645
648 646 msg.logplay.trap_all()
649 647 IP.safe_execfile(load_logplay,IP.user_ns,
650 648 islog = 1, quiet = logplay_quiet)
651 649 msg.logplay.release_all()
652 650 if IP_rc.messages:
653 651 msg.summary += msg.logplay.summary_all()
654 652 except:
655 653 warn('Problems replaying logfile %s.' % load_logplay)
656 654 IP.InteractiveTB()
657 655
658 656 # Load remaining files in command line
659 657 msg.user_exec.trap_all()
660 658
661 659 # Do NOT execute files named in the command line as scripts to be loaded
662 660 # by embedded instances. Doing so has the potential for an infinite
663 661 # recursion if there are exceptions thrown in the process.
664 662
665 663 # XXX FIXME: the execution of user files should be moved out to after
666 664 # ipython is fully initialized, just as if they were run via %run at the
667 665 # ipython prompt. This would also give them the benefit of ipython's
668 666 # nice tracebacks.
669 667
670 668 if not embedded and IP_rc.args:
671 669 name_save = IP.user_ns['__name__']
672 670 IP.user_ns['__name__'] = '__main__'
673 671 # Set our own excepthook in case the user code tries to call it
674 672 # directly. This prevents triggering the IPython crash handler.
675 673 old_excepthook,sys.excepthook = sys.excepthook, IP.excepthook
676 674
677 675 save_argv = sys.argv[:] # save it for later restoring
678 676
679 677 sys.argv = args
680 678
681 679 try:
682 680 IP.safe_execfile(args[0], IP.user_ns)
683 681 finally:
684 682 # Reset our crash handler in place
685 683 sys.excepthook = old_excepthook
686 684 sys.argv = save_argv
687 685 IP.user_ns['__name__'] = name_save
688 686
689 687 msg.user_exec.release_all()
690 688 if IP_rc.messages:
691 689 msg.summary += msg.user_exec.summary_all()
692 690
693 691 # since we can't specify a null string on the cmd line, 0 is the equivalent:
694 692 if IP_rc.nosep:
695 693 IP_rc.separate_in = IP_rc.separate_out = IP_rc.separate_out2 = '0'
696 694 if IP_rc.separate_in == '0': IP_rc.separate_in = ''
697 695 if IP_rc.separate_out == '0': IP_rc.separate_out = ''
698 696 if IP_rc.separate_out2 == '0': IP_rc.separate_out2 = ''
699 697 IP_rc.separate_in = IP_rc.separate_in.replace('\\n','\n')
700 698 IP_rc.separate_out = IP_rc.separate_out.replace('\\n','\n')
701 699 IP_rc.separate_out2 = IP_rc.separate_out2.replace('\\n','\n')
702 700
703 701 # Determine how many lines at the bottom of the screen are needed for
704 702 # showing prompts, so we can know wheter long strings are to be printed or
705 703 # paged:
706 704 num_lines_bot = IP_rc.separate_in.count('\n')+1
707 705 IP_rc.screen_length = IP_rc.screen_length - num_lines_bot
708 706
709 707 # configure startup banner
710 708 if IP_rc.c: # regular python doesn't print the banner with -c
711 709 IP_rc.banner = 0
712 710 if IP_rc.banner:
713 711 BANN_P = IP.BANNER_PARTS
714 712 else:
715 713 BANN_P = []
716 714
717 715 if IP_rc.profile: BANN_P.append('IPython profile: %s\n' % IP_rc.profile)
718 716
719 717 # add message log (possibly empty)
720 718 if msg.summary: BANN_P.append(msg.summary)
721 719 # Final banner is a string
722 720 IP.BANNER = '\n'.join(BANN_P)
723 721
724 722 # Finalize the IPython instance. This assumes the rc structure is fully
725 723 # in place.
726 724 IP.post_config_initialization()
727 725
728 726 return IP
729 727 #************************ end of file <ipmaker.py> **************************
1 NO CONTENT: modified file
The requested commit or file is too big and content was truncated. Show full diff
General Comments 0
You need to be logged in to leave comments. Login now