Show More
The requested changes are too big and content was truncated. Show full diff
@@ -1,311 +1,311 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """ |
|
2 | """ | |
3 | %jot magic for lightweight persistence. |
|
3 | %jot magic for lightweight persistence. | |
4 |
|
4 | |||
5 | Stores variables in Struct with some notes in PicleShare database |
|
5 | Stores variables in Struct with some notes in PicleShare database | |
6 |
|
6 | |||
7 |
|
7 | |||
8 | """ |
|
8 | """ | |
9 |
|
9 | |||
10 | from datetime import datetime |
|
10 | from datetime import datetime | |
11 | from IPython.core import ipapi |
|
11 | from IPython.core import ipapi | |
12 | ip = ipapi.get() |
|
12 | ip = ipapi.get() | |
13 |
|
13 | |||
14 | import pickleshare |
|
14 | import pickleshare | |
15 |
|
15 | |||
16 | import inspect,pickle,os,sys,textwrap |
|
16 | import inspect,pickle,os,sys,textwrap | |
17 | from IPython.core.fakemodule import FakeModule |
|
17 | from IPython.core.fakemodule import FakeModule | |
18 | from IPython.ipstruct import Struct |
|
18 | from IPython.utils.ipstruct import Struct | |
19 |
|
19 | |||
20 |
|
20 | |||
21 | def refresh_variables(ip, key=None): |
|
21 | def refresh_variables(ip, key=None): | |
22 | db = ip.db |
|
22 | db = ip.db | |
23 | if key is None: |
|
23 | if key is None: | |
24 | keys = db.keys('jot/*') |
|
24 | keys = db.keys('jot/*') | |
25 | else: |
|
25 | else: | |
26 | keys = db.keys('jot/'+key) |
|
26 | keys = db.keys('jot/'+key) | |
27 | for key in keys: |
|
27 | for key in keys: | |
28 | # strip autorestore |
|
28 | # strip autorestore | |
29 | justkey = os.path.basename(key) |
|
29 | justkey = os.path.basename(key) | |
30 | print "Restoring from", justkey, "..." |
|
30 | print "Restoring from", justkey, "..." | |
31 | try: |
|
31 | try: | |
32 | obj = db[key] |
|
32 | obj = db[key] | |
33 | except KeyError: |
|
33 | except KeyError: | |
34 | print "Unable to restore variable '%s', ignoring (use %%jot -d to forget!)" % justkey |
|
34 | print "Unable to restore variable '%s', ignoring (use %%jot -d to forget!)" % justkey | |
35 | print "The error was:",sys.exc_info()[0] |
|
35 | print "The error was:",sys.exc_info()[0] | |
36 | else: |
|
36 | else: | |
37 | #print "restored",justkey,"=",obj #dbg |
|
37 | #print "restored",justkey,"=",obj #dbg | |
38 | try: |
|
38 | try: | |
39 | origname = obj.name |
|
39 | origname = obj.name | |
40 | except: |
|
40 | except: | |
41 | ip.user_ns[justkey] = obj |
|
41 | ip.user_ns[justkey] = obj | |
42 | print "Restored", justkey |
|
42 | print "Restored", justkey | |
43 | else: |
|
43 | else: | |
44 | ip.user_ns[origname] = obj['val'] |
|
44 | ip.user_ns[origname] = obj['val'] | |
45 | print "Restored", origname |
|
45 | print "Restored", origname | |
46 |
|
46 | |||
47 | def read_variables(ip, key=None): |
|
47 | def read_variables(ip, key=None): | |
48 | db = ip.db |
|
48 | db = ip.db | |
49 | if key is None: |
|
49 | if key is None: | |
50 | return None |
|
50 | return None | |
51 | else: |
|
51 | else: | |
52 | keys = db.keys('jot/'+key) |
|
52 | keys = db.keys('jot/'+key) | |
53 | for key in keys: |
|
53 | for key in keys: | |
54 | # strip autorestore |
|
54 | # strip autorestore | |
55 | justkey = os.path.basename(key) |
|
55 | justkey = os.path.basename(key) | |
56 | print "restoring from ", justkey |
|
56 | print "restoring from ", justkey | |
57 | try: |
|
57 | try: | |
58 | obj = db[key] |
|
58 | obj = db[key] | |
59 | except KeyError: |
|
59 | except KeyError: | |
60 | print "Unable to read variable '%s', ignoring (use %%jot -d to forget!)" % justkey |
|
60 | print "Unable to read variable '%s', ignoring (use %%jot -d to forget!)" % justkey | |
61 | print "The error was:",sys.exc_info()[0] |
|
61 | print "The error was:",sys.exc_info()[0] | |
62 | else: |
|
62 | else: | |
63 | return obj |
|
63 | return obj | |
64 |
|
64 | |||
65 |
|
65 | |||
66 | def detail_variables(ip, key=None): |
|
66 | def detail_variables(ip, key=None): | |
67 | db, get = ip.db, ip.db.get |
|
67 | db, get = ip.db, ip.db.get | |
68 |
|
68 | |||
69 | if key is None: |
|
69 | if key is None: | |
70 | keys = db.keys('jot/*') |
|
70 | keys = db.keys('jot/*') | |
71 | else: |
|
71 | else: | |
72 | keys = db.keys('jot/'+key) |
|
72 | keys = db.keys('jot/'+key) | |
73 | if keys: |
|
73 | if keys: | |
74 | size = max(map(len,keys)) |
|
74 | size = max(map(len,keys)) | |
75 | else: |
|
75 | else: | |
76 | size = 0 |
|
76 | size = 0 | |
77 |
|
77 | |||
78 | fmthead = '%-'+str(size)+'s [%s]' |
|
78 | fmthead = '%-'+str(size)+'s [%s]' | |
79 | fmtbody = 'Comment:\n %s' |
|
79 | fmtbody = 'Comment:\n %s' | |
80 | fmtdata = 'Data:\n %s, %s' |
|
80 | fmtdata = 'Data:\n %s, %s' | |
81 | for key in keys: |
|
81 | for key in keys: | |
82 | v = get(key,'<unavailable>') |
|
82 | v = get(key,'<unavailable>') | |
83 | justkey = os.path.basename(key) |
|
83 | justkey = os.path.basename(key) | |
84 | try: |
|
84 | try: | |
85 | print fmthead % (justkey, datetime.ctime(v.get('time','<unavailable>'))) |
|
85 | print fmthead % (justkey, datetime.ctime(v.get('time','<unavailable>'))) | |
86 | print fmtbody % (v.get('comment','<unavailable>')) |
|
86 | print fmtbody % (v.get('comment','<unavailable>')) | |
87 | d = v.get('val','unavailable') |
|
87 | d = v.get('val','unavailable') | |
88 | print fmtdata % (repr(type(d)), '') |
|
88 | print fmtdata % (repr(type(d)), '') | |
89 | print repr(d)[0:200] |
|
89 | print repr(d)[0:200] | |
90 |
|
90 | |||
91 |
|
91 | |||
92 | except AttributeError: |
|
92 | except AttributeError: | |
93 | print fmt % (justkey, '<unavailable>', '<unavailable>', repr(v)[:50]) |
|
93 | print fmt % (justkey, '<unavailable>', '<unavailable>', repr(v)[:50]) | |
94 |
|
94 | |||
95 |
|
95 | |||
96 | def intm(n): |
|
96 | def intm(n): | |
97 | try: |
|
97 | try: | |
98 | return int(n) |
|
98 | return int(n) | |
99 | except: |
|
99 | except: | |
100 | return 0 |
|
100 | return 0 | |
101 |
|
101 | |||
102 | def jot_obj(self, obj, name, comment=''): |
|
102 | def jot_obj(self, obj, name, comment=''): | |
103 | """ |
|
103 | """ | |
104 | write obj data to the note database, with whatever that should be noted. |
|
104 | write obj data to the note database, with whatever that should be noted. | |
105 | """ |
|
105 | """ | |
106 | had = self.db.keys('jot/'+name+'*') |
|
106 | had = self.db.keys('jot/'+name+'*') | |
107 | # if it the same name but a later version, we stupidly add a number to the |
|
107 | # if it the same name but a later version, we stupidly add a number to the | |
108 | # so the name doesn't collide. Any better idea? |
|
108 | # so the name doesn't collide. Any better idea? | |
109 | suffix = '' |
|
109 | suffix = '' | |
110 | if len(had)>0: |
|
110 | if len(had)>0: | |
111 | pre = os.path.commonprefix(had) |
|
111 | pre = os.path.commonprefix(had) | |
112 | suf = [n.split(pre)[1] for n in had] |
|
112 | suf = [n.split(pre)[1] for n in had] | |
113 | versions = map(intm, suf) |
|
113 | versions = map(intm, suf) | |
114 | suffix = str(max(versions)+1) |
|
114 | suffix = str(max(versions)+1) | |
115 |
|
115 | |||
116 | uname = 'jot/'+name+suffix |
|
116 | uname = 'jot/'+name+suffix | |
117 |
|
117 | |||
118 | # which one works better? |
|
118 | # which one works better? | |
119 | #all = ip.IP.shadowhist.all() |
|
119 | #all = ip.IP.shadowhist.all() | |
120 | all = ip.IP.shell.input_hist |
|
120 | all = ip.IP.shell.input_hist | |
121 |
|
121 | |||
122 | # We may actually want to make snapshot of files that are run-ned. |
|
122 | # We may actually want to make snapshot of files that are run-ned. | |
123 |
|
123 | |||
124 | # get the comment |
|
124 | # get the comment | |
125 | try: |
|
125 | try: | |
126 | comment = ip.IP.magic_edit('-x').strip() |
|
126 | comment = ip.IP.magic_edit('-x').strip() | |
127 | except: |
|
127 | except: | |
128 | print "No comment is recorded." |
|
128 | print "No comment is recorded." | |
129 | comment = '' |
|
129 | comment = '' | |
130 |
|
130 | |||
131 | self.db[uname] = Struct({'val':obj, |
|
131 | self.db[uname] = Struct({'val':obj, | |
132 | 'time' : datetime.now(), |
|
132 | 'time' : datetime.now(), | |
133 | 'hist' : all, |
|
133 | 'hist' : all, | |
134 | 'name' : name, |
|
134 | 'name' : name, | |
135 | 'comment' : comment,}) |
|
135 | 'comment' : comment,}) | |
136 |
|
136 | |||
137 | print "Jotted down notes for '%s' (%s)" % (uname, obj.__class__.__name__) |
|
137 | print "Jotted down notes for '%s' (%s)" % (uname, obj.__class__.__name__) | |
138 |
|
138 | |||
139 |
|
139 | |||
140 |
|
140 | |||
141 | def magic_jot(self, parameter_s=''): |
|
141 | def magic_jot(self, parameter_s=''): | |
142 | """Lightweight persistence for python variables. |
|
142 | """Lightweight persistence for python variables. | |
143 |
|
143 | |||
144 | Example: |
|
144 | Example: | |
145 |
|
145 | |||
146 | ville@badger[~]|1> A = ['hello',10,'world']\\ |
|
146 | ville@badger[~]|1> A = ['hello',10,'world']\\ | |
147 | ville@badger[~]|2> %jot A\\ |
|
147 | ville@badger[~]|2> %jot A\\ | |
148 | ville@badger[~]|3> Exit |
|
148 | ville@badger[~]|3> Exit | |
149 |
|
149 | |||
150 | (IPython session is closed and started again...) |
|
150 | (IPython session is closed and started again...) | |
151 |
|
151 | |||
152 | ville@badger:~$ ipython -p pysh\\ |
|
152 | ville@badger:~$ ipython -p pysh\\ | |
153 | ville@badger[~]|1> print A |
|
153 | ville@badger[~]|1> print A | |
154 |
|
154 | |||
155 | ['hello', 10, 'world'] |
|
155 | ['hello', 10, 'world'] | |
156 |
|
156 | |||
157 | Usage: |
|
157 | Usage: | |
158 |
|
158 | |||
159 | %jot - Show list of all variables and their current values\\ |
|
159 | %jot - Show list of all variables and their current values\\ | |
160 | %jot -l - Show list of all variables and their current values in detail\\ |
|
160 | %jot -l - Show list of all variables and their current values in detail\\ | |
161 | %jot -l <var> - Show one variable and its current values in detail\\ |
|
161 | %jot -l <var> - Show one variable and its current values in detail\\ | |
162 | %jot <var> - Store the *current* value of the variable to disk\\ |
|
162 | %jot <var> - Store the *current* value of the variable to disk\\ | |
163 | %jot -d <var> - Remove the variable and its value from storage\\ |
|
163 | %jot -d <var> - Remove the variable and its value from storage\\ | |
164 | %jot -z - Remove all variables from storage (disabled)\\ |
|
164 | %jot -z - Remove all variables from storage (disabled)\\ | |
165 | %jot -r <var> - Refresh/Load variable from jot (delete current vals)\\ |
|
165 | %jot -r <var> - Refresh/Load variable from jot (delete current vals)\\ | |
166 | %jot foo >a.txt - Store value of foo to new file a.txt\\ |
|
166 | %jot foo >a.txt - Store value of foo to new file a.txt\\ | |
167 | %jot foo >>a.txt - Append value of foo to file a.txt\\ |
|
167 | %jot foo >>a.txt - Append value of foo to file a.txt\\ | |
168 |
|
168 | |||
169 | It should be noted that if you change the value of a variable, you |
|
169 | It should be noted that if you change the value of a variable, you | |
170 | need to %note it again if you want to persist the new value. |
|
170 | need to %note it again if you want to persist the new value. | |
171 |
|
171 | |||
172 | Note also that the variables will need to be pickleable; most basic |
|
172 | Note also that the variables will need to be pickleable; most basic | |
173 | python types can be safely %stored. |
|
173 | python types can be safely %stored. | |
174 |
|
174 | |||
175 | """ |
|
175 | """ | |
176 |
|
176 | |||
177 | opts,argsl = self.parse_options(parameter_s,'drzl',mode='string') |
|
177 | opts,argsl = self.parse_options(parameter_s,'drzl',mode='string') | |
178 | args = argsl.split(None,1) |
|
178 | args = argsl.split(None,1) | |
179 | ip = self.getapi() |
|
179 | ip = self.getapi() | |
180 | db = ip.db |
|
180 | db = ip.db | |
181 | # delete |
|
181 | # delete | |
182 | if opts.has_key('d'): |
|
182 | if opts.has_key('d'): | |
183 | try: |
|
183 | try: | |
184 | todel = args[0] |
|
184 | todel = args[0] | |
185 | except IndexError: |
|
185 | except IndexError: | |
186 | error('You must provide the variable to forget') |
|
186 | error('You must provide the variable to forget') | |
187 | else: |
|
187 | else: | |
188 | try: |
|
188 | try: | |
189 | del db['jot/' + todel] |
|
189 | del db['jot/' + todel] | |
190 | except: |
|
190 | except: | |
191 | error("Can't delete variable '%s'" % todel) |
|
191 | error("Can't delete variable '%s'" % todel) | |
192 | # reset the whole database |
|
192 | # reset the whole database | |
193 | elif opts.has_key('z'): |
|
193 | elif opts.has_key('z'): | |
194 | print "reseting the whole database has been disabled." |
|
194 | print "reseting the whole database has been disabled." | |
195 | #for k in db.keys('autorestore/*'): |
|
195 | #for k in db.keys('autorestore/*'): | |
196 | # del db[k] |
|
196 | # del db[k] | |
197 |
|
197 | |||
198 | elif opts.has_key('r'): |
|
198 | elif opts.has_key('r'): | |
199 | try: |
|
199 | try: | |
200 | toret = args[0] |
|
200 | toret = args[0] | |
201 | except: |
|
201 | except: | |
202 | print "restoring all the variables jotted down..." |
|
202 | print "restoring all the variables jotted down..." | |
203 | refresh_variables(ip) |
|
203 | refresh_variables(ip) | |
204 | else: |
|
204 | else: | |
205 | refresh_variables(ip, toret) |
|
205 | refresh_variables(ip, toret) | |
206 |
|
206 | |||
207 | elif opts.has_key('l'): |
|
207 | elif opts.has_key('l'): | |
208 | try: |
|
208 | try: | |
209 | tolist = args[0] |
|
209 | tolist = args[0] | |
210 | except: |
|
210 | except: | |
211 | print "List details for all the items." |
|
211 | print "List details for all the items." | |
212 | detail_variables(ip) |
|
212 | detail_variables(ip) | |
213 | else: |
|
213 | else: | |
214 | print "Details for", tolist, ":" |
|
214 | print "Details for", tolist, ":" | |
215 | detail_variables(ip, tolist) |
|
215 | detail_variables(ip, tolist) | |
216 |
|
216 | |||
217 | # run without arguments -> list noted variables & notes |
|
217 | # run without arguments -> list noted variables & notes | |
218 | elif not args: |
|
218 | elif not args: | |
219 | vars = self.db.keys('jot/*') |
|
219 | vars = self.db.keys('jot/*') | |
220 | vars.sort() |
|
220 | vars.sort() | |
221 | if vars: |
|
221 | if vars: | |
222 | size = max(map(len,vars)) - 4 |
|
222 | size = max(map(len,vars)) - 4 | |
223 | else: |
|
223 | else: | |
224 | size = 0 |
|
224 | size = 0 | |
225 |
|
225 | |||
226 | print 'Variables and their in-db values:' |
|
226 | print 'Variables and their in-db values:' | |
227 | fmt = '%-'+str(size)+'s [%s] -> %s' |
|
227 | fmt = '%-'+str(size)+'s [%s] -> %s' | |
228 | get = db.get |
|
228 | get = db.get | |
229 | for var in vars: |
|
229 | for var in vars: | |
230 | justkey = os.path.basename(var) |
|
230 | justkey = os.path.basename(var) | |
231 | v = get(var,'<unavailable>') |
|
231 | v = get(var,'<unavailable>') | |
232 | try: |
|
232 | try: | |
233 | print fmt % (justkey,\ |
|
233 | print fmt % (justkey,\ | |
234 | datetime.ctime(v.get('time','<unavailable>')),\ |
|
234 | datetime.ctime(v.get('time','<unavailable>')),\ | |
235 | v.get('comment','<unavailable>')[:70].replace('\n',' '),) |
|
235 | v.get('comment','<unavailable>')[:70].replace('\n',' '),) | |
236 | except AttributeError: |
|
236 | except AttributeError: | |
237 | print fmt % (justkey, '<unavailable>', '<unavailable>', repr(v)[:50]) |
|
237 | print fmt % (justkey, '<unavailable>', '<unavailable>', repr(v)[:50]) | |
238 |
|
238 | |||
239 |
|
239 | |||
240 | # default action - store the variable |
|
240 | # default action - store the variable | |
241 | else: |
|
241 | else: | |
242 | # %store foo >file.txt or >>file.txt |
|
242 | # %store foo >file.txt or >>file.txt | |
243 | if len(args) > 1 and args[1].startswith('>'): |
|
243 | if len(args) > 1 and args[1].startswith('>'): | |
244 | fnam = os.path.expanduser(args[1].lstrip('>').lstrip()) |
|
244 | fnam = os.path.expanduser(args[1].lstrip('>').lstrip()) | |
245 | if args[1].startswith('>>'): |
|
245 | if args[1].startswith('>>'): | |
246 | fil = open(fnam,'a') |
|
246 | fil = open(fnam,'a') | |
247 | else: |
|
247 | else: | |
248 | fil = open(fnam,'w') |
|
248 | fil = open(fnam,'w') | |
249 | obj = ip.ev(args[0]) |
|
249 | obj = ip.ev(args[0]) | |
250 | print "Writing '%s' (%s) to file '%s'." % (args[0], |
|
250 | print "Writing '%s' (%s) to file '%s'." % (args[0], | |
251 | obj.__class__.__name__, fnam) |
|
251 | obj.__class__.__name__, fnam) | |
252 |
|
252 | |||
253 |
|
253 | |||
254 | if not isinstance (obj,basestring): |
|
254 | if not isinstance (obj,basestring): | |
255 | from pprint import pprint |
|
255 | from pprint import pprint | |
256 | pprint(obj,fil) |
|
256 | pprint(obj,fil) | |
257 | else: |
|
257 | else: | |
258 | fil.write(obj) |
|
258 | fil.write(obj) | |
259 | if not obj.endswith('\n'): |
|
259 | if not obj.endswith('\n'): | |
260 | fil.write('\n') |
|
260 | fil.write('\n') | |
261 |
|
261 | |||
262 | fil.close() |
|
262 | fil.close() | |
263 | return |
|
263 | return | |
264 |
|
264 | |||
265 | # %note foo |
|
265 | # %note foo | |
266 | try: |
|
266 | try: | |
267 | obj = ip.user_ns[args[0]] |
|
267 | obj = ip.user_ns[args[0]] | |
268 | except KeyError: |
|
268 | except KeyError: | |
269 | # this should not be alias, for aliases, use %store |
|
269 | # this should not be alias, for aliases, use %store | |
270 |
|
270 | |||
271 | print "Error: %s doesn't exist." % args[0] |
|
271 | print "Error: %s doesn't exist." % args[0] | |
272 |
|
272 | |||
273 | print "Use %note -r <var> to retrieve variables. This should not be used " +\ |
|
273 | print "Use %note -r <var> to retrieve variables. This should not be used " +\ | |
274 | "to store alias, for saving aliases, use %store" |
|
274 | "to store alias, for saving aliases, use %store" | |
275 | return |
|
275 | return | |
276 | else: |
|
276 | else: | |
277 | if isinstance(inspect.getmodule(obj), FakeModule): |
|
277 | if isinstance(inspect.getmodule(obj), FakeModule): | |
278 | print textwrap.dedent("""\ |
|
278 | print textwrap.dedent("""\ | |
279 | Warning:%s is %s |
|
279 | Warning:%s is %s | |
280 | Proper storage of interactively declared classes (or instances |
|
280 | Proper storage of interactively declared classes (or instances | |
281 | of those classes) is not possible! Only instances |
|
281 | of those classes) is not possible! Only instances | |
282 | of classes in real modules on file system can be %%store'd. |
|
282 | of classes in real modules on file system can be %%store'd. | |
283 | """ % (args[0], obj) ) |
|
283 | """ % (args[0], obj) ) | |
284 | return |
|
284 | return | |
285 | #pickled = pickle.dumps(obj) |
|
285 | #pickled = pickle.dumps(obj) | |
286 | #self.db[ 'jot/' + args[0] ] = obj |
|
286 | #self.db[ 'jot/' + args[0] ] = obj | |
287 | jot_obj(self, obj, args[0]) |
|
287 | jot_obj(self, obj, args[0]) | |
288 |
|
288 | |||
289 |
|
289 | |||
290 | def magic_read(self, parameter_s=''): |
|
290 | def magic_read(self, parameter_s=''): | |
291 | """ |
|
291 | """ | |
292 | %read <var> - Load variable from data that is jotted down.\\ |
|
292 | %read <var> - Load variable from data that is jotted down.\\ | |
293 |
|
293 | |||
294 | """ |
|
294 | """ | |
295 |
|
295 | |||
296 | opts,argsl = self.parse_options(parameter_s,'drzl',mode='string') |
|
296 | opts,argsl = self.parse_options(parameter_s,'drzl',mode='string') | |
297 | args = argsl.split(None,1) |
|
297 | args = argsl.split(None,1) | |
298 | ip = self.getapi() |
|
298 | ip = self.getapi() | |
299 | db = ip.db |
|
299 | db = ip.db | |
300 | #if opts.has_key('r'): |
|
300 | #if opts.has_key('r'): | |
301 | try: |
|
301 | try: | |
302 | toret = args[0] |
|
302 | toret = args[0] | |
303 | except: |
|
303 | except: | |
304 | print "which record do you want to read out?" |
|
304 | print "which record do you want to read out?" | |
305 | return |
|
305 | return | |
306 | else: |
|
306 | else: | |
307 | return read_variables(ip, toret) |
|
307 | return read_variables(ip, toret) | |
308 |
|
308 | |||
309 |
|
309 | |||
310 | ip.expose_magic('jot',magic_jot) |
|
310 | ip.expose_magic('jot',magic_jot) | |
311 | ip.expose_magic('read',magic_read) |
|
311 | ip.expose_magic('read',magic_read) |
1 | NO CONTENT: modified file |
|
NO CONTENT: modified file | ||
The requested commit or file is too big and content was truncated. Show full diff |
@@ -1,627 +1,627 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """ |
|
2 | """ | |
3 | Classes for handling input/output prompts. |
|
3 | Classes for handling input/output prompts. | |
4 | """ |
|
4 | """ | |
5 |
|
5 | |||
6 | #***************************************************************************** |
|
6 | #***************************************************************************** | |
7 | # Copyright (C) 2008-2009 The IPython Development Team |
|
7 | # Copyright (C) 2008-2009 The IPython Development Team | |
8 | # Copyright (C) 2001-2007 Fernando Perez <fperez@colorado.edu> |
|
8 | # Copyright (C) 2001-2007 Fernando Perez <fperez@colorado.edu> | |
9 | # |
|
9 | # | |
10 | # Distributed under the terms of the BSD License. The full license is in |
|
10 | # Distributed under the terms of the BSD License. The full license is in | |
11 | # the file COPYING, distributed as part of this software. |
|
11 | # the file COPYING, distributed as part of this software. | |
12 | #***************************************************************************** |
|
12 | #***************************************************************************** | |
13 |
|
13 | |||
14 | #**************************************************************************** |
|
14 | #**************************************************************************** | |
15 | # Required modules |
|
15 | # Required modules | |
16 | import __builtin__ |
|
16 | import __builtin__ | |
17 | import os |
|
17 | import os | |
18 | import socket |
|
18 | import socket | |
19 | import sys |
|
19 | import sys | |
20 | import time |
|
20 | import time | |
21 |
|
21 | |||
22 | # IPython's own |
|
22 | # IPython's own | |
23 | from IPython.utils import coloransi |
|
23 | from IPython.utils import coloransi | |
24 | from IPython import Release |
|
24 | from IPython import Release | |
25 | from IPython.external.Itpl import ItplNS |
|
25 | from IPython.external.Itpl import ItplNS | |
26 | from IPython.core.ipapi import TryNext |
|
26 | from IPython.core.ipapi import TryNext | |
27 | from IPython.ipstruct import Struct |
|
27 | from IPython.utils.ipstruct import Struct | |
28 | from IPython.macro import Macro |
|
28 | from IPython.macro import Macro | |
29 | import IPython.utils.generics |
|
29 | import IPython.utils.generics | |
30 |
|
30 | |||
31 | from IPython.utils.genutils import * |
|
31 | from IPython.utils.genutils import * | |
32 |
|
32 | |||
33 | #**************************************************************************** |
|
33 | #**************************************************************************** | |
34 | #Color schemes for Prompts. |
|
34 | #Color schemes for Prompts. | |
35 |
|
35 | |||
36 | PromptColors = coloransi.ColorSchemeTable() |
|
36 | PromptColors = coloransi.ColorSchemeTable() | |
37 | InputColors = coloransi.InputTermColors # just a shorthand |
|
37 | InputColors = coloransi.InputTermColors # just a shorthand | |
38 | Colors = coloransi.TermColors # just a shorthand |
|
38 | Colors = coloransi.TermColors # just a shorthand | |
39 |
|
39 | |||
40 | PromptColors.add_scheme(coloransi.ColorScheme( |
|
40 | PromptColors.add_scheme(coloransi.ColorScheme( | |
41 | 'NoColor', |
|
41 | 'NoColor', | |
42 | in_prompt = InputColors.NoColor, # Input prompt |
|
42 | in_prompt = InputColors.NoColor, # Input prompt | |
43 | in_number = InputColors.NoColor, # Input prompt number |
|
43 | in_number = InputColors.NoColor, # Input prompt number | |
44 | in_prompt2 = InputColors.NoColor, # Continuation prompt |
|
44 | in_prompt2 = InputColors.NoColor, # Continuation prompt | |
45 | in_normal = InputColors.NoColor, # color off (usu. Colors.Normal) |
|
45 | in_normal = InputColors.NoColor, # color off (usu. Colors.Normal) | |
46 |
|
46 | |||
47 | out_prompt = Colors.NoColor, # Output prompt |
|
47 | out_prompt = Colors.NoColor, # Output prompt | |
48 | out_number = Colors.NoColor, # Output prompt number |
|
48 | out_number = Colors.NoColor, # Output prompt number | |
49 |
|
49 | |||
50 | normal = Colors.NoColor # color off (usu. Colors.Normal) |
|
50 | normal = Colors.NoColor # color off (usu. Colors.Normal) | |
51 | )) |
|
51 | )) | |
52 |
|
52 | |||
53 | # make some schemes as instances so we can copy them for modification easily: |
|
53 | # make some schemes as instances so we can copy them for modification easily: | |
54 | __PColLinux = coloransi.ColorScheme( |
|
54 | __PColLinux = coloransi.ColorScheme( | |
55 | 'Linux', |
|
55 | 'Linux', | |
56 | in_prompt = InputColors.Green, |
|
56 | in_prompt = InputColors.Green, | |
57 | in_number = InputColors.LightGreen, |
|
57 | in_number = InputColors.LightGreen, | |
58 | in_prompt2 = InputColors.Green, |
|
58 | in_prompt2 = InputColors.Green, | |
59 | in_normal = InputColors.Normal, # color off (usu. Colors.Normal) |
|
59 | in_normal = InputColors.Normal, # color off (usu. Colors.Normal) | |
60 |
|
60 | |||
61 | out_prompt = Colors.Red, |
|
61 | out_prompt = Colors.Red, | |
62 | out_number = Colors.LightRed, |
|
62 | out_number = Colors.LightRed, | |
63 |
|
63 | |||
64 | normal = Colors.Normal |
|
64 | normal = Colors.Normal | |
65 | ) |
|
65 | ) | |
66 | # Don't forget to enter it into the table! |
|
66 | # Don't forget to enter it into the table! | |
67 | PromptColors.add_scheme(__PColLinux) |
|
67 | PromptColors.add_scheme(__PColLinux) | |
68 |
|
68 | |||
69 | # Slightly modified Linux for light backgrounds |
|
69 | # Slightly modified Linux for light backgrounds | |
70 | __PColLightBG = __PColLinux.copy('LightBG') |
|
70 | __PColLightBG = __PColLinux.copy('LightBG') | |
71 |
|
71 | |||
72 | __PColLightBG.colors.update( |
|
72 | __PColLightBG.colors.update( | |
73 | in_prompt = InputColors.Blue, |
|
73 | in_prompt = InputColors.Blue, | |
74 | in_number = InputColors.LightBlue, |
|
74 | in_number = InputColors.LightBlue, | |
75 | in_prompt2 = InputColors.Blue |
|
75 | in_prompt2 = InputColors.Blue | |
76 | ) |
|
76 | ) | |
77 | PromptColors.add_scheme(__PColLightBG) |
|
77 | PromptColors.add_scheme(__PColLightBG) | |
78 |
|
78 | |||
79 | del Colors,InputColors |
|
79 | del Colors,InputColors | |
80 |
|
80 | |||
81 | #----------------------------------------------------------------------------- |
|
81 | #----------------------------------------------------------------------------- | |
82 | def multiple_replace(dict, text): |
|
82 | def multiple_replace(dict, text): | |
83 | """ Replace in 'text' all occurences of any key in the given |
|
83 | """ Replace in 'text' all occurences of any key in the given | |
84 | dictionary by its corresponding value. Returns the new string.""" |
|
84 | dictionary by its corresponding value. Returns the new string.""" | |
85 |
|
85 | |||
86 | # Function by Xavier Defrang, originally found at: |
|
86 | # Function by Xavier Defrang, originally found at: | |
87 | # http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/81330 |
|
87 | # http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/81330 | |
88 |
|
88 | |||
89 | # Create a regular expression from the dictionary keys |
|
89 | # Create a regular expression from the dictionary keys | |
90 | regex = re.compile("(%s)" % "|".join(map(re.escape, dict.keys()))) |
|
90 | regex = re.compile("(%s)" % "|".join(map(re.escape, dict.keys()))) | |
91 | # For each match, look-up corresponding value in dictionary |
|
91 | # For each match, look-up corresponding value in dictionary | |
92 | return regex.sub(lambda mo: dict[mo.string[mo.start():mo.end()]], text) |
|
92 | return regex.sub(lambda mo: dict[mo.string[mo.start():mo.end()]], text) | |
93 |
|
93 | |||
94 | #----------------------------------------------------------------------------- |
|
94 | #----------------------------------------------------------------------------- | |
95 | # Special characters that can be used in prompt templates, mainly bash-like |
|
95 | # Special characters that can be used in prompt templates, mainly bash-like | |
96 |
|
96 | |||
97 | # If $HOME isn't defined (Windows), make it an absurd string so that it can |
|
97 | # If $HOME isn't defined (Windows), make it an absurd string so that it can | |
98 | # never be expanded out into '~'. Basically anything which can never be a |
|
98 | # never be expanded out into '~'. Basically anything which can never be a | |
99 | # reasonable directory name will do, we just want the $HOME -> '~' operation |
|
99 | # reasonable directory name will do, we just want the $HOME -> '~' operation | |
100 | # to become a no-op. We pre-compute $HOME here so it's not done on every |
|
100 | # to become a no-op. We pre-compute $HOME here so it's not done on every | |
101 | # prompt call. |
|
101 | # prompt call. | |
102 |
|
102 | |||
103 | # FIXME: |
|
103 | # FIXME: | |
104 |
|
104 | |||
105 | # - This should be turned into a class which does proper namespace management, |
|
105 | # - This should be turned into a class which does proper namespace management, | |
106 | # since the prompt specials need to be evaluated in a certain namespace. |
|
106 | # since the prompt specials need to be evaluated in a certain namespace. | |
107 | # Currently it's just globals, which need to be managed manually by code |
|
107 | # Currently it's just globals, which need to be managed manually by code | |
108 | # below. |
|
108 | # below. | |
109 |
|
109 | |||
110 | # - I also need to split up the color schemes from the prompt specials |
|
110 | # - I also need to split up the color schemes from the prompt specials | |
111 | # somehow. I don't have a clean design for that quite yet. |
|
111 | # somehow. I don't have a clean design for that quite yet. | |
112 |
|
112 | |||
113 | HOME = os.environ.get("HOME","//////:::::ZZZZZ,,,~~~") |
|
113 | HOME = os.environ.get("HOME","//////:::::ZZZZZ,,,~~~") | |
114 |
|
114 | |||
115 | # We precompute a few more strings here for the prompt_specials, which are |
|
115 | # We precompute a few more strings here for the prompt_specials, which are | |
116 | # fixed once ipython starts. This reduces the runtime overhead of computing |
|
116 | # fixed once ipython starts. This reduces the runtime overhead of computing | |
117 | # prompt strings. |
|
117 | # prompt strings. | |
118 | USER = os.environ.get("USER") |
|
118 | USER = os.environ.get("USER") | |
119 | HOSTNAME = socket.gethostname() |
|
119 | HOSTNAME = socket.gethostname() | |
120 | HOSTNAME_SHORT = HOSTNAME.split(".")[0] |
|
120 | HOSTNAME_SHORT = HOSTNAME.split(".")[0] | |
121 | ROOT_SYMBOL = "$#"[os.name=='nt' or os.getuid()==0] |
|
121 | ROOT_SYMBOL = "$#"[os.name=='nt' or os.getuid()==0] | |
122 |
|
122 | |||
123 | prompt_specials_color = { |
|
123 | prompt_specials_color = { | |
124 | # Prompt/history count |
|
124 | # Prompt/history count | |
125 | '%n' : '${self.col_num}' '${self.cache.prompt_count}' '${self.col_p}', |
|
125 | '%n' : '${self.col_num}' '${self.cache.prompt_count}' '${self.col_p}', | |
126 | r'\#': '${self.col_num}' '${self.cache.prompt_count}' '${self.col_p}', |
|
126 | r'\#': '${self.col_num}' '${self.cache.prompt_count}' '${self.col_p}', | |
127 | # Just the prompt counter number, WITHOUT any coloring wrappers, so users |
|
127 | # Just the prompt counter number, WITHOUT any coloring wrappers, so users | |
128 | # can get numbers displayed in whatever color they want. |
|
128 | # can get numbers displayed in whatever color they want. | |
129 | r'\N': '${self.cache.prompt_count}', |
|
129 | r'\N': '${self.cache.prompt_count}', | |
130 |
|
130 | |||
131 | # Prompt/history count, with the actual digits replaced by dots. Used |
|
131 | # Prompt/history count, with the actual digits replaced by dots. Used | |
132 | # mainly in continuation prompts (prompt_in2) |
|
132 | # mainly in continuation prompts (prompt_in2) | |
133 | #r'\D': '${"."*len(str(self.cache.prompt_count))}', |
|
133 | #r'\D': '${"."*len(str(self.cache.prompt_count))}', | |
134 | # More robust form of the above expression, that uses __builtins__ |
|
134 | # More robust form of the above expression, that uses __builtins__ | |
135 | r'\D': '${"."*__builtins__.len(__builtins__.str(self.cache.prompt_count))}', |
|
135 | r'\D': '${"."*__builtins__.len(__builtins__.str(self.cache.prompt_count))}', | |
136 |
|
136 | |||
137 | # Current working directory |
|
137 | # Current working directory | |
138 | r'\w': '${os.getcwd()}', |
|
138 | r'\w': '${os.getcwd()}', | |
139 | # Current time |
|
139 | # Current time | |
140 | r'\t' : '${time.strftime("%H:%M:%S")}', |
|
140 | r'\t' : '${time.strftime("%H:%M:%S")}', | |
141 | # Basename of current working directory. |
|
141 | # Basename of current working directory. | |
142 | # (use os.sep to make this portable across OSes) |
|
142 | # (use os.sep to make this portable across OSes) | |
143 | r'\W' : '${os.getcwd().split("%s")[-1]}' % os.sep, |
|
143 | r'\W' : '${os.getcwd().split("%s")[-1]}' % os.sep, | |
144 | # These X<N> are an extension to the normal bash prompts. They return |
|
144 | # These X<N> are an extension to the normal bash prompts. They return | |
145 | # N terms of the path, after replacing $HOME with '~' |
|
145 | # N terms of the path, after replacing $HOME with '~' | |
146 | r'\X0': '${os.getcwd().replace("%s","~")}' % HOME, |
|
146 | r'\X0': '${os.getcwd().replace("%s","~")}' % HOME, | |
147 | r'\X1': '${self.cwd_filt(1)}', |
|
147 | r'\X1': '${self.cwd_filt(1)}', | |
148 | r'\X2': '${self.cwd_filt(2)}', |
|
148 | r'\X2': '${self.cwd_filt(2)}', | |
149 | r'\X3': '${self.cwd_filt(3)}', |
|
149 | r'\X3': '${self.cwd_filt(3)}', | |
150 | r'\X4': '${self.cwd_filt(4)}', |
|
150 | r'\X4': '${self.cwd_filt(4)}', | |
151 | r'\X5': '${self.cwd_filt(5)}', |
|
151 | r'\X5': '${self.cwd_filt(5)}', | |
152 | # Y<N> are similar to X<N>, but they show '~' if it's the directory |
|
152 | # Y<N> are similar to X<N>, but they show '~' if it's the directory | |
153 | # N+1 in the list. Somewhat like %cN in tcsh. |
|
153 | # N+1 in the list. Somewhat like %cN in tcsh. | |
154 | r'\Y0': '${self.cwd_filt2(0)}', |
|
154 | r'\Y0': '${self.cwd_filt2(0)}', | |
155 | r'\Y1': '${self.cwd_filt2(1)}', |
|
155 | r'\Y1': '${self.cwd_filt2(1)}', | |
156 | r'\Y2': '${self.cwd_filt2(2)}', |
|
156 | r'\Y2': '${self.cwd_filt2(2)}', | |
157 | r'\Y3': '${self.cwd_filt2(3)}', |
|
157 | r'\Y3': '${self.cwd_filt2(3)}', | |
158 | r'\Y4': '${self.cwd_filt2(4)}', |
|
158 | r'\Y4': '${self.cwd_filt2(4)}', | |
159 | r'\Y5': '${self.cwd_filt2(5)}', |
|
159 | r'\Y5': '${self.cwd_filt2(5)}', | |
160 | # Hostname up to first . |
|
160 | # Hostname up to first . | |
161 | r'\h': HOSTNAME_SHORT, |
|
161 | r'\h': HOSTNAME_SHORT, | |
162 | # Full hostname |
|
162 | # Full hostname | |
163 | r'\H': HOSTNAME, |
|
163 | r'\H': HOSTNAME, | |
164 | # Username of current user |
|
164 | # Username of current user | |
165 | r'\u': USER, |
|
165 | r'\u': USER, | |
166 | # Escaped '\' |
|
166 | # Escaped '\' | |
167 | '\\\\': '\\', |
|
167 | '\\\\': '\\', | |
168 | # Newline |
|
168 | # Newline | |
169 | r'\n': '\n', |
|
169 | r'\n': '\n', | |
170 | # Carriage return |
|
170 | # Carriage return | |
171 | r'\r': '\r', |
|
171 | r'\r': '\r', | |
172 | # Release version |
|
172 | # Release version | |
173 | r'\v': Release.version, |
|
173 | r'\v': Release.version, | |
174 | # Root symbol ($ or #) |
|
174 | # Root symbol ($ or #) | |
175 | r'\$': ROOT_SYMBOL, |
|
175 | r'\$': ROOT_SYMBOL, | |
176 | } |
|
176 | } | |
177 |
|
177 | |||
178 | # A copy of the prompt_specials dictionary but with all color escapes removed, |
|
178 | # A copy of the prompt_specials dictionary but with all color escapes removed, | |
179 | # so we can correctly compute the prompt length for the auto_rewrite method. |
|
179 | # so we can correctly compute the prompt length for the auto_rewrite method. | |
180 | prompt_specials_nocolor = prompt_specials_color.copy() |
|
180 | prompt_specials_nocolor = prompt_specials_color.copy() | |
181 | prompt_specials_nocolor['%n'] = '${self.cache.prompt_count}' |
|
181 | prompt_specials_nocolor['%n'] = '${self.cache.prompt_count}' | |
182 | prompt_specials_nocolor[r'\#'] = '${self.cache.prompt_count}' |
|
182 | prompt_specials_nocolor[r'\#'] = '${self.cache.prompt_count}' | |
183 |
|
183 | |||
184 | # Add in all the InputTermColors color escapes as valid prompt characters. |
|
184 | # Add in all the InputTermColors color escapes as valid prompt characters. | |
185 | # They all get added as \\C_COLORNAME, so that we don't have any conflicts |
|
185 | # They all get added as \\C_COLORNAME, so that we don't have any conflicts | |
186 | # with a color name which may begin with a letter used by any other of the |
|
186 | # with a color name which may begin with a letter used by any other of the | |
187 | # allowed specials. This of course means that \\C will never be allowed for |
|
187 | # allowed specials. This of course means that \\C will never be allowed for | |
188 | # anything else. |
|
188 | # anything else. | |
189 | input_colors = coloransi.InputTermColors |
|
189 | input_colors = coloransi.InputTermColors | |
190 | for _color in dir(input_colors): |
|
190 | for _color in dir(input_colors): | |
191 | if _color[0] != '_': |
|
191 | if _color[0] != '_': | |
192 | c_name = r'\C_'+_color |
|
192 | c_name = r'\C_'+_color | |
193 | prompt_specials_color[c_name] = getattr(input_colors,_color) |
|
193 | prompt_specials_color[c_name] = getattr(input_colors,_color) | |
194 | prompt_specials_nocolor[c_name] = '' |
|
194 | prompt_specials_nocolor[c_name] = '' | |
195 |
|
195 | |||
196 | # we default to no color for safety. Note that prompt_specials is a global |
|
196 | # we default to no color for safety. Note that prompt_specials is a global | |
197 | # variable used by all prompt objects. |
|
197 | # variable used by all prompt objects. | |
198 | prompt_specials = prompt_specials_nocolor |
|
198 | prompt_specials = prompt_specials_nocolor | |
199 |
|
199 | |||
200 | #----------------------------------------------------------------------------- |
|
200 | #----------------------------------------------------------------------------- | |
201 | def str_safe(arg): |
|
201 | def str_safe(arg): | |
202 | """Convert to a string, without ever raising an exception. |
|
202 | """Convert to a string, without ever raising an exception. | |
203 |
|
203 | |||
204 | If str(arg) fails, <ERROR: ... > is returned, where ... is the exception |
|
204 | If str(arg) fails, <ERROR: ... > is returned, where ... is the exception | |
205 | error message.""" |
|
205 | error message.""" | |
206 |
|
206 | |||
207 | try: |
|
207 | try: | |
208 | out = str(arg) |
|
208 | out = str(arg) | |
209 | except UnicodeError: |
|
209 | except UnicodeError: | |
210 | try: |
|
210 | try: | |
211 | out = arg.encode('utf_8','replace') |
|
211 | out = arg.encode('utf_8','replace') | |
212 | except Exception,msg: |
|
212 | except Exception,msg: | |
213 | # let's keep this little duplication here, so that the most common |
|
213 | # let's keep this little duplication here, so that the most common | |
214 | # case doesn't suffer from a double try wrapping. |
|
214 | # case doesn't suffer from a double try wrapping. | |
215 | out = '<ERROR: %s>' % msg |
|
215 | out = '<ERROR: %s>' % msg | |
216 | except Exception,msg: |
|
216 | except Exception,msg: | |
217 | out = '<ERROR: %s>' % msg |
|
217 | out = '<ERROR: %s>' % msg | |
218 | return out |
|
218 | return out | |
219 |
|
219 | |||
220 | class BasePrompt(object): |
|
220 | class BasePrompt(object): | |
221 | """Interactive prompt similar to Mathematica's.""" |
|
221 | """Interactive prompt similar to Mathematica's.""" | |
222 |
|
222 | |||
223 | def _get_p_template(self): |
|
223 | def _get_p_template(self): | |
224 | return self._p_template |
|
224 | return self._p_template | |
225 |
|
225 | |||
226 | def _set_p_template(self,val): |
|
226 | def _set_p_template(self,val): | |
227 | self._p_template = val |
|
227 | self._p_template = val | |
228 | self.set_p_str() |
|
228 | self.set_p_str() | |
229 |
|
229 | |||
230 | p_template = property(_get_p_template,_set_p_template, |
|
230 | p_template = property(_get_p_template,_set_p_template, | |
231 | doc='Template for prompt string creation') |
|
231 | doc='Template for prompt string creation') | |
232 |
|
232 | |||
233 | def __init__(self,cache,sep,prompt,pad_left=False): |
|
233 | def __init__(self,cache,sep,prompt,pad_left=False): | |
234 |
|
234 | |||
235 | # Hack: we access information about the primary prompt through the |
|
235 | # Hack: we access information about the primary prompt through the | |
236 | # cache argument. We need this, because we want the secondary prompt |
|
236 | # cache argument. We need this, because we want the secondary prompt | |
237 | # to be aligned with the primary one. Color table info is also shared |
|
237 | # to be aligned with the primary one. Color table info is also shared | |
238 | # by all prompt classes through the cache. Nice OO spaghetti code! |
|
238 | # by all prompt classes through the cache. Nice OO spaghetti code! | |
239 | self.cache = cache |
|
239 | self.cache = cache | |
240 | self.sep = sep |
|
240 | self.sep = sep | |
241 |
|
241 | |||
242 | # regexp to count the number of spaces at the end of a prompt |
|
242 | # regexp to count the number of spaces at the end of a prompt | |
243 | # expression, useful for prompt auto-rewriting |
|
243 | # expression, useful for prompt auto-rewriting | |
244 | self.rspace = re.compile(r'(\s*)$') |
|
244 | self.rspace = re.compile(r'(\s*)$') | |
245 | # Flag to left-pad prompt strings to match the length of the primary |
|
245 | # Flag to left-pad prompt strings to match the length of the primary | |
246 | # prompt |
|
246 | # prompt | |
247 | self.pad_left = pad_left |
|
247 | self.pad_left = pad_left | |
248 |
|
248 | |||
249 | # Set template to create each actual prompt (where numbers change). |
|
249 | # Set template to create each actual prompt (where numbers change). | |
250 | # Use a property |
|
250 | # Use a property | |
251 | self.p_template = prompt |
|
251 | self.p_template = prompt | |
252 | self.set_p_str() |
|
252 | self.set_p_str() | |
253 |
|
253 | |||
254 | def set_p_str(self): |
|
254 | def set_p_str(self): | |
255 | """ Set the interpolating prompt strings. |
|
255 | """ Set the interpolating prompt strings. | |
256 |
|
256 | |||
257 | This must be called every time the color settings change, because the |
|
257 | This must be called every time the color settings change, because the | |
258 | prompt_specials global may have changed.""" |
|
258 | prompt_specials global may have changed.""" | |
259 |
|
259 | |||
260 | import os,time # needed in locals for prompt string handling |
|
260 | import os,time # needed in locals for prompt string handling | |
261 | loc = locals() |
|
261 | loc = locals() | |
262 | try: |
|
262 | try: | |
263 | self.p_str = ItplNS('%s%s%s' % |
|
263 | self.p_str = ItplNS('%s%s%s' % | |
264 | ('${self.sep}${self.col_p}', |
|
264 | ('${self.sep}${self.col_p}', | |
265 | multiple_replace(prompt_specials, self.p_template), |
|
265 | multiple_replace(prompt_specials, self.p_template), | |
266 | '${self.col_norm}'),self.cache.user_ns,loc) |
|
266 | '${self.col_norm}'),self.cache.user_ns,loc) | |
267 |
|
267 | |||
268 | self.p_str_nocolor = ItplNS(multiple_replace(prompt_specials_nocolor, |
|
268 | self.p_str_nocolor = ItplNS(multiple_replace(prompt_specials_nocolor, | |
269 | self.p_template), |
|
269 | self.p_template), | |
270 | self.cache.user_ns,loc) |
|
270 | self.cache.user_ns,loc) | |
271 | except: |
|
271 | except: | |
272 | print "Illegal prompt template (check $ usage!):",self.p_template |
|
272 | print "Illegal prompt template (check $ usage!):",self.p_template | |
273 | self.p_str = self.p_template |
|
273 | self.p_str = self.p_template | |
274 | self.p_str_nocolor = self.p_template |
|
274 | self.p_str_nocolor = self.p_template | |
275 |
|
275 | |||
276 | def write(self,msg): # dbg |
|
276 | def write(self,msg): # dbg | |
277 | sys.stdout.write(msg) |
|
277 | sys.stdout.write(msg) | |
278 | return '' |
|
278 | return '' | |
279 |
|
279 | |||
280 | def __str__(self): |
|
280 | def __str__(self): | |
281 | """Return a string form of the prompt. |
|
281 | """Return a string form of the prompt. | |
282 |
|
282 | |||
283 | This for is useful for continuation and output prompts, since it is |
|
283 | This for is useful for continuation and output prompts, since it is | |
284 | left-padded to match lengths with the primary one (if the |
|
284 | left-padded to match lengths with the primary one (if the | |
285 | self.pad_left attribute is set).""" |
|
285 | self.pad_left attribute is set).""" | |
286 |
|
286 | |||
287 | out_str = str_safe(self.p_str) |
|
287 | out_str = str_safe(self.p_str) | |
288 | if self.pad_left: |
|
288 | if self.pad_left: | |
289 | # We must find the amount of padding required to match lengths, |
|
289 | # We must find the amount of padding required to match lengths, | |
290 | # taking the color escapes (which are invisible on-screen) into |
|
290 | # taking the color escapes (which are invisible on-screen) into | |
291 | # account. |
|
291 | # account. | |
292 | esc_pad = len(out_str) - len(str_safe(self.p_str_nocolor)) |
|
292 | esc_pad = len(out_str) - len(str_safe(self.p_str_nocolor)) | |
293 | format = '%%%ss' % (len(str(self.cache.last_prompt))+esc_pad) |
|
293 | format = '%%%ss' % (len(str(self.cache.last_prompt))+esc_pad) | |
294 | return format % out_str |
|
294 | return format % out_str | |
295 | else: |
|
295 | else: | |
296 | return out_str |
|
296 | return out_str | |
297 |
|
297 | |||
298 | # these path filters are put in as methods so that we can control the |
|
298 | # these path filters are put in as methods so that we can control the | |
299 | # namespace where the prompt strings get evaluated |
|
299 | # namespace where the prompt strings get evaluated | |
300 | def cwd_filt(self,depth): |
|
300 | def cwd_filt(self,depth): | |
301 | """Return the last depth elements of the current working directory. |
|
301 | """Return the last depth elements of the current working directory. | |
302 |
|
302 | |||
303 | $HOME is always replaced with '~'. |
|
303 | $HOME is always replaced with '~'. | |
304 | If depth==0, the full path is returned.""" |
|
304 | If depth==0, the full path is returned.""" | |
305 |
|
305 | |||
306 | cwd = os.getcwd().replace(HOME,"~") |
|
306 | cwd = os.getcwd().replace(HOME,"~") | |
307 | out = os.sep.join(cwd.split(os.sep)[-depth:]) |
|
307 | out = os.sep.join(cwd.split(os.sep)[-depth:]) | |
308 | if out: |
|
308 | if out: | |
309 | return out |
|
309 | return out | |
310 | else: |
|
310 | else: | |
311 | return os.sep |
|
311 | return os.sep | |
312 |
|
312 | |||
313 | def cwd_filt2(self,depth): |
|
313 | def cwd_filt2(self,depth): | |
314 | """Return the last depth elements of the current working directory. |
|
314 | """Return the last depth elements of the current working directory. | |
315 |
|
315 | |||
316 | $HOME is always replaced with '~'. |
|
316 | $HOME is always replaced with '~'. | |
317 | If depth==0, the full path is returned.""" |
|
317 | If depth==0, the full path is returned.""" | |
318 |
|
318 | |||
319 | full_cwd = os.getcwd() |
|
319 | full_cwd = os.getcwd() | |
320 | cwd = full_cwd.replace(HOME,"~").split(os.sep) |
|
320 | cwd = full_cwd.replace(HOME,"~").split(os.sep) | |
321 | if '~' in cwd and len(cwd) == depth+1: |
|
321 | if '~' in cwd and len(cwd) == depth+1: | |
322 | depth += 1 |
|
322 | depth += 1 | |
323 | drivepart = '' |
|
323 | drivepart = '' | |
324 | if sys.platform == 'win32' and len(cwd) > depth: |
|
324 | if sys.platform == 'win32' and len(cwd) > depth: | |
325 | drivepart = os.path.splitdrive(full_cwd)[0] |
|
325 | drivepart = os.path.splitdrive(full_cwd)[0] | |
326 | out = drivepart + '/'.join(cwd[-depth:]) |
|
326 | out = drivepart + '/'.join(cwd[-depth:]) | |
327 |
|
327 | |||
328 | if out: |
|
328 | if out: | |
329 | return out |
|
329 | return out | |
330 | else: |
|
330 | else: | |
331 | return os.sep |
|
331 | return os.sep | |
332 |
|
332 | |||
333 | def __nonzero__(self): |
|
333 | def __nonzero__(self): | |
334 | """Implement boolean behavior. |
|
334 | """Implement boolean behavior. | |
335 |
|
335 | |||
336 | Checks whether the p_str attribute is non-empty""" |
|
336 | Checks whether the p_str attribute is non-empty""" | |
337 |
|
337 | |||
338 | return bool(self.p_template) |
|
338 | return bool(self.p_template) | |
339 |
|
339 | |||
340 | class Prompt1(BasePrompt): |
|
340 | class Prompt1(BasePrompt): | |
341 | """Input interactive prompt similar to Mathematica's.""" |
|
341 | """Input interactive prompt similar to Mathematica's.""" | |
342 |
|
342 | |||
343 | def __init__(self,cache,sep='\n',prompt='In [\\#]: ',pad_left=True): |
|
343 | def __init__(self,cache,sep='\n',prompt='In [\\#]: ',pad_left=True): | |
344 | BasePrompt.__init__(self,cache,sep,prompt,pad_left) |
|
344 | BasePrompt.__init__(self,cache,sep,prompt,pad_left) | |
345 |
|
345 | |||
346 | def set_colors(self): |
|
346 | def set_colors(self): | |
347 | self.set_p_str() |
|
347 | self.set_p_str() | |
348 | Colors = self.cache.color_table.active_colors # shorthand |
|
348 | Colors = self.cache.color_table.active_colors # shorthand | |
349 | self.col_p = Colors.in_prompt |
|
349 | self.col_p = Colors.in_prompt | |
350 | self.col_num = Colors.in_number |
|
350 | self.col_num = Colors.in_number | |
351 | self.col_norm = Colors.in_normal |
|
351 | self.col_norm = Colors.in_normal | |
352 | # We need a non-input version of these escapes for the '--->' |
|
352 | # We need a non-input version of these escapes for the '--->' | |
353 | # auto-call prompts used in the auto_rewrite() method. |
|
353 | # auto-call prompts used in the auto_rewrite() method. | |
354 | self.col_p_ni = self.col_p.replace('\001','').replace('\002','') |
|
354 | self.col_p_ni = self.col_p.replace('\001','').replace('\002','') | |
355 | self.col_norm_ni = Colors.normal |
|
355 | self.col_norm_ni = Colors.normal | |
356 |
|
356 | |||
357 | def __str__(self): |
|
357 | def __str__(self): | |
358 | self.cache.prompt_count += 1 |
|
358 | self.cache.prompt_count += 1 | |
359 | self.cache.last_prompt = str_safe(self.p_str_nocolor).split('\n')[-1] |
|
359 | self.cache.last_prompt = str_safe(self.p_str_nocolor).split('\n')[-1] | |
360 | return str_safe(self.p_str) |
|
360 | return str_safe(self.p_str) | |
361 |
|
361 | |||
362 | def auto_rewrite(self): |
|
362 | def auto_rewrite(self): | |
363 | """Print a string of the form '--->' which lines up with the previous |
|
363 | """Print a string of the form '--->' which lines up with the previous | |
364 | input string. Useful for systems which re-write the user input when |
|
364 | input string. Useful for systems which re-write the user input when | |
365 | handling automatically special syntaxes.""" |
|
365 | handling automatically special syntaxes.""" | |
366 |
|
366 | |||
367 | curr = str(self.cache.last_prompt) |
|
367 | curr = str(self.cache.last_prompt) | |
368 | nrspaces = len(self.rspace.search(curr).group()) |
|
368 | nrspaces = len(self.rspace.search(curr).group()) | |
369 | return '%s%s>%s%s' % (self.col_p_ni,'-'*(len(curr)-nrspaces-1), |
|
369 | return '%s%s>%s%s' % (self.col_p_ni,'-'*(len(curr)-nrspaces-1), | |
370 | ' '*nrspaces,self.col_norm_ni) |
|
370 | ' '*nrspaces,self.col_norm_ni) | |
371 |
|
371 | |||
372 | class PromptOut(BasePrompt): |
|
372 | class PromptOut(BasePrompt): | |
373 | """Output interactive prompt similar to Mathematica's.""" |
|
373 | """Output interactive prompt similar to Mathematica's.""" | |
374 |
|
374 | |||
375 | def __init__(self,cache,sep='',prompt='Out[\\#]: ',pad_left=True): |
|
375 | def __init__(self,cache,sep='',prompt='Out[\\#]: ',pad_left=True): | |
376 | BasePrompt.__init__(self,cache,sep,prompt,pad_left) |
|
376 | BasePrompt.__init__(self,cache,sep,prompt,pad_left) | |
377 | if not self.p_template: |
|
377 | if not self.p_template: | |
378 | self.__str__ = lambda: '' |
|
378 | self.__str__ = lambda: '' | |
379 |
|
379 | |||
380 | def set_colors(self): |
|
380 | def set_colors(self): | |
381 | self.set_p_str() |
|
381 | self.set_p_str() | |
382 | Colors = self.cache.color_table.active_colors # shorthand |
|
382 | Colors = self.cache.color_table.active_colors # shorthand | |
383 | self.col_p = Colors.out_prompt |
|
383 | self.col_p = Colors.out_prompt | |
384 | self.col_num = Colors.out_number |
|
384 | self.col_num = Colors.out_number | |
385 | self.col_norm = Colors.normal |
|
385 | self.col_norm = Colors.normal | |
386 |
|
386 | |||
387 | class Prompt2(BasePrompt): |
|
387 | class Prompt2(BasePrompt): | |
388 | """Interactive continuation prompt.""" |
|
388 | """Interactive continuation prompt.""" | |
389 |
|
389 | |||
390 | def __init__(self,cache,prompt=' .\\D.: ',pad_left=True): |
|
390 | def __init__(self,cache,prompt=' .\\D.: ',pad_left=True): | |
391 | self.cache = cache |
|
391 | self.cache = cache | |
392 | self.p_template = prompt |
|
392 | self.p_template = prompt | |
393 | self.pad_left = pad_left |
|
393 | self.pad_left = pad_left | |
394 | self.set_p_str() |
|
394 | self.set_p_str() | |
395 |
|
395 | |||
396 | def set_p_str(self): |
|
396 | def set_p_str(self): | |
397 | import os,time # needed in locals for prompt string handling |
|
397 | import os,time # needed in locals for prompt string handling | |
398 | loc = locals() |
|
398 | loc = locals() | |
399 | self.p_str = ItplNS('%s%s%s' % |
|
399 | self.p_str = ItplNS('%s%s%s' % | |
400 | ('${self.col_p2}', |
|
400 | ('${self.col_p2}', | |
401 | multiple_replace(prompt_specials, self.p_template), |
|
401 | multiple_replace(prompt_specials, self.p_template), | |
402 | '$self.col_norm'), |
|
402 | '$self.col_norm'), | |
403 | self.cache.user_ns,loc) |
|
403 | self.cache.user_ns,loc) | |
404 | self.p_str_nocolor = ItplNS(multiple_replace(prompt_specials_nocolor, |
|
404 | self.p_str_nocolor = ItplNS(multiple_replace(prompt_specials_nocolor, | |
405 | self.p_template), |
|
405 | self.p_template), | |
406 | self.cache.user_ns,loc) |
|
406 | self.cache.user_ns,loc) | |
407 |
|
407 | |||
408 | def set_colors(self): |
|
408 | def set_colors(self): | |
409 | self.set_p_str() |
|
409 | self.set_p_str() | |
410 | Colors = self.cache.color_table.active_colors |
|
410 | Colors = self.cache.color_table.active_colors | |
411 | self.col_p2 = Colors.in_prompt2 |
|
411 | self.col_p2 = Colors.in_prompt2 | |
412 | self.col_norm = Colors.in_normal |
|
412 | self.col_norm = Colors.in_normal | |
413 | # FIXME (2004-06-16) HACK: prevent crashes for users who haven't |
|
413 | # FIXME (2004-06-16) HACK: prevent crashes for users who haven't | |
414 | # updated their prompt_in2 definitions. Remove eventually. |
|
414 | # updated their prompt_in2 definitions. Remove eventually. | |
415 | self.col_p = Colors.out_prompt |
|
415 | self.col_p = Colors.out_prompt | |
416 | self.col_num = Colors.out_number |
|
416 | self.col_num = Colors.out_number | |
417 |
|
417 | |||
418 |
|
418 | |||
419 | #----------------------------------------------------------------------------- |
|
419 | #----------------------------------------------------------------------------- | |
420 | class CachedOutput: |
|
420 | class CachedOutput: | |
421 | """Class for printing output from calculations while keeping a cache of |
|
421 | """Class for printing output from calculations while keeping a cache of | |
422 | reults. It dynamically creates global variables prefixed with _ which |
|
422 | reults. It dynamically creates global variables prefixed with _ which | |
423 | contain these results. |
|
423 | contain these results. | |
424 |
|
424 | |||
425 | Meant to be used as a sys.displayhook replacement, providing numbered |
|
425 | Meant to be used as a sys.displayhook replacement, providing numbered | |
426 | prompts and cache services. |
|
426 | prompts and cache services. | |
427 |
|
427 | |||
428 | Initialize with initial and final values for cache counter (this defines |
|
428 | Initialize with initial and final values for cache counter (this defines | |
429 | the maximum size of the cache.""" |
|
429 | the maximum size of the cache.""" | |
430 |
|
430 | |||
431 | def __init__(self,shell,cache_size,Pprint, |
|
431 | def __init__(self,shell,cache_size,Pprint, | |
432 | colors='NoColor',input_sep='\n', |
|
432 | colors='NoColor',input_sep='\n', | |
433 | output_sep='\n',output_sep2='', |
|
433 | output_sep='\n',output_sep2='', | |
434 | ps1 = None, ps2 = None,ps_out = None,pad_left=True): |
|
434 | ps1 = None, ps2 = None,ps_out = None,pad_left=True): | |
435 |
|
435 | |||
436 | cache_size_min = 3 |
|
436 | cache_size_min = 3 | |
437 | if cache_size <= 0: |
|
437 | if cache_size <= 0: | |
438 | self.do_full_cache = 0 |
|
438 | self.do_full_cache = 0 | |
439 | cache_size = 0 |
|
439 | cache_size = 0 | |
440 | elif cache_size < cache_size_min: |
|
440 | elif cache_size < cache_size_min: | |
441 | self.do_full_cache = 0 |
|
441 | self.do_full_cache = 0 | |
442 | cache_size = 0 |
|
442 | cache_size = 0 | |
443 | warn('caching was disabled (min value for cache size is %s).' % |
|
443 | warn('caching was disabled (min value for cache size is %s).' % | |
444 | cache_size_min,level=3) |
|
444 | cache_size_min,level=3) | |
445 | else: |
|
445 | else: | |
446 | self.do_full_cache = 1 |
|
446 | self.do_full_cache = 1 | |
447 |
|
447 | |||
448 | self.cache_size = cache_size |
|
448 | self.cache_size = cache_size | |
449 | self.input_sep = input_sep |
|
449 | self.input_sep = input_sep | |
450 |
|
450 | |||
451 | # we need a reference to the user-level namespace |
|
451 | # we need a reference to the user-level namespace | |
452 | self.shell = shell |
|
452 | self.shell = shell | |
453 | self.user_ns = shell.user_ns |
|
453 | self.user_ns = shell.user_ns | |
454 | # and to the user's input |
|
454 | # and to the user's input | |
455 | self.input_hist = shell.input_hist |
|
455 | self.input_hist = shell.input_hist | |
456 | # and to the user's logger, for logging output |
|
456 | # and to the user's logger, for logging output | |
457 | self.logger = shell.logger |
|
457 | self.logger = shell.logger | |
458 |
|
458 | |||
459 | # Set input prompt strings and colors |
|
459 | # Set input prompt strings and colors | |
460 | if cache_size == 0: |
|
460 | if cache_size == 0: | |
461 | if ps1.find('%n') > -1 or ps1.find(r'\#') > -1 \ |
|
461 | if ps1.find('%n') > -1 or ps1.find(r'\#') > -1 \ | |
462 | or ps1.find(r'\N') > -1: |
|
462 | or ps1.find(r'\N') > -1: | |
463 | ps1 = '>>> ' |
|
463 | ps1 = '>>> ' | |
464 | if ps2.find('%n') > -1 or ps2.find(r'\#') > -1 \ |
|
464 | if ps2.find('%n') > -1 or ps2.find(r'\#') > -1 \ | |
465 | or ps2.find(r'\N') > -1: |
|
465 | or ps2.find(r'\N') > -1: | |
466 | ps2 = '... ' |
|
466 | ps2 = '... ' | |
467 | self.ps1_str = self._set_prompt_str(ps1,'In [\\#]: ','>>> ') |
|
467 | self.ps1_str = self._set_prompt_str(ps1,'In [\\#]: ','>>> ') | |
468 | self.ps2_str = self._set_prompt_str(ps2,' .\\D.: ','... ') |
|
468 | self.ps2_str = self._set_prompt_str(ps2,' .\\D.: ','... ') | |
469 | self.ps_out_str = self._set_prompt_str(ps_out,'Out[\\#]: ','') |
|
469 | self.ps_out_str = self._set_prompt_str(ps_out,'Out[\\#]: ','') | |
470 |
|
470 | |||
471 | self.color_table = PromptColors |
|
471 | self.color_table = PromptColors | |
472 | self.prompt1 = Prompt1(self,sep=input_sep,prompt=self.ps1_str, |
|
472 | self.prompt1 = Prompt1(self,sep=input_sep,prompt=self.ps1_str, | |
473 | pad_left=pad_left) |
|
473 | pad_left=pad_left) | |
474 | self.prompt2 = Prompt2(self,prompt=self.ps2_str,pad_left=pad_left) |
|
474 | self.prompt2 = Prompt2(self,prompt=self.ps2_str,pad_left=pad_left) | |
475 | self.prompt_out = PromptOut(self,sep='',prompt=self.ps_out_str, |
|
475 | self.prompt_out = PromptOut(self,sep='',prompt=self.ps_out_str, | |
476 | pad_left=pad_left) |
|
476 | pad_left=pad_left) | |
477 | self.set_colors(colors) |
|
477 | self.set_colors(colors) | |
478 |
|
478 | |||
479 | # other more normal stuff |
|
479 | # other more normal stuff | |
480 | # b/c each call to the In[] prompt raises it by 1, even the first. |
|
480 | # b/c each call to the In[] prompt raises it by 1, even the first. | |
481 | self.prompt_count = 0 |
|
481 | self.prompt_count = 0 | |
482 | # Store the last prompt string each time, we need it for aligning |
|
482 | # Store the last prompt string each time, we need it for aligning | |
483 | # continuation and auto-rewrite prompts |
|
483 | # continuation and auto-rewrite prompts | |
484 | self.last_prompt = '' |
|
484 | self.last_prompt = '' | |
485 | self.Pprint = Pprint |
|
485 | self.Pprint = Pprint | |
486 | self.output_sep = output_sep |
|
486 | self.output_sep = output_sep | |
487 | self.output_sep2 = output_sep2 |
|
487 | self.output_sep2 = output_sep2 | |
488 | self._,self.__,self.___ = '','','' |
|
488 | self._,self.__,self.___ = '','','' | |
489 | self.pprint_types = map(type,[(),[],{}]) |
|
489 | self.pprint_types = map(type,[(),[],{}]) | |
490 |
|
490 | |||
491 | # these are deliberately global: |
|
491 | # these are deliberately global: | |
492 | to_user_ns = {'_':self._,'__':self.__,'___':self.___} |
|
492 | to_user_ns = {'_':self._,'__':self.__,'___':self.___} | |
493 | self.user_ns.update(to_user_ns) |
|
493 | self.user_ns.update(to_user_ns) | |
494 |
|
494 | |||
495 | def _set_prompt_str(self,p_str,cache_def,no_cache_def): |
|
495 | def _set_prompt_str(self,p_str,cache_def,no_cache_def): | |
496 | if p_str is None: |
|
496 | if p_str is None: | |
497 | if self.do_full_cache: |
|
497 | if self.do_full_cache: | |
498 | return cache_def |
|
498 | return cache_def | |
499 | else: |
|
499 | else: | |
500 | return no_cache_def |
|
500 | return no_cache_def | |
501 | else: |
|
501 | else: | |
502 | return p_str |
|
502 | return p_str | |
503 |
|
503 | |||
504 | def set_colors(self,colors): |
|
504 | def set_colors(self,colors): | |
505 | """Set the active color scheme and configure colors for the three |
|
505 | """Set the active color scheme and configure colors for the three | |
506 | prompt subsystems.""" |
|
506 | prompt subsystems.""" | |
507 |
|
507 | |||
508 | # FIXME: the prompt_specials global should be gobbled inside this |
|
508 | # FIXME: the prompt_specials global should be gobbled inside this | |
509 | # class instead. Do it when cleaning up the whole 3-prompt system. |
|
509 | # class instead. Do it when cleaning up the whole 3-prompt system. | |
510 | global prompt_specials |
|
510 | global prompt_specials | |
511 | if colors.lower()=='nocolor': |
|
511 | if colors.lower()=='nocolor': | |
512 | prompt_specials = prompt_specials_nocolor |
|
512 | prompt_specials = prompt_specials_nocolor | |
513 | else: |
|
513 | else: | |
514 | prompt_specials = prompt_specials_color |
|
514 | prompt_specials = prompt_specials_color | |
515 |
|
515 | |||
516 | self.color_table.set_active_scheme(colors) |
|
516 | self.color_table.set_active_scheme(colors) | |
517 | self.prompt1.set_colors() |
|
517 | self.prompt1.set_colors() | |
518 | self.prompt2.set_colors() |
|
518 | self.prompt2.set_colors() | |
519 | self.prompt_out.set_colors() |
|
519 | self.prompt_out.set_colors() | |
520 |
|
520 | |||
521 | def __call__(self,arg=None): |
|
521 | def __call__(self,arg=None): | |
522 | """Printing with history cache management. |
|
522 | """Printing with history cache management. | |
523 |
|
523 | |||
524 | This is invoked everytime the interpreter needs to print, and is |
|
524 | This is invoked everytime the interpreter needs to print, and is | |
525 | activated by setting the variable sys.displayhook to it.""" |
|
525 | activated by setting the variable sys.displayhook to it.""" | |
526 |
|
526 | |||
527 | # If something injected a '_' variable in __builtin__, delete |
|
527 | # If something injected a '_' variable in __builtin__, delete | |
528 | # ipython's automatic one so we don't clobber that. gettext() in |
|
528 | # ipython's automatic one so we don't clobber that. gettext() in | |
529 | # particular uses _, so we need to stay away from it. |
|
529 | # particular uses _, so we need to stay away from it. | |
530 | if '_' in __builtin__.__dict__: |
|
530 | if '_' in __builtin__.__dict__: | |
531 | try: |
|
531 | try: | |
532 | del self.user_ns['_'] |
|
532 | del self.user_ns['_'] | |
533 | except KeyError: |
|
533 | except KeyError: | |
534 | pass |
|
534 | pass | |
535 | if arg is not None: |
|
535 | if arg is not None: | |
536 | cout_write = Term.cout.write # fast lookup |
|
536 | cout_write = Term.cout.write # fast lookup | |
537 | # first handle the cache and counters |
|
537 | # first handle the cache and counters | |
538 |
|
538 | |||
539 | # do not print output if input ends in ';' |
|
539 | # do not print output if input ends in ';' | |
540 | try: |
|
540 | try: | |
541 | if self.input_hist[self.prompt_count].endswith(';\n'): |
|
541 | if self.input_hist[self.prompt_count].endswith(';\n'): | |
542 | return |
|
542 | return | |
543 | except IndexError: |
|
543 | except IndexError: | |
544 | # some uses of ipshellembed may fail here |
|
544 | # some uses of ipshellembed may fail here | |
545 | pass |
|
545 | pass | |
546 | # don't use print, puts an extra space |
|
546 | # don't use print, puts an extra space | |
547 | cout_write(self.output_sep) |
|
547 | cout_write(self.output_sep) | |
548 | outprompt = self.shell.hooks.generate_output_prompt() |
|
548 | outprompt = self.shell.hooks.generate_output_prompt() | |
549 | if self.do_full_cache: |
|
549 | if self.do_full_cache: | |
550 | cout_write(outprompt) |
|
550 | cout_write(outprompt) | |
551 |
|
551 | |||
552 | # and now call a possibly user-defined print mechanism |
|
552 | # and now call a possibly user-defined print mechanism | |
553 | manipulated_val = self.display(arg) |
|
553 | manipulated_val = self.display(arg) | |
554 |
|
554 | |||
555 | # user display hooks can change the variable to be stored in |
|
555 | # user display hooks can change the variable to be stored in | |
556 | # output history |
|
556 | # output history | |
557 |
|
557 | |||
558 | if manipulated_val is not None: |
|
558 | if manipulated_val is not None: | |
559 | arg = manipulated_val |
|
559 | arg = manipulated_val | |
560 |
|
560 | |||
561 | # avoid recursive reference when displaying _oh/Out |
|
561 | # avoid recursive reference when displaying _oh/Out | |
562 | if arg is not self.user_ns['_oh']: |
|
562 | if arg is not self.user_ns['_oh']: | |
563 | self.update(arg) |
|
563 | self.update(arg) | |
564 |
|
564 | |||
565 | if self.logger.log_output: |
|
565 | if self.logger.log_output: | |
566 | self.logger.log_write(repr(arg),'output') |
|
566 | self.logger.log_write(repr(arg),'output') | |
567 | cout_write(self.output_sep2) |
|
567 | cout_write(self.output_sep2) | |
568 | Term.cout.flush() |
|
568 | Term.cout.flush() | |
569 |
|
569 | |||
570 | def _display(self,arg): |
|
570 | def _display(self,arg): | |
571 | """Default printer method, uses pprint. |
|
571 | """Default printer method, uses pprint. | |
572 |
|
572 | |||
573 | Do ip.set_hook("result_display", my_displayhook) for custom result |
|
573 | Do ip.set_hook("result_display", my_displayhook) for custom result | |
574 | display, e.g. when your own objects need special formatting. |
|
574 | display, e.g. when your own objects need special formatting. | |
575 | """ |
|
575 | """ | |
576 | try: |
|
576 | try: | |
577 | return IPython.utils.generics.result_display(arg) |
|
577 | return IPython.utils.generics.result_display(arg) | |
578 | except TryNext: |
|
578 | except TryNext: | |
579 | return self.shell.hooks.result_display(arg) |
|
579 | return self.shell.hooks.result_display(arg) | |
580 |
|
580 | |||
581 | # Assign the default display method: |
|
581 | # Assign the default display method: | |
582 | display = _display |
|
582 | display = _display | |
583 |
|
583 | |||
584 | def update(self,arg): |
|
584 | def update(self,arg): | |
585 | #print '***cache_count', self.cache_count # dbg |
|
585 | #print '***cache_count', self.cache_count # dbg | |
586 | if len(self.user_ns['_oh']) >= self.cache_size and self.do_full_cache: |
|
586 | if len(self.user_ns['_oh']) >= self.cache_size and self.do_full_cache: | |
587 | warn('Output cache limit (currently '+ |
|
587 | warn('Output cache limit (currently '+ | |
588 | `self.cache_size`+' entries) hit.\n' |
|
588 | `self.cache_size`+' entries) hit.\n' | |
589 | 'Flushing cache and resetting history counter...\n' |
|
589 | 'Flushing cache and resetting history counter...\n' | |
590 | 'The only history variables available will be _,__,___ and _1\n' |
|
590 | 'The only history variables available will be _,__,___ and _1\n' | |
591 | 'with the current result.') |
|
591 | 'with the current result.') | |
592 |
|
592 | |||
593 | self.flush() |
|
593 | self.flush() | |
594 | # Don't overwrite '_' and friends if '_' is in __builtin__ (otherwise |
|
594 | # Don't overwrite '_' and friends if '_' is in __builtin__ (otherwise | |
595 | # we cause buggy behavior for things like gettext). |
|
595 | # we cause buggy behavior for things like gettext). | |
596 | if '_' not in __builtin__.__dict__: |
|
596 | if '_' not in __builtin__.__dict__: | |
597 | self.___ = self.__ |
|
597 | self.___ = self.__ | |
598 | self.__ = self._ |
|
598 | self.__ = self._ | |
599 | self._ = arg |
|
599 | self._ = arg | |
600 | self.user_ns.update({'_':self._,'__':self.__,'___':self.___}) |
|
600 | self.user_ns.update({'_':self._,'__':self.__,'___':self.___}) | |
601 |
|
601 | |||
602 | # hackish access to top-level namespace to create _1,_2... dynamically |
|
602 | # hackish access to top-level namespace to create _1,_2... dynamically | |
603 | to_main = {} |
|
603 | to_main = {} | |
604 | if self.do_full_cache: |
|
604 | if self.do_full_cache: | |
605 | new_result = '_'+`self.prompt_count` |
|
605 | new_result = '_'+`self.prompt_count` | |
606 | to_main[new_result] = arg |
|
606 | to_main[new_result] = arg | |
607 | self.user_ns.update(to_main) |
|
607 | self.user_ns.update(to_main) | |
608 | self.user_ns['_oh'][self.prompt_count] = arg |
|
608 | self.user_ns['_oh'][self.prompt_count] = arg | |
609 |
|
609 | |||
610 | def flush(self): |
|
610 | def flush(self): | |
611 | if not self.do_full_cache: |
|
611 | if not self.do_full_cache: | |
612 | raise ValueError,"You shouldn't have reached the cache flush "\ |
|
612 | raise ValueError,"You shouldn't have reached the cache flush "\ | |
613 | "if full caching is not enabled!" |
|
613 | "if full caching is not enabled!" | |
614 | # delete auto-generated vars from global namespace |
|
614 | # delete auto-generated vars from global namespace | |
615 |
|
615 | |||
616 | for n in range(1,self.prompt_count + 1): |
|
616 | for n in range(1,self.prompt_count + 1): | |
617 | key = '_'+`n` |
|
617 | key = '_'+`n` | |
618 | try: |
|
618 | try: | |
619 | del self.user_ns[key] |
|
619 | del self.user_ns[key] | |
620 | except: pass |
|
620 | except: pass | |
621 | self.user_ns['_oh'].clear() |
|
621 | self.user_ns['_oh'].clear() | |
622 |
|
622 | |||
623 | if '_' not in __builtin__.__dict__: |
|
623 | if '_' not in __builtin__.__dict__: | |
624 | self.user_ns.update({'_':None,'__':None, '___':None}) |
|
624 | self.user_ns.update({'_':None,'__':None, '___':None}) | |
625 | import gc |
|
625 | import gc | |
626 | gc.collect() # xxx needed? |
|
626 | gc.collect() # xxx needed? | |
627 |
|
627 |
@@ -1,1247 +1,1247 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """IPython Shell classes. |
|
2 | """IPython Shell classes. | |
3 |
|
3 | |||
4 | All the matplotlib support code was co-developed with John Hunter, |
|
4 | All the matplotlib support code was co-developed with John Hunter, | |
5 | matplotlib's author. |
|
5 | matplotlib's author. | |
6 | """ |
|
6 | """ | |
7 |
|
7 | |||
8 | #***************************************************************************** |
|
8 | #***************************************************************************** | |
9 | # Copyright (C) 2001-2006 Fernando Perez <fperez@colorado.edu> |
|
9 | # Copyright (C) 2001-2006 Fernando Perez <fperez@colorado.edu> | |
10 | # |
|
10 | # | |
11 | # Distributed under the terms of the BSD License. The full license is in |
|
11 | # Distributed under the terms of the BSD License. The full license is in | |
12 | # the file COPYING, distributed as part of this software. |
|
12 | # the file COPYING, distributed as part of this software. | |
13 | #***************************************************************************** |
|
13 | #***************************************************************************** | |
14 |
|
14 | |||
15 | # Code begins |
|
15 | # Code begins | |
16 | # Stdlib imports |
|
16 | # Stdlib imports | |
17 | import __builtin__ |
|
17 | import __builtin__ | |
18 | import __main__ |
|
18 | import __main__ | |
19 | import Queue |
|
19 | import Queue | |
20 | import inspect |
|
20 | import inspect | |
21 | import os |
|
21 | import os | |
22 | import sys |
|
22 | import sys | |
23 | import thread |
|
23 | import thread | |
24 | import threading |
|
24 | import threading | |
25 | import time |
|
25 | import time | |
26 |
|
26 | |||
27 | from signal import signal, SIGINT |
|
27 | from signal import signal, SIGINT | |
28 |
|
28 | |||
29 | try: |
|
29 | try: | |
30 | import ctypes |
|
30 | import ctypes | |
31 | HAS_CTYPES = True |
|
31 | HAS_CTYPES = True | |
32 | except ImportError: |
|
32 | except ImportError: | |
33 | HAS_CTYPES = False |
|
33 | HAS_CTYPES = False | |
34 |
|
34 | |||
35 | # IPython imports |
|
35 | # IPython imports | |
36 | import IPython |
|
36 | import IPython | |
37 | from IPython import ultraTB |
|
37 | from IPython import ultraTB | |
38 | from IPython.core import ipapi |
|
38 | from IPython.core import ipapi | |
39 | from IPython.Magic import Magic |
|
39 | from IPython.Magic import Magic | |
40 | from IPython.utils.genutils import Term,warn,error,flag_calls, ask_yes_no |
|
40 | from IPython.utils.genutils import Term,warn,error,flag_calls, ask_yes_no | |
41 | from IPython.core.iplib import InteractiveShell |
|
41 | from IPython.core.iplib import InteractiveShell | |
42 | from IPython.core.ipmaker import make_IPython |
|
42 | from IPython.core.ipmaker import make_IPython | |
43 | from IPython.ipstruct import Struct |
|
43 | from IPython.utils.ipstruct import Struct | |
44 | from IPython.testing import decorators as testdec |
|
44 | from IPython.testing import decorators as testdec | |
45 |
|
45 | |||
46 | # Globals |
|
46 | # Globals | |
47 | # global flag to pass around information about Ctrl-C without exceptions |
|
47 | # global flag to pass around information about Ctrl-C without exceptions | |
48 | KBINT = False |
|
48 | KBINT = False | |
49 |
|
49 | |||
50 | # global flag to turn on/off Tk support. |
|
50 | # global flag to turn on/off Tk support. | |
51 | USE_TK = False |
|
51 | USE_TK = False | |
52 |
|
52 | |||
53 | # ID for the main thread, used for cross-thread exceptions |
|
53 | # ID for the main thread, used for cross-thread exceptions | |
54 | MAIN_THREAD_ID = thread.get_ident() |
|
54 | MAIN_THREAD_ID = thread.get_ident() | |
55 |
|
55 | |||
56 | # Tag when runcode() is active, for exception handling |
|
56 | # Tag when runcode() is active, for exception handling | |
57 | CODE_RUN = None |
|
57 | CODE_RUN = None | |
58 |
|
58 | |||
59 | # Default timeout for waiting for multithreaded shells (in seconds) |
|
59 | # Default timeout for waiting for multithreaded shells (in seconds) | |
60 | GUI_TIMEOUT = 10 |
|
60 | GUI_TIMEOUT = 10 | |
61 |
|
61 | |||
62 | #----------------------------------------------------------------------------- |
|
62 | #----------------------------------------------------------------------------- | |
63 | # This class is trivial now, but I want to have it in to publish a clean |
|
63 | # This class is trivial now, but I want to have it in to publish a clean | |
64 | # interface. Later when the internals are reorganized, code that uses this |
|
64 | # interface. Later when the internals are reorganized, code that uses this | |
65 | # shouldn't have to change. |
|
65 | # shouldn't have to change. | |
66 |
|
66 | |||
67 | class IPShell: |
|
67 | class IPShell: | |
68 | """Create an IPython instance.""" |
|
68 | """Create an IPython instance.""" | |
69 |
|
69 | |||
70 | def __init__(self,argv=None,user_ns=None,user_global_ns=None, |
|
70 | def __init__(self,argv=None,user_ns=None,user_global_ns=None, | |
71 | debug=1,shell_class=InteractiveShell): |
|
71 | debug=1,shell_class=InteractiveShell): | |
72 | self.IP = make_IPython(argv,user_ns=user_ns, |
|
72 | self.IP = make_IPython(argv,user_ns=user_ns, | |
73 | user_global_ns=user_global_ns, |
|
73 | user_global_ns=user_global_ns, | |
74 | debug=debug,shell_class=shell_class) |
|
74 | debug=debug,shell_class=shell_class) | |
75 |
|
75 | |||
76 | def mainloop(self,sys_exit=0,banner=None): |
|
76 | def mainloop(self,sys_exit=0,banner=None): | |
77 | self.IP.mainloop(banner) |
|
77 | self.IP.mainloop(banner) | |
78 | if sys_exit: |
|
78 | if sys_exit: | |
79 | sys.exit() |
|
79 | sys.exit() | |
80 |
|
80 | |||
81 | #----------------------------------------------------------------------------- |
|
81 | #----------------------------------------------------------------------------- | |
82 | def kill_embedded(self,parameter_s=''): |
|
82 | def kill_embedded(self,parameter_s=''): | |
83 | """%kill_embedded : deactivate for good the current embedded IPython. |
|
83 | """%kill_embedded : deactivate for good the current embedded IPython. | |
84 |
|
84 | |||
85 | This function (after asking for confirmation) sets an internal flag so that |
|
85 | This function (after asking for confirmation) sets an internal flag so that | |
86 | an embedded IPython will never activate again. This is useful to |
|
86 | an embedded IPython will never activate again. This is useful to | |
87 | permanently disable a shell that is being called inside a loop: once you've |
|
87 | permanently disable a shell that is being called inside a loop: once you've | |
88 | figured out what you needed from it, you may then kill it and the program |
|
88 | figured out what you needed from it, you may then kill it and the program | |
89 | will then continue to run without the interactive shell interfering again. |
|
89 | will then continue to run without the interactive shell interfering again. | |
90 | """ |
|
90 | """ | |
91 |
|
91 | |||
92 | kill = ask_yes_no("Are you sure you want to kill this embedded instance " |
|
92 | kill = ask_yes_no("Are you sure you want to kill this embedded instance " | |
93 | "(y/n)? [y/N] ",'n') |
|
93 | "(y/n)? [y/N] ",'n') | |
94 | if kill: |
|
94 | if kill: | |
95 | self.shell.embedded_active = False |
|
95 | self.shell.embedded_active = False | |
96 | print "This embedded IPython will not reactivate anymore once you exit." |
|
96 | print "This embedded IPython will not reactivate anymore once you exit." | |
97 |
|
97 | |||
98 | class IPShellEmbed: |
|
98 | class IPShellEmbed: | |
99 | """Allow embedding an IPython shell into a running program. |
|
99 | """Allow embedding an IPython shell into a running program. | |
100 |
|
100 | |||
101 | Instances of this class are callable, with the __call__ method being an |
|
101 | Instances of this class are callable, with the __call__ method being an | |
102 | alias to the embed() method of an InteractiveShell instance. |
|
102 | alias to the embed() method of an InteractiveShell instance. | |
103 |
|
103 | |||
104 | Usage (see also the example-embed.py file for a running example): |
|
104 | Usage (see also the example-embed.py file for a running example): | |
105 |
|
105 | |||
106 | ipshell = IPShellEmbed([argv,banner,exit_msg,rc_override]) |
|
106 | ipshell = IPShellEmbed([argv,banner,exit_msg,rc_override]) | |
107 |
|
107 | |||
108 | - argv: list containing valid command-line options for IPython, as they |
|
108 | - argv: list containing valid command-line options for IPython, as they | |
109 | would appear in sys.argv[1:]. |
|
109 | would appear in sys.argv[1:]. | |
110 |
|
110 | |||
111 | For example, the following command-line options: |
|
111 | For example, the following command-line options: | |
112 |
|
112 | |||
113 | $ ipython -prompt_in1 'Input <\\#>' -colors LightBG |
|
113 | $ ipython -prompt_in1 'Input <\\#>' -colors LightBG | |
114 |
|
114 | |||
115 | would be passed in the argv list as: |
|
115 | would be passed in the argv list as: | |
116 |
|
116 | |||
117 | ['-prompt_in1','Input <\\#>','-colors','LightBG'] |
|
117 | ['-prompt_in1','Input <\\#>','-colors','LightBG'] | |
118 |
|
118 | |||
119 | - banner: string which gets printed every time the interpreter starts. |
|
119 | - banner: string which gets printed every time the interpreter starts. | |
120 |
|
120 | |||
121 | - exit_msg: string which gets printed every time the interpreter exits. |
|
121 | - exit_msg: string which gets printed every time the interpreter exits. | |
122 |
|
122 | |||
123 | - rc_override: a dict or Struct of configuration options such as those |
|
123 | - rc_override: a dict or Struct of configuration options such as those | |
124 | used by IPython. These options are read from your ~/.ipython/ipythonrc |
|
124 | used by IPython. These options are read from your ~/.ipython/ipythonrc | |
125 | file when the Shell object is created. Passing an explicit rc_override |
|
125 | file when the Shell object is created. Passing an explicit rc_override | |
126 | dict with any options you want allows you to override those values at |
|
126 | dict with any options you want allows you to override those values at | |
127 | creation time without having to modify the file. This way you can create |
|
127 | creation time without having to modify the file. This way you can create | |
128 | embeddable instances configured in any way you want without editing any |
|
128 | embeddable instances configured in any way you want without editing any | |
129 | global files (thus keeping your interactive IPython configuration |
|
129 | global files (thus keeping your interactive IPython configuration | |
130 | unchanged). |
|
130 | unchanged). | |
131 |
|
131 | |||
132 | Then the ipshell instance can be called anywhere inside your code: |
|
132 | Then the ipshell instance can be called anywhere inside your code: | |
133 |
|
133 | |||
134 | ipshell(header='') -> Opens up an IPython shell. |
|
134 | ipshell(header='') -> Opens up an IPython shell. | |
135 |
|
135 | |||
136 | - header: string printed by the IPython shell upon startup. This can let |
|
136 | - header: string printed by the IPython shell upon startup. This can let | |
137 | you know where in your code you are when dropping into the shell. Note |
|
137 | you know where in your code you are when dropping into the shell. Note | |
138 | that 'banner' gets prepended to all calls, so header is used for |
|
138 | that 'banner' gets prepended to all calls, so header is used for | |
139 | location-specific information. |
|
139 | location-specific information. | |
140 |
|
140 | |||
141 | For more details, see the __call__ method below. |
|
141 | For more details, see the __call__ method below. | |
142 |
|
142 | |||
143 | When the IPython shell is exited with Ctrl-D, normal program execution |
|
143 | When the IPython shell is exited with Ctrl-D, normal program execution | |
144 | resumes. |
|
144 | resumes. | |
145 |
|
145 | |||
146 | This functionality was inspired by a posting on comp.lang.python by cmkl |
|
146 | This functionality was inspired by a posting on comp.lang.python by cmkl | |
147 | <cmkleffner@gmx.de> on Dec. 06/01 concerning similar uses of pyrepl, and |
|
147 | <cmkleffner@gmx.de> on Dec. 06/01 concerning similar uses of pyrepl, and | |
148 | by the IDL stop/continue commands.""" |
|
148 | by the IDL stop/continue commands.""" | |
149 |
|
149 | |||
150 | def __init__(self,argv=None,banner='',exit_msg=None,rc_override=None, |
|
150 | def __init__(self,argv=None,banner='',exit_msg=None,rc_override=None, | |
151 | user_ns=None): |
|
151 | user_ns=None): | |
152 | """Note that argv here is a string, NOT a list.""" |
|
152 | """Note that argv here is a string, NOT a list.""" | |
153 | self.set_banner(banner) |
|
153 | self.set_banner(banner) | |
154 | self.set_exit_msg(exit_msg) |
|
154 | self.set_exit_msg(exit_msg) | |
155 | self.set_dummy_mode(0) |
|
155 | self.set_dummy_mode(0) | |
156 |
|
156 | |||
157 | # sys.displayhook is a global, we need to save the user's original |
|
157 | # sys.displayhook is a global, we need to save the user's original | |
158 | # Don't rely on __displayhook__, as the user may have changed that. |
|
158 | # Don't rely on __displayhook__, as the user may have changed that. | |
159 | self.sys_displayhook_ori = sys.displayhook |
|
159 | self.sys_displayhook_ori = sys.displayhook | |
160 |
|
160 | |||
161 | # save readline completer status |
|
161 | # save readline completer status | |
162 | try: |
|
162 | try: | |
163 | #print 'Save completer',sys.ipcompleter # dbg |
|
163 | #print 'Save completer',sys.ipcompleter # dbg | |
164 | self.sys_ipcompleter_ori = sys.ipcompleter |
|
164 | self.sys_ipcompleter_ori = sys.ipcompleter | |
165 | except: |
|
165 | except: | |
166 | pass # not nested with IPython |
|
166 | pass # not nested with IPython | |
167 |
|
167 | |||
168 | self.IP = make_IPython(argv,rc_override=rc_override, |
|
168 | self.IP = make_IPython(argv,rc_override=rc_override, | |
169 | embedded=True, |
|
169 | embedded=True, | |
170 | user_ns=user_ns) |
|
170 | user_ns=user_ns) | |
171 |
|
171 | |||
172 | ip = ipapi.IPApi(self.IP) |
|
172 | ip = ipapi.IPApi(self.IP) | |
173 | ip.expose_magic("kill_embedded",kill_embedded) |
|
173 | ip.expose_magic("kill_embedded",kill_embedded) | |
174 |
|
174 | |||
175 | # copy our own displayhook also |
|
175 | # copy our own displayhook also | |
176 | self.sys_displayhook_embed = sys.displayhook |
|
176 | self.sys_displayhook_embed = sys.displayhook | |
177 | # and leave the system's display hook clean |
|
177 | # and leave the system's display hook clean | |
178 | sys.displayhook = self.sys_displayhook_ori |
|
178 | sys.displayhook = self.sys_displayhook_ori | |
179 | # don't use the ipython crash handler so that user exceptions aren't |
|
179 | # don't use the ipython crash handler so that user exceptions aren't | |
180 | # trapped |
|
180 | # trapped | |
181 | sys.excepthook = ultraTB.FormattedTB(color_scheme = self.IP.rc.colors, |
|
181 | sys.excepthook = ultraTB.FormattedTB(color_scheme = self.IP.rc.colors, | |
182 | mode = self.IP.rc.xmode, |
|
182 | mode = self.IP.rc.xmode, | |
183 | call_pdb = self.IP.rc.pdb) |
|
183 | call_pdb = self.IP.rc.pdb) | |
184 | self.restore_system_completer() |
|
184 | self.restore_system_completer() | |
185 |
|
185 | |||
186 | def restore_system_completer(self): |
|
186 | def restore_system_completer(self): | |
187 | """Restores the readline completer which was in place. |
|
187 | """Restores the readline completer which was in place. | |
188 |
|
188 | |||
189 | This allows embedded IPython within IPython not to disrupt the |
|
189 | This allows embedded IPython within IPython not to disrupt the | |
190 | parent's completion. |
|
190 | parent's completion. | |
191 | """ |
|
191 | """ | |
192 |
|
192 | |||
193 | try: |
|
193 | try: | |
194 | self.IP.readline.set_completer(self.sys_ipcompleter_ori) |
|
194 | self.IP.readline.set_completer(self.sys_ipcompleter_ori) | |
195 | sys.ipcompleter = self.sys_ipcompleter_ori |
|
195 | sys.ipcompleter = self.sys_ipcompleter_ori | |
196 | except: |
|
196 | except: | |
197 | pass |
|
197 | pass | |
198 |
|
198 | |||
199 | def __call__(self,header='',local_ns=None,global_ns=None,dummy=None): |
|
199 | def __call__(self,header='',local_ns=None,global_ns=None,dummy=None): | |
200 | """Activate the interactive interpreter. |
|
200 | """Activate the interactive interpreter. | |
201 |
|
201 | |||
202 | __call__(self,header='',local_ns=None,global_ns,dummy=None) -> Start |
|
202 | __call__(self,header='',local_ns=None,global_ns,dummy=None) -> Start | |
203 | the interpreter shell with the given local and global namespaces, and |
|
203 | the interpreter shell with the given local and global namespaces, and | |
204 | optionally print a header string at startup. |
|
204 | optionally print a header string at startup. | |
205 |
|
205 | |||
206 | The shell can be globally activated/deactivated using the |
|
206 | The shell can be globally activated/deactivated using the | |
207 | set/get_dummy_mode methods. This allows you to turn off a shell used |
|
207 | set/get_dummy_mode methods. This allows you to turn off a shell used | |
208 | for debugging globally. |
|
208 | for debugging globally. | |
209 |
|
209 | |||
210 | However, *each* time you call the shell you can override the current |
|
210 | However, *each* time you call the shell you can override the current | |
211 | state of dummy_mode with the optional keyword parameter 'dummy'. For |
|
211 | state of dummy_mode with the optional keyword parameter 'dummy'. For | |
212 | example, if you set dummy mode on with IPShell.set_dummy_mode(1), you |
|
212 | example, if you set dummy mode on with IPShell.set_dummy_mode(1), you | |
213 | can still have a specific call work by making it as IPShell(dummy=0). |
|
213 | can still have a specific call work by making it as IPShell(dummy=0). | |
214 |
|
214 | |||
215 | The optional keyword parameter dummy controls whether the call |
|
215 | The optional keyword parameter dummy controls whether the call | |
216 | actually does anything. """ |
|
216 | actually does anything. """ | |
217 |
|
217 | |||
218 | # If the user has turned it off, go away |
|
218 | # If the user has turned it off, go away | |
219 | if not self.IP.embedded_active: |
|
219 | if not self.IP.embedded_active: | |
220 | return |
|
220 | return | |
221 |
|
221 | |||
222 | # Normal exits from interactive mode set this flag, so the shell can't |
|
222 | # Normal exits from interactive mode set this flag, so the shell can't | |
223 | # re-enter (it checks this variable at the start of interactive mode). |
|
223 | # re-enter (it checks this variable at the start of interactive mode). | |
224 | self.IP.exit_now = False |
|
224 | self.IP.exit_now = False | |
225 |
|
225 | |||
226 | # Allow the dummy parameter to override the global __dummy_mode |
|
226 | # Allow the dummy parameter to override the global __dummy_mode | |
227 | if dummy or (dummy != 0 and self.__dummy_mode): |
|
227 | if dummy or (dummy != 0 and self.__dummy_mode): | |
228 | return |
|
228 | return | |
229 |
|
229 | |||
230 | # Set global subsystems (display,completions) to our values |
|
230 | # Set global subsystems (display,completions) to our values | |
231 | sys.displayhook = self.sys_displayhook_embed |
|
231 | sys.displayhook = self.sys_displayhook_embed | |
232 | if self.IP.has_readline: |
|
232 | if self.IP.has_readline: | |
233 | self.IP.set_completer() |
|
233 | self.IP.set_completer() | |
234 |
|
234 | |||
235 | if self.banner and header: |
|
235 | if self.banner and header: | |
236 | format = '%s\n%s\n' |
|
236 | format = '%s\n%s\n' | |
237 | else: |
|
237 | else: | |
238 | format = '%s%s\n' |
|
238 | format = '%s%s\n' | |
239 | banner = format % (self.banner,header) |
|
239 | banner = format % (self.banner,header) | |
240 |
|
240 | |||
241 | # Call the embedding code with a stack depth of 1 so it can skip over |
|
241 | # Call the embedding code with a stack depth of 1 so it can skip over | |
242 | # our call and get the original caller's namespaces. |
|
242 | # our call and get the original caller's namespaces. | |
243 | self.IP.embed_mainloop(banner,local_ns,global_ns,stack_depth=1) |
|
243 | self.IP.embed_mainloop(banner,local_ns,global_ns,stack_depth=1) | |
244 |
|
244 | |||
245 | if self.exit_msg: |
|
245 | if self.exit_msg: | |
246 | print self.exit_msg |
|
246 | print self.exit_msg | |
247 |
|
247 | |||
248 | # Restore global systems (display, completion) |
|
248 | # Restore global systems (display, completion) | |
249 | sys.displayhook = self.sys_displayhook_ori |
|
249 | sys.displayhook = self.sys_displayhook_ori | |
250 | self.restore_system_completer() |
|
250 | self.restore_system_completer() | |
251 |
|
251 | |||
252 | def set_dummy_mode(self,dummy): |
|
252 | def set_dummy_mode(self,dummy): | |
253 | """Sets the embeddable shell's dummy mode parameter. |
|
253 | """Sets the embeddable shell's dummy mode parameter. | |
254 |
|
254 | |||
255 | set_dummy_mode(dummy): dummy = 0 or 1. |
|
255 | set_dummy_mode(dummy): dummy = 0 or 1. | |
256 |
|
256 | |||
257 | This parameter is persistent and makes calls to the embeddable shell |
|
257 | This parameter is persistent and makes calls to the embeddable shell | |
258 | silently return without performing any action. This allows you to |
|
258 | silently return without performing any action. This allows you to | |
259 | globally activate or deactivate a shell you're using with a single call. |
|
259 | globally activate or deactivate a shell you're using with a single call. | |
260 |
|
260 | |||
261 | If you need to manually""" |
|
261 | If you need to manually""" | |
262 |
|
262 | |||
263 | if dummy not in [0,1,False,True]: |
|
263 | if dummy not in [0,1,False,True]: | |
264 | raise ValueError,'dummy parameter must be boolean' |
|
264 | raise ValueError,'dummy parameter must be boolean' | |
265 | self.__dummy_mode = dummy |
|
265 | self.__dummy_mode = dummy | |
266 |
|
266 | |||
267 | def get_dummy_mode(self): |
|
267 | def get_dummy_mode(self): | |
268 | """Return the current value of the dummy mode parameter. |
|
268 | """Return the current value of the dummy mode parameter. | |
269 | """ |
|
269 | """ | |
270 | return self.__dummy_mode |
|
270 | return self.__dummy_mode | |
271 |
|
271 | |||
272 | def set_banner(self,banner): |
|
272 | def set_banner(self,banner): | |
273 | """Sets the global banner. |
|
273 | """Sets the global banner. | |
274 |
|
274 | |||
275 | This banner gets prepended to every header printed when the shell |
|
275 | This banner gets prepended to every header printed when the shell | |
276 | instance is called.""" |
|
276 | instance is called.""" | |
277 |
|
277 | |||
278 | self.banner = banner |
|
278 | self.banner = banner | |
279 |
|
279 | |||
280 | def set_exit_msg(self,exit_msg): |
|
280 | def set_exit_msg(self,exit_msg): | |
281 | """Sets the global exit_msg. |
|
281 | """Sets the global exit_msg. | |
282 |
|
282 | |||
283 | This exit message gets printed upon exiting every time the embedded |
|
283 | This exit message gets printed upon exiting every time the embedded | |
284 | shell is called. It is None by default. """ |
|
284 | shell is called. It is None by default. """ | |
285 |
|
285 | |||
286 | self.exit_msg = exit_msg |
|
286 | self.exit_msg = exit_msg | |
287 |
|
287 | |||
288 | #----------------------------------------------------------------------------- |
|
288 | #----------------------------------------------------------------------------- | |
289 | if HAS_CTYPES: |
|
289 | if HAS_CTYPES: | |
290 | # Add async exception support. Trick taken from: |
|
290 | # Add async exception support. Trick taken from: | |
291 | # http://sebulba.wikispaces.com/recipe+thread2 |
|
291 | # http://sebulba.wikispaces.com/recipe+thread2 | |
292 | def _async_raise(tid, exctype): |
|
292 | def _async_raise(tid, exctype): | |
293 | """raises the exception, performs cleanup if needed""" |
|
293 | """raises the exception, performs cleanup if needed""" | |
294 | if not inspect.isclass(exctype): |
|
294 | if not inspect.isclass(exctype): | |
295 | raise TypeError("Only types can be raised (not instances)") |
|
295 | raise TypeError("Only types can be raised (not instances)") | |
296 | # Explicit cast to c_long is necessary for 64-bit support: |
|
296 | # Explicit cast to c_long is necessary for 64-bit support: | |
297 | # See https://bugs.launchpad.net/ipython/+bug/237073 |
|
297 | # See https://bugs.launchpad.net/ipython/+bug/237073 | |
298 | res = ctypes.pythonapi.PyThreadState_SetAsyncExc(ctypes.c_long(tid), |
|
298 | res = ctypes.pythonapi.PyThreadState_SetAsyncExc(ctypes.c_long(tid), | |
299 | ctypes.py_object(exctype)) |
|
299 | ctypes.py_object(exctype)) | |
300 | if res == 0: |
|
300 | if res == 0: | |
301 | raise ValueError("invalid thread id") |
|
301 | raise ValueError("invalid thread id") | |
302 | elif res != 1: |
|
302 | elif res != 1: | |
303 | # If it returns a number greater than one, you're in trouble, |
|
303 | # If it returns a number greater than one, you're in trouble, | |
304 | # and you should call it again with exc=NULL to revert the effect |
|
304 | # and you should call it again with exc=NULL to revert the effect | |
305 | ctypes.pythonapi.PyThreadState_SetAsyncExc(tid, 0) |
|
305 | ctypes.pythonapi.PyThreadState_SetAsyncExc(tid, 0) | |
306 | raise SystemError("PyThreadState_SetAsyncExc failed") |
|
306 | raise SystemError("PyThreadState_SetAsyncExc failed") | |
307 |
|
307 | |||
308 | def sigint_handler(signum,stack_frame): |
|
308 | def sigint_handler(signum,stack_frame): | |
309 | """Sigint handler for threaded apps. |
|
309 | """Sigint handler for threaded apps. | |
310 |
|
310 | |||
311 | This is a horrible hack to pass information about SIGINT _without_ |
|
311 | This is a horrible hack to pass information about SIGINT _without_ | |
312 | using exceptions, since I haven't been able to properly manage |
|
312 | using exceptions, since I haven't been able to properly manage | |
313 | cross-thread exceptions in GTK/WX. In fact, I don't think it can be |
|
313 | cross-thread exceptions in GTK/WX. In fact, I don't think it can be | |
314 | done (or at least that's my understanding from a c.l.py thread where |
|
314 | done (or at least that's my understanding from a c.l.py thread where | |
315 | this was discussed).""" |
|
315 | this was discussed).""" | |
316 |
|
316 | |||
317 | global KBINT |
|
317 | global KBINT | |
318 |
|
318 | |||
319 | if CODE_RUN: |
|
319 | if CODE_RUN: | |
320 | _async_raise(MAIN_THREAD_ID,KeyboardInterrupt) |
|
320 | _async_raise(MAIN_THREAD_ID,KeyboardInterrupt) | |
321 | else: |
|
321 | else: | |
322 | KBINT = True |
|
322 | KBINT = True | |
323 | print '\nKeyboardInterrupt - Press <Enter> to continue.', |
|
323 | print '\nKeyboardInterrupt - Press <Enter> to continue.', | |
324 | Term.cout.flush() |
|
324 | Term.cout.flush() | |
325 |
|
325 | |||
326 | else: |
|
326 | else: | |
327 | def sigint_handler(signum,stack_frame): |
|
327 | def sigint_handler(signum,stack_frame): | |
328 | """Sigint handler for threaded apps. |
|
328 | """Sigint handler for threaded apps. | |
329 |
|
329 | |||
330 | This is a horrible hack to pass information about SIGINT _without_ |
|
330 | This is a horrible hack to pass information about SIGINT _without_ | |
331 | using exceptions, since I haven't been able to properly manage |
|
331 | using exceptions, since I haven't been able to properly manage | |
332 | cross-thread exceptions in GTK/WX. In fact, I don't think it can be |
|
332 | cross-thread exceptions in GTK/WX. In fact, I don't think it can be | |
333 | done (or at least that's my understanding from a c.l.py thread where |
|
333 | done (or at least that's my understanding from a c.l.py thread where | |
334 | this was discussed).""" |
|
334 | this was discussed).""" | |
335 |
|
335 | |||
336 | global KBINT |
|
336 | global KBINT | |
337 |
|
337 | |||
338 | print '\nKeyboardInterrupt - Press <Enter> to continue.', |
|
338 | print '\nKeyboardInterrupt - Press <Enter> to continue.', | |
339 | Term.cout.flush() |
|
339 | Term.cout.flush() | |
340 | # Set global flag so that runsource can know that Ctrl-C was hit |
|
340 | # Set global flag so that runsource can know that Ctrl-C was hit | |
341 | KBINT = True |
|
341 | KBINT = True | |
342 |
|
342 | |||
343 |
|
343 | |||
344 | class MTInteractiveShell(InteractiveShell): |
|
344 | class MTInteractiveShell(InteractiveShell): | |
345 | """Simple multi-threaded shell.""" |
|
345 | """Simple multi-threaded shell.""" | |
346 |
|
346 | |||
347 | # Threading strategy taken from: |
|
347 | # Threading strategy taken from: | |
348 | # http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/65109, by Brian |
|
348 | # http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/65109, by Brian | |
349 | # McErlean and John Finlay. Modified with corrections by Antoon Pardon, |
|
349 | # McErlean and John Finlay. Modified with corrections by Antoon Pardon, | |
350 | # from the pygtk mailing list, to avoid lockups with system calls. |
|
350 | # from the pygtk mailing list, to avoid lockups with system calls. | |
351 |
|
351 | |||
352 | # class attribute to indicate whether the class supports threads or not. |
|
352 | # class attribute to indicate whether the class supports threads or not. | |
353 | # Subclasses with thread support should override this as needed. |
|
353 | # Subclasses with thread support should override this as needed. | |
354 | isthreaded = True |
|
354 | isthreaded = True | |
355 |
|
355 | |||
356 | def __init__(self,name,usage=None,rc=Struct(opts=None,args=None), |
|
356 | def __init__(self,name,usage=None,rc=Struct(opts=None,args=None), | |
357 | user_ns=None,user_global_ns=None,banner2='', |
|
357 | user_ns=None,user_global_ns=None,banner2='', | |
358 | gui_timeout=GUI_TIMEOUT,**kw): |
|
358 | gui_timeout=GUI_TIMEOUT,**kw): | |
359 | """Similar to the normal InteractiveShell, but with threading control""" |
|
359 | """Similar to the normal InteractiveShell, but with threading control""" | |
360 |
|
360 | |||
361 | InteractiveShell.__init__(self,name,usage,rc,user_ns, |
|
361 | InteractiveShell.__init__(self,name,usage,rc,user_ns, | |
362 | user_global_ns,banner2) |
|
362 | user_global_ns,banner2) | |
363 |
|
363 | |||
364 | # Timeout we wait for GUI thread |
|
364 | # Timeout we wait for GUI thread | |
365 | self.gui_timeout = gui_timeout |
|
365 | self.gui_timeout = gui_timeout | |
366 |
|
366 | |||
367 | # A queue to hold the code to be executed. |
|
367 | # A queue to hold the code to be executed. | |
368 | self.code_queue = Queue.Queue() |
|
368 | self.code_queue = Queue.Queue() | |
369 |
|
369 | |||
370 | # Stuff to do at closing time |
|
370 | # Stuff to do at closing time | |
371 | self._kill = None |
|
371 | self._kill = None | |
372 | on_kill = kw.get('on_kill', []) |
|
372 | on_kill = kw.get('on_kill', []) | |
373 | # Check that all things to kill are callable: |
|
373 | # Check that all things to kill are callable: | |
374 | for t in on_kill: |
|
374 | for t in on_kill: | |
375 | if not callable(t): |
|
375 | if not callable(t): | |
376 | raise TypeError,'on_kill must be a list of callables' |
|
376 | raise TypeError,'on_kill must be a list of callables' | |
377 | self.on_kill = on_kill |
|
377 | self.on_kill = on_kill | |
378 | # thread identity of the "worker thread" (that may execute code directly) |
|
378 | # thread identity of the "worker thread" (that may execute code directly) | |
379 | self.worker_ident = None |
|
379 | self.worker_ident = None | |
380 |
|
380 | |||
381 | def runsource(self, source, filename="<input>", symbol="single"): |
|
381 | def runsource(self, source, filename="<input>", symbol="single"): | |
382 | """Compile and run some source in the interpreter. |
|
382 | """Compile and run some source in the interpreter. | |
383 |
|
383 | |||
384 | Modified version of code.py's runsource(), to handle threading issues. |
|
384 | Modified version of code.py's runsource(), to handle threading issues. | |
385 | See the original for full docstring details.""" |
|
385 | See the original for full docstring details.""" | |
386 |
|
386 | |||
387 | global KBINT |
|
387 | global KBINT | |
388 |
|
388 | |||
389 | # If Ctrl-C was typed, we reset the flag and return right away |
|
389 | # If Ctrl-C was typed, we reset the flag and return right away | |
390 | if KBINT: |
|
390 | if KBINT: | |
391 | KBINT = False |
|
391 | KBINT = False | |
392 | return False |
|
392 | return False | |
393 |
|
393 | |||
394 | if self._kill: |
|
394 | if self._kill: | |
395 | # can't queue new code if we are being killed |
|
395 | # can't queue new code if we are being killed | |
396 | return True |
|
396 | return True | |
397 |
|
397 | |||
398 | try: |
|
398 | try: | |
399 | code = self.compile(source, filename, symbol) |
|
399 | code = self.compile(source, filename, symbol) | |
400 | except (OverflowError, SyntaxError, ValueError): |
|
400 | except (OverflowError, SyntaxError, ValueError): | |
401 | # Case 1 |
|
401 | # Case 1 | |
402 | self.showsyntaxerror(filename) |
|
402 | self.showsyntaxerror(filename) | |
403 | return False |
|
403 | return False | |
404 |
|
404 | |||
405 | if code is None: |
|
405 | if code is None: | |
406 | # Case 2 |
|
406 | # Case 2 | |
407 | return True |
|
407 | return True | |
408 |
|
408 | |||
409 | # shortcut - if we are in worker thread, or the worker thread is not |
|
409 | # shortcut - if we are in worker thread, or the worker thread is not | |
410 | # running, execute directly (to allow recursion and prevent deadlock if |
|
410 | # running, execute directly (to allow recursion and prevent deadlock if | |
411 | # code is run early in IPython construction) |
|
411 | # code is run early in IPython construction) | |
412 |
|
412 | |||
413 | if (self.worker_ident is None |
|
413 | if (self.worker_ident is None | |
414 | or self.worker_ident == thread.get_ident() ): |
|
414 | or self.worker_ident == thread.get_ident() ): | |
415 | InteractiveShell.runcode(self,code) |
|
415 | InteractiveShell.runcode(self,code) | |
416 | return False |
|
416 | return False | |
417 |
|
417 | |||
418 | # Case 3 |
|
418 | # Case 3 | |
419 | # Store code in queue, so the execution thread can handle it. |
|
419 | # Store code in queue, so the execution thread can handle it. | |
420 |
|
420 | |||
421 | completed_ev, received_ev = threading.Event(), threading.Event() |
|
421 | completed_ev, received_ev = threading.Event(), threading.Event() | |
422 |
|
422 | |||
423 | self.code_queue.put((code,completed_ev, received_ev)) |
|
423 | self.code_queue.put((code,completed_ev, received_ev)) | |
424 | # first make sure the message was received, with timeout |
|
424 | # first make sure the message was received, with timeout | |
425 | received_ev.wait(self.gui_timeout) |
|
425 | received_ev.wait(self.gui_timeout) | |
426 | if not received_ev.isSet(): |
|
426 | if not received_ev.isSet(): | |
427 | # the mainloop is dead, start executing code directly |
|
427 | # the mainloop is dead, start executing code directly | |
428 | print "Warning: Timeout for mainloop thread exceeded" |
|
428 | print "Warning: Timeout for mainloop thread exceeded" | |
429 | print "switching to nonthreaded mode (until mainloop wakes up again)" |
|
429 | print "switching to nonthreaded mode (until mainloop wakes up again)" | |
430 | self.worker_ident = None |
|
430 | self.worker_ident = None | |
431 | else: |
|
431 | else: | |
432 | completed_ev.wait() |
|
432 | completed_ev.wait() | |
433 | return False |
|
433 | return False | |
434 |
|
434 | |||
435 | def runcode(self): |
|
435 | def runcode(self): | |
436 | """Execute a code object. |
|
436 | """Execute a code object. | |
437 |
|
437 | |||
438 | Multithreaded wrapper around IPython's runcode().""" |
|
438 | Multithreaded wrapper around IPython's runcode().""" | |
439 |
|
439 | |||
440 | global CODE_RUN |
|
440 | global CODE_RUN | |
441 |
|
441 | |||
442 | # we are in worker thread, stash out the id for runsource() |
|
442 | # we are in worker thread, stash out the id for runsource() | |
443 | self.worker_ident = thread.get_ident() |
|
443 | self.worker_ident = thread.get_ident() | |
444 |
|
444 | |||
445 | if self._kill: |
|
445 | if self._kill: | |
446 | print >>Term.cout, 'Closing threads...', |
|
446 | print >>Term.cout, 'Closing threads...', | |
447 | Term.cout.flush() |
|
447 | Term.cout.flush() | |
448 | for tokill in self.on_kill: |
|
448 | for tokill in self.on_kill: | |
449 | tokill() |
|
449 | tokill() | |
450 | print >>Term.cout, 'Done.' |
|
450 | print >>Term.cout, 'Done.' | |
451 | # allow kill() to return |
|
451 | # allow kill() to return | |
452 | self._kill.set() |
|
452 | self._kill.set() | |
453 | return True |
|
453 | return True | |
454 |
|
454 | |||
455 | # Install sigint handler. We do it every time to ensure that if user |
|
455 | # Install sigint handler. We do it every time to ensure that if user | |
456 | # code modifies it, we restore our own handling. |
|
456 | # code modifies it, we restore our own handling. | |
457 | try: |
|
457 | try: | |
458 | signal(SIGINT,sigint_handler) |
|
458 | signal(SIGINT,sigint_handler) | |
459 | except SystemError: |
|
459 | except SystemError: | |
460 | # This happens under Windows, which seems to have all sorts |
|
460 | # This happens under Windows, which seems to have all sorts | |
461 | # of problems with signal handling. Oh well... |
|
461 | # of problems with signal handling. Oh well... | |
462 | pass |
|
462 | pass | |
463 |
|
463 | |||
464 | # Flush queue of pending code by calling the run methood of the parent |
|
464 | # Flush queue of pending code by calling the run methood of the parent | |
465 | # class with all items which may be in the queue. |
|
465 | # class with all items which may be in the queue. | |
466 | code_to_run = None |
|
466 | code_to_run = None | |
467 | while 1: |
|
467 | while 1: | |
468 | try: |
|
468 | try: | |
469 | code_to_run, completed_ev, received_ev = self.code_queue.get_nowait() |
|
469 | code_to_run, completed_ev, received_ev = self.code_queue.get_nowait() | |
470 | except Queue.Empty: |
|
470 | except Queue.Empty: | |
471 | break |
|
471 | break | |
472 | received_ev.set() |
|
472 | received_ev.set() | |
473 |
|
473 | |||
474 | # Exceptions need to be raised differently depending on which |
|
474 | # Exceptions need to be raised differently depending on which | |
475 | # thread is active. This convoluted try/except is only there to |
|
475 | # thread is active. This convoluted try/except is only there to | |
476 | # protect against asynchronous exceptions, to ensure that a KBINT |
|
476 | # protect against asynchronous exceptions, to ensure that a KBINT | |
477 | # at the wrong time doesn't deadlock everything. The global |
|
477 | # at the wrong time doesn't deadlock everything. The global | |
478 | # CODE_TO_RUN is set to true/false as close as possible to the |
|
478 | # CODE_TO_RUN is set to true/false as close as possible to the | |
479 | # runcode() call, so that the KBINT handler is correctly informed. |
|
479 | # runcode() call, so that the KBINT handler is correctly informed. | |
480 | try: |
|
480 | try: | |
481 | try: |
|
481 | try: | |
482 | CODE_RUN = True |
|
482 | CODE_RUN = True | |
483 | InteractiveShell.runcode(self,code_to_run) |
|
483 | InteractiveShell.runcode(self,code_to_run) | |
484 | except KeyboardInterrupt: |
|
484 | except KeyboardInterrupt: | |
485 | print "Keyboard interrupted in mainloop" |
|
485 | print "Keyboard interrupted in mainloop" | |
486 | while not self.code_queue.empty(): |
|
486 | while not self.code_queue.empty(): | |
487 | code, ev1,ev2 = self.code_queue.get_nowait() |
|
487 | code, ev1,ev2 = self.code_queue.get_nowait() | |
488 | ev1.set() |
|
488 | ev1.set() | |
489 | ev2.set() |
|
489 | ev2.set() | |
490 | break |
|
490 | break | |
491 | finally: |
|
491 | finally: | |
492 | CODE_RUN = False |
|
492 | CODE_RUN = False | |
493 | # allow runsource() return from wait |
|
493 | # allow runsource() return from wait | |
494 | completed_ev.set() |
|
494 | completed_ev.set() | |
495 |
|
495 | |||
496 |
|
496 | |||
497 | # This MUST return true for gtk threading to work |
|
497 | # This MUST return true for gtk threading to work | |
498 | return True |
|
498 | return True | |
499 |
|
499 | |||
500 | def kill(self): |
|
500 | def kill(self): | |
501 | """Kill the thread, returning when it has been shut down.""" |
|
501 | """Kill the thread, returning when it has been shut down.""" | |
502 | self._kill = threading.Event() |
|
502 | self._kill = threading.Event() | |
503 | self._kill.wait() |
|
503 | self._kill.wait() | |
504 |
|
504 | |||
505 | class MatplotlibShellBase: |
|
505 | class MatplotlibShellBase: | |
506 | """Mixin class to provide the necessary modifications to regular IPython |
|
506 | """Mixin class to provide the necessary modifications to regular IPython | |
507 | shell classes for matplotlib support. |
|
507 | shell classes for matplotlib support. | |
508 |
|
508 | |||
509 | Given Python's MRO, this should be used as the FIRST class in the |
|
509 | Given Python's MRO, this should be used as the FIRST class in the | |
510 | inheritance hierarchy, so that it overrides the relevant methods.""" |
|
510 | inheritance hierarchy, so that it overrides the relevant methods.""" | |
511 |
|
511 | |||
512 | def _matplotlib_config(self,name,user_ns,user_global_ns=None): |
|
512 | def _matplotlib_config(self,name,user_ns,user_global_ns=None): | |
513 | """Return items needed to setup the user's shell with matplotlib""" |
|
513 | """Return items needed to setup the user's shell with matplotlib""" | |
514 |
|
514 | |||
515 | # Initialize matplotlib to interactive mode always |
|
515 | # Initialize matplotlib to interactive mode always | |
516 | import matplotlib |
|
516 | import matplotlib | |
517 | from matplotlib import backends |
|
517 | from matplotlib import backends | |
518 | matplotlib.interactive(True) |
|
518 | matplotlib.interactive(True) | |
519 |
|
519 | |||
520 | def use(arg): |
|
520 | def use(arg): | |
521 | """IPython wrapper for matplotlib's backend switcher. |
|
521 | """IPython wrapper for matplotlib's backend switcher. | |
522 |
|
522 | |||
523 | In interactive use, we can not allow switching to a different |
|
523 | In interactive use, we can not allow switching to a different | |
524 | interactive backend, since thread conflicts will most likely crash |
|
524 | interactive backend, since thread conflicts will most likely crash | |
525 | the python interpreter. This routine does a safety check first, |
|
525 | the python interpreter. This routine does a safety check first, | |
526 | and refuses to perform a dangerous switch. It still allows |
|
526 | and refuses to perform a dangerous switch. It still allows | |
527 | switching to non-interactive backends.""" |
|
527 | switching to non-interactive backends.""" | |
528 |
|
528 | |||
529 | if arg in backends.interactive_bk and arg != self.mpl_backend: |
|
529 | if arg in backends.interactive_bk and arg != self.mpl_backend: | |
530 | m=('invalid matplotlib backend switch.\n' |
|
530 | m=('invalid matplotlib backend switch.\n' | |
531 | 'This script attempted to switch to the interactive ' |
|
531 | 'This script attempted to switch to the interactive ' | |
532 | 'backend: `%s`\n' |
|
532 | 'backend: `%s`\n' | |
533 | 'Your current choice of interactive backend is: `%s`\n\n' |
|
533 | 'Your current choice of interactive backend is: `%s`\n\n' | |
534 | 'Switching interactive matplotlib backends at runtime\n' |
|
534 | 'Switching interactive matplotlib backends at runtime\n' | |
535 | 'would crash the python interpreter, ' |
|
535 | 'would crash the python interpreter, ' | |
536 | 'and IPython has blocked it.\n\n' |
|
536 | 'and IPython has blocked it.\n\n' | |
537 | 'You need to either change your choice of matplotlib backend\n' |
|
537 | 'You need to either change your choice of matplotlib backend\n' | |
538 | 'by editing your .matplotlibrc file, or run this script as a \n' |
|
538 | 'by editing your .matplotlibrc file, or run this script as a \n' | |
539 | 'standalone file from the command line, not using IPython.\n' % |
|
539 | 'standalone file from the command line, not using IPython.\n' % | |
540 | (arg,self.mpl_backend) ) |
|
540 | (arg,self.mpl_backend) ) | |
541 | raise RuntimeError, m |
|
541 | raise RuntimeError, m | |
542 | else: |
|
542 | else: | |
543 | self.mpl_use(arg) |
|
543 | self.mpl_use(arg) | |
544 | self.mpl_use._called = True |
|
544 | self.mpl_use._called = True | |
545 |
|
545 | |||
546 | self.matplotlib = matplotlib |
|
546 | self.matplotlib = matplotlib | |
547 | self.mpl_backend = matplotlib.rcParams['backend'] |
|
547 | self.mpl_backend = matplotlib.rcParams['backend'] | |
548 |
|
548 | |||
549 | # we also need to block switching of interactive backends by use() |
|
549 | # we also need to block switching of interactive backends by use() | |
550 | self.mpl_use = matplotlib.use |
|
550 | self.mpl_use = matplotlib.use | |
551 | self.mpl_use._called = False |
|
551 | self.mpl_use._called = False | |
552 | # overwrite the original matplotlib.use with our wrapper |
|
552 | # overwrite the original matplotlib.use with our wrapper | |
553 | matplotlib.use = use |
|
553 | matplotlib.use = use | |
554 |
|
554 | |||
555 | # This must be imported last in the matplotlib series, after |
|
555 | # This must be imported last in the matplotlib series, after | |
556 | # backend/interactivity choices have been made |
|
556 | # backend/interactivity choices have been made | |
557 | import matplotlib.pylab as pylab |
|
557 | import matplotlib.pylab as pylab | |
558 | self.pylab = pylab |
|
558 | self.pylab = pylab | |
559 |
|
559 | |||
560 | self.pylab.show._needmain = False |
|
560 | self.pylab.show._needmain = False | |
561 | # We need to detect at runtime whether show() is called by the user. |
|
561 | # We need to detect at runtime whether show() is called by the user. | |
562 | # For this, we wrap it into a decorator which adds a 'called' flag. |
|
562 | # For this, we wrap it into a decorator which adds a 'called' flag. | |
563 | self.pylab.draw_if_interactive = flag_calls(self.pylab.draw_if_interactive) |
|
563 | self.pylab.draw_if_interactive = flag_calls(self.pylab.draw_if_interactive) | |
564 |
|
564 | |||
565 | # Build a user namespace initialized with matplotlib/matlab features. |
|
565 | # Build a user namespace initialized with matplotlib/matlab features. | |
566 | user_ns, user_global_ns = ipapi.make_user_namespaces(user_ns, |
|
566 | user_ns, user_global_ns = ipapi.make_user_namespaces(user_ns, | |
567 | user_global_ns) |
|
567 | user_global_ns) | |
568 |
|
568 | |||
569 | # Import numpy as np/pyplot as plt are conventions we're trying to |
|
569 | # Import numpy as np/pyplot as plt are conventions we're trying to | |
570 | # somewhat standardize on. Making them available to users by default |
|
570 | # somewhat standardize on. Making them available to users by default | |
571 | # will greatly help this. |
|
571 | # will greatly help this. | |
572 | exec ("import numpy\n" |
|
572 | exec ("import numpy\n" | |
573 | "import numpy as np\n" |
|
573 | "import numpy as np\n" | |
574 | "import matplotlib\n" |
|
574 | "import matplotlib\n" | |
575 | "import matplotlib.pylab as pylab\n" |
|
575 | "import matplotlib.pylab as pylab\n" | |
576 | "try:\n" |
|
576 | "try:\n" | |
577 | " import matplotlib.pyplot as plt\n" |
|
577 | " import matplotlib.pyplot as plt\n" | |
578 | "except ImportError:\n" |
|
578 | "except ImportError:\n" | |
579 | " pass\n" |
|
579 | " pass\n" | |
580 | ) in user_ns |
|
580 | ) in user_ns | |
581 |
|
581 | |||
582 | # Build matplotlib info banner |
|
582 | # Build matplotlib info banner | |
583 | b=""" |
|
583 | b=""" | |
584 | Welcome to pylab, a matplotlib-based Python environment. |
|
584 | Welcome to pylab, a matplotlib-based Python environment. | |
585 | For more information, type 'help(pylab)'. |
|
585 | For more information, type 'help(pylab)'. | |
586 | """ |
|
586 | """ | |
587 | return user_ns,user_global_ns,b |
|
587 | return user_ns,user_global_ns,b | |
588 |
|
588 | |||
589 | def mplot_exec(self,fname,*where,**kw): |
|
589 | def mplot_exec(self,fname,*where,**kw): | |
590 | """Execute a matplotlib script. |
|
590 | """Execute a matplotlib script. | |
591 |
|
591 | |||
592 | This is a call to execfile(), but wrapped in safeties to properly |
|
592 | This is a call to execfile(), but wrapped in safeties to properly | |
593 | handle interactive rendering and backend switching.""" |
|
593 | handle interactive rendering and backend switching.""" | |
594 |
|
594 | |||
595 | #print '*** Matplotlib runner ***' # dbg |
|
595 | #print '*** Matplotlib runner ***' # dbg | |
596 | # turn off rendering until end of script |
|
596 | # turn off rendering until end of script | |
597 | isInteractive = self.matplotlib.rcParams['interactive'] |
|
597 | isInteractive = self.matplotlib.rcParams['interactive'] | |
598 | self.matplotlib.interactive(False) |
|
598 | self.matplotlib.interactive(False) | |
599 | self.safe_execfile(fname,*where,**kw) |
|
599 | self.safe_execfile(fname,*where,**kw) | |
600 | self.matplotlib.interactive(isInteractive) |
|
600 | self.matplotlib.interactive(isInteractive) | |
601 | # make rendering call now, if the user tried to do it |
|
601 | # make rendering call now, if the user tried to do it | |
602 | if self.pylab.draw_if_interactive.called: |
|
602 | if self.pylab.draw_if_interactive.called: | |
603 | self.pylab.draw() |
|
603 | self.pylab.draw() | |
604 | self.pylab.draw_if_interactive.called = False |
|
604 | self.pylab.draw_if_interactive.called = False | |
605 |
|
605 | |||
606 | # if a backend switch was performed, reverse it now |
|
606 | # if a backend switch was performed, reverse it now | |
607 | if self.mpl_use._called: |
|
607 | if self.mpl_use._called: | |
608 | self.matplotlib.rcParams['backend'] = self.mpl_backend |
|
608 | self.matplotlib.rcParams['backend'] = self.mpl_backend | |
609 |
|
609 | |||
610 | @testdec.skip_doctest |
|
610 | @testdec.skip_doctest | |
611 | def magic_run(self,parameter_s=''): |
|
611 | def magic_run(self,parameter_s=''): | |
612 | Magic.magic_run(self,parameter_s,runner=self.mplot_exec) |
|
612 | Magic.magic_run(self,parameter_s,runner=self.mplot_exec) | |
613 |
|
613 | |||
614 | # Fix the docstring so users see the original as well |
|
614 | # Fix the docstring so users see the original as well | |
615 | magic_run.__doc__ = "%s\n%s" % (Magic.magic_run.__doc__, |
|
615 | magic_run.__doc__ = "%s\n%s" % (Magic.magic_run.__doc__, | |
616 | "\n *** Modified %run for Matplotlib," |
|
616 | "\n *** Modified %run for Matplotlib," | |
617 | " with proper interactive handling ***") |
|
617 | " with proper interactive handling ***") | |
618 |
|
618 | |||
619 | # Now we provide 2 versions of a matplotlib-aware IPython base shells, single |
|
619 | # Now we provide 2 versions of a matplotlib-aware IPython base shells, single | |
620 | # and multithreaded. Note that these are meant for internal use, the IPShell* |
|
620 | # and multithreaded. Note that these are meant for internal use, the IPShell* | |
621 | # classes below are the ones meant for public consumption. |
|
621 | # classes below are the ones meant for public consumption. | |
622 |
|
622 | |||
623 | class MatplotlibShell(MatplotlibShellBase,InteractiveShell): |
|
623 | class MatplotlibShell(MatplotlibShellBase,InteractiveShell): | |
624 | """Single-threaded shell with matplotlib support.""" |
|
624 | """Single-threaded shell with matplotlib support.""" | |
625 |
|
625 | |||
626 | def __init__(self,name,usage=None,rc=Struct(opts=None,args=None), |
|
626 | def __init__(self,name,usage=None,rc=Struct(opts=None,args=None), | |
627 | user_ns=None,user_global_ns=None,**kw): |
|
627 | user_ns=None,user_global_ns=None,**kw): | |
628 | user_ns,user_global_ns,b2 = self._matplotlib_config(name,user_ns,user_global_ns) |
|
628 | user_ns,user_global_ns,b2 = self._matplotlib_config(name,user_ns,user_global_ns) | |
629 | InteractiveShell.__init__(self,name,usage,rc,user_ns,user_global_ns, |
|
629 | InteractiveShell.__init__(self,name,usage,rc,user_ns,user_global_ns, | |
630 | banner2=b2,**kw) |
|
630 | banner2=b2,**kw) | |
631 |
|
631 | |||
632 | class MatplotlibMTShell(MatplotlibShellBase,MTInteractiveShell): |
|
632 | class MatplotlibMTShell(MatplotlibShellBase,MTInteractiveShell): | |
633 | """Multi-threaded shell with matplotlib support.""" |
|
633 | """Multi-threaded shell with matplotlib support.""" | |
634 |
|
634 | |||
635 | def __init__(self,name,usage=None,rc=Struct(opts=None,args=None), |
|
635 | def __init__(self,name,usage=None,rc=Struct(opts=None,args=None), | |
636 | user_ns=None,user_global_ns=None, **kw): |
|
636 | user_ns=None,user_global_ns=None, **kw): | |
637 | user_ns,user_global_ns,b2 = self._matplotlib_config(name,user_ns,user_global_ns) |
|
637 | user_ns,user_global_ns,b2 = self._matplotlib_config(name,user_ns,user_global_ns) | |
638 | MTInteractiveShell.__init__(self,name,usage,rc,user_ns,user_global_ns, |
|
638 | MTInteractiveShell.__init__(self,name,usage,rc,user_ns,user_global_ns, | |
639 | banner2=b2,**kw) |
|
639 | banner2=b2,**kw) | |
640 |
|
640 | |||
641 | #----------------------------------------------------------------------------- |
|
641 | #----------------------------------------------------------------------------- | |
642 | # Utility functions for the different GUI enabled IPShell* classes. |
|
642 | # Utility functions for the different GUI enabled IPShell* classes. | |
643 |
|
643 | |||
644 | def get_tk(): |
|
644 | def get_tk(): | |
645 | """Tries to import Tkinter and returns a withdrawn Tkinter root |
|
645 | """Tries to import Tkinter and returns a withdrawn Tkinter root | |
646 | window. If Tkinter is already imported or not available, this |
|
646 | window. If Tkinter is already imported or not available, this | |
647 | returns None. This function calls `hijack_tk` underneath. |
|
647 | returns None. This function calls `hijack_tk` underneath. | |
648 | """ |
|
648 | """ | |
649 | if not USE_TK or sys.modules.has_key('Tkinter'): |
|
649 | if not USE_TK or sys.modules.has_key('Tkinter'): | |
650 | return None |
|
650 | return None | |
651 | else: |
|
651 | else: | |
652 | try: |
|
652 | try: | |
653 | import Tkinter |
|
653 | import Tkinter | |
654 | except ImportError: |
|
654 | except ImportError: | |
655 | return None |
|
655 | return None | |
656 | else: |
|
656 | else: | |
657 | hijack_tk() |
|
657 | hijack_tk() | |
658 | r = Tkinter.Tk() |
|
658 | r = Tkinter.Tk() | |
659 | r.withdraw() |
|
659 | r.withdraw() | |
660 | return r |
|
660 | return r | |
661 |
|
661 | |||
662 | def hijack_tk(): |
|
662 | def hijack_tk(): | |
663 | """Modifies Tkinter's mainloop with a dummy so when a module calls |
|
663 | """Modifies Tkinter's mainloop with a dummy so when a module calls | |
664 | mainloop, it does not block. |
|
664 | mainloop, it does not block. | |
665 |
|
665 | |||
666 | """ |
|
666 | """ | |
667 | def misc_mainloop(self, n=0): |
|
667 | def misc_mainloop(self, n=0): | |
668 | pass |
|
668 | pass | |
669 | def tkinter_mainloop(n=0): |
|
669 | def tkinter_mainloop(n=0): | |
670 | pass |
|
670 | pass | |
671 |
|
671 | |||
672 | import Tkinter |
|
672 | import Tkinter | |
673 | Tkinter.Misc.mainloop = misc_mainloop |
|
673 | Tkinter.Misc.mainloop = misc_mainloop | |
674 | Tkinter.mainloop = tkinter_mainloop |
|
674 | Tkinter.mainloop = tkinter_mainloop | |
675 |
|
675 | |||
676 | def update_tk(tk): |
|
676 | def update_tk(tk): | |
677 | """Updates the Tkinter event loop. This is typically called from |
|
677 | """Updates the Tkinter event loop. This is typically called from | |
678 | the respective WX or GTK mainloops. |
|
678 | the respective WX or GTK mainloops. | |
679 | """ |
|
679 | """ | |
680 | if tk: |
|
680 | if tk: | |
681 | tk.update() |
|
681 | tk.update() | |
682 |
|
682 | |||
683 | def hijack_wx(): |
|
683 | def hijack_wx(): | |
684 | """Modifies wxPython's MainLoop with a dummy so user code does not |
|
684 | """Modifies wxPython's MainLoop with a dummy so user code does not | |
685 | block IPython. The hijacked mainloop function is returned. |
|
685 | block IPython. The hijacked mainloop function is returned. | |
686 | """ |
|
686 | """ | |
687 | def dummy_mainloop(*args, **kw): |
|
687 | def dummy_mainloop(*args, **kw): | |
688 | pass |
|
688 | pass | |
689 |
|
689 | |||
690 | try: |
|
690 | try: | |
691 | import wx |
|
691 | import wx | |
692 | except ImportError: |
|
692 | except ImportError: | |
693 | # For very old versions of WX |
|
693 | # For very old versions of WX | |
694 | import wxPython as wx |
|
694 | import wxPython as wx | |
695 |
|
695 | |||
696 | ver = wx.__version__ |
|
696 | ver = wx.__version__ | |
697 | orig_mainloop = None |
|
697 | orig_mainloop = None | |
698 | if ver[:3] >= '2.5': |
|
698 | if ver[:3] >= '2.5': | |
699 | import wx |
|
699 | import wx | |
700 | if hasattr(wx, '_core_'): core = getattr(wx, '_core_') |
|
700 | if hasattr(wx, '_core_'): core = getattr(wx, '_core_') | |
701 | elif hasattr(wx, '_core'): core = getattr(wx, '_core') |
|
701 | elif hasattr(wx, '_core'): core = getattr(wx, '_core') | |
702 | else: raise AttributeError('Could not find wx core module') |
|
702 | else: raise AttributeError('Could not find wx core module') | |
703 | orig_mainloop = core.PyApp_MainLoop |
|
703 | orig_mainloop = core.PyApp_MainLoop | |
704 | core.PyApp_MainLoop = dummy_mainloop |
|
704 | core.PyApp_MainLoop = dummy_mainloop | |
705 | elif ver[:3] == '2.4': |
|
705 | elif ver[:3] == '2.4': | |
706 | orig_mainloop = wx.wxc.wxPyApp_MainLoop |
|
706 | orig_mainloop = wx.wxc.wxPyApp_MainLoop | |
707 | wx.wxc.wxPyApp_MainLoop = dummy_mainloop |
|
707 | wx.wxc.wxPyApp_MainLoop = dummy_mainloop | |
708 | else: |
|
708 | else: | |
709 | warn("Unable to find either wxPython version 2.4 or >= 2.5.") |
|
709 | warn("Unable to find either wxPython version 2.4 or >= 2.5.") | |
710 | return orig_mainloop |
|
710 | return orig_mainloop | |
711 |
|
711 | |||
712 | def hijack_gtk(): |
|
712 | def hijack_gtk(): | |
713 | """Modifies pyGTK's mainloop with a dummy so user code does not |
|
713 | """Modifies pyGTK's mainloop with a dummy so user code does not | |
714 | block IPython. This function returns the original `gtk.mainloop` |
|
714 | block IPython. This function returns the original `gtk.mainloop` | |
715 | function that has been hijacked. |
|
715 | function that has been hijacked. | |
716 | """ |
|
716 | """ | |
717 | def dummy_mainloop(*args, **kw): |
|
717 | def dummy_mainloop(*args, **kw): | |
718 | pass |
|
718 | pass | |
719 | import gtk |
|
719 | import gtk | |
720 | if gtk.pygtk_version >= (2,4,0): orig_mainloop = gtk.main |
|
720 | if gtk.pygtk_version >= (2,4,0): orig_mainloop = gtk.main | |
721 | else: orig_mainloop = gtk.mainloop |
|
721 | else: orig_mainloop = gtk.mainloop | |
722 | gtk.mainloop = dummy_mainloop |
|
722 | gtk.mainloop = dummy_mainloop | |
723 | gtk.main = dummy_mainloop |
|
723 | gtk.main = dummy_mainloop | |
724 | return orig_mainloop |
|
724 | return orig_mainloop | |
725 |
|
725 | |||
726 | def hijack_qt(): |
|
726 | def hijack_qt(): | |
727 | """Modifies PyQt's mainloop with a dummy so user code does not |
|
727 | """Modifies PyQt's mainloop with a dummy so user code does not | |
728 | block IPython. This function returns the original |
|
728 | block IPython. This function returns the original | |
729 | `qt.qApp.exec_loop` function that has been hijacked. |
|
729 | `qt.qApp.exec_loop` function that has been hijacked. | |
730 | """ |
|
730 | """ | |
731 | def dummy_mainloop(*args, **kw): |
|
731 | def dummy_mainloop(*args, **kw): | |
732 | pass |
|
732 | pass | |
733 | import qt |
|
733 | import qt | |
734 | orig_mainloop = qt.qApp.exec_loop |
|
734 | orig_mainloop = qt.qApp.exec_loop | |
735 | qt.qApp.exec_loop = dummy_mainloop |
|
735 | qt.qApp.exec_loop = dummy_mainloop | |
736 | qt.QApplication.exec_loop = dummy_mainloop |
|
736 | qt.QApplication.exec_loop = dummy_mainloop | |
737 | return orig_mainloop |
|
737 | return orig_mainloop | |
738 |
|
738 | |||
739 | def hijack_qt4(): |
|
739 | def hijack_qt4(): | |
740 | """Modifies PyQt4's mainloop with a dummy so user code does not |
|
740 | """Modifies PyQt4's mainloop with a dummy so user code does not | |
741 | block IPython. This function returns the original |
|
741 | block IPython. This function returns the original | |
742 | `QtGui.qApp.exec_` function that has been hijacked. |
|
742 | `QtGui.qApp.exec_` function that has been hijacked. | |
743 | """ |
|
743 | """ | |
744 | def dummy_mainloop(*args, **kw): |
|
744 | def dummy_mainloop(*args, **kw): | |
745 | pass |
|
745 | pass | |
746 | from PyQt4 import QtGui, QtCore |
|
746 | from PyQt4 import QtGui, QtCore | |
747 | orig_mainloop = QtGui.qApp.exec_ |
|
747 | orig_mainloop = QtGui.qApp.exec_ | |
748 | QtGui.qApp.exec_ = dummy_mainloop |
|
748 | QtGui.qApp.exec_ = dummy_mainloop | |
749 | QtGui.QApplication.exec_ = dummy_mainloop |
|
749 | QtGui.QApplication.exec_ = dummy_mainloop | |
750 | QtCore.QCoreApplication.exec_ = dummy_mainloop |
|
750 | QtCore.QCoreApplication.exec_ = dummy_mainloop | |
751 | return orig_mainloop |
|
751 | return orig_mainloop | |
752 |
|
752 | |||
753 | #----------------------------------------------------------------------------- |
|
753 | #----------------------------------------------------------------------------- | |
754 | # The IPShell* classes below are the ones meant to be run by external code as |
|
754 | # The IPShell* classes below are the ones meant to be run by external code as | |
755 | # IPython instances. Note that unless a specific threading strategy is |
|
755 | # IPython instances. Note that unless a specific threading strategy is | |
756 | # desired, the factory function start() below should be used instead (it |
|
756 | # desired, the factory function start() below should be used instead (it | |
757 | # selects the proper threaded class). |
|
757 | # selects the proper threaded class). | |
758 |
|
758 | |||
759 | class IPThread(threading.Thread): |
|
759 | class IPThread(threading.Thread): | |
760 | def run(self): |
|
760 | def run(self): | |
761 | self.IP.mainloop(self._banner) |
|
761 | self.IP.mainloop(self._banner) | |
762 | self.IP.kill() |
|
762 | self.IP.kill() | |
763 |
|
763 | |||
764 | class IPShellGTK(IPThread): |
|
764 | class IPShellGTK(IPThread): | |
765 | """Run a gtk mainloop() in a separate thread. |
|
765 | """Run a gtk mainloop() in a separate thread. | |
766 |
|
766 | |||
767 | Python commands can be passed to the thread where they will be executed. |
|
767 | Python commands can be passed to the thread where they will be executed. | |
768 | This is implemented by periodically checking for passed code using a |
|
768 | This is implemented by periodically checking for passed code using a | |
769 | GTK timeout callback.""" |
|
769 | GTK timeout callback.""" | |
770 |
|
770 | |||
771 | TIMEOUT = 100 # Millisecond interval between timeouts. |
|
771 | TIMEOUT = 100 # Millisecond interval between timeouts. | |
772 |
|
772 | |||
773 | def __init__(self,argv=None,user_ns=None,user_global_ns=None, |
|
773 | def __init__(self,argv=None,user_ns=None,user_global_ns=None, | |
774 | debug=1,shell_class=MTInteractiveShell): |
|
774 | debug=1,shell_class=MTInteractiveShell): | |
775 |
|
775 | |||
776 | import gtk |
|
776 | import gtk | |
777 | # Check for set_interactive, coming up in new pygtk. |
|
777 | # Check for set_interactive, coming up in new pygtk. | |
778 | # Disable it so that this code works, but notify |
|
778 | # Disable it so that this code works, but notify | |
779 | # the user that he has a better option as well. |
|
779 | # the user that he has a better option as well. | |
780 | # XXX TODO better support when set_interactive is released |
|
780 | # XXX TODO better support when set_interactive is released | |
781 | try: |
|
781 | try: | |
782 | gtk.set_interactive(False) |
|
782 | gtk.set_interactive(False) | |
783 | print "Your PyGtk has set_interactive(), so you can use the" |
|
783 | print "Your PyGtk has set_interactive(), so you can use the" | |
784 | print "more stable single-threaded Gtk mode." |
|
784 | print "more stable single-threaded Gtk mode." | |
785 | print "See https://bugs.launchpad.net/ipython/+bug/270856" |
|
785 | print "See https://bugs.launchpad.net/ipython/+bug/270856" | |
786 | except AttributeError: |
|
786 | except AttributeError: | |
787 | pass |
|
787 | pass | |
788 |
|
788 | |||
789 | self.gtk = gtk |
|
789 | self.gtk = gtk | |
790 | self.gtk_mainloop = hijack_gtk() |
|
790 | self.gtk_mainloop = hijack_gtk() | |
791 |
|
791 | |||
792 | # Allows us to use both Tk and GTK. |
|
792 | # Allows us to use both Tk and GTK. | |
793 | self.tk = get_tk() |
|
793 | self.tk = get_tk() | |
794 |
|
794 | |||
795 | if gtk.pygtk_version >= (2,4,0): mainquit = self.gtk.main_quit |
|
795 | if gtk.pygtk_version >= (2,4,0): mainquit = self.gtk.main_quit | |
796 | else: mainquit = self.gtk.mainquit |
|
796 | else: mainquit = self.gtk.mainquit | |
797 |
|
797 | |||
798 | self.IP = make_IPython(argv,user_ns=user_ns, |
|
798 | self.IP = make_IPython(argv,user_ns=user_ns, | |
799 | user_global_ns=user_global_ns, |
|
799 | user_global_ns=user_global_ns, | |
800 | debug=debug, |
|
800 | debug=debug, | |
801 | shell_class=shell_class, |
|
801 | shell_class=shell_class, | |
802 | on_kill=[mainquit]) |
|
802 | on_kill=[mainquit]) | |
803 |
|
803 | |||
804 | # HACK: slot for banner in self; it will be passed to the mainloop |
|
804 | # HACK: slot for banner in self; it will be passed to the mainloop | |
805 | # method only and .run() needs it. The actual value will be set by |
|
805 | # method only and .run() needs it. The actual value will be set by | |
806 | # .mainloop(). |
|
806 | # .mainloop(). | |
807 | self._banner = None |
|
807 | self._banner = None | |
808 |
|
808 | |||
809 | threading.Thread.__init__(self) |
|
809 | threading.Thread.__init__(self) | |
810 |
|
810 | |||
811 | def mainloop(self,sys_exit=0,banner=None): |
|
811 | def mainloop(self,sys_exit=0,banner=None): | |
812 |
|
812 | |||
813 | self._banner = banner |
|
813 | self._banner = banner | |
814 |
|
814 | |||
815 | if self.gtk.pygtk_version >= (2,4,0): |
|
815 | if self.gtk.pygtk_version >= (2,4,0): | |
816 | import gobject |
|
816 | import gobject | |
817 | gobject.idle_add(self.on_timer) |
|
817 | gobject.idle_add(self.on_timer) | |
818 | else: |
|
818 | else: | |
819 | self.gtk.idle_add(self.on_timer) |
|
819 | self.gtk.idle_add(self.on_timer) | |
820 |
|
820 | |||
821 | if sys.platform != 'win32': |
|
821 | if sys.platform != 'win32': | |
822 | try: |
|
822 | try: | |
823 | if self.gtk.gtk_version[0] >= 2: |
|
823 | if self.gtk.gtk_version[0] >= 2: | |
824 | self.gtk.gdk.threads_init() |
|
824 | self.gtk.gdk.threads_init() | |
825 | except AttributeError: |
|
825 | except AttributeError: | |
826 | pass |
|
826 | pass | |
827 | except RuntimeError: |
|
827 | except RuntimeError: | |
828 | error('Your pyGTK likely has not been compiled with ' |
|
828 | error('Your pyGTK likely has not been compiled with ' | |
829 | 'threading support.\n' |
|
829 | 'threading support.\n' | |
830 | 'The exception printout is below.\n' |
|
830 | 'The exception printout is below.\n' | |
831 | 'You can either rebuild pyGTK with threads, or ' |
|
831 | 'You can either rebuild pyGTK with threads, or ' | |
832 | 'try using \n' |
|
832 | 'try using \n' | |
833 | 'matplotlib with a different backend (like Tk or WX).\n' |
|
833 | 'matplotlib with a different backend (like Tk or WX).\n' | |
834 | 'Note that matplotlib will most likely not work in its ' |
|
834 | 'Note that matplotlib will most likely not work in its ' | |
835 | 'current state!') |
|
835 | 'current state!') | |
836 | self.IP.InteractiveTB() |
|
836 | self.IP.InteractiveTB() | |
837 |
|
837 | |||
838 | self.start() |
|
838 | self.start() | |
839 | self.gtk.gdk.threads_enter() |
|
839 | self.gtk.gdk.threads_enter() | |
840 | self.gtk_mainloop() |
|
840 | self.gtk_mainloop() | |
841 | self.gtk.gdk.threads_leave() |
|
841 | self.gtk.gdk.threads_leave() | |
842 | self.join() |
|
842 | self.join() | |
843 |
|
843 | |||
844 | def on_timer(self): |
|
844 | def on_timer(self): | |
845 | """Called when GTK is idle. |
|
845 | """Called when GTK is idle. | |
846 |
|
846 | |||
847 | Must return True always, otherwise GTK stops calling it""" |
|
847 | Must return True always, otherwise GTK stops calling it""" | |
848 |
|
848 | |||
849 | update_tk(self.tk) |
|
849 | update_tk(self.tk) | |
850 | self.IP.runcode() |
|
850 | self.IP.runcode() | |
851 | time.sleep(0.01) |
|
851 | time.sleep(0.01) | |
852 | return True |
|
852 | return True | |
853 |
|
853 | |||
854 |
|
854 | |||
855 | class IPShellWX(IPThread): |
|
855 | class IPShellWX(IPThread): | |
856 | """Run a wx mainloop() in a separate thread. |
|
856 | """Run a wx mainloop() in a separate thread. | |
857 |
|
857 | |||
858 | Python commands can be passed to the thread where they will be executed. |
|
858 | Python commands can be passed to the thread where they will be executed. | |
859 | This is implemented by periodically checking for passed code using a |
|
859 | This is implemented by periodically checking for passed code using a | |
860 | GTK timeout callback.""" |
|
860 | GTK timeout callback.""" | |
861 |
|
861 | |||
862 | TIMEOUT = 100 # Millisecond interval between timeouts. |
|
862 | TIMEOUT = 100 # Millisecond interval between timeouts. | |
863 |
|
863 | |||
864 | def __init__(self,argv=None,user_ns=None,user_global_ns=None, |
|
864 | def __init__(self,argv=None,user_ns=None,user_global_ns=None, | |
865 | debug=1,shell_class=MTInteractiveShell): |
|
865 | debug=1,shell_class=MTInteractiveShell): | |
866 |
|
866 | |||
867 | self.IP = make_IPython(argv,user_ns=user_ns, |
|
867 | self.IP = make_IPython(argv,user_ns=user_ns, | |
868 | user_global_ns=user_global_ns, |
|
868 | user_global_ns=user_global_ns, | |
869 | debug=debug, |
|
869 | debug=debug, | |
870 | shell_class=shell_class, |
|
870 | shell_class=shell_class, | |
871 | on_kill=[self.wxexit]) |
|
871 | on_kill=[self.wxexit]) | |
872 |
|
872 | |||
873 | wantedwxversion=self.IP.rc.wxversion |
|
873 | wantedwxversion=self.IP.rc.wxversion | |
874 | if wantedwxversion!="0": |
|
874 | if wantedwxversion!="0": | |
875 | try: |
|
875 | try: | |
876 | import wxversion |
|
876 | import wxversion | |
877 | except ImportError: |
|
877 | except ImportError: | |
878 | error('The wxversion module is needed for WX version selection') |
|
878 | error('The wxversion module is needed for WX version selection') | |
879 | else: |
|
879 | else: | |
880 | try: |
|
880 | try: | |
881 | wxversion.select(wantedwxversion) |
|
881 | wxversion.select(wantedwxversion) | |
882 | except: |
|
882 | except: | |
883 | self.IP.InteractiveTB() |
|
883 | self.IP.InteractiveTB() | |
884 | error('Requested wxPython version %s could not be loaded' % |
|
884 | error('Requested wxPython version %s could not be loaded' % | |
885 | wantedwxversion) |
|
885 | wantedwxversion) | |
886 |
|
886 | |||
887 | import wx |
|
887 | import wx | |
888 |
|
888 | |||
889 | threading.Thread.__init__(self) |
|
889 | threading.Thread.__init__(self) | |
890 | self.wx = wx |
|
890 | self.wx = wx | |
891 | self.wx_mainloop = hijack_wx() |
|
891 | self.wx_mainloop = hijack_wx() | |
892 |
|
892 | |||
893 | # Allows us to use both Tk and GTK. |
|
893 | # Allows us to use both Tk and GTK. | |
894 | self.tk = get_tk() |
|
894 | self.tk = get_tk() | |
895 |
|
895 | |||
896 | # HACK: slot for banner in self; it will be passed to the mainloop |
|
896 | # HACK: slot for banner in self; it will be passed to the mainloop | |
897 | # method only and .run() needs it. The actual value will be set by |
|
897 | # method only and .run() needs it. The actual value will be set by | |
898 | # .mainloop(). |
|
898 | # .mainloop(). | |
899 | self._banner = None |
|
899 | self._banner = None | |
900 |
|
900 | |||
901 | self.app = None |
|
901 | self.app = None | |
902 |
|
902 | |||
903 | def wxexit(self, *args): |
|
903 | def wxexit(self, *args): | |
904 | if self.app is not None: |
|
904 | if self.app is not None: | |
905 | self.app.agent.timer.Stop() |
|
905 | self.app.agent.timer.Stop() | |
906 | self.app.ExitMainLoop() |
|
906 | self.app.ExitMainLoop() | |
907 |
|
907 | |||
908 | def mainloop(self,sys_exit=0,banner=None): |
|
908 | def mainloop(self,sys_exit=0,banner=None): | |
909 |
|
909 | |||
910 | self._banner = banner |
|
910 | self._banner = banner | |
911 |
|
911 | |||
912 | self.start() |
|
912 | self.start() | |
913 |
|
913 | |||
914 | class TimerAgent(self.wx.MiniFrame): |
|
914 | class TimerAgent(self.wx.MiniFrame): | |
915 | wx = self.wx |
|
915 | wx = self.wx | |
916 | IP = self.IP |
|
916 | IP = self.IP | |
917 | tk = self.tk |
|
917 | tk = self.tk | |
918 | def __init__(self, parent, interval): |
|
918 | def __init__(self, parent, interval): | |
919 | style = self.wx.DEFAULT_FRAME_STYLE | self.wx.TINY_CAPTION_HORIZ |
|
919 | style = self.wx.DEFAULT_FRAME_STYLE | self.wx.TINY_CAPTION_HORIZ | |
920 | self.wx.MiniFrame.__init__(self, parent, -1, ' ', pos=(200, 200), |
|
920 | self.wx.MiniFrame.__init__(self, parent, -1, ' ', pos=(200, 200), | |
921 | size=(100, 100),style=style) |
|
921 | size=(100, 100),style=style) | |
922 | self.Show(False) |
|
922 | self.Show(False) | |
923 | self.interval = interval |
|
923 | self.interval = interval | |
924 | self.timerId = self.wx.NewId() |
|
924 | self.timerId = self.wx.NewId() | |
925 |
|
925 | |||
926 | def StartWork(self): |
|
926 | def StartWork(self): | |
927 | self.timer = self.wx.Timer(self, self.timerId) |
|
927 | self.timer = self.wx.Timer(self, self.timerId) | |
928 | self.wx.EVT_TIMER(self, self.timerId, self.OnTimer) |
|
928 | self.wx.EVT_TIMER(self, self.timerId, self.OnTimer) | |
929 | self.timer.Start(self.interval) |
|
929 | self.timer.Start(self.interval) | |
930 |
|
930 | |||
931 | def OnTimer(self, event): |
|
931 | def OnTimer(self, event): | |
932 | update_tk(self.tk) |
|
932 | update_tk(self.tk) | |
933 | self.IP.runcode() |
|
933 | self.IP.runcode() | |
934 |
|
934 | |||
935 | class App(self.wx.App): |
|
935 | class App(self.wx.App): | |
936 | wx = self.wx |
|
936 | wx = self.wx | |
937 | TIMEOUT = self.TIMEOUT |
|
937 | TIMEOUT = self.TIMEOUT | |
938 | def OnInit(self): |
|
938 | def OnInit(self): | |
939 | 'Create the main window and insert the custom frame' |
|
939 | 'Create the main window and insert the custom frame' | |
940 | self.agent = TimerAgent(None, self.TIMEOUT) |
|
940 | self.agent = TimerAgent(None, self.TIMEOUT) | |
941 | self.agent.Show(False) |
|
941 | self.agent.Show(False) | |
942 | self.agent.StartWork() |
|
942 | self.agent.StartWork() | |
943 | return True |
|
943 | return True | |
944 |
|
944 | |||
945 | self.app = App(redirect=False) |
|
945 | self.app = App(redirect=False) | |
946 | self.wx_mainloop(self.app) |
|
946 | self.wx_mainloop(self.app) | |
947 | self.join() |
|
947 | self.join() | |
948 |
|
948 | |||
949 |
|
949 | |||
950 | class IPShellQt(IPThread): |
|
950 | class IPShellQt(IPThread): | |
951 | """Run a Qt event loop in a separate thread. |
|
951 | """Run a Qt event loop in a separate thread. | |
952 |
|
952 | |||
953 | Python commands can be passed to the thread where they will be executed. |
|
953 | Python commands can be passed to the thread where they will be executed. | |
954 | This is implemented by periodically checking for passed code using a |
|
954 | This is implemented by periodically checking for passed code using a | |
955 | Qt timer / slot.""" |
|
955 | Qt timer / slot.""" | |
956 |
|
956 | |||
957 | TIMEOUT = 100 # Millisecond interval between timeouts. |
|
957 | TIMEOUT = 100 # Millisecond interval between timeouts. | |
958 |
|
958 | |||
959 | def __init__(self, argv=None, user_ns=None, user_global_ns=None, |
|
959 | def __init__(self, argv=None, user_ns=None, user_global_ns=None, | |
960 | debug=0, shell_class=MTInteractiveShell): |
|
960 | debug=0, shell_class=MTInteractiveShell): | |
961 |
|
961 | |||
962 | import qt |
|
962 | import qt | |
963 |
|
963 | |||
964 | self.exec_loop = hijack_qt() |
|
964 | self.exec_loop = hijack_qt() | |
965 |
|
965 | |||
966 | # Allows us to use both Tk and QT. |
|
966 | # Allows us to use both Tk and QT. | |
967 | self.tk = get_tk() |
|
967 | self.tk = get_tk() | |
968 |
|
968 | |||
969 | self.IP = make_IPython(argv, |
|
969 | self.IP = make_IPython(argv, | |
970 | user_ns=user_ns, |
|
970 | user_ns=user_ns, | |
971 | user_global_ns=user_global_ns, |
|
971 | user_global_ns=user_global_ns, | |
972 | debug=debug, |
|
972 | debug=debug, | |
973 | shell_class=shell_class, |
|
973 | shell_class=shell_class, | |
974 | on_kill=[qt.qApp.exit]) |
|
974 | on_kill=[qt.qApp.exit]) | |
975 |
|
975 | |||
976 | # HACK: slot for banner in self; it will be passed to the mainloop |
|
976 | # HACK: slot for banner in self; it will be passed to the mainloop | |
977 | # method only and .run() needs it. The actual value will be set by |
|
977 | # method only and .run() needs it. The actual value will be set by | |
978 | # .mainloop(). |
|
978 | # .mainloop(). | |
979 | self._banner = None |
|
979 | self._banner = None | |
980 |
|
980 | |||
981 | threading.Thread.__init__(self) |
|
981 | threading.Thread.__init__(self) | |
982 |
|
982 | |||
983 | def mainloop(self, sys_exit=0, banner=None): |
|
983 | def mainloop(self, sys_exit=0, banner=None): | |
984 |
|
984 | |||
985 | import qt |
|
985 | import qt | |
986 |
|
986 | |||
987 | self._banner = banner |
|
987 | self._banner = banner | |
988 |
|
988 | |||
989 | if qt.QApplication.startingUp(): |
|
989 | if qt.QApplication.startingUp(): | |
990 | a = qt.QApplication(sys.argv) |
|
990 | a = qt.QApplication(sys.argv) | |
991 |
|
991 | |||
992 | self.timer = qt.QTimer() |
|
992 | self.timer = qt.QTimer() | |
993 | qt.QObject.connect(self.timer, |
|
993 | qt.QObject.connect(self.timer, | |
994 | qt.SIGNAL('timeout()'), |
|
994 | qt.SIGNAL('timeout()'), | |
995 | self.on_timer) |
|
995 | self.on_timer) | |
996 |
|
996 | |||
997 | self.start() |
|
997 | self.start() | |
998 | self.timer.start(self.TIMEOUT, True) |
|
998 | self.timer.start(self.TIMEOUT, True) | |
999 | while True: |
|
999 | while True: | |
1000 | if self.IP._kill: break |
|
1000 | if self.IP._kill: break | |
1001 | self.exec_loop() |
|
1001 | self.exec_loop() | |
1002 | self.join() |
|
1002 | self.join() | |
1003 |
|
1003 | |||
1004 | def on_timer(self): |
|
1004 | def on_timer(self): | |
1005 | update_tk(self.tk) |
|
1005 | update_tk(self.tk) | |
1006 | result = self.IP.runcode() |
|
1006 | result = self.IP.runcode() | |
1007 | self.timer.start(self.TIMEOUT, True) |
|
1007 | self.timer.start(self.TIMEOUT, True) | |
1008 | return result |
|
1008 | return result | |
1009 |
|
1009 | |||
1010 |
|
1010 | |||
1011 | class IPShellQt4(IPThread): |
|
1011 | class IPShellQt4(IPThread): | |
1012 | """Run a Qt event loop in a separate thread. |
|
1012 | """Run a Qt event loop in a separate thread. | |
1013 |
|
1013 | |||
1014 | Python commands can be passed to the thread where they will be executed. |
|
1014 | Python commands can be passed to the thread where they will be executed. | |
1015 | This is implemented by periodically checking for passed code using a |
|
1015 | This is implemented by periodically checking for passed code using a | |
1016 | Qt timer / slot.""" |
|
1016 | Qt timer / slot.""" | |
1017 |
|
1017 | |||
1018 | TIMEOUT = 100 # Millisecond interval between timeouts. |
|
1018 | TIMEOUT = 100 # Millisecond interval between timeouts. | |
1019 |
|
1019 | |||
1020 | def __init__(self, argv=None, user_ns=None, user_global_ns=None, |
|
1020 | def __init__(self, argv=None, user_ns=None, user_global_ns=None, | |
1021 | debug=0, shell_class=MTInteractiveShell): |
|
1021 | debug=0, shell_class=MTInteractiveShell): | |
1022 |
|
1022 | |||
1023 | from PyQt4 import QtCore, QtGui |
|
1023 | from PyQt4 import QtCore, QtGui | |
1024 |
|
1024 | |||
1025 | try: |
|
1025 | try: | |
1026 | # present in PyQt4-4.2.1 or later |
|
1026 | # present in PyQt4-4.2.1 or later | |
1027 | QtCore.pyqtRemoveInputHook() |
|
1027 | QtCore.pyqtRemoveInputHook() | |
1028 | except AttributeError: |
|
1028 | except AttributeError: | |
1029 | pass |
|
1029 | pass | |
1030 |
|
1030 | |||
1031 | if QtCore.PYQT_VERSION_STR == '4.3': |
|
1031 | if QtCore.PYQT_VERSION_STR == '4.3': | |
1032 | warn('''PyQt4 version 4.3 detected. |
|
1032 | warn('''PyQt4 version 4.3 detected. | |
1033 | If you experience repeated threading warnings, please update PyQt4. |
|
1033 | If you experience repeated threading warnings, please update PyQt4. | |
1034 | ''') |
|
1034 | ''') | |
1035 |
|
1035 | |||
1036 | self.exec_ = hijack_qt4() |
|
1036 | self.exec_ = hijack_qt4() | |
1037 |
|
1037 | |||
1038 | # Allows us to use both Tk and QT. |
|
1038 | # Allows us to use both Tk and QT. | |
1039 | self.tk = get_tk() |
|
1039 | self.tk = get_tk() | |
1040 |
|
1040 | |||
1041 | self.IP = make_IPython(argv, |
|
1041 | self.IP = make_IPython(argv, | |
1042 | user_ns=user_ns, |
|
1042 | user_ns=user_ns, | |
1043 | user_global_ns=user_global_ns, |
|
1043 | user_global_ns=user_global_ns, | |
1044 | debug=debug, |
|
1044 | debug=debug, | |
1045 | shell_class=shell_class, |
|
1045 | shell_class=shell_class, | |
1046 | on_kill=[QtGui.qApp.exit]) |
|
1046 | on_kill=[QtGui.qApp.exit]) | |
1047 |
|
1047 | |||
1048 | # HACK: slot for banner in self; it will be passed to the mainloop |
|
1048 | # HACK: slot for banner in self; it will be passed to the mainloop | |
1049 | # method only and .run() needs it. The actual value will be set by |
|
1049 | # method only and .run() needs it. The actual value will be set by | |
1050 | # .mainloop(). |
|
1050 | # .mainloop(). | |
1051 | self._banner = None |
|
1051 | self._banner = None | |
1052 |
|
1052 | |||
1053 | threading.Thread.__init__(self) |
|
1053 | threading.Thread.__init__(self) | |
1054 |
|
1054 | |||
1055 | def mainloop(self, sys_exit=0, banner=None): |
|
1055 | def mainloop(self, sys_exit=0, banner=None): | |
1056 |
|
1056 | |||
1057 | from PyQt4 import QtCore, QtGui |
|
1057 | from PyQt4 import QtCore, QtGui | |
1058 |
|
1058 | |||
1059 | self._banner = banner |
|
1059 | self._banner = banner | |
1060 |
|
1060 | |||
1061 | if QtGui.QApplication.startingUp(): |
|
1061 | if QtGui.QApplication.startingUp(): | |
1062 | a = QtGui.QApplication(sys.argv) |
|
1062 | a = QtGui.QApplication(sys.argv) | |
1063 |
|
1063 | |||
1064 | self.timer = QtCore.QTimer() |
|
1064 | self.timer = QtCore.QTimer() | |
1065 | QtCore.QObject.connect(self.timer, |
|
1065 | QtCore.QObject.connect(self.timer, | |
1066 | QtCore.SIGNAL('timeout()'), |
|
1066 | QtCore.SIGNAL('timeout()'), | |
1067 | self.on_timer) |
|
1067 | self.on_timer) | |
1068 |
|
1068 | |||
1069 | self.start() |
|
1069 | self.start() | |
1070 | self.timer.start(self.TIMEOUT) |
|
1070 | self.timer.start(self.TIMEOUT) | |
1071 | while True: |
|
1071 | while True: | |
1072 | if self.IP._kill: break |
|
1072 | if self.IP._kill: break | |
1073 | self.exec_() |
|
1073 | self.exec_() | |
1074 | self.join() |
|
1074 | self.join() | |
1075 |
|
1075 | |||
1076 | def on_timer(self): |
|
1076 | def on_timer(self): | |
1077 | update_tk(self.tk) |
|
1077 | update_tk(self.tk) | |
1078 | result = self.IP.runcode() |
|
1078 | result = self.IP.runcode() | |
1079 | self.timer.start(self.TIMEOUT) |
|
1079 | self.timer.start(self.TIMEOUT) | |
1080 | return result |
|
1080 | return result | |
1081 |
|
1081 | |||
1082 |
|
1082 | |||
1083 | # A set of matplotlib public IPython shell classes, for single-threaded (Tk* |
|
1083 | # A set of matplotlib public IPython shell classes, for single-threaded (Tk* | |
1084 | # and FLTK*) and multithreaded (GTK*, WX* and Qt*) backends to use. |
|
1084 | # and FLTK*) and multithreaded (GTK*, WX* and Qt*) backends to use. | |
1085 | def _load_pylab(user_ns): |
|
1085 | def _load_pylab(user_ns): | |
1086 | """Allow users to disable pulling all of pylab into the top-level |
|
1086 | """Allow users to disable pulling all of pylab into the top-level | |
1087 | namespace. |
|
1087 | namespace. | |
1088 |
|
1088 | |||
1089 | This little utility must be called AFTER the actual ipython instance is |
|
1089 | This little utility must be called AFTER the actual ipython instance is | |
1090 | running, since only then will the options file have been fully parsed.""" |
|
1090 | running, since only then will the options file have been fully parsed.""" | |
1091 |
|
1091 | |||
1092 | ip = ipapi.get() |
|
1092 | ip = ipapi.get() | |
1093 | if ip.options.pylab_import_all: |
|
1093 | if ip.options.pylab_import_all: | |
1094 | ip.ex("from matplotlib.pylab import *") |
|
1094 | ip.ex("from matplotlib.pylab import *") | |
1095 | ip.IP.user_config_ns.update(ip.user_ns) |
|
1095 | ip.IP.user_config_ns.update(ip.user_ns) | |
1096 |
|
1096 | |||
1097 |
|
1097 | |||
1098 | class IPShellMatplotlib(IPShell): |
|
1098 | class IPShellMatplotlib(IPShell): | |
1099 | """Subclass IPShell with MatplotlibShell as the internal shell. |
|
1099 | """Subclass IPShell with MatplotlibShell as the internal shell. | |
1100 |
|
1100 | |||
1101 | Single-threaded class, meant for the Tk* and FLTK* backends. |
|
1101 | Single-threaded class, meant for the Tk* and FLTK* backends. | |
1102 |
|
1102 | |||
1103 | Having this on a separate class simplifies the external driver code.""" |
|
1103 | Having this on a separate class simplifies the external driver code.""" | |
1104 |
|
1104 | |||
1105 | def __init__(self,argv=None,user_ns=None,user_global_ns=None,debug=1): |
|
1105 | def __init__(self,argv=None,user_ns=None,user_global_ns=None,debug=1): | |
1106 | IPShell.__init__(self,argv,user_ns,user_global_ns,debug, |
|
1106 | IPShell.__init__(self,argv,user_ns,user_global_ns,debug, | |
1107 | shell_class=MatplotlibShell) |
|
1107 | shell_class=MatplotlibShell) | |
1108 | _load_pylab(self.IP.user_ns) |
|
1108 | _load_pylab(self.IP.user_ns) | |
1109 |
|
1109 | |||
1110 | class IPShellMatplotlibGTK(IPShellGTK): |
|
1110 | class IPShellMatplotlibGTK(IPShellGTK): | |
1111 | """Subclass IPShellGTK with MatplotlibMTShell as the internal shell. |
|
1111 | """Subclass IPShellGTK with MatplotlibMTShell as the internal shell. | |
1112 |
|
1112 | |||
1113 | Multi-threaded class, meant for the GTK* backends.""" |
|
1113 | Multi-threaded class, meant for the GTK* backends.""" | |
1114 |
|
1114 | |||
1115 | def __init__(self,argv=None,user_ns=None,user_global_ns=None,debug=1): |
|
1115 | def __init__(self,argv=None,user_ns=None,user_global_ns=None,debug=1): | |
1116 | IPShellGTK.__init__(self,argv,user_ns,user_global_ns,debug, |
|
1116 | IPShellGTK.__init__(self,argv,user_ns,user_global_ns,debug, | |
1117 | shell_class=MatplotlibMTShell) |
|
1117 | shell_class=MatplotlibMTShell) | |
1118 | _load_pylab(self.IP.user_ns) |
|
1118 | _load_pylab(self.IP.user_ns) | |
1119 |
|
1119 | |||
1120 | class IPShellMatplotlibWX(IPShellWX): |
|
1120 | class IPShellMatplotlibWX(IPShellWX): | |
1121 | """Subclass IPShellWX with MatplotlibMTShell as the internal shell. |
|
1121 | """Subclass IPShellWX with MatplotlibMTShell as the internal shell. | |
1122 |
|
1122 | |||
1123 | Multi-threaded class, meant for the WX* backends.""" |
|
1123 | Multi-threaded class, meant for the WX* backends.""" | |
1124 |
|
1124 | |||
1125 | def __init__(self,argv=None,user_ns=None,user_global_ns=None,debug=1): |
|
1125 | def __init__(self,argv=None,user_ns=None,user_global_ns=None,debug=1): | |
1126 | IPShellWX.__init__(self,argv,user_ns,user_global_ns,debug, |
|
1126 | IPShellWX.__init__(self,argv,user_ns,user_global_ns,debug, | |
1127 | shell_class=MatplotlibMTShell) |
|
1127 | shell_class=MatplotlibMTShell) | |
1128 | _load_pylab(self.IP.user_ns) |
|
1128 | _load_pylab(self.IP.user_ns) | |
1129 |
|
1129 | |||
1130 | class IPShellMatplotlibQt(IPShellQt): |
|
1130 | class IPShellMatplotlibQt(IPShellQt): | |
1131 | """Subclass IPShellQt with MatplotlibMTShell as the internal shell. |
|
1131 | """Subclass IPShellQt with MatplotlibMTShell as the internal shell. | |
1132 |
|
1132 | |||
1133 | Multi-threaded class, meant for the Qt* backends.""" |
|
1133 | Multi-threaded class, meant for the Qt* backends.""" | |
1134 |
|
1134 | |||
1135 | def __init__(self,argv=None,user_ns=None,user_global_ns=None,debug=1): |
|
1135 | def __init__(self,argv=None,user_ns=None,user_global_ns=None,debug=1): | |
1136 | IPShellQt.__init__(self,argv,user_ns,user_global_ns,debug, |
|
1136 | IPShellQt.__init__(self,argv,user_ns,user_global_ns,debug, | |
1137 | shell_class=MatplotlibMTShell) |
|
1137 | shell_class=MatplotlibMTShell) | |
1138 | _load_pylab(self.IP.user_ns) |
|
1138 | _load_pylab(self.IP.user_ns) | |
1139 |
|
1139 | |||
1140 | class IPShellMatplotlibQt4(IPShellQt4): |
|
1140 | class IPShellMatplotlibQt4(IPShellQt4): | |
1141 | """Subclass IPShellQt4 with MatplotlibMTShell as the internal shell. |
|
1141 | """Subclass IPShellQt4 with MatplotlibMTShell as the internal shell. | |
1142 |
|
1142 | |||
1143 | Multi-threaded class, meant for the Qt4* backends.""" |
|
1143 | Multi-threaded class, meant for the Qt4* backends.""" | |
1144 |
|
1144 | |||
1145 | def __init__(self,argv=None,user_ns=None,user_global_ns=None,debug=1): |
|
1145 | def __init__(self,argv=None,user_ns=None,user_global_ns=None,debug=1): | |
1146 | IPShellQt4.__init__(self,argv,user_ns,user_global_ns,debug, |
|
1146 | IPShellQt4.__init__(self,argv,user_ns,user_global_ns,debug, | |
1147 | shell_class=MatplotlibMTShell) |
|
1147 | shell_class=MatplotlibMTShell) | |
1148 | _load_pylab(self.IP.user_ns) |
|
1148 | _load_pylab(self.IP.user_ns) | |
1149 |
|
1149 | |||
1150 | #----------------------------------------------------------------------------- |
|
1150 | #----------------------------------------------------------------------------- | |
1151 | # Factory functions to actually start the proper thread-aware shell |
|
1151 | # Factory functions to actually start the proper thread-aware shell | |
1152 |
|
1152 | |||
1153 | def _select_shell(argv): |
|
1153 | def _select_shell(argv): | |
1154 | """Select a shell from the given argv vector. |
|
1154 | """Select a shell from the given argv vector. | |
1155 |
|
1155 | |||
1156 | This function implements the threading selection policy, allowing runtime |
|
1156 | This function implements the threading selection policy, allowing runtime | |
1157 | control of the threading mode, both for general users and for matplotlib. |
|
1157 | control of the threading mode, both for general users and for matplotlib. | |
1158 |
|
1158 | |||
1159 | Return: |
|
1159 | Return: | |
1160 | Shell class to be instantiated for runtime operation. |
|
1160 | Shell class to be instantiated for runtime operation. | |
1161 | """ |
|
1161 | """ | |
1162 |
|
1162 | |||
1163 | global USE_TK |
|
1163 | global USE_TK | |
1164 |
|
1164 | |||
1165 | mpl_shell = {'gthread' : IPShellMatplotlibGTK, |
|
1165 | mpl_shell = {'gthread' : IPShellMatplotlibGTK, | |
1166 | 'wthread' : IPShellMatplotlibWX, |
|
1166 | 'wthread' : IPShellMatplotlibWX, | |
1167 | 'qthread' : IPShellMatplotlibQt, |
|
1167 | 'qthread' : IPShellMatplotlibQt, | |
1168 | 'q4thread' : IPShellMatplotlibQt4, |
|
1168 | 'q4thread' : IPShellMatplotlibQt4, | |
1169 | 'tkthread' : IPShellMatplotlib, # Tk is built-in |
|
1169 | 'tkthread' : IPShellMatplotlib, # Tk is built-in | |
1170 | } |
|
1170 | } | |
1171 |
|
1171 | |||
1172 | th_shell = {'gthread' : IPShellGTK, |
|
1172 | th_shell = {'gthread' : IPShellGTK, | |
1173 | 'wthread' : IPShellWX, |
|
1173 | 'wthread' : IPShellWX, | |
1174 | 'qthread' : IPShellQt, |
|
1174 | 'qthread' : IPShellQt, | |
1175 | 'q4thread' : IPShellQt4, |
|
1175 | 'q4thread' : IPShellQt4, | |
1176 | 'tkthread' : IPShell, # Tk is built-in |
|
1176 | 'tkthread' : IPShell, # Tk is built-in | |
1177 | } |
|
1177 | } | |
1178 |
|
1178 | |||
1179 | backends = {'gthread' : 'GTKAgg', |
|
1179 | backends = {'gthread' : 'GTKAgg', | |
1180 | 'wthread' : 'WXAgg', |
|
1180 | 'wthread' : 'WXAgg', | |
1181 | 'qthread' : 'QtAgg', |
|
1181 | 'qthread' : 'QtAgg', | |
1182 | 'q4thread' :'Qt4Agg', |
|
1182 | 'q4thread' :'Qt4Agg', | |
1183 | 'tkthread' :'TkAgg', |
|
1183 | 'tkthread' :'TkAgg', | |
1184 | } |
|
1184 | } | |
1185 |
|
1185 | |||
1186 | all_opts = set(['tk','pylab','gthread','qthread','q4thread','wthread', |
|
1186 | all_opts = set(['tk','pylab','gthread','qthread','q4thread','wthread', | |
1187 | 'tkthread']) |
|
1187 | 'tkthread']) | |
1188 | user_opts = set([s.replace('-','') for s in argv[:3]]) |
|
1188 | user_opts = set([s.replace('-','') for s in argv[:3]]) | |
1189 | special_opts = user_opts & all_opts |
|
1189 | special_opts = user_opts & all_opts | |
1190 |
|
1190 | |||
1191 | if 'tk' in special_opts: |
|
1191 | if 'tk' in special_opts: | |
1192 | USE_TK = True |
|
1192 | USE_TK = True | |
1193 | special_opts.remove('tk') |
|
1193 | special_opts.remove('tk') | |
1194 |
|
1194 | |||
1195 | if 'pylab' in special_opts: |
|
1195 | if 'pylab' in special_opts: | |
1196 |
|
1196 | |||
1197 | try: |
|
1197 | try: | |
1198 | import matplotlib |
|
1198 | import matplotlib | |
1199 | except ImportError: |
|
1199 | except ImportError: | |
1200 | error('matplotlib could NOT be imported! Starting normal IPython.') |
|
1200 | error('matplotlib could NOT be imported! Starting normal IPython.') | |
1201 | return IPShell |
|
1201 | return IPShell | |
1202 |
|
1202 | |||
1203 | special_opts.remove('pylab') |
|
1203 | special_opts.remove('pylab') | |
1204 | # If there's any option left, it means the user wants to force the |
|
1204 | # If there's any option left, it means the user wants to force the | |
1205 | # threading backend, else it's auto-selected from the rc file |
|
1205 | # threading backend, else it's auto-selected from the rc file | |
1206 | if special_opts: |
|
1206 | if special_opts: | |
1207 | th_mode = special_opts.pop() |
|
1207 | th_mode = special_opts.pop() | |
1208 | matplotlib.rcParams['backend'] = backends[th_mode] |
|
1208 | matplotlib.rcParams['backend'] = backends[th_mode] | |
1209 | else: |
|
1209 | else: | |
1210 | backend = matplotlib.rcParams['backend'] |
|
1210 | backend = matplotlib.rcParams['backend'] | |
1211 | if backend.startswith('GTK'): |
|
1211 | if backend.startswith('GTK'): | |
1212 | th_mode = 'gthread' |
|
1212 | th_mode = 'gthread' | |
1213 | elif backend.startswith('WX'): |
|
1213 | elif backend.startswith('WX'): | |
1214 | th_mode = 'wthread' |
|
1214 | th_mode = 'wthread' | |
1215 | elif backend.startswith('Qt4'): |
|
1215 | elif backend.startswith('Qt4'): | |
1216 | th_mode = 'q4thread' |
|
1216 | th_mode = 'q4thread' | |
1217 | elif backend.startswith('Qt'): |
|
1217 | elif backend.startswith('Qt'): | |
1218 | th_mode = 'qthread' |
|
1218 | th_mode = 'qthread' | |
1219 | else: |
|
1219 | else: | |
1220 | # Any other backend, use plain Tk |
|
1220 | # Any other backend, use plain Tk | |
1221 | th_mode = 'tkthread' |
|
1221 | th_mode = 'tkthread' | |
1222 |
|
1222 | |||
1223 | return mpl_shell[th_mode] |
|
1223 | return mpl_shell[th_mode] | |
1224 | else: |
|
1224 | else: | |
1225 | # No pylab requested, just plain threads |
|
1225 | # No pylab requested, just plain threads | |
1226 | try: |
|
1226 | try: | |
1227 | th_mode = special_opts.pop() |
|
1227 | th_mode = special_opts.pop() | |
1228 | except KeyError: |
|
1228 | except KeyError: | |
1229 | th_mode = 'tkthread' |
|
1229 | th_mode = 'tkthread' | |
1230 | return th_shell[th_mode] |
|
1230 | return th_shell[th_mode] | |
1231 |
|
1231 | |||
1232 |
|
1232 | |||
1233 | # This is the one which should be called by external code. |
|
1233 | # This is the one which should be called by external code. | |
1234 | def start(user_ns = None): |
|
1234 | def start(user_ns = None): | |
1235 | """Return a running shell instance, dealing with threading options. |
|
1235 | """Return a running shell instance, dealing with threading options. | |
1236 |
|
1236 | |||
1237 | This is a factory function which will instantiate the proper IPython shell |
|
1237 | This is a factory function which will instantiate the proper IPython shell | |
1238 | based on the user's threading choice. Such a selector is needed because |
|
1238 | based on the user's threading choice. Such a selector is needed because | |
1239 | different GUI toolkits require different thread handling details.""" |
|
1239 | different GUI toolkits require different thread handling details.""" | |
1240 |
|
1240 | |||
1241 | shell = _select_shell(sys.argv) |
|
1241 | shell = _select_shell(sys.argv) | |
1242 | return shell(user_ns = user_ns) |
|
1242 | return shell(user_ns = user_ns) | |
1243 |
|
1243 | |||
1244 | # Some aliases for backwards compatibility |
|
1244 | # Some aliases for backwards compatibility | |
1245 | IPythonShell = IPShell |
|
1245 | IPythonShell = IPShell | |
1246 | IPythonShellEmbed = IPShellEmbed |
|
1246 | IPythonShellEmbed = IPShellEmbed | |
1247 | #************************ End of file <Shell.py> *************************** |
|
1247 | #************************ End of file <Shell.py> *************************** |
@@ -1,111 +1,111 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """Configuration loader |
|
2 | """Configuration loader | |
3 | """ |
|
3 | """ | |
4 |
|
4 | |||
5 | #***************************************************************************** |
|
5 | #***************************************************************************** | |
6 | # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu> |
|
6 | # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu> | |
7 | # |
|
7 | # | |
8 | # Distributed under the terms of the BSD License. The full license is in |
|
8 | # Distributed under the terms of the BSD License. The full license is in | |
9 | # the file COPYING, distributed as part of this software. |
|
9 | # the file COPYING, distributed as part of this software. | |
10 | #***************************************************************************** |
|
10 | #***************************************************************************** | |
11 |
|
11 | |||
12 | import exceptions |
|
12 | import exceptions | |
13 | import os |
|
13 | import os | |
14 | from pprint import pprint |
|
14 | from pprint import pprint | |
15 |
|
15 | |||
16 | from IPython import ultraTB |
|
16 | from IPython import ultraTB | |
17 | from IPython.ipstruct import Struct |
|
17 | from IPython.utils.ipstruct import Struct | |
18 | from IPython.utils.genutils import * |
|
18 | from IPython.utils.genutils import * | |
19 |
|
19 | |||
20 | class ConfigLoaderError(exceptions.Exception): |
|
20 | class ConfigLoaderError(exceptions.Exception): | |
21 | """Exception for ConfigLoader class.""" |
|
21 | """Exception for ConfigLoader class.""" | |
22 |
|
22 | |||
23 | def __init__(self,args=None): |
|
23 | def __init__(self,args=None): | |
24 | self.args = args |
|
24 | self.args = args | |
25 |
|
25 | |||
26 | class ConfigLoader: |
|
26 | class ConfigLoader: | |
27 |
|
27 | |||
28 | """Configuration file loader capable of handling recursive inclusions and |
|
28 | """Configuration file loader capable of handling recursive inclusions and | |
29 | with parametrized conflict resolution for multiply found keys.""" |
|
29 | with parametrized conflict resolution for multiply found keys.""" | |
30 |
|
30 | |||
31 | def __init__(self,conflict=None,field_sep=None,reclimit=15): |
|
31 | def __init__(self,conflict=None,field_sep=None,reclimit=15): | |
32 |
|
32 | |||
33 | """The reclimit parameter controls the number of recursive |
|
33 | """The reclimit parameter controls the number of recursive | |
34 | configuration file inclusions. This way we can stop early on (before |
|
34 | configuration file inclusions. This way we can stop early on (before | |
35 | python's own recursion limit is hit) if there is a circular |
|
35 | python's own recursion limit is hit) if there is a circular | |
36 | inclusion. |
|
36 | inclusion. | |
37 |
|
37 | |||
38 | - conflict: dictionary for conflict resolutions (see Struct.merge()) |
|
38 | - conflict: dictionary for conflict resolutions (see Struct.merge()) | |
39 |
|
39 | |||
40 | """ |
|
40 | """ | |
41 | self.conflict = conflict |
|
41 | self.conflict = conflict | |
42 | self.field_sep = field_sep |
|
42 | self.field_sep = field_sep | |
43 | self.reset(reclimit) |
|
43 | self.reset(reclimit) | |
44 |
|
44 | |||
45 | def reset(self,reclimit=15): |
|
45 | def reset(self,reclimit=15): | |
46 | self.reclimit = reclimit |
|
46 | self.reclimit = reclimit | |
47 | self.recdepth = 0 |
|
47 | self.recdepth = 0 | |
48 | self.included = [] |
|
48 | self.included = [] | |
49 |
|
49 | |||
50 | def load(self,fname,convert=None,recurse_key='',incpath = '.',**kw): |
|
50 | def load(self,fname,convert=None,recurse_key='',incpath = '.',**kw): | |
51 | """Load a configuration file, return the resulting Struct. |
|
51 | """Load a configuration file, return the resulting Struct. | |
52 |
|
52 | |||
53 | Call: load_config(fname,convert=None,conflict=None,recurse_key='') |
|
53 | Call: load_config(fname,convert=None,conflict=None,recurse_key='') | |
54 |
|
54 | |||
55 | - fname: file to load from. |
|
55 | - fname: file to load from. | |
56 | - convert: dictionary of type conversions (see read_dict()) |
|
56 | - convert: dictionary of type conversions (see read_dict()) | |
57 | - recurse_key: keyword in dictionary to trigger recursive file |
|
57 | - recurse_key: keyword in dictionary to trigger recursive file | |
58 | inclusions. |
|
58 | inclusions. | |
59 | """ |
|
59 | """ | |
60 |
|
60 | |||
61 | if self.recdepth > self.reclimit: |
|
61 | if self.recdepth > self.reclimit: | |
62 | raise ConfigLoaderError, 'maximum recursive inclusion of rcfiles '+\ |
|
62 | raise ConfigLoaderError, 'maximum recursive inclusion of rcfiles '+\ | |
63 | 'exceeded: ' + `self.recdepth` + \ |
|
63 | 'exceeded: ' + `self.recdepth` + \ | |
64 | '.\nMaybe you have a circular chain of inclusions?' |
|
64 | '.\nMaybe you have a circular chain of inclusions?' | |
65 | self.recdepth += 1 |
|
65 | self.recdepth += 1 | |
66 | fname = filefind(fname,incpath) |
|
66 | fname = filefind(fname,incpath) | |
67 | data = Struct() |
|
67 | data = Struct() | |
68 | # avoid including the same file more than once |
|
68 | # avoid including the same file more than once | |
69 | if fname in self.included: |
|
69 | if fname in self.included: | |
70 | return data |
|
70 | return data | |
71 | Xinfo = ultraTB.AutoFormattedTB(color_scheme='NoColor') |
|
71 | Xinfo = ultraTB.AutoFormattedTB(color_scheme='NoColor') | |
72 | if convert==None and recurse_key : convert = {qwflat:recurse_key} |
|
72 | if convert==None and recurse_key : convert = {qwflat:recurse_key} | |
73 | # for production, change warn to 0: |
|
73 | # for production, change warn to 0: | |
74 | data.merge(read_dict(fname,convert,fs=self.field_sep,strip=1, |
|
74 | data.merge(read_dict(fname,convert,fs=self.field_sep,strip=1, | |
75 | warn=0,no_empty=0,**kw)) |
|
75 | warn=0,no_empty=0,**kw)) | |
76 | # keep track of successfully loaded files |
|
76 | # keep track of successfully loaded files | |
77 | self.included.append(fname) |
|
77 | self.included.append(fname) | |
78 | if recurse_key in data: |
|
78 | if recurse_key in data: | |
79 | for incfilename in data[recurse_key]: |
|
79 | for incfilename in data[recurse_key]: | |
80 | found=0 |
|
80 | found=0 | |
81 | try: |
|
81 | try: | |
82 | incfile = filefind(incfilename,incpath) |
|
82 | incfile = filefind(incfilename,incpath) | |
83 | except IOError: |
|
83 | except IOError: | |
84 | if os.name in ['nt','dos']: |
|
84 | if os.name in ['nt','dos']: | |
85 | try: |
|
85 | try: | |
86 | # Try again with '.ini' extension |
|
86 | # Try again with '.ini' extension | |
87 | incfilename += '.ini' |
|
87 | incfilename += '.ini' | |
88 | incfile = filefind(incfilename,incpath) |
|
88 | incfile = filefind(incfilename,incpath) | |
89 | except IOError: |
|
89 | except IOError: | |
90 | found = 0 |
|
90 | found = 0 | |
91 | else: |
|
91 | else: | |
92 | found = 1 |
|
92 | found = 1 | |
93 | else: |
|
93 | else: | |
94 | found = 0 |
|
94 | found = 0 | |
95 | else: |
|
95 | else: | |
96 | found = 1 |
|
96 | found = 1 | |
97 | if found: |
|
97 | if found: | |
98 | try: |
|
98 | try: | |
99 | data.merge(self.load(incfile,convert,recurse_key, |
|
99 | data.merge(self.load(incfile,convert,recurse_key, | |
100 | incpath,**kw), |
|
100 | incpath,**kw), | |
101 | self.conflict) |
|
101 | self.conflict) | |
102 | except: |
|
102 | except: | |
103 | Xinfo() |
|
103 | Xinfo() | |
104 | warn('Problem loading included file: '+ |
|
104 | warn('Problem loading included file: '+ | |
105 | `incfilename` + '. Ignoring it...') |
|
105 | `incfilename` + '. Ignoring it...') | |
106 | else: |
|
106 | else: | |
107 | warn('File `%s` not found. Included by %s' % (incfilename,fname)) |
|
107 | warn('File `%s` not found. Included by %s' % (incfilename,fname)) | |
108 |
|
108 | |||
109 | return data |
|
109 | return data | |
110 |
|
110 | |||
111 | # end ConfigLoader |
|
111 | # end ConfigLoader |
@@ -1,639 +1,639 b'' | |||||
1 | """Word completion for IPython. |
|
1 | """Word completion for IPython. | |
2 |
|
2 | |||
3 | This module is a fork of the rlcompleter module in the Python standard |
|
3 | This module is a fork of the rlcompleter module in the Python standard | |
4 | library. The original enhancements made to rlcompleter have been sent |
|
4 | library. The original enhancements made to rlcompleter have been sent | |
5 | upstream and were accepted as of Python 2.3, but we need a lot more |
|
5 | upstream and were accepted as of Python 2.3, but we need a lot more | |
6 | functionality specific to IPython, so this module will continue to live as an |
|
6 | functionality specific to IPython, so this module will continue to live as an | |
7 | IPython-specific utility. |
|
7 | IPython-specific utility. | |
8 |
|
8 | |||
9 | Original rlcompleter documentation: |
|
9 | Original rlcompleter documentation: | |
10 |
|
10 | |||
11 | This requires the latest extension to the readline module (the |
|
11 | This requires the latest extension to the readline module (the | |
12 | completes keywords, built-ins and globals in __main__; when completing |
|
12 | completes keywords, built-ins and globals in __main__; when completing | |
13 | NAME.NAME..., it evaluates (!) the expression up to the last dot and |
|
13 | NAME.NAME..., it evaluates (!) the expression up to the last dot and | |
14 | completes its attributes. |
|
14 | completes its attributes. | |
15 |
|
15 | |||
16 | It's very cool to do "import string" type "string.", hit the |
|
16 | It's very cool to do "import string" type "string.", hit the | |
17 | completion key (twice), and see the list of names defined by the |
|
17 | completion key (twice), and see the list of names defined by the | |
18 | string module! |
|
18 | string module! | |
19 |
|
19 | |||
20 | Tip: to use the tab key as the completion key, call |
|
20 | Tip: to use the tab key as the completion key, call | |
21 |
|
21 | |||
22 | readline.parse_and_bind("tab: complete") |
|
22 | readline.parse_and_bind("tab: complete") | |
23 |
|
23 | |||
24 | Notes: |
|
24 | Notes: | |
25 |
|
25 | |||
26 | - Exceptions raised by the completer function are *ignored* (and |
|
26 | - Exceptions raised by the completer function are *ignored* (and | |
27 | generally cause the completion to fail). This is a feature -- since |
|
27 | generally cause the completion to fail). This is a feature -- since | |
28 | readline sets the tty device in raw (or cbreak) mode, printing a |
|
28 | readline sets the tty device in raw (or cbreak) mode, printing a | |
29 | traceback wouldn't work well without some complicated hoopla to save, |
|
29 | traceback wouldn't work well without some complicated hoopla to save, | |
30 | reset and restore the tty state. |
|
30 | reset and restore the tty state. | |
31 |
|
31 | |||
32 | - The evaluation of the NAME.NAME... form may cause arbitrary |
|
32 | - The evaluation of the NAME.NAME... form may cause arbitrary | |
33 | application defined code to be executed if an object with a |
|
33 | application defined code to be executed if an object with a | |
34 | __getattr__ hook is found. Since it is the responsibility of the |
|
34 | __getattr__ hook is found. Since it is the responsibility of the | |
35 | application (or the user) to enable this feature, I consider this an |
|
35 | application (or the user) to enable this feature, I consider this an | |
36 | acceptable risk. More complicated expressions (e.g. function calls or |
|
36 | acceptable risk. More complicated expressions (e.g. function calls or | |
37 | indexing operations) are *not* evaluated. |
|
37 | indexing operations) are *not* evaluated. | |
38 |
|
38 | |||
39 | - GNU readline is also used by the built-in functions input() and |
|
39 | - GNU readline is also used by the built-in functions input() and | |
40 | raw_input(), and thus these also benefit/suffer from the completer |
|
40 | raw_input(), and thus these also benefit/suffer from the completer | |
41 | features. Clearly an interactive application can benefit by |
|
41 | features. Clearly an interactive application can benefit by | |
42 | specifying its own completer function and using raw_input() for all |
|
42 | specifying its own completer function and using raw_input() for all | |
43 | its input. |
|
43 | its input. | |
44 |
|
44 | |||
45 | - When the original stdin is not a tty device, GNU readline is never |
|
45 | - When the original stdin is not a tty device, GNU readline is never | |
46 | used, and this module (and the readline module) are silently inactive. |
|
46 | used, and this module (and the readline module) are silently inactive. | |
47 |
|
47 | |||
48 | """ |
|
48 | """ | |
49 |
|
49 | |||
50 | #***************************************************************************** |
|
50 | #***************************************************************************** | |
51 | # |
|
51 | # | |
52 | # Since this file is essentially a minimally modified copy of the rlcompleter |
|
52 | # Since this file is essentially a minimally modified copy of the rlcompleter | |
53 | # module which is part of the standard Python distribution, I assume that the |
|
53 | # module which is part of the standard Python distribution, I assume that the | |
54 | # proper procedure is to maintain its copyright as belonging to the Python |
|
54 | # proper procedure is to maintain its copyright as belonging to the Python | |
55 | # Software Foundation (in addition to my own, for all new code). |
|
55 | # Software Foundation (in addition to my own, for all new code). | |
56 | # |
|
56 | # | |
57 | # Copyright (C) 2001 Python Software Foundation, www.python.org |
|
57 | # Copyright (C) 2001 Python Software Foundation, www.python.org | |
58 | # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu> |
|
58 | # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu> | |
59 | # |
|
59 | # | |
60 | # Distributed under the terms of the BSD License. The full license is in |
|
60 | # Distributed under the terms of the BSD License. The full license is in | |
61 | # the file COPYING, distributed as part of this software. |
|
61 | # the file COPYING, distributed as part of this software. | |
62 | # |
|
62 | # | |
63 | #***************************************************************************** |
|
63 | #***************************************************************************** | |
64 |
|
64 | |||
65 | import __builtin__ |
|
65 | import __builtin__ | |
66 | import __main__ |
|
66 | import __main__ | |
67 | import glob |
|
67 | import glob | |
68 | import keyword |
|
68 | import keyword | |
69 | import os |
|
69 | import os | |
70 | import re |
|
70 | import re | |
71 | import shlex |
|
71 | import shlex | |
72 | import sys |
|
72 | import sys | |
73 | import IPython.rlineimpl as readline |
|
73 | import IPython.rlineimpl as readline | |
74 | import itertools |
|
74 | import itertools | |
75 | from IPython.ipstruct import Struct |
|
75 | from IPython.utils.ipstruct import Struct | |
76 | from IPython.core import ipapi |
|
76 | from IPython.core import ipapi | |
77 | from IPython.utils import generics |
|
77 | from IPython.utils import generics | |
78 | import types |
|
78 | import types | |
79 |
|
79 | |||
80 | # Python 2.4 offers sets as a builtin |
|
80 | # Python 2.4 offers sets as a builtin | |
81 | try: |
|
81 | try: | |
82 | set() |
|
82 | set() | |
83 | except NameError: |
|
83 | except NameError: | |
84 | from sets import Set as set |
|
84 | from sets import Set as set | |
85 |
|
85 | |||
86 | from IPython.utils.genutils import debugx, dir2 |
|
86 | from IPython.utils.genutils import debugx, dir2 | |
87 |
|
87 | |||
88 | __all__ = ['Completer','IPCompleter'] |
|
88 | __all__ = ['Completer','IPCompleter'] | |
89 |
|
89 | |||
90 | class Completer: |
|
90 | class Completer: | |
91 | def __init__(self,namespace=None,global_namespace=None): |
|
91 | def __init__(self,namespace=None,global_namespace=None): | |
92 | """Create a new completer for the command line. |
|
92 | """Create a new completer for the command line. | |
93 |
|
93 | |||
94 | Completer([namespace,global_namespace]) -> completer instance. |
|
94 | Completer([namespace,global_namespace]) -> completer instance. | |
95 |
|
95 | |||
96 | If unspecified, the default namespace where completions are performed |
|
96 | If unspecified, the default namespace where completions are performed | |
97 | is __main__ (technically, __main__.__dict__). Namespaces should be |
|
97 | is __main__ (technically, __main__.__dict__). Namespaces should be | |
98 | given as dictionaries. |
|
98 | given as dictionaries. | |
99 |
|
99 | |||
100 | An optional second namespace can be given. This allows the completer |
|
100 | An optional second namespace can be given. This allows the completer | |
101 | to handle cases where both the local and global scopes need to be |
|
101 | to handle cases where both the local and global scopes need to be | |
102 | distinguished. |
|
102 | distinguished. | |
103 |
|
103 | |||
104 | Completer instances should be used as the completion mechanism of |
|
104 | Completer instances should be used as the completion mechanism of | |
105 | readline via the set_completer() call: |
|
105 | readline via the set_completer() call: | |
106 |
|
106 | |||
107 | readline.set_completer(Completer(my_namespace).complete) |
|
107 | readline.set_completer(Completer(my_namespace).complete) | |
108 | """ |
|
108 | """ | |
109 |
|
109 | |||
110 | # Don't bind to namespace quite yet, but flag whether the user wants a |
|
110 | # Don't bind to namespace quite yet, but flag whether the user wants a | |
111 | # specific namespace or to use __main__.__dict__. This will allow us |
|
111 | # specific namespace or to use __main__.__dict__. This will allow us | |
112 | # to bind to __main__.__dict__ at completion time, not now. |
|
112 | # to bind to __main__.__dict__ at completion time, not now. | |
113 | if namespace is None: |
|
113 | if namespace is None: | |
114 | self.use_main_ns = 1 |
|
114 | self.use_main_ns = 1 | |
115 | else: |
|
115 | else: | |
116 | self.use_main_ns = 0 |
|
116 | self.use_main_ns = 0 | |
117 | self.namespace = namespace |
|
117 | self.namespace = namespace | |
118 |
|
118 | |||
119 | # The global namespace, if given, can be bound directly |
|
119 | # The global namespace, if given, can be bound directly | |
120 | if global_namespace is None: |
|
120 | if global_namespace is None: | |
121 | self.global_namespace = {} |
|
121 | self.global_namespace = {} | |
122 | else: |
|
122 | else: | |
123 | self.global_namespace = global_namespace |
|
123 | self.global_namespace = global_namespace | |
124 |
|
124 | |||
125 | def complete(self, text, state): |
|
125 | def complete(self, text, state): | |
126 | """Return the next possible completion for 'text'. |
|
126 | """Return the next possible completion for 'text'. | |
127 |
|
127 | |||
128 | This is called successively with state == 0, 1, 2, ... until it |
|
128 | This is called successively with state == 0, 1, 2, ... until it | |
129 | returns None. The completion should begin with 'text'. |
|
129 | returns None. The completion should begin with 'text'. | |
130 |
|
130 | |||
131 | """ |
|
131 | """ | |
132 | if self.use_main_ns: |
|
132 | if self.use_main_ns: | |
133 | self.namespace = __main__.__dict__ |
|
133 | self.namespace = __main__.__dict__ | |
134 |
|
134 | |||
135 | if state == 0: |
|
135 | if state == 0: | |
136 | if "." in text: |
|
136 | if "." in text: | |
137 | self.matches = self.attr_matches(text) |
|
137 | self.matches = self.attr_matches(text) | |
138 | else: |
|
138 | else: | |
139 | self.matches = self.global_matches(text) |
|
139 | self.matches = self.global_matches(text) | |
140 | try: |
|
140 | try: | |
141 | return self.matches[state] |
|
141 | return self.matches[state] | |
142 | except IndexError: |
|
142 | except IndexError: | |
143 | return None |
|
143 | return None | |
144 |
|
144 | |||
145 | def global_matches(self, text): |
|
145 | def global_matches(self, text): | |
146 | """Compute matches when text is a simple name. |
|
146 | """Compute matches when text is a simple name. | |
147 |
|
147 | |||
148 | Return a list of all keywords, built-in functions and names currently |
|
148 | Return a list of all keywords, built-in functions and names currently | |
149 | defined in self.namespace or self.global_namespace that match. |
|
149 | defined in self.namespace or self.global_namespace that match. | |
150 |
|
150 | |||
151 | """ |
|
151 | """ | |
152 | matches = [] |
|
152 | matches = [] | |
153 | match_append = matches.append |
|
153 | match_append = matches.append | |
154 | n = len(text) |
|
154 | n = len(text) | |
155 | for lst in [keyword.kwlist, |
|
155 | for lst in [keyword.kwlist, | |
156 | __builtin__.__dict__.keys(), |
|
156 | __builtin__.__dict__.keys(), | |
157 | self.namespace.keys(), |
|
157 | self.namespace.keys(), | |
158 | self.global_namespace.keys()]: |
|
158 | self.global_namespace.keys()]: | |
159 | for word in lst: |
|
159 | for word in lst: | |
160 | if word[:n] == text and word != "__builtins__": |
|
160 | if word[:n] == text and word != "__builtins__": | |
161 | match_append(word) |
|
161 | match_append(word) | |
162 | return matches |
|
162 | return matches | |
163 |
|
163 | |||
164 | def attr_matches(self, text): |
|
164 | def attr_matches(self, text): | |
165 | """Compute matches when text contains a dot. |
|
165 | """Compute matches when text contains a dot. | |
166 |
|
166 | |||
167 | Assuming the text is of the form NAME.NAME....[NAME], and is |
|
167 | Assuming the text is of the form NAME.NAME....[NAME], and is | |
168 | evaluatable in self.namespace or self.global_namespace, it will be |
|
168 | evaluatable in self.namespace or self.global_namespace, it will be | |
169 | evaluated and its attributes (as revealed by dir()) are used as |
|
169 | evaluated and its attributes (as revealed by dir()) are used as | |
170 | possible completions. (For class instances, class members are are |
|
170 | possible completions. (For class instances, class members are are | |
171 | also considered.) |
|
171 | also considered.) | |
172 |
|
172 | |||
173 | WARNING: this can still invoke arbitrary C code, if an object |
|
173 | WARNING: this can still invoke arbitrary C code, if an object | |
174 | with a __getattr__ hook is evaluated. |
|
174 | with a __getattr__ hook is evaluated. | |
175 |
|
175 | |||
176 | """ |
|
176 | """ | |
177 | import re |
|
177 | import re | |
178 |
|
178 | |||
179 | # Another option, seems to work great. Catches things like ''.<tab> |
|
179 | # Another option, seems to work great. Catches things like ''.<tab> | |
180 | m = re.match(r"(\S+(\.\w+)*)\.(\w*)$", text) |
|
180 | m = re.match(r"(\S+(\.\w+)*)\.(\w*)$", text) | |
181 |
|
181 | |||
182 | if not m: |
|
182 | if not m: | |
183 | return [] |
|
183 | return [] | |
184 |
|
184 | |||
185 | expr, attr = m.group(1, 3) |
|
185 | expr, attr = m.group(1, 3) | |
186 | try: |
|
186 | try: | |
187 | obj = eval(expr, self.namespace) |
|
187 | obj = eval(expr, self.namespace) | |
188 | except: |
|
188 | except: | |
189 | try: |
|
189 | try: | |
190 | obj = eval(expr, self.global_namespace) |
|
190 | obj = eval(expr, self.global_namespace) | |
191 | except: |
|
191 | except: | |
192 | return [] |
|
192 | return [] | |
193 |
|
193 | |||
194 | words = dir2(obj) |
|
194 | words = dir2(obj) | |
195 |
|
195 | |||
196 | try: |
|
196 | try: | |
197 | words = generics.complete_object(obj, words) |
|
197 | words = generics.complete_object(obj, words) | |
198 | except ipapi.TryNext: |
|
198 | except ipapi.TryNext: | |
199 | pass |
|
199 | pass | |
200 | # Build match list to return |
|
200 | # Build match list to return | |
201 | n = len(attr) |
|
201 | n = len(attr) | |
202 | res = ["%s.%s" % (expr, w) for w in words if w[:n] == attr ] |
|
202 | res = ["%s.%s" % (expr, w) for w in words if w[:n] == attr ] | |
203 | return res |
|
203 | return res | |
204 |
|
204 | |||
205 | class IPCompleter(Completer): |
|
205 | class IPCompleter(Completer): | |
206 | """Extension of the completer class with IPython-specific features""" |
|
206 | """Extension of the completer class with IPython-specific features""" | |
207 |
|
207 | |||
208 | def __init__(self,shell,namespace=None,global_namespace=None, |
|
208 | def __init__(self,shell,namespace=None,global_namespace=None, | |
209 | omit__names=0,alias_table=None): |
|
209 | omit__names=0,alias_table=None): | |
210 | """IPCompleter() -> completer |
|
210 | """IPCompleter() -> completer | |
211 |
|
211 | |||
212 | Return a completer object suitable for use by the readline library |
|
212 | Return a completer object suitable for use by the readline library | |
213 | via readline.set_completer(). |
|
213 | via readline.set_completer(). | |
214 |
|
214 | |||
215 | Inputs: |
|
215 | Inputs: | |
216 |
|
216 | |||
217 | - shell: a pointer to the ipython shell itself. This is needed |
|
217 | - shell: a pointer to the ipython shell itself. This is needed | |
218 | because this completer knows about magic functions, and those can |
|
218 | because this completer knows about magic functions, and those can | |
219 | only be accessed via the ipython instance. |
|
219 | only be accessed via the ipython instance. | |
220 |
|
220 | |||
221 | - namespace: an optional dict where completions are performed. |
|
221 | - namespace: an optional dict where completions are performed. | |
222 |
|
222 | |||
223 | - global_namespace: secondary optional dict for completions, to |
|
223 | - global_namespace: secondary optional dict for completions, to | |
224 | handle cases (such as IPython embedded inside functions) where |
|
224 | handle cases (such as IPython embedded inside functions) where | |
225 | both Python scopes are visible. |
|
225 | both Python scopes are visible. | |
226 |
|
226 | |||
227 | - The optional omit__names parameter sets the completer to omit the |
|
227 | - The optional omit__names parameter sets the completer to omit the | |
228 | 'magic' names (__magicname__) for python objects unless the text |
|
228 | 'magic' names (__magicname__) for python objects unless the text | |
229 | to be completed explicitly starts with one or more underscores. |
|
229 | to be completed explicitly starts with one or more underscores. | |
230 |
|
230 | |||
231 | - If alias_table is supplied, it should be a dictionary of aliases |
|
231 | - If alias_table is supplied, it should be a dictionary of aliases | |
232 | to complete. """ |
|
232 | to complete. """ | |
233 |
|
233 | |||
234 | Completer.__init__(self,namespace,global_namespace) |
|
234 | Completer.__init__(self,namespace,global_namespace) | |
235 | self.magic_prefix = shell.name+'.magic_' |
|
235 | self.magic_prefix = shell.name+'.magic_' | |
236 | self.magic_escape = shell.ESC_MAGIC |
|
236 | self.magic_escape = shell.ESC_MAGIC | |
237 | self.readline = readline |
|
237 | self.readline = readline | |
238 | delims = self.readline.get_completer_delims() |
|
238 | delims = self.readline.get_completer_delims() | |
239 | delims = delims.replace(self.magic_escape,'') |
|
239 | delims = delims.replace(self.magic_escape,'') | |
240 | self.readline.set_completer_delims(delims) |
|
240 | self.readline.set_completer_delims(delims) | |
241 | self.get_line_buffer = self.readline.get_line_buffer |
|
241 | self.get_line_buffer = self.readline.get_line_buffer | |
242 | self.get_endidx = self.readline.get_endidx |
|
242 | self.get_endidx = self.readline.get_endidx | |
243 | self.omit__names = omit__names |
|
243 | self.omit__names = omit__names | |
244 | self.merge_completions = shell.rc.readline_merge_completions |
|
244 | self.merge_completions = shell.rc.readline_merge_completions | |
245 | if alias_table is None: |
|
245 | if alias_table is None: | |
246 | alias_table = {} |
|
246 | alias_table = {} | |
247 | self.alias_table = alias_table |
|
247 | self.alias_table = alias_table | |
248 | # Regexp to split filenames with spaces in them |
|
248 | # Regexp to split filenames with spaces in them | |
249 | self.space_name_re = re.compile(r'([^\\] )') |
|
249 | self.space_name_re = re.compile(r'([^\\] )') | |
250 | # Hold a local ref. to glob.glob for speed |
|
250 | # Hold a local ref. to glob.glob for speed | |
251 | self.glob = glob.glob |
|
251 | self.glob = glob.glob | |
252 |
|
252 | |||
253 | # Determine if we are running on 'dumb' terminals, like (X)Emacs |
|
253 | # Determine if we are running on 'dumb' terminals, like (X)Emacs | |
254 | # buffers, to avoid completion problems. |
|
254 | # buffers, to avoid completion problems. | |
255 | term = os.environ.get('TERM','xterm') |
|
255 | term = os.environ.get('TERM','xterm') | |
256 | self.dumb_terminal = term in ['dumb','emacs'] |
|
256 | self.dumb_terminal = term in ['dumb','emacs'] | |
257 |
|
257 | |||
258 | # Special handling of backslashes needed in win32 platforms |
|
258 | # Special handling of backslashes needed in win32 platforms | |
259 | if sys.platform == "win32": |
|
259 | if sys.platform == "win32": | |
260 | self.clean_glob = self._clean_glob_win32 |
|
260 | self.clean_glob = self._clean_glob_win32 | |
261 | else: |
|
261 | else: | |
262 | self.clean_glob = self._clean_glob |
|
262 | self.clean_glob = self._clean_glob | |
263 | self.matchers = [self.python_matches, |
|
263 | self.matchers = [self.python_matches, | |
264 | self.file_matches, |
|
264 | self.file_matches, | |
265 | self.alias_matches, |
|
265 | self.alias_matches, | |
266 | self.python_func_kw_matches] |
|
266 | self.python_func_kw_matches] | |
267 |
|
267 | |||
268 |
|
268 | |||
269 | # Code contributed by Alex Schmolck, for ipython/emacs integration |
|
269 | # Code contributed by Alex Schmolck, for ipython/emacs integration | |
270 | def all_completions(self, text): |
|
270 | def all_completions(self, text): | |
271 | """Return all possible completions for the benefit of emacs.""" |
|
271 | """Return all possible completions for the benefit of emacs.""" | |
272 |
|
272 | |||
273 | completions = [] |
|
273 | completions = [] | |
274 | comp_append = completions.append |
|
274 | comp_append = completions.append | |
275 | try: |
|
275 | try: | |
276 | for i in xrange(sys.maxint): |
|
276 | for i in xrange(sys.maxint): | |
277 | res = self.complete(text, i) |
|
277 | res = self.complete(text, i) | |
278 |
|
278 | |||
279 | if not res: break |
|
279 | if not res: break | |
280 |
|
280 | |||
281 | comp_append(res) |
|
281 | comp_append(res) | |
282 | #XXX workaround for ``notDefined.<tab>`` |
|
282 | #XXX workaround for ``notDefined.<tab>`` | |
283 | except NameError: |
|
283 | except NameError: | |
284 | pass |
|
284 | pass | |
285 | return completions |
|
285 | return completions | |
286 | # /end Alex Schmolck code. |
|
286 | # /end Alex Schmolck code. | |
287 |
|
287 | |||
288 | def _clean_glob(self,text): |
|
288 | def _clean_glob(self,text): | |
289 | return self.glob("%s*" % text) |
|
289 | return self.glob("%s*" % text) | |
290 |
|
290 | |||
291 | def _clean_glob_win32(self,text): |
|
291 | def _clean_glob_win32(self,text): | |
292 | return [f.replace("\\","/") |
|
292 | return [f.replace("\\","/") | |
293 | for f in self.glob("%s*" % text)] |
|
293 | for f in self.glob("%s*" % text)] | |
294 |
|
294 | |||
295 | def file_matches(self, text): |
|
295 | def file_matches(self, text): | |
296 | """Match filenames, expanding ~USER type strings. |
|
296 | """Match filenames, expanding ~USER type strings. | |
297 |
|
297 | |||
298 | Most of the seemingly convoluted logic in this completer is an |
|
298 | Most of the seemingly convoluted logic in this completer is an | |
299 | attempt to handle filenames with spaces in them. And yet it's not |
|
299 | attempt to handle filenames with spaces in them. And yet it's not | |
300 | quite perfect, because Python's readline doesn't expose all of the |
|
300 | quite perfect, because Python's readline doesn't expose all of the | |
301 | GNU readline details needed for this to be done correctly. |
|
301 | GNU readline details needed for this to be done correctly. | |
302 |
|
302 | |||
303 | For a filename with a space in it, the printed completions will be |
|
303 | For a filename with a space in it, the printed completions will be | |
304 | only the parts after what's already been typed (instead of the |
|
304 | only the parts after what's already been typed (instead of the | |
305 | full completions, as is normally done). I don't think with the |
|
305 | full completions, as is normally done). I don't think with the | |
306 | current (as of Python 2.3) Python readline it's possible to do |
|
306 | current (as of Python 2.3) Python readline it's possible to do | |
307 | better.""" |
|
307 | better.""" | |
308 |
|
308 | |||
309 | #print 'Completer->file_matches: <%s>' % text # dbg |
|
309 | #print 'Completer->file_matches: <%s>' % text # dbg | |
310 |
|
310 | |||
311 | # chars that require escaping with backslash - i.e. chars |
|
311 | # chars that require escaping with backslash - i.e. chars | |
312 | # that readline treats incorrectly as delimiters, but we |
|
312 | # that readline treats incorrectly as delimiters, but we | |
313 | # don't want to treat as delimiters in filename matching |
|
313 | # don't want to treat as delimiters in filename matching | |
314 | # when escaped with backslash |
|
314 | # when escaped with backslash | |
315 |
|
315 | |||
316 | if sys.platform == 'win32': |
|
316 | if sys.platform == 'win32': | |
317 | protectables = ' ' |
|
317 | protectables = ' ' | |
318 | else: |
|
318 | else: | |
319 | protectables = ' ()' |
|
319 | protectables = ' ()' | |
320 |
|
320 | |||
321 | if text.startswith('!'): |
|
321 | if text.startswith('!'): | |
322 | text = text[1:] |
|
322 | text = text[1:] | |
323 | text_prefix = '!' |
|
323 | text_prefix = '!' | |
324 | else: |
|
324 | else: | |
325 | text_prefix = '' |
|
325 | text_prefix = '' | |
326 |
|
326 | |||
327 | def protect_filename(s): |
|
327 | def protect_filename(s): | |
328 | return "".join([(ch in protectables and '\\' + ch or ch) |
|
328 | return "".join([(ch in protectables and '\\' + ch or ch) | |
329 | for ch in s]) |
|
329 | for ch in s]) | |
330 |
|
330 | |||
331 | def single_dir_expand(matches): |
|
331 | def single_dir_expand(matches): | |
332 | "Recursively expand match lists containing a single dir." |
|
332 | "Recursively expand match lists containing a single dir." | |
333 |
|
333 | |||
334 | if len(matches) == 1 and os.path.isdir(matches[0]): |
|
334 | if len(matches) == 1 and os.path.isdir(matches[0]): | |
335 | # Takes care of links to directories also. Use '/' |
|
335 | # Takes care of links to directories also. Use '/' | |
336 | # explicitly, even under Windows, so that name completions |
|
336 | # explicitly, even under Windows, so that name completions | |
337 | # don't end up escaped. |
|
337 | # don't end up escaped. | |
338 | d = matches[0] |
|
338 | d = matches[0] | |
339 | if d[-1] in ['/','\\']: |
|
339 | if d[-1] in ['/','\\']: | |
340 | d = d[:-1] |
|
340 | d = d[:-1] | |
341 |
|
341 | |||
342 | subdirs = os.listdir(d) |
|
342 | subdirs = os.listdir(d) | |
343 | if subdirs: |
|
343 | if subdirs: | |
344 | matches = [ (d + '/' + p) for p in subdirs] |
|
344 | matches = [ (d + '/' + p) for p in subdirs] | |
345 | return single_dir_expand(matches) |
|
345 | return single_dir_expand(matches) | |
346 | else: |
|
346 | else: | |
347 | return matches |
|
347 | return matches | |
348 | else: |
|
348 | else: | |
349 | return matches |
|
349 | return matches | |
350 |
|
350 | |||
351 | lbuf = self.lbuf |
|
351 | lbuf = self.lbuf | |
352 | open_quotes = 0 # track strings with open quotes |
|
352 | open_quotes = 0 # track strings with open quotes | |
353 | try: |
|
353 | try: | |
354 | lsplit = shlex.split(lbuf)[-1] |
|
354 | lsplit = shlex.split(lbuf)[-1] | |
355 | except ValueError: |
|
355 | except ValueError: | |
356 | # typically an unmatched ", or backslash without escaped char. |
|
356 | # typically an unmatched ", or backslash without escaped char. | |
357 | if lbuf.count('"')==1: |
|
357 | if lbuf.count('"')==1: | |
358 | open_quotes = 1 |
|
358 | open_quotes = 1 | |
359 | lsplit = lbuf.split('"')[-1] |
|
359 | lsplit = lbuf.split('"')[-1] | |
360 | elif lbuf.count("'")==1: |
|
360 | elif lbuf.count("'")==1: | |
361 | open_quotes = 1 |
|
361 | open_quotes = 1 | |
362 | lsplit = lbuf.split("'")[-1] |
|
362 | lsplit = lbuf.split("'")[-1] | |
363 | else: |
|
363 | else: | |
364 | return [] |
|
364 | return [] | |
365 | except IndexError: |
|
365 | except IndexError: | |
366 | # tab pressed on empty line |
|
366 | # tab pressed on empty line | |
367 | lsplit = "" |
|
367 | lsplit = "" | |
368 |
|
368 | |||
369 | if lsplit != protect_filename(lsplit): |
|
369 | if lsplit != protect_filename(lsplit): | |
370 | # if protectables are found, do matching on the whole escaped |
|
370 | # if protectables are found, do matching on the whole escaped | |
371 | # name |
|
371 | # name | |
372 | has_protectables = 1 |
|
372 | has_protectables = 1 | |
373 | text0,text = text,lsplit |
|
373 | text0,text = text,lsplit | |
374 | else: |
|
374 | else: | |
375 | has_protectables = 0 |
|
375 | has_protectables = 0 | |
376 | text = os.path.expanduser(text) |
|
376 | text = os.path.expanduser(text) | |
377 |
|
377 | |||
378 | if text == "": |
|
378 | if text == "": | |
379 | return [text_prefix + protect_filename(f) for f in self.glob("*")] |
|
379 | return [text_prefix + protect_filename(f) for f in self.glob("*")] | |
380 |
|
380 | |||
381 | m0 = self.clean_glob(text.replace('\\','')) |
|
381 | m0 = self.clean_glob(text.replace('\\','')) | |
382 | if has_protectables: |
|
382 | if has_protectables: | |
383 | # If we had protectables, we need to revert our changes to the |
|
383 | # If we had protectables, we need to revert our changes to the | |
384 | # beginning of filename so that we don't double-write the part |
|
384 | # beginning of filename so that we don't double-write the part | |
385 | # of the filename we have so far |
|
385 | # of the filename we have so far | |
386 | len_lsplit = len(lsplit) |
|
386 | len_lsplit = len(lsplit) | |
387 | matches = [text_prefix + text0 + |
|
387 | matches = [text_prefix + text0 + | |
388 | protect_filename(f[len_lsplit:]) for f in m0] |
|
388 | protect_filename(f[len_lsplit:]) for f in m0] | |
389 | else: |
|
389 | else: | |
390 | if open_quotes: |
|
390 | if open_quotes: | |
391 | # if we have a string with an open quote, we don't need to |
|
391 | # if we have a string with an open quote, we don't need to | |
392 | # protect the names at all (and we _shouldn't_, as it |
|
392 | # protect the names at all (and we _shouldn't_, as it | |
393 | # would cause bugs when the filesystem call is made). |
|
393 | # would cause bugs when the filesystem call is made). | |
394 | matches = m0 |
|
394 | matches = m0 | |
395 | else: |
|
395 | else: | |
396 | matches = [text_prefix + |
|
396 | matches = [text_prefix + | |
397 | protect_filename(f) for f in m0] |
|
397 | protect_filename(f) for f in m0] | |
398 |
|
398 | |||
399 | #print 'mm',matches # dbg |
|
399 | #print 'mm',matches # dbg | |
400 | return single_dir_expand(matches) |
|
400 | return single_dir_expand(matches) | |
401 |
|
401 | |||
402 | def alias_matches(self, text): |
|
402 | def alias_matches(self, text): | |
403 | """Match internal system aliases""" |
|
403 | """Match internal system aliases""" | |
404 | #print 'Completer->alias_matches:',text,'lb',self.lbuf # dbg |
|
404 | #print 'Completer->alias_matches:',text,'lb',self.lbuf # dbg | |
405 |
|
405 | |||
406 | # if we are not in the first 'item', alias matching |
|
406 | # if we are not in the first 'item', alias matching | |
407 | # doesn't make sense - unless we are starting with 'sudo' command. |
|
407 | # doesn't make sense - unless we are starting with 'sudo' command. | |
408 | if ' ' in self.lbuf.lstrip() and not self.lbuf.lstrip().startswith('sudo'): |
|
408 | if ' ' in self.lbuf.lstrip() and not self.lbuf.lstrip().startswith('sudo'): | |
409 | return [] |
|
409 | return [] | |
410 | text = os.path.expanduser(text) |
|
410 | text = os.path.expanduser(text) | |
411 | aliases = self.alias_table.keys() |
|
411 | aliases = self.alias_table.keys() | |
412 | if text == "": |
|
412 | if text == "": | |
413 | return aliases |
|
413 | return aliases | |
414 | else: |
|
414 | else: | |
415 | return [alias for alias in aliases if alias.startswith(text)] |
|
415 | return [alias for alias in aliases if alias.startswith(text)] | |
416 |
|
416 | |||
417 | def python_matches(self,text): |
|
417 | def python_matches(self,text): | |
418 | """Match attributes or global python names""" |
|
418 | """Match attributes or global python names""" | |
419 |
|
419 | |||
420 | #print 'Completer->python_matches, txt=<%s>' % text # dbg |
|
420 | #print 'Completer->python_matches, txt=<%s>' % text # dbg | |
421 | if "." in text: |
|
421 | if "." in text: | |
422 | try: |
|
422 | try: | |
423 | matches = self.attr_matches(text) |
|
423 | matches = self.attr_matches(text) | |
424 | if text.endswith('.') and self.omit__names: |
|
424 | if text.endswith('.') and self.omit__names: | |
425 | if self.omit__names == 1: |
|
425 | if self.omit__names == 1: | |
426 | # true if txt is _not_ a __ name, false otherwise: |
|
426 | # true if txt is _not_ a __ name, false otherwise: | |
427 | no__name = (lambda txt: |
|
427 | no__name = (lambda txt: | |
428 | re.match(r'.*\.__.*?__',txt) is None) |
|
428 | re.match(r'.*\.__.*?__',txt) is None) | |
429 | else: |
|
429 | else: | |
430 | # true if txt is _not_ a _ name, false otherwise: |
|
430 | # true if txt is _not_ a _ name, false otherwise: | |
431 | no__name = (lambda txt: |
|
431 | no__name = (lambda txt: | |
432 | re.match(r'.*\._.*?',txt) is None) |
|
432 | re.match(r'.*\._.*?',txt) is None) | |
433 | matches = filter(no__name, matches) |
|
433 | matches = filter(no__name, matches) | |
434 | except NameError: |
|
434 | except NameError: | |
435 | # catches <undefined attributes>.<tab> |
|
435 | # catches <undefined attributes>.<tab> | |
436 | matches = [] |
|
436 | matches = [] | |
437 | else: |
|
437 | else: | |
438 | matches = self.global_matches(text) |
|
438 | matches = self.global_matches(text) | |
439 | # this is so completion finds magics when automagic is on: |
|
439 | # this is so completion finds magics when automagic is on: | |
440 | if (matches == [] and |
|
440 | if (matches == [] and | |
441 | not text.startswith(os.sep) and |
|
441 | not text.startswith(os.sep) and | |
442 | not ' ' in self.lbuf): |
|
442 | not ' ' in self.lbuf): | |
443 | matches = self.attr_matches(self.magic_prefix+text) |
|
443 | matches = self.attr_matches(self.magic_prefix+text) | |
444 | return matches |
|
444 | return matches | |
445 |
|
445 | |||
446 | def _default_arguments(self, obj): |
|
446 | def _default_arguments(self, obj): | |
447 | """Return the list of default arguments of obj if it is callable, |
|
447 | """Return the list of default arguments of obj if it is callable, | |
448 | or empty list otherwise.""" |
|
448 | or empty list otherwise.""" | |
449 |
|
449 | |||
450 | if not (inspect.isfunction(obj) or inspect.ismethod(obj)): |
|
450 | if not (inspect.isfunction(obj) or inspect.ismethod(obj)): | |
451 | # for classes, check for __init__,__new__ |
|
451 | # for classes, check for __init__,__new__ | |
452 | if inspect.isclass(obj): |
|
452 | if inspect.isclass(obj): | |
453 | obj = (getattr(obj,'__init__',None) or |
|
453 | obj = (getattr(obj,'__init__',None) or | |
454 | getattr(obj,'__new__',None)) |
|
454 | getattr(obj,'__new__',None)) | |
455 | # for all others, check if they are __call__able |
|
455 | # for all others, check if they are __call__able | |
456 | elif hasattr(obj, '__call__'): |
|
456 | elif hasattr(obj, '__call__'): | |
457 | obj = obj.__call__ |
|
457 | obj = obj.__call__ | |
458 | # XXX: is there a way to handle the builtins ? |
|
458 | # XXX: is there a way to handle the builtins ? | |
459 | try: |
|
459 | try: | |
460 | args,_,_1,defaults = inspect.getargspec(obj) |
|
460 | args,_,_1,defaults = inspect.getargspec(obj) | |
461 | if defaults: |
|
461 | if defaults: | |
462 | return args[-len(defaults):] |
|
462 | return args[-len(defaults):] | |
463 | except TypeError: pass |
|
463 | except TypeError: pass | |
464 | return [] |
|
464 | return [] | |
465 |
|
465 | |||
466 | def python_func_kw_matches(self,text): |
|
466 | def python_func_kw_matches(self,text): | |
467 | """Match named parameters (kwargs) of the last open function""" |
|
467 | """Match named parameters (kwargs) of the last open function""" | |
468 |
|
468 | |||
469 | if "." in text: # a parameter cannot be dotted |
|
469 | if "." in text: # a parameter cannot be dotted | |
470 | return [] |
|
470 | return [] | |
471 | try: regexp = self.__funcParamsRegex |
|
471 | try: regexp = self.__funcParamsRegex | |
472 | except AttributeError: |
|
472 | except AttributeError: | |
473 | regexp = self.__funcParamsRegex = re.compile(r''' |
|
473 | regexp = self.__funcParamsRegex = re.compile(r''' | |
474 | '.*?' | # single quoted strings or |
|
474 | '.*?' | # single quoted strings or | |
475 | ".*?" | # double quoted strings or |
|
475 | ".*?" | # double quoted strings or | |
476 | \w+ | # identifier |
|
476 | \w+ | # identifier | |
477 | \S # other characters |
|
477 | \S # other characters | |
478 | ''', re.VERBOSE | re.DOTALL) |
|
478 | ''', re.VERBOSE | re.DOTALL) | |
479 | # 1. find the nearest identifier that comes before an unclosed |
|
479 | # 1. find the nearest identifier that comes before an unclosed | |
480 | # parenthesis e.g. for "foo (1+bar(x), pa", the candidate is "foo" |
|
480 | # parenthesis e.g. for "foo (1+bar(x), pa", the candidate is "foo" | |
481 | tokens = regexp.findall(self.get_line_buffer()) |
|
481 | tokens = regexp.findall(self.get_line_buffer()) | |
482 | tokens.reverse() |
|
482 | tokens.reverse() | |
483 | iterTokens = iter(tokens); openPar = 0 |
|
483 | iterTokens = iter(tokens); openPar = 0 | |
484 | for token in iterTokens: |
|
484 | for token in iterTokens: | |
485 | if token == ')': |
|
485 | if token == ')': | |
486 | openPar -= 1 |
|
486 | openPar -= 1 | |
487 | elif token == '(': |
|
487 | elif token == '(': | |
488 | openPar += 1 |
|
488 | openPar += 1 | |
489 | if openPar > 0: |
|
489 | if openPar > 0: | |
490 | # found the last unclosed parenthesis |
|
490 | # found the last unclosed parenthesis | |
491 | break |
|
491 | break | |
492 | else: |
|
492 | else: | |
493 | return [] |
|
493 | return [] | |
494 | # 2. Concatenate dotted names ("foo.bar" for "foo.bar(x, pa" ) |
|
494 | # 2. Concatenate dotted names ("foo.bar" for "foo.bar(x, pa" ) | |
495 | ids = [] |
|
495 | ids = [] | |
496 | isId = re.compile(r'\w+$').match |
|
496 | isId = re.compile(r'\w+$').match | |
497 | while True: |
|
497 | while True: | |
498 | try: |
|
498 | try: | |
499 | ids.append(iterTokens.next()) |
|
499 | ids.append(iterTokens.next()) | |
500 | if not isId(ids[-1]): |
|
500 | if not isId(ids[-1]): | |
501 | ids.pop(); break |
|
501 | ids.pop(); break | |
502 | if not iterTokens.next() == '.': |
|
502 | if not iterTokens.next() == '.': | |
503 | break |
|
503 | break | |
504 | except StopIteration: |
|
504 | except StopIteration: | |
505 | break |
|
505 | break | |
506 | # lookup the candidate callable matches either using global_matches |
|
506 | # lookup the candidate callable matches either using global_matches | |
507 | # or attr_matches for dotted names |
|
507 | # or attr_matches for dotted names | |
508 | if len(ids) == 1: |
|
508 | if len(ids) == 1: | |
509 | callableMatches = self.global_matches(ids[0]) |
|
509 | callableMatches = self.global_matches(ids[0]) | |
510 | else: |
|
510 | else: | |
511 | callableMatches = self.attr_matches('.'.join(ids[::-1])) |
|
511 | callableMatches = self.attr_matches('.'.join(ids[::-1])) | |
512 | argMatches = [] |
|
512 | argMatches = [] | |
513 | for callableMatch in callableMatches: |
|
513 | for callableMatch in callableMatches: | |
514 | try: namedArgs = self._default_arguments(eval(callableMatch, |
|
514 | try: namedArgs = self._default_arguments(eval(callableMatch, | |
515 | self.namespace)) |
|
515 | self.namespace)) | |
516 | except: continue |
|
516 | except: continue | |
517 | for namedArg in namedArgs: |
|
517 | for namedArg in namedArgs: | |
518 | if namedArg.startswith(text): |
|
518 | if namedArg.startswith(text): | |
519 | argMatches.append("%s=" %namedArg) |
|
519 | argMatches.append("%s=" %namedArg) | |
520 | return argMatches |
|
520 | return argMatches | |
521 |
|
521 | |||
522 | def dispatch_custom_completer(self,text): |
|
522 | def dispatch_custom_completer(self,text): | |
523 | #print "Custom! '%s' %s" % (text, self.custom_completers) # dbg |
|
523 | #print "Custom! '%s' %s" % (text, self.custom_completers) # dbg | |
524 | line = self.full_lbuf |
|
524 | line = self.full_lbuf | |
525 | if not line.strip(): |
|
525 | if not line.strip(): | |
526 | return None |
|
526 | return None | |
527 |
|
527 | |||
528 | event = Struct() |
|
528 | event = Struct() | |
529 | event.line = line |
|
529 | event.line = line | |
530 | event.symbol = text |
|
530 | event.symbol = text | |
531 | cmd = line.split(None,1)[0] |
|
531 | cmd = line.split(None,1)[0] | |
532 | event.command = cmd |
|
532 | event.command = cmd | |
533 | #print "\ncustom:{%s]\n" % event # dbg |
|
533 | #print "\ncustom:{%s]\n" % event # dbg | |
534 |
|
534 | |||
535 | # for foo etc, try also to find completer for %foo |
|
535 | # for foo etc, try also to find completer for %foo | |
536 | if not cmd.startswith(self.magic_escape): |
|
536 | if not cmd.startswith(self.magic_escape): | |
537 | try_magic = self.custom_completers.s_matches( |
|
537 | try_magic = self.custom_completers.s_matches( | |
538 | self.magic_escape + cmd) |
|
538 | self.magic_escape + cmd) | |
539 | else: |
|
539 | else: | |
540 | try_magic = [] |
|
540 | try_magic = [] | |
541 |
|
541 | |||
542 |
|
542 | |||
543 | for c in itertools.chain( |
|
543 | for c in itertools.chain( | |
544 | self.custom_completers.s_matches(cmd), |
|
544 | self.custom_completers.s_matches(cmd), | |
545 | try_magic, |
|
545 | try_magic, | |
546 | self.custom_completers.flat_matches(self.lbuf)): |
|
546 | self.custom_completers.flat_matches(self.lbuf)): | |
547 | #print "try",c # dbg |
|
547 | #print "try",c # dbg | |
548 | try: |
|
548 | try: | |
549 | res = c(event) |
|
549 | res = c(event) | |
550 | # first, try case sensitive match |
|
550 | # first, try case sensitive match | |
551 | withcase = [r for r in res if r.startswith(text)] |
|
551 | withcase = [r for r in res if r.startswith(text)] | |
552 | if withcase: |
|
552 | if withcase: | |
553 | return withcase |
|
553 | return withcase | |
554 | # if none, then case insensitive ones are ok too |
|
554 | # if none, then case insensitive ones are ok too | |
555 | return [r for r in res if r.lower().startswith(text.lower())] |
|
555 | return [r for r in res if r.lower().startswith(text.lower())] | |
556 | except ipapi.TryNext: |
|
556 | except ipapi.TryNext: | |
557 | pass |
|
557 | pass | |
558 |
|
558 | |||
559 | return None |
|
559 | return None | |
560 |
|
560 | |||
561 | def complete(self, text, state,line_buffer=None): |
|
561 | def complete(self, text, state,line_buffer=None): | |
562 | """Return the next possible completion for 'text'. |
|
562 | """Return the next possible completion for 'text'. | |
563 |
|
563 | |||
564 | This is called successively with state == 0, 1, 2, ... until it |
|
564 | This is called successively with state == 0, 1, 2, ... until it | |
565 | returns None. The completion should begin with 'text'. |
|
565 | returns None. The completion should begin with 'text'. | |
566 |
|
566 | |||
567 | :Keywords: |
|
567 | :Keywords: | |
568 | - line_buffer: string |
|
568 | - line_buffer: string | |
569 | If not given, the completer attempts to obtain the current line buffer |
|
569 | If not given, the completer attempts to obtain the current line buffer | |
570 | via readline. This keyword allows clients which are requesting for |
|
570 | via readline. This keyword allows clients which are requesting for | |
571 | text completions in non-readline contexts to inform the completer of |
|
571 | text completions in non-readline contexts to inform the completer of | |
572 | the entire text. |
|
572 | the entire text. | |
573 | """ |
|
573 | """ | |
574 |
|
574 | |||
575 | #print '\n*** COMPLETE: <%s> (%s)' % (text,state) # dbg |
|
575 | #print '\n*** COMPLETE: <%s> (%s)' % (text,state) # dbg | |
576 |
|
576 | |||
577 | # if there is only a tab on a line with only whitespace, instead |
|
577 | # if there is only a tab on a line with only whitespace, instead | |
578 | # of the mostly useless 'do you want to see all million |
|
578 | # of the mostly useless 'do you want to see all million | |
579 | # completions' message, just do the right thing and give the user |
|
579 | # completions' message, just do the right thing and give the user | |
580 | # his tab! Incidentally, this enables pasting of tabbed text from |
|
580 | # his tab! Incidentally, this enables pasting of tabbed text from | |
581 | # an editor (as long as autoindent is off). |
|
581 | # an editor (as long as autoindent is off). | |
582 |
|
582 | |||
583 | # It should be noted that at least pyreadline still shows |
|
583 | # It should be noted that at least pyreadline still shows | |
584 | # file completions - is there a way around it? |
|
584 | # file completions - is there a way around it? | |
585 |
|
585 | |||
586 | # don't apply this on 'dumb' terminals, such as emacs buffers, so we |
|
586 | # don't apply this on 'dumb' terminals, such as emacs buffers, so we | |
587 | # don't interfere with their own tab-completion mechanism. |
|
587 | # don't interfere with their own tab-completion mechanism. | |
588 | if line_buffer is None: |
|
588 | if line_buffer is None: | |
589 | self.full_lbuf = self.get_line_buffer() |
|
589 | self.full_lbuf = self.get_line_buffer() | |
590 | else: |
|
590 | else: | |
591 | self.full_lbuf = line_buffer |
|
591 | self.full_lbuf = line_buffer | |
592 |
|
592 | |||
593 | if not (self.dumb_terminal or self.full_lbuf.strip()): |
|
593 | if not (self.dumb_terminal or self.full_lbuf.strip()): | |
594 | self.readline.insert_text('\t') |
|
594 | self.readline.insert_text('\t') | |
595 | return None |
|
595 | return None | |
596 |
|
596 | |||
597 | magic_escape = self.magic_escape |
|
597 | magic_escape = self.magic_escape | |
598 | magic_prefix = self.magic_prefix |
|
598 | magic_prefix = self.magic_prefix | |
599 |
|
599 | |||
600 | self.lbuf = self.full_lbuf[:self.get_endidx()] |
|
600 | self.lbuf = self.full_lbuf[:self.get_endidx()] | |
601 |
|
601 | |||
602 | try: |
|
602 | try: | |
603 | if text.startswith(magic_escape): |
|
603 | if text.startswith(magic_escape): | |
604 | text = text.replace(magic_escape,magic_prefix) |
|
604 | text = text.replace(magic_escape,magic_prefix) | |
605 | elif text.startswith('~'): |
|
605 | elif text.startswith('~'): | |
606 | text = os.path.expanduser(text) |
|
606 | text = os.path.expanduser(text) | |
607 | if state == 0: |
|
607 | if state == 0: | |
608 | custom_res = self.dispatch_custom_completer(text) |
|
608 | custom_res = self.dispatch_custom_completer(text) | |
609 | if custom_res is not None: |
|
609 | if custom_res is not None: | |
610 | # did custom completers produce something? |
|
610 | # did custom completers produce something? | |
611 | self.matches = custom_res |
|
611 | self.matches = custom_res | |
612 | else: |
|
612 | else: | |
613 | # Extend the list of completions with the results of each |
|
613 | # Extend the list of completions with the results of each | |
614 | # matcher, so we return results to the user from all |
|
614 | # matcher, so we return results to the user from all | |
615 | # namespaces. |
|
615 | # namespaces. | |
616 | if self.merge_completions: |
|
616 | if self.merge_completions: | |
617 | self.matches = [] |
|
617 | self.matches = [] | |
618 | for matcher in self.matchers: |
|
618 | for matcher in self.matchers: | |
619 | self.matches.extend(matcher(text)) |
|
619 | self.matches.extend(matcher(text)) | |
620 | else: |
|
620 | else: | |
621 | for matcher in self.matchers: |
|
621 | for matcher in self.matchers: | |
622 | self.matches = matcher(text) |
|
622 | self.matches = matcher(text) | |
623 | if self.matches: |
|
623 | if self.matches: | |
624 | break |
|
624 | break | |
625 | def uniq(alist): |
|
625 | def uniq(alist): | |
626 | set = {} |
|
626 | set = {} | |
627 | return [set.setdefault(e,e) for e in alist if e not in set] |
|
627 | return [set.setdefault(e,e) for e in alist if e not in set] | |
628 | self.matches = uniq(self.matches) |
|
628 | self.matches = uniq(self.matches) | |
629 | try: |
|
629 | try: | |
630 | ret = self.matches[state].replace(magic_prefix,magic_escape) |
|
630 | ret = self.matches[state].replace(magic_prefix,magic_escape) | |
631 | return ret |
|
631 | return ret | |
632 | except IndexError: |
|
632 | except IndexError: | |
633 | return None |
|
633 | return None | |
634 | except: |
|
634 | except: | |
635 | #from IPython.ultraTB import AutoFormattedTB; # dbg |
|
635 | #from IPython.ultraTB import AutoFormattedTB; # dbg | |
636 | #tb=AutoFormattedTB('Verbose');tb() #dbg |
|
636 | #tb=AutoFormattedTB('Verbose');tb() #dbg | |
637 |
|
637 | |||
638 | # If completion fails, don't annoy the user. |
|
638 | # If completion fails, don't annoy the user. | |
639 | return None |
|
639 | return None |
@@ -1,2864 +1,2864 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """ |
|
2 | """ | |
3 | IPython -- An enhanced Interactive Python |
|
3 | IPython -- An enhanced Interactive Python | |
4 |
|
4 | |||
5 | Requires Python 2.4 or newer. |
|
5 | Requires Python 2.4 or newer. | |
6 |
|
6 | |||
7 | This file contains all the classes and helper functions specific to IPython. |
|
7 | This file contains all the classes and helper functions specific to IPython. | |
8 | """ |
|
8 | """ | |
9 |
|
9 | |||
10 | #***************************************************************************** |
|
10 | #***************************************************************************** | |
11 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and |
|
11 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and | |
12 | # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu> |
|
12 | # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu> | |
13 | # |
|
13 | # | |
14 | # Distributed under the terms of the BSD License. The full license is in |
|
14 | # Distributed under the terms of the BSD License. The full license is in | |
15 | # the file COPYING, distributed as part of this software. |
|
15 | # the file COPYING, distributed as part of this software. | |
16 | # |
|
16 | # | |
17 | # Note: this code originally subclassed code.InteractiveConsole from the |
|
17 | # Note: this code originally subclassed code.InteractiveConsole from the | |
18 | # Python standard library. Over time, all of that class has been copied |
|
18 | # Python standard library. Over time, all of that class has been copied | |
19 | # verbatim here for modifications which could not be accomplished by |
|
19 | # verbatim here for modifications which could not be accomplished by | |
20 | # subclassing. At this point, there are no dependencies at all on the code |
|
20 | # subclassing. At this point, there are no dependencies at all on the code | |
21 | # module anymore (it is not even imported). The Python License (sec. 2) |
|
21 | # module anymore (it is not even imported). The Python License (sec. 2) | |
22 | # allows for this, but it's always nice to acknowledge credit where credit is |
|
22 | # allows for this, but it's always nice to acknowledge credit where credit is | |
23 | # due. |
|
23 | # due. | |
24 | #***************************************************************************** |
|
24 | #***************************************************************************** | |
25 |
|
25 | |||
26 | #**************************************************************************** |
|
26 | #**************************************************************************** | |
27 | # Modules and globals |
|
27 | # Modules and globals | |
28 |
|
28 | |||
29 | # Python standard modules |
|
29 | # Python standard modules | |
30 | import __main__ |
|
30 | import __main__ | |
31 | import __builtin__ |
|
31 | import __builtin__ | |
32 | import StringIO |
|
32 | import StringIO | |
33 | import bdb |
|
33 | import bdb | |
34 | import codeop |
|
34 | import codeop | |
35 | import exceptions |
|
35 | import exceptions | |
36 | import glob |
|
36 | import glob | |
37 | import keyword |
|
37 | import keyword | |
38 | import new |
|
38 | import new | |
39 | import os |
|
39 | import os | |
40 | import re |
|
40 | import re | |
41 | import shutil |
|
41 | import shutil | |
42 | import string |
|
42 | import string | |
43 | import sys |
|
43 | import sys | |
44 | import tempfile |
|
44 | import tempfile | |
45 |
|
45 | |||
46 | # IPython's own modules |
|
46 | # IPython's own modules | |
47 | #import IPython |
|
47 | #import IPython | |
48 | from IPython import OInspect,PyColorize,ultraTB |
|
48 | from IPython import OInspect,PyColorize,ultraTB | |
49 | from IPython.core import debugger |
|
49 | from IPython.core import debugger | |
50 | from IPython.Extensions import pickleshare |
|
50 | from IPython.Extensions import pickleshare | |
51 | from IPython.core.fakemodule import FakeModule, init_fakemod_dict |
|
51 | from IPython.core.fakemodule import FakeModule, init_fakemod_dict | |
52 | from IPython.Itpl import ItplNS |
|
52 | from IPython.Itpl import ItplNS | |
53 | from IPython.Logger import Logger |
|
53 | from IPython.Logger import Logger | |
54 | from IPython.Magic import Magic |
|
54 | from IPython.Magic import Magic | |
55 | from IPython.Prompts import CachedOutput |
|
55 | from IPython.Prompts import CachedOutput | |
56 | from IPython.ipstruct import Struct |
|
56 | from IPython.utils.ipstruct import Struct | |
57 | from IPython.lib.backgroundjobs import BackgroundJobManager |
|
57 | from IPython.lib.backgroundjobs import BackgroundJobManager | |
58 | from IPython.utils.genutils import * |
|
58 | from IPython.utils.genutils import * | |
59 | from IPython.strdispatch import StrDispatch |
|
59 | from IPython.strdispatch import StrDispatch | |
60 | from IPython.core import ipapi |
|
60 | from IPython.core import ipapi | |
61 | import IPython.core.history |
|
61 | import IPython.core.history | |
62 | import IPython.prefilter as prefilter |
|
62 | import IPython.prefilter as prefilter | |
63 | import IPython.shadowns |
|
63 | import IPython.shadowns | |
64 | # Globals |
|
64 | # Globals | |
65 |
|
65 | |||
66 | # store the builtin raw_input globally, and use this always, in case user code |
|
66 | # store the builtin raw_input globally, and use this always, in case user code | |
67 | # overwrites it (like wx.py.PyShell does) |
|
67 | # overwrites it (like wx.py.PyShell does) | |
68 | raw_input_original = raw_input |
|
68 | raw_input_original = raw_input | |
69 |
|
69 | |||
70 | # compiled regexps for autoindent management |
|
70 | # compiled regexps for autoindent management | |
71 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') |
|
71 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') | |
72 |
|
72 | |||
73 |
|
73 | |||
74 | #**************************************************************************** |
|
74 | #**************************************************************************** | |
75 | # Some utility function definitions |
|
75 | # Some utility function definitions | |
76 |
|
76 | |||
77 | ini_spaces_re = re.compile(r'^(\s+)') |
|
77 | ini_spaces_re = re.compile(r'^(\s+)') | |
78 |
|
78 | |||
79 | def num_ini_spaces(strng): |
|
79 | def num_ini_spaces(strng): | |
80 | """Return the number of initial spaces in a string""" |
|
80 | """Return the number of initial spaces in a string""" | |
81 |
|
81 | |||
82 | ini_spaces = ini_spaces_re.match(strng) |
|
82 | ini_spaces = ini_spaces_re.match(strng) | |
83 | if ini_spaces: |
|
83 | if ini_spaces: | |
84 | return ini_spaces.end() |
|
84 | return ini_spaces.end() | |
85 | else: |
|
85 | else: | |
86 | return 0 |
|
86 | return 0 | |
87 |
|
87 | |||
88 | def softspace(file, newvalue): |
|
88 | def softspace(file, newvalue): | |
89 | """Copied from code.py, to remove the dependency""" |
|
89 | """Copied from code.py, to remove the dependency""" | |
90 |
|
90 | |||
91 | oldvalue = 0 |
|
91 | oldvalue = 0 | |
92 | try: |
|
92 | try: | |
93 | oldvalue = file.softspace |
|
93 | oldvalue = file.softspace | |
94 | except AttributeError: |
|
94 | except AttributeError: | |
95 | pass |
|
95 | pass | |
96 | try: |
|
96 | try: | |
97 | file.softspace = newvalue |
|
97 | file.softspace = newvalue | |
98 | except (AttributeError, TypeError): |
|
98 | except (AttributeError, TypeError): | |
99 | # "attribute-less object" or "read-only attributes" |
|
99 | # "attribute-less object" or "read-only attributes" | |
100 | pass |
|
100 | pass | |
101 | return oldvalue |
|
101 | return oldvalue | |
102 |
|
102 | |||
103 |
|
103 | |||
104 | def user_setup(ipythondir,rc_suffix,mode='install',interactive=True): |
|
104 | def user_setup(ipythondir,rc_suffix,mode='install',interactive=True): | |
105 | """Install or upgrade the user configuration directory. |
|
105 | """Install or upgrade the user configuration directory. | |
106 |
|
106 | |||
107 | Can be called when running for the first time or to upgrade the user's |
|
107 | Can be called when running for the first time or to upgrade the user's | |
108 | .ipython/ directory. |
|
108 | .ipython/ directory. | |
109 |
|
109 | |||
110 | Parameters |
|
110 | Parameters | |
111 | ---------- |
|
111 | ---------- | |
112 | ipythondir : path |
|
112 | ipythondir : path | |
113 | The directory to be used for installation/upgrade. In 'install' mode, |
|
113 | The directory to be used for installation/upgrade. In 'install' mode, | |
114 | if this path already exists, the function exits immediately. |
|
114 | if this path already exists, the function exits immediately. | |
115 |
|
115 | |||
116 | rc_suffix : str |
|
116 | rc_suffix : str | |
117 | Extension for the config files. On *nix platforms it is typically the |
|
117 | Extension for the config files. On *nix platforms it is typically the | |
118 | empty string, while Windows normally uses '.ini'. |
|
118 | empty string, while Windows normally uses '.ini'. | |
119 |
|
119 | |||
120 | mode : str, optional |
|
120 | mode : str, optional | |
121 | Valid modes are 'install' and 'upgrade'. |
|
121 | Valid modes are 'install' and 'upgrade'. | |
122 |
|
122 | |||
123 | interactive : bool, optional |
|
123 | interactive : bool, optional | |
124 | If False, do not wait for user input on any errors. Normally after |
|
124 | If False, do not wait for user input on any errors. Normally after | |
125 | printing its status information, this function waits for the user to |
|
125 | printing its status information, this function waits for the user to | |
126 | hit Return before proceeding. This is because the default use case is |
|
126 | hit Return before proceeding. This is because the default use case is | |
127 | when first installing the IPython configuration, so we want the user to |
|
127 | when first installing the IPython configuration, so we want the user to | |
128 | acknowledge the initial message, which contains some useful |
|
128 | acknowledge the initial message, which contains some useful | |
129 | information. |
|
129 | information. | |
130 | """ |
|
130 | """ | |
131 |
|
131 | |||
132 | # For automatic use, deactivate all i/o |
|
132 | # For automatic use, deactivate all i/o | |
133 | if interactive: |
|
133 | if interactive: | |
134 | def wait(): |
|
134 | def wait(): | |
135 | try: |
|
135 | try: | |
136 | raw_input("Please press <RETURN> to start IPython.") |
|
136 | raw_input("Please press <RETURN> to start IPython.") | |
137 | except EOFError: |
|
137 | except EOFError: | |
138 | print >> Term.cout |
|
138 | print >> Term.cout | |
139 | print '*'*70 |
|
139 | print '*'*70 | |
140 |
|
140 | |||
141 | def printf(s): |
|
141 | def printf(s): | |
142 | print s |
|
142 | print s | |
143 | else: |
|
143 | else: | |
144 | wait = lambda : None |
|
144 | wait = lambda : None | |
145 | printf = lambda s : None |
|
145 | printf = lambda s : None | |
146 |
|
146 | |||
147 | # Install mode should be re-entrant: if the install dir already exists, |
|
147 | # Install mode should be re-entrant: if the install dir already exists, | |
148 | # bail out cleanly. |
|
148 | # bail out cleanly. | |
149 | # XXX. This is too hasty to return. We need to check to make sure that |
|
149 | # XXX. This is too hasty to return. We need to check to make sure that | |
150 | # all the expected config files and directories are actually there. We |
|
150 | # all the expected config files and directories are actually there. We | |
151 | # currently have a failure mode if someone deletes a needed config file |
|
151 | # currently have a failure mode if someone deletes a needed config file | |
152 | # but still has the ipythondir. |
|
152 | # but still has the ipythondir. | |
153 | if mode == 'install' and os.path.isdir(ipythondir): |
|
153 | if mode == 'install' and os.path.isdir(ipythondir): | |
154 | return |
|
154 | return | |
155 |
|
155 | |||
156 | cwd = os.getcwd() # remember where we started |
|
156 | cwd = os.getcwd() # remember where we started | |
157 | glb = glob.glob |
|
157 | glb = glob.glob | |
158 |
|
158 | |||
159 | printf('*'*70) |
|
159 | printf('*'*70) | |
160 | if mode == 'install': |
|
160 | if mode == 'install': | |
161 | printf( |
|
161 | printf( | |
162 | """Welcome to IPython. I will try to create a personal configuration directory |
|
162 | """Welcome to IPython. I will try to create a personal configuration directory | |
163 | where you can customize many aspects of IPython's functionality in:\n""") |
|
163 | where you can customize many aspects of IPython's functionality in:\n""") | |
164 | else: |
|
164 | else: | |
165 | printf('I am going to upgrade your configuration in:') |
|
165 | printf('I am going to upgrade your configuration in:') | |
166 |
|
166 | |||
167 | printf(ipythondir) |
|
167 | printf(ipythondir) | |
168 |
|
168 | |||
169 | rcdirend = os.path.join('IPython','UserConfig') |
|
169 | rcdirend = os.path.join('IPython','UserConfig') | |
170 | cfg = lambda d: os.path.join(d,rcdirend) |
|
170 | cfg = lambda d: os.path.join(d,rcdirend) | |
171 | try: |
|
171 | try: | |
172 | rcdir = filter(os.path.isdir,map(cfg,sys.path))[0] |
|
172 | rcdir = filter(os.path.isdir,map(cfg,sys.path))[0] | |
173 | printf("Initializing from configuration: %s" % rcdir) |
|
173 | printf("Initializing from configuration: %s" % rcdir) | |
174 | except IndexError: |
|
174 | except IndexError: | |
175 | warning = """ |
|
175 | warning = """ | |
176 | Installation error. IPython's directory was not found. |
|
176 | Installation error. IPython's directory was not found. | |
177 |
|
177 | |||
178 | Check the following: |
|
178 | Check the following: | |
179 |
|
179 | |||
180 | The ipython/IPython directory should be in a directory belonging to your |
|
180 | The ipython/IPython directory should be in a directory belonging to your | |
181 | PYTHONPATH environment variable (that is, it should be in a directory |
|
181 | PYTHONPATH environment variable (that is, it should be in a directory | |
182 | belonging to sys.path). You can copy it explicitly there or just link to it. |
|
182 | belonging to sys.path). You can copy it explicitly there or just link to it. | |
183 |
|
183 | |||
184 | IPython will create a minimal default configuration for you. |
|
184 | IPython will create a minimal default configuration for you. | |
185 |
|
185 | |||
186 | """ |
|
186 | """ | |
187 | warn(warning) |
|
187 | warn(warning) | |
188 | wait() |
|
188 | wait() | |
189 |
|
189 | |||
190 | if sys.platform =='win32': |
|
190 | if sys.platform =='win32': | |
191 | inif = 'ipythonrc.ini' |
|
191 | inif = 'ipythonrc.ini' | |
192 | else: |
|
192 | else: | |
193 | inif = 'ipythonrc' |
|
193 | inif = 'ipythonrc' | |
194 | minimal_setup = {'ipy_user_conf.py' : 'import ipy_defaults', |
|
194 | minimal_setup = {'ipy_user_conf.py' : 'import ipy_defaults', | |
195 | inif : '# intentionally left blank' } |
|
195 | inif : '# intentionally left blank' } | |
196 | os.makedirs(ipythondir, mode = 0777) |
|
196 | os.makedirs(ipythondir, mode = 0777) | |
197 | for f, cont in minimal_setup.items(): |
|
197 | for f, cont in minimal_setup.items(): | |
198 | # In 2.5, this can be more cleanly done using 'with' |
|
198 | # In 2.5, this can be more cleanly done using 'with' | |
199 | fobj = file(ipythondir + '/' + f,'w') |
|
199 | fobj = file(ipythondir + '/' + f,'w') | |
200 | fobj.write(cont) |
|
200 | fobj.write(cont) | |
201 | fobj.close() |
|
201 | fobj.close() | |
202 |
|
202 | |||
203 | return |
|
203 | return | |
204 |
|
204 | |||
205 | if mode == 'install': |
|
205 | if mode == 'install': | |
206 | try: |
|
206 | try: | |
207 | shutil.copytree(rcdir,ipythondir) |
|
207 | shutil.copytree(rcdir,ipythondir) | |
208 | os.chdir(ipythondir) |
|
208 | os.chdir(ipythondir) | |
209 | rc_files = glb("ipythonrc*") |
|
209 | rc_files = glb("ipythonrc*") | |
210 | for rc_file in rc_files: |
|
210 | for rc_file in rc_files: | |
211 | os.rename(rc_file,rc_file+rc_suffix) |
|
211 | os.rename(rc_file,rc_file+rc_suffix) | |
212 | except: |
|
212 | except: | |
213 | warning = """ |
|
213 | warning = """ | |
214 |
|
214 | |||
215 | There was a problem with the installation: |
|
215 | There was a problem with the installation: | |
216 | %s |
|
216 | %s | |
217 | Try to correct it or contact the developers if you think it's a bug. |
|
217 | Try to correct it or contact the developers if you think it's a bug. | |
218 | IPython will proceed with builtin defaults.""" % sys.exc_info()[1] |
|
218 | IPython will proceed with builtin defaults.""" % sys.exc_info()[1] | |
219 | warn(warning) |
|
219 | warn(warning) | |
220 | wait() |
|
220 | wait() | |
221 | return |
|
221 | return | |
222 |
|
222 | |||
223 | elif mode == 'upgrade': |
|
223 | elif mode == 'upgrade': | |
224 | try: |
|
224 | try: | |
225 | os.chdir(ipythondir) |
|
225 | os.chdir(ipythondir) | |
226 | except: |
|
226 | except: | |
227 | printf(""" |
|
227 | printf(""" | |
228 | Can not upgrade: changing to directory %s failed. Details: |
|
228 | Can not upgrade: changing to directory %s failed. Details: | |
229 | %s |
|
229 | %s | |
230 | """ % (ipythondir,sys.exc_info()[1]) ) |
|
230 | """ % (ipythondir,sys.exc_info()[1]) ) | |
231 | wait() |
|
231 | wait() | |
232 | return |
|
232 | return | |
233 | else: |
|
233 | else: | |
234 | sources = glb(os.path.join(rcdir,'[A-Za-z]*')) |
|
234 | sources = glb(os.path.join(rcdir,'[A-Za-z]*')) | |
235 | for new_full_path in sources: |
|
235 | for new_full_path in sources: | |
236 | new_filename = os.path.basename(new_full_path) |
|
236 | new_filename = os.path.basename(new_full_path) | |
237 | if new_filename.startswith('ipythonrc'): |
|
237 | if new_filename.startswith('ipythonrc'): | |
238 | new_filename = new_filename + rc_suffix |
|
238 | new_filename = new_filename + rc_suffix | |
239 | # The config directory should only contain files, skip any |
|
239 | # The config directory should only contain files, skip any | |
240 | # directories which may be there (like CVS) |
|
240 | # directories which may be there (like CVS) | |
241 | if os.path.isdir(new_full_path): |
|
241 | if os.path.isdir(new_full_path): | |
242 | continue |
|
242 | continue | |
243 | if os.path.exists(new_filename): |
|
243 | if os.path.exists(new_filename): | |
244 | old_file = new_filename+'.old' |
|
244 | old_file = new_filename+'.old' | |
245 | if os.path.exists(old_file): |
|
245 | if os.path.exists(old_file): | |
246 | os.remove(old_file) |
|
246 | os.remove(old_file) | |
247 | os.rename(new_filename,old_file) |
|
247 | os.rename(new_filename,old_file) | |
248 | shutil.copy(new_full_path,new_filename) |
|
248 | shutil.copy(new_full_path,new_filename) | |
249 | else: |
|
249 | else: | |
250 | raise ValueError('unrecognized mode for install: %r' % mode) |
|
250 | raise ValueError('unrecognized mode for install: %r' % mode) | |
251 |
|
251 | |||
252 | # Fix line-endings to those native to each platform in the config |
|
252 | # Fix line-endings to those native to each platform in the config | |
253 | # directory. |
|
253 | # directory. | |
254 | try: |
|
254 | try: | |
255 | os.chdir(ipythondir) |
|
255 | os.chdir(ipythondir) | |
256 | except: |
|
256 | except: | |
257 | printf(""" |
|
257 | printf(""" | |
258 | Problem: changing to directory %s failed. |
|
258 | Problem: changing to directory %s failed. | |
259 | Details: |
|
259 | Details: | |
260 | %s |
|
260 | %s | |
261 |
|
261 | |||
262 | Some configuration files may have incorrect line endings. This should not |
|
262 | Some configuration files may have incorrect line endings. This should not | |
263 | cause any problems during execution. """ % (ipythondir,sys.exc_info()[1]) ) |
|
263 | cause any problems during execution. """ % (ipythondir,sys.exc_info()[1]) ) | |
264 | wait() |
|
264 | wait() | |
265 | else: |
|
265 | else: | |
266 | for fname in glb('ipythonrc*'): |
|
266 | for fname in glb('ipythonrc*'): | |
267 | try: |
|
267 | try: | |
268 | native_line_ends(fname,backup=0) |
|
268 | native_line_ends(fname,backup=0) | |
269 | except IOError: |
|
269 | except IOError: | |
270 | pass |
|
270 | pass | |
271 |
|
271 | |||
272 | if mode == 'install': |
|
272 | if mode == 'install': | |
273 | printf(""" |
|
273 | printf(""" | |
274 | Successful installation! |
|
274 | Successful installation! | |
275 |
|
275 | |||
276 | Please read the sections 'Initial Configuration' and 'Quick Tips' in the |
|
276 | Please read the sections 'Initial Configuration' and 'Quick Tips' in the | |
277 | IPython manual (there are both HTML and PDF versions supplied with the |
|
277 | IPython manual (there are both HTML and PDF versions supplied with the | |
278 | distribution) to make sure that your system environment is properly configured |
|
278 | distribution) to make sure that your system environment is properly configured | |
279 | to take advantage of IPython's features. |
|
279 | to take advantage of IPython's features. | |
280 |
|
280 | |||
281 | Important note: the configuration system has changed! The old system is |
|
281 | Important note: the configuration system has changed! The old system is | |
282 | still in place, but its setting may be partly overridden by the settings in |
|
282 | still in place, but its setting may be partly overridden by the settings in | |
283 | "~/.ipython/ipy_user_conf.py" config file. Please take a look at the file |
|
283 | "~/.ipython/ipy_user_conf.py" config file. Please take a look at the file | |
284 | if some of the new settings bother you. |
|
284 | if some of the new settings bother you. | |
285 |
|
285 | |||
286 | """) |
|
286 | """) | |
287 | else: |
|
287 | else: | |
288 | printf(""" |
|
288 | printf(""" | |
289 | Successful upgrade! |
|
289 | Successful upgrade! | |
290 |
|
290 | |||
291 | All files in your directory: |
|
291 | All files in your directory: | |
292 | %(ipythondir)s |
|
292 | %(ipythondir)s | |
293 | which would have been overwritten by the upgrade were backed up with a .old |
|
293 | which would have been overwritten by the upgrade were backed up with a .old | |
294 | extension. If you had made particular customizations in those files you may |
|
294 | extension. If you had made particular customizations in those files you may | |
295 | want to merge them back into the new files.""" % locals() ) |
|
295 | want to merge them back into the new files.""" % locals() ) | |
296 | wait() |
|
296 | wait() | |
297 | os.chdir(cwd) |
|
297 | os.chdir(cwd) | |
298 |
|
298 | |||
299 | #**************************************************************************** |
|
299 | #**************************************************************************** | |
300 | # Local use exceptions |
|
300 | # Local use exceptions | |
301 | class SpaceInInput(exceptions.Exception): pass |
|
301 | class SpaceInInput(exceptions.Exception): pass | |
302 |
|
302 | |||
303 |
|
303 | |||
304 | #**************************************************************************** |
|
304 | #**************************************************************************** | |
305 | # Local use classes |
|
305 | # Local use classes | |
306 | class Bunch: pass |
|
306 | class Bunch: pass | |
307 |
|
307 | |||
308 | class Undefined: pass |
|
308 | class Undefined: pass | |
309 |
|
309 | |||
310 | class Quitter(object): |
|
310 | class Quitter(object): | |
311 | """Simple class to handle exit, similar to Python 2.5's. |
|
311 | """Simple class to handle exit, similar to Python 2.5's. | |
312 |
|
312 | |||
313 | It handles exiting in an ipython-safe manner, which the one in Python 2.5 |
|
313 | It handles exiting in an ipython-safe manner, which the one in Python 2.5 | |
314 | doesn't do (obviously, since it doesn't know about ipython).""" |
|
314 | doesn't do (obviously, since it doesn't know about ipython).""" | |
315 |
|
315 | |||
316 | def __init__(self,shell,name): |
|
316 | def __init__(self,shell,name): | |
317 | self.shell = shell |
|
317 | self.shell = shell | |
318 | self.name = name |
|
318 | self.name = name | |
319 |
|
319 | |||
320 | def __repr__(self): |
|
320 | def __repr__(self): | |
321 | return 'Type %s() to exit.' % self.name |
|
321 | return 'Type %s() to exit.' % self.name | |
322 | __str__ = __repr__ |
|
322 | __str__ = __repr__ | |
323 |
|
323 | |||
324 | def __call__(self): |
|
324 | def __call__(self): | |
325 | self.shell.exit() |
|
325 | self.shell.exit() | |
326 |
|
326 | |||
327 | class InputList(list): |
|
327 | class InputList(list): | |
328 | """Class to store user input. |
|
328 | """Class to store user input. | |
329 |
|
329 | |||
330 | It's basically a list, but slices return a string instead of a list, thus |
|
330 | It's basically a list, but slices return a string instead of a list, thus | |
331 | allowing things like (assuming 'In' is an instance): |
|
331 | allowing things like (assuming 'In' is an instance): | |
332 |
|
332 | |||
333 | exec In[4:7] |
|
333 | exec In[4:7] | |
334 |
|
334 | |||
335 | or |
|
335 | or | |
336 |
|
336 | |||
337 | exec In[5:9] + In[14] + In[21:25]""" |
|
337 | exec In[5:9] + In[14] + In[21:25]""" | |
338 |
|
338 | |||
339 | def __getslice__(self,i,j): |
|
339 | def __getslice__(self,i,j): | |
340 | return ''.join(list.__getslice__(self,i,j)) |
|
340 | return ''.join(list.__getslice__(self,i,j)) | |
341 |
|
341 | |||
342 | class SyntaxTB(ultraTB.ListTB): |
|
342 | class SyntaxTB(ultraTB.ListTB): | |
343 | """Extension which holds some state: the last exception value""" |
|
343 | """Extension which holds some state: the last exception value""" | |
344 |
|
344 | |||
345 | def __init__(self,color_scheme = 'NoColor'): |
|
345 | def __init__(self,color_scheme = 'NoColor'): | |
346 | ultraTB.ListTB.__init__(self,color_scheme) |
|
346 | ultraTB.ListTB.__init__(self,color_scheme) | |
347 | self.last_syntax_error = None |
|
347 | self.last_syntax_error = None | |
348 |
|
348 | |||
349 | def __call__(self, etype, value, elist): |
|
349 | def __call__(self, etype, value, elist): | |
350 | self.last_syntax_error = value |
|
350 | self.last_syntax_error = value | |
351 | ultraTB.ListTB.__call__(self,etype,value,elist) |
|
351 | ultraTB.ListTB.__call__(self,etype,value,elist) | |
352 |
|
352 | |||
353 | def clear_err_state(self): |
|
353 | def clear_err_state(self): | |
354 | """Return the current error state and clear it""" |
|
354 | """Return the current error state and clear it""" | |
355 | e = self.last_syntax_error |
|
355 | e = self.last_syntax_error | |
356 | self.last_syntax_error = None |
|
356 | self.last_syntax_error = None | |
357 | return e |
|
357 | return e | |
358 |
|
358 | |||
359 | #**************************************************************************** |
|
359 | #**************************************************************************** | |
360 | # Main IPython class |
|
360 | # Main IPython class | |
361 |
|
361 | |||
362 | # FIXME: the Magic class is a mixin for now, and will unfortunately remain so |
|
362 | # FIXME: the Magic class is a mixin for now, and will unfortunately remain so | |
363 | # until a full rewrite is made. I've cleaned all cross-class uses of |
|
363 | # until a full rewrite is made. I've cleaned all cross-class uses of | |
364 | # attributes and methods, but too much user code out there relies on the |
|
364 | # attributes and methods, but too much user code out there relies on the | |
365 | # equlity %foo == __IP.magic_foo, so I can't actually remove the mixin usage. |
|
365 | # equlity %foo == __IP.magic_foo, so I can't actually remove the mixin usage. | |
366 | # |
|
366 | # | |
367 | # But at least now, all the pieces have been separated and we could, in |
|
367 | # But at least now, all the pieces have been separated and we could, in | |
368 | # principle, stop using the mixin. This will ease the transition to the |
|
368 | # principle, stop using the mixin. This will ease the transition to the | |
369 | # chainsaw branch. |
|
369 | # chainsaw branch. | |
370 |
|
370 | |||
371 | # For reference, the following is the list of 'self.foo' uses in the Magic |
|
371 | # For reference, the following is the list of 'self.foo' uses in the Magic | |
372 | # class as of 2005-12-28. These are names we CAN'T use in the main ipython |
|
372 | # class as of 2005-12-28. These are names we CAN'T use in the main ipython | |
373 | # class, to prevent clashes. |
|
373 | # class, to prevent clashes. | |
374 |
|
374 | |||
375 | # ['self.__class__', 'self.__dict__', 'self._inspect', 'self._ofind', |
|
375 | # ['self.__class__', 'self.__dict__', 'self._inspect', 'self._ofind', | |
376 | # 'self.arg_err', 'self.extract_input', 'self.format_', 'self.lsmagic', |
|
376 | # 'self.arg_err', 'self.extract_input', 'self.format_', 'self.lsmagic', | |
377 | # 'self.magic_', 'self.options_table', 'self.parse', 'self.shell', |
|
377 | # 'self.magic_', 'self.options_table', 'self.parse', 'self.shell', | |
378 | # 'self.value'] |
|
378 | # 'self.value'] | |
379 |
|
379 | |||
380 | class InteractiveShell(object,Magic): |
|
380 | class InteractiveShell(object,Magic): | |
381 | """An enhanced console for Python.""" |
|
381 | """An enhanced console for Python.""" | |
382 |
|
382 | |||
383 | # class attribute to indicate whether the class supports threads or not. |
|
383 | # class attribute to indicate whether the class supports threads or not. | |
384 | # Subclasses with thread support should override this as needed. |
|
384 | # Subclasses with thread support should override this as needed. | |
385 | isthreaded = False |
|
385 | isthreaded = False | |
386 |
|
386 | |||
387 | def __init__(self,name,usage=None,rc=Struct(opts=None,args=None), |
|
387 | def __init__(self,name,usage=None,rc=Struct(opts=None,args=None), | |
388 | user_ns=None,user_global_ns=None,banner2='', |
|
388 | user_ns=None,user_global_ns=None,banner2='', | |
389 | custom_exceptions=((),None),embedded=False): |
|
389 | custom_exceptions=((),None),embedded=False): | |
390 |
|
390 | |||
391 | # log system |
|
391 | # log system | |
392 | self.logger = Logger(self,logfname='ipython_log.py',logmode='rotate') |
|
392 | self.logger = Logger(self,logfname='ipython_log.py',logmode='rotate') | |
393 |
|
393 | |||
394 | # Job manager (for jobs run as background threads) |
|
394 | # Job manager (for jobs run as background threads) | |
395 | self.jobs = BackgroundJobManager() |
|
395 | self.jobs = BackgroundJobManager() | |
396 |
|
396 | |||
397 | # Store the actual shell's name |
|
397 | # Store the actual shell's name | |
398 | self.name = name |
|
398 | self.name = name | |
399 | self.more = False |
|
399 | self.more = False | |
400 |
|
400 | |||
401 | # We need to know whether the instance is meant for embedding, since |
|
401 | # We need to know whether the instance is meant for embedding, since | |
402 | # global/local namespaces need to be handled differently in that case |
|
402 | # global/local namespaces need to be handled differently in that case | |
403 | self.embedded = embedded |
|
403 | self.embedded = embedded | |
404 | if embedded: |
|
404 | if embedded: | |
405 | # Control variable so users can, from within the embedded instance, |
|
405 | # Control variable so users can, from within the embedded instance, | |
406 | # permanently deactivate it. |
|
406 | # permanently deactivate it. | |
407 | self.embedded_active = True |
|
407 | self.embedded_active = True | |
408 |
|
408 | |||
409 | # command compiler |
|
409 | # command compiler | |
410 | self.compile = codeop.CommandCompiler() |
|
410 | self.compile = codeop.CommandCompiler() | |
411 |
|
411 | |||
412 | # User input buffer |
|
412 | # User input buffer | |
413 | self.buffer = [] |
|
413 | self.buffer = [] | |
414 |
|
414 | |||
415 | # Default name given in compilation of code |
|
415 | # Default name given in compilation of code | |
416 | self.filename = '<ipython console>' |
|
416 | self.filename = '<ipython console>' | |
417 |
|
417 | |||
418 | # Install our own quitter instead of the builtins. For python2.3-2.4, |
|
418 | # Install our own quitter instead of the builtins. For python2.3-2.4, | |
419 | # this brings in behavior like 2.5, and for 2.5 it's identical. |
|
419 | # this brings in behavior like 2.5, and for 2.5 it's identical. | |
420 | __builtin__.exit = Quitter(self,'exit') |
|
420 | __builtin__.exit = Quitter(self,'exit') | |
421 | __builtin__.quit = Quitter(self,'quit') |
|
421 | __builtin__.quit = Quitter(self,'quit') | |
422 |
|
422 | |||
423 | # Make an empty namespace, which extension writers can rely on both |
|
423 | # Make an empty namespace, which extension writers can rely on both | |
424 | # existing and NEVER being used by ipython itself. This gives them a |
|
424 | # existing and NEVER being used by ipython itself. This gives them a | |
425 | # convenient location for storing additional information and state |
|
425 | # convenient location for storing additional information and state | |
426 | # their extensions may require, without fear of collisions with other |
|
426 | # their extensions may require, without fear of collisions with other | |
427 | # ipython names that may develop later. |
|
427 | # ipython names that may develop later. | |
428 | self.meta = Struct() |
|
428 | self.meta = Struct() | |
429 |
|
429 | |||
430 | # Create the namespace where the user will operate. user_ns is |
|
430 | # Create the namespace where the user will operate. user_ns is | |
431 | # normally the only one used, and it is passed to the exec calls as |
|
431 | # normally the only one used, and it is passed to the exec calls as | |
432 | # the locals argument. But we do carry a user_global_ns namespace |
|
432 | # the locals argument. But we do carry a user_global_ns namespace | |
433 | # given as the exec 'globals' argument, This is useful in embedding |
|
433 | # given as the exec 'globals' argument, This is useful in embedding | |
434 | # situations where the ipython shell opens in a context where the |
|
434 | # situations where the ipython shell opens in a context where the | |
435 | # distinction between locals and globals is meaningful. For |
|
435 | # distinction between locals and globals is meaningful. For | |
436 | # non-embedded contexts, it is just the same object as the user_ns dict. |
|
436 | # non-embedded contexts, it is just the same object as the user_ns dict. | |
437 |
|
437 | |||
438 | # FIXME. For some strange reason, __builtins__ is showing up at user |
|
438 | # FIXME. For some strange reason, __builtins__ is showing up at user | |
439 | # level as a dict instead of a module. This is a manual fix, but I |
|
439 | # level as a dict instead of a module. This is a manual fix, but I | |
440 | # should really track down where the problem is coming from. Alex |
|
440 | # should really track down where the problem is coming from. Alex | |
441 | # Schmolck reported this problem first. |
|
441 | # Schmolck reported this problem first. | |
442 |
|
442 | |||
443 | # A useful post by Alex Martelli on this topic: |
|
443 | # A useful post by Alex Martelli on this topic: | |
444 | # Re: inconsistent value from __builtins__ |
|
444 | # Re: inconsistent value from __builtins__ | |
445 | # Von: Alex Martelli <aleaxit@yahoo.com> |
|
445 | # Von: Alex Martelli <aleaxit@yahoo.com> | |
446 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends |
|
446 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends | |
447 | # Gruppen: comp.lang.python |
|
447 | # Gruppen: comp.lang.python | |
448 |
|
448 | |||
449 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: |
|
449 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: | |
450 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) |
|
450 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) | |
451 | # > <type 'dict'> |
|
451 | # > <type 'dict'> | |
452 | # > >>> print type(__builtins__) |
|
452 | # > >>> print type(__builtins__) | |
453 | # > <type 'module'> |
|
453 | # > <type 'module'> | |
454 | # > Is this difference in return value intentional? |
|
454 | # > Is this difference in return value intentional? | |
455 |
|
455 | |||
456 | # Well, it's documented that '__builtins__' can be either a dictionary |
|
456 | # Well, it's documented that '__builtins__' can be either a dictionary | |
457 | # or a module, and it's been that way for a long time. Whether it's |
|
457 | # or a module, and it's been that way for a long time. Whether it's | |
458 | # intentional (or sensible), I don't know. In any case, the idea is |
|
458 | # intentional (or sensible), I don't know. In any case, the idea is | |
459 | # that if you need to access the built-in namespace directly, you |
|
459 | # that if you need to access the built-in namespace directly, you | |
460 | # should start with "import __builtin__" (note, no 's') which will |
|
460 | # should start with "import __builtin__" (note, no 's') which will | |
461 | # definitely give you a module. Yeah, it's somewhat confusing:-(. |
|
461 | # definitely give you a module. Yeah, it's somewhat confusing:-(. | |
462 |
|
462 | |||
463 | # These routines return properly built dicts as needed by the rest of |
|
463 | # These routines return properly built dicts as needed by the rest of | |
464 | # the code, and can also be used by extension writers to generate |
|
464 | # the code, and can also be used by extension writers to generate | |
465 | # properly initialized namespaces. |
|
465 | # properly initialized namespaces. | |
466 | user_ns, user_global_ns = ipapi.make_user_namespaces(user_ns, |
|
466 | user_ns, user_global_ns = ipapi.make_user_namespaces(user_ns, | |
467 | user_global_ns) |
|
467 | user_global_ns) | |
468 |
|
468 | |||
469 | # Assign namespaces |
|
469 | # Assign namespaces | |
470 | # This is the namespace where all normal user variables live |
|
470 | # This is the namespace where all normal user variables live | |
471 | self.user_ns = user_ns |
|
471 | self.user_ns = user_ns | |
472 | self.user_global_ns = user_global_ns |
|
472 | self.user_global_ns = user_global_ns | |
473 |
|
473 | |||
474 | # An auxiliary namespace that checks what parts of the user_ns were |
|
474 | # An auxiliary namespace that checks what parts of the user_ns were | |
475 | # loaded at startup, so we can list later only variables defined in |
|
475 | # loaded at startup, so we can list later only variables defined in | |
476 | # actual interactive use. Since it is always a subset of user_ns, it |
|
476 | # actual interactive use. Since it is always a subset of user_ns, it | |
477 | # doesn't need to be seaparately tracked in the ns_table |
|
477 | # doesn't need to be seaparately tracked in the ns_table | |
478 | self.user_config_ns = {} |
|
478 | self.user_config_ns = {} | |
479 |
|
479 | |||
480 | # A namespace to keep track of internal data structures to prevent |
|
480 | # A namespace to keep track of internal data structures to prevent | |
481 | # them from cluttering user-visible stuff. Will be updated later |
|
481 | # them from cluttering user-visible stuff. Will be updated later | |
482 | self.internal_ns = {} |
|
482 | self.internal_ns = {} | |
483 |
|
483 | |||
484 | # Namespace of system aliases. Each entry in the alias |
|
484 | # Namespace of system aliases. Each entry in the alias | |
485 | # table must be a 2-tuple of the form (N,name), where N is the number |
|
485 | # table must be a 2-tuple of the form (N,name), where N is the number | |
486 | # of positional arguments of the alias. |
|
486 | # of positional arguments of the alias. | |
487 | self.alias_table = {} |
|
487 | self.alias_table = {} | |
488 |
|
488 | |||
489 | # Now that FakeModule produces a real module, we've run into a nasty |
|
489 | # Now that FakeModule produces a real module, we've run into a nasty | |
490 | # problem: after script execution (via %run), the module where the user |
|
490 | # problem: after script execution (via %run), the module where the user | |
491 | # code ran is deleted. Now that this object is a true module (needed |
|
491 | # code ran is deleted. Now that this object is a true module (needed | |
492 | # so docetst and other tools work correctly), the Python module |
|
492 | # so docetst and other tools work correctly), the Python module | |
493 | # teardown mechanism runs over it, and sets to None every variable |
|
493 | # teardown mechanism runs over it, and sets to None every variable | |
494 | # present in that module. Top-level references to objects from the |
|
494 | # present in that module. Top-level references to objects from the | |
495 | # script survive, because the user_ns is updated with them. However, |
|
495 | # script survive, because the user_ns is updated with them. However, | |
496 | # calling functions defined in the script that use other things from |
|
496 | # calling functions defined in the script that use other things from | |
497 | # the script will fail, because the function's closure had references |
|
497 | # the script will fail, because the function's closure had references | |
498 | # to the original objects, which are now all None. So we must protect |
|
498 | # to the original objects, which are now all None. So we must protect | |
499 | # these modules from deletion by keeping a cache. |
|
499 | # these modules from deletion by keeping a cache. | |
500 | # |
|
500 | # | |
501 | # To avoid keeping stale modules around (we only need the one from the |
|
501 | # To avoid keeping stale modules around (we only need the one from the | |
502 | # last run), we use a dict keyed with the full path to the script, so |
|
502 | # last run), we use a dict keyed with the full path to the script, so | |
503 | # only the last version of the module is held in the cache. Note, |
|
503 | # only the last version of the module is held in the cache. Note, | |
504 | # however, that we must cache the module *namespace contents* (their |
|
504 | # however, that we must cache the module *namespace contents* (their | |
505 | # __dict__). Because if we try to cache the actual modules, old ones |
|
505 | # __dict__). Because if we try to cache the actual modules, old ones | |
506 | # (uncached) could be destroyed while still holding references (such as |
|
506 | # (uncached) could be destroyed while still holding references (such as | |
507 | # those held by GUI objects that tend to be long-lived)> |
|
507 | # those held by GUI objects that tend to be long-lived)> | |
508 | # |
|
508 | # | |
509 | # The %reset command will flush this cache. See the cache_main_mod() |
|
509 | # The %reset command will flush this cache. See the cache_main_mod() | |
510 | # and clear_main_mod_cache() methods for details on use. |
|
510 | # and clear_main_mod_cache() methods for details on use. | |
511 |
|
511 | |||
512 | # This is the cache used for 'main' namespaces |
|
512 | # This is the cache used for 'main' namespaces | |
513 | self._main_ns_cache = {} |
|
513 | self._main_ns_cache = {} | |
514 | # And this is the single instance of FakeModule whose __dict__ we keep |
|
514 | # And this is the single instance of FakeModule whose __dict__ we keep | |
515 | # copying and clearing for reuse on each %run |
|
515 | # copying and clearing for reuse on each %run | |
516 | self._user_main_module = FakeModule() |
|
516 | self._user_main_module = FakeModule() | |
517 |
|
517 | |||
518 | # A table holding all the namespaces IPython deals with, so that |
|
518 | # A table holding all the namespaces IPython deals with, so that | |
519 | # introspection facilities can search easily. |
|
519 | # introspection facilities can search easily. | |
520 | self.ns_table = {'user':user_ns, |
|
520 | self.ns_table = {'user':user_ns, | |
521 | 'user_global':user_global_ns, |
|
521 | 'user_global':user_global_ns, | |
522 | 'alias':self.alias_table, |
|
522 | 'alias':self.alias_table, | |
523 | 'internal':self.internal_ns, |
|
523 | 'internal':self.internal_ns, | |
524 | 'builtin':__builtin__.__dict__ |
|
524 | 'builtin':__builtin__.__dict__ | |
525 | } |
|
525 | } | |
526 |
|
526 | |||
527 | # Similarly, track all namespaces where references can be held and that |
|
527 | # Similarly, track all namespaces where references can be held and that | |
528 | # we can safely clear (so it can NOT include builtin). This one can be |
|
528 | # we can safely clear (so it can NOT include builtin). This one can be | |
529 | # a simple list. |
|
529 | # a simple list. | |
530 | self.ns_refs_table = [ user_ns, user_global_ns, self.user_config_ns, |
|
530 | self.ns_refs_table = [ user_ns, user_global_ns, self.user_config_ns, | |
531 | self.alias_table, self.internal_ns, |
|
531 | self.alias_table, self.internal_ns, | |
532 | self._main_ns_cache ] |
|
532 | self._main_ns_cache ] | |
533 |
|
533 | |||
534 | # We need to insert into sys.modules something that looks like a |
|
534 | # We need to insert into sys.modules something that looks like a | |
535 | # module but which accesses the IPython namespace, for shelve and |
|
535 | # module but which accesses the IPython namespace, for shelve and | |
536 | # pickle to work interactively. Normally they rely on getting |
|
536 | # pickle to work interactively. Normally they rely on getting | |
537 | # everything out of __main__, but for embedding purposes each IPython |
|
537 | # everything out of __main__, but for embedding purposes each IPython | |
538 | # instance has its own private namespace, so we can't go shoving |
|
538 | # instance has its own private namespace, so we can't go shoving | |
539 | # everything into __main__. |
|
539 | # everything into __main__. | |
540 |
|
540 | |||
541 | # note, however, that we should only do this for non-embedded |
|
541 | # note, however, that we should only do this for non-embedded | |
542 | # ipythons, which really mimic the __main__.__dict__ with their own |
|
542 | # ipythons, which really mimic the __main__.__dict__ with their own | |
543 | # namespace. Embedded instances, on the other hand, should not do |
|
543 | # namespace. Embedded instances, on the other hand, should not do | |
544 | # this because they need to manage the user local/global namespaces |
|
544 | # this because they need to manage the user local/global namespaces | |
545 | # only, but they live within a 'normal' __main__ (meaning, they |
|
545 | # only, but they live within a 'normal' __main__ (meaning, they | |
546 | # shouldn't overtake the execution environment of the script they're |
|
546 | # shouldn't overtake the execution environment of the script they're | |
547 | # embedded in). |
|
547 | # embedded in). | |
548 |
|
548 | |||
549 | if not embedded: |
|
549 | if not embedded: | |
550 | try: |
|
550 | try: | |
551 | main_name = self.user_ns['__name__'] |
|
551 | main_name = self.user_ns['__name__'] | |
552 | except KeyError: |
|
552 | except KeyError: | |
553 | raise KeyError,'user_ns dictionary MUST have a "__name__" key' |
|
553 | raise KeyError,'user_ns dictionary MUST have a "__name__" key' | |
554 | else: |
|
554 | else: | |
555 | #print "pickle hack in place" # dbg |
|
555 | #print "pickle hack in place" # dbg | |
556 | #print 'main_name:',main_name # dbg |
|
556 | #print 'main_name:',main_name # dbg | |
557 | sys.modules[main_name] = FakeModule(self.user_ns) |
|
557 | sys.modules[main_name] = FakeModule(self.user_ns) | |
558 |
|
558 | |||
559 | # List of input with multi-line handling. |
|
559 | # List of input with multi-line handling. | |
560 | self.input_hist = InputList() |
|
560 | self.input_hist = InputList() | |
561 | # This one will hold the 'raw' input history, without any |
|
561 | # This one will hold the 'raw' input history, without any | |
562 | # pre-processing. This will allow users to retrieve the input just as |
|
562 | # pre-processing. This will allow users to retrieve the input just as | |
563 | # it was exactly typed in by the user, with %hist -r. |
|
563 | # it was exactly typed in by the user, with %hist -r. | |
564 | self.input_hist_raw = InputList() |
|
564 | self.input_hist_raw = InputList() | |
565 |
|
565 | |||
566 | # list of visited directories |
|
566 | # list of visited directories | |
567 | try: |
|
567 | try: | |
568 | self.dir_hist = [os.getcwd()] |
|
568 | self.dir_hist = [os.getcwd()] | |
569 | except OSError: |
|
569 | except OSError: | |
570 | self.dir_hist = [] |
|
570 | self.dir_hist = [] | |
571 |
|
571 | |||
572 | # dict of output history |
|
572 | # dict of output history | |
573 | self.output_hist = {} |
|
573 | self.output_hist = {} | |
574 |
|
574 | |||
575 | # Get system encoding at startup time. Certain terminals (like Emacs |
|
575 | # Get system encoding at startup time. Certain terminals (like Emacs | |
576 | # under Win32 have it set to None, and we need to have a known valid |
|
576 | # under Win32 have it set to None, and we need to have a known valid | |
577 | # encoding to use in the raw_input() method |
|
577 | # encoding to use in the raw_input() method | |
578 | try: |
|
578 | try: | |
579 | self.stdin_encoding = sys.stdin.encoding or 'ascii' |
|
579 | self.stdin_encoding = sys.stdin.encoding or 'ascii' | |
580 | except AttributeError: |
|
580 | except AttributeError: | |
581 | self.stdin_encoding = 'ascii' |
|
581 | self.stdin_encoding = 'ascii' | |
582 |
|
582 | |||
583 | # dict of things NOT to alias (keywords, builtins and some magics) |
|
583 | # dict of things NOT to alias (keywords, builtins and some magics) | |
584 | no_alias = {} |
|
584 | no_alias = {} | |
585 | no_alias_magics = ['cd','popd','pushd','dhist','alias','unalias'] |
|
585 | no_alias_magics = ['cd','popd','pushd','dhist','alias','unalias'] | |
586 | for key in keyword.kwlist + no_alias_magics: |
|
586 | for key in keyword.kwlist + no_alias_magics: | |
587 | no_alias[key] = 1 |
|
587 | no_alias[key] = 1 | |
588 | no_alias.update(__builtin__.__dict__) |
|
588 | no_alias.update(__builtin__.__dict__) | |
589 | self.no_alias = no_alias |
|
589 | self.no_alias = no_alias | |
590 |
|
590 | |||
591 | # Object variable to store code object waiting execution. This is |
|
591 | # Object variable to store code object waiting execution. This is | |
592 | # used mainly by the multithreaded shells, but it can come in handy in |
|
592 | # used mainly by the multithreaded shells, but it can come in handy in | |
593 | # other situations. No need to use a Queue here, since it's a single |
|
593 | # other situations. No need to use a Queue here, since it's a single | |
594 | # item which gets cleared once run. |
|
594 | # item which gets cleared once run. | |
595 | self.code_to_run = None |
|
595 | self.code_to_run = None | |
596 |
|
596 | |||
597 | # escapes for automatic behavior on the command line |
|
597 | # escapes for automatic behavior on the command line | |
598 | self.ESC_SHELL = '!' |
|
598 | self.ESC_SHELL = '!' | |
599 | self.ESC_SH_CAP = '!!' |
|
599 | self.ESC_SH_CAP = '!!' | |
600 | self.ESC_HELP = '?' |
|
600 | self.ESC_HELP = '?' | |
601 | self.ESC_MAGIC = '%' |
|
601 | self.ESC_MAGIC = '%' | |
602 | self.ESC_QUOTE = ',' |
|
602 | self.ESC_QUOTE = ',' | |
603 | self.ESC_QUOTE2 = ';' |
|
603 | self.ESC_QUOTE2 = ';' | |
604 | self.ESC_PAREN = '/' |
|
604 | self.ESC_PAREN = '/' | |
605 |
|
605 | |||
606 | # And their associated handlers |
|
606 | # And their associated handlers | |
607 | self.esc_handlers = {self.ESC_PAREN : self.handle_auto, |
|
607 | self.esc_handlers = {self.ESC_PAREN : self.handle_auto, | |
608 | self.ESC_QUOTE : self.handle_auto, |
|
608 | self.ESC_QUOTE : self.handle_auto, | |
609 | self.ESC_QUOTE2 : self.handle_auto, |
|
609 | self.ESC_QUOTE2 : self.handle_auto, | |
610 | self.ESC_MAGIC : self.handle_magic, |
|
610 | self.ESC_MAGIC : self.handle_magic, | |
611 | self.ESC_HELP : self.handle_help, |
|
611 | self.ESC_HELP : self.handle_help, | |
612 | self.ESC_SHELL : self.handle_shell_escape, |
|
612 | self.ESC_SHELL : self.handle_shell_escape, | |
613 | self.ESC_SH_CAP : self.handle_shell_escape, |
|
613 | self.ESC_SH_CAP : self.handle_shell_escape, | |
614 | } |
|
614 | } | |
615 |
|
615 | |||
616 | # class initializations |
|
616 | # class initializations | |
617 | Magic.__init__(self,self) |
|
617 | Magic.__init__(self,self) | |
618 |
|
618 | |||
619 | # Python source parser/formatter for syntax highlighting |
|
619 | # Python source parser/formatter for syntax highlighting | |
620 | pyformat = PyColorize.Parser().format |
|
620 | pyformat = PyColorize.Parser().format | |
621 | self.pycolorize = lambda src: pyformat(src,'str',self.rc['colors']) |
|
621 | self.pycolorize = lambda src: pyformat(src,'str',self.rc['colors']) | |
622 |
|
622 | |||
623 | # hooks holds pointers used for user-side customizations |
|
623 | # hooks holds pointers used for user-side customizations | |
624 | self.hooks = Struct() |
|
624 | self.hooks = Struct() | |
625 |
|
625 | |||
626 | self.strdispatchers = {} |
|
626 | self.strdispatchers = {} | |
627 |
|
627 | |||
628 | # Set all default hooks, defined in the IPython.hooks module. |
|
628 | # Set all default hooks, defined in the IPython.hooks module. | |
629 | import IPython.core.hooks |
|
629 | import IPython.core.hooks | |
630 | hooks = IPython.core.hooks |
|
630 | hooks = IPython.core.hooks | |
631 | for hook_name in hooks.__all__: |
|
631 | for hook_name in hooks.__all__: | |
632 | # default hooks have priority 100, i.e. low; user hooks should have |
|
632 | # default hooks have priority 100, i.e. low; user hooks should have | |
633 | # 0-100 priority |
|
633 | # 0-100 priority | |
634 | self.set_hook(hook_name,getattr(hooks,hook_name), 100) |
|
634 | self.set_hook(hook_name,getattr(hooks,hook_name), 100) | |
635 | #print "bound hook",hook_name |
|
635 | #print "bound hook",hook_name | |
636 |
|
636 | |||
637 | # Flag to mark unconditional exit |
|
637 | # Flag to mark unconditional exit | |
638 | self.exit_now = False |
|
638 | self.exit_now = False | |
639 |
|
639 | |||
640 | self.usage_min = """\ |
|
640 | self.usage_min = """\ | |
641 | An enhanced console for Python. |
|
641 | An enhanced console for Python. | |
642 | Some of its features are: |
|
642 | Some of its features are: | |
643 | - Readline support if the readline library is present. |
|
643 | - Readline support if the readline library is present. | |
644 | - Tab completion in the local namespace. |
|
644 | - Tab completion in the local namespace. | |
645 | - Logging of input, see command-line options. |
|
645 | - Logging of input, see command-line options. | |
646 | - System shell escape via ! , eg !ls. |
|
646 | - System shell escape via ! , eg !ls. | |
647 | - Magic commands, starting with a % (like %ls, %pwd, %cd, etc.) |
|
647 | - Magic commands, starting with a % (like %ls, %pwd, %cd, etc.) | |
648 | - Keeps track of locally defined variables via %who, %whos. |
|
648 | - Keeps track of locally defined variables via %who, %whos. | |
649 | - Show object information with a ? eg ?x or x? (use ?? for more info). |
|
649 | - Show object information with a ? eg ?x or x? (use ?? for more info). | |
650 | """ |
|
650 | """ | |
651 | if usage: self.usage = usage |
|
651 | if usage: self.usage = usage | |
652 | else: self.usage = self.usage_min |
|
652 | else: self.usage = self.usage_min | |
653 |
|
653 | |||
654 | # Storage |
|
654 | # Storage | |
655 | self.rc = rc # This will hold all configuration information |
|
655 | self.rc = rc # This will hold all configuration information | |
656 | self.pager = 'less' |
|
656 | self.pager = 'less' | |
657 | # temporary files used for various purposes. Deleted at exit. |
|
657 | # temporary files used for various purposes. Deleted at exit. | |
658 | self.tempfiles = [] |
|
658 | self.tempfiles = [] | |
659 |
|
659 | |||
660 | # Keep track of readline usage (later set by init_readline) |
|
660 | # Keep track of readline usage (later set by init_readline) | |
661 | self.has_readline = False |
|
661 | self.has_readline = False | |
662 |
|
662 | |||
663 | # template for logfile headers. It gets resolved at runtime by the |
|
663 | # template for logfile headers. It gets resolved at runtime by the | |
664 | # logstart method. |
|
664 | # logstart method. | |
665 | self.loghead_tpl = \ |
|
665 | self.loghead_tpl = \ | |
666 | """#log# Automatic Logger file. *** THIS MUST BE THE FIRST LINE *** |
|
666 | """#log# Automatic Logger file. *** THIS MUST BE THE FIRST LINE *** | |
667 | #log# DO NOT CHANGE THIS LINE OR THE TWO BELOW |
|
667 | #log# DO NOT CHANGE THIS LINE OR THE TWO BELOW | |
668 | #log# opts = %s |
|
668 | #log# opts = %s | |
669 | #log# args = %s |
|
669 | #log# args = %s | |
670 | #log# It is safe to make manual edits below here. |
|
670 | #log# It is safe to make manual edits below here. | |
671 | #log#----------------------------------------------------------------------- |
|
671 | #log#----------------------------------------------------------------------- | |
672 | """ |
|
672 | """ | |
673 | # for pushd/popd management |
|
673 | # for pushd/popd management | |
674 | try: |
|
674 | try: | |
675 | self.home_dir = get_home_dir() |
|
675 | self.home_dir = get_home_dir() | |
676 | except HomeDirError,msg: |
|
676 | except HomeDirError,msg: | |
677 | fatal(msg) |
|
677 | fatal(msg) | |
678 |
|
678 | |||
679 | self.dir_stack = [] |
|
679 | self.dir_stack = [] | |
680 |
|
680 | |||
681 | # Functions to call the underlying shell. |
|
681 | # Functions to call the underlying shell. | |
682 |
|
682 | |||
683 | # The first is similar to os.system, but it doesn't return a value, |
|
683 | # The first is similar to os.system, but it doesn't return a value, | |
684 | # and it allows interpolation of variables in the user's namespace. |
|
684 | # and it allows interpolation of variables in the user's namespace. | |
685 | self.system = lambda cmd: \ |
|
685 | self.system = lambda cmd: \ | |
686 | self.hooks.shell_hook(self.var_expand(cmd,depth=2)) |
|
686 | self.hooks.shell_hook(self.var_expand(cmd,depth=2)) | |
687 |
|
687 | |||
688 | # These are for getoutput and getoutputerror: |
|
688 | # These are for getoutput and getoutputerror: | |
689 | self.getoutput = lambda cmd: \ |
|
689 | self.getoutput = lambda cmd: \ | |
690 | getoutput(self.var_expand(cmd,depth=2), |
|
690 | getoutput(self.var_expand(cmd,depth=2), | |
691 | header=self.rc.system_header, |
|
691 | header=self.rc.system_header, | |
692 | verbose=self.rc.system_verbose) |
|
692 | verbose=self.rc.system_verbose) | |
693 |
|
693 | |||
694 | self.getoutputerror = lambda cmd: \ |
|
694 | self.getoutputerror = lambda cmd: \ | |
695 | getoutputerror(self.var_expand(cmd,depth=2), |
|
695 | getoutputerror(self.var_expand(cmd,depth=2), | |
696 | header=self.rc.system_header, |
|
696 | header=self.rc.system_header, | |
697 | verbose=self.rc.system_verbose) |
|
697 | verbose=self.rc.system_verbose) | |
698 |
|
698 | |||
699 |
|
699 | |||
700 | # keep track of where we started running (mainly for crash post-mortem) |
|
700 | # keep track of where we started running (mainly for crash post-mortem) | |
701 | self.starting_dir = os.getcwd() |
|
701 | self.starting_dir = os.getcwd() | |
702 |
|
702 | |||
703 | # Various switches which can be set |
|
703 | # Various switches which can be set | |
704 | self.CACHELENGTH = 5000 # this is cheap, it's just text |
|
704 | self.CACHELENGTH = 5000 # this is cheap, it's just text | |
705 | self.BANNER = "Python %(version)s on %(platform)s\n" % sys.__dict__ |
|
705 | self.BANNER = "Python %(version)s on %(platform)s\n" % sys.__dict__ | |
706 | self.banner2 = banner2 |
|
706 | self.banner2 = banner2 | |
707 |
|
707 | |||
708 | # TraceBack handlers: |
|
708 | # TraceBack handlers: | |
709 |
|
709 | |||
710 | # Syntax error handler. |
|
710 | # Syntax error handler. | |
711 | self.SyntaxTB = SyntaxTB(color_scheme='NoColor') |
|
711 | self.SyntaxTB = SyntaxTB(color_scheme='NoColor') | |
712 |
|
712 | |||
713 | # The interactive one is initialized with an offset, meaning we always |
|
713 | # The interactive one is initialized with an offset, meaning we always | |
714 | # want to remove the topmost item in the traceback, which is our own |
|
714 | # want to remove the topmost item in the traceback, which is our own | |
715 | # internal code. Valid modes: ['Plain','Context','Verbose'] |
|
715 | # internal code. Valid modes: ['Plain','Context','Verbose'] | |
716 | self.InteractiveTB = ultraTB.AutoFormattedTB(mode = 'Plain', |
|
716 | self.InteractiveTB = ultraTB.AutoFormattedTB(mode = 'Plain', | |
717 | color_scheme='NoColor', |
|
717 | color_scheme='NoColor', | |
718 | tb_offset = 1) |
|
718 | tb_offset = 1) | |
719 |
|
719 | |||
720 | # IPython itself shouldn't crash. This will produce a detailed |
|
720 | # IPython itself shouldn't crash. This will produce a detailed | |
721 | # post-mortem if it does. But we only install the crash handler for |
|
721 | # post-mortem if it does. But we only install the crash handler for | |
722 | # non-threaded shells, the threaded ones use a normal verbose reporter |
|
722 | # non-threaded shells, the threaded ones use a normal verbose reporter | |
723 | # and lose the crash handler. This is because exceptions in the main |
|
723 | # and lose the crash handler. This is because exceptions in the main | |
724 | # thread (such as in GUI code) propagate directly to sys.excepthook, |
|
724 | # thread (such as in GUI code) propagate directly to sys.excepthook, | |
725 | # and there's no point in printing crash dumps for every user exception. |
|
725 | # and there's no point in printing crash dumps for every user exception. | |
726 | if self.isthreaded: |
|
726 | if self.isthreaded: | |
727 | ipCrashHandler = ultraTB.FormattedTB() |
|
727 | ipCrashHandler = ultraTB.FormattedTB() | |
728 | else: |
|
728 | else: | |
729 | from IPython.core import crashhandler |
|
729 | from IPython.core import crashhandler | |
730 | ipCrashHandler = crashhandler.IPythonCrashHandler(self) |
|
730 | ipCrashHandler = crashhandler.IPythonCrashHandler(self) | |
731 | self.set_crash_handler(ipCrashHandler) |
|
731 | self.set_crash_handler(ipCrashHandler) | |
732 |
|
732 | |||
733 | # and add any custom exception handlers the user may have specified |
|
733 | # and add any custom exception handlers the user may have specified | |
734 | self.set_custom_exc(*custom_exceptions) |
|
734 | self.set_custom_exc(*custom_exceptions) | |
735 |
|
735 | |||
736 | # indentation management |
|
736 | # indentation management | |
737 | self.autoindent = False |
|
737 | self.autoindent = False | |
738 | self.indent_current_nsp = 0 |
|
738 | self.indent_current_nsp = 0 | |
739 |
|
739 | |||
740 | # Make some aliases automatically |
|
740 | # Make some aliases automatically | |
741 | # Prepare list of shell aliases to auto-define |
|
741 | # Prepare list of shell aliases to auto-define | |
742 | if os.name == 'posix': |
|
742 | if os.name == 'posix': | |
743 | auto_alias = ('mkdir mkdir', 'rmdir rmdir', |
|
743 | auto_alias = ('mkdir mkdir', 'rmdir rmdir', | |
744 | 'mv mv -i','rm rm -i','cp cp -i', |
|
744 | 'mv mv -i','rm rm -i','cp cp -i', | |
745 | 'cat cat','less less','clear clear', |
|
745 | 'cat cat','less less','clear clear', | |
746 | # a better ls |
|
746 | # a better ls | |
747 | 'ls ls -F', |
|
747 | 'ls ls -F', | |
748 | # long ls |
|
748 | # long ls | |
749 | 'll ls -lF') |
|
749 | 'll ls -lF') | |
750 | # Extra ls aliases with color, which need special treatment on BSD |
|
750 | # Extra ls aliases with color, which need special treatment on BSD | |
751 | # variants |
|
751 | # variants | |
752 | ls_extra = ( # color ls |
|
752 | ls_extra = ( # color ls | |
753 | 'lc ls -F -o --color', |
|
753 | 'lc ls -F -o --color', | |
754 | # ls normal files only |
|
754 | # ls normal files only | |
755 | 'lf ls -F -o --color %l | grep ^-', |
|
755 | 'lf ls -F -o --color %l | grep ^-', | |
756 | # ls symbolic links |
|
756 | # ls symbolic links | |
757 | 'lk ls -F -o --color %l | grep ^l', |
|
757 | 'lk ls -F -o --color %l | grep ^l', | |
758 | # directories or links to directories, |
|
758 | # directories or links to directories, | |
759 | 'ldir ls -F -o --color %l | grep /$', |
|
759 | 'ldir ls -F -o --color %l | grep /$', | |
760 | # things which are executable |
|
760 | # things which are executable | |
761 | 'lx ls -F -o --color %l | grep ^-..x', |
|
761 | 'lx ls -F -o --color %l | grep ^-..x', | |
762 | ) |
|
762 | ) | |
763 | # The BSDs don't ship GNU ls, so they don't understand the |
|
763 | # The BSDs don't ship GNU ls, so they don't understand the | |
764 | # --color switch out of the box |
|
764 | # --color switch out of the box | |
765 | if 'bsd' in sys.platform: |
|
765 | if 'bsd' in sys.platform: | |
766 | ls_extra = ( # ls normal files only |
|
766 | ls_extra = ( # ls normal files only | |
767 | 'lf ls -lF | grep ^-', |
|
767 | 'lf ls -lF | grep ^-', | |
768 | # ls symbolic links |
|
768 | # ls symbolic links | |
769 | 'lk ls -lF | grep ^l', |
|
769 | 'lk ls -lF | grep ^l', | |
770 | # directories or links to directories, |
|
770 | # directories or links to directories, | |
771 | 'ldir ls -lF | grep /$', |
|
771 | 'ldir ls -lF | grep /$', | |
772 | # things which are executable |
|
772 | # things which are executable | |
773 | 'lx ls -lF | grep ^-..x', |
|
773 | 'lx ls -lF | grep ^-..x', | |
774 | ) |
|
774 | ) | |
775 | auto_alias = auto_alias + ls_extra |
|
775 | auto_alias = auto_alias + ls_extra | |
776 | elif os.name in ['nt','dos']: |
|
776 | elif os.name in ['nt','dos']: | |
777 | auto_alias = ('ls dir /on', |
|
777 | auto_alias = ('ls dir /on', | |
778 | 'ddir dir /ad /on', 'ldir dir /ad /on', |
|
778 | 'ddir dir /ad /on', 'ldir dir /ad /on', | |
779 | 'mkdir mkdir','rmdir rmdir','echo echo', |
|
779 | 'mkdir mkdir','rmdir rmdir','echo echo', | |
780 | 'ren ren','cls cls','copy copy') |
|
780 | 'ren ren','cls cls','copy copy') | |
781 | else: |
|
781 | else: | |
782 | auto_alias = () |
|
782 | auto_alias = () | |
783 | self.auto_alias = [s.split(None,1) for s in auto_alias] |
|
783 | self.auto_alias = [s.split(None,1) for s in auto_alias] | |
784 |
|
784 | |||
785 | # Produce a public API instance |
|
785 | # Produce a public API instance | |
786 | self.api = ipapi.IPApi(self) |
|
786 | self.api = ipapi.IPApi(self) | |
787 |
|
787 | |||
788 | # Initialize all user-visible namespaces |
|
788 | # Initialize all user-visible namespaces | |
789 | self.init_namespaces() |
|
789 | self.init_namespaces() | |
790 |
|
790 | |||
791 | # Call the actual (public) initializer |
|
791 | # Call the actual (public) initializer | |
792 | self.init_auto_alias() |
|
792 | self.init_auto_alias() | |
793 |
|
793 | |||
794 | # track which builtins we add, so we can clean up later |
|
794 | # track which builtins we add, so we can clean up later | |
795 | self.builtins_added = {} |
|
795 | self.builtins_added = {} | |
796 | # This method will add the necessary builtins for operation, but |
|
796 | # This method will add the necessary builtins for operation, but | |
797 | # tracking what it did via the builtins_added dict. |
|
797 | # tracking what it did via the builtins_added dict. | |
798 |
|
798 | |||
799 | #TODO: remove this, redundant |
|
799 | #TODO: remove this, redundant | |
800 | self.add_builtins() |
|
800 | self.add_builtins() | |
801 | # end __init__ |
|
801 | # end __init__ | |
802 |
|
802 | |||
803 | def var_expand(self,cmd,depth=0): |
|
803 | def var_expand(self,cmd,depth=0): | |
804 | """Expand python variables in a string. |
|
804 | """Expand python variables in a string. | |
805 |
|
805 | |||
806 | The depth argument indicates how many frames above the caller should |
|
806 | The depth argument indicates how many frames above the caller should | |
807 | be walked to look for the local namespace where to expand variables. |
|
807 | be walked to look for the local namespace where to expand variables. | |
808 |
|
808 | |||
809 | The global namespace for expansion is always the user's interactive |
|
809 | The global namespace for expansion is always the user's interactive | |
810 | namespace. |
|
810 | namespace. | |
811 | """ |
|
811 | """ | |
812 |
|
812 | |||
813 | return str(ItplNS(cmd, |
|
813 | return str(ItplNS(cmd, | |
814 | self.user_ns, # globals |
|
814 | self.user_ns, # globals | |
815 | # Skip our own frame in searching for locals: |
|
815 | # Skip our own frame in searching for locals: | |
816 | sys._getframe(depth+1).f_locals # locals |
|
816 | sys._getframe(depth+1).f_locals # locals | |
817 | )) |
|
817 | )) | |
818 |
|
818 | |||
819 | def pre_config_initialization(self): |
|
819 | def pre_config_initialization(self): | |
820 | """Pre-configuration init method |
|
820 | """Pre-configuration init method | |
821 |
|
821 | |||
822 | This is called before the configuration files are processed to |
|
822 | This is called before the configuration files are processed to | |
823 | prepare the services the config files might need. |
|
823 | prepare the services the config files might need. | |
824 |
|
824 | |||
825 | self.rc already has reasonable default values at this point. |
|
825 | self.rc already has reasonable default values at this point. | |
826 | """ |
|
826 | """ | |
827 | rc = self.rc |
|
827 | rc = self.rc | |
828 | try: |
|
828 | try: | |
829 | self.db = pickleshare.PickleShareDB(rc.ipythondir + "/db") |
|
829 | self.db = pickleshare.PickleShareDB(rc.ipythondir + "/db") | |
830 | except exceptions.UnicodeDecodeError: |
|
830 | except exceptions.UnicodeDecodeError: | |
831 | print "Your ipythondir can't be decoded to unicode!" |
|
831 | print "Your ipythondir can't be decoded to unicode!" | |
832 | print "Please set HOME environment variable to something that" |
|
832 | print "Please set HOME environment variable to something that" | |
833 | print r"only has ASCII characters, e.g. c:\home" |
|
833 | print r"only has ASCII characters, e.g. c:\home" | |
834 | print "Now it is",rc.ipythondir |
|
834 | print "Now it is",rc.ipythondir | |
835 | sys.exit() |
|
835 | sys.exit() | |
836 | self.shadowhist = IPython.core.history.ShadowHist(self.db) |
|
836 | self.shadowhist = IPython.core.history.ShadowHist(self.db) | |
837 |
|
837 | |||
838 | def post_config_initialization(self): |
|
838 | def post_config_initialization(self): | |
839 | """Post configuration init method |
|
839 | """Post configuration init method | |
840 |
|
840 | |||
841 | This is called after the configuration files have been processed to |
|
841 | This is called after the configuration files have been processed to | |
842 | 'finalize' the initialization.""" |
|
842 | 'finalize' the initialization.""" | |
843 |
|
843 | |||
844 | rc = self.rc |
|
844 | rc = self.rc | |
845 |
|
845 | |||
846 | # Object inspector |
|
846 | # Object inspector | |
847 | self.inspector = OInspect.Inspector(OInspect.InspectColors, |
|
847 | self.inspector = OInspect.Inspector(OInspect.InspectColors, | |
848 | PyColorize.ANSICodeColors, |
|
848 | PyColorize.ANSICodeColors, | |
849 | 'NoColor', |
|
849 | 'NoColor', | |
850 | rc.object_info_string_level) |
|
850 | rc.object_info_string_level) | |
851 |
|
851 | |||
852 | self.rl_next_input = None |
|
852 | self.rl_next_input = None | |
853 | self.rl_do_indent = False |
|
853 | self.rl_do_indent = False | |
854 | # Load readline proper |
|
854 | # Load readline proper | |
855 | if rc.readline: |
|
855 | if rc.readline: | |
856 | self.init_readline() |
|
856 | self.init_readline() | |
857 |
|
857 | |||
858 | # local shortcut, this is used a LOT |
|
858 | # local shortcut, this is used a LOT | |
859 | self.log = self.logger.log |
|
859 | self.log = self.logger.log | |
860 |
|
860 | |||
861 | # Initialize cache, set in/out prompts and printing system |
|
861 | # Initialize cache, set in/out prompts and printing system | |
862 | self.outputcache = CachedOutput(self, |
|
862 | self.outputcache = CachedOutput(self, | |
863 | rc.cache_size, |
|
863 | rc.cache_size, | |
864 | rc.pprint, |
|
864 | rc.pprint, | |
865 | input_sep = rc.separate_in, |
|
865 | input_sep = rc.separate_in, | |
866 | output_sep = rc.separate_out, |
|
866 | output_sep = rc.separate_out, | |
867 | output_sep2 = rc.separate_out2, |
|
867 | output_sep2 = rc.separate_out2, | |
868 | ps1 = rc.prompt_in1, |
|
868 | ps1 = rc.prompt_in1, | |
869 | ps2 = rc.prompt_in2, |
|
869 | ps2 = rc.prompt_in2, | |
870 | ps_out = rc.prompt_out, |
|
870 | ps_out = rc.prompt_out, | |
871 | pad_left = rc.prompts_pad_left) |
|
871 | pad_left = rc.prompts_pad_left) | |
872 |
|
872 | |||
873 | # user may have over-ridden the default print hook: |
|
873 | # user may have over-ridden the default print hook: | |
874 | try: |
|
874 | try: | |
875 | self.outputcache.__class__.display = self.hooks.display |
|
875 | self.outputcache.__class__.display = self.hooks.display | |
876 | except AttributeError: |
|
876 | except AttributeError: | |
877 | pass |
|
877 | pass | |
878 |
|
878 | |||
879 | # I don't like assigning globally to sys, because it means when |
|
879 | # I don't like assigning globally to sys, because it means when | |
880 | # embedding instances, each embedded instance overrides the previous |
|
880 | # embedding instances, each embedded instance overrides the previous | |
881 | # choice. But sys.displayhook seems to be called internally by exec, |
|
881 | # choice. But sys.displayhook seems to be called internally by exec, | |
882 | # so I don't see a way around it. We first save the original and then |
|
882 | # so I don't see a way around it. We first save the original and then | |
883 | # overwrite it. |
|
883 | # overwrite it. | |
884 | self.sys_displayhook = sys.displayhook |
|
884 | self.sys_displayhook = sys.displayhook | |
885 | sys.displayhook = self.outputcache |
|
885 | sys.displayhook = self.outputcache | |
886 |
|
886 | |||
887 | # Do a proper resetting of doctest, including the necessary displayhook |
|
887 | # Do a proper resetting of doctest, including the necessary displayhook | |
888 | # monkeypatching |
|
888 | # monkeypatching | |
889 | try: |
|
889 | try: | |
890 | doctest_reload() |
|
890 | doctest_reload() | |
891 | except ImportError: |
|
891 | except ImportError: | |
892 | warn("doctest module does not exist.") |
|
892 | warn("doctest module does not exist.") | |
893 |
|
893 | |||
894 | # Set user colors (don't do it in the constructor above so that it |
|
894 | # Set user colors (don't do it in the constructor above so that it | |
895 | # doesn't crash if colors option is invalid) |
|
895 | # doesn't crash if colors option is invalid) | |
896 | self.magic_colors(rc.colors) |
|
896 | self.magic_colors(rc.colors) | |
897 |
|
897 | |||
898 | # Set calling of pdb on exceptions |
|
898 | # Set calling of pdb on exceptions | |
899 | self.call_pdb = rc.pdb |
|
899 | self.call_pdb = rc.pdb | |
900 |
|
900 | |||
901 | # Load user aliases |
|
901 | # Load user aliases | |
902 | for alias in rc.alias: |
|
902 | for alias in rc.alias: | |
903 | self.magic_alias(alias) |
|
903 | self.magic_alias(alias) | |
904 |
|
904 | |||
905 | self.hooks.late_startup_hook() |
|
905 | self.hooks.late_startup_hook() | |
906 |
|
906 | |||
907 | for cmd in self.rc.autoexec: |
|
907 | for cmd in self.rc.autoexec: | |
908 | #print "autoexec>",cmd #dbg |
|
908 | #print "autoexec>",cmd #dbg | |
909 | self.api.runlines(cmd) |
|
909 | self.api.runlines(cmd) | |
910 |
|
910 | |||
911 | batchrun = False |
|
911 | batchrun = False | |
912 | for batchfile in [path(arg) for arg in self.rc.args |
|
912 | for batchfile in [path(arg) for arg in self.rc.args | |
913 | if arg.lower().endswith('.ipy')]: |
|
913 | if arg.lower().endswith('.ipy')]: | |
914 | if not batchfile.isfile(): |
|
914 | if not batchfile.isfile(): | |
915 | print "No such batch file:", batchfile |
|
915 | print "No such batch file:", batchfile | |
916 | continue |
|
916 | continue | |
917 | self.api.runlines(batchfile.text()) |
|
917 | self.api.runlines(batchfile.text()) | |
918 | batchrun = True |
|
918 | batchrun = True | |
919 | # without -i option, exit after running the batch file |
|
919 | # without -i option, exit after running the batch file | |
920 | if batchrun and not self.rc.interact: |
|
920 | if batchrun and not self.rc.interact: | |
921 | self.ask_exit() |
|
921 | self.ask_exit() | |
922 |
|
922 | |||
923 | def init_namespaces(self): |
|
923 | def init_namespaces(self): | |
924 | """Initialize all user-visible namespaces to their minimum defaults. |
|
924 | """Initialize all user-visible namespaces to their minimum defaults. | |
925 |
|
925 | |||
926 | Certain history lists are also initialized here, as they effectively |
|
926 | Certain history lists are also initialized here, as they effectively | |
927 | act as user namespaces. |
|
927 | act as user namespaces. | |
928 |
|
928 | |||
929 | Note |
|
929 | Note | |
930 | ---- |
|
930 | ---- | |
931 | All data structures here are only filled in, they are NOT reset by this |
|
931 | All data structures here are only filled in, they are NOT reset by this | |
932 | method. If they were not empty before, data will simply be added to |
|
932 | method. If they were not empty before, data will simply be added to | |
933 | therm. |
|
933 | therm. | |
934 | """ |
|
934 | """ | |
935 | # The user namespace MUST have a pointer to the shell itself. |
|
935 | # The user namespace MUST have a pointer to the shell itself. | |
936 | self.user_ns[self.name] = self |
|
936 | self.user_ns[self.name] = self | |
937 |
|
937 | |||
938 | # Store the public api instance |
|
938 | # Store the public api instance | |
939 | self.user_ns['_ip'] = self.api |
|
939 | self.user_ns['_ip'] = self.api | |
940 |
|
940 | |||
941 | # make global variables for user access to the histories |
|
941 | # make global variables for user access to the histories | |
942 | self.user_ns['_ih'] = self.input_hist |
|
942 | self.user_ns['_ih'] = self.input_hist | |
943 | self.user_ns['_oh'] = self.output_hist |
|
943 | self.user_ns['_oh'] = self.output_hist | |
944 | self.user_ns['_dh'] = self.dir_hist |
|
944 | self.user_ns['_dh'] = self.dir_hist | |
945 |
|
945 | |||
946 | # user aliases to input and output histories |
|
946 | # user aliases to input and output histories | |
947 | self.user_ns['In'] = self.input_hist |
|
947 | self.user_ns['In'] = self.input_hist | |
948 | self.user_ns['Out'] = self.output_hist |
|
948 | self.user_ns['Out'] = self.output_hist | |
949 |
|
949 | |||
950 | self.user_ns['_sh'] = IPython.shadowns |
|
950 | self.user_ns['_sh'] = IPython.shadowns | |
951 |
|
951 | |||
952 | # Fill the history zero entry, user counter starts at 1 |
|
952 | # Fill the history zero entry, user counter starts at 1 | |
953 | self.input_hist.append('\n') |
|
953 | self.input_hist.append('\n') | |
954 | self.input_hist_raw.append('\n') |
|
954 | self.input_hist_raw.append('\n') | |
955 |
|
955 | |||
956 | def add_builtins(self): |
|
956 | def add_builtins(self): | |
957 | """Store ipython references into the builtin namespace. |
|
957 | """Store ipython references into the builtin namespace. | |
958 |
|
958 | |||
959 | Some parts of ipython operate via builtins injected here, which hold a |
|
959 | Some parts of ipython operate via builtins injected here, which hold a | |
960 | reference to IPython itself.""" |
|
960 | reference to IPython itself.""" | |
961 |
|
961 | |||
962 | # TODO: deprecate all of these, they are unsafe |
|
962 | # TODO: deprecate all of these, they are unsafe | |
963 | builtins_new = dict(__IPYTHON__ = self, |
|
963 | builtins_new = dict(__IPYTHON__ = self, | |
964 | ip_set_hook = self.set_hook, |
|
964 | ip_set_hook = self.set_hook, | |
965 | jobs = self.jobs, |
|
965 | jobs = self.jobs, | |
966 | ipmagic = wrap_deprecated(self.ipmagic,'_ip.magic()'), |
|
966 | ipmagic = wrap_deprecated(self.ipmagic,'_ip.magic()'), | |
967 | ipalias = wrap_deprecated(self.ipalias), |
|
967 | ipalias = wrap_deprecated(self.ipalias), | |
968 | ipsystem = wrap_deprecated(self.ipsystem,'_ip.system()'), |
|
968 | ipsystem = wrap_deprecated(self.ipsystem,'_ip.system()'), | |
969 | #_ip = self.api |
|
969 | #_ip = self.api | |
970 | ) |
|
970 | ) | |
971 | for biname,bival in builtins_new.items(): |
|
971 | for biname,bival in builtins_new.items(): | |
972 | try: |
|
972 | try: | |
973 | # store the orignal value so we can restore it |
|
973 | # store the orignal value so we can restore it | |
974 | self.builtins_added[biname] = __builtin__.__dict__[biname] |
|
974 | self.builtins_added[biname] = __builtin__.__dict__[biname] | |
975 | except KeyError: |
|
975 | except KeyError: | |
976 | # or mark that it wasn't defined, and we'll just delete it at |
|
976 | # or mark that it wasn't defined, and we'll just delete it at | |
977 | # cleanup |
|
977 | # cleanup | |
978 | self.builtins_added[biname] = Undefined |
|
978 | self.builtins_added[biname] = Undefined | |
979 | __builtin__.__dict__[biname] = bival |
|
979 | __builtin__.__dict__[biname] = bival | |
980 |
|
980 | |||
981 | # Keep in the builtins a flag for when IPython is active. We set it |
|
981 | # Keep in the builtins a flag for when IPython is active. We set it | |
982 | # with setdefault so that multiple nested IPythons don't clobber one |
|
982 | # with setdefault so that multiple nested IPythons don't clobber one | |
983 | # another. Each will increase its value by one upon being activated, |
|
983 | # another. Each will increase its value by one upon being activated, | |
984 | # which also gives us a way to determine the nesting level. |
|
984 | # which also gives us a way to determine the nesting level. | |
985 | __builtin__.__dict__.setdefault('__IPYTHON__active',0) |
|
985 | __builtin__.__dict__.setdefault('__IPYTHON__active',0) | |
986 |
|
986 | |||
987 | def clean_builtins(self): |
|
987 | def clean_builtins(self): | |
988 | """Remove any builtins which might have been added by add_builtins, or |
|
988 | """Remove any builtins which might have been added by add_builtins, or | |
989 | restore overwritten ones to their previous values.""" |
|
989 | restore overwritten ones to their previous values.""" | |
990 | for biname,bival in self.builtins_added.items(): |
|
990 | for biname,bival in self.builtins_added.items(): | |
991 | if bival is Undefined: |
|
991 | if bival is Undefined: | |
992 | del __builtin__.__dict__[biname] |
|
992 | del __builtin__.__dict__[biname] | |
993 | else: |
|
993 | else: | |
994 | __builtin__.__dict__[biname] = bival |
|
994 | __builtin__.__dict__[biname] = bival | |
995 | self.builtins_added.clear() |
|
995 | self.builtins_added.clear() | |
996 |
|
996 | |||
997 | def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None): |
|
997 | def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None): | |
998 | """set_hook(name,hook) -> sets an internal IPython hook. |
|
998 | """set_hook(name,hook) -> sets an internal IPython hook. | |
999 |
|
999 | |||
1000 | IPython exposes some of its internal API as user-modifiable hooks. By |
|
1000 | IPython exposes some of its internal API as user-modifiable hooks. By | |
1001 | adding your function to one of these hooks, you can modify IPython's |
|
1001 | adding your function to one of these hooks, you can modify IPython's | |
1002 | behavior to call at runtime your own routines.""" |
|
1002 | behavior to call at runtime your own routines.""" | |
1003 |
|
1003 | |||
1004 | # At some point in the future, this should validate the hook before it |
|
1004 | # At some point in the future, this should validate the hook before it | |
1005 | # accepts it. Probably at least check that the hook takes the number |
|
1005 | # accepts it. Probably at least check that the hook takes the number | |
1006 | # of args it's supposed to. |
|
1006 | # of args it's supposed to. | |
1007 |
|
1007 | |||
1008 | f = new.instancemethod(hook,self,self.__class__) |
|
1008 | f = new.instancemethod(hook,self,self.__class__) | |
1009 |
|
1009 | |||
1010 | # check if the hook is for strdispatcher first |
|
1010 | # check if the hook is for strdispatcher first | |
1011 | if str_key is not None: |
|
1011 | if str_key is not None: | |
1012 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
1012 | sdp = self.strdispatchers.get(name, StrDispatch()) | |
1013 | sdp.add_s(str_key, f, priority ) |
|
1013 | sdp.add_s(str_key, f, priority ) | |
1014 | self.strdispatchers[name] = sdp |
|
1014 | self.strdispatchers[name] = sdp | |
1015 | return |
|
1015 | return | |
1016 | if re_key is not None: |
|
1016 | if re_key is not None: | |
1017 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
1017 | sdp = self.strdispatchers.get(name, StrDispatch()) | |
1018 | sdp.add_re(re.compile(re_key), f, priority ) |
|
1018 | sdp.add_re(re.compile(re_key), f, priority ) | |
1019 | self.strdispatchers[name] = sdp |
|
1019 | self.strdispatchers[name] = sdp | |
1020 | return |
|
1020 | return | |
1021 |
|
1021 | |||
1022 | dp = getattr(self.hooks, name, None) |
|
1022 | dp = getattr(self.hooks, name, None) | |
1023 | if name not in IPython.core.hooks.__all__: |
|
1023 | if name not in IPython.core.hooks.__all__: | |
1024 | print "Warning! Hook '%s' is not one of %s" % (name, IPython.core.hooks.__all__ ) |
|
1024 | print "Warning! Hook '%s' is not one of %s" % (name, IPython.core.hooks.__all__ ) | |
1025 | if not dp: |
|
1025 | if not dp: | |
1026 | dp = IPython.core.hooks.CommandChainDispatcher() |
|
1026 | dp = IPython.core.hooks.CommandChainDispatcher() | |
1027 |
|
1027 | |||
1028 | try: |
|
1028 | try: | |
1029 | dp.add(f,priority) |
|
1029 | dp.add(f,priority) | |
1030 | except AttributeError: |
|
1030 | except AttributeError: | |
1031 | # it was not commandchain, plain old func - replace |
|
1031 | # it was not commandchain, plain old func - replace | |
1032 | dp = f |
|
1032 | dp = f | |
1033 |
|
1033 | |||
1034 | setattr(self.hooks,name, dp) |
|
1034 | setattr(self.hooks,name, dp) | |
1035 |
|
1035 | |||
1036 |
|
1036 | |||
1037 | #setattr(self.hooks,name,new.instancemethod(hook,self,self.__class__)) |
|
1037 | #setattr(self.hooks,name,new.instancemethod(hook,self,self.__class__)) | |
1038 |
|
1038 | |||
1039 | def set_crash_handler(self,crashHandler): |
|
1039 | def set_crash_handler(self,crashHandler): | |
1040 | """Set the IPython crash handler. |
|
1040 | """Set the IPython crash handler. | |
1041 |
|
1041 | |||
1042 | This must be a callable with a signature suitable for use as |
|
1042 | This must be a callable with a signature suitable for use as | |
1043 | sys.excepthook.""" |
|
1043 | sys.excepthook.""" | |
1044 |
|
1044 | |||
1045 | # Install the given crash handler as the Python exception hook |
|
1045 | # Install the given crash handler as the Python exception hook | |
1046 | sys.excepthook = crashHandler |
|
1046 | sys.excepthook = crashHandler | |
1047 |
|
1047 | |||
1048 | # The instance will store a pointer to this, so that runtime code |
|
1048 | # The instance will store a pointer to this, so that runtime code | |
1049 | # (such as magics) can access it. This is because during the |
|
1049 | # (such as magics) can access it. This is because during the | |
1050 | # read-eval loop, it gets temporarily overwritten (to deal with GUI |
|
1050 | # read-eval loop, it gets temporarily overwritten (to deal with GUI | |
1051 | # frameworks). |
|
1051 | # frameworks). | |
1052 | self.sys_excepthook = sys.excepthook |
|
1052 | self.sys_excepthook = sys.excepthook | |
1053 |
|
1053 | |||
1054 |
|
1054 | |||
1055 | def set_custom_exc(self,exc_tuple,handler): |
|
1055 | def set_custom_exc(self,exc_tuple,handler): | |
1056 | """set_custom_exc(exc_tuple,handler) |
|
1056 | """set_custom_exc(exc_tuple,handler) | |
1057 |
|
1057 | |||
1058 | Set a custom exception handler, which will be called if any of the |
|
1058 | Set a custom exception handler, which will be called if any of the | |
1059 | exceptions in exc_tuple occur in the mainloop (specifically, in the |
|
1059 | exceptions in exc_tuple occur in the mainloop (specifically, in the | |
1060 | runcode() method. |
|
1060 | runcode() method. | |
1061 |
|
1061 | |||
1062 | Inputs: |
|
1062 | Inputs: | |
1063 |
|
1063 | |||
1064 | - exc_tuple: a *tuple* of valid exceptions to call the defined |
|
1064 | - exc_tuple: a *tuple* of valid exceptions to call the defined | |
1065 | handler for. It is very important that you use a tuple, and NOT A |
|
1065 | handler for. It is very important that you use a tuple, and NOT A | |
1066 | LIST here, because of the way Python's except statement works. If |
|
1066 | LIST here, because of the way Python's except statement works. If | |
1067 | you only want to trap a single exception, use a singleton tuple: |
|
1067 | you only want to trap a single exception, use a singleton tuple: | |
1068 |
|
1068 | |||
1069 | exc_tuple == (MyCustomException,) |
|
1069 | exc_tuple == (MyCustomException,) | |
1070 |
|
1070 | |||
1071 | - handler: this must be defined as a function with the following |
|
1071 | - handler: this must be defined as a function with the following | |
1072 | basic interface: def my_handler(self,etype,value,tb). |
|
1072 | basic interface: def my_handler(self,etype,value,tb). | |
1073 |
|
1073 | |||
1074 | This will be made into an instance method (via new.instancemethod) |
|
1074 | This will be made into an instance method (via new.instancemethod) | |
1075 | of IPython itself, and it will be called if any of the exceptions |
|
1075 | of IPython itself, and it will be called if any of the exceptions | |
1076 | listed in the exc_tuple are caught. If the handler is None, an |
|
1076 | listed in the exc_tuple are caught. If the handler is None, an | |
1077 | internal basic one is used, which just prints basic info. |
|
1077 | internal basic one is used, which just prints basic info. | |
1078 |
|
1078 | |||
1079 | WARNING: by putting in your own exception handler into IPython's main |
|
1079 | WARNING: by putting in your own exception handler into IPython's main | |
1080 | execution loop, you run a very good chance of nasty crashes. This |
|
1080 | execution loop, you run a very good chance of nasty crashes. This | |
1081 | facility should only be used if you really know what you are doing.""" |
|
1081 | facility should only be used if you really know what you are doing.""" | |
1082 |
|
1082 | |||
1083 | assert type(exc_tuple)==type(()) , \ |
|
1083 | assert type(exc_tuple)==type(()) , \ | |
1084 | "The custom exceptions must be given AS A TUPLE." |
|
1084 | "The custom exceptions must be given AS A TUPLE." | |
1085 |
|
1085 | |||
1086 | def dummy_handler(self,etype,value,tb): |
|
1086 | def dummy_handler(self,etype,value,tb): | |
1087 | print '*** Simple custom exception handler ***' |
|
1087 | print '*** Simple custom exception handler ***' | |
1088 | print 'Exception type :',etype |
|
1088 | print 'Exception type :',etype | |
1089 | print 'Exception value:',value |
|
1089 | print 'Exception value:',value | |
1090 | print 'Traceback :',tb |
|
1090 | print 'Traceback :',tb | |
1091 | print 'Source code :','\n'.join(self.buffer) |
|
1091 | print 'Source code :','\n'.join(self.buffer) | |
1092 |
|
1092 | |||
1093 | if handler is None: handler = dummy_handler |
|
1093 | if handler is None: handler = dummy_handler | |
1094 |
|
1094 | |||
1095 | self.CustomTB = new.instancemethod(handler,self,self.__class__) |
|
1095 | self.CustomTB = new.instancemethod(handler,self,self.__class__) | |
1096 | self.custom_exceptions = exc_tuple |
|
1096 | self.custom_exceptions = exc_tuple | |
1097 |
|
1097 | |||
1098 | def set_custom_completer(self,completer,pos=0): |
|
1098 | def set_custom_completer(self,completer,pos=0): | |
1099 | """set_custom_completer(completer,pos=0) |
|
1099 | """set_custom_completer(completer,pos=0) | |
1100 |
|
1100 | |||
1101 | Adds a new custom completer function. |
|
1101 | Adds a new custom completer function. | |
1102 |
|
1102 | |||
1103 | The position argument (defaults to 0) is the index in the completers |
|
1103 | The position argument (defaults to 0) is the index in the completers | |
1104 | list where you want the completer to be inserted.""" |
|
1104 | list where you want the completer to be inserted.""" | |
1105 |
|
1105 | |||
1106 | newcomp = new.instancemethod(completer,self.Completer, |
|
1106 | newcomp = new.instancemethod(completer,self.Completer, | |
1107 | self.Completer.__class__) |
|
1107 | self.Completer.__class__) | |
1108 | self.Completer.matchers.insert(pos,newcomp) |
|
1108 | self.Completer.matchers.insert(pos,newcomp) | |
1109 |
|
1109 | |||
1110 | def set_completer(self): |
|
1110 | def set_completer(self): | |
1111 | """reset readline's completer to be our own.""" |
|
1111 | """reset readline's completer to be our own.""" | |
1112 | self.readline.set_completer(self.Completer.complete) |
|
1112 | self.readline.set_completer(self.Completer.complete) | |
1113 |
|
1113 | |||
1114 | def _get_call_pdb(self): |
|
1114 | def _get_call_pdb(self): | |
1115 | return self._call_pdb |
|
1115 | return self._call_pdb | |
1116 |
|
1116 | |||
1117 | def _set_call_pdb(self,val): |
|
1117 | def _set_call_pdb(self,val): | |
1118 |
|
1118 | |||
1119 | if val not in (0,1,False,True): |
|
1119 | if val not in (0,1,False,True): | |
1120 | raise ValueError,'new call_pdb value must be boolean' |
|
1120 | raise ValueError,'new call_pdb value must be boolean' | |
1121 |
|
1121 | |||
1122 | # store value in instance |
|
1122 | # store value in instance | |
1123 | self._call_pdb = val |
|
1123 | self._call_pdb = val | |
1124 |
|
1124 | |||
1125 | # notify the actual exception handlers |
|
1125 | # notify the actual exception handlers | |
1126 | self.InteractiveTB.call_pdb = val |
|
1126 | self.InteractiveTB.call_pdb = val | |
1127 | if self.isthreaded: |
|
1127 | if self.isthreaded: | |
1128 | try: |
|
1128 | try: | |
1129 | self.sys_excepthook.call_pdb = val |
|
1129 | self.sys_excepthook.call_pdb = val | |
1130 | except: |
|
1130 | except: | |
1131 | warn('Failed to activate pdb for threaded exception handler') |
|
1131 | warn('Failed to activate pdb for threaded exception handler') | |
1132 |
|
1132 | |||
1133 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, |
|
1133 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, | |
1134 | 'Control auto-activation of pdb at exceptions') |
|
1134 | 'Control auto-activation of pdb at exceptions') | |
1135 |
|
1135 | |||
1136 | # These special functions get installed in the builtin namespace, to |
|
1136 | # These special functions get installed in the builtin namespace, to | |
1137 | # provide programmatic (pure python) access to magics, aliases and system |
|
1137 | # provide programmatic (pure python) access to magics, aliases and system | |
1138 | # calls. This is important for logging, user scripting, and more. |
|
1138 | # calls. This is important for logging, user scripting, and more. | |
1139 |
|
1139 | |||
1140 | # We are basically exposing, via normal python functions, the three |
|
1140 | # We are basically exposing, via normal python functions, the three | |
1141 | # mechanisms in which ipython offers special call modes (magics for |
|
1141 | # mechanisms in which ipython offers special call modes (magics for | |
1142 | # internal control, aliases for direct system access via pre-selected |
|
1142 | # internal control, aliases for direct system access via pre-selected | |
1143 | # names, and !cmd for calling arbitrary system commands). |
|
1143 | # names, and !cmd for calling arbitrary system commands). | |
1144 |
|
1144 | |||
1145 | def ipmagic(self,arg_s): |
|
1145 | def ipmagic(self,arg_s): | |
1146 | """Call a magic function by name. |
|
1146 | """Call a magic function by name. | |
1147 |
|
1147 | |||
1148 | Input: a string containing the name of the magic function to call and any |
|
1148 | Input: a string containing the name of the magic function to call and any | |
1149 | additional arguments to be passed to the magic. |
|
1149 | additional arguments to be passed to the magic. | |
1150 |
|
1150 | |||
1151 | ipmagic('name -opt foo bar') is equivalent to typing at the ipython |
|
1151 | ipmagic('name -opt foo bar') is equivalent to typing at the ipython | |
1152 | prompt: |
|
1152 | prompt: | |
1153 |
|
1153 | |||
1154 | In[1]: %name -opt foo bar |
|
1154 | In[1]: %name -opt foo bar | |
1155 |
|
1155 | |||
1156 | To call a magic without arguments, simply use ipmagic('name'). |
|
1156 | To call a magic without arguments, simply use ipmagic('name'). | |
1157 |
|
1157 | |||
1158 | This provides a proper Python function to call IPython's magics in any |
|
1158 | This provides a proper Python function to call IPython's magics in any | |
1159 | valid Python code you can type at the interpreter, including loops and |
|
1159 | valid Python code you can type at the interpreter, including loops and | |
1160 | compound statements. It is added by IPython to the Python builtin |
|
1160 | compound statements. It is added by IPython to the Python builtin | |
1161 | namespace upon initialization.""" |
|
1161 | namespace upon initialization.""" | |
1162 |
|
1162 | |||
1163 | args = arg_s.split(' ',1) |
|
1163 | args = arg_s.split(' ',1) | |
1164 | magic_name = args[0] |
|
1164 | magic_name = args[0] | |
1165 | magic_name = magic_name.lstrip(self.ESC_MAGIC) |
|
1165 | magic_name = magic_name.lstrip(self.ESC_MAGIC) | |
1166 |
|
1166 | |||
1167 | try: |
|
1167 | try: | |
1168 | magic_args = args[1] |
|
1168 | magic_args = args[1] | |
1169 | except IndexError: |
|
1169 | except IndexError: | |
1170 | magic_args = '' |
|
1170 | magic_args = '' | |
1171 | fn = getattr(self,'magic_'+magic_name,None) |
|
1171 | fn = getattr(self,'magic_'+magic_name,None) | |
1172 | if fn is None: |
|
1172 | if fn is None: | |
1173 | error("Magic function `%s` not found." % magic_name) |
|
1173 | error("Magic function `%s` not found." % magic_name) | |
1174 | else: |
|
1174 | else: | |
1175 | magic_args = self.var_expand(magic_args,1) |
|
1175 | magic_args = self.var_expand(magic_args,1) | |
1176 | return fn(magic_args) |
|
1176 | return fn(magic_args) | |
1177 |
|
1177 | |||
1178 | def ipalias(self,arg_s): |
|
1178 | def ipalias(self,arg_s): | |
1179 | """Call an alias by name. |
|
1179 | """Call an alias by name. | |
1180 |
|
1180 | |||
1181 | Input: a string containing the name of the alias to call and any |
|
1181 | Input: a string containing the name of the alias to call and any | |
1182 | additional arguments to be passed to the magic. |
|
1182 | additional arguments to be passed to the magic. | |
1183 |
|
1183 | |||
1184 | ipalias('name -opt foo bar') is equivalent to typing at the ipython |
|
1184 | ipalias('name -opt foo bar') is equivalent to typing at the ipython | |
1185 | prompt: |
|
1185 | prompt: | |
1186 |
|
1186 | |||
1187 | In[1]: name -opt foo bar |
|
1187 | In[1]: name -opt foo bar | |
1188 |
|
1188 | |||
1189 | To call an alias without arguments, simply use ipalias('name'). |
|
1189 | To call an alias without arguments, simply use ipalias('name'). | |
1190 |
|
1190 | |||
1191 | This provides a proper Python function to call IPython's aliases in any |
|
1191 | This provides a proper Python function to call IPython's aliases in any | |
1192 | valid Python code you can type at the interpreter, including loops and |
|
1192 | valid Python code you can type at the interpreter, including loops and | |
1193 | compound statements. It is added by IPython to the Python builtin |
|
1193 | compound statements. It is added by IPython to the Python builtin | |
1194 | namespace upon initialization.""" |
|
1194 | namespace upon initialization.""" | |
1195 |
|
1195 | |||
1196 | args = arg_s.split(' ',1) |
|
1196 | args = arg_s.split(' ',1) | |
1197 | alias_name = args[0] |
|
1197 | alias_name = args[0] | |
1198 | try: |
|
1198 | try: | |
1199 | alias_args = args[1] |
|
1199 | alias_args = args[1] | |
1200 | except IndexError: |
|
1200 | except IndexError: | |
1201 | alias_args = '' |
|
1201 | alias_args = '' | |
1202 | if alias_name in self.alias_table: |
|
1202 | if alias_name in self.alias_table: | |
1203 | self.call_alias(alias_name,alias_args) |
|
1203 | self.call_alias(alias_name,alias_args) | |
1204 | else: |
|
1204 | else: | |
1205 | error("Alias `%s` not found." % alias_name) |
|
1205 | error("Alias `%s` not found." % alias_name) | |
1206 |
|
1206 | |||
1207 | def ipsystem(self,arg_s): |
|
1207 | def ipsystem(self,arg_s): | |
1208 | """Make a system call, using IPython.""" |
|
1208 | """Make a system call, using IPython.""" | |
1209 |
|
1209 | |||
1210 | self.system(arg_s) |
|
1210 | self.system(arg_s) | |
1211 |
|
1211 | |||
1212 | def complete(self,text): |
|
1212 | def complete(self,text): | |
1213 | """Return a sorted list of all possible completions on text. |
|
1213 | """Return a sorted list of all possible completions on text. | |
1214 |
|
1214 | |||
1215 | Inputs: |
|
1215 | Inputs: | |
1216 |
|
1216 | |||
1217 | - text: a string of text to be completed on. |
|
1217 | - text: a string of text to be completed on. | |
1218 |
|
1218 | |||
1219 | This is a wrapper around the completion mechanism, similar to what |
|
1219 | This is a wrapper around the completion mechanism, similar to what | |
1220 | readline does at the command line when the TAB key is hit. By |
|
1220 | readline does at the command line when the TAB key is hit. By | |
1221 | exposing it as a method, it can be used by other non-readline |
|
1221 | exposing it as a method, it can be used by other non-readline | |
1222 | environments (such as GUIs) for text completion. |
|
1222 | environments (such as GUIs) for text completion. | |
1223 |
|
1223 | |||
1224 | Simple usage example: |
|
1224 | Simple usage example: | |
1225 |
|
1225 | |||
1226 | In [7]: x = 'hello' |
|
1226 | In [7]: x = 'hello' | |
1227 |
|
1227 | |||
1228 | In [8]: x |
|
1228 | In [8]: x | |
1229 | Out[8]: 'hello' |
|
1229 | Out[8]: 'hello' | |
1230 |
|
1230 | |||
1231 | In [9]: print x |
|
1231 | In [9]: print x | |
1232 | hello |
|
1232 | hello | |
1233 |
|
1233 | |||
1234 | In [10]: _ip.IP.complete('x.l') |
|
1234 | In [10]: _ip.IP.complete('x.l') | |
1235 | Out[10]: ['x.ljust', 'x.lower', 'x.lstrip'] |
|
1235 | Out[10]: ['x.ljust', 'x.lower', 'x.lstrip'] | |
1236 | """ |
|
1236 | """ | |
1237 |
|
1237 | |||
1238 | complete = self.Completer.complete |
|
1238 | complete = self.Completer.complete | |
1239 | state = 0 |
|
1239 | state = 0 | |
1240 | # use a dict so we get unique keys, since ipyhton's multiple |
|
1240 | # use a dict so we get unique keys, since ipyhton's multiple | |
1241 | # completers can return duplicates. When we make 2.4 a requirement, |
|
1241 | # completers can return duplicates. When we make 2.4 a requirement, | |
1242 | # start using sets instead, which are faster. |
|
1242 | # start using sets instead, which are faster. | |
1243 | comps = {} |
|
1243 | comps = {} | |
1244 | while True: |
|
1244 | while True: | |
1245 | newcomp = complete(text,state,line_buffer=text) |
|
1245 | newcomp = complete(text,state,line_buffer=text) | |
1246 | if newcomp is None: |
|
1246 | if newcomp is None: | |
1247 | break |
|
1247 | break | |
1248 | comps[newcomp] = 1 |
|
1248 | comps[newcomp] = 1 | |
1249 | state += 1 |
|
1249 | state += 1 | |
1250 | outcomps = comps.keys() |
|
1250 | outcomps = comps.keys() | |
1251 | outcomps.sort() |
|
1251 | outcomps.sort() | |
1252 | #print "T:",text,"OC:",outcomps # dbg |
|
1252 | #print "T:",text,"OC:",outcomps # dbg | |
1253 | #print "vars:",self.user_ns.keys() |
|
1253 | #print "vars:",self.user_ns.keys() | |
1254 | return outcomps |
|
1254 | return outcomps | |
1255 |
|
1255 | |||
1256 | def set_completer_frame(self, frame=None): |
|
1256 | def set_completer_frame(self, frame=None): | |
1257 | if frame: |
|
1257 | if frame: | |
1258 | self.Completer.namespace = frame.f_locals |
|
1258 | self.Completer.namespace = frame.f_locals | |
1259 | self.Completer.global_namespace = frame.f_globals |
|
1259 | self.Completer.global_namespace = frame.f_globals | |
1260 | else: |
|
1260 | else: | |
1261 | self.Completer.namespace = self.user_ns |
|
1261 | self.Completer.namespace = self.user_ns | |
1262 | self.Completer.global_namespace = self.user_global_ns |
|
1262 | self.Completer.global_namespace = self.user_global_ns | |
1263 |
|
1263 | |||
1264 | def init_auto_alias(self): |
|
1264 | def init_auto_alias(self): | |
1265 | """Define some aliases automatically. |
|
1265 | """Define some aliases automatically. | |
1266 |
|
1266 | |||
1267 | These are ALL parameter-less aliases""" |
|
1267 | These are ALL parameter-less aliases""" | |
1268 |
|
1268 | |||
1269 | for alias,cmd in self.auto_alias: |
|
1269 | for alias,cmd in self.auto_alias: | |
1270 | self.getapi().defalias(alias,cmd) |
|
1270 | self.getapi().defalias(alias,cmd) | |
1271 |
|
1271 | |||
1272 |
|
1272 | |||
1273 | def alias_table_validate(self,verbose=0): |
|
1273 | def alias_table_validate(self,verbose=0): | |
1274 | """Update information about the alias table. |
|
1274 | """Update information about the alias table. | |
1275 |
|
1275 | |||
1276 | In particular, make sure no Python keywords/builtins are in it.""" |
|
1276 | In particular, make sure no Python keywords/builtins are in it.""" | |
1277 |
|
1277 | |||
1278 | no_alias = self.no_alias |
|
1278 | no_alias = self.no_alias | |
1279 | for k in self.alias_table.keys(): |
|
1279 | for k in self.alias_table.keys(): | |
1280 | if k in no_alias: |
|
1280 | if k in no_alias: | |
1281 | del self.alias_table[k] |
|
1281 | del self.alias_table[k] | |
1282 | if verbose: |
|
1282 | if verbose: | |
1283 | print ("Deleting alias <%s>, it's a Python " |
|
1283 | print ("Deleting alias <%s>, it's a Python " | |
1284 | "keyword or builtin." % k) |
|
1284 | "keyword or builtin." % k) | |
1285 |
|
1285 | |||
1286 | def set_autoindent(self,value=None): |
|
1286 | def set_autoindent(self,value=None): | |
1287 | """Set the autoindent flag, checking for readline support. |
|
1287 | """Set the autoindent flag, checking for readline support. | |
1288 |
|
1288 | |||
1289 | If called with no arguments, it acts as a toggle.""" |
|
1289 | If called with no arguments, it acts as a toggle.""" | |
1290 |
|
1290 | |||
1291 | if not self.has_readline: |
|
1291 | if not self.has_readline: | |
1292 | if os.name == 'posix': |
|
1292 | if os.name == 'posix': | |
1293 | warn("The auto-indent feature requires the readline library") |
|
1293 | warn("The auto-indent feature requires the readline library") | |
1294 | self.autoindent = 0 |
|
1294 | self.autoindent = 0 | |
1295 | return |
|
1295 | return | |
1296 | if value is None: |
|
1296 | if value is None: | |
1297 | self.autoindent = not self.autoindent |
|
1297 | self.autoindent = not self.autoindent | |
1298 | else: |
|
1298 | else: | |
1299 | self.autoindent = value |
|
1299 | self.autoindent = value | |
1300 |
|
1300 | |||
1301 | def rc_set_toggle(self,rc_field,value=None): |
|
1301 | def rc_set_toggle(self,rc_field,value=None): | |
1302 | """Set or toggle a field in IPython's rc config. structure. |
|
1302 | """Set or toggle a field in IPython's rc config. structure. | |
1303 |
|
1303 | |||
1304 | If called with no arguments, it acts as a toggle. |
|
1304 | If called with no arguments, it acts as a toggle. | |
1305 |
|
1305 | |||
1306 | If called with a non-existent field, the resulting AttributeError |
|
1306 | If called with a non-existent field, the resulting AttributeError | |
1307 | exception will propagate out.""" |
|
1307 | exception will propagate out.""" | |
1308 |
|
1308 | |||
1309 | rc_val = getattr(self.rc,rc_field) |
|
1309 | rc_val = getattr(self.rc,rc_field) | |
1310 | if value is None: |
|
1310 | if value is None: | |
1311 | value = not rc_val |
|
1311 | value = not rc_val | |
1312 | setattr(self.rc,rc_field,value) |
|
1312 | setattr(self.rc,rc_field,value) | |
1313 |
|
1313 | |||
1314 | def user_setup(self,ipythondir,rc_suffix,mode='install'): |
|
1314 | def user_setup(self,ipythondir,rc_suffix,mode='install'): | |
1315 | """Install the user configuration directory. |
|
1315 | """Install the user configuration directory. | |
1316 |
|
1316 | |||
1317 | Note |
|
1317 | Note | |
1318 | ---- |
|
1318 | ---- | |
1319 | DEPRECATED: use the top-level user_setup() function instead. |
|
1319 | DEPRECATED: use the top-level user_setup() function instead. | |
1320 | """ |
|
1320 | """ | |
1321 | return user_setup(ipythondir,rc_suffix,mode) |
|
1321 | return user_setup(ipythondir,rc_suffix,mode) | |
1322 |
|
1322 | |||
1323 | def atexit_operations(self): |
|
1323 | def atexit_operations(self): | |
1324 | """This will be executed at the time of exit. |
|
1324 | """This will be executed at the time of exit. | |
1325 |
|
1325 | |||
1326 | Saving of persistent data should be performed here. """ |
|
1326 | Saving of persistent data should be performed here. """ | |
1327 |
|
1327 | |||
1328 | #print '*** IPython exit cleanup ***' # dbg |
|
1328 | #print '*** IPython exit cleanup ***' # dbg | |
1329 | # input history |
|
1329 | # input history | |
1330 | self.savehist() |
|
1330 | self.savehist() | |
1331 |
|
1331 | |||
1332 | # Cleanup all tempfiles left around |
|
1332 | # Cleanup all tempfiles left around | |
1333 | for tfile in self.tempfiles: |
|
1333 | for tfile in self.tempfiles: | |
1334 | try: |
|
1334 | try: | |
1335 | os.unlink(tfile) |
|
1335 | os.unlink(tfile) | |
1336 | except OSError: |
|
1336 | except OSError: | |
1337 | pass |
|
1337 | pass | |
1338 |
|
1338 | |||
1339 | # Clear all user namespaces to release all references cleanly. |
|
1339 | # Clear all user namespaces to release all references cleanly. | |
1340 | self.reset() |
|
1340 | self.reset() | |
1341 |
|
1341 | |||
1342 | # Run user hooks |
|
1342 | # Run user hooks | |
1343 | self.hooks.shutdown_hook() |
|
1343 | self.hooks.shutdown_hook() | |
1344 |
|
1344 | |||
1345 | def reset(self): |
|
1345 | def reset(self): | |
1346 | """Clear all internal namespaces. |
|
1346 | """Clear all internal namespaces. | |
1347 |
|
1347 | |||
1348 | Note that this is much more aggressive than %reset, since it clears |
|
1348 | Note that this is much more aggressive than %reset, since it clears | |
1349 | fully all namespaces, as well as all input/output lists. |
|
1349 | fully all namespaces, as well as all input/output lists. | |
1350 | """ |
|
1350 | """ | |
1351 | for ns in self.ns_refs_table: |
|
1351 | for ns in self.ns_refs_table: | |
1352 | ns.clear() |
|
1352 | ns.clear() | |
1353 |
|
1353 | |||
1354 | # Clear input and output histories |
|
1354 | # Clear input and output histories | |
1355 | self.input_hist[:] = [] |
|
1355 | self.input_hist[:] = [] | |
1356 | self.input_hist_raw[:] = [] |
|
1356 | self.input_hist_raw[:] = [] | |
1357 | self.output_hist.clear() |
|
1357 | self.output_hist.clear() | |
1358 | # Restore the user namespaces to minimal usability |
|
1358 | # Restore the user namespaces to minimal usability | |
1359 | self.init_namespaces() |
|
1359 | self.init_namespaces() | |
1360 |
|
1360 | |||
1361 | def savehist(self): |
|
1361 | def savehist(self): | |
1362 | """Save input history to a file (via readline library).""" |
|
1362 | """Save input history to a file (via readline library).""" | |
1363 |
|
1363 | |||
1364 | if not self.has_readline: |
|
1364 | if not self.has_readline: | |
1365 | return |
|
1365 | return | |
1366 |
|
1366 | |||
1367 | try: |
|
1367 | try: | |
1368 | self.readline.write_history_file(self.histfile) |
|
1368 | self.readline.write_history_file(self.histfile) | |
1369 | except: |
|
1369 | except: | |
1370 | print 'Unable to save IPython command history to file: ' + \ |
|
1370 | print 'Unable to save IPython command history to file: ' + \ | |
1371 | `self.histfile` |
|
1371 | `self.histfile` | |
1372 |
|
1372 | |||
1373 | def reloadhist(self): |
|
1373 | def reloadhist(self): | |
1374 | """Reload the input history from disk file.""" |
|
1374 | """Reload the input history from disk file.""" | |
1375 |
|
1375 | |||
1376 | if self.has_readline: |
|
1376 | if self.has_readline: | |
1377 | try: |
|
1377 | try: | |
1378 | self.readline.clear_history() |
|
1378 | self.readline.clear_history() | |
1379 | self.readline.read_history_file(self.shell.histfile) |
|
1379 | self.readline.read_history_file(self.shell.histfile) | |
1380 | except AttributeError: |
|
1380 | except AttributeError: | |
1381 | pass |
|
1381 | pass | |
1382 |
|
1382 | |||
1383 |
|
1383 | |||
1384 | def history_saving_wrapper(self, func): |
|
1384 | def history_saving_wrapper(self, func): | |
1385 | """ Wrap func for readline history saving |
|
1385 | """ Wrap func for readline history saving | |
1386 |
|
1386 | |||
1387 | Convert func into callable that saves & restores |
|
1387 | Convert func into callable that saves & restores | |
1388 | history around the call """ |
|
1388 | history around the call """ | |
1389 |
|
1389 | |||
1390 | if not self.has_readline: |
|
1390 | if not self.has_readline: | |
1391 | return func |
|
1391 | return func | |
1392 |
|
1392 | |||
1393 | def wrapper(): |
|
1393 | def wrapper(): | |
1394 | self.savehist() |
|
1394 | self.savehist() | |
1395 | try: |
|
1395 | try: | |
1396 | func() |
|
1396 | func() | |
1397 | finally: |
|
1397 | finally: | |
1398 | readline.read_history_file(self.histfile) |
|
1398 | readline.read_history_file(self.histfile) | |
1399 | return wrapper |
|
1399 | return wrapper | |
1400 |
|
1400 | |||
1401 | def pre_readline(self): |
|
1401 | def pre_readline(self): | |
1402 | """readline hook to be used at the start of each line. |
|
1402 | """readline hook to be used at the start of each line. | |
1403 |
|
1403 | |||
1404 | Currently it handles auto-indent only.""" |
|
1404 | Currently it handles auto-indent only.""" | |
1405 |
|
1405 | |||
1406 | #debugx('self.indent_current_nsp','pre_readline:') |
|
1406 | #debugx('self.indent_current_nsp','pre_readline:') | |
1407 |
|
1407 | |||
1408 | if self.rl_do_indent: |
|
1408 | if self.rl_do_indent: | |
1409 | self.readline.insert_text(self.indent_current_str()) |
|
1409 | self.readline.insert_text(self.indent_current_str()) | |
1410 | if self.rl_next_input is not None: |
|
1410 | if self.rl_next_input is not None: | |
1411 | self.readline.insert_text(self.rl_next_input) |
|
1411 | self.readline.insert_text(self.rl_next_input) | |
1412 | self.rl_next_input = None |
|
1412 | self.rl_next_input = None | |
1413 |
|
1413 | |||
1414 | def init_readline(self): |
|
1414 | def init_readline(self): | |
1415 | """Command history completion/saving/reloading.""" |
|
1415 | """Command history completion/saving/reloading.""" | |
1416 |
|
1416 | |||
1417 |
|
1417 | |||
1418 | import IPython.rlineimpl as readline |
|
1418 | import IPython.rlineimpl as readline | |
1419 |
|
1419 | |||
1420 | if not readline.have_readline: |
|
1420 | if not readline.have_readline: | |
1421 | self.has_readline = 0 |
|
1421 | self.has_readline = 0 | |
1422 | self.readline = None |
|
1422 | self.readline = None | |
1423 | # no point in bugging windows users with this every time: |
|
1423 | # no point in bugging windows users with this every time: | |
1424 | warn('Readline services not available on this platform.') |
|
1424 | warn('Readline services not available on this platform.') | |
1425 | else: |
|
1425 | else: | |
1426 | sys.modules['readline'] = readline |
|
1426 | sys.modules['readline'] = readline | |
1427 | import atexit |
|
1427 | import atexit | |
1428 | from IPython.core.completer import IPCompleter |
|
1428 | from IPython.core.completer import IPCompleter | |
1429 | self.Completer = IPCompleter(self, |
|
1429 | self.Completer = IPCompleter(self, | |
1430 | self.user_ns, |
|
1430 | self.user_ns, | |
1431 | self.user_global_ns, |
|
1431 | self.user_global_ns, | |
1432 | self.rc.readline_omit__names, |
|
1432 | self.rc.readline_omit__names, | |
1433 | self.alias_table) |
|
1433 | self.alias_table) | |
1434 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) |
|
1434 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) | |
1435 | self.strdispatchers['complete_command'] = sdisp |
|
1435 | self.strdispatchers['complete_command'] = sdisp | |
1436 | self.Completer.custom_completers = sdisp |
|
1436 | self.Completer.custom_completers = sdisp | |
1437 | # Platform-specific configuration |
|
1437 | # Platform-specific configuration | |
1438 | if os.name == 'nt': |
|
1438 | if os.name == 'nt': | |
1439 | self.readline_startup_hook = readline.set_pre_input_hook |
|
1439 | self.readline_startup_hook = readline.set_pre_input_hook | |
1440 | else: |
|
1440 | else: | |
1441 | self.readline_startup_hook = readline.set_startup_hook |
|
1441 | self.readline_startup_hook = readline.set_startup_hook | |
1442 |
|
1442 | |||
1443 | # Load user's initrc file (readline config) |
|
1443 | # Load user's initrc file (readline config) | |
1444 | # Or if libedit is used, load editrc. |
|
1444 | # Or if libedit is used, load editrc. | |
1445 | inputrc_name = os.environ.get('INPUTRC') |
|
1445 | inputrc_name = os.environ.get('INPUTRC') | |
1446 | if inputrc_name is None: |
|
1446 | if inputrc_name is None: | |
1447 | home_dir = get_home_dir() |
|
1447 | home_dir = get_home_dir() | |
1448 | if home_dir is not None: |
|
1448 | if home_dir is not None: | |
1449 | inputrc_name = '.inputrc' |
|
1449 | inputrc_name = '.inputrc' | |
1450 | if readline.uses_libedit: |
|
1450 | if readline.uses_libedit: | |
1451 | inputrc_name = '.editrc' |
|
1451 | inputrc_name = '.editrc' | |
1452 | inputrc_name = os.path.join(home_dir, inputrc_name) |
|
1452 | inputrc_name = os.path.join(home_dir, inputrc_name) | |
1453 | if os.path.isfile(inputrc_name): |
|
1453 | if os.path.isfile(inputrc_name): | |
1454 | try: |
|
1454 | try: | |
1455 | readline.read_init_file(inputrc_name) |
|
1455 | readline.read_init_file(inputrc_name) | |
1456 | except: |
|
1456 | except: | |
1457 | warn('Problems reading readline initialization file <%s>' |
|
1457 | warn('Problems reading readline initialization file <%s>' | |
1458 | % inputrc_name) |
|
1458 | % inputrc_name) | |
1459 |
|
1459 | |||
1460 | self.has_readline = 1 |
|
1460 | self.has_readline = 1 | |
1461 | self.readline = readline |
|
1461 | self.readline = readline | |
1462 | # save this in sys so embedded copies can restore it properly |
|
1462 | # save this in sys so embedded copies can restore it properly | |
1463 | sys.ipcompleter = self.Completer.complete |
|
1463 | sys.ipcompleter = self.Completer.complete | |
1464 | self.set_completer() |
|
1464 | self.set_completer() | |
1465 |
|
1465 | |||
1466 | # Configure readline according to user's prefs |
|
1466 | # Configure readline according to user's prefs | |
1467 | # This is only done if GNU readline is being used. If libedit |
|
1467 | # This is only done if GNU readline is being used. If libedit | |
1468 | # is being used (as on Leopard) the readline config is |
|
1468 | # is being used (as on Leopard) the readline config is | |
1469 | # not run as the syntax for libedit is different. |
|
1469 | # not run as the syntax for libedit is different. | |
1470 | if not readline.uses_libedit: |
|
1470 | if not readline.uses_libedit: | |
1471 | for rlcommand in self.rc.readline_parse_and_bind: |
|
1471 | for rlcommand in self.rc.readline_parse_and_bind: | |
1472 | #print "loading rl:",rlcommand # dbg |
|
1472 | #print "loading rl:",rlcommand # dbg | |
1473 | readline.parse_and_bind(rlcommand) |
|
1473 | readline.parse_and_bind(rlcommand) | |
1474 |
|
1474 | |||
1475 | # Remove some chars from the delimiters list. If we encounter |
|
1475 | # Remove some chars from the delimiters list. If we encounter | |
1476 | # unicode chars, discard them. |
|
1476 | # unicode chars, discard them. | |
1477 | delims = readline.get_completer_delims().encode("ascii", "ignore") |
|
1477 | delims = readline.get_completer_delims().encode("ascii", "ignore") | |
1478 | delims = delims.translate(string._idmap, |
|
1478 | delims = delims.translate(string._idmap, | |
1479 | self.rc.readline_remove_delims) |
|
1479 | self.rc.readline_remove_delims) | |
1480 | readline.set_completer_delims(delims) |
|
1480 | readline.set_completer_delims(delims) | |
1481 | # otherwise we end up with a monster history after a while: |
|
1481 | # otherwise we end up with a monster history after a while: | |
1482 | readline.set_history_length(1000) |
|
1482 | readline.set_history_length(1000) | |
1483 | try: |
|
1483 | try: | |
1484 | #print '*** Reading readline history' # dbg |
|
1484 | #print '*** Reading readline history' # dbg | |
1485 | readline.read_history_file(self.histfile) |
|
1485 | readline.read_history_file(self.histfile) | |
1486 | except IOError: |
|
1486 | except IOError: | |
1487 | pass # It doesn't exist yet. |
|
1487 | pass # It doesn't exist yet. | |
1488 |
|
1488 | |||
1489 | atexit.register(self.atexit_operations) |
|
1489 | atexit.register(self.atexit_operations) | |
1490 | del atexit |
|
1490 | del atexit | |
1491 |
|
1491 | |||
1492 | # Configure auto-indent for all platforms |
|
1492 | # Configure auto-indent for all platforms | |
1493 | self.set_autoindent(self.rc.autoindent) |
|
1493 | self.set_autoindent(self.rc.autoindent) | |
1494 |
|
1494 | |||
1495 | def ask_yes_no(self,prompt,default=True): |
|
1495 | def ask_yes_no(self,prompt,default=True): | |
1496 | if self.rc.quiet: |
|
1496 | if self.rc.quiet: | |
1497 | return True |
|
1497 | return True | |
1498 | return ask_yes_no(prompt,default) |
|
1498 | return ask_yes_no(prompt,default) | |
1499 |
|
1499 | |||
1500 | def new_main_mod(self,ns=None): |
|
1500 | def new_main_mod(self,ns=None): | |
1501 | """Return a new 'main' module object for user code execution. |
|
1501 | """Return a new 'main' module object for user code execution. | |
1502 | """ |
|
1502 | """ | |
1503 | main_mod = self._user_main_module |
|
1503 | main_mod = self._user_main_module | |
1504 | init_fakemod_dict(main_mod,ns) |
|
1504 | init_fakemod_dict(main_mod,ns) | |
1505 | return main_mod |
|
1505 | return main_mod | |
1506 |
|
1506 | |||
1507 | def cache_main_mod(self,ns,fname): |
|
1507 | def cache_main_mod(self,ns,fname): | |
1508 | """Cache a main module's namespace. |
|
1508 | """Cache a main module's namespace. | |
1509 |
|
1509 | |||
1510 | When scripts are executed via %run, we must keep a reference to the |
|
1510 | When scripts are executed via %run, we must keep a reference to the | |
1511 | namespace of their __main__ module (a FakeModule instance) around so |
|
1511 | namespace of their __main__ module (a FakeModule instance) around so | |
1512 | that Python doesn't clear it, rendering objects defined therein |
|
1512 | that Python doesn't clear it, rendering objects defined therein | |
1513 | useless. |
|
1513 | useless. | |
1514 |
|
1514 | |||
1515 | This method keeps said reference in a private dict, keyed by the |
|
1515 | This method keeps said reference in a private dict, keyed by the | |
1516 | absolute path of the module object (which corresponds to the script |
|
1516 | absolute path of the module object (which corresponds to the script | |
1517 | path). This way, for multiple executions of the same script we only |
|
1517 | path). This way, for multiple executions of the same script we only | |
1518 | keep one copy of the namespace (the last one), thus preventing memory |
|
1518 | keep one copy of the namespace (the last one), thus preventing memory | |
1519 | leaks from old references while allowing the objects from the last |
|
1519 | leaks from old references while allowing the objects from the last | |
1520 | execution to be accessible. |
|
1520 | execution to be accessible. | |
1521 |
|
1521 | |||
1522 | Note: we can not allow the actual FakeModule instances to be deleted, |
|
1522 | Note: we can not allow the actual FakeModule instances to be deleted, | |
1523 | because of how Python tears down modules (it hard-sets all their |
|
1523 | because of how Python tears down modules (it hard-sets all their | |
1524 | references to None without regard for reference counts). This method |
|
1524 | references to None without regard for reference counts). This method | |
1525 | must therefore make a *copy* of the given namespace, to allow the |
|
1525 | must therefore make a *copy* of the given namespace, to allow the | |
1526 | original module's __dict__ to be cleared and reused. |
|
1526 | original module's __dict__ to be cleared and reused. | |
1527 |
|
1527 | |||
1528 |
|
1528 | |||
1529 | Parameters |
|
1529 | Parameters | |
1530 | ---------- |
|
1530 | ---------- | |
1531 | ns : a namespace (a dict, typically) |
|
1531 | ns : a namespace (a dict, typically) | |
1532 |
|
1532 | |||
1533 | fname : str |
|
1533 | fname : str | |
1534 | Filename associated with the namespace. |
|
1534 | Filename associated with the namespace. | |
1535 |
|
1535 | |||
1536 | Examples |
|
1536 | Examples | |
1537 | -------- |
|
1537 | -------- | |
1538 |
|
1538 | |||
1539 | In [10]: import IPython |
|
1539 | In [10]: import IPython | |
1540 |
|
1540 | |||
1541 | In [11]: _ip.IP.cache_main_mod(IPython.__dict__,IPython.__file__) |
|
1541 | In [11]: _ip.IP.cache_main_mod(IPython.__dict__,IPython.__file__) | |
1542 |
|
1542 | |||
1543 | In [12]: IPython.__file__ in _ip.IP._main_ns_cache |
|
1543 | In [12]: IPython.__file__ in _ip.IP._main_ns_cache | |
1544 | Out[12]: True |
|
1544 | Out[12]: True | |
1545 | """ |
|
1545 | """ | |
1546 | self._main_ns_cache[os.path.abspath(fname)] = ns.copy() |
|
1546 | self._main_ns_cache[os.path.abspath(fname)] = ns.copy() | |
1547 |
|
1547 | |||
1548 | def clear_main_mod_cache(self): |
|
1548 | def clear_main_mod_cache(self): | |
1549 | """Clear the cache of main modules. |
|
1549 | """Clear the cache of main modules. | |
1550 |
|
1550 | |||
1551 | Mainly for use by utilities like %reset. |
|
1551 | Mainly for use by utilities like %reset. | |
1552 |
|
1552 | |||
1553 | Examples |
|
1553 | Examples | |
1554 | -------- |
|
1554 | -------- | |
1555 |
|
1555 | |||
1556 | In [15]: import IPython |
|
1556 | In [15]: import IPython | |
1557 |
|
1557 | |||
1558 | In [16]: _ip.IP.cache_main_mod(IPython.__dict__,IPython.__file__) |
|
1558 | In [16]: _ip.IP.cache_main_mod(IPython.__dict__,IPython.__file__) | |
1559 |
|
1559 | |||
1560 | In [17]: len(_ip.IP._main_ns_cache) > 0 |
|
1560 | In [17]: len(_ip.IP._main_ns_cache) > 0 | |
1561 | Out[17]: True |
|
1561 | Out[17]: True | |
1562 |
|
1562 | |||
1563 | In [18]: _ip.IP.clear_main_mod_cache() |
|
1563 | In [18]: _ip.IP.clear_main_mod_cache() | |
1564 |
|
1564 | |||
1565 | In [19]: len(_ip.IP._main_ns_cache) == 0 |
|
1565 | In [19]: len(_ip.IP._main_ns_cache) == 0 | |
1566 | Out[19]: True |
|
1566 | Out[19]: True | |
1567 | """ |
|
1567 | """ | |
1568 | self._main_ns_cache.clear() |
|
1568 | self._main_ns_cache.clear() | |
1569 |
|
1569 | |||
1570 | def _should_recompile(self,e): |
|
1570 | def _should_recompile(self,e): | |
1571 | """Utility routine for edit_syntax_error""" |
|
1571 | """Utility routine for edit_syntax_error""" | |
1572 |
|
1572 | |||
1573 | if e.filename in ('<ipython console>','<input>','<string>', |
|
1573 | if e.filename in ('<ipython console>','<input>','<string>', | |
1574 | '<console>','<BackgroundJob compilation>', |
|
1574 | '<console>','<BackgroundJob compilation>', | |
1575 | None): |
|
1575 | None): | |
1576 |
|
1576 | |||
1577 | return False |
|
1577 | return False | |
1578 | try: |
|
1578 | try: | |
1579 | if (self.rc.autoedit_syntax and |
|
1579 | if (self.rc.autoedit_syntax and | |
1580 | not self.ask_yes_no('Return to editor to correct syntax error? ' |
|
1580 | not self.ask_yes_no('Return to editor to correct syntax error? ' | |
1581 | '[Y/n] ','y')): |
|
1581 | '[Y/n] ','y')): | |
1582 | return False |
|
1582 | return False | |
1583 | except EOFError: |
|
1583 | except EOFError: | |
1584 | return False |
|
1584 | return False | |
1585 |
|
1585 | |||
1586 | def int0(x): |
|
1586 | def int0(x): | |
1587 | try: |
|
1587 | try: | |
1588 | return int(x) |
|
1588 | return int(x) | |
1589 | except TypeError: |
|
1589 | except TypeError: | |
1590 | return 0 |
|
1590 | return 0 | |
1591 | # always pass integer line and offset values to editor hook |
|
1591 | # always pass integer line and offset values to editor hook | |
1592 | try: |
|
1592 | try: | |
1593 | self.hooks.fix_error_editor(e.filename, |
|
1593 | self.hooks.fix_error_editor(e.filename, | |
1594 | int0(e.lineno),int0(e.offset),e.msg) |
|
1594 | int0(e.lineno),int0(e.offset),e.msg) | |
1595 | except ipapi.TryNext: |
|
1595 | except ipapi.TryNext: | |
1596 | warn('Could not open editor') |
|
1596 | warn('Could not open editor') | |
1597 | return False |
|
1597 | return False | |
1598 | return True |
|
1598 | return True | |
1599 |
|
1599 | |||
1600 | def edit_syntax_error(self): |
|
1600 | def edit_syntax_error(self): | |
1601 | """The bottom half of the syntax error handler called in the main loop. |
|
1601 | """The bottom half of the syntax error handler called in the main loop. | |
1602 |
|
1602 | |||
1603 | Loop until syntax error is fixed or user cancels. |
|
1603 | Loop until syntax error is fixed or user cancels. | |
1604 | """ |
|
1604 | """ | |
1605 |
|
1605 | |||
1606 | while self.SyntaxTB.last_syntax_error: |
|
1606 | while self.SyntaxTB.last_syntax_error: | |
1607 | # copy and clear last_syntax_error |
|
1607 | # copy and clear last_syntax_error | |
1608 | err = self.SyntaxTB.clear_err_state() |
|
1608 | err = self.SyntaxTB.clear_err_state() | |
1609 | if not self._should_recompile(err): |
|
1609 | if not self._should_recompile(err): | |
1610 | return |
|
1610 | return | |
1611 | try: |
|
1611 | try: | |
1612 | # may set last_syntax_error again if a SyntaxError is raised |
|
1612 | # may set last_syntax_error again if a SyntaxError is raised | |
1613 | self.safe_execfile(err.filename,self.user_ns) |
|
1613 | self.safe_execfile(err.filename,self.user_ns) | |
1614 | except: |
|
1614 | except: | |
1615 | self.showtraceback() |
|
1615 | self.showtraceback() | |
1616 | else: |
|
1616 | else: | |
1617 | try: |
|
1617 | try: | |
1618 | f = file(err.filename) |
|
1618 | f = file(err.filename) | |
1619 | try: |
|
1619 | try: | |
1620 | sys.displayhook(f.read()) |
|
1620 | sys.displayhook(f.read()) | |
1621 | finally: |
|
1621 | finally: | |
1622 | f.close() |
|
1622 | f.close() | |
1623 | except: |
|
1623 | except: | |
1624 | self.showtraceback() |
|
1624 | self.showtraceback() | |
1625 |
|
1625 | |||
1626 | def showsyntaxerror(self, filename=None): |
|
1626 | def showsyntaxerror(self, filename=None): | |
1627 | """Display the syntax error that just occurred. |
|
1627 | """Display the syntax error that just occurred. | |
1628 |
|
1628 | |||
1629 | This doesn't display a stack trace because there isn't one. |
|
1629 | This doesn't display a stack trace because there isn't one. | |
1630 |
|
1630 | |||
1631 | If a filename is given, it is stuffed in the exception instead |
|
1631 | If a filename is given, it is stuffed in the exception instead | |
1632 | of what was there before (because Python's parser always uses |
|
1632 | of what was there before (because Python's parser always uses | |
1633 | "<string>" when reading from a string). |
|
1633 | "<string>" when reading from a string). | |
1634 | """ |
|
1634 | """ | |
1635 | etype, value, last_traceback = sys.exc_info() |
|
1635 | etype, value, last_traceback = sys.exc_info() | |
1636 |
|
1636 | |||
1637 | # See note about these variables in showtraceback() below |
|
1637 | # See note about these variables in showtraceback() below | |
1638 | sys.last_type = etype |
|
1638 | sys.last_type = etype | |
1639 | sys.last_value = value |
|
1639 | sys.last_value = value | |
1640 | sys.last_traceback = last_traceback |
|
1640 | sys.last_traceback = last_traceback | |
1641 |
|
1641 | |||
1642 | if filename and etype is SyntaxError: |
|
1642 | if filename and etype is SyntaxError: | |
1643 | # Work hard to stuff the correct filename in the exception |
|
1643 | # Work hard to stuff the correct filename in the exception | |
1644 | try: |
|
1644 | try: | |
1645 | msg, (dummy_filename, lineno, offset, line) = value |
|
1645 | msg, (dummy_filename, lineno, offset, line) = value | |
1646 | except: |
|
1646 | except: | |
1647 | # Not the format we expect; leave it alone |
|
1647 | # Not the format we expect; leave it alone | |
1648 | pass |
|
1648 | pass | |
1649 | else: |
|
1649 | else: | |
1650 | # Stuff in the right filename |
|
1650 | # Stuff in the right filename | |
1651 | try: |
|
1651 | try: | |
1652 | # Assume SyntaxError is a class exception |
|
1652 | # Assume SyntaxError is a class exception | |
1653 | value = SyntaxError(msg, (filename, lineno, offset, line)) |
|
1653 | value = SyntaxError(msg, (filename, lineno, offset, line)) | |
1654 | except: |
|
1654 | except: | |
1655 | # If that failed, assume SyntaxError is a string |
|
1655 | # If that failed, assume SyntaxError is a string | |
1656 | value = msg, (filename, lineno, offset, line) |
|
1656 | value = msg, (filename, lineno, offset, line) | |
1657 | self.SyntaxTB(etype,value,[]) |
|
1657 | self.SyntaxTB(etype,value,[]) | |
1658 |
|
1658 | |||
1659 | def debugger(self,force=False): |
|
1659 | def debugger(self,force=False): | |
1660 | """Call the pydb/pdb debugger. |
|
1660 | """Call the pydb/pdb debugger. | |
1661 |
|
1661 | |||
1662 | Keywords: |
|
1662 | Keywords: | |
1663 |
|
1663 | |||
1664 | - force(False): by default, this routine checks the instance call_pdb |
|
1664 | - force(False): by default, this routine checks the instance call_pdb | |
1665 | flag and does not actually invoke the debugger if the flag is false. |
|
1665 | flag and does not actually invoke the debugger if the flag is false. | |
1666 | The 'force' option forces the debugger to activate even if the flag |
|
1666 | The 'force' option forces the debugger to activate even if the flag | |
1667 | is false. |
|
1667 | is false. | |
1668 | """ |
|
1668 | """ | |
1669 |
|
1669 | |||
1670 | if not (force or self.call_pdb): |
|
1670 | if not (force or self.call_pdb): | |
1671 | return |
|
1671 | return | |
1672 |
|
1672 | |||
1673 | if not hasattr(sys,'last_traceback'): |
|
1673 | if not hasattr(sys,'last_traceback'): | |
1674 | error('No traceback has been produced, nothing to debug.') |
|
1674 | error('No traceback has been produced, nothing to debug.') | |
1675 | return |
|
1675 | return | |
1676 |
|
1676 | |||
1677 | # use pydb if available |
|
1677 | # use pydb if available | |
1678 | if debugger.has_pydb: |
|
1678 | if debugger.has_pydb: | |
1679 | from pydb import pm |
|
1679 | from pydb import pm | |
1680 | else: |
|
1680 | else: | |
1681 | # fallback to our internal debugger |
|
1681 | # fallback to our internal debugger | |
1682 | pm = lambda : self.InteractiveTB.debugger(force=True) |
|
1682 | pm = lambda : self.InteractiveTB.debugger(force=True) | |
1683 | self.history_saving_wrapper(pm)() |
|
1683 | self.history_saving_wrapper(pm)() | |
1684 |
|
1684 | |||
1685 | def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None): |
|
1685 | def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None): | |
1686 | """Display the exception that just occurred. |
|
1686 | """Display the exception that just occurred. | |
1687 |
|
1687 | |||
1688 | If nothing is known about the exception, this is the method which |
|
1688 | If nothing is known about the exception, this is the method which | |
1689 | should be used throughout the code for presenting user tracebacks, |
|
1689 | should be used throughout the code for presenting user tracebacks, | |
1690 | rather than directly invoking the InteractiveTB object. |
|
1690 | rather than directly invoking the InteractiveTB object. | |
1691 |
|
1691 | |||
1692 | A specific showsyntaxerror() also exists, but this method can take |
|
1692 | A specific showsyntaxerror() also exists, but this method can take | |
1693 | care of calling it if needed, so unless you are explicitly catching a |
|
1693 | care of calling it if needed, so unless you are explicitly catching a | |
1694 | SyntaxError exception, don't try to analyze the stack manually and |
|
1694 | SyntaxError exception, don't try to analyze the stack manually and | |
1695 | simply call this method.""" |
|
1695 | simply call this method.""" | |
1696 |
|
1696 | |||
1697 |
|
1697 | |||
1698 | # Though this won't be called by syntax errors in the input line, |
|
1698 | # Though this won't be called by syntax errors in the input line, | |
1699 | # there may be SyntaxError cases whith imported code. |
|
1699 | # there may be SyntaxError cases whith imported code. | |
1700 |
|
1700 | |||
1701 | try: |
|
1701 | try: | |
1702 | if exc_tuple is None: |
|
1702 | if exc_tuple is None: | |
1703 | etype, value, tb = sys.exc_info() |
|
1703 | etype, value, tb = sys.exc_info() | |
1704 | else: |
|
1704 | else: | |
1705 | etype, value, tb = exc_tuple |
|
1705 | etype, value, tb = exc_tuple | |
1706 |
|
1706 | |||
1707 | if etype is SyntaxError: |
|
1707 | if etype is SyntaxError: | |
1708 | self.showsyntaxerror(filename) |
|
1708 | self.showsyntaxerror(filename) | |
1709 | elif etype is ipapi.UsageError: |
|
1709 | elif etype is ipapi.UsageError: | |
1710 | print "UsageError:", value |
|
1710 | print "UsageError:", value | |
1711 | else: |
|
1711 | else: | |
1712 | # WARNING: these variables are somewhat deprecated and not |
|
1712 | # WARNING: these variables are somewhat deprecated and not | |
1713 | # necessarily safe to use in a threaded environment, but tools |
|
1713 | # necessarily safe to use in a threaded environment, but tools | |
1714 | # like pdb depend on their existence, so let's set them. If we |
|
1714 | # like pdb depend on their existence, so let's set them. If we | |
1715 | # find problems in the field, we'll need to revisit their use. |
|
1715 | # find problems in the field, we'll need to revisit their use. | |
1716 | sys.last_type = etype |
|
1716 | sys.last_type = etype | |
1717 | sys.last_value = value |
|
1717 | sys.last_value = value | |
1718 | sys.last_traceback = tb |
|
1718 | sys.last_traceback = tb | |
1719 |
|
1719 | |||
1720 | if etype in self.custom_exceptions: |
|
1720 | if etype in self.custom_exceptions: | |
1721 | self.CustomTB(etype,value,tb) |
|
1721 | self.CustomTB(etype,value,tb) | |
1722 | else: |
|
1722 | else: | |
1723 | self.InteractiveTB(etype,value,tb,tb_offset=tb_offset) |
|
1723 | self.InteractiveTB(etype,value,tb,tb_offset=tb_offset) | |
1724 | if self.InteractiveTB.call_pdb and self.has_readline: |
|
1724 | if self.InteractiveTB.call_pdb and self.has_readline: | |
1725 | # pdb mucks up readline, fix it back |
|
1725 | # pdb mucks up readline, fix it back | |
1726 | self.set_completer() |
|
1726 | self.set_completer() | |
1727 | except KeyboardInterrupt: |
|
1727 | except KeyboardInterrupt: | |
1728 | self.write("\nKeyboardInterrupt\n") |
|
1728 | self.write("\nKeyboardInterrupt\n") | |
1729 |
|
1729 | |||
1730 | def mainloop(self,banner=None): |
|
1730 | def mainloop(self,banner=None): | |
1731 | """Creates the local namespace and starts the mainloop. |
|
1731 | """Creates the local namespace and starts the mainloop. | |
1732 |
|
1732 | |||
1733 | If an optional banner argument is given, it will override the |
|
1733 | If an optional banner argument is given, it will override the | |
1734 | internally created default banner.""" |
|
1734 | internally created default banner.""" | |
1735 |
|
1735 | |||
1736 | if self.rc.c: # Emulate Python's -c option |
|
1736 | if self.rc.c: # Emulate Python's -c option | |
1737 | self.exec_init_cmd() |
|
1737 | self.exec_init_cmd() | |
1738 | if banner is None: |
|
1738 | if banner is None: | |
1739 | if not self.rc.banner: |
|
1739 | if not self.rc.banner: | |
1740 | banner = '' |
|
1740 | banner = '' | |
1741 | # banner is string? Use it directly! |
|
1741 | # banner is string? Use it directly! | |
1742 | elif isinstance(self.rc.banner,basestring): |
|
1742 | elif isinstance(self.rc.banner,basestring): | |
1743 | banner = self.rc.banner |
|
1743 | banner = self.rc.banner | |
1744 | else: |
|
1744 | else: | |
1745 | banner = self.BANNER+self.banner2 |
|
1745 | banner = self.BANNER+self.banner2 | |
1746 |
|
1746 | |||
1747 | # if you run stuff with -c <cmd>, raw hist is not updated |
|
1747 | # if you run stuff with -c <cmd>, raw hist is not updated | |
1748 | # ensure that it's in sync |
|
1748 | # ensure that it's in sync | |
1749 | if len(self.input_hist) != len (self.input_hist_raw): |
|
1749 | if len(self.input_hist) != len (self.input_hist_raw): | |
1750 | self.input_hist_raw = InputList(self.input_hist) |
|
1750 | self.input_hist_raw = InputList(self.input_hist) | |
1751 |
|
1751 | |||
1752 | while 1: |
|
1752 | while 1: | |
1753 | try: |
|
1753 | try: | |
1754 | self.interact(banner) |
|
1754 | self.interact(banner) | |
1755 | #self.interact_with_readline() |
|
1755 | #self.interact_with_readline() | |
1756 |
|
1756 | |||
1757 | # XXX for testing of a readline-decoupled repl loop, call |
|
1757 | # XXX for testing of a readline-decoupled repl loop, call | |
1758 | # interact_with_readline above |
|
1758 | # interact_with_readline above | |
1759 |
|
1759 | |||
1760 | break |
|
1760 | break | |
1761 | except KeyboardInterrupt: |
|
1761 | except KeyboardInterrupt: | |
1762 | # this should not be necessary, but KeyboardInterrupt |
|
1762 | # this should not be necessary, but KeyboardInterrupt | |
1763 | # handling seems rather unpredictable... |
|
1763 | # handling seems rather unpredictable... | |
1764 | self.write("\nKeyboardInterrupt in interact()\n") |
|
1764 | self.write("\nKeyboardInterrupt in interact()\n") | |
1765 |
|
1765 | |||
1766 | def exec_init_cmd(self): |
|
1766 | def exec_init_cmd(self): | |
1767 | """Execute a command given at the command line. |
|
1767 | """Execute a command given at the command line. | |
1768 |
|
1768 | |||
1769 | This emulates Python's -c option.""" |
|
1769 | This emulates Python's -c option.""" | |
1770 |
|
1770 | |||
1771 | #sys.argv = ['-c'] |
|
1771 | #sys.argv = ['-c'] | |
1772 | self.push(self.prefilter(self.rc.c, False)) |
|
1772 | self.push(self.prefilter(self.rc.c, False)) | |
1773 | if not self.rc.interact: |
|
1773 | if not self.rc.interact: | |
1774 | self.ask_exit() |
|
1774 | self.ask_exit() | |
1775 |
|
1775 | |||
1776 | def embed_mainloop(self,header='',local_ns=None,global_ns=None,stack_depth=0): |
|
1776 | def embed_mainloop(self,header='',local_ns=None,global_ns=None,stack_depth=0): | |
1777 | """Embeds IPython into a running python program. |
|
1777 | """Embeds IPython into a running python program. | |
1778 |
|
1778 | |||
1779 | Input: |
|
1779 | Input: | |
1780 |
|
1780 | |||
1781 | - header: An optional header message can be specified. |
|
1781 | - header: An optional header message can be specified. | |
1782 |
|
1782 | |||
1783 | - local_ns, global_ns: working namespaces. If given as None, the |
|
1783 | - local_ns, global_ns: working namespaces. If given as None, the | |
1784 | IPython-initialized one is updated with __main__.__dict__, so that |
|
1784 | IPython-initialized one is updated with __main__.__dict__, so that | |
1785 | program variables become visible but user-specific configuration |
|
1785 | program variables become visible but user-specific configuration | |
1786 | remains possible. |
|
1786 | remains possible. | |
1787 |
|
1787 | |||
1788 | - stack_depth: specifies how many levels in the stack to go to |
|
1788 | - stack_depth: specifies how many levels in the stack to go to | |
1789 | looking for namespaces (when local_ns and global_ns are None). This |
|
1789 | looking for namespaces (when local_ns and global_ns are None). This | |
1790 | allows an intermediate caller to make sure that this function gets |
|
1790 | allows an intermediate caller to make sure that this function gets | |
1791 | the namespace from the intended level in the stack. By default (0) |
|
1791 | the namespace from the intended level in the stack. By default (0) | |
1792 | it will get its locals and globals from the immediate caller. |
|
1792 | it will get its locals and globals from the immediate caller. | |
1793 |
|
1793 | |||
1794 | Warning: it's possible to use this in a program which is being run by |
|
1794 | Warning: it's possible to use this in a program which is being run by | |
1795 | IPython itself (via %run), but some funny things will happen (a few |
|
1795 | IPython itself (via %run), but some funny things will happen (a few | |
1796 | globals get overwritten). In the future this will be cleaned up, as |
|
1796 | globals get overwritten). In the future this will be cleaned up, as | |
1797 | there is no fundamental reason why it can't work perfectly.""" |
|
1797 | there is no fundamental reason why it can't work perfectly.""" | |
1798 |
|
1798 | |||
1799 | # Get locals and globals from caller |
|
1799 | # Get locals and globals from caller | |
1800 | if local_ns is None or global_ns is None: |
|
1800 | if local_ns is None or global_ns is None: | |
1801 | call_frame = sys._getframe(stack_depth).f_back |
|
1801 | call_frame = sys._getframe(stack_depth).f_back | |
1802 |
|
1802 | |||
1803 | if local_ns is None: |
|
1803 | if local_ns is None: | |
1804 | local_ns = call_frame.f_locals |
|
1804 | local_ns = call_frame.f_locals | |
1805 | if global_ns is None: |
|
1805 | if global_ns is None: | |
1806 | global_ns = call_frame.f_globals |
|
1806 | global_ns = call_frame.f_globals | |
1807 |
|
1807 | |||
1808 | # Update namespaces and fire up interpreter |
|
1808 | # Update namespaces and fire up interpreter | |
1809 |
|
1809 | |||
1810 | # The global one is easy, we can just throw it in |
|
1810 | # The global one is easy, we can just throw it in | |
1811 | self.user_global_ns = global_ns |
|
1811 | self.user_global_ns = global_ns | |
1812 |
|
1812 | |||
1813 | # but the user/local one is tricky: ipython needs it to store internal |
|
1813 | # but the user/local one is tricky: ipython needs it to store internal | |
1814 | # data, but we also need the locals. We'll copy locals in the user |
|
1814 | # data, but we also need the locals. We'll copy locals in the user | |
1815 | # one, but will track what got copied so we can delete them at exit. |
|
1815 | # one, but will track what got copied so we can delete them at exit. | |
1816 | # This is so that a later embedded call doesn't see locals from a |
|
1816 | # This is so that a later embedded call doesn't see locals from a | |
1817 | # previous call (which most likely existed in a separate scope). |
|
1817 | # previous call (which most likely existed in a separate scope). | |
1818 | local_varnames = local_ns.keys() |
|
1818 | local_varnames = local_ns.keys() | |
1819 | self.user_ns.update(local_ns) |
|
1819 | self.user_ns.update(local_ns) | |
1820 | #self.user_ns['local_ns'] = local_ns # dbg |
|
1820 | #self.user_ns['local_ns'] = local_ns # dbg | |
1821 |
|
1821 | |||
1822 | # Patch for global embedding to make sure that things don't overwrite |
|
1822 | # Patch for global embedding to make sure that things don't overwrite | |
1823 | # user globals accidentally. Thanks to Richard <rxe@renre-europe.com> |
|
1823 | # user globals accidentally. Thanks to Richard <rxe@renre-europe.com> | |
1824 | # FIXME. Test this a bit more carefully (the if.. is new) |
|
1824 | # FIXME. Test this a bit more carefully (the if.. is new) | |
1825 | if local_ns is None and global_ns is None: |
|
1825 | if local_ns is None and global_ns is None: | |
1826 | self.user_global_ns.update(__main__.__dict__) |
|
1826 | self.user_global_ns.update(__main__.__dict__) | |
1827 |
|
1827 | |||
1828 | # make sure the tab-completer has the correct frame information, so it |
|
1828 | # make sure the tab-completer has the correct frame information, so it | |
1829 | # actually completes using the frame's locals/globals |
|
1829 | # actually completes using the frame's locals/globals | |
1830 | self.set_completer_frame() |
|
1830 | self.set_completer_frame() | |
1831 |
|
1831 | |||
1832 | # before activating the interactive mode, we need to make sure that |
|
1832 | # before activating the interactive mode, we need to make sure that | |
1833 | # all names in the builtin namespace needed by ipython point to |
|
1833 | # all names in the builtin namespace needed by ipython point to | |
1834 | # ourselves, and not to other instances. |
|
1834 | # ourselves, and not to other instances. | |
1835 | self.add_builtins() |
|
1835 | self.add_builtins() | |
1836 |
|
1836 | |||
1837 | self.interact(header) |
|
1837 | self.interact(header) | |
1838 |
|
1838 | |||
1839 | # now, purge out the user namespace from anything we might have added |
|
1839 | # now, purge out the user namespace from anything we might have added | |
1840 | # from the caller's local namespace |
|
1840 | # from the caller's local namespace | |
1841 | delvar = self.user_ns.pop |
|
1841 | delvar = self.user_ns.pop | |
1842 | for var in local_varnames: |
|
1842 | for var in local_varnames: | |
1843 | delvar(var,None) |
|
1843 | delvar(var,None) | |
1844 | # and clean builtins we may have overridden |
|
1844 | # and clean builtins we may have overridden | |
1845 | self.clean_builtins() |
|
1845 | self.clean_builtins() | |
1846 |
|
1846 | |||
1847 | def interact_prompt(self): |
|
1847 | def interact_prompt(self): | |
1848 | """ Print the prompt (in read-eval-print loop) |
|
1848 | """ Print the prompt (in read-eval-print loop) | |
1849 |
|
1849 | |||
1850 | Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not |
|
1850 | Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not | |
1851 | used in standard IPython flow. |
|
1851 | used in standard IPython flow. | |
1852 | """ |
|
1852 | """ | |
1853 | if self.more: |
|
1853 | if self.more: | |
1854 | try: |
|
1854 | try: | |
1855 | prompt = self.hooks.generate_prompt(True) |
|
1855 | prompt = self.hooks.generate_prompt(True) | |
1856 | except: |
|
1856 | except: | |
1857 | self.showtraceback() |
|
1857 | self.showtraceback() | |
1858 | if self.autoindent: |
|
1858 | if self.autoindent: | |
1859 | self.rl_do_indent = True |
|
1859 | self.rl_do_indent = True | |
1860 |
|
1860 | |||
1861 | else: |
|
1861 | else: | |
1862 | try: |
|
1862 | try: | |
1863 | prompt = self.hooks.generate_prompt(False) |
|
1863 | prompt = self.hooks.generate_prompt(False) | |
1864 | except: |
|
1864 | except: | |
1865 | self.showtraceback() |
|
1865 | self.showtraceback() | |
1866 | self.write(prompt) |
|
1866 | self.write(prompt) | |
1867 |
|
1867 | |||
1868 | def interact_handle_input(self,line): |
|
1868 | def interact_handle_input(self,line): | |
1869 | """ Handle the input line (in read-eval-print loop) |
|
1869 | """ Handle the input line (in read-eval-print loop) | |
1870 |
|
1870 | |||
1871 | Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not |
|
1871 | Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not | |
1872 | used in standard IPython flow. |
|
1872 | used in standard IPython flow. | |
1873 | """ |
|
1873 | """ | |
1874 | if line.lstrip() == line: |
|
1874 | if line.lstrip() == line: | |
1875 | self.shadowhist.add(line.strip()) |
|
1875 | self.shadowhist.add(line.strip()) | |
1876 | lineout = self.prefilter(line,self.more) |
|
1876 | lineout = self.prefilter(line,self.more) | |
1877 |
|
1877 | |||
1878 | if line.strip(): |
|
1878 | if line.strip(): | |
1879 | if self.more: |
|
1879 | if self.more: | |
1880 | self.input_hist_raw[-1] += '%s\n' % line |
|
1880 | self.input_hist_raw[-1] += '%s\n' % line | |
1881 | else: |
|
1881 | else: | |
1882 | self.input_hist_raw.append('%s\n' % line) |
|
1882 | self.input_hist_raw.append('%s\n' % line) | |
1883 |
|
1883 | |||
1884 |
|
1884 | |||
1885 | self.more = self.push(lineout) |
|
1885 | self.more = self.push(lineout) | |
1886 | if (self.SyntaxTB.last_syntax_error and |
|
1886 | if (self.SyntaxTB.last_syntax_error and | |
1887 | self.rc.autoedit_syntax): |
|
1887 | self.rc.autoedit_syntax): | |
1888 | self.edit_syntax_error() |
|
1888 | self.edit_syntax_error() | |
1889 |
|
1889 | |||
1890 | def interact_with_readline(self): |
|
1890 | def interact_with_readline(self): | |
1891 | """ Demo of using interact_handle_input, interact_prompt |
|
1891 | """ Demo of using interact_handle_input, interact_prompt | |
1892 |
|
1892 | |||
1893 | This is the main read-eval-print loop. If you need to implement your own (e.g. for GUI), |
|
1893 | This is the main read-eval-print loop. If you need to implement your own (e.g. for GUI), | |
1894 | it should work like this. |
|
1894 | it should work like this. | |
1895 | """ |
|
1895 | """ | |
1896 | self.readline_startup_hook(self.pre_readline) |
|
1896 | self.readline_startup_hook(self.pre_readline) | |
1897 | while not self.exit_now: |
|
1897 | while not self.exit_now: | |
1898 | self.interact_prompt() |
|
1898 | self.interact_prompt() | |
1899 | if self.more: |
|
1899 | if self.more: | |
1900 | self.rl_do_indent = True |
|
1900 | self.rl_do_indent = True | |
1901 | else: |
|
1901 | else: | |
1902 | self.rl_do_indent = False |
|
1902 | self.rl_do_indent = False | |
1903 | line = raw_input_original().decode(self.stdin_encoding) |
|
1903 | line = raw_input_original().decode(self.stdin_encoding) | |
1904 | self.interact_handle_input(line) |
|
1904 | self.interact_handle_input(line) | |
1905 |
|
1905 | |||
1906 |
|
1906 | |||
1907 | def interact(self, banner=None): |
|
1907 | def interact(self, banner=None): | |
1908 | """Closely emulate the interactive Python console. |
|
1908 | """Closely emulate the interactive Python console. | |
1909 |
|
1909 | |||
1910 | The optional banner argument specify the banner to print |
|
1910 | The optional banner argument specify the banner to print | |
1911 | before the first interaction; by default it prints a banner |
|
1911 | before the first interaction; by default it prints a banner | |
1912 | similar to the one printed by the real Python interpreter, |
|
1912 | similar to the one printed by the real Python interpreter, | |
1913 | followed by the current class name in parentheses (so as not |
|
1913 | followed by the current class name in parentheses (so as not | |
1914 | to confuse this with the real interpreter -- since it's so |
|
1914 | to confuse this with the real interpreter -- since it's so | |
1915 | close!). |
|
1915 | close!). | |
1916 |
|
1916 | |||
1917 | """ |
|
1917 | """ | |
1918 |
|
1918 | |||
1919 | if self.exit_now: |
|
1919 | if self.exit_now: | |
1920 | # batch run -> do not interact |
|
1920 | # batch run -> do not interact | |
1921 | return |
|
1921 | return | |
1922 | cprt = 'Type "copyright", "credits" or "license" for more information.' |
|
1922 | cprt = 'Type "copyright", "credits" or "license" for more information.' | |
1923 | if banner is None: |
|
1923 | if banner is None: | |
1924 | self.write("Python %s on %s\n%s\n(%s)\n" % |
|
1924 | self.write("Python %s on %s\n%s\n(%s)\n" % | |
1925 | (sys.version, sys.platform, cprt, |
|
1925 | (sys.version, sys.platform, cprt, | |
1926 | self.__class__.__name__)) |
|
1926 | self.__class__.__name__)) | |
1927 | else: |
|
1927 | else: | |
1928 | self.write(banner) |
|
1928 | self.write(banner) | |
1929 |
|
1929 | |||
1930 | more = 0 |
|
1930 | more = 0 | |
1931 |
|
1931 | |||
1932 | # Mark activity in the builtins |
|
1932 | # Mark activity in the builtins | |
1933 | __builtin__.__dict__['__IPYTHON__active'] += 1 |
|
1933 | __builtin__.__dict__['__IPYTHON__active'] += 1 | |
1934 |
|
1934 | |||
1935 | if self.has_readline: |
|
1935 | if self.has_readline: | |
1936 | self.readline_startup_hook(self.pre_readline) |
|
1936 | self.readline_startup_hook(self.pre_readline) | |
1937 | # exit_now is set by a call to %Exit or %Quit, through the |
|
1937 | # exit_now is set by a call to %Exit or %Quit, through the | |
1938 | # ask_exit callback. |
|
1938 | # ask_exit callback. | |
1939 |
|
1939 | |||
1940 | while not self.exit_now: |
|
1940 | while not self.exit_now: | |
1941 | self.hooks.pre_prompt_hook() |
|
1941 | self.hooks.pre_prompt_hook() | |
1942 | if more: |
|
1942 | if more: | |
1943 | try: |
|
1943 | try: | |
1944 | prompt = self.hooks.generate_prompt(True) |
|
1944 | prompt = self.hooks.generate_prompt(True) | |
1945 | except: |
|
1945 | except: | |
1946 | self.showtraceback() |
|
1946 | self.showtraceback() | |
1947 | if self.autoindent: |
|
1947 | if self.autoindent: | |
1948 | self.rl_do_indent = True |
|
1948 | self.rl_do_indent = True | |
1949 |
|
1949 | |||
1950 | else: |
|
1950 | else: | |
1951 | try: |
|
1951 | try: | |
1952 | prompt = self.hooks.generate_prompt(False) |
|
1952 | prompt = self.hooks.generate_prompt(False) | |
1953 | except: |
|
1953 | except: | |
1954 | self.showtraceback() |
|
1954 | self.showtraceback() | |
1955 | try: |
|
1955 | try: | |
1956 | line = self.raw_input(prompt,more) |
|
1956 | line = self.raw_input(prompt,more) | |
1957 | if self.exit_now: |
|
1957 | if self.exit_now: | |
1958 | # quick exit on sys.std[in|out] close |
|
1958 | # quick exit on sys.std[in|out] close | |
1959 | break |
|
1959 | break | |
1960 | if self.autoindent: |
|
1960 | if self.autoindent: | |
1961 | self.rl_do_indent = False |
|
1961 | self.rl_do_indent = False | |
1962 |
|
1962 | |||
1963 | except KeyboardInterrupt: |
|
1963 | except KeyboardInterrupt: | |
1964 | #double-guard against keyboardinterrupts during kbdint handling |
|
1964 | #double-guard against keyboardinterrupts during kbdint handling | |
1965 | try: |
|
1965 | try: | |
1966 | self.write('\nKeyboardInterrupt\n') |
|
1966 | self.write('\nKeyboardInterrupt\n') | |
1967 | self.resetbuffer() |
|
1967 | self.resetbuffer() | |
1968 | # keep cache in sync with the prompt counter: |
|
1968 | # keep cache in sync with the prompt counter: | |
1969 | self.outputcache.prompt_count -= 1 |
|
1969 | self.outputcache.prompt_count -= 1 | |
1970 |
|
1970 | |||
1971 | if self.autoindent: |
|
1971 | if self.autoindent: | |
1972 | self.indent_current_nsp = 0 |
|
1972 | self.indent_current_nsp = 0 | |
1973 | more = 0 |
|
1973 | more = 0 | |
1974 | except KeyboardInterrupt: |
|
1974 | except KeyboardInterrupt: | |
1975 | pass |
|
1975 | pass | |
1976 | except EOFError: |
|
1976 | except EOFError: | |
1977 | if self.autoindent: |
|
1977 | if self.autoindent: | |
1978 | self.rl_do_indent = False |
|
1978 | self.rl_do_indent = False | |
1979 | self.readline_startup_hook(None) |
|
1979 | self.readline_startup_hook(None) | |
1980 | self.write('\n') |
|
1980 | self.write('\n') | |
1981 | self.exit() |
|
1981 | self.exit() | |
1982 | except bdb.BdbQuit: |
|
1982 | except bdb.BdbQuit: | |
1983 | warn('The Python debugger has exited with a BdbQuit exception.\n' |
|
1983 | warn('The Python debugger has exited with a BdbQuit exception.\n' | |
1984 | 'Because of how pdb handles the stack, it is impossible\n' |
|
1984 | 'Because of how pdb handles the stack, it is impossible\n' | |
1985 | 'for IPython to properly format this particular exception.\n' |
|
1985 | 'for IPython to properly format this particular exception.\n' | |
1986 | 'IPython will resume normal operation.') |
|
1986 | 'IPython will resume normal operation.') | |
1987 | except: |
|
1987 | except: | |
1988 | # exceptions here are VERY RARE, but they can be triggered |
|
1988 | # exceptions here are VERY RARE, but they can be triggered | |
1989 | # asynchronously by signal handlers, for example. |
|
1989 | # asynchronously by signal handlers, for example. | |
1990 | self.showtraceback() |
|
1990 | self.showtraceback() | |
1991 | else: |
|
1991 | else: | |
1992 | more = self.push(line) |
|
1992 | more = self.push(line) | |
1993 | if (self.SyntaxTB.last_syntax_error and |
|
1993 | if (self.SyntaxTB.last_syntax_error and | |
1994 | self.rc.autoedit_syntax): |
|
1994 | self.rc.autoedit_syntax): | |
1995 | self.edit_syntax_error() |
|
1995 | self.edit_syntax_error() | |
1996 |
|
1996 | |||
1997 | # We are off again... |
|
1997 | # We are off again... | |
1998 | __builtin__.__dict__['__IPYTHON__active'] -= 1 |
|
1998 | __builtin__.__dict__['__IPYTHON__active'] -= 1 | |
1999 |
|
1999 | |||
2000 | def excepthook(self, etype, value, tb): |
|
2000 | def excepthook(self, etype, value, tb): | |
2001 | """One more defense for GUI apps that call sys.excepthook. |
|
2001 | """One more defense for GUI apps that call sys.excepthook. | |
2002 |
|
2002 | |||
2003 | GUI frameworks like wxPython trap exceptions and call |
|
2003 | GUI frameworks like wxPython trap exceptions and call | |
2004 | sys.excepthook themselves. I guess this is a feature that |
|
2004 | sys.excepthook themselves. I guess this is a feature that | |
2005 | enables them to keep running after exceptions that would |
|
2005 | enables them to keep running after exceptions that would | |
2006 | otherwise kill their mainloop. This is a bother for IPython |
|
2006 | otherwise kill their mainloop. This is a bother for IPython | |
2007 | which excepts to catch all of the program exceptions with a try: |
|
2007 | which excepts to catch all of the program exceptions with a try: | |
2008 | except: statement. |
|
2008 | except: statement. | |
2009 |
|
2009 | |||
2010 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if |
|
2010 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if | |
2011 | any app directly invokes sys.excepthook, it will look to the user like |
|
2011 | any app directly invokes sys.excepthook, it will look to the user like | |
2012 | IPython crashed. In order to work around this, we can disable the |
|
2012 | IPython crashed. In order to work around this, we can disable the | |
2013 | CrashHandler and replace it with this excepthook instead, which prints a |
|
2013 | CrashHandler and replace it with this excepthook instead, which prints a | |
2014 | regular traceback using our InteractiveTB. In this fashion, apps which |
|
2014 | regular traceback using our InteractiveTB. In this fashion, apps which | |
2015 | call sys.excepthook will generate a regular-looking exception from |
|
2015 | call sys.excepthook will generate a regular-looking exception from | |
2016 | IPython, and the CrashHandler will only be triggered by real IPython |
|
2016 | IPython, and the CrashHandler will only be triggered by real IPython | |
2017 | crashes. |
|
2017 | crashes. | |
2018 |
|
2018 | |||
2019 | This hook should be used sparingly, only in places which are not likely |
|
2019 | This hook should be used sparingly, only in places which are not likely | |
2020 | to be true IPython errors. |
|
2020 | to be true IPython errors. | |
2021 | """ |
|
2021 | """ | |
2022 | self.showtraceback((etype,value,tb),tb_offset=0) |
|
2022 | self.showtraceback((etype,value,tb),tb_offset=0) | |
2023 |
|
2023 | |||
2024 | def expand_aliases(self,fn,rest): |
|
2024 | def expand_aliases(self,fn,rest): | |
2025 | """ Expand multiple levels of aliases: |
|
2025 | """ Expand multiple levels of aliases: | |
2026 |
|
2026 | |||
2027 | if: |
|
2027 | if: | |
2028 |
|
2028 | |||
2029 | alias foo bar /tmp |
|
2029 | alias foo bar /tmp | |
2030 | alias baz foo |
|
2030 | alias baz foo | |
2031 |
|
2031 | |||
2032 | then: |
|
2032 | then: | |
2033 |
|
2033 | |||
2034 | baz huhhahhei -> bar /tmp huhhahhei |
|
2034 | baz huhhahhei -> bar /tmp huhhahhei | |
2035 |
|
2035 | |||
2036 | """ |
|
2036 | """ | |
2037 | line = fn + " " + rest |
|
2037 | line = fn + " " + rest | |
2038 |
|
2038 | |||
2039 | done = set() |
|
2039 | done = set() | |
2040 | while 1: |
|
2040 | while 1: | |
2041 | pre,fn,rest = prefilter.splitUserInput(line, |
|
2041 | pre,fn,rest = prefilter.splitUserInput(line, | |
2042 | prefilter.shell_line_split) |
|
2042 | prefilter.shell_line_split) | |
2043 | if fn in self.alias_table: |
|
2043 | if fn in self.alias_table: | |
2044 | if fn in done: |
|
2044 | if fn in done: | |
2045 | warn("Cyclic alias definition, repeated '%s'" % fn) |
|
2045 | warn("Cyclic alias definition, repeated '%s'" % fn) | |
2046 | return "" |
|
2046 | return "" | |
2047 | done.add(fn) |
|
2047 | done.add(fn) | |
2048 |
|
2048 | |||
2049 | l2 = self.transform_alias(fn,rest) |
|
2049 | l2 = self.transform_alias(fn,rest) | |
2050 | # dir -> dir |
|
2050 | # dir -> dir | |
2051 | # print "alias",line, "->",l2 #dbg |
|
2051 | # print "alias",line, "->",l2 #dbg | |
2052 | if l2 == line: |
|
2052 | if l2 == line: | |
2053 | break |
|
2053 | break | |
2054 | # ls -> ls -F should not recurse forever |
|
2054 | # ls -> ls -F should not recurse forever | |
2055 | if l2.split(None,1)[0] == line.split(None,1)[0]: |
|
2055 | if l2.split(None,1)[0] == line.split(None,1)[0]: | |
2056 | line = l2 |
|
2056 | line = l2 | |
2057 | break |
|
2057 | break | |
2058 |
|
2058 | |||
2059 | line=l2 |
|
2059 | line=l2 | |
2060 |
|
2060 | |||
2061 |
|
2061 | |||
2062 | # print "al expand to",line #dbg |
|
2062 | # print "al expand to",line #dbg | |
2063 | else: |
|
2063 | else: | |
2064 | break |
|
2064 | break | |
2065 |
|
2065 | |||
2066 | return line |
|
2066 | return line | |
2067 |
|
2067 | |||
2068 | def transform_alias(self, alias,rest=''): |
|
2068 | def transform_alias(self, alias,rest=''): | |
2069 | """ Transform alias to system command string. |
|
2069 | """ Transform alias to system command string. | |
2070 | """ |
|
2070 | """ | |
2071 | trg = self.alias_table[alias] |
|
2071 | trg = self.alias_table[alias] | |
2072 |
|
2072 | |||
2073 | nargs,cmd = trg |
|
2073 | nargs,cmd = trg | |
2074 | # print trg #dbg |
|
2074 | # print trg #dbg | |
2075 | if ' ' in cmd and os.path.isfile(cmd): |
|
2075 | if ' ' in cmd and os.path.isfile(cmd): | |
2076 | cmd = '"%s"' % cmd |
|
2076 | cmd = '"%s"' % cmd | |
2077 |
|
2077 | |||
2078 | # Expand the %l special to be the user's input line |
|
2078 | # Expand the %l special to be the user's input line | |
2079 | if cmd.find('%l') >= 0: |
|
2079 | if cmd.find('%l') >= 0: | |
2080 | cmd = cmd.replace('%l',rest) |
|
2080 | cmd = cmd.replace('%l',rest) | |
2081 | rest = '' |
|
2081 | rest = '' | |
2082 | if nargs==0: |
|
2082 | if nargs==0: | |
2083 | # Simple, argument-less aliases |
|
2083 | # Simple, argument-less aliases | |
2084 | cmd = '%s %s' % (cmd,rest) |
|
2084 | cmd = '%s %s' % (cmd,rest) | |
2085 | else: |
|
2085 | else: | |
2086 | # Handle aliases with positional arguments |
|
2086 | # Handle aliases with positional arguments | |
2087 | args = rest.split(None,nargs) |
|
2087 | args = rest.split(None,nargs) | |
2088 | if len(args)< nargs: |
|
2088 | if len(args)< nargs: | |
2089 | error('Alias <%s> requires %s arguments, %s given.' % |
|
2089 | error('Alias <%s> requires %s arguments, %s given.' % | |
2090 | (alias,nargs,len(args))) |
|
2090 | (alias,nargs,len(args))) | |
2091 | return None |
|
2091 | return None | |
2092 | cmd = '%s %s' % (cmd % tuple(args[:nargs]),' '.join(args[nargs:])) |
|
2092 | cmd = '%s %s' % (cmd % tuple(args[:nargs]),' '.join(args[nargs:])) | |
2093 | # Now call the macro, evaluating in the user's namespace |
|
2093 | # Now call the macro, evaluating in the user's namespace | |
2094 | #print 'new command: <%r>' % cmd # dbg |
|
2094 | #print 'new command: <%r>' % cmd # dbg | |
2095 | return cmd |
|
2095 | return cmd | |
2096 |
|
2096 | |||
2097 | def call_alias(self,alias,rest=''): |
|
2097 | def call_alias(self,alias,rest=''): | |
2098 | """Call an alias given its name and the rest of the line. |
|
2098 | """Call an alias given its name and the rest of the line. | |
2099 |
|
2099 | |||
2100 | This is only used to provide backwards compatibility for users of |
|
2100 | This is only used to provide backwards compatibility for users of | |
2101 | ipalias(), use of which is not recommended for anymore.""" |
|
2101 | ipalias(), use of which is not recommended for anymore.""" | |
2102 |
|
2102 | |||
2103 | # Now call the macro, evaluating in the user's namespace |
|
2103 | # Now call the macro, evaluating in the user's namespace | |
2104 | cmd = self.transform_alias(alias, rest) |
|
2104 | cmd = self.transform_alias(alias, rest) | |
2105 | try: |
|
2105 | try: | |
2106 | self.system(cmd) |
|
2106 | self.system(cmd) | |
2107 | except: |
|
2107 | except: | |
2108 | self.showtraceback() |
|
2108 | self.showtraceback() | |
2109 |
|
2109 | |||
2110 | def indent_current_str(self): |
|
2110 | def indent_current_str(self): | |
2111 | """return the current level of indentation as a string""" |
|
2111 | """return the current level of indentation as a string""" | |
2112 | return self.indent_current_nsp * ' ' |
|
2112 | return self.indent_current_nsp * ' ' | |
2113 |
|
2113 | |||
2114 | def autoindent_update(self,line): |
|
2114 | def autoindent_update(self,line): | |
2115 | """Keep track of the indent level.""" |
|
2115 | """Keep track of the indent level.""" | |
2116 |
|
2116 | |||
2117 | #debugx('line') |
|
2117 | #debugx('line') | |
2118 | #debugx('self.indent_current_nsp') |
|
2118 | #debugx('self.indent_current_nsp') | |
2119 | if self.autoindent: |
|
2119 | if self.autoindent: | |
2120 | if line: |
|
2120 | if line: | |
2121 | inisp = num_ini_spaces(line) |
|
2121 | inisp = num_ini_spaces(line) | |
2122 | if inisp < self.indent_current_nsp: |
|
2122 | if inisp < self.indent_current_nsp: | |
2123 | self.indent_current_nsp = inisp |
|
2123 | self.indent_current_nsp = inisp | |
2124 |
|
2124 | |||
2125 | if line[-1] == ':': |
|
2125 | if line[-1] == ':': | |
2126 | self.indent_current_nsp += 4 |
|
2126 | self.indent_current_nsp += 4 | |
2127 | elif dedent_re.match(line): |
|
2127 | elif dedent_re.match(line): | |
2128 | self.indent_current_nsp -= 4 |
|
2128 | self.indent_current_nsp -= 4 | |
2129 | else: |
|
2129 | else: | |
2130 | self.indent_current_nsp = 0 |
|
2130 | self.indent_current_nsp = 0 | |
2131 |
|
2131 | |||
2132 | def runlines(self,lines): |
|
2132 | def runlines(self,lines): | |
2133 | """Run a string of one or more lines of source. |
|
2133 | """Run a string of one or more lines of source. | |
2134 |
|
2134 | |||
2135 | This method is capable of running a string containing multiple source |
|
2135 | This method is capable of running a string containing multiple source | |
2136 | lines, as if they had been entered at the IPython prompt. Since it |
|
2136 | lines, as if they had been entered at the IPython prompt. Since it | |
2137 | exposes IPython's processing machinery, the given strings can contain |
|
2137 | exposes IPython's processing machinery, the given strings can contain | |
2138 | magic calls (%magic), special shell access (!cmd), etc.""" |
|
2138 | magic calls (%magic), special shell access (!cmd), etc.""" | |
2139 |
|
2139 | |||
2140 | # We must start with a clean buffer, in case this is run from an |
|
2140 | # We must start with a clean buffer, in case this is run from an | |
2141 | # interactive IPython session (via a magic, for example). |
|
2141 | # interactive IPython session (via a magic, for example). | |
2142 | self.resetbuffer() |
|
2142 | self.resetbuffer() | |
2143 | lines = lines.split('\n') |
|
2143 | lines = lines.split('\n') | |
2144 | more = 0 |
|
2144 | more = 0 | |
2145 |
|
2145 | |||
2146 | for line in lines: |
|
2146 | for line in lines: | |
2147 | # skip blank lines so we don't mess up the prompt counter, but do |
|
2147 | # skip blank lines so we don't mess up the prompt counter, but do | |
2148 | # NOT skip even a blank line if we are in a code block (more is |
|
2148 | # NOT skip even a blank line if we are in a code block (more is | |
2149 | # true) |
|
2149 | # true) | |
2150 |
|
2150 | |||
2151 | if line or more: |
|
2151 | if line or more: | |
2152 | # push to raw history, so hist line numbers stay in sync |
|
2152 | # push to raw history, so hist line numbers stay in sync | |
2153 | self.input_hist_raw.append("# " + line + "\n") |
|
2153 | self.input_hist_raw.append("# " + line + "\n") | |
2154 | more = self.push(self.prefilter(line,more)) |
|
2154 | more = self.push(self.prefilter(line,more)) | |
2155 | # IPython's runsource returns None if there was an error |
|
2155 | # IPython's runsource returns None if there was an error | |
2156 | # compiling the code. This allows us to stop processing right |
|
2156 | # compiling the code. This allows us to stop processing right | |
2157 | # away, so the user gets the error message at the right place. |
|
2157 | # away, so the user gets the error message at the right place. | |
2158 | if more is None: |
|
2158 | if more is None: | |
2159 | break |
|
2159 | break | |
2160 | else: |
|
2160 | else: | |
2161 | self.input_hist_raw.append("\n") |
|
2161 | self.input_hist_raw.append("\n") | |
2162 | # final newline in case the input didn't have it, so that the code |
|
2162 | # final newline in case the input didn't have it, so that the code | |
2163 | # actually does get executed |
|
2163 | # actually does get executed | |
2164 | if more: |
|
2164 | if more: | |
2165 | self.push('\n') |
|
2165 | self.push('\n') | |
2166 |
|
2166 | |||
2167 | def runsource(self, source, filename='<input>', symbol='single'): |
|
2167 | def runsource(self, source, filename='<input>', symbol='single'): | |
2168 | """Compile and run some source in the interpreter. |
|
2168 | """Compile and run some source in the interpreter. | |
2169 |
|
2169 | |||
2170 | Arguments are as for compile_command(). |
|
2170 | Arguments are as for compile_command(). | |
2171 |
|
2171 | |||
2172 | One several things can happen: |
|
2172 | One several things can happen: | |
2173 |
|
2173 | |||
2174 | 1) The input is incorrect; compile_command() raised an |
|
2174 | 1) The input is incorrect; compile_command() raised an | |
2175 | exception (SyntaxError or OverflowError). A syntax traceback |
|
2175 | exception (SyntaxError or OverflowError). A syntax traceback | |
2176 | will be printed by calling the showsyntaxerror() method. |
|
2176 | will be printed by calling the showsyntaxerror() method. | |
2177 |
|
2177 | |||
2178 | 2) The input is incomplete, and more input is required; |
|
2178 | 2) The input is incomplete, and more input is required; | |
2179 | compile_command() returned None. Nothing happens. |
|
2179 | compile_command() returned None. Nothing happens. | |
2180 |
|
2180 | |||
2181 | 3) The input is complete; compile_command() returned a code |
|
2181 | 3) The input is complete; compile_command() returned a code | |
2182 | object. The code is executed by calling self.runcode() (which |
|
2182 | object. The code is executed by calling self.runcode() (which | |
2183 | also handles run-time exceptions, except for SystemExit). |
|
2183 | also handles run-time exceptions, except for SystemExit). | |
2184 |
|
2184 | |||
2185 | The return value is: |
|
2185 | The return value is: | |
2186 |
|
2186 | |||
2187 | - True in case 2 |
|
2187 | - True in case 2 | |
2188 |
|
2188 | |||
2189 | - False in the other cases, unless an exception is raised, where |
|
2189 | - False in the other cases, unless an exception is raised, where | |
2190 | None is returned instead. This can be used by external callers to |
|
2190 | None is returned instead. This can be used by external callers to | |
2191 | know whether to continue feeding input or not. |
|
2191 | know whether to continue feeding input or not. | |
2192 |
|
2192 | |||
2193 | The return value can be used to decide whether to use sys.ps1 or |
|
2193 | The return value can be used to decide whether to use sys.ps1 or | |
2194 | sys.ps2 to prompt the next line.""" |
|
2194 | sys.ps2 to prompt the next line.""" | |
2195 |
|
2195 | |||
2196 | # if the source code has leading blanks, add 'if 1:\n' to it |
|
2196 | # if the source code has leading blanks, add 'if 1:\n' to it | |
2197 | # this allows execution of indented pasted code. It is tempting |
|
2197 | # this allows execution of indented pasted code. It is tempting | |
2198 | # to add '\n' at the end of source to run commands like ' a=1' |
|
2198 | # to add '\n' at the end of source to run commands like ' a=1' | |
2199 | # directly, but this fails for more complicated scenarios |
|
2199 | # directly, but this fails for more complicated scenarios | |
2200 | source=source.encode(self.stdin_encoding) |
|
2200 | source=source.encode(self.stdin_encoding) | |
2201 | if source[:1] in [' ', '\t']: |
|
2201 | if source[:1] in [' ', '\t']: | |
2202 | source = 'if 1:\n%s' % source |
|
2202 | source = 'if 1:\n%s' % source | |
2203 |
|
2203 | |||
2204 | try: |
|
2204 | try: | |
2205 | code = self.compile(source,filename,symbol) |
|
2205 | code = self.compile(source,filename,symbol) | |
2206 | except (OverflowError, SyntaxError, ValueError, TypeError, MemoryError): |
|
2206 | except (OverflowError, SyntaxError, ValueError, TypeError, MemoryError): | |
2207 | # Case 1 |
|
2207 | # Case 1 | |
2208 | self.showsyntaxerror(filename) |
|
2208 | self.showsyntaxerror(filename) | |
2209 | return None |
|
2209 | return None | |
2210 |
|
2210 | |||
2211 | if code is None: |
|
2211 | if code is None: | |
2212 | # Case 2 |
|
2212 | # Case 2 | |
2213 | return True |
|
2213 | return True | |
2214 |
|
2214 | |||
2215 | # Case 3 |
|
2215 | # Case 3 | |
2216 | # We store the code object so that threaded shells and |
|
2216 | # We store the code object so that threaded shells and | |
2217 | # custom exception handlers can access all this info if needed. |
|
2217 | # custom exception handlers can access all this info if needed. | |
2218 | # The source corresponding to this can be obtained from the |
|
2218 | # The source corresponding to this can be obtained from the | |
2219 | # buffer attribute as '\n'.join(self.buffer). |
|
2219 | # buffer attribute as '\n'.join(self.buffer). | |
2220 | self.code_to_run = code |
|
2220 | self.code_to_run = code | |
2221 | # now actually execute the code object |
|
2221 | # now actually execute the code object | |
2222 | if self.runcode(code) == 0: |
|
2222 | if self.runcode(code) == 0: | |
2223 | return False |
|
2223 | return False | |
2224 | else: |
|
2224 | else: | |
2225 | return None |
|
2225 | return None | |
2226 |
|
2226 | |||
2227 | def runcode(self,code_obj): |
|
2227 | def runcode(self,code_obj): | |
2228 | """Execute a code object. |
|
2228 | """Execute a code object. | |
2229 |
|
2229 | |||
2230 | When an exception occurs, self.showtraceback() is called to display a |
|
2230 | When an exception occurs, self.showtraceback() is called to display a | |
2231 | traceback. |
|
2231 | traceback. | |
2232 |
|
2232 | |||
2233 | Return value: a flag indicating whether the code to be run completed |
|
2233 | Return value: a flag indicating whether the code to be run completed | |
2234 | successfully: |
|
2234 | successfully: | |
2235 |
|
2235 | |||
2236 | - 0: successful execution. |
|
2236 | - 0: successful execution. | |
2237 | - 1: an error occurred. |
|
2237 | - 1: an error occurred. | |
2238 | """ |
|
2238 | """ | |
2239 |
|
2239 | |||
2240 | # Set our own excepthook in case the user code tries to call it |
|
2240 | # Set our own excepthook in case the user code tries to call it | |
2241 | # directly, so that the IPython crash handler doesn't get triggered |
|
2241 | # directly, so that the IPython crash handler doesn't get triggered | |
2242 | old_excepthook,sys.excepthook = sys.excepthook, self.excepthook |
|
2242 | old_excepthook,sys.excepthook = sys.excepthook, self.excepthook | |
2243 |
|
2243 | |||
2244 | # we save the original sys.excepthook in the instance, in case config |
|
2244 | # we save the original sys.excepthook in the instance, in case config | |
2245 | # code (such as magics) needs access to it. |
|
2245 | # code (such as magics) needs access to it. | |
2246 | self.sys_excepthook = old_excepthook |
|
2246 | self.sys_excepthook = old_excepthook | |
2247 | outflag = 1 # happens in more places, so it's easier as default |
|
2247 | outflag = 1 # happens in more places, so it's easier as default | |
2248 | try: |
|
2248 | try: | |
2249 | try: |
|
2249 | try: | |
2250 | self.hooks.pre_runcode_hook() |
|
2250 | self.hooks.pre_runcode_hook() | |
2251 | exec code_obj in self.user_global_ns, self.user_ns |
|
2251 | exec code_obj in self.user_global_ns, self.user_ns | |
2252 | finally: |
|
2252 | finally: | |
2253 | # Reset our crash handler in place |
|
2253 | # Reset our crash handler in place | |
2254 | sys.excepthook = old_excepthook |
|
2254 | sys.excepthook = old_excepthook | |
2255 | except SystemExit: |
|
2255 | except SystemExit: | |
2256 | self.resetbuffer() |
|
2256 | self.resetbuffer() | |
2257 | self.showtraceback() |
|
2257 | self.showtraceback() | |
2258 | warn("Type %exit or %quit to exit IPython " |
|
2258 | warn("Type %exit or %quit to exit IPython " | |
2259 | "(%Exit or %Quit do so unconditionally).",level=1) |
|
2259 | "(%Exit or %Quit do so unconditionally).",level=1) | |
2260 | except self.custom_exceptions: |
|
2260 | except self.custom_exceptions: | |
2261 | etype,value,tb = sys.exc_info() |
|
2261 | etype,value,tb = sys.exc_info() | |
2262 | self.CustomTB(etype,value,tb) |
|
2262 | self.CustomTB(etype,value,tb) | |
2263 | except: |
|
2263 | except: | |
2264 | self.showtraceback() |
|
2264 | self.showtraceback() | |
2265 | else: |
|
2265 | else: | |
2266 | outflag = 0 |
|
2266 | outflag = 0 | |
2267 | if softspace(sys.stdout, 0): |
|
2267 | if softspace(sys.stdout, 0): | |
2268 |
|
2268 | |||
2269 | # Flush out code object which has been run (and source) |
|
2269 | # Flush out code object which has been run (and source) | |
2270 | self.code_to_run = None |
|
2270 | self.code_to_run = None | |
2271 | return outflag |
|
2271 | return outflag | |
2272 |
|
2272 | |||
2273 | def push(self, line): |
|
2273 | def push(self, line): | |
2274 | """Push a line to the interpreter. |
|
2274 | """Push a line to the interpreter. | |
2275 |
|
2275 | |||
2276 | The line should not have a trailing newline; it may have |
|
2276 | The line should not have a trailing newline; it may have | |
2277 | internal newlines. The line is appended to a buffer and the |
|
2277 | internal newlines. The line is appended to a buffer and the | |
2278 | interpreter's runsource() method is called with the |
|
2278 | interpreter's runsource() method is called with the | |
2279 | concatenated contents of the buffer as source. If this |
|
2279 | concatenated contents of the buffer as source. If this | |
2280 | indicates that the command was executed or invalid, the buffer |
|
2280 | indicates that the command was executed or invalid, the buffer | |
2281 | is reset; otherwise, the command is incomplete, and the buffer |
|
2281 | is reset; otherwise, the command is incomplete, and the buffer | |
2282 | is left as it was after the line was appended. The return |
|
2282 | is left as it was after the line was appended. The return | |
2283 | value is 1 if more input is required, 0 if the line was dealt |
|
2283 | value is 1 if more input is required, 0 if the line was dealt | |
2284 | with in some way (this is the same as runsource()). |
|
2284 | with in some way (this is the same as runsource()). | |
2285 | """ |
|
2285 | """ | |
2286 |
|
2286 | |||
2287 | # autoindent management should be done here, and not in the |
|
2287 | # autoindent management should be done here, and not in the | |
2288 | # interactive loop, since that one is only seen by keyboard input. We |
|
2288 | # interactive loop, since that one is only seen by keyboard input. We | |
2289 | # need this done correctly even for code run via runlines (which uses |
|
2289 | # need this done correctly even for code run via runlines (which uses | |
2290 | # push). |
|
2290 | # push). | |
2291 |
|
2291 | |||
2292 | #print 'push line: <%s>' % line # dbg |
|
2292 | #print 'push line: <%s>' % line # dbg | |
2293 | for subline in line.splitlines(): |
|
2293 | for subline in line.splitlines(): | |
2294 | self.autoindent_update(subline) |
|
2294 | self.autoindent_update(subline) | |
2295 | self.buffer.append(line) |
|
2295 | self.buffer.append(line) | |
2296 | more = self.runsource('\n'.join(self.buffer), self.filename) |
|
2296 | more = self.runsource('\n'.join(self.buffer), self.filename) | |
2297 | if not more: |
|
2297 | if not more: | |
2298 | self.resetbuffer() |
|
2298 | self.resetbuffer() | |
2299 | return more |
|
2299 | return more | |
2300 |
|
2300 | |||
2301 | def split_user_input(self, line): |
|
2301 | def split_user_input(self, line): | |
2302 | # This is really a hold-over to support ipapi and some extensions |
|
2302 | # This is really a hold-over to support ipapi and some extensions | |
2303 | return prefilter.splitUserInput(line) |
|
2303 | return prefilter.splitUserInput(line) | |
2304 |
|
2304 | |||
2305 | def resetbuffer(self): |
|
2305 | def resetbuffer(self): | |
2306 | """Reset the input buffer.""" |
|
2306 | """Reset the input buffer.""" | |
2307 | self.buffer[:] = [] |
|
2307 | self.buffer[:] = [] | |
2308 |
|
2308 | |||
2309 | def raw_input(self,prompt='',continue_prompt=False): |
|
2309 | def raw_input(self,prompt='',continue_prompt=False): | |
2310 | """Write a prompt and read a line. |
|
2310 | """Write a prompt and read a line. | |
2311 |
|
2311 | |||
2312 | The returned line does not include the trailing newline. |
|
2312 | The returned line does not include the trailing newline. | |
2313 | When the user enters the EOF key sequence, EOFError is raised. |
|
2313 | When the user enters the EOF key sequence, EOFError is raised. | |
2314 |
|
2314 | |||
2315 | Optional inputs: |
|
2315 | Optional inputs: | |
2316 |
|
2316 | |||
2317 | - prompt(''): a string to be printed to prompt the user. |
|
2317 | - prompt(''): a string to be printed to prompt the user. | |
2318 |
|
2318 | |||
2319 | - continue_prompt(False): whether this line is the first one or a |
|
2319 | - continue_prompt(False): whether this line is the first one or a | |
2320 | continuation in a sequence of inputs. |
|
2320 | continuation in a sequence of inputs. | |
2321 | """ |
|
2321 | """ | |
2322 |
|
2322 | |||
2323 | # Code run by the user may have modified the readline completer state. |
|
2323 | # Code run by the user may have modified the readline completer state. | |
2324 | # We must ensure that our completer is back in place. |
|
2324 | # We must ensure that our completer is back in place. | |
2325 | if self.has_readline: |
|
2325 | if self.has_readline: | |
2326 | self.set_completer() |
|
2326 | self.set_completer() | |
2327 |
|
2327 | |||
2328 | try: |
|
2328 | try: | |
2329 | line = raw_input_original(prompt).decode(self.stdin_encoding) |
|
2329 | line = raw_input_original(prompt).decode(self.stdin_encoding) | |
2330 | except ValueError: |
|
2330 | except ValueError: | |
2331 | warn("\n********\nYou or a %run:ed script called sys.stdin.close()" |
|
2331 | warn("\n********\nYou or a %run:ed script called sys.stdin.close()" | |
2332 | " or sys.stdout.close()!\nExiting IPython!") |
|
2332 | " or sys.stdout.close()!\nExiting IPython!") | |
2333 | self.ask_exit() |
|
2333 | self.ask_exit() | |
2334 | return "" |
|
2334 | return "" | |
2335 |
|
2335 | |||
2336 | # Try to be reasonably smart about not re-indenting pasted input more |
|
2336 | # Try to be reasonably smart about not re-indenting pasted input more | |
2337 | # than necessary. We do this by trimming out the auto-indent initial |
|
2337 | # than necessary. We do this by trimming out the auto-indent initial | |
2338 | # spaces, if the user's actual input started itself with whitespace. |
|
2338 | # spaces, if the user's actual input started itself with whitespace. | |
2339 | #debugx('self.buffer[-1]') |
|
2339 | #debugx('self.buffer[-1]') | |
2340 |
|
2340 | |||
2341 | if self.autoindent: |
|
2341 | if self.autoindent: | |
2342 | if num_ini_spaces(line) > self.indent_current_nsp: |
|
2342 | if num_ini_spaces(line) > self.indent_current_nsp: | |
2343 | line = line[self.indent_current_nsp:] |
|
2343 | line = line[self.indent_current_nsp:] | |
2344 | self.indent_current_nsp = 0 |
|
2344 | self.indent_current_nsp = 0 | |
2345 |
|
2345 | |||
2346 | # store the unfiltered input before the user has any chance to modify |
|
2346 | # store the unfiltered input before the user has any chance to modify | |
2347 | # it. |
|
2347 | # it. | |
2348 | if line.strip(): |
|
2348 | if line.strip(): | |
2349 | if continue_prompt: |
|
2349 | if continue_prompt: | |
2350 | self.input_hist_raw[-1] += '%s\n' % line |
|
2350 | self.input_hist_raw[-1] += '%s\n' % line | |
2351 | if self.has_readline: # and some config option is set? |
|
2351 | if self.has_readline: # and some config option is set? | |
2352 | try: |
|
2352 | try: | |
2353 | histlen = self.readline.get_current_history_length() |
|
2353 | histlen = self.readline.get_current_history_length() | |
2354 | if histlen > 1: |
|
2354 | if histlen > 1: | |
2355 | newhist = self.input_hist_raw[-1].rstrip() |
|
2355 | newhist = self.input_hist_raw[-1].rstrip() | |
2356 | self.readline.remove_history_item(histlen-1) |
|
2356 | self.readline.remove_history_item(histlen-1) | |
2357 | self.readline.replace_history_item(histlen-2, |
|
2357 | self.readline.replace_history_item(histlen-2, | |
2358 | newhist.encode(self.stdin_encoding)) |
|
2358 | newhist.encode(self.stdin_encoding)) | |
2359 | except AttributeError: |
|
2359 | except AttributeError: | |
2360 | pass # re{move,place}_history_item are new in 2.4. |
|
2360 | pass # re{move,place}_history_item are new in 2.4. | |
2361 | else: |
|
2361 | else: | |
2362 | self.input_hist_raw.append('%s\n' % line) |
|
2362 | self.input_hist_raw.append('%s\n' % line) | |
2363 | # only entries starting at first column go to shadow history |
|
2363 | # only entries starting at first column go to shadow history | |
2364 | if line.lstrip() == line: |
|
2364 | if line.lstrip() == line: | |
2365 | self.shadowhist.add(line.strip()) |
|
2365 | self.shadowhist.add(line.strip()) | |
2366 | elif not continue_prompt: |
|
2366 | elif not continue_prompt: | |
2367 | self.input_hist_raw.append('\n') |
|
2367 | self.input_hist_raw.append('\n') | |
2368 | try: |
|
2368 | try: | |
2369 | lineout = self.prefilter(line,continue_prompt) |
|
2369 | lineout = self.prefilter(line,continue_prompt) | |
2370 | except: |
|
2370 | except: | |
2371 | # blanket except, in case a user-defined prefilter crashes, so it |
|
2371 | # blanket except, in case a user-defined prefilter crashes, so it | |
2372 | # can't take all of ipython with it. |
|
2372 | # can't take all of ipython with it. | |
2373 | self.showtraceback() |
|
2373 | self.showtraceback() | |
2374 | return '' |
|
2374 | return '' | |
2375 | else: |
|
2375 | else: | |
2376 | return lineout |
|
2376 | return lineout | |
2377 |
|
2377 | |||
2378 | def _prefilter(self, line, continue_prompt): |
|
2378 | def _prefilter(self, line, continue_prompt): | |
2379 | """Calls different preprocessors, depending on the form of line.""" |
|
2379 | """Calls different preprocessors, depending on the form of line.""" | |
2380 |
|
2380 | |||
2381 | # All handlers *must* return a value, even if it's blank (''). |
|
2381 | # All handlers *must* return a value, even if it's blank (''). | |
2382 |
|
2382 | |||
2383 | # Lines are NOT logged here. Handlers should process the line as |
|
2383 | # Lines are NOT logged here. Handlers should process the line as | |
2384 | # needed, update the cache AND log it (so that the input cache array |
|
2384 | # needed, update the cache AND log it (so that the input cache array | |
2385 | # stays synced). |
|
2385 | # stays synced). | |
2386 |
|
2386 | |||
2387 | #..................................................................... |
|
2387 | #..................................................................... | |
2388 | # Code begins |
|
2388 | # Code begins | |
2389 |
|
2389 | |||
2390 | #if line.startswith('%crash'): raise RuntimeError,'Crash now!' # dbg |
|
2390 | #if line.startswith('%crash'): raise RuntimeError,'Crash now!' # dbg | |
2391 |
|
2391 | |||
2392 | # save the line away in case we crash, so the post-mortem handler can |
|
2392 | # save the line away in case we crash, so the post-mortem handler can | |
2393 | # record it |
|
2393 | # record it | |
2394 | self._last_input_line = line |
|
2394 | self._last_input_line = line | |
2395 |
|
2395 | |||
2396 | #print '***line: <%s>' % line # dbg |
|
2396 | #print '***line: <%s>' % line # dbg | |
2397 |
|
2397 | |||
2398 | if not line: |
|
2398 | if not line: | |
2399 | # Return immediately on purely empty lines, so that if the user |
|
2399 | # Return immediately on purely empty lines, so that if the user | |
2400 | # previously typed some whitespace that started a continuation |
|
2400 | # previously typed some whitespace that started a continuation | |
2401 | # prompt, he can break out of that loop with just an empty line. |
|
2401 | # prompt, he can break out of that loop with just an empty line. | |
2402 | # This is how the default python prompt works. |
|
2402 | # This is how the default python prompt works. | |
2403 |
|
2403 | |||
2404 | # Only return if the accumulated input buffer was just whitespace! |
|
2404 | # Only return if the accumulated input buffer was just whitespace! | |
2405 | if ''.join(self.buffer).isspace(): |
|
2405 | if ''.join(self.buffer).isspace(): | |
2406 | self.buffer[:] = [] |
|
2406 | self.buffer[:] = [] | |
2407 | return '' |
|
2407 | return '' | |
2408 |
|
2408 | |||
2409 | line_info = prefilter.LineInfo(line, continue_prompt) |
|
2409 | line_info = prefilter.LineInfo(line, continue_prompt) | |
2410 |
|
2410 | |||
2411 | # the input history needs to track even empty lines |
|
2411 | # the input history needs to track even empty lines | |
2412 | stripped = line.strip() |
|
2412 | stripped = line.strip() | |
2413 |
|
2413 | |||
2414 | if not stripped: |
|
2414 | if not stripped: | |
2415 | if not continue_prompt: |
|
2415 | if not continue_prompt: | |
2416 | self.outputcache.prompt_count -= 1 |
|
2416 | self.outputcache.prompt_count -= 1 | |
2417 | return self.handle_normal(line_info) |
|
2417 | return self.handle_normal(line_info) | |
2418 |
|
2418 | |||
2419 | # print '***cont',continue_prompt # dbg |
|
2419 | # print '***cont',continue_prompt # dbg | |
2420 | # special handlers are only allowed for single line statements |
|
2420 | # special handlers are only allowed for single line statements | |
2421 | if continue_prompt and not self.rc.multi_line_specials: |
|
2421 | if continue_prompt and not self.rc.multi_line_specials: | |
2422 | return self.handle_normal(line_info) |
|
2422 | return self.handle_normal(line_info) | |
2423 |
|
2423 | |||
2424 |
|
2424 | |||
2425 | # See whether any pre-existing handler can take care of it |
|
2425 | # See whether any pre-existing handler can take care of it | |
2426 | rewritten = self.hooks.input_prefilter(stripped) |
|
2426 | rewritten = self.hooks.input_prefilter(stripped) | |
2427 | if rewritten != stripped: # ok, some prefilter did something |
|
2427 | if rewritten != stripped: # ok, some prefilter did something | |
2428 | rewritten = line_info.pre + rewritten # add indentation |
|
2428 | rewritten = line_info.pre + rewritten # add indentation | |
2429 | return self.handle_normal(prefilter.LineInfo(rewritten, |
|
2429 | return self.handle_normal(prefilter.LineInfo(rewritten, | |
2430 | continue_prompt)) |
|
2430 | continue_prompt)) | |
2431 |
|
2431 | |||
2432 | #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg |
|
2432 | #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg | |
2433 |
|
2433 | |||
2434 | return prefilter.prefilter(line_info, self) |
|
2434 | return prefilter.prefilter(line_info, self) | |
2435 |
|
2435 | |||
2436 |
|
2436 | |||
2437 | def _prefilter_dumb(self, line, continue_prompt): |
|
2437 | def _prefilter_dumb(self, line, continue_prompt): | |
2438 | """simple prefilter function, for debugging""" |
|
2438 | """simple prefilter function, for debugging""" | |
2439 | return self.handle_normal(line,continue_prompt) |
|
2439 | return self.handle_normal(line,continue_prompt) | |
2440 |
|
2440 | |||
2441 |
|
2441 | |||
2442 | def multiline_prefilter(self, line, continue_prompt): |
|
2442 | def multiline_prefilter(self, line, continue_prompt): | |
2443 | """ Run _prefilter for each line of input |
|
2443 | """ Run _prefilter for each line of input | |
2444 |
|
2444 | |||
2445 | Covers cases where there are multiple lines in the user entry, |
|
2445 | Covers cases where there are multiple lines in the user entry, | |
2446 | which is the case when the user goes back to a multiline history |
|
2446 | which is the case when the user goes back to a multiline history | |
2447 | entry and presses enter. |
|
2447 | entry and presses enter. | |
2448 |
|
2448 | |||
2449 | """ |
|
2449 | """ | |
2450 | out = [] |
|
2450 | out = [] | |
2451 | for l in line.rstrip('\n').split('\n'): |
|
2451 | for l in line.rstrip('\n').split('\n'): | |
2452 | out.append(self._prefilter(l, continue_prompt)) |
|
2452 | out.append(self._prefilter(l, continue_prompt)) | |
2453 | return '\n'.join(out) |
|
2453 | return '\n'.join(out) | |
2454 |
|
2454 | |||
2455 | # Set the default prefilter() function (this can be user-overridden) |
|
2455 | # Set the default prefilter() function (this can be user-overridden) | |
2456 | prefilter = multiline_prefilter |
|
2456 | prefilter = multiline_prefilter | |
2457 |
|
2457 | |||
2458 | def handle_normal(self,line_info): |
|
2458 | def handle_normal(self,line_info): | |
2459 | """Handle normal input lines. Use as a template for handlers.""" |
|
2459 | """Handle normal input lines. Use as a template for handlers.""" | |
2460 |
|
2460 | |||
2461 | # With autoindent on, we need some way to exit the input loop, and I |
|
2461 | # With autoindent on, we need some way to exit the input loop, and I | |
2462 | # don't want to force the user to have to backspace all the way to |
|
2462 | # don't want to force the user to have to backspace all the way to | |
2463 | # clear the line. The rule will be in this case, that either two |
|
2463 | # clear the line. The rule will be in this case, that either two | |
2464 | # lines of pure whitespace in a row, or a line of pure whitespace but |
|
2464 | # lines of pure whitespace in a row, or a line of pure whitespace but | |
2465 | # of a size different to the indent level, will exit the input loop. |
|
2465 | # of a size different to the indent level, will exit the input loop. | |
2466 | line = line_info.line |
|
2466 | line = line_info.line | |
2467 | continue_prompt = line_info.continue_prompt |
|
2467 | continue_prompt = line_info.continue_prompt | |
2468 |
|
2468 | |||
2469 | if (continue_prompt and self.autoindent and line.isspace() and |
|
2469 | if (continue_prompt and self.autoindent and line.isspace() and | |
2470 | (0 < abs(len(line) - self.indent_current_nsp) <= 2 or |
|
2470 | (0 < abs(len(line) - self.indent_current_nsp) <= 2 or | |
2471 | (self.buffer[-1]).isspace() )): |
|
2471 | (self.buffer[-1]).isspace() )): | |
2472 | line = '' |
|
2472 | line = '' | |
2473 |
|
2473 | |||
2474 | self.log(line,line,continue_prompt) |
|
2474 | self.log(line,line,continue_prompt) | |
2475 | return line |
|
2475 | return line | |
2476 |
|
2476 | |||
2477 | def handle_alias(self,line_info): |
|
2477 | def handle_alias(self,line_info): | |
2478 | """Handle alias input lines. """ |
|
2478 | """Handle alias input lines. """ | |
2479 | tgt = self.alias_table[line_info.iFun] |
|
2479 | tgt = self.alias_table[line_info.iFun] | |
2480 | # print "=>",tgt #dbg |
|
2480 | # print "=>",tgt #dbg | |
2481 | if callable(tgt): |
|
2481 | if callable(tgt): | |
2482 | if '$' in line_info.line: |
|
2482 | if '$' in line_info.line: | |
2483 | call_meth = '(_ip, _ip.itpl(%s))' |
|
2483 | call_meth = '(_ip, _ip.itpl(%s))' | |
2484 | else: |
|
2484 | else: | |
2485 | call_meth = '(_ip,%s)' |
|
2485 | call_meth = '(_ip,%s)' | |
2486 | line_out = ("%s_sh.%s" + call_meth) % (line_info.preWhitespace, |
|
2486 | line_out = ("%s_sh.%s" + call_meth) % (line_info.preWhitespace, | |
2487 | line_info.iFun, |
|
2487 | line_info.iFun, | |
2488 | make_quoted_expr(line_info.line)) |
|
2488 | make_quoted_expr(line_info.line)) | |
2489 | else: |
|
2489 | else: | |
2490 | transformed = self.expand_aliases(line_info.iFun,line_info.theRest) |
|
2490 | transformed = self.expand_aliases(line_info.iFun,line_info.theRest) | |
2491 |
|
2491 | |||
2492 | # pre is needed, because it carries the leading whitespace. Otherwise |
|
2492 | # pre is needed, because it carries the leading whitespace. Otherwise | |
2493 | # aliases won't work in indented sections. |
|
2493 | # aliases won't work in indented sections. | |
2494 | line_out = '%s_ip.system(%s)' % (line_info.preWhitespace, |
|
2494 | line_out = '%s_ip.system(%s)' % (line_info.preWhitespace, | |
2495 | make_quoted_expr( transformed )) |
|
2495 | make_quoted_expr( transformed )) | |
2496 |
|
2496 | |||
2497 | self.log(line_info.line,line_out,line_info.continue_prompt) |
|
2497 | self.log(line_info.line,line_out,line_info.continue_prompt) | |
2498 | #print 'line out:',line_out # dbg |
|
2498 | #print 'line out:',line_out # dbg | |
2499 | return line_out |
|
2499 | return line_out | |
2500 |
|
2500 | |||
2501 | def handle_shell_escape(self, line_info): |
|
2501 | def handle_shell_escape(self, line_info): | |
2502 | """Execute the line in a shell, empty return value""" |
|
2502 | """Execute the line in a shell, empty return value""" | |
2503 | #print 'line in :', `line` # dbg |
|
2503 | #print 'line in :', `line` # dbg | |
2504 | line = line_info.line |
|
2504 | line = line_info.line | |
2505 | if line.lstrip().startswith('!!'): |
|
2505 | if line.lstrip().startswith('!!'): | |
2506 | # rewrite LineInfo's line, iFun and theRest to properly hold the |
|
2506 | # rewrite LineInfo's line, iFun and theRest to properly hold the | |
2507 | # call to %sx and the actual command to be executed, so |
|
2507 | # call to %sx and the actual command to be executed, so | |
2508 | # handle_magic can work correctly. Note that this works even if |
|
2508 | # handle_magic can work correctly. Note that this works even if | |
2509 | # the line is indented, so it handles multi_line_specials |
|
2509 | # the line is indented, so it handles multi_line_specials | |
2510 | # properly. |
|
2510 | # properly. | |
2511 | new_rest = line.lstrip()[2:] |
|
2511 | new_rest = line.lstrip()[2:] | |
2512 | line_info.line = '%ssx %s' % (self.ESC_MAGIC,new_rest) |
|
2512 | line_info.line = '%ssx %s' % (self.ESC_MAGIC,new_rest) | |
2513 | line_info.iFun = 'sx' |
|
2513 | line_info.iFun = 'sx' | |
2514 | line_info.theRest = new_rest |
|
2514 | line_info.theRest = new_rest | |
2515 | return self.handle_magic(line_info) |
|
2515 | return self.handle_magic(line_info) | |
2516 | else: |
|
2516 | else: | |
2517 | cmd = line.lstrip().lstrip('!') |
|
2517 | cmd = line.lstrip().lstrip('!') | |
2518 | line_out = '%s_ip.system(%s)' % (line_info.preWhitespace, |
|
2518 | line_out = '%s_ip.system(%s)' % (line_info.preWhitespace, | |
2519 | make_quoted_expr(cmd)) |
|
2519 | make_quoted_expr(cmd)) | |
2520 | # update cache/log and return |
|
2520 | # update cache/log and return | |
2521 | self.log(line,line_out,line_info.continue_prompt) |
|
2521 | self.log(line,line_out,line_info.continue_prompt) | |
2522 | return line_out |
|
2522 | return line_out | |
2523 |
|
2523 | |||
2524 | def handle_magic(self, line_info): |
|
2524 | def handle_magic(self, line_info): | |
2525 | """Execute magic functions.""" |
|
2525 | """Execute magic functions.""" | |
2526 | iFun = line_info.iFun |
|
2526 | iFun = line_info.iFun | |
2527 | theRest = line_info.theRest |
|
2527 | theRest = line_info.theRest | |
2528 | cmd = '%s_ip.magic(%s)' % (line_info.preWhitespace, |
|
2528 | cmd = '%s_ip.magic(%s)' % (line_info.preWhitespace, | |
2529 | make_quoted_expr(iFun + " " + theRest)) |
|
2529 | make_quoted_expr(iFun + " " + theRest)) | |
2530 | self.log(line_info.line,cmd,line_info.continue_prompt) |
|
2530 | self.log(line_info.line,cmd,line_info.continue_prompt) | |
2531 | #print 'in handle_magic, cmd=<%s>' % cmd # dbg |
|
2531 | #print 'in handle_magic, cmd=<%s>' % cmd # dbg | |
2532 | return cmd |
|
2532 | return cmd | |
2533 |
|
2533 | |||
2534 | def handle_auto(self, line_info): |
|
2534 | def handle_auto(self, line_info): | |
2535 | """Hande lines which can be auto-executed, quoting if requested.""" |
|
2535 | """Hande lines which can be auto-executed, quoting if requested.""" | |
2536 |
|
2536 | |||
2537 | line = line_info.line |
|
2537 | line = line_info.line | |
2538 | iFun = line_info.iFun |
|
2538 | iFun = line_info.iFun | |
2539 | theRest = line_info.theRest |
|
2539 | theRest = line_info.theRest | |
2540 | pre = line_info.pre |
|
2540 | pre = line_info.pre | |
2541 | continue_prompt = line_info.continue_prompt |
|
2541 | continue_prompt = line_info.continue_prompt | |
2542 | obj = line_info.ofind(self)['obj'] |
|
2542 | obj = line_info.ofind(self)['obj'] | |
2543 |
|
2543 | |||
2544 | #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg |
|
2544 | #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg | |
2545 |
|
2545 | |||
2546 | # This should only be active for single-line input! |
|
2546 | # This should only be active for single-line input! | |
2547 | if continue_prompt: |
|
2547 | if continue_prompt: | |
2548 | self.log(line,line,continue_prompt) |
|
2548 | self.log(line,line,continue_prompt) | |
2549 | return line |
|
2549 | return line | |
2550 |
|
2550 | |||
2551 | force_auto = isinstance(obj, ipapi.IPyAutocall) |
|
2551 | force_auto = isinstance(obj, ipapi.IPyAutocall) | |
2552 | auto_rewrite = True |
|
2552 | auto_rewrite = True | |
2553 |
|
2553 | |||
2554 | if pre == self.ESC_QUOTE: |
|
2554 | if pre == self.ESC_QUOTE: | |
2555 | # Auto-quote splitting on whitespace |
|
2555 | # Auto-quote splitting on whitespace | |
2556 | newcmd = '%s("%s")' % (iFun,'", "'.join(theRest.split()) ) |
|
2556 | newcmd = '%s("%s")' % (iFun,'", "'.join(theRest.split()) ) | |
2557 | elif pre == self.ESC_QUOTE2: |
|
2557 | elif pre == self.ESC_QUOTE2: | |
2558 | # Auto-quote whole string |
|
2558 | # Auto-quote whole string | |
2559 | newcmd = '%s("%s")' % (iFun,theRest) |
|
2559 | newcmd = '%s("%s")' % (iFun,theRest) | |
2560 | elif pre == self.ESC_PAREN: |
|
2560 | elif pre == self.ESC_PAREN: | |
2561 | newcmd = '%s(%s)' % (iFun,",".join(theRest.split())) |
|
2561 | newcmd = '%s(%s)' % (iFun,",".join(theRest.split())) | |
2562 | else: |
|
2562 | else: | |
2563 | # Auto-paren. |
|
2563 | # Auto-paren. | |
2564 | # We only apply it to argument-less calls if the autocall |
|
2564 | # We only apply it to argument-less calls if the autocall | |
2565 | # parameter is set to 2. We only need to check that autocall is < |
|
2565 | # parameter is set to 2. We only need to check that autocall is < | |
2566 | # 2, since this function isn't called unless it's at least 1. |
|
2566 | # 2, since this function isn't called unless it's at least 1. | |
2567 | if not theRest and (self.rc.autocall < 2) and not force_auto: |
|
2567 | if not theRest and (self.rc.autocall < 2) and not force_auto: | |
2568 | newcmd = '%s %s' % (iFun,theRest) |
|
2568 | newcmd = '%s %s' % (iFun,theRest) | |
2569 | auto_rewrite = False |
|
2569 | auto_rewrite = False | |
2570 | else: |
|
2570 | else: | |
2571 | if not force_auto and theRest.startswith('['): |
|
2571 | if not force_auto and theRest.startswith('['): | |
2572 | if hasattr(obj,'__getitem__'): |
|
2572 | if hasattr(obj,'__getitem__'): | |
2573 | # Don't autocall in this case: item access for an object |
|
2573 | # Don't autocall in this case: item access for an object | |
2574 | # which is BOTH callable and implements __getitem__. |
|
2574 | # which is BOTH callable and implements __getitem__. | |
2575 | newcmd = '%s %s' % (iFun,theRest) |
|
2575 | newcmd = '%s %s' % (iFun,theRest) | |
2576 | auto_rewrite = False |
|
2576 | auto_rewrite = False | |
2577 | else: |
|
2577 | else: | |
2578 | # if the object doesn't support [] access, go ahead and |
|
2578 | # if the object doesn't support [] access, go ahead and | |
2579 | # autocall |
|
2579 | # autocall | |
2580 | newcmd = '%s(%s)' % (iFun.rstrip(),theRest) |
|
2580 | newcmd = '%s(%s)' % (iFun.rstrip(),theRest) | |
2581 | elif theRest.endswith(';'): |
|
2581 | elif theRest.endswith(';'): | |
2582 | newcmd = '%s(%s);' % (iFun.rstrip(),theRest[:-1]) |
|
2582 | newcmd = '%s(%s);' % (iFun.rstrip(),theRest[:-1]) | |
2583 | else: |
|
2583 | else: | |
2584 | newcmd = '%s(%s)' % (iFun.rstrip(), theRest) |
|
2584 | newcmd = '%s(%s)' % (iFun.rstrip(), theRest) | |
2585 |
|
2585 | |||
2586 | if auto_rewrite: |
|
2586 | if auto_rewrite: | |
2587 | rw = self.outputcache.prompt1.auto_rewrite() + newcmd |
|
2587 | rw = self.outputcache.prompt1.auto_rewrite() + newcmd | |
2588 |
|
2588 | |||
2589 | try: |
|
2589 | try: | |
2590 | # plain ascii works better w/ pyreadline, on some machines, so |
|
2590 | # plain ascii works better w/ pyreadline, on some machines, so | |
2591 | # we use it and only print uncolored rewrite if we have unicode |
|
2591 | # we use it and only print uncolored rewrite if we have unicode | |
2592 | rw = str(rw) |
|
2592 | rw = str(rw) | |
2593 | print >>Term.cout, rw |
|
2593 | print >>Term.cout, rw | |
2594 | except UnicodeEncodeError: |
|
2594 | except UnicodeEncodeError: | |
2595 | print "-------------->" + newcmd |
|
2595 | print "-------------->" + newcmd | |
2596 |
|
2596 | |||
2597 | # log what is now valid Python, not the actual user input (without the |
|
2597 | # log what is now valid Python, not the actual user input (without the | |
2598 | # final newline) |
|
2598 | # final newline) | |
2599 | self.log(line,newcmd,continue_prompt) |
|
2599 | self.log(line,newcmd,continue_prompt) | |
2600 | return newcmd |
|
2600 | return newcmd | |
2601 |
|
2601 | |||
2602 | def handle_help(self, line_info): |
|
2602 | def handle_help(self, line_info): | |
2603 | """Try to get some help for the object. |
|
2603 | """Try to get some help for the object. | |
2604 |
|
2604 | |||
2605 | obj? or ?obj -> basic information. |
|
2605 | obj? or ?obj -> basic information. | |
2606 | obj?? or ??obj -> more details. |
|
2606 | obj?? or ??obj -> more details. | |
2607 | """ |
|
2607 | """ | |
2608 |
|
2608 | |||
2609 | line = line_info.line |
|
2609 | line = line_info.line | |
2610 | # We need to make sure that we don't process lines which would be |
|
2610 | # We need to make sure that we don't process lines which would be | |
2611 | # otherwise valid python, such as "x=1 # what?" |
|
2611 | # otherwise valid python, such as "x=1 # what?" | |
2612 | try: |
|
2612 | try: | |
2613 | codeop.compile_command(line) |
|
2613 | codeop.compile_command(line) | |
2614 | except SyntaxError: |
|
2614 | except SyntaxError: | |
2615 | # We should only handle as help stuff which is NOT valid syntax |
|
2615 | # We should only handle as help stuff which is NOT valid syntax | |
2616 | if line[0]==self.ESC_HELP: |
|
2616 | if line[0]==self.ESC_HELP: | |
2617 | line = line[1:] |
|
2617 | line = line[1:] | |
2618 | elif line[-1]==self.ESC_HELP: |
|
2618 | elif line[-1]==self.ESC_HELP: | |
2619 | line = line[:-1] |
|
2619 | line = line[:-1] | |
2620 | self.log(line,'#?'+line,line_info.continue_prompt) |
|
2620 | self.log(line,'#?'+line,line_info.continue_prompt) | |
2621 | if line: |
|
2621 | if line: | |
2622 | #print 'line:<%r>' % line # dbg |
|
2622 | #print 'line:<%r>' % line # dbg | |
2623 | self.magic_pinfo(line) |
|
2623 | self.magic_pinfo(line) | |
2624 | else: |
|
2624 | else: | |
2625 | page(self.usage,screen_lines=self.rc.screen_length) |
|
2625 | page(self.usage,screen_lines=self.rc.screen_length) | |
2626 | return '' # Empty string is needed here! |
|
2626 | return '' # Empty string is needed here! | |
2627 | except: |
|
2627 | except: | |
2628 | # Pass any other exceptions through to the normal handler |
|
2628 | # Pass any other exceptions through to the normal handler | |
2629 | return self.handle_normal(line_info) |
|
2629 | return self.handle_normal(line_info) | |
2630 | else: |
|
2630 | else: | |
2631 | # If the code compiles ok, we should handle it normally |
|
2631 | # If the code compiles ok, we should handle it normally | |
2632 | return self.handle_normal(line_info) |
|
2632 | return self.handle_normal(line_info) | |
2633 |
|
2633 | |||
2634 | def getapi(self): |
|
2634 | def getapi(self): | |
2635 | """ Get an IPApi object for this shell instance |
|
2635 | """ Get an IPApi object for this shell instance | |
2636 |
|
2636 | |||
2637 | Getting an IPApi object is always preferable to accessing the shell |
|
2637 | Getting an IPApi object is always preferable to accessing the shell | |
2638 | directly, but this holds true especially for extensions. |
|
2638 | directly, but this holds true especially for extensions. | |
2639 |
|
2639 | |||
2640 | It should always be possible to implement an extension with IPApi |
|
2640 | It should always be possible to implement an extension with IPApi | |
2641 | alone. If not, contact maintainer to request an addition. |
|
2641 | alone. If not, contact maintainer to request an addition. | |
2642 |
|
2642 | |||
2643 | """ |
|
2643 | """ | |
2644 | return self.api |
|
2644 | return self.api | |
2645 |
|
2645 | |||
2646 | def handle_emacs(self, line_info): |
|
2646 | def handle_emacs(self, line_info): | |
2647 | """Handle input lines marked by python-mode.""" |
|
2647 | """Handle input lines marked by python-mode.""" | |
2648 |
|
2648 | |||
2649 | # Currently, nothing is done. Later more functionality can be added |
|
2649 | # Currently, nothing is done. Later more functionality can be added | |
2650 | # here if needed. |
|
2650 | # here if needed. | |
2651 |
|
2651 | |||
2652 | # The input cache shouldn't be updated |
|
2652 | # The input cache shouldn't be updated | |
2653 | return line_info.line |
|
2653 | return line_info.line | |
2654 |
|
2654 | |||
2655 |
|
2655 | |||
2656 | def mktempfile(self,data=None): |
|
2656 | def mktempfile(self,data=None): | |
2657 | """Make a new tempfile and return its filename. |
|
2657 | """Make a new tempfile and return its filename. | |
2658 |
|
2658 | |||
2659 | This makes a call to tempfile.mktemp, but it registers the created |
|
2659 | This makes a call to tempfile.mktemp, but it registers the created | |
2660 | filename internally so ipython cleans it up at exit time. |
|
2660 | filename internally so ipython cleans it up at exit time. | |
2661 |
|
2661 | |||
2662 | Optional inputs: |
|
2662 | Optional inputs: | |
2663 |
|
2663 | |||
2664 | - data(None): if data is given, it gets written out to the temp file |
|
2664 | - data(None): if data is given, it gets written out to the temp file | |
2665 | immediately, and the file is closed again.""" |
|
2665 | immediately, and the file is closed again.""" | |
2666 |
|
2666 | |||
2667 | filename = tempfile.mktemp('.py','ipython_edit_') |
|
2667 | filename = tempfile.mktemp('.py','ipython_edit_') | |
2668 | self.tempfiles.append(filename) |
|
2668 | self.tempfiles.append(filename) | |
2669 |
|
2669 | |||
2670 | if data: |
|
2670 | if data: | |
2671 | tmp_file = open(filename,'w') |
|
2671 | tmp_file = open(filename,'w') | |
2672 | tmp_file.write(data) |
|
2672 | tmp_file.write(data) | |
2673 | tmp_file.close() |
|
2673 | tmp_file.close() | |
2674 | return filename |
|
2674 | return filename | |
2675 |
|
2675 | |||
2676 | def write(self,data): |
|
2676 | def write(self,data): | |
2677 | """Write a string to the default output""" |
|
2677 | """Write a string to the default output""" | |
2678 | Term.cout.write(data) |
|
2678 | Term.cout.write(data) | |
2679 |
|
2679 | |||
2680 | def write_err(self,data): |
|
2680 | def write_err(self,data): | |
2681 | """Write a string to the default error output""" |
|
2681 | """Write a string to the default error output""" | |
2682 | Term.cerr.write(data) |
|
2682 | Term.cerr.write(data) | |
2683 |
|
2683 | |||
2684 | def ask_exit(self): |
|
2684 | def ask_exit(self): | |
2685 | """ Call for exiting. Can be overiden and used as a callback. """ |
|
2685 | """ Call for exiting. Can be overiden and used as a callback. """ | |
2686 | self.exit_now = True |
|
2686 | self.exit_now = True | |
2687 |
|
2687 | |||
2688 | def exit(self): |
|
2688 | def exit(self): | |
2689 | """Handle interactive exit. |
|
2689 | """Handle interactive exit. | |
2690 |
|
2690 | |||
2691 | This method calls the ask_exit callback.""" |
|
2691 | This method calls the ask_exit callback.""" | |
2692 |
|
2692 | |||
2693 | if self.rc.confirm_exit: |
|
2693 | if self.rc.confirm_exit: | |
2694 | if self.ask_yes_no('Do you really want to exit ([y]/n)?','y'): |
|
2694 | if self.ask_yes_no('Do you really want to exit ([y]/n)?','y'): | |
2695 | self.ask_exit() |
|
2695 | self.ask_exit() | |
2696 | else: |
|
2696 | else: | |
2697 | self.ask_exit() |
|
2697 | self.ask_exit() | |
2698 |
|
2698 | |||
2699 | def safe_execfile(self,fname,*where,**kw): |
|
2699 | def safe_execfile(self,fname,*where,**kw): | |
2700 | """A safe version of the builtin execfile(). |
|
2700 | """A safe version of the builtin execfile(). | |
2701 |
|
2701 | |||
2702 | This version will never throw an exception, and knows how to handle |
|
2702 | This version will never throw an exception, and knows how to handle | |
2703 | ipython logs as well. |
|
2703 | ipython logs as well. | |
2704 |
|
2704 | |||
2705 | :Parameters: |
|
2705 | :Parameters: | |
2706 | fname : string |
|
2706 | fname : string | |
2707 | Name of the file to be executed. |
|
2707 | Name of the file to be executed. | |
2708 |
|
2708 | |||
2709 | where : tuple |
|
2709 | where : tuple | |
2710 | One or two namespaces, passed to execfile() as (globals,locals). |
|
2710 | One or two namespaces, passed to execfile() as (globals,locals). | |
2711 | If only one is given, it is passed as both. |
|
2711 | If only one is given, it is passed as both. | |
2712 |
|
2712 | |||
2713 | :Keywords: |
|
2713 | :Keywords: | |
2714 | islog : boolean (False) |
|
2714 | islog : boolean (False) | |
2715 |
|
2715 | |||
2716 | quiet : boolean (True) |
|
2716 | quiet : boolean (True) | |
2717 |
|
2717 | |||
2718 | exit_ignore : boolean (False) |
|
2718 | exit_ignore : boolean (False) | |
2719 | """ |
|
2719 | """ | |
2720 |
|
2720 | |||
2721 | def syspath_cleanup(): |
|
2721 | def syspath_cleanup(): | |
2722 | """Internal cleanup routine for sys.path.""" |
|
2722 | """Internal cleanup routine for sys.path.""" | |
2723 | if add_dname: |
|
2723 | if add_dname: | |
2724 | try: |
|
2724 | try: | |
2725 | sys.path.remove(dname) |
|
2725 | sys.path.remove(dname) | |
2726 | except ValueError: |
|
2726 | except ValueError: | |
2727 | # For some reason the user has already removed it, ignore. |
|
2727 | # For some reason the user has already removed it, ignore. | |
2728 | pass |
|
2728 | pass | |
2729 |
|
2729 | |||
2730 | fname = os.path.expanduser(fname) |
|
2730 | fname = os.path.expanduser(fname) | |
2731 |
|
2731 | |||
2732 | # Find things also in current directory. This is needed to mimic the |
|
2732 | # Find things also in current directory. This is needed to mimic the | |
2733 | # behavior of running a script from the system command line, where |
|
2733 | # behavior of running a script from the system command line, where | |
2734 | # Python inserts the script's directory into sys.path |
|
2734 | # Python inserts the script's directory into sys.path | |
2735 | dname = os.path.dirname(os.path.abspath(fname)) |
|
2735 | dname = os.path.dirname(os.path.abspath(fname)) | |
2736 | add_dname = False |
|
2736 | add_dname = False | |
2737 | if dname not in sys.path: |
|
2737 | if dname not in sys.path: | |
2738 | sys.path.insert(0,dname) |
|
2738 | sys.path.insert(0,dname) | |
2739 | add_dname = True |
|
2739 | add_dname = True | |
2740 |
|
2740 | |||
2741 | try: |
|
2741 | try: | |
2742 | xfile = open(fname) |
|
2742 | xfile = open(fname) | |
2743 | except: |
|
2743 | except: | |
2744 | print >> Term.cerr, \ |
|
2744 | print >> Term.cerr, \ | |
2745 | 'Could not open file <%s> for safe execution.' % fname |
|
2745 | 'Could not open file <%s> for safe execution.' % fname | |
2746 | syspath_cleanup() |
|
2746 | syspath_cleanup() | |
2747 | return None |
|
2747 | return None | |
2748 |
|
2748 | |||
2749 | kw.setdefault('islog',0) |
|
2749 | kw.setdefault('islog',0) | |
2750 | kw.setdefault('quiet',1) |
|
2750 | kw.setdefault('quiet',1) | |
2751 | kw.setdefault('exit_ignore',0) |
|
2751 | kw.setdefault('exit_ignore',0) | |
2752 |
|
2752 | |||
2753 | first = xfile.readline() |
|
2753 | first = xfile.readline() | |
2754 | loghead = str(self.loghead_tpl).split('\n',1)[0].strip() |
|
2754 | loghead = str(self.loghead_tpl).split('\n',1)[0].strip() | |
2755 | xfile.close() |
|
2755 | xfile.close() | |
2756 | # line by line execution |
|
2756 | # line by line execution | |
2757 | if first.startswith(loghead) or kw['islog']: |
|
2757 | if first.startswith(loghead) or kw['islog']: | |
2758 | print 'Loading log file <%s> one line at a time...' % fname |
|
2758 | print 'Loading log file <%s> one line at a time...' % fname | |
2759 | if kw['quiet']: |
|
2759 | if kw['quiet']: | |
2760 | stdout_save = sys.stdout |
|
2760 | stdout_save = sys.stdout | |
2761 | sys.stdout = StringIO.StringIO() |
|
2761 | sys.stdout = StringIO.StringIO() | |
2762 | try: |
|
2762 | try: | |
2763 | globs,locs = where[0:2] |
|
2763 | globs,locs = where[0:2] | |
2764 | except: |
|
2764 | except: | |
2765 | try: |
|
2765 | try: | |
2766 | globs = locs = where[0] |
|
2766 | globs = locs = where[0] | |
2767 | except: |
|
2767 | except: | |
2768 | globs = locs = globals() |
|
2768 | globs = locs = globals() | |
2769 | badblocks = [] |
|
2769 | badblocks = [] | |
2770 |
|
2770 | |||
2771 | # we also need to identify indented blocks of code when replaying |
|
2771 | # we also need to identify indented blocks of code when replaying | |
2772 | # logs and put them together before passing them to an exec |
|
2772 | # logs and put them together before passing them to an exec | |
2773 | # statement. This takes a bit of regexp and look-ahead work in the |
|
2773 | # statement. This takes a bit of regexp and look-ahead work in the | |
2774 | # file. It's easiest if we swallow the whole thing in memory |
|
2774 | # file. It's easiest if we swallow the whole thing in memory | |
2775 | # first, and manually walk through the lines list moving the |
|
2775 | # first, and manually walk through the lines list moving the | |
2776 | # counter ourselves. |
|
2776 | # counter ourselves. | |
2777 | indent_re = re.compile('\s+\S') |
|
2777 | indent_re = re.compile('\s+\S') | |
2778 | xfile = open(fname) |
|
2778 | xfile = open(fname) | |
2779 | filelines = xfile.readlines() |
|
2779 | filelines = xfile.readlines() | |
2780 | xfile.close() |
|
2780 | xfile.close() | |
2781 | nlines = len(filelines) |
|
2781 | nlines = len(filelines) | |
2782 | lnum = 0 |
|
2782 | lnum = 0 | |
2783 | while lnum < nlines: |
|
2783 | while lnum < nlines: | |
2784 | line = filelines[lnum] |
|
2784 | line = filelines[lnum] | |
2785 | lnum += 1 |
|
2785 | lnum += 1 | |
2786 | # don't re-insert logger status info into cache |
|
2786 | # don't re-insert logger status info into cache | |
2787 | if line.startswith('#log#'): |
|
2787 | if line.startswith('#log#'): | |
2788 | continue |
|
2788 | continue | |
2789 | else: |
|
2789 | else: | |
2790 | # build a block of code (maybe a single line) for execution |
|
2790 | # build a block of code (maybe a single line) for execution | |
2791 | block = line |
|
2791 | block = line | |
2792 | try: |
|
2792 | try: | |
2793 | next = filelines[lnum] # lnum has already incremented |
|
2793 | next = filelines[lnum] # lnum has already incremented | |
2794 | except: |
|
2794 | except: | |
2795 | next = None |
|
2795 | next = None | |
2796 | while next and indent_re.match(next): |
|
2796 | while next and indent_re.match(next): | |
2797 | block += next |
|
2797 | block += next | |
2798 | lnum += 1 |
|
2798 | lnum += 1 | |
2799 | try: |
|
2799 | try: | |
2800 | next = filelines[lnum] |
|
2800 | next = filelines[lnum] | |
2801 | except: |
|
2801 | except: | |
2802 | next = None |
|
2802 | next = None | |
2803 | # now execute the block of one or more lines |
|
2803 | # now execute the block of one or more lines | |
2804 | try: |
|
2804 | try: | |
2805 | exec block in globs,locs |
|
2805 | exec block in globs,locs | |
2806 | except SystemExit: |
|
2806 | except SystemExit: | |
2807 | pass |
|
2807 | pass | |
2808 | except: |
|
2808 | except: | |
2809 | badblocks.append(block.rstrip()) |
|
2809 | badblocks.append(block.rstrip()) | |
2810 | if kw['quiet']: # restore stdout |
|
2810 | if kw['quiet']: # restore stdout | |
2811 | sys.stdout.close() |
|
2811 | sys.stdout.close() | |
2812 | sys.stdout = stdout_save |
|
2812 | sys.stdout = stdout_save | |
2813 | print 'Finished replaying log file <%s>' % fname |
|
2813 | print 'Finished replaying log file <%s>' % fname | |
2814 | if badblocks: |
|
2814 | if badblocks: | |
2815 | print >> sys.stderr, ('\nThe following lines/blocks in file ' |
|
2815 | print >> sys.stderr, ('\nThe following lines/blocks in file ' | |
2816 | '<%s> reported errors:' % fname) |
|
2816 | '<%s> reported errors:' % fname) | |
2817 |
|
2817 | |||
2818 | for badline in badblocks: |
|
2818 | for badline in badblocks: | |
2819 | print >> sys.stderr, badline |
|
2819 | print >> sys.stderr, badline | |
2820 | else: # regular file execution |
|
2820 | else: # regular file execution | |
2821 | try: |
|
2821 | try: | |
2822 | if sys.platform == 'win32' and sys.version_info < (2,5,1): |
|
2822 | if sys.platform == 'win32' and sys.version_info < (2,5,1): | |
2823 | # Work around a bug in Python for Windows. The bug was |
|
2823 | # Work around a bug in Python for Windows. The bug was | |
2824 | # fixed in in Python 2.5 r54159 and 54158, but that's still |
|
2824 | # fixed in in Python 2.5 r54159 and 54158, but that's still | |
2825 | # SVN Python as of March/07. For details, see: |
|
2825 | # SVN Python as of March/07. For details, see: | |
2826 | # http://projects.scipy.org/ipython/ipython/ticket/123 |
|
2826 | # http://projects.scipy.org/ipython/ipython/ticket/123 | |
2827 | try: |
|
2827 | try: | |
2828 | globs,locs = where[0:2] |
|
2828 | globs,locs = where[0:2] | |
2829 | except: |
|
2829 | except: | |
2830 | try: |
|
2830 | try: | |
2831 | globs = locs = where[0] |
|
2831 | globs = locs = where[0] | |
2832 | except: |
|
2832 | except: | |
2833 | globs = locs = globals() |
|
2833 | globs = locs = globals() | |
2834 | exec file(fname) in globs,locs |
|
2834 | exec file(fname) in globs,locs | |
2835 | else: |
|
2835 | else: | |
2836 | execfile(fname,*where) |
|
2836 | execfile(fname,*where) | |
2837 | except SyntaxError: |
|
2837 | except SyntaxError: | |
2838 | self.showsyntaxerror() |
|
2838 | self.showsyntaxerror() | |
2839 | warn('Failure executing file: <%s>' % fname) |
|
2839 | warn('Failure executing file: <%s>' % fname) | |
2840 | except SystemExit,status: |
|
2840 | except SystemExit,status: | |
2841 | # Code that correctly sets the exit status flag to success (0) |
|
2841 | # Code that correctly sets the exit status flag to success (0) | |
2842 | # shouldn't be bothered with a traceback. Note that a plain |
|
2842 | # shouldn't be bothered with a traceback. Note that a plain | |
2843 | # sys.exit() does NOT set the message to 0 (it's empty) so that |
|
2843 | # sys.exit() does NOT set the message to 0 (it's empty) so that | |
2844 | # will still get a traceback. Note that the structure of the |
|
2844 | # will still get a traceback. Note that the structure of the | |
2845 | # SystemExit exception changed between Python 2.4 and 2.5, so |
|
2845 | # SystemExit exception changed between Python 2.4 and 2.5, so | |
2846 | # the checks must be done in a version-dependent way. |
|
2846 | # the checks must be done in a version-dependent way. | |
2847 | show = False |
|
2847 | show = False | |
2848 |
|
2848 | |||
2849 | if sys.version_info[:2] > (2,5): |
|
2849 | if sys.version_info[:2] > (2,5): | |
2850 | if status.message!=0 and not kw['exit_ignore']: |
|
2850 | if status.message!=0 and not kw['exit_ignore']: | |
2851 | show = True |
|
2851 | show = True | |
2852 | else: |
|
2852 | else: | |
2853 | if status.code and not kw['exit_ignore']: |
|
2853 | if status.code and not kw['exit_ignore']: | |
2854 | show = True |
|
2854 | show = True | |
2855 | if show: |
|
2855 | if show: | |
2856 | self.showtraceback() |
|
2856 | self.showtraceback() | |
2857 | warn('Failure executing file: <%s>' % fname) |
|
2857 | warn('Failure executing file: <%s>' % fname) | |
2858 | except: |
|
2858 | except: | |
2859 | self.showtraceback() |
|
2859 | self.showtraceback() | |
2860 | warn('Failure executing file: <%s>' % fname) |
|
2860 | warn('Failure executing file: <%s>' % fname) | |
2861 |
|
2861 | |||
2862 | syspath_cleanup() |
|
2862 | syspath_cleanup() | |
2863 |
|
2863 | |||
2864 | #************************* end of file <iplib.py> ***************************** |
|
2864 | #************************* end of file <iplib.py> ***************************** |
@@ -1,771 +1,771 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """ |
|
2 | """ | |
3 | IPython -- An enhanced Interactive Python |
|
3 | IPython -- An enhanced Interactive Python | |
4 |
|
4 | |||
5 | Requires Python 2.1 or better. |
|
5 | Requires Python 2.1 or better. | |
6 |
|
6 | |||
7 | This file contains the main make_IPython() starter function. |
|
7 | This file contains the main make_IPython() starter function. | |
8 | """ |
|
8 | """ | |
9 |
|
9 | |||
10 | #***************************************************************************** |
|
10 | #***************************************************************************** | |
11 | # Copyright (C) 2008-2009 The IPython Development Team |
|
11 | # Copyright (C) 2008-2009 The IPython Development Team | |
12 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> |
|
12 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> | |
13 | # |
|
13 | # | |
14 | # Distributed under the terms of the BSD License. The full license is in |
|
14 | # Distributed under the terms of the BSD License. The full license is in | |
15 | # the file COPYING, distributed as part of this software. |
|
15 | # the file COPYING, distributed as part of this software. | |
16 | #***************************************************************************** |
|
16 | #***************************************************************************** | |
17 |
|
17 | |||
18 | try: |
|
18 | try: | |
19 | credits._Printer__data = """ |
|
19 | credits._Printer__data = """ | |
20 | Python: %s |
|
20 | Python: %s | |
21 |
|
21 | |||
22 | IPython: The IPython Development Team. |
|
22 | IPython: The IPython Development Team. | |
23 | See http://ipython.scipy.org for more information.""" \ |
|
23 | See http://ipython.scipy.org for more information.""" \ | |
24 | % credits._Printer__data |
|
24 | % credits._Printer__data | |
25 |
|
25 | |||
26 | copyright._Printer__data += """ |
|
26 | copyright._Printer__data += """ | |
27 |
|
27 | |||
28 | Copyright (c) 2008-2009 The IPython Development Team. |
|
28 | Copyright (c) 2008-2009 The IPython Development Team. | |
29 | Copyright (c) 2001-2007 Fernando Perez, Janko Hauser, Nathan Gray. |
|
29 | Copyright (c) 2001-2007 Fernando Perez, Janko Hauser, Nathan Gray. | |
30 | All Rights Reserved.""" |
|
30 | All Rights Reserved.""" | |
31 | except NameError: |
|
31 | except NameError: | |
32 | # Can happen if ipython was started with 'python -S', so that site.py is |
|
32 | # Can happen if ipython was started with 'python -S', so that site.py is | |
33 | # not loaded |
|
33 | # not loaded | |
34 | pass |
|
34 | pass | |
35 |
|
35 | |||
36 | #**************************************************************************** |
|
36 | #**************************************************************************** | |
37 | # Required modules |
|
37 | # Required modules | |
38 |
|
38 | |||
39 | # From the standard library |
|
39 | # From the standard library | |
40 | import __main__ |
|
40 | import __main__ | |
41 | import __builtin__ |
|
41 | import __builtin__ | |
42 | import os |
|
42 | import os | |
43 | import sys |
|
43 | import sys | |
44 | from pprint import pprint |
|
44 | from pprint import pprint | |
45 |
|
45 | |||
46 | # Our own |
|
46 | # Our own | |
47 | from IPython.utils import DPyGetOpt |
|
47 | from IPython.utils import DPyGetOpt | |
48 | from IPython import Release |
|
48 | from IPython import Release | |
49 | from IPython.ipstruct import Struct |
|
49 | from IPython.utils.ipstruct import Struct | |
50 | from IPython.OutputTrap import OutputTrap |
|
50 | from IPython.OutputTrap import OutputTrap | |
51 | from IPython.config.configloader import ConfigLoader |
|
51 | from IPython.config.configloader import ConfigLoader | |
52 | from IPython.core.iplib import InteractiveShell |
|
52 | from IPython.core.iplib import InteractiveShell | |
53 | from IPython.usage import cmd_line_usage,interactive_usage |
|
53 | from IPython.usage import cmd_line_usage,interactive_usage | |
54 | from IPython.utils.genutils import * |
|
54 | from IPython.utils.genutils import * | |
55 |
|
55 | |||
56 | def force_import(modname,force_reload=False): |
|
56 | def force_import(modname,force_reload=False): | |
57 | if modname in sys.modules and force_reload: |
|
57 | if modname in sys.modules and force_reload: | |
58 | info("reloading: %s" % modname) |
|
58 | info("reloading: %s" % modname) | |
59 | reload(sys.modules[modname]) |
|
59 | reload(sys.modules[modname]) | |
60 | else: |
|
60 | else: | |
61 | __import__(modname) |
|
61 | __import__(modname) | |
62 |
|
62 | |||
63 |
|
63 | |||
64 | #----------------------------------------------------------------------------- |
|
64 | #----------------------------------------------------------------------------- | |
65 | def make_IPython(argv=None,user_ns=None,user_global_ns=None,debug=1, |
|
65 | def make_IPython(argv=None,user_ns=None,user_global_ns=None,debug=1, | |
66 | rc_override=None,shell_class=InteractiveShell, |
|
66 | rc_override=None,shell_class=InteractiveShell, | |
67 | embedded=False,**kw): |
|
67 | embedded=False,**kw): | |
68 | """This is a dump of IPython into a single function. |
|
68 | """This is a dump of IPython into a single function. | |
69 |
|
69 | |||
70 | Later it will have to be broken up in a sensible manner. |
|
70 | Later it will have to be broken up in a sensible manner. | |
71 |
|
71 | |||
72 | Arguments: |
|
72 | Arguments: | |
73 |
|
73 | |||
74 | - argv: a list similar to sys.argv[1:]. It should NOT contain the desired |
|
74 | - argv: a list similar to sys.argv[1:]. It should NOT contain the desired | |
75 | script name, b/c DPyGetOpt strips the first argument only for the real |
|
75 | script name, b/c DPyGetOpt strips the first argument only for the real | |
76 | sys.argv. |
|
76 | sys.argv. | |
77 |
|
77 | |||
78 | - user_ns: a dict to be used as the user's namespace.""" |
|
78 | - user_ns: a dict to be used as the user's namespace.""" | |
79 |
|
79 | |||
80 | #---------------------------------------------------------------------- |
|
80 | #---------------------------------------------------------------------- | |
81 | # Defaults and initialization |
|
81 | # Defaults and initialization | |
82 |
|
82 | |||
83 | # For developer debugging, deactivates crash handler and uses pdb. |
|
83 | # For developer debugging, deactivates crash handler and uses pdb. | |
84 | DEVDEBUG = False |
|
84 | DEVDEBUG = False | |
85 |
|
85 | |||
86 | if argv is None: |
|
86 | if argv is None: | |
87 | argv = sys.argv |
|
87 | argv = sys.argv | |
88 |
|
88 | |||
89 | # __IP is the main global that lives throughout and represents the whole |
|
89 | # __IP is the main global that lives throughout and represents the whole | |
90 | # application. If the user redefines it, all bets are off as to what |
|
90 | # application. If the user redefines it, all bets are off as to what | |
91 | # happens. |
|
91 | # happens. | |
92 |
|
92 | |||
93 | # __IP is the name of he global which the caller will have accessible as |
|
93 | # __IP is the name of he global which the caller will have accessible as | |
94 | # __IP.name. We set its name via the first parameter passed to |
|
94 | # __IP.name. We set its name via the first parameter passed to | |
95 | # InteractiveShell: |
|
95 | # InteractiveShell: | |
96 |
|
96 | |||
97 | IP = shell_class('__IP',user_ns=user_ns,user_global_ns=user_global_ns, |
|
97 | IP = shell_class('__IP',user_ns=user_ns,user_global_ns=user_global_ns, | |
98 | embedded=embedded,**kw) |
|
98 | embedded=embedded,**kw) | |
99 |
|
99 | |||
100 | # Put 'help' in the user namespace |
|
100 | # Put 'help' in the user namespace | |
101 | try: |
|
101 | try: | |
102 | from site import _Helper |
|
102 | from site import _Helper | |
103 | IP.user_ns['help'] = _Helper() |
|
103 | IP.user_ns['help'] = _Helper() | |
104 | except ImportError: |
|
104 | except ImportError: | |
105 | warn('help() not available - check site.py') |
|
105 | warn('help() not available - check site.py') | |
106 |
|
106 | |||
107 | if DEVDEBUG: |
|
107 | if DEVDEBUG: | |
108 | # For developer debugging only (global flag) |
|
108 | # For developer debugging only (global flag) | |
109 | from IPython import ultraTB |
|
109 | from IPython import ultraTB | |
110 | sys.excepthook = ultraTB.VerboseTB(call_pdb=1) |
|
110 | sys.excepthook = ultraTB.VerboseTB(call_pdb=1) | |
111 |
|
111 | |||
112 | IP.BANNER_PARTS = ['Python %s\n' |
|
112 | IP.BANNER_PARTS = ['Python %s\n' | |
113 | 'Type "copyright", "credits" or "license" ' |
|
113 | 'Type "copyright", "credits" or "license" ' | |
114 | 'for more information.\n' |
|
114 | 'for more information.\n' | |
115 | % (sys.version.split('\n')[0],), |
|
115 | % (sys.version.split('\n')[0],), | |
116 | "IPython %s -- An enhanced Interactive Python." |
|
116 | "IPython %s -- An enhanced Interactive Python." | |
117 | % (Release.version,), |
|
117 | % (Release.version,), | |
118 | """\ |
|
118 | """\ | |
119 | ? -> Introduction and overview of IPython's features. |
|
119 | ? -> Introduction and overview of IPython's features. | |
120 | %quickref -> Quick reference. |
|
120 | %quickref -> Quick reference. | |
121 | help -> Python's own help system. |
|
121 | help -> Python's own help system. | |
122 | object? -> Details about 'object'. ?object also works, ?? prints more. |
|
122 | object? -> Details about 'object'. ?object also works, ?? prints more. | |
123 | """ ] |
|
123 | """ ] | |
124 |
|
124 | |||
125 | IP.usage = interactive_usage |
|
125 | IP.usage = interactive_usage | |
126 |
|
126 | |||
127 | # Platform-dependent suffix. |
|
127 | # Platform-dependent suffix. | |
128 | if os.name == 'posix': |
|
128 | if os.name == 'posix': | |
129 | rc_suffix = '' |
|
129 | rc_suffix = '' | |
130 | else: |
|
130 | else: | |
131 | rc_suffix = '.ini' |
|
131 | rc_suffix = '.ini' | |
132 |
|
132 | |||
133 | # default directory for configuration |
|
133 | # default directory for configuration | |
134 | ipythondir_def = get_ipython_dir() |
|
134 | ipythondir_def = get_ipython_dir() | |
135 |
|
135 | |||
136 | sys.path.insert(0, '') # add . to sys.path. Fix from Prabhu Ramachandran |
|
136 | sys.path.insert(0, '') # add . to sys.path. Fix from Prabhu Ramachandran | |
137 |
|
137 | |||
138 | # we need the directory where IPython itself is installed |
|
138 | # we need the directory where IPython itself is installed | |
139 | import IPython |
|
139 | import IPython | |
140 | IPython_dir = os.path.dirname(IPython.__file__) |
|
140 | IPython_dir = os.path.dirname(IPython.__file__) | |
141 | del IPython |
|
141 | del IPython | |
142 |
|
142 | |||
143 | #------------------------------------------------------------------------- |
|
143 | #------------------------------------------------------------------------- | |
144 | # Command line handling |
|
144 | # Command line handling | |
145 |
|
145 | |||
146 | # Valid command line options (uses DPyGetOpt syntax, like Perl's |
|
146 | # Valid command line options (uses DPyGetOpt syntax, like Perl's | |
147 | # GetOpt::Long) |
|
147 | # GetOpt::Long) | |
148 |
|
148 | |||
149 | # Any key not listed here gets deleted even if in the file (like session |
|
149 | # Any key not listed here gets deleted even if in the file (like session | |
150 | # or profile). That's deliberate, to maintain the rc namespace clean. |
|
150 | # or profile). That's deliberate, to maintain the rc namespace clean. | |
151 |
|
151 | |||
152 | # Each set of options appears twice: under _conv only the names are |
|
152 | # Each set of options appears twice: under _conv only the names are | |
153 | # listed, indicating which type they must be converted to when reading the |
|
153 | # listed, indicating which type they must be converted to when reading the | |
154 | # ipythonrc file. And under DPyGetOpt they are listed with the regular |
|
154 | # ipythonrc file. And under DPyGetOpt they are listed with the regular | |
155 | # DPyGetOpt syntax (=s,=i,:f,etc). |
|
155 | # DPyGetOpt syntax (=s,=i,:f,etc). | |
156 |
|
156 | |||
157 | # Make sure there's a space before each end of line (they get auto-joined!) |
|
157 | # Make sure there's a space before each end of line (they get auto-joined!) | |
158 | cmdline_opts = ('autocall=i autoindent! automagic! banner! cache_size|cs=i ' |
|
158 | cmdline_opts = ('autocall=i autoindent! automagic! banner! cache_size|cs=i ' | |
159 | 'c=s classic|cl color_info! colors=s confirm_exit! ' |
|
159 | 'c=s classic|cl color_info! colors=s confirm_exit! ' | |
160 | 'debug! deep_reload! editor=s log|l messages! nosep ' |
|
160 | 'debug! deep_reload! editor=s log|l messages! nosep ' | |
161 | 'object_info_string_level=i pdb! ' |
|
161 | 'object_info_string_level=i pdb! ' | |
162 | 'pprint! prompt_in1|pi1=s prompt_in2|pi2=s prompt_out|po=s ' |
|
162 | 'pprint! prompt_in1|pi1=s prompt_in2|pi2=s prompt_out|po=s ' | |
163 | 'pydb! ' |
|
163 | 'pydb! ' | |
164 | 'pylab_import_all! ' |
|
164 | 'pylab_import_all! ' | |
165 | 'quick screen_length|sl=i prompts_pad_left=i ' |
|
165 | 'quick screen_length|sl=i prompts_pad_left=i ' | |
166 | 'logfile|lf=s logplay|lp=s profile|p=s ' |
|
166 | 'logfile|lf=s logplay|lp=s profile|p=s ' | |
167 | 'readline! readline_merge_completions! ' |
|
167 | 'readline! readline_merge_completions! ' | |
168 | 'readline_omit__names! ' |
|
168 | 'readline_omit__names! ' | |
169 | 'rcfile=s separate_in|si=s separate_out|so=s ' |
|
169 | 'rcfile=s separate_in|si=s separate_out|so=s ' | |
170 | 'separate_out2|so2=s xmode=s wildcards_case_sensitive! ' |
|
170 | 'separate_out2|so2=s xmode=s wildcards_case_sensitive! ' | |
171 | 'magic_docstrings system_verbose! ' |
|
171 | 'magic_docstrings system_verbose! ' | |
172 | 'multi_line_specials! ' |
|
172 | 'multi_line_specials! ' | |
173 | 'term_title! wxversion=s ' |
|
173 | 'term_title! wxversion=s ' | |
174 | 'autoedit_syntax!') |
|
174 | 'autoedit_syntax!') | |
175 |
|
175 | |||
176 | # Options that can *only* appear at the cmd line (not in rcfiles). |
|
176 | # Options that can *only* appear at the cmd line (not in rcfiles). | |
177 |
|
177 | |||
178 | cmdline_only = ('help interact|i ipythondir=s Version upgrade ' |
|
178 | cmdline_only = ('help interact|i ipythondir=s Version upgrade ' | |
179 | 'gthread! qthread! q4thread! wthread! tkthread! pylab! tk! ' |
|
179 | 'gthread! qthread! q4thread! wthread! tkthread! pylab! tk! ' | |
180 | # 'twisted!' # disabled for now. |
|
180 | # 'twisted!' # disabled for now. | |
181 | ) |
|
181 | ) | |
182 |
|
182 | |||
183 | # Build the actual name list to be used by DPyGetOpt |
|
183 | # Build the actual name list to be used by DPyGetOpt | |
184 | opts_names = qw(cmdline_opts) + qw(cmdline_only) |
|
184 | opts_names = qw(cmdline_opts) + qw(cmdline_only) | |
185 |
|
185 | |||
186 | # Set sensible command line defaults. |
|
186 | # Set sensible command line defaults. | |
187 | # This should have everything from cmdline_opts and cmdline_only |
|
187 | # This should have everything from cmdline_opts and cmdline_only | |
188 | opts_def = Struct(autocall = 1, |
|
188 | opts_def = Struct(autocall = 1, | |
189 | autoedit_syntax = 0, |
|
189 | autoedit_syntax = 0, | |
190 | autoindent = 0, |
|
190 | autoindent = 0, | |
191 | automagic = 1, |
|
191 | automagic = 1, | |
192 | autoexec = [], |
|
192 | autoexec = [], | |
193 | banner = 1, |
|
193 | banner = 1, | |
194 | c = '', |
|
194 | c = '', | |
195 | cache_size = 1000, |
|
195 | cache_size = 1000, | |
196 | classic = 0, |
|
196 | classic = 0, | |
197 | color_info = 0, |
|
197 | color_info = 0, | |
198 | colors = 'NoColor', |
|
198 | colors = 'NoColor', | |
199 | confirm_exit = 1, |
|
199 | confirm_exit = 1, | |
200 | debug = 0, |
|
200 | debug = 0, | |
201 | deep_reload = 0, |
|
201 | deep_reload = 0, | |
202 | editor = '0', |
|
202 | editor = '0', | |
203 | gthread = 0, |
|
203 | gthread = 0, | |
204 | help = 0, |
|
204 | help = 0, | |
205 | interact = 0, |
|
205 | interact = 0, | |
206 | ipythondir = ipythondir_def, |
|
206 | ipythondir = ipythondir_def, | |
207 | log = 0, |
|
207 | log = 0, | |
208 | logfile = '', |
|
208 | logfile = '', | |
209 | logplay = '', |
|
209 | logplay = '', | |
210 | messages = 1, |
|
210 | messages = 1, | |
211 | multi_line_specials = 1, |
|
211 | multi_line_specials = 1, | |
212 | nosep = 0, |
|
212 | nosep = 0, | |
213 | object_info_string_level = 0, |
|
213 | object_info_string_level = 0, | |
214 | pdb = 0, |
|
214 | pdb = 0, | |
215 | pprint = 0, |
|
215 | pprint = 0, | |
216 | profile = '', |
|
216 | profile = '', | |
217 | prompt_in1 = 'In [\\#]: ', |
|
217 | prompt_in1 = 'In [\\#]: ', | |
218 | prompt_in2 = ' .\\D.: ', |
|
218 | prompt_in2 = ' .\\D.: ', | |
219 | prompt_out = 'Out[\\#]: ', |
|
219 | prompt_out = 'Out[\\#]: ', | |
220 | prompts_pad_left = 1, |
|
220 | prompts_pad_left = 1, | |
221 | pydb = 0, |
|
221 | pydb = 0, | |
222 | pylab = 0, |
|
222 | pylab = 0, | |
223 | pylab_import_all = 1, |
|
223 | pylab_import_all = 1, | |
224 | q4thread = 0, |
|
224 | q4thread = 0, | |
225 | qthread = 0, |
|
225 | qthread = 0, | |
226 | quick = 0, |
|
226 | quick = 0, | |
227 | quiet = 0, |
|
227 | quiet = 0, | |
228 | rcfile = 'ipythonrc' + rc_suffix, |
|
228 | rcfile = 'ipythonrc' + rc_suffix, | |
229 | readline = 1, |
|
229 | readline = 1, | |
230 | readline_merge_completions = 1, |
|
230 | readline_merge_completions = 1, | |
231 | readline_omit__names = 0, |
|
231 | readline_omit__names = 0, | |
232 | screen_length = 0, |
|
232 | screen_length = 0, | |
233 | separate_in = '\n', |
|
233 | separate_in = '\n', | |
234 | separate_out = '\n', |
|
234 | separate_out = '\n', | |
235 | separate_out2 = '', |
|
235 | separate_out2 = '', | |
236 | system_header = 'IPython system call: ', |
|
236 | system_header = 'IPython system call: ', | |
237 | system_verbose = 0, |
|
237 | system_verbose = 0, | |
238 | term_title = 1, |
|
238 | term_title = 1, | |
239 | tk = 0, |
|
239 | tk = 0, | |
240 | #twisted= 0, # disabled for now |
|
240 | #twisted= 0, # disabled for now | |
241 | upgrade = 0, |
|
241 | upgrade = 0, | |
242 | Version = 0, |
|
242 | Version = 0, | |
243 | wildcards_case_sensitive = 1, |
|
243 | wildcards_case_sensitive = 1, | |
244 | wthread = 0, |
|
244 | wthread = 0, | |
245 | wxversion = '0', |
|
245 | wxversion = '0', | |
246 | xmode = 'Context', |
|
246 | xmode = 'Context', | |
247 | magic_docstrings = 0, # undocumented, for doc generation |
|
247 | magic_docstrings = 0, # undocumented, for doc generation | |
248 | ) |
|
248 | ) | |
249 |
|
249 | |||
250 | # Things that will *only* appear in rcfiles (not at the command line). |
|
250 | # Things that will *only* appear in rcfiles (not at the command line). | |
251 | # Make sure there's a space before each end of line (they get auto-joined!) |
|
251 | # Make sure there's a space before each end of line (they get auto-joined!) | |
252 | rcfile_opts = { qwflat: 'include import_mod import_all execfile ', |
|
252 | rcfile_opts = { qwflat: 'include import_mod import_all execfile ', | |
253 | qw_lol: 'import_some ', |
|
253 | qw_lol: 'import_some ', | |
254 | # for things with embedded whitespace: |
|
254 | # for things with embedded whitespace: | |
255 | list_strings:'execute alias readline_parse_and_bind ', |
|
255 | list_strings:'execute alias readline_parse_and_bind ', | |
256 | # Regular strings need no conversion: |
|
256 | # Regular strings need no conversion: | |
257 | None:'readline_remove_delims ', |
|
257 | None:'readline_remove_delims ', | |
258 | } |
|
258 | } | |
259 | # Default values for these |
|
259 | # Default values for these | |
260 | rc_def = Struct(include = [], |
|
260 | rc_def = Struct(include = [], | |
261 | import_mod = [], |
|
261 | import_mod = [], | |
262 | import_all = [], |
|
262 | import_all = [], | |
263 | import_some = [[]], |
|
263 | import_some = [[]], | |
264 | execute = [], |
|
264 | execute = [], | |
265 | execfile = [], |
|
265 | execfile = [], | |
266 | alias = [], |
|
266 | alias = [], | |
267 | readline_parse_and_bind = [], |
|
267 | readline_parse_and_bind = [], | |
268 | readline_remove_delims = '', |
|
268 | readline_remove_delims = '', | |
269 | ) |
|
269 | ) | |
270 |
|
270 | |||
271 | # Build the type conversion dictionary from the above tables: |
|
271 | # Build the type conversion dictionary from the above tables: | |
272 | typeconv = rcfile_opts.copy() |
|
272 | typeconv = rcfile_opts.copy() | |
273 | typeconv.update(optstr2types(cmdline_opts)) |
|
273 | typeconv.update(optstr2types(cmdline_opts)) | |
274 |
|
274 | |||
275 | # FIXME: the None key appears in both, put that back together by hand. Ugly! |
|
275 | # FIXME: the None key appears in both, put that back together by hand. Ugly! | |
276 | typeconv[None] += ' ' + rcfile_opts[None] |
|
276 | typeconv[None] += ' ' + rcfile_opts[None] | |
277 |
|
277 | |||
278 | # Remove quotes at ends of all strings (used to protect spaces) |
|
278 | # Remove quotes at ends of all strings (used to protect spaces) | |
279 | typeconv[unquote_ends] = typeconv[None] |
|
279 | typeconv[unquote_ends] = typeconv[None] | |
280 | del typeconv[None] |
|
280 | del typeconv[None] | |
281 |
|
281 | |||
282 | # Build the list we'll use to make all config decisions with defaults: |
|
282 | # Build the list we'll use to make all config decisions with defaults: | |
283 | opts_all = opts_def.copy() |
|
283 | opts_all = opts_def.copy() | |
284 | opts_all.update(rc_def) |
|
284 | opts_all.update(rc_def) | |
285 |
|
285 | |||
286 | # Build conflict resolver for recursive loading of config files: |
|
286 | # Build conflict resolver for recursive loading of config files: | |
287 | # - preserve means the outermost file maintains the value, it is not |
|
287 | # - preserve means the outermost file maintains the value, it is not | |
288 | # overwritten if an included file has the same key. |
|
288 | # overwritten if an included file has the same key. | |
289 | # - add_flip applies + to the two values, so it better make sense to add |
|
289 | # - add_flip applies + to the two values, so it better make sense to add | |
290 | # those types of keys. But it flips them first so that things loaded |
|
290 | # those types of keys. But it flips them first so that things loaded | |
291 | # deeper in the inclusion chain have lower precedence. |
|
291 | # deeper in the inclusion chain have lower precedence. | |
292 | conflict = {'preserve': ' '.join([ typeconv[int], |
|
292 | conflict = {'preserve': ' '.join([ typeconv[int], | |
293 | typeconv[unquote_ends] ]), |
|
293 | typeconv[unquote_ends] ]), | |
294 | 'add_flip': ' '.join([ typeconv[qwflat], |
|
294 | 'add_flip': ' '.join([ typeconv[qwflat], | |
295 | typeconv[qw_lol], |
|
295 | typeconv[qw_lol], | |
296 | typeconv[list_strings] ]) |
|
296 | typeconv[list_strings] ]) | |
297 | } |
|
297 | } | |
298 |
|
298 | |||
299 | # Now actually process the command line |
|
299 | # Now actually process the command line | |
300 | getopt = DPyGetOpt.DPyGetOpt() |
|
300 | getopt = DPyGetOpt.DPyGetOpt() | |
301 | getopt.setIgnoreCase(0) |
|
301 | getopt.setIgnoreCase(0) | |
302 |
|
302 | |||
303 | getopt.parseConfiguration(opts_names) |
|
303 | getopt.parseConfiguration(opts_names) | |
304 |
|
304 | |||
305 | try: |
|
305 | try: | |
306 | getopt.processArguments(argv) |
|
306 | getopt.processArguments(argv) | |
307 | except DPyGetOpt.ArgumentError, exc: |
|
307 | except DPyGetOpt.ArgumentError, exc: | |
308 | print cmd_line_usage |
|
308 | print cmd_line_usage | |
309 | warn('\nError in Arguments: "%s"' % exc) |
|
309 | warn('\nError in Arguments: "%s"' % exc) | |
310 | sys.exit(1) |
|
310 | sys.exit(1) | |
311 |
|
311 | |||
312 | # convert the options dict to a struct for much lighter syntax later |
|
312 | # convert the options dict to a struct for much lighter syntax later | |
313 | opts = Struct(getopt.optionValues) |
|
313 | opts = Struct(getopt.optionValues) | |
314 | args = getopt.freeValues |
|
314 | args = getopt.freeValues | |
315 |
|
315 | |||
316 | # this is the struct (which has default values at this point) with which |
|
316 | # this is the struct (which has default values at this point) with which | |
317 | # we make all decisions: |
|
317 | # we make all decisions: | |
318 | opts_all.update(opts) |
|
318 | opts_all.update(opts) | |
319 |
|
319 | |||
320 | # Options that force an immediate exit |
|
320 | # Options that force an immediate exit | |
321 | if opts_all.help: |
|
321 | if opts_all.help: | |
322 | page(cmd_line_usage) |
|
322 | page(cmd_line_usage) | |
323 | sys.exit() |
|
323 | sys.exit() | |
324 |
|
324 | |||
325 | if opts_all.Version: |
|
325 | if opts_all.Version: | |
326 | print Release.version |
|
326 | print Release.version | |
327 | sys.exit() |
|
327 | sys.exit() | |
328 |
|
328 | |||
329 | if opts_all.magic_docstrings: |
|
329 | if opts_all.magic_docstrings: | |
330 | IP.magic_magic('-latex') |
|
330 | IP.magic_magic('-latex') | |
331 | sys.exit() |
|
331 | sys.exit() | |
332 |
|
332 | |||
333 | # add personal ipythondir to sys.path so that users can put things in |
|
333 | # add personal ipythondir to sys.path so that users can put things in | |
334 | # there for customization |
|
334 | # there for customization | |
335 | sys.path.append(os.path.abspath(opts_all.ipythondir)) |
|
335 | sys.path.append(os.path.abspath(opts_all.ipythondir)) | |
336 |
|
336 | |||
337 | # Create user config directory if it doesn't exist. This must be done |
|
337 | # Create user config directory if it doesn't exist. This must be done | |
338 | # *after* getting the cmd line options. |
|
338 | # *after* getting the cmd line options. | |
339 | if not os.path.isdir(opts_all.ipythondir): |
|
339 | if not os.path.isdir(opts_all.ipythondir): | |
340 | IP.user_setup(opts_all.ipythondir,rc_suffix,'install') |
|
340 | IP.user_setup(opts_all.ipythondir,rc_suffix,'install') | |
341 |
|
341 | |||
342 | # upgrade user config files while preserving a copy of the originals |
|
342 | # upgrade user config files while preserving a copy of the originals | |
343 | if opts_all.upgrade: |
|
343 | if opts_all.upgrade: | |
344 | IP.user_setup(opts_all.ipythondir,rc_suffix,'upgrade') |
|
344 | IP.user_setup(opts_all.ipythondir,rc_suffix,'upgrade') | |
345 |
|
345 | |||
346 | # check mutually exclusive options in the *original* command line |
|
346 | # check mutually exclusive options in the *original* command line | |
347 | mutex_opts(opts,[qw('log logfile'),qw('rcfile profile'), |
|
347 | mutex_opts(opts,[qw('log logfile'),qw('rcfile profile'), | |
348 | qw('classic profile'),qw('classic rcfile')]) |
|
348 | qw('classic profile'),qw('classic rcfile')]) | |
349 |
|
349 | |||
350 | #--------------------------------------------------------------------------- |
|
350 | #--------------------------------------------------------------------------- | |
351 | # Log replay |
|
351 | # Log replay | |
352 |
|
352 | |||
353 | # if -logplay, we need to 'become' the other session. That basically means |
|
353 | # if -logplay, we need to 'become' the other session. That basically means | |
354 | # replacing the current command line environment with that of the old |
|
354 | # replacing the current command line environment with that of the old | |
355 | # session and moving on. |
|
355 | # session and moving on. | |
356 |
|
356 | |||
357 | # this is needed so that later we know we're in session reload mode, as |
|
357 | # this is needed so that later we know we're in session reload mode, as | |
358 | # opts_all will get overwritten: |
|
358 | # opts_all will get overwritten: | |
359 | load_logplay = 0 |
|
359 | load_logplay = 0 | |
360 |
|
360 | |||
361 | if opts_all.logplay: |
|
361 | if opts_all.logplay: | |
362 | load_logplay = opts_all.logplay |
|
362 | load_logplay = opts_all.logplay | |
363 | opts_debug_save = opts_all.debug |
|
363 | opts_debug_save = opts_all.debug | |
364 | try: |
|
364 | try: | |
365 | logplay = open(opts_all.logplay) |
|
365 | logplay = open(opts_all.logplay) | |
366 | except IOError: |
|
366 | except IOError: | |
367 | if opts_all.debug: IP.InteractiveTB() |
|
367 | if opts_all.debug: IP.InteractiveTB() | |
368 | warn('Could not open logplay file '+`opts_all.logplay`) |
|
368 | warn('Could not open logplay file '+`opts_all.logplay`) | |
369 | # restore state as if nothing had happened and move on, but make |
|
369 | # restore state as if nothing had happened and move on, but make | |
370 | # sure that later we don't try to actually load the session file |
|
370 | # sure that later we don't try to actually load the session file | |
371 | logplay = None |
|
371 | logplay = None | |
372 | load_logplay = 0 |
|
372 | load_logplay = 0 | |
373 | del opts_all.logplay |
|
373 | del opts_all.logplay | |
374 | else: |
|
374 | else: | |
375 | try: |
|
375 | try: | |
376 | logplay.readline() |
|
376 | logplay.readline() | |
377 | logplay.readline(); |
|
377 | logplay.readline(); | |
378 | # this reloads that session's command line |
|
378 | # this reloads that session's command line | |
379 | cmd = logplay.readline()[6:] |
|
379 | cmd = logplay.readline()[6:] | |
380 | exec cmd |
|
380 | exec cmd | |
381 | # restore the true debug flag given so that the process of |
|
381 | # restore the true debug flag given so that the process of | |
382 | # session loading itself can be monitored. |
|
382 | # session loading itself can be monitored. | |
383 | opts.debug = opts_debug_save |
|
383 | opts.debug = opts_debug_save | |
384 | # save the logplay flag so later we don't overwrite the log |
|
384 | # save the logplay flag so later we don't overwrite the log | |
385 | opts.logplay = load_logplay |
|
385 | opts.logplay = load_logplay | |
386 | # now we must update our own structure with defaults |
|
386 | # now we must update our own structure with defaults | |
387 | opts_all.update(opts) |
|
387 | opts_all.update(opts) | |
388 | # now load args |
|
388 | # now load args | |
389 | cmd = logplay.readline()[6:] |
|
389 | cmd = logplay.readline()[6:] | |
390 | exec cmd |
|
390 | exec cmd | |
391 | logplay.close() |
|
391 | logplay.close() | |
392 | except: |
|
392 | except: | |
393 | logplay.close() |
|
393 | logplay.close() | |
394 | if opts_all.debug: IP.InteractiveTB() |
|
394 | if opts_all.debug: IP.InteractiveTB() | |
395 | warn("Logplay file lacking full configuration information.\n" |
|
395 | warn("Logplay file lacking full configuration information.\n" | |
396 | "I'll try to read it, but some things may not work.") |
|
396 | "I'll try to read it, but some things may not work.") | |
397 |
|
397 | |||
398 | #------------------------------------------------------------------------- |
|
398 | #------------------------------------------------------------------------- | |
399 | # set up output traps: catch all output from files, being run, modules |
|
399 | # set up output traps: catch all output from files, being run, modules | |
400 | # loaded, etc. Then give it to the user in a clean form at the end. |
|
400 | # loaded, etc. Then give it to the user in a clean form at the end. | |
401 |
|
401 | |||
402 | msg_out = 'Output messages. ' |
|
402 | msg_out = 'Output messages. ' | |
403 | msg_err = 'Error messages. ' |
|
403 | msg_err = 'Error messages. ' | |
404 | msg_sep = '\n' |
|
404 | msg_sep = '\n' | |
405 | msg = Struct(config = OutputTrap('Configuration Loader',msg_out, |
|
405 | msg = Struct(config = OutputTrap('Configuration Loader',msg_out, | |
406 | msg_err,msg_sep,debug, |
|
406 | msg_err,msg_sep,debug, | |
407 | quiet_out=1), |
|
407 | quiet_out=1), | |
408 | user_exec = OutputTrap('User File Execution',msg_out, |
|
408 | user_exec = OutputTrap('User File Execution',msg_out, | |
409 | msg_err,msg_sep,debug), |
|
409 | msg_err,msg_sep,debug), | |
410 | logplay = OutputTrap('Log Loader',msg_out, |
|
410 | logplay = OutputTrap('Log Loader',msg_out, | |
411 | msg_err,msg_sep,debug), |
|
411 | msg_err,msg_sep,debug), | |
412 | summary = '' |
|
412 | summary = '' | |
413 | ) |
|
413 | ) | |
414 |
|
414 | |||
415 | #------------------------------------------------------------------------- |
|
415 | #------------------------------------------------------------------------- | |
416 | # Process user ipythonrc-type configuration files |
|
416 | # Process user ipythonrc-type configuration files | |
417 |
|
417 | |||
418 | # turn on output trapping and log to msg.config |
|
418 | # turn on output trapping and log to msg.config | |
419 | # remember that with debug on, trapping is actually disabled |
|
419 | # remember that with debug on, trapping is actually disabled | |
420 | msg.config.trap_all() |
|
420 | msg.config.trap_all() | |
421 |
|
421 | |||
422 | # look for rcfile in current or default directory |
|
422 | # look for rcfile in current or default directory | |
423 | try: |
|
423 | try: | |
424 | opts_all.rcfile = filefind(opts_all.rcfile,opts_all.ipythondir) |
|
424 | opts_all.rcfile = filefind(opts_all.rcfile,opts_all.ipythondir) | |
425 | except IOError: |
|
425 | except IOError: | |
426 | if opts_all.debug: IP.InteractiveTB() |
|
426 | if opts_all.debug: IP.InteractiveTB() | |
427 | warn('Configuration file %s not found. Ignoring request.' |
|
427 | warn('Configuration file %s not found. Ignoring request.' | |
428 | % (opts_all.rcfile) ) |
|
428 | % (opts_all.rcfile) ) | |
429 |
|
429 | |||
430 | # 'profiles' are a shorthand notation for config filenames |
|
430 | # 'profiles' are a shorthand notation for config filenames | |
431 | profile_handled_by_legacy = False |
|
431 | profile_handled_by_legacy = False | |
432 | if opts_all.profile: |
|
432 | if opts_all.profile: | |
433 |
|
433 | |||
434 | try: |
|
434 | try: | |
435 | opts_all.rcfile = filefind('ipythonrc-' + opts_all.profile |
|
435 | opts_all.rcfile = filefind('ipythonrc-' + opts_all.profile | |
436 | + rc_suffix, |
|
436 | + rc_suffix, | |
437 | opts_all.ipythondir) |
|
437 | opts_all.ipythondir) | |
438 | profile_handled_by_legacy = True |
|
438 | profile_handled_by_legacy = True | |
439 | except IOError: |
|
439 | except IOError: | |
440 | if opts_all.debug: IP.InteractiveTB() |
|
440 | if opts_all.debug: IP.InteractiveTB() | |
441 | opts.profile = '' # remove profile from options if invalid |
|
441 | opts.profile = '' # remove profile from options if invalid | |
442 | # We won't warn anymore, primary method is ipy_profile_PROFNAME |
|
442 | # We won't warn anymore, primary method is ipy_profile_PROFNAME | |
443 | # which does trigger a warning. |
|
443 | # which does trigger a warning. | |
444 |
|
444 | |||
445 | # load the config file |
|
445 | # load the config file | |
446 | rcfiledata = None |
|
446 | rcfiledata = None | |
447 | if opts_all.quick: |
|
447 | if opts_all.quick: | |
448 | print 'Launching IPython in quick mode. No config file read.' |
|
448 | print 'Launching IPython in quick mode. No config file read.' | |
449 | elif opts_all.rcfile: |
|
449 | elif opts_all.rcfile: | |
450 | try: |
|
450 | try: | |
451 | cfg_loader = ConfigLoader(conflict) |
|
451 | cfg_loader = ConfigLoader(conflict) | |
452 | rcfiledata = cfg_loader.load(opts_all.rcfile,typeconv, |
|
452 | rcfiledata = cfg_loader.load(opts_all.rcfile,typeconv, | |
453 | 'include',opts_all.ipythondir, |
|
453 | 'include',opts_all.ipythondir, | |
454 | purge = 1, |
|
454 | purge = 1, | |
455 | unique = conflict['preserve']) |
|
455 | unique = conflict['preserve']) | |
456 | except: |
|
456 | except: | |
457 | IP.InteractiveTB() |
|
457 | IP.InteractiveTB() | |
458 | warn('Problems loading configuration file '+ |
|
458 | warn('Problems loading configuration file '+ | |
459 | `opts_all.rcfile`+ |
|
459 | `opts_all.rcfile`+ | |
460 | '\nStarting with default -bare bones- configuration.') |
|
460 | '\nStarting with default -bare bones- configuration.') | |
461 | else: |
|
461 | else: | |
462 | warn('No valid configuration file found in either currrent directory\n'+ |
|
462 | warn('No valid configuration file found in either currrent directory\n'+ | |
463 | 'or in the IPython config. directory: '+`opts_all.ipythondir`+ |
|
463 | 'or in the IPython config. directory: '+`opts_all.ipythondir`+ | |
464 | '\nProceeding with internal defaults.') |
|
464 | '\nProceeding with internal defaults.') | |
465 |
|
465 | |||
466 | #------------------------------------------------------------------------ |
|
466 | #------------------------------------------------------------------------ | |
467 | # Set exception handlers in mode requested by user. |
|
467 | # Set exception handlers in mode requested by user. | |
468 | otrap = OutputTrap(trap_out=1) # trap messages from magic_xmode |
|
468 | otrap = OutputTrap(trap_out=1) # trap messages from magic_xmode | |
469 | IP.magic_xmode(opts_all.xmode) |
|
469 | IP.magic_xmode(opts_all.xmode) | |
470 | otrap.release_out() |
|
470 | otrap.release_out() | |
471 |
|
471 | |||
472 | #------------------------------------------------------------------------ |
|
472 | #------------------------------------------------------------------------ | |
473 | # Execute user config |
|
473 | # Execute user config | |
474 |
|
474 | |||
475 | # Create a valid config structure with the right precedence order: |
|
475 | # Create a valid config structure with the right precedence order: | |
476 | # defaults < rcfile < command line. This needs to be in the instance, so |
|
476 | # defaults < rcfile < command line. This needs to be in the instance, so | |
477 | # that method calls below that rely on it find it. |
|
477 | # that method calls below that rely on it find it. | |
478 | IP.rc = rc_def.copy() |
|
478 | IP.rc = rc_def.copy() | |
479 |
|
479 | |||
480 | # Work with a local alias inside this routine to avoid unnecessary |
|
480 | # Work with a local alias inside this routine to avoid unnecessary | |
481 | # attribute lookups. |
|
481 | # attribute lookups. | |
482 | IP_rc = IP.rc |
|
482 | IP_rc = IP.rc | |
483 |
|
483 | |||
484 | IP_rc.update(opts_def) |
|
484 | IP_rc.update(opts_def) | |
485 | if rcfiledata: |
|
485 | if rcfiledata: | |
486 | # now we can update |
|
486 | # now we can update | |
487 | IP_rc.update(rcfiledata) |
|
487 | IP_rc.update(rcfiledata) | |
488 | IP_rc.update(opts) |
|
488 | IP_rc.update(opts) | |
489 | IP_rc.update(rc_override) |
|
489 | IP_rc.update(rc_override) | |
490 |
|
490 | |||
491 | # Store the original cmd line for reference: |
|
491 | # Store the original cmd line for reference: | |
492 | IP_rc.opts = opts |
|
492 | IP_rc.opts = opts | |
493 | IP_rc.args = args |
|
493 | IP_rc.args = args | |
494 |
|
494 | |||
495 | # create a *runtime* Struct like rc for holding parameters which may be |
|
495 | # create a *runtime* Struct like rc for holding parameters which may be | |
496 | # created and/or modified by runtime user extensions. |
|
496 | # created and/or modified by runtime user extensions. | |
497 | IP.runtime_rc = Struct() |
|
497 | IP.runtime_rc = Struct() | |
498 |
|
498 | |||
499 | # from this point on, all config should be handled through IP_rc, |
|
499 | # from this point on, all config should be handled through IP_rc, | |
500 | # opts* shouldn't be used anymore. |
|
500 | # opts* shouldn't be used anymore. | |
501 |
|
501 | |||
502 |
|
502 | |||
503 | # update IP_rc with some special things that need manual |
|
503 | # update IP_rc with some special things that need manual | |
504 | # tweaks. Basically options which affect other options. I guess this |
|
504 | # tweaks. Basically options which affect other options. I guess this | |
505 | # should just be written so that options are fully orthogonal and we |
|
505 | # should just be written so that options are fully orthogonal and we | |
506 | # wouldn't worry about this stuff! |
|
506 | # wouldn't worry about this stuff! | |
507 |
|
507 | |||
508 | if IP_rc.classic: |
|
508 | if IP_rc.classic: | |
509 | IP_rc.quick = 1 |
|
509 | IP_rc.quick = 1 | |
510 | IP_rc.cache_size = 0 |
|
510 | IP_rc.cache_size = 0 | |
511 | IP_rc.pprint = 0 |
|
511 | IP_rc.pprint = 0 | |
512 | IP_rc.prompt_in1 = '>>> ' |
|
512 | IP_rc.prompt_in1 = '>>> ' | |
513 | IP_rc.prompt_in2 = '... ' |
|
513 | IP_rc.prompt_in2 = '... ' | |
514 | IP_rc.prompt_out = '' |
|
514 | IP_rc.prompt_out = '' | |
515 | IP_rc.separate_in = IP_rc.separate_out = IP_rc.separate_out2 = '0' |
|
515 | IP_rc.separate_in = IP_rc.separate_out = IP_rc.separate_out2 = '0' | |
516 | IP_rc.colors = 'NoColor' |
|
516 | IP_rc.colors = 'NoColor' | |
517 | IP_rc.xmode = 'Plain' |
|
517 | IP_rc.xmode = 'Plain' | |
518 |
|
518 | |||
519 | IP.pre_config_initialization() |
|
519 | IP.pre_config_initialization() | |
520 | # configure readline |
|
520 | # configure readline | |
521 |
|
521 | |||
522 | # update exception handlers with rc file status |
|
522 | # update exception handlers with rc file status | |
523 | otrap.trap_out() # I don't want these messages ever. |
|
523 | otrap.trap_out() # I don't want these messages ever. | |
524 | IP.magic_xmode(IP_rc.xmode) |
|
524 | IP.magic_xmode(IP_rc.xmode) | |
525 | otrap.release_out() |
|
525 | otrap.release_out() | |
526 |
|
526 | |||
527 | # activate logging if requested and not reloading a log |
|
527 | # activate logging if requested and not reloading a log | |
528 | if IP_rc.logplay: |
|
528 | if IP_rc.logplay: | |
529 | IP.magic_logstart(IP_rc.logplay + ' append') |
|
529 | IP.magic_logstart(IP_rc.logplay + ' append') | |
530 | elif IP_rc.logfile: |
|
530 | elif IP_rc.logfile: | |
531 | IP.magic_logstart(IP_rc.logfile) |
|
531 | IP.magic_logstart(IP_rc.logfile) | |
532 | elif IP_rc.log: |
|
532 | elif IP_rc.log: | |
533 | IP.magic_logstart() |
|
533 | IP.magic_logstart() | |
534 |
|
534 | |||
535 | # find user editor so that it we don't have to look it up constantly |
|
535 | # find user editor so that it we don't have to look it up constantly | |
536 | if IP_rc.editor.strip()=='0': |
|
536 | if IP_rc.editor.strip()=='0': | |
537 | try: |
|
537 | try: | |
538 | ed = os.environ['EDITOR'] |
|
538 | ed = os.environ['EDITOR'] | |
539 | except KeyError: |
|
539 | except KeyError: | |
540 | if os.name == 'posix': |
|
540 | if os.name == 'posix': | |
541 | ed = 'vi' # the only one guaranteed to be there! |
|
541 | ed = 'vi' # the only one guaranteed to be there! | |
542 | else: |
|
542 | else: | |
543 | ed = 'notepad' # same in Windows! |
|
543 | ed = 'notepad' # same in Windows! | |
544 | IP_rc.editor = ed |
|
544 | IP_rc.editor = ed | |
545 |
|
545 | |||
546 | # Keep track of whether this is an embedded instance or not (useful for |
|
546 | # Keep track of whether this is an embedded instance or not (useful for | |
547 | # post-mortems). |
|
547 | # post-mortems). | |
548 | IP_rc.embedded = IP.embedded |
|
548 | IP_rc.embedded = IP.embedded | |
549 |
|
549 | |||
550 | # Recursive reload |
|
550 | # Recursive reload | |
551 | try: |
|
551 | try: | |
552 | from IPython.lib import deepreload |
|
552 | from IPython.lib import deepreload | |
553 | if IP_rc.deep_reload: |
|
553 | if IP_rc.deep_reload: | |
554 | __builtin__.reload = deepreload.reload |
|
554 | __builtin__.reload = deepreload.reload | |
555 | else: |
|
555 | else: | |
556 | __builtin__.dreload = deepreload.reload |
|
556 | __builtin__.dreload = deepreload.reload | |
557 | del deepreload |
|
557 | del deepreload | |
558 | except ImportError: |
|
558 | except ImportError: | |
559 | pass |
|
559 | pass | |
560 |
|
560 | |||
561 | # Save the current state of our namespace so that the interactive shell |
|
561 | # Save the current state of our namespace so that the interactive shell | |
562 | # can later know which variables have been created by us from config files |
|
562 | # can later know which variables have been created by us from config files | |
563 | # and loading. This way, loading a file (in any way) is treated just like |
|
563 | # and loading. This way, loading a file (in any way) is treated just like | |
564 | # defining things on the command line, and %who works as expected. |
|
564 | # defining things on the command line, and %who works as expected. | |
565 |
|
565 | |||
566 | # DON'T do anything that affects the namespace beyond this point! |
|
566 | # DON'T do anything that affects the namespace beyond this point! | |
567 | IP.internal_ns.update(__main__.__dict__) |
|
567 | IP.internal_ns.update(__main__.__dict__) | |
568 |
|
568 | |||
569 | #IP.internal_ns.update(locals()) # so our stuff doesn't show up in %who |
|
569 | #IP.internal_ns.update(locals()) # so our stuff doesn't show up in %who | |
570 |
|
570 | |||
571 | # Now run through the different sections of the users's config |
|
571 | # Now run through the different sections of the users's config | |
572 | if IP_rc.debug: |
|
572 | if IP_rc.debug: | |
573 | print 'Trying to execute the following configuration structure:' |
|
573 | print 'Trying to execute the following configuration structure:' | |
574 | print '(Things listed first are deeper in the inclusion tree and get' |
|
574 | print '(Things listed first are deeper in the inclusion tree and get' | |
575 | print 'loaded first).\n' |
|
575 | print 'loaded first).\n' | |
576 | pprint(IP_rc.__dict__) |
|
576 | pprint(IP_rc.__dict__) | |
577 |
|
577 | |||
578 | for mod in IP_rc.import_mod: |
|
578 | for mod in IP_rc.import_mod: | |
579 | try: |
|
579 | try: | |
580 | exec 'import '+mod in IP.user_ns |
|
580 | exec 'import '+mod in IP.user_ns | |
581 | except : |
|
581 | except : | |
582 | IP.InteractiveTB() |
|
582 | IP.InteractiveTB() | |
583 | import_fail_info(mod) |
|
583 | import_fail_info(mod) | |
584 |
|
584 | |||
585 | for mod_fn in IP_rc.import_some: |
|
585 | for mod_fn in IP_rc.import_some: | |
586 | if not mod_fn == []: |
|
586 | if not mod_fn == []: | |
587 | mod,fn = mod_fn[0],','.join(mod_fn[1:]) |
|
587 | mod,fn = mod_fn[0],','.join(mod_fn[1:]) | |
588 | try: |
|
588 | try: | |
589 | exec 'from '+mod+' import '+fn in IP.user_ns |
|
589 | exec 'from '+mod+' import '+fn in IP.user_ns | |
590 | except : |
|
590 | except : | |
591 | IP.InteractiveTB() |
|
591 | IP.InteractiveTB() | |
592 | import_fail_info(mod,fn) |
|
592 | import_fail_info(mod,fn) | |
593 |
|
593 | |||
594 | for mod in IP_rc.import_all: |
|
594 | for mod in IP_rc.import_all: | |
595 | try: |
|
595 | try: | |
596 | exec 'from '+mod+' import *' in IP.user_ns |
|
596 | exec 'from '+mod+' import *' in IP.user_ns | |
597 | except : |
|
597 | except : | |
598 | IP.InteractiveTB() |
|
598 | IP.InteractiveTB() | |
599 | import_fail_info(mod) |
|
599 | import_fail_info(mod) | |
600 |
|
600 | |||
601 | for code in IP_rc.execute: |
|
601 | for code in IP_rc.execute: | |
602 | try: |
|
602 | try: | |
603 | exec code in IP.user_ns |
|
603 | exec code in IP.user_ns | |
604 | except: |
|
604 | except: | |
605 | IP.InteractiveTB() |
|
605 | IP.InteractiveTB() | |
606 | warn('Failure executing code: ' + `code`) |
|
606 | warn('Failure executing code: ' + `code`) | |
607 |
|
607 | |||
608 | # Execute the files the user wants in ipythonrc |
|
608 | # Execute the files the user wants in ipythonrc | |
609 | for file in IP_rc.execfile: |
|
609 | for file in IP_rc.execfile: | |
610 | try: |
|
610 | try: | |
611 | file = filefind(file,sys.path+[IPython_dir]) |
|
611 | file = filefind(file,sys.path+[IPython_dir]) | |
612 | except IOError: |
|
612 | except IOError: | |
613 | warn(itpl('File $file not found. Skipping it.')) |
|
613 | warn(itpl('File $file not found. Skipping it.')) | |
614 | else: |
|
614 | else: | |
615 | IP.safe_execfile(os.path.expanduser(file),IP.user_ns) |
|
615 | IP.safe_execfile(os.path.expanduser(file),IP.user_ns) | |
616 |
|
616 | |||
617 | # finally, try importing ipy_*_conf for final configuration |
|
617 | # finally, try importing ipy_*_conf for final configuration | |
618 | try: |
|
618 | try: | |
619 | import ipy_system_conf |
|
619 | import ipy_system_conf | |
620 | except ImportError: |
|
620 | except ImportError: | |
621 | if opts_all.debug: IP.InteractiveTB() |
|
621 | if opts_all.debug: IP.InteractiveTB() | |
622 | warn("Could not import 'ipy_system_conf'") |
|
622 | warn("Could not import 'ipy_system_conf'") | |
623 | except: |
|
623 | except: | |
624 | IP.InteractiveTB() |
|
624 | IP.InteractiveTB() | |
625 | import_fail_info('ipy_system_conf') |
|
625 | import_fail_info('ipy_system_conf') | |
626 |
|
626 | |||
627 | # only import prof module if ipythonrc-PROF was not found |
|
627 | # only import prof module if ipythonrc-PROF was not found | |
628 | if opts_all.profile and not profile_handled_by_legacy: |
|
628 | if opts_all.profile and not profile_handled_by_legacy: | |
629 | profmodname = 'ipy_profile_' + opts_all.profile |
|
629 | profmodname = 'ipy_profile_' + opts_all.profile | |
630 | try: |
|
630 | try: | |
631 | force_import(profmodname) |
|
631 | force_import(profmodname) | |
632 | except: |
|
632 | except: | |
633 | IP.InteractiveTB() |
|
633 | IP.InteractiveTB() | |
634 | print "Error importing",profmodname,\ |
|
634 | print "Error importing",profmodname,\ | |
635 | "- perhaps you should run %upgrade?" |
|
635 | "- perhaps you should run %upgrade?" | |
636 | import_fail_info(profmodname) |
|
636 | import_fail_info(profmodname) | |
637 | else: |
|
637 | else: | |
638 | opts.profile = opts_all.profile |
|
638 | opts.profile = opts_all.profile | |
639 | else: |
|
639 | else: | |
640 | force_import('ipy_profile_none') |
|
640 | force_import('ipy_profile_none') | |
641 | # XXX - this is wrong: ipy_user_conf should not be loaded unconditionally, |
|
641 | # XXX - this is wrong: ipy_user_conf should not be loaded unconditionally, | |
642 | # since the user could have specified a config file path by hand. |
|
642 | # since the user could have specified a config file path by hand. | |
643 | try: |
|
643 | try: | |
644 | force_import('ipy_user_conf') |
|
644 | force_import('ipy_user_conf') | |
645 | except: |
|
645 | except: | |
646 | conf = opts_all.ipythondir + "/ipy_user_conf.py" |
|
646 | conf = opts_all.ipythondir + "/ipy_user_conf.py" | |
647 | IP.InteractiveTB() |
|
647 | IP.InteractiveTB() | |
648 | if not os.path.isfile(conf): |
|
648 | if not os.path.isfile(conf): | |
649 | warn(conf + ' does not exist, please run %upgrade!') |
|
649 | warn(conf + ' does not exist, please run %upgrade!') | |
650 |
|
650 | |||
651 | import_fail_info("ipy_user_conf") |
|
651 | import_fail_info("ipy_user_conf") | |
652 |
|
652 | |||
653 | # Define the history file for saving commands in between sessions |
|
653 | # Define the history file for saving commands in between sessions | |
654 | try: |
|
654 | try: | |
655 | histfname = 'history-%s' % opts.profile |
|
655 | histfname = 'history-%s' % opts.profile | |
656 | except AttributeError: |
|
656 | except AttributeError: | |
657 | histfname = 'history' |
|
657 | histfname = 'history' | |
658 | IP.histfile = os.path.join(opts_all.ipythondir,histfname) |
|
658 | IP.histfile = os.path.join(opts_all.ipythondir,histfname) | |
659 |
|
659 | |||
660 | # finally, push the argv to options again to ensure highest priority |
|
660 | # finally, push the argv to options again to ensure highest priority | |
661 | IP_rc.update(opts) |
|
661 | IP_rc.update(opts) | |
662 |
|
662 | |||
663 | # release stdout and stderr and save config log into a global summary |
|
663 | # release stdout and stderr and save config log into a global summary | |
664 | msg.config.release_all() |
|
664 | msg.config.release_all() | |
665 | if IP_rc.messages: |
|
665 | if IP_rc.messages: | |
666 | msg.summary += msg.config.summary_all() |
|
666 | msg.summary += msg.config.summary_all() | |
667 |
|
667 | |||
668 | #------------------------------------------------------------------------ |
|
668 | #------------------------------------------------------------------------ | |
669 | # Setup interactive session |
|
669 | # Setup interactive session | |
670 |
|
670 | |||
671 | # Now we should be fully configured. We can then execute files or load |
|
671 | # Now we should be fully configured. We can then execute files or load | |
672 | # things only needed for interactive use. Then we'll open the shell. |
|
672 | # things only needed for interactive use. Then we'll open the shell. | |
673 |
|
673 | |||
674 | # Take a snapshot of the user namespace before opening the shell. That way |
|
674 | # Take a snapshot of the user namespace before opening the shell. That way | |
675 | # we'll be able to identify which things were interactively defined and |
|
675 | # we'll be able to identify which things were interactively defined and | |
676 | # which were defined through config files. |
|
676 | # which were defined through config files. | |
677 | IP.user_config_ns.update(IP.user_ns) |
|
677 | IP.user_config_ns.update(IP.user_ns) | |
678 |
|
678 | |||
679 | # Force reading a file as if it were a session log. Slower but safer. |
|
679 | # Force reading a file as if it were a session log. Slower but safer. | |
680 | if load_logplay: |
|
680 | if load_logplay: | |
681 | print 'Replaying log...' |
|
681 | print 'Replaying log...' | |
682 | try: |
|
682 | try: | |
683 | if IP_rc.debug: |
|
683 | if IP_rc.debug: | |
684 | logplay_quiet = 0 |
|
684 | logplay_quiet = 0 | |
685 | else: |
|
685 | else: | |
686 | logplay_quiet = 1 |
|
686 | logplay_quiet = 1 | |
687 |
|
687 | |||
688 | msg.logplay.trap_all() |
|
688 | msg.logplay.trap_all() | |
689 | IP.safe_execfile(load_logplay,IP.user_ns, |
|
689 | IP.safe_execfile(load_logplay,IP.user_ns, | |
690 | islog = 1, quiet = logplay_quiet) |
|
690 | islog = 1, quiet = logplay_quiet) | |
691 | msg.logplay.release_all() |
|
691 | msg.logplay.release_all() | |
692 | if IP_rc.messages: |
|
692 | if IP_rc.messages: | |
693 | msg.summary += msg.logplay.summary_all() |
|
693 | msg.summary += msg.logplay.summary_all() | |
694 | except: |
|
694 | except: | |
695 | warn('Problems replaying logfile %s.' % load_logplay) |
|
695 | warn('Problems replaying logfile %s.' % load_logplay) | |
696 | IP.InteractiveTB() |
|
696 | IP.InteractiveTB() | |
697 |
|
697 | |||
698 | # Load remaining files in command line |
|
698 | # Load remaining files in command line | |
699 | msg.user_exec.trap_all() |
|
699 | msg.user_exec.trap_all() | |
700 |
|
700 | |||
701 | # Do NOT execute files named in the command line as scripts to be loaded |
|
701 | # Do NOT execute files named in the command line as scripts to be loaded | |
702 | # by embedded instances. Doing so has the potential for an infinite |
|
702 | # by embedded instances. Doing so has the potential for an infinite | |
703 | # recursion if there are exceptions thrown in the process. |
|
703 | # recursion if there are exceptions thrown in the process. | |
704 |
|
704 | |||
705 | # XXX FIXME: the execution of user files should be moved out to after |
|
705 | # XXX FIXME: the execution of user files should be moved out to after | |
706 | # ipython is fully initialized, just as if they were run via %run at the |
|
706 | # ipython is fully initialized, just as if they were run via %run at the | |
707 | # ipython prompt. This would also give them the benefit of ipython's |
|
707 | # ipython prompt. This would also give them the benefit of ipython's | |
708 | # nice tracebacks. |
|
708 | # nice tracebacks. | |
709 |
|
709 | |||
710 | if (not embedded and IP_rc.args and |
|
710 | if (not embedded and IP_rc.args and | |
711 | not IP_rc.args[0].lower().endswith('.ipy')): |
|
711 | not IP_rc.args[0].lower().endswith('.ipy')): | |
712 | name_save = IP.user_ns['__name__'] |
|
712 | name_save = IP.user_ns['__name__'] | |
713 | IP.user_ns['__name__'] = '__main__' |
|
713 | IP.user_ns['__name__'] = '__main__' | |
714 | # Set our own excepthook in case the user code tries to call it |
|
714 | # Set our own excepthook in case the user code tries to call it | |
715 | # directly. This prevents triggering the IPython crash handler. |
|
715 | # directly. This prevents triggering the IPython crash handler. | |
716 | old_excepthook,sys.excepthook = sys.excepthook, IP.excepthook |
|
716 | old_excepthook,sys.excepthook = sys.excepthook, IP.excepthook | |
717 |
|
717 | |||
718 | save_argv = sys.argv[1:] # save it for later restoring |
|
718 | save_argv = sys.argv[1:] # save it for later restoring | |
719 |
|
719 | |||
720 | sys.argv = args |
|
720 | sys.argv = args | |
721 |
|
721 | |||
722 | try: |
|
722 | try: | |
723 | IP.safe_execfile(args[0], IP.user_ns) |
|
723 | IP.safe_execfile(args[0], IP.user_ns) | |
724 | finally: |
|
724 | finally: | |
725 | # Reset our crash handler in place |
|
725 | # Reset our crash handler in place | |
726 | sys.excepthook = old_excepthook |
|
726 | sys.excepthook = old_excepthook | |
727 | sys.argv[:] = save_argv |
|
727 | sys.argv[:] = save_argv | |
728 | IP.user_ns['__name__'] = name_save |
|
728 | IP.user_ns['__name__'] = name_save | |
729 |
|
729 | |||
730 | msg.user_exec.release_all() |
|
730 | msg.user_exec.release_all() | |
731 |
|
731 | |||
732 | if IP_rc.messages: |
|
732 | if IP_rc.messages: | |
733 | msg.summary += msg.user_exec.summary_all() |
|
733 | msg.summary += msg.user_exec.summary_all() | |
734 |
|
734 | |||
735 | # since we can't specify a null string on the cmd line, 0 is the equivalent: |
|
735 | # since we can't specify a null string on the cmd line, 0 is the equivalent: | |
736 | if IP_rc.nosep: |
|
736 | if IP_rc.nosep: | |
737 | IP_rc.separate_in = IP_rc.separate_out = IP_rc.separate_out2 = '0' |
|
737 | IP_rc.separate_in = IP_rc.separate_out = IP_rc.separate_out2 = '0' | |
738 | if IP_rc.separate_in == '0': IP_rc.separate_in = '' |
|
738 | if IP_rc.separate_in == '0': IP_rc.separate_in = '' | |
739 | if IP_rc.separate_out == '0': IP_rc.separate_out = '' |
|
739 | if IP_rc.separate_out == '0': IP_rc.separate_out = '' | |
740 | if IP_rc.separate_out2 == '0': IP_rc.separate_out2 = '' |
|
740 | if IP_rc.separate_out2 == '0': IP_rc.separate_out2 = '' | |
741 | IP_rc.separate_in = IP_rc.separate_in.replace('\\n','\n') |
|
741 | IP_rc.separate_in = IP_rc.separate_in.replace('\\n','\n') | |
742 | IP_rc.separate_out = IP_rc.separate_out.replace('\\n','\n') |
|
742 | IP_rc.separate_out = IP_rc.separate_out.replace('\\n','\n') | |
743 | IP_rc.separate_out2 = IP_rc.separate_out2.replace('\\n','\n') |
|
743 | IP_rc.separate_out2 = IP_rc.separate_out2.replace('\\n','\n') | |
744 |
|
744 | |||
745 | # Determine how many lines at the bottom of the screen are needed for |
|
745 | # Determine how many lines at the bottom of the screen are needed for | |
746 | # showing prompts, so we can know wheter long strings are to be printed or |
|
746 | # showing prompts, so we can know wheter long strings are to be printed or | |
747 | # paged: |
|
747 | # paged: | |
748 | num_lines_bot = IP_rc.separate_in.count('\n')+1 |
|
748 | num_lines_bot = IP_rc.separate_in.count('\n')+1 | |
749 | IP_rc.screen_length = IP_rc.screen_length - num_lines_bot |
|
749 | IP_rc.screen_length = IP_rc.screen_length - num_lines_bot | |
750 |
|
750 | |||
751 | # configure startup banner |
|
751 | # configure startup banner | |
752 | if IP_rc.c: # regular python doesn't print the banner with -c |
|
752 | if IP_rc.c: # regular python doesn't print the banner with -c | |
753 | IP_rc.banner = 0 |
|
753 | IP_rc.banner = 0 | |
754 | if IP_rc.banner: |
|
754 | if IP_rc.banner: | |
755 | BANN_P = IP.BANNER_PARTS |
|
755 | BANN_P = IP.BANNER_PARTS | |
756 | else: |
|
756 | else: | |
757 | BANN_P = [] |
|
757 | BANN_P = [] | |
758 |
|
758 | |||
759 | if IP_rc.profile: BANN_P.append('IPython profile: %s\n' % IP_rc.profile) |
|
759 | if IP_rc.profile: BANN_P.append('IPython profile: %s\n' % IP_rc.profile) | |
760 |
|
760 | |||
761 | # add message log (possibly empty) |
|
761 | # add message log (possibly empty) | |
762 | if msg.summary: BANN_P.append(msg.summary) |
|
762 | if msg.summary: BANN_P.append(msg.summary) | |
763 | # Final banner is a string |
|
763 | # Final banner is a string | |
764 | IP.BANNER = '\n'.join(BANN_P) |
|
764 | IP.BANNER = '\n'.join(BANN_P) | |
765 |
|
765 | |||
766 | # Finalize the IPython instance. This assumes the rc structure is fully |
|
766 | # Finalize the IPython instance. This assumes the rc structure is fully | |
767 | # in place. |
|
767 | # in place. | |
768 | IP.post_config_initialization() |
|
768 | IP.post_config_initialization() | |
769 |
|
769 | |||
770 | return IP |
|
770 | return IP | |
771 | #************************ end of file <ipmaker.py> ************************** |
|
771 | #************************ end of file <ipmaker.py> ************************** |
@@ -1,282 +1,282 b'' | |||||
1 | """Twisted shell support. |
|
1 | """Twisted shell support. | |
2 |
|
2 | |||
3 | XXX - This module is missing proper docs. |
|
3 | XXX - This module is missing proper docs. | |
4 | """ |
|
4 | """ | |
5 | import sys |
|
5 | import sys | |
6 |
|
6 | |||
7 | from twisted.internet import reactor, threads |
|
7 | from twisted.internet import reactor, threads | |
8 |
|
8 | |||
9 | from IPython.core.ipmaker import make_IPython |
|
9 | from IPython.core.ipmaker import make_IPython | |
10 | from IPython.core.iplib import InteractiveShell |
|
10 | from IPython.core.iplib import InteractiveShell | |
11 | from IPython.ipstruct import Struct |
|
11 | from IPython.utils.ipstruct import Struct | |
12 | import Queue,thread,threading,signal |
|
12 | import Queue,thread,threading,signal | |
13 | from signal import signal, SIGINT |
|
13 | from signal import signal, SIGINT | |
14 | from IPython.utils.genutils import Term,warn,error,flag_calls, ask_yes_no |
|
14 | from IPython.utils.genutils import Term,warn,error,flag_calls, ask_yes_no | |
15 | import shellglobals |
|
15 | import shellglobals | |
16 |
|
16 | |||
17 | def install_gtk2(): |
|
17 | def install_gtk2(): | |
18 | """ Install gtk2 reactor, needs to be called bef """ |
|
18 | """ Install gtk2 reactor, needs to be called bef """ | |
19 | from twisted.internet import gtk2reactor |
|
19 | from twisted.internet import gtk2reactor | |
20 | gtk2reactor.install() |
|
20 | gtk2reactor.install() | |
21 |
|
21 | |||
22 |
|
22 | |||
23 | def hijack_reactor(): |
|
23 | def hijack_reactor(): | |
24 | """Modifies Twisted's reactor with a dummy so user code does |
|
24 | """Modifies Twisted's reactor with a dummy so user code does | |
25 | not block IPython. This function returns the original |
|
25 | not block IPython. This function returns the original | |
26 | 'twisted.internet.reactor' that has been hijacked. |
|
26 | 'twisted.internet.reactor' that has been hijacked. | |
27 |
|
27 | |||
28 | NOTE: Make sure you call this *AFTER* you've installed |
|
28 | NOTE: Make sure you call this *AFTER* you've installed | |
29 | the reactor of your choice. |
|
29 | the reactor of your choice. | |
30 | """ |
|
30 | """ | |
31 | from twisted import internet |
|
31 | from twisted import internet | |
32 | orig_reactor = internet.reactor |
|
32 | orig_reactor = internet.reactor | |
33 |
|
33 | |||
34 | class DummyReactor(object): |
|
34 | class DummyReactor(object): | |
35 | def run(self): |
|
35 | def run(self): | |
36 | pass |
|
36 | pass | |
37 | def __getattr__(self, name): |
|
37 | def __getattr__(self, name): | |
38 | return getattr(orig_reactor, name) |
|
38 | return getattr(orig_reactor, name) | |
39 | def __setattr__(self, name, value): |
|
39 | def __setattr__(self, name, value): | |
40 | return setattr(orig_reactor, name, value) |
|
40 | return setattr(orig_reactor, name, value) | |
41 |
|
41 | |||
42 | internet.reactor = DummyReactor() |
|
42 | internet.reactor = DummyReactor() | |
43 | return orig_reactor |
|
43 | return orig_reactor | |
44 |
|
44 | |||
45 | class TwistedInteractiveShell(InteractiveShell): |
|
45 | class TwistedInteractiveShell(InteractiveShell): | |
46 | """Simple multi-threaded shell.""" |
|
46 | """Simple multi-threaded shell.""" | |
47 |
|
47 | |||
48 | # Threading strategy taken from: |
|
48 | # Threading strategy taken from: | |
49 | # http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/65109, by Brian |
|
49 | # http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/65109, by Brian | |
50 | # McErlean and John Finlay. Modified with corrections by Antoon Pardon, |
|
50 | # McErlean and John Finlay. Modified with corrections by Antoon Pardon, | |
51 | # from the pygtk mailing list, to avoid lockups with system calls. |
|
51 | # from the pygtk mailing list, to avoid lockups with system calls. | |
52 |
|
52 | |||
53 | # class attribute to indicate whether the class supports threads or not. |
|
53 | # class attribute to indicate whether the class supports threads or not. | |
54 | # Subclasses with thread support should override this as needed. |
|
54 | # Subclasses with thread support should override this as needed. | |
55 | isthreaded = True |
|
55 | isthreaded = True | |
56 |
|
56 | |||
57 | def __init__(self,name,usage=None,rc=Struct(opts=None,args=None), |
|
57 | def __init__(self,name,usage=None,rc=Struct(opts=None,args=None), | |
58 | user_ns=None,user_global_ns=None,banner2='',**kw): |
|
58 | user_ns=None,user_global_ns=None,banner2='',**kw): | |
59 | """Similar to the normal InteractiveShell, but with threading control""" |
|
59 | """Similar to the normal InteractiveShell, but with threading control""" | |
60 |
|
60 | |||
61 | InteractiveShell.__init__(self,name,usage,rc,user_ns, |
|
61 | InteractiveShell.__init__(self,name,usage,rc,user_ns, | |
62 | user_global_ns,banner2) |
|
62 | user_global_ns,banner2) | |
63 |
|
63 | |||
64 |
|
64 | |||
65 | # A queue to hold the code to be executed. |
|
65 | # A queue to hold the code to be executed. | |
66 | self.code_queue = Queue.Queue() |
|
66 | self.code_queue = Queue.Queue() | |
67 |
|
67 | |||
68 | # Stuff to do at closing time |
|
68 | # Stuff to do at closing time | |
69 | self._kill = None |
|
69 | self._kill = None | |
70 | on_kill = kw.get('on_kill', []) |
|
70 | on_kill = kw.get('on_kill', []) | |
71 | # Check that all things to kill are callable: |
|
71 | # Check that all things to kill are callable: | |
72 | for t in on_kill: |
|
72 | for t in on_kill: | |
73 | if not callable(t): |
|
73 | if not callable(t): | |
74 | raise TypeError,'on_kill must be a list of callables' |
|
74 | raise TypeError,'on_kill must be a list of callables' | |
75 | self.on_kill = on_kill |
|
75 | self.on_kill = on_kill | |
76 | # thread identity of the "worker thread" (that may execute code directly) |
|
76 | # thread identity of the "worker thread" (that may execute code directly) | |
77 | self.worker_ident = None |
|
77 | self.worker_ident = None | |
78 | self.reactor_started = False |
|
78 | self.reactor_started = False | |
79 | self.first_run = True |
|
79 | self.first_run = True | |
80 |
|
80 | |||
81 | def runsource(self, source, filename="<input>", symbol="single"): |
|
81 | def runsource(self, source, filename="<input>", symbol="single"): | |
82 | """Compile and run some source in the interpreter. |
|
82 | """Compile and run some source in the interpreter. | |
83 |
|
83 | |||
84 | Modified version of code.py's runsource(), to handle threading issues. |
|
84 | Modified version of code.py's runsource(), to handle threading issues. | |
85 | See the original for full docstring details.""" |
|
85 | See the original for full docstring details.""" | |
86 |
|
86 | |||
87 | # If Ctrl-C was typed, we reset the flag and return right away |
|
87 | # If Ctrl-C was typed, we reset the flag and return right away | |
88 | if shellglobals.KBINT: |
|
88 | if shellglobals.KBINT: | |
89 | shellglobals.KBINT = False |
|
89 | shellglobals.KBINT = False | |
90 | return False |
|
90 | return False | |
91 |
|
91 | |||
92 | if self._kill: |
|
92 | if self._kill: | |
93 | # can't queue new code if we are being killed |
|
93 | # can't queue new code if we are being killed | |
94 | return True |
|
94 | return True | |
95 |
|
95 | |||
96 | try: |
|
96 | try: | |
97 | code = self.compile(source, filename, symbol) |
|
97 | code = self.compile(source, filename, symbol) | |
98 | except (OverflowError, SyntaxError, ValueError): |
|
98 | except (OverflowError, SyntaxError, ValueError): | |
99 | # Case 1 |
|
99 | # Case 1 | |
100 | self.showsyntaxerror(filename) |
|
100 | self.showsyntaxerror(filename) | |
101 | return False |
|
101 | return False | |
102 |
|
102 | |||
103 | if code is None: |
|
103 | if code is None: | |
104 | # Case 2 |
|
104 | # Case 2 | |
105 | return True |
|
105 | return True | |
106 |
|
106 | |||
107 | # shortcut - if we are in worker thread, or the worker thread is not running, |
|
107 | # shortcut - if we are in worker thread, or the worker thread is not running, | |
108 | # execute directly (to allow recursion and prevent deadlock if code is run early |
|
108 | # execute directly (to allow recursion and prevent deadlock if code is run early | |
109 | # in IPython construction) |
|
109 | # in IPython construction) | |
110 |
|
110 | |||
111 | if (not self.reactor_started or (self.worker_ident is None and not self.first_run) |
|
111 | if (not self.reactor_started or (self.worker_ident is None and not self.first_run) | |
112 | or self.worker_ident == thread.get_ident() or shellglobals.run_in_frontend(source)): |
|
112 | or self.worker_ident == thread.get_ident() or shellglobals.run_in_frontend(source)): | |
113 | InteractiveShell.runcode(self,code) |
|
113 | InteractiveShell.runcode(self,code) | |
114 | return |
|
114 | return | |
115 |
|
115 | |||
116 | # Case 3 |
|
116 | # Case 3 | |
117 | # Store code in queue, so the execution thread can handle it. |
|
117 | # Store code in queue, so the execution thread can handle it. | |
118 |
|
118 | |||
119 | self.first_run = False |
|
119 | self.first_run = False | |
120 | completed_ev, received_ev = threading.Event(), threading.Event() |
|
120 | completed_ev, received_ev = threading.Event(), threading.Event() | |
121 |
|
121 | |||
122 | self.code_queue.put((code,completed_ev, received_ev)) |
|
122 | self.code_queue.put((code,completed_ev, received_ev)) | |
123 |
|
123 | |||
124 | reactor.callLater(0.0,self.runcode) |
|
124 | reactor.callLater(0.0,self.runcode) | |
125 | received_ev.wait(5) |
|
125 | received_ev.wait(5) | |
126 | if not received_ev.isSet(): |
|
126 | if not received_ev.isSet(): | |
127 | # the mainloop is dead, start executing code directly |
|
127 | # the mainloop is dead, start executing code directly | |
128 | print "Warning: Timeout for mainloop thread exceeded" |
|
128 | print "Warning: Timeout for mainloop thread exceeded" | |
129 | print "switching to nonthreaded mode (until mainloop wakes up again)" |
|
129 | print "switching to nonthreaded mode (until mainloop wakes up again)" | |
130 | self.worker_ident = None |
|
130 | self.worker_ident = None | |
131 | else: |
|
131 | else: | |
132 | completed_ev.wait() |
|
132 | completed_ev.wait() | |
133 |
|
133 | |||
134 | return False |
|
134 | return False | |
135 |
|
135 | |||
136 | def runcode(self): |
|
136 | def runcode(self): | |
137 | """Execute a code object. |
|
137 | """Execute a code object. | |
138 |
|
138 | |||
139 | Multithreaded wrapper around IPython's runcode().""" |
|
139 | Multithreaded wrapper around IPython's runcode().""" | |
140 |
|
140 | |||
141 |
|
141 | |||
142 | # we are in worker thread, stash out the id for runsource() |
|
142 | # we are in worker thread, stash out the id for runsource() | |
143 | self.worker_ident = thread.get_ident() |
|
143 | self.worker_ident = thread.get_ident() | |
144 |
|
144 | |||
145 | if self._kill: |
|
145 | if self._kill: | |
146 | print >>Term.cout, 'Closing threads...', |
|
146 | print >>Term.cout, 'Closing threads...', | |
147 | Term.cout.flush() |
|
147 | Term.cout.flush() | |
148 | for tokill in self.on_kill: |
|
148 | for tokill in self.on_kill: | |
149 | tokill() |
|
149 | tokill() | |
150 | print >>Term.cout, 'Done.' |
|
150 | print >>Term.cout, 'Done.' | |
151 | # allow kill() to return |
|
151 | # allow kill() to return | |
152 | self._kill.set() |
|
152 | self._kill.set() | |
153 | return True |
|
153 | return True | |
154 |
|
154 | |||
155 | # Install SIGINT handler. We do it every time to ensure that if user |
|
155 | # Install SIGINT handler. We do it every time to ensure that if user | |
156 | # code modifies it, we restore our own handling. |
|
156 | # code modifies it, we restore our own handling. | |
157 | try: |
|
157 | try: | |
158 | pass |
|
158 | pass | |
159 | signal(SIGINT,shellglobals.sigint_handler) |
|
159 | signal(SIGINT,shellglobals.sigint_handler) | |
160 | except SystemError: |
|
160 | except SystemError: | |
161 | # This happens under Windows, which seems to have all sorts |
|
161 | # This happens under Windows, which seems to have all sorts | |
162 | # of problems with signal handling. Oh well... |
|
162 | # of problems with signal handling. Oh well... | |
163 | pass |
|
163 | pass | |
164 |
|
164 | |||
165 | # Flush queue of pending code by calling the run methood of the parent |
|
165 | # Flush queue of pending code by calling the run methood of the parent | |
166 | # class with all items which may be in the queue. |
|
166 | # class with all items which may be in the queue. | |
167 | code_to_run = None |
|
167 | code_to_run = None | |
168 | while 1: |
|
168 | while 1: | |
169 | try: |
|
169 | try: | |
170 | code_to_run, completed_ev, received_ev = self.code_queue.get_nowait() |
|
170 | code_to_run, completed_ev, received_ev = self.code_queue.get_nowait() | |
171 | except Queue.Empty: |
|
171 | except Queue.Empty: | |
172 | break |
|
172 | break | |
173 | received_ev.set() |
|
173 | received_ev.set() | |
174 |
|
174 | |||
175 |
|
175 | |||
176 | # Exceptions need to be raised differently depending on which |
|
176 | # Exceptions need to be raised differently depending on which | |
177 | # thread is active. This convoluted try/except is only there to |
|
177 | # thread is active. This convoluted try/except is only there to | |
178 | # protect against asynchronous exceptions, to ensure that a shellglobals.KBINT |
|
178 | # protect against asynchronous exceptions, to ensure that a shellglobals.KBINT | |
179 | # at the wrong time doesn't deadlock everything. The global |
|
179 | # at the wrong time doesn't deadlock everything. The global | |
180 | # CODE_TO_RUN is set to true/false as close as possible to the |
|
180 | # CODE_TO_RUN is set to true/false as close as possible to the | |
181 | # runcode() call, so that the KBINT handler is correctly informed. |
|
181 | # runcode() call, so that the KBINT handler is correctly informed. | |
182 | try: |
|
182 | try: | |
183 | try: |
|
183 | try: | |
184 | shellglobals.CODE_RUN = True |
|
184 | shellglobals.CODE_RUN = True | |
185 | InteractiveShell.runcode(self,code_to_run) |
|
185 | InteractiveShell.runcode(self,code_to_run) | |
186 | except KeyboardInterrupt: |
|
186 | except KeyboardInterrupt: | |
187 | print "Keyboard interrupted in mainloop" |
|
187 | print "Keyboard interrupted in mainloop" | |
188 | while not self.code_queue.empty(): |
|
188 | while not self.code_queue.empty(): | |
189 | code = self.code_queue.get_nowait() |
|
189 | code = self.code_queue.get_nowait() | |
190 | break |
|
190 | break | |
191 | finally: |
|
191 | finally: | |
192 | shellglobals.CODE_RUN = False |
|
192 | shellglobals.CODE_RUN = False | |
193 | # allow runsource() return from wait |
|
193 | # allow runsource() return from wait | |
194 | completed_ev.set() |
|
194 | completed_ev.set() | |
195 |
|
195 | |||
196 | # This MUST return true for gtk threading to work |
|
196 | # This MUST return true for gtk threading to work | |
197 | return True |
|
197 | return True | |
198 |
|
198 | |||
199 | def kill(self): |
|
199 | def kill(self): | |
200 | """Kill the thread, returning when it has been shut down.""" |
|
200 | """Kill the thread, returning when it has been shut down.""" | |
201 | self._kill = threading.Event() |
|
201 | self._kill = threading.Event() | |
202 | reactor.callLater(0.0,self.runcode) |
|
202 | reactor.callLater(0.0,self.runcode) | |
203 | self._kill.wait() |
|
203 | self._kill.wait() | |
204 |
|
204 | |||
205 |
|
205 | |||
206 |
|
206 | |||
207 | class IPShellTwisted: |
|
207 | class IPShellTwisted: | |
208 | """Run a Twisted reactor while in an IPython session. |
|
208 | """Run a Twisted reactor while in an IPython session. | |
209 |
|
209 | |||
210 | Python commands can be passed to the thread where they will be |
|
210 | Python commands can be passed to the thread where they will be | |
211 | executed. This is implemented by periodically checking for |
|
211 | executed. This is implemented by periodically checking for | |
212 | passed code using a Twisted reactor callback. |
|
212 | passed code using a Twisted reactor callback. | |
213 | """ |
|
213 | """ | |
214 |
|
214 | |||
215 | TIMEOUT = 0.01 # Millisecond interval between reactor runs. |
|
215 | TIMEOUT = 0.01 # Millisecond interval between reactor runs. | |
216 |
|
216 | |||
217 | def __init__(self, argv=None, user_ns=None, debug=1, |
|
217 | def __init__(self, argv=None, user_ns=None, debug=1, | |
218 | shell_class=TwistedInteractiveShell): |
|
218 | shell_class=TwistedInteractiveShell): | |
219 |
|
219 | |||
220 | from twisted.internet import reactor |
|
220 | from twisted.internet import reactor | |
221 | self.reactor = hijack_reactor() |
|
221 | self.reactor = hijack_reactor() | |
222 |
|
222 | |||
223 | mainquit = self.reactor.stop |
|
223 | mainquit = self.reactor.stop | |
224 |
|
224 | |||
225 | # Make sure IPython keeps going after reactor stop. |
|
225 | # Make sure IPython keeps going after reactor stop. | |
226 | def reactorstop(): |
|
226 | def reactorstop(): | |
227 | pass |
|
227 | pass | |
228 | self.reactor.stop = reactorstop |
|
228 | self.reactor.stop = reactorstop | |
229 | reactorrun_orig = self.reactor.run |
|
229 | reactorrun_orig = self.reactor.run | |
230 | self.quitting = False |
|
230 | self.quitting = False | |
231 | def reactorrun(): |
|
231 | def reactorrun(): | |
232 | while True and not self.quitting: |
|
232 | while True and not self.quitting: | |
233 | reactorrun_orig() |
|
233 | reactorrun_orig() | |
234 | self.reactor.run = reactorrun |
|
234 | self.reactor.run = reactorrun | |
235 |
|
235 | |||
236 | self.IP = make_IPython(argv, user_ns=user_ns, debug=debug, |
|
236 | self.IP = make_IPython(argv, user_ns=user_ns, debug=debug, | |
237 | shell_class=shell_class, |
|
237 | shell_class=shell_class, | |
238 | on_kill=[mainquit]) |
|
238 | on_kill=[mainquit]) | |
239 |
|
239 | |||
240 | # threading.Thread.__init__(self) |
|
240 | # threading.Thread.__init__(self) | |
241 |
|
241 | |||
242 | def run(self): |
|
242 | def run(self): | |
243 | self.IP.mainloop() |
|
243 | self.IP.mainloop() | |
244 | self.quitting = True |
|
244 | self.quitting = True | |
245 | self.IP.kill() |
|
245 | self.IP.kill() | |
246 |
|
246 | |||
247 | def mainloop(self): |
|
247 | def mainloop(self): | |
248 | def mainLoopThreadDeath(r): |
|
248 | def mainLoopThreadDeath(r): | |
249 | print "mainLoopThreadDeath: ", str(r) |
|
249 | print "mainLoopThreadDeath: ", str(r) | |
250 | def spawnMainloopThread(): |
|
250 | def spawnMainloopThread(): | |
251 | d=threads.deferToThread(self.run) |
|
251 | d=threads.deferToThread(self.run) | |
252 | d.addBoth(mainLoopThreadDeath) |
|
252 | d.addBoth(mainLoopThreadDeath) | |
253 | reactor.callWhenRunning(spawnMainloopThread) |
|
253 | reactor.callWhenRunning(spawnMainloopThread) | |
254 | self.IP.reactor_started = True |
|
254 | self.IP.reactor_started = True | |
255 | self.reactor.run() |
|
255 | self.reactor.run() | |
256 | print "mainloop ending...." |
|
256 | print "mainloop ending...." | |
257 |
|
257 | |||
258 | exists = True |
|
258 | exists = True | |
259 |
|
259 | |||
260 |
|
260 | |||
261 | if __name__ == '__main__': |
|
261 | if __name__ == '__main__': | |
262 | # Sample usage. |
|
262 | # Sample usage. | |
263 |
|
263 | |||
264 | # Create the shell object. This steals twisted.internet.reactor |
|
264 | # Create the shell object. This steals twisted.internet.reactor | |
265 | # for its own purposes, to make sure you've already installed a |
|
265 | # for its own purposes, to make sure you've already installed a | |
266 | # reactor of your choice. |
|
266 | # reactor of your choice. | |
267 | shell = IPShellTwisted( |
|
267 | shell = IPShellTwisted( | |
268 | argv=[], |
|
268 | argv=[], | |
269 | user_ns={'__name__': '__example__', |
|
269 | user_ns={'__name__': '__example__', | |
270 | 'hello': 'world', |
|
270 | 'hello': 'world', | |
271 | }, |
|
271 | }, | |
272 | ) |
|
272 | ) | |
273 |
|
273 | |||
274 | # Run the mainloop. This runs the actual reactor.run() method. |
|
274 | # Run the mainloop. This runs the actual reactor.run() method. | |
275 | # The twisted.internet.reactor object at this point is a dummy |
|
275 | # The twisted.internet.reactor object at this point is a dummy | |
276 | # object that passes through to the actual reactor, but prevents |
|
276 | # object that passes through to the actual reactor, but prevents | |
277 | # run() from being called on it again. |
|
277 | # run() from being called on it again. | |
278 | shell.mainloop() |
|
278 | shell.mainloop() | |
279 |
|
279 | |||
280 | # You must exit IPython to terminate your program. |
|
280 | # You must exit IPython to terminate your program. | |
281 | print 'Goodbye!' |
|
281 | print 'Goodbye!' | |
282 |
|
282 |
@@ -1,1067 +1,1067 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """ |
|
2 | """ | |
3 | ultraTB.py -- Spice up your tracebacks! |
|
3 | ultraTB.py -- Spice up your tracebacks! | |
4 |
|
4 | |||
5 | * ColorTB |
|
5 | * ColorTB | |
6 | I've always found it a bit hard to visually parse tracebacks in Python. The |
|
6 | I've always found it a bit hard to visually parse tracebacks in Python. The | |
7 | ColorTB class is a solution to that problem. It colors the different parts of a |
|
7 | ColorTB class is a solution to that problem. It colors the different parts of a | |
8 | traceback in a manner similar to what you would expect from a syntax-highlighting |
|
8 | traceback in a manner similar to what you would expect from a syntax-highlighting | |
9 | text editor. |
|
9 | text editor. | |
10 |
|
10 | |||
11 | Installation instructions for ColorTB: |
|
11 | Installation instructions for ColorTB: | |
12 | import sys,ultraTB |
|
12 | import sys,ultraTB | |
13 | sys.excepthook = ultraTB.ColorTB() |
|
13 | sys.excepthook = ultraTB.ColorTB() | |
14 |
|
14 | |||
15 | * VerboseTB |
|
15 | * VerboseTB | |
16 | I've also included a port of Ka-Ping Yee's "cgitb.py" that produces all kinds |
|
16 | I've also included a port of Ka-Ping Yee's "cgitb.py" that produces all kinds | |
17 | of useful info when a traceback occurs. Ping originally had it spit out HTML |
|
17 | of useful info when a traceback occurs. Ping originally had it spit out HTML | |
18 | and intended it for CGI programmers, but why should they have all the fun? I |
|
18 | and intended it for CGI programmers, but why should they have all the fun? I | |
19 | altered it to spit out colored text to the terminal. It's a bit overwhelming, |
|
19 | altered it to spit out colored text to the terminal. It's a bit overwhelming, | |
20 | but kind of neat, and maybe useful for long-running programs that you believe |
|
20 | but kind of neat, and maybe useful for long-running programs that you believe | |
21 | are bug-free. If a crash *does* occur in that type of program you want details. |
|
21 | are bug-free. If a crash *does* occur in that type of program you want details. | |
22 | Give it a shot--you'll love it or you'll hate it. |
|
22 | Give it a shot--you'll love it or you'll hate it. | |
23 |
|
23 | |||
24 | Note: |
|
24 | Note: | |
25 |
|
25 | |||
26 | The Verbose mode prints the variables currently visible where the exception |
|
26 | The Verbose mode prints the variables currently visible where the exception | |
27 | happened (shortening their strings if too long). This can potentially be |
|
27 | happened (shortening their strings if too long). This can potentially be | |
28 | very slow, if you happen to have a huge data structure whose string |
|
28 | very slow, if you happen to have a huge data structure whose string | |
29 | representation is complex to compute. Your computer may appear to freeze for |
|
29 | representation is complex to compute. Your computer may appear to freeze for | |
30 | a while with cpu usage at 100%. If this occurs, you can cancel the traceback |
|
30 | a while with cpu usage at 100%. If this occurs, you can cancel the traceback | |
31 | with Ctrl-C (maybe hitting it more than once). |
|
31 | with Ctrl-C (maybe hitting it more than once). | |
32 |
|
32 | |||
33 | If you encounter this kind of situation often, you may want to use the |
|
33 | If you encounter this kind of situation often, you may want to use the | |
34 | Verbose_novars mode instead of the regular Verbose, which avoids formatting |
|
34 | Verbose_novars mode instead of the regular Verbose, which avoids formatting | |
35 | variables (but otherwise includes the information and context given by |
|
35 | variables (but otherwise includes the information and context given by | |
36 | Verbose). |
|
36 | Verbose). | |
37 |
|
37 | |||
38 |
|
38 | |||
39 | Installation instructions for ColorTB: |
|
39 | Installation instructions for ColorTB: | |
40 | import sys,ultraTB |
|
40 | import sys,ultraTB | |
41 | sys.excepthook = ultraTB.VerboseTB() |
|
41 | sys.excepthook = ultraTB.VerboseTB() | |
42 |
|
42 | |||
43 | Note: Much of the code in this module was lifted verbatim from the standard |
|
43 | Note: Much of the code in this module was lifted verbatim from the standard | |
44 | library module 'traceback.py' and Ka-Ping Yee's 'cgitb.py'. |
|
44 | library module 'traceback.py' and Ka-Ping Yee's 'cgitb.py'. | |
45 |
|
45 | |||
46 | * Color schemes |
|
46 | * Color schemes | |
47 | The colors are defined in the class TBTools through the use of the |
|
47 | The colors are defined in the class TBTools through the use of the | |
48 | ColorSchemeTable class. Currently the following exist: |
|
48 | ColorSchemeTable class. Currently the following exist: | |
49 |
|
49 | |||
50 | - NoColor: allows all of this module to be used in any terminal (the color |
|
50 | - NoColor: allows all of this module to be used in any terminal (the color | |
51 | escapes are just dummy blank strings). |
|
51 | escapes are just dummy blank strings). | |
52 |
|
52 | |||
53 | - Linux: is meant to look good in a terminal like the Linux console (black |
|
53 | - Linux: is meant to look good in a terminal like the Linux console (black | |
54 | or very dark background). |
|
54 | or very dark background). | |
55 |
|
55 | |||
56 | - LightBG: similar to Linux but swaps dark/light colors to be more readable |
|
56 | - LightBG: similar to Linux but swaps dark/light colors to be more readable | |
57 | in light background terminals. |
|
57 | in light background terminals. | |
58 |
|
58 | |||
59 | You can implement other color schemes easily, the syntax is fairly |
|
59 | You can implement other color schemes easily, the syntax is fairly | |
60 | self-explanatory. Please send back new schemes you develop to the author for |
|
60 | self-explanatory. Please send back new schemes you develop to the author for | |
61 | possible inclusion in future releases. |
|
61 | possible inclusion in future releases. | |
62 | """ |
|
62 | """ | |
63 |
|
63 | |||
64 | #***************************************************************************** |
|
64 | #***************************************************************************** | |
65 | # Copyright (C) 2001 Nathaniel Gray <n8gray@caltech.edu> |
|
65 | # Copyright (C) 2001 Nathaniel Gray <n8gray@caltech.edu> | |
66 | # Copyright (C) 2001-2004 Fernando Perez <fperez@colorado.edu> |
|
66 | # Copyright (C) 2001-2004 Fernando Perez <fperez@colorado.edu> | |
67 | # |
|
67 | # | |
68 | # Distributed under the terms of the BSD License. The full license is in |
|
68 | # Distributed under the terms of the BSD License. The full license is in | |
69 | # the file COPYING, distributed as part of this software. |
|
69 | # the file COPYING, distributed as part of this software. | |
70 | #***************************************************************************** |
|
70 | #***************************************************************************** | |
71 |
|
71 | |||
72 | # Required modules |
|
72 | # Required modules | |
73 | import inspect |
|
73 | import inspect | |
74 | import keyword |
|
74 | import keyword | |
75 | import linecache |
|
75 | import linecache | |
76 | import os |
|
76 | import os | |
77 | import pydoc |
|
77 | import pydoc | |
78 | import re |
|
78 | import re | |
79 | import string |
|
79 | import string | |
80 | import sys |
|
80 | import sys | |
81 | import time |
|
81 | import time | |
82 | import tokenize |
|
82 | import tokenize | |
83 | import traceback |
|
83 | import traceback | |
84 | import types |
|
84 | import types | |
85 |
|
85 | |||
86 | # For purposes of monkeypatching inspect to fix a bug in it. |
|
86 | # For purposes of monkeypatching inspect to fix a bug in it. | |
87 | from inspect import getsourcefile, getfile, getmodule,\ |
|
87 | from inspect import getsourcefile, getfile, getmodule,\ | |
88 | ismodule, isclass, ismethod, isfunction, istraceback, isframe, iscode |
|
88 | ismodule, isclass, ismethod, isfunction, istraceback, isframe, iscode | |
89 |
|
89 | |||
90 |
|
90 | |||
91 | # IPython's own modules |
|
91 | # IPython's own modules | |
92 | # Modified pdb which doesn't damage IPython's readline handling |
|
92 | # Modified pdb which doesn't damage IPython's readline handling | |
93 | from IPython import PyColorize |
|
93 | from IPython import PyColorize | |
94 | from IPython.core import debugger |
|
94 | from IPython.core import debugger | |
95 | from IPython.ipstruct import Struct |
|
95 | from IPython.utils.ipstruct import Struct | |
96 | from IPython.core.excolors import exception_colors |
|
96 | from IPython.core.excolors import exception_colors | |
97 | from IPython.utils.genutils import Term,uniq_stable,error,info |
|
97 | from IPython.utils.genutils import Term,uniq_stable,error,info | |
98 |
|
98 | |||
99 | # Globals |
|
99 | # Globals | |
100 | # amount of space to put line numbers before verbose tracebacks |
|
100 | # amount of space to put line numbers before verbose tracebacks | |
101 | INDENT_SIZE = 8 |
|
101 | INDENT_SIZE = 8 | |
102 |
|
102 | |||
103 | # Default color scheme. This is used, for example, by the traceback |
|
103 | # Default color scheme. This is used, for example, by the traceback | |
104 | # formatter. When running in an actual IPython instance, the user's rc.colors |
|
104 | # formatter. When running in an actual IPython instance, the user's rc.colors | |
105 | # value is used, but havinga module global makes this functionality available |
|
105 | # value is used, but havinga module global makes this functionality available | |
106 | # to users of ultraTB who are NOT running inside ipython. |
|
106 | # to users of ultraTB who are NOT running inside ipython. | |
107 | DEFAULT_SCHEME = 'NoColor' |
|
107 | DEFAULT_SCHEME = 'NoColor' | |
108 |
|
108 | |||
109 | #--------------------------------------------------------------------------- |
|
109 | #--------------------------------------------------------------------------- | |
110 | # Code begins |
|
110 | # Code begins | |
111 |
|
111 | |||
112 | # Utility functions |
|
112 | # Utility functions | |
113 | def inspect_error(): |
|
113 | def inspect_error(): | |
114 | """Print a message about internal inspect errors. |
|
114 | """Print a message about internal inspect errors. | |
115 |
|
115 | |||
116 | These are unfortunately quite common.""" |
|
116 | These are unfortunately quite common.""" | |
117 |
|
117 | |||
118 | error('Internal Python error in the inspect module.\n' |
|
118 | error('Internal Python error in the inspect module.\n' | |
119 | 'Below is the traceback from this internal error.\n') |
|
119 | 'Below is the traceback from this internal error.\n') | |
120 |
|
120 | |||
121 |
|
121 | |||
122 | def findsource(object): |
|
122 | def findsource(object): | |
123 | """Return the entire source file and starting line number for an object. |
|
123 | """Return the entire source file and starting line number for an object. | |
124 |
|
124 | |||
125 | The argument may be a module, class, method, function, traceback, frame, |
|
125 | The argument may be a module, class, method, function, traceback, frame, | |
126 | or code object. The source code is returned as a list of all the lines |
|
126 | or code object. The source code is returned as a list of all the lines | |
127 | in the file and the line number indexes a line in that list. An IOError |
|
127 | in the file and the line number indexes a line in that list. An IOError | |
128 | is raised if the source code cannot be retrieved. |
|
128 | is raised if the source code cannot be retrieved. | |
129 |
|
129 | |||
130 | FIXED version with which we monkeypatch the stdlib to work around a bug.""" |
|
130 | FIXED version with which we monkeypatch the stdlib to work around a bug.""" | |
131 |
|
131 | |||
132 | file = getsourcefile(object) or getfile(object) |
|
132 | file = getsourcefile(object) or getfile(object) | |
133 | # If the object is a frame, then trying to get the globals dict from its |
|
133 | # If the object is a frame, then trying to get the globals dict from its | |
134 | # module won't work. Instead, the frame object itself has the globals |
|
134 | # module won't work. Instead, the frame object itself has the globals | |
135 | # dictionary. |
|
135 | # dictionary. | |
136 | globals_dict = None |
|
136 | globals_dict = None | |
137 | if inspect.isframe(object): |
|
137 | if inspect.isframe(object): | |
138 | # XXX: can this ever be false? |
|
138 | # XXX: can this ever be false? | |
139 | globals_dict = object.f_globals |
|
139 | globals_dict = object.f_globals | |
140 | else: |
|
140 | else: | |
141 | module = getmodule(object, file) |
|
141 | module = getmodule(object, file) | |
142 | if module: |
|
142 | if module: | |
143 | globals_dict = module.__dict__ |
|
143 | globals_dict = module.__dict__ | |
144 | lines = linecache.getlines(file, globals_dict) |
|
144 | lines = linecache.getlines(file, globals_dict) | |
145 | if not lines: |
|
145 | if not lines: | |
146 | raise IOError('could not get source code') |
|
146 | raise IOError('could not get source code') | |
147 |
|
147 | |||
148 | if ismodule(object): |
|
148 | if ismodule(object): | |
149 | return lines, 0 |
|
149 | return lines, 0 | |
150 |
|
150 | |||
151 | if isclass(object): |
|
151 | if isclass(object): | |
152 | name = object.__name__ |
|
152 | name = object.__name__ | |
153 | pat = re.compile(r'^(\s*)class\s*' + name + r'\b') |
|
153 | pat = re.compile(r'^(\s*)class\s*' + name + r'\b') | |
154 | # make some effort to find the best matching class definition: |
|
154 | # make some effort to find the best matching class definition: | |
155 | # use the one with the least indentation, which is the one |
|
155 | # use the one with the least indentation, which is the one | |
156 | # that's most probably not inside a function definition. |
|
156 | # that's most probably not inside a function definition. | |
157 | candidates = [] |
|
157 | candidates = [] | |
158 | for i in range(len(lines)): |
|
158 | for i in range(len(lines)): | |
159 | match = pat.match(lines[i]) |
|
159 | match = pat.match(lines[i]) | |
160 | if match: |
|
160 | if match: | |
161 | # if it's at toplevel, it's already the best one |
|
161 | # if it's at toplevel, it's already the best one | |
162 | if lines[i][0] == 'c': |
|
162 | if lines[i][0] == 'c': | |
163 | return lines, i |
|
163 | return lines, i | |
164 | # else add whitespace to candidate list |
|
164 | # else add whitespace to candidate list | |
165 | candidates.append((match.group(1), i)) |
|
165 | candidates.append((match.group(1), i)) | |
166 | if candidates: |
|
166 | if candidates: | |
167 | # this will sort by whitespace, and by line number, |
|
167 | # this will sort by whitespace, and by line number, | |
168 | # less whitespace first |
|
168 | # less whitespace first | |
169 | candidates.sort() |
|
169 | candidates.sort() | |
170 | return lines, candidates[0][1] |
|
170 | return lines, candidates[0][1] | |
171 | else: |
|
171 | else: | |
172 | raise IOError('could not find class definition') |
|
172 | raise IOError('could not find class definition') | |
173 |
|
173 | |||
174 | if ismethod(object): |
|
174 | if ismethod(object): | |
175 | object = object.im_func |
|
175 | object = object.im_func | |
176 | if isfunction(object): |
|
176 | if isfunction(object): | |
177 | object = object.func_code |
|
177 | object = object.func_code | |
178 | if istraceback(object): |
|
178 | if istraceback(object): | |
179 | object = object.tb_frame |
|
179 | object = object.tb_frame | |
180 | if isframe(object): |
|
180 | if isframe(object): | |
181 | object = object.f_code |
|
181 | object = object.f_code | |
182 | if iscode(object): |
|
182 | if iscode(object): | |
183 | if not hasattr(object, 'co_firstlineno'): |
|
183 | if not hasattr(object, 'co_firstlineno'): | |
184 | raise IOError('could not find function definition') |
|
184 | raise IOError('could not find function definition') | |
185 | pat = re.compile(r'^(\s*def\s)|(.*(?<!\w)lambda(:|\s))|^(\s*@)') |
|
185 | pat = re.compile(r'^(\s*def\s)|(.*(?<!\w)lambda(:|\s))|^(\s*@)') | |
186 | pmatch = pat.match |
|
186 | pmatch = pat.match | |
187 | # fperez - fix: sometimes, co_firstlineno can give a number larger than |
|
187 | # fperez - fix: sometimes, co_firstlineno can give a number larger than | |
188 | # the length of lines, which causes an error. Safeguard against that. |
|
188 | # the length of lines, which causes an error. Safeguard against that. | |
189 | lnum = min(object.co_firstlineno,len(lines))-1 |
|
189 | lnum = min(object.co_firstlineno,len(lines))-1 | |
190 | while lnum > 0: |
|
190 | while lnum > 0: | |
191 | if pmatch(lines[lnum]): break |
|
191 | if pmatch(lines[lnum]): break | |
192 | lnum -= 1 |
|
192 | lnum -= 1 | |
193 |
|
193 | |||
194 | return lines, lnum |
|
194 | return lines, lnum | |
195 | raise IOError('could not find code object') |
|
195 | raise IOError('could not find code object') | |
196 |
|
196 | |||
197 | # Monkeypatch inspect to apply our bugfix. This code only works with py25 |
|
197 | # Monkeypatch inspect to apply our bugfix. This code only works with py25 | |
198 | if sys.version_info[:2] >= (2,5): |
|
198 | if sys.version_info[:2] >= (2,5): | |
199 | inspect.findsource = findsource |
|
199 | inspect.findsource = findsource | |
200 |
|
200 | |||
201 | def fix_frame_records_filenames(records): |
|
201 | def fix_frame_records_filenames(records): | |
202 | """Try to fix the filenames in each record from inspect.getinnerframes(). |
|
202 | """Try to fix the filenames in each record from inspect.getinnerframes(). | |
203 |
|
203 | |||
204 | Particularly, modules loaded from within zip files have useless filenames |
|
204 | Particularly, modules loaded from within zip files have useless filenames | |
205 | attached to their code object, and inspect.getinnerframes() just uses it. |
|
205 | attached to their code object, and inspect.getinnerframes() just uses it. | |
206 | """ |
|
206 | """ | |
207 | fixed_records = [] |
|
207 | fixed_records = [] | |
208 | for frame, filename, line_no, func_name, lines, index in records: |
|
208 | for frame, filename, line_no, func_name, lines, index in records: | |
209 | # Look inside the frame's globals dictionary for __file__, which should |
|
209 | # Look inside the frame's globals dictionary for __file__, which should | |
210 | # be better. |
|
210 | # be better. | |
211 | better_fn = frame.f_globals.get('__file__', None) |
|
211 | better_fn = frame.f_globals.get('__file__', None) | |
212 | if isinstance(better_fn, str): |
|
212 | if isinstance(better_fn, str): | |
213 | # Check the type just in case someone did something weird with |
|
213 | # Check the type just in case someone did something weird with | |
214 | # __file__. It might also be None if the error occurred during |
|
214 | # __file__. It might also be None if the error occurred during | |
215 | # import. |
|
215 | # import. | |
216 | filename = better_fn |
|
216 | filename = better_fn | |
217 | fixed_records.append((frame, filename, line_no, func_name, lines, index)) |
|
217 | fixed_records.append((frame, filename, line_no, func_name, lines, index)) | |
218 | return fixed_records |
|
218 | return fixed_records | |
219 |
|
219 | |||
220 |
|
220 | |||
221 | def _fixed_getinnerframes(etb, context=1,tb_offset=0): |
|
221 | def _fixed_getinnerframes(etb, context=1,tb_offset=0): | |
222 | import linecache |
|
222 | import linecache | |
223 | LNUM_POS, LINES_POS, INDEX_POS = 2, 4, 5 |
|
223 | LNUM_POS, LINES_POS, INDEX_POS = 2, 4, 5 | |
224 |
|
224 | |||
225 | records = fix_frame_records_filenames(inspect.getinnerframes(etb, context)) |
|
225 | records = fix_frame_records_filenames(inspect.getinnerframes(etb, context)) | |
226 |
|
226 | |||
227 | # If the error is at the console, don't build any context, since it would |
|
227 | # If the error is at the console, don't build any context, since it would | |
228 | # otherwise produce 5 blank lines printed out (there is no file at the |
|
228 | # otherwise produce 5 blank lines printed out (there is no file at the | |
229 | # console) |
|
229 | # console) | |
230 | rec_check = records[tb_offset:] |
|
230 | rec_check = records[tb_offset:] | |
231 | try: |
|
231 | try: | |
232 | rname = rec_check[0][1] |
|
232 | rname = rec_check[0][1] | |
233 | if rname == '<ipython console>' or rname.endswith('<string>'): |
|
233 | if rname == '<ipython console>' or rname.endswith('<string>'): | |
234 | return rec_check |
|
234 | return rec_check | |
235 | except IndexError: |
|
235 | except IndexError: | |
236 | pass |
|
236 | pass | |
237 |
|
237 | |||
238 | aux = traceback.extract_tb(etb) |
|
238 | aux = traceback.extract_tb(etb) | |
239 | assert len(records) == len(aux) |
|
239 | assert len(records) == len(aux) | |
240 | for i, (file, lnum, _, _) in zip(range(len(records)), aux): |
|
240 | for i, (file, lnum, _, _) in zip(range(len(records)), aux): | |
241 | maybeStart = lnum-1 - context//2 |
|
241 | maybeStart = lnum-1 - context//2 | |
242 | start = max(maybeStart, 0) |
|
242 | start = max(maybeStart, 0) | |
243 | end = start + context |
|
243 | end = start + context | |
244 | lines = linecache.getlines(file)[start:end] |
|
244 | lines = linecache.getlines(file)[start:end] | |
245 | # pad with empty lines if necessary |
|
245 | # pad with empty lines if necessary | |
246 | if maybeStart < 0: |
|
246 | if maybeStart < 0: | |
247 | lines = (['\n'] * -maybeStart) + lines |
|
247 | lines = (['\n'] * -maybeStart) + lines | |
248 | if len(lines) < context: |
|
248 | if len(lines) < context: | |
249 | lines += ['\n'] * (context - len(lines)) |
|
249 | lines += ['\n'] * (context - len(lines)) | |
250 | buf = list(records[i]) |
|
250 | buf = list(records[i]) | |
251 | buf[LNUM_POS] = lnum |
|
251 | buf[LNUM_POS] = lnum | |
252 | buf[INDEX_POS] = lnum - 1 - start |
|
252 | buf[INDEX_POS] = lnum - 1 - start | |
253 | buf[LINES_POS] = lines |
|
253 | buf[LINES_POS] = lines | |
254 | records[i] = tuple(buf) |
|
254 | records[i] = tuple(buf) | |
255 | return records[tb_offset:] |
|
255 | return records[tb_offset:] | |
256 |
|
256 | |||
257 | # Helper function -- largely belongs to VerboseTB, but we need the same |
|
257 | # Helper function -- largely belongs to VerboseTB, but we need the same | |
258 | # functionality to produce a pseudo verbose TB for SyntaxErrors, so that they |
|
258 | # functionality to produce a pseudo verbose TB for SyntaxErrors, so that they | |
259 | # can be recognized properly by ipython.el's py-traceback-line-re |
|
259 | # can be recognized properly by ipython.el's py-traceback-line-re | |
260 | # (SyntaxErrors have to be treated specially because they have no traceback) |
|
260 | # (SyntaxErrors have to be treated specially because they have no traceback) | |
261 |
|
261 | |||
262 | _parser = PyColorize.Parser() |
|
262 | _parser = PyColorize.Parser() | |
263 |
|
263 | |||
264 | def _formatTracebackLines(lnum, index, lines, Colors, lvals=None,scheme=None): |
|
264 | def _formatTracebackLines(lnum, index, lines, Colors, lvals=None,scheme=None): | |
265 | numbers_width = INDENT_SIZE - 1 |
|
265 | numbers_width = INDENT_SIZE - 1 | |
266 | res = [] |
|
266 | res = [] | |
267 | i = lnum - index |
|
267 | i = lnum - index | |
268 |
|
268 | |||
269 | # This lets us get fully syntax-highlighted tracebacks. |
|
269 | # This lets us get fully syntax-highlighted tracebacks. | |
270 | if scheme is None: |
|
270 | if scheme is None: | |
271 | try: |
|
271 | try: | |
272 | # Again, reference to a global __IPYTHON__ that doesn't exist. |
|
272 | # Again, reference to a global __IPYTHON__ that doesn't exist. | |
273 | # XXX |
|
273 | # XXX | |
274 | scheme = __IPYTHON__.rc.colors |
|
274 | scheme = __IPYTHON__.rc.colors | |
275 | except: |
|
275 | except: | |
276 | scheme = DEFAULT_SCHEME |
|
276 | scheme = DEFAULT_SCHEME | |
277 | _line_format = _parser.format2 |
|
277 | _line_format = _parser.format2 | |
278 |
|
278 | |||
279 | for line in lines: |
|
279 | for line in lines: | |
280 | new_line, err = _line_format(line,'str',scheme) |
|
280 | new_line, err = _line_format(line,'str',scheme) | |
281 | if not err: line = new_line |
|
281 | if not err: line = new_line | |
282 |
|
282 | |||
283 | if i == lnum: |
|
283 | if i == lnum: | |
284 | # This is the line with the error |
|
284 | # This is the line with the error | |
285 | pad = numbers_width - len(str(i)) |
|
285 | pad = numbers_width - len(str(i)) | |
286 | if pad >= 3: |
|
286 | if pad >= 3: | |
287 | marker = '-'*(pad-3) + '-> ' |
|
287 | marker = '-'*(pad-3) + '-> ' | |
288 | elif pad == 2: |
|
288 | elif pad == 2: | |
289 | marker = '> ' |
|
289 | marker = '> ' | |
290 | elif pad == 1: |
|
290 | elif pad == 1: | |
291 | marker = '>' |
|
291 | marker = '>' | |
292 | else: |
|
292 | else: | |
293 | marker = '' |
|
293 | marker = '' | |
294 | num = marker + str(i) |
|
294 | num = marker + str(i) | |
295 | line = '%s%s%s %s%s' %(Colors.linenoEm, num, |
|
295 | line = '%s%s%s %s%s' %(Colors.linenoEm, num, | |
296 | Colors.line, line, Colors.Normal) |
|
296 | Colors.line, line, Colors.Normal) | |
297 | else: |
|
297 | else: | |
298 | num = '%*s' % (numbers_width,i) |
|
298 | num = '%*s' % (numbers_width,i) | |
299 | line = '%s%s%s %s' %(Colors.lineno, num, |
|
299 | line = '%s%s%s %s' %(Colors.lineno, num, | |
300 | Colors.Normal, line) |
|
300 | Colors.Normal, line) | |
301 |
|
301 | |||
302 | res.append(line) |
|
302 | res.append(line) | |
303 | if lvals and i == lnum: |
|
303 | if lvals and i == lnum: | |
304 | res.append(lvals + '\n') |
|
304 | res.append(lvals + '\n') | |
305 | i = i + 1 |
|
305 | i = i + 1 | |
306 | return res |
|
306 | return res | |
307 |
|
307 | |||
308 |
|
308 | |||
309 | #--------------------------------------------------------------------------- |
|
309 | #--------------------------------------------------------------------------- | |
310 | # Module classes |
|
310 | # Module classes | |
311 | class TBTools: |
|
311 | class TBTools: | |
312 | """Basic tools used by all traceback printer classes.""" |
|
312 | """Basic tools used by all traceback printer classes.""" | |
313 |
|
313 | |||
314 | def __init__(self,color_scheme = 'NoColor',call_pdb=False): |
|
314 | def __init__(self,color_scheme = 'NoColor',call_pdb=False): | |
315 | # Whether to call the interactive pdb debugger after printing |
|
315 | # Whether to call the interactive pdb debugger after printing | |
316 | # tracebacks or not |
|
316 | # tracebacks or not | |
317 | self.call_pdb = call_pdb |
|
317 | self.call_pdb = call_pdb | |
318 |
|
318 | |||
319 | # Create color table |
|
319 | # Create color table | |
320 | self.color_scheme_table = exception_colors() |
|
320 | self.color_scheme_table = exception_colors() | |
321 |
|
321 | |||
322 | self.set_colors(color_scheme) |
|
322 | self.set_colors(color_scheme) | |
323 | self.old_scheme = color_scheme # save initial value for toggles |
|
323 | self.old_scheme = color_scheme # save initial value for toggles | |
324 |
|
324 | |||
325 | if call_pdb: |
|
325 | if call_pdb: | |
326 | self.pdb = debugger.Pdb(self.color_scheme_table.active_scheme_name) |
|
326 | self.pdb = debugger.Pdb(self.color_scheme_table.active_scheme_name) | |
327 | else: |
|
327 | else: | |
328 | self.pdb = None |
|
328 | self.pdb = None | |
329 |
|
329 | |||
330 | def set_colors(self,*args,**kw): |
|
330 | def set_colors(self,*args,**kw): | |
331 | """Shorthand access to the color table scheme selector method.""" |
|
331 | """Shorthand access to the color table scheme selector method.""" | |
332 |
|
332 | |||
333 | # Set own color table |
|
333 | # Set own color table | |
334 | self.color_scheme_table.set_active_scheme(*args,**kw) |
|
334 | self.color_scheme_table.set_active_scheme(*args,**kw) | |
335 | # for convenience, set Colors to the active scheme |
|
335 | # for convenience, set Colors to the active scheme | |
336 | self.Colors = self.color_scheme_table.active_colors |
|
336 | self.Colors = self.color_scheme_table.active_colors | |
337 | # Also set colors of debugger |
|
337 | # Also set colors of debugger | |
338 | if hasattr(self,'pdb') and self.pdb is not None: |
|
338 | if hasattr(self,'pdb') and self.pdb is not None: | |
339 | self.pdb.set_colors(*args,**kw) |
|
339 | self.pdb.set_colors(*args,**kw) | |
340 |
|
340 | |||
341 | def color_toggle(self): |
|
341 | def color_toggle(self): | |
342 | """Toggle between the currently active color scheme and NoColor.""" |
|
342 | """Toggle between the currently active color scheme and NoColor.""" | |
343 |
|
343 | |||
344 | if self.color_scheme_table.active_scheme_name == 'NoColor': |
|
344 | if self.color_scheme_table.active_scheme_name == 'NoColor': | |
345 | self.color_scheme_table.set_active_scheme(self.old_scheme) |
|
345 | self.color_scheme_table.set_active_scheme(self.old_scheme) | |
346 | self.Colors = self.color_scheme_table.active_colors |
|
346 | self.Colors = self.color_scheme_table.active_colors | |
347 | else: |
|
347 | else: | |
348 | self.old_scheme = self.color_scheme_table.active_scheme_name |
|
348 | self.old_scheme = self.color_scheme_table.active_scheme_name | |
349 | self.color_scheme_table.set_active_scheme('NoColor') |
|
349 | self.color_scheme_table.set_active_scheme('NoColor') | |
350 | self.Colors = self.color_scheme_table.active_colors |
|
350 | self.Colors = self.color_scheme_table.active_colors | |
351 |
|
351 | |||
352 | #--------------------------------------------------------------------------- |
|
352 | #--------------------------------------------------------------------------- | |
353 | class ListTB(TBTools): |
|
353 | class ListTB(TBTools): | |
354 | """Print traceback information from a traceback list, with optional color. |
|
354 | """Print traceback information from a traceback list, with optional color. | |
355 |
|
355 | |||
356 | Calling: requires 3 arguments: |
|
356 | Calling: requires 3 arguments: | |
357 | (etype, evalue, elist) |
|
357 | (etype, evalue, elist) | |
358 | as would be obtained by: |
|
358 | as would be obtained by: | |
359 | etype, evalue, tb = sys.exc_info() |
|
359 | etype, evalue, tb = sys.exc_info() | |
360 | if tb: |
|
360 | if tb: | |
361 | elist = traceback.extract_tb(tb) |
|
361 | elist = traceback.extract_tb(tb) | |
362 | else: |
|
362 | else: | |
363 | elist = None |
|
363 | elist = None | |
364 |
|
364 | |||
365 | It can thus be used by programs which need to process the traceback before |
|
365 | It can thus be used by programs which need to process the traceback before | |
366 | printing (such as console replacements based on the code module from the |
|
366 | printing (such as console replacements based on the code module from the | |
367 | standard library). |
|
367 | standard library). | |
368 |
|
368 | |||
369 | Because they are meant to be called without a full traceback (only a |
|
369 | Because they are meant to be called without a full traceback (only a | |
370 | list), instances of this class can't call the interactive pdb debugger.""" |
|
370 | list), instances of this class can't call the interactive pdb debugger.""" | |
371 |
|
371 | |||
372 | def __init__(self,color_scheme = 'NoColor'): |
|
372 | def __init__(self,color_scheme = 'NoColor'): | |
373 | TBTools.__init__(self,color_scheme = color_scheme,call_pdb=0) |
|
373 | TBTools.__init__(self,color_scheme = color_scheme,call_pdb=0) | |
374 |
|
374 | |||
375 | def __call__(self, etype, value, elist): |
|
375 | def __call__(self, etype, value, elist): | |
376 | Term.cout.flush() |
|
376 | Term.cout.flush() | |
377 | print >> Term.cerr, self.text(etype,value,elist) |
|
377 | print >> Term.cerr, self.text(etype,value,elist) | |
378 | Term.cerr.flush() |
|
378 | Term.cerr.flush() | |
379 |
|
379 | |||
380 | def text(self,etype, value, elist,context=5): |
|
380 | def text(self,etype, value, elist,context=5): | |
381 | """Return a color formatted string with the traceback info.""" |
|
381 | """Return a color formatted string with the traceback info.""" | |
382 |
|
382 | |||
383 | Colors = self.Colors |
|
383 | Colors = self.Colors | |
384 | out_string = ['%s%s%s\n' % (Colors.topline,'-'*60,Colors.Normal)] |
|
384 | out_string = ['%s%s%s\n' % (Colors.topline,'-'*60,Colors.Normal)] | |
385 | if elist: |
|
385 | if elist: | |
386 | out_string.append('Traceback %s(most recent call last)%s:' % \ |
|
386 | out_string.append('Traceback %s(most recent call last)%s:' % \ | |
387 | (Colors.normalEm, Colors.Normal) + '\n') |
|
387 | (Colors.normalEm, Colors.Normal) + '\n') | |
388 | out_string.extend(self._format_list(elist)) |
|
388 | out_string.extend(self._format_list(elist)) | |
389 | lines = self._format_exception_only(etype, value) |
|
389 | lines = self._format_exception_only(etype, value) | |
390 | for line in lines[:-1]: |
|
390 | for line in lines[:-1]: | |
391 | out_string.append(" "+line) |
|
391 | out_string.append(" "+line) | |
392 | out_string.append(lines[-1]) |
|
392 | out_string.append(lines[-1]) | |
393 | return ''.join(out_string) |
|
393 | return ''.join(out_string) | |
394 |
|
394 | |||
395 | def _format_list(self, extracted_list): |
|
395 | def _format_list(self, extracted_list): | |
396 | """Format a list of traceback entry tuples for printing. |
|
396 | """Format a list of traceback entry tuples for printing. | |
397 |
|
397 | |||
398 | Given a list of tuples as returned by extract_tb() or |
|
398 | Given a list of tuples as returned by extract_tb() or | |
399 | extract_stack(), return a list of strings ready for printing. |
|
399 | extract_stack(), return a list of strings ready for printing. | |
400 | Each string in the resulting list corresponds to the item with the |
|
400 | Each string in the resulting list corresponds to the item with the | |
401 | same index in the argument list. Each string ends in a newline; |
|
401 | same index in the argument list. Each string ends in a newline; | |
402 | the strings may contain internal newlines as well, for those items |
|
402 | the strings may contain internal newlines as well, for those items | |
403 | whose source text line is not None. |
|
403 | whose source text line is not None. | |
404 |
|
404 | |||
405 | Lifted almost verbatim from traceback.py |
|
405 | Lifted almost verbatim from traceback.py | |
406 | """ |
|
406 | """ | |
407 |
|
407 | |||
408 | Colors = self.Colors |
|
408 | Colors = self.Colors | |
409 | list = [] |
|
409 | list = [] | |
410 | for filename, lineno, name, line in extracted_list[:-1]: |
|
410 | for filename, lineno, name, line in extracted_list[:-1]: | |
411 | item = ' File %s"%s"%s, line %s%d%s, in %s%s%s\n' % \ |
|
411 | item = ' File %s"%s"%s, line %s%d%s, in %s%s%s\n' % \ | |
412 | (Colors.filename, filename, Colors.Normal, |
|
412 | (Colors.filename, filename, Colors.Normal, | |
413 | Colors.lineno, lineno, Colors.Normal, |
|
413 | Colors.lineno, lineno, Colors.Normal, | |
414 | Colors.name, name, Colors.Normal) |
|
414 | Colors.name, name, Colors.Normal) | |
415 | if line: |
|
415 | if line: | |
416 | item = item + ' %s\n' % line.strip() |
|
416 | item = item + ' %s\n' % line.strip() | |
417 | list.append(item) |
|
417 | list.append(item) | |
418 | # Emphasize the last entry |
|
418 | # Emphasize the last entry | |
419 | filename, lineno, name, line = extracted_list[-1] |
|
419 | filename, lineno, name, line = extracted_list[-1] | |
420 | item = '%s File %s"%s"%s, line %s%d%s, in %s%s%s%s\n' % \ |
|
420 | item = '%s File %s"%s"%s, line %s%d%s, in %s%s%s%s\n' % \ | |
421 | (Colors.normalEm, |
|
421 | (Colors.normalEm, | |
422 | Colors.filenameEm, filename, Colors.normalEm, |
|
422 | Colors.filenameEm, filename, Colors.normalEm, | |
423 | Colors.linenoEm, lineno, Colors.normalEm, |
|
423 | Colors.linenoEm, lineno, Colors.normalEm, | |
424 | Colors.nameEm, name, Colors.normalEm, |
|
424 | Colors.nameEm, name, Colors.normalEm, | |
425 | Colors.Normal) |
|
425 | Colors.Normal) | |
426 | if line: |
|
426 | if line: | |
427 | item = item + '%s %s%s\n' % (Colors.line, line.strip(), |
|
427 | item = item + '%s %s%s\n' % (Colors.line, line.strip(), | |
428 | Colors.Normal) |
|
428 | Colors.Normal) | |
429 | list.append(item) |
|
429 | list.append(item) | |
430 | return list |
|
430 | return list | |
431 |
|
431 | |||
432 | def _format_exception_only(self, etype, value): |
|
432 | def _format_exception_only(self, etype, value): | |
433 | """Format the exception part of a traceback. |
|
433 | """Format the exception part of a traceback. | |
434 |
|
434 | |||
435 | The arguments are the exception type and value such as given by |
|
435 | The arguments are the exception type and value such as given by | |
436 | sys.exc_info()[:2]. The return value is a list of strings, each ending |
|
436 | sys.exc_info()[:2]. The return value is a list of strings, each ending | |
437 | in a newline. Normally, the list contains a single string; however, |
|
437 | in a newline. Normally, the list contains a single string; however, | |
438 | for SyntaxError exceptions, it contains several lines that (when |
|
438 | for SyntaxError exceptions, it contains several lines that (when | |
439 | printed) display detailed information about where the syntax error |
|
439 | printed) display detailed information about where the syntax error | |
440 | occurred. The message indicating which exception occurred is the |
|
440 | occurred. The message indicating which exception occurred is the | |
441 | always last string in the list. |
|
441 | always last string in the list. | |
442 |
|
442 | |||
443 | Also lifted nearly verbatim from traceback.py |
|
443 | Also lifted nearly verbatim from traceback.py | |
444 | """ |
|
444 | """ | |
445 |
|
445 | |||
446 | have_filedata = False |
|
446 | have_filedata = False | |
447 | Colors = self.Colors |
|
447 | Colors = self.Colors | |
448 | list = [] |
|
448 | list = [] | |
449 | try: |
|
449 | try: | |
450 | stype = Colors.excName + etype.__name__ + Colors.Normal |
|
450 | stype = Colors.excName + etype.__name__ + Colors.Normal | |
451 | except AttributeError: |
|
451 | except AttributeError: | |
452 | stype = etype # String exceptions don't get special coloring |
|
452 | stype = etype # String exceptions don't get special coloring | |
453 | if value is None: |
|
453 | if value is None: | |
454 | list.append( str(stype) + '\n') |
|
454 | list.append( str(stype) + '\n') | |
455 | else: |
|
455 | else: | |
456 | if etype is SyntaxError: |
|
456 | if etype is SyntaxError: | |
457 | try: |
|
457 | try: | |
458 | msg, (filename, lineno, offset, line) = value |
|
458 | msg, (filename, lineno, offset, line) = value | |
459 | except: |
|
459 | except: | |
460 | have_filedata = False |
|
460 | have_filedata = False | |
461 | else: |
|
461 | else: | |
462 | have_filedata = True |
|
462 | have_filedata = True | |
463 | #print 'filename is',filename # dbg |
|
463 | #print 'filename is',filename # dbg | |
464 | if not filename: filename = "<string>" |
|
464 | if not filename: filename = "<string>" | |
465 | list.append('%s File %s"%s"%s, line %s%d%s\n' % \ |
|
465 | list.append('%s File %s"%s"%s, line %s%d%s\n' % \ | |
466 | (Colors.normalEm, |
|
466 | (Colors.normalEm, | |
467 | Colors.filenameEm, filename, Colors.normalEm, |
|
467 | Colors.filenameEm, filename, Colors.normalEm, | |
468 | Colors.linenoEm, lineno, Colors.Normal )) |
|
468 | Colors.linenoEm, lineno, Colors.Normal )) | |
469 | if line is not None: |
|
469 | if line is not None: | |
470 | i = 0 |
|
470 | i = 0 | |
471 | while i < len(line) and line[i].isspace(): |
|
471 | while i < len(line) and line[i].isspace(): | |
472 | i = i+1 |
|
472 | i = i+1 | |
473 | list.append('%s %s%s\n' % (Colors.line, |
|
473 | list.append('%s %s%s\n' % (Colors.line, | |
474 | line.strip(), |
|
474 | line.strip(), | |
475 | Colors.Normal)) |
|
475 | Colors.Normal)) | |
476 | if offset is not None: |
|
476 | if offset is not None: | |
477 | s = ' ' |
|
477 | s = ' ' | |
478 | for c in line[i:offset-1]: |
|
478 | for c in line[i:offset-1]: | |
479 | if c.isspace(): |
|
479 | if c.isspace(): | |
480 | s = s + c |
|
480 | s = s + c | |
481 | else: |
|
481 | else: | |
482 | s = s + ' ' |
|
482 | s = s + ' ' | |
483 | list.append('%s%s^%s\n' % (Colors.caret, s, |
|
483 | list.append('%s%s^%s\n' % (Colors.caret, s, | |
484 | Colors.Normal) ) |
|
484 | Colors.Normal) ) | |
485 | value = msg |
|
485 | value = msg | |
486 | s = self._some_str(value) |
|
486 | s = self._some_str(value) | |
487 | if s: |
|
487 | if s: | |
488 | list.append('%s%s:%s %s\n' % (str(stype), Colors.excName, |
|
488 | list.append('%s%s:%s %s\n' % (str(stype), Colors.excName, | |
489 | Colors.Normal, s)) |
|
489 | Colors.Normal, s)) | |
490 | else: |
|
490 | else: | |
491 | list.append('%s\n' % str(stype)) |
|
491 | list.append('%s\n' % str(stype)) | |
492 |
|
492 | |||
493 | # This is being commented out for now as the __IPYTHON__ variable |
|
493 | # This is being commented out for now as the __IPYTHON__ variable | |
494 | # referenced here is not resolved and causes massive test failures |
|
494 | # referenced here is not resolved and causes massive test failures | |
495 | # and errors. B. Granger, 04/2009. XXX |
|
495 | # and errors. B. Granger, 04/2009. XXX | |
496 | # See https://bugs.launchpad.net/bugs/362137 |
|
496 | # See https://bugs.launchpad.net/bugs/362137 | |
497 | # # vds:>> |
|
497 | # # vds:>> | |
498 | # if have_filedata: |
|
498 | # if have_filedata: | |
499 | # __IPYTHON__.hooks.synchronize_with_editor(filename, lineno, 0) |
|
499 | # __IPYTHON__.hooks.synchronize_with_editor(filename, lineno, 0) | |
500 | # # vds:<< |
|
500 | # # vds:<< | |
501 |
|
501 | |||
502 | return list |
|
502 | return list | |
503 |
|
503 | |||
504 | def _some_str(self, value): |
|
504 | def _some_str(self, value): | |
505 | # Lifted from traceback.py |
|
505 | # Lifted from traceback.py | |
506 | try: |
|
506 | try: | |
507 | return str(value) |
|
507 | return str(value) | |
508 | except: |
|
508 | except: | |
509 | return '<unprintable %s object>' % type(value).__name__ |
|
509 | return '<unprintable %s object>' % type(value).__name__ | |
510 |
|
510 | |||
511 | #---------------------------------------------------------------------------- |
|
511 | #---------------------------------------------------------------------------- | |
512 | class VerboseTB(TBTools): |
|
512 | class VerboseTB(TBTools): | |
513 | """A port of Ka-Ping Yee's cgitb.py module that outputs color text instead |
|
513 | """A port of Ka-Ping Yee's cgitb.py module that outputs color text instead | |
514 | of HTML. Requires inspect and pydoc. Crazy, man. |
|
514 | of HTML. Requires inspect and pydoc. Crazy, man. | |
515 |
|
515 | |||
516 | Modified version which optionally strips the topmost entries from the |
|
516 | Modified version which optionally strips the topmost entries from the | |
517 | traceback, to be used with alternate interpreters (because their own code |
|
517 | traceback, to be used with alternate interpreters (because their own code | |
518 | would appear in the traceback).""" |
|
518 | would appear in the traceback).""" | |
519 |
|
519 | |||
520 | def __init__(self,color_scheme = 'Linux',tb_offset=0,long_header=0, |
|
520 | def __init__(self,color_scheme = 'Linux',tb_offset=0,long_header=0, | |
521 | call_pdb = 0, include_vars=1): |
|
521 | call_pdb = 0, include_vars=1): | |
522 | """Specify traceback offset, headers and color scheme. |
|
522 | """Specify traceback offset, headers and color scheme. | |
523 |
|
523 | |||
524 | Define how many frames to drop from the tracebacks. Calling it with |
|
524 | Define how many frames to drop from the tracebacks. Calling it with | |
525 | tb_offset=1 allows use of this handler in interpreters which will have |
|
525 | tb_offset=1 allows use of this handler in interpreters which will have | |
526 | their own code at the top of the traceback (VerboseTB will first |
|
526 | their own code at the top of the traceback (VerboseTB will first | |
527 | remove that frame before printing the traceback info).""" |
|
527 | remove that frame before printing the traceback info).""" | |
528 | TBTools.__init__(self,color_scheme=color_scheme,call_pdb=call_pdb) |
|
528 | TBTools.__init__(self,color_scheme=color_scheme,call_pdb=call_pdb) | |
529 | self.tb_offset = tb_offset |
|
529 | self.tb_offset = tb_offset | |
530 | self.long_header = long_header |
|
530 | self.long_header = long_header | |
531 | self.include_vars = include_vars |
|
531 | self.include_vars = include_vars | |
532 |
|
532 | |||
533 | def text(self, etype, evalue, etb, context=5): |
|
533 | def text(self, etype, evalue, etb, context=5): | |
534 | """Return a nice text document describing the traceback.""" |
|
534 | """Return a nice text document describing the traceback.""" | |
535 |
|
535 | |||
536 | # some locals |
|
536 | # some locals | |
537 | try: |
|
537 | try: | |
538 | etype = etype.__name__ |
|
538 | etype = etype.__name__ | |
539 | except AttributeError: |
|
539 | except AttributeError: | |
540 | pass |
|
540 | pass | |
541 | Colors = self.Colors # just a shorthand + quicker name lookup |
|
541 | Colors = self.Colors # just a shorthand + quicker name lookup | |
542 | ColorsNormal = Colors.Normal # used a lot |
|
542 | ColorsNormal = Colors.Normal # used a lot | |
543 | col_scheme = self.color_scheme_table.active_scheme_name |
|
543 | col_scheme = self.color_scheme_table.active_scheme_name | |
544 | indent = ' '*INDENT_SIZE |
|
544 | indent = ' '*INDENT_SIZE | |
545 | em_normal = '%s\n%s%s' % (Colors.valEm, indent,ColorsNormal) |
|
545 | em_normal = '%s\n%s%s' % (Colors.valEm, indent,ColorsNormal) | |
546 | undefined = '%sundefined%s' % (Colors.em, ColorsNormal) |
|
546 | undefined = '%sundefined%s' % (Colors.em, ColorsNormal) | |
547 | exc = '%s%s%s' % (Colors.excName,etype,ColorsNormal) |
|
547 | exc = '%s%s%s' % (Colors.excName,etype,ColorsNormal) | |
548 |
|
548 | |||
549 | # some internal-use functions |
|
549 | # some internal-use functions | |
550 | def text_repr(value): |
|
550 | def text_repr(value): | |
551 | """Hopefully pretty robust repr equivalent.""" |
|
551 | """Hopefully pretty robust repr equivalent.""" | |
552 | # this is pretty horrible but should always return *something* |
|
552 | # this is pretty horrible but should always return *something* | |
553 | try: |
|
553 | try: | |
554 | return pydoc.text.repr(value) |
|
554 | return pydoc.text.repr(value) | |
555 | except KeyboardInterrupt: |
|
555 | except KeyboardInterrupt: | |
556 | raise |
|
556 | raise | |
557 | except: |
|
557 | except: | |
558 | try: |
|
558 | try: | |
559 | return repr(value) |
|
559 | return repr(value) | |
560 | except KeyboardInterrupt: |
|
560 | except KeyboardInterrupt: | |
561 | raise |
|
561 | raise | |
562 | except: |
|
562 | except: | |
563 | try: |
|
563 | try: | |
564 | # all still in an except block so we catch |
|
564 | # all still in an except block so we catch | |
565 | # getattr raising |
|
565 | # getattr raising | |
566 | name = getattr(value, '__name__', None) |
|
566 | name = getattr(value, '__name__', None) | |
567 | if name: |
|
567 | if name: | |
568 | # ick, recursion |
|
568 | # ick, recursion | |
569 | return text_repr(name) |
|
569 | return text_repr(name) | |
570 | klass = getattr(value, '__class__', None) |
|
570 | klass = getattr(value, '__class__', None) | |
571 | if klass: |
|
571 | if klass: | |
572 | return '%s instance' % text_repr(klass) |
|
572 | return '%s instance' % text_repr(klass) | |
573 | except KeyboardInterrupt: |
|
573 | except KeyboardInterrupt: | |
574 | raise |
|
574 | raise | |
575 | except: |
|
575 | except: | |
576 | return 'UNRECOVERABLE REPR FAILURE' |
|
576 | return 'UNRECOVERABLE REPR FAILURE' | |
577 | def eqrepr(value, repr=text_repr): return '=%s' % repr(value) |
|
577 | def eqrepr(value, repr=text_repr): return '=%s' % repr(value) | |
578 | def nullrepr(value, repr=text_repr): return '' |
|
578 | def nullrepr(value, repr=text_repr): return '' | |
579 |
|
579 | |||
580 | # meat of the code begins |
|
580 | # meat of the code begins | |
581 | try: |
|
581 | try: | |
582 | etype = etype.__name__ |
|
582 | etype = etype.__name__ | |
583 | except AttributeError: |
|
583 | except AttributeError: | |
584 | pass |
|
584 | pass | |
585 |
|
585 | |||
586 | if self.long_header: |
|
586 | if self.long_header: | |
587 | # Header with the exception type, python version, and date |
|
587 | # Header with the exception type, python version, and date | |
588 | pyver = 'Python ' + string.split(sys.version)[0] + ': ' + sys.executable |
|
588 | pyver = 'Python ' + string.split(sys.version)[0] + ': ' + sys.executable | |
589 | date = time.ctime(time.time()) |
|
589 | date = time.ctime(time.time()) | |
590 |
|
590 | |||
591 | head = '%s%s%s\n%s%s%s\n%s' % (Colors.topline, '-'*75, ColorsNormal, |
|
591 | head = '%s%s%s\n%s%s%s\n%s' % (Colors.topline, '-'*75, ColorsNormal, | |
592 | exc, ' '*(75-len(str(etype))-len(pyver)), |
|
592 | exc, ' '*(75-len(str(etype))-len(pyver)), | |
593 | pyver, string.rjust(date, 75) ) |
|
593 | pyver, string.rjust(date, 75) ) | |
594 | head += "\nA problem occured executing Python code. Here is the sequence of function"\ |
|
594 | head += "\nA problem occured executing Python code. Here is the sequence of function"\ | |
595 | "\ncalls leading up to the error, with the most recent (innermost) call last." |
|
595 | "\ncalls leading up to the error, with the most recent (innermost) call last." | |
596 | else: |
|
596 | else: | |
597 | # Simplified header |
|
597 | # Simplified header | |
598 | head = '%s%s%s\n%s%s' % (Colors.topline, '-'*75, ColorsNormal,exc, |
|
598 | head = '%s%s%s\n%s%s' % (Colors.topline, '-'*75, ColorsNormal,exc, | |
599 | string.rjust('Traceback (most recent call last)', |
|
599 | string.rjust('Traceback (most recent call last)', | |
600 | 75 - len(str(etype)) ) ) |
|
600 | 75 - len(str(etype)) ) ) | |
601 | frames = [] |
|
601 | frames = [] | |
602 | # Flush cache before calling inspect. This helps alleviate some of the |
|
602 | # Flush cache before calling inspect. This helps alleviate some of the | |
603 | # problems with python 2.3's inspect.py. |
|
603 | # problems with python 2.3's inspect.py. | |
604 | linecache.checkcache() |
|
604 | linecache.checkcache() | |
605 | # Drop topmost frames if requested |
|
605 | # Drop topmost frames if requested | |
606 | try: |
|
606 | try: | |
607 | # Try the default getinnerframes and Alex's: Alex's fixes some |
|
607 | # Try the default getinnerframes and Alex's: Alex's fixes some | |
608 | # problems, but it generates empty tracebacks for console errors |
|
608 | # problems, but it generates empty tracebacks for console errors | |
609 | # (5 blanks lines) where none should be returned. |
|
609 | # (5 blanks lines) where none should be returned. | |
610 | #records = inspect.getinnerframes(etb, context)[self.tb_offset:] |
|
610 | #records = inspect.getinnerframes(etb, context)[self.tb_offset:] | |
611 | #print 'python records:', records # dbg |
|
611 | #print 'python records:', records # dbg | |
612 | records = _fixed_getinnerframes(etb, context,self.tb_offset) |
|
612 | records = _fixed_getinnerframes(etb, context,self.tb_offset) | |
613 | #print 'alex records:', records # dbg |
|
613 | #print 'alex records:', records # dbg | |
614 | except: |
|
614 | except: | |
615 |
|
615 | |||
616 | # FIXME: I've been getting many crash reports from python 2.3 |
|
616 | # FIXME: I've been getting many crash reports from python 2.3 | |
617 | # users, traceable to inspect.py. If I can find a small test-case |
|
617 | # users, traceable to inspect.py. If I can find a small test-case | |
618 | # to reproduce this, I should either write a better workaround or |
|
618 | # to reproduce this, I should either write a better workaround or | |
619 | # file a bug report against inspect (if that's the real problem). |
|
619 | # file a bug report against inspect (if that's the real problem). | |
620 | # So far, I haven't been able to find an isolated example to |
|
620 | # So far, I haven't been able to find an isolated example to | |
621 | # reproduce the problem. |
|
621 | # reproduce the problem. | |
622 | inspect_error() |
|
622 | inspect_error() | |
623 | traceback.print_exc(file=Term.cerr) |
|
623 | traceback.print_exc(file=Term.cerr) | |
624 | info('\nUnfortunately, your original traceback can not be constructed.\n') |
|
624 | info('\nUnfortunately, your original traceback can not be constructed.\n') | |
625 | return '' |
|
625 | return '' | |
626 |
|
626 | |||
627 | # build some color string templates outside these nested loops |
|
627 | # build some color string templates outside these nested loops | |
628 | tpl_link = '%s%%s%s' % (Colors.filenameEm,ColorsNormal) |
|
628 | tpl_link = '%s%%s%s' % (Colors.filenameEm,ColorsNormal) | |
629 | tpl_call = 'in %s%%s%s%%s%s' % (Colors.vName, Colors.valEm, |
|
629 | tpl_call = 'in %s%%s%s%%s%s' % (Colors.vName, Colors.valEm, | |
630 | ColorsNormal) |
|
630 | ColorsNormal) | |
631 | tpl_call_fail = 'in %s%%s%s(***failed resolving arguments***)%s' % \ |
|
631 | tpl_call_fail = 'in %s%%s%s(***failed resolving arguments***)%s' % \ | |
632 | (Colors.vName, Colors.valEm, ColorsNormal) |
|
632 | (Colors.vName, Colors.valEm, ColorsNormal) | |
633 | tpl_local_var = '%s%%s%s' % (Colors.vName, ColorsNormal) |
|
633 | tpl_local_var = '%s%%s%s' % (Colors.vName, ColorsNormal) | |
634 | tpl_global_var = '%sglobal%s %s%%s%s' % (Colors.em, ColorsNormal, |
|
634 | tpl_global_var = '%sglobal%s %s%%s%s' % (Colors.em, ColorsNormal, | |
635 | Colors.vName, ColorsNormal) |
|
635 | Colors.vName, ColorsNormal) | |
636 | tpl_name_val = '%%s %s= %%s%s' % (Colors.valEm, ColorsNormal) |
|
636 | tpl_name_val = '%%s %s= %%s%s' % (Colors.valEm, ColorsNormal) | |
637 | tpl_line = '%s%%s%s %%s' % (Colors.lineno, ColorsNormal) |
|
637 | tpl_line = '%s%%s%s %%s' % (Colors.lineno, ColorsNormal) | |
638 | tpl_line_em = '%s%%s%s %%s%s' % (Colors.linenoEm,Colors.line, |
|
638 | tpl_line_em = '%s%%s%s %%s%s' % (Colors.linenoEm,Colors.line, | |
639 | ColorsNormal) |
|
639 | ColorsNormal) | |
640 |
|
640 | |||
641 | # now, loop over all records printing context and info |
|
641 | # now, loop over all records printing context and info | |
642 | abspath = os.path.abspath |
|
642 | abspath = os.path.abspath | |
643 | for frame, file, lnum, func, lines, index in records: |
|
643 | for frame, file, lnum, func, lines, index in records: | |
644 | #print '*** record:',file,lnum,func,lines,index # dbg |
|
644 | #print '*** record:',file,lnum,func,lines,index # dbg | |
645 | try: |
|
645 | try: | |
646 | file = file and abspath(file) or '?' |
|
646 | file = file and abspath(file) or '?' | |
647 | except OSError: |
|
647 | except OSError: | |
648 | # if file is '<console>' or something not in the filesystem, |
|
648 | # if file is '<console>' or something not in the filesystem, | |
649 | # the abspath call will throw an OSError. Just ignore it and |
|
649 | # the abspath call will throw an OSError. Just ignore it and | |
650 | # keep the original file string. |
|
650 | # keep the original file string. | |
651 | pass |
|
651 | pass | |
652 | link = tpl_link % file |
|
652 | link = tpl_link % file | |
653 | try: |
|
653 | try: | |
654 | args, varargs, varkw, locals = inspect.getargvalues(frame) |
|
654 | args, varargs, varkw, locals = inspect.getargvalues(frame) | |
655 | except: |
|
655 | except: | |
656 | # This can happen due to a bug in python2.3. We should be |
|
656 | # This can happen due to a bug in python2.3. We should be | |
657 | # able to remove this try/except when 2.4 becomes a |
|
657 | # able to remove this try/except when 2.4 becomes a | |
658 | # requirement. Bug details at http://python.org/sf/1005466 |
|
658 | # requirement. Bug details at http://python.org/sf/1005466 | |
659 | inspect_error() |
|
659 | inspect_error() | |
660 | traceback.print_exc(file=Term.cerr) |
|
660 | traceback.print_exc(file=Term.cerr) | |
661 | info("\nIPython's exception reporting continues...\n") |
|
661 | info("\nIPython's exception reporting continues...\n") | |
662 |
|
662 | |||
663 | if func == '?': |
|
663 | if func == '?': | |
664 | call = '' |
|
664 | call = '' | |
665 | else: |
|
665 | else: | |
666 | # Decide whether to include variable details or not |
|
666 | # Decide whether to include variable details or not | |
667 | var_repr = self.include_vars and eqrepr or nullrepr |
|
667 | var_repr = self.include_vars and eqrepr or nullrepr | |
668 | try: |
|
668 | try: | |
669 | call = tpl_call % (func,inspect.formatargvalues(args, |
|
669 | call = tpl_call % (func,inspect.formatargvalues(args, | |
670 | varargs, varkw, |
|
670 | varargs, varkw, | |
671 | locals,formatvalue=var_repr)) |
|
671 | locals,formatvalue=var_repr)) | |
672 | except KeyError: |
|
672 | except KeyError: | |
673 | # Very odd crash from inspect.formatargvalues(). The |
|
673 | # Very odd crash from inspect.formatargvalues(). The | |
674 | # scenario under which it appeared was a call to |
|
674 | # scenario under which it appeared was a call to | |
675 | # view(array,scale) in NumTut.view.view(), where scale had |
|
675 | # view(array,scale) in NumTut.view.view(), where scale had | |
676 | # been defined as a scalar (it should be a tuple). Somehow |
|
676 | # been defined as a scalar (it should be a tuple). Somehow | |
677 | # inspect messes up resolving the argument list of view() |
|
677 | # inspect messes up resolving the argument list of view() | |
678 | # and barfs out. At some point I should dig into this one |
|
678 | # and barfs out. At some point I should dig into this one | |
679 | # and file a bug report about it. |
|
679 | # and file a bug report about it. | |
680 | inspect_error() |
|
680 | inspect_error() | |
681 | traceback.print_exc(file=Term.cerr) |
|
681 | traceback.print_exc(file=Term.cerr) | |
682 | info("\nIPython's exception reporting continues...\n") |
|
682 | info("\nIPython's exception reporting continues...\n") | |
683 | call = tpl_call_fail % func |
|
683 | call = tpl_call_fail % func | |
684 |
|
684 | |||
685 | # Initialize a list of names on the current line, which the |
|
685 | # Initialize a list of names on the current line, which the | |
686 | # tokenizer below will populate. |
|
686 | # tokenizer below will populate. | |
687 | names = [] |
|
687 | names = [] | |
688 |
|
688 | |||
689 | def tokeneater(token_type, token, start, end, line): |
|
689 | def tokeneater(token_type, token, start, end, line): | |
690 | """Stateful tokeneater which builds dotted names. |
|
690 | """Stateful tokeneater which builds dotted names. | |
691 |
|
691 | |||
692 | The list of names it appends to (from the enclosing scope) can |
|
692 | The list of names it appends to (from the enclosing scope) can | |
693 | contain repeated composite names. This is unavoidable, since |
|
693 | contain repeated composite names. This is unavoidable, since | |
694 | there is no way to disambguate partial dotted structures until |
|
694 | there is no way to disambguate partial dotted structures until | |
695 | the full list is known. The caller is responsible for pruning |
|
695 | the full list is known. The caller is responsible for pruning | |
696 | the final list of duplicates before using it.""" |
|
696 | the final list of duplicates before using it.""" | |
697 |
|
697 | |||
698 | # build composite names |
|
698 | # build composite names | |
699 | if token == '.': |
|
699 | if token == '.': | |
700 | try: |
|
700 | try: | |
701 | names[-1] += '.' |
|
701 | names[-1] += '.' | |
702 | # store state so the next token is added for x.y.z names |
|
702 | # store state so the next token is added for x.y.z names | |
703 | tokeneater.name_cont = True |
|
703 | tokeneater.name_cont = True | |
704 | return |
|
704 | return | |
705 | except IndexError: |
|
705 | except IndexError: | |
706 | pass |
|
706 | pass | |
707 | if token_type == tokenize.NAME and token not in keyword.kwlist: |
|
707 | if token_type == tokenize.NAME and token not in keyword.kwlist: | |
708 | if tokeneater.name_cont: |
|
708 | if tokeneater.name_cont: | |
709 | # Dotted names |
|
709 | # Dotted names | |
710 | names[-1] += token |
|
710 | names[-1] += token | |
711 | tokeneater.name_cont = False |
|
711 | tokeneater.name_cont = False | |
712 | else: |
|
712 | else: | |
713 | # Regular new names. We append everything, the caller |
|
713 | # Regular new names. We append everything, the caller | |
714 | # will be responsible for pruning the list later. It's |
|
714 | # will be responsible for pruning the list later. It's | |
715 | # very tricky to try to prune as we go, b/c composite |
|
715 | # very tricky to try to prune as we go, b/c composite | |
716 | # names can fool us. The pruning at the end is easy |
|
716 | # names can fool us. The pruning at the end is easy | |
717 | # to do (or the caller can print a list with repeated |
|
717 | # to do (or the caller can print a list with repeated | |
718 | # names if so desired. |
|
718 | # names if so desired. | |
719 | names.append(token) |
|
719 | names.append(token) | |
720 | elif token_type == tokenize.NEWLINE: |
|
720 | elif token_type == tokenize.NEWLINE: | |
721 | raise IndexError |
|
721 | raise IndexError | |
722 | # we need to store a bit of state in the tokenizer to build |
|
722 | # we need to store a bit of state in the tokenizer to build | |
723 | # dotted names |
|
723 | # dotted names | |
724 | tokeneater.name_cont = False |
|
724 | tokeneater.name_cont = False | |
725 |
|
725 | |||
726 | def linereader(file=file, lnum=[lnum], getline=linecache.getline): |
|
726 | def linereader(file=file, lnum=[lnum], getline=linecache.getline): | |
727 | line = getline(file, lnum[0]) |
|
727 | line = getline(file, lnum[0]) | |
728 | lnum[0] += 1 |
|
728 | lnum[0] += 1 | |
729 | return line |
|
729 | return line | |
730 |
|
730 | |||
731 | # Build the list of names on this line of code where the exception |
|
731 | # Build the list of names on this line of code where the exception | |
732 | # occurred. |
|
732 | # occurred. | |
733 | try: |
|
733 | try: | |
734 | # This builds the names list in-place by capturing it from the |
|
734 | # This builds the names list in-place by capturing it from the | |
735 | # enclosing scope. |
|
735 | # enclosing scope. | |
736 | tokenize.tokenize(linereader, tokeneater) |
|
736 | tokenize.tokenize(linereader, tokeneater) | |
737 | except IndexError: |
|
737 | except IndexError: | |
738 | # signals exit of tokenizer |
|
738 | # signals exit of tokenizer | |
739 | pass |
|
739 | pass | |
740 | except tokenize.TokenError,msg: |
|
740 | except tokenize.TokenError,msg: | |
741 | _m = ("An unexpected error occurred while tokenizing input\n" |
|
741 | _m = ("An unexpected error occurred while tokenizing input\n" | |
742 | "The following traceback may be corrupted or invalid\n" |
|
742 | "The following traceback may be corrupted or invalid\n" | |
743 | "The error message is: %s\n" % msg) |
|
743 | "The error message is: %s\n" % msg) | |
744 | error(_m) |
|
744 | error(_m) | |
745 |
|
745 | |||
746 | # prune names list of duplicates, but keep the right order |
|
746 | # prune names list of duplicates, but keep the right order | |
747 | unique_names = uniq_stable(names) |
|
747 | unique_names = uniq_stable(names) | |
748 |
|
748 | |||
749 | # Start loop over vars |
|
749 | # Start loop over vars | |
750 | lvals = [] |
|
750 | lvals = [] | |
751 | if self.include_vars: |
|
751 | if self.include_vars: | |
752 | for name_full in unique_names: |
|
752 | for name_full in unique_names: | |
753 | name_base = name_full.split('.',1)[0] |
|
753 | name_base = name_full.split('.',1)[0] | |
754 | if name_base in frame.f_code.co_varnames: |
|
754 | if name_base in frame.f_code.co_varnames: | |
755 | if locals.has_key(name_base): |
|
755 | if locals.has_key(name_base): | |
756 | try: |
|
756 | try: | |
757 | value = repr(eval(name_full,locals)) |
|
757 | value = repr(eval(name_full,locals)) | |
758 | except: |
|
758 | except: | |
759 | value = undefined |
|
759 | value = undefined | |
760 | else: |
|
760 | else: | |
761 | value = undefined |
|
761 | value = undefined | |
762 | name = tpl_local_var % name_full |
|
762 | name = tpl_local_var % name_full | |
763 | else: |
|
763 | else: | |
764 | if frame.f_globals.has_key(name_base): |
|
764 | if frame.f_globals.has_key(name_base): | |
765 | try: |
|
765 | try: | |
766 | value = repr(eval(name_full,frame.f_globals)) |
|
766 | value = repr(eval(name_full,frame.f_globals)) | |
767 | except: |
|
767 | except: | |
768 | value = undefined |
|
768 | value = undefined | |
769 | else: |
|
769 | else: | |
770 | value = undefined |
|
770 | value = undefined | |
771 | name = tpl_global_var % name_full |
|
771 | name = tpl_global_var % name_full | |
772 | lvals.append(tpl_name_val % (name,value)) |
|
772 | lvals.append(tpl_name_val % (name,value)) | |
773 | if lvals: |
|
773 | if lvals: | |
774 | lvals = '%s%s' % (indent,em_normal.join(lvals)) |
|
774 | lvals = '%s%s' % (indent,em_normal.join(lvals)) | |
775 | else: |
|
775 | else: | |
776 | lvals = '' |
|
776 | lvals = '' | |
777 |
|
777 | |||
778 | level = '%s %s\n' % (link,call) |
|
778 | level = '%s %s\n' % (link,call) | |
779 |
|
779 | |||
780 | if index is None: |
|
780 | if index is None: | |
781 | frames.append(level) |
|
781 | frames.append(level) | |
782 | else: |
|
782 | else: | |
783 | frames.append('%s%s' % (level,''.join( |
|
783 | frames.append('%s%s' % (level,''.join( | |
784 | _formatTracebackLines(lnum,index,lines,Colors,lvals, |
|
784 | _formatTracebackLines(lnum,index,lines,Colors,lvals, | |
785 | col_scheme)))) |
|
785 | col_scheme)))) | |
786 |
|
786 | |||
787 | # Get (safely) a string form of the exception info |
|
787 | # Get (safely) a string form of the exception info | |
788 | try: |
|
788 | try: | |
789 | etype_str,evalue_str = map(str,(etype,evalue)) |
|
789 | etype_str,evalue_str = map(str,(etype,evalue)) | |
790 | except: |
|
790 | except: | |
791 | # User exception is improperly defined. |
|
791 | # User exception is improperly defined. | |
792 | etype,evalue = str,sys.exc_info()[:2] |
|
792 | etype,evalue = str,sys.exc_info()[:2] | |
793 | etype_str,evalue_str = map(str,(etype,evalue)) |
|
793 | etype_str,evalue_str = map(str,(etype,evalue)) | |
794 | # ... and format it |
|
794 | # ... and format it | |
795 | exception = ['%s%s%s: %s' % (Colors.excName, etype_str, |
|
795 | exception = ['%s%s%s: %s' % (Colors.excName, etype_str, | |
796 | ColorsNormal, evalue_str)] |
|
796 | ColorsNormal, evalue_str)] | |
797 | if type(evalue) is types.InstanceType: |
|
797 | if type(evalue) is types.InstanceType: | |
798 | try: |
|
798 | try: | |
799 | names = [w for w in dir(evalue) if isinstance(w, basestring)] |
|
799 | names = [w for w in dir(evalue) if isinstance(w, basestring)] | |
800 | except: |
|
800 | except: | |
801 | # Every now and then, an object with funny inernals blows up |
|
801 | # Every now and then, an object with funny inernals blows up | |
802 | # when dir() is called on it. We do the best we can to report |
|
802 | # when dir() is called on it. We do the best we can to report | |
803 | # the problem and continue |
|
803 | # the problem and continue | |
804 | _m = '%sException reporting error (object with broken dir())%s:' |
|
804 | _m = '%sException reporting error (object with broken dir())%s:' | |
805 | exception.append(_m % (Colors.excName,ColorsNormal)) |
|
805 | exception.append(_m % (Colors.excName,ColorsNormal)) | |
806 | etype_str,evalue_str = map(str,sys.exc_info()[:2]) |
|
806 | etype_str,evalue_str = map(str,sys.exc_info()[:2]) | |
807 | exception.append('%s%s%s: %s' % (Colors.excName,etype_str, |
|
807 | exception.append('%s%s%s: %s' % (Colors.excName,etype_str, | |
808 | ColorsNormal, evalue_str)) |
|
808 | ColorsNormal, evalue_str)) | |
809 | names = [] |
|
809 | names = [] | |
810 | for name in names: |
|
810 | for name in names: | |
811 | value = text_repr(getattr(evalue, name)) |
|
811 | value = text_repr(getattr(evalue, name)) | |
812 | exception.append('\n%s%s = %s' % (indent, name, value)) |
|
812 | exception.append('\n%s%s = %s' % (indent, name, value)) | |
813 |
|
813 | |||
814 | # This is being commented out for now as the __IPYTHON__ variable |
|
814 | # This is being commented out for now as the __IPYTHON__ variable | |
815 | # referenced here is not resolved and causes massive test failures |
|
815 | # referenced here is not resolved and causes massive test failures | |
816 | # and errors. B. Granger, 04/2009. XXX |
|
816 | # and errors. B. Granger, 04/2009. XXX | |
817 | # See https://bugs.launchpad.net/bugs/362137 |
|
817 | # See https://bugs.launchpad.net/bugs/362137 | |
818 | # # vds: >> |
|
818 | # # vds: >> | |
819 | # if records: |
|
819 | # if records: | |
820 | # filepath, lnum = records[-1][1:3] |
|
820 | # filepath, lnum = records[-1][1:3] | |
821 | # #print "file:", str(file), "linenb", str(lnum) # dbg |
|
821 | # #print "file:", str(file), "linenb", str(lnum) # dbg | |
822 | # filepath = os.path.abspath(filepath) |
|
822 | # filepath = os.path.abspath(filepath) | |
823 | # __IPYTHON__.hooks.synchronize_with_editor(filepath, lnum, 0) |
|
823 | # __IPYTHON__.hooks.synchronize_with_editor(filepath, lnum, 0) | |
824 | # # vds: << |
|
824 | # # vds: << | |
825 |
|
825 | |||
826 | # return all our info assembled as a single string |
|
826 | # return all our info assembled as a single string | |
827 | return '%s\n\n%s\n%s' % (head,'\n'.join(frames),''.join(exception[0]) ) |
|
827 | return '%s\n\n%s\n%s' % (head,'\n'.join(frames),''.join(exception[0]) ) | |
828 |
|
828 | |||
829 | def debugger(self,force=False): |
|
829 | def debugger(self,force=False): | |
830 | """Call up the pdb debugger if desired, always clean up the tb |
|
830 | """Call up the pdb debugger if desired, always clean up the tb | |
831 | reference. |
|
831 | reference. | |
832 |
|
832 | |||
833 | Keywords: |
|
833 | Keywords: | |
834 |
|
834 | |||
835 | - force(False): by default, this routine checks the instance call_pdb |
|
835 | - force(False): by default, this routine checks the instance call_pdb | |
836 | flag and does not actually invoke the debugger if the flag is false. |
|
836 | flag and does not actually invoke the debugger if the flag is false. | |
837 | The 'force' option forces the debugger to activate even if the flag |
|
837 | The 'force' option forces the debugger to activate even if the flag | |
838 | is false. |
|
838 | is false. | |
839 |
|
839 | |||
840 | If the call_pdb flag is set, the pdb interactive debugger is |
|
840 | If the call_pdb flag is set, the pdb interactive debugger is | |
841 | invoked. In all cases, the self.tb reference to the current traceback |
|
841 | invoked. In all cases, the self.tb reference to the current traceback | |
842 | is deleted to prevent lingering references which hamper memory |
|
842 | is deleted to prevent lingering references which hamper memory | |
843 | management. |
|
843 | management. | |
844 |
|
844 | |||
845 | Note that each call to pdb() does an 'import readline', so if your app |
|
845 | Note that each call to pdb() does an 'import readline', so if your app | |
846 | requires a special setup for the readline completers, you'll have to |
|
846 | requires a special setup for the readline completers, you'll have to | |
847 | fix that by hand after invoking the exception handler.""" |
|
847 | fix that by hand after invoking the exception handler.""" | |
848 |
|
848 | |||
849 | if force or self.call_pdb: |
|
849 | if force or self.call_pdb: | |
850 | if self.pdb is None: |
|
850 | if self.pdb is None: | |
851 | self.pdb = debugger.Pdb( |
|
851 | self.pdb = debugger.Pdb( | |
852 | self.color_scheme_table.active_scheme_name) |
|
852 | self.color_scheme_table.active_scheme_name) | |
853 | # the system displayhook may have changed, restore the original |
|
853 | # the system displayhook may have changed, restore the original | |
854 | # for pdb |
|
854 | # for pdb | |
855 | dhook = sys.displayhook |
|
855 | dhook = sys.displayhook | |
856 | sys.displayhook = sys.__displayhook__ |
|
856 | sys.displayhook = sys.__displayhook__ | |
857 | self.pdb.reset() |
|
857 | self.pdb.reset() | |
858 | # Find the right frame so we don't pop up inside ipython itself |
|
858 | # Find the right frame so we don't pop up inside ipython itself | |
859 | if hasattr(self,'tb'): |
|
859 | if hasattr(self,'tb'): | |
860 | etb = self.tb |
|
860 | etb = self.tb | |
861 | else: |
|
861 | else: | |
862 | etb = self.tb = sys.last_traceback |
|
862 | etb = self.tb = sys.last_traceback | |
863 | while self.tb.tb_next is not None: |
|
863 | while self.tb.tb_next is not None: | |
864 | self.tb = self.tb.tb_next |
|
864 | self.tb = self.tb.tb_next | |
865 | try: |
|
865 | try: | |
866 | if etb and etb.tb_next: |
|
866 | if etb and etb.tb_next: | |
867 | etb = etb.tb_next |
|
867 | etb = etb.tb_next | |
868 | self.pdb.botframe = etb.tb_frame |
|
868 | self.pdb.botframe = etb.tb_frame | |
869 | self.pdb.interaction(self.tb.tb_frame, self.tb) |
|
869 | self.pdb.interaction(self.tb.tb_frame, self.tb) | |
870 | finally: |
|
870 | finally: | |
871 | sys.displayhook = dhook |
|
871 | sys.displayhook = dhook | |
872 |
|
872 | |||
873 | if hasattr(self,'tb'): |
|
873 | if hasattr(self,'tb'): | |
874 | del self.tb |
|
874 | del self.tb | |
875 |
|
875 | |||
876 | def handler(self, info=None): |
|
876 | def handler(self, info=None): | |
877 | (etype, evalue, etb) = info or sys.exc_info() |
|
877 | (etype, evalue, etb) = info or sys.exc_info() | |
878 | self.tb = etb |
|
878 | self.tb = etb | |
879 | Term.cout.flush() |
|
879 | Term.cout.flush() | |
880 | print >> Term.cerr, self.text(etype, evalue, etb) |
|
880 | print >> Term.cerr, self.text(etype, evalue, etb) | |
881 | Term.cerr.flush() |
|
881 | Term.cerr.flush() | |
882 |
|
882 | |||
883 | # Changed so an instance can just be called as VerboseTB_inst() and print |
|
883 | # Changed so an instance can just be called as VerboseTB_inst() and print | |
884 | # out the right info on its own. |
|
884 | # out the right info on its own. | |
885 | def __call__(self, etype=None, evalue=None, etb=None): |
|
885 | def __call__(self, etype=None, evalue=None, etb=None): | |
886 | """This hook can replace sys.excepthook (for Python 2.1 or higher).""" |
|
886 | """This hook can replace sys.excepthook (for Python 2.1 or higher).""" | |
887 | if etb is None: |
|
887 | if etb is None: | |
888 | self.handler() |
|
888 | self.handler() | |
889 | else: |
|
889 | else: | |
890 | self.handler((etype, evalue, etb)) |
|
890 | self.handler((etype, evalue, etb)) | |
891 | try: |
|
891 | try: | |
892 | self.debugger() |
|
892 | self.debugger() | |
893 | except KeyboardInterrupt: |
|
893 | except KeyboardInterrupt: | |
894 | print "\nKeyboardInterrupt" |
|
894 | print "\nKeyboardInterrupt" | |
895 |
|
895 | |||
896 | #---------------------------------------------------------------------------- |
|
896 | #---------------------------------------------------------------------------- | |
897 | class FormattedTB(VerboseTB,ListTB): |
|
897 | class FormattedTB(VerboseTB,ListTB): | |
898 | """Subclass ListTB but allow calling with a traceback. |
|
898 | """Subclass ListTB but allow calling with a traceback. | |
899 |
|
899 | |||
900 | It can thus be used as a sys.excepthook for Python > 2.1. |
|
900 | It can thus be used as a sys.excepthook for Python > 2.1. | |
901 |
|
901 | |||
902 | Also adds 'Context' and 'Verbose' modes, not available in ListTB. |
|
902 | Also adds 'Context' and 'Verbose' modes, not available in ListTB. | |
903 |
|
903 | |||
904 | Allows a tb_offset to be specified. This is useful for situations where |
|
904 | Allows a tb_offset to be specified. This is useful for situations where | |
905 | one needs to remove a number of topmost frames from the traceback (such as |
|
905 | one needs to remove a number of topmost frames from the traceback (such as | |
906 | occurs with python programs that themselves execute other python code, |
|
906 | occurs with python programs that themselves execute other python code, | |
907 | like Python shells). """ |
|
907 | like Python shells). """ | |
908 |
|
908 | |||
909 | def __init__(self, mode = 'Plain', color_scheme='Linux', |
|
909 | def __init__(self, mode = 'Plain', color_scheme='Linux', | |
910 | tb_offset = 0,long_header=0,call_pdb=0,include_vars=0): |
|
910 | tb_offset = 0,long_header=0,call_pdb=0,include_vars=0): | |
911 |
|
911 | |||
912 | # NEVER change the order of this list. Put new modes at the end: |
|
912 | # NEVER change the order of this list. Put new modes at the end: | |
913 | self.valid_modes = ['Plain','Context','Verbose'] |
|
913 | self.valid_modes = ['Plain','Context','Verbose'] | |
914 | self.verbose_modes = self.valid_modes[1:3] |
|
914 | self.verbose_modes = self.valid_modes[1:3] | |
915 |
|
915 | |||
916 | VerboseTB.__init__(self,color_scheme,tb_offset,long_header, |
|
916 | VerboseTB.__init__(self,color_scheme,tb_offset,long_header, | |
917 | call_pdb=call_pdb,include_vars=include_vars) |
|
917 | call_pdb=call_pdb,include_vars=include_vars) | |
918 | self.set_mode(mode) |
|
918 | self.set_mode(mode) | |
919 |
|
919 | |||
920 | def _extract_tb(self,tb): |
|
920 | def _extract_tb(self,tb): | |
921 | if tb: |
|
921 | if tb: | |
922 | return traceback.extract_tb(tb) |
|
922 | return traceback.extract_tb(tb) | |
923 | else: |
|
923 | else: | |
924 | return None |
|
924 | return None | |
925 |
|
925 | |||
926 | def text(self, etype, value, tb,context=5,mode=None): |
|
926 | def text(self, etype, value, tb,context=5,mode=None): | |
927 | """Return formatted traceback. |
|
927 | """Return formatted traceback. | |
928 |
|
928 | |||
929 | If the optional mode parameter is given, it overrides the current |
|
929 | If the optional mode parameter is given, it overrides the current | |
930 | mode.""" |
|
930 | mode.""" | |
931 |
|
931 | |||
932 | if mode is None: |
|
932 | if mode is None: | |
933 | mode = self.mode |
|
933 | mode = self.mode | |
934 | if mode in self.verbose_modes: |
|
934 | if mode in self.verbose_modes: | |
935 | # verbose modes need a full traceback |
|
935 | # verbose modes need a full traceback | |
936 | return VerboseTB.text(self,etype, value, tb,context=5) |
|
936 | return VerboseTB.text(self,etype, value, tb,context=5) | |
937 | else: |
|
937 | else: | |
938 | # We must check the source cache because otherwise we can print |
|
938 | # We must check the source cache because otherwise we can print | |
939 | # out-of-date source code. |
|
939 | # out-of-date source code. | |
940 | linecache.checkcache() |
|
940 | linecache.checkcache() | |
941 | # Now we can extract and format the exception |
|
941 | # Now we can extract and format the exception | |
942 | elist = self._extract_tb(tb) |
|
942 | elist = self._extract_tb(tb) | |
943 | if len(elist) > self.tb_offset: |
|
943 | if len(elist) > self.tb_offset: | |
944 | del elist[:self.tb_offset] |
|
944 | del elist[:self.tb_offset] | |
945 | return ListTB.text(self,etype,value,elist) |
|
945 | return ListTB.text(self,etype,value,elist) | |
946 |
|
946 | |||
947 | def set_mode(self,mode=None): |
|
947 | def set_mode(self,mode=None): | |
948 | """Switch to the desired mode. |
|
948 | """Switch to the desired mode. | |
949 |
|
949 | |||
950 | If mode is not specified, cycles through the available modes.""" |
|
950 | If mode is not specified, cycles through the available modes.""" | |
951 |
|
951 | |||
952 | if not mode: |
|
952 | if not mode: | |
953 | new_idx = ( self.valid_modes.index(self.mode) + 1 ) % \ |
|
953 | new_idx = ( self.valid_modes.index(self.mode) + 1 ) % \ | |
954 | len(self.valid_modes) |
|
954 | len(self.valid_modes) | |
955 | self.mode = self.valid_modes[new_idx] |
|
955 | self.mode = self.valid_modes[new_idx] | |
956 | elif mode not in self.valid_modes: |
|
956 | elif mode not in self.valid_modes: | |
957 | raise ValueError, 'Unrecognized mode in FormattedTB: <'+mode+'>\n'\ |
|
957 | raise ValueError, 'Unrecognized mode in FormattedTB: <'+mode+'>\n'\ | |
958 | 'Valid modes: '+str(self.valid_modes) |
|
958 | 'Valid modes: '+str(self.valid_modes) | |
959 | else: |
|
959 | else: | |
960 | self.mode = mode |
|
960 | self.mode = mode | |
961 | # include variable details only in 'Verbose' mode |
|
961 | # include variable details only in 'Verbose' mode | |
962 | self.include_vars = (self.mode == self.valid_modes[2]) |
|
962 | self.include_vars = (self.mode == self.valid_modes[2]) | |
963 |
|
963 | |||
964 | # some convenient shorcuts |
|
964 | # some convenient shorcuts | |
965 | def plain(self): |
|
965 | def plain(self): | |
966 | self.set_mode(self.valid_modes[0]) |
|
966 | self.set_mode(self.valid_modes[0]) | |
967 |
|
967 | |||
968 | def context(self): |
|
968 | def context(self): | |
969 | self.set_mode(self.valid_modes[1]) |
|
969 | self.set_mode(self.valid_modes[1]) | |
970 |
|
970 | |||
971 | def verbose(self): |
|
971 | def verbose(self): | |
972 | self.set_mode(self.valid_modes[2]) |
|
972 | self.set_mode(self.valid_modes[2]) | |
973 |
|
973 | |||
974 | #---------------------------------------------------------------------------- |
|
974 | #---------------------------------------------------------------------------- | |
975 | class AutoFormattedTB(FormattedTB): |
|
975 | class AutoFormattedTB(FormattedTB): | |
976 | """A traceback printer which can be called on the fly. |
|
976 | """A traceback printer which can be called on the fly. | |
977 |
|
977 | |||
978 | It will find out about exceptions by itself. |
|
978 | It will find out about exceptions by itself. | |
979 |
|
979 | |||
980 | A brief example: |
|
980 | A brief example: | |
981 |
|
981 | |||
982 | AutoTB = AutoFormattedTB(mode = 'Verbose',color_scheme='Linux') |
|
982 | AutoTB = AutoFormattedTB(mode = 'Verbose',color_scheme='Linux') | |
983 | try: |
|
983 | try: | |
984 | ... |
|
984 | ... | |
985 | except: |
|
985 | except: | |
986 | AutoTB() # or AutoTB(out=logfile) where logfile is an open file object |
|
986 | AutoTB() # or AutoTB(out=logfile) where logfile is an open file object | |
987 | """ |
|
987 | """ | |
988 | def __call__(self,etype=None,evalue=None,etb=None, |
|
988 | def __call__(self,etype=None,evalue=None,etb=None, | |
989 | out=None,tb_offset=None): |
|
989 | out=None,tb_offset=None): | |
990 | """Print out a formatted exception traceback. |
|
990 | """Print out a formatted exception traceback. | |
991 |
|
991 | |||
992 | Optional arguments: |
|
992 | Optional arguments: | |
993 | - out: an open file-like object to direct output to. |
|
993 | - out: an open file-like object to direct output to. | |
994 |
|
994 | |||
995 | - tb_offset: the number of frames to skip over in the stack, on a |
|
995 | - tb_offset: the number of frames to skip over in the stack, on a | |
996 | per-call basis (this overrides temporarily the instance's tb_offset |
|
996 | per-call basis (this overrides temporarily the instance's tb_offset | |
997 | given at initialization time. """ |
|
997 | given at initialization time. """ | |
998 |
|
998 | |||
999 | if out is None: |
|
999 | if out is None: | |
1000 | out = Term.cerr |
|
1000 | out = Term.cerr | |
1001 | Term.cout.flush() |
|
1001 | Term.cout.flush() | |
1002 | if tb_offset is not None: |
|
1002 | if tb_offset is not None: | |
1003 | tb_offset, self.tb_offset = self.tb_offset, tb_offset |
|
1003 | tb_offset, self.tb_offset = self.tb_offset, tb_offset | |
1004 | print >> out, self.text(etype, evalue, etb) |
|
1004 | print >> out, self.text(etype, evalue, etb) | |
1005 | self.tb_offset = tb_offset |
|
1005 | self.tb_offset = tb_offset | |
1006 | else: |
|
1006 | else: | |
1007 | print >> out, self.text(etype, evalue, etb) |
|
1007 | print >> out, self.text(etype, evalue, etb) | |
1008 | out.flush() |
|
1008 | out.flush() | |
1009 | try: |
|
1009 | try: | |
1010 | self.debugger() |
|
1010 | self.debugger() | |
1011 | except KeyboardInterrupt: |
|
1011 | except KeyboardInterrupt: | |
1012 | print "\nKeyboardInterrupt" |
|
1012 | print "\nKeyboardInterrupt" | |
1013 |
|
1013 | |||
1014 | def text(self,etype=None,value=None,tb=None,context=5,mode=None): |
|
1014 | def text(self,etype=None,value=None,tb=None,context=5,mode=None): | |
1015 | if etype is None: |
|
1015 | if etype is None: | |
1016 | etype,value,tb = sys.exc_info() |
|
1016 | etype,value,tb = sys.exc_info() | |
1017 | self.tb = tb |
|
1017 | self.tb = tb | |
1018 | return FormattedTB.text(self,etype,value,tb,context=5,mode=mode) |
|
1018 | return FormattedTB.text(self,etype,value,tb,context=5,mode=mode) | |
1019 |
|
1019 | |||
1020 | #--------------------------------------------------------------------------- |
|
1020 | #--------------------------------------------------------------------------- | |
1021 | # A simple class to preserve Nathan's original functionality. |
|
1021 | # A simple class to preserve Nathan's original functionality. | |
1022 | class ColorTB(FormattedTB): |
|
1022 | class ColorTB(FormattedTB): | |
1023 | """Shorthand to initialize a FormattedTB in Linux colors mode.""" |
|
1023 | """Shorthand to initialize a FormattedTB in Linux colors mode.""" | |
1024 | def __init__(self,color_scheme='Linux',call_pdb=0): |
|
1024 | def __init__(self,color_scheme='Linux',call_pdb=0): | |
1025 | FormattedTB.__init__(self,color_scheme=color_scheme, |
|
1025 | FormattedTB.__init__(self,color_scheme=color_scheme, | |
1026 | call_pdb=call_pdb) |
|
1026 | call_pdb=call_pdb) | |
1027 |
|
1027 | |||
1028 | #---------------------------------------------------------------------------- |
|
1028 | #---------------------------------------------------------------------------- | |
1029 | # module testing (minimal) |
|
1029 | # module testing (minimal) | |
1030 | if __name__ == "__main__": |
|
1030 | if __name__ == "__main__": | |
1031 | def spam(c, (d, e)): |
|
1031 | def spam(c, (d, e)): | |
1032 | x = c + d |
|
1032 | x = c + d | |
1033 | y = c * d |
|
1033 | y = c * d | |
1034 | foo(x, y) |
|
1034 | foo(x, y) | |
1035 |
|
1035 | |||
1036 | def foo(a, b, bar=1): |
|
1036 | def foo(a, b, bar=1): | |
1037 | eggs(a, b + bar) |
|
1037 | eggs(a, b + bar) | |
1038 |
|
1038 | |||
1039 | def eggs(f, g, z=globals()): |
|
1039 | def eggs(f, g, z=globals()): | |
1040 | h = f + g |
|
1040 | h = f + g | |
1041 | i = f - g |
|
1041 | i = f - g | |
1042 | return h / i |
|
1042 | return h / i | |
1043 |
|
1043 | |||
1044 | print '' |
|
1044 | print '' | |
1045 | print '*** Before ***' |
|
1045 | print '*** Before ***' | |
1046 | try: |
|
1046 | try: | |
1047 | print spam(1, (2, 3)) |
|
1047 | print spam(1, (2, 3)) | |
1048 | except: |
|
1048 | except: | |
1049 | traceback.print_exc() |
|
1049 | traceback.print_exc() | |
1050 | print '' |
|
1050 | print '' | |
1051 |
|
1051 | |||
1052 | handler = ColorTB() |
|
1052 | handler = ColorTB() | |
1053 | print '*** ColorTB ***' |
|
1053 | print '*** ColorTB ***' | |
1054 | try: |
|
1054 | try: | |
1055 | print spam(1, (2, 3)) |
|
1055 | print spam(1, (2, 3)) | |
1056 | except: |
|
1056 | except: | |
1057 | apply(handler, sys.exc_info() ) |
|
1057 | apply(handler, sys.exc_info() ) | |
1058 | print '' |
|
1058 | print '' | |
1059 |
|
1059 | |||
1060 | handler = VerboseTB() |
|
1060 | handler = VerboseTB() | |
1061 | print '*** VerboseTB ***' |
|
1061 | print '*** VerboseTB ***' | |
1062 | try: |
|
1062 | try: | |
1063 | print spam(1, (2, 3)) |
|
1063 | print spam(1, (2, 3)) | |
1064 | except: |
|
1064 | except: | |
1065 | apply(handler, sys.exc_info() ) |
|
1065 | apply(handler, sys.exc_info() ) | |
1066 | print '' |
|
1066 | print '' | |
1067 |
|
1067 |
@@ -1,1057 +1,1057 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """ |
|
2 | """ | |
3 | ultraTB.py -- Spice up your tracebacks! |
|
3 | ultraTB.py -- Spice up your tracebacks! | |
4 |
|
4 | |||
5 | * ColorTB |
|
5 | * ColorTB | |
6 | I've always found it a bit hard to visually parse tracebacks in Python. The |
|
6 | I've always found it a bit hard to visually parse tracebacks in Python. The | |
7 | ColorTB class is a solution to that problem. It colors the different parts of a |
|
7 | ColorTB class is a solution to that problem. It colors the different parts of a | |
8 | traceback in a manner similar to what you would expect from a syntax-highlighting |
|
8 | traceback in a manner similar to what you would expect from a syntax-highlighting | |
9 | text editor. |
|
9 | text editor. | |
10 |
|
10 | |||
11 | Installation instructions for ColorTB: |
|
11 | Installation instructions for ColorTB: | |
12 | import sys,ultraTB |
|
12 | import sys,ultraTB | |
13 | sys.excepthook = ultraTB.ColorTB() |
|
13 | sys.excepthook = ultraTB.ColorTB() | |
14 |
|
14 | |||
15 | * VerboseTB |
|
15 | * VerboseTB | |
16 | I've also included a port of Ka-Ping Yee's "cgitb.py" that produces all kinds |
|
16 | I've also included a port of Ka-Ping Yee's "cgitb.py" that produces all kinds | |
17 | of useful info when a traceback occurs. Ping originally had it spit out HTML |
|
17 | of useful info when a traceback occurs. Ping originally had it spit out HTML | |
18 | and intended it for CGI programmers, but why should they have all the fun? I |
|
18 | and intended it for CGI programmers, but why should they have all the fun? I | |
19 | altered it to spit out colored text to the terminal. It's a bit overwhelming, |
|
19 | altered it to spit out colored text to the terminal. It's a bit overwhelming, | |
20 | but kind of neat, and maybe useful for long-running programs that you believe |
|
20 | but kind of neat, and maybe useful for long-running programs that you believe | |
21 | are bug-free. If a crash *does* occur in that type of program you want details. |
|
21 | are bug-free. If a crash *does* occur in that type of program you want details. | |
22 | Give it a shot--you'll love it or you'll hate it. |
|
22 | Give it a shot--you'll love it or you'll hate it. | |
23 |
|
23 | |||
24 | Note: |
|
24 | Note: | |
25 |
|
25 | |||
26 | The Verbose mode prints the variables currently visible where the exception |
|
26 | The Verbose mode prints the variables currently visible where the exception | |
27 | happened (shortening their strings if too long). This can potentially be |
|
27 | happened (shortening their strings if too long). This can potentially be | |
28 | very slow, if you happen to have a huge data structure whose string |
|
28 | very slow, if you happen to have a huge data structure whose string | |
29 | representation is complex to compute. Your computer may appear to freeze for |
|
29 | representation is complex to compute. Your computer may appear to freeze for | |
30 | a while with cpu usage at 100%. If this occurs, you can cancel the traceback |
|
30 | a while with cpu usage at 100%. If this occurs, you can cancel the traceback | |
31 | with Ctrl-C (maybe hitting it more than once). |
|
31 | with Ctrl-C (maybe hitting it more than once). | |
32 |
|
32 | |||
33 | If you encounter this kind of situation often, you may want to use the |
|
33 | If you encounter this kind of situation often, you may want to use the | |
34 | Verbose_novars mode instead of the regular Verbose, which avoids formatting |
|
34 | Verbose_novars mode instead of the regular Verbose, which avoids formatting | |
35 | variables (but otherwise includes the information and context given by |
|
35 | variables (but otherwise includes the information and context given by | |
36 | Verbose). |
|
36 | Verbose). | |
37 |
|
37 | |||
38 |
|
38 | |||
39 | Installation instructions for ColorTB: |
|
39 | Installation instructions for ColorTB: | |
40 | import sys,ultraTB |
|
40 | import sys,ultraTB | |
41 | sys.excepthook = ultraTB.VerboseTB() |
|
41 | sys.excepthook = ultraTB.VerboseTB() | |
42 |
|
42 | |||
43 | Note: Much of the code in this module was lifted verbatim from the standard |
|
43 | Note: Much of the code in this module was lifted verbatim from the standard | |
44 | library module 'traceback.py' and Ka-Ping Yee's 'cgitb.py'. |
|
44 | library module 'traceback.py' and Ka-Ping Yee's 'cgitb.py'. | |
45 |
|
45 | |||
46 | * Color schemes |
|
46 | * Color schemes | |
47 | The colors are defined in the class TBTools through the use of the |
|
47 | The colors are defined in the class TBTools through the use of the | |
48 | ColorSchemeTable class. Currently the following exist: |
|
48 | ColorSchemeTable class. Currently the following exist: | |
49 |
|
49 | |||
50 | - NoColor: allows all of this module to be used in any terminal (the color |
|
50 | - NoColor: allows all of this module to be used in any terminal (the color | |
51 | escapes are just dummy blank strings). |
|
51 | escapes are just dummy blank strings). | |
52 |
|
52 | |||
53 | - Linux: is meant to look good in a terminal like the Linux console (black |
|
53 | - Linux: is meant to look good in a terminal like the Linux console (black | |
54 | or very dark background). |
|
54 | or very dark background). | |
55 |
|
55 | |||
56 | - LightBG: similar to Linux but swaps dark/light colors to be more readable |
|
56 | - LightBG: similar to Linux but swaps dark/light colors to be more readable | |
57 | in light background terminals. |
|
57 | in light background terminals. | |
58 |
|
58 | |||
59 | You can implement other color schemes easily, the syntax is fairly |
|
59 | You can implement other color schemes easily, the syntax is fairly | |
60 | self-explanatory. Please send back new schemes you develop to the author for |
|
60 | self-explanatory. Please send back new schemes you develop to the author for | |
61 | possible inclusion in future releases. |
|
61 | possible inclusion in future releases. | |
62 | """ |
|
62 | """ | |
63 |
|
63 | |||
64 | #***************************************************************************** |
|
64 | #***************************************************************************** | |
65 | # Copyright (C) 2001 Nathaniel Gray <n8gray@caltech.edu> |
|
65 | # Copyright (C) 2001 Nathaniel Gray <n8gray@caltech.edu> | |
66 | # Copyright (C) 2001-2004 Fernando Perez <fperez@colorado.edu> |
|
66 | # Copyright (C) 2001-2004 Fernando Perez <fperez@colorado.edu> | |
67 | # |
|
67 | # | |
68 | # Distributed under the terms of the BSD License. The full license is in |
|
68 | # Distributed under the terms of the BSD License. The full license is in | |
69 | # the file COPYING, distributed as part of this software. |
|
69 | # the file COPYING, distributed as part of this software. | |
70 | #***************************************************************************** |
|
70 | #***************************************************************************** | |
71 |
|
71 | |||
72 | # Required modules |
|
72 | # Required modules | |
73 | import inspect |
|
73 | import inspect | |
74 | import keyword |
|
74 | import keyword | |
75 | import linecache |
|
75 | import linecache | |
76 | import os |
|
76 | import os | |
77 | import pydoc |
|
77 | import pydoc | |
78 | import re |
|
78 | import re | |
79 | import string |
|
79 | import string | |
80 | import sys |
|
80 | import sys | |
81 | import time |
|
81 | import time | |
82 | import tokenize |
|
82 | import tokenize | |
83 | import traceback |
|
83 | import traceback | |
84 | import types |
|
84 | import types | |
85 |
|
85 | |||
86 | # For purposes of monkeypatching inspect to fix a bug in it. |
|
86 | # For purposes of monkeypatching inspect to fix a bug in it. | |
87 | from inspect import getsourcefile, getfile, getmodule,\ |
|
87 | from inspect import getsourcefile, getfile, getmodule,\ | |
88 | ismodule, isclass, ismethod, isfunction, istraceback, isframe, iscode |
|
88 | ismodule, isclass, ismethod, isfunction, istraceback, isframe, iscode | |
89 |
|
89 | |||
90 |
|
90 | |||
91 | # IPython's own modules |
|
91 | # IPython's own modules | |
92 | # Modified pdb which doesn't damage IPython's readline handling |
|
92 | # Modified pdb which doesn't damage IPython's readline handling | |
93 | from IPython import PyColorize |
|
93 | from IPython import PyColorize | |
94 | from IPython.core import debugger |
|
94 | from IPython.core import debugger | |
95 | from IPython.ipstruct import Struct |
|
95 | from IPython.utils.ipstruct import Struct | |
96 | from IPython.core.excolors import exception_colors |
|
96 | from IPython.core.excolors import exception_colors | |
97 | from IPython.utils.genutils import Term,uniq_stable,error,info |
|
97 | from IPython.utils.genutils import Term,uniq_stable,error,info | |
98 |
|
98 | |||
99 | # Globals |
|
99 | # Globals | |
100 | # amount of space to put line numbers before verbose tracebacks |
|
100 | # amount of space to put line numbers before verbose tracebacks | |
101 | INDENT_SIZE = 8 |
|
101 | INDENT_SIZE = 8 | |
102 |
|
102 | |||
103 | # Default color scheme. This is used, for example, by the traceback |
|
103 | # Default color scheme. This is used, for example, by the traceback | |
104 | # formatter. When running in an actual IPython instance, the user's rc.colors |
|
104 | # formatter. When running in an actual IPython instance, the user's rc.colors | |
105 | # value is used, but havinga module global makes this functionality available |
|
105 | # value is used, but havinga module global makes this functionality available | |
106 | # to users of ultraTB who are NOT running inside ipython. |
|
106 | # to users of ultraTB who are NOT running inside ipython. | |
107 | DEFAULT_SCHEME = 'NoColor' |
|
107 | DEFAULT_SCHEME = 'NoColor' | |
108 |
|
108 | |||
109 | #--------------------------------------------------------------------------- |
|
109 | #--------------------------------------------------------------------------- | |
110 | # Code begins |
|
110 | # Code begins | |
111 |
|
111 | |||
112 | # Utility functions |
|
112 | # Utility functions | |
113 | def inspect_error(): |
|
113 | def inspect_error(): | |
114 | """Print a message about internal inspect errors. |
|
114 | """Print a message about internal inspect errors. | |
115 |
|
115 | |||
116 | These are unfortunately quite common.""" |
|
116 | These are unfortunately quite common.""" | |
117 |
|
117 | |||
118 | error('Internal Python error in the inspect module.\n' |
|
118 | error('Internal Python error in the inspect module.\n' | |
119 | 'Below is the traceback from this internal error.\n') |
|
119 | 'Below is the traceback from this internal error.\n') | |
120 |
|
120 | |||
121 |
|
121 | |||
122 | def findsource(object): |
|
122 | def findsource(object): | |
123 | """Return the entire source file and starting line number for an object. |
|
123 | """Return the entire source file and starting line number for an object. | |
124 |
|
124 | |||
125 | The argument may be a module, class, method, function, traceback, frame, |
|
125 | The argument may be a module, class, method, function, traceback, frame, | |
126 | or code object. The source code is returned as a list of all the lines |
|
126 | or code object. The source code is returned as a list of all the lines | |
127 | in the file and the line number indexes a line in that list. An IOError |
|
127 | in the file and the line number indexes a line in that list. An IOError | |
128 | is raised if the source code cannot be retrieved. |
|
128 | is raised if the source code cannot be retrieved. | |
129 |
|
129 | |||
130 | FIXED version with which we monkeypatch the stdlib to work around a bug.""" |
|
130 | FIXED version with which we monkeypatch the stdlib to work around a bug.""" | |
131 |
|
131 | |||
132 | file = getsourcefile(object) or getfile(object) |
|
132 | file = getsourcefile(object) or getfile(object) | |
133 | # If the object is a frame, then trying to get the globals dict from its |
|
133 | # If the object is a frame, then trying to get the globals dict from its | |
134 | # module won't work. Instead, the frame object itself has the globals |
|
134 | # module won't work. Instead, the frame object itself has the globals | |
135 | # dictionary. |
|
135 | # dictionary. | |
136 | globals_dict = None |
|
136 | globals_dict = None | |
137 | if inspect.isframe(object): |
|
137 | if inspect.isframe(object): | |
138 | # XXX: can this ever be false? |
|
138 | # XXX: can this ever be false? | |
139 | globals_dict = object.f_globals |
|
139 | globals_dict = object.f_globals | |
140 | else: |
|
140 | else: | |
141 | module = getmodule(object, file) |
|
141 | module = getmodule(object, file) | |
142 | if module: |
|
142 | if module: | |
143 | globals_dict = module.__dict__ |
|
143 | globals_dict = module.__dict__ | |
144 | lines = linecache.getlines(file, globals_dict) |
|
144 | lines = linecache.getlines(file, globals_dict) | |
145 | if not lines: |
|
145 | if not lines: | |
146 | raise IOError('could not get source code') |
|
146 | raise IOError('could not get source code') | |
147 |
|
147 | |||
148 | if ismodule(object): |
|
148 | if ismodule(object): | |
149 | return lines, 0 |
|
149 | return lines, 0 | |
150 |
|
150 | |||
151 | if isclass(object): |
|
151 | if isclass(object): | |
152 | name = object.__name__ |
|
152 | name = object.__name__ | |
153 | pat = re.compile(r'^(\s*)class\s*' + name + r'\b') |
|
153 | pat = re.compile(r'^(\s*)class\s*' + name + r'\b') | |
154 | # make some effort to find the best matching class definition: |
|
154 | # make some effort to find the best matching class definition: | |
155 | # use the one with the least indentation, which is the one |
|
155 | # use the one with the least indentation, which is the one | |
156 | # that's most probably not inside a function definition. |
|
156 | # that's most probably not inside a function definition. | |
157 | candidates = [] |
|
157 | candidates = [] | |
158 | for i in range(len(lines)): |
|
158 | for i in range(len(lines)): | |
159 | match = pat.match(lines[i]) |
|
159 | match = pat.match(lines[i]) | |
160 | if match: |
|
160 | if match: | |
161 | # if it's at toplevel, it's already the best one |
|
161 | # if it's at toplevel, it's already the best one | |
162 | if lines[i][0] == 'c': |
|
162 | if lines[i][0] == 'c': | |
163 | return lines, i |
|
163 | return lines, i | |
164 | # else add whitespace to candidate list |
|
164 | # else add whitespace to candidate list | |
165 | candidates.append((match.group(1), i)) |
|
165 | candidates.append((match.group(1), i)) | |
166 | if candidates: |
|
166 | if candidates: | |
167 | # this will sort by whitespace, and by line number, |
|
167 | # this will sort by whitespace, and by line number, | |
168 | # less whitespace first |
|
168 | # less whitespace first | |
169 | candidates.sort() |
|
169 | candidates.sort() | |
170 | return lines, candidates[0][1] |
|
170 | return lines, candidates[0][1] | |
171 | else: |
|
171 | else: | |
172 | raise IOError('could not find class definition') |
|
172 | raise IOError('could not find class definition') | |
173 |
|
173 | |||
174 | if ismethod(object): |
|
174 | if ismethod(object): | |
175 | object = object.im_func |
|
175 | object = object.im_func | |
176 | if isfunction(object): |
|
176 | if isfunction(object): | |
177 | object = object.func_code |
|
177 | object = object.func_code | |
178 | if istraceback(object): |
|
178 | if istraceback(object): | |
179 | object = object.tb_frame |
|
179 | object = object.tb_frame | |
180 | if isframe(object): |
|
180 | if isframe(object): | |
181 | object = object.f_code |
|
181 | object = object.f_code | |
182 | if iscode(object): |
|
182 | if iscode(object): | |
183 | if not hasattr(object, 'co_firstlineno'): |
|
183 | if not hasattr(object, 'co_firstlineno'): | |
184 | raise IOError('could not find function definition') |
|
184 | raise IOError('could not find function definition') | |
185 | pat = re.compile(r'^(\s*def\s)|(.*(?<!\w)lambda(:|\s))|^(\s*@)') |
|
185 | pat = re.compile(r'^(\s*def\s)|(.*(?<!\w)lambda(:|\s))|^(\s*@)') | |
186 | pmatch = pat.match |
|
186 | pmatch = pat.match | |
187 | # fperez - fix: sometimes, co_firstlineno can give a number larger than |
|
187 | # fperez - fix: sometimes, co_firstlineno can give a number larger than | |
188 | # the length of lines, which causes an error. Safeguard against that. |
|
188 | # the length of lines, which causes an error. Safeguard against that. | |
189 | lnum = min(object.co_firstlineno,len(lines))-1 |
|
189 | lnum = min(object.co_firstlineno,len(lines))-1 | |
190 | while lnum > 0: |
|
190 | while lnum > 0: | |
191 | if pmatch(lines[lnum]): break |
|
191 | if pmatch(lines[lnum]): break | |
192 | lnum -= 1 |
|
192 | lnum -= 1 | |
193 |
|
193 | |||
194 | return lines, lnum |
|
194 | return lines, lnum | |
195 | raise IOError('could not find code object') |
|
195 | raise IOError('could not find code object') | |
196 |
|
196 | |||
197 | # Monkeypatch inspect to apply our bugfix. This code only works with py25 |
|
197 | # Monkeypatch inspect to apply our bugfix. This code only works with py25 | |
198 | if sys.version_info[:2] >= (2,5): |
|
198 | if sys.version_info[:2] >= (2,5): | |
199 | inspect.findsource = findsource |
|
199 | inspect.findsource = findsource | |
200 |
|
200 | |||
201 | def fix_frame_records_filenames(records): |
|
201 | def fix_frame_records_filenames(records): | |
202 | """Try to fix the filenames in each record from inspect.getinnerframes(). |
|
202 | """Try to fix the filenames in each record from inspect.getinnerframes(). | |
203 |
|
203 | |||
204 | Particularly, modules loaded from within zip files have useless filenames |
|
204 | Particularly, modules loaded from within zip files have useless filenames | |
205 | attached to their code object, and inspect.getinnerframes() just uses it. |
|
205 | attached to their code object, and inspect.getinnerframes() just uses it. | |
206 | """ |
|
206 | """ | |
207 | fixed_records = [] |
|
207 | fixed_records = [] | |
208 | for frame, filename, line_no, func_name, lines, index in records: |
|
208 | for frame, filename, line_no, func_name, lines, index in records: | |
209 | # Look inside the frame's globals dictionary for __file__, which should |
|
209 | # Look inside the frame's globals dictionary for __file__, which should | |
210 | # be better. |
|
210 | # be better. | |
211 | better_fn = frame.f_globals.get('__file__', None) |
|
211 | better_fn = frame.f_globals.get('__file__', None) | |
212 | if isinstance(better_fn, str): |
|
212 | if isinstance(better_fn, str): | |
213 | # Check the type just in case someone did something weird with |
|
213 | # Check the type just in case someone did something weird with | |
214 | # __file__. It might also be None if the error occurred during |
|
214 | # __file__. It might also be None if the error occurred during | |
215 | # import. |
|
215 | # import. | |
216 | filename = better_fn |
|
216 | filename = better_fn | |
217 | fixed_records.append((frame, filename, line_no, func_name, lines, index)) |
|
217 | fixed_records.append((frame, filename, line_no, func_name, lines, index)) | |
218 | return fixed_records |
|
218 | return fixed_records | |
219 |
|
219 | |||
220 |
|
220 | |||
221 | def _fixed_getinnerframes(etb, context=1,tb_offset=0): |
|
221 | def _fixed_getinnerframes(etb, context=1,tb_offset=0): | |
222 | import linecache |
|
222 | import linecache | |
223 | LNUM_POS, LINES_POS, INDEX_POS = 2, 4, 5 |
|
223 | LNUM_POS, LINES_POS, INDEX_POS = 2, 4, 5 | |
224 |
|
224 | |||
225 | records = fix_frame_records_filenames(inspect.getinnerframes(etb, context)) |
|
225 | records = fix_frame_records_filenames(inspect.getinnerframes(etb, context)) | |
226 |
|
226 | |||
227 | # If the error is at the console, don't build any context, since it would |
|
227 | # If the error is at the console, don't build any context, since it would | |
228 | # otherwise produce 5 blank lines printed out (there is no file at the |
|
228 | # otherwise produce 5 blank lines printed out (there is no file at the | |
229 | # console) |
|
229 | # console) | |
230 | rec_check = records[tb_offset:] |
|
230 | rec_check = records[tb_offset:] | |
231 | try: |
|
231 | try: | |
232 | rname = rec_check[0][1] |
|
232 | rname = rec_check[0][1] | |
233 | if rname == '<ipython console>' or rname.endswith('<string>'): |
|
233 | if rname == '<ipython console>' or rname.endswith('<string>'): | |
234 | return rec_check |
|
234 | return rec_check | |
235 | except IndexError: |
|
235 | except IndexError: | |
236 | pass |
|
236 | pass | |
237 |
|
237 | |||
238 | aux = traceback.extract_tb(etb) |
|
238 | aux = traceback.extract_tb(etb) | |
239 | assert len(records) == len(aux) |
|
239 | assert len(records) == len(aux) | |
240 | for i, (file, lnum, _, _) in zip(range(len(records)), aux): |
|
240 | for i, (file, lnum, _, _) in zip(range(len(records)), aux): | |
241 | maybeStart = lnum-1 - context//2 |
|
241 | maybeStart = lnum-1 - context//2 | |
242 | start = max(maybeStart, 0) |
|
242 | start = max(maybeStart, 0) | |
243 | end = start + context |
|
243 | end = start + context | |
244 | lines = linecache.getlines(file)[start:end] |
|
244 | lines = linecache.getlines(file)[start:end] | |
245 | # pad with empty lines if necessary |
|
245 | # pad with empty lines if necessary | |
246 | if maybeStart < 0: |
|
246 | if maybeStart < 0: | |
247 | lines = (['\n'] * -maybeStart) + lines |
|
247 | lines = (['\n'] * -maybeStart) + lines | |
248 | if len(lines) < context: |
|
248 | if len(lines) < context: | |
249 | lines += ['\n'] * (context - len(lines)) |
|
249 | lines += ['\n'] * (context - len(lines)) | |
250 | buf = list(records[i]) |
|
250 | buf = list(records[i]) | |
251 | buf[LNUM_POS] = lnum |
|
251 | buf[LNUM_POS] = lnum | |
252 | buf[INDEX_POS] = lnum - 1 - start |
|
252 | buf[INDEX_POS] = lnum - 1 - start | |
253 | buf[LINES_POS] = lines |
|
253 | buf[LINES_POS] = lines | |
254 | records[i] = tuple(buf) |
|
254 | records[i] = tuple(buf) | |
255 | return records[tb_offset:] |
|
255 | return records[tb_offset:] | |
256 |
|
256 | |||
257 | # Helper function -- largely belongs to VerboseTB, but we need the same |
|
257 | # Helper function -- largely belongs to VerboseTB, but we need the same | |
258 | # functionality to produce a pseudo verbose TB for SyntaxErrors, so that they |
|
258 | # functionality to produce a pseudo verbose TB for SyntaxErrors, so that they | |
259 | # can be recognized properly by ipython.el's py-traceback-line-re |
|
259 | # can be recognized properly by ipython.el's py-traceback-line-re | |
260 | # (SyntaxErrors have to be treated specially because they have no traceback) |
|
260 | # (SyntaxErrors have to be treated specially because they have no traceback) | |
261 |
|
261 | |||
262 | _parser = PyColorize.Parser() |
|
262 | _parser = PyColorize.Parser() | |
263 |
|
263 | |||
264 | def _formatTracebackLines(lnum, index, lines, Colors, lvals=None,scheme=None): |
|
264 | def _formatTracebackLines(lnum, index, lines, Colors, lvals=None,scheme=None): | |
265 | numbers_width = INDENT_SIZE - 1 |
|
265 | numbers_width = INDENT_SIZE - 1 | |
266 | res = [] |
|
266 | res = [] | |
267 | i = lnum - index |
|
267 | i = lnum - index | |
268 |
|
268 | |||
269 | # This lets us get fully syntax-highlighted tracebacks. |
|
269 | # This lets us get fully syntax-highlighted tracebacks. | |
270 | if scheme is None: |
|
270 | if scheme is None: | |
271 | try: |
|
271 | try: | |
272 | scheme = __IPYTHON__.rc.colors |
|
272 | scheme = __IPYTHON__.rc.colors | |
273 | except: |
|
273 | except: | |
274 | scheme = DEFAULT_SCHEME |
|
274 | scheme = DEFAULT_SCHEME | |
275 | _line_format = _parser.format2 |
|
275 | _line_format = _parser.format2 | |
276 |
|
276 | |||
277 | for line in lines: |
|
277 | for line in lines: | |
278 | new_line, err = _line_format(line,'str',scheme) |
|
278 | new_line, err = _line_format(line,'str',scheme) | |
279 | if not err: line = new_line |
|
279 | if not err: line = new_line | |
280 |
|
280 | |||
281 | if i == lnum: |
|
281 | if i == lnum: | |
282 | # This is the line with the error |
|
282 | # This is the line with the error | |
283 | pad = numbers_width - len(str(i)) |
|
283 | pad = numbers_width - len(str(i)) | |
284 | if pad >= 3: |
|
284 | if pad >= 3: | |
285 | marker = '-'*(pad-3) + '-> ' |
|
285 | marker = '-'*(pad-3) + '-> ' | |
286 | elif pad == 2: |
|
286 | elif pad == 2: | |
287 | marker = '> ' |
|
287 | marker = '> ' | |
288 | elif pad == 1: |
|
288 | elif pad == 1: | |
289 | marker = '>' |
|
289 | marker = '>' | |
290 | else: |
|
290 | else: | |
291 | marker = '' |
|
291 | marker = '' | |
292 | num = marker + str(i) |
|
292 | num = marker + str(i) | |
293 | line = '%s%s%s %s%s' %(Colors.linenoEm, num, |
|
293 | line = '%s%s%s %s%s' %(Colors.linenoEm, num, | |
294 | Colors.line, line, Colors.Normal) |
|
294 | Colors.line, line, Colors.Normal) | |
295 | else: |
|
295 | else: | |
296 | num = '%*s' % (numbers_width,i) |
|
296 | num = '%*s' % (numbers_width,i) | |
297 | line = '%s%s%s %s' %(Colors.lineno, num, |
|
297 | line = '%s%s%s %s' %(Colors.lineno, num, | |
298 | Colors.Normal, line) |
|
298 | Colors.Normal, line) | |
299 |
|
299 | |||
300 | res.append(line) |
|
300 | res.append(line) | |
301 | if lvals and i == lnum: |
|
301 | if lvals and i == lnum: | |
302 | res.append(lvals + '\n') |
|
302 | res.append(lvals + '\n') | |
303 | i = i + 1 |
|
303 | i = i + 1 | |
304 | return res |
|
304 | return res | |
305 |
|
305 | |||
306 |
|
306 | |||
307 | #--------------------------------------------------------------------------- |
|
307 | #--------------------------------------------------------------------------- | |
308 | # Module classes |
|
308 | # Module classes | |
309 | class TBTools: |
|
309 | class TBTools: | |
310 | """Basic tools used by all traceback printer classes.""" |
|
310 | """Basic tools used by all traceback printer classes.""" | |
311 |
|
311 | |||
312 | def __init__(self,color_scheme = 'NoColor',call_pdb=False): |
|
312 | def __init__(self,color_scheme = 'NoColor',call_pdb=False): | |
313 | # Whether to call the interactive pdb debugger after printing |
|
313 | # Whether to call the interactive pdb debugger after printing | |
314 | # tracebacks or not |
|
314 | # tracebacks or not | |
315 | self.call_pdb = call_pdb |
|
315 | self.call_pdb = call_pdb | |
316 |
|
316 | |||
317 | # Create color table |
|
317 | # Create color table | |
318 | self.color_scheme_table = exception_colors() |
|
318 | self.color_scheme_table = exception_colors() | |
319 |
|
319 | |||
320 | self.set_colors(color_scheme) |
|
320 | self.set_colors(color_scheme) | |
321 | self.old_scheme = color_scheme # save initial value for toggles |
|
321 | self.old_scheme = color_scheme # save initial value for toggles | |
322 |
|
322 | |||
323 | if call_pdb: |
|
323 | if call_pdb: | |
324 | self.pdb = debugger.Pdb(self.color_scheme_table.active_scheme_name) |
|
324 | self.pdb = debugger.Pdb(self.color_scheme_table.active_scheme_name) | |
325 | else: |
|
325 | else: | |
326 | self.pdb = None |
|
326 | self.pdb = None | |
327 |
|
327 | |||
328 | def set_colors(self,*args,**kw): |
|
328 | def set_colors(self,*args,**kw): | |
329 | """Shorthand access to the color table scheme selector method.""" |
|
329 | """Shorthand access to the color table scheme selector method.""" | |
330 |
|
330 | |||
331 | # Set own color table |
|
331 | # Set own color table | |
332 | self.color_scheme_table.set_active_scheme(*args,**kw) |
|
332 | self.color_scheme_table.set_active_scheme(*args,**kw) | |
333 | # for convenience, set Colors to the active scheme |
|
333 | # for convenience, set Colors to the active scheme | |
334 | self.Colors = self.color_scheme_table.active_colors |
|
334 | self.Colors = self.color_scheme_table.active_colors | |
335 | # Also set colors of debugger |
|
335 | # Also set colors of debugger | |
336 | if hasattr(self,'pdb') and self.pdb is not None: |
|
336 | if hasattr(self,'pdb') and self.pdb is not None: | |
337 | self.pdb.set_colors(*args,**kw) |
|
337 | self.pdb.set_colors(*args,**kw) | |
338 |
|
338 | |||
339 | def color_toggle(self): |
|
339 | def color_toggle(self): | |
340 | """Toggle between the currently active color scheme and NoColor.""" |
|
340 | """Toggle between the currently active color scheme and NoColor.""" | |
341 |
|
341 | |||
342 | if self.color_scheme_table.active_scheme_name == 'NoColor': |
|
342 | if self.color_scheme_table.active_scheme_name == 'NoColor': | |
343 | self.color_scheme_table.set_active_scheme(self.old_scheme) |
|
343 | self.color_scheme_table.set_active_scheme(self.old_scheme) | |
344 | self.Colors = self.color_scheme_table.active_colors |
|
344 | self.Colors = self.color_scheme_table.active_colors | |
345 | else: |
|
345 | else: | |
346 | self.old_scheme = self.color_scheme_table.active_scheme_name |
|
346 | self.old_scheme = self.color_scheme_table.active_scheme_name | |
347 | self.color_scheme_table.set_active_scheme('NoColor') |
|
347 | self.color_scheme_table.set_active_scheme('NoColor') | |
348 | self.Colors = self.color_scheme_table.active_colors |
|
348 | self.Colors = self.color_scheme_table.active_colors | |
349 |
|
349 | |||
350 | #--------------------------------------------------------------------------- |
|
350 | #--------------------------------------------------------------------------- | |
351 | class ListTB(TBTools): |
|
351 | class ListTB(TBTools): | |
352 | """Print traceback information from a traceback list, with optional color. |
|
352 | """Print traceback information from a traceback list, with optional color. | |
353 |
|
353 | |||
354 | Calling: requires 3 arguments: |
|
354 | Calling: requires 3 arguments: | |
355 | (etype, evalue, elist) |
|
355 | (etype, evalue, elist) | |
356 | as would be obtained by: |
|
356 | as would be obtained by: | |
357 | etype, evalue, tb = sys.exc_info() |
|
357 | etype, evalue, tb = sys.exc_info() | |
358 | if tb: |
|
358 | if tb: | |
359 | elist = traceback.extract_tb(tb) |
|
359 | elist = traceback.extract_tb(tb) | |
360 | else: |
|
360 | else: | |
361 | elist = None |
|
361 | elist = None | |
362 |
|
362 | |||
363 | It can thus be used by programs which need to process the traceback before |
|
363 | It can thus be used by programs which need to process the traceback before | |
364 | printing (such as console replacements based on the code module from the |
|
364 | printing (such as console replacements based on the code module from the | |
365 | standard library). |
|
365 | standard library). | |
366 |
|
366 | |||
367 | Because they are meant to be called without a full traceback (only a |
|
367 | Because they are meant to be called without a full traceback (only a | |
368 | list), instances of this class can't call the interactive pdb debugger.""" |
|
368 | list), instances of this class can't call the interactive pdb debugger.""" | |
369 |
|
369 | |||
370 | def __init__(self,color_scheme = 'NoColor'): |
|
370 | def __init__(self,color_scheme = 'NoColor'): | |
371 | TBTools.__init__(self,color_scheme = color_scheme,call_pdb=0) |
|
371 | TBTools.__init__(self,color_scheme = color_scheme,call_pdb=0) | |
372 |
|
372 | |||
373 | def __call__(self, etype, value, elist): |
|
373 | def __call__(self, etype, value, elist): | |
374 | Term.cout.flush() |
|
374 | Term.cout.flush() | |
375 | print >> Term.cerr, self.text(etype,value,elist) |
|
375 | print >> Term.cerr, self.text(etype,value,elist) | |
376 | Term.cerr.flush() |
|
376 | Term.cerr.flush() | |
377 |
|
377 | |||
378 | def text(self,etype, value, elist,context=5): |
|
378 | def text(self,etype, value, elist,context=5): | |
379 | """Return a color formatted string with the traceback info.""" |
|
379 | """Return a color formatted string with the traceback info.""" | |
380 |
|
380 | |||
381 | Colors = self.Colors |
|
381 | Colors = self.Colors | |
382 | out_string = ['%s%s%s\n' % (Colors.topline,'-'*60,Colors.Normal)] |
|
382 | out_string = ['%s%s%s\n' % (Colors.topline,'-'*60,Colors.Normal)] | |
383 | if elist: |
|
383 | if elist: | |
384 | out_string.append('Traceback %s(most recent call last)%s:' % \ |
|
384 | out_string.append('Traceback %s(most recent call last)%s:' % \ | |
385 | (Colors.normalEm, Colors.Normal) + '\n') |
|
385 | (Colors.normalEm, Colors.Normal) + '\n') | |
386 | out_string.extend(self._format_list(elist)) |
|
386 | out_string.extend(self._format_list(elist)) | |
387 | lines = self._format_exception_only(etype, value) |
|
387 | lines = self._format_exception_only(etype, value) | |
388 | for line in lines[:-1]: |
|
388 | for line in lines[:-1]: | |
389 | out_string.append(" "+line) |
|
389 | out_string.append(" "+line) | |
390 | out_string.append(lines[-1]) |
|
390 | out_string.append(lines[-1]) | |
391 | return ''.join(out_string) |
|
391 | return ''.join(out_string) | |
392 |
|
392 | |||
393 | def _format_list(self, extracted_list): |
|
393 | def _format_list(self, extracted_list): | |
394 | """Format a list of traceback entry tuples for printing. |
|
394 | """Format a list of traceback entry tuples for printing. | |
395 |
|
395 | |||
396 | Given a list of tuples as returned by extract_tb() or |
|
396 | Given a list of tuples as returned by extract_tb() or | |
397 | extract_stack(), return a list of strings ready for printing. |
|
397 | extract_stack(), return a list of strings ready for printing. | |
398 | Each string in the resulting list corresponds to the item with the |
|
398 | Each string in the resulting list corresponds to the item with the | |
399 | same index in the argument list. Each string ends in a newline; |
|
399 | same index in the argument list. Each string ends in a newline; | |
400 | the strings may contain internal newlines as well, for those items |
|
400 | the strings may contain internal newlines as well, for those items | |
401 | whose source text line is not None. |
|
401 | whose source text line is not None. | |
402 |
|
402 | |||
403 | Lifted almost verbatim from traceback.py |
|
403 | Lifted almost verbatim from traceback.py | |
404 | """ |
|
404 | """ | |
405 |
|
405 | |||
406 | Colors = self.Colors |
|
406 | Colors = self.Colors | |
407 | list = [] |
|
407 | list = [] | |
408 | for filename, lineno, name, line in extracted_list[:-1]: |
|
408 | for filename, lineno, name, line in extracted_list[:-1]: | |
409 | item = ' File %s"%s"%s, line %s%d%s, in %s%s%s\n' % \ |
|
409 | item = ' File %s"%s"%s, line %s%d%s, in %s%s%s\n' % \ | |
410 | (Colors.filename, filename, Colors.Normal, |
|
410 | (Colors.filename, filename, Colors.Normal, | |
411 | Colors.lineno, lineno, Colors.Normal, |
|
411 | Colors.lineno, lineno, Colors.Normal, | |
412 | Colors.name, name, Colors.Normal) |
|
412 | Colors.name, name, Colors.Normal) | |
413 | if line: |
|
413 | if line: | |
414 | item = item + ' %s\n' % line.strip() |
|
414 | item = item + ' %s\n' % line.strip() | |
415 | list.append(item) |
|
415 | list.append(item) | |
416 | # Emphasize the last entry |
|
416 | # Emphasize the last entry | |
417 | filename, lineno, name, line = extracted_list[-1] |
|
417 | filename, lineno, name, line = extracted_list[-1] | |
418 | item = '%s File %s"%s"%s, line %s%d%s, in %s%s%s%s\n' % \ |
|
418 | item = '%s File %s"%s"%s, line %s%d%s, in %s%s%s%s\n' % \ | |
419 | (Colors.normalEm, |
|
419 | (Colors.normalEm, | |
420 | Colors.filenameEm, filename, Colors.normalEm, |
|
420 | Colors.filenameEm, filename, Colors.normalEm, | |
421 | Colors.linenoEm, lineno, Colors.normalEm, |
|
421 | Colors.linenoEm, lineno, Colors.normalEm, | |
422 | Colors.nameEm, name, Colors.normalEm, |
|
422 | Colors.nameEm, name, Colors.normalEm, | |
423 | Colors.Normal) |
|
423 | Colors.Normal) | |
424 | if line: |
|
424 | if line: | |
425 | item = item + '%s %s%s\n' % (Colors.line, line.strip(), |
|
425 | item = item + '%s %s%s\n' % (Colors.line, line.strip(), | |
426 | Colors.Normal) |
|
426 | Colors.Normal) | |
427 | list.append(item) |
|
427 | list.append(item) | |
428 | return list |
|
428 | return list | |
429 |
|
429 | |||
430 | def _format_exception_only(self, etype, value): |
|
430 | def _format_exception_only(self, etype, value): | |
431 | """Format the exception part of a traceback. |
|
431 | """Format the exception part of a traceback. | |
432 |
|
432 | |||
433 | The arguments are the exception type and value such as given by |
|
433 | The arguments are the exception type and value such as given by | |
434 | sys.exc_info()[:2]. The return value is a list of strings, each ending |
|
434 | sys.exc_info()[:2]. The return value is a list of strings, each ending | |
435 | in a newline. Normally, the list contains a single string; however, |
|
435 | in a newline. Normally, the list contains a single string; however, | |
436 | for SyntaxError exceptions, it contains several lines that (when |
|
436 | for SyntaxError exceptions, it contains several lines that (when | |
437 | printed) display detailed information about where the syntax error |
|
437 | printed) display detailed information about where the syntax error | |
438 | occurred. The message indicating which exception occurred is the |
|
438 | occurred. The message indicating which exception occurred is the | |
439 | always last string in the list. |
|
439 | always last string in the list. | |
440 |
|
440 | |||
441 | Also lifted nearly verbatim from traceback.py |
|
441 | Also lifted nearly verbatim from traceback.py | |
442 | """ |
|
442 | """ | |
443 |
|
443 | |||
444 | have_filedata = False |
|
444 | have_filedata = False | |
445 | Colors = self.Colors |
|
445 | Colors = self.Colors | |
446 | list = [] |
|
446 | list = [] | |
447 | try: |
|
447 | try: | |
448 | stype = Colors.excName + etype.__name__ + Colors.Normal |
|
448 | stype = Colors.excName + etype.__name__ + Colors.Normal | |
449 | except AttributeError: |
|
449 | except AttributeError: | |
450 | stype = etype # String exceptions don't get special coloring |
|
450 | stype = etype # String exceptions don't get special coloring | |
451 | if value is None: |
|
451 | if value is None: | |
452 | list.append( str(stype) + '\n') |
|
452 | list.append( str(stype) + '\n') | |
453 | else: |
|
453 | else: | |
454 | if etype is SyntaxError: |
|
454 | if etype is SyntaxError: | |
455 | try: |
|
455 | try: | |
456 | msg, (filename, lineno, offset, line) = value |
|
456 | msg, (filename, lineno, offset, line) = value | |
457 | except: |
|
457 | except: | |
458 | have_filedata = False |
|
458 | have_filedata = False | |
459 | else: |
|
459 | else: | |
460 | have_filedata = True |
|
460 | have_filedata = True | |
461 | #print 'filename is',filename # dbg |
|
461 | #print 'filename is',filename # dbg | |
462 | if not filename: filename = "<string>" |
|
462 | if not filename: filename = "<string>" | |
463 | list.append('%s File %s"%s"%s, line %s%d%s\n' % \ |
|
463 | list.append('%s File %s"%s"%s, line %s%d%s\n' % \ | |
464 | (Colors.normalEm, |
|
464 | (Colors.normalEm, | |
465 | Colors.filenameEm, filename, Colors.normalEm, |
|
465 | Colors.filenameEm, filename, Colors.normalEm, | |
466 | Colors.linenoEm, lineno, Colors.Normal )) |
|
466 | Colors.linenoEm, lineno, Colors.Normal )) | |
467 | if line is not None: |
|
467 | if line is not None: | |
468 | i = 0 |
|
468 | i = 0 | |
469 | while i < len(line) and line[i].isspace(): |
|
469 | while i < len(line) and line[i].isspace(): | |
470 | i = i+1 |
|
470 | i = i+1 | |
471 | list.append('%s %s%s\n' % (Colors.line, |
|
471 | list.append('%s %s%s\n' % (Colors.line, | |
472 | line.strip(), |
|
472 | line.strip(), | |
473 | Colors.Normal)) |
|
473 | Colors.Normal)) | |
474 | if offset is not None: |
|
474 | if offset is not None: | |
475 | s = ' ' |
|
475 | s = ' ' | |
476 | for c in line[i:offset-1]: |
|
476 | for c in line[i:offset-1]: | |
477 | if c.isspace(): |
|
477 | if c.isspace(): | |
478 | s = s + c |
|
478 | s = s + c | |
479 | else: |
|
479 | else: | |
480 | s = s + ' ' |
|
480 | s = s + ' ' | |
481 | list.append('%s%s^%s\n' % (Colors.caret, s, |
|
481 | list.append('%s%s^%s\n' % (Colors.caret, s, | |
482 | Colors.Normal) ) |
|
482 | Colors.Normal) ) | |
483 | value = msg |
|
483 | value = msg | |
484 | s = self._some_str(value) |
|
484 | s = self._some_str(value) | |
485 | if s: |
|
485 | if s: | |
486 | list.append('%s%s:%s %s\n' % (str(stype), Colors.excName, |
|
486 | list.append('%s%s:%s %s\n' % (str(stype), Colors.excName, | |
487 | Colors.Normal, s)) |
|
487 | Colors.Normal, s)) | |
488 | else: |
|
488 | else: | |
489 | list.append('%s\n' % str(stype)) |
|
489 | list.append('%s\n' % str(stype)) | |
490 |
|
490 | |||
491 | # vds:>> |
|
491 | # vds:>> | |
492 | if have_filedata: |
|
492 | if have_filedata: | |
493 | __IPYTHON__.hooks.synchronize_with_editor(filename, lineno, 0) |
|
493 | __IPYTHON__.hooks.synchronize_with_editor(filename, lineno, 0) | |
494 | # vds:<< |
|
494 | # vds:<< | |
495 |
|
495 | |||
496 | return list |
|
496 | return list | |
497 |
|
497 | |||
498 | def _some_str(self, value): |
|
498 | def _some_str(self, value): | |
499 | # Lifted from traceback.py |
|
499 | # Lifted from traceback.py | |
500 | try: |
|
500 | try: | |
501 | return str(value) |
|
501 | return str(value) | |
502 | except: |
|
502 | except: | |
503 | return '<unprintable %s object>' % type(value).__name__ |
|
503 | return '<unprintable %s object>' % type(value).__name__ | |
504 |
|
504 | |||
505 | #---------------------------------------------------------------------------- |
|
505 | #---------------------------------------------------------------------------- | |
506 | class VerboseTB(TBTools): |
|
506 | class VerboseTB(TBTools): | |
507 | """A port of Ka-Ping Yee's cgitb.py module that outputs color text instead |
|
507 | """A port of Ka-Ping Yee's cgitb.py module that outputs color text instead | |
508 | of HTML. Requires inspect and pydoc. Crazy, man. |
|
508 | of HTML. Requires inspect and pydoc. Crazy, man. | |
509 |
|
509 | |||
510 | Modified version which optionally strips the topmost entries from the |
|
510 | Modified version which optionally strips the topmost entries from the | |
511 | traceback, to be used with alternate interpreters (because their own code |
|
511 | traceback, to be used with alternate interpreters (because their own code | |
512 | would appear in the traceback).""" |
|
512 | would appear in the traceback).""" | |
513 |
|
513 | |||
514 | def __init__(self,color_scheme = 'Linux',tb_offset=0,long_header=0, |
|
514 | def __init__(self,color_scheme = 'Linux',tb_offset=0,long_header=0, | |
515 | call_pdb = 0, include_vars=1): |
|
515 | call_pdb = 0, include_vars=1): | |
516 | """Specify traceback offset, headers and color scheme. |
|
516 | """Specify traceback offset, headers and color scheme. | |
517 |
|
517 | |||
518 | Define how many frames to drop from the tracebacks. Calling it with |
|
518 | Define how many frames to drop from the tracebacks. Calling it with | |
519 | tb_offset=1 allows use of this handler in interpreters which will have |
|
519 | tb_offset=1 allows use of this handler in interpreters which will have | |
520 | their own code at the top of the traceback (VerboseTB will first |
|
520 | their own code at the top of the traceback (VerboseTB will first | |
521 | remove that frame before printing the traceback info).""" |
|
521 | remove that frame before printing the traceback info).""" | |
522 | TBTools.__init__(self,color_scheme=color_scheme,call_pdb=call_pdb) |
|
522 | TBTools.__init__(self,color_scheme=color_scheme,call_pdb=call_pdb) | |
523 | self.tb_offset = tb_offset |
|
523 | self.tb_offset = tb_offset | |
524 | self.long_header = long_header |
|
524 | self.long_header = long_header | |
525 | self.include_vars = include_vars |
|
525 | self.include_vars = include_vars | |
526 |
|
526 | |||
527 | def text(self, etype, evalue, etb, context=5): |
|
527 | def text(self, etype, evalue, etb, context=5): | |
528 | """Return a nice text document describing the traceback.""" |
|
528 | """Return a nice text document describing the traceback.""" | |
529 |
|
529 | |||
530 | # some locals |
|
530 | # some locals | |
531 | try: |
|
531 | try: | |
532 | etype = etype.__name__ |
|
532 | etype = etype.__name__ | |
533 | except AttributeError: |
|
533 | except AttributeError: | |
534 | pass |
|
534 | pass | |
535 | Colors = self.Colors # just a shorthand + quicker name lookup |
|
535 | Colors = self.Colors # just a shorthand + quicker name lookup | |
536 | ColorsNormal = Colors.Normal # used a lot |
|
536 | ColorsNormal = Colors.Normal # used a lot | |
537 | col_scheme = self.color_scheme_table.active_scheme_name |
|
537 | col_scheme = self.color_scheme_table.active_scheme_name | |
538 | indent = ' '*INDENT_SIZE |
|
538 | indent = ' '*INDENT_SIZE | |
539 | em_normal = '%s\n%s%s' % (Colors.valEm, indent,ColorsNormal) |
|
539 | em_normal = '%s\n%s%s' % (Colors.valEm, indent,ColorsNormal) | |
540 | undefined = '%sundefined%s' % (Colors.em, ColorsNormal) |
|
540 | undefined = '%sundefined%s' % (Colors.em, ColorsNormal) | |
541 | exc = '%s%s%s' % (Colors.excName,etype,ColorsNormal) |
|
541 | exc = '%s%s%s' % (Colors.excName,etype,ColorsNormal) | |
542 |
|
542 | |||
543 | # some internal-use functions |
|
543 | # some internal-use functions | |
544 | def text_repr(value): |
|
544 | def text_repr(value): | |
545 | """Hopefully pretty robust repr equivalent.""" |
|
545 | """Hopefully pretty robust repr equivalent.""" | |
546 | # this is pretty horrible but should always return *something* |
|
546 | # this is pretty horrible but should always return *something* | |
547 | try: |
|
547 | try: | |
548 | return pydoc.text.repr(value) |
|
548 | return pydoc.text.repr(value) | |
549 | except KeyboardInterrupt: |
|
549 | except KeyboardInterrupt: | |
550 | raise |
|
550 | raise | |
551 | except: |
|
551 | except: | |
552 | try: |
|
552 | try: | |
553 | return repr(value) |
|
553 | return repr(value) | |
554 | except KeyboardInterrupt: |
|
554 | except KeyboardInterrupt: | |
555 | raise |
|
555 | raise | |
556 | except: |
|
556 | except: | |
557 | try: |
|
557 | try: | |
558 | # all still in an except block so we catch |
|
558 | # all still in an except block so we catch | |
559 | # getattr raising |
|
559 | # getattr raising | |
560 | name = getattr(value, '__name__', None) |
|
560 | name = getattr(value, '__name__', None) | |
561 | if name: |
|
561 | if name: | |
562 | # ick, recursion |
|
562 | # ick, recursion | |
563 | return text_repr(name) |
|
563 | return text_repr(name) | |
564 | klass = getattr(value, '__class__', None) |
|
564 | klass = getattr(value, '__class__', None) | |
565 | if klass: |
|
565 | if klass: | |
566 | return '%s instance' % text_repr(klass) |
|
566 | return '%s instance' % text_repr(klass) | |
567 | except KeyboardInterrupt: |
|
567 | except KeyboardInterrupt: | |
568 | raise |
|
568 | raise | |
569 | except: |
|
569 | except: | |
570 | return 'UNRECOVERABLE REPR FAILURE' |
|
570 | return 'UNRECOVERABLE REPR FAILURE' | |
571 | def eqrepr(value, repr=text_repr): return '=%s' % repr(value) |
|
571 | def eqrepr(value, repr=text_repr): return '=%s' % repr(value) | |
572 | def nullrepr(value, repr=text_repr): return '' |
|
572 | def nullrepr(value, repr=text_repr): return '' | |
573 |
|
573 | |||
574 | # meat of the code begins |
|
574 | # meat of the code begins | |
575 | try: |
|
575 | try: | |
576 | etype = etype.__name__ |
|
576 | etype = etype.__name__ | |
577 | except AttributeError: |
|
577 | except AttributeError: | |
578 | pass |
|
578 | pass | |
579 |
|
579 | |||
580 | if self.long_header: |
|
580 | if self.long_header: | |
581 | # Header with the exception type, python version, and date |
|
581 | # Header with the exception type, python version, and date | |
582 | pyver = 'Python ' + string.split(sys.version)[0] + ': ' + sys.executable |
|
582 | pyver = 'Python ' + string.split(sys.version)[0] + ': ' + sys.executable | |
583 | date = time.ctime(time.time()) |
|
583 | date = time.ctime(time.time()) | |
584 |
|
584 | |||
585 | head = '%s%s%s\n%s%s%s\n%s' % (Colors.topline, '-'*75, ColorsNormal, |
|
585 | head = '%s%s%s\n%s%s%s\n%s' % (Colors.topline, '-'*75, ColorsNormal, | |
586 | exc, ' '*(75-len(str(etype))-len(pyver)), |
|
586 | exc, ' '*(75-len(str(etype))-len(pyver)), | |
587 | pyver, string.rjust(date, 75) ) |
|
587 | pyver, string.rjust(date, 75) ) | |
588 | head += "\nA problem occured executing Python code. Here is the sequence of function"\ |
|
588 | head += "\nA problem occured executing Python code. Here is the sequence of function"\ | |
589 | "\ncalls leading up to the error, with the most recent (innermost) call last." |
|
589 | "\ncalls leading up to the error, with the most recent (innermost) call last." | |
590 | else: |
|
590 | else: | |
591 | # Simplified header |
|
591 | # Simplified header | |
592 | head = '%s%s%s\n%s%s' % (Colors.topline, '-'*75, ColorsNormal,exc, |
|
592 | head = '%s%s%s\n%s%s' % (Colors.topline, '-'*75, ColorsNormal,exc, | |
593 | string.rjust('Traceback (most recent call last)', |
|
593 | string.rjust('Traceback (most recent call last)', | |
594 | 75 - len(str(etype)) ) ) |
|
594 | 75 - len(str(etype)) ) ) | |
595 | frames = [] |
|
595 | frames = [] | |
596 | # Flush cache before calling inspect. This helps alleviate some of the |
|
596 | # Flush cache before calling inspect. This helps alleviate some of the | |
597 | # problems with python 2.3's inspect.py. |
|
597 | # problems with python 2.3's inspect.py. | |
598 | linecache.checkcache() |
|
598 | linecache.checkcache() | |
599 | # Drop topmost frames if requested |
|
599 | # Drop topmost frames if requested | |
600 | try: |
|
600 | try: | |
601 | # Try the default getinnerframes and Alex's: Alex's fixes some |
|
601 | # Try the default getinnerframes and Alex's: Alex's fixes some | |
602 | # problems, but it generates empty tracebacks for console errors |
|
602 | # problems, but it generates empty tracebacks for console errors | |
603 | # (5 blanks lines) where none should be returned. |
|
603 | # (5 blanks lines) where none should be returned. | |
604 | #records = inspect.getinnerframes(etb, context)[self.tb_offset:] |
|
604 | #records = inspect.getinnerframes(etb, context)[self.tb_offset:] | |
605 | #print 'python records:', records # dbg |
|
605 | #print 'python records:', records # dbg | |
606 | records = _fixed_getinnerframes(etb, context,self.tb_offset) |
|
606 | records = _fixed_getinnerframes(etb, context,self.tb_offset) | |
607 | #print 'alex records:', records # dbg |
|
607 | #print 'alex records:', records # dbg | |
608 | except: |
|
608 | except: | |
609 |
|
609 | |||
610 | # FIXME: I've been getting many crash reports from python 2.3 |
|
610 | # FIXME: I've been getting many crash reports from python 2.3 | |
611 | # users, traceable to inspect.py. If I can find a small test-case |
|
611 | # users, traceable to inspect.py. If I can find a small test-case | |
612 | # to reproduce this, I should either write a better workaround or |
|
612 | # to reproduce this, I should either write a better workaround or | |
613 | # file a bug report against inspect (if that's the real problem). |
|
613 | # file a bug report against inspect (if that's the real problem). | |
614 | # So far, I haven't been able to find an isolated example to |
|
614 | # So far, I haven't been able to find an isolated example to | |
615 | # reproduce the problem. |
|
615 | # reproduce the problem. | |
616 | inspect_error() |
|
616 | inspect_error() | |
617 | traceback.print_exc(file=Term.cerr) |
|
617 | traceback.print_exc(file=Term.cerr) | |
618 | info('\nUnfortunately, your original traceback can not be constructed.\n') |
|
618 | info('\nUnfortunately, your original traceback can not be constructed.\n') | |
619 | return '' |
|
619 | return '' | |
620 |
|
620 | |||
621 | # build some color string templates outside these nested loops |
|
621 | # build some color string templates outside these nested loops | |
622 | tpl_link = '%s%%s%s' % (Colors.filenameEm,ColorsNormal) |
|
622 | tpl_link = '%s%%s%s' % (Colors.filenameEm,ColorsNormal) | |
623 | tpl_call = 'in %s%%s%s%%s%s' % (Colors.vName, Colors.valEm, |
|
623 | tpl_call = 'in %s%%s%s%%s%s' % (Colors.vName, Colors.valEm, | |
624 | ColorsNormal) |
|
624 | ColorsNormal) | |
625 | tpl_call_fail = 'in %s%%s%s(***failed resolving arguments***)%s' % \ |
|
625 | tpl_call_fail = 'in %s%%s%s(***failed resolving arguments***)%s' % \ | |
626 | (Colors.vName, Colors.valEm, ColorsNormal) |
|
626 | (Colors.vName, Colors.valEm, ColorsNormal) | |
627 | tpl_local_var = '%s%%s%s' % (Colors.vName, ColorsNormal) |
|
627 | tpl_local_var = '%s%%s%s' % (Colors.vName, ColorsNormal) | |
628 | tpl_global_var = '%sglobal%s %s%%s%s' % (Colors.em, ColorsNormal, |
|
628 | tpl_global_var = '%sglobal%s %s%%s%s' % (Colors.em, ColorsNormal, | |
629 | Colors.vName, ColorsNormal) |
|
629 | Colors.vName, ColorsNormal) | |
630 | tpl_name_val = '%%s %s= %%s%s' % (Colors.valEm, ColorsNormal) |
|
630 | tpl_name_val = '%%s %s= %%s%s' % (Colors.valEm, ColorsNormal) | |
631 | tpl_line = '%s%%s%s %%s' % (Colors.lineno, ColorsNormal) |
|
631 | tpl_line = '%s%%s%s %%s' % (Colors.lineno, ColorsNormal) | |
632 | tpl_line_em = '%s%%s%s %%s%s' % (Colors.linenoEm,Colors.line, |
|
632 | tpl_line_em = '%s%%s%s %%s%s' % (Colors.linenoEm,Colors.line, | |
633 | ColorsNormal) |
|
633 | ColorsNormal) | |
634 |
|
634 | |||
635 | # now, loop over all records printing context and info |
|
635 | # now, loop over all records printing context and info | |
636 | abspath = os.path.abspath |
|
636 | abspath = os.path.abspath | |
637 | for frame, file, lnum, func, lines, index in records: |
|
637 | for frame, file, lnum, func, lines, index in records: | |
638 | #print '*** record:',file,lnum,func,lines,index # dbg |
|
638 | #print '*** record:',file,lnum,func,lines,index # dbg | |
639 | try: |
|
639 | try: | |
640 | file = file and abspath(file) or '?' |
|
640 | file = file and abspath(file) or '?' | |
641 | except OSError: |
|
641 | except OSError: | |
642 | # if file is '<console>' or something not in the filesystem, |
|
642 | # if file is '<console>' or something not in the filesystem, | |
643 | # the abspath call will throw an OSError. Just ignore it and |
|
643 | # the abspath call will throw an OSError. Just ignore it and | |
644 | # keep the original file string. |
|
644 | # keep the original file string. | |
645 | pass |
|
645 | pass | |
646 | link = tpl_link % file |
|
646 | link = tpl_link % file | |
647 | try: |
|
647 | try: | |
648 | args, varargs, varkw, locals = inspect.getargvalues(frame) |
|
648 | args, varargs, varkw, locals = inspect.getargvalues(frame) | |
649 | except: |
|
649 | except: | |
650 | # This can happen due to a bug in python2.3. We should be |
|
650 | # This can happen due to a bug in python2.3. We should be | |
651 | # able to remove this try/except when 2.4 becomes a |
|
651 | # able to remove this try/except when 2.4 becomes a | |
652 | # requirement. Bug details at http://python.org/sf/1005466 |
|
652 | # requirement. Bug details at http://python.org/sf/1005466 | |
653 | inspect_error() |
|
653 | inspect_error() | |
654 | traceback.print_exc(file=Term.cerr) |
|
654 | traceback.print_exc(file=Term.cerr) | |
655 | info("\nIPython's exception reporting continues...\n") |
|
655 | info("\nIPython's exception reporting continues...\n") | |
656 |
|
656 | |||
657 | if func == '?': |
|
657 | if func == '?': | |
658 | call = '' |
|
658 | call = '' | |
659 | else: |
|
659 | else: | |
660 | # Decide whether to include variable details or not |
|
660 | # Decide whether to include variable details or not | |
661 | var_repr = self.include_vars and eqrepr or nullrepr |
|
661 | var_repr = self.include_vars and eqrepr or nullrepr | |
662 | try: |
|
662 | try: | |
663 | call = tpl_call % (func,inspect.formatargvalues(args, |
|
663 | call = tpl_call % (func,inspect.formatargvalues(args, | |
664 | varargs, varkw, |
|
664 | varargs, varkw, | |
665 | locals,formatvalue=var_repr)) |
|
665 | locals,formatvalue=var_repr)) | |
666 | except KeyError: |
|
666 | except KeyError: | |
667 | # Very odd crash from inspect.formatargvalues(). The |
|
667 | # Very odd crash from inspect.formatargvalues(). The | |
668 | # scenario under which it appeared was a call to |
|
668 | # scenario under which it appeared was a call to | |
669 | # view(array,scale) in NumTut.view.view(), where scale had |
|
669 | # view(array,scale) in NumTut.view.view(), where scale had | |
670 | # been defined as a scalar (it should be a tuple). Somehow |
|
670 | # been defined as a scalar (it should be a tuple). Somehow | |
671 | # inspect messes up resolving the argument list of view() |
|
671 | # inspect messes up resolving the argument list of view() | |
672 | # and barfs out. At some point I should dig into this one |
|
672 | # and barfs out. At some point I should dig into this one | |
673 | # and file a bug report about it. |
|
673 | # and file a bug report about it. | |
674 | inspect_error() |
|
674 | inspect_error() | |
675 | traceback.print_exc(file=Term.cerr) |
|
675 | traceback.print_exc(file=Term.cerr) | |
676 | info("\nIPython's exception reporting continues...\n") |
|
676 | info("\nIPython's exception reporting continues...\n") | |
677 | call = tpl_call_fail % func |
|
677 | call = tpl_call_fail % func | |
678 |
|
678 | |||
679 | # Initialize a list of names on the current line, which the |
|
679 | # Initialize a list of names on the current line, which the | |
680 | # tokenizer below will populate. |
|
680 | # tokenizer below will populate. | |
681 | names = [] |
|
681 | names = [] | |
682 |
|
682 | |||
683 | def tokeneater(token_type, token, start, end, line): |
|
683 | def tokeneater(token_type, token, start, end, line): | |
684 | """Stateful tokeneater which builds dotted names. |
|
684 | """Stateful tokeneater which builds dotted names. | |
685 |
|
685 | |||
686 | The list of names it appends to (from the enclosing scope) can |
|
686 | The list of names it appends to (from the enclosing scope) can | |
687 | contain repeated composite names. This is unavoidable, since |
|
687 | contain repeated composite names. This is unavoidable, since | |
688 | there is no way to disambguate partial dotted structures until |
|
688 | there is no way to disambguate partial dotted structures until | |
689 | the full list is known. The caller is responsible for pruning |
|
689 | the full list is known. The caller is responsible for pruning | |
690 | the final list of duplicates before using it.""" |
|
690 | the final list of duplicates before using it.""" | |
691 |
|
691 | |||
692 | # build composite names |
|
692 | # build composite names | |
693 | if token == '.': |
|
693 | if token == '.': | |
694 | try: |
|
694 | try: | |
695 | names[-1] += '.' |
|
695 | names[-1] += '.' | |
696 | # store state so the next token is added for x.y.z names |
|
696 | # store state so the next token is added for x.y.z names | |
697 | tokeneater.name_cont = True |
|
697 | tokeneater.name_cont = True | |
698 | return |
|
698 | return | |
699 | except IndexError: |
|
699 | except IndexError: | |
700 | pass |
|
700 | pass | |
701 | if token_type == tokenize.NAME and token not in keyword.kwlist: |
|
701 | if token_type == tokenize.NAME and token not in keyword.kwlist: | |
702 | if tokeneater.name_cont: |
|
702 | if tokeneater.name_cont: | |
703 | # Dotted names |
|
703 | # Dotted names | |
704 | names[-1] += token |
|
704 | names[-1] += token | |
705 | tokeneater.name_cont = False |
|
705 | tokeneater.name_cont = False | |
706 | else: |
|
706 | else: | |
707 | # Regular new names. We append everything, the caller |
|
707 | # Regular new names. We append everything, the caller | |
708 | # will be responsible for pruning the list later. It's |
|
708 | # will be responsible for pruning the list later. It's | |
709 | # very tricky to try to prune as we go, b/c composite |
|
709 | # very tricky to try to prune as we go, b/c composite | |
710 | # names can fool us. The pruning at the end is easy |
|
710 | # names can fool us. The pruning at the end is easy | |
711 | # to do (or the caller can print a list with repeated |
|
711 | # to do (or the caller can print a list with repeated | |
712 | # names if so desired. |
|
712 | # names if so desired. | |
713 | names.append(token) |
|
713 | names.append(token) | |
714 | elif token_type == tokenize.NEWLINE: |
|
714 | elif token_type == tokenize.NEWLINE: | |
715 | raise IndexError |
|
715 | raise IndexError | |
716 | # we need to store a bit of state in the tokenizer to build |
|
716 | # we need to store a bit of state in the tokenizer to build | |
717 | # dotted names |
|
717 | # dotted names | |
718 | tokeneater.name_cont = False |
|
718 | tokeneater.name_cont = False | |
719 |
|
719 | |||
720 | def linereader(file=file, lnum=[lnum], getline=linecache.getline): |
|
720 | def linereader(file=file, lnum=[lnum], getline=linecache.getline): | |
721 | line = getline(file, lnum[0]) |
|
721 | line = getline(file, lnum[0]) | |
722 | lnum[0] += 1 |
|
722 | lnum[0] += 1 | |
723 | return line |
|
723 | return line | |
724 |
|
724 | |||
725 | # Build the list of names on this line of code where the exception |
|
725 | # Build the list of names on this line of code where the exception | |
726 | # occurred. |
|
726 | # occurred. | |
727 | try: |
|
727 | try: | |
728 | # This builds the names list in-place by capturing it from the |
|
728 | # This builds the names list in-place by capturing it from the | |
729 | # enclosing scope. |
|
729 | # enclosing scope. | |
730 | tokenize.tokenize(linereader, tokeneater) |
|
730 | tokenize.tokenize(linereader, tokeneater) | |
731 | except IndexError: |
|
731 | except IndexError: | |
732 | # signals exit of tokenizer |
|
732 | # signals exit of tokenizer | |
733 | pass |
|
733 | pass | |
734 | except tokenize.TokenError,msg: |
|
734 | except tokenize.TokenError,msg: | |
735 | _m = ("An unexpected error occurred while tokenizing input\n" |
|
735 | _m = ("An unexpected error occurred while tokenizing input\n" | |
736 | "The following traceback may be corrupted or invalid\n" |
|
736 | "The following traceback may be corrupted or invalid\n" | |
737 | "The error message is: %s\n" % msg) |
|
737 | "The error message is: %s\n" % msg) | |
738 | error(_m) |
|
738 | error(_m) | |
739 |
|
739 | |||
740 | # prune names list of duplicates, but keep the right order |
|
740 | # prune names list of duplicates, but keep the right order | |
741 | unique_names = uniq_stable(names) |
|
741 | unique_names = uniq_stable(names) | |
742 |
|
742 | |||
743 | # Start loop over vars |
|
743 | # Start loop over vars | |
744 | lvals = [] |
|
744 | lvals = [] | |
745 | if self.include_vars: |
|
745 | if self.include_vars: | |
746 | for name_full in unique_names: |
|
746 | for name_full in unique_names: | |
747 | name_base = name_full.split('.',1)[0] |
|
747 | name_base = name_full.split('.',1)[0] | |
748 | if name_base in frame.f_code.co_varnames: |
|
748 | if name_base in frame.f_code.co_varnames: | |
749 | if locals.has_key(name_base): |
|
749 | if locals.has_key(name_base): | |
750 | try: |
|
750 | try: | |
751 | value = repr(eval(name_full,locals)) |
|
751 | value = repr(eval(name_full,locals)) | |
752 | except: |
|
752 | except: | |
753 | value = undefined |
|
753 | value = undefined | |
754 | else: |
|
754 | else: | |
755 | value = undefined |
|
755 | value = undefined | |
756 | name = tpl_local_var % name_full |
|
756 | name = tpl_local_var % name_full | |
757 | else: |
|
757 | else: | |
758 | if frame.f_globals.has_key(name_base): |
|
758 | if frame.f_globals.has_key(name_base): | |
759 | try: |
|
759 | try: | |
760 | value = repr(eval(name_full,frame.f_globals)) |
|
760 | value = repr(eval(name_full,frame.f_globals)) | |
761 | except: |
|
761 | except: | |
762 | value = undefined |
|
762 | value = undefined | |
763 | else: |
|
763 | else: | |
764 | value = undefined |
|
764 | value = undefined | |
765 | name = tpl_global_var % name_full |
|
765 | name = tpl_global_var % name_full | |
766 | lvals.append(tpl_name_val % (name,value)) |
|
766 | lvals.append(tpl_name_val % (name,value)) | |
767 | if lvals: |
|
767 | if lvals: | |
768 | lvals = '%s%s' % (indent,em_normal.join(lvals)) |
|
768 | lvals = '%s%s' % (indent,em_normal.join(lvals)) | |
769 | else: |
|
769 | else: | |
770 | lvals = '' |
|
770 | lvals = '' | |
771 |
|
771 | |||
772 | level = '%s %s\n' % (link,call) |
|
772 | level = '%s %s\n' % (link,call) | |
773 |
|
773 | |||
774 | if index is None: |
|
774 | if index is None: | |
775 | frames.append(level) |
|
775 | frames.append(level) | |
776 | else: |
|
776 | else: | |
777 | frames.append('%s%s' % (level,''.join( |
|
777 | frames.append('%s%s' % (level,''.join( | |
778 | _formatTracebackLines(lnum,index,lines,Colors,lvals, |
|
778 | _formatTracebackLines(lnum,index,lines,Colors,lvals, | |
779 | col_scheme)))) |
|
779 | col_scheme)))) | |
780 |
|
780 | |||
781 | # Get (safely) a string form of the exception info |
|
781 | # Get (safely) a string form of the exception info | |
782 | try: |
|
782 | try: | |
783 | etype_str,evalue_str = map(str,(etype,evalue)) |
|
783 | etype_str,evalue_str = map(str,(etype,evalue)) | |
784 | except: |
|
784 | except: | |
785 | # User exception is improperly defined. |
|
785 | # User exception is improperly defined. | |
786 | etype,evalue = str,sys.exc_info()[:2] |
|
786 | etype,evalue = str,sys.exc_info()[:2] | |
787 | etype_str,evalue_str = map(str,(etype,evalue)) |
|
787 | etype_str,evalue_str = map(str,(etype,evalue)) | |
788 | # ... and format it |
|
788 | # ... and format it | |
789 | exception = ['%s%s%s: %s' % (Colors.excName, etype_str, |
|
789 | exception = ['%s%s%s: %s' % (Colors.excName, etype_str, | |
790 | ColorsNormal, evalue_str)] |
|
790 | ColorsNormal, evalue_str)] | |
791 | if type(evalue) is types.InstanceType: |
|
791 | if type(evalue) is types.InstanceType: | |
792 | try: |
|
792 | try: | |
793 | names = [w for w in dir(evalue) if isinstance(w, basestring)] |
|
793 | names = [w for w in dir(evalue) if isinstance(w, basestring)] | |
794 | except: |
|
794 | except: | |
795 | # Every now and then, an object with funny inernals blows up |
|
795 | # Every now and then, an object with funny inernals blows up | |
796 | # when dir() is called on it. We do the best we can to report |
|
796 | # when dir() is called on it. We do the best we can to report | |
797 | # the problem and continue |
|
797 | # the problem and continue | |
798 | _m = '%sException reporting error (object with broken dir())%s:' |
|
798 | _m = '%sException reporting error (object with broken dir())%s:' | |
799 | exception.append(_m % (Colors.excName,ColorsNormal)) |
|
799 | exception.append(_m % (Colors.excName,ColorsNormal)) | |
800 | etype_str,evalue_str = map(str,sys.exc_info()[:2]) |
|
800 | etype_str,evalue_str = map(str,sys.exc_info()[:2]) | |
801 | exception.append('%s%s%s: %s' % (Colors.excName,etype_str, |
|
801 | exception.append('%s%s%s: %s' % (Colors.excName,etype_str, | |
802 | ColorsNormal, evalue_str)) |
|
802 | ColorsNormal, evalue_str)) | |
803 | names = [] |
|
803 | names = [] | |
804 | for name in names: |
|
804 | for name in names: | |
805 | value = text_repr(getattr(evalue, name)) |
|
805 | value = text_repr(getattr(evalue, name)) | |
806 | exception.append('\n%s%s = %s' % (indent, name, value)) |
|
806 | exception.append('\n%s%s = %s' % (indent, name, value)) | |
807 |
|
807 | |||
808 | # vds: >> |
|
808 | # vds: >> | |
809 | if records: |
|
809 | if records: | |
810 | filepath, lnum = records[-1][1:3] |
|
810 | filepath, lnum = records[-1][1:3] | |
811 | #print "file:", str(file), "linenb", str(lnum) # dbg |
|
811 | #print "file:", str(file), "linenb", str(lnum) # dbg | |
812 | filepath = os.path.abspath(filepath) |
|
812 | filepath = os.path.abspath(filepath) | |
813 | __IPYTHON__.hooks.synchronize_with_editor(filepath, lnum, 0) |
|
813 | __IPYTHON__.hooks.synchronize_with_editor(filepath, lnum, 0) | |
814 | # vds: << |
|
814 | # vds: << | |
815 |
|
815 | |||
816 | # return all our info assembled as a single string |
|
816 | # return all our info assembled as a single string | |
817 | return '%s\n\n%s\n%s' % (head,'\n'.join(frames),''.join(exception[0]) ) |
|
817 | return '%s\n\n%s\n%s' % (head,'\n'.join(frames),''.join(exception[0]) ) | |
818 |
|
818 | |||
819 | def debugger(self,force=False): |
|
819 | def debugger(self,force=False): | |
820 | """Call up the pdb debugger if desired, always clean up the tb |
|
820 | """Call up the pdb debugger if desired, always clean up the tb | |
821 | reference. |
|
821 | reference. | |
822 |
|
822 | |||
823 | Keywords: |
|
823 | Keywords: | |
824 |
|
824 | |||
825 | - force(False): by default, this routine checks the instance call_pdb |
|
825 | - force(False): by default, this routine checks the instance call_pdb | |
826 | flag and does not actually invoke the debugger if the flag is false. |
|
826 | flag and does not actually invoke the debugger if the flag is false. | |
827 | The 'force' option forces the debugger to activate even if the flag |
|
827 | The 'force' option forces the debugger to activate even if the flag | |
828 | is false. |
|
828 | is false. | |
829 |
|
829 | |||
830 | If the call_pdb flag is set, the pdb interactive debugger is |
|
830 | If the call_pdb flag is set, the pdb interactive debugger is | |
831 | invoked. In all cases, the self.tb reference to the current traceback |
|
831 | invoked. In all cases, the self.tb reference to the current traceback | |
832 | is deleted to prevent lingering references which hamper memory |
|
832 | is deleted to prevent lingering references which hamper memory | |
833 | management. |
|
833 | management. | |
834 |
|
834 | |||
835 | Note that each call to pdb() does an 'import readline', so if your app |
|
835 | Note that each call to pdb() does an 'import readline', so if your app | |
836 | requires a special setup for the readline completers, you'll have to |
|
836 | requires a special setup for the readline completers, you'll have to | |
837 | fix that by hand after invoking the exception handler.""" |
|
837 | fix that by hand after invoking the exception handler.""" | |
838 |
|
838 | |||
839 | if force or self.call_pdb: |
|
839 | if force or self.call_pdb: | |
840 | if self.pdb is None: |
|
840 | if self.pdb is None: | |
841 | self.pdb = debugger.Pdb( |
|
841 | self.pdb = debugger.Pdb( | |
842 | self.color_scheme_table.active_scheme_name) |
|
842 | self.color_scheme_table.active_scheme_name) | |
843 | # the system displayhook may have changed, restore the original |
|
843 | # the system displayhook may have changed, restore the original | |
844 | # for pdb |
|
844 | # for pdb | |
845 | dhook = sys.displayhook |
|
845 | dhook = sys.displayhook | |
846 | sys.displayhook = sys.__displayhook__ |
|
846 | sys.displayhook = sys.__displayhook__ | |
847 | self.pdb.reset() |
|
847 | self.pdb.reset() | |
848 | # Find the right frame so we don't pop up inside ipython itself |
|
848 | # Find the right frame so we don't pop up inside ipython itself | |
849 | if hasattr(self,'tb'): |
|
849 | if hasattr(self,'tb'): | |
850 | etb = self.tb |
|
850 | etb = self.tb | |
851 | else: |
|
851 | else: | |
852 | etb = self.tb = sys.last_traceback |
|
852 | etb = self.tb = sys.last_traceback | |
853 | while self.tb.tb_next is not None: |
|
853 | while self.tb.tb_next is not None: | |
854 | self.tb = self.tb.tb_next |
|
854 | self.tb = self.tb.tb_next | |
855 | try: |
|
855 | try: | |
856 | if etb and etb.tb_next: |
|
856 | if etb and etb.tb_next: | |
857 | etb = etb.tb_next |
|
857 | etb = etb.tb_next | |
858 | self.pdb.botframe = etb.tb_frame |
|
858 | self.pdb.botframe = etb.tb_frame | |
859 | self.pdb.interaction(self.tb.tb_frame, self.tb) |
|
859 | self.pdb.interaction(self.tb.tb_frame, self.tb) | |
860 | finally: |
|
860 | finally: | |
861 | sys.displayhook = dhook |
|
861 | sys.displayhook = dhook | |
862 |
|
862 | |||
863 | if hasattr(self,'tb'): |
|
863 | if hasattr(self,'tb'): | |
864 | del self.tb |
|
864 | del self.tb | |
865 |
|
865 | |||
866 | def handler(self, info=None): |
|
866 | def handler(self, info=None): | |
867 | (etype, evalue, etb) = info or sys.exc_info() |
|
867 | (etype, evalue, etb) = info or sys.exc_info() | |
868 | self.tb = etb |
|
868 | self.tb = etb | |
869 | Term.cout.flush() |
|
869 | Term.cout.flush() | |
870 | print >> Term.cerr, self.text(etype, evalue, etb) |
|
870 | print >> Term.cerr, self.text(etype, evalue, etb) | |
871 | Term.cerr.flush() |
|
871 | Term.cerr.flush() | |
872 |
|
872 | |||
873 | # Changed so an instance can just be called as VerboseTB_inst() and print |
|
873 | # Changed so an instance can just be called as VerboseTB_inst() and print | |
874 | # out the right info on its own. |
|
874 | # out the right info on its own. | |
875 | def __call__(self, etype=None, evalue=None, etb=None): |
|
875 | def __call__(self, etype=None, evalue=None, etb=None): | |
876 | """This hook can replace sys.excepthook (for Python 2.1 or higher).""" |
|
876 | """This hook can replace sys.excepthook (for Python 2.1 or higher).""" | |
877 | if etb is None: |
|
877 | if etb is None: | |
878 | self.handler() |
|
878 | self.handler() | |
879 | else: |
|
879 | else: | |
880 | self.handler((etype, evalue, etb)) |
|
880 | self.handler((etype, evalue, etb)) | |
881 | try: |
|
881 | try: | |
882 | self.debugger() |
|
882 | self.debugger() | |
883 | except KeyboardInterrupt: |
|
883 | except KeyboardInterrupt: | |
884 | print "\nKeyboardInterrupt" |
|
884 | print "\nKeyboardInterrupt" | |
885 |
|
885 | |||
886 | #---------------------------------------------------------------------------- |
|
886 | #---------------------------------------------------------------------------- | |
887 | class FormattedTB(VerboseTB,ListTB): |
|
887 | class FormattedTB(VerboseTB,ListTB): | |
888 | """Subclass ListTB but allow calling with a traceback. |
|
888 | """Subclass ListTB but allow calling with a traceback. | |
889 |
|
889 | |||
890 | It can thus be used as a sys.excepthook for Python > 2.1. |
|
890 | It can thus be used as a sys.excepthook for Python > 2.1. | |
891 |
|
891 | |||
892 | Also adds 'Context' and 'Verbose' modes, not available in ListTB. |
|
892 | Also adds 'Context' and 'Verbose' modes, not available in ListTB. | |
893 |
|
893 | |||
894 | Allows a tb_offset to be specified. This is useful for situations where |
|
894 | Allows a tb_offset to be specified. This is useful for situations where | |
895 | one needs to remove a number of topmost frames from the traceback (such as |
|
895 | one needs to remove a number of topmost frames from the traceback (such as | |
896 | occurs with python programs that themselves execute other python code, |
|
896 | occurs with python programs that themselves execute other python code, | |
897 | like Python shells). """ |
|
897 | like Python shells). """ | |
898 |
|
898 | |||
899 | def __init__(self, mode = 'Plain', color_scheme='Linux', |
|
899 | def __init__(self, mode = 'Plain', color_scheme='Linux', | |
900 | tb_offset = 0,long_header=0,call_pdb=0,include_vars=0): |
|
900 | tb_offset = 0,long_header=0,call_pdb=0,include_vars=0): | |
901 |
|
901 | |||
902 | # NEVER change the order of this list. Put new modes at the end: |
|
902 | # NEVER change the order of this list. Put new modes at the end: | |
903 | self.valid_modes = ['Plain','Context','Verbose'] |
|
903 | self.valid_modes = ['Plain','Context','Verbose'] | |
904 | self.verbose_modes = self.valid_modes[1:3] |
|
904 | self.verbose_modes = self.valid_modes[1:3] | |
905 |
|
905 | |||
906 | VerboseTB.__init__(self,color_scheme,tb_offset,long_header, |
|
906 | VerboseTB.__init__(self,color_scheme,tb_offset,long_header, | |
907 | call_pdb=call_pdb,include_vars=include_vars) |
|
907 | call_pdb=call_pdb,include_vars=include_vars) | |
908 | self.set_mode(mode) |
|
908 | self.set_mode(mode) | |
909 |
|
909 | |||
910 | def _extract_tb(self,tb): |
|
910 | def _extract_tb(self,tb): | |
911 | if tb: |
|
911 | if tb: | |
912 | return traceback.extract_tb(tb) |
|
912 | return traceback.extract_tb(tb) | |
913 | else: |
|
913 | else: | |
914 | return None |
|
914 | return None | |
915 |
|
915 | |||
916 | def text(self, etype, value, tb,context=5,mode=None): |
|
916 | def text(self, etype, value, tb,context=5,mode=None): | |
917 | """Return formatted traceback. |
|
917 | """Return formatted traceback. | |
918 |
|
918 | |||
919 | If the optional mode parameter is given, it overrides the current |
|
919 | If the optional mode parameter is given, it overrides the current | |
920 | mode.""" |
|
920 | mode.""" | |
921 |
|
921 | |||
922 | if mode is None: |
|
922 | if mode is None: | |
923 | mode = self.mode |
|
923 | mode = self.mode | |
924 | if mode in self.verbose_modes: |
|
924 | if mode in self.verbose_modes: | |
925 | # verbose modes need a full traceback |
|
925 | # verbose modes need a full traceback | |
926 | return VerboseTB.text(self,etype, value, tb,context=5) |
|
926 | return VerboseTB.text(self,etype, value, tb,context=5) | |
927 | else: |
|
927 | else: | |
928 | # We must check the source cache because otherwise we can print |
|
928 | # We must check the source cache because otherwise we can print | |
929 | # out-of-date source code. |
|
929 | # out-of-date source code. | |
930 | linecache.checkcache() |
|
930 | linecache.checkcache() | |
931 | # Now we can extract and format the exception |
|
931 | # Now we can extract and format the exception | |
932 | elist = self._extract_tb(tb) |
|
932 | elist = self._extract_tb(tb) | |
933 | if len(elist) > self.tb_offset: |
|
933 | if len(elist) > self.tb_offset: | |
934 | del elist[:self.tb_offset] |
|
934 | del elist[:self.tb_offset] | |
935 | return ListTB.text(self,etype,value,elist) |
|
935 | return ListTB.text(self,etype,value,elist) | |
936 |
|
936 | |||
937 | def set_mode(self,mode=None): |
|
937 | def set_mode(self,mode=None): | |
938 | """Switch to the desired mode. |
|
938 | """Switch to the desired mode. | |
939 |
|
939 | |||
940 | If mode is not specified, cycles through the available modes.""" |
|
940 | If mode is not specified, cycles through the available modes.""" | |
941 |
|
941 | |||
942 | if not mode: |
|
942 | if not mode: | |
943 | new_idx = ( self.valid_modes.index(self.mode) + 1 ) % \ |
|
943 | new_idx = ( self.valid_modes.index(self.mode) + 1 ) % \ | |
944 | len(self.valid_modes) |
|
944 | len(self.valid_modes) | |
945 | self.mode = self.valid_modes[new_idx] |
|
945 | self.mode = self.valid_modes[new_idx] | |
946 | elif mode not in self.valid_modes: |
|
946 | elif mode not in self.valid_modes: | |
947 | raise ValueError, 'Unrecognized mode in FormattedTB: <'+mode+'>\n'\ |
|
947 | raise ValueError, 'Unrecognized mode in FormattedTB: <'+mode+'>\n'\ | |
948 | 'Valid modes: '+str(self.valid_modes) |
|
948 | 'Valid modes: '+str(self.valid_modes) | |
949 | else: |
|
949 | else: | |
950 | self.mode = mode |
|
950 | self.mode = mode | |
951 | # include variable details only in 'Verbose' mode |
|
951 | # include variable details only in 'Verbose' mode | |
952 | self.include_vars = (self.mode == self.valid_modes[2]) |
|
952 | self.include_vars = (self.mode == self.valid_modes[2]) | |
953 |
|
953 | |||
954 | # some convenient shorcuts |
|
954 | # some convenient shorcuts | |
955 | def plain(self): |
|
955 | def plain(self): | |
956 | self.set_mode(self.valid_modes[0]) |
|
956 | self.set_mode(self.valid_modes[0]) | |
957 |
|
957 | |||
958 | def context(self): |
|
958 | def context(self): | |
959 | self.set_mode(self.valid_modes[1]) |
|
959 | self.set_mode(self.valid_modes[1]) | |
960 |
|
960 | |||
961 | def verbose(self): |
|
961 | def verbose(self): | |
962 | self.set_mode(self.valid_modes[2]) |
|
962 | self.set_mode(self.valid_modes[2]) | |
963 |
|
963 | |||
964 | #---------------------------------------------------------------------------- |
|
964 | #---------------------------------------------------------------------------- | |
965 | class AutoFormattedTB(FormattedTB): |
|
965 | class AutoFormattedTB(FormattedTB): | |
966 | """A traceback printer which can be called on the fly. |
|
966 | """A traceback printer which can be called on the fly. | |
967 |
|
967 | |||
968 | It will find out about exceptions by itself. |
|
968 | It will find out about exceptions by itself. | |
969 |
|
969 | |||
970 | A brief example: |
|
970 | A brief example: | |
971 |
|
971 | |||
972 | AutoTB = AutoFormattedTB(mode = 'Verbose',color_scheme='Linux') |
|
972 | AutoTB = AutoFormattedTB(mode = 'Verbose',color_scheme='Linux') | |
973 | try: |
|
973 | try: | |
974 | ... |
|
974 | ... | |
975 | except: |
|
975 | except: | |
976 | AutoTB() # or AutoTB(out=logfile) where logfile is an open file object |
|
976 | AutoTB() # or AutoTB(out=logfile) where logfile is an open file object | |
977 | """ |
|
977 | """ | |
978 | def __call__(self,etype=None,evalue=None,etb=None, |
|
978 | def __call__(self,etype=None,evalue=None,etb=None, | |
979 | out=None,tb_offset=None): |
|
979 | out=None,tb_offset=None): | |
980 | """Print out a formatted exception traceback. |
|
980 | """Print out a formatted exception traceback. | |
981 |
|
981 | |||
982 | Optional arguments: |
|
982 | Optional arguments: | |
983 | - out: an open file-like object to direct output to. |
|
983 | - out: an open file-like object to direct output to. | |
984 |
|
984 | |||
985 | - tb_offset: the number of frames to skip over in the stack, on a |
|
985 | - tb_offset: the number of frames to skip over in the stack, on a | |
986 | per-call basis (this overrides temporarily the instance's tb_offset |
|
986 | per-call basis (this overrides temporarily the instance's tb_offset | |
987 | given at initialization time. """ |
|
987 | given at initialization time. """ | |
988 |
|
988 | |||
989 | if out is None: |
|
989 | if out is None: | |
990 | out = Term.cerr |
|
990 | out = Term.cerr | |
991 | Term.cout.flush() |
|
991 | Term.cout.flush() | |
992 | if tb_offset is not None: |
|
992 | if tb_offset is not None: | |
993 | tb_offset, self.tb_offset = self.tb_offset, tb_offset |
|
993 | tb_offset, self.tb_offset = self.tb_offset, tb_offset | |
994 | print >> out, self.text(etype, evalue, etb) |
|
994 | print >> out, self.text(etype, evalue, etb) | |
995 | self.tb_offset = tb_offset |
|
995 | self.tb_offset = tb_offset | |
996 | else: |
|
996 | else: | |
997 | print >> out, self.text(etype, evalue, etb) |
|
997 | print >> out, self.text(etype, evalue, etb) | |
998 | out.flush() |
|
998 | out.flush() | |
999 | try: |
|
999 | try: | |
1000 | self.debugger() |
|
1000 | self.debugger() | |
1001 | except KeyboardInterrupt: |
|
1001 | except KeyboardInterrupt: | |
1002 | print "\nKeyboardInterrupt" |
|
1002 | print "\nKeyboardInterrupt" | |
1003 |
|
1003 | |||
1004 | def text(self,etype=None,value=None,tb=None,context=5,mode=None): |
|
1004 | def text(self,etype=None,value=None,tb=None,context=5,mode=None): | |
1005 | if etype is None: |
|
1005 | if etype is None: | |
1006 | etype,value,tb = sys.exc_info() |
|
1006 | etype,value,tb = sys.exc_info() | |
1007 | self.tb = tb |
|
1007 | self.tb = tb | |
1008 | return FormattedTB.text(self,etype,value,tb,context=5,mode=mode) |
|
1008 | return FormattedTB.text(self,etype,value,tb,context=5,mode=mode) | |
1009 |
|
1009 | |||
1010 | #--------------------------------------------------------------------------- |
|
1010 | #--------------------------------------------------------------------------- | |
1011 | # A simple class to preserve Nathan's original functionality. |
|
1011 | # A simple class to preserve Nathan's original functionality. | |
1012 | class ColorTB(FormattedTB): |
|
1012 | class ColorTB(FormattedTB): | |
1013 | """Shorthand to initialize a FormattedTB in Linux colors mode.""" |
|
1013 | """Shorthand to initialize a FormattedTB in Linux colors mode.""" | |
1014 | def __init__(self,color_scheme='Linux',call_pdb=0): |
|
1014 | def __init__(self,color_scheme='Linux',call_pdb=0): | |
1015 | FormattedTB.__init__(self,color_scheme=color_scheme, |
|
1015 | FormattedTB.__init__(self,color_scheme=color_scheme, | |
1016 | call_pdb=call_pdb) |
|
1016 | call_pdb=call_pdb) | |
1017 |
|
1017 | |||
1018 | #---------------------------------------------------------------------------- |
|
1018 | #---------------------------------------------------------------------------- | |
1019 | # module testing (minimal) |
|
1019 | # module testing (minimal) | |
1020 | if __name__ == "__main__": |
|
1020 | if __name__ == "__main__": | |
1021 | def spam(c, (d, e)): |
|
1021 | def spam(c, (d, e)): | |
1022 | x = c + d |
|
1022 | x = c + d | |
1023 | y = c * d |
|
1023 | y = c * d | |
1024 | foo(x, y) |
|
1024 | foo(x, y) | |
1025 |
|
1025 | |||
1026 | def foo(a, b, bar=1): |
|
1026 | def foo(a, b, bar=1): | |
1027 | eggs(a, b + bar) |
|
1027 | eggs(a, b + bar) | |
1028 |
|
1028 | |||
1029 | def eggs(f, g, z=globals()): |
|
1029 | def eggs(f, g, z=globals()): | |
1030 | h = f + g |
|
1030 | h = f + g | |
1031 | i = f - g |
|
1031 | i = f - g | |
1032 | return h / i |
|
1032 | return h / i | |
1033 |
|
1033 | |||
1034 | print '' |
|
1034 | print '' | |
1035 | print '*** Before ***' |
|
1035 | print '*** Before ***' | |
1036 | try: |
|
1036 | try: | |
1037 | print spam(1, (2, 3)) |
|
1037 | print spam(1, (2, 3)) | |
1038 | except: |
|
1038 | except: | |
1039 | traceback.print_exc() |
|
1039 | traceback.print_exc() | |
1040 | print '' |
|
1040 | print '' | |
1041 |
|
1041 | |||
1042 | handler = ColorTB() |
|
1042 | handler = ColorTB() | |
1043 | print '*** ColorTB ***' |
|
1043 | print '*** ColorTB ***' | |
1044 | try: |
|
1044 | try: | |
1045 | print spam(1, (2, 3)) |
|
1045 | print spam(1, (2, 3)) | |
1046 | except: |
|
1046 | except: | |
1047 | apply(handler, sys.exc_info() ) |
|
1047 | apply(handler, sys.exc_info() ) | |
1048 | print '' |
|
1048 | print '' | |
1049 |
|
1049 | |||
1050 | handler = VerboseTB() |
|
1050 | handler = VerboseTB() | |
1051 | print '*** VerboseTB ***' |
|
1051 | print '*** VerboseTB ***' | |
1052 | try: |
|
1052 | try: | |
1053 | print spam(1, (2, 3)) |
|
1053 | print spam(1, (2, 3)) | |
1054 | except: |
|
1054 | except: | |
1055 | apply(handler, sys.exc_info() ) |
|
1055 | apply(handler, sys.exc_info() ) | |
1056 | print '' |
|
1056 | print '' | |
1057 |
|
1057 |
@@ -1,177 +1,177 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """Tools for coloring text in ANSI terminals. |
|
2 | """Tools for coloring text in ANSI terminals. | |
3 | """ |
|
3 | """ | |
4 |
|
4 | |||
5 | #***************************************************************************** |
|
5 | #***************************************************************************** | |
6 | # Copyright (C) 2002-2006 Fernando Perez. <fperez@colorado.edu> |
|
6 | # Copyright (C) 2002-2006 Fernando Perez. <fperez@colorado.edu> | |
7 | # |
|
7 | # | |
8 | # Distributed under the terms of the BSD License. The full license is in |
|
8 | # Distributed under the terms of the BSD License. The full license is in | |
9 | # the file COPYING, distributed as part of this software. |
|
9 | # the file COPYING, distributed as part of this software. | |
10 | #***************************************************************************** |
|
10 | #***************************************************************************** | |
11 |
|
11 | |||
12 | __all__ = ['TermColors','InputTermColors','ColorScheme','ColorSchemeTable'] |
|
12 | __all__ = ['TermColors','InputTermColors','ColorScheme','ColorSchemeTable'] | |
13 |
|
13 | |||
14 | import os |
|
14 | import os | |
15 |
|
15 | |||
16 | from IPython.ipstruct import Struct |
|
16 | from IPython.utils.ipstruct import Struct | |
17 |
|
17 | |||
18 | def make_color_table(in_class): |
|
18 | def make_color_table(in_class): | |
19 | """Build a set of color attributes in a class. |
|
19 | """Build a set of color attributes in a class. | |
20 |
|
20 | |||
21 | Helper function for building the *TermColors classes.""" |
|
21 | Helper function for building the *TermColors classes.""" | |
22 |
|
22 | |||
23 | color_templates = ( |
|
23 | color_templates = ( | |
24 | # Dark colors |
|
24 | # Dark colors | |
25 | ("Black" , "0;30"), |
|
25 | ("Black" , "0;30"), | |
26 | ("Red" , "0;31"), |
|
26 | ("Red" , "0;31"), | |
27 | ("Green" , "0;32"), |
|
27 | ("Green" , "0;32"), | |
28 | ("Brown" , "0;33"), |
|
28 | ("Brown" , "0;33"), | |
29 | ("Blue" , "0;34"), |
|
29 | ("Blue" , "0;34"), | |
30 | ("Purple" , "0;35"), |
|
30 | ("Purple" , "0;35"), | |
31 | ("Cyan" , "0;36"), |
|
31 | ("Cyan" , "0;36"), | |
32 | ("LightGray" , "0;37"), |
|
32 | ("LightGray" , "0;37"), | |
33 | # Light colors |
|
33 | # Light colors | |
34 | ("DarkGray" , "1;30"), |
|
34 | ("DarkGray" , "1;30"), | |
35 | ("LightRed" , "1;31"), |
|
35 | ("LightRed" , "1;31"), | |
36 | ("LightGreen" , "1;32"), |
|
36 | ("LightGreen" , "1;32"), | |
37 | ("Yellow" , "1;33"), |
|
37 | ("Yellow" , "1;33"), | |
38 | ("LightBlue" , "1;34"), |
|
38 | ("LightBlue" , "1;34"), | |
39 | ("LightPurple" , "1;35"), |
|
39 | ("LightPurple" , "1;35"), | |
40 | ("LightCyan" , "1;36"), |
|
40 | ("LightCyan" , "1;36"), | |
41 | ("White" , "1;37"), |
|
41 | ("White" , "1;37"), | |
42 | # Blinking colors. Probably should not be used in anything serious. |
|
42 | # Blinking colors. Probably should not be used in anything serious. | |
43 | ("BlinkBlack" , "5;30"), |
|
43 | ("BlinkBlack" , "5;30"), | |
44 | ("BlinkRed" , "5;31"), |
|
44 | ("BlinkRed" , "5;31"), | |
45 | ("BlinkGreen" , "5;32"), |
|
45 | ("BlinkGreen" , "5;32"), | |
46 | ("BlinkYellow" , "5;33"), |
|
46 | ("BlinkYellow" , "5;33"), | |
47 | ("BlinkBlue" , "5;34"), |
|
47 | ("BlinkBlue" , "5;34"), | |
48 | ("BlinkPurple" , "5;35"), |
|
48 | ("BlinkPurple" , "5;35"), | |
49 | ("BlinkCyan" , "5;36"), |
|
49 | ("BlinkCyan" , "5;36"), | |
50 | ("BlinkLightGray", "5;37"), |
|
50 | ("BlinkLightGray", "5;37"), | |
51 | ) |
|
51 | ) | |
52 |
|
52 | |||
53 | for name,value in color_templates: |
|
53 | for name,value in color_templates: | |
54 | setattr(in_class,name,in_class._base % value) |
|
54 | setattr(in_class,name,in_class._base % value) | |
55 |
|
55 | |||
56 | class TermColors: |
|
56 | class TermColors: | |
57 | """Color escape sequences. |
|
57 | """Color escape sequences. | |
58 |
|
58 | |||
59 | This class defines the escape sequences for all the standard (ANSI?) |
|
59 | This class defines the escape sequences for all the standard (ANSI?) | |
60 | colors in terminals. Also defines a NoColor escape which is just the null |
|
60 | colors in terminals. Also defines a NoColor escape which is just the null | |
61 | string, suitable for defining 'dummy' color schemes in terminals which get |
|
61 | string, suitable for defining 'dummy' color schemes in terminals which get | |
62 | confused by color escapes. |
|
62 | confused by color escapes. | |
63 |
|
63 | |||
64 | This class should be used as a mixin for building color schemes.""" |
|
64 | This class should be used as a mixin for building color schemes.""" | |
65 |
|
65 | |||
66 | NoColor = '' # for color schemes in color-less terminals. |
|
66 | NoColor = '' # for color schemes in color-less terminals. | |
67 | Normal = '\033[0m' # Reset normal coloring |
|
67 | Normal = '\033[0m' # Reset normal coloring | |
68 | _base = '\033[%sm' # Template for all other colors |
|
68 | _base = '\033[%sm' # Template for all other colors | |
69 |
|
69 | |||
70 | # Build the actual color table as a set of class attributes: |
|
70 | # Build the actual color table as a set of class attributes: | |
71 | make_color_table(TermColors) |
|
71 | make_color_table(TermColors) | |
72 |
|
72 | |||
73 | class InputTermColors: |
|
73 | class InputTermColors: | |
74 | """Color escape sequences for input prompts. |
|
74 | """Color escape sequences for input prompts. | |
75 |
|
75 | |||
76 | This class is similar to TermColors, but the escapes are wrapped in \001 |
|
76 | This class is similar to TermColors, but the escapes are wrapped in \001 | |
77 | and \002 so that readline can properly know the length of each line and |
|
77 | and \002 so that readline can properly know the length of each line and | |
78 | can wrap lines accordingly. Use this class for any colored text which |
|
78 | can wrap lines accordingly. Use this class for any colored text which | |
79 | needs to be used in input prompts, such as in calls to raw_input(). |
|
79 | needs to be used in input prompts, such as in calls to raw_input(). | |
80 |
|
80 | |||
81 | This class defines the escape sequences for all the standard (ANSI?) |
|
81 | This class defines the escape sequences for all the standard (ANSI?) | |
82 | colors in terminals. Also defines a NoColor escape which is just the null |
|
82 | colors in terminals. Also defines a NoColor escape which is just the null | |
83 | string, suitable for defining 'dummy' color schemes in terminals which get |
|
83 | string, suitable for defining 'dummy' color schemes in terminals which get | |
84 | confused by color escapes. |
|
84 | confused by color escapes. | |
85 |
|
85 | |||
86 | This class should be used as a mixin for building color schemes.""" |
|
86 | This class should be used as a mixin for building color schemes.""" | |
87 |
|
87 | |||
88 | NoColor = '' # for color schemes in color-less terminals. |
|
88 | NoColor = '' # for color schemes in color-less terminals. | |
89 |
|
89 | |||
90 | if os.name == 'nt' and os.environ.get('TERM','dumb') == 'emacs': |
|
90 | if os.name == 'nt' and os.environ.get('TERM','dumb') == 'emacs': | |
91 | # (X)emacs on W32 gets confused with \001 and \002 so we remove them |
|
91 | # (X)emacs on W32 gets confused with \001 and \002 so we remove them | |
92 | Normal = '\033[0m' # Reset normal coloring |
|
92 | Normal = '\033[0m' # Reset normal coloring | |
93 | _base = '\033[%sm' # Template for all other colors |
|
93 | _base = '\033[%sm' # Template for all other colors | |
94 | else: |
|
94 | else: | |
95 | Normal = '\001\033[0m\002' # Reset normal coloring |
|
95 | Normal = '\001\033[0m\002' # Reset normal coloring | |
96 | _base = '\001\033[%sm\002' # Template for all other colors |
|
96 | _base = '\001\033[%sm\002' # Template for all other colors | |
97 |
|
97 | |||
98 | # Build the actual color table as a set of class attributes: |
|
98 | # Build the actual color table as a set of class attributes: | |
99 | make_color_table(InputTermColors) |
|
99 | make_color_table(InputTermColors) | |
100 |
|
100 | |||
101 | class ColorScheme: |
|
101 | class ColorScheme: | |
102 | """Generic color scheme class. Just a name and a Struct.""" |
|
102 | """Generic color scheme class. Just a name and a Struct.""" | |
103 | def __init__(self,__scheme_name_,colordict=None,**colormap): |
|
103 | def __init__(self,__scheme_name_,colordict=None,**colormap): | |
104 | self.name = __scheme_name_ |
|
104 | self.name = __scheme_name_ | |
105 | if colordict is None: |
|
105 | if colordict is None: | |
106 | self.colors = Struct(**colormap) |
|
106 | self.colors = Struct(**colormap) | |
107 | else: |
|
107 | else: | |
108 | self.colors = Struct(colordict) |
|
108 | self.colors = Struct(colordict) | |
109 |
|
109 | |||
110 | def copy(self,name=None): |
|
110 | def copy(self,name=None): | |
111 | """Return a full copy of the object, optionally renaming it.""" |
|
111 | """Return a full copy of the object, optionally renaming it.""" | |
112 | if name is None: |
|
112 | if name is None: | |
113 | name = self.name |
|
113 | name = self.name | |
114 | return ColorScheme(name,self.colors.__dict__) |
|
114 | return ColorScheme(name,self.colors.__dict__) | |
115 |
|
115 | |||
116 | class ColorSchemeTable(dict): |
|
116 | class ColorSchemeTable(dict): | |
117 | """General class to handle tables of color schemes. |
|
117 | """General class to handle tables of color schemes. | |
118 |
|
118 | |||
119 | It's basically a dict of color schemes with a couple of shorthand |
|
119 | It's basically a dict of color schemes with a couple of shorthand | |
120 | attributes and some convenient methods. |
|
120 | attributes and some convenient methods. | |
121 |
|
121 | |||
122 | active_scheme_name -> obvious |
|
122 | active_scheme_name -> obvious | |
123 | active_colors -> actual color table of the active scheme""" |
|
123 | active_colors -> actual color table of the active scheme""" | |
124 |
|
124 | |||
125 | def __init__(self,scheme_list=None,default_scheme=''): |
|
125 | def __init__(self,scheme_list=None,default_scheme=''): | |
126 | """Create a table of color schemes. |
|
126 | """Create a table of color schemes. | |
127 |
|
127 | |||
128 | The table can be created empty and manually filled or it can be |
|
128 | The table can be created empty and manually filled or it can be | |
129 | created with a list of valid color schemes AND the specification for |
|
129 | created with a list of valid color schemes AND the specification for | |
130 | the default active scheme. |
|
130 | the default active scheme. | |
131 | """ |
|
131 | """ | |
132 |
|
132 | |||
133 | # create object attributes to be set later |
|
133 | # create object attributes to be set later | |
134 | self.active_scheme_name = '' |
|
134 | self.active_scheme_name = '' | |
135 | self.active_colors = None |
|
135 | self.active_colors = None | |
136 |
|
136 | |||
137 | if scheme_list: |
|
137 | if scheme_list: | |
138 | if default_scheme == '': |
|
138 | if default_scheme == '': | |
139 | raise ValueError,'you must specify the default color scheme' |
|
139 | raise ValueError,'you must specify the default color scheme' | |
140 | for scheme in scheme_list: |
|
140 | for scheme in scheme_list: | |
141 | self.add_scheme(scheme) |
|
141 | self.add_scheme(scheme) | |
142 | self.set_active_scheme(default_scheme) |
|
142 | self.set_active_scheme(default_scheme) | |
143 |
|
143 | |||
144 | def copy(self): |
|
144 | def copy(self): | |
145 | """Return full copy of object""" |
|
145 | """Return full copy of object""" | |
146 | return ColorSchemeTable(self.values(),self.active_scheme_name) |
|
146 | return ColorSchemeTable(self.values(),self.active_scheme_name) | |
147 |
|
147 | |||
148 | def add_scheme(self,new_scheme): |
|
148 | def add_scheme(self,new_scheme): | |
149 | """Add a new color scheme to the table.""" |
|
149 | """Add a new color scheme to the table.""" | |
150 | if not isinstance(new_scheme,ColorScheme): |
|
150 | if not isinstance(new_scheme,ColorScheme): | |
151 | raise ValueError,'ColorSchemeTable only accepts ColorScheme instances' |
|
151 | raise ValueError,'ColorSchemeTable only accepts ColorScheme instances' | |
152 | self[new_scheme.name] = new_scheme |
|
152 | self[new_scheme.name] = new_scheme | |
153 |
|
153 | |||
154 | def set_active_scheme(self,scheme,case_sensitive=0): |
|
154 | def set_active_scheme(self,scheme,case_sensitive=0): | |
155 | """Set the currently active scheme. |
|
155 | """Set the currently active scheme. | |
156 |
|
156 | |||
157 | Names are by default compared in a case-insensitive way, but this can |
|
157 | Names are by default compared in a case-insensitive way, but this can | |
158 | be changed by setting the parameter case_sensitive to true.""" |
|
158 | be changed by setting the parameter case_sensitive to true.""" | |
159 |
|
159 | |||
160 | scheme_names = self.keys() |
|
160 | scheme_names = self.keys() | |
161 | if case_sensitive: |
|
161 | if case_sensitive: | |
162 | valid_schemes = scheme_names |
|
162 | valid_schemes = scheme_names | |
163 | scheme_test = scheme |
|
163 | scheme_test = scheme | |
164 | else: |
|
164 | else: | |
165 | valid_schemes = [s.lower() for s in scheme_names] |
|
165 | valid_schemes = [s.lower() for s in scheme_names] | |
166 | scheme_test = scheme.lower() |
|
166 | scheme_test = scheme.lower() | |
167 | try: |
|
167 | try: | |
168 | scheme_idx = valid_schemes.index(scheme_test) |
|
168 | scheme_idx = valid_schemes.index(scheme_test) | |
169 | except ValueError: |
|
169 | except ValueError: | |
170 | raise ValueError,'Unrecognized color scheme: ' + scheme + \ |
|
170 | raise ValueError,'Unrecognized color scheme: ' + scheme + \ | |
171 | '\nValid schemes: '+str(scheme_names).replace("'', ",'') |
|
171 | '\nValid schemes: '+str(scheme_names).replace("'', ",'') | |
172 | else: |
|
172 | else: | |
173 | active = scheme_names[scheme_idx] |
|
173 | active = scheme_names[scheme_idx] | |
174 | self.active_scheme_name = active |
|
174 | self.active_scheme_name = active | |
175 | self.active_colors = self[active].colors |
|
175 | self.active_colors = self[active].colors | |
176 | # Now allow using '' as an index for the current active scheme |
|
176 | # Now allow using '' as an index for the current active scheme | |
177 | self[''] = self[active] |
|
177 | self[''] = self[active] |
1 | NO CONTENT: file renamed from IPython/ipstruct.py to IPython/utils/ipstruct.py |
|
NO CONTENT: file renamed from IPython/ipstruct.py to IPython/utils/ipstruct.py |
@@ -1,17 +1,19 b'' | |||||
1 | #!/usr/bin/env python |
|
1 | #!/usr/bin/env python | |
2 | # encoding: utf-8 |
|
2 | # encoding: utf-8 | |
3 |
|
3 | |||
4 | def test_import_coloransi(): |
|
4 | def test_import_coloransi(): | |
5 | from IPython.utils import coloransi |
|
5 | from IPython.utils import coloransi | |
6 |
|
6 | |||
7 | def test_import_DPyGetOpt(): |
|
7 | def test_import_DPyGetOpt(): | |
8 | from IPython.utils import DPyGetOpt |
|
8 | from IPython.utils import DPyGetOpt | |
9 |
|
9 | |||
10 | def test_import_generics(): |
|
10 | def test_import_generics(): | |
11 | from IPython.utils import generics |
|
11 | from IPython.utils import generics | |
12 |
|
12 | |||
13 | def test_import_genutils(): |
|
13 | def test_import_genutils(): | |
14 | from IPython.utils import genutils |
|
14 | from IPython.utils import genutils | |
15 |
|
15 | |||
|
16 | def test_import_ipstruct(): | |||
|
17 | from IPython.utils import ipstruct | |||
16 |
|
18 | |||
17 |
|
19 |
General Comments 0
You need to be logged in to leave comments.
Login now