Show More
@@ -1,3681 +1,3682 b'' | |||||
1 | # encoding: utf-8 |
|
1 | # encoding: utf-8 | |
2 | """Magic functions for InteractiveShell. |
|
2 | """Magic functions for InteractiveShell. | |
3 | """ |
|
3 | """ | |
4 |
|
4 | |||
5 | #----------------------------------------------------------------------------- |
|
5 | #----------------------------------------------------------------------------- | |
6 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and |
|
6 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and | |
7 | # Copyright (C) 2001-2007 Fernando Perez <fperez@colorado.edu> |
|
7 | # Copyright (C) 2001-2007 Fernando Perez <fperez@colorado.edu> | |
8 | # Copyright (C) 2008-2011 The IPython Development Team |
|
8 | # Copyright (C) 2008-2011 The IPython Development Team | |
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 | # Imports |
|
15 | # Imports | |
16 | #----------------------------------------------------------------------------- |
|
16 | #----------------------------------------------------------------------------- | |
17 |
|
17 | |||
18 | import __builtin__ as builtin_mod |
|
18 | import __builtin__ as builtin_mod | |
19 | import __future__ |
|
19 | import __future__ | |
20 | import bdb |
|
20 | import bdb | |
21 | import inspect |
|
21 | import inspect | |
22 | import imp |
|
22 | import imp | |
23 | import os |
|
23 | import os | |
24 | import sys |
|
24 | import sys | |
25 | import shutil |
|
25 | import shutil | |
26 | import re |
|
26 | import re | |
27 | import time |
|
27 | import time | |
28 | from StringIO import StringIO |
|
28 | from StringIO import StringIO | |
29 | from getopt import getopt,GetoptError |
|
29 | from getopt import getopt,GetoptError | |
30 | from pprint import pformat |
|
30 | from pprint import pformat | |
31 | from xmlrpclib import ServerProxy |
|
31 | from xmlrpclib import ServerProxy | |
32 |
|
32 | |||
33 | # cProfile was added in Python2.5 |
|
33 | # cProfile was added in Python2.5 | |
34 | try: |
|
34 | try: | |
35 | import cProfile as profile |
|
35 | import cProfile as profile | |
36 | import pstats |
|
36 | import pstats | |
37 | except ImportError: |
|
37 | except ImportError: | |
38 | # profile isn't bundled by default in Debian for license reasons |
|
38 | # profile isn't bundled by default in Debian for license reasons | |
39 | try: |
|
39 | try: | |
40 | import profile,pstats |
|
40 | import profile,pstats | |
41 | except ImportError: |
|
41 | except ImportError: | |
42 | profile = pstats = None |
|
42 | profile = pstats = None | |
43 |
|
43 | |||
44 | import IPython |
|
44 | import IPython | |
45 | from IPython.core import debugger, oinspect |
|
45 | from IPython.core import debugger, oinspect | |
46 | from IPython.core.error import TryNext |
|
46 | from IPython.core.error import TryNext | |
47 | from IPython.core.error import UsageError |
|
47 | from IPython.core.error import UsageError | |
48 | from IPython.core.fakemodule import FakeModule |
|
48 | from IPython.core.fakemodule import FakeModule | |
49 | from IPython.core.profiledir import ProfileDir |
|
49 | from IPython.core.profiledir import ProfileDir | |
50 | from IPython.core.macro import Macro |
|
50 | from IPython.core.macro import Macro | |
51 | from IPython.core import magic_arguments, page |
|
51 | from IPython.core import magic_arguments, page | |
52 | from IPython.core.prefilter import ESC_MAGIC |
|
52 | from IPython.core.prefilter import ESC_MAGIC | |
53 | from IPython.core.pylabtools import mpl_runner |
|
53 | from IPython.core.pylabtools import mpl_runner | |
54 | from IPython.testing.skipdoctest import skip_doctest |
|
54 | from IPython.testing.skipdoctest import skip_doctest | |
55 | from IPython.utils import py3compat |
|
55 | from IPython.utils import py3compat | |
56 | from IPython.utils.io import file_read, nlprint |
|
56 | from IPython.utils.io import file_read, nlprint | |
57 | from IPython.utils.module_paths import find_mod |
|
57 | from IPython.utils.module_paths import find_mod | |
58 | from IPython.utils.path import get_py_filename, unquote_filename |
|
58 | from IPython.utils.path import get_py_filename, unquote_filename | |
59 | from IPython.utils.process import arg_split, abbrev_cwd |
|
59 | from IPython.utils.process import arg_split, abbrev_cwd | |
60 | from IPython.utils.terminal import set_term_title |
|
60 | from IPython.utils.terminal import set_term_title | |
61 | from IPython.utils.text import LSString, SList, format_screen |
|
61 | from IPython.utils.text import LSString, SList, format_screen | |
62 | from IPython.utils.timing import clock, clock2 |
|
62 | from IPython.utils.timing import clock, clock2 | |
63 | from IPython.utils.warn import warn, error |
|
63 | from IPython.utils.warn import warn, error | |
64 | from IPython.utils.ipstruct import Struct |
|
64 | from IPython.utils.ipstruct import Struct | |
65 | from IPython.config.application import Application |
|
65 | from IPython.config.application import Application | |
66 |
|
66 | |||
67 | #----------------------------------------------------------------------------- |
|
67 | #----------------------------------------------------------------------------- | |
68 | # Utility functions |
|
68 | # Utility functions | |
69 | #----------------------------------------------------------------------------- |
|
69 | #----------------------------------------------------------------------------- | |
70 |
|
70 | |||
71 | def on_off(tag): |
|
71 | def on_off(tag): | |
72 | """Return an ON/OFF string for a 1/0 input. Simple utility function.""" |
|
72 | """Return an ON/OFF string for a 1/0 input. Simple utility function.""" | |
73 | return ['OFF','ON'][tag] |
|
73 | return ['OFF','ON'][tag] | |
74 |
|
74 | |||
75 | class Bunch: pass |
|
75 | class Bunch: pass | |
76 |
|
76 | |||
77 | def compress_dhist(dh): |
|
77 | def compress_dhist(dh): | |
78 | head, tail = dh[:-10], dh[-10:] |
|
78 | head, tail = dh[:-10], dh[-10:] | |
79 |
|
79 | |||
80 | newhead = [] |
|
80 | newhead = [] | |
81 | done = set() |
|
81 | done = set() | |
82 | for h in head: |
|
82 | for h in head: | |
83 | if h in done: |
|
83 | if h in done: | |
84 | continue |
|
84 | continue | |
85 | newhead.append(h) |
|
85 | newhead.append(h) | |
86 | done.add(h) |
|
86 | done.add(h) | |
87 |
|
87 | |||
88 | return newhead + tail |
|
88 | return newhead + tail | |
89 |
|
89 | |||
90 | def needs_local_scope(func): |
|
90 | def needs_local_scope(func): | |
91 | """Decorator to mark magic functions which need to local scope to run.""" |
|
91 | """Decorator to mark magic functions which need to local scope to run.""" | |
92 | func.needs_local_scope = True |
|
92 | func.needs_local_scope = True | |
93 | return func |
|
93 | return func | |
94 |
|
94 | |||
95 |
|
95 | |||
96 | # Used for exception handling in magic_edit |
|
96 | # Used for exception handling in magic_edit | |
97 | class MacroToEdit(ValueError): pass |
|
97 | class MacroToEdit(ValueError): pass | |
98 |
|
98 | |||
99 | #*************************************************************************** |
|
99 | #*************************************************************************** | |
100 | # Main class implementing Magic functionality |
|
100 | # Main class implementing Magic functionality | |
101 |
|
101 | |||
102 | # XXX - for some odd reason, if Magic is made a new-style class, we get errors |
|
102 | # XXX - for some odd reason, if Magic is made a new-style class, we get errors | |
103 | # on construction of the main InteractiveShell object. Something odd is going |
|
103 | # on construction of the main InteractiveShell object. Something odd is going | |
104 | # on with super() calls, Configurable and the MRO... For now leave it as-is, but |
|
104 | # on with super() calls, Configurable and the MRO... For now leave it as-is, but | |
105 | # eventually this needs to be clarified. |
|
105 | # eventually this needs to be clarified. | |
106 | # BG: This is because InteractiveShell inherits from this, but is itself a |
|
106 | # BG: This is because InteractiveShell inherits from this, but is itself a | |
107 | # Configurable. This messes up the MRO in some way. The fix is that we need to |
|
107 | # Configurable. This messes up the MRO in some way. The fix is that we need to | |
108 | # make Magic a configurable that InteractiveShell does not subclass. |
|
108 | # make Magic a configurable that InteractiveShell does not subclass. | |
109 |
|
109 | |||
110 | class Magic: |
|
110 | class Magic: | |
111 | """Magic functions for InteractiveShell. |
|
111 | """Magic functions for InteractiveShell. | |
112 |
|
112 | |||
113 | Shell functions which can be reached as %function_name. All magic |
|
113 | Shell functions which can be reached as %function_name. All magic | |
114 | functions should accept a string, which they can parse for their own |
|
114 | functions should accept a string, which they can parse for their own | |
115 | needs. This can make some functions easier to type, eg `%cd ../` |
|
115 | needs. This can make some functions easier to type, eg `%cd ../` | |
116 | vs. `%cd("../")` |
|
116 | vs. `%cd("../")` | |
117 |
|
117 | |||
118 | ALL definitions MUST begin with the prefix magic_. The user won't need it |
|
118 | ALL definitions MUST begin with the prefix magic_. The user won't need it | |
119 | at the command line, but it is is needed in the definition. """ |
|
119 | at the command line, but it is is needed in the definition. """ | |
120 |
|
120 | |||
121 | # class globals |
|
121 | # class globals | |
122 | auto_status = ['Automagic is OFF, % prefix IS needed for magic functions.', |
|
122 | auto_status = ['Automagic is OFF, % prefix IS needed for magic functions.', | |
123 | 'Automagic is ON, % prefix NOT needed for magic functions.'] |
|
123 | 'Automagic is ON, % prefix NOT needed for magic functions.'] | |
124 |
|
124 | |||
125 |
|
125 | |||
126 | configurables = None |
|
126 | configurables = None | |
127 | #...................................................................... |
|
127 | #...................................................................... | |
128 | # some utility functions |
|
128 | # some utility functions | |
129 |
|
129 | |||
130 | def __init__(self,shell): |
|
130 | def __init__(self,shell): | |
131 |
|
131 | |||
132 | self.options_table = {} |
|
132 | self.options_table = {} | |
133 | if profile is None: |
|
133 | if profile is None: | |
134 | self.magic_prun = self.profile_missing_notice |
|
134 | self.magic_prun = self.profile_missing_notice | |
135 | self.shell = shell |
|
135 | self.shell = shell | |
136 | if self.configurables is None: |
|
136 | if self.configurables is None: | |
137 | self.configurables = [] |
|
137 | self.configurables = [] | |
138 |
|
138 | |||
139 | # namespace for holding state we may need |
|
139 | # namespace for holding state we may need | |
140 | self._magic_state = Bunch() |
|
140 | self._magic_state = Bunch() | |
141 |
|
141 | |||
142 | def profile_missing_notice(self, *args, **kwargs): |
|
142 | def profile_missing_notice(self, *args, **kwargs): | |
143 | error("""\ |
|
143 | error("""\ | |
144 | The profile module could not be found. It has been removed from the standard |
|
144 | The profile module could not be found. It has been removed from the standard | |
145 | python packages because of its non-free license. To use profiling, install the |
|
145 | python packages because of its non-free license. To use profiling, install the | |
146 | python-profiler package from non-free.""") |
|
146 | python-profiler package from non-free.""") | |
147 |
|
147 | |||
148 | def default_option(self,fn,optstr): |
|
148 | def default_option(self,fn,optstr): | |
149 | """Make an entry in the options_table for fn, with value optstr""" |
|
149 | """Make an entry in the options_table for fn, with value optstr""" | |
150 |
|
150 | |||
151 | if fn not in self.lsmagic(): |
|
151 | if fn not in self.lsmagic(): | |
152 | error("%s is not a magic function" % fn) |
|
152 | error("%s is not a magic function" % fn) | |
153 | self.options_table[fn] = optstr |
|
153 | self.options_table[fn] = optstr | |
154 |
|
154 | |||
155 | def lsmagic(self): |
|
155 | def lsmagic(self): | |
156 | """Return a list of currently available magic functions. |
|
156 | """Return a list of currently available magic functions. | |
157 |
|
157 | |||
158 | Gives a list of the bare names after mangling (['ls','cd', ...], not |
|
158 | Gives a list of the bare names after mangling (['ls','cd', ...], not | |
159 | ['magic_ls','magic_cd',...]""" |
|
159 | ['magic_ls','magic_cd',...]""" | |
160 |
|
160 | |||
161 | # FIXME. This needs a cleanup, in the way the magics list is built. |
|
161 | # FIXME. This needs a cleanup, in the way the magics list is built. | |
162 |
|
162 | |||
163 | # magics in class definition |
|
163 | # magics in class definition | |
164 | class_magic = lambda fn: fn.startswith('magic_') and \ |
|
164 | class_magic = lambda fn: fn.startswith('magic_') and \ | |
165 | callable(Magic.__dict__[fn]) |
|
165 | callable(Magic.__dict__[fn]) | |
166 | # in instance namespace (run-time user additions) |
|
166 | # in instance namespace (run-time user additions) | |
167 | inst_magic = lambda fn: fn.startswith('magic_') and \ |
|
167 | inst_magic = lambda fn: fn.startswith('magic_') and \ | |
168 | callable(self.__dict__[fn]) |
|
168 | callable(self.__dict__[fn]) | |
169 | # and bound magics by user (so they can access self): |
|
169 | # and bound magics by user (so they can access self): | |
170 | inst_bound_magic = lambda fn: fn.startswith('magic_') and \ |
|
170 | inst_bound_magic = lambda fn: fn.startswith('magic_') and \ | |
171 | callable(self.__class__.__dict__[fn]) |
|
171 | callable(self.__class__.__dict__[fn]) | |
172 | magics = filter(class_magic,Magic.__dict__.keys()) + \ |
|
172 | magics = filter(class_magic,Magic.__dict__.keys()) + \ | |
173 | filter(inst_magic,self.__dict__.keys()) + \ |
|
173 | filter(inst_magic,self.__dict__.keys()) + \ | |
174 | filter(inst_bound_magic,self.__class__.__dict__.keys()) |
|
174 | filter(inst_bound_magic,self.__class__.__dict__.keys()) | |
175 | out = [] |
|
175 | out = [] | |
176 | for fn in set(magics): |
|
176 | for fn in set(magics): | |
177 | out.append(fn.replace('magic_','',1)) |
|
177 | out.append(fn.replace('magic_','',1)) | |
178 | out.sort() |
|
178 | out.sort() | |
179 | return out |
|
179 | return out | |
180 |
|
180 | |||
181 | def extract_input_lines(self, range_str, raw=False): |
|
181 | def extract_input_lines(self, range_str, raw=False): | |
182 | """Return as a string a set of input history slices. |
|
182 | """Return as a string a set of input history slices. | |
183 |
|
183 | |||
184 | Inputs: |
|
184 | Inputs: | |
185 |
|
185 | |||
186 | - range_str: the set of slices is given as a string, like |
|
186 | - range_str: the set of slices is given as a string, like | |
187 | "~5/6-~4/2 4:8 9", since this function is for use by magic functions |
|
187 | "~5/6-~4/2 4:8 9", since this function is for use by magic functions | |
188 | which get their arguments as strings. The number before the / is the |
|
188 | which get their arguments as strings. The number before the / is the | |
189 | session number: ~n goes n back from the current session. |
|
189 | session number: ~n goes n back from the current session. | |
190 |
|
190 | |||
191 | Optional inputs: |
|
191 | Optional inputs: | |
192 |
|
192 | |||
193 | - raw(False): by default, the processed input is used. If this is |
|
193 | - raw(False): by default, the processed input is used. If this is | |
194 | true, the raw input history is used instead. |
|
194 | true, the raw input history is used instead. | |
195 |
|
195 | |||
196 | Note that slices can be called with two notations: |
|
196 | Note that slices can be called with two notations: | |
197 |
|
197 | |||
198 | N:M -> standard python form, means including items N...(M-1). |
|
198 | N:M -> standard python form, means including items N...(M-1). | |
199 |
|
199 | |||
200 | N-M -> include items N..M (closed endpoint).""" |
|
200 | N-M -> include items N..M (closed endpoint).""" | |
201 | lines = self.shell.history_manager.\ |
|
201 | lines = self.shell.history_manager.\ | |
202 | get_range_by_str(range_str, raw=raw) |
|
202 | get_range_by_str(range_str, raw=raw) | |
203 | return "\n".join(x for _, _, x in lines) |
|
203 | return "\n".join(x for _, _, x in lines) | |
204 |
|
204 | |||
205 | def arg_err(self,func): |
|
205 | def arg_err(self,func): | |
206 | """Print docstring if incorrect arguments were passed""" |
|
206 | """Print docstring if incorrect arguments were passed""" | |
207 | print 'Error in arguments:' |
|
207 | print 'Error in arguments:' | |
208 | print oinspect.getdoc(func) |
|
208 | print oinspect.getdoc(func) | |
209 |
|
209 | |||
210 | def format_latex(self,strng): |
|
210 | def format_latex(self,strng): | |
211 | """Format a string for latex inclusion.""" |
|
211 | """Format a string for latex inclusion.""" | |
212 |
|
212 | |||
213 | # Characters that need to be escaped for latex: |
|
213 | # Characters that need to be escaped for latex: | |
214 | escape_re = re.compile(r'(%|_|\$|#|&)',re.MULTILINE) |
|
214 | escape_re = re.compile(r'(%|_|\$|#|&)',re.MULTILINE) | |
215 | # Magic command names as headers: |
|
215 | # Magic command names as headers: | |
216 | cmd_name_re = re.compile(r'^(%s.*?):' % ESC_MAGIC, |
|
216 | cmd_name_re = re.compile(r'^(%s.*?):' % ESC_MAGIC, | |
217 | re.MULTILINE) |
|
217 | re.MULTILINE) | |
218 | # Magic commands |
|
218 | # Magic commands | |
219 | cmd_re = re.compile(r'(?P<cmd>%s.+?\b)(?!\}\}:)' % ESC_MAGIC, |
|
219 | cmd_re = re.compile(r'(?P<cmd>%s.+?\b)(?!\}\}:)' % ESC_MAGIC, | |
220 | re.MULTILINE) |
|
220 | re.MULTILINE) | |
221 | # Paragraph continue |
|
221 | # Paragraph continue | |
222 | par_re = re.compile(r'\\$',re.MULTILINE) |
|
222 | par_re = re.compile(r'\\$',re.MULTILINE) | |
223 |
|
223 | |||
224 | # The "\n" symbol |
|
224 | # The "\n" symbol | |
225 | newline_re = re.compile(r'\\n') |
|
225 | newline_re = re.compile(r'\\n') | |
226 |
|
226 | |||
227 | # Now build the string for output: |
|
227 | # Now build the string for output: | |
228 | #strng = cmd_name_re.sub(r'\n\\texttt{\\textsl{\\large \1}}:',strng) |
|
228 | #strng = cmd_name_re.sub(r'\n\\texttt{\\textsl{\\large \1}}:',strng) | |
229 | strng = cmd_name_re.sub(r'\n\\bigskip\n\\texttt{\\textbf{ \1}}:', |
|
229 | strng = cmd_name_re.sub(r'\n\\bigskip\n\\texttt{\\textbf{ \1}}:', | |
230 | strng) |
|
230 | strng) | |
231 | strng = cmd_re.sub(r'\\texttt{\g<cmd>}',strng) |
|
231 | strng = cmd_re.sub(r'\\texttt{\g<cmd>}',strng) | |
232 | strng = par_re.sub(r'\\\\',strng) |
|
232 | strng = par_re.sub(r'\\\\',strng) | |
233 | strng = escape_re.sub(r'\\\1',strng) |
|
233 | strng = escape_re.sub(r'\\\1',strng) | |
234 | strng = newline_re.sub(r'\\textbackslash{}n',strng) |
|
234 | strng = newline_re.sub(r'\\textbackslash{}n',strng) | |
235 | return strng |
|
235 | return strng | |
236 |
|
236 | |||
237 | def parse_options(self,arg_str,opt_str,*long_opts,**kw): |
|
237 | def parse_options(self,arg_str,opt_str,*long_opts,**kw): | |
238 | """Parse options passed to an argument string. |
|
238 | """Parse options passed to an argument string. | |
239 |
|
239 | |||
240 | The interface is similar to that of getopt(), but it returns back a |
|
240 | The interface is similar to that of getopt(), but it returns back a | |
241 | Struct with the options as keys and the stripped argument string still |
|
241 | Struct with the options as keys and the stripped argument string still | |
242 | as a string. |
|
242 | as a string. | |
243 |
|
243 | |||
244 | arg_str is quoted as a true sys.argv vector by using shlex.split. |
|
244 | arg_str is quoted as a true sys.argv vector by using shlex.split. | |
245 | This allows us to easily expand variables, glob files, quote |
|
245 | This allows us to easily expand variables, glob files, quote | |
246 | arguments, etc. |
|
246 | arguments, etc. | |
247 |
|
247 | |||
248 | Options: |
|
248 | Options: | |
249 | -mode: default 'string'. If given as 'list', the argument string is |
|
249 | -mode: default 'string'. If given as 'list', the argument string is | |
250 | returned as a list (split on whitespace) instead of a string. |
|
250 | returned as a list (split on whitespace) instead of a string. | |
251 |
|
251 | |||
252 | -list_all: put all option values in lists. Normally only options |
|
252 | -list_all: put all option values in lists. Normally only options | |
253 | appearing more than once are put in a list. |
|
253 | appearing more than once are put in a list. | |
254 |
|
254 | |||
255 | -posix (True): whether to split the input line in POSIX mode or not, |
|
255 | -posix (True): whether to split the input line in POSIX mode or not, | |
256 | as per the conventions outlined in the shlex module from the |
|
256 | as per the conventions outlined in the shlex module from the | |
257 | standard library.""" |
|
257 | standard library.""" | |
258 |
|
258 | |||
259 | # inject default options at the beginning of the input line |
|
259 | # inject default options at the beginning of the input line | |
260 | caller = sys._getframe(1).f_code.co_name.replace('magic_','') |
|
260 | caller = sys._getframe(1).f_code.co_name.replace('magic_','') | |
261 | arg_str = '%s %s' % (self.options_table.get(caller,''),arg_str) |
|
261 | arg_str = '%s %s' % (self.options_table.get(caller,''),arg_str) | |
262 |
|
262 | |||
263 | mode = kw.get('mode','string') |
|
263 | mode = kw.get('mode','string') | |
264 | if mode not in ['string','list']: |
|
264 | if mode not in ['string','list']: | |
265 | raise ValueError,'incorrect mode given: %s' % mode |
|
265 | raise ValueError,'incorrect mode given: %s' % mode | |
266 | # Get options |
|
266 | # Get options | |
267 | list_all = kw.get('list_all',0) |
|
267 | list_all = kw.get('list_all',0) | |
268 | posix = kw.get('posix', os.name == 'posix') |
|
268 | posix = kw.get('posix', os.name == 'posix') | |
|
269 | strict = kw.get('strict', True) | |||
269 |
|
270 | |||
270 | # Check if we have more than one argument to warrant extra processing: |
|
271 | # Check if we have more than one argument to warrant extra processing: | |
271 | odict = {} # Dictionary with options |
|
272 | odict = {} # Dictionary with options | |
272 | args = arg_str.split() |
|
273 | args = arg_str.split() | |
273 | if len(args) >= 1: |
|
274 | if len(args) >= 1: | |
274 | # If the list of inputs only has 0 or 1 thing in it, there's no |
|
275 | # If the list of inputs only has 0 or 1 thing in it, there's no | |
275 | # need to look for options |
|
276 | # need to look for options | |
276 | argv = arg_split(arg_str,posix) |
|
277 | argv = arg_split(arg_str, posix, strict) | |
277 | # Do regular option processing |
|
278 | # Do regular option processing | |
278 | try: |
|
279 | try: | |
279 | opts,args = getopt(argv,opt_str,*long_opts) |
|
280 | opts,args = getopt(argv,opt_str,*long_opts) | |
280 | except GetoptError,e: |
|
281 | except GetoptError,e: | |
281 | raise UsageError('%s ( allowed: "%s" %s)' % (e.msg,opt_str, |
|
282 | raise UsageError('%s ( allowed: "%s" %s)' % (e.msg,opt_str, | |
282 | " ".join(long_opts))) |
|
283 | " ".join(long_opts))) | |
283 | for o,a in opts: |
|
284 | for o,a in opts: | |
284 | if o.startswith('--'): |
|
285 | if o.startswith('--'): | |
285 | o = o[2:] |
|
286 | o = o[2:] | |
286 | else: |
|
287 | else: | |
287 | o = o[1:] |
|
288 | o = o[1:] | |
288 | try: |
|
289 | try: | |
289 | odict[o].append(a) |
|
290 | odict[o].append(a) | |
290 | except AttributeError: |
|
291 | except AttributeError: | |
291 | odict[o] = [odict[o],a] |
|
292 | odict[o] = [odict[o],a] | |
292 | except KeyError: |
|
293 | except KeyError: | |
293 | if list_all: |
|
294 | if list_all: | |
294 | odict[o] = [a] |
|
295 | odict[o] = [a] | |
295 | else: |
|
296 | else: | |
296 | odict[o] = a |
|
297 | odict[o] = a | |
297 |
|
298 | |||
298 | # Prepare opts,args for return |
|
299 | # Prepare opts,args for return | |
299 | opts = Struct(odict) |
|
300 | opts = Struct(odict) | |
300 | if mode == 'string': |
|
301 | if mode == 'string': | |
301 | args = ' '.join(args) |
|
302 | args = ' '.join(args) | |
302 |
|
303 | |||
303 | return opts,args |
|
304 | return opts,args | |
304 |
|
305 | |||
305 | #...................................................................... |
|
306 | #...................................................................... | |
306 | # And now the actual magic functions |
|
307 | # And now the actual magic functions | |
307 |
|
308 | |||
308 | # Functions for IPython shell work (vars,funcs, config, etc) |
|
309 | # Functions for IPython shell work (vars,funcs, config, etc) | |
309 | def magic_lsmagic(self, parameter_s = ''): |
|
310 | def magic_lsmagic(self, parameter_s = ''): | |
310 | """List currently available magic functions.""" |
|
311 | """List currently available magic functions.""" | |
311 | mesc = ESC_MAGIC |
|
312 | mesc = ESC_MAGIC | |
312 | print 'Available magic functions:\n'+mesc+\ |
|
313 | print 'Available magic functions:\n'+mesc+\ | |
313 | (' '+mesc).join(self.lsmagic()) |
|
314 | (' '+mesc).join(self.lsmagic()) | |
314 | print '\n' + Magic.auto_status[self.shell.automagic] |
|
315 | print '\n' + Magic.auto_status[self.shell.automagic] | |
315 | return None |
|
316 | return None | |
316 |
|
317 | |||
317 | def magic_magic(self, parameter_s = ''): |
|
318 | def magic_magic(self, parameter_s = ''): | |
318 | """Print information about the magic function system. |
|
319 | """Print information about the magic function system. | |
319 |
|
320 | |||
320 | Supported formats: -latex, -brief, -rest |
|
321 | Supported formats: -latex, -brief, -rest | |
321 | """ |
|
322 | """ | |
322 |
|
323 | |||
323 | mode = '' |
|
324 | mode = '' | |
324 | try: |
|
325 | try: | |
325 | if parameter_s.split()[0] == '-latex': |
|
326 | if parameter_s.split()[0] == '-latex': | |
326 | mode = 'latex' |
|
327 | mode = 'latex' | |
327 | if parameter_s.split()[0] == '-brief': |
|
328 | if parameter_s.split()[0] == '-brief': | |
328 | mode = 'brief' |
|
329 | mode = 'brief' | |
329 | if parameter_s.split()[0] == '-rest': |
|
330 | if parameter_s.split()[0] == '-rest': | |
330 | mode = 'rest' |
|
331 | mode = 'rest' | |
331 | rest_docs = [] |
|
332 | rest_docs = [] | |
332 | except: |
|
333 | except: | |
333 | pass |
|
334 | pass | |
334 |
|
335 | |||
335 | magic_docs = [] |
|
336 | magic_docs = [] | |
336 | for fname in self.lsmagic(): |
|
337 | for fname in self.lsmagic(): | |
337 | mname = 'magic_' + fname |
|
338 | mname = 'magic_' + fname | |
338 | for space in (Magic,self,self.__class__): |
|
339 | for space in (Magic,self,self.__class__): | |
339 | try: |
|
340 | try: | |
340 | fn = space.__dict__[mname] |
|
341 | fn = space.__dict__[mname] | |
341 | except KeyError: |
|
342 | except KeyError: | |
342 | pass |
|
343 | pass | |
343 | else: |
|
344 | else: | |
344 | break |
|
345 | break | |
345 | if mode == 'brief': |
|
346 | if mode == 'brief': | |
346 | # only first line |
|
347 | # only first line | |
347 | if fn.__doc__: |
|
348 | if fn.__doc__: | |
348 | fndoc = fn.__doc__.split('\n',1)[0] |
|
349 | fndoc = fn.__doc__.split('\n',1)[0] | |
349 | else: |
|
350 | else: | |
350 | fndoc = 'No documentation' |
|
351 | fndoc = 'No documentation' | |
351 | else: |
|
352 | else: | |
352 | if fn.__doc__: |
|
353 | if fn.__doc__: | |
353 | fndoc = fn.__doc__.rstrip() |
|
354 | fndoc = fn.__doc__.rstrip() | |
354 | else: |
|
355 | else: | |
355 | fndoc = 'No documentation' |
|
356 | fndoc = 'No documentation' | |
356 |
|
357 | |||
357 |
|
358 | |||
358 | if mode == 'rest': |
|
359 | if mode == 'rest': | |
359 | rest_docs.append('**%s%s**::\n\n\t%s\n\n' %(ESC_MAGIC, |
|
360 | rest_docs.append('**%s%s**::\n\n\t%s\n\n' %(ESC_MAGIC, | |
360 | fname,fndoc)) |
|
361 | fname,fndoc)) | |
361 |
|
362 | |||
362 | else: |
|
363 | else: | |
363 | magic_docs.append('%s%s:\n\t%s\n' %(ESC_MAGIC, |
|
364 | magic_docs.append('%s%s:\n\t%s\n' %(ESC_MAGIC, | |
364 | fname,fndoc)) |
|
365 | fname,fndoc)) | |
365 |
|
366 | |||
366 | magic_docs = ''.join(magic_docs) |
|
367 | magic_docs = ''.join(magic_docs) | |
367 |
|
368 | |||
368 | if mode == 'rest': |
|
369 | if mode == 'rest': | |
369 | return "".join(rest_docs) |
|
370 | return "".join(rest_docs) | |
370 |
|
371 | |||
371 | if mode == 'latex': |
|
372 | if mode == 'latex': | |
372 | print self.format_latex(magic_docs) |
|
373 | print self.format_latex(magic_docs) | |
373 | return |
|
374 | return | |
374 | else: |
|
375 | else: | |
375 | magic_docs = format_screen(magic_docs) |
|
376 | magic_docs = format_screen(magic_docs) | |
376 | if mode == 'brief': |
|
377 | if mode == 'brief': | |
377 | return magic_docs |
|
378 | return magic_docs | |
378 |
|
379 | |||
379 | outmsg = """ |
|
380 | outmsg = """ | |
380 | IPython's 'magic' functions |
|
381 | IPython's 'magic' functions | |
381 | =========================== |
|
382 | =========================== | |
382 |
|
383 | |||
383 | The magic function system provides a series of functions which allow you to |
|
384 | The magic function system provides a series of functions which allow you to | |
384 | control the behavior of IPython itself, plus a lot of system-type |
|
385 | control the behavior of IPython itself, plus a lot of system-type | |
385 | features. All these functions are prefixed with a % character, but parameters |
|
386 | features. All these functions are prefixed with a % character, but parameters | |
386 | are given without parentheses or quotes. |
|
387 | are given without parentheses or quotes. | |
387 |
|
388 | |||
388 | NOTE: If you have 'automagic' enabled (via the command line option or with the |
|
389 | NOTE: If you have 'automagic' enabled (via the command line option or with the | |
389 | %automagic function), you don't need to type in the % explicitly. By default, |
|
390 | %automagic function), you don't need to type in the % explicitly. By default, | |
390 | IPython ships with automagic on, so you should only rarely need the % escape. |
|
391 | IPython ships with automagic on, so you should only rarely need the % escape. | |
391 |
|
392 | |||
392 | Example: typing '%cd mydir' (without the quotes) changes you working directory |
|
393 | Example: typing '%cd mydir' (without the quotes) changes you working directory | |
393 | to 'mydir', if it exists. |
|
394 | to 'mydir', if it exists. | |
394 |
|
395 | |||
395 | For a list of the available magic functions, use %lsmagic. For a description |
|
396 | For a list of the available magic functions, use %lsmagic. For a description | |
396 | of any of them, type %magic_name?, e.g. '%cd?'. |
|
397 | of any of them, type %magic_name?, e.g. '%cd?'. | |
397 |
|
398 | |||
398 | Currently the magic system has the following functions:\n""" |
|
399 | Currently the magic system has the following functions:\n""" | |
399 |
|
400 | |||
400 | mesc = ESC_MAGIC |
|
401 | mesc = ESC_MAGIC | |
401 | outmsg = ("%s\n%s\n\nSummary of magic functions (from %slsmagic):" |
|
402 | outmsg = ("%s\n%s\n\nSummary of magic functions (from %slsmagic):" | |
402 | "\n\n%s%s\n\n%s" % (outmsg, |
|
403 | "\n\n%s%s\n\n%s" % (outmsg, | |
403 | magic_docs,mesc,mesc, |
|
404 | magic_docs,mesc,mesc, | |
404 | (' '+mesc).join(self.lsmagic()), |
|
405 | (' '+mesc).join(self.lsmagic()), | |
405 | Magic.auto_status[self.shell.automagic] ) ) |
|
406 | Magic.auto_status[self.shell.automagic] ) ) | |
406 | page.page(outmsg) |
|
407 | page.page(outmsg) | |
407 |
|
408 | |||
408 | def magic_automagic(self, parameter_s = ''): |
|
409 | def magic_automagic(self, parameter_s = ''): | |
409 | """Make magic functions callable without having to type the initial %. |
|
410 | """Make magic functions callable without having to type the initial %. | |
410 |
|
411 | |||
411 | Without argumentsl toggles on/off (when off, you must call it as |
|
412 | Without argumentsl toggles on/off (when off, you must call it as | |
412 | %automagic, of course). With arguments it sets the value, and you can |
|
413 | %automagic, of course). With arguments it sets the value, and you can | |
413 | use any of (case insensitive): |
|
414 | use any of (case insensitive): | |
414 |
|
415 | |||
415 | - on,1,True: to activate |
|
416 | - on,1,True: to activate | |
416 |
|
417 | |||
417 | - off,0,False: to deactivate. |
|
418 | - off,0,False: to deactivate. | |
418 |
|
419 | |||
419 | Note that magic functions have lowest priority, so if there's a |
|
420 | Note that magic functions have lowest priority, so if there's a | |
420 | variable whose name collides with that of a magic fn, automagic won't |
|
421 | variable whose name collides with that of a magic fn, automagic won't | |
421 | work for that function (you get the variable instead). However, if you |
|
422 | work for that function (you get the variable instead). However, if you | |
422 | delete the variable (del var), the previously shadowed magic function |
|
423 | delete the variable (del var), the previously shadowed magic function | |
423 | becomes visible to automagic again.""" |
|
424 | becomes visible to automagic again.""" | |
424 |
|
425 | |||
425 | arg = parameter_s.lower() |
|
426 | arg = parameter_s.lower() | |
426 | if parameter_s in ('on','1','true'): |
|
427 | if parameter_s in ('on','1','true'): | |
427 | self.shell.automagic = True |
|
428 | self.shell.automagic = True | |
428 | elif parameter_s in ('off','0','false'): |
|
429 | elif parameter_s in ('off','0','false'): | |
429 | self.shell.automagic = False |
|
430 | self.shell.automagic = False | |
430 | else: |
|
431 | else: | |
431 | self.shell.automagic = not self.shell.automagic |
|
432 | self.shell.automagic = not self.shell.automagic | |
432 | print '\n' + Magic.auto_status[self.shell.automagic] |
|
433 | print '\n' + Magic.auto_status[self.shell.automagic] | |
433 |
|
434 | |||
434 | @skip_doctest |
|
435 | @skip_doctest | |
435 | def magic_autocall(self, parameter_s = ''): |
|
436 | def magic_autocall(self, parameter_s = ''): | |
436 | """Make functions callable without having to type parentheses. |
|
437 | """Make functions callable without having to type parentheses. | |
437 |
|
438 | |||
438 | Usage: |
|
439 | Usage: | |
439 |
|
440 | |||
440 | %autocall [mode] |
|
441 | %autocall [mode] | |
441 |
|
442 | |||
442 | The mode can be one of: 0->Off, 1->Smart, 2->Full. If not given, the |
|
443 | The mode can be one of: 0->Off, 1->Smart, 2->Full. If not given, the | |
443 | value is toggled on and off (remembering the previous state). |
|
444 | value is toggled on and off (remembering the previous state). | |
444 |
|
445 | |||
445 | In more detail, these values mean: |
|
446 | In more detail, these values mean: | |
446 |
|
447 | |||
447 | 0 -> fully disabled |
|
448 | 0 -> fully disabled | |
448 |
|
449 | |||
449 | 1 -> active, but do not apply if there are no arguments on the line. |
|
450 | 1 -> active, but do not apply if there are no arguments on the line. | |
450 |
|
451 | |||
451 | In this mode, you get: |
|
452 | In this mode, you get: | |
452 |
|
453 | |||
453 | In [1]: callable |
|
454 | In [1]: callable | |
454 | Out[1]: <built-in function callable> |
|
455 | Out[1]: <built-in function callable> | |
455 |
|
456 | |||
456 | In [2]: callable 'hello' |
|
457 | In [2]: callable 'hello' | |
457 | ------> callable('hello') |
|
458 | ------> callable('hello') | |
458 | Out[2]: False |
|
459 | Out[2]: False | |
459 |
|
460 | |||
460 | 2 -> Active always. Even if no arguments are present, the callable |
|
461 | 2 -> Active always. Even if no arguments are present, the callable | |
461 | object is called: |
|
462 | object is called: | |
462 |
|
463 | |||
463 | In [2]: float |
|
464 | In [2]: float | |
464 | ------> float() |
|
465 | ------> float() | |
465 | Out[2]: 0.0 |
|
466 | Out[2]: 0.0 | |
466 |
|
467 | |||
467 | Note that even with autocall off, you can still use '/' at the start of |
|
468 | Note that even with autocall off, you can still use '/' at the start of | |
468 | a line to treat the first argument on the command line as a function |
|
469 | a line to treat the first argument on the command line as a function | |
469 | and add parentheses to it: |
|
470 | and add parentheses to it: | |
470 |
|
471 | |||
471 | In [8]: /str 43 |
|
472 | In [8]: /str 43 | |
472 | ------> str(43) |
|
473 | ------> str(43) | |
473 | Out[8]: '43' |
|
474 | Out[8]: '43' | |
474 |
|
475 | |||
475 | # all-random (note for auto-testing) |
|
476 | # all-random (note for auto-testing) | |
476 | """ |
|
477 | """ | |
477 |
|
478 | |||
478 | if parameter_s: |
|
479 | if parameter_s: | |
479 | arg = int(parameter_s) |
|
480 | arg = int(parameter_s) | |
480 | else: |
|
481 | else: | |
481 | arg = 'toggle' |
|
482 | arg = 'toggle' | |
482 |
|
483 | |||
483 | if not arg in (0,1,2,'toggle'): |
|
484 | if not arg in (0,1,2,'toggle'): | |
484 | error('Valid modes: (0->Off, 1->Smart, 2->Full') |
|
485 | error('Valid modes: (0->Off, 1->Smart, 2->Full') | |
485 | return |
|
486 | return | |
486 |
|
487 | |||
487 | if arg in (0,1,2): |
|
488 | if arg in (0,1,2): | |
488 | self.shell.autocall = arg |
|
489 | self.shell.autocall = arg | |
489 | else: # toggle |
|
490 | else: # toggle | |
490 | if self.shell.autocall: |
|
491 | if self.shell.autocall: | |
491 | self._magic_state.autocall_save = self.shell.autocall |
|
492 | self._magic_state.autocall_save = self.shell.autocall | |
492 | self.shell.autocall = 0 |
|
493 | self.shell.autocall = 0 | |
493 | else: |
|
494 | else: | |
494 | try: |
|
495 | try: | |
495 | self.shell.autocall = self._magic_state.autocall_save |
|
496 | self.shell.autocall = self._magic_state.autocall_save | |
496 | except AttributeError: |
|
497 | except AttributeError: | |
497 | self.shell.autocall = self._magic_state.autocall_save = 1 |
|
498 | self.shell.autocall = self._magic_state.autocall_save = 1 | |
498 |
|
499 | |||
499 | print "Automatic calling is:",['OFF','Smart','Full'][self.shell.autocall] |
|
500 | print "Automatic calling is:",['OFF','Smart','Full'][self.shell.autocall] | |
500 |
|
501 | |||
501 |
|
502 | |||
502 | def magic_page(self, parameter_s=''): |
|
503 | def magic_page(self, parameter_s=''): | |
503 | """Pretty print the object and display it through a pager. |
|
504 | """Pretty print the object and display it through a pager. | |
504 |
|
505 | |||
505 | %page [options] OBJECT |
|
506 | %page [options] OBJECT | |
506 |
|
507 | |||
507 | If no object is given, use _ (last output). |
|
508 | If no object is given, use _ (last output). | |
508 |
|
509 | |||
509 | Options: |
|
510 | Options: | |
510 |
|
511 | |||
511 | -r: page str(object), don't pretty-print it.""" |
|
512 | -r: page str(object), don't pretty-print it.""" | |
512 |
|
513 | |||
513 | # After a function contributed by Olivier Aubert, slightly modified. |
|
514 | # After a function contributed by Olivier Aubert, slightly modified. | |
514 |
|
515 | |||
515 | # Process options/args |
|
516 | # Process options/args | |
516 | opts,args = self.parse_options(parameter_s,'r') |
|
517 | opts,args = self.parse_options(parameter_s,'r') | |
517 | raw = 'r' in opts |
|
518 | raw = 'r' in opts | |
518 |
|
519 | |||
519 | oname = args and args or '_' |
|
520 | oname = args and args or '_' | |
520 | info = self._ofind(oname) |
|
521 | info = self._ofind(oname) | |
521 | if info['found']: |
|
522 | if info['found']: | |
522 | txt = (raw and str or pformat)( info['obj'] ) |
|
523 | txt = (raw and str or pformat)( info['obj'] ) | |
523 | page.page(txt) |
|
524 | page.page(txt) | |
524 | else: |
|
525 | else: | |
525 | print 'Object `%s` not found' % oname |
|
526 | print 'Object `%s` not found' % oname | |
526 |
|
527 | |||
527 | def magic_profile(self, parameter_s=''): |
|
528 | def magic_profile(self, parameter_s=''): | |
528 | """Print your currently active IPython profile.""" |
|
529 | """Print your currently active IPython profile.""" | |
529 | from IPython.core.application import BaseIPythonApplication |
|
530 | from IPython.core.application import BaseIPythonApplication | |
530 | if BaseIPythonApplication.initialized(): |
|
531 | if BaseIPythonApplication.initialized(): | |
531 | print BaseIPythonApplication.instance().profile |
|
532 | print BaseIPythonApplication.instance().profile | |
532 | else: |
|
533 | else: | |
533 | error("profile is an application-level value, but you don't appear to be in an IPython application") |
|
534 | error("profile is an application-level value, but you don't appear to be in an IPython application") | |
534 |
|
535 | |||
535 | def magic_pinfo(self, parameter_s='', namespaces=None): |
|
536 | def magic_pinfo(self, parameter_s='', namespaces=None): | |
536 | """Provide detailed information about an object. |
|
537 | """Provide detailed information about an object. | |
537 |
|
538 | |||
538 | '%pinfo object' is just a synonym for object? or ?object.""" |
|
539 | '%pinfo object' is just a synonym for object? or ?object.""" | |
539 |
|
540 | |||
540 | #print 'pinfo par: <%s>' % parameter_s # dbg |
|
541 | #print 'pinfo par: <%s>' % parameter_s # dbg | |
541 |
|
542 | |||
542 |
|
543 | |||
543 | # detail_level: 0 -> obj? , 1 -> obj?? |
|
544 | # detail_level: 0 -> obj? , 1 -> obj?? | |
544 | detail_level = 0 |
|
545 | detail_level = 0 | |
545 | # We need to detect if we got called as 'pinfo pinfo foo', which can |
|
546 | # We need to detect if we got called as 'pinfo pinfo foo', which can | |
546 | # happen if the user types 'pinfo foo?' at the cmd line. |
|
547 | # happen if the user types 'pinfo foo?' at the cmd line. | |
547 | pinfo,qmark1,oname,qmark2 = \ |
|
548 | pinfo,qmark1,oname,qmark2 = \ | |
548 | re.match('(pinfo )?(\?*)(.*?)(\??$)',parameter_s).groups() |
|
549 | re.match('(pinfo )?(\?*)(.*?)(\??$)',parameter_s).groups() | |
549 | if pinfo or qmark1 or qmark2: |
|
550 | if pinfo or qmark1 or qmark2: | |
550 | detail_level = 1 |
|
551 | detail_level = 1 | |
551 | if "*" in oname: |
|
552 | if "*" in oname: | |
552 | self.magic_psearch(oname) |
|
553 | self.magic_psearch(oname) | |
553 | else: |
|
554 | else: | |
554 | self.shell._inspect('pinfo', oname, detail_level=detail_level, |
|
555 | self.shell._inspect('pinfo', oname, detail_level=detail_level, | |
555 | namespaces=namespaces) |
|
556 | namespaces=namespaces) | |
556 |
|
557 | |||
557 | def magic_pinfo2(self, parameter_s='', namespaces=None): |
|
558 | def magic_pinfo2(self, parameter_s='', namespaces=None): | |
558 | """Provide extra detailed information about an object. |
|
559 | """Provide extra detailed information about an object. | |
559 |
|
560 | |||
560 | '%pinfo2 object' is just a synonym for object?? or ??object.""" |
|
561 | '%pinfo2 object' is just a synonym for object?? or ??object.""" | |
561 | self.shell._inspect('pinfo', parameter_s, detail_level=1, |
|
562 | self.shell._inspect('pinfo', parameter_s, detail_level=1, | |
562 | namespaces=namespaces) |
|
563 | namespaces=namespaces) | |
563 |
|
564 | |||
564 | @skip_doctest |
|
565 | @skip_doctest | |
565 | def magic_pdef(self, parameter_s='', namespaces=None): |
|
566 | def magic_pdef(self, parameter_s='', namespaces=None): | |
566 | """Print the definition header for any callable object. |
|
567 | """Print the definition header for any callable object. | |
567 |
|
568 | |||
568 | If the object is a class, print the constructor information. |
|
569 | If the object is a class, print the constructor information. | |
569 |
|
570 | |||
570 | Examples |
|
571 | Examples | |
571 | -------- |
|
572 | -------- | |
572 | :: |
|
573 | :: | |
573 |
|
574 | |||
574 | In [3]: %pdef urllib.urlopen |
|
575 | In [3]: %pdef urllib.urlopen | |
575 | urllib.urlopen(url, data=None, proxies=None) |
|
576 | urllib.urlopen(url, data=None, proxies=None) | |
576 | """ |
|
577 | """ | |
577 | self._inspect('pdef',parameter_s, namespaces) |
|
578 | self._inspect('pdef',parameter_s, namespaces) | |
578 |
|
579 | |||
579 | def magic_pdoc(self, parameter_s='', namespaces=None): |
|
580 | def magic_pdoc(self, parameter_s='', namespaces=None): | |
580 | """Print the docstring for an object. |
|
581 | """Print the docstring for an object. | |
581 |
|
582 | |||
582 | If the given object is a class, it will print both the class and the |
|
583 | If the given object is a class, it will print both the class and the | |
583 | constructor docstrings.""" |
|
584 | constructor docstrings.""" | |
584 | self._inspect('pdoc',parameter_s, namespaces) |
|
585 | self._inspect('pdoc',parameter_s, namespaces) | |
585 |
|
586 | |||
586 | def magic_psource(self, parameter_s='', namespaces=None): |
|
587 | def magic_psource(self, parameter_s='', namespaces=None): | |
587 | """Print (or run through pager) the source code for an object.""" |
|
588 | """Print (or run through pager) the source code for an object.""" | |
588 | self._inspect('psource',parameter_s, namespaces) |
|
589 | self._inspect('psource',parameter_s, namespaces) | |
589 |
|
590 | |||
590 | def magic_pfile(self, parameter_s=''): |
|
591 | def magic_pfile(self, parameter_s=''): | |
591 | """Print (or run through pager) the file where an object is defined. |
|
592 | """Print (or run through pager) the file where an object is defined. | |
592 |
|
593 | |||
593 | The file opens at the line where the object definition begins. IPython |
|
594 | The file opens at the line where the object definition begins. IPython | |
594 | will honor the environment variable PAGER if set, and otherwise will |
|
595 | will honor the environment variable PAGER if set, and otherwise will | |
595 | do its best to print the file in a convenient form. |
|
596 | do its best to print the file in a convenient form. | |
596 |
|
597 | |||
597 | If the given argument is not an object currently defined, IPython will |
|
598 | If the given argument is not an object currently defined, IPython will | |
598 | try to interpret it as a filename (automatically adding a .py extension |
|
599 | try to interpret it as a filename (automatically adding a .py extension | |
599 | if needed). You can thus use %pfile as a syntax highlighting code |
|
600 | if needed). You can thus use %pfile as a syntax highlighting code | |
600 | viewer.""" |
|
601 | viewer.""" | |
601 |
|
602 | |||
602 | # first interpret argument as an object name |
|
603 | # first interpret argument as an object name | |
603 | out = self._inspect('pfile',parameter_s) |
|
604 | out = self._inspect('pfile',parameter_s) | |
604 | # if not, try the input as a filename |
|
605 | # if not, try the input as a filename | |
605 | if out == 'not found': |
|
606 | if out == 'not found': | |
606 | try: |
|
607 | try: | |
607 | filename = get_py_filename(parameter_s) |
|
608 | filename = get_py_filename(parameter_s) | |
608 | except IOError,msg: |
|
609 | except IOError,msg: | |
609 | print msg |
|
610 | print msg | |
610 | return |
|
611 | return | |
611 | page.page(self.shell.inspector.format(file(filename).read())) |
|
612 | page.page(self.shell.inspector.format(file(filename).read())) | |
612 |
|
613 | |||
613 | def magic_psearch(self, parameter_s=''): |
|
614 | def magic_psearch(self, parameter_s=''): | |
614 | """Search for object in namespaces by wildcard. |
|
615 | """Search for object in namespaces by wildcard. | |
615 |
|
616 | |||
616 | %psearch [options] PATTERN [OBJECT TYPE] |
|
617 | %psearch [options] PATTERN [OBJECT TYPE] | |
617 |
|
618 | |||
618 | Note: ? can be used as a synonym for %psearch, at the beginning or at |
|
619 | Note: ? can be used as a synonym for %psearch, at the beginning or at | |
619 | the end: both a*? and ?a* are equivalent to '%psearch a*'. Still, the |
|
620 | the end: both a*? and ?a* are equivalent to '%psearch a*'. Still, the | |
620 | rest of the command line must be unchanged (options come first), so |
|
621 | rest of the command line must be unchanged (options come first), so | |
621 | for example the following forms are equivalent |
|
622 | for example the following forms are equivalent | |
622 |
|
623 | |||
623 | %psearch -i a* function |
|
624 | %psearch -i a* function | |
624 | -i a* function? |
|
625 | -i a* function? | |
625 | ?-i a* function |
|
626 | ?-i a* function | |
626 |
|
627 | |||
627 | Arguments: |
|
628 | Arguments: | |
628 |
|
629 | |||
629 | PATTERN |
|
630 | PATTERN | |
630 |
|
631 | |||
631 | where PATTERN is a string containing * as a wildcard similar to its |
|
632 | where PATTERN is a string containing * as a wildcard similar to its | |
632 | use in a shell. The pattern is matched in all namespaces on the |
|
633 | use in a shell. The pattern is matched in all namespaces on the | |
633 | search path. By default objects starting with a single _ are not |
|
634 | search path. By default objects starting with a single _ are not | |
634 | matched, many IPython generated objects have a single |
|
635 | matched, many IPython generated objects have a single | |
635 | underscore. The default is case insensitive matching. Matching is |
|
636 | underscore. The default is case insensitive matching. Matching is | |
636 | also done on the attributes of objects and not only on the objects |
|
637 | also done on the attributes of objects and not only on the objects | |
637 | in a module. |
|
638 | in a module. | |
638 |
|
639 | |||
639 | [OBJECT TYPE] |
|
640 | [OBJECT TYPE] | |
640 |
|
641 | |||
641 | Is the name of a python type from the types module. The name is |
|
642 | Is the name of a python type from the types module. The name is | |
642 | given in lowercase without the ending type, ex. StringType is |
|
643 | given in lowercase without the ending type, ex. StringType is | |
643 | written string. By adding a type here only objects matching the |
|
644 | written string. By adding a type here only objects matching the | |
644 | given type are matched. Using all here makes the pattern match all |
|
645 | given type are matched. Using all here makes the pattern match all | |
645 | types (this is the default). |
|
646 | types (this is the default). | |
646 |
|
647 | |||
647 | Options: |
|
648 | Options: | |
648 |
|
649 | |||
649 | -a: makes the pattern match even objects whose names start with a |
|
650 | -a: makes the pattern match even objects whose names start with a | |
650 | single underscore. These names are normally ommitted from the |
|
651 | single underscore. These names are normally ommitted from the | |
651 | search. |
|
652 | search. | |
652 |
|
653 | |||
653 | -i/-c: make the pattern case insensitive/sensitive. If neither of |
|
654 | -i/-c: make the pattern case insensitive/sensitive. If neither of | |
654 | these options are given, the default is read from your configuration |
|
655 | these options are given, the default is read from your configuration | |
655 | file, with the option ``InteractiveShell.wildcards_case_sensitive``. |
|
656 | file, with the option ``InteractiveShell.wildcards_case_sensitive``. | |
656 | If this option is not specified in your configuration file, IPython's |
|
657 | If this option is not specified in your configuration file, IPython's | |
657 | internal default is to do a case sensitive search. |
|
658 | internal default is to do a case sensitive search. | |
658 |
|
659 | |||
659 | -e/-s NAMESPACE: exclude/search a given namespace. The pattern you |
|
660 | -e/-s NAMESPACE: exclude/search a given namespace. The pattern you | |
660 | specifiy can be searched in any of the following namespaces: |
|
661 | specifiy can be searched in any of the following namespaces: | |
661 | 'builtin', 'user', 'user_global','internal', 'alias', where |
|
662 | 'builtin', 'user', 'user_global','internal', 'alias', where | |
662 | 'builtin' and 'user' are the search defaults. Note that you should |
|
663 | 'builtin' and 'user' are the search defaults. Note that you should | |
663 | not use quotes when specifying namespaces. |
|
664 | not use quotes when specifying namespaces. | |
664 |
|
665 | |||
665 | 'Builtin' contains the python module builtin, 'user' contains all |
|
666 | 'Builtin' contains the python module builtin, 'user' contains all | |
666 | user data, 'alias' only contain the shell aliases and no python |
|
667 | user data, 'alias' only contain the shell aliases and no python | |
667 | objects, 'internal' contains objects used by IPython. The |
|
668 | objects, 'internal' contains objects used by IPython. The | |
668 | 'user_global' namespace is only used by embedded IPython instances, |
|
669 | 'user_global' namespace is only used by embedded IPython instances, | |
669 | and it contains module-level globals. You can add namespaces to the |
|
670 | and it contains module-level globals. You can add namespaces to the | |
670 | search with -s or exclude them with -e (these options can be given |
|
671 | search with -s or exclude them with -e (these options can be given | |
671 | more than once). |
|
672 | more than once). | |
672 |
|
673 | |||
673 | Examples: |
|
674 | Examples: | |
674 |
|
675 | |||
675 | %psearch a* -> objects beginning with an a |
|
676 | %psearch a* -> objects beginning with an a | |
676 | %psearch -e builtin a* -> objects NOT in the builtin space starting in a |
|
677 | %psearch -e builtin a* -> objects NOT in the builtin space starting in a | |
677 | %psearch a* function -> all functions beginning with an a |
|
678 | %psearch a* function -> all functions beginning with an a | |
678 | %psearch re.e* -> objects beginning with an e in module re |
|
679 | %psearch re.e* -> objects beginning with an e in module re | |
679 | %psearch r*.e* -> objects that start with e in modules starting in r |
|
680 | %psearch r*.e* -> objects that start with e in modules starting in r | |
680 | %psearch r*.* string -> all strings in modules beginning with r |
|
681 | %psearch r*.* string -> all strings in modules beginning with r | |
681 |
|
682 | |||
682 | Case sensitve search: |
|
683 | Case sensitve search: | |
683 |
|
684 | |||
684 | %psearch -c a* list all object beginning with lower case a |
|
685 | %psearch -c a* list all object beginning with lower case a | |
685 |
|
686 | |||
686 | Show objects beginning with a single _: |
|
687 | Show objects beginning with a single _: | |
687 |
|
688 | |||
688 | %psearch -a _* list objects beginning with a single underscore""" |
|
689 | %psearch -a _* list objects beginning with a single underscore""" | |
689 | try: |
|
690 | try: | |
690 | parameter_s.encode('ascii') |
|
691 | parameter_s.encode('ascii') | |
691 | except UnicodeEncodeError: |
|
692 | except UnicodeEncodeError: | |
692 | print 'Python identifiers can only contain ascii characters.' |
|
693 | print 'Python identifiers can only contain ascii characters.' | |
693 | return |
|
694 | return | |
694 |
|
695 | |||
695 | # default namespaces to be searched |
|
696 | # default namespaces to be searched | |
696 | def_search = ['user_local', 'user_global', 'builtin'] |
|
697 | def_search = ['user_local', 'user_global', 'builtin'] | |
697 |
|
698 | |||
698 | # Process options/args |
|
699 | # Process options/args | |
699 | opts,args = self.parse_options(parameter_s,'cias:e:',list_all=True) |
|
700 | opts,args = self.parse_options(parameter_s,'cias:e:',list_all=True) | |
700 | opt = opts.get |
|
701 | opt = opts.get | |
701 | shell = self.shell |
|
702 | shell = self.shell | |
702 | psearch = shell.inspector.psearch |
|
703 | psearch = shell.inspector.psearch | |
703 |
|
704 | |||
704 | # select case options |
|
705 | # select case options | |
705 | if opts.has_key('i'): |
|
706 | if opts.has_key('i'): | |
706 | ignore_case = True |
|
707 | ignore_case = True | |
707 | elif opts.has_key('c'): |
|
708 | elif opts.has_key('c'): | |
708 | ignore_case = False |
|
709 | ignore_case = False | |
709 | else: |
|
710 | else: | |
710 | ignore_case = not shell.wildcards_case_sensitive |
|
711 | ignore_case = not shell.wildcards_case_sensitive | |
711 |
|
712 | |||
712 | # Build list of namespaces to search from user options |
|
713 | # Build list of namespaces to search from user options | |
713 | def_search.extend(opt('s',[])) |
|
714 | def_search.extend(opt('s',[])) | |
714 | ns_exclude = ns_exclude=opt('e',[]) |
|
715 | ns_exclude = ns_exclude=opt('e',[]) | |
715 | ns_search = [nm for nm in def_search if nm not in ns_exclude] |
|
716 | ns_search = [nm for nm in def_search if nm not in ns_exclude] | |
716 |
|
717 | |||
717 | # Call the actual search |
|
718 | # Call the actual search | |
718 | try: |
|
719 | try: | |
719 | psearch(args,shell.ns_table,ns_search, |
|
720 | psearch(args,shell.ns_table,ns_search, | |
720 | show_all=opt('a'),ignore_case=ignore_case) |
|
721 | show_all=opt('a'),ignore_case=ignore_case) | |
721 | except: |
|
722 | except: | |
722 | shell.showtraceback() |
|
723 | shell.showtraceback() | |
723 |
|
724 | |||
724 | @skip_doctest |
|
725 | @skip_doctest | |
725 | def magic_who_ls(self, parameter_s=''): |
|
726 | def magic_who_ls(self, parameter_s=''): | |
726 | """Return a sorted list of all interactive variables. |
|
727 | """Return a sorted list of all interactive variables. | |
727 |
|
728 | |||
728 | If arguments are given, only variables of types matching these |
|
729 | If arguments are given, only variables of types matching these | |
729 | arguments are returned. |
|
730 | arguments are returned. | |
730 |
|
731 | |||
731 | Examples |
|
732 | Examples | |
732 | -------- |
|
733 | -------- | |
733 |
|
734 | |||
734 | Define two variables and list them with who_ls:: |
|
735 | Define two variables and list them with who_ls:: | |
735 |
|
736 | |||
736 | In [1]: alpha = 123 |
|
737 | In [1]: alpha = 123 | |
737 |
|
738 | |||
738 | In [2]: beta = 'test' |
|
739 | In [2]: beta = 'test' | |
739 |
|
740 | |||
740 | In [3]: %who_ls |
|
741 | In [3]: %who_ls | |
741 | Out[3]: ['alpha', 'beta'] |
|
742 | Out[3]: ['alpha', 'beta'] | |
742 |
|
743 | |||
743 | In [4]: %who_ls int |
|
744 | In [4]: %who_ls int | |
744 | Out[4]: ['alpha'] |
|
745 | Out[4]: ['alpha'] | |
745 |
|
746 | |||
746 | In [5]: %who_ls str |
|
747 | In [5]: %who_ls str | |
747 | Out[5]: ['beta'] |
|
748 | Out[5]: ['beta'] | |
748 | """ |
|
749 | """ | |
749 |
|
750 | |||
750 | user_ns = self.shell.user_ns |
|
751 | user_ns = self.shell.user_ns | |
751 | user_ns_hidden = self.shell.user_ns_hidden |
|
752 | user_ns_hidden = self.shell.user_ns_hidden | |
752 | out = [ i for i in user_ns |
|
753 | out = [ i for i in user_ns | |
753 | if not i.startswith('_') \ |
|
754 | if not i.startswith('_') \ | |
754 | and not i in user_ns_hidden ] |
|
755 | and not i in user_ns_hidden ] | |
755 |
|
756 | |||
756 | typelist = parameter_s.split() |
|
757 | typelist = parameter_s.split() | |
757 | if typelist: |
|
758 | if typelist: | |
758 | typeset = set(typelist) |
|
759 | typeset = set(typelist) | |
759 | out = [i for i in out if type(user_ns[i]).__name__ in typeset] |
|
760 | out = [i for i in out if type(user_ns[i]).__name__ in typeset] | |
760 |
|
761 | |||
761 | out.sort() |
|
762 | out.sort() | |
762 | return out |
|
763 | return out | |
763 |
|
764 | |||
764 | @skip_doctest |
|
765 | @skip_doctest | |
765 | def magic_who(self, parameter_s=''): |
|
766 | def magic_who(self, parameter_s=''): | |
766 | """Print all interactive variables, with some minimal formatting. |
|
767 | """Print all interactive variables, with some minimal formatting. | |
767 |
|
768 | |||
768 | If any arguments are given, only variables whose type matches one of |
|
769 | If any arguments are given, only variables whose type matches one of | |
769 | these are printed. For example: |
|
770 | these are printed. For example: | |
770 |
|
771 | |||
771 | %who function str |
|
772 | %who function str | |
772 |
|
773 | |||
773 | will only list functions and strings, excluding all other types of |
|
774 | will only list functions and strings, excluding all other types of | |
774 | variables. To find the proper type names, simply use type(var) at a |
|
775 | variables. To find the proper type names, simply use type(var) at a | |
775 | command line to see how python prints type names. For example: |
|
776 | command line to see how python prints type names. For example: | |
776 |
|
777 | |||
777 | In [1]: type('hello')\\ |
|
778 | In [1]: type('hello')\\ | |
778 | Out[1]: <type 'str'> |
|
779 | Out[1]: <type 'str'> | |
779 |
|
780 | |||
780 | indicates that the type name for strings is 'str'. |
|
781 | indicates that the type name for strings is 'str'. | |
781 |
|
782 | |||
782 | %who always excludes executed names loaded through your configuration |
|
783 | %who always excludes executed names loaded through your configuration | |
783 | file and things which are internal to IPython. |
|
784 | file and things which are internal to IPython. | |
784 |
|
785 | |||
785 | This is deliberate, as typically you may load many modules and the |
|
786 | This is deliberate, as typically you may load many modules and the | |
786 | purpose of %who is to show you only what you've manually defined. |
|
787 | purpose of %who is to show you only what you've manually defined. | |
787 |
|
788 | |||
788 | Examples |
|
789 | Examples | |
789 | -------- |
|
790 | -------- | |
790 |
|
791 | |||
791 | Define two variables and list them with who:: |
|
792 | Define two variables and list them with who:: | |
792 |
|
793 | |||
793 | In [1]: alpha = 123 |
|
794 | In [1]: alpha = 123 | |
794 |
|
795 | |||
795 | In [2]: beta = 'test' |
|
796 | In [2]: beta = 'test' | |
796 |
|
797 | |||
797 | In [3]: %who |
|
798 | In [3]: %who | |
798 | alpha beta |
|
799 | alpha beta | |
799 |
|
800 | |||
800 | In [4]: %who int |
|
801 | In [4]: %who int | |
801 | alpha |
|
802 | alpha | |
802 |
|
803 | |||
803 | In [5]: %who str |
|
804 | In [5]: %who str | |
804 | beta |
|
805 | beta | |
805 | """ |
|
806 | """ | |
806 |
|
807 | |||
807 | varlist = self.magic_who_ls(parameter_s) |
|
808 | varlist = self.magic_who_ls(parameter_s) | |
808 | if not varlist: |
|
809 | if not varlist: | |
809 | if parameter_s: |
|
810 | if parameter_s: | |
810 | print 'No variables match your requested type.' |
|
811 | print 'No variables match your requested type.' | |
811 | else: |
|
812 | else: | |
812 | print 'Interactive namespace is empty.' |
|
813 | print 'Interactive namespace is empty.' | |
813 | return |
|
814 | return | |
814 |
|
815 | |||
815 | # if we have variables, move on... |
|
816 | # if we have variables, move on... | |
816 | count = 0 |
|
817 | count = 0 | |
817 | for i in varlist: |
|
818 | for i in varlist: | |
818 | print i+'\t', |
|
819 | print i+'\t', | |
819 | count += 1 |
|
820 | count += 1 | |
820 | if count > 8: |
|
821 | if count > 8: | |
821 | count = 0 |
|
822 | count = 0 | |
822 |
|
823 | |||
823 |
|
824 | |||
824 |
|
825 | |||
825 | @skip_doctest |
|
826 | @skip_doctest | |
826 | def magic_whos(self, parameter_s=''): |
|
827 | def magic_whos(self, parameter_s=''): | |
827 | """Like %who, but gives some extra information about each variable. |
|
828 | """Like %who, but gives some extra information about each variable. | |
828 |
|
829 | |||
829 | The same type filtering of %who can be applied here. |
|
830 | The same type filtering of %who can be applied here. | |
830 |
|
831 | |||
831 | For all variables, the type is printed. Additionally it prints: |
|
832 | For all variables, the type is printed. Additionally it prints: | |
832 |
|
833 | |||
833 | - For {},[],(): their length. |
|
834 | - For {},[],(): their length. | |
834 |
|
835 | |||
835 | - For numpy arrays, a summary with shape, number of |
|
836 | - For numpy arrays, a summary with shape, number of | |
836 | elements, typecode and size in memory. |
|
837 | elements, typecode and size in memory. | |
837 |
|
838 | |||
838 | - Everything else: a string representation, snipping their middle if |
|
839 | - Everything else: a string representation, snipping their middle if | |
839 | too long. |
|
840 | too long. | |
840 |
|
841 | |||
841 | Examples |
|
842 | Examples | |
842 | -------- |
|
843 | -------- | |
843 |
|
844 | |||
844 | Define two variables and list them with whos:: |
|
845 | Define two variables and list them with whos:: | |
845 |
|
846 | |||
846 | In [1]: alpha = 123 |
|
847 | In [1]: alpha = 123 | |
847 |
|
848 | |||
848 | In [2]: beta = 'test' |
|
849 | In [2]: beta = 'test' | |
849 |
|
850 | |||
850 | In [3]: %whos |
|
851 | In [3]: %whos | |
851 | Variable Type Data/Info |
|
852 | Variable Type Data/Info | |
852 | -------------------------------- |
|
853 | -------------------------------- | |
853 | alpha int 123 |
|
854 | alpha int 123 | |
854 | beta str test |
|
855 | beta str test | |
855 | """ |
|
856 | """ | |
856 |
|
857 | |||
857 | varnames = self.magic_who_ls(parameter_s) |
|
858 | varnames = self.magic_who_ls(parameter_s) | |
858 | if not varnames: |
|
859 | if not varnames: | |
859 | if parameter_s: |
|
860 | if parameter_s: | |
860 | print 'No variables match your requested type.' |
|
861 | print 'No variables match your requested type.' | |
861 | else: |
|
862 | else: | |
862 | print 'Interactive namespace is empty.' |
|
863 | print 'Interactive namespace is empty.' | |
863 | return |
|
864 | return | |
864 |
|
865 | |||
865 | # if we have variables, move on... |
|
866 | # if we have variables, move on... | |
866 |
|
867 | |||
867 | # for these types, show len() instead of data: |
|
868 | # for these types, show len() instead of data: | |
868 | seq_types = ['dict', 'list', 'tuple'] |
|
869 | seq_types = ['dict', 'list', 'tuple'] | |
869 |
|
870 | |||
870 | # for numpy arrays, display summary info |
|
871 | # for numpy arrays, display summary info | |
871 | ndarray_type = None |
|
872 | ndarray_type = None | |
872 | if 'numpy' in sys.modules: |
|
873 | if 'numpy' in sys.modules: | |
873 | try: |
|
874 | try: | |
874 | from numpy import ndarray |
|
875 | from numpy import ndarray | |
875 | except ImportError: |
|
876 | except ImportError: | |
876 | pass |
|
877 | pass | |
877 | else: |
|
878 | else: | |
878 | ndarray_type = ndarray.__name__ |
|
879 | ndarray_type = ndarray.__name__ | |
879 |
|
880 | |||
880 | # Find all variable names and types so we can figure out column sizes |
|
881 | # Find all variable names and types so we can figure out column sizes | |
881 | def get_vars(i): |
|
882 | def get_vars(i): | |
882 | return self.shell.user_ns[i] |
|
883 | return self.shell.user_ns[i] | |
883 |
|
884 | |||
884 | # some types are well known and can be shorter |
|
885 | # some types are well known and can be shorter | |
885 | abbrevs = {'IPython.core.macro.Macro' : 'Macro'} |
|
886 | abbrevs = {'IPython.core.macro.Macro' : 'Macro'} | |
886 | def type_name(v): |
|
887 | def type_name(v): | |
887 | tn = type(v).__name__ |
|
888 | tn = type(v).__name__ | |
888 | return abbrevs.get(tn,tn) |
|
889 | return abbrevs.get(tn,tn) | |
889 |
|
890 | |||
890 | varlist = map(get_vars,varnames) |
|
891 | varlist = map(get_vars,varnames) | |
891 |
|
892 | |||
892 | typelist = [] |
|
893 | typelist = [] | |
893 | for vv in varlist: |
|
894 | for vv in varlist: | |
894 | tt = type_name(vv) |
|
895 | tt = type_name(vv) | |
895 |
|
896 | |||
896 | if tt=='instance': |
|
897 | if tt=='instance': | |
897 | typelist.append( abbrevs.get(str(vv.__class__), |
|
898 | typelist.append( abbrevs.get(str(vv.__class__), | |
898 | str(vv.__class__))) |
|
899 | str(vv.__class__))) | |
899 | else: |
|
900 | else: | |
900 | typelist.append(tt) |
|
901 | typelist.append(tt) | |
901 |
|
902 | |||
902 | # column labels and # of spaces as separator |
|
903 | # column labels and # of spaces as separator | |
903 | varlabel = 'Variable' |
|
904 | varlabel = 'Variable' | |
904 | typelabel = 'Type' |
|
905 | typelabel = 'Type' | |
905 | datalabel = 'Data/Info' |
|
906 | datalabel = 'Data/Info' | |
906 | colsep = 3 |
|
907 | colsep = 3 | |
907 | # variable format strings |
|
908 | # variable format strings | |
908 | vformat = "{0:<{varwidth}}{1:<{typewidth}}" |
|
909 | vformat = "{0:<{varwidth}}{1:<{typewidth}}" | |
909 | aformat = "%s: %s elems, type `%s`, %s bytes" |
|
910 | aformat = "%s: %s elems, type `%s`, %s bytes" | |
910 | # find the size of the columns to format the output nicely |
|
911 | # find the size of the columns to format the output nicely | |
911 | varwidth = max(max(map(len,varnames)), len(varlabel)) + colsep |
|
912 | varwidth = max(max(map(len,varnames)), len(varlabel)) + colsep | |
912 | typewidth = max(max(map(len,typelist)), len(typelabel)) + colsep |
|
913 | typewidth = max(max(map(len,typelist)), len(typelabel)) + colsep | |
913 | # table header |
|
914 | # table header | |
914 | print varlabel.ljust(varwidth) + typelabel.ljust(typewidth) + \ |
|
915 | print varlabel.ljust(varwidth) + typelabel.ljust(typewidth) + \ | |
915 | ' '+datalabel+'\n' + '-'*(varwidth+typewidth+len(datalabel)+1) |
|
916 | ' '+datalabel+'\n' + '-'*(varwidth+typewidth+len(datalabel)+1) | |
916 | # and the table itself |
|
917 | # and the table itself | |
917 | kb = 1024 |
|
918 | kb = 1024 | |
918 | Mb = 1048576 # kb**2 |
|
919 | Mb = 1048576 # kb**2 | |
919 | for vname,var,vtype in zip(varnames,varlist,typelist): |
|
920 | for vname,var,vtype in zip(varnames,varlist,typelist): | |
920 | print vformat.format(vname, vtype, varwidth=varwidth, typewidth=typewidth), |
|
921 | print vformat.format(vname, vtype, varwidth=varwidth, typewidth=typewidth), | |
921 | if vtype in seq_types: |
|
922 | if vtype in seq_types: | |
922 | print "n="+str(len(var)) |
|
923 | print "n="+str(len(var)) | |
923 | elif vtype == ndarray_type: |
|
924 | elif vtype == ndarray_type: | |
924 | vshape = str(var.shape).replace(',','').replace(' ','x')[1:-1] |
|
925 | vshape = str(var.shape).replace(',','').replace(' ','x')[1:-1] | |
925 | if vtype==ndarray_type: |
|
926 | if vtype==ndarray_type: | |
926 | # numpy |
|
927 | # numpy | |
927 | vsize = var.size |
|
928 | vsize = var.size | |
928 | vbytes = vsize*var.itemsize |
|
929 | vbytes = vsize*var.itemsize | |
929 | vdtype = var.dtype |
|
930 | vdtype = var.dtype | |
930 | else: |
|
931 | else: | |
931 | # Numeric |
|
932 | # Numeric | |
932 | vsize = Numeric.size(var) |
|
933 | vsize = Numeric.size(var) | |
933 | vbytes = vsize*var.itemsize() |
|
934 | vbytes = vsize*var.itemsize() | |
934 | vdtype = var.typecode() |
|
935 | vdtype = var.typecode() | |
935 |
|
936 | |||
936 | if vbytes < 100000: |
|
937 | if vbytes < 100000: | |
937 | print aformat % (vshape,vsize,vdtype,vbytes) |
|
938 | print aformat % (vshape,vsize,vdtype,vbytes) | |
938 | else: |
|
939 | else: | |
939 | print aformat % (vshape,vsize,vdtype,vbytes), |
|
940 | print aformat % (vshape,vsize,vdtype,vbytes), | |
940 | if vbytes < Mb: |
|
941 | if vbytes < Mb: | |
941 | print '(%s kb)' % (vbytes/kb,) |
|
942 | print '(%s kb)' % (vbytes/kb,) | |
942 | else: |
|
943 | else: | |
943 | print '(%s Mb)' % (vbytes/Mb,) |
|
944 | print '(%s Mb)' % (vbytes/Mb,) | |
944 | else: |
|
945 | else: | |
945 | try: |
|
946 | try: | |
946 | vstr = str(var) |
|
947 | vstr = str(var) | |
947 | except UnicodeEncodeError: |
|
948 | except UnicodeEncodeError: | |
948 | vstr = unicode(var).encode(sys.getdefaultencoding(), |
|
949 | vstr = unicode(var).encode(sys.getdefaultencoding(), | |
949 | 'backslashreplace') |
|
950 | 'backslashreplace') | |
950 | vstr = vstr.replace('\n','\\n') |
|
951 | vstr = vstr.replace('\n','\\n') | |
951 | if len(vstr) < 50: |
|
952 | if len(vstr) < 50: | |
952 | print vstr |
|
953 | print vstr | |
953 | else: |
|
954 | else: | |
954 | print vstr[:25] + "<...>" + vstr[-25:] |
|
955 | print vstr[:25] + "<...>" + vstr[-25:] | |
955 |
|
956 | |||
956 | def magic_reset(self, parameter_s=''): |
|
957 | def magic_reset(self, parameter_s=''): | |
957 | """Resets the namespace by removing all names defined by the user. |
|
958 | """Resets the namespace by removing all names defined by the user. | |
958 |
|
959 | |||
959 | Parameters |
|
960 | Parameters | |
960 | ---------- |
|
961 | ---------- | |
961 | -f : force reset without asking for confirmation. |
|
962 | -f : force reset without asking for confirmation. | |
962 |
|
963 | |||
963 | -s : 'Soft' reset: Only clears your namespace, leaving history intact. |
|
964 | -s : 'Soft' reset: Only clears your namespace, leaving history intact. | |
964 | References to objects may be kept. By default (without this option), |
|
965 | References to objects may be kept. By default (without this option), | |
965 | we do a 'hard' reset, giving you a new session and removing all |
|
966 | we do a 'hard' reset, giving you a new session and removing all | |
966 | references to objects from the current session. |
|
967 | references to objects from the current session. | |
967 |
|
968 | |||
968 | Examples |
|
969 | Examples | |
969 | -------- |
|
970 | -------- | |
970 | In [6]: a = 1 |
|
971 | In [6]: a = 1 | |
971 |
|
972 | |||
972 | In [7]: a |
|
973 | In [7]: a | |
973 | Out[7]: 1 |
|
974 | Out[7]: 1 | |
974 |
|
975 | |||
975 | In [8]: 'a' in _ip.user_ns |
|
976 | In [8]: 'a' in _ip.user_ns | |
976 | Out[8]: True |
|
977 | Out[8]: True | |
977 |
|
978 | |||
978 | In [9]: %reset -f |
|
979 | In [9]: %reset -f | |
979 |
|
980 | |||
980 | In [1]: 'a' in _ip.user_ns |
|
981 | In [1]: 'a' in _ip.user_ns | |
981 | Out[1]: False |
|
982 | Out[1]: False | |
982 | """ |
|
983 | """ | |
983 | opts, args = self.parse_options(parameter_s,'sf') |
|
984 | opts, args = self.parse_options(parameter_s,'sf') | |
984 | if 'f' in opts: |
|
985 | if 'f' in opts: | |
985 | ans = True |
|
986 | ans = True | |
986 | else: |
|
987 | else: | |
987 | ans = self.shell.ask_yes_no( |
|
988 | ans = self.shell.ask_yes_no( | |
988 | "Once deleted, variables cannot be recovered. Proceed (y/[n])? ", default='n') |
|
989 | "Once deleted, variables cannot be recovered. Proceed (y/[n])? ", default='n') | |
989 | if not ans: |
|
990 | if not ans: | |
990 | print 'Nothing done.' |
|
991 | print 'Nothing done.' | |
991 | return |
|
992 | return | |
992 |
|
993 | |||
993 | if 's' in opts: # Soft reset |
|
994 | if 's' in opts: # Soft reset | |
994 | user_ns = self.shell.user_ns |
|
995 | user_ns = self.shell.user_ns | |
995 | for i in self.magic_who_ls(): |
|
996 | for i in self.magic_who_ls(): | |
996 | del(user_ns[i]) |
|
997 | del(user_ns[i]) | |
997 |
|
998 | |||
998 | else: # Hard reset |
|
999 | else: # Hard reset | |
999 | self.shell.reset(new_session = False) |
|
1000 | self.shell.reset(new_session = False) | |
1000 |
|
1001 | |||
1001 |
|
1002 | |||
1002 |
|
1003 | |||
1003 | def magic_reset_selective(self, parameter_s=''): |
|
1004 | def magic_reset_selective(self, parameter_s=''): | |
1004 | """Resets the namespace by removing names defined by the user. |
|
1005 | """Resets the namespace by removing names defined by the user. | |
1005 |
|
1006 | |||
1006 | Input/Output history are left around in case you need them. |
|
1007 | Input/Output history are left around in case you need them. | |
1007 |
|
1008 | |||
1008 | %reset_selective [-f] regex |
|
1009 | %reset_selective [-f] regex | |
1009 |
|
1010 | |||
1010 | No action is taken if regex is not included |
|
1011 | No action is taken if regex is not included | |
1011 |
|
1012 | |||
1012 | Options |
|
1013 | Options | |
1013 | -f : force reset without asking for confirmation. |
|
1014 | -f : force reset without asking for confirmation. | |
1014 |
|
1015 | |||
1015 | Examples |
|
1016 | Examples | |
1016 | -------- |
|
1017 | -------- | |
1017 |
|
1018 | |||
1018 | We first fully reset the namespace so your output looks identical to |
|
1019 | We first fully reset the namespace so your output looks identical to | |
1019 | this example for pedagogical reasons; in practice you do not need a |
|
1020 | this example for pedagogical reasons; in practice you do not need a | |
1020 | full reset. |
|
1021 | full reset. | |
1021 |
|
1022 | |||
1022 | In [1]: %reset -f |
|
1023 | In [1]: %reset -f | |
1023 |
|
1024 | |||
1024 | Now, with a clean namespace we can make a few variables and use |
|
1025 | Now, with a clean namespace we can make a few variables and use | |
1025 | %reset_selective to only delete names that match our regexp: |
|
1026 | %reset_selective to only delete names that match our regexp: | |
1026 |
|
1027 | |||
1027 | In [2]: a=1; b=2; c=3; b1m=4; b2m=5; b3m=6; b4m=7; b2s=8 |
|
1028 | In [2]: a=1; b=2; c=3; b1m=4; b2m=5; b3m=6; b4m=7; b2s=8 | |
1028 |
|
1029 | |||
1029 | In [3]: who_ls |
|
1030 | In [3]: who_ls | |
1030 | Out[3]: ['a', 'b', 'b1m', 'b2m', 'b2s', 'b3m', 'b4m', 'c'] |
|
1031 | Out[3]: ['a', 'b', 'b1m', 'b2m', 'b2s', 'b3m', 'b4m', 'c'] | |
1031 |
|
1032 | |||
1032 | In [4]: %reset_selective -f b[2-3]m |
|
1033 | In [4]: %reset_selective -f b[2-3]m | |
1033 |
|
1034 | |||
1034 | In [5]: who_ls |
|
1035 | In [5]: who_ls | |
1035 | Out[5]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c'] |
|
1036 | Out[5]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c'] | |
1036 |
|
1037 | |||
1037 | In [6]: %reset_selective -f d |
|
1038 | In [6]: %reset_selective -f d | |
1038 |
|
1039 | |||
1039 | In [7]: who_ls |
|
1040 | In [7]: who_ls | |
1040 | Out[7]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c'] |
|
1041 | Out[7]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c'] | |
1041 |
|
1042 | |||
1042 | In [8]: %reset_selective -f c |
|
1043 | In [8]: %reset_selective -f c | |
1043 |
|
1044 | |||
1044 | In [9]: who_ls |
|
1045 | In [9]: who_ls | |
1045 | Out[9]: ['a', 'b', 'b1m', 'b2s', 'b4m'] |
|
1046 | Out[9]: ['a', 'b', 'b1m', 'b2s', 'b4m'] | |
1046 |
|
1047 | |||
1047 | In [10]: %reset_selective -f b |
|
1048 | In [10]: %reset_selective -f b | |
1048 |
|
1049 | |||
1049 | In [11]: who_ls |
|
1050 | In [11]: who_ls | |
1050 | Out[11]: ['a'] |
|
1051 | Out[11]: ['a'] | |
1051 | """ |
|
1052 | """ | |
1052 |
|
1053 | |||
1053 | opts, regex = self.parse_options(parameter_s,'f') |
|
1054 | opts, regex = self.parse_options(parameter_s,'f') | |
1054 |
|
1055 | |||
1055 | if opts.has_key('f'): |
|
1056 | if opts.has_key('f'): | |
1056 | ans = True |
|
1057 | ans = True | |
1057 | else: |
|
1058 | else: | |
1058 | ans = self.shell.ask_yes_no( |
|
1059 | ans = self.shell.ask_yes_no( | |
1059 | "Once deleted, variables cannot be recovered. Proceed (y/[n])? ", |
|
1060 | "Once deleted, variables cannot be recovered. Proceed (y/[n])? ", | |
1060 | default='n') |
|
1061 | default='n') | |
1061 | if not ans: |
|
1062 | if not ans: | |
1062 | print 'Nothing done.' |
|
1063 | print 'Nothing done.' | |
1063 | return |
|
1064 | return | |
1064 | user_ns = self.shell.user_ns |
|
1065 | user_ns = self.shell.user_ns | |
1065 | if not regex: |
|
1066 | if not regex: | |
1066 | print 'No regex pattern specified. Nothing done.' |
|
1067 | print 'No regex pattern specified. Nothing done.' | |
1067 | return |
|
1068 | return | |
1068 | else: |
|
1069 | else: | |
1069 | try: |
|
1070 | try: | |
1070 | m = re.compile(regex) |
|
1071 | m = re.compile(regex) | |
1071 | except TypeError: |
|
1072 | except TypeError: | |
1072 | raise TypeError('regex must be a string or compiled pattern') |
|
1073 | raise TypeError('regex must be a string or compiled pattern') | |
1073 | for i in self.magic_who_ls(): |
|
1074 | for i in self.magic_who_ls(): | |
1074 | if m.search(i): |
|
1075 | if m.search(i): | |
1075 | del(user_ns[i]) |
|
1076 | del(user_ns[i]) | |
1076 |
|
1077 | |||
1077 | def magic_xdel(self, parameter_s=''): |
|
1078 | def magic_xdel(self, parameter_s=''): | |
1078 | """Delete a variable, trying to clear it from anywhere that |
|
1079 | """Delete a variable, trying to clear it from anywhere that | |
1079 | IPython's machinery has references to it. By default, this uses |
|
1080 | IPython's machinery has references to it. By default, this uses | |
1080 | the identity of the named object in the user namespace to remove |
|
1081 | the identity of the named object in the user namespace to remove | |
1081 | references held under other names. The object is also removed |
|
1082 | references held under other names. The object is also removed | |
1082 | from the output history. |
|
1083 | from the output history. | |
1083 |
|
1084 | |||
1084 | Options |
|
1085 | Options | |
1085 | -n : Delete the specified name from all namespaces, without |
|
1086 | -n : Delete the specified name from all namespaces, without | |
1086 | checking their identity. |
|
1087 | checking their identity. | |
1087 | """ |
|
1088 | """ | |
1088 | opts, varname = self.parse_options(parameter_s,'n') |
|
1089 | opts, varname = self.parse_options(parameter_s,'n') | |
1089 | try: |
|
1090 | try: | |
1090 | self.shell.del_var(varname, ('n' in opts)) |
|
1091 | self.shell.del_var(varname, ('n' in opts)) | |
1091 | except (NameError, ValueError) as e: |
|
1092 | except (NameError, ValueError) as e: | |
1092 | print type(e).__name__ +": "+ str(e) |
|
1093 | print type(e).__name__ +": "+ str(e) | |
1093 |
|
1094 | |||
1094 | def magic_logstart(self,parameter_s=''): |
|
1095 | def magic_logstart(self,parameter_s=''): | |
1095 | """Start logging anywhere in a session. |
|
1096 | """Start logging anywhere in a session. | |
1096 |
|
1097 | |||
1097 | %logstart [-o|-r|-t] [log_name [log_mode]] |
|
1098 | %logstart [-o|-r|-t] [log_name [log_mode]] | |
1098 |
|
1099 | |||
1099 | If no name is given, it defaults to a file named 'ipython_log.py' in your |
|
1100 | If no name is given, it defaults to a file named 'ipython_log.py' in your | |
1100 | current directory, in 'rotate' mode (see below). |
|
1101 | current directory, in 'rotate' mode (see below). | |
1101 |
|
1102 | |||
1102 | '%logstart name' saves to file 'name' in 'backup' mode. It saves your |
|
1103 | '%logstart name' saves to file 'name' in 'backup' mode. It saves your | |
1103 | history up to that point and then continues logging. |
|
1104 | history up to that point and then continues logging. | |
1104 |
|
1105 | |||
1105 | %logstart takes a second optional parameter: logging mode. This can be one |
|
1106 | %logstart takes a second optional parameter: logging mode. This can be one | |
1106 | of (note that the modes are given unquoted):\\ |
|
1107 | of (note that the modes are given unquoted):\\ | |
1107 | append: well, that says it.\\ |
|
1108 | append: well, that says it.\\ | |
1108 | backup: rename (if exists) to name~ and start name.\\ |
|
1109 | backup: rename (if exists) to name~ and start name.\\ | |
1109 | global: single logfile in your home dir, appended to.\\ |
|
1110 | global: single logfile in your home dir, appended to.\\ | |
1110 | over : overwrite existing log.\\ |
|
1111 | over : overwrite existing log.\\ | |
1111 | rotate: create rotating logs name.1~, name.2~, etc. |
|
1112 | rotate: create rotating logs name.1~, name.2~, etc. | |
1112 |
|
1113 | |||
1113 | Options: |
|
1114 | Options: | |
1114 |
|
1115 | |||
1115 | -o: log also IPython's output. In this mode, all commands which |
|
1116 | -o: log also IPython's output. In this mode, all commands which | |
1116 | generate an Out[NN] prompt are recorded to the logfile, right after |
|
1117 | generate an Out[NN] prompt are recorded to the logfile, right after | |
1117 | their corresponding input line. The output lines are always |
|
1118 | their corresponding input line. The output lines are always | |
1118 | prepended with a '#[Out]# ' marker, so that the log remains valid |
|
1119 | prepended with a '#[Out]# ' marker, so that the log remains valid | |
1119 | Python code. |
|
1120 | Python code. | |
1120 |
|
1121 | |||
1121 | Since this marker is always the same, filtering only the output from |
|
1122 | Since this marker is always the same, filtering only the output from | |
1122 | a log is very easy, using for example a simple awk call: |
|
1123 | a log is very easy, using for example a simple awk call: | |
1123 |
|
1124 | |||
1124 | awk -F'#\\[Out\\]# ' '{if($2) {print $2}}' ipython_log.py |
|
1125 | awk -F'#\\[Out\\]# ' '{if($2) {print $2}}' ipython_log.py | |
1125 |
|
1126 | |||
1126 | -r: log 'raw' input. Normally, IPython's logs contain the processed |
|
1127 | -r: log 'raw' input. Normally, IPython's logs contain the processed | |
1127 | input, so that user lines are logged in their final form, converted |
|
1128 | input, so that user lines are logged in their final form, converted | |
1128 | into valid Python. For example, %Exit is logged as |
|
1129 | into valid Python. For example, %Exit is logged as | |
1129 | '_ip.magic("Exit"). If the -r flag is given, all input is logged |
|
1130 | '_ip.magic("Exit"). If the -r flag is given, all input is logged | |
1130 | exactly as typed, with no transformations applied. |
|
1131 | exactly as typed, with no transformations applied. | |
1131 |
|
1132 | |||
1132 | -t: put timestamps before each input line logged (these are put in |
|
1133 | -t: put timestamps before each input line logged (these are put in | |
1133 | comments).""" |
|
1134 | comments).""" | |
1134 |
|
1135 | |||
1135 | opts,par = self.parse_options(parameter_s,'ort') |
|
1136 | opts,par = self.parse_options(parameter_s,'ort') | |
1136 | log_output = 'o' in opts |
|
1137 | log_output = 'o' in opts | |
1137 | log_raw_input = 'r' in opts |
|
1138 | log_raw_input = 'r' in opts | |
1138 | timestamp = 't' in opts |
|
1139 | timestamp = 't' in opts | |
1139 |
|
1140 | |||
1140 | logger = self.shell.logger |
|
1141 | logger = self.shell.logger | |
1141 |
|
1142 | |||
1142 | # if no args are given, the defaults set in the logger constructor by |
|
1143 | # if no args are given, the defaults set in the logger constructor by | |
1143 | # ipytohn remain valid |
|
1144 | # ipytohn remain valid | |
1144 | if par: |
|
1145 | if par: | |
1145 | try: |
|
1146 | try: | |
1146 | logfname,logmode = par.split() |
|
1147 | logfname,logmode = par.split() | |
1147 | except: |
|
1148 | except: | |
1148 | logfname = par |
|
1149 | logfname = par | |
1149 | logmode = 'backup' |
|
1150 | logmode = 'backup' | |
1150 | else: |
|
1151 | else: | |
1151 | logfname = logger.logfname |
|
1152 | logfname = logger.logfname | |
1152 | logmode = logger.logmode |
|
1153 | logmode = logger.logmode | |
1153 | # put logfname into rc struct as if it had been called on the command |
|
1154 | # put logfname into rc struct as if it had been called on the command | |
1154 | # line, so it ends up saved in the log header Save it in case we need |
|
1155 | # line, so it ends up saved in the log header Save it in case we need | |
1155 | # to restore it... |
|
1156 | # to restore it... | |
1156 | old_logfile = self.shell.logfile |
|
1157 | old_logfile = self.shell.logfile | |
1157 | if logfname: |
|
1158 | if logfname: | |
1158 | logfname = os.path.expanduser(logfname) |
|
1159 | logfname = os.path.expanduser(logfname) | |
1159 | self.shell.logfile = logfname |
|
1160 | self.shell.logfile = logfname | |
1160 |
|
1161 | |||
1161 | loghead = '# IPython log file\n\n' |
|
1162 | loghead = '# IPython log file\n\n' | |
1162 | try: |
|
1163 | try: | |
1163 | started = logger.logstart(logfname,loghead,logmode, |
|
1164 | started = logger.logstart(logfname,loghead,logmode, | |
1164 | log_output,timestamp,log_raw_input) |
|
1165 | log_output,timestamp,log_raw_input) | |
1165 | except: |
|
1166 | except: | |
1166 | self.shell.logfile = old_logfile |
|
1167 | self.shell.logfile = old_logfile | |
1167 | warn("Couldn't start log: %s" % sys.exc_info()[1]) |
|
1168 | warn("Couldn't start log: %s" % sys.exc_info()[1]) | |
1168 | else: |
|
1169 | else: | |
1169 | # log input history up to this point, optionally interleaving |
|
1170 | # log input history up to this point, optionally interleaving | |
1170 | # output if requested |
|
1171 | # output if requested | |
1171 |
|
1172 | |||
1172 | if timestamp: |
|
1173 | if timestamp: | |
1173 | # disable timestamping for the previous history, since we've |
|
1174 | # disable timestamping for the previous history, since we've | |
1174 | # lost those already (no time machine here). |
|
1175 | # lost those already (no time machine here). | |
1175 | logger.timestamp = False |
|
1176 | logger.timestamp = False | |
1176 |
|
1177 | |||
1177 | if log_raw_input: |
|
1178 | if log_raw_input: | |
1178 | input_hist = self.shell.history_manager.input_hist_raw |
|
1179 | input_hist = self.shell.history_manager.input_hist_raw | |
1179 | else: |
|
1180 | else: | |
1180 | input_hist = self.shell.history_manager.input_hist_parsed |
|
1181 | input_hist = self.shell.history_manager.input_hist_parsed | |
1181 |
|
1182 | |||
1182 | if log_output: |
|
1183 | if log_output: | |
1183 | log_write = logger.log_write |
|
1184 | log_write = logger.log_write | |
1184 | output_hist = self.shell.history_manager.output_hist |
|
1185 | output_hist = self.shell.history_manager.output_hist | |
1185 | for n in range(1,len(input_hist)-1): |
|
1186 | for n in range(1,len(input_hist)-1): | |
1186 | log_write(input_hist[n].rstrip() + '\n') |
|
1187 | log_write(input_hist[n].rstrip() + '\n') | |
1187 | if n in output_hist: |
|
1188 | if n in output_hist: | |
1188 | log_write(repr(output_hist[n]),'output') |
|
1189 | log_write(repr(output_hist[n]),'output') | |
1189 | else: |
|
1190 | else: | |
1190 | logger.log_write('\n'.join(input_hist[1:])) |
|
1191 | logger.log_write('\n'.join(input_hist[1:])) | |
1191 | logger.log_write('\n') |
|
1192 | logger.log_write('\n') | |
1192 | if timestamp: |
|
1193 | if timestamp: | |
1193 | # re-enable timestamping |
|
1194 | # re-enable timestamping | |
1194 | logger.timestamp = True |
|
1195 | logger.timestamp = True | |
1195 |
|
1196 | |||
1196 | print ('Activating auto-logging. ' |
|
1197 | print ('Activating auto-logging. ' | |
1197 | 'Current session state plus future input saved.') |
|
1198 | 'Current session state plus future input saved.') | |
1198 | logger.logstate() |
|
1199 | logger.logstate() | |
1199 |
|
1200 | |||
1200 | def magic_logstop(self,parameter_s=''): |
|
1201 | def magic_logstop(self,parameter_s=''): | |
1201 | """Fully stop logging and close log file. |
|
1202 | """Fully stop logging and close log file. | |
1202 |
|
1203 | |||
1203 | In order to start logging again, a new %logstart call needs to be made, |
|
1204 | In order to start logging again, a new %logstart call needs to be made, | |
1204 | possibly (though not necessarily) with a new filename, mode and other |
|
1205 | possibly (though not necessarily) with a new filename, mode and other | |
1205 | options.""" |
|
1206 | options.""" | |
1206 | self.logger.logstop() |
|
1207 | self.logger.logstop() | |
1207 |
|
1208 | |||
1208 | def magic_logoff(self,parameter_s=''): |
|
1209 | def magic_logoff(self,parameter_s=''): | |
1209 | """Temporarily stop logging. |
|
1210 | """Temporarily stop logging. | |
1210 |
|
1211 | |||
1211 | You must have previously started logging.""" |
|
1212 | You must have previously started logging.""" | |
1212 | self.shell.logger.switch_log(0) |
|
1213 | self.shell.logger.switch_log(0) | |
1213 |
|
1214 | |||
1214 | def magic_logon(self,parameter_s=''): |
|
1215 | def magic_logon(self,parameter_s=''): | |
1215 | """Restart logging. |
|
1216 | """Restart logging. | |
1216 |
|
1217 | |||
1217 | This function is for restarting logging which you've temporarily |
|
1218 | This function is for restarting logging which you've temporarily | |
1218 | stopped with %logoff. For starting logging for the first time, you |
|
1219 | stopped with %logoff. For starting logging for the first time, you | |
1219 | must use the %logstart function, which allows you to specify an |
|
1220 | must use the %logstart function, which allows you to specify an | |
1220 | optional log filename.""" |
|
1221 | optional log filename.""" | |
1221 |
|
1222 | |||
1222 | self.shell.logger.switch_log(1) |
|
1223 | self.shell.logger.switch_log(1) | |
1223 |
|
1224 | |||
1224 | def magic_logstate(self,parameter_s=''): |
|
1225 | def magic_logstate(self,parameter_s=''): | |
1225 | """Print the status of the logging system.""" |
|
1226 | """Print the status of the logging system.""" | |
1226 |
|
1227 | |||
1227 | self.shell.logger.logstate() |
|
1228 | self.shell.logger.logstate() | |
1228 |
|
1229 | |||
1229 | def magic_pdb(self, parameter_s=''): |
|
1230 | def magic_pdb(self, parameter_s=''): | |
1230 | """Control the automatic calling of the pdb interactive debugger. |
|
1231 | """Control the automatic calling of the pdb interactive debugger. | |
1231 |
|
1232 | |||
1232 | Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without |
|
1233 | Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without | |
1233 | argument it works as a toggle. |
|
1234 | argument it works as a toggle. | |
1234 |
|
1235 | |||
1235 | When an exception is triggered, IPython can optionally call the |
|
1236 | When an exception is triggered, IPython can optionally call the | |
1236 | interactive pdb debugger after the traceback printout. %pdb toggles |
|
1237 | interactive pdb debugger after the traceback printout. %pdb toggles | |
1237 | this feature on and off. |
|
1238 | this feature on and off. | |
1238 |
|
1239 | |||
1239 | The initial state of this feature is set in your configuration |
|
1240 | The initial state of this feature is set in your configuration | |
1240 | file (the option is ``InteractiveShell.pdb``). |
|
1241 | file (the option is ``InteractiveShell.pdb``). | |
1241 |
|
1242 | |||
1242 | If you want to just activate the debugger AFTER an exception has fired, |
|
1243 | If you want to just activate the debugger AFTER an exception has fired, | |
1243 | without having to type '%pdb on' and rerunning your code, you can use |
|
1244 | without having to type '%pdb on' and rerunning your code, you can use | |
1244 | the %debug magic.""" |
|
1245 | the %debug magic.""" | |
1245 |
|
1246 | |||
1246 | par = parameter_s.strip().lower() |
|
1247 | par = parameter_s.strip().lower() | |
1247 |
|
1248 | |||
1248 | if par: |
|
1249 | if par: | |
1249 | try: |
|
1250 | try: | |
1250 | new_pdb = {'off':0,'0':0,'on':1,'1':1}[par] |
|
1251 | new_pdb = {'off':0,'0':0,'on':1,'1':1}[par] | |
1251 | except KeyError: |
|
1252 | except KeyError: | |
1252 | print ('Incorrect argument. Use on/1, off/0, ' |
|
1253 | print ('Incorrect argument. Use on/1, off/0, ' | |
1253 | 'or nothing for a toggle.') |
|
1254 | 'or nothing for a toggle.') | |
1254 | return |
|
1255 | return | |
1255 | else: |
|
1256 | else: | |
1256 | # toggle |
|
1257 | # toggle | |
1257 | new_pdb = not self.shell.call_pdb |
|
1258 | new_pdb = not self.shell.call_pdb | |
1258 |
|
1259 | |||
1259 | # set on the shell |
|
1260 | # set on the shell | |
1260 | self.shell.call_pdb = new_pdb |
|
1261 | self.shell.call_pdb = new_pdb | |
1261 | print 'Automatic pdb calling has been turned',on_off(new_pdb) |
|
1262 | print 'Automatic pdb calling has been turned',on_off(new_pdb) | |
1262 |
|
1263 | |||
1263 | def magic_debug(self, parameter_s=''): |
|
1264 | def magic_debug(self, parameter_s=''): | |
1264 | """Activate the interactive debugger in post-mortem mode. |
|
1265 | """Activate the interactive debugger in post-mortem mode. | |
1265 |
|
1266 | |||
1266 | If an exception has just occurred, this lets you inspect its stack |
|
1267 | If an exception has just occurred, this lets you inspect its stack | |
1267 | frames interactively. Note that this will always work only on the last |
|
1268 | frames interactively. Note that this will always work only on the last | |
1268 | traceback that occurred, so you must call this quickly after an |
|
1269 | traceback that occurred, so you must call this quickly after an | |
1269 | exception that you wish to inspect has fired, because if another one |
|
1270 | exception that you wish to inspect has fired, because if another one | |
1270 | occurs, it clobbers the previous one. |
|
1271 | occurs, it clobbers the previous one. | |
1271 |
|
1272 | |||
1272 | If you want IPython to automatically do this on every exception, see |
|
1273 | If you want IPython to automatically do this on every exception, see | |
1273 | the %pdb magic for more details. |
|
1274 | the %pdb magic for more details. | |
1274 | """ |
|
1275 | """ | |
1275 | self.shell.debugger(force=True) |
|
1276 | self.shell.debugger(force=True) | |
1276 |
|
1277 | |||
1277 | @skip_doctest |
|
1278 | @skip_doctest | |
1278 | def magic_prun(self, parameter_s ='',user_mode=1, |
|
1279 | def magic_prun(self, parameter_s ='',user_mode=1, | |
1279 | opts=None,arg_lst=None,prog_ns=None): |
|
1280 | opts=None,arg_lst=None,prog_ns=None): | |
1280 |
|
1281 | |||
1281 | """Run a statement through the python code profiler. |
|
1282 | """Run a statement through the python code profiler. | |
1282 |
|
1283 | |||
1283 | Usage: |
|
1284 | Usage: | |
1284 | %prun [options] statement |
|
1285 | %prun [options] statement | |
1285 |
|
1286 | |||
1286 | The given statement (which doesn't require quote marks) is run via the |
|
1287 | The given statement (which doesn't require quote marks) is run via the | |
1287 | python profiler in a manner similar to the profile.run() function. |
|
1288 | python profiler in a manner similar to the profile.run() function. | |
1288 | Namespaces are internally managed to work correctly; profile.run |
|
1289 | Namespaces are internally managed to work correctly; profile.run | |
1289 | cannot be used in IPython because it makes certain assumptions about |
|
1290 | cannot be used in IPython because it makes certain assumptions about | |
1290 | namespaces which do not hold under IPython. |
|
1291 | namespaces which do not hold under IPython. | |
1291 |
|
1292 | |||
1292 | Options: |
|
1293 | Options: | |
1293 |
|
1294 | |||
1294 | -l <limit>: you can place restrictions on what or how much of the |
|
1295 | -l <limit>: you can place restrictions on what or how much of the | |
1295 | profile gets printed. The limit value can be: |
|
1296 | profile gets printed. The limit value can be: | |
1296 |
|
1297 | |||
1297 | * A string: only information for function names containing this string |
|
1298 | * A string: only information for function names containing this string | |
1298 | is printed. |
|
1299 | is printed. | |
1299 |
|
1300 | |||
1300 | * An integer: only these many lines are printed. |
|
1301 | * An integer: only these many lines are printed. | |
1301 |
|
1302 | |||
1302 | * A float (between 0 and 1): this fraction of the report is printed |
|
1303 | * A float (between 0 and 1): this fraction of the report is printed | |
1303 | (for example, use a limit of 0.4 to see the topmost 40% only). |
|
1304 | (for example, use a limit of 0.4 to see the topmost 40% only). | |
1304 |
|
1305 | |||
1305 | You can combine several limits with repeated use of the option. For |
|
1306 | You can combine several limits with repeated use of the option. For | |
1306 | example, '-l __init__ -l 5' will print only the topmost 5 lines of |
|
1307 | example, '-l __init__ -l 5' will print only the topmost 5 lines of | |
1307 | information about class constructors. |
|
1308 | information about class constructors. | |
1308 |
|
1309 | |||
1309 | -r: return the pstats.Stats object generated by the profiling. This |
|
1310 | -r: return the pstats.Stats object generated by the profiling. This | |
1310 | object has all the information about the profile in it, and you can |
|
1311 | object has all the information about the profile in it, and you can | |
1311 | later use it for further analysis or in other functions. |
|
1312 | later use it for further analysis or in other functions. | |
1312 |
|
1313 | |||
1313 | -s <key>: sort profile by given key. You can provide more than one key |
|
1314 | -s <key>: sort profile by given key. You can provide more than one key | |
1314 | by using the option several times: '-s key1 -s key2 -s key3...'. The |
|
1315 | by using the option several times: '-s key1 -s key2 -s key3...'. The | |
1315 | default sorting key is 'time'. |
|
1316 | default sorting key is 'time'. | |
1316 |
|
1317 | |||
1317 | The following is copied verbatim from the profile documentation |
|
1318 | The following is copied verbatim from the profile documentation | |
1318 | referenced below: |
|
1319 | referenced below: | |
1319 |
|
1320 | |||
1320 | When more than one key is provided, additional keys are used as |
|
1321 | When more than one key is provided, additional keys are used as | |
1321 | secondary criteria when the there is equality in all keys selected |
|
1322 | secondary criteria when the there is equality in all keys selected | |
1322 | before them. |
|
1323 | before them. | |
1323 |
|
1324 | |||
1324 | Abbreviations can be used for any key names, as long as the |
|
1325 | Abbreviations can be used for any key names, as long as the | |
1325 | abbreviation is unambiguous. The following are the keys currently |
|
1326 | abbreviation is unambiguous. The following are the keys currently | |
1326 | defined: |
|
1327 | defined: | |
1327 |
|
1328 | |||
1328 | Valid Arg Meaning |
|
1329 | Valid Arg Meaning | |
1329 | "calls" call count |
|
1330 | "calls" call count | |
1330 | "cumulative" cumulative time |
|
1331 | "cumulative" cumulative time | |
1331 | "file" file name |
|
1332 | "file" file name | |
1332 | "module" file name |
|
1333 | "module" file name | |
1333 | "pcalls" primitive call count |
|
1334 | "pcalls" primitive call count | |
1334 | "line" line number |
|
1335 | "line" line number | |
1335 | "name" function name |
|
1336 | "name" function name | |
1336 | "nfl" name/file/line |
|
1337 | "nfl" name/file/line | |
1337 | "stdname" standard name |
|
1338 | "stdname" standard name | |
1338 | "time" internal time |
|
1339 | "time" internal time | |
1339 |
|
1340 | |||
1340 | Note that all sorts on statistics are in descending order (placing |
|
1341 | Note that all sorts on statistics are in descending order (placing | |
1341 | most time consuming items first), where as name, file, and line number |
|
1342 | most time consuming items first), where as name, file, and line number | |
1342 | searches are in ascending order (i.e., alphabetical). The subtle |
|
1343 | searches are in ascending order (i.e., alphabetical). The subtle | |
1343 | distinction between "nfl" and "stdname" is that the standard name is a |
|
1344 | distinction between "nfl" and "stdname" is that the standard name is a | |
1344 | sort of the name as printed, which means that the embedded line |
|
1345 | sort of the name as printed, which means that the embedded line | |
1345 | numbers get compared in an odd way. For example, lines 3, 20, and 40 |
|
1346 | numbers get compared in an odd way. For example, lines 3, 20, and 40 | |
1346 | would (if the file names were the same) appear in the string order |
|
1347 | would (if the file names were the same) appear in the string order | |
1347 | "20" "3" and "40". In contrast, "nfl" does a numeric compare of the |
|
1348 | "20" "3" and "40". In contrast, "nfl" does a numeric compare of the | |
1348 | line numbers. In fact, sort_stats("nfl") is the same as |
|
1349 | line numbers. In fact, sort_stats("nfl") is the same as | |
1349 | sort_stats("name", "file", "line"). |
|
1350 | sort_stats("name", "file", "line"). | |
1350 |
|
1351 | |||
1351 | -T <filename>: save profile results as shown on screen to a text |
|
1352 | -T <filename>: save profile results as shown on screen to a text | |
1352 | file. The profile is still shown on screen. |
|
1353 | file. The profile is still shown on screen. | |
1353 |
|
1354 | |||
1354 | -D <filename>: save (via dump_stats) profile statistics to given |
|
1355 | -D <filename>: save (via dump_stats) profile statistics to given | |
1355 | filename. This data is in a format understod by the pstats module, and |
|
1356 | filename. This data is in a format understod by the pstats module, and | |
1356 | is generated by a call to the dump_stats() method of profile |
|
1357 | is generated by a call to the dump_stats() method of profile | |
1357 | objects. The profile is still shown on screen. |
|
1358 | objects. The profile is still shown on screen. | |
1358 |
|
1359 | |||
1359 | If you want to run complete programs under the profiler's control, use |
|
1360 | If you want to run complete programs under the profiler's control, use | |
1360 | '%run -p [prof_opts] filename.py [args to program]' where prof_opts |
|
1361 | '%run -p [prof_opts] filename.py [args to program]' where prof_opts | |
1361 | contains profiler specific options as described here. |
|
1362 | contains profiler specific options as described here. | |
1362 |
|
1363 | |||
1363 | You can read the complete documentation for the profile module with:: |
|
1364 | You can read the complete documentation for the profile module with:: | |
1364 |
|
1365 | |||
1365 | In [1]: import profile; profile.help() |
|
1366 | In [1]: import profile; profile.help() | |
1366 | """ |
|
1367 | """ | |
1367 |
|
1368 | |||
1368 | opts_def = Struct(D=[''],l=[],s=['time'],T=['']) |
|
1369 | opts_def = Struct(D=[''],l=[],s=['time'],T=['']) | |
1369 | # protect user quote marks |
|
1370 | # protect user quote marks | |
1370 | parameter_s = parameter_s.replace('"',r'\"').replace("'",r"\'") |
|
1371 | parameter_s = parameter_s.replace('"',r'\"').replace("'",r"\'") | |
1371 |
|
1372 | |||
1372 | if user_mode: # regular user call |
|
1373 | if user_mode: # regular user call | |
1373 | opts,arg_str = self.parse_options(parameter_s,'D:l:rs:T:', |
|
1374 | opts,arg_str = self.parse_options(parameter_s,'D:l:rs:T:', | |
1374 | list_all=1) |
|
1375 | list_all=1) | |
1375 | namespace = self.shell.user_ns |
|
1376 | namespace = self.shell.user_ns | |
1376 | else: # called to run a program by %run -p |
|
1377 | else: # called to run a program by %run -p | |
1377 | try: |
|
1378 | try: | |
1378 | filename = get_py_filename(arg_lst[0]) |
|
1379 | filename = get_py_filename(arg_lst[0]) | |
1379 | except IOError as e: |
|
1380 | except IOError as e: | |
1380 | try: |
|
1381 | try: | |
1381 | msg = str(e) |
|
1382 | msg = str(e) | |
1382 | except UnicodeError: |
|
1383 | except UnicodeError: | |
1383 | msg = e.message |
|
1384 | msg = e.message | |
1384 | error(msg) |
|
1385 | error(msg) | |
1385 | return |
|
1386 | return | |
1386 |
|
1387 | |||
1387 | arg_str = 'execfile(filename,prog_ns)' |
|
1388 | arg_str = 'execfile(filename,prog_ns)' | |
1388 | namespace = { |
|
1389 | namespace = { | |
1389 | 'execfile': self.shell.safe_execfile, |
|
1390 | 'execfile': self.shell.safe_execfile, | |
1390 | 'prog_ns': prog_ns, |
|
1391 | 'prog_ns': prog_ns, | |
1391 | 'filename': filename |
|
1392 | 'filename': filename | |
1392 | } |
|
1393 | } | |
1393 |
|
1394 | |||
1394 | opts.merge(opts_def) |
|
1395 | opts.merge(opts_def) | |
1395 |
|
1396 | |||
1396 | prof = profile.Profile() |
|
1397 | prof = profile.Profile() | |
1397 | try: |
|
1398 | try: | |
1398 | prof = prof.runctx(arg_str,namespace,namespace) |
|
1399 | prof = prof.runctx(arg_str,namespace,namespace) | |
1399 | sys_exit = '' |
|
1400 | sys_exit = '' | |
1400 | except SystemExit: |
|
1401 | except SystemExit: | |
1401 | sys_exit = """*** SystemExit exception caught in code being profiled.""" |
|
1402 | sys_exit = """*** SystemExit exception caught in code being profiled.""" | |
1402 |
|
1403 | |||
1403 | stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s) |
|
1404 | stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s) | |
1404 |
|
1405 | |||
1405 | lims = opts.l |
|
1406 | lims = opts.l | |
1406 | if lims: |
|
1407 | if lims: | |
1407 | lims = [] # rebuild lims with ints/floats/strings |
|
1408 | lims = [] # rebuild lims with ints/floats/strings | |
1408 | for lim in opts.l: |
|
1409 | for lim in opts.l: | |
1409 | try: |
|
1410 | try: | |
1410 | lims.append(int(lim)) |
|
1411 | lims.append(int(lim)) | |
1411 | except ValueError: |
|
1412 | except ValueError: | |
1412 | try: |
|
1413 | try: | |
1413 | lims.append(float(lim)) |
|
1414 | lims.append(float(lim)) | |
1414 | except ValueError: |
|
1415 | except ValueError: | |
1415 | lims.append(lim) |
|
1416 | lims.append(lim) | |
1416 |
|
1417 | |||
1417 | # Trap output. |
|
1418 | # Trap output. | |
1418 | stdout_trap = StringIO() |
|
1419 | stdout_trap = StringIO() | |
1419 |
|
1420 | |||
1420 | if hasattr(stats,'stream'): |
|
1421 | if hasattr(stats,'stream'): | |
1421 | # In newer versions of python, the stats object has a 'stream' |
|
1422 | # In newer versions of python, the stats object has a 'stream' | |
1422 | # attribute to write into. |
|
1423 | # attribute to write into. | |
1423 | stats.stream = stdout_trap |
|
1424 | stats.stream = stdout_trap | |
1424 | stats.print_stats(*lims) |
|
1425 | stats.print_stats(*lims) | |
1425 | else: |
|
1426 | else: | |
1426 | # For older versions, we manually redirect stdout during printing |
|
1427 | # For older versions, we manually redirect stdout during printing | |
1427 | sys_stdout = sys.stdout |
|
1428 | sys_stdout = sys.stdout | |
1428 | try: |
|
1429 | try: | |
1429 | sys.stdout = stdout_trap |
|
1430 | sys.stdout = stdout_trap | |
1430 | stats.print_stats(*lims) |
|
1431 | stats.print_stats(*lims) | |
1431 | finally: |
|
1432 | finally: | |
1432 | sys.stdout = sys_stdout |
|
1433 | sys.stdout = sys_stdout | |
1433 |
|
1434 | |||
1434 | output = stdout_trap.getvalue() |
|
1435 | output = stdout_trap.getvalue() | |
1435 | output = output.rstrip() |
|
1436 | output = output.rstrip() | |
1436 |
|
1437 | |||
1437 | page.page(output) |
|
1438 | page.page(output) | |
1438 | print sys_exit, |
|
1439 | print sys_exit, | |
1439 |
|
1440 | |||
1440 | dump_file = opts.D[0] |
|
1441 | dump_file = opts.D[0] | |
1441 | text_file = opts.T[0] |
|
1442 | text_file = opts.T[0] | |
1442 | if dump_file: |
|
1443 | if dump_file: | |
1443 | dump_file = unquote_filename(dump_file) |
|
1444 | dump_file = unquote_filename(dump_file) | |
1444 | prof.dump_stats(dump_file) |
|
1445 | prof.dump_stats(dump_file) | |
1445 | print '\n*** Profile stats marshalled to file',\ |
|
1446 | print '\n*** Profile stats marshalled to file',\ | |
1446 | `dump_file`+'.',sys_exit |
|
1447 | `dump_file`+'.',sys_exit | |
1447 | if text_file: |
|
1448 | if text_file: | |
1448 | text_file = unquote_filename(text_file) |
|
1449 | text_file = unquote_filename(text_file) | |
1449 | pfile = file(text_file,'w') |
|
1450 | pfile = file(text_file,'w') | |
1450 | pfile.write(output) |
|
1451 | pfile.write(output) | |
1451 | pfile.close() |
|
1452 | pfile.close() | |
1452 | print '\n*** Profile printout saved to text file',\ |
|
1453 | print '\n*** Profile printout saved to text file',\ | |
1453 | `text_file`+'.',sys_exit |
|
1454 | `text_file`+'.',sys_exit | |
1454 |
|
1455 | |||
1455 | if opts.has_key('r'): |
|
1456 | if opts.has_key('r'): | |
1456 | return stats |
|
1457 | return stats | |
1457 | else: |
|
1458 | else: | |
1458 | return None |
|
1459 | return None | |
1459 |
|
1460 | |||
1460 | @skip_doctest |
|
1461 | @skip_doctest | |
1461 | def magic_run(self, parameter_s ='', runner=None, |
|
1462 | def magic_run(self, parameter_s ='', runner=None, | |
1462 | file_finder=get_py_filename): |
|
1463 | file_finder=get_py_filename): | |
1463 | """Run the named file inside IPython as a program. |
|
1464 | """Run the named file inside IPython as a program. | |
1464 |
|
1465 | |||
1465 | Usage:\\ |
|
1466 | Usage:\\ | |
1466 | %run [-n -i -t [-N<N>] -d [-b<N>] -p [profile options]] file [args] |
|
1467 | %run [-n -i -t [-N<N>] -d [-b<N>] -p [profile options]] file [args] | |
1467 |
|
1468 | |||
1468 | Parameters after the filename are passed as command-line arguments to |
|
1469 | Parameters after the filename are passed as command-line arguments to | |
1469 | the program (put in sys.argv). Then, control returns to IPython's |
|
1470 | the program (put in sys.argv). Then, control returns to IPython's | |
1470 | prompt. |
|
1471 | prompt. | |
1471 |
|
1472 | |||
1472 | This is similar to running at a system prompt:\\ |
|
1473 | This is similar to running at a system prompt:\\ | |
1473 | $ python file args\\ |
|
1474 | $ python file args\\ | |
1474 | but with the advantage of giving you IPython's tracebacks, and of |
|
1475 | but with the advantage of giving you IPython's tracebacks, and of | |
1475 | loading all variables into your interactive namespace for further use |
|
1476 | loading all variables into your interactive namespace for further use | |
1476 | (unless -p is used, see below). |
|
1477 | (unless -p is used, see below). | |
1477 |
|
1478 | |||
1478 | The file is executed in a namespace initially consisting only of |
|
1479 | The file is executed in a namespace initially consisting only of | |
1479 | __name__=='__main__' and sys.argv constructed as indicated. It thus |
|
1480 | __name__=='__main__' and sys.argv constructed as indicated. It thus | |
1480 | sees its environment as if it were being run as a stand-alone program |
|
1481 | sees its environment as if it were being run as a stand-alone program | |
1481 | (except for sharing global objects such as previously imported |
|
1482 | (except for sharing global objects such as previously imported | |
1482 | modules). But after execution, the IPython interactive namespace gets |
|
1483 | modules). But after execution, the IPython interactive namespace gets | |
1483 | updated with all variables defined in the program (except for __name__ |
|
1484 | updated with all variables defined in the program (except for __name__ | |
1484 | and sys.argv). This allows for very convenient loading of code for |
|
1485 | and sys.argv). This allows for very convenient loading of code for | |
1485 | interactive work, while giving each program a 'clean sheet' to run in. |
|
1486 | interactive work, while giving each program a 'clean sheet' to run in. | |
1486 |
|
1487 | |||
1487 | Options: |
|
1488 | Options: | |
1488 |
|
1489 | |||
1489 | -n: __name__ is NOT set to '__main__', but to the running file's name |
|
1490 | -n: __name__ is NOT set to '__main__', but to the running file's name | |
1490 | without extension (as python does under import). This allows running |
|
1491 | without extension (as python does under import). This allows running | |
1491 | scripts and reloading the definitions in them without calling code |
|
1492 | scripts and reloading the definitions in them without calling code | |
1492 | protected by an ' if __name__ == "__main__" ' clause. |
|
1493 | protected by an ' if __name__ == "__main__" ' clause. | |
1493 |
|
1494 | |||
1494 | -i: run the file in IPython's namespace instead of an empty one. This |
|
1495 | -i: run the file in IPython's namespace instead of an empty one. This | |
1495 | is useful if you are experimenting with code written in a text editor |
|
1496 | is useful if you are experimenting with code written in a text editor | |
1496 | which depends on variables defined interactively. |
|
1497 | which depends on variables defined interactively. | |
1497 |
|
1498 | |||
1498 | -e: ignore sys.exit() calls or SystemExit exceptions in the script |
|
1499 | -e: ignore sys.exit() calls or SystemExit exceptions in the script | |
1499 | being run. This is particularly useful if IPython is being used to |
|
1500 | being run. This is particularly useful if IPython is being used to | |
1500 | run unittests, which always exit with a sys.exit() call. In such |
|
1501 | run unittests, which always exit with a sys.exit() call. In such | |
1501 | cases you are interested in the output of the test results, not in |
|
1502 | cases you are interested in the output of the test results, not in | |
1502 | seeing a traceback of the unittest module. |
|
1503 | seeing a traceback of the unittest module. | |
1503 |
|
1504 | |||
1504 | -t: print timing information at the end of the run. IPython will give |
|
1505 | -t: print timing information at the end of the run. IPython will give | |
1505 | you an estimated CPU time consumption for your script, which under |
|
1506 | you an estimated CPU time consumption for your script, which under | |
1506 | Unix uses the resource module to avoid the wraparound problems of |
|
1507 | Unix uses the resource module to avoid the wraparound problems of | |
1507 | time.clock(). Under Unix, an estimate of time spent on system tasks |
|
1508 | time.clock(). Under Unix, an estimate of time spent on system tasks | |
1508 | is also given (for Windows platforms this is reported as 0.0). |
|
1509 | is also given (for Windows platforms this is reported as 0.0). | |
1509 |
|
1510 | |||
1510 | If -t is given, an additional -N<N> option can be given, where <N> |
|
1511 | If -t is given, an additional -N<N> option can be given, where <N> | |
1511 | must be an integer indicating how many times you want the script to |
|
1512 | must be an integer indicating how many times you want the script to | |
1512 | run. The final timing report will include total and per run results. |
|
1513 | run. The final timing report will include total and per run results. | |
1513 |
|
1514 | |||
1514 | For example (testing the script uniq_stable.py): |
|
1515 | For example (testing the script uniq_stable.py): | |
1515 |
|
1516 | |||
1516 | In [1]: run -t uniq_stable |
|
1517 | In [1]: run -t uniq_stable | |
1517 |
|
1518 | |||
1518 | IPython CPU timings (estimated):\\ |
|
1519 | IPython CPU timings (estimated):\\ | |
1519 | User : 0.19597 s.\\ |
|
1520 | User : 0.19597 s.\\ | |
1520 | System: 0.0 s.\\ |
|
1521 | System: 0.0 s.\\ | |
1521 |
|
1522 | |||
1522 | In [2]: run -t -N5 uniq_stable |
|
1523 | In [2]: run -t -N5 uniq_stable | |
1523 |
|
1524 | |||
1524 | IPython CPU timings (estimated):\\ |
|
1525 | IPython CPU timings (estimated):\\ | |
1525 | Total runs performed: 5\\ |
|
1526 | Total runs performed: 5\\ | |
1526 | Times : Total Per run\\ |
|
1527 | Times : Total Per run\\ | |
1527 | User : 0.910862 s, 0.1821724 s.\\ |
|
1528 | User : 0.910862 s, 0.1821724 s.\\ | |
1528 | System: 0.0 s, 0.0 s. |
|
1529 | System: 0.0 s, 0.0 s. | |
1529 |
|
1530 | |||
1530 | -d: run your program under the control of pdb, the Python debugger. |
|
1531 | -d: run your program under the control of pdb, the Python debugger. | |
1531 | This allows you to execute your program step by step, watch variables, |
|
1532 | This allows you to execute your program step by step, watch variables, | |
1532 | etc. Internally, what IPython does is similar to calling: |
|
1533 | etc. Internally, what IPython does is similar to calling: | |
1533 |
|
1534 | |||
1534 | pdb.run('execfile("YOURFILENAME")') |
|
1535 | pdb.run('execfile("YOURFILENAME")') | |
1535 |
|
1536 | |||
1536 | with a breakpoint set on line 1 of your file. You can change the line |
|
1537 | with a breakpoint set on line 1 of your file. You can change the line | |
1537 | number for this automatic breakpoint to be <N> by using the -bN option |
|
1538 | number for this automatic breakpoint to be <N> by using the -bN option | |
1538 | (where N must be an integer). For example: |
|
1539 | (where N must be an integer). For example: | |
1539 |
|
1540 | |||
1540 | %run -d -b40 myscript |
|
1541 | %run -d -b40 myscript | |
1541 |
|
1542 | |||
1542 | will set the first breakpoint at line 40 in myscript.py. Note that |
|
1543 | will set the first breakpoint at line 40 in myscript.py. Note that | |
1543 | the first breakpoint must be set on a line which actually does |
|
1544 | the first breakpoint must be set on a line which actually does | |
1544 | something (not a comment or docstring) for it to stop execution. |
|
1545 | something (not a comment or docstring) for it to stop execution. | |
1545 |
|
1546 | |||
1546 | When the pdb debugger starts, you will see a (Pdb) prompt. You must |
|
1547 | When the pdb debugger starts, you will see a (Pdb) prompt. You must | |
1547 | first enter 'c' (without qoutes) to start execution up to the first |
|
1548 | first enter 'c' (without qoutes) to start execution up to the first | |
1548 | breakpoint. |
|
1549 | breakpoint. | |
1549 |
|
1550 | |||
1550 | Entering 'help' gives information about the use of the debugger. You |
|
1551 | Entering 'help' gives information about the use of the debugger. You | |
1551 | can easily see pdb's full documentation with "import pdb;pdb.help()" |
|
1552 | can easily see pdb's full documentation with "import pdb;pdb.help()" | |
1552 | at a prompt. |
|
1553 | at a prompt. | |
1553 |
|
1554 | |||
1554 | -p: run program under the control of the Python profiler module (which |
|
1555 | -p: run program under the control of the Python profiler module (which | |
1555 | prints a detailed report of execution times, function calls, etc). |
|
1556 | prints a detailed report of execution times, function calls, etc). | |
1556 |
|
1557 | |||
1557 | You can pass other options after -p which affect the behavior of the |
|
1558 | You can pass other options after -p which affect the behavior of the | |
1558 | profiler itself. See the docs for %prun for details. |
|
1559 | profiler itself. See the docs for %prun for details. | |
1559 |
|
1560 | |||
1560 | In this mode, the program's variables do NOT propagate back to the |
|
1561 | In this mode, the program's variables do NOT propagate back to the | |
1561 | IPython interactive namespace (because they remain in the namespace |
|
1562 | IPython interactive namespace (because they remain in the namespace | |
1562 | where the profiler executes them). |
|
1563 | where the profiler executes them). | |
1563 |
|
1564 | |||
1564 | Internally this triggers a call to %prun, see its documentation for |
|
1565 | Internally this triggers a call to %prun, see its documentation for | |
1565 | details on the options available specifically for profiling. |
|
1566 | details on the options available specifically for profiling. | |
1566 |
|
1567 | |||
1567 | There is one special usage for which the text above doesn't apply: |
|
1568 | There is one special usage for which the text above doesn't apply: | |
1568 | if the filename ends with .ipy, the file is run as ipython script, |
|
1569 | if the filename ends with .ipy, the file is run as ipython script, | |
1569 | just as if the commands were written on IPython prompt. |
|
1570 | just as if the commands were written on IPython prompt. | |
1570 |
|
1571 | |||
1571 | -m: specify module name to load instead of script path. Similar to |
|
1572 | -m: specify module name to load instead of script path. Similar to | |
1572 | the -m option for the python interpreter. Use this option last if you |
|
1573 | the -m option for the python interpreter. Use this option last if you | |
1573 | want to combine with other %run options. Unlike the python interpreter |
|
1574 | want to combine with other %run options. Unlike the python interpreter | |
1574 | only source modules are allowed no .pyc or .pyo files. |
|
1575 | only source modules are allowed no .pyc or .pyo files. | |
1575 | For example: |
|
1576 | For example: | |
1576 |
|
1577 | |||
1577 | %run -m example |
|
1578 | %run -m example | |
1578 |
|
1579 | |||
1579 | will run the example module. |
|
1580 | will run the example module. | |
1580 |
|
1581 | |||
1581 | """ |
|
1582 | """ | |
1582 |
|
1583 | |||
1583 | # get arguments and set sys.argv for program to be run. |
|
1584 | # get arguments and set sys.argv for program to be run. | |
1584 | opts, arg_lst = self.parse_options(parameter_s, 'nidtN:b:pD:l:rs:T:em:', |
|
1585 | opts, arg_lst = self.parse_options(parameter_s, 'nidtN:b:pD:l:rs:T:em:', | |
1585 | mode='list', list_all=1) |
|
1586 | mode='list', list_all=1) | |
1586 | if "m" in opts: |
|
1587 | if "m" in opts: | |
1587 | modulename = opts["m"][0] |
|
1588 | modulename = opts["m"][0] | |
1588 | modpath = find_mod(modulename) |
|
1589 | modpath = find_mod(modulename) | |
1589 | if modpath is None: |
|
1590 | if modpath is None: | |
1590 | warn('%r is not a valid modulename on sys.path'%modulename) |
|
1591 | warn('%r is not a valid modulename on sys.path'%modulename) | |
1591 | return |
|
1592 | return | |
1592 | arg_lst = [modpath] + arg_lst |
|
1593 | arg_lst = [modpath] + arg_lst | |
1593 | try: |
|
1594 | try: | |
1594 | filename = file_finder(arg_lst[0]) |
|
1595 | filename = file_finder(arg_lst[0]) | |
1595 | except IndexError: |
|
1596 | except IndexError: | |
1596 | warn('you must provide at least a filename.') |
|
1597 | warn('you must provide at least a filename.') | |
1597 | print '\n%run:\n', oinspect.getdoc(self.magic_run) |
|
1598 | print '\n%run:\n', oinspect.getdoc(self.magic_run) | |
1598 | return |
|
1599 | return | |
1599 | except IOError as e: |
|
1600 | except IOError as e: | |
1600 | try: |
|
1601 | try: | |
1601 | msg = str(e) |
|
1602 | msg = str(e) | |
1602 | except UnicodeError: |
|
1603 | except UnicodeError: | |
1603 | msg = e.message |
|
1604 | msg = e.message | |
1604 | error(msg) |
|
1605 | error(msg) | |
1605 | return |
|
1606 | return | |
1606 |
|
1607 | |||
1607 | if filename.lower().endswith('.ipy'): |
|
1608 | if filename.lower().endswith('.ipy'): | |
1608 | self.shell.safe_execfile_ipy(filename) |
|
1609 | self.shell.safe_execfile_ipy(filename) | |
1609 | return |
|
1610 | return | |
1610 |
|
1611 | |||
1611 | # Control the response to exit() calls made by the script being run |
|
1612 | # Control the response to exit() calls made by the script being run | |
1612 | exit_ignore = 'e' in opts |
|
1613 | exit_ignore = 'e' in opts | |
1613 |
|
1614 | |||
1614 | # Make sure that the running script gets a proper sys.argv as if it |
|
1615 | # Make sure that the running script gets a proper sys.argv as if it | |
1615 | # were run from a system shell. |
|
1616 | # were run from a system shell. | |
1616 | save_argv = sys.argv # save it for later restoring |
|
1617 | save_argv = sys.argv # save it for later restoring | |
1617 |
|
1618 | |||
1618 | # simulate shell expansion on arguments, at least tilde expansion |
|
1619 | # simulate shell expansion on arguments, at least tilde expansion | |
1619 | args = [ os.path.expanduser(a) for a in arg_lst[1:] ] |
|
1620 | args = [ os.path.expanduser(a) for a in arg_lst[1:] ] | |
1620 |
|
1621 | |||
1621 | sys.argv = [filename] + args # put in the proper filename |
|
1622 | sys.argv = [filename] + args # put in the proper filename | |
1622 | # protect sys.argv from potential unicode strings on Python 2: |
|
1623 | # protect sys.argv from potential unicode strings on Python 2: | |
1623 | if not py3compat.PY3: |
|
1624 | if not py3compat.PY3: | |
1624 | sys.argv = [ py3compat.cast_bytes(a) for a in sys.argv ] |
|
1625 | sys.argv = [ py3compat.cast_bytes(a) for a in sys.argv ] | |
1625 |
|
1626 | |||
1626 | if 'i' in opts: |
|
1627 | if 'i' in opts: | |
1627 | # Run in user's interactive namespace |
|
1628 | # Run in user's interactive namespace | |
1628 | prog_ns = self.shell.user_ns |
|
1629 | prog_ns = self.shell.user_ns | |
1629 | __name__save = self.shell.user_ns['__name__'] |
|
1630 | __name__save = self.shell.user_ns['__name__'] | |
1630 | prog_ns['__name__'] = '__main__' |
|
1631 | prog_ns['__name__'] = '__main__' | |
1631 | main_mod = self.shell.new_main_mod(prog_ns) |
|
1632 | main_mod = self.shell.new_main_mod(prog_ns) | |
1632 | else: |
|
1633 | else: | |
1633 | # Run in a fresh, empty namespace |
|
1634 | # Run in a fresh, empty namespace | |
1634 | if 'n' in opts: |
|
1635 | if 'n' in opts: | |
1635 | name = os.path.splitext(os.path.basename(filename))[0] |
|
1636 | name = os.path.splitext(os.path.basename(filename))[0] | |
1636 | else: |
|
1637 | else: | |
1637 | name = '__main__' |
|
1638 | name = '__main__' | |
1638 |
|
1639 | |||
1639 | main_mod = self.shell.new_main_mod() |
|
1640 | main_mod = self.shell.new_main_mod() | |
1640 | prog_ns = main_mod.__dict__ |
|
1641 | prog_ns = main_mod.__dict__ | |
1641 | prog_ns['__name__'] = name |
|
1642 | prog_ns['__name__'] = name | |
1642 |
|
1643 | |||
1643 | # Since '%run foo' emulates 'python foo.py' at the cmd line, we must |
|
1644 | # Since '%run foo' emulates 'python foo.py' at the cmd line, we must | |
1644 | # set the __file__ global in the script's namespace |
|
1645 | # set the __file__ global in the script's namespace | |
1645 | prog_ns['__file__'] = filename |
|
1646 | prog_ns['__file__'] = filename | |
1646 |
|
1647 | |||
1647 | # pickle fix. See interactiveshell for an explanation. But we need to make sure |
|
1648 | # pickle fix. See interactiveshell for an explanation. But we need to make sure | |
1648 | # that, if we overwrite __main__, we replace it at the end |
|
1649 | # that, if we overwrite __main__, we replace it at the end | |
1649 | main_mod_name = prog_ns['__name__'] |
|
1650 | main_mod_name = prog_ns['__name__'] | |
1650 |
|
1651 | |||
1651 | if main_mod_name == '__main__': |
|
1652 | if main_mod_name == '__main__': | |
1652 | restore_main = sys.modules['__main__'] |
|
1653 | restore_main = sys.modules['__main__'] | |
1653 | else: |
|
1654 | else: | |
1654 | restore_main = False |
|
1655 | restore_main = False | |
1655 |
|
1656 | |||
1656 | # This needs to be undone at the end to prevent holding references to |
|
1657 | # This needs to be undone at the end to prevent holding references to | |
1657 | # every single object ever created. |
|
1658 | # every single object ever created. | |
1658 | sys.modules[main_mod_name] = main_mod |
|
1659 | sys.modules[main_mod_name] = main_mod | |
1659 |
|
1660 | |||
1660 | try: |
|
1661 | try: | |
1661 | stats = None |
|
1662 | stats = None | |
1662 | with self.readline_no_record: |
|
1663 | with self.readline_no_record: | |
1663 | if 'p' in opts: |
|
1664 | if 'p' in opts: | |
1664 | stats = self.magic_prun('', 0, opts, arg_lst, prog_ns) |
|
1665 | stats = self.magic_prun('', 0, opts, arg_lst, prog_ns) | |
1665 | else: |
|
1666 | else: | |
1666 | if 'd' in opts: |
|
1667 | if 'd' in opts: | |
1667 | deb = debugger.Pdb(self.shell.colors) |
|
1668 | deb = debugger.Pdb(self.shell.colors) | |
1668 | # reset Breakpoint state, which is moronically kept |
|
1669 | # reset Breakpoint state, which is moronically kept | |
1669 | # in a class |
|
1670 | # in a class | |
1670 | bdb.Breakpoint.next = 1 |
|
1671 | bdb.Breakpoint.next = 1 | |
1671 | bdb.Breakpoint.bplist = {} |
|
1672 | bdb.Breakpoint.bplist = {} | |
1672 | bdb.Breakpoint.bpbynumber = [None] |
|
1673 | bdb.Breakpoint.bpbynumber = [None] | |
1673 | # Set an initial breakpoint to stop execution |
|
1674 | # Set an initial breakpoint to stop execution | |
1674 | maxtries = 10 |
|
1675 | maxtries = 10 | |
1675 | bp = int(opts.get('b', [1])[0]) |
|
1676 | bp = int(opts.get('b', [1])[0]) | |
1676 | checkline = deb.checkline(filename, bp) |
|
1677 | checkline = deb.checkline(filename, bp) | |
1677 | if not checkline: |
|
1678 | if not checkline: | |
1678 | for bp in range(bp + 1, bp + maxtries + 1): |
|
1679 | for bp in range(bp + 1, bp + maxtries + 1): | |
1679 | if deb.checkline(filename, bp): |
|
1680 | if deb.checkline(filename, bp): | |
1680 | break |
|
1681 | break | |
1681 | else: |
|
1682 | else: | |
1682 | msg = ("\nI failed to find a valid line to set " |
|
1683 | msg = ("\nI failed to find a valid line to set " | |
1683 | "a breakpoint\n" |
|
1684 | "a breakpoint\n" | |
1684 | "after trying up to line: %s.\n" |
|
1685 | "after trying up to line: %s.\n" | |
1685 | "Please set a valid breakpoint manually " |
|
1686 | "Please set a valid breakpoint manually " | |
1686 | "with the -b option." % bp) |
|
1687 | "with the -b option." % bp) | |
1687 | error(msg) |
|
1688 | error(msg) | |
1688 | return |
|
1689 | return | |
1689 | # if we find a good linenumber, set the breakpoint |
|
1690 | # if we find a good linenumber, set the breakpoint | |
1690 | deb.do_break('%s:%s' % (filename, bp)) |
|
1691 | deb.do_break('%s:%s' % (filename, bp)) | |
1691 | # Start file run |
|
1692 | # Start file run | |
1692 | print "NOTE: Enter 'c' at the", |
|
1693 | print "NOTE: Enter 'c' at the", | |
1693 | print "%s prompt to start your script." % deb.prompt |
|
1694 | print "%s prompt to start your script." % deb.prompt | |
1694 | try: |
|
1695 | try: | |
1695 | deb.run('execfile("%s")' % filename, prog_ns) |
|
1696 | deb.run('execfile("%s")' % filename, prog_ns) | |
1696 |
|
1697 | |||
1697 | except: |
|
1698 | except: | |
1698 | etype, value, tb = sys.exc_info() |
|
1699 | etype, value, tb = sys.exc_info() | |
1699 | # Skip three frames in the traceback: the %run one, |
|
1700 | # Skip three frames in the traceback: the %run one, | |
1700 | # one inside bdb.py, and the command-line typed by the |
|
1701 | # one inside bdb.py, and the command-line typed by the | |
1701 | # user (run by exec in pdb itself). |
|
1702 | # user (run by exec in pdb itself). | |
1702 | self.shell.InteractiveTB(etype, value, tb, tb_offset=3) |
|
1703 | self.shell.InteractiveTB(etype, value, tb, tb_offset=3) | |
1703 | else: |
|
1704 | else: | |
1704 | if runner is None: |
|
1705 | if runner is None: | |
1705 | runner = self.shell.safe_execfile |
|
1706 | runner = self.shell.safe_execfile | |
1706 | if 't' in opts: |
|
1707 | if 't' in opts: | |
1707 | # timed execution |
|
1708 | # timed execution | |
1708 | try: |
|
1709 | try: | |
1709 | nruns = int(opts['N'][0]) |
|
1710 | nruns = int(opts['N'][0]) | |
1710 | if nruns < 1: |
|
1711 | if nruns < 1: | |
1711 | error('Number of runs must be >=1') |
|
1712 | error('Number of runs must be >=1') | |
1712 | return |
|
1713 | return | |
1713 | except (KeyError): |
|
1714 | except (KeyError): | |
1714 | nruns = 1 |
|
1715 | nruns = 1 | |
1715 | twall0 = time.time() |
|
1716 | twall0 = time.time() | |
1716 | if nruns == 1: |
|
1717 | if nruns == 1: | |
1717 | t0 = clock2() |
|
1718 | t0 = clock2() | |
1718 | runner(filename, prog_ns, prog_ns, |
|
1719 | runner(filename, prog_ns, prog_ns, | |
1719 | exit_ignore=exit_ignore) |
|
1720 | exit_ignore=exit_ignore) | |
1720 | t1 = clock2() |
|
1721 | t1 = clock2() | |
1721 | t_usr = t1[0] - t0[0] |
|
1722 | t_usr = t1[0] - t0[0] | |
1722 | t_sys = t1[1] - t0[1] |
|
1723 | t_sys = t1[1] - t0[1] | |
1723 | print "\nIPython CPU timings (estimated):" |
|
1724 | print "\nIPython CPU timings (estimated):" | |
1724 | print " User : %10.2f s." % t_usr |
|
1725 | print " User : %10.2f s." % t_usr | |
1725 | print " System : %10.2f s." % t_sys |
|
1726 | print " System : %10.2f s." % t_sys | |
1726 | else: |
|
1727 | else: | |
1727 | runs = range(nruns) |
|
1728 | runs = range(nruns) | |
1728 | t0 = clock2() |
|
1729 | t0 = clock2() | |
1729 | for nr in runs: |
|
1730 | for nr in runs: | |
1730 | runner(filename, prog_ns, prog_ns, |
|
1731 | runner(filename, prog_ns, prog_ns, | |
1731 | exit_ignore=exit_ignore) |
|
1732 | exit_ignore=exit_ignore) | |
1732 | t1 = clock2() |
|
1733 | t1 = clock2() | |
1733 | t_usr = t1[0] - t0[0] |
|
1734 | t_usr = t1[0] - t0[0] | |
1734 | t_sys = t1[1] - t0[1] |
|
1735 | t_sys = t1[1] - t0[1] | |
1735 | print "\nIPython CPU timings (estimated):" |
|
1736 | print "\nIPython CPU timings (estimated):" | |
1736 | print "Total runs performed:", nruns |
|
1737 | print "Total runs performed:", nruns | |
1737 | print " Times : %10.2f %10.2f" % ('Total', 'Per run') |
|
1738 | print " Times : %10.2f %10.2f" % ('Total', 'Per run') | |
1738 | print " User : %10.2f s, %10.2f s." % (t_usr, t_usr / nruns) |
|
1739 | print " User : %10.2f s, %10.2f s." % (t_usr, t_usr / nruns) | |
1739 | print " System : %10.2f s, %10.2f s." % (t_sys, t_sys / nruns) |
|
1740 | print " System : %10.2f s, %10.2f s." % (t_sys, t_sys / nruns) | |
1740 | twall1 = time.time() |
|
1741 | twall1 = time.time() | |
1741 | print "Wall time: %10.2f s." % (twall1 - twall0) |
|
1742 | print "Wall time: %10.2f s." % (twall1 - twall0) | |
1742 |
|
1743 | |||
1743 | else: |
|
1744 | else: | |
1744 | # regular execution |
|
1745 | # regular execution | |
1745 | runner(filename, prog_ns, prog_ns, exit_ignore=exit_ignore) |
|
1746 | runner(filename, prog_ns, prog_ns, exit_ignore=exit_ignore) | |
1746 |
|
1747 | |||
1747 | if 'i' in opts: |
|
1748 | if 'i' in opts: | |
1748 | self.shell.user_ns['__name__'] = __name__save |
|
1749 | self.shell.user_ns['__name__'] = __name__save | |
1749 | else: |
|
1750 | else: | |
1750 | # The shell MUST hold a reference to prog_ns so after %run |
|
1751 | # The shell MUST hold a reference to prog_ns so after %run | |
1751 | # exits, the python deletion mechanism doesn't zero it out |
|
1752 | # exits, the python deletion mechanism doesn't zero it out | |
1752 | # (leaving dangling references). |
|
1753 | # (leaving dangling references). | |
1753 | self.shell.cache_main_mod(prog_ns, filename) |
|
1754 | self.shell.cache_main_mod(prog_ns, filename) | |
1754 | # update IPython interactive namespace |
|
1755 | # update IPython interactive namespace | |
1755 |
|
1756 | |||
1756 | # Some forms of read errors on the file may mean the |
|
1757 | # Some forms of read errors on the file may mean the | |
1757 | # __name__ key was never set; using pop we don't have to |
|
1758 | # __name__ key was never set; using pop we don't have to | |
1758 | # worry about a possible KeyError. |
|
1759 | # worry about a possible KeyError. | |
1759 | prog_ns.pop('__name__', None) |
|
1760 | prog_ns.pop('__name__', None) | |
1760 |
|
1761 | |||
1761 | self.shell.user_ns.update(prog_ns) |
|
1762 | self.shell.user_ns.update(prog_ns) | |
1762 | finally: |
|
1763 | finally: | |
1763 | # It's a bit of a mystery why, but __builtins__ can change from |
|
1764 | # It's a bit of a mystery why, but __builtins__ can change from | |
1764 | # being a module to becoming a dict missing some key data after |
|
1765 | # being a module to becoming a dict missing some key data after | |
1765 | # %run. As best I can see, this is NOT something IPython is doing |
|
1766 | # %run. As best I can see, this is NOT something IPython is doing | |
1766 | # at all, and similar problems have been reported before: |
|
1767 | # at all, and similar problems have been reported before: | |
1767 | # http://coding.derkeiler.com/Archive/Python/comp.lang.python/2004-10/0188.html |
|
1768 | # http://coding.derkeiler.com/Archive/Python/comp.lang.python/2004-10/0188.html | |
1768 | # Since this seems to be done by the interpreter itself, the best |
|
1769 | # Since this seems to be done by the interpreter itself, the best | |
1769 | # we can do is to at least restore __builtins__ for the user on |
|
1770 | # we can do is to at least restore __builtins__ for the user on | |
1770 | # exit. |
|
1771 | # exit. | |
1771 | self.shell.user_ns['__builtins__'] = builtin_mod |
|
1772 | self.shell.user_ns['__builtins__'] = builtin_mod | |
1772 |
|
1773 | |||
1773 | # Ensure key global structures are restored |
|
1774 | # Ensure key global structures are restored | |
1774 | sys.argv = save_argv |
|
1775 | sys.argv = save_argv | |
1775 | if restore_main: |
|
1776 | if restore_main: | |
1776 | sys.modules['__main__'] = restore_main |
|
1777 | sys.modules['__main__'] = restore_main | |
1777 | else: |
|
1778 | else: | |
1778 | # Remove from sys.modules the reference to main_mod we'd |
|
1779 | # Remove from sys.modules the reference to main_mod we'd | |
1779 | # added. Otherwise it will trap references to objects |
|
1780 | # added. Otherwise it will trap references to objects | |
1780 | # contained therein. |
|
1781 | # contained therein. | |
1781 | del sys.modules[main_mod_name] |
|
1782 | del sys.modules[main_mod_name] | |
1782 |
|
1783 | |||
1783 | return stats |
|
1784 | return stats | |
1784 |
|
1785 | |||
1785 | @skip_doctest |
|
1786 | @skip_doctest | |
1786 | def magic_timeit(self, parameter_s =''): |
|
1787 | def magic_timeit(self, parameter_s =''): | |
1787 | """Time execution of a Python statement or expression |
|
1788 | """Time execution of a Python statement or expression | |
1788 |
|
1789 | |||
1789 | Usage:\\ |
|
1790 | Usage:\\ | |
1790 | %timeit [-n<N> -r<R> [-t|-c]] statement |
|
1791 | %timeit [-n<N> -r<R> [-t|-c]] statement | |
1791 |
|
1792 | |||
1792 | Time execution of a Python statement or expression using the timeit |
|
1793 | Time execution of a Python statement or expression using the timeit | |
1793 | module. |
|
1794 | module. | |
1794 |
|
1795 | |||
1795 | Options: |
|
1796 | Options: | |
1796 | -n<N>: execute the given statement <N> times in a loop. If this value |
|
1797 | -n<N>: execute the given statement <N> times in a loop. If this value | |
1797 | is not given, a fitting value is chosen. |
|
1798 | is not given, a fitting value is chosen. | |
1798 |
|
1799 | |||
1799 | -r<R>: repeat the loop iteration <R> times and take the best result. |
|
1800 | -r<R>: repeat the loop iteration <R> times and take the best result. | |
1800 | Default: 3 |
|
1801 | Default: 3 | |
1801 |
|
1802 | |||
1802 | -t: use time.time to measure the time, which is the default on Unix. |
|
1803 | -t: use time.time to measure the time, which is the default on Unix. | |
1803 | This function measures wall time. |
|
1804 | This function measures wall time. | |
1804 |
|
1805 | |||
1805 | -c: use time.clock to measure the time, which is the default on |
|
1806 | -c: use time.clock to measure the time, which is the default on | |
1806 | Windows and measures wall time. On Unix, resource.getrusage is used |
|
1807 | Windows and measures wall time. On Unix, resource.getrusage is used | |
1807 | instead and returns the CPU user time. |
|
1808 | instead and returns the CPU user time. | |
1808 |
|
1809 | |||
1809 | -p<P>: use a precision of <P> digits to display the timing result. |
|
1810 | -p<P>: use a precision of <P> digits to display the timing result. | |
1810 | Default: 3 |
|
1811 | Default: 3 | |
1811 |
|
1812 | |||
1812 |
|
1813 | |||
1813 | Examples: |
|
1814 | Examples: | |
1814 |
|
1815 | |||
1815 | In [1]: %timeit pass |
|
1816 | In [1]: %timeit pass | |
1816 | 10000000 loops, best of 3: 53.3 ns per loop |
|
1817 | 10000000 loops, best of 3: 53.3 ns per loop | |
1817 |
|
1818 | |||
1818 | In [2]: u = None |
|
1819 | In [2]: u = None | |
1819 |
|
1820 | |||
1820 | In [3]: %timeit u is None |
|
1821 | In [3]: %timeit u is None | |
1821 | 10000000 loops, best of 3: 184 ns per loop |
|
1822 | 10000000 loops, best of 3: 184 ns per loop | |
1822 |
|
1823 | |||
1823 | In [4]: %timeit -r 4 u == None |
|
1824 | In [4]: %timeit -r 4 u == None | |
1824 | 1000000 loops, best of 4: 242 ns per loop |
|
1825 | 1000000 loops, best of 4: 242 ns per loop | |
1825 |
|
1826 | |||
1826 | In [5]: import time |
|
1827 | In [5]: import time | |
1827 |
|
1828 | |||
1828 | In [6]: %timeit -n1 time.sleep(2) |
|
1829 | In [6]: %timeit -n1 time.sleep(2) | |
1829 | 1 loops, best of 3: 2 s per loop |
|
1830 | 1 loops, best of 3: 2 s per loop | |
1830 |
|
1831 | |||
1831 |
|
1832 | |||
1832 | The times reported by %timeit will be slightly higher than those |
|
1833 | The times reported by %timeit will be slightly higher than those | |
1833 | reported by the timeit.py script when variables are accessed. This is |
|
1834 | reported by the timeit.py script when variables are accessed. This is | |
1834 | due to the fact that %timeit executes the statement in the namespace |
|
1835 | due to the fact that %timeit executes the statement in the namespace | |
1835 | of the shell, compared with timeit.py, which uses a single setup |
|
1836 | of the shell, compared with timeit.py, which uses a single setup | |
1836 | statement to import function or create variables. Generally, the bias |
|
1837 | statement to import function or create variables. Generally, the bias | |
1837 | does not matter as long as results from timeit.py are not mixed with |
|
1838 | does not matter as long as results from timeit.py are not mixed with | |
1838 | those from %timeit.""" |
|
1839 | those from %timeit.""" | |
1839 |
|
1840 | |||
1840 | import timeit |
|
1841 | import timeit | |
1841 | import math |
|
1842 | import math | |
1842 |
|
1843 | |||
1843 | # XXX: Unfortunately the unicode 'micro' symbol can cause problems in |
|
1844 | # XXX: Unfortunately the unicode 'micro' symbol can cause problems in | |
1844 | # certain terminals. Until we figure out a robust way of |
|
1845 | # certain terminals. Until we figure out a robust way of | |
1845 | # auto-detecting if the terminal can deal with it, use plain 'us' for |
|
1846 | # auto-detecting if the terminal can deal with it, use plain 'us' for | |
1846 | # microseconds. I am really NOT happy about disabling the proper |
|
1847 | # microseconds. I am really NOT happy about disabling the proper | |
1847 | # 'micro' prefix, but crashing is worse... If anyone knows what the |
|
1848 | # 'micro' prefix, but crashing is worse... If anyone knows what the | |
1848 | # right solution for this is, I'm all ears... |
|
1849 | # right solution for this is, I'm all ears... | |
1849 | # |
|
1850 | # | |
1850 | # Note: using |
|
1851 | # Note: using | |
1851 | # |
|
1852 | # | |
1852 | # s = u'\xb5' |
|
1853 | # s = u'\xb5' | |
1853 | # s.encode(sys.getdefaultencoding()) |
|
1854 | # s.encode(sys.getdefaultencoding()) | |
1854 | # |
|
1855 | # | |
1855 | # is not sufficient, as I've seen terminals where that fails but |
|
1856 | # is not sufficient, as I've seen terminals where that fails but | |
1856 | # print s |
|
1857 | # print s | |
1857 | # |
|
1858 | # | |
1858 | # succeeds |
|
1859 | # succeeds | |
1859 | # |
|
1860 | # | |
1860 | # See bug: https://bugs.launchpad.net/ipython/+bug/348466 |
|
1861 | # See bug: https://bugs.launchpad.net/ipython/+bug/348466 | |
1861 |
|
1862 | |||
1862 | #units = [u"s", u"ms",u'\xb5',"ns"] |
|
1863 | #units = [u"s", u"ms",u'\xb5',"ns"] | |
1863 | units = [u"s", u"ms",u'us',"ns"] |
|
1864 | units = [u"s", u"ms",u'us',"ns"] | |
1864 |
|
1865 | |||
1865 | scaling = [1, 1e3, 1e6, 1e9] |
|
1866 | scaling = [1, 1e3, 1e6, 1e9] | |
1866 |
|
1867 | |||
1867 | opts, stmt = self.parse_options(parameter_s,'n:r:tcp:', |
|
1868 | opts, stmt = self.parse_options(parameter_s,'n:r:tcp:', | |
1868 | posix=False) |
|
1869 | posix=False, strict=False) | |
1869 | if stmt == "": |
|
1870 | if stmt == "": | |
1870 | return |
|
1871 | return | |
1871 | timefunc = timeit.default_timer |
|
1872 | timefunc = timeit.default_timer | |
1872 | number = int(getattr(opts, "n", 0)) |
|
1873 | number = int(getattr(opts, "n", 0)) | |
1873 | repeat = int(getattr(opts, "r", timeit.default_repeat)) |
|
1874 | repeat = int(getattr(opts, "r", timeit.default_repeat)) | |
1874 | precision = int(getattr(opts, "p", 3)) |
|
1875 | precision = int(getattr(opts, "p", 3)) | |
1875 | if hasattr(opts, "t"): |
|
1876 | if hasattr(opts, "t"): | |
1876 | timefunc = time.time |
|
1877 | timefunc = time.time | |
1877 | if hasattr(opts, "c"): |
|
1878 | if hasattr(opts, "c"): | |
1878 | timefunc = clock |
|
1879 | timefunc = clock | |
1879 |
|
1880 | |||
1880 | timer = timeit.Timer(timer=timefunc) |
|
1881 | timer = timeit.Timer(timer=timefunc) | |
1881 | # this code has tight coupling to the inner workings of timeit.Timer, |
|
1882 | # this code has tight coupling to the inner workings of timeit.Timer, | |
1882 | # but is there a better way to achieve that the code stmt has access |
|
1883 | # but is there a better way to achieve that the code stmt has access | |
1883 | # to the shell namespace? |
|
1884 | # to the shell namespace? | |
1884 |
|
1885 | |||
1885 | src = timeit.template % {'stmt': timeit.reindent(stmt, 8), |
|
1886 | src = timeit.template % {'stmt': timeit.reindent(stmt, 8), | |
1886 | 'setup': "pass"} |
|
1887 | 'setup': "pass"} | |
1887 | # Track compilation time so it can be reported if too long |
|
1888 | # Track compilation time so it can be reported if too long | |
1888 | # Minimum time above which compilation time will be reported |
|
1889 | # Minimum time above which compilation time will be reported | |
1889 | tc_min = 0.1 |
|
1890 | tc_min = 0.1 | |
1890 |
|
1891 | |||
1891 | t0 = clock() |
|
1892 | t0 = clock() | |
1892 | code = compile(src, "<magic-timeit>", "exec") |
|
1893 | code = compile(src, "<magic-timeit>", "exec") | |
1893 | tc = clock()-t0 |
|
1894 | tc = clock()-t0 | |
1894 |
|
1895 | |||
1895 | ns = {} |
|
1896 | ns = {} | |
1896 | exec code in self.shell.user_ns, ns |
|
1897 | exec code in self.shell.user_ns, ns | |
1897 | timer.inner = ns["inner"] |
|
1898 | timer.inner = ns["inner"] | |
1898 |
|
1899 | |||
1899 | if number == 0: |
|
1900 | if number == 0: | |
1900 | # determine number so that 0.2 <= total time < 2.0 |
|
1901 | # determine number so that 0.2 <= total time < 2.0 | |
1901 | number = 1 |
|
1902 | number = 1 | |
1902 | for i in range(1, 10): |
|
1903 | for i in range(1, 10): | |
1903 | if timer.timeit(number) >= 0.2: |
|
1904 | if timer.timeit(number) >= 0.2: | |
1904 | break |
|
1905 | break | |
1905 | number *= 10 |
|
1906 | number *= 10 | |
1906 |
|
1907 | |||
1907 | best = min(timer.repeat(repeat, number)) / number |
|
1908 | best = min(timer.repeat(repeat, number)) / number | |
1908 |
|
1909 | |||
1909 | if best > 0.0 and best < 1000.0: |
|
1910 | if best > 0.0 and best < 1000.0: | |
1910 | order = min(-int(math.floor(math.log10(best)) // 3), 3) |
|
1911 | order = min(-int(math.floor(math.log10(best)) // 3), 3) | |
1911 | elif best >= 1000.0: |
|
1912 | elif best >= 1000.0: | |
1912 | order = 0 |
|
1913 | order = 0 | |
1913 | else: |
|
1914 | else: | |
1914 | order = 3 |
|
1915 | order = 3 | |
1915 | print u"%d loops, best of %d: %.*g %s per loop" % (number, repeat, |
|
1916 | print u"%d loops, best of %d: %.*g %s per loop" % (number, repeat, | |
1916 | precision, |
|
1917 | precision, | |
1917 | best * scaling[order], |
|
1918 | best * scaling[order], | |
1918 | units[order]) |
|
1919 | units[order]) | |
1919 | if tc > tc_min: |
|
1920 | if tc > tc_min: | |
1920 | print "Compiler time: %.2f s" % tc |
|
1921 | print "Compiler time: %.2f s" % tc | |
1921 |
|
1922 | |||
1922 | @skip_doctest |
|
1923 | @skip_doctest | |
1923 | @needs_local_scope |
|
1924 | @needs_local_scope | |
1924 | def magic_time(self,parameter_s = ''): |
|
1925 | def magic_time(self,parameter_s = ''): | |
1925 | """Time execution of a Python statement or expression. |
|
1926 | """Time execution of a Python statement or expression. | |
1926 |
|
1927 | |||
1927 | The CPU and wall clock times are printed, and the value of the |
|
1928 | The CPU and wall clock times are printed, and the value of the | |
1928 | expression (if any) is returned. Note that under Win32, system time |
|
1929 | expression (if any) is returned. Note that under Win32, system time | |
1929 | is always reported as 0, since it can not be measured. |
|
1930 | is always reported as 0, since it can not be measured. | |
1930 |
|
1931 | |||
1931 | This function provides very basic timing functionality. In Python |
|
1932 | This function provides very basic timing functionality. In Python | |
1932 | 2.3, the timeit module offers more control and sophistication, so this |
|
1933 | 2.3, the timeit module offers more control and sophistication, so this | |
1933 | could be rewritten to use it (patches welcome). |
|
1934 | could be rewritten to use it (patches welcome). | |
1934 |
|
1935 | |||
1935 | Some examples: |
|
1936 | Some examples: | |
1936 |
|
1937 | |||
1937 | In [1]: time 2**128 |
|
1938 | In [1]: time 2**128 | |
1938 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1939 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s | |
1939 | Wall time: 0.00 |
|
1940 | Wall time: 0.00 | |
1940 | Out[1]: 340282366920938463463374607431768211456L |
|
1941 | Out[1]: 340282366920938463463374607431768211456L | |
1941 |
|
1942 | |||
1942 | In [2]: n = 1000000 |
|
1943 | In [2]: n = 1000000 | |
1943 |
|
1944 | |||
1944 | In [3]: time sum(range(n)) |
|
1945 | In [3]: time sum(range(n)) | |
1945 | CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s |
|
1946 | CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s | |
1946 | Wall time: 1.37 |
|
1947 | Wall time: 1.37 | |
1947 | Out[3]: 499999500000L |
|
1948 | Out[3]: 499999500000L | |
1948 |
|
1949 | |||
1949 | In [4]: time print 'hello world' |
|
1950 | In [4]: time print 'hello world' | |
1950 | hello world |
|
1951 | hello world | |
1951 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1952 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s | |
1952 | Wall time: 0.00 |
|
1953 | Wall time: 0.00 | |
1953 |
|
1954 | |||
1954 | Note that the time needed by Python to compile the given expression |
|
1955 | Note that the time needed by Python to compile the given expression | |
1955 | will be reported if it is more than 0.1s. In this example, the |
|
1956 | will be reported if it is more than 0.1s. In this example, the | |
1956 | actual exponentiation is done by Python at compilation time, so while |
|
1957 | actual exponentiation is done by Python at compilation time, so while | |
1957 | the expression can take a noticeable amount of time to compute, that |
|
1958 | the expression can take a noticeable amount of time to compute, that | |
1958 | time is purely due to the compilation: |
|
1959 | time is purely due to the compilation: | |
1959 |
|
1960 | |||
1960 | In [5]: time 3**9999; |
|
1961 | In [5]: time 3**9999; | |
1961 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1962 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s | |
1962 | Wall time: 0.00 s |
|
1963 | Wall time: 0.00 s | |
1963 |
|
1964 | |||
1964 | In [6]: time 3**999999; |
|
1965 | In [6]: time 3**999999; | |
1965 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1966 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s | |
1966 | Wall time: 0.00 s |
|
1967 | Wall time: 0.00 s | |
1967 | Compiler : 0.78 s |
|
1968 | Compiler : 0.78 s | |
1968 | """ |
|
1969 | """ | |
1969 |
|
1970 | |||
1970 | # fail immediately if the given expression can't be compiled |
|
1971 | # fail immediately if the given expression can't be compiled | |
1971 |
|
1972 | |||
1972 | expr = self.shell.prefilter(parameter_s,False) |
|
1973 | expr = self.shell.prefilter(parameter_s,False) | |
1973 |
|
1974 | |||
1974 | # Minimum time above which compilation time will be reported |
|
1975 | # Minimum time above which compilation time will be reported | |
1975 | tc_min = 0.1 |
|
1976 | tc_min = 0.1 | |
1976 |
|
1977 | |||
1977 | try: |
|
1978 | try: | |
1978 | mode = 'eval' |
|
1979 | mode = 'eval' | |
1979 | t0 = clock() |
|
1980 | t0 = clock() | |
1980 | code = compile(expr,'<timed eval>',mode) |
|
1981 | code = compile(expr,'<timed eval>',mode) | |
1981 | tc = clock()-t0 |
|
1982 | tc = clock()-t0 | |
1982 | except SyntaxError: |
|
1983 | except SyntaxError: | |
1983 | mode = 'exec' |
|
1984 | mode = 'exec' | |
1984 | t0 = clock() |
|
1985 | t0 = clock() | |
1985 | code = compile(expr,'<timed exec>',mode) |
|
1986 | code = compile(expr,'<timed exec>',mode) | |
1986 | tc = clock()-t0 |
|
1987 | tc = clock()-t0 | |
1987 | # skew measurement as little as possible |
|
1988 | # skew measurement as little as possible | |
1988 | glob = self.shell.user_ns |
|
1989 | glob = self.shell.user_ns | |
1989 | locs = self._magic_locals |
|
1990 | locs = self._magic_locals | |
1990 | clk = clock2 |
|
1991 | clk = clock2 | |
1991 | wtime = time.time |
|
1992 | wtime = time.time | |
1992 | # time execution |
|
1993 | # time execution | |
1993 | wall_st = wtime() |
|
1994 | wall_st = wtime() | |
1994 | if mode=='eval': |
|
1995 | if mode=='eval': | |
1995 | st = clk() |
|
1996 | st = clk() | |
1996 | out = eval(code, glob, locs) |
|
1997 | out = eval(code, glob, locs) | |
1997 | end = clk() |
|
1998 | end = clk() | |
1998 | else: |
|
1999 | else: | |
1999 | st = clk() |
|
2000 | st = clk() | |
2000 | exec code in glob, locs |
|
2001 | exec code in glob, locs | |
2001 | end = clk() |
|
2002 | end = clk() | |
2002 | out = None |
|
2003 | out = None | |
2003 | wall_end = wtime() |
|
2004 | wall_end = wtime() | |
2004 | # Compute actual times and report |
|
2005 | # Compute actual times and report | |
2005 | wall_time = wall_end-wall_st |
|
2006 | wall_time = wall_end-wall_st | |
2006 | cpu_user = end[0]-st[0] |
|
2007 | cpu_user = end[0]-st[0] | |
2007 | cpu_sys = end[1]-st[1] |
|
2008 | cpu_sys = end[1]-st[1] | |
2008 | cpu_tot = cpu_user+cpu_sys |
|
2009 | cpu_tot = cpu_user+cpu_sys | |
2009 | print "CPU times: user %.2f s, sys: %.2f s, total: %.2f s" % \ |
|
2010 | print "CPU times: user %.2f s, sys: %.2f s, total: %.2f s" % \ | |
2010 | (cpu_user,cpu_sys,cpu_tot) |
|
2011 | (cpu_user,cpu_sys,cpu_tot) | |
2011 | print "Wall time: %.2f s" % wall_time |
|
2012 | print "Wall time: %.2f s" % wall_time | |
2012 | if tc > tc_min: |
|
2013 | if tc > tc_min: | |
2013 | print "Compiler : %.2f s" % tc |
|
2014 | print "Compiler : %.2f s" % tc | |
2014 | return out |
|
2015 | return out | |
2015 |
|
2016 | |||
2016 | @skip_doctest |
|
2017 | @skip_doctest | |
2017 | def magic_macro(self,parameter_s = ''): |
|
2018 | def magic_macro(self,parameter_s = ''): | |
2018 | """Define a macro for future re-execution. It accepts ranges of history, |
|
2019 | """Define a macro for future re-execution. It accepts ranges of history, | |
2019 | filenames or string objects. |
|
2020 | filenames or string objects. | |
2020 |
|
2021 | |||
2021 | Usage:\\ |
|
2022 | Usage:\\ | |
2022 | %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ... |
|
2023 | %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ... | |
2023 |
|
2024 | |||
2024 | Options: |
|
2025 | Options: | |
2025 |
|
2026 | |||
2026 | -r: use 'raw' input. By default, the 'processed' history is used, |
|
2027 | -r: use 'raw' input. By default, the 'processed' history is used, | |
2027 | so that magics are loaded in their transformed version to valid |
|
2028 | so that magics are loaded in their transformed version to valid | |
2028 | Python. If this option is given, the raw input as typed as the |
|
2029 | Python. If this option is given, the raw input as typed as the | |
2029 | command line is used instead. |
|
2030 | command line is used instead. | |
2030 |
|
2031 | |||
2031 | This will define a global variable called `name` which is a string |
|
2032 | This will define a global variable called `name` which is a string | |
2032 | made of joining the slices and lines you specify (n1,n2,... numbers |
|
2033 | made of joining the slices and lines you specify (n1,n2,... numbers | |
2033 | above) from your input history into a single string. This variable |
|
2034 | above) from your input history into a single string. This variable | |
2034 | acts like an automatic function which re-executes those lines as if |
|
2035 | acts like an automatic function which re-executes those lines as if | |
2035 | you had typed them. You just type 'name' at the prompt and the code |
|
2036 | you had typed them. You just type 'name' at the prompt and the code | |
2036 | executes. |
|
2037 | executes. | |
2037 |
|
2038 | |||
2038 | The syntax for indicating input ranges is described in %history. |
|
2039 | The syntax for indicating input ranges is described in %history. | |
2039 |
|
2040 | |||
2040 | Note: as a 'hidden' feature, you can also use traditional python slice |
|
2041 | Note: as a 'hidden' feature, you can also use traditional python slice | |
2041 | notation, where N:M means numbers N through M-1. |
|
2042 | notation, where N:M means numbers N through M-1. | |
2042 |
|
2043 | |||
2043 | For example, if your history contains (%hist prints it): |
|
2044 | For example, if your history contains (%hist prints it): | |
2044 |
|
2045 | |||
2045 | 44: x=1 |
|
2046 | 44: x=1 | |
2046 | 45: y=3 |
|
2047 | 45: y=3 | |
2047 | 46: z=x+y |
|
2048 | 46: z=x+y | |
2048 | 47: print x |
|
2049 | 47: print x | |
2049 | 48: a=5 |
|
2050 | 48: a=5 | |
2050 | 49: print 'x',x,'y',y |
|
2051 | 49: print 'x',x,'y',y | |
2051 |
|
2052 | |||
2052 | you can create a macro with lines 44 through 47 (included) and line 49 |
|
2053 | you can create a macro with lines 44 through 47 (included) and line 49 | |
2053 | called my_macro with: |
|
2054 | called my_macro with: | |
2054 |
|
2055 | |||
2055 | In [55]: %macro my_macro 44-47 49 |
|
2056 | In [55]: %macro my_macro 44-47 49 | |
2056 |
|
2057 | |||
2057 | Now, typing `my_macro` (without quotes) will re-execute all this code |
|
2058 | Now, typing `my_macro` (without quotes) will re-execute all this code | |
2058 | in one pass. |
|
2059 | in one pass. | |
2059 |
|
2060 | |||
2060 | You don't need to give the line-numbers in order, and any given line |
|
2061 | You don't need to give the line-numbers in order, and any given line | |
2061 | number can appear multiple times. You can assemble macros with any |
|
2062 | number can appear multiple times. You can assemble macros with any | |
2062 | lines from your input history in any order. |
|
2063 | lines from your input history in any order. | |
2063 |
|
2064 | |||
2064 | The macro is a simple object which holds its value in an attribute, |
|
2065 | The macro is a simple object which holds its value in an attribute, | |
2065 | but IPython's display system checks for macros and executes them as |
|
2066 | but IPython's display system checks for macros and executes them as | |
2066 | code instead of printing them when you type their name. |
|
2067 | code instead of printing them when you type their name. | |
2067 |
|
2068 | |||
2068 | You can view a macro's contents by explicitly printing it with: |
|
2069 | You can view a macro's contents by explicitly printing it with: | |
2069 |
|
2070 | |||
2070 | 'print macro_name'. |
|
2071 | 'print macro_name'. | |
2071 |
|
2072 | |||
2072 | """ |
|
2073 | """ | |
2073 | opts,args = self.parse_options(parameter_s,'r',mode='list') |
|
2074 | opts,args = self.parse_options(parameter_s,'r',mode='list') | |
2074 | if not args: # List existing macros |
|
2075 | if not args: # List existing macros | |
2075 | return sorted(k for k,v in self.shell.user_ns.iteritems() if\ |
|
2076 | return sorted(k for k,v in self.shell.user_ns.iteritems() if\ | |
2076 | isinstance(v, Macro)) |
|
2077 | isinstance(v, Macro)) | |
2077 | if len(args) == 1: |
|
2078 | if len(args) == 1: | |
2078 | raise UsageError( |
|
2079 | raise UsageError( | |
2079 | "%macro insufficient args; usage '%macro name n1-n2 n3-4...") |
|
2080 | "%macro insufficient args; usage '%macro name n1-n2 n3-4...") | |
2080 | name, codefrom = args[0], " ".join(args[1:]) |
|
2081 | name, codefrom = args[0], " ".join(args[1:]) | |
2081 |
|
2082 | |||
2082 | #print 'rng',ranges # dbg |
|
2083 | #print 'rng',ranges # dbg | |
2083 | try: |
|
2084 | try: | |
2084 | lines = self.shell.find_user_code(codefrom, 'r' in opts) |
|
2085 | lines = self.shell.find_user_code(codefrom, 'r' in opts) | |
2085 | except (ValueError, TypeError) as e: |
|
2086 | except (ValueError, TypeError) as e: | |
2086 | print e.args[0] |
|
2087 | print e.args[0] | |
2087 | return |
|
2088 | return | |
2088 | macro = Macro(lines) |
|
2089 | macro = Macro(lines) | |
2089 | self.shell.define_macro(name, macro) |
|
2090 | self.shell.define_macro(name, macro) | |
2090 | print 'Macro `%s` created. To execute, type its name (without quotes).' % name |
|
2091 | print 'Macro `%s` created. To execute, type its name (without quotes).' % name | |
2091 | print '=== Macro contents: ===' |
|
2092 | print '=== Macro contents: ===' | |
2092 | print macro, |
|
2093 | print macro, | |
2093 |
|
2094 | |||
2094 | def magic_save(self,parameter_s = ''): |
|
2095 | def magic_save(self,parameter_s = ''): | |
2095 | """Save a set of lines or a macro to a given filename. |
|
2096 | """Save a set of lines or a macro to a given filename. | |
2096 |
|
2097 | |||
2097 | Usage:\\ |
|
2098 | Usage:\\ | |
2098 | %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ... |
|
2099 | %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ... | |
2099 |
|
2100 | |||
2100 | Options: |
|
2101 | Options: | |
2101 |
|
2102 | |||
2102 | -r: use 'raw' input. By default, the 'processed' history is used, |
|
2103 | -r: use 'raw' input. By default, the 'processed' history is used, | |
2103 | so that magics are loaded in their transformed version to valid |
|
2104 | so that magics are loaded in their transformed version to valid | |
2104 | Python. If this option is given, the raw input as typed as the |
|
2105 | Python. If this option is given, the raw input as typed as the | |
2105 | command line is used instead. |
|
2106 | command line is used instead. | |
2106 |
|
2107 | |||
2107 | This function uses the same syntax as %history for input ranges, |
|
2108 | This function uses the same syntax as %history for input ranges, | |
2108 | then saves the lines to the filename you specify. |
|
2109 | then saves the lines to the filename you specify. | |
2109 |
|
2110 | |||
2110 | It adds a '.py' extension to the file if you don't do so yourself, and |
|
2111 | It adds a '.py' extension to the file if you don't do so yourself, and | |
2111 | it asks for confirmation before overwriting existing files.""" |
|
2112 | it asks for confirmation before overwriting existing files.""" | |
2112 |
|
2113 | |||
2113 | opts,args = self.parse_options(parameter_s,'r',mode='list') |
|
2114 | opts,args = self.parse_options(parameter_s,'r',mode='list') | |
2114 | fname, codefrom = unquote_filename(args[0]), " ".join(args[1:]) |
|
2115 | fname, codefrom = unquote_filename(args[0]), " ".join(args[1:]) | |
2115 | if not fname.endswith('.py'): |
|
2116 | if not fname.endswith('.py'): | |
2116 | fname += '.py' |
|
2117 | fname += '.py' | |
2117 | if os.path.isfile(fname): |
|
2118 | if os.path.isfile(fname): | |
2118 | ans = raw_input('File `%s` exists. Overwrite (y/[N])? ' % fname) |
|
2119 | ans = raw_input('File `%s` exists. Overwrite (y/[N])? ' % fname) | |
2119 | if ans.lower() not in ['y','yes']: |
|
2120 | if ans.lower() not in ['y','yes']: | |
2120 | print 'Operation cancelled.' |
|
2121 | print 'Operation cancelled.' | |
2121 | return |
|
2122 | return | |
2122 | try: |
|
2123 | try: | |
2123 | cmds = self.shell.find_user_code(codefrom, 'r' in opts) |
|
2124 | cmds = self.shell.find_user_code(codefrom, 'r' in opts) | |
2124 | except (TypeError, ValueError) as e: |
|
2125 | except (TypeError, ValueError) as e: | |
2125 | print e.args[0] |
|
2126 | print e.args[0] | |
2126 | return |
|
2127 | return | |
2127 | with py3compat.open(fname,'w', encoding="utf-8") as f: |
|
2128 | with py3compat.open(fname,'w', encoding="utf-8") as f: | |
2128 | f.write(u"# coding: utf-8\n") |
|
2129 | f.write(u"# coding: utf-8\n") | |
2129 | f.write(py3compat.cast_unicode(cmds)) |
|
2130 | f.write(py3compat.cast_unicode(cmds)) | |
2130 | print 'The following commands were written to file `%s`:' % fname |
|
2131 | print 'The following commands were written to file `%s`:' % fname | |
2131 | print cmds |
|
2132 | print cmds | |
2132 |
|
2133 | |||
2133 | def magic_pastebin(self, parameter_s = ''): |
|
2134 | def magic_pastebin(self, parameter_s = ''): | |
2134 | """Upload code to the 'Lodge it' paste bin, returning the URL.""" |
|
2135 | """Upload code to the 'Lodge it' paste bin, returning the URL.""" | |
2135 | try: |
|
2136 | try: | |
2136 | code = self.shell.find_user_code(parameter_s) |
|
2137 | code = self.shell.find_user_code(parameter_s) | |
2137 | except (ValueError, TypeError) as e: |
|
2138 | except (ValueError, TypeError) as e: | |
2138 | print e.args[0] |
|
2139 | print e.args[0] | |
2139 | return |
|
2140 | return | |
2140 | pbserver = ServerProxy('http://paste.pocoo.org/xmlrpc/') |
|
2141 | pbserver = ServerProxy('http://paste.pocoo.org/xmlrpc/') | |
2141 | id = pbserver.pastes.newPaste("python", code) |
|
2142 | id = pbserver.pastes.newPaste("python", code) | |
2142 | return "http://paste.pocoo.org/show/" + id |
|
2143 | return "http://paste.pocoo.org/show/" + id | |
2143 |
|
2144 | |||
2144 | def magic_loadpy(self, arg_s): |
|
2145 | def magic_loadpy(self, arg_s): | |
2145 | """Load a .py python script into the GUI console. |
|
2146 | """Load a .py python script into the GUI console. | |
2146 |
|
2147 | |||
2147 | This magic command can either take a local filename or a url:: |
|
2148 | This magic command can either take a local filename or a url:: | |
2148 |
|
2149 | |||
2149 | %loadpy myscript.py |
|
2150 | %loadpy myscript.py | |
2150 | %loadpy http://www.example.com/myscript.py |
|
2151 | %loadpy http://www.example.com/myscript.py | |
2151 | """ |
|
2152 | """ | |
2152 | arg_s = unquote_filename(arg_s) |
|
2153 | arg_s = unquote_filename(arg_s) | |
2153 | if not arg_s.endswith('.py'): |
|
2154 | if not arg_s.endswith('.py'): | |
2154 | raise ValueError('%%load only works with .py files: %s' % arg_s) |
|
2155 | raise ValueError('%%load only works with .py files: %s' % arg_s) | |
2155 | if arg_s.startswith('http'): |
|
2156 | if arg_s.startswith('http'): | |
2156 | import urllib2 |
|
2157 | import urllib2 | |
2157 | response = urllib2.urlopen(arg_s) |
|
2158 | response = urllib2.urlopen(arg_s) | |
2158 | content = response.read() |
|
2159 | content = response.read() | |
2159 | else: |
|
2160 | else: | |
2160 | with open(arg_s) as f: |
|
2161 | with open(arg_s) as f: | |
2161 | content = f.read() |
|
2162 | content = f.read() | |
2162 | self.set_next_input(content) |
|
2163 | self.set_next_input(content) | |
2163 |
|
2164 | |||
2164 | def _find_edit_target(self, args, opts, last_call): |
|
2165 | def _find_edit_target(self, args, opts, last_call): | |
2165 | """Utility method used by magic_edit to find what to edit.""" |
|
2166 | """Utility method used by magic_edit to find what to edit.""" | |
2166 |
|
2167 | |||
2167 | def make_filename(arg): |
|
2168 | def make_filename(arg): | |
2168 | "Make a filename from the given args" |
|
2169 | "Make a filename from the given args" | |
2169 | arg = unquote_filename(arg) |
|
2170 | arg = unquote_filename(arg) | |
2170 | try: |
|
2171 | try: | |
2171 | filename = get_py_filename(arg) |
|
2172 | filename = get_py_filename(arg) | |
2172 | except IOError: |
|
2173 | except IOError: | |
2173 | # If it ends with .py but doesn't already exist, assume we want |
|
2174 | # If it ends with .py but doesn't already exist, assume we want | |
2174 | # a new file. |
|
2175 | # a new file. | |
2175 | if arg.endswith('.py'): |
|
2176 | if arg.endswith('.py'): | |
2176 | filename = arg |
|
2177 | filename = arg | |
2177 | else: |
|
2178 | else: | |
2178 | filename = None |
|
2179 | filename = None | |
2179 | return filename |
|
2180 | return filename | |
2180 |
|
2181 | |||
2181 | # Set a few locals from the options for convenience: |
|
2182 | # Set a few locals from the options for convenience: | |
2182 | opts_prev = 'p' in opts |
|
2183 | opts_prev = 'p' in opts | |
2183 | opts_raw = 'r' in opts |
|
2184 | opts_raw = 'r' in opts | |
2184 |
|
2185 | |||
2185 | # custom exceptions |
|
2186 | # custom exceptions | |
2186 | class DataIsObject(Exception): pass |
|
2187 | class DataIsObject(Exception): pass | |
2187 |
|
2188 | |||
2188 | # Default line number value |
|
2189 | # Default line number value | |
2189 | lineno = opts.get('n',None) |
|
2190 | lineno = opts.get('n',None) | |
2190 |
|
2191 | |||
2191 | if opts_prev: |
|
2192 | if opts_prev: | |
2192 | args = '_%s' % last_call[0] |
|
2193 | args = '_%s' % last_call[0] | |
2193 | if not self.shell.user_ns.has_key(args): |
|
2194 | if not self.shell.user_ns.has_key(args): | |
2194 | args = last_call[1] |
|
2195 | args = last_call[1] | |
2195 |
|
2196 | |||
2196 | # use last_call to remember the state of the previous call, but don't |
|
2197 | # use last_call to remember the state of the previous call, but don't | |
2197 | # let it be clobbered by successive '-p' calls. |
|
2198 | # let it be clobbered by successive '-p' calls. | |
2198 | try: |
|
2199 | try: | |
2199 | last_call[0] = self.shell.displayhook.prompt_count |
|
2200 | last_call[0] = self.shell.displayhook.prompt_count | |
2200 | if not opts_prev: |
|
2201 | if not opts_prev: | |
2201 | last_call[1] = parameter_s |
|
2202 | last_call[1] = parameter_s | |
2202 | except: |
|
2203 | except: | |
2203 | pass |
|
2204 | pass | |
2204 |
|
2205 | |||
2205 | # by default this is done with temp files, except when the given |
|
2206 | # by default this is done with temp files, except when the given | |
2206 | # arg is a filename |
|
2207 | # arg is a filename | |
2207 | use_temp = True |
|
2208 | use_temp = True | |
2208 |
|
2209 | |||
2209 | data = '' |
|
2210 | data = '' | |
2210 |
|
2211 | |||
2211 | # First, see if the arguments should be a filename. |
|
2212 | # First, see if the arguments should be a filename. | |
2212 | filename = make_filename(args) |
|
2213 | filename = make_filename(args) | |
2213 | if filename: |
|
2214 | if filename: | |
2214 | use_temp = False |
|
2215 | use_temp = False | |
2215 | elif args: |
|
2216 | elif args: | |
2216 | # Mode where user specifies ranges of lines, like in %macro. |
|
2217 | # Mode where user specifies ranges of lines, like in %macro. | |
2217 | data = self.extract_input_lines(args, opts_raw) |
|
2218 | data = self.extract_input_lines(args, opts_raw) | |
2218 | if not data: |
|
2219 | if not data: | |
2219 | try: |
|
2220 | try: | |
2220 | # Load the parameter given as a variable. If not a string, |
|
2221 | # Load the parameter given as a variable. If not a string, | |
2221 | # process it as an object instead (below) |
|
2222 | # process it as an object instead (below) | |
2222 |
|
2223 | |||
2223 | #print '*** args',args,'type',type(args) # dbg |
|
2224 | #print '*** args',args,'type',type(args) # dbg | |
2224 | data = eval(args, self.shell.user_ns) |
|
2225 | data = eval(args, self.shell.user_ns) | |
2225 | if not isinstance(data, basestring): |
|
2226 | if not isinstance(data, basestring): | |
2226 | raise DataIsObject |
|
2227 | raise DataIsObject | |
2227 |
|
2228 | |||
2228 | except (NameError,SyntaxError): |
|
2229 | except (NameError,SyntaxError): | |
2229 | # given argument is not a variable, try as a filename |
|
2230 | # given argument is not a variable, try as a filename | |
2230 | filename = make_filename(args) |
|
2231 | filename = make_filename(args) | |
2231 | if filename is None: |
|
2232 | if filename is None: | |
2232 | warn("Argument given (%s) can't be found as a variable " |
|
2233 | warn("Argument given (%s) can't be found as a variable " | |
2233 | "or as a filename." % args) |
|
2234 | "or as a filename." % args) | |
2234 | return |
|
2235 | return | |
2235 | use_temp = False |
|
2236 | use_temp = False | |
2236 |
|
2237 | |||
2237 | except DataIsObject: |
|
2238 | except DataIsObject: | |
2238 | # macros have a special edit function |
|
2239 | # macros have a special edit function | |
2239 | if isinstance(data, Macro): |
|
2240 | if isinstance(data, Macro): | |
2240 | raise MacroToEdit(data) |
|
2241 | raise MacroToEdit(data) | |
2241 |
|
2242 | |||
2242 | # For objects, try to edit the file where they are defined |
|
2243 | # For objects, try to edit the file where they are defined | |
2243 | try: |
|
2244 | try: | |
2244 | filename = inspect.getabsfile(data) |
|
2245 | filename = inspect.getabsfile(data) | |
2245 | if 'fakemodule' in filename.lower() and inspect.isclass(data): |
|
2246 | if 'fakemodule' in filename.lower() and inspect.isclass(data): | |
2246 | # class created by %edit? Try to find source |
|
2247 | # class created by %edit? Try to find source | |
2247 | # by looking for method definitions instead, the |
|
2248 | # by looking for method definitions instead, the | |
2248 | # __module__ in those classes is FakeModule. |
|
2249 | # __module__ in those classes is FakeModule. | |
2249 | attrs = [getattr(data, aname) for aname in dir(data)] |
|
2250 | attrs = [getattr(data, aname) for aname in dir(data)] | |
2250 | for attr in attrs: |
|
2251 | for attr in attrs: | |
2251 | if not inspect.ismethod(attr): |
|
2252 | if not inspect.ismethod(attr): | |
2252 | continue |
|
2253 | continue | |
2253 | filename = inspect.getabsfile(attr) |
|
2254 | filename = inspect.getabsfile(attr) | |
2254 | if filename and 'fakemodule' not in filename.lower(): |
|
2255 | if filename and 'fakemodule' not in filename.lower(): | |
2255 | # change the attribute to be the edit target instead |
|
2256 | # change the attribute to be the edit target instead | |
2256 | data = attr |
|
2257 | data = attr | |
2257 | break |
|
2258 | break | |
2258 |
|
2259 | |||
2259 | datafile = 1 |
|
2260 | datafile = 1 | |
2260 | except TypeError: |
|
2261 | except TypeError: | |
2261 | filename = make_filename(args) |
|
2262 | filename = make_filename(args) | |
2262 | datafile = 1 |
|
2263 | datafile = 1 | |
2263 | warn('Could not find file where `%s` is defined.\n' |
|
2264 | warn('Could not find file where `%s` is defined.\n' | |
2264 | 'Opening a file named `%s`' % (args,filename)) |
|
2265 | 'Opening a file named `%s`' % (args,filename)) | |
2265 | # Now, make sure we can actually read the source (if it was in |
|
2266 | # Now, make sure we can actually read the source (if it was in | |
2266 | # a temp file it's gone by now). |
|
2267 | # a temp file it's gone by now). | |
2267 | if datafile: |
|
2268 | if datafile: | |
2268 | try: |
|
2269 | try: | |
2269 | if lineno is None: |
|
2270 | if lineno is None: | |
2270 | lineno = inspect.getsourcelines(data)[1] |
|
2271 | lineno = inspect.getsourcelines(data)[1] | |
2271 | except IOError: |
|
2272 | except IOError: | |
2272 | filename = make_filename(args) |
|
2273 | filename = make_filename(args) | |
2273 | if filename is None: |
|
2274 | if filename is None: | |
2274 | warn('The file `%s` where `%s` was defined cannot ' |
|
2275 | warn('The file `%s` where `%s` was defined cannot ' | |
2275 | 'be read.' % (filename,data)) |
|
2276 | 'be read.' % (filename,data)) | |
2276 | return |
|
2277 | return | |
2277 | use_temp = False |
|
2278 | use_temp = False | |
2278 |
|
2279 | |||
2279 | if use_temp: |
|
2280 | if use_temp: | |
2280 | filename = self.shell.mktempfile(data) |
|
2281 | filename = self.shell.mktempfile(data) | |
2281 | print 'IPython will make a temporary file named:',filename |
|
2282 | print 'IPython will make a temporary file named:',filename | |
2282 |
|
2283 | |||
2283 | return filename, lineno, use_temp |
|
2284 | return filename, lineno, use_temp | |
2284 |
|
2285 | |||
2285 | def _edit_macro(self,mname,macro): |
|
2286 | def _edit_macro(self,mname,macro): | |
2286 | """open an editor with the macro data in a file""" |
|
2287 | """open an editor with the macro data in a file""" | |
2287 | filename = self.shell.mktempfile(macro.value) |
|
2288 | filename = self.shell.mktempfile(macro.value) | |
2288 | self.shell.hooks.editor(filename) |
|
2289 | self.shell.hooks.editor(filename) | |
2289 |
|
2290 | |||
2290 | # and make a new macro object, to replace the old one |
|
2291 | # and make a new macro object, to replace the old one | |
2291 | mfile = open(filename) |
|
2292 | mfile = open(filename) | |
2292 | mvalue = mfile.read() |
|
2293 | mvalue = mfile.read() | |
2293 | mfile.close() |
|
2294 | mfile.close() | |
2294 | self.shell.user_ns[mname] = Macro(mvalue) |
|
2295 | self.shell.user_ns[mname] = Macro(mvalue) | |
2295 |
|
2296 | |||
2296 | def magic_ed(self,parameter_s=''): |
|
2297 | def magic_ed(self,parameter_s=''): | |
2297 | """Alias to %edit.""" |
|
2298 | """Alias to %edit.""" | |
2298 | return self.magic_edit(parameter_s) |
|
2299 | return self.magic_edit(parameter_s) | |
2299 |
|
2300 | |||
2300 | @skip_doctest |
|
2301 | @skip_doctest | |
2301 | def magic_edit(self,parameter_s='',last_call=['','']): |
|
2302 | def magic_edit(self,parameter_s='',last_call=['','']): | |
2302 | """Bring up an editor and execute the resulting code. |
|
2303 | """Bring up an editor and execute the resulting code. | |
2303 |
|
2304 | |||
2304 | Usage: |
|
2305 | Usage: | |
2305 | %edit [options] [args] |
|
2306 | %edit [options] [args] | |
2306 |
|
2307 | |||
2307 | %edit runs IPython's editor hook. The default version of this hook is |
|
2308 | %edit runs IPython's editor hook. The default version of this hook is | |
2308 | set to call the editor specified by your $EDITOR environment variable. |
|
2309 | set to call the editor specified by your $EDITOR environment variable. | |
2309 | If this isn't found, it will default to vi under Linux/Unix and to |
|
2310 | If this isn't found, it will default to vi under Linux/Unix and to | |
2310 | notepad under Windows. See the end of this docstring for how to change |
|
2311 | notepad under Windows. See the end of this docstring for how to change | |
2311 | the editor hook. |
|
2312 | the editor hook. | |
2312 |
|
2313 | |||
2313 | You can also set the value of this editor via the |
|
2314 | You can also set the value of this editor via the | |
2314 | ``TerminalInteractiveShell.editor`` option in your configuration file. |
|
2315 | ``TerminalInteractiveShell.editor`` option in your configuration file. | |
2315 | This is useful if you wish to use a different editor from your typical |
|
2316 | This is useful if you wish to use a different editor from your typical | |
2316 | default with IPython (and for Windows users who typically don't set |
|
2317 | default with IPython (and for Windows users who typically don't set | |
2317 | environment variables). |
|
2318 | environment variables). | |
2318 |
|
2319 | |||
2319 | This command allows you to conveniently edit multi-line code right in |
|
2320 | This command allows you to conveniently edit multi-line code right in | |
2320 | your IPython session. |
|
2321 | your IPython session. | |
2321 |
|
2322 | |||
2322 | If called without arguments, %edit opens up an empty editor with a |
|
2323 | If called without arguments, %edit opens up an empty editor with a | |
2323 | temporary file and will execute the contents of this file when you |
|
2324 | temporary file and will execute the contents of this file when you | |
2324 | close it (don't forget to save it!). |
|
2325 | close it (don't forget to save it!). | |
2325 |
|
2326 | |||
2326 |
|
2327 | |||
2327 | Options: |
|
2328 | Options: | |
2328 |
|
2329 | |||
2329 | -n <number>: open the editor at a specified line number. By default, |
|
2330 | -n <number>: open the editor at a specified line number. By default, | |
2330 | the IPython editor hook uses the unix syntax 'editor +N filename', but |
|
2331 | the IPython editor hook uses the unix syntax 'editor +N filename', but | |
2331 | you can configure this by providing your own modified hook if your |
|
2332 | you can configure this by providing your own modified hook if your | |
2332 | favorite editor supports line-number specifications with a different |
|
2333 | favorite editor supports line-number specifications with a different | |
2333 | syntax. |
|
2334 | syntax. | |
2334 |
|
2335 | |||
2335 | -p: this will call the editor with the same data as the previous time |
|
2336 | -p: this will call the editor with the same data as the previous time | |
2336 | it was used, regardless of how long ago (in your current session) it |
|
2337 | it was used, regardless of how long ago (in your current session) it | |
2337 | was. |
|
2338 | was. | |
2338 |
|
2339 | |||
2339 | -r: use 'raw' input. This option only applies to input taken from the |
|
2340 | -r: use 'raw' input. This option only applies to input taken from the | |
2340 | user's history. By default, the 'processed' history is used, so that |
|
2341 | user's history. By default, the 'processed' history is used, so that | |
2341 | magics are loaded in their transformed version to valid Python. If |
|
2342 | magics are loaded in their transformed version to valid Python. If | |
2342 | this option is given, the raw input as typed as the command line is |
|
2343 | this option is given, the raw input as typed as the command line is | |
2343 | used instead. When you exit the editor, it will be executed by |
|
2344 | used instead. When you exit the editor, it will be executed by | |
2344 | IPython's own processor. |
|
2345 | IPython's own processor. | |
2345 |
|
2346 | |||
2346 | -x: do not execute the edited code immediately upon exit. This is |
|
2347 | -x: do not execute the edited code immediately upon exit. This is | |
2347 | mainly useful if you are editing programs which need to be called with |
|
2348 | mainly useful if you are editing programs which need to be called with | |
2348 | command line arguments, which you can then do using %run. |
|
2349 | command line arguments, which you can then do using %run. | |
2349 |
|
2350 | |||
2350 |
|
2351 | |||
2351 | Arguments: |
|
2352 | Arguments: | |
2352 |
|
2353 | |||
2353 | If arguments are given, the following possibilites exist: |
|
2354 | If arguments are given, the following possibilites exist: | |
2354 |
|
2355 | |||
2355 | - If the argument is a filename, IPython will load that into the |
|
2356 | - If the argument is a filename, IPython will load that into the | |
2356 | editor. It will execute its contents with execfile() when you exit, |
|
2357 | editor. It will execute its contents with execfile() when you exit, | |
2357 | loading any code in the file into your interactive namespace. |
|
2358 | loading any code in the file into your interactive namespace. | |
2358 |
|
2359 | |||
2359 | - The arguments are ranges of input history, e.g. "7 ~1/4-6". |
|
2360 | - The arguments are ranges of input history, e.g. "7 ~1/4-6". | |
2360 | The syntax is the same as in the %history magic. |
|
2361 | The syntax is the same as in the %history magic. | |
2361 |
|
2362 | |||
2362 | - If the argument is a string variable, its contents are loaded |
|
2363 | - If the argument is a string variable, its contents are loaded | |
2363 | into the editor. You can thus edit any string which contains |
|
2364 | into the editor. You can thus edit any string which contains | |
2364 | python code (including the result of previous edits). |
|
2365 | python code (including the result of previous edits). | |
2365 |
|
2366 | |||
2366 | - If the argument is the name of an object (other than a string), |
|
2367 | - If the argument is the name of an object (other than a string), | |
2367 | IPython will try to locate the file where it was defined and open the |
|
2368 | IPython will try to locate the file where it was defined and open the | |
2368 | editor at the point where it is defined. You can use `%edit function` |
|
2369 | editor at the point where it is defined. You can use `%edit function` | |
2369 | to load an editor exactly at the point where 'function' is defined, |
|
2370 | to load an editor exactly at the point where 'function' is defined, | |
2370 | edit it and have the file be executed automatically. |
|
2371 | edit it and have the file be executed automatically. | |
2371 |
|
2372 | |||
2372 | - If the object is a macro (see %macro for details), this opens up your |
|
2373 | - If the object is a macro (see %macro for details), this opens up your | |
2373 | specified editor with a temporary file containing the macro's data. |
|
2374 | specified editor with a temporary file containing the macro's data. | |
2374 | Upon exit, the macro is reloaded with the contents of the file. |
|
2375 | Upon exit, the macro is reloaded with the contents of the file. | |
2375 |
|
2376 | |||
2376 | Note: opening at an exact line is only supported under Unix, and some |
|
2377 | Note: opening at an exact line is only supported under Unix, and some | |
2377 | editors (like kedit and gedit up to Gnome 2.8) do not understand the |
|
2378 | editors (like kedit and gedit up to Gnome 2.8) do not understand the | |
2378 | '+NUMBER' parameter necessary for this feature. Good editors like |
|
2379 | '+NUMBER' parameter necessary for this feature. Good editors like | |
2379 | (X)Emacs, vi, jed, pico and joe all do. |
|
2380 | (X)Emacs, vi, jed, pico and joe all do. | |
2380 |
|
2381 | |||
2381 | After executing your code, %edit will return as output the code you |
|
2382 | After executing your code, %edit will return as output the code you | |
2382 | typed in the editor (except when it was an existing file). This way |
|
2383 | typed in the editor (except when it was an existing file). This way | |
2383 | you can reload the code in further invocations of %edit as a variable, |
|
2384 | you can reload the code in further invocations of %edit as a variable, | |
2384 | via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of |
|
2385 | via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of | |
2385 | the output. |
|
2386 | the output. | |
2386 |
|
2387 | |||
2387 | Note that %edit is also available through the alias %ed. |
|
2388 | Note that %edit is also available through the alias %ed. | |
2388 |
|
2389 | |||
2389 | This is an example of creating a simple function inside the editor and |
|
2390 | This is an example of creating a simple function inside the editor and | |
2390 | then modifying it. First, start up the editor: |
|
2391 | then modifying it. First, start up the editor: | |
2391 |
|
2392 | |||
2392 | In [1]: ed |
|
2393 | In [1]: ed | |
2393 | Editing... done. Executing edited code... |
|
2394 | Editing... done. Executing edited code... | |
2394 | Out[1]: 'def foo():n print "foo() was defined in an editing session"n' |
|
2395 | Out[1]: 'def foo():n print "foo() was defined in an editing session"n' | |
2395 |
|
2396 | |||
2396 | We can then call the function foo(): |
|
2397 | We can then call the function foo(): | |
2397 |
|
2398 | |||
2398 | In [2]: foo() |
|
2399 | In [2]: foo() | |
2399 | foo() was defined in an editing session |
|
2400 | foo() was defined in an editing session | |
2400 |
|
2401 | |||
2401 | Now we edit foo. IPython automatically loads the editor with the |
|
2402 | Now we edit foo. IPython automatically loads the editor with the | |
2402 | (temporary) file where foo() was previously defined: |
|
2403 | (temporary) file where foo() was previously defined: | |
2403 |
|
2404 | |||
2404 | In [3]: ed foo |
|
2405 | In [3]: ed foo | |
2405 | Editing... done. Executing edited code... |
|
2406 | Editing... done. Executing edited code... | |
2406 |
|
2407 | |||
2407 | And if we call foo() again we get the modified version: |
|
2408 | And if we call foo() again we get the modified version: | |
2408 |
|
2409 | |||
2409 | In [4]: foo() |
|
2410 | In [4]: foo() | |
2410 | foo() has now been changed! |
|
2411 | foo() has now been changed! | |
2411 |
|
2412 | |||
2412 | Here is an example of how to edit a code snippet successive |
|
2413 | Here is an example of how to edit a code snippet successive | |
2413 | times. First we call the editor: |
|
2414 | times. First we call the editor: | |
2414 |
|
2415 | |||
2415 | In [5]: ed |
|
2416 | In [5]: ed | |
2416 | Editing... done. Executing edited code... |
|
2417 | Editing... done. Executing edited code... | |
2417 | hello |
|
2418 | hello | |
2418 | Out[5]: "print 'hello'n" |
|
2419 | Out[5]: "print 'hello'n" | |
2419 |
|
2420 | |||
2420 | Now we call it again with the previous output (stored in _): |
|
2421 | Now we call it again with the previous output (stored in _): | |
2421 |
|
2422 | |||
2422 | In [6]: ed _ |
|
2423 | In [6]: ed _ | |
2423 | Editing... done. Executing edited code... |
|
2424 | Editing... done. Executing edited code... | |
2424 | hello world |
|
2425 | hello world | |
2425 | Out[6]: "print 'hello world'n" |
|
2426 | Out[6]: "print 'hello world'n" | |
2426 |
|
2427 | |||
2427 | Now we call it with the output #8 (stored in _8, also as Out[8]): |
|
2428 | Now we call it with the output #8 (stored in _8, also as Out[8]): | |
2428 |
|
2429 | |||
2429 | In [7]: ed _8 |
|
2430 | In [7]: ed _8 | |
2430 | Editing... done. Executing edited code... |
|
2431 | Editing... done. Executing edited code... | |
2431 | hello again |
|
2432 | hello again | |
2432 | Out[7]: "print 'hello again'n" |
|
2433 | Out[7]: "print 'hello again'n" | |
2433 |
|
2434 | |||
2434 |
|
2435 | |||
2435 | Changing the default editor hook: |
|
2436 | Changing the default editor hook: | |
2436 |
|
2437 | |||
2437 | If you wish to write your own editor hook, you can put it in a |
|
2438 | If you wish to write your own editor hook, you can put it in a | |
2438 | configuration file which you load at startup time. The default hook |
|
2439 | configuration file which you load at startup time. The default hook | |
2439 | is defined in the IPython.core.hooks module, and you can use that as a |
|
2440 | is defined in the IPython.core.hooks module, and you can use that as a | |
2440 | starting example for further modifications. That file also has |
|
2441 | starting example for further modifications. That file also has | |
2441 | general instructions on how to set a new hook for use once you've |
|
2442 | general instructions on how to set a new hook for use once you've | |
2442 | defined it.""" |
|
2443 | defined it.""" | |
2443 | opts,args = self.parse_options(parameter_s,'prxn:') |
|
2444 | opts,args = self.parse_options(parameter_s,'prxn:') | |
2444 |
|
2445 | |||
2445 | try: |
|
2446 | try: | |
2446 | filename, lineno, is_temp = self._find_edit_target(args, opts, last_call) |
|
2447 | filename, lineno, is_temp = self._find_edit_target(args, opts, last_call) | |
2447 | except MacroToEdit as e: |
|
2448 | except MacroToEdit as e: | |
2448 | self._edit_macro(args, e.args[0]) |
|
2449 | self._edit_macro(args, e.args[0]) | |
2449 | return |
|
2450 | return | |
2450 |
|
2451 | |||
2451 | # do actual editing here |
|
2452 | # do actual editing here | |
2452 | print 'Editing...', |
|
2453 | print 'Editing...', | |
2453 | sys.stdout.flush() |
|
2454 | sys.stdout.flush() | |
2454 | try: |
|
2455 | try: | |
2455 | # Quote filenames that may have spaces in them |
|
2456 | # Quote filenames that may have spaces in them | |
2456 | if ' ' in filename: |
|
2457 | if ' ' in filename: | |
2457 | filename = "'%s'" % filename |
|
2458 | filename = "'%s'" % filename | |
2458 | self.shell.hooks.editor(filename,lineno) |
|
2459 | self.shell.hooks.editor(filename,lineno) | |
2459 | except TryNext: |
|
2460 | except TryNext: | |
2460 | warn('Could not open editor') |
|
2461 | warn('Could not open editor') | |
2461 | return |
|
2462 | return | |
2462 |
|
2463 | |||
2463 | # XXX TODO: should this be generalized for all string vars? |
|
2464 | # XXX TODO: should this be generalized for all string vars? | |
2464 | # For now, this is special-cased to blocks created by cpaste |
|
2465 | # For now, this is special-cased to blocks created by cpaste | |
2465 | if args.strip() == 'pasted_block': |
|
2466 | if args.strip() == 'pasted_block': | |
2466 | self.shell.user_ns['pasted_block'] = file_read(filename) |
|
2467 | self.shell.user_ns['pasted_block'] = file_read(filename) | |
2467 |
|
2468 | |||
2468 | if 'x' in opts: # -x prevents actual execution |
|
2469 | if 'x' in opts: # -x prevents actual execution | |
2469 |
|
2470 | |||
2470 | else: |
|
2471 | else: | |
2471 | print 'done. Executing edited code...' |
|
2472 | print 'done. Executing edited code...' | |
2472 | if 'r' in opts: # Untranslated IPython code |
|
2473 | if 'r' in opts: # Untranslated IPython code | |
2473 | self.shell.run_cell(file_read(filename), |
|
2474 | self.shell.run_cell(file_read(filename), | |
2474 | store_history=False) |
|
2475 | store_history=False) | |
2475 | else: |
|
2476 | else: | |
2476 | self.shell.safe_execfile(filename,self.shell.user_ns, |
|
2477 | self.shell.safe_execfile(filename,self.shell.user_ns, | |
2477 | self.shell.user_ns) |
|
2478 | self.shell.user_ns) | |
2478 |
|
2479 | |||
2479 | if is_temp: |
|
2480 | if is_temp: | |
2480 | try: |
|
2481 | try: | |
2481 | return open(filename).read() |
|
2482 | return open(filename).read() | |
2482 | except IOError,msg: |
|
2483 | except IOError,msg: | |
2483 | if msg.filename == filename: |
|
2484 | if msg.filename == filename: | |
2484 | warn('File not found. Did you forget to save?') |
|
2485 | warn('File not found. Did you forget to save?') | |
2485 | return |
|
2486 | return | |
2486 | else: |
|
2487 | else: | |
2487 | self.shell.showtraceback() |
|
2488 | self.shell.showtraceback() | |
2488 |
|
2489 | |||
2489 | def magic_xmode(self,parameter_s = ''): |
|
2490 | def magic_xmode(self,parameter_s = ''): | |
2490 | """Switch modes for the exception handlers. |
|
2491 | """Switch modes for the exception handlers. | |
2491 |
|
2492 | |||
2492 | Valid modes: Plain, Context and Verbose. |
|
2493 | Valid modes: Plain, Context and Verbose. | |
2493 |
|
2494 | |||
2494 | If called without arguments, acts as a toggle.""" |
|
2495 | If called without arguments, acts as a toggle.""" | |
2495 |
|
2496 | |||
2496 | def xmode_switch_err(name): |
|
2497 | def xmode_switch_err(name): | |
2497 | warn('Error changing %s exception modes.\n%s' % |
|
2498 | warn('Error changing %s exception modes.\n%s' % | |
2498 | (name,sys.exc_info()[1])) |
|
2499 | (name,sys.exc_info()[1])) | |
2499 |
|
2500 | |||
2500 | shell = self.shell |
|
2501 | shell = self.shell | |
2501 | new_mode = parameter_s.strip().capitalize() |
|
2502 | new_mode = parameter_s.strip().capitalize() | |
2502 | try: |
|
2503 | try: | |
2503 | shell.InteractiveTB.set_mode(mode=new_mode) |
|
2504 | shell.InteractiveTB.set_mode(mode=new_mode) | |
2504 | print 'Exception reporting mode:',shell.InteractiveTB.mode |
|
2505 | print 'Exception reporting mode:',shell.InteractiveTB.mode | |
2505 | except: |
|
2506 | except: | |
2506 | xmode_switch_err('user') |
|
2507 | xmode_switch_err('user') | |
2507 |
|
2508 | |||
2508 | def magic_colors(self,parameter_s = ''): |
|
2509 | def magic_colors(self,parameter_s = ''): | |
2509 | """Switch color scheme for prompts, info system and exception handlers. |
|
2510 | """Switch color scheme for prompts, info system and exception handlers. | |
2510 |
|
2511 | |||
2511 | Currently implemented schemes: NoColor, Linux, LightBG. |
|
2512 | Currently implemented schemes: NoColor, Linux, LightBG. | |
2512 |
|
2513 | |||
2513 | Color scheme names are not case-sensitive. |
|
2514 | Color scheme names are not case-sensitive. | |
2514 |
|
2515 | |||
2515 | Examples |
|
2516 | Examples | |
2516 | -------- |
|
2517 | -------- | |
2517 | To get a plain black and white terminal:: |
|
2518 | To get a plain black and white terminal:: | |
2518 |
|
2519 | |||
2519 | %colors nocolor |
|
2520 | %colors nocolor | |
2520 | """ |
|
2521 | """ | |
2521 |
|
2522 | |||
2522 | def color_switch_err(name): |
|
2523 | def color_switch_err(name): | |
2523 | warn('Error changing %s color schemes.\n%s' % |
|
2524 | warn('Error changing %s color schemes.\n%s' % | |
2524 | (name,sys.exc_info()[1])) |
|
2525 | (name,sys.exc_info()[1])) | |
2525 |
|
2526 | |||
2526 |
|
2527 | |||
2527 | new_scheme = parameter_s.strip() |
|
2528 | new_scheme = parameter_s.strip() | |
2528 | if not new_scheme: |
|
2529 | if not new_scheme: | |
2529 | raise UsageError( |
|
2530 | raise UsageError( | |
2530 | "%colors: you must specify a color scheme. See '%colors?'") |
|
2531 | "%colors: you must specify a color scheme. See '%colors?'") | |
2531 | return |
|
2532 | return | |
2532 | # local shortcut |
|
2533 | # local shortcut | |
2533 | shell = self.shell |
|
2534 | shell = self.shell | |
2534 |
|
2535 | |||
2535 | import IPython.utils.rlineimpl as readline |
|
2536 | import IPython.utils.rlineimpl as readline | |
2536 |
|
2537 | |||
2537 | if not shell.colors_force and \ |
|
2538 | if not shell.colors_force and \ | |
2538 | not readline.have_readline and sys.platform == "win32": |
|
2539 | not readline.have_readline and sys.platform == "win32": | |
2539 | msg = """\ |
|
2540 | msg = """\ | |
2540 | Proper color support under MS Windows requires the pyreadline library. |
|
2541 | Proper color support under MS Windows requires the pyreadline library. | |
2541 | You can find it at: |
|
2542 | You can find it at: | |
2542 | http://ipython.org/pyreadline.html |
|
2543 | http://ipython.org/pyreadline.html | |
2543 | Gary's readline needs the ctypes module, from: |
|
2544 | Gary's readline needs the ctypes module, from: | |
2544 | http://starship.python.net/crew/theller/ctypes |
|
2545 | http://starship.python.net/crew/theller/ctypes | |
2545 | (Note that ctypes is already part of Python versions 2.5 and newer). |
|
2546 | (Note that ctypes is already part of Python versions 2.5 and newer). | |
2546 |
|
2547 | |||
2547 | Defaulting color scheme to 'NoColor'""" |
|
2548 | Defaulting color scheme to 'NoColor'""" | |
2548 | new_scheme = 'NoColor' |
|
2549 | new_scheme = 'NoColor' | |
2549 | warn(msg) |
|
2550 | warn(msg) | |
2550 |
|
2551 | |||
2551 | # readline option is 0 |
|
2552 | # readline option is 0 | |
2552 | if not shell.colors_force and not shell.has_readline: |
|
2553 | if not shell.colors_force and not shell.has_readline: | |
2553 | new_scheme = 'NoColor' |
|
2554 | new_scheme = 'NoColor' | |
2554 |
|
2555 | |||
2555 | # Set prompt colors |
|
2556 | # Set prompt colors | |
2556 | try: |
|
2557 | try: | |
2557 | shell.prompt_manager.color_scheme = new_scheme |
|
2558 | shell.prompt_manager.color_scheme = new_scheme | |
2558 | except: |
|
2559 | except: | |
2559 | color_switch_err('prompt') |
|
2560 | color_switch_err('prompt') | |
2560 | else: |
|
2561 | else: | |
2561 | shell.colors = \ |
|
2562 | shell.colors = \ | |
2562 | shell.prompt_manager.color_scheme_table.active_scheme_name |
|
2563 | shell.prompt_manager.color_scheme_table.active_scheme_name | |
2563 | # Set exception colors |
|
2564 | # Set exception colors | |
2564 | try: |
|
2565 | try: | |
2565 | shell.InteractiveTB.set_colors(scheme = new_scheme) |
|
2566 | shell.InteractiveTB.set_colors(scheme = new_scheme) | |
2566 | shell.SyntaxTB.set_colors(scheme = new_scheme) |
|
2567 | shell.SyntaxTB.set_colors(scheme = new_scheme) | |
2567 | except: |
|
2568 | except: | |
2568 | color_switch_err('exception') |
|
2569 | color_switch_err('exception') | |
2569 |
|
2570 | |||
2570 | # Set info (for 'object?') colors |
|
2571 | # Set info (for 'object?') colors | |
2571 | if shell.color_info: |
|
2572 | if shell.color_info: | |
2572 | try: |
|
2573 | try: | |
2573 | shell.inspector.set_active_scheme(new_scheme) |
|
2574 | shell.inspector.set_active_scheme(new_scheme) | |
2574 | except: |
|
2575 | except: | |
2575 | color_switch_err('object inspector') |
|
2576 | color_switch_err('object inspector') | |
2576 | else: |
|
2577 | else: | |
2577 | shell.inspector.set_active_scheme('NoColor') |
|
2578 | shell.inspector.set_active_scheme('NoColor') | |
2578 |
|
2579 | |||
2579 | def magic_pprint(self, parameter_s=''): |
|
2580 | def magic_pprint(self, parameter_s=''): | |
2580 | """Toggle pretty printing on/off.""" |
|
2581 | """Toggle pretty printing on/off.""" | |
2581 | ptformatter = self.shell.display_formatter.formatters['text/plain'] |
|
2582 | ptformatter = self.shell.display_formatter.formatters['text/plain'] | |
2582 | ptformatter.pprint = bool(1 - ptformatter.pprint) |
|
2583 | ptformatter.pprint = bool(1 - ptformatter.pprint) | |
2583 | print 'Pretty printing has been turned', \ |
|
2584 | print 'Pretty printing has been turned', \ | |
2584 | ['OFF','ON'][ptformatter.pprint] |
|
2585 | ['OFF','ON'][ptformatter.pprint] | |
2585 |
|
2586 | |||
2586 | #...................................................................... |
|
2587 | #...................................................................... | |
2587 | # Functions to implement unix shell-type things |
|
2588 | # Functions to implement unix shell-type things | |
2588 |
|
2589 | |||
2589 | @skip_doctest |
|
2590 | @skip_doctest | |
2590 | def magic_alias(self, parameter_s = ''): |
|
2591 | def magic_alias(self, parameter_s = ''): | |
2591 | """Define an alias for a system command. |
|
2592 | """Define an alias for a system command. | |
2592 |
|
2593 | |||
2593 | '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd' |
|
2594 | '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd' | |
2594 |
|
2595 | |||
2595 | Then, typing 'alias_name params' will execute the system command 'cmd |
|
2596 | Then, typing 'alias_name params' will execute the system command 'cmd | |
2596 | params' (from your underlying operating system). |
|
2597 | params' (from your underlying operating system). | |
2597 |
|
2598 | |||
2598 | Aliases have lower precedence than magic functions and Python normal |
|
2599 | Aliases have lower precedence than magic functions and Python normal | |
2599 | variables, so if 'foo' is both a Python variable and an alias, the |
|
2600 | variables, so if 'foo' is both a Python variable and an alias, the | |
2600 | alias can not be executed until 'del foo' removes the Python variable. |
|
2601 | alias can not be executed until 'del foo' removes the Python variable. | |
2601 |
|
2602 | |||
2602 | You can use the %l specifier in an alias definition to represent the |
|
2603 | You can use the %l specifier in an alias definition to represent the | |
2603 | whole line when the alias is called. For example: |
|
2604 | whole line when the alias is called. For example: | |
2604 |
|
2605 | |||
2605 | In [2]: alias bracket echo "Input in brackets: <%l>" |
|
2606 | In [2]: alias bracket echo "Input in brackets: <%l>" | |
2606 | In [3]: bracket hello world |
|
2607 | In [3]: bracket hello world | |
2607 | Input in brackets: <hello world> |
|
2608 | Input in brackets: <hello world> | |
2608 |
|
2609 | |||
2609 | You can also define aliases with parameters using %s specifiers (one |
|
2610 | You can also define aliases with parameters using %s specifiers (one | |
2610 | per parameter): |
|
2611 | per parameter): | |
2611 |
|
2612 | |||
2612 | In [1]: alias parts echo first %s second %s |
|
2613 | In [1]: alias parts echo first %s second %s | |
2613 | In [2]: %parts A B |
|
2614 | In [2]: %parts A B | |
2614 | first A second B |
|
2615 | first A second B | |
2615 | In [3]: %parts A |
|
2616 | In [3]: %parts A | |
2616 | Incorrect number of arguments: 2 expected. |
|
2617 | Incorrect number of arguments: 2 expected. | |
2617 | parts is an alias to: 'echo first %s second %s' |
|
2618 | parts is an alias to: 'echo first %s second %s' | |
2618 |
|
2619 | |||
2619 | Note that %l and %s are mutually exclusive. You can only use one or |
|
2620 | Note that %l and %s are mutually exclusive. You can only use one or | |
2620 | the other in your aliases. |
|
2621 | the other in your aliases. | |
2621 |
|
2622 | |||
2622 | Aliases expand Python variables just like system calls using ! or !! |
|
2623 | Aliases expand Python variables just like system calls using ! or !! | |
2623 | do: all expressions prefixed with '$' get expanded. For details of |
|
2624 | do: all expressions prefixed with '$' get expanded. For details of | |
2624 | the semantic rules, see PEP-215: |
|
2625 | the semantic rules, see PEP-215: | |
2625 | http://www.python.org/peps/pep-0215.html. This is the library used by |
|
2626 | http://www.python.org/peps/pep-0215.html. This is the library used by | |
2626 | IPython for variable expansion. If you want to access a true shell |
|
2627 | IPython for variable expansion. If you want to access a true shell | |
2627 | variable, an extra $ is necessary to prevent its expansion by IPython: |
|
2628 | variable, an extra $ is necessary to prevent its expansion by IPython: | |
2628 |
|
2629 | |||
2629 | In [6]: alias show echo |
|
2630 | In [6]: alias show echo | |
2630 | In [7]: PATH='A Python string' |
|
2631 | In [7]: PATH='A Python string' | |
2631 | In [8]: show $PATH |
|
2632 | In [8]: show $PATH | |
2632 | A Python string |
|
2633 | A Python string | |
2633 | In [9]: show $$PATH |
|
2634 | In [9]: show $$PATH | |
2634 | /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:... |
|
2635 | /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:... | |
2635 |
|
2636 | |||
2636 | You can use the alias facility to acess all of $PATH. See the %rehash |
|
2637 | You can use the alias facility to acess all of $PATH. See the %rehash | |
2637 | and %rehashx functions, which automatically create aliases for the |
|
2638 | and %rehashx functions, which automatically create aliases for the | |
2638 | contents of your $PATH. |
|
2639 | contents of your $PATH. | |
2639 |
|
2640 | |||
2640 | If called with no parameters, %alias prints the current alias table.""" |
|
2641 | If called with no parameters, %alias prints the current alias table.""" | |
2641 |
|
2642 | |||
2642 | par = parameter_s.strip() |
|
2643 | par = parameter_s.strip() | |
2643 | if not par: |
|
2644 | if not par: | |
2644 | stored = self.db.get('stored_aliases', {} ) |
|
2645 | stored = self.db.get('stored_aliases', {} ) | |
2645 | aliases = sorted(self.shell.alias_manager.aliases) |
|
2646 | aliases = sorted(self.shell.alias_manager.aliases) | |
2646 | # for k, v in stored: |
|
2647 | # for k, v in stored: | |
2647 | # atab.append(k, v[0]) |
|
2648 | # atab.append(k, v[0]) | |
2648 |
|
2649 | |||
2649 | print "Total number of aliases:", len(aliases) |
|
2650 | print "Total number of aliases:", len(aliases) | |
2650 | sys.stdout.flush() |
|
2651 | sys.stdout.flush() | |
2651 | return aliases |
|
2652 | return aliases | |
2652 |
|
2653 | |||
2653 | # Now try to define a new one |
|
2654 | # Now try to define a new one | |
2654 | try: |
|
2655 | try: | |
2655 | alias,cmd = par.split(None, 1) |
|
2656 | alias,cmd = par.split(None, 1) | |
2656 | except: |
|
2657 | except: | |
2657 | print oinspect.getdoc(self.magic_alias) |
|
2658 | print oinspect.getdoc(self.magic_alias) | |
2658 | else: |
|
2659 | else: | |
2659 | self.shell.alias_manager.soft_define_alias(alias, cmd) |
|
2660 | self.shell.alias_manager.soft_define_alias(alias, cmd) | |
2660 | # end magic_alias |
|
2661 | # end magic_alias | |
2661 |
|
2662 | |||
2662 | def magic_unalias(self, parameter_s = ''): |
|
2663 | def magic_unalias(self, parameter_s = ''): | |
2663 | """Remove an alias""" |
|
2664 | """Remove an alias""" | |
2664 |
|
2665 | |||
2665 | aname = parameter_s.strip() |
|
2666 | aname = parameter_s.strip() | |
2666 | self.shell.alias_manager.undefine_alias(aname) |
|
2667 | self.shell.alias_manager.undefine_alias(aname) | |
2667 | stored = self.db.get('stored_aliases', {} ) |
|
2668 | stored = self.db.get('stored_aliases', {} ) | |
2668 | if aname in stored: |
|
2669 | if aname in stored: | |
2669 | print "Removing %stored alias",aname |
|
2670 | print "Removing %stored alias",aname | |
2670 | del stored[aname] |
|
2671 | del stored[aname] | |
2671 | self.db['stored_aliases'] = stored |
|
2672 | self.db['stored_aliases'] = stored | |
2672 |
|
2673 | |||
2673 | def magic_rehashx(self, parameter_s = ''): |
|
2674 | def magic_rehashx(self, parameter_s = ''): | |
2674 | """Update the alias table with all executable files in $PATH. |
|
2675 | """Update the alias table with all executable files in $PATH. | |
2675 |
|
2676 | |||
2676 | This version explicitly checks that every entry in $PATH is a file |
|
2677 | This version explicitly checks that every entry in $PATH is a file | |
2677 | with execute access (os.X_OK), so it is much slower than %rehash. |
|
2678 | with execute access (os.X_OK), so it is much slower than %rehash. | |
2678 |
|
2679 | |||
2679 | Under Windows, it checks executability as a match agains a |
|
2680 | Under Windows, it checks executability as a match agains a | |
2680 | '|'-separated string of extensions, stored in the IPython config |
|
2681 | '|'-separated string of extensions, stored in the IPython config | |
2681 | variable win_exec_ext. This defaults to 'exe|com|bat'. |
|
2682 | variable win_exec_ext. This defaults to 'exe|com|bat'. | |
2682 |
|
2683 | |||
2683 | This function also resets the root module cache of module completer, |
|
2684 | This function also resets the root module cache of module completer, | |
2684 | used on slow filesystems. |
|
2685 | used on slow filesystems. | |
2685 | """ |
|
2686 | """ | |
2686 | from IPython.core.alias import InvalidAliasError |
|
2687 | from IPython.core.alias import InvalidAliasError | |
2687 |
|
2688 | |||
2688 | # for the benefit of module completer in ipy_completers.py |
|
2689 | # for the benefit of module completer in ipy_completers.py | |
2689 | del self.shell.db['rootmodules'] |
|
2690 | del self.shell.db['rootmodules'] | |
2690 |
|
2691 | |||
2691 | path = [os.path.abspath(os.path.expanduser(p)) for p in |
|
2692 | path = [os.path.abspath(os.path.expanduser(p)) for p in | |
2692 | os.environ.get('PATH','').split(os.pathsep)] |
|
2693 | os.environ.get('PATH','').split(os.pathsep)] | |
2693 | path = filter(os.path.isdir,path) |
|
2694 | path = filter(os.path.isdir,path) | |
2694 |
|
2695 | |||
2695 | syscmdlist = [] |
|
2696 | syscmdlist = [] | |
2696 | # Now define isexec in a cross platform manner. |
|
2697 | # Now define isexec in a cross platform manner. | |
2697 | if os.name == 'posix': |
|
2698 | if os.name == 'posix': | |
2698 | isexec = lambda fname:os.path.isfile(fname) and \ |
|
2699 | isexec = lambda fname:os.path.isfile(fname) and \ | |
2699 | os.access(fname,os.X_OK) |
|
2700 | os.access(fname,os.X_OK) | |
2700 | else: |
|
2701 | else: | |
2701 | try: |
|
2702 | try: | |
2702 | winext = os.environ['pathext'].replace(';','|').replace('.','') |
|
2703 | winext = os.environ['pathext'].replace(';','|').replace('.','') | |
2703 | except KeyError: |
|
2704 | except KeyError: | |
2704 | winext = 'exe|com|bat|py' |
|
2705 | winext = 'exe|com|bat|py' | |
2705 | if 'py' not in winext: |
|
2706 | if 'py' not in winext: | |
2706 | winext += '|py' |
|
2707 | winext += '|py' | |
2707 | execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE) |
|
2708 | execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE) | |
2708 | isexec = lambda fname:os.path.isfile(fname) and execre.match(fname) |
|
2709 | isexec = lambda fname:os.path.isfile(fname) and execre.match(fname) | |
2709 | savedir = os.getcwdu() |
|
2710 | savedir = os.getcwdu() | |
2710 |
|
2711 | |||
2711 | # Now walk the paths looking for executables to alias. |
|
2712 | # Now walk the paths looking for executables to alias. | |
2712 | try: |
|
2713 | try: | |
2713 | # write the whole loop for posix/Windows so we don't have an if in |
|
2714 | # write the whole loop for posix/Windows so we don't have an if in | |
2714 | # the innermost part |
|
2715 | # the innermost part | |
2715 | if os.name == 'posix': |
|
2716 | if os.name == 'posix': | |
2716 | for pdir in path: |
|
2717 | for pdir in path: | |
2717 | os.chdir(pdir) |
|
2718 | os.chdir(pdir) | |
2718 | for ff in os.listdir(pdir): |
|
2719 | for ff in os.listdir(pdir): | |
2719 | if isexec(ff): |
|
2720 | if isexec(ff): | |
2720 | try: |
|
2721 | try: | |
2721 | # Removes dots from the name since ipython |
|
2722 | # Removes dots from the name since ipython | |
2722 | # will assume names with dots to be python. |
|
2723 | # will assume names with dots to be python. | |
2723 | self.shell.alias_manager.define_alias( |
|
2724 | self.shell.alias_manager.define_alias( | |
2724 | ff.replace('.',''), ff) |
|
2725 | ff.replace('.',''), ff) | |
2725 | except InvalidAliasError: |
|
2726 | except InvalidAliasError: | |
2726 | pass |
|
2727 | pass | |
2727 | else: |
|
2728 | else: | |
2728 | syscmdlist.append(ff) |
|
2729 | syscmdlist.append(ff) | |
2729 | else: |
|
2730 | else: | |
2730 | no_alias = self.shell.alias_manager.no_alias |
|
2731 | no_alias = self.shell.alias_manager.no_alias | |
2731 | for pdir in path: |
|
2732 | for pdir in path: | |
2732 | os.chdir(pdir) |
|
2733 | os.chdir(pdir) | |
2733 | for ff in os.listdir(pdir): |
|
2734 | for ff in os.listdir(pdir): | |
2734 | base, ext = os.path.splitext(ff) |
|
2735 | base, ext = os.path.splitext(ff) | |
2735 | if isexec(ff) and base.lower() not in no_alias: |
|
2736 | if isexec(ff) and base.lower() not in no_alias: | |
2736 | if ext.lower() == '.exe': |
|
2737 | if ext.lower() == '.exe': | |
2737 | ff = base |
|
2738 | ff = base | |
2738 | try: |
|
2739 | try: | |
2739 | # Removes dots from the name since ipython |
|
2740 | # Removes dots from the name since ipython | |
2740 | # will assume names with dots to be python. |
|
2741 | # will assume names with dots to be python. | |
2741 | self.shell.alias_manager.define_alias( |
|
2742 | self.shell.alias_manager.define_alias( | |
2742 | base.lower().replace('.',''), ff) |
|
2743 | base.lower().replace('.',''), ff) | |
2743 | except InvalidAliasError: |
|
2744 | except InvalidAliasError: | |
2744 | pass |
|
2745 | pass | |
2745 | syscmdlist.append(ff) |
|
2746 | syscmdlist.append(ff) | |
2746 | self.shell.db['syscmdlist'] = syscmdlist |
|
2747 | self.shell.db['syscmdlist'] = syscmdlist | |
2747 | finally: |
|
2748 | finally: | |
2748 | os.chdir(savedir) |
|
2749 | os.chdir(savedir) | |
2749 |
|
2750 | |||
2750 | @skip_doctest |
|
2751 | @skip_doctest | |
2751 | def magic_pwd(self, parameter_s = ''): |
|
2752 | def magic_pwd(self, parameter_s = ''): | |
2752 | """Return the current working directory path. |
|
2753 | """Return the current working directory path. | |
2753 |
|
2754 | |||
2754 | Examples |
|
2755 | Examples | |
2755 | -------- |
|
2756 | -------- | |
2756 | :: |
|
2757 | :: | |
2757 |
|
2758 | |||
2758 | In [9]: pwd |
|
2759 | In [9]: pwd | |
2759 | Out[9]: '/home/tsuser/sprint/ipython' |
|
2760 | Out[9]: '/home/tsuser/sprint/ipython' | |
2760 | """ |
|
2761 | """ | |
2761 | return os.getcwdu() |
|
2762 | return os.getcwdu() | |
2762 |
|
2763 | |||
2763 | @skip_doctest |
|
2764 | @skip_doctest | |
2764 | def magic_cd(self, parameter_s=''): |
|
2765 | def magic_cd(self, parameter_s=''): | |
2765 | """Change the current working directory. |
|
2766 | """Change the current working directory. | |
2766 |
|
2767 | |||
2767 | This command automatically maintains an internal list of directories |
|
2768 | This command automatically maintains an internal list of directories | |
2768 | you visit during your IPython session, in the variable _dh. The |
|
2769 | you visit during your IPython session, in the variable _dh. The | |
2769 | command %dhist shows this history nicely formatted. You can also |
|
2770 | command %dhist shows this history nicely formatted. You can also | |
2770 | do 'cd -<tab>' to see directory history conveniently. |
|
2771 | do 'cd -<tab>' to see directory history conveniently. | |
2771 |
|
2772 | |||
2772 | Usage: |
|
2773 | Usage: | |
2773 |
|
2774 | |||
2774 | cd 'dir': changes to directory 'dir'. |
|
2775 | cd 'dir': changes to directory 'dir'. | |
2775 |
|
2776 | |||
2776 | cd -: changes to the last visited directory. |
|
2777 | cd -: changes to the last visited directory. | |
2777 |
|
2778 | |||
2778 | cd -<n>: changes to the n-th directory in the directory history. |
|
2779 | cd -<n>: changes to the n-th directory in the directory history. | |
2779 |
|
2780 | |||
2780 | cd --foo: change to directory that matches 'foo' in history |
|
2781 | cd --foo: change to directory that matches 'foo' in history | |
2781 |
|
2782 | |||
2782 | cd -b <bookmark_name>: jump to a bookmark set by %bookmark |
|
2783 | cd -b <bookmark_name>: jump to a bookmark set by %bookmark | |
2783 | (note: cd <bookmark_name> is enough if there is no |
|
2784 | (note: cd <bookmark_name> is enough if there is no | |
2784 | directory <bookmark_name>, but a bookmark with the name exists.) |
|
2785 | directory <bookmark_name>, but a bookmark with the name exists.) | |
2785 | 'cd -b <tab>' allows you to tab-complete bookmark names. |
|
2786 | 'cd -b <tab>' allows you to tab-complete bookmark names. | |
2786 |
|
2787 | |||
2787 | Options: |
|
2788 | Options: | |
2788 |
|
2789 | |||
2789 | -q: quiet. Do not print the working directory after the cd command is |
|
2790 | -q: quiet. Do not print the working directory after the cd command is | |
2790 | executed. By default IPython's cd command does print this directory, |
|
2791 | executed. By default IPython's cd command does print this directory, | |
2791 | since the default prompts do not display path information. |
|
2792 | since the default prompts do not display path information. | |
2792 |
|
2793 | |||
2793 | Note that !cd doesn't work for this purpose because the shell where |
|
2794 | Note that !cd doesn't work for this purpose because the shell where | |
2794 | !command runs is immediately discarded after executing 'command'. |
|
2795 | !command runs is immediately discarded after executing 'command'. | |
2795 |
|
2796 | |||
2796 | Examples |
|
2797 | Examples | |
2797 | -------- |
|
2798 | -------- | |
2798 | :: |
|
2799 | :: | |
2799 |
|
2800 | |||
2800 | In [10]: cd parent/child |
|
2801 | In [10]: cd parent/child | |
2801 | /home/tsuser/parent/child |
|
2802 | /home/tsuser/parent/child | |
2802 | """ |
|
2803 | """ | |
2803 |
|
2804 | |||
2804 | parameter_s = parameter_s.strip() |
|
2805 | parameter_s = parameter_s.strip() | |
2805 | #bkms = self.shell.persist.get("bookmarks",{}) |
|
2806 | #bkms = self.shell.persist.get("bookmarks",{}) | |
2806 |
|
2807 | |||
2807 | oldcwd = os.getcwdu() |
|
2808 | oldcwd = os.getcwdu() | |
2808 | numcd = re.match(r'(-)(\d+)$',parameter_s) |
|
2809 | numcd = re.match(r'(-)(\d+)$',parameter_s) | |
2809 | # jump in directory history by number |
|
2810 | # jump in directory history by number | |
2810 | if numcd: |
|
2811 | if numcd: | |
2811 | nn = int(numcd.group(2)) |
|
2812 | nn = int(numcd.group(2)) | |
2812 | try: |
|
2813 | try: | |
2813 | ps = self.shell.user_ns['_dh'][nn] |
|
2814 | ps = self.shell.user_ns['_dh'][nn] | |
2814 | except IndexError: |
|
2815 | except IndexError: | |
2815 | print 'The requested directory does not exist in history.' |
|
2816 | print 'The requested directory does not exist in history.' | |
2816 | return |
|
2817 | return | |
2817 | else: |
|
2818 | else: | |
2818 | opts = {} |
|
2819 | opts = {} | |
2819 | elif parameter_s.startswith('--'): |
|
2820 | elif parameter_s.startswith('--'): | |
2820 | ps = None |
|
2821 | ps = None | |
2821 | fallback = None |
|
2822 | fallback = None | |
2822 | pat = parameter_s[2:] |
|
2823 | pat = parameter_s[2:] | |
2823 | dh = self.shell.user_ns['_dh'] |
|
2824 | dh = self.shell.user_ns['_dh'] | |
2824 | # first search only by basename (last component) |
|
2825 | # first search only by basename (last component) | |
2825 | for ent in reversed(dh): |
|
2826 | for ent in reversed(dh): | |
2826 | if pat in os.path.basename(ent) and os.path.isdir(ent): |
|
2827 | if pat in os.path.basename(ent) and os.path.isdir(ent): | |
2827 | ps = ent |
|
2828 | ps = ent | |
2828 | break |
|
2829 | break | |
2829 |
|
2830 | |||
2830 | if fallback is None and pat in ent and os.path.isdir(ent): |
|
2831 | if fallback is None and pat in ent and os.path.isdir(ent): | |
2831 | fallback = ent |
|
2832 | fallback = ent | |
2832 |
|
2833 | |||
2833 | # if we have no last part match, pick the first full path match |
|
2834 | # if we have no last part match, pick the first full path match | |
2834 | if ps is None: |
|
2835 | if ps is None: | |
2835 | ps = fallback |
|
2836 | ps = fallback | |
2836 |
|
2837 | |||
2837 | if ps is None: |
|
2838 | if ps is None: | |
2838 | print "No matching entry in directory history" |
|
2839 | print "No matching entry in directory history" | |
2839 | return |
|
2840 | return | |
2840 | else: |
|
2841 | else: | |
2841 | opts = {} |
|
2842 | opts = {} | |
2842 |
|
2843 | |||
2843 |
|
2844 | |||
2844 | else: |
|
2845 | else: | |
2845 | #turn all non-space-escaping backslashes to slashes, |
|
2846 | #turn all non-space-escaping backslashes to slashes, | |
2846 | # for c:\windows\directory\names\ |
|
2847 | # for c:\windows\directory\names\ | |
2847 | parameter_s = re.sub(r'\\(?! )','/', parameter_s) |
|
2848 | parameter_s = re.sub(r'\\(?! )','/', parameter_s) | |
2848 | opts,ps = self.parse_options(parameter_s,'qb',mode='string') |
|
2849 | opts,ps = self.parse_options(parameter_s,'qb',mode='string') | |
2849 | # jump to previous |
|
2850 | # jump to previous | |
2850 | if ps == '-': |
|
2851 | if ps == '-': | |
2851 | try: |
|
2852 | try: | |
2852 | ps = self.shell.user_ns['_dh'][-2] |
|
2853 | ps = self.shell.user_ns['_dh'][-2] | |
2853 | except IndexError: |
|
2854 | except IndexError: | |
2854 | raise UsageError('%cd -: No previous directory to change to.') |
|
2855 | raise UsageError('%cd -: No previous directory to change to.') | |
2855 | # jump to bookmark if needed |
|
2856 | # jump to bookmark if needed | |
2856 | else: |
|
2857 | else: | |
2857 | if not os.path.isdir(ps) or opts.has_key('b'): |
|
2858 | if not os.path.isdir(ps) or opts.has_key('b'): | |
2858 | bkms = self.db.get('bookmarks', {}) |
|
2859 | bkms = self.db.get('bookmarks', {}) | |
2859 |
|
2860 | |||
2860 | if bkms.has_key(ps): |
|
2861 | if bkms.has_key(ps): | |
2861 | target = bkms[ps] |
|
2862 | target = bkms[ps] | |
2862 | print '(bookmark:%s) -> %s' % (ps,target) |
|
2863 | print '(bookmark:%s) -> %s' % (ps,target) | |
2863 | ps = target |
|
2864 | ps = target | |
2864 | else: |
|
2865 | else: | |
2865 | if opts.has_key('b'): |
|
2866 | if opts.has_key('b'): | |
2866 | raise UsageError("Bookmark '%s' not found. " |
|
2867 | raise UsageError("Bookmark '%s' not found. " | |
2867 | "Use '%%bookmark -l' to see your bookmarks." % ps) |
|
2868 | "Use '%%bookmark -l' to see your bookmarks." % ps) | |
2868 |
|
2869 | |||
2869 | # strip extra quotes on Windows, because os.chdir doesn't like them |
|
2870 | # strip extra quotes on Windows, because os.chdir doesn't like them | |
2870 | ps = unquote_filename(ps) |
|
2871 | ps = unquote_filename(ps) | |
2871 | # at this point ps should point to the target dir |
|
2872 | # at this point ps should point to the target dir | |
2872 | if ps: |
|
2873 | if ps: | |
2873 | try: |
|
2874 | try: | |
2874 | os.chdir(os.path.expanduser(ps)) |
|
2875 | os.chdir(os.path.expanduser(ps)) | |
2875 | if hasattr(self.shell, 'term_title') and self.shell.term_title: |
|
2876 | if hasattr(self.shell, 'term_title') and self.shell.term_title: | |
2876 | set_term_title('IPython: ' + abbrev_cwd()) |
|
2877 | set_term_title('IPython: ' + abbrev_cwd()) | |
2877 | except OSError: |
|
2878 | except OSError: | |
2878 | print sys.exc_info()[1] |
|
2879 | print sys.exc_info()[1] | |
2879 | else: |
|
2880 | else: | |
2880 | cwd = os.getcwdu() |
|
2881 | cwd = os.getcwdu() | |
2881 | dhist = self.shell.user_ns['_dh'] |
|
2882 | dhist = self.shell.user_ns['_dh'] | |
2882 | if oldcwd != cwd: |
|
2883 | if oldcwd != cwd: | |
2883 | dhist.append(cwd) |
|
2884 | dhist.append(cwd) | |
2884 | self.db['dhist'] = compress_dhist(dhist)[-100:] |
|
2885 | self.db['dhist'] = compress_dhist(dhist)[-100:] | |
2885 |
|
2886 | |||
2886 | else: |
|
2887 | else: | |
2887 | os.chdir(self.shell.home_dir) |
|
2888 | os.chdir(self.shell.home_dir) | |
2888 | if hasattr(self.shell, 'term_title') and self.shell.term_title: |
|
2889 | if hasattr(self.shell, 'term_title') and self.shell.term_title: | |
2889 | set_term_title('IPython: ' + '~') |
|
2890 | set_term_title('IPython: ' + '~') | |
2890 | cwd = os.getcwdu() |
|
2891 | cwd = os.getcwdu() | |
2891 | dhist = self.shell.user_ns['_dh'] |
|
2892 | dhist = self.shell.user_ns['_dh'] | |
2892 |
|
2893 | |||
2893 | if oldcwd != cwd: |
|
2894 | if oldcwd != cwd: | |
2894 | dhist.append(cwd) |
|
2895 | dhist.append(cwd) | |
2895 | self.db['dhist'] = compress_dhist(dhist)[-100:] |
|
2896 | self.db['dhist'] = compress_dhist(dhist)[-100:] | |
2896 | if not 'q' in opts and self.shell.user_ns['_dh']: |
|
2897 | if not 'q' in opts and self.shell.user_ns['_dh']: | |
2897 | print self.shell.user_ns['_dh'][-1] |
|
2898 | print self.shell.user_ns['_dh'][-1] | |
2898 |
|
2899 | |||
2899 |
|
2900 | |||
2900 | def magic_env(self, parameter_s=''): |
|
2901 | def magic_env(self, parameter_s=''): | |
2901 | """List environment variables.""" |
|
2902 | """List environment variables.""" | |
2902 |
|
2903 | |||
2903 | return os.environ.data |
|
2904 | return os.environ.data | |
2904 |
|
2905 | |||
2905 | def magic_pushd(self, parameter_s=''): |
|
2906 | def magic_pushd(self, parameter_s=''): | |
2906 | """Place the current dir on stack and change directory. |
|
2907 | """Place the current dir on stack and change directory. | |
2907 |
|
2908 | |||
2908 | Usage:\\ |
|
2909 | Usage:\\ | |
2909 | %pushd ['dirname'] |
|
2910 | %pushd ['dirname'] | |
2910 | """ |
|
2911 | """ | |
2911 |
|
2912 | |||
2912 | dir_s = self.shell.dir_stack |
|
2913 | dir_s = self.shell.dir_stack | |
2913 | tgt = os.path.expanduser(unquote_filename(parameter_s)) |
|
2914 | tgt = os.path.expanduser(unquote_filename(parameter_s)) | |
2914 | cwd = os.getcwdu().replace(self.home_dir,'~') |
|
2915 | cwd = os.getcwdu().replace(self.home_dir,'~') | |
2915 | if tgt: |
|
2916 | if tgt: | |
2916 | self.magic_cd(parameter_s) |
|
2917 | self.magic_cd(parameter_s) | |
2917 | dir_s.insert(0,cwd) |
|
2918 | dir_s.insert(0,cwd) | |
2918 | return self.magic_dirs() |
|
2919 | return self.magic_dirs() | |
2919 |
|
2920 | |||
2920 | def magic_popd(self, parameter_s=''): |
|
2921 | def magic_popd(self, parameter_s=''): | |
2921 | """Change to directory popped off the top of the stack. |
|
2922 | """Change to directory popped off the top of the stack. | |
2922 | """ |
|
2923 | """ | |
2923 | if not self.shell.dir_stack: |
|
2924 | if not self.shell.dir_stack: | |
2924 | raise UsageError("%popd on empty stack") |
|
2925 | raise UsageError("%popd on empty stack") | |
2925 | top = self.shell.dir_stack.pop(0) |
|
2926 | top = self.shell.dir_stack.pop(0) | |
2926 | self.magic_cd(top) |
|
2927 | self.magic_cd(top) | |
2927 | print "popd ->",top |
|
2928 | print "popd ->",top | |
2928 |
|
2929 | |||
2929 | def magic_dirs(self, parameter_s=''): |
|
2930 | def magic_dirs(self, parameter_s=''): | |
2930 | """Return the current directory stack.""" |
|
2931 | """Return the current directory stack.""" | |
2931 |
|
2932 | |||
2932 | return self.shell.dir_stack |
|
2933 | return self.shell.dir_stack | |
2933 |
|
2934 | |||
2934 | def magic_dhist(self, parameter_s=''): |
|
2935 | def magic_dhist(self, parameter_s=''): | |
2935 | """Print your history of visited directories. |
|
2936 | """Print your history of visited directories. | |
2936 |
|
2937 | |||
2937 | %dhist -> print full history\\ |
|
2938 | %dhist -> print full history\\ | |
2938 | %dhist n -> print last n entries only\\ |
|
2939 | %dhist n -> print last n entries only\\ | |
2939 | %dhist n1 n2 -> print entries between n1 and n2 (n1 not included)\\ |
|
2940 | %dhist n1 n2 -> print entries between n1 and n2 (n1 not included)\\ | |
2940 |
|
2941 | |||
2941 | This history is automatically maintained by the %cd command, and |
|
2942 | This history is automatically maintained by the %cd command, and | |
2942 | always available as the global list variable _dh. You can use %cd -<n> |
|
2943 | always available as the global list variable _dh. You can use %cd -<n> | |
2943 | to go to directory number <n>. |
|
2944 | to go to directory number <n>. | |
2944 |
|
2945 | |||
2945 | Note that most of time, you should view directory history by entering |
|
2946 | Note that most of time, you should view directory history by entering | |
2946 | cd -<TAB>. |
|
2947 | cd -<TAB>. | |
2947 |
|
2948 | |||
2948 | """ |
|
2949 | """ | |
2949 |
|
2950 | |||
2950 | dh = self.shell.user_ns['_dh'] |
|
2951 | dh = self.shell.user_ns['_dh'] | |
2951 | if parameter_s: |
|
2952 | if parameter_s: | |
2952 | try: |
|
2953 | try: | |
2953 | args = map(int,parameter_s.split()) |
|
2954 | args = map(int,parameter_s.split()) | |
2954 | except: |
|
2955 | except: | |
2955 | self.arg_err(Magic.magic_dhist) |
|
2956 | self.arg_err(Magic.magic_dhist) | |
2956 | return |
|
2957 | return | |
2957 | if len(args) == 1: |
|
2958 | if len(args) == 1: | |
2958 | ini,fin = max(len(dh)-(args[0]),0),len(dh) |
|
2959 | ini,fin = max(len(dh)-(args[0]),0),len(dh) | |
2959 | elif len(args) == 2: |
|
2960 | elif len(args) == 2: | |
2960 | ini,fin = args |
|
2961 | ini,fin = args | |
2961 | else: |
|
2962 | else: | |
2962 | self.arg_err(Magic.magic_dhist) |
|
2963 | self.arg_err(Magic.magic_dhist) | |
2963 | return |
|
2964 | return | |
2964 | else: |
|
2965 | else: | |
2965 | ini,fin = 0,len(dh) |
|
2966 | ini,fin = 0,len(dh) | |
2966 | nlprint(dh, |
|
2967 | nlprint(dh, | |
2967 | header = 'Directory history (kept in _dh)', |
|
2968 | header = 'Directory history (kept in _dh)', | |
2968 | start=ini,stop=fin) |
|
2969 | start=ini,stop=fin) | |
2969 |
|
2970 | |||
2970 | @skip_doctest |
|
2971 | @skip_doctest | |
2971 | def magic_sc(self, parameter_s=''): |
|
2972 | def magic_sc(self, parameter_s=''): | |
2972 | """Shell capture - execute a shell command and capture its output. |
|
2973 | """Shell capture - execute a shell command and capture its output. | |
2973 |
|
2974 | |||
2974 | DEPRECATED. Suboptimal, retained for backwards compatibility. |
|
2975 | DEPRECATED. Suboptimal, retained for backwards compatibility. | |
2975 |
|
2976 | |||
2976 | You should use the form 'var = !command' instead. Example: |
|
2977 | You should use the form 'var = !command' instead. Example: | |
2977 |
|
2978 | |||
2978 | "%sc -l myfiles = ls ~" should now be written as |
|
2979 | "%sc -l myfiles = ls ~" should now be written as | |
2979 |
|
2980 | |||
2980 | "myfiles = !ls ~" |
|
2981 | "myfiles = !ls ~" | |
2981 |
|
2982 | |||
2982 | myfiles.s, myfiles.l and myfiles.n still apply as documented |
|
2983 | myfiles.s, myfiles.l and myfiles.n still apply as documented | |
2983 | below. |
|
2984 | below. | |
2984 |
|
2985 | |||
2985 | -- |
|
2986 | -- | |
2986 | %sc [options] varname=command |
|
2987 | %sc [options] varname=command | |
2987 |
|
2988 | |||
2988 | IPython will run the given command using commands.getoutput(), and |
|
2989 | IPython will run the given command using commands.getoutput(), and | |
2989 | will then update the user's interactive namespace with a variable |
|
2990 | will then update the user's interactive namespace with a variable | |
2990 | called varname, containing the value of the call. Your command can |
|
2991 | called varname, containing the value of the call. Your command can | |
2991 | contain shell wildcards, pipes, etc. |
|
2992 | contain shell wildcards, pipes, etc. | |
2992 |
|
2993 | |||
2993 | The '=' sign in the syntax is mandatory, and the variable name you |
|
2994 | The '=' sign in the syntax is mandatory, and the variable name you | |
2994 | supply must follow Python's standard conventions for valid names. |
|
2995 | supply must follow Python's standard conventions for valid names. | |
2995 |
|
2996 | |||
2996 | (A special format without variable name exists for internal use) |
|
2997 | (A special format without variable name exists for internal use) | |
2997 |
|
2998 | |||
2998 | Options: |
|
2999 | Options: | |
2999 |
|
3000 | |||
3000 | -l: list output. Split the output on newlines into a list before |
|
3001 | -l: list output. Split the output on newlines into a list before | |
3001 | assigning it to the given variable. By default the output is stored |
|
3002 | assigning it to the given variable. By default the output is stored | |
3002 | as a single string. |
|
3003 | as a single string. | |
3003 |
|
3004 | |||
3004 | -v: verbose. Print the contents of the variable. |
|
3005 | -v: verbose. Print the contents of the variable. | |
3005 |
|
3006 | |||
3006 | In most cases you should not need to split as a list, because the |
|
3007 | In most cases you should not need to split as a list, because the | |
3007 | returned value is a special type of string which can automatically |
|
3008 | returned value is a special type of string which can automatically | |
3008 | provide its contents either as a list (split on newlines) or as a |
|
3009 | provide its contents either as a list (split on newlines) or as a | |
3009 | space-separated string. These are convenient, respectively, either |
|
3010 | space-separated string. These are convenient, respectively, either | |
3010 | for sequential processing or to be passed to a shell command. |
|
3011 | for sequential processing or to be passed to a shell command. | |
3011 |
|
3012 | |||
3012 | For example: |
|
3013 | For example: | |
3013 |
|
3014 | |||
3014 | # all-random |
|
3015 | # all-random | |
3015 |
|
3016 | |||
3016 | # Capture into variable a |
|
3017 | # Capture into variable a | |
3017 | In [1]: sc a=ls *py |
|
3018 | In [1]: sc a=ls *py | |
3018 |
|
3019 | |||
3019 | # a is a string with embedded newlines |
|
3020 | # a is a string with embedded newlines | |
3020 | In [2]: a |
|
3021 | In [2]: a | |
3021 | Out[2]: 'setup.py\\nwin32_manual_post_install.py' |
|
3022 | Out[2]: 'setup.py\\nwin32_manual_post_install.py' | |
3022 |
|
3023 | |||
3023 | # which can be seen as a list: |
|
3024 | # which can be seen as a list: | |
3024 | In [3]: a.l |
|
3025 | In [3]: a.l | |
3025 | Out[3]: ['setup.py', 'win32_manual_post_install.py'] |
|
3026 | Out[3]: ['setup.py', 'win32_manual_post_install.py'] | |
3026 |
|
3027 | |||
3027 | # or as a whitespace-separated string: |
|
3028 | # or as a whitespace-separated string: | |
3028 | In [4]: a.s |
|
3029 | In [4]: a.s | |
3029 | Out[4]: 'setup.py win32_manual_post_install.py' |
|
3030 | Out[4]: 'setup.py win32_manual_post_install.py' | |
3030 |
|
3031 | |||
3031 | # a.s is useful to pass as a single command line: |
|
3032 | # a.s is useful to pass as a single command line: | |
3032 | In [5]: !wc -l $a.s |
|
3033 | In [5]: !wc -l $a.s | |
3033 | 146 setup.py |
|
3034 | 146 setup.py | |
3034 | 130 win32_manual_post_install.py |
|
3035 | 130 win32_manual_post_install.py | |
3035 | 276 total |
|
3036 | 276 total | |
3036 |
|
3037 | |||
3037 | # while the list form is useful to loop over: |
|
3038 | # while the list form is useful to loop over: | |
3038 | In [6]: for f in a.l: |
|
3039 | In [6]: for f in a.l: | |
3039 | ...: !wc -l $f |
|
3040 | ...: !wc -l $f | |
3040 | ...: |
|
3041 | ...: | |
3041 | 146 setup.py |
|
3042 | 146 setup.py | |
3042 | 130 win32_manual_post_install.py |
|
3043 | 130 win32_manual_post_install.py | |
3043 |
|
3044 | |||
3044 | Similiarly, the lists returned by the -l option are also special, in |
|
3045 | Similiarly, the lists returned by the -l option are also special, in | |
3045 | the sense that you can equally invoke the .s attribute on them to |
|
3046 | the sense that you can equally invoke the .s attribute on them to | |
3046 | automatically get a whitespace-separated string from their contents: |
|
3047 | automatically get a whitespace-separated string from their contents: | |
3047 |
|
3048 | |||
3048 | In [7]: sc -l b=ls *py |
|
3049 | In [7]: sc -l b=ls *py | |
3049 |
|
3050 | |||
3050 | In [8]: b |
|
3051 | In [8]: b | |
3051 | Out[8]: ['setup.py', 'win32_manual_post_install.py'] |
|
3052 | Out[8]: ['setup.py', 'win32_manual_post_install.py'] | |
3052 |
|
3053 | |||
3053 | In [9]: b.s |
|
3054 | In [9]: b.s | |
3054 | Out[9]: 'setup.py win32_manual_post_install.py' |
|
3055 | Out[9]: 'setup.py win32_manual_post_install.py' | |
3055 |
|
3056 | |||
3056 | In summary, both the lists and strings used for ouptut capture have |
|
3057 | In summary, both the lists and strings used for ouptut capture have | |
3057 | the following special attributes: |
|
3058 | the following special attributes: | |
3058 |
|
3059 | |||
3059 | .l (or .list) : value as list. |
|
3060 | .l (or .list) : value as list. | |
3060 | .n (or .nlstr): value as newline-separated string. |
|
3061 | .n (or .nlstr): value as newline-separated string. | |
3061 | .s (or .spstr): value as space-separated string. |
|
3062 | .s (or .spstr): value as space-separated string. | |
3062 | """ |
|
3063 | """ | |
3063 |
|
3064 | |||
3064 | opts,args = self.parse_options(parameter_s,'lv') |
|
3065 | opts,args = self.parse_options(parameter_s,'lv') | |
3065 | # Try to get a variable name and command to run |
|
3066 | # Try to get a variable name and command to run | |
3066 | try: |
|
3067 | try: | |
3067 | # the variable name must be obtained from the parse_options |
|
3068 | # the variable name must be obtained from the parse_options | |
3068 | # output, which uses shlex.split to strip options out. |
|
3069 | # output, which uses shlex.split to strip options out. | |
3069 | var,_ = args.split('=',1) |
|
3070 | var,_ = args.split('=',1) | |
3070 | var = var.strip() |
|
3071 | var = var.strip() | |
3071 | # But the the command has to be extracted from the original input |
|
3072 | # But the the command has to be extracted from the original input | |
3072 | # parameter_s, not on what parse_options returns, to avoid the |
|
3073 | # parameter_s, not on what parse_options returns, to avoid the | |
3073 | # quote stripping which shlex.split performs on it. |
|
3074 | # quote stripping which shlex.split performs on it. | |
3074 | _,cmd = parameter_s.split('=',1) |
|
3075 | _,cmd = parameter_s.split('=',1) | |
3075 | except ValueError: |
|
3076 | except ValueError: | |
3076 | var,cmd = '','' |
|
3077 | var,cmd = '','' | |
3077 | # If all looks ok, proceed |
|
3078 | # If all looks ok, proceed | |
3078 | split = 'l' in opts |
|
3079 | split = 'l' in opts | |
3079 | out = self.shell.getoutput(cmd, split=split) |
|
3080 | out = self.shell.getoutput(cmd, split=split) | |
3080 | if opts.has_key('v'): |
|
3081 | if opts.has_key('v'): | |
3081 | print '%s ==\n%s' % (var,pformat(out)) |
|
3082 | print '%s ==\n%s' % (var,pformat(out)) | |
3082 | if var: |
|
3083 | if var: | |
3083 | self.shell.user_ns.update({var:out}) |
|
3084 | self.shell.user_ns.update({var:out}) | |
3084 | else: |
|
3085 | else: | |
3085 | return out |
|
3086 | return out | |
3086 |
|
3087 | |||
3087 | def magic_sx(self, parameter_s=''): |
|
3088 | def magic_sx(self, parameter_s=''): | |
3088 | """Shell execute - run a shell command and capture its output. |
|
3089 | """Shell execute - run a shell command and capture its output. | |
3089 |
|
3090 | |||
3090 | %sx command |
|
3091 | %sx command | |
3091 |
|
3092 | |||
3092 | IPython will run the given command using commands.getoutput(), and |
|
3093 | IPython will run the given command using commands.getoutput(), and | |
3093 | return the result formatted as a list (split on '\\n'). Since the |
|
3094 | return the result formatted as a list (split on '\\n'). Since the | |
3094 | output is _returned_, it will be stored in ipython's regular output |
|
3095 | output is _returned_, it will be stored in ipython's regular output | |
3095 | cache Out[N] and in the '_N' automatic variables. |
|
3096 | cache Out[N] and in the '_N' automatic variables. | |
3096 |
|
3097 | |||
3097 | Notes: |
|
3098 | Notes: | |
3098 |
|
3099 | |||
3099 | 1) If an input line begins with '!!', then %sx is automatically |
|
3100 | 1) If an input line begins with '!!', then %sx is automatically | |
3100 | invoked. That is, while: |
|
3101 | invoked. That is, while: | |
3101 | !ls |
|
3102 | !ls | |
3102 | causes ipython to simply issue system('ls'), typing |
|
3103 | causes ipython to simply issue system('ls'), typing | |
3103 | !!ls |
|
3104 | !!ls | |
3104 | is a shorthand equivalent to: |
|
3105 | is a shorthand equivalent to: | |
3105 | %sx ls |
|
3106 | %sx ls | |
3106 |
|
3107 | |||
3107 | 2) %sx differs from %sc in that %sx automatically splits into a list, |
|
3108 | 2) %sx differs from %sc in that %sx automatically splits into a list, | |
3108 | like '%sc -l'. The reason for this is to make it as easy as possible |
|
3109 | like '%sc -l'. The reason for this is to make it as easy as possible | |
3109 | to process line-oriented shell output via further python commands. |
|
3110 | to process line-oriented shell output via further python commands. | |
3110 | %sc is meant to provide much finer control, but requires more |
|
3111 | %sc is meant to provide much finer control, but requires more | |
3111 | typing. |
|
3112 | typing. | |
3112 |
|
3113 | |||
3113 | 3) Just like %sc -l, this is a list with special attributes: |
|
3114 | 3) Just like %sc -l, this is a list with special attributes: | |
3114 |
|
3115 | |||
3115 | .l (or .list) : value as list. |
|
3116 | .l (or .list) : value as list. | |
3116 | .n (or .nlstr): value as newline-separated string. |
|
3117 | .n (or .nlstr): value as newline-separated string. | |
3117 | .s (or .spstr): value as whitespace-separated string. |
|
3118 | .s (or .spstr): value as whitespace-separated string. | |
3118 |
|
3119 | |||
3119 | This is very useful when trying to use such lists as arguments to |
|
3120 | This is very useful when trying to use such lists as arguments to | |
3120 | system commands.""" |
|
3121 | system commands.""" | |
3121 |
|
3122 | |||
3122 | if parameter_s: |
|
3123 | if parameter_s: | |
3123 | return self.shell.getoutput(parameter_s) |
|
3124 | return self.shell.getoutput(parameter_s) | |
3124 |
|
3125 | |||
3125 |
|
3126 | |||
3126 | def magic_bookmark(self, parameter_s=''): |
|
3127 | def magic_bookmark(self, parameter_s=''): | |
3127 | """Manage IPython's bookmark system. |
|
3128 | """Manage IPython's bookmark system. | |
3128 |
|
3129 | |||
3129 | %bookmark <name> - set bookmark to current dir |
|
3130 | %bookmark <name> - set bookmark to current dir | |
3130 | %bookmark <name> <dir> - set bookmark to <dir> |
|
3131 | %bookmark <name> <dir> - set bookmark to <dir> | |
3131 | %bookmark -l - list all bookmarks |
|
3132 | %bookmark -l - list all bookmarks | |
3132 | %bookmark -d <name> - remove bookmark |
|
3133 | %bookmark -d <name> - remove bookmark | |
3133 | %bookmark -r - remove all bookmarks |
|
3134 | %bookmark -r - remove all bookmarks | |
3134 |
|
3135 | |||
3135 | You can later on access a bookmarked folder with: |
|
3136 | You can later on access a bookmarked folder with: | |
3136 | %cd -b <name> |
|
3137 | %cd -b <name> | |
3137 | or simply '%cd <name>' if there is no directory called <name> AND |
|
3138 | or simply '%cd <name>' if there is no directory called <name> AND | |
3138 | there is such a bookmark defined. |
|
3139 | there is such a bookmark defined. | |
3139 |
|
3140 | |||
3140 | Your bookmarks persist through IPython sessions, but they are |
|
3141 | Your bookmarks persist through IPython sessions, but they are | |
3141 | associated with each profile.""" |
|
3142 | associated with each profile.""" | |
3142 |
|
3143 | |||
3143 | opts,args = self.parse_options(parameter_s,'drl',mode='list') |
|
3144 | opts,args = self.parse_options(parameter_s,'drl',mode='list') | |
3144 | if len(args) > 2: |
|
3145 | if len(args) > 2: | |
3145 | raise UsageError("%bookmark: too many arguments") |
|
3146 | raise UsageError("%bookmark: too many arguments") | |
3146 |
|
3147 | |||
3147 | bkms = self.db.get('bookmarks',{}) |
|
3148 | bkms = self.db.get('bookmarks',{}) | |
3148 |
|
3149 | |||
3149 | if opts.has_key('d'): |
|
3150 | if opts.has_key('d'): | |
3150 | try: |
|
3151 | try: | |
3151 | todel = args[0] |
|
3152 | todel = args[0] | |
3152 | except IndexError: |
|
3153 | except IndexError: | |
3153 | raise UsageError( |
|
3154 | raise UsageError( | |
3154 | "%bookmark -d: must provide a bookmark to delete") |
|
3155 | "%bookmark -d: must provide a bookmark to delete") | |
3155 | else: |
|
3156 | else: | |
3156 | try: |
|
3157 | try: | |
3157 | del bkms[todel] |
|
3158 | del bkms[todel] | |
3158 | except KeyError: |
|
3159 | except KeyError: | |
3159 | raise UsageError( |
|
3160 | raise UsageError( | |
3160 | "%%bookmark -d: Can't delete bookmark '%s'" % todel) |
|
3161 | "%%bookmark -d: Can't delete bookmark '%s'" % todel) | |
3161 |
|
3162 | |||
3162 | elif opts.has_key('r'): |
|
3163 | elif opts.has_key('r'): | |
3163 | bkms = {} |
|
3164 | bkms = {} | |
3164 | elif opts.has_key('l'): |
|
3165 | elif opts.has_key('l'): | |
3165 | bks = bkms.keys() |
|
3166 | bks = bkms.keys() | |
3166 | bks.sort() |
|
3167 | bks.sort() | |
3167 | if bks: |
|
3168 | if bks: | |
3168 | size = max(map(len,bks)) |
|
3169 | size = max(map(len,bks)) | |
3169 | else: |
|
3170 | else: | |
3170 | size = 0 |
|
3171 | size = 0 | |
3171 | fmt = '%-'+str(size)+'s -> %s' |
|
3172 | fmt = '%-'+str(size)+'s -> %s' | |
3172 | print 'Current bookmarks:' |
|
3173 | print 'Current bookmarks:' | |
3173 | for bk in bks: |
|
3174 | for bk in bks: | |
3174 | print fmt % (bk,bkms[bk]) |
|
3175 | print fmt % (bk,bkms[bk]) | |
3175 | else: |
|
3176 | else: | |
3176 | if not args: |
|
3177 | if not args: | |
3177 | raise UsageError("%bookmark: You must specify the bookmark name") |
|
3178 | raise UsageError("%bookmark: You must specify the bookmark name") | |
3178 | elif len(args)==1: |
|
3179 | elif len(args)==1: | |
3179 | bkms[args[0]] = os.getcwdu() |
|
3180 | bkms[args[0]] = os.getcwdu() | |
3180 | elif len(args)==2: |
|
3181 | elif len(args)==2: | |
3181 | bkms[args[0]] = args[1] |
|
3182 | bkms[args[0]] = args[1] | |
3182 | self.db['bookmarks'] = bkms |
|
3183 | self.db['bookmarks'] = bkms | |
3183 |
|
3184 | |||
3184 | def magic_pycat(self, parameter_s=''): |
|
3185 | def magic_pycat(self, parameter_s=''): | |
3185 | """Show a syntax-highlighted file through a pager. |
|
3186 | """Show a syntax-highlighted file through a pager. | |
3186 |
|
3187 | |||
3187 | This magic is similar to the cat utility, but it will assume the file |
|
3188 | This magic is similar to the cat utility, but it will assume the file | |
3188 | to be Python source and will show it with syntax highlighting. """ |
|
3189 | to be Python source and will show it with syntax highlighting. """ | |
3189 |
|
3190 | |||
3190 | try: |
|
3191 | try: | |
3191 | filename = get_py_filename(parameter_s) |
|
3192 | filename = get_py_filename(parameter_s) | |
3192 | cont = file_read(filename) |
|
3193 | cont = file_read(filename) | |
3193 | except IOError: |
|
3194 | except IOError: | |
3194 | try: |
|
3195 | try: | |
3195 | cont = eval(parameter_s,self.user_ns) |
|
3196 | cont = eval(parameter_s,self.user_ns) | |
3196 | except NameError: |
|
3197 | except NameError: | |
3197 | cont = None |
|
3198 | cont = None | |
3198 | if cont is None: |
|
3199 | if cont is None: | |
3199 | print "Error: no such file or variable" |
|
3200 | print "Error: no such file or variable" | |
3200 | return |
|
3201 | return | |
3201 |
|
3202 | |||
3202 | page.page(self.shell.pycolorize(cont)) |
|
3203 | page.page(self.shell.pycolorize(cont)) | |
3203 |
|
3204 | |||
3204 | def magic_quickref(self,arg): |
|
3205 | def magic_quickref(self,arg): | |
3205 | """ Show a quick reference sheet """ |
|
3206 | """ Show a quick reference sheet """ | |
3206 | import IPython.core.usage |
|
3207 | import IPython.core.usage | |
3207 | qr = IPython.core.usage.quick_reference + self.magic_magic('-brief') |
|
3208 | qr = IPython.core.usage.quick_reference + self.magic_magic('-brief') | |
3208 |
|
3209 | |||
3209 | page.page(qr) |
|
3210 | page.page(qr) | |
3210 |
|
3211 | |||
3211 | def magic_doctest_mode(self,parameter_s=''): |
|
3212 | def magic_doctest_mode(self,parameter_s=''): | |
3212 | """Toggle doctest mode on and off. |
|
3213 | """Toggle doctest mode on and off. | |
3213 |
|
3214 | |||
3214 | This mode is intended to make IPython behave as much as possible like a |
|
3215 | This mode is intended to make IPython behave as much as possible like a | |
3215 | plain Python shell, from the perspective of how its prompts, exceptions |
|
3216 | plain Python shell, from the perspective of how its prompts, exceptions | |
3216 | and output look. This makes it easy to copy and paste parts of a |
|
3217 | and output look. This makes it easy to copy and paste parts of a | |
3217 | session into doctests. It does so by: |
|
3218 | session into doctests. It does so by: | |
3218 |
|
3219 | |||
3219 | - Changing the prompts to the classic ``>>>`` ones. |
|
3220 | - Changing the prompts to the classic ``>>>`` ones. | |
3220 | - Changing the exception reporting mode to 'Plain'. |
|
3221 | - Changing the exception reporting mode to 'Plain'. | |
3221 | - Disabling pretty-printing of output. |
|
3222 | - Disabling pretty-printing of output. | |
3222 |
|
3223 | |||
3223 | Note that IPython also supports the pasting of code snippets that have |
|
3224 | Note that IPython also supports the pasting of code snippets that have | |
3224 | leading '>>>' and '...' prompts in them. This means that you can paste |
|
3225 | leading '>>>' and '...' prompts in them. This means that you can paste | |
3225 | doctests from files or docstrings (even if they have leading |
|
3226 | doctests from files or docstrings (even if they have leading | |
3226 | whitespace), and the code will execute correctly. You can then use |
|
3227 | whitespace), and the code will execute correctly. You can then use | |
3227 | '%history -t' to see the translated history; this will give you the |
|
3228 | '%history -t' to see the translated history; this will give you the | |
3228 | input after removal of all the leading prompts and whitespace, which |
|
3229 | input after removal of all the leading prompts and whitespace, which | |
3229 | can be pasted back into an editor. |
|
3230 | can be pasted back into an editor. | |
3230 |
|
3231 | |||
3231 | With these features, you can switch into this mode easily whenever you |
|
3232 | With these features, you can switch into this mode easily whenever you | |
3232 | need to do testing and changes to doctests, without having to leave |
|
3233 | need to do testing and changes to doctests, without having to leave | |
3233 | your existing IPython session. |
|
3234 | your existing IPython session. | |
3234 | """ |
|
3235 | """ | |
3235 |
|
3236 | |||
3236 | from IPython.utils.ipstruct import Struct |
|
3237 | from IPython.utils.ipstruct import Struct | |
3237 |
|
3238 | |||
3238 | # Shorthands |
|
3239 | # Shorthands | |
3239 | shell = self.shell |
|
3240 | shell = self.shell | |
3240 | pm = shell.prompt_manager |
|
3241 | pm = shell.prompt_manager | |
3241 | meta = shell.meta |
|
3242 | meta = shell.meta | |
3242 | disp_formatter = self.shell.display_formatter |
|
3243 | disp_formatter = self.shell.display_formatter | |
3243 | ptformatter = disp_formatter.formatters['text/plain'] |
|
3244 | ptformatter = disp_formatter.formatters['text/plain'] | |
3244 | # dstore is a data store kept in the instance metadata bag to track any |
|
3245 | # dstore is a data store kept in the instance metadata bag to track any | |
3245 | # changes we make, so we can undo them later. |
|
3246 | # changes we make, so we can undo them later. | |
3246 | dstore = meta.setdefault('doctest_mode',Struct()) |
|
3247 | dstore = meta.setdefault('doctest_mode',Struct()) | |
3247 | save_dstore = dstore.setdefault |
|
3248 | save_dstore = dstore.setdefault | |
3248 |
|
3249 | |||
3249 | # save a few values we'll need to recover later |
|
3250 | # save a few values we'll need to recover later | |
3250 | mode = save_dstore('mode',False) |
|
3251 | mode = save_dstore('mode',False) | |
3251 | save_dstore('rc_pprint',ptformatter.pprint) |
|
3252 | save_dstore('rc_pprint',ptformatter.pprint) | |
3252 | save_dstore('xmode',shell.InteractiveTB.mode) |
|
3253 | save_dstore('xmode',shell.InteractiveTB.mode) | |
3253 | save_dstore('rc_separate_out',shell.separate_out) |
|
3254 | save_dstore('rc_separate_out',shell.separate_out) | |
3254 | save_dstore('rc_separate_out2',shell.separate_out2) |
|
3255 | save_dstore('rc_separate_out2',shell.separate_out2) | |
3255 | save_dstore('rc_prompts_pad_left',pm.justify) |
|
3256 | save_dstore('rc_prompts_pad_left',pm.justify) | |
3256 | save_dstore('rc_separate_in',shell.separate_in) |
|
3257 | save_dstore('rc_separate_in',shell.separate_in) | |
3257 | save_dstore('rc_plain_text_only',disp_formatter.plain_text_only) |
|
3258 | save_dstore('rc_plain_text_only',disp_formatter.plain_text_only) | |
3258 | save_dstore('prompt_templates',(pm.in_template, pm.in2_template, pm.out_template)) |
|
3259 | save_dstore('prompt_templates',(pm.in_template, pm.in2_template, pm.out_template)) | |
3259 |
|
3260 | |||
3260 | if mode == False: |
|
3261 | if mode == False: | |
3261 | # turn on |
|
3262 | # turn on | |
3262 | pm.in_template = '>>> ' |
|
3263 | pm.in_template = '>>> ' | |
3263 | pm.in2_template = '... ' |
|
3264 | pm.in2_template = '... ' | |
3264 | pm.out_template = '' |
|
3265 | pm.out_template = '' | |
3265 |
|
3266 | |||
3266 | # Prompt separators like plain python |
|
3267 | # Prompt separators like plain python | |
3267 | shell.separate_in = '' |
|
3268 | shell.separate_in = '' | |
3268 | shell.separate_out = '' |
|
3269 | shell.separate_out = '' | |
3269 | shell.separate_out2 = '' |
|
3270 | shell.separate_out2 = '' | |
3270 |
|
3271 | |||
3271 | pm.justify = False |
|
3272 | pm.justify = False | |
3272 |
|
3273 | |||
3273 | ptformatter.pprint = False |
|
3274 | ptformatter.pprint = False | |
3274 | disp_formatter.plain_text_only = True |
|
3275 | disp_formatter.plain_text_only = True | |
3275 |
|
3276 | |||
3276 | shell.magic_xmode('Plain') |
|
3277 | shell.magic_xmode('Plain') | |
3277 | else: |
|
3278 | else: | |
3278 | # turn off |
|
3279 | # turn off | |
3279 | pm.in_template, pm.in2_template, pm.out_template = dstore.prompt_templates |
|
3280 | pm.in_template, pm.in2_template, pm.out_template = dstore.prompt_templates | |
3280 |
|
3281 | |||
3281 | shell.separate_in = dstore.rc_separate_in |
|
3282 | shell.separate_in = dstore.rc_separate_in | |
3282 |
|
3283 | |||
3283 | shell.separate_out = dstore.rc_separate_out |
|
3284 | shell.separate_out = dstore.rc_separate_out | |
3284 | shell.separate_out2 = dstore.rc_separate_out2 |
|
3285 | shell.separate_out2 = dstore.rc_separate_out2 | |
3285 |
|
3286 | |||
3286 | pm.justify = dstore.rc_prompts_pad_left |
|
3287 | pm.justify = dstore.rc_prompts_pad_left | |
3287 |
|
3288 | |||
3288 | ptformatter.pprint = dstore.rc_pprint |
|
3289 | ptformatter.pprint = dstore.rc_pprint | |
3289 | disp_formatter.plain_text_only = dstore.rc_plain_text_only |
|
3290 | disp_formatter.plain_text_only = dstore.rc_plain_text_only | |
3290 |
|
3291 | |||
3291 | shell.magic_xmode(dstore.xmode) |
|
3292 | shell.magic_xmode(dstore.xmode) | |
3292 |
|
3293 | |||
3293 | # Store new mode and inform |
|
3294 | # Store new mode and inform | |
3294 | dstore.mode = bool(1-int(mode)) |
|
3295 | dstore.mode = bool(1-int(mode)) | |
3295 | mode_label = ['OFF','ON'][dstore.mode] |
|
3296 | mode_label = ['OFF','ON'][dstore.mode] | |
3296 | print 'Doctest mode is:', mode_label |
|
3297 | print 'Doctest mode is:', mode_label | |
3297 |
|
3298 | |||
3298 | def magic_gui(self, parameter_s=''): |
|
3299 | def magic_gui(self, parameter_s=''): | |
3299 | """Enable or disable IPython GUI event loop integration. |
|
3300 | """Enable or disable IPython GUI event loop integration. | |
3300 |
|
3301 | |||
3301 | %gui [GUINAME] |
|
3302 | %gui [GUINAME] | |
3302 |
|
3303 | |||
3303 | This magic replaces IPython's threaded shells that were activated |
|
3304 | This magic replaces IPython's threaded shells that were activated | |
3304 | using the (pylab/wthread/etc.) command line flags. GUI toolkits |
|
3305 | using the (pylab/wthread/etc.) command line flags. GUI toolkits | |
3305 | can now be enabled at runtime and keyboard |
|
3306 | can now be enabled at runtime and keyboard | |
3306 | interrupts should work without any problems. The following toolkits |
|
3307 | interrupts should work without any problems. The following toolkits | |
3307 | are supported: wxPython, PyQt4, PyGTK, Tk and Cocoa (OSX):: |
|
3308 | are supported: wxPython, PyQt4, PyGTK, Tk and Cocoa (OSX):: | |
3308 |
|
3309 | |||
3309 | %gui wx # enable wxPython event loop integration |
|
3310 | %gui wx # enable wxPython event loop integration | |
3310 | %gui qt4|qt # enable PyQt4 event loop integration |
|
3311 | %gui qt4|qt # enable PyQt4 event loop integration | |
3311 | %gui gtk # enable PyGTK event loop integration |
|
3312 | %gui gtk # enable PyGTK event loop integration | |
3312 | %gui tk # enable Tk event loop integration |
|
3313 | %gui tk # enable Tk event loop integration | |
3313 | %gui OSX # enable Cocoa event loop integration |
|
3314 | %gui OSX # enable Cocoa event loop integration | |
3314 | # (requires %matplotlib 1.1) |
|
3315 | # (requires %matplotlib 1.1) | |
3315 | %gui # disable all event loop integration |
|
3316 | %gui # disable all event loop integration | |
3316 |
|
3317 | |||
3317 | WARNING: after any of these has been called you can simply create |
|
3318 | WARNING: after any of these has been called you can simply create | |
3318 | an application object, but DO NOT start the event loop yourself, as |
|
3319 | an application object, but DO NOT start the event loop yourself, as | |
3319 | we have already handled that. |
|
3320 | we have already handled that. | |
3320 | """ |
|
3321 | """ | |
3321 | opts, arg = self.parse_options(parameter_s, '') |
|
3322 | opts, arg = self.parse_options(parameter_s, '') | |
3322 | if arg=='': arg = None |
|
3323 | if arg=='': arg = None | |
3323 | try: |
|
3324 | try: | |
3324 | return self.enable_gui(arg) |
|
3325 | return self.enable_gui(arg) | |
3325 | except Exception as e: |
|
3326 | except Exception as e: | |
3326 | # print simple error message, rather than traceback if we can't |
|
3327 | # print simple error message, rather than traceback if we can't | |
3327 | # hook up the GUI |
|
3328 | # hook up the GUI | |
3328 | error(str(e)) |
|
3329 | error(str(e)) | |
3329 |
|
3330 | |||
3330 | def magic_load_ext(self, module_str): |
|
3331 | def magic_load_ext(self, module_str): | |
3331 | """Load an IPython extension by its module name.""" |
|
3332 | """Load an IPython extension by its module name.""" | |
3332 | return self.extension_manager.load_extension(module_str) |
|
3333 | return self.extension_manager.load_extension(module_str) | |
3333 |
|
3334 | |||
3334 | def magic_unload_ext(self, module_str): |
|
3335 | def magic_unload_ext(self, module_str): | |
3335 | """Unload an IPython extension by its module name.""" |
|
3336 | """Unload an IPython extension by its module name.""" | |
3336 | self.extension_manager.unload_extension(module_str) |
|
3337 | self.extension_manager.unload_extension(module_str) | |
3337 |
|
3338 | |||
3338 | def magic_reload_ext(self, module_str): |
|
3339 | def magic_reload_ext(self, module_str): | |
3339 | """Reload an IPython extension by its module name.""" |
|
3340 | """Reload an IPython extension by its module name.""" | |
3340 | self.extension_manager.reload_extension(module_str) |
|
3341 | self.extension_manager.reload_extension(module_str) | |
3341 |
|
3342 | |||
3342 | @skip_doctest |
|
3343 | @skip_doctest | |
3343 | def magic_install_profiles(self, s): |
|
3344 | def magic_install_profiles(self, s): | |
3344 | """Install the default IPython profiles into the .ipython dir. |
|
3345 | """Install the default IPython profiles into the .ipython dir. | |
3345 |
|
3346 | |||
3346 | If the default profiles have already been installed, they will not |
|
3347 | If the default profiles have already been installed, they will not | |
3347 | be overwritten. You can force overwriting them by using the ``-o`` |
|
3348 | be overwritten. You can force overwriting them by using the ``-o`` | |
3348 | option:: |
|
3349 | option:: | |
3349 |
|
3350 | |||
3350 | In [1]: %install_profiles -o |
|
3351 | In [1]: %install_profiles -o | |
3351 | """ |
|
3352 | """ | |
3352 | if '-o' in s: |
|
3353 | if '-o' in s: | |
3353 | overwrite = True |
|
3354 | overwrite = True | |
3354 | else: |
|
3355 | else: | |
3355 | overwrite = False |
|
3356 | overwrite = False | |
3356 | from IPython.config import profile |
|
3357 | from IPython.config import profile | |
3357 | profile_dir = os.path.dirname(profile.__file__) |
|
3358 | profile_dir = os.path.dirname(profile.__file__) | |
3358 | ipython_dir = self.ipython_dir |
|
3359 | ipython_dir = self.ipython_dir | |
3359 | print "Installing profiles to: %s [overwrite=%s]"%(ipython_dir,overwrite) |
|
3360 | print "Installing profiles to: %s [overwrite=%s]"%(ipython_dir,overwrite) | |
3360 | for src in os.listdir(profile_dir): |
|
3361 | for src in os.listdir(profile_dir): | |
3361 | if src.startswith('profile_'): |
|
3362 | if src.startswith('profile_'): | |
3362 | name = src.replace('profile_', '') |
|
3363 | name = src.replace('profile_', '') | |
3363 | print " %s"%name |
|
3364 | print " %s"%name | |
3364 | pd = ProfileDir.create_profile_dir_by_name(ipython_dir, name) |
|
3365 | pd = ProfileDir.create_profile_dir_by_name(ipython_dir, name) | |
3365 | pd.copy_config_file('ipython_config.py', path=src, |
|
3366 | pd.copy_config_file('ipython_config.py', path=src, | |
3366 | overwrite=overwrite) |
|
3367 | overwrite=overwrite) | |
3367 |
|
3368 | |||
3368 | @skip_doctest |
|
3369 | @skip_doctest | |
3369 | def magic_install_default_config(self, s): |
|
3370 | def magic_install_default_config(self, s): | |
3370 | """Install IPython's default config file into the .ipython dir. |
|
3371 | """Install IPython's default config file into the .ipython dir. | |
3371 |
|
3372 | |||
3372 | If the default config file (:file:`ipython_config.py`) is already |
|
3373 | If the default config file (:file:`ipython_config.py`) is already | |
3373 | installed, it will not be overwritten. You can force overwriting |
|
3374 | installed, it will not be overwritten. You can force overwriting | |
3374 | by using the ``-o`` option:: |
|
3375 | by using the ``-o`` option:: | |
3375 |
|
3376 | |||
3376 | In [1]: %install_default_config |
|
3377 | In [1]: %install_default_config | |
3377 | """ |
|
3378 | """ | |
3378 | if '-o' in s: |
|
3379 | if '-o' in s: | |
3379 | overwrite = True |
|
3380 | overwrite = True | |
3380 | else: |
|
3381 | else: | |
3381 | overwrite = False |
|
3382 | overwrite = False | |
3382 | pd = self.shell.profile_dir |
|
3383 | pd = self.shell.profile_dir | |
3383 | print "Installing default config file in: %s" % pd.location |
|
3384 | print "Installing default config file in: %s" % pd.location | |
3384 | pd.copy_config_file('ipython_config.py', overwrite=overwrite) |
|
3385 | pd.copy_config_file('ipython_config.py', overwrite=overwrite) | |
3385 |
|
3386 | |||
3386 | # Pylab support: simple wrappers that activate pylab, load gui input |
|
3387 | # Pylab support: simple wrappers that activate pylab, load gui input | |
3387 | # handling and modify slightly %run |
|
3388 | # handling and modify slightly %run | |
3388 |
|
3389 | |||
3389 | @skip_doctest |
|
3390 | @skip_doctest | |
3390 | def _pylab_magic_run(self, parameter_s=''): |
|
3391 | def _pylab_magic_run(self, parameter_s=''): | |
3391 | Magic.magic_run(self, parameter_s, |
|
3392 | Magic.magic_run(self, parameter_s, | |
3392 | runner=mpl_runner(self.shell.safe_execfile)) |
|
3393 | runner=mpl_runner(self.shell.safe_execfile)) | |
3393 |
|
3394 | |||
3394 | _pylab_magic_run.__doc__ = magic_run.__doc__ |
|
3395 | _pylab_magic_run.__doc__ = magic_run.__doc__ | |
3395 |
|
3396 | |||
3396 | @skip_doctest |
|
3397 | @skip_doctest | |
3397 | def magic_pylab(self, s): |
|
3398 | def magic_pylab(self, s): | |
3398 | """Load numpy and matplotlib to work interactively. |
|
3399 | """Load numpy and matplotlib to work interactively. | |
3399 |
|
3400 | |||
3400 | %pylab [GUINAME] |
|
3401 | %pylab [GUINAME] | |
3401 |
|
3402 | |||
3402 | This function lets you activate pylab (matplotlib, numpy and |
|
3403 | This function lets you activate pylab (matplotlib, numpy and | |
3403 | interactive support) at any point during an IPython session. |
|
3404 | interactive support) at any point during an IPython session. | |
3404 |
|
3405 | |||
3405 | It will import at the top level numpy as np, pyplot as plt, matplotlib, |
|
3406 | It will import at the top level numpy as np, pyplot as plt, matplotlib, | |
3406 | pylab and mlab, as well as all names from numpy and pylab. |
|
3407 | pylab and mlab, as well as all names from numpy and pylab. | |
3407 |
|
3408 | |||
3408 | If you are using the inline matplotlib backend for embedded figures, |
|
3409 | If you are using the inline matplotlib backend for embedded figures, | |
3409 | you can adjust its behavior via the %config magic:: |
|
3410 | you can adjust its behavior via the %config magic:: | |
3410 |
|
3411 | |||
3411 | # enable SVG figures, necessary for SVG+XHTML export in the qtconsole |
|
3412 | # enable SVG figures, necessary for SVG+XHTML export in the qtconsole | |
3412 | In [1]: %config InlineBackend.figure_format = 'svg' |
|
3413 | In [1]: %config InlineBackend.figure_format = 'svg' | |
3413 |
|
3414 | |||
3414 | # change the behavior of closing all figures at the end of each |
|
3415 | # change the behavior of closing all figures at the end of each | |
3415 | # execution (cell), or allowing reuse of active figures across |
|
3416 | # execution (cell), or allowing reuse of active figures across | |
3416 | # cells: |
|
3417 | # cells: | |
3417 | In [2]: %config InlineBackend.close_figures = False |
|
3418 | In [2]: %config InlineBackend.close_figures = False | |
3418 |
|
3419 | |||
3419 | Parameters |
|
3420 | Parameters | |
3420 | ---------- |
|
3421 | ---------- | |
3421 | guiname : optional |
|
3422 | guiname : optional | |
3422 | One of the valid arguments to the %gui magic ('qt', 'wx', 'gtk', |
|
3423 | One of the valid arguments to the %gui magic ('qt', 'wx', 'gtk', | |
3423 | 'osx' or 'tk'). If given, the corresponding Matplotlib backend is |
|
3424 | 'osx' or 'tk'). If given, the corresponding Matplotlib backend is | |
3424 | used, otherwise matplotlib's default (which you can override in your |
|
3425 | used, otherwise matplotlib's default (which you can override in your | |
3425 | matplotlib config file) is used. |
|
3426 | matplotlib config file) is used. | |
3426 |
|
3427 | |||
3427 | Examples |
|
3428 | Examples | |
3428 | -------- |
|
3429 | -------- | |
3429 | In this case, where the MPL default is TkAgg:: |
|
3430 | In this case, where the MPL default is TkAgg:: | |
3430 |
|
3431 | |||
3431 | In [2]: %pylab |
|
3432 | In [2]: %pylab | |
3432 |
|
3433 | |||
3433 | Welcome to pylab, a matplotlib-based Python environment. |
|
3434 | Welcome to pylab, a matplotlib-based Python environment. | |
3434 | Backend in use: TkAgg |
|
3435 | Backend in use: TkAgg | |
3435 | For more information, type 'help(pylab)'. |
|
3436 | For more information, type 'help(pylab)'. | |
3436 |
|
3437 | |||
3437 | But you can explicitly request a different backend:: |
|
3438 | But you can explicitly request a different backend:: | |
3438 |
|
3439 | |||
3439 | In [3]: %pylab qt |
|
3440 | In [3]: %pylab qt | |
3440 |
|
3441 | |||
3441 | Welcome to pylab, a matplotlib-based Python environment. |
|
3442 | Welcome to pylab, a matplotlib-based Python environment. | |
3442 | Backend in use: Qt4Agg |
|
3443 | Backend in use: Qt4Agg | |
3443 | For more information, type 'help(pylab)'. |
|
3444 | For more information, type 'help(pylab)'. | |
3444 | """ |
|
3445 | """ | |
3445 |
|
3446 | |||
3446 | if Application.initialized(): |
|
3447 | if Application.initialized(): | |
3447 | app = Application.instance() |
|
3448 | app = Application.instance() | |
3448 | try: |
|
3449 | try: | |
3449 | import_all_status = app.pylab_import_all |
|
3450 | import_all_status = app.pylab_import_all | |
3450 | except AttributeError: |
|
3451 | except AttributeError: | |
3451 | import_all_status = True |
|
3452 | import_all_status = True | |
3452 | else: |
|
3453 | else: | |
3453 | import_all_status = True |
|
3454 | import_all_status = True | |
3454 |
|
3455 | |||
3455 | self.shell.enable_pylab(s, import_all=import_all_status) |
|
3456 | self.shell.enable_pylab(s, import_all=import_all_status) | |
3456 |
|
3457 | |||
3457 | def magic_tb(self, s): |
|
3458 | def magic_tb(self, s): | |
3458 | """Print the last traceback with the currently active exception mode. |
|
3459 | """Print the last traceback with the currently active exception mode. | |
3459 |
|
3460 | |||
3460 | See %xmode for changing exception reporting modes.""" |
|
3461 | See %xmode for changing exception reporting modes.""" | |
3461 | self.shell.showtraceback() |
|
3462 | self.shell.showtraceback() | |
3462 |
|
3463 | |||
3463 | @skip_doctest |
|
3464 | @skip_doctest | |
3464 | def magic_precision(self, s=''): |
|
3465 | def magic_precision(self, s=''): | |
3465 | """Set floating point precision for pretty printing. |
|
3466 | """Set floating point precision for pretty printing. | |
3466 |
|
3467 | |||
3467 | Can set either integer precision or a format string. |
|
3468 | Can set either integer precision or a format string. | |
3468 |
|
3469 | |||
3469 | If numpy has been imported and precision is an int, |
|
3470 | If numpy has been imported and precision is an int, | |
3470 | numpy display precision will also be set, via ``numpy.set_printoptions``. |
|
3471 | numpy display precision will also be set, via ``numpy.set_printoptions``. | |
3471 |
|
3472 | |||
3472 | If no argument is given, defaults will be restored. |
|
3473 | If no argument is given, defaults will be restored. | |
3473 |
|
3474 | |||
3474 | Examples |
|
3475 | Examples | |
3475 | -------- |
|
3476 | -------- | |
3476 | :: |
|
3477 | :: | |
3477 |
|
3478 | |||
3478 | In [1]: from math import pi |
|
3479 | In [1]: from math import pi | |
3479 |
|
3480 | |||
3480 | In [2]: %precision 3 |
|
3481 | In [2]: %precision 3 | |
3481 | Out[2]: u'%.3f' |
|
3482 | Out[2]: u'%.3f' | |
3482 |
|
3483 | |||
3483 | In [3]: pi |
|
3484 | In [3]: pi | |
3484 | Out[3]: 3.142 |
|
3485 | Out[3]: 3.142 | |
3485 |
|
3486 | |||
3486 | In [4]: %precision %i |
|
3487 | In [4]: %precision %i | |
3487 | Out[4]: u'%i' |
|
3488 | Out[4]: u'%i' | |
3488 |
|
3489 | |||
3489 | In [5]: pi |
|
3490 | In [5]: pi | |
3490 | Out[5]: 3 |
|
3491 | Out[5]: 3 | |
3491 |
|
3492 | |||
3492 | In [6]: %precision %e |
|
3493 | In [6]: %precision %e | |
3493 | Out[6]: u'%e' |
|
3494 | Out[6]: u'%e' | |
3494 |
|
3495 | |||
3495 | In [7]: pi**10 |
|
3496 | In [7]: pi**10 | |
3496 | Out[7]: 9.364805e+04 |
|
3497 | Out[7]: 9.364805e+04 | |
3497 |
|
3498 | |||
3498 | In [8]: %precision |
|
3499 | In [8]: %precision | |
3499 | Out[8]: u'%r' |
|
3500 | Out[8]: u'%r' | |
3500 |
|
3501 | |||
3501 | In [9]: pi**10 |
|
3502 | In [9]: pi**10 | |
3502 | Out[9]: 93648.047476082982 |
|
3503 | Out[9]: 93648.047476082982 | |
3503 |
|
3504 | |||
3504 | """ |
|
3505 | """ | |
3505 |
|
3506 | |||
3506 | ptformatter = self.shell.display_formatter.formatters['text/plain'] |
|
3507 | ptformatter = self.shell.display_formatter.formatters['text/plain'] | |
3507 | ptformatter.float_precision = s |
|
3508 | ptformatter.float_precision = s | |
3508 | return ptformatter.float_format |
|
3509 | return ptformatter.float_format | |
3509 |
|
3510 | |||
3510 |
|
3511 | |||
3511 | @magic_arguments.magic_arguments() |
|
3512 | @magic_arguments.magic_arguments() | |
3512 | @magic_arguments.argument( |
|
3513 | @magic_arguments.argument( | |
3513 | '-e', '--export', action='store_true', default=False, |
|
3514 | '-e', '--export', action='store_true', default=False, | |
3514 | help='Export IPython history as a notebook. The filename argument ' |
|
3515 | help='Export IPython history as a notebook. The filename argument ' | |
3515 | 'is used to specify the notebook name and format. For example ' |
|
3516 | 'is used to specify the notebook name and format. For example ' | |
3516 | 'a filename of notebook.ipynb will result in a notebook name ' |
|
3517 | 'a filename of notebook.ipynb will result in a notebook name ' | |
3517 | 'of "notebook" and a format of "xml". Likewise using a ".json" ' |
|
3518 | 'of "notebook" and a format of "xml". Likewise using a ".json" ' | |
3518 | 'or ".py" file extension will write the notebook in the json ' |
|
3519 | 'or ".py" file extension will write the notebook in the json ' | |
3519 | 'or py formats.' |
|
3520 | 'or py formats.' | |
3520 | ) |
|
3521 | ) | |
3521 | @magic_arguments.argument( |
|
3522 | @magic_arguments.argument( | |
3522 | '-f', '--format', |
|
3523 | '-f', '--format', | |
3523 | help='Convert an existing IPython notebook to a new format. This option ' |
|
3524 | help='Convert an existing IPython notebook to a new format. This option ' | |
3524 | 'specifies the new format and can have the values: xml, json, py. ' |
|
3525 | 'specifies the new format and can have the values: xml, json, py. ' | |
3525 | 'The target filename is choosen automatically based on the new ' |
|
3526 | 'The target filename is choosen automatically based on the new ' | |
3526 | 'format. The filename argument gives the name of the source file.' |
|
3527 | 'format. The filename argument gives the name of the source file.' | |
3527 | ) |
|
3528 | ) | |
3528 | @magic_arguments.argument( |
|
3529 | @magic_arguments.argument( | |
3529 | 'filename', type=unicode, |
|
3530 | 'filename', type=unicode, | |
3530 | help='Notebook name or filename' |
|
3531 | help='Notebook name or filename' | |
3531 | ) |
|
3532 | ) | |
3532 | def magic_notebook(self, s): |
|
3533 | def magic_notebook(self, s): | |
3533 | """Export and convert IPython notebooks. |
|
3534 | """Export and convert IPython notebooks. | |
3534 |
|
3535 | |||
3535 | This function can export the current IPython history to a notebook file |
|
3536 | This function can export the current IPython history to a notebook file | |
3536 | or can convert an existing notebook file into a different format. For |
|
3537 | or can convert an existing notebook file into a different format. For | |
3537 | example, to export the history to "foo.ipynb" do "%notebook -e foo.ipynb". |
|
3538 | example, to export the history to "foo.ipynb" do "%notebook -e foo.ipynb". | |
3538 | To export the history to "foo.py" do "%notebook -e foo.py". To convert |
|
3539 | To export the history to "foo.py" do "%notebook -e foo.py". To convert | |
3539 | "foo.ipynb" to "foo.json" do "%notebook -f json foo.ipynb". Possible |
|
3540 | "foo.ipynb" to "foo.json" do "%notebook -f json foo.ipynb". Possible | |
3540 | formats include (json/ipynb, py). |
|
3541 | formats include (json/ipynb, py). | |
3541 | """ |
|
3542 | """ | |
3542 | args = magic_arguments.parse_argstring(self.magic_notebook, s) |
|
3543 | args = magic_arguments.parse_argstring(self.magic_notebook, s) | |
3543 |
|
3544 | |||
3544 | from IPython.nbformat import current |
|
3545 | from IPython.nbformat import current | |
3545 | args.filename = unquote_filename(args.filename) |
|
3546 | args.filename = unquote_filename(args.filename) | |
3546 | if args.export: |
|
3547 | if args.export: | |
3547 | fname, name, format = current.parse_filename(args.filename) |
|
3548 | fname, name, format = current.parse_filename(args.filename) | |
3548 | cells = [] |
|
3549 | cells = [] | |
3549 | hist = list(self.history_manager.get_range()) |
|
3550 | hist = list(self.history_manager.get_range()) | |
3550 | for session, prompt_number, input in hist[:-1]: |
|
3551 | for session, prompt_number, input in hist[:-1]: | |
3551 | cells.append(current.new_code_cell(prompt_number=prompt_number, input=input)) |
|
3552 | cells.append(current.new_code_cell(prompt_number=prompt_number, input=input)) | |
3552 | worksheet = current.new_worksheet(cells=cells) |
|
3553 | worksheet = current.new_worksheet(cells=cells) | |
3553 | nb = current.new_notebook(name=name,worksheets=[worksheet]) |
|
3554 | nb = current.new_notebook(name=name,worksheets=[worksheet]) | |
3554 | with open(fname, 'w') as f: |
|
3555 | with open(fname, 'w') as f: | |
3555 | current.write(nb, f, format); |
|
3556 | current.write(nb, f, format); | |
3556 | elif args.format is not None: |
|
3557 | elif args.format is not None: | |
3557 | old_fname, old_name, old_format = current.parse_filename(args.filename) |
|
3558 | old_fname, old_name, old_format = current.parse_filename(args.filename) | |
3558 | new_format = args.format |
|
3559 | new_format = args.format | |
3559 | if new_format == u'xml': |
|
3560 | if new_format == u'xml': | |
3560 | raise ValueError('Notebooks cannot be written as xml.') |
|
3561 | raise ValueError('Notebooks cannot be written as xml.') | |
3561 | elif new_format == u'ipynb' or new_format == u'json': |
|
3562 | elif new_format == u'ipynb' or new_format == u'json': | |
3562 | new_fname = old_name + u'.ipynb' |
|
3563 | new_fname = old_name + u'.ipynb' | |
3563 | new_format = u'json' |
|
3564 | new_format = u'json' | |
3564 | elif new_format == u'py': |
|
3565 | elif new_format == u'py': | |
3565 | new_fname = old_name + u'.py' |
|
3566 | new_fname = old_name + u'.py' | |
3566 | else: |
|
3567 | else: | |
3567 | raise ValueError('Invalid notebook format: %s' % new_format) |
|
3568 | raise ValueError('Invalid notebook format: %s' % new_format) | |
3568 | with open(old_fname, 'r') as f: |
|
3569 | with open(old_fname, 'r') as f: | |
3569 | s = f.read() |
|
3570 | s = f.read() | |
3570 | try: |
|
3571 | try: | |
3571 | nb = current.reads(s, old_format) |
|
3572 | nb = current.reads(s, old_format) | |
3572 | except: |
|
3573 | except: | |
3573 | nb = current.reads(s, u'xml') |
|
3574 | nb = current.reads(s, u'xml') | |
3574 | with open(new_fname, 'w') as f: |
|
3575 | with open(new_fname, 'w') as f: | |
3575 | current.write(nb, f, new_format) |
|
3576 | current.write(nb, f, new_format) | |
3576 |
|
3577 | |||
3577 | def magic_config(self, s): |
|
3578 | def magic_config(self, s): | |
3578 | """configure IPython |
|
3579 | """configure IPython | |
3579 |
|
3580 | |||
3580 | %config Class[.trait=value] |
|
3581 | %config Class[.trait=value] | |
3581 |
|
3582 | |||
3582 | This magic exposes most of the IPython config system. Any |
|
3583 | This magic exposes most of the IPython config system. Any | |
3583 | Configurable class should be able to be configured with the simple |
|
3584 | Configurable class should be able to be configured with the simple | |
3584 | line:: |
|
3585 | line:: | |
3585 |
|
3586 | |||
3586 | %config Class.trait=value |
|
3587 | %config Class.trait=value | |
3587 |
|
3588 | |||
3588 | Where `value` will be resolved in the user's namespace, if it is an |
|
3589 | Where `value` will be resolved in the user's namespace, if it is an | |
3589 | expression or variable name. |
|
3590 | expression or variable name. | |
3590 |
|
3591 | |||
3591 | Examples |
|
3592 | Examples | |
3592 | -------- |
|
3593 | -------- | |
3593 |
|
3594 | |||
3594 | To see what classes are availabe for config, pass no arguments:: |
|
3595 | To see what classes are availabe for config, pass no arguments:: | |
3595 |
|
3596 | |||
3596 | In [1]: %config |
|
3597 | In [1]: %config | |
3597 | Available objects for config: |
|
3598 | Available objects for config: | |
3598 | TerminalInteractiveShell |
|
3599 | TerminalInteractiveShell | |
3599 | HistoryManager |
|
3600 | HistoryManager | |
3600 | PrefilterManager |
|
3601 | PrefilterManager | |
3601 | AliasManager |
|
3602 | AliasManager | |
3602 | IPCompleter |
|
3603 | IPCompleter | |
3603 | PromptManager |
|
3604 | PromptManager | |
3604 | DisplayFormatter |
|
3605 | DisplayFormatter | |
3605 |
|
3606 | |||
3606 | To view what is configurable on a given class, just pass the class name:: |
|
3607 | To view what is configurable on a given class, just pass the class name:: | |
3607 |
|
3608 | |||
3608 | In [2]: %config IPCompleter |
|
3609 | In [2]: %config IPCompleter | |
3609 | IPCompleter options |
|
3610 | IPCompleter options | |
3610 | ----------------- |
|
3611 | ----------------- | |
3611 | IPCompleter.omit__names=<Enum> |
|
3612 | IPCompleter.omit__names=<Enum> | |
3612 | Current: 2 |
|
3613 | Current: 2 | |
3613 | Choices: (0, 1, 2) |
|
3614 | Choices: (0, 1, 2) | |
3614 | Instruct the completer to omit private method names |
|
3615 | Instruct the completer to omit private method names | |
3615 | Specifically, when completing on ``object.<tab>``. |
|
3616 | Specifically, when completing on ``object.<tab>``. | |
3616 | When 2 [default]: all names that start with '_' will be excluded. |
|
3617 | When 2 [default]: all names that start with '_' will be excluded. | |
3617 | When 1: all 'magic' names (``__foo__``) will be excluded. |
|
3618 | When 1: all 'magic' names (``__foo__``) will be excluded. | |
3618 | When 0: nothing will be excluded. |
|
3619 | When 0: nothing will be excluded. | |
3619 | IPCompleter.merge_completions=<CBool> |
|
3620 | IPCompleter.merge_completions=<CBool> | |
3620 | Current: True |
|
3621 | Current: True | |
3621 | Whether to merge completion results into a single list |
|
3622 | Whether to merge completion results into a single list | |
3622 | If False, only the completion results from the first non-empty completer |
|
3623 | If False, only the completion results from the first non-empty completer | |
3623 | will be returned. |
|
3624 | will be returned. | |
3624 | IPCompleter.greedy=<CBool> |
|
3625 | IPCompleter.greedy=<CBool> | |
3625 | Current: False |
|
3626 | Current: False | |
3626 | Activate greedy completion |
|
3627 | Activate greedy completion | |
3627 | This will enable completion on elements of lists, results of function calls, |
|
3628 | This will enable completion on elements of lists, results of function calls, | |
3628 | etc., but can be unsafe because the code is actually evaluated on TAB. |
|
3629 | etc., but can be unsafe because the code is actually evaluated on TAB. | |
3629 |
|
3630 | |||
3630 | but the real use is in setting values:: |
|
3631 | but the real use is in setting values:: | |
3631 |
|
3632 | |||
3632 | In [3]: %config IPCompleter.greedy = True |
|
3633 | In [3]: %config IPCompleter.greedy = True | |
3633 |
|
3634 | |||
3634 | and these values are read from the user_ns if they are variables:: |
|
3635 | and these values are read from the user_ns if they are variables:: | |
3635 |
|
3636 | |||
3636 | In [4]: feeling_greedy=False |
|
3637 | In [4]: feeling_greedy=False | |
3637 |
|
3638 | |||
3638 | In [5]: %config IPCompleter.greedy = feeling_greedy |
|
3639 | In [5]: %config IPCompleter.greedy = feeling_greedy | |
3639 |
|
3640 | |||
3640 | """ |
|
3641 | """ | |
3641 | from IPython.config.loader import Config |
|
3642 | from IPython.config.loader import Config | |
3642 | # some IPython objects are Configurable, but do not yet have |
|
3643 | # some IPython objects are Configurable, but do not yet have | |
3643 | # any configurable traits. Exclude them from the effects of |
|
3644 | # any configurable traits. Exclude them from the effects of | |
3644 | # this magic, as their presence is just noise: |
|
3645 | # this magic, as their presence is just noise: | |
3645 | configurables = [ c for c in self.configurables if c.__class__.class_traits(config=True) ] |
|
3646 | configurables = [ c for c in self.configurables if c.__class__.class_traits(config=True) ] | |
3646 | classnames = [ c.__class__.__name__ for c in configurables ] |
|
3647 | classnames = [ c.__class__.__name__ for c in configurables ] | |
3647 |
|
3648 | |||
3648 | line = s.strip() |
|
3649 | line = s.strip() | |
3649 | if not line: |
|
3650 | if not line: | |
3650 | # print available configurable names |
|
3651 | # print available configurable names | |
3651 | print "Available objects for config:" |
|
3652 | print "Available objects for config:" | |
3652 | for name in classnames: |
|
3653 | for name in classnames: | |
3653 | print " ", name |
|
3654 | print " ", name | |
3654 | return |
|
3655 | return | |
3655 | elif line in classnames: |
|
3656 | elif line in classnames: | |
3656 | # `%config TerminalInteractiveShell` will print trait info for |
|
3657 | # `%config TerminalInteractiveShell` will print trait info for | |
3657 | # TerminalInteractiveShell |
|
3658 | # TerminalInteractiveShell | |
3658 | c = configurables[classnames.index(line)] |
|
3659 | c = configurables[classnames.index(line)] | |
3659 | cls = c.__class__ |
|
3660 | cls = c.__class__ | |
3660 | help = cls.class_get_help(c) |
|
3661 | help = cls.class_get_help(c) | |
3661 | # strip leading '--' from cl-args: |
|
3662 | # strip leading '--' from cl-args: | |
3662 | help = re.sub(re.compile(r'^--', re.MULTILINE), '', help) |
|
3663 | help = re.sub(re.compile(r'^--', re.MULTILINE), '', help) | |
3663 | print help |
|
3664 | print help | |
3664 | return |
|
3665 | return | |
3665 | elif '=' not in line: |
|
3666 | elif '=' not in line: | |
3666 | raise UsageError("Invalid config statement: %r, should be Class.trait = value" % line) |
|
3667 | raise UsageError("Invalid config statement: %r, should be Class.trait = value" % line) | |
3667 |
|
3668 | |||
3668 |
|
3669 | |||
3669 | # otherwise, assume we are setting configurables. |
|
3670 | # otherwise, assume we are setting configurables. | |
3670 | # leave quotes on args when splitting, because we want |
|
3671 | # leave quotes on args when splitting, because we want | |
3671 | # unquoted args to eval in user_ns |
|
3672 | # unquoted args to eval in user_ns | |
3672 | cfg = Config() |
|
3673 | cfg = Config() | |
3673 | exec "cfg."+line in locals(), self.user_ns |
|
3674 | exec "cfg."+line in locals(), self.user_ns | |
3674 |
|
3675 | |||
3675 | for configurable in configurables: |
|
3676 | for configurable in configurables: | |
3676 | try: |
|
3677 | try: | |
3677 | configurable.update_config(cfg) |
|
3678 | configurable.update_config(cfg) | |
3678 | except Exception as e: |
|
3679 | except Exception as e: | |
3679 | error(e) |
|
3680 | error(e) | |
3680 |
|
3681 | |||
3681 | # end Magic |
|
3682 | # end Magic |
@@ -1,346 +1,355 b'' | |||||
1 | """Tests for various magic functions. |
|
1 | """Tests for various magic functions. | |
2 |
|
2 | |||
3 | Needs to be run by nose (to make ipython session available). |
|
3 | Needs to be run by nose (to make ipython session available). | |
4 | """ |
|
4 | """ | |
5 | from __future__ import absolute_import |
|
5 | from __future__ import absolute_import | |
6 |
|
6 | |||
7 | #----------------------------------------------------------------------------- |
|
7 | #----------------------------------------------------------------------------- | |
8 | # Imports |
|
8 | # Imports | |
9 | #----------------------------------------------------------------------------- |
|
9 | #----------------------------------------------------------------------------- | |
10 |
|
10 | |||
11 | import os |
|
11 | import os | |
12 |
|
12 | |||
13 | import nose.tools as nt |
|
13 | import nose.tools as nt | |
14 |
|
14 | |||
15 | from IPython.testing import decorators as dec |
|
15 | from IPython.testing import decorators as dec | |
16 | from IPython.testing import tools as tt |
|
16 | from IPython.testing import tools as tt | |
17 | from IPython.utils import py3compat |
|
17 | from IPython.utils import py3compat | |
18 |
|
18 | |||
19 | #----------------------------------------------------------------------------- |
|
19 | #----------------------------------------------------------------------------- | |
20 | # Test functions begin |
|
20 | # Test functions begin | |
21 | #----------------------------------------------------------------------------- |
|
21 | #----------------------------------------------------------------------------- | |
22 |
|
22 | |||
23 | def test_rehashx(): |
|
23 | def test_rehashx(): | |
24 | # clear up everything |
|
24 | # clear up everything | |
25 | _ip = get_ipython() |
|
25 | _ip = get_ipython() | |
26 | _ip.alias_manager.alias_table.clear() |
|
26 | _ip.alias_manager.alias_table.clear() | |
27 | del _ip.db['syscmdlist'] |
|
27 | del _ip.db['syscmdlist'] | |
28 |
|
28 | |||
29 | _ip.magic('rehashx') |
|
29 | _ip.magic('rehashx') | |
30 | # Practically ALL ipython development systems will have more than 10 aliases |
|
30 | # Practically ALL ipython development systems will have more than 10 aliases | |
31 |
|
31 | |||
32 | yield (nt.assert_true, len(_ip.alias_manager.alias_table) > 10) |
|
32 | yield (nt.assert_true, len(_ip.alias_manager.alias_table) > 10) | |
33 | for key, val in _ip.alias_manager.alias_table.iteritems(): |
|
33 | for key, val in _ip.alias_manager.alias_table.iteritems(): | |
34 | # we must strip dots from alias names |
|
34 | # we must strip dots from alias names | |
35 | nt.assert_true('.' not in key) |
|
35 | nt.assert_true('.' not in key) | |
36 |
|
36 | |||
37 | # rehashx must fill up syscmdlist |
|
37 | # rehashx must fill up syscmdlist | |
38 | scoms = _ip.db['syscmdlist'] |
|
38 | scoms = _ip.db['syscmdlist'] | |
39 | yield (nt.assert_true, len(scoms) > 10) |
|
39 | yield (nt.assert_true, len(scoms) > 10) | |
40 |
|
40 | |||
41 |
|
41 | |||
42 | def test_magic_parse_options(): |
|
42 | def test_magic_parse_options(): | |
43 | """Test that we don't mangle paths when parsing magic options.""" |
|
43 | """Test that we don't mangle paths when parsing magic options.""" | |
44 | ip = get_ipython() |
|
44 | ip = get_ipython() | |
45 | path = 'c:\\x' |
|
45 | path = 'c:\\x' | |
46 | opts = ip.parse_options('-f %s' % path,'f:')[0] |
|
46 | opts = ip.parse_options('-f %s' % path,'f:')[0] | |
47 | # argv splitting is os-dependent |
|
47 | # argv splitting is os-dependent | |
48 | if os.name == 'posix': |
|
48 | if os.name == 'posix': | |
49 | expected = 'c:x' |
|
49 | expected = 'c:x' | |
50 | else: |
|
50 | else: | |
51 | expected = path |
|
51 | expected = path | |
52 | nt.assert_equals(opts['f'], expected) |
|
52 | nt.assert_equals(opts['f'], expected) | |
53 |
|
53 | |||
54 |
|
54 | |||
55 | @dec.skip_without('sqlite3') |
|
55 | @dec.skip_without('sqlite3') | |
56 | def doctest_hist_f(): |
|
56 | def doctest_hist_f(): | |
57 | """Test %hist -f with temporary filename. |
|
57 | """Test %hist -f with temporary filename. | |
58 |
|
58 | |||
59 | In [9]: import tempfile |
|
59 | In [9]: import tempfile | |
60 |
|
60 | |||
61 | In [10]: tfile = tempfile.mktemp('.py','tmp-ipython-') |
|
61 | In [10]: tfile = tempfile.mktemp('.py','tmp-ipython-') | |
62 |
|
62 | |||
63 | In [11]: %hist -nl -f $tfile 3 |
|
63 | In [11]: %hist -nl -f $tfile 3 | |
64 |
|
64 | |||
65 | In [13]: import os; os.unlink(tfile) |
|
65 | In [13]: import os; os.unlink(tfile) | |
66 | """ |
|
66 | """ | |
67 |
|
67 | |||
68 |
|
68 | |||
69 | @dec.skip_without('sqlite3') |
|
69 | @dec.skip_without('sqlite3') | |
70 | def doctest_hist_r(): |
|
70 | def doctest_hist_r(): | |
71 | """Test %hist -r |
|
71 | """Test %hist -r | |
72 |
|
72 | |||
73 | XXX - This test is not recording the output correctly. For some reason, in |
|
73 | XXX - This test is not recording the output correctly. For some reason, in | |
74 | testing mode the raw history isn't getting populated. No idea why. |
|
74 | testing mode the raw history isn't getting populated. No idea why. | |
75 | Disabling the output checking for now, though at least we do run it. |
|
75 | Disabling the output checking for now, though at least we do run it. | |
76 |
|
76 | |||
77 | In [1]: 'hist' in _ip.lsmagic() |
|
77 | In [1]: 'hist' in _ip.lsmagic() | |
78 | Out[1]: True |
|
78 | Out[1]: True | |
79 |
|
79 | |||
80 | In [2]: x=1 |
|
80 | In [2]: x=1 | |
81 |
|
81 | |||
82 | In [3]: %hist -rl 2 |
|
82 | In [3]: %hist -rl 2 | |
83 | x=1 # random |
|
83 | x=1 # random | |
84 | %hist -r 2 |
|
84 | %hist -r 2 | |
85 | """ |
|
85 | """ | |
86 |
|
86 | |||
87 |
|
87 | |||
88 | @dec.skip_without('sqlite3') |
|
88 | @dec.skip_without('sqlite3') | |
89 | def doctest_hist_op(): |
|
89 | def doctest_hist_op(): | |
90 | """Test %hist -op |
|
90 | """Test %hist -op | |
91 |
|
91 | |||
92 | In [1]: class b(float): |
|
92 | In [1]: class b(float): | |
93 | ...: pass |
|
93 | ...: pass | |
94 | ...: |
|
94 | ...: | |
95 |
|
95 | |||
96 | In [2]: class s(object): |
|
96 | In [2]: class s(object): | |
97 | ...: def __str__(self): |
|
97 | ...: def __str__(self): | |
98 | ...: return 's' |
|
98 | ...: return 's' | |
99 | ...: |
|
99 | ...: | |
100 |
|
100 | |||
101 | In [3]: |
|
101 | In [3]: | |
102 |
|
102 | |||
103 | In [4]: class r(b): |
|
103 | In [4]: class r(b): | |
104 | ...: def __repr__(self): |
|
104 | ...: def __repr__(self): | |
105 | ...: return 'r' |
|
105 | ...: return 'r' | |
106 | ...: |
|
106 | ...: | |
107 |
|
107 | |||
108 | In [5]: class sr(s,r): pass |
|
108 | In [5]: class sr(s,r): pass | |
109 | ...: |
|
109 | ...: | |
110 |
|
110 | |||
111 | In [6]: |
|
111 | In [6]: | |
112 |
|
112 | |||
113 | In [7]: bb=b() |
|
113 | In [7]: bb=b() | |
114 |
|
114 | |||
115 | In [8]: ss=s() |
|
115 | In [8]: ss=s() | |
116 |
|
116 | |||
117 | In [9]: rr=r() |
|
117 | In [9]: rr=r() | |
118 |
|
118 | |||
119 | In [10]: ssrr=sr() |
|
119 | In [10]: ssrr=sr() | |
120 |
|
120 | |||
121 | In [11]: 4.5 |
|
121 | In [11]: 4.5 | |
122 | Out[11]: 4.5 |
|
122 | Out[11]: 4.5 | |
123 |
|
123 | |||
124 | In [12]: str(ss) |
|
124 | In [12]: str(ss) | |
125 | Out[12]: 's' |
|
125 | Out[12]: 's' | |
126 |
|
126 | |||
127 | In [13]: |
|
127 | In [13]: | |
128 |
|
128 | |||
129 | In [14]: %hist -op |
|
129 | In [14]: %hist -op | |
130 | >>> class b: |
|
130 | >>> class b: | |
131 | ... pass |
|
131 | ... pass | |
132 | ... |
|
132 | ... | |
133 | >>> class s(b): |
|
133 | >>> class s(b): | |
134 | ... def __str__(self): |
|
134 | ... def __str__(self): | |
135 | ... return 's' |
|
135 | ... return 's' | |
136 | ... |
|
136 | ... | |
137 | >>> |
|
137 | >>> | |
138 | >>> class r(b): |
|
138 | >>> class r(b): | |
139 | ... def __repr__(self): |
|
139 | ... def __repr__(self): | |
140 | ... return 'r' |
|
140 | ... return 'r' | |
141 | ... |
|
141 | ... | |
142 | >>> class sr(s,r): pass |
|
142 | >>> class sr(s,r): pass | |
143 | >>> |
|
143 | >>> | |
144 | >>> bb=b() |
|
144 | >>> bb=b() | |
145 | >>> ss=s() |
|
145 | >>> ss=s() | |
146 | >>> rr=r() |
|
146 | >>> rr=r() | |
147 | >>> ssrr=sr() |
|
147 | >>> ssrr=sr() | |
148 | >>> 4.5 |
|
148 | >>> 4.5 | |
149 | 4.5 |
|
149 | 4.5 | |
150 | >>> str(ss) |
|
150 | >>> str(ss) | |
151 | 's' |
|
151 | 's' | |
152 | >>> |
|
152 | >>> | |
153 | """ |
|
153 | """ | |
154 |
|
154 | |||
155 |
|
155 | |||
156 | @dec.skip_without('sqlite3') |
|
156 | @dec.skip_without('sqlite3') | |
157 | def test_macro(): |
|
157 | def test_macro(): | |
158 | ip = get_ipython() |
|
158 | ip = get_ipython() | |
159 | ip.history_manager.reset() # Clear any existing history. |
|
159 | ip.history_manager.reset() # Clear any existing history. | |
160 | cmds = ["a=1", "def b():\n return a**2", "print(a,b())"] |
|
160 | cmds = ["a=1", "def b():\n return a**2", "print(a,b())"] | |
161 | for i, cmd in enumerate(cmds, start=1): |
|
161 | for i, cmd in enumerate(cmds, start=1): | |
162 | ip.history_manager.store_inputs(i, cmd) |
|
162 | ip.history_manager.store_inputs(i, cmd) | |
163 | ip.magic("macro test 1-3") |
|
163 | ip.magic("macro test 1-3") | |
164 | nt.assert_equal(ip.user_ns["test"].value, "\n".join(cmds)+"\n") |
|
164 | nt.assert_equal(ip.user_ns["test"].value, "\n".join(cmds)+"\n") | |
165 |
|
165 | |||
166 | # List macros. |
|
166 | # List macros. | |
167 | assert "test" in ip.magic("macro") |
|
167 | assert "test" in ip.magic("macro") | |
168 |
|
168 | |||
169 |
|
169 | |||
170 | @dec.skip_without('sqlite3') |
|
170 | @dec.skip_without('sqlite3') | |
171 | def test_macro_run(): |
|
171 | def test_macro_run(): | |
172 | """Test that we can run a multi-line macro successfully.""" |
|
172 | """Test that we can run a multi-line macro successfully.""" | |
173 | ip = get_ipython() |
|
173 | ip = get_ipython() | |
174 | ip.history_manager.reset() |
|
174 | ip.history_manager.reset() | |
175 | cmds = ["a=10", "a+=1", py3compat.doctest_refactor_print("print a"), |
|
175 | cmds = ["a=10", "a+=1", py3compat.doctest_refactor_print("print a"), | |
176 | "%macro test 2-3"] |
|
176 | "%macro test 2-3"] | |
177 | for cmd in cmds: |
|
177 | for cmd in cmds: | |
178 | ip.run_cell(cmd, store_history=True) |
|
178 | ip.run_cell(cmd, store_history=True) | |
179 | nt.assert_equal(ip.user_ns["test"].value, |
|
179 | nt.assert_equal(ip.user_ns["test"].value, | |
180 | py3compat.doctest_refactor_print("a+=1\nprint a\n")) |
|
180 | py3compat.doctest_refactor_print("a+=1\nprint a\n")) | |
181 | with tt.AssertPrints("12"): |
|
181 | with tt.AssertPrints("12"): | |
182 | ip.run_cell("test") |
|
182 | ip.run_cell("test") | |
183 | with tt.AssertPrints("13"): |
|
183 | with tt.AssertPrints("13"): | |
184 | ip.run_cell("test") |
|
184 | ip.run_cell("test") | |
185 |
|
185 | |||
186 |
|
186 | |||
187 | # XXX failing for now, until we get clearcmd out of quarantine. But we should |
|
187 | # XXX failing for now, until we get clearcmd out of quarantine. But we should | |
188 | # fix this and revert the skip to happen only if numpy is not around. |
|
188 | # fix this and revert the skip to happen only if numpy is not around. | |
189 | #@dec.skipif_not_numpy |
|
189 | #@dec.skipif_not_numpy | |
190 | @dec.skip_known_failure |
|
190 | @dec.skip_known_failure | |
191 | def test_numpy_clear_array_undec(): |
|
191 | def test_numpy_clear_array_undec(): | |
192 | from IPython.extensions import clearcmd |
|
192 | from IPython.extensions import clearcmd | |
193 |
|
193 | |||
194 | _ip.ex('import numpy as np') |
|
194 | _ip.ex('import numpy as np') | |
195 | _ip.ex('a = np.empty(2)') |
|
195 | _ip.ex('a = np.empty(2)') | |
196 | yield (nt.assert_true, 'a' in _ip.user_ns) |
|
196 | yield (nt.assert_true, 'a' in _ip.user_ns) | |
197 | _ip.magic('clear array') |
|
197 | _ip.magic('clear array') | |
198 | yield (nt.assert_false, 'a' in _ip.user_ns) |
|
198 | yield (nt.assert_false, 'a' in _ip.user_ns) | |
199 |
|
199 | |||
200 |
|
200 | |||
201 | def test_time(): |
|
201 | def test_time(): | |
202 | _ip.magic('time None') |
|
202 | _ip.magic('time None') | |
203 |
|
203 | |||
204 |
|
204 | |||
205 | @py3compat.doctest_refactor_print |
|
205 | @py3compat.doctest_refactor_print | |
206 | def doctest_time(): |
|
206 | def doctest_time(): | |
207 | """ |
|
207 | """ | |
208 | In [10]: %time None |
|
208 | In [10]: %time None | |
209 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
209 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s | |
210 | Wall time: 0.00 s |
|
210 | Wall time: 0.00 s | |
211 |
|
211 | |||
212 | In [11]: def f(kmjy): |
|
212 | In [11]: def f(kmjy): | |
213 | ....: %time print 2*kmjy |
|
213 | ....: %time print 2*kmjy | |
214 |
|
214 | |||
215 | In [12]: f(3) |
|
215 | In [12]: f(3) | |
216 | 6 |
|
216 | 6 | |
217 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
217 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s | |
218 | Wall time: 0.00 s |
|
218 | Wall time: 0.00 s | |
219 | """ |
|
219 | """ | |
220 |
|
220 | |||
221 |
|
221 | |||
222 | def test_doctest_mode(): |
|
222 | def test_doctest_mode(): | |
223 | "Toggle doctest_mode twice, it should be a no-op and run without error" |
|
223 | "Toggle doctest_mode twice, it should be a no-op and run without error" | |
224 | _ip.magic('doctest_mode') |
|
224 | _ip.magic('doctest_mode') | |
225 | _ip.magic('doctest_mode') |
|
225 | _ip.magic('doctest_mode') | |
226 |
|
226 | |||
227 |
|
227 | |||
228 | def test_parse_options(): |
|
228 | def test_parse_options(): | |
229 | """Tests for basic options parsing in magics.""" |
|
229 | """Tests for basic options parsing in magics.""" | |
230 | # These are only the most minimal of tests, more should be added later. At |
|
230 | # These are only the most minimal of tests, more should be added later. At | |
231 | # the very least we check that basic text/unicode calls work OK. |
|
231 | # the very least we check that basic text/unicode calls work OK. | |
232 | nt.assert_equal(_ip.parse_options('foo', '')[1], 'foo') |
|
232 | nt.assert_equal(_ip.parse_options('foo', '')[1], 'foo') | |
233 | nt.assert_equal(_ip.parse_options(u'foo', '')[1], u'foo') |
|
233 | nt.assert_equal(_ip.parse_options(u'foo', '')[1], u'foo') | |
234 |
|
234 | |||
235 |
|
235 | |||
236 | def test_dirops(): |
|
236 | def test_dirops(): | |
237 | """Test various directory handling operations.""" |
|
237 | """Test various directory handling operations.""" | |
238 | # curpath = lambda :os.path.splitdrive(os.getcwdu())[1].replace('\\','/') |
|
238 | # curpath = lambda :os.path.splitdrive(os.getcwdu())[1].replace('\\','/') | |
239 | curpath = os.getcwdu |
|
239 | curpath = os.getcwdu | |
240 | startdir = os.getcwdu() |
|
240 | startdir = os.getcwdu() | |
241 | ipdir = _ip.ipython_dir |
|
241 | ipdir = _ip.ipython_dir | |
242 | try: |
|
242 | try: | |
243 | _ip.magic('cd "%s"' % ipdir) |
|
243 | _ip.magic('cd "%s"' % ipdir) | |
244 | nt.assert_equal(curpath(), ipdir) |
|
244 | nt.assert_equal(curpath(), ipdir) | |
245 | _ip.magic('cd -') |
|
245 | _ip.magic('cd -') | |
246 | nt.assert_equal(curpath(), startdir) |
|
246 | nt.assert_equal(curpath(), startdir) | |
247 | _ip.magic('pushd "%s"' % ipdir) |
|
247 | _ip.magic('pushd "%s"' % ipdir) | |
248 | nt.assert_equal(curpath(), ipdir) |
|
248 | nt.assert_equal(curpath(), ipdir) | |
249 | _ip.magic('popd') |
|
249 | _ip.magic('popd') | |
250 | nt.assert_equal(curpath(), startdir) |
|
250 | nt.assert_equal(curpath(), startdir) | |
251 | finally: |
|
251 | finally: | |
252 | os.chdir(startdir) |
|
252 | os.chdir(startdir) | |
253 |
|
253 | |||
254 |
|
254 | |||
255 | def test_xmode(): |
|
255 | def test_xmode(): | |
256 | # Calling xmode three times should be a no-op |
|
256 | # Calling xmode three times should be a no-op | |
257 | xmode = _ip.InteractiveTB.mode |
|
257 | xmode = _ip.InteractiveTB.mode | |
258 | for i in range(3): |
|
258 | for i in range(3): | |
259 | _ip.magic("xmode") |
|
259 | _ip.magic("xmode") | |
260 | nt.assert_equal(_ip.InteractiveTB.mode, xmode) |
|
260 | nt.assert_equal(_ip.InteractiveTB.mode, xmode) | |
261 |
|
261 | |||
262 | def test_reset_hard(): |
|
262 | def test_reset_hard(): | |
263 | monitor = [] |
|
263 | monitor = [] | |
264 | class A(object): |
|
264 | class A(object): | |
265 | def __del__(self): |
|
265 | def __del__(self): | |
266 | monitor.append(1) |
|
266 | monitor.append(1) | |
267 | def __repr__(self): |
|
267 | def __repr__(self): | |
268 | return "<A instance>" |
|
268 | return "<A instance>" | |
269 |
|
269 | |||
270 | _ip.user_ns["a"] = A() |
|
270 | _ip.user_ns["a"] = A() | |
271 | _ip.run_cell("a") |
|
271 | _ip.run_cell("a") | |
272 |
|
272 | |||
273 | nt.assert_equal(monitor, []) |
|
273 | nt.assert_equal(monitor, []) | |
274 | _ip.magic_reset("-f") |
|
274 | _ip.magic_reset("-f") | |
275 | nt.assert_equal(monitor, [1]) |
|
275 | nt.assert_equal(monitor, [1]) | |
276 |
|
276 | |||
277 | class TestXdel(tt.TempFileMixin): |
|
277 | class TestXdel(tt.TempFileMixin): | |
278 | def test_xdel(self): |
|
278 | def test_xdel(self): | |
279 | """Test that references from %run are cleared by xdel.""" |
|
279 | """Test that references from %run are cleared by xdel.""" | |
280 | src = ("class A(object):\n" |
|
280 | src = ("class A(object):\n" | |
281 | " monitor = []\n" |
|
281 | " monitor = []\n" | |
282 | " def __del__(self):\n" |
|
282 | " def __del__(self):\n" | |
283 | " self.monitor.append(1)\n" |
|
283 | " self.monitor.append(1)\n" | |
284 | "a = A()\n") |
|
284 | "a = A()\n") | |
285 | self.mktmp(src) |
|
285 | self.mktmp(src) | |
286 | # %run creates some hidden references... |
|
286 | # %run creates some hidden references... | |
287 | _ip.magic("run %s" % self.fname) |
|
287 | _ip.magic("run %s" % self.fname) | |
288 | # ... as does the displayhook. |
|
288 | # ... as does the displayhook. | |
289 | _ip.run_cell("a") |
|
289 | _ip.run_cell("a") | |
290 |
|
290 | |||
291 | monitor = _ip.user_ns["A"].monitor |
|
291 | monitor = _ip.user_ns["A"].monitor | |
292 | nt.assert_equal(monitor, []) |
|
292 | nt.assert_equal(monitor, []) | |
293 |
|
293 | |||
294 | _ip.magic("xdel a") |
|
294 | _ip.magic("xdel a") | |
295 |
|
295 | |||
296 | # Check that a's __del__ method has been called. |
|
296 | # Check that a's __del__ method has been called. | |
297 | nt.assert_equal(monitor, [1]) |
|
297 | nt.assert_equal(monitor, [1]) | |
298 |
|
298 | |||
299 | def doctest_who(): |
|
299 | def doctest_who(): | |
300 | """doctest for %who |
|
300 | """doctest for %who | |
301 |
|
301 | |||
302 | In [1]: %reset -f |
|
302 | In [1]: %reset -f | |
303 |
|
303 | |||
304 | In [2]: alpha = 123 |
|
304 | In [2]: alpha = 123 | |
305 |
|
305 | |||
306 | In [3]: beta = 'beta' |
|
306 | In [3]: beta = 'beta' | |
307 |
|
307 | |||
308 | In [4]: %who int |
|
308 | In [4]: %who int | |
309 | alpha |
|
309 | alpha | |
310 |
|
310 | |||
311 | In [5]: %who str |
|
311 | In [5]: %who str | |
312 | beta |
|
312 | beta | |
313 |
|
313 | |||
314 | In [6]: %whos |
|
314 | In [6]: %whos | |
315 | Variable Type Data/Info |
|
315 | Variable Type Data/Info | |
316 | ---------------------------- |
|
316 | ---------------------------- | |
317 | alpha int 123 |
|
317 | alpha int 123 | |
318 | beta str beta |
|
318 | beta str beta | |
319 |
|
319 | |||
320 | In [7]: %who_ls |
|
320 | In [7]: %who_ls | |
321 | Out[7]: ['alpha', 'beta'] |
|
321 | Out[7]: ['alpha', 'beta'] | |
322 | """ |
|
322 | """ | |
323 |
|
323 | |||
324 | @py3compat.u_format |
|
324 | @py3compat.u_format | |
325 | def doctest_precision(): |
|
325 | def doctest_precision(): | |
326 | """doctest for %precision |
|
326 | """doctest for %precision | |
327 |
|
327 | |||
328 | In [1]: f = get_ipython().shell.display_formatter.formatters['text/plain'] |
|
328 | In [1]: f = get_ipython().shell.display_formatter.formatters['text/plain'] | |
329 |
|
329 | |||
330 | In [2]: %precision 5 |
|
330 | In [2]: %precision 5 | |
331 | Out[2]: {u}'%.5f' |
|
331 | Out[2]: {u}'%.5f' | |
332 |
|
332 | |||
333 | In [3]: f.float_format |
|
333 | In [3]: f.float_format | |
334 | Out[3]: {u}'%.5f' |
|
334 | Out[3]: {u}'%.5f' | |
335 |
|
335 | |||
336 | In [4]: %precision %e |
|
336 | In [4]: %precision %e | |
337 | Out[4]: {u}'%e' |
|
337 | Out[4]: {u}'%e' | |
338 |
|
338 | |||
339 | In [5]: f(3.1415927) |
|
339 | In [5]: f(3.1415927) | |
340 | Out[5]: {u}'3.141593e+00' |
|
340 | Out[5]: {u}'3.141593e+00' | |
341 | """ |
|
341 | """ | |
342 |
|
342 | |||
343 | def test_psearch(): |
|
343 | def test_psearch(): | |
344 | with tt.AssertPrints("dict.fromkeys"): |
|
344 | with tt.AssertPrints("dict.fromkeys"): | |
345 | _ip.run_cell("dict.fr*?") |
|
345 | _ip.run_cell("dict.fr*?") | |
346 |
|
346 | |||
|
347 | def test_timeit_shlex(): | |||
|
348 | """test shlex issues with timeit (#1109)""" | |||
|
349 | _ip.ex("def f(*a,**kw): pass") | |||
|
350 | _ip.magic('timeit -n1 "this is a bug".count(" ")') | |||
|
351 | _ip.magic('timeit -r1 -n1 f(" ", 1)') | |||
|
352 | _ip.magic('timeit -r1 -n1 f(" ", 1, " ", 2, " ")') | |||
|
353 | _ip.magic('timeit -r1 -n1 ("a " + "b")') | |||
|
354 | _ip.magic('timeit -r1 -n1 f("a " + "b")') | |||
|
355 | _ip.magic('timeit -r1 -n1 f("a " + "b ")') |
@@ -1,170 +1,194 b'' | |||||
1 | """Common utilities for the various process_* implementations. |
|
1 | """Common utilities for the various process_* implementations. | |
2 |
|
2 | |||
3 | This file is only meant to be imported by the platform-specific implementations |
|
3 | This file is only meant to be imported by the platform-specific implementations | |
4 | of subprocess utilities, and it contains tools that are common to all of them. |
|
4 | of subprocess utilities, and it contains tools that are common to all of them. | |
5 | """ |
|
5 | """ | |
6 |
|
6 | |||
7 | #----------------------------------------------------------------------------- |
|
7 | #----------------------------------------------------------------------------- | |
8 | # Copyright (C) 2010-2011 The IPython Development Team |
|
8 | # Copyright (C) 2010-2011 The IPython Development Team | |
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 | # Imports |
|
15 | # Imports | |
16 | #----------------------------------------------------------------------------- |
|
16 | #----------------------------------------------------------------------------- | |
17 | import subprocess |
|
17 | import subprocess | |
18 | import shlex |
|
18 | import shlex | |
19 | import sys |
|
19 | import sys | |
20 |
|
20 | |||
21 | from IPython.utils import py3compat |
|
21 | from IPython.utils import py3compat | |
22 |
|
22 | |||
23 | #----------------------------------------------------------------------------- |
|
23 | #----------------------------------------------------------------------------- | |
24 | # Function definitions |
|
24 | # Function definitions | |
25 | #----------------------------------------------------------------------------- |
|
25 | #----------------------------------------------------------------------------- | |
26 |
|
26 | |||
27 | def read_no_interrupt(p): |
|
27 | def read_no_interrupt(p): | |
28 | """Read from a pipe ignoring EINTR errors. |
|
28 | """Read from a pipe ignoring EINTR errors. | |
29 |
|
29 | |||
30 | This is necessary because when reading from pipes with GUI event loops |
|
30 | This is necessary because when reading from pipes with GUI event loops | |
31 | running in the background, often interrupts are raised that stop the |
|
31 | running in the background, often interrupts are raised that stop the | |
32 | command from completing.""" |
|
32 | command from completing.""" | |
33 | import errno |
|
33 | import errno | |
34 |
|
34 | |||
35 | try: |
|
35 | try: | |
36 | return p.read() |
|
36 | return p.read() | |
37 | except IOError, err: |
|
37 | except IOError, err: | |
38 | if err.errno != errno.EINTR: |
|
38 | if err.errno != errno.EINTR: | |
39 | raise |
|
39 | raise | |
40 |
|
40 | |||
41 |
|
41 | |||
42 | def process_handler(cmd, callback, stderr=subprocess.PIPE): |
|
42 | def process_handler(cmd, callback, stderr=subprocess.PIPE): | |
43 | """Open a command in a shell subprocess and execute a callback. |
|
43 | """Open a command in a shell subprocess and execute a callback. | |
44 |
|
44 | |||
45 | This function provides common scaffolding for creating subprocess.Popen() |
|
45 | This function provides common scaffolding for creating subprocess.Popen() | |
46 | calls. It creates a Popen object and then calls the callback with it. |
|
46 | calls. It creates a Popen object and then calls the callback with it. | |
47 |
|
47 | |||
48 | Parameters |
|
48 | Parameters | |
49 | ---------- |
|
49 | ---------- | |
50 | cmd : str |
|
50 | cmd : str | |
51 | A string to be executed with the underlying system shell (by calling |
|
51 | A string to be executed with the underlying system shell (by calling | |
52 | :func:`Popen` with ``shell=True``. |
|
52 | :func:`Popen` with ``shell=True``. | |
53 |
|
53 | |||
54 | callback : callable |
|
54 | callback : callable | |
55 | A one-argument function that will be called with the Popen object. |
|
55 | A one-argument function that will be called with the Popen object. | |
56 |
|
56 | |||
57 | stderr : file descriptor number, optional |
|
57 | stderr : file descriptor number, optional | |
58 | By default this is set to ``subprocess.PIPE``, but you can also pass the |
|
58 | By default this is set to ``subprocess.PIPE``, but you can also pass the | |
59 | value ``subprocess.STDOUT`` to force the subprocess' stderr to go into |
|
59 | value ``subprocess.STDOUT`` to force the subprocess' stderr to go into | |
60 | the same file descriptor as its stdout. This is useful to read stdout |
|
60 | the same file descriptor as its stdout. This is useful to read stdout | |
61 | and stderr combined in the order they are generated. |
|
61 | and stderr combined in the order they are generated. | |
62 |
|
62 | |||
63 | Returns |
|
63 | Returns | |
64 | ------- |
|
64 | ------- | |
65 | The return value of the provided callback is returned. |
|
65 | The return value of the provided callback is returned. | |
66 | """ |
|
66 | """ | |
67 | sys.stdout.flush() |
|
67 | sys.stdout.flush() | |
68 | sys.stderr.flush() |
|
68 | sys.stderr.flush() | |
69 | # On win32, close_fds can't be true when using pipes for stdin/out/err |
|
69 | # On win32, close_fds can't be true when using pipes for stdin/out/err | |
70 | close_fds = sys.platform != 'win32' |
|
70 | close_fds = sys.platform != 'win32' | |
71 | p = subprocess.Popen(cmd, shell=True, |
|
71 | p = subprocess.Popen(cmd, shell=True, | |
72 | stdin=subprocess.PIPE, |
|
72 | stdin=subprocess.PIPE, | |
73 | stdout=subprocess.PIPE, |
|
73 | stdout=subprocess.PIPE, | |
74 | stderr=stderr, |
|
74 | stderr=stderr, | |
75 | close_fds=close_fds) |
|
75 | close_fds=close_fds) | |
76 |
|
76 | |||
77 | try: |
|
77 | try: | |
78 | out = callback(p) |
|
78 | out = callback(p) | |
79 | except KeyboardInterrupt: |
|
79 | except KeyboardInterrupt: | |
80 | print('^C') |
|
80 | print('^C') | |
81 | sys.stdout.flush() |
|
81 | sys.stdout.flush() | |
82 | sys.stderr.flush() |
|
82 | sys.stderr.flush() | |
83 | out = None |
|
83 | out = None | |
84 | finally: |
|
84 | finally: | |
85 | # Make really sure that we don't leave processes behind, in case the |
|
85 | # Make really sure that we don't leave processes behind, in case the | |
86 | # call above raises an exception |
|
86 | # call above raises an exception | |
87 | # We start by assuming the subprocess finished (to avoid NameErrors |
|
87 | # We start by assuming the subprocess finished (to avoid NameErrors | |
88 | # later depending on the path taken) |
|
88 | # later depending on the path taken) | |
89 | if p.returncode is None: |
|
89 | if p.returncode is None: | |
90 | try: |
|
90 | try: | |
91 | p.terminate() |
|
91 | p.terminate() | |
92 | p.poll() |
|
92 | p.poll() | |
93 | except OSError: |
|
93 | except OSError: | |
94 | pass |
|
94 | pass | |
95 | # One last try on our way out |
|
95 | # One last try on our way out | |
96 | if p.returncode is None: |
|
96 | if p.returncode is None: | |
97 | try: |
|
97 | try: | |
98 | p.kill() |
|
98 | p.kill() | |
99 | except OSError: |
|
99 | except OSError: | |
100 | pass |
|
100 | pass | |
101 |
|
101 | |||
102 | return out |
|
102 | return out | |
103 |
|
103 | |||
104 |
|
104 | |||
105 | def getoutput(cmd): |
|
105 | def getoutput(cmd): | |
106 | """Return standard output of executing cmd in a shell. |
|
106 | """Return standard output of executing cmd in a shell. | |
107 |
|
107 | |||
108 | Accepts the same arguments as os.system(). |
|
108 | Accepts the same arguments as os.system(). | |
109 |
|
109 | |||
110 | Parameters |
|
110 | Parameters | |
111 | ---------- |
|
111 | ---------- | |
112 | cmd : str |
|
112 | cmd : str | |
113 | A command to be executed in the system shell. |
|
113 | A command to be executed in the system shell. | |
114 |
|
114 | |||
115 | Returns |
|
115 | Returns | |
116 | ------- |
|
116 | ------- | |
117 | stdout : str |
|
117 | stdout : str | |
118 | """ |
|
118 | """ | |
119 |
|
119 | |||
120 | out = process_handler(cmd, lambda p: p.communicate()[0], subprocess.STDOUT) |
|
120 | out = process_handler(cmd, lambda p: p.communicate()[0], subprocess.STDOUT) | |
121 | if out is None: |
|
121 | if out is None: | |
122 | return '' |
|
122 | return '' | |
123 | return py3compat.bytes_to_str(out) |
|
123 | return py3compat.bytes_to_str(out) | |
124 |
|
124 | |||
125 |
|
125 | |||
126 | def getoutputerror(cmd): |
|
126 | def getoutputerror(cmd): | |
127 | """Return (standard output, standard error) of executing cmd in a shell. |
|
127 | """Return (standard output, standard error) of executing cmd in a shell. | |
128 |
|
128 | |||
129 | Accepts the same arguments as os.system(). |
|
129 | Accepts the same arguments as os.system(). | |
130 |
|
130 | |||
131 | Parameters |
|
131 | Parameters | |
132 | ---------- |
|
132 | ---------- | |
133 | cmd : str |
|
133 | cmd : str | |
134 | A command to be executed in the system shell. |
|
134 | A command to be executed in the system shell. | |
135 |
|
135 | |||
136 | Returns |
|
136 | Returns | |
137 | ------- |
|
137 | ------- | |
138 | stdout : str |
|
138 | stdout : str | |
139 | stderr : str |
|
139 | stderr : str | |
140 | """ |
|
140 | """ | |
141 |
|
141 | |||
142 | out_err = process_handler(cmd, lambda p: p.communicate()) |
|
142 | out_err = process_handler(cmd, lambda p: p.communicate()) | |
143 | if out_err is None: |
|
143 | if out_err is None: | |
144 | return '', '' |
|
144 | return '', '' | |
145 | out, err = out_err |
|
145 | out, err = out_err | |
146 | return py3compat.bytes_to_str(out), py3compat.bytes_to_str(err) |
|
146 | return py3compat.bytes_to_str(out), py3compat.bytes_to_str(err) | |
147 |
|
147 | |||
148 |
|
148 | |||
149 | def arg_split(s, posix=False): |
|
149 | def arg_split(s, posix=False, strict=True): | |
150 | """Split a command line's arguments in a shell-like manner. |
|
150 | """Split a command line's arguments in a shell-like manner. | |
151 |
|
151 | |||
152 | This is a modified version of the standard library's shlex.split() |
|
152 | This is a modified version of the standard library's shlex.split() | |
153 | function, but with a default of posix=False for splitting, so that quotes |
|
153 | function, but with a default of posix=False for splitting, so that quotes | |
154 |
in inputs are respected. |
|
154 | in inputs are respected. | |
|
155 | ||||
|
156 | if strict=False, then any errors shlex.split would raise will result in the | |||
|
157 | unparsed remainder being the last element of the list, rather than raising. | |||
|
158 | This is because we sometimes use arg_split to parse things other than | |||
|
159 | command-line args. | |||
|
160 | """ | |||
155 |
|
161 | |||
156 | # Unfortunately, python's shlex module is buggy with unicode input: |
|
162 | # Unfortunately, python's shlex module is buggy with unicode input: | |
157 | # http://bugs.python.org/issue1170 |
|
163 | # http://bugs.python.org/issue1170 | |
158 | # At least encoding the input when it's unicode seems to help, but there |
|
164 | # At least encoding the input when it's unicode seems to help, but there | |
159 | # may be more problems lurking. Apparently this is fixed in python3. |
|
165 | # may be more problems lurking. Apparently this is fixed in python3. | |
160 | is_unicode = False |
|
166 | is_unicode = False | |
161 | if (not py3compat.PY3) and isinstance(s, unicode): |
|
167 | if (not py3compat.PY3) and isinstance(s, unicode): | |
162 | is_unicode = True |
|
168 | is_unicode = True | |
163 | s = s.encode('utf-8') |
|
169 | s = s.encode('utf-8') | |
164 | lex = shlex.shlex(s, posix=posix) |
|
170 | lex = shlex.shlex(s, posix=posix) | |
165 | lex.whitespace_split = True |
|
171 | lex.whitespace_split = True | |
166 | tokens = list(lex) |
|
172 | # Extract tokens, ensuring that things like leaving open quotes | |
|
173 | # does not cause this to raise. This is important, because we | |||
|
174 | # sometimes pass Python source through this (e.g. %timeit f(" ")), | |||
|
175 | # and it shouldn't raise an exception. | |||
|
176 | # It may be a bad idea to parse things that are not command-line args | |||
|
177 | # through this function, but we do, so let's be safe about it. | |||
|
178 | tokens = [] | |||
|
179 | while True: | |||
|
180 | try: | |||
|
181 | tokens.append(lex.next()) | |||
|
182 | except StopIteration: | |||
|
183 | break | |||
|
184 | except ValueError: | |||
|
185 | if strict: | |||
|
186 | raise | |||
|
187 | # couldn't parse, get remaining blob as last token | |||
|
188 | tokens.append(lex.token) | |||
|
189 | break | |||
|
190 | ||||
167 | if is_unicode: |
|
191 | if is_unicode: | |
168 | # Convert the tokens back to unicode. |
|
192 | # Convert the tokens back to unicode. | |
169 | tokens = [x.decode('utf-8') for x in tokens] |
|
193 | tokens = [x.decode('utf-8') for x in tokens] | |
170 | return tokens |
|
194 | return tokens |
General Comments 0
You need to be logged in to leave comments.
Login now