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