Show More
The requested changes are too big and content was truncated. Show full diff
@@ -1,3012 +1,3010 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 26 |
|
4 | $Id: Magic.py 2659 2007-08-22 20:21:07Z vivainio $""" | |
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 |
|
63 | |||
64 | #*************************************************************************** |
|
64 | #*************************************************************************** | |
65 | # Utility functions |
|
65 | # Utility functions | |
66 | def on_off(tag): |
|
66 | def on_off(tag): | |
67 | """Return an ON/OFF string for a 1/0 input. Simple utility function.""" |
|
67 | """Return an ON/OFF string for a 1/0 input. Simple utility function.""" | |
68 | return ['OFF','ON'][tag] |
|
68 | return ['OFF','ON'][tag] | |
69 |
|
69 | |||
70 | class Bunch: pass |
|
70 | class Bunch: pass | |
71 |
|
71 | |||
72 | def compress_dhist(dh): |
|
72 | def compress_dhist(dh): | |
73 | head, tail = dh[:-10], dh[-10:] |
|
73 | head, tail = dh[:-10], dh[-10:] | |
74 |
|
74 | |||
75 | newhead = [] |
|
75 | newhead = [] | |
76 | done = Set() |
|
76 | done = Set() | |
77 | for h in head: |
|
77 | for h in head: | |
78 | if h in done: |
|
78 | if h in done: | |
79 | continue |
|
79 | continue | |
80 | newhead.append(h) |
|
80 | newhead.append(h) | |
81 | done.add(h) |
|
81 | done.add(h) | |
82 |
|
82 | |||
83 | return newhead + tail |
|
83 | return newhead + tail | |
84 |
|
84 | |||
85 |
|
85 | |||
86 | #*************************************************************************** |
|
86 | #*************************************************************************** | |
87 | # Main class implementing Magic functionality |
|
87 | # Main class implementing Magic functionality | |
88 | class Magic: |
|
88 | class Magic: | |
89 | """Magic functions for InteractiveShell. |
|
89 | """Magic functions for InteractiveShell. | |
90 |
|
90 | |||
91 | Shell functions which can be reached as %function_name. All magic |
|
91 | Shell functions which can be reached as %function_name. All magic | |
92 | functions should accept a string, which they can parse for their own |
|
92 | functions should accept a string, which they can parse for their own | |
93 | needs. This can make some functions easier to type, eg `%cd ../` |
|
93 | needs. This can make some functions easier to type, eg `%cd ../` | |
94 | vs. `%cd("../")` |
|
94 | vs. `%cd("../")` | |
95 |
|
95 | |||
96 | ALL definitions MUST begin with the prefix magic_. The user won't need it |
|
96 | 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. """ |
|
97 | at the command line, but it is is needed in the definition. """ | |
98 |
|
98 | |||
99 | # class globals |
|
99 | # class globals | |
100 | auto_status = ['Automagic is OFF, % prefix IS needed for magic functions.', |
|
100 | auto_status = ['Automagic is OFF, % prefix IS needed for magic functions.', | |
101 | 'Automagic is ON, % prefix NOT needed for magic functions.'] |
|
101 | 'Automagic is ON, % prefix NOT needed for magic functions.'] | |
102 |
|
102 | |||
103 | #...................................................................... |
|
103 | #...................................................................... | |
104 | # some utility functions |
|
104 | # some utility functions | |
105 |
|
105 | |||
106 | def __init__(self,shell): |
|
106 | def __init__(self,shell): | |
107 |
|
107 | |||
108 | self.options_table = {} |
|
108 | self.options_table = {} | |
109 | if profile is None: |
|
109 | if profile is None: | |
110 | self.magic_prun = self.profile_missing_notice |
|
110 | self.magic_prun = self.profile_missing_notice | |
111 | self.shell = shell |
|
111 | self.shell = shell | |
112 |
|
112 | |||
113 | # namespace for holding state we may need |
|
113 | # namespace for holding state we may need | |
114 | self._magic_state = Bunch() |
|
114 | self._magic_state = Bunch() | |
115 |
|
115 | |||
116 | def profile_missing_notice(self, *args, **kwargs): |
|
116 | def profile_missing_notice(self, *args, **kwargs): | |
117 | error("""\ |
|
117 | error("""\ | |
118 | The profile module could not be found. If you are a Debian user, |
|
118 | The profile module could not be found. If you are a Debian user, | |
119 | it has been removed from the standard Debian package because of its non-free |
|
119 | it has been removed from the standard Debian package because of its non-free | |
120 | license. To use profiling, please install"python2.3-profiler" from non-free.""") |
|
120 | license. To use profiling, please install"python2.3-profiler" from non-free.""") | |
121 |
|
121 | |||
122 | def default_option(self,fn,optstr): |
|
122 | def default_option(self,fn,optstr): | |
123 | """Make an entry in the options_table for fn, with value optstr""" |
|
123 | """Make an entry in the options_table for fn, with value optstr""" | |
124 |
|
124 | |||
125 | if fn not in self.lsmagic(): |
|
125 | if fn not in self.lsmagic(): | |
126 | error("%s is not a magic function" % fn) |
|
126 | error("%s is not a magic function" % fn) | |
127 | self.options_table[fn] = optstr |
|
127 | self.options_table[fn] = optstr | |
128 |
|
128 | |||
129 | def lsmagic(self): |
|
129 | def lsmagic(self): | |
130 | """Return a list of currently available magic functions. |
|
130 | """Return a list of currently available magic functions. | |
131 |
|
131 | |||
132 | Gives a list of the bare names after mangling (['ls','cd', ...], not |
|
132 | Gives a list of the bare names after mangling (['ls','cd', ...], not | |
133 | ['magic_ls','magic_cd',...]""" |
|
133 | ['magic_ls','magic_cd',...]""" | |
134 |
|
134 | |||
135 | # FIXME. This needs a cleanup, in the way the magics list is built. |
|
135 | # FIXME. This needs a cleanup, in the way the magics list is built. | |
136 |
|
136 | |||
137 | # magics in class definition |
|
137 | # magics in class definition | |
138 | class_magic = lambda fn: fn.startswith('magic_') and \ |
|
138 | class_magic = lambda fn: fn.startswith('magic_') and \ | |
139 | callable(Magic.__dict__[fn]) |
|
139 | callable(Magic.__dict__[fn]) | |
140 | # in instance namespace (run-time user additions) |
|
140 | # in instance namespace (run-time user additions) | |
141 | inst_magic = lambda fn: fn.startswith('magic_') and \ |
|
141 | inst_magic = lambda fn: fn.startswith('magic_') and \ | |
142 | callable(self.__dict__[fn]) |
|
142 | callable(self.__dict__[fn]) | |
143 | # and bound magics by user (so they can access self): |
|
143 | # and bound magics by user (so they can access self): | |
144 | inst_bound_magic = lambda fn: fn.startswith('magic_') and \ |
|
144 | inst_bound_magic = lambda fn: fn.startswith('magic_') and \ | |
145 | callable(self.__class__.__dict__[fn]) |
|
145 | callable(self.__class__.__dict__[fn]) | |
146 | magics = filter(class_magic,Magic.__dict__.keys()) + \ |
|
146 | magics = filter(class_magic,Magic.__dict__.keys()) + \ | |
147 | filter(inst_magic,self.__dict__.keys()) + \ |
|
147 | filter(inst_magic,self.__dict__.keys()) + \ | |
148 | filter(inst_bound_magic,self.__class__.__dict__.keys()) |
|
148 | filter(inst_bound_magic,self.__class__.__dict__.keys()) | |
149 | out = [] |
|
149 | out = [] | |
150 | for fn in magics: |
|
150 | for fn in magics: | |
151 | out.append(fn.replace('magic_','',1)) |
|
151 | out.append(fn.replace('magic_','',1)) | |
152 | out.sort() |
|
152 | out.sort() | |
153 | return out |
|
153 | return out | |
154 |
|
154 | |||
155 | def extract_input_slices(self,slices,raw=False): |
|
155 | def extract_input_slices(self,slices,raw=False): | |
156 | """Return as a string a set of input history slices. |
|
156 | """Return as a string a set of input history slices. | |
157 |
|
157 | |||
158 | Inputs: |
|
158 | Inputs: | |
159 |
|
159 | |||
160 | - slices: the set of slices is given as a list of strings (like |
|
160 | - 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 |
|
161 | ['1','4:8','9'], since this function is for use by magic functions | |
162 | which get their arguments as strings. |
|
162 | which get their arguments as strings. | |
163 |
|
163 | |||
164 | Optional inputs: |
|
164 | Optional inputs: | |
165 |
|
165 | |||
166 | - raw(False): by default, the processed input is used. If this is |
|
166 | - raw(False): by default, the processed input is used. If this is | |
167 | true, the raw input history is used instead. |
|
167 | true, the raw input history is used instead. | |
168 |
|
168 | |||
169 | Note that slices can be called with two notations: |
|
169 | Note that slices can be called with two notations: | |
170 |
|
170 | |||
171 | N:M -> standard python form, means including items N...(M-1). |
|
171 | N:M -> standard python form, means including items N...(M-1). | |
172 |
|
172 | |||
173 | N-M -> include items N..M (closed endpoint).""" |
|
173 | N-M -> include items N..M (closed endpoint).""" | |
174 |
|
174 | |||
175 | if raw: |
|
175 | if raw: | |
176 | hist = self.shell.input_hist_raw |
|
176 | hist = self.shell.input_hist_raw | |
177 | else: |
|
177 | else: | |
178 | hist = self.shell.input_hist |
|
178 | hist = self.shell.input_hist | |
179 |
|
179 | |||
180 | cmds = [] |
|
180 | cmds = [] | |
181 | for chunk in slices: |
|
181 | for chunk in slices: | |
182 | if ':' in chunk: |
|
182 | if ':' in chunk: | |
183 | ini,fin = map(int,chunk.split(':')) |
|
183 | ini,fin = map(int,chunk.split(':')) | |
184 | elif '-' in chunk: |
|
184 | elif '-' in chunk: | |
185 | ini,fin = map(int,chunk.split('-')) |
|
185 | ini,fin = map(int,chunk.split('-')) | |
186 | fin += 1 |
|
186 | fin += 1 | |
187 | else: |
|
187 | else: | |
188 | ini = int(chunk) |
|
188 | ini = int(chunk) | |
189 | fin = ini+1 |
|
189 | fin = ini+1 | |
190 | cmds.append(hist[ini:fin]) |
|
190 | cmds.append(hist[ini:fin]) | |
191 | return cmds |
|
191 | return cmds | |
192 |
|
192 | |||
193 | def _ofind(self, oname, namespaces=None): |
|
193 | def _ofind(self, oname, namespaces=None): | |
194 | """Find an object in the available namespaces. |
|
194 | """Find an object in the available namespaces. | |
195 |
|
195 | |||
196 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic |
|
196 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic | |
197 |
|
197 | |||
198 | Has special code to detect magic functions. |
|
198 | Has special code to detect magic functions. | |
199 | """ |
|
199 | """ | |
200 |
|
200 | |||
201 | oname = oname.strip() |
|
201 | oname = oname.strip() | |
202 |
|
202 | |||
203 | alias_ns = None |
|
203 | alias_ns = None | |
204 | if namespaces is None: |
|
204 | if namespaces is None: | |
205 | # Namespaces to search in: |
|
205 | # Namespaces to search in: | |
206 | # Put them in a list. The order is important so that we |
|
206 | # Put them in a list. The order is important so that we | |
207 | # find things in the same order that Python finds them. |
|
207 | # find things in the same order that Python finds them. | |
208 | namespaces = [ ('Interactive', self.shell.user_ns), |
|
208 | namespaces = [ ('Interactive', self.shell.user_ns), | |
209 | ('IPython internal', self.shell.internal_ns), |
|
209 | ('IPython internal', self.shell.internal_ns), | |
210 | ('Python builtin', __builtin__.__dict__), |
|
210 | ('Python builtin', __builtin__.__dict__), | |
211 | ('Alias', self.shell.alias_table), |
|
211 | ('Alias', self.shell.alias_table), | |
212 | ] |
|
212 | ] | |
213 | alias_ns = self.shell.alias_table |
|
213 | alias_ns = self.shell.alias_table | |
214 |
|
214 | |||
215 | # initialize results to 'null' |
|
215 | # initialize results to 'null' | |
216 | found = 0; obj = None; ospace = None; ds = None; |
|
216 | found = 0; obj = None; ospace = None; ds = None; | |
217 | ismagic = 0; isalias = 0; parent = None |
|
217 | ismagic = 0; isalias = 0; parent = None | |
218 |
|
218 | |||
219 | # Look for the given name by splitting it in parts. If the head is |
|
219 | # 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 |
|
220 | # found, then we look for all the remaining parts as members, and only | |
221 | # declare success if we can find them all. |
|
221 | # declare success if we can find them all. | |
222 | oname_parts = oname.split('.') |
|
222 | oname_parts = oname.split('.') | |
223 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] |
|
223 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] | |
224 | for nsname,ns in namespaces: |
|
224 | for nsname,ns in namespaces: | |
225 | try: |
|
225 | try: | |
226 | obj = ns[oname_head] |
|
226 | obj = ns[oname_head] | |
227 | except KeyError: |
|
227 | except KeyError: | |
228 | continue |
|
228 | continue | |
229 | else: |
|
229 | else: | |
230 | #print 'oname_rest:', oname_rest # dbg |
|
230 | #print 'oname_rest:', oname_rest # dbg | |
231 | for part in oname_rest: |
|
231 | for part in oname_rest: | |
232 | try: |
|
232 | try: | |
233 | parent = obj |
|
233 | parent = obj | |
234 | obj = getattr(obj,part) |
|
234 | obj = getattr(obj,part) | |
235 | except: |
|
235 | except: | |
236 | # Blanket except b/c some badly implemented objects |
|
236 | # Blanket except b/c some badly implemented objects | |
237 | # allow __getattr__ to raise exceptions other than |
|
237 | # allow __getattr__ to raise exceptions other than | |
238 | # AttributeError, which then crashes IPython. |
|
238 | # AttributeError, which then crashes IPython. | |
239 | break |
|
239 | break | |
240 | else: |
|
240 | else: | |
241 | # If we finish the for loop (no break), we got all members |
|
241 | # If we finish the for loop (no break), we got all members | |
242 | found = 1 |
|
242 | found = 1 | |
243 | ospace = nsname |
|
243 | ospace = nsname | |
244 | if ns == alias_ns: |
|
244 | if ns == alias_ns: | |
245 | isalias = 1 |
|
245 | isalias = 1 | |
246 | break # namespace loop |
|
246 | break # namespace loop | |
247 |
|
247 | |||
248 | # Try to see if it's magic |
|
248 | # Try to see if it's magic | |
249 | if not found: |
|
249 | if not found: | |
250 | if oname.startswith(self.shell.ESC_MAGIC): |
|
250 | if oname.startswith(self.shell.ESC_MAGIC): | |
251 | oname = oname[1:] |
|
251 | oname = oname[1:] | |
252 | obj = getattr(self,'magic_'+oname,None) |
|
252 | obj = getattr(self,'magic_'+oname,None) | |
253 | if obj is not None: |
|
253 | if obj is not None: | |
254 | found = 1 |
|
254 | found = 1 | |
255 | ospace = 'IPython internal' |
|
255 | ospace = 'IPython internal' | |
256 | ismagic = 1 |
|
256 | ismagic = 1 | |
257 |
|
257 | |||
258 | # Last try: special-case some literals like '', [], {}, etc: |
|
258 | # Last try: special-case some literals like '', [], {}, etc: | |
259 | if not found and oname_head in ["''",'""','[]','{}','()']: |
|
259 | if not found and oname_head in ["''",'""','[]','{}','()']: | |
260 | obj = eval(oname_head) |
|
260 | obj = eval(oname_head) | |
261 | found = 1 |
|
261 | found = 1 | |
262 | ospace = 'Interactive' |
|
262 | ospace = 'Interactive' | |
263 |
|
263 | |||
264 | return {'found':found, 'obj':obj, 'namespace':ospace, |
|
264 | return {'found':found, 'obj':obj, 'namespace':ospace, | |
265 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} |
|
265 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} | |
266 |
|
266 | |||
267 | def arg_err(self,func): |
|
267 | def arg_err(self,func): | |
268 | """Print docstring if incorrect arguments were passed""" |
|
268 | """Print docstring if incorrect arguments were passed""" | |
269 | print 'Error in arguments:' |
|
269 | print 'Error in arguments:' | |
270 | print OInspect.getdoc(func) |
|
270 | print OInspect.getdoc(func) | |
271 |
|
271 | |||
272 | def format_latex(self,strng): |
|
272 | def format_latex(self,strng): | |
273 | """Format a string for latex inclusion.""" |
|
273 | """Format a string for latex inclusion.""" | |
274 |
|
274 | |||
275 | # Characters that need to be escaped for latex: |
|
275 | # Characters that need to be escaped for latex: | |
276 | escape_re = re.compile(r'(%|_|\$|#|&)',re.MULTILINE) |
|
276 | escape_re = re.compile(r'(%|_|\$|#|&)',re.MULTILINE) | |
277 | # Magic command names as headers: |
|
277 | # Magic command names as headers: | |
278 | cmd_name_re = re.compile(r'^(%s.*?):' % self.shell.ESC_MAGIC, |
|
278 | cmd_name_re = re.compile(r'^(%s.*?):' % self.shell.ESC_MAGIC, | |
279 | re.MULTILINE) |
|
279 | re.MULTILINE) | |
280 | # Magic commands |
|
280 | # Magic commands | |
281 | cmd_re = re.compile(r'(?P<cmd>%s.+?\b)(?!\}\}:)' % self.shell.ESC_MAGIC, |
|
281 | cmd_re = re.compile(r'(?P<cmd>%s.+?\b)(?!\}\}:)' % self.shell.ESC_MAGIC, | |
282 | re.MULTILINE) |
|
282 | re.MULTILINE) | |
283 | # Paragraph continue |
|
283 | # Paragraph continue | |
284 | par_re = re.compile(r'\\$',re.MULTILINE) |
|
284 | par_re = re.compile(r'\\$',re.MULTILINE) | |
285 |
|
285 | |||
286 | # The "\n" symbol |
|
286 | # The "\n" symbol | |
287 | newline_re = re.compile(r'\\n') |
|
287 | newline_re = re.compile(r'\\n') | |
288 |
|
288 | |||
289 | # Now build the string for output: |
|
289 | # Now build the string for output: | |
290 | #strng = cmd_name_re.sub(r'\n\\texttt{\\textsl{\\large \1}}:',strng) |
|
290 | #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}}:', |
|
291 | strng = cmd_name_re.sub(r'\n\\bigskip\n\\texttt{\\textbf{ \1}}:', | |
292 | strng) |
|
292 | strng) | |
293 | strng = cmd_re.sub(r'\\texttt{\g<cmd>}',strng) |
|
293 | strng = cmd_re.sub(r'\\texttt{\g<cmd>}',strng) | |
294 | strng = par_re.sub(r'\\\\',strng) |
|
294 | strng = par_re.sub(r'\\\\',strng) | |
295 | strng = escape_re.sub(r'\\\1',strng) |
|
295 | strng = escape_re.sub(r'\\\1',strng) | |
296 | strng = newline_re.sub(r'\\textbackslash{}n',strng) |
|
296 | strng = newline_re.sub(r'\\textbackslash{}n',strng) | |
297 | return strng |
|
297 | return strng | |
298 |
|
298 | |||
299 | def format_screen(self,strng): |
|
299 | def format_screen(self,strng): | |
300 | """Format a string for screen printing. |
|
300 | """Format a string for screen printing. | |
301 |
|
301 | |||
302 | This removes some latex-type format codes.""" |
|
302 | This removes some latex-type format codes.""" | |
303 | # Paragraph continue |
|
303 | # Paragraph continue | |
304 | par_re = re.compile(r'\\$',re.MULTILINE) |
|
304 | par_re = re.compile(r'\\$',re.MULTILINE) | |
305 | strng = par_re.sub('',strng) |
|
305 | strng = par_re.sub('',strng) | |
306 | return strng |
|
306 | return strng | |
307 |
|
307 | |||
308 | def parse_options(self,arg_str,opt_str,*long_opts,**kw): |
|
308 | def parse_options(self,arg_str,opt_str,*long_opts,**kw): | |
309 | """Parse options passed to an argument string. |
|
309 | """Parse options passed to an argument string. | |
310 |
|
310 | |||
311 | The interface is similar to that of getopt(), but it returns back a |
|
311 | 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 |
|
312 | Struct with the options as keys and the stripped argument string still | |
313 | as a string. |
|
313 | as a string. | |
314 |
|
314 | |||
315 | arg_str is quoted as a true sys.argv vector by using shlex.split. |
|
315 | 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 |
|
316 | This allows us to easily expand variables, glob files, quote | |
317 | arguments, etc. |
|
317 | arguments, etc. | |
318 |
|
318 | |||
319 | Options: |
|
319 | Options: | |
320 | -mode: default 'string'. If given as 'list', the argument string is |
|
320 | -mode: default 'string'. If given as 'list', the argument string is | |
321 | returned as a list (split on whitespace) instead of a string. |
|
321 | returned as a list (split on whitespace) instead of a string. | |
322 |
|
322 | |||
323 | -list_all: put all option values in lists. Normally only options |
|
323 | -list_all: put all option values in lists. Normally only options | |
324 | appearing more than once are put in a list. |
|
324 | appearing more than once are put in a list. | |
325 |
|
325 | |||
326 | -posix (True): whether to split the input line in POSIX mode or not, |
|
326 | -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 |
|
327 | as per the conventions outlined in the shlex module from the | |
328 | standard library.""" |
|
328 | standard library.""" | |
329 |
|
329 | |||
330 | # inject default options at the beginning of the input line |
|
330 | # inject default options at the beginning of the input line | |
331 | caller = sys._getframe(1).f_code.co_name.replace('magic_','') |
|
331 | caller = sys._getframe(1).f_code.co_name.replace('magic_','') | |
332 | arg_str = '%s %s' % (self.options_table.get(caller,''),arg_str) |
|
332 | arg_str = '%s %s' % (self.options_table.get(caller,''),arg_str) | |
333 |
|
333 | |||
334 | mode = kw.get('mode','string') |
|
334 | mode = kw.get('mode','string') | |
335 | if mode not in ['string','list']: |
|
335 | if mode not in ['string','list']: | |
336 | raise ValueError,'incorrect mode given: %s' % mode |
|
336 | raise ValueError,'incorrect mode given: %s' % mode | |
337 | # Get options |
|
337 | # Get options | |
338 | list_all = kw.get('list_all',0) |
|
338 | list_all = kw.get('list_all',0) | |
339 | posix = kw.get('posix',True) |
|
339 | posix = kw.get('posix',True) | |
340 |
|
340 | |||
341 | # Check if we have more than one argument to warrant extra processing: |
|
341 | # Check if we have more than one argument to warrant extra processing: | |
342 | odict = {} # Dictionary with options |
|
342 | odict = {} # Dictionary with options | |
343 | args = arg_str.split() |
|
343 | args = arg_str.split() | |
344 | if len(args) >= 1: |
|
344 | if len(args) >= 1: | |
345 | # If the list of inputs only has 0 or 1 thing in it, there's no |
|
345 | # If the list of inputs only has 0 or 1 thing in it, there's no | |
346 | # need to look for options |
|
346 | # need to look for options | |
347 | argv = arg_split(arg_str,posix) |
|
347 | argv = arg_split(arg_str,posix) | |
348 | # Do regular option processing |
|
348 | # Do regular option processing | |
349 | try: |
|
349 | try: | |
350 | opts,args = getopt(argv,opt_str,*long_opts) |
|
350 | opts,args = getopt(argv,opt_str,*long_opts) | |
351 | except GetoptError,e: |
|
351 | except GetoptError,e: | |
352 | raise GetoptError('%s ( allowed: "%s" %s)' % (e.msg,opt_str, |
|
352 | raise GetoptError('%s ( allowed: "%s" %s)' % (e.msg,opt_str, | |
353 | " ".join(long_opts))) |
|
353 | " ".join(long_opts))) | |
354 | for o,a in opts: |
|
354 | for o,a in opts: | |
355 | if o.startswith('--'): |
|
355 | if o.startswith('--'): | |
356 | o = o[2:] |
|
356 | o = o[2:] | |
357 | else: |
|
357 | else: | |
358 | o = o[1:] |
|
358 | o = o[1:] | |
359 | try: |
|
359 | try: | |
360 | odict[o].append(a) |
|
360 | odict[o].append(a) | |
361 | except AttributeError: |
|
361 | except AttributeError: | |
362 | odict[o] = [odict[o],a] |
|
362 | odict[o] = [odict[o],a] | |
363 | except KeyError: |
|
363 | except KeyError: | |
364 | if list_all: |
|
364 | if list_all: | |
365 | odict[o] = [a] |
|
365 | odict[o] = [a] | |
366 | else: |
|
366 | else: | |
367 | odict[o] = a |
|
367 | odict[o] = a | |
368 |
|
368 | |||
369 | # Prepare opts,args for return |
|
369 | # Prepare opts,args for return | |
370 | opts = Struct(odict) |
|
370 | opts = Struct(odict) | |
371 | if mode == 'string': |
|
371 | if mode == 'string': | |
372 | args = ' '.join(args) |
|
372 | args = ' '.join(args) | |
373 |
|
373 | |||
374 | return opts,args |
|
374 | return opts,args | |
375 |
|
375 | |||
376 | #...................................................................... |
|
376 | #...................................................................... | |
377 | # And now the actual magic functions |
|
377 | # And now the actual magic functions | |
378 |
|
378 | |||
379 | # Functions for IPython shell work (vars,funcs, config, etc) |
|
379 | # Functions for IPython shell work (vars,funcs, config, etc) | |
380 | def magic_lsmagic(self, parameter_s = ''): |
|
380 | def magic_lsmagic(self, parameter_s = ''): | |
381 | """List currently available magic functions.""" |
|
381 | """List currently available magic functions.""" | |
382 | mesc = self.shell.ESC_MAGIC |
|
382 | mesc = self.shell.ESC_MAGIC | |
383 | print 'Available magic functions:\n'+mesc+\ |
|
383 | print 'Available magic functions:\n'+mesc+\ | |
384 | (' '+mesc).join(self.lsmagic()) |
|
384 | (' '+mesc).join(self.lsmagic()) | |
385 | print '\n' + Magic.auto_status[self.shell.rc.automagic] |
|
385 | print '\n' + Magic.auto_status[self.shell.rc.automagic] | |
386 | return None |
|
386 | return None | |
387 |
|
387 | |||
388 | def magic_magic(self, parameter_s = ''): |
|
388 | def magic_magic(self, parameter_s = ''): | |
389 | """Print information about the magic function system.""" |
|
389 | """Print information about the magic function system.""" | |
390 |
|
390 | |||
391 | mode = '' |
|
391 | mode = '' | |
392 | try: |
|
392 | try: | |
393 | if parameter_s.split()[0] == '-latex': |
|
393 | if parameter_s.split()[0] == '-latex': | |
394 | mode = 'latex' |
|
394 | mode = 'latex' | |
395 | if parameter_s.split()[0] == '-brief': |
|
395 | if parameter_s.split()[0] == '-brief': | |
396 | mode = 'brief' |
|
396 | mode = 'brief' | |
397 | except: |
|
397 | except: | |
398 | pass |
|
398 | pass | |
399 |
|
399 | |||
400 | magic_docs = [] |
|
400 | magic_docs = [] | |
401 | for fname in self.lsmagic(): |
|
401 | for fname in self.lsmagic(): | |
402 | mname = 'magic_' + fname |
|
402 | mname = 'magic_' + fname | |
403 | for space in (Magic,self,self.__class__): |
|
403 | for space in (Magic,self,self.__class__): | |
404 | try: |
|
404 | try: | |
405 | fn = space.__dict__[mname] |
|
405 | fn = space.__dict__[mname] | |
406 | except KeyError: |
|
406 | except KeyError: | |
407 | pass |
|
407 | pass | |
408 | else: |
|
408 | else: | |
409 | break |
|
409 | break | |
410 | if mode == 'brief': |
|
410 | if mode == 'brief': | |
411 | # only first line |
|
411 | # only first line | |
412 | fndoc = fn.__doc__.split('\n',1)[0] |
|
412 | fndoc = fn.__doc__.split('\n',1)[0] | |
413 | else: |
|
413 | else: | |
414 | fndoc = fn.__doc__ |
|
414 | fndoc = fn.__doc__ | |
415 |
|
415 | |||
416 | magic_docs.append('%s%s:\n\t%s\n' %(self.shell.ESC_MAGIC, |
|
416 | magic_docs.append('%s%s:\n\t%s\n' %(self.shell.ESC_MAGIC, | |
417 | fname,fndoc)) |
|
417 | fname,fndoc)) | |
418 | magic_docs = ''.join(magic_docs) |
|
418 | magic_docs = ''.join(magic_docs) | |
419 |
|
419 | |||
420 | if mode == 'latex': |
|
420 | if mode == 'latex': | |
421 | print self.format_latex(magic_docs) |
|
421 | print self.format_latex(magic_docs) | |
422 | return |
|
422 | return | |
423 | else: |
|
423 | else: | |
424 | magic_docs = self.format_screen(magic_docs) |
|
424 | magic_docs = self.format_screen(magic_docs) | |
425 | if mode == 'brief': |
|
425 | if mode == 'brief': | |
426 | return magic_docs |
|
426 | return magic_docs | |
427 |
|
427 | |||
428 | outmsg = """ |
|
428 | outmsg = """ | |
429 | IPython's 'magic' functions |
|
429 | IPython's 'magic' functions | |
430 | =========================== |
|
430 | =========================== | |
431 |
|
431 | |||
432 | The magic function system provides a series of functions which allow you to |
|
432 | The magic function system provides a series of functions which allow you to | |
433 | control the behavior of IPython itself, plus a lot of system-type |
|
433 | control the behavior of IPython itself, plus a lot of system-type | |
434 | features. All these functions are prefixed with a % character, but parameters |
|
434 | features. All these functions are prefixed with a % character, but parameters | |
435 | are given without parentheses or quotes. |
|
435 | are given without parentheses or quotes. | |
436 |
|
436 | |||
437 | NOTE: If you have 'automagic' enabled (via the command line option or with the |
|
437 | NOTE: If you have 'automagic' enabled (via the command line option or with the | |
438 | %automagic function), you don't need to type in the % explicitly. By default, |
|
438 | %automagic function), you don't need to type in the % explicitly. By default, | |
439 | IPython ships with automagic on, so you should only rarely need the % escape. |
|
439 | IPython ships with automagic on, so you should only rarely need the % escape. | |
440 |
|
440 | |||
441 | Example: typing '%cd mydir' (without the quotes) changes you working directory |
|
441 | Example: typing '%cd mydir' (without the quotes) changes you working directory | |
442 | to 'mydir', if it exists. |
|
442 | to 'mydir', if it exists. | |
443 |
|
443 | |||
444 | You can define your own magic functions to extend the system. See the supplied |
|
444 | You can define your own magic functions to extend the system. See the supplied | |
445 | ipythonrc and example-magic.py files for details (in your ipython |
|
445 | ipythonrc and example-magic.py files for details (in your ipython | |
446 | configuration directory, typically $HOME/.ipython/). |
|
446 | configuration directory, typically $HOME/.ipython/). | |
447 |
|
447 | |||
448 | You can also define your own aliased names for magic functions. In your |
|
448 | You can also define your own aliased names for magic functions. In your | |
449 | ipythonrc file, placing a line like: |
|
449 | ipythonrc file, placing a line like: | |
450 |
|
450 | |||
451 | execute __IPYTHON__.magic_pf = __IPYTHON__.magic_profile |
|
451 | execute __IPYTHON__.magic_pf = __IPYTHON__.magic_profile | |
452 |
|
452 | |||
453 | will define %pf as a new name for %profile. |
|
453 | will define %pf as a new name for %profile. | |
454 |
|
454 | |||
455 | You can also call magics in code using the ipmagic() function, which IPython |
|
455 | You can also call magics in code using the ipmagic() function, which IPython | |
456 | automatically adds to the builtin namespace. Type 'ipmagic?' for details. |
|
456 | automatically adds to the builtin namespace. Type 'ipmagic?' for details. | |
457 |
|
457 | |||
458 | For a list of the available magic functions, use %lsmagic. For a description |
|
458 | For a list of the available magic functions, use %lsmagic. For a description | |
459 | of any of them, type %magic_name?, e.g. '%cd?'. |
|
459 | of any of them, type %magic_name?, e.g. '%cd?'. | |
460 |
|
460 | |||
461 | Currently the magic system has the following functions:\n""" |
|
461 | Currently the magic system has the following functions:\n""" | |
462 |
|
462 | |||
463 | mesc = self.shell.ESC_MAGIC |
|
463 | mesc = self.shell.ESC_MAGIC | |
464 | outmsg = ("%s\n%s\n\nSummary of magic functions (from %slsmagic):" |
|
464 | outmsg = ("%s\n%s\n\nSummary of magic functions (from %slsmagic):" | |
465 | "\n\n%s%s\n\n%s" % (outmsg, |
|
465 | "\n\n%s%s\n\n%s" % (outmsg, | |
466 | magic_docs,mesc,mesc, |
|
466 | magic_docs,mesc,mesc, | |
467 | (' '+mesc).join(self.lsmagic()), |
|
467 | (' '+mesc).join(self.lsmagic()), | |
468 | Magic.auto_status[self.shell.rc.automagic] ) ) |
|
468 | Magic.auto_status[self.shell.rc.automagic] ) ) | |
469 |
|
469 | |||
470 | page(outmsg,screen_lines=self.shell.rc.screen_length) |
|
470 | page(outmsg,screen_lines=self.shell.rc.screen_length) | |
471 |
|
471 | |||
472 |
|
472 | |||
473 | def magic_autoindent(self, parameter_s = ''): |
|
473 | def magic_autoindent(self, parameter_s = ''): | |
474 | """Toggle autoindent on/off (if available).""" |
|
474 | """Toggle autoindent on/off (if available).""" | |
475 |
|
475 | |||
476 | self.shell.set_autoindent() |
|
476 | self.shell.set_autoindent() | |
477 | print "Automatic indentation is:",['OFF','ON'][self.shell.autoindent] |
|
477 | print "Automatic indentation is:",['OFF','ON'][self.shell.autoindent] | |
478 |
|
478 | |||
479 | def magic_system_verbose(self, parameter_s = ''): |
|
479 | def magic_system_verbose(self, parameter_s = ''): | |
480 | """Set verbose printing of system calls. |
|
480 | """Set verbose printing of system calls. | |
481 |
|
481 | |||
482 | If called without an argument, act as a toggle""" |
|
482 | If called without an argument, act as a toggle""" | |
483 |
|
483 | |||
484 | if parameter_s: |
|
484 | if parameter_s: | |
485 | val = bool(eval(parameter_s)) |
|
485 | val = bool(eval(parameter_s)) | |
486 | else: |
|
486 | else: | |
487 | val = None |
|
487 | val = None | |
488 |
|
488 | |||
489 | self.shell.rc_set_toggle('system_verbose',val) |
|
489 | self.shell.rc_set_toggle('system_verbose',val) | |
490 | print "System verbose printing is:",\ |
|
490 | print "System verbose printing is:",\ | |
491 | ['OFF','ON'][self.shell.rc.system_verbose] |
|
491 | ['OFF','ON'][self.shell.rc.system_verbose] | |
492 |
|
492 | |||
493 |
|
493 | |||
494 | def magic_page(self, parameter_s=''): |
|
494 | def magic_page(self, parameter_s=''): | |
495 | """Pretty print the object and display it through a pager. |
|
495 | """Pretty print the object and display it through a pager. | |
496 |
|
496 | |||
497 | %page [options] OBJECT |
|
497 | %page [options] OBJECT | |
498 |
|
498 | |||
499 | If no object is given, use _ (last output). |
|
499 | If no object is given, use _ (last output). | |
500 |
|
500 | |||
501 | Options: |
|
501 | Options: | |
502 |
|
502 | |||
503 | -r: page str(object), don't pretty-print it.""" |
|
503 | -r: page str(object), don't pretty-print it.""" | |
504 |
|
504 | |||
505 | # After a function contributed by Olivier Aubert, slightly modified. |
|
505 | # After a function contributed by Olivier Aubert, slightly modified. | |
506 |
|
506 | |||
507 | # Process options/args |
|
507 | # Process options/args | |
508 | opts,args = self.parse_options(parameter_s,'r') |
|
508 | opts,args = self.parse_options(parameter_s,'r') | |
509 | raw = 'r' in opts |
|
509 | raw = 'r' in opts | |
510 |
|
510 | |||
511 | oname = args and args or '_' |
|
511 | oname = args and args or '_' | |
512 | info = self._ofind(oname) |
|
512 | info = self._ofind(oname) | |
513 | if info['found']: |
|
513 | if info['found']: | |
514 | txt = (raw and str or pformat)( info['obj'] ) |
|
514 | txt = (raw and str or pformat)( info['obj'] ) | |
515 | page(txt) |
|
515 | page(txt) | |
516 | else: |
|
516 | else: | |
517 | print 'Object `%s` not found' % oname |
|
517 | print 'Object `%s` not found' % oname | |
518 |
|
518 | |||
519 | def magic_profile(self, parameter_s=''): |
|
519 | def magic_profile(self, parameter_s=''): | |
520 | """Print your currently active IPyhton profile.""" |
|
520 | """Print your currently active IPyhton profile.""" | |
521 | if self.shell.rc.profile: |
|
521 | if self.shell.rc.profile: | |
522 | printpl('Current IPython profile: $self.shell.rc.profile.') |
|
522 | printpl('Current IPython profile: $self.shell.rc.profile.') | |
523 | else: |
|
523 | else: | |
524 | print 'No profile active.' |
|
524 | print 'No profile active.' | |
525 |
|
525 | |||
526 | def magic_pinfo(self, parameter_s='', namespaces=None): |
|
526 | def magic_pinfo(self, parameter_s='', namespaces=None): | |
527 | """Provide detailed information about an object. |
|
527 | """Provide detailed information about an object. | |
528 |
|
528 | |||
529 | '%pinfo object' is just a synonym for object? or ?object.""" |
|
529 | '%pinfo object' is just a synonym for object? or ?object.""" | |
530 |
|
530 | |||
531 | #print 'pinfo par: <%s>' % parameter_s # dbg |
|
531 | #print 'pinfo par: <%s>' % parameter_s # dbg | |
532 |
|
532 | |||
533 |
|
533 | |||
534 | # detail_level: 0 -> obj? , 1 -> obj?? |
|
534 | # detail_level: 0 -> obj? , 1 -> obj?? | |
535 | detail_level = 0 |
|
535 | detail_level = 0 | |
536 | # We need to detect if we got called as 'pinfo pinfo foo', which can |
|
536 | # We need to detect if we got called as 'pinfo pinfo foo', which can | |
537 | # happen if the user types 'pinfo foo?' at the cmd line. |
|
537 | # happen if the user types 'pinfo foo?' at the cmd line. | |
538 | pinfo,qmark1,oname,qmark2 = \ |
|
538 | pinfo,qmark1,oname,qmark2 = \ | |
539 | re.match('(pinfo )?(\?*)(.*?)(\??$)',parameter_s).groups() |
|
539 | re.match('(pinfo )?(\?*)(.*?)(\??$)',parameter_s).groups() | |
540 | if pinfo or qmark1 or qmark2: |
|
540 | if pinfo or qmark1 or qmark2: | |
541 | detail_level = 1 |
|
541 | detail_level = 1 | |
542 | if "*" in oname: |
|
542 | if "*" in oname: | |
543 | self.magic_psearch(oname) |
|
543 | self.magic_psearch(oname) | |
544 | else: |
|
544 | else: | |
545 | self._inspect('pinfo', oname, detail_level=detail_level, |
|
545 | self._inspect('pinfo', oname, detail_level=detail_level, | |
546 | namespaces=namespaces) |
|
546 | namespaces=namespaces) | |
547 |
|
547 | |||
548 | def _inspect(self,meth,oname,namespaces=None,**kw): |
|
548 | def _inspect(self,meth,oname,namespaces=None,**kw): | |
549 | """Generic interface to the inspector system. |
|
549 | """Generic interface to the inspector system. | |
550 |
|
550 | |||
551 | This function is meant to be called by pdef, pdoc & friends.""" |
|
551 | This function is meant to be called by pdef, pdoc & friends.""" | |
552 |
|
552 | |||
553 | #oname = oname.strip() |
|
553 | #oname = oname.strip() | |
554 | #print '1- oname: <%r>' % oname # dbg |
|
554 | #print '1- oname: <%r>' % oname # dbg | |
555 | try: |
|
555 | try: | |
556 | oname = oname.strip().encode('ascii') |
|
556 | oname = oname.strip().encode('ascii') | |
557 | #print '2- oname: <%r>' % oname # dbg |
|
557 | #print '2- oname: <%r>' % oname # dbg | |
558 | except UnicodeEncodeError: |
|
558 | except UnicodeEncodeError: | |
559 | print 'Python identifiers can only contain ascii characters.' |
|
559 | print 'Python identifiers can only contain ascii characters.' | |
560 | return 'not found' |
|
560 | return 'not found' | |
561 |
|
561 | |||
562 | info = Struct(self._ofind(oname, namespaces)) |
|
562 | info = Struct(self._ofind(oname, namespaces)) | |
563 |
|
563 | |||
564 | if info.found: |
|
564 | if info.found: | |
565 | try: |
|
565 | try: | |
566 | IPython.generics.inspect_object(info.obj) |
|
566 | IPython.generics.inspect_object(info.obj) | |
567 | return |
|
567 | return | |
568 | except IPython.ipapi.TryNext: |
|
568 | except IPython.ipapi.TryNext: | |
569 | pass |
|
569 | pass | |
570 | # Get the docstring of the class property if it exists. |
|
570 | # Get the docstring of the class property if it exists. | |
571 | path = oname.split('.') |
|
571 | path = oname.split('.') | |
572 | root = '.'.join(path[:-1]) |
|
572 | root = '.'.join(path[:-1]) | |
573 | if info.parent is not None: |
|
573 | if info.parent is not None: | |
574 | try: |
|
574 | try: | |
575 | target = getattr(info.parent, '__class__') |
|
575 | target = getattr(info.parent, '__class__') | |
576 | # The object belongs to a class instance. |
|
576 | # The object belongs to a class instance. | |
577 | try: |
|
577 | try: | |
578 | target = getattr(target, path[-1]) |
|
578 | target = getattr(target, path[-1]) | |
579 | # The class defines the object. |
|
579 | # The class defines the object. | |
580 | if isinstance(target, property): |
|
580 | if isinstance(target, property): | |
581 | oname = root + '.__class__.' + path[-1] |
|
581 | oname = root + '.__class__.' + path[-1] | |
582 | info = Struct(self._ofind(oname)) |
|
582 | info = Struct(self._ofind(oname)) | |
583 | except AttributeError: pass |
|
583 | except AttributeError: pass | |
584 | except AttributeError: pass |
|
584 | except AttributeError: pass | |
585 |
|
585 | |||
586 | pmethod = getattr(self.shell.inspector,meth) |
|
586 | pmethod = getattr(self.shell.inspector,meth) | |
587 | formatter = info.ismagic and self.format_screen or None |
|
587 | formatter = info.ismagic and self.format_screen or None | |
588 | if meth == 'pdoc': |
|
588 | if meth == 'pdoc': | |
589 | pmethod(info.obj,oname,formatter) |
|
589 | pmethod(info.obj,oname,formatter) | |
590 | elif meth == 'pinfo': |
|
590 | elif meth == 'pinfo': | |
591 | pmethod(info.obj,oname,formatter,info,**kw) |
|
591 | pmethod(info.obj,oname,formatter,info,**kw) | |
592 | else: |
|
592 | else: | |
593 | pmethod(info.obj,oname) |
|
593 | pmethod(info.obj,oname) | |
594 | else: |
|
594 | else: | |
595 | print 'Object `%s` not found.' % oname |
|
595 | print 'Object `%s` not found.' % oname | |
596 | return 'not found' # so callers can take other action |
|
596 | return 'not found' # so callers can take other action | |
597 |
|
597 | |||
598 | def magic_psearch(self, parameter_s=''): |
|
598 | def magic_psearch(self, parameter_s=''): | |
599 | """Search for object in namespaces by wildcard. |
|
599 | """Search for object in namespaces by wildcard. | |
600 |
|
600 | |||
601 | %psearch [options] PATTERN [OBJECT TYPE] |
|
601 | %psearch [options] PATTERN [OBJECT TYPE] | |
602 |
|
602 | |||
603 | Note: ? can be used as a synonym for %psearch, at the beginning or at |
|
603 | Note: ? can be used as a synonym for %psearch, at the beginning or at | |
604 | the end: both a*? and ?a* are equivalent to '%psearch a*'. Still, the |
|
604 | the end: both a*? and ?a* are equivalent to '%psearch a*'. Still, the | |
605 | rest of the command line must be unchanged (options come first), so |
|
605 | rest of the command line must be unchanged (options come first), so | |
606 | for example the following forms are equivalent |
|
606 | for example the following forms are equivalent | |
607 |
|
607 | |||
608 | %psearch -i a* function |
|
608 | %psearch -i a* function | |
609 | -i a* function? |
|
609 | -i a* function? | |
610 | ?-i a* function |
|
610 | ?-i a* function | |
611 |
|
611 | |||
612 | Arguments: |
|
612 | Arguments: | |
613 |
|
613 | |||
614 | PATTERN |
|
614 | PATTERN | |
615 |
|
615 | |||
616 | where PATTERN is a string containing * as a wildcard similar to its |
|
616 | where PATTERN is a string containing * as a wildcard similar to its | |
617 | use in a shell. The pattern is matched in all namespaces on the |
|
617 | use in a shell. The pattern is matched in all namespaces on the | |
618 | search path. By default objects starting with a single _ are not |
|
618 | search path. By default objects starting with a single _ are not | |
619 | matched, many IPython generated objects have a single |
|
619 | matched, many IPython generated objects have a single | |
620 | underscore. The default is case insensitive matching. Matching is |
|
620 | underscore. The default is case insensitive matching. Matching is | |
621 | also done on the attributes of objects and not only on the objects |
|
621 | also done on the attributes of objects and not only on the objects | |
622 | in a module. |
|
622 | in a module. | |
623 |
|
623 | |||
624 | [OBJECT TYPE] |
|
624 | [OBJECT TYPE] | |
625 |
|
625 | |||
626 | Is the name of a python type from the types module. The name is |
|
626 | Is the name of a python type from the types module. The name is | |
627 | given in lowercase without the ending type, ex. StringType is |
|
627 | given in lowercase without the ending type, ex. StringType is | |
628 | written string. By adding a type here only objects matching the |
|
628 | written string. By adding a type here only objects matching the | |
629 | given type are matched. Using all here makes the pattern match all |
|
629 | given type are matched. Using all here makes the pattern match all | |
630 | types (this is the default). |
|
630 | types (this is the default). | |
631 |
|
631 | |||
632 | Options: |
|
632 | Options: | |
633 |
|
633 | |||
634 | -a: makes the pattern match even objects whose names start with a |
|
634 | -a: makes the pattern match even objects whose names start with a | |
635 | single underscore. These names are normally ommitted from the |
|
635 | single underscore. These names are normally ommitted from the | |
636 | search. |
|
636 | search. | |
637 |
|
637 | |||
638 | -i/-c: make the pattern case insensitive/sensitive. If neither of |
|
638 | -i/-c: make the pattern case insensitive/sensitive. If neither of | |
639 | these options is given, the default is read from your ipythonrc |
|
639 | these options is given, the default is read from your ipythonrc | |
640 | file. The option name which sets this value is |
|
640 | file. The option name which sets this value is | |
641 | 'wildcards_case_sensitive'. If this option is not specified in your |
|
641 | 'wildcards_case_sensitive'. If this option is not specified in your | |
642 | ipythonrc file, IPython's internal default is to do a case sensitive |
|
642 | ipythonrc file, IPython's internal default is to do a case sensitive | |
643 | search. |
|
643 | search. | |
644 |
|
644 | |||
645 | -e/-s NAMESPACE: exclude/search a given namespace. The pattern you |
|
645 | -e/-s NAMESPACE: exclude/search a given namespace. The pattern you | |
646 | specifiy can be searched in any of the following namespaces: |
|
646 | specifiy can be searched in any of the following namespaces: | |
647 | 'builtin', 'user', 'user_global','internal', 'alias', where |
|
647 | 'builtin', 'user', 'user_global','internal', 'alias', where | |
648 | 'builtin' and 'user' are the search defaults. Note that you should |
|
648 | 'builtin' and 'user' are the search defaults. Note that you should | |
649 | not use quotes when specifying namespaces. |
|
649 | not use quotes when specifying namespaces. | |
650 |
|
650 | |||
651 | 'Builtin' contains the python module builtin, 'user' contains all |
|
651 | 'Builtin' contains the python module builtin, 'user' contains all | |
652 | user data, 'alias' only contain the shell aliases and no python |
|
652 | user data, 'alias' only contain the shell aliases and no python | |
653 | objects, 'internal' contains objects used by IPython. The |
|
653 | objects, 'internal' contains objects used by IPython. The | |
654 | 'user_global' namespace is only used by embedded IPython instances, |
|
654 | 'user_global' namespace is only used by embedded IPython instances, | |
655 | and it contains module-level globals. You can add namespaces to the |
|
655 | and it contains module-level globals. You can add namespaces to the | |
656 | search with -s or exclude them with -e (these options can be given |
|
656 | search with -s or exclude them with -e (these options can be given | |
657 | more than once). |
|
657 | more than once). | |
658 |
|
658 | |||
659 | Examples: |
|
659 | Examples: | |
660 |
|
660 | |||
661 | %psearch a* -> objects beginning with an a |
|
661 | %psearch a* -> objects beginning with an a | |
662 | %psearch -e builtin a* -> objects NOT in the builtin space starting in a |
|
662 | %psearch -e builtin a* -> objects NOT in the builtin space starting in a | |
663 | %psearch a* function -> all functions beginning with an a |
|
663 | %psearch a* function -> all functions beginning with an a | |
664 | %psearch re.e* -> objects beginning with an e in module re |
|
664 | %psearch re.e* -> objects beginning with an e in module re | |
665 | %psearch r*.e* -> objects that start with e in modules starting in r |
|
665 | %psearch r*.e* -> objects that start with e in modules starting in r | |
666 | %psearch r*.* string -> all strings in modules beginning with r |
|
666 | %psearch r*.* string -> all strings in modules beginning with r | |
667 |
|
667 | |||
668 | Case sensitve search: |
|
668 | Case sensitve search: | |
669 |
|
669 | |||
670 | %psearch -c a* list all object beginning with lower case a |
|
670 | %psearch -c a* list all object beginning with lower case a | |
671 |
|
671 | |||
672 | Show objects beginning with a single _: |
|
672 | Show objects beginning with a single _: | |
673 |
|
673 | |||
674 | %psearch -a _* list objects beginning with a single underscore""" |
|
674 | %psearch -a _* list objects beginning with a single underscore""" | |
675 | try: |
|
675 | try: | |
676 | parameter_s = parameter_s.encode('ascii') |
|
676 | parameter_s = parameter_s.encode('ascii') | |
677 | except UnicodeEncodeError: |
|
677 | except UnicodeEncodeError: | |
678 | print 'Python identifiers can only contain ascii characters.' |
|
678 | print 'Python identifiers can only contain ascii characters.' | |
679 | return |
|
679 | return | |
680 |
|
680 | |||
681 | # default namespaces to be searched |
|
681 | # default namespaces to be searched | |
682 | def_search = ['user','builtin'] |
|
682 | def_search = ['user','builtin'] | |
683 |
|
683 | |||
684 | # Process options/args |
|
684 | # Process options/args | |
685 | opts,args = self.parse_options(parameter_s,'cias:e:',list_all=True) |
|
685 | opts,args = self.parse_options(parameter_s,'cias:e:',list_all=True) | |
686 | opt = opts.get |
|
686 | opt = opts.get | |
687 | shell = self.shell |
|
687 | shell = self.shell | |
688 | psearch = shell.inspector.psearch |
|
688 | psearch = shell.inspector.psearch | |
689 |
|
689 | |||
690 | # select case options |
|
690 | # select case options | |
691 | if opts.has_key('i'): |
|
691 | if opts.has_key('i'): | |
692 | ignore_case = True |
|
692 | ignore_case = True | |
693 | elif opts.has_key('c'): |
|
693 | elif opts.has_key('c'): | |
694 | ignore_case = False |
|
694 | ignore_case = False | |
695 | else: |
|
695 | else: | |
696 | ignore_case = not shell.rc.wildcards_case_sensitive |
|
696 | ignore_case = not shell.rc.wildcards_case_sensitive | |
697 |
|
697 | |||
698 | # Build list of namespaces to search from user options |
|
698 | # Build list of namespaces to search from user options | |
699 | def_search.extend(opt('s',[])) |
|
699 | def_search.extend(opt('s',[])) | |
700 | ns_exclude = ns_exclude=opt('e',[]) |
|
700 | ns_exclude = ns_exclude=opt('e',[]) | |
701 | ns_search = [nm for nm in def_search if nm not in ns_exclude] |
|
701 | ns_search = [nm for nm in def_search if nm not in ns_exclude] | |
702 |
|
702 | |||
703 | # Call the actual search |
|
703 | # Call the actual search | |
704 | try: |
|
704 | try: | |
705 | psearch(args,shell.ns_table,ns_search, |
|
705 | psearch(args,shell.ns_table,ns_search, | |
706 | show_all=opt('a'),ignore_case=ignore_case) |
|
706 | show_all=opt('a'),ignore_case=ignore_case) | |
707 | except: |
|
707 | except: | |
708 | shell.showtraceback() |
|
708 | shell.showtraceback() | |
709 |
|
709 | |||
710 | def magic_who_ls(self, parameter_s=''): |
|
710 | def magic_who_ls(self, parameter_s=''): | |
711 | """Return a sorted list of all interactive variables. |
|
711 | """Return a sorted list of all interactive variables. | |
712 |
|
712 | |||
713 | If arguments are given, only variables of types matching these |
|
713 | If arguments are given, only variables of types matching these | |
714 | arguments are returned.""" |
|
714 | arguments are returned.""" | |
715 |
|
715 | |||
716 | user_ns = self.shell.user_ns |
|
716 | user_ns = self.shell.user_ns | |
717 | internal_ns = self.shell.internal_ns |
|
717 | internal_ns = self.shell.internal_ns | |
718 | user_config_ns = self.shell.user_config_ns |
|
718 | user_config_ns = self.shell.user_config_ns | |
719 | out = [] |
|
719 | out = [] | |
720 | typelist = parameter_s.split() |
|
720 | typelist = parameter_s.split() | |
721 |
|
721 | |||
722 | for i in user_ns: |
|
722 | for i in user_ns: | |
723 | if not (i.startswith('_') or i.startswith('_i')) \ |
|
723 | if not (i.startswith('_') or i.startswith('_i')) \ | |
724 | and not (i in internal_ns or i in user_config_ns): |
|
724 | and not (i in internal_ns or i in user_config_ns): | |
725 | if typelist: |
|
725 | if typelist: | |
726 | if type(user_ns[i]).__name__ in typelist: |
|
726 | if type(user_ns[i]).__name__ in typelist: | |
727 | out.append(i) |
|
727 | out.append(i) | |
728 | else: |
|
728 | else: | |
729 | out.append(i) |
|
729 | out.append(i) | |
730 | out.sort() |
|
730 | out.sort() | |
731 | return out |
|
731 | return out | |
732 |
|
732 | |||
733 | def magic_who(self, parameter_s=''): |
|
733 | def magic_who(self, parameter_s=''): | |
734 | """Print all interactive variables, with some minimal formatting. |
|
734 | """Print all interactive variables, with some minimal formatting. | |
735 |
|
735 | |||
736 | If any arguments are given, only variables whose type matches one of |
|
736 | If any arguments are given, only variables whose type matches one of | |
737 | these are printed. For example: |
|
737 | these are printed. For example: | |
738 |
|
738 | |||
739 | %who function str |
|
739 | %who function str | |
740 |
|
740 | |||
741 | will only list functions and strings, excluding all other types of |
|
741 | will only list functions and strings, excluding all other types of | |
742 | variables. To find the proper type names, simply use type(var) at a |
|
742 | variables. To find the proper type names, simply use type(var) at a | |
743 | command line to see how python prints type names. For example: |
|
743 | command line to see how python prints type names. For example: | |
744 |
|
744 | |||
745 | In [1]: type('hello')\\ |
|
745 | In [1]: type('hello')\\ | |
746 | Out[1]: <type 'str'> |
|
746 | Out[1]: <type 'str'> | |
747 |
|
747 | |||
748 | indicates that the type name for strings is 'str'. |
|
748 | indicates that the type name for strings is 'str'. | |
749 |
|
749 | |||
750 | %who always excludes executed names loaded through your configuration |
|
750 | %who always excludes executed names loaded through your configuration | |
751 | file and things which are internal to IPython. |
|
751 | file and things which are internal to IPython. | |
752 |
|
752 | |||
753 | This is deliberate, as typically you may load many modules and the |
|
753 | This is deliberate, as typically you may load many modules and the | |
754 | purpose of %who is to show you only what you've manually defined.""" |
|
754 | purpose of %who is to show you only what you've manually defined.""" | |
755 |
|
755 | |||
756 | varlist = self.magic_who_ls(parameter_s) |
|
756 | varlist = self.magic_who_ls(parameter_s) | |
757 | if not varlist: |
|
757 | if not varlist: | |
758 | if parameter_s: |
|
758 | if parameter_s: | |
759 | print 'No variables match your requested type.' |
|
759 | print 'No variables match your requested type.' | |
760 | else: |
|
760 | else: | |
761 | print 'Interactive namespace is empty.' |
|
761 | print 'Interactive namespace is empty.' | |
762 | return |
|
762 | return | |
763 |
|
763 | |||
764 | # if we have variables, move on... |
|
764 | # if we have variables, move on... | |
765 | count = 0 |
|
765 | count = 0 | |
766 | for i in varlist: |
|
766 | for i in varlist: | |
767 | print i+'\t', |
|
767 | print i+'\t', | |
768 | count += 1 |
|
768 | count += 1 | |
769 | if count > 8: |
|
769 | if count > 8: | |
770 | count = 0 |
|
770 | count = 0 | |
771 |
|
771 | |||
772 |
|
772 | |||
773 |
|
773 | |||
774 | def magic_whos(self, parameter_s=''): |
|
774 | def magic_whos(self, parameter_s=''): | |
775 | """Like %who, but gives some extra information about each variable. |
|
775 | """Like %who, but gives some extra information about each variable. | |
776 |
|
776 | |||
777 | The same type filtering of %who can be applied here. |
|
777 | The same type filtering of %who can be applied here. | |
778 |
|
778 | |||
779 | For all variables, the type is printed. Additionally it prints: |
|
779 | For all variables, the type is printed. Additionally it prints: | |
780 |
|
780 | |||
781 | - For {},[],(): their length. |
|
781 | - For {},[],(): their length. | |
782 |
|
782 | |||
783 | - For numpy and Numeric arrays, a summary with shape, number of |
|
783 | - For numpy and Numeric arrays, a summary with shape, number of | |
784 | elements, typecode and size in memory. |
|
784 | elements, typecode and size in memory. | |
785 |
|
785 | |||
786 | - Everything else: a string representation, snipping their middle if |
|
786 | - Everything else: a string representation, snipping their middle if | |
787 | too long.""" |
|
787 | too long.""" | |
788 |
|
788 | |||
789 | varnames = self.magic_who_ls(parameter_s) |
|
789 | varnames = self.magic_who_ls(parameter_s) | |
790 | if not varnames: |
|
790 | if not varnames: | |
791 | if parameter_s: |
|
791 | if parameter_s: | |
792 | print 'No variables match your requested type.' |
|
792 | print 'No variables match your requested type.' | |
793 | else: |
|
793 | else: | |
794 | print 'Interactive namespace is empty.' |
|
794 | print 'Interactive namespace is empty.' | |
795 | return |
|
795 | return | |
796 |
|
796 | |||
797 | # if we have variables, move on... |
|
797 | # if we have variables, move on... | |
798 |
|
798 | |||
799 | # for these types, show len() instead of data: |
|
799 | # for these types, show len() instead of data: | |
800 | seq_types = [types.DictType,types.ListType,types.TupleType] |
|
800 | seq_types = [types.DictType,types.ListType,types.TupleType] | |
801 |
|
801 | |||
802 | # for numpy/Numeric arrays, display summary info |
|
802 | # for numpy/Numeric arrays, display summary info | |
803 | try: |
|
803 | try: | |
804 | import numpy |
|
804 | import numpy | |
805 | except ImportError: |
|
805 | except ImportError: | |
806 | ndarray_type = None |
|
806 | ndarray_type = None | |
807 | else: |
|
807 | else: | |
808 | ndarray_type = numpy.ndarray.__name__ |
|
808 | ndarray_type = numpy.ndarray.__name__ | |
809 | try: |
|
809 | try: | |
810 | import Numeric |
|
810 | import Numeric | |
811 | except ImportError: |
|
811 | except ImportError: | |
812 | array_type = None |
|
812 | array_type = None | |
813 | else: |
|
813 | else: | |
814 | array_type = Numeric.ArrayType.__name__ |
|
814 | array_type = Numeric.ArrayType.__name__ | |
815 |
|
815 | |||
816 | # Find all variable names and types so we can figure out column sizes |
|
816 | # Find all variable names and types so we can figure out column sizes | |
817 | def get_vars(i): |
|
817 | def get_vars(i): | |
818 | return self.shell.user_ns[i] |
|
818 | return self.shell.user_ns[i] | |
819 |
|
819 | |||
820 | # some types are well known and can be shorter |
|
820 | # some types are well known and can be shorter | |
821 | abbrevs = {'IPython.macro.Macro' : 'Macro'} |
|
821 | abbrevs = {'IPython.macro.Macro' : 'Macro'} | |
822 | def type_name(v): |
|
822 | def type_name(v): | |
823 | tn = type(v).__name__ |
|
823 | tn = type(v).__name__ | |
824 | return abbrevs.get(tn,tn) |
|
824 | return abbrevs.get(tn,tn) | |
825 |
|
825 | |||
826 | varlist = map(get_vars,varnames) |
|
826 | varlist = map(get_vars,varnames) | |
827 |
|
827 | |||
828 | typelist = [] |
|
828 | typelist = [] | |
829 | for vv in varlist: |
|
829 | for vv in varlist: | |
830 | tt = type_name(vv) |
|
830 | tt = type_name(vv) | |
831 |
|
831 | |||
832 | if tt=='instance': |
|
832 | if tt=='instance': | |
833 | typelist.append( abbrevs.get(str(vv.__class__), |
|
833 | typelist.append( abbrevs.get(str(vv.__class__), | |
834 | str(vv.__class__))) |
|
834 | str(vv.__class__))) | |
835 | else: |
|
835 | else: | |
836 | typelist.append(tt) |
|
836 | typelist.append(tt) | |
837 |
|
837 | |||
838 | # column labels and # of spaces as separator |
|
838 | # column labels and # of spaces as separator | |
839 | varlabel = 'Variable' |
|
839 | varlabel = 'Variable' | |
840 | typelabel = 'Type' |
|
840 | typelabel = 'Type' | |
841 | datalabel = 'Data/Info' |
|
841 | datalabel = 'Data/Info' | |
842 | colsep = 3 |
|
842 | colsep = 3 | |
843 | # variable format strings |
|
843 | # variable format strings | |
844 | vformat = "$vname.ljust(varwidth)$vtype.ljust(typewidth)" |
|
844 | vformat = "$vname.ljust(varwidth)$vtype.ljust(typewidth)" | |
845 | vfmt_short = '$vstr[:25]<...>$vstr[-25:]' |
|
845 | vfmt_short = '$vstr[:25]<...>$vstr[-25:]' | |
846 | aformat = "%s: %s elems, type `%s`, %s bytes" |
|
846 | aformat = "%s: %s elems, type `%s`, %s bytes" | |
847 | # find the size of the columns to format the output nicely |
|
847 | # find the size of the columns to format the output nicely | |
848 | varwidth = max(max(map(len,varnames)), len(varlabel)) + colsep |
|
848 | varwidth = max(max(map(len,varnames)), len(varlabel)) + colsep | |
849 | typewidth = max(max(map(len,typelist)), len(typelabel)) + colsep |
|
849 | typewidth = max(max(map(len,typelist)), len(typelabel)) + colsep | |
850 | # table header |
|
850 | # table header | |
851 | print varlabel.ljust(varwidth) + typelabel.ljust(typewidth) + \ |
|
851 | print varlabel.ljust(varwidth) + typelabel.ljust(typewidth) + \ | |
852 | ' '+datalabel+'\n' + '-'*(varwidth+typewidth+len(datalabel)+1) |
|
852 | ' '+datalabel+'\n' + '-'*(varwidth+typewidth+len(datalabel)+1) | |
853 | # and the table itself |
|
853 | # and the table itself | |
854 | kb = 1024 |
|
854 | kb = 1024 | |
855 | Mb = 1048576 # kb**2 |
|
855 | Mb = 1048576 # kb**2 | |
856 | for vname,var,vtype in zip(varnames,varlist,typelist): |
|
856 | for vname,var,vtype in zip(varnames,varlist,typelist): | |
857 | print itpl(vformat), |
|
857 | print itpl(vformat), | |
858 | if vtype in seq_types: |
|
858 | if vtype in seq_types: | |
859 | print len(var) |
|
859 | print len(var) | |
860 | elif vtype in [array_type,ndarray_type]: |
|
860 | elif vtype in [array_type,ndarray_type]: | |
861 | vshape = str(var.shape).replace(',','').replace(' ','x')[1:-1] |
|
861 | vshape = str(var.shape).replace(',','').replace(' ','x')[1:-1] | |
862 | if vtype==ndarray_type: |
|
862 | if vtype==ndarray_type: | |
863 | # numpy |
|
863 | # numpy | |
864 | vsize = var.size |
|
864 | vsize = var.size | |
865 | vbytes = vsize*var.itemsize |
|
865 | vbytes = vsize*var.itemsize | |
866 | vdtype = var.dtype |
|
866 | vdtype = var.dtype | |
867 | else: |
|
867 | else: | |
868 | # Numeric |
|
868 | # Numeric | |
869 | vsize = Numeric.size(var) |
|
869 | vsize = Numeric.size(var) | |
870 | vbytes = vsize*var.itemsize() |
|
870 | vbytes = vsize*var.itemsize() | |
871 | vdtype = var.typecode() |
|
871 | vdtype = var.typecode() | |
872 |
|
872 | |||
873 | if vbytes < 100000: |
|
873 | if vbytes < 100000: | |
874 | print aformat % (vshape,vsize,vdtype,vbytes) |
|
874 | print aformat % (vshape,vsize,vdtype,vbytes) | |
875 | else: |
|
875 | else: | |
876 | print aformat % (vshape,vsize,vdtype,vbytes), |
|
876 | print aformat % (vshape,vsize,vdtype,vbytes), | |
877 | if vbytes < Mb: |
|
877 | if vbytes < Mb: | |
878 | print '(%s kb)' % (vbytes/kb,) |
|
878 | print '(%s kb)' % (vbytes/kb,) | |
879 | else: |
|
879 | else: | |
880 | print '(%s Mb)' % (vbytes/Mb,) |
|
880 | print '(%s Mb)' % (vbytes/Mb,) | |
881 | else: |
|
881 | else: | |
882 | try: |
|
882 | try: | |
883 | vstr = str(var) |
|
883 | vstr = str(var) | |
884 | except UnicodeEncodeError: |
|
884 | except UnicodeEncodeError: | |
885 | vstr = unicode(var).encode(sys.getdefaultencoding(), |
|
885 | vstr = unicode(var).encode(sys.getdefaultencoding(), | |
886 | 'backslashreplace') |
|
886 | 'backslashreplace') | |
887 | vstr = vstr.replace('\n','\\n') |
|
887 | vstr = vstr.replace('\n','\\n') | |
888 | if len(vstr) < 50: |
|
888 | if len(vstr) < 50: | |
889 | print vstr |
|
889 | print vstr | |
890 | else: |
|
890 | else: | |
891 | printpl(vfmt_short) |
|
891 | printpl(vfmt_short) | |
892 |
|
892 | |||
893 | def magic_reset(self, parameter_s=''): |
|
893 | def magic_reset(self, parameter_s=''): | |
894 | """Resets the namespace by removing all names defined by the user. |
|
894 | """Resets the namespace by removing all names defined by the user. | |
895 |
|
895 | |||
896 | Input/Output history are left around in case you need them.""" |
|
896 | Input/Output history are left around in case you need them.""" | |
897 |
|
897 | |||
898 | ans = self.shell.ask_yes_no( |
|
898 | ans = self.shell.ask_yes_no( | |
899 | "Once deleted, variables cannot be recovered. Proceed (y/[n])? ") |
|
899 | "Once deleted, variables cannot be recovered. Proceed (y/[n])? ") | |
900 | if not ans: |
|
900 | if not ans: | |
901 | print 'Nothing done.' |
|
901 | print 'Nothing done.' | |
902 | return |
|
902 | return | |
903 | user_ns = self.shell.user_ns |
|
903 | user_ns = self.shell.user_ns | |
904 | for i in self.magic_who_ls(): |
|
904 | for i in self.magic_who_ls(): | |
905 | del(user_ns[i]) |
|
905 | del(user_ns[i]) | |
906 |
|
906 | |||
907 | def magic_logstart(self,parameter_s=''): |
|
907 | def magic_logstart(self,parameter_s=''): | |
908 | """Start logging anywhere in a session. |
|
908 | """Start logging anywhere in a session. | |
909 |
|
909 | |||
910 | %logstart [-o|-r|-t] [log_name [log_mode]] |
|
910 | %logstart [-o|-r|-t] [log_name [log_mode]] | |
911 |
|
911 | |||
912 | If no name is given, it defaults to a file named 'ipython_log.py' in your |
|
912 | If no name is given, it defaults to a file named 'ipython_log.py' in your | |
913 | current directory, in 'rotate' mode (see below). |
|
913 | current directory, in 'rotate' mode (see below). | |
914 |
|
914 | |||
915 | '%logstart name' saves to file 'name' in 'backup' mode. It saves your |
|
915 | '%logstart name' saves to file 'name' in 'backup' mode. It saves your | |
916 | history up to that point and then continues logging. |
|
916 | history up to that point and then continues logging. | |
917 |
|
917 | |||
918 | %logstart takes a second optional parameter: logging mode. This can be one |
|
918 | %logstart takes a second optional parameter: logging mode. This can be one | |
919 | of (note that the modes are given unquoted):\\ |
|
919 | of (note that the modes are given unquoted):\\ | |
920 | append: well, that says it.\\ |
|
920 | append: well, that says it.\\ | |
921 | backup: rename (if exists) to name~ and start name.\\ |
|
921 | backup: rename (if exists) to name~ and start name.\\ | |
922 | global: single logfile in your home dir, appended to.\\ |
|
922 | global: single logfile in your home dir, appended to.\\ | |
923 | over : overwrite existing log.\\ |
|
923 | over : overwrite existing log.\\ | |
924 | rotate: create rotating logs name.1~, name.2~, etc. |
|
924 | rotate: create rotating logs name.1~, name.2~, etc. | |
925 |
|
925 | |||
926 | Options: |
|
926 | Options: | |
927 |
|
927 | |||
928 | -o: log also IPython's output. In this mode, all commands which |
|
928 | -o: log also IPython's output. In this mode, all commands which | |
929 | generate an Out[NN] prompt are recorded to the logfile, right after |
|
929 | generate an Out[NN] prompt are recorded to the logfile, right after | |
930 | their corresponding input line. The output lines are always |
|
930 | their corresponding input line. The output lines are always | |
931 | prepended with a '#[Out]# ' marker, so that the log remains valid |
|
931 | prepended with a '#[Out]# ' marker, so that the log remains valid | |
932 | Python code. |
|
932 | Python code. | |
933 |
|
933 | |||
934 | Since this marker is always the same, filtering only the output from |
|
934 | Since this marker is always the same, filtering only the output from | |
935 | a log is very easy, using for example a simple awk call: |
|
935 | a log is very easy, using for example a simple awk call: | |
936 |
|
936 | |||
937 | awk -F'#\\[Out\\]# ' '{if($2) {print $2}}' ipython_log.py |
|
937 | awk -F'#\\[Out\\]# ' '{if($2) {print $2}}' ipython_log.py | |
938 |
|
938 | |||
939 | -r: log 'raw' input. Normally, IPython's logs contain the processed |
|
939 | -r: log 'raw' input. Normally, IPython's logs contain the processed | |
940 | input, so that user lines are logged in their final form, converted |
|
940 | input, so that user lines are logged in their final form, converted | |
941 | into valid Python. For example, %Exit is logged as |
|
941 | into valid Python. For example, %Exit is logged as | |
942 | '_ip.magic("Exit"). If the -r flag is given, all input is logged |
|
942 | '_ip.magic("Exit"). If the -r flag is given, all input is logged | |
943 | exactly as typed, with no transformations applied. |
|
943 | exactly as typed, with no transformations applied. | |
944 |
|
944 | |||
945 | -t: put timestamps before each input line logged (these are put in |
|
945 | -t: put timestamps before each input line logged (these are put in | |
946 | comments).""" |
|
946 | comments).""" | |
947 |
|
947 | |||
948 | opts,par = self.parse_options(parameter_s,'ort') |
|
948 | opts,par = self.parse_options(parameter_s,'ort') | |
949 | log_output = 'o' in opts |
|
949 | log_output = 'o' in opts | |
950 | log_raw_input = 'r' in opts |
|
950 | log_raw_input = 'r' in opts | |
951 | timestamp = 't' in opts |
|
951 | timestamp = 't' in opts | |
952 |
|
952 | |||
953 | rc = self.shell.rc |
|
953 | rc = self.shell.rc | |
954 | logger = self.shell.logger |
|
954 | logger = self.shell.logger | |
955 |
|
955 | |||
956 | # if no args are given, the defaults set in the logger constructor by |
|
956 | # if no args are given, the defaults set in the logger constructor by | |
957 | # ipytohn remain valid |
|
957 | # ipytohn remain valid | |
958 | if par: |
|
958 | if par: | |
959 | try: |
|
959 | try: | |
960 | logfname,logmode = par.split() |
|
960 | logfname,logmode = par.split() | |
961 | except: |
|
961 | except: | |
962 | logfname = par |
|
962 | logfname = par | |
963 | logmode = 'backup' |
|
963 | logmode = 'backup' | |
964 | else: |
|
964 | else: | |
965 | logfname = logger.logfname |
|
965 | logfname = logger.logfname | |
966 | logmode = logger.logmode |
|
966 | logmode = logger.logmode | |
967 | # put logfname into rc struct as if it had been called on the command |
|
967 | # put logfname into rc struct as if it had been called on the command | |
968 | # line, so it ends up saved in the log header Save it in case we need |
|
968 | # line, so it ends up saved in the log header Save it in case we need | |
969 | # to restore it... |
|
969 | # to restore it... | |
970 | old_logfile = rc.opts.get('logfile','') |
|
970 | old_logfile = rc.opts.get('logfile','') | |
971 | if logfname: |
|
971 | if logfname: | |
972 | logfname = os.path.expanduser(logfname) |
|
972 | logfname = os.path.expanduser(logfname) | |
973 | rc.opts.logfile = logfname |
|
973 | rc.opts.logfile = logfname | |
974 | loghead = self.shell.loghead_tpl % (rc.opts,rc.args) |
|
974 | loghead = self.shell.loghead_tpl % (rc.opts,rc.args) | |
975 | try: |
|
975 | try: | |
976 | started = logger.logstart(logfname,loghead,logmode, |
|
976 | started = logger.logstart(logfname,loghead,logmode, | |
977 | log_output,timestamp,log_raw_input) |
|
977 | log_output,timestamp,log_raw_input) | |
978 | except: |
|
978 | except: | |
979 | rc.opts.logfile = old_logfile |
|
979 | rc.opts.logfile = old_logfile | |
980 | warn("Couldn't start log: %s" % sys.exc_info()[1]) |
|
980 | warn("Couldn't start log: %s" % sys.exc_info()[1]) | |
981 | else: |
|
981 | else: | |
982 | # log input history up to this point, optionally interleaving |
|
982 | # log input history up to this point, optionally interleaving | |
983 | # output if requested |
|
983 | # output if requested | |
984 |
|
984 | |||
985 | if timestamp: |
|
985 | if timestamp: | |
986 | # disable timestamping for the previous history, since we've |
|
986 | # disable timestamping for the previous history, since we've | |
987 | # lost those already (no time machine here). |
|
987 | # lost those already (no time machine here). | |
988 | logger.timestamp = False |
|
988 | logger.timestamp = False | |
989 |
|
989 | |||
990 | if log_raw_input: |
|
990 | if log_raw_input: | |
991 | input_hist = self.shell.input_hist_raw |
|
991 | input_hist = self.shell.input_hist_raw | |
992 | else: |
|
992 | else: | |
993 | input_hist = self.shell.input_hist |
|
993 | input_hist = self.shell.input_hist | |
994 |
|
994 | |||
995 | if log_output: |
|
995 | if log_output: | |
996 | log_write = logger.log_write |
|
996 | log_write = logger.log_write | |
997 | output_hist = self.shell.output_hist |
|
997 | output_hist = self.shell.output_hist | |
998 | for n in range(1,len(input_hist)-1): |
|
998 | for n in range(1,len(input_hist)-1): | |
999 | log_write(input_hist[n].rstrip()) |
|
999 | log_write(input_hist[n].rstrip()) | |
1000 | if n in output_hist: |
|
1000 | if n in output_hist: | |
1001 | log_write(repr(output_hist[n]),'output') |
|
1001 | log_write(repr(output_hist[n]),'output') | |
1002 | else: |
|
1002 | else: | |
1003 | logger.log_write(input_hist[1:]) |
|
1003 | logger.log_write(input_hist[1:]) | |
1004 | if timestamp: |
|
1004 | if timestamp: | |
1005 | # re-enable timestamping |
|
1005 | # re-enable timestamping | |
1006 | logger.timestamp = True |
|
1006 | logger.timestamp = True | |
1007 |
|
1007 | |||
1008 | print ('Activating auto-logging. ' |
|
1008 | print ('Activating auto-logging. ' | |
1009 | 'Current session state plus future input saved.') |
|
1009 | 'Current session state plus future input saved.') | |
1010 | logger.logstate() |
|
1010 | logger.logstate() | |
1011 |
|
1011 | |||
1012 | def magic_logoff(self,parameter_s=''): |
|
1012 | def magic_logoff(self,parameter_s=''): | |
1013 | """Temporarily stop logging. |
|
1013 | """Temporarily stop logging. | |
1014 |
|
1014 | |||
1015 | You must have previously started logging.""" |
|
1015 | You must have previously started logging.""" | |
1016 | self.shell.logger.switch_log(0) |
|
1016 | self.shell.logger.switch_log(0) | |
1017 |
|
1017 | |||
1018 | def magic_logon(self,parameter_s=''): |
|
1018 | def magic_logon(self,parameter_s=''): | |
1019 | """Restart logging. |
|
1019 | """Restart logging. | |
1020 |
|
1020 | |||
1021 | This function is for restarting logging which you've temporarily |
|
1021 | This function is for restarting logging which you've temporarily | |
1022 | stopped with %logoff. For starting logging for the first time, you |
|
1022 | stopped with %logoff. For starting logging for the first time, you | |
1023 | must use the %logstart function, which allows you to specify an |
|
1023 | must use the %logstart function, which allows you to specify an | |
1024 | optional log filename.""" |
|
1024 | optional log filename.""" | |
1025 |
|
1025 | |||
1026 | self.shell.logger.switch_log(1) |
|
1026 | self.shell.logger.switch_log(1) | |
1027 |
|
1027 | |||
1028 | def magic_logstate(self,parameter_s=''): |
|
1028 | def magic_logstate(self,parameter_s=''): | |
1029 | """Print the status of the logging system.""" |
|
1029 | """Print the status of the logging system.""" | |
1030 |
|
1030 | |||
1031 | self.shell.logger.logstate() |
|
1031 | self.shell.logger.logstate() | |
1032 |
|
1032 | |||
1033 | def magic_pdb(self, parameter_s=''): |
|
1033 | def magic_pdb(self, parameter_s=''): | |
1034 | """Control the automatic calling of the pdb interactive debugger. |
|
1034 | """Control the automatic calling of the pdb interactive debugger. | |
1035 |
|
1035 | |||
1036 | Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without |
|
1036 | Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without | |
1037 | argument it works as a toggle. |
|
1037 | argument it works as a toggle. | |
1038 |
|
1038 | |||
1039 | When an exception is triggered, IPython can optionally call the |
|
1039 | When an exception is triggered, IPython can optionally call the | |
1040 | interactive pdb debugger after the traceback printout. %pdb toggles |
|
1040 | interactive pdb debugger after the traceback printout. %pdb toggles | |
1041 | this feature on and off. |
|
1041 | this feature on and off. | |
1042 |
|
1042 | |||
1043 | The initial state of this feature is set in your ipythonrc |
|
1043 | The initial state of this feature is set in your ipythonrc | |
1044 | configuration file (the variable is called 'pdb'). |
|
1044 | configuration file (the variable is called 'pdb'). | |
1045 |
|
1045 | |||
1046 | If you want to just activate the debugger AFTER an exception has fired, |
|
1046 | If you want to just activate the debugger AFTER an exception has fired, | |
1047 | without having to type '%pdb on' and rerunning your code, you can use |
|
1047 | without having to type '%pdb on' and rerunning your code, you can use | |
1048 | the %debug magic.""" |
|
1048 | the %debug magic.""" | |
1049 |
|
1049 | |||
1050 | par = parameter_s.strip().lower() |
|
1050 | par = parameter_s.strip().lower() | |
1051 |
|
1051 | |||
1052 | if par: |
|
1052 | if par: | |
1053 | try: |
|
1053 | try: | |
1054 | new_pdb = {'off':0,'0':0,'on':1,'1':1}[par] |
|
1054 | new_pdb = {'off':0,'0':0,'on':1,'1':1}[par] | |
1055 | except KeyError: |
|
1055 | except KeyError: | |
1056 | print ('Incorrect argument. Use on/1, off/0, ' |
|
1056 | print ('Incorrect argument. Use on/1, off/0, ' | |
1057 | 'or nothing for a toggle.') |
|
1057 | 'or nothing for a toggle.') | |
1058 | return |
|
1058 | return | |
1059 | else: |
|
1059 | else: | |
1060 | # toggle |
|
1060 | # toggle | |
1061 | new_pdb = not self.shell.call_pdb |
|
1061 | new_pdb = not self.shell.call_pdb | |
1062 |
|
1062 | |||
1063 | # set on the shell |
|
1063 | # set on the shell | |
1064 | self.shell.call_pdb = new_pdb |
|
1064 | self.shell.call_pdb = new_pdb | |
1065 | print 'Automatic pdb calling has been turned',on_off(new_pdb) |
|
1065 | print 'Automatic pdb calling has been turned',on_off(new_pdb) | |
1066 |
|
1066 | |||
1067 | def magic_debug(self, parameter_s=''): |
|
1067 | def magic_debug(self, parameter_s=''): | |
1068 | """Activate the interactive debugger in post-mortem mode. |
|
1068 | """Activate the interactive debugger in post-mortem mode. | |
1069 |
|
1069 | |||
1070 | If an exception has just occurred, this lets you inspect its stack |
|
1070 | If an exception has just occurred, this lets you inspect its stack | |
1071 | frames interactively. Note that this will always work only on the last |
|
1071 | frames interactively. Note that this will always work only on the last | |
1072 | traceback that occurred, so you must call this quickly after an |
|
1072 | traceback that occurred, so you must call this quickly after an | |
1073 | exception that you wish to inspect has fired, because if another one |
|
1073 | exception that you wish to inspect has fired, because if another one | |
1074 | occurs, it clobbers the previous one. |
|
1074 | occurs, it clobbers the previous one. | |
1075 |
|
1075 | |||
1076 | If you want IPython to automatically do this on every exception, see |
|
1076 | If you want IPython to automatically do this on every exception, see | |
1077 | the %pdb magic for more details. |
|
1077 | the %pdb magic for more details. | |
1078 | """ |
|
1078 | """ | |
1079 |
|
1079 | |||
1080 | self.shell.debugger(force=True) |
|
1080 | self.shell.debugger(force=True) | |
1081 |
|
1081 | |||
1082 | def magic_prun(self, parameter_s ='',user_mode=1, |
|
1082 | def magic_prun(self, parameter_s ='',user_mode=1, | |
1083 | opts=None,arg_lst=None,prog_ns=None): |
|
1083 | opts=None,arg_lst=None,prog_ns=None): | |
1084 |
|
1084 | |||
1085 | """Run a statement through the python code profiler. |
|
1085 | """Run a statement through the python code profiler. | |
1086 |
|
1086 | |||
1087 | Usage:\\ |
|
1087 | Usage:\\ | |
1088 | %prun [options] statement |
|
1088 | %prun [options] statement | |
1089 |
|
1089 | |||
1090 | The given statement (which doesn't require quote marks) is run via the |
|
1090 | The given statement (which doesn't require quote marks) is run via the | |
1091 | python profiler in a manner similar to the profile.run() function. |
|
1091 | python profiler in a manner similar to the profile.run() function. | |
1092 | Namespaces are internally managed to work correctly; profile.run |
|
1092 | Namespaces are internally managed to work correctly; profile.run | |
1093 | cannot be used in IPython because it makes certain assumptions about |
|
1093 | cannot be used in IPython because it makes certain assumptions about | |
1094 | namespaces which do not hold under IPython. |
|
1094 | namespaces which do not hold under IPython. | |
1095 |
|
1095 | |||
1096 | Options: |
|
1096 | Options: | |
1097 |
|
1097 | |||
1098 | -l <limit>: you can place restrictions on what or how much of the |
|
1098 | -l <limit>: you can place restrictions on what or how much of the | |
1099 | profile gets printed. The limit value can be: |
|
1099 | profile gets printed. The limit value can be: | |
1100 |
|
1100 | |||
1101 | * A string: only information for function names containing this string |
|
1101 | * A string: only information for function names containing this string | |
1102 | is printed. |
|
1102 | is printed. | |
1103 |
|
1103 | |||
1104 | * An integer: only these many lines are printed. |
|
1104 | * An integer: only these many lines are printed. | |
1105 |
|
1105 | |||
1106 | * A float (between 0 and 1): this fraction of the report is printed |
|
1106 | * A float (between 0 and 1): this fraction of the report is printed | |
1107 | (for example, use a limit of 0.4 to see the topmost 40% only). |
|
1107 | (for example, use a limit of 0.4 to see the topmost 40% only). | |
1108 |
|
1108 | |||
1109 | You can combine several limits with repeated use of the option. For |
|
1109 | You can combine several limits with repeated use of the option. For | |
1110 | example, '-l __init__ -l 5' will print only the topmost 5 lines of |
|
1110 | example, '-l __init__ -l 5' will print only the topmost 5 lines of | |
1111 | information about class constructors. |
|
1111 | information about class constructors. | |
1112 |
|
1112 | |||
1113 | -r: return the pstats.Stats object generated by the profiling. This |
|
1113 | -r: return the pstats.Stats object generated by the profiling. This | |
1114 | object has all the information about the profile in it, and you can |
|
1114 | object has all the information about the profile in it, and you can | |
1115 | later use it for further analysis or in other functions. |
|
1115 | later use it for further analysis or in other functions. | |
1116 |
|
1116 | |||
1117 | -s <key>: sort profile by given key. You can provide more than one key |
|
1117 | -s <key>: sort profile by given key. You can provide more than one key | |
1118 | by using the option several times: '-s key1 -s key2 -s key3...'. The |
|
1118 | by using the option several times: '-s key1 -s key2 -s key3...'. The | |
1119 | default sorting key is 'time'. |
|
1119 | default sorting key is 'time'. | |
1120 |
|
1120 | |||
1121 | The following is copied verbatim from the profile documentation |
|
1121 | The following is copied verbatim from the profile documentation | |
1122 | referenced below: |
|
1122 | referenced below: | |
1123 |
|
1123 | |||
1124 | When more than one key is provided, additional keys are used as |
|
1124 | When more than one key is provided, additional keys are used as | |
1125 | secondary criteria when the there is equality in all keys selected |
|
1125 | secondary criteria when the there is equality in all keys selected | |
1126 | before them. |
|
1126 | before them. | |
1127 |
|
1127 | |||
1128 | Abbreviations can be used for any key names, as long as the |
|
1128 | Abbreviations can be used for any key names, as long as the | |
1129 | abbreviation is unambiguous. The following are the keys currently |
|
1129 | abbreviation is unambiguous. The following are the keys currently | |
1130 | defined: |
|
1130 | defined: | |
1131 |
|
1131 | |||
1132 | Valid Arg Meaning\\ |
|
1132 | Valid Arg Meaning\\ | |
1133 | "calls" call count\\ |
|
1133 | "calls" call count\\ | |
1134 | "cumulative" cumulative time\\ |
|
1134 | "cumulative" cumulative time\\ | |
1135 | "file" file name\\ |
|
1135 | "file" file name\\ | |
1136 | "module" file name\\ |
|
1136 | "module" file name\\ | |
1137 | "pcalls" primitive call count\\ |
|
1137 | "pcalls" primitive call count\\ | |
1138 | "line" line number\\ |
|
1138 | "line" line number\\ | |
1139 | "name" function name\\ |
|
1139 | "name" function name\\ | |
1140 | "nfl" name/file/line\\ |
|
1140 | "nfl" name/file/line\\ | |
1141 | "stdname" standard name\\ |
|
1141 | "stdname" standard name\\ | |
1142 | "time" internal time |
|
1142 | "time" internal time | |
1143 |
|
1143 | |||
1144 | Note that all sorts on statistics are in descending order (placing |
|
1144 | Note that all sorts on statistics are in descending order (placing | |
1145 | most time consuming items first), where as name, file, and line number |
|
1145 | most time consuming items first), where as name, file, and line number | |
1146 | searches are in ascending order (i.e., alphabetical). The subtle |
|
1146 | searches are in ascending order (i.e., alphabetical). The subtle | |
1147 | distinction between "nfl" and "stdname" is that the standard name is a |
|
1147 | distinction between "nfl" and "stdname" is that the standard name is a | |
1148 | sort of the name as printed, which means that the embedded line |
|
1148 | sort of the name as printed, which means that the embedded line | |
1149 | numbers get compared in an odd way. For example, lines 3, 20, and 40 |
|
1149 | numbers get compared in an odd way. For example, lines 3, 20, and 40 | |
1150 | would (if the file names were the same) appear in the string order |
|
1150 | would (if the file names were the same) appear in the string order | |
1151 | "20" "3" and "40". In contrast, "nfl" does a numeric compare of the |
|
1151 | "20" "3" and "40". In contrast, "nfl" does a numeric compare of the | |
1152 | line numbers. In fact, sort_stats("nfl") is the same as |
|
1152 | line numbers. In fact, sort_stats("nfl") is the same as | |
1153 | sort_stats("name", "file", "line"). |
|
1153 | sort_stats("name", "file", "line"). | |
1154 |
|
1154 | |||
1155 | -T <filename>: save profile results as shown on screen to a text |
|
1155 | -T <filename>: save profile results as shown on screen to a text | |
1156 | file. The profile is still shown on screen. |
|
1156 | file. The profile is still shown on screen. | |
1157 |
|
1157 | |||
1158 | -D <filename>: save (via dump_stats) profile statistics to given |
|
1158 | -D <filename>: save (via dump_stats) profile statistics to given | |
1159 | filename. This data is in a format understod by the pstats module, and |
|
1159 | filename. This data is in a format understod by the pstats module, and | |
1160 | is generated by a call to the dump_stats() method of profile |
|
1160 | is generated by a call to the dump_stats() method of profile | |
1161 | objects. The profile is still shown on screen. |
|
1161 | objects. The profile is still shown on screen. | |
1162 |
|
1162 | |||
1163 | If you want to run complete programs under the profiler's control, use |
|
1163 | If you want to run complete programs under the profiler's control, use | |
1164 | '%run -p [prof_opts] filename.py [args to program]' where prof_opts |
|
1164 | '%run -p [prof_opts] filename.py [args to program]' where prof_opts | |
1165 | contains profiler specific options as described here. |
|
1165 | contains profiler specific options as described here. | |
1166 |
|
1166 | |||
1167 | You can read the complete documentation for the profile module with:\\ |
|
1167 | You can read the complete documentation for the profile module with:\\ | |
1168 | In [1]: import profile; profile.help() """ |
|
1168 | In [1]: import profile; profile.help() """ | |
1169 |
|
1169 | |||
1170 | opts_def = Struct(D=[''],l=[],s=['time'],T=['']) |
|
1170 | opts_def = Struct(D=[''],l=[],s=['time'],T=['']) | |
1171 | # protect user quote marks |
|
1171 | # protect user quote marks | |
1172 | parameter_s = parameter_s.replace('"',r'\"').replace("'",r"\'") |
|
1172 | parameter_s = parameter_s.replace('"',r'\"').replace("'",r"\'") | |
1173 |
|
1173 | |||
1174 | if user_mode: # regular user call |
|
1174 | if user_mode: # regular user call | |
1175 | opts,arg_str = self.parse_options(parameter_s,'D:l:rs:T:', |
|
1175 | opts,arg_str = self.parse_options(parameter_s,'D:l:rs:T:', | |
1176 | list_all=1) |
|
1176 | list_all=1) | |
1177 | namespace = self.shell.user_ns |
|
1177 | namespace = self.shell.user_ns | |
1178 | else: # called to run a program by %run -p |
|
1178 | else: # called to run a program by %run -p | |
1179 | try: |
|
1179 | try: | |
1180 | filename = get_py_filename(arg_lst[0]) |
|
1180 | filename = get_py_filename(arg_lst[0]) | |
1181 | except IOError,msg: |
|
1181 | except IOError,msg: | |
1182 | error(msg) |
|
1182 | error(msg) | |
1183 | return |
|
1183 | return | |
1184 |
|
1184 | |||
1185 | arg_str = 'execfile(filename,prog_ns)' |
|
1185 | arg_str = 'execfile(filename,prog_ns)' | |
1186 | namespace = locals() |
|
1186 | namespace = locals() | |
1187 |
|
1187 | |||
1188 | opts.merge(opts_def) |
|
1188 | opts.merge(opts_def) | |
1189 |
|
1189 | |||
1190 | prof = profile.Profile() |
|
1190 | prof = profile.Profile() | |
1191 | try: |
|
1191 | try: | |
1192 | prof = prof.runctx(arg_str,namespace,namespace) |
|
1192 | prof = prof.runctx(arg_str,namespace,namespace) | |
1193 | sys_exit = '' |
|
1193 | sys_exit = '' | |
1194 | except SystemExit: |
|
1194 | except SystemExit: | |
1195 | sys_exit = """*** SystemExit exception caught in code being profiled.""" |
|
1195 | sys_exit = """*** SystemExit exception caught in code being profiled.""" | |
1196 |
|
1196 | |||
1197 | stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s) |
|
1197 | stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s) | |
1198 |
|
1198 | |||
1199 | lims = opts.l |
|
1199 | lims = opts.l | |
1200 | if lims: |
|
1200 | if lims: | |
1201 | lims = [] # rebuild lims with ints/floats/strings |
|
1201 | lims = [] # rebuild lims with ints/floats/strings | |
1202 | for lim in opts.l: |
|
1202 | for lim in opts.l: | |
1203 | try: |
|
1203 | try: | |
1204 | lims.append(int(lim)) |
|
1204 | lims.append(int(lim)) | |
1205 | except ValueError: |
|
1205 | except ValueError: | |
1206 | try: |
|
1206 | try: | |
1207 | lims.append(float(lim)) |
|
1207 | lims.append(float(lim)) | |
1208 | except ValueError: |
|
1208 | except ValueError: | |
1209 | lims.append(lim) |
|
1209 | lims.append(lim) | |
1210 |
|
1210 | |||
1211 | # Trap output. |
|
1211 | # Trap output. | |
1212 | stdout_trap = StringIO() |
|
1212 | stdout_trap = StringIO() | |
1213 |
|
1213 | |||
1214 | if hasattr(stats,'stream'): |
|
1214 | if hasattr(stats,'stream'): | |
1215 | # In newer versions of python, the stats object has a 'stream' |
|
1215 | # In newer versions of python, the stats object has a 'stream' | |
1216 | # attribute to write into. |
|
1216 | # attribute to write into. | |
1217 | stats.stream = stdout_trap |
|
1217 | stats.stream = stdout_trap | |
1218 | stats.print_stats(*lims) |
|
1218 | stats.print_stats(*lims) | |
1219 | else: |
|
1219 | else: | |
1220 | # For older versions, we manually redirect stdout during printing |
|
1220 | # For older versions, we manually redirect stdout during printing | |
1221 | sys_stdout = sys.stdout |
|
1221 | sys_stdout = sys.stdout | |
1222 | try: |
|
1222 | try: | |
1223 | sys.stdout = stdout_trap |
|
1223 | sys.stdout = stdout_trap | |
1224 | stats.print_stats(*lims) |
|
1224 | stats.print_stats(*lims) | |
1225 | finally: |
|
1225 | finally: | |
1226 | sys.stdout = sys_stdout |
|
1226 | sys.stdout = sys_stdout | |
1227 |
|
1227 | |||
1228 | output = stdout_trap.getvalue() |
|
1228 | output = stdout_trap.getvalue() | |
1229 | output = output.rstrip() |
|
1229 | output = output.rstrip() | |
1230 |
|
1230 | |||
1231 | page(output,screen_lines=self.shell.rc.screen_length) |
|
1231 | page(output,screen_lines=self.shell.rc.screen_length) | |
1232 | print sys_exit, |
|
1232 | print sys_exit, | |
1233 |
|
1233 | |||
1234 | dump_file = opts.D[0] |
|
1234 | dump_file = opts.D[0] | |
1235 | text_file = opts.T[0] |
|
1235 | text_file = opts.T[0] | |
1236 | if dump_file: |
|
1236 | if dump_file: | |
1237 | prof.dump_stats(dump_file) |
|
1237 | prof.dump_stats(dump_file) | |
1238 | print '\n*** Profile stats marshalled to file',\ |
|
1238 | print '\n*** Profile stats marshalled to file',\ | |
1239 | `dump_file`+'.',sys_exit |
|
1239 | `dump_file`+'.',sys_exit | |
1240 | if text_file: |
|
1240 | if text_file: | |
1241 | pfile = file(text_file,'w') |
|
1241 | pfile = file(text_file,'w') | |
1242 | pfile.write(output) |
|
1242 | pfile.write(output) | |
1243 | pfile.close() |
|
1243 | pfile.close() | |
1244 | print '\n*** Profile printout saved to text file',\ |
|
1244 | print '\n*** Profile printout saved to text file',\ | |
1245 | `text_file`+'.',sys_exit |
|
1245 | `text_file`+'.',sys_exit | |
1246 |
|
1246 | |||
1247 | if opts.has_key('r'): |
|
1247 | if opts.has_key('r'): | |
1248 | return stats |
|
1248 | return stats | |
1249 | else: |
|
1249 | else: | |
1250 | return None |
|
1250 | return None | |
1251 |
|
1251 | |||
1252 | def magic_run(self, parameter_s ='',runner=None): |
|
1252 | def magic_run(self, parameter_s ='',runner=None): | |
1253 | """Run the named file inside IPython as a program. |
|
1253 | """Run the named file inside IPython as a program. | |
1254 |
|
1254 | |||
1255 | Usage:\\ |
|
1255 | Usage:\\ | |
1256 | %run [-n -i -t [-N<N>] -d [-b<N>] -p [profile options]] file [args] |
|
1256 | %run [-n -i -t [-N<N>] -d [-b<N>] -p [profile options]] file [args] | |
1257 |
|
1257 | |||
1258 | Parameters after the filename are passed as command-line arguments to |
|
1258 | Parameters after the filename are passed as command-line arguments to | |
1259 | the program (put in sys.argv). Then, control returns to IPython's |
|
1259 | the program (put in sys.argv). Then, control returns to IPython's | |
1260 | prompt. |
|
1260 | prompt. | |
1261 |
|
1261 | |||
1262 | This is similar to running at a system prompt:\\ |
|
1262 | This is similar to running at a system prompt:\\ | |
1263 | $ python file args\\ |
|
1263 | $ python file args\\ | |
1264 | but with the advantage of giving you IPython's tracebacks, and of |
|
1264 | but with the advantage of giving you IPython's tracebacks, and of | |
1265 | loading all variables into your interactive namespace for further use |
|
1265 | loading all variables into your interactive namespace for further use | |
1266 | (unless -p is used, see below). |
|
1266 | (unless -p is used, see below). | |
1267 |
|
1267 | |||
1268 | The file is executed in a namespace initially consisting only of |
|
1268 | The file is executed in a namespace initially consisting only of | |
1269 | __name__=='__main__' and sys.argv constructed as indicated. It thus |
|
1269 | __name__=='__main__' and sys.argv constructed as indicated. It thus | |
1270 | sees its environment as if it were being run as a stand-alone |
|
1270 | sees its environment as if it were being run as a stand-alone | |
1271 | program. But after execution, the IPython interactive namespace gets |
|
1271 | program. But after execution, the IPython interactive namespace gets | |
1272 | updated with all variables defined in the program (except for __name__ |
|
1272 | updated with all variables defined in the program (except for __name__ | |
1273 | and sys.argv). This allows for very convenient loading of code for |
|
1273 | and sys.argv). This allows for very convenient loading of code for | |
1274 | interactive work, while giving each program a 'clean sheet' to run in. |
|
1274 | interactive work, while giving each program a 'clean sheet' to run in. | |
1275 |
|
1275 | |||
1276 | Options: |
|
1276 | Options: | |
1277 |
|
1277 | |||
1278 | -n: __name__ is NOT set to '__main__', but to the running file's name |
|
1278 | -n: __name__ is NOT set to '__main__', but to the running file's name | |
1279 | without extension (as python does under import). This allows running |
|
1279 | without extension (as python does under import). This allows running | |
1280 | scripts and reloading the definitions in them without calling code |
|
1280 | scripts and reloading the definitions in them without calling code | |
1281 | protected by an ' if __name__ == "__main__" ' clause. |
|
1281 | protected by an ' if __name__ == "__main__" ' clause. | |
1282 |
|
1282 | |||
1283 | -i: run the file in IPython's namespace instead of an empty one. This |
|
1283 | -i: run the file in IPython's namespace instead of an empty one. This | |
1284 | is useful if you are experimenting with code written in a text editor |
|
1284 | is useful if you are experimenting with code written in a text editor | |
1285 | which depends on variables defined interactively. |
|
1285 | which depends on variables defined interactively. | |
1286 |
|
1286 | |||
1287 | -e: ignore sys.exit() calls or SystemExit exceptions in the script |
|
1287 | -e: ignore sys.exit() calls or SystemExit exceptions in the script | |
1288 | being run. This is particularly useful if IPython is being used to |
|
1288 | being run. This is particularly useful if IPython is being used to | |
1289 | run unittests, which always exit with a sys.exit() call. In such |
|
1289 | run unittests, which always exit with a sys.exit() call. In such | |
1290 | cases you are interested in the output of the test results, not in |
|
1290 | cases you are interested in the output of the test results, not in | |
1291 | seeing a traceback of the unittest module. |
|
1291 | seeing a traceback of the unittest module. | |
1292 |
|
1292 | |||
1293 | -t: print timing information at the end of the run. IPython will give |
|
1293 | -t: print timing information at the end of the run. IPython will give | |
1294 | you an estimated CPU time consumption for your script, which under |
|
1294 | you an estimated CPU time consumption for your script, which under | |
1295 | Unix uses the resource module to avoid the wraparound problems of |
|
1295 | Unix uses the resource module to avoid the wraparound problems of | |
1296 | time.clock(). Under Unix, an estimate of time spent on system tasks |
|
1296 | time.clock(). Under Unix, an estimate of time spent on system tasks | |
1297 | is also given (for Windows platforms this is reported as 0.0). |
|
1297 | is also given (for Windows platforms this is reported as 0.0). | |
1298 |
|
1298 | |||
1299 | If -t is given, an additional -N<N> option can be given, where <N> |
|
1299 | If -t is given, an additional -N<N> option can be given, where <N> | |
1300 | must be an integer indicating how many times you want the script to |
|
1300 | must be an integer indicating how many times you want the script to | |
1301 | run. The final timing report will include total and per run results. |
|
1301 | run. The final timing report will include total and per run results. | |
1302 |
|
1302 | |||
1303 | For example (testing the script uniq_stable.py): |
|
1303 | For example (testing the script uniq_stable.py): | |
1304 |
|
1304 | |||
1305 | In [1]: run -t uniq_stable |
|
1305 | In [1]: run -t uniq_stable | |
1306 |
|
1306 | |||
1307 | IPython CPU timings (estimated):\\ |
|
1307 | IPython CPU timings (estimated):\\ | |
1308 | User : 0.19597 s.\\ |
|
1308 | User : 0.19597 s.\\ | |
1309 | System: 0.0 s.\\ |
|
1309 | System: 0.0 s.\\ | |
1310 |
|
1310 | |||
1311 | In [2]: run -t -N5 uniq_stable |
|
1311 | In [2]: run -t -N5 uniq_stable | |
1312 |
|
1312 | |||
1313 | IPython CPU timings (estimated):\\ |
|
1313 | IPython CPU timings (estimated):\\ | |
1314 | Total runs performed: 5\\ |
|
1314 | Total runs performed: 5\\ | |
1315 | Times : Total Per run\\ |
|
1315 | Times : Total Per run\\ | |
1316 | User : 0.910862 s, 0.1821724 s.\\ |
|
1316 | User : 0.910862 s, 0.1821724 s.\\ | |
1317 | System: 0.0 s, 0.0 s. |
|
1317 | System: 0.0 s, 0.0 s. | |
1318 |
|
1318 | |||
1319 | -d: run your program under the control of pdb, the Python debugger. |
|
1319 | -d: run your program under the control of pdb, the Python debugger. | |
1320 | This allows you to execute your program step by step, watch variables, |
|
1320 | This allows you to execute your program step by step, watch variables, | |
1321 | etc. Internally, what IPython does is similar to calling: |
|
1321 | etc. Internally, what IPython does is similar to calling: | |
1322 |
|
1322 | |||
1323 | pdb.run('execfile("YOURFILENAME")') |
|
1323 | pdb.run('execfile("YOURFILENAME")') | |
1324 |
|
1324 | |||
1325 | with a breakpoint set on line 1 of your file. You can change the line |
|
1325 | with a breakpoint set on line 1 of your file. You can change the line | |
1326 | number for this automatic breakpoint to be <N> by using the -bN option |
|
1326 | number for this automatic breakpoint to be <N> by using the -bN option | |
1327 | (where N must be an integer). For example: |
|
1327 | (where N must be an integer). For example: | |
1328 |
|
1328 | |||
1329 | %run -d -b40 myscript |
|
1329 | %run -d -b40 myscript | |
1330 |
|
1330 | |||
1331 | will set the first breakpoint at line 40 in myscript.py. Note that |
|
1331 | will set the first breakpoint at line 40 in myscript.py. Note that | |
1332 | the first breakpoint must be set on a line which actually does |
|
1332 | the first breakpoint must be set on a line which actually does | |
1333 | something (not a comment or docstring) for it to stop execution. |
|
1333 | something (not a comment or docstring) for it to stop execution. | |
1334 |
|
1334 | |||
1335 | When the pdb debugger starts, you will see a (Pdb) prompt. You must |
|
1335 | When the pdb debugger starts, you will see a (Pdb) prompt. You must | |
1336 | first enter 'c' (without qoutes) to start execution up to the first |
|
1336 | first enter 'c' (without qoutes) to start execution up to the first | |
1337 | breakpoint. |
|
1337 | breakpoint. | |
1338 |
|
1338 | |||
1339 | Entering 'help' gives information about the use of the debugger. You |
|
1339 | Entering 'help' gives information about the use of the debugger. You | |
1340 | can easily see pdb's full documentation with "import pdb;pdb.help()" |
|
1340 | can easily see pdb's full documentation with "import pdb;pdb.help()" | |
1341 | at a prompt. |
|
1341 | at a prompt. | |
1342 |
|
1342 | |||
1343 | -p: run program under the control of the Python profiler module (which |
|
1343 | -p: run program under the control of the Python profiler module (which | |
1344 | prints a detailed report of execution times, function calls, etc). |
|
1344 | prints a detailed report of execution times, function calls, etc). | |
1345 |
|
1345 | |||
1346 | You can pass other options after -p which affect the behavior of the |
|
1346 | You can pass other options after -p which affect the behavior of the | |
1347 | profiler itself. See the docs for %prun for details. |
|
1347 | profiler itself. See the docs for %prun for details. | |
1348 |
|
1348 | |||
1349 | In this mode, the program's variables do NOT propagate back to the |
|
1349 | In this mode, the program's variables do NOT propagate back to the | |
1350 | IPython interactive namespace (because they remain in the namespace |
|
1350 | IPython interactive namespace (because they remain in the namespace | |
1351 | where the profiler executes them). |
|
1351 | where the profiler executes them). | |
1352 |
|
1352 | |||
1353 | Internally this triggers a call to %prun, see its documentation for |
|
1353 | Internally this triggers a call to %prun, see its documentation for | |
1354 | details on the options available specifically for profiling. |
|
1354 | details on the options available specifically for profiling. | |
1355 |
|
1355 | |||
1356 | There is one special usage for which the text above doesn't apply: |
|
1356 | There is one special usage for which the text above doesn't apply: | |
1357 | if the filename ends with .ipy, the file is run as ipython script, |
|
1357 | if the filename ends with .ipy, the file is run as ipython script, | |
1358 | just as if the commands were written on IPython prompt. |
|
1358 | just as if the commands were written on IPython prompt. | |
1359 | """ |
|
1359 | """ | |
1360 |
|
1360 | |||
1361 | # get arguments and set sys.argv for program to be run. |
|
1361 | # get arguments and set sys.argv for program to be run. | |
1362 | opts,arg_lst = self.parse_options(parameter_s,'nidtN:b:pD:l:rs:T:e', |
|
1362 | opts,arg_lst = self.parse_options(parameter_s,'nidtN:b:pD:l:rs:T:e', | |
1363 | mode='list',list_all=1) |
|
1363 | mode='list',list_all=1) | |
1364 |
|
1364 | |||
1365 | try: |
|
1365 | try: | |
1366 | filename = get_py_filename(arg_lst[0]) |
|
1366 | filename = get_py_filename(arg_lst[0]) | |
1367 | except IndexError: |
|
1367 | except IndexError: | |
1368 | warn('you must provide at least a filename.') |
|
1368 | warn('you must provide at least a filename.') | |
1369 | print '\n%run:\n',OInspect.getdoc(self.magic_run) |
|
1369 | print '\n%run:\n',OInspect.getdoc(self.magic_run) | |
1370 | return |
|
1370 | return | |
1371 | except IOError,msg: |
|
1371 | except IOError,msg: | |
1372 | error(msg) |
|
1372 | error(msg) | |
1373 | return |
|
1373 | return | |
1374 |
|
1374 | |||
1375 | if filename.lower().endswith('.ipy'): |
|
1375 | if filename.lower().endswith('.ipy'): | |
1376 | self.api.runlines(open(filename).read()) |
|
1376 | self.api.runlines(open(filename).read()) | |
1377 | return |
|
1377 | return | |
1378 |
|
1378 | |||
1379 | # Control the response to exit() calls made by the script being run |
|
1379 | # Control the response to exit() calls made by the script being run | |
1380 | exit_ignore = opts.has_key('e') |
|
1380 | exit_ignore = opts.has_key('e') | |
1381 |
|
1381 | |||
1382 | # Make sure that the running script gets a proper sys.argv as if it |
|
1382 | # Make sure that the running script gets a proper sys.argv as if it | |
1383 | # were run from a system shell. |
|
1383 | # were run from a system shell. | |
1384 | save_argv = sys.argv # save it for later restoring |
|
1384 | save_argv = sys.argv # save it for later restoring | |
1385 | sys.argv = [filename]+ arg_lst[1:] # put in the proper filename |
|
1385 | sys.argv = [filename]+ arg_lst[1:] # put in the proper filename | |
1386 |
|
1386 | |||
1387 | if opts.has_key('i'): |
|
1387 | if opts.has_key('i'): | |
1388 | prog_ns = self.shell.user_ns |
|
1388 | prog_ns = self.shell.user_ns | |
1389 | __name__save = self.shell.user_ns['__name__'] |
|
1389 | __name__save = self.shell.user_ns['__name__'] | |
1390 | prog_ns['__name__'] = '__main__' |
|
1390 | prog_ns['__name__'] = '__main__' | |
1391 | else: |
|
1391 | else: | |
1392 | if opts.has_key('n'): |
|
1392 | if opts.has_key('n'): | |
1393 | name = os.path.splitext(os.path.basename(filename))[0] |
|
1393 | name = os.path.splitext(os.path.basename(filename))[0] | |
1394 | else: |
|
1394 | else: | |
1395 | name = '__main__' |
|
1395 | name = '__main__' | |
1396 | prog_ns = {'__name__':name} |
|
1396 | prog_ns = {'__name__':name} | |
1397 |
|
1397 | |||
1398 | # Since '%run foo' emulates 'python foo.py' at the cmd line, we must |
|
1398 | # Since '%run foo' emulates 'python foo.py' at the cmd line, we must | |
1399 | # set the __file__ global in the script's namespace |
|
1399 | # set the __file__ global in the script's namespace | |
1400 | prog_ns['__file__'] = filename |
|
1400 | prog_ns['__file__'] = filename | |
1401 |
|
1401 | |||
1402 | # pickle fix. See iplib for an explanation. But we need to make sure |
|
1402 | # pickle fix. See iplib for an explanation. But we need to make sure | |
1403 | # that, if we overwrite __main__, we replace it at the end |
|
1403 | # that, if we overwrite __main__, we replace it at the end | |
1404 | if prog_ns['__name__'] == '__main__': |
|
1404 | if prog_ns['__name__'] == '__main__': | |
1405 | restore_main = sys.modules['__main__'] |
|
1405 | restore_main = sys.modules['__main__'] | |
1406 | else: |
|
1406 | else: | |
1407 | restore_main = False |
|
1407 | restore_main = False | |
1408 |
|
1408 | |||
1409 | sys.modules[prog_ns['__name__']] = FakeModule(prog_ns) |
|
1409 | sys.modules[prog_ns['__name__']] = FakeModule(prog_ns) | |
1410 |
|
1410 | |||
1411 | stats = None |
|
1411 | stats = None | |
1412 | try: |
|
1412 | try: | |
1413 | if self.shell.has_readline: |
|
1413 | if self.shell.has_readline: | |
1414 | self.shell.savehist() |
|
1414 | self.shell.savehist() | |
1415 |
|
1415 | |||
1416 | if opts.has_key('p'): |
|
1416 | if opts.has_key('p'): | |
1417 | stats = self.magic_prun('',0,opts,arg_lst,prog_ns) |
|
1417 | stats = self.magic_prun('',0,opts,arg_lst,prog_ns) | |
1418 | else: |
|
1418 | else: | |
1419 | if opts.has_key('d'): |
|
1419 | if opts.has_key('d'): | |
1420 | deb = Debugger.Pdb(self.shell.rc.colors) |
|
1420 | deb = Debugger.Pdb(self.shell.rc.colors) | |
1421 | # reset Breakpoint state, which is moronically kept |
|
1421 | # reset Breakpoint state, which is moronically kept | |
1422 | # in a class |
|
1422 | # in a class | |
1423 | bdb.Breakpoint.next = 1 |
|
1423 | bdb.Breakpoint.next = 1 | |
1424 | bdb.Breakpoint.bplist = {} |
|
1424 | bdb.Breakpoint.bplist = {} | |
1425 | bdb.Breakpoint.bpbynumber = [None] |
|
1425 | bdb.Breakpoint.bpbynumber = [None] | |
1426 | # Set an initial breakpoint to stop execution |
|
1426 | # Set an initial breakpoint to stop execution | |
1427 | maxtries = 10 |
|
1427 | maxtries = 10 | |
1428 | bp = int(opts.get('b',[1])[0]) |
|
1428 | bp = int(opts.get('b',[1])[0]) | |
1429 | checkline = deb.checkline(filename,bp) |
|
1429 | checkline = deb.checkline(filename,bp) | |
1430 | if not checkline: |
|
1430 | if not checkline: | |
1431 | for bp in range(bp+1,bp+maxtries+1): |
|
1431 | for bp in range(bp+1,bp+maxtries+1): | |
1432 | if deb.checkline(filename,bp): |
|
1432 | if deb.checkline(filename,bp): | |
1433 | break |
|
1433 | break | |
1434 | else: |
|
1434 | else: | |
1435 | msg = ("\nI failed to find a valid line to set " |
|
1435 | msg = ("\nI failed to find a valid line to set " | |
1436 | "a breakpoint\n" |
|
1436 | "a breakpoint\n" | |
1437 | "after trying up to line: %s.\n" |
|
1437 | "after trying up to line: %s.\n" | |
1438 | "Please set a valid breakpoint manually " |
|
1438 | "Please set a valid breakpoint manually " | |
1439 | "with the -b option." % bp) |
|
1439 | "with the -b option." % bp) | |
1440 | error(msg) |
|
1440 | error(msg) | |
1441 | return |
|
1441 | return | |
1442 | # if we find a good linenumber, set the breakpoint |
|
1442 | # if we find a good linenumber, set the breakpoint | |
1443 | deb.do_break('%s:%s' % (filename,bp)) |
|
1443 | deb.do_break('%s:%s' % (filename,bp)) | |
1444 | # Start file run |
|
1444 | # Start file run | |
1445 | print "NOTE: Enter 'c' at the", |
|
1445 | print "NOTE: Enter 'c' at the", | |
1446 | print "%s prompt to start your script." % deb.prompt |
|
1446 | print "%s prompt to start your script." % deb.prompt | |
1447 | try: |
|
1447 | try: | |
1448 | deb.run('execfile("%s")' % filename,prog_ns) |
|
1448 | deb.run('execfile("%s")' % filename,prog_ns) | |
1449 |
|
1449 | |||
1450 | except: |
|
1450 | except: | |
1451 | etype, value, tb = sys.exc_info() |
|
1451 | etype, value, tb = sys.exc_info() | |
1452 | # Skip three frames in the traceback: the %run one, |
|
1452 | # Skip three frames in the traceback: the %run one, | |
1453 | # one inside bdb.py, and the command-line typed by the |
|
1453 | # one inside bdb.py, and the command-line typed by the | |
1454 | # user (run by exec in pdb itself). |
|
1454 | # user (run by exec in pdb itself). | |
1455 | self.shell.InteractiveTB(etype,value,tb,tb_offset=3) |
|
1455 | self.shell.InteractiveTB(etype,value,tb,tb_offset=3) | |
1456 | else: |
|
1456 | else: | |
1457 | if runner is None: |
|
1457 | if runner is None: | |
1458 | runner = self.shell.safe_execfile |
|
1458 | runner = self.shell.safe_execfile | |
1459 | if opts.has_key('t'): |
|
1459 | if opts.has_key('t'): | |
1460 | try: |
|
1460 | try: | |
1461 | nruns = int(opts['N'][0]) |
|
1461 | nruns = int(opts['N'][0]) | |
1462 | if nruns < 1: |
|
1462 | if nruns < 1: | |
1463 | error('Number of runs must be >=1') |
|
1463 | error('Number of runs must be >=1') | |
1464 | return |
|
1464 | return | |
1465 | except (KeyError): |
|
1465 | except (KeyError): | |
1466 | nruns = 1 |
|
1466 | nruns = 1 | |
1467 | if nruns == 1: |
|
1467 | if nruns == 1: | |
1468 | t0 = clock2() |
|
1468 | t0 = clock2() | |
1469 | runner(filename,prog_ns,prog_ns, |
|
1469 | runner(filename,prog_ns,prog_ns, | |
1470 | exit_ignore=exit_ignore) |
|
1470 | exit_ignore=exit_ignore) | |
1471 | t1 = clock2() |
|
1471 | t1 = clock2() | |
1472 | t_usr = t1[0]-t0[0] |
|
1472 | t_usr = t1[0]-t0[0] | |
1473 | t_sys = t1[1]-t1[1] |
|
1473 | t_sys = t1[1]-t1[1] | |
1474 | print "\nIPython CPU timings (estimated):" |
|
1474 | print "\nIPython CPU timings (estimated):" | |
1475 | print " User : %10s s." % t_usr |
|
1475 | print " User : %10s s." % t_usr | |
1476 | print " System: %10s s." % t_sys |
|
1476 | print " System: %10s s." % t_sys | |
1477 | else: |
|
1477 | else: | |
1478 | runs = range(nruns) |
|
1478 | runs = range(nruns) | |
1479 | t0 = clock2() |
|
1479 | t0 = clock2() | |
1480 | for nr in runs: |
|
1480 | for nr in runs: | |
1481 | runner(filename,prog_ns,prog_ns, |
|
1481 | runner(filename,prog_ns,prog_ns, | |
1482 | exit_ignore=exit_ignore) |
|
1482 | exit_ignore=exit_ignore) | |
1483 | t1 = clock2() |
|
1483 | t1 = clock2() | |
1484 | t_usr = t1[0]-t0[0] |
|
1484 | t_usr = t1[0]-t0[0] | |
1485 | t_sys = t1[1]-t1[1] |
|
1485 | t_sys = t1[1]-t1[1] | |
1486 | print "\nIPython CPU timings (estimated):" |
|
1486 | print "\nIPython CPU timings (estimated):" | |
1487 | print "Total runs performed:",nruns |
|
1487 | print "Total runs performed:",nruns | |
1488 | print " Times : %10s %10s" % ('Total','Per run') |
|
1488 | print " Times : %10s %10s" % ('Total','Per run') | |
1489 | print " User : %10s s, %10s s." % (t_usr,t_usr/nruns) |
|
1489 | print " User : %10s s, %10s s." % (t_usr,t_usr/nruns) | |
1490 | print " System: %10s s, %10s s." % (t_sys,t_sys/nruns) |
|
1490 | print " System: %10s s, %10s s." % (t_sys,t_sys/nruns) | |
1491 |
|
1491 | |||
1492 | else: |
|
1492 | else: | |
1493 | runner(filename,prog_ns,prog_ns,exit_ignore=exit_ignore) |
|
1493 | runner(filename,prog_ns,prog_ns,exit_ignore=exit_ignore) | |
1494 | if opts.has_key('i'): |
|
1494 | if opts.has_key('i'): | |
1495 | self.shell.user_ns['__name__'] = __name__save |
|
1495 | self.shell.user_ns['__name__'] = __name__save | |
1496 | else: |
|
1496 | else: | |
1497 | # update IPython interactive namespace |
|
1497 | # update IPython interactive namespace | |
1498 | del prog_ns['__name__'] |
|
1498 | del prog_ns['__name__'] | |
1499 | self.shell.user_ns.update(prog_ns) |
|
1499 | self.shell.user_ns.update(prog_ns) | |
1500 | finally: |
|
1500 | finally: | |
1501 | sys.argv = save_argv |
|
1501 | sys.argv = save_argv | |
1502 | if restore_main: |
|
1502 | if restore_main: | |
1503 | sys.modules['__main__'] = restore_main |
|
1503 | sys.modules['__main__'] = restore_main | |
1504 | self.shell.reloadhist() |
|
1504 | self.shell.reloadhist() | |
1505 |
|
1505 | |||
1506 | return stats |
|
1506 | return stats | |
1507 |
|
1507 | |||
1508 | def magic_runlog(self, parameter_s =''): |
|
1508 | def magic_runlog(self, parameter_s =''): | |
1509 | """Run files as logs. |
|
1509 | """Run files as logs. | |
1510 |
|
1510 | |||
1511 | Usage:\\ |
|
1511 | Usage:\\ | |
1512 | %runlog file1 file2 ... |
|
1512 | %runlog file1 file2 ... | |
1513 |
|
1513 | |||
1514 | Run the named files (treating them as log files) in sequence inside |
|
1514 | Run the named files (treating them as log files) in sequence inside | |
1515 | the interpreter, and return to the prompt. This is much slower than |
|
1515 | the interpreter, and return to the prompt. This is much slower than | |
1516 | %run because each line is executed in a try/except block, but it |
|
1516 | %run because each line is executed in a try/except block, but it | |
1517 | allows running files with syntax errors in them. |
|
1517 | allows running files with syntax errors in them. | |
1518 |
|
1518 | |||
1519 | Normally IPython will guess when a file is one of its own logfiles, so |
|
1519 | Normally IPython will guess when a file is one of its own logfiles, so | |
1520 | you can typically use %run even for logs. This shorthand allows you to |
|
1520 | you can typically use %run even for logs. This shorthand allows you to | |
1521 | force any file to be treated as a log file.""" |
|
1521 | force any file to be treated as a log file.""" | |
1522 |
|
1522 | |||
1523 | for f in parameter_s.split(): |
|
1523 | for f in parameter_s.split(): | |
1524 | self.shell.safe_execfile(f,self.shell.user_ns, |
|
1524 | self.shell.safe_execfile(f,self.shell.user_ns, | |
1525 | self.shell.user_ns,islog=1) |
|
1525 | self.shell.user_ns,islog=1) | |
1526 |
|
1526 | |||
1527 | def magic_timeit(self, parameter_s =''): |
|
1527 | def magic_timeit(self, parameter_s =''): | |
1528 | """Time execution of a Python statement or expression |
|
1528 | """Time execution of a Python statement or expression | |
1529 |
|
1529 | |||
1530 | Usage:\\ |
|
1530 | Usage:\\ | |
1531 | %timeit [-n<N> -r<R> [-t|-c]] statement |
|
1531 | %timeit [-n<N> -r<R> [-t|-c]] statement | |
1532 |
|
1532 | |||
1533 | Time execution of a Python statement or expression using the timeit |
|
1533 | Time execution of a Python statement or expression using the timeit | |
1534 | module. |
|
1534 | module. | |
1535 |
|
1535 | |||
1536 | Options: |
|
1536 | Options: | |
1537 | -n<N>: execute the given statement <N> times in a loop. If this value |
|
1537 | -n<N>: execute the given statement <N> times in a loop. If this value | |
1538 | is not given, a fitting value is chosen. |
|
1538 | is not given, a fitting value is chosen. | |
1539 |
|
1539 | |||
1540 | -r<R>: repeat the loop iteration <R> times and take the best result. |
|
1540 | -r<R>: repeat the loop iteration <R> times and take the best result. | |
1541 | Default: 3 |
|
1541 | Default: 3 | |
1542 |
|
1542 | |||
1543 | -t: use time.time to measure the time, which is the default on Unix. |
|
1543 | -t: use time.time to measure the time, which is the default on Unix. | |
1544 | This function measures wall time. |
|
1544 | This function measures wall time. | |
1545 |
|
1545 | |||
1546 | -c: use time.clock to measure the time, which is the default on |
|
1546 | -c: use time.clock to measure the time, which is the default on | |
1547 | Windows and measures wall time. On Unix, resource.getrusage is used |
|
1547 | Windows and measures wall time. On Unix, resource.getrusage is used | |
1548 | instead and returns the CPU user time. |
|
1548 | instead and returns the CPU user time. | |
1549 |
|
1549 | |||
1550 | -p<P>: use a precision of <P> digits to display the timing result. |
|
1550 | -p<P>: use a precision of <P> digits to display the timing result. | |
1551 | Default: 3 |
|
1551 | Default: 3 | |
1552 |
|
1552 | |||
1553 |
|
1553 | |||
1554 | Examples:\\ |
|
1554 | Examples:\\ | |
1555 | In [1]: %timeit pass |
|
1555 | In [1]: %timeit pass | |
1556 | 10000000 loops, best of 3: 53.3 ns per loop |
|
1556 | 10000000 loops, best of 3: 53.3 ns per loop | |
1557 |
|
1557 | |||
1558 | In [2]: u = None |
|
1558 | In [2]: u = None | |
1559 |
|
1559 | |||
1560 | In [3]: %timeit u is None |
|
1560 | In [3]: %timeit u is None | |
1561 | 10000000 loops, best of 3: 184 ns per loop |
|
1561 | 10000000 loops, best of 3: 184 ns per loop | |
1562 |
|
1562 | |||
1563 | In [4]: %timeit -r 4 u == None |
|
1563 | In [4]: %timeit -r 4 u == None | |
1564 | 1000000 loops, best of 4: 242 ns per loop |
|
1564 | 1000000 loops, best of 4: 242 ns per loop | |
1565 |
|
1565 | |||
1566 | In [5]: import time |
|
1566 | In [5]: import time | |
1567 |
|
1567 | |||
1568 | In [6]: %timeit -n1 time.sleep(2) |
|
1568 | In [6]: %timeit -n1 time.sleep(2) | |
1569 | 1 loops, best of 3: 2 s per loop |
|
1569 | 1 loops, best of 3: 2 s per loop | |
1570 |
|
1570 | |||
1571 |
|
1571 | |||
1572 | The times reported by %timeit will be slightly higher than those |
|
1572 | The times reported by %timeit will be slightly higher than those | |
1573 | reported by the timeit.py script when variables are accessed. This is |
|
1573 | reported by the timeit.py script when variables are accessed. This is | |
1574 | due to the fact that %timeit executes the statement in the namespace |
|
1574 | due to the fact that %timeit executes the statement in the namespace | |
1575 | of the shell, compared with timeit.py, which uses a single setup |
|
1575 | of the shell, compared with timeit.py, which uses a single setup | |
1576 | statement to import function or create variables. Generally, the bias |
|
1576 | statement to import function or create variables. Generally, the bias | |
1577 | does not matter as long as results from timeit.py are not mixed with |
|
1577 | does not matter as long as results from timeit.py are not mixed with | |
1578 | those from %timeit.""" |
|
1578 | those from %timeit.""" | |
1579 |
|
1579 | |||
1580 | import timeit |
|
1580 | import timeit | |
1581 | import math |
|
1581 | import math | |
1582 |
|
1582 | |||
1583 | units = ["s", "ms", "\xc2\xb5s", "ns"] |
|
1583 | units = ["s", "ms", "\xc2\xb5s", "ns"] | |
1584 | scaling = [1, 1e3, 1e6, 1e9] |
|
1584 | scaling = [1, 1e3, 1e6, 1e9] | |
1585 |
|
1585 | |||
1586 | opts, stmt = self.parse_options(parameter_s,'n:r:tcp:', |
|
1586 | opts, stmt = self.parse_options(parameter_s,'n:r:tcp:', | |
1587 | posix=False) |
|
1587 | posix=False) | |
1588 | if stmt == "": |
|
1588 | if stmt == "": | |
1589 | return |
|
1589 | return | |
1590 | timefunc = timeit.default_timer |
|
1590 | timefunc = timeit.default_timer | |
1591 | number = int(getattr(opts, "n", 0)) |
|
1591 | number = int(getattr(opts, "n", 0)) | |
1592 | repeat = int(getattr(opts, "r", timeit.default_repeat)) |
|
1592 | repeat = int(getattr(opts, "r", timeit.default_repeat)) | |
1593 | precision = int(getattr(opts, "p", 3)) |
|
1593 | precision = int(getattr(opts, "p", 3)) | |
1594 | if hasattr(opts, "t"): |
|
1594 | if hasattr(opts, "t"): | |
1595 | timefunc = time.time |
|
1595 | timefunc = time.time | |
1596 | if hasattr(opts, "c"): |
|
1596 | if hasattr(opts, "c"): | |
1597 | timefunc = clock |
|
1597 | timefunc = clock | |
1598 |
|
1598 | |||
1599 | timer = timeit.Timer(timer=timefunc) |
|
1599 | timer = timeit.Timer(timer=timefunc) | |
1600 | # this code has tight coupling to the inner workings of timeit.Timer, |
|
1600 | # this code has tight coupling to the inner workings of timeit.Timer, | |
1601 | # but is there a better way to achieve that the code stmt has access |
|
1601 | # but is there a better way to achieve that the code stmt has access | |
1602 | # to the shell namespace? |
|
1602 | # to the shell namespace? | |
1603 |
|
1603 | |||
1604 | src = timeit.template % {'stmt': timeit.reindent(stmt, 8), |
|
1604 | src = timeit.template % {'stmt': timeit.reindent(stmt, 8), | |
1605 | 'setup': "pass"} |
|
1605 | 'setup': "pass"} | |
1606 | code = compile(src, "<magic-timeit>", "exec") |
|
1606 | code = compile(src, "<magic-timeit>", "exec") | |
1607 | ns = {} |
|
1607 | ns = {} | |
1608 | exec code in self.shell.user_ns, ns |
|
1608 | exec code in self.shell.user_ns, ns | |
1609 | timer.inner = ns["inner"] |
|
1609 | timer.inner = ns["inner"] | |
1610 |
|
1610 | |||
1611 | if number == 0: |
|
1611 | if number == 0: | |
1612 | # determine number so that 0.2 <= total time < 2.0 |
|
1612 | # determine number so that 0.2 <= total time < 2.0 | |
1613 | number = 1 |
|
1613 | number = 1 | |
1614 | for i in range(1, 10): |
|
1614 | for i in range(1, 10): | |
1615 | number *= 10 |
|
1615 | number *= 10 | |
1616 | if timer.timeit(number) >= 0.2: |
|
1616 | if timer.timeit(number) >= 0.2: | |
1617 | break |
|
1617 | break | |
1618 |
|
1618 | |||
1619 | best = min(timer.repeat(repeat, number)) / number |
|
1619 | best = min(timer.repeat(repeat, number)) / number | |
1620 |
|
1620 | |||
1621 | if best > 0.0: |
|
1621 | if best > 0.0: | |
1622 | order = min(-int(math.floor(math.log10(best)) // 3), 3) |
|
1622 | order = min(-int(math.floor(math.log10(best)) // 3), 3) | |
1623 | else: |
|
1623 | else: | |
1624 | order = 3 |
|
1624 | order = 3 | |
1625 | print "%d loops, best of %d: %.*g %s per loop" % (number, repeat, |
|
1625 | print "%d loops, best of %d: %.*g %s per loop" % (number, repeat, | |
1626 | precision, |
|
1626 | precision, | |
1627 | best * scaling[order], |
|
1627 | best * scaling[order], | |
1628 | units[order]) |
|
1628 | units[order]) | |
1629 |
|
1629 | |||
1630 | def magic_time(self,parameter_s = ''): |
|
1630 | def magic_time(self,parameter_s = ''): | |
1631 | """Time execution of a Python statement or expression. |
|
1631 | """Time execution of a Python statement or expression. | |
1632 |
|
1632 | |||
1633 | The CPU and wall clock times are printed, and the value of the |
|
1633 | The CPU and wall clock times are printed, and the value of the | |
1634 | expression (if any) is returned. Note that under Win32, system time |
|
1634 | expression (if any) is returned. Note that under Win32, system time | |
1635 | is always reported as 0, since it can not be measured. |
|
1635 | is always reported as 0, since it can not be measured. | |
1636 |
|
1636 | |||
1637 | This function provides very basic timing functionality. In Python |
|
1637 | This function provides very basic timing functionality. In Python | |
1638 | 2.3, the timeit module offers more control and sophistication, so this |
|
1638 | 2.3, the timeit module offers more control and sophistication, so this | |
1639 | could be rewritten to use it (patches welcome). |
|
1639 | could be rewritten to use it (patches welcome). | |
1640 |
|
1640 | |||
1641 | Some examples: |
|
1641 | Some examples: | |
1642 |
|
1642 | |||
1643 | In [1]: time 2**128 |
|
1643 | In [1]: time 2**128 | |
1644 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1644 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s | |
1645 | Wall time: 0.00 |
|
1645 | Wall time: 0.00 | |
1646 | Out[1]: 340282366920938463463374607431768211456L |
|
1646 | Out[1]: 340282366920938463463374607431768211456L | |
1647 |
|
1647 | |||
1648 | In [2]: n = 1000000 |
|
1648 | In [2]: n = 1000000 | |
1649 |
|
1649 | |||
1650 | In [3]: time sum(range(n)) |
|
1650 | In [3]: time sum(range(n)) | |
1651 | CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s |
|
1651 | CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s | |
1652 | Wall time: 1.37 |
|
1652 | Wall time: 1.37 | |
1653 | Out[3]: 499999500000L |
|
1653 | Out[3]: 499999500000L | |
1654 |
|
1654 | |||
1655 | In [4]: time print 'hello world' |
|
1655 | In [4]: time print 'hello world' | |
1656 | hello world |
|
1656 | hello world | |
1657 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1657 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s | |
1658 | Wall time: 0.00 |
|
1658 | Wall time: 0.00 | |
1659 | """ |
|
1659 | """ | |
1660 |
|
1660 | |||
1661 | # fail immediately if the given expression can't be compiled |
|
1661 | # fail immediately if the given expression can't be compiled | |
1662 | try: |
|
1662 | try: | |
1663 | mode = 'eval' |
|
1663 | mode = 'eval' | |
1664 | code = compile(parameter_s,'<timed eval>',mode) |
|
1664 | code = compile(parameter_s,'<timed eval>',mode) | |
1665 | except SyntaxError: |
|
1665 | except SyntaxError: | |
1666 | mode = 'exec' |
|
1666 | mode = 'exec' | |
1667 | code = compile(parameter_s,'<timed exec>',mode) |
|
1667 | code = compile(parameter_s,'<timed exec>',mode) | |
1668 | # skew measurement as little as possible |
|
1668 | # skew measurement as little as possible | |
1669 | glob = self.shell.user_ns |
|
1669 | glob = self.shell.user_ns | |
1670 | clk = clock2 |
|
1670 | clk = clock2 | |
1671 | wtime = time.time |
|
1671 | wtime = time.time | |
1672 | # time execution |
|
1672 | # time execution | |
1673 | wall_st = wtime() |
|
1673 | wall_st = wtime() | |
1674 | if mode=='eval': |
|
1674 | if mode=='eval': | |
1675 | st = clk() |
|
1675 | st = clk() | |
1676 | out = eval(code,glob) |
|
1676 | out = eval(code,glob) | |
1677 | end = clk() |
|
1677 | end = clk() | |
1678 | else: |
|
1678 | else: | |
1679 | st = clk() |
|
1679 | st = clk() | |
1680 | exec code in glob |
|
1680 | exec code in glob | |
1681 | end = clk() |
|
1681 | end = clk() | |
1682 | out = None |
|
1682 | out = None | |
1683 | wall_end = wtime() |
|
1683 | wall_end = wtime() | |
1684 | # Compute actual times and report |
|
1684 | # Compute actual times and report | |
1685 | wall_time = wall_end-wall_st |
|
1685 | wall_time = wall_end-wall_st | |
1686 | cpu_user = end[0]-st[0] |
|
1686 | cpu_user = end[0]-st[0] | |
1687 | cpu_sys = end[1]-st[1] |
|
1687 | cpu_sys = end[1]-st[1] | |
1688 | cpu_tot = cpu_user+cpu_sys |
|
1688 | cpu_tot = cpu_user+cpu_sys | |
1689 | print "CPU times: user %.2f s, sys: %.2f s, total: %.2f s" % \ |
|
1689 | print "CPU times: user %.2f s, sys: %.2f s, total: %.2f s" % \ | |
1690 | (cpu_user,cpu_sys,cpu_tot) |
|
1690 | (cpu_user,cpu_sys,cpu_tot) | |
1691 | print "Wall time: %.2f" % wall_time |
|
1691 | print "Wall time: %.2f" % wall_time | |
1692 | return out |
|
1692 | return out | |
1693 |
|
1693 | |||
1694 | def magic_macro(self,parameter_s = ''): |
|
1694 | def magic_macro(self,parameter_s = ''): | |
1695 | """Define a set of input lines as a macro for future re-execution. |
|
1695 | """Define a set of input lines as a macro for future re-execution. | |
1696 |
|
1696 | |||
1697 | Usage:\\ |
|
1697 | Usage:\\ | |
1698 | %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ... |
|
1698 | %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ... | |
1699 |
|
1699 | |||
1700 | Options: |
|
1700 | Options: | |
1701 |
|
1701 | |||
1702 | -r: use 'raw' input. By default, the 'processed' history is used, |
|
1702 | -r: use 'raw' input. By default, the 'processed' history is used, | |
1703 | so that magics are loaded in their transformed version to valid |
|
1703 | so that magics are loaded in their transformed version to valid | |
1704 | Python. If this option is given, the raw input as typed as the |
|
1704 | Python. If this option is given, the raw input as typed as the | |
1705 | command line is used instead. |
|
1705 | command line is used instead. | |
1706 |
|
1706 | |||
1707 | This will define a global variable called `name` which is a string |
|
1707 | This will define a global variable called `name` which is a string | |
1708 | made of joining the slices and lines you specify (n1,n2,... numbers |
|
1708 | made of joining the slices and lines you specify (n1,n2,... numbers | |
1709 | above) from your input history into a single string. This variable |
|
1709 | above) from your input history into a single string. This variable | |
1710 | acts like an automatic function which re-executes those lines as if |
|
1710 | acts like an automatic function which re-executes those lines as if | |
1711 | you had typed them. You just type 'name' at the prompt and the code |
|
1711 | you had typed them. You just type 'name' at the prompt and the code | |
1712 | executes. |
|
1712 | executes. | |
1713 |
|
1713 | |||
1714 | The notation for indicating number ranges is: n1-n2 means 'use line |
|
1714 | The notation for indicating number ranges is: n1-n2 means 'use line | |
1715 | numbers n1,...n2' (the endpoint is included). That is, '5-7' means |
|
1715 | numbers n1,...n2' (the endpoint is included). That is, '5-7' means | |
1716 | using the lines numbered 5,6 and 7. |
|
1716 | using the lines numbered 5,6 and 7. | |
1717 |
|
1717 | |||
1718 | Note: as a 'hidden' feature, you can also use traditional python slice |
|
1718 | Note: as a 'hidden' feature, you can also use traditional python slice | |
1719 | notation, where N:M means numbers N through M-1. |
|
1719 | notation, where N:M means numbers N through M-1. | |
1720 |
|
1720 | |||
1721 | For example, if your history contains (%hist prints it): |
|
1721 | For example, if your history contains (%hist prints it): | |
1722 |
|
1722 | |||
1723 | 44: x=1\\ |
|
1723 | 44: x=1\\ | |
1724 | 45: y=3\\ |
|
1724 | 45: y=3\\ | |
1725 | 46: z=x+y\\ |
|
1725 | 46: z=x+y\\ | |
1726 | 47: print x\\ |
|
1726 | 47: print x\\ | |
1727 | 48: a=5\\ |
|
1727 | 48: a=5\\ | |
1728 | 49: print 'x',x,'y',y\\ |
|
1728 | 49: print 'x',x,'y',y\\ | |
1729 |
|
1729 | |||
1730 | you can create a macro with lines 44 through 47 (included) and line 49 |
|
1730 | you can create a macro with lines 44 through 47 (included) and line 49 | |
1731 | called my_macro with: |
|
1731 | called my_macro with: | |
1732 |
|
1732 | |||
1733 | In [51]: %macro my_macro 44-47 49 |
|
1733 | In [51]: %macro my_macro 44-47 49 | |
1734 |
|
1734 | |||
1735 | Now, typing `my_macro` (without quotes) will re-execute all this code |
|
1735 | Now, typing `my_macro` (without quotes) will re-execute all this code | |
1736 | in one pass. |
|
1736 | in one pass. | |
1737 |
|
1737 | |||
1738 | You don't need to give the line-numbers in order, and any given line |
|
1738 | You don't need to give the line-numbers in order, and any given line | |
1739 | number can appear multiple times. You can assemble macros with any |
|
1739 | number can appear multiple times. You can assemble macros with any | |
1740 | lines from your input history in any order. |
|
1740 | lines from your input history in any order. | |
1741 |
|
1741 | |||
1742 | The macro is a simple object which holds its value in an attribute, |
|
1742 | The macro is a simple object which holds its value in an attribute, | |
1743 | but IPython's display system checks for macros and executes them as |
|
1743 | but IPython's display system checks for macros and executes them as | |
1744 | code instead of printing them when you type their name. |
|
1744 | code instead of printing them when you type their name. | |
1745 |
|
1745 | |||
1746 | You can view a macro's contents by explicitly printing it with: |
|
1746 | You can view a macro's contents by explicitly printing it with: | |
1747 |
|
1747 | |||
1748 | 'print macro_name'. |
|
1748 | 'print macro_name'. | |
1749 |
|
1749 | |||
1750 | For one-off cases which DON'T contain magic function calls in them you |
|
1750 | For one-off cases which DON'T contain magic function calls in them you | |
1751 | can obtain similar results by explicitly executing slices from your |
|
1751 | can obtain similar results by explicitly executing slices from your | |
1752 | input history with: |
|
1752 | input history with: | |
1753 |
|
1753 | |||
1754 | In [60]: exec In[44:48]+In[49]""" |
|
1754 | In [60]: exec In[44:48]+In[49]""" | |
1755 |
|
1755 | |||
1756 | opts,args = self.parse_options(parameter_s,'r',mode='list') |
|
1756 | opts,args = self.parse_options(parameter_s,'r',mode='list') | |
1757 | if not args: |
|
1757 | if not args: | |
1758 | macs = [k for k,v in self.shell.user_ns.items() if isinstance(v, Macro)] |
|
1758 | macs = [k for k,v in self.shell.user_ns.items() if isinstance(v, Macro)] | |
1759 | macs.sort() |
|
1759 | macs.sort() | |
1760 | return macs |
|
1760 | return macs | |
1761 | name,ranges = args[0], args[1:] |
|
1761 | name,ranges = args[0], args[1:] | |
1762 | #print 'rng',ranges # dbg |
|
1762 | #print 'rng',ranges # dbg | |
1763 | lines = self.extract_input_slices(ranges,opts.has_key('r')) |
|
1763 | lines = self.extract_input_slices(ranges,opts.has_key('r')) | |
1764 | macro = Macro(lines) |
|
1764 | macro = Macro(lines) | |
1765 | self.shell.user_ns.update({name:macro}) |
|
1765 | self.shell.user_ns.update({name:macro}) | |
1766 | print 'Macro `%s` created. To execute, type its name (without quotes).' % name |
|
1766 | print 'Macro `%s` created. To execute, type its name (without quotes).' % name | |
1767 | print 'Macro contents:' |
|
1767 | print 'Macro contents:' | |
1768 | print macro, |
|
1768 | print macro, | |
1769 |
|
1769 | |||
1770 | def magic_save(self,parameter_s = ''): |
|
1770 | def magic_save(self,parameter_s = ''): | |
1771 | """Save a set of lines to a given filename. |
|
1771 | """Save a set of lines to a given filename. | |
1772 |
|
1772 | |||
1773 | Usage:\\ |
|
1773 | Usage:\\ | |
1774 | %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ... |
|
1774 | %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ... | |
1775 |
|
1775 | |||
1776 | Options: |
|
1776 | Options: | |
1777 |
|
1777 | |||
1778 | -r: use 'raw' input. By default, the 'processed' history is used, |
|
1778 | -r: use 'raw' input. By default, the 'processed' history is used, | |
1779 | so that magics are loaded in their transformed version to valid |
|
1779 | so that magics are loaded in their transformed version to valid | |
1780 | Python. If this option is given, the raw input as typed as the |
|
1780 | Python. If this option is given, the raw input as typed as the | |
1781 | command line is used instead. |
|
1781 | command line is used instead. | |
1782 |
|
1782 | |||
1783 | This function uses the same syntax as %macro for line extraction, but |
|
1783 | This function uses the same syntax as %macro for line extraction, but | |
1784 | instead of creating a macro it saves the resulting string to the |
|
1784 | instead of creating a macro it saves the resulting string to the | |
1785 | filename you specify. |
|
1785 | filename you specify. | |
1786 |
|
1786 | |||
1787 | It adds a '.py' extension to the file if you don't do so yourself, and |
|
1787 | It adds a '.py' extension to the file if you don't do so yourself, and | |
1788 | it asks for confirmation before overwriting existing files.""" |
|
1788 | it asks for confirmation before overwriting existing files.""" | |
1789 |
|
1789 | |||
1790 | opts,args = self.parse_options(parameter_s,'r',mode='list') |
|
1790 | opts,args = self.parse_options(parameter_s,'r',mode='list') | |
1791 | fname,ranges = args[0], args[1:] |
|
1791 | fname,ranges = args[0], args[1:] | |
1792 | if not fname.endswith('.py'): |
|
1792 | if not fname.endswith('.py'): | |
1793 | fname += '.py' |
|
1793 | fname += '.py' | |
1794 | if os.path.isfile(fname): |
|
1794 | if os.path.isfile(fname): | |
1795 | ans = raw_input('File `%s` exists. Overwrite (y/[N])? ' % fname) |
|
1795 | ans = raw_input('File `%s` exists. Overwrite (y/[N])? ' % fname) | |
1796 | if ans.lower() not in ['y','yes']: |
|
1796 | if ans.lower() not in ['y','yes']: | |
1797 | print 'Operation cancelled.' |
|
1797 | print 'Operation cancelled.' | |
1798 | return |
|
1798 | return | |
1799 | cmds = ''.join(self.extract_input_slices(ranges,opts.has_key('r'))) |
|
1799 | cmds = ''.join(self.extract_input_slices(ranges,opts.has_key('r'))) | |
1800 | f = file(fname,'w') |
|
1800 | f = file(fname,'w') | |
1801 | f.write(cmds) |
|
1801 | f.write(cmds) | |
1802 | f.close() |
|
1802 | f.close() | |
1803 | print 'The following commands were written to file `%s`:' % fname |
|
1803 | print 'The following commands were written to file `%s`:' % fname | |
1804 | print cmds |
|
1804 | print cmds | |
1805 |
|
1805 | |||
1806 | def _edit_macro(self,mname,macro): |
|
1806 | def _edit_macro(self,mname,macro): | |
1807 | """open an editor with the macro data in a file""" |
|
1807 | """open an editor with the macro data in a file""" | |
1808 | filename = self.shell.mktempfile(macro.value) |
|
1808 | filename = self.shell.mktempfile(macro.value) | |
1809 | self.shell.hooks.editor(filename) |
|
1809 | self.shell.hooks.editor(filename) | |
1810 |
|
1810 | |||
1811 | # and make a new macro object, to replace the old one |
|
1811 | # and make a new macro object, to replace the old one | |
1812 | mfile = open(filename) |
|
1812 | mfile = open(filename) | |
1813 | mvalue = mfile.read() |
|
1813 | mvalue = mfile.read() | |
1814 | mfile.close() |
|
1814 | mfile.close() | |
1815 | self.shell.user_ns[mname] = Macro(mvalue) |
|
1815 | self.shell.user_ns[mname] = Macro(mvalue) | |
1816 |
|
1816 | |||
1817 | def magic_ed(self,parameter_s=''): |
|
1817 | def magic_ed(self,parameter_s=''): | |
1818 | """Alias to %edit.""" |
|
1818 | """Alias to %edit.""" | |
1819 | return self.magic_edit(parameter_s) |
|
1819 | return self.magic_edit(parameter_s) | |
1820 |
|
1820 | |||
1821 | def magic_edit(self,parameter_s='',last_call=['','']): |
|
1821 | def magic_edit(self,parameter_s='',last_call=['','']): | |
1822 | """Bring up an editor and execute the resulting code. |
|
1822 | """Bring up an editor and execute the resulting code. | |
1823 |
|
1823 | |||
1824 | Usage: |
|
1824 | Usage: | |
1825 | %edit [options] [args] |
|
1825 | %edit [options] [args] | |
1826 |
|
1826 | |||
1827 | %edit runs IPython's editor hook. The default version of this hook is |
|
1827 | %edit runs IPython's editor hook. The default version of this hook is | |
1828 | set to call the __IPYTHON__.rc.editor command. This is read from your |
|
1828 | set to call the __IPYTHON__.rc.editor command. This is read from your | |
1829 | environment variable $EDITOR. If this isn't found, it will default to |
|
1829 | environment variable $EDITOR. If this isn't found, it will default to | |
1830 | vi under Linux/Unix and to notepad under Windows. See the end of this |
|
1830 | vi under Linux/Unix and to notepad under Windows. See the end of this | |
1831 | docstring for how to change the editor hook. |
|
1831 | docstring for how to change the editor hook. | |
1832 |
|
1832 | |||
1833 | You can also set the value of this editor via the command line option |
|
1833 | You can also set the value of this editor via the command line option | |
1834 | '-editor' or in your ipythonrc file. This is useful if you wish to use |
|
1834 | '-editor' or in your ipythonrc file. This is useful if you wish to use | |
1835 | specifically for IPython an editor different from your typical default |
|
1835 | specifically for IPython an editor different from your typical default | |
1836 | (and for Windows users who typically don't set environment variables). |
|
1836 | (and for Windows users who typically don't set environment variables). | |
1837 |
|
1837 | |||
1838 | This command allows you to conveniently edit multi-line code right in |
|
1838 | This command allows you to conveniently edit multi-line code right in | |
1839 | your IPython session. |
|
1839 | your IPython session. | |
1840 |
|
1840 | |||
1841 | If called without arguments, %edit opens up an empty editor with a |
|
1841 | If called without arguments, %edit opens up an empty editor with a | |
1842 | temporary file and will execute the contents of this file when you |
|
1842 | temporary file and will execute the contents of this file when you | |
1843 | close it (don't forget to save it!). |
|
1843 | close it (don't forget to save it!). | |
1844 |
|
1844 | |||
1845 |
|
1845 | |||
1846 | Options: |
|
1846 | Options: | |
1847 |
|
1847 | |||
1848 | -n <number>: open the editor at a specified line number. By default, |
|
1848 | -n <number>: open the editor at a specified line number. By default, | |
1849 | the IPython editor hook uses the unix syntax 'editor +N filename', but |
|
1849 | the IPython editor hook uses the unix syntax 'editor +N filename', but | |
1850 | you can configure this by providing your own modified hook if your |
|
1850 | you can configure this by providing your own modified hook if your | |
1851 | favorite editor supports line-number specifications with a different |
|
1851 | favorite editor supports line-number specifications with a different | |
1852 | syntax. |
|
1852 | syntax. | |
1853 |
|
1853 | |||
1854 | -p: this will call the editor with the same data as the previous time |
|
1854 | -p: this will call the editor with the same data as the previous time | |
1855 | it was used, regardless of how long ago (in your current session) it |
|
1855 | it was used, regardless of how long ago (in your current session) it | |
1856 | was. |
|
1856 | was. | |
1857 |
|
1857 | |||
1858 | -r: use 'raw' input. This option only applies to input taken from the |
|
1858 | -r: use 'raw' input. This option only applies to input taken from the | |
1859 | user's history. By default, the 'processed' history is used, so that |
|
1859 | user's history. By default, the 'processed' history is used, so that | |
1860 | magics are loaded in their transformed version to valid Python. If |
|
1860 | magics are loaded in their transformed version to valid Python. If | |
1861 | this option is given, the raw input as typed as the command line is |
|
1861 | this option is given, the raw input as typed as the command line is | |
1862 | used instead. When you exit the editor, it will be executed by |
|
1862 | used instead. When you exit the editor, it will be executed by | |
1863 | IPython's own processor. |
|
1863 | IPython's own processor. | |
1864 |
|
1864 | |||
1865 | -x: do not execute the edited code immediately upon exit. This is |
|
1865 | -x: do not execute the edited code immediately upon exit. This is | |
1866 | mainly useful if you are editing programs which need to be called with |
|
1866 | mainly useful if you are editing programs which need to be called with | |
1867 | command line arguments, which you can then do using %run. |
|
1867 | command line arguments, which you can then do using %run. | |
1868 |
|
1868 | |||
1869 |
|
1869 | |||
1870 | Arguments: |
|
1870 | Arguments: | |
1871 |
|
1871 | |||
1872 | If arguments are given, the following possibilites exist: |
|
1872 | If arguments are given, the following possibilites exist: | |
1873 |
|
1873 | |||
1874 | - The arguments are numbers or pairs of colon-separated numbers (like |
|
1874 | - The arguments are numbers or pairs of colon-separated numbers (like | |
1875 | 1 4:8 9). These are interpreted as lines of previous input to be |
|
1875 | 1 4:8 9). These are interpreted as lines of previous input to be | |
1876 | loaded into the editor. The syntax is the same of the %macro command. |
|
1876 | loaded into the editor. The syntax is the same of the %macro command. | |
1877 |
|
1877 | |||
1878 | - If the argument doesn't start with a number, it is evaluated as a |
|
1878 | - If the argument doesn't start with a number, it is evaluated as a | |
1879 | variable and its contents loaded into the editor. You can thus edit |
|
1879 | variable and its contents loaded into the editor. You can thus edit | |
1880 | any string which contains python code (including the result of |
|
1880 | any string which contains python code (including the result of | |
1881 | previous edits). |
|
1881 | previous edits). | |
1882 |
|
1882 | |||
1883 | - If the argument is the name of an object (other than a string), |
|
1883 | - If the argument is the name of an object (other than a string), | |
1884 | IPython will try to locate the file where it was defined and open the |
|
1884 | IPython will try to locate the file where it was defined and open the | |
1885 | editor at the point where it is defined. You can use `%edit function` |
|
1885 | editor at the point where it is defined. You can use `%edit function` | |
1886 | to load an editor exactly at the point where 'function' is defined, |
|
1886 | to load an editor exactly at the point where 'function' is defined, | |
1887 | edit it and have the file be executed automatically. |
|
1887 | edit it and have the file be executed automatically. | |
1888 |
|
1888 | |||
1889 | If the object is a macro (see %macro for details), this opens up your |
|
1889 | If the object is a macro (see %macro for details), this opens up your | |
1890 | specified editor with a temporary file containing the macro's data. |
|
1890 | specified editor with a temporary file containing the macro's data. | |
1891 | Upon exit, the macro is reloaded with the contents of the file. |
|
1891 | Upon exit, the macro is reloaded with the contents of the file. | |
1892 |
|
1892 | |||
1893 | Note: opening at an exact line is only supported under Unix, and some |
|
1893 | Note: opening at an exact line is only supported under Unix, and some | |
1894 | editors (like kedit and gedit up to Gnome 2.8) do not understand the |
|
1894 | editors (like kedit and gedit up to Gnome 2.8) do not understand the | |
1895 | '+NUMBER' parameter necessary for this feature. Good editors like |
|
1895 | '+NUMBER' parameter necessary for this feature. Good editors like | |
1896 | (X)Emacs, vi, jed, pico and joe all do. |
|
1896 | (X)Emacs, vi, jed, pico and joe all do. | |
1897 |
|
1897 | |||
1898 | - If the argument is not found as a variable, IPython will look for a |
|
1898 | - If the argument is not found as a variable, IPython will look for a | |
1899 | file with that name (adding .py if necessary) and load it into the |
|
1899 | file with that name (adding .py if necessary) and load it into the | |
1900 | editor. It will execute its contents with execfile() when you exit, |
|
1900 | editor. It will execute its contents with execfile() when you exit, | |
1901 | loading any code in the file into your interactive namespace. |
|
1901 | loading any code in the file into your interactive namespace. | |
1902 |
|
1902 | |||
1903 | After executing your code, %edit will return as output the code you |
|
1903 | After executing your code, %edit will return as output the code you | |
1904 | typed in the editor (except when it was an existing file). This way |
|
1904 | typed in the editor (except when it was an existing file). This way | |
1905 | you can reload the code in further invocations of %edit as a variable, |
|
1905 | you can reload the code in further invocations of %edit as a variable, | |
1906 | via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of |
|
1906 | via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of | |
1907 | the output. |
|
1907 | the output. | |
1908 |
|
1908 | |||
1909 | Note that %edit is also available through the alias %ed. |
|
1909 | Note that %edit is also available through the alias %ed. | |
1910 |
|
1910 | |||
1911 | This is an example of creating a simple function inside the editor and |
|
1911 | This is an example of creating a simple function inside the editor and | |
1912 | then modifying it. First, start up the editor: |
|
1912 | then modifying it. First, start up the editor: | |
1913 |
|
1913 | |||
1914 | In [1]: ed\\ |
|
1914 | In [1]: ed\\ | |
1915 | Editing... done. Executing edited code...\\ |
|
1915 | Editing... done. Executing edited code...\\ | |
1916 | Out[1]: 'def foo():\\n print "foo() was defined in an editing session"\\n' |
|
1916 | Out[1]: 'def foo():\\n print "foo() was defined in an editing session"\\n' | |
1917 |
|
1917 | |||
1918 | We can then call the function foo(): |
|
1918 | We can then call the function foo(): | |
1919 |
|
1919 | |||
1920 | In [2]: foo()\\ |
|
1920 | In [2]: foo()\\ | |
1921 | foo() was defined in an editing session |
|
1921 | foo() was defined in an editing session | |
1922 |
|
1922 | |||
1923 | Now we edit foo. IPython automatically loads the editor with the |
|
1923 | Now we edit foo. IPython automatically loads the editor with the | |
1924 | (temporary) file where foo() was previously defined: |
|
1924 | (temporary) file where foo() was previously defined: | |
1925 |
|
1925 | |||
1926 | In [3]: ed foo\\ |
|
1926 | In [3]: ed foo\\ | |
1927 | Editing... done. Executing edited code... |
|
1927 | Editing... done. Executing edited code... | |
1928 |
|
1928 | |||
1929 | And if we call foo() again we get the modified version: |
|
1929 | And if we call foo() again we get the modified version: | |
1930 |
|
1930 | |||
1931 | In [4]: foo()\\ |
|
1931 | In [4]: foo()\\ | |
1932 | foo() has now been changed! |
|
1932 | foo() has now been changed! | |
1933 |
|
1933 | |||
1934 | Here is an example of how to edit a code snippet successive |
|
1934 | Here is an example of how to edit a code snippet successive | |
1935 | times. First we call the editor: |
|
1935 | times. First we call the editor: | |
1936 |
|
1936 | |||
1937 | In [8]: ed\\ |
|
1937 | In [8]: ed\\ | |
1938 | Editing... done. Executing edited code...\\ |
|
1938 | Editing... done. Executing edited code...\\ | |
1939 | hello\\ |
|
1939 | hello\\ | |
1940 | Out[8]: "print 'hello'\\n" |
|
1940 | Out[8]: "print 'hello'\\n" | |
1941 |
|
1941 | |||
1942 | Now we call it again with the previous output (stored in _): |
|
1942 | Now we call it again with the previous output (stored in _): | |
1943 |
|
1943 | |||
1944 | In [9]: ed _\\ |
|
1944 | In [9]: ed _\\ | |
1945 | Editing... done. Executing edited code...\\ |
|
1945 | Editing... done. Executing edited code...\\ | |
1946 | hello world\\ |
|
1946 | hello world\\ | |
1947 | Out[9]: "print 'hello world'\\n" |
|
1947 | Out[9]: "print 'hello world'\\n" | |
1948 |
|
1948 | |||
1949 | Now we call it with the output #8 (stored in _8, also as Out[8]): |
|
1949 | Now we call it with the output #8 (stored in _8, also as Out[8]): | |
1950 |
|
1950 | |||
1951 | In [10]: ed _8\\ |
|
1951 | In [10]: ed _8\\ | |
1952 | Editing... done. Executing edited code...\\ |
|
1952 | Editing... done. Executing edited code...\\ | |
1953 | hello again\\ |
|
1953 | hello again\\ | |
1954 | Out[10]: "print 'hello again'\\n" |
|
1954 | Out[10]: "print 'hello again'\\n" | |
1955 |
|
1955 | |||
1956 |
|
1956 | |||
1957 | Changing the default editor hook: |
|
1957 | Changing the default editor hook: | |
1958 |
|
1958 | |||
1959 | If you wish to write your own editor hook, you can put it in a |
|
1959 | If you wish to write your own editor hook, you can put it in a | |
1960 | configuration file which you load at startup time. The default hook |
|
1960 | configuration file which you load at startup time. The default hook | |
1961 | is defined in the IPython.hooks module, and you can use that as a |
|
1961 | is defined in the IPython.hooks module, and you can use that as a | |
1962 | starting example for further modifications. That file also has |
|
1962 | starting example for further modifications. That file also has | |
1963 | general instructions on how to set a new hook for use once you've |
|
1963 | general instructions on how to set a new hook for use once you've | |
1964 | defined it.""" |
|
1964 | defined it.""" | |
1965 |
|
1965 | |||
1966 | # FIXME: This function has become a convoluted mess. It needs a |
|
1966 | # FIXME: This function has become a convoluted mess. It needs a | |
1967 | # ground-up rewrite with clean, simple logic. |
|
1967 | # ground-up rewrite with clean, simple logic. | |
1968 |
|
1968 | |||
1969 | def make_filename(arg): |
|
1969 | def make_filename(arg): | |
1970 | "Make a filename from the given args" |
|
1970 | "Make a filename from the given args" | |
1971 | try: |
|
1971 | try: | |
1972 | filename = get_py_filename(arg) |
|
1972 | filename = get_py_filename(arg) | |
1973 | except IOError: |
|
1973 | except IOError: | |
1974 | if args.endswith('.py'): |
|
1974 | if args.endswith('.py'): | |
1975 | filename = arg |
|
1975 | filename = arg | |
1976 | else: |
|
1976 | else: | |
1977 | filename = None |
|
1977 | filename = None | |
1978 | return filename |
|
1978 | return filename | |
1979 |
|
1979 | |||
1980 | # custom exceptions |
|
1980 | # custom exceptions | |
1981 | class DataIsObject(Exception): pass |
|
1981 | class DataIsObject(Exception): pass | |
1982 |
|
1982 | |||
1983 | opts,args = self.parse_options(parameter_s,'prxn:') |
|
1983 | opts,args = self.parse_options(parameter_s,'prxn:') | |
1984 | # Set a few locals from the options for convenience: |
|
1984 | # Set a few locals from the options for convenience: | |
1985 | opts_p = opts.has_key('p') |
|
1985 | opts_p = opts.has_key('p') | |
1986 | opts_r = opts.has_key('r') |
|
1986 | opts_r = opts.has_key('r') | |
1987 |
|
1987 | |||
1988 | # Default line number value |
|
1988 | # Default line number value | |
1989 | lineno = opts.get('n',None) |
|
1989 | lineno = opts.get('n',None) | |
1990 |
|
1990 | |||
1991 | if opts_p: |
|
1991 | if opts_p: | |
1992 | args = '_%s' % last_call[0] |
|
1992 | args = '_%s' % last_call[0] | |
1993 | if not self.shell.user_ns.has_key(args): |
|
1993 | if not self.shell.user_ns.has_key(args): | |
1994 | args = last_call[1] |
|
1994 | args = last_call[1] | |
1995 |
|
1995 | |||
1996 | # use last_call to remember the state of the previous call, but don't |
|
1996 | # use last_call to remember the state of the previous call, but don't | |
1997 | # let it be clobbered by successive '-p' calls. |
|
1997 | # let it be clobbered by successive '-p' calls. | |
1998 | try: |
|
1998 | try: | |
1999 | last_call[0] = self.shell.outputcache.prompt_count |
|
1999 | last_call[0] = self.shell.outputcache.prompt_count | |
2000 | if not opts_p: |
|
2000 | if not opts_p: | |
2001 | last_call[1] = parameter_s |
|
2001 | last_call[1] = parameter_s | |
2002 | except: |
|
2002 | except: | |
2003 | pass |
|
2003 | pass | |
2004 |
|
2004 | |||
2005 | # by default this is done with temp files, except when the given |
|
2005 | # by default this is done with temp files, except when the given | |
2006 | # arg is a filename |
|
2006 | # arg is a filename | |
2007 | use_temp = 1 |
|
2007 | use_temp = 1 | |
2008 |
|
2008 | |||
2009 | if re.match(r'\d',args): |
|
2009 | if re.match(r'\d',args): | |
2010 | # Mode where user specifies ranges of lines, like in %macro. |
|
2010 | # Mode where user specifies ranges of lines, like in %macro. | |
2011 | # This means that you can't edit files whose names begin with |
|
2011 | # This means that you can't edit files whose names begin with | |
2012 | # numbers this way. Tough. |
|
2012 | # numbers this way. Tough. | |
2013 | ranges = args.split() |
|
2013 | ranges = args.split() | |
2014 | data = ''.join(self.extract_input_slices(ranges,opts_r)) |
|
2014 | data = ''.join(self.extract_input_slices(ranges,opts_r)) | |
2015 | elif args.endswith('.py'): |
|
2015 | elif args.endswith('.py'): | |
2016 | filename = make_filename(args) |
|
2016 | filename = make_filename(args) | |
2017 | data = '' |
|
2017 | data = '' | |
2018 | use_temp = 0 |
|
2018 | use_temp = 0 | |
2019 | elif args: |
|
2019 | elif args: | |
2020 | try: |
|
2020 | try: | |
2021 | # Load the parameter given as a variable. If not a string, |
|
2021 | # Load the parameter given as a variable. If not a string, | |
2022 | # process it as an object instead (below) |
|
2022 | # process it as an object instead (below) | |
2023 |
|
2023 | |||
2024 | #print '*** args',args,'type',type(args) # dbg |
|
2024 | #print '*** args',args,'type',type(args) # dbg | |
2025 | data = eval(args,self.shell.user_ns) |
|
2025 | data = eval(args,self.shell.user_ns) | |
2026 | if not type(data) in StringTypes: |
|
2026 | if not type(data) in StringTypes: | |
2027 | raise DataIsObject |
|
2027 | raise DataIsObject | |
2028 |
|
2028 | |||
2029 | except (NameError,SyntaxError): |
|
2029 | except (NameError,SyntaxError): | |
2030 | # given argument is not a variable, try as a filename |
|
2030 | # given argument is not a variable, try as a filename | |
2031 | filename = make_filename(args) |
|
2031 | filename = make_filename(args) | |
2032 | if filename is None: |
|
2032 | if filename is None: | |
2033 | warn("Argument given (%s) can't be found as a variable " |
|
2033 | warn("Argument given (%s) can't be found as a variable " | |
2034 | "or as a filename." % args) |
|
2034 | "or as a filename." % args) | |
2035 | return |
|
2035 | return | |
2036 |
|
2036 | |||
2037 | data = '' |
|
2037 | data = '' | |
2038 | use_temp = 0 |
|
2038 | use_temp = 0 | |
2039 | except DataIsObject: |
|
2039 | except DataIsObject: | |
2040 |
|
2040 | |||
2041 | # macros have a special edit function |
|
2041 | # macros have a special edit function | |
2042 | if isinstance(data,Macro): |
|
2042 | if isinstance(data,Macro): | |
2043 | self._edit_macro(args,data) |
|
2043 | self._edit_macro(args,data) | |
2044 | return |
|
2044 | return | |
2045 |
|
2045 | |||
2046 | # For objects, try to edit the file where they are defined |
|
2046 | # For objects, try to edit the file where they are defined | |
2047 | try: |
|
2047 | try: | |
2048 | filename = inspect.getabsfile(data) |
|
2048 | filename = inspect.getabsfile(data) | |
2049 | datafile = 1 |
|
2049 | datafile = 1 | |
2050 | except TypeError: |
|
2050 | except TypeError: | |
2051 | filename = make_filename(args) |
|
2051 | filename = make_filename(args) | |
2052 | datafile = 1 |
|
2052 | datafile = 1 | |
2053 | warn('Could not find file where `%s` is defined.\n' |
|
2053 | warn('Could not find file where `%s` is defined.\n' | |
2054 | 'Opening a file named `%s`' % (args,filename)) |
|
2054 | 'Opening a file named `%s`' % (args,filename)) | |
2055 | # Now, make sure we can actually read the source (if it was in |
|
2055 | # Now, make sure we can actually read the source (if it was in | |
2056 | # a temp file it's gone by now). |
|
2056 | # a temp file it's gone by now). | |
2057 | if datafile: |
|
2057 | if datafile: | |
2058 | try: |
|
2058 | try: | |
2059 | if lineno is None: |
|
2059 | if lineno is None: | |
2060 | lineno = inspect.getsourcelines(data)[1] |
|
2060 | lineno = inspect.getsourcelines(data)[1] | |
2061 | except IOError: |
|
2061 | except IOError: | |
2062 | filename = make_filename(args) |
|
2062 | filename = make_filename(args) | |
2063 | if filename is None: |
|
2063 | if filename is None: | |
2064 | warn('The file `%s` where `%s` was defined cannot ' |
|
2064 | warn('The file `%s` where `%s` was defined cannot ' | |
2065 | 'be read.' % (filename,data)) |
|
2065 | 'be read.' % (filename,data)) | |
2066 | return |
|
2066 | return | |
2067 | use_temp = 0 |
|
2067 | use_temp = 0 | |
2068 | else: |
|
2068 | else: | |
2069 | data = '' |
|
2069 | data = '' | |
2070 |
|
2070 | |||
2071 | if use_temp: |
|
2071 | if use_temp: | |
2072 | filename = self.shell.mktempfile(data) |
|
2072 | filename = self.shell.mktempfile(data) | |
2073 | print 'IPython will make a temporary file named:',filename |
|
2073 | print 'IPython will make a temporary file named:',filename | |
2074 |
|
2074 | |||
2075 | # do actual editing here |
|
2075 | # do actual editing here | |
2076 | print 'Editing...', |
|
2076 | print 'Editing...', | |
2077 | sys.stdout.flush() |
|
2077 | sys.stdout.flush() | |
2078 | self.shell.hooks.editor(filename,lineno) |
|
2078 | self.shell.hooks.editor(filename,lineno) | |
2079 | if opts.has_key('x'): # -x prevents actual execution |
|
2079 | if opts.has_key('x'): # -x prevents actual execution | |
2080 |
|
2080 | |||
2081 | else: |
|
2081 | else: | |
2082 | print 'done. Executing edited code...' |
|
2082 | print 'done. Executing edited code...' | |
2083 | if opts_r: |
|
2083 | if opts_r: | |
2084 | self.shell.runlines(file_read(filename)) |
|
2084 | self.shell.runlines(file_read(filename)) | |
2085 | else: |
|
2085 | else: | |
2086 | self.shell.safe_execfile(filename,self.shell.user_ns, |
|
2086 | self.shell.safe_execfile(filename,self.shell.user_ns, | |
2087 | self.shell.user_ns) |
|
2087 | self.shell.user_ns) | |
2088 | if use_temp: |
|
2088 | if use_temp: | |
2089 | try: |
|
2089 | try: | |
2090 | return open(filename).read() |
|
2090 | return open(filename).read() | |
2091 | except IOError,msg: |
|
2091 | except IOError,msg: | |
2092 | if msg.filename == filename: |
|
2092 | if msg.filename == filename: | |
2093 | warn('File not found. Did you forget to save?') |
|
2093 | warn('File not found. Did you forget to save?') | |
2094 | return |
|
2094 | return | |
2095 | else: |
|
2095 | else: | |
2096 | self.shell.showtraceback() |
|
2096 | self.shell.showtraceback() | |
2097 |
|
2097 | |||
2098 | def magic_xmode(self,parameter_s = ''): |
|
2098 | def magic_xmode(self,parameter_s = ''): | |
2099 | """Switch modes for the exception handlers. |
|
2099 | """Switch modes for the exception handlers. | |
2100 |
|
2100 | |||
2101 | Valid modes: Plain, Context and Verbose. |
|
2101 | Valid modes: Plain, Context and Verbose. | |
2102 |
|
2102 | |||
2103 | If called without arguments, acts as a toggle.""" |
|
2103 | If called without arguments, acts as a toggle.""" | |
2104 |
|
2104 | |||
2105 | def xmode_switch_err(name): |
|
2105 | def xmode_switch_err(name): | |
2106 | warn('Error changing %s exception modes.\n%s' % |
|
2106 | warn('Error changing %s exception modes.\n%s' % | |
2107 | (name,sys.exc_info()[1])) |
|
2107 | (name,sys.exc_info()[1])) | |
2108 |
|
2108 | |||
2109 | shell = self.shell |
|
2109 | shell = self.shell | |
2110 | new_mode = parameter_s.strip().capitalize() |
|
2110 | new_mode = parameter_s.strip().capitalize() | |
2111 | try: |
|
2111 | try: | |
2112 | shell.InteractiveTB.set_mode(mode=new_mode) |
|
2112 | shell.InteractiveTB.set_mode(mode=new_mode) | |
2113 | print 'Exception reporting mode:',shell.InteractiveTB.mode |
|
2113 | print 'Exception reporting mode:',shell.InteractiveTB.mode | |
2114 | except: |
|
2114 | except: | |
2115 | xmode_switch_err('user') |
|
2115 | xmode_switch_err('user') | |
2116 |
|
2116 | |||
2117 | # threaded shells use a special handler in sys.excepthook |
|
2117 | # threaded shells use a special handler in sys.excepthook | |
2118 | if shell.isthreaded: |
|
2118 | if shell.isthreaded: | |
2119 | try: |
|
2119 | try: | |
2120 | shell.sys_excepthook.set_mode(mode=new_mode) |
|
2120 | shell.sys_excepthook.set_mode(mode=new_mode) | |
2121 | except: |
|
2121 | except: | |
2122 | xmode_switch_err('threaded') |
|
2122 | xmode_switch_err('threaded') | |
2123 |
|
2123 | |||
2124 | def magic_colors(self,parameter_s = ''): |
|
2124 | def magic_colors(self,parameter_s = ''): | |
2125 | """Switch color scheme for prompts, info system and exception handlers. |
|
2125 | """Switch color scheme for prompts, info system and exception handlers. | |
2126 |
|
2126 | |||
2127 | Currently implemented schemes: NoColor, Linux, LightBG. |
|
2127 | Currently implemented schemes: NoColor, Linux, LightBG. | |
2128 |
|
2128 | |||
2129 | Color scheme names are not case-sensitive.""" |
|
2129 | Color scheme names are not case-sensitive.""" | |
2130 |
|
2130 | |||
2131 | def color_switch_err(name): |
|
2131 | def color_switch_err(name): | |
2132 | warn('Error changing %s color schemes.\n%s' % |
|
2132 | warn('Error changing %s color schemes.\n%s' % | |
2133 | (name,sys.exc_info()[1])) |
|
2133 | (name,sys.exc_info()[1])) | |
2134 |
|
2134 | |||
2135 |
|
2135 | |||
2136 | new_scheme = parameter_s.strip() |
|
2136 | new_scheme = parameter_s.strip() | |
2137 | if not new_scheme: |
|
2137 | if not new_scheme: | |
2138 | print 'You must specify a color scheme.' |
|
2138 | print 'You must specify a color scheme.' | |
2139 | return |
|
2139 | return | |
2140 | # local shortcut |
|
2140 | # local shortcut | |
2141 | shell = self.shell |
|
2141 | shell = self.shell | |
2142 |
|
2142 | |||
2143 | import IPython.rlineimpl as readline |
|
2143 | import IPython.rlineimpl as readline | |
2144 |
|
2144 | |||
2145 | if not readline.have_readline and sys.platform == "win32": |
|
2145 | if not readline.have_readline and sys.platform == "win32": | |
2146 | msg = """\ |
|
2146 | msg = """\ | |
2147 | Proper color support under MS Windows requires the pyreadline library. |
|
2147 | Proper color support under MS Windows requires the pyreadline library. | |
2148 | You can find it at: |
|
2148 | You can find it at: | |
2149 | http://ipython.scipy.org/moin/PyReadline/Intro |
|
2149 | http://ipython.scipy.org/moin/PyReadline/Intro | |
2150 | Gary's readline needs the ctypes module, from: |
|
2150 | Gary's readline needs the ctypes module, from: | |
2151 | http://starship.python.net/crew/theller/ctypes |
|
2151 | http://starship.python.net/crew/theller/ctypes | |
2152 | (Note that ctypes is already part of Python versions 2.5 and newer). |
|
2152 | (Note that ctypes is already part of Python versions 2.5 and newer). | |
2153 |
|
2153 | |||
2154 | Defaulting color scheme to 'NoColor'""" |
|
2154 | Defaulting color scheme to 'NoColor'""" | |
2155 | new_scheme = 'NoColor' |
|
2155 | new_scheme = 'NoColor' | |
2156 | warn(msg) |
|
2156 | warn(msg) | |
2157 |
|
2157 | |||
2158 | # readline option is 0 |
|
2158 | # readline option is 0 | |
2159 | if not shell.has_readline: |
|
2159 | if not shell.has_readline: | |
2160 | new_scheme = 'NoColor' |
|
2160 | new_scheme = 'NoColor' | |
2161 |
|
2161 | |||
2162 | # Set prompt colors |
|
2162 | # Set prompt colors | |
2163 | try: |
|
2163 | try: | |
2164 | shell.outputcache.set_colors(new_scheme) |
|
2164 | shell.outputcache.set_colors(new_scheme) | |
2165 | except: |
|
2165 | except: | |
2166 | color_switch_err('prompt') |
|
2166 | color_switch_err('prompt') | |
2167 | else: |
|
2167 | else: | |
2168 | shell.rc.colors = \ |
|
2168 | shell.rc.colors = \ | |
2169 | shell.outputcache.color_table.active_scheme_name |
|
2169 | shell.outputcache.color_table.active_scheme_name | |
2170 | # Set exception colors |
|
2170 | # Set exception colors | |
2171 | try: |
|
2171 | try: | |
2172 | shell.InteractiveTB.set_colors(scheme = new_scheme) |
|
2172 | shell.InteractiveTB.set_colors(scheme = new_scheme) | |
2173 | shell.SyntaxTB.set_colors(scheme = new_scheme) |
|
2173 | shell.SyntaxTB.set_colors(scheme = new_scheme) | |
2174 | except: |
|
2174 | except: | |
2175 | color_switch_err('exception') |
|
2175 | color_switch_err('exception') | |
2176 |
|
2176 | |||
2177 | # threaded shells use a verbose traceback in sys.excepthook |
|
2177 | # threaded shells use a verbose traceback in sys.excepthook | |
2178 | if shell.isthreaded: |
|
2178 | if shell.isthreaded: | |
2179 | try: |
|
2179 | try: | |
2180 | shell.sys_excepthook.set_colors(scheme=new_scheme) |
|
2180 | shell.sys_excepthook.set_colors(scheme=new_scheme) | |
2181 | except: |
|
2181 | except: | |
2182 | color_switch_err('system exception handler') |
|
2182 | color_switch_err('system exception handler') | |
2183 |
|
2183 | |||
2184 | # Set info (for 'object?') colors |
|
2184 | # Set info (for 'object?') colors | |
2185 | if shell.rc.color_info: |
|
2185 | if shell.rc.color_info: | |
2186 | try: |
|
2186 | try: | |
2187 | shell.inspector.set_active_scheme(new_scheme) |
|
2187 | shell.inspector.set_active_scheme(new_scheme) | |
2188 | except: |
|
2188 | except: | |
2189 | color_switch_err('object inspector') |
|
2189 | color_switch_err('object inspector') | |
2190 | else: |
|
2190 | else: | |
2191 | shell.inspector.set_active_scheme('NoColor') |
|
2191 | shell.inspector.set_active_scheme('NoColor') | |
2192 |
|
2192 | |||
2193 | def magic_color_info(self,parameter_s = ''): |
|
2193 | def magic_color_info(self,parameter_s = ''): | |
2194 | """Toggle color_info. |
|
2194 | """Toggle color_info. | |
2195 |
|
2195 | |||
2196 | The color_info configuration parameter controls whether colors are |
|
2196 | The color_info configuration parameter controls whether colors are | |
2197 | used for displaying object details (by things like %psource, %pfile or |
|
2197 | used for displaying object details (by things like %psource, %pfile or | |
2198 | the '?' system). This function toggles this value with each call. |
|
2198 | the '?' system). This function toggles this value with each call. | |
2199 |
|
2199 | |||
2200 | Note that unless you have a fairly recent pager (less works better |
|
2200 | Note that unless you have a fairly recent pager (less works better | |
2201 | than more) in your system, using colored object information displays |
|
2201 | than more) in your system, using colored object information displays | |
2202 | will not work properly. Test it and see.""" |
|
2202 | will not work properly. Test it and see.""" | |
2203 |
|
2203 | |||
2204 | self.shell.rc.color_info = 1 - self.shell.rc.color_info |
|
2204 | self.shell.rc.color_info = 1 - self.shell.rc.color_info | |
2205 | self.magic_colors(self.shell.rc.colors) |
|
2205 | self.magic_colors(self.shell.rc.colors) | |
2206 | print 'Object introspection functions have now coloring:', |
|
2206 | print 'Object introspection functions have now coloring:', | |
2207 | print ['OFF','ON'][self.shell.rc.color_info] |
|
2207 | print ['OFF','ON'][self.shell.rc.color_info] | |
2208 |
|
2208 | |||
2209 | def magic_Pprint(self, parameter_s=''): |
|
2209 | def magic_Pprint(self, parameter_s=''): | |
2210 | """Toggle pretty printing on/off.""" |
|
2210 | """Toggle pretty printing on/off.""" | |
2211 |
|
2211 | |||
2212 | self.shell.rc.pprint = 1 - self.shell.rc.pprint |
|
2212 | self.shell.rc.pprint = 1 - self.shell.rc.pprint | |
2213 | print 'Pretty printing has been turned', \ |
|
2213 | print 'Pretty printing has been turned', \ | |
2214 | ['OFF','ON'][self.shell.rc.pprint] |
|
2214 | ['OFF','ON'][self.shell.rc.pprint] | |
2215 |
|
2215 | |||
2216 | def magic_exit(self, parameter_s=''): |
|
2216 | def magic_exit(self, parameter_s=''): | |
2217 | """Exit IPython, confirming if configured to do so. |
|
2217 | """Exit IPython, confirming if configured to do so. | |
2218 |
|
2218 | |||
2219 | You can configure whether IPython asks for confirmation upon exit by |
|
2219 | You can configure whether IPython asks for confirmation upon exit by | |
2220 | setting the confirm_exit flag in the ipythonrc file.""" |
|
2220 | setting the confirm_exit flag in the ipythonrc file.""" | |
2221 |
|
2221 | |||
2222 | self.shell.exit() |
|
2222 | self.shell.exit() | |
2223 |
|
2223 | |||
2224 | def magic_quit(self, parameter_s=''): |
|
2224 | def magic_quit(self, parameter_s=''): | |
2225 | """Exit IPython, confirming if configured to do so (like %exit)""" |
|
2225 | """Exit IPython, confirming if configured to do so (like %exit)""" | |
2226 |
|
2226 | |||
2227 | self.shell.exit() |
|
2227 | self.shell.exit() | |
2228 |
|
2228 | |||
2229 | def magic_Exit(self, parameter_s=''): |
|
2229 | def magic_Exit(self, parameter_s=''): | |
2230 | """Exit IPython without confirmation.""" |
|
2230 | """Exit IPython without confirmation.""" | |
2231 |
|
2231 | |||
2232 | self.shell.exit_now = True |
|
2232 | self.shell.exit_now = True | |
2233 |
|
2233 | |||
2234 | #...................................................................... |
|
2234 | #...................................................................... | |
2235 | # Functions to implement unix shell-type things |
|
2235 | # Functions to implement unix shell-type things | |
2236 |
|
2236 | |||
2237 | def magic_alias(self, parameter_s = ''): |
|
2237 | def magic_alias(self, parameter_s = ''): | |
2238 | """Define an alias for a system command. |
|
2238 | """Define an alias for a system command. | |
2239 |
|
2239 | |||
2240 | '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd' |
|
2240 | '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd' | |
2241 |
|
2241 | |||
2242 | Then, typing 'alias_name params' will execute the system command 'cmd |
|
2242 | Then, typing 'alias_name params' will execute the system command 'cmd | |
2243 | params' (from your underlying operating system). |
|
2243 | params' (from your underlying operating system). | |
2244 |
|
2244 | |||
2245 | Aliases have lower precedence than magic functions and Python normal |
|
2245 | Aliases have lower precedence than magic functions and Python normal | |
2246 | variables, so if 'foo' is both a Python variable and an alias, the |
|
2246 | variables, so if 'foo' is both a Python variable and an alias, the | |
2247 | alias can not be executed until 'del foo' removes the Python variable. |
|
2247 | alias can not be executed until 'del foo' removes the Python variable. | |
2248 |
|
2248 | |||
2249 | You can use the %l specifier in an alias definition to represent the |
|
2249 | You can use the %l specifier in an alias definition to represent the | |
2250 | whole line when the alias is called. For example: |
|
2250 | whole line when the alias is called. For example: | |
2251 |
|
2251 | |||
2252 | In [2]: alias all echo "Input in brackets: <%l>"\\ |
|
2252 | In [2]: alias all echo "Input in brackets: <%l>"\\ | |
2253 | In [3]: all hello world\\ |
|
2253 | In [3]: all hello world\\ | |
2254 | Input in brackets: <hello world> |
|
2254 | Input in brackets: <hello world> | |
2255 |
|
2255 | |||
2256 | You can also define aliases with parameters using %s specifiers (one |
|
2256 | You can also define aliases with parameters using %s specifiers (one | |
2257 | per parameter): |
|
2257 | per parameter): | |
2258 |
|
2258 | |||
2259 | In [1]: alias parts echo first %s second %s\\ |
|
2259 | In [1]: alias parts echo first %s second %s\\ | |
2260 | In [2]: %parts A B\\ |
|
2260 | In [2]: %parts A B\\ | |
2261 | first A second B\\ |
|
2261 | first A second B\\ | |
2262 | In [3]: %parts A\\ |
|
2262 | In [3]: %parts A\\ | |
2263 | Incorrect number of arguments: 2 expected.\\ |
|
2263 | Incorrect number of arguments: 2 expected.\\ | |
2264 | parts is an alias to: 'echo first %s second %s' |
|
2264 | parts is an alias to: 'echo first %s second %s' | |
2265 |
|
2265 | |||
2266 | Note that %l and %s are mutually exclusive. You can only use one or |
|
2266 | Note that %l and %s are mutually exclusive. You can only use one or | |
2267 | the other in your aliases. |
|
2267 | the other in your aliases. | |
2268 |
|
2268 | |||
2269 | Aliases expand Python variables just like system calls using ! or !! |
|
2269 | Aliases expand Python variables just like system calls using ! or !! | |
2270 | do: all expressions prefixed with '$' get expanded. For details of |
|
2270 | do: all expressions prefixed with '$' get expanded. For details of | |
2271 | the semantic rules, see PEP-215: |
|
2271 | the semantic rules, see PEP-215: | |
2272 | http://www.python.org/peps/pep-0215.html. This is the library used by |
|
2272 | http://www.python.org/peps/pep-0215.html. This is the library used by | |
2273 | IPython for variable expansion. If you want to access a true shell |
|
2273 | IPython for variable expansion. If you want to access a true shell | |
2274 | variable, an extra $ is necessary to prevent its expansion by IPython: |
|
2274 | variable, an extra $ is necessary to prevent its expansion by IPython: | |
2275 |
|
2275 | |||
2276 | In [6]: alias show echo\\ |
|
2276 | In [6]: alias show echo\\ | |
2277 | In [7]: PATH='A Python string'\\ |
|
2277 | In [7]: PATH='A Python string'\\ | |
2278 | In [8]: show $PATH\\ |
|
2278 | In [8]: show $PATH\\ | |
2279 | A Python string\\ |
|
2279 | A Python string\\ | |
2280 | In [9]: show $$PATH\\ |
|
2280 | In [9]: show $$PATH\\ | |
2281 | /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:... |
|
2281 | /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:... | |
2282 |
|
2282 | |||
2283 | You can use the alias facility to acess all of $PATH. See the %rehash |
|
2283 | You can use the alias facility to acess all of $PATH. See the %rehash | |
2284 | and %rehashx functions, which automatically create aliases for the |
|
2284 | and %rehashx functions, which automatically create aliases for the | |
2285 | contents of your $PATH. |
|
2285 | contents of your $PATH. | |
2286 |
|
2286 | |||
2287 | If called with no parameters, %alias prints the current alias table.""" |
|
2287 | If called with no parameters, %alias prints the current alias table.""" | |
2288 |
|
2288 | |||
2289 | par = parameter_s.strip() |
|
2289 | par = parameter_s.strip() | |
2290 | if not par: |
|
2290 | if not par: | |
2291 | stored = self.db.get('stored_aliases', {} ) |
|
2291 | stored = self.db.get('stored_aliases', {} ) | |
2292 | atab = self.shell.alias_table |
|
2292 | atab = self.shell.alias_table | |
2293 | aliases = atab.keys() |
|
2293 | aliases = atab.keys() | |
2294 | aliases.sort() |
|
2294 | aliases.sort() | |
2295 | res = [] |
|
2295 | res = [] | |
2296 | showlast = [] |
|
2296 | showlast = [] | |
2297 | for alias in aliases: |
|
2297 | for alias in aliases: | |
2298 | try: |
|
2298 | try: | |
2299 | tgt = atab[alias][1] |
|
2299 | tgt = atab[alias][1] | |
2300 | except TypeError: |
|
2300 | except TypeError: | |
2301 | # unsubscriptable? probably a callable |
|
2301 | # unsubscriptable? probably a callable | |
2302 | tgt = atab[alias] |
|
2302 | tgt = atab[alias] | |
2303 | # 'interesting' aliases |
|
2303 | # 'interesting' aliases | |
2304 | if (alias in stored or |
|
2304 | if (alias in stored or | |
2305 | alias.lower() != os.path.splitext(tgt)[0].lower() or |
|
2305 | alias.lower() != os.path.splitext(tgt)[0].lower() or | |
2306 | ' ' in tgt): |
|
2306 | ' ' in tgt): | |
2307 | showlast.append((alias, tgt)) |
|
2307 | showlast.append((alias, tgt)) | |
2308 | else: |
|
2308 | else: | |
2309 | res.append((alias, tgt )) |
|
2309 | res.append((alias, tgt )) | |
2310 |
|
2310 | |||
2311 | # show most interesting aliases last |
|
2311 | # show most interesting aliases last | |
2312 | res.extend(showlast) |
|
2312 | res.extend(showlast) | |
2313 | print "Total number of aliases:",len(aliases) |
|
2313 | print "Total number of aliases:",len(aliases) | |
2314 | return res |
|
2314 | return res | |
2315 | try: |
|
2315 | try: | |
2316 | alias,cmd = par.split(None,1) |
|
2316 | alias,cmd = par.split(None,1) | |
2317 | except: |
|
2317 | except: | |
2318 | print OInspect.getdoc(self.magic_alias) |
|
2318 | print OInspect.getdoc(self.magic_alias) | |
2319 | else: |
|
2319 | else: | |
2320 | nargs = cmd.count('%s') |
|
2320 | nargs = cmd.count('%s') | |
2321 | if nargs>0 and cmd.find('%l')>=0: |
|
2321 | if nargs>0 and cmd.find('%l')>=0: | |
2322 | error('The %s and %l specifiers are mutually exclusive ' |
|
2322 | error('The %s and %l specifiers are mutually exclusive ' | |
2323 | 'in alias definitions.') |
|
2323 | 'in alias definitions.') | |
2324 | else: # all looks OK |
|
2324 | else: # all looks OK | |
2325 | self.shell.alias_table[alias] = (nargs,cmd) |
|
2325 | self.shell.alias_table[alias] = (nargs,cmd) | |
2326 | self.shell.alias_table_validate(verbose=0) |
|
2326 | self.shell.alias_table_validate(verbose=0) | |
2327 | # end magic_alias |
|
2327 | # end magic_alias | |
2328 |
|
2328 | |||
2329 | def magic_unalias(self, parameter_s = ''): |
|
2329 | def magic_unalias(self, parameter_s = ''): | |
2330 | """Remove an alias""" |
|
2330 | """Remove an alias""" | |
2331 |
|
2331 | |||
2332 | aname = parameter_s.strip() |
|
2332 | aname = parameter_s.strip() | |
2333 | if aname in self.shell.alias_table: |
|
2333 | if aname in self.shell.alias_table: | |
2334 | del self.shell.alias_table[aname] |
|
2334 | del self.shell.alias_table[aname] | |
2335 | stored = self.db.get('stored_aliases', {} ) |
|
2335 | stored = self.db.get('stored_aliases', {} ) | |
2336 | if aname in stored: |
|
2336 | if aname in stored: | |
2337 | print "Removing %stored alias",aname |
|
2337 | print "Removing %stored alias",aname | |
2338 | del stored[aname] |
|
2338 | del stored[aname] | |
2339 | self.db['stored_aliases'] = stored |
|
2339 | self.db['stored_aliases'] = stored | |
2340 |
|
2340 | |||
2341 |
|
2341 | |||
2342 | def magic_rehashx(self, parameter_s = ''): |
|
2342 | def magic_rehashx(self, parameter_s = ''): | |
2343 | """Update the alias table with all executable files in $PATH. |
|
2343 | """Update the alias table with all executable files in $PATH. | |
2344 |
|
2344 | |||
2345 | This version explicitly checks that every entry in $PATH is a file |
|
2345 | This version explicitly checks that every entry in $PATH is a file | |
2346 | with execute access (os.X_OK), so it is much slower than %rehash. |
|
2346 | with execute access (os.X_OK), so it is much slower than %rehash. | |
2347 |
|
2347 | |||
2348 | Under Windows, it checks executability as a match agains a |
|
2348 | Under Windows, it checks executability as a match agains a | |
2349 | '|'-separated string of extensions, stored in the IPython config |
|
2349 | '|'-separated string of extensions, stored in the IPython config | |
2350 | variable win_exec_ext. This defaults to 'exe|com|bat'. |
|
2350 | variable win_exec_ext. This defaults to 'exe|com|bat'. | |
2351 |
|
2351 | |||
2352 | This function also resets the root module cache of module completer, |
|
2352 | This function also resets the root module cache of module completer, | |
2353 | used on slow filesystems. |
|
2353 | used on slow filesystems. | |
2354 | """ |
|
2354 | """ | |
2355 |
|
2355 | |||
2356 |
|
2356 | |||
2357 | ip = self.api |
|
2357 | ip = self.api | |
2358 |
|
2358 | |||
2359 | # for the benefit of module completer in ipy_completers.py |
|
2359 | # for the benefit of module completer in ipy_completers.py | |
2360 | del ip.db['rootmodules'] |
|
2360 | del ip.db['rootmodules'] | |
2361 |
|
2361 | |||
2362 | path = [os.path.abspath(os.path.expanduser(p)) for p in |
|
2362 | path = [os.path.abspath(os.path.expanduser(p)) for p in | |
2363 | os.environ.get('PATH','').split(os.pathsep)] |
|
2363 | os.environ.get('PATH','').split(os.pathsep)] | |
2364 | path = filter(os.path.isdir,path) |
|
2364 | path = filter(os.path.isdir,path) | |
2365 |
|
2365 | |||
2366 | alias_table = self.shell.alias_table |
|
2366 | alias_table = self.shell.alias_table | |
2367 | syscmdlist = [] |
|
2367 | syscmdlist = [] | |
2368 | if os.name == 'posix': |
|
2368 | if os.name == 'posix': | |
2369 | isexec = lambda fname:os.path.isfile(fname) and \ |
|
2369 | isexec = lambda fname:os.path.isfile(fname) and \ | |
2370 | os.access(fname,os.X_OK) |
|
2370 | os.access(fname,os.X_OK) | |
2371 | else: |
|
2371 | else: | |
2372 |
|
2372 | |||
2373 | try: |
|
2373 | try: | |
2374 | winext = os.environ['pathext'].replace(';','|').replace('.','') |
|
2374 | winext = os.environ['pathext'].replace(';','|').replace('.','') | |
2375 | except KeyError: |
|
2375 | except KeyError: | |
2376 | winext = 'exe|com|bat|py' |
|
2376 | winext = 'exe|com|bat|py' | |
2377 | if 'py' not in winext: |
|
2377 | if 'py' not in winext: | |
2378 | winext += '|py' |
|
2378 | winext += '|py' | |
2379 | execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE) |
|
2379 | execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE) | |
2380 | isexec = lambda fname:os.path.isfile(fname) and execre.match(fname) |
|
2380 | isexec = lambda fname:os.path.isfile(fname) and execre.match(fname) | |
2381 | savedir = os.getcwd() |
|
2381 | savedir = os.getcwd() | |
2382 | try: |
|
2382 | try: | |
2383 | # write the whole loop for posix/Windows so we don't have an if in |
|
2383 | # write the whole loop for posix/Windows so we don't have an if in | |
2384 | # the innermost part |
|
2384 | # the innermost part | |
2385 | if os.name == 'posix': |
|
2385 | if os.name == 'posix': | |
2386 | for pdir in path: |
|
2386 | for pdir in path: | |
2387 | os.chdir(pdir) |
|
2387 | os.chdir(pdir) | |
2388 | for ff in os.listdir(pdir): |
|
2388 | for ff in os.listdir(pdir): | |
2389 | if isexec(ff) and ff not in self.shell.no_alias: |
|
2389 | if isexec(ff) and ff not in self.shell.no_alias: | |
2390 | # each entry in the alias table must be (N,name), |
|
2390 | # each entry in the alias table must be (N,name), | |
2391 | # where N is the number of positional arguments of the |
|
2391 | # where N is the number of positional arguments of the | |
2392 | # alias. |
|
2392 | # alias. | |
2393 | alias_table[ff] = (0,ff) |
|
2393 | alias_table[ff] = (0,ff) | |
2394 | syscmdlist.append(ff) |
|
2394 | syscmdlist.append(ff) | |
2395 | else: |
|
2395 | else: | |
2396 | for pdir in path: |
|
2396 | for pdir in path: | |
2397 | os.chdir(pdir) |
|
2397 | os.chdir(pdir) | |
2398 | for ff in os.listdir(pdir): |
|
2398 | for ff in os.listdir(pdir): | |
2399 | base, ext = os.path.splitext(ff) |
|
2399 | base, ext = os.path.splitext(ff) | |
2400 | if isexec(ff) and base not in self.shell.no_alias: |
|
2400 | if isexec(ff) and base not in self.shell.no_alias: | |
2401 | if ext.lower() == '.exe': |
|
2401 | if ext.lower() == '.exe': | |
2402 | ff = base |
|
2402 | ff = base | |
2403 | alias_table[base.lower()] = (0,ff) |
|
2403 | alias_table[base.lower()] = (0,ff) | |
2404 | syscmdlist.append(ff) |
|
2404 | syscmdlist.append(ff) | |
2405 | # Make sure the alias table doesn't contain keywords or builtins |
|
2405 | # Make sure the alias table doesn't contain keywords or builtins | |
2406 | self.shell.alias_table_validate() |
|
2406 | self.shell.alias_table_validate() | |
2407 | # Call again init_auto_alias() so we get 'rm -i' and other |
|
2407 | # Call again init_auto_alias() so we get 'rm -i' and other | |
2408 | # modified aliases since %rehashx will probably clobber them |
|
2408 | # modified aliases since %rehashx will probably clobber them | |
2409 |
|
2409 | |||
2410 | # no, we don't want them. if %rehashx clobbers them, good, |
|
2410 | # no, we don't want them. if %rehashx clobbers them, good, | |
2411 | # we'll probably get better versions |
|
2411 | # we'll probably get better versions | |
2412 | # self.shell.init_auto_alias() |
|
2412 | # self.shell.init_auto_alias() | |
2413 | db = ip.db |
|
2413 | db = ip.db | |
2414 | db['syscmdlist'] = syscmdlist |
|
2414 | db['syscmdlist'] = syscmdlist | |
2415 | finally: |
|
2415 | finally: | |
2416 | os.chdir(savedir) |
|
2416 | os.chdir(savedir) | |
2417 |
|
2417 | |||
2418 | def magic_pwd(self, parameter_s = ''): |
|
2418 | def magic_pwd(self, parameter_s = ''): | |
2419 | """Return the current working directory path.""" |
|
2419 | """Return the current working directory path.""" | |
2420 | return os.getcwd() |
|
2420 | return os.getcwd() | |
2421 |
|
2421 | |||
2422 | def magic_cd(self, parameter_s=''): |
|
2422 | def magic_cd(self, parameter_s=''): | |
2423 | """Change the current working directory. |
|
2423 | """Change the current working directory. | |
2424 |
|
2424 | |||
2425 | This command automatically maintains an internal list of directories |
|
2425 | This command automatically maintains an internal list of directories | |
2426 | you visit during your IPython session, in the variable _dh. The |
|
2426 | you visit during your IPython session, in the variable _dh. The | |
2427 | command %dhist shows this history nicely formatted. You can also |
|
2427 | command %dhist shows this history nicely formatted. You can also | |
2428 | do 'cd -<tab>' to see directory history conveniently. |
|
2428 | do 'cd -<tab>' to see directory history conveniently. | |
2429 |
|
2429 | |||
2430 | Usage: |
|
2430 | Usage: | |
2431 |
|
2431 | |||
2432 | cd 'dir': changes to directory 'dir'. |
|
2432 | cd 'dir': changes to directory 'dir'. | |
2433 |
|
2433 | |||
2434 | cd -: changes to the last visited directory. |
|
2434 | cd -: changes to the last visited directory. | |
2435 |
|
2435 | |||
2436 | cd -<n>: changes to the n-th directory in the directory history. |
|
2436 | cd -<n>: changes to the n-th directory in the directory history. | |
2437 |
|
2437 | |||
2438 | cd -b <bookmark_name>: jump to a bookmark set by %bookmark |
|
2438 | cd -b <bookmark_name>: jump to a bookmark set by %bookmark | |
2439 | (note: cd <bookmark_name> is enough if there is no |
|
2439 | (note: cd <bookmark_name> is enough if there is no | |
2440 | directory <bookmark_name>, but a bookmark with the name exists.) |
|
2440 | directory <bookmark_name>, but a bookmark with the name exists.) | |
2441 | 'cd -b <tab>' allows you to tab-complete bookmark names. |
|
2441 | 'cd -b <tab>' allows you to tab-complete bookmark names. | |
2442 |
|
2442 | |||
2443 | Options: |
|
2443 | Options: | |
2444 |
|
2444 | |||
2445 | -q: quiet. Do not print the working directory after the cd command is |
|
2445 | -q: quiet. Do not print the working directory after the cd command is | |
2446 | executed. By default IPython's cd command does print this directory, |
|
2446 | executed. By default IPython's cd command does print this directory, | |
2447 | since the default prompts do not display path information. |
|
2447 | since the default prompts do not display path information. | |
2448 |
|
2448 | |||
2449 | Note that !cd doesn't work for this purpose because the shell where |
|
2449 | Note that !cd doesn't work for this purpose because the shell where | |
2450 | !command runs is immediately discarded after executing 'command'.""" |
|
2450 | !command runs is immediately discarded after executing 'command'.""" | |
2451 |
|
2451 | |||
2452 | parameter_s = parameter_s.strip() |
|
2452 | parameter_s = parameter_s.strip() | |
2453 | #bkms = self.shell.persist.get("bookmarks",{}) |
|
2453 | #bkms = self.shell.persist.get("bookmarks",{}) | |
2454 |
|
2454 | |||
2455 | numcd = re.match(r'(-)(\d+)$',parameter_s) |
|
2455 | numcd = re.match(r'(-)(\d+)$',parameter_s) | |
2456 | # jump in directory history by number |
|
2456 | # jump in directory history by number | |
2457 | if numcd: |
|
2457 | if numcd: | |
2458 | nn = int(numcd.group(2)) |
|
2458 | nn = int(numcd.group(2)) | |
2459 | try: |
|
2459 | try: | |
2460 | ps = self.shell.user_ns['_dh'][nn] |
|
2460 | ps = self.shell.user_ns['_dh'][nn] | |
2461 | except IndexError: |
|
2461 | except IndexError: | |
2462 | print 'The requested directory does not exist in history.' |
|
2462 | print 'The requested directory does not exist in history.' | |
2463 | return |
|
2463 | return | |
2464 | else: |
|
2464 | else: | |
2465 | opts = {} |
|
2465 | opts = {} | |
2466 | else: |
|
2466 | else: | |
2467 | #turn all non-space-escaping backslashes to slashes, |
|
2467 | #turn all non-space-escaping backslashes to slashes, | |
2468 | # for c:\windows\directory\names\ |
|
2468 | # for c:\windows\directory\names\ | |
2469 | parameter_s = re.sub(r'\\(?! )','/', parameter_s) |
|
2469 | parameter_s = re.sub(r'\\(?! )','/', parameter_s) | |
2470 | opts,ps = self.parse_options(parameter_s,'qb',mode='string') |
|
2470 | opts,ps = self.parse_options(parameter_s,'qb',mode='string') | |
2471 | # jump to previous |
|
2471 | # jump to previous | |
2472 | if ps == '-': |
|
2472 | if ps == '-': | |
2473 | try: |
|
2473 | try: | |
2474 | ps = self.shell.user_ns['_dh'][-2] |
|
2474 | ps = self.shell.user_ns['_dh'][-2] | |
2475 | except IndexError: |
|
2475 | except IndexError: | |
2476 | print 'No previous directory to change to.' |
|
2476 | print 'No previous directory to change to.' | |
2477 | return |
|
2477 | return | |
2478 | # jump to bookmark if needed |
|
2478 | # jump to bookmark if needed | |
2479 | else: |
|
2479 | else: | |
2480 | if not os.path.isdir(ps) or opts.has_key('b'): |
|
2480 | if not os.path.isdir(ps) or opts.has_key('b'): | |
2481 | bkms = self.db.get('bookmarks', {}) |
|
2481 | bkms = self.db.get('bookmarks', {}) | |
2482 |
|
2482 | |||
2483 | if bkms.has_key(ps): |
|
2483 | if bkms.has_key(ps): | |
2484 | target = bkms[ps] |
|
2484 | target = bkms[ps] | |
2485 | print '(bookmark:%s) -> %s' % (ps,target) |
|
2485 | print '(bookmark:%s) -> %s' % (ps,target) | |
2486 | ps = target |
|
2486 | ps = target | |
2487 | else: |
|
2487 | else: | |
2488 | if opts.has_key('b'): |
|
2488 | if opts.has_key('b'): | |
2489 | error("Bookmark '%s' not found. " |
|
2489 | error("Bookmark '%s' not found. " | |
2490 | "Use '%%bookmark -l' to see your bookmarks." % ps) |
|
2490 | "Use '%%bookmark -l' to see your bookmarks." % ps) | |
2491 | return |
|
2491 | return | |
2492 |
|
2492 | |||
2493 | # at this point ps should point to the target dir |
|
2493 | # at this point ps should point to the target dir | |
2494 | if ps: |
|
2494 | if ps: | |
2495 | try: |
|
2495 | try: | |
2496 | os.chdir(os.path.expanduser(ps)) |
|
2496 | os.chdir(os.path.expanduser(ps)) | |
2497 | if self.shell.rc.term_title: |
|
2497 | if self.shell.rc.term_title: | |
2498 | #print 'set term title:',self.shell.rc.term_title # dbg |
|
2498 | #print 'set term title:',self.shell.rc.term_title # dbg | |
2499 |
ttitle = |
|
2499 | ttitle = 'IPy ' + abbrev_cwd() | |
2500 | os.getcwd() == '/' and '/' or \ |
|
|||
2501 | os.path.basename(os.getcwd()))) |
|
|||
2502 | platutils.set_term_title(ttitle) |
|
2500 | platutils.set_term_title(ttitle) | |
2503 | except OSError: |
|
2501 | except OSError: | |
2504 | print sys.exc_info()[1] |
|
2502 | print sys.exc_info()[1] | |
2505 | else: |
|
2503 | else: | |
2506 | cwd = os.getcwd() |
|
2504 | cwd = os.getcwd() | |
2507 | dhist = self.shell.user_ns['_dh'] |
|
2505 | dhist = self.shell.user_ns['_dh'] | |
2508 | dhist.append(cwd) |
|
2506 | dhist.append(cwd) | |
2509 | self.db['dhist'] = compress_dhist(dhist)[-100:] |
|
2507 | self.db['dhist'] = compress_dhist(dhist)[-100:] | |
2510 |
|
2508 | |||
2511 | else: |
|
2509 | else: | |
2512 | os.chdir(self.shell.home_dir) |
|
2510 | os.chdir(self.shell.home_dir) | |
2513 | if self.shell.rc.term_title: |
|
2511 | if self.shell.rc.term_title: | |
2514 |
platutils.set_term_title("IPy |
|
2512 | platutils.set_term_title("IPy ~") | |
2515 | cwd = os.getcwd() |
|
2513 | cwd = os.getcwd() | |
2516 | dhist = self.shell.user_ns['_dh'] |
|
2514 | dhist = self.shell.user_ns['_dh'] | |
2517 | dhist.append(cwd) |
|
2515 | dhist.append(cwd) | |
2518 | self.db['dhist'] = compress_dhist(dhist)[-100:] |
|
2516 | self.db['dhist'] = compress_dhist(dhist)[-100:] | |
2519 | if not 'q' in opts: |
|
2517 | if not 'q' in opts: | |
2520 | print self.shell.user_ns['_dh'][-1] |
|
2518 | print self.shell.user_ns['_dh'][-1] | |
2521 |
|
2519 | |||
2522 |
|
2520 | |||
2523 | def magic_env(self, parameter_s=''): |
|
2521 | def magic_env(self, parameter_s=''): | |
2524 | """List environment variables.""" |
|
2522 | """List environment variables.""" | |
2525 |
|
2523 | |||
2526 | return os.environ.data |
|
2524 | return os.environ.data | |
2527 |
|
2525 | |||
2528 | def magic_pushd(self, parameter_s=''): |
|
2526 | def magic_pushd(self, parameter_s=''): | |
2529 | """Place the current dir on stack and change directory. |
|
2527 | """Place the current dir on stack and change directory. | |
2530 |
|
2528 | |||
2531 | Usage:\\ |
|
2529 | Usage:\\ | |
2532 | %pushd ['dirname'] |
|
2530 | %pushd ['dirname'] | |
2533 |
|
2531 | |||
2534 | %pushd with no arguments does a %pushd to your home directory. |
|
2532 | %pushd with no arguments does a %pushd to your home directory. | |
2535 | """ |
|
2533 | """ | |
2536 | if parameter_s == '': parameter_s = '~' |
|
2534 | if parameter_s == '': parameter_s = '~' | |
2537 | dir_s = self.shell.dir_stack |
|
2535 | dir_s = self.shell.dir_stack | |
2538 | if len(dir_s)>0 and os.path.expanduser(parameter_s) != \ |
|
2536 | if len(dir_s)>0 and os.path.expanduser(parameter_s) != \ | |
2539 | os.path.expanduser(self.shell.dir_stack[0]): |
|
2537 | os.path.expanduser(self.shell.dir_stack[0]): | |
2540 | try: |
|
2538 | try: | |
2541 | self.magic_cd(parameter_s) |
|
2539 | self.magic_cd(parameter_s) | |
2542 | dir_s.insert(0,os.getcwd().replace(self.home_dir,'~')) |
|
2540 | dir_s.insert(0,os.getcwd().replace(self.home_dir,'~')) | |
2543 | self.magic_dirs() |
|
2541 | self.magic_dirs() | |
2544 | except: |
|
2542 | except: | |
2545 | print 'Invalid directory' |
|
2543 | print 'Invalid directory' | |
2546 | else: |
|
2544 | else: | |
2547 | print 'You are already there!' |
|
2545 | print 'You are already there!' | |
2548 |
|
2546 | |||
2549 | def magic_popd(self, parameter_s=''): |
|
2547 | def magic_popd(self, parameter_s=''): | |
2550 | """Change to directory popped off the top of the stack. |
|
2548 | """Change to directory popped off the top of the stack. | |
2551 | """ |
|
2549 | """ | |
2552 | if len (self.shell.dir_stack) > 1: |
|
2550 | if len (self.shell.dir_stack) > 1: | |
2553 | self.shell.dir_stack.pop(0) |
|
2551 | self.shell.dir_stack.pop(0) | |
2554 | self.magic_cd(self.shell.dir_stack[0]) |
|
2552 | self.magic_cd(self.shell.dir_stack[0]) | |
2555 | print self.shell.dir_stack[0] |
|
2553 | print self.shell.dir_stack[0] | |
2556 | else: |
|
2554 | else: | |
2557 | print "You can't remove the starting directory from the stack:",\ |
|
2555 | print "You can't remove the starting directory from the stack:",\ | |
2558 | self.shell.dir_stack |
|
2556 | self.shell.dir_stack | |
2559 |
|
2557 | |||
2560 | def magic_dirs(self, parameter_s=''): |
|
2558 | def magic_dirs(self, parameter_s=''): | |
2561 | """Return the current directory stack.""" |
|
2559 | """Return the current directory stack.""" | |
2562 |
|
2560 | |||
2563 | return self.shell.dir_stack[:] |
|
2561 | return self.shell.dir_stack[:] | |
2564 |
|
2562 | |||
2565 | def magic_sc(self, parameter_s=''): |
|
2563 | def magic_sc(self, parameter_s=''): | |
2566 | """Shell capture - execute a shell command and capture its output. |
|
2564 | """Shell capture - execute a shell command and capture its output. | |
2567 |
|
2565 | |||
2568 | DEPRECATED. Suboptimal, retained for backwards compatibility. |
|
2566 | DEPRECATED. Suboptimal, retained for backwards compatibility. | |
2569 |
|
2567 | |||
2570 | You should use the form 'var = !command' instead. Example: |
|
2568 | You should use the form 'var = !command' instead. Example: | |
2571 |
|
2569 | |||
2572 | "%sc -l myfiles = ls ~" should now be written as |
|
2570 | "%sc -l myfiles = ls ~" should now be written as | |
2573 |
|
2571 | |||
2574 | "myfiles = !ls ~" |
|
2572 | "myfiles = !ls ~" | |
2575 |
|
2573 | |||
2576 | myfiles.s, myfiles.l and myfiles.n still apply as documented |
|
2574 | myfiles.s, myfiles.l and myfiles.n still apply as documented | |
2577 | below. |
|
2575 | below. | |
2578 |
|
2576 | |||
2579 | -- |
|
2577 | -- | |
2580 | %sc [options] varname=command |
|
2578 | %sc [options] varname=command | |
2581 |
|
2579 | |||
2582 | IPython will run the given command using commands.getoutput(), and |
|
2580 | IPython will run the given command using commands.getoutput(), and | |
2583 | will then update the user's interactive namespace with a variable |
|
2581 | will then update the user's interactive namespace with a variable | |
2584 | called varname, containing the value of the call. Your command can |
|
2582 | called varname, containing the value of the call. Your command can | |
2585 | contain shell wildcards, pipes, etc. |
|
2583 | contain shell wildcards, pipes, etc. | |
2586 |
|
2584 | |||
2587 | The '=' sign in the syntax is mandatory, and the variable name you |
|
2585 | The '=' sign in the syntax is mandatory, and the variable name you | |
2588 | supply must follow Python's standard conventions for valid names. |
|
2586 | supply must follow Python's standard conventions for valid names. | |
2589 |
|
2587 | |||
2590 | (A special format without variable name exists for internal use) |
|
2588 | (A special format without variable name exists for internal use) | |
2591 |
|
2589 | |||
2592 | Options: |
|
2590 | Options: | |
2593 |
|
2591 | |||
2594 | -l: list output. Split the output on newlines into a list before |
|
2592 | -l: list output. Split the output on newlines into a list before | |
2595 | assigning it to the given variable. By default the output is stored |
|
2593 | assigning it to the given variable. By default the output is stored | |
2596 | as a single string. |
|
2594 | as a single string. | |
2597 |
|
2595 | |||
2598 | -v: verbose. Print the contents of the variable. |
|
2596 | -v: verbose. Print the contents of the variable. | |
2599 |
|
2597 | |||
2600 | In most cases you should not need to split as a list, because the |
|
2598 | In most cases you should not need to split as a list, because the | |
2601 | returned value is a special type of string which can automatically |
|
2599 | returned value is a special type of string which can automatically | |
2602 | provide its contents either as a list (split on newlines) or as a |
|
2600 | provide its contents either as a list (split on newlines) or as a | |
2603 | space-separated string. These are convenient, respectively, either |
|
2601 | space-separated string. These are convenient, respectively, either | |
2604 | for sequential processing or to be passed to a shell command. |
|
2602 | for sequential processing or to be passed to a shell command. | |
2605 |
|
2603 | |||
2606 | For example: |
|
2604 | For example: | |
2607 |
|
2605 | |||
2608 | # Capture into variable a |
|
2606 | # Capture into variable a | |
2609 | In [9]: sc a=ls *py |
|
2607 | In [9]: sc a=ls *py | |
2610 |
|
2608 | |||
2611 | # a is a string with embedded newlines |
|
2609 | # a is a string with embedded newlines | |
2612 | In [10]: a |
|
2610 | In [10]: a | |
2613 | Out[10]: 'setup.py\nwin32_manual_post_install.py' |
|
2611 | Out[10]: 'setup.py\nwin32_manual_post_install.py' | |
2614 |
|
2612 | |||
2615 | # which can be seen as a list: |
|
2613 | # which can be seen as a list: | |
2616 | In [11]: a.l |
|
2614 | In [11]: a.l | |
2617 | Out[11]: ['setup.py', 'win32_manual_post_install.py'] |
|
2615 | Out[11]: ['setup.py', 'win32_manual_post_install.py'] | |
2618 |
|
2616 | |||
2619 | # or as a whitespace-separated string: |
|
2617 | # or as a whitespace-separated string: | |
2620 | In [12]: a.s |
|
2618 | In [12]: a.s | |
2621 | Out[12]: 'setup.py win32_manual_post_install.py' |
|
2619 | Out[12]: 'setup.py win32_manual_post_install.py' | |
2622 |
|
2620 | |||
2623 | # a.s is useful to pass as a single command line: |
|
2621 | # a.s is useful to pass as a single command line: | |
2624 | In [13]: !wc -l $a.s |
|
2622 | In [13]: !wc -l $a.s | |
2625 | 146 setup.py |
|
2623 | 146 setup.py | |
2626 | 130 win32_manual_post_install.py |
|
2624 | 130 win32_manual_post_install.py | |
2627 | 276 total |
|
2625 | 276 total | |
2628 |
|
2626 | |||
2629 | # while the list form is useful to loop over: |
|
2627 | # while the list form is useful to loop over: | |
2630 | In [14]: for f in a.l: |
|
2628 | In [14]: for f in a.l: | |
2631 | ....: !wc -l $f |
|
2629 | ....: !wc -l $f | |
2632 | ....: |
|
2630 | ....: | |
2633 | 146 setup.py |
|
2631 | 146 setup.py | |
2634 | 130 win32_manual_post_install.py |
|
2632 | 130 win32_manual_post_install.py | |
2635 |
|
2633 | |||
2636 | Similiarly, the lists returned by the -l option are also special, in |
|
2634 | Similiarly, the lists returned by the -l option are also special, in | |
2637 | the sense that you can equally invoke the .s attribute on them to |
|
2635 | the sense that you can equally invoke the .s attribute on them to | |
2638 | automatically get a whitespace-separated string from their contents: |
|
2636 | automatically get a whitespace-separated string from their contents: | |
2639 |
|
2637 | |||
2640 | In [1]: sc -l b=ls *py |
|
2638 | In [1]: sc -l b=ls *py | |
2641 |
|
2639 | |||
2642 | In [2]: b |
|
2640 | In [2]: b | |
2643 | Out[2]: ['setup.py', 'win32_manual_post_install.py'] |
|
2641 | Out[2]: ['setup.py', 'win32_manual_post_install.py'] | |
2644 |
|
2642 | |||
2645 | In [3]: b.s |
|
2643 | In [3]: b.s | |
2646 | Out[3]: 'setup.py win32_manual_post_install.py' |
|
2644 | Out[3]: 'setup.py win32_manual_post_install.py' | |
2647 |
|
2645 | |||
2648 | In summary, both the lists and strings used for ouptut capture have |
|
2646 | In summary, both the lists and strings used for ouptut capture have | |
2649 | the following special attributes: |
|
2647 | the following special attributes: | |
2650 |
|
2648 | |||
2651 | .l (or .list) : value as list. |
|
2649 | .l (or .list) : value as list. | |
2652 | .n (or .nlstr): value as newline-separated string. |
|
2650 | .n (or .nlstr): value as newline-separated string. | |
2653 | .s (or .spstr): value as space-separated string. |
|
2651 | .s (or .spstr): value as space-separated string. | |
2654 | """ |
|
2652 | """ | |
2655 |
|
2653 | |||
2656 | opts,args = self.parse_options(parameter_s,'lv') |
|
2654 | opts,args = self.parse_options(parameter_s,'lv') | |
2657 | # Try to get a variable name and command to run |
|
2655 | # Try to get a variable name and command to run | |
2658 | try: |
|
2656 | try: | |
2659 | # the variable name must be obtained from the parse_options |
|
2657 | # the variable name must be obtained from the parse_options | |
2660 | # output, which uses shlex.split to strip options out. |
|
2658 | # output, which uses shlex.split to strip options out. | |
2661 | var,_ = args.split('=',1) |
|
2659 | var,_ = args.split('=',1) | |
2662 | var = var.strip() |
|
2660 | var = var.strip() | |
2663 | # But the the command has to be extracted from the original input |
|
2661 | # But the the command has to be extracted from the original input | |
2664 | # parameter_s, not on what parse_options returns, to avoid the |
|
2662 | # parameter_s, not on what parse_options returns, to avoid the | |
2665 | # quote stripping which shlex.split performs on it. |
|
2663 | # quote stripping which shlex.split performs on it. | |
2666 | _,cmd = parameter_s.split('=',1) |
|
2664 | _,cmd = parameter_s.split('=',1) | |
2667 | except ValueError: |
|
2665 | except ValueError: | |
2668 | var,cmd = '','' |
|
2666 | var,cmd = '','' | |
2669 | # If all looks ok, proceed |
|
2667 | # If all looks ok, proceed | |
2670 | out,err = self.shell.getoutputerror(cmd) |
|
2668 | out,err = self.shell.getoutputerror(cmd) | |
2671 | if err: |
|
2669 | if err: | |
2672 | print >> Term.cerr,err |
|
2670 | print >> Term.cerr,err | |
2673 | if opts.has_key('l'): |
|
2671 | if opts.has_key('l'): | |
2674 | out = SList(out.split('\n')) |
|
2672 | out = SList(out.split('\n')) | |
2675 | else: |
|
2673 | else: | |
2676 | out = LSString(out) |
|
2674 | out = LSString(out) | |
2677 | if opts.has_key('v'): |
|
2675 | if opts.has_key('v'): | |
2678 | print '%s ==\n%s' % (var,pformat(out)) |
|
2676 | print '%s ==\n%s' % (var,pformat(out)) | |
2679 | if var: |
|
2677 | if var: | |
2680 | self.shell.user_ns.update({var:out}) |
|
2678 | self.shell.user_ns.update({var:out}) | |
2681 | else: |
|
2679 | else: | |
2682 | return out |
|
2680 | return out | |
2683 |
|
2681 | |||
2684 | def magic_sx(self, parameter_s=''): |
|
2682 | def magic_sx(self, parameter_s=''): | |
2685 | """Shell execute - run a shell command and capture its output. |
|
2683 | """Shell execute - run a shell command and capture its output. | |
2686 |
|
2684 | |||
2687 | %sx command |
|
2685 | %sx command | |
2688 |
|
2686 | |||
2689 | IPython will run the given command using commands.getoutput(), and |
|
2687 | IPython will run the given command using commands.getoutput(), and | |
2690 | return the result formatted as a list (split on '\\n'). Since the |
|
2688 | return the result formatted as a list (split on '\\n'). Since the | |
2691 | output is _returned_, it will be stored in ipython's regular output |
|
2689 | output is _returned_, it will be stored in ipython's regular output | |
2692 | cache Out[N] and in the '_N' automatic variables. |
|
2690 | cache Out[N] and in the '_N' automatic variables. | |
2693 |
|
2691 | |||
2694 | Notes: |
|
2692 | Notes: | |
2695 |
|
2693 | |||
2696 | 1) If an input line begins with '!!', then %sx is automatically |
|
2694 | 1) If an input line begins with '!!', then %sx is automatically | |
2697 | invoked. That is, while: |
|
2695 | invoked. That is, while: | |
2698 | !ls |
|
2696 | !ls | |
2699 | causes ipython to simply issue system('ls'), typing |
|
2697 | causes ipython to simply issue system('ls'), typing | |
2700 | !!ls |
|
2698 | !!ls | |
2701 | is a shorthand equivalent to: |
|
2699 | is a shorthand equivalent to: | |
2702 | %sx ls |
|
2700 | %sx ls | |
2703 |
|
2701 | |||
2704 | 2) %sx differs from %sc in that %sx automatically splits into a list, |
|
2702 | 2) %sx differs from %sc in that %sx automatically splits into a list, | |
2705 | like '%sc -l'. The reason for this is to make it as easy as possible |
|
2703 | like '%sc -l'. The reason for this is to make it as easy as possible | |
2706 | to process line-oriented shell output via further python commands. |
|
2704 | to process line-oriented shell output via further python commands. | |
2707 | %sc is meant to provide much finer control, but requires more |
|
2705 | %sc is meant to provide much finer control, but requires more | |
2708 | typing. |
|
2706 | typing. | |
2709 |
|
2707 | |||
2710 | 3) Just like %sc -l, this is a list with special attributes: |
|
2708 | 3) Just like %sc -l, this is a list with special attributes: | |
2711 |
|
2709 | |||
2712 | .l (or .list) : value as list. |
|
2710 | .l (or .list) : value as list. | |
2713 | .n (or .nlstr): value as newline-separated string. |
|
2711 | .n (or .nlstr): value as newline-separated string. | |
2714 | .s (or .spstr): value as whitespace-separated string. |
|
2712 | .s (or .spstr): value as whitespace-separated string. | |
2715 |
|
2713 | |||
2716 | This is very useful when trying to use such lists as arguments to |
|
2714 | This is very useful when trying to use such lists as arguments to | |
2717 | system commands.""" |
|
2715 | system commands.""" | |
2718 |
|
2716 | |||
2719 | if parameter_s: |
|
2717 | if parameter_s: | |
2720 | out,err = self.shell.getoutputerror(parameter_s) |
|
2718 | out,err = self.shell.getoutputerror(parameter_s) | |
2721 | if err: |
|
2719 | if err: | |
2722 | print >> Term.cerr,err |
|
2720 | print >> Term.cerr,err | |
2723 | return SList(out.split('\n')) |
|
2721 | return SList(out.split('\n')) | |
2724 |
|
2722 | |||
2725 | def magic_bg(self, parameter_s=''): |
|
2723 | def magic_bg(self, parameter_s=''): | |
2726 | """Run a job in the background, in a separate thread. |
|
2724 | """Run a job in the background, in a separate thread. | |
2727 |
|
2725 | |||
2728 | For example, |
|
2726 | For example, | |
2729 |
|
2727 | |||
2730 | %bg myfunc(x,y,z=1) |
|
2728 | %bg myfunc(x,y,z=1) | |
2731 |
|
2729 | |||
2732 | will execute 'myfunc(x,y,z=1)' in a background thread. As soon as the |
|
2730 | will execute 'myfunc(x,y,z=1)' in a background thread. As soon as the | |
2733 | execution starts, a message will be printed indicating the job |
|
2731 | execution starts, a message will be printed indicating the job | |
2734 | number. If your job number is 5, you can use |
|
2732 | number. If your job number is 5, you can use | |
2735 |
|
2733 | |||
2736 | myvar = jobs.result(5) or myvar = jobs[5].result |
|
2734 | myvar = jobs.result(5) or myvar = jobs[5].result | |
2737 |
|
2735 | |||
2738 | to assign this result to variable 'myvar'. |
|
2736 | to assign this result to variable 'myvar'. | |
2739 |
|
2737 | |||
2740 | IPython has a job manager, accessible via the 'jobs' object. You can |
|
2738 | IPython has a job manager, accessible via the 'jobs' object. You can | |
2741 | type jobs? to get more information about it, and use jobs.<TAB> to see |
|
2739 | type jobs? to get more information about it, and use jobs.<TAB> to see | |
2742 | its attributes. All attributes not starting with an underscore are |
|
2740 | its attributes. All attributes not starting with an underscore are | |
2743 | meant for public use. |
|
2741 | meant for public use. | |
2744 |
|
2742 | |||
2745 | In particular, look at the jobs.new() method, which is used to create |
|
2743 | In particular, look at the jobs.new() method, which is used to create | |
2746 | new jobs. This magic %bg function is just a convenience wrapper |
|
2744 | new jobs. This magic %bg function is just a convenience wrapper | |
2747 | around jobs.new(), for expression-based jobs. If you want to create a |
|
2745 | around jobs.new(), for expression-based jobs. If you want to create a | |
2748 | new job with an explicit function object and arguments, you must call |
|
2746 | new job with an explicit function object and arguments, you must call | |
2749 | jobs.new() directly. |
|
2747 | jobs.new() directly. | |
2750 |
|
2748 | |||
2751 | The jobs.new docstring also describes in detail several important |
|
2749 | The jobs.new docstring also describes in detail several important | |
2752 | caveats associated with a thread-based model for background job |
|
2750 | caveats associated with a thread-based model for background job | |
2753 | execution. Type jobs.new? for details. |
|
2751 | execution. Type jobs.new? for details. | |
2754 |
|
2752 | |||
2755 | You can check the status of all jobs with jobs.status(). |
|
2753 | You can check the status of all jobs with jobs.status(). | |
2756 |
|
2754 | |||
2757 | The jobs variable is set by IPython into the Python builtin namespace. |
|
2755 | The jobs variable is set by IPython into the Python builtin namespace. | |
2758 | If you ever declare a variable named 'jobs', you will shadow this |
|
2756 | If you ever declare a variable named 'jobs', you will shadow this | |
2759 | name. You can either delete your global jobs variable to regain |
|
2757 | name. You can either delete your global jobs variable to regain | |
2760 | access to the job manager, or make a new name and assign it manually |
|
2758 | access to the job manager, or make a new name and assign it manually | |
2761 | to the manager (stored in IPython's namespace). For example, to |
|
2759 | to the manager (stored in IPython's namespace). For example, to | |
2762 | assign the job manager to the Jobs name, use: |
|
2760 | assign the job manager to the Jobs name, use: | |
2763 |
|
2761 | |||
2764 | Jobs = __builtins__.jobs""" |
|
2762 | Jobs = __builtins__.jobs""" | |
2765 |
|
2763 | |||
2766 | self.shell.jobs.new(parameter_s,self.shell.user_ns) |
|
2764 | self.shell.jobs.new(parameter_s,self.shell.user_ns) | |
2767 |
|
2765 | |||
2768 |
|
2766 | |||
2769 | def magic_bookmark(self, parameter_s=''): |
|
2767 | def magic_bookmark(self, parameter_s=''): | |
2770 | """Manage IPython's bookmark system. |
|
2768 | """Manage IPython's bookmark system. | |
2771 |
|
2769 | |||
2772 | %bookmark <name> - set bookmark to current dir |
|
2770 | %bookmark <name> - set bookmark to current dir | |
2773 | %bookmark <name> <dir> - set bookmark to <dir> |
|
2771 | %bookmark <name> <dir> - set bookmark to <dir> | |
2774 | %bookmark -l - list all bookmarks |
|
2772 | %bookmark -l - list all bookmarks | |
2775 | %bookmark -d <name> - remove bookmark |
|
2773 | %bookmark -d <name> - remove bookmark | |
2776 | %bookmark -r - remove all bookmarks |
|
2774 | %bookmark -r - remove all bookmarks | |
2777 |
|
2775 | |||
2778 | You can later on access a bookmarked folder with: |
|
2776 | You can later on access a bookmarked folder with: | |
2779 | %cd -b <name> |
|
2777 | %cd -b <name> | |
2780 | or simply '%cd <name>' if there is no directory called <name> AND |
|
2778 | or simply '%cd <name>' if there is no directory called <name> AND | |
2781 | there is such a bookmark defined. |
|
2779 | there is such a bookmark defined. | |
2782 |
|
2780 | |||
2783 | Your bookmarks persist through IPython sessions, but they are |
|
2781 | Your bookmarks persist through IPython sessions, but they are | |
2784 | associated with each profile.""" |
|
2782 | associated with each profile.""" | |
2785 |
|
2783 | |||
2786 | opts,args = self.parse_options(parameter_s,'drl',mode='list') |
|
2784 | opts,args = self.parse_options(parameter_s,'drl',mode='list') | |
2787 | if len(args) > 2: |
|
2785 | if len(args) > 2: | |
2788 | error('You can only give at most two arguments') |
|
2786 | error('You can only give at most two arguments') | |
2789 | return |
|
2787 | return | |
2790 |
|
2788 | |||
2791 | bkms = self.db.get('bookmarks',{}) |
|
2789 | bkms = self.db.get('bookmarks',{}) | |
2792 |
|
2790 | |||
2793 | if opts.has_key('d'): |
|
2791 | if opts.has_key('d'): | |
2794 | try: |
|
2792 | try: | |
2795 | todel = args[0] |
|
2793 | todel = args[0] | |
2796 | except IndexError: |
|
2794 | except IndexError: | |
2797 | error('You must provide a bookmark to delete') |
|
2795 | error('You must provide a bookmark to delete') | |
2798 | else: |
|
2796 | else: | |
2799 | try: |
|
2797 | try: | |
2800 | del bkms[todel] |
|
2798 | del bkms[todel] | |
2801 | except: |
|
2799 | except: | |
2802 | error("Can't delete bookmark '%s'" % todel) |
|
2800 | error("Can't delete bookmark '%s'" % todel) | |
2803 | elif opts.has_key('r'): |
|
2801 | elif opts.has_key('r'): | |
2804 | bkms = {} |
|
2802 | bkms = {} | |
2805 | elif opts.has_key('l'): |
|
2803 | elif opts.has_key('l'): | |
2806 | bks = bkms.keys() |
|
2804 | bks = bkms.keys() | |
2807 | bks.sort() |
|
2805 | bks.sort() | |
2808 | if bks: |
|
2806 | if bks: | |
2809 | size = max(map(len,bks)) |
|
2807 | size = max(map(len,bks)) | |
2810 | else: |
|
2808 | else: | |
2811 | size = 0 |
|
2809 | size = 0 | |
2812 | fmt = '%-'+str(size)+'s -> %s' |
|
2810 | fmt = '%-'+str(size)+'s -> %s' | |
2813 | print 'Current bookmarks:' |
|
2811 | print 'Current bookmarks:' | |
2814 | for bk in bks: |
|
2812 | for bk in bks: | |
2815 | print fmt % (bk,bkms[bk]) |
|
2813 | print fmt % (bk,bkms[bk]) | |
2816 | else: |
|
2814 | else: | |
2817 | if not args: |
|
2815 | if not args: | |
2818 | error("You must specify the bookmark name") |
|
2816 | error("You must specify the bookmark name") | |
2819 | elif len(args)==1: |
|
2817 | elif len(args)==1: | |
2820 | bkms[args[0]] = os.getcwd() |
|
2818 | bkms[args[0]] = os.getcwd() | |
2821 | elif len(args)==2: |
|
2819 | elif len(args)==2: | |
2822 | bkms[args[0]] = args[1] |
|
2820 | bkms[args[0]] = args[1] | |
2823 | self.db['bookmarks'] = bkms |
|
2821 | self.db['bookmarks'] = bkms | |
2824 |
|
2822 | |||
2825 | def magic_pycat(self, parameter_s=''): |
|
2823 | def magic_pycat(self, parameter_s=''): | |
2826 | """Show a syntax-highlighted file through a pager. |
|
2824 | """Show a syntax-highlighted file through a pager. | |
2827 |
|
2825 | |||
2828 | This magic is similar to the cat utility, but it will assume the file |
|
2826 | This magic is similar to the cat utility, but it will assume the file | |
2829 | to be Python source and will show it with syntax highlighting. """ |
|
2827 | to be Python source and will show it with syntax highlighting. """ | |
2830 |
|
2828 | |||
2831 | try: |
|
2829 | try: | |
2832 | filename = get_py_filename(parameter_s) |
|
2830 | filename = get_py_filename(parameter_s) | |
2833 | cont = file_read(filename) |
|
2831 | cont = file_read(filename) | |
2834 | except IOError: |
|
2832 | except IOError: | |
2835 | try: |
|
2833 | try: | |
2836 | cont = eval(parameter_s,self.user_ns) |
|
2834 | cont = eval(parameter_s,self.user_ns) | |
2837 | except NameError: |
|
2835 | except NameError: | |
2838 | cont = None |
|
2836 | cont = None | |
2839 | if cont is None: |
|
2837 | if cont is None: | |
2840 | print "Error: no such file or variable" |
|
2838 | print "Error: no such file or variable" | |
2841 | return |
|
2839 | return | |
2842 |
|
2840 | |||
2843 | page(self.shell.pycolorize(cont), |
|
2841 | page(self.shell.pycolorize(cont), | |
2844 | screen_lines=self.shell.rc.screen_length) |
|
2842 | screen_lines=self.shell.rc.screen_length) | |
2845 |
|
2843 | |||
2846 | def magic_cpaste(self, parameter_s=''): |
|
2844 | def magic_cpaste(self, parameter_s=''): | |
2847 | """Allows you to paste & execute a pre-formatted code block from clipboard |
|
2845 | """Allows you to paste & execute a pre-formatted code block from clipboard | |
2848 |
|
2846 | |||
2849 | You must terminate the block with '--' (two minus-signs) alone on the |
|
2847 | You must terminate the block with '--' (two minus-signs) alone on the | |
2850 | line. You can also provide your own sentinel with '%paste -s %%' ('%%' |
|
2848 | line. You can also provide your own sentinel with '%paste -s %%' ('%%' | |
2851 | is the new sentinel for this operation) |
|
2849 | is the new sentinel for this operation) | |
2852 |
|
2850 | |||
2853 | The block is dedented prior to execution to enable execution of method |
|
2851 | The block is dedented prior to execution to enable execution of method | |
2854 | definitions. '>' and '+' characters at the beginning of a line are |
|
2852 | definitions. '>' and '+' characters at the beginning of a line are | |
2855 | ignored, to allow pasting directly from e-mails or diff files. The |
|
2853 | ignored, to allow pasting directly from e-mails or diff files. The | |
2856 | executed block is also assigned to variable named 'pasted_block' for |
|
2854 | executed block is also assigned to variable named 'pasted_block' for | |
2857 | later editing with '%edit pasted_block'. |
|
2855 | later editing with '%edit pasted_block'. | |
2858 |
|
2856 | |||
2859 | You can also pass a variable name as an argument, e.g. '%cpaste foo'. |
|
2857 | You can also pass a variable name as an argument, e.g. '%cpaste foo'. | |
2860 | This assigns the pasted block to variable 'foo' as string, without |
|
2858 | This assigns the pasted block to variable 'foo' as string, without | |
2861 | dedenting or executing it. |
|
2859 | dedenting or executing it. | |
2862 |
|
2860 | |||
2863 | Do not be alarmed by garbled output on Windows (it's a readline bug). |
|
2861 | Do not be alarmed by garbled output on Windows (it's a readline bug). | |
2864 | Just press enter and type -- (and press enter again) and the block |
|
2862 | Just press enter and type -- (and press enter again) and the block | |
2865 | will be what was just pasted. |
|
2863 | will be what was just pasted. | |
2866 |
|
2864 | |||
2867 | IPython statements (magics, shell escapes) are not supported (yet). |
|
2865 | IPython statements (magics, shell escapes) are not supported (yet). | |
2868 | """ |
|
2866 | """ | |
2869 | opts,args = self.parse_options(parameter_s,'s:',mode='string') |
|
2867 | opts,args = self.parse_options(parameter_s,'s:',mode='string') | |
2870 | par = args.strip() |
|
2868 | par = args.strip() | |
2871 | sentinel = opts.get('s','--') |
|
2869 | sentinel = opts.get('s','--') | |
2872 |
|
2870 | |||
2873 | from IPython import iplib |
|
2871 | from IPython import iplib | |
2874 | lines = [] |
|
2872 | lines = [] | |
2875 | print "Pasting code; enter '%s' alone on the line to stop." % sentinel |
|
2873 | print "Pasting code; enter '%s' alone on the line to stop." % sentinel | |
2876 | while 1: |
|
2874 | while 1: | |
2877 | l = iplib.raw_input_original(':') |
|
2875 | l = iplib.raw_input_original(':') | |
2878 | if l ==sentinel: |
|
2876 | if l ==sentinel: | |
2879 | break |
|
2877 | break | |
2880 | lines.append(l.lstrip('>').lstrip('+')) |
|
2878 | lines.append(l.lstrip('>').lstrip('+')) | |
2881 | block = "\n".join(lines) + '\n' |
|
2879 | block = "\n".join(lines) + '\n' | |
2882 | #print "block:\n",block |
|
2880 | #print "block:\n",block | |
2883 | if not par: |
|
2881 | if not par: | |
2884 | b = textwrap.dedent(block) |
|
2882 | b = textwrap.dedent(block) | |
2885 | exec b in self.user_ns |
|
2883 | exec b in self.user_ns | |
2886 | self.user_ns['pasted_block'] = b |
|
2884 | self.user_ns['pasted_block'] = b | |
2887 | else: |
|
2885 | else: | |
2888 | self.user_ns[par] = block |
|
2886 | self.user_ns[par] = block | |
2889 | print "Block assigned to '%s'" % par |
|
2887 | print "Block assigned to '%s'" % par | |
2890 |
|
2888 | |||
2891 | def magic_quickref(self,arg): |
|
2889 | def magic_quickref(self,arg): | |
2892 | """ Show a quick reference sheet """ |
|
2890 | """ Show a quick reference sheet """ | |
2893 | import IPython.usage |
|
2891 | import IPython.usage | |
2894 | qr = IPython.usage.quick_reference + self.magic_magic('-brief') |
|
2892 | qr = IPython.usage.quick_reference + self.magic_magic('-brief') | |
2895 |
|
2893 | |||
2896 | page(qr) |
|
2894 | page(qr) | |
2897 |
|
2895 | |||
2898 | def magic_upgrade(self,arg): |
|
2896 | def magic_upgrade(self,arg): | |
2899 | """ Upgrade your IPython installation |
|
2897 | """ Upgrade your IPython installation | |
2900 |
|
2898 | |||
2901 | This will copy the config files that don't yet exist in your |
|
2899 | This will copy the config files that don't yet exist in your | |
2902 | ipython dir from the system config dir. Use this after upgrading |
|
2900 | ipython dir from the system config dir. Use this after upgrading | |
2903 | IPython if you don't wish to delete your .ipython dir. |
|
2901 | IPython if you don't wish to delete your .ipython dir. | |
2904 |
|
2902 | |||
2905 | Call with -nolegacy to get rid of ipythonrc* files (recommended for |
|
2903 | Call with -nolegacy to get rid of ipythonrc* files (recommended for | |
2906 | new users) |
|
2904 | new users) | |
2907 |
|
2905 | |||
2908 | """ |
|
2906 | """ | |
2909 | ip = self.getapi() |
|
2907 | ip = self.getapi() | |
2910 | ipinstallation = path(IPython.__file__).dirname() |
|
2908 | ipinstallation = path(IPython.__file__).dirname() | |
2911 | upgrade_script = '%s "%s"' % (sys.executable,ipinstallation / 'upgrade_dir.py') |
|
2909 | upgrade_script = '%s "%s"' % (sys.executable,ipinstallation / 'upgrade_dir.py') | |
2912 | src_config = ipinstallation / 'UserConfig' |
|
2910 | src_config = ipinstallation / 'UserConfig' | |
2913 | userdir = path(ip.options.ipythondir) |
|
2911 | userdir = path(ip.options.ipythondir) | |
2914 | cmd = '%s "%s" "%s"' % (upgrade_script, src_config, userdir) |
|
2912 | cmd = '%s "%s" "%s"' % (upgrade_script, src_config, userdir) | |
2915 | print ">",cmd |
|
2913 | print ">",cmd | |
2916 | shell(cmd) |
|
2914 | shell(cmd) | |
2917 | if arg == '-nolegacy': |
|
2915 | if arg == '-nolegacy': | |
2918 | legacy = userdir.files('ipythonrc*') |
|
2916 | legacy = userdir.files('ipythonrc*') | |
2919 | print "Nuking legacy files:",legacy |
|
2917 | print "Nuking legacy files:",legacy | |
2920 |
|
2918 | |||
2921 | [p.remove() for p in legacy] |
|
2919 | [p.remove() for p in legacy] | |
2922 | suffix = (sys.platform == 'win32' and '.ini' or '') |
|
2920 | suffix = (sys.platform == 'win32' and '.ini' or '') | |
2923 | (userdir / ('ipythonrc' + suffix)).write_text('# Empty, see ipy_user_conf.py\n') |
|
2921 | (userdir / ('ipythonrc' + suffix)).write_text('# Empty, see ipy_user_conf.py\n') | |
2924 |
|
2922 | |||
2925 |
|
2923 | |||
2926 | def magic_doctest_mode(self,parameter_s=''): |
|
2924 | def magic_doctest_mode(self,parameter_s=''): | |
2927 | """Toggle doctest mode on and off. |
|
2925 | """Toggle doctest mode on and off. | |
2928 |
|
2926 | |||
2929 | This mode allows you to toggle the prompt behavior between normal |
|
2927 | This mode allows you to toggle the prompt behavior between normal | |
2930 | IPython prompts and ones that are as similar to the default IPython |
|
2928 | IPython prompts and ones that are as similar to the default IPython | |
2931 | interpreter as possible. |
|
2929 | interpreter as possible. | |
2932 |
|
2930 | |||
2933 | It also supports the pasting of code snippets that have leading '>>>' |
|
2931 | It also supports the pasting of code snippets that have leading '>>>' | |
2934 | and '...' prompts in them. This means that you can paste doctests from |
|
2932 | and '...' prompts in them. This means that you can paste doctests from | |
2935 | files or docstrings (even if they have leading whitespace), and the |
|
2933 | files or docstrings (even if they have leading whitespace), and the | |
2936 | code will execute correctly. You can then use '%history -tn' to see |
|
2934 | code will execute correctly. You can then use '%history -tn' to see | |
2937 | the translated history without line numbers; this will give you the |
|
2935 | the translated history without line numbers; this will give you the | |
2938 | input after removal of all the leading prompts and whitespace, which |
|
2936 | input after removal of all the leading prompts and whitespace, which | |
2939 | can be pasted back into an editor. |
|
2937 | can be pasted back into an editor. | |
2940 |
|
2938 | |||
2941 | With these features, you can switch into this mode easily whenever you |
|
2939 | With these features, you can switch into this mode easily whenever you | |
2942 | need to do testing and changes to doctests, without having to leave |
|
2940 | need to do testing and changes to doctests, without having to leave | |
2943 | your existing IPython session. |
|
2941 | your existing IPython session. | |
2944 | """ |
|
2942 | """ | |
2945 |
|
2943 | |||
2946 | # XXX - Fix this to have cleaner activate/deactivate calls. |
|
2944 | # XXX - Fix this to have cleaner activate/deactivate calls. | |
2947 | from IPython.Extensions import InterpreterPasteInput as ipaste |
|
2945 | from IPython.Extensions import InterpreterPasteInput as ipaste | |
2948 | from IPython.ipstruct import Struct |
|
2946 | from IPython.ipstruct import Struct | |
2949 |
|
2947 | |||
2950 | # Shorthands |
|
2948 | # Shorthands | |
2951 | shell = self.shell |
|
2949 | shell = self.shell | |
2952 | oc = shell.outputcache |
|
2950 | oc = shell.outputcache | |
2953 | rc = shell.rc |
|
2951 | rc = shell.rc | |
2954 | meta = shell.meta |
|
2952 | meta = shell.meta | |
2955 | # dstore is a data store kept in the instance metadata bag to track any |
|
2953 | # dstore is a data store kept in the instance metadata bag to track any | |
2956 | # changes we make, so we can undo them later. |
|
2954 | # changes we make, so we can undo them later. | |
2957 | dstore = meta.setdefault('doctest_mode',Struct()) |
|
2955 | dstore = meta.setdefault('doctest_mode',Struct()) | |
2958 | save_dstore = dstore.setdefault |
|
2956 | save_dstore = dstore.setdefault | |
2959 |
|
2957 | |||
2960 | # save a few values we'll need to recover later |
|
2958 | # save a few values we'll need to recover later | |
2961 | mode = save_dstore('mode',False) |
|
2959 | mode = save_dstore('mode',False) | |
2962 | save_dstore('rc_pprint',rc.pprint) |
|
2960 | save_dstore('rc_pprint',rc.pprint) | |
2963 | save_dstore('xmode',shell.InteractiveTB.mode) |
|
2961 | save_dstore('xmode',shell.InteractiveTB.mode) | |
2964 | save_dstore('rc_separate_in',rc.separate_in) |
|
2962 | save_dstore('rc_separate_in',rc.separate_in) | |
2965 | save_dstore('rc_separate_out',rc.separate_out) |
|
2963 | save_dstore('rc_separate_out',rc.separate_out) | |
2966 | save_dstore('rc_separate_out2',rc.separate_out2) |
|
2964 | save_dstore('rc_separate_out2',rc.separate_out2) | |
2967 | save_dstore('rc_prompts_pad_left',rc.prompts_pad_left) |
|
2965 | save_dstore('rc_prompts_pad_left',rc.prompts_pad_left) | |
2968 |
|
2966 | |||
2969 | if mode == False: |
|
2967 | if mode == False: | |
2970 | # turn on |
|
2968 | # turn on | |
2971 | ipaste.activate_prefilter() |
|
2969 | ipaste.activate_prefilter() | |
2972 |
|
2970 | |||
2973 | oc.prompt1.p_template = '>>> ' |
|
2971 | oc.prompt1.p_template = '>>> ' | |
2974 | oc.prompt2.p_template = '... ' |
|
2972 | oc.prompt2.p_template = '... ' | |
2975 | oc.prompt_out.p_template = '' |
|
2973 | oc.prompt_out.p_template = '' | |
2976 |
|
2974 | |||
2977 | oc.prompt1.sep = '\n' |
|
2975 | oc.prompt1.sep = '\n' | |
2978 | oc.output_sep = '' |
|
2976 | oc.output_sep = '' | |
2979 | oc.output_sep2 = '' |
|
2977 | oc.output_sep2 = '' | |
2980 |
|
2978 | |||
2981 | oc.prompt1.pad_left = oc.prompt2.pad_left = \ |
|
2979 | oc.prompt1.pad_left = oc.prompt2.pad_left = \ | |
2982 | oc.prompt_out.pad_left = False |
|
2980 | oc.prompt_out.pad_left = False | |
2983 |
|
2981 | |||
2984 | rc.pprint = False |
|
2982 | rc.pprint = False | |
2985 |
|
2983 | |||
2986 | shell.magic_xmode('Plain') |
|
2984 | shell.magic_xmode('Plain') | |
2987 |
|
2985 | |||
2988 | else: |
|
2986 | else: | |
2989 | # turn off |
|
2987 | # turn off | |
2990 | ipaste.deactivate_prefilter() |
|
2988 | ipaste.deactivate_prefilter() | |
2991 |
|
2989 | |||
2992 | oc.prompt1.p_template = rc.prompt_in1 |
|
2990 | oc.prompt1.p_template = rc.prompt_in1 | |
2993 | oc.prompt2.p_template = rc.prompt_in2 |
|
2991 | oc.prompt2.p_template = rc.prompt_in2 | |
2994 | oc.prompt_out.p_template = rc.prompt_out |
|
2992 | oc.prompt_out.p_template = rc.prompt_out | |
2995 |
|
2993 | |||
2996 | oc.prompt1.sep = dstore.rc_separate_in |
|
2994 | oc.prompt1.sep = dstore.rc_separate_in | |
2997 | oc.output_sep = dstore.rc_separate_out |
|
2995 | oc.output_sep = dstore.rc_separate_out | |
2998 | oc.output_sep2 = dstore.rc_separate_out2 |
|
2996 | oc.output_sep2 = dstore.rc_separate_out2 | |
2999 |
|
2997 | |||
3000 | oc.prompt1.pad_left = oc.prompt2.pad_left = \ |
|
2998 | oc.prompt1.pad_left = oc.prompt2.pad_left = \ | |
3001 | oc.prompt_out.pad_left = dstore.rc_prompts_pad_left |
|
2999 | oc.prompt_out.pad_left = dstore.rc_prompts_pad_left | |
3002 |
|
3000 | |||
3003 | rc.pprint = dstore.rc_pprint |
|
3001 | rc.pprint = dstore.rc_pprint | |
3004 |
|
3002 | |||
3005 | shell.magic_xmode(dstore.xmode) |
|
3003 | shell.magic_xmode(dstore.xmode) | |
3006 |
|
3004 | |||
3007 | # Store new mode and inform |
|
3005 | # Store new mode and inform | |
3008 | dstore.mode = bool(1-int(mode)) |
|
3006 | dstore.mode = bool(1-int(mode)) | |
3009 | print 'Doctest mode is:', |
|
3007 | print 'Doctest mode is:', | |
3010 | print ['OFF','ON'][dstore.mode] |
|
3008 | print ['OFF','ON'][dstore.mode] | |
3011 |
|
3009 | |||
3012 | # end Magic |
|
3010 | # end Magic |
@@ -1,604 +1,609 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """ |
|
2 | """ | |
3 | Classes for handling input/output prompts. |
|
3 | Classes for handling input/output prompts. | |
4 |
|
4 | |||
5 |
$Id: Prompts.py 26 |
|
5 | $Id: Prompts.py 2659 2007-08-22 20:21:07Z vivainio $""" | |
6 |
|
6 | |||
7 | #***************************************************************************** |
|
7 | #***************************************************************************** | |
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 | from IPython import Release |
|
14 | from IPython import Release | |
15 | __author__ = '%s <%s>' % Release.authors['Fernando'] |
|
15 | __author__ = '%s <%s>' % Release.authors['Fernando'] | |
16 | __license__ = Release.license |
|
16 | __license__ = Release.license | |
17 | __version__ = Release.version |
|
17 | __version__ = Release.version | |
18 |
|
18 | |||
19 | #**************************************************************************** |
|
19 | #**************************************************************************** | |
20 | # Required modules |
|
20 | # Required modules | |
21 | import __builtin__ |
|
21 | import __builtin__ | |
22 | import os |
|
22 | import os | |
23 | import socket |
|
23 | import socket | |
24 | import sys |
|
24 | import sys | |
25 | import time |
|
25 | import time | |
26 |
|
26 | |||
27 | # IPython's own |
|
27 | # IPython's own | |
28 | from IPython import ColorANSI |
|
28 | from IPython import ColorANSI | |
29 | from IPython.Itpl import ItplNS |
|
29 | from IPython.Itpl import ItplNS | |
30 | from IPython.ipstruct import Struct |
|
30 | from IPython.ipstruct import Struct | |
31 | from IPython.macro import Macro |
|
31 | from IPython.macro import Macro | |
32 | from IPython.genutils import * |
|
32 | from IPython.genutils import * | |
33 | from IPython.ipapi import TryNext |
|
33 | from IPython.ipapi import TryNext | |
34 |
|
34 | |||
35 | #**************************************************************************** |
|
35 | #**************************************************************************** | |
36 | #Color schemes for Prompts. |
|
36 | #Color schemes for Prompts. | |
37 |
|
37 | |||
38 | PromptColors = ColorANSI.ColorSchemeTable() |
|
38 | PromptColors = ColorANSI.ColorSchemeTable() | |
39 | InputColors = ColorANSI.InputTermColors # just a shorthand |
|
39 | InputColors = ColorANSI.InputTermColors # just a shorthand | |
40 | Colors = ColorANSI.TermColors # just a shorthand |
|
40 | Colors = ColorANSI.TermColors # just a shorthand | |
41 |
|
41 | |||
42 | PromptColors.add_scheme(ColorANSI.ColorScheme( |
|
42 | PromptColors.add_scheme(ColorANSI.ColorScheme( | |
43 | 'NoColor', |
|
43 | 'NoColor', | |
44 | in_prompt = InputColors.NoColor, # Input prompt |
|
44 | in_prompt = InputColors.NoColor, # Input prompt | |
45 | in_number = InputColors.NoColor, # Input prompt number |
|
45 | in_number = InputColors.NoColor, # Input prompt number | |
46 | in_prompt2 = InputColors.NoColor, # Continuation prompt |
|
46 | in_prompt2 = InputColors.NoColor, # Continuation prompt | |
47 | in_normal = InputColors.NoColor, # color off (usu. Colors.Normal) |
|
47 | in_normal = InputColors.NoColor, # color off (usu. Colors.Normal) | |
48 |
|
48 | |||
49 | out_prompt = Colors.NoColor, # Output prompt |
|
49 | out_prompt = Colors.NoColor, # Output prompt | |
50 | out_number = Colors.NoColor, # Output prompt number |
|
50 | out_number = Colors.NoColor, # Output prompt number | |
51 |
|
51 | |||
52 | normal = Colors.NoColor # color off (usu. Colors.Normal) |
|
52 | normal = Colors.NoColor # color off (usu. Colors.Normal) | |
53 | )) |
|
53 | )) | |
54 |
|
54 | |||
55 | # make some schemes as instances so we can copy them for modification easily: |
|
55 | # make some schemes as instances so we can copy them for modification easily: | |
56 | __PColLinux = ColorANSI.ColorScheme( |
|
56 | __PColLinux = ColorANSI.ColorScheme( | |
57 | 'Linux', |
|
57 | 'Linux', | |
58 | in_prompt = InputColors.Green, |
|
58 | in_prompt = InputColors.Green, | |
59 | in_number = InputColors.LightGreen, |
|
59 | in_number = InputColors.LightGreen, | |
60 | in_prompt2 = InputColors.Green, |
|
60 | in_prompt2 = InputColors.Green, | |
61 | in_normal = InputColors.Normal, # color off (usu. Colors.Normal) |
|
61 | in_normal = InputColors.Normal, # color off (usu. Colors.Normal) | |
62 |
|
62 | |||
63 | out_prompt = Colors.Red, |
|
63 | out_prompt = Colors.Red, | |
64 | out_number = Colors.LightRed, |
|
64 | out_number = Colors.LightRed, | |
65 |
|
65 | |||
66 | normal = Colors.Normal |
|
66 | normal = Colors.Normal | |
67 | ) |
|
67 | ) | |
68 | # Don't forget to enter it into the table! |
|
68 | # Don't forget to enter it into the table! | |
69 | PromptColors.add_scheme(__PColLinux) |
|
69 | PromptColors.add_scheme(__PColLinux) | |
70 |
|
70 | |||
71 | # Slightly modified Linux for light backgrounds |
|
71 | # Slightly modified Linux for light backgrounds | |
72 | __PColLightBG = __PColLinux.copy('LightBG') |
|
72 | __PColLightBG = __PColLinux.copy('LightBG') | |
73 |
|
73 | |||
74 | __PColLightBG.colors.update( |
|
74 | __PColLightBG.colors.update( | |
75 | in_prompt = InputColors.Blue, |
|
75 | in_prompt = InputColors.Blue, | |
76 | in_number = InputColors.LightBlue, |
|
76 | in_number = InputColors.LightBlue, | |
77 | in_prompt2 = InputColors.Blue |
|
77 | in_prompt2 = InputColors.Blue | |
78 | ) |
|
78 | ) | |
79 | PromptColors.add_scheme(__PColLightBG) |
|
79 | PromptColors.add_scheme(__PColLightBG) | |
80 |
|
80 | |||
81 | del Colors,InputColors |
|
81 | del Colors,InputColors | |
82 |
|
82 | |||
83 | #----------------------------------------------------------------------------- |
|
83 | #----------------------------------------------------------------------------- | |
84 | def multiple_replace(dict, text): |
|
84 | def multiple_replace(dict, text): | |
85 | """ Replace in 'text' all occurences of any key in the given |
|
85 | """ Replace in 'text' all occurences of any key in the given | |
86 | dictionary by its corresponding value. Returns the new string.""" |
|
86 | dictionary by its corresponding value. Returns the new string.""" | |
87 |
|
87 | |||
88 | # Function by Xavier Defrang, originally found at: |
|
88 | # Function by Xavier Defrang, originally found at: | |
89 | # http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/81330 |
|
89 | # http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/81330 | |
90 |
|
90 | |||
91 | # Create a regular expression from the dictionary keys |
|
91 | # Create a regular expression from the dictionary keys | |
92 | regex = re.compile("(%s)" % "|".join(map(re.escape, dict.keys()))) |
|
92 | regex = re.compile("(%s)" % "|".join(map(re.escape, dict.keys()))) | |
93 | # For each match, look-up corresponding value in dictionary |
|
93 | # For each match, look-up corresponding value in dictionary | |
94 | return regex.sub(lambda mo: dict[mo.string[mo.start():mo.end()]], text) |
|
94 | return regex.sub(lambda mo: dict[mo.string[mo.start():mo.end()]], text) | |
95 |
|
95 | |||
96 | #----------------------------------------------------------------------------- |
|
96 | #----------------------------------------------------------------------------- | |
97 | # Special characters that can be used in prompt templates, mainly bash-like |
|
97 | # Special characters that can be used in prompt templates, mainly bash-like | |
98 |
|
98 | |||
99 | # If $HOME isn't defined (Windows), make it an absurd string so that it can |
|
99 | # If $HOME isn't defined (Windows), make it an absurd string so that it can | |
100 | # never be expanded out into '~'. Basically anything which can never be a |
|
100 | # never be expanded out into '~'. Basically anything which can never be a | |
101 | # reasonable directory name will do, we just want the $HOME -> '~' operation |
|
101 | # reasonable directory name will do, we just want the $HOME -> '~' operation | |
102 | # to become a no-op. We pre-compute $HOME here so it's not done on every |
|
102 | # to become a no-op. We pre-compute $HOME here so it's not done on every | |
103 | # prompt call. |
|
103 | # prompt call. | |
104 |
|
104 | |||
105 | # FIXME: |
|
105 | # FIXME: | |
106 |
|
106 | |||
107 | # - This should be turned into a class which does proper namespace management, |
|
107 | # - This should be turned into a class which does proper namespace management, | |
108 | # since the prompt specials need to be evaluated in a certain namespace. |
|
108 | # since the prompt specials need to be evaluated in a certain namespace. | |
109 | # Currently it's just globals, which need to be managed manually by code |
|
109 | # Currently it's just globals, which need to be managed manually by code | |
110 | # below. |
|
110 | # below. | |
111 |
|
111 | |||
112 | # - I also need to split up the color schemes from the prompt specials |
|
112 | # - I also need to split up the color schemes from the prompt specials | |
113 | # somehow. I don't have a clean design for that quite yet. |
|
113 | # somehow. I don't have a clean design for that quite yet. | |
114 |
|
114 | |||
115 | HOME = os.environ.get("HOME","//////:::::ZZZZZ,,,~~~") |
|
115 | HOME = os.environ.get("HOME","//////:::::ZZZZZ,,,~~~") | |
116 |
|
116 | |||
117 | # We precompute a few more strings here for the prompt_specials, which are |
|
117 | # We precompute a few more strings here for the prompt_specials, which are | |
118 | # fixed once ipython starts. This reduces the runtime overhead of computing |
|
118 | # fixed once ipython starts. This reduces the runtime overhead of computing | |
119 | # prompt strings. |
|
119 | # prompt strings. | |
120 | USER = os.environ.get("USER") |
|
120 | USER = os.environ.get("USER") | |
121 | HOSTNAME = socket.gethostname() |
|
121 | HOSTNAME = socket.gethostname() | |
122 | HOSTNAME_SHORT = HOSTNAME.split(".")[0] |
|
122 | HOSTNAME_SHORT = HOSTNAME.split(".")[0] | |
123 | ROOT_SYMBOL = "$#"[os.name=='nt' or os.getuid()==0] |
|
123 | ROOT_SYMBOL = "$#"[os.name=='nt' or os.getuid()==0] | |
124 |
|
124 | |||
125 | prompt_specials_color = { |
|
125 | prompt_specials_color = { | |
126 | # Prompt/history count |
|
126 | # Prompt/history count | |
127 | '%n' : '${self.col_num}' '${self.cache.prompt_count}' '${self.col_p}', |
|
127 | '%n' : '${self.col_num}' '${self.cache.prompt_count}' '${self.col_p}', | |
128 | r'\#': '${self.col_num}' '${self.cache.prompt_count}' '${self.col_p}', |
|
128 | r'\#': '${self.col_num}' '${self.cache.prompt_count}' '${self.col_p}', | |
129 | # Just the prompt counter number, WITHOUT any coloring wrappers, so users |
|
129 | # Just the prompt counter number, WITHOUT any coloring wrappers, so users | |
130 | # can get numbers displayed in whatever color they want. |
|
130 | # can get numbers displayed in whatever color they want. | |
131 | r'\N': '${self.cache.prompt_count}', |
|
131 | r'\N': '${self.cache.prompt_count}', | |
132 | # Prompt/history count, with the actual digits replaced by dots. Used |
|
132 | # Prompt/history count, with the actual digits replaced by dots. Used | |
133 | # mainly in continuation prompts (prompt_in2) |
|
133 | # mainly in continuation prompts (prompt_in2) | |
134 | r'\D': '${"."*len(str(self.cache.prompt_count))}', |
|
134 | r'\D': '${"."*len(str(self.cache.prompt_count))}', | |
135 | # Current working directory |
|
135 | # Current working directory | |
136 | r'\w': '${os.getcwd()}', |
|
136 | r'\w': '${os.getcwd()}', | |
137 | # Current time |
|
137 | # Current time | |
138 | r'\t' : '${time.strftime("%H:%M:%S")}', |
|
138 | r'\t' : '${time.strftime("%H:%M:%S")}', | |
139 | # Basename of current working directory. |
|
139 | # Basename of current working directory. | |
140 | # (use os.sep to make this portable across OSes) |
|
140 | # (use os.sep to make this portable across OSes) | |
141 | r'\W' : '${os.getcwd().split("%s")[-1]}' % os.sep, |
|
141 | r'\W' : '${os.getcwd().split("%s")[-1]}' % os.sep, | |
142 | # These X<N> are an extension to the normal bash prompts. They return |
|
142 | # These X<N> are an extension to the normal bash prompts. They return | |
143 | # N terms of the path, after replacing $HOME with '~' |
|
143 | # N terms of the path, after replacing $HOME with '~' | |
144 | r'\X0': '${os.getcwd().replace("%s","~")}' % HOME, |
|
144 | r'\X0': '${os.getcwd().replace("%s","~")}' % HOME, | |
145 | r'\X1': '${self.cwd_filt(1)}', |
|
145 | r'\X1': '${self.cwd_filt(1)}', | |
146 | r'\X2': '${self.cwd_filt(2)}', |
|
146 | r'\X2': '${self.cwd_filt(2)}', | |
147 | r'\X3': '${self.cwd_filt(3)}', |
|
147 | r'\X3': '${self.cwd_filt(3)}', | |
148 | r'\X4': '${self.cwd_filt(4)}', |
|
148 | r'\X4': '${self.cwd_filt(4)}', | |
149 | r'\X5': '${self.cwd_filt(5)}', |
|
149 | r'\X5': '${self.cwd_filt(5)}', | |
150 | # Y<N> are similar to X<N>, but they show '~' if it's the directory |
|
150 | # Y<N> are similar to X<N>, but they show '~' if it's the directory | |
151 | # N+1 in the list. Somewhat like %cN in tcsh. |
|
151 | # N+1 in the list. Somewhat like %cN in tcsh. | |
152 | r'\Y0': '${self.cwd_filt2(0)}', |
|
152 | r'\Y0': '${self.cwd_filt2(0)}', | |
153 | r'\Y1': '${self.cwd_filt2(1)}', |
|
153 | r'\Y1': '${self.cwd_filt2(1)}', | |
154 | r'\Y2': '${self.cwd_filt2(2)}', |
|
154 | r'\Y2': '${self.cwd_filt2(2)}', | |
155 | r'\Y3': '${self.cwd_filt2(3)}', |
|
155 | r'\Y3': '${self.cwd_filt2(3)}', | |
156 | r'\Y4': '${self.cwd_filt2(4)}', |
|
156 | r'\Y4': '${self.cwd_filt2(4)}', | |
157 | r'\Y5': '${self.cwd_filt2(5)}', |
|
157 | r'\Y5': '${self.cwd_filt2(5)}', | |
158 | # Hostname up to first . |
|
158 | # Hostname up to first . | |
159 | r'\h': HOSTNAME_SHORT, |
|
159 | r'\h': HOSTNAME_SHORT, | |
160 | # Full hostname |
|
160 | # Full hostname | |
161 | r'\H': HOSTNAME, |
|
161 | r'\H': HOSTNAME, | |
162 | # Username of current user |
|
162 | # Username of current user | |
163 | r'\u': USER, |
|
163 | r'\u': USER, | |
164 | # Escaped '\' |
|
164 | # Escaped '\' | |
165 | '\\\\': '\\', |
|
165 | '\\\\': '\\', | |
166 | # Newline |
|
166 | # Newline | |
167 | r'\n': '\n', |
|
167 | r'\n': '\n', | |
168 | # Carriage return |
|
168 | # Carriage return | |
169 | r'\r': '\r', |
|
169 | r'\r': '\r', | |
170 | # Release version |
|
170 | # Release version | |
171 | r'\v': __version__, |
|
171 | r'\v': __version__, | |
172 | # Root symbol ($ or #) |
|
172 | # Root symbol ($ or #) | |
173 | r'\$': ROOT_SYMBOL, |
|
173 | r'\$': ROOT_SYMBOL, | |
174 | } |
|
174 | } | |
175 |
|
175 | |||
176 | # A copy of the prompt_specials dictionary but with all color escapes removed, |
|
176 | # A copy of the prompt_specials dictionary but with all color escapes removed, | |
177 | # so we can correctly compute the prompt length for the auto_rewrite method. |
|
177 | # so we can correctly compute the prompt length for the auto_rewrite method. | |
178 | prompt_specials_nocolor = prompt_specials_color.copy() |
|
178 | prompt_specials_nocolor = prompt_specials_color.copy() | |
179 | prompt_specials_nocolor['%n'] = '${self.cache.prompt_count}' |
|
179 | prompt_specials_nocolor['%n'] = '${self.cache.prompt_count}' | |
180 | prompt_specials_nocolor[r'\#'] = '${self.cache.prompt_count}' |
|
180 | prompt_specials_nocolor[r'\#'] = '${self.cache.prompt_count}' | |
181 |
|
181 | |||
182 | # Add in all the InputTermColors color escapes as valid prompt characters. |
|
182 | # Add in all the InputTermColors color escapes as valid prompt characters. | |
183 | # They all get added as \\C_COLORNAME, so that we don't have any conflicts |
|
183 | # They all get added as \\C_COLORNAME, so that we don't have any conflicts | |
184 | # with a color name which may begin with a letter used by any other of the |
|
184 | # with a color name which may begin with a letter used by any other of the | |
185 | # allowed specials. This of course means that \\C will never be allowed for |
|
185 | # allowed specials. This of course means that \\C will never be allowed for | |
186 | # anything else. |
|
186 | # anything else. | |
187 | input_colors = ColorANSI.InputTermColors |
|
187 | input_colors = ColorANSI.InputTermColors | |
188 | for _color in dir(input_colors): |
|
188 | for _color in dir(input_colors): | |
189 | if _color[0] != '_': |
|
189 | if _color[0] != '_': | |
190 | c_name = r'\C_'+_color |
|
190 | c_name = r'\C_'+_color | |
191 | prompt_specials_color[c_name] = getattr(input_colors,_color) |
|
191 | prompt_specials_color[c_name] = getattr(input_colors,_color) | |
192 | prompt_specials_nocolor[c_name] = '' |
|
192 | prompt_specials_nocolor[c_name] = '' | |
193 |
|
193 | |||
194 | # we default to no color for safety. Note that prompt_specials is a global |
|
194 | # we default to no color for safety. Note that prompt_specials is a global | |
195 | # variable used by all prompt objects. |
|
195 | # variable used by all prompt objects. | |
196 | prompt_specials = prompt_specials_nocolor |
|
196 | prompt_specials = prompt_specials_nocolor | |
197 |
|
197 | |||
198 | #----------------------------------------------------------------------------- |
|
198 | #----------------------------------------------------------------------------- | |
199 | def str_safe(arg): |
|
199 | def str_safe(arg): | |
200 | """Convert to a string, without ever raising an exception. |
|
200 | """Convert to a string, without ever raising an exception. | |
201 |
|
201 | |||
202 | If str(arg) fails, <ERROR: ... > is returned, where ... is the exception |
|
202 | If str(arg) fails, <ERROR: ... > is returned, where ... is the exception | |
203 | error message.""" |
|
203 | error message.""" | |
204 |
|
204 | |||
205 | try: |
|
205 | try: | |
206 | out = str(arg) |
|
206 | out = str(arg) | |
207 | except UnicodeError: |
|
207 | except UnicodeError: | |
208 | try: |
|
208 | try: | |
209 | out = arg.encode('utf_8','replace') |
|
209 | out = arg.encode('utf_8','replace') | |
210 | except Exception,msg: |
|
210 | except Exception,msg: | |
211 | # let's keep this little duplication here, so that the most common |
|
211 | # let's keep this little duplication here, so that the most common | |
212 | # case doesn't suffer from a double try wrapping. |
|
212 | # case doesn't suffer from a double try wrapping. | |
213 | out = '<ERROR: %s>' % msg |
|
213 | out = '<ERROR: %s>' % msg | |
214 | except Exception,msg: |
|
214 | except Exception,msg: | |
215 | out = '<ERROR: %s>' % msg |
|
215 | out = '<ERROR: %s>' % msg | |
216 | return out |
|
216 | return out | |
217 |
|
217 | |||
218 | class BasePrompt(object): |
|
218 | class BasePrompt(object): | |
219 | """Interactive prompt similar to Mathematica's.""" |
|
219 | """Interactive prompt similar to Mathematica's.""" | |
220 |
|
220 | |||
221 | def _get_p_template(self): |
|
221 | def _get_p_template(self): | |
222 | return self._p_template |
|
222 | return self._p_template | |
223 |
|
223 | |||
224 | def _set_p_template(self,val): |
|
224 | def _set_p_template(self,val): | |
225 | self._p_template = val |
|
225 | self._p_template = val | |
226 | self.set_p_str() |
|
226 | self.set_p_str() | |
227 |
|
227 | |||
228 | p_template = property(_get_p_template,_set_p_template, |
|
228 | p_template = property(_get_p_template,_set_p_template, | |
229 | doc='Template for prompt string creation') |
|
229 | doc='Template for prompt string creation') | |
230 |
|
230 | |||
231 | def __init__(self,cache,sep,prompt,pad_left=False): |
|
231 | def __init__(self,cache,sep,prompt,pad_left=False): | |
232 |
|
232 | |||
233 | # Hack: we access information about the primary prompt through the |
|
233 | # Hack: we access information about the primary prompt through the | |
234 | # cache argument. We need this, because we want the secondary prompt |
|
234 | # cache argument. We need this, because we want the secondary prompt | |
235 | # to be aligned with the primary one. Color table info is also shared |
|
235 | # to be aligned with the primary one. Color table info is also shared | |
236 | # by all prompt classes through the cache. Nice OO spaghetti code! |
|
236 | # by all prompt classes through the cache. Nice OO spaghetti code! | |
237 | self.cache = cache |
|
237 | self.cache = cache | |
238 | self.sep = sep |
|
238 | self.sep = sep | |
239 |
|
239 | |||
240 | # regexp to count the number of spaces at the end of a prompt |
|
240 | # regexp to count the number of spaces at the end of a prompt | |
241 | # expression, useful for prompt auto-rewriting |
|
241 | # expression, useful for prompt auto-rewriting | |
242 | self.rspace = re.compile(r'(\s*)$') |
|
242 | self.rspace = re.compile(r'(\s*)$') | |
243 | # Flag to left-pad prompt strings to match the length of the primary |
|
243 | # Flag to left-pad prompt strings to match the length of the primary | |
244 | # prompt |
|
244 | # prompt | |
245 | self.pad_left = pad_left |
|
245 | self.pad_left = pad_left | |
246 |
|
246 | |||
247 | # Set template to create each actual prompt (where numbers change). |
|
247 | # Set template to create each actual prompt (where numbers change). | |
248 | # Use a property |
|
248 | # Use a property | |
249 | self.p_template = prompt |
|
249 | self.p_template = prompt | |
250 | self.set_p_str() |
|
250 | self.set_p_str() | |
251 |
|
251 | |||
252 | def set_p_str(self): |
|
252 | def set_p_str(self): | |
253 | """ Set the interpolating prompt strings. |
|
253 | """ Set the interpolating prompt strings. | |
254 |
|
254 | |||
255 | This must be called every time the color settings change, because the |
|
255 | This must be called every time the color settings change, because the | |
256 | prompt_specials global may have changed.""" |
|
256 | prompt_specials global may have changed.""" | |
257 |
|
257 | |||
258 | import os,time # needed in locals for prompt string handling |
|
258 | import os,time # needed in locals for prompt string handling | |
259 | loc = locals() |
|
259 | loc = locals() | |
260 | self.p_str = ItplNS('%s%s%s' % |
|
260 | self.p_str = ItplNS('%s%s%s' % | |
261 | ('${self.sep}${self.col_p}', |
|
261 | ('${self.sep}${self.col_p}', | |
262 | multiple_replace(prompt_specials, self.p_template), |
|
262 | multiple_replace(prompt_specials, self.p_template), | |
263 | '${self.col_norm}'),self.cache.user_ns,loc) |
|
263 | '${self.col_norm}'),self.cache.user_ns,loc) | |
264 |
|
264 | |||
265 | self.p_str_nocolor = ItplNS(multiple_replace(prompt_specials_nocolor, |
|
265 | self.p_str_nocolor = ItplNS(multiple_replace(prompt_specials_nocolor, | |
266 | self.p_template), |
|
266 | self.p_template), | |
267 | self.cache.user_ns,loc) |
|
267 | self.cache.user_ns,loc) | |
268 |
|
268 | |||
269 | def write(self,msg): # dbg |
|
269 | def write(self,msg): # dbg | |
270 | sys.stdout.write(msg) |
|
270 | sys.stdout.write(msg) | |
271 | return '' |
|
271 | return '' | |
272 |
|
272 | |||
273 | def __str__(self): |
|
273 | def __str__(self): | |
274 | """Return a string form of the prompt. |
|
274 | """Return a string form of the prompt. | |
275 |
|
275 | |||
276 | This for is useful for continuation and output prompts, since it is |
|
276 | This for is useful for continuation and output prompts, since it is | |
277 | left-padded to match lengths with the primary one (if the |
|
277 | left-padded to match lengths with the primary one (if the | |
278 | self.pad_left attribute is set).""" |
|
278 | self.pad_left attribute is set).""" | |
279 |
|
279 | |||
280 | out_str = str_safe(self.p_str) |
|
280 | out_str = str_safe(self.p_str) | |
281 | if self.pad_left: |
|
281 | if self.pad_left: | |
282 | # We must find the amount of padding required to match lengths, |
|
282 | # We must find the amount of padding required to match lengths, | |
283 | # taking the color escapes (which are invisible on-screen) into |
|
283 | # taking the color escapes (which are invisible on-screen) into | |
284 | # account. |
|
284 | # account. | |
285 | esc_pad = len(out_str) - len(str_safe(self.p_str_nocolor)) |
|
285 | esc_pad = len(out_str) - len(str_safe(self.p_str_nocolor)) | |
286 | format = '%%%ss' % (len(str(self.cache.last_prompt))+esc_pad) |
|
286 | format = '%%%ss' % (len(str(self.cache.last_prompt))+esc_pad) | |
287 | return format % out_str |
|
287 | return format % out_str | |
288 | else: |
|
288 | else: | |
289 | return out_str |
|
289 | return out_str | |
290 |
|
290 | |||
291 | # these path filters are put in as methods so that we can control the |
|
291 | # these path filters are put in as methods so that we can control the | |
292 | # namespace where the prompt strings get evaluated |
|
292 | # namespace where the prompt strings get evaluated | |
293 | def cwd_filt(self,depth): |
|
293 | def cwd_filt(self,depth): | |
294 | """Return the last depth elements of the current working directory. |
|
294 | """Return the last depth elements of the current working directory. | |
295 |
|
295 | |||
296 | $HOME is always replaced with '~'. |
|
296 | $HOME is always replaced with '~'. | |
297 | If depth==0, the full path is returned.""" |
|
297 | If depth==0, the full path is returned.""" | |
298 |
|
298 | |||
299 | cwd = os.getcwd().replace(HOME,"~") |
|
299 | cwd = os.getcwd().replace(HOME,"~") | |
300 | out = os.sep.join(cwd.split(os.sep)[-depth:]) |
|
300 | out = os.sep.join(cwd.split(os.sep)[-depth:]) | |
301 | if out: |
|
301 | if out: | |
302 | return out |
|
302 | return out | |
303 | else: |
|
303 | else: | |
304 | return os.sep |
|
304 | return os.sep | |
305 |
|
305 | |||
306 | def cwd_filt2(self,depth): |
|
306 | def cwd_filt2(self,depth): | |
307 | """Return the last depth elements of the current working directory. |
|
307 | """Return the last depth elements of the current working directory. | |
308 |
|
308 | |||
309 | $HOME is always replaced with '~'. |
|
309 | $HOME is always replaced with '~'. | |
310 | If depth==0, the full path is returned.""" |
|
310 | If depth==0, the full path is returned.""" | |
311 |
|
311 | |||
312 | cwd = os.getcwd().replace(HOME,"~").split(os.sep) |
|
312 | full_cwd = os.getcwd() | |
|
313 | cwd = full_cwd.replace(HOME,"~").split(os.sep) | |||
313 | if '~' in cwd and len(cwd) == depth+1: |
|
314 | if '~' in cwd and len(cwd) == depth+1: | |
314 | depth += 1 |
|
315 | depth += 1 | |
315 | out = os.sep.join(cwd[-depth:]) |
|
316 | drivepart = '' | |
|
317 | if sys.platform == 'win32' and len(cwd) > depth: | |||
|
318 | drivepart = os.path.splitdrive(full_cwd)[0] | |||
|
319 | out = drivepart + '/'.join(cwd[-depth:]) | |||
|
320 | ||||
316 | if out: |
|
321 | if out: | |
317 | return out |
|
322 | return out | |
318 | else: |
|
323 | else: | |
319 | return os.sep |
|
324 | return os.sep | |
320 |
|
325 | |||
321 | class Prompt1(BasePrompt): |
|
326 | class Prompt1(BasePrompt): | |
322 | """Input interactive prompt similar to Mathematica's.""" |
|
327 | """Input interactive prompt similar to Mathematica's.""" | |
323 |
|
328 | |||
324 | def __init__(self,cache,sep='\n',prompt='In [\\#]: ',pad_left=True): |
|
329 | def __init__(self,cache,sep='\n',prompt='In [\\#]: ',pad_left=True): | |
325 | BasePrompt.__init__(self,cache,sep,prompt,pad_left) |
|
330 | BasePrompt.__init__(self,cache,sep,prompt,pad_left) | |
326 |
|
331 | |||
327 | def set_colors(self): |
|
332 | def set_colors(self): | |
328 | self.set_p_str() |
|
333 | self.set_p_str() | |
329 | Colors = self.cache.color_table.active_colors # shorthand |
|
334 | Colors = self.cache.color_table.active_colors # shorthand | |
330 | self.col_p = Colors.in_prompt |
|
335 | self.col_p = Colors.in_prompt | |
331 | self.col_num = Colors.in_number |
|
336 | self.col_num = Colors.in_number | |
332 | self.col_norm = Colors.in_normal |
|
337 | self.col_norm = Colors.in_normal | |
333 | # We need a non-input version of these escapes for the '--->' |
|
338 | # We need a non-input version of these escapes for the '--->' | |
334 | # auto-call prompts used in the auto_rewrite() method. |
|
339 | # auto-call prompts used in the auto_rewrite() method. | |
335 | self.col_p_ni = self.col_p.replace('\001','').replace('\002','') |
|
340 | self.col_p_ni = self.col_p.replace('\001','').replace('\002','') | |
336 | self.col_norm_ni = Colors.normal |
|
341 | self.col_norm_ni = Colors.normal | |
337 |
|
342 | |||
338 | def __str__(self): |
|
343 | def __str__(self): | |
339 | self.cache.prompt_count += 1 |
|
344 | self.cache.prompt_count += 1 | |
340 | self.cache.last_prompt = str_safe(self.p_str_nocolor).split('\n')[-1] |
|
345 | self.cache.last_prompt = str_safe(self.p_str_nocolor).split('\n')[-1] | |
341 | return str_safe(self.p_str) |
|
346 | return str_safe(self.p_str) | |
342 |
|
347 | |||
343 | def auto_rewrite(self): |
|
348 | def auto_rewrite(self): | |
344 | """Print a string of the form '--->' which lines up with the previous |
|
349 | """Print a string of the form '--->' which lines up with the previous | |
345 | input string. Useful for systems which re-write the user input when |
|
350 | input string. Useful for systems which re-write the user input when | |
346 | handling automatically special syntaxes.""" |
|
351 | handling automatically special syntaxes.""" | |
347 |
|
352 | |||
348 | curr = str(self.cache.last_prompt) |
|
353 | curr = str(self.cache.last_prompt) | |
349 | nrspaces = len(self.rspace.search(curr).group()) |
|
354 | nrspaces = len(self.rspace.search(curr).group()) | |
350 | return '%s%s>%s%s' % (self.col_p_ni,'-'*(len(curr)-nrspaces-1), |
|
355 | return '%s%s>%s%s' % (self.col_p_ni,'-'*(len(curr)-nrspaces-1), | |
351 | ' '*nrspaces,self.col_norm_ni) |
|
356 | ' '*nrspaces,self.col_norm_ni) | |
352 |
|
357 | |||
353 | class PromptOut(BasePrompt): |
|
358 | class PromptOut(BasePrompt): | |
354 | """Output interactive prompt similar to Mathematica's.""" |
|
359 | """Output interactive prompt similar to Mathematica's.""" | |
355 |
|
360 | |||
356 | def __init__(self,cache,sep='',prompt='Out[\\#]: ',pad_left=True): |
|
361 | def __init__(self,cache,sep='',prompt='Out[\\#]: ',pad_left=True): | |
357 | BasePrompt.__init__(self,cache,sep,prompt,pad_left) |
|
362 | BasePrompt.__init__(self,cache,sep,prompt,pad_left) | |
358 | if not self.p_template: |
|
363 | if not self.p_template: | |
359 | self.__str__ = lambda: '' |
|
364 | self.__str__ = lambda: '' | |
360 |
|
365 | |||
361 | def set_colors(self): |
|
366 | def set_colors(self): | |
362 | self.set_p_str() |
|
367 | self.set_p_str() | |
363 | Colors = self.cache.color_table.active_colors # shorthand |
|
368 | Colors = self.cache.color_table.active_colors # shorthand | |
364 | self.col_p = Colors.out_prompt |
|
369 | self.col_p = Colors.out_prompt | |
365 | self.col_num = Colors.out_number |
|
370 | self.col_num = Colors.out_number | |
366 | self.col_norm = Colors.normal |
|
371 | self.col_norm = Colors.normal | |
367 |
|
372 | |||
368 | class Prompt2(BasePrompt): |
|
373 | class Prompt2(BasePrompt): | |
369 | """Interactive continuation prompt.""" |
|
374 | """Interactive continuation prompt.""" | |
370 |
|
375 | |||
371 | def __init__(self,cache,prompt=' .\\D.: ',pad_left=True): |
|
376 | def __init__(self,cache,prompt=' .\\D.: ',pad_left=True): | |
372 | self.cache = cache |
|
377 | self.cache = cache | |
373 | self.p_template = prompt |
|
378 | self.p_template = prompt | |
374 | self.pad_left = pad_left |
|
379 | self.pad_left = pad_left | |
375 | self.set_p_str() |
|
380 | self.set_p_str() | |
376 |
|
381 | |||
377 | def set_p_str(self): |
|
382 | def set_p_str(self): | |
378 | import os,time # needed in locals for prompt string handling |
|
383 | import os,time # needed in locals for prompt string handling | |
379 | loc = locals() |
|
384 | loc = locals() | |
380 | self.p_str = ItplNS('%s%s%s' % |
|
385 | self.p_str = ItplNS('%s%s%s' % | |
381 | ('${self.col_p2}', |
|
386 | ('${self.col_p2}', | |
382 | multiple_replace(prompt_specials, self.p_template), |
|
387 | multiple_replace(prompt_specials, self.p_template), | |
383 | '$self.col_norm'), |
|
388 | '$self.col_norm'), | |
384 | self.cache.user_ns,loc) |
|
389 | self.cache.user_ns,loc) | |
385 | self.p_str_nocolor = ItplNS(multiple_replace(prompt_specials_nocolor, |
|
390 | self.p_str_nocolor = ItplNS(multiple_replace(prompt_specials_nocolor, | |
386 | self.p_template), |
|
391 | self.p_template), | |
387 | self.cache.user_ns,loc) |
|
392 | self.cache.user_ns,loc) | |
388 |
|
393 | |||
389 | def set_colors(self): |
|
394 | def set_colors(self): | |
390 | self.set_p_str() |
|
395 | self.set_p_str() | |
391 | Colors = self.cache.color_table.active_colors |
|
396 | Colors = self.cache.color_table.active_colors | |
392 | self.col_p2 = Colors.in_prompt2 |
|
397 | self.col_p2 = Colors.in_prompt2 | |
393 | self.col_norm = Colors.in_normal |
|
398 | self.col_norm = Colors.in_normal | |
394 | # FIXME (2004-06-16) HACK: prevent crashes for users who haven't |
|
399 | # FIXME (2004-06-16) HACK: prevent crashes for users who haven't | |
395 | # updated their prompt_in2 definitions. Remove eventually. |
|
400 | # updated their prompt_in2 definitions. Remove eventually. | |
396 | self.col_p = Colors.out_prompt |
|
401 | self.col_p = Colors.out_prompt | |
397 | self.col_num = Colors.out_number |
|
402 | self.col_num = Colors.out_number | |
398 |
|
403 | |||
399 |
|
404 | |||
400 | #----------------------------------------------------------------------------- |
|
405 | #----------------------------------------------------------------------------- | |
401 | class CachedOutput: |
|
406 | class CachedOutput: | |
402 | """Class for printing output from calculations while keeping a cache of |
|
407 | """Class for printing output from calculations while keeping a cache of | |
403 | reults. It dynamically creates global variables prefixed with _ which |
|
408 | reults. It dynamically creates global variables prefixed with _ which | |
404 | contain these results. |
|
409 | contain these results. | |
405 |
|
410 | |||
406 | Meant to be used as a sys.displayhook replacement, providing numbered |
|
411 | Meant to be used as a sys.displayhook replacement, providing numbered | |
407 | prompts and cache services. |
|
412 | prompts and cache services. | |
408 |
|
413 | |||
409 | Initialize with initial and final values for cache counter (this defines |
|
414 | Initialize with initial and final values for cache counter (this defines | |
410 | the maximum size of the cache.""" |
|
415 | the maximum size of the cache.""" | |
411 |
|
416 | |||
412 | def __init__(self,shell,cache_size,Pprint, |
|
417 | def __init__(self,shell,cache_size,Pprint, | |
413 | colors='NoColor',input_sep='\n', |
|
418 | colors='NoColor',input_sep='\n', | |
414 | output_sep='\n',output_sep2='', |
|
419 | output_sep='\n',output_sep2='', | |
415 | ps1 = None, ps2 = None,ps_out = None,pad_left=True): |
|
420 | ps1 = None, ps2 = None,ps_out = None,pad_left=True): | |
416 |
|
421 | |||
417 | cache_size_min = 3 |
|
422 | cache_size_min = 3 | |
418 | if cache_size <= 0: |
|
423 | if cache_size <= 0: | |
419 | self.do_full_cache = 0 |
|
424 | self.do_full_cache = 0 | |
420 | cache_size = 0 |
|
425 | cache_size = 0 | |
421 | elif cache_size < cache_size_min: |
|
426 | elif cache_size < cache_size_min: | |
422 | self.do_full_cache = 0 |
|
427 | self.do_full_cache = 0 | |
423 | cache_size = 0 |
|
428 | cache_size = 0 | |
424 | warn('caching was disabled (min value for cache size is %s).' % |
|
429 | warn('caching was disabled (min value for cache size is %s).' % | |
425 | cache_size_min,level=3) |
|
430 | cache_size_min,level=3) | |
426 | else: |
|
431 | else: | |
427 | self.do_full_cache = 1 |
|
432 | self.do_full_cache = 1 | |
428 |
|
433 | |||
429 | self.cache_size = cache_size |
|
434 | self.cache_size = cache_size | |
430 | self.input_sep = input_sep |
|
435 | self.input_sep = input_sep | |
431 |
|
436 | |||
432 | # we need a reference to the user-level namespace |
|
437 | # we need a reference to the user-level namespace | |
433 | self.shell = shell |
|
438 | self.shell = shell | |
434 | self.user_ns = shell.user_ns |
|
439 | self.user_ns = shell.user_ns | |
435 | # and to the user's input |
|
440 | # and to the user's input | |
436 | self.input_hist = shell.input_hist |
|
441 | self.input_hist = shell.input_hist | |
437 | # and to the user's logger, for logging output |
|
442 | # and to the user's logger, for logging output | |
438 | self.logger = shell.logger |
|
443 | self.logger = shell.logger | |
439 |
|
444 | |||
440 | # Set input prompt strings and colors |
|
445 | # Set input prompt strings and colors | |
441 | if cache_size == 0: |
|
446 | if cache_size == 0: | |
442 | if ps1.find('%n') > -1 or ps1.find(r'\#') > -1 \ |
|
447 | if ps1.find('%n') > -1 or ps1.find(r'\#') > -1 \ | |
443 | or ps1.find(r'\N') > -1: |
|
448 | or ps1.find(r'\N') > -1: | |
444 | ps1 = '>>> ' |
|
449 | ps1 = '>>> ' | |
445 | if ps2.find('%n') > -1 or ps2.find(r'\#') > -1 \ |
|
450 | if ps2.find('%n') > -1 or ps2.find(r'\#') > -1 \ | |
446 | or ps2.find(r'\N') > -1: |
|
451 | or ps2.find(r'\N') > -1: | |
447 | ps2 = '... ' |
|
452 | ps2 = '... ' | |
448 | self.ps1_str = self._set_prompt_str(ps1,'In [\\#]: ','>>> ') |
|
453 | self.ps1_str = self._set_prompt_str(ps1,'In [\\#]: ','>>> ') | |
449 | self.ps2_str = self._set_prompt_str(ps2,' .\\D.: ','... ') |
|
454 | self.ps2_str = self._set_prompt_str(ps2,' .\\D.: ','... ') | |
450 | self.ps_out_str = self._set_prompt_str(ps_out,'Out[\\#]: ','') |
|
455 | self.ps_out_str = self._set_prompt_str(ps_out,'Out[\\#]: ','') | |
451 |
|
456 | |||
452 | self.color_table = PromptColors |
|
457 | self.color_table = PromptColors | |
453 | self.prompt1 = Prompt1(self,sep=input_sep,prompt=self.ps1_str, |
|
458 | self.prompt1 = Prompt1(self,sep=input_sep,prompt=self.ps1_str, | |
454 | pad_left=pad_left) |
|
459 | pad_left=pad_left) | |
455 | self.prompt2 = Prompt2(self,prompt=self.ps2_str,pad_left=pad_left) |
|
460 | self.prompt2 = Prompt2(self,prompt=self.ps2_str,pad_left=pad_left) | |
456 | self.prompt_out = PromptOut(self,sep='',prompt=self.ps_out_str, |
|
461 | self.prompt_out = PromptOut(self,sep='',prompt=self.ps_out_str, | |
457 | pad_left=pad_left) |
|
462 | pad_left=pad_left) | |
458 | self.set_colors(colors) |
|
463 | self.set_colors(colors) | |
459 |
|
464 | |||
460 | # other more normal stuff |
|
465 | # other more normal stuff | |
461 | # b/c each call to the In[] prompt raises it by 1, even the first. |
|
466 | # b/c each call to the In[] prompt raises it by 1, even the first. | |
462 | self.prompt_count = 0 |
|
467 | self.prompt_count = 0 | |
463 | # Store the last prompt string each time, we need it for aligning |
|
468 | # Store the last prompt string each time, we need it for aligning | |
464 | # continuation and auto-rewrite prompts |
|
469 | # continuation and auto-rewrite prompts | |
465 | self.last_prompt = '' |
|
470 | self.last_prompt = '' | |
466 | self.Pprint = Pprint |
|
471 | self.Pprint = Pprint | |
467 | self.output_sep = output_sep |
|
472 | self.output_sep = output_sep | |
468 | self.output_sep2 = output_sep2 |
|
473 | self.output_sep2 = output_sep2 | |
469 | self._,self.__,self.___ = '','','' |
|
474 | self._,self.__,self.___ = '','','' | |
470 | self.pprint_types = map(type,[(),[],{}]) |
|
475 | self.pprint_types = map(type,[(),[],{}]) | |
471 |
|
476 | |||
472 | # these are deliberately global: |
|
477 | # these are deliberately global: | |
473 | to_user_ns = {'_':self._,'__':self.__,'___':self.___} |
|
478 | to_user_ns = {'_':self._,'__':self.__,'___':self.___} | |
474 | self.user_ns.update(to_user_ns) |
|
479 | self.user_ns.update(to_user_ns) | |
475 |
|
480 | |||
476 | def _set_prompt_str(self,p_str,cache_def,no_cache_def): |
|
481 | def _set_prompt_str(self,p_str,cache_def,no_cache_def): | |
477 | if p_str is None: |
|
482 | if p_str is None: | |
478 | if self.do_full_cache: |
|
483 | if self.do_full_cache: | |
479 | return cache_def |
|
484 | return cache_def | |
480 | else: |
|
485 | else: | |
481 | return no_cache_def |
|
486 | return no_cache_def | |
482 | else: |
|
487 | else: | |
483 | return p_str |
|
488 | return p_str | |
484 |
|
489 | |||
485 | def set_colors(self,colors): |
|
490 | def set_colors(self,colors): | |
486 | """Set the active color scheme and configure colors for the three |
|
491 | """Set the active color scheme and configure colors for the three | |
487 | prompt subsystems.""" |
|
492 | prompt subsystems.""" | |
488 |
|
493 | |||
489 | # FIXME: the prompt_specials global should be gobbled inside this |
|
494 | # FIXME: the prompt_specials global should be gobbled inside this | |
490 | # class instead. Do it when cleaning up the whole 3-prompt system. |
|
495 | # class instead. Do it when cleaning up the whole 3-prompt system. | |
491 | global prompt_specials |
|
496 | global prompt_specials | |
492 | if colors.lower()=='nocolor': |
|
497 | if colors.lower()=='nocolor': | |
493 | prompt_specials = prompt_specials_nocolor |
|
498 | prompt_specials = prompt_specials_nocolor | |
494 | else: |
|
499 | else: | |
495 | prompt_specials = prompt_specials_color |
|
500 | prompt_specials = prompt_specials_color | |
496 |
|
501 | |||
497 | self.color_table.set_active_scheme(colors) |
|
502 | self.color_table.set_active_scheme(colors) | |
498 | self.prompt1.set_colors() |
|
503 | self.prompt1.set_colors() | |
499 | self.prompt2.set_colors() |
|
504 | self.prompt2.set_colors() | |
500 | self.prompt_out.set_colors() |
|
505 | self.prompt_out.set_colors() | |
501 |
|
506 | |||
502 | def __call__(self,arg=None): |
|
507 | def __call__(self,arg=None): | |
503 | """Printing with history cache management. |
|
508 | """Printing with history cache management. | |
504 |
|
509 | |||
505 | This is invoked everytime the interpreter needs to print, and is |
|
510 | This is invoked everytime the interpreter needs to print, and is | |
506 | activated by setting the variable sys.displayhook to it.""" |
|
511 | activated by setting the variable sys.displayhook to it.""" | |
507 |
|
512 | |||
508 | # If something injected a '_' variable in __builtin__, delete |
|
513 | # If something injected a '_' variable in __builtin__, delete | |
509 | # ipython's automatic one so we don't clobber that. gettext() in |
|
514 | # ipython's automatic one so we don't clobber that. gettext() in | |
510 | # particular uses _, so we need to stay away from it. |
|
515 | # particular uses _, so we need to stay away from it. | |
511 | if '_' in __builtin__.__dict__: |
|
516 | if '_' in __builtin__.__dict__: | |
512 | try: |
|
517 | try: | |
513 | del self.user_ns['_'] |
|
518 | del self.user_ns['_'] | |
514 | except KeyError: |
|
519 | except KeyError: | |
515 | pass |
|
520 | pass | |
516 | if arg is not None: |
|
521 | if arg is not None: | |
517 | cout_write = Term.cout.write # fast lookup |
|
522 | cout_write = Term.cout.write # fast lookup | |
518 | # first handle the cache and counters |
|
523 | # first handle the cache and counters | |
519 |
|
524 | |||
520 | # do not print output if input ends in ';' |
|
525 | # do not print output if input ends in ';' | |
521 | if self.input_hist[self.prompt_count].endswith(';\n'): |
|
526 | if self.input_hist[self.prompt_count].endswith(';\n'): | |
522 | return |
|
527 | return | |
523 | # don't use print, puts an extra space |
|
528 | # don't use print, puts an extra space | |
524 | cout_write(self.output_sep) |
|
529 | cout_write(self.output_sep) | |
525 | outprompt = self.shell.hooks.generate_output_prompt() |
|
530 | outprompt = self.shell.hooks.generate_output_prompt() | |
526 | if self.do_full_cache: |
|
531 | if self.do_full_cache: | |
527 | cout_write(outprompt) |
|
532 | cout_write(outprompt) | |
528 |
|
533 | |||
529 | # and now call a possibly user-defined print mechanism |
|
534 | # and now call a possibly user-defined print mechanism | |
530 | manipulated_val = self.display(arg) |
|
535 | manipulated_val = self.display(arg) | |
531 |
|
536 | |||
532 | # user display hooks can change the variable to be stored in |
|
537 | # user display hooks can change the variable to be stored in | |
533 | # output history |
|
538 | # output history | |
534 |
|
539 | |||
535 | if manipulated_val is not None: |
|
540 | if manipulated_val is not None: | |
536 | arg = manipulated_val |
|
541 | arg = manipulated_val | |
537 |
|
542 | |||
538 | # avoid recursive reference when displaying _oh/Out |
|
543 | # avoid recursive reference when displaying _oh/Out | |
539 | if arg is not self.user_ns['_oh']: |
|
544 | if arg is not self.user_ns['_oh']: | |
540 | self.update(arg) |
|
545 | self.update(arg) | |
541 |
|
546 | |||
542 | if self.logger.log_output: |
|
547 | if self.logger.log_output: | |
543 | self.logger.log_write(repr(arg),'output') |
|
548 | self.logger.log_write(repr(arg),'output') | |
544 | cout_write(self.output_sep2) |
|
549 | cout_write(self.output_sep2) | |
545 | Term.cout.flush() |
|
550 | Term.cout.flush() | |
546 |
|
551 | |||
547 | def _display(self,arg): |
|
552 | def _display(self,arg): | |
548 | """Default printer method, uses pprint. |
|
553 | """Default printer method, uses pprint. | |
549 |
|
554 | |||
550 | Do ip.set_hook("result_display", my_displayhook) for custom result |
|
555 | Do ip.set_hook("result_display", my_displayhook) for custom result | |
551 | display, e.g. when your own objects need special formatting. |
|
556 | display, e.g. when your own objects need special formatting. | |
552 | """ |
|
557 | """ | |
553 | try: |
|
558 | try: | |
554 | return IPython.generics.result_display(arg) |
|
559 | return IPython.generics.result_display(arg) | |
555 | except TryNext: |
|
560 | except TryNext: | |
556 | return self.shell.hooks.result_display(arg) |
|
561 | return self.shell.hooks.result_display(arg) | |
557 |
|
562 | |||
558 | # Assign the default display method: |
|
563 | # Assign the default display method: | |
559 | display = _display |
|
564 | display = _display | |
560 |
|
565 | |||
561 | def update(self,arg): |
|
566 | def update(self,arg): | |
562 | #print '***cache_count', self.cache_count # dbg |
|
567 | #print '***cache_count', self.cache_count # dbg | |
563 | if len(self.user_ns['_oh']) >= self.cache_size and self.do_full_cache: |
|
568 | if len(self.user_ns['_oh']) >= self.cache_size and self.do_full_cache: | |
564 | warn('Output cache limit (currently '+ |
|
569 | warn('Output cache limit (currently '+ | |
565 | `self.cache_size`+' entries) hit.\n' |
|
570 | `self.cache_size`+' entries) hit.\n' | |
566 | 'Flushing cache and resetting history counter...\n' |
|
571 | 'Flushing cache and resetting history counter...\n' | |
567 | 'The only history variables available will be _,__,___ and _1\n' |
|
572 | 'The only history variables available will be _,__,___ and _1\n' | |
568 | 'with the current result.') |
|
573 | 'with the current result.') | |
569 |
|
574 | |||
570 | self.flush() |
|
575 | self.flush() | |
571 | # Don't overwrite '_' and friends if '_' is in __builtin__ (otherwise |
|
576 | # Don't overwrite '_' and friends if '_' is in __builtin__ (otherwise | |
572 | # we cause buggy behavior for things like gettext). |
|
577 | # we cause buggy behavior for things like gettext). | |
573 | if '_' not in __builtin__.__dict__: |
|
578 | if '_' not in __builtin__.__dict__: | |
574 | self.___ = self.__ |
|
579 | self.___ = self.__ | |
575 | self.__ = self._ |
|
580 | self.__ = self._ | |
576 | self._ = arg |
|
581 | self._ = arg | |
577 | self.user_ns.update({'_':self._,'__':self.__,'___':self.___}) |
|
582 | self.user_ns.update({'_':self._,'__':self.__,'___':self.___}) | |
578 |
|
583 | |||
579 | # hackish access to top-level namespace to create _1,_2... dynamically |
|
584 | # hackish access to top-level namespace to create _1,_2... dynamically | |
580 | to_main = {} |
|
585 | to_main = {} | |
581 | if self.do_full_cache: |
|
586 | if self.do_full_cache: | |
582 | new_result = '_'+`self.prompt_count` |
|
587 | new_result = '_'+`self.prompt_count` | |
583 | to_main[new_result] = arg |
|
588 | to_main[new_result] = arg | |
584 | self.user_ns.update(to_main) |
|
589 | self.user_ns.update(to_main) | |
585 | self.user_ns['_oh'][self.prompt_count] = arg |
|
590 | self.user_ns['_oh'][self.prompt_count] = arg | |
586 |
|
591 | |||
587 | def flush(self): |
|
592 | def flush(self): | |
588 | if not self.do_full_cache: |
|
593 | if not self.do_full_cache: | |
589 | raise ValueError,"You shouldn't have reached the cache flush "\ |
|
594 | raise ValueError,"You shouldn't have reached the cache flush "\ | |
590 | "if full caching is not enabled!" |
|
595 | "if full caching is not enabled!" | |
591 | # delete auto-generated vars from global namespace |
|
596 | # delete auto-generated vars from global namespace | |
592 |
|
597 | |||
593 | for n in range(1,self.prompt_count + 1): |
|
598 | for n in range(1,self.prompt_count + 1): | |
594 | key = '_'+`n` |
|
599 | key = '_'+`n` | |
595 | try: |
|
600 | try: | |
596 | del self.user_ns[key] |
|
601 | del self.user_ns[key] | |
597 | except: pass |
|
602 | except: pass | |
598 | self.user_ns['_oh'].clear() |
|
603 | self.user_ns['_oh'].clear() | |
599 |
|
604 | |||
600 | if '_' not in __builtin__.__dict__: |
|
605 | if '_' not in __builtin__.__dict__: | |
601 | self.user_ns.update({'_':None,'__':None, '___':None}) |
|
606 | self.user_ns.update({'_':None,'__':None, '___':None}) | |
602 | import gc |
|
607 | import gc | |
603 | gc.collect() # xxx needed? |
|
608 | gc.collect() # xxx needed? | |
604 |
|
609 |
@@ -1,1874 +1,1887 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """ |
|
2 | """ | |
3 | General purpose utilities. |
|
3 | General purpose utilities. | |
4 |
|
4 | |||
5 | This is a grab-bag of stuff I find useful in most programs I write. Some of |
|
5 | This is a grab-bag of stuff I find useful in most programs I write. Some of | |
6 | these things are also convenient when working at the command line. |
|
6 | these things are also convenient when working at the command line. | |
7 |
|
7 | |||
8 |
$Id: genutils.py 26 |
|
8 | $Id: genutils.py 2659 2007-08-22 20:21:07Z vivainio $""" | |
9 |
|
9 | |||
10 | #***************************************************************************** |
|
10 | #***************************************************************************** | |
11 | # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu> |
|
11 | # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu> | |
12 | # |
|
12 | # | |
13 | # Distributed under the terms of the BSD License. The full license is in |
|
13 | # Distributed under the terms of the BSD License. The full license is in | |
14 | # the file COPYING, distributed as part of this software. |
|
14 | # the file COPYING, distributed as part of this software. | |
15 | #***************************************************************************** |
|
15 | #***************************************************************************** | |
16 |
|
16 | |||
17 | from IPython import Release |
|
17 | from IPython import Release | |
18 | __author__ = '%s <%s>' % Release.authors['Fernando'] |
|
18 | __author__ = '%s <%s>' % Release.authors['Fernando'] | |
19 | __license__ = Release.license |
|
19 | __license__ = Release.license | |
20 |
|
20 | |||
21 | #**************************************************************************** |
|
21 | #**************************************************************************** | |
22 | # required modules from the Python standard library |
|
22 | # required modules from the Python standard library | |
23 | import __main__ |
|
23 | import __main__ | |
24 | import commands |
|
24 | import commands | |
25 | import os |
|
25 | import os | |
26 | import re |
|
26 | import re | |
27 | import shlex |
|
27 | import shlex | |
28 | import shutil |
|
28 | import shutil | |
29 | import sys |
|
29 | import sys | |
30 | import tempfile |
|
30 | import tempfile | |
31 | import time |
|
31 | import time | |
32 | import types |
|
32 | import types | |
33 | import warnings |
|
33 | import warnings | |
34 |
|
34 | |||
35 | # Other IPython utilities |
|
35 | # Other IPython utilities | |
36 | import IPython |
|
36 | import IPython | |
37 | from IPython.Itpl import Itpl,itpl,printpl |
|
37 | from IPython.Itpl import Itpl,itpl,printpl | |
38 | from IPython import DPyGetOpt, platutils |
|
38 | from IPython import DPyGetOpt, platutils | |
39 | from IPython.generics import result_display |
|
39 | from IPython.generics import result_display | |
40 | from path import path |
|
40 | from path import path | |
41 | if os.name == "nt": |
|
41 | if os.name == "nt": | |
42 | from IPython.winconsole import get_console_size |
|
42 | from IPython.winconsole import get_console_size | |
43 |
|
43 | |||
44 | #**************************************************************************** |
|
44 | #**************************************************************************** | |
45 | # Exceptions |
|
45 | # Exceptions | |
46 | class Error(Exception): |
|
46 | class Error(Exception): | |
47 | """Base class for exceptions in this module.""" |
|
47 | """Base class for exceptions in this module.""" | |
48 | pass |
|
48 | pass | |
49 |
|
49 | |||
50 | #---------------------------------------------------------------------------- |
|
50 | #---------------------------------------------------------------------------- | |
51 | class IOStream: |
|
51 | class IOStream: | |
52 | def __init__(self,stream,fallback): |
|
52 | def __init__(self,stream,fallback): | |
53 | if not hasattr(stream,'write') or not hasattr(stream,'flush'): |
|
53 | if not hasattr(stream,'write') or not hasattr(stream,'flush'): | |
54 | stream = fallback |
|
54 | stream = fallback | |
55 | self.stream = stream |
|
55 | self.stream = stream | |
56 | self._swrite = stream.write |
|
56 | self._swrite = stream.write | |
57 | self.flush = stream.flush |
|
57 | self.flush = stream.flush | |
58 |
|
58 | |||
59 | def write(self,data): |
|
59 | def write(self,data): | |
60 | try: |
|
60 | try: | |
61 | self._swrite(data) |
|
61 | self._swrite(data) | |
62 | except: |
|
62 | except: | |
63 | try: |
|
63 | try: | |
64 | # print handles some unicode issues which may trip a plain |
|
64 | # print handles some unicode issues which may trip a plain | |
65 | # write() call. Attempt to emulate write() by using a |
|
65 | # write() call. Attempt to emulate write() by using a | |
66 | # trailing comma |
|
66 | # trailing comma | |
67 | print >> self.stream, data, |
|
67 | print >> self.stream, data, | |
68 | except: |
|
68 | except: | |
69 | # if we get here, something is seriously broken. |
|
69 | # if we get here, something is seriously broken. | |
70 | print >> sys.stderr, \ |
|
70 | print >> sys.stderr, \ | |
71 | 'ERROR - failed to write data to stream:', self.stream |
|
71 | 'ERROR - failed to write data to stream:', self.stream | |
72 |
|
72 | |||
73 | def close(self): |
|
73 | def close(self): | |
74 | pass |
|
74 | pass | |
75 |
|
75 | |||
76 |
|
76 | |||
77 | class IOTerm: |
|
77 | class IOTerm: | |
78 | """ Term holds the file or file-like objects for handling I/O operations. |
|
78 | """ Term holds the file or file-like objects for handling I/O operations. | |
79 |
|
79 | |||
80 | These are normally just sys.stdin, sys.stdout and sys.stderr but for |
|
80 | These are normally just sys.stdin, sys.stdout and sys.stderr but for | |
81 | Windows they can can replaced to allow editing the strings before they are |
|
81 | Windows they can can replaced to allow editing the strings before they are | |
82 | displayed.""" |
|
82 | displayed.""" | |
83 |
|
83 | |||
84 | # In the future, having IPython channel all its I/O operations through |
|
84 | # In the future, having IPython channel all its I/O operations through | |
85 | # this class will make it easier to embed it into other environments which |
|
85 | # this class will make it easier to embed it into other environments which | |
86 | # are not a normal terminal (such as a GUI-based shell) |
|
86 | # are not a normal terminal (such as a GUI-based shell) | |
87 | def __init__(self,cin=None,cout=None,cerr=None): |
|
87 | def __init__(self,cin=None,cout=None,cerr=None): | |
88 | self.cin = IOStream(cin,sys.stdin) |
|
88 | self.cin = IOStream(cin,sys.stdin) | |
89 | self.cout = IOStream(cout,sys.stdout) |
|
89 | self.cout = IOStream(cout,sys.stdout) | |
90 | self.cerr = IOStream(cerr,sys.stderr) |
|
90 | self.cerr = IOStream(cerr,sys.stderr) | |
91 |
|
91 | |||
92 | # Global variable to be used for all I/O |
|
92 | # Global variable to be used for all I/O | |
93 | Term = IOTerm() |
|
93 | Term = IOTerm() | |
94 |
|
94 | |||
95 | import IPython.rlineimpl as readline |
|
95 | import IPython.rlineimpl as readline | |
96 | # Remake Term to use the readline i/o facilities |
|
96 | # Remake Term to use the readline i/o facilities | |
97 | if sys.platform == 'win32' and readline.have_readline: |
|
97 | if sys.platform == 'win32' and readline.have_readline: | |
98 |
|
98 | |||
99 | Term = IOTerm(cout=readline._outputfile,cerr=readline._outputfile) |
|
99 | Term = IOTerm(cout=readline._outputfile,cerr=readline._outputfile) | |
100 |
|
100 | |||
101 |
|
101 | |||
102 | #**************************************************************************** |
|
102 | #**************************************************************************** | |
103 | # Generic warning/error printer, used by everything else |
|
103 | # Generic warning/error printer, used by everything else | |
104 | def warn(msg,level=2,exit_val=1): |
|
104 | def warn(msg,level=2,exit_val=1): | |
105 | """Standard warning printer. Gives formatting consistency. |
|
105 | """Standard warning printer. Gives formatting consistency. | |
106 |
|
106 | |||
107 | Output is sent to Term.cerr (sys.stderr by default). |
|
107 | Output is sent to Term.cerr (sys.stderr by default). | |
108 |
|
108 | |||
109 | Options: |
|
109 | Options: | |
110 |
|
110 | |||
111 | -level(2): allows finer control: |
|
111 | -level(2): allows finer control: | |
112 | 0 -> Do nothing, dummy function. |
|
112 | 0 -> Do nothing, dummy function. | |
113 | 1 -> Print message. |
|
113 | 1 -> Print message. | |
114 | 2 -> Print 'WARNING:' + message. (Default level). |
|
114 | 2 -> Print 'WARNING:' + message. (Default level). | |
115 | 3 -> Print 'ERROR:' + message. |
|
115 | 3 -> Print 'ERROR:' + message. | |
116 | 4 -> Print 'FATAL ERROR:' + message and trigger a sys.exit(exit_val). |
|
116 | 4 -> Print 'FATAL ERROR:' + message and trigger a sys.exit(exit_val). | |
117 |
|
117 | |||
118 | -exit_val (1): exit value returned by sys.exit() for a level 4 |
|
118 | -exit_val (1): exit value returned by sys.exit() for a level 4 | |
119 | warning. Ignored for all other levels.""" |
|
119 | warning. Ignored for all other levels.""" | |
120 |
|
120 | |||
121 | if level>0: |
|
121 | if level>0: | |
122 | header = ['','','WARNING: ','ERROR: ','FATAL ERROR: '] |
|
122 | header = ['','','WARNING: ','ERROR: ','FATAL ERROR: '] | |
123 | print >> Term.cerr, '%s%s' % (header[level],msg) |
|
123 | print >> Term.cerr, '%s%s' % (header[level],msg) | |
124 | if level == 4: |
|
124 | if level == 4: | |
125 | print >> Term.cerr,'Exiting.\n' |
|
125 | print >> Term.cerr,'Exiting.\n' | |
126 | sys.exit(exit_val) |
|
126 | sys.exit(exit_val) | |
127 |
|
127 | |||
128 | def info(msg): |
|
128 | def info(msg): | |
129 | """Equivalent to warn(msg,level=1).""" |
|
129 | """Equivalent to warn(msg,level=1).""" | |
130 |
|
130 | |||
131 | warn(msg,level=1) |
|
131 | warn(msg,level=1) | |
132 |
|
132 | |||
133 | def error(msg): |
|
133 | def error(msg): | |
134 | """Equivalent to warn(msg,level=3).""" |
|
134 | """Equivalent to warn(msg,level=3).""" | |
135 |
|
135 | |||
136 | warn(msg,level=3) |
|
136 | warn(msg,level=3) | |
137 |
|
137 | |||
138 | def fatal(msg,exit_val=1): |
|
138 | def fatal(msg,exit_val=1): | |
139 | """Equivalent to warn(msg,exit_val=exit_val,level=4).""" |
|
139 | """Equivalent to warn(msg,exit_val=exit_val,level=4).""" | |
140 |
|
140 | |||
141 | warn(msg,exit_val=exit_val,level=4) |
|
141 | warn(msg,exit_val=exit_val,level=4) | |
142 |
|
142 | |||
143 | #--------------------------------------------------------------------------- |
|
143 | #--------------------------------------------------------------------------- | |
144 | # Debugging routines |
|
144 | # Debugging routines | |
145 | # |
|
145 | # | |
146 | def debugx(expr,pre_msg=''): |
|
146 | def debugx(expr,pre_msg=''): | |
147 | """Print the value of an expression from the caller's frame. |
|
147 | """Print the value of an expression from the caller's frame. | |
148 |
|
148 | |||
149 | Takes an expression, evaluates it in the caller's frame and prints both |
|
149 | Takes an expression, evaluates it in the caller's frame and prints both | |
150 | the given expression and the resulting value (as well as a debug mark |
|
150 | the given expression and the resulting value (as well as a debug mark | |
151 | indicating the name of the calling function. The input must be of a form |
|
151 | indicating the name of the calling function. The input must be of a form | |
152 | suitable for eval(). |
|
152 | suitable for eval(). | |
153 |
|
153 | |||
154 | An optional message can be passed, which will be prepended to the printed |
|
154 | An optional message can be passed, which will be prepended to the printed | |
155 | expr->value pair.""" |
|
155 | expr->value pair.""" | |
156 |
|
156 | |||
157 | cf = sys._getframe(1) |
|
157 | cf = sys._getframe(1) | |
158 | print '[DBG:%s] %s%s -> %r' % (cf.f_code.co_name,pre_msg,expr, |
|
158 | print '[DBG:%s] %s%s -> %r' % (cf.f_code.co_name,pre_msg,expr, | |
159 | eval(expr,cf.f_globals,cf.f_locals)) |
|
159 | eval(expr,cf.f_globals,cf.f_locals)) | |
160 |
|
160 | |||
161 | # deactivate it by uncommenting the following line, which makes it a no-op |
|
161 | # deactivate it by uncommenting the following line, which makes it a no-op | |
162 | #def debugx(expr,pre_msg=''): pass |
|
162 | #def debugx(expr,pre_msg=''): pass | |
163 |
|
163 | |||
164 | #---------------------------------------------------------------------------- |
|
164 | #---------------------------------------------------------------------------- | |
165 | StringTypes = types.StringTypes |
|
165 | StringTypes = types.StringTypes | |
166 |
|
166 | |||
167 | # Basic timing functionality |
|
167 | # Basic timing functionality | |
168 |
|
168 | |||
169 | # If possible (Unix), use the resource module instead of time.clock() |
|
169 | # If possible (Unix), use the resource module instead of time.clock() | |
170 | try: |
|
170 | try: | |
171 | import resource |
|
171 | import resource | |
172 | def clocku(): |
|
172 | def clocku(): | |
173 | """clocku() -> floating point number |
|
173 | """clocku() -> floating point number | |
174 |
|
174 | |||
175 | Return the *USER* CPU time in seconds since the start of the process. |
|
175 | Return the *USER* CPU time in seconds since the start of the process. | |
176 | This is done via a call to resource.getrusage, so it avoids the |
|
176 | This is done via a call to resource.getrusage, so it avoids the | |
177 | wraparound problems in time.clock().""" |
|
177 | wraparound problems in time.clock().""" | |
178 |
|
178 | |||
179 | return resource.getrusage(resource.RUSAGE_SELF)[0] |
|
179 | return resource.getrusage(resource.RUSAGE_SELF)[0] | |
180 |
|
180 | |||
181 | def clocks(): |
|
181 | def clocks(): | |
182 | """clocks() -> floating point number |
|
182 | """clocks() -> floating point number | |
183 |
|
183 | |||
184 | Return the *SYSTEM* CPU time in seconds since the start of the process. |
|
184 | Return the *SYSTEM* CPU time in seconds since the start of the process. | |
185 | This is done via a call to resource.getrusage, so it avoids the |
|
185 | This is done via a call to resource.getrusage, so it avoids the | |
186 | wraparound problems in time.clock().""" |
|
186 | wraparound problems in time.clock().""" | |
187 |
|
187 | |||
188 | return resource.getrusage(resource.RUSAGE_SELF)[1] |
|
188 | return resource.getrusage(resource.RUSAGE_SELF)[1] | |
189 |
|
189 | |||
190 | def clock(): |
|
190 | def clock(): | |
191 | """clock() -> floating point number |
|
191 | """clock() -> floating point number | |
192 |
|
192 | |||
193 | Return the *TOTAL USER+SYSTEM* CPU time in seconds since the start of |
|
193 | Return the *TOTAL USER+SYSTEM* CPU time in seconds since the start of | |
194 | the process. This is done via a call to resource.getrusage, so it |
|
194 | the process. This is done via a call to resource.getrusage, so it | |
195 | avoids the wraparound problems in time.clock().""" |
|
195 | avoids the wraparound problems in time.clock().""" | |
196 |
|
196 | |||
197 | u,s = resource.getrusage(resource.RUSAGE_SELF)[:2] |
|
197 | u,s = resource.getrusage(resource.RUSAGE_SELF)[:2] | |
198 | return u+s |
|
198 | return u+s | |
199 |
|
199 | |||
200 | def clock2(): |
|
200 | def clock2(): | |
201 | """clock2() -> (t_user,t_system) |
|
201 | """clock2() -> (t_user,t_system) | |
202 |
|
202 | |||
203 | Similar to clock(), but return a tuple of user/system times.""" |
|
203 | Similar to clock(), but return a tuple of user/system times.""" | |
204 | return resource.getrusage(resource.RUSAGE_SELF)[:2] |
|
204 | return resource.getrusage(resource.RUSAGE_SELF)[:2] | |
205 |
|
205 | |||
206 | except ImportError: |
|
206 | except ImportError: | |
207 | # There is no distinction of user/system time under windows, so we just use |
|
207 | # There is no distinction of user/system time under windows, so we just use | |
208 | # time.clock() for everything... |
|
208 | # time.clock() for everything... | |
209 | clocku = clocks = clock = time.clock |
|
209 | clocku = clocks = clock = time.clock | |
210 | def clock2(): |
|
210 | def clock2(): | |
211 | """Under windows, system CPU time can't be measured. |
|
211 | """Under windows, system CPU time can't be measured. | |
212 |
|
212 | |||
213 | This just returns clock() and zero.""" |
|
213 | This just returns clock() and zero.""" | |
214 | return time.clock(),0.0 |
|
214 | return time.clock(),0.0 | |
215 |
|
215 | |||
216 | def timings_out(reps,func,*args,**kw): |
|
216 | def timings_out(reps,func,*args,**kw): | |
217 | """timings_out(reps,func,*args,**kw) -> (t_total,t_per_call,output) |
|
217 | """timings_out(reps,func,*args,**kw) -> (t_total,t_per_call,output) | |
218 |
|
218 | |||
219 | Execute a function reps times, return a tuple with the elapsed total |
|
219 | Execute a function reps times, return a tuple with the elapsed total | |
220 | CPU time in seconds, the time per call and the function's output. |
|
220 | CPU time in seconds, the time per call and the function's output. | |
221 |
|
221 | |||
222 | Under Unix, the return value is the sum of user+system time consumed by |
|
222 | Under Unix, the return value is the sum of user+system time consumed by | |
223 | the process, computed via the resource module. This prevents problems |
|
223 | the process, computed via the resource module. This prevents problems | |
224 | related to the wraparound effect which the time.clock() function has. |
|
224 | related to the wraparound effect which the time.clock() function has. | |
225 |
|
225 | |||
226 | Under Windows the return value is in wall clock seconds. See the |
|
226 | Under Windows the return value is in wall clock seconds. See the | |
227 | documentation for the time module for more details.""" |
|
227 | documentation for the time module for more details.""" | |
228 |
|
228 | |||
229 | reps = int(reps) |
|
229 | reps = int(reps) | |
230 | assert reps >=1, 'reps must be >= 1' |
|
230 | assert reps >=1, 'reps must be >= 1' | |
231 | if reps==1: |
|
231 | if reps==1: | |
232 | start = clock() |
|
232 | start = clock() | |
233 | out = func(*args,**kw) |
|
233 | out = func(*args,**kw) | |
234 | tot_time = clock()-start |
|
234 | tot_time = clock()-start | |
235 | else: |
|
235 | else: | |
236 | rng = xrange(reps-1) # the last time is executed separately to store output |
|
236 | rng = xrange(reps-1) # the last time is executed separately to store output | |
237 | start = clock() |
|
237 | start = clock() | |
238 | for dummy in rng: func(*args,**kw) |
|
238 | for dummy in rng: func(*args,**kw) | |
239 | out = func(*args,**kw) # one last time |
|
239 | out = func(*args,**kw) # one last time | |
240 | tot_time = clock()-start |
|
240 | tot_time = clock()-start | |
241 | av_time = tot_time / reps |
|
241 | av_time = tot_time / reps | |
242 | return tot_time,av_time,out |
|
242 | return tot_time,av_time,out | |
243 |
|
243 | |||
244 | def timings(reps,func,*args,**kw): |
|
244 | def timings(reps,func,*args,**kw): | |
245 | """timings(reps,func,*args,**kw) -> (t_total,t_per_call) |
|
245 | """timings(reps,func,*args,**kw) -> (t_total,t_per_call) | |
246 |
|
246 | |||
247 | Execute a function reps times, return a tuple with the elapsed total CPU |
|
247 | Execute a function reps times, return a tuple with the elapsed total CPU | |
248 | time in seconds and the time per call. These are just the first two values |
|
248 | time in seconds and the time per call. These are just the first two values | |
249 | in timings_out().""" |
|
249 | in timings_out().""" | |
250 |
|
250 | |||
251 | return timings_out(reps,func,*args,**kw)[0:2] |
|
251 | return timings_out(reps,func,*args,**kw)[0:2] | |
252 |
|
252 | |||
253 | def timing(func,*args,**kw): |
|
253 | def timing(func,*args,**kw): | |
254 | """timing(func,*args,**kw) -> t_total |
|
254 | """timing(func,*args,**kw) -> t_total | |
255 |
|
255 | |||
256 | Execute a function once, return the elapsed total CPU time in |
|
256 | Execute a function once, return the elapsed total CPU time in | |
257 | seconds. This is just the first value in timings_out().""" |
|
257 | seconds. This is just the first value in timings_out().""" | |
258 |
|
258 | |||
259 | return timings_out(1,func,*args,**kw)[0] |
|
259 | return timings_out(1,func,*args,**kw)[0] | |
260 |
|
260 | |||
261 | #**************************************************************************** |
|
261 | #**************************************************************************** | |
262 | # file and system |
|
262 | # file and system | |
263 |
|
263 | |||
264 | def arg_split(s,posix=False): |
|
264 | def arg_split(s,posix=False): | |
265 | """Split a command line's arguments in a shell-like manner. |
|
265 | """Split a command line's arguments in a shell-like manner. | |
266 |
|
266 | |||
267 | This is a modified version of the standard library's shlex.split() |
|
267 | This is a modified version of the standard library's shlex.split() | |
268 | function, but with a default of posix=False for splitting, so that quotes |
|
268 | function, but with a default of posix=False for splitting, so that quotes | |
269 | in inputs are respected.""" |
|
269 | in inputs are respected.""" | |
270 |
|
270 | |||
271 | # XXX - there may be unicode-related problems here!!! I'm not sure that |
|
271 | # XXX - there may be unicode-related problems here!!! I'm not sure that | |
272 | # shlex is truly unicode-safe, so it might be necessary to do |
|
272 | # shlex is truly unicode-safe, so it might be necessary to do | |
273 | # |
|
273 | # | |
274 | # s = s.encode(sys.stdin.encoding) |
|
274 | # s = s.encode(sys.stdin.encoding) | |
275 | # |
|
275 | # | |
276 | # first, to ensure that shlex gets a normal string. Input from anyone who |
|
276 | # first, to ensure that shlex gets a normal string. Input from anyone who | |
277 | # knows more about unicode and shlex than I would be good to have here... |
|
277 | # knows more about unicode and shlex than I would be good to have here... | |
278 | lex = shlex.shlex(s, posix=posix) |
|
278 | lex = shlex.shlex(s, posix=posix) | |
279 | lex.whitespace_split = True |
|
279 | lex.whitespace_split = True | |
280 | return list(lex) |
|
280 | return list(lex) | |
281 |
|
281 | |||
282 | def system(cmd,verbose=0,debug=0,header=''): |
|
282 | def system(cmd,verbose=0,debug=0,header=''): | |
283 | """Execute a system command, return its exit status. |
|
283 | """Execute a system command, return its exit status. | |
284 |
|
284 | |||
285 | Options: |
|
285 | Options: | |
286 |
|
286 | |||
287 | - verbose (0): print the command to be executed. |
|
287 | - verbose (0): print the command to be executed. | |
288 |
|
288 | |||
289 | - debug (0): only print, do not actually execute. |
|
289 | - debug (0): only print, do not actually execute. | |
290 |
|
290 | |||
291 | - header (''): Header to print on screen prior to the executed command (it |
|
291 | - header (''): Header to print on screen prior to the executed command (it | |
292 | is only prepended to the command, no newlines are added). |
|
292 | is only prepended to the command, no newlines are added). | |
293 |
|
293 | |||
294 | Note: a stateful version of this function is available through the |
|
294 | Note: a stateful version of this function is available through the | |
295 | SystemExec class.""" |
|
295 | SystemExec class.""" | |
296 |
|
296 | |||
297 | stat = 0 |
|
297 | stat = 0 | |
298 | if verbose or debug: print header+cmd |
|
298 | if verbose or debug: print header+cmd | |
299 | sys.stdout.flush() |
|
299 | sys.stdout.flush() | |
300 | if not debug: stat = os.system(cmd) |
|
300 | if not debug: stat = os.system(cmd) | |
301 | return stat |
|
301 | return stat | |
302 |
|
302 | |||
|
303 | def abbrev_cwd(): | |||
|
304 | """ Return abbreviated version of cwd, e.g. d:mydir """ | |||
|
305 | cwd = os.getcwd() | |||
|
306 | drivepart = '' | |||
|
307 | if sys.platform == 'win32': | |||
|
308 | if len(cwd) < 4: | |||
|
309 | return cwd | |||
|
310 | drivepart = os.path.splitdrive(cwd)[0] | |||
|
311 | return (drivepart + ( | |||
|
312 | cwd == '/' and '/' or \ | |||
|
313 | os.path.basename(cwd))) | |||
|
314 | ||||
|
315 | ||||
303 | # This function is used by ipython in a lot of places to make system calls. |
|
316 | # This function is used by ipython in a lot of places to make system calls. | |
304 | # We need it to be slightly different under win32, due to the vagaries of |
|
317 | # We need it to be slightly different under win32, due to the vagaries of | |
305 | # 'network shares'. A win32 override is below. |
|
318 | # 'network shares'. A win32 override is below. | |
306 |
|
319 | |||
307 | def shell(cmd,verbose=0,debug=0,header=''): |
|
320 | def shell(cmd,verbose=0,debug=0,header=''): | |
308 | """Execute a command in the system shell, always return None. |
|
321 | """Execute a command in the system shell, always return None. | |
309 |
|
322 | |||
310 | Options: |
|
323 | Options: | |
311 |
|
324 | |||
312 | - verbose (0): print the command to be executed. |
|
325 | - verbose (0): print the command to be executed. | |
313 |
|
326 | |||
314 | - debug (0): only print, do not actually execute. |
|
327 | - debug (0): only print, do not actually execute. | |
315 |
|
328 | |||
316 | - header (''): Header to print on screen prior to the executed command (it |
|
329 | - header (''): Header to print on screen prior to the executed command (it | |
317 | is only prepended to the command, no newlines are added). |
|
330 | is only prepended to the command, no newlines are added). | |
318 |
|
331 | |||
319 | Note: this is similar to genutils.system(), but it returns None so it can |
|
332 | Note: this is similar to genutils.system(), but it returns None so it can | |
320 | be conveniently used in interactive loops without getting the return value |
|
333 | be conveniently used in interactive loops without getting the return value | |
321 | (typically 0) printed many times.""" |
|
334 | (typically 0) printed many times.""" | |
322 |
|
335 | |||
323 | stat = 0 |
|
336 | stat = 0 | |
324 | if verbose or debug: print header+cmd |
|
337 | if verbose or debug: print header+cmd | |
325 | # flush stdout so we don't mangle python's buffering |
|
338 | # flush stdout so we don't mangle python's buffering | |
326 | sys.stdout.flush() |
|
339 | sys.stdout.flush() | |
327 |
|
340 | |||
328 | if not debug: |
|
341 | if not debug: | |
329 |
platutils.set_term_title("IPy |
|
342 | platutils.set_term_title("IPy " + cmd) | |
330 | os.system(cmd) |
|
343 | os.system(cmd) | |
331 |
platutils.set_term_title("IPy |
|
344 | platutils.set_term_title("IPy " + abbrev_cwd()) | |
332 |
|
345 | |||
333 | # override shell() for win32 to deal with network shares |
|
346 | # override shell() for win32 to deal with network shares | |
334 | if os.name in ('nt','dos'): |
|
347 | if os.name in ('nt','dos'): | |
335 |
|
348 | |||
336 | shell_ori = shell |
|
349 | shell_ori = shell | |
337 |
|
350 | |||
338 | def shell(cmd,verbose=0,debug=0,header=''): |
|
351 | def shell(cmd,verbose=0,debug=0,header=''): | |
339 | if os.getcwd().startswith(r"\\"): |
|
352 | if os.getcwd().startswith(r"\\"): | |
340 | path = os.getcwd() |
|
353 | path = os.getcwd() | |
341 | # change to c drive (cannot be on UNC-share when issuing os.system, |
|
354 | # change to c drive (cannot be on UNC-share when issuing os.system, | |
342 | # as cmd.exe cannot handle UNC addresses) |
|
355 | # as cmd.exe cannot handle UNC addresses) | |
343 | os.chdir("c:") |
|
356 | os.chdir("c:") | |
344 | # issue pushd to the UNC-share and then run the command |
|
357 | # issue pushd to the UNC-share and then run the command | |
345 | try: |
|
358 | try: | |
346 | shell_ori('"pushd %s&&"'%path+cmd,verbose,debug,header) |
|
359 | shell_ori('"pushd %s&&"'%path+cmd,verbose,debug,header) | |
347 | finally: |
|
360 | finally: | |
348 | os.chdir(path) |
|
361 | os.chdir(path) | |
349 | else: |
|
362 | else: | |
350 | shell_ori(cmd,verbose,debug,header) |
|
363 | shell_ori(cmd,verbose,debug,header) | |
351 |
|
364 | |||
352 | shell.__doc__ = shell_ori.__doc__ |
|
365 | shell.__doc__ = shell_ori.__doc__ | |
353 |
|
366 | |||
354 | def getoutput(cmd,verbose=0,debug=0,header='',split=0): |
|
367 | def getoutput(cmd,verbose=0,debug=0,header='',split=0): | |
355 | """Dummy substitute for perl's backquotes. |
|
368 | """Dummy substitute for perl's backquotes. | |
356 |
|
369 | |||
357 | Executes a command and returns the output. |
|
370 | Executes a command and returns the output. | |
358 |
|
371 | |||
359 | Accepts the same arguments as system(), plus: |
|
372 | Accepts the same arguments as system(), plus: | |
360 |
|
373 | |||
361 | - split(0): if true, the output is returned as a list split on newlines. |
|
374 | - split(0): if true, the output is returned as a list split on newlines. | |
362 |
|
375 | |||
363 | Note: a stateful version of this function is available through the |
|
376 | Note: a stateful version of this function is available through the | |
364 | SystemExec class. |
|
377 | SystemExec class. | |
365 |
|
378 | |||
366 | This is pretty much deprecated and rarely used, |
|
379 | This is pretty much deprecated and rarely used, | |
367 | genutils.getoutputerror may be what you need. |
|
380 | genutils.getoutputerror may be what you need. | |
368 |
|
381 | |||
369 | """ |
|
382 | """ | |
370 |
|
383 | |||
371 | if verbose or debug: print header+cmd |
|
384 | if verbose or debug: print header+cmd | |
372 | if not debug: |
|
385 | if not debug: | |
373 | output = os.popen(cmd).read() |
|
386 | output = os.popen(cmd).read() | |
374 | # stipping last \n is here for backwards compat. |
|
387 | # stipping last \n is here for backwards compat. | |
375 | if output.endswith('\n'): |
|
388 | if output.endswith('\n'): | |
376 | output = output[:-1] |
|
389 | output = output[:-1] | |
377 | if split: |
|
390 | if split: | |
378 | return output.split('\n') |
|
391 | return output.split('\n') | |
379 | else: |
|
392 | else: | |
380 | return output |
|
393 | return output | |
381 |
|
394 | |||
382 | def getoutputerror(cmd,verbose=0,debug=0,header='',split=0): |
|
395 | def getoutputerror(cmd,verbose=0,debug=0,header='',split=0): | |
383 | """Return (standard output,standard error) of executing cmd in a shell. |
|
396 | """Return (standard output,standard error) of executing cmd in a shell. | |
384 |
|
397 | |||
385 | Accepts the same arguments as system(), plus: |
|
398 | Accepts the same arguments as system(), plus: | |
386 |
|
399 | |||
387 | - split(0): if true, each of stdout/err is returned as a list split on |
|
400 | - split(0): if true, each of stdout/err is returned as a list split on | |
388 | newlines. |
|
401 | newlines. | |
389 |
|
402 | |||
390 | Note: a stateful version of this function is available through the |
|
403 | Note: a stateful version of this function is available through the | |
391 | SystemExec class.""" |
|
404 | SystemExec class.""" | |
392 |
|
405 | |||
393 | if verbose or debug: print header+cmd |
|
406 | if verbose or debug: print header+cmd | |
394 | if not cmd: |
|
407 | if not cmd: | |
395 | if split: |
|
408 | if split: | |
396 | return [],[] |
|
409 | return [],[] | |
397 | else: |
|
410 | else: | |
398 | return '','' |
|
411 | return '','' | |
399 | if not debug: |
|
412 | if not debug: | |
400 | pin,pout,perr = os.popen3(cmd) |
|
413 | pin,pout,perr = os.popen3(cmd) | |
401 | tout = pout.read().rstrip() |
|
414 | tout = pout.read().rstrip() | |
402 | terr = perr.read().rstrip() |
|
415 | terr = perr.read().rstrip() | |
403 | pin.close() |
|
416 | pin.close() | |
404 | pout.close() |
|
417 | pout.close() | |
405 | perr.close() |
|
418 | perr.close() | |
406 | if split: |
|
419 | if split: | |
407 | return tout.split('\n'),terr.split('\n') |
|
420 | return tout.split('\n'),terr.split('\n') | |
408 | else: |
|
421 | else: | |
409 | return tout,terr |
|
422 | return tout,terr | |
410 |
|
423 | |||
411 | # for compatibility with older naming conventions |
|
424 | # for compatibility with older naming conventions | |
412 | xsys = system |
|
425 | xsys = system | |
413 | bq = getoutput |
|
426 | bq = getoutput | |
414 |
|
427 | |||
415 | class SystemExec: |
|
428 | class SystemExec: | |
416 | """Access the system and getoutput functions through a stateful interface. |
|
429 | """Access the system and getoutput functions through a stateful interface. | |
417 |
|
430 | |||
418 | Note: here we refer to the system and getoutput functions from this |
|
431 | Note: here we refer to the system and getoutput functions from this | |
419 | library, not the ones from the standard python library. |
|
432 | library, not the ones from the standard python library. | |
420 |
|
433 | |||
421 | This class offers the system and getoutput functions as methods, but the |
|
434 | This class offers the system and getoutput functions as methods, but the | |
422 | verbose, debug and header parameters can be set for the instance (at |
|
435 | verbose, debug and header parameters can be set for the instance (at | |
423 | creation time or later) so that they don't need to be specified on each |
|
436 | creation time or later) so that they don't need to be specified on each | |
424 | call. |
|
437 | call. | |
425 |
|
438 | |||
426 | For efficiency reasons, there's no way to override the parameters on a |
|
439 | For efficiency reasons, there's no way to override the parameters on a | |
427 | per-call basis other than by setting instance attributes. If you need |
|
440 | per-call basis other than by setting instance attributes. If you need | |
428 | local overrides, it's best to directly call system() or getoutput(). |
|
441 | local overrides, it's best to directly call system() or getoutput(). | |
429 |
|
442 | |||
430 | The following names are provided as alternate options: |
|
443 | The following names are provided as alternate options: | |
431 | - xsys: alias to system |
|
444 | - xsys: alias to system | |
432 | - bq: alias to getoutput |
|
445 | - bq: alias to getoutput | |
433 |
|
446 | |||
434 | An instance can then be created as: |
|
447 | An instance can then be created as: | |
435 | >>> sysexec = SystemExec(verbose=1,debug=0,header='Calling: ') |
|
448 | >>> sysexec = SystemExec(verbose=1,debug=0,header='Calling: ') | |
436 |
|
449 | |||
437 | And used as: |
|
450 | And used as: | |
438 | >>> sysexec.xsys('pwd') |
|
451 | >>> sysexec.xsys('pwd') | |
439 | >>> dirlist = sysexec.bq('ls -l') |
|
452 | >>> dirlist = sysexec.bq('ls -l') | |
440 | """ |
|
453 | """ | |
441 |
|
454 | |||
442 | def __init__(self,verbose=0,debug=0,header='',split=0): |
|
455 | def __init__(self,verbose=0,debug=0,header='',split=0): | |
443 | """Specify the instance's values for verbose, debug and header.""" |
|
456 | """Specify the instance's values for verbose, debug and header.""" | |
444 | setattr_list(self,'verbose debug header split') |
|
457 | setattr_list(self,'verbose debug header split') | |
445 |
|
458 | |||
446 | def system(self,cmd): |
|
459 | def system(self,cmd): | |
447 | """Stateful interface to system(), with the same keyword parameters.""" |
|
460 | """Stateful interface to system(), with the same keyword parameters.""" | |
448 |
|
461 | |||
449 | system(cmd,self.verbose,self.debug,self.header) |
|
462 | system(cmd,self.verbose,self.debug,self.header) | |
450 |
|
463 | |||
451 | def shell(self,cmd): |
|
464 | def shell(self,cmd): | |
452 | """Stateful interface to shell(), with the same keyword parameters.""" |
|
465 | """Stateful interface to shell(), with the same keyword parameters.""" | |
453 |
|
466 | |||
454 | shell(cmd,self.verbose,self.debug,self.header) |
|
467 | shell(cmd,self.verbose,self.debug,self.header) | |
455 |
|
468 | |||
456 | xsys = system # alias |
|
469 | xsys = system # alias | |
457 |
|
470 | |||
458 | def getoutput(self,cmd): |
|
471 | def getoutput(self,cmd): | |
459 | """Stateful interface to getoutput().""" |
|
472 | """Stateful interface to getoutput().""" | |
460 |
|
473 | |||
461 | return getoutput(cmd,self.verbose,self.debug,self.header,self.split) |
|
474 | return getoutput(cmd,self.verbose,self.debug,self.header,self.split) | |
462 |
|
475 | |||
463 | def getoutputerror(self,cmd): |
|
476 | def getoutputerror(self,cmd): | |
464 | """Stateful interface to getoutputerror().""" |
|
477 | """Stateful interface to getoutputerror().""" | |
465 |
|
478 | |||
466 | return getoutputerror(cmd,self.verbose,self.debug,self.header,self.split) |
|
479 | return getoutputerror(cmd,self.verbose,self.debug,self.header,self.split) | |
467 |
|
480 | |||
468 | bq = getoutput # alias |
|
481 | bq = getoutput # alias | |
469 |
|
482 | |||
470 | #----------------------------------------------------------------------------- |
|
483 | #----------------------------------------------------------------------------- | |
471 | def mutex_opts(dict,ex_op): |
|
484 | def mutex_opts(dict,ex_op): | |
472 | """Check for presence of mutually exclusive keys in a dict. |
|
485 | """Check for presence of mutually exclusive keys in a dict. | |
473 |
|
486 | |||
474 | Call: mutex_opts(dict,[[op1a,op1b],[op2a,op2b]...]""" |
|
487 | Call: mutex_opts(dict,[[op1a,op1b],[op2a,op2b]...]""" | |
475 | for op1,op2 in ex_op: |
|
488 | for op1,op2 in ex_op: | |
476 | if op1 in dict and op2 in dict: |
|
489 | if op1 in dict and op2 in dict: | |
477 | raise ValueError,'\n*** ERROR in Arguments *** '\ |
|
490 | raise ValueError,'\n*** ERROR in Arguments *** '\ | |
478 | 'Options '+op1+' and '+op2+' are mutually exclusive.' |
|
491 | 'Options '+op1+' and '+op2+' are mutually exclusive.' | |
479 |
|
492 | |||
480 | #----------------------------------------------------------------------------- |
|
493 | #----------------------------------------------------------------------------- | |
481 | def get_py_filename(name): |
|
494 | def get_py_filename(name): | |
482 | """Return a valid python filename in the current directory. |
|
495 | """Return a valid python filename in the current directory. | |
483 |
|
496 | |||
484 | If the given name is not a file, it adds '.py' and searches again. |
|
497 | If the given name is not a file, it adds '.py' and searches again. | |
485 | Raises IOError with an informative message if the file isn't found.""" |
|
498 | Raises IOError with an informative message if the file isn't found.""" | |
486 |
|
499 | |||
487 | name = os.path.expanduser(name) |
|
500 | name = os.path.expanduser(name) | |
488 | if not os.path.isfile(name) and not name.endswith('.py'): |
|
501 | if not os.path.isfile(name) and not name.endswith('.py'): | |
489 | name += '.py' |
|
502 | name += '.py' | |
490 | if os.path.isfile(name): |
|
503 | if os.path.isfile(name): | |
491 | return name |
|
504 | return name | |
492 | else: |
|
505 | else: | |
493 | raise IOError,'File `%s` not found.' % name |
|
506 | raise IOError,'File `%s` not found.' % name | |
494 |
|
507 | |||
495 | #----------------------------------------------------------------------------- |
|
508 | #----------------------------------------------------------------------------- | |
496 | def filefind(fname,alt_dirs = None): |
|
509 | def filefind(fname,alt_dirs = None): | |
497 | """Return the given filename either in the current directory, if it |
|
510 | """Return the given filename either in the current directory, if it | |
498 | exists, or in a specified list of directories. |
|
511 | exists, or in a specified list of directories. | |
499 |
|
512 | |||
500 | ~ expansion is done on all file and directory names. |
|
513 | ~ expansion is done on all file and directory names. | |
501 |
|
514 | |||
502 | Upon an unsuccessful search, raise an IOError exception.""" |
|
515 | Upon an unsuccessful search, raise an IOError exception.""" | |
503 |
|
516 | |||
504 | if alt_dirs is None: |
|
517 | if alt_dirs is None: | |
505 | try: |
|
518 | try: | |
506 | alt_dirs = get_home_dir() |
|
519 | alt_dirs = get_home_dir() | |
507 | except HomeDirError: |
|
520 | except HomeDirError: | |
508 | alt_dirs = os.getcwd() |
|
521 | alt_dirs = os.getcwd() | |
509 | search = [fname] + list_strings(alt_dirs) |
|
522 | search = [fname] + list_strings(alt_dirs) | |
510 | search = map(os.path.expanduser,search) |
|
523 | search = map(os.path.expanduser,search) | |
511 | #print 'search list for',fname,'list:',search # dbg |
|
524 | #print 'search list for',fname,'list:',search # dbg | |
512 | fname = search[0] |
|
525 | fname = search[0] | |
513 | if os.path.isfile(fname): |
|
526 | if os.path.isfile(fname): | |
514 | return fname |
|
527 | return fname | |
515 | for direc in search[1:]: |
|
528 | for direc in search[1:]: | |
516 | testname = os.path.join(direc,fname) |
|
529 | testname = os.path.join(direc,fname) | |
517 | #print 'testname',testname # dbg |
|
530 | #print 'testname',testname # dbg | |
518 | if os.path.isfile(testname): |
|
531 | if os.path.isfile(testname): | |
519 | return testname |
|
532 | return testname | |
520 | raise IOError,'File' + `fname` + \ |
|
533 | raise IOError,'File' + `fname` + \ | |
521 | ' not found in current or supplied directories:' + `alt_dirs` |
|
534 | ' not found in current or supplied directories:' + `alt_dirs` | |
522 |
|
535 | |||
523 | #---------------------------------------------------------------------------- |
|
536 | #---------------------------------------------------------------------------- | |
524 | def file_read(filename): |
|
537 | def file_read(filename): | |
525 | """Read a file and close it. Returns the file source.""" |
|
538 | """Read a file and close it. Returns the file source.""" | |
526 | fobj = open(filename,'r'); |
|
539 | fobj = open(filename,'r'); | |
527 | source = fobj.read(); |
|
540 | source = fobj.read(); | |
528 | fobj.close() |
|
541 | fobj.close() | |
529 | return source |
|
542 | return source | |
530 |
|
543 | |||
531 | def file_readlines(filename): |
|
544 | def file_readlines(filename): | |
532 | """Read a file and close it. Returns the file source using readlines().""" |
|
545 | """Read a file and close it. Returns the file source using readlines().""" | |
533 | fobj = open(filename,'r'); |
|
546 | fobj = open(filename,'r'); | |
534 | lines = fobj.readlines(); |
|
547 | lines = fobj.readlines(); | |
535 | fobj.close() |
|
548 | fobj.close() | |
536 | return lines |
|
549 | return lines | |
537 |
|
550 | |||
538 | #---------------------------------------------------------------------------- |
|
551 | #---------------------------------------------------------------------------- | |
539 | def target_outdated(target,deps): |
|
552 | def target_outdated(target,deps): | |
540 | """Determine whether a target is out of date. |
|
553 | """Determine whether a target is out of date. | |
541 |
|
554 | |||
542 | target_outdated(target,deps) -> 1/0 |
|
555 | target_outdated(target,deps) -> 1/0 | |
543 |
|
556 | |||
544 | deps: list of filenames which MUST exist. |
|
557 | deps: list of filenames which MUST exist. | |
545 | target: single filename which may or may not exist. |
|
558 | target: single filename which may or may not exist. | |
546 |
|
559 | |||
547 | If target doesn't exist or is older than any file listed in deps, return |
|
560 | If target doesn't exist or is older than any file listed in deps, return | |
548 | true, otherwise return false. |
|
561 | true, otherwise return false. | |
549 | """ |
|
562 | """ | |
550 | try: |
|
563 | try: | |
551 | target_time = os.path.getmtime(target) |
|
564 | target_time = os.path.getmtime(target) | |
552 | except os.error: |
|
565 | except os.error: | |
553 | return 1 |
|
566 | return 1 | |
554 | for dep in deps: |
|
567 | for dep in deps: | |
555 | dep_time = os.path.getmtime(dep) |
|
568 | dep_time = os.path.getmtime(dep) | |
556 | if dep_time > target_time: |
|
569 | if dep_time > target_time: | |
557 | #print "For target",target,"Dep failed:",dep # dbg |
|
570 | #print "For target",target,"Dep failed:",dep # dbg | |
558 | #print "times (dep,tar):",dep_time,target_time # dbg |
|
571 | #print "times (dep,tar):",dep_time,target_time # dbg | |
559 | return 1 |
|
572 | return 1 | |
560 | return 0 |
|
573 | return 0 | |
561 |
|
574 | |||
562 | #----------------------------------------------------------------------------- |
|
575 | #----------------------------------------------------------------------------- | |
563 | def target_update(target,deps,cmd): |
|
576 | def target_update(target,deps,cmd): | |
564 | """Update a target with a given command given a list of dependencies. |
|
577 | """Update a target with a given command given a list of dependencies. | |
565 |
|
578 | |||
566 | target_update(target,deps,cmd) -> runs cmd if target is outdated. |
|
579 | target_update(target,deps,cmd) -> runs cmd if target is outdated. | |
567 |
|
580 | |||
568 | This is just a wrapper around target_outdated() which calls the given |
|
581 | This is just a wrapper around target_outdated() which calls the given | |
569 | command if target is outdated.""" |
|
582 | command if target is outdated.""" | |
570 |
|
583 | |||
571 | if target_outdated(target,deps): |
|
584 | if target_outdated(target,deps): | |
572 | xsys(cmd) |
|
585 | xsys(cmd) | |
573 |
|
586 | |||
574 | #---------------------------------------------------------------------------- |
|
587 | #---------------------------------------------------------------------------- | |
575 | def unquote_ends(istr): |
|
588 | def unquote_ends(istr): | |
576 | """Remove a single pair of quotes from the endpoints of a string.""" |
|
589 | """Remove a single pair of quotes from the endpoints of a string.""" | |
577 |
|
590 | |||
578 | if not istr: |
|
591 | if not istr: | |
579 | return istr |
|
592 | return istr | |
580 | if (istr[0]=="'" and istr[-1]=="'") or \ |
|
593 | if (istr[0]=="'" and istr[-1]=="'") or \ | |
581 | (istr[0]=='"' and istr[-1]=='"'): |
|
594 | (istr[0]=='"' and istr[-1]=='"'): | |
582 | return istr[1:-1] |
|
595 | return istr[1:-1] | |
583 | else: |
|
596 | else: | |
584 | return istr |
|
597 | return istr | |
585 |
|
598 | |||
586 | #---------------------------------------------------------------------------- |
|
599 | #---------------------------------------------------------------------------- | |
587 | def process_cmdline(argv,names=[],defaults={},usage=''): |
|
600 | def process_cmdline(argv,names=[],defaults={},usage=''): | |
588 | """ Process command-line options and arguments. |
|
601 | """ Process command-line options and arguments. | |
589 |
|
602 | |||
590 | Arguments: |
|
603 | Arguments: | |
591 |
|
604 | |||
592 | - argv: list of arguments, typically sys.argv. |
|
605 | - argv: list of arguments, typically sys.argv. | |
593 |
|
606 | |||
594 | - names: list of option names. See DPyGetOpt docs for details on options |
|
607 | - names: list of option names. See DPyGetOpt docs for details on options | |
595 | syntax. |
|
608 | syntax. | |
596 |
|
609 | |||
597 | - defaults: dict of default values. |
|
610 | - defaults: dict of default values. | |
598 |
|
611 | |||
599 | - usage: optional usage notice to print if a wrong argument is passed. |
|
612 | - usage: optional usage notice to print if a wrong argument is passed. | |
600 |
|
613 | |||
601 | Return a dict of options and a list of free arguments.""" |
|
614 | Return a dict of options and a list of free arguments.""" | |
602 |
|
615 | |||
603 | getopt = DPyGetOpt.DPyGetOpt() |
|
616 | getopt = DPyGetOpt.DPyGetOpt() | |
604 | getopt.setIgnoreCase(0) |
|
617 | getopt.setIgnoreCase(0) | |
605 | getopt.parseConfiguration(names) |
|
618 | getopt.parseConfiguration(names) | |
606 |
|
619 | |||
607 | try: |
|
620 | try: | |
608 | getopt.processArguments(argv) |
|
621 | getopt.processArguments(argv) | |
609 | except: |
|
622 | except: | |
610 | print usage |
|
623 | print usage | |
611 | warn(`sys.exc_value`,level=4) |
|
624 | warn(`sys.exc_value`,level=4) | |
612 |
|
625 | |||
613 | defaults.update(getopt.optionValues) |
|
626 | defaults.update(getopt.optionValues) | |
614 | args = getopt.freeValues |
|
627 | args = getopt.freeValues | |
615 |
|
628 | |||
616 | return defaults,args |
|
629 | return defaults,args | |
617 |
|
630 | |||
618 | #---------------------------------------------------------------------------- |
|
631 | #---------------------------------------------------------------------------- | |
619 | def optstr2types(ostr): |
|
632 | def optstr2types(ostr): | |
620 | """Convert a string of option names to a dict of type mappings. |
|
633 | """Convert a string of option names to a dict of type mappings. | |
621 |
|
634 | |||
622 | optstr2types(str) -> {None:'string_opts',int:'int_opts',float:'float_opts'} |
|
635 | optstr2types(str) -> {None:'string_opts',int:'int_opts',float:'float_opts'} | |
623 |
|
636 | |||
624 | This is used to get the types of all the options in a string formatted |
|
637 | This is used to get the types of all the options in a string formatted | |
625 | with the conventions of DPyGetOpt. The 'type' None is used for options |
|
638 | with the conventions of DPyGetOpt. The 'type' None is used for options | |
626 | which are strings (they need no further conversion). This function's main |
|
639 | which are strings (they need no further conversion). This function's main | |
627 | use is to get a typemap for use with read_dict(). |
|
640 | use is to get a typemap for use with read_dict(). | |
628 | """ |
|
641 | """ | |
629 |
|
642 | |||
630 | typeconv = {None:'',int:'',float:''} |
|
643 | typeconv = {None:'',int:'',float:''} | |
631 | typemap = {'s':None,'i':int,'f':float} |
|
644 | typemap = {'s':None,'i':int,'f':float} | |
632 | opt_re = re.compile(r'([\w]*)([^:=]*:?=?)([sif]?)') |
|
645 | opt_re = re.compile(r'([\w]*)([^:=]*:?=?)([sif]?)') | |
633 |
|
646 | |||
634 | for w in ostr.split(): |
|
647 | for w in ostr.split(): | |
635 | oname,alias,otype = opt_re.match(w).groups() |
|
648 | oname,alias,otype = opt_re.match(w).groups() | |
636 | if otype == '' or alias == '!': # simple switches are integers too |
|
649 | if otype == '' or alias == '!': # simple switches are integers too | |
637 | otype = 'i' |
|
650 | otype = 'i' | |
638 | typeconv[typemap[otype]] += oname + ' ' |
|
651 | typeconv[typemap[otype]] += oname + ' ' | |
639 | return typeconv |
|
652 | return typeconv | |
640 |
|
653 | |||
641 | #---------------------------------------------------------------------------- |
|
654 | #---------------------------------------------------------------------------- | |
642 | def read_dict(filename,type_conv=None,**opt): |
|
655 | def read_dict(filename,type_conv=None,**opt): | |
643 |
|
656 | |||
644 | """Read a dictionary of key=value pairs from an input file, optionally |
|
657 | """Read a dictionary of key=value pairs from an input file, optionally | |
645 | performing conversions on the resulting values. |
|
658 | performing conversions on the resulting values. | |
646 |
|
659 | |||
647 | read_dict(filename,type_conv,**opt) -> dict |
|
660 | read_dict(filename,type_conv,**opt) -> dict | |
648 |
|
661 | |||
649 | Only one value per line is accepted, the format should be |
|
662 | Only one value per line is accepted, the format should be | |
650 | # optional comments are ignored |
|
663 | # optional comments are ignored | |
651 | key value\n |
|
664 | key value\n | |
652 |
|
665 | |||
653 | Args: |
|
666 | Args: | |
654 |
|
667 | |||
655 | - type_conv: A dictionary specifying which keys need to be converted to |
|
668 | - type_conv: A dictionary specifying which keys need to be converted to | |
656 | which types. By default all keys are read as strings. This dictionary |
|
669 | which types. By default all keys are read as strings. This dictionary | |
657 | should have as its keys valid conversion functions for strings |
|
670 | should have as its keys valid conversion functions for strings | |
658 | (int,long,float,complex, or your own). The value for each key |
|
671 | (int,long,float,complex, or your own). The value for each key | |
659 | (converter) should be a whitespace separated string containing the names |
|
672 | (converter) should be a whitespace separated string containing the names | |
660 | of all the entries in the file to be converted using that function. For |
|
673 | of all the entries in the file to be converted using that function. For | |
661 | keys to be left alone, use None as the conversion function (only needed |
|
674 | keys to be left alone, use None as the conversion function (only needed | |
662 | with purge=1, see below). |
|
675 | with purge=1, see below). | |
663 |
|
676 | |||
664 | - opt: dictionary with extra options as below (default in parens) |
|
677 | - opt: dictionary with extra options as below (default in parens) | |
665 |
|
678 | |||
666 | purge(0): if set to 1, all keys *not* listed in type_conv are purged out |
|
679 | purge(0): if set to 1, all keys *not* listed in type_conv are purged out | |
667 | of the dictionary to be returned. If purge is going to be used, the |
|
680 | of the dictionary to be returned. If purge is going to be used, the | |
668 | set of keys to be left as strings also has to be explicitly specified |
|
681 | set of keys to be left as strings also has to be explicitly specified | |
669 | using the (non-existent) conversion function None. |
|
682 | using the (non-existent) conversion function None. | |
670 |
|
683 | |||
671 | fs(None): field separator. This is the key/value separator to be used |
|
684 | fs(None): field separator. This is the key/value separator to be used | |
672 | when parsing the file. The None default means any whitespace [behavior |
|
685 | when parsing the file. The None default means any whitespace [behavior | |
673 | of string.split()]. |
|
686 | of string.split()]. | |
674 |
|
687 | |||
675 | strip(0): if 1, strip string values of leading/trailinig whitespace. |
|
688 | strip(0): if 1, strip string values of leading/trailinig whitespace. | |
676 |
|
689 | |||
677 | warn(1): warning level if requested keys are not found in file. |
|
690 | warn(1): warning level if requested keys are not found in file. | |
678 | - 0: silently ignore. |
|
691 | - 0: silently ignore. | |
679 | - 1: inform but proceed. |
|
692 | - 1: inform but proceed. | |
680 | - 2: raise KeyError exception. |
|
693 | - 2: raise KeyError exception. | |
681 |
|
694 | |||
682 | no_empty(0): if 1, remove keys with whitespace strings as a value. |
|
695 | no_empty(0): if 1, remove keys with whitespace strings as a value. | |
683 |
|
696 | |||
684 | unique([]): list of keys (or space separated string) which can't be |
|
697 | unique([]): list of keys (or space separated string) which can't be | |
685 | repeated. If one such key is found in the file, each new instance |
|
698 | repeated. If one such key is found in the file, each new instance | |
686 | overwrites the previous one. For keys not listed here, the behavior is |
|
699 | overwrites the previous one. For keys not listed here, the behavior is | |
687 | to make a list of all appearances. |
|
700 | to make a list of all appearances. | |
688 |
|
701 | |||
689 | Example: |
|
702 | Example: | |
690 | If the input file test.ini has: |
|
703 | If the input file test.ini has: | |
691 | i 3 |
|
704 | i 3 | |
692 | x 4.5 |
|
705 | x 4.5 | |
693 | y 5.5 |
|
706 | y 5.5 | |
694 | s hi ho |
|
707 | s hi ho | |
695 | Then: |
|
708 | Then: | |
696 |
|
709 | |||
697 | >>> type_conv={int:'i',float:'x',None:'s'} |
|
710 | >>> type_conv={int:'i',float:'x',None:'s'} | |
698 | >>> read_dict('test.ini') |
|
711 | >>> read_dict('test.ini') | |
699 | {'i': '3', 's': 'hi ho', 'x': '4.5', 'y': '5.5'} |
|
712 | {'i': '3', 's': 'hi ho', 'x': '4.5', 'y': '5.5'} | |
700 | >>> read_dict('test.ini',type_conv) |
|
713 | >>> read_dict('test.ini',type_conv) | |
701 | {'i': 3, 's': 'hi ho', 'x': 4.5, 'y': '5.5'} |
|
714 | {'i': 3, 's': 'hi ho', 'x': 4.5, 'y': '5.5'} | |
702 | >>> read_dict('test.ini',type_conv,purge=1) |
|
715 | >>> read_dict('test.ini',type_conv,purge=1) | |
703 | {'i': 3, 's': 'hi ho', 'x': 4.5} |
|
716 | {'i': 3, 's': 'hi ho', 'x': 4.5} | |
704 | """ |
|
717 | """ | |
705 |
|
718 | |||
706 | # starting config |
|
719 | # starting config | |
707 | opt.setdefault('purge',0) |
|
720 | opt.setdefault('purge',0) | |
708 | opt.setdefault('fs',None) # field sep defaults to any whitespace |
|
721 | opt.setdefault('fs',None) # field sep defaults to any whitespace | |
709 | opt.setdefault('strip',0) |
|
722 | opt.setdefault('strip',0) | |
710 | opt.setdefault('warn',1) |
|
723 | opt.setdefault('warn',1) | |
711 | opt.setdefault('no_empty',0) |
|
724 | opt.setdefault('no_empty',0) | |
712 | opt.setdefault('unique','') |
|
725 | opt.setdefault('unique','') | |
713 | if type(opt['unique']) in StringTypes: |
|
726 | if type(opt['unique']) in StringTypes: | |
714 | unique_keys = qw(opt['unique']) |
|
727 | unique_keys = qw(opt['unique']) | |
715 | elif type(opt['unique']) in (types.TupleType,types.ListType): |
|
728 | elif type(opt['unique']) in (types.TupleType,types.ListType): | |
716 | unique_keys = opt['unique'] |
|
729 | unique_keys = opt['unique'] | |
717 | else: |
|
730 | else: | |
718 | raise ValueError, 'Unique keys must be given as a string, List or Tuple' |
|
731 | raise ValueError, 'Unique keys must be given as a string, List or Tuple' | |
719 |
|
732 | |||
720 | dict = {} |
|
733 | dict = {} | |
721 | # first read in table of values as strings |
|
734 | # first read in table of values as strings | |
722 | file = open(filename,'r') |
|
735 | file = open(filename,'r') | |
723 | for line in file.readlines(): |
|
736 | for line in file.readlines(): | |
724 | line = line.strip() |
|
737 | line = line.strip() | |
725 | if len(line) and line[0]=='#': continue |
|
738 | if len(line) and line[0]=='#': continue | |
726 | if len(line)>0: |
|
739 | if len(line)>0: | |
727 | lsplit = line.split(opt['fs'],1) |
|
740 | lsplit = line.split(opt['fs'],1) | |
728 | try: |
|
741 | try: | |
729 | key,val = lsplit |
|
742 | key,val = lsplit | |
730 | except ValueError: |
|
743 | except ValueError: | |
731 | key,val = lsplit[0],'' |
|
744 | key,val = lsplit[0],'' | |
732 | key = key.strip() |
|
745 | key = key.strip() | |
733 | if opt['strip']: val = val.strip() |
|
746 | if opt['strip']: val = val.strip() | |
734 | if val == "''" or val == '""': val = '' |
|
747 | if val == "''" or val == '""': val = '' | |
735 | if opt['no_empty'] and (val=='' or val.isspace()): |
|
748 | if opt['no_empty'] and (val=='' or val.isspace()): | |
736 | continue |
|
749 | continue | |
737 | # if a key is found more than once in the file, build a list |
|
750 | # if a key is found more than once in the file, build a list | |
738 | # unless it's in the 'unique' list. In that case, last found in file |
|
751 | # unless it's in the 'unique' list. In that case, last found in file | |
739 | # takes precedence. User beware. |
|
752 | # takes precedence. User beware. | |
740 | try: |
|
753 | try: | |
741 | if dict[key] and key in unique_keys: |
|
754 | if dict[key] and key in unique_keys: | |
742 | dict[key] = val |
|
755 | dict[key] = val | |
743 | elif type(dict[key]) is types.ListType: |
|
756 | elif type(dict[key]) is types.ListType: | |
744 | dict[key].append(val) |
|
757 | dict[key].append(val) | |
745 | else: |
|
758 | else: | |
746 | dict[key] = [dict[key],val] |
|
759 | dict[key] = [dict[key],val] | |
747 | except KeyError: |
|
760 | except KeyError: | |
748 | dict[key] = val |
|
761 | dict[key] = val | |
749 | # purge if requested |
|
762 | # purge if requested | |
750 | if opt['purge']: |
|
763 | if opt['purge']: | |
751 | accepted_keys = qwflat(type_conv.values()) |
|
764 | accepted_keys = qwflat(type_conv.values()) | |
752 | for key in dict.keys(): |
|
765 | for key in dict.keys(): | |
753 | if key in accepted_keys: continue |
|
766 | if key in accepted_keys: continue | |
754 | del(dict[key]) |
|
767 | del(dict[key]) | |
755 | # now convert if requested |
|
768 | # now convert if requested | |
756 | if type_conv==None: return dict |
|
769 | if type_conv==None: return dict | |
757 | conversions = type_conv.keys() |
|
770 | conversions = type_conv.keys() | |
758 | try: conversions.remove(None) |
|
771 | try: conversions.remove(None) | |
759 | except: pass |
|
772 | except: pass | |
760 | for convert in conversions: |
|
773 | for convert in conversions: | |
761 | for val in qw(type_conv[convert]): |
|
774 | for val in qw(type_conv[convert]): | |
762 | try: |
|
775 | try: | |
763 | dict[val] = convert(dict[val]) |
|
776 | dict[val] = convert(dict[val]) | |
764 | except KeyError,e: |
|
777 | except KeyError,e: | |
765 | if opt['warn'] == 0: |
|
778 | if opt['warn'] == 0: | |
766 | pass |
|
779 | pass | |
767 | elif opt['warn'] == 1: |
|
780 | elif opt['warn'] == 1: | |
768 | print >>sys.stderr, 'Warning: key',val,\ |
|
781 | print >>sys.stderr, 'Warning: key',val,\ | |
769 | 'not found in file',filename |
|
782 | 'not found in file',filename | |
770 | elif opt['warn'] == 2: |
|
783 | elif opt['warn'] == 2: | |
771 | raise KeyError,e |
|
784 | raise KeyError,e | |
772 | else: |
|
785 | else: | |
773 | raise ValueError,'Warning level must be 0,1 or 2' |
|
786 | raise ValueError,'Warning level must be 0,1 or 2' | |
774 |
|
787 | |||
775 | return dict |
|
788 | return dict | |
776 |
|
789 | |||
777 | #---------------------------------------------------------------------------- |
|
790 | #---------------------------------------------------------------------------- | |
778 | def flag_calls(func): |
|
791 | def flag_calls(func): | |
779 | """Wrap a function to detect and flag when it gets called. |
|
792 | """Wrap a function to detect and flag when it gets called. | |
780 |
|
793 | |||
781 | This is a decorator which takes a function and wraps it in a function with |
|
794 | This is a decorator which takes a function and wraps it in a function with | |
782 | a 'called' attribute. wrapper.called is initialized to False. |
|
795 | a 'called' attribute. wrapper.called is initialized to False. | |
783 |
|
796 | |||
784 | The wrapper.called attribute is set to False right before each call to the |
|
797 | The wrapper.called attribute is set to False right before each call to the | |
785 | wrapped function, so if the call fails it remains False. After the call |
|
798 | wrapped function, so if the call fails it remains False. After the call | |
786 | completes, wrapper.called is set to True and the output is returned. |
|
799 | completes, wrapper.called is set to True and the output is returned. | |
787 |
|
800 | |||
788 | Testing for truth in wrapper.called allows you to determine if a call to |
|
801 | Testing for truth in wrapper.called allows you to determine if a call to | |
789 | func() was attempted and succeeded.""" |
|
802 | func() was attempted and succeeded.""" | |
790 |
|
803 | |||
791 | def wrapper(*args,**kw): |
|
804 | def wrapper(*args,**kw): | |
792 | wrapper.called = False |
|
805 | wrapper.called = False | |
793 | out = func(*args,**kw) |
|
806 | out = func(*args,**kw) | |
794 | wrapper.called = True |
|
807 | wrapper.called = True | |
795 | return out |
|
808 | return out | |
796 |
|
809 | |||
797 | wrapper.called = False |
|
810 | wrapper.called = False | |
798 | wrapper.__doc__ = func.__doc__ |
|
811 | wrapper.__doc__ = func.__doc__ | |
799 | return wrapper |
|
812 | return wrapper | |
800 |
|
813 | |||
801 | #---------------------------------------------------------------------------- |
|
814 | #---------------------------------------------------------------------------- | |
802 | def dhook_wrap(func,*a,**k): |
|
815 | def dhook_wrap(func,*a,**k): | |
803 | """Wrap a function call in a sys.displayhook controller. |
|
816 | """Wrap a function call in a sys.displayhook controller. | |
804 |
|
817 | |||
805 | Returns a wrapper around func which calls func, with all its arguments and |
|
818 | Returns a wrapper around func which calls func, with all its arguments and | |
806 | keywords unmodified, using the default sys.displayhook. Since IPython |
|
819 | keywords unmodified, using the default sys.displayhook. Since IPython | |
807 | modifies sys.displayhook, it breaks the behavior of certain systems that |
|
820 | modifies sys.displayhook, it breaks the behavior of certain systems that | |
808 | rely on the default behavior, notably doctest. |
|
821 | rely on the default behavior, notably doctest. | |
809 | """ |
|
822 | """ | |
810 |
|
823 | |||
811 | def f(*a,**k): |
|
824 | def f(*a,**k): | |
812 |
|
825 | |||
813 | dhook_s = sys.displayhook |
|
826 | dhook_s = sys.displayhook | |
814 | sys.displayhook = sys.__displayhook__ |
|
827 | sys.displayhook = sys.__displayhook__ | |
815 | try: |
|
828 | try: | |
816 | out = func(*a,**k) |
|
829 | out = func(*a,**k) | |
817 | finally: |
|
830 | finally: | |
818 | sys.displayhook = dhook_s |
|
831 | sys.displayhook = dhook_s | |
819 |
|
832 | |||
820 | return out |
|
833 | return out | |
821 |
|
834 | |||
822 | f.__doc__ = func.__doc__ |
|
835 | f.__doc__ = func.__doc__ | |
823 | return f |
|
836 | return f | |
824 |
|
837 | |||
825 | #---------------------------------------------------------------------------- |
|
838 | #---------------------------------------------------------------------------- | |
826 | class HomeDirError(Error): |
|
839 | class HomeDirError(Error): | |
827 | pass |
|
840 | pass | |
828 |
|
841 | |||
829 | def get_home_dir(): |
|
842 | def get_home_dir(): | |
830 | """Return the closest possible equivalent to a 'home' directory. |
|
843 | """Return the closest possible equivalent to a 'home' directory. | |
831 |
|
844 | |||
832 | We first try $HOME. Absent that, on NT it's $HOMEDRIVE\$HOMEPATH. |
|
845 | We first try $HOME. Absent that, on NT it's $HOMEDRIVE\$HOMEPATH. | |
833 |
|
846 | |||
834 | Currently only Posix and NT are implemented, a HomeDirError exception is |
|
847 | Currently only Posix and NT are implemented, a HomeDirError exception is | |
835 | raised for all other OSes. """ |
|
848 | raised for all other OSes. """ | |
836 |
|
849 | |||
837 | isdir = os.path.isdir |
|
850 | isdir = os.path.isdir | |
838 | env = os.environ |
|
851 | env = os.environ | |
839 |
|
852 | |||
840 | # first, check py2exe distribution root directory for _ipython. |
|
853 | # first, check py2exe distribution root directory for _ipython. | |
841 | # This overrides all. Normally does not exist. |
|
854 | # This overrides all. Normally does not exist. | |
842 |
|
855 | |||
843 | if '\\library.zip\\' in IPython.__file__.lower(): |
|
856 | if '\\library.zip\\' in IPython.__file__.lower(): | |
844 | root, rest = IPython.__file__.lower().split('library.zip') |
|
857 | root, rest = IPython.__file__.lower().split('library.zip') | |
845 | if isdir(root + '_ipython'): |
|
858 | if isdir(root + '_ipython'): | |
846 | os.environ["IPYKITROOT"] = root.rstrip('\\') |
|
859 | os.environ["IPYKITROOT"] = root.rstrip('\\') | |
847 | return root |
|
860 | return root | |
848 |
|
861 | |||
849 | try: |
|
862 | try: | |
850 | homedir = env['HOME'] |
|
863 | homedir = env['HOME'] | |
851 | if not isdir(homedir): |
|
864 | if not isdir(homedir): | |
852 | # in case a user stuck some string which does NOT resolve to a |
|
865 | # in case a user stuck some string which does NOT resolve to a | |
853 | # valid path, it's as good as if we hadn't foud it |
|
866 | # valid path, it's as good as if we hadn't foud it | |
854 | raise KeyError |
|
867 | raise KeyError | |
855 | return homedir |
|
868 | return homedir | |
856 | except KeyError: |
|
869 | except KeyError: | |
857 | if os.name == 'posix': |
|
870 | if os.name == 'posix': | |
858 | raise HomeDirError,'undefined $HOME, IPython can not proceed.' |
|
871 | raise HomeDirError,'undefined $HOME, IPython can not proceed.' | |
859 | elif os.name == 'nt': |
|
872 | elif os.name == 'nt': | |
860 | # For some strange reason, win9x returns 'nt' for os.name. |
|
873 | # For some strange reason, win9x returns 'nt' for os.name. | |
861 | try: |
|
874 | try: | |
862 | homedir = os.path.join(env['HOMEDRIVE'],env['HOMEPATH']) |
|
875 | homedir = os.path.join(env['HOMEDRIVE'],env['HOMEPATH']) | |
863 | if not isdir(homedir): |
|
876 | if not isdir(homedir): | |
864 | homedir = os.path.join(env['USERPROFILE']) |
|
877 | homedir = os.path.join(env['USERPROFILE']) | |
865 | if not isdir(homedir): |
|
878 | if not isdir(homedir): | |
866 | raise HomeDirError |
|
879 | raise HomeDirError | |
867 | return homedir |
|
880 | return homedir | |
868 | except: |
|
881 | except: | |
869 | try: |
|
882 | try: | |
870 | # Use the registry to get the 'My Documents' folder. |
|
883 | # Use the registry to get the 'My Documents' folder. | |
871 | import _winreg as wreg |
|
884 | import _winreg as wreg | |
872 | key = wreg.OpenKey(wreg.HKEY_CURRENT_USER, |
|
885 | key = wreg.OpenKey(wreg.HKEY_CURRENT_USER, | |
873 | "Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders") |
|
886 | "Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders") | |
874 | homedir = wreg.QueryValueEx(key,'Personal')[0] |
|
887 | homedir = wreg.QueryValueEx(key,'Personal')[0] | |
875 | key.Close() |
|
888 | key.Close() | |
876 | if not isdir(homedir): |
|
889 | if not isdir(homedir): | |
877 | e = ('Invalid "Personal" folder registry key ' |
|
890 | e = ('Invalid "Personal" folder registry key ' | |
878 | 'typically "My Documents".\n' |
|
891 | 'typically "My Documents".\n' | |
879 | 'Value: %s\n' |
|
892 | 'Value: %s\n' | |
880 | 'This is not a valid directory on your system.' % |
|
893 | 'This is not a valid directory on your system.' % | |
881 | homedir) |
|
894 | homedir) | |
882 | raise HomeDirError(e) |
|
895 | raise HomeDirError(e) | |
883 | return homedir |
|
896 | return homedir | |
884 | except HomeDirError: |
|
897 | except HomeDirError: | |
885 | raise |
|
898 | raise | |
886 | except: |
|
899 | except: | |
887 | return 'C:\\' |
|
900 | return 'C:\\' | |
888 | elif os.name == 'dos': |
|
901 | elif os.name == 'dos': | |
889 | # Desperate, may do absurd things in classic MacOS. May work under DOS. |
|
902 | # Desperate, may do absurd things in classic MacOS. May work under DOS. | |
890 | return 'C:\\' |
|
903 | return 'C:\\' | |
891 | else: |
|
904 | else: | |
892 | raise HomeDirError,'support for your operating system not implemented.' |
|
905 | raise HomeDirError,'support for your operating system not implemented.' | |
893 |
|
906 | |||
894 | #**************************************************************************** |
|
907 | #**************************************************************************** | |
895 | # strings and text |
|
908 | # strings and text | |
896 |
|
909 | |||
897 | class LSString(str): |
|
910 | class LSString(str): | |
898 | """String derivative with a special access attributes. |
|
911 | """String derivative with a special access attributes. | |
899 |
|
912 | |||
900 | These are normal strings, but with the special attributes: |
|
913 | These are normal strings, but with the special attributes: | |
901 |
|
914 | |||
902 | .l (or .list) : value as list (split on newlines). |
|
915 | .l (or .list) : value as list (split on newlines). | |
903 | .n (or .nlstr): original value (the string itself). |
|
916 | .n (or .nlstr): original value (the string itself). | |
904 | .s (or .spstr): value as whitespace-separated string. |
|
917 | .s (or .spstr): value as whitespace-separated string. | |
905 | .p (or .paths): list of path objects |
|
918 | .p (or .paths): list of path objects | |
906 |
|
919 | |||
907 | Any values which require transformations are computed only once and |
|
920 | Any values which require transformations are computed only once and | |
908 | cached. |
|
921 | cached. | |
909 |
|
922 | |||
910 | Such strings are very useful to efficiently interact with the shell, which |
|
923 | Such strings are very useful to efficiently interact with the shell, which | |
911 | typically only understands whitespace-separated options for commands.""" |
|
924 | typically only understands whitespace-separated options for commands.""" | |
912 |
|
925 | |||
913 | def get_list(self): |
|
926 | def get_list(self): | |
914 | try: |
|
927 | try: | |
915 | return self.__list |
|
928 | return self.__list | |
916 | except AttributeError: |
|
929 | except AttributeError: | |
917 | self.__list = self.split('\n') |
|
930 | self.__list = self.split('\n') | |
918 | return self.__list |
|
931 | return self.__list | |
919 |
|
932 | |||
920 | l = list = property(get_list) |
|
933 | l = list = property(get_list) | |
921 |
|
934 | |||
922 | def get_spstr(self): |
|
935 | def get_spstr(self): | |
923 | try: |
|
936 | try: | |
924 | return self.__spstr |
|
937 | return self.__spstr | |
925 | except AttributeError: |
|
938 | except AttributeError: | |
926 | self.__spstr = self.replace('\n',' ') |
|
939 | self.__spstr = self.replace('\n',' ') | |
927 | return self.__spstr |
|
940 | return self.__spstr | |
928 |
|
941 | |||
929 | s = spstr = property(get_spstr) |
|
942 | s = spstr = property(get_spstr) | |
930 |
|
943 | |||
931 | def get_nlstr(self): |
|
944 | def get_nlstr(self): | |
932 | return self |
|
945 | return self | |
933 |
|
946 | |||
934 | n = nlstr = property(get_nlstr) |
|
947 | n = nlstr = property(get_nlstr) | |
935 |
|
948 | |||
936 | def get_paths(self): |
|
949 | def get_paths(self): | |
937 | try: |
|
950 | try: | |
938 | return self.__paths |
|
951 | return self.__paths | |
939 | except AttributeError: |
|
952 | except AttributeError: | |
940 | self.__paths = [path(p) for p in self.split('\n') if os.path.exists(p)] |
|
953 | self.__paths = [path(p) for p in self.split('\n') if os.path.exists(p)] | |
941 | return self.__paths |
|
954 | return self.__paths | |
942 |
|
955 | |||
943 | p = paths = property(get_paths) |
|
956 | p = paths = property(get_paths) | |
944 |
|
957 | |||
945 | def print_lsstring(arg): |
|
958 | def print_lsstring(arg): | |
946 | """ Prettier (non-repr-like) and more informative printer for LSString """ |
|
959 | """ Prettier (non-repr-like) and more informative printer for LSString """ | |
947 | print "LSString (.p, .n, .l, .s available). Value:" |
|
960 | print "LSString (.p, .n, .l, .s available). Value:" | |
948 | print arg |
|
961 | print arg | |
949 |
|
962 | |||
950 | print_lsstring = result_display.when_type(LSString)(print_lsstring) |
|
963 | print_lsstring = result_display.when_type(LSString)(print_lsstring) | |
951 |
|
964 | |||
952 | #---------------------------------------------------------------------------- |
|
965 | #---------------------------------------------------------------------------- | |
953 | class SList(list): |
|
966 | class SList(list): | |
954 | """List derivative with a special access attributes. |
|
967 | """List derivative with a special access attributes. | |
955 |
|
968 | |||
956 | These are normal lists, but with the special attributes: |
|
969 | These are normal lists, but with the special attributes: | |
957 |
|
970 | |||
958 | .l (or .list) : value as list (the list itself). |
|
971 | .l (or .list) : value as list (the list itself). | |
959 | .n (or .nlstr): value as a string, joined on newlines. |
|
972 | .n (or .nlstr): value as a string, joined on newlines. | |
960 | .s (or .spstr): value as a string, joined on spaces. |
|
973 | .s (or .spstr): value as a string, joined on spaces. | |
961 | .p (or .paths): list of path objects |
|
974 | .p (or .paths): list of path objects | |
962 |
|
975 | |||
963 | Any values which require transformations are computed only once and |
|
976 | Any values which require transformations are computed only once and | |
964 | cached.""" |
|
977 | cached.""" | |
965 |
|
978 | |||
966 | def get_list(self): |
|
979 | def get_list(self): | |
967 | return self |
|
980 | return self | |
968 |
|
981 | |||
969 | l = list = property(get_list) |
|
982 | l = list = property(get_list) | |
970 |
|
983 | |||
971 | def get_spstr(self): |
|
984 | def get_spstr(self): | |
972 | try: |
|
985 | try: | |
973 | return self.__spstr |
|
986 | return self.__spstr | |
974 | except AttributeError: |
|
987 | except AttributeError: | |
975 | self.__spstr = ' '.join(self) |
|
988 | self.__spstr = ' '.join(self) | |
976 | return self.__spstr |
|
989 | return self.__spstr | |
977 |
|
990 | |||
978 | s = spstr = property(get_spstr) |
|
991 | s = spstr = property(get_spstr) | |
979 |
|
992 | |||
980 | def get_nlstr(self): |
|
993 | def get_nlstr(self): | |
981 | try: |
|
994 | try: | |
982 | return self.__nlstr |
|
995 | return self.__nlstr | |
983 | except AttributeError: |
|
996 | except AttributeError: | |
984 | self.__nlstr = '\n'.join(self) |
|
997 | self.__nlstr = '\n'.join(self) | |
985 | return self.__nlstr |
|
998 | return self.__nlstr | |
986 |
|
999 | |||
987 | n = nlstr = property(get_nlstr) |
|
1000 | n = nlstr = property(get_nlstr) | |
988 |
|
1001 | |||
989 | def get_paths(self): |
|
1002 | def get_paths(self): | |
990 | try: |
|
1003 | try: | |
991 | return self.__paths |
|
1004 | return self.__paths | |
992 | except AttributeError: |
|
1005 | except AttributeError: | |
993 | self.__paths = [path(p) for p in self if os.path.exists(p)] |
|
1006 | self.__paths = [path(p) for p in self if os.path.exists(p)] | |
994 | return self.__paths |
|
1007 | return self.__paths | |
995 |
|
1008 | |||
996 | p = paths = property(get_paths) |
|
1009 | p = paths = property(get_paths) | |
997 |
|
1010 | |||
998 | #---------------------------------------------------------------------------- |
|
1011 | #---------------------------------------------------------------------------- | |
999 | def esc_quotes(strng): |
|
1012 | def esc_quotes(strng): | |
1000 | """Return the input string with single and double quotes escaped out""" |
|
1013 | """Return the input string with single and double quotes escaped out""" | |
1001 |
|
1014 | |||
1002 | return strng.replace('"','\\"').replace("'","\\'") |
|
1015 | return strng.replace('"','\\"').replace("'","\\'") | |
1003 |
|
1016 | |||
1004 | #---------------------------------------------------------------------------- |
|
1017 | #---------------------------------------------------------------------------- | |
1005 | def make_quoted_expr(s): |
|
1018 | def make_quoted_expr(s): | |
1006 | """Return string s in appropriate quotes, using raw string if possible. |
|
1019 | """Return string s in appropriate quotes, using raw string if possible. | |
1007 |
|
1020 | |||
1008 | Effectively this turns string: cd \ao\ao\ |
|
1021 | Effectively this turns string: cd \ao\ao\ | |
1009 | to: r"cd \ao\ao\_"[:-1] |
|
1022 | to: r"cd \ao\ao\_"[:-1] | |
1010 |
|
1023 | |||
1011 | Note the use of raw string and padding at the end to allow trailing backslash. |
|
1024 | Note the use of raw string and padding at the end to allow trailing backslash. | |
1012 |
|
1025 | |||
1013 | """ |
|
1026 | """ | |
1014 |
|
1027 | |||
1015 | tail = '' |
|
1028 | tail = '' | |
1016 | tailpadding = '' |
|
1029 | tailpadding = '' | |
1017 | raw = '' |
|
1030 | raw = '' | |
1018 | if "\\" in s: |
|
1031 | if "\\" in s: | |
1019 | raw = 'r' |
|
1032 | raw = 'r' | |
1020 | if s.endswith('\\'): |
|
1033 | if s.endswith('\\'): | |
1021 | tail = '[:-1]' |
|
1034 | tail = '[:-1]' | |
1022 | tailpadding = '_' |
|
1035 | tailpadding = '_' | |
1023 | if '"' not in s: |
|
1036 | if '"' not in s: | |
1024 | quote = '"' |
|
1037 | quote = '"' | |
1025 | elif "'" not in s: |
|
1038 | elif "'" not in s: | |
1026 | quote = "'" |
|
1039 | quote = "'" | |
1027 | elif '"""' not in s and not s.endswith('"'): |
|
1040 | elif '"""' not in s and not s.endswith('"'): | |
1028 | quote = '"""' |
|
1041 | quote = '"""' | |
1029 | elif "'''" not in s and not s.endswith("'"): |
|
1042 | elif "'''" not in s and not s.endswith("'"): | |
1030 | quote = "'''" |
|
1043 | quote = "'''" | |
1031 | else: |
|
1044 | else: | |
1032 | # give up, backslash-escaped string will do |
|
1045 | # give up, backslash-escaped string will do | |
1033 | return '"%s"' % esc_quotes(s) |
|
1046 | return '"%s"' % esc_quotes(s) | |
1034 | res = itpl("$raw$quote$s$tailpadding$quote$tail") |
|
1047 | res = itpl("$raw$quote$s$tailpadding$quote$tail") | |
1035 | return res |
|
1048 | return res | |
1036 |
|
1049 | |||
1037 |
|
1050 | |||
1038 | #---------------------------------------------------------------------------- |
|
1051 | #---------------------------------------------------------------------------- | |
1039 | def raw_input_multi(header='', ps1='==> ', ps2='..> ',terminate_str = '.'): |
|
1052 | def raw_input_multi(header='', ps1='==> ', ps2='..> ',terminate_str = '.'): | |
1040 | """Take multiple lines of input. |
|
1053 | """Take multiple lines of input. | |
1041 |
|
1054 | |||
1042 | A list with each line of input as a separate element is returned when a |
|
1055 | A list with each line of input as a separate element is returned when a | |
1043 | termination string is entered (defaults to a single '.'). Input can also |
|
1056 | termination string is entered (defaults to a single '.'). Input can also | |
1044 | terminate via EOF (^D in Unix, ^Z-RET in Windows). |
|
1057 | terminate via EOF (^D in Unix, ^Z-RET in Windows). | |
1045 |
|
1058 | |||
1046 | Lines of input which end in \\ are joined into single entries (and a |
|
1059 | Lines of input which end in \\ are joined into single entries (and a | |
1047 | secondary continuation prompt is issued as long as the user terminates |
|
1060 | secondary continuation prompt is issued as long as the user terminates | |
1048 | lines with \\). This allows entering very long strings which are still |
|
1061 | lines with \\). This allows entering very long strings which are still | |
1049 | meant to be treated as single entities. |
|
1062 | meant to be treated as single entities. | |
1050 | """ |
|
1063 | """ | |
1051 |
|
1064 | |||
1052 | try: |
|
1065 | try: | |
1053 | if header: |
|
1066 | if header: | |
1054 | header += '\n' |
|
1067 | header += '\n' | |
1055 | lines = [raw_input(header + ps1)] |
|
1068 | lines = [raw_input(header + ps1)] | |
1056 | except EOFError: |
|
1069 | except EOFError: | |
1057 | return [] |
|
1070 | return [] | |
1058 | terminate = [terminate_str] |
|
1071 | terminate = [terminate_str] | |
1059 | try: |
|
1072 | try: | |
1060 | while lines[-1:] != terminate: |
|
1073 | while lines[-1:] != terminate: | |
1061 | new_line = raw_input(ps1) |
|
1074 | new_line = raw_input(ps1) | |
1062 | while new_line.endswith('\\'): |
|
1075 | while new_line.endswith('\\'): | |
1063 | new_line = new_line[:-1] + raw_input(ps2) |
|
1076 | new_line = new_line[:-1] + raw_input(ps2) | |
1064 | lines.append(new_line) |
|
1077 | lines.append(new_line) | |
1065 |
|
1078 | |||
1066 | return lines[:-1] # don't return the termination command |
|
1079 | return lines[:-1] # don't return the termination command | |
1067 | except EOFError: |
|
1080 | except EOFError: | |
1068 |
|
1081 | |||
1069 | return lines |
|
1082 | return lines | |
1070 |
|
1083 | |||
1071 | #---------------------------------------------------------------------------- |
|
1084 | #---------------------------------------------------------------------------- | |
1072 | def raw_input_ext(prompt='', ps2='... '): |
|
1085 | def raw_input_ext(prompt='', ps2='... '): | |
1073 | """Similar to raw_input(), but accepts extended lines if input ends with \\.""" |
|
1086 | """Similar to raw_input(), but accepts extended lines if input ends with \\.""" | |
1074 |
|
1087 | |||
1075 | line = raw_input(prompt) |
|
1088 | line = raw_input(prompt) | |
1076 | while line.endswith('\\'): |
|
1089 | while line.endswith('\\'): | |
1077 | line = line[:-1] + raw_input(ps2) |
|
1090 | line = line[:-1] + raw_input(ps2) | |
1078 | return line |
|
1091 | return line | |
1079 |
|
1092 | |||
1080 | #---------------------------------------------------------------------------- |
|
1093 | #---------------------------------------------------------------------------- | |
1081 | def ask_yes_no(prompt,default=None): |
|
1094 | def ask_yes_no(prompt,default=None): | |
1082 | """Asks a question and returns a boolean (y/n) answer. |
|
1095 | """Asks a question and returns a boolean (y/n) answer. | |
1083 |
|
1096 | |||
1084 | If default is given (one of 'y','n'), it is used if the user input is |
|
1097 | If default is given (one of 'y','n'), it is used if the user input is | |
1085 | empty. Otherwise the question is repeated until an answer is given. |
|
1098 | empty. Otherwise the question is repeated until an answer is given. | |
1086 |
|
1099 | |||
1087 | An EOF is treated as the default answer. If there is no default, an |
|
1100 | An EOF is treated as the default answer. If there is no default, an | |
1088 | exception is raised to prevent infinite loops. |
|
1101 | exception is raised to prevent infinite loops. | |
1089 |
|
1102 | |||
1090 | Valid answers are: y/yes/n/no (match is not case sensitive).""" |
|
1103 | Valid answers are: y/yes/n/no (match is not case sensitive).""" | |
1091 |
|
1104 | |||
1092 | answers = {'y':True,'n':False,'yes':True,'no':False} |
|
1105 | answers = {'y':True,'n':False,'yes':True,'no':False} | |
1093 | ans = None |
|
1106 | ans = None | |
1094 | while ans not in answers.keys(): |
|
1107 | while ans not in answers.keys(): | |
1095 | try: |
|
1108 | try: | |
1096 | ans = raw_input(prompt+' ').lower() |
|
1109 | ans = raw_input(prompt+' ').lower() | |
1097 | if not ans: # response was an empty string |
|
1110 | if not ans: # response was an empty string | |
1098 | ans = default |
|
1111 | ans = default | |
1099 | except KeyboardInterrupt: |
|
1112 | except KeyboardInterrupt: | |
1100 | pass |
|
1113 | pass | |
1101 | except EOFError: |
|
1114 | except EOFError: | |
1102 | if default in answers.keys(): |
|
1115 | if default in answers.keys(): | |
1103 | ans = default |
|
1116 | ans = default | |
1104 |
|
1117 | |||
1105 | else: |
|
1118 | else: | |
1106 | raise |
|
1119 | raise | |
1107 |
|
1120 | |||
1108 | return answers[ans] |
|
1121 | return answers[ans] | |
1109 |
|
1122 | |||
1110 | #---------------------------------------------------------------------------- |
|
1123 | #---------------------------------------------------------------------------- | |
1111 | def marquee(txt='',width=78,mark='*'): |
|
1124 | def marquee(txt='',width=78,mark='*'): | |
1112 | """Return the input string centered in a 'marquee'.""" |
|
1125 | """Return the input string centered in a 'marquee'.""" | |
1113 | if not txt: |
|
1126 | if not txt: | |
1114 | return (mark*width)[:width] |
|
1127 | return (mark*width)[:width] | |
1115 | nmark = (width-len(txt)-2)/len(mark)/2 |
|
1128 | nmark = (width-len(txt)-2)/len(mark)/2 | |
1116 | if nmark < 0: nmark =0 |
|
1129 | if nmark < 0: nmark =0 | |
1117 | marks = mark*nmark |
|
1130 | marks = mark*nmark | |
1118 | return '%s %s %s' % (marks,txt,marks) |
|
1131 | return '%s %s %s' % (marks,txt,marks) | |
1119 |
|
1132 | |||
1120 | #---------------------------------------------------------------------------- |
|
1133 | #---------------------------------------------------------------------------- | |
1121 | class EvalDict: |
|
1134 | class EvalDict: | |
1122 | """ |
|
1135 | """ | |
1123 | Emulate a dict which evaluates its contents in the caller's frame. |
|
1136 | Emulate a dict which evaluates its contents in the caller's frame. | |
1124 |
|
1137 | |||
1125 | Usage: |
|
1138 | Usage: | |
1126 | >>>number = 19 |
|
1139 | >>>number = 19 | |
1127 | >>>text = "python" |
|
1140 | >>>text = "python" | |
1128 | >>>print "%(text.capitalize())s %(number/9.0).1f rules!" % EvalDict() |
|
1141 | >>>print "%(text.capitalize())s %(number/9.0).1f rules!" % EvalDict() | |
1129 | """ |
|
1142 | """ | |
1130 |
|
1143 | |||
1131 | # This version is due to sismex01@hebmex.com on c.l.py, and is basically a |
|
1144 | # This version is due to sismex01@hebmex.com on c.l.py, and is basically a | |
1132 | # modified (shorter) version of: |
|
1145 | # modified (shorter) version of: | |
1133 | # http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/66018 by |
|
1146 | # http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/66018 by | |
1134 | # Skip Montanaro (skip@pobox.com). |
|
1147 | # Skip Montanaro (skip@pobox.com). | |
1135 |
|
1148 | |||
1136 | def __getitem__(self, name): |
|
1149 | def __getitem__(self, name): | |
1137 | frame = sys._getframe(1) |
|
1150 | frame = sys._getframe(1) | |
1138 | return eval(name, frame.f_globals, frame.f_locals) |
|
1151 | return eval(name, frame.f_globals, frame.f_locals) | |
1139 |
|
1152 | |||
1140 | EvalString = EvalDict # for backwards compatibility |
|
1153 | EvalString = EvalDict # for backwards compatibility | |
1141 | #---------------------------------------------------------------------------- |
|
1154 | #---------------------------------------------------------------------------- | |
1142 | def qw(words,flat=0,sep=None,maxsplit=-1): |
|
1155 | def qw(words,flat=0,sep=None,maxsplit=-1): | |
1143 | """Similar to Perl's qw() operator, but with some more options. |
|
1156 | """Similar to Perl's qw() operator, but with some more options. | |
1144 |
|
1157 | |||
1145 | qw(words,flat=0,sep=' ',maxsplit=-1) -> words.split(sep,maxsplit) |
|
1158 | qw(words,flat=0,sep=' ',maxsplit=-1) -> words.split(sep,maxsplit) | |
1146 |
|
1159 | |||
1147 | words can also be a list itself, and with flat=1, the output will be |
|
1160 | words can also be a list itself, and with flat=1, the output will be | |
1148 | recursively flattened. Examples: |
|
1161 | recursively flattened. Examples: | |
1149 |
|
1162 | |||
1150 | >>> qw('1 2') |
|
1163 | >>> qw('1 2') | |
1151 | ['1', '2'] |
|
1164 | ['1', '2'] | |
1152 | >>> qw(['a b','1 2',['m n','p q']]) |
|
1165 | >>> qw(['a b','1 2',['m n','p q']]) | |
1153 | [['a', 'b'], ['1', '2'], [['m', 'n'], ['p', 'q']]] |
|
1166 | [['a', 'b'], ['1', '2'], [['m', 'n'], ['p', 'q']]] | |
1154 | >>> qw(['a b','1 2',['m n','p q']],flat=1) |
|
1167 | >>> qw(['a b','1 2',['m n','p q']],flat=1) | |
1155 | ['a', 'b', '1', '2', 'm', 'n', 'p', 'q'] """ |
|
1168 | ['a', 'b', '1', '2', 'm', 'n', 'p', 'q'] """ | |
1156 |
|
1169 | |||
1157 | if type(words) in StringTypes: |
|
1170 | if type(words) in StringTypes: | |
1158 | return [word.strip() for word in words.split(sep,maxsplit) |
|
1171 | return [word.strip() for word in words.split(sep,maxsplit) | |
1159 | if word and not word.isspace() ] |
|
1172 | if word and not word.isspace() ] | |
1160 | if flat: |
|
1173 | if flat: | |
1161 | return flatten(map(qw,words,[1]*len(words))) |
|
1174 | return flatten(map(qw,words,[1]*len(words))) | |
1162 | return map(qw,words) |
|
1175 | return map(qw,words) | |
1163 |
|
1176 | |||
1164 | #---------------------------------------------------------------------------- |
|
1177 | #---------------------------------------------------------------------------- | |
1165 | def qwflat(words,sep=None,maxsplit=-1): |
|
1178 | def qwflat(words,sep=None,maxsplit=-1): | |
1166 | """Calls qw(words) in flat mode. It's just a convenient shorthand.""" |
|
1179 | """Calls qw(words) in flat mode. It's just a convenient shorthand.""" | |
1167 | return qw(words,1,sep,maxsplit) |
|
1180 | return qw(words,1,sep,maxsplit) | |
1168 |
|
1181 | |||
1169 | #---------------------------------------------------------------------------- |
|
1182 | #---------------------------------------------------------------------------- | |
1170 | def qw_lol(indata): |
|
1183 | def qw_lol(indata): | |
1171 | """qw_lol('a b') -> [['a','b']], |
|
1184 | """qw_lol('a b') -> [['a','b']], | |
1172 | otherwise it's just a call to qw(). |
|
1185 | otherwise it's just a call to qw(). | |
1173 |
|
1186 | |||
1174 | We need this to make sure the modules_some keys *always* end up as a |
|
1187 | We need this to make sure the modules_some keys *always* end up as a | |
1175 | list of lists.""" |
|
1188 | list of lists.""" | |
1176 |
|
1189 | |||
1177 | if type(indata) in StringTypes: |
|
1190 | if type(indata) in StringTypes: | |
1178 | return [qw(indata)] |
|
1191 | return [qw(indata)] | |
1179 | else: |
|
1192 | else: | |
1180 | return qw(indata) |
|
1193 | return qw(indata) | |
1181 |
|
1194 | |||
1182 | #----------------------------------------------------------------------------- |
|
1195 | #----------------------------------------------------------------------------- | |
1183 | def list_strings(arg): |
|
1196 | def list_strings(arg): | |
1184 | """Always return a list of strings, given a string or list of strings |
|
1197 | """Always return a list of strings, given a string or list of strings | |
1185 | as input.""" |
|
1198 | as input.""" | |
1186 |
|
1199 | |||
1187 | if type(arg) in StringTypes: return [arg] |
|
1200 | if type(arg) in StringTypes: return [arg] | |
1188 | else: return arg |
|
1201 | else: return arg | |
1189 |
|
1202 | |||
1190 | #---------------------------------------------------------------------------- |
|
1203 | #---------------------------------------------------------------------------- | |
1191 | def grep(pat,list,case=1): |
|
1204 | def grep(pat,list,case=1): | |
1192 | """Simple minded grep-like function. |
|
1205 | """Simple minded grep-like function. | |
1193 | grep(pat,list) returns occurrences of pat in list, None on failure. |
|
1206 | grep(pat,list) returns occurrences of pat in list, None on failure. | |
1194 |
|
1207 | |||
1195 | It only does simple string matching, with no support for regexps. Use the |
|
1208 | It only does simple string matching, with no support for regexps. Use the | |
1196 | option case=0 for case-insensitive matching.""" |
|
1209 | option case=0 for case-insensitive matching.""" | |
1197 |
|
1210 | |||
1198 | # This is pretty crude. At least it should implement copying only references |
|
1211 | # This is pretty crude. At least it should implement copying only references | |
1199 | # to the original data in case it's big. Now it copies the data for output. |
|
1212 | # to the original data in case it's big. Now it copies the data for output. | |
1200 | out=[] |
|
1213 | out=[] | |
1201 | if case: |
|
1214 | if case: | |
1202 | for term in list: |
|
1215 | for term in list: | |
1203 | if term.find(pat)>-1: out.append(term) |
|
1216 | if term.find(pat)>-1: out.append(term) | |
1204 | else: |
|
1217 | else: | |
1205 | lpat=pat.lower() |
|
1218 | lpat=pat.lower() | |
1206 | for term in list: |
|
1219 | for term in list: | |
1207 | if term.lower().find(lpat)>-1: out.append(term) |
|
1220 | if term.lower().find(lpat)>-1: out.append(term) | |
1208 |
|
1221 | |||
1209 | if len(out): return out |
|
1222 | if len(out): return out | |
1210 | else: return None |
|
1223 | else: return None | |
1211 |
|
1224 | |||
1212 | #---------------------------------------------------------------------------- |
|
1225 | #---------------------------------------------------------------------------- | |
1213 | def dgrep(pat,*opts): |
|
1226 | def dgrep(pat,*opts): | |
1214 | """Return grep() on dir()+dir(__builtins__). |
|
1227 | """Return grep() on dir()+dir(__builtins__). | |
1215 |
|
1228 | |||
1216 | A very common use of grep() when working interactively.""" |
|
1229 | A very common use of grep() when working interactively.""" | |
1217 |
|
1230 | |||
1218 | return grep(pat,dir(__main__)+dir(__main__.__builtins__),*opts) |
|
1231 | return grep(pat,dir(__main__)+dir(__main__.__builtins__),*opts) | |
1219 |
|
1232 | |||
1220 | #---------------------------------------------------------------------------- |
|
1233 | #---------------------------------------------------------------------------- | |
1221 | def idgrep(pat): |
|
1234 | def idgrep(pat): | |
1222 | """Case-insensitive dgrep()""" |
|
1235 | """Case-insensitive dgrep()""" | |
1223 |
|
1236 | |||
1224 | return dgrep(pat,0) |
|
1237 | return dgrep(pat,0) | |
1225 |
|
1238 | |||
1226 | #---------------------------------------------------------------------------- |
|
1239 | #---------------------------------------------------------------------------- | |
1227 | def igrep(pat,list): |
|
1240 | def igrep(pat,list): | |
1228 | """Synonym for case-insensitive grep.""" |
|
1241 | """Synonym for case-insensitive grep.""" | |
1229 |
|
1242 | |||
1230 | return grep(pat,list,case=0) |
|
1243 | return grep(pat,list,case=0) | |
1231 |
|
1244 | |||
1232 | #---------------------------------------------------------------------------- |
|
1245 | #---------------------------------------------------------------------------- | |
1233 | def indent(str,nspaces=4,ntabs=0): |
|
1246 | def indent(str,nspaces=4,ntabs=0): | |
1234 | """Indent a string a given number of spaces or tabstops. |
|
1247 | """Indent a string a given number of spaces or tabstops. | |
1235 |
|
1248 | |||
1236 | indent(str,nspaces=4,ntabs=0) -> indent str by ntabs+nspaces. |
|
1249 | indent(str,nspaces=4,ntabs=0) -> indent str by ntabs+nspaces. | |
1237 | """ |
|
1250 | """ | |
1238 | if str is None: |
|
1251 | if str is None: | |
1239 | return |
|
1252 | return | |
1240 | ind = '\t'*ntabs+' '*nspaces |
|
1253 | ind = '\t'*ntabs+' '*nspaces | |
1241 | outstr = '%s%s' % (ind,str.replace(os.linesep,os.linesep+ind)) |
|
1254 | outstr = '%s%s' % (ind,str.replace(os.linesep,os.linesep+ind)) | |
1242 | if outstr.endswith(os.linesep+ind): |
|
1255 | if outstr.endswith(os.linesep+ind): | |
1243 | return outstr[:-len(ind)] |
|
1256 | return outstr[:-len(ind)] | |
1244 | else: |
|
1257 | else: | |
1245 | return outstr |
|
1258 | return outstr | |
1246 |
|
1259 | |||
1247 | #----------------------------------------------------------------------------- |
|
1260 | #----------------------------------------------------------------------------- | |
1248 | def native_line_ends(filename,backup=1): |
|
1261 | def native_line_ends(filename,backup=1): | |
1249 | """Convert (in-place) a file to line-ends native to the current OS. |
|
1262 | """Convert (in-place) a file to line-ends native to the current OS. | |
1250 |
|
1263 | |||
1251 | If the optional backup argument is given as false, no backup of the |
|
1264 | If the optional backup argument is given as false, no backup of the | |
1252 | original file is left. """ |
|
1265 | original file is left. """ | |
1253 |
|
1266 | |||
1254 | backup_suffixes = {'posix':'~','dos':'.bak','nt':'.bak','mac':'.bak'} |
|
1267 | backup_suffixes = {'posix':'~','dos':'.bak','nt':'.bak','mac':'.bak'} | |
1255 |
|
1268 | |||
1256 | bak_filename = filename + backup_suffixes[os.name] |
|
1269 | bak_filename = filename + backup_suffixes[os.name] | |
1257 |
|
1270 | |||
1258 | original = open(filename).read() |
|
1271 | original = open(filename).read() | |
1259 | shutil.copy2(filename,bak_filename) |
|
1272 | shutil.copy2(filename,bak_filename) | |
1260 | try: |
|
1273 | try: | |
1261 | new = open(filename,'wb') |
|
1274 | new = open(filename,'wb') | |
1262 | new.write(os.linesep.join(original.splitlines())) |
|
1275 | new.write(os.linesep.join(original.splitlines())) | |
1263 | new.write(os.linesep) # ALWAYS put an eol at the end of the file |
|
1276 | new.write(os.linesep) # ALWAYS put an eol at the end of the file | |
1264 | new.close() |
|
1277 | new.close() | |
1265 | except: |
|
1278 | except: | |
1266 | os.rename(bak_filename,filename) |
|
1279 | os.rename(bak_filename,filename) | |
1267 | if not backup: |
|
1280 | if not backup: | |
1268 | try: |
|
1281 | try: | |
1269 | os.remove(bak_filename) |
|
1282 | os.remove(bak_filename) | |
1270 | except: |
|
1283 | except: | |
1271 | pass |
|
1284 | pass | |
1272 |
|
1285 | |||
1273 | #---------------------------------------------------------------------------- |
|
1286 | #---------------------------------------------------------------------------- | |
1274 | def get_pager_cmd(pager_cmd = None): |
|
1287 | def get_pager_cmd(pager_cmd = None): | |
1275 | """Return a pager command. |
|
1288 | """Return a pager command. | |
1276 |
|
1289 | |||
1277 | Makes some attempts at finding an OS-correct one.""" |
|
1290 | Makes some attempts at finding an OS-correct one.""" | |
1278 |
|
1291 | |||
1279 | if os.name == 'posix': |
|
1292 | if os.name == 'posix': | |
1280 | default_pager_cmd = 'less -r' # -r for color control sequences |
|
1293 | default_pager_cmd = 'less -r' # -r for color control sequences | |
1281 | elif os.name in ['nt','dos']: |
|
1294 | elif os.name in ['nt','dos']: | |
1282 | default_pager_cmd = 'type' |
|
1295 | default_pager_cmd = 'type' | |
1283 |
|
1296 | |||
1284 | if pager_cmd is None: |
|
1297 | if pager_cmd is None: | |
1285 | try: |
|
1298 | try: | |
1286 | pager_cmd = os.environ['PAGER'] |
|
1299 | pager_cmd = os.environ['PAGER'] | |
1287 | except: |
|
1300 | except: | |
1288 | pager_cmd = default_pager_cmd |
|
1301 | pager_cmd = default_pager_cmd | |
1289 | return pager_cmd |
|
1302 | return pager_cmd | |
1290 |
|
1303 | |||
1291 | #----------------------------------------------------------------------------- |
|
1304 | #----------------------------------------------------------------------------- | |
1292 | def get_pager_start(pager,start): |
|
1305 | def get_pager_start(pager,start): | |
1293 | """Return the string for paging files with an offset. |
|
1306 | """Return the string for paging files with an offset. | |
1294 |
|
1307 | |||
1295 | This is the '+N' argument which less and more (under Unix) accept. |
|
1308 | This is the '+N' argument which less and more (under Unix) accept. | |
1296 | """ |
|
1309 | """ | |
1297 |
|
1310 | |||
1298 | if pager in ['less','more']: |
|
1311 | if pager in ['less','more']: | |
1299 | if start: |
|
1312 | if start: | |
1300 | start_string = '+' + str(start) |
|
1313 | start_string = '+' + str(start) | |
1301 | else: |
|
1314 | else: | |
1302 | start_string = '' |
|
1315 | start_string = '' | |
1303 | else: |
|
1316 | else: | |
1304 | start_string = '' |
|
1317 | start_string = '' | |
1305 | return start_string |
|
1318 | return start_string | |
1306 |
|
1319 | |||
1307 | #---------------------------------------------------------------------------- |
|
1320 | #---------------------------------------------------------------------------- | |
1308 | # (X)emacs on W32 doesn't like to be bypassed with msvcrt.getch() |
|
1321 | # (X)emacs on W32 doesn't like to be bypassed with msvcrt.getch() | |
1309 | if os.name == 'nt' and os.environ.get('TERM','dumb') != 'emacs': |
|
1322 | if os.name == 'nt' and os.environ.get('TERM','dumb') != 'emacs': | |
1310 | import msvcrt |
|
1323 | import msvcrt | |
1311 | def page_more(): |
|
1324 | def page_more(): | |
1312 | """ Smart pausing between pages |
|
1325 | """ Smart pausing between pages | |
1313 |
|
1326 | |||
1314 | @return: True if need print more lines, False if quit |
|
1327 | @return: True if need print more lines, False if quit | |
1315 | """ |
|
1328 | """ | |
1316 | Term.cout.write('---Return to continue, q to quit--- ') |
|
1329 | Term.cout.write('---Return to continue, q to quit--- ') | |
1317 | ans = msvcrt.getch() |
|
1330 | ans = msvcrt.getch() | |
1318 | if ans in ("q", "Q"): |
|
1331 | if ans in ("q", "Q"): | |
1319 | result = False |
|
1332 | result = False | |
1320 | else: |
|
1333 | else: | |
1321 | result = True |
|
1334 | result = True | |
1322 | Term.cout.write("\b"*37 + " "*37 + "\b"*37) |
|
1335 | Term.cout.write("\b"*37 + " "*37 + "\b"*37) | |
1323 | return result |
|
1336 | return result | |
1324 | else: |
|
1337 | else: | |
1325 | def page_more(): |
|
1338 | def page_more(): | |
1326 | ans = raw_input('---Return to continue, q to quit--- ') |
|
1339 | ans = raw_input('---Return to continue, q to quit--- ') | |
1327 | if ans.lower().startswith('q'): |
|
1340 | if ans.lower().startswith('q'): | |
1328 | return False |
|
1341 | return False | |
1329 | else: |
|
1342 | else: | |
1330 | return True |
|
1343 | return True | |
1331 |
|
1344 | |||
1332 | esc_re = re.compile(r"(\x1b[^m]+m)") |
|
1345 | esc_re = re.compile(r"(\x1b[^m]+m)") | |
1333 |
|
1346 | |||
1334 | def page_dumb(strng,start=0,screen_lines=25): |
|
1347 | def page_dumb(strng,start=0,screen_lines=25): | |
1335 | """Very dumb 'pager' in Python, for when nothing else works. |
|
1348 | """Very dumb 'pager' in Python, for when nothing else works. | |
1336 |
|
1349 | |||
1337 | Only moves forward, same interface as page(), except for pager_cmd and |
|
1350 | Only moves forward, same interface as page(), except for pager_cmd and | |
1338 | mode.""" |
|
1351 | mode.""" | |
1339 |
|
1352 | |||
1340 | out_ln = strng.splitlines()[start:] |
|
1353 | out_ln = strng.splitlines()[start:] | |
1341 | screens = chop(out_ln,screen_lines-1) |
|
1354 | screens = chop(out_ln,screen_lines-1) | |
1342 | if len(screens) == 1: |
|
1355 | if len(screens) == 1: | |
1343 | print >>Term.cout, os.linesep.join(screens[0]) |
|
1356 | print >>Term.cout, os.linesep.join(screens[0]) | |
1344 | else: |
|
1357 | else: | |
1345 | last_escape = "" |
|
1358 | last_escape = "" | |
1346 | for scr in screens[0:-1]: |
|
1359 | for scr in screens[0:-1]: | |
1347 | hunk = os.linesep.join(scr) |
|
1360 | hunk = os.linesep.join(scr) | |
1348 | print >>Term.cout, last_escape + hunk |
|
1361 | print >>Term.cout, last_escape + hunk | |
1349 | if not page_more(): |
|
1362 | if not page_more(): | |
1350 | return |
|
1363 | return | |
1351 | esc_list = esc_re.findall(hunk) |
|
1364 | esc_list = esc_re.findall(hunk) | |
1352 | if len(esc_list) > 0: |
|
1365 | if len(esc_list) > 0: | |
1353 | last_escape = esc_list[-1] |
|
1366 | last_escape = esc_list[-1] | |
1354 | print >>Term.cout, last_escape + os.linesep.join(screens[-1]) |
|
1367 | print >>Term.cout, last_escape + os.linesep.join(screens[-1]) | |
1355 |
|
1368 | |||
1356 | #---------------------------------------------------------------------------- |
|
1369 | #---------------------------------------------------------------------------- | |
1357 | def page(strng,start=0,screen_lines=0,pager_cmd = None): |
|
1370 | def page(strng,start=0,screen_lines=0,pager_cmd = None): | |
1358 | """Print a string, piping through a pager after a certain length. |
|
1371 | """Print a string, piping through a pager after a certain length. | |
1359 |
|
1372 | |||
1360 | The screen_lines parameter specifies the number of *usable* lines of your |
|
1373 | The screen_lines parameter specifies the number of *usable* lines of your | |
1361 | terminal screen (total lines minus lines you need to reserve to show other |
|
1374 | terminal screen (total lines minus lines you need to reserve to show other | |
1362 | information). |
|
1375 | information). | |
1363 |
|
1376 | |||
1364 | If you set screen_lines to a number <=0, page() will try to auto-determine |
|
1377 | If you set screen_lines to a number <=0, page() will try to auto-determine | |
1365 | your screen size and will only use up to (screen_size+screen_lines) for |
|
1378 | your screen size and will only use up to (screen_size+screen_lines) for | |
1366 | printing, paging after that. That is, if you want auto-detection but need |
|
1379 | printing, paging after that. That is, if you want auto-detection but need | |
1367 | to reserve the bottom 3 lines of the screen, use screen_lines = -3, and for |
|
1380 | to reserve the bottom 3 lines of the screen, use screen_lines = -3, and for | |
1368 | auto-detection without any lines reserved simply use screen_lines = 0. |
|
1381 | auto-detection without any lines reserved simply use screen_lines = 0. | |
1369 |
|
1382 | |||
1370 | If a string won't fit in the allowed lines, it is sent through the |
|
1383 | If a string won't fit in the allowed lines, it is sent through the | |
1371 | specified pager command. If none given, look for PAGER in the environment, |
|
1384 | specified pager command. If none given, look for PAGER in the environment, | |
1372 | and ultimately default to less. |
|
1385 | and ultimately default to less. | |
1373 |
|
1386 | |||
1374 | If no system pager works, the string is sent through a 'dumb pager' |
|
1387 | If no system pager works, the string is sent through a 'dumb pager' | |
1375 | written in python, very simplistic. |
|
1388 | written in python, very simplistic. | |
1376 | """ |
|
1389 | """ | |
1377 |
|
1390 | |||
1378 | # Ugly kludge, but calling curses.initscr() flat out crashes in emacs |
|
1391 | # Ugly kludge, but calling curses.initscr() flat out crashes in emacs | |
1379 | TERM = os.environ.get('TERM','dumb') |
|
1392 | TERM = os.environ.get('TERM','dumb') | |
1380 | if TERM in ['dumb','emacs'] and os.name != 'nt': |
|
1393 | if TERM in ['dumb','emacs'] and os.name != 'nt': | |
1381 | print strng |
|
1394 | print strng | |
1382 | return |
|
1395 | return | |
1383 | # chop off the topmost part of the string we don't want to see |
|
1396 | # chop off the topmost part of the string we don't want to see | |
1384 | str_lines = strng.split(os.linesep)[start:] |
|
1397 | str_lines = strng.split(os.linesep)[start:] | |
1385 | str_toprint = os.linesep.join(str_lines) |
|
1398 | str_toprint = os.linesep.join(str_lines) | |
1386 | num_newlines = len(str_lines) |
|
1399 | num_newlines = len(str_lines) | |
1387 | len_str = len(str_toprint) |
|
1400 | len_str = len(str_toprint) | |
1388 |
|
1401 | |||
1389 | # Dumb heuristics to guesstimate number of on-screen lines the string |
|
1402 | # Dumb heuristics to guesstimate number of on-screen lines the string | |
1390 | # takes. Very basic, but good enough for docstrings in reasonable |
|
1403 | # takes. Very basic, but good enough for docstrings in reasonable | |
1391 | # terminals. If someone later feels like refining it, it's not hard. |
|
1404 | # terminals. If someone later feels like refining it, it's not hard. | |
1392 | numlines = max(num_newlines,int(len_str/80)+1) |
|
1405 | numlines = max(num_newlines,int(len_str/80)+1) | |
1393 |
|
1406 | |||
1394 | if os.name == "nt": |
|
1407 | if os.name == "nt": | |
1395 | screen_lines_def = get_console_size(defaulty=25)[1] |
|
1408 | screen_lines_def = get_console_size(defaulty=25)[1] | |
1396 | else: |
|
1409 | else: | |
1397 | screen_lines_def = 25 # default value if we can't auto-determine |
|
1410 | screen_lines_def = 25 # default value if we can't auto-determine | |
1398 |
|
1411 | |||
1399 | # auto-determine screen size |
|
1412 | # auto-determine screen size | |
1400 | if screen_lines <= 0: |
|
1413 | if screen_lines <= 0: | |
1401 | if TERM=='xterm': |
|
1414 | if TERM=='xterm': | |
1402 | try: |
|
1415 | try: | |
1403 | import curses |
|
1416 | import curses | |
1404 | if hasattr(curses,'initscr'): |
|
1417 | if hasattr(curses,'initscr'): | |
1405 | use_curses = 1 |
|
1418 | use_curses = 1 | |
1406 | else: |
|
1419 | else: | |
1407 | use_curses = 0 |
|
1420 | use_curses = 0 | |
1408 | except ImportError: |
|
1421 | except ImportError: | |
1409 | use_curses = 0 |
|
1422 | use_curses = 0 | |
1410 | else: |
|
1423 | else: | |
1411 | # curses causes problems on many terminals other than xterm. |
|
1424 | # curses causes problems on many terminals other than xterm. | |
1412 | use_curses = 0 |
|
1425 | use_curses = 0 | |
1413 | if use_curses: |
|
1426 | if use_curses: | |
1414 | scr = curses.initscr() |
|
1427 | scr = curses.initscr() | |
1415 | screen_lines_real,screen_cols = scr.getmaxyx() |
|
1428 | screen_lines_real,screen_cols = scr.getmaxyx() | |
1416 | curses.endwin() |
|
1429 | curses.endwin() | |
1417 | screen_lines += screen_lines_real |
|
1430 | screen_lines += screen_lines_real | |
1418 | #print '***Screen size:',screen_lines_real,'lines x',\ |
|
1431 | #print '***Screen size:',screen_lines_real,'lines x',\ | |
1419 | #screen_cols,'columns.' # dbg |
|
1432 | #screen_cols,'columns.' # dbg | |
1420 | else: |
|
1433 | else: | |
1421 | screen_lines += screen_lines_def |
|
1434 | screen_lines += screen_lines_def | |
1422 |
|
1435 | |||
1423 | #print 'numlines',numlines,'screenlines',screen_lines # dbg |
|
1436 | #print 'numlines',numlines,'screenlines',screen_lines # dbg | |
1424 | if numlines <= screen_lines : |
|
1437 | if numlines <= screen_lines : | |
1425 | #print '*** normal print' # dbg |
|
1438 | #print '*** normal print' # dbg | |
1426 | print >>Term.cout, str_toprint |
|
1439 | print >>Term.cout, str_toprint | |
1427 | else: |
|
1440 | else: | |
1428 | # Try to open pager and default to internal one if that fails. |
|
1441 | # Try to open pager and default to internal one if that fails. | |
1429 | # All failure modes are tagged as 'retval=1', to match the return |
|
1442 | # All failure modes are tagged as 'retval=1', to match the return | |
1430 | # value of a failed system command. If any intermediate attempt |
|
1443 | # value of a failed system command. If any intermediate attempt | |
1431 | # sets retval to 1, at the end we resort to our own page_dumb() pager. |
|
1444 | # sets retval to 1, at the end we resort to our own page_dumb() pager. | |
1432 | pager_cmd = get_pager_cmd(pager_cmd) |
|
1445 | pager_cmd = get_pager_cmd(pager_cmd) | |
1433 | pager_cmd += ' ' + get_pager_start(pager_cmd,start) |
|
1446 | pager_cmd += ' ' + get_pager_start(pager_cmd,start) | |
1434 | if os.name == 'nt': |
|
1447 | if os.name == 'nt': | |
1435 | if pager_cmd.startswith('type'): |
|
1448 | if pager_cmd.startswith('type'): | |
1436 | # The default WinXP 'type' command is failing on complex strings. |
|
1449 | # The default WinXP 'type' command is failing on complex strings. | |
1437 | retval = 1 |
|
1450 | retval = 1 | |
1438 | else: |
|
1451 | else: | |
1439 | tmpname = tempfile.mktemp('.txt') |
|
1452 | tmpname = tempfile.mktemp('.txt') | |
1440 | tmpfile = file(tmpname,'wt') |
|
1453 | tmpfile = file(tmpname,'wt') | |
1441 | tmpfile.write(strng) |
|
1454 | tmpfile.write(strng) | |
1442 | tmpfile.close() |
|
1455 | tmpfile.close() | |
1443 | cmd = "%s < %s" % (pager_cmd,tmpname) |
|
1456 | cmd = "%s < %s" % (pager_cmd,tmpname) | |
1444 | if os.system(cmd): |
|
1457 | if os.system(cmd): | |
1445 | retval = 1 |
|
1458 | retval = 1 | |
1446 | else: |
|
1459 | else: | |
1447 | retval = None |
|
1460 | retval = None | |
1448 | os.remove(tmpname) |
|
1461 | os.remove(tmpname) | |
1449 | else: |
|
1462 | else: | |
1450 | try: |
|
1463 | try: | |
1451 | retval = None |
|
1464 | retval = None | |
1452 | # if I use popen4, things hang. No idea why. |
|
1465 | # if I use popen4, things hang. No idea why. | |
1453 | #pager,shell_out = os.popen4(pager_cmd) |
|
1466 | #pager,shell_out = os.popen4(pager_cmd) | |
1454 | pager = os.popen(pager_cmd,'w') |
|
1467 | pager = os.popen(pager_cmd,'w') | |
1455 | pager.write(strng) |
|
1468 | pager.write(strng) | |
1456 | pager.close() |
|
1469 | pager.close() | |
1457 | retval = pager.close() # success returns None |
|
1470 | retval = pager.close() # success returns None | |
1458 | except IOError,msg: # broken pipe when user quits |
|
1471 | except IOError,msg: # broken pipe when user quits | |
1459 | if msg.args == (32,'Broken pipe'): |
|
1472 | if msg.args == (32,'Broken pipe'): | |
1460 | retval = None |
|
1473 | retval = None | |
1461 | else: |
|
1474 | else: | |
1462 | retval = 1 |
|
1475 | retval = 1 | |
1463 | except OSError: |
|
1476 | except OSError: | |
1464 | # Other strange problems, sometimes seen in Win2k/cygwin |
|
1477 | # Other strange problems, sometimes seen in Win2k/cygwin | |
1465 | retval = 1 |
|
1478 | retval = 1 | |
1466 | if retval is not None: |
|
1479 | if retval is not None: | |
1467 | page_dumb(strng,screen_lines=screen_lines) |
|
1480 | page_dumb(strng,screen_lines=screen_lines) | |
1468 |
|
1481 | |||
1469 | #---------------------------------------------------------------------------- |
|
1482 | #---------------------------------------------------------------------------- | |
1470 | def page_file(fname,start = 0, pager_cmd = None): |
|
1483 | def page_file(fname,start = 0, pager_cmd = None): | |
1471 | """Page a file, using an optional pager command and starting line. |
|
1484 | """Page a file, using an optional pager command and starting line. | |
1472 | """ |
|
1485 | """ | |
1473 |
|
1486 | |||
1474 | pager_cmd = get_pager_cmd(pager_cmd) |
|
1487 | pager_cmd = get_pager_cmd(pager_cmd) | |
1475 | pager_cmd += ' ' + get_pager_start(pager_cmd,start) |
|
1488 | pager_cmd += ' ' + get_pager_start(pager_cmd,start) | |
1476 |
|
1489 | |||
1477 | try: |
|
1490 | try: | |
1478 | if os.environ['TERM'] in ['emacs','dumb']: |
|
1491 | if os.environ['TERM'] in ['emacs','dumb']: | |
1479 | raise EnvironmentError |
|
1492 | raise EnvironmentError | |
1480 | xsys(pager_cmd + ' ' + fname) |
|
1493 | xsys(pager_cmd + ' ' + fname) | |
1481 | except: |
|
1494 | except: | |
1482 | try: |
|
1495 | try: | |
1483 | if start > 0: |
|
1496 | if start > 0: | |
1484 | start -= 1 |
|
1497 | start -= 1 | |
1485 | page(open(fname).read(),start) |
|
1498 | page(open(fname).read(),start) | |
1486 | except: |
|
1499 | except: | |
1487 | print 'Unable to show file',`fname` |
|
1500 | print 'Unable to show file',`fname` | |
1488 |
|
1501 | |||
1489 | #---------------------------------------------------------------------------- |
|
1502 | #---------------------------------------------------------------------------- | |
1490 | def snip_print(str,width = 75,print_full = 0,header = ''): |
|
1503 | def snip_print(str,width = 75,print_full = 0,header = ''): | |
1491 | """Print a string snipping the midsection to fit in width. |
|
1504 | """Print a string snipping the midsection to fit in width. | |
1492 |
|
1505 | |||
1493 | print_full: mode control: |
|
1506 | print_full: mode control: | |
1494 | - 0: only snip long strings |
|
1507 | - 0: only snip long strings | |
1495 | - 1: send to page() directly. |
|
1508 | - 1: send to page() directly. | |
1496 | - 2: snip long strings and ask for full length viewing with page() |
|
1509 | - 2: snip long strings and ask for full length viewing with page() | |
1497 | Return 1 if snipping was necessary, 0 otherwise.""" |
|
1510 | Return 1 if snipping was necessary, 0 otherwise.""" | |
1498 |
|
1511 | |||
1499 | if print_full == 1: |
|
1512 | if print_full == 1: | |
1500 | page(header+str) |
|
1513 | page(header+str) | |
1501 | return 0 |
|
1514 | return 0 | |
1502 |
|
1515 | |||
1503 | print header, |
|
1516 | print header, | |
1504 | if len(str) < width: |
|
1517 | if len(str) < width: | |
1505 | print str |
|
1518 | print str | |
1506 | snip = 0 |
|
1519 | snip = 0 | |
1507 | else: |
|
1520 | else: | |
1508 | whalf = int((width -5)/2) |
|
1521 | whalf = int((width -5)/2) | |
1509 | print str[:whalf] + ' <...> ' + str[-whalf:] |
|
1522 | print str[:whalf] + ' <...> ' + str[-whalf:] | |
1510 | snip = 1 |
|
1523 | snip = 1 | |
1511 | if snip and print_full == 2: |
|
1524 | if snip and print_full == 2: | |
1512 | if raw_input(header+' Snipped. View (y/n)? [N]').lower() == 'y': |
|
1525 | if raw_input(header+' Snipped. View (y/n)? [N]').lower() == 'y': | |
1513 | page(str) |
|
1526 | page(str) | |
1514 | return snip |
|
1527 | return snip | |
1515 |
|
1528 | |||
1516 | #**************************************************************************** |
|
1529 | #**************************************************************************** | |
1517 | # lists, dicts and structures |
|
1530 | # lists, dicts and structures | |
1518 |
|
1531 | |||
1519 | def belong(candidates,checklist): |
|
1532 | def belong(candidates,checklist): | |
1520 | """Check whether a list of items appear in a given list of options. |
|
1533 | """Check whether a list of items appear in a given list of options. | |
1521 |
|
1534 | |||
1522 | Returns a list of 1 and 0, one for each candidate given.""" |
|
1535 | Returns a list of 1 and 0, one for each candidate given.""" | |
1523 |
|
1536 | |||
1524 | return [x in checklist for x in candidates] |
|
1537 | return [x in checklist for x in candidates] | |
1525 |
|
1538 | |||
1526 | #---------------------------------------------------------------------------- |
|
1539 | #---------------------------------------------------------------------------- | |
1527 | def uniq_stable(elems): |
|
1540 | def uniq_stable(elems): | |
1528 | """uniq_stable(elems) -> list |
|
1541 | """uniq_stable(elems) -> list | |
1529 |
|
1542 | |||
1530 | Return from an iterable, a list of all the unique elements in the input, |
|
1543 | Return from an iterable, a list of all the unique elements in the input, | |
1531 | but maintaining the order in which they first appear. |
|
1544 | but maintaining the order in which they first appear. | |
1532 |
|
1545 | |||
1533 | A naive solution to this problem which just makes a dictionary with the |
|
1546 | A naive solution to this problem which just makes a dictionary with the | |
1534 | elements as keys fails to respect the stability condition, since |
|
1547 | elements as keys fails to respect the stability condition, since | |
1535 | dictionaries are unsorted by nature. |
|
1548 | dictionaries are unsorted by nature. | |
1536 |
|
1549 | |||
1537 | Note: All elements in the input must be valid dictionary keys for this |
|
1550 | Note: All elements in the input must be valid dictionary keys for this | |
1538 | routine to work, as it internally uses a dictionary for efficiency |
|
1551 | routine to work, as it internally uses a dictionary for efficiency | |
1539 | reasons.""" |
|
1552 | reasons.""" | |
1540 |
|
1553 | |||
1541 | unique = [] |
|
1554 | unique = [] | |
1542 | unique_dict = {} |
|
1555 | unique_dict = {} | |
1543 | for nn in elems: |
|
1556 | for nn in elems: | |
1544 | if nn not in unique_dict: |
|
1557 | if nn not in unique_dict: | |
1545 | unique.append(nn) |
|
1558 | unique.append(nn) | |
1546 | unique_dict[nn] = None |
|
1559 | unique_dict[nn] = None | |
1547 | return unique |
|
1560 | return unique | |
1548 |
|
1561 | |||
1549 | #---------------------------------------------------------------------------- |
|
1562 | #---------------------------------------------------------------------------- | |
1550 | class NLprinter: |
|
1563 | class NLprinter: | |
1551 | """Print an arbitrarily nested list, indicating index numbers. |
|
1564 | """Print an arbitrarily nested list, indicating index numbers. | |
1552 |
|
1565 | |||
1553 | An instance of this class called nlprint is available and callable as a |
|
1566 | An instance of this class called nlprint is available and callable as a | |
1554 | function. |
|
1567 | function. | |
1555 |
|
1568 | |||
1556 | nlprint(list,indent=' ',sep=': ') -> prints indenting each level by 'indent' |
|
1569 | nlprint(list,indent=' ',sep=': ') -> prints indenting each level by 'indent' | |
1557 | and using 'sep' to separate the index from the value. """ |
|
1570 | and using 'sep' to separate the index from the value. """ | |
1558 |
|
1571 | |||
1559 | def __init__(self): |
|
1572 | def __init__(self): | |
1560 | self.depth = 0 |
|
1573 | self.depth = 0 | |
1561 |
|
1574 | |||
1562 | def __call__(self,lst,pos='',**kw): |
|
1575 | def __call__(self,lst,pos='',**kw): | |
1563 | """Prints the nested list numbering levels.""" |
|
1576 | """Prints the nested list numbering levels.""" | |
1564 | kw.setdefault('indent',' ') |
|
1577 | kw.setdefault('indent',' ') | |
1565 | kw.setdefault('sep',': ') |
|
1578 | kw.setdefault('sep',': ') | |
1566 | kw.setdefault('start',0) |
|
1579 | kw.setdefault('start',0) | |
1567 | kw.setdefault('stop',len(lst)) |
|
1580 | kw.setdefault('stop',len(lst)) | |
1568 | # we need to remove start and stop from kw so they don't propagate |
|
1581 | # we need to remove start and stop from kw so they don't propagate | |
1569 | # into a recursive call for a nested list. |
|
1582 | # into a recursive call for a nested list. | |
1570 | start = kw['start']; del kw['start'] |
|
1583 | start = kw['start']; del kw['start'] | |
1571 | stop = kw['stop']; del kw['stop'] |
|
1584 | stop = kw['stop']; del kw['stop'] | |
1572 | if self.depth == 0 and 'header' in kw.keys(): |
|
1585 | if self.depth == 0 and 'header' in kw.keys(): | |
1573 | print kw['header'] |
|
1586 | print kw['header'] | |
1574 |
|
1587 | |||
1575 | for idx in range(start,stop): |
|
1588 | for idx in range(start,stop): | |
1576 | elem = lst[idx] |
|
1589 | elem = lst[idx] | |
1577 | if type(elem)==type([]): |
|
1590 | if type(elem)==type([]): | |
1578 | self.depth += 1 |
|
1591 | self.depth += 1 | |
1579 | self.__call__(elem,itpl('$pos$idx,'),**kw) |
|
1592 | self.__call__(elem,itpl('$pos$idx,'),**kw) | |
1580 | self.depth -= 1 |
|
1593 | self.depth -= 1 | |
1581 | else: |
|
1594 | else: | |
1582 | printpl(kw['indent']*self.depth+'$pos$idx$kw["sep"]$elem') |
|
1595 | printpl(kw['indent']*self.depth+'$pos$idx$kw["sep"]$elem') | |
1583 |
|
1596 | |||
1584 | nlprint = NLprinter() |
|
1597 | nlprint = NLprinter() | |
1585 | #---------------------------------------------------------------------------- |
|
1598 | #---------------------------------------------------------------------------- | |
1586 | def all_belong(candidates,checklist): |
|
1599 | def all_belong(candidates,checklist): | |
1587 | """Check whether a list of items ALL appear in a given list of options. |
|
1600 | """Check whether a list of items ALL appear in a given list of options. | |
1588 |
|
1601 | |||
1589 | Returns a single 1 or 0 value.""" |
|
1602 | Returns a single 1 or 0 value.""" | |
1590 |
|
1603 | |||
1591 | return 1-(0 in [x in checklist for x in candidates]) |
|
1604 | return 1-(0 in [x in checklist for x in candidates]) | |
1592 |
|
1605 | |||
1593 | #---------------------------------------------------------------------------- |
|
1606 | #---------------------------------------------------------------------------- | |
1594 | def sort_compare(lst1,lst2,inplace = 1): |
|
1607 | def sort_compare(lst1,lst2,inplace = 1): | |
1595 | """Sort and compare two lists. |
|
1608 | """Sort and compare two lists. | |
1596 |
|
1609 | |||
1597 | By default it does it in place, thus modifying the lists. Use inplace = 0 |
|
1610 | By default it does it in place, thus modifying the lists. Use inplace = 0 | |
1598 | to avoid that (at the cost of temporary copy creation).""" |
|
1611 | to avoid that (at the cost of temporary copy creation).""" | |
1599 | if not inplace: |
|
1612 | if not inplace: | |
1600 | lst1 = lst1[:] |
|
1613 | lst1 = lst1[:] | |
1601 | lst2 = lst2[:] |
|
1614 | lst2 = lst2[:] | |
1602 | lst1.sort(); lst2.sort() |
|
1615 | lst1.sort(); lst2.sort() | |
1603 | return lst1 == lst2 |
|
1616 | return lst1 == lst2 | |
1604 |
|
1617 | |||
1605 | #---------------------------------------------------------------------------- |
|
1618 | #---------------------------------------------------------------------------- | |
1606 | def mkdict(**kwargs): |
|
1619 | def mkdict(**kwargs): | |
1607 | """Return a dict from a keyword list. |
|
1620 | """Return a dict from a keyword list. | |
1608 |
|
1621 | |||
1609 | It's just syntactic sugar for making ditcionary creation more convenient: |
|
1622 | It's just syntactic sugar for making ditcionary creation more convenient: | |
1610 | # the standard way |
|
1623 | # the standard way | |
1611 | >>>data = { 'red' : 1, 'green' : 2, 'blue' : 3 } |
|
1624 | >>>data = { 'red' : 1, 'green' : 2, 'blue' : 3 } | |
1612 | # a cleaner way |
|
1625 | # a cleaner way | |
1613 | >>>data = dict(red=1, green=2, blue=3) |
|
1626 | >>>data = dict(red=1, green=2, blue=3) | |
1614 |
|
1627 | |||
1615 | If you need more than this, look at the Struct() class.""" |
|
1628 | If you need more than this, look at the Struct() class.""" | |
1616 |
|
1629 | |||
1617 | return kwargs |
|
1630 | return kwargs | |
1618 |
|
1631 | |||
1619 | #---------------------------------------------------------------------------- |
|
1632 | #---------------------------------------------------------------------------- | |
1620 | def list2dict(lst): |
|
1633 | def list2dict(lst): | |
1621 | """Takes a list of (key,value) pairs and turns it into a dict.""" |
|
1634 | """Takes a list of (key,value) pairs and turns it into a dict.""" | |
1622 |
|
1635 | |||
1623 | dic = {} |
|
1636 | dic = {} | |
1624 | for k,v in lst: dic[k] = v |
|
1637 | for k,v in lst: dic[k] = v | |
1625 | return dic |
|
1638 | return dic | |
1626 |
|
1639 | |||
1627 | #---------------------------------------------------------------------------- |
|
1640 | #---------------------------------------------------------------------------- | |
1628 | def list2dict2(lst,default=''): |
|
1641 | def list2dict2(lst,default=''): | |
1629 | """Takes a list and turns it into a dict. |
|
1642 | """Takes a list and turns it into a dict. | |
1630 | Much slower than list2dict, but more versatile. This version can take |
|
1643 | Much slower than list2dict, but more versatile. This version can take | |
1631 | lists with sublists of arbitrary length (including sclars).""" |
|
1644 | lists with sublists of arbitrary length (including sclars).""" | |
1632 |
|
1645 | |||
1633 | dic = {} |
|
1646 | dic = {} | |
1634 | for elem in lst: |
|
1647 | for elem in lst: | |
1635 | if type(elem) in (types.ListType,types.TupleType): |
|
1648 | if type(elem) in (types.ListType,types.TupleType): | |
1636 | size = len(elem) |
|
1649 | size = len(elem) | |
1637 | if size == 0: |
|
1650 | if size == 0: | |
1638 | pass |
|
1651 | pass | |
1639 | elif size == 1: |
|
1652 | elif size == 1: | |
1640 | dic[elem] = default |
|
1653 | dic[elem] = default | |
1641 | else: |
|
1654 | else: | |
1642 | k,v = elem[0], elem[1:] |
|
1655 | k,v = elem[0], elem[1:] | |
1643 | if len(v) == 1: v = v[0] |
|
1656 | if len(v) == 1: v = v[0] | |
1644 | dic[k] = v |
|
1657 | dic[k] = v | |
1645 | else: |
|
1658 | else: | |
1646 | dic[elem] = default |
|
1659 | dic[elem] = default | |
1647 | return dic |
|
1660 | return dic | |
1648 |
|
1661 | |||
1649 | #---------------------------------------------------------------------------- |
|
1662 | #---------------------------------------------------------------------------- | |
1650 | def flatten(seq): |
|
1663 | def flatten(seq): | |
1651 | """Flatten a list of lists (NOT recursive, only works for 2d lists).""" |
|
1664 | """Flatten a list of lists (NOT recursive, only works for 2d lists).""" | |
1652 |
|
1665 | |||
1653 | return [x for subseq in seq for x in subseq] |
|
1666 | return [x for subseq in seq for x in subseq] | |
1654 |
|
1667 | |||
1655 | #---------------------------------------------------------------------------- |
|
1668 | #---------------------------------------------------------------------------- | |
1656 | def get_slice(seq,start=0,stop=None,step=1): |
|
1669 | def get_slice(seq,start=0,stop=None,step=1): | |
1657 | """Get a slice of a sequence with variable step. Specify start,stop,step.""" |
|
1670 | """Get a slice of a sequence with variable step. Specify start,stop,step.""" | |
1658 | if stop == None: |
|
1671 | if stop == None: | |
1659 | stop = len(seq) |
|
1672 | stop = len(seq) | |
1660 | item = lambda i: seq[i] |
|
1673 | item = lambda i: seq[i] | |
1661 | return map(item,xrange(start,stop,step)) |
|
1674 | return map(item,xrange(start,stop,step)) | |
1662 |
|
1675 | |||
1663 | #---------------------------------------------------------------------------- |
|
1676 | #---------------------------------------------------------------------------- | |
1664 | def chop(seq,size): |
|
1677 | def chop(seq,size): | |
1665 | """Chop a sequence into chunks of the given size.""" |
|
1678 | """Chop a sequence into chunks of the given size.""" | |
1666 | chunk = lambda i: seq[i:i+size] |
|
1679 | chunk = lambda i: seq[i:i+size] | |
1667 | return map(chunk,xrange(0,len(seq),size)) |
|
1680 | return map(chunk,xrange(0,len(seq),size)) | |
1668 |
|
1681 | |||
1669 | #---------------------------------------------------------------------------- |
|
1682 | #---------------------------------------------------------------------------- | |
1670 | # with is a keyword as of python 2.5, so this function is renamed to withobj |
|
1683 | # with is a keyword as of python 2.5, so this function is renamed to withobj | |
1671 | # from its old 'with' name. |
|
1684 | # from its old 'with' name. | |
1672 | def with_obj(object, **args): |
|
1685 | def with_obj(object, **args): | |
1673 | """Set multiple attributes for an object, similar to Pascal's with. |
|
1686 | """Set multiple attributes for an object, similar to Pascal's with. | |
1674 |
|
1687 | |||
1675 | Example: |
|
1688 | Example: | |
1676 | with_obj(jim, |
|
1689 | with_obj(jim, | |
1677 | born = 1960, |
|
1690 | born = 1960, | |
1678 | haircolour = 'Brown', |
|
1691 | haircolour = 'Brown', | |
1679 | eyecolour = 'Green') |
|
1692 | eyecolour = 'Green') | |
1680 |
|
1693 | |||
1681 | Credit: Greg Ewing, in |
|
1694 | Credit: Greg Ewing, in | |
1682 | http://mail.python.org/pipermail/python-list/2001-May/040703.html. |
|
1695 | http://mail.python.org/pipermail/python-list/2001-May/040703.html. | |
1683 |
|
1696 | |||
1684 | NOTE: up until IPython 0.7.2, this was called simply 'with', but 'with' |
|
1697 | NOTE: up until IPython 0.7.2, this was called simply 'with', but 'with' | |
1685 | has become a keyword for Python 2.5, so we had to rename it.""" |
|
1698 | has become a keyword for Python 2.5, so we had to rename it.""" | |
1686 |
|
1699 | |||
1687 | object.__dict__.update(args) |
|
1700 | object.__dict__.update(args) | |
1688 |
|
1701 | |||
1689 | #---------------------------------------------------------------------------- |
|
1702 | #---------------------------------------------------------------------------- | |
1690 | def setattr_list(obj,alist,nspace = None): |
|
1703 | def setattr_list(obj,alist,nspace = None): | |
1691 | """Set a list of attributes for an object taken from a namespace. |
|
1704 | """Set a list of attributes for an object taken from a namespace. | |
1692 |
|
1705 | |||
1693 | setattr_list(obj,alist,nspace) -> sets in obj all the attributes listed in |
|
1706 | setattr_list(obj,alist,nspace) -> sets in obj all the attributes listed in | |
1694 | alist with their values taken from nspace, which must be a dict (something |
|
1707 | alist with their values taken from nspace, which must be a dict (something | |
1695 | like locals() will often do) If nspace isn't given, locals() of the |
|
1708 | like locals() will often do) If nspace isn't given, locals() of the | |
1696 | *caller* is used, so in most cases you can omit it. |
|
1709 | *caller* is used, so in most cases you can omit it. | |
1697 |
|
1710 | |||
1698 | Note that alist can be given as a string, which will be automatically |
|
1711 | Note that alist can be given as a string, which will be automatically | |
1699 | split into a list on whitespace. If given as a list, it must be a list of |
|
1712 | split into a list on whitespace. If given as a list, it must be a list of | |
1700 | *strings* (the variable names themselves), not of variables.""" |
|
1713 | *strings* (the variable names themselves), not of variables.""" | |
1701 |
|
1714 | |||
1702 | # this grabs the local variables from the *previous* call frame -- that is |
|
1715 | # this grabs the local variables from the *previous* call frame -- that is | |
1703 | # the locals from the function that called setattr_list(). |
|
1716 | # the locals from the function that called setattr_list(). | |
1704 | # - snipped from weave.inline() |
|
1717 | # - snipped from weave.inline() | |
1705 | if nspace is None: |
|
1718 | if nspace is None: | |
1706 | call_frame = sys._getframe().f_back |
|
1719 | call_frame = sys._getframe().f_back | |
1707 | nspace = call_frame.f_locals |
|
1720 | nspace = call_frame.f_locals | |
1708 |
|
1721 | |||
1709 | if type(alist) in StringTypes: |
|
1722 | if type(alist) in StringTypes: | |
1710 | alist = alist.split() |
|
1723 | alist = alist.split() | |
1711 | for attr in alist: |
|
1724 | for attr in alist: | |
1712 | val = eval(attr,nspace) |
|
1725 | val = eval(attr,nspace) | |
1713 | setattr(obj,attr,val) |
|
1726 | setattr(obj,attr,val) | |
1714 |
|
1727 | |||
1715 | #---------------------------------------------------------------------------- |
|
1728 | #---------------------------------------------------------------------------- | |
1716 | def getattr_list(obj,alist,*args): |
|
1729 | def getattr_list(obj,alist,*args): | |
1717 | """getattr_list(obj,alist[, default]) -> attribute list. |
|
1730 | """getattr_list(obj,alist[, default]) -> attribute list. | |
1718 |
|
1731 | |||
1719 | Get a list of named attributes for an object. When a default argument is |
|
1732 | Get a list of named attributes for an object. When a default argument is | |
1720 | given, it is returned when the attribute doesn't exist; without it, an |
|
1733 | given, it is returned when the attribute doesn't exist; without it, an | |
1721 | exception is raised in that case. |
|
1734 | exception is raised in that case. | |
1722 |
|
1735 | |||
1723 | Note that alist can be given as a string, which will be automatically |
|
1736 | Note that alist can be given as a string, which will be automatically | |
1724 | split into a list on whitespace. If given as a list, it must be a list of |
|
1737 | split into a list on whitespace. If given as a list, it must be a list of | |
1725 | *strings* (the variable names themselves), not of variables.""" |
|
1738 | *strings* (the variable names themselves), not of variables.""" | |
1726 |
|
1739 | |||
1727 | if type(alist) in StringTypes: |
|
1740 | if type(alist) in StringTypes: | |
1728 | alist = alist.split() |
|
1741 | alist = alist.split() | |
1729 | if args: |
|
1742 | if args: | |
1730 | if len(args)==1: |
|
1743 | if len(args)==1: | |
1731 | default = args[0] |
|
1744 | default = args[0] | |
1732 | return map(lambda attr: getattr(obj,attr,default),alist) |
|
1745 | return map(lambda attr: getattr(obj,attr,default),alist) | |
1733 | else: |
|
1746 | else: | |
1734 | raise ValueError,'getattr_list() takes only one optional argument' |
|
1747 | raise ValueError,'getattr_list() takes only one optional argument' | |
1735 | else: |
|
1748 | else: | |
1736 | return map(lambda attr: getattr(obj,attr),alist) |
|
1749 | return map(lambda attr: getattr(obj,attr),alist) | |
1737 |
|
1750 | |||
1738 | #---------------------------------------------------------------------------- |
|
1751 | #---------------------------------------------------------------------------- | |
1739 | def map_method(method,object_list,*argseq,**kw): |
|
1752 | def map_method(method,object_list,*argseq,**kw): | |
1740 | """map_method(method,object_list,*args,**kw) -> list |
|
1753 | """map_method(method,object_list,*args,**kw) -> list | |
1741 |
|
1754 | |||
1742 | Return a list of the results of applying the methods to the items of the |
|
1755 | Return a list of the results of applying the methods to the items of the | |
1743 | argument sequence(s). If more than one sequence is given, the method is |
|
1756 | argument sequence(s). If more than one sequence is given, the method is | |
1744 | called with an argument list consisting of the corresponding item of each |
|
1757 | called with an argument list consisting of the corresponding item of each | |
1745 | sequence. All sequences must be of the same length. |
|
1758 | sequence. All sequences must be of the same length. | |
1746 |
|
1759 | |||
1747 | Keyword arguments are passed verbatim to all objects called. |
|
1760 | Keyword arguments are passed verbatim to all objects called. | |
1748 |
|
1761 | |||
1749 | This is Python code, so it's not nearly as fast as the builtin map().""" |
|
1762 | This is Python code, so it's not nearly as fast as the builtin map().""" | |
1750 |
|
1763 | |||
1751 | out_list = [] |
|
1764 | out_list = [] | |
1752 | idx = 0 |
|
1765 | idx = 0 | |
1753 | for object in object_list: |
|
1766 | for object in object_list: | |
1754 | try: |
|
1767 | try: | |
1755 | handler = getattr(object, method) |
|
1768 | handler = getattr(object, method) | |
1756 | except AttributeError: |
|
1769 | except AttributeError: | |
1757 | out_list.append(None) |
|
1770 | out_list.append(None) | |
1758 | else: |
|
1771 | else: | |
1759 | if argseq: |
|
1772 | if argseq: | |
1760 | args = map(lambda lst:lst[idx],argseq) |
|
1773 | args = map(lambda lst:lst[idx],argseq) | |
1761 | #print 'ob',object,'hand',handler,'ar',args # dbg |
|
1774 | #print 'ob',object,'hand',handler,'ar',args # dbg | |
1762 | out_list.append(handler(args,**kw)) |
|
1775 | out_list.append(handler(args,**kw)) | |
1763 | else: |
|
1776 | else: | |
1764 | out_list.append(handler(**kw)) |
|
1777 | out_list.append(handler(**kw)) | |
1765 | idx += 1 |
|
1778 | idx += 1 | |
1766 | return out_list |
|
1779 | return out_list | |
1767 |
|
1780 | |||
1768 | #---------------------------------------------------------------------------- |
|
1781 | #---------------------------------------------------------------------------- | |
1769 | def get_class_members(cls): |
|
1782 | def get_class_members(cls): | |
1770 | ret = dir(cls) |
|
1783 | ret = dir(cls) | |
1771 | if hasattr(cls,'__bases__'): |
|
1784 | if hasattr(cls,'__bases__'): | |
1772 | for base in cls.__bases__: |
|
1785 | for base in cls.__bases__: | |
1773 | ret.extend(get_class_members(base)) |
|
1786 | ret.extend(get_class_members(base)) | |
1774 | return ret |
|
1787 | return ret | |
1775 |
|
1788 | |||
1776 | #---------------------------------------------------------------------------- |
|
1789 | #---------------------------------------------------------------------------- | |
1777 | def dir2(obj): |
|
1790 | def dir2(obj): | |
1778 | """dir2(obj) -> list of strings |
|
1791 | """dir2(obj) -> list of strings | |
1779 |
|
1792 | |||
1780 | Extended version of the Python builtin dir(), which does a few extra |
|
1793 | Extended version of the Python builtin dir(), which does a few extra | |
1781 | checks, and supports common objects with unusual internals that confuse |
|
1794 | checks, and supports common objects with unusual internals that confuse | |
1782 | dir(), such as Traits and PyCrust. |
|
1795 | dir(), such as Traits and PyCrust. | |
1783 |
|
1796 | |||
1784 | This version is guaranteed to return only a list of true strings, whereas |
|
1797 | This version is guaranteed to return only a list of true strings, whereas | |
1785 | dir() returns anything that objects inject into themselves, even if they |
|
1798 | dir() returns anything that objects inject into themselves, even if they | |
1786 | are later not really valid for attribute access (many extension libraries |
|
1799 | are later not really valid for attribute access (many extension libraries | |
1787 | have such bugs). |
|
1800 | have such bugs). | |
1788 | """ |
|
1801 | """ | |
1789 |
|
1802 | |||
1790 | # Start building the attribute list via dir(), and then complete it |
|
1803 | # Start building the attribute list via dir(), and then complete it | |
1791 | # with a few extra special-purpose calls. |
|
1804 | # with a few extra special-purpose calls. | |
1792 | words = dir(obj) |
|
1805 | words = dir(obj) | |
1793 |
|
1806 | |||
1794 | if hasattr(obj,'__class__'): |
|
1807 | if hasattr(obj,'__class__'): | |
1795 | words.append('__class__') |
|
1808 | words.append('__class__') | |
1796 | words.extend(get_class_members(obj.__class__)) |
|
1809 | words.extend(get_class_members(obj.__class__)) | |
1797 | #if '__base__' in words: 1/0 |
|
1810 | #if '__base__' in words: 1/0 | |
1798 |
|
1811 | |||
1799 | # Some libraries (such as traits) may introduce duplicates, we want to |
|
1812 | # Some libraries (such as traits) may introduce duplicates, we want to | |
1800 | # track and clean this up if it happens |
|
1813 | # track and clean this up if it happens | |
1801 | may_have_dupes = False |
|
1814 | may_have_dupes = False | |
1802 |
|
1815 | |||
1803 | # this is the 'dir' function for objects with Enthought's traits |
|
1816 | # this is the 'dir' function for objects with Enthought's traits | |
1804 | if hasattr(obj, 'trait_names'): |
|
1817 | if hasattr(obj, 'trait_names'): | |
1805 | try: |
|
1818 | try: | |
1806 | words.extend(obj.trait_names()) |
|
1819 | words.extend(obj.trait_names()) | |
1807 | may_have_dupes = True |
|
1820 | may_have_dupes = True | |
1808 | except TypeError: |
|
1821 | except TypeError: | |
1809 | # This will happen if `obj` is a class and not an instance. |
|
1822 | # This will happen if `obj` is a class and not an instance. | |
1810 | pass |
|
1823 | pass | |
1811 |
|
1824 | |||
1812 | # Support for PyCrust-style _getAttributeNames magic method. |
|
1825 | # Support for PyCrust-style _getAttributeNames magic method. | |
1813 | if hasattr(obj, '_getAttributeNames'): |
|
1826 | if hasattr(obj, '_getAttributeNames'): | |
1814 | try: |
|
1827 | try: | |
1815 | words.extend(obj._getAttributeNames()) |
|
1828 | words.extend(obj._getAttributeNames()) | |
1816 | may_have_dupes = True |
|
1829 | may_have_dupes = True | |
1817 | except TypeError: |
|
1830 | except TypeError: | |
1818 | # `obj` is a class and not an instance. Ignore |
|
1831 | # `obj` is a class and not an instance. Ignore | |
1819 | # this error. |
|
1832 | # this error. | |
1820 | pass |
|
1833 | pass | |
1821 |
|
1834 | |||
1822 | if may_have_dupes: |
|
1835 | if may_have_dupes: | |
1823 | # eliminate possible duplicates, as some traits may also |
|
1836 | # eliminate possible duplicates, as some traits may also | |
1824 | # appear as normal attributes in the dir() call. |
|
1837 | # appear as normal attributes in the dir() call. | |
1825 | words = list(set(words)) |
|
1838 | words = list(set(words)) | |
1826 | words.sort() |
|
1839 | words.sort() | |
1827 |
|
1840 | |||
1828 | # filter out non-string attributes which may be stuffed by dir() calls |
|
1841 | # filter out non-string attributes which may be stuffed by dir() calls | |
1829 | # and poor coding in third-party modules |
|
1842 | # and poor coding in third-party modules | |
1830 | return [w for w in words if isinstance(w, basestring)] |
|
1843 | return [w for w in words if isinstance(w, basestring)] | |
1831 |
|
1844 | |||
1832 | #---------------------------------------------------------------------------- |
|
1845 | #---------------------------------------------------------------------------- | |
1833 | def import_fail_info(mod_name,fns=None): |
|
1846 | def import_fail_info(mod_name,fns=None): | |
1834 | """Inform load failure for a module.""" |
|
1847 | """Inform load failure for a module.""" | |
1835 |
|
1848 | |||
1836 | if fns == None: |
|
1849 | if fns == None: | |
1837 | warn("Loading of %s failed.\n" % (mod_name,)) |
|
1850 | warn("Loading of %s failed.\n" % (mod_name,)) | |
1838 | else: |
|
1851 | else: | |
1839 | warn("Loading of %s from %s failed.\n" % (fns,mod_name)) |
|
1852 | warn("Loading of %s from %s failed.\n" % (fns,mod_name)) | |
1840 |
|
1853 | |||
1841 | #---------------------------------------------------------------------------- |
|
1854 | #---------------------------------------------------------------------------- | |
1842 | # Proposed popitem() extension, written as a method |
|
1855 | # Proposed popitem() extension, written as a method | |
1843 |
|
1856 | |||
1844 |
|
1857 | |||
1845 | class NotGiven: pass |
|
1858 | class NotGiven: pass | |
1846 |
|
1859 | |||
1847 | def popkey(dct,key,default=NotGiven): |
|
1860 | def popkey(dct,key,default=NotGiven): | |
1848 | """Return dct[key] and delete dct[key]. |
|
1861 | """Return dct[key] and delete dct[key]. | |
1849 |
|
1862 | |||
1850 | If default is given, return it if dct[key] doesn't exist, otherwise raise |
|
1863 | If default is given, return it if dct[key] doesn't exist, otherwise raise | |
1851 | KeyError. """ |
|
1864 | KeyError. """ | |
1852 |
|
1865 | |||
1853 | try: |
|
1866 | try: | |
1854 | val = dct[key] |
|
1867 | val = dct[key] | |
1855 | except KeyError: |
|
1868 | except KeyError: | |
1856 | if default is NotGiven: |
|
1869 | if default is NotGiven: | |
1857 | raise |
|
1870 | raise | |
1858 | else: |
|
1871 | else: | |
1859 | return default |
|
1872 | return default | |
1860 | else: |
|
1873 | else: | |
1861 | del dct[key] |
|
1874 | del dct[key] | |
1862 | return val |
|
1875 | return val | |
1863 |
|
1876 | |||
1864 | def wrap_deprecated(func, suggest = '<nothing>'): |
|
1877 | def wrap_deprecated(func, suggest = '<nothing>'): | |
1865 | def newFunc(*args, **kwargs): |
|
1878 | def newFunc(*args, **kwargs): | |
1866 | warnings.warn("Call to deprecated function %s, use %s instead" % |
|
1879 | warnings.warn("Call to deprecated function %s, use %s instead" % | |
1867 | ( func.__name__, suggest), |
|
1880 | ( func.__name__, suggest), | |
1868 | category=DeprecationWarning, |
|
1881 | category=DeprecationWarning, | |
1869 | stacklevel = 2) |
|
1882 | stacklevel = 2) | |
1870 | return func(*args, **kwargs) |
|
1883 | return func(*args, **kwargs) | |
1871 | return newFunc |
|
1884 | return newFunc | |
1872 |
|
1885 | |||
1873 | #*************************** end of file <genutils.py> ********************** |
|
1886 | #*************************** end of file <genutils.py> ********************** | |
1874 |
|
1887 |
1 | NO CONTENT: modified file |
|
NO CONTENT: modified file | ||
The requested commit or file is too big and content was truncated. Show full diff |
General Comments 0
You need to be logged in to leave comments.
Login now