Show More
@@ -1,182 +1,183 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """ |
|
3 | 3 | %store magic for lightweight persistence. |
|
4 | 4 | |
|
5 | 5 | Stores variables, aliases etc. in PickleShare database. |
|
6 | 6 | |
|
7 | 7 | $Id: iplib.py 1107 2006-01-30 19:02:20Z vivainio $ |
|
8 | 8 | """ |
|
9 | 9 | |
|
10 | 10 | import IPython.ipapi |
|
11 | 11 | ip = IPython.ipapi.get() |
|
12 | 12 | |
|
13 | 13 | import pickleshare |
|
14 | 14 | |
|
15 | 15 | import inspect,pickle,os,sys,textwrap |
|
16 | 16 | from IPython.FakeModule import FakeModule |
|
17 | 17 | |
|
18 | 18 | def restore_aliases(self): |
|
19 | 19 | ip = self.getapi() |
|
20 | 20 | staliases = ip.db.get('stored_aliases', {}) |
|
21 | 21 | for k,v in staliases.items(): |
|
22 | 22 | #print "restore alias",k,v # dbg |
|
23 | self.alias_table[k] = v | |
|
23 | #self.alias_table[k] = v | |
|
24 | ip.defalias(k,v) | |
|
24 | 25 | |
|
25 | 26 | |
|
26 | 27 | def refresh_variables(ip): |
|
27 | 28 | db = ip.db |
|
28 | 29 | for key in db.keys('autorestore/*'): |
|
29 | 30 | # strip autorestore |
|
30 | 31 | justkey = os.path.basename(key) |
|
31 | 32 | try: |
|
32 | 33 | obj = db[key] |
|
33 | 34 | except KeyError: |
|
34 | 35 | print "Unable to restore variable '%s', ignoring (use %%store -d to forget!)" % justkey |
|
35 | 36 | print "The error was:",sys.exc_info()[0] |
|
36 | 37 | else: |
|
37 | 38 | #print "restored",justkey,"=",obj #dbg |
|
38 | 39 | ip.user_ns[justkey] = obj |
|
39 | 40 | |
|
40 | 41 | |
|
41 | 42 | def restore_dhist(ip): |
|
42 | 43 | db = ip.db |
|
43 | 44 | ip.user_ns['_dh'] = db.get('dhist',[]) |
|
44 | 45 | |
|
45 | 46 | def restore_data(self): |
|
46 | 47 | ip = self.getapi() |
|
47 | 48 | refresh_variables(ip) |
|
48 | 49 | restore_aliases(self) |
|
49 | 50 | restore_dhist(self) |
|
50 | 51 | raise IPython.ipapi.TryNext |
|
51 | 52 | |
|
52 | 53 | ip.set_hook('late_startup_hook', restore_data) |
|
53 | 54 | |
|
54 | 55 | def magic_store(self, parameter_s=''): |
|
55 | 56 | """Lightweight persistence for python variables. |
|
56 | 57 | |
|
57 | 58 | Example: |
|
58 | 59 | |
|
59 | 60 | ville@badger[~]|1> A = ['hello',10,'world']\\ |
|
60 | 61 | ville@badger[~]|2> %store A\\ |
|
61 | 62 | ville@badger[~]|3> Exit |
|
62 | 63 | |
|
63 | 64 | (IPython session is closed and started again...) |
|
64 | 65 | |
|
65 | 66 | ville@badger:~$ ipython -p pysh\\ |
|
66 | 67 | ville@badger[~]|1> print A |
|
67 | 68 | |
|
68 | 69 | ['hello', 10, 'world'] |
|
69 | 70 | |
|
70 | 71 | Usage: |
|
71 | 72 | |
|
72 | 73 | %store - Show list of all variables and their current values\\ |
|
73 | 74 | %store <var> - Store the *current* value of the variable to disk\\ |
|
74 | 75 | %store -d <var> - Remove the variable and its value from storage\\ |
|
75 | 76 | %store -z - Remove all variables from storage\\ |
|
76 | 77 | %store -r - Refresh all variables from store (delete current vals)\\ |
|
77 | 78 | %store foo >a.txt - Store value of foo to new file a.txt\\ |
|
78 | 79 | %store foo >>a.txt - Append value of foo to file a.txt\\ |
|
79 | 80 | |
|
80 | 81 | It should be noted that if you change the value of a variable, you |
|
81 | 82 | need to %store it again if you want to persist the new value. |
|
82 | 83 | |
|
83 | 84 | Note also that the variables will need to be pickleable; most basic |
|
84 | 85 | python types can be safely %stored. |
|
85 | 86 | |
|
86 | 87 | Also aliases can be %store'd across sessions. |
|
87 | 88 | """ |
|
88 | 89 | |
|
89 | 90 | opts,argsl = self.parse_options(parameter_s,'drz',mode='string') |
|
90 | 91 | args = argsl.split(None,1) |
|
91 | 92 | ip = self.getapi() |
|
92 | 93 | db = ip.db |
|
93 | 94 | # delete |
|
94 | 95 | if opts.has_key('d'): |
|
95 | 96 | try: |
|
96 | 97 | todel = args[0] |
|
97 | 98 | except IndexError: |
|
98 | 99 | error('You must provide the variable to forget') |
|
99 | 100 | else: |
|
100 | 101 | try: |
|
101 | 102 | del db['autorestore/' + todel] |
|
102 | 103 | except: |
|
103 | 104 | error("Can't delete variable '%s'" % todel) |
|
104 | 105 | # reset |
|
105 | 106 | elif opts.has_key('z'): |
|
106 | 107 | for k in db.keys('autorestore/*'): |
|
107 | 108 | del db[k] |
|
108 | 109 | |
|
109 | 110 | elif opts.has_key('r'): |
|
110 | 111 | refresh_variables(ip) |
|
111 | 112 | |
|
112 | 113 | |
|
113 | 114 | # run without arguments -> list variables & values |
|
114 | 115 | elif not args: |
|
115 | 116 | vars = self.db.keys('autorestore/*') |
|
116 | 117 | vars.sort() |
|
117 | 118 | if vars: |
|
118 | 119 | size = max(map(len,vars)) |
|
119 | 120 | else: |
|
120 | 121 | size = 0 |
|
121 | 122 | |
|
122 | 123 | print 'Stored variables and their in-db values:' |
|
123 | 124 | fmt = '%-'+str(size)+'s -> %s' |
|
124 | 125 | get = db.get |
|
125 | 126 | for var in vars: |
|
126 | 127 | justkey = os.path.basename(var) |
|
127 | 128 | # print 30 first characters from every var |
|
128 | 129 | print fmt % (justkey,repr(get(var,'<unavailable>'))[:50]) |
|
129 | 130 | |
|
130 | 131 | # default action - store the variable |
|
131 | 132 | else: |
|
132 | 133 | # %store foo >file.txt or >>file.txt |
|
133 | 134 | if len(args) > 1 and args[1].startswith('>'): |
|
134 | 135 | fnam = os.path.expanduser(args[1].lstrip('>').lstrip()) |
|
135 | 136 | if args[1].startswith('>>'): |
|
136 | 137 | fil = open(fnam,'a') |
|
137 | 138 | else: |
|
138 | 139 | fil = open(fnam,'w') |
|
139 | 140 | obj = ip.ev(args[0]) |
|
140 | 141 | print "Writing '%s' (%s) to file '%s'." % (args[0], |
|
141 | 142 | obj.__class__.__name__, fnam) |
|
142 | 143 | |
|
143 | 144 | |
|
144 | 145 | if not isinstance (obj,basestring): |
|
145 | 146 | from pprint import pprint |
|
146 | 147 | pprint(obj,fil) |
|
147 | 148 | else: |
|
148 | 149 | fil.write(obj) |
|
149 | 150 | if not obj.endswith('\n'): |
|
150 | 151 | fil.write('\n') |
|
151 | 152 | |
|
152 | 153 | fil.close() |
|
153 | 154 | return |
|
154 | 155 | |
|
155 | 156 | # %store foo |
|
156 | 157 | try: |
|
157 | 158 | obj = ip.user_ns[args[0]] |
|
158 | 159 | except KeyError: |
|
159 | 160 | # it might be an alias |
|
160 | 161 | if args[0] in self.alias_table: |
|
161 | 162 | staliases = db.get('stored_aliases',{}) |
|
162 | 163 | staliases[ args[0] ] = self.alias_table[ args[0] ] |
|
163 | 164 | db['stored_aliases'] = staliases |
|
164 | 165 | print "Alias stored:", args[0], self.alias_table[ args[0] ] |
|
165 | 166 | return |
|
166 | 167 | else: |
|
167 | 168 | print "Error: unknown variable '%s'" % args[0] |
|
168 | 169 | |
|
169 | 170 | else: |
|
170 | 171 | if isinstance(inspect.getmodule(obj), FakeModule): |
|
171 | 172 | print textwrap.dedent("""\ |
|
172 | 173 | Warning:%s is %s |
|
173 | 174 | Proper storage of interactively declared classes (or instances |
|
174 | 175 | of those classes) is not possible! Only instances |
|
175 | 176 | of classes in real modules on file system can be %%store'd. |
|
176 | 177 | """ % (args[0], obj) ) |
|
177 | 178 | return |
|
178 | 179 | #pickled = pickle.dumps(obj) |
|
179 | 180 | self.db[ 'autorestore/' + args[0] ] = obj |
|
180 | 181 | print "Stored '%s' (%s)" % (args[0], obj.__class__.__name__) |
|
181 | 182 | |
|
182 | 183 | ip.expose_magic('store',magic_store) |
@@ -1,3002 +1,3006 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """Magic functions for InteractiveShell. |
|
3 | 3 | |
|
4 |
$Id: Magic.py 26 |
|
|
4 | $Id: Magic.py 2637 2007-08-17 16:18:05Z vivainio $""" | |
|
5 | 5 | |
|
6 | 6 | #***************************************************************************** |
|
7 | 7 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and |
|
8 | 8 | # Copyright (C) 2001-2006 Fernando Perez <fperez@colorado.edu> |
|
9 | 9 | # |
|
10 | 10 | # Distributed under the terms of the BSD License. The full license is in |
|
11 | 11 | # the file COPYING, distributed as part of this software. |
|
12 | 12 | #***************************************************************************** |
|
13 | 13 | |
|
14 | 14 | #**************************************************************************** |
|
15 | 15 | # Modules and globals |
|
16 | 16 | |
|
17 | 17 | from IPython import Release |
|
18 | 18 | __author__ = '%s <%s>\n%s <%s>' % \ |
|
19 | 19 | ( Release.authors['Janko'] + Release.authors['Fernando'] ) |
|
20 | 20 | __license__ = Release.license |
|
21 | 21 | |
|
22 | 22 | # Python standard modules |
|
23 | 23 | import __builtin__ |
|
24 | 24 | import bdb |
|
25 | 25 | import inspect |
|
26 | 26 | import os |
|
27 | 27 | import pdb |
|
28 | 28 | import pydoc |
|
29 | 29 | import sys |
|
30 | 30 | import re |
|
31 | 31 | import tempfile |
|
32 | 32 | import time |
|
33 | 33 | import cPickle as pickle |
|
34 | 34 | import textwrap |
|
35 | 35 | from cStringIO import StringIO |
|
36 | 36 | from getopt import getopt,GetoptError |
|
37 | 37 | from pprint import pprint, pformat |
|
38 | 38 | from sets import Set |
|
39 | 39 | |
|
40 | 40 | # cProfile was added in Python2.5 |
|
41 | 41 | try: |
|
42 | 42 | import cProfile as profile |
|
43 | 43 | import pstats |
|
44 | 44 | except ImportError: |
|
45 | 45 | # profile isn't bundled by default in Debian for license reasons |
|
46 | 46 | try: |
|
47 | 47 | import profile,pstats |
|
48 | 48 | except ImportError: |
|
49 | 49 | profile = pstats = None |
|
50 | 50 | |
|
51 | 51 | # Homebrewed |
|
52 | 52 | import IPython |
|
53 | 53 | from IPython import Debugger, OInspect, wildcard |
|
54 | 54 | from IPython.FakeModule import FakeModule |
|
55 | 55 | from IPython.Itpl import Itpl, itpl, printpl,itplns |
|
56 | 56 | from IPython.PyColorize import Parser |
|
57 | 57 | from IPython.ipstruct import Struct |
|
58 | 58 | from IPython.macro import Macro |
|
59 | 59 | from IPython.genutils import * |
|
60 | 60 | from IPython import platutils |
|
61 | 61 | import IPython.generics |
|
62 | 62 | import IPython.ipapi |
|
63 | 63 | |
|
64 | 64 | #*************************************************************************** |
|
65 | 65 | # Utility functions |
|
66 | 66 | def on_off(tag): |
|
67 | 67 | """Return an ON/OFF string for a 1/0 input. Simple utility function.""" |
|
68 | 68 | return ['OFF','ON'][tag] |
|
69 | 69 | |
|
70 | 70 | class Bunch: pass |
|
71 | 71 | |
|
72 | 72 | def compress_dhist(dh): |
|
73 | 73 | head, tail = dh[:-10], dh[-10:] |
|
74 | 74 | |
|
75 | 75 | newhead = [] |
|
76 | 76 | done = Set() |
|
77 | 77 | for h in head: |
|
78 | 78 | if h in done: |
|
79 | 79 | continue |
|
80 | 80 | newhead.append(h) |
|
81 | 81 | done.add(h) |
|
82 | 82 | |
|
83 | 83 | return newhead + tail |
|
84 | 84 | |
|
85 | 85 | |
|
86 | 86 | #*************************************************************************** |
|
87 | 87 | # Main class implementing Magic functionality |
|
88 | 88 | class Magic: |
|
89 | 89 | """Magic functions for InteractiveShell. |
|
90 | 90 | |
|
91 | 91 | Shell functions which can be reached as %function_name. All magic |
|
92 | 92 | functions should accept a string, which they can parse for their own |
|
93 | 93 | needs. This can make some functions easier to type, eg `%cd ../` |
|
94 | 94 | vs. `%cd("../")` |
|
95 | 95 | |
|
96 | 96 | ALL definitions MUST begin with the prefix magic_. The user won't need it |
|
97 | 97 | at the command line, but it is is needed in the definition. """ |
|
98 | 98 | |
|
99 | 99 | # class globals |
|
100 | 100 | auto_status = ['Automagic is OFF, % prefix IS needed for magic functions.', |
|
101 | 101 | 'Automagic is ON, % prefix NOT needed for magic functions.'] |
|
102 | 102 | |
|
103 | 103 | #...................................................................... |
|
104 | 104 | # some utility functions |
|
105 | 105 | |
|
106 | 106 | def __init__(self,shell): |
|
107 | 107 | |
|
108 | 108 | self.options_table = {} |
|
109 | 109 | if profile is None: |
|
110 | 110 | self.magic_prun = self.profile_missing_notice |
|
111 | 111 | self.shell = shell |
|
112 | 112 | |
|
113 | 113 | # namespace for holding state we may need |
|
114 | 114 | self._magic_state = Bunch() |
|
115 | 115 | |
|
116 | 116 | def profile_missing_notice(self, *args, **kwargs): |
|
117 | 117 | error("""\ |
|
118 | 118 | The profile module could not be found. If you are a Debian user, |
|
119 | 119 | it has been removed from the standard Debian package because of its non-free |
|
120 | 120 | license. To use profiling, please install"python2.3-profiler" from non-free.""") |
|
121 | 121 | |
|
122 | 122 | def default_option(self,fn,optstr): |
|
123 | 123 | """Make an entry in the options_table for fn, with value optstr""" |
|
124 | 124 | |
|
125 | 125 | if fn not in self.lsmagic(): |
|
126 | 126 | error("%s is not a magic function" % fn) |
|
127 | 127 | self.options_table[fn] = optstr |
|
128 | 128 | |
|
129 | 129 | def lsmagic(self): |
|
130 | 130 | """Return a list of currently available magic functions. |
|
131 | 131 | |
|
132 | 132 | Gives a list of the bare names after mangling (['ls','cd', ...], not |
|
133 | 133 | ['magic_ls','magic_cd',...]""" |
|
134 | 134 | |
|
135 | 135 | # FIXME. This needs a cleanup, in the way the magics list is built. |
|
136 | 136 | |
|
137 | 137 | # magics in class definition |
|
138 | 138 | class_magic = lambda fn: fn.startswith('magic_') and \ |
|
139 | 139 | callable(Magic.__dict__[fn]) |
|
140 | 140 | # in instance namespace (run-time user additions) |
|
141 | 141 | inst_magic = lambda fn: fn.startswith('magic_') and \ |
|
142 | 142 | callable(self.__dict__[fn]) |
|
143 | 143 | # and bound magics by user (so they can access self): |
|
144 | 144 | inst_bound_magic = lambda fn: fn.startswith('magic_') and \ |
|
145 | 145 | callable(self.__class__.__dict__[fn]) |
|
146 | 146 | magics = filter(class_magic,Magic.__dict__.keys()) + \ |
|
147 | 147 | filter(inst_magic,self.__dict__.keys()) + \ |
|
148 | 148 | filter(inst_bound_magic,self.__class__.__dict__.keys()) |
|
149 | 149 | out = [] |
|
150 | 150 | for fn in magics: |
|
151 | 151 | out.append(fn.replace('magic_','',1)) |
|
152 | 152 | out.sort() |
|
153 | 153 | return out |
|
154 | 154 | |
|
155 | 155 | def extract_input_slices(self,slices,raw=False): |
|
156 | 156 | """Return as a string a set of input history slices. |
|
157 | 157 | |
|
158 | 158 | Inputs: |
|
159 | 159 | |
|
160 | 160 | - slices: the set of slices is given as a list of strings (like |
|
161 | 161 | ['1','4:8','9'], since this function is for use by magic functions |
|
162 | 162 | which get their arguments as strings. |
|
163 | 163 | |
|
164 | 164 | Optional inputs: |
|
165 | 165 | |
|
166 | 166 | - raw(False): by default, the processed input is used. If this is |
|
167 | 167 | true, the raw input history is used instead. |
|
168 | 168 | |
|
169 | 169 | Note that slices can be called with two notations: |
|
170 | 170 | |
|
171 | 171 | N:M -> standard python form, means including items N...(M-1). |
|
172 | 172 | |
|
173 | 173 | N-M -> include items N..M (closed endpoint).""" |
|
174 | 174 | |
|
175 | 175 | if raw: |
|
176 | 176 | hist = self.shell.input_hist_raw |
|
177 | 177 | else: |
|
178 | 178 | hist = self.shell.input_hist |
|
179 | 179 | |
|
180 | 180 | cmds = [] |
|
181 | 181 | for chunk in slices: |
|
182 | 182 | if ':' in chunk: |
|
183 | 183 | ini,fin = map(int,chunk.split(':')) |
|
184 | 184 | elif '-' in chunk: |
|
185 | 185 | ini,fin = map(int,chunk.split('-')) |
|
186 | 186 | fin += 1 |
|
187 | 187 | else: |
|
188 | 188 | ini = int(chunk) |
|
189 | 189 | fin = ini+1 |
|
190 | 190 | cmds.append(hist[ini:fin]) |
|
191 | 191 | return cmds |
|
192 | 192 | |
|
193 | 193 | def _ofind(self, oname, namespaces=None): |
|
194 | 194 | """Find an object in the available namespaces. |
|
195 | 195 | |
|
196 | 196 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic |
|
197 | 197 | |
|
198 | 198 | Has special code to detect magic functions. |
|
199 | 199 | """ |
|
200 | 200 | |
|
201 | 201 | oname = oname.strip() |
|
202 | 202 | |
|
203 | 203 | alias_ns = None |
|
204 | 204 | if namespaces is None: |
|
205 | 205 | # Namespaces to search in: |
|
206 | 206 | # Put them in a list. The order is important so that we |
|
207 | 207 | # find things in the same order that Python finds them. |
|
208 | 208 | namespaces = [ ('Interactive', self.shell.user_ns), |
|
209 | 209 | ('IPython internal', self.shell.internal_ns), |
|
210 | 210 | ('Python builtin', __builtin__.__dict__), |
|
211 | 211 | ('Alias', self.shell.alias_table), |
|
212 | 212 | ] |
|
213 | 213 | alias_ns = self.shell.alias_table |
|
214 | 214 | |
|
215 | 215 | # initialize results to 'null' |
|
216 | 216 | found = 0; obj = None; ospace = None; ds = None; |
|
217 | 217 | ismagic = 0; isalias = 0; parent = None |
|
218 | 218 | |
|
219 | 219 | # Look for the given name by splitting it in parts. If the head is |
|
220 | 220 | # found, then we look for all the remaining parts as members, and only |
|
221 | 221 | # declare success if we can find them all. |
|
222 | 222 | oname_parts = oname.split('.') |
|
223 | 223 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] |
|
224 | 224 | for nsname,ns in namespaces: |
|
225 | 225 | try: |
|
226 | 226 | obj = ns[oname_head] |
|
227 | 227 | except KeyError: |
|
228 | 228 | continue |
|
229 | 229 | else: |
|
230 | 230 | #print 'oname_rest:', oname_rest # dbg |
|
231 | 231 | for part in oname_rest: |
|
232 | 232 | try: |
|
233 | 233 | parent = obj |
|
234 | 234 | obj = getattr(obj,part) |
|
235 | 235 | except: |
|
236 | 236 | # Blanket except b/c some badly implemented objects |
|
237 | 237 | # allow __getattr__ to raise exceptions other than |
|
238 | 238 | # AttributeError, which then crashes IPython. |
|
239 | 239 | break |
|
240 | 240 | else: |
|
241 | 241 | # If we finish the for loop (no break), we got all members |
|
242 | 242 | found = 1 |
|
243 | 243 | ospace = nsname |
|
244 | 244 | if ns == alias_ns: |
|
245 | 245 | isalias = 1 |
|
246 | 246 | break # namespace loop |
|
247 | 247 | |
|
248 | 248 | # Try to see if it's magic |
|
249 | 249 | if not found: |
|
250 | 250 | if oname.startswith(self.shell.ESC_MAGIC): |
|
251 | 251 | oname = oname[1:] |
|
252 | 252 | obj = getattr(self,'magic_'+oname,None) |
|
253 | 253 | if obj is not None: |
|
254 | 254 | found = 1 |
|
255 | 255 | ospace = 'IPython internal' |
|
256 | 256 | ismagic = 1 |
|
257 | 257 | |
|
258 | 258 | # Last try: special-case some literals like '', [], {}, etc: |
|
259 | 259 | if not found and oname_head in ["''",'""','[]','{}','()']: |
|
260 | 260 | obj = eval(oname_head) |
|
261 | 261 | found = 1 |
|
262 | 262 | ospace = 'Interactive' |
|
263 | 263 | |
|
264 | 264 | return {'found':found, 'obj':obj, 'namespace':ospace, |
|
265 | 265 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} |
|
266 | 266 | |
|
267 | 267 | def arg_err(self,func): |
|
268 | 268 | """Print docstring if incorrect arguments were passed""" |
|
269 | 269 | print 'Error in arguments:' |
|
270 | 270 | print OInspect.getdoc(func) |
|
271 | 271 | |
|
272 | 272 | def format_latex(self,strng): |
|
273 | 273 | """Format a string for latex inclusion.""" |
|
274 | 274 | |
|
275 | 275 | # Characters that need to be escaped for latex: |
|
276 | 276 | escape_re = re.compile(r'(%|_|\$|#|&)',re.MULTILINE) |
|
277 | 277 | # Magic command names as headers: |
|
278 | 278 | cmd_name_re = re.compile(r'^(%s.*?):' % self.shell.ESC_MAGIC, |
|
279 | 279 | re.MULTILINE) |
|
280 | 280 | # Magic commands |
|
281 | 281 | cmd_re = re.compile(r'(?P<cmd>%s.+?\b)(?!\}\}:)' % self.shell.ESC_MAGIC, |
|
282 | 282 | re.MULTILINE) |
|
283 | 283 | # Paragraph continue |
|
284 | 284 | par_re = re.compile(r'\\$',re.MULTILINE) |
|
285 | 285 | |
|
286 | 286 | # The "\n" symbol |
|
287 | 287 | newline_re = re.compile(r'\\n') |
|
288 | 288 | |
|
289 | 289 | # Now build the string for output: |
|
290 | 290 | #strng = cmd_name_re.sub(r'\n\\texttt{\\textsl{\\large \1}}:',strng) |
|
291 | 291 | strng = cmd_name_re.sub(r'\n\\bigskip\n\\texttt{\\textbf{ \1}}:', |
|
292 | 292 | strng) |
|
293 | 293 | strng = cmd_re.sub(r'\\texttt{\g<cmd>}',strng) |
|
294 | 294 | strng = par_re.sub(r'\\\\',strng) |
|
295 | 295 | strng = escape_re.sub(r'\\\1',strng) |
|
296 | 296 | strng = newline_re.sub(r'\\textbackslash{}n',strng) |
|
297 | 297 | return strng |
|
298 | 298 | |
|
299 | 299 | def format_screen(self,strng): |
|
300 | 300 | """Format a string for screen printing. |
|
301 | 301 | |
|
302 | 302 | This removes some latex-type format codes.""" |
|
303 | 303 | # Paragraph continue |
|
304 | 304 | par_re = re.compile(r'\\$',re.MULTILINE) |
|
305 | 305 | strng = par_re.sub('',strng) |
|
306 | 306 | return strng |
|
307 | 307 | |
|
308 | 308 | def parse_options(self,arg_str,opt_str,*long_opts,**kw): |
|
309 | 309 | """Parse options passed to an argument string. |
|
310 | 310 | |
|
311 | 311 | The interface is similar to that of getopt(), but it returns back a |
|
312 | 312 | Struct with the options as keys and the stripped argument string still |
|
313 | 313 | as a string. |
|
314 | 314 | |
|
315 | 315 | arg_str is quoted as a true sys.argv vector by using shlex.split. |
|
316 | 316 | This allows us to easily expand variables, glob files, quote |
|
317 | 317 | arguments, etc. |
|
318 | 318 | |
|
319 | 319 | Options: |
|
320 | 320 | -mode: default 'string'. If given as 'list', the argument string is |
|
321 | 321 | returned as a list (split on whitespace) instead of a string. |
|
322 | 322 | |
|
323 | 323 | -list_all: put all option values in lists. Normally only options |
|
324 | 324 | appearing more than once are put in a list. |
|
325 | 325 | |
|
326 | 326 | -posix (True): whether to split the input line in POSIX mode or not, |
|
327 | 327 | as per the conventions outlined in the shlex module from the |
|
328 | 328 | standard library.""" |
|
329 | 329 | |
|
330 | 330 | # inject default options at the beginning of the input line |
|
331 | 331 | caller = sys._getframe(1).f_code.co_name.replace('magic_','') |
|
332 | 332 | arg_str = '%s %s' % (self.options_table.get(caller,''),arg_str) |
|
333 | 333 | |
|
334 | 334 | mode = kw.get('mode','string') |
|
335 | 335 | if mode not in ['string','list']: |
|
336 | 336 | raise ValueError,'incorrect mode given: %s' % mode |
|
337 | 337 | # Get options |
|
338 | 338 | list_all = kw.get('list_all',0) |
|
339 | 339 | posix = kw.get('posix',True) |
|
340 | 340 | |
|
341 | 341 | # Check if we have more than one argument to warrant extra processing: |
|
342 | 342 | odict = {} # Dictionary with options |
|
343 | 343 | args = arg_str.split() |
|
344 | 344 | if len(args) >= 1: |
|
345 | 345 | # If the list of inputs only has 0 or 1 thing in it, there's no |
|
346 | 346 | # need to look for options |
|
347 | 347 | argv = arg_split(arg_str,posix) |
|
348 | 348 | # Do regular option processing |
|
349 | 349 | try: |
|
350 | 350 | opts,args = getopt(argv,opt_str,*long_opts) |
|
351 | 351 | except GetoptError,e: |
|
352 | 352 | raise GetoptError('%s ( allowed: "%s" %s)' % (e.msg,opt_str, |
|
353 | 353 | " ".join(long_opts))) |
|
354 | 354 | for o,a in opts: |
|
355 | 355 | if o.startswith('--'): |
|
356 | 356 | o = o[2:] |
|
357 | 357 | else: |
|
358 | 358 | o = o[1:] |
|
359 | 359 | try: |
|
360 | 360 | odict[o].append(a) |
|
361 | 361 | except AttributeError: |
|
362 | 362 | odict[o] = [odict[o],a] |
|
363 | 363 | except KeyError: |
|
364 | 364 | if list_all: |
|
365 | 365 | odict[o] = [a] |
|
366 | 366 | else: |
|
367 | 367 | odict[o] = a |
|
368 | 368 | |
|
369 | 369 | # Prepare opts,args for return |
|
370 | 370 | opts = Struct(odict) |
|
371 | 371 | if mode == 'string': |
|
372 | 372 | args = ' '.join(args) |
|
373 | 373 | |
|
374 | 374 | return opts,args |
|
375 | 375 | |
|
376 | 376 | #...................................................................... |
|
377 | 377 | # And now the actual magic functions |
|
378 | 378 | |
|
379 | 379 | # Functions for IPython shell work (vars,funcs, config, etc) |
|
380 | 380 | def magic_lsmagic(self, parameter_s = ''): |
|
381 | 381 | """List currently available magic functions.""" |
|
382 | 382 | mesc = self.shell.ESC_MAGIC |
|
383 | 383 | print 'Available magic functions:\n'+mesc+\ |
|
384 | 384 | (' '+mesc).join(self.lsmagic()) |
|
385 | 385 | print '\n' + Magic.auto_status[self.shell.rc.automagic] |
|
386 | 386 | return None |
|
387 | 387 | |
|
388 | 388 | def magic_magic(self, parameter_s = ''): |
|
389 | 389 | """Print information about the magic function system.""" |
|
390 | 390 | |
|
391 | 391 | mode = '' |
|
392 | 392 | try: |
|
393 | 393 | if parameter_s.split()[0] == '-latex': |
|
394 | 394 | mode = 'latex' |
|
395 | 395 | if parameter_s.split()[0] == '-brief': |
|
396 | 396 | mode = 'brief' |
|
397 | 397 | except: |
|
398 | 398 | pass |
|
399 | 399 | |
|
400 | 400 | magic_docs = [] |
|
401 | 401 | for fname in self.lsmagic(): |
|
402 | 402 | mname = 'magic_' + fname |
|
403 | 403 | for space in (Magic,self,self.__class__): |
|
404 | 404 | try: |
|
405 | 405 | fn = space.__dict__[mname] |
|
406 | 406 | except KeyError: |
|
407 | 407 | pass |
|
408 | 408 | else: |
|
409 | 409 | break |
|
410 | 410 | if mode == 'brief': |
|
411 | 411 | # only first line |
|
412 | 412 | fndoc = fn.__doc__.split('\n',1)[0] |
|
413 | 413 | else: |
|
414 | 414 | fndoc = fn.__doc__ |
|
415 | 415 | |
|
416 | 416 | magic_docs.append('%s%s:\n\t%s\n' %(self.shell.ESC_MAGIC, |
|
417 | 417 | fname,fndoc)) |
|
418 | 418 | magic_docs = ''.join(magic_docs) |
|
419 | 419 | |
|
420 | 420 | if mode == 'latex': |
|
421 | 421 | print self.format_latex(magic_docs) |
|
422 | 422 | return |
|
423 | 423 | else: |
|
424 | 424 | magic_docs = self.format_screen(magic_docs) |
|
425 | 425 | if mode == 'brief': |
|
426 | 426 | return magic_docs |
|
427 | 427 | |
|
428 | 428 | outmsg = """ |
|
429 | 429 | IPython's 'magic' functions |
|
430 | 430 | =========================== |
|
431 | 431 | |
|
432 | 432 | The magic function system provides a series of functions which allow you to |
|
433 | 433 | control the behavior of IPython itself, plus a lot of system-type |
|
434 | 434 | features. All these functions are prefixed with a % character, but parameters |
|
435 | 435 | are given without parentheses or quotes. |
|
436 | 436 | |
|
437 | 437 | NOTE: If you have 'automagic' enabled (via the command line option or with the |
|
438 | 438 | %automagic function), you don't need to type in the % explicitly. By default, |
|
439 | 439 | IPython ships with automagic on, so you should only rarely need the % escape. |
|
440 | 440 | |
|
441 | 441 | Example: typing '%cd mydir' (without the quotes) changes you working directory |
|
442 | 442 | to 'mydir', if it exists. |
|
443 | 443 | |
|
444 | 444 | You can define your own magic functions to extend the system. See the supplied |
|
445 | 445 | ipythonrc and example-magic.py files for details (in your ipython |
|
446 | 446 | configuration directory, typically $HOME/.ipython/). |
|
447 | 447 | |
|
448 | 448 | You can also define your own aliased names for magic functions. In your |
|
449 | 449 | ipythonrc file, placing a line like: |
|
450 | 450 | |
|
451 | 451 | execute __IPYTHON__.magic_pf = __IPYTHON__.magic_profile |
|
452 | 452 | |
|
453 | 453 | will define %pf as a new name for %profile. |
|
454 | 454 | |
|
455 | 455 | You can also call magics in code using the ipmagic() function, which IPython |
|
456 | 456 | automatically adds to the builtin namespace. Type 'ipmagic?' for details. |
|
457 | 457 | |
|
458 | 458 | For a list of the available magic functions, use %lsmagic. For a description |
|
459 | 459 | of any of them, type %magic_name?, e.g. '%cd?'. |
|
460 | 460 | |
|
461 | 461 | Currently the magic system has the following functions:\n""" |
|
462 | 462 | |
|
463 | 463 | mesc = self.shell.ESC_MAGIC |
|
464 | 464 | outmsg = ("%s\n%s\n\nSummary of magic functions (from %slsmagic):" |
|
465 | 465 | "\n\n%s%s\n\n%s" % (outmsg, |
|
466 | 466 | magic_docs,mesc,mesc, |
|
467 | 467 | (' '+mesc).join(self.lsmagic()), |
|
468 | 468 | Magic.auto_status[self.shell.rc.automagic] ) ) |
|
469 | 469 | |
|
470 | 470 | page(outmsg,screen_lines=self.shell.rc.screen_length) |
|
471 | 471 | |
|
472 | 472 | |
|
473 | 473 | def magic_autoindent(self, parameter_s = ''): |
|
474 | 474 | """Toggle autoindent on/off (if available).""" |
|
475 | 475 | |
|
476 | 476 | self.shell.set_autoindent() |
|
477 | 477 | print "Automatic indentation is:",['OFF','ON'][self.shell.autoindent] |
|
478 | 478 | |
|
479 | 479 | def magic_system_verbose(self, parameter_s = ''): |
|
480 | 480 | """Set verbose printing of system calls. |
|
481 | 481 | |
|
482 | 482 | If called without an argument, act as a toggle""" |
|
483 | 483 | |
|
484 | 484 | if parameter_s: |
|
485 | 485 | val = bool(eval(parameter_s)) |
|
486 | 486 | else: |
|
487 | 487 | val = None |
|
488 | 488 | |
|
489 | 489 | self.shell.rc_set_toggle('system_verbose',val) |
|
490 | 490 | print "System verbose printing is:",\ |
|
491 | 491 | ['OFF','ON'][self.shell.rc.system_verbose] |
|
492 | 492 | |
|
493 | 493 | |
|
494 | 494 | def magic_page(self, parameter_s=''): |
|
495 | 495 | """Pretty print the object and display it through a pager. |
|
496 | 496 | |
|
497 | 497 | %page [options] OBJECT |
|
498 | 498 | |
|
499 | 499 | If no object is given, use _ (last output). |
|
500 | 500 | |
|
501 | 501 | Options: |
|
502 | 502 | |
|
503 | 503 | -r: page str(object), don't pretty-print it.""" |
|
504 | 504 | |
|
505 | 505 | # After a function contributed by Olivier Aubert, slightly modified. |
|
506 | 506 | |
|
507 | 507 | # Process options/args |
|
508 | 508 | opts,args = self.parse_options(parameter_s,'r') |
|
509 | 509 | raw = 'r' in opts |
|
510 | 510 | |
|
511 | 511 | oname = args and args or '_' |
|
512 | 512 | info = self._ofind(oname) |
|
513 | 513 | if info['found']: |
|
514 | 514 | txt = (raw and str or pformat)( info['obj'] ) |
|
515 | 515 | page(txt) |
|
516 | 516 | else: |
|
517 | 517 | print 'Object `%s` not found' % oname |
|
518 | 518 | |
|
519 | 519 | def magic_profile(self, parameter_s=''): |
|
520 | 520 | """Print your currently active IPyhton profile.""" |
|
521 | 521 | if self.shell.rc.profile: |
|
522 | 522 | printpl('Current IPython profile: $self.shell.rc.profile.') |
|
523 | 523 | else: |
|
524 | 524 | print 'No profile active.' |
|
525 | 525 | |
|
526 | 526 | def magic_pinfo(self, parameter_s='', namespaces=None): |
|
527 | 527 | """Provide detailed information about an object. |
|
528 | 528 | |
|
529 | 529 | '%pinfo object' is just a synonym for object? or ?object.""" |
|
530 | 530 | |
|
531 | 531 | #print 'pinfo par: <%s>' % parameter_s # dbg |
|
532 | 532 | |
|
533 | 533 | |
|
534 | 534 | # detail_level: 0 -> obj? , 1 -> obj?? |
|
535 | 535 | detail_level = 0 |
|
536 | 536 | # We need to detect if we got called as 'pinfo pinfo foo', which can |
|
537 | 537 | # happen if the user types 'pinfo foo?' at the cmd line. |
|
538 | 538 | pinfo,qmark1,oname,qmark2 = \ |
|
539 | 539 | re.match('(pinfo )?(\?*)(.*?)(\??$)',parameter_s).groups() |
|
540 | 540 | if pinfo or qmark1 or qmark2: |
|
541 | 541 | detail_level = 1 |
|
542 | 542 | if "*" in oname: |
|
543 | 543 | self.magic_psearch(oname) |
|
544 | 544 | else: |
|
545 | 545 | self._inspect('pinfo', oname, detail_level=detail_level, |
|
546 | 546 | namespaces=namespaces) |
|
547 | 547 | |
|
548 | 548 | def _inspect(self,meth,oname,namespaces=None,**kw): |
|
549 | 549 | """Generic interface to the inspector system. |
|
550 | 550 | |
|
551 | 551 | This function is meant to be called by pdef, pdoc & friends.""" |
|
552 | 552 | |
|
553 | 553 | #oname = oname.strip() |
|
554 | 554 | #print '1- oname: <%r>' % oname # dbg |
|
555 | 555 | try: |
|
556 | 556 | oname = oname.strip().encode('ascii') |
|
557 | 557 | #print '2- oname: <%r>' % oname # dbg |
|
558 | 558 | except UnicodeEncodeError: |
|
559 | 559 | print 'Python identifiers can only contain ascii characters.' |
|
560 | 560 | return 'not found' |
|
561 | 561 | |
|
562 | 562 | info = Struct(self._ofind(oname, namespaces)) |
|
563 | 563 | |
|
564 | 564 | if info.found: |
|
565 | 565 | try: |
|
566 | 566 | IPython.generics.inspect_object(info.obj) |
|
567 | 567 | return |
|
568 | 568 | except IPython.ipapi.TryNext: |
|
569 | 569 | pass |
|
570 | 570 | # Get the docstring of the class property if it exists. |
|
571 | 571 | path = oname.split('.') |
|
572 | 572 | root = '.'.join(path[:-1]) |
|
573 | 573 | if info.parent is not None: |
|
574 | 574 | try: |
|
575 | 575 | target = getattr(info.parent, '__class__') |
|
576 | 576 | # The object belongs to a class instance. |
|
577 | 577 | try: |
|
578 | 578 | target = getattr(target, path[-1]) |
|
579 | 579 | # The class defines the object. |
|
580 | 580 | if isinstance(target, property): |
|
581 | 581 | oname = root + '.__class__.' + path[-1] |
|
582 | 582 | info = Struct(self._ofind(oname)) |
|
583 | 583 | except AttributeError: pass |
|
584 | 584 | except AttributeError: pass |
|
585 | 585 | |
|
586 | 586 | pmethod = getattr(self.shell.inspector,meth) |
|
587 | 587 | formatter = info.ismagic and self.format_screen or None |
|
588 | 588 | if meth == 'pdoc': |
|
589 | 589 | pmethod(info.obj,oname,formatter) |
|
590 | 590 | elif meth == 'pinfo': |
|
591 | 591 | pmethod(info.obj,oname,formatter,info,**kw) |
|
592 | 592 | else: |
|
593 | 593 | pmethod(info.obj,oname) |
|
594 | 594 | else: |
|
595 | 595 | print 'Object `%s` not found.' % oname |
|
596 | 596 | return 'not found' # so callers can take other action |
|
597 | 597 | |
|
598 | 598 | def magic_psearch(self, parameter_s=''): |
|
599 | 599 | """Search for object in namespaces by wildcard. |
|
600 | 600 | |
|
601 | 601 | %psearch [options] PATTERN [OBJECT TYPE] |
|
602 | 602 | |
|
603 | 603 | Note: ? can be used as a synonym for %psearch, at the beginning or at |
|
604 | 604 | the end: both a*? and ?a* are equivalent to '%psearch a*'. Still, the |
|
605 | 605 | rest of the command line must be unchanged (options come first), so |
|
606 | 606 | for example the following forms are equivalent |
|
607 | 607 | |
|
608 | 608 | %psearch -i a* function |
|
609 | 609 | -i a* function? |
|
610 | 610 | ?-i a* function |
|
611 | 611 | |
|
612 | 612 | Arguments: |
|
613 | 613 | |
|
614 | 614 | PATTERN |
|
615 | 615 | |
|
616 | 616 | where PATTERN is a string containing * as a wildcard similar to its |
|
617 | 617 | use in a shell. The pattern is matched in all namespaces on the |
|
618 | 618 | search path. By default objects starting with a single _ are not |
|
619 | 619 | matched, many IPython generated objects have a single |
|
620 | 620 | underscore. The default is case insensitive matching. Matching is |
|
621 | 621 | also done on the attributes of objects and not only on the objects |
|
622 | 622 | in a module. |
|
623 | 623 | |
|
624 | 624 | [OBJECT TYPE] |
|
625 | 625 | |
|
626 | 626 | Is the name of a python type from the types module. The name is |
|
627 | 627 | given in lowercase without the ending type, ex. StringType is |
|
628 | 628 | written string. By adding a type here only objects matching the |
|
629 | 629 | given type are matched. Using all here makes the pattern match all |
|
630 | 630 | types (this is the default). |
|
631 | 631 | |
|
632 | 632 | Options: |
|
633 | 633 | |
|
634 | 634 | -a: makes the pattern match even objects whose names start with a |
|
635 | 635 | single underscore. These names are normally ommitted from the |
|
636 | 636 | search. |
|
637 | 637 | |
|
638 | 638 | -i/-c: make the pattern case insensitive/sensitive. If neither of |
|
639 | 639 | these options is given, the default is read from your ipythonrc |
|
640 | 640 | file. The option name which sets this value is |
|
641 | 641 | 'wildcards_case_sensitive'. If this option is not specified in your |
|
642 | 642 | ipythonrc file, IPython's internal default is to do a case sensitive |
|
643 | 643 | search. |
|
644 | 644 | |
|
645 | 645 | -e/-s NAMESPACE: exclude/search a given namespace. The pattern you |
|
646 | 646 | specifiy can be searched in any of the following namespaces: |
|
647 | 647 | 'builtin', 'user', 'user_global','internal', 'alias', where |
|
648 | 648 | 'builtin' and 'user' are the search defaults. Note that you should |
|
649 | 649 | not use quotes when specifying namespaces. |
|
650 | 650 | |
|
651 | 651 | 'Builtin' contains the python module builtin, 'user' contains all |
|
652 | 652 | user data, 'alias' only contain the shell aliases and no python |
|
653 | 653 | objects, 'internal' contains objects used by IPython. The |
|
654 | 654 | 'user_global' namespace is only used by embedded IPython instances, |
|
655 | 655 | and it contains module-level globals. You can add namespaces to the |
|
656 | 656 | search with -s or exclude them with -e (these options can be given |
|
657 | 657 | more than once). |
|
658 | 658 | |
|
659 | 659 | Examples: |
|
660 | 660 | |
|
661 | 661 | %psearch a* -> objects beginning with an a |
|
662 | 662 | %psearch -e builtin a* -> objects NOT in the builtin space starting in a |
|
663 | 663 | %psearch a* function -> all functions beginning with an a |
|
664 | 664 | %psearch re.e* -> objects beginning with an e in module re |
|
665 | 665 | %psearch r*.e* -> objects that start with e in modules starting in r |
|
666 | 666 | %psearch r*.* string -> all strings in modules beginning with r |
|
667 | 667 | |
|
668 | 668 | Case sensitve search: |
|
669 | 669 | |
|
670 | 670 | %psearch -c a* list all object beginning with lower case a |
|
671 | 671 | |
|
672 | 672 | Show objects beginning with a single _: |
|
673 | 673 | |
|
674 | 674 | %psearch -a _* list objects beginning with a single underscore""" |
|
675 | 675 | try: |
|
676 | 676 | parameter_s = parameter_s.encode('ascii') |
|
677 | 677 | except UnicodeEncodeError: |
|
678 | 678 | print 'Python identifiers can only contain ascii characters.' |
|
679 | 679 | return |
|
680 | 680 | |
|
681 | 681 | # default namespaces to be searched |
|
682 | 682 | def_search = ['user','builtin'] |
|
683 | 683 | |
|
684 | 684 | # Process options/args |
|
685 | 685 | opts,args = self.parse_options(parameter_s,'cias:e:',list_all=True) |
|
686 | 686 | opt = opts.get |
|
687 | 687 | shell = self.shell |
|
688 | 688 | psearch = shell.inspector.psearch |
|
689 | 689 | |
|
690 | 690 | # select case options |
|
691 | 691 | if opts.has_key('i'): |
|
692 | 692 | ignore_case = True |
|
693 | 693 | elif opts.has_key('c'): |
|
694 | 694 | ignore_case = False |
|
695 | 695 | else: |
|
696 | 696 | ignore_case = not shell.rc.wildcards_case_sensitive |
|
697 | 697 | |
|
698 | 698 | # Build list of namespaces to search from user options |
|
699 | 699 | def_search.extend(opt('s',[])) |
|
700 | 700 | ns_exclude = ns_exclude=opt('e',[]) |
|
701 | 701 | ns_search = [nm for nm in def_search if nm not in ns_exclude] |
|
702 | 702 | |
|
703 | 703 | # Call the actual search |
|
704 | 704 | try: |
|
705 | 705 | psearch(args,shell.ns_table,ns_search, |
|
706 | 706 | show_all=opt('a'),ignore_case=ignore_case) |
|
707 | 707 | except: |
|
708 | 708 | shell.showtraceback() |
|
709 | 709 | |
|
710 | 710 | def magic_who_ls(self, parameter_s=''): |
|
711 | 711 | """Return a sorted list of all interactive variables. |
|
712 | 712 | |
|
713 | 713 | If arguments are given, only variables of types matching these |
|
714 | 714 | arguments are returned.""" |
|
715 | 715 | |
|
716 | 716 | user_ns = self.shell.user_ns |
|
717 | 717 | internal_ns = self.shell.internal_ns |
|
718 | 718 | user_config_ns = self.shell.user_config_ns |
|
719 | 719 | out = [] |
|
720 | 720 | typelist = parameter_s.split() |
|
721 | 721 | |
|
722 | 722 | for i in user_ns: |
|
723 | 723 | if not (i.startswith('_') or i.startswith('_i')) \ |
|
724 | 724 | and not (i in internal_ns or i in user_config_ns): |
|
725 | 725 | if typelist: |
|
726 | 726 | if type(user_ns[i]).__name__ in typelist: |
|
727 | 727 | out.append(i) |
|
728 | 728 | else: |
|
729 | 729 | out.append(i) |
|
730 | 730 | out.sort() |
|
731 | 731 | return out |
|
732 | 732 | |
|
733 | 733 | def magic_who(self, parameter_s=''): |
|
734 | 734 | """Print all interactive variables, with some minimal formatting. |
|
735 | 735 | |
|
736 | 736 | If any arguments are given, only variables whose type matches one of |
|
737 | 737 | these are printed. For example: |
|
738 | 738 | |
|
739 | 739 | %who function str |
|
740 | 740 | |
|
741 | 741 | will only list functions and strings, excluding all other types of |
|
742 | 742 | variables. To find the proper type names, simply use type(var) at a |
|
743 | 743 | command line to see how python prints type names. For example: |
|
744 | 744 | |
|
745 | 745 | In [1]: type('hello')\\ |
|
746 | 746 | Out[1]: <type 'str'> |
|
747 | 747 | |
|
748 | 748 | indicates that the type name for strings is 'str'. |
|
749 | 749 | |
|
750 | 750 | %who always excludes executed names loaded through your configuration |
|
751 | 751 | file and things which are internal to IPython. |
|
752 | 752 | |
|
753 | 753 | This is deliberate, as typically you may load many modules and the |
|
754 | 754 | purpose of %who is to show you only what you've manually defined.""" |
|
755 | 755 | |
|
756 | 756 | varlist = self.magic_who_ls(parameter_s) |
|
757 | 757 | if not varlist: |
|
758 | 758 | if parameter_s: |
|
759 | 759 | print 'No variables match your requested type.' |
|
760 | 760 | else: |
|
761 | 761 | print 'Interactive namespace is empty.' |
|
762 | 762 | return |
|
763 | 763 | |
|
764 | 764 | # if we have variables, move on... |
|
765 | 765 | count = 0 |
|
766 | 766 | for i in varlist: |
|
767 | 767 | print i+'\t', |
|
768 | 768 | count += 1 |
|
769 | 769 | if count > 8: |
|
770 | 770 | count = 0 |
|
771 | 771 | |
|
772 | 772 | |
|
773 | 773 | |
|
774 | 774 | def magic_whos(self, parameter_s=''): |
|
775 | 775 | """Like %who, but gives some extra information about each variable. |
|
776 | 776 | |
|
777 | 777 | The same type filtering of %who can be applied here. |
|
778 | 778 | |
|
779 | 779 | For all variables, the type is printed. Additionally it prints: |
|
780 | 780 | |
|
781 | 781 | - For {},[],(): their length. |
|
782 | 782 | |
|
783 | 783 | - For numpy and Numeric arrays, a summary with shape, number of |
|
784 | 784 | elements, typecode and size in memory. |
|
785 | 785 | |
|
786 | 786 | - Everything else: a string representation, snipping their middle if |
|
787 | 787 | too long.""" |
|
788 | 788 | |
|
789 | 789 | varnames = self.magic_who_ls(parameter_s) |
|
790 | 790 | if not varnames: |
|
791 | 791 | if parameter_s: |
|
792 | 792 | print 'No variables match your requested type.' |
|
793 | 793 | else: |
|
794 | 794 | print 'Interactive namespace is empty.' |
|
795 | 795 | return |
|
796 | 796 | |
|
797 | 797 | # if we have variables, move on... |
|
798 | 798 | |
|
799 | 799 | # for these types, show len() instead of data: |
|
800 | 800 | seq_types = [types.DictType,types.ListType,types.TupleType] |
|
801 | 801 | |
|
802 | 802 | # for numpy/Numeric arrays, display summary info |
|
803 | 803 | try: |
|
804 | 804 | import numpy |
|
805 | 805 | except ImportError: |
|
806 | 806 | ndarray_type = None |
|
807 | 807 | else: |
|
808 | 808 | ndarray_type = numpy.ndarray.__name__ |
|
809 | 809 | try: |
|
810 | 810 | import Numeric |
|
811 | 811 | except ImportError: |
|
812 | 812 | array_type = None |
|
813 | 813 | else: |
|
814 | 814 | array_type = Numeric.ArrayType.__name__ |
|
815 | 815 | |
|
816 | 816 | # Find all variable names and types so we can figure out column sizes |
|
817 | 817 | def get_vars(i): |
|
818 | 818 | return self.shell.user_ns[i] |
|
819 | 819 | |
|
820 | 820 | # some types are well known and can be shorter |
|
821 | 821 | abbrevs = {'IPython.macro.Macro' : 'Macro'} |
|
822 | 822 | def type_name(v): |
|
823 | 823 | tn = type(v).__name__ |
|
824 | 824 | return abbrevs.get(tn,tn) |
|
825 | 825 | |
|
826 | 826 | varlist = map(get_vars,varnames) |
|
827 | 827 | |
|
828 | 828 | typelist = [] |
|
829 | 829 | for vv in varlist: |
|
830 | 830 | tt = type_name(vv) |
|
831 | 831 | |
|
832 | 832 | if tt=='instance': |
|
833 | 833 | typelist.append( abbrevs.get(str(vv.__class__), |
|
834 | 834 | str(vv.__class__))) |
|
835 | 835 | else: |
|
836 | 836 | typelist.append(tt) |
|
837 | 837 | |
|
838 | 838 | # column labels and # of spaces as separator |
|
839 | 839 | varlabel = 'Variable' |
|
840 | 840 | typelabel = 'Type' |
|
841 | 841 | datalabel = 'Data/Info' |
|
842 | 842 | colsep = 3 |
|
843 | 843 | # variable format strings |
|
844 | 844 | vformat = "$vname.ljust(varwidth)$vtype.ljust(typewidth)" |
|
845 | 845 | vfmt_short = '$vstr[:25]<...>$vstr[-25:]' |
|
846 | 846 | aformat = "%s: %s elems, type `%s`, %s bytes" |
|
847 | 847 | # find the size of the columns to format the output nicely |
|
848 | 848 | varwidth = max(max(map(len,varnames)), len(varlabel)) + colsep |
|
849 | 849 | typewidth = max(max(map(len,typelist)), len(typelabel)) + colsep |
|
850 | 850 | # table header |
|
851 | 851 | print varlabel.ljust(varwidth) + typelabel.ljust(typewidth) + \ |
|
852 | 852 | ' '+datalabel+'\n' + '-'*(varwidth+typewidth+len(datalabel)+1) |
|
853 | 853 | # and the table itself |
|
854 | 854 | kb = 1024 |
|
855 | 855 | Mb = 1048576 # kb**2 |
|
856 | 856 | for vname,var,vtype in zip(varnames,varlist,typelist): |
|
857 | 857 | print itpl(vformat), |
|
858 | 858 | if vtype in seq_types: |
|
859 | 859 | print len(var) |
|
860 | 860 | elif vtype in [array_type,ndarray_type]: |
|
861 | 861 | vshape = str(var.shape).replace(',','').replace(' ','x')[1:-1] |
|
862 | 862 | if vtype==ndarray_type: |
|
863 | 863 | # numpy |
|
864 | 864 | vsize = var.size |
|
865 | 865 | vbytes = vsize*var.itemsize |
|
866 | 866 | vdtype = var.dtype |
|
867 | 867 | else: |
|
868 | 868 | # Numeric |
|
869 | 869 | vsize = Numeric.size(var) |
|
870 | 870 | vbytes = vsize*var.itemsize() |
|
871 | 871 | vdtype = var.typecode() |
|
872 | 872 | |
|
873 | 873 | if vbytes < 100000: |
|
874 | 874 | print aformat % (vshape,vsize,vdtype,vbytes) |
|
875 | 875 | else: |
|
876 | 876 | print aformat % (vshape,vsize,vdtype,vbytes), |
|
877 | 877 | if vbytes < Mb: |
|
878 | 878 | print '(%s kb)' % (vbytes/kb,) |
|
879 | 879 | else: |
|
880 | 880 | print '(%s Mb)' % (vbytes/Mb,) |
|
881 | 881 | else: |
|
882 | 882 | try: |
|
883 | 883 | vstr = str(var) |
|
884 | 884 | except UnicodeEncodeError: |
|
885 | 885 | vstr = unicode(var).encode(sys.getdefaultencoding(), |
|
886 | 886 | 'backslashreplace') |
|
887 | 887 | vstr = vstr.replace('\n','\\n') |
|
888 | 888 | if len(vstr) < 50: |
|
889 | 889 | print vstr |
|
890 | 890 | else: |
|
891 | 891 | printpl(vfmt_short) |
|
892 | 892 | |
|
893 | 893 | def magic_reset(self, parameter_s=''): |
|
894 | 894 | """Resets the namespace by removing all names defined by the user. |
|
895 | 895 | |
|
896 | 896 | Input/Output history are left around in case you need them.""" |
|
897 | 897 | |
|
898 | 898 | ans = self.shell.ask_yes_no( |
|
899 | 899 | "Once deleted, variables cannot be recovered. Proceed (y/[n])? ") |
|
900 | 900 | if not ans: |
|
901 | 901 | print 'Nothing done.' |
|
902 | 902 | return |
|
903 | 903 | user_ns = self.shell.user_ns |
|
904 | 904 | for i in self.magic_who_ls(): |
|
905 | 905 | del(user_ns[i]) |
|
906 | 906 | |
|
907 | 907 | def magic_logstart(self,parameter_s=''): |
|
908 | 908 | """Start logging anywhere in a session. |
|
909 | 909 | |
|
910 | 910 | %logstart [-o|-r|-t] [log_name [log_mode]] |
|
911 | 911 | |
|
912 | 912 | If no name is given, it defaults to a file named 'ipython_log.py' in your |
|
913 | 913 | current directory, in 'rotate' mode (see below). |
|
914 | 914 | |
|
915 | 915 | '%logstart name' saves to file 'name' in 'backup' mode. It saves your |
|
916 | 916 | history up to that point and then continues logging. |
|
917 | 917 | |
|
918 | 918 | %logstart takes a second optional parameter: logging mode. This can be one |
|
919 | 919 | of (note that the modes are given unquoted):\\ |
|
920 | 920 | append: well, that says it.\\ |
|
921 | 921 | backup: rename (if exists) to name~ and start name.\\ |
|
922 | 922 | global: single logfile in your home dir, appended to.\\ |
|
923 | 923 | over : overwrite existing log.\\ |
|
924 | 924 | rotate: create rotating logs name.1~, name.2~, etc. |
|
925 | 925 | |
|
926 | 926 | Options: |
|
927 | 927 | |
|
928 | 928 | -o: log also IPython's output. In this mode, all commands which |
|
929 | 929 | generate an Out[NN] prompt are recorded to the logfile, right after |
|
930 | 930 | their corresponding input line. The output lines are always |
|
931 | 931 | prepended with a '#[Out]# ' marker, so that the log remains valid |
|
932 | 932 | Python code. |
|
933 | 933 | |
|
934 | 934 | Since this marker is always the same, filtering only the output from |
|
935 | 935 | a log is very easy, using for example a simple awk call: |
|
936 | 936 | |
|
937 | 937 | awk -F'#\\[Out\\]# ' '{if($2) {print $2}}' ipython_log.py |
|
938 | 938 | |
|
939 | 939 | -r: log 'raw' input. Normally, IPython's logs contain the processed |
|
940 | 940 | input, so that user lines are logged in their final form, converted |
|
941 | 941 | into valid Python. For example, %Exit is logged as |
|
942 | 942 | '_ip.magic("Exit"). If the -r flag is given, all input is logged |
|
943 | 943 | exactly as typed, with no transformations applied. |
|
944 | 944 | |
|
945 | 945 | -t: put timestamps before each input line logged (these are put in |
|
946 | 946 | comments).""" |
|
947 | 947 | |
|
948 | 948 | opts,par = self.parse_options(parameter_s,'ort') |
|
949 | 949 | log_output = 'o' in opts |
|
950 | 950 | log_raw_input = 'r' in opts |
|
951 | 951 | timestamp = 't' in opts |
|
952 | 952 | |
|
953 | 953 | rc = self.shell.rc |
|
954 | 954 | logger = self.shell.logger |
|
955 | 955 | |
|
956 | 956 | # if no args are given, the defaults set in the logger constructor by |
|
957 | 957 | # ipytohn remain valid |
|
958 | 958 | if par: |
|
959 | 959 | try: |
|
960 | 960 | logfname,logmode = par.split() |
|
961 | 961 | except: |
|
962 | 962 | logfname = par |
|
963 | 963 | logmode = 'backup' |
|
964 | 964 | else: |
|
965 | 965 | logfname = logger.logfname |
|
966 | 966 | logmode = logger.logmode |
|
967 | 967 | # put logfname into rc struct as if it had been called on the command |
|
968 | 968 | # line, so it ends up saved in the log header Save it in case we need |
|
969 | 969 | # to restore it... |
|
970 | 970 | old_logfile = rc.opts.get('logfile','') |
|
971 | 971 | if logfname: |
|
972 | 972 | logfname = os.path.expanduser(logfname) |
|
973 | 973 | rc.opts.logfile = logfname |
|
974 | 974 | loghead = self.shell.loghead_tpl % (rc.opts,rc.args) |
|
975 | 975 | try: |
|
976 | 976 | started = logger.logstart(logfname,loghead,logmode, |
|
977 | 977 | log_output,timestamp,log_raw_input) |
|
978 | 978 | except: |
|
979 | 979 | rc.opts.logfile = old_logfile |
|
980 | 980 | warn("Couldn't start log: %s" % sys.exc_info()[1]) |
|
981 | 981 | else: |
|
982 | 982 | # log input history up to this point, optionally interleaving |
|
983 | 983 | # output if requested |
|
984 | 984 | |
|
985 | 985 | if timestamp: |
|
986 | 986 | # disable timestamping for the previous history, since we've |
|
987 | 987 | # lost those already (no time machine here). |
|
988 | 988 | logger.timestamp = False |
|
989 | 989 | |
|
990 | 990 | if log_raw_input: |
|
991 | 991 | input_hist = self.shell.input_hist_raw |
|
992 | 992 | else: |
|
993 | 993 | input_hist = self.shell.input_hist |
|
994 | 994 | |
|
995 | 995 | if log_output: |
|
996 | 996 | log_write = logger.log_write |
|
997 | 997 | output_hist = self.shell.output_hist |
|
998 | 998 | for n in range(1,len(input_hist)-1): |
|
999 | 999 | log_write(input_hist[n].rstrip()) |
|
1000 | 1000 | if n in output_hist: |
|
1001 | 1001 | log_write(repr(output_hist[n]),'output') |
|
1002 | 1002 | else: |
|
1003 | 1003 | logger.log_write(input_hist[1:]) |
|
1004 | 1004 | if timestamp: |
|
1005 | 1005 | # re-enable timestamping |
|
1006 | 1006 | logger.timestamp = True |
|
1007 | 1007 | |
|
1008 | 1008 | print ('Activating auto-logging. ' |
|
1009 | 1009 | 'Current session state plus future input saved.') |
|
1010 | 1010 | logger.logstate() |
|
1011 | 1011 | |
|
1012 | 1012 | def magic_logoff(self,parameter_s=''): |
|
1013 | 1013 | """Temporarily stop logging. |
|
1014 | 1014 | |
|
1015 | 1015 | You must have previously started logging.""" |
|
1016 | 1016 | self.shell.logger.switch_log(0) |
|
1017 | 1017 | |
|
1018 | 1018 | def magic_logon(self,parameter_s=''): |
|
1019 | 1019 | """Restart logging. |
|
1020 | 1020 | |
|
1021 | 1021 | This function is for restarting logging which you've temporarily |
|
1022 | 1022 | stopped with %logoff. For starting logging for the first time, you |
|
1023 | 1023 | must use the %logstart function, which allows you to specify an |
|
1024 | 1024 | optional log filename.""" |
|
1025 | 1025 | |
|
1026 | 1026 | self.shell.logger.switch_log(1) |
|
1027 | 1027 | |
|
1028 | 1028 | def magic_logstate(self,parameter_s=''): |
|
1029 | 1029 | """Print the status of the logging system.""" |
|
1030 | 1030 | |
|
1031 | 1031 | self.shell.logger.logstate() |
|
1032 | 1032 | |
|
1033 | 1033 | def magic_pdb(self, parameter_s=''): |
|
1034 | 1034 | """Control the automatic calling of the pdb interactive debugger. |
|
1035 | 1035 | |
|
1036 | 1036 | Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without |
|
1037 | 1037 | argument it works as a toggle. |
|
1038 | 1038 | |
|
1039 | 1039 | When an exception is triggered, IPython can optionally call the |
|
1040 | 1040 | interactive pdb debugger after the traceback printout. %pdb toggles |
|
1041 | 1041 | this feature on and off. |
|
1042 | 1042 | |
|
1043 | 1043 | The initial state of this feature is set in your ipythonrc |
|
1044 | 1044 | configuration file (the variable is called 'pdb'). |
|
1045 | 1045 | |
|
1046 | 1046 | If you want to just activate the debugger AFTER an exception has fired, |
|
1047 | 1047 | without having to type '%pdb on' and rerunning your code, you can use |
|
1048 | 1048 | the %debug magic.""" |
|
1049 | 1049 | |
|
1050 | 1050 | par = parameter_s.strip().lower() |
|
1051 | 1051 | |
|
1052 | 1052 | if par: |
|
1053 | 1053 | try: |
|
1054 | 1054 | new_pdb = {'off':0,'0':0,'on':1,'1':1}[par] |
|
1055 | 1055 | except KeyError: |
|
1056 | 1056 | print ('Incorrect argument. Use on/1, off/0, ' |
|
1057 | 1057 | 'or nothing for a toggle.') |
|
1058 | 1058 | return |
|
1059 | 1059 | else: |
|
1060 | 1060 | # toggle |
|
1061 | 1061 | new_pdb = not self.shell.call_pdb |
|
1062 | 1062 | |
|
1063 | 1063 | # set on the shell |
|
1064 | 1064 | self.shell.call_pdb = new_pdb |
|
1065 | 1065 | print 'Automatic pdb calling has been turned',on_off(new_pdb) |
|
1066 | 1066 | |
|
1067 | 1067 | def magic_debug(self, parameter_s=''): |
|
1068 | 1068 | """Activate the interactive debugger in post-mortem mode. |
|
1069 | 1069 | |
|
1070 | 1070 | If an exception has just occurred, this lets you inspect its stack |
|
1071 | 1071 | frames interactively. Note that this will always work only on the last |
|
1072 | 1072 | traceback that occurred, so you must call this quickly after an |
|
1073 | 1073 | exception that you wish to inspect has fired, because if another one |
|
1074 | 1074 | occurs, it clobbers the previous one. |
|
1075 | 1075 | |
|
1076 | 1076 | If you want IPython to automatically do this on every exception, see |
|
1077 | 1077 | the %pdb magic for more details. |
|
1078 | 1078 | """ |
|
1079 | 1079 | |
|
1080 | 1080 | self.shell.debugger(force=True) |
|
1081 | 1081 | |
|
1082 | 1082 | def magic_prun(self, parameter_s ='',user_mode=1, |
|
1083 | 1083 | opts=None,arg_lst=None,prog_ns=None): |
|
1084 | 1084 | |
|
1085 | 1085 | """Run a statement through the python code profiler. |
|
1086 | 1086 | |
|
1087 | 1087 | Usage:\\ |
|
1088 | 1088 | %prun [options] statement |
|
1089 | 1089 | |
|
1090 | 1090 | The given statement (which doesn't require quote marks) is run via the |
|
1091 | 1091 | python profiler in a manner similar to the profile.run() function. |
|
1092 | 1092 | Namespaces are internally managed to work correctly; profile.run |
|
1093 | 1093 | cannot be used in IPython because it makes certain assumptions about |
|
1094 | 1094 | namespaces which do not hold under IPython. |
|
1095 | 1095 | |
|
1096 | 1096 | Options: |
|
1097 | 1097 | |
|
1098 | 1098 | -l <limit>: you can place restrictions on what or how much of the |
|
1099 | 1099 | profile gets printed. The limit value can be: |
|
1100 | 1100 | |
|
1101 | 1101 | * A string: only information for function names containing this string |
|
1102 | 1102 | is printed. |
|
1103 | 1103 | |
|
1104 | 1104 | * An integer: only these many lines are printed. |
|
1105 | 1105 | |
|
1106 | 1106 | * A float (between 0 and 1): this fraction of the report is printed |
|
1107 | 1107 | (for example, use a limit of 0.4 to see the topmost 40% only). |
|
1108 | 1108 | |
|
1109 | 1109 | You can combine several limits with repeated use of the option. For |
|
1110 | 1110 | example, '-l __init__ -l 5' will print only the topmost 5 lines of |
|
1111 | 1111 | information about class constructors. |
|
1112 | 1112 | |
|
1113 | 1113 | -r: return the pstats.Stats object generated by the profiling. This |
|
1114 | 1114 | object has all the information about the profile in it, and you can |
|
1115 | 1115 | later use it for further analysis or in other functions. |
|
1116 | 1116 | |
|
1117 | 1117 | -s <key>: sort profile by given key. You can provide more than one key |
|
1118 | 1118 | by using the option several times: '-s key1 -s key2 -s key3...'. The |
|
1119 | 1119 | default sorting key is 'time'. |
|
1120 | 1120 | |
|
1121 | 1121 | The following is copied verbatim from the profile documentation |
|
1122 | 1122 | referenced below: |
|
1123 | 1123 | |
|
1124 | 1124 | When more than one key is provided, additional keys are used as |
|
1125 | 1125 | secondary criteria when the there is equality in all keys selected |
|
1126 | 1126 | before them. |
|
1127 | 1127 | |
|
1128 | 1128 | Abbreviations can be used for any key names, as long as the |
|
1129 | 1129 | abbreviation is unambiguous. The following are the keys currently |
|
1130 | 1130 | defined: |
|
1131 | 1131 | |
|
1132 | 1132 | Valid Arg Meaning\\ |
|
1133 | 1133 | "calls" call count\\ |
|
1134 | 1134 | "cumulative" cumulative time\\ |
|
1135 | 1135 | "file" file name\\ |
|
1136 | 1136 | "module" file name\\ |
|
1137 | 1137 | "pcalls" primitive call count\\ |
|
1138 | 1138 | "line" line number\\ |
|
1139 | 1139 | "name" function name\\ |
|
1140 | 1140 | "nfl" name/file/line\\ |
|
1141 | 1141 | "stdname" standard name\\ |
|
1142 | 1142 | "time" internal time |
|
1143 | 1143 | |
|
1144 | 1144 | Note that all sorts on statistics are in descending order (placing |
|
1145 | 1145 | most time consuming items first), where as name, file, and line number |
|
1146 | 1146 | searches are in ascending order (i.e., alphabetical). The subtle |
|
1147 | 1147 | distinction between "nfl" and "stdname" is that the standard name is a |
|
1148 | 1148 | sort of the name as printed, which means that the embedded line |
|
1149 | 1149 | numbers get compared in an odd way. For example, lines 3, 20, and 40 |
|
1150 | 1150 | would (if the file names were the same) appear in the string order |
|
1151 | 1151 | "20" "3" and "40". In contrast, "nfl" does a numeric compare of the |
|
1152 | 1152 | line numbers. In fact, sort_stats("nfl") is the same as |
|
1153 | 1153 | sort_stats("name", "file", "line"). |
|
1154 | 1154 | |
|
1155 | 1155 | -T <filename>: save profile results as shown on screen to a text |
|
1156 | 1156 | file. The profile is still shown on screen. |
|
1157 | 1157 | |
|
1158 | 1158 | -D <filename>: save (via dump_stats) profile statistics to given |
|
1159 | 1159 | filename. This data is in a format understod by the pstats module, and |
|
1160 | 1160 | is generated by a call to the dump_stats() method of profile |
|
1161 | 1161 | objects. The profile is still shown on screen. |
|
1162 | 1162 | |
|
1163 | 1163 | If you want to run complete programs under the profiler's control, use |
|
1164 | 1164 | '%run -p [prof_opts] filename.py [args to program]' where prof_opts |
|
1165 | 1165 | contains profiler specific options as described here. |
|
1166 | 1166 | |
|
1167 | 1167 | You can read the complete documentation for the profile module with:\\ |
|
1168 | 1168 | In [1]: import profile; profile.help() """ |
|
1169 | 1169 | |
|
1170 | 1170 | opts_def = Struct(D=[''],l=[],s=['time'],T=['']) |
|
1171 | 1171 | # protect user quote marks |
|
1172 | 1172 | parameter_s = parameter_s.replace('"',r'\"').replace("'",r"\'") |
|
1173 | 1173 | |
|
1174 | 1174 | if user_mode: # regular user call |
|
1175 | 1175 | opts,arg_str = self.parse_options(parameter_s,'D:l:rs:T:', |
|
1176 | 1176 | list_all=1) |
|
1177 | 1177 | namespace = self.shell.user_ns |
|
1178 | 1178 | else: # called to run a program by %run -p |
|
1179 | 1179 | try: |
|
1180 | 1180 | filename = get_py_filename(arg_lst[0]) |
|
1181 | 1181 | except IOError,msg: |
|
1182 | 1182 | error(msg) |
|
1183 | 1183 | return |
|
1184 | 1184 | |
|
1185 | 1185 | arg_str = 'execfile(filename,prog_ns)' |
|
1186 | 1186 | namespace = locals() |
|
1187 | 1187 | |
|
1188 | 1188 | opts.merge(opts_def) |
|
1189 | 1189 | |
|
1190 | 1190 | prof = profile.Profile() |
|
1191 | 1191 | try: |
|
1192 | 1192 | prof = prof.runctx(arg_str,namespace,namespace) |
|
1193 | 1193 | sys_exit = '' |
|
1194 | 1194 | except SystemExit: |
|
1195 | 1195 | sys_exit = """*** SystemExit exception caught in code being profiled.""" |
|
1196 | 1196 | |
|
1197 | 1197 | stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s) |
|
1198 | 1198 | |
|
1199 | 1199 | lims = opts.l |
|
1200 | 1200 | if lims: |
|
1201 | 1201 | lims = [] # rebuild lims with ints/floats/strings |
|
1202 | 1202 | for lim in opts.l: |
|
1203 | 1203 | try: |
|
1204 | 1204 | lims.append(int(lim)) |
|
1205 | 1205 | except ValueError: |
|
1206 | 1206 | try: |
|
1207 | 1207 | lims.append(float(lim)) |
|
1208 | 1208 | except ValueError: |
|
1209 | 1209 | lims.append(lim) |
|
1210 | 1210 | |
|
1211 | 1211 | # Trap output. |
|
1212 | 1212 | stdout_trap = StringIO() |
|
1213 | 1213 | |
|
1214 | 1214 | if hasattr(stats,'stream'): |
|
1215 | 1215 | # In newer versions of python, the stats object has a 'stream' |
|
1216 | 1216 | # attribute to write into. |
|
1217 | 1217 | stats.stream = stdout_trap |
|
1218 | 1218 | stats.print_stats(*lims) |
|
1219 | 1219 | else: |
|
1220 | 1220 | # For older versions, we manually redirect stdout during printing |
|
1221 | 1221 | sys_stdout = sys.stdout |
|
1222 | 1222 | try: |
|
1223 | 1223 | sys.stdout = stdout_trap |
|
1224 | 1224 | stats.print_stats(*lims) |
|
1225 | 1225 | finally: |
|
1226 | 1226 | sys.stdout = sys_stdout |
|
1227 | 1227 | |
|
1228 | 1228 | output = stdout_trap.getvalue() |
|
1229 | 1229 | output = output.rstrip() |
|
1230 | 1230 | |
|
1231 | 1231 | page(output,screen_lines=self.shell.rc.screen_length) |
|
1232 | 1232 | print sys_exit, |
|
1233 | 1233 | |
|
1234 | 1234 | dump_file = opts.D[0] |
|
1235 | 1235 | text_file = opts.T[0] |
|
1236 | 1236 | if dump_file: |
|
1237 | 1237 | prof.dump_stats(dump_file) |
|
1238 | 1238 | print '\n*** Profile stats marshalled to file',\ |
|
1239 | 1239 | `dump_file`+'.',sys_exit |
|
1240 | 1240 | if text_file: |
|
1241 | 1241 | pfile = file(text_file,'w') |
|
1242 | 1242 | pfile.write(output) |
|
1243 | 1243 | pfile.close() |
|
1244 | 1244 | print '\n*** Profile printout saved to text file',\ |
|
1245 | 1245 | `text_file`+'.',sys_exit |
|
1246 | 1246 | |
|
1247 | 1247 | if opts.has_key('r'): |
|
1248 | 1248 | return stats |
|
1249 | 1249 | else: |
|
1250 | 1250 | return None |
|
1251 | 1251 | |
|
1252 | 1252 | def magic_run(self, parameter_s ='',runner=None): |
|
1253 | 1253 | """Run the named file inside IPython as a program. |
|
1254 | 1254 | |
|
1255 | 1255 | Usage:\\ |
|
1256 | 1256 | %run [-n -i -t [-N<N>] -d [-b<N>] -p [profile options]] file [args] |
|
1257 | 1257 | |
|
1258 | 1258 | Parameters after the filename are passed as command-line arguments to |
|
1259 | 1259 | the program (put in sys.argv). Then, control returns to IPython's |
|
1260 | 1260 | prompt. |
|
1261 | 1261 | |
|
1262 | 1262 | This is similar to running at a system prompt:\\ |
|
1263 | 1263 | $ python file args\\ |
|
1264 | 1264 | but with the advantage of giving you IPython's tracebacks, and of |
|
1265 | 1265 | loading all variables into your interactive namespace for further use |
|
1266 | 1266 | (unless -p is used, see below). |
|
1267 | 1267 | |
|
1268 | 1268 | The file is executed in a namespace initially consisting only of |
|
1269 | 1269 | __name__=='__main__' and sys.argv constructed as indicated. It thus |
|
1270 | 1270 | sees its environment as if it were being run as a stand-alone |
|
1271 | 1271 | program. But after execution, the IPython interactive namespace gets |
|
1272 | 1272 | updated with all variables defined in the program (except for __name__ |
|
1273 | 1273 | and sys.argv). This allows for very convenient loading of code for |
|
1274 | 1274 | interactive work, while giving each program a 'clean sheet' to run in. |
|
1275 | 1275 | |
|
1276 | 1276 | Options: |
|
1277 | 1277 | |
|
1278 | 1278 | -n: __name__ is NOT set to '__main__', but to the running file's name |
|
1279 | 1279 | without extension (as python does under import). This allows running |
|
1280 | 1280 | scripts and reloading the definitions in them without calling code |
|
1281 | 1281 | protected by an ' if __name__ == "__main__" ' clause. |
|
1282 | 1282 | |
|
1283 | 1283 | -i: run the file in IPython's namespace instead of an empty one. This |
|
1284 | 1284 | is useful if you are experimenting with code written in a text editor |
|
1285 | 1285 | which depends on variables defined interactively. |
|
1286 | 1286 | |
|
1287 | 1287 | -e: ignore sys.exit() calls or SystemExit exceptions in the script |
|
1288 | 1288 | being run. This is particularly useful if IPython is being used to |
|
1289 | 1289 | run unittests, which always exit with a sys.exit() call. In such |
|
1290 | 1290 | cases you are interested in the output of the test results, not in |
|
1291 | 1291 | seeing a traceback of the unittest module. |
|
1292 | 1292 | |
|
1293 | 1293 | -t: print timing information at the end of the run. IPython will give |
|
1294 | 1294 | you an estimated CPU time consumption for your script, which under |
|
1295 | 1295 | Unix uses the resource module to avoid the wraparound problems of |
|
1296 | 1296 | time.clock(). Under Unix, an estimate of time spent on system tasks |
|
1297 | 1297 | is also given (for Windows platforms this is reported as 0.0). |
|
1298 | 1298 | |
|
1299 | 1299 | If -t is given, an additional -N<N> option can be given, where <N> |
|
1300 | 1300 | must be an integer indicating how many times you want the script to |
|
1301 | 1301 | run. The final timing report will include total and per run results. |
|
1302 | 1302 | |
|
1303 | 1303 | For example (testing the script uniq_stable.py): |
|
1304 | 1304 | |
|
1305 | 1305 | In [1]: run -t uniq_stable |
|
1306 | 1306 | |
|
1307 | 1307 | IPython CPU timings (estimated):\\ |
|
1308 | 1308 | User : 0.19597 s.\\ |
|
1309 | 1309 | System: 0.0 s.\\ |
|
1310 | 1310 | |
|
1311 | 1311 | In [2]: run -t -N5 uniq_stable |
|
1312 | 1312 | |
|
1313 | 1313 | IPython CPU timings (estimated):\\ |
|
1314 | 1314 | Total runs performed: 5\\ |
|
1315 | 1315 | Times : Total Per run\\ |
|
1316 | 1316 | User : 0.910862 s, 0.1821724 s.\\ |
|
1317 | 1317 | System: 0.0 s, 0.0 s. |
|
1318 | 1318 | |
|
1319 | 1319 | -d: run your program under the control of pdb, the Python debugger. |
|
1320 | 1320 | This allows you to execute your program step by step, watch variables, |
|
1321 | 1321 | etc. Internally, what IPython does is similar to calling: |
|
1322 | 1322 | |
|
1323 | 1323 | pdb.run('execfile("YOURFILENAME")') |
|
1324 | 1324 | |
|
1325 | 1325 | with a breakpoint set on line 1 of your file. You can change the line |
|
1326 | 1326 | number for this automatic breakpoint to be <N> by using the -bN option |
|
1327 | 1327 | (where N must be an integer). For example: |
|
1328 | 1328 | |
|
1329 | 1329 | %run -d -b40 myscript |
|
1330 | 1330 | |
|
1331 | 1331 | will set the first breakpoint at line 40 in myscript.py. Note that |
|
1332 | 1332 | the first breakpoint must be set on a line which actually does |
|
1333 | 1333 | something (not a comment or docstring) for it to stop execution. |
|
1334 | 1334 | |
|
1335 | 1335 | When the pdb debugger starts, you will see a (Pdb) prompt. You must |
|
1336 | 1336 | first enter 'c' (without qoutes) to start execution up to the first |
|
1337 | 1337 | breakpoint. |
|
1338 | 1338 | |
|
1339 | 1339 | Entering 'help' gives information about the use of the debugger. You |
|
1340 | 1340 | can easily see pdb's full documentation with "import pdb;pdb.help()" |
|
1341 | 1341 | at a prompt. |
|
1342 | 1342 | |
|
1343 | 1343 | -p: run program under the control of the Python profiler module (which |
|
1344 | 1344 | prints a detailed report of execution times, function calls, etc). |
|
1345 | 1345 | |
|
1346 | 1346 | You can pass other options after -p which affect the behavior of the |
|
1347 | 1347 | profiler itself. See the docs for %prun for details. |
|
1348 | 1348 | |
|
1349 | 1349 | In this mode, the program's variables do NOT propagate back to the |
|
1350 | 1350 | IPython interactive namespace (because they remain in the namespace |
|
1351 | 1351 | where the profiler executes them). |
|
1352 | 1352 | |
|
1353 | 1353 | Internally this triggers a call to %prun, see its documentation for |
|
1354 | 1354 | details on the options available specifically for profiling. |
|
1355 | 1355 | |
|
1356 | 1356 | There is one special usage for which the text above doesn't apply: |
|
1357 | 1357 | if the filename ends with .ipy, the file is run as ipython script, |
|
1358 | 1358 | just as if the commands were written on IPython prompt. |
|
1359 | 1359 | """ |
|
1360 | 1360 | |
|
1361 | 1361 | # get arguments and set sys.argv for program to be run. |
|
1362 | 1362 | opts,arg_lst = self.parse_options(parameter_s,'nidtN:b:pD:l:rs:T:e', |
|
1363 | 1363 | mode='list',list_all=1) |
|
1364 | 1364 | |
|
1365 | 1365 | try: |
|
1366 | 1366 | filename = get_py_filename(arg_lst[0]) |
|
1367 | 1367 | except IndexError: |
|
1368 | 1368 | warn('you must provide at least a filename.') |
|
1369 | 1369 | print '\n%run:\n',OInspect.getdoc(self.magic_run) |
|
1370 | 1370 | return |
|
1371 | 1371 | except IOError,msg: |
|
1372 | 1372 | error(msg) |
|
1373 | 1373 | return |
|
1374 | 1374 | |
|
1375 | 1375 | if filename.lower().endswith('.ipy'): |
|
1376 | 1376 | self.api.runlines(open(filename).read()) |
|
1377 | 1377 | return |
|
1378 | 1378 | |
|
1379 | 1379 | # Control the response to exit() calls made by the script being run |
|
1380 | 1380 | exit_ignore = opts.has_key('e') |
|
1381 | 1381 | |
|
1382 | 1382 | # Make sure that the running script gets a proper sys.argv as if it |
|
1383 | 1383 | # were run from a system shell. |
|
1384 | 1384 | save_argv = sys.argv # save it for later restoring |
|
1385 | 1385 | sys.argv = [filename]+ arg_lst[1:] # put in the proper filename |
|
1386 | 1386 | |
|
1387 | 1387 | if opts.has_key('i'): |
|
1388 | 1388 | prog_ns = self.shell.user_ns |
|
1389 | 1389 | __name__save = self.shell.user_ns['__name__'] |
|
1390 | 1390 | prog_ns['__name__'] = '__main__' |
|
1391 | 1391 | else: |
|
1392 | 1392 | if opts.has_key('n'): |
|
1393 | 1393 | name = os.path.splitext(os.path.basename(filename))[0] |
|
1394 | 1394 | else: |
|
1395 | 1395 | name = '__main__' |
|
1396 | 1396 | prog_ns = {'__name__':name} |
|
1397 | 1397 | |
|
1398 | 1398 | # Since '%run foo' emulates 'python foo.py' at the cmd line, we must |
|
1399 | 1399 | # set the __file__ global in the script's namespace |
|
1400 | 1400 | prog_ns['__file__'] = filename |
|
1401 | 1401 | |
|
1402 | 1402 | # pickle fix. See iplib for an explanation. But we need to make sure |
|
1403 | 1403 | # that, if we overwrite __main__, we replace it at the end |
|
1404 | 1404 | if prog_ns['__name__'] == '__main__': |
|
1405 | 1405 | restore_main = sys.modules['__main__'] |
|
1406 | 1406 | else: |
|
1407 | 1407 | restore_main = False |
|
1408 | 1408 | |
|
1409 | 1409 | sys.modules[prog_ns['__name__']] = FakeModule(prog_ns) |
|
1410 | 1410 | |
|
1411 | 1411 | stats = None |
|
1412 | 1412 | try: |
|
1413 | 1413 | if self.shell.has_readline: |
|
1414 | 1414 | self.shell.savehist() |
|
1415 | 1415 | |
|
1416 | 1416 | if opts.has_key('p'): |
|
1417 | 1417 | stats = self.magic_prun('',0,opts,arg_lst,prog_ns) |
|
1418 | 1418 | else: |
|
1419 | 1419 | if opts.has_key('d'): |
|
1420 | 1420 | deb = Debugger.Pdb(self.shell.rc.colors) |
|
1421 | 1421 | # reset Breakpoint state, which is moronically kept |
|
1422 | 1422 | # in a class |
|
1423 | 1423 | bdb.Breakpoint.next = 1 |
|
1424 | 1424 | bdb.Breakpoint.bplist = {} |
|
1425 | 1425 | bdb.Breakpoint.bpbynumber = [None] |
|
1426 | 1426 | # Set an initial breakpoint to stop execution |
|
1427 | 1427 | maxtries = 10 |
|
1428 | 1428 | bp = int(opts.get('b',[1])[0]) |
|
1429 | 1429 | checkline = deb.checkline(filename,bp) |
|
1430 | 1430 | if not checkline: |
|
1431 | 1431 | for bp in range(bp+1,bp+maxtries+1): |
|
1432 | 1432 | if deb.checkline(filename,bp): |
|
1433 | 1433 | break |
|
1434 | 1434 | else: |
|
1435 | 1435 | msg = ("\nI failed to find a valid line to set " |
|
1436 | 1436 | "a breakpoint\n" |
|
1437 | 1437 | "after trying up to line: %s.\n" |
|
1438 | 1438 | "Please set a valid breakpoint manually " |
|
1439 | 1439 | "with the -b option." % bp) |
|
1440 | 1440 | error(msg) |
|
1441 | 1441 | return |
|
1442 | 1442 | # if we find a good linenumber, set the breakpoint |
|
1443 | 1443 | deb.do_break('%s:%s' % (filename,bp)) |
|
1444 | 1444 | # Start file run |
|
1445 | 1445 | print "NOTE: Enter 'c' at the", |
|
1446 | 1446 | print "%s prompt to start your script." % deb.prompt |
|
1447 | 1447 | try: |
|
1448 | 1448 | deb.run('execfile("%s")' % filename,prog_ns) |
|
1449 | 1449 | |
|
1450 | 1450 | except: |
|
1451 | 1451 | etype, value, tb = sys.exc_info() |
|
1452 | 1452 | # Skip three frames in the traceback: the %run one, |
|
1453 | 1453 | # one inside bdb.py, and the command-line typed by the |
|
1454 | 1454 | # user (run by exec in pdb itself). |
|
1455 | 1455 | self.shell.InteractiveTB(etype,value,tb,tb_offset=3) |
|
1456 | 1456 | else: |
|
1457 | 1457 | if runner is None: |
|
1458 | 1458 | runner = self.shell.safe_execfile |
|
1459 | 1459 | if opts.has_key('t'): |
|
1460 | 1460 | try: |
|
1461 | 1461 | nruns = int(opts['N'][0]) |
|
1462 | 1462 | if nruns < 1: |
|
1463 | 1463 | error('Number of runs must be >=1') |
|
1464 | 1464 | return |
|
1465 | 1465 | except (KeyError): |
|
1466 | 1466 | nruns = 1 |
|
1467 | 1467 | if nruns == 1: |
|
1468 | 1468 | t0 = clock2() |
|
1469 | 1469 | runner(filename,prog_ns,prog_ns, |
|
1470 | 1470 | exit_ignore=exit_ignore) |
|
1471 | 1471 | t1 = clock2() |
|
1472 | 1472 | t_usr = t1[0]-t0[0] |
|
1473 | 1473 | t_sys = t1[1]-t1[1] |
|
1474 | 1474 | print "\nIPython CPU timings (estimated):" |
|
1475 | 1475 | print " User : %10s s." % t_usr |
|
1476 | 1476 | print " System: %10s s." % t_sys |
|
1477 | 1477 | else: |
|
1478 | 1478 | runs = range(nruns) |
|
1479 | 1479 | t0 = clock2() |
|
1480 | 1480 | for nr in runs: |
|
1481 | 1481 | runner(filename,prog_ns,prog_ns, |
|
1482 | 1482 | exit_ignore=exit_ignore) |
|
1483 | 1483 | t1 = clock2() |
|
1484 | 1484 | t_usr = t1[0]-t0[0] |
|
1485 | 1485 | t_sys = t1[1]-t1[1] |
|
1486 | 1486 | print "\nIPython CPU timings (estimated):" |
|
1487 | 1487 | print "Total runs performed:",nruns |
|
1488 | 1488 | print " Times : %10s %10s" % ('Total','Per run') |
|
1489 | 1489 | print " User : %10s s, %10s s." % (t_usr,t_usr/nruns) |
|
1490 | 1490 | print " System: %10s s, %10s s." % (t_sys,t_sys/nruns) |
|
1491 | 1491 | |
|
1492 | 1492 | else: |
|
1493 | 1493 | runner(filename,prog_ns,prog_ns,exit_ignore=exit_ignore) |
|
1494 | 1494 | if opts.has_key('i'): |
|
1495 | 1495 | self.shell.user_ns['__name__'] = __name__save |
|
1496 | 1496 | else: |
|
1497 | 1497 | # update IPython interactive namespace |
|
1498 | 1498 | del prog_ns['__name__'] |
|
1499 | 1499 | self.shell.user_ns.update(prog_ns) |
|
1500 | 1500 | finally: |
|
1501 | 1501 | sys.argv = save_argv |
|
1502 | 1502 | if restore_main: |
|
1503 | 1503 | sys.modules['__main__'] = restore_main |
|
1504 | 1504 | self.shell.reloadhist() |
|
1505 | 1505 | |
|
1506 | 1506 | return stats |
|
1507 | 1507 | |
|
1508 | 1508 | def magic_runlog(self, parameter_s =''): |
|
1509 | 1509 | """Run files as logs. |
|
1510 | 1510 | |
|
1511 | 1511 | Usage:\\ |
|
1512 | 1512 | %runlog file1 file2 ... |
|
1513 | 1513 | |
|
1514 | 1514 | Run the named files (treating them as log files) in sequence inside |
|
1515 | 1515 | the interpreter, and return to the prompt. This is much slower than |
|
1516 | 1516 | %run because each line is executed in a try/except block, but it |
|
1517 | 1517 | allows running files with syntax errors in them. |
|
1518 | 1518 | |
|
1519 | 1519 | Normally IPython will guess when a file is one of its own logfiles, so |
|
1520 | 1520 | you can typically use %run even for logs. This shorthand allows you to |
|
1521 | 1521 | force any file to be treated as a log file.""" |
|
1522 | 1522 | |
|
1523 | 1523 | for f in parameter_s.split(): |
|
1524 | 1524 | self.shell.safe_execfile(f,self.shell.user_ns, |
|
1525 | 1525 | self.shell.user_ns,islog=1) |
|
1526 | 1526 | |
|
1527 | 1527 | def magic_timeit(self, parameter_s =''): |
|
1528 | 1528 | """Time execution of a Python statement or expression |
|
1529 | 1529 | |
|
1530 | 1530 | Usage:\\ |
|
1531 | 1531 | %timeit [-n<N> -r<R> [-t|-c]] statement |
|
1532 | 1532 | |
|
1533 | 1533 | Time execution of a Python statement or expression using the timeit |
|
1534 | 1534 | module. |
|
1535 | 1535 | |
|
1536 | 1536 | Options: |
|
1537 | 1537 | -n<N>: execute the given statement <N> times in a loop. If this value |
|
1538 | 1538 | is not given, a fitting value is chosen. |
|
1539 | 1539 | |
|
1540 | 1540 | -r<R>: repeat the loop iteration <R> times and take the best result. |
|
1541 | 1541 | Default: 3 |
|
1542 | 1542 | |
|
1543 | 1543 | -t: use time.time to measure the time, which is the default on Unix. |
|
1544 | 1544 | This function measures wall time. |
|
1545 | 1545 | |
|
1546 | 1546 | -c: use time.clock to measure the time, which is the default on |
|
1547 | 1547 | Windows and measures wall time. On Unix, resource.getrusage is used |
|
1548 | 1548 | instead and returns the CPU user time. |
|
1549 | 1549 | |
|
1550 | 1550 | -p<P>: use a precision of <P> digits to display the timing result. |
|
1551 | 1551 | Default: 3 |
|
1552 | 1552 | |
|
1553 | 1553 | |
|
1554 | 1554 | Examples:\\ |
|
1555 | 1555 | In [1]: %timeit pass |
|
1556 | 1556 | 10000000 loops, best of 3: 53.3 ns per loop |
|
1557 | 1557 | |
|
1558 | 1558 | In [2]: u = None |
|
1559 | 1559 | |
|
1560 | 1560 | In [3]: %timeit u is None |
|
1561 | 1561 | 10000000 loops, best of 3: 184 ns per loop |
|
1562 | 1562 | |
|
1563 | 1563 | In [4]: %timeit -r 4 u == None |
|
1564 | 1564 | 1000000 loops, best of 4: 242 ns per loop |
|
1565 | 1565 | |
|
1566 | 1566 | In [5]: import time |
|
1567 | 1567 | |
|
1568 | 1568 | In [6]: %timeit -n1 time.sleep(2) |
|
1569 | 1569 | 1 loops, best of 3: 2 s per loop |
|
1570 | 1570 | |
|
1571 | 1571 | |
|
1572 | 1572 | The times reported by %timeit will be slightly higher than those |
|
1573 | 1573 | reported by the timeit.py script when variables are accessed. This is |
|
1574 | 1574 | due to the fact that %timeit executes the statement in the namespace |
|
1575 | 1575 | of the shell, compared with timeit.py, which uses a single setup |
|
1576 | 1576 | statement to import function or create variables. Generally, the bias |
|
1577 | 1577 | does not matter as long as results from timeit.py are not mixed with |
|
1578 | 1578 | those from %timeit.""" |
|
1579 | 1579 | |
|
1580 | 1580 | import timeit |
|
1581 | 1581 | import math |
|
1582 | 1582 | |
|
1583 | 1583 | units = ["s", "ms", "\xc2\xb5s", "ns"] |
|
1584 | 1584 | scaling = [1, 1e3, 1e6, 1e9] |
|
1585 | 1585 | |
|
1586 | 1586 | opts, stmt = self.parse_options(parameter_s,'n:r:tcp:', |
|
1587 | 1587 | posix=False) |
|
1588 | 1588 | if stmt == "": |
|
1589 | 1589 | return |
|
1590 | 1590 | timefunc = timeit.default_timer |
|
1591 | 1591 | number = int(getattr(opts, "n", 0)) |
|
1592 | 1592 | repeat = int(getattr(opts, "r", timeit.default_repeat)) |
|
1593 | 1593 | precision = int(getattr(opts, "p", 3)) |
|
1594 | 1594 | if hasattr(opts, "t"): |
|
1595 | 1595 | timefunc = time.time |
|
1596 | 1596 | if hasattr(opts, "c"): |
|
1597 | 1597 | timefunc = clock |
|
1598 | 1598 | |
|
1599 | 1599 | timer = timeit.Timer(timer=timefunc) |
|
1600 | 1600 | # this code has tight coupling to the inner workings of timeit.Timer, |
|
1601 | 1601 | # but is there a better way to achieve that the code stmt has access |
|
1602 | 1602 | # to the shell namespace? |
|
1603 | 1603 | |
|
1604 | 1604 | src = timeit.template % {'stmt': timeit.reindent(stmt, 8), |
|
1605 | 1605 | 'setup': "pass"} |
|
1606 | 1606 | code = compile(src, "<magic-timeit>", "exec") |
|
1607 | 1607 | ns = {} |
|
1608 | 1608 | exec code in self.shell.user_ns, ns |
|
1609 | 1609 | timer.inner = ns["inner"] |
|
1610 | 1610 | |
|
1611 | 1611 | if number == 0: |
|
1612 | 1612 | # determine number so that 0.2 <= total time < 2.0 |
|
1613 | 1613 | number = 1 |
|
1614 | 1614 | for i in range(1, 10): |
|
1615 | 1615 | number *= 10 |
|
1616 | 1616 | if timer.timeit(number) >= 0.2: |
|
1617 | 1617 | break |
|
1618 | 1618 | |
|
1619 | 1619 | best = min(timer.repeat(repeat, number)) / number |
|
1620 | 1620 | |
|
1621 | 1621 | if best > 0.0: |
|
1622 | 1622 | order = min(-int(math.floor(math.log10(best)) // 3), 3) |
|
1623 | 1623 | else: |
|
1624 | 1624 | order = 3 |
|
1625 | 1625 | print "%d loops, best of %d: %.*g %s per loop" % (number, repeat, |
|
1626 | 1626 | precision, |
|
1627 | 1627 | best * scaling[order], |
|
1628 | 1628 | units[order]) |
|
1629 | 1629 | |
|
1630 | 1630 | def magic_time(self,parameter_s = ''): |
|
1631 | 1631 | """Time execution of a Python statement or expression. |
|
1632 | 1632 | |
|
1633 | 1633 | The CPU and wall clock times are printed, and the value of the |
|
1634 | 1634 | expression (if any) is returned. Note that under Win32, system time |
|
1635 | 1635 | is always reported as 0, since it can not be measured. |
|
1636 | 1636 | |
|
1637 | 1637 | This function provides very basic timing functionality. In Python |
|
1638 | 1638 | 2.3, the timeit module offers more control and sophistication, so this |
|
1639 | 1639 | could be rewritten to use it (patches welcome). |
|
1640 | 1640 | |
|
1641 | 1641 | Some examples: |
|
1642 | 1642 | |
|
1643 | 1643 | In [1]: time 2**128 |
|
1644 | 1644 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1645 | 1645 | Wall time: 0.00 |
|
1646 | 1646 | Out[1]: 340282366920938463463374607431768211456L |
|
1647 | 1647 | |
|
1648 | 1648 | In [2]: n = 1000000 |
|
1649 | 1649 | |
|
1650 | 1650 | In [3]: time sum(range(n)) |
|
1651 | 1651 | CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s |
|
1652 | 1652 | Wall time: 1.37 |
|
1653 | 1653 | Out[3]: 499999500000L |
|
1654 | 1654 | |
|
1655 | 1655 | In [4]: time print 'hello world' |
|
1656 | 1656 | hello world |
|
1657 | 1657 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1658 | 1658 | Wall time: 0.00 |
|
1659 | 1659 | """ |
|
1660 | 1660 | |
|
1661 | 1661 | # fail immediately if the given expression can't be compiled |
|
1662 | 1662 | try: |
|
1663 | 1663 | mode = 'eval' |
|
1664 | 1664 | code = compile(parameter_s,'<timed eval>',mode) |
|
1665 | 1665 | except SyntaxError: |
|
1666 | 1666 | mode = 'exec' |
|
1667 | 1667 | code = compile(parameter_s,'<timed exec>',mode) |
|
1668 | 1668 | # skew measurement as little as possible |
|
1669 | 1669 | glob = self.shell.user_ns |
|
1670 | 1670 | clk = clock2 |
|
1671 | 1671 | wtime = time.time |
|
1672 | 1672 | # time execution |
|
1673 | 1673 | wall_st = wtime() |
|
1674 | 1674 | if mode=='eval': |
|
1675 | 1675 | st = clk() |
|
1676 | 1676 | out = eval(code,glob) |
|
1677 | 1677 | end = clk() |
|
1678 | 1678 | else: |
|
1679 | 1679 | st = clk() |
|
1680 | 1680 | exec code in glob |
|
1681 | 1681 | end = clk() |
|
1682 | 1682 | out = None |
|
1683 | 1683 | wall_end = wtime() |
|
1684 | 1684 | # Compute actual times and report |
|
1685 | 1685 | wall_time = wall_end-wall_st |
|
1686 | 1686 | cpu_user = end[0]-st[0] |
|
1687 | 1687 | cpu_sys = end[1]-st[1] |
|
1688 | 1688 | cpu_tot = cpu_user+cpu_sys |
|
1689 | 1689 | print "CPU times: user %.2f s, sys: %.2f s, total: %.2f s" % \ |
|
1690 | 1690 | (cpu_user,cpu_sys,cpu_tot) |
|
1691 | 1691 | print "Wall time: %.2f" % wall_time |
|
1692 | 1692 | return out |
|
1693 | 1693 | |
|
1694 | 1694 | def magic_macro(self,parameter_s = ''): |
|
1695 | 1695 | """Define a set of input lines as a macro for future re-execution. |
|
1696 | 1696 | |
|
1697 | 1697 | Usage:\\ |
|
1698 | 1698 | %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ... |
|
1699 | 1699 | |
|
1700 | 1700 | Options: |
|
1701 | 1701 | |
|
1702 | 1702 | -r: use 'raw' input. By default, the 'processed' history is used, |
|
1703 | 1703 | so that magics are loaded in their transformed version to valid |
|
1704 | 1704 | Python. If this option is given, the raw input as typed as the |
|
1705 | 1705 | command line is used instead. |
|
1706 | 1706 | |
|
1707 | 1707 | This will define a global variable called `name` which is a string |
|
1708 | 1708 | made of joining the slices and lines you specify (n1,n2,... numbers |
|
1709 | 1709 | above) from your input history into a single string. This variable |
|
1710 | 1710 | acts like an automatic function which re-executes those lines as if |
|
1711 | 1711 | you had typed them. You just type 'name' at the prompt and the code |
|
1712 | 1712 | executes. |
|
1713 | 1713 | |
|
1714 | 1714 | The notation for indicating number ranges is: n1-n2 means 'use line |
|
1715 | 1715 | numbers n1,...n2' (the endpoint is included). That is, '5-7' means |
|
1716 | 1716 | using the lines numbered 5,6 and 7. |
|
1717 | 1717 | |
|
1718 | 1718 | Note: as a 'hidden' feature, you can also use traditional python slice |
|
1719 | 1719 | notation, where N:M means numbers N through M-1. |
|
1720 | 1720 | |
|
1721 | 1721 | For example, if your history contains (%hist prints it): |
|
1722 | 1722 | |
|
1723 | 1723 | 44: x=1\\ |
|
1724 | 1724 | 45: y=3\\ |
|
1725 | 1725 | 46: z=x+y\\ |
|
1726 | 1726 | 47: print x\\ |
|
1727 | 1727 | 48: a=5\\ |
|
1728 | 1728 | 49: print 'x',x,'y',y\\ |
|
1729 | 1729 | |
|
1730 | 1730 | you can create a macro with lines 44 through 47 (included) and line 49 |
|
1731 | 1731 | called my_macro with: |
|
1732 | 1732 | |
|
1733 | 1733 | In [51]: %macro my_macro 44-47 49 |
|
1734 | 1734 | |
|
1735 | 1735 | Now, typing `my_macro` (without quotes) will re-execute all this code |
|
1736 | 1736 | in one pass. |
|
1737 | 1737 | |
|
1738 | 1738 | You don't need to give the line-numbers in order, and any given line |
|
1739 | 1739 | number can appear multiple times. You can assemble macros with any |
|
1740 | 1740 | lines from your input history in any order. |
|
1741 | 1741 | |
|
1742 | 1742 | The macro is a simple object which holds its value in an attribute, |
|
1743 | 1743 | but IPython's display system checks for macros and executes them as |
|
1744 | 1744 | code instead of printing them when you type their name. |
|
1745 | 1745 | |
|
1746 | 1746 | You can view a macro's contents by explicitly printing it with: |
|
1747 | 1747 | |
|
1748 | 1748 | 'print macro_name'. |
|
1749 | 1749 | |
|
1750 | 1750 | For one-off cases which DON'T contain magic function calls in them you |
|
1751 | 1751 | can obtain similar results by explicitly executing slices from your |
|
1752 | 1752 | input history with: |
|
1753 | 1753 | |
|
1754 | 1754 | In [60]: exec In[44:48]+In[49]""" |
|
1755 | 1755 | |
|
1756 | 1756 | opts,args = self.parse_options(parameter_s,'r',mode='list') |
|
1757 | 1757 | if not args: |
|
1758 | 1758 | macs = [k for k,v in self.shell.user_ns.items() if isinstance(v, Macro)] |
|
1759 | 1759 | macs.sort() |
|
1760 | 1760 | return macs |
|
1761 | 1761 | name,ranges = args[0], args[1:] |
|
1762 | 1762 | #print 'rng',ranges # dbg |
|
1763 | 1763 | lines = self.extract_input_slices(ranges,opts.has_key('r')) |
|
1764 | 1764 | macro = Macro(lines) |
|
1765 | 1765 | self.shell.user_ns.update({name:macro}) |
|
1766 | 1766 | print 'Macro `%s` created. To execute, type its name (without quotes).' % name |
|
1767 | 1767 | print 'Macro contents:' |
|
1768 | 1768 | print macro, |
|
1769 | 1769 | |
|
1770 | 1770 | def magic_save(self,parameter_s = ''): |
|
1771 | 1771 | """Save a set of lines to a given filename. |
|
1772 | 1772 | |
|
1773 | 1773 | Usage:\\ |
|
1774 | 1774 | %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ... |
|
1775 | 1775 | |
|
1776 | 1776 | Options: |
|
1777 | 1777 | |
|
1778 | 1778 | -r: use 'raw' input. By default, the 'processed' history is used, |
|
1779 | 1779 | so that magics are loaded in their transformed version to valid |
|
1780 | 1780 | Python. If this option is given, the raw input as typed as the |
|
1781 | 1781 | command line is used instead. |
|
1782 | 1782 | |
|
1783 | 1783 | This function uses the same syntax as %macro for line extraction, but |
|
1784 | 1784 | instead of creating a macro it saves the resulting string to the |
|
1785 | 1785 | filename you specify. |
|
1786 | 1786 | |
|
1787 | 1787 | It adds a '.py' extension to the file if you don't do so yourself, and |
|
1788 | 1788 | it asks for confirmation before overwriting existing files.""" |
|
1789 | 1789 | |
|
1790 | 1790 | opts,args = self.parse_options(parameter_s,'r',mode='list') |
|
1791 | 1791 | fname,ranges = args[0], args[1:] |
|
1792 | 1792 | if not fname.endswith('.py'): |
|
1793 | 1793 | fname += '.py' |
|
1794 | 1794 | if os.path.isfile(fname): |
|
1795 | 1795 | ans = raw_input('File `%s` exists. Overwrite (y/[N])? ' % fname) |
|
1796 | 1796 | if ans.lower() not in ['y','yes']: |
|
1797 | 1797 | print 'Operation cancelled.' |
|
1798 | 1798 | return |
|
1799 | 1799 | cmds = ''.join(self.extract_input_slices(ranges,opts.has_key('r'))) |
|
1800 | 1800 | f = file(fname,'w') |
|
1801 | 1801 | f.write(cmds) |
|
1802 | 1802 | f.close() |
|
1803 | 1803 | print 'The following commands were written to file `%s`:' % fname |
|
1804 | 1804 | print cmds |
|
1805 | 1805 | |
|
1806 | 1806 | def _edit_macro(self,mname,macro): |
|
1807 | 1807 | """open an editor with the macro data in a file""" |
|
1808 | 1808 | filename = self.shell.mktempfile(macro.value) |
|
1809 | 1809 | self.shell.hooks.editor(filename) |
|
1810 | 1810 | |
|
1811 | 1811 | # and make a new macro object, to replace the old one |
|
1812 | 1812 | mfile = open(filename) |
|
1813 | 1813 | mvalue = mfile.read() |
|
1814 | 1814 | mfile.close() |
|
1815 | 1815 | self.shell.user_ns[mname] = Macro(mvalue) |
|
1816 | 1816 | |
|
1817 | 1817 | def magic_ed(self,parameter_s=''): |
|
1818 | 1818 | """Alias to %edit.""" |
|
1819 | 1819 | return self.magic_edit(parameter_s) |
|
1820 | 1820 | |
|
1821 | 1821 | def magic_edit(self,parameter_s='',last_call=['','']): |
|
1822 | 1822 | """Bring up an editor and execute the resulting code. |
|
1823 | 1823 | |
|
1824 | 1824 | Usage: |
|
1825 | 1825 | %edit [options] [args] |
|
1826 | 1826 | |
|
1827 | 1827 | %edit runs IPython's editor hook. The default version of this hook is |
|
1828 | 1828 | set to call the __IPYTHON__.rc.editor command. This is read from your |
|
1829 | 1829 | environment variable $EDITOR. If this isn't found, it will default to |
|
1830 | 1830 | vi under Linux/Unix and to notepad under Windows. See the end of this |
|
1831 | 1831 | docstring for how to change the editor hook. |
|
1832 | 1832 | |
|
1833 | 1833 | You can also set the value of this editor via the command line option |
|
1834 | 1834 | '-editor' or in your ipythonrc file. This is useful if you wish to use |
|
1835 | 1835 | specifically for IPython an editor different from your typical default |
|
1836 | 1836 | (and for Windows users who typically don't set environment variables). |
|
1837 | 1837 | |
|
1838 | 1838 | This command allows you to conveniently edit multi-line code right in |
|
1839 | 1839 | your IPython session. |
|
1840 | 1840 | |
|
1841 | 1841 | If called without arguments, %edit opens up an empty editor with a |
|
1842 | 1842 | temporary file and will execute the contents of this file when you |
|
1843 | 1843 | close it (don't forget to save it!). |
|
1844 | 1844 | |
|
1845 | 1845 | |
|
1846 | 1846 | Options: |
|
1847 | 1847 | |
|
1848 | 1848 | -n <number>: open the editor at a specified line number. By default, |
|
1849 | 1849 | the IPython editor hook uses the unix syntax 'editor +N filename', but |
|
1850 | 1850 | you can configure this by providing your own modified hook if your |
|
1851 | 1851 | favorite editor supports line-number specifications with a different |
|
1852 | 1852 | syntax. |
|
1853 | 1853 | |
|
1854 | 1854 | -p: this will call the editor with the same data as the previous time |
|
1855 | 1855 | it was used, regardless of how long ago (in your current session) it |
|
1856 | 1856 | was. |
|
1857 | 1857 | |
|
1858 | 1858 | -r: use 'raw' input. This option only applies to input taken from the |
|
1859 | 1859 | user's history. By default, the 'processed' history is used, so that |
|
1860 | 1860 | magics are loaded in their transformed version to valid Python. If |
|
1861 | 1861 | this option is given, the raw input as typed as the command line is |
|
1862 | 1862 | used instead. When you exit the editor, it will be executed by |
|
1863 | 1863 | IPython's own processor. |
|
1864 | 1864 | |
|
1865 | 1865 | -x: do not execute the edited code immediately upon exit. This is |
|
1866 | 1866 | mainly useful if you are editing programs which need to be called with |
|
1867 | 1867 | command line arguments, which you can then do using %run. |
|
1868 | 1868 | |
|
1869 | 1869 | |
|
1870 | 1870 | Arguments: |
|
1871 | 1871 | |
|
1872 | 1872 | If arguments are given, the following possibilites exist: |
|
1873 | 1873 | |
|
1874 | 1874 | - The arguments are numbers or pairs of colon-separated numbers (like |
|
1875 | 1875 | 1 4:8 9). These are interpreted as lines of previous input to be |
|
1876 | 1876 | loaded into the editor. The syntax is the same of the %macro command. |
|
1877 | 1877 | |
|
1878 | 1878 | - If the argument doesn't start with a number, it is evaluated as a |
|
1879 | 1879 | variable and its contents loaded into the editor. You can thus edit |
|
1880 | 1880 | any string which contains python code (including the result of |
|
1881 | 1881 | previous edits). |
|
1882 | 1882 | |
|
1883 | 1883 | - If the argument is the name of an object (other than a string), |
|
1884 | 1884 | IPython will try to locate the file where it was defined and open the |
|
1885 | 1885 | editor at the point where it is defined. You can use `%edit function` |
|
1886 | 1886 | to load an editor exactly at the point where 'function' is defined, |
|
1887 | 1887 | edit it and have the file be executed automatically. |
|
1888 | 1888 | |
|
1889 | 1889 | If the object is a macro (see %macro for details), this opens up your |
|
1890 | 1890 | specified editor with a temporary file containing the macro's data. |
|
1891 | 1891 | Upon exit, the macro is reloaded with the contents of the file. |
|
1892 | 1892 | |
|
1893 | 1893 | Note: opening at an exact line is only supported under Unix, and some |
|
1894 | 1894 | editors (like kedit and gedit up to Gnome 2.8) do not understand the |
|
1895 | 1895 | '+NUMBER' parameter necessary for this feature. Good editors like |
|
1896 | 1896 | (X)Emacs, vi, jed, pico and joe all do. |
|
1897 | 1897 | |
|
1898 | 1898 | - If the argument is not found as a variable, IPython will look for a |
|
1899 | 1899 | file with that name (adding .py if necessary) and load it into the |
|
1900 | 1900 | editor. It will execute its contents with execfile() when you exit, |
|
1901 | 1901 | loading any code in the file into your interactive namespace. |
|
1902 | 1902 | |
|
1903 | 1903 | After executing your code, %edit will return as output the code you |
|
1904 | 1904 | typed in the editor (except when it was an existing file). This way |
|
1905 | 1905 | you can reload the code in further invocations of %edit as a variable, |
|
1906 | 1906 | via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of |
|
1907 | 1907 | the output. |
|
1908 | 1908 | |
|
1909 | 1909 | Note that %edit is also available through the alias %ed. |
|
1910 | 1910 | |
|
1911 | 1911 | This is an example of creating a simple function inside the editor and |
|
1912 | 1912 | then modifying it. First, start up the editor: |
|
1913 | 1913 | |
|
1914 | 1914 | In [1]: ed\\ |
|
1915 | 1915 | Editing... done. Executing edited code...\\ |
|
1916 | 1916 | Out[1]: 'def foo():\\n print "foo() was defined in an editing session"\\n' |
|
1917 | 1917 | |
|
1918 | 1918 | We can then call the function foo(): |
|
1919 | 1919 | |
|
1920 | 1920 | In [2]: foo()\\ |
|
1921 | 1921 | foo() was defined in an editing session |
|
1922 | 1922 | |
|
1923 | 1923 | Now we edit foo. IPython automatically loads the editor with the |
|
1924 | 1924 | (temporary) file where foo() was previously defined: |
|
1925 | 1925 | |
|
1926 | 1926 | In [3]: ed foo\\ |
|
1927 | 1927 | Editing... done. Executing edited code... |
|
1928 | 1928 | |
|
1929 | 1929 | And if we call foo() again we get the modified version: |
|
1930 | 1930 | |
|
1931 | 1931 | In [4]: foo()\\ |
|
1932 | 1932 | foo() has now been changed! |
|
1933 | 1933 | |
|
1934 | 1934 | Here is an example of how to edit a code snippet successive |
|
1935 | 1935 | times. First we call the editor: |
|
1936 | 1936 | |
|
1937 | 1937 | In [8]: ed\\ |
|
1938 | 1938 | Editing... done. Executing edited code...\\ |
|
1939 | 1939 | hello\\ |
|
1940 | 1940 | Out[8]: "print 'hello'\\n" |
|
1941 | 1941 | |
|
1942 | 1942 | Now we call it again with the previous output (stored in _): |
|
1943 | 1943 | |
|
1944 | 1944 | In [9]: ed _\\ |
|
1945 | 1945 | Editing... done. Executing edited code...\\ |
|
1946 | 1946 | hello world\\ |
|
1947 | 1947 | Out[9]: "print 'hello world'\\n" |
|
1948 | 1948 | |
|
1949 | 1949 | Now we call it with the output #8 (stored in _8, also as Out[8]): |
|
1950 | 1950 | |
|
1951 | 1951 | In [10]: ed _8\\ |
|
1952 | 1952 | Editing... done. Executing edited code...\\ |
|
1953 | 1953 | hello again\\ |
|
1954 | 1954 | Out[10]: "print 'hello again'\\n" |
|
1955 | 1955 | |
|
1956 | 1956 | |
|
1957 | 1957 | Changing the default editor hook: |
|
1958 | 1958 | |
|
1959 | 1959 | If you wish to write your own editor hook, you can put it in a |
|
1960 | 1960 | configuration file which you load at startup time. The default hook |
|
1961 | 1961 | is defined in the IPython.hooks module, and you can use that as a |
|
1962 | 1962 | starting example for further modifications. That file also has |
|
1963 | 1963 | general instructions on how to set a new hook for use once you've |
|
1964 | 1964 | defined it.""" |
|
1965 | 1965 | |
|
1966 | 1966 | # FIXME: This function has become a convoluted mess. It needs a |
|
1967 | 1967 | # ground-up rewrite with clean, simple logic. |
|
1968 | 1968 | |
|
1969 | 1969 | def make_filename(arg): |
|
1970 | 1970 | "Make a filename from the given args" |
|
1971 | 1971 | try: |
|
1972 | 1972 | filename = get_py_filename(arg) |
|
1973 | 1973 | except IOError: |
|
1974 | 1974 | if args.endswith('.py'): |
|
1975 | 1975 | filename = arg |
|
1976 | 1976 | else: |
|
1977 | 1977 | filename = None |
|
1978 | 1978 | return filename |
|
1979 | 1979 | |
|
1980 | 1980 | # custom exceptions |
|
1981 | 1981 | class DataIsObject(Exception): pass |
|
1982 | 1982 | |
|
1983 | 1983 | opts,args = self.parse_options(parameter_s,'prxn:') |
|
1984 | 1984 | # Set a few locals from the options for convenience: |
|
1985 | 1985 | opts_p = opts.has_key('p') |
|
1986 | 1986 | opts_r = opts.has_key('r') |
|
1987 | 1987 | |
|
1988 | 1988 | # Default line number value |
|
1989 | 1989 | lineno = opts.get('n',None) |
|
1990 | 1990 | |
|
1991 | 1991 | if opts_p: |
|
1992 | 1992 | args = '_%s' % last_call[0] |
|
1993 | 1993 | if not self.shell.user_ns.has_key(args): |
|
1994 | 1994 | args = last_call[1] |
|
1995 | 1995 | |
|
1996 | 1996 | # use last_call to remember the state of the previous call, but don't |
|
1997 | 1997 | # let it be clobbered by successive '-p' calls. |
|
1998 | 1998 | try: |
|
1999 | 1999 | last_call[0] = self.shell.outputcache.prompt_count |
|
2000 | 2000 | if not opts_p: |
|
2001 | 2001 | last_call[1] = parameter_s |
|
2002 | 2002 | except: |
|
2003 | 2003 | pass |
|
2004 | 2004 | |
|
2005 | 2005 | # by default this is done with temp files, except when the given |
|
2006 | 2006 | # arg is a filename |
|
2007 | 2007 | use_temp = 1 |
|
2008 | 2008 | |
|
2009 | 2009 | if re.match(r'\d',args): |
|
2010 | 2010 | # Mode where user specifies ranges of lines, like in %macro. |
|
2011 | 2011 | # This means that you can't edit files whose names begin with |
|
2012 | 2012 | # numbers this way. Tough. |
|
2013 | 2013 | ranges = args.split() |
|
2014 | 2014 | data = ''.join(self.extract_input_slices(ranges,opts_r)) |
|
2015 | 2015 | elif args.endswith('.py'): |
|
2016 | 2016 | filename = make_filename(args) |
|
2017 | 2017 | data = '' |
|
2018 | 2018 | use_temp = 0 |
|
2019 | 2019 | elif args: |
|
2020 | 2020 | try: |
|
2021 | 2021 | # Load the parameter given as a variable. If not a string, |
|
2022 | 2022 | # process it as an object instead (below) |
|
2023 | 2023 | |
|
2024 | 2024 | #print '*** args',args,'type',type(args) # dbg |
|
2025 | 2025 | data = eval(args,self.shell.user_ns) |
|
2026 | 2026 | if not type(data) in StringTypes: |
|
2027 | 2027 | raise DataIsObject |
|
2028 | 2028 | |
|
2029 | 2029 | except (NameError,SyntaxError): |
|
2030 | 2030 | # given argument is not a variable, try as a filename |
|
2031 | 2031 | filename = make_filename(args) |
|
2032 | 2032 | if filename is None: |
|
2033 | 2033 | warn("Argument given (%s) can't be found as a variable " |
|
2034 | 2034 | "or as a filename." % args) |
|
2035 | 2035 | return |
|
2036 | 2036 | |
|
2037 | 2037 | data = '' |
|
2038 | 2038 | use_temp = 0 |
|
2039 | 2039 | except DataIsObject: |
|
2040 | 2040 | |
|
2041 | 2041 | # macros have a special edit function |
|
2042 | 2042 | if isinstance(data,Macro): |
|
2043 | 2043 | self._edit_macro(args,data) |
|
2044 | 2044 | return |
|
2045 | 2045 | |
|
2046 | 2046 | # For objects, try to edit the file where they are defined |
|
2047 | 2047 | try: |
|
2048 | 2048 | filename = inspect.getabsfile(data) |
|
2049 | 2049 | datafile = 1 |
|
2050 | 2050 | except TypeError: |
|
2051 | 2051 | filename = make_filename(args) |
|
2052 | 2052 | datafile = 1 |
|
2053 | 2053 | warn('Could not find file where `%s` is defined.\n' |
|
2054 | 2054 | 'Opening a file named `%s`' % (args,filename)) |
|
2055 | 2055 | # Now, make sure we can actually read the source (if it was in |
|
2056 | 2056 | # a temp file it's gone by now). |
|
2057 | 2057 | if datafile: |
|
2058 | 2058 | try: |
|
2059 | 2059 | if lineno is None: |
|
2060 | 2060 | lineno = inspect.getsourcelines(data)[1] |
|
2061 | 2061 | except IOError: |
|
2062 | 2062 | filename = make_filename(args) |
|
2063 | 2063 | if filename is None: |
|
2064 | 2064 | warn('The file `%s` where `%s` was defined cannot ' |
|
2065 | 2065 | 'be read.' % (filename,data)) |
|
2066 | 2066 | return |
|
2067 | 2067 | use_temp = 0 |
|
2068 | 2068 | else: |
|
2069 | 2069 | data = '' |
|
2070 | 2070 | |
|
2071 | 2071 | if use_temp: |
|
2072 | 2072 | filename = self.shell.mktempfile(data) |
|
2073 | 2073 | print 'IPython will make a temporary file named:',filename |
|
2074 | 2074 | |
|
2075 | 2075 | # do actual editing here |
|
2076 | 2076 | print 'Editing...', |
|
2077 | 2077 | sys.stdout.flush() |
|
2078 | 2078 | self.shell.hooks.editor(filename,lineno) |
|
2079 | 2079 | if opts.has_key('x'): # -x prevents actual execution |
|
2080 | 2080 | |
|
2081 | 2081 | else: |
|
2082 | 2082 | print 'done. Executing edited code...' |
|
2083 | 2083 | if opts_r: |
|
2084 | 2084 | self.shell.runlines(file_read(filename)) |
|
2085 | 2085 | else: |
|
2086 | 2086 | self.shell.safe_execfile(filename,self.shell.user_ns, |
|
2087 | 2087 | self.shell.user_ns) |
|
2088 | 2088 | if use_temp: |
|
2089 | 2089 | try: |
|
2090 | 2090 | return open(filename).read() |
|
2091 | 2091 | except IOError,msg: |
|
2092 | 2092 | if msg.filename == filename: |
|
2093 | 2093 | warn('File not found. Did you forget to save?') |
|
2094 | 2094 | return |
|
2095 | 2095 | else: |
|
2096 | 2096 | self.shell.showtraceback() |
|
2097 | 2097 | |
|
2098 | 2098 | def magic_xmode(self,parameter_s = ''): |
|
2099 | 2099 | """Switch modes for the exception handlers. |
|
2100 | 2100 | |
|
2101 | 2101 | Valid modes: Plain, Context and Verbose. |
|
2102 | 2102 | |
|
2103 | 2103 | If called without arguments, acts as a toggle.""" |
|
2104 | 2104 | |
|
2105 | 2105 | def xmode_switch_err(name): |
|
2106 | 2106 | warn('Error changing %s exception modes.\n%s' % |
|
2107 | 2107 | (name,sys.exc_info()[1])) |
|
2108 | 2108 | |
|
2109 | 2109 | shell = self.shell |
|
2110 | 2110 | new_mode = parameter_s.strip().capitalize() |
|
2111 | 2111 | try: |
|
2112 | 2112 | shell.InteractiveTB.set_mode(mode=new_mode) |
|
2113 | 2113 | print 'Exception reporting mode:',shell.InteractiveTB.mode |
|
2114 | 2114 | except: |
|
2115 | 2115 | xmode_switch_err('user') |
|
2116 | 2116 | |
|
2117 | 2117 | # threaded shells use a special handler in sys.excepthook |
|
2118 | 2118 | if shell.isthreaded: |
|
2119 | 2119 | try: |
|
2120 | 2120 | shell.sys_excepthook.set_mode(mode=new_mode) |
|
2121 | 2121 | except: |
|
2122 | 2122 | xmode_switch_err('threaded') |
|
2123 | 2123 | |
|
2124 | 2124 | def magic_colors(self,parameter_s = ''): |
|
2125 | 2125 | """Switch color scheme for prompts, info system and exception handlers. |
|
2126 | 2126 | |
|
2127 | 2127 | Currently implemented schemes: NoColor, Linux, LightBG. |
|
2128 | 2128 | |
|
2129 | 2129 | Color scheme names are not case-sensitive.""" |
|
2130 | 2130 | |
|
2131 | 2131 | def color_switch_err(name): |
|
2132 | 2132 | warn('Error changing %s color schemes.\n%s' % |
|
2133 | 2133 | (name,sys.exc_info()[1])) |
|
2134 | 2134 | |
|
2135 | 2135 | |
|
2136 | 2136 | new_scheme = parameter_s.strip() |
|
2137 | 2137 | if not new_scheme: |
|
2138 | 2138 | print 'You must specify a color scheme.' |
|
2139 | 2139 | return |
|
2140 | 2140 | import IPython.rlineimpl as readline |
|
2141 | 2141 | if not readline.have_readline and sys.platform == "win32": |
|
2142 | 2142 | msg = """\ |
|
2143 | 2143 | Proper color support under MS Windows requires the pyreadline library. |
|
2144 | 2144 | You can find it at: |
|
2145 | 2145 | http://ipython.scipy.org/moin/PyReadline/Intro |
|
2146 | 2146 | Gary's readline needs the ctypes module, from: |
|
2147 | 2147 | http://starship.python.net/crew/theller/ctypes |
|
2148 | 2148 | (Note that ctypes is already part of Python versions 2.5 and newer). |
|
2149 | 2149 | |
|
2150 | 2150 | Defaulting color scheme to 'NoColor'""" |
|
2151 | 2151 | new_scheme = 'NoColor' |
|
2152 | 2152 | warn(msg) |
|
2153 | 2153 | # local shortcut |
|
2154 | 2154 | shell = self.shell |
|
2155 | 2155 | |
|
2156 | 2156 | # Set prompt colors |
|
2157 | 2157 | try: |
|
2158 | 2158 | shell.outputcache.set_colors(new_scheme) |
|
2159 | 2159 | except: |
|
2160 | 2160 | color_switch_err('prompt') |
|
2161 | 2161 | else: |
|
2162 | 2162 | shell.rc.colors = \ |
|
2163 | 2163 | shell.outputcache.color_table.active_scheme_name |
|
2164 | 2164 | # Set exception colors |
|
2165 | 2165 | try: |
|
2166 | 2166 | shell.InteractiveTB.set_colors(scheme = new_scheme) |
|
2167 | 2167 | shell.SyntaxTB.set_colors(scheme = new_scheme) |
|
2168 | 2168 | except: |
|
2169 | 2169 | color_switch_err('exception') |
|
2170 | 2170 | |
|
2171 | 2171 | # threaded shells use a verbose traceback in sys.excepthook |
|
2172 | 2172 | if shell.isthreaded: |
|
2173 | 2173 | try: |
|
2174 | 2174 | shell.sys_excepthook.set_colors(scheme=new_scheme) |
|
2175 | 2175 | except: |
|
2176 | 2176 | color_switch_err('system exception handler') |
|
2177 | 2177 | |
|
2178 | 2178 | # Set info (for 'object?') colors |
|
2179 | 2179 | if shell.rc.color_info: |
|
2180 | 2180 | try: |
|
2181 | 2181 | shell.inspector.set_active_scheme(new_scheme) |
|
2182 | 2182 | except: |
|
2183 | 2183 | color_switch_err('object inspector') |
|
2184 | 2184 | else: |
|
2185 | 2185 | shell.inspector.set_active_scheme('NoColor') |
|
2186 | 2186 | |
|
2187 | 2187 | def magic_color_info(self,parameter_s = ''): |
|
2188 | 2188 | """Toggle color_info. |
|
2189 | 2189 | |
|
2190 | 2190 | The color_info configuration parameter controls whether colors are |
|
2191 | 2191 | used for displaying object details (by things like %psource, %pfile or |
|
2192 | 2192 | the '?' system). This function toggles this value with each call. |
|
2193 | 2193 | |
|
2194 | 2194 | Note that unless you have a fairly recent pager (less works better |
|
2195 | 2195 | than more) in your system, using colored object information displays |
|
2196 | 2196 | will not work properly. Test it and see.""" |
|
2197 | 2197 | |
|
2198 | 2198 | self.shell.rc.color_info = 1 - self.shell.rc.color_info |
|
2199 | 2199 | self.magic_colors(self.shell.rc.colors) |
|
2200 | 2200 | print 'Object introspection functions have now coloring:', |
|
2201 | 2201 | print ['OFF','ON'][self.shell.rc.color_info] |
|
2202 | 2202 | |
|
2203 | 2203 | def magic_Pprint(self, parameter_s=''): |
|
2204 | 2204 | """Toggle pretty printing on/off.""" |
|
2205 | 2205 | |
|
2206 | 2206 | self.shell.rc.pprint = 1 - self.shell.rc.pprint |
|
2207 | 2207 | print 'Pretty printing has been turned', \ |
|
2208 | 2208 | ['OFF','ON'][self.shell.rc.pprint] |
|
2209 | 2209 | |
|
2210 | 2210 | def magic_exit(self, parameter_s=''): |
|
2211 | 2211 | """Exit IPython, confirming if configured to do so. |
|
2212 | 2212 | |
|
2213 | 2213 | You can configure whether IPython asks for confirmation upon exit by |
|
2214 | 2214 | setting the confirm_exit flag in the ipythonrc file.""" |
|
2215 | 2215 | |
|
2216 | 2216 | self.shell.exit() |
|
2217 | 2217 | |
|
2218 | 2218 | def magic_quit(self, parameter_s=''): |
|
2219 | 2219 | """Exit IPython, confirming if configured to do so (like %exit)""" |
|
2220 | 2220 | |
|
2221 | 2221 | self.shell.exit() |
|
2222 | 2222 | |
|
2223 | 2223 | def magic_Exit(self, parameter_s=''): |
|
2224 | 2224 | """Exit IPython without confirmation.""" |
|
2225 | 2225 | |
|
2226 | 2226 | self.shell.exit_now = True |
|
2227 | 2227 | |
|
2228 | 2228 | #...................................................................... |
|
2229 | 2229 | # Functions to implement unix shell-type things |
|
2230 | 2230 | |
|
2231 | 2231 | def magic_alias(self, parameter_s = ''): |
|
2232 | 2232 | """Define an alias for a system command. |
|
2233 | 2233 | |
|
2234 | 2234 | '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd' |
|
2235 | 2235 | |
|
2236 | 2236 | Then, typing 'alias_name params' will execute the system command 'cmd |
|
2237 | 2237 | params' (from your underlying operating system). |
|
2238 | 2238 | |
|
2239 | 2239 | Aliases have lower precedence than magic functions and Python normal |
|
2240 | 2240 | variables, so if 'foo' is both a Python variable and an alias, the |
|
2241 | 2241 | alias can not be executed until 'del foo' removes the Python variable. |
|
2242 | 2242 | |
|
2243 | 2243 | You can use the %l specifier in an alias definition to represent the |
|
2244 | 2244 | whole line when the alias is called. For example: |
|
2245 | 2245 | |
|
2246 | 2246 | In [2]: alias all echo "Input in brackets: <%l>"\\ |
|
2247 | 2247 | In [3]: all hello world\\ |
|
2248 | 2248 | Input in brackets: <hello world> |
|
2249 | 2249 | |
|
2250 | 2250 | You can also define aliases with parameters using %s specifiers (one |
|
2251 | 2251 | per parameter): |
|
2252 | 2252 | |
|
2253 | 2253 | In [1]: alias parts echo first %s second %s\\ |
|
2254 | 2254 | In [2]: %parts A B\\ |
|
2255 | 2255 | first A second B\\ |
|
2256 | 2256 | In [3]: %parts A\\ |
|
2257 | 2257 | Incorrect number of arguments: 2 expected.\\ |
|
2258 | 2258 | parts is an alias to: 'echo first %s second %s' |
|
2259 | 2259 | |
|
2260 | 2260 | Note that %l and %s are mutually exclusive. You can only use one or |
|
2261 | 2261 | the other in your aliases. |
|
2262 | 2262 | |
|
2263 | 2263 | Aliases expand Python variables just like system calls using ! or !! |
|
2264 | 2264 | do: all expressions prefixed with '$' get expanded. For details of |
|
2265 | 2265 | the semantic rules, see PEP-215: |
|
2266 | 2266 | http://www.python.org/peps/pep-0215.html. This is the library used by |
|
2267 | 2267 | IPython for variable expansion. If you want to access a true shell |
|
2268 | 2268 | variable, an extra $ is necessary to prevent its expansion by IPython: |
|
2269 | 2269 | |
|
2270 | 2270 | In [6]: alias show echo\\ |
|
2271 | 2271 | In [7]: PATH='A Python string'\\ |
|
2272 | 2272 | In [8]: show $PATH\\ |
|
2273 | 2273 | A Python string\\ |
|
2274 | 2274 | In [9]: show $$PATH\\ |
|
2275 | 2275 | /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:... |
|
2276 | 2276 | |
|
2277 | 2277 | You can use the alias facility to acess all of $PATH. See the %rehash |
|
2278 | 2278 | and %rehashx functions, which automatically create aliases for the |
|
2279 | 2279 | contents of your $PATH. |
|
2280 | 2280 | |
|
2281 | 2281 | If called with no parameters, %alias prints the current alias table.""" |
|
2282 | 2282 | |
|
2283 | 2283 | par = parameter_s.strip() |
|
2284 | 2284 | if not par: |
|
2285 | 2285 | stored = self.db.get('stored_aliases', {} ) |
|
2286 | 2286 | atab = self.shell.alias_table |
|
2287 | 2287 | aliases = atab.keys() |
|
2288 | 2288 | aliases.sort() |
|
2289 | 2289 | res = [] |
|
2290 | 2290 | showlast = [] |
|
2291 | 2291 | for alias in aliases: |
|
2292 |
t |
|
|
2292 | try: | |
|
2293 | tgt = atab[alias][1] | |
|
2294 | except TypeError: | |
|
2295 | # unsubscriptable? probably a callable | |
|
2296 | tgt = atab[alias] | |
|
2293 | 2297 | # 'interesting' aliases |
|
2294 | 2298 | if (alias in stored or |
|
2295 | 2299 | alias.lower() != os.path.splitext(tgt)[0].lower() or |
|
2296 | 2300 | ' ' in tgt): |
|
2297 | 2301 | showlast.append((alias, tgt)) |
|
2298 | 2302 | else: |
|
2299 | 2303 | res.append((alias, tgt )) |
|
2300 | 2304 | |
|
2301 | 2305 | # show most interesting aliases last |
|
2302 | 2306 | res.extend(showlast) |
|
2303 | 2307 | print "Total number of aliases:",len(aliases) |
|
2304 | 2308 | return res |
|
2305 | 2309 | try: |
|
2306 | 2310 | alias,cmd = par.split(None,1) |
|
2307 | 2311 | except: |
|
2308 | 2312 | print OInspect.getdoc(self.magic_alias) |
|
2309 | 2313 | else: |
|
2310 | 2314 | nargs = cmd.count('%s') |
|
2311 | 2315 | if nargs>0 and cmd.find('%l')>=0: |
|
2312 | 2316 | error('The %s and %l specifiers are mutually exclusive ' |
|
2313 | 2317 | 'in alias definitions.') |
|
2314 | 2318 | else: # all looks OK |
|
2315 | 2319 | self.shell.alias_table[alias] = (nargs,cmd) |
|
2316 | 2320 | self.shell.alias_table_validate(verbose=0) |
|
2317 | 2321 | # end magic_alias |
|
2318 | 2322 | |
|
2319 | 2323 | def magic_unalias(self, parameter_s = ''): |
|
2320 | 2324 | """Remove an alias""" |
|
2321 | 2325 | |
|
2322 | 2326 | aname = parameter_s.strip() |
|
2323 | 2327 | if aname in self.shell.alias_table: |
|
2324 | 2328 | del self.shell.alias_table[aname] |
|
2325 | 2329 | stored = self.db.get('stored_aliases', {} ) |
|
2326 | 2330 | if aname in stored: |
|
2327 | 2331 | print "Removing %stored alias",aname |
|
2328 | 2332 | del stored[aname] |
|
2329 | 2333 | self.db['stored_aliases'] = stored |
|
2330 | 2334 | |
|
2331 | 2335 | |
|
2332 | 2336 | def magic_rehashx(self, parameter_s = ''): |
|
2333 | 2337 | """Update the alias table with all executable files in $PATH. |
|
2334 | 2338 | |
|
2335 | 2339 | This version explicitly checks that every entry in $PATH is a file |
|
2336 | 2340 | with execute access (os.X_OK), so it is much slower than %rehash. |
|
2337 | 2341 | |
|
2338 | 2342 | Under Windows, it checks executability as a match agains a |
|
2339 | 2343 | '|'-separated string of extensions, stored in the IPython config |
|
2340 | 2344 | variable win_exec_ext. This defaults to 'exe|com|bat'. |
|
2341 | 2345 | |
|
2342 | 2346 | This function also resets the root module cache of module completer, |
|
2343 | 2347 | used on slow filesystems. |
|
2344 | 2348 | """ |
|
2345 | 2349 | |
|
2346 | 2350 | |
|
2347 | 2351 | ip = self.api |
|
2348 | 2352 | |
|
2349 | 2353 | # for the benefit of module completer in ipy_completers.py |
|
2350 | 2354 | del ip.db['rootmodules'] |
|
2351 | 2355 | |
|
2352 | 2356 | path = [os.path.abspath(os.path.expanduser(p)) for p in |
|
2353 | 2357 | os.environ.get('PATH','').split(os.pathsep)] |
|
2354 | 2358 | path = filter(os.path.isdir,path) |
|
2355 | 2359 | |
|
2356 | 2360 | alias_table = self.shell.alias_table |
|
2357 | 2361 | syscmdlist = [] |
|
2358 | 2362 | if os.name == 'posix': |
|
2359 | 2363 | isexec = lambda fname:os.path.isfile(fname) and \ |
|
2360 | 2364 | os.access(fname,os.X_OK) |
|
2361 | 2365 | else: |
|
2362 | 2366 | |
|
2363 | 2367 | try: |
|
2364 | 2368 | winext = os.environ['pathext'].replace(';','|').replace('.','') |
|
2365 | 2369 | except KeyError: |
|
2366 | 2370 | winext = 'exe|com|bat|py' |
|
2367 | 2371 | if 'py' not in winext: |
|
2368 | 2372 | winext += '|py' |
|
2369 | 2373 | execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE) |
|
2370 | 2374 | isexec = lambda fname:os.path.isfile(fname) and execre.match(fname) |
|
2371 | 2375 | savedir = os.getcwd() |
|
2372 | 2376 | try: |
|
2373 | 2377 | # write the whole loop for posix/Windows so we don't have an if in |
|
2374 | 2378 | # the innermost part |
|
2375 | 2379 | if os.name == 'posix': |
|
2376 | 2380 | for pdir in path: |
|
2377 | 2381 | os.chdir(pdir) |
|
2378 | 2382 | for ff in os.listdir(pdir): |
|
2379 | 2383 | if isexec(ff) and ff not in self.shell.no_alias: |
|
2380 | 2384 | # each entry in the alias table must be (N,name), |
|
2381 | 2385 | # where N is the number of positional arguments of the |
|
2382 | 2386 | # alias. |
|
2383 | 2387 | alias_table[ff] = (0,ff) |
|
2384 | 2388 | syscmdlist.append(ff) |
|
2385 | 2389 | else: |
|
2386 | 2390 | for pdir in path: |
|
2387 | 2391 | os.chdir(pdir) |
|
2388 | 2392 | for ff in os.listdir(pdir): |
|
2389 | 2393 | base, ext = os.path.splitext(ff) |
|
2390 | 2394 | if isexec(ff) and base not in self.shell.no_alias: |
|
2391 | 2395 | if ext.lower() == '.exe': |
|
2392 | 2396 | ff = base |
|
2393 | 2397 | alias_table[base.lower()] = (0,ff) |
|
2394 | 2398 | syscmdlist.append(ff) |
|
2395 | 2399 | # Make sure the alias table doesn't contain keywords or builtins |
|
2396 | 2400 | self.shell.alias_table_validate() |
|
2397 | 2401 | # Call again init_auto_alias() so we get 'rm -i' and other |
|
2398 | 2402 | # modified aliases since %rehashx will probably clobber them |
|
2399 | 2403 | |
|
2400 | 2404 | # no, we don't want them. if %rehashx clobbers them, good, |
|
2401 | 2405 | # we'll probably get better versions |
|
2402 | 2406 | # self.shell.init_auto_alias() |
|
2403 | 2407 | db = ip.db |
|
2404 | 2408 | db['syscmdlist'] = syscmdlist |
|
2405 | 2409 | finally: |
|
2406 | 2410 | os.chdir(savedir) |
|
2407 | 2411 | |
|
2408 | 2412 | def magic_pwd(self, parameter_s = ''): |
|
2409 | 2413 | """Return the current working directory path.""" |
|
2410 | 2414 | return os.getcwd() |
|
2411 | 2415 | |
|
2412 | 2416 | def magic_cd(self, parameter_s=''): |
|
2413 | 2417 | """Change the current working directory. |
|
2414 | 2418 | |
|
2415 | 2419 | This command automatically maintains an internal list of directories |
|
2416 | 2420 | you visit during your IPython session, in the variable _dh. The |
|
2417 | 2421 | command %dhist shows this history nicely formatted. You can also |
|
2418 | 2422 | do 'cd -<tab>' to see directory history conveniently. |
|
2419 | 2423 | |
|
2420 | 2424 | Usage: |
|
2421 | 2425 | |
|
2422 | 2426 | cd 'dir': changes to directory 'dir'. |
|
2423 | 2427 | |
|
2424 | 2428 | cd -: changes to the last visited directory. |
|
2425 | 2429 | |
|
2426 | 2430 | cd -<n>: changes to the n-th directory in the directory history. |
|
2427 | 2431 | |
|
2428 | 2432 | cd -b <bookmark_name>: jump to a bookmark set by %bookmark |
|
2429 | 2433 | (note: cd <bookmark_name> is enough if there is no |
|
2430 | 2434 | directory <bookmark_name>, but a bookmark with the name exists.) |
|
2431 | 2435 | 'cd -b <tab>' allows you to tab-complete bookmark names. |
|
2432 | 2436 | |
|
2433 | 2437 | Options: |
|
2434 | 2438 | |
|
2435 | 2439 | -q: quiet. Do not print the working directory after the cd command is |
|
2436 | 2440 | executed. By default IPython's cd command does print this directory, |
|
2437 | 2441 | since the default prompts do not display path information. |
|
2438 | 2442 | |
|
2439 | 2443 | Note that !cd doesn't work for this purpose because the shell where |
|
2440 | 2444 | !command runs is immediately discarded after executing 'command'.""" |
|
2441 | 2445 | |
|
2442 | 2446 | parameter_s = parameter_s.strip() |
|
2443 | 2447 | #bkms = self.shell.persist.get("bookmarks",{}) |
|
2444 | 2448 | |
|
2445 | 2449 | numcd = re.match(r'(-)(\d+)$',parameter_s) |
|
2446 | 2450 | # jump in directory history by number |
|
2447 | 2451 | if numcd: |
|
2448 | 2452 | nn = int(numcd.group(2)) |
|
2449 | 2453 | try: |
|
2450 | 2454 | ps = self.shell.user_ns['_dh'][nn] |
|
2451 | 2455 | except IndexError: |
|
2452 | 2456 | print 'The requested directory does not exist in history.' |
|
2453 | 2457 | return |
|
2454 | 2458 | else: |
|
2455 | 2459 | opts = {} |
|
2456 | 2460 | else: |
|
2457 | 2461 | #turn all non-space-escaping backslashes to slashes, |
|
2458 | 2462 | # for c:\windows\directory\names\ |
|
2459 | 2463 | parameter_s = re.sub(r'\\(?! )','/', parameter_s) |
|
2460 | 2464 | opts,ps = self.parse_options(parameter_s,'qb',mode='string') |
|
2461 | 2465 | # jump to previous |
|
2462 | 2466 | if ps == '-': |
|
2463 | 2467 | try: |
|
2464 | 2468 | ps = self.shell.user_ns['_dh'][-2] |
|
2465 | 2469 | except IndexError: |
|
2466 | 2470 | print 'No previous directory to change to.' |
|
2467 | 2471 | return |
|
2468 | 2472 | # jump to bookmark if needed |
|
2469 | 2473 | else: |
|
2470 | 2474 | if not os.path.isdir(ps) or opts.has_key('b'): |
|
2471 | 2475 | bkms = self.db.get('bookmarks', {}) |
|
2472 | 2476 | |
|
2473 | 2477 | if bkms.has_key(ps): |
|
2474 | 2478 | target = bkms[ps] |
|
2475 | 2479 | print '(bookmark:%s) -> %s' % (ps,target) |
|
2476 | 2480 | ps = target |
|
2477 | 2481 | else: |
|
2478 | 2482 | if opts.has_key('b'): |
|
2479 | 2483 | error("Bookmark '%s' not found. " |
|
2480 | 2484 | "Use '%%bookmark -l' to see your bookmarks." % ps) |
|
2481 | 2485 | return |
|
2482 | 2486 | |
|
2483 | 2487 | # at this point ps should point to the target dir |
|
2484 | 2488 | if ps: |
|
2485 | 2489 | try: |
|
2486 | 2490 | os.chdir(os.path.expanduser(ps)) |
|
2487 | 2491 | if self.shell.rc.term_title: |
|
2488 | 2492 | #print 'set term title:',self.shell.rc.term_title # dbg |
|
2489 | 2493 | ttitle = ("IPy:" + ( |
|
2490 | 2494 | os.getcwd() == '/' and '/' or \ |
|
2491 | 2495 | os.path.basename(os.getcwd()))) |
|
2492 | 2496 | platutils.set_term_title(ttitle) |
|
2493 | 2497 | except OSError: |
|
2494 | 2498 | print sys.exc_info()[1] |
|
2495 | 2499 | else: |
|
2496 | 2500 | cwd = os.getcwd() |
|
2497 | 2501 | dhist = self.shell.user_ns['_dh'] |
|
2498 | 2502 | dhist.append(cwd) |
|
2499 | 2503 | self.db['dhist'] = compress_dhist(dhist)[-100:] |
|
2500 | 2504 | |
|
2501 | 2505 | else: |
|
2502 | 2506 | os.chdir(self.shell.home_dir) |
|
2503 | 2507 | if self.shell.rc.term_title: |
|
2504 | 2508 | platutils.set_term_title("IPy:~") |
|
2505 | 2509 | cwd = os.getcwd() |
|
2506 | 2510 | dhist = self.shell.user_ns['_dh'] |
|
2507 | 2511 | dhist.append(cwd) |
|
2508 | 2512 | self.db['dhist'] = compress_dhist(dhist)[-100:] |
|
2509 | 2513 | if not 'q' in opts: |
|
2510 | 2514 | print self.shell.user_ns['_dh'][-1] |
|
2511 | 2515 | |
|
2512 | 2516 | |
|
2513 | 2517 | def magic_env(self, parameter_s=''): |
|
2514 | 2518 | """List environment variables.""" |
|
2515 | 2519 | |
|
2516 | 2520 | return os.environ.data |
|
2517 | 2521 | |
|
2518 | 2522 | def magic_pushd(self, parameter_s=''): |
|
2519 | 2523 | """Place the current dir on stack and change directory. |
|
2520 | 2524 | |
|
2521 | 2525 | Usage:\\ |
|
2522 | 2526 | %pushd ['dirname'] |
|
2523 | 2527 | |
|
2524 | 2528 | %pushd with no arguments does a %pushd to your home directory. |
|
2525 | 2529 | """ |
|
2526 | 2530 | if parameter_s == '': parameter_s = '~' |
|
2527 | 2531 | dir_s = self.shell.dir_stack |
|
2528 | 2532 | if len(dir_s)>0 and os.path.expanduser(parameter_s) != \ |
|
2529 | 2533 | os.path.expanduser(self.shell.dir_stack[0]): |
|
2530 | 2534 | try: |
|
2531 | 2535 | self.magic_cd(parameter_s) |
|
2532 | 2536 | dir_s.insert(0,os.getcwd().replace(self.home_dir,'~')) |
|
2533 | 2537 | self.magic_dirs() |
|
2534 | 2538 | except: |
|
2535 | 2539 | print 'Invalid directory' |
|
2536 | 2540 | else: |
|
2537 | 2541 | print 'You are already there!' |
|
2538 | 2542 | |
|
2539 | 2543 | def magic_popd(self, parameter_s=''): |
|
2540 | 2544 | """Change to directory popped off the top of the stack. |
|
2541 | 2545 | """ |
|
2542 | 2546 | if len (self.shell.dir_stack) > 1: |
|
2543 | 2547 | self.shell.dir_stack.pop(0) |
|
2544 | 2548 | self.magic_cd(self.shell.dir_stack[0]) |
|
2545 | 2549 | print self.shell.dir_stack[0] |
|
2546 | 2550 | else: |
|
2547 | 2551 | print "You can't remove the starting directory from the stack:",\ |
|
2548 | 2552 | self.shell.dir_stack |
|
2549 | 2553 | |
|
2550 | 2554 | def magic_dirs(self, parameter_s=''): |
|
2551 | 2555 | """Return the current directory stack.""" |
|
2552 | 2556 | |
|
2553 | 2557 | return self.shell.dir_stack[:] |
|
2554 | 2558 | |
|
2555 | 2559 | def magic_sc(self, parameter_s=''): |
|
2556 | 2560 | """Shell capture - execute a shell command and capture its output. |
|
2557 | 2561 | |
|
2558 | 2562 | DEPRECATED. Suboptimal, retained for backwards compatibility. |
|
2559 | 2563 | |
|
2560 | 2564 | You should use the form 'var = !command' instead. Example: |
|
2561 | 2565 | |
|
2562 | 2566 | "%sc -l myfiles = ls ~" should now be written as |
|
2563 | 2567 | |
|
2564 | 2568 | "myfiles = !ls ~" |
|
2565 | 2569 | |
|
2566 | 2570 | myfiles.s, myfiles.l and myfiles.n still apply as documented |
|
2567 | 2571 | below. |
|
2568 | 2572 | |
|
2569 | 2573 | -- |
|
2570 | 2574 | %sc [options] varname=command |
|
2571 | 2575 | |
|
2572 | 2576 | IPython will run the given command using commands.getoutput(), and |
|
2573 | 2577 | will then update the user's interactive namespace with a variable |
|
2574 | 2578 | called varname, containing the value of the call. Your command can |
|
2575 | 2579 | contain shell wildcards, pipes, etc. |
|
2576 | 2580 | |
|
2577 | 2581 | The '=' sign in the syntax is mandatory, and the variable name you |
|
2578 | 2582 | supply must follow Python's standard conventions for valid names. |
|
2579 | 2583 | |
|
2580 | 2584 | (A special format without variable name exists for internal use) |
|
2581 | 2585 | |
|
2582 | 2586 | Options: |
|
2583 | 2587 | |
|
2584 | 2588 | -l: list output. Split the output on newlines into a list before |
|
2585 | 2589 | assigning it to the given variable. By default the output is stored |
|
2586 | 2590 | as a single string. |
|
2587 | 2591 | |
|
2588 | 2592 | -v: verbose. Print the contents of the variable. |
|
2589 | 2593 | |
|
2590 | 2594 | In most cases you should not need to split as a list, because the |
|
2591 | 2595 | returned value is a special type of string which can automatically |
|
2592 | 2596 | provide its contents either as a list (split on newlines) or as a |
|
2593 | 2597 | space-separated string. These are convenient, respectively, either |
|
2594 | 2598 | for sequential processing or to be passed to a shell command. |
|
2595 | 2599 | |
|
2596 | 2600 | For example: |
|
2597 | 2601 | |
|
2598 | 2602 | # Capture into variable a |
|
2599 | 2603 | In [9]: sc a=ls *py |
|
2600 | 2604 | |
|
2601 | 2605 | # a is a string with embedded newlines |
|
2602 | 2606 | In [10]: a |
|
2603 | 2607 | Out[10]: 'setup.py\nwin32_manual_post_install.py' |
|
2604 | 2608 | |
|
2605 | 2609 | # which can be seen as a list: |
|
2606 | 2610 | In [11]: a.l |
|
2607 | 2611 | Out[11]: ['setup.py', 'win32_manual_post_install.py'] |
|
2608 | 2612 | |
|
2609 | 2613 | # or as a whitespace-separated string: |
|
2610 | 2614 | In [12]: a.s |
|
2611 | 2615 | Out[12]: 'setup.py win32_manual_post_install.py' |
|
2612 | 2616 | |
|
2613 | 2617 | # a.s is useful to pass as a single command line: |
|
2614 | 2618 | In [13]: !wc -l $a.s |
|
2615 | 2619 | 146 setup.py |
|
2616 | 2620 | 130 win32_manual_post_install.py |
|
2617 | 2621 | 276 total |
|
2618 | 2622 | |
|
2619 | 2623 | # while the list form is useful to loop over: |
|
2620 | 2624 | In [14]: for f in a.l: |
|
2621 | 2625 | ....: !wc -l $f |
|
2622 | 2626 | ....: |
|
2623 | 2627 | 146 setup.py |
|
2624 | 2628 | 130 win32_manual_post_install.py |
|
2625 | 2629 | |
|
2626 | 2630 | Similiarly, the lists returned by the -l option are also special, in |
|
2627 | 2631 | the sense that you can equally invoke the .s attribute on them to |
|
2628 | 2632 | automatically get a whitespace-separated string from their contents: |
|
2629 | 2633 | |
|
2630 | 2634 | In [1]: sc -l b=ls *py |
|
2631 | 2635 | |
|
2632 | 2636 | In [2]: b |
|
2633 | 2637 | Out[2]: ['setup.py', 'win32_manual_post_install.py'] |
|
2634 | 2638 | |
|
2635 | 2639 | In [3]: b.s |
|
2636 | 2640 | Out[3]: 'setup.py win32_manual_post_install.py' |
|
2637 | 2641 | |
|
2638 | 2642 | In summary, both the lists and strings used for ouptut capture have |
|
2639 | 2643 | the following special attributes: |
|
2640 | 2644 | |
|
2641 | 2645 | .l (or .list) : value as list. |
|
2642 | 2646 | .n (or .nlstr): value as newline-separated string. |
|
2643 | 2647 | .s (or .spstr): value as space-separated string. |
|
2644 | 2648 | """ |
|
2645 | 2649 | |
|
2646 | 2650 | opts,args = self.parse_options(parameter_s,'lv') |
|
2647 | 2651 | # Try to get a variable name and command to run |
|
2648 | 2652 | try: |
|
2649 | 2653 | # the variable name must be obtained from the parse_options |
|
2650 | 2654 | # output, which uses shlex.split to strip options out. |
|
2651 | 2655 | var,_ = args.split('=',1) |
|
2652 | 2656 | var = var.strip() |
|
2653 | 2657 | # But the the command has to be extracted from the original input |
|
2654 | 2658 | # parameter_s, not on what parse_options returns, to avoid the |
|
2655 | 2659 | # quote stripping which shlex.split performs on it. |
|
2656 | 2660 | _,cmd = parameter_s.split('=',1) |
|
2657 | 2661 | except ValueError: |
|
2658 | 2662 | var,cmd = '','' |
|
2659 | 2663 | # If all looks ok, proceed |
|
2660 | 2664 | out,err = self.shell.getoutputerror(cmd) |
|
2661 | 2665 | if err: |
|
2662 | 2666 | print >> Term.cerr,err |
|
2663 | 2667 | if opts.has_key('l'): |
|
2664 | 2668 | out = SList(out.split('\n')) |
|
2665 | 2669 | else: |
|
2666 | 2670 | out = LSString(out) |
|
2667 | 2671 | if opts.has_key('v'): |
|
2668 | 2672 | print '%s ==\n%s' % (var,pformat(out)) |
|
2669 | 2673 | if var: |
|
2670 | 2674 | self.shell.user_ns.update({var:out}) |
|
2671 | 2675 | else: |
|
2672 | 2676 | return out |
|
2673 | 2677 | |
|
2674 | 2678 | def magic_sx(self, parameter_s=''): |
|
2675 | 2679 | """Shell execute - run a shell command and capture its output. |
|
2676 | 2680 | |
|
2677 | 2681 | %sx command |
|
2678 | 2682 | |
|
2679 | 2683 | IPython will run the given command using commands.getoutput(), and |
|
2680 | 2684 | return the result formatted as a list (split on '\\n'). Since the |
|
2681 | 2685 | output is _returned_, it will be stored in ipython's regular output |
|
2682 | 2686 | cache Out[N] and in the '_N' automatic variables. |
|
2683 | 2687 | |
|
2684 | 2688 | Notes: |
|
2685 | 2689 | |
|
2686 | 2690 | 1) If an input line begins with '!!', then %sx is automatically |
|
2687 | 2691 | invoked. That is, while: |
|
2688 | 2692 | !ls |
|
2689 | 2693 | causes ipython to simply issue system('ls'), typing |
|
2690 | 2694 | !!ls |
|
2691 | 2695 | is a shorthand equivalent to: |
|
2692 | 2696 | %sx ls |
|
2693 | 2697 | |
|
2694 | 2698 | 2) %sx differs from %sc in that %sx automatically splits into a list, |
|
2695 | 2699 | like '%sc -l'. The reason for this is to make it as easy as possible |
|
2696 | 2700 | to process line-oriented shell output via further python commands. |
|
2697 | 2701 | %sc is meant to provide much finer control, but requires more |
|
2698 | 2702 | typing. |
|
2699 | 2703 | |
|
2700 | 2704 | 3) Just like %sc -l, this is a list with special attributes: |
|
2701 | 2705 | |
|
2702 | 2706 | .l (or .list) : value as list. |
|
2703 | 2707 | .n (or .nlstr): value as newline-separated string. |
|
2704 | 2708 | .s (or .spstr): value as whitespace-separated string. |
|
2705 | 2709 | |
|
2706 | 2710 | This is very useful when trying to use such lists as arguments to |
|
2707 | 2711 | system commands.""" |
|
2708 | 2712 | |
|
2709 | 2713 | if parameter_s: |
|
2710 | 2714 | out,err = self.shell.getoutputerror(parameter_s) |
|
2711 | 2715 | if err: |
|
2712 | 2716 | print >> Term.cerr,err |
|
2713 | 2717 | return SList(out.split('\n')) |
|
2714 | 2718 | |
|
2715 | 2719 | def magic_bg(self, parameter_s=''): |
|
2716 | 2720 | """Run a job in the background, in a separate thread. |
|
2717 | 2721 | |
|
2718 | 2722 | For example, |
|
2719 | 2723 | |
|
2720 | 2724 | %bg myfunc(x,y,z=1) |
|
2721 | 2725 | |
|
2722 | 2726 | will execute 'myfunc(x,y,z=1)' in a background thread. As soon as the |
|
2723 | 2727 | execution starts, a message will be printed indicating the job |
|
2724 | 2728 | number. If your job number is 5, you can use |
|
2725 | 2729 | |
|
2726 | 2730 | myvar = jobs.result(5) or myvar = jobs[5].result |
|
2727 | 2731 | |
|
2728 | 2732 | to assign this result to variable 'myvar'. |
|
2729 | 2733 | |
|
2730 | 2734 | IPython has a job manager, accessible via the 'jobs' object. You can |
|
2731 | 2735 | type jobs? to get more information about it, and use jobs.<TAB> to see |
|
2732 | 2736 | its attributes. All attributes not starting with an underscore are |
|
2733 | 2737 | meant for public use. |
|
2734 | 2738 | |
|
2735 | 2739 | In particular, look at the jobs.new() method, which is used to create |
|
2736 | 2740 | new jobs. This magic %bg function is just a convenience wrapper |
|
2737 | 2741 | around jobs.new(), for expression-based jobs. If you want to create a |
|
2738 | 2742 | new job with an explicit function object and arguments, you must call |
|
2739 | 2743 | jobs.new() directly. |
|
2740 | 2744 | |
|
2741 | 2745 | The jobs.new docstring also describes in detail several important |
|
2742 | 2746 | caveats associated with a thread-based model for background job |
|
2743 | 2747 | execution. Type jobs.new? for details. |
|
2744 | 2748 | |
|
2745 | 2749 | You can check the status of all jobs with jobs.status(). |
|
2746 | 2750 | |
|
2747 | 2751 | The jobs variable is set by IPython into the Python builtin namespace. |
|
2748 | 2752 | If you ever declare a variable named 'jobs', you will shadow this |
|
2749 | 2753 | name. You can either delete your global jobs variable to regain |
|
2750 | 2754 | access to the job manager, or make a new name and assign it manually |
|
2751 | 2755 | to the manager (stored in IPython's namespace). For example, to |
|
2752 | 2756 | assign the job manager to the Jobs name, use: |
|
2753 | 2757 | |
|
2754 | 2758 | Jobs = __builtins__.jobs""" |
|
2755 | 2759 | |
|
2756 | 2760 | self.shell.jobs.new(parameter_s,self.shell.user_ns) |
|
2757 | 2761 | |
|
2758 | 2762 | |
|
2759 | 2763 | def magic_bookmark(self, parameter_s=''): |
|
2760 | 2764 | """Manage IPython's bookmark system. |
|
2761 | 2765 | |
|
2762 | 2766 | %bookmark <name> - set bookmark to current dir |
|
2763 | 2767 | %bookmark <name> <dir> - set bookmark to <dir> |
|
2764 | 2768 | %bookmark -l - list all bookmarks |
|
2765 | 2769 | %bookmark -d <name> - remove bookmark |
|
2766 | 2770 | %bookmark -r - remove all bookmarks |
|
2767 | 2771 | |
|
2768 | 2772 | You can later on access a bookmarked folder with: |
|
2769 | 2773 | %cd -b <name> |
|
2770 | 2774 | or simply '%cd <name>' if there is no directory called <name> AND |
|
2771 | 2775 | there is such a bookmark defined. |
|
2772 | 2776 | |
|
2773 | 2777 | Your bookmarks persist through IPython sessions, but they are |
|
2774 | 2778 | associated with each profile.""" |
|
2775 | 2779 | |
|
2776 | 2780 | opts,args = self.parse_options(parameter_s,'drl',mode='list') |
|
2777 | 2781 | if len(args) > 2: |
|
2778 | 2782 | error('You can only give at most two arguments') |
|
2779 | 2783 | return |
|
2780 | 2784 | |
|
2781 | 2785 | bkms = self.db.get('bookmarks',{}) |
|
2782 | 2786 | |
|
2783 | 2787 | if opts.has_key('d'): |
|
2784 | 2788 | try: |
|
2785 | 2789 | todel = args[0] |
|
2786 | 2790 | except IndexError: |
|
2787 | 2791 | error('You must provide a bookmark to delete') |
|
2788 | 2792 | else: |
|
2789 | 2793 | try: |
|
2790 | 2794 | del bkms[todel] |
|
2791 | 2795 | except: |
|
2792 | 2796 | error("Can't delete bookmark '%s'" % todel) |
|
2793 | 2797 | elif opts.has_key('r'): |
|
2794 | 2798 | bkms = {} |
|
2795 | 2799 | elif opts.has_key('l'): |
|
2796 | 2800 | bks = bkms.keys() |
|
2797 | 2801 | bks.sort() |
|
2798 | 2802 | if bks: |
|
2799 | 2803 | size = max(map(len,bks)) |
|
2800 | 2804 | else: |
|
2801 | 2805 | size = 0 |
|
2802 | 2806 | fmt = '%-'+str(size)+'s -> %s' |
|
2803 | 2807 | print 'Current bookmarks:' |
|
2804 | 2808 | for bk in bks: |
|
2805 | 2809 | print fmt % (bk,bkms[bk]) |
|
2806 | 2810 | else: |
|
2807 | 2811 | if not args: |
|
2808 | 2812 | error("You must specify the bookmark name") |
|
2809 | 2813 | elif len(args)==1: |
|
2810 | 2814 | bkms[args[0]] = os.getcwd() |
|
2811 | 2815 | elif len(args)==2: |
|
2812 | 2816 | bkms[args[0]] = args[1] |
|
2813 | 2817 | self.db['bookmarks'] = bkms |
|
2814 | 2818 | |
|
2815 | 2819 | def magic_pycat(self, parameter_s=''): |
|
2816 | 2820 | """Show a syntax-highlighted file through a pager. |
|
2817 | 2821 | |
|
2818 | 2822 | This magic is similar to the cat utility, but it will assume the file |
|
2819 | 2823 | to be Python source and will show it with syntax highlighting. """ |
|
2820 | 2824 | |
|
2821 | 2825 | try: |
|
2822 | 2826 | filename = get_py_filename(parameter_s) |
|
2823 | 2827 | cont = file_read(filename) |
|
2824 | 2828 | except IOError: |
|
2825 | 2829 | try: |
|
2826 | 2830 | cont = eval(parameter_s,self.user_ns) |
|
2827 | 2831 | except NameError: |
|
2828 | 2832 | cont = None |
|
2829 | 2833 | if cont is None: |
|
2830 | 2834 | print "Error: no such file or variable" |
|
2831 | 2835 | return |
|
2832 | 2836 | |
|
2833 | 2837 | page(self.shell.pycolorize(cont), |
|
2834 | 2838 | screen_lines=self.shell.rc.screen_length) |
|
2835 | 2839 | |
|
2836 | 2840 | def magic_cpaste(self, parameter_s=''): |
|
2837 | 2841 | """Allows you to paste & execute a pre-formatted code block from clipboard |
|
2838 | 2842 | |
|
2839 | 2843 | You must terminate the block with '--' (two minus-signs) alone on the |
|
2840 | 2844 | line. You can also provide your own sentinel with '%paste -s %%' ('%%' |
|
2841 | 2845 | is the new sentinel for this operation) |
|
2842 | 2846 | |
|
2843 | 2847 | The block is dedented prior to execution to enable execution of method |
|
2844 | 2848 | definitions. '>' and '+' characters at the beginning of a line are |
|
2845 | 2849 | ignored, to allow pasting directly from e-mails or diff files. The |
|
2846 | 2850 | executed block is also assigned to variable named 'pasted_block' for |
|
2847 | 2851 | later editing with '%edit pasted_block'. |
|
2848 | 2852 | |
|
2849 | 2853 | You can also pass a variable name as an argument, e.g. '%cpaste foo'. |
|
2850 | 2854 | This assigns the pasted block to variable 'foo' as string, without |
|
2851 | 2855 | dedenting or executing it. |
|
2852 | 2856 | |
|
2853 | 2857 | Do not be alarmed by garbled output on Windows (it's a readline bug). |
|
2854 | 2858 | Just press enter and type -- (and press enter again) and the block |
|
2855 | 2859 | will be what was just pasted. |
|
2856 | 2860 | |
|
2857 | 2861 | IPython statements (magics, shell escapes) are not supported (yet). |
|
2858 | 2862 | """ |
|
2859 | 2863 | opts,args = self.parse_options(parameter_s,'s:',mode='string') |
|
2860 | 2864 | par = args.strip() |
|
2861 | 2865 | sentinel = opts.get('s','--') |
|
2862 | 2866 | |
|
2863 | 2867 | from IPython import iplib |
|
2864 | 2868 | lines = [] |
|
2865 | 2869 | print "Pasting code; enter '%s' alone on the line to stop." % sentinel |
|
2866 | 2870 | while 1: |
|
2867 | 2871 | l = iplib.raw_input_original(':') |
|
2868 | 2872 | if l ==sentinel: |
|
2869 | 2873 | break |
|
2870 | 2874 | lines.append(l.lstrip('>').lstrip('+')) |
|
2871 | 2875 | block = "\n".join(lines) + '\n' |
|
2872 | 2876 | #print "block:\n",block |
|
2873 | 2877 | if not par: |
|
2874 | 2878 | b = textwrap.dedent(block) |
|
2875 | 2879 | exec b in self.user_ns |
|
2876 | 2880 | self.user_ns['pasted_block'] = b |
|
2877 | 2881 | else: |
|
2878 | 2882 | self.user_ns[par] = block |
|
2879 | 2883 | print "Block assigned to '%s'" % par |
|
2880 | 2884 | |
|
2881 | 2885 | def magic_quickref(self,arg): |
|
2882 | 2886 | """ Show a quick reference sheet """ |
|
2883 | 2887 | import IPython.usage |
|
2884 | 2888 | qr = IPython.usage.quick_reference + self.magic_magic('-brief') |
|
2885 | 2889 | |
|
2886 | 2890 | page(qr) |
|
2887 | 2891 | |
|
2888 | 2892 | def magic_upgrade(self,arg): |
|
2889 | 2893 | """ Upgrade your IPython installation |
|
2890 | 2894 | |
|
2891 | 2895 | This will copy the config files that don't yet exist in your |
|
2892 | 2896 | ipython dir from the system config dir. Use this after upgrading |
|
2893 | 2897 | IPython if you don't wish to delete your .ipython dir. |
|
2894 | 2898 | |
|
2895 | 2899 | Call with -nolegacy to get rid of ipythonrc* files (recommended for |
|
2896 | 2900 | new users) |
|
2897 | 2901 | |
|
2898 | 2902 | """ |
|
2899 | 2903 | ip = self.getapi() |
|
2900 | 2904 | ipinstallation = path(IPython.__file__).dirname() |
|
2901 | 2905 | upgrade_script = '%s "%s"' % (sys.executable,ipinstallation / 'upgrade_dir.py') |
|
2902 | 2906 | src_config = ipinstallation / 'UserConfig' |
|
2903 | 2907 | userdir = path(ip.options.ipythondir) |
|
2904 | 2908 | cmd = '%s "%s" "%s"' % (upgrade_script, src_config, userdir) |
|
2905 | 2909 | print ">",cmd |
|
2906 | 2910 | shell(cmd) |
|
2907 | 2911 | if arg == '-nolegacy': |
|
2908 | 2912 | legacy = userdir.files('ipythonrc*') |
|
2909 | 2913 | print "Nuking legacy files:",legacy |
|
2910 | 2914 | |
|
2911 | 2915 | [p.remove() for p in legacy] |
|
2912 | 2916 | suffix = (sys.platform == 'win32' and '.ini' or '') |
|
2913 | 2917 | (userdir / ('ipythonrc' + suffix)).write_text('# Empty, see ipy_user_conf.py\n') |
|
2914 | 2918 | |
|
2915 | 2919 | |
|
2916 | 2920 | def magic_doctest_mode(self,parameter_s=''): |
|
2917 | 2921 | """Toggle doctest mode on and off. |
|
2918 | 2922 | |
|
2919 | 2923 | This mode allows you to toggle the prompt behavior between normal |
|
2920 | 2924 | IPython prompts and ones that are as similar to the default IPython |
|
2921 | 2925 | interpreter as possible. |
|
2922 | 2926 | |
|
2923 | 2927 | It also supports the pasting of code snippets that have leading '>>>' |
|
2924 | 2928 | and '...' prompts in them. This means that you can paste doctests from |
|
2925 | 2929 | files or docstrings (even if they have leading whitespace), and the |
|
2926 | 2930 | code will execute correctly. You can then use '%history -tn' to see |
|
2927 | 2931 | the translated history without line numbers; this will give you the |
|
2928 | 2932 | input after removal of all the leading prompts and whitespace, which |
|
2929 | 2933 | can be pasted back into an editor. |
|
2930 | 2934 | |
|
2931 | 2935 | With these features, you can switch into this mode easily whenever you |
|
2932 | 2936 | need to do testing and changes to doctests, without having to leave |
|
2933 | 2937 | your existing IPython session. |
|
2934 | 2938 | """ |
|
2935 | 2939 | |
|
2936 | 2940 | # XXX - Fix this to have cleaner activate/deactivate calls. |
|
2937 | 2941 | from IPython.Extensions import InterpreterPasteInput as ipaste |
|
2938 | 2942 | from IPython.ipstruct import Struct |
|
2939 | 2943 | |
|
2940 | 2944 | # Shorthands |
|
2941 | 2945 | shell = self.shell |
|
2942 | 2946 | oc = shell.outputcache |
|
2943 | 2947 | rc = shell.rc |
|
2944 | 2948 | meta = shell.meta |
|
2945 | 2949 | # dstore is a data store kept in the instance metadata bag to track any |
|
2946 | 2950 | # changes we make, so we can undo them later. |
|
2947 | 2951 | dstore = meta.setdefault('doctest_mode',Struct()) |
|
2948 | 2952 | save_dstore = dstore.setdefault |
|
2949 | 2953 | |
|
2950 | 2954 | # save a few values we'll need to recover later |
|
2951 | 2955 | mode = save_dstore('mode',False) |
|
2952 | 2956 | save_dstore('rc_pprint',rc.pprint) |
|
2953 | 2957 | save_dstore('xmode',shell.InteractiveTB.mode) |
|
2954 | 2958 | save_dstore('rc_separate_in',rc.separate_in) |
|
2955 | 2959 | save_dstore('rc_separate_out',rc.separate_out) |
|
2956 | 2960 | save_dstore('rc_separate_out2',rc.separate_out2) |
|
2957 | 2961 | save_dstore('rc_prompts_pad_left',rc.prompts_pad_left) |
|
2958 | 2962 | |
|
2959 | 2963 | if mode == False: |
|
2960 | 2964 | # turn on |
|
2961 | 2965 | ipaste.activate_prefilter() |
|
2962 | 2966 | |
|
2963 | 2967 | oc.prompt1.p_template = '>>> ' |
|
2964 | 2968 | oc.prompt2.p_template = '... ' |
|
2965 | 2969 | oc.prompt_out.p_template = '' |
|
2966 | 2970 | |
|
2967 | 2971 | oc.prompt1.sep = '\n' |
|
2968 | 2972 | oc.output_sep = '' |
|
2969 | 2973 | oc.output_sep2 = '' |
|
2970 | 2974 | |
|
2971 | 2975 | oc.prompt1.pad_left = oc.prompt2.pad_left = \ |
|
2972 | 2976 | oc.prompt_out.pad_left = False |
|
2973 | 2977 | |
|
2974 | 2978 | rc.pprint = False |
|
2975 | 2979 | |
|
2976 | 2980 | shell.magic_xmode('Plain') |
|
2977 | 2981 | |
|
2978 | 2982 | else: |
|
2979 | 2983 | # turn off |
|
2980 | 2984 | ipaste.deactivate_prefilter() |
|
2981 | 2985 | |
|
2982 | 2986 | oc.prompt1.p_template = rc.prompt_in1 |
|
2983 | 2987 | oc.prompt2.p_template = rc.prompt_in2 |
|
2984 | 2988 | oc.prompt_out.p_template = rc.prompt_out |
|
2985 | 2989 | |
|
2986 | 2990 | oc.prompt1.sep = dstore.rc_separate_in |
|
2987 | 2991 | oc.output_sep = dstore.rc_separate_out |
|
2988 | 2992 | oc.output_sep2 = dstore.rc_separate_out2 |
|
2989 | 2993 | |
|
2990 | 2994 | oc.prompt1.pad_left = oc.prompt2.pad_left = \ |
|
2991 | 2995 | oc.prompt_out.pad_left = dstore.rc_prompts_pad_left |
|
2992 | 2996 | |
|
2993 | 2997 | rc.pprint = dstore.rc_pprint |
|
2994 | 2998 | |
|
2995 | 2999 | shell.magic_xmode(dstore.xmode) |
|
2996 | 3000 | |
|
2997 | 3001 | # Store new mode and inform |
|
2998 | 3002 | dstore.mode = bool(1-int(mode)) |
|
2999 | 3003 | print 'Doctest mode is:', |
|
3000 | 3004 | print ['OFF','ON'][dstore.mode] |
|
3001 | 3005 | |
|
3002 | 3006 | # end Magic |
@@ -1,484 +1,483 b'' | |||
|
1 | 1 | ''' IPython customization API |
|
2 | 2 | |
|
3 | 3 | Your one-stop module for configuring & extending ipython |
|
4 | 4 | |
|
5 | 5 | The API will probably break when ipython 1.0 is released, but so |
|
6 | 6 | will the other configuration method (rc files). |
|
7 | 7 | |
|
8 | 8 | All names prefixed by underscores are for internal use, not part |
|
9 | 9 | of the public api. |
|
10 | 10 | |
|
11 | 11 | Below is an example that you can just put to a module and import from ipython. |
|
12 | 12 | |
|
13 | 13 | A good practice is to install the config script below as e.g. |
|
14 | 14 | |
|
15 | 15 | ~/.ipython/my_private_conf.py |
|
16 | 16 | |
|
17 | 17 | And do |
|
18 | 18 | |
|
19 | 19 | import_mod my_private_conf |
|
20 | 20 | |
|
21 | 21 | in ~/.ipython/ipythonrc |
|
22 | 22 | |
|
23 | 23 | That way the module is imported at startup and you can have all your |
|
24 | 24 | personal configuration (as opposed to boilerplate ipythonrc-PROFILENAME |
|
25 | 25 | stuff) in there. |
|
26 | 26 | |
|
27 | 27 | ----------------------------------------------- |
|
28 | 28 | import IPython.ipapi |
|
29 | 29 | ip = IPython.ipapi.get() |
|
30 | 30 | |
|
31 | 31 | def ankka_f(self, arg): |
|
32 | 32 | print "Ankka",self,"says uppercase:",arg.upper() |
|
33 | 33 | |
|
34 | 34 | ip.expose_magic("ankka",ankka_f) |
|
35 | 35 | |
|
36 | 36 | ip.magic('alias sayhi echo "Testing, hi ok"') |
|
37 | 37 | ip.magic('alias helloworld echo "Hello world"') |
|
38 | 38 | ip.system('pwd') |
|
39 | 39 | |
|
40 | 40 | ip.ex('import re') |
|
41 | 41 | ip.ex(""" |
|
42 | 42 | def funcci(a,b): |
|
43 | 43 | print a+b |
|
44 | 44 | print funcci(3,4) |
|
45 | 45 | """) |
|
46 | 46 | ip.ex("funcci(348,9)") |
|
47 | 47 | |
|
48 | 48 | def jed_editor(self,filename, linenum=None): |
|
49 | 49 | print "Calling my own editor, jed ... via hook!" |
|
50 | 50 | import os |
|
51 | 51 | if linenum is None: linenum = 0 |
|
52 | 52 | os.system('jed +%d %s' % (linenum, filename)) |
|
53 | 53 | print "exiting jed" |
|
54 | 54 | |
|
55 | 55 | ip.set_hook('editor',jed_editor) |
|
56 | 56 | |
|
57 | 57 | o = ip.options |
|
58 | 58 | o.autocall = 2 # FULL autocall mode |
|
59 | 59 | |
|
60 | 60 | print "done!" |
|
61 | 61 | ''' |
|
62 | 62 | |
|
63 | 63 | # stdlib imports |
|
64 | 64 | import __builtin__ |
|
65 | 65 | import sys |
|
66 | 66 | |
|
67 | 67 | # our own |
|
68 | 68 | #from IPython.genutils import warn,error |
|
69 | 69 | |
|
70 | 70 | class TryNext(Exception): |
|
71 | 71 | """Try next hook exception. |
|
72 | 72 | |
|
73 | 73 | Raise this in your hook function to indicate that the next hook handler |
|
74 | 74 | should be used to handle the operation. If you pass arguments to the |
|
75 | 75 | constructor those arguments will be used by the next hook instead of the |
|
76 | 76 | original ones. |
|
77 | 77 | """ |
|
78 | 78 | |
|
79 | 79 | def __init__(self, *args, **kwargs): |
|
80 | 80 | self.args = args |
|
81 | 81 | self.kwargs = kwargs |
|
82 | 82 | |
|
83 | 83 | class IPyAutocall: |
|
84 | 84 | """ Instances of this class are always autocalled |
|
85 | 85 | |
|
86 | 86 | This happens regardless of 'autocall' variable state. Use this to |
|
87 | 87 | develop macro-like mechanisms. |
|
88 | 88 | """ |
|
89 | 89 | |
|
90 | 90 | def set_ip(self,ip): |
|
91 | 91 | """ Will be used to set _ip point to current ipython instance b/f call |
|
92 | 92 | |
|
93 | 93 | Override this method if you don't want this to happen. |
|
94 | 94 | |
|
95 | 95 | """ |
|
96 | 96 | self._ip = ip |
|
97 | 97 | |
|
98 | 98 | |
|
99 | 99 | # contains the most recently instantiated IPApi |
|
100 | 100 | |
|
101 | 101 | class IPythonNotRunning: |
|
102 | 102 | """Dummy do-nothing class. |
|
103 | 103 | |
|
104 | 104 | Instances of this class return a dummy attribute on all accesses, which |
|
105 | 105 | can be called and warns. This makes it easier to write scripts which use |
|
106 | 106 | the ipapi.get() object for informational purposes to operate both with and |
|
107 | 107 | without ipython. Obviously code which uses the ipython object for |
|
108 | 108 | computations will not work, but this allows a wider range of code to |
|
109 | 109 | transparently work whether ipython is being used or not.""" |
|
110 | 110 | |
|
111 | 111 | def __init__(self,warn=True): |
|
112 | 112 | if warn: |
|
113 | 113 | self.dummy = self._dummy_warn |
|
114 | 114 | else: |
|
115 | 115 | self.dummy = self._dummy_silent |
|
116 | 116 | |
|
117 | 117 | def __str__(self): |
|
118 | 118 | return "<IPythonNotRunning>" |
|
119 | 119 | |
|
120 | 120 | __repr__ = __str__ |
|
121 | 121 | |
|
122 | 122 | def __getattr__(self,name): |
|
123 | 123 | return self.dummy |
|
124 | 124 | |
|
125 | 125 | def _dummy_warn(self,*args,**kw): |
|
126 | 126 | """Dummy function, which doesn't do anything but warn.""" |
|
127 | 127 | |
|
128 | 128 | print ("IPython is not running, this is a dummy no-op function") |
|
129 | 129 | |
|
130 | 130 | def _dummy_silent(self,*args,**kw): |
|
131 | 131 | """Dummy function, which doesn't do anything and emits no warnings.""" |
|
132 | 132 | pass |
|
133 | 133 | |
|
134 | 134 | _recent = None |
|
135 | 135 | |
|
136 | 136 | |
|
137 | 137 | def get(allow_dummy=False,dummy_warn=True): |
|
138 | 138 | """Get an IPApi object. |
|
139 | 139 | |
|
140 | 140 | If allow_dummy is true, returns an instance of IPythonNotRunning |
|
141 | 141 | instead of None if not running under IPython. |
|
142 | 142 | |
|
143 | 143 | If dummy_warn is false, the dummy instance will be completely silent. |
|
144 | 144 | |
|
145 | 145 | Running this should be the first thing you do when writing extensions that |
|
146 | 146 | can be imported as normal modules. You can then direct all the |
|
147 | 147 | configuration operations against the returned object. |
|
148 | 148 | """ |
|
149 | 149 | global _recent |
|
150 | 150 | if allow_dummy and not _recent: |
|
151 | 151 | _recent = IPythonNotRunning(dummy_warn) |
|
152 | 152 | return _recent |
|
153 | 153 | |
|
154 | 154 | class IPApi: |
|
155 | 155 | """ The actual API class for configuring IPython |
|
156 | 156 | |
|
157 | 157 | You should do all of the IPython configuration by getting an IPApi object |
|
158 | 158 | with IPython.ipapi.get() and using the attributes and methods of the |
|
159 | 159 | returned object.""" |
|
160 | 160 | |
|
161 | 161 | def __init__(self,ip): |
|
162 | 162 | |
|
163 | 163 | # All attributes exposed here are considered to be the public API of |
|
164 | 164 | # IPython. As needs dictate, some of these may be wrapped as |
|
165 | 165 | # properties. |
|
166 | 166 | |
|
167 | 167 | self.magic = ip.ipmagic |
|
168 | 168 | |
|
169 | 169 | self.system = ip.system |
|
170 | 170 | |
|
171 | 171 | self.set_hook = ip.set_hook |
|
172 | 172 | |
|
173 | 173 | self.set_custom_exc = ip.set_custom_exc |
|
174 | 174 | |
|
175 | 175 | self.user_ns = ip.user_ns |
|
176 | 176 | |
|
177 | 177 | self.set_crash_handler = ip.set_crash_handler |
|
178 | 178 | |
|
179 | 179 | # Session-specific data store, which can be used to store |
|
180 | 180 | # data that should persist through the ipython session. |
|
181 | 181 | self.meta = ip.meta |
|
182 | 182 | |
|
183 | 183 | # The ipython instance provided |
|
184 | 184 | self.IP = ip |
|
185 | 185 | |
|
186 | 186 | self.extensions = {} |
|
187 | 187 | global _recent |
|
188 | 188 | _recent = self |
|
189 | 189 | |
|
190 | 190 | # Use a property for some things which are added to the instance very |
|
191 | 191 | # late. I don't have time right now to disentangle the initialization |
|
192 | 192 | # order issues, so a property lets us delay item extraction while |
|
193 | 193 | # providing a normal attribute API. |
|
194 | 194 | def get_db(self): |
|
195 | 195 | """A handle to persistent dict-like database (a PickleShareDB object)""" |
|
196 | 196 | return self.IP.db |
|
197 | 197 | |
|
198 | 198 | db = property(get_db,None,None,get_db.__doc__) |
|
199 | 199 | |
|
200 | 200 | def get_options(self): |
|
201 | 201 | """All configurable variables.""" |
|
202 | 202 | |
|
203 | 203 | # catch typos by disabling new attribute creation. If new attr creation |
|
204 | 204 | # is in fact wanted (e.g. when exposing new options), do allow_new_attr(True) |
|
205 | 205 | # for the received rc struct. |
|
206 | 206 | |
|
207 | 207 | self.IP.rc.allow_new_attr(False) |
|
208 | 208 | return self.IP.rc |
|
209 | 209 | |
|
210 | 210 | options = property(get_options,None,None,get_options.__doc__) |
|
211 | 211 | |
|
212 | 212 | def expose_magic(self,magicname, func): |
|
213 | 213 | ''' Expose own function as magic function for ipython |
|
214 | 214 | |
|
215 | 215 | def foo_impl(self,parameter_s=''): |
|
216 | 216 | """My very own magic!. (Use docstrings, IPython reads them).""" |
|
217 | 217 | print 'Magic function. Passed parameter is between < >: <'+parameter_s+'>' |
|
218 | 218 | print 'The self object is:',self |
|
219 | 219 | |
|
220 | 220 | ipapi.expose_magic("foo",foo_impl) |
|
221 | 221 | ''' |
|
222 | 222 | |
|
223 | 223 | import new |
|
224 | 224 | im = new.instancemethod(func,self.IP, self.IP.__class__) |
|
225 | 225 | setattr(self.IP, "magic_" + magicname, im) |
|
226 | 226 | |
|
227 | 227 | def ex(self,cmd): |
|
228 | 228 | """ Execute a normal python statement in user namespace """ |
|
229 | 229 | exec cmd in self.user_ns |
|
230 | 230 | |
|
231 | 231 | def ev(self,expr): |
|
232 | 232 | """ Evaluate python expression expr in user namespace |
|
233 | 233 | |
|
234 | 234 | Returns the result of evaluation""" |
|
235 | 235 | return eval(expr,self.user_ns) |
|
236 | 236 | |
|
237 | 237 | def runlines(self,lines): |
|
238 | 238 | """ Run the specified lines in interpreter, honoring ipython directives. |
|
239 | 239 | |
|
240 | 240 | This allows %magic and !shell escape notations. |
|
241 | 241 | |
|
242 | 242 | Takes either all lines in one string or list of lines. |
|
243 | 243 | """ |
|
244 | 244 | if isinstance(lines,basestring): |
|
245 | 245 | self.IP.runlines(lines) |
|
246 | 246 | else: |
|
247 | 247 | self.IP.runlines('\n'.join(lines)) |
|
248 | 248 | |
|
249 | 249 | def to_user_ns(self,vars, interactive = True): |
|
250 | 250 | """Inject a group of variables into the IPython user namespace. |
|
251 | 251 | |
|
252 | 252 | Inputs: |
|
253 | 253 | |
|
254 | 254 | - vars: string with variable names separated by whitespace, or a |
|
255 | 255 | dict with name/value pairs. |
|
256 | 256 | |
|
257 | 257 | - interactive: if True (default), the var will be listed with |
|
258 | 258 | %whos et. al. |
|
259 | 259 | |
|
260 | 260 | This utility routine is meant to ease interactive debugging work, |
|
261 | 261 | where you want to easily propagate some internal variable in your code |
|
262 | 262 | up to the interactive namespace for further exploration. |
|
263 | 263 | |
|
264 | 264 | When you run code via %run, globals in your script become visible at |
|
265 | 265 | the interactive prompt, but this doesn't happen for locals inside your |
|
266 | 266 | own functions and methods. Yet when debugging, it is common to want |
|
267 | 267 | to explore some internal variables further at the interactive propmt. |
|
268 | 268 | |
|
269 | 269 | Examples: |
|
270 | 270 | |
|
271 | 271 | To use this, you first must obtain a handle on the ipython object as |
|
272 | 272 | indicated above, via: |
|
273 | 273 | |
|
274 | 274 | import IPython.ipapi |
|
275 | 275 | ip = IPython.ipapi.get() |
|
276 | 276 | |
|
277 | 277 | Once this is done, inside a routine foo() where you want to expose |
|
278 | 278 | variables x and y, you do the following: |
|
279 | 279 | |
|
280 | 280 | def foo(): |
|
281 | 281 | ... |
|
282 | 282 | x = your_computation() |
|
283 | 283 | y = something_else() |
|
284 | 284 | |
|
285 | 285 | # This pushes x and y to the interactive prompt immediately, even |
|
286 | 286 | # if this routine crashes on the next line after: |
|
287 | 287 | ip.to_user_ns('x y') |
|
288 | 288 | ... |
|
289 | 289 | |
|
290 | 290 | # To expose *ALL* the local variables from the function, use: |
|
291 | 291 | ip.to_user_ns(locals()) |
|
292 | 292 | |
|
293 | 293 | ... |
|
294 | 294 | # return |
|
295 | 295 | |
|
296 | 296 | |
|
297 | 297 | If you need to rename variables, the dict input makes it easy. For |
|
298 | 298 | example, this call exposes variables 'foo' as 'x' and 'bar' as 'y' |
|
299 | 299 | in IPython user namespace: |
|
300 | 300 | |
|
301 | 301 | ip.to_user_ns(dict(x=foo,y=bar)) |
|
302 | 302 | """ |
|
303 | 303 | |
|
304 | 304 | # print 'vars given:',vars # dbg |
|
305 | 305 | |
|
306 | 306 | # We need a dict of name/value pairs to do namespace updates. |
|
307 | 307 | if isinstance(vars,dict): |
|
308 | 308 | # If a dict was given, no need to change anything. |
|
309 | 309 | vdict = vars |
|
310 | 310 | elif isinstance(vars,basestring): |
|
311 | 311 | # If a string with names was given, get the caller's frame to |
|
312 | 312 | # evaluate the given names in |
|
313 | 313 | cf = sys._getframe(1) |
|
314 | 314 | vdict = {} |
|
315 | 315 | for name in vars.split(): |
|
316 | 316 | try: |
|
317 | 317 | vdict[name] = eval(name,cf.f_globals,cf.f_locals) |
|
318 | 318 | except: |
|
319 | 319 | print ('could not get var. %s from %s' % |
|
320 | 320 | (name,cf.f_code.co_name)) |
|
321 | 321 | else: |
|
322 | 322 | raise ValueError('vars must be a string or a dict') |
|
323 | 323 | |
|
324 | 324 | # Propagate variables to user namespace |
|
325 | 325 | self.user_ns.update(vdict) |
|
326 | 326 | |
|
327 | 327 | # And configure interactive visibility |
|
328 | 328 | config_ns = self.IP.user_config_ns |
|
329 | 329 | if interactive: |
|
330 | 330 | for name,val in vdict.iteritems(): |
|
331 | 331 | config_ns.pop(name,None) |
|
332 | 332 | else: |
|
333 | 333 | for name,val in vdict.iteritems(): |
|
334 | 334 | config_ns[name] = val |
|
335 | 335 | |
|
336 | 336 | |
|
337 | 337 | def expand_alias(self,line): |
|
338 | 338 | """ Expand an alias in the command line |
|
339 | 339 | |
|
340 | 340 | Returns the provided command line, possibly with the first word |
|
341 | 341 | (command) translated according to alias expansion rules. |
|
342 | 342 | |
|
343 | 343 | [ipython]|16> _ip.expand_aliases("np myfile.txt") |
|
344 | 344 | <16> 'q:/opt/np/notepad++.exe myfile.txt' |
|
345 | 345 | """ |
|
346 | 346 | |
|
347 | 347 | pre,fn,rest = self.IP.split_user_input(line) |
|
348 | 348 | res = pre + self.IP.expand_aliases(fn,rest) |
|
349 | 349 | return res |
|
350 | 350 | |
|
351 | 351 | def defalias(self, name, cmd): |
|
352 | 352 | """ Define a new alias |
|
353 | 353 | |
|
354 | 354 | _ip.defalias('bb','bldmake bldfiles') |
|
355 | 355 | |
|
356 | 356 | Creates a new alias named 'bb' in ipython user namespace |
|
357 | 357 | """ |
|
358 | 358 | |
|
359 | 359 | if callable(cmd): |
|
360 | 360 | self.IP.alias_table[name] = cmd |
|
361 | 361 | import IPython.shadowns |
|
362 | 362 | setattr(IPython.shadowns, name,cmd) |
|
363 | 363 | return |
|
364 | 364 | |
|
365 | ||
|
366 | nargs = cmd.count('%s') | |
|
367 | if nargs>0 and cmd.find('%l')>=0: | |
|
368 | raise Exception('The %s and %l specifiers are mutually exclusive ' | |
|
369 | 'in alias definitions.') | |
|
365 | if isinstance(cmd,basestring): | |
|
366 | nargs = cmd.count('%s') | |
|
367 | if nargs>0 and cmd.find('%l')>=0: | |
|
368 | raise Exception('The %s and %l specifiers are mutually exclusive ' | |
|
369 | 'in alias definitions.') | |
|
370 | 370 | |
|
371 | else: # all looks OK | |
|
372 | 371 | self.IP.alias_table[name] = (nargs,cmd) |
|
373 | 372 | |
|
374 | 373 | def defmacro(self, *args): |
|
375 | 374 | """ Define a new macro |
|
376 | 375 | |
|
377 | 376 | 2 forms of calling: |
|
378 | 377 | |
|
379 | 378 | mac = _ip.defmacro('print "hello"\nprint "world"') |
|
380 | 379 | |
|
381 | 380 | (doesn't put the created macro on user namespace) |
|
382 | 381 | |
|
383 | 382 | _ip.defmacro('build', 'bldmake bldfiles\nabld build winscw udeb') |
|
384 | 383 | |
|
385 | 384 | (creates a macro named 'build' in user namespace) |
|
386 | 385 | """ |
|
387 | 386 | |
|
388 | 387 | import IPython.macro |
|
389 | 388 | |
|
390 | 389 | if len(args) == 1: |
|
391 | 390 | return IPython.macro.Macro(args[0]) |
|
392 | 391 | elif len(args) == 2: |
|
393 | 392 | self.user_ns[args[0]] = IPython.macro.Macro(args[1]) |
|
394 | 393 | else: |
|
395 | 394 | return Exception("_ip.defmacro must be called with 1 or 2 arguments") |
|
396 | 395 | |
|
397 | 396 | def set_next_input(self, s): |
|
398 | 397 | """ Sets the 'default' input string for the next command line. |
|
399 | 398 | |
|
400 | 399 | Requires readline. |
|
401 | 400 | |
|
402 | 401 | Example: |
|
403 | 402 | |
|
404 | 403 | [D:\ipython]|1> _ip.set_next_input("Hello Word") |
|
405 | 404 | [D:\ipython]|2> Hello Word_ # cursor is here |
|
406 | 405 | """ |
|
407 | 406 | |
|
408 | 407 | self.IP.rl_next_input = s |
|
409 | 408 | |
|
410 | 409 | def load(self, mod): |
|
411 | 410 | if mod in self.extensions: |
|
412 | 411 | # just to make sure we don't init it twice |
|
413 | 412 | # note that if you 'load' a module that has already been |
|
414 | 413 | # imported, init_ipython gets run anyway |
|
415 | 414 | |
|
416 | 415 | return self.extensions[mod] |
|
417 | 416 | __import__(mod) |
|
418 | 417 | m = sys.modules[mod] |
|
419 | 418 | if hasattr(m,'init_ipython'): |
|
420 | 419 | m.init_ipython(self) |
|
421 | 420 | self.extensions[mod] = m |
|
422 | 421 | return m |
|
423 | 422 | |
|
424 | 423 | |
|
425 | 424 | def launch_new_instance(user_ns = None): |
|
426 | 425 | """ Make and start a new ipython instance. |
|
427 | 426 | |
|
428 | 427 | This can be called even without having an already initialized |
|
429 | 428 | ipython session running. |
|
430 | 429 | |
|
431 | 430 | This is also used as the egg entry point for the 'ipython' script. |
|
432 | 431 | |
|
433 | 432 | """ |
|
434 | 433 | ses = make_session(user_ns) |
|
435 | 434 | ses.mainloop() |
|
436 | 435 | |
|
437 | 436 | |
|
438 | 437 | def make_user_ns(user_ns = None): |
|
439 | 438 | """Return a valid user interactive namespace. |
|
440 | 439 | |
|
441 | 440 | This builds a dict with the minimal information needed to operate as a |
|
442 | 441 | valid IPython user namespace, which you can pass to the various embedding |
|
443 | 442 | classes in ipython. |
|
444 | 443 | """ |
|
445 | 444 | |
|
446 | 445 | if user_ns is None: |
|
447 | 446 | # Set __name__ to __main__ to better match the behavior of the |
|
448 | 447 | # normal interpreter. |
|
449 | 448 | user_ns = {'__name__' :'__main__', |
|
450 | 449 | '__builtins__' : __builtin__, |
|
451 | 450 | } |
|
452 | 451 | else: |
|
453 | 452 | user_ns.setdefault('__name__','__main__') |
|
454 | 453 | user_ns.setdefault('__builtins__',__builtin__) |
|
455 | 454 | |
|
456 | 455 | return user_ns |
|
457 | 456 | |
|
458 | 457 | |
|
459 | 458 | def make_user_global_ns(ns = None): |
|
460 | 459 | """Return a valid user global namespace. |
|
461 | 460 | |
|
462 | 461 | Similar to make_user_ns(), but global namespaces are really only needed in |
|
463 | 462 | embedded applications, where there is a distinction between the user's |
|
464 | 463 | interactive namespace and the global one where ipython is running.""" |
|
465 | 464 | |
|
466 | 465 | if ns is None: ns = {} |
|
467 | 466 | return ns |
|
468 | 467 | |
|
469 | 468 | |
|
470 | 469 | def make_session(user_ns = None): |
|
471 | 470 | """Makes, but does not launch an IPython session. |
|
472 | 471 | |
|
473 | 472 | Later on you can call obj.mainloop() on the returned object. |
|
474 | 473 | |
|
475 | 474 | Inputs: |
|
476 | 475 | |
|
477 | 476 | - user_ns(None): a dict to be used as the user's namespace with initial |
|
478 | 477 | data. |
|
479 | 478 | |
|
480 | 479 | WARNING: This should *not* be run when a session exists already.""" |
|
481 | 480 | |
|
482 | 481 | import IPython.Shell |
|
483 | 482 | return IPython.Shell.start(user_ns) |
|
484 | 483 |
@@ -1,2512 +1,2515 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """ |
|
3 | 3 | IPython -- An enhanced Interactive Python |
|
4 | 4 | |
|
5 | 5 | Requires Python 2.3 or newer. |
|
6 | 6 | |
|
7 | 7 | This file contains all the classes and helper functions specific to IPython. |
|
8 | 8 | |
|
9 |
$Id: iplib.py 263 |
|
|
9 | $Id: iplib.py 2637 2007-08-17 16:18:05Z vivainio $ | |
|
10 | 10 | """ |
|
11 | 11 | |
|
12 | 12 | #***************************************************************************** |
|
13 | 13 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and |
|
14 | 14 | # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu> |
|
15 | 15 | # |
|
16 | 16 | # Distributed under the terms of the BSD License. The full license is in |
|
17 | 17 | # the file COPYING, distributed as part of this software. |
|
18 | 18 | # |
|
19 | 19 | # Note: this code originally subclassed code.InteractiveConsole from the |
|
20 | 20 | # Python standard library. Over time, all of that class has been copied |
|
21 | 21 | # verbatim here for modifications which could not be accomplished by |
|
22 | 22 | # subclassing. At this point, there are no dependencies at all on the code |
|
23 | 23 | # module anymore (it is not even imported). The Python License (sec. 2) |
|
24 | 24 | # allows for this, but it's always nice to acknowledge credit where credit is |
|
25 | 25 | # due. |
|
26 | 26 | #***************************************************************************** |
|
27 | 27 | |
|
28 | 28 | #**************************************************************************** |
|
29 | 29 | # Modules and globals |
|
30 | 30 | |
|
31 | 31 | from IPython import Release |
|
32 | 32 | __author__ = '%s <%s>\n%s <%s>' % \ |
|
33 | 33 | ( Release.authors['Janko'] + Release.authors['Fernando'] ) |
|
34 | 34 | __license__ = Release.license |
|
35 | 35 | __version__ = Release.version |
|
36 | 36 | |
|
37 | 37 | # Python standard modules |
|
38 | 38 | import __main__ |
|
39 | 39 | import __builtin__ |
|
40 | 40 | import StringIO |
|
41 | 41 | import bdb |
|
42 | 42 | import cPickle as pickle |
|
43 | 43 | import codeop |
|
44 | 44 | import doctest |
|
45 | 45 | import exceptions |
|
46 | 46 | import glob |
|
47 | 47 | import inspect |
|
48 | 48 | import keyword |
|
49 | 49 | import new |
|
50 | 50 | import os |
|
51 | 51 | import pydoc |
|
52 | 52 | import re |
|
53 | 53 | import shutil |
|
54 | 54 | import string |
|
55 | 55 | import sys |
|
56 | 56 | import tempfile |
|
57 | 57 | import traceback |
|
58 | 58 | import types |
|
59 | 59 | import pickleshare |
|
60 | 60 | from sets import Set |
|
61 | 61 | from pprint import pprint, pformat |
|
62 | 62 | |
|
63 | 63 | # IPython's own modules |
|
64 | 64 | #import IPython |
|
65 | 65 | from IPython import Debugger,OInspect,PyColorize,ultraTB |
|
66 | 66 | from IPython.ColorANSI import ColorScheme,ColorSchemeTable # too long names |
|
67 | 67 | from IPython.FakeModule import FakeModule |
|
68 | 68 | from IPython.Itpl import Itpl,itpl,printpl,ItplNS,itplns |
|
69 | 69 | from IPython.Logger import Logger |
|
70 | 70 | from IPython.Magic import Magic |
|
71 | 71 | from IPython.Prompts import CachedOutput |
|
72 | 72 | from IPython.ipstruct import Struct |
|
73 | 73 | from IPython.background_jobs import BackgroundJobManager |
|
74 | 74 | from IPython.usage import cmd_line_usage,interactive_usage |
|
75 | 75 | from IPython.genutils import * |
|
76 | 76 | from IPython.strdispatch import StrDispatch |
|
77 | 77 | import IPython.ipapi |
|
78 | 78 | import IPython.history |
|
79 | 79 | import IPython.prefilter as prefilter |
|
80 | 80 | import IPython.shadowns |
|
81 | 81 | # Globals |
|
82 | 82 | |
|
83 | 83 | # store the builtin raw_input globally, and use this always, in case user code |
|
84 | 84 | # overwrites it (like wx.py.PyShell does) |
|
85 | 85 | raw_input_original = raw_input |
|
86 | 86 | |
|
87 | 87 | # compiled regexps for autoindent management |
|
88 | 88 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') |
|
89 | 89 | |
|
90 | 90 | |
|
91 | 91 | #**************************************************************************** |
|
92 | 92 | # Some utility function definitions |
|
93 | 93 | |
|
94 | 94 | ini_spaces_re = re.compile(r'^(\s+)') |
|
95 | 95 | |
|
96 | 96 | def num_ini_spaces(strng): |
|
97 | 97 | """Return the number of initial spaces in a string""" |
|
98 | 98 | |
|
99 | 99 | ini_spaces = ini_spaces_re.match(strng) |
|
100 | 100 | if ini_spaces: |
|
101 | 101 | return ini_spaces.end() |
|
102 | 102 | else: |
|
103 | 103 | return 0 |
|
104 | 104 | |
|
105 | 105 | def softspace(file, newvalue): |
|
106 | 106 | """Copied from code.py, to remove the dependency""" |
|
107 | 107 | |
|
108 | 108 | oldvalue = 0 |
|
109 | 109 | try: |
|
110 | 110 | oldvalue = file.softspace |
|
111 | 111 | except AttributeError: |
|
112 | 112 | pass |
|
113 | 113 | try: |
|
114 | 114 | file.softspace = newvalue |
|
115 | 115 | except (AttributeError, TypeError): |
|
116 | 116 | # "attribute-less object" or "read-only attributes" |
|
117 | 117 | pass |
|
118 | 118 | return oldvalue |
|
119 | 119 | |
|
120 | 120 | |
|
121 | 121 | #**************************************************************************** |
|
122 | 122 | # Local use exceptions |
|
123 | 123 | class SpaceInInput(exceptions.Exception): pass |
|
124 | 124 | |
|
125 | 125 | |
|
126 | 126 | #**************************************************************************** |
|
127 | 127 | # Local use classes |
|
128 | 128 | class Bunch: pass |
|
129 | 129 | |
|
130 | 130 | class Undefined: pass |
|
131 | 131 | |
|
132 | 132 | class Quitter(object): |
|
133 | 133 | """Simple class to handle exit, similar to Python 2.5's. |
|
134 | 134 | |
|
135 | 135 | It handles exiting in an ipython-safe manner, which the one in Python 2.5 |
|
136 | 136 | doesn't do (obviously, since it doesn't know about ipython).""" |
|
137 | 137 | |
|
138 | 138 | def __init__(self,shell,name): |
|
139 | 139 | self.shell = shell |
|
140 | 140 | self.name = name |
|
141 | 141 | |
|
142 | 142 | def __repr__(self): |
|
143 | 143 | return 'Type %s() to exit.' % self.name |
|
144 | 144 | __str__ = __repr__ |
|
145 | 145 | |
|
146 | 146 | def __call__(self): |
|
147 | 147 | self.shell.exit() |
|
148 | 148 | |
|
149 | 149 | class InputList(list): |
|
150 | 150 | """Class to store user input. |
|
151 | 151 | |
|
152 | 152 | It's basically a list, but slices return a string instead of a list, thus |
|
153 | 153 | allowing things like (assuming 'In' is an instance): |
|
154 | 154 | |
|
155 | 155 | exec In[4:7] |
|
156 | 156 | |
|
157 | 157 | or |
|
158 | 158 | |
|
159 | 159 | exec In[5:9] + In[14] + In[21:25]""" |
|
160 | 160 | |
|
161 | 161 | def __getslice__(self,i,j): |
|
162 | 162 | return ''.join(list.__getslice__(self,i,j)) |
|
163 | 163 | |
|
164 | 164 | class SyntaxTB(ultraTB.ListTB): |
|
165 | 165 | """Extension which holds some state: the last exception value""" |
|
166 | 166 | |
|
167 | 167 | def __init__(self,color_scheme = 'NoColor'): |
|
168 | 168 | ultraTB.ListTB.__init__(self,color_scheme) |
|
169 | 169 | self.last_syntax_error = None |
|
170 | 170 | |
|
171 | 171 | def __call__(self, etype, value, elist): |
|
172 | 172 | self.last_syntax_error = value |
|
173 | 173 | ultraTB.ListTB.__call__(self,etype,value,elist) |
|
174 | 174 | |
|
175 | 175 | def clear_err_state(self): |
|
176 | 176 | """Return the current error state and clear it""" |
|
177 | 177 | e = self.last_syntax_error |
|
178 | 178 | self.last_syntax_error = None |
|
179 | 179 | return e |
|
180 | 180 | |
|
181 | 181 | #**************************************************************************** |
|
182 | 182 | # Main IPython class |
|
183 | 183 | |
|
184 | 184 | # FIXME: the Magic class is a mixin for now, and will unfortunately remain so |
|
185 | 185 | # until a full rewrite is made. I've cleaned all cross-class uses of |
|
186 | 186 | # attributes and methods, but too much user code out there relies on the |
|
187 | 187 | # equlity %foo == __IP.magic_foo, so I can't actually remove the mixin usage. |
|
188 | 188 | # |
|
189 | 189 | # But at least now, all the pieces have been separated and we could, in |
|
190 | 190 | # principle, stop using the mixin. This will ease the transition to the |
|
191 | 191 | # chainsaw branch. |
|
192 | 192 | |
|
193 | 193 | # For reference, the following is the list of 'self.foo' uses in the Magic |
|
194 | 194 | # class as of 2005-12-28. These are names we CAN'T use in the main ipython |
|
195 | 195 | # class, to prevent clashes. |
|
196 | 196 | |
|
197 | 197 | # ['self.__class__', 'self.__dict__', 'self._inspect', 'self._ofind', |
|
198 | 198 | # 'self.arg_err', 'self.extract_input', 'self.format_', 'self.lsmagic', |
|
199 | 199 | # 'self.magic_', 'self.options_table', 'self.parse', 'self.shell', |
|
200 | 200 | # 'self.value'] |
|
201 | 201 | |
|
202 | 202 | class InteractiveShell(object,Magic): |
|
203 | 203 | """An enhanced console for Python.""" |
|
204 | 204 | |
|
205 | 205 | # class attribute to indicate whether the class supports threads or not. |
|
206 | 206 | # Subclasses with thread support should override this as needed. |
|
207 | 207 | isthreaded = False |
|
208 | 208 | |
|
209 | 209 | def __init__(self,name,usage=None,rc=Struct(opts=None,args=None), |
|
210 | 210 | user_ns = None,user_global_ns=None,banner2='', |
|
211 | 211 | custom_exceptions=((),None),embedded=False): |
|
212 | 212 | |
|
213 | 213 | # log system |
|
214 | 214 | self.logger = Logger(self,logfname='ipython_log.py',logmode='rotate') |
|
215 | 215 | |
|
216 | 216 | # some minimal strict typechecks. For some core data structures, I |
|
217 | 217 | # want actual basic python types, not just anything that looks like |
|
218 | 218 | # one. This is especially true for namespaces. |
|
219 | 219 | for ns in (user_ns,user_global_ns): |
|
220 | 220 | if ns is not None and type(ns) != types.DictType: |
|
221 | 221 | raise TypeError,'namespace must be a dictionary' |
|
222 | 222 | |
|
223 | 223 | # Job manager (for jobs run as background threads) |
|
224 | 224 | self.jobs = BackgroundJobManager() |
|
225 | 225 | |
|
226 | 226 | # Store the actual shell's name |
|
227 | 227 | self.name = name |
|
228 | 228 | |
|
229 | 229 | # We need to know whether the instance is meant for embedding, since |
|
230 | 230 | # global/local namespaces need to be handled differently in that case |
|
231 | 231 | self.embedded = embedded |
|
232 | 232 | if embedded: |
|
233 | 233 | # Control variable so users can, from within the embedded instance, |
|
234 | 234 | # permanently deactivate it. |
|
235 | 235 | self.embedded_active = True |
|
236 | 236 | |
|
237 | 237 | # command compiler |
|
238 | 238 | self.compile = codeop.CommandCompiler() |
|
239 | 239 | |
|
240 | 240 | # User input buffer |
|
241 | 241 | self.buffer = [] |
|
242 | 242 | |
|
243 | 243 | # Default name given in compilation of code |
|
244 | 244 | self.filename = '<ipython console>' |
|
245 | 245 | |
|
246 | 246 | # Install our own quitter instead of the builtins. For python2.3-2.4, |
|
247 | 247 | # this brings in behavior like 2.5, and for 2.5 it's identical. |
|
248 | 248 | __builtin__.exit = Quitter(self,'exit') |
|
249 | 249 | __builtin__.quit = Quitter(self,'quit') |
|
250 | 250 | |
|
251 | 251 | # Make an empty namespace, which extension writers can rely on both |
|
252 | 252 | # existing and NEVER being used by ipython itself. This gives them a |
|
253 | 253 | # convenient location for storing additional information and state |
|
254 | 254 | # their extensions may require, without fear of collisions with other |
|
255 | 255 | # ipython names that may develop later. |
|
256 | 256 | self.meta = Struct() |
|
257 | 257 | |
|
258 | 258 | # Create the namespace where the user will operate. user_ns is |
|
259 | 259 | # normally the only one used, and it is passed to the exec calls as |
|
260 | 260 | # the locals argument. But we do carry a user_global_ns namespace |
|
261 | 261 | # given as the exec 'globals' argument, This is useful in embedding |
|
262 | 262 | # situations where the ipython shell opens in a context where the |
|
263 | 263 | # distinction between locals and globals is meaningful. |
|
264 | 264 | |
|
265 | 265 | # FIXME. For some strange reason, __builtins__ is showing up at user |
|
266 | 266 | # level as a dict instead of a module. This is a manual fix, but I |
|
267 | 267 | # should really track down where the problem is coming from. Alex |
|
268 | 268 | # Schmolck reported this problem first. |
|
269 | 269 | |
|
270 | 270 | # A useful post by Alex Martelli on this topic: |
|
271 | 271 | # Re: inconsistent value from __builtins__ |
|
272 | 272 | # Von: Alex Martelli <aleaxit@yahoo.com> |
|
273 | 273 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends |
|
274 | 274 | # Gruppen: comp.lang.python |
|
275 | 275 | |
|
276 | 276 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: |
|
277 | 277 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) |
|
278 | 278 | # > <type 'dict'> |
|
279 | 279 | # > >>> print type(__builtins__) |
|
280 | 280 | # > <type 'module'> |
|
281 | 281 | # > Is this difference in return value intentional? |
|
282 | 282 | |
|
283 | 283 | # Well, it's documented that '__builtins__' can be either a dictionary |
|
284 | 284 | # or a module, and it's been that way for a long time. Whether it's |
|
285 | 285 | # intentional (or sensible), I don't know. In any case, the idea is |
|
286 | 286 | # that if you need to access the built-in namespace directly, you |
|
287 | 287 | # should start with "import __builtin__" (note, no 's') which will |
|
288 | 288 | # definitely give you a module. Yeah, it's somewhat confusing:-(. |
|
289 | 289 | |
|
290 | 290 | # These routines return properly built dicts as needed by the rest of |
|
291 | 291 | # the code, and can also be used by extension writers to generate |
|
292 | 292 | # properly initialized namespaces. |
|
293 | 293 | user_ns = IPython.ipapi.make_user_ns(user_ns) |
|
294 | 294 | user_global_ns = IPython.ipapi.make_user_global_ns(user_global_ns) |
|
295 | 295 | |
|
296 | 296 | # Assign namespaces |
|
297 | 297 | # This is the namespace where all normal user variables live |
|
298 | 298 | self.user_ns = user_ns |
|
299 | 299 | # Embedded instances require a separate namespace for globals. |
|
300 | 300 | # Normally this one is unused by non-embedded instances. |
|
301 | 301 | self.user_global_ns = user_global_ns |
|
302 | 302 | # A namespace to keep track of internal data structures to prevent |
|
303 | 303 | # them from cluttering user-visible stuff. Will be updated later |
|
304 | 304 | self.internal_ns = {} |
|
305 | 305 | |
|
306 | 306 | # Namespace of system aliases. Each entry in the alias |
|
307 | 307 | # table must be a 2-tuple of the form (N,name), where N is the number |
|
308 | 308 | # of positional arguments of the alias. |
|
309 | 309 | self.alias_table = {} |
|
310 | 310 | |
|
311 | 311 | # A table holding all the namespaces IPython deals with, so that |
|
312 | 312 | # introspection facilities can search easily. |
|
313 | 313 | self.ns_table = {'user':user_ns, |
|
314 | 314 | 'user_global':user_global_ns, |
|
315 | 315 | 'alias':self.alias_table, |
|
316 | 316 | 'internal':self.internal_ns, |
|
317 | 317 | 'builtin':__builtin__.__dict__ |
|
318 | 318 | } |
|
319 | 319 | |
|
320 | 320 | # The user namespace MUST have a pointer to the shell itself. |
|
321 | 321 | self.user_ns[name] = self |
|
322 | 322 | |
|
323 | 323 | # We need to insert into sys.modules something that looks like a |
|
324 | 324 | # module but which accesses the IPython namespace, for shelve and |
|
325 | 325 | # pickle to work interactively. Normally they rely on getting |
|
326 | 326 | # everything out of __main__, but for embedding purposes each IPython |
|
327 | 327 | # instance has its own private namespace, so we can't go shoving |
|
328 | 328 | # everything into __main__. |
|
329 | 329 | |
|
330 | 330 | # note, however, that we should only do this for non-embedded |
|
331 | 331 | # ipythons, which really mimic the __main__.__dict__ with their own |
|
332 | 332 | # namespace. Embedded instances, on the other hand, should not do |
|
333 | 333 | # this because they need to manage the user local/global namespaces |
|
334 | 334 | # only, but they live within a 'normal' __main__ (meaning, they |
|
335 | 335 | # shouldn't overtake the execution environment of the script they're |
|
336 | 336 | # embedded in). |
|
337 | 337 | |
|
338 | 338 | if not embedded: |
|
339 | 339 | try: |
|
340 | 340 | main_name = self.user_ns['__name__'] |
|
341 | 341 | except KeyError: |
|
342 | 342 | raise KeyError,'user_ns dictionary MUST have a "__name__" key' |
|
343 | 343 | else: |
|
344 | 344 | #print "pickle hack in place" # dbg |
|
345 | 345 | #print 'main_name:',main_name # dbg |
|
346 | 346 | sys.modules[main_name] = FakeModule(self.user_ns) |
|
347 | 347 | |
|
348 | 348 | # List of input with multi-line handling. |
|
349 | 349 | # Fill its zero entry, user counter starts at 1 |
|
350 | 350 | self.input_hist = InputList(['\n']) |
|
351 | 351 | # This one will hold the 'raw' input history, without any |
|
352 | 352 | # pre-processing. This will allow users to retrieve the input just as |
|
353 | 353 | # it was exactly typed in by the user, with %hist -r. |
|
354 | 354 | self.input_hist_raw = InputList(['\n']) |
|
355 | 355 | |
|
356 | 356 | # list of visited directories |
|
357 | 357 | try: |
|
358 | 358 | self.dir_hist = [os.getcwd()] |
|
359 | 359 | except OSError: |
|
360 | 360 | self.dir_hist = [] |
|
361 | 361 | |
|
362 | 362 | # dict of output history |
|
363 | 363 | self.output_hist = {} |
|
364 | 364 | |
|
365 | 365 | # Get system encoding at startup time. Certain terminals (like Emacs |
|
366 | 366 | # under Win32 have it set to None, and we need to have a known valid |
|
367 | 367 | # encoding to use in the raw_input() method |
|
368 | 368 | self.stdin_encoding = sys.stdin.encoding or 'ascii' |
|
369 | 369 | |
|
370 | 370 | # dict of things NOT to alias (keywords, builtins and some magics) |
|
371 | 371 | no_alias = {} |
|
372 | 372 | no_alias_magics = ['cd','popd','pushd','dhist','alias','unalias'] |
|
373 | 373 | for key in keyword.kwlist + no_alias_magics: |
|
374 | 374 | no_alias[key] = 1 |
|
375 | 375 | no_alias.update(__builtin__.__dict__) |
|
376 | 376 | self.no_alias = no_alias |
|
377 | 377 | |
|
378 | 378 | # make global variables for user access to these |
|
379 | 379 | self.user_ns['_ih'] = self.input_hist |
|
380 | 380 | self.user_ns['_oh'] = self.output_hist |
|
381 | 381 | self.user_ns['_dh'] = self.dir_hist |
|
382 | 382 | |
|
383 | 383 | # user aliases to input and output histories |
|
384 | 384 | self.user_ns['In'] = self.input_hist |
|
385 | 385 | self.user_ns['Out'] = self.output_hist |
|
386 | 386 | |
|
387 | 387 | self.user_ns['_sh'] = IPython.shadowns |
|
388 | 388 | # Object variable to store code object waiting execution. This is |
|
389 | 389 | # used mainly by the multithreaded shells, but it can come in handy in |
|
390 | 390 | # other situations. No need to use a Queue here, since it's a single |
|
391 | 391 | # item which gets cleared once run. |
|
392 | 392 | self.code_to_run = None |
|
393 | 393 | |
|
394 | 394 | # escapes for automatic behavior on the command line |
|
395 | 395 | self.ESC_SHELL = '!' |
|
396 | 396 | self.ESC_SH_CAP = '!!' |
|
397 | 397 | self.ESC_HELP = '?' |
|
398 | 398 | self.ESC_MAGIC = '%' |
|
399 | 399 | self.ESC_QUOTE = ',' |
|
400 | 400 | self.ESC_QUOTE2 = ';' |
|
401 | 401 | self.ESC_PAREN = '/' |
|
402 | 402 | |
|
403 | 403 | # And their associated handlers |
|
404 | 404 | self.esc_handlers = {self.ESC_PAREN : self.handle_auto, |
|
405 | 405 | self.ESC_QUOTE : self.handle_auto, |
|
406 | 406 | self.ESC_QUOTE2 : self.handle_auto, |
|
407 | 407 | self.ESC_MAGIC : self.handle_magic, |
|
408 | 408 | self.ESC_HELP : self.handle_help, |
|
409 | 409 | self.ESC_SHELL : self.handle_shell_escape, |
|
410 | 410 | self.ESC_SH_CAP : self.handle_shell_escape, |
|
411 | 411 | } |
|
412 | 412 | |
|
413 | 413 | # class initializations |
|
414 | 414 | Magic.__init__(self,self) |
|
415 | 415 | |
|
416 | 416 | # Python source parser/formatter for syntax highlighting |
|
417 | 417 | pyformat = PyColorize.Parser().format |
|
418 | 418 | self.pycolorize = lambda src: pyformat(src,'str',self.rc['colors']) |
|
419 | 419 | |
|
420 | 420 | # hooks holds pointers used for user-side customizations |
|
421 | 421 | self.hooks = Struct() |
|
422 | 422 | |
|
423 | 423 | self.strdispatchers = {} |
|
424 | 424 | |
|
425 | 425 | # Set all default hooks, defined in the IPython.hooks module. |
|
426 | 426 | hooks = IPython.hooks |
|
427 | 427 | for hook_name in hooks.__all__: |
|
428 | 428 | # default hooks have priority 100, i.e. low; user hooks should have |
|
429 | 429 | # 0-100 priority |
|
430 | 430 | self.set_hook(hook_name,getattr(hooks,hook_name), 100) |
|
431 | 431 | #print "bound hook",hook_name |
|
432 | 432 | |
|
433 | 433 | # Flag to mark unconditional exit |
|
434 | 434 | self.exit_now = False |
|
435 | 435 | |
|
436 | 436 | self.usage_min = """\ |
|
437 | 437 | An enhanced console for Python. |
|
438 | 438 | Some of its features are: |
|
439 | 439 | - Readline support if the readline library is present. |
|
440 | 440 | - Tab completion in the local namespace. |
|
441 | 441 | - Logging of input, see command-line options. |
|
442 | 442 | - System shell escape via ! , eg !ls. |
|
443 | 443 | - Magic commands, starting with a % (like %ls, %pwd, %cd, etc.) |
|
444 | 444 | - Keeps track of locally defined variables via %who, %whos. |
|
445 | 445 | - Show object information with a ? eg ?x or x? (use ?? for more info). |
|
446 | 446 | """ |
|
447 | 447 | if usage: self.usage = usage |
|
448 | 448 | else: self.usage = self.usage_min |
|
449 | 449 | |
|
450 | 450 | # Storage |
|
451 | 451 | self.rc = rc # This will hold all configuration information |
|
452 | 452 | self.pager = 'less' |
|
453 | 453 | # temporary files used for various purposes. Deleted at exit. |
|
454 | 454 | self.tempfiles = [] |
|
455 | 455 | |
|
456 | 456 | # Keep track of readline usage (later set by init_readline) |
|
457 | 457 | self.has_readline = False |
|
458 | 458 | |
|
459 | 459 | # template for logfile headers. It gets resolved at runtime by the |
|
460 | 460 | # logstart method. |
|
461 | 461 | self.loghead_tpl = \ |
|
462 | 462 | """#log# Automatic Logger file. *** THIS MUST BE THE FIRST LINE *** |
|
463 | 463 | #log# DO NOT CHANGE THIS LINE OR THE TWO BELOW |
|
464 | 464 | #log# opts = %s |
|
465 | 465 | #log# args = %s |
|
466 | 466 | #log# It is safe to make manual edits below here. |
|
467 | 467 | #log#----------------------------------------------------------------------- |
|
468 | 468 | """ |
|
469 | 469 | # for pushd/popd management |
|
470 | 470 | try: |
|
471 | 471 | self.home_dir = get_home_dir() |
|
472 | 472 | except HomeDirError,msg: |
|
473 | 473 | fatal(msg) |
|
474 | 474 | |
|
475 | 475 | self.dir_stack = [os.getcwd().replace(self.home_dir,'~')] |
|
476 | 476 | |
|
477 | 477 | # Functions to call the underlying shell. |
|
478 | 478 | |
|
479 | 479 | # The first is similar to os.system, but it doesn't return a value, |
|
480 | 480 | # and it allows interpolation of variables in the user's namespace. |
|
481 | 481 | self.system = lambda cmd: \ |
|
482 | 482 | shell(self.var_expand(cmd,depth=2), |
|
483 | 483 | header=self.rc.system_header, |
|
484 | 484 | verbose=self.rc.system_verbose) |
|
485 | 485 | |
|
486 | 486 | # These are for getoutput and getoutputerror: |
|
487 | 487 | self.getoutput = lambda cmd: \ |
|
488 | 488 | getoutput(self.var_expand(cmd,depth=2), |
|
489 | 489 | header=self.rc.system_header, |
|
490 | 490 | verbose=self.rc.system_verbose) |
|
491 | 491 | |
|
492 | 492 | self.getoutputerror = lambda cmd: \ |
|
493 | 493 | getoutputerror(self.var_expand(cmd,depth=2), |
|
494 | 494 | header=self.rc.system_header, |
|
495 | 495 | verbose=self.rc.system_verbose) |
|
496 | 496 | |
|
497 | 497 | |
|
498 | 498 | # keep track of where we started running (mainly for crash post-mortem) |
|
499 | 499 | self.starting_dir = os.getcwd() |
|
500 | 500 | |
|
501 | 501 | # Various switches which can be set |
|
502 | 502 | self.CACHELENGTH = 5000 # this is cheap, it's just text |
|
503 | 503 | self.BANNER = "Python %(version)s on %(platform)s\n" % sys.__dict__ |
|
504 | 504 | self.banner2 = banner2 |
|
505 | 505 | |
|
506 | 506 | # TraceBack handlers: |
|
507 | 507 | |
|
508 | 508 | # Syntax error handler. |
|
509 | 509 | self.SyntaxTB = SyntaxTB(color_scheme='NoColor') |
|
510 | 510 | |
|
511 | 511 | # The interactive one is initialized with an offset, meaning we always |
|
512 | 512 | # want to remove the topmost item in the traceback, which is our own |
|
513 | 513 | # internal code. Valid modes: ['Plain','Context','Verbose'] |
|
514 | 514 | self.InteractiveTB = ultraTB.AutoFormattedTB(mode = 'Plain', |
|
515 | 515 | color_scheme='NoColor', |
|
516 | 516 | tb_offset = 1) |
|
517 | 517 | |
|
518 | 518 | # IPython itself shouldn't crash. This will produce a detailed |
|
519 | 519 | # post-mortem if it does. But we only install the crash handler for |
|
520 | 520 | # non-threaded shells, the threaded ones use a normal verbose reporter |
|
521 | 521 | # and lose the crash handler. This is because exceptions in the main |
|
522 | 522 | # thread (such as in GUI code) propagate directly to sys.excepthook, |
|
523 | 523 | # and there's no point in printing crash dumps for every user exception. |
|
524 | 524 | if self.isthreaded: |
|
525 | 525 | ipCrashHandler = ultraTB.FormattedTB() |
|
526 | 526 | else: |
|
527 | 527 | from IPython import CrashHandler |
|
528 | 528 | ipCrashHandler = CrashHandler.IPythonCrashHandler(self) |
|
529 | 529 | self.set_crash_handler(ipCrashHandler) |
|
530 | 530 | |
|
531 | 531 | # and add any custom exception handlers the user may have specified |
|
532 | 532 | self.set_custom_exc(*custom_exceptions) |
|
533 | 533 | |
|
534 | 534 | # indentation management |
|
535 | 535 | self.autoindent = False |
|
536 | 536 | self.indent_current_nsp = 0 |
|
537 | 537 | |
|
538 | 538 | # Make some aliases automatically |
|
539 | 539 | # Prepare list of shell aliases to auto-define |
|
540 | 540 | if os.name == 'posix': |
|
541 | 541 | auto_alias = ('mkdir mkdir', 'rmdir rmdir', |
|
542 | 542 | 'mv mv -i','rm rm -i','cp cp -i', |
|
543 | 543 | 'cat cat','less less','clear clear', |
|
544 | 544 | # a better ls |
|
545 | 545 | 'ls ls -F', |
|
546 | 546 | # long ls |
|
547 | 547 | 'll ls -lF') |
|
548 | 548 | # Extra ls aliases with color, which need special treatment on BSD |
|
549 | 549 | # variants |
|
550 | 550 | ls_extra = ( # color ls |
|
551 | 551 | 'lc ls -F -o --color', |
|
552 | 552 | # ls normal files only |
|
553 | 553 | 'lf ls -F -o --color %l | grep ^-', |
|
554 | 554 | # ls symbolic links |
|
555 | 555 | 'lk ls -F -o --color %l | grep ^l', |
|
556 | 556 | # directories or links to directories, |
|
557 | 557 | 'ldir ls -F -o --color %l | grep /$', |
|
558 | 558 | # things which are executable |
|
559 | 559 | 'lx ls -F -o --color %l | grep ^-..x', |
|
560 | 560 | ) |
|
561 | 561 | # The BSDs don't ship GNU ls, so they don't understand the |
|
562 | 562 | # --color switch out of the box |
|
563 | 563 | if 'bsd' in sys.platform: |
|
564 | 564 | ls_extra = ( # ls normal files only |
|
565 | 565 | 'lf ls -lF | grep ^-', |
|
566 | 566 | # ls symbolic links |
|
567 | 567 | 'lk ls -lF | grep ^l', |
|
568 | 568 | # directories or links to directories, |
|
569 | 569 | 'ldir ls -lF | grep /$', |
|
570 | 570 | # things which are executable |
|
571 | 571 | 'lx ls -lF | grep ^-..x', |
|
572 | 572 | ) |
|
573 | 573 | auto_alias = auto_alias + ls_extra |
|
574 | 574 | elif os.name in ['nt','dos']: |
|
575 | 575 | auto_alias = ('dir dir /on', 'ls dir /on', |
|
576 | 576 | 'ddir dir /ad /on', 'ldir dir /ad /on', |
|
577 | 577 | 'mkdir mkdir','rmdir rmdir','echo echo', |
|
578 | 578 | 'ren ren','cls cls','copy copy') |
|
579 | 579 | else: |
|
580 | 580 | auto_alias = () |
|
581 | 581 | self.auto_alias = [s.split(None,1) for s in auto_alias] |
|
582 | 582 | # Call the actual (public) initializer |
|
583 | 583 | self.init_auto_alias() |
|
584 | 584 | |
|
585 | 585 | # Produce a public API instance |
|
586 | 586 | self.api = IPython.ipapi.IPApi(self) |
|
587 | 587 | |
|
588 | 588 | # track which builtins we add, so we can clean up later |
|
589 | 589 | self.builtins_added = {} |
|
590 | 590 | # This method will add the necessary builtins for operation, but |
|
591 | 591 | # tracking what it did via the builtins_added dict. |
|
592 | 592 | self.add_builtins() |
|
593 | 593 | |
|
594 | 594 | # end __init__ |
|
595 | 595 | |
|
596 | 596 | def var_expand(self,cmd,depth=0): |
|
597 | 597 | """Expand python variables in a string. |
|
598 | 598 | |
|
599 | 599 | The depth argument indicates how many frames above the caller should |
|
600 | 600 | be walked to look for the local namespace where to expand variables. |
|
601 | 601 | |
|
602 | 602 | The global namespace for expansion is always the user's interactive |
|
603 | 603 | namespace. |
|
604 | 604 | """ |
|
605 | 605 | |
|
606 | 606 | return str(ItplNS(cmd.replace('#','\#'), |
|
607 | 607 | self.user_ns, # globals |
|
608 | 608 | # Skip our own frame in searching for locals: |
|
609 | 609 | sys._getframe(depth+1).f_locals # locals |
|
610 | 610 | )) |
|
611 | 611 | |
|
612 | 612 | def pre_config_initialization(self): |
|
613 | 613 | """Pre-configuration init method |
|
614 | 614 | |
|
615 | 615 | This is called before the configuration files are processed to |
|
616 | 616 | prepare the services the config files might need. |
|
617 | 617 | |
|
618 | 618 | self.rc already has reasonable default values at this point. |
|
619 | 619 | """ |
|
620 | 620 | rc = self.rc |
|
621 | 621 | try: |
|
622 | 622 | self.db = pickleshare.PickleShareDB(rc.ipythondir + "/db") |
|
623 | 623 | except exceptions.UnicodeDecodeError: |
|
624 | 624 | print "Your ipythondir can't be decoded to unicode!" |
|
625 | 625 | print "Please set HOME environment variable to something that" |
|
626 | 626 | print r"only has ASCII characters, e.g. c:\home" |
|
627 | 627 | print "Now it is",rc.ipythondir |
|
628 | 628 | sys.exit() |
|
629 | 629 | self.shadowhist = IPython.history.ShadowHist(self.db) |
|
630 | 630 | |
|
631 | 631 | |
|
632 | 632 | def post_config_initialization(self): |
|
633 | 633 | """Post configuration init method |
|
634 | 634 | |
|
635 | 635 | This is called after the configuration files have been processed to |
|
636 | 636 | 'finalize' the initialization.""" |
|
637 | 637 | |
|
638 | 638 | rc = self.rc |
|
639 | 639 | |
|
640 | 640 | # Object inspector |
|
641 | 641 | self.inspector = OInspect.Inspector(OInspect.InspectColors, |
|
642 | 642 | PyColorize.ANSICodeColors, |
|
643 | 643 | 'NoColor', |
|
644 | 644 | rc.object_info_string_level) |
|
645 | 645 | |
|
646 | 646 | self.rl_next_input = None |
|
647 | 647 | self.rl_do_indent = False |
|
648 | 648 | # Load readline proper |
|
649 | 649 | if rc.readline: |
|
650 | 650 | self.init_readline() |
|
651 | 651 | |
|
652 | 652 | |
|
653 | 653 | # local shortcut, this is used a LOT |
|
654 | 654 | self.log = self.logger.log |
|
655 | 655 | |
|
656 | 656 | # Initialize cache, set in/out prompts and printing system |
|
657 | 657 | self.outputcache = CachedOutput(self, |
|
658 | 658 | rc.cache_size, |
|
659 | 659 | rc.pprint, |
|
660 | 660 | input_sep = rc.separate_in, |
|
661 | 661 | output_sep = rc.separate_out, |
|
662 | 662 | output_sep2 = rc.separate_out2, |
|
663 | 663 | ps1 = rc.prompt_in1, |
|
664 | 664 | ps2 = rc.prompt_in2, |
|
665 | 665 | ps_out = rc.prompt_out, |
|
666 | 666 | pad_left = rc.prompts_pad_left) |
|
667 | 667 | |
|
668 | 668 | # user may have over-ridden the default print hook: |
|
669 | 669 | try: |
|
670 | 670 | self.outputcache.__class__.display = self.hooks.display |
|
671 | 671 | except AttributeError: |
|
672 | 672 | pass |
|
673 | 673 | |
|
674 | 674 | # I don't like assigning globally to sys, because it means when |
|
675 | 675 | # embedding instances, each embedded instance overrides the previous |
|
676 | 676 | # choice. But sys.displayhook seems to be called internally by exec, |
|
677 | 677 | # so I don't see a way around it. We first save the original and then |
|
678 | 678 | # overwrite it. |
|
679 | 679 | self.sys_displayhook = sys.displayhook |
|
680 | 680 | sys.displayhook = self.outputcache |
|
681 | 681 | |
|
682 | 682 | # Monkeypatch doctest so that its core test runner method is protected |
|
683 | 683 | # from IPython's modified displayhook. Doctest expects the default |
|
684 | 684 | # displayhook behavior deep down, so our modification breaks it |
|
685 | 685 | # completely. For this reason, a hard monkeypatch seems like a |
|
686 | 686 | # reasonable solution rather than asking users to manually use a |
|
687 | 687 | # different doctest runner when under IPython. |
|
688 | 688 | doctest.DocTestRunner.run = dhook_wrap(doctest.DocTestRunner.run) |
|
689 | 689 | |
|
690 | 690 | # Set user colors (don't do it in the constructor above so that it |
|
691 | 691 | # doesn't crash if colors option is invalid) |
|
692 | 692 | self.magic_colors(rc.colors) |
|
693 | 693 | |
|
694 | 694 | # Set calling of pdb on exceptions |
|
695 | 695 | self.call_pdb = rc.pdb |
|
696 | 696 | |
|
697 | 697 | # Load user aliases |
|
698 | 698 | for alias in rc.alias: |
|
699 | 699 | self.magic_alias(alias) |
|
700 | 700 | self.hooks.late_startup_hook() |
|
701 | 701 | |
|
702 | 702 | batchrun = False |
|
703 | 703 | for batchfile in [path(arg) for arg in self.rc.args |
|
704 | 704 | if arg.lower().endswith('.ipy')]: |
|
705 | 705 | if not batchfile.isfile(): |
|
706 | 706 | print "No such batch file:", batchfile |
|
707 | 707 | continue |
|
708 | 708 | self.api.runlines(batchfile.text()) |
|
709 | 709 | batchrun = True |
|
710 | 710 | if batchrun: |
|
711 | 711 | self.exit_now = True |
|
712 | 712 | |
|
713 | 713 | def add_builtins(self): |
|
714 | 714 | """Store ipython references into the builtin namespace. |
|
715 | 715 | |
|
716 | 716 | Some parts of ipython operate via builtins injected here, which hold a |
|
717 | 717 | reference to IPython itself.""" |
|
718 | 718 | |
|
719 | 719 | # TODO: deprecate all except _ip; 'jobs' should be installed |
|
720 | 720 | # by an extension and the rest are under _ip, ipalias is redundant |
|
721 | 721 | builtins_new = dict(__IPYTHON__ = self, |
|
722 | 722 | ip_set_hook = self.set_hook, |
|
723 | 723 | jobs = self.jobs, |
|
724 | 724 | ipmagic = wrap_deprecated(self.ipmagic,'_ip.magic()'), |
|
725 | 725 | ipalias = wrap_deprecated(self.ipalias), |
|
726 | 726 | ipsystem = wrap_deprecated(self.ipsystem,'_ip.system()'), |
|
727 | 727 | _ip = self.api |
|
728 | 728 | ) |
|
729 | 729 | for biname,bival in builtins_new.items(): |
|
730 | 730 | try: |
|
731 | 731 | # store the orignal value so we can restore it |
|
732 | 732 | self.builtins_added[biname] = __builtin__.__dict__[biname] |
|
733 | 733 | except KeyError: |
|
734 | 734 | # or mark that it wasn't defined, and we'll just delete it at |
|
735 | 735 | # cleanup |
|
736 | 736 | self.builtins_added[biname] = Undefined |
|
737 | 737 | __builtin__.__dict__[biname] = bival |
|
738 | 738 | |
|
739 | 739 | # Keep in the builtins a flag for when IPython is active. We set it |
|
740 | 740 | # with setdefault so that multiple nested IPythons don't clobber one |
|
741 | 741 | # another. Each will increase its value by one upon being activated, |
|
742 | 742 | # which also gives us a way to determine the nesting level. |
|
743 | 743 | __builtin__.__dict__.setdefault('__IPYTHON__active',0) |
|
744 | 744 | |
|
745 | 745 | def clean_builtins(self): |
|
746 | 746 | """Remove any builtins which might have been added by add_builtins, or |
|
747 | 747 | restore overwritten ones to their previous values.""" |
|
748 | 748 | for biname,bival in self.builtins_added.items(): |
|
749 | 749 | if bival is Undefined: |
|
750 | 750 | del __builtin__.__dict__[biname] |
|
751 | 751 | else: |
|
752 | 752 | __builtin__.__dict__[biname] = bival |
|
753 | 753 | self.builtins_added.clear() |
|
754 | 754 | |
|
755 | 755 | def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None): |
|
756 | 756 | """set_hook(name,hook) -> sets an internal IPython hook. |
|
757 | 757 | |
|
758 | 758 | IPython exposes some of its internal API as user-modifiable hooks. By |
|
759 | 759 | adding your function to one of these hooks, you can modify IPython's |
|
760 | 760 | behavior to call at runtime your own routines.""" |
|
761 | 761 | |
|
762 | 762 | # At some point in the future, this should validate the hook before it |
|
763 | 763 | # accepts it. Probably at least check that the hook takes the number |
|
764 | 764 | # of args it's supposed to. |
|
765 | 765 | |
|
766 | 766 | f = new.instancemethod(hook,self,self.__class__) |
|
767 | 767 | |
|
768 | 768 | # check if the hook is for strdispatcher first |
|
769 | 769 | if str_key is not None: |
|
770 | 770 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
771 | 771 | sdp.add_s(str_key, f, priority ) |
|
772 | 772 | self.strdispatchers[name] = sdp |
|
773 | 773 | return |
|
774 | 774 | if re_key is not None: |
|
775 | 775 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
776 | 776 | sdp.add_re(re.compile(re_key), f, priority ) |
|
777 | 777 | self.strdispatchers[name] = sdp |
|
778 | 778 | return |
|
779 | 779 | |
|
780 | 780 | dp = getattr(self.hooks, name, None) |
|
781 | 781 | if name not in IPython.hooks.__all__: |
|
782 | 782 | print "Warning! Hook '%s' is not one of %s" % (name, IPython.hooks.__all__ ) |
|
783 | 783 | if not dp: |
|
784 | 784 | dp = IPython.hooks.CommandChainDispatcher() |
|
785 | 785 | |
|
786 | 786 | try: |
|
787 | 787 | dp.add(f,priority) |
|
788 | 788 | except AttributeError: |
|
789 | 789 | # it was not commandchain, plain old func - replace |
|
790 | 790 | dp = f |
|
791 | 791 | |
|
792 | 792 | setattr(self.hooks,name, dp) |
|
793 | 793 | |
|
794 | 794 | |
|
795 | 795 | #setattr(self.hooks,name,new.instancemethod(hook,self,self.__class__)) |
|
796 | 796 | |
|
797 | 797 | def set_crash_handler(self,crashHandler): |
|
798 | 798 | """Set the IPython crash handler. |
|
799 | 799 | |
|
800 | 800 | This must be a callable with a signature suitable for use as |
|
801 | 801 | sys.excepthook.""" |
|
802 | 802 | |
|
803 | 803 | # Install the given crash handler as the Python exception hook |
|
804 | 804 | sys.excepthook = crashHandler |
|
805 | 805 | |
|
806 | 806 | # The instance will store a pointer to this, so that runtime code |
|
807 | 807 | # (such as magics) can access it. This is because during the |
|
808 | 808 | # read-eval loop, it gets temporarily overwritten (to deal with GUI |
|
809 | 809 | # frameworks). |
|
810 | 810 | self.sys_excepthook = sys.excepthook |
|
811 | 811 | |
|
812 | 812 | |
|
813 | 813 | def set_custom_exc(self,exc_tuple,handler): |
|
814 | 814 | """set_custom_exc(exc_tuple,handler) |
|
815 | 815 | |
|
816 | 816 | Set a custom exception handler, which will be called if any of the |
|
817 | 817 | exceptions in exc_tuple occur in the mainloop (specifically, in the |
|
818 | 818 | runcode() method. |
|
819 | 819 | |
|
820 | 820 | Inputs: |
|
821 | 821 | |
|
822 | 822 | - exc_tuple: a *tuple* of valid exceptions to call the defined |
|
823 | 823 | handler for. It is very important that you use a tuple, and NOT A |
|
824 | 824 | LIST here, because of the way Python's except statement works. If |
|
825 | 825 | you only want to trap a single exception, use a singleton tuple: |
|
826 | 826 | |
|
827 | 827 | exc_tuple == (MyCustomException,) |
|
828 | 828 | |
|
829 | 829 | - handler: this must be defined as a function with the following |
|
830 | 830 | basic interface: def my_handler(self,etype,value,tb). |
|
831 | 831 | |
|
832 | 832 | This will be made into an instance method (via new.instancemethod) |
|
833 | 833 | of IPython itself, and it will be called if any of the exceptions |
|
834 | 834 | listed in the exc_tuple are caught. If the handler is None, an |
|
835 | 835 | internal basic one is used, which just prints basic info. |
|
836 | 836 | |
|
837 | 837 | WARNING: by putting in your own exception handler into IPython's main |
|
838 | 838 | execution loop, you run a very good chance of nasty crashes. This |
|
839 | 839 | facility should only be used if you really know what you are doing.""" |
|
840 | 840 | |
|
841 | 841 | assert type(exc_tuple)==type(()) , \ |
|
842 | 842 | "The custom exceptions must be given AS A TUPLE." |
|
843 | 843 | |
|
844 | 844 | def dummy_handler(self,etype,value,tb): |
|
845 | 845 | print '*** Simple custom exception handler ***' |
|
846 | 846 | print 'Exception type :',etype |
|
847 | 847 | print 'Exception value:',value |
|
848 | 848 | print 'Traceback :',tb |
|
849 | 849 | print 'Source code :','\n'.join(self.buffer) |
|
850 | 850 | |
|
851 | 851 | if handler is None: handler = dummy_handler |
|
852 | 852 | |
|
853 | 853 | self.CustomTB = new.instancemethod(handler,self,self.__class__) |
|
854 | 854 | self.custom_exceptions = exc_tuple |
|
855 | 855 | |
|
856 | 856 | def set_custom_completer(self,completer,pos=0): |
|
857 | 857 | """set_custom_completer(completer,pos=0) |
|
858 | 858 | |
|
859 | 859 | Adds a new custom completer function. |
|
860 | 860 | |
|
861 | 861 | The position argument (defaults to 0) is the index in the completers |
|
862 | 862 | list where you want the completer to be inserted.""" |
|
863 | 863 | |
|
864 | 864 | newcomp = new.instancemethod(completer,self.Completer, |
|
865 | 865 | self.Completer.__class__) |
|
866 | 866 | self.Completer.matchers.insert(pos,newcomp) |
|
867 | 867 | |
|
868 | 868 | def set_completer(self): |
|
869 | 869 | """reset readline's completer to be our own.""" |
|
870 | 870 | self.readline.set_completer(self.Completer.complete) |
|
871 | 871 | |
|
872 | 872 | def _get_call_pdb(self): |
|
873 | 873 | return self._call_pdb |
|
874 | 874 | |
|
875 | 875 | def _set_call_pdb(self,val): |
|
876 | 876 | |
|
877 | 877 | if val not in (0,1,False,True): |
|
878 | 878 | raise ValueError,'new call_pdb value must be boolean' |
|
879 | 879 | |
|
880 | 880 | # store value in instance |
|
881 | 881 | self._call_pdb = val |
|
882 | 882 | |
|
883 | 883 | # notify the actual exception handlers |
|
884 | 884 | self.InteractiveTB.call_pdb = val |
|
885 | 885 | if self.isthreaded: |
|
886 | 886 | try: |
|
887 | 887 | self.sys_excepthook.call_pdb = val |
|
888 | 888 | except: |
|
889 | 889 | warn('Failed to activate pdb for threaded exception handler') |
|
890 | 890 | |
|
891 | 891 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, |
|
892 | 892 | 'Control auto-activation of pdb at exceptions') |
|
893 | 893 | |
|
894 | 894 | |
|
895 | 895 | # These special functions get installed in the builtin namespace, to |
|
896 | 896 | # provide programmatic (pure python) access to magics, aliases and system |
|
897 | 897 | # calls. This is important for logging, user scripting, and more. |
|
898 | 898 | |
|
899 | 899 | # We are basically exposing, via normal python functions, the three |
|
900 | 900 | # mechanisms in which ipython offers special call modes (magics for |
|
901 | 901 | # internal control, aliases for direct system access via pre-selected |
|
902 | 902 | # names, and !cmd for calling arbitrary system commands). |
|
903 | 903 | |
|
904 | 904 | def ipmagic(self,arg_s): |
|
905 | 905 | """Call a magic function by name. |
|
906 | 906 | |
|
907 | 907 | Input: a string containing the name of the magic function to call and any |
|
908 | 908 | additional arguments to be passed to the magic. |
|
909 | 909 | |
|
910 | 910 | ipmagic('name -opt foo bar') is equivalent to typing at the ipython |
|
911 | 911 | prompt: |
|
912 | 912 | |
|
913 | 913 | In[1]: %name -opt foo bar |
|
914 | 914 | |
|
915 | 915 | To call a magic without arguments, simply use ipmagic('name'). |
|
916 | 916 | |
|
917 | 917 | This provides a proper Python function to call IPython's magics in any |
|
918 | 918 | valid Python code you can type at the interpreter, including loops and |
|
919 | 919 | compound statements. It is added by IPython to the Python builtin |
|
920 | 920 | namespace upon initialization.""" |
|
921 | 921 | |
|
922 | 922 | args = arg_s.split(' ',1) |
|
923 | 923 | magic_name = args[0] |
|
924 | 924 | magic_name = magic_name.lstrip(self.ESC_MAGIC) |
|
925 | 925 | |
|
926 | 926 | try: |
|
927 | 927 | magic_args = args[1] |
|
928 | 928 | except IndexError: |
|
929 | 929 | magic_args = '' |
|
930 | 930 | fn = getattr(self,'magic_'+magic_name,None) |
|
931 | 931 | if fn is None: |
|
932 | 932 | error("Magic function `%s` not found." % magic_name) |
|
933 | 933 | else: |
|
934 | 934 | magic_args = self.var_expand(magic_args,1) |
|
935 | 935 | return fn(magic_args) |
|
936 | 936 | |
|
937 | 937 | def ipalias(self,arg_s): |
|
938 | 938 | """Call an alias by name. |
|
939 | 939 | |
|
940 | 940 | Input: a string containing the name of the alias to call and any |
|
941 | 941 | additional arguments to be passed to the magic. |
|
942 | 942 | |
|
943 | 943 | ipalias('name -opt foo bar') is equivalent to typing at the ipython |
|
944 | 944 | prompt: |
|
945 | 945 | |
|
946 | 946 | In[1]: name -opt foo bar |
|
947 | 947 | |
|
948 | 948 | To call an alias without arguments, simply use ipalias('name'). |
|
949 | 949 | |
|
950 | 950 | This provides a proper Python function to call IPython's aliases in any |
|
951 | 951 | valid Python code you can type at the interpreter, including loops and |
|
952 | 952 | compound statements. It is added by IPython to the Python builtin |
|
953 | 953 | namespace upon initialization.""" |
|
954 | 954 | |
|
955 | 955 | args = arg_s.split(' ',1) |
|
956 | 956 | alias_name = args[0] |
|
957 | 957 | try: |
|
958 | 958 | alias_args = args[1] |
|
959 | 959 | except IndexError: |
|
960 | 960 | alias_args = '' |
|
961 | 961 | if alias_name in self.alias_table: |
|
962 | 962 | self.call_alias(alias_name,alias_args) |
|
963 | 963 | else: |
|
964 | 964 | error("Alias `%s` not found." % alias_name) |
|
965 | 965 | |
|
966 | 966 | def ipsystem(self,arg_s): |
|
967 | 967 | """Make a system call, using IPython.""" |
|
968 | 968 | |
|
969 | 969 | self.system(arg_s) |
|
970 | 970 | |
|
971 | 971 | def complete(self,text): |
|
972 | 972 | """Return a sorted list of all possible completions on text. |
|
973 | 973 | |
|
974 | 974 | Inputs: |
|
975 | 975 | |
|
976 | 976 | - text: a string of text to be completed on. |
|
977 | 977 | |
|
978 | 978 | This is a wrapper around the completion mechanism, similar to what |
|
979 | 979 | readline does at the command line when the TAB key is hit. By |
|
980 | 980 | exposing it as a method, it can be used by other non-readline |
|
981 | 981 | environments (such as GUIs) for text completion. |
|
982 | 982 | |
|
983 | 983 | Simple usage example: |
|
984 | 984 | |
|
985 | 985 | In [1]: x = 'hello' |
|
986 | 986 | |
|
987 | 987 | In [2]: __IP.complete('x.l') |
|
988 | 988 | Out[2]: ['x.ljust', 'x.lower', 'x.lstrip']""" |
|
989 | 989 | |
|
990 | 990 | complete = self.Completer.complete |
|
991 | 991 | state = 0 |
|
992 | 992 | # use a dict so we get unique keys, since ipyhton's multiple |
|
993 | 993 | # completers can return duplicates. When we make 2.4 a requirement, |
|
994 | 994 | # start using sets instead, which are faster. |
|
995 | 995 | comps = {} |
|
996 | 996 | while True: |
|
997 | 997 | newcomp = complete(text,state,line_buffer=text) |
|
998 | 998 | if newcomp is None: |
|
999 | 999 | break |
|
1000 | 1000 | comps[newcomp] = 1 |
|
1001 | 1001 | state += 1 |
|
1002 | 1002 | outcomps = comps.keys() |
|
1003 | 1003 | outcomps.sort() |
|
1004 | 1004 | return outcomps |
|
1005 | 1005 | |
|
1006 | 1006 | def set_completer_frame(self, frame=None): |
|
1007 | 1007 | if frame: |
|
1008 | 1008 | self.Completer.namespace = frame.f_locals |
|
1009 | 1009 | self.Completer.global_namespace = frame.f_globals |
|
1010 | 1010 | else: |
|
1011 | 1011 | self.Completer.namespace = self.user_ns |
|
1012 | 1012 | self.Completer.global_namespace = self.user_global_ns |
|
1013 | 1013 | |
|
1014 | 1014 | def init_auto_alias(self): |
|
1015 | 1015 | """Define some aliases automatically. |
|
1016 | 1016 | |
|
1017 | 1017 | These are ALL parameter-less aliases""" |
|
1018 | 1018 | |
|
1019 | 1019 | for alias,cmd in self.auto_alias: |
|
1020 | 1020 | self.alias_table[alias] = (0,cmd) |
|
1021 | 1021 | |
|
1022 | 1022 | def alias_table_validate(self,verbose=0): |
|
1023 | 1023 | """Update information about the alias table. |
|
1024 | 1024 | |
|
1025 | 1025 | In particular, make sure no Python keywords/builtins are in it.""" |
|
1026 | 1026 | |
|
1027 | 1027 | no_alias = self.no_alias |
|
1028 | 1028 | for k in self.alias_table.keys(): |
|
1029 | 1029 | if k in no_alias: |
|
1030 | 1030 | del self.alias_table[k] |
|
1031 | 1031 | if verbose: |
|
1032 | 1032 | print ("Deleting alias <%s>, it's a Python " |
|
1033 | 1033 | "keyword or builtin." % k) |
|
1034 | 1034 | |
|
1035 | 1035 | def set_autoindent(self,value=None): |
|
1036 | 1036 | """Set the autoindent flag, checking for readline support. |
|
1037 | 1037 | |
|
1038 | 1038 | If called with no arguments, it acts as a toggle.""" |
|
1039 | 1039 | |
|
1040 | 1040 | if not self.has_readline: |
|
1041 | 1041 | if os.name == 'posix': |
|
1042 | 1042 | warn("The auto-indent feature requires the readline library") |
|
1043 | 1043 | self.autoindent = 0 |
|
1044 | 1044 | return |
|
1045 | 1045 | if value is None: |
|
1046 | 1046 | self.autoindent = not self.autoindent |
|
1047 | 1047 | else: |
|
1048 | 1048 | self.autoindent = value |
|
1049 | 1049 | |
|
1050 | 1050 | def rc_set_toggle(self,rc_field,value=None): |
|
1051 | 1051 | """Set or toggle a field in IPython's rc config. structure. |
|
1052 | 1052 | |
|
1053 | 1053 | If called with no arguments, it acts as a toggle. |
|
1054 | 1054 | |
|
1055 | 1055 | If called with a non-existent field, the resulting AttributeError |
|
1056 | 1056 | exception will propagate out.""" |
|
1057 | 1057 | |
|
1058 | 1058 | rc_val = getattr(self.rc,rc_field) |
|
1059 | 1059 | if value is None: |
|
1060 | 1060 | value = not rc_val |
|
1061 | 1061 | setattr(self.rc,rc_field,value) |
|
1062 | 1062 | |
|
1063 | 1063 | def user_setup(self,ipythondir,rc_suffix,mode='install'): |
|
1064 | 1064 | """Install the user configuration directory. |
|
1065 | 1065 | |
|
1066 | 1066 | Can be called when running for the first time or to upgrade the user's |
|
1067 | 1067 | .ipython/ directory with the mode parameter. Valid modes are 'install' |
|
1068 | 1068 | and 'upgrade'.""" |
|
1069 | 1069 | |
|
1070 | 1070 | def wait(): |
|
1071 | 1071 | try: |
|
1072 | 1072 | raw_input("Please press <RETURN> to start IPython.") |
|
1073 | 1073 | except EOFError: |
|
1074 | 1074 | print >> Term.cout |
|
1075 | 1075 | print '*'*70 |
|
1076 | 1076 | |
|
1077 | 1077 | cwd = os.getcwd() # remember where we started |
|
1078 | 1078 | glb = glob.glob |
|
1079 | 1079 | print '*'*70 |
|
1080 | 1080 | if mode == 'install': |
|
1081 | 1081 | print \ |
|
1082 | 1082 | """Welcome to IPython. I will try to create a personal configuration directory |
|
1083 | 1083 | where you can customize many aspects of IPython's functionality in:\n""" |
|
1084 | 1084 | else: |
|
1085 | 1085 | print 'I am going to upgrade your configuration in:' |
|
1086 | 1086 | |
|
1087 | 1087 | print ipythondir |
|
1088 | 1088 | |
|
1089 | 1089 | rcdirend = os.path.join('IPython','UserConfig') |
|
1090 | 1090 | cfg = lambda d: os.path.join(d,rcdirend) |
|
1091 | 1091 | try: |
|
1092 | 1092 | rcdir = filter(os.path.isdir,map(cfg,sys.path))[0] |
|
1093 | 1093 | except IOError: |
|
1094 | 1094 | warning = """ |
|
1095 | 1095 | Installation error. IPython's directory was not found. |
|
1096 | 1096 | |
|
1097 | 1097 | Check the following: |
|
1098 | 1098 | |
|
1099 | 1099 | The ipython/IPython directory should be in a directory belonging to your |
|
1100 | 1100 | PYTHONPATH environment variable (that is, it should be in a directory |
|
1101 | 1101 | belonging to sys.path). You can copy it explicitly there or just link to it. |
|
1102 | 1102 | |
|
1103 | 1103 | IPython will proceed with builtin defaults. |
|
1104 | 1104 | """ |
|
1105 | 1105 | warn(warning) |
|
1106 | 1106 | wait() |
|
1107 | 1107 | return |
|
1108 | 1108 | |
|
1109 | 1109 | if mode == 'install': |
|
1110 | 1110 | try: |
|
1111 | 1111 | shutil.copytree(rcdir,ipythondir) |
|
1112 | 1112 | os.chdir(ipythondir) |
|
1113 | 1113 | rc_files = glb("ipythonrc*") |
|
1114 | 1114 | for rc_file in rc_files: |
|
1115 | 1115 | os.rename(rc_file,rc_file+rc_suffix) |
|
1116 | 1116 | except: |
|
1117 | 1117 | warning = """ |
|
1118 | 1118 | |
|
1119 | 1119 | There was a problem with the installation: |
|
1120 | 1120 | %s |
|
1121 | 1121 | Try to correct it or contact the developers if you think it's a bug. |
|
1122 | 1122 | IPython will proceed with builtin defaults.""" % sys.exc_info()[1] |
|
1123 | 1123 | warn(warning) |
|
1124 | 1124 | wait() |
|
1125 | 1125 | return |
|
1126 | 1126 | |
|
1127 | 1127 | elif mode == 'upgrade': |
|
1128 | 1128 | try: |
|
1129 | 1129 | os.chdir(ipythondir) |
|
1130 | 1130 | except: |
|
1131 | 1131 | print """ |
|
1132 | 1132 | Can not upgrade: changing to directory %s failed. Details: |
|
1133 | 1133 | %s |
|
1134 | 1134 | """ % (ipythondir,sys.exc_info()[1]) |
|
1135 | 1135 | wait() |
|
1136 | 1136 | return |
|
1137 | 1137 | else: |
|
1138 | 1138 | sources = glb(os.path.join(rcdir,'[A-Za-z]*')) |
|
1139 | 1139 | for new_full_path in sources: |
|
1140 | 1140 | new_filename = os.path.basename(new_full_path) |
|
1141 | 1141 | if new_filename.startswith('ipythonrc'): |
|
1142 | 1142 | new_filename = new_filename + rc_suffix |
|
1143 | 1143 | # The config directory should only contain files, skip any |
|
1144 | 1144 | # directories which may be there (like CVS) |
|
1145 | 1145 | if os.path.isdir(new_full_path): |
|
1146 | 1146 | continue |
|
1147 | 1147 | if os.path.exists(new_filename): |
|
1148 | 1148 | old_file = new_filename+'.old' |
|
1149 | 1149 | if os.path.exists(old_file): |
|
1150 | 1150 | os.remove(old_file) |
|
1151 | 1151 | os.rename(new_filename,old_file) |
|
1152 | 1152 | shutil.copy(new_full_path,new_filename) |
|
1153 | 1153 | else: |
|
1154 | 1154 | raise ValueError,'unrecognized mode for install:',`mode` |
|
1155 | 1155 | |
|
1156 | 1156 | # Fix line-endings to those native to each platform in the config |
|
1157 | 1157 | # directory. |
|
1158 | 1158 | try: |
|
1159 | 1159 | os.chdir(ipythondir) |
|
1160 | 1160 | except: |
|
1161 | 1161 | print """ |
|
1162 | 1162 | Problem: changing to directory %s failed. |
|
1163 | 1163 | Details: |
|
1164 | 1164 | %s |
|
1165 | 1165 | |
|
1166 | 1166 | Some configuration files may have incorrect line endings. This should not |
|
1167 | 1167 | cause any problems during execution. """ % (ipythondir,sys.exc_info()[1]) |
|
1168 | 1168 | wait() |
|
1169 | 1169 | else: |
|
1170 | 1170 | for fname in glb('ipythonrc*'): |
|
1171 | 1171 | try: |
|
1172 | 1172 | native_line_ends(fname,backup=0) |
|
1173 | 1173 | except IOError: |
|
1174 | 1174 | pass |
|
1175 | 1175 | |
|
1176 | 1176 | if mode == 'install': |
|
1177 | 1177 | print """ |
|
1178 | 1178 | Successful installation! |
|
1179 | 1179 | |
|
1180 | 1180 | Please read the sections 'Initial Configuration' and 'Quick Tips' in the |
|
1181 | 1181 | IPython manual (there are both HTML and PDF versions supplied with the |
|
1182 | 1182 | distribution) to make sure that your system environment is properly configured |
|
1183 | 1183 | to take advantage of IPython's features. |
|
1184 | 1184 | |
|
1185 | 1185 | Important note: the configuration system has changed! The old system is |
|
1186 | 1186 | still in place, but its setting may be partly overridden by the settings in |
|
1187 | 1187 | "~/.ipython/ipy_user_conf.py" config file. Please take a look at the file |
|
1188 | 1188 | if some of the new settings bother you. |
|
1189 | 1189 | |
|
1190 | 1190 | """ |
|
1191 | 1191 | else: |
|
1192 | 1192 | print """ |
|
1193 | 1193 | Successful upgrade! |
|
1194 | 1194 | |
|
1195 | 1195 | All files in your directory: |
|
1196 | 1196 | %(ipythondir)s |
|
1197 | 1197 | which would have been overwritten by the upgrade were backed up with a .old |
|
1198 | 1198 | extension. If you had made particular customizations in those files you may |
|
1199 | 1199 | want to merge them back into the new files.""" % locals() |
|
1200 | 1200 | wait() |
|
1201 | 1201 | os.chdir(cwd) |
|
1202 | 1202 | # end user_setup() |
|
1203 | 1203 | |
|
1204 | 1204 | def atexit_operations(self): |
|
1205 | 1205 | """This will be executed at the time of exit. |
|
1206 | 1206 | |
|
1207 | 1207 | Saving of persistent data should be performed here. """ |
|
1208 | 1208 | |
|
1209 | 1209 | #print '*** IPython exit cleanup ***' # dbg |
|
1210 | 1210 | # input history |
|
1211 | 1211 | self.savehist() |
|
1212 | 1212 | |
|
1213 | 1213 | # Cleanup all tempfiles left around |
|
1214 | 1214 | for tfile in self.tempfiles: |
|
1215 | 1215 | try: |
|
1216 | 1216 | os.unlink(tfile) |
|
1217 | 1217 | except OSError: |
|
1218 | 1218 | pass |
|
1219 | 1219 | |
|
1220 | 1220 | self.hooks.shutdown_hook() |
|
1221 | 1221 | |
|
1222 | 1222 | def savehist(self): |
|
1223 | 1223 | """Save input history to a file (via readline library).""" |
|
1224 | 1224 | try: |
|
1225 | 1225 | self.readline.write_history_file(self.histfile) |
|
1226 | 1226 | except: |
|
1227 | 1227 | print 'Unable to save IPython command history to file: ' + \ |
|
1228 | 1228 | `self.histfile` |
|
1229 | 1229 | |
|
1230 | 1230 | def reloadhist(self): |
|
1231 | 1231 | """Reload the input history from disk file.""" |
|
1232 | 1232 | |
|
1233 | 1233 | if self.has_readline: |
|
1234 | 1234 | self.readline.clear_history() |
|
1235 | 1235 | self.readline.read_history_file(self.shell.histfile) |
|
1236 | 1236 | |
|
1237 | 1237 | def history_saving_wrapper(self, func): |
|
1238 | 1238 | """ Wrap func for readline history saving |
|
1239 | 1239 | |
|
1240 | 1240 | Convert func into callable that saves & restores |
|
1241 | 1241 | history around the call """ |
|
1242 | 1242 | |
|
1243 | 1243 | if not self.has_readline: |
|
1244 | 1244 | return func |
|
1245 | 1245 | |
|
1246 | 1246 | def wrapper(): |
|
1247 | 1247 | self.savehist() |
|
1248 | 1248 | try: |
|
1249 | 1249 | func() |
|
1250 | 1250 | finally: |
|
1251 | 1251 | readline.read_history_file(self.histfile) |
|
1252 | 1252 | return wrapper |
|
1253 | 1253 | |
|
1254 | 1254 | |
|
1255 | 1255 | def pre_readline(self): |
|
1256 | 1256 | """readline hook to be used at the start of each line. |
|
1257 | 1257 | |
|
1258 | 1258 | Currently it handles auto-indent only.""" |
|
1259 | 1259 | |
|
1260 | 1260 | #debugx('self.indent_current_nsp','pre_readline:') |
|
1261 | 1261 | |
|
1262 | 1262 | if self.rl_do_indent: |
|
1263 | 1263 | self.readline.insert_text(self.indent_current_str()) |
|
1264 | 1264 | if self.rl_next_input is not None: |
|
1265 | 1265 | self.readline.insert_text(self.rl_next_input) |
|
1266 | 1266 | self.rl_next_input = None |
|
1267 | 1267 | |
|
1268 | 1268 | def init_readline(self): |
|
1269 | 1269 | """Command history completion/saving/reloading.""" |
|
1270 | 1270 | |
|
1271 | 1271 | import IPython.rlineimpl as readline |
|
1272 | 1272 | if not readline.have_readline: |
|
1273 | 1273 | self.has_readline = 0 |
|
1274 | 1274 | self.readline = None |
|
1275 | 1275 | # no point in bugging windows users with this every time: |
|
1276 | 1276 | warn('Readline services not available on this platform.') |
|
1277 | 1277 | else: |
|
1278 | 1278 | sys.modules['readline'] = readline |
|
1279 | 1279 | import atexit |
|
1280 | 1280 | from IPython.completer import IPCompleter |
|
1281 | 1281 | self.Completer = IPCompleter(self, |
|
1282 | 1282 | self.user_ns, |
|
1283 | 1283 | self.user_global_ns, |
|
1284 | 1284 | self.rc.readline_omit__names, |
|
1285 | 1285 | self.alias_table) |
|
1286 | 1286 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) |
|
1287 | 1287 | self.strdispatchers['complete_command'] = sdisp |
|
1288 | 1288 | self.Completer.custom_completers = sdisp |
|
1289 | 1289 | # Platform-specific configuration |
|
1290 | 1290 | if os.name == 'nt': |
|
1291 | 1291 | self.readline_startup_hook = readline.set_pre_input_hook |
|
1292 | 1292 | else: |
|
1293 | 1293 | self.readline_startup_hook = readline.set_startup_hook |
|
1294 | 1294 | |
|
1295 | 1295 | # Load user's initrc file (readline config) |
|
1296 | 1296 | inputrc_name = os.environ.get('INPUTRC') |
|
1297 | 1297 | if inputrc_name is None: |
|
1298 | 1298 | home_dir = get_home_dir() |
|
1299 | 1299 | if home_dir is not None: |
|
1300 | 1300 | inputrc_name = os.path.join(home_dir,'.inputrc') |
|
1301 | 1301 | if os.path.isfile(inputrc_name): |
|
1302 | 1302 | try: |
|
1303 | 1303 | readline.read_init_file(inputrc_name) |
|
1304 | 1304 | except: |
|
1305 | 1305 | warn('Problems reading readline initialization file <%s>' |
|
1306 | 1306 | % inputrc_name) |
|
1307 | 1307 | |
|
1308 | 1308 | self.has_readline = 1 |
|
1309 | 1309 | self.readline = readline |
|
1310 | 1310 | # save this in sys so embedded copies can restore it properly |
|
1311 | 1311 | sys.ipcompleter = self.Completer.complete |
|
1312 | 1312 | self.set_completer() |
|
1313 | 1313 | |
|
1314 | 1314 | # Configure readline according to user's prefs |
|
1315 | 1315 | for rlcommand in self.rc.readline_parse_and_bind: |
|
1316 | 1316 | readline.parse_and_bind(rlcommand) |
|
1317 | 1317 | |
|
1318 | 1318 | # remove some chars from the delimiters list |
|
1319 | 1319 | delims = readline.get_completer_delims() |
|
1320 | 1320 | delims = delims.translate(string._idmap, |
|
1321 | 1321 | self.rc.readline_remove_delims) |
|
1322 | 1322 | readline.set_completer_delims(delims) |
|
1323 | 1323 | # otherwise we end up with a monster history after a while: |
|
1324 | 1324 | readline.set_history_length(1000) |
|
1325 | 1325 | try: |
|
1326 | 1326 | #print '*** Reading readline history' # dbg |
|
1327 | 1327 | readline.read_history_file(self.histfile) |
|
1328 | 1328 | except IOError: |
|
1329 | 1329 | pass # It doesn't exist yet. |
|
1330 | 1330 | |
|
1331 | 1331 | atexit.register(self.atexit_operations) |
|
1332 | 1332 | del atexit |
|
1333 | 1333 | |
|
1334 | 1334 | # Configure auto-indent for all platforms |
|
1335 | 1335 | self.set_autoindent(self.rc.autoindent) |
|
1336 | 1336 | |
|
1337 | 1337 | def ask_yes_no(self,prompt,default=True): |
|
1338 | 1338 | if self.rc.quiet: |
|
1339 | 1339 | return True |
|
1340 | 1340 | return ask_yes_no(prompt,default) |
|
1341 | 1341 | |
|
1342 | 1342 | def _should_recompile(self,e): |
|
1343 | 1343 | """Utility routine for edit_syntax_error""" |
|
1344 | 1344 | |
|
1345 | 1345 | if e.filename in ('<ipython console>','<input>','<string>', |
|
1346 | 1346 | '<console>','<BackgroundJob compilation>', |
|
1347 | 1347 | None): |
|
1348 | 1348 | |
|
1349 | 1349 | return False |
|
1350 | 1350 | try: |
|
1351 | 1351 | if (self.rc.autoedit_syntax and |
|
1352 | 1352 | not self.ask_yes_no('Return to editor to correct syntax error? ' |
|
1353 | 1353 | '[Y/n] ','y')): |
|
1354 | 1354 | return False |
|
1355 | 1355 | except EOFError: |
|
1356 | 1356 | return False |
|
1357 | 1357 | |
|
1358 | 1358 | def int0(x): |
|
1359 | 1359 | try: |
|
1360 | 1360 | return int(x) |
|
1361 | 1361 | except TypeError: |
|
1362 | 1362 | return 0 |
|
1363 | 1363 | # always pass integer line and offset values to editor hook |
|
1364 | 1364 | self.hooks.fix_error_editor(e.filename, |
|
1365 | 1365 | int0(e.lineno),int0(e.offset),e.msg) |
|
1366 | 1366 | return True |
|
1367 | 1367 | |
|
1368 | 1368 | def edit_syntax_error(self): |
|
1369 | 1369 | """The bottom half of the syntax error handler called in the main loop. |
|
1370 | 1370 | |
|
1371 | 1371 | Loop until syntax error is fixed or user cancels. |
|
1372 | 1372 | """ |
|
1373 | 1373 | |
|
1374 | 1374 | while self.SyntaxTB.last_syntax_error: |
|
1375 | 1375 | # copy and clear last_syntax_error |
|
1376 | 1376 | err = self.SyntaxTB.clear_err_state() |
|
1377 | 1377 | if not self._should_recompile(err): |
|
1378 | 1378 | return |
|
1379 | 1379 | try: |
|
1380 | 1380 | # may set last_syntax_error again if a SyntaxError is raised |
|
1381 | 1381 | self.safe_execfile(err.filename,self.user_ns) |
|
1382 | 1382 | except: |
|
1383 | 1383 | self.showtraceback() |
|
1384 | 1384 | else: |
|
1385 | 1385 | try: |
|
1386 | 1386 | f = file(err.filename) |
|
1387 | 1387 | try: |
|
1388 | 1388 | sys.displayhook(f.read()) |
|
1389 | 1389 | finally: |
|
1390 | 1390 | f.close() |
|
1391 | 1391 | except: |
|
1392 | 1392 | self.showtraceback() |
|
1393 | 1393 | |
|
1394 | 1394 | def showsyntaxerror(self, filename=None): |
|
1395 | 1395 | """Display the syntax error that just occurred. |
|
1396 | 1396 | |
|
1397 | 1397 | This doesn't display a stack trace because there isn't one. |
|
1398 | 1398 | |
|
1399 | 1399 | If a filename is given, it is stuffed in the exception instead |
|
1400 | 1400 | of what was there before (because Python's parser always uses |
|
1401 | 1401 | "<string>" when reading from a string). |
|
1402 | 1402 | """ |
|
1403 | 1403 | etype, value, last_traceback = sys.exc_info() |
|
1404 | 1404 | |
|
1405 | 1405 | # See note about these variables in showtraceback() below |
|
1406 | 1406 | sys.last_type = etype |
|
1407 | 1407 | sys.last_value = value |
|
1408 | 1408 | sys.last_traceback = last_traceback |
|
1409 | 1409 | |
|
1410 | 1410 | if filename and etype is SyntaxError: |
|
1411 | 1411 | # Work hard to stuff the correct filename in the exception |
|
1412 | 1412 | try: |
|
1413 | 1413 | msg, (dummy_filename, lineno, offset, line) = value |
|
1414 | 1414 | except: |
|
1415 | 1415 | # Not the format we expect; leave it alone |
|
1416 | 1416 | pass |
|
1417 | 1417 | else: |
|
1418 | 1418 | # Stuff in the right filename |
|
1419 | 1419 | try: |
|
1420 | 1420 | # Assume SyntaxError is a class exception |
|
1421 | 1421 | value = SyntaxError(msg, (filename, lineno, offset, line)) |
|
1422 | 1422 | except: |
|
1423 | 1423 | # If that failed, assume SyntaxError is a string |
|
1424 | 1424 | value = msg, (filename, lineno, offset, line) |
|
1425 | 1425 | self.SyntaxTB(etype,value,[]) |
|
1426 | 1426 | |
|
1427 | 1427 | def debugger(self,force=False): |
|
1428 | 1428 | """Call the pydb/pdb debugger. |
|
1429 | 1429 | |
|
1430 | 1430 | Keywords: |
|
1431 | 1431 | |
|
1432 | 1432 | - force(False): by default, this routine checks the instance call_pdb |
|
1433 | 1433 | flag and does not actually invoke the debugger if the flag is false. |
|
1434 | 1434 | The 'force' option forces the debugger to activate even if the flag |
|
1435 | 1435 | is false. |
|
1436 | 1436 | """ |
|
1437 | 1437 | |
|
1438 | 1438 | if not (force or self.call_pdb): |
|
1439 | 1439 | return |
|
1440 | 1440 | |
|
1441 | 1441 | if not hasattr(sys,'last_traceback'): |
|
1442 | 1442 | error('No traceback has been produced, nothing to debug.') |
|
1443 | 1443 | return |
|
1444 | 1444 | |
|
1445 | 1445 | # use pydb if available |
|
1446 | 1446 | if Debugger.has_pydb: |
|
1447 | 1447 | from pydb import pm |
|
1448 | 1448 | else: |
|
1449 | 1449 | # fallback to our internal debugger |
|
1450 | 1450 | pm = lambda : self.InteractiveTB.debugger(force=True) |
|
1451 | 1451 | self.history_saving_wrapper(pm)() |
|
1452 | 1452 | |
|
1453 | 1453 | def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None): |
|
1454 | 1454 | """Display the exception that just occurred. |
|
1455 | 1455 | |
|
1456 | 1456 | If nothing is known about the exception, this is the method which |
|
1457 | 1457 | should be used throughout the code for presenting user tracebacks, |
|
1458 | 1458 | rather than directly invoking the InteractiveTB object. |
|
1459 | 1459 | |
|
1460 | 1460 | A specific showsyntaxerror() also exists, but this method can take |
|
1461 | 1461 | care of calling it if needed, so unless you are explicitly catching a |
|
1462 | 1462 | SyntaxError exception, don't try to analyze the stack manually and |
|
1463 | 1463 | simply call this method.""" |
|
1464 | 1464 | |
|
1465 | 1465 | |
|
1466 | 1466 | # Though this won't be called by syntax errors in the input line, |
|
1467 | 1467 | # there may be SyntaxError cases whith imported code. |
|
1468 | 1468 | |
|
1469 | 1469 | |
|
1470 | 1470 | if exc_tuple is None: |
|
1471 | 1471 | etype, value, tb = sys.exc_info() |
|
1472 | 1472 | else: |
|
1473 | 1473 | etype, value, tb = exc_tuple |
|
1474 | 1474 | |
|
1475 | 1475 | if etype is SyntaxError: |
|
1476 | 1476 | self.showsyntaxerror(filename) |
|
1477 | 1477 | else: |
|
1478 | 1478 | # WARNING: these variables are somewhat deprecated and not |
|
1479 | 1479 | # necessarily safe to use in a threaded environment, but tools |
|
1480 | 1480 | # like pdb depend on their existence, so let's set them. If we |
|
1481 | 1481 | # find problems in the field, we'll need to revisit their use. |
|
1482 | 1482 | sys.last_type = etype |
|
1483 | 1483 | sys.last_value = value |
|
1484 | 1484 | sys.last_traceback = tb |
|
1485 | 1485 | |
|
1486 | 1486 | if etype in self.custom_exceptions: |
|
1487 | 1487 | self.CustomTB(etype,value,tb) |
|
1488 | 1488 | else: |
|
1489 | 1489 | self.InteractiveTB(etype,value,tb,tb_offset=tb_offset) |
|
1490 | 1490 | if self.InteractiveTB.call_pdb and self.has_readline: |
|
1491 | 1491 | # pdb mucks up readline, fix it back |
|
1492 | 1492 | self.set_completer() |
|
1493 | 1493 | |
|
1494 | 1494 | |
|
1495 | 1495 | def mainloop(self,banner=None): |
|
1496 | 1496 | """Creates the local namespace and starts the mainloop. |
|
1497 | 1497 | |
|
1498 | 1498 | If an optional banner argument is given, it will override the |
|
1499 | 1499 | internally created default banner.""" |
|
1500 | 1500 | |
|
1501 | 1501 | if self.rc.c: # Emulate Python's -c option |
|
1502 | 1502 | self.exec_init_cmd() |
|
1503 | 1503 | if banner is None: |
|
1504 | 1504 | if not self.rc.banner: |
|
1505 | 1505 | banner = '' |
|
1506 | 1506 | # banner is string? Use it directly! |
|
1507 | 1507 | elif isinstance(self.rc.banner,basestring): |
|
1508 | 1508 | banner = self.rc.banner |
|
1509 | 1509 | else: |
|
1510 | 1510 | banner = self.BANNER+self.banner2 |
|
1511 | 1511 | |
|
1512 | 1512 | self.interact(banner) |
|
1513 | 1513 | |
|
1514 | 1514 | def exec_init_cmd(self): |
|
1515 | 1515 | """Execute a command given at the command line. |
|
1516 | 1516 | |
|
1517 | 1517 | This emulates Python's -c option.""" |
|
1518 | 1518 | |
|
1519 | 1519 | #sys.argv = ['-c'] |
|
1520 | 1520 | self.push(self.prefilter(self.rc.c, False)) |
|
1521 | 1521 | self.exit_now = True |
|
1522 | 1522 | |
|
1523 | 1523 | def embed_mainloop(self,header='',local_ns=None,global_ns=None,stack_depth=0): |
|
1524 | 1524 | """Embeds IPython into a running python program. |
|
1525 | 1525 | |
|
1526 | 1526 | Input: |
|
1527 | 1527 | |
|
1528 | 1528 | - header: An optional header message can be specified. |
|
1529 | 1529 | |
|
1530 | 1530 | - local_ns, global_ns: working namespaces. If given as None, the |
|
1531 | 1531 | IPython-initialized one is updated with __main__.__dict__, so that |
|
1532 | 1532 | program variables become visible but user-specific configuration |
|
1533 | 1533 | remains possible. |
|
1534 | 1534 | |
|
1535 | 1535 | - stack_depth: specifies how many levels in the stack to go to |
|
1536 | 1536 | looking for namespaces (when local_ns and global_ns are None). This |
|
1537 | 1537 | allows an intermediate caller to make sure that this function gets |
|
1538 | 1538 | the namespace from the intended level in the stack. By default (0) |
|
1539 | 1539 | it will get its locals and globals from the immediate caller. |
|
1540 | 1540 | |
|
1541 | 1541 | Warning: it's possible to use this in a program which is being run by |
|
1542 | 1542 | IPython itself (via %run), but some funny things will happen (a few |
|
1543 | 1543 | globals get overwritten). In the future this will be cleaned up, as |
|
1544 | 1544 | there is no fundamental reason why it can't work perfectly.""" |
|
1545 | 1545 | |
|
1546 | 1546 | # Get locals and globals from caller |
|
1547 | 1547 | if local_ns is None or global_ns is None: |
|
1548 | 1548 | call_frame = sys._getframe(stack_depth).f_back |
|
1549 | 1549 | |
|
1550 | 1550 | if local_ns is None: |
|
1551 | 1551 | local_ns = call_frame.f_locals |
|
1552 | 1552 | if global_ns is None: |
|
1553 | 1553 | global_ns = call_frame.f_globals |
|
1554 | 1554 | |
|
1555 | 1555 | # Update namespaces and fire up interpreter |
|
1556 | 1556 | |
|
1557 | 1557 | # The global one is easy, we can just throw it in |
|
1558 | 1558 | self.user_global_ns = global_ns |
|
1559 | 1559 | |
|
1560 | 1560 | # but the user/local one is tricky: ipython needs it to store internal |
|
1561 | 1561 | # data, but we also need the locals. We'll copy locals in the user |
|
1562 | 1562 | # one, but will track what got copied so we can delete them at exit. |
|
1563 | 1563 | # This is so that a later embedded call doesn't see locals from a |
|
1564 | 1564 | # previous call (which most likely existed in a separate scope). |
|
1565 | 1565 | local_varnames = local_ns.keys() |
|
1566 | 1566 | self.user_ns.update(local_ns) |
|
1567 | 1567 | |
|
1568 | 1568 | # Patch for global embedding to make sure that things don't overwrite |
|
1569 | 1569 | # user globals accidentally. Thanks to Richard <rxe@renre-europe.com> |
|
1570 | 1570 | # FIXME. Test this a bit more carefully (the if.. is new) |
|
1571 | 1571 | if local_ns is None and global_ns is None: |
|
1572 | 1572 | self.user_global_ns.update(__main__.__dict__) |
|
1573 | 1573 | |
|
1574 | 1574 | # make sure the tab-completer has the correct frame information, so it |
|
1575 | 1575 | # actually completes using the frame's locals/globals |
|
1576 | 1576 | self.set_completer_frame() |
|
1577 | 1577 | |
|
1578 | 1578 | # before activating the interactive mode, we need to make sure that |
|
1579 | 1579 | # all names in the builtin namespace needed by ipython point to |
|
1580 | 1580 | # ourselves, and not to other instances. |
|
1581 | 1581 | self.add_builtins() |
|
1582 | 1582 | |
|
1583 | 1583 | self.interact(header) |
|
1584 | 1584 | |
|
1585 | 1585 | # now, purge out the user namespace from anything we might have added |
|
1586 | 1586 | # from the caller's local namespace |
|
1587 | 1587 | delvar = self.user_ns.pop |
|
1588 | 1588 | for var in local_varnames: |
|
1589 | 1589 | delvar(var,None) |
|
1590 | 1590 | # and clean builtins we may have overridden |
|
1591 | 1591 | self.clean_builtins() |
|
1592 | 1592 | |
|
1593 | 1593 | def interact(self, banner=None): |
|
1594 | 1594 | """Closely emulate the interactive Python console. |
|
1595 | 1595 | |
|
1596 | 1596 | The optional banner argument specify the banner to print |
|
1597 | 1597 | before the first interaction; by default it prints a banner |
|
1598 | 1598 | similar to the one printed by the real Python interpreter, |
|
1599 | 1599 | followed by the current class name in parentheses (so as not |
|
1600 | 1600 | to confuse this with the real interpreter -- since it's so |
|
1601 | 1601 | close!). |
|
1602 | 1602 | |
|
1603 | 1603 | """ |
|
1604 | 1604 | |
|
1605 | 1605 | if self.exit_now: |
|
1606 | 1606 | # batch run -> do not interact |
|
1607 | 1607 | return |
|
1608 | 1608 | cprt = 'Type "copyright", "credits" or "license" for more information.' |
|
1609 | 1609 | if banner is None: |
|
1610 | 1610 | self.write("Python %s on %s\n%s\n(%s)\n" % |
|
1611 | 1611 | (sys.version, sys.platform, cprt, |
|
1612 | 1612 | self.__class__.__name__)) |
|
1613 | 1613 | else: |
|
1614 | 1614 | self.write(banner) |
|
1615 | 1615 | |
|
1616 | 1616 | more = 0 |
|
1617 | 1617 | |
|
1618 | 1618 | # Mark activity in the builtins |
|
1619 | 1619 | __builtin__.__dict__['__IPYTHON__active'] += 1 |
|
1620 | 1620 | |
|
1621 | 1621 | if readline.have_readline: |
|
1622 | 1622 | self.readline_startup_hook(self.pre_readline) |
|
1623 | 1623 | # exit_now is set by a call to %Exit or %Quit |
|
1624 | 1624 | |
|
1625 | 1625 | while not self.exit_now: |
|
1626 | 1626 | if more: |
|
1627 | 1627 | prompt = self.hooks.generate_prompt(True) |
|
1628 | 1628 | if self.autoindent: |
|
1629 | 1629 | self.rl_do_indent = True |
|
1630 | 1630 | |
|
1631 | 1631 | else: |
|
1632 | 1632 | prompt = self.hooks.generate_prompt(False) |
|
1633 | 1633 | try: |
|
1634 | 1634 | line = self.raw_input(prompt,more) |
|
1635 | 1635 | if self.exit_now: |
|
1636 | 1636 | # quick exit on sys.std[in|out] close |
|
1637 | 1637 | break |
|
1638 | 1638 | if self.autoindent: |
|
1639 | 1639 | self.rl_do_indent = False |
|
1640 | 1640 | |
|
1641 | 1641 | except KeyboardInterrupt: |
|
1642 | 1642 | self.write('\nKeyboardInterrupt\n') |
|
1643 | 1643 | self.resetbuffer() |
|
1644 | 1644 | # keep cache in sync with the prompt counter: |
|
1645 | 1645 | self.outputcache.prompt_count -= 1 |
|
1646 | 1646 | |
|
1647 | 1647 | if self.autoindent: |
|
1648 | 1648 | self.indent_current_nsp = 0 |
|
1649 | 1649 | more = 0 |
|
1650 | 1650 | except EOFError: |
|
1651 | 1651 | if self.autoindent: |
|
1652 | 1652 | self.rl_do_indent = False |
|
1653 | 1653 | self.readline_startup_hook(None) |
|
1654 | 1654 | self.write('\n') |
|
1655 | 1655 | self.exit() |
|
1656 | 1656 | except bdb.BdbQuit: |
|
1657 | 1657 | warn('The Python debugger has exited with a BdbQuit exception.\n' |
|
1658 | 1658 | 'Because of how pdb handles the stack, it is impossible\n' |
|
1659 | 1659 | 'for IPython to properly format this particular exception.\n' |
|
1660 | 1660 | 'IPython will resume normal operation.') |
|
1661 | 1661 | except: |
|
1662 | 1662 | # exceptions here are VERY RARE, but they can be triggered |
|
1663 | 1663 | # asynchronously by signal handlers, for example. |
|
1664 | 1664 | self.showtraceback() |
|
1665 | 1665 | else: |
|
1666 | 1666 | more = self.push(line) |
|
1667 | 1667 | if (self.SyntaxTB.last_syntax_error and |
|
1668 | 1668 | self.rc.autoedit_syntax): |
|
1669 | 1669 | self.edit_syntax_error() |
|
1670 | 1670 | |
|
1671 | 1671 | # We are off again... |
|
1672 | 1672 | __builtin__.__dict__['__IPYTHON__active'] -= 1 |
|
1673 | 1673 | |
|
1674 | 1674 | def excepthook(self, etype, value, tb): |
|
1675 | 1675 | """One more defense for GUI apps that call sys.excepthook. |
|
1676 | 1676 | |
|
1677 | 1677 | GUI frameworks like wxPython trap exceptions and call |
|
1678 | 1678 | sys.excepthook themselves. I guess this is a feature that |
|
1679 | 1679 | enables them to keep running after exceptions that would |
|
1680 | 1680 | otherwise kill their mainloop. This is a bother for IPython |
|
1681 | 1681 | which excepts to catch all of the program exceptions with a try: |
|
1682 | 1682 | except: statement. |
|
1683 | 1683 | |
|
1684 | 1684 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if |
|
1685 | 1685 | any app directly invokes sys.excepthook, it will look to the user like |
|
1686 | 1686 | IPython crashed. In order to work around this, we can disable the |
|
1687 | 1687 | CrashHandler and replace it with this excepthook instead, which prints a |
|
1688 | 1688 | regular traceback using our InteractiveTB. In this fashion, apps which |
|
1689 | 1689 | call sys.excepthook will generate a regular-looking exception from |
|
1690 | 1690 | IPython, and the CrashHandler will only be triggered by real IPython |
|
1691 | 1691 | crashes. |
|
1692 | 1692 | |
|
1693 | 1693 | This hook should be used sparingly, only in places which are not likely |
|
1694 | 1694 | to be true IPython errors. |
|
1695 | 1695 | """ |
|
1696 | 1696 | self.showtraceback((etype,value,tb),tb_offset=0) |
|
1697 | 1697 | |
|
1698 | 1698 | def expand_aliases(self,fn,rest): |
|
1699 | 1699 | """ Expand multiple levels of aliases: |
|
1700 | 1700 | |
|
1701 | 1701 | if: |
|
1702 | 1702 | |
|
1703 | 1703 | alias foo bar /tmp |
|
1704 | 1704 | alias baz foo |
|
1705 | 1705 | |
|
1706 | 1706 | then: |
|
1707 | 1707 | |
|
1708 | 1708 | baz huhhahhei -> bar /tmp huhhahhei |
|
1709 | 1709 | |
|
1710 | 1710 | """ |
|
1711 | 1711 | line = fn + " " + rest |
|
1712 | 1712 | |
|
1713 | 1713 | done = Set() |
|
1714 | 1714 | while 1: |
|
1715 | 1715 | pre,fn,rest = prefilter.splitUserInput(line, |
|
1716 | 1716 | prefilter.shell_line_split) |
|
1717 | 1717 | if fn in self.alias_table: |
|
1718 | 1718 | if fn in done: |
|
1719 | 1719 | warn("Cyclic alias definition, repeated '%s'" % fn) |
|
1720 | 1720 | return "" |
|
1721 | 1721 | done.add(fn) |
|
1722 | 1722 | |
|
1723 | 1723 | l2 = self.transform_alias(fn,rest) |
|
1724 | 1724 | # dir -> dir |
|
1725 | 1725 | # print "alias",line, "->",l2 #dbg |
|
1726 | 1726 | if l2 == line: |
|
1727 | 1727 | break |
|
1728 | 1728 | # ls -> ls -F should not recurse forever |
|
1729 | 1729 | if l2.split(None,1)[0] == line.split(None,1)[0]: |
|
1730 | 1730 | line = l2 |
|
1731 | 1731 | break |
|
1732 | 1732 | |
|
1733 | 1733 | line=l2 |
|
1734 | 1734 | |
|
1735 | 1735 | |
|
1736 | 1736 | # print "al expand to",line #dbg |
|
1737 | 1737 | else: |
|
1738 | 1738 | break |
|
1739 | 1739 | |
|
1740 | 1740 | return line |
|
1741 | 1741 | |
|
1742 | 1742 | def transform_alias(self, alias,rest=''): |
|
1743 | 1743 | """ Transform alias to system command string. |
|
1744 | 1744 | """ |
|
1745 |
|
|
|
1745 | trg = self.alias_table[alias] | |
|
1746 | ||
|
1747 | nargs,cmd = trg | |
|
1748 | # print trg #dbg | |
|
1746 | 1749 | if ' ' in cmd and os.path.isfile(cmd): |
|
1747 | 1750 | cmd = '"%s"' % cmd |
|
1748 | 1751 | |
|
1749 | 1752 | # Expand the %l special to be the user's input line |
|
1750 | 1753 | if cmd.find('%l') >= 0: |
|
1751 | 1754 | cmd = cmd.replace('%l',rest) |
|
1752 | 1755 | rest = '' |
|
1753 | 1756 | if nargs==0: |
|
1754 | 1757 | # Simple, argument-less aliases |
|
1755 | 1758 | cmd = '%s %s' % (cmd,rest) |
|
1756 | 1759 | else: |
|
1757 | 1760 | # Handle aliases with positional arguments |
|
1758 | 1761 | args = rest.split(None,nargs) |
|
1759 | 1762 | if len(args)< nargs: |
|
1760 | 1763 | error('Alias <%s> requires %s arguments, %s given.' % |
|
1761 | 1764 | (alias,nargs,len(args))) |
|
1762 | 1765 | return None |
|
1763 | 1766 | cmd = '%s %s' % (cmd % tuple(args[:nargs]),' '.join(args[nargs:])) |
|
1764 | 1767 | # Now call the macro, evaluating in the user's namespace |
|
1765 | 1768 | #print 'new command: <%r>' % cmd # dbg |
|
1766 | 1769 | return cmd |
|
1767 | 1770 | |
|
1768 | 1771 | def call_alias(self,alias,rest=''): |
|
1769 | 1772 | """Call an alias given its name and the rest of the line. |
|
1770 | 1773 | |
|
1771 | 1774 | This is only used to provide backwards compatibility for users of |
|
1772 | 1775 | ipalias(), use of which is not recommended for anymore.""" |
|
1773 | 1776 | |
|
1774 | 1777 | # Now call the macro, evaluating in the user's namespace |
|
1775 | 1778 | cmd = self.transform_alias(alias, rest) |
|
1776 | 1779 | try: |
|
1777 | 1780 | self.system(cmd) |
|
1778 | 1781 | except: |
|
1779 | 1782 | self.showtraceback() |
|
1780 | 1783 | |
|
1781 | 1784 | def indent_current_str(self): |
|
1782 | 1785 | """return the current level of indentation as a string""" |
|
1783 | 1786 | return self.indent_current_nsp * ' ' |
|
1784 | 1787 | |
|
1785 | 1788 | def autoindent_update(self,line): |
|
1786 | 1789 | """Keep track of the indent level.""" |
|
1787 | 1790 | |
|
1788 | 1791 | #debugx('line') |
|
1789 | 1792 | #debugx('self.indent_current_nsp') |
|
1790 | 1793 | if self.autoindent: |
|
1791 | 1794 | if line: |
|
1792 | 1795 | inisp = num_ini_spaces(line) |
|
1793 | 1796 | if inisp < self.indent_current_nsp: |
|
1794 | 1797 | self.indent_current_nsp = inisp |
|
1795 | 1798 | |
|
1796 | 1799 | if line[-1] == ':': |
|
1797 | 1800 | self.indent_current_nsp += 4 |
|
1798 | 1801 | elif dedent_re.match(line): |
|
1799 | 1802 | self.indent_current_nsp -= 4 |
|
1800 | 1803 | else: |
|
1801 | 1804 | self.indent_current_nsp = 0 |
|
1802 | 1805 | def runlines(self,lines): |
|
1803 | 1806 | """Run a string of one or more lines of source. |
|
1804 | 1807 | |
|
1805 | 1808 | This method is capable of running a string containing multiple source |
|
1806 | 1809 | lines, as if they had been entered at the IPython prompt. Since it |
|
1807 | 1810 | exposes IPython's processing machinery, the given strings can contain |
|
1808 | 1811 | magic calls (%magic), special shell access (!cmd), etc.""" |
|
1809 | 1812 | |
|
1810 | 1813 | # We must start with a clean buffer, in case this is run from an |
|
1811 | 1814 | # interactive IPython session (via a magic, for example). |
|
1812 | 1815 | self.resetbuffer() |
|
1813 | 1816 | lines = lines.split('\n') |
|
1814 | 1817 | more = 0 |
|
1815 | 1818 | |
|
1816 | 1819 | for line in lines: |
|
1817 | 1820 | # skip blank lines so we don't mess up the prompt counter, but do |
|
1818 | 1821 | # NOT skip even a blank line if we are in a code block (more is |
|
1819 | 1822 | # true) |
|
1820 | 1823 | |
|
1821 | 1824 | |
|
1822 | 1825 | if line or more: |
|
1823 | 1826 | # push to raw history, so hist line numbers stay in sync |
|
1824 | 1827 | self.input_hist_raw.append("# " + line + "\n") |
|
1825 | 1828 | more = self.push(self.prefilter(line,more)) |
|
1826 | 1829 | # IPython's runsource returns None if there was an error |
|
1827 | 1830 | # compiling the code. This allows us to stop processing right |
|
1828 | 1831 | # away, so the user gets the error message at the right place. |
|
1829 | 1832 | if more is None: |
|
1830 | 1833 | break |
|
1831 | 1834 | else: |
|
1832 | 1835 | self.input_hist_raw.append("\n") |
|
1833 | 1836 | # final newline in case the input didn't have it, so that the code |
|
1834 | 1837 | # actually does get executed |
|
1835 | 1838 | if more: |
|
1836 | 1839 | self.push('\n') |
|
1837 | 1840 | |
|
1838 | 1841 | def runsource(self, source, filename='<input>', symbol='single'): |
|
1839 | 1842 | """Compile and run some source in the interpreter. |
|
1840 | 1843 | |
|
1841 | 1844 | Arguments are as for compile_command(). |
|
1842 | 1845 | |
|
1843 | 1846 | One several things can happen: |
|
1844 | 1847 | |
|
1845 | 1848 | 1) The input is incorrect; compile_command() raised an |
|
1846 | 1849 | exception (SyntaxError or OverflowError). A syntax traceback |
|
1847 | 1850 | will be printed by calling the showsyntaxerror() method. |
|
1848 | 1851 | |
|
1849 | 1852 | 2) The input is incomplete, and more input is required; |
|
1850 | 1853 | compile_command() returned None. Nothing happens. |
|
1851 | 1854 | |
|
1852 | 1855 | 3) The input is complete; compile_command() returned a code |
|
1853 | 1856 | object. The code is executed by calling self.runcode() (which |
|
1854 | 1857 | also handles run-time exceptions, except for SystemExit). |
|
1855 | 1858 | |
|
1856 | 1859 | The return value is: |
|
1857 | 1860 | |
|
1858 | 1861 | - True in case 2 |
|
1859 | 1862 | |
|
1860 | 1863 | - False in the other cases, unless an exception is raised, where |
|
1861 | 1864 | None is returned instead. This can be used by external callers to |
|
1862 | 1865 | know whether to continue feeding input or not. |
|
1863 | 1866 | |
|
1864 | 1867 | The return value can be used to decide whether to use sys.ps1 or |
|
1865 | 1868 | sys.ps2 to prompt the next line.""" |
|
1866 | 1869 | |
|
1867 | 1870 | # if the source code has leading blanks, add 'if 1:\n' to it |
|
1868 | 1871 | # this allows execution of indented pasted code. It is tempting |
|
1869 | 1872 | # to add '\n' at the end of source to run commands like ' a=1' |
|
1870 | 1873 | # directly, but this fails for more complicated scenarios |
|
1871 | 1874 | if source[:1] in [' ', '\t']: |
|
1872 | 1875 | source = 'if 1:\n%s' % source |
|
1873 | 1876 | |
|
1874 | 1877 | try: |
|
1875 | 1878 | code = self.compile(source,filename,symbol) |
|
1876 | 1879 | except (OverflowError, SyntaxError, ValueError): |
|
1877 | 1880 | # Case 1 |
|
1878 | 1881 | self.showsyntaxerror(filename) |
|
1879 | 1882 | return None |
|
1880 | 1883 | |
|
1881 | 1884 | if code is None: |
|
1882 | 1885 | # Case 2 |
|
1883 | 1886 | return True |
|
1884 | 1887 | |
|
1885 | 1888 | # Case 3 |
|
1886 | 1889 | # We store the code object so that threaded shells and |
|
1887 | 1890 | # custom exception handlers can access all this info if needed. |
|
1888 | 1891 | # The source corresponding to this can be obtained from the |
|
1889 | 1892 | # buffer attribute as '\n'.join(self.buffer). |
|
1890 | 1893 | self.code_to_run = code |
|
1891 | 1894 | # now actually execute the code object |
|
1892 | 1895 | if self.runcode(code) == 0: |
|
1893 | 1896 | return False |
|
1894 | 1897 | else: |
|
1895 | 1898 | return None |
|
1896 | 1899 | |
|
1897 | 1900 | def runcode(self,code_obj): |
|
1898 | 1901 | """Execute a code object. |
|
1899 | 1902 | |
|
1900 | 1903 | When an exception occurs, self.showtraceback() is called to display a |
|
1901 | 1904 | traceback. |
|
1902 | 1905 | |
|
1903 | 1906 | Return value: a flag indicating whether the code to be run completed |
|
1904 | 1907 | successfully: |
|
1905 | 1908 | |
|
1906 | 1909 | - 0: successful execution. |
|
1907 | 1910 | - 1: an error occurred. |
|
1908 | 1911 | """ |
|
1909 | 1912 | |
|
1910 | 1913 | # Set our own excepthook in case the user code tries to call it |
|
1911 | 1914 | # directly, so that the IPython crash handler doesn't get triggered |
|
1912 | 1915 | old_excepthook,sys.excepthook = sys.excepthook, self.excepthook |
|
1913 | 1916 | |
|
1914 | 1917 | # we save the original sys.excepthook in the instance, in case config |
|
1915 | 1918 | # code (such as magics) needs access to it. |
|
1916 | 1919 | self.sys_excepthook = old_excepthook |
|
1917 | 1920 | outflag = 1 # happens in more places, so it's easier as default |
|
1918 | 1921 | try: |
|
1919 | 1922 | try: |
|
1920 | 1923 | # Embedded instances require separate global/local namespaces |
|
1921 | 1924 | # so they can see both the surrounding (local) namespace and |
|
1922 | 1925 | # the module-level globals when called inside another function. |
|
1923 | 1926 | if self.embedded: |
|
1924 | 1927 | exec code_obj in self.user_global_ns, self.user_ns |
|
1925 | 1928 | # Normal (non-embedded) instances should only have a single |
|
1926 | 1929 | # namespace for user code execution, otherwise functions won't |
|
1927 | 1930 | # see interactive top-level globals. |
|
1928 | 1931 | else: |
|
1929 | 1932 | exec code_obj in self.user_ns |
|
1930 | 1933 | finally: |
|
1931 | 1934 | # Reset our crash handler in place |
|
1932 | 1935 | sys.excepthook = old_excepthook |
|
1933 | 1936 | except SystemExit: |
|
1934 | 1937 | self.resetbuffer() |
|
1935 | 1938 | self.showtraceback() |
|
1936 | 1939 | warn("Type %exit or %quit to exit IPython " |
|
1937 | 1940 | "(%Exit or %Quit do so unconditionally).",level=1) |
|
1938 | 1941 | except self.custom_exceptions: |
|
1939 | 1942 | etype,value,tb = sys.exc_info() |
|
1940 | 1943 | self.CustomTB(etype,value,tb) |
|
1941 | 1944 | except: |
|
1942 | 1945 | self.showtraceback() |
|
1943 | 1946 | else: |
|
1944 | 1947 | outflag = 0 |
|
1945 | 1948 | if softspace(sys.stdout, 0): |
|
1946 | 1949 | |
|
1947 | 1950 | # Flush out code object which has been run (and source) |
|
1948 | 1951 | self.code_to_run = None |
|
1949 | 1952 | return outflag |
|
1950 | 1953 | |
|
1951 | 1954 | def push(self, line): |
|
1952 | 1955 | """Push a line to the interpreter. |
|
1953 | 1956 | |
|
1954 | 1957 | The line should not have a trailing newline; it may have |
|
1955 | 1958 | internal newlines. The line is appended to a buffer and the |
|
1956 | 1959 | interpreter's runsource() method is called with the |
|
1957 | 1960 | concatenated contents of the buffer as source. If this |
|
1958 | 1961 | indicates that the command was executed or invalid, the buffer |
|
1959 | 1962 | is reset; otherwise, the command is incomplete, and the buffer |
|
1960 | 1963 | is left as it was after the line was appended. The return |
|
1961 | 1964 | value is 1 if more input is required, 0 if the line was dealt |
|
1962 | 1965 | with in some way (this is the same as runsource()). |
|
1963 | 1966 | """ |
|
1964 | 1967 | |
|
1965 | 1968 | # autoindent management should be done here, and not in the |
|
1966 | 1969 | # interactive loop, since that one is only seen by keyboard input. We |
|
1967 | 1970 | # need this done correctly even for code run via runlines (which uses |
|
1968 | 1971 | # push). |
|
1969 | 1972 | |
|
1970 | 1973 | #print 'push line: <%s>' % line # dbg |
|
1971 | 1974 | for subline in line.splitlines(): |
|
1972 | 1975 | self.autoindent_update(subline) |
|
1973 | 1976 | self.buffer.append(line) |
|
1974 | 1977 | more = self.runsource('\n'.join(self.buffer), self.filename) |
|
1975 | 1978 | if not more: |
|
1976 | 1979 | self.resetbuffer() |
|
1977 | 1980 | return more |
|
1978 | 1981 | |
|
1979 | 1982 | def split_user_input(self, line): |
|
1980 | 1983 | # This is really a hold-over to support ipapi and some extensions |
|
1981 | 1984 | return prefilter.splitUserInput(line) |
|
1982 | 1985 | |
|
1983 | 1986 | def resetbuffer(self): |
|
1984 | 1987 | """Reset the input buffer.""" |
|
1985 | 1988 | self.buffer[:] = [] |
|
1986 | 1989 | |
|
1987 | 1990 | def raw_input(self,prompt='',continue_prompt=False): |
|
1988 | 1991 | """Write a prompt and read a line. |
|
1989 | 1992 | |
|
1990 | 1993 | The returned line does not include the trailing newline. |
|
1991 | 1994 | When the user enters the EOF key sequence, EOFError is raised. |
|
1992 | 1995 | |
|
1993 | 1996 | Optional inputs: |
|
1994 | 1997 | |
|
1995 | 1998 | - prompt(''): a string to be printed to prompt the user. |
|
1996 | 1999 | |
|
1997 | 2000 | - continue_prompt(False): whether this line is the first one or a |
|
1998 | 2001 | continuation in a sequence of inputs. |
|
1999 | 2002 | """ |
|
2000 | 2003 | |
|
2001 | 2004 | # Code run by the user may have modified the readline completer state. |
|
2002 | 2005 | # We must ensure that our completer is back in place. |
|
2003 | 2006 | if self.has_readline: |
|
2004 | 2007 | self.set_completer() |
|
2005 | 2008 | |
|
2006 | 2009 | try: |
|
2007 | 2010 | line = raw_input_original(prompt).decode(self.stdin_encoding) |
|
2008 | 2011 | except ValueError: |
|
2009 | 2012 | warn("\n********\nYou or a %run:ed script called sys.stdin.close()" |
|
2010 | 2013 | " or sys.stdout.close()!\nExiting IPython!") |
|
2011 | 2014 | self.exit_now = True |
|
2012 | 2015 | return "" |
|
2013 | 2016 | |
|
2014 | 2017 | # Try to be reasonably smart about not re-indenting pasted input more |
|
2015 | 2018 | # than necessary. We do this by trimming out the auto-indent initial |
|
2016 | 2019 | # spaces, if the user's actual input started itself with whitespace. |
|
2017 | 2020 | #debugx('self.buffer[-1]') |
|
2018 | 2021 | |
|
2019 | 2022 | if self.autoindent: |
|
2020 | 2023 | if num_ini_spaces(line) > self.indent_current_nsp: |
|
2021 | 2024 | line = line[self.indent_current_nsp:] |
|
2022 | 2025 | self.indent_current_nsp = 0 |
|
2023 | 2026 | |
|
2024 | 2027 | # store the unfiltered input before the user has any chance to modify |
|
2025 | 2028 | # it. |
|
2026 | 2029 | if line.strip(): |
|
2027 | 2030 | if continue_prompt: |
|
2028 | 2031 | self.input_hist_raw[-1] += '%s\n' % line |
|
2029 | 2032 | if self.has_readline: # and some config option is set? |
|
2030 | 2033 | try: |
|
2031 | 2034 | histlen = self.readline.get_current_history_length() |
|
2032 | 2035 | newhist = self.input_hist_raw[-1].rstrip() |
|
2033 | 2036 | self.readline.remove_history_item(histlen-1) |
|
2034 | 2037 | self.readline.replace_history_item(histlen-2,newhist) |
|
2035 | 2038 | except AttributeError: |
|
2036 | 2039 | pass # re{move,place}_history_item are new in 2.4. |
|
2037 | 2040 | else: |
|
2038 | 2041 | self.input_hist_raw.append('%s\n' % line) |
|
2039 | 2042 | # only entries starting at first column go to shadow history |
|
2040 | 2043 | if line.lstrip() == line: |
|
2041 | 2044 | self.shadowhist.add(line.strip()) |
|
2042 | 2045 | else: |
|
2043 | 2046 | self.input_hist_raw.append('\n') |
|
2044 | 2047 | try: |
|
2045 | 2048 | lineout = self.prefilter(line,continue_prompt) |
|
2046 | 2049 | except: |
|
2047 | 2050 | # blanket except, in case a user-defined prefilter crashes, so it |
|
2048 | 2051 | # can't take all of ipython with it. |
|
2049 | 2052 | self.showtraceback() |
|
2050 | 2053 | return '' |
|
2051 | 2054 | else: |
|
2052 | 2055 | return lineout |
|
2053 | 2056 | |
|
2054 | 2057 | def _prefilter(self, line, continue_prompt): |
|
2055 | 2058 | """Calls different preprocessors, depending on the form of line.""" |
|
2056 | 2059 | |
|
2057 | 2060 | # All handlers *must* return a value, even if it's blank (''). |
|
2058 | 2061 | |
|
2059 | 2062 | # Lines are NOT logged here. Handlers should process the line as |
|
2060 | 2063 | # needed, update the cache AND log it (so that the input cache array |
|
2061 | 2064 | # stays synced). |
|
2062 | 2065 | |
|
2063 | 2066 | #..................................................................... |
|
2064 | 2067 | # Code begins |
|
2065 | 2068 | |
|
2066 | 2069 | #if line.startswith('%crash'): raise RuntimeError,'Crash now!' # dbg |
|
2067 | 2070 | |
|
2068 | 2071 | # save the line away in case we crash, so the post-mortem handler can |
|
2069 | 2072 | # record it |
|
2070 | 2073 | self._last_input_line = line |
|
2071 | 2074 | |
|
2072 | 2075 | #print '***line: <%s>' % line # dbg |
|
2073 | 2076 | |
|
2074 | 2077 | if not line: |
|
2075 | 2078 | # Return immediately on purely empty lines, so that if the user |
|
2076 | 2079 | # previously typed some whitespace that started a continuation |
|
2077 | 2080 | # prompt, he can break out of that loop with just an empty line. |
|
2078 | 2081 | # This is how the default python prompt works. |
|
2079 | 2082 | |
|
2080 | 2083 | # Only return if the accumulated input buffer was just whitespace! |
|
2081 | 2084 | if ''.join(self.buffer).isspace(): |
|
2082 | 2085 | self.buffer[:] = [] |
|
2083 | 2086 | return '' |
|
2084 | 2087 | |
|
2085 | 2088 | line_info = prefilter.LineInfo(line, continue_prompt) |
|
2086 | 2089 | |
|
2087 | 2090 | # the input history needs to track even empty lines |
|
2088 | 2091 | stripped = line.strip() |
|
2089 | 2092 | |
|
2090 | 2093 | if not stripped: |
|
2091 | 2094 | if not continue_prompt: |
|
2092 | 2095 | self.outputcache.prompt_count -= 1 |
|
2093 | 2096 | return self.handle_normal(line_info) |
|
2094 | 2097 | |
|
2095 | 2098 | # print '***cont',continue_prompt # dbg |
|
2096 | 2099 | # special handlers are only allowed for single line statements |
|
2097 | 2100 | if continue_prompt and not self.rc.multi_line_specials: |
|
2098 | 2101 | return self.handle_normal(line_info) |
|
2099 | 2102 | |
|
2100 | 2103 | |
|
2101 | 2104 | # See whether any pre-existing handler can take care of it |
|
2102 | 2105 | rewritten = self.hooks.input_prefilter(stripped) |
|
2103 | 2106 | if rewritten != stripped: # ok, some prefilter did something |
|
2104 | 2107 | rewritten = line_info.pre + rewritten # add indentation |
|
2105 | 2108 | return self.handle_normal(prefilter.LineInfo(rewritten, |
|
2106 | 2109 | continue_prompt)) |
|
2107 | 2110 | |
|
2108 | 2111 | #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg |
|
2109 | 2112 | |
|
2110 | 2113 | return prefilter.prefilter(line_info, self) |
|
2111 | 2114 | |
|
2112 | 2115 | |
|
2113 | 2116 | def _prefilter_dumb(self, line, continue_prompt): |
|
2114 | 2117 | """simple prefilter function, for debugging""" |
|
2115 | 2118 | return self.handle_normal(line,continue_prompt) |
|
2116 | 2119 | |
|
2117 | 2120 | |
|
2118 | 2121 | def multiline_prefilter(self, line, continue_prompt): |
|
2119 | 2122 | """ Run _prefilter for each line of input |
|
2120 | 2123 | |
|
2121 | 2124 | Covers cases where there are multiple lines in the user entry, |
|
2122 | 2125 | which is the case when the user goes back to a multiline history |
|
2123 | 2126 | entry and presses enter. |
|
2124 | 2127 | |
|
2125 | 2128 | """ |
|
2126 | 2129 | out = [] |
|
2127 | 2130 | for l in line.rstrip('\n').split('\n'): |
|
2128 | 2131 | out.append(self._prefilter(l, continue_prompt)) |
|
2129 | 2132 | return '\n'.join(out) |
|
2130 | 2133 | |
|
2131 | 2134 | # Set the default prefilter() function (this can be user-overridden) |
|
2132 | 2135 | prefilter = multiline_prefilter |
|
2133 | 2136 | |
|
2134 | 2137 | def handle_normal(self,line_info): |
|
2135 | 2138 | """Handle normal input lines. Use as a template for handlers.""" |
|
2136 | 2139 | |
|
2137 | 2140 | # With autoindent on, we need some way to exit the input loop, and I |
|
2138 | 2141 | # don't want to force the user to have to backspace all the way to |
|
2139 | 2142 | # clear the line. The rule will be in this case, that either two |
|
2140 | 2143 | # lines of pure whitespace in a row, or a line of pure whitespace but |
|
2141 | 2144 | # of a size different to the indent level, will exit the input loop. |
|
2142 | 2145 | line = line_info.line |
|
2143 | 2146 | continue_prompt = line_info.continue_prompt |
|
2144 | 2147 | |
|
2145 | 2148 | if (continue_prompt and self.autoindent and line.isspace() and |
|
2146 | 2149 | (0 < abs(len(line) - self.indent_current_nsp) <= 2 or |
|
2147 | 2150 | (self.buffer[-1]).isspace() )): |
|
2148 | 2151 | line = '' |
|
2149 | 2152 | |
|
2150 | 2153 | self.log(line,line,continue_prompt) |
|
2151 | 2154 | return line |
|
2152 | 2155 | |
|
2153 | 2156 | def handle_alias(self,line_info): |
|
2154 | 2157 | """Handle alias input lines. """ |
|
2155 | 2158 | tgt = self.alias_table[line_info.iFun] |
|
2156 | 2159 | # print "=>",tgt #dbg |
|
2157 | 2160 | if callable(tgt): |
|
2158 | 2161 | line_out = "_sh." + line_info.iFun + '(r"""' + line_info.line + '""")' |
|
2159 | 2162 | else: |
|
2160 | 2163 | transformed = self.expand_aliases(line_info.iFun,line_info.theRest) |
|
2161 | 2164 | |
|
2162 | 2165 | # pre is needed, because it carries the leading whitespace. Otherwise |
|
2163 | 2166 | # aliases won't work in indented sections. |
|
2164 | 2167 | line_out = '%s_ip.system(%s)' % (line_info.preWhitespace, |
|
2165 | 2168 | make_quoted_expr( transformed )) |
|
2166 | 2169 | |
|
2167 | 2170 | self.log(line_info.line,line_out,line_info.continue_prompt) |
|
2168 | 2171 | #print 'line out:',line_out # dbg |
|
2169 | 2172 | return line_out |
|
2170 | 2173 | |
|
2171 | 2174 | def handle_shell_escape(self, line_info): |
|
2172 | 2175 | """Execute the line in a shell, empty return value""" |
|
2173 | 2176 | #print 'line in :', `line` # dbg |
|
2174 | 2177 | line = line_info.line |
|
2175 | 2178 | if line.lstrip().startswith('!!'): |
|
2176 | 2179 | # rewrite LineInfo's line, iFun and theRest to properly hold the |
|
2177 | 2180 | # call to %sx and the actual command to be executed, so |
|
2178 | 2181 | # handle_magic can work correctly. Note that this works even if |
|
2179 | 2182 | # the line is indented, so it handles multi_line_specials |
|
2180 | 2183 | # properly. |
|
2181 | 2184 | new_rest = line.lstrip()[2:] |
|
2182 | 2185 | line_info.line = '%ssx %s' % (self.ESC_MAGIC,new_rest) |
|
2183 | 2186 | line_info.iFun = 'sx' |
|
2184 | 2187 | line_info.theRest = new_rest |
|
2185 | 2188 | return self.handle_magic(line_info) |
|
2186 | 2189 | else: |
|
2187 | 2190 | cmd = line.lstrip().lstrip('!') |
|
2188 | 2191 | line_out = '%s_ip.system(%s)' % (line_info.preWhitespace, |
|
2189 | 2192 | make_quoted_expr(cmd)) |
|
2190 | 2193 | # update cache/log and return |
|
2191 | 2194 | self.log(line,line_out,line_info.continue_prompt) |
|
2192 | 2195 | return line_out |
|
2193 | 2196 | |
|
2194 | 2197 | def handle_magic(self, line_info): |
|
2195 | 2198 | """Execute magic functions.""" |
|
2196 | 2199 | iFun = line_info.iFun |
|
2197 | 2200 | theRest = line_info.theRest |
|
2198 | 2201 | cmd = '%s_ip.magic(%s)' % (line_info.preWhitespace, |
|
2199 | 2202 | make_quoted_expr(iFun + " " + theRest)) |
|
2200 | 2203 | self.log(line_info.line,cmd,line_info.continue_prompt) |
|
2201 | 2204 | #print 'in handle_magic, cmd=<%s>' % cmd # dbg |
|
2202 | 2205 | return cmd |
|
2203 | 2206 | |
|
2204 | 2207 | def handle_auto(self, line_info): |
|
2205 | 2208 | """Hande lines which can be auto-executed, quoting if requested.""" |
|
2206 | 2209 | |
|
2207 | 2210 | #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg |
|
2208 | 2211 | line = line_info.line |
|
2209 | 2212 | iFun = line_info.iFun |
|
2210 | 2213 | theRest = line_info.theRest |
|
2211 | 2214 | pre = line_info.pre |
|
2212 | 2215 | continue_prompt = line_info.continue_prompt |
|
2213 | 2216 | obj = line_info.ofind(self)['obj'] |
|
2214 | 2217 | |
|
2215 | 2218 | # This should only be active for single-line input! |
|
2216 | 2219 | if continue_prompt: |
|
2217 | 2220 | self.log(line,line,continue_prompt) |
|
2218 | 2221 | return line |
|
2219 | 2222 | |
|
2220 | 2223 | force_auto = isinstance(obj, IPython.ipapi.IPyAutocall) |
|
2221 | 2224 | auto_rewrite = True |
|
2222 | 2225 | |
|
2223 | 2226 | if pre == self.ESC_QUOTE: |
|
2224 | 2227 | # Auto-quote splitting on whitespace |
|
2225 | 2228 | newcmd = '%s("%s")' % (iFun,'", "'.join(theRest.split()) ) |
|
2226 | 2229 | elif pre == self.ESC_QUOTE2: |
|
2227 | 2230 | # Auto-quote whole string |
|
2228 | 2231 | newcmd = '%s("%s")' % (iFun,theRest) |
|
2229 | 2232 | elif pre == self.ESC_PAREN: |
|
2230 | 2233 | newcmd = '%s(%s)' % (iFun,",".join(theRest.split())) |
|
2231 | 2234 | else: |
|
2232 | 2235 | # Auto-paren. |
|
2233 | 2236 | # We only apply it to argument-less calls if the autocall |
|
2234 | 2237 | # parameter is set to 2. We only need to check that autocall is < |
|
2235 | 2238 | # 2, since this function isn't called unless it's at least 1. |
|
2236 | 2239 | if not theRest and (self.rc.autocall < 2) and not force_auto: |
|
2237 | 2240 | newcmd = '%s %s' % (iFun,theRest) |
|
2238 | 2241 | auto_rewrite = False |
|
2239 | 2242 | else: |
|
2240 | 2243 | if not force_auto and theRest.startswith('['): |
|
2241 | 2244 | if hasattr(obj,'__getitem__'): |
|
2242 | 2245 | # Don't autocall in this case: item access for an object |
|
2243 | 2246 | # which is BOTH callable and implements __getitem__. |
|
2244 | 2247 | newcmd = '%s %s' % (iFun,theRest) |
|
2245 | 2248 | auto_rewrite = False |
|
2246 | 2249 | else: |
|
2247 | 2250 | # if the object doesn't support [] access, go ahead and |
|
2248 | 2251 | # autocall |
|
2249 | 2252 | newcmd = '%s(%s)' % (iFun.rstrip(),theRest) |
|
2250 | 2253 | elif theRest.endswith(';'): |
|
2251 | 2254 | newcmd = '%s(%s);' % (iFun.rstrip(),theRest[:-1]) |
|
2252 | 2255 | else: |
|
2253 | 2256 | newcmd = '%s(%s)' % (iFun.rstrip(), theRest) |
|
2254 | 2257 | |
|
2255 | 2258 | if auto_rewrite: |
|
2256 | 2259 | rw = self.outputcache.prompt1.auto_rewrite() + newcmd |
|
2257 | 2260 | |
|
2258 | 2261 | try: |
|
2259 | 2262 | # plain ascii works better w/ pyreadline, on some machines, so |
|
2260 | 2263 | # we use it and only print uncolored rewrite if we have unicode |
|
2261 | 2264 | rw = str(rw) |
|
2262 | 2265 | print >>Term.cout, rw |
|
2263 | 2266 | except UnicodeEncodeError: |
|
2264 | 2267 | print "-------------->" + newcmd |
|
2265 | 2268 | |
|
2266 | 2269 | # log what is now valid Python, not the actual user input (without the |
|
2267 | 2270 | # final newline) |
|
2268 | 2271 | self.log(line,newcmd,continue_prompt) |
|
2269 | 2272 | return newcmd |
|
2270 | 2273 | |
|
2271 | 2274 | def handle_help(self, line_info): |
|
2272 | 2275 | """Try to get some help for the object. |
|
2273 | 2276 | |
|
2274 | 2277 | obj? or ?obj -> basic information. |
|
2275 | 2278 | obj?? or ??obj -> more details. |
|
2276 | 2279 | """ |
|
2277 | 2280 | |
|
2278 | 2281 | line = line_info.line |
|
2279 | 2282 | # We need to make sure that we don't process lines which would be |
|
2280 | 2283 | # otherwise valid python, such as "x=1 # what?" |
|
2281 | 2284 | try: |
|
2282 | 2285 | codeop.compile_command(line) |
|
2283 | 2286 | except SyntaxError: |
|
2284 | 2287 | # We should only handle as help stuff which is NOT valid syntax |
|
2285 | 2288 | if line[0]==self.ESC_HELP: |
|
2286 | 2289 | line = line[1:] |
|
2287 | 2290 | elif line[-1]==self.ESC_HELP: |
|
2288 | 2291 | line = line[:-1] |
|
2289 | 2292 | self.log(line,'#?'+line,line_info.continue_prompt) |
|
2290 | 2293 | if line: |
|
2291 | 2294 | #print 'line:<%r>' % line # dbg |
|
2292 | 2295 | self.magic_pinfo(line) |
|
2293 | 2296 | else: |
|
2294 | 2297 | page(self.usage,screen_lines=self.rc.screen_length) |
|
2295 | 2298 | return '' # Empty string is needed here! |
|
2296 | 2299 | except: |
|
2297 | 2300 | # Pass any other exceptions through to the normal handler |
|
2298 | 2301 | return self.handle_normal(line_info) |
|
2299 | 2302 | else: |
|
2300 | 2303 | # If the code compiles ok, we should handle it normally |
|
2301 | 2304 | return self.handle_normal(line_info) |
|
2302 | 2305 | |
|
2303 | 2306 | def getapi(self): |
|
2304 | 2307 | """ Get an IPApi object for this shell instance |
|
2305 | 2308 | |
|
2306 | 2309 | Getting an IPApi object is always preferable to accessing the shell |
|
2307 | 2310 | directly, but this holds true especially for extensions. |
|
2308 | 2311 | |
|
2309 | 2312 | It should always be possible to implement an extension with IPApi |
|
2310 | 2313 | alone. If not, contact maintainer to request an addition. |
|
2311 | 2314 | |
|
2312 | 2315 | """ |
|
2313 | 2316 | return self.api |
|
2314 | 2317 | |
|
2315 | 2318 | def handle_emacs(self, line_info): |
|
2316 | 2319 | """Handle input lines marked by python-mode.""" |
|
2317 | 2320 | |
|
2318 | 2321 | # Currently, nothing is done. Later more functionality can be added |
|
2319 | 2322 | # here if needed. |
|
2320 | 2323 | |
|
2321 | 2324 | # The input cache shouldn't be updated |
|
2322 | 2325 | return line_info.line |
|
2323 | 2326 | |
|
2324 | 2327 | |
|
2325 | 2328 | def mktempfile(self,data=None): |
|
2326 | 2329 | """Make a new tempfile and return its filename. |
|
2327 | 2330 | |
|
2328 | 2331 | This makes a call to tempfile.mktemp, but it registers the created |
|
2329 | 2332 | filename internally so ipython cleans it up at exit time. |
|
2330 | 2333 | |
|
2331 | 2334 | Optional inputs: |
|
2332 | 2335 | |
|
2333 | 2336 | - data(None): if data is given, it gets written out to the temp file |
|
2334 | 2337 | immediately, and the file is closed again.""" |
|
2335 | 2338 | |
|
2336 | 2339 | filename = tempfile.mktemp('.py','ipython_edit_') |
|
2337 | 2340 | self.tempfiles.append(filename) |
|
2338 | 2341 | |
|
2339 | 2342 | if data: |
|
2340 | 2343 | tmp_file = open(filename,'w') |
|
2341 | 2344 | tmp_file.write(data) |
|
2342 | 2345 | tmp_file.close() |
|
2343 | 2346 | return filename |
|
2344 | 2347 | |
|
2345 | 2348 | def write(self,data): |
|
2346 | 2349 | """Write a string to the default output""" |
|
2347 | 2350 | Term.cout.write(data) |
|
2348 | 2351 | |
|
2349 | 2352 | def write_err(self,data): |
|
2350 | 2353 | """Write a string to the default error output""" |
|
2351 | 2354 | Term.cerr.write(data) |
|
2352 | 2355 | |
|
2353 | 2356 | def exit(self): |
|
2354 | 2357 | """Handle interactive exit. |
|
2355 | 2358 | |
|
2356 | 2359 | This method sets the exit_now attribute.""" |
|
2357 | 2360 | |
|
2358 | 2361 | if self.rc.confirm_exit: |
|
2359 | 2362 | if self.ask_yes_no('Do you really want to exit ([y]/n)?','y'): |
|
2360 | 2363 | self.exit_now = True |
|
2361 | 2364 | else: |
|
2362 | 2365 | self.exit_now = True |
|
2363 | 2366 | |
|
2364 | 2367 | def safe_execfile(self,fname,*where,**kw): |
|
2365 | 2368 | """A safe version of the builtin execfile(). |
|
2366 | 2369 | |
|
2367 | 2370 | This version will never throw an exception, and knows how to handle |
|
2368 | 2371 | ipython logs as well.""" |
|
2369 | 2372 | |
|
2370 | 2373 | def syspath_cleanup(): |
|
2371 | 2374 | """Internal cleanup routine for sys.path.""" |
|
2372 | 2375 | if add_dname: |
|
2373 | 2376 | try: |
|
2374 | 2377 | sys.path.remove(dname) |
|
2375 | 2378 | except ValueError: |
|
2376 | 2379 | # For some reason the user has already removed it, ignore. |
|
2377 | 2380 | pass |
|
2378 | 2381 | |
|
2379 | 2382 | fname = os.path.expanduser(fname) |
|
2380 | 2383 | |
|
2381 | 2384 | # Find things also in current directory. This is needed to mimic the |
|
2382 | 2385 | # behavior of running a script from the system command line, where |
|
2383 | 2386 | # Python inserts the script's directory into sys.path |
|
2384 | 2387 | dname = os.path.dirname(os.path.abspath(fname)) |
|
2385 | 2388 | add_dname = False |
|
2386 | 2389 | if dname not in sys.path: |
|
2387 | 2390 | sys.path.insert(0,dname) |
|
2388 | 2391 | add_dname = True |
|
2389 | 2392 | |
|
2390 | 2393 | try: |
|
2391 | 2394 | xfile = open(fname) |
|
2392 | 2395 | except: |
|
2393 | 2396 | print >> Term.cerr, \ |
|
2394 | 2397 | 'Could not open file <%s> for safe execution.' % fname |
|
2395 | 2398 | syspath_cleanup() |
|
2396 | 2399 | return None |
|
2397 | 2400 | |
|
2398 | 2401 | kw.setdefault('islog',0) |
|
2399 | 2402 | kw.setdefault('quiet',1) |
|
2400 | 2403 | kw.setdefault('exit_ignore',0) |
|
2401 | 2404 | first = xfile.readline() |
|
2402 | 2405 | loghead = str(self.loghead_tpl).split('\n',1)[0].strip() |
|
2403 | 2406 | xfile.close() |
|
2404 | 2407 | # line by line execution |
|
2405 | 2408 | if first.startswith(loghead) or kw['islog']: |
|
2406 | 2409 | print 'Loading log file <%s> one line at a time...' % fname |
|
2407 | 2410 | if kw['quiet']: |
|
2408 | 2411 | stdout_save = sys.stdout |
|
2409 | 2412 | sys.stdout = StringIO.StringIO() |
|
2410 | 2413 | try: |
|
2411 | 2414 | globs,locs = where[0:2] |
|
2412 | 2415 | except: |
|
2413 | 2416 | try: |
|
2414 | 2417 | globs = locs = where[0] |
|
2415 | 2418 | except: |
|
2416 | 2419 | globs = locs = globals() |
|
2417 | 2420 | badblocks = [] |
|
2418 | 2421 | |
|
2419 | 2422 | # we also need to identify indented blocks of code when replaying |
|
2420 | 2423 | # logs and put them together before passing them to an exec |
|
2421 | 2424 | # statement. This takes a bit of regexp and look-ahead work in the |
|
2422 | 2425 | # file. It's easiest if we swallow the whole thing in memory |
|
2423 | 2426 | # first, and manually walk through the lines list moving the |
|
2424 | 2427 | # counter ourselves. |
|
2425 | 2428 | indent_re = re.compile('\s+\S') |
|
2426 | 2429 | xfile = open(fname) |
|
2427 | 2430 | filelines = xfile.readlines() |
|
2428 | 2431 | xfile.close() |
|
2429 | 2432 | nlines = len(filelines) |
|
2430 | 2433 | lnum = 0 |
|
2431 | 2434 | while lnum < nlines: |
|
2432 | 2435 | line = filelines[lnum] |
|
2433 | 2436 | lnum += 1 |
|
2434 | 2437 | # don't re-insert logger status info into cache |
|
2435 | 2438 | if line.startswith('#log#'): |
|
2436 | 2439 | continue |
|
2437 | 2440 | else: |
|
2438 | 2441 | # build a block of code (maybe a single line) for execution |
|
2439 | 2442 | block = line |
|
2440 | 2443 | try: |
|
2441 | 2444 | next = filelines[lnum] # lnum has already incremented |
|
2442 | 2445 | except: |
|
2443 | 2446 | next = None |
|
2444 | 2447 | while next and indent_re.match(next): |
|
2445 | 2448 | block += next |
|
2446 | 2449 | lnum += 1 |
|
2447 | 2450 | try: |
|
2448 | 2451 | next = filelines[lnum] |
|
2449 | 2452 | except: |
|
2450 | 2453 | next = None |
|
2451 | 2454 | # now execute the block of one or more lines |
|
2452 | 2455 | try: |
|
2453 | 2456 | exec block in globs,locs |
|
2454 | 2457 | except SystemExit: |
|
2455 | 2458 | pass |
|
2456 | 2459 | except: |
|
2457 | 2460 | badblocks.append(block.rstrip()) |
|
2458 | 2461 | if kw['quiet']: # restore stdout |
|
2459 | 2462 | sys.stdout.close() |
|
2460 | 2463 | sys.stdout = stdout_save |
|
2461 | 2464 | print 'Finished replaying log file <%s>' % fname |
|
2462 | 2465 | if badblocks: |
|
2463 | 2466 | print >> sys.stderr, ('\nThe following lines/blocks in file ' |
|
2464 | 2467 | '<%s> reported errors:' % fname) |
|
2465 | 2468 | |
|
2466 | 2469 | for badline in badblocks: |
|
2467 | 2470 | print >> sys.stderr, badline |
|
2468 | 2471 | else: # regular file execution |
|
2469 | 2472 | try: |
|
2470 | 2473 | if sys.platform == 'win32' and sys.version_info < (2,5,1): |
|
2471 | 2474 | # Work around a bug in Python for Windows. The bug was |
|
2472 | 2475 | # fixed in in Python 2.5 r54159 and 54158, but that's still |
|
2473 | 2476 | # SVN Python as of March/07. For details, see: |
|
2474 | 2477 | # http://projects.scipy.org/ipython/ipython/ticket/123 |
|
2475 | 2478 | try: |
|
2476 | 2479 | globs,locs = where[0:2] |
|
2477 | 2480 | except: |
|
2478 | 2481 | try: |
|
2479 | 2482 | globs = locs = where[0] |
|
2480 | 2483 | except: |
|
2481 | 2484 | globs = locs = globals() |
|
2482 | 2485 | exec file(fname) in globs,locs |
|
2483 | 2486 | else: |
|
2484 | 2487 | execfile(fname,*where) |
|
2485 | 2488 | except SyntaxError: |
|
2486 | 2489 | self.showsyntaxerror() |
|
2487 | 2490 | warn('Failure executing file: <%s>' % fname) |
|
2488 | 2491 | except SystemExit,status: |
|
2489 | 2492 | # Code that correctly sets the exit status flag to success (0) |
|
2490 | 2493 | # shouldn't be bothered with a traceback. Note that a plain |
|
2491 | 2494 | # sys.exit() does NOT set the message to 0 (it's empty) so that |
|
2492 | 2495 | # will still get a traceback. Note that the structure of the |
|
2493 | 2496 | # SystemExit exception changed between Python 2.4 and 2.5, so |
|
2494 | 2497 | # the checks must be done in a version-dependent way. |
|
2495 | 2498 | show = False |
|
2496 | 2499 | |
|
2497 | 2500 | if sys.version_info[:2] > (2,5): |
|
2498 | 2501 | if status.message!=0 and not kw['exit_ignore']: |
|
2499 | 2502 | show = True |
|
2500 | 2503 | else: |
|
2501 | 2504 | if status.code and not kw['exit_ignore']: |
|
2502 | 2505 | show = True |
|
2503 | 2506 | if show: |
|
2504 | 2507 | self.showtraceback() |
|
2505 | 2508 | warn('Failure executing file: <%s>' % fname) |
|
2506 | 2509 | except: |
|
2507 | 2510 | self.showtraceback() |
|
2508 | 2511 | warn('Failure executing file: <%s>' % fname) |
|
2509 | 2512 | |
|
2510 | 2513 | syspath_cleanup() |
|
2511 | 2514 | |
|
2512 | 2515 | #************************* end of file <iplib.py> ***************************** |
General Comments 0
You need to be logged in to leave comments.
Login now