Show More
@@ -1,3333 +1,3350 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """Magic functions for InteractiveShell. |
|
2 | """Magic functions for InteractiveShell. | |
3 |
|
3 | |||
4 | $Id: Magic.py 2996 2008-01-30 06:31:39Z fperez $""" |
|
4 | $Id: Magic.py 2996 2008-01-30 06:31:39Z fperez $""" | |
5 |
|
5 | |||
6 | #***************************************************************************** |
|
6 | #***************************************************************************** | |
7 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and |
|
7 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and | |
8 | # Copyright (C) 2001-2006 Fernando Perez <fperez@colorado.edu> |
|
8 | # Copyright (C) 2001-2006 Fernando Perez <fperez@colorado.edu> | |
9 | # |
|
9 | # | |
10 | # Distributed under the terms of the BSD License. The full license is in |
|
10 | # Distributed under the terms of the BSD License. The full license is in | |
11 | # the file COPYING, distributed as part of this software. |
|
11 | # the file COPYING, distributed as part of this software. | |
12 | #***************************************************************************** |
|
12 | #***************************************************************************** | |
13 |
|
13 | |||
14 | #**************************************************************************** |
|
14 | #**************************************************************************** | |
15 | # Modules and globals |
|
15 | # Modules and globals | |
16 |
|
16 | |||
17 | from IPython import Release |
|
17 | from IPython import Release | |
18 | __author__ = '%s <%s>\n%s <%s>' % \ |
|
18 | __author__ = '%s <%s>\n%s <%s>' % \ | |
19 | ( Release.authors['Janko'] + Release.authors['Fernando'] ) |
|
19 | ( Release.authors['Janko'] + Release.authors['Fernando'] ) | |
20 | __license__ = Release.license |
|
20 | __license__ = Release.license | |
21 |
|
21 | |||
22 | # Python standard modules |
|
22 | # Python standard modules | |
23 | import __builtin__ |
|
23 | import __builtin__ | |
24 | import bdb |
|
24 | import bdb | |
25 | import inspect |
|
25 | import inspect | |
26 | import os |
|
26 | import os | |
27 | import pdb |
|
27 | import pdb | |
28 | import pydoc |
|
28 | import pydoc | |
29 | import sys |
|
29 | import sys | |
30 | import re |
|
30 | import re | |
31 | import tempfile |
|
31 | import tempfile | |
32 | import time |
|
32 | import time | |
33 | import cPickle as pickle |
|
33 | import cPickle as pickle | |
34 | import textwrap |
|
34 | import textwrap | |
35 | from cStringIO import StringIO |
|
35 | from cStringIO import StringIO | |
36 | from getopt import getopt,GetoptError |
|
36 | from getopt import getopt,GetoptError | |
37 | from pprint import pprint, pformat |
|
37 | from pprint import pprint, pformat | |
38 | from sets import Set |
|
38 | from sets import Set | |
39 |
|
39 | |||
40 | # cProfile was added in Python2.5 |
|
40 | # cProfile was added in Python2.5 | |
41 | try: |
|
41 | try: | |
42 | import cProfile as profile |
|
42 | import cProfile as profile | |
43 | import pstats |
|
43 | import pstats | |
44 | except ImportError: |
|
44 | except ImportError: | |
45 | # profile isn't bundled by default in Debian for license reasons |
|
45 | # profile isn't bundled by default in Debian for license reasons | |
46 | try: |
|
46 | try: | |
47 | import profile,pstats |
|
47 | import profile,pstats | |
48 | except ImportError: |
|
48 | except ImportError: | |
49 | profile = pstats = None |
|
49 | profile = pstats = None | |
50 |
|
50 | |||
51 | # Homebrewed |
|
51 | # Homebrewed | |
52 | import IPython |
|
52 | import IPython | |
53 | from IPython import Debugger, OInspect, wildcard |
|
53 | from IPython import Debugger, OInspect, wildcard | |
54 | from IPython.FakeModule import FakeModule |
|
54 | from IPython.FakeModule import FakeModule | |
55 | from IPython.Itpl import Itpl, itpl, printpl,itplns |
|
55 | from IPython.Itpl import Itpl, itpl, printpl,itplns | |
56 | from IPython.PyColorize import Parser |
|
56 | from IPython.PyColorize import Parser | |
57 | from IPython.ipstruct import Struct |
|
57 | from IPython.ipstruct import Struct | |
58 | from IPython.macro import Macro |
|
58 | from IPython.macro import Macro | |
59 | from IPython.genutils import * |
|
59 | from IPython.genutils import * | |
60 | from IPython import platutils |
|
60 | from IPython import platutils | |
61 | import IPython.generics |
|
61 | import IPython.generics | |
62 | import IPython.ipapi |
|
62 | import IPython.ipapi | |
63 | from IPython.ipapi import UsageError |
|
63 | from IPython.ipapi import UsageError | |
|
64 | from IPython.testing import decorators as testdec | |||
|
65 | ||||
64 | #*************************************************************************** |
|
66 | #*************************************************************************** | |
65 | # Utility functions |
|
67 | # Utility functions | |
66 | def on_off(tag): |
|
68 | def on_off(tag): | |
67 | """Return an ON/OFF string for a 1/0 input. Simple utility function.""" |
|
69 | """Return an ON/OFF string for a 1/0 input. Simple utility function.""" | |
68 | return ['OFF','ON'][tag] |
|
70 | return ['OFF','ON'][tag] | |
69 |
|
71 | |||
70 | class Bunch: pass |
|
72 | class Bunch: pass | |
71 |
|
73 | |||
72 | def compress_dhist(dh): |
|
74 | def compress_dhist(dh): | |
73 | head, tail = dh[:-10], dh[-10:] |
|
75 | head, tail = dh[:-10], dh[-10:] | |
74 |
|
76 | |||
75 | newhead = [] |
|
77 | newhead = [] | |
76 | done = Set() |
|
78 | done = Set() | |
77 | for h in head: |
|
79 | for h in head: | |
78 | if h in done: |
|
80 | if h in done: | |
79 | continue |
|
81 | continue | |
80 | newhead.append(h) |
|
82 | newhead.append(h) | |
81 | done.add(h) |
|
83 | done.add(h) | |
82 |
|
84 | |||
83 | return newhead + tail |
|
85 | return newhead + tail | |
84 |
|
86 | |||
85 |
|
87 | |||
86 | #*************************************************************************** |
|
88 | #*************************************************************************** | |
87 | # Main class implementing Magic functionality |
|
89 | # Main class implementing Magic functionality | |
88 | class Magic: |
|
90 | class Magic: | |
89 | """Magic functions for InteractiveShell. |
|
91 | """Magic functions for InteractiveShell. | |
90 |
|
92 | |||
91 | Shell functions which can be reached as %function_name. All magic |
|
93 | Shell functions which can be reached as %function_name. All magic | |
92 | functions should accept a string, which they can parse for their own |
|
94 | functions should accept a string, which they can parse for their own | |
93 | needs. This can make some functions easier to type, eg `%cd ../` |
|
95 | needs. This can make some functions easier to type, eg `%cd ../` | |
94 | vs. `%cd("../")` |
|
96 | vs. `%cd("../")` | |
95 |
|
97 | |||
96 | ALL definitions MUST begin with the prefix magic_. The user won't need it |
|
98 | ALL definitions MUST begin with the prefix magic_. The user won't need it | |
97 | at the command line, but it is is needed in the definition. """ |
|
99 | at the command line, but it is is needed in the definition. """ | |
98 |
|
100 | |||
99 | # class globals |
|
101 | # class globals | |
100 | auto_status = ['Automagic is OFF, % prefix IS needed for magic functions.', |
|
102 | auto_status = ['Automagic is OFF, % prefix IS needed for magic functions.', | |
101 | 'Automagic is ON, % prefix NOT needed for magic functions.'] |
|
103 | 'Automagic is ON, % prefix NOT needed for magic functions.'] | |
102 |
|
104 | |||
103 | #...................................................................... |
|
105 | #...................................................................... | |
104 | # some utility functions |
|
106 | # some utility functions | |
105 |
|
107 | |||
106 | def __init__(self,shell): |
|
108 | def __init__(self,shell): | |
107 |
|
109 | |||
108 | self.options_table = {} |
|
110 | self.options_table = {} | |
109 | if profile is None: |
|
111 | if profile is None: | |
110 | self.magic_prun = self.profile_missing_notice |
|
112 | self.magic_prun = self.profile_missing_notice | |
111 | self.shell = shell |
|
113 | self.shell = shell | |
112 |
|
114 | |||
113 | # namespace for holding state we may need |
|
115 | # namespace for holding state we may need | |
114 | self._magic_state = Bunch() |
|
116 | self._magic_state = Bunch() | |
115 |
|
117 | |||
116 | def profile_missing_notice(self, *args, **kwargs): |
|
118 | def profile_missing_notice(self, *args, **kwargs): | |
117 | error("""\ |
|
119 | error("""\ | |
118 | The profile module could not be found. It has been removed from the standard |
|
120 | The profile module could not be found. It has been removed from the standard | |
119 | python packages because of its non-free license. To use profiling, install the |
|
121 | python packages because of its non-free license. To use profiling, install the | |
120 | python-profiler package from non-free.""") |
|
122 | python-profiler package from non-free.""") | |
121 |
|
123 | |||
122 | def default_option(self,fn,optstr): |
|
124 | def default_option(self,fn,optstr): | |
123 | """Make an entry in the options_table for fn, with value optstr""" |
|
125 | """Make an entry in the options_table for fn, with value optstr""" | |
124 |
|
126 | |||
125 | if fn not in self.lsmagic(): |
|
127 | if fn not in self.lsmagic(): | |
126 | error("%s is not a magic function" % fn) |
|
128 | error("%s is not a magic function" % fn) | |
127 | self.options_table[fn] = optstr |
|
129 | self.options_table[fn] = optstr | |
128 |
|
130 | |||
129 | def lsmagic(self): |
|
131 | def lsmagic(self): | |
130 | """Return a list of currently available magic functions. |
|
132 | """Return a list of currently available magic functions. | |
131 |
|
133 | |||
132 | Gives a list of the bare names after mangling (['ls','cd', ...], not |
|
134 | Gives a list of the bare names after mangling (['ls','cd', ...], not | |
133 | ['magic_ls','magic_cd',...]""" |
|
135 | ['magic_ls','magic_cd',...]""" | |
134 |
|
136 | |||
135 | # FIXME. This needs a cleanup, in the way the magics list is built. |
|
137 | # FIXME. This needs a cleanup, in the way the magics list is built. | |
136 |
|
138 | |||
137 | # magics in class definition |
|
139 | # magics in class definition | |
138 | class_magic = lambda fn: fn.startswith('magic_') and \ |
|
140 | class_magic = lambda fn: fn.startswith('magic_') and \ | |
139 | callable(Magic.__dict__[fn]) |
|
141 | callable(Magic.__dict__[fn]) | |
140 | # in instance namespace (run-time user additions) |
|
142 | # in instance namespace (run-time user additions) | |
141 | inst_magic = lambda fn: fn.startswith('magic_') and \ |
|
143 | inst_magic = lambda fn: fn.startswith('magic_') and \ | |
142 | callable(self.__dict__[fn]) |
|
144 | callable(self.__dict__[fn]) | |
143 | # and bound magics by user (so they can access self): |
|
145 | # and bound magics by user (so they can access self): | |
144 | inst_bound_magic = lambda fn: fn.startswith('magic_') and \ |
|
146 | inst_bound_magic = lambda fn: fn.startswith('magic_') and \ | |
145 | callable(self.__class__.__dict__[fn]) |
|
147 | callable(self.__class__.__dict__[fn]) | |
146 | magics = filter(class_magic,Magic.__dict__.keys()) + \ |
|
148 | magics = filter(class_magic,Magic.__dict__.keys()) + \ | |
147 | filter(inst_magic,self.__dict__.keys()) + \ |
|
149 | filter(inst_magic,self.__dict__.keys()) + \ | |
148 | filter(inst_bound_magic,self.__class__.__dict__.keys()) |
|
150 | filter(inst_bound_magic,self.__class__.__dict__.keys()) | |
149 | out = [] |
|
151 | out = [] | |
150 | for fn in Set(magics): |
|
152 | for fn in Set(magics): | |
151 | out.append(fn.replace('magic_','',1)) |
|
153 | out.append(fn.replace('magic_','',1)) | |
152 | out.sort() |
|
154 | out.sort() | |
153 | return out |
|
155 | return out | |
154 |
|
156 | |||
155 | def extract_input_slices(self,slices,raw=False): |
|
157 | def extract_input_slices(self,slices,raw=False): | |
156 | """Return as a string a set of input history slices. |
|
158 | """Return as a string a set of input history slices. | |
157 |
|
159 | |||
158 | Inputs: |
|
160 | Inputs: | |
159 |
|
161 | |||
160 | - slices: the set of slices is given as a list of strings (like |
|
162 | - slices: the set of slices is given as a list of strings (like | |
161 | ['1','4:8','9'], since this function is for use by magic functions |
|
163 | ['1','4:8','9'], since this function is for use by magic functions | |
162 | which get their arguments as strings. |
|
164 | which get their arguments as strings. | |
163 |
|
165 | |||
164 | Optional inputs: |
|
166 | Optional inputs: | |
165 |
|
167 | |||
166 | - raw(False): by default, the processed input is used. If this is |
|
168 | - raw(False): by default, the processed input is used. If this is | |
167 | true, the raw input history is used instead. |
|
169 | true, the raw input history is used instead. | |
168 |
|
170 | |||
169 | Note that slices can be called with two notations: |
|
171 | Note that slices can be called with two notations: | |
170 |
|
172 | |||
171 | N:M -> standard python form, means including items N...(M-1). |
|
173 | N:M -> standard python form, means including items N...(M-1). | |
172 |
|
174 | |||
173 | N-M -> include items N..M (closed endpoint).""" |
|
175 | N-M -> include items N..M (closed endpoint).""" | |
174 |
|
176 | |||
175 | if raw: |
|
177 | if raw: | |
176 | hist = self.shell.input_hist_raw |
|
178 | hist = self.shell.input_hist_raw | |
177 | else: |
|
179 | else: | |
178 | hist = self.shell.input_hist |
|
180 | hist = self.shell.input_hist | |
179 |
|
181 | |||
180 | cmds = [] |
|
182 | cmds = [] | |
181 | for chunk in slices: |
|
183 | for chunk in slices: | |
182 | if ':' in chunk: |
|
184 | if ':' in chunk: | |
183 | ini,fin = map(int,chunk.split(':')) |
|
185 | ini,fin = map(int,chunk.split(':')) | |
184 | elif '-' in chunk: |
|
186 | elif '-' in chunk: | |
185 | ini,fin = map(int,chunk.split('-')) |
|
187 | ini,fin = map(int,chunk.split('-')) | |
186 | fin += 1 |
|
188 | fin += 1 | |
187 | else: |
|
189 | else: | |
188 | ini = int(chunk) |
|
190 | ini = int(chunk) | |
189 | fin = ini+1 |
|
191 | fin = ini+1 | |
190 | cmds.append(hist[ini:fin]) |
|
192 | cmds.append(hist[ini:fin]) | |
191 | return cmds |
|
193 | return cmds | |
192 |
|
194 | |||
193 | def _ofind(self, oname, namespaces=None): |
|
195 | def _ofind(self, oname, namespaces=None): | |
194 | """Find an object in the available namespaces. |
|
196 | """Find an object in the available namespaces. | |
195 |
|
197 | |||
196 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic |
|
198 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic | |
197 |
|
199 | |||
198 | Has special code to detect magic functions. |
|
200 | Has special code to detect magic functions. | |
199 | """ |
|
201 | """ | |
200 |
|
202 | |||
201 | oname = oname.strip() |
|
203 | oname = oname.strip() | |
202 |
|
204 | |||
203 | alias_ns = None |
|
205 | alias_ns = None | |
204 | if namespaces is None: |
|
206 | if namespaces is None: | |
205 | # Namespaces to search in: |
|
207 | # Namespaces to search in: | |
206 | # Put them in a list. The order is important so that we |
|
208 | # Put them in a list. The order is important so that we | |
207 | # find things in the same order that Python finds them. |
|
209 | # find things in the same order that Python finds them. | |
208 | namespaces = [ ('Interactive', self.shell.user_ns), |
|
210 | namespaces = [ ('Interactive', self.shell.user_ns), | |
209 | ('IPython internal', self.shell.internal_ns), |
|
211 | ('IPython internal', self.shell.internal_ns), | |
210 | ('Python builtin', __builtin__.__dict__), |
|
212 | ('Python builtin', __builtin__.__dict__), | |
211 | ('Alias', self.shell.alias_table), |
|
213 | ('Alias', self.shell.alias_table), | |
212 | ] |
|
214 | ] | |
213 | alias_ns = self.shell.alias_table |
|
215 | alias_ns = self.shell.alias_table | |
214 |
|
216 | |||
215 | # initialize results to 'null' |
|
217 | # initialize results to 'null' | |
216 | found = 0; obj = None; ospace = None; ds = None; |
|
218 | found = 0; obj = None; ospace = None; ds = None; | |
217 | ismagic = 0; isalias = 0; parent = None |
|
219 | ismagic = 0; isalias = 0; parent = None | |
218 |
|
220 | |||
219 | # Look for the given name by splitting it in parts. If the head is |
|
221 | # Look for the given name by splitting it in parts. If the head is | |
220 | # found, then we look for all the remaining parts as members, and only |
|
222 | # found, then we look for all the remaining parts as members, and only | |
221 | # declare success if we can find them all. |
|
223 | # declare success if we can find them all. | |
222 | oname_parts = oname.split('.') |
|
224 | oname_parts = oname.split('.') | |
223 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] |
|
225 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] | |
224 | for nsname,ns in namespaces: |
|
226 | for nsname,ns in namespaces: | |
225 | try: |
|
227 | try: | |
226 | obj = ns[oname_head] |
|
228 | obj = ns[oname_head] | |
227 | except KeyError: |
|
229 | except KeyError: | |
228 | continue |
|
230 | continue | |
229 | else: |
|
231 | else: | |
230 | #print 'oname_rest:', oname_rest # dbg |
|
232 | #print 'oname_rest:', oname_rest # dbg | |
231 | for part in oname_rest: |
|
233 | for part in oname_rest: | |
232 | try: |
|
234 | try: | |
233 | parent = obj |
|
235 | parent = obj | |
234 | obj = getattr(obj,part) |
|
236 | obj = getattr(obj,part) | |
235 | except: |
|
237 | except: | |
236 | # Blanket except b/c some badly implemented objects |
|
238 | # Blanket except b/c some badly implemented objects | |
237 | # allow __getattr__ to raise exceptions other than |
|
239 | # allow __getattr__ to raise exceptions other than | |
238 | # AttributeError, which then crashes IPython. |
|
240 | # AttributeError, which then crashes IPython. | |
239 | break |
|
241 | break | |
240 | else: |
|
242 | else: | |
241 | # If we finish the for loop (no break), we got all members |
|
243 | # If we finish the for loop (no break), we got all members | |
242 | found = 1 |
|
244 | found = 1 | |
243 | ospace = nsname |
|
245 | ospace = nsname | |
244 | if ns == alias_ns: |
|
246 | if ns == alias_ns: | |
245 | isalias = 1 |
|
247 | isalias = 1 | |
246 | break # namespace loop |
|
248 | break # namespace loop | |
247 |
|
249 | |||
248 | # Try to see if it's magic |
|
250 | # Try to see if it's magic | |
249 | if not found: |
|
251 | if not found: | |
250 | if oname.startswith(self.shell.ESC_MAGIC): |
|
252 | if oname.startswith(self.shell.ESC_MAGIC): | |
251 | oname = oname[1:] |
|
253 | oname = oname[1:] | |
252 | obj = getattr(self,'magic_'+oname,None) |
|
254 | obj = getattr(self,'magic_'+oname,None) | |
253 | if obj is not None: |
|
255 | if obj is not None: | |
254 | found = 1 |
|
256 | found = 1 | |
255 | ospace = 'IPython internal' |
|
257 | ospace = 'IPython internal' | |
256 | ismagic = 1 |
|
258 | ismagic = 1 | |
257 |
|
259 | |||
258 | # Last try: special-case some literals like '', [], {}, etc: |
|
260 | # Last try: special-case some literals like '', [], {}, etc: | |
259 | if not found and oname_head in ["''",'""','[]','{}','()']: |
|
261 | if not found and oname_head in ["''",'""','[]','{}','()']: | |
260 | obj = eval(oname_head) |
|
262 | obj = eval(oname_head) | |
261 | found = 1 |
|
263 | found = 1 | |
262 | ospace = 'Interactive' |
|
264 | ospace = 'Interactive' | |
263 |
|
265 | |||
264 | return {'found':found, 'obj':obj, 'namespace':ospace, |
|
266 | return {'found':found, 'obj':obj, 'namespace':ospace, | |
265 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} |
|
267 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} | |
266 |
|
268 | |||
267 | def arg_err(self,func): |
|
269 | def arg_err(self,func): | |
268 | """Print docstring if incorrect arguments were passed""" |
|
270 | """Print docstring if incorrect arguments were passed""" | |
269 | print 'Error in arguments:' |
|
271 | print 'Error in arguments:' | |
270 | print OInspect.getdoc(func) |
|
272 | print OInspect.getdoc(func) | |
271 |
|
273 | |||
272 | def format_latex(self,strng): |
|
274 | def format_latex(self,strng): | |
273 | """Format a string for latex inclusion.""" |
|
275 | """Format a string for latex inclusion.""" | |
274 |
|
276 | |||
275 | # Characters that need to be escaped for latex: |
|
277 | # Characters that need to be escaped for latex: | |
276 | escape_re = re.compile(r'(%|_|\$|#|&)',re.MULTILINE) |
|
278 | escape_re = re.compile(r'(%|_|\$|#|&)',re.MULTILINE) | |
277 | # Magic command names as headers: |
|
279 | # Magic command names as headers: | |
278 | cmd_name_re = re.compile(r'^(%s.*?):' % self.shell.ESC_MAGIC, |
|
280 | cmd_name_re = re.compile(r'^(%s.*?):' % self.shell.ESC_MAGIC, | |
279 | re.MULTILINE) |
|
281 | re.MULTILINE) | |
280 | # Magic commands |
|
282 | # Magic commands | |
281 | cmd_re = re.compile(r'(?P<cmd>%s.+?\b)(?!\}\}:)' % self.shell.ESC_MAGIC, |
|
283 | cmd_re = re.compile(r'(?P<cmd>%s.+?\b)(?!\}\}:)' % self.shell.ESC_MAGIC, | |
282 | re.MULTILINE) |
|
284 | re.MULTILINE) | |
283 | # Paragraph continue |
|
285 | # Paragraph continue | |
284 | par_re = re.compile(r'\\$',re.MULTILINE) |
|
286 | par_re = re.compile(r'\\$',re.MULTILINE) | |
285 |
|
287 | |||
286 | # The "\n" symbol |
|
288 | # The "\n" symbol | |
287 | newline_re = re.compile(r'\\n') |
|
289 | newline_re = re.compile(r'\\n') | |
288 |
|
290 | |||
289 | # Now build the string for output: |
|
291 | # Now build the string for output: | |
290 | #strng = cmd_name_re.sub(r'\n\\texttt{\\textsl{\\large \1}}:',strng) |
|
292 | #strng = cmd_name_re.sub(r'\n\\texttt{\\textsl{\\large \1}}:',strng) | |
291 | strng = cmd_name_re.sub(r'\n\\bigskip\n\\texttt{\\textbf{ \1}}:', |
|
293 | strng = cmd_name_re.sub(r'\n\\bigskip\n\\texttt{\\textbf{ \1}}:', | |
292 | strng) |
|
294 | strng) | |
293 | strng = cmd_re.sub(r'\\texttt{\g<cmd>}',strng) |
|
295 | strng = cmd_re.sub(r'\\texttt{\g<cmd>}',strng) | |
294 | strng = par_re.sub(r'\\\\',strng) |
|
296 | strng = par_re.sub(r'\\\\',strng) | |
295 | strng = escape_re.sub(r'\\\1',strng) |
|
297 | strng = escape_re.sub(r'\\\1',strng) | |
296 | strng = newline_re.sub(r'\\textbackslash{}n',strng) |
|
298 | strng = newline_re.sub(r'\\textbackslash{}n',strng) | |
297 | return strng |
|
299 | return strng | |
298 |
|
300 | |||
299 | def format_screen(self,strng): |
|
301 | def format_screen(self,strng): | |
300 | """Format a string for screen printing. |
|
302 | """Format a string for screen printing. | |
301 |
|
303 | |||
302 | This removes some latex-type format codes.""" |
|
304 | This removes some latex-type format codes.""" | |
303 | # Paragraph continue |
|
305 | # Paragraph continue | |
304 | par_re = re.compile(r'\\$',re.MULTILINE) |
|
306 | par_re = re.compile(r'\\$',re.MULTILINE) | |
305 | strng = par_re.sub('',strng) |
|
307 | strng = par_re.sub('',strng) | |
306 | return strng |
|
308 | return strng | |
307 |
|
309 | |||
308 | def parse_options(self,arg_str,opt_str,*long_opts,**kw): |
|
310 | def parse_options(self,arg_str,opt_str,*long_opts,**kw): | |
309 | """Parse options passed to an argument string. |
|
311 | """Parse options passed to an argument string. | |
310 |
|
312 | |||
311 | The interface is similar to that of getopt(), but it returns back a |
|
313 | The interface is similar to that of getopt(), but it returns back a | |
312 | Struct with the options as keys and the stripped argument string still |
|
314 | Struct with the options as keys and the stripped argument string still | |
313 | as a string. |
|
315 | as a string. | |
314 |
|
316 | |||
315 | arg_str is quoted as a true sys.argv vector by using shlex.split. |
|
317 | arg_str is quoted as a true sys.argv vector by using shlex.split. | |
316 | This allows us to easily expand variables, glob files, quote |
|
318 | This allows us to easily expand variables, glob files, quote | |
317 | arguments, etc. |
|
319 | arguments, etc. | |
318 |
|
320 | |||
319 | Options: |
|
321 | Options: | |
320 | -mode: default 'string'. If given as 'list', the argument string is |
|
322 | -mode: default 'string'. If given as 'list', the argument string is | |
321 | returned as a list (split on whitespace) instead of a string. |
|
323 | returned as a list (split on whitespace) instead of a string. | |
322 |
|
324 | |||
323 | -list_all: put all option values in lists. Normally only options |
|
325 | -list_all: put all option values in lists. Normally only options | |
324 | appearing more than once are put in a list. |
|
326 | appearing more than once are put in a list. | |
325 |
|
327 | |||
326 | -posix (True): whether to split the input line in POSIX mode or not, |
|
328 | -posix (True): whether to split the input line in POSIX mode or not, | |
327 | as per the conventions outlined in the shlex module from the |
|
329 | as per the conventions outlined in the shlex module from the | |
328 | standard library.""" |
|
330 | standard library.""" | |
329 |
|
331 | |||
330 | # inject default options at the beginning of the input line |
|
332 | # inject default options at the beginning of the input line | |
331 | caller = sys._getframe(1).f_code.co_name.replace('magic_','') |
|
333 | caller = sys._getframe(1).f_code.co_name.replace('magic_','') | |
332 | arg_str = '%s %s' % (self.options_table.get(caller,''),arg_str) |
|
334 | arg_str = '%s %s' % (self.options_table.get(caller,''),arg_str) | |
333 |
|
335 | |||
334 | mode = kw.get('mode','string') |
|
336 | mode = kw.get('mode','string') | |
335 | if mode not in ['string','list']: |
|
337 | if mode not in ['string','list']: | |
336 | raise ValueError,'incorrect mode given: %s' % mode |
|
338 | raise ValueError,'incorrect mode given: %s' % mode | |
337 | # Get options |
|
339 | # Get options | |
338 | list_all = kw.get('list_all',0) |
|
340 | list_all = kw.get('list_all',0) | |
339 | posix = kw.get('posix',True) |
|
341 | posix = kw.get('posix',True) | |
340 |
|
342 | |||
341 | # Check if we have more than one argument to warrant extra processing: |
|
343 | # Check if we have more than one argument to warrant extra processing: | |
342 | odict = {} # Dictionary with options |
|
344 | odict = {} # Dictionary with options | |
343 | args = arg_str.split() |
|
345 | args = arg_str.split() | |
344 | if len(args) >= 1: |
|
346 | if len(args) >= 1: | |
345 | # If the list of inputs only has 0 or 1 thing in it, there's no |
|
347 | # If the list of inputs only has 0 or 1 thing in it, there's no | |
346 | # need to look for options |
|
348 | # need to look for options | |
347 | argv = arg_split(arg_str,posix) |
|
349 | argv = arg_split(arg_str,posix) | |
348 | # Do regular option processing |
|
350 | # Do regular option processing | |
349 | try: |
|
351 | try: | |
350 | opts,args = getopt(argv,opt_str,*long_opts) |
|
352 | opts,args = getopt(argv,opt_str,*long_opts) | |
351 | except GetoptError,e: |
|
353 | except GetoptError,e: | |
352 | raise UsageError('%s ( allowed: "%s" %s)' % (e.msg,opt_str, |
|
354 | raise UsageError('%s ( allowed: "%s" %s)' % (e.msg,opt_str, | |
353 | " ".join(long_opts))) |
|
355 | " ".join(long_opts))) | |
354 | for o,a in opts: |
|
356 | for o,a in opts: | |
355 | if o.startswith('--'): |
|
357 | if o.startswith('--'): | |
356 | o = o[2:] |
|
358 | o = o[2:] | |
357 | else: |
|
359 | else: | |
358 | o = o[1:] |
|
360 | o = o[1:] | |
359 | try: |
|
361 | try: | |
360 | odict[o].append(a) |
|
362 | odict[o].append(a) | |
361 | except AttributeError: |
|
363 | except AttributeError: | |
362 | odict[o] = [odict[o],a] |
|
364 | odict[o] = [odict[o],a] | |
363 | except KeyError: |
|
365 | except KeyError: | |
364 | if list_all: |
|
366 | if list_all: | |
365 | odict[o] = [a] |
|
367 | odict[o] = [a] | |
366 | else: |
|
368 | else: | |
367 | odict[o] = a |
|
369 | odict[o] = a | |
368 |
|
370 | |||
369 | # Prepare opts,args for return |
|
371 | # Prepare opts,args for return | |
370 | opts = Struct(odict) |
|
372 | opts = Struct(odict) | |
371 | if mode == 'string': |
|
373 | if mode == 'string': | |
372 | args = ' '.join(args) |
|
374 | args = ' '.join(args) | |
373 |
|
375 | |||
374 | return opts,args |
|
376 | return opts,args | |
375 |
|
377 | |||
376 | #...................................................................... |
|
378 | #...................................................................... | |
377 | # And now the actual magic functions |
|
379 | # And now the actual magic functions | |
378 |
|
380 | |||
379 | # Functions for IPython shell work (vars,funcs, config, etc) |
|
381 | # Functions for IPython shell work (vars,funcs, config, etc) | |
380 | def magic_lsmagic(self, parameter_s = ''): |
|
382 | def magic_lsmagic(self, parameter_s = ''): | |
381 | """List currently available magic functions.""" |
|
383 | """List currently available magic functions.""" | |
382 | mesc = self.shell.ESC_MAGIC |
|
384 | mesc = self.shell.ESC_MAGIC | |
383 | print 'Available magic functions:\n'+mesc+\ |
|
385 | print 'Available magic functions:\n'+mesc+\ | |
384 | (' '+mesc).join(self.lsmagic()) |
|
386 | (' '+mesc).join(self.lsmagic()) | |
385 | print '\n' + Magic.auto_status[self.shell.rc.automagic] |
|
387 | print '\n' + Magic.auto_status[self.shell.rc.automagic] | |
386 | return None |
|
388 | return None | |
387 |
|
389 | |||
388 | def magic_magic(self, parameter_s = ''): |
|
390 | def magic_magic(self, parameter_s = ''): | |
389 | """Print information about the magic function system. |
|
391 | """Print information about the magic function system. | |
390 |
|
392 | |||
391 | Supported formats: -latex, -brief, -rest |
|
393 | Supported formats: -latex, -brief, -rest | |
392 | """ |
|
394 | """ | |
393 |
|
395 | |||
394 | mode = '' |
|
396 | mode = '' | |
395 | try: |
|
397 | try: | |
396 | if parameter_s.split()[0] == '-latex': |
|
398 | if parameter_s.split()[0] == '-latex': | |
397 | mode = 'latex' |
|
399 | mode = 'latex' | |
398 | if parameter_s.split()[0] == '-brief': |
|
400 | if parameter_s.split()[0] == '-brief': | |
399 | mode = 'brief' |
|
401 | mode = 'brief' | |
400 | if parameter_s.split()[0] == '-rest': |
|
402 | if parameter_s.split()[0] == '-rest': | |
401 | mode = 'rest' |
|
403 | mode = 'rest' | |
402 | rest_docs = [] |
|
404 | rest_docs = [] | |
403 | except: |
|
405 | except: | |
404 | pass |
|
406 | pass | |
405 |
|
407 | |||
406 | magic_docs = [] |
|
408 | magic_docs = [] | |
407 | for fname in self.lsmagic(): |
|
409 | for fname in self.lsmagic(): | |
408 | mname = 'magic_' + fname |
|
410 | mname = 'magic_' + fname | |
409 | for space in (Magic,self,self.__class__): |
|
411 | for space in (Magic,self,self.__class__): | |
410 | try: |
|
412 | try: | |
411 | fn = space.__dict__[mname] |
|
413 | fn = space.__dict__[mname] | |
412 | except KeyError: |
|
414 | except KeyError: | |
413 | pass |
|
415 | pass | |
414 | else: |
|
416 | else: | |
415 | break |
|
417 | break | |
416 | if mode == 'brief': |
|
418 | if mode == 'brief': | |
417 | # only first line |
|
419 | # only first line | |
418 | if fn.__doc__: |
|
420 | if fn.__doc__: | |
419 | fndoc = fn.__doc__.split('\n',1)[0] |
|
421 | fndoc = fn.__doc__.split('\n',1)[0] | |
420 | else: |
|
422 | else: | |
421 | fndoc = 'No documentation' |
|
423 | fndoc = 'No documentation' | |
422 | else: |
|
424 | else: | |
423 | fndoc = fn.__doc__.rstrip() |
|
425 | fndoc = fn.__doc__.rstrip() | |
424 |
|
426 | |||
425 | if mode == 'rest': |
|
427 | if mode == 'rest': | |
426 | rest_docs.append('**%s%s**::\n\n\t%s\n\n' %(self.shell.ESC_MAGIC, |
|
428 | rest_docs.append('**%s%s**::\n\n\t%s\n\n' %(self.shell.ESC_MAGIC, | |
427 | fname,fndoc)) |
|
429 | fname,fndoc)) | |
428 |
|
430 | |||
429 | else: |
|
431 | else: | |
430 | magic_docs.append('%s%s:\n\t%s\n' %(self.shell.ESC_MAGIC, |
|
432 | magic_docs.append('%s%s:\n\t%s\n' %(self.shell.ESC_MAGIC, | |
431 | fname,fndoc)) |
|
433 | fname,fndoc)) | |
432 |
|
434 | |||
433 | magic_docs = ''.join(magic_docs) |
|
435 | magic_docs = ''.join(magic_docs) | |
434 |
|
436 | |||
435 | if mode == 'rest': |
|
437 | if mode == 'rest': | |
436 | return "".join(rest_docs) |
|
438 | return "".join(rest_docs) | |
437 |
|
439 | |||
438 | if mode == 'latex': |
|
440 | if mode == 'latex': | |
439 | print self.format_latex(magic_docs) |
|
441 | print self.format_latex(magic_docs) | |
440 | return |
|
442 | return | |
441 | else: |
|
443 | else: | |
442 | magic_docs = self.format_screen(magic_docs) |
|
444 | magic_docs = self.format_screen(magic_docs) | |
443 | if mode == 'brief': |
|
445 | if mode == 'brief': | |
444 | return magic_docs |
|
446 | return magic_docs | |
445 |
|
447 | |||
446 | outmsg = """ |
|
448 | outmsg = """ | |
447 | IPython's 'magic' functions |
|
449 | IPython's 'magic' functions | |
448 | =========================== |
|
450 | =========================== | |
449 |
|
451 | |||
450 | The magic function system provides a series of functions which allow you to |
|
452 | The magic function system provides a series of functions which allow you to | |
451 | control the behavior of IPython itself, plus a lot of system-type |
|
453 | control the behavior of IPython itself, plus a lot of system-type | |
452 | features. All these functions are prefixed with a % character, but parameters |
|
454 | features. All these functions are prefixed with a % character, but parameters | |
453 | are given without parentheses or quotes. |
|
455 | are given without parentheses or quotes. | |
454 |
|
456 | |||
455 | NOTE: If you have 'automagic' enabled (via the command line option or with the |
|
457 | NOTE: If you have 'automagic' enabled (via the command line option or with the | |
456 | %automagic function), you don't need to type in the % explicitly. By default, |
|
458 | %automagic function), you don't need to type in the % explicitly. By default, | |
457 | IPython ships with automagic on, so you should only rarely need the % escape. |
|
459 | IPython ships with automagic on, so you should only rarely need the % escape. | |
458 |
|
460 | |||
459 | Example: typing '%cd mydir' (without the quotes) changes you working directory |
|
461 | Example: typing '%cd mydir' (without the quotes) changes you working directory | |
460 | to 'mydir', if it exists. |
|
462 | to 'mydir', if it exists. | |
461 |
|
463 | |||
462 | You can define your own magic functions to extend the system. See the supplied |
|
464 | You can define your own magic functions to extend the system. See the supplied | |
463 | ipythonrc and example-magic.py files for details (in your ipython |
|
465 | ipythonrc and example-magic.py files for details (in your ipython | |
464 | configuration directory, typically $HOME/.ipython/). |
|
466 | configuration directory, typically $HOME/.ipython/). | |
465 |
|
467 | |||
466 | You can also define your own aliased names for magic functions. In your |
|
468 | You can also define your own aliased names for magic functions. In your | |
467 | ipythonrc file, placing a line like: |
|
469 | ipythonrc file, placing a line like: | |
468 |
|
470 | |||
469 | execute __IPYTHON__.magic_pf = __IPYTHON__.magic_profile |
|
471 | execute __IPYTHON__.magic_pf = __IPYTHON__.magic_profile | |
470 |
|
472 | |||
471 | will define %pf as a new name for %profile. |
|
473 | will define %pf as a new name for %profile. | |
472 |
|
474 | |||
473 | You can also call magics in code using the ipmagic() function, which IPython |
|
475 | You can also call magics in code using the ipmagic() function, which IPython | |
474 | automatically adds to the builtin namespace. Type 'ipmagic?' for details. |
|
476 | automatically adds to the builtin namespace. Type 'ipmagic?' for details. | |
475 |
|
477 | |||
476 | For a list of the available magic functions, use %lsmagic. For a description |
|
478 | For a list of the available magic functions, use %lsmagic. For a description | |
477 | of any of them, type %magic_name?, e.g. '%cd?'. |
|
479 | of any of them, type %magic_name?, e.g. '%cd?'. | |
478 |
|
480 | |||
479 | Currently the magic system has the following functions:\n""" |
|
481 | Currently the magic system has the following functions:\n""" | |
480 |
|
482 | |||
481 | mesc = self.shell.ESC_MAGIC |
|
483 | mesc = self.shell.ESC_MAGIC | |
482 | outmsg = ("%s\n%s\n\nSummary of magic functions (from %slsmagic):" |
|
484 | outmsg = ("%s\n%s\n\nSummary of magic functions (from %slsmagic):" | |
483 | "\n\n%s%s\n\n%s" % (outmsg, |
|
485 | "\n\n%s%s\n\n%s" % (outmsg, | |
484 | magic_docs,mesc,mesc, |
|
486 | magic_docs,mesc,mesc, | |
485 | (' '+mesc).join(self.lsmagic()), |
|
487 | (' '+mesc).join(self.lsmagic()), | |
486 | Magic.auto_status[self.shell.rc.automagic] ) ) |
|
488 | Magic.auto_status[self.shell.rc.automagic] ) ) | |
487 |
|
489 | |||
488 | page(outmsg,screen_lines=self.shell.rc.screen_length) |
|
490 | page(outmsg,screen_lines=self.shell.rc.screen_length) | |
489 |
|
491 | |||
490 |
|
492 | |||
491 | def magic_autoindent(self, parameter_s = ''): |
|
493 | def magic_autoindent(self, parameter_s = ''): | |
492 | """Toggle autoindent on/off (if available).""" |
|
494 | """Toggle autoindent on/off (if available).""" | |
493 |
|
495 | |||
494 | self.shell.set_autoindent() |
|
496 | self.shell.set_autoindent() | |
495 | print "Automatic indentation is:",['OFF','ON'][self.shell.autoindent] |
|
497 | print "Automatic indentation is:",['OFF','ON'][self.shell.autoindent] | |
496 |
|
498 | |||
497 |
|
499 | |||
498 | def magic_automagic(self, parameter_s = ''): |
|
500 | def magic_automagic(self, parameter_s = ''): | |
499 | """Make magic functions callable without having to type the initial %. |
|
501 | """Make magic functions callable without having to type the initial %. | |
500 |
|
502 | |||
501 | Without argumentsl toggles on/off (when off, you must call it as |
|
503 | Without argumentsl toggles on/off (when off, you must call it as | |
502 | %automagic, of course). With arguments it sets the value, and you can |
|
504 | %automagic, of course). With arguments it sets the value, and you can | |
503 | use any of (case insensitive): |
|
505 | use any of (case insensitive): | |
504 |
|
506 | |||
505 | - on,1,True: to activate |
|
507 | - on,1,True: to activate | |
506 |
|
508 | |||
507 | - off,0,False: to deactivate. |
|
509 | - off,0,False: to deactivate. | |
508 |
|
510 | |||
509 | Note that magic functions have lowest priority, so if there's a |
|
511 | Note that magic functions have lowest priority, so if there's a | |
510 | variable whose name collides with that of a magic fn, automagic won't |
|
512 | variable whose name collides with that of a magic fn, automagic won't | |
511 | work for that function (you get the variable instead). However, if you |
|
513 | work for that function (you get the variable instead). However, if you | |
512 | delete the variable (del var), the previously shadowed magic function |
|
514 | delete the variable (del var), the previously shadowed magic function | |
513 | becomes visible to automagic again.""" |
|
515 | becomes visible to automagic again.""" | |
514 |
|
516 | |||
515 | rc = self.shell.rc |
|
517 | rc = self.shell.rc | |
516 | arg = parameter_s.lower() |
|
518 | arg = parameter_s.lower() | |
517 | if parameter_s in ('on','1','true'): |
|
519 | if parameter_s in ('on','1','true'): | |
518 | rc.automagic = True |
|
520 | rc.automagic = True | |
519 | elif parameter_s in ('off','0','false'): |
|
521 | elif parameter_s in ('off','0','false'): | |
520 | rc.automagic = False |
|
522 | rc.automagic = False | |
521 | else: |
|
523 | else: | |
522 | rc.automagic = not rc.automagic |
|
524 | rc.automagic = not rc.automagic | |
523 | print '\n' + Magic.auto_status[rc.automagic] |
|
525 | print '\n' + Magic.auto_status[rc.automagic] | |
524 |
|
526 | |||
525 |
|
527 | @testdec.skip_doctest | ||
526 | def magic_autocall(self, parameter_s = ''): |
|
528 | def magic_autocall(self, parameter_s = ''): | |
527 | """Make functions callable without having to type parentheses. |
|
529 | """Make functions callable without having to type parentheses. | |
528 |
|
530 | |||
529 | Usage: |
|
531 | Usage: | |
530 |
|
532 | |||
531 | %autocall [mode] |
|
533 | %autocall [mode] | |
532 |
|
534 | |||
533 | The mode can be one of: 0->Off, 1->Smart, 2->Full. If not given, the |
|
535 | The mode can be one of: 0->Off, 1->Smart, 2->Full. If not given, the | |
534 | value is toggled on and off (remembering the previous state). |
|
536 | value is toggled on and off (remembering the previous state). | |
535 |
|
537 | |||
536 | In more detail, these values mean: |
|
538 | In more detail, these values mean: | |
537 |
|
539 | |||
538 | 0 -> fully disabled |
|
540 | 0 -> fully disabled | |
539 |
|
541 | |||
540 | 1 -> active, but do not apply if there are no arguments on the line. |
|
542 | 1 -> active, but do not apply if there are no arguments on the line. | |
541 |
|
543 | |||
542 | In this mode, you get: |
|
544 | In this mode, you get: | |
543 |
|
545 | |||
544 | In [1]: callable |
|
546 | In [1]: callable | |
545 | Out[1]: <built-in function callable> |
|
547 | Out[1]: <built-in function callable> | |
546 |
|
548 | |||
547 | In [2]: callable 'hello' |
|
549 | In [2]: callable 'hello' | |
548 | ------> callable('hello') |
|
550 | ------> callable('hello') | |
549 | Out[2]: False |
|
551 | Out[2]: False | |
550 |
|
552 | |||
551 | 2 -> Active always. Even if no arguments are present, the callable |
|
553 | 2 -> Active always. Even if no arguments are present, the callable | |
552 | object is called: |
|
554 | object is called: | |
553 |
|
555 | |||
554 |
In [ |
|
556 | In [2]: float | |
555 |
------> |
|
557 | ------> float() | |
|
558 | Out[2]: 0.0 | |||
556 |
|
559 | |||
557 | Note that even with autocall off, you can still use '/' at the start of |
|
560 | Note that even with autocall off, you can still use '/' at the start of | |
558 | a line to treat the first argument on the command line as a function |
|
561 | a line to treat the first argument on the command line as a function | |
559 | and add parentheses to it: |
|
562 | and add parentheses to it: | |
560 |
|
563 | |||
561 | In [8]: /str 43 |
|
564 | In [8]: /str 43 | |
562 | ------> str(43) |
|
565 | ------> str(43) | |
563 | Out[8]: '43' |
|
566 | Out[8]: '43' | |
|
567 | ||||
|
568 | # all-random (note for auto-testing) | |||
564 | """ |
|
569 | """ | |
565 |
|
570 | |||
566 | rc = self.shell.rc |
|
571 | rc = self.shell.rc | |
567 |
|
572 | |||
568 | if parameter_s: |
|
573 | if parameter_s: | |
569 | arg = int(parameter_s) |
|
574 | arg = int(parameter_s) | |
570 | else: |
|
575 | else: | |
571 | arg = 'toggle' |
|
576 | arg = 'toggle' | |
572 |
|
577 | |||
573 | if not arg in (0,1,2,'toggle'): |
|
578 | if not arg in (0,1,2,'toggle'): | |
574 | error('Valid modes: (0->Off, 1->Smart, 2->Full') |
|
579 | error('Valid modes: (0->Off, 1->Smart, 2->Full') | |
575 | return |
|
580 | return | |
576 |
|
581 | |||
577 | if arg in (0,1,2): |
|
582 | if arg in (0,1,2): | |
578 | rc.autocall = arg |
|
583 | rc.autocall = arg | |
579 | else: # toggle |
|
584 | else: # toggle | |
580 | if rc.autocall: |
|
585 | if rc.autocall: | |
581 | self._magic_state.autocall_save = rc.autocall |
|
586 | self._magic_state.autocall_save = rc.autocall | |
582 | rc.autocall = 0 |
|
587 | rc.autocall = 0 | |
583 | else: |
|
588 | else: | |
584 | try: |
|
589 | try: | |
585 | rc.autocall = self._magic_state.autocall_save |
|
590 | rc.autocall = self._magic_state.autocall_save | |
586 | except AttributeError: |
|
591 | except AttributeError: | |
587 | rc.autocall = self._magic_state.autocall_save = 1 |
|
592 | rc.autocall = self._magic_state.autocall_save = 1 | |
588 |
|
593 | |||
589 | print "Automatic calling is:",['OFF','Smart','Full'][rc.autocall] |
|
594 | print "Automatic calling is:",['OFF','Smart','Full'][rc.autocall] | |
590 |
|
595 | |||
591 | def magic_system_verbose(self, parameter_s = ''): |
|
596 | def magic_system_verbose(self, parameter_s = ''): | |
592 | """Set verbose printing of system calls. |
|
597 | """Set verbose printing of system calls. | |
593 |
|
598 | |||
594 | If called without an argument, act as a toggle""" |
|
599 | If called without an argument, act as a toggle""" | |
595 |
|
600 | |||
596 | if parameter_s: |
|
601 | if parameter_s: | |
597 | val = bool(eval(parameter_s)) |
|
602 | val = bool(eval(parameter_s)) | |
598 | else: |
|
603 | else: | |
599 | val = None |
|
604 | val = None | |
600 |
|
605 | |||
601 | self.shell.rc_set_toggle('system_verbose',val) |
|
606 | self.shell.rc_set_toggle('system_verbose',val) | |
602 | print "System verbose printing is:",\ |
|
607 | print "System verbose printing is:",\ | |
603 | ['OFF','ON'][self.shell.rc.system_verbose] |
|
608 | ['OFF','ON'][self.shell.rc.system_verbose] | |
604 |
|
609 | |||
605 |
|
610 | |||
606 | def magic_page(self, parameter_s=''): |
|
611 | def magic_page(self, parameter_s=''): | |
607 | """Pretty print the object and display it through a pager. |
|
612 | """Pretty print the object and display it through a pager. | |
608 |
|
613 | |||
609 | %page [options] OBJECT |
|
614 | %page [options] OBJECT | |
610 |
|
615 | |||
611 | If no object is given, use _ (last output). |
|
616 | If no object is given, use _ (last output). | |
612 |
|
617 | |||
613 | Options: |
|
618 | Options: | |
614 |
|
619 | |||
615 | -r: page str(object), don't pretty-print it.""" |
|
620 | -r: page str(object), don't pretty-print it.""" | |
616 |
|
621 | |||
617 | # After a function contributed by Olivier Aubert, slightly modified. |
|
622 | # After a function contributed by Olivier Aubert, slightly modified. | |
618 |
|
623 | |||
619 | # Process options/args |
|
624 | # Process options/args | |
620 | opts,args = self.parse_options(parameter_s,'r') |
|
625 | opts,args = self.parse_options(parameter_s,'r') | |
621 | raw = 'r' in opts |
|
626 | raw = 'r' in opts | |
622 |
|
627 | |||
623 | oname = args and args or '_' |
|
628 | oname = args and args or '_' | |
624 | info = self._ofind(oname) |
|
629 | info = self._ofind(oname) | |
625 | if info['found']: |
|
630 | if info['found']: | |
626 | txt = (raw and str or pformat)( info['obj'] ) |
|
631 | txt = (raw and str or pformat)( info['obj'] ) | |
627 | page(txt) |
|
632 | page(txt) | |
628 | else: |
|
633 | else: | |
629 | print 'Object `%s` not found' % oname |
|
634 | print 'Object `%s` not found' % oname | |
630 |
|
635 | |||
631 | def magic_profile(self, parameter_s=''): |
|
636 | def magic_profile(self, parameter_s=''): | |
632 | """Print your currently active IPyhton profile.""" |
|
637 | """Print your currently active IPyhton profile.""" | |
633 | if self.shell.rc.profile: |
|
638 | if self.shell.rc.profile: | |
634 | printpl('Current IPython profile: $self.shell.rc.profile.') |
|
639 | printpl('Current IPython profile: $self.shell.rc.profile.') | |
635 | else: |
|
640 | else: | |
636 | print 'No profile active.' |
|
641 | print 'No profile active.' | |
637 |
|
642 | |||
638 | def magic_pinfo(self, parameter_s='', namespaces=None): |
|
643 | def magic_pinfo(self, parameter_s='', namespaces=None): | |
639 | """Provide detailed information about an object. |
|
644 | """Provide detailed information about an object. | |
640 |
|
645 | |||
641 | '%pinfo object' is just a synonym for object? or ?object.""" |
|
646 | '%pinfo object' is just a synonym for object? or ?object.""" | |
642 |
|
647 | |||
643 | #print 'pinfo par: <%s>' % parameter_s # dbg |
|
648 | #print 'pinfo par: <%s>' % parameter_s # dbg | |
644 |
|
649 | |||
645 |
|
650 | |||
646 | # detail_level: 0 -> obj? , 1 -> obj?? |
|
651 | # detail_level: 0 -> obj? , 1 -> obj?? | |
647 | detail_level = 0 |
|
652 | detail_level = 0 | |
648 | # We need to detect if we got called as 'pinfo pinfo foo', which can |
|
653 | # We need to detect if we got called as 'pinfo pinfo foo', which can | |
649 | # happen if the user types 'pinfo foo?' at the cmd line. |
|
654 | # happen if the user types 'pinfo foo?' at the cmd line. | |
650 | pinfo,qmark1,oname,qmark2 = \ |
|
655 | pinfo,qmark1,oname,qmark2 = \ | |
651 | re.match('(pinfo )?(\?*)(.*?)(\??$)',parameter_s).groups() |
|
656 | re.match('(pinfo )?(\?*)(.*?)(\??$)',parameter_s).groups() | |
652 | if pinfo or qmark1 or qmark2: |
|
657 | if pinfo or qmark1 or qmark2: | |
653 | detail_level = 1 |
|
658 | detail_level = 1 | |
654 | if "*" in oname: |
|
659 | if "*" in oname: | |
655 | self.magic_psearch(oname) |
|
660 | self.magic_psearch(oname) | |
656 | else: |
|
661 | else: | |
657 | self._inspect('pinfo', oname, detail_level=detail_level, |
|
662 | self._inspect('pinfo', oname, detail_level=detail_level, | |
658 | namespaces=namespaces) |
|
663 | namespaces=namespaces) | |
659 |
|
664 | |||
660 | def magic_pdef(self, parameter_s='', namespaces=None): |
|
665 | def magic_pdef(self, parameter_s='', namespaces=None): | |
661 | """Print the definition header for any callable object. |
|
666 | """Print the definition header for any callable object. | |
662 |
|
667 | |||
663 | If the object is a class, print the constructor information.""" |
|
668 | If the object is a class, print the constructor information.""" | |
664 | self._inspect('pdef',parameter_s, namespaces) |
|
669 | self._inspect('pdef',parameter_s, namespaces) | |
665 |
|
670 | |||
666 | def magic_pdoc(self, parameter_s='', namespaces=None): |
|
671 | def magic_pdoc(self, parameter_s='', namespaces=None): | |
667 | """Print the docstring for an object. |
|
672 | """Print the docstring for an object. | |
668 |
|
673 | |||
669 | If the given object is a class, it will print both the class and the |
|
674 | If the given object is a class, it will print both the class and the | |
670 | constructor docstrings.""" |
|
675 | constructor docstrings.""" | |
671 | self._inspect('pdoc',parameter_s, namespaces) |
|
676 | self._inspect('pdoc',parameter_s, namespaces) | |
672 |
|
677 | |||
673 | def magic_psource(self, parameter_s='', namespaces=None): |
|
678 | def magic_psource(self, parameter_s='', namespaces=None): | |
674 | """Print (or run through pager) the source code for an object.""" |
|
679 | """Print (or run through pager) the source code for an object.""" | |
675 | self._inspect('psource',parameter_s, namespaces) |
|
680 | self._inspect('psource',parameter_s, namespaces) | |
676 |
|
681 | |||
677 | def magic_pfile(self, parameter_s=''): |
|
682 | def magic_pfile(self, parameter_s=''): | |
678 | """Print (or run through pager) the file where an object is defined. |
|
683 | """Print (or run through pager) the file where an object is defined. | |
679 |
|
684 | |||
680 | The file opens at the line where the object definition begins. IPython |
|
685 | The file opens at the line where the object definition begins. IPython | |
681 | will honor the environment variable PAGER if set, and otherwise will |
|
686 | will honor the environment variable PAGER if set, and otherwise will | |
682 | do its best to print the file in a convenient form. |
|
687 | do its best to print the file in a convenient form. | |
683 |
|
688 | |||
684 | If the given argument is not an object currently defined, IPython will |
|
689 | If the given argument is not an object currently defined, IPython will | |
685 | try to interpret it as a filename (automatically adding a .py extension |
|
690 | try to interpret it as a filename (automatically adding a .py extension | |
686 | if needed). You can thus use %pfile as a syntax highlighting code |
|
691 | if needed). You can thus use %pfile as a syntax highlighting code | |
687 | viewer.""" |
|
692 | viewer.""" | |
688 |
|
693 | |||
689 | # first interpret argument as an object name |
|
694 | # first interpret argument as an object name | |
690 | out = self._inspect('pfile',parameter_s) |
|
695 | out = self._inspect('pfile',parameter_s) | |
691 | # if not, try the input as a filename |
|
696 | # if not, try the input as a filename | |
692 | if out == 'not found': |
|
697 | if out == 'not found': | |
693 | try: |
|
698 | try: | |
694 | filename = get_py_filename(parameter_s) |
|
699 | filename = get_py_filename(parameter_s) | |
695 | except IOError,msg: |
|
700 | except IOError,msg: | |
696 | print msg |
|
701 | print msg | |
697 | return |
|
702 | return | |
698 | page(self.shell.inspector.format(file(filename).read())) |
|
703 | page(self.shell.inspector.format(file(filename).read())) | |
699 |
|
704 | |||
700 | def _inspect(self,meth,oname,namespaces=None,**kw): |
|
705 | def _inspect(self,meth,oname,namespaces=None,**kw): | |
701 | """Generic interface to the inspector system. |
|
706 | """Generic interface to the inspector system. | |
702 |
|
707 | |||
703 | This function is meant to be called by pdef, pdoc & friends.""" |
|
708 | This function is meant to be called by pdef, pdoc & friends.""" | |
704 |
|
709 | |||
705 | #oname = oname.strip() |
|
710 | #oname = oname.strip() | |
706 | #print '1- oname: <%r>' % oname # dbg |
|
711 | #print '1- oname: <%r>' % oname # dbg | |
707 | try: |
|
712 | try: | |
708 | oname = oname.strip().encode('ascii') |
|
713 | oname = oname.strip().encode('ascii') | |
709 | #print '2- oname: <%r>' % oname # dbg |
|
714 | #print '2- oname: <%r>' % oname # dbg | |
710 | except UnicodeEncodeError: |
|
715 | except UnicodeEncodeError: | |
711 | print 'Python identifiers can only contain ascii characters.' |
|
716 | print 'Python identifiers can only contain ascii characters.' | |
712 | return 'not found' |
|
717 | return 'not found' | |
713 |
|
718 | |||
714 | info = Struct(self._ofind(oname, namespaces)) |
|
719 | info = Struct(self._ofind(oname, namespaces)) | |
715 |
|
720 | |||
716 | if info.found: |
|
721 | if info.found: | |
717 | try: |
|
722 | try: | |
718 | IPython.generics.inspect_object(info.obj) |
|
723 | IPython.generics.inspect_object(info.obj) | |
719 | return |
|
724 | return | |
720 | except IPython.ipapi.TryNext: |
|
725 | except IPython.ipapi.TryNext: | |
721 | pass |
|
726 | pass | |
722 | # Get the docstring of the class property if it exists. |
|
727 | # Get the docstring of the class property if it exists. | |
723 | path = oname.split('.') |
|
728 | path = oname.split('.') | |
724 | root = '.'.join(path[:-1]) |
|
729 | root = '.'.join(path[:-1]) | |
725 | if info.parent is not None: |
|
730 | if info.parent is not None: | |
726 | try: |
|
731 | try: | |
727 | target = getattr(info.parent, '__class__') |
|
732 | target = getattr(info.parent, '__class__') | |
728 | # The object belongs to a class instance. |
|
733 | # The object belongs to a class instance. | |
729 | try: |
|
734 | try: | |
730 | target = getattr(target, path[-1]) |
|
735 | target = getattr(target, path[-1]) | |
731 | # The class defines the object. |
|
736 | # The class defines the object. | |
732 | if isinstance(target, property): |
|
737 | if isinstance(target, property): | |
733 | oname = root + '.__class__.' + path[-1] |
|
738 | oname = root + '.__class__.' + path[-1] | |
734 | info = Struct(self._ofind(oname)) |
|
739 | info = Struct(self._ofind(oname)) | |
735 | except AttributeError: pass |
|
740 | except AttributeError: pass | |
736 | except AttributeError: pass |
|
741 | except AttributeError: pass | |
737 |
|
742 | |||
738 | pmethod = getattr(self.shell.inspector,meth) |
|
743 | pmethod = getattr(self.shell.inspector,meth) | |
739 | formatter = info.ismagic and self.format_screen or None |
|
744 | formatter = info.ismagic and self.format_screen or None | |
740 | if meth == 'pdoc': |
|
745 | if meth == 'pdoc': | |
741 | pmethod(info.obj,oname,formatter) |
|
746 | pmethod(info.obj,oname,formatter) | |
742 | elif meth == 'pinfo': |
|
747 | elif meth == 'pinfo': | |
743 | pmethod(info.obj,oname,formatter,info,**kw) |
|
748 | pmethod(info.obj,oname,formatter,info,**kw) | |
744 | else: |
|
749 | else: | |
745 | pmethod(info.obj,oname) |
|
750 | pmethod(info.obj,oname) | |
746 | else: |
|
751 | else: | |
747 | print 'Object `%s` not found.' % oname |
|
752 | print 'Object `%s` not found.' % oname | |
748 | return 'not found' # so callers can take other action |
|
753 | return 'not found' # so callers can take other action | |
749 |
|
754 | |||
750 | def magic_psearch(self, parameter_s=''): |
|
755 | def magic_psearch(self, parameter_s=''): | |
751 | """Search for object in namespaces by wildcard. |
|
756 | """Search for object in namespaces by wildcard. | |
752 |
|
757 | |||
753 | %psearch [options] PATTERN [OBJECT TYPE] |
|
758 | %psearch [options] PATTERN [OBJECT TYPE] | |
754 |
|
759 | |||
755 | Note: ? can be used as a synonym for %psearch, at the beginning or at |
|
760 | Note: ? can be used as a synonym for %psearch, at the beginning or at | |
756 | the end: both a*? and ?a* are equivalent to '%psearch a*'. Still, the |
|
761 | the end: both a*? and ?a* are equivalent to '%psearch a*'. Still, the | |
757 | rest of the command line must be unchanged (options come first), so |
|
762 | rest of the command line must be unchanged (options come first), so | |
758 | for example the following forms are equivalent |
|
763 | for example the following forms are equivalent | |
759 |
|
764 | |||
760 | %psearch -i a* function |
|
765 | %psearch -i a* function | |
761 | -i a* function? |
|
766 | -i a* function? | |
762 | ?-i a* function |
|
767 | ?-i a* function | |
763 |
|
768 | |||
764 | Arguments: |
|
769 | Arguments: | |
765 |
|
770 | |||
766 | PATTERN |
|
771 | PATTERN | |
767 |
|
772 | |||
768 | where PATTERN is a string containing * as a wildcard similar to its |
|
773 | where PATTERN is a string containing * as a wildcard similar to its | |
769 | use in a shell. The pattern is matched in all namespaces on the |
|
774 | use in a shell. The pattern is matched in all namespaces on the | |
770 | search path. By default objects starting with a single _ are not |
|
775 | search path. By default objects starting with a single _ are not | |
771 | matched, many IPython generated objects have a single |
|
776 | matched, many IPython generated objects have a single | |
772 | underscore. The default is case insensitive matching. Matching is |
|
777 | underscore. The default is case insensitive matching. Matching is | |
773 | also done on the attributes of objects and not only on the objects |
|
778 | also done on the attributes of objects and not only on the objects | |
774 | in a module. |
|
779 | in a module. | |
775 |
|
780 | |||
776 | [OBJECT TYPE] |
|
781 | [OBJECT TYPE] | |
777 |
|
782 | |||
778 | Is the name of a python type from the types module. The name is |
|
783 | Is the name of a python type from the types module. The name is | |
779 | given in lowercase without the ending type, ex. StringType is |
|
784 | given in lowercase without the ending type, ex. StringType is | |
780 | written string. By adding a type here only objects matching the |
|
785 | written string. By adding a type here only objects matching the | |
781 | given type are matched. Using all here makes the pattern match all |
|
786 | given type are matched. Using all here makes the pattern match all | |
782 | types (this is the default). |
|
787 | types (this is the default). | |
783 |
|
788 | |||
784 | Options: |
|
789 | Options: | |
785 |
|
790 | |||
786 | -a: makes the pattern match even objects whose names start with a |
|
791 | -a: makes the pattern match even objects whose names start with a | |
787 | single underscore. These names are normally ommitted from the |
|
792 | single underscore. These names are normally ommitted from the | |
788 | search. |
|
793 | search. | |
789 |
|
794 | |||
790 | -i/-c: make the pattern case insensitive/sensitive. If neither of |
|
795 | -i/-c: make the pattern case insensitive/sensitive. If neither of | |
791 | these options is given, the default is read from your ipythonrc |
|
796 | these options is given, the default is read from your ipythonrc | |
792 | file. The option name which sets this value is |
|
797 | file. The option name which sets this value is | |
793 | 'wildcards_case_sensitive'. If this option is not specified in your |
|
798 | 'wildcards_case_sensitive'. If this option is not specified in your | |
794 | ipythonrc file, IPython's internal default is to do a case sensitive |
|
799 | ipythonrc file, IPython's internal default is to do a case sensitive | |
795 | search. |
|
800 | search. | |
796 |
|
801 | |||
797 | -e/-s NAMESPACE: exclude/search a given namespace. The pattern you |
|
802 | -e/-s NAMESPACE: exclude/search a given namespace. The pattern you | |
798 | specifiy can be searched in any of the following namespaces: |
|
803 | specifiy can be searched in any of the following namespaces: | |
799 | 'builtin', 'user', 'user_global','internal', 'alias', where |
|
804 | 'builtin', 'user', 'user_global','internal', 'alias', where | |
800 | 'builtin' and 'user' are the search defaults. Note that you should |
|
805 | 'builtin' and 'user' are the search defaults. Note that you should | |
801 | not use quotes when specifying namespaces. |
|
806 | not use quotes when specifying namespaces. | |
802 |
|
807 | |||
803 | 'Builtin' contains the python module builtin, 'user' contains all |
|
808 | 'Builtin' contains the python module builtin, 'user' contains all | |
804 | user data, 'alias' only contain the shell aliases and no python |
|
809 | user data, 'alias' only contain the shell aliases and no python | |
805 | objects, 'internal' contains objects used by IPython. The |
|
810 | objects, 'internal' contains objects used by IPython. The | |
806 | 'user_global' namespace is only used by embedded IPython instances, |
|
811 | 'user_global' namespace is only used by embedded IPython instances, | |
807 | and it contains module-level globals. You can add namespaces to the |
|
812 | and it contains module-level globals. You can add namespaces to the | |
808 | search with -s or exclude them with -e (these options can be given |
|
813 | search with -s or exclude them with -e (these options can be given | |
809 | more than once). |
|
814 | more than once). | |
810 |
|
815 | |||
811 | Examples: |
|
816 | Examples: | |
812 |
|
817 | |||
813 | %psearch a* -> objects beginning with an a |
|
818 | %psearch a* -> objects beginning with an a | |
814 | %psearch -e builtin a* -> objects NOT in the builtin space starting in a |
|
819 | %psearch -e builtin a* -> objects NOT in the builtin space starting in a | |
815 | %psearch a* function -> all functions beginning with an a |
|
820 | %psearch a* function -> all functions beginning with an a | |
816 | %psearch re.e* -> objects beginning with an e in module re |
|
821 | %psearch re.e* -> objects beginning with an e in module re | |
817 | %psearch r*.e* -> objects that start with e in modules starting in r |
|
822 | %psearch r*.e* -> objects that start with e in modules starting in r | |
818 | %psearch r*.* string -> all strings in modules beginning with r |
|
823 | %psearch r*.* string -> all strings in modules beginning with r | |
819 |
|
824 | |||
820 | Case sensitve search: |
|
825 | Case sensitve search: | |
821 |
|
826 | |||
822 | %psearch -c a* list all object beginning with lower case a |
|
827 | %psearch -c a* list all object beginning with lower case a | |
823 |
|
828 | |||
824 | Show objects beginning with a single _: |
|
829 | Show objects beginning with a single _: | |
825 |
|
830 | |||
826 | %psearch -a _* list objects beginning with a single underscore""" |
|
831 | %psearch -a _* list objects beginning with a single underscore""" | |
827 | try: |
|
832 | try: | |
828 | parameter_s = parameter_s.encode('ascii') |
|
833 | parameter_s = parameter_s.encode('ascii') | |
829 | except UnicodeEncodeError: |
|
834 | except UnicodeEncodeError: | |
830 | print 'Python identifiers can only contain ascii characters.' |
|
835 | print 'Python identifiers can only contain ascii characters.' | |
831 | return |
|
836 | return | |
832 |
|
837 | |||
833 | # default namespaces to be searched |
|
838 | # default namespaces to be searched | |
834 | def_search = ['user','builtin'] |
|
839 | def_search = ['user','builtin'] | |
835 |
|
840 | |||
836 | # Process options/args |
|
841 | # Process options/args | |
837 | opts,args = self.parse_options(parameter_s,'cias:e:',list_all=True) |
|
842 | opts,args = self.parse_options(parameter_s,'cias:e:',list_all=True) | |
838 | opt = opts.get |
|
843 | opt = opts.get | |
839 | shell = self.shell |
|
844 | shell = self.shell | |
840 | psearch = shell.inspector.psearch |
|
845 | psearch = shell.inspector.psearch | |
841 |
|
846 | |||
842 | # select case options |
|
847 | # select case options | |
843 | if opts.has_key('i'): |
|
848 | if opts.has_key('i'): | |
844 | ignore_case = True |
|
849 | ignore_case = True | |
845 | elif opts.has_key('c'): |
|
850 | elif opts.has_key('c'): | |
846 | ignore_case = False |
|
851 | ignore_case = False | |
847 | else: |
|
852 | else: | |
848 | ignore_case = not shell.rc.wildcards_case_sensitive |
|
853 | ignore_case = not shell.rc.wildcards_case_sensitive | |
849 |
|
854 | |||
850 | # Build list of namespaces to search from user options |
|
855 | # Build list of namespaces to search from user options | |
851 | def_search.extend(opt('s',[])) |
|
856 | def_search.extend(opt('s',[])) | |
852 | ns_exclude = ns_exclude=opt('e',[]) |
|
857 | ns_exclude = ns_exclude=opt('e',[]) | |
853 | ns_search = [nm for nm in def_search if nm not in ns_exclude] |
|
858 | ns_search = [nm for nm in def_search if nm not in ns_exclude] | |
854 |
|
859 | |||
855 | # Call the actual search |
|
860 | # Call the actual search | |
856 | try: |
|
861 | try: | |
857 | psearch(args,shell.ns_table,ns_search, |
|
862 | psearch(args,shell.ns_table,ns_search, | |
858 | show_all=opt('a'),ignore_case=ignore_case) |
|
863 | show_all=opt('a'),ignore_case=ignore_case) | |
859 | except: |
|
864 | except: | |
860 | shell.showtraceback() |
|
865 | shell.showtraceback() | |
861 |
|
866 | |||
862 | def magic_who_ls(self, parameter_s=''): |
|
867 | def magic_who_ls(self, parameter_s=''): | |
863 | """Return a sorted list of all interactive variables. |
|
868 | """Return a sorted list of all interactive variables. | |
864 |
|
869 | |||
865 | If arguments are given, only variables of types matching these |
|
870 | If arguments are given, only variables of types matching these | |
866 | arguments are returned.""" |
|
871 | arguments are returned.""" | |
867 |
|
872 | |||
868 | user_ns = self.shell.user_ns |
|
873 | user_ns = self.shell.user_ns | |
869 | internal_ns = self.shell.internal_ns |
|
874 | internal_ns = self.shell.internal_ns | |
870 | user_config_ns = self.shell.user_config_ns |
|
875 | user_config_ns = self.shell.user_config_ns | |
871 | out = [] |
|
876 | out = [] | |
872 | typelist = parameter_s.split() |
|
877 | typelist = parameter_s.split() | |
873 |
|
878 | |||
874 | for i in user_ns: |
|
879 | for i in user_ns: | |
875 | if not (i.startswith('_') or i.startswith('_i')) \ |
|
880 | if not (i.startswith('_') or i.startswith('_i')) \ | |
876 | and not (i in internal_ns or i in user_config_ns): |
|
881 | and not (i in internal_ns or i in user_config_ns): | |
877 | if typelist: |
|
882 | if typelist: | |
878 | if type(user_ns[i]).__name__ in typelist: |
|
883 | if type(user_ns[i]).__name__ in typelist: | |
879 | out.append(i) |
|
884 | out.append(i) | |
880 | else: |
|
885 | else: | |
881 | out.append(i) |
|
886 | out.append(i) | |
882 | out.sort() |
|
887 | out.sort() | |
883 | return out |
|
888 | return out | |
884 |
|
889 | |||
885 | def magic_who(self, parameter_s=''): |
|
890 | def magic_who(self, parameter_s=''): | |
886 | """Print all interactive variables, with some minimal formatting. |
|
891 | """Print all interactive variables, with some minimal formatting. | |
887 |
|
892 | |||
888 | If any arguments are given, only variables whose type matches one of |
|
893 | If any arguments are given, only variables whose type matches one of | |
889 | these are printed. For example: |
|
894 | these are printed. For example: | |
890 |
|
895 | |||
891 | %who function str |
|
896 | %who function str | |
892 |
|
897 | |||
893 | will only list functions and strings, excluding all other types of |
|
898 | will only list functions and strings, excluding all other types of | |
894 | variables. To find the proper type names, simply use type(var) at a |
|
899 | variables. To find the proper type names, simply use type(var) at a | |
895 | command line to see how python prints type names. For example: |
|
900 | command line to see how python prints type names. For example: | |
896 |
|
901 | |||
897 | In [1]: type('hello')\\ |
|
902 | In [1]: type('hello')\\ | |
898 | Out[1]: <type 'str'> |
|
903 | Out[1]: <type 'str'> | |
899 |
|
904 | |||
900 | indicates that the type name for strings is 'str'. |
|
905 | indicates that the type name for strings is 'str'. | |
901 |
|
906 | |||
902 | %who always excludes executed names loaded through your configuration |
|
907 | %who always excludes executed names loaded through your configuration | |
903 | file and things which are internal to IPython. |
|
908 | file and things which are internal to IPython. | |
904 |
|
909 | |||
905 | This is deliberate, as typically you may load many modules and the |
|
910 | This is deliberate, as typically you may load many modules and the | |
906 | purpose of %who is to show you only what you've manually defined.""" |
|
911 | purpose of %who is to show you only what you've manually defined.""" | |
907 |
|
912 | |||
908 | varlist = self.magic_who_ls(parameter_s) |
|
913 | varlist = self.magic_who_ls(parameter_s) | |
909 | if not varlist: |
|
914 | if not varlist: | |
910 | if parameter_s: |
|
915 | if parameter_s: | |
911 | print 'No variables match your requested type.' |
|
916 | print 'No variables match your requested type.' | |
912 | else: |
|
917 | else: | |
913 | print 'Interactive namespace is empty.' |
|
918 | print 'Interactive namespace is empty.' | |
914 | return |
|
919 | return | |
915 |
|
920 | |||
916 | # if we have variables, move on... |
|
921 | # if we have variables, move on... | |
917 | count = 0 |
|
922 | count = 0 | |
918 | for i in varlist: |
|
923 | for i in varlist: | |
919 | print i+'\t', |
|
924 | print i+'\t', | |
920 | count += 1 |
|
925 | count += 1 | |
921 | if count > 8: |
|
926 | if count > 8: | |
922 | count = 0 |
|
927 | count = 0 | |
923 |
|
928 | |||
924 |
|
929 | |||
925 |
|
930 | |||
926 | def magic_whos(self, parameter_s=''): |
|
931 | def magic_whos(self, parameter_s=''): | |
927 | """Like %who, but gives some extra information about each variable. |
|
932 | """Like %who, but gives some extra information about each variable. | |
928 |
|
933 | |||
929 | The same type filtering of %who can be applied here. |
|
934 | The same type filtering of %who can be applied here. | |
930 |
|
935 | |||
931 | For all variables, the type is printed. Additionally it prints: |
|
936 | For all variables, the type is printed. Additionally it prints: | |
932 |
|
937 | |||
933 | - For {},[],(): their length. |
|
938 | - For {},[],(): their length. | |
934 |
|
939 | |||
935 | - For numpy and Numeric arrays, a summary with shape, number of |
|
940 | - For numpy and Numeric arrays, a summary with shape, number of | |
936 | elements, typecode and size in memory. |
|
941 | elements, typecode and size in memory. | |
937 |
|
942 | |||
938 | - Everything else: a string representation, snipping their middle if |
|
943 | - Everything else: a string representation, snipping their middle if | |
939 | too long.""" |
|
944 | too long.""" | |
940 |
|
945 | |||
941 | varnames = self.magic_who_ls(parameter_s) |
|
946 | varnames = self.magic_who_ls(parameter_s) | |
942 | if not varnames: |
|
947 | if not varnames: | |
943 | if parameter_s: |
|
948 | if parameter_s: | |
944 | print 'No variables match your requested type.' |
|
949 | print 'No variables match your requested type.' | |
945 | else: |
|
950 | else: | |
946 | print 'Interactive namespace is empty.' |
|
951 | print 'Interactive namespace is empty.' | |
947 | return |
|
952 | return | |
948 |
|
953 | |||
949 | # if we have variables, move on... |
|
954 | # if we have variables, move on... | |
950 |
|
955 | |||
951 | # for these types, show len() instead of data: |
|
956 | # for these types, show len() instead of data: | |
952 | seq_types = [types.DictType,types.ListType,types.TupleType] |
|
957 | seq_types = [types.DictType,types.ListType,types.TupleType] | |
953 |
|
958 | |||
954 | # for numpy/Numeric arrays, display summary info |
|
959 | # for numpy/Numeric arrays, display summary info | |
955 | try: |
|
960 | try: | |
956 | import numpy |
|
961 | import numpy | |
957 | except ImportError: |
|
962 | except ImportError: | |
958 | ndarray_type = None |
|
963 | ndarray_type = None | |
959 | else: |
|
964 | else: | |
960 | ndarray_type = numpy.ndarray.__name__ |
|
965 | ndarray_type = numpy.ndarray.__name__ | |
961 | try: |
|
966 | try: | |
962 | import Numeric |
|
967 | import Numeric | |
963 | except ImportError: |
|
968 | except ImportError: | |
964 | array_type = None |
|
969 | array_type = None | |
965 | else: |
|
970 | else: | |
966 | array_type = Numeric.ArrayType.__name__ |
|
971 | array_type = Numeric.ArrayType.__name__ | |
967 |
|
972 | |||
968 | # Find all variable names and types so we can figure out column sizes |
|
973 | # Find all variable names and types so we can figure out column sizes | |
969 | def get_vars(i): |
|
974 | def get_vars(i): | |
970 | return self.shell.user_ns[i] |
|
975 | return self.shell.user_ns[i] | |
971 |
|
976 | |||
972 | # some types are well known and can be shorter |
|
977 | # some types are well known and can be shorter | |
973 | abbrevs = {'IPython.macro.Macro' : 'Macro'} |
|
978 | abbrevs = {'IPython.macro.Macro' : 'Macro'} | |
974 | def type_name(v): |
|
979 | def type_name(v): | |
975 | tn = type(v).__name__ |
|
980 | tn = type(v).__name__ | |
976 | return abbrevs.get(tn,tn) |
|
981 | return abbrevs.get(tn,tn) | |
977 |
|
982 | |||
978 | varlist = map(get_vars,varnames) |
|
983 | varlist = map(get_vars,varnames) | |
979 |
|
984 | |||
980 | typelist = [] |
|
985 | typelist = [] | |
981 | for vv in varlist: |
|
986 | for vv in varlist: | |
982 | tt = type_name(vv) |
|
987 | tt = type_name(vv) | |
983 |
|
988 | |||
984 | if tt=='instance': |
|
989 | if tt=='instance': | |
985 | typelist.append( abbrevs.get(str(vv.__class__), |
|
990 | typelist.append( abbrevs.get(str(vv.__class__), | |
986 | str(vv.__class__))) |
|
991 | str(vv.__class__))) | |
987 | else: |
|
992 | else: | |
988 | typelist.append(tt) |
|
993 | typelist.append(tt) | |
989 |
|
994 | |||
990 | # column labels and # of spaces as separator |
|
995 | # column labels and # of spaces as separator | |
991 | varlabel = 'Variable' |
|
996 | varlabel = 'Variable' | |
992 | typelabel = 'Type' |
|
997 | typelabel = 'Type' | |
993 | datalabel = 'Data/Info' |
|
998 | datalabel = 'Data/Info' | |
994 | colsep = 3 |
|
999 | colsep = 3 | |
995 | # variable format strings |
|
1000 | # variable format strings | |
996 | vformat = "$vname.ljust(varwidth)$vtype.ljust(typewidth)" |
|
1001 | vformat = "$vname.ljust(varwidth)$vtype.ljust(typewidth)" | |
997 | vfmt_short = '$vstr[:25]<...>$vstr[-25:]' |
|
1002 | vfmt_short = '$vstr[:25]<...>$vstr[-25:]' | |
998 | aformat = "%s: %s elems, type `%s`, %s bytes" |
|
1003 | aformat = "%s: %s elems, type `%s`, %s bytes" | |
999 | # find the size of the columns to format the output nicely |
|
1004 | # find the size of the columns to format the output nicely | |
1000 | varwidth = max(max(map(len,varnames)), len(varlabel)) + colsep |
|
1005 | varwidth = max(max(map(len,varnames)), len(varlabel)) + colsep | |
1001 | typewidth = max(max(map(len,typelist)), len(typelabel)) + colsep |
|
1006 | typewidth = max(max(map(len,typelist)), len(typelabel)) + colsep | |
1002 | # table header |
|
1007 | # table header | |
1003 | print varlabel.ljust(varwidth) + typelabel.ljust(typewidth) + \ |
|
1008 | print varlabel.ljust(varwidth) + typelabel.ljust(typewidth) + \ | |
1004 | ' '+datalabel+'\n' + '-'*(varwidth+typewidth+len(datalabel)+1) |
|
1009 | ' '+datalabel+'\n' + '-'*(varwidth+typewidth+len(datalabel)+1) | |
1005 | # and the table itself |
|
1010 | # and the table itself | |
1006 | kb = 1024 |
|
1011 | kb = 1024 | |
1007 | Mb = 1048576 # kb**2 |
|
1012 | Mb = 1048576 # kb**2 | |
1008 | for vname,var,vtype in zip(varnames,varlist,typelist): |
|
1013 | for vname,var,vtype in zip(varnames,varlist,typelist): | |
1009 | print itpl(vformat), |
|
1014 | print itpl(vformat), | |
1010 | if vtype in seq_types: |
|
1015 | if vtype in seq_types: | |
1011 | print len(var) |
|
1016 | print len(var) | |
1012 | elif vtype in [array_type,ndarray_type]: |
|
1017 | elif vtype in [array_type,ndarray_type]: | |
1013 | vshape = str(var.shape).replace(',','').replace(' ','x')[1:-1] |
|
1018 | vshape = str(var.shape).replace(',','').replace(' ','x')[1:-1] | |
1014 | if vtype==ndarray_type: |
|
1019 | if vtype==ndarray_type: | |
1015 | # numpy |
|
1020 | # numpy | |
1016 | vsize = var.size |
|
1021 | vsize = var.size | |
1017 | vbytes = vsize*var.itemsize |
|
1022 | vbytes = vsize*var.itemsize | |
1018 | vdtype = var.dtype |
|
1023 | vdtype = var.dtype | |
1019 | else: |
|
1024 | else: | |
1020 | # Numeric |
|
1025 | # Numeric | |
1021 | vsize = Numeric.size(var) |
|
1026 | vsize = Numeric.size(var) | |
1022 | vbytes = vsize*var.itemsize() |
|
1027 | vbytes = vsize*var.itemsize() | |
1023 | vdtype = var.typecode() |
|
1028 | vdtype = var.typecode() | |
1024 |
|
1029 | |||
1025 | if vbytes < 100000: |
|
1030 | if vbytes < 100000: | |
1026 | print aformat % (vshape,vsize,vdtype,vbytes) |
|
1031 | print aformat % (vshape,vsize,vdtype,vbytes) | |
1027 | else: |
|
1032 | else: | |
1028 | print aformat % (vshape,vsize,vdtype,vbytes), |
|
1033 | print aformat % (vshape,vsize,vdtype,vbytes), | |
1029 | if vbytes < Mb: |
|
1034 | if vbytes < Mb: | |
1030 | print '(%s kb)' % (vbytes/kb,) |
|
1035 | print '(%s kb)' % (vbytes/kb,) | |
1031 | else: |
|
1036 | else: | |
1032 | print '(%s Mb)' % (vbytes/Mb,) |
|
1037 | print '(%s Mb)' % (vbytes/Mb,) | |
1033 | else: |
|
1038 | else: | |
1034 | try: |
|
1039 | try: | |
1035 | vstr = str(var) |
|
1040 | vstr = str(var) | |
1036 | except UnicodeEncodeError: |
|
1041 | except UnicodeEncodeError: | |
1037 | vstr = unicode(var).encode(sys.getdefaultencoding(), |
|
1042 | vstr = unicode(var).encode(sys.getdefaultencoding(), | |
1038 | 'backslashreplace') |
|
1043 | 'backslashreplace') | |
1039 | vstr = vstr.replace('\n','\\n') |
|
1044 | vstr = vstr.replace('\n','\\n') | |
1040 | if len(vstr) < 50: |
|
1045 | if len(vstr) < 50: | |
1041 | print vstr |
|
1046 | print vstr | |
1042 | else: |
|
1047 | else: | |
1043 | printpl(vfmt_short) |
|
1048 | printpl(vfmt_short) | |
1044 |
|
1049 | |||
1045 | def magic_reset(self, parameter_s=''): |
|
1050 | def magic_reset(self, parameter_s=''): | |
1046 | """Resets the namespace by removing all names defined by the user. |
|
1051 | """Resets the namespace by removing all names defined by the user. | |
1047 |
|
1052 | |||
1048 | Input/Output history are left around in case you need them.""" |
|
1053 | Input/Output history are left around in case you need them.""" | |
1049 |
|
1054 | |||
1050 | ans = self.shell.ask_yes_no( |
|
1055 | ans = self.shell.ask_yes_no( | |
1051 | "Once deleted, variables cannot be recovered. Proceed (y/[n])? ") |
|
1056 | "Once deleted, variables cannot be recovered. Proceed (y/[n])? ") | |
1052 | if not ans: |
|
1057 | if not ans: | |
1053 | print 'Nothing done.' |
|
1058 | print 'Nothing done.' | |
1054 | return |
|
1059 | return | |
1055 | user_ns = self.shell.user_ns |
|
1060 | user_ns = self.shell.user_ns | |
1056 | for i in self.magic_who_ls(): |
|
1061 | for i in self.magic_who_ls(): | |
1057 | del(user_ns[i]) |
|
1062 | del(user_ns[i]) | |
1058 |
|
1063 | |||
1059 | # Also flush the private list of module references kept for script |
|
1064 | # Also flush the private list of module references kept for script | |
1060 | # execution protection |
|
1065 | # execution protection | |
1061 | self.shell._user_main_modules[:] = [] |
|
1066 | self.shell._user_main_modules[:] = [] | |
1062 |
|
1067 | |||
1063 | def magic_logstart(self,parameter_s=''): |
|
1068 | def magic_logstart(self,parameter_s=''): | |
1064 | """Start logging anywhere in a session. |
|
1069 | """Start logging anywhere in a session. | |
1065 |
|
1070 | |||
1066 | %logstart [-o|-r|-t] [log_name [log_mode]] |
|
1071 | %logstart [-o|-r|-t] [log_name [log_mode]] | |
1067 |
|
1072 | |||
1068 | If no name is given, it defaults to a file named 'ipython_log.py' in your |
|
1073 | If no name is given, it defaults to a file named 'ipython_log.py' in your | |
1069 | current directory, in 'rotate' mode (see below). |
|
1074 | current directory, in 'rotate' mode (see below). | |
1070 |
|
1075 | |||
1071 | '%logstart name' saves to file 'name' in 'backup' mode. It saves your |
|
1076 | '%logstart name' saves to file 'name' in 'backup' mode. It saves your | |
1072 | history up to that point and then continues logging. |
|
1077 | history up to that point and then continues logging. | |
1073 |
|
1078 | |||
1074 | %logstart takes a second optional parameter: logging mode. This can be one |
|
1079 | %logstart takes a second optional parameter: logging mode. This can be one | |
1075 | of (note that the modes are given unquoted):\\ |
|
1080 | of (note that the modes are given unquoted):\\ | |
1076 | append: well, that says it.\\ |
|
1081 | append: well, that says it.\\ | |
1077 | backup: rename (if exists) to name~ and start name.\\ |
|
1082 | backup: rename (if exists) to name~ and start name.\\ | |
1078 | global: single logfile in your home dir, appended to.\\ |
|
1083 | global: single logfile in your home dir, appended to.\\ | |
1079 | over : overwrite existing log.\\ |
|
1084 | over : overwrite existing log.\\ | |
1080 | rotate: create rotating logs name.1~, name.2~, etc. |
|
1085 | rotate: create rotating logs name.1~, name.2~, etc. | |
1081 |
|
1086 | |||
1082 | Options: |
|
1087 | Options: | |
1083 |
|
1088 | |||
1084 | -o: log also IPython's output. In this mode, all commands which |
|
1089 | -o: log also IPython's output. In this mode, all commands which | |
1085 | generate an Out[NN] prompt are recorded to the logfile, right after |
|
1090 | generate an Out[NN] prompt are recorded to the logfile, right after | |
1086 | their corresponding input line. The output lines are always |
|
1091 | their corresponding input line. The output lines are always | |
1087 | prepended with a '#[Out]# ' marker, so that the log remains valid |
|
1092 | prepended with a '#[Out]# ' marker, so that the log remains valid | |
1088 | Python code. |
|
1093 | Python code. | |
1089 |
|
1094 | |||
1090 | Since this marker is always the same, filtering only the output from |
|
1095 | Since this marker is always the same, filtering only the output from | |
1091 | a log is very easy, using for example a simple awk call: |
|
1096 | a log is very easy, using for example a simple awk call: | |
1092 |
|
1097 | |||
1093 | awk -F'#\\[Out\\]# ' '{if($2) {print $2}}' ipython_log.py |
|
1098 | awk -F'#\\[Out\\]# ' '{if($2) {print $2}}' ipython_log.py | |
1094 |
|
1099 | |||
1095 | -r: log 'raw' input. Normally, IPython's logs contain the processed |
|
1100 | -r: log 'raw' input. Normally, IPython's logs contain the processed | |
1096 | input, so that user lines are logged in their final form, converted |
|
1101 | input, so that user lines are logged in their final form, converted | |
1097 | into valid Python. For example, %Exit is logged as |
|
1102 | into valid Python. For example, %Exit is logged as | |
1098 | '_ip.magic("Exit"). If the -r flag is given, all input is logged |
|
1103 | '_ip.magic("Exit"). If the -r flag is given, all input is logged | |
1099 | exactly as typed, with no transformations applied. |
|
1104 | exactly as typed, with no transformations applied. | |
1100 |
|
1105 | |||
1101 | -t: put timestamps before each input line logged (these are put in |
|
1106 | -t: put timestamps before each input line logged (these are put in | |
1102 | comments).""" |
|
1107 | comments).""" | |
1103 |
|
1108 | |||
1104 | opts,par = self.parse_options(parameter_s,'ort') |
|
1109 | opts,par = self.parse_options(parameter_s,'ort') | |
1105 | log_output = 'o' in opts |
|
1110 | log_output = 'o' in opts | |
1106 | log_raw_input = 'r' in opts |
|
1111 | log_raw_input = 'r' in opts | |
1107 | timestamp = 't' in opts |
|
1112 | timestamp = 't' in opts | |
1108 |
|
1113 | |||
1109 | rc = self.shell.rc |
|
1114 | rc = self.shell.rc | |
1110 | logger = self.shell.logger |
|
1115 | logger = self.shell.logger | |
1111 |
|
1116 | |||
1112 | # if no args are given, the defaults set in the logger constructor by |
|
1117 | # if no args are given, the defaults set in the logger constructor by | |
1113 | # ipytohn remain valid |
|
1118 | # ipytohn remain valid | |
1114 | if par: |
|
1119 | if par: | |
1115 | try: |
|
1120 | try: | |
1116 | logfname,logmode = par.split() |
|
1121 | logfname,logmode = par.split() | |
1117 | except: |
|
1122 | except: | |
1118 | logfname = par |
|
1123 | logfname = par | |
1119 | logmode = 'backup' |
|
1124 | logmode = 'backup' | |
1120 | else: |
|
1125 | else: | |
1121 | logfname = logger.logfname |
|
1126 | logfname = logger.logfname | |
1122 | logmode = logger.logmode |
|
1127 | logmode = logger.logmode | |
1123 | # put logfname into rc struct as if it had been called on the command |
|
1128 | # put logfname into rc struct as if it had been called on the command | |
1124 | # line, so it ends up saved in the log header Save it in case we need |
|
1129 | # line, so it ends up saved in the log header Save it in case we need | |
1125 | # to restore it... |
|
1130 | # to restore it... | |
1126 | old_logfile = rc.opts.get('logfile','') |
|
1131 | old_logfile = rc.opts.get('logfile','') | |
1127 | if logfname: |
|
1132 | if logfname: | |
1128 | logfname = os.path.expanduser(logfname) |
|
1133 | logfname = os.path.expanduser(logfname) | |
1129 | rc.opts.logfile = logfname |
|
1134 | rc.opts.logfile = logfname | |
1130 | loghead = self.shell.loghead_tpl % (rc.opts,rc.args) |
|
1135 | loghead = self.shell.loghead_tpl % (rc.opts,rc.args) | |
1131 | try: |
|
1136 | try: | |
1132 | started = logger.logstart(logfname,loghead,logmode, |
|
1137 | started = logger.logstart(logfname,loghead,logmode, | |
1133 | log_output,timestamp,log_raw_input) |
|
1138 | log_output,timestamp,log_raw_input) | |
1134 | except: |
|
1139 | except: | |
1135 | rc.opts.logfile = old_logfile |
|
1140 | rc.opts.logfile = old_logfile | |
1136 | warn("Couldn't start log: %s" % sys.exc_info()[1]) |
|
1141 | warn("Couldn't start log: %s" % sys.exc_info()[1]) | |
1137 | else: |
|
1142 | else: | |
1138 | # log input history up to this point, optionally interleaving |
|
1143 | # log input history up to this point, optionally interleaving | |
1139 | # output if requested |
|
1144 | # output if requested | |
1140 |
|
1145 | |||
1141 | if timestamp: |
|
1146 | if timestamp: | |
1142 | # disable timestamping for the previous history, since we've |
|
1147 | # disable timestamping for the previous history, since we've | |
1143 | # lost those already (no time machine here). |
|
1148 | # lost those already (no time machine here). | |
1144 | logger.timestamp = False |
|
1149 | logger.timestamp = False | |
1145 |
|
1150 | |||
1146 | if log_raw_input: |
|
1151 | if log_raw_input: | |
1147 | input_hist = self.shell.input_hist_raw |
|
1152 | input_hist = self.shell.input_hist_raw | |
1148 | else: |
|
1153 | else: | |
1149 | input_hist = self.shell.input_hist |
|
1154 | input_hist = self.shell.input_hist | |
1150 |
|
1155 | |||
1151 | if log_output: |
|
1156 | if log_output: | |
1152 | log_write = logger.log_write |
|
1157 | log_write = logger.log_write | |
1153 | output_hist = self.shell.output_hist |
|
1158 | output_hist = self.shell.output_hist | |
1154 | for n in range(1,len(input_hist)-1): |
|
1159 | for n in range(1,len(input_hist)-1): | |
1155 | log_write(input_hist[n].rstrip()) |
|
1160 | log_write(input_hist[n].rstrip()) | |
1156 | if n in output_hist: |
|
1161 | if n in output_hist: | |
1157 | log_write(repr(output_hist[n]),'output') |
|
1162 | log_write(repr(output_hist[n]),'output') | |
1158 | else: |
|
1163 | else: | |
1159 | logger.log_write(input_hist[1:]) |
|
1164 | logger.log_write(input_hist[1:]) | |
1160 | if timestamp: |
|
1165 | if timestamp: | |
1161 | # re-enable timestamping |
|
1166 | # re-enable timestamping | |
1162 | logger.timestamp = True |
|
1167 | logger.timestamp = True | |
1163 |
|
1168 | |||
1164 | print ('Activating auto-logging. ' |
|
1169 | print ('Activating auto-logging. ' | |
1165 | 'Current session state plus future input saved.') |
|
1170 | 'Current session state plus future input saved.') | |
1166 | logger.logstate() |
|
1171 | logger.logstate() | |
1167 |
|
1172 | |||
1168 | def magic_logstop(self,parameter_s=''): |
|
1173 | def magic_logstop(self,parameter_s=''): | |
1169 | """Fully stop logging and close log file. |
|
1174 | """Fully stop logging and close log file. | |
1170 |
|
1175 | |||
1171 | In order to start logging again, a new %logstart call needs to be made, |
|
1176 | In order to start logging again, a new %logstart call needs to be made, | |
1172 | possibly (though not necessarily) with a new filename, mode and other |
|
1177 | possibly (though not necessarily) with a new filename, mode and other | |
1173 | options.""" |
|
1178 | options.""" | |
1174 | self.logger.logstop() |
|
1179 | self.logger.logstop() | |
1175 |
|
1180 | |||
1176 | def magic_logoff(self,parameter_s=''): |
|
1181 | def magic_logoff(self,parameter_s=''): | |
1177 | """Temporarily stop logging. |
|
1182 | """Temporarily stop logging. | |
1178 |
|
1183 | |||
1179 | You must have previously started logging.""" |
|
1184 | You must have previously started logging.""" | |
1180 | self.shell.logger.switch_log(0) |
|
1185 | self.shell.logger.switch_log(0) | |
1181 |
|
1186 | |||
1182 | def magic_logon(self,parameter_s=''): |
|
1187 | def magic_logon(self,parameter_s=''): | |
1183 | """Restart logging. |
|
1188 | """Restart logging. | |
1184 |
|
1189 | |||
1185 | This function is for restarting logging which you've temporarily |
|
1190 | This function is for restarting logging which you've temporarily | |
1186 | stopped with %logoff. For starting logging for the first time, you |
|
1191 | stopped with %logoff. For starting logging for the first time, you | |
1187 | must use the %logstart function, which allows you to specify an |
|
1192 | must use the %logstart function, which allows you to specify an | |
1188 | optional log filename.""" |
|
1193 | optional log filename.""" | |
1189 |
|
1194 | |||
1190 | self.shell.logger.switch_log(1) |
|
1195 | self.shell.logger.switch_log(1) | |
1191 |
|
1196 | |||
1192 | def magic_logstate(self,parameter_s=''): |
|
1197 | def magic_logstate(self,parameter_s=''): | |
1193 | """Print the status of the logging system.""" |
|
1198 | """Print the status of the logging system.""" | |
1194 |
|
1199 | |||
1195 | self.shell.logger.logstate() |
|
1200 | self.shell.logger.logstate() | |
1196 |
|
1201 | |||
1197 | def magic_pdb(self, parameter_s=''): |
|
1202 | def magic_pdb(self, parameter_s=''): | |
1198 | """Control the automatic calling of the pdb interactive debugger. |
|
1203 | """Control the automatic calling of the pdb interactive debugger. | |
1199 |
|
1204 | |||
1200 | Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without |
|
1205 | Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without | |
1201 | argument it works as a toggle. |
|
1206 | argument it works as a toggle. | |
1202 |
|
1207 | |||
1203 | When an exception is triggered, IPython can optionally call the |
|
1208 | When an exception is triggered, IPython can optionally call the | |
1204 | interactive pdb debugger after the traceback printout. %pdb toggles |
|
1209 | interactive pdb debugger after the traceback printout. %pdb toggles | |
1205 | this feature on and off. |
|
1210 | this feature on and off. | |
1206 |
|
1211 | |||
1207 | The initial state of this feature is set in your ipythonrc |
|
1212 | The initial state of this feature is set in your ipythonrc | |
1208 | configuration file (the variable is called 'pdb'). |
|
1213 | configuration file (the variable is called 'pdb'). | |
1209 |
|
1214 | |||
1210 | If you want to just activate the debugger AFTER an exception has fired, |
|
1215 | If you want to just activate the debugger AFTER an exception has fired, | |
1211 | without having to type '%pdb on' and rerunning your code, you can use |
|
1216 | without having to type '%pdb on' and rerunning your code, you can use | |
1212 | the %debug magic.""" |
|
1217 | the %debug magic.""" | |
1213 |
|
1218 | |||
1214 | par = parameter_s.strip().lower() |
|
1219 | par = parameter_s.strip().lower() | |
1215 |
|
1220 | |||
1216 | if par: |
|
1221 | if par: | |
1217 | try: |
|
1222 | try: | |
1218 | new_pdb = {'off':0,'0':0,'on':1,'1':1}[par] |
|
1223 | new_pdb = {'off':0,'0':0,'on':1,'1':1}[par] | |
1219 | except KeyError: |
|
1224 | except KeyError: | |
1220 | print ('Incorrect argument. Use on/1, off/0, ' |
|
1225 | print ('Incorrect argument. Use on/1, off/0, ' | |
1221 | 'or nothing for a toggle.') |
|
1226 | 'or nothing for a toggle.') | |
1222 | return |
|
1227 | return | |
1223 | else: |
|
1228 | else: | |
1224 | # toggle |
|
1229 | # toggle | |
1225 | new_pdb = not self.shell.call_pdb |
|
1230 | new_pdb = not self.shell.call_pdb | |
1226 |
|
1231 | |||
1227 | # set on the shell |
|
1232 | # set on the shell | |
1228 | self.shell.call_pdb = new_pdb |
|
1233 | self.shell.call_pdb = new_pdb | |
1229 | print 'Automatic pdb calling has been turned',on_off(new_pdb) |
|
1234 | print 'Automatic pdb calling has been turned',on_off(new_pdb) | |
1230 |
|
1235 | |||
1231 | def magic_debug(self, parameter_s=''): |
|
1236 | def magic_debug(self, parameter_s=''): | |
1232 | """Activate the interactive debugger in post-mortem mode. |
|
1237 | """Activate the interactive debugger in post-mortem mode. | |
1233 |
|
1238 | |||
1234 | If an exception has just occurred, this lets you inspect its stack |
|
1239 | If an exception has just occurred, this lets you inspect its stack | |
1235 | frames interactively. Note that this will always work only on the last |
|
1240 | frames interactively. Note that this will always work only on the last | |
1236 | traceback that occurred, so you must call this quickly after an |
|
1241 | traceback that occurred, so you must call this quickly after an | |
1237 | exception that you wish to inspect has fired, because if another one |
|
1242 | exception that you wish to inspect has fired, because if another one | |
1238 | occurs, it clobbers the previous one. |
|
1243 | occurs, it clobbers the previous one. | |
1239 |
|
1244 | |||
1240 | If you want IPython to automatically do this on every exception, see |
|
1245 | If you want IPython to automatically do this on every exception, see | |
1241 | the %pdb magic for more details. |
|
1246 | the %pdb magic for more details. | |
1242 | """ |
|
1247 | """ | |
1243 |
|
1248 | |||
1244 | self.shell.debugger(force=True) |
|
1249 | self.shell.debugger(force=True) | |
1245 |
|
1250 | |||
|
1251 | @testdec.skip_doctest | |||
1246 | def magic_prun(self, parameter_s ='',user_mode=1, |
|
1252 | def magic_prun(self, parameter_s ='',user_mode=1, | |
1247 | opts=None,arg_lst=None,prog_ns=None): |
|
1253 | opts=None,arg_lst=None,prog_ns=None): | |
1248 |
|
1254 | |||
1249 | """Run a statement through the python code profiler. |
|
1255 | """Run a statement through the python code profiler. | |
1250 |
|
1256 | |||
1251 |
Usage: |
|
1257 | Usage: | |
1252 | %prun [options] statement |
|
1258 | %prun [options] statement | |
1253 |
|
1259 | |||
1254 | The given statement (which doesn't require quote marks) is run via the |
|
1260 | The given statement (which doesn't require quote marks) is run via the | |
1255 | python profiler in a manner similar to the profile.run() function. |
|
1261 | python profiler in a manner similar to the profile.run() function. | |
1256 | Namespaces are internally managed to work correctly; profile.run |
|
1262 | Namespaces are internally managed to work correctly; profile.run | |
1257 | cannot be used in IPython because it makes certain assumptions about |
|
1263 | cannot be used in IPython because it makes certain assumptions about | |
1258 | namespaces which do not hold under IPython. |
|
1264 | namespaces which do not hold under IPython. | |
1259 |
|
1265 | |||
1260 | Options: |
|
1266 | Options: | |
1261 |
|
1267 | |||
1262 | -l <limit>: you can place restrictions on what or how much of the |
|
1268 | -l <limit>: you can place restrictions on what or how much of the | |
1263 | profile gets printed. The limit value can be: |
|
1269 | profile gets printed. The limit value can be: | |
1264 |
|
1270 | |||
1265 | * A string: only information for function names containing this string |
|
1271 | * A string: only information for function names containing this string | |
1266 | is printed. |
|
1272 | is printed. | |
1267 |
|
1273 | |||
1268 | * An integer: only these many lines are printed. |
|
1274 | * An integer: only these many lines are printed. | |
1269 |
|
1275 | |||
1270 | * A float (between 0 and 1): this fraction of the report is printed |
|
1276 | * A float (between 0 and 1): this fraction of the report is printed | |
1271 | (for example, use a limit of 0.4 to see the topmost 40% only). |
|
1277 | (for example, use a limit of 0.4 to see the topmost 40% only). | |
1272 |
|
1278 | |||
1273 | You can combine several limits with repeated use of the option. For |
|
1279 | You can combine several limits with repeated use of the option. For | |
1274 | example, '-l __init__ -l 5' will print only the topmost 5 lines of |
|
1280 | example, '-l __init__ -l 5' will print only the topmost 5 lines of | |
1275 | information about class constructors. |
|
1281 | information about class constructors. | |
1276 |
|
1282 | |||
1277 | -r: return the pstats.Stats object generated by the profiling. This |
|
1283 | -r: return the pstats.Stats object generated by the profiling. This | |
1278 | object has all the information about the profile in it, and you can |
|
1284 | object has all the information about the profile in it, and you can | |
1279 | later use it for further analysis or in other functions. |
|
1285 | later use it for further analysis or in other functions. | |
1280 |
|
1286 | |||
1281 | -s <key>: sort profile by given key. You can provide more than one key |
|
1287 | -s <key>: sort profile by given key. You can provide more than one key | |
1282 | by using the option several times: '-s key1 -s key2 -s key3...'. The |
|
1288 | by using the option several times: '-s key1 -s key2 -s key3...'. The | |
1283 | default sorting key is 'time'. |
|
1289 | default sorting key is 'time'. | |
1284 |
|
1290 | |||
1285 | The following is copied verbatim from the profile documentation |
|
1291 | The following is copied verbatim from the profile documentation | |
1286 | referenced below: |
|
1292 | referenced below: | |
1287 |
|
1293 | |||
1288 | When more than one key is provided, additional keys are used as |
|
1294 | When more than one key is provided, additional keys are used as | |
1289 | secondary criteria when the there is equality in all keys selected |
|
1295 | secondary criteria when the there is equality in all keys selected | |
1290 | before them. |
|
1296 | before them. | |
1291 |
|
1297 | |||
1292 | Abbreviations can be used for any key names, as long as the |
|
1298 | Abbreviations can be used for any key names, as long as the | |
1293 | abbreviation is unambiguous. The following are the keys currently |
|
1299 | abbreviation is unambiguous. The following are the keys currently | |
1294 | defined: |
|
1300 | defined: | |
1295 |
|
1301 | |||
1296 |
Valid Arg Meaning |
|
1302 | Valid Arg Meaning | |
1297 |
"calls" call count |
|
1303 | "calls" call count | |
1298 |
"cumulative" cumulative time |
|
1304 | "cumulative" cumulative time | |
1299 |
"file" file name |
|
1305 | "file" file name | |
1300 |
"module" file name |
|
1306 | "module" file name | |
1301 |
"pcalls" primitive call count |
|
1307 | "pcalls" primitive call count | |
1302 |
"line" line number |
|
1308 | "line" line number | |
1303 |
"name" function name |
|
1309 | "name" function name | |
1304 |
"nfl" name/file/line |
|
1310 | "nfl" name/file/line | |
1305 |
"stdname" standard name |
|
1311 | "stdname" standard name | |
1306 | "time" internal time |
|
1312 | "time" internal time | |
1307 |
|
1313 | |||
1308 | Note that all sorts on statistics are in descending order (placing |
|
1314 | Note that all sorts on statistics are in descending order (placing | |
1309 | most time consuming items first), where as name, file, and line number |
|
1315 | most time consuming items first), where as name, file, and line number | |
1310 | searches are in ascending order (i.e., alphabetical). The subtle |
|
1316 | searches are in ascending order (i.e., alphabetical). The subtle | |
1311 | distinction between "nfl" and "stdname" is that the standard name is a |
|
1317 | distinction between "nfl" and "stdname" is that the standard name is a | |
1312 | sort of the name as printed, which means that the embedded line |
|
1318 | sort of the name as printed, which means that the embedded line | |
1313 | numbers get compared in an odd way. For example, lines 3, 20, and 40 |
|
1319 | numbers get compared in an odd way. For example, lines 3, 20, and 40 | |
1314 | would (if the file names were the same) appear in the string order |
|
1320 | would (if the file names were the same) appear in the string order | |
1315 | "20" "3" and "40". In contrast, "nfl" does a numeric compare of the |
|
1321 | "20" "3" and "40". In contrast, "nfl" does a numeric compare of the | |
1316 | line numbers. In fact, sort_stats("nfl") is the same as |
|
1322 | line numbers. In fact, sort_stats("nfl") is the same as | |
1317 | sort_stats("name", "file", "line"). |
|
1323 | sort_stats("name", "file", "line"). | |
1318 |
|
1324 | |||
1319 | -T <filename>: save profile results as shown on screen to a text |
|
1325 | -T <filename>: save profile results as shown on screen to a text | |
1320 | file. The profile is still shown on screen. |
|
1326 | file. The profile is still shown on screen. | |
1321 |
|
1327 | |||
1322 | -D <filename>: save (via dump_stats) profile statistics to given |
|
1328 | -D <filename>: save (via dump_stats) profile statistics to given | |
1323 | filename. This data is in a format understod by the pstats module, and |
|
1329 | filename. This data is in a format understod by the pstats module, and | |
1324 | is generated by a call to the dump_stats() method of profile |
|
1330 | is generated by a call to the dump_stats() method of profile | |
1325 | objects. The profile is still shown on screen. |
|
1331 | objects. The profile is still shown on screen. | |
1326 |
|
1332 | |||
1327 | If you want to run complete programs under the profiler's control, use |
|
1333 | If you want to run complete programs under the profiler's control, use | |
1328 | '%run -p [prof_opts] filename.py [args to program]' where prof_opts |
|
1334 | '%run -p [prof_opts] filename.py [args to program]' where prof_opts | |
1329 | contains profiler specific options as described here. |
|
1335 | contains profiler specific options as described here. | |
1330 |
|
1336 | |||
1331 |
You can read the complete documentation for the profile module with: |
|
1337 | You can read the complete documentation for the profile module with:: | |
1332 | In []: import profile; profile.help() """ |
|
1338 | ||
|
1339 | In [1]: import profile; profile.help() | |||
|
1340 | """ | |||
1333 |
|
1341 | |||
1334 | opts_def = Struct(D=[''],l=[],s=['time'],T=['']) |
|
1342 | opts_def = Struct(D=[''],l=[],s=['time'],T=['']) | |
1335 | # protect user quote marks |
|
1343 | # protect user quote marks | |
1336 | parameter_s = parameter_s.replace('"',r'\"').replace("'",r"\'") |
|
1344 | parameter_s = parameter_s.replace('"',r'\"').replace("'",r"\'") | |
1337 |
|
1345 | |||
1338 | if user_mode: # regular user call |
|
1346 | if user_mode: # regular user call | |
1339 | opts,arg_str = self.parse_options(parameter_s,'D:l:rs:T:', |
|
1347 | opts,arg_str = self.parse_options(parameter_s,'D:l:rs:T:', | |
1340 | list_all=1) |
|
1348 | list_all=1) | |
1341 | namespace = self.shell.user_ns |
|
1349 | namespace = self.shell.user_ns | |
1342 | else: # called to run a program by %run -p |
|
1350 | else: # called to run a program by %run -p | |
1343 | try: |
|
1351 | try: | |
1344 | filename = get_py_filename(arg_lst[0]) |
|
1352 | filename = get_py_filename(arg_lst[0]) | |
1345 | except IOError,msg: |
|
1353 | except IOError,msg: | |
1346 | error(msg) |
|
1354 | error(msg) | |
1347 | return |
|
1355 | return | |
1348 |
|
1356 | |||
1349 | arg_str = 'execfile(filename,prog_ns)' |
|
1357 | arg_str = 'execfile(filename,prog_ns)' | |
1350 | namespace = locals() |
|
1358 | namespace = locals() | |
1351 |
|
1359 | |||
1352 | opts.merge(opts_def) |
|
1360 | opts.merge(opts_def) | |
1353 |
|
1361 | |||
1354 | prof = profile.Profile() |
|
1362 | prof = profile.Profile() | |
1355 | try: |
|
1363 | try: | |
1356 | prof = prof.runctx(arg_str,namespace,namespace) |
|
1364 | prof = prof.runctx(arg_str,namespace,namespace) | |
1357 | sys_exit = '' |
|
1365 | sys_exit = '' | |
1358 | except SystemExit: |
|
1366 | except SystemExit: | |
1359 | sys_exit = """*** SystemExit exception caught in code being profiled.""" |
|
1367 | sys_exit = """*** SystemExit exception caught in code being profiled.""" | |
1360 |
|
1368 | |||
1361 | stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s) |
|
1369 | stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s) | |
1362 |
|
1370 | |||
1363 | lims = opts.l |
|
1371 | lims = opts.l | |
1364 | if lims: |
|
1372 | if lims: | |
1365 | lims = [] # rebuild lims with ints/floats/strings |
|
1373 | lims = [] # rebuild lims with ints/floats/strings | |
1366 | for lim in opts.l: |
|
1374 | for lim in opts.l: | |
1367 | try: |
|
1375 | try: | |
1368 | lims.append(int(lim)) |
|
1376 | lims.append(int(lim)) | |
1369 | except ValueError: |
|
1377 | except ValueError: | |
1370 | try: |
|
1378 | try: | |
1371 | lims.append(float(lim)) |
|
1379 | lims.append(float(lim)) | |
1372 | except ValueError: |
|
1380 | except ValueError: | |
1373 | lims.append(lim) |
|
1381 | lims.append(lim) | |
1374 |
|
1382 | |||
1375 | # Trap output. |
|
1383 | # Trap output. | |
1376 | stdout_trap = StringIO() |
|
1384 | stdout_trap = StringIO() | |
1377 |
|
1385 | |||
1378 | if hasattr(stats,'stream'): |
|
1386 | if hasattr(stats,'stream'): | |
1379 | # In newer versions of python, the stats object has a 'stream' |
|
1387 | # In newer versions of python, the stats object has a 'stream' | |
1380 | # attribute to write into. |
|
1388 | # attribute to write into. | |
1381 | stats.stream = stdout_trap |
|
1389 | stats.stream = stdout_trap | |
1382 | stats.print_stats(*lims) |
|
1390 | stats.print_stats(*lims) | |
1383 | else: |
|
1391 | else: | |
1384 | # For older versions, we manually redirect stdout during printing |
|
1392 | # For older versions, we manually redirect stdout during printing | |
1385 | sys_stdout = sys.stdout |
|
1393 | sys_stdout = sys.stdout | |
1386 | try: |
|
1394 | try: | |
1387 | sys.stdout = stdout_trap |
|
1395 | sys.stdout = stdout_trap | |
1388 | stats.print_stats(*lims) |
|
1396 | stats.print_stats(*lims) | |
1389 | finally: |
|
1397 | finally: | |
1390 | sys.stdout = sys_stdout |
|
1398 | sys.stdout = sys_stdout | |
1391 |
|
1399 | |||
1392 | output = stdout_trap.getvalue() |
|
1400 | output = stdout_trap.getvalue() | |
1393 | output = output.rstrip() |
|
1401 | output = output.rstrip() | |
1394 |
|
1402 | |||
1395 | page(output,screen_lines=self.shell.rc.screen_length) |
|
1403 | page(output,screen_lines=self.shell.rc.screen_length) | |
1396 | print sys_exit, |
|
1404 | print sys_exit, | |
1397 |
|
1405 | |||
1398 | dump_file = opts.D[0] |
|
1406 | dump_file = opts.D[0] | |
1399 | text_file = opts.T[0] |
|
1407 | text_file = opts.T[0] | |
1400 | if dump_file: |
|
1408 | if dump_file: | |
1401 | prof.dump_stats(dump_file) |
|
1409 | prof.dump_stats(dump_file) | |
1402 | print '\n*** Profile stats marshalled to file',\ |
|
1410 | print '\n*** Profile stats marshalled to file',\ | |
1403 | `dump_file`+'.',sys_exit |
|
1411 | `dump_file`+'.',sys_exit | |
1404 | if text_file: |
|
1412 | if text_file: | |
1405 | pfile = file(text_file,'w') |
|
1413 | pfile = file(text_file,'w') | |
1406 | pfile.write(output) |
|
1414 | pfile.write(output) | |
1407 | pfile.close() |
|
1415 | pfile.close() | |
1408 | print '\n*** Profile printout saved to text file',\ |
|
1416 | print '\n*** Profile printout saved to text file',\ | |
1409 | `text_file`+'.',sys_exit |
|
1417 | `text_file`+'.',sys_exit | |
1410 |
|
1418 | |||
1411 | if opts.has_key('r'): |
|
1419 | if opts.has_key('r'): | |
1412 | return stats |
|
1420 | return stats | |
1413 | else: |
|
1421 | else: | |
1414 | return None |
|
1422 | return None | |
1415 |
|
1423 | |||
|
1424 | @testdec.skip_doctest | |||
1416 | def magic_run(self, parameter_s ='',runner=None): |
|
1425 | def magic_run(self, parameter_s ='',runner=None): | |
1417 | """Run the named file inside IPython as a program. |
|
1426 | """Run the named file inside IPython as a program. | |
1418 |
|
1427 | |||
1419 | Usage:\\ |
|
1428 | Usage:\\ | |
1420 | %run [-n -i -t [-N<N>] -d [-b<N>] -p [profile options]] file [args] |
|
1429 | %run [-n -i -t [-N<N>] -d [-b<N>] -p [profile options]] file [args] | |
1421 |
|
1430 | |||
1422 | Parameters after the filename are passed as command-line arguments to |
|
1431 | Parameters after the filename are passed as command-line arguments to | |
1423 | the program (put in sys.argv). Then, control returns to IPython's |
|
1432 | the program (put in sys.argv). Then, control returns to IPython's | |
1424 | prompt. |
|
1433 | prompt. | |
1425 |
|
1434 | |||
1426 | This is similar to running at a system prompt:\\ |
|
1435 | This is similar to running at a system prompt:\\ | |
1427 | $ python file args\\ |
|
1436 | $ python file args\\ | |
1428 | but with the advantage of giving you IPython's tracebacks, and of |
|
1437 | but with the advantage of giving you IPython's tracebacks, and of | |
1429 | loading all variables into your interactive namespace for further use |
|
1438 | loading all variables into your interactive namespace for further use | |
1430 | (unless -p is used, see below). |
|
1439 | (unless -p is used, see below). | |
1431 |
|
1440 | |||
1432 | The file is executed in a namespace initially consisting only of |
|
1441 | The file is executed in a namespace initially consisting only of | |
1433 | __name__=='__main__' and sys.argv constructed as indicated. It thus |
|
1442 | __name__=='__main__' and sys.argv constructed as indicated. It thus | |
1434 | sees its environment as if it were being run as a stand-alone program |
|
1443 | sees its environment as if it were being run as a stand-alone program | |
1435 | (except for sharing global objects such as previously imported |
|
1444 | (except for sharing global objects such as previously imported | |
1436 | modules). But after execution, the IPython interactive namespace gets |
|
1445 | modules). But after execution, the IPython interactive namespace gets | |
1437 | updated with all variables defined in the program (except for __name__ |
|
1446 | updated with all variables defined in the program (except for __name__ | |
1438 | and sys.argv). This allows for very convenient loading of code for |
|
1447 | and sys.argv). This allows for very convenient loading of code for | |
1439 | interactive work, while giving each program a 'clean sheet' to run in. |
|
1448 | interactive work, while giving each program a 'clean sheet' to run in. | |
1440 |
|
1449 | |||
1441 | Options: |
|
1450 | Options: | |
1442 |
|
1451 | |||
1443 | -n: __name__ is NOT set to '__main__', but to the running file's name |
|
1452 | -n: __name__ is NOT set to '__main__', but to the running file's name | |
1444 | without extension (as python does under import). This allows running |
|
1453 | without extension (as python does under import). This allows running | |
1445 | scripts and reloading the definitions in them without calling code |
|
1454 | scripts and reloading the definitions in them without calling code | |
1446 | protected by an ' if __name__ == "__main__" ' clause. |
|
1455 | protected by an ' if __name__ == "__main__" ' clause. | |
1447 |
|
1456 | |||
1448 | -i: run the file in IPython's namespace instead of an empty one. This |
|
1457 | -i: run the file in IPython's namespace instead of an empty one. This | |
1449 | is useful if you are experimenting with code written in a text editor |
|
1458 | is useful if you are experimenting with code written in a text editor | |
1450 | which depends on variables defined interactively. |
|
1459 | which depends on variables defined interactively. | |
1451 |
|
1460 | |||
1452 | -e: ignore sys.exit() calls or SystemExit exceptions in the script |
|
1461 | -e: ignore sys.exit() calls or SystemExit exceptions in the script | |
1453 | being run. This is particularly useful if IPython is being used to |
|
1462 | being run. This is particularly useful if IPython is being used to | |
1454 | run unittests, which always exit with a sys.exit() call. In such |
|
1463 | run unittests, which always exit with a sys.exit() call. In such | |
1455 | cases you are interested in the output of the test results, not in |
|
1464 | cases you are interested in the output of the test results, not in | |
1456 | seeing a traceback of the unittest module. |
|
1465 | seeing a traceback of the unittest module. | |
1457 |
|
1466 | |||
1458 | -t: print timing information at the end of the run. IPython will give |
|
1467 | -t: print timing information at the end of the run. IPython will give | |
1459 | you an estimated CPU time consumption for your script, which under |
|
1468 | you an estimated CPU time consumption for your script, which under | |
1460 | Unix uses the resource module to avoid the wraparound problems of |
|
1469 | Unix uses the resource module to avoid the wraparound problems of | |
1461 | time.clock(). Under Unix, an estimate of time spent on system tasks |
|
1470 | time.clock(). Under Unix, an estimate of time spent on system tasks | |
1462 | is also given (for Windows platforms this is reported as 0.0). |
|
1471 | is also given (for Windows platforms this is reported as 0.0). | |
1463 |
|
1472 | |||
1464 | If -t is given, an additional -N<N> option can be given, where <N> |
|
1473 | If -t is given, an additional -N<N> option can be given, where <N> | |
1465 | must be an integer indicating how many times you want the script to |
|
1474 | must be an integer indicating how many times you want the script to | |
1466 | run. The final timing report will include total and per run results. |
|
1475 | run. The final timing report will include total and per run results. | |
1467 |
|
1476 | |||
1468 | For example (testing the script uniq_stable.py): |
|
1477 | For example (testing the script uniq_stable.py): | |
1469 |
|
1478 | |||
1470 | In [1]: run -t uniq_stable |
|
1479 | In [1]: run -t uniq_stable | |
1471 |
|
1480 | |||
1472 | IPython CPU timings (estimated):\\ |
|
1481 | IPython CPU timings (estimated):\\ | |
1473 | User : 0.19597 s.\\ |
|
1482 | User : 0.19597 s.\\ | |
1474 | System: 0.0 s.\\ |
|
1483 | System: 0.0 s.\\ | |
1475 |
|
1484 | |||
1476 | In [2]: run -t -N5 uniq_stable |
|
1485 | In [2]: run -t -N5 uniq_stable | |
1477 |
|
1486 | |||
1478 | IPython CPU timings (estimated):\\ |
|
1487 | IPython CPU timings (estimated):\\ | |
1479 | Total runs performed: 5\\ |
|
1488 | Total runs performed: 5\\ | |
1480 | Times : Total Per run\\ |
|
1489 | Times : Total Per run\\ | |
1481 | User : 0.910862 s, 0.1821724 s.\\ |
|
1490 | User : 0.910862 s, 0.1821724 s.\\ | |
1482 | System: 0.0 s, 0.0 s. |
|
1491 | System: 0.0 s, 0.0 s. | |
1483 |
|
1492 | |||
1484 | -d: run your program under the control of pdb, the Python debugger. |
|
1493 | -d: run your program under the control of pdb, the Python debugger. | |
1485 | This allows you to execute your program step by step, watch variables, |
|
1494 | This allows you to execute your program step by step, watch variables, | |
1486 | etc. Internally, what IPython does is similar to calling: |
|
1495 | etc. Internally, what IPython does is similar to calling: | |
1487 |
|
1496 | |||
1488 | pdb.run('execfile("YOURFILENAME")') |
|
1497 | pdb.run('execfile("YOURFILENAME")') | |
1489 |
|
1498 | |||
1490 | with a breakpoint set on line 1 of your file. You can change the line |
|
1499 | with a breakpoint set on line 1 of your file. You can change the line | |
1491 | number for this automatic breakpoint to be <N> by using the -bN option |
|
1500 | number for this automatic breakpoint to be <N> by using the -bN option | |
1492 | (where N must be an integer). For example: |
|
1501 | (where N must be an integer). For example: | |
1493 |
|
1502 | |||
1494 | %run -d -b40 myscript |
|
1503 | %run -d -b40 myscript | |
1495 |
|
1504 | |||
1496 | will set the first breakpoint at line 40 in myscript.py. Note that |
|
1505 | will set the first breakpoint at line 40 in myscript.py. Note that | |
1497 | the first breakpoint must be set on a line which actually does |
|
1506 | the first breakpoint must be set on a line which actually does | |
1498 | something (not a comment or docstring) for it to stop execution. |
|
1507 | something (not a comment or docstring) for it to stop execution. | |
1499 |
|
1508 | |||
1500 | When the pdb debugger starts, you will see a (Pdb) prompt. You must |
|
1509 | When the pdb debugger starts, you will see a (Pdb) prompt. You must | |
1501 | first enter 'c' (without qoutes) to start execution up to the first |
|
1510 | first enter 'c' (without qoutes) to start execution up to the first | |
1502 | breakpoint. |
|
1511 | breakpoint. | |
1503 |
|
1512 | |||
1504 | Entering 'help' gives information about the use of the debugger. You |
|
1513 | Entering 'help' gives information about the use of the debugger. You | |
1505 | can easily see pdb's full documentation with "import pdb;pdb.help()" |
|
1514 | can easily see pdb's full documentation with "import pdb;pdb.help()" | |
1506 | at a prompt. |
|
1515 | at a prompt. | |
1507 |
|
1516 | |||
1508 | -p: run program under the control of the Python profiler module (which |
|
1517 | -p: run program under the control of the Python profiler module (which | |
1509 | prints a detailed report of execution times, function calls, etc). |
|
1518 | prints a detailed report of execution times, function calls, etc). | |
1510 |
|
1519 | |||
1511 | You can pass other options after -p which affect the behavior of the |
|
1520 | You can pass other options after -p which affect the behavior of the | |
1512 | profiler itself. See the docs for %prun for details. |
|
1521 | profiler itself. See the docs for %prun for details. | |
1513 |
|
1522 | |||
1514 | In this mode, the program's variables do NOT propagate back to the |
|
1523 | In this mode, the program's variables do NOT propagate back to the | |
1515 | IPython interactive namespace (because they remain in the namespace |
|
1524 | IPython interactive namespace (because they remain in the namespace | |
1516 | where the profiler executes them). |
|
1525 | where the profiler executes them). | |
1517 |
|
1526 | |||
1518 | Internally this triggers a call to %prun, see its documentation for |
|
1527 | Internally this triggers a call to %prun, see its documentation for | |
1519 | details on the options available specifically for profiling. |
|
1528 | details on the options available specifically for profiling. | |
1520 |
|
1529 | |||
1521 | There is one special usage for which the text above doesn't apply: |
|
1530 | There is one special usage for which the text above doesn't apply: | |
1522 | if the filename ends with .ipy, the file is run as ipython script, |
|
1531 | if the filename ends with .ipy, the file is run as ipython script, | |
1523 | just as if the commands were written on IPython prompt. |
|
1532 | just as if the commands were written on IPython prompt. | |
1524 | """ |
|
1533 | """ | |
1525 |
|
1534 | |||
1526 | # get arguments and set sys.argv for program to be run. |
|
1535 | # get arguments and set sys.argv for program to be run. | |
1527 | opts,arg_lst = self.parse_options(parameter_s,'nidtN:b:pD:l:rs:T:e', |
|
1536 | opts,arg_lst = self.parse_options(parameter_s,'nidtN:b:pD:l:rs:T:e', | |
1528 | mode='list',list_all=1) |
|
1537 | mode='list',list_all=1) | |
1529 |
|
1538 | |||
1530 | try: |
|
1539 | try: | |
1531 | filename = get_py_filename(arg_lst[0]) |
|
1540 | filename = get_py_filename(arg_lst[0]) | |
1532 | except IndexError: |
|
1541 | except IndexError: | |
1533 | warn('you must provide at least a filename.') |
|
1542 | warn('you must provide at least a filename.') | |
1534 | print '\n%run:\n',OInspect.getdoc(self.magic_run) |
|
1543 | print '\n%run:\n',OInspect.getdoc(self.magic_run) | |
1535 | return |
|
1544 | return | |
1536 | except IOError,msg: |
|
1545 | except IOError,msg: | |
1537 | error(msg) |
|
1546 | error(msg) | |
1538 | return |
|
1547 | return | |
1539 |
|
1548 | |||
1540 | if filename.lower().endswith('.ipy'): |
|
1549 | if filename.lower().endswith('.ipy'): | |
1541 | self.api.runlines(open(filename).read()) |
|
1550 | self.api.runlines(open(filename).read()) | |
1542 | return |
|
1551 | return | |
1543 |
|
1552 | |||
1544 | # Control the response to exit() calls made by the script being run |
|
1553 | # Control the response to exit() calls made by the script being run | |
1545 | exit_ignore = opts.has_key('e') |
|
1554 | exit_ignore = opts.has_key('e') | |
1546 |
|
1555 | |||
1547 | # Make sure that the running script gets a proper sys.argv as if it |
|
1556 | # Make sure that the running script gets a proper sys.argv as if it | |
1548 | # were run from a system shell. |
|
1557 | # were run from a system shell. | |
1549 | save_argv = sys.argv # save it for later restoring |
|
1558 | save_argv = sys.argv # save it for later restoring | |
1550 | sys.argv = [filename]+ arg_lst[1:] # put in the proper filename |
|
1559 | sys.argv = [filename]+ arg_lst[1:] # put in the proper filename | |
1551 |
|
1560 | |||
1552 | if opts.has_key('i'): |
|
1561 | if opts.has_key('i'): | |
1553 | # Run in user's interactive namespace |
|
1562 | # Run in user's interactive namespace | |
1554 | prog_ns = self.shell.user_ns |
|
1563 | prog_ns = self.shell.user_ns | |
1555 | __name__save = self.shell.user_ns['__name__'] |
|
1564 | __name__save = self.shell.user_ns['__name__'] | |
1556 | prog_ns['__name__'] = '__main__' |
|
1565 | prog_ns['__name__'] = '__main__' | |
1557 | main_mod = FakeModule(prog_ns) |
|
1566 | main_mod = FakeModule(prog_ns) | |
1558 | else: |
|
1567 | else: | |
1559 | # Run in a fresh, empty namespace |
|
1568 | # Run in a fresh, empty namespace | |
1560 | if opts.has_key('n'): |
|
1569 | if opts.has_key('n'): | |
1561 | name = os.path.splitext(os.path.basename(filename))[0] |
|
1570 | name = os.path.splitext(os.path.basename(filename))[0] | |
1562 | else: |
|
1571 | else: | |
1563 | name = '__main__' |
|
1572 | name = '__main__' | |
1564 | main_mod = FakeModule() |
|
1573 | main_mod = FakeModule() | |
1565 | prog_ns = main_mod.__dict__ |
|
1574 | prog_ns = main_mod.__dict__ | |
1566 | prog_ns['__name__'] = name |
|
1575 | prog_ns['__name__'] = name | |
1567 | # The shell MUST hold a reference to main_mod so after %run exits, |
|
1576 | # The shell MUST hold a reference to main_mod so after %run exits, | |
1568 | # the python deletion mechanism doesn't zero it out (leaving |
|
1577 | # the python deletion mechanism doesn't zero it out (leaving | |
1569 | # dangling references) |
|
1578 | # dangling references) | |
1570 | self.shell._user_main_modules.append(main_mod) |
|
1579 | self.shell._user_main_modules.append(main_mod) | |
1571 |
|
1580 | |||
1572 | # Since '%run foo' emulates 'python foo.py' at the cmd line, we must |
|
1581 | # Since '%run foo' emulates 'python foo.py' at the cmd line, we must | |
1573 | # set the __file__ global in the script's namespace |
|
1582 | # set the __file__ global in the script's namespace | |
1574 | prog_ns['__file__'] = filename |
|
1583 | prog_ns['__file__'] = filename | |
1575 |
|
1584 | |||
1576 | # pickle fix. See iplib for an explanation. But we need to make sure |
|
1585 | # pickle fix. See iplib for an explanation. But we need to make sure | |
1577 | # that, if we overwrite __main__, we replace it at the end |
|
1586 | # that, if we overwrite __main__, we replace it at the end | |
1578 | main_mod_name = prog_ns['__name__'] |
|
1587 | main_mod_name = prog_ns['__name__'] | |
1579 |
|
1588 | |||
1580 | if main_mod_name == '__main__': |
|
1589 | if main_mod_name == '__main__': | |
1581 | restore_main = sys.modules['__main__'] |
|
1590 | restore_main = sys.modules['__main__'] | |
1582 | else: |
|
1591 | else: | |
1583 | restore_main = False |
|
1592 | restore_main = False | |
1584 |
|
1593 | |||
1585 | # This needs to be undone at the end to prevent holding references to |
|
1594 | # This needs to be undone at the end to prevent holding references to | |
1586 | # every single object ever created. |
|
1595 | # every single object ever created. | |
1587 | sys.modules[main_mod_name] = main_mod |
|
1596 | sys.modules[main_mod_name] = main_mod | |
1588 |
|
1597 | |||
1589 | stats = None |
|
1598 | stats = None | |
1590 | try: |
|
1599 | try: | |
1591 | self.shell.savehist() |
|
1600 | self.shell.savehist() | |
1592 |
|
1601 | |||
1593 | if opts.has_key('p'): |
|
1602 | if opts.has_key('p'): | |
1594 | stats = self.magic_prun('',0,opts,arg_lst,prog_ns) |
|
1603 | stats = self.magic_prun('',0,opts,arg_lst,prog_ns) | |
1595 | else: |
|
1604 | else: | |
1596 | if opts.has_key('d'): |
|
1605 | if opts.has_key('d'): | |
1597 | deb = Debugger.Pdb(self.shell.rc.colors) |
|
1606 | deb = Debugger.Pdb(self.shell.rc.colors) | |
1598 | # reset Breakpoint state, which is moronically kept |
|
1607 | # reset Breakpoint state, which is moronically kept | |
1599 | # in a class |
|
1608 | # in a class | |
1600 | bdb.Breakpoint.next = 1 |
|
1609 | bdb.Breakpoint.next = 1 | |
1601 | bdb.Breakpoint.bplist = {} |
|
1610 | bdb.Breakpoint.bplist = {} | |
1602 | bdb.Breakpoint.bpbynumber = [None] |
|
1611 | bdb.Breakpoint.bpbynumber = [None] | |
1603 | # Set an initial breakpoint to stop execution |
|
1612 | # Set an initial breakpoint to stop execution | |
1604 | maxtries = 10 |
|
1613 | maxtries = 10 | |
1605 | bp = int(opts.get('b',[1])[0]) |
|
1614 | bp = int(opts.get('b',[1])[0]) | |
1606 | checkline = deb.checkline(filename,bp) |
|
1615 | checkline = deb.checkline(filename,bp) | |
1607 | if not checkline: |
|
1616 | if not checkline: | |
1608 | for bp in range(bp+1,bp+maxtries+1): |
|
1617 | for bp in range(bp+1,bp+maxtries+1): | |
1609 | if deb.checkline(filename,bp): |
|
1618 | if deb.checkline(filename,bp): | |
1610 | break |
|
1619 | break | |
1611 | else: |
|
1620 | else: | |
1612 | msg = ("\nI failed to find a valid line to set " |
|
1621 | msg = ("\nI failed to find a valid line to set " | |
1613 | "a breakpoint\n" |
|
1622 | "a breakpoint\n" | |
1614 | "after trying up to line: %s.\n" |
|
1623 | "after trying up to line: %s.\n" | |
1615 | "Please set a valid breakpoint manually " |
|
1624 | "Please set a valid breakpoint manually " | |
1616 | "with the -b option." % bp) |
|
1625 | "with the -b option." % bp) | |
1617 | error(msg) |
|
1626 | error(msg) | |
1618 | return |
|
1627 | return | |
1619 | # if we find a good linenumber, set the breakpoint |
|
1628 | # if we find a good linenumber, set the breakpoint | |
1620 | deb.do_break('%s:%s' % (filename,bp)) |
|
1629 | deb.do_break('%s:%s' % (filename,bp)) | |
1621 | # Start file run |
|
1630 | # Start file run | |
1622 | print "NOTE: Enter 'c' at the", |
|
1631 | print "NOTE: Enter 'c' at the", | |
1623 | print "%s prompt to start your script." % deb.prompt |
|
1632 | print "%s prompt to start your script." % deb.prompt | |
1624 | try: |
|
1633 | try: | |
1625 | deb.run('execfile("%s")' % filename,prog_ns) |
|
1634 | deb.run('execfile("%s")' % filename,prog_ns) | |
1626 |
|
1635 | |||
1627 | except: |
|
1636 | except: | |
1628 | etype, value, tb = sys.exc_info() |
|
1637 | etype, value, tb = sys.exc_info() | |
1629 | # Skip three frames in the traceback: the %run one, |
|
1638 | # Skip three frames in the traceback: the %run one, | |
1630 | # one inside bdb.py, and the command-line typed by the |
|
1639 | # one inside bdb.py, and the command-line typed by the | |
1631 | # user (run by exec in pdb itself). |
|
1640 | # user (run by exec in pdb itself). | |
1632 | self.shell.InteractiveTB(etype,value,tb,tb_offset=3) |
|
1641 | self.shell.InteractiveTB(etype,value,tb,tb_offset=3) | |
1633 | else: |
|
1642 | else: | |
1634 | if runner is None: |
|
1643 | if runner is None: | |
1635 | runner = self.shell.safe_execfile |
|
1644 | runner = self.shell.safe_execfile | |
1636 | if opts.has_key('t'): |
|
1645 | if opts.has_key('t'): | |
1637 | # timed execution |
|
1646 | # timed execution | |
1638 | try: |
|
1647 | try: | |
1639 | nruns = int(opts['N'][0]) |
|
1648 | nruns = int(opts['N'][0]) | |
1640 | if nruns < 1: |
|
1649 | if nruns < 1: | |
1641 | error('Number of runs must be >=1') |
|
1650 | error('Number of runs must be >=1') | |
1642 | return |
|
1651 | return | |
1643 | except (KeyError): |
|
1652 | except (KeyError): | |
1644 | nruns = 1 |
|
1653 | nruns = 1 | |
1645 | if nruns == 1: |
|
1654 | if nruns == 1: | |
1646 | t0 = clock2() |
|
1655 | t0 = clock2() | |
1647 | runner(filename,prog_ns,prog_ns, |
|
1656 | runner(filename,prog_ns,prog_ns, | |
1648 | exit_ignore=exit_ignore) |
|
1657 | exit_ignore=exit_ignore) | |
1649 | t1 = clock2() |
|
1658 | t1 = clock2() | |
1650 | t_usr = t1[0]-t0[0] |
|
1659 | t_usr = t1[0]-t0[0] | |
1651 | t_sys = t1[1]-t1[1] |
|
1660 | t_sys = t1[1]-t1[1] | |
1652 | print "\nIPython CPU timings (estimated):" |
|
1661 | print "\nIPython CPU timings (estimated):" | |
1653 | print " User : %10s s." % t_usr |
|
1662 | print " User : %10s s." % t_usr | |
1654 | print " System: %10s s." % t_sys |
|
1663 | print " System: %10s s." % t_sys | |
1655 | else: |
|
1664 | else: | |
1656 | runs = range(nruns) |
|
1665 | runs = range(nruns) | |
1657 | t0 = clock2() |
|
1666 | t0 = clock2() | |
1658 | for nr in runs: |
|
1667 | for nr in runs: | |
1659 | runner(filename,prog_ns,prog_ns, |
|
1668 | runner(filename,prog_ns,prog_ns, | |
1660 | exit_ignore=exit_ignore) |
|
1669 | exit_ignore=exit_ignore) | |
1661 | t1 = clock2() |
|
1670 | t1 = clock2() | |
1662 | t_usr = t1[0]-t0[0] |
|
1671 | t_usr = t1[0]-t0[0] | |
1663 | t_sys = t1[1]-t1[1] |
|
1672 | t_sys = t1[1]-t1[1] | |
1664 | print "\nIPython CPU timings (estimated):" |
|
1673 | print "\nIPython CPU timings (estimated):" | |
1665 | print "Total runs performed:",nruns |
|
1674 | print "Total runs performed:",nruns | |
1666 | print " Times : %10s %10s" % ('Total','Per run') |
|
1675 | print " Times : %10s %10s" % ('Total','Per run') | |
1667 | print " User : %10s s, %10s s." % (t_usr,t_usr/nruns) |
|
1676 | print " User : %10s s, %10s s." % (t_usr,t_usr/nruns) | |
1668 | print " System: %10s s, %10s s." % (t_sys,t_sys/nruns) |
|
1677 | print " System: %10s s, %10s s." % (t_sys,t_sys/nruns) | |
1669 |
|
1678 | |||
1670 | else: |
|
1679 | else: | |
1671 | # regular execution |
|
1680 | # regular execution | |
1672 | runner(filename,prog_ns,prog_ns,exit_ignore=exit_ignore) |
|
1681 | runner(filename,prog_ns,prog_ns,exit_ignore=exit_ignore) | |
1673 | if opts.has_key('i'): |
|
1682 | if opts.has_key('i'): | |
1674 | self.shell.user_ns['__name__'] = __name__save |
|
1683 | self.shell.user_ns['__name__'] = __name__save | |
1675 | else: |
|
1684 | else: | |
1676 | # update IPython interactive namespace |
|
1685 | # update IPython interactive namespace | |
1677 | del prog_ns['__name__'] |
|
1686 | del prog_ns['__name__'] | |
1678 | self.shell.user_ns.update(prog_ns) |
|
1687 | self.shell.user_ns.update(prog_ns) | |
1679 | finally: |
|
1688 | finally: | |
1680 | # Ensure key global structures are restored |
|
1689 | # Ensure key global structures are restored | |
1681 | sys.argv = save_argv |
|
1690 | sys.argv = save_argv | |
1682 | if restore_main: |
|
1691 | if restore_main: | |
1683 | sys.modules['__main__'] = restore_main |
|
1692 | sys.modules['__main__'] = restore_main | |
1684 | else: |
|
1693 | else: | |
1685 | # Remove from sys.modules the reference to main_mod we'd |
|
1694 | # Remove from sys.modules the reference to main_mod we'd | |
1686 | # added. Otherwise it will trap references to objects |
|
1695 | # added. Otherwise it will trap references to objects | |
1687 | # contained therein. |
|
1696 | # contained therein. | |
1688 | del sys.modules[main_mod_name] |
|
1697 | del sys.modules[main_mod_name] | |
1689 | self.shell.reloadhist() |
|
1698 | self.shell.reloadhist() | |
1690 |
|
1699 | |||
1691 | return stats |
|
1700 | return stats | |
1692 |
|
1701 | |||
1693 | def magic_runlog(self, parameter_s =''): |
|
1702 | def magic_runlog(self, parameter_s =''): | |
1694 | """Run files as logs. |
|
1703 | """Run files as logs. | |
1695 |
|
1704 | |||
1696 | Usage:\\ |
|
1705 | Usage:\\ | |
1697 | %runlog file1 file2 ... |
|
1706 | %runlog file1 file2 ... | |
1698 |
|
1707 | |||
1699 | Run the named files (treating them as log files) in sequence inside |
|
1708 | Run the named files (treating them as log files) in sequence inside | |
1700 | the interpreter, and return to the prompt. This is much slower than |
|
1709 | the interpreter, and return to the prompt. This is much slower than | |
1701 | %run because each line is executed in a try/except block, but it |
|
1710 | %run because each line is executed in a try/except block, but it | |
1702 | allows running files with syntax errors in them. |
|
1711 | allows running files with syntax errors in them. | |
1703 |
|
1712 | |||
1704 | Normally IPython will guess when a file is one of its own logfiles, so |
|
1713 | Normally IPython will guess when a file is one of its own logfiles, so | |
1705 | you can typically use %run even for logs. This shorthand allows you to |
|
1714 | you can typically use %run even for logs. This shorthand allows you to | |
1706 | force any file to be treated as a log file.""" |
|
1715 | force any file to be treated as a log file.""" | |
1707 |
|
1716 | |||
1708 | for f in parameter_s.split(): |
|
1717 | for f in parameter_s.split(): | |
1709 | self.shell.safe_execfile(f,self.shell.user_ns, |
|
1718 | self.shell.safe_execfile(f,self.shell.user_ns, | |
1710 | self.shell.user_ns,islog=1) |
|
1719 | self.shell.user_ns,islog=1) | |
1711 |
|
1720 | |||
|
1721 | @testdec.skip_doctest | |||
1712 | def magic_timeit(self, parameter_s =''): |
|
1722 | def magic_timeit(self, parameter_s =''): | |
1713 | """Time execution of a Python statement or expression |
|
1723 | """Time execution of a Python statement or expression | |
1714 |
|
1724 | |||
1715 | Usage:\\ |
|
1725 | Usage:\\ | |
1716 | %timeit [-n<N> -r<R> [-t|-c]] statement |
|
1726 | %timeit [-n<N> -r<R> [-t|-c]] statement | |
1717 |
|
1727 | |||
1718 | Time execution of a Python statement or expression using the timeit |
|
1728 | Time execution of a Python statement or expression using the timeit | |
1719 | module. |
|
1729 | module. | |
1720 |
|
1730 | |||
1721 | Options: |
|
1731 | Options: | |
1722 | -n<N>: execute the given statement <N> times in a loop. If this value |
|
1732 | -n<N>: execute the given statement <N> times in a loop. If this value | |
1723 | is not given, a fitting value is chosen. |
|
1733 | is not given, a fitting value is chosen. | |
1724 |
|
1734 | |||
1725 | -r<R>: repeat the loop iteration <R> times and take the best result. |
|
1735 | -r<R>: repeat the loop iteration <R> times and take the best result. | |
1726 | Default: 3 |
|
1736 | Default: 3 | |
1727 |
|
1737 | |||
1728 | -t: use time.time to measure the time, which is the default on Unix. |
|
1738 | -t: use time.time to measure the time, which is the default on Unix. | |
1729 | This function measures wall time. |
|
1739 | This function measures wall time. | |
1730 |
|
1740 | |||
1731 | -c: use time.clock to measure the time, which is the default on |
|
1741 | -c: use time.clock to measure the time, which is the default on | |
1732 | Windows and measures wall time. On Unix, resource.getrusage is used |
|
1742 | Windows and measures wall time. On Unix, resource.getrusage is used | |
1733 | instead and returns the CPU user time. |
|
1743 | instead and returns the CPU user time. | |
1734 |
|
1744 | |||
1735 | -p<P>: use a precision of <P> digits to display the timing result. |
|
1745 | -p<P>: use a precision of <P> digits to display the timing result. | |
1736 | Default: 3 |
|
1746 | Default: 3 | |
1737 |
|
1747 | |||
1738 |
|
1748 | |||
1739 |
Examples: |
|
1749 | Examples: | |
|
1750 | ||||
1740 | In [1]: %timeit pass |
|
1751 | In [1]: %timeit pass | |
1741 | 10000000 loops, best of 3: 53.3 ns per loop |
|
1752 | 10000000 loops, best of 3: 53.3 ns per loop | |
1742 |
|
1753 | |||
1743 | In [2]: u = None |
|
1754 | In [2]: u = None | |
1744 |
|
1755 | |||
1745 | In [3]: %timeit u is None |
|
1756 | In [3]: %timeit u is None | |
1746 | 10000000 loops, best of 3: 184 ns per loop |
|
1757 | 10000000 loops, best of 3: 184 ns per loop | |
1747 |
|
1758 | |||
1748 | In [4]: %timeit -r 4 u == None |
|
1759 | In [4]: %timeit -r 4 u == None | |
1749 | 1000000 loops, best of 4: 242 ns per loop |
|
1760 | 1000000 loops, best of 4: 242 ns per loop | |
1750 |
|
1761 | |||
1751 | In [5]: import time |
|
1762 | In [5]: import time | |
1752 |
|
1763 | |||
1753 | In [6]: %timeit -n1 time.sleep(2) |
|
1764 | In [6]: %timeit -n1 time.sleep(2) | |
1754 | 1 loops, best of 3: 2 s per loop |
|
1765 | 1 loops, best of 3: 2 s per loop | |
1755 |
|
1766 | |||
1756 |
|
1767 | |||
1757 | The times reported by %timeit will be slightly higher than those |
|
1768 | The times reported by %timeit will be slightly higher than those | |
1758 | reported by the timeit.py script when variables are accessed. This is |
|
1769 | reported by the timeit.py script when variables are accessed. This is | |
1759 | due to the fact that %timeit executes the statement in the namespace |
|
1770 | due to the fact that %timeit executes the statement in the namespace | |
1760 | of the shell, compared with timeit.py, which uses a single setup |
|
1771 | of the shell, compared with timeit.py, which uses a single setup | |
1761 | statement to import function or create variables. Generally, the bias |
|
1772 | statement to import function or create variables. Generally, the bias | |
1762 | does not matter as long as results from timeit.py are not mixed with |
|
1773 | does not matter as long as results from timeit.py are not mixed with | |
1763 | those from %timeit.""" |
|
1774 | those from %timeit.""" | |
1764 |
|
1775 | |||
1765 | import timeit |
|
1776 | import timeit | |
1766 | import math |
|
1777 | import math | |
1767 |
|
1778 | |||
1768 | units = [u"s", u"ms", u"\xb5s", u"ns"] |
|
1779 | units = [u"s", u"ms", u"\xb5s", u"ns"] | |
1769 | scaling = [1, 1e3, 1e6, 1e9] |
|
1780 | scaling = [1, 1e3, 1e6, 1e9] | |
1770 |
|
1781 | |||
1771 | opts, stmt = self.parse_options(parameter_s,'n:r:tcp:', |
|
1782 | opts, stmt = self.parse_options(parameter_s,'n:r:tcp:', | |
1772 | posix=False) |
|
1783 | posix=False) | |
1773 | if stmt == "": |
|
1784 | if stmt == "": | |
1774 | return |
|
1785 | return | |
1775 | timefunc = timeit.default_timer |
|
1786 | timefunc = timeit.default_timer | |
1776 | number = int(getattr(opts, "n", 0)) |
|
1787 | number = int(getattr(opts, "n", 0)) | |
1777 | repeat = int(getattr(opts, "r", timeit.default_repeat)) |
|
1788 | repeat = int(getattr(opts, "r", timeit.default_repeat)) | |
1778 | precision = int(getattr(opts, "p", 3)) |
|
1789 | precision = int(getattr(opts, "p", 3)) | |
1779 | if hasattr(opts, "t"): |
|
1790 | if hasattr(opts, "t"): | |
1780 | timefunc = time.time |
|
1791 | timefunc = time.time | |
1781 | if hasattr(opts, "c"): |
|
1792 | if hasattr(opts, "c"): | |
1782 | timefunc = clock |
|
1793 | timefunc = clock | |
1783 |
|
1794 | |||
1784 | timer = timeit.Timer(timer=timefunc) |
|
1795 | timer = timeit.Timer(timer=timefunc) | |
1785 | # this code has tight coupling to the inner workings of timeit.Timer, |
|
1796 | # this code has tight coupling to the inner workings of timeit.Timer, | |
1786 | # but is there a better way to achieve that the code stmt has access |
|
1797 | # but is there a better way to achieve that the code stmt has access | |
1787 | # to the shell namespace? |
|
1798 | # to the shell namespace? | |
1788 |
|
1799 | |||
1789 | src = timeit.template % {'stmt': timeit.reindent(stmt, 8), |
|
1800 | src = timeit.template % {'stmt': timeit.reindent(stmt, 8), | |
1790 | 'setup': "pass"} |
|
1801 | 'setup': "pass"} | |
1791 | # Track compilation time so it can be reported if too long |
|
1802 | # Track compilation time so it can be reported if too long | |
1792 | # Minimum time above which compilation time will be reported |
|
1803 | # Minimum time above which compilation time will be reported | |
1793 | tc_min = 0.1 |
|
1804 | tc_min = 0.1 | |
1794 |
|
1805 | |||
1795 | t0 = clock() |
|
1806 | t0 = clock() | |
1796 | code = compile(src, "<magic-timeit>", "exec") |
|
1807 | code = compile(src, "<magic-timeit>", "exec") | |
1797 | tc = clock()-t0 |
|
1808 | tc = clock()-t0 | |
1798 |
|
1809 | |||
1799 | ns = {} |
|
1810 | ns = {} | |
1800 | exec code in self.shell.user_ns, ns |
|
1811 | exec code in self.shell.user_ns, ns | |
1801 | timer.inner = ns["inner"] |
|
1812 | timer.inner = ns["inner"] | |
1802 |
|
1813 | |||
1803 | if number == 0: |
|
1814 | if number == 0: | |
1804 | # determine number so that 0.2 <= total time < 2.0 |
|
1815 | # determine number so that 0.2 <= total time < 2.0 | |
1805 | number = 1 |
|
1816 | number = 1 | |
1806 | for i in range(1, 10): |
|
1817 | for i in range(1, 10): | |
1807 | number *= 10 |
|
1818 | number *= 10 | |
1808 | if timer.timeit(number) >= 0.2: |
|
1819 | if timer.timeit(number) >= 0.2: | |
1809 | break |
|
1820 | break | |
1810 |
|
1821 | |||
1811 | best = min(timer.repeat(repeat, number)) / number |
|
1822 | best = min(timer.repeat(repeat, number)) / number | |
1812 |
|
1823 | |||
1813 | if best > 0.0: |
|
1824 | if best > 0.0: | |
1814 | order = min(-int(math.floor(math.log10(best)) // 3), 3) |
|
1825 | order = min(-int(math.floor(math.log10(best)) // 3), 3) | |
1815 | else: |
|
1826 | else: | |
1816 | order = 3 |
|
1827 | order = 3 | |
1817 | print u"%d loops, best of %d: %.*g %s per loop" % (number, repeat, |
|
1828 | print u"%d loops, best of %d: %.*g %s per loop" % (number, repeat, | |
1818 | precision, |
|
1829 | precision, | |
1819 | best * scaling[order], |
|
1830 | best * scaling[order], | |
1820 | units[order]) |
|
1831 | units[order]) | |
1821 | if tc > tc_min: |
|
1832 | if tc > tc_min: | |
1822 | print "Compiler time: %.2f s" % tc |
|
1833 | print "Compiler time: %.2f s" % tc | |
1823 |
|
1834 | |||
|
1835 | @testdec.skip_doctest | |||
1824 | def magic_time(self,parameter_s = ''): |
|
1836 | def magic_time(self,parameter_s = ''): | |
1825 | """Time execution of a Python statement or expression. |
|
1837 | """Time execution of a Python statement or expression. | |
1826 |
|
1838 | |||
1827 | The CPU and wall clock times are printed, and the value of the |
|
1839 | The CPU and wall clock times are printed, and the value of the | |
1828 | expression (if any) is returned. Note that under Win32, system time |
|
1840 | expression (if any) is returned. Note that under Win32, system time | |
1829 | is always reported as 0, since it can not be measured. |
|
1841 | is always reported as 0, since it can not be measured. | |
1830 |
|
1842 | |||
1831 | This function provides very basic timing functionality. In Python |
|
1843 | This function provides very basic timing functionality. In Python | |
1832 | 2.3, the timeit module offers more control and sophistication, so this |
|
1844 | 2.3, the timeit module offers more control and sophistication, so this | |
1833 | could be rewritten to use it (patches welcome). |
|
1845 | could be rewritten to use it (patches welcome). | |
1834 |
|
1846 | |||
1835 | Some examples: |
|
1847 | Some examples: | |
1836 |
|
1848 | |||
1837 | In [1]: time 2**128 |
|
1849 | In [1]: time 2**128 | |
1838 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1850 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s | |
1839 | Wall time: 0.00 |
|
1851 | Wall time: 0.00 | |
1840 | Out[1]: 340282366920938463463374607431768211456L |
|
1852 | Out[1]: 340282366920938463463374607431768211456L | |
1841 |
|
1853 | |||
1842 | In [2]: n = 1000000 |
|
1854 | In [2]: n = 1000000 | |
1843 |
|
1855 | |||
1844 | In [3]: time sum(range(n)) |
|
1856 | In [3]: time sum(range(n)) | |
1845 | CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s |
|
1857 | CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s | |
1846 | Wall time: 1.37 |
|
1858 | Wall time: 1.37 | |
1847 | Out[3]: 499999500000L |
|
1859 | Out[3]: 499999500000L | |
1848 |
|
1860 | |||
1849 | In [4]: time print 'hello world' |
|
1861 | In [4]: time print 'hello world' | |
1850 | hello world |
|
1862 | hello world | |
1851 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1863 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s | |
1852 | Wall time: 0.00 |
|
1864 | Wall time: 0.00 | |
1853 |
|
1865 | |||
1854 | Note that the time needed by Python to compile the given expression |
|
1866 | Note that the time needed by Python to compile the given expression | |
1855 | will be reported if it is more than 0.1s. In this example, the |
|
1867 | will be reported if it is more than 0.1s. In this example, the | |
1856 | actual exponentiation is done by Python at compilation time, so while |
|
1868 | actual exponentiation is done by Python at compilation time, so while | |
1857 | the expression can take a noticeable amount of time to compute, that |
|
1869 | the expression can take a noticeable amount of time to compute, that | |
1858 | time is purely due to the compilation: |
|
1870 | time is purely due to the compilation: | |
1859 |
|
1871 | |||
1860 | In [5]: time 3**9999; |
|
1872 | In [5]: time 3**9999; | |
1861 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1873 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s | |
1862 | Wall time: 0.00 s |
|
1874 | Wall time: 0.00 s | |
1863 |
|
1875 | |||
1864 | In [6]: time 3**999999; |
|
1876 | In [6]: time 3**999999; | |
1865 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1877 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s | |
1866 | Wall time: 0.00 s |
|
1878 | Wall time: 0.00 s | |
1867 | Compiler : 0.78 s |
|
1879 | Compiler : 0.78 s | |
1868 | """ |
|
1880 | """ | |
1869 |
|
1881 | |||
1870 | # fail immediately if the given expression can't be compiled |
|
1882 | # fail immediately if the given expression can't be compiled | |
1871 |
|
1883 | |||
1872 | expr = self.shell.prefilter(parameter_s,False) |
|
1884 | expr = self.shell.prefilter(parameter_s,False) | |
1873 |
|
1885 | |||
1874 | # Minimum time above which compilation time will be reported |
|
1886 | # Minimum time above which compilation time will be reported | |
1875 | tc_min = 0.1 |
|
1887 | tc_min = 0.1 | |
1876 |
|
1888 | |||
1877 | try: |
|
1889 | try: | |
1878 | mode = 'eval' |
|
1890 | mode = 'eval' | |
1879 | t0 = clock() |
|
1891 | t0 = clock() | |
1880 | code = compile(expr,'<timed eval>',mode) |
|
1892 | code = compile(expr,'<timed eval>',mode) | |
1881 | tc = clock()-t0 |
|
1893 | tc = clock()-t0 | |
1882 | except SyntaxError: |
|
1894 | except SyntaxError: | |
1883 | mode = 'exec' |
|
1895 | mode = 'exec' | |
1884 | t0 = clock() |
|
1896 | t0 = clock() | |
1885 | code = compile(expr,'<timed exec>',mode) |
|
1897 | code = compile(expr,'<timed exec>',mode) | |
1886 | tc = clock()-t0 |
|
1898 | tc = clock()-t0 | |
1887 | # skew measurement as little as possible |
|
1899 | # skew measurement as little as possible | |
1888 | glob = self.shell.user_ns |
|
1900 | glob = self.shell.user_ns | |
1889 | clk = clock2 |
|
1901 | clk = clock2 | |
1890 | wtime = time.time |
|
1902 | wtime = time.time | |
1891 | # time execution |
|
1903 | # time execution | |
1892 | wall_st = wtime() |
|
1904 | wall_st = wtime() | |
1893 | if mode=='eval': |
|
1905 | if mode=='eval': | |
1894 | st = clk() |
|
1906 | st = clk() | |
1895 | out = eval(code,glob) |
|
1907 | out = eval(code,glob) | |
1896 | end = clk() |
|
1908 | end = clk() | |
1897 | else: |
|
1909 | else: | |
1898 | st = clk() |
|
1910 | st = clk() | |
1899 | exec code in glob |
|
1911 | exec code in glob | |
1900 | end = clk() |
|
1912 | end = clk() | |
1901 | out = None |
|
1913 | out = None | |
1902 | wall_end = wtime() |
|
1914 | wall_end = wtime() | |
1903 | # Compute actual times and report |
|
1915 | # Compute actual times and report | |
1904 | wall_time = wall_end-wall_st |
|
1916 | wall_time = wall_end-wall_st | |
1905 | cpu_user = end[0]-st[0] |
|
1917 | cpu_user = end[0]-st[0] | |
1906 | cpu_sys = end[1]-st[1] |
|
1918 | cpu_sys = end[1]-st[1] | |
1907 | cpu_tot = cpu_user+cpu_sys |
|
1919 | cpu_tot = cpu_user+cpu_sys | |
1908 | print "CPU times: user %.2f s, sys: %.2f s, total: %.2f s" % \ |
|
1920 | print "CPU times: user %.2f s, sys: %.2f s, total: %.2f s" % \ | |
1909 | (cpu_user,cpu_sys,cpu_tot) |
|
1921 | (cpu_user,cpu_sys,cpu_tot) | |
1910 | print "Wall time: %.2f s" % wall_time |
|
1922 | print "Wall time: %.2f s" % wall_time | |
1911 | if tc > tc_min: |
|
1923 | if tc > tc_min: | |
1912 | print "Compiler : %.2f s" % tc |
|
1924 | print "Compiler : %.2f s" % tc | |
1913 | return out |
|
1925 | return out | |
1914 |
|
1926 | |||
|
1927 | @testdec.skip_doctest | |||
1915 | def magic_macro(self,parameter_s = ''): |
|
1928 | def magic_macro(self,parameter_s = ''): | |
1916 | """Define a set of input lines as a macro for future re-execution. |
|
1929 | """Define a set of input lines as a macro for future re-execution. | |
1917 |
|
1930 | |||
1918 | Usage:\\ |
|
1931 | Usage:\\ | |
1919 | %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ... |
|
1932 | %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ... | |
1920 |
|
1933 | |||
1921 | Options: |
|
1934 | Options: | |
1922 |
|
1935 | |||
1923 | -r: use 'raw' input. By default, the 'processed' history is used, |
|
1936 | -r: use 'raw' input. By default, the 'processed' history is used, | |
1924 | so that magics are loaded in their transformed version to valid |
|
1937 | so that magics are loaded in their transformed version to valid | |
1925 | Python. If this option is given, the raw input as typed as the |
|
1938 | Python. If this option is given, the raw input as typed as the | |
1926 | command line is used instead. |
|
1939 | command line is used instead. | |
1927 |
|
1940 | |||
1928 | This will define a global variable called `name` which is a string |
|
1941 | This will define a global variable called `name` which is a string | |
1929 | made of joining the slices and lines you specify (n1,n2,... numbers |
|
1942 | made of joining the slices and lines you specify (n1,n2,... numbers | |
1930 | above) from your input history into a single string. This variable |
|
1943 | above) from your input history into a single string. This variable | |
1931 | acts like an automatic function which re-executes those lines as if |
|
1944 | acts like an automatic function which re-executes those lines as if | |
1932 | you had typed them. You just type 'name' at the prompt and the code |
|
1945 | you had typed them. You just type 'name' at the prompt and the code | |
1933 | executes. |
|
1946 | executes. | |
1934 |
|
1947 | |||
1935 | The notation for indicating number ranges is: n1-n2 means 'use line |
|
1948 | The notation for indicating number ranges is: n1-n2 means 'use line | |
1936 | numbers n1,...n2' (the endpoint is included). That is, '5-7' means |
|
1949 | numbers n1,...n2' (the endpoint is included). That is, '5-7' means | |
1937 | using the lines numbered 5,6 and 7. |
|
1950 | using the lines numbered 5,6 and 7. | |
1938 |
|
1951 | |||
1939 | Note: as a 'hidden' feature, you can also use traditional python slice |
|
1952 | Note: as a 'hidden' feature, you can also use traditional python slice | |
1940 | notation, where N:M means numbers N through M-1. |
|
1953 | notation, where N:M means numbers N through M-1. | |
1941 |
|
1954 | |||
1942 | For example, if your history contains (%hist prints it): |
|
1955 | For example, if your history contains (%hist prints it): | |
1943 |
|
1956 | |||
1944 |
44: x=1 |
|
1957 | 44: x=1 | |
1945 |
45: y=3 |
|
1958 | 45: y=3 | |
1946 |
46: z=x+y |
|
1959 | 46: z=x+y | |
1947 |
47: print x |
|
1960 | 47: print x | |
1948 |
48: a=5 |
|
1961 | 48: a=5 | |
1949 |
49: print 'x',x,'y',y |
|
1962 | 49: print 'x',x,'y',y | |
1950 |
|
1963 | |||
1951 | you can create a macro with lines 44 through 47 (included) and line 49 |
|
1964 | you can create a macro with lines 44 through 47 (included) and line 49 | |
1952 | called my_macro with: |
|
1965 | called my_macro with: | |
1953 |
|
1966 | |||
1954 | In []: %macro my_macro 44-47 49 |
|
1967 | In [55]: %macro my_macro 44-47 49 | |
1955 |
|
1968 | |||
1956 | Now, typing `my_macro` (without quotes) will re-execute all this code |
|
1969 | Now, typing `my_macro` (without quotes) will re-execute all this code | |
1957 | in one pass. |
|
1970 | in one pass. | |
1958 |
|
1971 | |||
1959 | You don't need to give the line-numbers in order, and any given line |
|
1972 | You don't need to give the line-numbers in order, and any given line | |
1960 | number can appear multiple times. You can assemble macros with any |
|
1973 | number can appear multiple times. You can assemble macros with any | |
1961 | lines from your input history in any order. |
|
1974 | lines from your input history in any order. | |
1962 |
|
1975 | |||
1963 | The macro is a simple object which holds its value in an attribute, |
|
1976 | The macro is a simple object which holds its value in an attribute, | |
1964 | but IPython's display system checks for macros and executes them as |
|
1977 | but IPython's display system checks for macros and executes them as | |
1965 | code instead of printing them when you type their name. |
|
1978 | code instead of printing them when you type their name. | |
1966 |
|
1979 | |||
1967 | You can view a macro's contents by explicitly printing it with: |
|
1980 | You can view a macro's contents by explicitly printing it with: | |
1968 |
|
1981 | |||
1969 | 'print macro_name'. |
|
1982 | 'print macro_name'. | |
1970 |
|
1983 | |||
1971 | For one-off cases which DON'T contain magic function calls in them you |
|
1984 | For one-off cases which DON'T contain magic function calls in them you | |
1972 | can obtain similar results by explicitly executing slices from your |
|
1985 | can obtain similar results by explicitly executing slices from your | |
1973 | input history with: |
|
1986 | input history with: | |
1974 |
|
1987 | |||
1975 | In []: exec In[44:48]+In[49]""" |
|
1988 | In [60]: exec In[44:48]+In[49]""" | |
1976 |
|
1989 | |||
1977 | opts,args = self.parse_options(parameter_s,'r',mode='list') |
|
1990 | opts,args = self.parse_options(parameter_s,'r',mode='list') | |
1978 | if not args: |
|
1991 | if not args: | |
1979 | macs = [k for k,v in self.shell.user_ns.items() if isinstance(v, Macro)] |
|
1992 | macs = [k for k,v in self.shell.user_ns.items() if isinstance(v, Macro)] | |
1980 | macs.sort() |
|
1993 | macs.sort() | |
1981 | return macs |
|
1994 | return macs | |
1982 | if len(args) == 1: |
|
1995 | if len(args) == 1: | |
1983 | raise UsageError( |
|
1996 | raise UsageError( | |
1984 | "%macro insufficient args; usage '%macro name n1-n2 n3-4...") |
|
1997 | "%macro insufficient args; usage '%macro name n1-n2 n3-4...") | |
1985 | name,ranges = args[0], args[1:] |
|
1998 | name,ranges = args[0], args[1:] | |
1986 |
|
1999 | |||
1987 | #print 'rng',ranges # dbg |
|
2000 | #print 'rng',ranges # dbg | |
1988 | lines = self.extract_input_slices(ranges,opts.has_key('r')) |
|
2001 | lines = self.extract_input_slices(ranges,opts.has_key('r')) | |
1989 | macro = Macro(lines) |
|
2002 | macro = Macro(lines) | |
1990 | self.shell.user_ns.update({name:macro}) |
|
2003 | self.shell.user_ns.update({name:macro}) | |
1991 | print 'Macro `%s` created. To execute, type its name (without quotes).' % name |
|
2004 | print 'Macro `%s` created. To execute, type its name (without quotes).' % name | |
1992 | print 'Macro contents:' |
|
2005 | print 'Macro contents:' | |
1993 | print macro, |
|
2006 | print macro, | |
1994 |
|
2007 | |||
1995 | def magic_save(self,parameter_s = ''): |
|
2008 | def magic_save(self,parameter_s = ''): | |
1996 | """Save a set of lines to a given filename. |
|
2009 | """Save a set of lines to a given filename. | |
1997 |
|
2010 | |||
1998 | Usage:\\ |
|
2011 | Usage:\\ | |
1999 | %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ... |
|
2012 | %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ... | |
2000 |
|
2013 | |||
2001 | Options: |
|
2014 | Options: | |
2002 |
|
2015 | |||
2003 | -r: use 'raw' input. By default, the 'processed' history is used, |
|
2016 | -r: use 'raw' input. By default, the 'processed' history is used, | |
2004 | so that magics are loaded in their transformed version to valid |
|
2017 | so that magics are loaded in their transformed version to valid | |
2005 | Python. If this option is given, the raw input as typed as the |
|
2018 | Python. If this option is given, the raw input as typed as the | |
2006 | command line is used instead. |
|
2019 | command line is used instead. | |
2007 |
|
2020 | |||
2008 | This function uses the same syntax as %macro for line extraction, but |
|
2021 | This function uses the same syntax as %macro for line extraction, but | |
2009 | instead of creating a macro it saves the resulting string to the |
|
2022 | instead of creating a macro it saves the resulting string to the | |
2010 | filename you specify. |
|
2023 | filename you specify. | |
2011 |
|
2024 | |||
2012 | It adds a '.py' extension to the file if you don't do so yourself, and |
|
2025 | It adds a '.py' extension to the file if you don't do so yourself, and | |
2013 | it asks for confirmation before overwriting existing files.""" |
|
2026 | it asks for confirmation before overwriting existing files.""" | |
2014 |
|
2027 | |||
2015 | opts,args = self.parse_options(parameter_s,'r',mode='list') |
|
2028 | opts,args = self.parse_options(parameter_s,'r',mode='list') | |
2016 | fname,ranges = args[0], args[1:] |
|
2029 | fname,ranges = args[0], args[1:] | |
2017 | if not fname.endswith('.py'): |
|
2030 | if not fname.endswith('.py'): | |
2018 | fname += '.py' |
|
2031 | fname += '.py' | |
2019 | if os.path.isfile(fname): |
|
2032 | if os.path.isfile(fname): | |
2020 | ans = raw_input('File `%s` exists. Overwrite (y/[N])? ' % fname) |
|
2033 | ans = raw_input('File `%s` exists. Overwrite (y/[N])? ' % fname) | |
2021 | if ans.lower() not in ['y','yes']: |
|
2034 | if ans.lower() not in ['y','yes']: | |
2022 | print 'Operation cancelled.' |
|
2035 | print 'Operation cancelled.' | |
2023 | return |
|
2036 | return | |
2024 | cmds = ''.join(self.extract_input_slices(ranges,opts.has_key('r'))) |
|
2037 | cmds = ''.join(self.extract_input_slices(ranges,opts.has_key('r'))) | |
2025 | f = file(fname,'w') |
|
2038 | f = file(fname,'w') | |
2026 | f.write(cmds) |
|
2039 | f.write(cmds) | |
2027 | f.close() |
|
2040 | f.close() | |
2028 | print 'The following commands were written to file `%s`:' % fname |
|
2041 | print 'The following commands were written to file `%s`:' % fname | |
2029 | print cmds |
|
2042 | print cmds | |
2030 |
|
2043 | |||
2031 | def _edit_macro(self,mname,macro): |
|
2044 | def _edit_macro(self,mname,macro): | |
2032 | """open an editor with the macro data in a file""" |
|
2045 | """open an editor with the macro data in a file""" | |
2033 | filename = self.shell.mktempfile(macro.value) |
|
2046 | filename = self.shell.mktempfile(macro.value) | |
2034 | self.shell.hooks.editor(filename) |
|
2047 | self.shell.hooks.editor(filename) | |
2035 |
|
2048 | |||
2036 | # and make a new macro object, to replace the old one |
|
2049 | # and make a new macro object, to replace the old one | |
2037 | mfile = open(filename) |
|
2050 | mfile = open(filename) | |
2038 | mvalue = mfile.read() |
|
2051 | mvalue = mfile.read() | |
2039 | mfile.close() |
|
2052 | mfile.close() | |
2040 | self.shell.user_ns[mname] = Macro(mvalue) |
|
2053 | self.shell.user_ns[mname] = Macro(mvalue) | |
2041 |
|
2054 | |||
2042 | def magic_ed(self,parameter_s=''): |
|
2055 | def magic_ed(self,parameter_s=''): | |
2043 | """Alias to %edit.""" |
|
2056 | """Alias to %edit.""" | |
2044 | return self.magic_edit(parameter_s) |
|
2057 | return self.magic_edit(parameter_s) | |
2045 |
|
2058 | |||
|
2059 | @testdec.skip_doctest | |||
2046 | def magic_edit(self,parameter_s='',last_call=['','']): |
|
2060 | def magic_edit(self,parameter_s='',last_call=['','']): | |
2047 | """Bring up an editor and execute the resulting code. |
|
2061 | """Bring up an editor and execute the resulting code. | |
2048 |
|
2062 | |||
2049 | Usage: |
|
2063 | Usage: | |
2050 | %edit [options] [args] |
|
2064 | %edit [options] [args] | |
2051 |
|
2065 | |||
2052 | %edit runs IPython's editor hook. The default version of this hook is |
|
2066 | %edit runs IPython's editor hook. The default version of this hook is | |
2053 | set to call the __IPYTHON__.rc.editor command. This is read from your |
|
2067 | set to call the __IPYTHON__.rc.editor command. This is read from your | |
2054 | environment variable $EDITOR. If this isn't found, it will default to |
|
2068 | environment variable $EDITOR. If this isn't found, it will default to | |
2055 | vi under Linux/Unix and to notepad under Windows. See the end of this |
|
2069 | vi under Linux/Unix and to notepad under Windows. See the end of this | |
2056 | docstring for how to change the editor hook. |
|
2070 | docstring for how to change the editor hook. | |
2057 |
|
2071 | |||
2058 | You can also set the value of this editor via the command line option |
|
2072 | You can also set the value of this editor via the command line option | |
2059 | '-editor' or in your ipythonrc file. This is useful if you wish to use |
|
2073 | '-editor' or in your ipythonrc file. This is useful if you wish to use | |
2060 | specifically for IPython an editor different from your typical default |
|
2074 | specifically for IPython an editor different from your typical default | |
2061 | (and for Windows users who typically don't set environment variables). |
|
2075 | (and for Windows users who typically don't set environment variables). | |
2062 |
|
2076 | |||
2063 | This command allows you to conveniently edit multi-line code right in |
|
2077 | This command allows you to conveniently edit multi-line code right in | |
2064 | your IPython session. |
|
2078 | your IPython session. | |
2065 |
|
2079 | |||
2066 | If called without arguments, %edit opens up an empty editor with a |
|
2080 | If called without arguments, %edit opens up an empty editor with a | |
2067 | temporary file and will execute the contents of this file when you |
|
2081 | temporary file and will execute the contents of this file when you | |
2068 | close it (don't forget to save it!). |
|
2082 | close it (don't forget to save it!). | |
2069 |
|
2083 | |||
2070 |
|
2084 | |||
2071 | Options: |
|
2085 | Options: | |
2072 |
|
2086 | |||
2073 | -n <number>: open the editor at a specified line number. By default, |
|
2087 | -n <number>: open the editor at a specified line number. By default, | |
2074 | the IPython editor hook uses the unix syntax 'editor +N filename', but |
|
2088 | the IPython editor hook uses the unix syntax 'editor +N filename', but | |
2075 | you can configure this by providing your own modified hook if your |
|
2089 | you can configure this by providing your own modified hook if your | |
2076 | favorite editor supports line-number specifications with a different |
|
2090 | favorite editor supports line-number specifications with a different | |
2077 | syntax. |
|
2091 | syntax. | |
2078 |
|
2092 | |||
2079 | -p: this will call the editor with the same data as the previous time |
|
2093 | -p: this will call the editor with the same data as the previous time | |
2080 | it was used, regardless of how long ago (in your current session) it |
|
2094 | it was used, regardless of how long ago (in your current session) it | |
2081 | was. |
|
2095 | was. | |
2082 |
|
2096 | |||
2083 | -r: use 'raw' input. This option only applies to input taken from the |
|
2097 | -r: use 'raw' input. This option only applies to input taken from the | |
2084 | user's history. By default, the 'processed' history is used, so that |
|
2098 | user's history. By default, the 'processed' history is used, so that | |
2085 | magics are loaded in their transformed version to valid Python. If |
|
2099 | magics are loaded in their transformed version to valid Python. If | |
2086 | this option is given, the raw input as typed as the command line is |
|
2100 | this option is given, the raw input as typed as the command line is | |
2087 | used instead. When you exit the editor, it will be executed by |
|
2101 | used instead. When you exit the editor, it will be executed by | |
2088 | IPython's own processor. |
|
2102 | IPython's own processor. | |
2089 |
|
2103 | |||
2090 | -x: do not execute the edited code immediately upon exit. This is |
|
2104 | -x: do not execute the edited code immediately upon exit. This is | |
2091 | mainly useful if you are editing programs which need to be called with |
|
2105 | mainly useful if you are editing programs which need to be called with | |
2092 | command line arguments, which you can then do using %run. |
|
2106 | command line arguments, which you can then do using %run. | |
2093 |
|
2107 | |||
2094 |
|
2108 | |||
2095 | Arguments: |
|
2109 | Arguments: | |
2096 |
|
2110 | |||
2097 | If arguments are given, the following possibilites exist: |
|
2111 | If arguments are given, the following possibilites exist: | |
2098 |
|
2112 | |||
2099 | - The arguments are numbers or pairs of colon-separated numbers (like |
|
2113 | - The arguments are numbers or pairs of colon-separated numbers (like | |
2100 | 1 4:8 9). These are interpreted as lines of previous input to be |
|
2114 | 1 4:8 9). These are interpreted as lines of previous input to be | |
2101 | loaded into the editor. The syntax is the same of the %macro command. |
|
2115 | loaded into the editor. The syntax is the same of the %macro command. | |
2102 |
|
2116 | |||
2103 | - If the argument doesn't start with a number, it is evaluated as a |
|
2117 | - If the argument doesn't start with a number, it is evaluated as a | |
2104 | variable and its contents loaded into the editor. You can thus edit |
|
2118 | variable and its contents loaded into the editor. You can thus edit | |
2105 | any string which contains python code (including the result of |
|
2119 | any string which contains python code (including the result of | |
2106 | previous edits). |
|
2120 | previous edits). | |
2107 |
|
2121 | |||
2108 | - If the argument is the name of an object (other than a string), |
|
2122 | - If the argument is the name of an object (other than a string), | |
2109 | IPython will try to locate the file where it was defined and open the |
|
2123 | IPython will try to locate the file where it was defined and open the | |
2110 | editor at the point where it is defined. You can use `%edit function` |
|
2124 | editor at the point where it is defined. You can use `%edit function` | |
2111 | to load an editor exactly at the point where 'function' is defined, |
|
2125 | to load an editor exactly at the point where 'function' is defined, | |
2112 | edit it and have the file be executed automatically. |
|
2126 | edit it and have the file be executed automatically. | |
2113 |
|
2127 | |||
2114 | If the object is a macro (see %macro for details), this opens up your |
|
2128 | If the object is a macro (see %macro for details), this opens up your | |
2115 | specified editor with a temporary file containing the macro's data. |
|
2129 | specified editor with a temporary file containing the macro's data. | |
2116 | Upon exit, the macro is reloaded with the contents of the file. |
|
2130 | Upon exit, the macro is reloaded with the contents of the file. | |
2117 |
|
2131 | |||
2118 | Note: opening at an exact line is only supported under Unix, and some |
|
2132 | Note: opening at an exact line is only supported under Unix, and some | |
2119 | editors (like kedit and gedit up to Gnome 2.8) do not understand the |
|
2133 | editors (like kedit and gedit up to Gnome 2.8) do not understand the | |
2120 | '+NUMBER' parameter necessary for this feature. Good editors like |
|
2134 | '+NUMBER' parameter necessary for this feature. Good editors like | |
2121 | (X)Emacs, vi, jed, pico and joe all do. |
|
2135 | (X)Emacs, vi, jed, pico and joe all do. | |
2122 |
|
2136 | |||
2123 | - If the argument is not found as a variable, IPython will look for a |
|
2137 | - If the argument is not found as a variable, IPython will look for a | |
2124 | file with that name (adding .py if necessary) and load it into the |
|
2138 | file with that name (adding .py if necessary) and load it into the | |
2125 | editor. It will execute its contents with execfile() when you exit, |
|
2139 | editor. It will execute its contents with execfile() when you exit, | |
2126 | loading any code in the file into your interactive namespace. |
|
2140 | loading any code in the file into your interactive namespace. | |
2127 |
|
2141 | |||
2128 | After executing your code, %edit will return as output the code you |
|
2142 | After executing your code, %edit will return as output the code you | |
2129 | typed in the editor (except when it was an existing file). This way |
|
2143 | typed in the editor (except when it was an existing file). This way | |
2130 | you can reload the code in further invocations of %edit as a variable, |
|
2144 | you can reload the code in further invocations of %edit as a variable, | |
2131 | via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of |
|
2145 | via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of | |
2132 | the output. |
|
2146 | the output. | |
2133 |
|
2147 | |||
2134 | Note that %edit is also available through the alias %ed. |
|
2148 | Note that %edit is also available through the alias %ed. | |
2135 |
|
2149 | |||
2136 | This is an example of creating a simple function inside the editor and |
|
2150 | This is an example of creating a simple function inside the editor and | |
2137 | then modifying it. First, start up the editor: |
|
2151 | then modifying it. First, start up the editor: | |
2138 |
|
2152 | |||
2139 |
In []: ed |
|
2153 | In [1]: ed | |
2140 |
Editing... done. Executing edited code... |
|
2154 | Editing... done. Executing edited code... | |
2141 |
Out[]: 'def foo(): |
|
2155 | Out[1]: 'def foo():n print "foo() was defined in an editing session"n' | |
2142 |
|
2156 | |||
2143 | We can then call the function foo(): |
|
2157 | We can then call the function foo(): | |
2144 |
|
2158 | |||
2145 |
In []: foo() |
|
2159 | In [2]: foo() | |
2146 | foo() was defined in an editing session |
|
2160 | foo() was defined in an editing session | |
2147 |
|
2161 | |||
2148 | Now we edit foo. IPython automatically loads the editor with the |
|
2162 | Now we edit foo. IPython automatically loads the editor with the | |
2149 | (temporary) file where foo() was previously defined: |
|
2163 | (temporary) file where foo() was previously defined: | |
2150 |
|
2164 | |||
2151 |
In []: ed foo |
|
2165 | In [3]: ed foo | |
2152 | Editing... done. Executing edited code... |
|
2166 | Editing... done. Executing edited code... | |
2153 |
|
2167 | |||
2154 | And if we call foo() again we get the modified version: |
|
2168 | And if we call foo() again we get the modified version: | |
2155 |
|
2169 | |||
2156 |
In []: foo() |
|
2170 | In [4]: foo() | |
2157 | foo() has now been changed! |
|
2171 | foo() has now been changed! | |
2158 |
|
2172 | |||
2159 | Here is an example of how to edit a code snippet successive |
|
2173 | Here is an example of how to edit a code snippet successive | |
2160 | times. First we call the editor: |
|
2174 | times. First we call the editor: | |
2161 |
|
2175 | |||
2162 |
In []: ed |
|
2176 | In [5]: ed | |
2163 |
Editing... done. Executing edited code... |
|
2177 | Editing... done. Executing edited code... | |
2164 |
hello |
|
2178 | hello | |
2165 |
Out[]: "print 'hello' |
|
2179 | Out[5]: "print 'hello'n" | |
2166 |
|
2180 | |||
2167 | Now we call it again with the previous output (stored in _): |
|
2181 | Now we call it again with the previous output (stored in _): | |
2168 |
|
2182 | |||
2169 |
In []: ed _ |
|
2183 | In [6]: ed _ | |
2170 |
Editing... done. Executing edited code... |
|
2184 | Editing... done. Executing edited code... | |
2171 |
hello world |
|
2185 | hello world | |
2172 |
Out[]: "print 'hello world' |
|
2186 | Out[6]: "print 'hello world'n" | |
2173 |
|
2187 | |||
2174 | Now we call it with the output #8 (stored in _8, also as Out[8]): |
|
2188 | Now we call it with the output #8 (stored in _8, also as Out[8]): | |
2175 |
|
2189 | |||
2176 |
In []: ed _8 |
|
2190 | In [7]: ed _8 | |
2177 |
Editing... done. Executing edited code... |
|
2191 | Editing... done. Executing edited code... | |
2178 |
hello again |
|
2192 | hello again | |
2179 |
Out[]: "print 'hello again' |
|
2193 | Out[7]: "print 'hello again'n" | |
2180 |
|
2194 | |||
2181 |
|
2195 | |||
2182 | Changing the default editor hook: |
|
2196 | Changing the default editor hook: | |
2183 |
|
2197 | |||
2184 | If you wish to write your own editor hook, you can put it in a |
|
2198 | If you wish to write your own editor hook, you can put it in a | |
2185 | configuration file which you load at startup time. The default hook |
|
2199 | configuration file which you load at startup time. The default hook | |
2186 | is defined in the IPython.hooks module, and you can use that as a |
|
2200 | is defined in the IPython.hooks module, and you can use that as a | |
2187 | starting example for further modifications. That file also has |
|
2201 | starting example for further modifications. That file also has | |
2188 | general instructions on how to set a new hook for use once you've |
|
2202 | general instructions on how to set a new hook for use once you've | |
2189 | defined it.""" |
|
2203 | defined it.""" | |
2190 |
|
2204 | |||
2191 | # FIXME: This function has become a convoluted mess. It needs a |
|
2205 | # FIXME: This function has become a convoluted mess. It needs a | |
2192 | # ground-up rewrite with clean, simple logic. |
|
2206 | # ground-up rewrite with clean, simple logic. | |
2193 |
|
2207 | |||
2194 | def make_filename(arg): |
|
2208 | def make_filename(arg): | |
2195 | "Make a filename from the given args" |
|
2209 | "Make a filename from the given args" | |
2196 | try: |
|
2210 | try: | |
2197 | filename = get_py_filename(arg) |
|
2211 | filename = get_py_filename(arg) | |
2198 | except IOError: |
|
2212 | except IOError: | |
2199 | if args.endswith('.py'): |
|
2213 | if args.endswith('.py'): | |
2200 | filename = arg |
|
2214 | filename = arg | |
2201 | else: |
|
2215 | else: | |
2202 | filename = None |
|
2216 | filename = None | |
2203 | return filename |
|
2217 | return filename | |
2204 |
|
2218 | |||
2205 | # custom exceptions |
|
2219 | # custom exceptions | |
2206 | class DataIsObject(Exception): pass |
|
2220 | class DataIsObject(Exception): pass | |
2207 |
|
2221 | |||
2208 | opts,args = self.parse_options(parameter_s,'prxn:') |
|
2222 | opts,args = self.parse_options(parameter_s,'prxn:') | |
2209 | # Set a few locals from the options for convenience: |
|
2223 | # Set a few locals from the options for convenience: | |
2210 | opts_p = opts.has_key('p') |
|
2224 | opts_p = opts.has_key('p') | |
2211 | opts_r = opts.has_key('r') |
|
2225 | opts_r = opts.has_key('r') | |
2212 |
|
2226 | |||
2213 | # Default line number value |
|
2227 | # Default line number value | |
2214 | lineno = opts.get('n',None) |
|
2228 | lineno = opts.get('n',None) | |
2215 |
|
2229 | |||
2216 | if opts_p: |
|
2230 | if opts_p: | |
2217 | args = '_%s' % last_call[0] |
|
2231 | args = '_%s' % last_call[0] | |
2218 | if not self.shell.user_ns.has_key(args): |
|
2232 | if not self.shell.user_ns.has_key(args): | |
2219 | args = last_call[1] |
|
2233 | args = last_call[1] | |
2220 |
|
2234 | |||
2221 | # use last_call to remember the state of the previous call, but don't |
|
2235 | # use last_call to remember the state of the previous call, but don't | |
2222 | # let it be clobbered by successive '-p' calls. |
|
2236 | # let it be clobbered by successive '-p' calls. | |
2223 | try: |
|
2237 | try: | |
2224 | last_call[0] = self.shell.outputcache.prompt_count |
|
2238 | last_call[0] = self.shell.outputcache.prompt_count | |
2225 | if not opts_p: |
|
2239 | if not opts_p: | |
2226 | last_call[1] = parameter_s |
|
2240 | last_call[1] = parameter_s | |
2227 | except: |
|
2241 | except: | |
2228 | pass |
|
2242 | pass | |
2229 |
|
2243 | |||
2230 | # by default this is done with temp files, except when the given |
|
2244 | # by default this is done with temp files, except when the given | |
2231 | # arg is a filename |
|
2245 | # arg is a filename | |
2232 | use_temp = 1 |
|
2246 | use_temp = 1 | |
2233 |
|
2247 | |||
2234 | if re.match(r'\d',args): |
|
2248 | if re.match(r'\d',args): | |
2235 | # Mode where user specifies ranges of lines, like in %macro. |
|
2249 | # Mode where user specifies ranges of lines, like in %macro. | |
2236 | # This means that you can't edit files whose names begin with |
|
2250 | # This means that you can't edit files whose names begin with | |
2237 | # numbers this way. Tough. |
|
2251 | # numbers this way. Tough. | |
2238 | ranges = args.split() |
|
2252 | ranges = args.split() | |
2239 | data = ''.join(self.extract_input_slices(ranges,opts_r)) |
|
2253 | data = ''.join(self.extract_input_slices(ranges,opts_r)) | |
2240 | elif args.endswith('.py'): |
|
2254 | elif args.endswith('.py'): | |
2241 | filename = make_filename(args) |
|
2255 | filename = make_filename(args) | |
2242 | data = '' |
|
2256 | data = '' | |
2243 | use_temp = 0 |
|
2257 | use_temp = 0 | |
2244 | elif args: |
|
2258 | elif args: | |
2245 | try: |
|
2259 | try: | |
2246 | # Load the parameter given as a variable. If not a string, |
|
2260 | # Load the parameter given as a variable. If not a string, | |
2247 | # process it as an object instead (below) |
|
2261 | # process it as an object instead (below) | |
2248 |
|
2262 | |||
2249 | #print '*** args',args,'type',type(args) # dbg |
|
2263 | #print '*** args',args,'type',type(args) # dbg | |
2250 | data = eval(args,self.shell.user_ns) |
|
2264 | data = eval(args,self.shell.user_ns) | |
2251 | if not type(data) in StringTypes: |
|
2265 | if not type(data) in StringTypes: | |
2252 | raise DataIsObject |
|
2266 | raise DataIsObject | |
2253 |
|
2267 | |||
2254 | except (NameError,SyntaxError): |
|
2268 | except (NameError,SyntaxError): | |
2255 | # given argument is not a variable, try as a filename |
|
2269 | # given argument is not a variable, try as a filename | |
2256 | filename = make_filename(args) |
|
2270 | filename = make_filename(args) | |
2257 | if filename is None: |
|
2271 | if filename is None: | |
2258 | warn("Argument given (%s) can't be found as a variable " |
|
2272 | warn("Argument given (%s) can't be found as a variable " | |
2259 | "or as a filename." % args) |
|
2273 | "or as a filename." % args) | |
2260 | return |
|
2274 | return | |
2261 |
|
2275 | |||
2262 | data = '' |
|
2276 | data = '' | |
2263 | use_temp = 0 |
|
2277 | use_temp = 0 | |
2264 | except DataIsObject: |
|
2278 | except DataIsObject: | |
2265 |
|
2279 | |||
2266 | # macros have a special edit function |
|
2280 | # macros have a special edit function | |
2267 | if isinstance(data,Macro): |
|
2281 | if isinstance(data,Macro): | |
2268 | self._edit_macro(args,data) |
|
2282 | self._edit_macro(args,data) | |
2269 | return |
|
2283 | return | |
2270 |
|
2284 | |||
2271 | # For objects, try to edit the file where they are defined |
|
2285 | # For objects, try to edit the file where they are defined | |
2272 | try: |
|
2286 | try: | |
2273 | filename = inspect.getabsfile(data) |
|
2287 | filename = inspect.getabsfile(data) | |
2274 | if 'fakemodule' in filename.lower() and inspect.isclass(data): |
|
2288 | if 'fakemodule' in filename.lower() and inspect.isclass(data): | |
2275 | # class created by %edit? Try to find source |
|
2289 | # class created by %edit? Try to find source | |
2276 | # by looking for method definitions instead, the |
|
2290 | # by looking for method definitions instead, the | |
2277 | # __module__ in those classes is FakeModule. |
|
2291 | # __module__ in those classes is FakeModule. | |
2278 | attrs = [getattr(data, aname) for aname in dir(data)] |
|
2292 | attrs = [getattr(data, aname) for aname in dir(data)] | |
2279 | for attr in attrs: |
|
2293 | for attr in attrs: | |
2280 | if not inspect.ismethod(attr): |
|
2294 | if not inspect.ismethod(attr): | |
2281 | continue |
|
2295 | continue | |
2282 | filename = inspect.getabsfile(attr) |
|
2296 | filename = inspect.getabsfile(attr) | |
2283 | if filename and 'fakemodule' not in filename.lower(): |
|
2297 | if filename and 'fakemodule' not in filename.lower(): | |
2284 | # change the attribute to be the edit target instead |
|
2298 | # change the attribute to be the edit target instead | |
2285 | data = attr |
|
2299 | data = attr | |
2286 | break |
|
2300 | break | |
2287 |
|
2301 | |||
2288 | datafile = 1 |
|
2302 | datafile = 1 | |
2289 | except TypeError: |
|
2303 | except TypeError: | |
2290 | filename = make_filename(args) |
|
2304 | filename = make_filename(args) | |
2291 | datafile = 1 |
|
2305 | datafile = 1 | |
2292 | warn('Could not find file where `%s` is defined.\n' |
|
2306 | warn('Could not find file where `%s` is defined.\n' | |
2293 | 'Opening a file named `%s`' % (args,filename)) |
|
2307 | 'Opening a file named `%s`' % (args,filename)) | |
2294 | # Now, make sure we can actually read the source (if it was in |
|
2308 | # Now, make sure we can actually read the source (if it was in | |
2295 | # a temp file it's gone by now). |
|
2309 | # a temp file it's gone by now). | |
2296 | if datafile: |
|
2310 | if datafile: | |
2297 | try: |
|
2311 | try: | |
2298 | if lineno is None: |
|
2312 | if lineno is None: | |
2299 | lineno = inspect.getsourcelines(data)[1] |
|
2313 | lineno = inspect.getsourcelines(data)[1] | |
2300 | except IOError: |
|
2314 | except IOError: | |
2301 | filename = make_filename(args) |
|
2315 | filename = make_filename(args) | |
2302 | if filename is None: |
|
2316 | if filename is None: | |
2303 | warn('The file `%s` where `%s` was defined cannot ' |
|
2317 | warn('The file `%s` where `%s` was defined cannot ' | |
2304 | 'be read.' % (filename,data)) |
|
2318 | 'be read.' % (filename,data)) | |
2305 | return |
|
2319 | return | |
2306 | use_temp = 0 |
|
2320 | use_temp = 0 | |
2307 | else: |
|
2321 | else: | |
2308 | data = '' |
|
2322 | data = '' | |
2309 |
|
2323 | |||
2310 | if use_temp: |
|
2324 | if use_temp: | |
2311 | filename = self.shell.mktempfile(data) |
|
2325 | filename = self.shell.mktempfile(data) | |
2312 | print 'IPython will make a temporary file named:',filename |
|
2326 | print 'IPython will make a temporary file named:',filename | |
2313 |
|
2327 | |||
2314 | # do actual editing here |
|
2328 | # do actual editing here | |
2315 | print 'Editing...', |
|
2329 | print 'Editing...', | |
2316 | sys.stdout.flush() |
|
2330 | sys.stdout.flush() | |
2317 | self.shell.hooks.editor(filename,lineno) |
|
2331 | self.shell.hooks.editor(filename,lineno) | |
2318 | if opts.has_key('x'): # -x prevents actual execution |
|
2332 | if opts.has_key('x'): # -x prevents actual execution | |
2319 |
|
2333 | |||
2320 | else: |
|
2334 | else: | |
2321 | print 'done. Executing edited code...' |
|
2335 | print 'done. Executing edited code...' | |
2322 | if opts_r: |
|
2336 | if opts_r: | |
2323 | self.shell.runlines(file_read(filename)) |
|
2337 | self.shell.runlines(file_read(filename)) | |
2324 | else: |
|
2338 | else: | |
2325 | self.shell.safe_execfile(filename,self.shell.user_ns, |
|
2339 | self.shell.safe_execfile(filename,self.shell.user_ns, | |
2326 | self.shell.user_ns) |
|
2340 | self.shell.user_ns) | |
2327 | if use_temp: |
|
2341 | if use_temp: | |
2328 | try: |
|
2342 | try: | |
2329 | return open(filename).read() |
|
2343 | return open(filename).read() | |
2330 | except IOError,msg: |
|
2344 | except IOError,msg: | |
2331 | if msg.filename == filename: |
|
2345 | if msg.filename == filename: | |
2332 | warn('File not found. Did you forget to save?') |
|
2346 | warn('File not found. Did you forget to save?') | |
2333 | return |
|
2347 | return | |
2334 | else: |
|
2348 | else: | |
2335 | self.shell.showtraceback() |
|
2349 | self.shell.showtraceback() | |
2336 |
|
2350 | |||
2337 | def magic_xmode(self,parameter_s = ''): |
|
2351 | def magic_xmode(self,parameter_s = ''): | |
2338 | """Switch modes for the exception handlers. |
|
2352 | """Switch modes for the exception handlers. | |
2339 |
|
2353 | |||
2340 | Valid modes: Plain, Context and Verbose. |
|
2354 | Valid modes: Plain, Context and Verbose. | |
2341 |
|
2355 | |||
2342 | If called without arguments, acts as a toggle.""" |
|
2356 | If called without arguments, acts as a toggle.""" | |
2343 |
|
2357 | |||
2344 | def xmode_switch_err(name): |
|
2358 | def xmode_switch_err(name): | |
2345 | warn('Error changing %s exception modes.\n%s' % |
|
2359 | warn('Error changing %s exception modes.\n%s' % | |
2346 | (name,sys.exc_info()[1])) |
|
2360 | (name,sys.exc_info()[1])) | |
2347 |
|
2361 | |||
2348 | shell = self.shell |
|
2362 | shell = self.shell | |
2349 | new_mode = parameter_s.strip().capitalize() |
|
2363 | new_mode = parameter_s.strip().capitalize() | |
2350 | try: |
|
2364 | try: | |
2351 | shell.InteractiveTB.set_mode(mode=new_mode) |
|
2365 | shell.InteractiveTB.set_mode(mode=new_mode) | |
2352 | print 'Exception reporting mode:',shell.InteractiveTB.mode |
|
2366 | print 'Exception reporting mode:',shell.InteractiveTB.mode | |
2353 | except: |
|
2367 | except: | |
2354 | xmode_switch_err('user') |
|
2368 | xmode_switch_err('user') | |
2355 |
|
2369 | |||
2356 | # threaded shells use a special handler in sys.excepthook |
|
2370 | # threaded shells use a special handler in sys.excepthook | |
2357 | if shell.isthreaded: |
|
2371 | if shell.isthreaded: | |
2358 | try: |
|
2372 | try: | |
2359 | shell.sys_excepthook.set_mode(mode=new_mode) |
|
2373 | shell.sys_excepthook.set_mode(mode=new_mode) | |
2360 | except: |
|
2374 | except: | |
2361 | xmode_switch_err('threaded') |
|
2375 | xmode_switch_err('threaded') | |
2362 |
|
2376 | |||
2363 | def magic_colors(self,parameter_s = ''): |
|
2377 | def magic_colors(self,parameter_s = ''): | |
2364 | """Switch color scheme for prompts, info system and exception handlers. |
|
2378 | """Switch color scheme for prompts, info system and exception handlers. | |
2365 |
|
2379 | |||
2366 | Currently implemented schemes: NoColor, Linux, LightBG. |
|
2380 | Currently implemented schemes: NoColor, Linux, LightBG. | |
2367 |
|
2381 | |||
2368 | Color scheme names are not case-sensitive.""" |
|
2382 | Color scheme names are not case-sensitive.""" | |
2369 |
|
2383 | |||
2370 | def color_switch_err(name): |
|
2384 | def color_switch_err(name): | |
2371 | warn('Error changing %s color schemes.\n%s' % |
|
2385 | warn('Error changing %s color schemes.\n%s' % | |
2372 | (name,sys.exc_info()[1])) |
|
2386 | (name,sys.exc_info()[1])) | |
2373 |
|
2387 | |||
2374 |
|
2388 | |||
2375 | new_scheme = parameter_s.strip() |
|
2389 | new_scheme = parameter_s.strip() | |
2376 | if not new_scheme: |
|
2390 | if not new_scheme: | |
2377 | raise UsageError( |
|
2391 | raise UsageError( | |
2378 | "%colors: you must specify a color scheme. See '%colors?'") |
|
2392 | "%colors: you must specify a color scheme. See '%colors?'") | |
2379 | return |
|
2393 | return | |
2380 | # local shortcut |
|
2394 | # local shortcut | |
2381 | shell = self.shell |
|
2395 | shell = self.shell | |
2382 |
|
2396 | |||
2383 | import IPython.rlineimpl as readline |
|
2397 | import IPython.rlineimpl as readline | |
2384 |
|
2398 | |||
2385 | if not readline.have_readline and sys.platform == "win32": |
|
2399 | if not readline.have_readline and sys.platform == "win32": | |
2386 | msg = """\ |
|
2400 | msg = """\ | |
2387 | Proper color support under MS Windows requires the pyreadline library. |
|
2401 | Proper color support under MS Windows requires the pyreadline library. | |
2388 | You can find it at: |
|
2402 | You can find it at: | |
2389 | http://ipython.scipy.org/moin/PyReadline/Intro |
|
2403 | http://ipython.scipy.org/moin/PyReadline/Intro | |
2390 | Gary's readline needs the ctypes module, from: |
|
2404 | Gary's readline needs the ctypes module, from: | |
2391 | http://starship.python.net/crew/theller/ctypes |
|
2405 | http://starship.python.net/crew/theller/ctypes | |
2392 | (Note that ctypes is already part of Python versions 2.5 and newer). |
|
2406 | (Note that ctypes is already part of Python versions 2.5 and newer). | |
2393 |
|
2407 | |||
2394 | Defaulting color scheme to 'NoColor'""" |
|
2408 | Defaulting color scheme to 'NoColor'""" | |
2395 | new_scheme = 'NoColor' |
|
2409 | new_scheme = 'NoColor' | |
2396 | warn(msg) |
|
2410 | warn(msg) | |
2397 |
|
2411 | |||
2398 | # readline option is 0 |
|
2412 | # readline option is 0 | |
2399 | if not shell.has_readline: |
|
2413 | if not shell.has_readline: | |
2400 | new_scheme = 'NoColor' |
|
2414 | new_scheme = 'NoColor' | |
2401 |
|
2415 | |||
2402 | # Set prompt colors |
|
2416 | # Set prompt colors | |
2403 | try: |
|
2417 | try: | |
2404 | shell.outputcache.set_colors(new_scheme) |
|
2418 | shell.outputcache.set_colors(new_scheme) | |
2405 | except: |
|
2419 | except: | |
2406 | color_switch_err('prompt') |
|
2420 | color_switch_err('prompt') | |
2407 | else: |
|
2421 | else: | |
2408 | shell.rc.colors = \ |
|
2422 | shell.rc.colors = \ | |
2409 | shell.outputcache.color_table.active_scheme_name |
|
2423 | shell.outputcache.color_table.active_scheme_name | |
2410 | # Set exception colors |
|
2424 | # Set exception colors | |
2411 | try: |
|
2425 | try: | |
2412 | shell.InteractiveTB.set_colors(scheme = new_scheme) |
|
2426 | shell.InteractiveTB.set_colors(scheme = new_scheme) | |
2413 | shell.SyntaxTB.set_colors(scheme = new_scheme) |
|
2427 | shell.SyntaxTB.set_colors(scheme = new_scheme) | |
2414 | except: |
|
2428 | except: | |
2415 | color_switch_err('exception') |
|
2429 | color_switch_err('exception') | |
2416 |
|
2430 | |||
2417 | # threaded shells use a verbose traceback in sys.excepthook |
|
2431 | # threaded shells use a verbose traceback in sys.excepthook | |
2418 | if shell.isthreaded: |
|
2432 | if shell.isthreaded: | |
2419 | try: |
|
2433 | try: | |
2420 | shell.sys_excepthook.set_colors(scheme=new_scheme) |
|
2434 | shell.sys_excepthook.set_colors(scheme=new_scheme) | |
2421 | except: |
|
2435 | except: | |
2422 | color_switch_err('system exception handler') |
|
2436 | color_switch_err('system exception handler') | |
2423 |
|
2437 | |||
2424 | # Set info (for 'object?') colors |
|
2438 | # Set info (for 'object?') colors | |
2425 | if shell.rc.color_info: |
|
2439 | if shell.rc.color_info: | |
2426 | try: |
|
2440 | try: | |
2427 | shell.inspector.set_active_scheme(new_scheme) |
|
2441 | shell.inspector.set_active_scheme(new_scheme) | |
2428 | except: |
|
2442 | except: | |
2429 | color_switch_err('object inspector') |
|
2443 | color_switch_err('object inspector') | |
2430 | else: |
|
2444 | else: | |
2431 | shell.inspector.set_active_scheme('NoColor') |
|
2445 | shell.inspector.set_active_scheme('NoColor') | |
2432 |
|
2446 | |||
2433 | def magic_color_info(self,parameter_s = ''): |
|
2447 | def magic_color_info(self,parameter_s = ''): | |
2434 | """Toggle color_info. |
|
2448 | """Toggle color_info. | |
2435 |
|
2449 | |||
2436 | The color_info configuration parameter controls whether colors are |
|
2450 | The color_info configuration parameter controls whether colors are | |
2437 | used for displaying object details (by things like %psource, %pfile or |
|
2451 | used for displaying object details (by things like %psource, %pfile or | |
2438 | the '?' system). This function toggles this value with each call. |
|
2452 | the '?' system). This function toggles this value with each call. | |
2439 |
|
2453 | |||
2440 | Note that unless you have a fairly recent pager (less works better |
|
2454 | Note that unless you have a fairly recent pager (less works better | |
2441 | than more) in your system, using colored object information displays |
|
2455 | than more) in your system, using colored object information displays | |
2442 | will not work properly. Test it and see.""" |
|
2456 | will not work properly. Test it and see.""" | |
2443 |
|
2457 | |||
2444 | self.shell.rc.color_info = 1 - self.shell.rc.color_info |
|
2458 | self.shell.rc.color_info = 1 - self.shell.rc.color_info | |
2445 | self.magic_colors(self.shell.rc.colors) |
|
2459 | self.magic_colors(self.shell.rc.colors) | |
2446 | print 'Object introspection functions have now coloring:', |
|
2460 | print 'Object introspection functions have now coloring:', | |
2447 | print ['OFF','ON'][self.shell.rc.color_info] |
|
2461 | print ['OFF','ON'][self.shell.rc.color_info] | |
2448 |
|
2462 | |||
2449 | def magic_Pprint(self, parameter_s=''): |
|
2463 | def magic_Pprint(self, parameter_s=''): | |
2450 | """Toggle pretty printing on/off.""" |
|
2464 | """Toggle pretty printing on/off.""" | |
2451 |
|
2465 | |||
2452 | self.shell.rc.pprint = 1 - self.shell.rc.pprint |
|
2466 | self.shell.rc.pprint = 1 - self.shell.rc.pprint | |
2453 | print 'Pretty printing has been turned', \ |
|
2467 | print 'Pretty printing has been turned', \ | |
2454 | ['OFF','ON'][self.shell.rc.pprint] |
|
2468 | ['OFF','ON'][self.shell.rc.pprint] | |
2455 |
|
2469 | |||
2456 | def magic_exit(self, parameter_s=''): |
|
2470 | def magic_exit(self, parameter_s=''): | |
2457 | """Exit IPython, confirming if configured to do so. |
|
2471 | """Exit IPython, confirming if configured to do so. | |
2458 |
|
2472 | |||
2459 | You can configure whether IPython asks for confirmation upon exit by |
|
2473 | You can configure whether IPython asks for confirmation upon exit by | |
2460 | setting the confirm_exit flag in the ipythonrc file.""" |
|
2474 | setting the confirm_exit flag in the ipythonrc file.""" | |
2461 |
|
2475 | |||
2462 | self.shell.exit() |
|
2476 | self.shell.exit() | |
2463 |
|
2477 | |||
2464 | def magic_quit(self, parameter_s=''): |
|
2478 | def magic_quit(self, parameter_s=''): | |
2465 | """Exit IPython, confirming if configured to do so (like %exit)""" |
|
2479 | """Exit IPython, confirming if configured to do so (like %exit)""" | |
2466 |
|
2480 | |||
2467 | self.shell.exit() |
|
2481 | self.shell.exit() | |
2468 |
|
2482 | |||
2469 | def magic_Exit(self, parameter_s=''): |
|
2483 | def magic_Exit(self, parameter_s=''): | |
2470 | """Exit IPython without confirmation.""" |
|
2484 | """Exit IPython without confirmation.""" | |
2471 |
|
2485 | |||
2472 | self.shell.exit_now = True |
|
2486 | self.shell.exit_now = True | |
2473 |
|
2487 | |||
2474 | #...................................................................... |
|
2488 | #...................................................................... | |
2475 | # Functions to implement unix shell-type things |
|
2489 | # Functions to implement unix shell-type things | |
2476 |
|
2490 | |||
|
2491 | @testdec.skip_doctest | |||
2477 | def magic_alias(self, parameter_s = ''): |
|
2492 | def magic_alias(self, parameter_s = ''): | |
2478 | """Define an alias for a system command. |
|
2493 | """Define an alias for a system command. | |
2479 |
|
2494 | |||
2480 | '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd' |
|
2495 | '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd' | |
2481 |
|
2496 | |||
2482 | Then, typing 'alias_name params' will execute the system command 'cmd |
|
2497 | Then, typing 'alias_name params' will execute the system command 'cmd | |
2483 | params' (from your underlying operating system). |
|
2498 | params' (from your underlying operating system). | |
2484 |
|
2499 | |||
2485 | Aliases have lower precedence than magic functions and Python normal |
|
2500 | Aliases have lower precedence than magic functions and Python normal | |
2486 | variables, so if 'foo' is both a Python variable and an alias, the |
|
2501 | variables, so if 'foo' is both a Python variable and an alias, the | |
2487 | alias can not be executed until 'del foo' removes the Python variable. |
|
2502 | alias can not be executed until 'del foo' removes the Python variable. | |
2488 |
|
2503 | |||
2489 | You can use the %l specifier in an alias definition to represent the |
|
2504 | You can use the %l specifier in an alias definition to represent the | |
2490 | whole line when the alias is called. For example: |
|
2505 | whole line when the alias is called. For example: | |
2491 |
|
2506 | |||
2492 |
In [2]: alias all echo "Input in brackets: <%l>" |
|
2507 | In [2]: alias all echo "Input in brackets: <%l>" | |
2493 |
In [3]: all hello world |
|
2508 | In [3]: all hello world | |
2494 | Input in brackets: <hello world> |
|
2509 | Input in brackets: <hello world> | |
2495 |
|
2510 | |||
2496 | You can also define aliases with parameters using %s specifiers (one |
|
2511 | You can also define aliases with parameters using %s specifiers (one | |
2497 | per parameter): |
|
2512 | per parameter): | |
2498 |
|
2513 | |||
2499 |
In [1]: alias parts echo first %s second %s |
|
2514 | In [1]: alias parts echo first %s second %s | |
2500 |
In [2]: %parts A B |
|
2515 | In [2]: %parts A B | |
2501 |
first A second B |
|
2516 | first A second B | |
2502 |
In [3]: %parts A |
|
2517 | In [3]: %parts A | |
2503 |
Incorrect number of arguments: 2 expected. |
|
2518 | Incorrect number of arguments: 2 expected. | |
2504 | parts is an alias to: 'echo first %s second %s' |
|
2519 | parts is an alias to: 'echo first %s second %s' | |
2505 |
|
2520 | |||
2506 | Note that %l and %s are mutually exclusive. You can only use one or |
|
2521 | Note that %l and %s are mutually exclusive. You can only use one or | |
2507 | the other in your aliases. |
|
2522 | the other in your aliases. | |
2508 |
|
2523 | |||
2509 | Aliases expand Python variables just like system calls using ! or !! |
|
2524 | Aliases expand Python variables just like system calls using ! or !! | |
2510 | do: all expressions prefixed with '$' get expanded. For details of |
|
2525 | do: all expressions prefixed with '$' get expanded. For details of | |
2511 | the semantic rules, see PEP-215: |
|
2526 | the semantic rules, see PEP-215: | |
2512 | http://www.python.org/peps/pep-0215.html. This is the library used by |
|
2527 | http://www.python.org/peps/pep-0215.html. This is the library used by | |
2513 | IPython for variable expansion. If you want to access a true shell |
|
2528 | IPython for variable expansion. If you want to access a true shell | |
2514 | variable, an extra $ is necessary to prevent its expansion by IPython: |
|
2529 | variable, an extra $ is necessary to prevent its expansion by IPython: | |
2515 |
|
2530 | |||
2516 |
In [6]: alias show echo |
|
2531 | In [6]: alias show echo | |
2517 |
In [7]: PATH='A Python string' |
|
2532 | In [7]: PATH='A Python string' | |
2518 |
In [8]: show $PATH |
|
2533 | In [8]: show $PATH | |
2519 |
A Python string |
|
2534 | A Python string | |
2520 |
In [9]: show $$PATH |
|
2535 | In [9]: show $$PATH | |
2521 | /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:... |
|
2536 | /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:... | |
2522 |
|
2537 | |||
2523 | You can use the alias facility to acess all of $PATH. See the %rehash |
|
2538 | You can use the alias facility to acess all of $PATH. See the %rehash | |
2524 | and %rehashx functions, which automatically create aliases for the |
|
2539 | and %rehashx functions, which automatically create aliases for the | |
2525 | contents of your $PATH. |
|
2540 | contents of your $PATH. | |
2526 |
|
2541 | |||
2527 | If called with no parameters, %alias prints the current alias table.""" |
|
2542 | If called with no parameters, %alias prints the current alias table.""" | |
2528 |
|
2543 | |||
2529 | par = parameter_s.strip() |
|
2544 | par = parameter_s.strip() | |
2530 | if not par: |
|
2545 | if not par: | |
2531 | stored = self.db.get('stored_aliases', {} ) |
|
2546 | stored = self.db.get('stored_aliases', {} ) | |
2532 | atab = self.shell.alias_table |
|
2547 | atab = self.shell.alias_table | |
2533 | aliases = atab.keys() |
|
2548 | aliases = atab.keys() | |
2534 | aliases.sort() |
|
2549 | aliases.sort() | |
2535 | res = [] |
|
2550 | res = [] | |
2536 | showlast = [] |
|
2551 | showlast = [] | |
2537 | for alias in aliases: |
|
2552 | for alias in aliases: | |
2538 | special = False |
|
2553 | special = False | |
2539 | try: |
|
2554 | try: | |
2540 | tgt = atab[alias][1] |
|
2555 | tgt = atab[alias][1] | |
2541 | except (TypeError, AttributeError): |
|
2556 | except (TypeError, AttributeError): | |
2542 | # unsubscriptable? probably a callable |
|
2557 | # unsubscriptable? probably a callable | |
2543 | tgt = atab[alias] |
|
2558 | tgt = atab[alias] | |
2544 | special = True |
|
2559 | special = True | |
2545 | # 'interesting' aliases |
|
2560 | # 'interesting' aliases | |
2546 | if (alias in stored or |
|
2561 | if (alias in stored or | |
2547 | special or |
|
2562 | special or | |
2548 | alias.lower() != os.path.splitext(tgt)[0].lower() or |
|
2563 | alias.lower() != os.path.splitext(tgt)[0].lower() or | |
2549 | ' ' in tgt): |
|
2564 | ' ' in tgt): | |
2550 | showlast.append((alias, tgt)) |
|
2565 | showlast.append((alias, tgt)) | |
2551 | else: |
|
2566 | else: | |
2552 | res.append((alias, tgt )) |
|
2567 | res.append((alias, tgt )) | |
2553 |
|
2568 | |||
2554 | # show most interesting aliases last |
|
2569 | # show most interesting aliases last | |
2555 | res.extend(showlast) |
|
2570 | res.extend(showlast) | |
2556 | print "Total number of aliases:",len(aliases) |
|
2571 | print "Total number of aliases:",len(aliases) | |
2557 | return res |
|
2572 | return res | |
2558 | try: |
|
2573 | try: | |
2559 | alias,cmd = par.split(None,1) |
|
2574 | alias,cmd = par.split(None,1) | |
2560 | except: |
|
2575 | except: | |
2561 | print OInspect.getdoc(self.magic_alias) |
|
2576 | print OInspect.getdoc(self.magic_alias) | |
2562 | else: |
|
2577 | else: | |
2563 | nargs = cmd.count('%s') |
|
2578 | nargs = cmd.count('%s') | |
2564 | if nargs>0 and cmd.find('%l')>=0: |
|
2579 | if nargs>0 and cmd.find('%l')>=0: | |
2565 | error('The %s and %l specifiers are mutually exclusive ' |
|
2580 | error('The %s and %l specifiers are mutually exclusive ' | |
2566 | 'in alias definitions.') |
|
2581 | 'in alias definitions.') | |
2567 | else: # all looks OK |
|
2582 | else: # all looks OK | |
2568 | self.shell.alias_table[alias] = (nargs,cmd) |
|
2583 | self.shell.alias_table[alias] = (nargs,cmd) | |
2569 | self.shell.alias_table_validate(verbose=0) |
|
2584 | self.shell.alias_table_validate(verbose=0) | |
2570 | # end magic_alias |
|
2585 | # end magic_alias | |
2571 |
|
2586 | |||
2572 | def magic_unalias(self, parameter_s = ''): |
|
2587 | def magic_unalias(self, parameter_s = ''): | |
2573 | """Remove an alias""" |
|
2588 | """Remove an alias""" | |
2574 |
|
2589 | |||
2575 | aname = parameter_s.strip() |
|
2590 | aname = parameter_s.strip() | |
2576 | if aname in self.shell.alias_table: |
|
2591 | if aname in self.shell.alias_table: | |
2577 | del self.shell.alias_table[aname] |
|
2592 | del self.shell.alias_table[aname] | |
2578 | stored = self.db.get('stored_aliases', {} ) |
|
2593 | stored = self.db.get('stored_aliases', {} ) | |
2579 | if aname in stored: |
|
2594 | if aname in stored: | |
2580 | print "Removing %stored alias",aname |
|
2595 | print "Removing %stored alias",aname | |
2581 | del stored[aname] |
|
2596 | del stored[aname] | |
2582 | self.db['stored_aliases'] = stored |
|
2597 | self.db['stored_aliases'] = stored | |
2583 |
|
2598 | |||
2584 |
|
2599 | |||
2585 | def magic_rehashx(self, parameter_s = ''): |
|
2600 | def magic_rehashx(self, parameter_s = ''): | |
2586 | """Update the alias table with all executable files in $PATH. |
|
2601 | """Update the alias table with all executable files in $PATH. | |
2587 |
|
2602 | |||
2588 | This version explicitly checks that every entry in $PATH is a file |
|
2603 | This version explicitly checks that every entry in $PATH is a file | |
2589 | with execute access (os.X_OK), so it is much slower than %rehash. |
|
2604 | with execute access (os.X_OK), so it is much slower than %rehash. | |
2590 |
|
2605 | |||
2591 | Under Windows, it checks executability as a match agains a |
|
2606 | Under Windows, it checks executability as a match agains a | |
2592 | '|'-separated string of extensions, stored in the IPython config |
|
2607 | '|'-separated string of extensions, stored in the IPython config | |
2593 | variable win_exec_ext. This defaults to 'exe|com|bat'. |
|
2608 | variable win_exec_ext. This defaults to 'exe|com|bat'. | |
2594 |
|
2609 | |||
2595 | This function also resets the root module cache of module completer, |
|
2610 | This function also resets the root module cache of module completer, | |
2596 | used on slow filesystems. |
|
2611 | used on slow filesystems. | |
2597 | """ |
|
2612 | """ | |
2598 |
|
2613 | |||
2599 |
|
2614 | |||
2600 | ip = self.api |
|
2615 | ip = self.api | |
2601 |
|
2616 | |||
2602 | # for the benefit of module completer in ipy_completers.py |
|
2617 | # for the benefit of module completer in ipy_completers.py | |
2603 | del ip.db['rootmodules'] |
|
2618 | del ip.db['rootmodules'] | |
2604 |
|
2619 | |||
2605 | path = [os.path.abspath(os.path.expanduser(p)) for p in |
|
2620 | path = [os.path.abspath(os.path.expanduser(p)) for p in | |
2606 | os.environ.get('PATH','').split(os.pathsep)] |
|
2621 | os.environ.get('PATH','').split(os.pathsep)] | |
2607 | path = filter(os.path.isdir,path) |
|
2622 | path = filter(os.path.isdir,path) | |
2608 |
|
2623 | |||
2609 | alias_table = self.shell.alias_table |
|
2624 | alias_table = self.shell.alias_table | |
2610 | syscmdlist = [] |
|
2625 | syscmdlist = [] | |
2611 | if os.name == 'posix': |
|
2626 | if os.name == 'posix': | |
2612 | isexec = lambda fname:os.path.isfile(fname) and \ |
|
2627 | isexec = lambda fname:os.path.isfile(fname) and \ | |
2613 | os.access(fname,os.X_OK) |
|
2628 | os.access(fname,os.X_OK) | |
2614 | else: |
|
2629 | else: | |
2615 |
|
2630 | |||
2616 | try: |
|
2631 | try: | |
2617 | winext = os.environ['pathext'].replace(';','|').replace('.','') |
|
2632 | winext = os.environ['pathext'].replace(';','|').replace('.','') | |
2618 | except KeyError: |
|
2633 | except KeyError: | |
2619 | winext = 'exe|com|bat|py' |
|
2634 | winext = 'exe|com|bat|py' | |
2620 | if 'py' not in winext: |
|
2635 | if 'py' not in winext: | |
2621 | winext += '|py' |
|
2636 | winext += '|py' | |
2622 | execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE) |
|
2637 | execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE) | |
2623 | isexec = lambda fname:os.path.isfile(fname) and execre.match(fname) |
|
2638 | isexec = lambda fname:os.path.isfile(fname) and execre.match(fname) | |
2624 | savedir = os.getcwd() |
|
2639 | savedir = os.getcwd() | |
2625 | try: |
|
2640 | try: | |
2626 | # write the whole loop for posix/Windows so we don't have an if in |
|
2641 | # write the whole loop for posix/Windows so we don't have an if in | |
2627 | # the innermost part |
|
2642 | # the innermost part | |
2628 | if os.name == 'posix': |
|
2643 | if os.name == 'posix': | |
2629 | for pdir in path: |
|
2644 | for pdir in path: | |
2630 | os.chdir(pdir) |
|
2645 | os.chdir(pdir) | |
2631 | for ff in os.listdir(pdir): |
|
2646 | for ff in os.listdir(pdir): | |
2632 | if isexec(ff) and ff not in self.shell.no_alias: |
|
2647 | if isexec(ff) and ff not in self.shell.no_alias: | |
2633 | # each entry in the alias table must be (N,name), |
|
2648 | # each entry in the alias table must be (N,name), | |
2634 | # where N is the number of positional arguments of the |
|
2649 | # where N is the number of positional arguments of the | |
2635 | # alias. |
|
2650 | # alias. | |
2636 | alias_table[ff] = (0,ff) |
|
2651 | alias_table[ff] = (0,ff) | |
2637 | syscmdlist.append(ff) |
|
2652 | syscmdlist.append(ff) | |
2638 | else: |
|
2653 | else: | |
2639 | for pdir in path: |
|
2654 | for pdir in path: | |
2640 | os.chdir(pdir) |
|
2655 | os.chdir(pdir) | |
2641 | for ff in os.listdir(pdir): |
|
2656 | for ff in os.listdir(pdir): | |
2642 | base, ext = os.path.splitext(ff) |
|
2657 | base, ext = os.path.splitext(ff) | |
2643 | if isexec(ff) and base.lower() not in self.shell.no_alias: |
|
2658 | if isexec(ff) and base.lower() not in self.shell.no_alias: | |
2644 | if ext.lower() == '.exe': |
|
2659 | if ext.lower() == '.exe': | |
2645 | ff = base |
|
2660 | ff = base | |
2646 | alias_table[base.lower()] = (0,ff) |
|
2661 | alias_table[base.lower()] = (0,ff) | |
2647 | syscmdlist.append(ff) |
|
2662 | syscmdlist.append(ff) | |
2648 | # Make sure the alias table doesn't contain keywords or builtins |
|
2663 | # Make sure the alias table doesn't contain keywords or builtins | |
2649 | self.shell.alias_table_validate() |
|
2664 | self.shell.alias_table_validate() | |
2650 | # Call again init_auto_alias() so we get 'rm -i' and other |
|
2665 | # Call again init_auto_alias() so we get 'rm -i' and other | |
2651 | # modified aliases since %rehashx will probably clobber them |
|
2666 | # modified aliases since %rehashx will probably clobber them | |
2652 |
|
2667 | |||
2653 | # no, we don't want them. if %rehashx clobbers them, good, |
|
2668 | # no, we don't want them. if %rehashx clobbers them, good, | |
2654 | # we'll probably get better versions |
|
2669 | # we'll probably get better versions | |
2655 | # self.shell.init_auto_alias() |
|
2670 | # self.shell.init_auto_alias() | |
2656 | db = ip.db |
|
2671 | db = ip.db | |
2657 | db['syscmdlist'] = syscmdlist |
|
2672 | db['syscmdlist'] = syscmdlist | |
2658 | finally: |
|
2673 | finally: | |
2659 | os.chdir(savedir) |
|
2674 | os.chdir(savedir) | |
2660 |
|
2675 | |||
2661 | def magic_pwd(self, parameter_s = ''): |
|
2676 | def magic_pwd(self, parameter_s = ''): | |
2662 | """Return the current working directory path.""" |
|
2677 | """Return the current working directory path.""" | |
2663 | return os.getcwd() |
|
2678 | return os.getcwd() | |
2664 |
|
2679 | |||
2665 | def magic_cd(self, parameter_s=''): |
|
2680 | def magic_cd(self, parameter_s=''): | |
2666 | """Change the current working directory. |
|
2681 | """Change the current working directory. | |
2667 |
|
2682 | |||
2668 | This command automatically maintains an internal list of directories |
|
2683 | This command automatically maintains an internal list of directories | |
2669 | you visit during your IPython session, in the variable _dh. The |
|
2684 | you visit during your IPython session, in the variable _dh. The | |
2670 | command %dhist shows this history nicely formatted. You can also |
|
2685 | command %dhist shows this history nicely formatted. You can also | |
2671 | do 'cd -<tab>' to see directory history conveniently. |
|
2686 | do 'cd -<tab>' to see directory history conveniently. | |
2672 |
|
2687 | |||
2673 | Usage: |
|
2688 | Usage: | |
2674 |
|
2689 | |||
2675 | cd 'dir': changes to directory 'dir'. |
|
2690 | cd 'dir': changes to directory 'dir'. | |
2676 |
|
2691 | |||
2677 | cd -: changes to the last visited directory. |
|
2692 | cd -: changes to the last visited directory. | |
2678 |
|
2693 | |||
2679 | cd -<n>: changes to the n-th directory in the directory history. |
|
2694 | cd -<n>: changes to the n-th directory in the directory history. | |
2680 |
|
2695 | |||
2681 | cd -b <bookmark_name>: jump to a bookmark set by %bookmark |
|
2696 | cd -b <bookmark_name>: jump to a bookmark set by %bookmark | |
2682 | (note: cd <bookmark_name> is enough if there is no |
|
2697 | (note: cd <bookmark_name> is enough if there is no | |
2683 | directory <bookmark_name>, but a bookmark with the name exists.) |
|
2698 | directory <bookmark_name>, but a bookmark with the name exists.) | |
2684 | 'cd -b <tab>' allows you to tab-complete bookmark names. |
|
2699 | 'cd -b <tab>' allows you to tab-complete bookmark names. | |
2685 |
|
2700 | |||
2686 | Options: |
|
2701 | Options: | |
2687 |
|
2702 | |||
2688 | -q: quiet. Do not print the working directory after the cd command is |
|
2703 | -q: quiet. Do not print the working directory after the cd command is | |
2689 | executed. By default IPython's cd command does print this directory, |
|
2704 | executed. By default IPython's cd command does print this directory, | |
2690 | since the default prompts do not display path information. |
|
2705 | since the default prompts do not display path information. | |
2691 |
|
2706 | |||
2692 | Note that !cd doesn't work for this purpose because the shell where |
|
2707 | Note that !cd doesn't work for this purpose because the shell where | |
2693 | !command runs is immediately discarded after executing 'command'.""" |
|
2708 | !command runs is immediately discarded after executing 'command'.""" | |
2694 |
|
2709 | |||
2695 | parameter_s = parameter_s.strip() |
|
2710 | parameter_s = parameter_s.strip() | |
2696 | #bkms = self.shell.persist.get("bookmarks",{}) |
|
2711 | #bkms = self.shell.persist.get("bookmarks",{}) | |
2697 |
|
2712 | |||
2698 | oldcwd = os.getcwd() |
|
2713 | oldcwd = os.getcwd() | |
2699 | numcd = re.match(r'(-)(\d+)$',parameter_s) |
|
2714 | numcd = re.match(r'(-)(\d+)$',parameter_s) | |
2700 | # jump in directory history by number |
|
2715 | # jump in directory history by number | |
2701 | if numcd: |
|
2716 | if numcd: | |
2702 | nn = int(numcd.group(2)) |
|
2717 | nn = int(numcd.group(2)) | |
2703 | try: |
|
2718 | try: | |
2704 | ps = self.shell.user_ns['_dh'][nn] |
|
2719 | ps = self.shell.user_ns['_dh'][nn] | |
2705 | except IndexError: |
|
2720 | except IndexError: | |
2706 | print 'The requested directory does not exist in history.' |
|
2721 | print 'The requested directory does not exist in history.' | |
2707 | return |
|
2722 | return | |
2708 | else: |
|
2723 | else: | |
2709 | opts = {} |
|
2724 | opts = {} | |
2710 | else: |
|
2725 | else: | |
2711 | #turn all non-space-escaping backslashes to slashes, |
|
2726 | #turn all non-space-escaping backslashes to slashes, | |
2712 | # for c:\windows\directory\names\ |
|
2727 | # for c:\windows\directory\names\ | |
2713 | parameter_s = re.sub(r'\\(?! )','/', parameter_s) |
|
2728 | parameter_s = re.sub(r'\\(?! )','/', parameter_s) | |
2714 | opts,ps = self.parse_options(parameter_s,'qb',mode='string') |
|
2729 | opts,ps = self.parse_options(parameter_s,'qb',mode='string') | |
2715 | # jump to previous |
|
2730 | # jump to previous | |
2716 | if ps == '-': |
|
2731 | if ps == '-': | |
2717 | try: |
|
2732 | try: | |
2718 | ps = self.shell.user_ns['_dh'][-2] |
|
2733 | ps = self.shell.user_ns['_dh'][-2] | |
2719 | except IndexError: |
|
2734 | except IndexError: | |
2720 | raise UsageError('%cd -: No previous directory to change to.') |
|
2735 | raise UsageError('%cd -: No previous directory to change to.') | |
2721 | # jump to bookmark if needed |
|
2736 | # jump to bookmark if needed | |
2722 | else: |
|
2737 | else: | |
2723 | if not os.path.isdir(ps) or opts.has_key('b'): |
|
2738 | if not os.path.isdir(ps) or opts.has_key('b'): | |
2724 | bkms = self.db.get('bookmarks', {}) |
|
2739 | bkms = self.db.get('bookmarks', {}) | |
2725 |
|
2740 | |||
2726 | if bkms.has_key(ps): |
|
2741 | if bkms.has_key(ps): | |
2727 | target = bkms[ps] |
|
2742 | target = bkms[ps] | |
2728 | print '(bookmark:%s) -> %s' % (ps,target) |
|
2743 | print '(bookmark:%s) -> %s' % (ps,target) | |
2729 | ps = target |
|
2744 | ps = target | |
2730 | else: |
|
2745 | else: | |
2731 | if opts.has_key('b'): |
|
2746 | if opts.has_key('b'): | |
2732 | raise UsageError("Bookmark '%s' not found. " |
|
2747 | raise UsageError("Bookmark '%s' not found. " | |
2733 | "Use '%%bookmark -l' to see your bookmarks." % ps) |
|
2748 | "Use '%%bookmark -l' to see your bookmarks." % ps) | |
2734 |
|
2749 | |||
2735 | # at this point ps should point to the target dir |
|
2750 | # at this point ps should point to the target dir | |
2736 | if ps: |
|
2751 | if ps: | |
2737 | try: |
|
2752 | try: | |
2738 | os.chdir(os.path.expanduser(ps)) |
|
2753 | os.chdir(os.path.expanduser(ps)) | |
2739 | if self.shell.rc.term_title: |
|
2754 | if self.shell.rc.term_title: | |
2740 | #print 'set term title:',self.shell.rc.term_title # dbg |
|
2755 | #print 'set term title:',self.shell.rc.term_title # dbg | |
2741 | platutils.set_term_title('IPy ' + abbrev_cwd()) |
|
2756 | platutils.set_term_title('IPy ' + abbrev_cwd()) | |
2742 | except OSError: |
|
2757 | except OSError: | |
2743 | print sys.exc_info()[1] |
|
2758 | print sys.exc_info()[1] | |
2744 | else: |
|
2759 | else: | |
2745 | cwd = os.getcwd() |
|
2760 | cwd = os.getcwd() | |
2746 | dhist = self.shell.user_ns['_dh'] |
|
2761 | dhist = self.shell.user_ns['_dh'] | |
2747 | if oldcwd != cwd: |
|
2762 | if oldcwd != cwd: | |
2748 | dhist.append(cwd) |
|
2763 | dhist.append(cwd) | |
2749 | self.db['dhist'] = compress_dhist(dhist)[-100:] |
|
2764 | self.db['dhist'] = compress_dhist(dhist)[-100:] | |
2750 |
|
2765 | |||
2751 | else: |
|
2766 | else: | |
2752 | os.chdir(self.shell.home_dir) |
|
2767 | os.chdir(self.shell.home_dir) | |
2753 | if self.shell.rc.term_title: |
|
2768 | if self.shell.rc.term_title: | |
2754 | platutils.set_term_title("IPy ~") |
|
2769 | platutils.set_term_title("IPy ~") | |
2755 | cwd = os.getcwd() |
|
2770 | cwd = os.getcwd() | |
2756 | dhist = self.shell.user_ns['_dh'] |
|
2771 | dhist = self.shell.user_ns['_dh'] | |
2757 |
|
2772 | |||
2758 | if oldcwd != cwd: |
|
2773 | if oldcwd != cwd: | |
2759 | dhist.append(cwd) |
|
2774 | dhist.append(cwd) | |
2760 | self.db['dhist'] = compress_dhist(dhist)[-100:] |
|
2775 | self.db['dhist'] = compress_dhist(dhist)[-100:] | |
2761 | if not 'q' in opts and self.shell.user_ns['_dh']: |
|
2776 | if not 'q' in opts and self.shell.user_ns['_dh']: | |
2762 | print self.shell.user_ns['_dh'][-1] |
|
2777 | print self.shell.user_ns['_dh'][-1] | |
2763 |
|
2778 | |||
2764 |
|
2779 | |||
2765 | def magic_env(self, parameter_s=''): |
|
2780 | def magic_env(self, parameter_s=''): | |
2766 | """List environment variables.""" |
|
2781 | """List environment variables.""" | |
2767 |
|
2782 | |||
2768 | return os.environ.data |
|
2783 | return os.environ.data | |
2769 |
|
2784 | |||
2770 | def magic_pushd(self, parameter_s=''): |
|
2785 | def magic_pushd(self, parameter_s=''): | |
2771 | """Place the current dir on stack and change directory. |
|
2786 | """Place the current dir on stack and change directory. | |
2772 |
|
2787 | |||
2773 | Usage:\\ |
|
2788 | Usage:\\ | |
2774 | %pushd ['dirname'] |
|
2789 | %pushd ['dirname'] | |
2775 | """ |
|
2790 | """ | |
2776 |
|
2791 | |||
2777 | dir_s = self.shell.dir_stack |
|
2792 | dir_s = self.shell.dir_stack | |
2778 | tgt = os.path.expanduser(parameter_s) |
|
2793 | tgt = os.path.expanduser(parameter_s) | |
2779 | cwd = os.getcwd().replace(self.home_dir,'~') |
|
2794 | cwd = os.getcwd().replace(self.home_dir,'~') | |
2780 | if tgt: |
|
2795 | if tgt: | |
2781 | self.magic_cd(parameter_s) |
|
2796 | self.magic_cd(parameter_s) | |
2782 | dir_s.insert(0,cwd) |
|
2797 | dir_s.insert(0,cwd) | |
2783 | return self.magic_dirs() |
|
2798 | return self.magic_dirs() | |
2784 |
|
2799 | |||
2785 | def magic_popd(self, parameter_s=''): |
|
2800 | def magic_popd(self, parameter_s=''): | |
2786 | """Change to directory popped off the top of the stack. |
|
2801 | """Change to directory popped off the top of the stack. | |
2787 | """ |
|
2802 | """ | |
2788 | if not self.shell.dir_stack: |
|
2803 | if not self.shell.dir_stack: | |
2789 | raise UsageError("%popd on empty stack") |
|
2804 | raise UsageError("%popd on empty stack") | |
2790 | top = self.shell.dir_stack.pop(0) |
|
2805 | top = self.shell.dir_stack.pop(0) | |
2791 | self.magic_cd(top) |
|
2806 | self.magic_cd(top) | |
2792 | print "popd ->",top |
|
2807 | print "popd ->",top | |
2793 |
|
2808 | |||
2794 | def magic_dirs(self, parameter_s=''): |
|
2809 | def magic_dirs(self, parameter_s=''): | |
2795 | """Return the current directory stack.""" |
|
2810 | """Return the current directory stack.""" | |
2796 |
|
2811 | |||
2797 | return self.shell.dir_stack |
|
2812 | return self.shell.dir_stack | |
2798 |
|
2813 | |||
2799 | def magic_dhist(self, parameter_s=''): |
|
2814 | def magic_dhist(self, parameter_s=''): | |
2800 | """Print your history of visited directories. |
|
2815 | """Print your history of visited directories. | |
2801 |
|
2816 | |||
2802 | %dhist -> print full history\\ |
|
2817 | %dhist -> print full history\\ | |
2803 | %dhist n -> print last n entries only\\ |
|
2818 | %dhist n -> print last n entries only\\ | |
2804 | %dhist n1 n2 -> print entries between n1 and n2 (n1 not included)\\ |
|
2819 | %dhist n1 n2 -> print entries between n1 and n2 (n1 not included)\\ | |
2805 |
|
2820 | |||
2806 | This history is automatically maintained by the %cd command, and |
|
2821 | This history is automatically maintained by the %cd command, and | |
2807 | always available as the global list variable _dh. You can use %cd -<n> |
|
2822 | always available as the global list variable _dh. You can use %cd -<n> | |
2808 | to go to directory number <n>. |
|
2823 | to go to directory number <n>. | |
2809 |
|
2824 | |||
2810 | Note that most of time, you should view directory history by entering |
|
2825 | Note that most of time, you should view directory history by entering | |
2811 | cd -<TAB>. |
|
2826 | cd -<TAB>. | |
2812 |
|
2827 | |||
2813 | """ |
|
2828 | """ | |
2814 |
|
2829 | |||
2815 | dh = self.shell.user_ns['_dh'] |
|
2830 | dh = self.shell.user_ns['_dh'] | |
2816 | if parameter_s: |
|
2831 | if parameter_s: | |
2817 | try: |
|
2832 | try: | |
2818 | args = map(int,parameter_s.split()) |
|
2833 | args = map(int,parameter_s.split()) | |
2819 | except: |
|
2834 | except: | |
2820 | self.arg_err(Magic.magic_dhist) |
|
2835 | self.arg_err(Magic.magic_dhist) | |
2821 | return |
|
2836 | return | |
2822 | if len(args) == 1: |
|
2837 | if len(args) == 1: | |
2823 | ini,fin = max(len(dh)-(args[0]),0),len(dh) |
|
2838 | ini,fin = max(len(dh)-(args[0]),0),len(dh) | |
2824 | elif len(args) == 2: |
|
2839 | elif len(args) == 2: | |
2825 | ini,fin = args |
|
2840 | ini,fin = args | |
2826 | else: |
|
2841 | else: | |
2827 | self.arg_err(Magic.magic_dhist) |
|
2842 | self.arg_err(Magic.magic_dhist) | |
2828 | return |
|
2843 | return | |
2829 | else: |
|
2844 | else: | |
2830 | ini,fin = 0,len(dh) |
|
2845 | ini,fin = 0,len(dh) | |
2831 | nlprint(dh, |
|
2846 | nlprint(dh, | |
2832 | header = 'Directory history (kept in _dh)', |
|
2847 | header = 'Directory history (kept in _dh)', | |
2833 | start=ini,stop=fin) |
|
2848 | start=ini,stop=fin) | |
2834 |
|
2849 | |||
2835 |
|
2850 | @testdec.skip_doctest | ||
2836 | def magic_sc(self, parameter_s=''): |
|
2851 | def magic_sc(self, parameter_s=''): | |
2837 | """Shell capture - execute a shell command and capture its output. |
|
2852 | """Shell capture - execute a shell command and capture its output. | |
2838 |
|
2853 | |||
2839 | DEPRECATED. Suboptimal, retained for backwards compatibility. |
|
2854 | DEPRECATED. Suboptimal, retained for backwards compatibility. | |
2840 |
|
2855 | |||
2841 | You should use the form 'var = !command' instead. Example: |
|
2856 | You should use the form 'var = !command' instead. Example: | |
2842 |
|
2857 | |||
2843 | "%sc -l myfiles = ls ~" should now be written as |
|
2858 | "%sc -l myfiles = ls ~" should now be written as | |
2844 |
|
2859 | |||
2845 | "myfiles = !ls ~" |
|
2860 | "myfiles = !ls ~" | |
2846 |
|
2861 | |||
2847 | myfiles.s, myfiles.l and myfiles.n still apply as documented |
|
2862 | myfiles.s, myfiles.l and myfiles.n still apply as documented | |
2848 | below. |
|
2863 | below. | |
2849 |
|
2864 | |||
2850 | -- |
|
2865 | -- | |
2851 | %sc [options] varname=command |
|
2866 | %sc [options] varname=command | |
2852 |
|
2867 | |||
2853 | IPython will run the given command using commands.getoutput(), and |
|
2868 | IPython will run the given command using commands.getoutput(), and | |
2854 | will then update the user's interactive namespace with a variable |
|
2869 | will then update the user's interactive namespace with a variable | |
2855 | called varname, containing the value of the call. Your command can |
|
2870 | called varname, containing the value of the call. Your command can | |
2856 | contain shell wildcards, pipes, etc. |
|
2871 | contain shell wildcards, pipes, etc. | |
2857 |
|
2872 | |||
2858 | The '=' sign in the syntax is mandatory, and the variable name you |
|
2873 | The '=' sign in the syntax is mandatory, and the variable name you | |
2859 | supply must follow Python's standard conventions for valid names. |
|
2874 | supply must follow Python's standard conventions for valid names. | |
2860 |
|
2875 | |||
2861 | (A special format without variable name exists for internal use) |
|
2876 | (A special format without variable name exists for internal use) | |
2862 |
|
2877 | |||
2863 | Options: |
|
2878 | Options: | |
2864 |
|
2879 | |||
2865 | -l: list output. Split the output on newlines into a list before |
|
2880 | -l: list output. Split the output on newlines into a list before | |
2866 | assigning it to the given variable. By default the output is stored |
|
2881 | assigning it to the given variable. By default the output is stored | |
2867 | as a single string. |
|
2882 | as a single string. | |
2868 |
|
2883 | |||
2869 | -v: verbose. Print the contents of the variable. |
|
2884 | -v: verbose. Print the contents of the variable. | |
2870 |
|
2885 | |||
2871 | In most cases you should not need to split as a list, because the |
|
2886 | In most cases you should not need to split as a list, because the | |
2872 | returned value is a special type of string which can automatically |
|
2887 | returned value is a special type of string which can automatically | |
2873 | provide its contents either as a list (split on newlines) or as a |
|
2888 | provide its contents either as a list (split on newlines) or as a | |
2874 | space-separated string. These are convenient, respectively, either |
|
2889 | space-separated string. These are convenient, respectively, either | |
2875 | for sequential processing or to be passed to a shell command. |
|
2890 | for sequential processing or to be passed to a shell command. | |
2876 |
|
2891 | |||
2877 | For example: |
|
2892 | For example: | |
2878 |
|
2893 | |||
|
2894 | # all-random | |||
|
2895 | ||||
2879 | # Capture into variable a |
|
2896 | # Capture into variable a | |
2880 | In []: sc a=ls *py |
|
2897 | In [1]: sc a=ls *py | |
2881 |
|
2898 | |||
2882 | # a is a string with embedded newlines |
|
2899 | # a is a string with embedded newlines | |
2883 | In []: a |
|
2900 | In [2]: a | |
2884 | Out[]: 'setup.py\nwin32_manual_post_install.py' |
|
2901 | Out[2]: 'setup.py\\nwin32_manual_post_install.py' | |
2885 |
|
2902 | |||
2886 | # which can be seen as a list: |
|
2903 | # which can be seen as a list: | |
2887 | In []: a.l |
|
2904 | In [3]: a.l | |
2888 | Out[]: ['setup.py', 'win32_manual_post_install.py'] |
|
2905 | Out[3]: ['setup.py', 'win32_manual_post_install.py'] | |
2889 |
|
2906 | |||
2890 | # or as a whitespace-separated string: |
|
2907 | # or as a whitespace-separated string: | |
2891 | In []: a.s |
|
2908 | In [4]: a.s | |
2892 | Out[]: 'setup.py win32_manual_post_install.py' |
|
2909 | Out[4]: 'setup.py win32_manual_post_install.py' | |
2893 |
|
2910 | |||
2894 | # a.s is useful to pass as a single command line: |
|
2911 | # a.s is useful to pass as a single command line: | |
2895 | In []: !wc -l $a.s |
|
2912 | In [5]: !wc -l $a.s | |
2896 | 146 setup.py |
|
2913 | 146 setup.py | |
2897 | 130 win32_manual_post_install.py |
|
2914 | 130 win32_manual_post_install.py | |
2898 | 276 total |
|
2915 | 276 total | |
2899 |
|
2916 | |||
2900 | # while the list form is useful to loop over: |
|
2917 | # while the list form is useful to loop over: | |
2901 | In []: for f in a.l: |
|
2918 | In [6]: for f in a.l: | |
2902 | ...: !wc -l $f |
|
2919 | ...: !wc -l $f | |
2903 | ...: |
|
2920 | ...: | |
2904 | 146 setup.py |
|
2921 | 146 setup.py | |
2905 | 130 win32_manual_post_install.py |
|
2922 | 130 win32_manual_post_install.py | |
2906 |
|
2923 | |||
2907 | Similiarly, the lists returned by the -l option are also special, in |
|
2924 | Similiarly, the lists returned by the -l option are also special, in | |
2908 | the sense that you can equally invoke the .s attribute on them to |
|
2925 | the sense that you can equally invoke the .s attribute on them to | |
2909 | automatically get a whitespace-separated string from their contents: |
|
2926 | automatically get a whitespace-separated string from their contents: | |
2910 |
|
2927 | |||
2911 | In []: sc -l b=ls *py |
|
2928 | In [7]: sc -l b=ls *py | |
2912 |
|
2929 | |||
2913 | In []: b |
|
2930 | In [8]: b | |
2914 | Out[]: ['setup.py', 'win32_manual_post_install.py'] |
|
2931 | Out[8]: ['setup.py', 'win32_manual_post_install.py'] | |
2915 |
|
2932 | |||
2916 | In []: b.s |
|
2933 | In [9]: b.s | |
2917 | Out[]: 'setup.py win32_manual_post_install.py' |
|
2934 | Out[9]: 'setup.py win32_manual_post_install.py' | |
2918 |
|
2935 | |||
2919 | In summary, both the lists and strings used for ouptut capture have |
|
2936 | In summary, both the lists and strings used for ouptut capture have | |
2920 | the following special attributes: |
|
2937 | the following special attributes: | |
2921 |
|
2938 | |||
2922 | .l (or .list) : value as list. |
|
2939 | .l (or .list) : value as list. | |
2923 | .n (or .nlstr): value as newline-separated string. |
|
2940 | .n (or .nlstr): value as newline-separated string. | |
2924 | .s (or .spstr): value as space-separated string. |
|
2941 | .s (or .spstr): value as space-separated string. | |
2925 | """ |
|
2942 | """ | |
2926 |
|
2943 | |||
2927 | opts,args = self.parse_options(parameter_s,'lv') |
|
2944 | opts,args = self.parse_options(parameter_s,'lv') | |
2928 | # Try to get a variable name and command to run |
|
2945 | # Try to get a variable name and command to run | |
2929 | try: |
|
2946 | try: | |
2930 | # the variable name must be obtained from the parse_options |
|
2947 | # the variable name must be obtained from the parse_options | |
2931 | # output, which uses shlex.split to strip options out. |
|
2948 | # output, which uses shlex.split to strip options out. | |
2932 | var,_ = args.split('=',1) |
|
2949 | var,_ = args.split('=',1) | |
2933 | var = var.strip() |
|
2950 | var = var.strip() | |
2934 | # But the the command has to be extracted from the original input |
|
2951 | # But the the command has to be extracted from the original input | |
2935 | # parameter_s, not on what parse_options returns, to avoid the |
|
2952 | # parameter_s, not on what parse_options returns, to avoid the | |
2936 | # quote stripping which shlex.split performs on it. |
|
2953 | # quote stripping which shlex.split performs on it. | |
2937 | _,cmd = parameter_s.split('=',1) |
|
2954 | _,cmd = parameter_s.split('=',1) | |
2938 | except ValueError: |
|
2955 | except ValueError: | |
2939 | var,cmd = '','' |
|
2956 | var,cmd = '','' | |
2940 | # If all looks ok, proceed |
|
2957 | # If all looks ok, proceed | |
2941 | out,err = self.shell.getoutputerror(cmd) |
|
2958 | out,err = self.shell.getoutputerror(cmd) | |
2942 | if err: |
|
2959 | if err: | |
2943 | print >> Term.cerr,err |
|
2960 | print >> Term.cerr,err | |
2944 | if opts.has_key('l'): |
|
2961 | if opts.has_key('l'): | |
2945 | out = SList(out.split('\n')) |
|
2962 | out = SList(out.split('\n')) | |
2946 | else: |
|
2963 | else: | |
2947 | out = LSString(out) |
|
2964 | out = LSString(out) | |
2948 | if opts.has_key('v'): |
|
2965 | if opts.has_key('v'): | |
2949 | print '%s ==\n%s' % (var,pformat(out)) |
|
2966 | print '%s ==\n%s' % (var,pformat(out)) | |
2950 | if var: |
|
2967 | if var: | |
2951 | self.shell.user_ns.update({var:out}) |
|
2968 | self.shell.user_ns.update({var:out}) | |
2952 | else: |
|
2969 | else: | |
2953 | return out |
|
2970 | return out | |
2954 |
|
2971 | |||
2955 | def magic_sx(self, parameter_s=''): |
|
2972 | def magic_sx(self, parameter_s=''): | |
2956 | """Shell execute - run a shell command and capture its output. |
|
2973 | """Shell execute - run a shell command and capture its output. | |
2957 |
|
2974 | |||
2958 | %sx command |
|
2975 | %sx command | |
2959 |
|
2976 | |||
2960 | IPython will run the given command using commands.getoutput(), and |
|
2977 | IPython will run the given command using commands.getoutput(), and | |
2961 | return the result formatted as a list (split on '\\n'). Since the |
|
2978 | return the result formatted as a list (split on '\\n'). Since the | |
2962 | output is _returned_, it will be stored in ipython's regular output |
|
2979 | output is _returned_, it will be stored in ipython's regular output | |
2963 | cache Out[N] and in the '_N' automatic variables. |
|
2980 | cache Out[N] and in the '_N' automatic variables. | |
2964 |
|
2981 | |||
2965 | Notes: |
|
2982 | Notes: | |
2966 |
|
2983 | |||
2967 | 1) If an input line begins with '!!', then %sx is automatically |
|
2984 | 1) If an input line begins with '!!', then %sx is automatically | |
2968 | invoked. That is, while: |
|
2985 | invoked. That is, while: | |
2969 | !ls |
|
2986 | !ls | |
2970 | causes ipython to simply issue system('ls'), typing |
|
2987 | causes ipython to simply issue system('ls'), typing | |
2971 | !!ls |
|
2988 | !!ls | |
2972 | is a shorthand equivalent to: |
|
2989 | is a shorthand equivalent to: | |
2973 | %sx ls |
|
2990 | %sx ls | |
2974 |
|
2991 | |||
2975 | 2) %sx differs from %sc in that %sx automatically splits into a list, |
|
2992 | 2) %sx differs from %sc in that %sx automatically splits into a list, | |
2976 | like '%sc -l'. The reason for this is to make it as easy as possible |
|
2993 | like '%sc -l'. The reason for this is to make it as easy as possible | |
2977 | to process line-oriented shell output via further python commands. |
|
2994 | to process line-oriented shell output via further python commands. | |
2978 | %sc is meant to provide much finer control, but requires more |
|
2995 | %sc is meant to provide much finer control, but requires more | |
2979 | typing. |
|
2996 | typing. | |
2980 |
|
2997 | |||
2981 | 3) Just like %sc -l, this is a list with special attributes: |
|
2998 | 3) Just like %sc -l, this is a list with special attributes: | |
2982 |
|
2999 | |||
2983 | .l (or .list) : value as list. |
|
3000 | .l (or .list) : value as list. | |
2984 | .n (or .nlstr): value as newline-separated string. |
|
3001 | .n (or .nlstr): value as newline-separated string. | |
2985 | .s (or .spstr): value as whitespace-separated string. |
|
3002 | .s (or .spstr): value as whitespace-separated string. | |
2986 |
|
3003 | |||
2987 | This is very useful when trying to use such lists as arguments to |
|
3004 | This is very useful when trying to use such lists as arguments to | |
2988 | system commands.""" |
|
3005 | system commands.""" | |
2989 |
|
3006 | |||
2990 | if parameter_s: |
|
3007 | if parameter_s: | |
2991 | out,err = self.shell.getoutputerror(parameter_s) |
|
3008 | out,err = self.shell.getoutputerror(parameter_s) | |
2992 | if err: |
|
3009 | if err: | |
2993 | print >> Term.cerr,err |
|
3010 | print >> Term.cerr,err | |
2994 | return SList(out.split('\n')) |
|
3011 | return SList(out.split('\n')) | |
2995 |
|
3012 | |||
2996 | def magic_bg(self, parameter_s=''): |
|
3013 | def magic_bg(self, parameter_s=''): | |
2997 | """Run a job in the background, in a separate thread. |
|
3014 | """Run a job in the background, in a separate thread. | |
2998 |
|
3015 | |||
2999 | For example, |
|
3016 | For example, | |
3000 |
|
3017 | |||
3001 | %bg myfunc(x,y,z=1) |
|
3018 | %bg myfunc(x,y,z=1) | |
3002 |
|
3019 | |||
3003 | will execute 'myfunc(x,y,z=1)' in a background thread. As soon as the |
|
3020 | will execute 'myfunc(x,y,z=1)' in a background thread. As soon as the | |
3004 | execution starts, a message will be printed indicating the job |
|
3021 | execution starts, a message will be printed indicating the job | |
3005 | number. If your job number is 5, you can use |
|
3022 | number. If your job number is 5, you can use | |
3006 |
|
3023 | |||
3007 | myvar = jobs.result(5) or myvar = jobs[5].result |
|
3024 | myvar = jobs.result(5) or myvar = jobs[5].result | |
3008 |
|
3025 | |||
3009 | to assign this result to variable 'myvar'. |
|
3026 | to assign this result to variable 'myvar'. | |
3010 |
|
3027 | |||
3011 | IPython has a job manager, accessible via the 'jobs' object. You can |
|
3028 | IPython has a job manager, accessible via the 'jobs' object. You can | |
3012 | type jobs? to get more information about it, and use jobs.<TAB> to see |
|
3029 | type jobs? to get more information about it, and use jobs.<TAB> to see | |
3013 | its attributes. All attributes not starting with an underscore are |
|
3030 | its attributes. All attributes not starting with an underscore are | |
3014 | meant for public use. |
|
3031 | meant for public use. | |
3015 |
|
3032 | |||
3016 | In particular, look at the jobs.new() method, which is used to create |
|
3033 | In particular, look at the jobs.new() method, which is used to create | |
3017 | new jobs. This magic %bg function is just a convenience wrapper |
|
3034 | new jobs. This magic %bg function is just a convenience wrapper | |
3018 | around jobs.new(), for expression-based jobs. If you want to create a |
|
3035 | around jobs.new(), for expression-based jobs. If you want to create a | |
3019 | new job with an explicit function object and arguments, you must call |
|
3036 | new job with an explicit function object and arguments, you must call | |
3020 | jobs.new() directly. |
|
3037 | jobs.new() directly. | |
3021 |
|
3038 | |||
3022 | The jobs.new docstring also describes in detail several important |
|
3039 | The jobs.new docstring also describes in detail several important | |
3023 | caveats associated with a thread-based model for background job |
|
3040 | caveats associated with a thread-based model for background job | |
3024 | execution. Type jobs.new? for details. |
|
3041 | execution. Type jobs.new? for details. | |
3025 |
|
3042 | |||
3026 | You can check the status of all jobs with jobs.status(). |
|
3043 | You can check the status of all jobs with jobs.status(). | |
3027 |
|
3044 | |||
3028 | The jobs variable is set by IPython into the Python builtin namespace. |
|
3045 | The jobs variable is set by IPython into the Python builtin namespace. | |
3029 | If you ever declare a variable named 'jobs', you will shadow this |
|
3046 | If you ever declare a variable named 'jobs', you will shadow this | |
3030 | name. You can either delete your global jobs variable to regain |
|
3047 | name. You can either delete your global jobs variable to regain | |
3031 | access to the job manager, or make a new name and assign it manually |
|
3048 | access to the job manager, or make a new name and assign it manually | |
3032 | to the manager (stored in IPython's namespace). For example, to |
|
3049 | to the manager (stored in IPython's namespace). For example, to | |
3033 | assign the job manager to the Jobs name, use: |
|
3050 | assign the job manager to the Jobs name, use: | |
3034 |
|
3051 | |||
3035 | Jobs = __builtins__.jobs""" |
|
3052 | Jobs = __builtins__.jobs""" | |
3036 |
|
3053 | |||
3037 | self.shell.jobs.new(parameter_s,self.shell.user_ns) |
|
3054 | self.shell.jobs.new(parameter_s,self.shell.user_ns) | |
3038 |
|
3055 | |||
3039 | def magic_r(self, parameter_s=''): |
|
3056 | def magic_r(self, parameter_s=''): | |
3040 | """Repeat previous input. |
|
3057 | """Repeat previous input. | |
3041 |
|
3058 | |||
3042 | Note: Consider using the more powerfull %rep instead! |
|
3059 | Note: Consider using the more powerfull %rep instead! | |
3043 |
|
3060 | |||
3044 | If given an argument, repeats the previous command which starts with |
|
3061 | If given an argument, repeats the previous command which starts with | |
3045 | the same string, otherwise it just repeats the previous input. |
|
3062 | the same string, otherwise it just repeats the previous input. | |
3046 |
|
3063 | |||
3047 | Shell escaped commands (with ! as first character) are not recognized |
|
3064 | Shell escaped commands (with ! as first character) are not recognized | |
3048 | by this system, only pure python code and magic commands. |
|
3065 | by this system, only pure python code and magic commands. | |
3049 | """ |
|
3066 | """ | |
3050 |
|
3067 | |||
3051 | start = parameter_s.strip() |
|
3068 | start = parameter_s.strip() | |
3052 | esc_magic = self.shell.ESC_MAGIC |
|
3069 | esc_magic = self.shell.ESC_MAGIC | |
3053 | # Identify magic commands even if automagic is on (which means |
|
3070 | # Identify magic commands even if automagic is on (which means | |
3054 | # the in-memory version is different from that typed by the user). |
|
3071 | # the in-memory version is different from that typed by the user). | |
3055 | if self.shell.rc.automagic: |
|
3072 | if self.shell.rc.automagic: | |
3056 | start_magic = esc_magic+start |
|
3073 | start_magic = esc_magic+start | |
3057 | else: |
|
3074 | else: | |
3058 | start_magic = start |
|
3075 | start_magic = start | |
3059 | # Look through the input history in reverse |
|
3076 | # Look through the input history in reverse | |
3060 | for n in range(len(self.shell.input_hist)-2,0,-1): |
|
3077 | for n in range(len(self.shell.input_hist)-2,0,-1): | |
3061 | input = self.shell.input_hist[n] |
|
3078 | input = self.shell.input_hist[n] | |
3062 | # skip plain 'r' lines so we don't recurse to infinity |
|
3079 | # skip plain 'r' lines so we don't recurse to infinity | |
3063 | if input != '_ip.magic("r")\n' and \ |
|
3080 | if input != '_ip.magic("r")\n' and \ | |
3064 | (input.startswith(start) or input.startswith(start_magic)): |
|
3081 | (input.startswith(start) or input.startswith(start_magic)): | |
3065 | #print 'match',`input` # dbg |
|
3082 | #print 'match',`input` # dbg | |
3066 | print 'Executing:',input, |
|
3083 | print 'Executing:',input, | |
3067 | self.shell.runlines(input) |
|
3084 | self.shell.runlines(input) | |
3068 | return |
|
3085 | return | |
3069 | print 'No previous input matching `%s` found.' % start |
|
3086 | print 'No previous input matching `%s` found.' % start | |
3070 |
|
3087 | |||
3071 |
|
3088 | |||
3072 | def magic_bookmark(self, parameter_s=''): |
|
3089 | def magic_bookmark(self, parameter_s=''): | |
3073 | """Manage IPython's bookmark system. |
|
3090 | """Manage IPython's bookmark system. | |
3074 |
|
3091 | |||
3075 | %bookmark <name> - set bookmark to current dir |
|
3092 | %bookmark <name> - set bookmark to current dir | |
3076 | %bookmark <name> <dir> - set bookmark to <dir> |
|
3093 | %bookmark <name> <dir> - set bookmark to <dir> | |
3077 | %bookmark -l - list all bookmarks |
|
3094 | %bookmark -l - list all bookmarks | |
3078 | %bookmark -d <name> - remove bookmark |
|
3095 | %bookmark -d <name> - remove bookmark | |
3079 | %bookmark -r - remove all bookmarks |
|
3096 | %bookmark -r - remove all bookmarks | |
3080 |
|
3097 | |||
3081 | You can later on access a bookmarked folder with: |
|
3098 | You can later on access a bookmarked folder with: | |
3082 | %cd -b <name> |
|
3099 | %cd -b <name> | |
3083 | or simply '%cd <name>' if there is no directory called <name> AND |
|
3100 | or simply '%cd <name>' if there is no directory called <name> AND | |
3084 | there is such a bookmark defined. |
|
3101 | there is such a bookmark defined. | |
3085 |
|
3102 | |||
3086 | Your bookmarks persist through IPython sessions, but they are |
|
3103 | Your bookmarks persist through IPython sessions, but they are | |
3087 | associated with each profile.""" |
|
3104 | associated with each profile.""" | |
3088 |
|
3105 | |||
3089 | opts,args = self.parse_options(parameter_s,'drl',mode='list') |
|
3106 | opts,args = self.parse_options(parameter_s,'drl',mode='list') | |
3090 | if len(args) > 2: |
|
3107 | if len(args) > 2: | |
3091 | raise UsageError("%bookmark: too many arguments") |
|
3108 | raise UsageError("%bookmark: too many arguments") | |
3092 |
|
3109 | |||
3093 | bkms = self.db.get('bookmarks',{}) |
|
3110 | bkms = self.db.get('bookmarks',{}) | |
3094 |
|
3111 | |||
3095 | if opts.has_key('d'): |
|
3112 | if opts.has_key('d'): | |
3096 | try: |
|
3113 | try: | |
3097 | todel = args[0] |
|
3114 | todel = args[0] | |
3098 | except IndexError: |
|
3115 | except IndexError: | |
3099 | raise UsageError( |
|
3116 | raise UsageError( | |
3100 | "%bookmark -d: must provide a bookmark to delete") |
|
3117 | "%bookmark -d: must provide a bookmark to delete") | |
3101 | else: |
|
3118 | else: | |
3102 | try: |
|
3119 | try: | |
3103 | del bkms[todel] |
|
3120 | del bkms[todel] | |
3104 | except KeyError: |
|
3121 | except KeyError: | |
3105 | raise UsageError( |
|
3122 | raise UsageError( | |
3106 | "%%bookmark -d: Can't delete bookmark '%s'" % todel) |
|
3123 | "%%bookmark -d: Can't delete bookmark '%s'" % todel) | |
3107 |
|
3124 | |||
3108 | elif opts.has_key('r'): |
|
3125 | elif opts.has_key('r'): | |
3109 | bkms = {} |
|
3126 | bkms = {} | |
3110 | elif opts.has_key('l'): |
|
3127 | elif opts.has_key('l'): | |
3111 | bks = bkms.keys() |
|
3128 | bks = bkms.keys() | |
3112 | bks.sort() |
|
3129 | bks.sort() | |
3113 | if bks: |
|
3130 | if bks: | |
3114 | size = max(map(len,bks)) |
|
3131 | size = max(map(len,bks)) | |
3115 | else: |
|
3132 | else: | |
3116 | size = 0 |
|
3133 | size = 0 | |
3117 | fmt = '%-'+str(size)+'s -> %s' |
|
3134 | fmt = '%-'+str(size)+'s -> %s' | |
3118 | print 'Current bookmarks:' |
|
3135 | print 'Current bookmarks:' | |
3119 | for bk in bks: |
|
3136 | for bk in bks: | |
3120 | print fmt % (bk,bkms[bk]) |
|
3137 | print fmt % (bk,bkms[bk]) | |
3121 | else: |
|
3138 | else: | |
3122 | if not args: |
|
3139 | if not args: | |
3123 | raise UsageError("%bookmark: You must specify the bookmark name") |
|
3140 | raise UsageError("%bookmark: You must specify the bookmark name") | |
3124 | elif len(args)==1: |
|
3141 | elif len(args)==1: | |
3125 | bkms[args[0]] = os.getcwd() |
|
3142 | bkms[args[0]] = os.getcwd() | |
3126 | elif len(args)==2: |
|
3143 | elif len(args)==2: | |
3127 | bkms[args[0]] = args[1] |
|
3144 | bkms[args[0]] = args[1] | |
3128 | self.db['bookmarks'] = bkms |
|
3145 | self.db['bookmarks'] = bkms | |
3129 |
|
3146 | |||
3130 | def magic_pycat(self, parameter_s=''): |
|
3147 | def magic_pycat(self, parameter_s=''): | |
3131 | """Show a syntax-highlighted file through a pager. |
|
3148 | """Show a syntax-highlighted file through a pager. | |
3132 |
|
3149 | |||
3133 | This magic is similar to the cat utility, but it will assume the file |
|
3150 | This magic is similar to the cat utility, but it will assume the file | |
3134 | to be Python source and will show it with syntax highlighting. """ |
|
3151 | to be Python source and will show it with syntax highlighting. """ | |
3135 |
|
3152 | |||
3136 | try: |
|
3153 | try: | |
3137 | filename = get_py_filename(parameter_s) |
|
3154 | filename = get_py_filename(parameter_s) | |
3138 | cont = file_read(filename) |
|
3155 | cont = file_read(filename) | |
3139 | except IOError: |
|
3156 | except IOError: | |
3140 | try: |
|
3157 | try: | |
3141 | cont = eval(parameter_s,self.user_ns) |
|
3158 | cont = eval(parameter_s,self.user_ns) | |
3142 | except NameError: |
|
3159 | except NameError: | |
3143 | cont = None |
|
3160 | cont = None | |
3144 | if cont is None: |
|
3161 | if cont is None: | |
3145 | print "Error: no such file or variable" |
|
3162 | print "Error: no such file or variable" | |
3146 | return |
|
3163 | return | |
3147 |
|
3164 | |||
3148 | page(self.shell.pycolorize(cont), |
|
3165 | page(self.shell.pycolorize(cont), | |
3149 | screen_lines=self.shell.rc.screen_length) |
|
3166 | screen_lines=self.shell.rc.screen_length) | |
3150 |
|
3167 | |||
3151 | def magic_cpaste(self, parameter_s=''): |
|
3168 | def magic_cpaste(self, parameter_s=''): | |
3152 | """Allows you to paste & execute a pre-formatted code block from clipboard. |
|
3169 | """Allows you to paste & execute a pre-formatted code block from clipboard. | |
3153 |
|
3170 | |||
3154 | You must terminate the block with '--' (two minus-signs) alone on the |
|
3171 | You must terminate the block with '--' (two minus-signs) alone on the | |
3155 | line. You can also provide your own sentinel with '%paste -s %%' ('%%' |
|
3172 | line. You can also provide your own sentinel with '%paste -s %%' ('%%' | |
3156 | is the new sentinel for this operation) |
|
3173 | is the new sentinel for this operation) | |
3157 |
|
3174 | |||
3158 | The block is dedented prior to execution to enable execution of method |
|
3175 | The block is dedented prior to execution to enable execution of method | |
3159 | definitions. '>' and '+' characters at the beginning of a line are |
|
3176 | definitions. '>' and '+' characters at the beginning of a line are | |
3160 | ignored, to allow pasting directly from e-mails, diff files and |
|
3177 | ignored, to allow pasting directly from e-mails, diff files and | |
3161 | doctests (the '...' continuation prompt is also stripped). The |
|
3178 | doctests (the '...' continuation prompt is also stripped). The | |
3162 | executed block is also assigned to variable named 'pasted_block' for |
|
3179 | executed block is also assigned to variable named 'pasted_block' for | |
3163 | later editing with '%edit pasted_block'. |
|
3180 | later editing with '%edit pasted_block'. | |
3164 |
|
3181 | |||
3165 | You can also pass a variable name as an argument, e.g. '%cpaste foo'. |
|
3182 | You can also pass a variable name as an argument, e.g. '%cpaste foo'. | |
3166 | This assigns the pasted block to variable 'foo' as string, without |
|
3183 | This assigns the pasted block to variable 'foo' as string, without | |
3167 | dedenting or executing it (preceding >>> and + is still stripped) |
|
3184 | dedenting or executing it (preceding >>> and + is still stripped) | |
3168 |
|
3185 | |||
3169 | Do not be alarmed by garbled output on Windows (it's a readline bug). |
|
3186 | Do not be alarmed by garbled output on Windows (it's a readline bug). | |
3170 | Just press enter and type -- (and press enter again) and the block |
|
3187 | Just press enter and type -- (and press enter again) and the block | |
3171 | will be what was just pasted. |
|
3188 | will be what was just pasted. | |
3172 |
|
3189 | |||
3173 | IPython statements (magics, shell escapes) are not supported (yet). |
|
3190 | IPython statements (magics, shell escapes) are not supported (yet). | |
3174 | """ |
|
3191 | """ | |
3175 | opts,args = self.parse_options(parameter_s,'s:',mode='string') |
|
3192 | opts,args = self.parse_options(parameter_s,'s:',mode='string') | |
3176 | par = args.strip() |
|
3193 | par = args.strip() | |
3177 | sentinel = opts.get('s','--') |
|
3194 | sentinel = opts.get('s','--') | |
3178 |
|
3195 | |||
3179 | # Regular expressions that declare text we strip from the input: |
|
3196 | # Regular expressions that declare text we strip from the input: | |
3180 | strip_re = [r'^\s*In \[\d+\]:', # IPython input prompt |
|
3197 | strip_re = [r'^\s*In \[\d+\]:', # IPython input prompt | |
3181 | r'^\s*(\s?>)+', # Python input prompt |
|
3198 | r'^\s*(\s?>)+', # Python input prompt | |
3182 | r'^\s*\.{3,}', # Continuation prompts |
|
3199 | r'^\s*\.{3,}', # Continuation prompts | |
3183 | r'^\++', |
|
3200 | r'^\++', | |
3184 | ] |
|
3201 | ] | |
3185 |
|
3202 | |||
3186 | strip_from_start = map(re.compile,strip_re) |
|
3203 | strip_from_start = map(re.compile,strip_re) | |
3187 |
|
3204 | |||
3188 | from IPython import iplib |
|
3205 | from IPython import iplib | |
3189 | lines = [] |
|
3206 | lines = [] | |
3190 | print "Pasting code; enter '%s' alone on the line to stop." % sentinel |
|
3207 | print "Pasting code; enter '%s' alone on the line to stop." % sentinel | |
3191 | while 1: |
|
3208 | while 1: | |
3192 | l = iplib.raw_input_original(':') |
|
3209 | l = iplib.raw_input_original(':') | |
3193 | if l ==sentinel: |
|
3210 | if l ==sentinel: | |
3194 | break |
|
3211 | break | |
3195 |
|
3212 | |||
3196 | for pat in strip_from_start: |
|
3213 | for pat in strip_from_start: | |
3197 | l = pat.sub('',l) |
|
3214 | l = pat.sub('',l) | |
3198 | lines.append(l) |
|
3215 | lines.append(l) | |
3199 |
|
3216 | |||
3200 | block = "\n".join(lines) + '\n' |
|
3217 | block = "\n".join(lines) + '\n' | |
3201 | #print "block:\n",block |
|
3218 | #print "block:\n",block | |
3202 | if not par: |
|
3219 | if not par: | |
3203 | b = textwrap.dedent(block) |
|
3220 | b = textwrap.dedent(block) | |
3204 | exec b in self.user_ns |
|
3221 | exec b in self.user_ns | |
3205 | self.user_ns['pasted_block'] = b |
|
3222 | self.user_ns['pasted_block'] = b | |
3206 | else: |
|
3223 | else: | |
3207 | self.user_ns[par] = SList(block.splitlines()) |
|
3224 | self.user_ns[par] = SList(block.splitlines()) | |
3208 | print "Block assigned to '%s'" % par |
|
3225 | print "Block assigned to '%s'" % par | |
3209 |
|
3226 | |||
3210 | def magic_quickref(self,arg): |
|
3227 | def magic_quickref(self,arg): | |
3211 | """ Show a quick reference sheet """ |
|
3228 | """ Show a quick reference sheet """ | |
3212 | import IPython.usage |
|
3229 | import IPython.usage | |
3213 | qr = IPython.usage.quick_reference + self.magic_magic('-brief') |
|
3230 | qr = IPython.usage.quick_reference + self.magic_magic('-brief') | |
3214 |
|
3231 | |||
3215 | page(qr) |
|
3232 | page(qr) | |
3216 |
|
3233 | |||
3217 | def magic_upgrade(self,arg): |
|
3234 | def magic_upgrade(self,arg): | |
3218 | """ Upgrade your IPython installation |
|
3235 | """ Upgrade your IPython installation | |
3219 |
|
3236 | |||
3220 | This will copy the config files that don't yet exist in your |
|
3237 | This will copy the config files that don't yet exist in your | |
3221 | ipython dir from the system config dir. Use this after upgrading |
|
3238 | ipython dir from the system config dir. Use this after upgrading | |
3222 | IPython if you don't wish to delete your .ipython dir. |
|
3239 | IPython if you don't wish to delete your .ipython dir. | |
3223 |
|
3240 | |||
3224 | Call with -nolegacy to get rid of ipythonrc* files (recommended for |
|
3241 | Call with -nolegacy to get rid of ipythonrc* files (recommended for | |
3225 | new users) |
|
3242 | new users) | |
3226 |
|
3243 | |||
3227 | """ |
|
3244 | """ | |
3228 | ip = self.getapi() |
|
3245 | ip = self.getapi() | |
3229 | ipinstallation = path(IPython.__file__).dirname() |
|
3246 | ipinstallation = path(IPython.__file__).dirname() | |
3230 | upgrade_script = '%s "%s"' % (sys.executable,ipinstallation / 'upgrade_dir.py') |
|
3247 | upgrade_script = '%s "%s"' % (sys.executable,ipinstallation / 'upgrade_dir.py') | |
3231 | src_config = ipinstallation / 'UserConfig' |
|
3248 | src_config = ipinstallation / 'UserConfig' | |
3232 | userdir = path(ip.options.ipythondir) |
|
3249 | userdir = path(ip.options.ipythondir) | |
3233 | cmd = '%s "%s" "%s"' % (upgrade_script, src_config, userdir) |
|
3250 | cmd = '%s "%s" "%s"' % (upgrade_script, src_config, userdir) | |
3234 | print ">",cmd |
|
3251 | print ">",cmd | |
3235 | shell(cmd) |
|
3252 | shell(cmd) | |
3236 | if arg == '-nolegacy': |
|
3253 | if arg == '-nolegacy': | |
3237 | legacy = userdir.files('ipythonrc*') |
|
3254 | legacy = userdir.files('ipythonrc*') | |
3238 | print "Nuking legacy files:",legacy |
|
3255 | print "Nuking legacy files:",legacy | |
3239 |
|
3256 | |||
3240 | [p.remove() for p in legacy] |
|
3257 | [p.remove() for p in legacy] | |
3241 | suffix = (sys.platform == 'win32' and '.ini' or '') |
|
3258 | suffix = (sys.platform == 'win32' and '.ini' or '') | |
3242 | (userdir / ('ipythonrc' + suffix)).write_text('# Empty, see ipy_user_conf.py\n') |
|
3259 | (userdir / ('ipythonrc' + suffix)).write_text('# Empty, see ipy_user_conf.py\n') | |
3243 |
|
3260 | |||
3244 |
|
3261 | |||
3245 | def magic_doctest_mode(self,parameter_s=''): |
|
3262 | def magic_doctest_mode(self,parameter_s=''): | |
3246 | """Toggle doctest mode on and off. |
|
3263 | """Toggle doctest mode on and off. | |
3247 |
|
3264 | |||
3248 | This mode allows you to toggle the prompt behavior between normal |
|
3265 | This mode allows you to toggle the prompt behavior between normal | |
3249 | IPython prompts and ones that are as similar to the default IPython |
|
3266 | IPython prompts and ones that are as similar to the default IPython | |
3250 | interpreter as possible. |
|
3267 | interpreter as possible. | |
3251 |
|
3268 | |||
3252 | It also supports the pasting of code snippets that have leading '>>>' |
|
3269 | It also supports the pasting of code snippets that have leading '>>>' | |
3253 | and '...' prompts in them. This means that you can paste doctests from |
|
3270 | and '...' prompts in them. This means that you can paste doctests from | |
3254 | files or docstrings (even if they have leading whitespace), and the |
|
3271 | files or docstrings (even if they have leading whitespace), and the | |
3255 | code will execute correctly. You can then use '%history -tn' to see |
|
3272 | code will execute correctly. You can then use '%history -tn' to see | |
3256 | the translated history without line numbers; this will give you the |
|
3273 | the translated history without line numbers; this will give you the | |
3257 | input after removal of all the leading prompts and whitespace, which |
|
3274 | input after removal of all the leading prompts and whitespace, which | |
3258 | can be pasted back into an editor. |
|
3275 | can be pasted back into an editor. | |
3259 |
|
3276 | |||
3260 | With these features, you can switch into this mode easily whenever you |
|
3277 | With these features, you can switch into this mode easily whenever you | |
3261 | need to do testing and changes to doctests, without having to leave |
|
3278 | need to do testing and changes to doctests, without having to leave | |
3262 | your existing IPython session. |
|
3279 | your existing IPython session. | |
3263 | """ |
|
3280 | """ | |
3264 |
|
3281 | |||
3265 | # XXX - Fix this to have cleaner activate/deactivate calls. |
|
3282 | # XXX - Fix this to have cleaner activate/deactivate calls. | |
3266 | from IPython.Extensions import InterpreterPasteInput as ipaste |
|
3283 | from IPython.Extensions import InterpreterPasteInput as ipaste | |
3267 | from IPython.ipstruct import Struct |
|
3284 | from IPython.ipstruct import Struct | |
3268 |
|
3285 | |||
3269 | # Shorthands |
|
3286 | # Shorthands | |
3270 | shell = self.shell |
|
3287 | shell = self.shell | |
3271 | oc = shell.outputcache |
|
3288 | oc = shell.outputcache | |
3272 | rc = shell.rc |
|
3289 | rc = shell.rc | |
3273 | meta = shell.meta |
|
3290 | meta = shell.meta | |
3274 | # dstore is a data store kept in the instance metadata bag to track any |
|
3291 | # dstore is a data store kept in the instance metadata bag to track any | |
3275 | # changes we make, so we can undo them later. |
|
3292 | # changes we make, so we can undo them later. | |
3276 | dstore = meta.setdefault('doctest_mode',Struct()) |
|
3293 | dstore = meta.setdefault('doctest_mode',Struct()) | |
3277 | save_dstore = dstore.setdefault |
|
3294 | save_dstore = dstore.setdefault | |
3278 |
|
3295 | |||
3279 | # save a few values we'll need to recover later |
|
3296 | # save a few values we'll need to recover later | |
3280 | mode = save_dstore('mode',False) |
|
3297 | mode = save_dstore('mode',False) | |
3281 | save_dstore('rc_pprint',rc.pprint) |
|
3298 | save_dstore('rc_pprint',rc.pprint) | |
3282 | save_dstore('xmode',shell.InteractiveTB.mode) |
|
3299 | save_dstore('xmode',shell.InteractiveTB.mode) | |
3283 | save_dstore('rc_separate_out',rc.separate_out) |
|
3300 | save_dstore('rc_separate_out',rc.separate_out) | |
3284 | save_dstore('rc_separate_out2',rc.separate_out2) |
|
3301 | save_dstore('rc_separate_out2',rc.separate_out2) | |
3285 | save_dstore('rc_prompts_pad_left',rc.prompts_pad_left) |
|
3302 | save_dstore('rc_prompts_pad_left',rc.prompts_pad_left) | |
3286 | save_dstore('rc_separate_in',rc.separate_in) |
|
3303 | save_dstore('rc_separate_in',rc.separate_in) | |
3287 |
|
3304 | |||
3288 | if mode == False: |
|
3305 | if mode == False: | |
3289 | # turn on |
|
3306 | # turn on | |
3290 | ipaste.activate_prefilter() |
|
3307 | ipaste.activate_prefilter() | |
3291 |
|
3308 | |||
3292 | oc.prompt1.p_template = '>>> ' |
|
3309 | oc.prompt1.p_template = '>>> ' | |
3293 | oc.prompt2.p_template = '... ' |
|
3310 | oc.prompt2.p_template = '... ' | |
3294 | oc.prompt_out.p_template = '' |
|
3311 | oc.prompt_out.p_template = '' | |
3295 |
|
3312 | |||
3296 | # Prompt separators like plain python |
|
3313 | # Prompt separators like plain python | |
3297 | oc.input_sep = oc.prompt1.sep = '' |
|
3314 | oc.input_sep = oc.prompt1.sep = '' | |
3298 | oc.output_sep = '' |
|
3315 | oc.output_sep = '' | |
3299 | oc.output_sep2 = '' |
|
3316 | oc.output_sep2 = '' | |
3300 |
|
3317 | |||
3301 | oc.prompt1.pad_left = oc.prompt2.pad_left = \ |
|
3318 | oc.prompt1.pad_left = oc.prompt2.pad_left = \ | |
3302 | oc.prompt_out.pad_left = False |
|
3319 | oc.prompt_out.pad_left = False | |
3303 |
|
3320 | |||
3304 | rc.pprint = False |
|
3321 | rc.pprint = False | |
3305 |
|
3322 | |||
3306 | shell.magic_xmode('Plain') |
|
3323 | shell.magic_xmode('Plain') | |
3307 |
|
3324 | |||
3308 | else: |
|
3325 | else: | |
3309 | # turn off |
|
3326 | # turn off | |
3310 | ipaste.deactivate_prefilter() |
|
3327 | ipaste.deactivate_prefilter() | |
3311 |
|
3328 | |||
3312 | oc.prompt1.p_template = rc.prompt_in1 |
|
3329 | oc.prompt1.p_template = rc.prompt_in1 | |
3313 | oc.prompt2.p_template = rc.prompt_in2 |
|
3330 | oc.prompt2.p_template = rc.prompt_in2 | |
3314 | oc.prompt_out.p_template = rc.prompt_out |
|
3331 | oc.prompt_out.p_template = rc.prompt_out | |
3315 |
|
3332 | |||
3316 | oc.input_sep = oc.prompt1.sep = dstore.rc_separate_in |
|
3333 | oc.input_sep = oc.prompt1.sep = dstore.rc_separate_in | |
3317 |
|
3334 | |||
3318 | oc.output_sep = dstore.rc_separate_out |
|
3335 | oc.output_sep = dstore.rc_separate_out | |
3319 | oc.output_sep2 = dstore.rc_separate_out2 |
|
3336 | oc.output_sep2 = dstore.rc_separate_out2 | |
3320 |
|
3337 | |||
3321 | oc.prompt1.pad_left = oc.prompt2.pad_left = \ |
|
3338 | oc.prompt1.pad_left = oc.prompt2.pad_left = \ | |
3322 | oc.prompt_out.pad_left = dstore.rc_prompts_pad_left |
|
3339 | oc.prompt_out.pad_left = dstore.rc_prompts_pad_left | |
3323 |
|
3340 | |||
3324 | rc.pprint = dstore.rc_pprint |
|
3341 | rc.pprint = dstore.rc_pprint | |
3325 |
|
3342 | |||
3326 | shell.magic_xmode(dstore.xmode) |
|
3343 | shell.magic_xmode(dstore.xmode) | |
3327 |
|
3344 | |||
3328 | # Store new mode and inform |
|
3345 | # Store new mode and inform | |
3329 | dstore.mode = bool(1-int(mode)) |
|
3346 | dstore.mode = bool(1-int(mode)) | |
3330 | print 'Doctest mode is:', |
|
3347 | print 'Doctest mode is:', | |
3331 | print ['OFF','ON'][dstore.mode] |
|
3348 | print ['OFF','ON'][dstore.mode] | |
3332 |
|
3349 | |||
3333 | # end Magic |
|
3350 | # end Magic |
@@ -1,2691 +1,2691 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """ |
|
2 | """ | |
3 | IPython -- An enhanced Interactive Python |
|
3 | IPython -- An enhanced Interactive Python | |
4 |
|
4 | |||
5 | Requires Python 2.3 or newer. |
|
5 | Requires Python 2.3 or newer. | |
6 |
|
6 | |||
7 | This file contains all the classes and helper functions specific to IPython. |
|
7 | This file contains all the classes and helper functions specific to IPython. | |
8 |
|
8 | |||
9 | """ |
|
9 | """ | |
10 |
|
10 | |||
11 | #***************************************************************************** |
|
11 | #***************************************************************************** | |
12 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and |
|
12 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and | |
13 | # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu> |
|
13 | # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu> | |
14 | # |
|
14 | # | |
15 | # Distributed under the terms of the BSD License. The full license is in |
|
15 | # Distributed under the terms of the BSD License. The full license is in | |
16 | # the file COPYING, distributed as part of this software. |
|
16 | # the file COPYING, distributed as part of this software. | |
17 | # |
|
17 | # | |
18 | # Note: this code originally subclassed code.InteractiveConsole from the |
|
18 | # Note: this code originally subclassed code.InteractiveConsole from the | |
19 | # Python standard library. Over time, all of that class has been copied |
|
19 | # Python standard library. Over time, all of that class has been copied | |
20 | # verbatim here for modifications which could not be accomplished by |
|
20 | # verbatim here for modifications which could not be accomplished by | |
21 | # subclassing. At this point, there are no dependencies at all on the code |
|
21 | # subclassing. At this point, there are no dependencies at all on the code | |
22 | # module anymore (it is not even imported). The Python License (sec. 2) |
|
22 | # module anymore (it is not even imported). The Python License (sec. 2) | |
23 | # allows for this, but it's always nice to acknowledge credit where credit is |
|
23 | # allows for this, but it's always nice to acknowledge credit where credit is | |
24 | # due. |
|
24 | # due. | |
25 | #***************************************************************************** |
|
25 | #***************************************************************************** | |
26 |
|
26 | |||
27 | #**************************************************************************** |
|
27 | #**************************************************************************** | |
28 | # Modules and globals |
|
28 | # Modules and globals | |
29 |
|
29 | |||
30 | from IPython import Release |
|
30 | from IPython import Release | |
31 | __author__ = '%s <%s>\n%s <%s>' % \ |
|
31 | __author__ = '%s <%s>\n%s <%s>' % \ | |
32 | ( Release.authors['Janko'] + Release.authors['Fernando'] ) |
|
32 | ( Release.authors['Janko'] + Release.authors['Fernando'] ) | |
33 | __license__ = Release.license |
|
33 | __license__ = Release.license | |
34 | __version__ = Release.version |
|
34 | __version__ = Release.version | |
35 |
|
35 | |||
36 | # Python standard modules |
|
36 | # Python standard modules | |
37 | import __main__ |
|
37 | import __main__ | |
38 | import __builtin__ |
|
38 | import __builtin__ | |
39 | import StringIO |
|
39 | import StringIO | |
40 | import bdb |
|
40 | import bdb | |
41 | import cPickle as pickle |
|
41 | import cPickle as pickle | |
42 | import codeop |
|
42 | import codeop | |
43 | import exceptions |
|
43 | import exceptions | |
44 | import glob |
|
44 | import glob | |
45 | import inspect |
|
45 | import inspect | |
46 | import keyword |
|
46 | import keyword | |
47 | import new |
|
47 | import new | |
48 | import os |
|
48 | import os | |
49 | import pydoc |
|
49 | import pydoc | |
50 | import re |
|
50 | import re | |
51 | import shutil |
|
51 | import shutil | |
52 | import string |
|
52 | import string | |
53 | import sys |
|
53 | import sys | |
54 | import tempfile |
|
54 | import tempfile | |
55 | import traceback |
|
55 | import traceback | |
56 | import types |
|
56 | import types | |
57 | import warnings |
|
57 | import warnings | |
58 | warnings.filterwarnings('ignore', r'.*sets module*') |
|
58 | warnings.filterwarnings('ignore', r'.*sets module*') | |
59 | from sets import Set |
|
59 | from sets import Set | |
60 | from pprint import pprint, pformat |
|
60 | from pprint import pprint, pformat | |
61 |
|
61 | |||
62 | # IPython's own modules |
|
62 | # IPython's own modules | |
63 | #import IPython |
|
63 | #import IPython | |
64 | from IPython import Debugger,OInspect,PyColorize,ultraTB |
|
64 | from IPython import Debugger,OInspect,PyColorize,ultraTB | |
65 | from IPython.ColorANSI import ColorScheme,ColorSchemeTable # too long names |
|
65 | from IPython.ColorANSI import ColorScheme,ColorSchemeTable # too long names | |
66 | from IPython.Extensions import pickleshare |
|
66 | from IPython.Extensions import pickleshare | |
67 | from IPython.FakeModule import FakeModule |
|
67 | from IPython.FakeModule import FakeModule | |
68 | from IPython.Itpl import Itpl,itpl,printpl,ItplNS,itplns |
|
68 | from IPython.Itpl import Itpl,itpl,printpl,ItplNS,itplns | |
69 | from IPython.Logger import Logger |
|
69 | from IPython.Logger import Logger | |
70 | from IPython.Magic import Magic |
|
70 | from IPython.Magic import Magic | |
71 | from IPython.Prompts import CachedOutput |
|
71 | from IPython.Prompts import CachedOutput | |
72 | from IPython.ipstruct import Struct |
|
72 | from IPython.ipstruct import Struct | |
73 | from IPython.background_jobs import BackgroundJobManager |
|
73 | from IPython.background_jobs import BackgroundJobManager | |
74 | from IPython.usage import cmd_line_usage,interactive_usage |
|
74 | from IPython.usage import cmd_line_usage,interactive_usage | |
75 | from IPython.genutils import * |
|
75 | from IPython.genutils import * | |
76 | from IPython.strdispatch import StrDispatch |
|
76 | from IPython.strdispatch import StrDispatch | |
77 | import IPython.ipapi |
|
77 | import IPython.ipapi | |
78 | import IPython.history |
|
78 | import IPython.history | |
79 | import IPython.prefilter as prefilter |
|
79 | import IPython.prefilter as prefilter | |
80 | import IPython.shadowns |
|
80 | import IPython.shadowns | |
81 | # Globals |
|
81 | # Globals | |
82 |
|
82 | |||
83 | # store the builtin raw_input globally, and use this always, in case user code |
|
83 | # store the builtin raw_input globally, and use this always, in case user code | |
84 | # overwrites it (like wx.py.PyShell does) |
|
84 | # overwrites it (like wx.py.PyShell does) | |
85 | raw_input_original = raw_input |
|
85 | raw_input_original = raw_input | |
86 |
|
86 | |||
87 | # compiled regexps for autoindent management |
|
87 | # compiled regexps for autoindent management | |
88 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') |
|
88 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') | |
89 |
|
89 | |||
90 |
|
90 | |||
91 | #**************************************************************************** |
|
91 | #**************************************************************************** | |
92 | # Some utility function definitions |
|
92 | # Some utility function definitions | |
93 |
|
93 | |||
94 | ini_spaces_re = re.compile(r'^(\s+)') |
|
94 | ini_spaces_re = re.compile(r'^(\s+)') | |
95 |
|
95 | |||
96 | def num_ini_spaces(strng): |
|
96 | def num_ini_spaces(strng): | |
97 | """Return the number of initial spaces in a string""" |
|
97 | """Return the number of initial spaces in a string""" | |
98 |
|
98 | |||
99 | ini_spaces = ini_spaces_re.match(strng) |
|
99 | ini_spaces = ini_spaces_re.match(strng) | |
100 | if ini_spaces: |
|
100 | if ini_spaces: | |
101 | return ini_spaces.end() |
|
101 | return ini_spaces.end() | |
102 | else: |
|
102 | else: | |
103 | return 0 |
|
103 | return 0 | |
104 |
|
104 | |||
105 | def softspace(file, newvalue): |
|
105 | def softspace(file, newvalue): | |
106 | """Copied from code.py, to remove the dependency""" |
|
106 | """Copied from code.py, to remove the dependency""" | |
107 |
|
107 | |||
108 | oldvalue = 0 |
|
108 | oldvalue = 0 | |
109 | try: |
|
109 | try: | |
110 | oldvalue = file.softspace |
|
110 | oldvalue = file.softspace | |
111 | except AttributeError: |
|
111 | except AttributeError: | |
112 | pass |
|
112 | pass | |
113 | try: |
|
113 | try: | |
114 | file.softspace = newvalue |
|
114 | file.softspace = newvalue | |
115 | except (AttributeError, TypeError): |
|
115 | except (AttributeError, TypeError): | |
116 | # "attribute-less object" or "read-only attributes" |
|
116 | # "attribute-less object" or "read-only attributes" | |
117 | pass |
|
117 | pass | |
118 | return oldvalue |
|
118 | return oldvalue | |
119 |
|
119 | |||
120 |
|
120 | |||
121 | #**************************************************************************** |
|
121 | #**************************************************************************** | |
122 | # Local use exceptions |
|
122 | # Local use exceptions | |
123 | class SpaceInInput(exceptions.Exception): pass |
|
123 | class SpaceInInput(exceptions.Exception): pass | |
124 |
|
124 | |||
125 |
|
125 | |||
126 | #**************************************************************************** |
|
126 | #**************************************************************************** | |
127 | # Local use classes |
|
127 | # Local use classes | |
128 | class Bunch: pass |
|
128 | class Bunch: pass | |
129 |
|
129 | |||
130 | class Undefined: pass |
|
130 | class Undefined: pass | |
131 |
|
131 | |||
132 | class Quitter(object): |
|
132 | class Quitter(object): | |
133 | """Simple class to handle exit, similar to Python 2.5's. |
|
133 | """Simple class to handle exit, similar to Python 2.5's. | |
134 |
|
134 | |||
135 | It handles exiting in an ipython-safe manner, which the one in Python 2.5 |
|
135 | It handles exiting in an ipython-safe manner, which the one in Python 2.5 | |
136 | doesn't do (obviously, since it doesn't know about ipython).""" |
|
136 | doesn't do (obviously, since it doesn't know about ipython).""" | |
137 |
|
137 | |||
138 | def __init__(self,shell,name): |
|
138 | def __init__(self,shell,name): | |
139 | self.shell = shell |
|
139 | self.shell = shell | |
140 | self.name = name |
|
140 | self.name = name | |
141 |
|
141 | |||
142 | def __repr__(self): |
|
142 | def __repr__(self): | |
143 | return 'Type %s() to exit.' % self.name |
|
143 | return 'Type %s() to exit.' % self.name | |
144 | __str__ = __repr__ |
|
144 | __str__ = __repr__ | |
145 |
|
145 | |||
146 | def __call__(self): |
|
146 | def __call__(self): | |
147 | self.shell.exit() |
|
147 | self.shell.exit() | |
148 |
|
148 | |||
149 | class InputList(list): |
|
149 | class InputList(list): | |
150 | """Class to store user input. |
|
150 | """Class to store user input. | |
151 |
|
151 | |||
152 | It's basically a list, but slices return a string instead of a list, thus |
|
152 | It's basically a list, but slices return a string instead of a list, thus | |
153 | allowing things like (assuming 'In' is an instance): |
|
153 | allowing things like (assuming 'In' is an instance): | |
154 |
|
154 | |||
155 | exec In[4:7] |
|
155 | exec In[4:7] | |
156 |
|
156 | |||
157 | or |
|
157 | or | |
158 |
|
158 | |||
159 | exec In[5:9] + In[14] + In[21:25]""" |
|
159 | exec In[5:9] + In[14] + In[21:25]""" | |
160 |
|
160 | |||
161 | def __getslice__(self,i,j): |
|
161 | def __getslice__(self,i,j): | |
162 | return ''.join(list.__getslice__(self,i,j)) |
|
162 | return ''.join(list.__getslice__(self,i,j)) | |
163 |
|
163 | |||
164 | class SyntaxTB(ultraTB.ListTB): |
|
164 | class SyntaxTB(ultraTB.ListTB): | |
165 | """Extension which holds some state: the last exception value""" |
|
165 | """Extension which holds some state: the last exception value""" | |
166 |
|
166 | |||
167 | def __init__(self,color_scheme = 'NoColor'): |
|
167 | def __init__(self,color_scheme = 'NoColor'): | |
168 | ultraTB.ListTB.__init__(self,color_scheme) |
|
168 | ultraTB.ListTB.__init__(self,color_scheme) | |
169 | self.last_syntax_error = None |
|
169 | self.last_syntax_error = None | |
170 |
|
170 | |||
171 | def __call__(self, etype, value, elist): |
|
171 | def __call__(self, etype, value, elist): | |
172 | self.last_syntax_error = value |
|
172 | self.last_syntax_error = value | |
173 | ultraTB.ListTB.__call__(self,etype,value,elist) |
|
173 | ultraTB.ListTB.__call__(self,etype,value,elist) | |
174 |
|
174 | |||
175 | def clear_err_state(self): |
|
175 | def clear_err_state(self): | |
176 | """Return the current error state and clear it""" |
|
176 | """Return the current error state and clear it""" | |
177 | e = self.last_syntax_error |
|
177 | e = self.last_syntax_error | |
178 | self.last_syntax_error = None |
|
178 | self.last_syntax_error = None | |
179 | return e |
|
179 | return e | |
180 |
|
180 | |||
181 | #**************************************************************************** |
|
181 | #**************************************************************************** | |
182 | # Main IPython class |
|
182 | # Main IPython class | |
183 |
|
183 | |||
184 | # FIXME: the Magic class is a mixin for now, and will unfortunately remain so |
|
184 | # FIXME: the Magic class is a mixin for now, and will unfortunately remain so | |
185 | # until a full rewrite is made. I've cleaned all cross-class uses of |
|
185 | # until a full rewrite is made. I've cleaned all cross-class uses of | |
186 | # attributes and methods, but too much user code out there relies on the |
|
186 | # attributes and methods, but too much user code out there relies on the | |
187 | # equlity %foo == __IP.magic_foo, so I can't actually remove the mixin usage. |
|
187 | # equlity %foo == __IP.magic_foo, so I can't actually remove the mixin usage. | |
188 | # |
|
188 | # | |
189 | # But at least now, all the pieces have been separated and we could, in |
|
189 | # But at least now, all the pieces have been separated and we could, in | |
190 | # principle, stop using the mixin. This will ease the transition to the |
|
190 | # principle, stop using the mixin. This will ease the transition to the | |
191 | # chainsaw branch. |
|
191 | # chainsaw branch. | |
192 |
|
192 | |||
193 | # For reference, the following is the list of 'self.foo' uses in the Magic |
|
193 | # For reference, the following is the list of 'self.foo' uses in the Magic | |
194 | # class as of 2005-12-28. These are names we CAN'T use in the main ipython |
|
194 | # class as of 2005-12-28. These are names we CAN'T use in the main ipython | |
195 | # class, to prevent clashes. |
|
195 | # class, to prevent clashes. | |
196 |
|
196 | |||
197 | # ['self.__class__', 'self.__dict__', 'self._inspect', 'self._ofind', |
|
197 | # ['self.__class__', 'self.__dict__', 'self._inspect', 'self._ofind', | |
198 | # 'self.arg_err', 'self.extract_input', 'self.format_', 'self.lsmagic', |
|
198 | # 'self.arg_err', 'self.extract_input', 'self.format_', 'self.lsmagic', | |
199 | # 'self.magic_', 'self.options_table', 'self.parse', 'self.shell', |
|
199 | # 'self.magic_', 'self.options_table', 'self.parse', 'self.shell', | |
200 | # 'self.value'] |
|
200 | # 'self.value'] | |
201 |
|
201 | |||
202 | class InteractiveShell(object,Magic): |
|
202 | class InteractiveShell(object,Magic): | |
203 | """An enhanced console for Python.""" |
|
203 | """An enhanced console for Python.""" | |
204 |
|
204 | |||
205 | # class attribute to indicate whether the class supports threads or not. |
|
205 | # class attribute to indicate whether the class supports threads or not. | |
206 | # Subclasses with thread support should override this as needed. |
|
206 | # Subclasses with thread support should override this as needed. | |
207 | isthreaded = False |
|
207 | isthreaded = False | |
208 |
|
208 | |||
209 | def __init__(self,name,usage=None,rc=Struct(opts=None,args=None), |
|
209 | def __init__(self,name,usage=None,rc=Struct(opts=None,args=None), | |
210 | user_ns = None,user_global_ns=None,banner2='', |
|
210 | user_ns = None,user_global_ns=None,banner2='', | |
211 | custom_exceptions=((),None),embedded=False): |
|
211 | custom_exceptions=((),None),embedded=False): | |
212 |
|
212 | |||
213 | # log system |
|
213 | # log system | |
214 | self.logger = Logger(self,logfname='ipython_log.py',logmode='rotate') |
|
214 | self.logger = Logger(self,logfname='ipython_log.py',logmode='rotate') | |
215 |
|
215 | |||
216 | # Job manager (for jobs run as background threads) |
|
216 | # Job manager (for jobs run as background threads) | |
217 | self.jobs = BackgroundJobManager() |
|
217 | self.jobs = BackgroundJobManager() | |
218 |
|
218 | |||
219 | # Store the actual shell's name |
|
219 | # Store the actual shell's name | |
220 | self.name = name |
|
220 | self.name = name | |
221 | self.more = False |
|
221 | self.more = False | |
222 |
|
222 | |||
223 | # We need to know whether the instance is meant for embedding, since |
|
223 | # We need to know whether the instance is meant for embedding, since | |
224 | # global/local namespaces need to be handled differently in that case |
|
224 | # global/local namespaces need to be handled differently in that case | |
225 | self.embedded = embedded |
|
225 | self.embedded = embedded | |
226 | if embedded: |
|
226 | if embedded: | |
227 | # Control variable so users can, from within the embedded instance, |
|
227 | # Control variable so users can, from within the embedded instance, | |
228 | # permanently deactivate it. |
|
228 | # permanently deactivate it. | |
229 | self.embedded_active = True |
|
229 | self.embedded_active = True | |
230 |
|
230 | |||
231 | # command compiler |
|
231 | # command compiler | |
232 | self.compile = codeop.CommandCompiler() |
|
232 | self.compile = codeop.CommandCompiler() | |
233 |
|
233 | |||
234 | # User input buffer |
|
234 | # User input buffer | |
235 | self.buffer = [] |
|
235 | self.buffer = [] | |
236 |
|
236 | |||
237 | # Default name given in compilation of code |
|
237 | # Default name given in compilation of code | |
238 | self.filename = '<ipython console>' |
|
238 | self.filename = '<ipython console>' | |
239 |
|
239 | |||
240 | # Install our own quitter instead of the builtins. For python2.3-2.4, |
|
240 | # Install our own quitter instead of the builtins. For python2.3-2.4, | |
241 | # this brings in behavior like 2.5, and for 2.5 it's identical. |
|
241 | # this brings in behavior like 2.5, and for 2.5 it's identical. | |
242 | __builtin__.exit = Quitter(self,'exit') |
|
242 | __builtin__.exit = Quitter(self,'exit') | |
243 | __builtin__.quit = Quitter(self,'quit') |
|
243 | __builtin__.quit = Quitter(self,'quit') | |
244 |
|
244 | |||
245 | # Make an empty namespace, which extension writers can rely on both |
|
245 | # Make an empty namespace, which extension writers can rely on both | |
246 | # existing and NEVER being used by ipython itself. This gives them a |
|
246 | # existing and NEVER being used by ipython itself. This gives them a | |
247 | # convenient location for storing additional information and state |
|
247 | # convenient location for storing additional information and state | |
248 | # their extensions may require, without fear of collisions with other |
|
248 | # their extensions may require, without fear of collisions with other | |
249 | # ipython names that may develop later. |
|
249 | # ipython names that may develop later. | |
250 | self.meta = Struct() |
|
250 | self.meta = Struct() | |
251 |
|
251 | |||
252 | # Create the namespace where the user will operate. user_ns is |
|
252 | # Create the namespace where the user will operate. user_ns is | |
253 | # normally the only one used, and it is passed to the exec calls as |
|
253 | # normally the only one used, and it is passed to the exec calls as | |
254 | # the locals argument. But we do carry a user_global_ns namespace |
|
254 | # the locals argument. But we do carry a user_global_ns namespace | |
255 | # given as the exec 'globals' argument, This is useful in embedding |
|
255 | # given as the exec 'globals' argument, This is useful in embedding | |
256 | # situations where the ipython shell opens in a context where the |
|
256 | # situations where the ipython shell opens in a context where the | |
257 | # distinction between locals and globals is meaningful. |
|
257 | # distinction between locals and globals is meaningful. | |
258 |
|
258 | |||
259 | # FIXME. For some strange reason, __builtins__ is showing up at user |
|
259 | # FIXME. For some strange reason, __builtins__ is showing up at user | |
260 | # level as a dict instead of a module. This is a manual fix, but I |
|
260 | # level as a dict instead of a module. This is a manual fix, but I | |
261 | # should really track down where the problem is coming from. Alex |
|
261 | # should really track down where the problem is coming from. Alex | |
262 | # Schmolck reported this problem first. |
|
262 | # Schmolck reported this problem first. | |
263 |
|
263 | |||
264 | # A useful post by Alex Martelli on this topic: |
|
264 | # A useful post by Alex Martelli on this topic: | |
265 | # Re: inconsistent value from __builtins__ |
|
265 | # Re: inconsistent value from __builtins__ | |
266 | # Von: Alex Martelli <aleaxit@yahoo.com> |
|
266 | # Von: Alex Martelli <aleaxit@yahoo.com> | |
267 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends |
|
267 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends | |
268 | # Gruppen: comp.lang.python |
|
268 | # Gruppen: comp.lang.python | |
269 |
|
269 | |||
270 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: |
|
270 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: | |
271 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) |
|
271 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) | |
272 | # > <type 'dict'> |
|
272 | # > <type 'dict'> | |
273 | # > >>> print type(__builtins__) |
|
273 | # > >>> print type(__builtins__) | |
274 | # > <type 'module'> |
|
274 | # > <type 'module'> | |
275 | # > Is this difference in return value intentional? |
|
275 | # > Is this difference in return value intentional? | |
276 |
|
276 | |||
277 | # Well, it's documented that '__builtins__' can be either a dictionary |
|
277 | # Well, it's documented that '__builtins__' can be either a dictionary | |
278 | # or a module, and it's been that way for a long time. Whether it's |
|
278 | # or a module, and it's been that way for a long time. Whether it's | |
279 | # intentional (or sensible), I don't know. In any case, the idea is |
|
279 | # intentional (or sensible), I don't know. In any case, the idea is | |
280 | # that if you need to access the built-in namespace directly, you |
|
280 | # that if you need to access the built-in namespace directly, you | |
281 | # should start with "import __builtin__" (note, no 's') which will |
|
281 | # should start with "import __builtin__" (note, no 's') which will | |
282 | # definitely give you a module. Yeah, it's somewhat confusing:-(. |
|
282 | # definitely give you a module. Yeah, it's somewhat confusing:-(. | |
283 |
|
283 | |||
284 | # These routines return properly built dicts as needed by the rest of |
|
284 | # These routines return properly built dicts as needed by the rest of | |
285 | # the code, and can also be used by extension writers to generate |
|
285 | # the code, and can also be used by extension writers to generate | |
286 | # properly initialized namespaces. |
|
286 | # properly initialized namespaces. | |
287 | user_ns = IPython.ipapi.make_user_ns(user_ns) |
|
287 | user_ns = IPython.ipapi.make_user_ns(user_ns) | |
288 | user_global_ns = IPython.ipapi.make_user_global_ns(user_global_ns) |
|
288 | user_global_ns = IPython.ipapi.make_user_global_ns(user_global_ns) | |
289 |
|
289 | |||
290 | # Assign namespaces |
|
290 | # Assign namespaces | |
291 | # This is the namespace where all normal user variables live |
|
291 | # This is the namespace where all normal user variables live | |
292 | self.user_ns = user_ns |
|
292 | self.user_ns = user_ns | |
293 | # Embedded instances require a separate namespace for globals. |
|
293 | # Embedded instances require a separate namespace for globals. | |
294 | # Normally this one is unused by non-embedded instances. |
|
294 | # Normally this one is unused by non-embedded instances. | |
295 | self.user_global_ns = user_global_ns |
|
295 | self.user_global_ns = user_global_ns | |
296 | # A namespace to keep track of internal data structures to prevent |
|
296 | # A namespace to keep track of internal data structures to prevent | |
297 | # them from cluttering user-visible stuff. Will be updated later |
|
297 | # them from cluttering user-visible stuff. Will be updated later | |
298 | self.internal_ns = {} |
|
298 | self.internal_ns = {} | |
299 |
|
299 | |||
300 | # Namespace of system aliases. Each entry in the alias |
|
300 | # Namespace of system aliases. Each entry in the alias | |
301 | # table must be a 2-tuple of the form (N,name), where N is the number |
|
301 | # table must be a 2-tuple of the form (N,name), where N is the number | |
302 | # of positional arguments of the alias. |
|
302 | # of positional arguments of the alias. | |
303 | self.alias_table = {} |
|
303 | self.alias_table = {} | |
304 |
|
304 | |||
305 | # A table holding all the namespaces IPython deals with, so that |
|
305 | # A table holding all the namespaces IPython deals with, so that | |
306 | # introspection facilities can search easily. |
|
306 | # introspection facilities can search easily. | |
307 | self.ns_table = {'user':user_ns, |
|
307 | self.ns_table = {'user':user_ns, | |
308 | 'user_global':user_global_ns, |
|
308 | 'user_global':user_global_ns, | |
309 | 'alias':self.alias_table, |
|
309 | 'alias':self.alias_table, | |
310 | 'internal':self.internal_ns, |
|
310 | 'internal':self.internal_ns, | |
311 | 'builtin':__builtin__.__dict__ |
|
311 | 'builtin':__builtin__.__dict__ | |
312 | } |
|
312 | } | |
313 | # The user namespace MUST have a pointer to the shell itself. |
|
313 | # The user namespace MUST have a pointer to the shell itself. | |
314 | self.user_ns[name] = self |
|
314 | self.user_ns[name] = self | |
315 |
|
315 | |||
316 | # We need to insert into sys.modules something that looks like a |
|
316 | # We need to insert into sys.modules something that looks like a | |
317 | # module but which accesses the IPython namespace, for shelve and |
|
317 | # module but which accesses the IPython namespace, for shelve and | |
318 | # pickle to work interactively. Normally they rely on getting |
|
318 | # pickle to work interactively. Normally they rely on getting | |
319 | # everything out of __main__, but for embedding purposes each IPython |
|
319 | # everything out of __main__, but for embedding purposes each IPython | |
320 | # instance has its own private namespace, so we can't go shoving |
|
320 | # instance has its own private namespace, so we can't go shoving | |
321 | # everything into __main__. |
|
321 | # everything into __main__. | |
322 |
|
322 | |||
323 | # note, however, that we should only do this for non-embedded |
|
323 | # note, however, that we should only do this for non-embedded | |
324 | # ipythons, which really mimic the __main__.__dict__ with their own |
|
324 | # ipythons, which really mimic the __main__.__dict__ with their own | |
325 | # namespace. Embedded instances, on the other hand, should not do |
|
325 | # namespace. Embedded instances, on the other hand, should not do | |
326 | # this because they need to manage the user local/global namespaces |
|
326 | # this because they need to manage the user local/global namespaces | |
327 | # only, but they live within a 'normal' __main__ (meaning, they |
|
327 | # only, but they live within a 'normal' __main__ (meaning, they | |
328 | # shouldn't overtake the execution environment of the script they're |
|
328 | # shouldn't overtake the execution environment of the script they're | |
329 | # embedded in). |
|
329 | # embedded in). | |
330 |
|
330 | |||
331 | if not embedded: |
|
331 | if not embedded: | |
332 | try: |
|
332 | try: | |
333 | main_name = self.user_ns['__name__'] |
|
333 | main_name = self.user_ns['__name__'] | |
334 | except KeyError: |
|
334 | except KeyError: | |
335 | raise KeyError,'user_ns dictionary MUST have a "__name__" key' |
|
335 | raise KeyError,'user_ns dictionary MUST have a "__name__" key' | |
336 | else: |
|
336 | else: | |
337 | #print "pickle hack in place" # dbg |
|
337 | #print "pickle hack in place" # dbg | |
338 | #print 'main_name:',main_name # dbg |
|
338 | #print 'main_name:',main_name # dbg | |
339 | sys.modules[main_name] = FakeModule(self.user_ns) |
|
339 | sys.modules[main_name] = FakeModule(self.user_ns) | |
340 |
|
340 | |||
341 | # Now that FakeModule produces a real module, we've run into a nasty |
|
341 | # Now that FakeModule produces a real module, we've run into a nasty | |
342 | # problem: after script execution (via %run), the module where the user |
|
342 | # problem: after script execution (via %run), the module where the user | |
343 | # code ran is deleted. Now that this object is a true module (needed |
|
343 | # code ran is deleted. Now that this object is a true module (needed | |
344 | # so docetst and other tools work correctly), the Python module |
|
344 | # so docetst and other tools work correctly), the Python module | |
345 | # teardown mechanism runs over it, and sets to None every variable |
|
345 | # teardown mechanism runs over it, and sets to None every variable | |
346 | # present in that module. This means that later calls to functions |
|
346 | # present in that module. This means that later calls to functions | |
347 | # defined in the script (which have become interactively visible after |
|
347 | # defined in the script (which have become interactively visible after | |
348 | # script exit) fail, because they hold references to objects that have |
|
348 | # script exit) fail, because they hold references to objects that have | |
349 | # become overwritten into None. The only solution I see right now is |
|
349 | # become overwritten into None. The only solution I see right now is | |
350 | # to protect every FakeModule used by %run by holding an internal |
|
350 | # to protect every FakeModule used by %run by holding an internal | |
351 | # reference to it. This private list will be used for that. The |
|
351 | # reference to it. This private list will be used for that. The | |
352 | # %reset command will flush it as well. |
|
352 | # %reset command will flush it as well. | |
353 | self._user_main_modules = [] |
|
353 | self._user_main_modules = [] | |
354 |
|
354 | |||
355 | # List of input with multi-line handling. |
|
355 | # List of input with multi-line handling. | |
356 | # Fill its zero entry, user counter starts at 1 |
|
356 | # Fill its zero entry, user counter starts at 1 | |
357 | self.input_hist = InputList(['\n']) |
|
357 | self.input_hist = InputList(['\n']) | |
358 | # This one will hold the 'raw' input history, without any |
|
358 | # This one will hold the 'raw' input history, without any | |
359 | # pre-processing. This will allow users to retrieve the input just as |
|
359 | # pre-processing. This will allow users to retrieve the input just as | |
360 | # it was exactly typed in by the user, with %hist -r. |
|
360 | # it was exactly typed in by the user, with %hist -r. | |
361 | self.input_hist_raw = InputList(['\n']) |
|
361 | self.input_hist_raw = InputList(['\n']) | |
362 |
|
362 | |||
363 | # list of visited directories |
|
363 | # list of visited directories | |
364 | try: |
|
364 | try: | |
365 | self.dir_hist = [os.getcwd()] |
|
365 | self.dir_hist = [os.getcwd()] | |
366 | except OSError: |
|
366 | except OSError: | |
367 | self.dir_hist = [] |
|
367 | self.dir_hist = [] | |
368 |
|
368 | |||
369 | # dict of output history |
|
369 | # dict of output history | |
370 | self.output_hist = {} |
|
370 | self.output_hist = {} | |
371 |
|
371 | |||
372 | # Get system encoding at startup time. Certain terminals (like Emacs |
|
372 | # Get system encoding at startup time. Certain terminals (like Emacs | |
373 | # under Win32 have it set to None, and we need to have a known valid |
|
373 | # under Win32 have it set to None, and we need to have a known valid | |
374 | # encoding to use in the raw_input() method |
|
374 | # encoding to use in the raw_input() method | |
375 | try: |
|
375 | try: | |
376 | self.stdin_encoding = sys.stdin.encoding or 'ascii' |
|
376 | self.stdin_encoding = sys.stdin.encoding or 'ascii' | |
377 | except AttributeError: |
|
377 | except AttributeError: | |
378 | self.stdin_encoding = 'ascii' |
|
378 | self.stdin_encoding = 'ascii' | |
379 |
|
379 | |||
380 | # dict of things NOT to alias (keywords, builtins and some magics) |
|
380 | # dict of things NOT to alias (keywords, builtins and some magics) | |
381 | no_alias = {} |
|
381 | no_alias = {} | |
382 | no_alias_magics = ['cd','popd','pushd','dhist','alias','unalias'] |
|
382 | no_alias_magics = ['cd','popd','pushd','dhist','alias','unalias'] | |
383 | for key in keyword.kwlist + no_alias_magics: |
|
383 | for key in keyword.kwlist + no_alias_magics: | |
384 | no_alias[key] = 1 |
|
384 | no_alias[key] = 1 | |
385 | no_alias.update(__builtin__.__dict__) |
|
385 | no_alias.update(__builtin__.__dict__) | |
386 | self.no_alias = no_alias |
|
386 | self.no_alias = no_alias | |
387 |
|
387 | |||
388 | # make global variables for user access to these |
|
388 | # make global variables for user access to these | |
389 | self.user_ns['_ih'] = self.input_hist |
|
389 | self.user_ns['_ih'] = self.input_hist | |
390 | self.user_ns['_oh'] = self.output_hist |
|
390 | self.user_ns['_oh'] = self.output_hist | |
391 | self.user_ns['_dh'] = self.dir_hist |
|
391 | self.user_ns['_dh'] = self.dir_hist | |
392 |
|
392 | |||
393 | # user aliases to input and output histories |
|
393 | # user aliases to input and output histories | |
394 | self.user_ns['In'] = self.input_hist |
|
394 | self.user_ns['In'] = self.input_hist | |
395 | self.user_ns['Out'] = self.output_hist |
|
395 | self.user_ns['Out'] = self.output_hist | |
396 |
|
396 | |||
397 | self.user_ns['_sh'] = IPython.shadowns |
|
397 | self.user_ns['_sh'] = IPython.shadowns | |
398 | # Object variable to store code object waiting execution. This is |
|
398 | # Object variable to store code object waiting execution. This is | |
399 | # used mainly by the multithreaded shells, but it can come in handy in |
|
399 | # used mainly by the multithreaded shells, but it can come in handy in | |
400 | # other situations. No need to use a Queue here, since it's a single |
|
400 | # other situations. No need to use a Queue here, since it's a single | |
401 | # item which gets cleared once run. |
|
401 | # item which gets cleared once run. | |
402 | self.code_to_run = None |
|
402 | self.code_to_run = None | |
403 |
|
403 | |||
404 | # escapes for automatic behavior on the command line |
|
404 | # escapes for automatic behavior on the command line | |
405 | self.ESC_SHELL = '!' |
|
405 | self.ESC_SHELL = '!' | |
406 | self.ESC_SH_CAP = '!!' |
|
406 | self.ESC_SH_CAP = '!!' | |
407 | self.ESC_HELP = '?' |
|
407 | self.ESC_HELP = '?' | |
408 | self.ESC_MAGIC = '%' |
|
408 | self.ESC_MAGIC = '%' | |
409 | self.ESC_QUOTE = ',' |
|
409 | self.ESC_QUOTE = ',' | |
410 | self.ESC_QUOTE2 = ';' |
|
410 | self.ESC_QUOTE2 = ';' | |
411 | self.ESC_PAREN = '/' |
|
411 | self.ESC_PAREN = '/' | |
412 |
|
412 | |||
413 | # And their associated handlers |
|
413 | # And their associated handlers | |
414 | self.esc_handlers = {self.ESC_PAREN : self.handle_auto, |
|
414 | self.esc_handlers = {self.ESC_PAREN : self.handle_auto, | |
415 | self.ESC_QUOTE : self.handle_auto, |
|
415 | self.ESC_QUOTE : self.handle_auto, | |
416 | self.ESC_QUOTE2 : self.handle_auto, |
|
416 | self.ESC_QUOTE2 : self.handle_auto, | |
417 | self.ESC_MAGIC : self.handle_magic, |
|
417 | self.ESC_MAGIC : self.handle_magic, | |
418 | self.ESC_HELP : self.handle_help, |
|
418 | self.ESC_HELP : self.handle_help, | |
419 | self.ESC_SHELL : self.handle_shell_escape, |
|
419 | self.ESC_SHELL : self.handle_shell_escape, | |
420 | self.ESC_SH_CAP : self.handle_shell_escape, |
|
420 | self.ESC_SH_CAP : self.handle_shell_escape, | |
421 | } |
|
421 | } | |
422 |
|
422 | |||
423 | # class initializations |
|
423 | # class initializations | |
424 | Magic.__init__(self,self) |
|
424 | Magic.__init__(self,self) | |
425 |
|
425 | |||
426 | # Python source parser/formatter for syntax highlighting |
|
426 | # Python source parser/formatter for syntax highlighting | |
427 | pyformat = PyColorize.Parser().format |
|
427 | pyformat = PyColorize.Parser().format | |
428 | self.pycolorize = lambda src: pyformat(src,'str',self.rc['colors']) |
|
428 | self.pycolorize = lambda src: pyformat(src,'str',self.rc['colors']) | |
429 |
|
429 | |||
430 | # hooks holds pointers used for user-side customizations |
|
430 | # hooks holds pointers used for user-side customizations | |
431 | self.hooks = Struct() |
|
431 | self.hooks = Struct() | |
432 |
|
432 | |||
433 | self.strdispatchers = {} |
|
433 | self.strdispatchers = {} | |
434 |
|
434 | |||
435 | # Set all default hooks, defined in the IPython.hooks module. |
|
435 | # Set all default hooks, defined in the IPython.hooks module. | |
436 | hooks = IPython.hooks |
|
436 | hooks = IPython.hooks | |
437 | for hook_name in hooks.__all__: |
|
437 | for hook_name in hooks.__all__: | |
438 | # default hooks have priority 100, i.e. low; user hooks should have |
|
438 | # default hooks have priority 100, i.e. low; user hooks should have | |
439 | # 0-100 priority |
|
439 | # 0-100 priority | |
440 | self.set_hook(hook_name,getattr(hooks,hook_name), 100) |
|
440 | self.set_hook(hook_name,getattr(hooks,hook_name), 100) | |
441 | #print "bound hook",hook_name |
|
441 | #print "bound hook",hook_name | |
442 |
|
442 | |||
443 | # Flag to mark unconditional exit |
|
443 | # Flag to mark unconditional exit | |
444 | self.exit_now = False |
|
444 | self.exit_now = False | |
445 |
|
445 | |||
446 | self.usage_min = """\ |
|
446 | self.usage_min = """\ | |
447 | An enhanced console for Python. |
|
447 | An enhanced console for Python. | |
448 | Some of its features are: |
|
448 | Some of its features are: | |
449 | - Readline support if the readline library is present. |
|
449 | - Readline support if the readline library is present. | |
450 | - Tab completion in the local namespace. |
|
450 | - Tab completion in the local namespace. | |
451 | - Logging of input, see command-line options. |
|
451 | - Logging of input, see command-line options. | |
452 | - System shell escape via ! , eg !ls. |
|
452 | - System shell escape via ! , eg !ls. | |
453 | - Magic commands, starting with a % (like %ls, %pwd, %cd, etc.) |
|
453 | - Magic commands, starting with a % (like %ls, %pwd, %cd, etc.) | |
454 | - Keeps track of locally defined variables via %who, %whos. |
|
454 | - Keeps track of locally defined variables via %who, %whos. | |
455 | - Show object information with a ? eg ?x or x? (use ?? for more info). |
|
455 | - Show object information with a ? eg ?x or x? (use ?? for more info). | |
456 | """ |
|
456 | """ | |
457 | if usage: self.usage = usage |
|
457 | if usage: self.usage = usage | |
458 | else: self.usage = self.usage_min |
|
458 | else: self.usage = self.usage_min | |
459 |
|
459 | |||
460 | # Storage |
|
460 | # Storage | |
461 | self.rc = rc # This will hold all configuration information |
|
461 | self.rc = rc # This will hold all configuration information | |
462 | self.pager = 'less' |
|
462 | self.pager = 'less' | |
463 | # temporary files used for various purposes. Deleted at exit. |
|
463 | # temporary files used for various purposes. Deleted at exit. | |
464 | self.tempfiles = [] |
|
464 | self.tempfiles = [] | |
465 |
|
465 | |||
466 | # Keep track of readline usage (later set by init_readline) |
|
466 | # Keep track of readline usage (later set by init_readline) | |
467 | self.has_readline = False |
|
467 | self.has_readline = False | |
468 |
|
468 | |||
469 | # template for logfile headers. It gets resolved at runtime by the |
|
469 | # template for logfile headers. It gets resolved at runtime by the | |
470 | # logstart method. |
|
470 | # logstart method. | |
471 | self.loghead_tpl = \ |
|
471 | self.loghead_tpl = \ | |
472 | """#log# Automatic Logger file. *** THIS MUST BE THE FIRST LINE *** |
|
472 | """#log# Automatic Logger file. *** THIS MUST BE THE FIRST LINE *** | |
473 | #log# DO NOT CHANGE THIS LINE OR THE TWO BELOW |
|
473 | #log# DO NOT CHANGE THIS LINE OR THE TWO BELOW | |
474 | #log# opts = %s |
|
474 | #log# opts = %s | |
475 | #log# args = %s |
|
475 | #log# args = %s | |
476 | #log# It is safe to make manual edits below here. |
|
476 | #log# It is safe to make manual edits below here. | |
477 | #log#----------------------------------------------------------------------- |
|
477 | #log#----------------------------------------------------------------------- | |
478 | """ |
|
478 | """ | |
479 | # for pushd/popd management |
|
479 | # for pushd/popd management | |
480 | try: |
|
480 | try: | |
481 | self.home_dir = get_home_dir() |
|
481 | self.home_dir = get_home_dir() | |
482 | except HomeDirError,msg: |
|
482 | except HomeDirError,msg: | |
483 | fatal(msg) |
|
483 | fatal(msg) | |
484 |
|
484 | |||
485 | self.dir_stack = [] |
|
485 | self.dir_stack = [] | |
486 |
|
486 | |||
487 | # Functions to call the underlying shell. |
|
487 | # Functions to call the underlying shell. | |
488 |
|
488 | |||
489 | # The first is similar to os.system, but it doesn't return a value, |
|
489 | # The first is similar to os.system, but it doesn't return a value, | |
490 | # and it allows interpolation of variables in the user's namespace. |
|
490 | # and it allows interpolation of variables in the user's namespace. | |
491 | self.system = lambda cmd: \ |
|
491 | self.system = lambda cmd: \ | |
492 | self.hooks.shell_hook(self.var_expand(cmd,depth=2)) |
|
492 | self.hooks.shell_hook(self.var_expand(cmd,depth=2)) | |
493 |
|
493 | |||
494 | # These are for getoutput and getoutputerror: |
|
494 | # These are for getoutput and getoutputerror: | |
495 | self.getoutput = lambda cmd: \ |
|
495 | self.getoutput = lambda cmd: \ | |
496 | getoutput(self.var_expand(cmd,depth=2), |
|
496 | getoutput(self.var_expand(cmd,depth=2), | |
497 | header=self.rc.system_header, |
|
497 | header=self.rc.system_header, | |
498 | verbose=self.rc.system_verbose) |
|
498 | verbose=self.rc.system_verbose) | |
499 |
|
499 | |||
500 | self.getoutputerror = lambda cmd: \ |
|
500 | self.getoutputerror = lambda cmd: \ | |
501 | getoutputerror(self.var_expand(cmd,depth=2), |
|
501 | getoutputerror(self.var_expand(cmd,depth=2), | |
502 | header=self.rc.system_header, |
|
502 | header=self.rc.system_header, | |
503 | verbose=self.rc.system_verbose) |
|
503 | verbose=self.rc.system_verbose) | |
504 |
|
504 | |||
505 |
|
505 | |||
506 | # keep track of where we started running (mainly for crash post-mortem) |
|
506 | # keep track of where we started running (mainly for crash post-mortem) | |
507 | self.starting_dir = os.getcwd() |
|
507 | self.starting_dir = os.getcwd() | |
508 |
|
508 | |||
509 | # Various switches which can be set |
|
509 | # Various switches which can be set | |
510 | self.CACHELENGTH = 5000 # this is cheap, it's just text |
|
510 | self.CACHELENGTH = 5000 # this is cheap, it's just text | |
511 | self.BANNER = "Python %(version)s on %(platform)s\n" % sys.__dict__ |
|
511 | self.BANNER = "Python %(version)s on %(platform)s\n" % sys.__dict__ | |
512 | self.banner2 = banner2 |
|
512 | self.banner2 = banner2 | |
513 |
|
513 | |||
514 | # TraceBack handlers: |
|
514 | # TraceBack handlers: | |
515 |
|
515 | |||
516 | # Syntax error handler. |
|
516 | # Syntax error handler. | |
517 | self.SyntaxTB = SyntaxTB(color_scheme='NoColor') |
|
517 | self.SyntaxTB = SyntaxTB(color_scheme='NoColor') | |
518 |
|
518 | |||
519 | # The interactive one is initialized with an offset, meaning we always |
|
519 | # The interactive one is initialized with an offset, meaning we always | |
520 | # want to remove the topmost item in the traceback, which is our own |
|
520 | # want to remove the topmost item in the traceback, which is our own | |
521 | # internal code. Valid modes: ['Plain','Context','Verbose'] |
|
521 | # internal code. Valid modes: ['Plain','Context','Verbose'] | |
522 | self.InteractiveTB = ultraTB.AutoFormattedTB(mode = 'Plain', |
|
522 | self.InteractiveTB = ultraTB.AutoFormattedTB(mode = 'Plain', | |
523 | color_scheme='NoColor', |
|
523 | color_scheme='NoColor', | |
524 | tb_offset = 1) |
|
524 | tb_offset = 1) | |
525 |
|
525 | |||
526 | # IPython itself shouldn't crash. This will produce a detailed |
|
526 | # IPython itself shouldn't crash. This will produce a detailed | |
527 | # post-mortem if it does. But we only install the crash handler for |
|
527 | # post-mortem if it does. But we only install the crash handler for | |
528 | # non-threaded shells, the threaded ones use a normal verbose reporter |
|
528 | # non-threaded shells, the threaded ones use a normal verbose reporter | |
529 | # and lose the crash handler. This is because exceptions in the main |
|
529 | # and lose the crash handler. This is because exceptions in the main | |
530 | # thread (such as in GUI code) propagate directly to sys.excepthook, |
|
530 | # thread (such as in GUI code) propagate directly to sys.excepthook, | |
531 | # and there's no point in printing crash dumps for every user exception. |
|
531 | # and there's no point in printing crash dumps for every user exception. | |
532 | if self.isthreaded: |
|
532 | if self.isthreaded: | |
533 | ipCrashHandler = ultraTB.FormattedTB() |
|
533 | ipCrashHandler = ultraTB.FormattedTB() | |
534 | else: |
|
534 | else: | |
535 | from IPython import CrashHandler |
|
535 | from IPython import CrashHandler | |
536 | ipCrashHandler = CrashHandler.IPythonCrashHandler(self) |
|
536 | ipCrashHandler = CrashHandler.IPythonCrashHandler(self) | |
537 | self.set_crash_handler(ipCrashHandler) |
|
537 | self.set_crash_handler(ipCrashHandler) | |
538 |
|
538 | |||
539 | # and add any custom exception handlers the user may have specified |
|
539 | # and add any custom exception handlers the user may have specified | |
540 | self.set_custom_exc(*custom_exceptions) |
|
540 | self.set_custom_exc(*custom_exceptions) | |
541 |
|
541 | |||
542 | # indentation management |
|
542 | # indentation management | |
543 | self.autoindent = False |
|
543 | self.autoindent = False | |
544 | self.indent_current_nsp = 0 |
|
544 | self.indent_current_nsp = 0 | |
545 |
|
545 | |||
546 | # Make some aliases automatically |
|
546 | # Make some aliases automatically | |
547 | # Prepare list of shell aliases to auto-define |
|
547 | # Prepare list of shell aliases to auto-define | |
548 | if os.name == 'posix': |
|
548 | if os.name == 'posix': | |
549 | auto_alias = ('mkdir mkdir', 'rmdir rmdir', |
|
549 | auto_alias = ('mkdir mkdir', 'rmdir rmdir', | |
550 | 'mv mv -i','rm rm -i','cp cp -i', |
|
550 | 'mv mv -i','rm rm -i','cp cp -i', | |
551 | 'cat cat','less less','clear clear', |
|
551 | 'cat cat','less less','clear clear', | |
552 | # a better ls |
|
552 | # a better ls | |
553 | 'ls ls -F', |
|
553 | 'ls ls -F', | |
554 | # long ls |
|
554 | # long ls | |
555 | 'll ls -lF') |
|
555 | 'll ls -lF') | |
556 | # Extra ls aliases with color, which need special treatment on BSD |
|
556 | # Extra ls aliases with color, which need special treatment on BSD | |
557 | # variants |
|
557 | # variants | |
558 | ls_extra = ( # color ls |
|
558 | ls_extra = ( # color ls | |
559 | 'lc ls -F -o --color', |
|
559 | 'lc ls -F -o --color', | |
560 | # ls normal files only |
|
560 | # ls normal files only | |
561 | 'lf ls -F -o --color %l | grep ^-', |
|
561 | 'lf ls -F -o --color %l | grep ^-', | |
562 | # ls symbolic links |
|
562 | # ls symbolic links | |
563 | 'lk ls -F -o --color %l | grep ^l', |
|
563 | 'lk ls -F -o --color %l | grep ^l', | |
564 | # directories or links to directories, |
|
564 | # directories or links to directories, | |
565 | 'ldir ls -F -o --color %l | grep /$', |
|
565 | 'ldir ls -F -o --color %l | grep /$', | |
566 | # things which are executable |
|
566 | # things which are executable | |
567 | 'lx ls -F -o --color %l | grep ^-..x', |
|
567 | 'lx ls -F -o --color %l | grep ^-..x', | |
568 | ) |
|
568 | ) | |
569 | # The BSDs don't ship GNU ls, so they don't understand the |
|
569 | # The BSDs don't ship GNU ls, so they don't understand the | |
570 | # --color switch out of the box |
|
570 | # --color switch out of the box | |
571 | if 'bsd' in sys.platform: |
|
571 | if 'bsd' in sys.platform: | |
572 | ls_extra = ( # ls normal files only |
|
572 | ls_extra = ( # ls normal files only | |
573 | 'lf ls -lF | grep ^-', |
|
573 | 'lf ls -lF | grep ^-', | |
574 | # ls symbolic links |
|
574 | # ls symbolic links | |
575 | 'lk ls -lF | grep ^l', |
|
575 | 'lk ls -lF | grep ^l', | |
576 | # directories or links to directories, |
|
576 | # directories or links to directories, | |
577 | 'ldir ls -lF | grep /$', |
|
577 | 'ldir ls -lF | grep /$', | |
578 | # things which are executable |
|
578 | # things which are executable | |
579 | 'lx ls -lF | grep ^-..x', |
|
579 | 'lx ls -lF | grep ^-..x', | |
580 | ) |
|
580 | ) | |
581 | auto_alias = auto_alias + ls_extra |
|
581 | auto_alias = auto_alias + ls_extra | |
582 | elif os.name in ['nt','dos']: |
|
582 | elif os.name in ['nt','dos']: | |
583 | auto_alias = ('ls dir /on', |
|
583 | auto_alias = ('ls dir /on', | |
584 | 'ddir dir /ad /on', 'ldir dir /ad /on', |
|
584 | 'ddir dir /ad /on', 'ldir dir /ad /on', | |
585 | 'mkdir mkdir','rmdir rmdir','echo echo', |
|
585 | 'mkdir mkdir','rmdir rmdir','echo echo', | |
586 | 'ren ren','cls cls','copy copy') |
|
586 | 'ren ren','cls cls','copy copy') | |
587 | else: |
|
587 | else: | |
588 | auto_alias = () |
|
588 | auto_alias = () | |
589 | self.auto_alias = [s.split(None,1) for s in auto_alias] |
|
589 | self.auto_alias = [s.split(None,1) for s in auto_alias] | |
590 |
|
590 | |||
591 |
|
591 | |||
592 | # Produce a public API instance |
|
592 | # Produce a public API instance | |
593 | self.api = IPython.ipapi.IPApi(self) |
|
593 | self.api = IPython.ipapi.IPApi(self) | |
594 |
|
594 | |||
595 | # Call the actual (public) initializer |
|
595 | # Call the actual (public) initializer | |
596 | self.init_auto_alias() |
|
596 | self.init_auto_alias() | |
597 |
|
597 | |||
598 | # track which builtins we add, so we can clean up later |
|
598 | # track which builtins we add, so we can clean up later | |
599 | self.builtins_added = {} |
|
599 | self.builtins_added = {} | |
600 | # This method will add the necessary builtins for operation, but |
|
600 | # This method will add the necessary builtins for operation, but | |
601 | # tracking what it did via the builtins_added dict. |
|
601 | # tracking what it did via the builtins_added dict. | |
602 |
|
602 | |||
603 | #TODO: remove this, redundant |
|
603 | #TODO: remove this, redundant | |
604 | self.add_builtins() |
|
604 | self.add_builtins() | |
605 |
|
605 | |||
606 |
|
606 | |||
607 |
|
607 | |||
608 |
|
608 | |||
609 | # end __init__ |
|
609 | # end __init__ | |
610 |
|
610 | |||
611 | def var_expand(self,cmd,depth=0): |
|
611 | def var_expand(self,cmd,depth=0): | |
612 | """Expand python variables in a string. |
|
612 | """Expand python variables in a string. | |
613 |
|
613 | |||
614 | The depth argument indicates how many frames above the caller should |
|
614 | The depth argument indicates how many frames above the caller should | |
615 | be walked to look for the local namespace where to expand variables. |
|
615 | be walked to look for the local namespace where to expand variables. | |
616 |
|
616 | |||
617 | The global namespace for expansion is always the user's interactive |
|
617 | The global namespace for expansion is always the user's interactive | |
618 | namespace. |
|
618 | namespace. | |
619 | """ |
|
619 | """ | |
620 |
|
620 | |||
621 | return str(ItplNS(cmd, |
|
621 | return str(ItplNS(cmd, | |
622 | self.user_ns, # globals |
|
622 | self.user_ns, # globals | |
623 | # Skip our own frame in searching for locals: |
|
623 | # Skip our own frame in searching for locals: | |
624 | sys._getframe(depth+1).f_locals # locals |
|
624 | sys._getframe(depth+1).f_locals # locals | |
625 | )) |
|
625 | )) | |
626 |
|
626 | |||
627 | def pre_config_initialization(self): |
|
627 | def pre_config_initialization(self): | |
628 | """Pre-configuration init method |
|
628 | """Pre-configuration init method | |
629 |
|
629 | |||
630 | This is called before the configuration files are processed to |
|
630 | This is called before the configuration files are processed to | |
631 | prepare the services the config files might need. |
|
631 | prepare the services the config files might need. | |
632 |
|
632 | |||
633 | self.rc already has reasonable default values at this point. |
|
633 | self.rc already has reasonable default values at this point. | |
634 | """ |
|
634 | """ | |
635 | rc = self.rc |
|
635 | rc = self.rc | |
636 | try: |
|
636 | try: | |
637 | self.db = pickleshare.PickleShareDB(rc.ipythondir + "/db") |
|
637 | self.db = pickleshare.PickleShareDB(rc.ipythondir + "/db") | |
638 | except exceptions.UnicodeDecodeError: |
|
638 | except exceptions.UnicodeDecodeError: | |
639 | print "Your ipythondir can't be decoded to unicode!" |
|
639 | print "Your ipythondir can't be decoded to unicode!" | |
640 | print "Please set HOME environment variable to something that" |
|
640 | print "Please set HOME environment variable to something that" | |
641 | print r"only has ASCII characters, e.g. c:\home" |
|
641 | print r"only has ASCII characters, e.g. c:\home" | |
642 | print "Now it is",rc.ipythondir |
|
642 | print "Now it is",rc.ipythondir | |
643 | sys.exit() |
|
643 | sys.exit() | |
644 | self.shadowhist = IPython.history.ShadowHist(self.db) |
|
644 | self.shadowhist = IPython.history.ShadowHist(self.db) | |
645 |
|
645 | |||
646 |
|
646 | |||
647 | def post_config_initialization(self): |
|
647 | def post_config_initialization(self): | |
648 | """Post configuration init method |
|
648 | """Post configuration init method | |
649 |
|
649 | |||
650 | This is called after the configuration files have been processed to |
|
650 | This is called after the configuration files have been processed to | |
651 | 'finalize' the initialization.""" |
|
651 | 'finalize' the initialization.""" | |
652 |
|
652 | |||
653 | rc = self.rc |
|
653 | rc = self.rc | |
654 |
|
654 | |||
655 | # Object inspector |
|
655 | # Object inspector | |
656 | self.inspector = OInspect.Inspector(OInspect.InspectColors, |
|
656 | self.inspector = OInspect.Inspector(OInspect.InspectColors, | |
657 | PyColorize.ANSICodeColors, |
|
657 | PyColorize.ANSICodeColors, | |
658 | 'NoColor', |
|
658 | 'NoColor', | |
659 | rc.object_info_string_level) |
|
659 | rc.object_info_string_level) | |
660 |
|
660 | |||
661 | self.rl_next_input = None |
|
661 | self.rl_next_input = None | |
662 | self.rl_do_indent = False |
|
662 | self.rl_do_indent = False | |
663 | # Load readline proper |
|
663 | # Load readline proper | |
664 | if rc.readline: |
|
664 | if rc.readline: | |
665 | self.init_readline() |
|
665 | self.init_readline() | |
666 |
|
666 | |||
667 |
|
667 | |||
668 | # local shortcut, this is used a LOT |
|
668 | # local shortcut, this is used a LOT | |
669 | self.log = self.logger.log |
|
669 | self.log = self.logger.log | |
670 |
|
670 | |||
671 | # Initialize cache, set in/out prompts and printing system |
|
671 | # Initialize cache, set in/out prompts and printing system | |
672 | self.outputcache = CachedOutput(self, |
|
672 | self.outputcache = CachedOutput(self, | |
673 | rc.cache_size, |
|
673 | rc.cache_size, | |
674 | rc.pprint, |
|
674 | rc.pprint, | |
675 | input_sep = rc.separate_in, |
|
675 | input_sep = rc.separate_in, | |
676 | output_sep = rc.separate_out, |
|
676 | output_sep = rc.separate_out, | |
677 | output_sep2 = rc.separate_out2, |
|
677 | output_sep2 = rc.separate_out2, | |
678 | ps1 = rc.prompt_in1, |
|
678 | ps1 = rc.prompt_in1, | |
679 | ps2 = rc.prompt_in2, |
|
679 | ps2 = rc.prompt_in2, | |
680 | ps_out = rc.prompt_out, |
|
680 | ps_out = rc.prompt_out, | |
681 | pad_left = rc.prompts_pad_left) |
|
681 | pad_left = rc.prompts_pad_left) | |
682 |
|
682 | |||
683 | # user may have over-ridden the default print hook: |
|
683 | # user may have over-ridden the default print hook: | |
684 | try: |
|
684 | try: | |
685 | self.outputcache.__class__.display = self.hooks.display |
|
685 | self.outputcache.__class__.display = self.hooks.display | |
686 | except AttributeError: |
|
686 | except AttributeError: | |
687 | pass |
|
687 | pass | |
688 |
|
688 | |||
689 | # I don't like assigning globally to sys, because it means when |
|
689 | # I don't like assigning globally to sys, because it means when | |
690 | # embedding instances, each embedded instance overrides the previous |
|
690 | # embedding instances, each embedded instance overrides the previous | |
691 | # choice. But sys.displayhook seems to be called internally by exec, |
|
691 | # choice. But sys.displayhook seems to be called internally by exec, | |
692 | # so I don't see a way around it. We first save the original and then |
|
692 | # so I don't see a way around it. We first save the original and then | |
693 | # overwrite it. |
|
693 | # overwrite it. | |
694 | self.sys_displayhook = sys.displayhook |
|
694 | self.sys_displayhook = sys.displayhook | |
695 | sys.displayhook = self.outputcache |
|
695 | sys.displayhook = self.outputcache | |
696 |
|
696 | |||
697 | # Do a proper resetting of doctest, including the necessary displayhook |
|
697 | # Do a proper resetting of doctest, including the necessary displayhook | |
698 | # monkeypatching |
|
698 | # monkeypatching | |
699 | try: |
|
699 | try: | |
700 | doctest_reload() |
|
700 | doctest_reload() | |
701 | except ImportError: |
|
701 | except ImportError: | |
702 | warn("doctest module does not exist.") |
|
702 | warn("doctest module does not exist.") | |
703 |
|
703 | |||
704 | # Set user colors (don't do it in the constructor above so that it |
|
704 | # Set user colors (don't do it in the constructor above so that it | |
705 | # doesn't crash if colors option is invalid) |
|
705 | # doesn't crash if colors option is invalid) | |
706 | self.magic_colors(rc.colors) |
|
706 | self.magic_colors(rc.colors) | |
707 |
|
707 | |||
708 | # Set calling of pdb on exceptions |
|
708 | # Set calling of pdb on exceptions | |
709 | self.call_pdb = rc.pdb |
|
709 | self.call_pdb = rc.pdb | |
710 |
|
710 | |||
711 | # Load user aliases |
|
711 | # Load user aliases | |
712 | for alias in rc.alias: |
|
712 | for alias in rc.alias: | |
713 | self.magic_alias(alias) |
|
713 | self.magic_alias(alias) | |
714 |
|
714 | |||
715 | self.hooks.late_startup_hook() |
|
715 | self.hooks.late_startup_hook() | |
716 |
|
716 | |||
717 | for cmd in self.rc.autoexec: |
|
717 | for cmd in self.rc.autoexec: | |
718 | #print "autoexec>",cmd #dbg |
|
718 | #print "autoexec>",cmd #dbg | |
719 | self.api.runlines(cmd) |
|
719 | self.api.runlines(cmd) | |
720 |
|
720 | |||
721 | batchrun = False |
|
721 | batchrun = False | |
722 | for batchfile in [path(arg) for arg in self.rc.args |
|
722 | for batchfile in [path(arg) for arg in self.rc.args | |
723 | if arg.lower().endswith('.ipy')]: |
|
723 | if arg.lower().endswith('.ipy')]: | |
724 | if not batchfile.isfile(): |
|
724 | if not batchfile.isfile(): | |
725 | print "No such batch file:", batchfile |
|
725 | print "No such batch file:", batchfile | |
726 | continue |
|
726 | continue | |
727 | self.api.runlines(batchfile.text()) |
|
727 | self.api.runlines(batchfile.text()) | |
728 | batchrun = True |
|
728 | batchrun = True | |
729 | # without -i option, exit after running the batch file |
|
729 | # without -i option, exit after running the batch file | |
730 | if batchrun and not self.rc.interact: |
|
730 | if batchrun and not self.rc.interact: | |
731 | self.exit_now = True |
|
731 | self.exit_now = True | |
732 |
|
732 | |||
733 | def add_builtins(self): |
|
733 | def add_builtins(self): | |
734 | """Store ipython references into the builtin namespace. |
|
734 | """Store ipython references into the builtin namespace. | |
735 |
|
735 | |||
736 | Some parts of ipython operate via builtins injected here, which hold a |
|
736 | Some parts of ipython operate via builtins injected here, which hold a | |
737 | reference to IPython itself.""" |
|
737 | reference to IPython itself.""" | |
738 |
|
738 | |||
739 | # TODO: deprecate all of these, they are unsafe |
|
739 | # TODO: deprecate all of these, they are unsafe | |
740 | builtins_new = dict(__IPYTHON__ = self, |
|
740 | builtins_new = dict(__IPYTHON__ = self, | |
741 | ip_set_hook = self.set_hook, |
|
741 | ip_set_hook = self.set_hook, | |
742 | jobs = self.jobs, |
|
742 | jobs = self.jobs, | |
743 | ipmagic = wrap_deprecated(self.ipmagic,'_ip.magic()'), |
|
743 | ipmagic = wrap_deprecated(self.ipmagic,'_ip.magic()'), | |
744 | ipalias = wrap_deprecated(self.ipalias), |
|
744 | ipalias = wrap_deprecated(self.ipalias), | |
745 | ipsystem = wrap_deprecated(self.ipsystem,'_ip.system()'), |
|
745 | ipsystem = wrap_deprecated(self.ipsystem,'_ip.system()'), | |
746 | #_ip = self.api |
|
746 | #_ip = self.api | |
747 | ) |
|
747 | ) | |
748 | for biname,bival in builtins_new.items(): |
|
748 | for biname,bival in builtins_new.items(): | |
749 | try: |
|
749 | try: | |
750 | # store the orignal value so we can restore it |
|
750 | # store the orignal value so we can restore it | |
751 | self.builtins_added[biname] = __builtin__.__dict__[biname] |
|
751 | self.builtins_added[biname] = __builtin__.__dict__[biname] | |
752 | except KeyError: |
|
752 | except KeyError: | |
753 | # or mark that it wasn't defined, and we'll just delete it at |
|
753 | # or mark that it wasn't defined, and we'll just delete it at | |
754 | # cleanup |
|
754 | # cleanup | |
755 | self.builtins_added[biname] = Undefined |
|
755 | self.builtins_added[biname] = Undefined | |
756 | __builtin__.__dict__[biname] = bival |
|
756 | __builtin__.__dict__[biname] = bival | |
757 |
|
757 | |||
758 | # Keep in the builtins a flag for when IPython is active. We set it |
|
758 | # Keep in the builtins a flag for when IPython is active. We set it | |
759 | # with setdefault so that multiple nested IPythons don't clobber one |
|
759 | # with setdefault so that multiple nested IPythons don't clobber one | |
760 | # another. Each will increase its value by one upon being activated, |
|
760 | # another. Each will increase its value by one upon being activated, | |
761 | # which also gives us a way to determine the nesting level. |
|
761 | # which also gives us a way to determine the nesting level. | |
762 | __builtin__.__dict__.setdefault('__IPYTHON__active',0) |
|
762 | __builtin__.__dict__.setdefault('__IPYTHON__active',0) | |
763 |
|
763 | |||
764 | def clean_builtins(self): |
|
764 | def clean_builtins(self): | |
765 | """Remove any builtins which might have been added by add_builtins, or |
|
765 | """Remove any builtins which might have been added by add_builtins, or | |
766 | restore overwritten ones to their previous values.""" |
|
766 | restore overwritten ones to their previous values.""" | |
767 | for biname,bival in self.builtins_added.items(): |
|
767 | for biname,bival in self.builtins_added.items(): | |
768 | if bival is Undefined: |
|
768 | if bival is Undefined: | |
769 | del __builtin__.__dict__[biname] |
|
769 | del __builtin__.__dict__[biname] | |
770 | else: |
|
770 | else: | |
771 | __builtin__.__dict__[biname] = bival |
|
771 | __builtin__.__dict__[biname] = bival | |
772 | self.builtins_added.clear() |
|
772 | self.builtins_added.clear() | |
773 |
|
773 | |||
774 | def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None): |
|
774 | def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None): | |
775 | """set_hook(name,hook) -> sets an internal IPython hook. |
|
775 | """set_hook(name,hook) -> sets an internal IPython hook. | |
776 |
|
776 | |||
777 | IPython exposes some of its internal API as user-modifiable hooks. By |
|
777 | IPython exposes some of its internal API as user-modifiable hooks. By | |
778 | adding your function to one of these hooks, you can modify IPython's |
|
778 | adding your function to one of these hooks, you can modify IPython's | |
779 | behavior to call at runtime your own routines.""" |
|
779 | behavior to call at runtime your own routines.""" | |
780 |
|
780 | |||
781 | # At some point in the future, this should validate the hook before it |
|
781 | # At some point in the future, this should validate the hook before it | |
782 | # accepts it. Probably at least check that the hook takes the number |
|
782 | # accepts it. Probably at least check that the hook takes the number | |
783 | # of args it's supposed to. |
|
783 | # of args it's supposed to. | |
784 |
|
784 | |||
785 | f = new.instancemethod(hook,self,self.__class__) |
|
785 | f = new.instancemethod(hook,self,self.__class__) | |
786 |
|
786 | |||
787 | # check if the hook is for strdispatcher first |
|
787 | # check if the hook is for strdispatcher first | |
788 | if str_key is not None: |
|
788 | if str_key is not None: | |
789 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
789 | sdp = self.strdispatchers.get(name, StrDispatch()) | |
790 | sdp.add_s(str_key, f, priority ) |
|
790 | sdp.add_s(str_key, f, priority ) | |
791 | self.strdispatchers[name] = sdp |
|
791 | self.strdispatchers[name] = sdp | |
792 | return |
|
792 | return | |
793 | if re_key is not None: |
|
793 | if re_key is not None: | |
794 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
794 | sdp = self.strdispatchers.get(name, StrDispatch()) | |
795 | sdp.add_re(re.compile(re_key), f, priority ) |
|
795 | sdp.add_re(re.compile(re_key), f, priority ) | |
796 | self.strdispatchers[name] = sdp |
|
796 | self.strdispatchers[name] = sdp | |
797 | return |
|
797 | return | |
798 |
|
798 | |||
799 | dp = getattr(self.hooks, name, None) |
|
799 | dp = getattr(self.hooks, name, None) | |
800 | if name not in IPython.hooks.__all__: |
|
800 | if name not in IPython.hooks.__all__: | |
801 | print "Warning! Hook '%s' is not one of %s" % (name, IPython.hooks.__all__ ) |
|
801 | print "Warning! Hook '%s' is not one of %s" % (name, IPython.hooks.__all__ ) | |
802 | if not dp: |
|
802 | if not dp: | |
803 | dp = IPython.hooks.CommandChainDispatcher() |
|
803 | dp = IPython.hooks.CommandChainDispatcher() | |
804 |
|
804 | |||
805 | try: |
|
805 | try: | |
806 | dp.add(f,priority) |
|
806 | dp.add(f,priority) | |
807 | except AttributeError: |
|
807 | except AttributeError: | |
808 | # it was not commandchain, plain old func - replace |
|
808 | # it was not commandchain, plain old func - replace | |
809 | dp = f |
|
809 | dp = f | |
810 |
|
810 | |||
811 | setattr(self.hooks,name, dp) |
|
811 | setattr(self.hooks,name, dp) | |
812 |
|
812 | |||
813 |
|
813 | |||
814 | #setattr(self.hooks,name,new.instancemethod(hook,self,self.__class__)) |
|
814 | #setattr(self.hooks,name,new.instancemethod(hook,self,self.__class__)) | |
815 |
|
815 | |||
816 | def set_crash_handler(self,crashHandler): |
|
816 | def set_crash_handler(self,crashHandler): | |
817 | """Set the IPython crash handler. |
|
817 | """Set the IPython crash handler. | |
818 |
|
818 | |||
819 | This must be a callable with a signature suitable for use as |
|
819 | This must be a callable with a signature suitable for use as | |
820 | sys.excepthook.""" |
|
820 | sys.excepthook.""" | |
821 |
|
821 | |||
822 | # Install the given crash handler as the Python exception hook |
|
822 | # Install the given crash handler as the Python exception hook | |
823 | sys.excepthook = crashHandler |
|
823 | sys.excepthook = crashHandler | |
824 |
|
824 | |||
825 | # The instance will store a pointer to this, so that runtime code |
|
825 | # The instance will store a pointer to this, so that runtime code | |
826 | # (such as magics) can access it. This is because during the |
|
826 | # (such as magics) can access it. This is because during the | |
827 | # read-eval loop, it gets temporarily overwritten (to deal with GUI |
|
827 | # read-eval loop, it gets temporarily overwritten (to deal with GUI | |
828 | # frameworks). |
|
828 | # frameworks). | |
829 | self.sys_excepthook = sys.excepthook |
|
829 | self.sys_excepthook = sys.excepthook | |
830 |
|
830 | |||
831 |
|
831 | |||
832 | def set_custom_exc(self,exc_tuple,handler): |
|
832 | def set_custom_exc(self,exc_tuple,handler): | |
833 | """set_custom_exc(exc_tuple,handler) |
|
833 | """set_custom_exc(exc_tuple,handler) | |
834 |
|
834 | |||
835 | Set a custom exception handler, which will be called if any of the |
|
835 | Set a custom exception handler, which will be called if any of the | |
836 | exceptions in exc_tuple occur in the mainloop (specifically, in the |
|
836 | exceptions in exc_tuple occur in the mainloop (specifically, in the | |
837 | runcode() method. |
|
837 | runcode() method. | |
838 |
|
838 | |||
839 | Inputs: |
|
839 | Inputs: | |
840 |
|
840 | |||
841 | - exc_tuple: a *tuple* of valid exceptions to call the defined |
|
841 | - exc_tuple: a *tuple* of valid exceptions to call the defined | |
842 | handler for. It is very important that you use a tuple, and NOT A |
|
842 | handler for. It is very important that you use a tuple, and NOT A | |
843 | LIST here, because of the way Python's except statement works. If |
|
843 | LIST here, because of the way Python's except statement works. If | |
844 | you only want to trap a single exception, use a singleton tuple: |
|
844 | you only want to trap a single exception, use a singleton tuple: | |
845 |
|
845 | |||
846 | exc_tuple == (MyCustomException,) |
|
846 | exc_tuple == (MyCustomException,) | |
847 |
|
847 | |||
848 | - handler: this must be defined as a function with the following |
|
848 | - handler: this must be defined as a function with the following | |
849 | basic interface: def my_handler(self,etype,value,tb). |
|
849 | basic interface: def my_handler(self,etype,value,tb). | |
850 |
|
850 | |||
851 | This will be made into an instance method (via new.instancemethod) |
|
851 | This will be made into an instance method (via new.instancemethod) | |
852 | of IPython itself, and it will be called if any of the exceptions |
|
852 | of IPython itself, and it will be called if any of the exceptions | |
853 | listed in the exc_tuple are caught. If the handler is None, an |
|
853 | listed in the exc_tuple are caught. If the handler is None, an | |
854 | internal basic one is used, which just prints basic info. |
|
854 | internal basic one is used, which just prints basic info. | |
855 |
|
855 | |||
856 | WARNING: by putting in your own exception handler into IPython's main |
|
856 | WARNING: by putting in your own exception handler into IPython's main | |
857 | execution loop, you run a very good chance of nasty crashes. This |
|
857 | execution loop, you run a very good chance of nasty crashes. This | |
858 | facility should only be used if you really know what you are doing.""" |
|
858 | facility should only be used if you really know what you are doing.""" | |
859 |
|
859 | |||
860 | assert type(exc_tuple)==type(()) , \ |
|
860 | assert type(exc_tuple)==type(()) , \ | |
861 | "The custom exceptions must be given AS A TUPLE." |
|
861 | "The custom exceptions must be given AS A TUPLE." | |
862 |
|
862 | |||
863 | def dummy_handler(self,etype,value,tb): |
|
863 | def dummy_handler(self,etype,value,tb): | |
864 | print '*** Simple custom exception handler ***' |
|
864 | print '*** Simple custom exception handler ***' | |
865 | print 'Exception type :',etype |
|
865 | print 'Exception type :',etype | |
866 | print 'Exception value:',value |
|
866 | print 'Exception value:',value | |
867 | print 'Traceback :',tb |
|
867 | print 'Traceback :',tb | |
868 | print 'Source code :','\n'.join(self.buffer) |
|
868 | print 'Source code :','\n'.join(self.buffer) | |
869 |
|
869 | |||
870 | if handler is None: handler = dummy_handler |
|
870 | if handler is None: handler = dummy_handler | |
871 |
|
871 | |||
872 | self.CustomTB = new.instancemethod(handler,self,self.__class__) |
|
872 | self.CustomTB = new.instancemethod(handler,self,self.__class__) | |
873 | self.custom_exceptions = exc_tuple |
|
873 | self.custom_exceptions = exc_tuple | |
874 |
|
874 | |||
875 | def set_custom_completer(self,completer,pos=0): |
|
875 | def set_custom_completer(self,completer,pos=0): | |
876 | """set_custom_completer(completer,pos=0) |
|
876 | """set_custom_completer(completer,pos=0) | |
877 |
|
877 | |||
878 | Adds a new custom completer function. |
|
878 | Adds a new custom completer function. | |
879 |
|
879 | |||
880 | The position argument (defaults to 0) is the index in the completers |
|
880 | The position argument (defaults to 0) is the index in the completers | |
881 | list where you want the completer to be inserted.""" |
|
881 | list where you want the completer to be inserted.""" | |
882 |
|
882 | |||
883 | newcomp = new.instancemethod(completer,self.Completer, |
|
883 | newcomp = new.instancemethod(completer,self.Completer, | |
884 | self.Completer.__class__) |
|
884 | self.Completer.__class__) | |
885 | self.Completer.matchers.insert(pos,newcomp) |
|
885 | self.Completer.matchers.insert(pos,newcomp) | |
886 |
|
886 | |||
887 | def set_completer(self): |
|
887 | def set_completer(self): | |
888 | """reset readline's completer to be our own.""" |
|
888 | """reset readline's completer to be our own.""" | |
889 | self.readline.set_completer(self.Completer.complete) |
|
889 | self.readline.set_completer(self.Completer.complete) | |
890 |
|
890 | |||
891 | def _get_call_pdb(self): |
|
891 | def _get_call_pdb(self): | |
892 | return self._call_pdb |
|
892 | return self._call_pdb | |
893 |
|
893 | |||
894 | def _set_call_pdb(self,val): |
|
894 | def _set_call_pdb(self,val): | |
895 |
|
895 | |||
896 | if val not in (0,1,False,True): |
|
896 | if val not in (0,1,False,True): | |
897 | raise ValueError,'new call_pdb value must be boolean' |
|
897 | raise ValueError,'new call_pdb value must be boolean' | |
898 |
|
898 | |||
899 | # store value in instance |
|
899 | # store value in instance | |
900 | self._call_pdb = val |
|
900 | self._call_pdb = val | |
901 |
|
901 | |||
902 | # notify the actual exception handlers |
|
902 | # notify the actual exception handlers | |
903 | self.InteractiveTB.call_pdb = val |
|
903 | self.InteractiveTB.call_pdb = val | |
904 | if self.isthreaded: |
|
904 | if self.isthreaded: | |
905 | try: |
|
905 | try: | |
906 | self.sys_excepthook.call_pdb = val |
|
906 | self.sys_excepthook.call_pdb = val | |
907 | except: |
|
907 | except: | |
908 | warn('Failed to activate pdb for threaded exception handler') |
|
908 | warn('Failed to activate pdb for threaded exception handler') | |
909 |
|
909 | |||
910 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, |
|
910 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, | |
911 | 'Control auto-activation of pdb at exceptions') |
|
911 | 'Control auto-activation of pdb at exceptions') | |
912 |
|
912 | |||
913 |
|
913 | |||
914 | # These special functions get installed in the builtin namespace, to |
|
914 | # These special functions get installed in the builtin namespace, to | |
915 | # provide programmatic (pure python) access to magics, aliases and system |
|
915 | # provide programmatic (pure python) access to magics, aliases and system | |
916 | # calls. This is important for logging, user scripting, and more. |
|
916 | # calls. This is important for logging, user scripting, and more. | |
917 |
|
917 | |||
918 | # We are basically exposing, via normal python functions, the three |
|
918 | # We are basically exposing, via normal python functions, the three | |
919 | # mechanisms in which ipython offers special call modes (magics for |
|
919 | # mechanisms in which ipython offers special call modes (magics for | |
920 | # internal control, aliases for direct system access via pre-selected |
|
920 | # internal control, aliases for direct system access via pre-selected | |
921 | # names, and !cmd for calling arbitrary system commands). |
|
921 | # names, and !cmd for calling arbitrary system commands). | |
922 |
|
922 | |||
923 | def ipmagic(self,arg_s): |
|
923 | def ipmagic(self,arg_s): | |
924 | """Call a magic function by name. |
|
924 | """Call a magic function by name. | |
925 |
|
925 | |||
926 | Input: a string containing the name of the magic function to call and any |
|
926 | Input: a string containing the name of the magic function to call and any | |
927 | additional arguments to be passed to the magic. |
|
927 | additional arguments to be passed to the magic. | |
928 |
|
928 | |||
929 | ipmagic('name -opt foo bar') is equivalent to typing at the ipython |
|
929 | ipmagic('name -opt foo bar') is equivalent to typing at the ipython | |
930 | prompt: |
|
930 | prompt: | |
931 |
|
931 | |||
932 | In[1]: %name -opt foo bar |
|
932 | In[1]: %name -opt foo bar | |
933 |
|
933 | |||
934 | To call a magic without arguments, simply use ipmagic('name'). |
|
934 | To call a magic without arguments, simply use ipmagic('name'). | |
935 |
|
935 | |||
936 | This provides a proper Python function to call IPython's magics in any |
|
936 | This provides a proper Python function to call IPython's magics in any | |
937 | valid Python code you can type at the interpreter, including loops and |
|
937 | valid Python code you can type at the interpreter, including loops and | |
938 | compound statements. It is added by IPython to the Python builtin |
|
938 | compound statements. It is added by IPython to the Python builtin | |
939 | namespace upon initialization.""" |
|
939 | namespace upon initialization.""" | |
940 |
|
940 | |||
941 | args = arg_s.split(' ',1) |
|
941 | args = arg_s.split(' ',1) | |
942 | magic_name = args[0] |
|
942 | magic_name = args[0] | |
943 | magic_name = magic_name.lstrip(self.ESC_MAGIC) |
|
943 | magic_name = magic_name.lstrip(self.ESC_MAGIC) | |
944 |
|
944 | |||
945 | try: |
|
945 | try: | |
946 | magic_args = args[1] |
|
946 | magic_args = args[1] | |
947 | except IndexError: |
|
947 | except IndexError: | |
948 | magic_args = '' |
|
948 | magic_args = '' | |
949 | fn = getattr(self,'magic_'+magic_name,None) |
|
949 | fn = getattr(self,'magic_'+magic_name,None) | |
950 | if fn is None: |
|
950 | if fn is None: | |
951 | error("Magic function `%s` not found." % magic_name) |
|
951 | error("Magic function `%s` not found." % magic_name) | |
952 | else: |
|
952 | else: | |
953 | magic_args = self.var_expand(magic_args,1) |
|
953 | magic_args = self.var_expand(magic_args,1) | |
954 | return fn(magic_args) |
|
954 | return fn(magic_args) | |
955 |
|
955 | |||
956 | def ipalias(self,arg_s): |
|
956 | def ipalias(self,arg_s): | |
957 | """Call an alias by name. |
|
957 | """Call an alias by name. | |
958 |
|
958 | |||
959 | Input: a string containing the name of the alias to call and any |
|
959 | Input: a string containing the name of the alias to call and any | |
960 | additional arguments to be passed to the magic. |
|
960 | additional arguments to be passed to the magic. | |
961 |
|
961 | |||
962 | ipalias('name -opt foo bar') is equivalent to typing at the ipython |
|
962 | ipalias('name -opt foo bar') is equivalent to typing at the ipython | |
963 | prompt: |
|
963 | prompt: | |
964 |
|
964 | |||
965 | In[1]: name -opt foo bar |
|
965 | In[1]: name -opt foo bar | |
966 |
|
966 | |||
967 | To call an alias without arguments, simply use ipalias('name'). |
|
967 | To call an alias without arguments, simply use ipalias('name'). | |
968 |
|
968 | |||
969 | This provides a proper Python function to call IPython's aliases in any |
|
969 | This provides a proper Python function to call IPython's aliases in any | |
970 | valid Python code you can type at the interpreter, including loops and |
|
970 | valid Python code you can type at the interpreter, including loops and | |
971 | compound statements. It is added by IPython to the Python builtin |
|
971 | compound statements. It is added by IPython to the Python builtin | |
972 | namespace upon initialization.""" |
|
972 | namespace upon initialization.""" | |
973 |
|
973 | |||
974 | args = arg_s.split(' ',1) |
|
974 | args = arg_s.split(' ',1) | |
975 | alias_name = args[0] |
|
975 | alias_name = args[0] | |
976 | try: |
|
976 | try: | |
977 | alias_args = args[1] |
|
977 | alias_args = args[1] | |
978 | except IndexError: |
|
978 | except IndexError: | |
979 | alias_args = '' |
|
979 | alias_args = '' | |
980 | if alias_name in self.alias_table: |
|
980 | if alias_name in self.alias_table: | |
981 | self.call_alias(alias_name,alias_args) |
|
981 | self.call_alias(alias_name,alias_args) | |
982 | else: |
|
982 | else: | |
983 | error("Alias `%s` not found." % alias_name) |
|
983 | error("Alias `%s` not found." % alias_name) | |
984 |
|
984 | |||
985 | def ipsystem(self,arg_s): |
|
985 | def ipsystem(self,arg_s): | |
986 | """Make a system call, using IPython.""" |
|
986 | """Make a system call, using IPython.""" | |
987 |
|
987 | |||
988 | self.system(arg_s) |
|
988 | self.system(arg_s) | |
989 |
|
989 | |||
990 | def complete(self,text): |
|
990 | def complete(self,text): | |
991 | """Return a sorted list of all possible completions on text. |
|
991 | """Return a sorted list of all possible completions on text. | |
992 |
|
992 | |||
993 | Inputs: |
|
993 | Inputs: | |
994 |
|
994 | |||
995 | - text: a string of text to be completed on. |
|
995 | - text: a string of text to be completed on. | |
996 |
|
996 | |||
997 | This is a wrapper around the completion mechanism, similar to what |
|
997 | This is a wrapper around the completion mechanism, similar to what | |
998 | readline does at the command line when the TAB key is hit. By |
|
998 | readline does at the command line when the TAB key is hit. By | |
999 | exposing it as a method, it can be used by other non-readline |
|
999 | exposing it as a method, it can be used by other non-readline | |
1000 | environments (such as GUIs) for text completion. |
|
1000 | environments (such as GUIs) for text completion. | |
1001 |
|
1001 | |||
1002 | Simple usage example: |
|
1002 | Simple usage example: | |
1003 |
|
1003 | |||
1004 | In [7]: x = 'hello' |
|
1004 | In [7]: x = 'hello' | |
1005 |
|
1005 | |||
1006 | In [8]: x |
|
1006 | In [8]: x | |
1007 | Out[8]: 'hello' |
|
1007 | Out[8]: 'hello' | |
1008 |
|
1008 | |||
1009 | In [9]: print x |
|
1009 | In [9]: print x | |
1010 | hello |
|
1010 | hello | |
1011 |
|
1011 | |||
1012 | In [10]: _ip.IP.complete('x.l') |
|
1012 | In [10]: _ip.IP.complete('x.l') | |
1013 | Out[10]: ['x.ljust', 'x.lower', 'x.lstrip'] |
|
1013 | Out[10]: ['x.ljust', 'x.lower', 'x.lstrip'] # random | |
1014 | """ |
|
1014 | """ | |
1015 |
|
1015 | |||
1016 | complete = self.Completer.complete |
|
1016 | complete = self.Completer.complete | |
1017 | state = 0 |
|
1017 | state = 0 | |
1018 | # use a dict so we get unique keys, since ipyhton's multiple |
|
1018 | # use a dict so we get unique keys, since ipyhton's multiple | |
1019 | # completers can return duplicates. When we make 2.4 a requirement, |
|
1019 | # completers can return duplicates. When we make 2.4 a requirement, | |
1020 | # start using sets instead, which are faster. |
|
1020 | # start using sets instead, which are faster. | |
1021 | comps = {} |
|
1021 | comps = {} | |
1022 | while True: |
|
1022 | while True: | |
1023 | newcomp = complete(text,state,line_buffer=text) |
|
1023 | newcomp = complete(text,state,line_buffer=text) | |
1024 | if newcomp is None: |
|
1024 | if newcomp is None: | |
1025 | break |
|
1025 | break | |
1026 | comps[newcomp] = 1 |
|
1026 | comps[newcomp] = 1 | |
1027 | state += 1 |
|
1027 | state += 1 | |
1028 | outcomps = comps.keys() |
|
1028 | outcomps = comps.keys() | |
1029 | outcomps.sort() |
|
1029 | outcomps.sort() | |
1030 | #print "T:",text,"OC:",outcomps # dbg |
|
1030 | #print "T:",text,"OC:",outcomps # dbg | |
1031 | #print "vars:",self.user_ns.keys() |
|
1031 | #print "vars:",self.user_ns.keys() | |
1032 | return outcomps |
|
1032 | return outcomps | |
1033 |
|
1033 | |||
1034 | def set_completer_frame(self, frame=None): |
|
1034 | def set_completer_frame(self, frame=None): | |
1035 | if frame: |
|
1035 | if frame: | |
1036 | self.Completer.namespace = frame.f_locals |
|
1036 | self.Completer.namespace = frame.f_locals | |
1037 | self.Completer.global_namespace = frame.f_globals |
|
1037 | self.Completer.global_namespace = frame.f_globals | |
1038 | else: |
|
1038 | else: | |
1039 | self.Completer.namespace = self.user_ns |
|
1039 | self.Completer.namespace = self.user_ns | |
1040 | self.Completer.global_namespace = self.user_global_ns |
|
1040 | self.Completer.global_namespace = self.user_global_ns | |
1041 |
|
1041 | |||
1042 | def init_auto_alias(self): |
|
1042 | def init_auto_alias(self): | |
1043 | """Define some aliases automatically. |
|
1043 | """Define some aliases automatically. | |
1044 |
|
1044 | |||
1045 | These are ALL parameter-less aliases""" |
|
1045 | These are ALL parameter-less aliases""" | |
1046 |
|
1046 | |||
1047 | for alias,cmd in self.auto_alias: |
|
1047 | for alias,cmd in self.auto_alias: | |
1048 | self.getapi().defalias(alias,cmd) |
|
1048 | self.getapi().defalias(alias,cmd) | |
1049 |
|
1049 | |||
1050 |
|
1050 | |||
1051 | def alias_table_validate(self,verbose=0): |
|
1051 | def alias_table_validate(self,verbose=0): | |
1052 | """Update information about the alias table. |
|
1052 | """Update information about the alias table. | |
1053 |
|
1053 | |||
1054 | In particular, make sure no Python keywords/builtins are in it.""" |
|
1054 | In particular, make sure no Python keywords/builtins are in it.""" | |
1055 |
|
1055 | |||
1056 | no_alias = self.no_alias |
|
1056 | no_alias = self.no_alias | |
1057 | for k in self.alias_table.keys(): |
|
1057 | for k in self.alias_table.keys(): | |
1058 | if k in no_alias: |
|
1058 | if k in no_alias: | |
1059 | del self.alias_table[k] |
|
1059 | del self.alias_table[k] | |
1060 | if verbose: |
|
1060 | if verbose: | |
1061 | print ("Deleting alias <%s>, it's a Python " |
|
1061 | print ("Deleting alias <%s>, it's a Python " | |
1062 | "keyword or builtin." % k) |
|
1062 | "keyword or builtin." % k) | |
1063 |
|
1063 | |||
1064 | def set_autoindent(self,value=None): |
|
1064 | def set_autoindent(self,value=None): | |
1065 | """Set the autoindent flag, checking for readline support. |
|
1065 | """Set the autoindent flag, checking for readline support. | |
1066 |
|
1066 | |||
1067 | If called with no arguments, it acts as a toggle.""" |
|
1067 | If called with no arguments, it acts as a toggle.""" | |
1068 |
|
1068 | |||
1069 | if not self.has_readline: |
|
1069 | if not self.has_readline: | |
1070 | if os.name == 'posix': |
|
1070 | if os.name == 'posix': | |
1071 | warn("The auto-indent feature requires the readline library") |
|
1071 | warn("The auto-indent feature requires the readline library") | |
1072 | self.autoindent = 0 |
|
1072 | self.autoindent = 0 | |
1073 | return |
|
1073 | return | |
1074 | if value is None: |
|
1074 | if value is None: | |
1075 | self.autoindent = not self.autoindent |
|
1075 | self.autoindent = not self.autoindent | |
1076 | else: |
|
1076 | else: | |
1077 | self.autoindent = value |
|
1077 | self.autoindent = value | |
1078 |
|
1078 | |||
1079 | def rc_set_toggle(self,rc_field,value=None): |
|
1079 | def rc_set_toggle(self,rc_field,value=None): | |
1080 | """Set or toggle a field in IPython's rc config. structure. |
|
1080 | """Set or toggle a field in IPython's rc config. structure. | |
1081 |
|
1081 | |||
1082 | If called with no arguments, it acts as a toggle. |
|
1082 | If called with no arguments, it acts as a toggle. | |
1083 |
|
1083 | |||
1084 | If called with a non-existent field, the resulting AttributeError |
|
1084 | If called with a non-existent field, the resulting AttributeError | |
1085 | exception will propagate out.""" |
|
1085 | exception will propagate out.""" | |
1086 |
|
1086 | |||
1087 | rc_val = getattr(self.rc,rc_field) |
|
1087 | rc_val = getattr(self.rc,rc_field) | |
1088 | if value is None: |
|
1088 | if value is None: | |
1089 | value = not rc_val |
|
1089 | value = not rc_val | |
1090 | setattr(self.rc,rc_field,value) |
|
1090 | setattr(self.rc,rc_field,value) | |
1091 |
|
1091 | |||
1092 | def user_setup(self,ipythondir,rc_suffix,mode='install'): |
|
1092 | def user_setup(self,ipythondir,rc_suffix,mode='install'): | |
1093 | """Install the user configuration directory. |
|
1093 | """Install the user configuration directory. | |
1094 |
|
1094 | |||
1095 | Can be called when running for the first time or to upgrade the user's |
|
1095 | Can be called when running for the first time or to upgrade the user's | |
1096 | .ipython/ directory with the mode parameter. Valid modes are 'install' |
|
1096 | .ipython/ directory with the mode parameter. Valid modes are 'install' | |
1097 | and 'upgrade'.""" |
|
1097 | and 'upgrade'.""" | |
1098 |
|
1098 | |||
1099 | def wait(): |
|
1099 | def wait(): | |
1100 | try: |
|
1100 | try: | |
1101 | raw_input("Please press <RETURN> to start IPython.") |
|
1101 | raw_input("Please press <RETURN> to start IPython.") | |
1102 | except EOFError: |
|
1102 | except EOFError: | |
1103 | print >> Term.cout |
|
1103 | print >> Term.cout | |
1104 | print '*'*70 |
|
1104 | print '*'*70 | |
1105 |
|
1105 | |||
1106 | cwd = os.getcwd() # remember where we started |
|
1106 | cwd = os.getcwd() # remember where we started | |
1107 | glb = glob.glob |
|
1107 | glb = glob.glob | |
1108 | print '*'*70 |
|
1108 | print '*'*70 | |
1109 | if mode == 'install': |
|
1109 | if mode == 'install': | |
1110 | print \ |
|
1110 | print \ | |
1111 | """Welcome to IPython. I will try to create a personal configuration directory |
|
1111 | """Welcome to IPython. I will try to create a personal configuration directory | |
1112 | where you can customize many aspects of IPython's functionality in:\n""" |
|
1112 | where you can customize many aspects of IPython's functionality in:\n""" | |
1113 | else: |
|
1113 | else: | |
1114 | print 'I am going to upgrade your configuration in:' |
|
1114 | print 'I am going to upgrade your configuration in:' | |
1115 |
|
1115 | |||
1116 | print ipythondir |
|
1116 | print ipythondir | |
1117 |
|
1117 | |||
1118 | rcdirend = os.path.join('IPython','UserConfig') |
|
1118 | rcdirend = os.path.join('IPython','UserConfig') | |
1119 | cfg = lambda d: os.path.join(d,rcdirend) |
|
1119 | cfg = lambda d: os.path.join(d,rcdirend) | |
1120 | try: |
|
1120 | try: | |
1121 | rcdir = filter(os.path.isdir,map(cfg,sys.path))[0] |
|
1121 | rcdir = filter(os.path.isdir,map(cfg,sys.path))[0] | |
1122 | print "Initializing from configuration",rcdir |
|
1122 | print "Initializing from configuration",rcdir | |
1123 | except IndexError: |
|
1123 | except IndexError: | |
1124 | warning = """ |
|
1124 | warning = """ | |
1125 | Installation error. IPython's directory was not found. |
|
1125 | Installation error. IPython's directory was not found. | |
1126 |
|
1126 | |||
1127 | Check the following: |
|
1127 | Check the following: | |
1128 |
|
1128 | |||
1129 | The ipython/IPython directory should be in a directory belonging to your |
|
1129 | The ipython/IPython directory should be in a directory belonging to your | |
1130 | PYTHONPATH environment variable (that is, it should be in a directory |
|
1130 | PYTHONPATH environment variable (that is, it should be in a directory | |
1131 | belonging to sys.path). You can copy it explicitly there or just link to it. |
|
1131 | belonging to sys.path). You can copy it explicitly there or just link to it. | |
1132 |
|
1132 | |||
1133 | IPython will create a minimal default configuration for you. |
|
1133 | IPython will create a minimal default configuration for you. | |
1134 |
|
1134 | |||
1135 | """ |
|
1135 | """ | |
1136 | warn(warning) |
|
1136 | warn(warning) | |
1137 | wait() |
|
1137 | wait() | |
1138 |
|
1138 | |||
1139 | if sys.platform =='win32': |
|
1139 | if sys.platform =='win32': | |
1140 | inif = 'ipythonrc.ini' |
|
1140 | inif = 'ipythonrc.ini' | |
1141 | else: |
|
1141 | else: | |
1142 | inif = 'ipythonrc' |
|
1142 | inif = 'ipythonrc' | |
1143 | minimal_setup = {'ipy_user_conf.py' : 'import ipy_defaults', inif : '# intentionally left blank' } |
|
1143 | minimal_setup = {'ipy_user_conf.py' : 'import ipy_defaults', inif : '# intentionally left blank' } | |
1144 | os.makedirs(ipythondir, mode = 0777) |
|
1144 | os.makedirs(ipythondir, mode = 0777) | |
1145 | for f, cont in minimal_setup.items(): |
|
1145 | for f, cont in minimal_setup.items(): | |
1146 | open(ipythondir + '/' + f,'w').write(cont) |
|
1146 | open(ipythondir + '/' + f,'w').write(cont) | |
1147 |
|
1147 | |||
1148 | return |
|
1148 | return | |
1149 |
|
1149 | |||
1150 | if mode == 'install': |
|
1150 | if mode == 'install': | |
1151 | try: |
|
1151 | try: | |
1152 | shutil.copytree(rcdir,ipythondir) |
|
1152 | shutil.copytree(rcdir,ipythondir) | |
1153 | os.chdir(ipythondir) |
|
1153 | os.chdir(ipythondir) | |
1154 | rc_files = glb("ipythonrc*") |
|
1154 | rc_files = glb("ipythonrc*") | |
1155 | for rc_file in rc_files: |
|
1155 | for rc_file in rc_files: | |
1156 | os.rename(rc_file,rc_file+rc_suffix) |
|
1156 | os.rename(rc_file,rc_file+rc_suffix) | |
1157 | except: |
|
1157 | except: | |
1158 | warning = """ |
|
1158 | warning = """ | |
1159 |
|
1159 | |||
1160 | There was a problem with the installation: |
|
1160 | There was a problem with the installation: | |
1161 | %s |
|
1161 | %s | |
1162 | Try to correct it or contact the developers if you think it's a bug. |
|
1162 | Try to correct it or contact the developers if you think it's a bug. | |
1163 | IPython will proceed with builtin defaults.""" % sys.exc_info()[1] |
|
1163 | IPython will proceed with builtin defaults.""" % sys.exc_info()[1] | |
1164 | warn(warning) |
|
1164 | warn(warning) | |
1165 | wait() |
|
1165 | wait() | |
1166 | return |
|
1166 | return | |
1167 |
|
1167 | |||
1168 | elif mode == 'upgrade': |
|
1168 | elif mode == 'upgrade': | |
1169 | try: |
|
1169 | try: | |
1170 | os.chdir(ipythondir) |
|
1170 | os.chdir(ipythondir) | |
1171 | except: |
|
1171 | except: | |
1172 | print """ |
|
1172 | print """ | |
1173 | Can not upgrade: changing to directory %s failed. Details: |
|
1173 | Can not upgrade: changing to directory %s failed. Details: | |
1174 | %s |
|
1174 | %s | |
1175 | """ % (ipythondir,sys.exc_info()[1]) |
|
1175 | """ % (ipythondir,sys.exc_info()[1]) | |
1176 | wait() |
|
1176 | wait() | |
1177 | return |
|
1177 | return | |
1178 | else: |
|
1178 | else: | |
1179 | sources = glb(os.path.join(rcdir,'[A-Za-z]*')) |
|
1179 | sources = glb(os.path.join(rcdir,'[A-Za-z]*')) | |
1180 | for new_full_path in sources: |
|
1180 | for new_full_path in sources: | |
1181 | new_filename = os.path.basename(new_full_path) |
|
1181 | new_filename = os.path.basename(new_full_path) | |
1182 | if new_filename.startswith('ipythonrc'): |
|
1182 | if new_filename.startswith('ipythonrc'): | |
1183 | new_filename = new_filename + rc_suffix |
|
1183 | new_filename = new_filename + rc_suffix | |
1184 | # The config directory should only contain files, skip any |
|
1184 | # The config directory should only contain files, skip any | |
1185 | # directories which may be there (like CVS) |
|
1185 | # directories which may be there (like CVS) | |
1186 | if os.path.isdir(new_full_path): |
|
1186 | if os.path.isdir(new_full_path): | |
1187 | continue |
|
1187 | continue | |
1188 | if os.path.exists(new_filename): |
|
1188 | if os.path.exists(new_filename): | |
1189 | old_file = new_filename+'.old' |
|
1189 | old_file = new_filename+'.old' | |
1190 | if os.path.exists(old_file): |
|
1190 | if os.path.exists(old_file): | |
1191 | os.remove(old_file) |
|
1191 | os.remove(old_file) | |
1192 | os.rename(new_filename,old_file) |
|
1192 | os.rename(new_filename,old_file) | |
1193 | shutil.copy(new_full_path,new_filename) |
|
1193 | shutil.copy(new_full_path,new_filename) | |
1194 | else: |
|
1194 | else: | |
1195 | raise ValueError,'unrecognized mode for install:',`mode` |
|
1195 | raise ValueError,'unrecognized mode for install:',`mode` | |
1196 |
|
1196 | |||
1197 | # Fix line-endings to those native to each platform in the config |
|
1197 | # Fix line-endings to those native to each platform in the config | |
1198 | # directory. |
|
1198 | # directory. | |
1199 | try: |
|
1199 | try: | |
1200 | os.chdir(ipythondir) |
|
1200 | os.chdir(ipythondir) | |
1201 | except: |
|
1201 | except: | |
1202 | print """ |
|
1202 | print """ | |
1203 | Problem: changing to directory %s failed. |
|
1203 | Problem: changing to directory %s failed. | |
1204 | Details: |
|
1204 | Details: | |
1205 | %s |
|
1205 | %s | |
1206 |
|
1206 | |||
1207 | Some configuration files may have incorrect line endings. This should not |
|
1207 | Some configuration files may have incorrect line endings. This should not | |
1208 | cause any problems during execution. """ % (ipythondir,sys.exc_info()[1]) |
|
1208 | cause any problems during execution. """ % (ipythondir,sys.exc_info()[1]) | |
1209 | wait() |
|
1209 | wait() | |
1210 | else: |
|
1210 | else: | |
1211 | for fname in glb('ipythonrc*'): |
|
1211 | for fname in glb('ipythonrc*'): | |
1212 | try: |
|
1212 | try: | |
1213 | native_line_ends(fname,backup=0) |
|
1213 | native_line_ends(fname,backup=0) | |
1214 | except IOError: |
|
1214 | except IOError: | |
1215 | pass |
|
1215 | pass | |
1216 |
|
1216 | |||
1217 | if mode == 'install': |
|
1217 | if mode == 'install': | |
1218 | print """ |
|
1218 | print """ | |
1219 | Successful installation! |
|
1219 | Successful installation! | |
1220 |
|
1220 | |||
1221 | Please read the sections 'Initial Configuration' and 'Quick Tips' in the |
|
1221 | Please read the sections 'Initial Configuration' and 'Quick Tips' in the | |
1222 | IPython manual (there are both HTML and PDF versions supplied with the |
|
1222 | IPython manual (there are both HTML and PDF versions supplied with the | |
1223 | distribution) to make sure that your system environment is properly configured |
|
1223 | distribution) to make sure that your system environment is properly configured | |
1224 | to take advantage of IPython's features. |
|
1224 | to take advantage of IPython's features. | |
1225 |
|
1225 | |||
1226 | Important note: the configuration system has changed! The old system is |
|
1226 | Important note: the configuration system has changed! The old system is | |
1227 | still in place, but its setting may be partly overridden by the settings in |
|
1227 | still in place, but its setting may be partly overridden by the settings in | |
1228 | "~/.ipython/ipy_user_conf.py" config file. Please take a look at the file |
|
1228 | "~/.ipython/ipy_user_conf.py" config file. Please take a look at the file | |
1229 | if some of the new settings bother you. |
|
1229 | if some of the new settings bother you. | |
1230 |
|
1230 | |||
1231 | """ |
|
1231 | """ | |
1232 | else: |
|
1232 | else: | |
1233 | print """ |
|
1233 | print """ | |
1234 | Successful upgrade! |
|
1234 | Successful upgrade! | |
1235 |
|
1235 | |||
1236 | All files in your directory: |
|
1236 | All files in your directory: | |
1237 | %(ipythondir)s |
|
1237 | %(ipythondir)s | |
1238 | which would have been overwritten by the upgrade were backed up with a .old |
|
1238 | which would have been overwritten by the upgrade were backed up with a .old | |
1239 | extension. If you had made particular customizations in those files you may |
|
1239 | extension. If you had made particular customizations in those files you may | |
1240 | want to merge them back into the new files.""" % locals() |
|
1240 | want to merge them back into the new files.""" % locals() | |
1241 | wait() |
|
1241 | wait() | |
1242 | os.chdir(cwd) |
|
1242 | os.chdir(cwd) | |
1243 | # end user_setup() |
|
1243 | # end user_setup() | |
1244 |
|
1244 | |||
1245 | def atexit_operations(self): |
|
1245 | def atexit_operations(self): | |
1246 | """This will be executed at the time of exit. |
|
1246 | """This will be executed at the time of exit. | |
1247 |
|
1247 | |||
1248 | Saving of persistent data should be performed here. """ |
|
1248 | Saving of persistent data should be performed here. """ | |
1249 |
|
1249 | |||
1250 | #print '*** IPython exit cleanup ***' # dbg |
|
1250 | #print '*** IPython exit cleanup ***' # dbg | |
1251 | # input history |
|
1251 | # input history | |
1252 | self.savehist() |
|
1252 | self.savehist() | |
1253 |
|
1253 | |||
1254 | # Cleanup all tempfiles left around |
|
1254 | # Cleanup all tempfiles left around | |
1255 | for tfile in self.tempfiles: |
|
1255 | for tfile in self.tempfiles: | |
1256 | try: |
|
1256 | try: | |
1257 | os.unlink(tfile) |
|
1257 | os.unlink(tfile) | |
1258 | except OSError: |
|
1258 | except OSError: | |
1259 | pass |
|
1259 | pass | |
1260 |
|
1260 | |||
1261 | self.hooks.shutdown_hook() |
|
1261 | self.hooks.shutdown_hook() | |
1262 |
|
1262 | |||
1263 | def savehist(self): |
|
1263 | def savehist(self): | |
1264 | """Save input history to a file (via readline library).""" |
|
1264 | """Save input history to a file (via readline library).""" | |
1265 |
|
1265 | |||
1266 | if not self.has_readline: |
|
1266 | if not self.has_readline: | |
1267 | return |
|
1267 | return | |
1268 |
|
1268 | |||
1269 | try: |
|
1269 | try: | |
1270 | self.readline.write_history_file(self.histfile) |
|
1270 | self.readline.write_history_file(self.histfile) | |
1271 | except: |
|
1271 | except: | |
1272 | print 'Unable to save IPython command history to file: ' + \ |
|
1272 | print 'Unable to save IPython command history to file: ' + \ | |
1273 | `self.histfile` |
|
1273 | `self.histfile` | |
1274 |
|
1274 | |||
1275 | def reloadhist(self): |
|
1275 | def reloadhist(self): | |
1276 | """Reload the input history from disk file.""" |
|
1276 | """Reload the input history from disk file.""" | |
1277 |
|
1277 | |||
1278 | if self.has_readline: |
|
1278 | if self.has_readline: | |
1279 | try: |
|
1279 | try: | |
1280 | self.readline.clear_history() |
|
1280 | self.readline.clear_history() | |
1281 | self.readline.read_history_file(self.shell.histfile) |
|
1281 | self.readline.read_history_file(self.shell.histfile) | |
1282 | except AttributeError: |
|
1282 | except AttributeError: | |
1283 | pass |
|
1283 | pass | |
1284 |
|
1284 | |||
1285 |
|
1285 | |||
1286 | def history_saving_wrapper(self, func): |
|
1286 | def history_saving_wrapper(self, func): | |
1287 | """ Wrap func for readline history saving |
|
1287 | """ Wrap func for readline history saving | |
1288 |
|
1288 | |||
1289 | Convert func into callable that saves & restores |
|
1289 | Convert func into callable that saves & restores | |
1290 | history around the call """ |
|
1290 | history around the call """ | |
1291 |
|
1291 | |||
1292 | if not self.has_readline: |
|
1292 | if not self.has_readline: | |
1293 | return func |
|
1293 | return func | |
1294 |
|
1294 | |||
1295 | def wrapper(): |
|
1295 | def wrapper(): | |
1296 | self.savehist() |
|
1296 | self.savehist() | |
1297 | try: |
|
1297 | try: | |
1298 | func() |
|
1298 | func() | |
1299 | finally: |
|
1299 | finally: | |
1300 | readline.read_history_file(self.histfile) |
|
1300 | readline.read_history_file(self.histfile) | |
1301 | return wrapper |
|
1301 | return wrapper | |
1302 |
|
1302 | |||
1303 |
|
1303 | |||
1304 | def pre_readline(self): |
|
1304 | def pre_readline(self): | |
1305 | """readline hook to be used at the start of each line. |
|
1305 | """readline hook to be used at the start of each line. | |
1306 |
|
1306 | |||
1307 | Currently it handles auto-indent only.""" |
|
1307 | Currently it handles auto-indent only.""" | |
1308 |
|
1308 | |||
1309 | #debugx('self.indent_current_nsp','pre_readline:') |
|
1309 | #debugx('self.indent_current_nsp','pre_readline:') | |
1310 |
|
1310 | |||
1311 | if self.rl_do_indent: |
|
1311 | if self.rl_do_indent: | |
1312 | self.readline.insert_text(self.indent_current_str()) |
|
1312 | self.readline.insert_text(self.indent_current_str()) | |
1313 | if self.rl_next_input is not None: |
|
1313 | if self.rl_next_input is not None: | |
1314 | self.readline.insert_text(self.rl_next_input) |
|
1314 | self.readline.insert_text(self.rl_next_input) | |
1315 | self.rl_next_input = None |
|
1315 | self.rl_next_input = None | |
1316 |
|
1316 | |||
1317 | def init_readline(self): |
|
1317 | def init_readline(self): | |
1318 | """Command history completion/saving/reloading.""" |
|
1318 | """Command history completion/saving/reloading.""" | |
1319 |
|
1319 | |||
1320 |
|
1320 | |||
1321 | import IPython.rlineimpl as readline |
|
1321 | import IPython.rlineimpl as readline | |
1322 |
|
1322 | |||
1323 | if not readline.have_readline: |
|
1323 | if not readline.have_readline: | |
1324 | self.has_readline = 0 |
|
1324 | self.has_readline = 0 | |
1325 | self.readline = None |
|
1325 | self.readline = None | |
1326 | # no point in bugging windows users with this every time: |
|
1326 | # no point in bugging windows users with this every time: | |
1327 | warn('Readline services not available on this platform.') |
|
1327 | warn('Readline services not available on this platform.') | |
1328 | else: |
|
1328 | else: | |
1329 | sys.modules['readline'] = readline |
|
1329 | sys.modules['readline'] = readline | |
1330 | import atexit |
|
1330 | import atexit | |
1331 | from IPython.completer import IPCompleter |
|
1331 | from IPython.completer import IPCompleter | |
1332 | self.Completer = IPCompleter(self, |
|
1332 | self.Completer = IPCompleter(self, | |
1333 | self.user_ns, |
|
1333 | self.user_ns, | |
1334 | self.user_global_ns, |
|
1334 | self.user_global_ns, | |
1335 | self.rc.readline_omit__names, |
|
1335 | self.rc.readline_omit__names, | |
1336 | self.alias_table) |
|
1336 | self.alias_table) | |
1337 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) |
|
1337 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) | |
1338 | self.strdispatchers['complete_command'] = sdisp |
|
1338 | self.strdispatchers['complete_command'] = sdisp | |
1339 | self.Completer.custom_completers = sdisp |
|
1339 | self.Completer.custom_completers = sdisp | |
1340 | # Platform-specific configuration |
|
1340 | # Platform-specific configuration | |
1341 | if os.name == 'nt': |
|
1341 | if os.name == 'nt': | |
1342 | self.readline_startup_hook = readline.set_pre_input_hook |
|
1342 | self.readline_startup_hook = readline.set_pre_input_hook | |
1343 | else: |
|
1343 | else: | |
1344 | self.readline_startup_hook = readline.set_startup_hook |
|
1344 | self.readline_startup_hook = readline.set_startup_hook | |
1345 |
|
1345 | |||
1346 | # Load user's initrc file (readline config) |
|
1346 | # Load user's initrc file (readline config) | |
1347 | # Or if libedit is used, load editrc. |
|
1347 | # Or if libedit is used, load editrc. | |
1348 | inputrc_name = os.environ.get('INPUTRC') |
|
1348 | inputrc_name = os.environ.get('INPUTRC') | |
1349 | if inputrc_name is None: |
|
1349 | if inputrc_name is None: | |
1350 | home_dir = get_home_dir() |
|
1350 | home_dir = get_home_dir() | |
1351 | if home_dir is not None: |
|
1351 | if home_dir is not None: | |
1352 | inputrc_name = '.inputrc' |
|
1352 | inputrc_name = '.inputrc' | |
1353 | if readline.uses_libedit: |
|
1353 | if readline.uses_libedit: | |
1354 | inputrc_name = '.editrc' |
|
1354 | inputrc_name = '.editrc' | |
1355 | inputrc_name = os.path.join(home_dir, inputrc_name) |
|
1355 | inputrc_name = os.path.join(home_dir, inputrc_name) | |
1356 | if os.path.isfile(inputrc_name): |
|
1356 | if os.path.isfile(inputrc_name): | |
1357 | try: |
|
1357 | try: | |
1358 | readline.read_init_file(inputrc_name) |
|
1358 | readline.read_init_file(inputrc_name) | |
1359 | except: |
|
1359 | except: | |
1360 | warn('Problems reading readline initialization file <%s>' |
|
1360 | warn('Problems reading readline initialization file <%s>' | |
1361 | % inputrc_name) |
|
1361 | % inputrc_name) | |
1362 |
|
1362 | |||
1363 | self.has_readline = 1 |
|
1363 | self.has_readline = 1 | |
1364 | self.readline = readline |
|
1364 | self.readline = readline | |
1365 | # save this in sys so embedded copies can restore it properly |
|
1365 | # save this in sys so embedded copies can restore it properly | |
1366 | sys.ipcompleter = self.Completer.complete |
|
1366 | sys.ipcompleter = self.Completer.complete | |
1367 | self.set_completer() |
|
1367 | self.set_completer() | |
1368 |
|
1368 | |||
1369 | # Configure readline according to user's prefs |
|
1369 | # Configure readline according to user's prefs | |
1370 | # This is only done if GNU readline is being used. If libedit |
|
1370 | # This is only done if GNU readline is being used. If libedit | |
1371 | # is being used (as on Leopard) the readline config is |
|
1371 | # is being used (as on Leopard) the readline config is | |
1372 | # not run as the syntax for libedit is different. |
|
1372 | # not run as the syntax for libedit is different. | |
1373 | if not readline.uses_libedit: |
|
1373 | if not readline.uses_libedit: | |
1374 | for rlcommand in self.rc.readline_parse_and_bind: |
|
1374 | for rlcommand in self.rc.readline_parse_and_bind: | |
1375 | readline.parse_and_bind(rlcommand) |
|
1375 | readline.parse_and_bind(rlcommand) | |
1376 |
|
1376 | |||
1377 | # remove some chars from the delimiters list |
|
1377 | # remove some chars from the delimiters list | |
1378 | delims = readline.get_completer_delims() |
|
1378 | delims = readline.get_completer_delims() | |
1379 | delims = delims.translate(string._idmap, |
|
1379 | delims = delims.translate(string._idmap, | |
1380 | self.rc.readline_remove_delims) |
|
1380 | self.rc.readline_remove_delims) | |
1381 | readline.set_completer_delims(delims) |
|
1381 | readline.set_completer_delims(delims) | |
1382 | # otherwise we end up with a monster history after a while: |
|
1382 | # otherwise we end up with a monster history after a while: | |
1383 | readline.set_history_length(1000) |
|
1383 | readline.set_history_length(1000) | |
1384 | try: |
|
1384 | try: | |
1385 | #print '*** Reading readline history' # dbg |
|
1385 | #print '*** Reading readline history' # dbg | |
1386 | readline.read_history_file(self.histfile) |
|
1386 | readline.read_history_file(self.histfile) | |
1387 | except IOError: |
|
1387 | except IOError: | |
1388 | pass # It doesn't exist yet. |
|
1388 | pass # It doesn't exist yet. | |
1389 |
|
1389 | |||
1390 | atexit.register(self.atexit_operations) |
|
1390 | atexit.register(self.atexit_operations) | |
1391 | del atexit |
|
1391 | del atexit | |
1392 |
|
1392 | |||
1393 | # Configure auto-indent for all platforms |
|
1393 | # Configure auto-indent for all platforms | |
1394 | self.set_autoindent(self.rc.autoindent) |
|
1394 | self.set_autoindent(self.rc.autoindent) | |
1395 |
|
1395 | |||
1396 | def ask_yes_no(self,prompt,default=True): |
|
1396 | def ask_yes_no(self,prompt,default=True): | |
1397 | if self.rc.quiet: |
|
1397 | if self.rc.quiet: | |
1398 | return True |
|
1398 | return True | |
1399 | return ask_yes_no(prompt,default) |
|
1399 | return ask_yes_no(prompt,default) | |
1400 |
|
1400 | |||
1401 | def _should_recompile(self,e): |
|
1401 | def _should_recompile(self,e): | |
1402 | """Utility routine for edit_syntax_error""" |
|
1402 | """Utility routine for edit_syntax_error""" | |
1403 |
|
1403 | |||
1404 | if e.filename in ('<ipython console>','<input>','<string>', |
|
1404 | if e.filename in ('<ipython console>','<input>','<string>', | |
1405 | '<console>','<BackgroundJob compilation>', |
|
1405 | '<console>','<BackgroundJob compilation>', | |
1406 | None): |
|
1406 | None): | |
1407 |
|
1407 | |||
1408 | return False |
|
1408 | return False | |
1409 | try: |
|
1409 | try: | |
1410 | if (self.rc.autoedit_syntax and |
|
1410 | if (self.rc.autoedit_syntax and | |
1411 | not self.ask_yes_no('Return to editor to correct syntax error? ' |
|
1411 | not self.ask_yes_no('Return to editor to correct syntax error? ' | |
1412 | '[Y/n] ','y')): |
|
1412 | '[Y/n] ','y')): | |
1413 | return False |
|
1413 | return False | |
1414 | except EOFError: |
|
1414 | except EOFError: | |
1415 | return False |
|
1415 | return False | |
1416 |
|
1416 | |||
1417 | def int0(x): |
|
1417 | def int0(x): | |
1418 | try: |
|
1418 | try: | |
1419 | return int(x) |
|
1419 | return int(x) | |
1420 | except TypeError: |
|
1420 | except TypeError: | |
1421 | return 0 |
|
1421 | return 0 | |
1422 | # always pass integer line and offset values to editor hook |
|
1422 | # always pass integer line and offset values to editor hook | |
1423 | self.hooks.fix_error_editor(e.filename, |
|
1423 | self.hooks.fix_error_editor(e.filename, | |
1424 | int0(e.lineno),int0(e.offset),e.msg) |
|
1424 | int0(e.lineno),int0(e.offset),e.msg) | |
1425 | return True |
|
1425 | return True | |
1426 |
|
1426 | |||
1427 | def edit_syntax_error(self): |
|
1427 | def edit_syntax_error(self): | |
1428 | """The bottom half of the syntax error handler called in the main loop. |
|
1428 | """The bottom half of the syntax error handler called in the main loop. | |
1429 |
|
1429 | |||
1430 | Loop until syntax error is fixed or user cancels. |
|
1430 | Loop until syntax error is fixed or user cancels. | |
1431 | """ |
|
1431 | """ | |
1432 |
|
1432 | |||
1433 | while self.SyntaxTB.last_syntax_error: |
|
1433 | while self.SyntaxTB.last_syntax_error: | |
1434 | # copy and clear last_syntax_error |
|
1434 | # copy and clear last_syntax_error | |
1435 | err = self.SyntaxTB.clear_err_state() |
|
1435 | err = self.SyntaxTB.clear_err_state() | |
1436 | if not self._should_recompile(err): |
|
1436 | if not self._should_recompile(err): | |
1437 | return |
|
1437 | return | |
1438 | try: |
|
1438 | try: | |
1439 | # may set last_syntax_error again if a SyntaxError is raised |
|
1439 | # may set last_syntax_error again if a SyntaxError is raised | |
1440 | self.safe_execfile(err.filename,self.user_ns) |
|
1440 | self.safe_execfile(err.filename,self.user_ns) | |
1441 | except: |
|
1441 | except: | |
1442 | self.showtraceback() |
|
1442 | self.showtraceback() | |
1443 | else: |
|
1443 | else: | |
1444 | try: |
|
1444 | try: | |
1445 | f = file(err.filename) |
|
1445 | f = file(err.filename) | |
1446 | try: |
|
1446 | try: | |
1447 | sys.displayhook(f.read()) |
|
1447 | sys.displayhook(f.read()) | |
1448 | finally: |
|
1448 | finally: | |
1449 | f.close() |
|
1449 | f.close() | |
1450 | except: |
|
1450 | except: | |
1451 | self.showtraceback() |
|
1451 | self.showtraceback() | |
1452 |
|
1452 | |||
1453 | def showsyntaxerror(self, filename=None): |
|
1453 | def showsyntaxerror(self, filename=None): | |
1454 | """Display the syntax error that just occurred. |
|
1454 | """Display the syntax error that just occurred. | |
1455 |
|
1455 | |||
1456 | This doesn't display a stack trace because there isn't one. |
|
1456 | This doesn't display a stack trace because there isn't one. | |
1457 |
|
1457 | |||
1458 | If a filename is given, it is stuffed in the exception instead |
|
1458 | If a filename is given, it is stuffed in the exception instead | |
1459 | of what was there before (because Python's parser always uses |
|
1459 | of what was there before (because Python's parser always uses | |
1460 | "<string>" when reading from a string). |
|
1460 | "<string>" when reading from a string). | |
1461 | """ |
|
1461 | """ | |
1462 | etype, value, last_traceback = sys.exc_info() |
|
1462 | etype, value, last_traceback = sys.exc_info() | |
1463 |
|
1463 | |||
1464 | # See note about these variables in showtraceback() below |
|
1464 | # See note about these variables in showtraceback() below | |
1465 | sys.last_type = etype |
|
1465 | sys.last_type = etype | |
1466 | sys.last_value = value |
|
1466 | sys.last_value = value | |
1467 | sys.last_traceback = last_traceback |
|
1467 | sys.last_traceback = last_traceback | |
1468 |
|
1468 | |||
1469 | if filename and etype is SyntaxError: |
|
1469 | if filename and etype is SyntaxError: | |
1470 | # Work hard to stuff the correct filename in the exception |
|
1470 | # Work hard to stuff the correct filename in the exception | |
1471 | try: |
|
1471 | try: | |
1472 | msg, (dummy_filename, lineno, offset, line) = value |
|
1472 | msg, (dummy_filename, lineno, offset, line) = value | |
1473 | except: |
|
1473 | except: | |
1474 | # Not the format we expect; leave it alone |
|
1474 | # Not the format we expect; leave it alone | |
1475 | pass |
|
1475 | pass | |
1476 | else: |
|
1476 | else: | |
1477 | # Stuff in the right filename |
|
1477 | # Stuff in the right filename | |
1478 | try: |
|
1478 | try: | |
1479 | # Assume SyntaxError is a class exception |
|
1479 | # Assume SyntaxError is a class exception | |
1480 | value = SyntaxError(msg, (filename, lineno, offset, line)) |
|
1480 | value = SyntaxError(msg, (filename, lineno, offset, line)) | |
1481 | except: |
|
1481 | except: | |
1482 | # If that failed, assume SyntaxError is a string |
|
1482 | # If that failed, assume SyntaxError is a string | |
1483 | value = msg, (filename, lineno, offset, line) |
|
1483 | value = msg, (filename, lineno, offset, line) | |
1484 | self.SyntaxTB(etype,value,[]) |
|
1484 | self.SyntaxTB(etype,value,[]) | |
1485 |
|
1485 | |||
1486 | def debugger(self,force=False): |
|
1486 | def debugger(self,force=False): | |
1487 | """Call the pydb/pdb debugger. |
|
1487 | """Call the pydb/pdb debugger. | |
1488 |
|
1488 | |||
1489 | Keywords: |
|
1489 | Keywords: | |
1490 |
|
1490 | |||
1491 | - force(False): by default, this routine checks the instance call_pdb |
|
1491 | - force(False): by default, this routine checks the instance call_pdb | |
1492 | flag and does not actually invoke the debugger if the flag is false. |
|
1492 | flag and does not actually invoke the debugger if the flag is false. | |
1493 | The 'force' option forces the debugger to activate even if the flag |
|
1493 | The 'force' option forces the debugger to activate even if the flag | |
1494 | is false. |
|
1494 | is false. | |
1495 | """ |
|
1495 | """ | |
1496 |
|
1496 | |||
1497 | if not (force or self.call_pdb): |
|
1497 | if not (force or self.call_pdb): | |
1498 | return |
|
1498 | return | |
1499 |
|
1499 | |||
1500 | if not hasattr(sys,'last_traceback'): |
|
1500 | if not hasattr(sys,'last_traceback'): | |
1501 | error('No traceback has been produced, nothing to debug.') |
|
1501 | error('No traceback has been produced, nothing to debug.') | |
1502 | return |
|
1502 | return | |
1503 |
|
1503 | |||
1504 | # use pydb if available |
|
1504 | # use pydb if available | |
1505 | if Debugger.has_pydb: |
|
1505 | if Debugger.has_pydb: | |
1506 | from pydb import pm |
|
1506 | from pydb import pm | |
1507 | else: |
|
1507 | else: | |
1508 | # fallback to our internal debugger |
|
1508 | # fallback to our internal debugger | |
1509 | pm = lambda : self.InteractiveTB.debugger(force=True) |
|
1509 | pm = lambda : self.InteractiveTB.debugger(force=True) | |
1510 | self.history_saving_wrapper(pm)() |
|
1510 | self.history_saving_wrapper(pm)() | |
1511 |
|
1511 | |||
1512 | def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None): |
|
1512 | def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None): | |
1513 | """Display the exception that just occurred. |
|
1513 | """Display the exception that just occurred. | |
1514 |
|
1514 | |||
1515 | If nothing is known about the exception, this is the method which |
|
1515 | If nothing is known about the exception, this is the method which | |
1516 | should be used throughout the code for presenting user tracebacks, |
|
1516 | should be used throughout the code for presenting user tracebacks, | |
1517 | rather than directly invoking the InteractiveTB object. |
|
1517 | rather than directly invoking the InteractiveTB object. | |
1518 |
|
1518 | |||
1519 | A specific showsyntaxerror() also exists, but this method can take |
|
1519 | A specific showsyntaxerror() also exists, but this method can take | |
1520 | care of calling it if needed, so unless you are explicitly catching a |
|
1520 | care of calling it if needed, so unless you are explicitly catching a | |
1521 | SyntaxError exception, don't try to analyze the stack manually and |
|
1521 | SyntaxError exception, don't try to analyze the stack manually and | |
1522 | simply call this method.""" |
|
1522 | simply call this method.""" | |
1523 |
|
1523 | |||
1524 |
|
1524 | |||
1525 | # Though this won't be called by syntax errors in the input line, |
|
1525 | # Though this won't be called by syntax errors in the input line, | |
1526 | # there may be SyntaxError cases whith imported code. |
|
1526 | # there may be SyntaxError cases whith imported code. | |
1527 |
|
1527 | |||
1528 | try: |
|
1528 | try: | |
1529 | if exc_tuple is None: |
|
1529 | if exc_tuple is None: | |
1530 | etype, value, tb = sys.exc_info() |
|
1530 | etype, value, tb = sys.exc_info() | |
1531 | else: |
|
1531 | else: | |
1532 | etype, value, tb = exc_tuple |
|
1532 | etype, value, tb = exc_tuple | |
1533 |
|
1533 | |||
1534 | if etype is SyntaxError: |
|
1534 | if etype is SyntaxError: | |
1535 | self.showsyntaxerror(filename) |
|
1535 | self.showsyntaxerror(filename) | |
1536 | elif etype is IPython.ipapi.UsageError: |
|
1536 | elif etype is IPython.ipapi.UsageError: | |
1537 | print "UsageError:", value |
|
1537 | print "UsageError:", value | |
1538 | else: |
|
1538 | else: | |
1539 | # WARNING: these variables are somewhat deprecated and not |
|
1539 | # WARNING: these variables are somewhat deprecated and not | |
1540 | # necessarily safe to use in a threaded environment, but tools |
|
1540 | # necessarily safe to use in a threaded environment, but tools | |
1541 | # like pdb depend on their existence, so let's set them. If we |
|
1541 | # like pdb depend on their existence, so let's set them. If we | |
1542 | # find problems in the field, we'll need to revisit their use. |
|
1542 | # find problems in the field, we'll need to revisit their use. | |
1543 | sys.last_type = etype |
|
1543 | sys.last_type = etype | |
1544 | sys.last_value = value |
|
1544 | sys.last_value = value | |
1545 | sys.last_traceback = tb |
|
1545 | sys.last_traceback = tb | |
1546 |
|
1546 | |||
1547 | if etype in self.custom_exceptions: |
|
1547 | if etype in self.custom_exceptions: | |
1548 | self.CustomTB(etype,value,tb) |
|
1548 | self.CustomTB(etype,value,tb) | |
1549 | else: |
|
1549 | else: | |
1550 | self.InteractiveTB(etype,value,tb,tb_offset=tb_offset) |
|
1550 | self.InteractiveTB(etype,value,tb,tb_offset=tb_offset) | |
1551 | if self.InteractiveTB.call_pdb and self.has_readline: |
|
1551 | if self.InteractiveTB.call_pdb and self.has_readline: | |
1552 | # pdb mucks up readline, fix it back |
|
1552 | # pdb mucks up readline, fix it back | |
1553 | self.set_completer() |
|
1553 | self.set_completer() | |
1554 | except KeyboardInterrupt: |
|
1554 | except KeyboardInterrupt: | |
1555 | self.write("\nKeyboardInterrupt\n") |
|
1555 | self.write("\nKeyboardInterrupt\n") | |
1556 |
|
1556 | |||
1557 |
|
1557 | |||
1558 |
|
1558 | |||
1559 | def mainloop(self,banner=None): |
|
1559 | def mainloop(self,banner=None): | |
1560 | """Creates the local namespace and starts the mainloop. |
|
1560 | """Creates the local namespace and starts the mainloop. | |
1561 |
|
1561 | |||
1562 | If an optional banner argument is given, it will override the |
|
1562 | If an optional banner argument is given, it will override the | |
1563 | internally created default banner.""" |
|
1563 | internally created default banner.""" | |
1564 |
|
1564 | |||
1565 | if self.rc.c: # Emulate Python's -c option |
|
1565 | if self.rc.c: # Emulate Python's -c option | |
1566 | self.exec_init_cmd() |
|
1566 | self.exec_init_cmd() | |
1567 | if banner is None: |
|
1567 | if banner is None: | |
1568 | if not self.rc.banner: |
|
1568 | if not self.rc.banner: | |
1569 | banner = '' |
|
1569 | banner = '' | |
1570 | # banner is string? Use it directly! |
|
1570 | # banner is string? Use it directly! | |
1571 | elif isinstance(self.rc.banner,basestring): |
|
1571 | elif isinstance(self.rc.banner,basestring): | |
1572 | banner = self.rc.banner |
|
1572 | banner = self.rc.banner | |
1573 | else: |
|
1573 | else: | |
1574 | banner = self.BANNER+self.banner2 |
|
1574 | banner = self.BANNER+self.banner2 | |
1575 |
|
1575 | |||
1576 | while 1: |
|
1576 | while 1: | |
1577 | try: |
|
1577 | try: | |
1578 | self.interact(banner) |
|
1578 | self.interact(banner) | |
1579 | #self.interact_with_readline() |
|
1579 | #self.interact_with_readline() | |
1580 | # XXX for testing of a readline-decoupled repl loop, call interact_with_readline above |
|
1580 | # XXX for testing of a readline-decoupled repl loop, call interact_with_readline above | |
1581 |
|
1581 | |||
1582 | break |
|
1582 | break | |
1583 | except KeyboardInterrupt: |
|
1583 | except KeyboardInterrupt: | |
1584 | # this should not be necessary, but KeyboardInterrupt |
|
1584 | # this should not be necessary, but KeyboardInterrupt | |
1585 | # handling seems rather unpredictable... |
|
1585 | # handling seems rather unpredictable... | |
1586 | self.write("\nKeyboardInterrupt in interact()\n") |
|
1586 | self.write("\nKeyboardInterrupt in interact()\n") | |
1587 |
|
1587 | |||
1588 | def exec_init_cmd(self): |
|
1588 | def exec_init_cmd(self): | |
1589 | """Execute a command given at the command line. |
|
1589 | """Execute a command given at the command line. | |
1590 |
|
1590 | |||
1591 | This emulates Python's -c option.""" |
|
1591 | This emulates Python's -c option.""" | |
1592 |
|
1592 | |||
1593 | #sys.argv = ['-c'] |
|
1593 | #sys.argv = ['-c'] | |
1594 | self.push(self.prefilter(self.rc.c, False)) |
|
1594 | self.push(self.prefilter(self.rc.c, False)) | |
1595 | if not self.rc.interact: |
|
1595 | if not self.rc.interact: | |
1596 | self.exit_now = True |
|
1596 | self.exit_now = True | |
1597 |
|
1597 | |||
1598 | def embed_mainloop(self,header='',local_ns=None,global_ns=None,stack_depth=0): |
|
1598 | def embed_mainloop(self,header='',local_ns=None,global_ns=None,stack_depth=0): | |
1599 | """Embeds IPython into a running python program. |
|
1599 | """Embeds IPython into a running python program. | |
1600 |
|
1600 | |||
1601 | Input: |
|
1601 | Input: | |
1602 |
|
1602 | |||
1603 | - header: An optional header message can be specified. |
|
1603 | - header: An optional header message can be specified. | |
1604 |
|
1604 | |||
1605 | - local_ns, global_ns: working namespaces. If given as None, the |
|
1605 | - local_ns, global_ns: working namespaces. If given as None, the | |
1606 | IPython-initialized one is updated with __main__.__dict__, so that |
|
1606 | IPython-initialized one is updated with __main__.__dict__, so that | |
1607 | program variables become visible but user-specific configuration |
|
1607 | program variables become visible but user-specific configuration | |
1608 | remains possible. |
|
1608 | remains possible. | |
1609 |
|
1609 | |||
1610 | - stack_depth: specifies how many levels in the stack to go to |
|
1610 | - stack_depth: specifies how many levels in the stack to go to | |
1611 | looking for namespaces (when local_ns and global_ns are None). This |
|
1611 | looking for namespaces (when local_ns and global_ns are None). This | |
1612 | allows an intermediate caller to make sure that this function gets |
|
1612 | allows an intermediate caller to make sure that this function gets | |
1613 | the namespace from the intended level in the stack. By default (0) |
|
1613 | the namespace from the intended level in the stack. By default (0) | |
1614 | it will get its locals and globals from the immediate caller. |
|
1614 | it will get its locals and globals from the immediate caller. | |
1615 |
|
1615 | |||
1616 | Warning: it's possible to use this in a program which is being run by |
|
1616 | Warning: it's possible to use this in a program which is being run by | |
1617 | IPython itself (via %run), but some funny things will happen (a few |
|
1617 | IPython itself (via %run), but some funny things will happen (a few | |
1618 | globals get overwritten). In the future this will be cleaned up, as |
|
1618 | globals get overwritten). In the future this will be cleaned up, as | |
1619 | there is no fundamental reason why it can't work perfectly.""" |
|
1619 | there is no fundamental reason why it can't work perfectly.""" | |
1620 |
|
1620 | |||
1621 | # Get locals and globals from caller |
|
1621 | # Get locals and globals from caller | |
1622 | if local_ns is None or global_ns is None: |
|
1622 | if local_ns is None or global_ns is None: | |
1623 | call_frame = sys._getframe(stack_depth).f_back |
|
1623 | call_frame = sys._getframe(stack_depth).f_back | |
1624 |
|
1624 | |||
1625 | if local_ns is None: |
|
1625 | if local_ns is None: | |
1626 | local_ns = call_frame.f_locals |
|
1626 | local_ns = call_frame.f_locals | |
1627 | if global_ns is None: |
|
1627 | if global_ns is None: | |
1628 | global_ns = call_frame.f_globals |
|
1628 | global_ns = call_frame.f_globals | |
1629 |
|
1629 | |||
1630 | # Update namespaces and fire up interpreter |
|
1630 | # Update namespaces and fire up interpreter | |
1631 |
|
1631 | |||
1632 | # The global one is easy, we can just throw it in |
|
1632 | # The global one is easy, we can just throw it in | |
1633 | self.user_global_ns = global_ns |
|
1633 | self.user_global_ns = global_ns | |
1634 |
|
1634 | |||
1635 | # but the user/local one is tricky: ipython needs it to store internal |
|
1635 | # but the user/local one is tricky: ipython needs it to store internal | |
1636 | # data, but we also need the locals. We'll copy locals in the user |
|
1636 | # data, but we also need the locals. We'll copy locals in the user | |
1637 | # one, but will track what got copied so we can delete them at exit. |
|
1637 | # one, but will track what got copied so we can delete them at exit. | |
1638 | # This is so that a later embedded call doesn't see locals from a |
|
1638 | # This is so that a later embedded call doesn't see locals from a | |
1639 | # previous call (which most likely existed in a separate scope). |
|
1639 | # previous call (which most likely existed in a separate scope). | |
1640 | local_varnames = local_ns.keys() |
|
1640 | local_varnames = local_ns.keys() | |
1641 | self.user_ns.update(local_ns) |
|
1641 | self.user_ns.update(local_ns) | |
1642 | #self.user_ns['local_ns'] = local_ns # dbg |
|
1642 | #self.user_ns['local_ns'] = local_ns # dbg | |
1643 |
|
1643 | |||
1644 | # Patch for global embedding to make sure that things don't overwrite |
|
1644 | # Patch for global embedding to make sure that things don't overwrite | |
1645 | # user globals accidentally. Thanks to Richard <rxe@renre-europe.com> |
|
1645 | # user globals accidentally. Thanks to Richard <rxe@renre-europe.com> | |
1646 | # FIXME. Test this a bit more carefully (the if.. is new) |
|
1646 | # FIXME. Test this a bit more carefully (the if.. is new) | |
1647 | if local_ns is None and global_ns is None: |
|
1647 | if local_ns is None and global_ns is None: | |
1648 | self.user_global_ns.update(__main__.__dict__) |
|
1648 | self.user_global_ns.update(__main__.__dict__) | |
1649 |
|
1649 | |||
1650 | # make sure the tab-completer has the correct frame information, so it |
|
1650 | # make sure the tab-completer has the correct frame information, so it | |
1651 | # actually completes using the frame's locals/globals |
|
1651 | # actually completes using the frame's locals/globals | |
1652 | self.set_completer_frame() |
|
1652 | self.set_completer_frame() | |
1653 |
|
1653 | |||
1654 | # before activating the interactive mode, we need to make sure that |
|
1654 | # before activating the interactive mode, we need to make sure that | |
1655 | # all names in the builtin namespace needed by ipython point to |
|
1655 | # all names in the builtin namespace needed by ipython point to | |
1656 | # ourselves, and not to other instances. |
|
1656 | # ourselves, and not to other instances. | |
1657 | self.add_builtins() |
|
1657 | self.add_builtins() | |
1658 |
|
1658 | |||
1659 | self.interact(header) |
|
1659 | self.interact(header) | |
1660 |
|
1660 | |||
1661 | # now, purge out the user namespace from anything we might have added |
|
1661 | # now, purge out the user namespace from anything we might have added | |
1662 | # from the caller's local namespace |
|
1662 | # from the caller's local namespace | |
1663 | delvar = self.user_ns.pop |
|
1663 | delvar = self.user_ns.pop | |
1664 | for var in local_varnames: |
|
1664 | for var in local_varnames: | |
1665 | delvar(var,None) |
|
1665 | delvar(var,None) | |
1666 | # and clean builtins we may have overridden |
|
1666 | # and clean builtins we may have overridden | |
1667 | self.clean_builtins() |
|
1667 | self.clean_builtins() | |
1668 |
|
1668 | |||
1669 | def interact_prompt(self): |
|
1669 | def interact_prompt(self): | |
1670 | """ Print the prompt (in read-eval-print loop) |
|
1670 | """ Print the prompt (in read-eval-print loop) | |
1671 |
|
1671 | |||
1672 | Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not |
|
1672 | Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not | |
1673 | used in standard IPython flow. |
|
1673 | used in standard IPython flow. | |
1674 | """ |
|
1674 | """ | |
1675 | if self.more: |
|
1675 | if self.more: | |
1676 | try: |
|
1676 | try: | |
1677 | prompt = self.hooks.generate_prompt(True) |
|
1677 | prompt = self.hooks.generate_prompt(True) | |
1678 | except: |
|
1678 | except: | |
1679 | self.showtraceback() |
|
1679 | self.showtraceback() | |
1680 | if self.autoindent: |
|
1680 | if self.autoindent: | |
1681 | self.rl_do_indent = True |
|
1681 | self.rl_do_indent = True | |
1682 |
|
1682 | |||
1683 | else: |
|
1683 | else: | |
1684 | try: |
|
1684 | try: | |
1685 | prompt = self.hooks.generate_prompt(False) |
|
1685 | prompt = self.hooks.generate_prompt(False) | |
1686 | except: |
|
1686 | except: | |
1687 | self.showtraceback() |
|
1687 | self.showtraceback() | |
1688 | self.write(prompt) |
|
1688 | self.write(prompt) | |
1689 |
|
1689 | |||
1690 | def interact_handle_input(self,line): |
|
1690 | def interact_handle_input(self,line): | |
1691 | """ Handle the input line (in read-eval-print loop) |
|
1691 | """ Handle the input line (in read-eval-print loop) | |
1692 |
|
1692 | |||
1693 | Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not |
|
1693 | Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not | |
1694 | used in standard IPython flow. |
|
1694 | used in standard IPython flow. | |
1695 | """ |
|
1695 | """ | |
1696 | if line.lstrip() == line: |
|
1696 | if line.lstrip() == line: | |
1697 | self.shadowhist.add(line.strip()) |
|
1697 | self.shadowhist.add(line.strip()) | |
1698 | lineout = self.prefilter(line,self.more) |
|
1698 | lineout = self.prefilter(line,self.more) | |
1699 |
|
1699 | |||
1700 | if line.strip(): |
|
1700 | if line.strip(): | |
1701 | if self.more: |
|
1701 | if self.more: | |
1702 | self.input_hist_raw[-1] += '%s\n' % line |
|
1702 | self.input_hist_raw[-1] += '%s\n' % line | |
1703 | else: |
|
1703 | else: | |
1704 | self.input_hist_raw.append('%s\n' % line) |
|
1704 | self.input_hist_raw.append('%s\n' % line) | |
1705 |
|
1705 | |||
1706 |
|
1706 | |||
1707 | self.more = self.push(lineout) |
|
1707 | self.more = self.push(lineout) | |
1708 | if (self.SyntaxTB.last_syntax_error and |
|
1708 | if (self.SyntaxTB.last_syntax_error and | |
1709 | self.rc.autoedit_syntax): |
|
1709 | self.rc.autoedit_syntax): | |
1710 | self.edit_syntax_error() |
|
1710 | self.edit_syntax_error() | |
1711 |
|
1711 | |||
1712 | def interact_with_readline(self): |
|
1712 | def interact_with_readline(self): | |
1713 | """ Demo of using interact_handle_input, interact_prompt |
|
1713 | """ Demo of using interact_handle_input, interact_prompt | |
1714 |
|
1714 | |||
1715 | This is the main read-eval-print loop. If you need to implement your own (e.g. for GUI), |
|
1715 | This is the main read-eval-print loop. If you need to implement your own (e.g. for GUI), | |
1716 | it should work like this. |
|
1716 | it should work like this. | |
1717 | """ |
|
1717 | """ | |
1718 | self.readline_startup_hook(self.pre_readline) |
|
1718 | self.readline_startup_hook(self.pre_readline) | |
1719 | while not self.exit_now: |
|
1719 | while not self.exit_now: | |
1720 | self.interact_prompt() |
|
1720 | self.interact_prompt() | |
1721 | if self.more: |
|
1721 | if self.more: | |
1722 | self.rl_do_indent = True |
|
1722 | self.rl_do_indent = True | |
1723 | else: |
|
1723 | else: | |
1724 | self.rl_do_indent = False |
|
1724 | self.rl_do_indent = False | |
1725 | line = raw_input_original().decode(self.stdin_encoding) |
|
1725 | line = raw_input_original().decode(self.stdin_encoding) | |
1726 | self.interact_handle_input(line) |
|
1726 | self.interact_handle_input(line) | |
1727 |
|
1727 | |||
1728 |
|
1728 | |||
1729 | def interact(self, banner=None): |
|
1729 | def interact(self, banner=None): | |
1730 | """Closely emulate the interactive Python console. |
|
1730 | """Closely emulate the interactive Python console. | |
1731 |
|
1731 | |||
1732 | The optional banner argument specify the banner to print |
|
1732 | The optional banner argument specify the banner to print | |
1733 | before the first interaction; by default it prints a banner |
|
1733 | before the first interaction; by default it prints a banner | |
1734 | similar to the one printed by the real Python interpreter, |
|
1734 | similar to the one printed by the real Python interpreter, | |
1735 | followed by the current class name in parentheses (so as not |
|
1735 | followed by the current class name in parentheses (so as not | |
1736 | to confuse this with the real interpreter -- since it's so |
|
1736 | to confuse this with the real interpreter -- since it's so | |
1737 | close!). |
|
1737 | close!). | |
1738 |
|
1738 | |||
1739 | """ |
|
1739 | """ | |
1740 |
|
1740 | |||
1741 | if self.exit_now: |
|
1741 | if self.exit_now: | |
1742 | # batch run -> do not interact |
|
1742 | # batch run -> do not interact | |
1743 | return |
|
1743 | return | |
1744 | cprt = 'Type "copyright", "credits" or "license" for more information.' |
|
1744 | cprt = 'Type "copyright", "credits" or "license" for more information.' | |
1745 | if banner is None: |
|
1745 | if banner is None: | |
1746 | self.write("Python %s on %s\n%s\n(%s)\n" % |
|
1746 | self.write("Python %s on %s\n%s\n(%s)\n" % | |
1747 | (sys.version, sys.platform, cprt, |
|
1747 | (sys.version, sys.platform, cprt, | |
1748 | self.__class__.__name__)) |
|
1748 | self.__class__.__name__)) | |
1749 | else: |
|
1749 | else: | |
1750 | self.write(banner) |
|
1750 | self.write(banner) | |
1751 |
|
1751 | |||
1752 | more = 0 |
|
1752 | more = 0 | |
1753 |
|
1753 | |||
1754 | # Mark activity in the builtins |
|
1754 | # Mark activity in the builtins | |
1755 | __builtin__.__dict__['__IPYTHON__active'] += 1 |
|
1755 | __builtin__.__dict__['__IPYTHON__active'] += 1 | |
1756 |
|
1756 | |||
1757 | if self.has_readline: |
|
1757 | if self.has_readline: | |
1758 | self.readline_startup_hook(self.pre_readline) |
|
1758 | self.readline_startup_hook(self.pre_readline) | |
1759 | # exit_now is set by a call to %Exit or %Quit |
|
1759 | # exit_now is set by a call to %Exit or %Quit | |
1760 |
|
1760 | |||
1761 | while not self.exit_now: |
|
1761 | while not self.exit_now: | |
1762 | self.hooks.pre_prompt_hook() |
|
1762 | self.hooks.pre_prompt_hook() | |
1763 | if more: |
|
1763 | if more: | |
1764 | try: |
|
1764 | try: | |
1765 | prompt = self.hooks.generate_prompt(True) |
|
1765 | prompt = self.hooks.generate_prompt(True) | |
1766 | except: |
|
1766 | except: | |
1767 | self.showtraceback() |
|
1767 | self.showtraceback() | |
1768 | if self.autoindent: |
|
1768 | if self.autoindent: | |
1769 | self.rl_do_indent = True |
|
1769 | self.rl_do_indent = True | |
1770 |
|
1770 | |||
1771 | else: |
|
1771 | else: | |
1772 | try: |
|
1772 | try: | |
1773 | prompt = self.hooks.generate_prompt(False) |
|
1773 | prompt = self.hooks.generate_prompt(False) | |
1774 | except: |
|
1774 | except: | |
1775 | self.showtraceback() |
|
1775 | self.showtraceback() | |
1776 | try: |
|
1776 | try: | |
1777 | line = self.raw_input(prompt,more) |
|
1777 | line = self.raw_input(prompt,more) | |
1778 | if self.exit_now: |
|
1778 | if self.exit_now: | |
1779 | # quick exit on sys.std[in|out] close |
|
1779 | # quick exit on sys.std[in|out] close | |
1780 | break |
|
1780 | break | |
1781 | if self.autoindent: |
|
1781 | if self.autoindent: | |
1782 | self.rl_do_indent = False |
|
1782 | self.rl_do_indent = False | |
1783 |
|
1783 | |||
1784 | except KeyboardInterrupt: |
|
1784 | except KeyboardInterrupt: | |
1785 | #double-guard against keyboardinterrupts during kbdint handling |
|
1785 | #double-guard against keyboardinterrupts during kbdint handling | |
1786 | try: |
|
1786 | try: | |
1787 | self.write('\nKeyboardInterrupt\n') |
|
1787 | self.write('\nKeyboardInterrupt\n') | |
1788 | self.resetbuffer() |
|
1788 | self.resetbuffer() | |
1789 | # keep cache in sync with the prompt counter: |
|
1789 | # keep cache in sync with the prompt counter: | |
1790 | self.outputcache.prompt_count -= 1 |
|
1790 | self.outputcache.prompt_count -= 1 | |
1791 |
|
1791 | |||
1792 | if self.autoindent: |
|
1792 | if self.autoindent: | |
1793 | self.indent_current_nsp = 0 |
|
1793 | self.indent_current_nsp = 0 | |
1794 | more = 0 |
|
1794 | more = 0 | |
1795 | except KeyboardInterrupt: |
|
1795 | except KeyboardInterrupt: | |
1796 | pass |
|
1796 | pass | |
1797 | except EOFError: |
|
1797 | except EOFError: | |
1798 | if self.autoindent: |
|
1798 | if self.autoindent: | |
1799 | self.rl_do_indent = False |
|
1799 | self.rl_do_indent = False | |
1800 | self.readline_startup_hook(None) |
|
1800 | self.readline_startup_hook(None) | |
1801 | self.write('\n') |
|
1801 | self.write('\n') | |
1802 | self.exit() |
|
1802 | self.exit() | |
1803 | except bdb.BdbQuit: |
|
1803 | except bdb.BdbQuit: | |
1804 | warn('The Python debugger has exited with a BdbQuit exception.\n' |
|
1804 | warn('The Python debugger has exited with a BdbQuit exception.\n' | |
1805 | 'Because of how pdb handles the stack, it is impossible\n' |
|
1805 | 'Because of how pdb handles the stack, it is impossible\n' | |
1806 | 'for IPython to properly format this particular exception.\n' |
|
1806 | 'for IPython to properly format this particular exception.\n' | |
1807 | 'IPython will resume normal operation.') |
|
1807 | 'IPython will resume normal operation.') | |
1808 | except: |
|
1808 | except: | |
1809 | # exceptions here are VERY RARE, but they can be triggered |
|
1809 | # exceptions here are VERY RARE, but they can be triggered | |
1810 | # asynchronously by signal handlers, for example. |
|
1810 | # asynchronously by signal handlers, for example. | |
1811 | self.showtraceback() |
|
1811 | self.showtraceback() | |
1812 | else: |
|
1812 | else: | |
1813 | more = self.push(line) |
|
1813 | more = self.push(line) | |
1814 | if (self.SyntaxTB.last_syntax_error and |
|
1814 | if (self.SyntaxTB.last_syntax_error and | |
1815 | self.rc.autoedit_syntax): |
|
1815 | self.rc.autoedit_syntax): | |
1816 | self.edit_syntax_error() |
|
1816 | self.edit_syntax_error() | |
1817 |
|
1817 | |||
1818 | # We are off again... |
|
1818 | # We are off again... | |
1819 | __builtin__.__dict__['__IPYTHON__active'] -= 1 |
|
1819 | __builtin__.__dict__['__IPYTHON__active'] -= 1 | |
1820 |
|
1820 | |||
1821 | def excepthook(self, etype, value, tb): |
|
1821 | def excepthook(self, etype, value, tb): | |
1822 | """One more defense for GUI apps that call sys.excepthook. |
|
1822 | """One more defense for GUI apps that call sys.excepthook. | |
1823 |
|
1823 | |||
1824 | GUI frameworks like wxPython trap exceptions and call |
|
1824 | GUI frameworks like wxPython trap exceptions and call | |
1825 | sys.excepthook themselves. I guess this is a feature that |
|
1825 | sys.excepthook themselves. I guess this is a feature that | |
1826 | enables them to keep running after exceptions that would |
|
1826 | enables them to keep running after exceptions that would | |
1827 | otherwise kill their mainloop. This is a bother for IPython |
|
1827 | otherwise kill their mainloop. This is a bother for IPython | |
1828 | which excepts to catch all of the program exceptions with a try: |
|
1828 | which excepts to catch all of the program exceptions with a try: | |
1829 | except: statement. |
|
1829 | except: statement. | |
1830 |
|
1830 | |||
1831 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if |
|
1831 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if | |
1832 | any app directly invokes sys.excepthook, it will look to the user like |
|
1832 | any app directly invokes sys.excepthook, it will look to the user like | |
1833 | IPython crashed. In order to work around this, we can disable the |
|
1833 | IPython crashed. In order to work around this, we can disable the | |
1834 | CrashHandler and replace it with this excepthook instead, which prints a |
|
1834 | CrashHandler and replace it with this excepthook instead, which prints a | |
1835 | regular traceback using our InteractiveTB. In this fashion, apps which |
|
1835 | regular traceback using our InteractiveTB. In this fashion, apps which | |
1836 | call sys.excepthook will generate a regular-looking exception from |
|
1836 | call sys.excepthook will generate a regular-looking exception from | |
1837 | IPython, and the CrashHandler will only be triggered by real IPython |
|
1837 | IPython, and the CrashHandler will only be triggered by real IPython | |
1838 | crashes. |
|
1838 | crashes. | |
1839 |
|
1839 | |||
1840 | This hook should be used sparingly, only in places which are not likely |
|
1840 | This hook should be used sparingly, only in places which are not likely | |
1841 | to be true IPython errors. |
|
1841 | to be true IPython errors. | |
1842 | """ |
|
1842 | """ | |
1843 | self.showtraceback((etype,value,tb),tb_offset=0) |
|
1843 | self.showtraceback((etype,value,tb),tb_offset=0) | |
1844 |
|
1844 | |||
1845 | def expand_aliases(self,fn,rest): |
|
1845 | def expand_aliases(self,fn,rest): | |
1846 | """ Expand multiple levels of aliases: |
|
1846 | """ Expand multiple levels of aliases: | |
1847 |
|
1847 | |||
1848 | if: |
|
1848 | if: | |
1849 |
|
1849 | |||
1850 | alias foo bar /tmp |
|
1850 | alias foo bar /tmp | |
1851 | alias baz foo |
|
1851 | alias baz foo | |
1852 |
|
1852 | |||
1853 | then: |
|
1853 | then: | |
1854 |
|
1854 | |||
1855 | baz huhhahhei -> bar /tmp huhhahhei |
|
1855 | baz huhhahhei -> bar /tmp huhhahhei | |
1856 |
|
1856 | |||
1857 | """ |
|
1857 | """ | |
1858 | line = fn + " " + rest |
|
1858 | line = fn + " " + rest | |
1859 |
|
1859 | |||
1860 | done = Set() |
|
1860 | done = Set() | |
1861 | while 1: |
|
1861 | while 1: | |
1862 | pre,fn,rest = prefilter.splitUserInput(line, |
|
1862 | pre,fn,rest = prefilter.splitUserInput(line, | |
1863 | prefilter.shell_line_split) |
|
1863 | prefilter.shell_line_split) | |
1864 | if fn in self.alias_table: |
|
1864 | if fn in self.alias_table: | |
1865 | if fn in done: |
|
1865 | if fn in done: | |
1866 | warn("Cyclic alias definition, repeated '%s'" % fn) |
|
1866 | warn("Cyclic alias definition, repeated '%s'" % fn) | |
1867 | return "" |
|
1867 | return "" | |
1868 | done.add(fn) |
|
1868 | done.add(fn) | |
1869 |
|
1869 | |||
1870 | l2 = self.transform_alias(fn,rest) |
|
1870 | l2 = self.transform_alias(fn,rest) | |
1871 | # dir -> dir |
|
1871 | # dir -> dir | |
1872 | # print "alias",line, "->",l2 #dbg |
|
1872 | # print "alias",line, "->",l2 #dbg | |
1873 | if l2 == line: |
|
1873 | if l2 == line: | |
1874 | break |
|
1874 | break | |
1875 | # ls -> ls -F should not recurse forever |
|
1875 | # ls -> ls -F should not recurse forever | |
1876 | if l2.split(None,1)[0] == line.split(None,1)[0]: |
|
1876 | if l2.split(None,1)[0] == line.split(None,1)[0]: | |
1877 | line = l2 |
|
1877 | line = l2 | |
1878 | break |
|
1878 | break | |
1879 |
|
1879 | |||
1880 | line=l2 |
|
1880 | line=l2 | |
1881 |
|
1881 | |||
1882 |
|
1882 | |||
1883 | # print "al expand to",line #dbg |
|
1883 | # print "al expand to",line #dbg | |
1884 | else: |
|
1884 | else: | |
1885 | break |
|
1885 | break | |
1886 |
|
1886 | |||
1887 | return line |
|
1887 | return line | |
1888 |
|
1888 | |||
1889 | def transform_alias(self, alias,rest=''): |
|
1889 | def transform_alias(self, alias,rest=''): | |
1890 | """ Transform alias to system command string. |
|
1890 | """ Transform alias to system command string. | |
1891 | """ |
|
1891 | """ | |
1892 | trg = self.alias_table[alias] |
|
1892 | trg = self.alias_table[alias] | |
1893 |
|
1893 | |||
1894 | nargs,cmd = trg |
|
1894 | nargs,cmd = trg | |
1895 | # print trg #dbg |
|
1895 | # print trg #dbg | |
1896 | if ' ' in cmd and os.path.isfile(cmd): |
|
1896 | if ' ' in cmd and os.path.isfile(cmd): | |
1897 | cmd = '"%s"' % cmd |
|
1897 | cmd = '"%s"' % cmd | |
1898 |
|
1898 | |||
1899 | # Expand the %l special to be the user's input line |
|
1899 | # Expand the %l special to be the user's input line | |
1900 | if cmd.find('%l') >= 0: |
|
1900 | if cmd.find('%l') >= 0: | |
1901 | cmd = cmd.replace('%l',rest) |
|
1901 | cmd = cmd.replace('%l',rest) | |
1902 | rest = '' |
|
1902 | rest = '' | |
1903 | if nargs==0: |
|
1903 | if nargs==0: | |
1904 | # Simple, argument-less aliases |
|
1904 | # Simple, argument-less aliases | |
1905 | cmd = '%s %s' % (cmd,rest) |
|
1905 | cmd = '%s %s' % (cmd,rest) | |
1906 | else: |
|
1906 | else: | |
1907 | # Handle aliases with positional arguments |
|
1907 | # Handle aliases with positional arguments | |
1908 | args = rest.split(None,nargs) |
|
1908 | args = rest.split(None,nargs) | |
1909 | if len(args)< nargs: |
|
1909 | if len(args)< nargs: | |
1910 | error('Alias <%s> requires %s arguments, %s given.' % |
|
1910 | error('Alias <%s> requires %s arguments, %s given.' % | |
1911 | (alias,nargs,len(args))) |
|
1911 | (alias,nargs,len(args))) | |
1912 | return None |
|
1912 | return None | |
1913 | cmd = '%s %s' % (cmd % tuple(args[:nargs]),' '.join(args[nargs:])) |
|
1913 | cmd = '%s %s' % (cmd % tuple(args[:nargs]),' '.join(args[nargs:])) | |
1914 | # Now call the macro, evaluating in the user's namespace |
|
1914 | # Now call the macro, evaluating in the user's namespace | |
1915 | #print 'new command: <%r>' % cmd # dbg |
|
1915 | #print 'new command: <%r>' % cmd # dbg | |
1916 | return cmd |
|
1916 | return cmd | |
1917 |
|
1917 | |||
1918 | def call_alias(self,alias,rest=''): |
|
1918 | def call_alias(self,alias,rest=''): | |
1919 | """Call an alias given its name and the rest of the line. |
|
1919 | """Call an alias given its name and the rest of the line. | |
1920 |
|
1920 | |||
1921 | This is only used to provide backwards compatibility for users of |
|
1921 | This is only used to provide backwards compatibility for users of | |
1922 | ipalias(), use of which is not recommended for anymore.""" |
|
1922 | ipalias(), use of which is not recommended for anymore.""" | |
1923 |
|
1923 | |||
1924 | # Now call the macro, evaluating in the user's namespace |
|
1924 | # Now call the macro, evaluating in the user's namespace | |
1925 | cmd = self.transform_alias(alias, rest) |
|
1925 | cmd = self.transform_alias(alias, rest) | |
1926 | try: |
|
1926 | try: | |
1927 | self.system(cmd) |
|
1927 | self.system(cmd) | |
1928 | except: |
|
1928 | except: | |
1929 | self.showtraceback() |
|
1929 | self.showtraceback() | |
1930 |
|
1930 | |||
1931 | def indent_current_str(self): |
|
1931 | def indent_current_str(self): | |
1932 | """return the current level of indentation as a string""" |
|
1932 | """return the current level of indentation as a string""" | |
1933 | return self.indent_current_nsp * ' ' |
|
1933 | return self.indent_current_nsp * ' ' | |
1934 |
|
1934 | |||
1935 | def autoindent_update(self,line): |
|
1935 | def autoindent_update(self,line): | |
1936 | """Keep track of the indent level.""" |
|
1936 | """Keep track of the indent level.""" | |
1937 |
|
1937 | |||
1938 | #debugx('line') |
|
1938 | #debugx('line') | |
1939 | #debugx('self.indent_current_nsp') |
|
1939 | #debugx('self.indent_current_nsp') | |
1940 | if self.autoindent: |
|
1940 | if self.autoindent: | |
1941 | if line: |
|
1941 | if line: | |
1942 | inisp = num_ini_spaces(line) |
|
1942 | inisp = num_ini_spaces(line) | |
1943 | if inisp < self.indent_current_nsp: |
|
1943 | if inisp < self.indent_current_nsp: | |
1944 | self.indent_current_nsp = inisp |
|
1944 | self.indent_current_nsp = inisp | |
1945 |
|
1945 | |||
1946 | if line[-1] == ':': |
|
1946 | if line[-1] == ':': | |
1947 | self.indent_current_nsp += 4 |
|
1947 | self.indent_current_nsp += 4 | |
1948 | elif dedent_re.match(line): |
|
1948 | elif dedent_re.match(line): | |
1949 | self.indent_current_nsp -= 4 |
|
1949 | self.indent_current_nsp -= 4 | |
1950 | else: |
|
1950 | else: | |
1951 | self.indent_current_nsp = 0 |
|
1951 | self.indent_current_nsp = 0 | |
1952 |
|
1952 | |||
1953 | def runlines(self,lines): |
|
1953 | def runlines(self,lines): | |
1954 | """Run a string of one or more lines of source. |
|
1954 | """Run a string of one or more lines of source. | |
1955 |
|
1955 | |||
1956 | This method is capable of running a string containing multiple source |
|
1956 | This method is capable of running a string containing multiple source | |
1957 | lines, as if they had been entered at the IPython prompt. Since it |
|
1957 | lines, as if they had been entered at the IPython prompt. Since it | |
1958 | exposes IPython's processing machinery, the given strings can contain |
|
1958 | exposes IPython's processing machinery, the given strings can contain | |
1959 | magic calls (%magic), special shell access (!cmd), etc.""" |
|
1959 | magic calls (%magic), special shell access (!cmd), etc.""" | |
1960 |
|
1960 | |||
1961 | # We must start with a clean buffer, in case this is run from an |
|
1961 | # We must start with a clean buffer, in case this is run from an | |
1962 | # interactive IPython session (via a magic, for example). |
|
1962 | # interactive IPython session (via a magic, for example). | |
1963 | self.resetbuffer() |
|
1963 | self.resetbuffer() | |
1964 | lines = lines.split('\n') |
|
1964 | lines = lines.split('\n') | |
1965 | more = 0 |
|
1965 | more = 0 | |
1966 |
|
1966 | |||
1967 | for line in lines: |
|
1967 | for line in lines: | |
1968 | # skip blank lines so we don't mess up the prompt counter, but do |
|
1968 | # skip blank lines so we don't mess up the prompt counter, but do | |
1969 | # NOT skip even a blank line if we are in a code block (more is |
|
1969 | # NOT skip even a blank line if we are in a code block (more is | |
1970 | # true) |
|
1970 | # true) | |
1971 |
|
1971 | |||
1972 |
|
1972 | |||
1973 | if line or more: |
|
1973 | if line or more: | |
1974 | # push to raw history, so hist line numbers stay in sync |
|
1974 | # push to raw history, so hist line numbers stay in sync | |
1975 | self.input_hist_raw.append("# " + line + "\n") |
|
1975 | self.input_hist_raw.append("# " + line + "\n") | |
1976 | more = self.push(self.prefilter(line,more)) |
|
1976 | more = self.push(self.prefilter(line,more)) | |
1977 | # IPython's runsource returns None if there was an error |
|
1977 | # IPython's runsource returns None if there was an error | |
1978 | # compiling the code. This allows us to stop processing right |
|
1978 | # compiling the code. This allows us to stop processing right | |
1979 | # away, so the user gets the error message at the right place. |
|
1979 | # away, so the user gets the error message at the right place. | |
1980 | if more is None: |
|
1980 | if more is None: | |
1981 | break |
|
1981 | break | |
1982 | else: |
|
1982 | else: | |
1983 | self.input_hist_raw.append("\n") |
|
1983 | self.input_hist_raw.append("\n") | |
1984 | # final newline in case the input didn't have it, so that the code |
|
1984 | # final newline in case the input didn't have it, so that the code | |
1985 | # actually does get executed |
|
1985 | # actually does get executed | |
1986 | if more: |
|
1986 | if more: | |
1987 | self.push('\n') |
|
1987 | self.push('\n') | |
1988 |
|
1988 | |||
1989 | def runsource(self, source, filename='<input>', symbol='single'): |
|
1989 | def runsource(self, source, filename='<input>', symbol='single'): | |
1990 | """Compile and run some source in the interpreter. |
|
1990 | """Compile and run some source in the interpreter. | |
1991 |
|
1991 | |||
1992 | Arguments are as for compile_command(). |
|
1992 | Arguments are as for compile_command(). | |
1993 |
|
1993 | |||
1994 | One several things can happen: |
|
1994 | One several things can happen: | |
1995 |
|
1995 | |||
1996 | 1) The input is incorrect; compile_command() raised an |
|
1996 | 1) The input is incorrect; compile_command() raised an | |
1997 | exception (SyntaxError or OverflowError). A syntax traceback |
|
1997 | exception (SyntaxError or OverflowError). A syntax traceback | |
1998 | will be printed by calling the showsyntaxerror() method. |
|
1998 | will be printed by calling the showsyntaxerror() method. | |
1999 |
|
1999 | |||
2000 | 2) The input is incomplete, and more input is required; |
|
2000 | 2) The input is incomplete, and more input is required; | |
2001 | compile_command() returned None. Nothing happens. |
|
2001 | compile_command() returned None. Nothing happens. | |
2002 |
|
2002 | |||
2003 | 3) The input is complete; compile_command() returned a code |
|
2003 | 3) The input is complete; compile_command() returned a code | |
2004 | object. The code is executed by calling self.runcode() (which |
|
2004 | object. The code is executed by calling self.runcode() (which | |
2005 | also handles run-time exceptions, except for SystemExit). |
|
2005 | also handles run-time exceptions, except for SystemExit). | |
2006 |
|
2006 | |||
2007 | The return value is: |
|
2007 | The return value is: | |
2008 |
|
2008 | |||
2009 | - True in case 2 |
|
2009 | - True in case 2 | |
2010 |
|
2010 | |||
2011 | - False in the other cases, unless an exception is raised, where |
|
2011 | - False in the other cases, unless an exception is raised, where | |
2012 | None is returned instead. This can be used by external callers to |
|
2012 | None is returned instead. This can be used by external callers to | |
2013 | know whether to continue feeding input or not. |
|
2013 | know whether to continue feeding input or not. | |
2014 |
|
2014 | |||
2015 | The return value can be used to decide whether to use sys.ps1 or |
|
2015 | The return value can be used to decide whether to use sys.ps1 or | |
2016 | sys.ps2 to prompt the next line.""" |
|
2016 | sys.ps2 to prompt the next line.""" | |
2017 |
|
2017 | |||
2018 | # if the source code has leading blanks, add 'if 1:\n' to it |
|
2018 | # if the source code has leading blanks, add 'if 1:\n' to it | |
2019 | # this allows execution of indented pasted code. It is tempting |
|
2019 | # this allows execution of indented pasted code. It is tempting | |
2020 | # to add '\n' at the end of source to run commands like ' a=1' |
|
2020 | # to add '\n' at the end of source to run commands like ' a=1' | |
2021 | # directly, but this fails for more complicated scenarios |
|
2021 | # directly, but this fails for more complicated scenarios | |
2022 | source=source.encode(self.stdin_encoding) |
|
2022 | source=source.encode(self.stdin_encoding) | |
2023 | if source[:1] in [' ', '\t']: |
|
2023 | if source[:1] in [' ', '\t']: | |
2024 | source = 'if 1:\n%s' % source |
|
2024 | source = 'if 1:\n%s' % source | |
2025 |
|
2025 | |||
2026 | try: |
|
2026 | try: | |
2027 | code = self.compile(source,filename,symbol) |
|
2027 | code = self.compile(source,filename,symbol) | |
2028 | except (OverflowError, SyntaxError, ValueError, TypeError): |
|
2028 | except (OverflowError, SyntaxError, ValueError, TypeError): | |
2029 | # Case 1 |
|
2029 | # Case 1 | |
2030 | self.showsyntaxerror(filename) |
|
2030 | self.showsyntaxerror(filename) | |
2031 | return None |
|
2031 | return None | |
2032 |
|
2032 | |||
2033 | if code is None: |
|
2033 | if code is None: | |
2034 | # Case 2 |
|
2034 | # Case 2 | |
2035 | return True |
|
2035 | return True | |
2036 |
|
2036 | |||
2037 | # Case 3 |
|
2037 | # Case 3 | |
2038 | # We store the code object so that threaded shells and |
|
2038 | # We store the code object so that threaded shells and | |
2039 | # custom exception handlers can access all this info if needed. |
|
2039 | # custom exception handlers can access all this info if needed. | |
2040 | # The source corresponding to this can be obtained from the |
|
2040 | # The source corresponding to this can be obtained from the | |
2041 | # buffer attribute as '\n'.join(self.buffer). |
|
2041 | # buffer attribute as '\n'.join(self.buffer). | |
2042 | self.code_to_run = code |
|
2042 | self.code_to_run = code | |
2043 | # now actually execute the code object |
|
2043 | # now actually execute the code object | |
2044 | if self.runcode(code) == 0: |
|
2044 | if self.runcode(code) == 0: | |
2045 | return False |
|
2045 | return False | |
2046 | else: |
|
2046 | else: | |
2047 | return None |
|
2047 | return None | |
2048 |
|
2048 | |||
2049 | def runcode(self,code_obj): |
|
2049 | def runcode(self,code_obj): | |
2050 | """Execute a code object. |
|
2050 | """Execute a code object. | |
2051 |
|
2051 | |||
2052 | When an exception occurs, self.showtraceback() is called to display a |
|
2052 | When an exception occurs, self.showtraceback() is called to display a | |
2053 | traceback. |
|
2053 | traceback. | |
2054 |
|
2054 | |||
2055 | Return value: a flag indicating whether the code to be run completed |
|
2055 | Return value: a flag indicating whether the code to be run completed | |
2056 | successfully: |
|
2056 | successfully: | |
2057 |
|
2057 | |||
2058 | - 0: successful execution. |
|
2058 | - 0: successful execution. | |
2059 | - 1: an error occurred. |
|
2059 | - 1: an error occurred. | |
2060 | """ |
|
2060 | """ | |
2061 |
|
2061 | |||
2062 | # Set our own excepthook in case the user code tries to call it |
|
2062 | # Set our own excepthook in case the user code tries to call it | |
2063 | # directly, so that the IPython crash handler doesn't get triggered |
|
2063 | # directly, so that the IPython crash handler doesn't get triggered | |
2064 | old_excepthook,sys.excepthook = sys.excepthook, self.excepthook |
|
2064 | old_excepthook,sys.excepthook = sys.excepthook, self.excepthook | |
2065 |
|
2065 | |||
2066 | # we save the original sys.excepthook in the instance, in case config |
|
2066 | # we save the original sys.excepthook in the instance, in case config | |
2067 | # code (such as magics) needs access to it. |
|
2067 | # code (such as magics) needs access to it. | |
2068 | self.sys_excepthook = old_excepthook |
|
2068 | self.sys_excepthook = old_excepthook | |
2069 | outflag = 1 # happens in more places, so it's easier as default |
|
2069 | outflag = 1 # happens in more places, so it's easier as default | |
2070 | try: |
|
2070 | try: | |
2071 | try: |
|
2071 | try: | |
2072 | self.hooks.pre_runcode_hook() |
|
2072 | self.hooks.pre_runcode_hook() | |
2073 | # Embedded instances require separate global/local namespaces |
|
2073 | # Embedded instances require separate global/local namespaces | |
2074 | # so they can see both the surrounding (local) namespace and |
|
2074 | # so they can see both the surrounding (local) namespace and | |
2075 | # the module-level globals when called inside another function. |
|
2075 | # the module-level globals when called inside another function. | |
2076 | if self.embedded: |
|
2076 | if self.embedded: | |
2077 | exec code_obj in self.user_global_ns, self.user_ns |
|
2077 | exec code_obj in self.user_global_ns, self.user_ns | |
2078 | # Normal (non-embedded) instances should only have a single |
|
2078 | # Normal (non-embedded) instances should only have a single | |
2079 | # namespace for user code execution, otherwise functions won't |
|
2079 | # namespace for user code execution, otherwise functions won't | |
2080 | # see interactive top-level globals. |
|
2080 | # see interactive top-level globals. | |
2081 | else: |
|
2081 | else: | |
2082 | exec code_obj in self.user_ns |
|
2082 | exec code_obj in self.user_ns | |
2083 | finally: |
|
2083 | finally: | |
2084 | # Reset our crash handler in place |
|
2084 | # Reset our crash handler in place | |
2085 | sys.excepthook = old_excepthook |
|
2085 | sys.excepthook = old_excepthook | |
2086 | except SystemExit: |
|
2086 | except SystemExit: | |
2087 | self.resetbuffer() |
|
2087 | self.resetbuffer() | |
2088 | self.showtraceback() |
|
2088 | self.showtraceback() | |
2089 | warn("Type %exit or %quit to exit IPython " |
|
2089 | warn("Type %exit or %quit to exit IPython " | |
2090 | "(%Exit or %Quit do so unconditionally).",level=1) |
|
2090 | "(%Exit or %Quit do so unconditionally).",level=1) | |
2091 | except self.custom_exceptions: |
|
2091 | except self.custom_exceptions: | |
2092 | etype,value,tb = sys.exc_info() |
|
2092 | etype,value,tb = sys.exc_info() | |
2093 | self.CustomTB(etype,value,tb) |
|
2093 | self.CustomTB(etype,value,tb) | |
2094 | except: |
|
2094 | except: | |
2095 | self.showtraceback() |
|
2095 | self.showtraceback() | |
2096 | else: |
|
2096 | else: | |
2097 | outflag = 0 |
|
2097 | outflag = 0 | |
2098 | if softspace(sys.stdout, 0): |
|
2098 | if softspace(sys.stdout, 0): | |
2099 |
|
2099 | |||
2100 | # Flush out code object which has been run (and source) |
|
2100 | # Flush out code object which has been run (and source) | |
2101 | self.code_to_run = None |
|
2101 | self.code_to_run = None | |
2102 | return outflag |
|
2102 | return outflag | |
2103 |
|
2103 | |||
2104 | def push(self, line): |
|
2104 | def push(self, line): | |
2105 | """Push a line to the interpreter. |
|
2105 | """Push a line to the interpreter. | |
2106 |
|
2106 | |||
2107 | The line should not have a trailing newline; it may have |
|
2107 | The line should not have a trailing newline; it may have | |
2108 | internal newlines. The line is appended to a buffer and the |
|
2108 | internal newlines. The line is appended to a buffer and the | |
2109 | interpreter's runsource() method is called with the |
|
2109 | interpreter's runsource() method is called with the | |
2110 | concatenated contents of the buffer as source. If this |
|
2110 | concatenated contents of the buffer as source. If this | |
2111 | indicates that the command was executed or invalid, the buffer |
|
2111 | indicates that the command was executed or invalid, the buffer | |
2112 | is reset; otherwise, the command is incomplete, and the buffer |
|
2112 | is reset; otherwise, the command is incomplete, and the buffer | |
2113 | is left as it was after the line was appended. The return |
|
2113 | is left as it was after the line was appended. The return | |
2114 | value is 1 if more input is required, 0 if the line was dealt |
|
2114 | value is 1 if more input is required, 0 if the line was dealt | |
2115 | with in some way (this is the same as runsource()). |
|
2115 | with in some way (this is the same as runsource()). | |
2116 | """ |
|
2116 | """ | |
2117 |
|
2117 | |||
2118 | # autoindent management should be done here, and not in the |
|
2118 | # autoindent management should be done here, and not in the | |
2119 | # interactive loop, since that one is only seen by keyboard input. We |
|
2119 | # interactive loop, since that one is only seen by keyboard input. We | |
2120 | # need this done correctly even for code run via runlines (which uses |
|
2120 | # need this done correctly even for code run via runlines (which uses | |
2121 | # push). |
|
2121 | # push). | |
2122 |
|
2122 | |||
2123 | #print 'push line: <%s>' % line # dbg |
|
2123 | #print 'push line: <%s>' % line # dbg | |
2124 | for subline in line.splitlines(): |
|
2124 | for subline in line.splitlines(): | |
2125 | self.autoindent_update(subline) |
|
2125 | self.autoindent_update(subline) | |
2126 | self.buffer.append(line) |
|
2126 | self.buffer.append(line) | |
2127 | more = self.runsource('\n'.join(self.buffer), self.filename) |
|
2127 | more = self.runsource('\n'.join(self.buffer), self.filename) | |
2128 | if not more: |
|
2128 | if not more: | |
2129 | self.resetbuffer() |
|
2129 | self.resetbuffer() | |
2130 | return more |
|
2130 | return more | |
2131 |
|
2131 | |||
2132 | def split_user_input(self, line): |
|
2132 | def split_user_input(self, line): | |
2133 | # This is really a hold-over to support ipapi and some extensions |
|
2133 | # This is really a hold-over to support ipapi and some extensions | |
2134 | return prefilter.splitUserInput(line) |
|
2134 | return prefilter.splitUserInput(line) | |
2135 |
|
2135 | |||
2136 | def resetbuffer(self): |
|
2136 | def resetbuffer(self): | |
2137 | """Reset the input buffer.""" |
|
2137 | """Reset the input buffer.""" | |
2138 | self.buffer[:] = [] |
|
2138 | self.buffer[:] = [] | |
2139 |
|
2139 | |||
2140 | def raw_input(self,prompt='',continue_prompt=False): |
|
2140 | def raw_input(self,prompt='',continue_prompt=False): | |
2141 | """Write a prompt and read a line. |
|
2141 | """Write a prompt and read a line. | |
2142 |
|
2142 | |||
2143 | The returned line does not include the trailing newline. |
|
2143 | The returned line does not include the trailing newline. | |
2144 | When the user enters the EOF key sequence, EOFError is raised. |
|
2144 | When the user enters the EOF key sequence, EOFError is raised. | |
2145 |
|
2145 | |||
2146 | Optional inputs: |
|
2146 | Optional inputs: | |
2147 |
|
2147 | |||
2148 | - prompt(''): a string to be printed to prompt the user. |
|
2148 | - prompt(''): a string to be printed to prompt the user. | |
2149 |
|
2149 | |||
2150 | - continue_prompt(False): whether this line is the first one or a |
|
2150 | - continue_prompt(False): whether this line is the first one or a | |
2151 | continuation in a sequence of inputs. |
|
2151 | continuation in a sequence of inputs. | |
2152 | """ |
|
2152 | """ | |
2153 |
|
2153 | |||
2154 | # Code run by the user may have modified the readline completer state. |
|
2154 | # Code run by the user may have modified the readline completer state. | |
2155 | # We must ensure that our completer is back in place. |
|
2155 | # We must ensure that our completer is back in place. | |
2156 | if self.has_readline: |
|
2156 | if self.has_readline: | |
2157 | self.set_completer() |
|
2157 | self.set_completer() | |
2158 |
|
2158 | |||
2159 | try: |
|
2159 | try: | |
2160 | line = raw_input_original(prompt).decode(self.stdin_encoding) |
|
2160 | line = raw_input_original(prompt).decode(self.stdin_encoding) | |
2161 | except ValueError: |
|
2161 | except ValueError: | |
2162 | warn("\n********\nYou or a %run:ed script called sys.stdin.close()" |
|
2162 | warn("\n********\nYou or a %run:ed script called sys.stdin.close()" | |
2163 | " or sys.stdout.close()!\nExiting IPython!") |
|
2163 | " or sys.stdout.close()!\nExiting IPython!") | |
2164 | self.exit_now = True |
|
2164 | self.exit_now = True | |
2165 | return "" |
|
2165 | return "" | |
2166 |
|
2166 | |||
2167 | # Try to be reasonably smart about not re-indenting pasted input more |
|
2167 | # Try to be reasonably smart about not re-indenting pasted input more | |
2168 | # than necessary. We do this by trimming out the auto-indent initial |
|
2168 | # than necessary. We do this by trimming out the auto-indent initial | |
2169 | # spaces, if the user's actual input started itself with whitespace. |
|
2169 | # spaces, if the user's actual input started itself with whitespace. | |
2170 | #debugx('self.buffer[-1]') |
|
2170 | #debugx('self.buffer[-1]') | |
2171 |
|
2171 | |||
2172 | if self.autoindent: |
|
2172 | if self.autoindent: | |
2173 | if num_ini_spaces(line) > self.indent_current_nsp: |
|
2173 | if num_ini_spaces(line) > self.indent_current_nsp: | |
2174 | line = line[self.indent_current_nsp:] |
|
2174 | line = line[self.indent_current_nsp:] | |
2175 | self.indent_current_nsp = 0 |
|
2175 | self.indent_current_nsp = 0 | |
2176 |
|
2176 | |||
2177 | # store the unfiltered input before the user has any chance to modify |
|
2177 | # store the unfiltered input before the user has any chance to modify | |
2178 | # it. |
|
2178 | # it. | |
2179 | if line.strip(): |
|
2179 | if line.strip(): | |
2180 | if continue_prompt: |
|
2180 | if continue_prompt: | |
2181 | self.input_hist_raw[-1] += '%s\n' % line |
|
2181 | self.input_hist_raw[-1] += '%s\n' % line | |
2182 | if self.has_readline: # and some config option is set? |
|
2182 | if self.has_readline: # and some config option is set? | |
2183 | try: |
|
2183 | try: | |
2184 | histlen = self.readline.get_current_history_length() |
|
2184 | histlen = self.readline.get_current_history_length() | |
2185 | if histlen > 1: |
|
2185 | if histlen > 1: | |
2186 | newhist = self.input_hist_raw[-1].rstrip() |
|
2186 | newhist = self.input_hist_raw[-1].rstrip() | |
2187 | self.readline.remove_history_item(histlen-1) |
|
2187 | self.readline.remove_history_item(histlen-1) | |
2188 | self.readline.replace_history_item(histlen-2, |
|
2188 | self.readline.replace_history_item(histlen-2, | |
2189 | newhist.encode(self.stdin_encoding)) |
|
2189 | newhist.encode(self.stdin_encoding)) | |
2190 | except AttributeError: |
|
2190 | except AttributeError: | |
2191 | pass # re{move,place}_history_item are new in 2.4. |
|
2191 | pass # re{move,place}_history_item are new in 2.4. | |
2192 | else: |
|
2192 | else: | |
2193 | self.input_hist_raw.append('%s\n' % line) |
|
2193 | self.input_hist_raw.append('%s\n' % line) | |
2194 | # only entries starting at first column go to shadow history |
|
2194 | # only entries starting at first column go to shadow history | |
2195 | if line.lstrip() == line: |
|
2195 | if line.lstrip() == line: | |
2196 | self.shadowhist.add(line.strip()) |
|
2196 | self.shadowhist.add(line.strip()) | |
2197 | elif not continue_prompt: |
|
2197 | elif not continue_prompt: | |
2198 | self.input_hist_raw.append('\n') |
|
2198 | self.input_hist_raw.append('\n') | |
2199 | try: |
|
2199 | try: | |
2200 | lineout = self.prefilter(line,continue_prompt) |
|
2200 | lineout = self.prefilter(line,continue_prompt) | |
2201 | except: |
|
2201 | except: | |
2202 | # blanket except, in case a user-defined prefilter crashes, so it |
|
2202 | # blanket except, in case a user-defined prefilter crashes, so it | |
2203 | # can't take all of ipython with it. |
|
2203 | # can't take all of ipython with it. | |
2204 | self.showtraceback() |
|
2204 | self.showtraceback() | |
2205 | return '' |
|
2205 | return '' | |
2206 | else: |
|
2206 | else: | |
2207 | return lineout |
|
2207 | return lineout | |
2208 |
|
2208 | |||
2209 | def _prefilter(self, line, continue_prompt): |
|
2209 | def _prefilter(self, line, continue_prompt): | |
2210 | """Calls different preprocessors, depending on the form of line.""" |
|
2210 | """Calls different preprocessors, depending on the form of line.""" | |
2211 |
|
2211 | |||
2212 | # All handlers *must* return a value, even if it's blank (''). |
|
2212 | # All handlers *must* return a value, even if it's blank (''). | |
2213 |
|
2213 | |||
2214 | # Lines are NOT logged here. Handlers should process the line as |
|
2214 | # Lines are NOT logged here. Handlers should process the line as | |
2215 | # needed, update the cache AND log it (so that the input cache array |
|
2215 | # needed, update the cache AND log it (so that the input cache array | |
2216 | # stays synced). |
|
2216 | # stays synced). | |
2217 |
|
2217 | |||
2218 | #..................................................................... |
|
2218 | #..................................................................... | |
2219 | # Code begins |
|
2219 | # Code begins | |
2220 |
|
2220 | |||
2221 | #if line.startswith('%crash'): raise RuntimeError,'Crash now!' # dbg |
|
2221 | #if line.startswith('%crash'): raise RuntimeError,'Crash now!' # dbg | |
2222 |
|
2222 | |||
2223 | # save the line away in case we crash, so the post-mortem handler can |
|
2223 | # save the line away in case we crash, so the post-mortem handler can | |
2224 | # record it |
|
2224 | # record it | |
2225 | self._last_input_line = line |
|
2225 | self._last_input_line = line | |
2226 |
|
2226 | |||
2227 | #print '***line: <%s>' % line # dbg |
|
2227 | #print '***line: <%s>' % line # dbg | |
2228 |
|
2228 | |||
2229 | if not line: |
|
2229 | if not line: | |
2230 | # Return immediately on purely empty lines, so that if the user |
|
2230 | # Return immediately on purely empty lines, so that if the user | |
2231 | # previously typed some whitespace that started a continuation |
|
2231 | # previously typed some whitespace that started a continuation | |
2232 | # prompt, he can break out of that loop with just an empty line. |
|
2232 | # prompt, he can break out of that loop with just an empty line. | |
2233 | # This is how the default python prompt works. |
|
2233 | # This is how the default python prompt works. | |
2234 |
|
2234 | |||
2235 | # Only return if the accumulated input buffer was just whitespace! |
|
2235 | # Only return if the accumulated input buffer was just whitespace! | |
2236 | if ''.join(self.buffer).isspace(): |
|
2236 | if ''.join(self.buffer).isspace(): | |
2237 | self.buffer[:] = [] |
|
2237 | self.buffer[:] = [] | |
2238 | return '' |
|
2238 | return '' | |
2239 |
|
2239 | |||
2240 | line_info = prefilter.LineInfo(line, continue_prompt) |
|
2240 | line_info = prefilter.LineInfo(line, continue_prompt) | |
2241 |
|
2241 | |||
2242 | # the input history needs to track even empty lines |
|
2242 | # the input history needs to track even empty lines | |
2243 | stripped = line.strip() |
|
2243 | stripped = line.strip() | |
2244 |
|
2244 | |||
2245 | if not stripped: |
|
2245 | if not stripped: | |
2246 | if not continue_prompt: |
|
2246 | if not continue_prompt: | |
2247 | self.outputcache.prompt_count -= 1 |
|
2247 | self.outputcache.prompt_count -= 1 | |
2248 | return self.handle_normal(line_info) |
|
2248 | return self.handle_normal(line_info) | |
2249 |
|
2249 | |||
2250 | # print '***cont',continue_prompt # dbg |
|
2250 | # print '***cont',continue_prompt # dbg | |
2251 | # special handlers are only allowed for single line statements |
|
2251 | # special handlers are only allowed for single line statements | |
2252 | if continue_prompt and not self.rc.multi_line_specials: |
|
2252 | if continue_prompt and not self.rc.multi_line_specials: | |
2253 | return self.handle_normal(line_info) |
|
2253 | return self.handle_normal(line_info) | |
2254 |
|
2254 | |||
2255 |
|
2255 | |||
2256 | # See whether any pre-existing handler can take care of it |
|
2256 | # See whether any pre-existing handler can take care of it | |
2257 | rewritten = self.hooks.input_prefilter(stripped) |
|
2257 | rewritten = self.hooks.input_prefilter(stripped) | |
2258 | if rewritten != stripped: # ok, some prefilter did something |
|
2258 | if rewritten != stripped: # ok, some prefilter did something | |
2259 | rewritten = line_info.pre + rewritten # add indentation |
|
2259 | rewritten = line_info.pre + rewritten # add indentation | |
2260 | return self.handle_normal(prefilter.LineInfo(rewritten, |
|
2260 | return self.handle_normal(prefilter.LineInfo(rewritten, | |
2261 | continue_prompt)) |
|
2261 | continue_prompt)) | |
2262 |
|
2262 | |||
2263 | #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg |
|
2263 | #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg | |
2264 |
|
2264 | |||
2265 | return prefilter.prefilter(line_info, self) |
|
2265 | return prefilter.prefilter(line_info, self) | |
2266 |
|
2266 | |||
2267 |
|
2267 | |||
2268 | def _prefilter_dumb(self, line, continue_prompt): |
|
2268 | def _prefilter_dumb(self, line, continue_prompt): | |
2269 | """simple prefilter function, for debugging""" |
|
2269 | """simple prefilter function, for debugging""" | |
2270 | return self.handle_normal(line,continue_prompt) |
|
2270 | return self.handle_normal(line,continue_prompt) | |
2271 |
|
2271 | |||
2272 |
|
2272 | |||
2273 | def multiline_prefilter(self, line, continue_prompt): |
|
2273 | def multiline_prefilter(self, line, continue_prompt): | |
2274 | """ Run _prefilter for each line of input |
|
2274 | """ Run _prefilter for each line of input | |
2275 |
|
2275 | |||
2276 | Covers cases where there are multiple lines in the user entry, |
|
2276 | Covers cases where there are multiple lines in the user entry, | |
2277 | which is the case when the user goes back to a multiline history |
|
2277 | which is the case when the user goes back to a multiline history | |
2278 | entry and presses enter. |
|
2278 | entry and presses enter. | |
2279 |
|
2279 | |||
2280 | """ |
|
2280 | """ | |
2281 | out = [] |
|
2281 | out = [] | |
2282 | for l in line.rstrip('\n').split('\n'): |
|
2282 | for l in line.rstrip('\n').split('\n'): | |
2283 | out.append(self._prefilter(l, continue_prompt)) |
|
2283 | out.append(self._prefilter(l, continue_prompt)) | |
2284 | return '\n'.join(out) |
|
2284 | return '\n'.join(out) | |
2285 |
|
2285 | |||
2286 | # Set the default prefilter() function (this can be user-overridden) |
|
2286 | # Set the default prefilter() function (this can be user-overridden) | |
2287 | prefilter = multiline_prefilter |
|
2287 | prefilter = multiline_prefilter | |
2288 |
|
2288 | |||
2289 | def handle_normal(self,line_info): |
|
2289 | def handle_normal(self,line_info): | |
2290 | """Handle normal input lines. Use as a template for handlers.""" |
|
2290 | """Handle normal input lines. Use as a template for handlers.""" | |
2291 |
|
2291 | |||
2292 | # With autoindent on, we need some way to exit the input loop, and I |
|
2292 | # With autoindent on, we need some way to exit the input loop, and I | |
2293 | # don't want to force the user to have to backspace all the way to |
|
2293 | # don't want to force the user to have to backspace all the way to | |
2294 | # clear the line. The rule will be in this case, that either two |
|
2294 | # clear the line. The rule will be in this case, that either two | |
2295 | # lines of pure whitespace in a row, or a line of pure whitespace but |
|
2295 | # lines of pure whitespace in a row, or a line of pure whitespace but | |
2296 | # of a size different to the indent level, will exit the input loop. |
|
2296 | # of a size different to the indent level, will exit the input loop. | |
2297 | line = line_info.line |
|
2297 | line = line_info.line | |
2298 | continue_prompt = line_info.continue_prompt |
|
2298 | continue_prompt = line_info.continue_prompt | |
2299 |
|
2299 | |||
2300 | if (continue_prompt and self.autoindent and line.isspace() and |
|
2300 | if (continue_prompt and self.autoindent and line.isspace() and | |
2301 | (0 < abs(len(line) - self.indent_current_nsp) <= 2 or |
|
2301 | (0 < abs(len(line) - self.indent_current_nsp) <= 2 or | |
2302 | (self.buffer[-1]).isspace() )): |
|
2302 | (self.buffer[-1]).isspace() )): | |
2303 | line = '' |
|
2303 | line = '' | |
2304 |
|
2304 | |||
2305 | self.log(line,line,continue_prompt) |
|
2305 | self.log(line,line,continue_prompt) | |
2306 | return line |
|
2306 | return line | |
2307 |
|
2307 | |||
2308 | def handle_alias(self,line_info): |
|
2308 | def handle_alias(self,line_info): | |
2309 | """Handle alias input lines. """ |
|
2309 | """Handle alias input lines. """ | |
2310 | tgt = self.alias_table[line_info.iFun] |
|
2310 | tgt = self.alias_table[line_info.iFun] | |
2311 | # print "=>",tgt #dbg |
|
2311 | # print "=>",tgt #dbg | |
2312 | if callable(tgt): |
|
2312 | if callable(tgt): | |
2313 | if '$' in line_info.line: |
|
2313 | if '$' in line_info.line: | |
2314 | call_meth = '(_ip, _ip.itpl(%s))' |
|
2314 | call_meth = '(_ip, _ip.itpl(%s))' | |
2315 | else: |
|
2315 | else: | |
2316 | call_meth = '(_ip,%s)' |
|
2316 | call_meth = '(_ip,%s)' | |
2317 | line_out = ("%s_sh.%s" + call_meth) % (line_info.preWhitespace, |
|
2317 | line_out = ("%s_sh.%s" + call_meth) % (line_info.preWhitespace, | |
2318 | line_info.iFun, |
|
2318 | line_info.iFun, | |
2319 | make_quoted_expr(line_info.line)) |
|
2319 | make_quoted_expr(line_info.line)) | |
2320 | else: |
|
2320 | else: | |
2321 | transformed = self.expand_aliases(line_info.iFun,line_info.theRest) |
|
2321 | transformed = self.expand_aliases(line_info.iFun,line_info.theRest) | |
2322 |
|
2322 | |||
2323 | # pre is needed, because it carries the leading whitespace. Otherwise |
|
2323 | # pre is needed, because it carries the leading whitespace. Otherwise | |
2324 | # aliases won't work in indented sections. |
|
2324 | # aliases won't work in indented sections. | |
2325 | line_out = '%s_ip.system(%s)' % (line_info.preWhitespace, |
|
2325 | line_out = '%s_ip.system(%s)' % (line_info.preWhitespace, | |
2326 | make_quoted_expr( transformed )) |
|
2326 | make_quoted_expr( transformed )) | |
2327 |
|
2327 | |||
2328 | self.log(line_info.line,line_out,line_info.continue_prompt) |
|
2328 | self.log(line_info.line,line_out,line_info.continue_prompt) | |
2329 | #print 'line out:',line_out # dbg |
|
2329 | #print 'line out:',line_out # dbg | |
2330 | return line_out |
|
2330 | return line_out | |
2331 |
|
2331 | |||
2332 | def handle_shell_escape(self, line_info): |
|
2332 | def handle_shell_escape(self, line_info): | |
2333 | """Execute the line in a shell, empty return value""" |
|
2333 | """Execute the line in a shell, empty return value""" | |
2334 | #print 'line in :', `line` # dbg |
|
2334 | #print 'line in :', `line` # dbg | |
2335 | line = line_info.line |
|
2335 | line = line_info.line | |
2336 | if line.lstrip().startswith('!!'): |
|
2336 | if line.lstrip().startswith('!!'): | |
2337 | # rewrite LineInfo's line, iFun and theRest to properly hold the |
|
2337 | # rewrite LineInfo's line, iFun and theRest to properly hold the | |
2338 | # call to %sx and the actual command to be executed, so |
|
2338 | # call to %sx and the actual command to be executed, so | |
2339 | # handle_magic can work correctly. Note that this works even if |
|
2339 | # handle_magic can work correctly. Note that this works even if | |
2340 | # the line is indented, so it handles multi_line_specials |
|
2340 | # the line is indented, so it handles multi_line_specials | |
2341 | # properly. |
|
2341 | # properly. | |
2342 | new_rest = line.lstrip()[2:] |
|
2342 | new_rest = line.lstrip()[2:] | |
2343 | line_info.line = '%ssx %s' % (self.ESC_MAGIC,new_rest) |
|
2343 | line_info.line = '%ssx %s' % (self.ESC_MAGIC,new_rest) | |
2344 | line_info.iFun = 'sx' |
|
2344 | line_info.iFun = 'sx' | |
2345 | line_info.theRest = new_rest |
|
2345 | line_info.theRest = new_rest | |
2346 | return self.handle_magic(line_info) |
|
2346 | return self.handle_magic(line_info) | |
2347 | else: |
|
2347 | else: | |
2348 | cmd = line.lstrip().lstrip('!') |
|
2348 | cmd = line.lstrip().lstrip('!') | |
2349 | line_out = '%s_ip.system(%s)' % (line_info.preWhitespace, |
|
2349 | line_out = '%s_ip.system(%s)' % (line_info.preWhitespace, | |
2350 | make_quoted_expr(cmd)) |
|
2350 | make_quoted_expr(cmd)) | |
2351 | # update cache/log and return |
|
2351 | # update cache/log and return | |
2352 | self.log(line,line_out,line_info.continue_prompt) |
|
2352 | self.log(line,line_out,line_info.continue_prompt) | |
2353 | return line_out |
|
2353 | return line_out | |
2354 |
|
2354 | |||
2355 | def handle_magic(self, line_info): |
|
2355 | def handle_magic(self, line_info): | |
2356 | """Execute magic functions.""" |
|
2356 | """Execute magic functions.""" | |
2357 | iFun = line_info.iFun |
|
2357 | iFun = line_info.iFun | |
2358 | theRest = line_info.theRest |
|
2358 | theRest = line_info.theRest | |
2359 | cmd = '%s_ip.magic(%s)' % (line_info.preWhitespace, |
|
2359 | cmd = '%s_ip.magic(%s)' % (line_info.preWhitespace, | |
2360 | make_quoted_expr(iFun + " " + theRest)) |
|
2360 | make_quoted_expr(iFun + " " + theRest)) | |
2361 | self.log(line_info.line,cmd,line_info.continue_prompt) |
|
2361 | self.log(line_info.line,cmd,line_info.continue_prompt) | |
2362 | #print 'in handle_magic, cmd=<%s>' % cmd # dbg |
|
2362 | #print 'in handle_magic, cmd=<%s>' % cmd # dbg | |
2363 | return cmd |
|
2363 | return cmd | |
2364 |
|
2364 | |||
2365 | def handle_auto(self, line_info): |
|
2365 | def handle_auto(self, line_info): | |
2366 | """Hande lines which can be auto-executed, quoting if requested.""" |
|
2366 | """Hande lines which can be auto-executed, quoting if requested.""" | |
2367 |
|
2367 | |||
2368 | line = line_info.line |
|
2368 | line = line_info.line | |
2369 | iFun = line_info.iFun |
|
2369 | iFun = line_info.iFun | |
2370 | theRest = line_info.theRest |
|
2370 | theRest = line_info.theRest | |
2371 | pre = line_info.pre |
|
2371 | pre = line_info.pre | |
2372 | continue_prompt = line_info.continue_prompt |
|
2372 | continue_prompt = line_info.continue_prompt | |
2373 | obj = line_info.ofind(self)['obj'] |
|
2373 | obj = line_info.ofind(self)['obj'] | |
2374 |
|
2374 | |||
2375 | #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg |
|
2375 | #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg | |
2376 |
|
2376 | |||
2377 | # This should only be active for single-line input! |
|
2377 | # This should only be active for single-line input! | |
2378 | if continue_prompt: |
|
2378 | if continue_prompt: | |
2379 | self.log(line,line,continue_prompt) |
|
2379 | self.log(line,line,continue_prompt) | |
2380 | return line |
|
2380 | return line | |
2381 |
|
2381 | |||
2382 | force_auto = isinstance(obj, IPython.ipapi.IPyAutocall) |
|
2382 | force_auto = isinstance(obj, IPython.ipapi.IPyAutocall) | |
2383 | auto_rewrite = True |
|
2383 | auto_rewrite = True | |
2384 |
|
2384 | |||
2385 | if pre == self.ESC_QUOTE: |
|
2385 | if pre == self.ESC_QUOTE: | |
2386 | # Auto-quote splitting on whitespace |
|
2386 | # Auto-quote splitting on whitespace | |
2387 | newcmd = '%s("%s")' % (iFun,'", "'.join(theRest.split()) ) |
|
2387 | newcmd = '%s("%s")' % (iFun,'", "'.join(theRest.split()) ) | |
2388 | elif pre == self.ESC_QUOTE2: |
|
2388 | elif pre == self.ESC_QUOTE2: | |
2389 | # Auto-quote whole string |
|
2389 | # Auto-quote whole string | |
2390 | newcmd = '%s("%s")' % (iFun,theRest) |
|
2390 | newcmd = '%s("%s")' % (iFun,theRest) | |
2391 | elif pre == self.ESC_PAREN: |
|
2391 | elif pre == self.ESC_PAREN: | |
2392 | newcmd = '%s(%s)' % (iFun,",".join(theRest.split())) |
|
2392 | newcmd = '%s(%s)' % (iFun,",".join(theRest.split())) | |
2393 | else: |
|
2393 | else: | |
2394 | # Auto-paren. |
|
2394 | # Auto-paren. | |
2395 | # We only apply it to argument-less calls if the autocall |
|
2395 | # We only apply it to argument-less calls if the autocall | |
2396 | # parameter is set to 2. We only need to check that autocall is < |
|
2396 | # parameter is set to 2. We only need to check that autocall is < | |
2397 | # 2, since this function isn't called unless it's at least 1. |
|
2397 | # 2, since this function isn't called unless it's at least 1. | |
2398 | if not theRest and (self.rc.autocall < 2) and not force_auto: |
|
2398 | if not theRest and (self.rc.autocall < 2) and not force_auto: | |
2399 | newcmd = '%s %s' % (iFun,theRest) |
|
2399 | newcmd = '%s %s' % (iFun,theRest) | |
2400 | auto_rewrite = False |
|
2400 | auto_rewrite = False | |
2401 | else: |
|
2401 | else: | |
2402 | if not force_auto and theRest.startswith('['): |
|
2402 | if not force_auto and theRest.startswith('['): | |
2403 | if hasattr(obj,'__getitem__'): |
|
2403 | if hasattr(obj,'__getitem__'): | |
2404 | # Don't autocall in this case: item access for an object |
|
2404 | # Don't autocall in this case: item access for an object | |
2405 | # which is BOTH callable and implements __getitem__. |
|
2405 | # which is BOTH callable and implements __getitem__. | |
2406 | newcmd = '%s %s' % (iFun,theRest) |
|
2406 | newcmd = '%s %s' % (iFun,theRest) | |
2407 | auto_rewrite = False |
|
2407 | auto_rewrite = False | |
2408 | else: |
|
2408 | else: | |
2409 | # if the object doesn't support [] access, go ahead and |
|
2409 | # if the object doesn't support [] access, go ahead and | |
2410 | # autocall |
|
2410 | # autocall | |
2411 | newcmd = '%s(%s)' % (iFun.rstrip(),theRest) |
|
2411 | newcmd = '%s(%s)' % (iFun.rstrip(),theRest) | |
2412 | elif theRest.endswith(';'): |
|
2412 | elif theRest.endswith(';'): | |
2413 | newcmd = '%s(%s);' % (iFun.rstrip(),theRest[:-1]) |
|
2413 | newcmd = '%s(%s);' % (iFun.rstrip(),theRest[:-1]) | |
2414 | else: |
|
2414 | else: | |
2415 | newcmd = '%s(%s)' % (iFun.rstrip(), theRest) |
|
2415 | newcmd = '%s(%s)' % (iFun.rstrip(), theRest) | |
2416 |
|
2416 | |||
2417 | if auto_rewrite: |
|
2417 | if auto_rewrite: | |
2418 | rw = self.outputcache.prompt1.auto_rewrite() + newcmd |
|
2418 | rw = self.outputcache.prompt1.auto_rewrite() + newcmd | |
2419 |
|
2419 | |||
2420 | try: |
|
2420 | try: | |
2421 | # plain ascii works better w/ pyreadline, on some machines, so |
|
2421 | # plain ascii works better w/ pyreadline, on some machines, so | |
2422 | # we use it and only print uncolored rewrite if we have unicode |
|
2422 | # we use it and only print uncolored rewrite if we have unicode | |
2423 | rw = str(rw) |
|
2423 | rw = str(rw) | |
2424 | print >>Term.cout, rw |
|
2424 | print >>Term.cout, rw | |
2425 | except UnicodeEncodeError: |
|
2425 | except UnicodeEncodeError: | |
2426 | print "-------------->" + newcmd |
|
2426 | print "-------------->" + newcmd | |
2427 |
|
2427 | |||
2428 | # log what is now valid Python, not the actual user input (without the |
|
2428 | # log what is now valid Python, not the actual user input (without the | |
2429 | # final newline) |
|
2429 | # final newline) | |
2430 | self.log(line,newcmd,continue_prompt) |
|
2430 | self.log(line,newcmd,continue_prompt) | |
2431 | return newcmd |
|
2431 | return newcmd | |
2432 |
|
2432 | |||
2433 | def handle_help(self, line_info): |
|
2433 | def handle_help(self, line_info): | |
2434 | """Try to get some help for the object. |
|
2434 | """Try to get some help for the object. | |
2435 |
|
2435 | |||
2436 | obj? or ?obj -> basic information. |
|
2436 | obj? or ?obj -> basic information. | |
2437 | obj?? or ??obj -> more details. |
|
2437 | obj?? or ??obj -> more details. | |
2438 | """ |
|
2438 | """ | |
2439 |
|
2439 | |||
2440 | line = line_info.line |
|
2440 | line = line_info.line | |
2441 | # We need to make sure that we don't process lines which would be |
|
2441 | # We need to make sure that we don't process lines which would be | |
2442 | # otherwise valid python, such as "x=1 # what?" |
|
2442 | # otherwise valid python, such as "x=1 # what?" | |
2443 | try: |
|
2443 | try: | |
2444 | codeop.compile_command(line) |
|
2444 | codeop.compile_command(line) | |
2445 | except SyntaxError: |
|
2445 | except SyntaxError: | |
2446 | # We should only handle as help stuff which is NOT valid syntax |
|
2446 | # We should only handle as help stuff which is NOT valid syntax | |
2447 | if line[0]==self.ESC_HELP: |
|
2447 | if line[0]==self.ESC_HELP: | |
2448 | line = line[1:] |
|
2448 | line = line[1:] | |
2449 | elif line[-1]==self.ESC_HELP: |
|
2449 | elif line[-1]==self.ESC_HELP: | |
2450 | line = line[:-1] |
|
2450 | line = line[:-1] | |
2451 | self.log(line,'#?'+line,line_info.continue_prompt) |
|
2451 | self.log(line,'#?'+line,line_info.continue_prompt) | |
2452 | if line: |
|
2452 | if line: | |
2453 | #print 'line:<%r>' % line # dbg |
|
2453 | #print 'line:<%r>' % line # dbg | |
2454 | self.magic_pinfo(line) |
|
2454 | self.magic_pinfo(line) | |
2455 | else: |
|
2455 | else: | |
2456 | page(self.usage,screen_lines=self.rc.screen_length) |
|
2456 | page(self.usage,screen_lines=self.rc.screen_length) | |
2457 | return '' # Empty string is needed here! |
|
2457 | return '' # Empty string is needed here! | |
2458 | except: |
|
2458 | except: | |
2459 | # Pass any other exceptions through to the normal handler |
|
2459 | # Pass any other exceptions through to the normal handler | |
2460 | return self.handle_normal(line_info) |
|
2460 | return self.handle_normal(line_info) | |
2461 | else: |
|
2461 | else: | |
2462 | # If the code compiles ok, we should handle it normally |
|
2462 | # If the code compiles ok, we should handle it normally | |
2463 | return self.handle_normal(line_info) |
|
2463 | return self.handle_normal(line_info) | |
2464 |
|
2464 | |||
2465 | def getapi(self): |
|
2465 | def getapi(self): | |
2466 | """ Get an IPApi object for this shell instance |
|
2466 | """ Get an IPApi object for this shell instance | |
2467 |
|
2467 | |||
2468 | Getting an IPApi object is always preferable to accessing the shell |
|
2468 | Getting an IPApi object is always preferable to accessing the shell | |
2469 | directly, but this holds true especially for extensions. |
|
2469 | directly, but this holds true especially for extensions. | |
2470 |
|
2470 | |||
2471 | It should always be possible to implement an extension with IPApi |
|
2471 | It should always be possible to implement an extension with IPApi | |
2472 | alone. If not, contact maintainer to request an addition. |
|
2472 | alone. If not, contact maintainer to request an addition. | |
2473 |
|
2473 | |||
2474 | """ |
|
2474 | """ | |
2475 | return self.api |
|
2475 | return self.api | |
2476 |
|
2476 | |||
2477 | def handle_emacs(self, line_info): |
|
2477 | def handle_emacs(self, line_info): | |
2478 | """Handle input lines marked by python-mode.""" |
|
2478 | """Handle input lines marked by python-mode.""" | |
2479 |
|
2479 | |||
2480 | # Currently, nothing is done. Later more functionality can be added |
|
2480 | # Currently, nothing is done. Later more functionality can be added | |
2481 | # here if needed. |
|
2481 | # here if needed. | |
2482 |
|
2482 | |||
2483 | # The input cache shouldn't be updated |
|
2483 | # The input cache shouldn't be updated | |
2484 | return line_info.line |
|
2484 | return line_info.line | |
2485 |
|
2485 | |||
2486 |
|
2486 | |||
2487 | def mktempfile(self,data=None): |
|
2487 | def mktempfile(self,data=None): | |
2488 | """Make a new tempfile and return its filename. |
|
2488 | """Make a new tempfile and return its filename. | |
2489 |
|
2489 | |||
2490 | This makes a call to tempfile.mktemp, but it registers the created |
|
2490 | This makes a call to tempfile.mktemp, but it registers the created | |
2491 | filename internally so ipython cleans it up at exit time. |
|
2491 | filename internally so ipython cleans it up at exit time. | |
2492 |
|
2492 | |||
2493 | Optional inputs: |
|
2493 | Optional inputs: | |
2494 |
|
2494 | |||
2495 | - data(None): if data is given, it gets written out to the temp file |
|
2495 | - data(None): if data is given, it gets written out to the temp file | |
2496 | immediately, and the file is closed again.""" |
|
2496 | immediately, and the file is closed again.""" | |
2497 |
|
2497 | |||
2498 | filename = tempfile.mktemp('.py','ipython_edit_') |
|
2498 | filename = tempfile.mktemp('.py','ipython_edit_') | |
2499 | self.tempfiles.append(filename) |
|
2499 | self.tempfiles.append(filename) | |
2500 |
|
2500 | |||
2501 | if data: |
|
2501 | if data: | |
2502 | tmp_file = open(filename,'w') |
|
2502 | tmp_file = open(filename,'w') | |
2503 | tmp_file.write(data) |
|
2503 | tmp_file.write(data) | |
2504 | tmp_file.close() |
|
2504 | tmp_file.close() | |
2505 | return filename |
|
2505 | return filename | |
2506 |
|
2506 | |||
2507 | def write(self,data): |
|
2507 | def write(self,data): | |
2508 | """Write a string to the default output""" |
|
2508 | """Write a string to the default output""" | |
2509 | Term.cout.write(data) |
|
2509 | Term.cout.write(data) | |
2510 |
|
2510 | |||
2511 | def write_err(self,data): |
|
2511 | def write_err(self,data): | |
2512 | """Write a string to the default error output""" |
|
2512 | """Write a string to the default error output""" | |
2513 | Term.cerr.write(data) |
|
2513 | Term.cerr.write(data) | |
2514 |
|
2514 | |||
2515 | def exit(self): |
|
2515 | def exit(self): | |
2516 | """Handle interactive exit. |
|
2516 | """Handle interactive exit. | |
2517 |
|
2517 | |||
2518 | This method sets the exit_now attribute.""" |
|
2518 | This method sets the exit_now attribute.""" | |
2519 |
|
2519 | |||
2520 | if self.rc.confirm_exit: |
|
2520 | if self.rc.confirm_exit: | |
2521 | if self.ask_yes_no('Do you really want to exit ([y]/n)?','y'): |
|
2521 | if self.ask_yes_no('Do you really want to exit ([y]/n)?','y'): | |
2522 | self.exit_now = True |
|
2522 | self.exit_now = True | |
2523 | else: |
|
2523 | else: | |
2524 | self.exit_now = True |
|
2524 | self.exit_now = True | |
2525 |
|
2525 | |||
2526 | def safe_execfile(self,fname,*where,**kw): |
|
2526 | def safe_execfile(self,fname,*where,**kw): | |
2527 | """A safe version of the builtin execfile(). |
|
2527 | """A safe version of the builtin execfile(). | |
2528 |
|
2528 | |||
2529 | This version will never throw an exception, and knows how to handle |
|
2529 | This version will never throw an exception, and knows how to handle | |
2530 | ipython logs as well. |
|
2530 | ipython logs as well. | |
2531 |
|
2531 | |||
2532 | :Parameters: |
|
2532 | :Parameters: | |
2533 | fname : string |
|
2533 | fname : string | |
2534 | Name of the file to be executed. |
|
2534 | Name of the file to be executed. | |
2535 |
|
2535 | |||
2536 | where : tuple |
|
2536 | where : tuple | |
2537 | One or two namespaces, passed to execfile() as (globals,locals). |
|
2537 | One or two namespaces, passed to execfile() as (globals,locals). | |
2538 | If only one is given, it is passed as both. |
|
2538 | If only one is given, it is passed as both. | |
2539 |
|
2539 | |||
2540 | :Keywords: |
|
2540 | :Keywords: | |
2541 | islog : boolean (False) |
|
2541 | islog : boolean (False) | |
2542 |
|
2542 | |||
2543 | quiet : boolean (True) |
|
2543 | quiet : boolean (True) | |
2544 |
|
2544 | |||
2545 | exit_ignore : boolean (False) |
|
2545 | exit_ignore : boolean (False) | |
2546 | """ |
|
2546 | """ | |
2547 |
|
2547 | |||
2548 | def syspath_cleanup(): |
|
2548 | def syspath_cleanup(): | |
2549 | """Internal cleanup routine for sys.path.""" |
|
2549 | """Internal cleanup routine for sys.path.""" | |
2550 | if add_dname: |
|
2550 | if add_dname: | |
2551 | try: |
|
2551 | try: | |
2552 | sys.path.remove(dname) |
|
2552 | sys.path.remove(dname) | |
2553 | except ValueError: |
|
2553 | except ValueError: | |
2554 | # For some reason the user has already removed it, ignore. |
|
2554 | # For some reason the user has already removed it, ignore. | |
2555 | pass |
|
2555 | pass | |
2556 |
|
2556 | |||
2557 | fname = os.path.expanduser(fname) |
|
2557 | fname = os.path.expanduser(fname) | |
2558 |
|
2558 | |||
2559 | # Find things also in current directory. This is needed to mimic the |
|
2559 | # Find things also in current directory. This is needed to mimic the | |
2560 | # behavior of running a script from the system command line, where |
|
2560 | # behavior of running a script from the system command line, where | |
2561 | # Python inserts the script's directory into sys.path |
|
2561 | # Python inserts the script's directory into sys.path | |
2562 | dname = os.path.dirname(os.path.abspath(fname)) |
|
2562 | dname = os.path.dirname(os.path.abspath(fname)) | |
2563 | add_dname = False |
|
2563 | add_dname = False | |
2564 | if dname not in sys.path: |
|
2564 | if dname not in sys.path: | |
2565 | sys.path.insert(0,dname) |
|
2565 | sys.path.insert(0,dname) | |
2566 | add_dname = True |
|
2566 | add_dname = True | |
2567 |
|
2567 | |||
2568 | try: |
|
2568 | try: | |
2569 | xfile = open(fname) |
|
2569 | xfile = open(fname) | |
2570 | except: |
|
2570 | except: | |
2571 | print >> Term.cerr, \ |
|
2571 | print >> Term.cerr, \ | |
2572 | 'Could not open file <%s> for safe execution.' % fname |
|
2572 | 'Could not open file <%s> for safe execution.' % fname | |
2573 | syspath_cleanup() |
|
2573 | syspath_cleanup() | |
2574 | return None |
|
2574 | return None | |
2575 |
|
2575 | |||
2576 | kw.setdefault('islog',0) |
|
2576 | kw.setdefault('islog',0) | |
2577 | kw.setdefault('quiet',1) |
|
2577 | kw.setdefault('quiet',1) | |
2578 | kw.setdefault('exit_ignore',0) |
|
2578 | kw.setdefault('exit_ignore',0) | |
2579 |
|
2579 | |||
2580 | first = xfile.readline() |
|
2580 | first = xfile.readline() | |
2581 | loghead = str(self.loghead_tpl).split('\n',1)[0].strip() |
|
2581 | loghead = str(self.loghead_tpl).split('\n',1)[0].strip() | |
2582 | xfile.close() |
|
2582 | xfile.close() | |
2583 | # line by line execution |
|
2583 | # line by line execution | |
2584 | if first.startswith(loghead) or kw['islog']: |
|
2584 | if first.startswith(loghead) or kw['islog']: | |
2585 | print 'Loading log file <%s> one line at a time...' % fname |
|
2585 | print 'Loading log file <%s> one line at a time...' % fname | |
2586 | if kw['quiet']: |
|
2586 | if kw['quiet']: | |
2587 | stdout_save = sys.stdout |
|
2587 | stdout_save = sys.stdout | |
2588 | sys.stdout = StringIO.StringIO() |
|
2588 | sys.stdout = StringIO.StringIO() | |
2589 | try: |
|
2589 | try: | |
2590 | globs,locs = where[0:2] |
|
2590 | globs,locs = where[0:2] | |
2591 | except: |
|
2591 | except: | |
2592 | try: |
|
2592 | try: | |
2593 | globs = locs = where[0] |
|
2593 | globs = locs = where[0] | |
2594 | except: |
|
2594 | except: | |
2595 | globs = locs = globals() |
|
2595 | globs = locs = globals() | |
2596 | badblocks = [] |
|
2596 | badblocks = [] | |
2597 |
|
2597 | |||
2598 | # we also need to identify indented blocks of code when replaying |
|
2598 | # we also need to identify indented blocks of code when replaying | |
2599 | # logs and put them together before passing them to an exec |
|
2599 | # logs and put them together before passing them to an exec | |
2600 | # statement. This takes a bit of regexp and look-ahead work in the |
|
2600 | # statement. This takes a bit of regexp and look-ahead work in the | |
2601 | # file. It's easiest if we swallow the whole thing in memory |
|
2601 | # file. It's easiest if we swallow the whole thing in memory | |
2602 | # first, and manually walk through the lines list moving the |
|
2602 | # first, and manually walk through the lines list moving the | |
2603 | # counter ourselves. |
|
2603 | # counter ourselves. | |
2604 | indent_re = re.compile('\s+\S') |
|
2604 | indent_re = re.compile('\s+\S') | |
2605 | xfile = open(fname) |
|
2605 | xfile = open(fname) | |
2606 | filelines = xfile.readlines() |
|
2606 | filelines = xfile.readlines() | |
2607 | xfile.close() |
|
2607 | xfile.close() | |
2608 | nlines = len(filelines) |
|
2608 | nlines = len(filelines) | |
2609 | lnum = 0 |
|
2609 | lnum = 0 | |
2610 | while lnum < nlines: |
|
2610 | while lnum < nlines: | |
2611 | line = filelines[lnum] |
|
2611 | line = filelines[lnum] | |
2612 | lnum += 1 |
|
2612 | lnum += 1 | |
2613 | # don't re-insert logger status info into cache |
|
2613 | # don't re-insert logger status info into cache | |
2614 | if line.startswith('#log#'): |
|
2614 | if line.startswith('#log#'): | |
2615 | continue |
|
2615 | continue | |
2616 | else: |
|
2616 | else: | |
2617 | # build a block of code (maybe a single line) for execution |
|
2617 | # build a block of code (maybe a single line) for execution | |
2618 | block = line |
|
2618 | block = line | |
2619 | try: |
|
2619 | try: | |
2620 | next = filelines[lnum] # lnum has already incremented |
|
2620 | next = filelines[lnum] # lnum has already incremented | |
2621 | except: |
|
2621 | except: | |
2622 | next = None |
|
2622 | next = None | |
2623 | while next and indent_re.match(next): |
|
2623 | while next and indent_re.match(next): | |
2624 | block += next |
|
2624 | block += next | |
2625 | lnum += 1 |
|
2625 | lnum += 1 | |
2626 | try: |
|
2626 | try: | |
2627 | next = filelines[lnum] |
|
2627 | next = filelines[lnum] | |
2628 | except: |
|
2628 | except: | |
2629 | next = None |
|
2629 | next = None | |
2630 | # now execute the block of one or more lines |
|
2630 | # now execute the block of one or more lines | |
2631 | try: |
|
2631 | try: | |
2632 | exec block in globs,locs |
|
2632 | exec block in globs,locs | |
2633 | except SystemExit: |
|
2633 | except SystemExit: | |
2634 | pass |
|
2634 | pass | |
2635 | except: |
|
2635 | except: | |
2636 | badblocks.append(block.rstrip()) |
|
2636 | badblocks.append(block.rstrip()) | |
2637 | if kw['quiet']: # restore stdout |
|
2637 | if kw['quiet']: # restore stdout | |
2638 | sys.stdout.close() |
|
2638 | sys.stdout.close() | |
2639 | sys.stdout = stdout_save |
|
2639 | sys.stdout = stdout_save | |
2640 | print 'Finished replaying log file <%s>' % fname |
|
2640 | print 'Finished replaying log file <%s>' % fname | |
2641 | if badblocks: |
|
2641 | if badblocks: | |
2642 | print >> sys.stderr, ('\nThe following lines/blocks in file ' |
|
2642 | print >> sys.stderr, ('\nThe following lines/blocks in file ' | |
2643 | '<%s> reported errors:' % fname) |
|
2643 | '<%s> reported errors:' % fname) | |
2644 |
|
2644 | |||
2645 | for badline in badblocks: |
|
2645 | for badline in badblocks: | |
2646 | print >> sys.stderr, badline |
|
2646 | print >> sys.stderr, badline | |
2647 | else: # regular file execution |
|
2647 | else: # regular file execution | |
2648 | try: |
|
2648 | try: | |
2649 | if sys.platform == 'win32' and sys.version_info < (2,5,1): |
|
2649 | if sys.platform == 'win32' and sys.version_info < (2,5,1): | |
2650 | # Work around a bug in Python for Windows. The bug was |
|
2650 | # Work around a bug in Python for Windows. The bug was | |
2651 | # fixed in in Python 2.5 r54159 and 54158, but that's still |
|
2651 | # fixed in in Python 2.5 r54159 and 54158, but that's still | |
2652 | # SVN Python as of March/07. For details, see: |
|
2652 | # SVN Python as of March/07. For details, see: | |
2653 | # http://projects.scipy.org/ipython/ipython/ticket/123 |
|
2653 | # http://projects.scipy.org/ipython/ipython/ticket/123 | |
2654 | try: |
|
2654 | try: | |
2655 | globs,locs = where[0:2] |
|
2655 | globs,locs = where[0:2] | |
2656 | except: |
|
2656 | except: | |
2657 | try: |
|
2657 | try: | |
2658 | globs = locs = where[0] |
|
2658 | globs = locs = where[0] | |
2659 | except: |
|
2659 | except: | |
2660 | globs = locs = globals() |
|
2660 | globs = locs = globals() | |
2661 | exec file(fname) in globs,locs |
|
2661 | exec file(fname) in globs,locs | |
2662 | else: |
|
2662 | else: | |
2663 | execfile(fname,*where) |
|
2663 | execfile(fname,*where) | |
2664 | except SyntaxError: |
|
2664 | except SyntaxError: | |
2665 | self.showsyntaxerror() |
|
2665 | self.showsyntaxerror() | |
2666 | warn('Failure executing file: <%s>' % fname) |
|
2666 | warn('Failure executing file: <%s>' % fname) | |
2667 | except SystemExit,status: |
|
2667 | except SystemExit,status: | |
2668 | # Code that correctly sets the exit status flag to success (0) |
|
2668 | # Code that correctly sets the exit status flag to success (0) | |
2669 | # shouldn't be bothered with a traceback. Note that a plain |
|
2669 | # shouldn't be bothered with a traceback. Note that a plain | |
2670 | # sys.exit() does NOT set the message to 0 (it's empty) so that |
|
2670 | # sys.exit() does NOT set the message to 0 (it's empty) so that | |
2671 | # will still get a traceback. Note that the structure of the |
|
2671 | # will still get a traceback. Note that the structure of the | |
2672 | # SystemExit exception changed between Python 2.4 and 2.5, so |
|
2672 | # SystemExit exception changed between Python 2.4 and 2.5, so | |
2673 | # the checks must be done in a version-dependent way. |
|
2673 | # the checks must be done in a version-dependent way. | |
2674 | show = False |
|
2674 | show = False | |
2675 |
|
2675 | |||
2676 | if sys.version_info[:2] > (2,5): |
|
2676 | if sys.version_info[:2] > (2,5): | |
2677 | if status.message!=0 and not kw['exit_ignore']: |
|
2677 | if status.message!=0 and not kw['exit_ignore']: | |
2678 | show = True |
|
2678 | show = True | |
2679 | else: |
|
2679 | else: | |
2680 | if status.code and not kw['exit_ignore']: |
|
2680 | if status.code and not kw['exit_ignore']: | |
2681 | show = True |
|
2681 | show = True | |
2682 | if show: |
|
2682 | if show: | |
2683 | self.showtraceback() |
|
2683 | self.showtraceback() | |
2684 | warn('Failure executing file: <%s>' % fname) |
|
2684 | warn('Failure executing file: <%s>' % fname) | |
2685 | except: |
|
2685 | except: | |
2686 | self.showtraceback() |
|
2686 | self.showtraceback() | |
2687 | warn('Failure executing file: <%s>' % fname) |
|
2687 | warn('Failure executing file: <%s>' % fname) | |
2688 |
|
2688 | |||
2689 | syspath_cleanup() |
|
2689 | syspath_cleanup() | |
2690 |
|
2690 | |||
2691 | #************************* end of file <iplib.py> ***************************** |
|
2691 | #************************* end of file <iplib.py> ***************************** |
@@ -1,406 +1,406 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """Mimic C structs with lots of extra functionality. |
|
2 | """Mimic C structs with lots of extra functionality. | |
3 |
|
3 | |||
4 | $Id: ipstruct.py 1950 2006-11-28 19:15:35Z vivainio $""" |
|
4 | $Id: ipstruct.py 1950 2006-11-28 19:15:35Z vivainio $""" | |
5 |
|
5 | |||
6 | #***************************************************************************** |
|
6 | #***************************************************************************** | |
7 | # Copyright (C) 2001-2004 Fernando Perez <fperez@colorado.edu> |
|
7 | # Copyright (C) 2001-2004 Fernando Perez <fperez@colorado.edu> | |
8 | # |
|
8 | # | |
9 | # Distributed under the terms of the BSD License. The full license is in |
|
9 | # Distributed under the terms of the BSD License. The full license is in | |
10 | # the file COPYING, distributed as part of this software. |
|
10 | # the file COPYING, distributed as part of this software. | |
11 | #***************************************************************************** |
|
11 | #***************************************************************************** | |
12 |
|
12 | |||
13 | from IPython import Release |
|
13 | from IPython import Release | |
14 | __author__ = '%s <%s>' % Release.authors['Fernando'] |
|
14 | __author__ = '%s <%s>' % Release.authors['Fernando'] | |
15 | __license__ = Release.license |
|
15 | __license__ = Release.license | |
16 |
|
16 | |||
17 | __all__ = ['Struct'] |
|
17 | __all__ = ['Struct'] | |
18 |
|
18 | |||
19 | import types |
|
19 | import types | |
20 | import pprint |
|
20 | import pprint | |
21 |
|
21 | |||
22 | from IPython.genutils import list2dict2 |
|
22 | from IPython.genutils import list2dict2 | |
23 |
|
23 | |||
24 | class Struct: |
|
24 | class Struct: | |
25 | """Class to mimic C structs but also provide convenient dictionary-like |
|
25 | """Class to mimic C structs but also provide convenient dictionary-like | |
26 | functionality. |
|
26 | functionality. | |
27 |
|
27 | |||
28 | Instances can be initialized with a dictionary, a list of key=value pairs |
|
28 | Instances can be initialized with a dictionary, a list of key=value pairs | |
29 | or both. If both are present, the dictionary must come first. |
|
29 | or both. If both are present, the dictionary must come first. | |
30 |
|
30 | |||
31 | Because Python classes provide direct assignment to their members, it's |
|
31 | Because Python classes provide direct assignment to their members, it's | |
32 | easy to overwrite normal methods (S.copy = 1 would destroy access to |
|
32 | easy to overwrite normal methods (S.copy = 1 would destroy access to | |
33 | S.copy()). For this reason, all builtin method names are protected and |
|
33 | S.copy()). For this reason, all builtin method names are protected and | |
34 | can't be assigned to. An attempt to do s.copy=1 or s['copy']=1 will raise |
|
34 | can't be assigned to. An attempt to do s.copy=1 or s['copy']=1 will raise | |
35 | a KeyError exception. If you really want to, you can bypass this |
|
35 | a KeyError exception. If you really want to, you can bypass this | |
36 | protection by directly assigning to __dict__: s.__dict__['copy']=1 will |
|
36 | protection by directly assigning to __dict__: s.__dict__['copy']=1 will | |
37 | still work. Doing this will break functionality, though. As in most of |
|
37 | still work. Doing this will break functionality, though. As in most of | |
38 | Python, namespace protection is weakly enforced, so feel free to shoot |
|
38 | Python, namespace protection is weakly enforced, so feel free to shoot | |
39 | yourself if you really want to. |
|
39 | yourself if you really want to. | |
40 |
|
40 | |||
41 | Note that this class uses more memory and is *much* slower than a regular |
|
41 | Note that this class uses more memory and is *much* slower than a regular | |
42 | dictionary, so be careful in situations where memory or performance are |
|
42 | dictionary, so be careful in situations where memory or performance are | |
43 | critical. But for day to day use it should behave fine. It is particularly |
|
43 | critical. But for day to day use it should behave fine. It is particularly | |
44 | convenient for storing configuration data in programs. |
|
44 | convenient for storing configuration data in programs. | |
45 |
|
45 | |||
46 | +,+=,- and -= are implemented. +/+= do merges (non-destructive updates), |
|
46 | +,+=,- and -= are implemented. +/+= do merges (non-destructive updates), | |
47 | -/-= remove keys from the original. See the method descripitions. |
|
47 | -/-= remove keys from the original. See the method descripitions. | |
48 |
|
48 | |||
49 | This class allows a quick access syntax: both s.key and s['key'] are |
|
49 | This class allows a quick access syntax: both s.key and s['key'] are | |
50 | valid. This syntax has a limitation: each 'key' has to be explicitly |
|
50 | valid. This syntax has a limitation: each 'key' has to be explicitly | |
51 | accessed by its original name. The normal s.key syntax doesn't provide |
|
51 | accessed by its original name. The normal s.key syntax doesn't provide | |
52 | access to the keys via variables whose values evaluate to the desired |
|
52 | access to the keys via variables whose values evaluate to the desired | |
53 | keys. An example should clarify this: |
|
53 | keys. An example should clarify this: | |
54 |
|
54 | |||
55 | Define a dictionary and initialize both with dict and k=v pairs: |
|
55 | Define a dictionary and initialize both with dict and k=v pairs: | |
56 | >>> d={'a':1,'b':2} |
|
56 | >>> d={'a':1,'b':2} | |
57 | >>> s=Struct(d,hi=10,ho=20) |
|
57 | >>> s=Struct(d,hi=10,ho=20) | |
58 |
|
58 | |||
59 | The return of __repr__ can be used to create a new instance: |
|
59 | The return of __repr__ can be used to create a new instance: | |
60 | >>> s |
|
60 | >>> s | |
61 | Struct({'__allownew': True, 'a': 1, 'b': 2, 'hi': 10, 'ho': 20}) |
|
61 | Struct({'__allownew': True, 'a': 1, 'b': 2, 'hi': 10, 'ho': 20}) | |
62 |
|
62 | |||
63 | Note: the special '__allownew' key is used for internal purposes. |
|
63 | Note: the special '__allownew' key is used for internal purposes. | |
64 |
|
64 | |||
65 | __str__ (called by print) shows it's not quite a regular dictionary: |
|
65 | __str__ (called by print) shows it's not quite a regular dictionary: | |
66 | >>> print s |
|
66 | >>> print s | |
67 | Struct({'__allownew': True, 'a': 1, 'b': 2, 'hi': 10, 'ho': 20}) |
|
67 | Struct({'__allownew': True, 'a': 1, 'b': 2, 'hi': 10, 'ho': 20}) | |
68 |
|
68 | |||
69 | Access by explicitly named key with dot notation: |
|
69 | Access by explicitly named key with dot notation: | |
70 | >>> s.a |
|
70 | >>> s.a | |
71 | 1 |
|
71 | 1 | |
72 |
|
72 | |||
73 | Or like a dictionary: |
|
73 | Or like a dictionary: | |
74 | >>> s['a'] |
|
74 | >>> s['a'] | |
75 | 1 |
|
75 | 1 | |
76 |
|
76 | |||
77 | If you want a variable to hold the key value, only dictionary access works: |
|
77 | If you want a variable to hold the key value, only dictionary access works: | |
78 | >>> key='hi' |
|
78 | >>> key='hi' | |
79 | >>> s.key |
|
79 | >>> s.key | |
80 | Traceback (most recent call last): |
|
80 | Traceback (most recent call last): | |
81 | File "<stdin>", line 1, in ? |
|
81 | File "<stdin>", line 1, in ? | |
82 | AttributeError: Struct instance has no attribute 'key' |
|
82 | AttributeError: Struct instance has no attribute 'key' | |
83 |
|
83 | |||
84 | >>> s[key] |
|
84 | >>> s[key] | |
85 | 10 |
|
85 | 10 | |
86 |
|
86 | |||
87 | Another limitation of the s.key syntax (and Struct(key=val) |
|
87 | Another limitation of the s.key syntax (and Struct(key=val) | |
88 | initialization): keys can't be numbers. But numeric keys can be used and |
|
88 | initialization): keys can't be numbers. But numeric keys can be used and | |
89 | accessed using the dictionary syntax. Again, an example: |
|
89 | accessed using the dictionary syntax. Again, an example: | |
90 |
|
90 | |||
91 | This doesn't work: |
|
91 | This doesn't work (prompt changed to avoid confusing the test system): | |
92 | py> s=Struct(4='hi') #doctest: +IGNORE_EXCEPTION_DETAIL |
|
92 | ->> s=Struct(4='hi') | |
93 | Traceback (most recent call last): |
|
93 | Traceback (most recent call last): | |
94 | ... |
|
94 | ... | |
95 | SyntaxError: keyword can't be an expression |
|
95 | SyntaxError: keyword can't be an expression | |
96 |
|
96 | |||
97 | But this does: |
|
97 | But this does: | |
98 | >>> s=Struct() |
|
98 | >>> s=Struct() | |
99 | >>> s[4]='hi' |
|
99 | >>> s[4]='hi' | |
100 | >>> s |
|
100 | >>> s | |
101 | Struct({4: 'hi', '__allownew': True}) |
|
101 | Struct({4: 'hi', '__allownew': True}) | |
102 | >>> s[4] |
|
102 | >>> s[4] | |
103 | 'hi' |
|
103 | 'hi' | |
104 | """ |
|
104 | """ | |
105 |
|
105 | |||
106 | # Attributes to which __setitem__ and __setattr__ will block access. |
|
106 | # Attributes to which __setitem__ and __setattr__ will block access. | |
107 | # Note: much of this will be moot in Python 2.2 and will be done in a much |
|
107 | # Note: much of this will be moot in Python 2.2 and will be done in a much | |
108 | # cleaner way. |
|
108 | # cleaner way. | |
109 | __protected = ('copy dict dictcopy get has_attr has_key items keys ' |
|
109 | __protected = ('copy dict dictcopy get has_attr has_key items keys ' | |
110 | 'merge popitem setdefault update values ' |
|
110 | 'merge popitem setdefault update values ' | |
111 | '__make_dict __dict_invert ').split() |
|
111 | '__make_dict __dict_invert ').split() | |
112 |
|
112 | |||
113 | def __init__(self,dict=None,**kw): |
|
113 | def __init__(self,dict=None,**kw): | |
114 | """Initialize with a dictionary, another Struct, or by giving |
|
114 | """Initialize with a dictionary, another Struct, or by giving | |
115 | explicitly the list of attributes. |
|
115 | explicitly the list of attributes. | |
116 |
|
116 | |||
117 | Both can be used, but the dictionary must come first: |
|
117 | Both can be used, but the dictionary must come first: | |
118 | Struct(dict), Struct(k1=v1,k2=v2) or Struct(dict,k1=v1,k2=v2). |
|
118 | Struct(dict), Struct(k1=v1,k2=v2) or Struct(dict,k1=v1,k2=v2). | |
119 | """ |
|
119 | """ | |
120 | self.__dict__['__allownew'] = True |
|
120 | self.__dict__['__allownew'] = True | |
121 | if dict is None: |
|
121 | if dict is None: | |
122 | dict = {} |
|
122 | dict = {} | |
123 | if isinstance(dict,Struct): |
|
123 | if isinstance(dict,Struct): | |
124 | dict = dict.dict() |
|
124 | dict = dict.dict() | |
125 | elif dict and type(dict) is not types.DictType: |
|
125 | elif dict and type(dict) is not types.DictType: | |
126 | raise TypeError,\ |
|
126 | raise TypeError,\ | |
127 | 'Initialize with a dictionary or key=val pairs.' |
|
127 | 'Initialize with a dictionary or key=val pairs.' | |
128 | dict.update(kw) |
|
128 | dict.update(kw) | |
129 | # do the updating by hand to guarantee that we go through the |
|
129 | # do the updating by hand to guarantee that we go through the | |
130 | # safety-checked __setitem__ |
|
130 | # safety-checked __setitem__ | |
131 | for k,v in dict.items(): |
|
131 | for k,v in dict.items(): | |
132 | self[k] = v |
|
132 | self[k] = v | |
133 |
|
133 | |||
134 |
|
134 | |||
135 | def __setitem__(self,key,value): |
|
135 | def __setitem__(self,key,value): | |
136 | """Used when struct[key] = val calls are made.""" |
|
136 | """Used when struct[key] = val calls are made.""" | |
137 | if key in Struct.__protected: |
|
137 | if key in Struct.__protected: | |
138 | raise KeyError,'Key '+`key`+' is a protected key of class Struct.' |
|
138 | raise KeyError,'Key '+`key`+' is a protected key of class Struct.' | |
139 | if not self['__allownew'] and key not in self.__dict__: |
|
139 | if not self['__allownew'] and key not in self.__dict__: | |
140 | raise KeyError( |
|
140 | raise KeyError( | |
141 | "Can't create unknown attribute %s - Check for typos, or use allow_new_attr to create new attributes!" % |
|
141 | "Can't create unknown attribute %s - Check for typos, or use allow_new_attr to create new attributes!" % | |
142 | key) |
|
142 | key) | |
143 |
|
143 | |||
144 | self.__dict__[key] = value |
|
144 | self.__dict__[key] = value | |
145 |
|
145 | |||
146 | def __setattr__(self, key, value): |
|
146 | def __setattr__(self, key, value): | |
147 | """Used when struct.key = val calls are made.""" |
|
147 | """Used when struct.key = val calls are made.""" | |
148 | self.__setitem__(key,value) |
|
148 | self.__setitem__(key,value) | |
149 |
|
149 | |||
150 | def __str__(self): |
|
150 | def __str__(self): | |
151 | """Gets called by print.""" |
|
151 | """Gets called by print.""" | |
152 |
|
152 | |||
153 | return 'Struct('+ pprint.pformat(self.__dict__)+')' |
|
153 | return 'Struct('+ pprint.pformat(self.__dict__)+')' | |
154 |
|
154 | |||
155 | def __repr__(self): |
|
155 | def __repr__(self): | |
156 | """Gets called by repr. |
|
156 | """Gets called by repr. | |
157 |
|
157 | |||
158 | A Struct can be recreated with S_new=eval(repr(S_old)).""" |
|
158 | A Struct can be recreated with S_new=eval(repr(S_old)).""" | |
159 | return self.__str__() |
|
159 | return self.__str__() | |
160 |
|
160 | |||
161 | def __getitem__(self,key): |
|
161 | def __getitem__(self,key): | |
162 | """Allows struct[key] access.""" |
|
162 | """Allows struct[key] access.""" | |
163 | return self.__dict__[key] |
|
163 | return self.__dict__[key] | |
164 |
|
164 | |||
165 | def __contains__(self,key): |
|
165 | def __contains__(self,key): | |
166 | """Allows use of the 'in' operator.""" |
|
166 | """Allows use of the 'in' operator.""" | |
167 | return self.__dict__.has_key(key) |
|
167 | return self.__dict__.has_key(key) | |
168 |
|
168 | |||
169 | def __iadd__(self,other): |
|
169 | def __iadd__(self,other): | |
170 | """S += S2 is a shorthand for S.merge(S2).""" |
|
170 | """S += S2 is a shorthand for S.merge(S2).""" | |
171 | self.merge(other) |
|
171 | self.merge(other) | |
172 | return self |
|
172 | return self | |
173 |
|
173 | |||
174 | def __add__(self,other): |
|
174 | def __add__(self,other): | |
175 | """S + S2 -> New Struct made form S and S.merge(S2)""" |
|
175 | """S + S2 -> New Struct made form S and S.merge(S2)""" | |
176 | Sout = self.copy() |
|
176 | Sout = self.copy() | |
177 | Sout.merge(other) |
|
177 | Sout.merge(other) | |
178 | return Sout |
|
178 | return Sout | |
179 |
|
179 | |||
180 | def __sub__(self,other): |
|
180 | def __sub__(self,other): | |
181 | """Return S1-S2, where all keys in S2 have been deleted (if present) |
|
181 | """Return S1-S2, where all keys in S2 have been deleted (if present) | |
182 | from S1.""" |
|
182 | from S1.""" | |
183 | Sout = self.copy() |
|
183 | Sout = self.copy() | |
184 | Sout -= other |
|
184 | Sout -= other | |
185 | return Sout |
|
185 | return Sout | |
186 |
|
186 | |||
187 | def __isub__(self,other): |
|
187 | def __isub__(self,other): | |
188 | """Do in place S = S - S2, meaning all keys in S2 have been deleted |
|
188 | """Do in place S = S - S2, meaning all keys in S2 have been deleted | |
189 | (if present) from S1.""" |
|
189 | (if present) from S1.""" | |
190 |
|
190 | |||
191 | for k in other.keys(): |
|
191 | for k in other.keys(): | |
192 | if self.has_key(k): |
|
192 | if self.has_key(k): | |
193 | del self.__dict__[k] |
|
193 | del self.__dict__[k] | |
194 |
|
194 | |||
195 | def __make_dict(self,__loc_data__,**kw): |
|
195 | def __make_dict(self,__loc_data__,**kw): | |
196 | "Helper function for update and merge. Return a dict from data." |
|
196 | "Helper function for update and merge. Return a dict from data." | |
197 |
|
197 | |||
198 | if __loc_data__ == None: |
|
198 | if __loc_data__ == None: | |
199 | dict = {} |
|
199 | dict = {} | |
200 | elif type(__loc_data__) is types.DictType: |
|
200 | elif type(__loc_data__) is types.DictType: | |
201 | dict = __loc_data__ |
|
201 | dict = __loc_data__ | |
202 | elif isinstance(__loc_data__,Struct): |
|
202 | elif isinstance(__loc_data__,Struct): | |
203 | dict = __loc_data__.__dict__ |
|
203 | dict = __loc_data__.__dict__ | |
204 | else: |
|
204 | else: | |
205 | raise TypeError, 'Update with a dict, a Struct or key=val pairs.' |
|
205 | raise TypeError, 'Update with a dict, a Struct or key=val pairs.' | |
206 | if kw: |
|
206 | if kw: | |
207 | dict.update(kw) |
|
207 | dict.update(kw) | |
208 | return dict |
|
208 | return dict | |
209 |
|
209 | |||
210 | def __dict_invert(self,dict): |
|
210 | def __dict_invert(self,dict): | |
211 | """Helper function for merge. Takes a dictionary whose values are |
|
211 | """Helper function for merge. Takes a dictionary whose values are | |
212 | lists and returns a dict. with the elements of each list as keys and |
|
212 | lists and returns a dict. with the elements of each list as keys and | |
213 | the original keys as values.""" |
|
213 | the original keys as values.""" | |
214 |
|
214 | |||
215 | outdict = {} |
|
215 | outdict = {} | |
216 | for k,lst in dict.items(): |
|
216 | for k,lst in dict.items(): | |
217 | if type(lst) is types.StringType: |
|
217 | if type(lst) is types.StringType: | |
218 | lst = lst.split() |
|
218 | lst = lst.split() | |
219 | for entry in lst: |
|
219 | for entry in lst: | |
220 | outdict[entry] = k |
|
220 | outdict[entry] = k | |
221 | return outdict |
|
221 | return outdict | |
222 |
|
222 | |||
223 | def clear(self): |
|
223 | def clear(self): | |
224 | """Clear all attributes.""" |
|
224 | """Clear all attributes.""" | |
225 | self.__dict__.clear() |
|
225 | self.__dict__.clear() | |
226 |
|
226 | |||
227 | def copy(self): |
|
227 | def copy(self): | |
228 | """Return a (shallow) copy of a Struct.""" |
|
228 | """Return a (shallow) copy of a Struct.""" | |
229 | return Struct(self.__dict__.copy()) |
|
229 | return Struct(self.__dict__.copy()) | |
230 |
|
230 | |||
231 | def dict(self): |
|
231 | def dict(self): | |
232 | """Return the Struct's dictionary.""" |
|
232 | """Return the Struct's dictionary.""" | |
233 | return self.__dict__ |
|
233 | return self.__dict__ | |
234 |
|
234 | |||
235 | def dictcopy(self): |
|
235 | def dictcopy(self): | |
236 | """Return a (shallow) copy of the Struct's dictionary.""" |
|
236 | """Return a (shallow) copy of the Struct's dictionary.""" | |
237 | return self.__dict__.copy() |
|
237 | return self.__dict__.copy() | |
238 |
|
238 | |||
239 | def popitem(self): |
|
239 | def popitem(self): | |
240 | """S.popitem() -> (k, v), remove and return some (key, value) pair as |
|
240 | """S.popitem() -> (k, v), remove and return some (key, value) pair as | |
241 | a 2-tuple; but raise KeyError if S is empty.""" |
|
241 | a 2-tuple; but raise KeyError if S is empty.""" | |
242 | return self.__dict__.popitem() |
|
242 | return self.__dict__.popitem() | |
243 |
|
243 | |||
244 | def update(self,__loc_data__=None,**kw): |
|
244 | def update(self,__loc_data__=None,**kw): | |
245 | """Update (merge) with data from another Struct or from a dictionary. |
|
245 | """Update (merge) with data from another Struct or from a dictionary. | |
246 | Optionally, one or more key=value pairs can be given at the end for |
|
246 | Optionally, one or more key=value pairs can be given at the end for | |
247 | direct update.""" |
|
247 | direct update.""" | |
248 |
|
248 | |||
249 | # The funny name __loc_data__ is to prevent a common variable name which |
|
249 | # The funny name __loc_data__ is to prevent a common variable name which | |
250 | # could be a fieled of a Struct to collide with this parameter. The problem |
|
250 | # could be a fieled of a Struct to collide with this parameter. The problem | |
251 | # would arise if the function is called with a keyword with this same name |
|
251 | # would arise if the function is called with a keyword with this same name | |
252 | # that a user means to add as a Struct field. |
|
252 | # that a user means to add as a Struct field. | |
253 | newdict = Struct.__make_dict(self,__loc_data__,**kw) |
|
253 | newdict = Struct.__make_dict(self,__loc_data__,**kw) | |
254 | for k,v in newdict.items(): |
|
254 | for k,v in newdict.items(): | |
255 | self[k] = v |
|
255 | self[k] = v | |
256 |
|
256 | |||
257 | def merge(self,__loc_data__=None,__conflict_solve=None,**kw): |
|
257 | def merge(self,__loc_data__=None,__conflict_solve=None,**kw): | |
258 | """S.merge(data,conflict,k=v1,k=v2,...) -> merge data and k=v into S. |
|
258 | """S.merge(data,conflict,k=v1,k=v2,...) -> merge data and k=v into S. | |
259 |
|
259 | |||
260 | This is similar to update(), but much more flexible. First, a dict is |
|
260 | This is similar to update(), but much more flexible. First, a dict is | |
261 | made from data+key=value pairs. When merging this dict with the Struct |
|
261 | made from data+key=value pairs. When merging this dict with the Struct | |
262 | S, the optional dictionary 'conflict' is used to decide what to do. |
|
262 | S, the optional dictionary 'conflict' is used to decide what to do. | |
263 |
|
263 | |||
264 | If conflict is not given, the default behavior is to preserve any keys |
|
264 | If conflict is not given, the default behavior is to preserve any keys | |
265 | with their current value (the opposite of the update method's |
|
265 | with their current value (the opposite of the update method's | |
266 | behavior). |
|
266 | behavior). | |
267 |
|
267 | |||
268 | conflict is a dictionary of binary functions which will be used to |
|
268 | conflict is a dictionary of binary functions which will be used to | |
269 | solve key conflicts. It must have the following structure: |
|
269 | solve key conflicts. It must have the following structure: | |
270 |
|
270 | |||
271 | conflict == { fn1 : [Skey1,Skey2,...], fn2 : [Skey3], etc } |
|
271 | conflict == { fn1 : [Skey1,Skey2,...], fn2 : [Skey3], etc } | |
272 |
|
272 | |||
273 | Values must be lists or whitespace separated strings which are |
|
273 | Values must be lists or whitespace separated strings which are | |
274 | automatically converted to lists of strings by calling string.split(). |
|
274 | automatically converted to lists of strings by calling string.split(). | |
275 |
|
275 | |||
276 | Each key of conflict is a function which defines a policy for |
|
276 | Each key of conflict is a function which defines a policy for | |
277 | resolving conflicts when merging with the input data. Each fn must be |
|
277 | resolving conflicts when merging with the input data. Each fn must be | |
278 | a binary function which returns the desired outcome for a key |
|
278 | a binary function which returns the desired outcome for a key | |
279 | conflict. These functions will be called as fn(old,new). |
|
279 | conflict. These functions will be called as fn(old,new). | |
280 |
|
280 | |||
281 | An example is probably in order. Suppose you are merging the struct S |
|
281 | An example is probably in order. Suppose you are merging the struct S | |
282 | with a dict D and the following conflict policy dict: |
|
282 | with a dict D and the following conflict policy dict: | |
283 |
|
283 | |||
284 | S.merge(D,{fn1:['a','b',4], fn2:'key_c key_d'}) |
|
284 | S.merge(D,{fn1:['a','b',4], fn2:'key_c key_d'}) | |
285 |
|
285 | |||
286 | If the key 'a' is found in both S and D, the merge method will call: |
|
286 | If the key 'a' is found in both S and D, the merge method will call: | |
287 |
|
287 | |||
288 | S['a'] = fn1(S['a'],D['a']) |
|
288 | S['a'] = fn1(S['a'],D['a']) | |
289 |
|
289 | |||
290 | As a convenience, merge() provides five (the most commonly needed) |
|
290 | As a convenience, merge() provides five (the most commonly needed) | |
291 | pre-defined policies: preserve, update, add, add_flip and add_s. The |
|
291 | pre-defined policies: preserve, update, add, add_flip and add_s. The | |
292 | easiest explanation is their implementation: |
|
292 | easiest explanation is their implementation: | |
293 |
|
293 | |||
294 | preserve = lambda old,new: old |
|
294 | preserve = lambda old,new: old | |
295 | update = lambda old,new: new |
|
295 | update = lambda old,new: new | |
296 | add = lambda old,new: old + new |
|
296 | add = lambda old,new: old + new | |
297 | add_flip = lambda old,new: new + old # note change of order! |
|
297 | add_flip = lambda old,new: new + old # note change of order! | |
298 | add_s = lambda old,new: old + ' ' + new # only works for strings! |
|
298 | add_s = lambda old,new: old + ' ' + new # only works for strings! | |
299 |
|
299 | |||
300 | You can use those four words (as strings) as keys in conflict instead |
|
300 | You can use those four words (as strings) as keys in conflict instead | |
301 | of defining them as functions, and the merge method will substitute |
|
301 | of defining them as functions, and the merge method will substitute | |
302 | the appropriate functions for you. That is, the call |
|
302 | the appropriate functions for you. That is, the call | |
303 |
|
303 | |||
304 | S.merge(D,{'preserve':'a b c','add':[4,5,'d'],my_function:[6]}) |
|
304 | S.merge(D,{'preserve':'a b c','add':[4,5,'d'],my_function:[6]}) | |
305 |
|
305 | |||
306 | will automatically substitute the functions preserve and add for the |
|
306 | will automatically substitute the functions preserve and add for the | |
307 | names 'preserve' and 'add' before making any function calls. |
|
307 | names 'preserve' and 'add' before making any function calls. | |
308 |
|
308 | |||
309 | For more complicated conflict resolution policies, you still need to |
|
309 | For more complicated conflict resolution policies, you still need to | |
310 | construct your own functions. """ |
|
310 | construct your own functions. """ | |
311 |
|
311 | |||
312 | data_dict = Struct.__make_dict(self,__loc_data__,**kw) |
|
312 | data_dict = Struct.__make_dict(self,__loc_data__,**kw) | |
313 |
|
313 | |||
314 | # policies for conflict resolution: two argument functions which return |
|
314 | # policies for conflict resolution: two argument functions which return | |
315 | # the value that will go in the new struct |
|
315 | # the value that will go in the new struct | |
316 | preserve = lambda old,new: old |
|
316 | preserve = lambda old,new: old | |
317 | update = lambda old,new: new |
|
317 | update = lambda old,new: new | |
318 | add = lambda old,new: old + new |
|
318 | add = lambda old,new: old + new | |
319 | add_flip = lambda old,new: new + old # note change of order! |
|
319 | add_flip = lambda old,new: new + old # note change of order! | |
320 | add_s = lambda old,new: old + ' ' + new |
|
320 | add_s = lambda old,new: old + ' ' + new | |
321 |
|
321 | |||
322 | # default policy is to keep current keys when there's a conflict |
|
322 | # default policy is to keep current keys when there's a conflict | |
323 | conflict_solve = list2dict2(self.keys(),default = preserve) |
|
323 | conflict_solve = list2dict2(self.keys(),default = preserve) | |
324 |
|
324 | |||
325 | # the conflict_solve dictionary is given by the user 'inverted': we |
|
325 | # the conflict_solve dictionary is given by the user 'inverted': we | |
326 | # need a name-function mapping, it comes as a function -> names |
|
326 | # need a name-function mapping, it comes as a function -> names | |
327 | # dict. Make a local copy (b/c we'll make changes), replace user |
|
327 | # dict. Make a local copy (b/c we'll make changes), replace user | |
328 | # strings for the three builtin policies and invert it. |
|
328 | # strings for the three builtin policies and invert it. | |
329 | if __conflict_solve: |
|
329 | if __conflict_solve: | |
330 | inv_conflict_solve_user = __conflict_solve.copy() |
|
330 | inv_conflict_solve_user = __conflict_solve.copy() | |
331 | for name, func in [('preserve',preserve), ('update',update), |
|
331 | for name, func in [('preserve',preserve), ('update',update), | |
332 | ('add',add), ('add_flip',add_flip), |
|
332 | ('add',add), ('add_flip',add_flip), | |
333 | ('add_s',add_s)]: |
|
333 | ('add_s',add_s)]: | |
334 | if name in inv_conflict_solve_user.keys(): |
|
334 | if name in inv_conflict_solve_user.keys(): | |
335 | inv_conflict_solve_user[func] = inv_conflict_solve_user[name] |
|
335 | inv_conflict_solve_user[func] = inv_conflict_solve_user[name] | |
336 | del inv_conflict_solve_user[name] |
|
336 | del inv_conflict_solve_user[name] | |
337 | conflict_solve.update(Struct.__dict_invert(self,inv_conflict_solve_user)) |
|
337 | conflict_solve.update(Struct.__dict_invert(self,inv_conflict_solve_user)) | |
338 | #print 'merge. conflict_solve: '; pprint(conflict_solve) # dbg |
|
338 | #print 'merge. conflict_solve: '; pprint(conflict_solve) # dbg | |
339 | #print '*'*50,'in merger. conflict_solver:'; pprint(conflict_solve) |
|
339 | #print '*'*50,'in merger. conflict_solver:'; pprint(conflict_solve) | |
340 | for key in data_dict: |
|
340 | for key in data_dict: | |
341 | if key not in self: |
|
341 | if key not in self: | |
342 | self[key] = data_dict[key] |
|
342 | self[key] = data_dict[key] | |
343 | else: |
|
343 | else: | |
344 | self[key] = conflict_solve[key](self[key],data_dict[key]) |
|
344 | self[key] = conflict_solve[key](self[key],data_dict[key]) | |
345 |
|
345 | |||
346 | def has_key(self,key): |
|
346 | def has_key(self,key): | |
347 | """Like has_key() dictionary method.""" |
|
347 | """Like has_key() dictionary method.""" | |
348 | return self.__dict__.has_key(key) |
|
348 | return self.__dict__.has_key(key) | |
349 |
|
349 | |||
350 | def hasattr(self,key): |
|
350 | def hasattr(self,key): | |
351 | """hasattr function available as a method. |
|
351 | """hasattr function available as a method. | |
352 |
|
352 | |||
353 | Implemented like has_key, to make sure that all available keys in the |
|
353 | Implemented like has_key, to make sure that all available keys in the | |
354 | internal dictionary of the Struct appear also as attributes (even |
|
354 | internal dictionary of the Struct appear also as attributes (even | |
355 | numeric keys).""" |
|
355 | numeric keys).""" | |
356 | return self.__dict__.has_key(key) |
|
356 | return self.__dict__.has_key(key) | |
357 |
|
357 | |||
358 | def items(self): |
|
358 | def items(self): | |
359 | """Return the items in the Struct's dictionary, in the same format |
|
359 | """Return the items in the Struct's dictionary, in the same format | |
360 | as a call to {}.items().""" |
|
360 | as a call to {}.items().""" | |
361 | return self.__dict__.items() |
|
361 | return self.__dict__.items() | |
362 |
|
362 | |||
363 | def keys(self): |
|
363 | def keys(self): | |
364 | """Return the keys in the Struct's dictionary, in the same format |
|
364 | """Return the keys in the Struct's dictionary, in the same format | |
365 | as a call to {}.keys().""" |
|
365 | as a call to {}.keys().""" | |
366 | return self.__dict__.keys() |
|
366 | return self.__dict__.keys() | |
367 |
|
367 | |||
368 | def values(self,keys=None): |
|
368 | def values(self,keys=None): | |
369 | """Return the values in the Struct's dictionary, in the same format |
|
369 | """Return the values in the Struct's dictionary, in the same format | |
370 | as a call to {}.values(). |
|
370 | as a call to {}.values(). | |
371 |
|
371 | |||
372 | Can be called with an optional argument keys, which must be a list or |
|
372 | Can be called with an optional argument keys, which must be a list or | |
373 | tuple of keys. In this case it returns only the values corresponding |
|
373 | tuple of keys. In this case it returns only the values corresponding | |
374 | to those keys (allowing a form of 'slicing' for Structs).""" |
|
374 | to those keys (allowing a form of 'slicing' for Structs).""" | |
375 | if not keys: |
|
375 | if not keys: | |
376 | return self.__dict__.values() |
|
376 | return self.__dict__.values() | |
377 | else: |
|
377 | else: | |
378 | ret=[] |
|
378 | ret=[] | |
379 | for k in keys: |
|
379 | for k in keys: | |
380 | ret.append(self[k]) |
|
380 | ret.append(self[k]) | |
381 | return ret |
|
381 | return ret | |
382 |
|
382 | |||
383 | def get(self,attr,val=None): |
|
383 | def get(self,attr,val=None): | |
384 | """S.get(k[,d]) -> S[k] if k in S, else d. d defaults to None.""" |
|
384 | """S.get(k[,d]) -> S[k] if k in S, else d. d defaults to None.""" | |
385 | try: |
|
385 | try: | |
386 | return self[attr] |
|
386 | return self[attr] | |
387 | except KeyError: |
|
387 | except KeyError: | |
388 | return val |
|
388 | return val | |
389 |
|
389 | |||
390 | def setdefault(self,attr,val=None): |
|
390 | def setdefault(self,attr,val=None): | |
391 | """S.setdefault(k[,d]) -> S.get(k,d), also set S[k]=d if k not in S""" |
|
391 | """S.setdefault(k[,d]) -> S.get(k,d), also set S[k]=d if k not in S""" | |
392 | if not self.has_key(attr): |
|
392 | if not self.has_key(attr): | |
393 | self[attr] = val |
|
393 | self[attr] = val | |
394 | return self.get(attr,val) |
|
394 | return self.get(attr,val) | |
395 |
|
395 | |||
396 | def allow_new_attr(self, allow = True): |
|
396 | def allow_new_attr(self, allow = True): | |
397 | """ Set whether new attributes can be created inside struct |
|
397 | """ Set whether new attributes can be created inside struct | |
398 |
|
398 | |||
399 | This can be used to catch typos by verifying that the attribute user |
|
399 | This can be used to catch typos by verifying that the attribute user | |
400 | tries to change already exists in this Struct. |
|
400 | tries to change already exists in this Struct. | |
401 | """ |
|
401 | """ | |
402 | self['__allownew'] = allow |
|
402 | self['__allownew'] = allow | |
403 |
|
403 | |||
404 |
|
404 | |||
405 | # end class Struct |
|
405 | # end class Struct | |
406 |
|
406 |
@@ -1,39 +1,41 b'' | |||||
|
1 | from __future__ import with_statement | |||
|
2 | ||||
1 | #def test_simple(): |
|
3 | #def test_simple(): | |
2 | if 0: |
|
4 | if 0: | |
3 |
|
5 | |||
4 | # XXX - for now, we need a running cluster to be started separately. The |
|
6 | # XXX - for now, we need a running cluster to be started separately. The | |
5 | # daemon work is almost finished, and will make much of this unnecessary. |
|
7 | # daemon work is almost finished, and will make much of this unnecessary. | |
6 | from IPython.kernel import client |
|
8 | from IPython.kernel import client | |
7 | mec = client.MultiEngineClient(('127.0.0.1',10105)) |
|
9 | mec = client.MultiEngineClient(('127.0.0.1',10105)) | |
8 |
|
10 | |||
9 | try: |
|
11 | try: | |
10 | mec.get_ids() |
|
12 | mec.get_ids() | |
11 | except ConnectionRefusedError: |
|
13 | except ConnectionRefusedError: | |
12 | import os, time |
|
14 | import os, time | |
13 | os.system('ipcluster -n 2 &') |
|
15 | os.system('ipcluster -n 2 &') | |
14 | time.sleep(2) |
|
16 | time.sleep(2) | |
15 | mec = client.MultiEngineClient(('127.0.0.1',10105)) |
|
17 | mec = client.MultiEngineClient(('127.0.0.1',10105)) | |
16 |
|
18 | |||
17 | mec.block = False |
|
19 | mec.block = False | |
18 |
|
20 | |||
19 | import itertools |
|
21 | import itertools | |
20 | c = itertools.count() |
|
22 | c = itertools.count() | |
21 |
|
23 | |||
22 | parallel = RemoteMultiEngine(mec) |
|
24 | parallel = RemoteMultiEngine(mec) | |
23 |
|
25 | |||
24 | mec.pushAll() |
|
26 | mec.pushAll() | |
25 |
|
27 | |||
26 | with parallel as pr: |
|
28 | with parallel as pr: | |
27 | # A comment |
|
29 | # A comment | |
28 | remote() # this means the code below only runs remotely |
|
30 | remote() # this means the code below only runs remotely | |
29 | print 'Hello remote world' |
|
31 | print 'Hello remote world' | |
30 | x = range(10) |
|
32 | x = range(10) | |
31 | # Comments are OK |
|
33 | # Comments are OK | |
32 | # Even misindented. |
|
34 | # Even misindented. | |
33 | y = x+1 |
|
35 | y = x+1 | |
34 |
|
36 | |||
35 |
|
37 | |||
36 | with pfor('i',sequence) as pr: |
|
38 | with pfor('i',sequence) as pr: | |
37 | print x[i] |
|
39 | print x[i] | |
38 |
|
40 | |||
39 | print pr.x + pr.y |
|
41 | print pr.x + pr.y |
1 | NO CONTENT: file renamed from IPython/testing/plugin/decorator_msim.py to IPython/testing/decorator_msim.py |
|
NO CONTENT: file renamed from IPython/testing/plugin/decorator_msim.py to IPython/testing/decorator_msim.py |
@@ -1,144 +1,133 b'' | |||||
1 | """Decorators for labeling test objects. |
|
1 | """Decorators for labeling test objects. | |
2 |
|
2 | |||
3 | Decorators that merely return a modified version of the original |
|
3 | Decorators that merely return a modified version of the original | |
4 | function object are straightforward. Decorators that return a new |
|
4 | function object are straightforward. Decorators that return a new | |
5 | function object need to use |
|
5 | function object need to use | |
6 | nose.tools.make_decorator(original_function)(decorator) in returning |
|
6 | nose.tools.make_decorator(original_function)(decorator) in returning | |
7 | the decorator, in order to preserve metadata such as function name, |
|
7 | the decorator, in order to preserve metadata such as function name, | |
8 | setup and teardown functions and so on - see nose.tools for more |
|
8 | setup and teardown functions and so on - see nose.tools for more | |
9 | information. |
|
9 | information. | |
10 |
|
10 | |||
11 | NOTE: This file contains IPython-specific decorators and imports the |
|
11 | NOTE: This file contains IPython-specific decorators and imports the | |
12 | numpy.testing.decorators file, which we've copied verbatim. Any of our own |
|
12 | numpy.testing.decorators file, which we've copied verbatim. Any of our own | |
13 | code will be added at the bottom if we end up extending this. |
|
13 | code will be added at the bottom if we end up extending this. | |
14 | """ |
|
14 | """ | |
15 |
|
15 | |||
16 | # Stdlib imports |
|
16 | # Stdlib imports | |
17 | import inspect |
|
17 | import inspect | |
18 |
|
18 | |||
19 | # Third-party imports |
|
19 | # Third-party imports | |
20 |
|
20 | |||
21 | # This is Michele Simionato's decorator module, also kept verbatim. |
|
21 | # This is Michele Simionato's decorator module, also kept verbatim. | |
22 | from decorator_msim import decorator |
|
22 | from decorator_msim import decorator, update_wrapper | |
23 |
|
23 | |||
24 | # Grab the numpy-specific decorators which we keep in a file that we |
|
24 | # Grab the numpy-specific decorators which we keep in a file that we | |
25 | # occasionally update from upstream: decorators_numpy.py is an IDENTICAL copy |
|
25 | # occasionally update from upstream: decorators_numpy.py is an IDENTICAL copy | |
26 | # of numpy.testing.decorators. |
|
26 | # of numpy.testing.decorators. | |
27 | from decorators_numpy import * |
|
27 | from decorators_numpy import * | |
28 |
|
28 | |||
29 | ############################################################################## |
|
29 | ############################################################################## | |
30 | # Local code begins |
|
30 | # Local code begins | |
31 |
|
31 | |||
32 | # Utility functions |
|
32 | # Utility functions | |
33 |
|
33 | |||
34 | def apply_wrapper(wrapper,func): |
|
34 | def apply_wrapper(wrapper,func): | |
35 | """Apply a wrapper to a function for decoration. |
|
35 | """Apply a wrapper to a function for decoration. | |
36 |
|
36 | |||
37 | This mixes Michele Simionato's decorator tool with nose's make_decorator, |
|
37 | This mixes Michele Simionato's decorator tool with nose's make_decorator, | |
38 | to apply a wrapper in a decorator so that all nose attributes, as well as |
|
38 | to apply a wrapper in a decorator so that all nose attributes, as well as | |
39 | function signature and other properties, survive the decoration cleanly. |
|
39 | function signature and other properties, survive the decoration cleanly. | |
40 | This will ensure that wrapped functions can still be well introspected via |
|
40 | This will ensure that wrapped functions can still be well introspected via | |
41 | IPython, for example. |
|
41 | IPython, for example. | |
42 | """ |
|
42 | """ | |
43 | import nose.tools |
|
43 | import nose.tools | |
44 |
|
44 | |||
45 | return decorator(wrapper,nose.tools.make_decorator(func)(wrapper)) |
|
45 | return decorator(wrapper,nose.tools.make_decorator(func)(wrapper)) | |
46 |
|
46 | |||
47 |
|
47 | |||
48 | def make_label_dec(label,ds=None): |
|
48 | def make_label_dec(label,ds=None): | |
49 | """Factory function to create a decorator that applies one or more labels. |
|
49 | """Factory function to create a decorator that applies one or more labels. | |
50 |
|
50 | |||
51 | :Parameters: |
|
51 | :Parameters: | |
52 | label : string or sequence |
|
52 | label : string or sequence | |
53 | One or more labels that will be applied by the decorator to the functions |
|
53 | One or more labels that will be applied by the decorator to the functions | |
54 | it decorates. Labels are attributes of the decorated function with their |
|
54 | it decorates. Labels are attributes of the decorated function with their | |
55 | value set to True. |
|
55 | value set to True. | |
56 |
|
56 | |||
57 | :Keywords: |
|
57 | :Keywords: | |
58 | ds : string |
|
58 | ds : string | |
59 | An optional docstring for the resulting decorator. If not given, a |
|
59 | An optional docstring for the resulting decorator. If not given, a | |
60 | default docstring is auto-generated. |
|
60 | default docstring is auto-generated. | |
61 |
|
61 | |||
62 | :Returns: |
|
62 | :Returns: | |
63 | A decorator. |
|
63 | A decorator. | |
64 |
|
64 | |||
65 | :Examples: |
|
65 | :Examples: | |
66 |
|
66 | |||
67 | A simple labeling decorator: |
|
67 | A simple labeling decorator: | |
68 | >>> slow = make_label_dec('slow') |
|
68 | >>> slow = make_label_dec('slow') | |
69 | >>> print slow.__doc__ |
|
69 | >>> print slow.__doc__ | |
70 | Labels a test as 'slow'. |
|
70 | Labels a test as 'slow'. | |
71 |
|
71 | |||
72 | And one that uses multiple labels and a custom docstring: |
|
72 | And one that uses multiple labels and a custom docstring: | |
73 | >>> rare = make_label_dec(['slow','hard'], |
|
73 | >>> rare = make_label_dec(['slow','hard'], | |
74 | ... "Mix labels 'slow' and 'hard' for rare tests.") |
|
74 | ... "Mix labels 'slow' and 'hard' for rare tests.") | |
75 | >>> print rare.__doc__ |
|
75 | >>> print rare.__doc__ | |
76 | Mix labels 'slow' and 'hard' for rare tests. |
|
76 | Mix labels 'slow' and 'hard' for rare tests. | |
77 |
|
77 | |||
78 | Now, let's test using this one: |
|
78 | Now, let's test using this one: | |
79 | >>> @rare |
|
79 | >>> @rare | |
80 | ... def f(): pass |
|
80 | ... def f(): pass | |
81 | ... |
|
81 | ... | |
82 | >>> |
|
82 | >>> | |
83 | >>> f.slow |
|
83 | >>> f.slow | |
84 | True |
|
84 | True | |
85 | >>> f.hard |
|
85 | >>> f.hard | |
86 | True |
|
86 | True | |
87 | """ |
|
87 | """ | |
88 |
|
88 | |||
89 | if isinstance(label,basestring): |
|
89 | if isinstance(label,basestring): | |
90 | labels = [label] |
|
90 | labels = [label] | |
91 | else: |
|
91 | else: | |
92 | labels = label |
|
92 | labels = label | |
93 |
|
93 | |||
94 | # Validate that the given label(s) are OK for use in setattr() by doing a |
|
94 | # Validate that the given label(s) are OK for use in setattr() by doing a | |
95 | # dry run on a dummy function. |
|
95 | # dry run on a dummy function. | |
96 | tmp = lambda : None |
|
96 | tmp = lambda : None | |
97 | for label in labels: |
|
97 | for label in labels: | |
98 | setattr(tmp,label,True) |
|
98 | setattr(tmp,label,True) | |
99 |
|
99 | |||
100 | # This is the actual decorator we'll return |
|
100 | # This is the actual decorator we'll return | |
101 | def decor(f): |
|
101 | def decor(f): | |
102 | for label in labels: |
|
102 | for label in labels: | |
103 | setattr(f,label,True) |
|
103 | setattr(f,label,True) | |
104 | return f |
|
104 | return f | |
105 |
|
105 | |||
106 | # Apply the user's docstring, or autogenerate a basic one |
|
106 | # Apply the user's docstring, or autogenerate a basic one | |
107 | if ds is None: |
|
107 | if ds is None: | |
108 | ds = "Labels a test as %r." % label |
|
108 | ds = "Labels a test as %r." % label | |
109 | decor.__doc__ = ds |
|
109 | decor.__doc__ = ds | |
110 |
|
110 | |||
111 | return decor |
|
111 | return decor | |
112 |
|
112 | |||
113 | #----------------------------------------------------------------------------- |
|
113 | #----------------------------------------------------------------------------- | |
114 | # Decorators for public use |
|
114 | # Decorators for public use | |
115 |
|
115 | |||
116 | def skip_doctest(func): |
|
116 | skip_doctest = make_label_dec('skip_doctest', | |
117 | """Decorator - mark a function for skipping its doctest. |
|
117 | """Decorator - mark a function or method for skipping its doctest. | |
118 |
|
118 | |||
119 | This decorator allows you to mark a function whose docstring you wish to |
|
119 | This decorator allows you to mark a function whose docstring you wish to | |
120 | omit from testing, while preserving the docstring for introspection, help, |
|
120 | omit from testing, while preserving the docstring for introspection, help, | |
121 | etc.""" |
|
121 | etc.""") | |
122 |
|
||||
123 | # We just return the function unmodified, but the wrapping has the effect |
|
|||
124 | # of making the doctest plugin skip the doctest. |
|
|||
125 | def wrapper(*a,**k): |
|
|||
126 | return func(*a,**k) |
|
|||
127 |
|
||||
128 | # Here we use plain 'decorator' and not apply_wrapper, because we don't |
|
|||
129 | # need all the nose-protection machinery (functions containing doctests |
|
|||
130 | # can't be full-blown nose tests, so we don't need to prserve |
|
|||
131 | # setup/teardown). |
|
|||
132 | return decorator(wrapper,func) |
|
|||
133 |
|
122 | |||
134 |
|
123 | |||
135 | def skip(func): |
|
124 | def skip(func): | |
136 | """Decorator - mark a test function for skipping from test suite.""" |
|
125 | """Decorator - mark a test function for skipping from test suite.""" | |
137 |
|
126 | |||
138 | import nose |
|
127 | import nose | |
139 |
|
128 | |||
140 | def wrapper(*a,**k): |
|
129 | def wrapper(*a,**k): | |
141 | raise nose.SkipTest("Skipping test for function: %s" % |
|
130 | raise nose.SkipTest("Skipping test for function: %s" % | |
142 | func.__name__) |
|
131 | func.__name__) | |
143 |
|
132 | |||
144 | return apply_wrapper(wrapper,func) |
|
133 | return apply_wrapper(wrapper,func) |
1 | NO CONTENT: file renamed from IPython/testing/plugin/decorators_numpy.py to IPython/testing/decorators_numpy.py |
|
NO CONTENT: file renamed from IPython/testing/plugin/decorators_numpy.py to IPython/testing/decorators_numpy.py |
@@ -1,48 +1,54 b'' | |||||
1 | # Set this prefix to where you want to install the plugin |
|
1 | # Set this prefix to where you want to install the plugin | |
2 | PREFIX=~/usr/local |
|
2 | PREFIX=~/usr/local | |
3 | PREFIX=~/tmp/local |
|
3 | PREFIX=~/tmp/local | |
4 |
|
4 | |||
5 | NOSE0=nosetests -vs --with-doctest --doctest-tests |
|
5 | NOSE0=nosetests -vs --with-doctest --doctest-tests | |
6 | NOSE=nosetests -vvs --with-ipdoctest --doctest-tests --doctest-extension=txt |
|
6 | NOSE=nosetests -vvs --with-ipdoctest --doctest-tests --doctest-extension=txt | |
7 |
|
7 | |||
8 | #--with-color |
|
8 | #--with-color | |
9 |
|
9 | |||
10 | SRC=ipdoctest.py setup.py decorators.py |
|
10 | SRC=ipdoctest.py setup.py ../decorators.py | |
11 |
|
11 | |||
12 | plugin: IPython_doctest_plugin.egg-info |
|
12 | plugin: IPython_doctest_plugin.egg-info | |
13 |
|
13 | |||
14 | dtest: plugin dtexample.py |
|
14 | dtest: plugin dtexample.py | |
15 | $(NOSE) dtexample.py |
|
15 | $(NOSE) dtexample.py | |
16 |
|
16 | |||
17 | # Note: this test is double counting!!! |
|
17 | # Note: this test is double counting!!! | |
18 | rtest: plugin dtexample.py |
|
18 | rtest: plugin dtexample.py | |
19 | $(NOSE) test_refs.py |
|
19 | $(NOSE) test_refs.py | |
20 |
|
20 | |||
21 | std: plugin |
|
21 | std: plugin | |
22 | nosetests -vs --with-doctest --doctest-tests IPython.strdispatch |
|
22 | nosetests -vs --with-doctest --doctest-tests IPython.strdispatch | |
23 | $(NOSE) IPython.strdispatch |
|
23 | $(NOSE) IPython.strdispatch | |
24 |
|
24 | |||
25 | test: plugin dtexample.py |
|
25 | test: plugin dtexample.py | |
26 | $(NOSE) dtexample.py test*.py test*.txt |
|
26 | $(NOSE) dtexample.py test*.py test*.txt | |
27 |
|
27 | |||
28 | deb: plugin dtexample.py |
|
28 | deb: plugin dtexample.py | |
29 | $(NOSE) test_combo.txt |
|
29 | $(NOSE) test_combo.txt | |
30 |
|
30 | |||
31 | iptest: plugin |
|
31 | iptest: plugin | |
32 | $(NOSE) IPython |
|
32 | $(NOSE) IPython | |
33 |
|
33 | |||
34 | deco: |
|
34 | deco: | |
35 |
$(NOSE0) decorators |
|
35 | $(NOSE0) IPython.testing.decorators | |
|
36 | ||||
|
37 | mtest: plugin | |||
|
38 | $(NOSE) -x IPython.Magic | |||
|
39 | ||||
|
40 | ipipe: plugin | |||
|
41 | $(NOSE) -x IPython.Extensions.ipipe | |||
36 |
|
42 | |||
37 | sr: rtest std |
|
43 | sr: rtest std | |
38 |
|
44 | |||
39 | base: dtest rtest test std deco |
|
45 | base: dtest rtest test std deco | |
40 |
|
46 | |||
41 | all: base iptest |
|
47 | all: base iptest | |
42 |
|
48 | |||
43 | IPython_doctest_plugin.egg-info: $(SRC) |
|
49 | IPython_doctest_plugin.egg-info: $(SRC) | |
44 | python setup.py install --prefix=$(PREFIX) |
|
50 | python setup.py install --prefix=$(PREFIX) | |
45 | touch $@ |
|
51 | touch $@ | |
46 |
|
52 | |||
47 | clean: |
|
53 | clean: | |
48 | rm -rf IPython_doctest_plugin.egg-info *~ *pyc build/ dist/ |
|
54 | rm -rf IPython_doctest_plugin.egg-info *~ *pyc build/ dist/ |
@@ -1,733 +1,753 b'' | |||||
1 | """Nose Plugin that supports IPython doctests. |
|
1 | """Nose Plugin that supports IPython doctests. | |
2 |
|
2 | |||
3 | Limitations: |
|
3 | Limitations: | |
4 |
|
4 | |||
5 | - When generating examples for use as doctests, make sure that you have |
|
5 | - When generating examples for use as doctests, make sure that you have | |
6 | pretty-printing OFF. This can be done either by starting ipython with the |
|
6 | pretty-printing OFF. This can be done either by starting ipython with the | |
7 | flag '--nopprint', by setting pprint to 0 in your ipythonrc file, or by |
|
7 | flag '--nopprint', by setting pprint to 0 in your ipythonrc file, or by | |
8 | interactively disabling it with %Pprint. This is required so that IPython |
|
8 | interactively disabling it with %Pprint. This is required so that IPython | |
9 | output matches that of normal Python, which is used by doctest for internal |
|
9 | output matches that of normal Python, which is used by doctest for internal | |
10 | execution. |
|
10 | execution. | |
11 |
|
11 | |||
12 | - Do not rely on specific prompt numbers for results (such as using |
|
12 | - Do not rely on specific prompt numbers for results (such as using | |
13 | '_34==True', for example). For IPython tests run via an external process the |
|
13 | '_34==True', for example). For IPython tests run via an external process the | |
14 | prompt numbers may be different, and IPython tests run as normal python code |
|
14 | prompt numbers may be different, and IPython tests run as normal python code | |
15 | won't even have these special _NN variables set at all. |
|
15 | won't even have these special _NN variables set at all. | |
16 |
|
16 | |||
17 | - IPython functions that produce output as a side-effect of calling a system |
|
17 | - IPython functions that produce output as a side-effect of calling a system | |
18 | process (e.g. 'ls') can be doc-tested, but they must be handled in an |
|
18 | process (e.g. 'ls') can be doc-tested, but they must be handled in an | |
19 | external IPython process. Such doctests must be tagged with: |
|
19 | external IPython process. Such doctests must be tagged with: | |
20 |
|
20 | |||
21 | # ipdoctest: EXTERNAL |
|
21 | # ipdoctest: EXTERNAL | |
22 |
|
22 | |||
23 | so that the testing machinery handles them differently. Since these are run |
|
23 | so that the testing machinery handles them differently. Since these are run | |
24 | via pexpect in an external process, they can't deal with exceptions or other |
|
24 | via pexpect in an external process, they can't deal with exceptions or other | |
25 | fancy featurs of regular doctests. You must limit such tests to simple |
|
25 | fancy featurs of regular doctests. You must limit such tests to simple | |
26 | matching of the output. For this reason, I recommend you limit these kinds |
|
26 | matching of the output. For this reason, I recommend you limit these kinds | |
27 | of doctests to features that truly require a separate process, and use the |
|
27 | of doctests to features that truly require a separate process, and use the | |
28 | normal IPython ones (which have all the features of normal doctests) for |
|
28 | normal IPython ones (which have all the features of normal doctests) for | |
29 | everything else. See the examples at the bottom of this file for a |
|
29 | everything else. See the examples at the bottom of this file for a | |
30 | comparison of what can be done with both types. |
|
30 | comparison of what can be done with both types. | |
31 | """ |
|
31 | """ | |
32 |
|
32 | |||
33 |
|
33 | |||
34 | #----------------------------------------------------------------------------- |
|
34 | #----------------------------------------------------------------------------- | |
35 | # Module imports |
|
35 | # Module imports | |
36 |
|
36 | |||
37 | # From the standard library |
|
37 | # From the standard library | |
38 | import __builtin__ |
|
38 | import __builtin__ | |
39 | import commands |
|
39 | import commands | |
40 | import doctest |
|
40 | import doctest | |
41 | import inspect |
|
41 | import inspect | |
42 | import logging |
|
42 | import logging | |
43 | import os |
|
43 | import os | |
44 | import re |
|
44 | import re | |
45 | import sys |
|
45 | import sys | |
46 | import traceback |
|
46 | import traceback | |
47 | import unittest |
|
47 | import unittest | |
48 |
|
48 | |||
49 | from inspect import getmodule |
|
49 | from inspect import getmodule | |
50 | from StringIO import StringIO |
|
50 | from StringIO import StringIO | |
51 |
|
51 | |||
52 | # We are overriding the default doctest runner, so we need to import a few |
|
52 | # We are overriding the default doctest runner, so we need to import a few | |
53 | # things from doctest directly |
|
53 | # things from doctest directly | |
54 | from doctest import (REPORTING_FLAGS, REPORT_ONLY_FIRST_FAILURE, |
|
54 | from doctest import (REPORTING_FLAGS, REPORT_ONLY_FIRST_FAILURE, | |
55 | _unittest_reportflags, DocTestRunner, |
|
55 | _unittest_reportflags, DocTestRunner, | |
56 | _extract_future_flags, pdb, _OutputRedirectingPdb, |
|
56 | _extract_future_flags, pdb, _OutputRedirectingPdb, | |
57 | _exception_traceback, |
|
57 | _exception_traceback, | |
58 | linecache) |
|
58 | linecache) | |
59 |
|
59 | |||
60 | # Third-party modules |
|
60 | # Third-party modules | |
61 | import nose.core |
|
61 | import nose.core | |
62 |
|
62 | |||
63 | from nose.plugins import doctests, Plugin |
|
63 | from nose.plugins import doctests, Plugin | |
64 | from nose.util import anyp, getpackage, test_address, resolve_name, tolist |
|
64 | from nose.util import anyp, getpackage, test_address, resolve_name, tolist | |
65 |
|
65 | |||
66 | # Our own imports |
|
66 | # Our own imports | |
67 | #from extdoctest import ExtensionDoctest, DocTestFinder |
|
67 | #from extdoctest import ExtensionDoctest, DocTestFinder | |
68 | #from dttools import DocTestFinder, DocTestCase |
|
68 | #from dttools import DocTestFinder, DocTestCase | |
69 | #----------------------------------------------------------------------------- |
|
69 | #----------------------------------------------------------------------------- | |
70 | # Module globals and other constants |
|
70 | # Module globals and other constants | |
71 |
|
71 | |||
72 | log = logging.getLogger(__name__) |
|
72 | log = logging.getLogger(__name__) | |
73 |
|
73 | |||
74 | ########################################################################### |
|
74 | ########################################################################### | |
75 | # *** HACK *** |
|
75 | # *** HACK *** | |
76 | # We must start our own ipython object and heavily muck with it so that all the |
|
76 | # We must start our own ipython object and heavily muck with it so that all the | |
77 | # modifications IPython makes to system behavior don't send the doctest |
|
77 | # modifications IPython makes to system behavior don't send the doctest | |
78 | # machinery into a fit. This code should be considered a gross hack, but it |
|
78 | # machinery into a fit. This code should be considered a gross hack, but it | |
79 | # gets the job done. |
|
79 | # gets the job done. | |
80 |
|
80 | |||
81 |
|
81 | |||
82 | # XXX - Hack to modify the %run command so we can sync the user's namespace |
|
82 | # XXX - Hack to modify the %run command so we can sync the user's namespace | |
83 | # with the test globals. Once we move over to a clean magic system, this will |
|
83 | # with the test globals. Once we move over to a clean magic system, this will | |
84 | # be done with much less ugliness. |
|
84 | # be done with much less ugliness. | |
85 |
|
85 | |||
86 | def _run_ns_sync(self,arg_s,runner=None): |
|
86 | def _run_ns_sync(self,arg_s,runner=None): | |
87 | """Modified version of %run that syncs testing namespaces. |
|
87 | """Modified version of %run that syncs testing namespaces. | |
88 |
|
88 | |||
89 | This is strictly needed for running doctests that call %run. |
|
89 | This is strictly needed for running doctests that call %run. | |
90 | """ |
|
90 | """ | |
91 |
|
91 | |||
92 | out = _ip.IP.magic_run_ori(arg_s,runner) |
|
92 | out = _ip.IP.magic_run_ori(arg_s,runner) | |
93 | _run_ns_sync.test_globs.update(_ip.user_ns) |
|
93 | _run_ns_sync.test_globs.update(_ip.user_ns) | |
94 | return out |
|
94 | return out | |
95 |
|
95 | |||
96 |
|
96 | |||
97 | def start_ipython(): |
|
97 | def start_ipython(): | |
98 | """Start a global IPython shell, which we need for IPython-specific syntax. |
|
98 | """Start a global IPython shell, which we need for IPython-specific syntax. | |
99 | """ |
|
99 | """ | |
100 | import new |
|
100 | import new | |
101 |
|
101 | |||
102 | import IPython |
|
102 | import IPython | |
103 |
|
103 | |||
104 | def xsys(cmd): |
|
104 | def xsys(cmd): | |
105 | """Execute a command and print its output. |
|
105 | """Execute a command and print its output. | |
106 |
|
106 | |||
107 | This is just a convenience function to replace the IPython system call |
|
107 | This is just a convenience function to replace the IPython system call | |
108 | with one that is more doctest-friendly. |
|
108 | with one that is more doctest-friendly. | |
109 | """ |
|
109 | """ | |
110 | cmd = _ip.IP.var_expand(cmd,depth=1) |
|
110 | cmd = _ip.IP.var_expand(cmd,depth=1) | |
111 | sys.stdout.write(commands.getoutput(cmd)) |
|
111 | sys.stdout.write(commands.getoutput(cmd)) | |
112 | sys.stdout.flush() |
|
112 | sys.stdout.flush() | |
113 |
|
113 | |||
114 | # Store certain global objects that IPython modifies |
|
114 | # Store certain global objects that IPython modifies | |
115 | _displayhook = sys.displayhook |
|
115 | _displayhook = sys.displayhook | |
116 | _excepthook = sys.excepthook |
|
116 | _excepthook = sys.excepthook | |
117 | _main = sys.modules.get('__main__') |
|
117 | _main = sys.modules.get('__main__') | |
118 |
|
118 | |||
119 | # Start IPython instance. We customize it to start with minimal frills. |
|
119 | # Start IPython instance. We customize it to start with minimal frills. | |
120 | IPython.Shell.IPShell(['--classic','--noterm_title']) |
|
120 | IPython.Shell.IPShell(['--classic','--noterm_title']) | |
121 |
|
121 | |||
122 | # Deactivate the various python system hooks added by ipython for |
|
122 | # Deactivate the various python system hooks added by ipython for | |
123 | # interactive convenience so we don't confuse the doctest system |
|
123 | # interactive convenience so we don't confuse the doctest system | |
124 | sys.modules['__main__'] = _main |
|
124 | sys.modules['__main__'] = _main | |
125 | sys.displayhook = _displayhook |
|
125 | sys.displayhook = _displayhook | |
126 | sys.excepthook = _excepthook |
|
126 | sys.excepthook = _excepthook | |
127 |
|
127 | |||
128 | # So that ipython magics and aliases can be doctested (they work by making |
|
128 | # So that ipython magics and aliases can be doctested (they work by making | |
129 | # a call into a global _ip object) |
|
129 | # a call into a global _ip object) | |
130 | _ip = IPython.ipapi.get() |
|
130 | _ip = IPython.ipapi.get() | |
131 | __builtin__._ip = _ip |
|
131 | __builtin__._ip = _ip | |
132 |
|
132 | |||
133 | # Modify the IPython system call with one that uses getoutput, so that we |
|
133 | # Modify the IPython system call with one that uses getoutput, so that we | |
134 | # can capture subcommands and print them to Python's stdout, otherwise the |
|
134 | # can capture subcommands and print them to Python's stdout, otherwise the | |
135 | # doctest machinery would miss them. |
|
135 | # doctest machinery would miss them. | |
136 | _ip.system = xsys |
|
136 | _ip.system = xsys | |
137 |
|
137 | |||
138 | # Also patch our %run function in. |
|
138 | # Also patch our %run function in. | |
139 | im = new.instancemethod(_run_ns_sync,_ip.IP, _ip.IP.__class__) |
|
139 | im = new.instancemethod(_run_ns_sync,_ip.IP, _ip.IP.__class__) | |
140 | _ip.IP.magic_run_ori = _ip.IP.magic_run |
|
140 | _ip.IP.magic_run_ori = _ip.IP.magic_run | |
141 | _ip.IP.magic_run = im |
|
141 | _ip.IP.magic_run = im | |
142 |
|
142 | |||
143 | # The start call MUST be made here. I'm not sure yet why it doesn't work if |
|
143 | # The start call MUST be made here. I'm not sure yet why it doesn't work if | |
144 | # it is made later, at plugin initialization time, but in all my tests, that's |
|
144 | # it is made later, at plugin initialization time, but in all my tests, that's | |
145 | # the case. |
|
145 | # the case. | |
146 | start_ipython() |
|
146 | start_ipython() | |
147 |
|
147 | |||
148 | # *** END HACK *** |
|
148 | # *** END HACK *** | |
149 | ########################################################################### |
|
149 | ########################################################################### | |
150 |
|
150 | |||
151 | # Classes and functions |
|
151 | # Classes and functions | |
152 |
|
152 | |||
153 | def is_extension_module(filename): |
|
153 | def is_extension_module(filename): | |
154 | """Return whether the given filename is an extension module. |
|
154 | """Return whether the given filename is an extension module. | |
155 |
|
155 | |||
156 | This simply checks that the extension is either .so or .pyd. |
|
156 | This simply checks that the extension is either .so or .pyd. | |
157 | """ |
|
157 | """ | |
158 | return os.path.splitext(filename)[1].lower() in ('.so','.pyd') |
|
158 | return os.path.splitext(filename)[1].lower() in ('.so','.pyd') | |
159 |
|
159 | |||
160 |
|
160 | |||
|
161 | class nodoc(object): | |||
|
162 | def __init__(self,obj): | |||
|
163 | self.obj = obj | |||
|
164 | ||||
|
165 | def __getattribute__(self,key): | |||
|
166 | if key == '__doc__': | |||
|
167 | return None | |||
|
168 | else: | |||
|
169 | return getattr(object.__getattribute__(self,'obj'),key) | |||
|
170 | ||||
161 | # Modified version of the one in the stdlib, that fixes a python bug (doctests |
|
171 | # Modified version of the one in the stdlib, that fixes a python bug (doctests | |
162 | # not found in extension modules, http://bugs.python.org/issue3158) |
|
172 | # not found in extension modules, http://bugs.python.org/issue3158) | |
163 | class DocTestFinder(doctest.DocTestFinder): |
|
173 | class DocTestFinder(doctest.DocTestFinder): | |
164 |
|
174 | |||
165 | def _from_module(self, module, object): |
|
175 | def _from_module(self, module, object): | |
166 | """ |
|
176 | """ | |
167 | Return true if the given object is defined in the given |
|
177 | Return true if the given object is defined in the given | |
168 | module. |
|
178 | module. | |
169 | """ |
|
179 | """ | |
170 | if module is None: |
|
180 | if module is None: | |
171 | return True |
|
181 | return True | |
172 | elif inspect.isfunction(object): |
|
182 | elif inspect.isfunction(object): | |
173 | return module.__dict__ is object.func_globals |
|
183 | return module.__dict__ is object.func_globals | |
174 | elif inspect.isbuiltin(object): |
|
184 | elif inspect.isbuiltin(object): | |
175 | return module.__name__ == object.__module__ |
|
185 | return module.__name__ == object.__module__ | |
176 | elif inspect.isclass(object): |
|
186 | elif inspect.isclass(object): | |
177 | return module.__name__ == object.__module__ |
|
187 | return module.__name__ == object.__module__ | |
178 | elif inspect.ismethod(object): |
|
188 | elif inspect.ismethod(object): | |
179 | # This one may be a bug in cython that fails to correctly set the |
|
189 | # This one may be a bug in cython that fails to correctly set the | |
180 | # __module__ attribute of methods, but since the same error is easy |
|
190 | # __module__ attribute of methods, but since the same error is easy | |
181 | # to make by extension code writers, having this safety in place |
|
191 | # to make by extension code writers, having this safety in place | |
182 | # isn't such a bad idea |
|
192 | # isn't such a bad idea | |
183 | return module.__name__ == object.im_class.__module__ |
|
193 | return module.__name__ == object.im_class.__module__ | |
184 | elif inspect.getmodule(object) is not None: |
|
194 | elif inspect.getmodule(object) is not None: | |
185 | return module is inspect.getmodule(object) |
|
195 | return module is inspect.getmodule(object) | |
186 | elif hasattr(object, '__module__'): |
|
196 | elif hasattr(object, '__module__'): | |
187 | return module.__name__ == object.__module__ |
|
197 | return module.__name__ == object.__module__ | |
188 | elif isinstance(object, property): |
|
198 | elif isinstance(object, property): | |
189 | return True # [XX] no way not be sure. |
|
199 | return True # [XX] no way not be sure. | |
190 | else: |
|
200 | else: | |
191 | raise ValueError("object must be a class or function") |
|
201 | raise ValueError("object must be a class or function") | |
192 |
|
202 | |||
193 | def _find(self, tests, obj, name, module, source_lines, globs, seen): |
|
203 | def _find(self, tests, obj, name, module, source_lines, globs, seen): | |
194 | """ |
|
204 | """ | |
195 | Find tests for the given object and any contained objects, and |
|
205 | Find tests for the given object and any contained objects, and | |
196 | add them to `tests`. |
|
206 | add them to `tests`. | |
197 | """ |
|
207 | """ | |
198 |
|
208 | |||
|
209 | if hasattr(obj,"skip_doctest"): | |||
|
210 | #print 'SKIPPING DOCTEST FOR:',obj # dbg | |||
|
211 | obj = nodoc(obj) | |||
|
212 | ||||
199 | doctest.DocTestFinder._find(self,tests, obj, name, module, |
|
213 | doctest.DocTestFinder._find(self,tests, obj, name, module, | |
200 | source_lines, globs, seen) |
|
214 | source_lines, globs, seen) | |
201 |
|
215 | |||
202 | # Below we re-run pieces of the above method with manual modifications, |
|
216 | # Below we re-run pieces of the above method with manual modifications, | |
203 | # because the original code is buggy and fails to correctly identify |
|
217 | # because the original code is buggy and fails to correctly identify | |
204 | # doctests in extension modules. |
|
218 | # doctests in extension modules. | |
205 |
|
219 | |||
206 | # Local shorthands |
|
220 | # Local shorthands | |
207 | from inspect import isroutine, isclass, ismodule |
|
221 | from inspect import isroutine, isclass, ismodule | |
208 |
|
222 | |||
209 | # Look for tests in a module's contained objects. |
|
223 | # Look for tests in a module's contained objects. | |
210 | if inspect.ismodule(obj) and self._recurse: |
|
224 | if inspect.ismodule(obj) and self._recurse: | |
211 | for valname, val in obj.__dict__.items(): |
|
225 | for valname, val in obj.__dict__.items(): | |
212 | valname1 = '%s.%s' % (name, valname) |
|
226 | valname1 = '%s.%s' % (name, valname) | |
213 | if ( (isroutine(val) or isclass(val)) |
|
227 | if ( (isroutine(val) or isclass(val)) | |
214 | and self._from_module(module, val) ): |
|
228 | and self._from_module(module, val) ): | |
215 |
|
229 | |||
216 | self._find(tests, val, valname1, module, source_lines, |
|
230 | self._find(tests, val, valname1, module, source_lines, | |
217 | globs, seen) |
|
231 | globs, seen) | |
218 |
|
232 | |||
219 | # Look for tests in a class's contained objects. |
|
233 | # Look for tests in a class's contained objects. | |
220 | if inspect.isclass(obj) and self._recurse: |
|
234 | if inspect.isclass(obj) and self._recurse: | |
221 | #print 'RECURSE into class:',obj # dbg |
|
235 | #print 'RECURSE into class:',obj # dbg | |
222 | for valname, val in obj.__dict__.items(): |
|
236 | for valname, val in obj.__dict__.items(): | |
223 | # Special handling for staticmethod/classmethod. |
|
237 | # Special handling for staticmethod/classmethod. | |
224 | if isinstance(val, staticmethod): |
|
238 | if isinstance(val, staticmethod): | |
225 | val = getattr(obj, valname) |
|
239 | val = getattr(obj, valname) | |
226 | if isinstance(val, classmethod): |
|
240 | if isinstance(val, classmethod): | |
227 | val = getattr(obj, valname).im_func |
|
241 | val = getattr(obj, valname).im_func | |
228 |
|
242 | |||
229 | # Recurse to methods, properties, and nested classes. |
|
243 | # Recurse to methods, properties, and nested classes. | |
230 | if ((inspect.isfunction(val) or inspect.isclass(val) or |
|
244 | if ((inspect.isfunction(val) or inspect.isclass(val) or | |
231 | inspect.ismethod(val) or |
|
245 | inspect.ismethod(val) or | |
232 | isinstance(val, property)) and |
|
246 | isinstance(val, property)) and | |
233 | self._from_module(module, val)): |
|
247 | self._from_module(module, val)): | |
234 | valname = '%s.%s' % (name, valname) |
|
248 | valname = '%s.%s' % (name, valname) | |
235 | self._find(tests, val, valname, module, source_lines, |
|
249 | self._find(tests, val, valname, module, source_lines, | |
236 | globs, seen) |
|
250 | globs, seen) | |
237 |
|
251 | |||
238 |
|
252 | |||
239 | class IPDoctestOutputChecker(doctest.OutputChecker): |
|
253 | class IPDoctestOutputChecker(doctest.OutputChecker): | |
240 | """Second-chance checker with support for random tests. |
|
254 | """Second-chance checker with support for random tests. | |
241 |
|
255 | |||
242 | If the default comparison doesn't pass, this checker looks in the expected |
|
256 | If the default comparison doesn't pass, this checker looks in the expected | |
243 | output string for flags that tell us to ignore the output. |
|
257 | output string for flags that tell us to ignore the output. | |
244 | """ |
|
258 | """ | |
245 |
|
259 | |||
246 | random_re = re.compile(r'#\s*random') |
|
260 | random_re = re.compile(r'#\s*random') | |
247 |
|
261 | |||
248 | def check_output(self, want, got, optionflags): |
|
262 | def check_output(self, want, got, optionflags): | |
249 | """Check output, accepting special markers embedded in the output. |
|
263 | """Check output, accepting special markers embedded in the output. | |
250 |
|
264 | |||
251 | If the output didn't pass the default validation but the special string |
|
265 | If the output didn't pass the default validation but the special string | |
252 | '#random' is included, we accept it.""" |
|
266 | '#random' is included, we accept it.""" | |
253 |
|
267 | |||
254 | # Let the original tester verify first, in case people have valid tests |
|
268 | # Let the original tester verify first, in case people have valid tests | |
255 | # that happen to have a comment saying '#random' embedded in. |
|
269 | # that happen to have a comment saying '#random' embedded in. | |
256 | ret = doctest.OutputChecker.check_output(self, want, got, |
|
270 | ret = doctest.OutputChecker.check_output(self, want, got, | |
257 | optionflags) |
|
271 | optionflags) | |
258 | if not ret and self.random_re.search(want): |
|
272 | if not ret and self.random_re.search(want): | |
259 | #print >> sys.stderr, 'RANDOM OK:',want # dbg |
|
273 | #print >> sys.stderr, 'RANDOM OK:',want # dbg | |
260 | return True |
|
274 | return True | |
261 |
|
275 | |||
262 | return ret |
|
276 | return ret | |
263 |
|
277 | |||
264 |
|
278 | |||
265 | class DocTestCase(doctests.DocTestCase): |
|
279 | class DocTestCase(doctests.DocTestCase): | |
266 | """Proxy for DocTestCase: provides an address() method that |
|
280 | """Proxy for DocTestCase: provides an address() method that | |
267 | returns the correct address for the doctest case. Otherwise |
|
281 | returns the correct address for the doctest case. Otherwise | |
268 | acts as a proxy to the test case. To provide hints for address(), |
|
282 | acts as a proxy to the test case. To provide hints for address(), | |
269 | an obj may also be passed -- this will be used as the test object |
|
283 | an obj may also be passed -- this will be used as the test object | |
270 | for purposes of determining the test address, if it is provided. |
|
284 | for purposes of determining the test address, if it is provided. | |
271 | """ |
|
285 | """ | |
272 |
|
286 | |||
273 | # Note: this method was taken from numpy's nosetester module. |
|
287 | # Note: this method was taken from numpy's nosetester module. | |
274 |
|
288 | |||
275 | # Subclass nose.plugins.doctests.DocTestCase to work around a bug in |
|
289 | # Subclass nose.plugins.doctests.DocTestCase to work around a bug in | |
276 | # its constructor that blocks non-default arguments from being passed |
|
290 | # its constructor that blocks non-default arguments from being passed | |
277 | # down into doctest.DocTestCase |
|
291 | # down into doctest.DocTestCase | |
278 |
|
292 | |||
279 | def __init__(self, test, optionflags=0, setUp=None, tearDown=None, |
|
293 | def __init__(self, test, optionflags=0, setUp=None, tearDown=None, | |
280 | checker=None, obj=None, result_var='_'): |
|
294 | checker=None, obj=None, result_var='_'): | |
281 | self._result_var = result_var |
|
295 | self._result_var = result_var | |
282 | doctests.DocTestCase.__init__(self, test, |
|
296 | doctests.DocTestCase.__init__(self, test, | |
283 | optionflags=optionflags, |
|
297 | optionflags=optionflags, | |
284 | setUp=setUp, tearDown=tearDown, |
|
298 | setUp=setUp, tearDown=tearDown, | |
285 | checker=checker) |
|
299 | checker=checker) | |
286 | # Now we must actually copy the original constructor from the stdlib |
|
300 | # Now we must actually copy the original constructor from the stdlib | |
287 | # doctest class, because we can't call it directly and a bug in nose |
|
301 | # doctest class, because we can't call it directly and a bug in nose | |
288 | # means it never gets passed the right arguments. |
|
302 | # means it never gets passed the right arguments. | |
289 |
|
303 | |||
290 | self._dt_optionflags = optionflags |
|
304 | self._dt_optionflags = optionflags | |
291 | self._dt_checker = checker |
|
305 | self._dt_checker = checker | |
292 | self._dt_test = test |
|
306 | self._dt_test = test | |
293 | self._dt_setUp = setUp |
|
307 | self._dt_setUp = setUp | |
294 | self._dt_tearDown = tearDown |
|
308 | self._dt_tearDown = tearDown | |
295 |
|
309 | |||
296 | # Each doctest should remember what directory it was loaded from... |
|
310 | # Each doctest should remember what directory it was loaded from... | |
297 | self._ori_dir = os.getcwd() |
|
311 | self._ori_dir = os.getcwd() | |
298 |
|
312 | |||
299 | # Modified runTest from the default stdlib |
|
313 | # Modified runTest from the default stdlib | |
300 | def runTest(self): |
|
314 | def runTest(self): | |
301 | test = self._dt_test |
|
315 | test = self._dt_test | |
302 | old = sys.stdout |
|
316 | old = sys.stdout | |
303 | new = StringIO() |
|
317 | new = StringIO() | |
304 | optionflags = self._dt_optionflags |
|
318 | optionflags = self._dt_optionflags | |
305 |
|
319 | |||
306 | if not (optionflags & REPORTING_FLAGS): |
|
320 | if not (optionflags & REPORTING_FLAGS): | |
307 | # The option flags don't include any reporting flags, |
|
321 | # The option flags don't include any reporting flags, | |
308 | # so add the default reporting flags |
|
322 | # so add the default reporting flags | |
309 | optionflags |= _unittest_reportflags |
|
323 | optionflags |= _unittest_reportflags | |
310 |
|
324 | |||
311 | runner = IPDocTestRunner(optionflags=optionflags, |
|
325 | runner = IPDocTestRunner(optionflags=optionflags, | |
312 | checker=self._dt_checker, verbose=False) |
|
326 | checker=self._dt_checker, verbose=False) | |
313 |
|
327 | |||
314 | try: |
|
328 | try: | |
315 | # Save our current directory and switch out to the one where the |
|
329 | # Save our current directory and switch out to the one where the | |
316 | # test was originally created, in case another doctest did a |
|
330 | # test was originally created, in case another doctest did a | |
317 | # directory change. We'll restore this in the finally clause. |
|
331 | # directory change. We'll restore this in the finally clause. | |
318 | curdir = os.getcwd() |
|
332 | curdir = os.getcwd() | |
319 | os.chdir(self._ori_dir) |
|
333 | os.chdir(self._ori_dir) | |
320 |
|
334 | |||
321 | runner.DIVIDER = "-"*70 |
|
335 | runner.DIVIDER = "-"*70 | |
322 | failures, tries = runner.run( |
|
336 | failures, tries = runner.run( | |
323 | test, out=new.write, clear_globs=False) |
|
337 | test, out=new.write, clear_globs=False) | |
324 | finally: |
|
338 | finally: | |
325 | sys.stdout = old |
|
339 | sys.stdout = old | |
326 | os.chdir(curdir) |
|
340 | os.chdir(curdir) | |
327 |
|
341 | |||
328 | if failures: |
|
342 | if failures: | |
329 | raise self.failureException(self.format_failure(new.getvalue())) |
|
343 | raise self.failureException(self.format_failure(new.getvalue())) | |
330 |
|
344 | |||
331 |
|
345 | |||
332 | # A simple subclassing of the original with a different class name, so we can |
|
346 | # A simple subclassing of the original with a different class name, so we can | |
333 | # distinguish and treat differently IPython examples from pure python ones. |
|
347 | # distinguish and treat differently IPython examples from pure python ones. | |
334 | class IPExample(doctest.Example): pass |
|
348 | class IPExample(doctest.Example): pass | |
335 |
|
349 | |||
336 |
|
350 | |||
337 | class IPExternalExample(doctest.Example): |
|
351 | class IPExternalExample(doctest.Example): | |
338 | """Doctest examples to be run in an external process.""" |
|
352 | """Doctest examples to be run in an external process.""" | |
339 |
|
353 | |||
340 | def __init__(self, source, want, exc_msg=None, lineno=0, indent=0, |
|
354 | def __init__(self, source, want, exc_msg=None, lineno=0, indent=0, | |
341 | options=None): |
|
355 | options=None): | |
342 | # Parent constructor |
|
356 | # Parent constructor | |
343 | doctest.Example.__init__(self,source,want,exc_msg,lineno,indent,options) |
|
357 | doctest.Example.__init__(self,source,want,exc_msg,lineno,indent,options) | |
344 |
|
358 | |||
345 | # An EXTRA newline is needed to prevent pexpect hangs |
|
359 | # An EXTRA newline is needed to prevent pexpect hangs | |
346 | self.source += '\n' |
|
360 | self.source += '\n' | |
347 |
|
361 | |||
348 |
|
362 | |||
349 | class IPDocTestParser(doctest.DocTestParser): |
|
363 | class IPDocTestParser(doctest.DocTestParser): | |
350 | """ |
|
364 | """ | |
351 | A class used to parse strings containing doctest examples. |
|
365 | A class used to parse strings containing doctest examples. | |
352 |
|
366 | |||
353 | Note: This is a version modified to properly recognize IPython input and |
|
367 | Note: This is a version modified to properly recognize IPython input and | |
354 | convert any IPython examples into valid Python ones. |
|
368 | convert any IPython examples into valid Python ones. | |
355 | """ |
|
369 | """ | |
356 | # This regular expression is used to find doctest examples in a |
|
370 | # This regular expression is used to find doctest examples in a | |
357 | # string. It defines three groups: `source` is the source code |
|
371 | # string. It defines three groups: `source` is the source code | |
358 | # (including leading indentation and prompts); `indent` is the |
|
372 | # (including leading indentation and prompts); `indent` is the | |
359 | # indentation of the first (PS1) line of the source code; and |
|
373 | # indentation of the first (PS1) line of the source code; and | |
360 | # `want` is the expected output (including leading indentation). |
|
374 | # `want` is the expected output (including leading indentation). | |
361 |
|
375 | |||
362 | # Classic Python prompts or default IPython ones |
|
376 | # Classic Python prompts or default IPython ones | |
363 | _PS1_PY = r'>>>' |
|
377 | _PS1_PY = r'>>>' | |
364 | _PS2_PY = r'\.\.\.' |
|
378 | _PS2_PY = r'\.\.\.' | |
365 |
|
379 | |||
366 | _PS1_IP = r'In\ \[\d+\]:' |
|
380 | _PS1_IP = r'In\ \[\d+\]:' | |
367 | _PS2_IP = r'\ \ \ \.\.\.+:' |
|
381 | _PS2_IP = r'\ \ \ \.\.\.+:' | |
368 |
|
382 | |||
369 | _RE_TPL = r''' |
|
383 | _RE_TPL = r''' | |
370 | # Source consists of a PS1 line followed by zero or more PS2 lines. |
|
384 | # Source consists of a PS1 line followed by zero or more PS2 lines. | |
371 | (?P<source> |
|
385 | (?P<source> | |
372 | (?:^(?P<indent> [ ]*) (?P<ps1> %s) .*) # PS1 line |
|
386 | (?:^(?P<indent> [ ]*) (?P<ps1> %s) .*) # PS1 line | |
373 | (?:\n [ ]* (?P<ps2> %s) .*)*) # PS2 lines |
|
387 | (?:\n [ ]* (?P<ps2> %s) .*)*) # PS2 lines | |
374 | \n? # a newline |
|
388 | \n? # a newline | |
375 | # Want consists of any non-blank lines that do not start with PS1. |
|
389 | # Want consists of any non-blank lines that do not start with PS1. | |
376 | (?P<want> (?:(?![ ]*$) # Not a blank line |
|
390 | (?P<want> (?:(?![ ]*$) # Not a blank line | |
377 | (?![ ]*%s) # Not a line starting with PS1 |
|
391 | (?![ ]*%s) # Not a line starting with PS1 | |
378 | (?![ ]*%s) # Not a line starting with PS2 |
|
392 | (?![ ]*%s) # Not a line starting with PS2 | |
379 | .*$\n? # But any other line |
|
393 | .*$\n? # But any other line | |
380 | )*) |
|
394 | )*) | |
381 | ''' |
|
395 | ''' | |
382 |
|
396 | |||
383 | _EXAMPLE_RE_PY = re.compile( _RE_TPL % (_PS1_PY,_PS2_PY,_PS1_PY,_PS2_PY), |
|
397 | _EXAMPLE_RE_PY = re.compile( _RE_TPL % (_PS1_PY,_PS2_PY,_PS1_PY,_PS2_PY), | |
384 | re.MULTILINE | re.VERBOSE) |
|
398 | re.MULTILINE | re.VERBOSE) | |
385 |
|
399 | |||
386 | _EXAMPLE_RE_IP = re.compile( _RE_TPL % (_PS1_IP,_PS2_IP,_PS1_IP,_PS2_IP), |
|
400 | _EXAMPLE_RE_IP = re.compile( _RE_TPL % (_PS1_IP,_PS2_IP,_PS1_IP,_PS2_IP), | |
387 | re.MULTILINE | re.VERBOSE) |
|
401 | re.MULTILINE | re.VERBOSE) | |
388 |
|
402 | |||
389 | # Mark a test as being fully random. In this case, we simply append the |
|
403 | # Mark a test as being fully random. In this case, we simply append the | |
390 | # random marker ('#random') to each individual example's output. This way |
|
404 | # random marker ('#random') to each individual example's output. This way | |
391 | # we don't need to modify any other code. |
|
405 | # we don't need to modify any other code. | |
392 | _RANDOM_TEST = re.compile(r'#\s*all-random') |
|
406 | _RANDOM_TEST = re.compile(r'#\s*all-random') | |
393 |
|
407 | |||
394 | # Mark tests to be executed in an external process - currently unsupported. |
|
408 | # Mark tests to be executed in an external process - currently unsupported. | |
395 | _EXTERNAL_IP = re.compile(r'#\s*ipdoctest:\s*EXTERNAL') |
|
409 | _EXTERNAL_IP = re.compile(r'#\s*ipdoctest:\s*EXTERNAL') | |
396 |
|
410 | |||
397 | def ip2py(self,source): |
|
411 | def ip2py(self,source): | |
398 | """Convert input IPython source into valid Python.""" |
|
412 | """Convert input IPython source into valid Python.""" | |
399 | out = [] |
|
413 | out = [] | |
400 | newline = out.append |
|
414 | newline = out.append | |
401 | for lnum,line in enumerate(source.splitlines()): |
|
415 | for lnum,line in enumerate(source.splitlines()): | |
402 | newline(_ip.IP.prefilter(line,lnum>0)) |
|
416 | newline(_ip.IP.prefilter(line,lnum>0)) | |
403 | newline('') # ensure a closing newline, needed by doctest |
|
417 | newline('') # ensure a closing newline, needed by doctest | |
404 | #print "PYSRC:", '\n'.join(out) # dbg |
|
418 | #print "PYSRC:", '\n'.join(out) # dbg | |
405 | return '\n'.join(out) |
|
419 | return '\n'.join(out) | |
406 |
|
420 | |||
407 | def parse(self, string, name='<string>'): |
|
421 | def parse(self, string, name='<string>'): | |
408 | """ |
|
422 | """ | |
409 | Divide the given string into examples and intervening text, |
|
423 | Divide the given string into examples and intervening text, | |
410 | and return them as a list of alternating Examples and strings. |
|
424 | and return them as a list of alternating Examples and strings. | |
411 | Line numbers for the Examples are 0-based. The optional |
|
425 | Line numbers for the Examples are 0-based. The optional | |
412 | argument `name` is a name identifying this string, and is only |
|
426 | argument `name` is a name identifying this string, and is only | |
413 | used for error messages. |
|
427 | used for error messages. | |
414 | """ |
|
428 | """ | |
415 |
|
429 | |||
416 | #print 'Parse string:\n',string # dbg |
|
430 | #print 'Parse string:\n',string # dbg | |
417 |
|
431 | |||
418 | string = string.expandtabs() |
|
432 | string = string.expandtabs() | |
419 | # If all lines begin with the same indentation, then strip it. |
|
433 | # If all lines begin with the same indentation, then strip it. | |
420 | min_indent = self._min_indent(string) |
|
434 | min_indent = self._min_indent(string) | |
421 | if min_indent > 0: |
|
435 | if min_indent > 0: | |
422 | string = '\n'.join([l[min_indent:] for l in string.split('\n')]) |
|
436 | string = '\n'.join([l[min_indent:] for l in string.split('\n')]) | |
423 |
|
437 | |||
424 | output = [] |
|
438 | output = [] | |
425 | charno, lineno = 0, 0 |
|
439 | charno, lineno = 0, 0 | |
426 |
|
440 | |||
427 | if self._RANDOM_TEST.search(string): |
|
441 | if self._RANDOM_TEST.search(string): | |
428 | random_marker = '\n# random' |
|
442 | random_marker = '\n# random' | |
429 | else: |
|
443 | else: | |
430 | random_marker = '' |
|
444 | random_marker = '' | |
431 |
|
445 | |||
432 | # Whether to convert the input from ipython to python syntax |
|
446 | # Whether to convert the input from ipython to python syntax | |
433 | ip2py = False |
|
447 | ip2py = False | |
434 | # Find all doctest examples in the string. First, try them as Python |
|
448 | # Find all doctest examples in the string. First, try them as Python | |
435 | # examples, then as IPython ones |
|
449 | # examples, then as IPython ones | |
436 | terms = list(self._EXAMPLE_RE_PY.finditer(string)) |
|
450 | terms = list(self._EXAMPLE_RE_PY.finditer(string)) | |
437 | if terms: |
|
451 | if terms: | |
438 | # Normal Python example |
|
452 | # Normal Python example | |
439 | #print '-'*70 # dbg |
|
453 | #print '-'*70 # dbg | |
440 | #print 'PyExample, Source:\n',string # dbg |
|
454 | #print 'PyExample, Source:\n',string # dbg | |
441 | #print '-'*70 # dbg |
|
455 | #print '-'*70 # dbg | |
442 | Example = doctest.Example |
|
456 | Example = doctest.Example | |
443 | else: |
|
457 | else: | |
444 | # It's an ipython example. Note that IPExamples are run |
|
458 | # It's an ipython example. Note that IPExamples are run | |
445 | # in-process, so their syntax must be turned into valid python. |
|
459 | # in-process, so their syntax must be turned into valid python. | |
446 | # IPExternalExamples are run out-of-process (via pexpect) so they |
|
460 | # IPExternalExamples are run out-of-process (via pexpect) so they | |
447 | # don't need any filtering (a real ipython will be executing them). |
|
461 | # don't need any filtering (a real ipython will be executing them). | |
448 | terms = list(self._EXAMPLE_RE_IP.finditer(string)) |
|
462 | terms = list(self._EXAMPLE_RE_IP.finditer(string)) | |
449 | if self._EXTERNAL_IP.search(string): |
|
463 | if self._EXTERNAL_IP.search(string): | |
450 | #print '-'*70 # dbg |
|
464 | #print '-'*70 # dbg | |
451 | #print 'IPExternalExample, Source:\n',string # dbg |
|
465 | #print 'IPExternalExample, Source:\n',string # dbg | |
452 | #print '-'*70 # dbg |
|
466 | #print '-'*70 # dbg | |
453 | Example = IPExternalExample |
|
467 | Example = IPExternalExample | |
454 | else: |
|
468 | else: | |
455 | #print '-'*70 # dbg |
|
469 | #print '-'*70 # dbg | |
456 | #print 'IPExample, Source:\n',string # dbg |
|
470 | #print 'IPExample, Source:\n',string # dbg | |
457 | #print '-'*70 # dbg |
|
471 | #print '-'*70 # dbg | |
458 | Example = IPExample |
|
472 | Example = IPExample | |
459 | ip2py = True |
|
473 | ip2py = True | |
460 |
|
474 | |||
461 | for m in terms: |
|
475 | for m in terms: | |
462 | # Add the pre-example text to `output`. |
|
476 | # Add the pre-example text to `output`. | |
463 | output.append(string[charno:m.start()]) |
|
477 | output.append(string[charno:m.start()]) | |
464 | # Update lineno (lines before this example) |
|
478 | # Update lineno (lines before this example) | |
465 | lineno += string.count('\n', charno, m.start()) |
|
479 | lineno += string.count('\n', charno, m.start()) | |
466 | # Extract info from the regexp match. |
|
480 | # Extract info from the regexp match. | |
467 | (source, options, want, exc_msg) = \ |
|
481 | (source, options, want, exc_msg) = \ | |
468 | self._parse_example(m, name, lineno,ip2py) |
|
482 | self._parse_example(m, name, lineno,ip2py) | |
469 |
|
483 | |||
470 | # Append the random-output marker (it defaults to empty in most |
|
484 | # Append the random-output marker (it defaults to empty in most | |
471 | # cases, it's only non-empty for 'all-random' tests): |
|
485 | # cases, it's only non-empty for 'all-random' tests): | |
472 | want += random_marker |
|
486 | want += random_marker | |
473 |
|
487 | |||
474 | if Example is IPExternalExample: |
|
488 | if Example is IPExternalExample: | |
475 | options[doctest.NORMALIZE_WHITESPACE] = True |
|
489 | options[doctest.NORMALIZE_WHITESPACE] = True | |
476 | want += '\n' |
|
490 | want += '\n' | |
477 |
|
491 | |||
478 | # Create an Example, and add it to the list. |
|
492 | # Create an Example, and add it to the list. | |
479 | if not self._IS_BLANK_OR_COMMENT(source): |
|
493 | if not self._IS_BLANK_OR_COMMENT(source): | |
480 | output.append(Example(source, want, exc_msg, |
|
494 | output.append(Example(source, want, exc_msg, | |
481 | lineno=lineno, |
|
495 | lineno=lineno, | |
482 | indent=min_indent+len(m.group('indent')), |
|
496 | indent=min_indent+len(m.group('indent')), | |
483 | options=options)) |
|
497 | options=options)) | |
484 | # Update lineno (lines inside this example) |
|
498 | # Update lineno (lines inside this example) | |
485 | lineno += string.count('\n', m.start(), m.end()) |
|
499 | lineno += string.count('\n', m.start(), m.end()) | |
486 | # Update charno. |
|
500 | # Update charno. | |
487 | charno = m.end() |
|
501 | charno = m.end() | |
488 | # Add any remaining post-example text to `output`. |
|
502 | # Add any remaining post-example text to `output`. | |
489 | output.append(string[charno:]) |
|
503 | output.append(string[charno:]) | |
490 | return output |
|
504 | return output | |
491 |
|
505 | |||
492 | def _parse_example(self, m, name, lineno,ip2py=False): |
|
506 | def _parse_example(self, m, name, lineno,ip2py=False): | |
493 | """ |
|
507 | """ | |
494 | Given a regular expression match from `_EXAMPLE_RE` (`m`), |
|
508 | Given a regular expression match from `_EXAMPLE_RE` (`m`), | |
495 | return a pair `(source, want)`, where `source` is the matched |
|
509 | return a pair `(source, want)`, where `source` is the matched | |
496 | example's source code (with prompts and indentation stripped); |
|
510 | example's source code (with prompts and indentation stripped); | |
497 | and `want` is the example's expected output (with indentation |
|
511 | and `want` is the example's expected output (with indentation | |
498 | stripped). |
|
512 | stripped). | |
499 |
|
513 | |||
500 | `name` is the string's name, and `lineno` is the line number |
|
514 | `name` is the string's name, and `lineno` is the line number | |
501 | where the example starts; both are used for error messages. |
|
515 | where the example starts; both are used for error messages. | |
502 |
|
516 | |||
503 | Optional: |
|
517 | Optional: | |
504 | `ip2py`: if true, filter the input via IPython to convert the syntax |
|
518 | `ip2py`: if true, filter the input via IPython to convert the syntax | |
505 | into valid python. |
|
519 | into valid python. | |
506 | """ |
|
520 | """ | |
507 |
|
521 | |||
508 | # Get the example's indentation level. |
|
522 | # Get the example's indentation level. | |
509 | indent = len(m.group('indent')) |
|
523 | indent = len(m.group('indent')) | |
510 |
|
524 | |||
511 | # Divide source into lines; check that they're properly |
|
525 | # Divide source into lines; check that they're properly | |
512 | # indented; and then strip their indentation & prompts. |
|
526 | # indented; and then strip their indentation & prompts. | |
513 | source_lines = m.group('source').split('\n') |
|
527 | source_lines = m.group('source').split('\n') | |
514 |
|
528 | |||
515 | # We're using variable-length input prompts |
|
529 | # We're using variable-length input prompts | |
516 | ps1 = m.group('ps1') |
|
530 | ps1 = m.group('ps1') | |
517 | ps2 = m.group('ps2') |
|
531 | ps2 = m.group('ps2') | |
518 | ps1_len = len(ps1) |
|
532 | ps1_len = len(ps1) | |
519 |
|
533 | |||
520 | self._check_prompt_blank(source_lines, indent, name, lineno,ps1_len) |
|
534 | self._check_prompt_blank(source_lines, indent, name, lineno,ps1_len) | |
521 | if ps2: |
|
535 | if ps2: | |
522 | self._check_prefix(source_lines[1:], ' '*indent + ps2, name, lineno) |
|
536 | self._check_prefix(source_lines[1:], ' '*indent + ps2, name, lineno) | |
523 |
|
537 | |||
524 | source = '\n'.join([sl[indent+ps1_len+1:] for sl in source_lines]) |
|
538 | source = '\n'.join([sl[indent+ps1_len+1:] for sl in source_lines]) | |
525 |
|
539 | |||
526 | if ip2py: |
|
540 | if ip2py: | |
527 | # Convert source input from IPython into valid Python syntax |
|
541 | # Convert source input from IPython into valid Python syntax | |
528 | source = self.ip2py(source) |
|
542 | source = self.ip2py(source) | |
529 |
|
543 | |||
530 | # Divide want into lines; check that it's properly indented; and |
|
544 | # Divide want into lines; check that it's properly indented; and | |
531 | # then strip the indentation. Spaces before the last newline should |
|
545 | # then strip the indentation. Spaces before the last newline should | |
532 | # be preserved, so plain rstrip() isn't good enough. |
|
546 | # be preserved, so plain rstrip() isn't good enough. | |
533 | want = m.group('want') |
|
547 | want = m.group('want') | |
534 | want_lines = want.split('\n') |
|
548 | want_lines = want.split('\n') | |
535 | if len(want_lines) > 1 and re.match(r' *$', want_lines[-1]): |
|
549 | if len(want_lines) > 1 and re.match(r' *$', want_lines[-1]): | |
536 | del want_lines[-1] # forget final newline & spaces after it |
|
550 | del want_lines[-1] # forget final newline & spaces after it | |
537 | self._check_prefix(want_lines, ' '*indent, name, |
|
551 | self._check_prefix(want_lines, ' '*indent, name, | |
538 | lineno + len(source_lines)) |
|
552 | lineno + len(source_lines)) | |
539 |
|
553 | |||
540 | # Remove ipython output prompt that might be present in the first line |
|
554 | # Remove ipython output prompt that might be present in the first line | |
541 | want_lines[0] = re.sub(r'Out\[\d+\]: \s*?\n?','',want_lines[0]) |
|
555 | want_lines[0] = re.sub(r'Out\[\d+\]: \s*?\n?','',want_lines[0]) | |
542 |
|
556 | |||
543 | want = '\n'.join([wl[indent:] for wl in want_lines]) |
|
557 | want = '\n'.join([wl[indent:] for wl in want_lines]) | |
544 |
|
558 | |||
545 | # If `want` contains a traceback message, then extract it. |
|
559 | # If `want` contains a traceback message, then extract it. | |
546 | m = self._EXCEPTION_RE.match(want) |
|
560 | m = self._EXCEPTION_RE.match(want) | |
547 | if m: |
|
561 | if m: | |
548 | exc_msg = m.group('msg') |
|
562 | exc_msg = m.group('msg') | |
549 | else: |
|
563 | else: | |
550 | exc_msg = None |
|
564 | exc_msg = None | |
551 |
|
565 | |||
552 | # Extract options from the source. |
|
566 | # Extract options from the source. | |
553 | options = self._find_options(source, name, lineno) |
|
567 | options = self._find_options(source, name, lineno) | |
554 |
|
568 | |||
555 | return source, options, want, exc_msg |
|
569 | return source, options, want, exc_msg | |
556 |
|
570 | |||
557 | def _check_prompt_blank(self, lines, indent, name, lineno, ps1_len): |
|
571 | def _check_prompt_blank(self, lines, indent, name, lineno, ps1_len): | |
558 | """ |
|
572 | """ | |
559 | Given the lines of a source string (including prompts and |
|
573 | Given the lines of a source string (including prompts and | |
560 | leading indentation), check to make sure that every prompt is |
|
574 | leading indentation), check to make sure that every prompt is | |
561 | followed by a space character. If any line is not followed by |
|
575 | followed by a space character. If any line is not followed by | |
562 | a space character, then raise ValueError. |
|
576 | a space character, then raise ValueError. | |
563 |
|
577 | |||
564 | Note: IPython-modified version which takes the input prompt length as a |
|
578 | Note: IPython-modified version which takes the input prompt length as a | |
565 | parameter, so that prompts of variable length can be dealt with. |
|
579 | parameter, so that prompts of variable length can be dealt with. | |
566 | """ |
|
580 | """ | |
567 | space_idx = indent+ps1_len |
|
581 | space_idx = indent+ps1_len | |
568 | min_len = space_idx+1 |
|
582 | min_len = space_idx+1 | |
569 | for i, line in enumerate(lines): |
|
583 | for i, line in enumerate(lines): | |
570 | if len(line) >= min_len and line[space_idx] != ' ': |
|
584 | if len(line) >= min_len and line[space_idx] != ' ': | |
571 | raise ValueError('line %r of the docstring for %s ' |
|
585 | raise ValueError('line %r of the docstring for %s ' | |
572 | 'lacks blank after %s: %r' % |
|
586 | 'lacks blank after %s: %r' % | |
573 | (lineno+i+1, name, |
|
587 | (lineno+i+1, name, | |
574 | line[indent:space_idx], line)) |
|
588 | line[indent:space_idx], line)) | |
575 |
|
589 | |||
576 |
|
590 | |||
577 | SKIP = doctest.register_optionflag('SKIP') |
|
591 | SKIP = doctest.register_optionflag('SKIP') | |
578 |
|
592 | |||
579 |
|
593 | |||
580 | class IPDocTestRunner(doctest.DocTestRunner,object): |
|
594 | class IPDocTestRunner(doctest.DocTestRunner,object): | |
581 | """Test runner that synchronizes the IPython namespace with test globals. |
|
595 | """Test runner that synchronizes the IPython namespace with test globals. | |
582 | """ |
|
596 | """ | |
583 |
|
597 | |||
584 | def run(self, test, compileflags=None, out=None, clear_globs=True): |
|
598 | def run(self, test, compileflags=None, out=None, clear_globs=True): | |
585 |
|
599 | |||
586 | # Hack: ipython needs access to the execution context of the example, |
|
600 | # Hack: ipython needs access to the execution context of the example, | |
587 | # so that it can propagate user variables loaded by %run into |
|
601 | # so that it can propagate user variables loaded by %run into | |
588 | # test.globs. We put them here into our modified %run as a function |
|
602 | # test.globs. We put them here into our modified %run as a function | |
589 | # attribute. Our new %run will then only make the namespace update |
|
603 | # attribute. Our new %run will then only make the namespace update | |
590 | # when called (rather than unconconditionally updating test.globs here |
|
604 | # when called (rather than unconconditionally updating test.globs here | |
591 | # for all examples, most of which won't be calling %run anyway). |
|
605 | # for all examples, most of which won't be calling %run anyway). | |
592 | _run_ns_sync.test_globs = test.globs |
|
606 | _run_ns_sync.test_globs = test.globs | |
593 |
|
607 | |||
|
608 | # dbg | |||
|
609 | ## print >> sys.stderr, "Test:",test | |||
|
610 | ## for ex in test.examples: | |||
|
611 | ## print >> sys.stderr, ex.source | |||
|
612 | ## print >> sys.stderr, 'Want:\n',ex.want,'\n--' | |||
|
613 | ||||
594 | return super(IPDocTestRunner,self).run(test, |
|
614 | return super(IPDocTestRunner,self).run(test, | |
595 | compileflags,out,clear_globs) |
|
615 | compileflags,out,clear_globs) | |
596 |
|
616 | |||
597 |
|
617 | |||
598 | class DocFileCase(doctest.DocFileCase): |
|
618 | class DocFileCase(doctest.DocFileCase): | |
599 | """Overrides to provide filename |
|
619 | """Overrides to provide filename | |
600 | """ |
|
620 | """ | |
601 | def address(self): |
|
621 | def address(self): | |
602 | return (self._dt_test.filename, None, None) |
|
622 | return (self._dt_test.filename, None, None) | |
603 |
|
623 | |||
604 |
|
624 | |||
605 | class ExtensionDoctest(doctests.Doctest): |
|
625 | class ExtensionDoctest(doctests.Doctest): | |
606 | """Nose Plugin that supports doctests in extension modules. |
|
626 | """Nose Plugin that supports doctests in extension modules. | |
607 | """ |
|
627 | """ | |
608 | name = 'extdoctest' # call nosetests with --with-extdoctest |
|
628 | name = 'extdoctest' # call nosetests with --with-extdoctest | |
609 | enabled = True |
|
629 | enabled = True | |
610 |
|
630 | |||
611 | def options(self, parser, env=os.environ): |
|
631 | def options(self, parser, env=os.environ): | |
612 | Plugin.options(self, parser, env) |
|
632 | Plugin.options(self, parser, env) | |
613 |
|
633 | |||
614 | def configure(self, options, config): |
|
634 | def configure(self, options, config): | |
615 | Plugin.configure(self, options, config) |
|
635 | Plugin.configure(self, options, config) | |
616 | self.doctest_tests = options.doctest_tests |
|
636 | self.doctest_tests = options.doctest_tests | |
617 | self.extension = tolist(options.doctestExtension) |
|
637 | self.extension = tolist(options.doctestExtension) | |
618 | self.finder = DocTestFinder() |
|
638 | self.finder = DocTestFinder() | |
619 | self.parser = doctest.DocTestParser() |
|
639 | self.parser = doctest.DocTestParser() | |
620 | self.globs = None |
|
640 | self.globs = None | |
621 | self.extraglobs = None |
|
641 | self.extraglobs = None | |
622 |
|
642 | |||
623 | def loadTestsFromExtensionModule(self,filename): |
|
643 | def loadTestsFromExtensionModule(self,filename): | |
624 | bpath,mod = os.path.split(filename) |
|
644 | bpath,mod = os.path.split(filename) | |
625 | modname = os.path.splitext(mod)[0] |
|
645 | modname = os.path.splitext(mod)[0] | |
626 | try: |
|
646 | try: | |
627 | sys.path.append(bpath) |
|
647 | sys.path.append(bpath) | |
628 | module = __import__(modname) |
|
648 | module = __import__(modname) | |
629 | tests = list(self.loadTestsFromModule(module)) |
|
649 | tests = list(self.loadTestsFromModule(module)) | |
630 | finally: |
|
650 | finally: | |
631 | sys.path.pop() |
|
651 | sys.path.pop() | |
632 | return tests |
|
652 | return tests | |
633 |
|
653 | |||
634 | # NOTE: the method below is almost a copy of the original one in nose, with |
|
654 | # NOTE: the method below is almost a copy of the original one in nose, with | |
635 | # a few modifications to control output checking. |
|
655 | # a few modifications to control output checking. | |
636 |
|
656 | |||
637 | def loadTestsFromModule(self, module): |
|
657 | def loadTestsFromModule(self, module): | |
638 | #print 'lTM',module # dbg |
|
658 | #print 'lTM',module # dbg | |
639 |
|
659 | |||
640 | if not self.matches(module.__name__): |
|
660 | if not self.matches(module.__name__): | |
641 | log.debug("Doctest doesn't want module %s", module) |
|
661 | log.debug("Doctest doesn't want module %s", module) | |
642 | return |
|
662 | return | |
643 |
|
663 | |||
644 | tests = self.finder.find(module,globs=self.globs, |
|
664 | tests = self.finder.find(module,globs=self.globs, | |
645 | extraglobs=self.extraglobs) |
|
665 | extraglobs=self.extraglobs) | |
646 | if not tests: |
|
666 | if not tests: | |
647 | return |
|
667 | return | |
648 |
|
668 | |||
649 | tests.sort() |
|
669 | tests.sort() | |
650 | module_file = module.__file__ |
|
670 | module_file = module.__file__ | |
651 | if module_file[-4:] in ('.pyc', '.pyo'): |
|
671 | if module_file[-4:] in ('.pyc', '.pyo'): | |
652 | module_file = module_file[:-1] |
|
672 | module_file = module_file[:-1] | |
653 | for test in tests: |
|
673 | for test in tests: | |
654 | if not test.examples: |
|
674 | if not test.examples: | |
655 | continue |
|
675 | continue | |
656 | if not test.filename: |
|
676 | if not test.filename: | |
657 | test.filename = module_file |
|
677 | test.filename = module_file | |
658 |
|
678 | |||
659 | # xxx - checker and options may be ok instantiated once outside loop |
|
679 | # xxx - checker and options may be ok instantiated once outside loop | |
660 | # always use whitespace and ellipsis options |
|
680 | # always use whitespace and ellipsis options | |
661 | optionflags = doctest.NORMALIZE_WHITESPACE | doctest.ELLIPSIS |
|
681 | optionflags = doctest.NORMALIZE_WHITESPACE | doctest.ELLIPSIS | |
662 | checker = IPDoctestOutputChecker() |
|
682 | checker = IPDoctestOutputChecker() | |
663 |
|
683 | |||
664 | yield DocTestCase(test, |
|
684 | yield DocTestCase(test, | |
665 | optionflags=optionflags, |
|
685 | optionflags=optionflags, | |
666 | checker=checker) |
|
686 | checker=checker) | |
667 |
|
687 | |||
668 | def loadTestsFromFile(self, filename): |
|
688 | def loadTestsFromFile(self, filename): | |
669 | #print 'lTF',filename # dbg |
|
689 | #print 'lTF',filename # dbg | |
670 |
|
690 | |||
671 | if is_extension_module(filename): |
|
691 | if is_extension_module(filename): | |
672 | for t in self.loadTestsFromExtensionModule(filename): |
|
692 | for t in self.loadTestsFromExtensionModule(filename): | |
673 | yield t |
|
693 | yield t | |
674 | else: |
|
694 | else: | |
675 | if self.extension and anyp(filename.endswith, self.extension): |
|
695 | if self.extension and anyp(filename.endswith, self.extension): | |
676 | name = os.path.basename(filename) |
|
696 | name = os.path.basename(filename) | |
677 | dh = open(filename) |
|
697 | dh = open(filename) | |
678 | try: |
|
698 | try: | |
679 | doc = dh.read() |
|
699 | doc = dh.read() | |
680 | finally: |
|
700 | finally: | |
681 | dh.close() |
|
701 | dh.close() | |
682 | test = self.parser.get_doctest( |
|
702 | test = self.parser.get_doctest( | |
683 | doc, globs={'__file__': filename}, name=name, |
|
703 | doc, globs={'__file__': filename}, name=name, | |
684 | filename=filename, lineno=0) |
|
704 | filename=filename, lineno=0) | |
685 | if test.examples: |
|
705 | if test.examples: | |
686 | #print 'FileCase:',test.examples # dbg |
|
706 | #print 'FileCase:',test.examples # dbg | |
687 | yield DocFileCase(test) |
|
707 | yield DocFileCase(test) | |
688 | else: |
|
708 | else: | |
689 | yield False # no tests to load |
|
709 | yield False # no tests to load | |
690 |
|
710 | |||
691 | def wantFile(self,filename): |
|
711 | def wantFile(self,filename): | |
692 | """Return whether the given filename should be scanned for tests. |
|
712 | """Return whether the given filename should be scanned for tests. | |
693 |
|
713 | |||
694 | Modified version that accepts extension modules as valid containers for |
|
714 | Modified version that accepts extension modules as valid containers for | |
695 | doctests. |
|
715 | doctests. | |
696 | """ |
|
716 | """ | |
697 | #print 'Filename:',filename # dbg |
|
717 | #print 'Filename:',filename # dbg | |
698 |
|
718 | |||
699 | # temporarily hardcoded list, will move to driver later |
|
719 | # temporarily hardcoded list, will move to driver later | |
700 | exclude = ['IPython/external/', |
|
720 | exclude = ['IPython/external/', | |
701 | 'IPython/Extensions/ipy_', |
|
721 | 'IPython/Extensions/ipy_', | |
702 | 'IPython/platutils_win32', |
|
722 | 'IPython/platutils_win32', | |
703 | 'IPython/frontend/cocoa', |
|
723 | 'IPython/frontend/cocoa', | |
704 | 'IPython_doctest_plugin', |
|
724 | 'IPython_doctest_plugin', | |
705 | 'IPython/Gnuplot', |
|
725 | 'IPython/Gnuplot', | |
706 | 'IPython/Extensions/PhysicalQIn'] |
|
726 | 'IPython/Extensions/PhysicalQIn'] | |
707 |
|
727 | |||
708 | for fex in exclude: |
|
728 | for fex in exclude: | |
709 | if fex in filename: # substring |
|
729 | if fex in filename: # substring | |
710 | #print '###>>> SKIP:',filename # dbg |
|
730 | #print '###>>> SKIP:',filename # dbg | |
711 | return False |
|
731 | return False | |
712 |
|
732 | |||
713 | if is_extension_module(filename): |
|
733 | if is_extension_module(filename): | |
714 | return True |
|
734 | return True | |
715 | else: |
|
735 | else: | |
716 | return doctests.Doctest.wantFile(self,filename) |
|
736 | return doctests.Doctest.wantFile(self,filename) | |
717 |
|
737 | |||
718 |
|
738 | |||
719 | class IPythonDoctest(ExtensionDoctest): |
|
739 | class IPythonDoctest(ExtensionDoctest): | |
720 | """Nose Plugin that supports doctests in extension modules. |
|
740 | """Nose Plugin that supports doctests in extension modules. | |
721 | """ |
|
741 | """ | |
722 | name = 'ipdoctest' # call nosetests with --with-ipdoctest |
|
742 | name = 'ipdoctest' # call nosetests with --with-ipdoctest | |
723 | enabled = True |
|
743 | enabled = True | |
724 |
|
744 | |||
725 | def configure(self, options, config): |
|
745 | def configure(self, options, config): | |
726 |
|
746 | |||
727 | Plugin.configure(self, options, config) |
|
747 | Plugin.configure(self, options, config) | |
728 | self.doctest_tests = options.doctest_tests |
|
748 | self.doctest_tests = options.doctest_tests | |
729 | self.extension = tolist(options.doctestExtension) |
|
749 | self.extension = tolist(options.doctestExtension) | |
730 | self.parser = IPDocTestParser() |
|
750 | self.parser = IPDocTestParser() | |
731 | self.finder = DocTestFinder(parser=self.parser) |
|
751 | self.finder = DocTestFinder(parser=self.parser) | |
732 | self.globs = None |
|
752 | self.globs = None | |
733 | self.extraglobs = None |
|
753 | self.extraglobs = None |
@@ -1,122 +1,180 b'' | |||||
1 | # Module imports |
|
1 | # Module imports | |
2 | # Std lib |
|
2 | # Std lib | |
3 | import inspect |
|
3 | import inspect | |
4 |
|
4 | |||
5 | # Third party |
|
5 | # Third party | |
6 |
|
6 | |||
7 | # Our own |
|
7 | # Our own | |
8 | import decorators as dec |
|
8 | from IPython.testing import decorators as dec | |
9 |
|
9 | |||
10 | #----------------------------------------------------------------------------- |
|
10 | #----------------------------------------------------------------------------- | |
11 | # Utilities |
|
11 | # Utilities | |
12 |
|
12 | |||
13 | # Note: copied from OInspect, kept here so the testing stuff doesn't create |
|
13 | # Note: copied from OInspect, kept here so the testing stuff doesn't create | |
14 | # circular dependencies and is easier to reuse. |
|
14 | # circular dependencies and is easier to reuse. | |
15 | def getargspec(obj): |
|
15 | def getargspec(obj): | |
16 | """Get the names and default values of a function's arguments. |
|
16 | """Get the names and default values of a function's arguments. | |
17 |
|
17 | |||
18 | A tuple of four things is returned: (args, varargs, varkw, defaults). |
|
18 | A tuple of four things is returned: (args, varargs, varkw, defaults). | |
19 | 'args' is a list of the argument names (it may contain nested lists). |
|
19 | 'args' is a list of the argument names (it may contain nested lists). | |
20 | 'varargs' and 'varkw' are the names of the * and ** arguments or None. |
|
20 | 'varargs' and 'varkw' are the names of the * and ** arguments or None. | |
21 | 'defaults' is an n-tuple of the default values of the last n arguments. |
|
21 | 'defaults' is an n-tuple of the default values of the last n arguments. | |
22 |
|
22 | |||
23 | Modified version of inspect.getargspec from the Python Standard |
|
23 | Modified version of inspect.getargspec from the Python Standard | |
24 | Library.""" |
|
24 | Library.""" | |
25 |
|
25 | |||
26 | if inspect.isfunction(obj): |
|
26 | if inspect.isfunction(obj): | |
27 | func_obj = obj |
|
27 | func_obj = obj | |
28 | elif inspect.ismethod(obj): |
|
28 | elif inspect.ismethod(obj): | |
29 | func_obj = obj.im_func |
|
29 | func_obj = obj.im_func | |
30 | else: |
|
30 | else: | |
31 | raise TypeError, 'arg is not a Python function' |
|
31 | raise TypeError, 'arg is not a Python function' | |
32 | args, varargs, varkw = inspect.getargs(func_obj.func_code) |
|
32 | args, varargs, varkw = inspect.getargs(func_obj.func_code) | |
33 | return args, varargs, varkw, func_obj.func_defaults |
|
33 | return args, varargs, varkw, func_obj.func_defaults | |
34 |
|
34 | |||
35 | #----------------------------------------------------------------------------- |
|
35 | #----------------------------------------------------------------------------- | |
36 | # Testing functions |
|
36 | # Testing functions | |
37 |
|
37 | |||
38 | def test_trivial(): |
|
38 | def test_trivial(): | |
39 | """A trivial passing test.""" |
|
39 | """A trivial passing test.""" | |
40 | pass |
|
40 | pass | |
41 |
|
41 | |||
42 |
|
42 | |||
43 | @dec.skip |
|
43 | @dec.skip | |
44 | def test_deliberately_broken(): |
|
44 | def test_deliberately_broken(): | |
45 | """A deliberately broken test - we want to skip this one.""" |
|
45 | """A deliberately broken test - we want to skip this one.""" | |
46 | 1/0 |
|
46 | 1/0 | |
47 |
|
47 | |||
48 |
|
48 | |||
49 | # Verify that we can correctly skip the doctest for a function at will, but |
|
49 | # Verify that we can correctly skip the doctest for a function at will, but | |
50 | # that the docstring itself is NOT destroyed by the decorator. |
|
50 | # that the docstring itself is NOT destroyed by the decorator. | |
51 | @dec.skip_doctest |
|
51 | @dec.skip_doctest | |
52 | def doctest_bad(x,y=1,**k): |
|
52 | def doctest_bad(x,y=1,**k): | |
53 | """A function whose doctest we need to skip. |
|
53 | """A function whose doctest we need to skip. | |
54 |
|
54 | |||
55 | >>> 1+1 |
|
55 | >>> 1+1 | |
56 | 3 |
|
56 | 3 | |
57 | """ |
|
57 | """ | |
58 | z=2 |
|
58 | print 'x:',x | |
|
59 | print 'y:',y | |||
|
60 | print 'k:',k | |||
|
61 | ||||
|
62 | ||||
|
63 | def call_doctest_bad(): | |||
|
64 | """Check that we can still call the decorated functions. | |||
|
65 | ||||
|
66 | >>> doctest_bad(3,y=4) | |||
|
67 | x: 3 | |||
|
68 | y: 4 | |||
|
69 | k: {} | |||
|
70 | """ | |||
|
71 | pass | |||
|
72 | ||||
|
73 | ||||
|
74 | # Doctest skipping should work for class methods too | |||
|
75 | class foo(object): | |||
|
76 | """Foo | |||
|
77 | ||||
|
78 | Example: | |||
|
79 | ||||
|
80 | >>> 1+1 | |||
|
81 | 2 | |||
|
82 | """ | |||
|
83 | ||||
|
84 | @dec.skip_doctest | |||
|
85 | def __init__(self,x): | |||
|
86 | """Make a foo. | |||
|
87 | ||||
|
88 | Example: | |||
|
89 | ||||
|
90 | >>> f = foo(3) | |||
|
91 | junk | |||
|
92 | """ | |||
|
93 | print 'Making a foo.' | |||
|
94 | self.x = x | |||
|
95 | ||||
|
96 | @dec.skip_doctest | |||
|
97 | def bar(self,y): | |||
|
98 | """Example: | |||
|
99 | ||||
|
100 | >>> f = foo(3) | |||
|
101 | >>> f.bar(0) | |||
|
102 | boom! | |||
|
103 | >>> 1/0 | |||
|
104 | bam! | |||
|
105 | """ | |||
|
106 | return 1/y | |||
|
107 | ||||
|
108 | def baz(self,y): | |||
|
109 | """Example: | |||
|
110 | ||||
|
111 | >>> f = foo(3) | |||
|
112 | Making a foo. | |||
|
113 | >>> f.baz(3) | |||
|
114 | True | |||
|
115 | """ | |||
|
116 | return self.x==y | |||
59 |
|
117 | |||
60 |
|
118 | |||
61 | def test_skip_dt_decorator(): |
|
119 | def test_skip_dt_decorator(): | |
62 | """Doctest-skipping decorator should preserve the docstring. |
|
120 | """Doctest-skipping decorator should preserve the docstring. | |
63 | """ |
|
121 | """ | |
64 | # Careful: 'check' must be a *verbatim* copy of the doctest_bad docstring! |
|
122 | # Careful: 'check' must be a *verbatim* copy of the doctest_bad docstring! | |
65 | check = """A function whose doctest we need to skip. |
|
123 | check = """A function whose doctest we need to skip. | |
66 |
|
124 | |||
67 | >>> 1+1 |
|
125 | >>> 1+1 | |
68 | 3 |
|
126 | 3 | |
69 | """ |
|
127 | """ | |
70 | # Fetch the docstring from doctest_bad after decoration. |
|
128 | # Fetch the docstring from doctest_bad after decoration. | |
71 | val = doctest_bad.__doc__ |
|
129 | val = doctest_bad.__doc__ | |
72 |
|
130 | |||
73 | assert check==val,"doctest_bad docstrings don't match" |
|
131 | assert check==val,"doctest_bad docstrings don't match" | |
74 |
|
132 | |||
75 |
|
133 | |||
76 | def test_skip_dt_decorator2(): |
|
134 | def test_skip_dt_decorator2(): | |
77 | """Doctest-skipping decorator should preserve function signature. |
|
135 | """Doctest-skipping decorator should preserve function signature. | |
78 | """ |
|
136 | """ | |
79 | # Hardcoded correct answer |
|
137 | # Hardcoded correct answer | |
80 | dtargs = (['x', 'y'], None, 'k', (1,)) |
|
138 | dtargs = (['x', 'y'], None, 'k', (1,)) | |
81 | # Introspect out the value |
|
139 | # Introspect out the value | |
82 | dtargsr = getargspec(doctest_bad) |
|
140 | dtargsr = getargspec(doctest_bad) | |
83 | assert dtargsr==dtargs, \ |
|
141 | assert dtargsr==dtargs, \ | |
84 | "Incorrectly reconstructed args for doctest_bad: %s" % (dtargsr,) |
|
142 | "Incorrectly reconstructed args for doctest_bad: %s" % (dtargsr,) | |
85 |
|
143 | |||
86 |
|
144 | |||
87 | def doctest_run(): |
|
145 | def doctest_run(): | |
88 | """Test running a trivial script. |
|
146 | """Test running a trivial script. | |
89 |
|
147 | |||
90 | In [13]: run simplevars.py |
|
148 | In [13]: run simplevars.py | |
91 | x is: 1 |
|
149 | x is: 1 | |
92 | """ |
|
150 | """ | |
93 |
|
151 | |||
94 | #@dec.skip_doctest |
|
152 | #@dec.skip_doctest | |
95 | def doctest_runvars(): |
|
153 | def doctest_runvars(): | |
96 | """Test that variables defined in scripts get loaded correcly via %run. |
|
154 | """Test that variables defined in scripts get loaded correcly via %run. | |
97 |
|
155 | |||
98 | In [13]: run simplevars.py |
|
156 | In [13]: run simplevars.py | |
99 | x is: 1 |
|
157 | x is: 1 | |
100 |
|
158 | |||
101 | In [14]: x |
|
159 | In [14]: x | |
102 | Out[14]: 1 |
|
160 | Out[14]: 1 | |
103 | """ |
|
161 | """ | |
104 |
|
162 | |||
105 | def doctest_ivars(): |
|
163 | def doctest_ivars(): | |
106 | """Test that variables defined interactively are picked up. |
|
164 | """Test that variables defined interactively are picked up. | |
107 | In [5]: zz=1 |
|
165 | In [5]: zz=1 | |
108 |
|
166 | |||
109 | In [6]: zz |
|
167 | In [6]: zz | |
110 | Out[6]: 1 |
|
168 | Out[6]: 1 | |
111 | """ |
|
169 | """ | |
112 |
|
170 | |||
113 | @dec.skip_doctest |
|
171 | @dec.skip_doctest | |
114 | def doctest_refs(): |
|
172 | def doctest_refs(): | |
115 | """DocTest reference holding issues when running scripts. |
|
173 | """DocTest reference holding issues when running scripts. | |
116 |
|
174 | |||
117 | In [32]: run show_refs.py |
|
175 | In [32]: run show_refs.py | |
118 | c referrers: [<type 'dict'>] |
|
176 | c referrers: [<type 'dict'>] | |
119 |
|
177 | |||
120 | In [33]: map(type,gc.get_referrers(c)) |
|
178 | In [33]: map(type,gc.get_referrers(c)) | |
121 | Out[33]: [<type 'dict'>] |
|
179 | Out[33]: [<type 'dict'>] | |
122 | """ |
|
180 | """ |
@@ -1,27 +1,28 b'' | |||||
1 | #!/usr/bin/env python |
|
1 | #!/usr/bin/env python | |
2 | # -*- coding: utf-8 -*- |
|
2 | # -*- coding: utf-8 -*- | |
3 | """IPython -- An enhanced Interactive Python |
|
3 | """IPython -- An enhanced Interactive Python | |
4 |
|
4 | |||
5 | This is just the startup wrapper script, kept deliberately to a minimum. |
|
5 | This is just the startup wrapper script, kept deliberately to a minimum. | |
6 |
|
6 | |||
7 | The shell's mainloop() takes an optional argument, sys_exit (default=0). If |
|
7 | The shell's mainloop() takes an optional argument, sys_exit (default=0). If | |
8 | set to 1, it calls sys.exit() at exit time. You can use the following code in |
|
8 | set to 1, it calls sys.exit() at exit time. You can use the following code in | |
9 | your PYTHONSTARTUP file: |
|
9 | your PYTHONSTARTUP file: | |
10 |
|
10 | |||
11 | import IPython |
|
11 | import IPython | |
12 | IPython.Shell.IPShell().mainloop(sys_exit=1) |
|
12 | IPython.Shell.IPShell().mainloop(sys_exit=1) | |
13 |
|
13 | |||
14 | [or simply IPython.Shell.IPShell().mainloop(1) ] |
|
14 | [or simply IPython.Shell.IPShell().mainloop(1) ] | |
15 |
|
15 | |||
16 | and IPython will be your working environment when you start python. The final |
|
16 | and IPython will be your working environment when you start python. The final | |
17 | sys.exit() call will make python exit transparently when IPython finishes, so |
|
17 | sys.exit() call will make python exit transparently when IPython finishes, so | |
18 | you don't have an extra prompt to get out of. |
|
18 | you don't have an extra prompt to get out of. | |
19 |
|
19 | |||
20 | This is probably useful to developers who manage multiple Python versions and |
|
20 | This is probably useful to developers who manage multiple Python versions and | |
21 | don't want to have correspondingly multiple IPython versions. Note that in |
|
21 | don't want to have correspondingly multiple IPython versions. Note that in | |
22 | this mode, there is no way to pass IPython any command-line options, as those |
|
22 | this mode, there is no way to pass IPython any command-line options, as those | |
23 | are trapped first by Python itself. |
|
23 | are trapped first by Python itself. | |
24 | """ |
|
24 | """ | |
25 |
|
25 | |||
26 | import IPython.Shell |
|
26 | import IPython.Shell | |
|
27 | ||||
27 | IPython.Shell.start().mainloop() |
|
28 | IPython.Shell.start().mainloop() |
General Comments 0
You need to be logged in to leave comments.
Login now