Show More
@@ -1,703 +1,717 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 Fernando Perez <fperez@colorado.edu> |
|
7 | # Copyright (C) 2001 Fernando Perez <fperez@colorado.edu> | |
8 | # Copyright (C) 2008 The IPython Development Team |
|
8 | # Copyright (C) 2008 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 | import os |
|
14 | import os | |
15 | import re |
|
15 | import re | |
16 | import sys |
|
16 | import sys | |
17 | from getopt import getopt, GetoptError |
|
17 | from getopt import getopt, GetoptError | |
18 |
|
18 | |||
19 | from traitlets.config.configurable import Configurable |
|
19 | from traitlets.config.configurable import Configurable | |
20 | from . import oinspect |
|
20 | from . import oinspect | |
21 | from .error import UsageError |
|
21 | from .error import UsageError | |
22 | from .inputtransformer2 import ESC_MAGIC, ESC_MAGIC2 |
|
22 | from .inputtransformer2 import ESC_MAGIC, ESC_MAGIC2 | |
23 | from decorator import decorator |
|
23 | from decorator import decorator | |
24 | from ..utils.ipstruct import Struct |
|
24 | from ..utils.ipstruct import Struct | |
25 | from ..utils.process import arg_split |
|
25 | from ..utils.process import arg_split | |
26 | from ..utils.text import dedent |
|
26 | from ..utils.text import dedent | |
27 | from traitlets import Bool, Dict, Instance, observe |
|
27 | from traitlets import Bool, Dict, Instance, observe | |
28 | from logging import error |
|
28 | from logging import error | |
29 |
|
29 | |||
30 | #----------------------------------------------------------------------------- |
|
30 | #----------------------------------------------------------------------------- | |
31 | # Globals |
|
31 | # Globals | |
32 | #----------------------------------------------------------------------------- |
|
32 | #----------------------------------------------------------------------------- | |
33 |
|
33 | |||
34 | # A dict we'll use for each class that has magics, used as temporary storage to |
|
34 | # A dict we'll use for each class that has magics, used as temporary storage to | |
35 | # pass information between the @line/cell_magic method decorators and the |
|
35 | # pass information between the @line/cell_magic method decorators and the | |
36 | # @magics_class class decorator, because the method decorators have no |
|
36 | # @magics_class class decorator, because the method decorators have no | |
37 | # access to the class when they run. See for more details: |
|
37 | # access to the class when they run. See for more details: | |
38 | # http://stackoverflow.com/questions/2366713/can-a-python-decorator-of-an-instance-method-access-the-class |
|
38 | # http://stackoverflow.com/questions/2366713/can-a-python-decorator-of-an-instance-method-access-the-class | |
39 |
|
39 | |||
40 | magics = dict(line={}, cell={}) |
|
40 | magics = dict(line={}, cell={}) | |
41 |
|
41 | |||
42 | magic_kinds = ('line', 'cell') |
|
42 | magic_kinds = ('line', 'cell') | |
43 | magic_spec = ('line', 'cell', 'line_cell') |
|
43 | magic_spec = ('line', 'cell', 'line_cell') | |
44 | magic_escapes = dict(line=ESC_MAGIC, cell=ESC_MAGIC2) |
|
44 | magic_escapes = dict(line=ESC_MAGIC, cell=ESC_MAGIC2) | |
45 |
|
45 | |||
46 | #----------------------------------------------------------------------------- |
|
46 | #----------------------------------------------------------------------------- | |
47 | # Utility classes and functions |
|
47 | # Utility classes and functions | |
48 | #----------------------------------------------------------------------------- |
|
48 | #----------------------------------------------------------------------------- | |
49 |
|
49 | |||
50 | class Bunch: pass |
|
50 | class Bunch: pass | |
51 |
|
51 | |||
52 |
|
52 | |||
53 | def on_off(tag): |
|
53 | def on_off(tag): | |
54 | """Return an ON/OFF string for a 1/0 input. Simple utility function.""" |
|
54 | """Return an ON/OFF string for a 1/0 input. Simple utility function.""" | |
55 | return ['OFF','ON'][tag] |
|
55 | return ['OFF','ON'][tag] | |
56 |
|
56 | |||
57 |
|
57 | |||
58 | def compress_dhist(dh): |
|
58 | def compress_dhist(dh): | |
59 | """Compress a directory history into a new one with at most 20 entries. |
|
59 | """Compress a directory history into a new one with at most 20 entries. | |
60 |
|
60 | |||
61 | Return a new list made from the first and last 10 elements of dhist after |
|
61 | Return a new list made from the first and last 10 elements of dhist after | |
62 | removal of duplicates. |
|
62 | removal of duplicates. | |
63 | """ |
|
63 | """ | |
64 | head, tail = dh[:-10], dh[-10:] |
|
64 | head, tail = dh[:-10], dh[-10:] | |
65 |
|
65 | |||
66 | newhead = [] |
|
66 | newhead = [] | |
67 | done = set() |
|
67 | done = set() | |
68 | for h in head: |
|
68 | for h in head: | |
69 | if h in done: |
|
69 | if h in done: | |
70 | continue |
|
70 | continue | |
71 | newhead.append(h) |
|
71 | newhead.append(h) | |
72 | done.add(h) |
|
72 | done.add(h) | |
73 |
|
73 | |||
74 | return newhead + tail |
|
74 | return newhead + tail | |
75 |
|
75 | |||
76 |
|
76 | |||
77 | def needs_local_scope(func): |
|
77 | def needs_local_scope(func): | |
78 | """Decorator to mark magic functions which need to local scope to run.""" |
|
78 | """Decorator to mark magic functions which need to local scope to run.""" | |
79 | func.needs_local_scope = True |
|
79 | func.needs_local_scope = True | |
80 | return func |
|
80 | return func | |
81 |
|
81 | |||
82 | #----------------------------------------------------------------------------- |
|
82 | #----------------------------------------------------------------------------- | |
83 | # Class and method decorators for registering magics |
|
83 | # Class and method decorators for registering magics | |
84 | #----------------------------------------------------------------------------- |
|
84 | #----------------------------------------------------------------------------- | |
85 |
|
85 | |||
86 | def magics_class(cls): |
|
86 | def magics_class(cls): | |
87 | """Class decorator for all subclasses of the main Magics class. |
|
87 | """Class decorator for all subclasses of the main Magics class. | |
88 |
|
88 | |||
89 | Any class that subclasses Magics *must* also apply this decorator, to |
|
89 | Any class that subclasses Magics *must* also apply this decorator, to | |
90 | ensure that all the methods that have been decorated as line/cell magics |
|
90 | ensure that all the methods that have been decorated as line/cell magics | |
91 | get correctly registered in the class instance. This is necessary because |
|
91 | get correctly registered in the class instance. This is necessary because | |
92 | when method decorators run, the class does not exist yet, so they |
|
92 | when method decorators run, the class does not exist yet, so they | |
93 | temporarily store their information into a module global. Application of |
|
93 | temporarily store their information into a module global. Application of | |
94 | this class decorator copies that global data to the class instance and |
|
94 | this class decorator copies that global data to the class instance and | |
95 | clears the global. |
|
95 | clears the global. | |
96 |
|
96 | |||
97 | Obviously, this mechanism is not thread-safe, which means that the |
|
97 | Obviously, this mechanism is not thread-safe, which means that the | |
98 | *creation* of subclasses of Magic should only be done in a single-thread |
|
98 | *creation* of subclasses of Magic should only be done in a single-thread | |
99 | context. Instantiation of the classes has no restrictions. Given that |
|
99 | context. Instantiation of the classes has no restrictions. Given that | |
100 | these classes are typically created at IPython startup time and before user |
|
100 | these classes are typically created at IPython startup time and before user | |
101 | application code becomes active, in practice this should not pose any |
|
101 | application code becomes active, in practice this should not pose any | |
102 | problems. |
|
102 | problems. | |
103 | """ |
|
103 | """ | |
104 | cls.registered = True |
|
104 | cls.registered = True | |
105 | cls.magics = dict(line = magics['line'], |
|
105 | cls.magics = dict(line = magics['line'], | |
106 | cell = magics['cell']) |
|
106 | cell = magics['cell']) | |
107 | magics['line'] = {} |
|
107 | magics['line'] = {} | |
108 | magics['cell'] = {} |
|
108 | magics['cell'] = {} | |
109 | return cls |
|
109 | return cls | |
110 |
|
110 | |||
111 |
|
111 | |||
112 | def record_magic(dct, magic_kind, magic_name, func): |
|
112 | def record_magic(dct, magic_kind, magic_name, func): | |
113 | """Utility function to store a function as a magic of a specific kind. |
|
113 | """Utility function to store a function as a magic of a specific kind. | |
114 |
|
114 | |||
115 | Parameters |
|
115 | Parameters | |
116 | ---------- |
|
116 | ---------- | |
117 | dct : dict |
|
117 | dct : dict | |
118 | A dictionary with 'line' and 'cell' subdicts. |
|
118 | A dictionary with 'line' and 'cell' subdicts. | |
119 |
|
119 | |||
120 | magic_kind : str |
|
120 | magic_kind : str | |
121 | Kind of magic to be stored. |
|
121 | Kind of magic to be stored. | |
122 |
|
122 | |||
123 | magic_name : str |
|
123 | magic_name : str | |
124 | Key to store the magic as. |
|
124 | Key to store the magic as. | |
125 |
|
125 | |||
126 | func : function |
|
126 | func : function | |
127 | Callable object to store. |
|
127 | Callable object to store. | |
128 | """ |
|
128 | """ | |
129 | if magic_kind == 'line_cell': |
|
129 | if magic_kind == 'line_cell': | |
130 | dct['line'][magic_name] = dct['cell'][magic_name] = func |
|
130 | dct['line'][magic_name] = dct['cell'][magic_name] = func | |
131 | else: |
|
131 | else: | |
132 | dct[magic_kind][magic_name] = func |
|
132 | dct[magic_kind][magic_name] = func | |
133 |
|
133 | |||
134 |
|
134 | |||
135 | def validate_type(magic_kind): |
|
135 | def validate_type(magic_kind): | |
136 | """Ensure that the given magic_kind is valid. |
|
136 | """Ensure that the given magic_kind is valid. | |
137 |
|
137 | |||
138 | Check that the given magic_kind is one of the accepted spec types (stored |
|
138 | Check that the given magic_kind is one of the accepted spec types (stored | |
139 | in the global `magic_spec`), raise ValueError otherwise. |
|
139 | in the global `magic_spec`), raise ValueError otherwise. | |
140 | """ |
|
140 | """ | |
141 | if magic_kind not in magic_spec: |
|
141 | if magic_kind not in magic_spec: | |
142 | raise ValueError('magic_kind must be one of %s, %s given' % |
|
142 | raise ValueError('magic_kind must be one of %s, %s given' % | |
143 | magic_kinds, magic_kind) |
|
143 | magic_kinds, magic_kind) | |
144 |
|
144 | |||
145 |
|
145 | |||
146 | # The docstrings for the decorator below will be fairly similar for the two |
|
146 | # The docstrings for the decorator below will be fairly similar for the two | |
147 | # types (method and function), so we generate them here once and reuse the |
|
147 | # types (method and function), so we generate them here once and reuse the | |
148 | # templates below. |
|
148 | # templates below. | |
149 | _docstring_template = \ |
|
149 | _docstring_template = \ | |
150 | """Decorate the given {0} as {1} magic. |
|
150 | """Decorate the given {0} as {1} magic. | |
151 |
|
151 | |||
152 | The decorator can be used with or without arguments, as follows. |
|
152 | The decorator can be used with or without arguments, as follows. | |
153 |
|
153 | |||
154 | i) without arguments: it will create a {1} magic named as the {0} being |
|
154 | i) without arguments: it will create a {1} magic named as the {0} being | |
155 | decorated:: |
|
155 | decorated:: | |
156 |
|
156 | |||
157 | @deco |
|
157 | @deco | |
158 | def foo(...) |
|
158 | def foo(...) | |
159 |
|
159 | |||
160 | will create a {1} magic named `foo`. |
|
160 | will create a {1} magic named `foo`. | |
161 |
|
161 | |||
162 | ii) with one string argument: which will be used as the actual name of the |
|
162 | ii) with one string argument: which will be used as the actual name of the | |
163 | resulting magic:: |
|
163 | resulting magic:: | |
164 |
|
164 | |||
165 | @deco('bar') |
|
165 | @deco('bar') | |
166 | def foo(...) |
|
166 | def foo(...) | |
167 |
|
167 | |||
168 | will create a {1} magic named `bar`. |
|
168 | will create a {1} magic named `bar`. | |
169 |
|
169 | |||
170 | To register a class magic use ``Interactiveshell.register_magic(class or instance)``. |
|
170 | To register a class magic use ``Interactiveshell.register_magic(class or instance)``. | |
171 | """ |
|
171 | """ | |
172 |
|
172 | |||
173 | # These two are decorator factories. While they are conceptually very similar, |
|
173 | # These two are decorator factories. While they are conceptually very similar, | |
174 | # there are enough differences in the details that it's simpler to have them |
|
174 | # there are enough differences in the details that it's simpler to have them | |
175 | # written as completely standalone functions rather than trying to share code |
|
175 | # written as completely standalone functions rather than trying to share code | |
176 | # and make a single one with convoluted logic. |
|
176 | # and make a single one with convoluted logic. | |
177 |
|
177 | |||
178 | def _method_magic_marker(magic_kind): |
|
178 | def _method_magic_marker(magic_kind): | |
179 | """Decorator factory for methods in Magics subclasses. |
|
179 | """Decorator factory for methods in Magics subclasses. | |
180 | """ |
|
180 | """ | |
181 |
|
181 | |||
182 | validate_type(magic_kind) |
|
182 | validate_type(magic_kind) | |
183 |
|
183 | |||
184 | # This is a closure to capture the magic_kind. We could also use a class, |
|
184 | # This is a closure to capture the magic_kind. We could also use a class, | |
185 | # but it's overkill for just that one bit of state. |
|
185 | # but it's overkill for just that one bit of state. | |
186 | def magic_deco(arg): |
|
186 | def magic_deco(arg): | |
187 | call = lambda f, *a, **k: f(*a, **k) |
|
187 | call = lambda f, *a, **k: f(*a, **k) | |
188 |
|
188 | |||
189 | if callable(arg): |
|
189 | if callable(arg): | |
190 | # "Naked" decorator call (just @foo, no args) |
|
190 | # "Naked" decorator call (just @foo, no args) | |
191 | func = arg |
|
191 | func = arg | |
192 | name = func.__name__ |
|
192 | name = func.__name__ | |
193 | retval = decorator(call, func) |
|
193 | retval = decorator(call, func) | |
194 | record_magic(magics, magic_kind, name, name) |
|
194 | record_magic(magics, magic_kind, name, name) | |
195 | elif isinstance(arg, str): |
|
195 | elif isinstance(arg, str): | |
196 | # Decorator called with arguments (@foo('bar')) |
|
196 | # Decorator called with arguments (@foo('bar')) | |
197 | name = arg |
|
197 | name = arg | |
198 | def mark(func, *a, **kw): |
|
198 | def mark(func, *a, **kw): | |
199 | record_magic(magics, magic_kind, name, func.__name__) |
|
199 | record_magic(magics, magic_kind, name, func.__name__) | |
200 | return decorator(call, func) |
|
200 | return decorator(call, func) | |
201 | retval = mark |
|
201 | retval = mark | |
202 | else: |
|
202 | else: | |
203 | raise TypeError("Decorator can only be called with " |
|
203 | raise TypeError("Decorator can only be called with " | |
204 | "string or function") |
|
204 | "string or function") | |
205 | return retval |
|
205 | return retval | |
206 |
|
206 | |||
207 | # Ensure the resulting decorator has a usable docstring |
|
207 | # Ensure the resulting decorator has a usable docstring | |
208 | magic_deco.__doc__ = _docstring_template.format('method', magic_kind) |
|
208 | magic_deco.__doc__ = _docstring_template.format('method', magic_kind) | |
209 | return magic_deco |
|
209 | return magic_deco | |
210 |
|
210 | |||
211 |
|
211 | |||
212 | def _function_magic_marker(magic_kind): |
|
212 | def _function_magic_marker(magic_kind): | |
213 | """Decorator factory for standalone functions. |
|
213 | """Decorator factory for standalone functions. | |
214 | """ |
|
214 | """ | |
215 | validate_type(magic_kind) |
|
215 | validate_type(magic_kind) | |
216 |
|
216 | |||
217 | # This is a closure to capture the magic_kind. We could also use a class, |
|
217 | # This is a closure to capture the magic_kind. We could also use a class, | |
218 | # but it's overkill for just that one bit of state. |
|
218 | # but it's overkill for just that one bit of state. | |
219 | def magic_deco(arg): |
|
219 | def magic_deco(arg): | |
220 | call = lambda f, *a, **k: f(*a, **k) |
|
220 | call = lambda f, *a, **k: f(*a, **k) | |
221 |
|
221 | |||
222 | # Find get_ipython() in the caller's namespace |
|
222 | # Find get_ipython() in the caller's namespace | |
223 | caller = sys._getframe(1) |
|
223 | caller = sys._getframe(1) | |
224 | for ns in ['f_locals', 'f_globals', 'f_builtins']: |
|
224 | for ns in ['f_locals', 'f_globals', 'f_builtins']: | |
225 | get_ipython = getattr(caller, ns).get('get_ipython') |
|
225 | get_ipython = getattr(caller, ns).get('get_ipython') | |
226 | if get_ipython is not None: |
|
226 | if get_ipython is not None: | |
227 | break |
|
227 | break | |
228 | else: |
|
228 | else: | |
229 | raise NameError('Decorator can only run in context where ' |
|
229 | raise NameError('Decorator can only run in context where ' | |
230 | '`get_ipython` exists') |
|
230 | '`get_ipython` exists') | |
231 |
|
231 | |||
232 | ip = get_ipython() |
|
232 | ip = get_ipython() | |
233 |
|
233 | |||
234 | if callable(arg): |
|
234 | if callable(arg): | |
235 | # "Naked" decorator call (just @foo, no args) |
|
235 | # "Naked" decorator call (just @foo, no args) | |
236 | func = arg |
|
236 | func = arg | |
237 | name = func.__name__ |
|
237 | name = func.__name__ | |
238 | ip.register_magic_function(func, magic_kind, name) |
|
238 | ip.register_magic_function(func, magic_kind, name) | |
239 | retval = decorator(call, func) |
|
239 | retval = decorator(call, func) | |
240 | elif isinstance(arg, str): |
|
240 | elif isinstance(arg, str): | |
241 | # Decorator called with arguments (@foo('bar')) |
|
241 | # Decorator called with arguments (@foo('bar')) | |
242 | name = arg |
|
242 | name = arg | |
243 | def mark(func, *a, **kw): |
|
243 | def mark(func, *a, **kw): | |
244 | ip.register_magic_function(func, magic_kind, name) |
|
244 | ip.register_magic_function(func, magic_kind, name) | |
245 | return decorator(call, func) |
|
245 | return decorator(call, func) | |
246 | retval = mark |
|
246 | retval = mark | |
247 | else: |
|
247 | else: | |
248 | raise TypeError("Decorator can only be called with " |
|
248 | raise TypeError("Decorator can only be called with " | |
249 | "string or function") |
|
249 | "string or function") | |
250 | return retval |
|
250 | return retval | |
251 |
|
251 | |||
252 | # Ensure the resulting decorator has a usable docstring |
|
252 | # Ensure the resulting decorator has a usable docstring | |
253 | ds = _docstring_template.format('function', magic_kind) |
|
253 | ds = _docstring_template.format('function', magic_kind) | |
254 |
|
254 | |||
255 | ds += dedent(""" |
|
255 | ds += dedent(""" | |
256 | Note: this decorator can only be used in a context where IPython is already |
|
256 | Note: this decorator can only be used in a context where IPython is already | |
257 | active, so that the `get_ipython()` call succeeds. You can therefore use |
|
257 | active, so that the `get_ipython()` call succeeds. You can therefore use | |
258 | it in your startup files loaded after IPython initializes, but *not* in the |
|
258 | it in your startup files loaded after IPython initializes, but *not* in the | |
259 | IPython configuration file itself, which is executed before IPython is |
|
259 | IPython configuration file itself, which is executed before IPython is | |
260 | fully up and running. Any file located in the `startup` subdirectory of |
|
260 | fully up and running. Any file located in the `startup` subdirectory of | |
261 | your configuration profile will be OK in this sense. |
|
261 | your configuration profile will be OK in this sense. | |
262 | """) |
|
262 | """) | |
263 |
|
263 | |||
264 | magic_deco.__doc__ = ds |
|
264 | magic_deco.__doc__ = ds | |
265 | return magic_deco |
|
265 | return magic_deco | |
266 |
|
266 | |||
267 |
|
267 | |||
268 | MAGIC_NO_VAR_EXPAND_ATTR = '_ipython_magic_no_var_expand' |
|
268 | MAGIC_NO_VAR_EXPAND_ATTR = '_ipython_magic_no_var_expand' | |
269 |
|
269 | |||
270 |
|
270 | |||
271 | def no_var_expand(magic_func): |
|
271 | def no_var_expand(magic_func): | |
272 | """Mark a magic function as not needing variable expansion |
|
272 | """Mark a magic function as not needing variable expansion | |
273 |
|
273 | |||
274 | By default, IPython interprets `{a}` or `$a` in the line passed to magics |
|
274 | By default, IPython interprets `{a}` or `$a` in the line passed to magics | |
275 | as variables that should be interpolated from the interactive namespace |
|
275 | as variables that should be interpolated from the interactive namespace | |
276 | before passing the line to the magic function. |
|
276 | before passing the line to the magic function. | |
277 | This is not always desirable, e.g. when the magic executes Python code |
|
277 | This is not always desirable, e.g. when the magic executes Python code | |
278 | (%timeit, %time, etc.). |
|
278 | (%timeit, %time, etc.). | |
279 | Decorate magics with `@no_var_expand` to opt-out of variable expansion. |
|
279 | Decorate magics with `@no_var_expand` to opt-out of variable expansion. | |
280 |
|
280 | |||
281 | .. versionadded:: 7.3 |
|
281 | .. versionadded:: 7.3 | |
282 | """ |
|
282 | """ | |
283 | setattr(magic_func, MAGIC_NO_VAR_EXPAND_ATTR, True) |
|
283 | setattr(magic_func, MAGIC_NO_VAR_EXPAND_ATTR, True) | |
284 | return magic_func |
|
284 | return magic_func | |
285 |
|
285 | |||
286 |
|
286 | |||
287 | # Create the actual decorators for public use |
|
287 | # Create the actual decorators for public use | |
288 |
|
288 | |||
289 | # These three are used to decorate methods in class definitions |
|
289 | # These three are used to decorate methods in class definitions | |
290 | line_magic = _method_magic_marker('line') |
|
290 | line_magic = _method_magic_marker('line') | |
291 | cell_magic = _method_magic_marker('cell') |
|
291 | cell_magic = _method_magic_marker('cell') | |
292 | line_cell_magic = _method_magic_marker('line_cell') |
|
292 | line_cell_magic = _method_magic_marker('line_cell') | |
293 |
|
293 | |||
294 | # These three decorate standalone functions and perform the decoration |
|
294 | # These three decorate standalone functions and perform the decoration | |
295 | # immediately. They can only run where get_ipython() works |
|
295 | # immediately. They can only run where get_ipython() works | |
296 | register_line_magic = _function_magic_marker('line') |
|
296 | register_line_magic = _function_magic_marker('line') | |
297 | register_cell_magic = _function_magic_marker('cell') |
|
297 | register_cell_magic = _function_magic_marker('cell') | |
298 | register_line_cell_magic = _function_magic_marker('line_cell') |
|
298 | register_line_cell_magic = _function_magic_marker('line_cell') | |
299 |
|
299 | |||
300 | #----------------------------------------------------------------------------- |
|
300 | #----------------------------------------------------------------------------- | |
301 | # Core Magic classes |
|
301 | # Core Magic classes | |
302 | #----------------------------------------------------------------------------- |
|
302 | #----------------------------------------------------------------------------- | |
303 |
|
303 | |||
304 | class MagicsManager(Configurable): |
|
304 | class MagicsManager(Configurable): | |
305 | """Object that handles all magic-related functionality for IPython. |
|
305 | """Object that handles all magic-related functionality for IPython. | |
306 | """ |
|
306 | """ | |
307 | # Non-configurable class attributes |
|
307 | # Non-configurable class attributes | |
308 |
|
308 | |||
309 | # A two-level dict, first keyed by magic type, then by magic function, and |
|
309 | # A two-level dict, first keyed by magic type, then by magic function, and | |
310 | # holding the actual callable object as value. This is the dict used for |
|
310 | # holding the actual callable object as value. This is the dict used for | |
311 | # magic function dispatch |
|
311 | # magic function dispatch | |
312 | magics = Dict() |
|
312 | magics = Dict() | |
313 |
|
313 | |||
314 | # A registry of the original objects that we've been given holding magics. |
|
314 | # A registry of the original objects that we've been given holding magics. | |
315 | registry = Dict() |
|
315 | registry = Dict() | |
316 |
|
316 | |||
317 | shell = Instance('IPython.core.interactiveshell.InteractiveShellABC', allow_none=True) |
|
317 | shell = Instance('IPython.core.interactiveshell.InteractiveShellABC', allow_none=True) | |
318 |
|
318 | |||
319 | auto_magic = Bool(True, help= |
|
319 | auto_magic = Bool(True, help= | |
320 | "Automatically call line magics without requiring explicit % prefix" |
|
320 | "Automatically call line magics without requiring explicit % prefix" | |
321 | ).tag(config=True) |
|
321 | ).tag(config=True) | |
322 | @observe('auto_magic') |
|
322 | @observe('auto_magic') | |
323 | def _auto_magic_changed(self, change): |
|
323 | def _auto_magic_changed(self, change): | |
324 | self.shell.automagic = change['new'] |
|
324 | self.shell.automagic = change['new'] | |
325 |
|
325 | |||
326 | _auto_status = [ |
|
326 | _auto_status = [ | |
327 | 'Automagic is OFF, % prefix IS needed for line magics.', |
|
327 | 'Automagic is OFF, % prefix IS needed for line magics.', | |
328 | 'Automagic is ON, % prefix IS NOT needed for line magics.'] |
|
328 | 'Automagic is ON, % prefix IS NOT needed for line magics.'] | |
329 |
|
329 | |||
330 | user_magics = Instance('IPython.core.magics.UserMagics', allow_none=True) |
|
330 | user_magics = Instance('IPython.core.magics.UserMagics', allow_none=True) | |
331 |
|
331 | |||
332 | def __init__(self, shell=None, config=None, user_magics=None, **traits): |
|
332 | def __init__(self, shell=None, config=None, user_magics=None, **traits): | |
333 |
|
333 | |||
334 | super(MagicsManager, self).__init__(shell=shell, config=config, |
|
334 | super(MagicsManager, self).__init__(shell=shell, config=config, | |
335 | user_magics=user_magics, **traits) |
|
335 | user_magics=user_magics, **traits) | |
336 | self.magics = dict(line={}, cell={}) |
|
336 | self.magics = dict(line={}, cell={}) | |
337 | # Let's add the user_magics to the registry for uniformity, so *all* |
|
337 | # Let's add the user_magics to the registry for uniformity, so *all* | |
338 | # registered magic containers can be found there. |
|
338 | # registered magic containers can be found there. | |
339 | self.registry[user_magics.__class__.__name__] = user_magics |
|
339 | self.registry[user_magics.__class__.__name__] = user_magics | |
340 |
|
340 | |||
341 | def auto_status(self): |
|
341 | def auto_status(self): | |
342 | """Return descriptive string with automagic status.""" |
|
342 | """Return descriptive string with automagic status.""" | |
343 | return self._auto_status[self.auto_magic] |
|
343 | return self._auto_status[self.auto_magic] | |
344 |
|
344 | |||
345 | def lsmagic(self): |
|
345 | def lsmagic(self): | |
346 | """Return a dict of currently available magic functions. |
|
346 | """Return a dict of currently available magic functions. | |
347 |
|
347 | |||
348 | The return dict has the keys 'line' and 'cell', corresponding to the |
|
348 | The return dict has the keys 'line' and 'cell', corresponding to the | |
349 | two types of magics we support. Each value is a list of names. |
|
349 | two types of magics we support. Each value is a list of names. | |
350 | """ |
|
350 | """ | |
351 | return self.magics |
|
351 | return self.magics | |
352 |
|
352 | |||
353 | def lsmagic_docs(self, brief=False, missing=''): |
|
353 | def lsmagic_docs(self, brief=False, missing=''): | |
354 | """Return dict of documentation of magic functions. |
|
354 | """Return dict of documentation of magic functions. | |
355 |
|
355 | |||
356 | The return dict has the keys 'line' and 'cell', corresponding to the |
|
356 | The return dict has the keys 'line' and 'cell', corresponding to the | |
357 | two types of magics we support. Each value is a dict keyed by magic |
|
357 | two types of magics we support. Each value is a dict keyed by magic | |
358 | name whose value is the function docstring. If a docstring is |
|
358 | name whose value is the function docstring. If a docstring is | |
359 | unavailable, the value of `missing` is used instead. |
|
359 | unavailable, the value of `missing` is used instead. | |
360 |
|
360 | |||
361 | If brief is True, only the first line of each docstring will be returned. |
|
361 | If brief is True, only the first line of each docstring will be returned. | |
362 | """ |
|
362 | """ | |
363 | docs = {} |
|
363 | docs = {} | |
364 | for m_type in self.magics: |
|
364 | for m_type in self.magics: | |
365 | m_docs = {} |
|
365 | m_docs = {} | |
366 | for m_name, m_func in self.magics[m_type].items(): |
|
366 | for m_name, m_func in self.magics[m_type].items(): | |
367 | if m_func.__doc__: |
|
367 | if m_func.__doc__: | |
368 | if brief: |
|
368 | if brief: | |
369 | m_docs[m_name] = m_func.__doc__.split('\n', 1)[0] |
|
369 | m_docs[m_name] = m_func.__doc__.split('\n', 1)[0] | |
370 | else: |
|
370 | else: | |
371 | m_docs[m_name] = m_func.__doc__.rstrip() |
|
371 | m_docs[m_name] = m_func.__doc__.rstrip() | |
372 | else: |
|
372 | else: | |
373 | m_docs[m_name] = missing |
|
373 | m_docs[m_name] = missing | |
374 | docs[m_type] = m_docs |
|
374 | docs[m_type] = m_docs | |
375 | return docs |
|
375 | return docs | |
376 |
|
376 | |||
377 | def register(self, *magic_objects): |
|
377 | def register(self, *magic_objects): | |
378 | """Register one or more instances of Magics. |
|
378 | """Register one or more instances of Magics. | |
379 |
|
379 | |||
380 | Take one or more classes or instances of classes that subclass the main |
|
380 | Take one or more classes or instances of classes that subclass the main | |
381 | `core.Magic` class, and register them with IPython to use the magic |
|
381 | `core.Magic` class, and register them with IPython to use the magic | |
382 | functions they provide. The registration process will then ensure that |
|
382 | functions they provide. The registration process will then ensure that | |
383 | any methods that have decorated to provide line and/or cell magics will |
|
383 | any methods that have decorated to provide line and/or cell magics will | |
384 | be recognized with the `%x`/`%%x` syntax as a line/cell magic |
|
384 | be recognized with the `%x`/`%%x` syntax as a line/cell magic | |
385 | respectively. |
|
385 | respectively. | |
386 |
|
386 | |||
387 | If classes are given, they will be instantiated with the default |
|
387 | If classes are given, they will be instantiated with the default | |
388 | constructor. If your classes need a custom constructor, you should |
|
388 | constructor. If your classes need a custom constructor, you should | |
389 | instanitate them first and pass the instance. |
|
389 | instanitate them first and pass the instance. | |
390 |
|
390 | |||
391 | The provided arguments can be an arbitrary mix of classes and instances. |
|
391 | The provided arguments can be an arbitrary mix of classes and instances. | |
392 |
|
392 | |||
393 | Parameters |
|
393 | Parameters | |
394 | ---------- |
|
394 | ---------- | |
395 | magic_objects : one or more classes or instances |
|
395 | magic_objects : one or more classes or instances | |
396 | """ |
|
396 | """ | |
397 | # Start by validating them to ensure they have all had their magic |
|
397 | # Start by validating them to ensure they have all had their magic | |
398 | # methods registered at the instance level |
|
398 | # methods registered at the instance level | |
399 | for m in magic_objects: |
|
399 | for m in magic_objects: | |
400 | if not m.registered: |
|
400 | if not m.registered: | |
401 | raise ValueError("Class of magics %r was constructed without " |
|
401 | raise ValueError("Class of magics %r was constructed without " | |
402 | "the @register_magics class decorator") |
|
402 | "the @register_magics class decorator") | |
403 | if isinstance(m, type): |
|
403 | if isinstance(m, type): | |
404 | # If we're given an uninstantiated class |
|
404 | # If we're given an uninstantiated class | |
405 | m = m(shell=self.shell) |
|
405 | m = m(shell=self.shell) | |
406 |
|
406 | |||
407 | # Now that we have an instance, we can register it and update the |
|
407 | # Now that we have an instance, we can register it and update the | |
408 | # table of callables |
|
408 | # table of callables | |
409 | self.registry[m.__class__.__name__] = m |
|
409 | self.registry[m.__class__.__name__] = m | |
410 | for mtype in magic_kinds: |
|
410 | for mtype in magic_kinds: | |
411 | self.magics[mtype].update(m.magics[mtype]) |
|
411 | self.magics[mtype].update(m.magics[mtype]) | |
412 |
|
412 | |||
413 | def register_function(self, func, magic_kind='line', magic_name=None): |
|
413 | def register_function(self, func, magic_kind='line', magic_name=None): | |
414 | """Expose a standalone function as magic function for IPython. |
|
414 | """Expose a standalone function as magic function for IPython. | |
415 |
|
415 | |||
416 | This will create an IPython magic (line, cell or both) from a |
|
416 | This will create an IPython magic (line, cell or both) from a | |
417 | standalone function. The functions should have the following |
|
417 | standalone function. The functions should have the following | |
418 | signatures: |
|
418 | signatures: | |
419 |
|
419 | |||
420 | * For line magics: `def f(line)` |
|
420 | * For line magics: `def f(line)` | |
421 | * For cell magics: `def f(line, cell)` |
|
421 | * For cell magics: `def f(line, cell)` | |
422 | * For a function that does both: `def f(line, cell=None)` |
|
422 | * For a function that does both: `def f(line, cell=None)` | |
423 |
|
423 | |||
424 | In the latter case, the function will be called with `cell==None` when |
|
424 | In the latter case, the function will be called with `cell==None` when | |
425 | invoked as `%f`, and with cell as a string when invoked as `%%f`. |
|
425 | invoked as `%f`, and with cell as a string when invoked as `%%f`. | |
426 |
|
426 | |||
427 | Parameters |
|
427 | Parameters | |
428 | ---------- |
|
428 | ---------- | |
429 | func : callable |
|
429 | func : callable | |
430 | Function to be registered as a magic. |
|
430 | Function to be registered as a magic. | |
431 |
|
431 | |||
432 | magic_kind : str |
|
432 | magic_kind : str | |
433 | Kind of magic, one of 'line', 'cell' or 'line_cell' |
|
433 | Kind of magic, one of 'line', 'cell' or 'line_cell' | |
434 |
|
434 | |||
435 | magic_name : optional str |
|
435 | magic_name : optional str | |
436 | If given, the name the magic will have in the IPython namespace. By |
|
436 | If given, the name the magic will have in the IPython namespace. By | |
437 | default, the name of the function itself is used. |
|
437 | default, the name of the function itself is used. | |
438 | """ |
|
438 | """ | |
439 |
|
439 | |||
440 | # Create the new method in the user_magics and register it in the |
|
440 | # Create the new method in the user_magics and register it in the | |
441 | # global table |
|
441 | # global table | |
442 | validate_type(magic_kind) |
|
442 | validate_type(magic_kind) | |
443 | magic_name = func.__name__ if magic_name is None else magic_name |
|
443 | magic_name = func.__name__ if magic_name is None else magic_name | |
444 | setattr(self.user_magics, magic_name, func) |
|
444 | setattr(self.user_magics, magic_name, func) | |
445 | record_magic(self.magics, magic_kind, magic_name, func) |
|
445 | record_magic(self.magics, magic_kind, magic_name, func) | |
446 |
|
446 | |||
447 | def register_alias(self, alias_name, magic_name, magic_kind='line', magic_params=None): |
|
447 | def register_alias(self, alias_name, magic_name, magic_kind='line', magic_params=None): | |
448 | """Register an alias to a magic function. |
|
448 | """Register an alias to a magic function. | |
449 |
|
449 | |||
450 | The alias is an instance of :class:`MagicAlias`, which holds the |
|
450 | The alias is an instance of :class:`MagicAlias`, which holds the | |
451 | name and kind of the magic it should call. Binding is done at |
|
451 | name and kind of the magic it should call. Binding is done at | |
452 | call time, so if the underlying magic function is changed the alias |
|
452 | call time, so if the underlying magic function is changed the alias | |
453 | will call the new function. |
|
453 | will call the new function. | |
454 |
|
454 | |||
455 | Parameters |
|
455 | Parameters | |
456 | ---------- |
|
456 | ---------- | |
457 | alias_name : str |
|
457 | alias_name : str | |
458 | The name of the magic to be registered. |
|
458 | The name of the magic to be registered. | |
459 |
|
459 | |||
460 | magic_name : str |
|
460 | magic_name : str | |
461 | The name of an existing magic. |
|
461 | The name of an existing magic. | |
462 |
|
462 | |||
463 | magic_kind : str |
|
463 | magic_kind : str | |
464 | Kind of magic, one of 'line' or 'cell' |
|
464 | Kind of magic, one of 'line' or 'cell' | |
465 | """ |
|
465 | """ | |
466 |
|
466 | |||
467 | # `validate_type` is too permissive, as it allows 'line_cell' |
|
467 | # `validate_type` is too permissive, as it allows 'line_cell' | |
468 | # which we do not handle. |
|
468 | # which we do not handle. | |
469 | if magic_kind not in magic_kinds: |
|
469 | if magic_kind not in magic_kinds: | |
470 | raise ValueError('magic_kind must be one of %s, %s given' % |
|
470 | raise ValueError('magic_kind must be one of %s, %s given' % | |
471 | magic_kinds, magic_kind) |
|
471 | magic_kinds, magic_kind) | |
472 |
|
472 | |||
473 | alias = MagicAlias(self.shell, magic_name, magic_kind, magic_params) |
|
473 | alias = MagicAlias(self.shell, magic_name, magic_kind, magic_params) | |
474 | setattr(self.user_magics, alias_name, alias) |
|
474 | setattr(self.user_magics, alias_name, alias) | |
475 | record_magic(self.magics, magic_kind, alias_name, alias) |
|
475 | record_magic(self.magics, magic_kind, alias_name, alias) | |
476 |
|
476 | |||
477 | # Key base class that provides the central functionality for magics. |
|
477 | # Key base class that provides the central functionality for magics. | |
478 |
|
478 | |||
479 |
|
479 | |||
480 | class Magics(Configurable): |
|
480 | class Magics(Configurable): | |
481 | """Base class for implementing magic functions. |
|
481 | """Base class for implementing magic functions. | |
482 |
|
482 | |||
483 | Shell functions which can be reached as %function_name. All magic |
|
483 | Shell functions which can be reached as %function_name. All magic | |
484 | functions should accept a string, which they can parse for their own |
|
484 | functions should accept a string, which they can parse for their own | |
485 | needs. This can make some functions easier to type, eg `%cd ../` |
|
485 | needs. This can make some functions easier to type, eg `%cd ../` | |
486 | vs. `%cd("../")` |
|
486 | vs. `%cd("../")` | |
487 |
|
487 | |||
488 | Classes providing magic functions need to subclass this class, and they |
|
488 | Classes providing magic functions need to subclass this class, and they | |
489 | MUST: |
|
489 | MUST: | |
490 |
|
490 | |||
491 | - Use the method decorators `@line_magic` and `@cell_magic` to decorate |
|
491 | - Use the method decorators `@line_magic` and `@cell_magic` to decorate | |
492 | individual methods as magic functions, AND |
|
492 | individual methods as magic functions, AND | |
493 |
|
493 | |||
494 | - Use the class decorator `@magics_class` to ensure that the magic |
|
494 | - Use the class decorator `@magics_class` to ensure that the magic | |
495 | methods are properly registered at the instance level upon instance |
|
495 | methods are properly registered at the instance level upon instance | |
496 | initialization. |
|
496 | initialization. | |
497 |
|
497 | |||
498 | See :mod:`magic_functions` for examples of actual implementation classes. |
|
498 | See :mod:`magic_functions` for examples of actual implementation classes. | |
499 | """ |
|
499 | """ | |
500 | # Dict holding all command-line options for each magic. |
|
500 | # Dict holding all command-line options for each magic. | |
501 | options_table = None |
|
501 | options_table = None | |
502 | # Dict for the mapping of magic names to methods, set by class decorator |
|
502 | # Dict for the mapping of magic names to methods, set by class decorator | |
503 | magics = None |
|
503 | magics = None | |
504 | # Flag to check that the class decorator was properly applied |
|
504 | # Flag to check that the class decorator was properly applied | |
505 | registered = False |
|
505 | registered = False | |
506 | # Instance of IPython shell |
|
506 | # Instance of IPython shell | |
507 | shell = None |
|
507 | shell = None | |
508 |
|
508 | |||
509 | def __init__(self, shell=None, **kwargs): |
|
509 | def __init__(self, shell=None, **kwargs): | |
510 | if not(self.__class__.registered): |
|
510 | if not(self.__class__.registered): | |
511 | raise ValueError('Magics subclass without registration - ' |
|
511 | raise ValueError('Magics subclass without registration - ' | |
512 | 'did you forget to apply @magics_class?') |
|
512 | 'did you forget to apply @magics_class?') | |
513 | if shell is not None: |
|
513 | if shell is not None: | |
514 | if hasattr(shell, 'configurables'): |
|
514 | if hasattr(shell, 'configurables'): | |
515 | shell.configurables.append(self) |
|
515 | shell.configurables.append(self) | |
516 | if hasattr(shell, 'config'): |
|
516 | if hasattr(shell, 'config'): | |
517 | kwargs.setdefault('parent', shell) |
|
517 | kwargs.setdefault('parent', shell) | |
518 |
|
518 | |||
519 | self.shell = shell |
|
519 | self.shell = shell | |
520 | self.options_table = {} |
|
520 | self.options_table = {} | |
521 | # The method decorators are run when the instance doesn't exist yet, so |
|
521 | # The method decorators are run when the instance doesn't exist yet, so | |
522 | # they can only record the names of the methods they are supposed to |
|
522 | # they can only record the names of the methods they are supposed to | |
523 | # grab. Only now, that the instance exists, can we create the proper |
|
523 | # grab. Only now, that the instance exists, can we create the proper | |
524 | # mapping to bound methods. So we read the info off the original names |
|
524 | # mapping to bound methods. So we read the info off the original names | |
525 | # table and replace each method name by the actual bound method. |
|
525 | # table and replace each method name by the actual bound method. | |
526 | # But we mustn't clobber the *class* mapping, in case of multiple instances. |
|
526 | # But we mustn't clobber the *class* mapping, in case of multiple instances. | |
527 | class_magics = self.magics |
|
527 | class_magics = self.magics | |
528 | self.magics = {} |
|
528 | self.magics = {} | |
529 | for mtype in magic_kinds: |
|
529 | for mtype in magic_kinds: | |
530 | tab = self.magics[mtype] = {} |
|
530 | tab = self.magics[mtype] = {} | |
531 | cls_tab = class_magics[mtype] |
|
531 | cls_tab = class_magics[mtype] | |
532 | for magic_name, meth_name in cls_tab.items(): |
|
532 | for magic_name, meth_name in cls_tab.items(): | |
533 | if isinstance(meth_name, str): |
|
533 | if isinstance(meth_name, str): | |
534 | # it's a method name, grab it |
|
534 | # it's a method name, grab it | |
535 | tab[magic_name] = getattr(self, meth_name) |
|
535 | tab[magic_name] = getattr(self, meth_name) | |
536 | else: |
|
536 | else: | |
537 | # it's the real thing |
|
537 | # it's the real thing | |
538 | tab[magic_name] = meth_name |
|
538 | tab[magic_name] = meth_name | |
539 | # Configurable **needs** to be initiated at the end or the config |
|
539 | # Configurable **needs** to be initiated at the end or the config | |
540 | # magics get screwed up. |
|
540 | # magics get screwed up. | |
541 | super(Magics, self).__init__(**kwargs) |
|
541 | super(Magics, self).__init__(**kwargs) | |
542 |
|
542 | |||
543 | def arg_err(self,func): |
|
543 | def arg_err(self,func): | |
544 | """Print docstring if incorrect arguments were passed""" |
|
544 | """Print docstring if incorrect arguments were passed""" | |
545 | print('Error in arguments:') |
|
545 | print('Error in arguments:') | |
546 | print(oinspect.getdoc(func)) |
|
546 | print(oinspect.getdoc(func)) | |
547 |
|
547 | |||
548 | def format_latex(self, strng): |
|
548 | def format_latex(self, strng): | |
549 | """Format a string for latex inclusion.""" |
|
549 | """Format a string for latex inclusion.""" | |
550 |
|
550 | |||
551 | # Characters that need to be escaped for latex: |
|
551 | # Characters that need to be escaped for latex: | |
552 | escape_re = re.compile(r'(%|_|\$|#|&)',re.MULTILINE) |
|
552 | escape_re = re.compile(r'(%|_|\$|#|&)',re.MULTILINE) | |
553 | # Magic command names as headers: |
|
553 | # Magic command names as headers: | |
554 | cmd_name_re = re.compile(r'^(%s.*?):' % ESC_MAGIC, |
|
554 | cmd_name_re = re.compile(r'^(%s.*?):' % ESC_MAGIC, | |
555 | re.MULTILINE) |
|
555 | re.MULTILINE) | |
556 | # Magic commands |
|
556 | # Magic commands | |
557 | cmd_re = re.compile(r'(?P<cmd>%s.+?\b)(?!\}\}:)' % ESC_MAGIC, |
|
557 | cmd_re = re.compile(r'(?P<cmd>%s.+?\b)(?!\}\}:)' % ESC_MAGIC, | |
558 | re.MULTILINE) |
|
558 | re.MULTILINE) | |
559 | # Paragraph continue |
|
559 | # Paragraph continue | |
560 | par_re = re.compile(r'\\$',re.MULTILINE) |
|
560 | par_re = re.compile(r'\\$',re.MULTILINE) | |
561 |
|
561 | |||
562 | # The "\n" symbol |
|
562 | # The "\n" symbol | |
563 | newline_re = re.compile(r'\\n') |
|
563 | newline_re = re.compile(r'\\n') | |
564 |
|
564 | |||
565 | # Now build the string for output: |
|
565 | # Now build the string for output: | |
566 | #strng = cmd_name_re.sub(r'\n\\texttt{\\textsl{\\large \1}}:',strng) |
|
566 | #strng = cmd_name_re.sub(r'\n\\texttt{\\textsl{\\large \1}}:',strng) | |
567 | strng = cmd_name_re.sub(r'\n\\bigskip\n\\texttt{\\textbf{ \1}}:', |
|
567 | strng = cmd_name_re.sub(r'\n\\bigskip\n\\texttt{\\textbf{ \1}}:', | |
568 | strng) |
|
568 | strng) | |
569 | strng = cmd_re.sub(r'\\texttt{\g<cmd>}',strng) |
|
569 | strng = cmd_re.sub(r'\\texttt{\g<cmd>}',strng) | |
570 | strng = par_re.sub(r'\\\\',strng) |
|
570 | strng = par_re.sub(r'\\\\',strng) | |
571 | strng = escape_re.sub(r'\\\1',strng) |
|
571 | strng = escape_re.sub(r'\\\1',strng) | |
572 | strng = newline_re.sub(r'\\textbackslash{}n',strng) |
|
572 | strng = newline_re.sub(r'\\textbackslash{}n',strng) | |
573 | return strng |
|
573 | return strng | |
574 |
|
574 | |||
575 | def parse_options(self, arg_str, opt_str, *long_opts, **kw): |
|
575 | def parse_options(self, arg_str, opt_str, *long_opts, **kw): | |
576 | """Parse options passed to an argument string. |
|
576 | """Parse options passed to an argument string. | |
577 |
|
577 | |||
578 | The interface is similar to that of :func:`getopt.getopt`, but it |
|
578 | The interface is similar to that of :func:`getopt.getopt`, but it | |
579 | returns a :class:`~IPython.utils.struct.Struct` with the options as keys |
|
579 | returns a :class:`~IPython.utils.struct.Struct` with the options as keys | |
580 | and the stripped argument string still as a string. |
|
580 | and the stripped argument string still as a string. | |
581 |
|
581 | |||
582 | arg_str is quoted as a true sys.argv vector by using shlex.split. |
|
582 | arg_str is quoted as a true sys.argv vector by using shlex.split. | |
583 | This allows us to easily expand variables, glob files, quote |
|
583 | This allows us to easily expand variables, glob files, quote | |
584 | arguments, etc. |
|
584 | arguments, etc. | |
585 |
|
585 | |||
586 | Parameters |
|
586 | Parameters | |
587 | ---------- |
|
587 | ---------- | |
588 |
|
588 | |||
589 | arg_str : str |
|
589 | arg_str : str | |
590 | The arguments to parse. |
|
590 | The arguments to parse. | |
591 |
|
591 | |||
592 | opt_str : str |
|
592 | opt_str : str | |
593 | The options specification. |
|
593 | The options specification. | |
594 |
|
594 | |||
595 | mode : str, default 'string' |
|
595 | mode : str, default 'string' | |
596 | If given as 'list', the argument string is returned as a list (split |
|
596 | If given as 'list', the argument string is returned as a list (split | |
597 | on whitespace) instead of a string. |
|
597 | on whitespace) instead of a string. | |
598 |
|
598 | |||
599 | list_all : bool, default False |
|
599 | list_all : bool, default False | |
600 | Put all option values in lists. Normally only options |
|
600 | Put all option values in lists. Normally only options | |
601 | appearing more than once are put in a list. |
|
601 | appearing more than once are put in a list. | |
602 |
|
602 | |||
603 | posix : bool, default True |
|
603 | posix : bool, default True | |
604 | Whether to split the input line in POSIX mode or not, as per the |
|
604 | Whether to split the input line in POSIX mode or not, as per the | |
605 | conventions outlined in the :mod:`shlex` module from the standard |
|
605 | conventions outlined in the :mod:`shlex` module from the standard | |
606 | library. |
|
606 | library. | |
607 | """ |
|
607 | """ | |
608 |
|
608 | |||
609 | # inject default options at the beginning of the input line |
|
609 | # inject default options at the beginning of the input line | |
610 | caller = sys._getframe(1).f_code.co_name |
|
610 | caller = sys._getframe(1).f_code.co_name | |
611 | arg_str = '%s %s' % (self.options_table.get(caller,''),arg_str) |
|
611 | arg_str = '%s %s' % (self.options_table.get(caller,''),arg_str) | |
612 |
|
612 | |||
613 | mode = kw.get('mode','string') |
|
613 | mode = kw.get('mode','string') | |
614 | if mode not in ['string','list']: |
|
614 | if mode not in ['string','list']: | |
615 | raise ValueError('incorrect mode given: %s' % mode) |
|
615 | raise ValueError('incorrect mode given: %s' % mode) | |
616 | # Get options |
|
616 | # Get options | |
617 | list_all = kw.get('list_all',0) |
|
617 | list_all = kw.get('list_all',0) | |
618 | posix = kw.get('posix', os.name == 'posix') |
|
618 | posix = kw.get('posix', os.name == 'posix') | |
619 | strict = kw.get('strict', True) |
|
619 | strict = kw.get('strict', True) | |
620 |
|
620 | |||
|
621 | preserve_non_opts = kw.get("preserve_non_opts", False) | |||
|
622 | remainder_arg_str = arg_str | |||
|
623 | ||||
621 | # Check if we have more than one argument to warrant extra processing: |
|
624 | # Check if we have more than one argument to warrant extra processing: | |
622 | odict = {} # Dictionary with options |
|
625 | odict = {} # Dictionary with options | |
623 | args = arg_str.split() |
|
626 | args = arg_str.split() | |
624 | if len(args) >= 1: |
|
627 | if len(args) >= 1: | |
625 | # If the list of inputs only has 0 or 1 thing in it, there's no |
|
628 | # If the list of inputs only has 0 or 1 thing in it, there's no | |
626 | # need to look for options |
|
629 | # need to look for options | |
627 | argv = arg_split(arg_str, posix, strict) |
|
630 | argv = arg_split(arg_str, posix, strict) | |
628 | # Do regular option processing |
|
631 | # Do regular option processing | |
629 | try: |
|
632 | try: | |
630 | opts,args = getopt(argv, opt_str, long_opts) |
|
633 | opts,args = getopt(argv, opt_str, long_opts) | |
631 | except GetoptError as e: |
|
634 | except GetoptError as e: | |
632 |
raise UsageError( |
|
635 | raise UsageError( | |
633 |
|
|
636 | '%s ( allowed: "%s" %s)' % (e.msg, opt_str, " ".join(long_opts)) | |
634 | for o,a in opts: |
|
637 | ) from e | |
635 |
|
|
638 | for o, a in opts: | |
|
639 | if mode is "string" and preserve_non_opts: | |||
|
640 | # remove option-parts from the original args-string and preserve remaining-part. | |||
|
641 | # This relies on the arg_split(...) and getopt(...)'s impl spec, that the parsed options are | |||
|
642 | # returned in the original order. | |||
|
643 | remainder_arg_str = remainder_arg_str.replace(o, "", 1).replace( | |||
|
644 | a, "", 1 | |||
|
645 | ) | |||
|
646 | if o.startswith("--"): | |||
636 | o = o[2:] |
|
647 | o = o[2:] | |
637 | else: |
|
648 | else: | |
638 | o = o[1:] |
|
649 | o = o[1:] | |
639 | try: |
|
650 | try: | |
640 | odict[o].append(a) |
|
651 | odict[o].append(a) | |
641 | except AttributeError: |
|
652 | except AttributeError: | |
642 | odict[o] = [odict[o],a] |
|
653 | odict[o] = [odict[o],a] | |
643 | except KeyError: |
|
654 | except KeyError: | |
644 | if list_all: |
|
655 | if list_all: | |
645 | odict[o] = [a] |
|
656 | odict[o] = [a] | |
646 | else: |
|
657 | else: | |
647 | odict[o] = a |
|
658 | odict[o] = a | |
648 |
|
659 | |||
649 | # Prepare opts,args for return |
|
660 | # Prepare opts,args for return | |
650 | opts = Struct(odict) |
|
661 | opts = Struct(odict) | |
651 | if mode == 'string': |
|
662 | if mode == 'string': | |
652 | args = ' '.join(args) |
|
663 | if preserve_non_opts: | |
|
664 | args = remainder_arg_str.lstrip() | |||
|
665 | else: | |||
|
666 | args = " ".join(args) | |||
653 |
|
667 | |||
654 | return opts,args |
|
668 | return opts,args | |
655 |
|
669 | |||
656 | def default_option(self, fn, optstr): |
|
670 | def default_option(self, fn, optstr): | |
657 | """Make an entry in the options_table for fn, with value optstr""" |
|
671 | """Make an entry in the options_table for fn, with value optstr""" | |
658 |
|
672 | |||
659 | if fn not in self.lsmagic(): |
|
673 | if fn not in self.lsmagic(): | |
660 | error("%s is not a magic function" % fn) |
|
674 | error("%s is not a magic function" % fn) | |
661 | self.options_table[fn] = optstr |
|
675 | self.options_table[fn] = optstr | |
662 |
|
676 | |||
663 |
|
677 | |||
664 | class MagicAlias(object): |
|
678 | class MagicAlias(object): | |
665 | """An alias to another magic function. |
|
679 | """An alias to another magic function. | |
666 |
|
680 | |||
667 | An alias is determined by its magic name and magic kind. Lookup |
|
681 | An alias is determined by its magic name and magic kind. Lookup | |
668 | is done at call time, so if the underlying magic changes the alias |
|
682 | is done at call time, so if the underlying magic changes the alias | |
669 | will call the new function. |
|
683 | will call the new function. | |
670 |
|
684 | |||
671 | Use the :meth:`MagicsManager.register_alias` method or the |
|
685 | Use the :meth:`MagicsManager.register_alias` method or the | |
672 | `%alias_magic` magic function to create and register a new alias. |
|
686 | `%alias_magic` magic function to create and register a new alias. | |
673 | """ |
|
687 | """ | |
674 | def __init__(self, shell, magic_name, magic_kind, magic_params=None): |
|
688 | def __init__(self, shell, magic_name, magic_kind, magic_params=None): | |
675 | self.shell = shell |
|
689 | self.shell = shell | |
676 | self.magic_name = magic_name |
|
690 | self.magic_name = magic_name | |
677 | self.magic_params = magic_params |
|
691 | self.magic_params = magic_params | |
678 | self.magic_kind = magic_kind |
|
692 | self.magic_kind = magic_kind | |
679 |
|
693 | |||
680 | self.pretty_target = '%s%s' % (magic_escapes[self.magic_kind], self.magic_name) |
|
694 | self.pretty_target = '%s%s' % (magic_escapes[self.magic_kind], self.magic_name) | |
681 | self.__doc__ = "Alias for `%s`." % self.pretty_target |
|
695 | self.__doc__ = "Alias for `%s`." % self.pretty_target | |
682 |
|
696 | |||
683 | self._in_call = False |
|
697 | self._in_call = False | |
684 |
|
698 | |||
685 | def __call__(self, *args, **kwargs): |
|
699 | def __call__(self, *args, **kwargs): | |
686 | """Call the magic alias.""" |
|
700 | """Call the magic alias.""" | |
687 | fn = self.shell.find_magic(self.magic_name, self.magic_kind) |
|
701 | fn = self.shell.find_magic(self.magic_name, self.magic_kind) | |
688 | if fn is None: |
|
702 | if fn is None: | |
689 | raise UsageError("Magic `%s` not found." % self.pretty_target) |
|
703 | raise UsageError("Magic `%s` not found." % self.pretty_target) | |
690 |
|
704 | |||
691 | # Protect against infinite recursion. |
|
705 | # Protect against infinite recursion. | |
692 | if self._in_call: |
|
706 | if self._in_call: | |
693 | raise UsageError("Infinite recursion detected; " |
|
707 | raise UsageError("Infinite recursion detected; " | |
694 | "magic aliases cannot call themselves.") |
|
708 | "magic aliases cannot call themselves.") | |
695 | self._in_call = True |
|
709 | self._in_call = True | |
696 | try: |
|
710 | try: | |
697 | if self.magic_params: |
|
711 | if self.magic_params: | |
698 | args_list = list(args) |
|
712 | args_list = list(args) | |
699 | args_list[0] = self.magic_params + " " + args[0] |
|
713 | args_list[0] = self.magic_params + " " + args[0] | |
700 | args = tuple(args_list) |
|
714 | args = tuple(args_list) | |
701 | return fn(*args, **kwargs) |
|
715 | return fn(*args, **kwargs) | |
702 | finally: |
|
716 | finally: | |
703 | self._in_call = False |
|
717 | self._in_call = False |
@@ -1,1502 +1,1503 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """Implementation of execution-related magic functions.""" |
|
2 | """Implementation of execution-related magic functions.""" | |
3 |
|
3 | |||
4 | # Copyright (c) IPython Development Team. |
|
4 | # Copyright (c) IPython Development Team. | |
5 | # Distributed under the terms of the Modified BSD License. |
|
5 | # Distributed under the terms of the Modified BSD License. | |
6 |
|
6 | |||
7 |
|
7 | |||
8 | import ast |
|
8 | import ast | |
9 | import bdb |
|
9 | import bdb | |
10 | import builtins as builtin_mod |
|
10 | import builtins as builtin_mod | |
11 | import gc |
|
11 | import gc | |
12 | import itertools |
|
12 | import itertools | |
13 | import os |
|
13 | import os | |
14 | import shlex |
|
14 | import shlex | |
15 | import sys |
|
15 | import sys | |
16 | import time |
|
16 | import time | |
17 | import timeit |
|
17 | import timeit | |
18 | import math |
|
18 | import math | |
19 | import re |
|
19 | import re | |
20 | from pdb import Restart |
|
20 | from pdb import Restart | |
21 |
|
21 | |||
22 | import cProfile as profile |
|
22 | import cProfile as profile | |
23 | import pstats |
|
23 | import pstats | |
24 |
|
24 | |||
25 | from IPython.core import oinspect |
|
25 | from IPython.core import oinspect | |
26 | from IPython.core import magic_arguments |
|
26 | from IPython.core import magic_arguments | |
27 | from IPython.core import page |
|
27 | from IPython.core import page | |
28 | from IPython.core.error import UsageError |
|
28 | from IPython.core.error import UsageError | |
29 | from IPython.core.macro import Macro |
|
29 | from IPython.core.macro import Macro | |
30 | from IPython.core.magic import (Magics, magics_class, line_magic, cell_magic, |
|
30 | from IPython.core.magic import (Magics, magics_class, line_magic, cell_magic, | |
31 | line_cell_magic, on_off, needs_local_scope, |
|
31 | line_cell_magic, on_off, needs_local_scope, | |
32 | no_var_expand) |
|
32 | no_var_expand) | |
33 | from IPython.testing.skipdoctest import skip_doctest |
|
33 | from IPython.testing.skipdoctest import skip_doctest | |
34 | from IPython.utils.contexts import preserve_keys |
|
34 | from IPython.utils.contexts import preserve_keys | |
35 | from IPython.utils.capture import capture_output |
|
35 | from IPython.utils.capture import capture_output | |
36 | from IPython.utils.ipstruct import Struct |
|
36 | from IPython.utils.ipstruct import Struct | |
37 | from IPython.utils.module_paths import find_mod |
|
37 | from IPython.utils.module_paths import find_mod | |
38 | from IPython.utils.path import get_py_filename, shellglob |
|
38 | from IPython.utils.path import get_py_filename, shellglob | |
39 | from IPython.utils.timing import clock, clock2 |
|
39 | from IPython.utils.timing import clock, clock2 | |
40 | from warnings import warn |
|
40 | from warnings import warn | |
41 | from logging import error |
|
41 | from logging import error | |
42 | from pathlib import Path |
|
42 | from pathlib import Path | |
43 | from io import StringIO |
|
43 | from io import StringIO | |
44 | from pathlib import Path |
|
44 | from pathlib import Path | |
45 |
|
45 | |||
46 | if sys.version_info > (3,8): |
|
46 | if sys.version_info > (3,8): | |
47 | from ast import Module |
|
47 | from ast import Module | |
48 | else : |
|
48 | else : | |
49 | # mock the new API, ignore second argument |
|
49 | # mock the new API, ignore second argument | |
50 | # see https://github.com/ipython/ipython/issues/11590 |
|
50 | # see https://github.com/ipython/ipython/issues/11590 | |
51 | from ast import Module as OriginalModule |
|
51 | from ast import Module as OriginalModule | |
52 | Module = lambda nodelist, type_ignores: OriginalModule(nodelist) |
|
52 | Module = lambda nodelist, type_ignores: OriginalModule(nodelist) | |
53 |
|
53 | |||
54 |
|
54 | |||
55 | #----------------------------------------------------------------------------- |
|
55 | #----------------------------------------------------------------------------- | |
56 | # Magic implementation classes |
|
56 | # Magic implementation classes | |
57 | #----------------------------------------------------------------------------- |
|
57 | #----------------------------------------------------------------------------- | |
58 |
|
58 | |||
59 |
|
59 | |||
60 | class TimeitResult(object): |
|
60 | class TimeitResult(object): | |
61 | """ |
|
61 | """ | |
62 | Object returned by the timeit magic with info about the run. |
|
62 | Object returned by the timeit magic with info about the run. | |
63 |
|
63 | |||
64 | Contains the following attributes : |
|
64 | Contains the following attributes : | |
65 |
|
65 | |||
66 | loops: (int) number of loops done per measurement |
|
66 | loops: (int) number of loops done per measurement | |
67 | repeat: (int) number of times the measurement has been repeated |
|
67 | repeat: (int) number of times the measurement has been repeated | |
68 | best: (float) best execution time / number |
|
68 | best: (float) best execution time / number | |
69 | all_runs: (list of float) execution time of each run (in s) |
|
69 | all_runs: (list of float) execution time of each run (in s) | |
70 | compile_time: (float) time of statement compilation (s) |
|
70 | compile_time: (float) time of statement compilation (s) | |
71 |
|
71 | |||
72 | """ |
|
72 | """ | |
73 | def __init__(self, loops, repeat, best, worst, all_runs, compile_time, precision): |
|
73 | def __init__(self, loops, repeat, best, worst, all_runs, compile_time, precision): | |
74 | self.loops = loops |
|
74 | self.loops = loops | |
75 | self.repeat = repeat |
|
75 | self.repeat = repeat | |
76 | self.best = best |
|
76 | self.best = best | |
77 | self.worst = worst |
|
77 | self.worst = worst | |
78 | self.all_runs = all_runs |
|
78 | self.all_runs = all_runs | |
79 | self.compile_time = compile_time |
|
79 | self.compile_time = compile_time | |
80 | self._precision = precision |
|
80 | self._precision = precision | |
81 | self.timings = [ dt / self.loops for dt in all_runs] |
|
81 | self.timings = [ dt / self.loops for dt in all_runs] | |
82 |
|
82 | |||
83 | @property |
|
83 | @property | |
84 | def average(self): |
|
84 | def average(self): | |
85 | return math.fsum(self.timings) / len(self.timings) |
|
85 | return math.fsum(self.timings) / len(self.timings) | |
86 |
|
86 | |||
87 | @property |
|
87 | @property | |
88 | def stdev(self): |
|
88 | def stdev(self): | |
89 | mean = self.average |
|
89 | mean = self.average | |
90 | return (math.fsum([(x - mean) ** 2 for x in self.timings]) / len(self.timings)) ** 0.5 |
|
90 | return (math.fsum([(x - mean) ** 2 for x in self.timings]) / len(self.timings)) ** 0.5 | |
91 |
|
91 | |||
92 | def __str__(self): |
|
92 | def __str__(self): | |
93 | pm = '+-' |
|
93 | pm = '+-' | |
94 | if hasattr(sys.stdout, 'encoding') and sys.stdout.encoding: |
|
94 | if hasattr(sys.stdout, 'encoding') and sys.stdout.encoding: | |
95 | try: |
|
95 | try: | |
96 | u'\xb1'.encode(sys.stdout.encoding) |
|
96 | u'\xb1'.encode(sys.stdout.encoding) | |
97 | pm = u'\xb1' |
|
97 | pm = u'\xb1' | |
98 | except: |
|
98 | except: | |
99 | pass |
|
99 | pass | |
100 | return ( |
|
100 | return ( | |
101 | u"{mean} {pm} {std} per loop (mean {pm} std. dev. of {runs} run{run_plural}, {loops} loop{loop_plural} each)" |
|
101 | u"{mean} {pm} {std} per loop (mean {pm} std. dev. of {runs} run{run_plural}, {loops} loop{loop_plural} each)" | |
102 | .format( |
|
102 | .format( | |
103 | pm = pm, |
|
103 | pm = pm, | |
104 | runs = self.repeat, |
|
104 | runs = self.repeat, | |
105 | loops = self.loops, |
|
105 | loops = self.loops, | |
106 | loop_plural = "" if self.loops == 1 else "s", |
|
106 | loop_plural = "" if self.loops == 1 else "s", | |
107 | run_plural = "" if self.repeat == 1 else "s", |
|
107 | run_plural = "" if self.repeat == 1 else "s", | |
108 | mean = _format_time(self.average, self._precision), |
|
108 | mean = _format_time(self.average, self._precision), | |
109 | std = _format_time(self.stdev, self._precision)) |
|
109 | std = _format_time(self.stdev, self._precision)) | |
110 | ) |
|
110 | ) | |
111 |
|
111 | |||
112 | def _repr_pretty_(self, p , cycle): |
|
112 | def _repr_pretty_(self, p , cycle): | |
113 | unic = self.__str__() |
|
113 | unic = self.__str__() | |
114 | p.text(u'<TimeitResult : '+unic+u'>') |
|
114 | p.text(u'<TimeitResult : '+unic+u'>') | |
115 |
|
115 | |||
116 |
|
116 | |||
117 | class TimeitTemplateFiller(ast.NodeTransformer): |
|
117 | class TimeitTemplateFiller(ast.NodeTransformer): | |
118 | """Fill in the AST template for timing execution. |
|
118 | """Fill in the AST template for timing execution. | |
119 |
|
119 | |||
120 | This is quite closely tied to the template definition, which is in |
|
120 | This is quite closely tied to the template definition, which is in | |
121 | :meth:`ExecutionMagics.timeit`. |
|
121 | :meth:`ExecutionMagics.timeit`. | |
122 | """ |
|
122 | """ | |
123 | def __init__(self, ast_setup, ast_stmt): |
|
123 | def __init__(self, ast_setup, ast_stmt): | |
124 | self.ast_setup = ast_setup |
|
124 | self.ast_setup = ast_setup | |
125 | self.ast_stmt = ast_stmt |
|
125 | self.ast_stmt = ast_stmt | |
126 |
|
126 | |||
127 | def visit_FunctionDef(self, node): |
|
127 | def visit_FunctionDef(self, node): | |
128 | "Fill in the setup statement" |
|
128 | "Fill in the setup statement" | |
129 | self.generic_visit(node) |
|
129 | self.generic_visit(node) | |
130 | if node.name == "inner": |
|
130 | if node.name == "inner": | |
131 | node.body[:1] = self.ast_setup.body |
|
131 | node.body[:1] = self.ast_setup.body | |
132 |
|
132 | |||
133 | return node |
|
133 | return node | |
134 |
|
134 | |||
135 | def visit_For(self, node): |
|
135 | def visit_For(self, node): | |
136 | "Fill in the statement to be timed" |
|
136 | "Fill in the statement to be timed" | |
137 | if getattr(getattr(node.body[0], 'value', None), 'id', None) == 'stmt': |
|
137 | if getattr(getattr(node.body[0], 'value', None), 'id', None) == 'stmt': | |
138 | node.body = self.ast_stmt.body |
|
138 | node.body = self.ast_stmt.body | |
139 | return node |
|
139 | return node | |
140 |
|
140 | |||
141 |
|
141 | |||
142 | class Timer(timeit.Timer): |
|
142 | class Timer(timeit.Timer): | |
143 | """Timer class that explicitly uses self.inner |
|
143 | """Timer class that explicitly uses self.inner | |
144 |
|
144 | |||
145 | which is an undocumented implementation detail of CPython, |
|
145 | which is an undocumented implementation detail of CPython, | |
146 | not shared by PyPy. |
|
146 | not shared by PyPy. | |
147 | """ |
|
147 | """ | |
148 | # Timer.timeit copied from CPython 3.4.2 |
|
148 | # Timer.timeit copied from CPython 3.4.2 | |
149 | def timeit(self, number=timeit.default_number): |
|
149 | def timeit(self, number=timeit.default_number): | |
150 | """Time 'number' executions of the main statement. |
|
150 | """Time 'number' executions of the main statement. | |
151 |
|
151 | |||
152 | To be precise, this executes the setup statement once, and |
|
152 | To be precise, this executes the setup statement once, and | |
153 | then returns the time it takes to execute the main statement |
|
153 | then returns the time it takes to execute the main statement | |
154 | a number of times, as a float measured in seconds. The |
|
154 | a number of times, as a float measured in seconds. The | |
155 | argument is the number of times through the loop, defaulting |
|
155 | argument is the number of times through the loop, defaulting | |
156 | to one million. The main statement, the setup statement and |
|
156 | to one million. The main statement, the setup statement and | |
157 | the timer function to be used are passed to the constructor. |
|
157 | the timer function to be used are passed to the constructor. | |
158 | """ |
|
158 | """ | |
159 | it = itertools.repeat(None, number) |
|
159 | it = itertools.repeat(None, number) | |
160 | gcold = gc.isenabled() |
|
160 | gcold = gc.isenabled() | |
161 | gc.disable() |
|
161 | gc.disable() | |
162 | try: |
|
162 | try: | |
163 | timing = self.inner(it, self.timer) |
|
163 | timing = self.inner(it, self.timer) | |
164 | finally: |
|
164 | finally: | |
165 | if gcold: |
|
165 | if gcold: | |
166 | gc.enable() |
|
166 | gc.enable() | |
167 | return timing |
|
167 | return timing | |
168 |
|
168 | |||
169 |
|
169 | |||
170 | @magics_class |
|
170 | @magics_class | |
171 | class ExecutionMagics(Magics): |
|
171 | class ExecutionMagics(Magics): | |
172 | """Magics related to code execution, debugging, profiling, etc. |
|
172 | """Magics related to code execution, debugging, profiling, etc. | |
173 |
|
173 | |||
174 | """ |
|
174 | """ | |
175 |
|
175 | |||
176 | def __init__(self, shell): |
|
176 | def __init__(self, shell): | |
177 | super(ExecutionMagics, self).__init__(shell) |
|
177 | super(ExecutionMagics, self).__init__(shell) | |
178 | # Default execution function used to actually run user code. |
|
178 | # Default execution function used to actually run user code. | |
179 | self.default_runner = None |
|
179 | self.default_runner = None | |
180 |
|
180 | |||
181 | @skip_doctest |
|
181 | @skip_doctest | |
182 | @no_var_expand |
|
182 | @no_var_expand | |
183 | @line_cell_magic |
|
183 | @line_cell_magic | |
184 | def prun(self, parameter_s='', cell=None): |
|
184 | def prun(self, parameter_s='', cell=None): | |
185 |
|
185 | |||
186 | """Run a statement through the python code profiler. |
|
186 | """Run a statement through the python code profiler. | |
187 |
|
187 | |||
188 | Usage, in line mode: |
|
188 | Usage, in line mode: | |
189 | %prun [options] statement |
|
189 | %prun [options] statement | |
190 |
|
190 | |||
191 | Usage, in cell mode: |
|
191 | Usage, in cell mode: | |
192 | %%prun [options] [statement] |
|
192 | %%prun [options] [statement] | |
193 | code... |
|
193 | code... | |
194 | code... |
|
194 | code... | |
195 |
|
195 | |||
196 | In cell mode, the additional code lines are appended to the (possibly |
|
196 | In cell mode, the additional code lines are appended to the (possibly | |
197 | empty) statement in the first line. Cell mode allows you to easily |
|
197 | empty) statement in the first line. Cell mode allows you to easily | |
198 | profile multiline blocks without having to put them in a separate |
|
198 | profile multiline blocks without having to put them in a separate | |
199 | function. |
|
199 | function. | |
200 |
|
200 | |||
201 | The given statement (which doesn't require quote marks) is run via the |
|
201 | The given statement (which doesn't require quote marks) is run via the | |
202 | python profiler in a manner similar to the profile.run() function. |
|
202 | python profiler in a manner similar to the profile.run() function. | |
203 | Namespaces are internally managed to work correctly; profile.run |
|
203 | Namespaces are internally managed to work correctly; profile.run | |
204 | cannot be used in IPython because it makes certain assumptions about |
|
204 | cannot be used in IPython because it makes certain assumptions about | |
205 | namespaces which do not hold under IPython. |
|
205 | namespaces which do not hold under IPython. | |
206 |
|
206 | |||
207 | Options: |
|
207 | Options: | |
208 |
|
208 | |||
209 | -l <limit> |
|
209 | -l <limit> | |
210 | you can place restrictions on what or how much of the |
|
210 | you can place restrictions on what or how much of the | |
211 | profile gets printed. The limit value can be: |
|
211 | profile gets printed. The limit value can be: | |
212 |
|
212 | |||
213 | * A string: only information for function names containing this string |
|
213 | * A string: only information for function names containing this string | |
214 | is printed. |
|
214 | is printed. | |
215 |
|
215 | |||
216 | * An integer: only these many lines are printed. |
|
216 | * An integer: only these many lines are printed. | |
217 |
|
217 | |||
218 | * A float (between 0 and 1): this fraction of the report is printed |
|
218 | * A float (between 0 and 1): this fraction of the report is printed | |
219 | (for example, use a limit of 0.4 to see the topmost 40% only). |
|
219 | (for example, use a limit of 0.4 to see the topmost 40% only). | |
220 |
|
220 | |||
221 | You can combine several limits with repeated use of the option. For |
|
221 | You can combine several limits with repeated use of the option. For | |
222 | example, ``-l __init__ -l 5`` will print only the topmost 5 lines of |
|
222 | example, ``-l __init__ -l 5`` will print only the topmost 5 lines of | |
223 | information about class constructors. |
|
223 | information about class constructors. | |
224 |
|
224 | |||
225 | -r |
|
225 | -r | |
226 | return the pstats.Stats object generated by the profiling. This |
|
226 | return the pstats.Stats object generated by the profiling. This | |
227 | object has all the information about the profile in it, and you can |
|
227 | object has all the information about the profile in it, and you can | |
228 | later use it for further analysis or in other functions. |
|
228 | later use it for further analysis or in other functions. | |
229 |
|
229 | |||
230 | -s <key> |
|
230 | -s <key> | |
231 | sort profile by given key. You can provide more than one key |
|
231 | sort profile by given key. You can provide more than one key | |
232 | by using the option several times: '-s key1 -s key2 -s key3...'. The |
|
232 | by using the option several times: '-s key1 -s key2 -s key3...'. The | |
233 | default sorting key is 'time'. |
|
233 | default sorting key is 'time'. | |
234 |
|
234 | |||
235 | The following is copied verbatim from the profile documentation |
|
235 | The following is copied verbatim from the profile documentation | |
236 | referenced below: |
|
236 | referenced below: | |
237 |
|
237 | |||
238 | When more than one key is provided, additional keys are used as |
|
238 | When more than one key is provided, additional keys are used as | |
239 | secondary criteria when the there is equality in all keys selected |
|
239 | secondary criteria when the there is equality in all keys selected | |
240 | before them. |
|
240 | before them. | |
241 |
|
241 | |||
242 | Abbreviations can be used for any key names, as long as the |
|
242 | Abbreviations can be used for any key names, as long as the | |
243 | abbreviation is unambiguous. The following are the keys currently |
|
243 | abbreviation is unambiguous. The following are the keys currently | |
244 | defined: |
|
244 | defined: | |
245 |
|
245 | |||
246 | ============ ===================== |
|
246 | ============ ===================== | |
247 | Valid Arg Meaning |
|
247 | Valid Arg Meaning | |
248 | ============ ===================== |
|
248 | ============ ===================== | |
249 | "calls" call count |
|
249 | "calls" call count | |
250 | "cumulative" cumulative time |
|
250 | "cumulative" cumulative time | |
251 | "file" file name |
|
251 | "file" file name | |
252 | "module" file name |
|
252 | "module" file name | |
253 | "pcalls" primitive call count |
|
253 | "pcalls" primitive call count | |
254 | "line" line number |
|
254 | "line" line number | |
255 | "name" function name |
|
255 | "name" function name | |
256 | "nfl" name/file/line |
|
256 | "nfl" name/file/line | |
257 | "stdname" standard name |
|
257 | "stdname" standard name | |
258 | "time" internal time |
|
258 | "time" internal time | |
259 | ============ ===================== |
|
259 | ============ ===================== | |
260 |
|
260 | |||
261 | Note that all sorts on statistics are in descending order (placing |
|
261 | Note that all sorts on statistics are in descending order (placing | |
262 | most time consuming items first), where as name, file, and line number |
|
262 | most time consuming items first), where as name, file, and line number | |
263 | searches are in ascending order (i.e., alphabetical). The subtle |
|
263 | searches are in ascending order (i.e., alphabetical). The subtle | |
264 | distinction between "nfl" and "stdname" is that the standard name is a |
|
264 | distinction between "nfl" and "stdname" is that the standard name is a | |
265 | sort of the name as printed, which means that the embedded line |
|
265 | sort of the name as printed, which means that the embedded line | |
266 | numbers get compared in an odd way. For example, lines 3, 20, and 40 |
|
266 | numbers get compared in an odd way. For example, lines 3, 20, and 40 | |
267 | would (if the file names were the same) appear in the string order |
|
267 | would (if the file names were the same) appear in the string order | |
268 | "20" "3" and "40". In contrast, "nfl" does a numeric compare of the |
|
268 | "20" "3" and "40". In contrast, "nfl" does a numeric compare of the | |
269 | line numbers. In fact, sort_stats("nfl") is the same as |
|
269 | line numbers. In fact, sort_stats("nfl") is the same as | |
270 | sort_stats("name", "file", "line"). |
|
270 | sort_stats("name", "file", "line"). | |
271 |
|
271 | |||
272 | -T <filename> |
|
272 | -T <filename> | |
273 | save profile results as shown on screen to a text |
|
273 | save profile results as shown on screen to a text | |
274 | file. The profile is still shown on screen. |
|
274 | file. The profile is still shown on screen. | |
275 |
|
275 | |||
276 | -D <filename> |
|
276 | -D <filename> | |
277 | save (via dump_stats) profile statistics to given |
|
277 | save (via dump_stats) profile statistics to given | |
278 | filename. This data is in a format understood by the pstats module, and |
|
278 | filename. This data is in a format understood by the pstats module, and | |
279 | is generated by a call to the dump_stats() method of profile |
|
279 | is generated by a call to the dump_stats() method of profile | |
280 | objects. The profile is still shown on screen. |
|
280 | objects. The profile is still shown on screen. | |
281 |
|
281 | |||
282 | -q |
|
282 | -q | |
283 | suppress output to the pager. Best used with -T and/or -D above. |
|
283 | suppress output to the pager. Best used with -T and/or -D above. | |
284 |
|
284 | |||
285 | If you want to run complete programs under the profiler's control, use |
|
285 | If you want to run complete programs under the profiler's control, use | |
286 | ``%run -p [prof_opts] filename.py [args to program]`` where prof_opts |
|
286 | ``%run -p [prof_opts] filename.py [args to program]`` where prof_opts | |
287 | contains profiler specific options as described here. |
|
287 | contains profiler specific options as described here. | |
288 |
|
288 | |||
289 | You can read the complete documentation for the profile module with:: |
|
289 | You can read the complete documentation for the profile module with:: | |
290 |
|
290 | |||
291 | In [1]: import profile; profile.help() |
|
291 | In [1]: import profile; profile.help() | |
292 |
|
292 | |||
293 | .. versionchanged:: 7.3 |
|
293 | .. versionchanged:: 7.3 | |
294 | User variables are no longer expanded, |
|
294 | User variables are no longer expanded, | |
295 | the magic line is always left unmodified. |
|
295 | the magic line is always left unmodified. | |
296 |
|
296 | |||
297 | """ |
|
297 | """ | |
298 | opts, arg_str = self.parse_options(parameter_s, 'D:l:rs:T:q', |
|
298 | opts, arg_str = self.parse_options(parameter_s, 'D:l:rs:T:q', | |
299 | list_all=True, posix=False) |
|
299 | list_all=True, posix=False) | |
300 | if cell is not None: |
|
300 | if cell is not None: | |
301 | arg_str += '\n' + cell |
|
301 | arg_str += '\n' + cell | |
302 | arg_str = self.shell.transform_cell(arg_str) |
|
302 | arg_str = self.shell.transform_cell(arg_str) | |
303 | return self._run_with_profiler(arg_str, opts, self.shell.user_ns) |
|
303 | return self._run_with_profiler(arg_str, opts, self.shell.user_ns) | |
304 |
|
304 | |||
305 | def _run_with_profiler(self, code, opts, namespace): |
|
305 | def _run_with_profiler(self, code, opts, namespace): | |
306 | """ |
|
306 | """ | |
307 | Run `code` with profiler. Used by ``%prun`` and ``%run -p``. |
|
307 | Run `code` with profiler. Used by ``%prun`` and ``%run -p``. | |
308 |
|
308 | |||
309 | Parameters |
|
309 | Parameters | |
310 | ---------- |
|
310 | ---------- | |
311 | code : str |
|
311 | code : str | |
312 | Code to be executed. |
|
312 | Code to be executed. | |
313 | opts : Struct |
|
313 | opts : Struct | |
314 | Options parsed by `self.parse_options`. |
|
314 | Options parsed by `self.parse_options`. | |
315 | namespace : dict |
|
315 | namespace : dict | |
316 | A dictionary for Python namespace (e.g., `self.shell.user_ns`). |
|
316 | A dictionary for Python namespace (e.g., `self.shell.user_ns`). | |
317 |
|
317 | |||
318 | """ |
|
318 | """ | |
319 |
|
319 | |||
320 | # Fill default values for unspecified options: |
|
320 | # Fill default values for unspecified options: | |
321 | opts.merge(Struct(D=[''], l=[], s=['time'], T=[''])) |
|
321 | opts.merge(Struct(D=[''], l=[], s=['time'], T=[''])) | |
322 |
|
322 | |||
323 | prof = profile.Profile() |
|
323 | prof = profile.Profile() | |
324 | try: |
|
324 | try: | |
325 | prof = prof.runctx(code, namespace, namespace) |
|
325 | prof = prof.runctx(code, namespace, namespace) | |
326 | sys_exit = '' |
|
326 | sys_exit = '' | |
327 | except SystemExit: |
|
327 | except SystemExit: | |
328 | sys_exit = """*** SystemExit exception caught in code being profiled.""" |
|
328 | sys_exit = """*** SystemExit exception caught in code being profiled.""" | |
329 |
|
329 | |||
330 | stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s) |
|
330 | stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s) | |
331 |
|
331 | |||
332 | lims = opts.l |
|
332 | lims = opts.l | |
333 | if lims: |
|
333 | if lims: | |
334 | lims = [] # rebuild lims with ints/floats/strings |
|
334 | lims = [] # rebuild lims with ints/floats/strings | |
335 | for lim in opts.l: |
|
335 | for lim in opts.l: | |
336 | try: |
|
336 | try: | |
337 | lims.append(int(lim)) |
|
337 | lims.append(int(lim)) | |
338 | except ValueError: |
|
338 | except ValueError: | |
339 | try: |
|
339 | try: | |
340 | lims.append(float(lim)) |
|
340 | lims.append(float(lim)) | |
341 | except ValueError: |
|
341 | except ValueError: | |
342 | lims.append(lim) |
|
342 | lims.append(lim) | |
343 |
|
343 | |||
344 | # Trap output. |
|
344 | # Trap output. | |
345 | stdout_trap = StringIO() |
|
345 | stdout_trap = StringIO() | |
346 | stats_stream = stats.stream |
|
346 | stats_stream = stats.stream | |
347 | try: |
|
347 | try: | |
348 | stats.stream = stdout_trap |
|
348 | stats.stream = stdout_trap | |
349 | stats.print_stats(*lims) |
|
349 | stats.print_stats(*lims) | |
350 | finally: |
|
350 | finally: | |
351 | stats.stream = stats_stream |
|
351 | stats.stream = stats_stream | |
352 |
|
352 | |||
353 | output = stdout_trap.getvalue() |
|
353 | output = stdout_trap.getvalue() | |
354 | output = output.rstrip() |
|
354 | output = output.rstrip() | |
355 |
|
355 | |||
356 | if 'q' not in opts: |
|
356 | if 'q' not in opts: | |
357 | page.page(output) |
|
357 | page.page(output) | |
358 | print(sys_exit, end=' ') |
|
358 | print(sys_exit, end=' ') | |
359 |
|
359 | |||
360 | dump_file = opts.D[0] |
|
360 | dump_file = opts.D[0] | |
361 | text_file = opts.T[0] |
|
361 | text_file = opts.T[0] | |
362 | if dump_file: |
|
362 | if dump_file: | |
363 | prof.dump_stats(dump_file) |
|
363 | prof.dump_stats(dump_file) | |
364 | print( |
|
364 | print( | |
365 | f"\n*** Profile stats marshalled to file {repr(dump_file)}.{sys_exit}" |
|
365 | f"\n*** Profile stats marshalled to file {repr(dump_file)}.{sys_exit}" | |
366 | ) |
|
366 | ) | |
367 | if text_file: |
|
367 | if text_file: | |
368 | pfile = Path(text_file) |
|
368 | pfile = Path(text_file) | |
369 | pfile.touch(exist_ok=True) |
|
369 | pfile.touch(exist_ok=True) | |
370 | pfile.write_text(output) |
|
370 | pfile.write_text(output) | |
371 |
|
371 | |||
372 | print( |
|
372 | print( | |
373 | f"\n*** Profile printout saved to text file {repr(text_file)}.{sys_exit}" |
|
373 | f"\n*** Profile printout saved to text file {repr(text_file)}.{sys_exit}" | |
374 | ) |
|
374 | ) | |
375 |
|
375 | |||
376 | if 'r' in opts: |
|
376 | if 'r' in opts: | |
377 | return stats |
|
377 | return stats | |
378 |
|
378 | |||
379 | return None |
|
379 | return None | |
380 |
|
380 | |||
381 | @line_magic |
|
381 | @line_magic | |
382 | def pdb(self, parameter_s=''): |
|
382 | def pdb(self, parameter_s=''): | |
383 | """Control the automatic calling of the pdb interactive debugger. |
|
383 | """Control the automatic calling of the pdb interactive debugger. | |
384 |
|
384 | |||
385 | Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without |
|
385 | Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without | |
386 | argument it works as a toggle. |
|
386 | argument it works as a toggle. | |
387 |
|
387 | |||
388 | When an exception is triggered, IPython can optionally call the |
|
388 | When an exception is triggered, IPython can optionally call the | |
389 | interactive pdb debugger after the traceback printout. %pdb toggles |
|
389 | interactive pdb debugger after the traceback printout. %pdb toggles | |
390 | this feature on and off. |
|
390 | this feature on and off. | |
391 |
|
391 | |||
392 | The initial state of this feature is set in your configuration |
|
392 | The initial state of this feature is set in your configuration | |
393 | file (the option is ``InteractiveShell.pdb``). |
|
393 | file (the option is ``InteractiveShell.pdb``). | |
394 |
|
394 | |||
395 | If you want to just activate the debugger AFTER an exception has fired, |
|
395 | If you want to just activate the debugger AFTER an exception has fired, | |
396 | without having to type '%pdb on' and rerunning your code, you can use |
|
396 | without having to type '%pdb on' and rerunning your code, you can use | |
397 | the %debug magic.""" |
|
397 | the %debug magic.""" | |
398 |
|
398 | |||
399 | par = parameter_s.strip().lower() |
|
399 | par = parameter_s.strip().lower() | |
400 |
|
400 | |||
401 | if par: |
|
401 | if par: | |
402 | try: |
|
402 | try: | |
403 | new_pdb = {'off':0,'0':0,'on':1,'1':1}[par] |
|
403 | new_pdb = {'off':0,'0':0,'on':1,'1':1}[par] | |
404 | except KeyError: |
|
404 | except KeyError: | |
405 | print ('Incorrect argument. Use on/1, off/0, ' |
|
405 | print ('Incorrect argument. Use on/1, off/0, ' | |
406 | 'or nothing for a toggle.') |
|
406 | 'or nothing for a toggle.') | |
407 | return |
|
407 | return | |
408 | else: |
|
408 | else: | |
409 | # toggle |
|
409 | # toggle | |
410 | new_pdb = not self.shell.call_pdb |
|
410 | new_pdb = not self.shell.call_pdb | |
411 |
|
411 | |||
412 | # set on the shell |
|
412 | # set on the shell | |
413 | self.shell.call_pdb = new_pdb |
|
413 | self.shell.call_pdb = new_pdb | |
414 | print('Automatic pdb calling has been turned',on_off(new_pdb)) |
|
414 | print('Automatic pdb calling has been turned',on_off(new_pdb)) | |
415 |
|
415 | |||
416 | @skip_doctest |
|
416 | @skip_doctest | |
417 | @magic_arguments.magic_arguments() |
|
417 | @magic_arguments.magic_arguments() | |
418 | @magic_arguments.argument('--breakpoint', '-b', metavar='FILE:LINE', |
|
418 | @magic_arguments.argument('--breakpoint', '-b', metavar='FILE:LINE', | |
419 | help=""" |
|
419 | help=""" | |
420 | Set break point at LINE in FILE. |
|
420 | Set break point at LINE in FILE. | |
421 | """ |
|
421 | """ | |
422 | ) |
|
422 | ) | |
423 | @magic_arguments.argument('statement', nargs='*', |
|
423 | @magic_arguments.argument('statement', nargs='*', | |
424 | help=""" |
|
424 | help=""" | |
425 | Code to run in debugger. |
|
425 | Code to run in debugger. | |
426 | You can omit this in cell magic mode. |
|
426 | You can omit this in cell magic mode. | |
427 | """ |
|
427 | """ | |
428 | ) |
|
428 | ) | |
429 | @no_var_expand |
|
429 | @no_var_expand | |
430 | @line_cell_magic |
|
430 | @line_cell_magic | |
431 | def debug(self, line='', cell=None): |
|
431 | def debug(self, line='', cell=None): | |
432 | """Activate the interactive debugger. |
|
432 | """Activate the interactive debugger. | |
433 |
|
433 | |||
434 | This magic command support two ways of activating debugger. |
|
434 | This magic command support two ways of activating debugger. | |
435 | One is to activate debugger before executing code. This way, you |
|
435 | One is to activate debugger before executing code. This way, you | |
436 | can set a break point, to step through the code from the point. |
|
436 | can set a break point, to step through the code from the point. | |
437 | You can use this mode by giving statements to execute and optionally |
|
437 | You can use this mode by giving statements to execute and optionally | |
438 | a breakpoint. |
|
438 | a breakpoint. | |
439 |
|
439 | |||
440 | The other one is to activate debugger in post-mortem mode. You can |
|
440 | The other one is to activate debugger in post-mortem mode. You can | |
441 | activate this mode simply running %debug without any argument. |
|
441 | activate this mode simply running %debug without any argument. | |
442 | If an exception has just occurred, this lets you inspect its stack |
|
442 | If an exception has just occurred, this lets you inspect its stack | |
443 | frames interactively. Note that this will always work only on the last |
|
443 | frames interactively. Note that this will always work only on the last | |
444 | traceback that occurred, so you must call this quickly after an |
|
444 | traceback that occurred, so you must call this quickly after an | |
445 | exception that you wish to inspect has fired, because if another one |
|
445 | exception that you wish to inspect has fired, because if another one | |
446 | occurs, it clobbers the previous one. |
|
446 | occurs, it clobbers the previous one. | |
447 |
|
447 | |||
448 | If you want IPython to automatically do this on every exception, see |
|
448 | If you want IPython to automatically do this on every exception, see | |
449 | the %pdb magic for more details. |
|
449 | the %pdb magic for more details. | |
450 |
|
450 | |||
451 | .. versionchanged:: 7.3 |
|
451 | .. versionchanged:: 7.3 | |
452 | When running code, user variables are no longer expanded, |
|
452 | When running code, user variables are no longer expanded, | |
453 | the magic line is always left unmodified. |
|
453 | the magic line is always left unmodified. | |
454 |
|
454 | |||
455 | """ |
|
455 | """ | |
456 | args = magic_arguments.parse_argstring(self.debug, line) |
|
456 | args = magic_arguments.parse_argstring(self.debug, line) | |
457 |
|
457 | |||
458 | if not (args.breakpoint or args.statement or cell): |
|
458 | if not (args.breakpoint or args.statement or cell): | |
459 | self._debug_post_mortem() |
|
459 | self._debug_post_mortem() | |
460 | elif not (args.breakpoint or cell): |
|
460 | elif not (args.breakpoint or cell): | |
461 | # If there is no breakpoints, the line is just code to execute |
|
461 | # If there is no breakpoints, the line is just code to execute | |
462 | self._debug_exec(line, None) |
|
462 | self._debug_exec(line, None) | |
463 | else: |
|
463 | else: | |
464 | # Here we try to reconstruct the code from the output of |
|
464 | # Here we try to reconstruct the code from the output of | |
465 | # parse_argstring. This might not work if the code has spaces |
|
465 | # parse_argstring. This might not work if the code has spaces | |
466 | # For example this fails for `print("a b")` |
|
466 | # For example this fails for `print("a b")` | |
467 | code = "\n".join(args.statement) |
|
467 | code = "\n".join(args.statement) | |
468 | if cell: |
|
468 | if cell: | |
469 | code += "\n" + cell |
|
469 | code += "\n" + cell | |
470 | self._debug_exec(code, args.breakpoint) |
|
470 | self._debug_exec(code, args.breakpoint) | |
471 |
|
471 | |||
472 | def _debug_post_mortem(self): |
|
472 | def _debug_post_mortem(self): | |
473 | self.shell.debugger(force=True) |
|
473 | self.shell.debugger(force=True) | |
474 |
|
474 | |||
475 | def _debug_exec(self, code, breakpoint): |
|
475 | def _debug_exec(self, code, breakpoint): | |
476 | if breakpoint: |
|
476 | if breakpoint: | |
477 | (filename, bp_line) = breakpoint.rsplit(':', 1) |
|
477 | (filename, bp_line) = breakpoint.rsplit(':', 1) | |
478 | bp_line = int(bp_line) |
|
478 | bp_line = int(bp_line) | |
479 | else: |
|
479 | else: | |
480 | (filename, bp_line) = (None, None) |
|
480 | (filename, bp_line) = (None, None) | |
481 | self._run_with_debugger(code, self.shell.user_ns, filename, bp_line) |
|
481 | self._run_with_debugger(code, self.shell.user_ns, filename, bp_line) | |
482 |
|
482 | |||
483 | @line_magic |
|
483 | @line_magic | |
484 | def tb(self, s): |
|
484 | def tb(self, s): | |
485 | """Print the last traceback. |
|
485 | """Print the last traceback. | |
486 |
|
486 | |||
487 | Optionally, specify an exception reporting mode, tuning the |
|
487 | Optionally, specify an exception reporting mode, tuning the | |
488 | verbosity of the traceback. By default the currently-active exception |
|
488 | verbosity of the traceback. By default the currently-active exception | |
489 | mode is used. See %xmode for changing exception reporting modes. |
|
489 | mode is used. See %xmode for changing exception reporting modes. | |
490 |
|
490 | |||
491 | Valid modes: Plain, Context, Verbose, and Minimal. |
|
491 | Valid modes: Plain, Context, Verbose, and Minimal. | |
492 | """ |
|
492 | """ | |
493 | interactive_tb = self.shell.InteractiveTB |
|
493 | interactive_tb = self.shell.InteractiveTB | |
494 | if s: |
|
494 | if s: | |
495 | # Switch exception reporting mode for this one call. |
|
495 | # Switch exception reporting mode for this one call. | |
496 | # Ensure it is switched back. |
|
496 | # Ensure it is switched back. | |
497 | def xmode_switch_err(name): |
|
497 | def xmode_switch_err(name): | |
498 | warn('Error changing %s exception modes.\n%s' % |
|
498 | warn('Error changing %s exception modes.\n%s' % | |
499 | (name,sys.exc_info()[1])) |
|
499 | (name,sys.exc_info()[1])) | |
500 |
|
500 | |||
501 | new_mode = s.strip().capitalize() |
|
501 | new_mode = s.strip().capitalize() | |
502 | original_mode = interactive_tb.mode |
|
502 | original_mode = interactive_tb.mode | |
503 | try: |
|
503 | try: | |
504 | try: |
|
504 | try: | |
505 | interactive_tb.set_mode(mode=new_mode) |
|
505 | interactive_tb.set_mode(mode=new_mode) | |
506 | except Exception: |
|
506 | except Exception: | |
507 | xmode_switch_err('user') |
|
507 | xmode_switch_err('user') | |
508 | else: |
|
508 | else: | |
509 | self.shell.showtraceback() |
|
509 | self.shell.showtraceback() | |
510 | finally: |
|
510 | finally: | |
511 | interactive_tb.set_mode(mode=original_mode) |
|
511 | interactive_tb.set_mode(mode=original_mode) | |
512 | else: |
|
512 | else: | |
513 | self.shell.showtraceback() |
|
513 | self.shell.showtraceback() | |
514 |
|
514 | |||
515 | @skip_doctest |
|
515 | @skip_doctest | |
516 | @line_magic |
|
516 | @line_magic | |
517 | def run(self, parameter_s='', runner=None, |
|
517 | def run(self, parameter_s='', runner=None, | |
518 | file_finder=get_py_filename): |
|
518 | file_finder=get_py_filename): | |
519 | """Run the named file inside IPython as a program. |
|
519 | """Run the named file inside IPython as a program. | |
520 |
|
520 | |||
521 | Usage:: |
|
521 | Usage:: | |
522 |
|
522 | |||
523 | %run [-n -i -e -G] |
|
523 | %run [-n -i -e -G] | |
524 | [( -t [-N<N>] | -d [-b<N>] | -p [profile options] )] |
|
524 | [( -t [-N<N>] | -d [-b<N>] | -p [profile options] )] | |
525 | ( -m mod | file ) [args] |
|
525 | ( -m mod | file ) [args] | |
526 |
|
526 | |||
527 | Parameters after the filename are passed as command-line arguments to |
|
527 | Parameters after the filename are passed as command-line arguments to | |
528 | the program (put in sys.argv). Then, control returns to IPython's |
|
528 | the program (put in sys.argv). Then, control returns to IPython's | |
529 | prompt. |
|
529 | prompt. | |
530 |
|
530 | |||
531 | This is similar to running at a system prompt ``python file args``, |
|
531 | This is similar to running at a system prompt ``python file args``, | |
532 | but with the advantage of giving you IPython's tracebacks, and of |
|
532 | but with the advantage of giving you IPython's tracebacks, and of | |
533 | loading all variables into your interactive namespace for further use |
|
533 | loading all variables into your interactive namespace for further use | |
534 | (unless -p is used, see below). |
|
534 | (unless -p is used, see below). | |
535 |
|
535 | |||
536 | The file is executed in a namespace initially consisting only of |
|
536 | The file is executed in a namespace initially consisting only of | |
537 | ``__name__=='__main__'`` and sys.argv constructed as indicated. It thus |
|
537 | ``__name__=='__main__'`` and sys.argv constructed as indicated. It thus | |
538 | sees its environment as if it were being run as a stand-alone program |
|
538 | sees its environment as if it were being run as a stand-alone program | |
539 | (except for sharing global objects such as previously imported |
|
539 | (except for sharing global objects such as previously imported | |
540 | modules). But after execution, the IPython interactive namespace gets |
|
540 | modules). But after execution, the IPython interactive namespace gets | |
541 | updated with all variables defined in the program (except for __name__ |
|
541 | updated with all variables defined in the program (except for __name__ | |
542 | and sys.argv). This allows for very convenient loading of code for |
|
542 | and sys.argv). This allows for very convenient loading of code for | |
543 | interactive work, while giving each program a 'clean sheet' to run in. |
|
543 | interactive work, while giving each program a 'clean sheet' to run in. | |
544 |
|
544 | |||
545 | Arguments are expanded using shell-like glob match. Patterns |
|
545 | Arguments are expanded using shell-like glob match. Patterns | |
546 | '*', '?', '[seq]' and '[!seq]' can be used. Additionally, |
|
546 | '*', '?', '[seq]' and '[!seq]' can be used. Additionally, | |
547 | tilde '~' will be expanded into user's home directory. Unlike |
|
547 | tilde '~' will be expanded into user's home directory. Unlike | |
548 | real shells, quotation does not suppress expansions. Use |
|
548 | real shells, quotation does not suppress expansions. Use | |
549 | *two* back slashes (e.g. ``\\\\*``) to suppress expansions. |
|
549 | *two* back slashes (e.g. ``\\\\*``) to suppress expansions. | |
550 | To completely disable these expansions, you can use -G flag. |
|
550 | To completely disable these expansions, you can use -G flag. | |
551 |
|
551 | |||
552 | On Windows systems, the use of single quotes `'` when specifying |
|
552 | On Windows systems, the use of single quotes `'` when specifying | |
553 | a file is not supported. Use double quotes `"`. |
|
553 | a file is not supported. Use double quotes `"`. | |
554 |
|
554 | |||
555 | Options: |
|
555 | Options: | |
556 |
|
556 | |||
557 | -n |
|
557 | -n | |
558 | __name__ is NOT set to '__main__', but to the running file's name |
|
558 | __name__ is NOT set to '__main__', but to the running file's name | |
559 | without extension (as python does under import). This allows running |
|
559 | without extension (as python does under import). This allows running | |
560 | scripts and reloading the definitions in them without calling code |
|
560 | scripts and reloading the definitions in them without calling code | |
561 | protected by an ``if __name__ == "__main__"`` clause. |
|
561 | protected by an ``if __name__ == "__main__"`` clause. | |
562 |
|
562 | |||
563 | -i |
|
563 | -i | |
564 | run the file in IPython's namespace instead of an empty one. This |
|
564 | run the file in IPython's namespace instead of an empty one. This | |
565 | is useful if you are experimenting with code written in a text editor |
|
565 | is useful if you are experimenting with code written in a text editor | |
566 | which depends on variables defined interactively. |
|
566 | which depends on variables defined interactively. | |
567 |
|
567 | |||
568 | -e |
|
568 | -e | |
569 | ignore sys.exit() calls or SystemExit exceptions in the script |
|
569 | ignore sys.exit() calls or SystemExit exceptions in the script | |
570 | being run. This is particularly useful if IPython is being used to |
|
570 | being run. This is particularly useful if IPython is being used to | |
571 | run unittests, which always exit with a sys.exit() call. In such |
|
571 | run unittests, which always exit with a sys.exit() call. In such | |
572 | cases you are interested in the output of the test results, not in |
|
572 | cases you are interested in the output of the test results, not in | |
573 | seeing a traceback of the unittest module. |
|
573 | seeing a traceback of the unittest module. | |
574 |
|
574 | |||
575 | -t |
|
575 | -t | |
576 | print timing information at the end of the run. IPython will give |
|
576 | print timing information at the end of the run. IPython will give | |
577 | you an estimated CPU time consumption for your script, which under |
|
577 | you an estimated CPU time consumption for your script, which under | |
578 | Unix uses the resource module to avoid the wraparound problems of |
|
578 | Unix uses the resource module to avoid the wraparound problems of | |
579 | time.clock(). Under Unix, an estimate of time spent on system tasks |
|
579 | time.clock(). Under Unix, an estimate of time spent on system tasks | |
580 | is also given (for Windows platforms this is reported as 0.0). |
|
580 | is also given (for Windows platforms this is reported as 0.0). | |
581 |
|
581 | |||
582 | If -t is given, an additional ``-N<N>`` option can be given, where <N> |
|
582 | If -t is given, an additional ``-N<N>`` option can be given, where <N> | |
583 | must be an integer indicating how many times you want the script to |
|
583 | must be an integer indicating how many times you want the script to | |
584 | run. The final timing report will include total and per run results. |
|
584 | run. The final timing report will include total and per run results. | |
585 |
|
585 | |||
586 | For example (testing the script uniq_stable.py):: |
|
586 | For example (testing the script uniq_stable.py):: | |
587 |
|
587 | |||
588 | In [1]: run -t uniq_stable |
|
588 | In [1]: run -t uniq_stable | |
589 |
|
589 | |||
590 | IPython CPU timings (estimated): |
|
590 | IPython CPU timings (estimated): | |
591 | User : 0.19597 s. |
|
591 | User : 0.19597 s. | |
592 | System: 0.0 s. |
|
592 | System: 0.0 s. | |
593 |
|
593 | |||
594 | In [2]: run -t -N5 uniq_stable |
|
594 | In [2]: run -t -N5 uniq_stable | |
595 |
|
595 | |||
596 | IPython CPU timings (estimated): |
|
596 | IPython CPU timings (estimated): | |
597 | Total runs performed: 5 |
|
597 | Total runs performed: 5 | |
598 | Times : Total Per run |
|
598 | Times : Total Per run | |
599 | User : 0.910862 s, 0.1821724 s. |
|
599 | User : 0.910862 s, 0.1821724 s. | |
600 | System: 0.0 s, 0.0 s. |
|
600 | System: 0.0 s, 0.0 s. | |
601 |
|
601 | |||
602 | -d |
|
602 | -d | |
603 | run your program under the control of pdb, the Python debugger. |
|
603 | run your program under the control of pdb, the Python debugger. | |
604 | This allows you to execute your program step by step, watch variables, |
|
604 | This allows you to execute your program step by step, watch variables, | |
605 | etc. Internally, what IPython does is similar to calling:: |
|
605 | etc. Internally, what IPython does is similar to calling:: | |
606 |
|
606 | |||
607 | pdb.run('execfile("YOURFILENAME")') |
|
607 | pdb.run('execfile("YOURFILENAME")') | |
608 |
|
608 | |||
609 | with a breakpoint set on line 1 of your file. You can change the line |
|
609 | with a breakpoint set on line 1 of your file. You can change the line | |
610 | number for this automatic breakpoint to be <N> by using the -bN option |
|
610 | number for this automatic breakpoint to be <N> by using the -bN option | |
611 | (where N must be an integer). For example:: |
|
611 | (where N must be an integer). For example:: | |
612 |
|
612 | |||
613 | %run -d -b40 myscript |
|
613 | %run -d -b40 myscript | |
614 |
|
614 | |||
615 | will set the first breakpoint at line 40 in myscript.py. Note that |
|
615 | will set the first breakpoint at line 40 in myscript.py. Note that | |
616 | the first breakpoint must be set on a line which actually does |
|
616 | the first breakpoint must be set on a line which actually does | |
617 | something (not a comment or docstring) for it to stop execution. |
|
617 | something (not a comment or docstring) for it to stop execution. | |
618 |
|
618 | |||
619 | Or you can specify a breakpoint in a different file:: |
|
619 | Or you can specify a breakpoint in a different file:: | |
620 |
|
620 | |||
621 | %run -d -b myotherfile.py:20 myscript |
|
621 | %run -d -b myotherfile.py:20 myscript | |
622 |
|
622 | |||
623 | When the pdb debugger starts, you will see a (Pdb) prompt. You must |
|
623 | When the pdb debugger starts, you will see a (Pdb) prompt. You must | |
624 | first enter 'c' (without quotes) to start execution up to the first |
|
624 | first enter 'c' (without quotes) to start execution up to the first | |
625 | breakpoint. |
|
625 | breakpoint. | |
626 |
|
626 | |||
627 | Entering 'help' gives information about the use of the debugger. You |
|
627 | Entering 'help' gives information about the use of the debugger. You | |
628 | can easily see pdb's full documentation with "import pdb;pdb.help()" |
|
628 | can easily see pdb's full documentation with "import pdb;pdb.help()" | |
629 | at a prompt. |
|
629 | at a prompt. | |
630 |
|
630 | |||
631 | -p |
|
631 | -p | |
632 | run program under the control of the Python profiler module (which |
|
632 | run program under the control of the Python profiler module (which | |
633 | prints a detailed report of execution times, function calls, etc). |
|
633 | prints a detailed report of execution times, function calls, etc). | |
634 |
|
634 | |||
635 | You can pass other options after -p which affect the behavior of the |
|
635 | You can pass other options after -p which affect the behavior of the | |
636 | profiler itself. See the docs for %prun for details. |
|
636 | profiler itself. See the docs for %prun for details. | |
637 |
|
637 | |||
638 | In this mode, the program's variables do NOT propagate back to the |
|
638 | In this mode, the program's variables do NOT propagate back to the | |
639 | IPython interactive namespace (because they remain in the namespace |
|
639 | IPython interactive namespace (because they remain in the namespace | |
640 | where the profiler executes them). |
|
640 | where the profiler executes them). | |
641 |
|
641 | |||
642 | Internally this triggers a call to %prun, see its documentation for |
|
642 | Internally this triggers a call to %prun, see its documentation for | |
643 | details on the options available specifically for profiling. |
|
643 | details on the options available specifically for profiling. | |
644 |
|
644 | |||
645 | There is one special usage for which the text above doesn't apply: |
|
645 | There is one special usage for which the text above doesn't apply: | |
646 | if the filename ends with .ipy[nb], the file is run as ipython script, |
|
646 | if the filename ends with .ipy[nb], the file is run as ipython script, | |
647 | just as if the commands were written on IPython prompt. |
|
647 | just as if the commands were written on IPython prompt. | |
648 |
|
648 | |||
649 | -m |
|
649 | -m | |
650 | specify module name to load instead of script path. Similar to |
|
650 | specify module name to load instead of script path. Similar to | |
651 | the -m option for the python interpreter. Use this option last if you |
|
651 | the -m option for the python interpreter. Use this option last if you | |
652 | want to combine with other %run options. Unlike the python interpreter |
|
652 | want to combine with other %run options. Unlike the python interpreter | |
653 | only source modules are allowed no .pyc or .pyo files. |
|
653 | only source modules are allowed no .pyc or .pyo files. | |
654 | For example:: |
|
654 | For example:: | |
655 |
|
655 | |||
656 | %run -m example |
|
656 | %run -m example | |
657 |
|
657 | |||
658 | will run the example module. |
|
658 | will run the example module. | |
659 |
|
659 | |||
660 | -G |
|
660 | -G | |
661 | disable shell-like glob expansion of arguments. |
|
661 | disable shell-like glob expansion of arguments. | |
662 |
|
662 | |||
663 | """ |
|
663 | """ | |
664 |
|
664 | |||
665 | # Logic to handle issue #3664 |
|
665 | # Logic to handle issue #3664 | |
666 | # Add '--' after '-m <module_name>' to ignore additional args passed to a module. |
|
666 | # Add '--' after '-m <module_name>' to ignore additional args passed to a module. | |
667 | if '-m' in parameter_s and '--' not in parameter_s: |
|
667 | if '-m' in parameter_s and '--' not in parameter_s: | |
668 | argv = shlex.split(parameter_s, posix=(os.name == 'posix')) |
|
668 | argv = shlex.split(parameter_s, posix=(os.name == 'posix')) | |
669 | for idx, arg in enumerate(argv): |
|
669 | for idx, arg in enumerate(argv): | |
670 | if arg and arg.startswith('-') and arg != '-': |
|
670 | if arg and arg.startswith('-') and arg != '-': | |
671 | if arg == '-m': |
|
671 | if arg == '-m': | |
672 | argv.insert(idx + 2, '--') |
|
672 | argv.insert(idx + 2, '--') | |
673 | break |
|
673 | break | |
674 | else: |
|
674 | else: | |
675 | # Positional arg, break |
|
675 | # Positional arg, break | |
676 | break |
|
676 | break | |
677 | parameter_s = ' '.join(shlex.quote(arg) for arg in argv) |
|
677 | parameter_s = ' '.join(shlex.quote(arg) for arg in argv) | |
678 |
|
678 | |||
679 | # get arguments and set sys.argv for program to be run. |
|
679 | # get arguments and set sys.argv for program to be run. | |
680 | opts, arg_lst = self.parse_options(parameter_s, |
|
680 | opts, arg_lst = self.parse_options(parameter_s, | |
681 | 'nidtN:b:pD:l:rs:T:em:G', |
|
681 | 'nidtN:b:pD:l:rs:T:em:G', | |
682 | mode='list', list_all=1) |
|
682 | mode='list', list_all=1) | |
683 | if "m" in opts: |
|
683 | if "m" in opts: | |
684 | modulename = opts["m"][0] |
|
684 | modulename = opts["m"][0] | |
685 | modpath = find_mod(modulename) |
|
685 | modpath = find_mod(modulename) | |
686 | if modpath is None: |
|
686 | if modpath is None: | |
687 | msg = '%r is not a valid modulename on sys.path'%modulename |
|
687 | msg = '%r is not a valid modulename on sys.path'%modulename | |
688 | raise Exception(msg) |
|
688 | raise Exception(msg) | |
689 | arg_lst = [modpath] + arg_lst |
|
689 | arg_lst = [modpath] + arg_lst | |
690 | try: |
|
690 | try: | |
691 | fpath = None # initialize to make sure fpath is in scope later |
|
691 | fpath = None # initialize to make sure fpath is in scope later | |
692 | fpath = arg_lst[0] |
|
692 | fpath = arg_lst[0] | |
693 | filename = file_finder(fpath) |
|
693 | filename = file_finder(fpath) | |
694 | except IndexError as e: |
|
694 | except IndexError as e: | |
695 | msg = 'you must provide at least a filename.' |
|
695 | msg = 'you must provide at least a filename.' | |
696 | raise Exception(msg) from e |
|
696 | raise Exception(msg) from e | |
697 | except IOError as e: |
|
697 | except IOError as e: | |
698 | try: |
|
698 | try: | |
699 | msg = str(e) |
|
699 | msg = str(e) | |
700 | except UnicodeError: |
|
700 | except UnicodeError: | |
701 | msg = e.message |
|
701 | msg = e.message | |
702 | if os.name == 'nt' and re.match(r"^'.*'$",fpath): |
|
702 | if os.name == 'nt' and re.match(r"^'.*'$",fpath): | |
703 | warn('For Windows, use double quotes to wrap a filename: %run "mypath\\myfile.py"') |
|
703 | warn('For Windows, use double quotes to wrap a filename: %run "mypath\\myfile.py"') | |
704 | raise Exception(msg) from e |
|
704 | raise Exception(msg) from e | |
705 | except TypeError: |
|
705 | except TypeError: | |
706 | if fpath in sys.meta_path: |
|
706 | if fpath in sys.meta_path: | |
707 | filename = "" |
|
707 | filename = "" | |
708 | else: |
|
708 | else: | |
709 | raise |
|
709 | raise | |
710 |
|
710 | |||
711 | if filename.lower().endswith(('.ipy', '.ipynb')): |
|
711 | if filename.lower().endswith(('.ipy', '.ipynb')): | |
712 | with preserve_keys(self.shell.user_ns, '__file__'): |
|
712 | with preserve_keys(self.shell.user_ns, '__file__'): | |
713 | self.shell.user_ns['__file__'] = filename |
|
713 | self.shell.user_ns['__file__'] = filename | |
714 | self.shell.safe_execfile_ipy(filename, raise_exceptions=True) |
|
714 | self.shell.safe_execfile_ipy(filename, raise_exceptions=True) | |
715 | return |
|
715 | return | |
716 |
|
716 | |||
717 | # Control the response to exit() calls made by the script being run |
|
717 | # Control the response to exit() calls made by the script being run | |
718 | exit_ignore = 'e' in opts |
|
718 | exit_ignore = 'e' in opts | |
719 |
|
719 | |||
720 | # Make sure that the running script gets a proper sys.argv as if it |
|
720 | # Make sure that the running script gets a proper sys.argv as if it | |
721 | # were run from a system shell. |
|
721 | # were run from a system shell. | |
722 | save_argv = sys.argv # save it for later restoring |
|
722 | save_argv = sys.argv # save it for later restoring | |
723 |
|
723 | |||
724 | if 'G' in opts: |
|
724 | if 'G' in opts: | |
725 | args = arg_lst[1:] |
|
725 | args = arg_lst[1:] | |
726 | else: |
|
726 | else: | |
727 | # tilde and glob expansion |
|
727 | # tilde and glob expansion | |
728 | args = shellglob(map(os.path.expanduser, arg_lst[1:])) |
|
728 | args = shellglob(map(os.path.expanduser, arg_lst[1:])) | |
729 |
|
729 | |||
730 | sys.argv = [filename] + args # put in the proper filename |
|
730 | sys.argv = [filename] + args # put in the proper filename | |
731 |
|
731 | |||
732 | if 'n' in opts: |
|
732 | if 'n' in opts: | |
733 | name = Path(filename).stem |
|
733 | name = Path(filename).stem | |
734 | else: |
|
734 | else: | |
735 | name = '__main__' |
|
735 | name = '__main__' | |
736 |
|
736 | |||
737 | if 'i' in opts: |
|
737 | if 'i' in opts: | |
738 | # Run in user's interactive namespace |
|
738 | # Run in user's interactive namespace | |
739 | prog_ns = self.shell.user_ns |
|
739 | prog_ns = self.shell.user_ns | |
740 | __name__save = self.shell.user_ns['__name__'] |
|
740 | __name__save = self.shell.user_ns['__name__'] | |
741 | prog_ns['__name__'] = name |
|
741 | prog_ns['__name__'] = name | |
742 | main_mod = self.shell.user_module |
|
742 | main_mod = self.shell.user_module | |
743 |
|
743 | |||
744 | # Since '%run foo' emulates 'python foo.py' at the cmd line, we must |
|
744 | # Since '%run foo' emulates 'python foo.py' at the cmd line, we must | |
745 | # set the __file__ global in the script's namespace |
|
745 | # set the __file__ global in the script's namespace | |
746 | # TK: Is this necessary in interactive mode? |
|
746 | # TK: Is this necessary in interactive mode? | |
747 | prog_ns['__file__'] = filename |
|
747 | prog_ns['__file__'] = filename | |
748 | else: |
|
748 | else: | |
749 | # Run in a fresh, empty namespace |
|
749 | # Run in a fresh, empty namespace | |
750 |
|
750 | |||
751 | # The shell MUST hold a reference to prog_ns so after %run |
|
751 | # The shell MUST hold a reference to prog_ns so after %run | |
752 | # exits, the python deletion mechanism doesn't zero it out |
|
752 | # exits, the python deletion mechanism doesn't zero it out | |
753 | # (leaving dangling references). See interactiveshell for details |
|
753 | # (leaving dangling references). See interactiveshell for details | |
754 | main_mod = self.shell.new_main_mod(filename, name) |
|
754 | main_mod = self.shell.new_main_mod(filename, name) | |
755 | prog_ns = main_mod.__dict__ |
|
755 | prog_ns = main_mod.__dict__ | |
756 |
|
756 | |||
757 | # pickle fix. See interactiveshell for an explanation. But we need to |
|
757 | # pickle fix. See interactiveshell for an explanation. But we need to | |
758 | # make sure that, if we overwrite __main__, we replace it at the end |
|
758 | # make sure that, if we overwrite __main__, we replace it at the end | |
759 | main_mod_name = prog_ns['__name__'] |
|
759 | main_mod_name = prog_ns['__name__'] | |
760 |
|
760 | |||
761 | if main_mod_name == '__main__': |
|
761 | if main_mod_name == '__main__': | |
762 | restore_main = sys.modules['__main__'] |
|
762 | restore_main = sys.modules['__main__'] | |
763 | else: |
|
763 | else: | |
764 | restore_main = False |
|
764 | restore_main = False | |
765 |
|
765 | |||
766 | # This needs to be undone at the end to prevent holding references to |
|
766 | # This needs to be undone at the end to prevent holding references to | |
767 | # every single object ever created. |
|
767 | # every single object ever created. | |
768 | sys.modules[main_mod_name] = main_mod |
|
768 | sys.modules[main_mod_name] = main_mod | |
769 |
|
769 | |||
770 | if 'p' in opts or 'd' in opts: |
|
770 | if 'p' in opts or 'd' in opts: | |
771 | if 'm' in opts: |
|
771 | if 'm' in opts: | |
772 | code = 'run_module(modulename, prog_ns)' |
|
772 | code = 'run_module(modulename, prog_ns)' | |
773 | code_ns = { |
|
773 | code_ns = { | |
774 | 'run_module': self.shell.safe_run_module, |
|
774 | 'run_module': self.shell.safe_run_module, | |
775 | 'prog_ns': prog_ns, |
|
775 | 'prog_ns': prog_ns, | |
776 | 'modulename': modulename, |
|
776 | 'modulename': modulename, | |
777 | } |
|
777 | } | |
778 | else: |
|
778 | else: | |
779 | if 'd' in opts: |
|
779 | if 'd' in opts: | |
780 | # allow exceptions to raise in debug mode |
|
780 | # allow exceptions to raise in debug mode | |
781 | code = 'execfile(filename, prog_ns, raise_exceptions=True)' |
|
781 | code = 'execfile(filename, prog_ns, raise_exceptions=True)' | |
782 | else: |
|
782 | else: | |
783 | code = 'execfile(filename, prog_ns)' |
|
783 | code = 'execfile(filename, prog_ns)' | |
784 | code_ns = { |
|
784 | code_ns = { | |
785 | 'execfile': self.shell.safe_execfile, |
|
785 | 'execfile': self.shell.safe_execfile, | |
786 | 'prog_ns': prog_ns, |
|
786 | 'prog_ns': prog_ns, | |
787 | 'filename': get_py_filename(filename), |
|
787 | 'filename': get_py_filename(filename), | |
788 | } |
|
788 | } | |
789 |
|
789 | |||
790 | try: |
|
790 | try: | |
791 | stats = None |
|
791 | stats = None | |
792 | if 'p' in opts: |
|
792 | if 'p' in opts: | |
793 | stats = self._run_with_profiler(code, opts, code_ns) |
|
793 | stats = self._run_with_profiler(code, opts, code_ns) | |
794 | else: |
|
794 | else: | |
795 | if 'd' in opts: |
|
795 | if 'd' in opts: | |
796 | bp_file, bp_line = parse_breakpoint( |
|
796 | bp_file, bp_line = parse_breakpoint( | |
797 | opts.get('b', ['1'])[0], filename) |
|
797 | opts.get('b', ['1'])[0], filename) | |
798 | self._run_with_debugger( |
|
798 | self._run_with_debugger( | |
799 | code, code_ns, filename, bp_line, bp_file) |
|
799 | code, code_ns, filename, bp_line, bp_file) | |
800 | else: |
|
800 | else: | |
801 | if 'm' in opts: |
|
801 | if 'm' in opts: | |
802 | def run(): |
|
802 | def run(): | |
803 | self.shell.safe_run_module(modulename, prog_ns) |
|
803 | self.shell.safe_run_module(modulename, prog_ns) | |
804 | else: |
|
804 | else: | |
805 | if runner is None: |
|
805 | if runner is None: | |
806 | runner = self.default_runner |
|
806 | runner = self.default_runner | |
807 | if runner is None: |
|
807 | if runner is None: | |
808 | runner = self.shell.safe_execfile |
|
808 | runner = self.shell.safe_execfile | |
809 |
|
809 | |||
810 | def run(): |
|
810 | def run(): | |
811 | runner(filename, prog_ns, prog_ns, |
|
811 | runner(filename, prog_ns, prog_ns, | |
812 | exit_ignore=exit_ignore) |
|
812 | exit_ignore=exit_ignore) | |
813 |
|
813 | |||
814 | if 't' in opts: |
|
814 | if 't' in opts: | |
815 | # timed execution |
|
815 | # timed execution | |
816 | try: |
|
816 | try: | |
817 | nruns = int(opts['N'][0]) |
|
817 | nruns = int(opts['N'][0]) | |
818 | if nruns < 1: |
|
818 | if nruns < 1: | |
819 | error('Number of runs must be >=1') |
|
819 | error('Number of runs must be >=1') | |
820 | return |
|
820 | return | |
821 | except (KeyError): |
|
821 | except (KeyError): | |
822 | nruns = 1 |
|
822 | nruns = 1 | |
823 | self._run_with_timing(run, nruns) |
|
823 | self._run_with_timing(run, nruns) | |
824 | else: |
|
824 | else: | |
825 | # regular execution |
|
825 | # regular execution | |
826 | run() |
|
826 | run() | |
827 |
|
827 | |||
828 | if 'i' in opts: |
|
828 | if 'i' in opts: | |
829 | self.shell.user_ns['__name__'] = __name__save |
|
829 | self.shell.user_ns['__name__'] = __name__save | |
830 | else: |
|
830 | else: | |
831 | # update IPython interactive namespace |
|
831 | # update IPython interactive namespace | |
832 |
|
832 | |||
833 | # Some forms of read errors on the file may mean the |
|
833 | # Some forms of read errors on the file may mean the | |
834 | # __name__ key was never set; using pop we don't have to |
|
834 | # __name__ key was never set; using pop we don't have to | |
835 | # worry about a possible KeyError. |
|
835 | # worry about a possible KeyError. | |
836 | prog_ns.pop('__name__', None) |
|
836 | prog_ns.pop('__name__', None) | |
837 |
|
837 | |||
838 | with preserve_keys(self.shell.user_ns, '__file__'): |
|
838 | with preserve_keys(self.shell.user_ns, '__file__'): | |
839 | self.shell.user_ns.update(prog_ns) |
|
839 | self.shell.user_ns.update(prog_ns) | |
840 | finally: |
|
840 | finally: | |
841 | # It's a bit of a mystery why, but __builtins__ can change from |
|
841 | # It's a bit of a mystery why, but __builtins__ can change from | |
842 | # being a module to becoming a dict missing some key data after |
|
842 | # being a module to becoming a dict missing some key data after | |
843 | # %run. As best I can see, this is NOT something IPython is doing |
|
843 | # %run. As best I can see, this is NOT something IPython is doing | |
844 | # at all, and similar problems have been reported before: |
|
844 | # at all, and similar problems have been reported before: | |
845 | # http://coding.derkeiler.com/Archive/Python/comp.lang.python/2004-10/0188.html |
|
845 | # http://coding.derkeiler.com/Archive/Python/comp.lang.python/2004-10/0188.html | |
846 | # Since this seems to be done by the interpreter itself, the best |
|
846 | # Since this seems to be done by the interpreter itself, the best | |
847 | # we can do is to at least restore __builtins__ for the user on |
|
847 | # we can do is to at least restore __builtins__ for the user on | |
848 | # exit. |
|
848 | # exit. | |
849 | self.shell.user_ns['__builtins__'] = builtin_mod |
|
849 | self.shell.user_ns['__builtins__'] = builtin_mod | |
850 |
|
850 | |||
851 | # Ensure key global structures are restored |
|
851 | # Ensure key global structures are restored | |
852 | sys.argv = save_argv |
|
852 | sys.argv = save_argv | |
853 | if restore_main: |
|
853 | if restore_main: | |
854 | sys.modules['__main__'] = restore_main |
|
854 | sys.modules['__main__'] = restore_main | |
855 | if '__mp_main__' in sys.modules: |
|
855 | if '__mp_main__' in sys.modules: | |
856 | sys.modules['__mp_main__'] = restore_main |
|
856 | sys.modules['__mp_main__'] = restore_main | |
857 | else: |
|
857 | else: | |
858 | # Remove from sys.modules the reference to main_mod we'd |
|
858 | # Remove from sys.modules the reference to main_mod we'd | |
859 | # added. Otherwise it will trap references to objects |
|
859 | # added. Otherwise it will trap references to objects | |
860 | # contained therein. |
|
860 | # contained therein. | |
861 | del sys.modules[main_mod_name] |
|
861 | del sys.modules[main_mod_name] | |
862 |
|
862 | |||
863 | return stats |
|
863 | return stats | |
864 |
|
864 | |||
865 | def _run_with_debugger(self, code, code_ns, filename=None, |
|
865 | def _run_with_debugger(self, code, code_ns, filename=None, | |
866 | bp_line=None, bp_file=None): |
|
866 | bp_line=None, bp_file=None): | |
867 | """ |
|
867 | """ | |
868 | Run `code` in debugger with a break point. |
|
868 | Run `code` in debugger with a break point. | |
869 |
|
869 | |||
870 | Parameters |
|
870 | Parameters | |
871 | ---------- |
|
871 | ---------- | |
872 | code : str |
|
872 | code : str | |
873 | Code to execute. |
|
873 | Code to execute. | |
874 | code_ns : dict |
|
874 | code_ns : dict | |
875 | A namespace in which `code` is executed. |
|
875 | A namespace in which `code` is executed. | |
876 | filename : str |
|
876 | filename : str | |
877 | `code` is ran as if it is in `filename`. |
|
877 | `code` is ran as if it is in `filename`. | |
878 | bp_line : int, optional |
|
878 | bp_line : int, optional | |
879 | Line number of the break point. |
|
879 | Line number of the break point. | |
880 | bp_file : str, optional |
|
880 | bp_file : str, optional | |
881 | Path to the file in which break point is specified. |
|
881 | Path to the file in which break point is specified. | |
882 | `filename` is used if not given. |
|
882 | `filename` is used if not given. | |
883 |
|
883 | |||
884 | Raises |
|
884 | Raises | |
885 | ------ |
|
885 | ------ | |
886 | UsageError |
|
886 | UsageError | |
887 | If the break point given by `bp_line` is not valid. |
|
887 | If the break point given by `bp_line` is not valid. | |
888 |
|
888 | |||
889 | """ |
|
889 | """ | |
890 | deb = self.shell.InteractiveTB.pdb |
|
890 | deb = self.shell.InteractiveTB.pdb | |
891 | if not deb: |
|
891 | if not deb: | |
892 | self.shell.InteractiveTB.pdb = self.shell.InteractiveTB.debugger_cls() |
|
892 | self.shell.InteractiveTB.pdb = self.shell.InteractiveTB.debugger_cls() | |
893 | deb = self.shell.InteractiveTB.pdb |
|
893 | deb = self.shell.InteractiveTB.pdb | |
894 |
|
894 | |||
895 | # deb.checkline() fails if deb.curframe exists but is None; it can |
|
895 | # deb.checkline() fails if deb.curframe exists but is None; it can | |
896 | # handle it not existing. https://github.com/ipython/ipython/issues/10028 |
|
896 | # handle it not existing. https://github.com/ipython/ipython/issues/10028 | |
897 | if hasattr(deb, 'curframe'): |
|
897 | if hasattr(deb, 'curframe'): | |
898 | del deb.curframe |
|
898 | del deb.curframe | |
899 |
|
899 | |||
900 | # reset Breakpoint state, which is moronically kept |
|
900 | # reset Breakpoint state, which is moronically kept | |
901 | # in a class |
|
901 | # in a class | |
902 | bdb.Breakpoint.next = 1 |
|
902 | bdb.Breakpoint.next = 1 | |
903 | bdb.Breakpoint.bplist = {} |
|
903 | bdb.Breakpoint.bplist = {} | |
904 | bdb.Breakpoint.bpbynumber = [None] |
|
904 | bdb.Breakpoint.bpbynumber = [None] | |
905 | deb.clear_all_breaks() |
|
905 | deb.clear_all_breaks() | |
906 | if bp_line is not None: |
|
906 | if bp_line is not None: | |
907 | # Set an initial breakpoint to stop execution |
|
907 | # Set an initial breakpoint to stop execution | |
908 | maxtries = 10 |
|
908 | maxtries = 10 | |
909 | bp_file = bp_file or filename |
|
909 | bp_file = bp_file or filename | |
910 | checkline = deb.checkline(bp_file, bp_line) |
|
910 | checkline = deb.checkline(bp_file, bp_line) | |
911 | if not checkline: |
|
911 | if not checkline: | |
912 | for bp in range(bp_line + 1, bp_line + maxtries + 1): |
|
912 | for bp in range(bp_line + 1, bp_line + maxtries + 1): | |
913 | if deb.checkline(bp_file, bp): |
|
913 | if deb.checkline(bp_file, bp): | |
914 | break |
|
914 | break | |
915 | else: |
|
915 | else: | |
916 | msg = ("\nI failed to find a valid line to set " |
|
916 | msg = ("\nI failed to find a valid line to set " | |
917 | "a breakpoint\n" |
|
917 | "a breakpoint\n" | |
918 | "after trying up to line: %s.\n" |
|
918 | "after trying up to line: %s.\n" | |
919 | "Please set a valid breakpoint manually " |
|
919 | "Please set a valid breakpoint manually " | |
920 | "with the -b option." % bp) |
|
920 | "with the -b option." % bp) | |
921 | raise UsageError(msg) |
|
921 | raise UsageError(msg) | |
922 | # if we find a good linenumber, set the breakpoint |
|
922 | # if we find a good linenumber, set the breakpoint | |
923 | deb.do_break('%s:%s' % (bp_file, bp_line)) |
|
923 | deb.do_break('%s:%s' % (bp_file, bp_line)) | |
924 |
|
924 | |||
925 | if filename: |
|
925 | if filename: | |
926 | # Mimic Pdb._runscript(...) |
|
926 | # Mimic Pdb._runscript(...) | |
927 | deb._wait_for_mainpyfile = True |
|
927 | deb._wait_for_mainpyfile = True | |
928 | deb.mainpyfile = deb.canonic(filename) |
|
928 | deb.mainpyfile = deb.canonic(filename) | |
929 |
|
929 | |||
930 | # Start file run |
|
930 | # Start file run | |
931 | print("NOTE: Enter 'c' at the %s prompt to continue execution." % deb.prompt) |
|
931 | print("NOTE: Enter 'c' at the %s prompt to continue execution." % deb.prompt) | |
932 | try: |
|
932 | try: | |
933 | if filename: |
|
933 | if filename: | |
934 | # save filename so it can be used by methods on the deb object |
|
934 | # save filename so it can be used by methods on the deb object | |
935 | deb._exec_filename = filename |
|
935 | deb._exec_filename = filename | |
936 | while True: |
|
936 | while True: | |
937 | try: |
|
937 | try: | |
938 | trace = sys.gettrace() |
|
938 | trace = sys.gettrace() | |
939 | deb.run(code, code_ns) |
|
939 | deb.run(code, code_ns) | |
940 | except Restart: |
|
940 | except Restart: | |
941 | print("Restarting") |
|
941 | print("Restarting") | |
942 | if filename: |
|
942 | if filename: | |
943 | deb._wait_for_mainpyfile = True |
|
943 | deb._wait_for_mainpyfile = True | |
944 | deb.mainpyfile = deb.canonic(filename) |
|
944 | deb.mainpyfile = deb.canonic(filename) | |
945 | continue |
|
945 | continue | |
946 | else: |
|
946 | else: | |
947 | break |
|
947 | break | |
948 | finally: |
|
948 | finally: | |
949 | sys.settrace(trace) |
|
949 | sys.settrace(trace) | |
950 |
|
950 | |||
951 |
|
951 | |||
952 | except: |
|
952 | except: | |
953 | etype, value, tb = sys.exc_info() |
|
953 | etype, value, tb = sys.exc_info() | |
954 | # Skip three frames in the traceback: the %run one, |
|
954 | # Skip three frames in the traceback: the %run one, | |
955 | # one inside bdb.py, and the command-line typed by the |
|
955 | # one inside bdb.py, and the command-line typed by the | |
956 | # user (run by exec in pdb itself). |
|
956 | # user (run by exec in pdb itself). | |
957 | self.shell.InteractiveTB(etype, value, tb, tb_offset=3) |
|
957 | self.shell.InteractiveTB(etype, value, tb, tb_offset=3) | |
958 |
|
958 | |||
959 | @staticmethod |
|
959 | @staticmethod | |
960 | def _run_with_timing(run, nruns): |
|
960 | def _run_with_timing(run, nruns): | |
961 | """ |
|
961 | """ | |
962 | Run function `run` and print timing information. |
|
962 | Run function `run` and print timing information. | |
963 |
|
963 | |||
964 | Parameters |
|
964 | Parameters | |
965 | ---------- |
|
965 | ---------- | |
966 | run : callable |
|
966 | run : callable | |
967 | Any callable object which takes no argument. |
|
967 | Any callable object which takes no argument. | |
968 | nruns : int |
|
968 | nruns : int | |
969 | Number of times to execute `run`. |
|
969 | Number of times to execute `run`. | |
970 |
|
970 | |||
971 | """ |
|
971 | """ | |
972 | twall0 = time.perf_counter() |
|
972 | twall0 = time.perf_counter() | |
973 | if nruns == 1: |
|
973 | if nruns == 1: | |
974 | t0 = clock2() |
|
974 | t0 = clock2() | |
975 | run() |
|
975 | run() | |
976 | t1 = clock2() |
|
976 | t1 = clock2() | |
977 | t_usr = t1[0] - t0[0] |
|
977 | t_usr = t1[0] - t0[0] | |
978 | t_sys = t1[1] - t0[1] |
|
978 | t_sys = t1[1] - t0[1] | |
979 | print("\nIPython CPU timings (estimated):") |
|
979 | print("\nIPython CPU timings (estimated):") | |
980 | print(" User : %10.2f s." % t_usr) |
|
980 | print(" User : %10.2f s." % t_usr) | |
981 | print(" System : %10.2f s." % t_sys) |
|
981 | print(" System : %10.2f s." % t_sys) | |
982 | else: |
|
982 | else: | |
983 | runs = range(nruns) |
|
983 | runs = range(nruns) | |
984 | t0 = clock2() |
|
984 | t0 = clock2() | |
985 | for nr in runs: |
|
985 | for nr in runs: | |
986 | run() |
|
986 | run() | |
987 | t1 = clock2() |
|
987 | t1 = clock2() | |
988 | t_usr = t1[0] - t0[0] |
|
988 | t_usr = t1[0] - t0[0] | |
989 | t_sys = t1[1] - t0[1] |
|
989 | t_sys = t1[1] - t0[1] | |
990 | print("\nIPython CPU timings (estimated):") |
|
990 | print("\nIPython CPU timings (estimated):") | |
991 | print("Total runs performed:", nruns) |
|
991 | print("Total runs performed:", nruns) | |
992 | print(" Times : %10s %10s" % ('Total', 'Per run')) |
|
992 | print(" Times : %10s %10s" % ('Total', 'Per run')) | |
993 | print(" User : %10.2f s, %10.2f s." % (t_usr, t_usr / nruns)) |
|
993 | print(" User : %10.2f s, %10.2f s." % (t_usr, t_usr / nruns)) | |
994 | print(" System : %10.2f s, %10.2f s." % (t_sys, t_sys / nruns)) |
|
994 | print(" System : %10.2f s, %10.2f s." % (t_sys, t_sys / nruns)) | |
995 | twall1 = time.perf_counter() |
|
995 | twall1 = time.perf_counter() | |
996 | print("Wall time: %10.2f s." % (twall1 - twall0)) |
|
996 | print("Wall time: %10.2f s." % (twall1 - twall0)) | |
997 |
|
997 | |||
998 | @skip_doctest |
|
998 | @skip_doctest | |
999 | @no_var_expand |
|
999 | @no_var_expand | |
1000 | @line_cell_magic |
|
1000 | @line_cell_magic | |
1001 | @needs_local_scope |
|
1001 | @needs_local_scope | |
1002 | def timeit(self, line='', cell=None, local_ns=None): |
|
1002 | def timeit(self, line='', cell=None, local_ns=None): | |
1003 | """Time execution of a Python statement or expression |
|
1003 | """Time execution of a Python statement or expression | |
1004 |
|
1004 | |||
1005 | Usage, in line mode: |
|
1005 | Usage, in line mode: | |
1006 | %timeit [-n<N> -r<R> [-t|-c] -q -p<P> -o] statement |
|
1006 | %timeit [-n<N> -r<R> [-t|-c] -q -p<P> -o] statement | |
1007 | or in cell mode: |
|
1007 | or in cell mode: | |
1008 | %%timeit [-n<N> -r<R> [-t|-c] -q -p<P> -o] setup_code |
|
1008 | %%timeit [-n<N> -r<R> [-t|-c] -q -p<P> -o] setup_code | |
1009 | code |
|
1009 | code | |
1010 | code... |
|
1010 | code... | |
1011 |
|
1011 | |||
1012 | Time execution of a Python statement or expression using the timeit |
|
1012 | Time execution of a Python statement or expression using the timeit | |
1013 | module. This function can be used both as a line and cell magic: |
|
1013 | module. This function can be used both as a line and cell magic: | |
1014 |
|
1014 | |||
1015 | - In line mode you can time a single-line statement (though multiple |
|
1015 | - In line mode you can time a single-line statement (though multiple | |
1016 | ones can be chained with using semicolons). |
|
1016 | ones can be chained with using semicolons). | |
1017 |
|
1017 | |||
1018 | - In cell mode, the statement in the first line is used as setup code |
|
1018 | - In cell mode, the statement in the first line is used as setup code | |
1019 | (executed but not timed) and the body of the cell is timed. The cell |
|
1019 | (executed but not timed) and the body of the cell is timed. The cell | |
1020 | body has access to any variables created in the setup code. |
|
1020 | body has access to any variables created in the setup code. | |
1021 |
|
1021 | |||
1022 | Options: |
|
1022 | Options: | |
1023 | -n<N>: execute the given statement <N> times in a loop. If <N> is not |
|
1023 | -n<N>: execute the given statement <N> times in a loop. If <N> is not | |
1024 | provided, <N> is determined so as to get sufficient accuracy. |
|
1024 | provided, <N> is determined so as to get sufficient accuracy. | |
1025 |
|
1025 | |||
1026 | -r<R>: number of repeats <R>, each consisting of <N> loops, and take the |
|
1026 | -r<R>: number of repeats <R>, each consisting of <N> loops, and take the | |
1027 | best result. |
|
1027 | best result. | |
1028 | Default: 7 |
|
1028 | Default: 7 | |
1029 |
|
1029 | |||
1030 | -t: use time.time to measure the time, which is the default on Unix. |
|
1030 | -t: use time.time to measure the time, which is the default on Unix. | |
1031 | This function measures wall time. |
|
1031 | This function measures wall time. | |
1032 |
|
1032 | |||
1033 | -c: use time.clock to measure the time, which is the default on |
|
1033 | -c: use time.clock to measure the time, which is the default on | |
1034 | Windows and measures wall time. On Unix, resource.getrusage is used |
|
1034 | Windows and measures wall time. On Unix, resource.getrusage is used | |
1035 | instead and returns the CPU user time. |
|
1035 | instead and returns the CPU user time. | |
1036 |
|
1036 | |||
1037 | -p<P>: use a precision of <P> digits to display the timing result. |
|
1037 | -p<P>: use a precision of <P> digits to display the timing result. | |
1038 | Default: 3 |
|
1038 | Default: 3 | |
1039 |
|
1039 | |||
1040 | -q: Quiet, do not print result. |
|
1040 | -q: Quiet, do not print result. | |
1041 |
|
1041 | |||
1042 | -o: return a TimeitResult that can be stored in a variable to inspect |
|
1042 | -o: return a TimeitResult that can be stored in a variable to inspect | |
1043 | the result in more details. |
|
1043 | the result in more details. | |
1044 |
|
1044 | |||
1045 | .. versionchanged:: 7.3 |
|
1045 | .. versionchanged:: 7.3 | |
1046 | User variables are no longer expanded, |
|
1046 | User variables are no longer expanded, | |
1047 | the magic line is always left unmodified. |
|
1047 | the magic line is always left unmodified. | |
1048 |
|
1048 | |||
1049 | Examples |
|
1049 | Examples | |
1050 | -------- |
|
1050 | -------- | |
1051 | :: |
|
1051 | :: | |
1052 |
|
1052 | |||
1053 | In [1]: %timeit pass |
|
1053 | In [1]: %timeit pass | |
1054 | 8.26 ns Β± 0.12 ns per loop (mean Β± std. dev. of 7 runs, 100000000 loops each) |
|
1054 | 8.26 ns Β± 0.12 ns per loop (mean Β± std. dev. of 7 runs, 100000000 loops each) | |
1055 |
|
1055 | |||
1056 | In [2]: u = None |
|
1056 | In [2]: u = None | |
1057 |
|
1057 | |||
1058 | In [3]: %timeit u is None |
|
1058 | In [3]: %timeit u is None | |
1059 | 29.9 ns Β± 0.643 ns per loop (mean Β± std. dev. of 7 runs, 10000000 loops each) |
|
1059 | 29.9 ns Β± 0.643 ns per loop (mean Β± std. dev. of 7 runs, 10000000 loops each) | |
1060 |
|
1060 | |||
1061 | In [4]: %timeit -r 4 u == None |
|
1061 | In [4]: %timeit -r 4 u == None | |
1062 |
|
1062 | |||
1063 | In [5]: import time |
|
1063 | In [5]: import time | |
1064 |
|
1064 | |||
1065 | In [6]: %timeit -n1 time.sleep(2) |
|
1065 | In [6]: %timeit -n1 time.sleep(2) | |
1066 |
|
1066 | |||
1067 |
|
1067 | |||
1068 | The times reported by %timeit will be slightly higher than those |
|
1068 | The times reported by %timeit will be slightly higher than those | |
1069 | reported by the timeit.py script when variables are accessed. This is |
|
1069 | reported by the timeit.py script when variables are accessed. This is | |
1070 | due to the fact that %timeit executes the statement in the namespace |
|
1070 | due to the fact that %timeit executes the statement in the namespace | |
1071 | of the shell, compared with timeit.py, which uses a single setup |
|
1071 | of the shell, compared with timeit.py, which uses a single setup | |
1072 | statement to import function or create variables. Generally, the bias |
|
1072 | statement to import function or create variables. Generally, the bias | |
1073 | does not matter as long as results from timeit.py are not mixed with |
|
1073 | does not matter as long as results from timeit.py are not mixed with | |
1074 | those from %timeit.""" |
|
1074 | those from %timeit.""" | |
1075 |
|
1075 | |||
1076 |
opts, stmt = self.parse_options( |
|
1076 | opts, stmt = self.parse_options( | |
1077 | posix=False, strict=False) |
|
1077 | line, "n:r:tcp:qo", posix=False, strict=False, preserve_non_opts=True | |
|
1078 | ) | |||
1078 | if stmt == "" and cell is None: |
|
1079 | if stmt == "" and cell is None: | |
1079 | return |
|
1080 | return | |
1080 |
|
1081 | |||
1081 | timefunc = timeit.default_timer |
|
1082 | timefunc = timeit.default_timer | |
1082 | number = int(getattr(opts, "n", 0)) |
|
1083 | number = int(getattr(opts, "n", 0)) | |
1083 | default_repeat = 7 if timeit.default_repeat < 7 else timeit.default_repeat |
|
1084 | default_repeat = 7 if timeit.default_repeat < 7 else timeit.default_repeat | |
1084 | repeat = int(getattr(opts, "r", default_repeat)) |
|
1085 | repeat = int(getattr(opts, "r", default_repeat)) | |
1085 | precision = int(getattr(opts, "p", 3)) |
|
1086 | precision = int(getattr(opts, "p", 3)) | |
1086 | quiet = 'q' in opts |
|
1087 | quiet = 'q' in opts | |
1087 | return_result = 'o' in opts |
|
1088 | return_result = 'o' in opts | |
1088 | if hasattr(opts, "t"): |
|
1089 | if hasattr(opts, "t"): | |
1089 | timefunc = time.time |
|
1090 | timefunc = time.time | |
1090 | if hasattr(opts, "c"): |
|
1091 | if hasattr(opts, "c"): | |
1091 | timefunc = clock |
|
1092 | timefunc = clock | |
1092 |
|
1093 | |||
1093 | timer = Timer(timer=timefunc) |
|
1094 | timer = Timer(timer=timefunc) | |
1094 | # this code has tight coupling to the inner workings of timeit.Timer, |
|
1095 | # this code has tight coupling to the inner workings of timeit.Timer, | |
1095 | # but is there a better way to achieve that the code stmt has access |
|
1096 | # but is there a better way to achieve that the code stmt has access | |
1096 | # to the shell namespace? |
|
1097 | # to the shell namespace? | |
1097 | transform = self.shell.transform_cell |
|
1098 | transform = self.shell.transform_cell | |
1098 |
|
1099 | |||
1099 | if cell is None: |
|
1100 | if cell is None: | |
1100 | # called as line magic |
|
1101 | # called as line magic | |
1101 | ast_setup = self.shell.compile.ast_parse("pass") |
|
1102 | ast_setup = self.shell.compile.ast_parse("pass") | |
1102 | ast_stmt = self.shell.compile.ast_parse(transform(stmt)) |
|
1103 | ast_stmt = self.shell.compile.ast_parse(transform(stmt)) | |
1103 | else: |
|
1104 | else: | |
1104 | ast_setup = self.shell.compile.ast_parse(transform(stmt)) |
|
1105 | ast_setup = self.shell.compile.ast_parse(transform(stmt)) | |
1105 | ast_stmt = self.shell.compile.ast_parse(transform(cell)) |
|
1106 | ast_stmt = self.shell.compile.ast_parse(transform(cell)) | |
1106 |
|
1107 | |||
1107 | ast_setup = self.shell.transform_ast(ast_setup) |
|
1108 | ast_setup = self.shell.transform_ast(ast_setup) | |
1108 | ast_stmt = self.shell.transform_ast(ast_stmt) |
|
1109 | ast_stmt = self.shell.transform_ast(ast_stmt) | |
1109 |
|
1110 | |||
1110 | # Check that these compile to valid Python code *outside* the timer func |
|
1111 | # Check that these compile to valid Python code *outside* the timer func | |
1111 | # Invalid code may become valid when put inside the function & loop, |
|
1112 | # Invalid code may become valid when put inside the function & loop, | |
1112 | # which messes up error messages. |
|
1113 | # which messes up error messages. | |
1113 | # https://github.com/ipython/ipython/issues/10636 |
|
1114 | # https://github.com/ipython/ipython/issues/10636 | |
1114 | self.shell.compile(ast_setup, "<magic-timeit-setup>", "exec") |
|
1115 | self.shell.compile(ast_setup, "<magic-timeit-setup>", "exec") | |
1115 | self.shell.compile(ast_stmt, "<magic-timeit-stmt>", "exec") |
|
1116 | self.shell.compile(ast_stmt, "<magic-timeit-stmt>", "exec") | |
1116 |
|
1117 | |||
1117 | # This codestring is taken from timeit.template - we fill it in as an |
|
1118 | # This codestring is taken from timeit.template - we fill it in as an | |
1118 | # AST, so that we can apply our AST transformations to the user code |
|
1119 | # AST, so that we can apply our AST transformations to the user code | |
1119 | # without affecting the timing code. |
|
1120 | # without affecting the timing code. | |
1120 | timeit_ast_template = ast.parse('def inner(_it, _timer):\n' |
|
1121 | timeit_ast_template = ast.parse('def inner(_it, _timer):\n' | |
1121 | ' setup\n' |
|
1122 | ' setup\n' | |
1122 | ' _t0 = _timer()\n' |
|
1123 | ' _t0 = _timer()\n' | |
1123 | ' for _i in _it:\n' |
|
1124 | ' for _i in _it:\n' | |
1124 | ' stmt\n' |
|
1125 | ' stmt\n' | |
1125 | ' _t1 = _timer()\n' |
|
1126 | ' _t1 = _timer()\n' | |
1126 | ' return _t1 - _t0\n') |
|
1127 | ' return _t1 - _t0\n') | |
1127 |
|
1128 | |||
1128 | timeit_ast = TimeitTemplateFiller(ast_setup, ast_stmt).visit(timeit_ast_template) |
|
1129 | timeit_ast = TimeitTemplateFiller(ast_setup, ast_stmt).visit(timeit_ast_template) | |
1129 | timeit_ast = ast.fix_missing_locations(timeit_ast) |
|
1130 | timeit_ast = ast.fix_missing_locations(timeit_ast) | |
1130 |
|
1131 | |||
1131 | # Track compilation time so it can be reported if too long |
|
1132 | # Track compilation time so it can be reported if too long | |
1132 | # Minimum time above which compilation time will be reported |
|
1133 | # Minimum time above which compilation time will be reported | |
1133 | tc_min = 0.1 |
|
1134 | tc_min = 0.1 | |
1134 |
|
1135 | |||
1135 | t0 = clock() |
|
1136 | t0 = clock() | |
1136 | code = self.shell.compile(timeit_ast, "<magic-timeit>", "exec") |
|
1137 | code = self.shell.compile(timeit_ast, "<magic-timeit>", "exec") | |
1137 | tc = clock()-t0 |
|
1138 | tc = clock()-t0 | |
1138 |
|
1139 | |||
1139 | ns = {} |
|
1140 | ns = {} | |
1140 | glob = self.shell.user_ns |
|
1141 | glob = self.shell.user_ns | |
1141 | # handles global vars with same name as local vars. We store them in conflict_globs. |
|
1142 | # handles global vars with same name as local vars. We store them in conflict_globs. | |
1142 | conflict_globs = {} |
|
1143 | conflict_globs = {} | |
1143 | if local_ns and cell is None: |
|
1144 | if local_ns and cell is None: | |
1144 | for var_name, var_val in glob.items(): |
|
1145 | for var_name, var_val in glob.items(): | |
1145 | if var_name in local_ns: |
|
1146 | if var_name in local_ns: | |
1146 | conflict_globs[var_name] = var_val |
|
1147 | conflict_globs[var_name] = var_val | |
1147 | glob.update(local_ns) |
|
1148 | glob.update(local_ns) | |
1148 |
|
1149 | |||
1149 | exec(code, glob, ns) |
|
1150 | exec(code, glob, ns) | |
1150 | timer.inner = ns["inner"] |
|
1151 | timer.inner = ns["inner"] | |
1151 |
|
1152 | |||
1152 | # This is used to check if there is a huge difference between the |
|
1153 | # This is used to check if there is a huge difference between the | |
1153 | # best and worst timings. |
|
1154 | # best and worst timings. | |
1154 | # Issue: https://github.com/ipython/ipython/issues/6471 |
|
1155 | # Issue: https://github.com/ipython/ipython/issues/6471 | |
1155 | if number == 0: |
|
1156 | if number == 0: | |
1156 | # determine number so that 0.2 <= total time < 2.0 |
|
1157 | # determine number so that 0.2 <= total time < 2.0 | |
1157 | for index in range(0, 10): |
|
1158 | for index in range(0, 10): | |
1158 | number = 10 ** index |
|
1159 | number = 10 ** index | |
1159 | time_number = timer.timeit(number) |
|
1160 | time_number = timer.timeit(number) | |
1160 | if time_number >= 0.2: |
|
1161 | if time_number >= 0.2: | |
1161 | break |
|
1162 | break | |
1162 |
|
1163 | |||
1163 | all_runs = timer.repeat(repeat, number) |
|
1164 | all_runs = timer.repeat(repeat, number) | |
1164 | best = min(all_runs) / number |
|
1165 | best = min(all_runs) / number | |
1165 | worst = max(all_runs) / number |
|
1166 | worst = max(all_runs) / number | |
1166 | timeit_result = TimeitResult(number, repeat, best, worst, all_runs, tc, precision) |
|
1167 | timeit_result = TimeitResult(number, repeat, best, worst, all_runs, tc, precision) | |
1167 |
|
1168 | |||
1168 | # Restore global vars from conflict_globs |
|
1169 | # Restore global vars from conflict_globs | |
1169 | if conflict_globs: |
|
1170 | if conflict_globs: | |
1170 | glob.update(conflict_globs) |
|
1171 | glob.update(conflict_globs) | |
1171 |
|
1172 | |||
1172 | if not quiet : |
|
1173 | if not quiet : | |
1173 | # Check best timing is greater than zero to avoid a |
|
1174 | # Check best timing is greater than zero to avoid a | |
1174 | # ZeroDivisionError. |
|
1175 | # ZeroDivisionError. | |
1175 | # In cases where the slowest timing is lesser than a microsecond |
|
1176 | # In cases where the slowest timing is lesser than a microsecond | |
1176 | # we assume that it does not really matter if the fastest |
|
1177 | # we assume that it does not really matter if the fastest | |
1177 | # timing is 4 times faster than the slowest timing or not. |
|
1178 | # timing is 4 times faster than the slowest timing or not. | |
1178 | if worst > 4 * best and best > 0 and worst > 1e-6: |
|
1179 | if worst > 4 * best and best > 0 and worst > 1e-6: | |
1179 | print("The slowest run took %0.2f times longer than the " |
|
1180 | print("The slowest run took %0.2f times longer than the " | |
1180 | "fastest. This could mean that an intermediate result " |
|
1181 | "fastest. This could mean that an intermediate result " | |
1181 | "is being cached." % (worst / best)) |
|
1182 | "is being cached." % (worst / best)) | |
1182 |
|
1183 | |||
1183 | print( timeit_result ) |
|
1184 | print( timeit_result ) | |
1184 |
|
1185 | |||
1185 | if tc > tc_min: |
|
1186 | if tc > tc_min: | |
1186 | print("Compiler time: %.2f s" % tc) |
|
1187 | print("Compiler time: %.2f s" % tc) | |
1187 | if return_result: |
|
1188 | if return_result: | |
1188 | return timeit_result |
|
1189 | return timeit_result | |
1189 |
|
1190 | |||
1190 | @skip_doctest |
|
1191 | @skip_doctest | |
1191 | @no_var_expand |
|
1192 | @no_var_expand | |
1192 | @needs_local_scope |
|
1193 | @needs_local_scope | |
1193 | @line_cell_magic |
|
1194 | @line_cell_magic | |
1194 | def time(self,line='', cell=None, local_ns=None): |
|
1195 | def time(self,line='', cell=None, local_ns=None): | |
1195 | """Time execution of a Python statement or expression. |
|
1196 | """Time execution of a Python statement or expression. | |
1196 |
|
1197 | |||
1197 | The CPU and wall clock times are printed, and the value of the |
|
1198 | The CPU and wall clock times are printed, and the value of the | |
1198 | expression (if any) is returned. Note that under Win32, system time |
|
1199 | expression (if any) is returned. Note that under Win32, system time | |
1199 | is always reported as 0, since it can not be measured. |
|
1200 | is always reported as 0, since it can not be measured. | |
1200 |
|
1201 | |||
1201 | This function can be used both as a line and cell magic: |
|
1202 | This function can be used both as a line and cell magic: | |
1202 |
|
1203 | |||
1203 | - In line mode you can time a single-line statement (though multiple |
|
1204 | - In line mode you can time a single-line statement (though multiple | |
1204 | ones can be chained with using semicolons). |
|
1205 | ones can be chained with using semicolons). | |
1205 |
|
1206 | |||
1206 | - In cell mode, you can time the cell body (a directly |
|
1207 | - In cell mode, you can time the cell body (a directly | |
1207 | following statement raises an error). |
|
1208 | following statement raises an error). | |
1208 |
|
1209 | |||
1209 | This function provides very basic timing functionality. Use the timeit |
|
1210 | This function provides very basic timing functionality. Use the timeit | |
1210 | magic for more control over the measurement. |
|
1211 | magic for more control over the measurement. | |
1211 |
|
1212 | |||
1212 | .. versionchanged:: 7.3 |
|
1213 | .. versionchanged:: 7.3 | |
1213 | User variables are no longer expanded, |
|
1214 | User variables are no longer expanded, | |
1214 | the magic line is always left unmodified. |
|
1215 | the magic line is always left unmodified. | |
1215 |
|
1216 | |||
1216 | Examples |
|
1217 | Examples | |
1217 | -------- |
|
1218 | -------- | |
1218 | :: |
|
1219 | :: | |
1219 |
|
1220 | |||
1220 | In [1]: %time 2**128 |
|
1221 | In [1]: %time 2**128 | |
1221 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1222 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s | |
1222 | Wall time: 0.00 |
|
1223 | Wall time: 0.00 | |
1223 | Out[1]: 340282366920938463463374607431768211456L |
|
1224 | Out[1]: 340282366920938463463374607431768211456L | |
1224 |
|
1225 | |||
1225 | In [2]: n = 1000000 |
|
1226 | In [2]: n = 1000000 | |
1226 |
|
1227 | |||
1227 | In [3]: %time sum(range(n)) |
|
1228 | In [3]: %time sum(range(n)) | |
1228 | CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s |
|
1229 | CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s | |
1229 | Wall time: 1.37 |
|
1230 | Wall time: 1.37 | |
1230 | Out[3]: 499999500000L |
|
1231 | Out[3]: 499999500000L | |
1231 |
|
1232 | |||
1232 | In [4]: %time print 'hello world' |
|
1233 | In [4]: %time print 'hello world' | |
1233 | hello world |
|
1234 | hello world | |
1234 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1235 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s | |
1235 | Wall time: 0.00 |
|
1236 | Wall time: 0.00 | |
1236 |
|
1237 | |||
1237 | Note that the time needed by Python to compile the given expression |
|
1238 | Note that the time needed by Python to compile the given expression | |
1238 | will be reported if it is more than 0.1s. In this example, the |
|
1239 | will be reported if it is more than 0.1s. In this example, the | |
1239 | actual exponentiation is done by Python at compilation time, so while |
|
1240 | actual exponentiation is done by Python at compilation time, so while | |
1240 | the expression can take a noticeable amount of time to compute, that |
|
1241 | the expression can take a noticeable amount of time to compute, that | |
1241 | time is purely due to the compilation: |
|
1242 | time is purely due to the compilation: | |
1242 |
|
1243 | |||
1243 | In [5]: %time 3**9999; |
|
1244 | In [5]: %time 3**9999; | |
1244 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1245 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s | |
1245 | Wall time: 0.00 s |
|
1246 | Wall time: 0.00 s | |
1246 |
|
1247 | |||
1247 | In [6]: %time 3**999999; |
|
1248 | In [6]: %time 3**999999; | |
1248 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1249 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s | |
1249 | Wall time: 0.00 s |
|
1250 | Wall time: 0.00 s | |
1250 | Compiler : 0.78 s |
|
1251 | Compiler : 0.78 s | |
1251 | """ |
|
1252 | """ | |
1252 |
|
1253 | |||
1253 | # fail immediately if the given expression can't be compiled |
|
1254 | # fail immediately if the given expression can't be compiled | |
1254 |
|
1255 | |||
1255 | if line and cell: |
|
1256 | if line and cell: | |
1256 | raise UsageError("Can't use statement directly after '%%time'!") |
|
1257 | raise UsageError("Can't use statement directly after '%%time'!") | |
1257 |
|
1258 | |||
1258 | if cell: |
|
1259 | if cell: | |
1259 | expr = self.shell.transform_cell(cell) |
|
1260 | expr = self.shell.transform_cell(cell) | |
1260 | else: |
|
1261 | else: | |
1261 | expr = self.shell.transform_cell(line) |
|
1262 | expr = self.shell.transform_cell(line) | |
1262 |
|
1263 | |||
1263 | # Minimum time above which parse time will be reported |
|
1264 | # Minimum time above which parse time will be reported | |
1264 | tp_min = 0.1 |
|
1265 | tp_min = 0.1 | |
1265 |
|
1266 | |||
1266 | t0 = clock() |
|
1267 | t0 = clock() | |
1267 | expr_ast = self.shell.compile.ast_parse(expr) |
|
1268 | expr_ast = self.shell.compile.ast_parse(expr) | |
1268 | tp = clock()-t0 |
|
1269 | tp = clock()-t0 | |
1269 |
|
1270 | |||
1270 | # Apply AST transformations |
|
1271 | # Apply AST transformations | |
1271 | expr_ast = self.shell.transform_ast(expr_ast) |
|
1272 | expr_ast = self.shell.transform_ast(expr_ast) | |
1272 |
|
1273 | |||
1273 | # Minimum time above which compilation time will be reported |
|
1274 | # Minimum time above which compilation time will be reported | |
1274 | tc_min = 0.1 |
|
1275 | tc_min = 0.1 | |
1275 |
|
1276 | |||
1276 | expr_val=None |
|
1277 | expr_val=None | |
1277 | if len(expr_ast.body)==1 and isinstance(expr_ast.body[0], ast.Expr): |
|
1278 | if len(expr_ast.body)==1 and isinstance(expr_ast.body[0], ast.Expr): | |
1278 | mode = 'eval' |
|
1279 | mode = 'eval' | |
1279 | source = '<timed eval>' |
|
1280 | source = '<timed eval>' | |
1280 | expr_ast = ast.Expression(expr_ast.body[0].value) |
|
1281 | expr_ast = ast.Expression(expr_ast.body[0].value) | |
1281 | else: |
|
1282 | else: | |
1282 | mode = 'exec' |
|
1283 | mode = 'exec' | |
1283 | source = '<timed exec>' |
|
1284 | source = '<timed exec>' | |
1284 | # multi-line %%time case |
|
1285 | # multi-line %%time case | |
1285 | if len(expr_ast.body) > 1 and isinstance(expr_ast.body[-1], ast.Expr): |
|
1286 | if len(expr_ast.body) > 1 and isinstance(expr_ast.body[-1], ast.Expr): | |
1286 | expr_val= expr_ast.body[-1] |
|
1287 | expr_val= expr_ast.body[-1] | |
1287 | expr_ast = expr_ast.body[:-1] |
|
1288 | expr_ast = expr_ast.body[:-1] | |
1288 | expr_ast = Module(expr_ast, []) |
|
1289 | expr_ast = Module(expr_ast, []) | |
1289 | expr_val = ast.Expression(expr_val.value) |
|
1290 | expr_val = ast.Expression(expr_val.value) | |
1290 |
|
1291 | |||
1291 | t0 = clock() |
|
1292 | t0 = clock() | |
1292 | code = self.shell.compile(expr_ast, source, mode) |
|
1293 | code = self.shell.compile(expr_ast, source, mode) | |
1293 | tc = clock()-t0 |
|
1294 | tc = clock()-t0 | |
1294 |
|
1295 | |||
1295 | # skew measurement as little as possible |
|
1296 | # skew measurement as little as possible | |
1296 | glob = self.shell.user_ns |
|
1297 | glob = self.shell.user_ns | |
1297 | wtime = time.time |
|
1298 | wtime = time.time | |
1298 | # time execution |
|
1299 | # time execution | |
1299 | wall_st = wtime() |
|
1300 | wall_st = wtime() | |
1300 | if mode=='eval': |
|
1301 | if mode=='eval': | |
1301 | st = clock2() |
|
1302 | st = clock2() | |
1302 | try: |
|
1303 | try: | |
1303 | out = eval(code, glob, local_ns) |
|
1304 | out = eval(code, glob, local_ns) | |
1304 | except: |
|
1305 | except: | |
1305 | self.shell.showtraceback() |
|
1306 | self.shell.showtraceback() | |
1306 | return |
|
1307 | return | |
1307 | end = clock2() |
|
1308 | end = clock2() | |
1308 | else: |
|
1309 | else: | |
1309 | st = clock2() |
|
1310 | st = clock2() | |
1310 | try: |
|
1311 | try: | |
1311 | exec(code, glob, local_ns) |
|
1312 | exec(code, glob, local_ns) | |
1312 | out=None |
|
1313 | out=None | |
1313 | # multi-line %%time case |
|
1314 | # multi-line %%time case | |
1314 | if expr_val is not None: |
|
1315 | if expr_val is not None: | |
1315 | code_2 = self.shell.compile(expr_val, source, 'eval') |
|
1316 | code_2 = self.shell.compile(expr_val, source, 'eval') | |
1316 | out = eval(code_2, glob, local_ns) |
|
1317 | out = eval(code_2, glob, local_ns) | |
1317 | except: |
|
1318 | except: | |
1318 | self.shell.showtraceback() |
|
1319 | self.shell.showtraceback() | |
1319 | return |
|
1320 | return | |
1320 | end = clock2() |
|
1321 | end = clock2() | |
1321 |
|
1322 | |||
1322 | wall_end = wtime() |
|
1323 | wall_end = wtime() | |
1323 | # Compute actual times and report |
|
1324 | # Compute actual times and report | |
1324 | wall_time = wall_end-wall_st |
|
1325 | wall_time = wall_end-wall_st | |
1325 | cpu_user = end[0]-st[0] |
|
1326 | cpu_user = end[0]-st[0] | |
1326 | cpu_sys = end[1]-st[1] |
|
1327 | cpu_sys = end[1]-st[1] | |
1327 | cpu_tot = cpu_user+cpu_sys |
|
1328 | cpu_tot = cpu_user+cpu_sys | |
1328 | # On windows cpu_sys is always zero, so no new information to the next print |
|
1329 | # On windows cpu_sys is always zero, so no new information to the next print | |
1329 | if sys.platform != 'win32': |
|
1330 | if sys.platform != 'win32': | |
1330 | print("CPU times: user %s, sys: %s, total: %s" % \ |
|
1331 | print("CPU times: user %s, sys: %s, total: %s" % \ | |
1331 | (_format_time(cpu_user),_format_time(cpu_sys),_format_time(cpu_tot))) |
|
1332 | (_format_time(cpu_user),_format_time(cpu_sys),_format_time(cpu_tot))) | |
1332 | print("Wall time: %s" % _format_time(wall_time)) |
|
1333 | print("Wall time: %s" % _format_time(wall_time)) | |
1333 | if tc > tc_min: |
|
1334 | if tc > tc_min: | |
1334 | print("Compiler : %s" % _format_time(tc)) |
|
1335 | print("Compiler : %s" % _format_time(tc)) | |
1335 | if tp > tp_min: |
|
1336 | if tp > tp_min: | |
1336 | print("Parser : %s" % _format_time(tp)) |
|
1337 | print("Parser : %s" % _format_time(tp)) | |
1337 | return out |
|
1338 | return out | |
1338 |
|
1339 | |||
1339 | @skip_doctest |
|
1340 | @skip_doctest | |
1340 | @line_magic |
|
1341 | @line_magic | |
1341 | def macro(self, parameter_s=''): |
|
1342 | def macro(self, parameter_s=''): | |
1342 | """Define a macro for future re-execution. It accepts ranges of history, |
|
1343 | """Define a macro for future re-execution. It accepts ranges of history, | |
1343 | filenames or string objects. |
|
1344 | filenames or string objects. | |
1344 |
|
1345 | |||
1345 | Usage:\\ |
|
1346 | Usage:\\ | |
1346 | %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ... |
|
1347 | %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ... | |
1347 |
|
1348 | |||
1348 | Options: |
|
1349 | Options: | |
1349 |
|
1350 | |||
1350 | -r: use 'raw' input. By default, the 'processed' history is used, |
|
1351 | -r: use 'raw' input. By default, the 'processed' history is used, | |
1351 | so that magics are loaded in their transformed version to valid |
|
1352 | so that magics are loaded in their transformed version to valid | |
1352 | Python. If this option is given, the raw input as typed at the |
|
1353 | Python. If this option is given, the raw input as typed at the | |
1353 | command line is used instead. |
|
1354 | command line is used instead. | |
1354 |
|
1355 | |||
1355 | -q: quiet macro definition. By default, a tag line is printed |
|
1356 | -q: quiet macro definition. By default, a tag line is printed | |
1356 | to indicate the macro has been created, and then the contents of |
|
1357 | to indicate the macro has been created, and then the contents of | |
1357 | the macro are printed. If this option is given, then no printout |
|
1358 | the macro are printed. If this option is given, then no printout | |
1358 | is produced once the macro is created. |
|
1359 | is produced once the macro is created. | |
1359 |
|
1360 | |||
1360 | This will define a global variable called `name` which is a string |
|
1361 | This will define a global variable called `name` which is a string | |
1361 | made of joining the slices and lines you specify (n1,n2,... numbers |
|
1362 | made of joining the slices and lines you specify (n1,n2,... numbers | |
1362 | above) from your input history into a single string. This variable |
|
1363 | above) from your input history into a single string. This variable | |
1363 | acts like an automatic function which re-executes those lines as if |
|
1364 | acts like an automatic function which re-executes those lines as if | |
1364 | you had typed them. You just type 'name' at the prompt and the code |
|
1365 | you had typed them. You just type 'name' at the prompt and the code | |
1365 | executes. |
|
1366 | executes. | |
1366 |
|
1367 | |||
1367 | The syntax for indicating input ranges is described in %history. |
|
1368 | The syntax for indicating input ranges is described in %history. | |
1368 |
|
1369 | |||
1369 | Note: as a 'hidden' feature, you can also use traditional python slice |
|
1370 | Note: as a 'hidden' feature, you can also use traditional python slice | |
1370 | notation, where N:M means numbers N through M-1. |
|
1371 | notation, where N:M means numbers N through M-1. | |
1371 |
|
1372 | |||
1372 | For example, if your history contains (print using %hist -n ):: |
|
1373 | For example, if your history contains (print using %hist -n ):: | |
1373 |
|
1374 | |||
1374 | 44: x=1 |
|
1375 | 44: x=1 | |
1375 | 45: y=3 |
|
1376 | 45: y=3 | |
1376 | 46: z=x+y |
|
1377 | 46: z=x+y | |
1377 | 47: print x |
|
1378 | 47: print x | |
1378 | 48: a=5 |
|
1379 | 48: a=5 | |
1379 | 49: print 'x',x,'y',y |
|
1380 | 49: print 'x',x,'y',y | |
1380 |
|
1381 | |||
1381 | you can create a macro with lines 44 through 47 (included) and line 49 |
|
1382 | you can create a macro with lines 44 through 47 (included) and line 49 | |
1382 | called my_macro with:: |
|
1383 | called my_macro with:: | |
1383 |
|
1384 | |||
1384 | In [55]: %macro my_macro 44-47 49 |
|
1385 | In [55]: %macro my_macro 44-47 49 | |
1385 |
|
1386 | |||
1386 | Now, typing `my_macro` (without quotes) will re-execute all this code |
|
1387 | Now, typing `my_macro` (without quotes) will re-execute all this code | |
1387 | in one pass. |
|
1388 | in one pass. | |
1388 |
|
1389 | |||
1389 | You don't need to give the line-numbers in order, and any given line |
|
1390 | You don't need to give the line-numbers in order, and any given line | |
1390 | number can appear multiple times. You can assemble macros with any |
|
1391 | number can appear multiple times. You can assemble macros with any | |
1391 | lines from your input history in any order. |
|
1392 | lines from your input history in any order. | |
1392 |
|
1393 | |||
1393 | The macro is a simple object which holds its value in an attribute, |
|
1394 | The macro is a simple object which holds its value in an attribute, | |
1394 | but IPython's display system checks for macros and executes them as |
|
1395 | but IPython's display system checks for macros and executes them as | |
1395 | code instead of printing them when you type their name. |
|
1396 | code instead of printing them when you type their name. | |
1396 |
|
1397 | |||
1397 | You can view a macro's contents by explicitly printing it with:: |
|
1398 | You can view a macro's contents by explicitly printing it with:: | |
1398 |
|
1399 | |||
1399 | print macro_name |
|
1400 | print macro_name | |
1400 |
|
1401 | |||
1401 | """ |
|
1402 | """ | |
1402 | opts,args = self.parse_options(parameter_s,'rq',mode='list') |
|
1403 | opts,args = self.parse_options(parameter_s,'rq',mode='list') | |
1403 | if not args: # List existing macros |
|
1404 | if not args: # List existing macros | |
1404 | return sorted(k for k,v in self.shell.user_ns.items() if isinstance(v, Macro)) |
|
1405 | return sorted(k for k,v in self.shell.user_ns.items() if isinstance(v, Macro)) | |
1405 | if len(args) == 1: |
|
1406 | if len(args) == 1: | |
1406 | raise UsageError( |
|
1407 | raise UsageError( | |
1407 | "%macro insufficient args; usage '%macro name n1-n2 n3-4...") |
|
1408 | "%macro insufficient args; usage '%macro name n1-n2 n3-4...") | |
1408 | name, codefrom = args[0], " ".join(args[1:]) |
|
1409 | name, codefrom = args[0], " ".join(args[1:]) | |
1409 |
|
1410 | |||
1410 | #print 'rng',ranges # dbg |
|
1411 | #print 'rng',ranges # dbg | |
1411 | try: |
|
1412 | try: | |
1412 | lines = self.shell.find_user_code(codefrom, 'r' in opts) |
|
1413 | lines = self.shell.find_user_code(codefrom, 'r' in opts) | |
1413 | except (ValueError, TypeError) as e: |
|
1414 | except (ValueError, TypeError) as e: | |
1414 | print(e.args[0]) |
|
1415 | print(e.args[0]) | |
1415 | return |
|
1416 | return | |
1416 | macro = Macro(lines) |
|
1417 | macro = Macro(lines) | |
1417 | self.shell.define_macro(name, macro) |
|
1418 | self.shell.define_macro(name, macro) | |
1418 | if not ( 'q' in opts) : |
|
1419 | if not ( 'q' in opts) : | |
1419 | print('Macro `%s` created. To execute, type its name (without quotes).' % name) |
|
1420 | print('Macro `%s` created. To execute, type its name (without quotes).' % name) | |
1420 | print('=== Macro contents: ===') |
|
1421 | print('=== Macro contents: ===') | |
1421 | print(macro, end=' ') |
|
1422 | print(macro, end=' ') | |
1422 |
|
1423 | |||
1423 | @magic_arguments.magic_arguments() |
|
1424 | @magic_arguments.magic_arguments() | |
1424 | @magic_arguments.argument('output', type=str, default='', nargs='?', |
|
1425 | @magic_arguments.argument('output', type=str, default='', nargs='?', | |
1425 | help="""The name of the variable in which to store output. |
|
1426 | help="""The name of the variable in which to store output. | |
1426 | This is a utils.io.CapturedIO object with stdout/err attributes |
|
1427 | This is a utils.io.CapturedIO object with stdout/err attributes | |
1427 | for the text of the captured output. |
|
1428 | for the text of the captured output. | |
1428 |
|
1429 | |||
1429 | CapturedOutput also has a show() method for displaying the output, |
|
1430 | CapturedOutput also has a show() method for displaying the output, | |
1430 | and __call__ as well, so you can use that to quickly display the |
|
1431 | and __call__ as well, so you can use that to quickly display the | |
1431 | output. |
|
1432 | output. | |
1432 |
|
1433 | |||
1433 | If unspecified, captured output is discarded. |
|
1434 | If unspecified, captured output is discarded. | |
1434 | """ |
|
1435 | """ | |
1435 | ) |
|
1436 | ) | |
1436 | @magic_arguments.argument('--no-stderr', action="store_true", |
|
1437 | @magic_arguments.argument('--no-stderr', action="store_true", | |
1437 | help="""Don't capture stderr.""" |
|
1438 | help="""Don't capture stderr.""" | |
1438 | ) |
|
1439 | ) | |
1439 | @magic_arguments.argument('--no-stdout', action="store_true", |
|
1440 | @magic_arguments.argument('--no-stdout', action="store_true", | |
1440 | help="""Don't capture stdout.""" |
|
1441 | help="""Don't capture stdout.""" | |
1441 | ) |
|
1442 | ) | |
1442 | @magic_arguments.argument('--no-display', action="store_true", |
|
1443 | @magic_arguments.argument('--no-display', action="store_true", | |
1443 | help="""Don't capture IPython's rich display.""" |
|
1444 | help="""Don't capture IPython's rich display.""" | |
1444 | ) |
|
1445 | ) | |
1445 | @cell_magic |
|
1446 | @cell_magic | |
1446 | def capture(self, line, cell): |
|
1447 | def capture(self, line, cell): | |
1447 | """run the cell, capturing stdout, stderr, and IPython's rich display() calls.""" |
|
1448 | """run the cell, capturing stdout, stderr, and IPython's rich display() calls.""" | |
1448 | args = magic_arguments.parse_argstring(self.capture, line) |
|
1449 | args = magic_arguments.parse_argstring(self.capture, line) | |
1449 | out = not args.no_stdout |
|
1450 | out = not args.no_stdout | |
1450 | err = not args.no_stderr |
|
1451 | err = not args.no_stderr | |
1451 | disp = not args.no_display |
|
1452 | disp = not args.no_display | |
1452 | with capture_output(out, err, disp) as io: |
|
1453 | with capture_output(out, err, disp) as io: | |
1453 | self.shell.run_cell(cell) |
|
1454 | self.shell.run_cell(cell) | |
1454 | if args.output: |
|
1455 | if args.output: | |
1455 | self.shell.user_ns[args.output] = io |
|
1456 | self.shell.user_ns[args.output] = io | |
1456 |
|
1457 | |||
1457 | def parse_breakpoint(text, current_file): |
|
1458 | def parse_breakpoint(text, current_file): | |
1458 | '''Returns (file, line) for file:line and (current_file, line) for line''' |
|
1459 | '''Returns (file, line) for file:line and (current_file, line) for line''' | |
1459 | colon = text.find(':') |
|
1460 | colon = text.find(':') | |
1460 | if colon == -1: |
|
1461 | if colon == -1: | |
1461 | return current_file, int(text) |
|
1462 | return current_file, int(text) | |
1462 | else: |
|
1463 | else: | |
1463 | return text[:colon], int(text[colon+1:]) |
|
1464 | return text[:colon], int(text[colon+1:]) | |
1464 |
|
1465 | |||
1465 | def _format_time(timespan, precision=3): |
|
1466 | def _format_time(timespan, precision=3): | |
1466 | """Formats the timespan in a human readable form""" |
|
1467 | """Formats the timespan in a human readable form""" | |
1467 |
|
1468 | |||
1468 | if timespan >= 60.0: |
|
1469 | if timespan >= 60.0: | |
1469 | # we have more than a minute, format that in a human readable form |
|
1470 | # we have more than a minute, format that in a human readable form | |
1470 | # Idea from http://snipplr.com/view/5713/ |
|
1471 | # Idea from http://snipplr.com/view/5713/ | |
1471 | parts = [("d", 60*60*24),("h", 60*60),("min", 60), ("s", 1)] |
|
1472 | parts = [("d", 60*60*24),("h", 60*60),("min", 60), ("s", 1)] | |
1472 | time = [] |
|
1473 | time = [] | |
1473 | leftover = timespan |
|
1474 | leftover = timespan | |
1474 | for suffix, length in parts: |
|
1475 | for suffix, length in parts: | |
1475 | value = int(leftover / length) |
|
1476 | value = int(leftover / length) | |
1476 | if value > 0: |
|
1477 | if value > 0: | |
1477 | leftover = leftover % length |
|
1478 | leftover = leftover % length | |
1478 | time.append(u'%s%s' % (str(value), suffix)) |
|
1479 | time.append(u'%s%s' % (str(value), suffix)) | |
1479 | if leftover < 1: |
|
1480 | if leftover < 1: | |
1480 | break |
|
1481 | break | |
1481 | return " ".join(time) |
|
1482 | return " ".join(time) | |
1482 |
|
1483 | |||
1483 |
|
1484 | |||
1484 | # Unfortunately the unicode 'micro' symbol can cause problems in |
|
1485 | # Unfortunately the unicode 'micro' symbol can cause problems in | |
1485 | # certain terminals. |
|
1486 | # certain terminals. | |
1486 | # See bug: https://bugs.launchpad.net/ipython/+bug/348466 |
|
1487 | # See bug: https://bugs.launchpad.net/ipython/+bug/348466 | |
1487 | # Try to prevent crashes by being more secure than it needs to |
|
1488 | # Try to prevent crashes by being more secure than it needs to | |
1488 | # E.g. eclipse is able to print a Β΅, but has no sys.stdout.encoding set. |
|
1489 | # E.g. eclipse is able to print a Β΅, but has no sys.stdout.encoding set. | |
1489 | units = [u"s", u"ms",u'us',"ns"] # the save value |
|
1490 | units = [u"s", u"ms",u'us',"ns"] # the save value | |
1490 | if hasattr(sys.stdout, 'encoding') and sys.stdout.encoding: |
|
1491 | if hasattr(sys.stdout, 'encoding') and sys.stdout.encoding: | |
1491 | try: |
|
1492 | try: | |
1492 | u'\xb5'.encode(sys.stdout.encoding) |
|
1493 | u'\xb5'.encode(sys.stdout.encoding) | |
1493 | units = [u"s", u"ms",u'\xb5s',"ns"] |
|
1494 | units = [u"s", u"ms",u'\xb5s',"ns"] | |
1494 | except: |
|
1495 | except: | |
1495 | pass |
|
1496 | pass | |
1496 | scaling = [1, 1e3, 1e6, 1e9] |
|
1497 | scaling = [1, 1e3, 1e6, 1e9] | |
1497 |
|
1498 | |||
1498 | if timespan > 0.0: |
|
1499 | if timespan > 0.0: | |
1499 | order = min(-int(math.floor(math.log10(timespan)) // 3), 3) |
|
1500 | order = min(-int(math.floor(math.log10(timespan)) // 3), 3) | |
1500 | else: |
|
1501 | else: | |
1501 | order = 3 |
|
1502 | order = 3 | |
1502 | return u"%.*g %s" % (precision, timespan * scaling[order], units[order]) |
|
1503 | return u"%.*g %s" % (precision, timespan * scaling[order], units[order]) |
@@ -1,1262 +1,1279 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """Tests for various magic functions. |
|
2 | """Tests for various magic functions. | |
3 |
|
3 | |||
4 | Needs to be run by nose (to make ipython session available). |
|
4 | Needs to be run by nose (to make ipython session available). | |
5 | """ |
|
5 | """ | |
6 |
|
6 | |||
7 | import io |
|
7 | import io | |
8 | import os |
|
8 | import os | |
9 | import re |
|
9 | import re | |
10 | import sys |
|
10 | import sys | |
11 | import warnings |
|
11 | import warnings | |
12 | from textwrap import dedent |
|
12 | from textwrap import dedent | |
13 | from unittest import TestCase |
|
13 | from unittest import TestCase | |
14 | from unittest import mock |
|
14 | from unittest import mock | |
15 | from importlib import invalidate_caches |
|
15 | from importlib import invalidate_caches | |
16 | from io import StringIO |
|
16 | from io import StringIO | |
17 | from pathlib import Path |
|
17 | from pathlib import Path | |
18 |
|
18 | |||
19 | import nose.tools as nt |
|
19 | import nose.tools as nt | |
20 |
|
20 | |||
21 | import shlex |
|
21 | import shlex | |
22 |
|
22 | |||
23 | from IPython import get_ipython |
|
23 | from IPython import get_ipython | |
24 | from IPython.core import magic |
|
24 | from IPython.core import magic | |
25 | from IPython.core.error import UsageError |
|
25 | from IPython.core.error import UsageError | |
26 | from IPython.core.magic import (Magics, magics_class, line_magic, |
|
26 | from IPython.core.magic import (Magics, magics_class, line_magic, | |
27 | cell_magic, |
|
27 | cell_magic, | |
28 | register_line_magic, register_cell_magic) |
|
28 | register_line_magic, register_cell_magic) | |
29 | from IPython.core.magics import execution, script, code, logging, osm |
|
29 | from IPython.core.magics import execution, script, code, logging, osm | |
30 | from IPython.testing import decorators as dec |
|
30 | from IPython.testing import decorators as dec | |
31 | from IPython.testing import tools as tt |
|
31 | from IPython.testing import tools as tt | |
32 | from IPython.utils.io import capture_output |
|
32 | from IPython.utils.io import capture_output | |
33 | from IPython.utils.tempdir import (TemporaryDirectory, |
|
33 | from IPython.utils.tempdir import (TemporaryDirectory, | |
34 | TemporaryWorkingDirectory) |
|
34 | TemporaryWorkingDirectory) | |
35 | from IPython.utils.process import find_cmd |
|
35 | from IPython.utils.process import find_cmd | |
36 | from .test_debugger import PdbTestInput |
|
36 | from .test_debugger import PdbTestInput | |
37 |
|
37 | |||
38 | import pytest |
|
38 | import pytest | |
39 |
|
39 | |||
40 |
|
40 | |||
41 | @magic.magics_class |
|
41 | @magic.magics_class | |
42 | class DummyMagics(magic.Magics): pass |
|
42 | class DummyMagics(magic.Magics): pass | |
43 |
|
43 | |||
44 | def test_extract_code_ranges(): |
|
44 | def test_extract_code_ranges(): | |
45 | instr = "1 3 5-6 7-9 10:15 17: :10 10- -13 :" |
|
45 | instr = "1 3 5-6 7-9 10:15 17: :10 10- -13 :" | |
46 | expected = [(0, 1), |
|
46 | expected = [(0, 1), | |
47 | (2, 3), |
|
47 | (2, 3), | |
48 | (4, 6), |
|
48 | (4, 6), | |
49 | (6, 9), |
|
49 | (6, 9), | |
50 | (9, 14), |
|
50 | (9, 14), | |
51 | (16, None), |
|
51 | (16, None), | |
52 | (None, 9), |
|
52 | (None, 9), | |
53 | (9, None), |
|
53 | (9, None), | |
54 | (None, 13), |
|
54 | (None, 13), | |
55 | (None, None)] |
|
55 | (None, None)] | |
56 | actual = list(code.extract_code_ranges(instr)) |
|
56 | actual = list(code.extract_code_ranges(instr)) | |
57 | nt.assert_equal(actual, expected) |
|
57 | nt.assert_equal(actual, expected) | |
58 |
|
58 | |||
59 | def test_extract_symbols(): |
|
59 | def test_extract_symbols(): | |
60 | source = """import foo\na = 10\ndef b():\n return 42\n\n\nclass A: pass\n\n\n""" |
|
60 | source = """import foo\na = 10\ndef b():\n return 42\n\n\nclass A: pass\n\n\n""" | |
61 | symbols_args = ["a", "b", "A", "A,b", "A,a", "z"] |
|
61 | symbols_args = ["a", "b", "A", "A,b", "A,a", "z"] | |
62 | expected = [([], ['a']), |
|
62 | expected = [([], ['a']), | |
63 | (["def b():\n return 42\n"], []), |
|
63 | (["def b():\n return 42\n"], []), | |
64 | (["class A: pass\n"], []), |
|
64 | (["class A: pass\n"], []), | |
65 | (["class A: pass\n", "def b():\n return 42\n"], []), |
|
65 | (["class A: pass\n", "def b():\n return 42\n"], []), | |
66 | (["class A: pass\n"], ['a']), |
|
66 | (["class A: pass\n"], ['a']), | |
67 | ([], ['z'])] |
|
67 | ([], ['z'])] | |
68 | for symbols, exp in zip(symbols_args, expected): |
|
68 | for symbols, exp in zip(symbols_args, expected): | |
69 | nt.assert_equal(code.extract_symbols(source, symbols), exp) |
|
69 | nt.assert_equal(code.extract_symbols(source, symbols), exp) | |
70 |
|
70 | |||
71 |
|
71 | |||
72 | def test_extract_symbols_raises_exception_with_non_python_code(): |
|
72 | def test_extract_symbols_raises_exception_with_non_python_code(): | |
73 | source = ("=begin A Ruby program :)=end\n" |
|
73 | source = ("=begin A Ruby program :)=end\n" | |
74 | "def hello\n" |
|
74 | "def hello\n" | |
75 | "puts 'Hello world'\n" |
|
75 | "puts 'Hello world'\n" | |
76 | "end") |
|
76 | "end") | |
77 | with nt.assert_raises(SyntaxError): |
|
77 | with nt.assert_raises(SyntaxError): | |
78 | code.extract_symbols(source, "hello") |
|
78 | code.extract_symbols(source, "hello") | |
79 |
|
79 | |||
80 |
|
80 | |||
81 | def test_magic_not_found(): |
|
81 | def test_magic_not_found(): | |
82 | # magic not found raises UsageError |
|
82 | # magic not found raises UsageError | |
83 | with nt.assert_raises(UsageError): |
|
83 | with nt.assert_raises(UsageError): | |
84 | _ip.magic('doesntexist') |
|
84 | _ip.magic('doesntexist') | |
85 |
|
85 | |||
86 | # ensure result isn't success when a magic isn't found |
|
86 | # ensure result isn't success when a magic isn't found | |
87 | result = _ip.run_cell('%doesntexist') |
|
87 | result = _ip.run_cell('%doesntexist') | |
88 | assert isinstance(result.error_in_exec, UsageError) |
|
88 | assert isinstance(result.error_in_exec, UsageError) | |
89 |
|
89 | |||
90 |
|
90 | |||
91 | def test_cell_magic_not_found(): |
|
91 | def test_cell_magic_not_found(): | |
92 | # magic not found raises UsageError |
|
92 | # magic not found raises UsageError | |
93 | with nt.assert_raises(UsageError): |
|
93 | with nt.assert_raises(UsageError): | |
94 | _ip.run_cell_magic('doesntexist', 'line', 'cell') |
|
94 | _ip.run_cell_magic('doesntexist', 'line', 'cell') | |
95 |
|
95 | |||
96 | # ensure result isn't success when a magic isn't found |
|
96 | # ensure result isn't success when a magic isn't found | |
97 | result = _ip.run_cell('%%doesntexist') |
|
97 | result = _ip.run_cell('%%doesntexist') | |
98 | assert isinstance(result.error_in_exec, UsageError) |
|
98 | assert isinstance(result.error_in_exec, UsageError) | |
99 |
|
99 | |||
100 |
|
100 | |||
101 | def test_magic_error_status(): |
|
101 | def test_magic_error_status(): | |
102 | def fail(shell): |
|
102 | def fail(shell): | |
103 | 1/0 |
|
103 | 1/0 | |
104 | _ip.register_magic_function(fail) |
|
104 | _ip.register_magic_function(fail) | |
105 | result = _ip.run_cell('%fail') |
|
105 | result = _ip.run_cell('%fail') | |
106 | assert isinstance(result.error_in_exec, ZeroDivisionError) |
|
106 | assert isinstance(result.error_in_exec, ZeroDivisionError) | |
107 |
|
107 | |||
108 |
|
108 | |||
109 | def test_config(): |
|
109 | def test_config(): | |
110 | """ test that config magic does not raise |
|
110 | """ test that config magic does not raise | |
111 | can happen if Configurable init is moved too early into |
|
111 | can happen if Configurable init is moved too early into | |
112 | Magics.__init__ as then a Config object will be registered as a |
|
112 | Magics.__init__ as then a Config object will be registered as a | |
113 | magic. |
|
113 | magic. | |
114 | """ |
|
114 | """ | |
115 | ## should not raise. |
|
115 | ## should not raise. | |
116 | _ip.magic('config') |
|
116 | _ip.magic('config') | |
117 |
|
117 | |||
118 | def test_config_available_configs(): |
|
118 | def test_config_available_configs(): | |
119 | """ test that config magic prints available configs in unique and |
|
119 | """ test that config magic prints available configs in unique and | |
120 | sorted order. """ |
|
120 | sorted order. """ | |
121 | with capture_output() as captured: |
|
121 | with capture_output() as captured: | |
122 | _ip.magic('config') |
|
122 | _ip.magic('config') | |
123 |
|
123 | |||
124 | stdout = captured.stdout |
|
124 | stdout = captured.stdout | |
125 | config_classes = stdout.strip().split('\n')[1:] |
|
125 | config_classes = stdout.strip().split('\n')[1:] | |
126 | nt.assert_list_equal(config_classes, sorted(set(config_classes))) |
|
126 | nt.assert_list_equal(config_classes, sorted(set(config_classes))) | |
127 |
|
127 | |||
128 | def test_config_print_class(): |
|
128 | def test_config_print_class(): | |
129 | """ test that config with a classname prints the class's options. """ |
|
129 | """ test that config with a classname prints the class's options. """ | |
130 | with capture_output() as captured: |
|
130 | with capture_output() as captured: | |
131 | _ip.magic('config TerminalInteractiveShell') |
|
131 | _ip.magic('config TerminalInteractiveShell') | |
132 |
|
132 | |||
133 | stdout = captured.stdout |
|
133 | stdout = captured.stdout | |
134 | if not re.match("TerminalInteractiveShell.* options", stdout.splitlines()[0]): |
|
134 | if not re.match("TerminalInteractiveShell.* options", stdout.splitlines()[0]): | |
135 | print(stdout) |
|
135 | print(stdout) | |
136 | raise AssertionError("1st line of stdout not like " |
|
136 | raise AssertionError("1st line of stdout not like " | |
137 | "'TerminalInteractiveShell.* options'") |
|
137 | "'TerminalInteractiveShell.* options'") | |
138 |
|
138 | |||
139 | def test_rehashx(): |
|
139 | def test_rehashx(): | |
140 | # clear up everything |
|
140 | # clear up everything | |
141 | _ip.alias_manager.clear_aliases() |
|
141 | _ip.alias_manager.clear_aliases() | |
142 | del _ip.db['syscmdlist'] |
|
142 | del _ip.db['syscmdlist'] | |
143 |
|
143 | |||
144 | _ip.magic('rehashx') |
|
144 | _ip.magic('rehashx') | |
145 | # Practically ALL ipython development systems will have more than 10 aliases |
|
145 | # Practically ALL ipython development systems will have more than 10 aliases | |
146 |
|
146 | |||
147 | nt.assert_true(len(_ip.alias_manager.aliases) > 10) |
|
147 | nt.assert_true(len(_ip.alias_manager.aliases) > 10) | |
148 | for name, cmd in _ip.alias_manager.aliases: |
|
148 | for name, cmd in _ip.alias_manager.aliases: | |
149 | # we must strip dots from alias names |
|
149 | # we must strip dots from alias names | |
150 | nt.assert_not_in('.', name) |
|
150 | nt.assert_not_in('.', name) | |
151 |
|
151 | |||
152 | # rehashx must fill up syscmdlist |
|
152 | # rehashx must fill up syscmdlist | |
153 | scoms = _ip.db['syscmdlist'] |
|
153 | scoms = _ip.db['syscmdlist'] | |
154 | nt.assert_true(len(scoms) > 10) |
|
154 | nt.assert_true(len(scoms) > 10) | |
155 |
|
155 | |||
156 |
|
156 | |||
157 |
|
157 | |||
158 | def test_magic_parse_options(): |
|
158 | def test_magic_parse_options(): | |
159 | """Test that we don't mangle paths when parsing magic options.""" |
|
159 | """Test that we don't mangle paths when parsing magic options.""" | |
160 | ip = get_ipython() |
|
160 | ip = get_ipython() | |
161 | path = 'c:\\x' |
|
161 | path = 'c:\\x' | |
162 | m = DummyMagics(ip) |
|
162 | m = DummyMagics(ip) | |
163 | opts = m.parse_options('-f %s' % path,'f:')[0] |
|
163 | opts = m.parse_options('-f %s' % path,'f:')[0] | |
164 | # argv splitting is os-dependent |
|
164 | # argv splitting is os-dependent | |
165 | if os.name == 'posix': |
|
165 | if os.name == 'posix': | |
166 | expected = 'c:x' |
|
166 | expected = 'c:x' | |
167 | else: |
|
167 | else: | |
168 | expected = path |
|
168 | expected = path | |
169 | nt.assert_equal(opts['f'], expected) |
|
169 | nt.assert_equal(opts['f'], expected) | |
170 |
|
170 | |||
171 | def test_magic_parse_long_options(): |
|
171 | def test_magic_parse_long_options(): | |
172 | """Magic.parse_options can handle --foo=bar long options""" |
|
172 | """Magic.parse_options can handle --foo=bar long options""" | |
173 | ip = get_ipython() |
|
173 | ip = get_ipython() | |
174 | m = DummyMagics(ip) |
|
174 | m = DummyMagics(ip) | |
175 | opts, _ = m.parse_options('--foo --bar=bubble', 'a', 'foo', 'bar=') |
|
175 | opts, _ = m.parse_options('--foo --bar=bubble', 'a', 'foo', 'bar=') | |
176 | nt.assert_in('foo', opts) |
|
176 | nt.assert_in('foo', opts) | |
177 | nt.assert_in('bar', opts) |
|
177 | nt.assert_in('bar', opts) | |
178 | nt.assert_equal(opts['bar'], "bubble") |
|
178 | nt.assert_equal(opts['bar'], "bubble") | |
179 |
|
179 | |||
180 |
|
180 | |||
181 | def doctest_hist_f(): |
|
181 | def doctest_hist_f(): | |
182 | """Test %hist -f with temporary filename. |
|
182 | """Test %hist -f with temporary filename. | |
183 |
|
183 | |||
184 | In [9]: import tempfile |
|
184 | In [9]: import tempfile | |
185 |
|
185 | |||
186 | In [10]: tfile = tempfile.mktemp('.py','tmp-ipython-') |
|
186 | In [10]: tfile = tempfile.mktemp('.py','tmp-ipython-') | |
187 |
|
187 | |||
188 | In [11]: %hist -nl -f $tfile 3 |
|
188 | In [11]: %hist -nl -f $tfile 3 | |
189 |
|
189 | |||
190 | In [13]: import os; os.unlink(tfile) |
|
190 | In [13]: import os; os.unlink(tfile) | |
191 | """ |
|
191 | """ | |
192 |
|
192 | |||
193 |
|
193 | |||
194 | def doctest_hist_op(): |
|
194 | def doctest_hist_op(): | |
195 | """Test %hist -op |
|
195 | """Test %hist -op | |
196 |
|
196 | |||
197 | In [1]: class b(float): |
|
197 | In [1]: class b(float): | |
198 | ...: pass |
|
198 | ...: pass | |
199 | ...: |
|
199 | ...: | |
200 |
|
200 | |||
201 | In [2]: class s(object): |
|
201 | In [2]: class s(object): | |
202 | ...: def __str__(self): |
|
202 | ...: def __str__(self): | |
203 | ...: return 's' |
|
203 | ...: return 's' | |
204 | ...: |
|
204 | ...: | |
205 |
|
205 | |||
206 | In [3]: |
|
206 | In [3]: | |
207 |
|
207 | |||
208 | In [4]: class r(b): |
|
208 | In [4]: class r(b): | |
209 | ...: def __repr__(self): |
|
209 | ...: def __repr__(self): | |
210 | ...: return 'r' |
|
210 | ...: return 'r' | |
211 | ...: |
|
211 | ...: | |
212 |
|
212 | |||
213 | In [5]: class sr(s,r): pass |
|
213 | In [5]: class sr(s,r): pass | |
214 | ...: |
|
214 | ...: | |
215 |
|
215 | |||
216 | In [6]: |
|
216 | In [6]: | |
217 |
|
217 | |||
218 | In [7]: bb=b() |
|
218 | In [7]: bb=b() | |
219 |
|
219 | |||
220 | In [8]: ss=s() |
|
220 | In [8]: ss=s() | |
221 |
|
221 | |||
222 | In [9]: rr=r() |
|
222 | In [9]: rr=r() | |
223 |
|
223 | |||
224 | In [10]: ssrr=sr() |
|
224 | In [10]: ssrr=sr() | |
225 |
|
225 | |||
226 | In [11]: 4.5 |
|
226 | In [11]: 4.5 | |
227 | Out[11]: 4.5 |
|
227 | Out[11]: 4.5 | |
228 |
|
228 | |||
229 | In [12]: str(ss) |
|
229 | In [12]: str(ss) | |
230 | Out[12]: 's' |
|
230 | Out[12]: 's' | |
231 |
|
231 | |||
232 | In [13]: |
|
232 | In [13]: | |
233 |
|
233 | |||
234 | In [14]: %hist -op |
|
234 | In [14]: %hist -op | |
235 | >>> class b: |
|
235 | >>> class b: | |
236 | ... pass |
|
236 | ... pass | |
237 | ... |
|
237 | ... | |
238 | >>> class s(b): |
|
238 | >>> class s(b): | |
239 | ... def __str__(self): |
|
239 | ... def __str__(self): | |
240 | ... return 's' |
|
240 | ... return 's' | |
241 | ... |
|
241 | ... | |
242 | >>> |
|
242 | >>> | |
243 | >>> class r(b): |
|
243 | >>> class r(b): | |
244 | ... def __repr__(self): |
|
244 | ... def __repr__(self): | |
245 | ... return 'r' |
|
245 | ... return 'r' | |
246 | ... |
|
246 | ... | |
247 | >>> class sr(s,r): pass |
|
247 | >>> class sr(s,r): pass | |
248 | >>> |
|
248 | >>> | |
249 | >>> bb=b() |
|
249 | >>> bb=b() | |
250 | >>> ss=s() |
|
250 | >>> ss=s() | |
251 | >>> rr=r() |
|
251 | >>> rr=r() | |
252 | >>> ssrr=sr() |
|
252 | >>> ssrr=sr() | |
253 | >>> 4.5 |
|
253 | >>> 4.5 | |
254 | 4.5 |
|
254 | 4.5 | |
255 | >>> str(ss) |
|
255 | >>> str(ss) | |
256 | 's' |
|
256 | 's' | |
257 | >>> |
|
257 | >>> | |
258 | """ |
|
258 | """ | |
259 |
|
259 | |||
260 | def test_hist_pof(): |
|
260 | def test_hist_pof(): | |
261 | ip = get_ipython() |
|
261 | ip = get_ipython() | |
262 | ip.run_cell(u"1+2", store_history=True) |
|
262 | ip.run_cell(u"1+2", store_history=True) | |
263 | #raise Exception(ip.history_manager.session_number) |
|
263 | #raise Exception(ip.history_manager.session_number) | |
264 | #raise Exception(list(ip.history_manager._get_range_session())) |
|
264 | #raise Exception(list(ip.history_manager._get_range_session())) | |
265 | with TemporaryDirectory() as td: |
|
265 | with TemporaryDirectory() as td: | |
266 | tf = os.path.join(td, 'hist.py') |
|
266 | tf = os.path.join(td, 'hist.py') | |
267 | ip.run_line_magic('history', '-pof %s' % tf) |
|
267 | ip.run_line_magic('history', '-pof %s' % tf) | |
268 | assert os.path.isfile(tf) |
|
268 | assert os.path.isfile(tf) | |
269 |
|
269 | |||
270 |
|
270 | |||
271 | def test_macro(): |
|
271 | def test_macro(): | |
272 | ip = get_ipython() |
|
272 | ip = get_ipython() | |
273 | ip.history_manager.reset() # Clear any existing history. |
|
273 | ip.history_manager.reset() # Clear any existing history. | |
274 | cmds = ["a=1", "def b():\n return a**2", "print(a,b())"] |
|
274 | cmds = ["a=1", "def b():\n return a**2", "print(a,b())"] | |
275 | for i, cmd in enumerate(cmds, start=1): |
|
275 | for i, cmd in enumerate(cmds, start=1): | |
276 | ip.history_manager.store_inputs(i, cmd) |
|
276 | ip.history_manager.store_inputs(i, cmd) | |
277 | ip.magic("macro test 1-3") |
|
277 | ip.magic("macro test 1-3") | |
278 | nt.assert_equal(ip.user_ns["test"].value, "\n".join(cmds)+"\n") |
|
278 | nt.assert_equal(ip.user_ns["test"].value, "\n".join(cmds)+"\n") | |
279 |
|
279 | |||
280 | # List macros |
|
280 | # List macros | |
281 | nt.assert_in("test", ip.magic("macro")) |
|
281 | nt.assert_in("test", ip.magic("macro")) | |
282 |
|
282 | |||
283 |
|
283 | |||
284 | def test_macro_run(): |
|
284 | def test_macro_run(): | |
285 | """Test that we can run a multi-line macro successfully.""" |
|
285 | """Test that we can run a multi-line macro successfully.""" | |
286 | ip = get_ipython() |
|
286 | ip = get_ipython() | |
287 | ip.history_manager.reset() |
|
287 | ip.history_manager.reset() | |
288 | cmds = ["a=10", "a+=1", "print(a)", "%macro test 2-3"] |
|
288 | cmds = ["a=10", "a+=1", "print(a)", "%macro test 2-3"] | |
289 | for cmd in cmds: |
|
289 | for cmd in cmds: | |
290 | ip.run_cell(cmd, store_history=True) |
|
290 | ip.run_cell(cmd, store_history=True) | |
291 | nt.assert_equal(ip.user_ns["test"].value, "a+=1\nprint(a)\n") |
|
291 | nt.assert_equal(ip.user_ns["test"].value, "a+=1\nprint(a)\n") | |
292 | with tt.AssertPrints("12"): |
|
292 | with tt.AssertPrints("12"): | |
293 | ip.run_cell("test") |
|
293 | ip.run_cell("test") | |
294 | with tt.AssertPrints("13"): |
|
294 | with tt.AssertPrints("13"): | |
295 | ip.run_cell("test") |
|
295 | ip.run_cell("test") | |
296 |
|
296 | |||
297 |
|
297 | |||
298 | def test_magic_magic(): |
|
298 | def test_magic_magic(): | |
299 | """Test %magic""" |
|
299 | """Test %magic""" | |
300 | ip = get_ipython() |
|
300 | ip = get_ipython() | |
301 | with capture_output() as captured: |
|
301 | with capture_output() as captured: | |
302 | ip.magic("magic") |
|
302 | ip.magic("magic") | |
303 |
|
303 | |||
304 | stdout = captured.stdout |
|
304 | stdout = captured.stdout | |
305 | nt.assert_in('%magic', stdout) |
|
305 | nt.assert_in('%magic', stdout) | |
306 | nt.assert_in('IPython', stdout) |
|
306 | nt.assert_in('IPython', stdout) | |
307 | nt.assert_in('Available', stdout) |
|
307 | nt.assert_in('Available', stdout) | |
308 |
|
308 | |||
309 |
|
309 | |||
310 | @dec.skipif_not_numpy |
|
310 | @dec.skipif_not_numpy | |
311 | def test_numpy_reset_array_undec(): |
|
311 | def test_numpy_reset_array_undec(): | |
312 | "Test '%reset array' functionality" |
|
312 | "Test '%reset array' functionality" | |
313 | _ip.ex('import numpy as np') |
|
313 | _ip.ex('import numpy as np') | |
314 | _ip.ex('a = np.empty(2)') |
|
314 | _ip.ex('a = np.empty(2)') | |
315 | nt.assert_in('a', _ip.user_ns) |
|
315 | nt.assert_in('a', _ip.user_ns) | |
316 | _ip.magic('reset -f array') |
|
316 | _ip.magic('reset -f array') | |
317 | nt.assert_not_in('a', _ip.user_ns) |
|
317 | nt.assert_not_in('a', _ip.user_ns) | |
318 |
|
318 | |||
319 | def test_reset_out(): |
|
319 | def test_reset_out(): | |
320 | "Test '%reset out' magic" |
|
320 | "Test '%reset out' magic" | |
321 | _ip.run_cell("parrot = 'dead'", store_history=True) |
|
321 | _ip.run_cell("parrot = 'dead'", store_history=True) | |
322 | # test '%reset -f out', make an Out prompt |
|
322 | # test '%reset -f out', make an Out prompt | |
323 | _ip.run_cell("parrot", store_history=True) |
|
323 | _ip.run_cell("parrot", store_history=True) | |
324 | nt.assert_true('dead' in [_ip.user_ns[x] for x in ('_','__','___')]) |
|
324 | nt.assert_true('dead' in [_ip.user_ns[x] for x in ('_','__','___')]) | |
325 | _ip.magic('reset -f out') |
|
325 | _ip.magic('reset -f out') | |
326 | nt.assert_false('dead' in [_ip.user_ns[x] for x in ('_','__','___')]) |
|
326 | nt.assert_false('dead' in [_ip.user_ns[x] for x in ('_','__','___')]) | |
327 | nt.assert_equal(len(_ip.user_ns['Out']), 0) |
|
327 | nt.assert_equal(len(_ip.user_ns['Out']), 0) | |
328 |
|
328 | |||
329 | def test_reset_in(): |
|
329 | def test_reset_in(): | |
330 | "Test '%reset in' magic" |
|
330 | "Test '%reset in' magic" | |
331 | # test '%reset -f in' |
|
331 | # test '%reset -f in' | |
332 | _ip.run_cell("parrot", store_history=True) |
|
332 | _ip.run_cell("parrot", store_history=True) | |
333 | nt.assert_true('parrot' in [_ip.user_ns[x] for x in ('_i','_ii','_iii')]) |
|
333 | nt.assert_true('parrot' in [_ip.user_ns[x] for x in ('_i','_ii','_iii')]) | |
334 | _ip.magic('%reset -f in') |
|
334 | _ip.magic('%reset -f in') | |
335 | nt.assert_false('parrot' in [_ip.user_ns[x] for x in ('_i','_ii','_iii')]) |
|
335 | nt.assert_false('parrot' in [_ip.user_ns[x] for x in ('_i','_ii','_iii')]) | |
336 | nt.assert_equal(len(set(_ip.user_ns['In'])), 1) |
|
336 | nt.assert_equal(len(set(_ip.user_ns['In'])), 1) | |
337 |
|
337 | |||
338 | def test_reset_dhist(): |
|
338 | def test_reset_dhist(): | |
339 | "Test '%reset dhist' magic" |
|
339 | "Test '%reset dhist' magic" | |
340 | _ip.run_cell("tmp = [d for d in _dh]") # copy before clearing |
|
340 | _ip.run_cell("tmp = [d for d in _dh]") # copy before clearing | |
341 | _ip.magic('cd ' + os.path.dirname(nt.__file__)) |
|
341 | _ip.magic('cd ' + os.path.dirname(nt.__file__)) | |
342 | _ip.magic('cd -') |
|
342 | _ip.magic('cd -') | |
343 | nt.assert_true(len(_ip.user_ns['_dh']) > 0) |
|
343 | nt.assert_true(len(_ip.user_ns['_dh']) > 0) | |
344 | _ip.magic('reset -f dhist') |
|
344 | _ip.magic('reset -f dhist') | |
345 | nt.assert_equal(len(_ip.user_ns['_dh']), 0) |
|
345 | nt.assert_equal(len(_ip.user_ns['_dh']), 0) | |
346 | _ip.run_cell("_dh = [d for d in tmp]") #restore |
|
346 | _ip.run_cell("_dh = [d for d in tmp]") #restore | |
347 |
|
347 | |||
348 | def test_reset_in_length(): |
|
348 | def test_reset_in_length(): | |
349 | "Test that '%reset in' preserves In[] length" |
|
349 | "Test that '%reset in' preserves In[] length" | |
350 | _ip.run_cell("print 'foo'") |
|
350 | _ip.run_cell("print 'foo'") | |
351 | _ip.run_cell("reset -f in") |
|
351 | _ip.run_cell("reset -f in") | |
352 | nt.assert_equal(len(_ip.user_ns['In']), _ip.displayhook.prompt_count+1) |
|
352 | nt.assert_equal(len(_ip.user_ns['In']), _ip.displayhook.prompt_count+1) | |
353 |
|
353 | |||
354 | class TestResetErrors(TestCase): |
|
354 | class TestResetErrors(TestCase): | |
355 |
|
355 | |||
356 | def test_reset_redefine(self): |
|
356 | def test_reset_redefine(self): | |
357 |
|
357 | |||
358 | @magics_class |
|
358 | @magics_class | |
359 | class KernelMagics(Magics): |
|
359 | class KernelMagics(Magics): | |
360 | @line_magic |
|
360 | @line_magic | |
361 | def less(self, shell): pass |
|
361 | def less(self, shell): pass | |
362 |
|
362 | |||
363 | _ip.register_magics(KernelMagics) |
|
363 | _ip.register_magics(KernelMagics) | |
364 |
|
364 | |||
365 | with self.assertLogs() as cm: |
|
365 | with self.assertLogs() as cm: | |
366 | # hack, we want to just capture logs, but assertLogs fails if not |
|
366 | # hack, we want to just capture logs, but assertLogs fails if not | |
367 | # logs get produce. |
|
367 | # logs get produce. | |
368 | # so log one things we ignore. |
|
368 | # so log one things we ignore. | |
369 | import logging as log_mod |
|
369 | import logging as log_mod | |
370 | log = log_mod.getLogger() |
|
370 | log = log_mod.getLogger() | |
371 | log.info('Nothing') |
|
371 | log.info('Nothing') | |
372 | # end hack. |
|
372 | # end hack. | |
373 | _ip.run_cell("reset -f") |
|
373 | _ip.run_cell("reset -f") | |
374 |
|
374 | |||
375 | assert len(cm.output) == 1 |
|
375 | assert len(cm.output) == 1 | |
376 | for out in cm.output: |
|
376 | for out in cm.output: | |
377 | assert "Invalid alias" not in out |
|
377 | assert "Invalid alias" not in out | |
378 |
|
378 | |||
379 | def test_tb_syntaxerror(): |
|
379 | def test_tb_syntaxerror(): | |
380 | """test %tb after a SyntaxError""" |
|
380 | """test %tb after a SyntaxError""" | |
381 | ip = get_ipython() |
|
381 | ip = get_ipython() | |
382 | ip.run_cell("for") |
|
382 | ip.run_cell("for") | |
383 |
|
383 | |||
384 | # trap and validate stdout |
|
384 | # trap and validate stdout | |
385 | save_stdout = sys.stdout |
|
385 | save_stdout = sys.stdout | |
386 | try: |
|
386 | try: | |
387 | sys.stdout = StringIO() |
|
387 | sys.stdout = StringIO() | |
388 | ip.run_cell("%tb") |
|
388 | ip.run_cell("%tb") | |
389 | out = sys.stdout.getvalue() |
|
389 | out = sys.stdout.getvalue() | |
390 | finally: |
|
390 | finally: | |
391 | sys.stdout = save_stdout |
|
391 | sys.stdout = save_stdout | |
392 | # trim output, and only check the last line |
|
392 | # trim output, and only check the last line | |
393 | last_line = out.rstrip().splitlines()[-1].strip() |
|
393 | last_line = out.rstrip().splitlines()[-1].strip() | |
394 | nt.assert_equal(last_line, "SyntaxError: invalid syntax") |
|
394 | nt.assert_equal(last_line, "SyntaxError: invalid syntax") | |
395 |
|
395 | |||
396 |
|
396 | |||
397 | def test_time(): |
|
397 | def test_time(): | |
398 | ip = get_ipython() |
|
398 | ip = get_ipython() | |
399 |
|
399 | |||
400 | with tt.AssertPrints("Wall time: "): |
|
400 | with tt.AssertPrints("Wall time: "): | |
401 | ip.run_cell("%time None") |
|
401 | ip.run_cell("%time None") | |
402 |
|
402 | |||
403 | ip.run_cell("def f(kmjy):\n" |
|
403 | ip.run_cell("def f(kmjy):\n" | |
404 | " %time print (2*kmjy)") |
|
404 | " %time print (2*kmjy)") | |
405 |
|
405 | |||
406 | with tt.AssertPrints("Wall time: "): |
|
406 | with tt.AssertPrints("Wall time: "): | |
407 | with tt.AssertPrints("hihi", suppress=False): |
|
407 | with tt.AssertPrints("hihi", suppress=False): | |
408 | ip.run_cell("f('hi')") |
|
408 | ip.run_cell("f('hi')") | |
409 |
|
409 | |||
410 | def test_time_last_not_expression(): |
|
410 | def test_time_last_not_expression(): | |
411 | ip.run_cell("%%time\n" |
|
411 | ip.run_cell("%%time\n" | |
412 | "var_1 = 1\n" |
|
412 | "var_1 = 1\n" | |
413 | "var_2 = 2\n") |
|
413 | "var_2 = 2\n") | |
414 | assert ip.user_ns['var_1'] == 1 |
|
414 | assert ip.user_ns['var_1'] == 1 | |
415 | del ip.user_ns['var_1'] |
|
415 | del ip.user_ns['var_1'] | |
416 | assert ip.user_ns['var_2'] == 2 |
|
416 | assert ip.user_ns['var_2'] == 2 | |
417 | del ip.user_ns['var_2'] |
|
417 | del ip.user_ns['var_2'] | |
418 |
|
418 | |||
419 |
|
419 | |||
420 | @dec.skip_win32 |
|
420 | @dec.skip_win32 | |
421 | def test_time2(): |
|
421 | def test_time2(): | |
422 | ip = get_ipython() |
|
422 | ip = get_ipython() | |
423 |
|
423 | |||
424 | with tt.AssertPrints("CPU times: user "): |
|
424 | with tt.AssertPrints("CPU times: user "): | |
425 | ip.run_cell("%time None") |
|
425 | ip.run_cell("%time None") | |
426 |
|
426 | |||
427 | def test_time3(): |
|
427 | def test_time3(): | |
428 | """Erroneous magic function calls, issue gh-3334""" |
|
428 | """Erroneous magic function calls, issue gh-3334""" | |
429 | ip = get_ipython() |
|
429 | ip = get_ipython() | |
430 | ip.user_ns.pop('run', None) |
|
430 | ip.user_ns.pop('run', None) | |
431 |
|
431 | |||
432 | with tt.AssertNotPrints("not found", channel='stderr'): |
|
432 | with tt.AssertNotPrints("not found", channel='stderr'): | |
433 | ip.run_cell("%%time\n" |
|
433 | ip.run_cell("%%time\n" | |
434 | "run = 0\n" |
|
434 | "run = 0\n" | |
435 | "run += 1") |
|
435 | "run += 1") | |
436 |
|
436 | |||
437 | def test_multiline_time(): |
|
437 | def test_multiline_time(): | |
438 | """Make sure last statement from time return a value.""" |
|
438 | """Make sure last statement from time return a value.""" | |
439 | ip = get_ipython() |
|
439 | ip = get_ipython() | |
440 | ip.user_ns.pop('run', None) |
|
440 | ip.user_ns.pop('run', None) | |
441 |
|
441 | |||
442 | ip.run_cell(dedent("""\ |
|
442 | ip.run_cell(dedent("""\ | |
443 | %%time |
|
443 | %%time | |
444 | a = "ho" |
|
444 | a = "ho" | |
445 | b = "hey" |
|
445 | b = "hey" | |
446 | a+b |
|
446 | a+b | |
447 | """)) |
|
447 | """)) | |
448 | nt.assert_equal(ip.user_ns_hidden['_'], 'hohey') |
|
448 | nt.assert_equal(ip.user_ns_hidden['_'], 'hohey') | |
449 |
|
449 | |||
450 | def test_time_local_ns(): |
|
450 | def test_time_local_ns(): | |
451 | """ |
|
451 | """ | |
452 | Test that local_ns is actually global_ns when running a cell magic |
|
452 | Test that local_ns is actually global_ns when running a cell magic | |
453 | """ |
|
453 | """ | |
454 | ip = get_ipython() |
|
454 | ip = get_ipython() | |
455 | ip.run_cell("%%time\n" |
|
455 | ip.run_cell("%%time\n" | |
456 | "myvar = 1") |
|
456 | "myvar = 1") | |
457 | nt.assert_equal(ip.user_ns['myvar'], 1) |
|
457 | nt.assert_equal(ip.user_ns['myvar'], 1) | |
458 | del ip.user_ns['myvar'] |
|
458 | del ip.user_ns['myvar'] | |
459 |
|
459 | |||
460 | def test_doctest_mode(): |
|
460 | def test_doctest_mode(): | |
461 | "Toggle doctest_mode twice, it should be a no-op and run without error" |
|
461 | "Toggle doctest_mode twice, it should be a no-op and run without error" | |
462 | _ip.magic('doctest_mode') |
|
462 | _ip.magic('doctest_mode') | |
463 | _ip.magic('doctest_mode') |
|
463 | _ip.magic('doctest_mode') | |
464 |
|
464 | |||
465 |
|
465 | |||
466 | def test_parse_options(): |
|
466 | def test_parse_options(): | |
467 | """Tests for basic options parsing in magics.""" |
|
467 | """Tests for basic options parsing in magics.""" | |
468 | # These are only the most minimal of tests, more should be added later. At |
|
468 | # These are only the most minimal of tests, more should be added later. At | |
469 | # the very least we check that basic text/unicode calls work OK. |
|
469 | # the very least we check that basic text/unicode calls work OK. | |
470 | m = DummyMagics(_ip) |
|
470 | m = DummyMagics(_ip) | |
471 | nt.assert_equal(m.parse_options('foo', '')[1], 'foo') |
|
471 | nt.assert_equal(m.parse_options('foo', '')[1], 'foo') | |
472 | nt.assert_equal(m.parse_options(u'foo', '')[1], u'foo') |
|
472 | nt.assert_equal(m.parse_options(u'foo', '')[1], u'foo') | |
473 |
|
473 | |||
474 |
|
474 | |||
|
475 | def test_parse_options_preserve_non_option_string(): | |||
|
476 | """Test to assert preservation of non-option part of magic-block, while parsing magic options.""" | |||
|
477 | m = DummyMagics(_ip) | |||
|
478 | opts, stmt = m.parse_options( | |||
|
479 | " -n1 -r 13 _ = 314 + foo", "n:r:", preserve_non_opts=True | |||
|
480 | ) | |||
|
481 | nt.assert_equal(opts, {"n": "1", "r": "13"}) | |||
|
482 | nt.assert_equal(stmt, "_ = 314 + foo") | |||
|
483 | ||||
|
484 | ||||
|
485 | def test_run_magic_preserve_code_block(): | |||
|
486 | """Test to assert preservation of non-option part of magic-block, while running magic.""" | |||
|
487 | _ip.user_ns["spaces"] = [] | |||
|
488 | _ip.magic("timeit -n1 -r1 spaces.append([s.count(' ') for s in ['document']])") | |||
|
489 | assert _ip.user_ns["spaces"] == [[0]] | |||
|
490 | ||||
|
491 | ||||
475 | def test_dirops(): |
|
492 | def test_dirops(): | |
476 | """Test various directory handling operations.""" |
|
493 | """Test various directory handling operations.""" | |
477 | # curpath = lambda :os.path.splitdrive(os.getcwd())[1].replace('\\','/') |
|
494 | # curpath = lambda :os.path.splitdrive(os.getcwd())[1].replace('\\','/') | |
478 | curpath = os.getcwd |
|
495 | curpath = os.getcwd | |
479 | startdir = os.getcwd() |
|
496 | startdir = os.getcwd() | |
480 | ipdir = os.path.realpath(_ip.ipython_dir) |
|
497 | ipdir = os.path.realpath(_ip.ipython_dir) | |
481 | try: |
|
498 | try: | |
482 | _ip.magic('cd "%s"' % ipdir) |
|
499 | _ip.magic('cd "%s"' % ipdir) | |
483 | nt.assert_equal(curpath(), ipdir) |
|
500 | nt.assert_equal(curpath(), ipdir) | |
484 | _ip.magic('cd -') |
|
501 | _ip.magic('cd -') | |
485 | nt.assert_equal(curpath(), startdir) |
|
502 | nt.assert_equal(curpath(), startdir) | |
486 | _ip.magic('pushd "%s"' % ipdir) |
|
503 | _ip.magic('pushd "%s"' % ipdir) | |
487 | nt.assert_equal(curpath(), ipdir) |
|
504 | nt.assert_equal(curpath(), ipdir) | |
488 | _ip.magic('popd') |
|
505 | _ip.magic('popd') | |
489 | nt.assert_equal(curpath(), startdir) |
|
506 | nt.assert_equal(curpath(), startdir) | |
490 | finally: |
|
507 | finally: | |
491 | os.chdir(startdir) |
|
508 | os.chdir(startdir) | |
492 |
|
509 | |||
493 |
|
510 | |||
494 | def test_cd_force_quiet(): |
|
511 | def test_cd_force_quiet(): | |
495 | """Test OSMagics.cd_force_quiet option""" |
|
512 | """Test OSMagics.cd_force_quiet option""" | |
496 | _ip.config.OSMagics.cd_force_quiet = True |
|
513 | _ip.config.OSMagics.cd_force_quiet = True | |
497 | osmagics = osm.OSMagics(shell=_ip) |
|
514 | osmagics = osm.OSMagics(shell=_ip) | |
498 |
|
515 | |||
499 | startdir = os.getcwd() |
|
516 | startdir = os.getcwd() | |
500 | ipdir = os.path.realpath(_ip.ipython_dir) |
|
517 | ipdir = os.path.realpath(_ip.ipython_dir) | |
501 |
|
518 | |||
502 | try: |
|
519 | try: | |
503 | with tt.AssertNotPrints(ipdir): |
|
520 | with tt.AssertNotPrints(ipdir): | |
504 | osmagics.cd('"%s"' % ipdir) |
|
521 | osmagics.cd('"%s"' % ipdir) | |
505 | with tt.AssertNotPrints(startdir): |
|
522 | with tt.AssertNotPrints(startdir): | |
506 | osmagics.cd('-') |
|
523 | osmagics.cd('-') | |
507 | finally: |
|
524 | finally: | |
508 | os.chdir(startdir) |
|
525 | os.chdir(startdir) | |
509 |
|
526 | |||
510 |
|
527 | |||
511 | def test_xmode(): |
|
528 | def test_xmode(): | |
512 | # Calling xmode three times should be a no-op |
|
529 | # Calling xmode three times should be a no-op | |
513 | xmode = _ip.InteractiveTB.mode |
|
530 | xmode = _ip.InteractiveTB.mode | |
514 | for i in range(4): |
|
531 | for i in range(4): | |
515 | _ip.magic("xmode") |
|
532 | _ip.magic("xmode") | |
516 | nt.assert_equal(_ip.InteractiveTB.mode, xmode) |
|
533 | nt.assert_equal(_ip.InteractiveTB.mode, xmode) | |
517 |
|
534 | |||
518 | def test_reset_hard(): |
|
535 | def test_reset_hard(): | |
519 | monitor = [] |
|
536 | monitor = [] | |
520 | class A(object): |
|
537 | class A(object): | |
521 | def __del__(self): |
|
538 | def __del__(self): | |
522 | monitor.append(1) |
|
539 | monitor.append(1) | |
523 | def __repr__(self): |
|
540 | def __repr__(self): | |
524 | return "<A instance>" |
|
541 | return "<A instance>" | |
525 |
|
542 | |||
526 | _ip.user_ns["a"] = A() |
|
543 | _ip.user_ns["a"] = A() | |
527 | _ip.run_cell("a") |
|
544 | _ip.run_cell("a") | |
528 |
|
545 | |||
529 | nt.assert_equal(monitor, []) |
|
546 | nt.assert_equal(monitor, []) | |
530 | _ip.magic("reset -f") |
|
547 | _ip.magic("reset -f") | |
531 | nt.assert_equal(monitor, [1]) |
|
548 | nt.assert_equal(monitor, [1]) | |
532 |
|
549 | |||
533 | class TestXdel(tt.TempFileMixin): |
|
550 | class TestXdel(tt.TempFileMixin): | |
534 | def test_xdel(self): |
|
551 | def test_xdel(self): | |
535 | """Test that references from %run are cleared by xdel.""" |
|
552 | """Test that references from %run are cleared by xdel.""" | |
536 | src = ("class A(object):\n" |
|
553 | src = ("class A(object):\n" | |
537 | " monitor = []\n" |
|
554 | " monitor = []\n" | |
538 | " def __del__(self):\n" |
|
555 | " def __del__(self):\n" | |
539 | " self.monitor.append(1)\n" |
|
556 | " self.monitor.append(1)\n" | |
540 | "a = A()\n") |
|
557 | "a = A()\n") | |
541 | self.mktmp(src) |
|
558 | self.mktmp(src) | |
542 | # %run creates some hidden references... |
|
559 | # %run creates some hidden references... | |
543 | _ip.magic("run %s" % self.fname) |
|
560 | _ip.magic("run %s" % self.fname) | |
544 | # ... as does the displayhook. |
|
561 | # ... as does the displayhook. | |
545 | _ip.run_cell("a") |
|
562 | _ip.run_cell("a") | |
546 |
|
563 | |||
547 | monitor = _ip.user_ns["A"].monitor |
|
564 | monitor = _ip.user_ns["A"].monitor | |
548 | nt.assert_equal(monitor, []) |
|
565 | nt.assert_equal(monitor, []) | |
549 |
|
566 | |||
550 | _ip.magic("xdel a") |
|
567 | _ip.magic("xdel a") | |
551 |
|
568 | |||
552 | # Check that a's __del__ method has been called. |
|
569 | # Check that a's __del__ method has been called. | |
553 | nt.assert_equal(monitor, [1]) |
|
570 | nt.assert_equal(monitor, [1]) | |
554 |
|
571 | |||
555 | def doctest_who(): |
|
572 | def doctest_who(): | |
556 | """doctest for %who |
|
573 | """doctest for %who | |
557 |
|
574 | |||
558 | In [1]: %reset -f |
|
575 | In [1]: %reset -f | |
559 |
|
576 | |||
560 | In [2]: alpha = 123 |
|
577 | In [2]: alpha = 123 | |
561 |
|
578 | |||
562 | In [3]: beta = 'beta' |
|
579 | In [3]: beta = 'beta' | |
563 |
|
580 | |||
564 | In [4]: %who int |
|
581 | In [4]: %who int | |
565 | alpha |
|
582 | alpha | |
566 |
|
583 | |||
567 | In [5]: %who str |
|
584 | In [5]: %who str | |
568 | beta |
|
585 | beta | |
569 |
|
586 | |||
570 | In [6]: %whos |
|
587 | In [6]: %whos | |
571 | Variable Type Data/Info |
|
588 | Variable Type Data/Info | |
572 | ---------------------------- |
|
589 | ---------------------------- | |
573 | alpha int 123 |
|
590 | alpha int 123 | |
574 | beta str beta |
|
591 | beta str beta | |
575 |
|
592 | |||
576 | In [7]: %who_ls |
|
593 | In [7]: %who_ls | |
577 | Out[7]: ['alpha', 'beta'] |
|
594 | Out[7]: ['alpha', 'beta'] | |
578 | """ |
|
595 | """ | |
579 |
|
596 | |||
580 | def test_whos(): |
|
597 | def test_whos(): | |
581 | """Check that whos is protected against objects where repr() fails.""" |
|
598 | """Check that whos is protected against objects where repr() fails.""" | |
582 | class A(object): |
|
599 | class A(object): | |
583 | def __repr__(self): |
|
600 | def __repr__(self): | |
584 | raise Exception() |
|
601 | raise Exception() | |
585 | _ip.user_ns['a'] = A() |
|
602 | _ip.user_ns['a'] = A() | |
586 | _ip.magic("whos") |
|
603 | _ip.magic("whos") | |
587 |
|
604 | |||
588 | def doctest_precision(): |
|
605 | def doctest_precision(): | |
589 | """doctest for %precision |
|
606 | """doctest for %precision | |
590 |
|
607 | |||
591 | In [1]: f = get_ipython().display_formatter.formatters['text/plain'] |
|
608 | In [1]: f = get_ipython().display_formatter.formatters['text/plain'] | |
592 |
|
609 | |||
593 | In [2]: %precision 5 |
|
610 | In [2]: %precision 5 | |
594 | Out[2]: '%.5f' |
|
611 | Out[2]: '%.5f' | |
595 |
|
612 | |||
596 | In [3]: f.float_format |
|
613 | In [3]: f.float_format | |
597 | Out[3]: '%.5f' |
|
614 | Out[3]: '%.5f' | |
598 |
|
615 | |||
599 | In [4]: %precision %e |
|
616 | In [4]: %precision %e | |
600 | Out[4]: '%e' |
|
617 | Out[4]: '%e' | |
601 |
|
618 | |||
602 | In [5]: f(3.1415927) |
|
619 | In [5]: f(3.1415927) | |
603 | Out[5]: '3.141593e+00' |
|
620 | Out[5]: '3.141593e+00' | |
604 | """ |
|
621 | """ | |
605 |
|
622 | |||
606 | def test_debug_magic(): |
|
623 | def test_debug_magic(): | |
607 | """Test debugging a small code with %debug |
|
624 | """Test debugging a small code with %debug | |
608 |
|
625 | |||
609 | In [1]: with PdbTestInput(['c']): |
|
626 | In [1]: with PdbTestInput(['c']): | |
610 | ...: %debug print("a b") #doctest: +ELLIPSIS |
|
627 | ...: %debug print("a b") #doctest: +ELLIPSIS | |
611 | ...: |
|
628 | ...: | |
612 | ... |
|
629 | ... | |
613 | ipdb> c |
|
630 | ipdb> c | |
614 | a b |
|
631 | a b | |
615 | In [2]: |
|
632 | In [2]: | |
616 | """ |
|
633 | """ | |
617 |
|
634 | |||
618 | def test_psearch(): |
|
635 | def test_psearch(): | |
619 | with tt.AssertPrints("dict.fromkeys"): |
|
636 | with tt.AssertPrints("dict.fromkeys"): | |
620 | _ip.run_cell("dict.fr*?") |
|
637 | _ip.run_cell("dict.fr*?") | |
621 | with tt.AssertPrints("Ο.is_integer"): |
|
638 | with tt.AssertPrints("Ο.is_integer"): | |
622 | _ip.run_cell("Ο = 3.14;\nΟ.is_integ*?") |
|
639 | _ip.run_cell("Ο = 3.14;\nΟ.is_integ*?") | |
623 |
|
640 | |||
624 | def test_timeit_shlex(): |
|
641 | def test_timeit_shlex(): | |
625 | """test shlex issues with timeit (#1109)""" |
|
642 | """test shlex issues with timeit (#1109)""" | |
626 | _ip.ex("def f(*a,**kw): pass") |
|
643 | _ip.ex("def f(*a,**kw): pass") | |
627 | _ip.magic('timeit -n1 "this is a bug".count(" ")') |
|
644 | _ip.magic('timeit -n1 "this is a bug".count(" ")') | |
628 | _ip.magic('timeit -r1 -n1 f(" ", 1)') |
|
645 | _ip.magic('timeit -r1 -n1 f(" ", 1)') | |
629 | _ip.magic('timeit -r1 -n1 f(" ", 1, " ", 2, " ")') |
|
646 | _ip.magic('timeit -r1 -n1 f(" ", 1, " ", 2, " ")') | |
630 | _ip.magic('timeit -r1 -n1 ("a " + "b")') |
|
647 | _ip.magic('timeit -r1 -n1 ("a " + "b")') | |
631 | _ip.magic('timeit -r1 -n1 f("a " + "b")') |
|
648 | _ip.magic('timeit -r1 -n1 f("a " + "b")') | |
632 | _ip.magic('timeit -r1 -n1 f("a " + "b ")') |
|
649 | _ip.magic('timeit -r1 -n1 f("a " + "b ")') | |
633 |
|
650 | |||
634 |
|
651 | |||
635 | def test_timeit_special_syntax(): |
|
652 | def test_timeit_special_syntax(): | |
636 | "Test %%timeit with IPython special syntax" |
|
653 | "Test %%timeit with IPython special syntax" | |
637 | @register_line_magic |
|
654 | @register_line_magic | |
638 | def lmagic(line): |
|
655 | def lmagic(line): | |
639 | ip = get_ipython() |
|
656 | ip = get_ipython() | |
640 | ip.user_ns['lmagic_out'] = line |
|
657 | ip.user_ns['lmagic_out'] = line | |
641 |
|
658 | |||
642 | # line mode test |
|
659 | # line mode test | |
643 | _ip.run_line_magic('timeit', '-n1 -r1 %lmagic my line') |
|
660 | _ip.run_line_magic('timeit', '-n1 -r1 %lmagic my line') | |
644 | nt.assert_equal(_ip.user_ns['lmagic_out'], 'my line') |
|
661 | nt.assert_equal(_ip.user_ns['lmagic_out'], 'my line') | |
645 | # cell mode test |
|
662 | # cell mode test | |
646 | _ip.run_cell_magic('timeit', '-n1 -r1', '%lmagic my line2') |
|
663 | _ip.run_cell_magic('timeit', '-n1 -r1', '%lmagic my line2') | |
647 | nt.assert_equal(_ip.user_ns['lmagic_out'], 'my line2') |
|
664 | nt.assert_equal(_ip.user_ns['lmagic_out'], 'my line2') | |
648 |
|
665 | |||
649 | def test_timeit_return(): |
|
666 | def test_timeit_return(): | |
650 | """ |
|
667 | """ | |
651 | test whether timeit -o return object |
|
668 | test whether timeit -o return object | |
652 | """ |
|
669 | """ | |
653 |
|
670 | |||
654 | res = _ip.run_line_magic('timeit','-n10 -r10 -o 1') |
|
671 | res = _ip.run_line_magic('timeit','-n10 -r10 -o 1') | |
655 | assert(res is not None) |
|
672 | assert(res is not None) | |
656 |
|
673 | |||
657 | def test_timeit_quiet(): |
|
674 | def test_timeit_quiet(): | |
658 | """ |
|
675 | """ | |
659 | test quiet option of timeit magic |
|
676 | test quiet option of timeit magic | |
660 | """ |
|
677 | """ | |
661 | with tt.AssertNotPrints("loops"): |
|
678 | with tt.AssertNotPrints("loops"): | |
662 | _ip.run_cell("%timeit -n1 -r1 -q 1") |
|
679 | _ip.run_cell("%timeit -n1 -r1 -q 1") | |
663 |
|
680 | |||
664 | def test_timeit_return_quiet(): |
|
681 | def test_timeit_return_quiet(): | |
665 | with tt.AssertNotPrints("loops"): |
|
682 | with tt.AssertNotPrints("loops"): | |
666 | res = _ip.run_line_magic('timeit', '-n1 -r1 -q -o 1') |
|
683 | res = _ip.run_line_magic('timeit', '-n1 -r1 -q -o 1') | |
667 | assert (res is not None) |
|
684 | assert (res is not None) | |
668 |
|
685 | |||
669 | def test_timeit_invalid_return(): |
|
686 | def test_timeit_invalid_return(): | |
670 | with nt.assert_raises_regex(SyntaxError, "outside function"): |
|
687 | with nt.assert_raises_regex(SyntaxError, "outside function"): | |
671 | _ip.run_line_magic('timeit', 'return') |
|
688 | _ip.run_line_magic('timeit', 'return') | |
672 |
|
689 | |||
673 | @dec.skipif(execution.profile is None) |
|
690 | @dec.skipif(execution.profile is None) | |
674 | def test_prun_special_syntax(): |
|
691 | def test_prun_special_syntax(): | |
675 | "Test %%prun with IPython special syntax" |
|
692 | "Test %%prun with IPython special syntax" | |
676 | @register_line_magic |
|
693 | @register_line_magic | |
677 | def lmagic(line): |
|
694 | def lmagic(line): | |
678 | ip = get_ipython() |
|
695 | ip = get_ipython() | |
679 | ip.user_ns['lmagic_out'] = line |
|
696 | ip.user_ns['lmagic_out'] = line | |
680 |
|
697 | |||
681 | # line mode test |
|
698 | # line mode test | |
682 | _ip.run_line_magic('prun', '-q %lmagic my line') |
|
699 | _ip.run_line_magic('prun', '-q %lmagic my line') | |
683 | nt.assert_equal(_ip.user_ns['lmagic_out'], 'my line') |
|
700 | nt.assert_equal(_ip.user_ns['lmagic_out'], 'my line') | |
684 | # cell mode test |
|
701 | # cell mode test | |
685 | _ip.run_cell_magic('prun', '-q', '%lmagic my line2') |
|
702 | _ip.run_cell_magic('prun', '-q', '%lmagic my line2') | |
686 | nt.assert_equal(_ip.user_ns['lmagic_out'], 'my line2') |
|
703 | nt.assert_equal(_ip.user_ns['lmagic_out'], 'my line2') | |
687 |
|
704 | |||
688 | @dec.skipif(execution.profile is None) |
|
705 | @dec.skipif(execution.profile is None) | |
689 | def test_prun_quotes(): |
|
706 | def test_prun_quotes(): | |
690 | "Test that prun does not clobber string escapes (GH #1302)" |
|
707 | "Test that prun does not clobber string escapes (GH #1302)" | |
691 | _ip.magic(r"prun -q x = '\t'") |
|
708 | _ip.magic(r"prun -q x = '\t'") | |
692 | nt.assert_equal(_ip.user_ns['x'], '\t') |
|
709 | nt.assert_equal(_ip.user_ns['x'], '\t') | |
693 |
|
710 | |||
694 | def test_extension(): |
|
711 | def test_extension(): | |
695 | # Debugging information for failures of this test |
|
712 | # Debugging information for failures of this test | |
696 | print('sys.path:') |
|
713 | print('sys.path:') | |
697 | for p in sys.path: |
|
714 | for p in sys.path: | |
698 | print(' ', p) |
|
715 | print(' ', p) | |
699 | print('CWD', os.getcwd()) |
|
716 | print('CWD', os.getcwd()) | |
700 |
|
717 | |||
701 | nt.assert_raises(ImportError, _ip.magic, "load_ext daft_extension") |
|
718 | nt.assert_raises(ImportError, _ip.magic, "load_ext daft_extension") | |
702 | daft_path = os.path.join(os.path.dirname(__file__), "daft_extension") |
|
719 | daft_path = os.path.join(os.path.dirname(__file__), "daft_extension") | |
703 | sys.path.insert(0, daft_path) |
|
720 | sys.path.insert(0, daft_path) | |
704 | try: |
|
721 | try: | |
705 | _ip.user_ns.pop('arq', None) |
|
722 | _ip.user_ns.pop('arq', None) | |
706 | invalidate_caches() # Clear import caches |
|
723 | invalidate_caches() # Clear import caches | |
707 | _ip.magic("load_ext daft_extension") |
|
724 | _ip.magic("load_ext daft_extension") | |
708 | nt.assert_equal(_ip.user_ns['arq'], 185) |
|
725 | nt.assert_equal(_ip.user_ns['arq'], 185) | |
709 | _ip.magic("unload_ext daft_extension") |
|
726 | _ip.magic("unload_ext daft_extension") | |
710 | assert 'arq' not in _ip.user_ns |
|
727 | assert 'arq' not in _ip.user_ns | |
711 | finally: |
|
728 | finally: | |
712 | sys.path.remove(daft_path) |
|
729 | sys.path.remove(daft_path) | |
713 |
|
730 | |||
714 |
|
731 | |||
715 | def test_notebook_export_json(): |
|
732 | def test_notebook_export_json(): | |
716 | _ip = get_ipython() |
|
733 | _ip = get_ipython() | |
717 | _ip.history_manager.reset() # Clear any existing history. |
|
734 | _ip.history_manager.reset() # Clear any existing history. | |
718 | cmds = [u"a=1", u"def b():\n return a**2", u"print('noΓ«l, Γ©tΓ©', b())"] |
|
735 | cmds = [u"a=1", u"def b():\n return a**2", u"print('noΓ«l, Γ©tΓ©', b())"] | |
719 | for i, cmd in enumerate(cmds, start=1): |
|
736 | for i, cmd in enumerate(cmds, start=1): | |
720 | _ip.history_manager.store_inputs(i, cmd) |
|
737 | _ip.history_manager.store_inputs(i, cmd) | |
721 | with TemporaryDirectory() as td: |
|
738 | with TemporaryDirectory() as td: | |
722 | outfile = os.path.join(td, "nb.ipynb") |
|
739 | outfile = os.path.join(td, "nb.ipynb") | |
723 | _ip.magic("notebook -e %s" % outfile) |
|
740 | _ip.magic("notebook -e %s" % outfile) | |
724 |
|
741 | |||
725 |
|
742 | |||
726 | class TestEnv(TestCase): |
|
743 | class TestEnv(TestCase): | |
727 |
|
744 | |||
728 | def test_env(self): |
|
745 | def test_env(self): | |
729 | env = _ip.magic("env") |
|
746 | env = _ip.magic("env") | |
730 | self.assertTrue(isinstance(env, dict)) |
|
747 | self.assertTrue(isinstance(env, dict)) | |
731 |
|
748 | |||
732 | def test_env_secret(self): |
|
749 | def test_env_secret(self): | |
733 | env = _ip.magic("env") |
|
750 | env = _ip.magic("env") | |
734 | hidden = "<hidden>" |
|
751 | hidden = "<hidden>" | |
735 | with mock.patch.dict( |
|
752 | with mock.patch.dict( | |
736 | os.environ, |
|
753 | os.environ, | |
737 | { |
|
754 | { | |
738 | "API_KEY": "abc123", |
|
755 | "API_KEY": "abc123", | |
739 | "SECRET_THING": "ssshhh", |
|
756 | "SECRET_THING": "ssshhh", | |
740 | "JUPYTER_TOKEN": "", |
|
757 | "JUPYTER_TOKEN": "", | |
741 | "VAR": "abc" |
|
758 | "VAR": "abc" | |
742 | } |
|
759 | } | |
743 | ): |
|
760 | ): | |
744 | env = _ip.magic("env") |
|
761 | env = _ip.magic("env") | |
745 | assert env["API_KEY"] == hidden |
|
762 | assert env["API_KEY"] == hidden | |
746 | assert env["SECRET_THING"] == hidden |
|
763 | assert env["SECRET_THING"] == hidden | |
747 | assert env["JUPYTER_TOKEN"] == hidden |
|
764 | assert env["JUPYTER_TOKEN"] == hidden | |
748 | assert env["VAR"] == "abc" |
|
765 | assert env["VAR"] == "abc" | |
749 |
|
766 | |||
750 | def test_env_get_set_simple(self): |
|
767 | def test_env_get_set_simple(self): | |
751 | env = _ip.magic("env var val1") |
|
768 | env = _ip.magic("env var val1") | |
752 | self.assertEqual(env, None) |
|
769 | self.assertEqual(env, None) | |
753 | self.assertEqual(os.environ['var'], 'val1') |
|
770 | self.assertEqual(os.environ['var'], 'val1') | |
754 | self.assertEqual(_ip.magic("env var"), 'val1') |
|
771 | self.assertEqual(_ip.magic("env var"), 'val1') | |
755 | env = _ip.magic("env var=val2") |
|
772 | env = _ip.magic("env var=val2") | |
756 | self.assertEqual(env, None) |
|
773 | self.assertEqual(env, None) | |
757 | self.assertEqual(os.environ['var'], 'val2') |
|
774 | self.assertEqual(os.environ['var'], 'val2') | |
758 |
|
775 | |||
759 | def test_env_get_set_complex(self): |
|
776 | def test_env_get_set_complex(self): | |
760 | env = _ip.magic("env var 'val1 '' 'val2") |
|
777 | env = _ip.magic("env var 'val1 '' 'val2") | |
761 | self.assertEqual(env, None) |
|
778 | self.assertEqual(env, None) | |
762 | self.assertEqual(os.environ['var'], "'val1 '' 'val2") |
|
779 | self.assertEqual(os.environ['var'], "'val1 '' 'val2") | |
763 | self.assertEqual(_ip.magic("env var"), "'val1 '' 'val2") |
|
780 | self.assertEqual(_ip.magic("env var"), "'val1 '' 'val2") | |
764 | env = _ip.magic('env var=val2 val3="val4') |
|
781 | env = _ip.magic('env var=val2 val3="val4') | |
765 | self.assertEqual(env, None) |
|
782 | self.assertEqual(env, None) | |
766 | self.assertEqual(os.environ['var'], 'val2 val3="val4') |
|
783 | self.assertEqual(os.environ['var'], 'val2 val3="val4') | |
767 |
|
784 | |||
768 | def test_env_set_bad_input(self): |
|
785 | def test_env_set_bad_input(self): | |
769 | self.assertRaises(UsageError, lambda: _ip.magic("set_env var")) |
|
786 | self.assertRaises(UsageError, lambda: _ip.magic("set_env var")) | |
770 |
|
787 | |||
771 | def test_env_set_whitespace(self): |
|
788 | def test_env_set_whitespace(self): | |
772 | self.assertRaises(UsageError, lambda: _ip.magic("env var A=B")) |
|
789 | self.assertRaises(UsageError, lambda: _ip.magic("env var A=B")) | |
773 |
|
790 | |||
774 |
|
791 | |||
775 | class CellMagicTestCase(TestCase): |
|
792 | class CellMagicTestCase(TestCase): | |
776 |
|
793 | |||
777 | def check_ident(self, magic): |
|
794 | def check_ident(self, magic): | |
778 | # Manually called, we get the result |
|
795 | # Manually called, we get the result | |
779 | out = _ip.run_cell_magic(magic, 'a', 'b') |
|
796 | out = _ip.run_cell_magic(magic, 'a', 'b') | |
780 | nt.assert_equal(out, ('a','b')) |
|
797 | nt.assert_equal(out, ('a','b')) | |
781 | # Via run_cell, it goes into the user's namespace via displayhook |
|
798 | # Via run_cell, it goes into the user's namespace via displayhook | |
782 | _ip.run_cell('%%' + magic +' c\nd\n') |
|
799 | _ip.run_cell('%%' + magic +' c\nd\n') | |
783 | nt.assert_equal(_ip.user_ns['_'], ('c','d\n')) |
|
800 | nt.assert_equal(_ip.user_ns['_'], ('c','d\n')) | |
784 |
|
801 | |||
785 | def test_cell_magic_func_deco(self): |
|
802 | def test_cell_magic_func_deco(self): | |
786 | "Cell magic using simple decorator" |
|
803 | "Cell magic using simple decorator" | |
787 | @register_cell_magic |
|
804 | @register_cell_magic | |
788 | def cellm(line, cell): |
|
805 | def cellm(line, cell): | |
789 | return line, cell |
|
806 | return line, cell | |
790 |
|
807 | |||
791 | self.check_ident('cellm') |
|
808 | self.check_ident('cellm') | |
792 |
|
809 | |||
793 | def test_cell_magic_reg(self): |
|
810 | def test_cell_magic_reg(self): | |
794 | "Cell magic manually registered" |
|
811 | "Cell magic manually registered" | |
795 | def cellm(line, cell): |
|
812 | def cellm(line, cell): | |
796 | return line, cell |
|
813 | return line, cell | |
797 |
|
814 | |||
798 | _ip.register_magic_function(cellm, 'cell', 'cellm2') |
|
815 | _ip.register_magic_function(cellm, 'cell', 'cellm2') | |
799 | self.check_ident('cellm2') |
|
816 | self.check_ident('cellm2') | |
800 |
|
817 | |||
801 | def test_cell_magic_class(self): |
|
818 | def test_cell_magic_class(self): | |
802 | "Cell magics declared via a class" |
|
819 | "Cell magics declared via a class" | |
803 | @magics_class |
|
820 | @magics_class | |
804 | class MyMagics(Magics): |
|
821 | class MyMagics(Magics): | |
805 |
|
822 | |||
806 | @cell_magic |
|
823 | @cell_magic | |
807 | def cellm3(self, line, cell): |
|
824 | def cellm3(self, line, cell): | |
808 | return line, cell |
|
825 | return line, cell | |
809 |
|
826 | |||
810 | _ip.register_magics(MyMagics) |
|
827 | _ip.register_magics(MyMagics) | |
811 | self.check_ident('cellm3') |
|
828 | self.check_ident('cellm3') | |
812 |
|
829 | |||
813 | def test_cell_magic_class2(self): |
|
830 | def test_cell_magic_class2(self): | |
814 | "Cell magics declared via a class, #2" |
|
831 | "Cell magics declared via a class, #2" | |
815 | @magics_class |
|
832 | @magics_class | |
816 | class MyMagics2(Magics): |
|
833 | class MyMagics2(Magics): | |
817 |
|
834 | |||
818 | @cell_magic('cellm4') |
|
835 | @cell_magic('cellm4') | |
819 | def cellm33(self, line, cell): |
|
836 | def cellm33(self, line, cell): | |
820 | return line, cell |
|
837 | return line, cell | |
821 |
|
838 | |||
822 | _ip.register_magics(MyMagics2) |
|
839 | _ip.register_magics(MyMagics2) | |
823 | self.check_ident('cellm4') |
|
840 | self.check_ident('cellm4') | |
824 | # Check that nothing is registered as 'cellm33' |
|
841 | # Check that nothing is registered as 'cellm33' | |
825 | c33 = _ip.find_cell_magic('cellm33') |
|
842 | c33 = _ip.find_cell_magic('cellm33') | |
826 | nt.assert_equal(c33, None) |
|
843 | nt.assert_equal(c33, None) | |
827 |
|
844 | |||
828 | def test_file(): |
|
845 | def test_file(): | |
829 | """Basic %%writefile""" |
|
846 | """Basic %%writefile""" | |
830 | ip = get_ipython() |
|
847 | ip = get_ipython() | |
831 | with TemporaryDirectory() as td: |
|
848 | with TemporaryDirectory() as td: | |
832 | fname = os.path.join(td, 'file1') |
|
849 | fname = os.path.join(td, 'file1') | |
833 | ip.run_cell_magic("writefile", fname, u'\n'.join([ |
|
850 | ip.run_cell_magic("writefile", fname, u'\n'.join([ | |
834 | 'line1', |
|
851 | 'line1', | |
835 | 'line2', |
|
852 | 'line2', | |
836 | ])) |
|
853 | ])) | |
837 | s = Path(fname).read_text() |
|
854 | s = Path(fname).read_text() | |
838 | nt.assert_in('line1\n', s) |
|
855 | nt.assert_in('line1\n', s) | |
839 | nt.assert_in('line2', s) |
|
856 | nt.assert_in('line2', s) | |
840 |
|
857 | |||
841 | @dec.skip_win32 |
|
858 | @dec.skip_win32 | |
842 | def test_file_single_quote(): |
|
859 | def test_file_single_quote(): | |
843 | """Basic %%writefile with embedded single quotes""" |
|
860 | """Basic %%writefile with embedded single quotes""" | |
844 | ip = get_ipython() |
|
861 | ip = get_ipython() | |
845 | with TemporaryDirectory() as td: |
|
862 | with TemporaryDirectory() as td: | |
846 | fname = os.path.join(td, '\'file1\'') |
|
863 | fname = os.path.join(td, '\'file1\'') | |
847 | ip.run_cell_magic("writefile", fname, u'\n'.join([ |
|
864 | ip.run_cell_magic("writefile", fname, u'\n'.join([ | |
848 | 'line1', |
|
865 | 'line1', | |
849 | 'line2', |
|
866 | 'line2', | |
850 | ])) |
|
867 | ])) | |
851 | s = Path(fname).read_text() |
|
868 | s = Path(fname).read_text() | |
852 | nt.assert_in('line1\n', s) |
|
869 | nt.assert_in('line1\n', s) | |
853 | nt.assert_in('line2', s) |
|
870 | nt.assert_in('line2', s) | |
854 |
|
871 | |||
855 | @dec.skip_win32 |
|
872 | @dec.skip_win32 | |
856 | def test_file_double_quote(): |
|
873 | def test_file_double_quote(): | |
857 | """Basic %%writefile with embedded double quotes""" |
|
874 | """Basic %%writefile with embedded double quotes""" | |
858 | ip = get_ipython() |
|
875 | ip = get_ipython() | |
859 | with TemporaryDirectory() as td: |
|
876 | with TemporaryDirectory() as td: | |
860 | fname = os.path.join(td, '"file1"') |
|
877 | fname = os.path.join(td, '"file1"') | |
861 | ip.run_cell_magic("writefile", fname, u'\n'.join([ |
|
878 | ip.run_cell_magic("writefile", fname, u'\n'.join([ | |
862 | 'line1', |
|
879 | 'line1', | |
863 | 'line2', |
|
880 | 'line2', | |
864 | ])) |
|
881 | ])) | |
865 | s = Path(fname).read_text() |
|
882 | s = Path(fname).read_text() | |
866 | nt.assert_in('line1\n', s) |
|
883 | nt.assert_in('line1\n', s) | |
867 | nt.assert_in('line2', s) |
|
884 | nt.assert_in('line2', s) | |
868 |
|
885 | |||
869 | def test_file_var_expand(): |
|
886 | def test_file_var_expand(): | |
870 | """%%writefile $filename""" |
|
887 | """%%writefile $filename""" | |
871 | ip = get_ipython() |
|
888 | ip = get_ipython() | |
872 | with TemporaryDirectory() as td: |
|
889 | with TemporaryDirectory() as td: | |
873 | fname = os.path.join(td, 'file1') |
|
890 | fname = os.path.join(td, 'file1') | |
874 | ip.user_ns['filename'] = fname |
|
891 | ip.user_ns['filename'] = fname | |
875 | ip.run_cell_magic("writefile", '$filename', u'\n'.join([ |
|
892 | ip.run_cell_magic("writefile", '$filename', u'\n'.join([ | |
876 | 'line1', |
|
893 | 'line1', | |
877 | 'line2', |
|
894 | 'line2', | |
878 | ])) |
|
895 | ])) | |
879 | s = Path(fname).read_text() |
|
896 | s = Path(fname).read_text() | |
880 | nt.assert_in('line1\n', s) |
|
897 | nt.assert_in('line1\n', s) | |
881 | nt.assert_in('line2', s) |
|
898 | nt.assert_in('line2', s) | |
882 |
|
899 | |||
883 | def test_file_unicode(): |
|
900 | def test_file_unicode(): | |
884 | """%%writefile with unicode cell""" |
|
901 | """%%writefile with unicode cell""" | |
885 | ip = get_ipython() |
|
902 | ip = get_ipython() | |
886 | with TemporaryDirectory() as td: |
|
903 | with TemporaryDirectory() as td: | |
887 | fname = os.path.join(td, 'file1') |
|
904 | fname = os.path.join(td, 'file1') | |
888 | ip.run_cell_magic("writefile", fname, u'\n'.join([ |
|
905 | ip.run_cell_magic("writefile", fname, u'\n'.join([ | |
889 | u'linΓ©1', |
|
906 | u'linΓ©1', | |
890 | u'linΓ©2', |
|
907 | u'linΓ©2', | |
891 | ])) |
|
908 | ])) | |
892 | with io.open(fname, encoding='utf-8') as f: |
|
909 | with io.open(fname, encoding='utf-8') as f: | |
893 | s = f.read() |
|
910 | s = f.read() | |
894 | nt.assert_in(u'linΓ©1\n', s) |
|
911 | nt.assert_in(u'linΓ©1\n', s) | |
895 | nt.assert_in(u'linΓ©2', s) |
|
912 | nt.assert_in(u'linΓ©2', s) | |
896 |
|
913 | |||
897 | def test_file_amend(): |
|
914 | def test_file_amend(): | |
898 | """%%writefile -a amends files""" |
|
915 | """%%writefile -a amends files""" | |
899 | ip = get_ipython() |
|
916 | ip = get_ipython() | |
900 | with TemporaryDirectory() as td: |
|
917 | with TemporaryDirectory() as td: | |
901 | fname = os.path.join(td, 'file2') |
|
918 | fname = os.path.join(td, 'file2') | |
902 | ip.run_cell_magic("writefile", fname, u'\n'.join([ |
|
919 | ip.run_cell_magic("writefile", fname, u'\n'.join([ | |
903 | 'line1', |
|
920 | 'line1', | |
904 | 'line2', |
|
921 | 'line2', | |
905 | ])) |
|
922 | ])) | |
906 | ip.run_cell_magic("writefile", "-a %s" % fname, u'\n'.join([ |
|
923 | ip.run_cell_magic("writefile", "-a %s" % fname, u'\n'.join([ | |
907 | 'line3', |
|
924 | 'line3', | |
908 | 'line4', |
|
925 | 'line4', | |
909 | ])) |
|
926 | ])) | |
910 | s = Path(fname).read_text() |
|
927 | s = Path(fname).read_text() | |
911 | nt.assert_in('line1\n', s) |
|
928 | nt.assert_in('line1\n', s) | |
912 | nt.assert_in('line3\n', s) |
|
929 | nt.assert_in('line3\n', s) | |
913 |
|
930 | |||
914 | def test_file_spaces(): |
|
931 | def test_file_spaces(): | |
915 | """%%file with spaces in filename""" |
|
932 | """%%file with spaces in filename""" | |
916 | ip = get_ipython() |
|
933 | ip = get_ipython() | |
917 | with TemporaryWorkingDirectory() as td: |
|
934 | with TemporaryWorkingDirectory() as td: | |
918 | fname = "file name" |
|
935 | fname = "file name" | |
919 | ip.run_cell_magic("file", '"%s"'%fname, u'\n'.join([ |
|
936 | ip.run_cell_magic("file", '"%s"'%fname, u'\n'.join([ | |
920 | 'line1', |
|
937 | 'line1', | |
921 | 'line2', |
|
938 | 'line2', | |
922 | ])) |
|
939 | ])) | |
923 | s = Path(fname).read_text() |
|
940 | s = Path(fname).read_text() | |
924 | nt.assert_in('line1\n', s) |
|
941 | nt.assert_in('line1\n', s) | |
925 | nt.assert_in('line2', s) |
|
942 | nt.assert_in('line2', s) | |
926 |
|
943 | |||
927 | def test_script_config(): |
|
944 | def test_script_config(): | |
928 | ip = get_ipython() |
|
945 | ip = get_ipython() | |
929 | ip.config.ScriptMagics.script_magics = ['whoda'] |
|
946 | ip.config.ScriptMagics.script_magics = ['whoda'] | |
930 | sm = script.ScriptMagics(shell=ip) |
|
947 | sm = script.ScriptMagics(shell=ip) | |
931 | nt.assert_in('whoda', sm.magics['cell']) |
|
948 | nt.assert_in('whoda', sm.magics['cell']) | |
932 |
|
949 | |||
933 | @dec.skip_win32 |
|
950 | @dec.skip_win32 | |
934 | def test_script_out(): |
|
951 | def test_script_out(): | |
935 | ip = get_ipython() |
|
952 | ip = get_ipython() | |
936 | ip.run_cell_magic("script", "--out output sh", "echo 'hi'") |
|
953 | ip.run_cell_magic("script", "--out output sh", "echo 'hi'") | |
937 | nt.assert_equal(ip.user_ns['output'], 'hi\n') |
|
954 | nt.assert_equal(ip.user_ns['output'], 'hi\n') | |
938 |
|
955 | |||
939 | @dec.skip_win32 |
|
956 | @dec.skip_win32 | |
940 | def test_script_err(): |
|
957 | def test_script_err(): | |
941 | ip = get_ipython() |
|
958 | ip = get_ipython() | |
942 | ip.run_cell_magic("script", "--err error sh", "echo 'hello' >&2") |
|
959 | ip.run_cell_magic("script", "--err error sh", "echo 'hello' >&2") | |
943 | nt.assert_equal(ip.user_ns['error'], 'hello\n') |
|
960 | nt.assert_equal(ip.user_ns['error'], 'hello\n') | |
944 |
|
961 | |||
945 | @dec.skip_win32 |
|
962 | @dec.skip_win32 | |
946 | def test_script_out_err(): |
|
963 | def test_script_out_err(): | |
947 | ip = get_ipython() |
|
964 | ip = get_ipython() | |
948 | ip.run_cell_magic("script", "--out output --err error sh", "echo 'hi'\necho 'hello' >&2") |
|
965 | ip.run_cell_magic("script", "--out output --err error sh", "echo 'hi'\necho 'hello' >&2") | |
949 | nt.assert_equal(ip.user_ns['output'], 'hi\n') |
|
966 | nt.assert_equal(ip.user_ns['output'], 'hi\n') | |
950 | nt.assert_equal(ip.user_ns['error'], 'hello\n') |
|
967 | nt.assert_equal(ip.user_ns['error'], 'hello\n') | |
951 |
|
968 | |||
952 | @dec.skip_win32 |
|
969 | @dec.skip_win32 | |
953 | async def test_script_bg_out(): |
|
970 | async def test_script_bg_out(): | |
954 | ip = get_ipython() |
|
971 | ip = get_ipython() | |
955 | ip.run_cell_magic("script", "--bg --out output sh", "echo 'hi'") |
|
972 | ip.run_cell_magic("script", "--bg --out output sh", "echo 'hi'") | |
956 | nt.assert_equal((await ip.user_ns["output"].read()), b"hi\n") |
|
973 | nt.assert_equal((await ip.user_ns["output"].read()), b"hi\n") | |
957 | ip.user_ns['output'].close() |
|
974 | ip.user_ns['output'].close() | |
958 |
|
975 | |||
959 | @dec.skip_win32 |
|
976 | @dec.skip_win32 | |
960 | async def test_script_bg_err(): |
|
977 | async def test_script_bg_err(): | |
961 | ip = get_ipython() |
|
978 | ip = get_ipython() | |
962 | ip.run_cell_magic("script", "--bg --err error sh", "echo 'hello' >&2") |
|
979 | ip.run_cell_magic("script", "--bg --err error sh", "echo 'hello' >&2") | |
963 | nt.assert_equal((await ip.user_ns["error"].read()), b"hello\n") |
|
980 | nt.assert_equal((await ip.user_ns["error"].read()), b"hello\n") | |
964 | ip.user_ns["error"].close() |
|
981 | ip.user_ns["error"].close() | |
965 |
|
982 | |||
966 |
|
983 | |||
967 | @dec.skip_win32 |
|
984 | @dec.skip_win32 | |
968 | async def test_script_bg_out_err(): |
|
985 | async def test_script_bg_out_err(): | |
969 | ip = get_ipython() |
|
986 | ip = get_ipython() | |
970 | ip.run_cell_magic( |
|
987 | ip.run_cell_magic( | |
971 | "script", "--bg --out output --err error sh", "echo 'hi'\necho 'hello' >&2" |
|
988 | "script", "--bg --out output --err error sh", "echo 'hi'\necho 'hello' >&2" | |
972 | ) |
|
989 | ) | |
973 | nt.assert_equal((await ip.user_ns["output"].read()), b"hi\n") |
|
990 | nt.assert_equal((await ip.user_ns["output"].read()), b"hi\n") | |
974 | nt.assert_equal((await ip.user_ns["error"].read()), b"hello\n") |
|
991 | nt.assert_equal((await ip.user_ns["error"].read()), b"hello\n") | |
975 | ip.user_ns["output"].close() |
|
992 | ip.user_ns["output"].close() | |
976 | ip.user_ns["error"].close() |
|
993 | ip.user_ns["error"].close() | |
977 |
|
994 | |||
978 |
|
995 | |||
979 | def test_script_defaults(): |
|
996 | def test_script_defaults(): | |
980 | ip = get_ipython() |
|
997 | ip = get_ipython() | |
981 | for cmd in ['sh', 'bash', 'perl', 'ruby']: |
|
998 | for cmd in ['sh', 'bash', 'perl', 'ruby']: | |
982 | try: |
|
999 | try: | |
983 | find_cmd(cmd) |
|
1000 | find_cmd(cmd) | |
984 | except Exception: |
|
1001 | except Exception: | |
985 | pass |
|
1002 | pass | |
986 | else: |
|
1003 | else: | |
987 | nt.assert_in(cmd, ip.magics_manager.magics['cell']) |
|
1004 | nt.assert_in(cmd, ip.magics_manager.magics['cell']) | |
988 |
|
1005 | |||
989 |
|
1006 | |||
990 | @magics_class |
|
1007 | @magics_class | |
991 | class FooFoo(Magics): |
|
1008 | class FooFoo(Magics): | |
992 | """class with both %foo and %%foo magics""" |
|
1009 | """class with both %foo and %%foo magics""" | |
993 | @line_magic('foo') |
|
1010 | @line_magic('foo') | |
994 | def line_foo(self, line): |
|
1011 | def line_foo(self, line): | |
995 | "I am line foo" |
|
1012 | "I am line foo" | |
996 | pass |
|
1013 | pass | |
997 |
|
1014 | |||
998 | @cell_magic("foo") |
|
1015 | @cell_magic("foo") | |
999 | def cell_foo(self, line, cell): |
|
1016 | def cell_foo(self, line, cell): | |
1000 | "I am cell foo, not line foo" |
|
1017 | "I am cell foo, not line foo" | |
1001 | pass |
|
1018 | pass | |
1002 |
|
1019 | |||
1003 | def test_line_cell_info(): |
|
1020 | def test_line_cell_info(): | |
1004 | """%%foo and %foo magics are distinguishable to inspect""" |
|
1021 | """%%foo and %foo magics are distinguishable to inspect""" | |
1005 | ip = get_ipython() |
|
1022 | ip = get_ipython() | |
1006 | ip.magics_manager.register(FooFoo) |
|
1023 | ip.magics_manager.register(FooFoo) | |
1007 | oinfo = ip.object_inspect('foo') |
|
1024 | oinfo = ip.object_inspect('foo') | |
1008 | nt.assert_true(oinfo['found']) |
|
1025 | nt.assert_true(oinfo['found']) | |
1009 | nt.assert_true(oinfo['ismagic']) |
|
1026 | nt.assert_true(oinfo['ismagic']) | |
1010 |
|
1027 | |||
1011 | oinfo = ip.object_inspect('%%foo') |
|
1028 | oinfo = ip.object_inspect('%%foo') | |
1012 | nt.assert_true(oinfo['found']) |
|
1029 | nt.assert_true(oinfo['found']) | |
1013 | nt.assert_true(oinfo['ismagic']) |
|
1030 | nt.assert_true(oinfo['ismagic']) | |
1014 | nt.assert_equal(oinfo['docstring'], FooFoo.cell_foo.__doc__) |
|
1031 | nt.assert_equal(oinfo['docstring'], FooFoo.cell_foo.__doc__) | |
1015 |
|
1032 | |||
1016 | oinfo = ip.object_inspect('%foo') |
|
1033 | oinfo = ip.object_inspect('%foo') | |
1017 | nt.assert_true(oinfo['found']) |
|
1034 | nt.assert_true(oinfo['found']) | |
1018 | nt.assert_true(oinfo['ismagic']) |
|
1035 | nt.assert_true(oinfo['ismagic']) | |
1019 | nt.assert_equal(oinfo['docstring'], FooFoo.line_foo.__doc__) |
|
1036 | nt.assert_equal(oinfo['docstring'], FooFoo.line_foo.__doc__) | |
1020 |
|
1037 | |||
1021 | def test_multiple_magics(): |
|
1038 | def test_multiple_magics(): | |
1022 | ip = get_ipython() |
|
1039 | ip = get_ipython() | |
1023 | foo1 = FooFoo(ip) |
|
1040 | foo1 = FooFoo(ip) | |
1024 | foo2 = FooFoo(ip) |
|
1041 | foo2 = FooFoo(ip) | |
1025 | mm = ip.magics_manager |
|
1042 | mm = ip.magics_manager | |
1026 | mm.register(foo1) |
|
1043 | mm.register(foo1) | |
1027 | nt.assert_true(mm.magics['line']['foo'].__self__ is foo1) |
|
1044 | nt.assert_true(mm.magics['line']['foo'].__self__ is foo1) | |
1028 | mm.register(foo2) |
|
1045 | mm.register(foo2) | |
1029 | nt.assert_true(mm.magics['line']['foo'].__self__ is foo2) |
|
1046 | nt.assert_true(mm.magics['line']['foo'].__self__ is foo2) | |
1030 |
|
1047 | |||
1031 | def test_alias_magic(): |
|
1048 | def test_alias_magic(): | |
1032 | """Test %alias_magic.""" |
|
1049 | """Test %alias_magic.""" | |
1033 | ip = get_ipython() |
|
1050 | ip = get_ipython() | |
1034 | mm = ip.magics_manager |
|
1051 | mm = ip.magics_manager | |
1035 |
|
1052 | |||
1036 | # Basic operation: both cell and line magics are created, if possible. |
|
1053 | # Basic operation: both cell and line magics are created, if possible. | |
1037 | ip.run_line_magic('alias_magic', 'timeit_alias timeit') |
|
1054 | ip.run_line_magic('alias_magic', 'timeit_alias timeit') | |
1038 | nt.assert_in('timeit_alias', mm.magics['line']) |
|
1055 | nt.assert_in('timeit_alias', mm.magics['line']) | |
1039 | nt.assert_in('timeit_alias', mm.magics['cell']) |
|
1056 | nt.assert_in('timeit_alias', mm.magics['cell']) | |
1040 |
|
1057 | |||
1041 | # --cell is specified, line magic not created. |
|
1058 | # --cell is specified, line magic not created. | |
1042 | ip.run_line_magic('alias_magic', '--cell timeit_cell_alias timeit') |
|
1059 | ip.run_line_magic('alias_magic', '--cell timeit_cell_alias timeit') | |
1043 | nt.assert_not_in('timeit_cell_alias', mm.magics['line']) |
|
1060 | nt.assert_not_in('timeit_cell_alias', mm.magics['line']) | |
1044 | nt.assert_in('timeit_cell_alias', mm.magics['cell']) |
|
1061 | nt.assert_in('timeit_cell_alias', mm.magics['cell']) | |
1045 |
|
1062 | |||
1046 | # Test that line alias is created successfully. |
|
1063 | # Test that line alias is created successfully. | |
1047 | ip.run_line_magic('alias_magic', '--line env_alias env') |
|
1064 | ip.run_line_magic('alias_magic', '--line env_alias env') | |
1048 | nt.assert_equal(ip.run_line_magic('env', ''), |
|
1065 | nt.assert_equal(ip.run_line_magic('env', ''), | |
1049 | ip.run_line_magic('env_alias', '')) |
|
1066 | ip.run_line_magic('env_alias', '')) | |
1050 |
|
1067 | |||
1051 | # Test that line alias with parameters passed in is created successfully. |
|
1068 | # Test that line alias with parameters passed in is created successfully. | |
1052 | ip.run_line_magic('alias_magic', '--line history_alias history --params ' + shlex.quote('3')) |
|
1069 | ip.run_line_magic('alias_magic', '--line history_alias history --params ' + shlex.quote('3')) | |
1053 | nt.assert_in('history_alias', mm.magics['line']) |
|
1070 | nt.assert_in('history_alias', mm.magics['line']) | |
1054 |
|
1071 | |||
1055 |
|
1072 | |||
1056 | def test_save(): |
|
1073 | def test_save(): | |
1057 | """Test %save.""" |
|
1074 | """Test %save.""" | |
1058 | ip = get_ipython() |
|
1075 | ip = get_ipython() | |
1059 | ip.history_manager.reset() # Clear any existing history. |
|
1076 | ip.history_manager.reset() # Clear any existing history. | |
1060 | cmds = [u"a=1", u"def b():\n return a**2", u"print(a, b())"] |
|
1077 | cmds = [u"a=1", u"def b():\n return a**2", u"print(a, b())"] | |
1061 | for i, cmd in enumerate(cmds, start=1): |
|
1078 | for i, cmd in enumerate(cmds, start=1): | |
1062 | ip.history_manager.store_inputs(i, cmd) |
|
1079 | ip.history_manager.store_inputs(i, cmd) | |
1063 | with TemporaryDirectory() as tmpdir: |
|
1080 | with TemporaryDirectory() as tmpdir: | |
1064 | file = os.path.join(tmpdir, "testsave.py") |
|
1081 | file = os.path.join(tmpdir, "testsave.py") | |
1065 | ip.run_line_magic("save", "%s 1-10" % file) |
|
1082 | ip.run_line_magic("save", "%s 1-10" % file) | |
1066 | content = Path(file).read_text() |
|
1083 | content = Path(file).read_text() | |
1067 | nt.assert_equal(content.count(cmds[0]), 1) |
|
1084 | nt.assert_equal(content.count(cmds[0]), 1) | |
1068 | nt.assert_in("coding: utf-8", content) |
|
1085 | nt.assert_in("coding: utf-8", content) | |
1069 | ip.run_line_magic("save", "-a %s 1-10" % file) |
|
1086 | ip.run_line_magic("save", "-a %s 1-10" % file) | |
1070 | content = Path(file).read_text() |
|
1087 | content = Path(file).read_text() | |
1071 | nt.assert_equal(content.count(cmds[0]), 2) |
|
1088 | nt.assert_equal(content.count(cmds[0]), 2) | |
1072 | nt.assert_in("coding: utf-8", content) |
|
1089 | nt.assert_in("coding: utf-8", content) | |
1073 |
|
1090 | |||
1074 |
|
1091 | |||
1075 | def test_store(): |
|
1092 | def test_store(): | |
1076 | """Test %store.""" |
|
1093 | """Test %store.""" | |
1077 | ip = get_ipython() |
|
1094 | ip = get_ipython() | |
1078 | ip.run_line_magic('load_ext', 'storemagic') |
|
1095 | ip.run_line_magic('load_ext', 'storemagic') | |
1079 |
|
1096 | |||
1080 | # make sure the storage is empty |
|
1097 | # make sure the storage is empty | |
1081 | ip.run_line_magic('store', '-z') |
|
1098 | ip.run_line_magic('store', '-z') | |
1082 | ip.user_ns['var'] = 42 |
|
1099 | ip.user_ns['var'] = 42 | |
1083 | ip.run_line_magic('store', 'var') |
|
1100 | ip.run_line_magic('store', 'var') | |
1084 | ip.user_ns['var'] = 39 |
|
1101 | ip.user_ns['var'] = 39 | |
1085 | ip.run_line_magic('store', '-r') |
|
1102 | ip.run_line_magic('store', '-r') | |
1086 | nt.assert_equal(ip.user_ns['var'], 42) |
|
1103 | nt.assert_equal(ip.user_ns['var'], 42) | |
1087 |
|
1104 | |||
1088 | ip.run_line_magic('store', '-d var') |
|
1105 | ip.run_line_magic('store', '-d var') | |
1089 | ip.user_ns['var'] = 39 |
|
1106 | ip.user_ns['var'] = 39 | |
1090 | ip.run_line_magic('store' , '-r') |
|
1107 | ip.run_line_magic('store' , '-r') | |
1091 | nt.assert_equal(ip.user_ns['var'], 39) |
|
1108 | nt.assert_equal(ip.user_ns['var'], 39) | |
1092 |
|
1109 | |||
1093 |
|
1110 | |||
1094 | def _run_edit_test(arg_s, exp_filename=None, |
|
1111 | def _run_edit_test(arg_s, exp_filename=None, | |
1095 | exp_lineno=-1, |
|
1112 | exp_lineno=-1, | |
1096 | exp_contents=None, |
|
1113 | exp_contents=None, | |
1097 | exp_is_temp=None): |
|
1114 | exp_is_temp=None): | |
1098 | ip = get_ipython() |
|
1115 | ip = get_ipython() | |
1099 | M = code.CodeMagics(ip) |
|
1116 | M = code.CodeMagics(ip) | |
1100 | last_call = ['',''] |
|
1117 | last_call = ['',''] | |
1101 | opts,args = M.parse_options(arg_s,'prxn:') |
|
1118 | opts,args = M.parse_options(arg_s,'prxn:') | |
1102 | filename, lineno, is_temp = M._find_edit_target(ip, args, opts, last_call) |
|
1119 | filename, lineno, is_temp = M._find_edit_target(ip, args, opts, last_call) | |
1103 |
|
1120 | |||
1104 | if exp_filename is not None: |
|
1121 | if exp_filename is not None: | |
1105 | nt.assert_equal(exp_filename, filename) |
|
1122 | nt.assert_equal(exp_filename, filename) | |
1106 | if exp_contents is not None: |
|
1123 | if exp_contents is not None: | |
1107 | with io.open(filename, 'r', encoding='utf-8') as f: |
|
1124 | with io.open(filename, 'r', encoding='utf-8') as f: | |
1108 | contents = f.read() |
|
1125 | contents = f.read() | |
1109 | nt.assert_equal(exp_contents, contents) |
|
1126 | nt.assert_equal(exp_contents, contents) | |
1110 | if exp_lineno != -1: |
|
1127 | if exp_lineno != -1: | |
1111 | nt.assert_equal(exp_lineno, lineno) |
|
1128 | nt.assert_equal(exp_lineno, lineno) | |
1112 | if exp_is_temp is not None: |
|
1129 | if exp_is_temp is not None: | |
1113 | nt.assert_equal(exp_is_temp, is_temp) |
|
1130 | nt.assert_equal(exp_is_temp, is_temp) | |
1114 |
|
1131 | |||
1115 |
|
1132 | |||
1116 | def test_edit_interactive(): |
|
1133 | def test_edit_interactive(): | |
1117 | """%edit on interactively defined objects""" |
|
1134 | """%edit on interactively defined objects""" | |
1118 | ip = get_ipython() |
|
1135 | ip = get_ipython() | |
1119 | n = ip.execution_count |
|
1136 | n = ip.execution_count | |
1120 | ip.run_cell(u"def foo(): return 1", store_history=True) |
|
1137 | ip.run_cell(u"def foo(): return 1", store_history=True) | |
1121 |
|
1138 | |||
1122 | try: |
|
1139 | try: | |
1123 | _run_edit_test("foo") |
|
1140 | _run_edit_test("foo") | |
1124 | except code.InteractivelyDefined as e: |
|
1141 | except code.InteractivelyDefined as e: | |
1125 | nt.assert_equal(e.index, n) |
|
1142 | nt.assert_equal(e.index, n) | |
1126 | else: |
|
1143 | else: | |
1127 | raise AssertionError("Should have raised InteractivelyDefined") |
|
1144 | raise AssertionError("Should have raised InteractivelyDefined") | |
1128 |
|
1145 | |||
1129 |
|
1146 | |||
1130 | def test_edit_cell(): |
|
1147 | def test_edit_cell(): | |
1131 | """%edit [cell id]""" |
|
1148 | """%edit [cell id]""" | |
1132 | ip = get_ipython() |
|
1149 | ip = get_ipython() | |
1133 |
|
1150 | |||
1134 | ip.run_cell(u"def foo(): return 1", store_history=True) |
|
1151 | ip.run_cell(u"def foo(): return 1", store_history=True) | |
1135 |
|
1152 | |||
1136 | # test |
|
1153 | # test | |
1137 | _run_edit_test("1", exp_contents=ip.user_ns['In'][1], exp_is_temp=True) |
|
1154 | _run_edit_test("1", exp_contents=ip.user_ns['In'][1], exp_is_temp=True) | |
1138 |
|
1155 | |||
1139 | def test_edit_fname(): |
|
1156 | def test_edit_fname(): | |
1140 | """%edit file""" |
|
1157 | """%edit file""" | |
1141 | # test |
|
1158 | # test | |
1142 | _run_edit_test("test file.py", exp_filename="test file.py") |
|
1159 | _run_edit_test("test file.py", exp_filename="test file.py") | |
1143 |
|
1160 | |||
1144 | def test_bookmark(): |
|
1161 | def test_bookmark(): | |
1145 | ip = get_ipython() |
|
1162 | ip = get_ipython() | |
1146 | ip.run_line_magic('bookmark', 'bmname') |
|
1163 | ip.run_line_magic('bookmark', 'bmname') | |
1147 | with tt.AssertPrints('bmname'): |
|
1164 | with tt.AssertPrints('bmname'): | |
1148 | ip.run_line_magic('bookmark', '-l') |
|
1165 | ip.run_line_magic('bookmark', '-l') | |
1149 | ip.run_line_magic('bookmark', '-d bmname') |
|
1166 | ip.run_line_magic('bookmark', '-d bmname') | |
1150 |
|
1167 | |||
1151 | def test_ls_magic(): |
|
1168 | def test_ls_magic(): | |
1152 | ip = get_ipython() |
|
1169 | ip = get_ipython() | |
1153 | json_formatter = ip.display_formatter.formatters['application/json'] |
|
1170 | json_formatter = ip.display_formatter.formatters['application/json'] | |
1154 | json_formatter.enabled = True |
|
1171 | json_formatter.enabled = True | |
1155 | lsmagic = ip.magic('lsmagic') |
|
1172 | lsmagic = ip.magic('lsmagic') | |
1156 | with warnings.catch_warnings(record=True) as w: |
|
1173 | with warnings.catch_warnings(record=True) as w: | |
1157 | j = json_formatter(lsmagic) |
|
1174 | j = json_formatter(lsmagic) | |
1158 | nt.assert_equal(sorted(j), ['cell', 'line']) |
|
1175 | nt.assert_equal(sorted(j), ['cell', 'line']) | |
1159 | nt.assert_equal(w, []) # no warnings |
|
1176 | nt.assert_equal(w, []) # no warnings | |
1160 |
|
1177 | |||
1161 | def test_strip_initial_indent(): |
|
1178 | def test_strip_initial_indent(): | |
1162 | def sii(s): |
|
1179 | def sii(s): | |
1163 | lines = s.splitlines() |
|
1180 | lines = s.splitlines() | |
1164 | return '\n'.join(code.strip_initial_indent(lines)) |
|
1181 | return '\n'.join(code.strip_initial_indent(lines)) | |
1165 |
|
1182 | |||
1166 | nt.assert_equal(sii(" a = 1\nb = 2"), "a = 1\nb = 2") |
|
1183 | nt.assert_equal(sii(" a = 1\nb = 2"), "a = 1\nb = 2") | |
1167 | nt.assert_equal(sii(" a\n b\nc"), "a\n b\nc") |
|
1184 | nt.assert_equal(sii(" a\n b\nc"), "a\n b\nc") | |
1168 | nt.assert_equal(sii("a\n b"), "a\n b") |
|
1185 | nt.assert_equal(sii("a\n b"), "a\n b") | |
1169 |
|
1186 | |||
1170 | def test_logging_magic_quiet_from_arg(): |
|
1187 | def test_logging_magic_quiet_from_arg(): | |
1171 | _ip.config.LoggingMagics.quiet = False |
|
1188 | _ip.config.LoggingMagics.quiet = False | |
1172 | lm = logging.LoggingMagics(shell=_ip) |
|
1189 | lm = logging.LoggingMagics(shell=_ip) | |
1173 | with TemporaryDirectory() as td: |
|
1190 | with TemporaryDirectory() as td: | |
1174 | try: |
|
1191 | try: | |
1175 | with tt.AssertNotPrints(re.compile("Activating.*")): |
|
1192 | with tt.AssertNotPrints(re.compile("Activating.*")): | |
1176 | lm.logstart('-q {}'.format( |
|
1193 | lm.logstart('-q {}'.format( | |
1177 | os.path.join(td, "quiet_from_arg.log"))) |
|
1194 | os.path.join(td, "quiet_from_arg.log"))) | |
1178 | finally: |
|
1195 | finally: | |
1179 | _ip.logger.logstop() |
|
1196 | _ip.logger.logstop() | |
1180 |
|
1197 | |||
1181 | def test_logging_magic_quiet_from_config(): |
|
1198 | def test_logging_magic_quiet_from_config(): | |
1182 | _ip.config.LoggingMagics.quiet = True |
|
1199 | _ip.config.LoggingMagics.quiet = True | |
1183 | lm = logging.LoggingMagics(shell=_ip) |
|
1200 | lm = logging.LoggingMagics(shell=_ip) | |
1184 | with TemporaryDirectory() as td: |
|
1201 | with TemporaryDirectory() as td: | |
1185 | try: |
|
1202 | try: | |
1186 | with tt.AssertNotPrints(re.compile("Activating.*")): |
|
1203 | with tt.AssertNotPrints(re.compile("Activating.*")): | |
1187 | lm.logstart(os.path.join(td, "quiet_from_config.log")) |
|
1204 | lm.logstart(os.path.join(td, "quiet_from_config.log")) | |
1188 | finally: |
|
1205 | finally: | |
1189 | _ip.logger.logstop() |
|
1206 | _ip.logger.logstop() | |
1190 |
|
1207 | |||
1191 |
|
1208 | |||
1192 | def test_logging_magic_not_quiet(): |
|
1209 | def test_logging_magic_not_quiet(): | |
1193 | _ip.config.LoggingMagics.quiet = False |
|
1210 | _ip.config.LoggingMagics.quiet = False | |
1194 | lm = logging.LoggingMagics(shell=_ip) |
|
1211 | lm = logging.LoggingMagics(shell=_ip) | |
1195 | with TemporaryDirectory() as td: |
|
1212 | with TemporaryDirectory() as td: | |
1196 | try: |
|
1213 | try: | |
1197 | with tt.AssertPrints(re.compile("Activating.*")): |
|
1214 | with tt.AssertPrints(re.compile("Activating.*")): | |
1198 | lm.logstart(os.path.join(td, "not_quiet.log")) |
|
1215 | lm.logstart(os.path.join(td, "not_quiet.log")) | |
1199 | finally: |
|
1216 | finally: | |
1200 | _ip.logger.logstop() |
|
1217 | _ip.logger.logstop() | |
1201 |
|
1218 | |||
1202 |
|
1219 | |||
1203 | def test_time_no_var_expand(): |
|
1220 | def test_time_no_var_expand(): | |
1204 | _ip.user_ns['a'] = 5 |
|
1221 | _ip.user_ns['a'] = 5 | |
1205 | _ip.user_ns['b'] = [] |
|
1222 | _ip.user_ns['b'] = [] | |
1206 | _ip.magic('time b.append("{a}")') |
|
1223 | _ip.magic('time b.append("{a}")') | |
1207 | assert _ip.user_ns['b'] == ['{a}'] |
|
1224 | assert _ip.user_ns['b'] == ['{a}'] | |
1208 |
|
1225 | |||
1209 |
|
1226 | |||
1210 | # this is slow, put at the end for local testing. |
|
1227 | # this is slow, put at the end for local testing. | |
1211 | def test_timeit_arguments(): |
|
1228 | def test_timeit_arguments(): | |
1212 | "Test valid timeit arguments, should not cause SyntaxError (GH #1269)" |
|
1229 | "Test valid timeit arguments, should not cause SyntaxError (GH #1269)" | |
1213 | if sys.version_info < (3,7): |
|
1230 | if sys.version_info < (3,7): | |
1214 | _ip.magic("timeit -n1 -r1 ('#')") |
|
1231 | _ip.magic("timeit -n1 -r1 ('#')") | |
1215 | else: |
|
1232 | else: | |
1216 | # 3.7 optimize no-op statement like above out, and complain there is |
|
1233 | # 3.7 optimize no-op statement like above out, and complain there is | |
1217 | # nothing in the for loop. |
|
1234 | # nothing in the for loop. | |
1218 | _ip.magic("timeit -n1 -r1 a=('#')") |
|
1235 | _ip.magic("timeit -n1 -r1 a=('#')") | |
1219 |
|
1236 | |||
1220 |
|
1237 | |||
1221 | TEST_MODULE = """ |
|
1238 | TEST_MODULE = """ | |
1222 | print('Loaded my_tmp') |
|
1239 | print('Loaded my_tmp') | |
1223 | if __name__ == "__main__": |
|
1240 | if __name__ == "__main__": | |
1224 | print('I just ran a script') |
|
1241 | print('I just ran a script') | |
1225 | """ |
|
1242 | """ | |
1226 |
|
1243 | |||
1227 |
|
1244 | |||
1228 | def test_run_module_from_import_hook(): |
|
1245 | def test_run_module_from_import_hook(): | |
1229 | "Test that a module can be loaded via an import hook" |
|
1246 | "Test that a module can be loaded via an import hook" | |
1230 | with TemporaryDirectory() as tmpdir: |
|
1247 | with TemporaryDirectory() as tmpdir: | |
1231 | fullpath = os.path.join(tmpdir, 'my_tmp.py') |
|
1248 | fullpath = os.path.join(tmpdir, 'my_tmp.py') | |
1232 | Path(fullpath).write_text(TEST_MODULE) |
|
1249 | Path(fullpath).write_text(TEST_MODULE) | |
1233 |
|
1250 | |||
1234 | class MyTempImporter(object): |
|
1251 | class MyTempImporter(object): | |
1235 | def __init__(self): |
|
1252 | def __init__(self): | |
1236 | pass |
|
1253 | pass | |
1237 |
|
1254 | |||
1238 | def find_module(self, fullname, path=None): |
|
1255 | def find_module(self, fullname, path=None): | |
1239 | if 'my_tmp' in fullname: |
|
1256 | if 'my_tmp' in fullname: | |
1240 | return self |
|
1257 | return self | |
1241 | return None |
|
1258 | return None | |
1242 |
|
1259 | |||
1243 | def load_module(self, name): |
|
1260 | def load_module(self, name): | |
1244 | import imp |
|
1261 | import imp | |
1245 | return imp.load_source('my_tmp', fullpath) |
|
1262 | return imp.load_source('my_tmp', fullpath) | |
1246 |
|
1263 | |||
1247 | def get_code(self, fullname): |
|
1264 | def get_code(self, fullname): | |
1248 | return compile(Path(fullpath).read_text(), "foo", "exec") |
|
1265 | return compile(Path(fullpath).read_text(), "foo", "exec") | |
1249 |
|
1266 | |||
1250 | def is_package(self, __): |
|
1267 | def is_package(self, __): | |
1251 | return False |
|
1268 | return False | |
1252 |
|
1269 | |||
1253 | sys.meta_path.insert(0, MyTempImporter()) |
|
1270 | sys.meta_path.insert(0, MyTempImporter()) | |
1254 |
|
1271 | |||
1255 | with capture_output() as captured: |
|
1272 | with capture_output() as captured: | |
1256 | _ip.magic("run -m my_tmp") |
|
1273 | _ip.magic("run -m my_tmp") | |
1257 | _ip.run_cell("import my_tmp") |
|
1274 | _ip.run_cell("import my_tmp") | |
1258 |
|
1275 | |||
1259 | output = "Loaded my_tmp\nI just ran a script\nLoaded my_tmp\n" |
|
1276 | output = "Loaded my_tmp\nI just ran a script\nLoaded my_tmp\n" | |
1260 | nt.assert_equal(output, captured.stdout) |
|
1277 | nt.assert_equal(output, captured.stdout) | |
1261 |
|
1278 | |||
1262 | sys.meta_path.pop(0) |
|
1279 | sys.meta_path.pop(0) |
General Comments 0
You need to be logged in to leave comments.
Login now