Show More
@@ -1,656 +1,653 b'' | |||||
1 | """Implementation of basic magic functions. |
|
1 | """Implementation of basic magic functions. | |
2 | """ |
|
2 | """ | |
3 | #----------------------------------------------------------------------------- |
|
3 | #----------------------------------------------------------------------------- | |
4 | # Copyright (c) 2012 The IPython Development Team. |
|
4 | # Copyright (c) 2012 The IPython Development Team. | |
5 | # |
|
5 | # | |
6 | # Distributed under the terms of the Modified BSD License. |
|
6 | # Distributed under the terms of the Modified BSD License. | |
7 | # |
|
7 | # | |
8 | # The full license is in the file COPYING.txt, distributed with this software. |
|
8 | # The full license is in the file COPYING.txt, distributed with this software. | |
9 | #----------------------------------------------------------------------------- |
|
9 | #----------------------------------------------------------------------------- | |
10 |
|
10 | |||
11 | #----------------------------------------------------------------------------- |
|
11 | #----------------------------------------------------------------------------- | |
12 | # Imports |
|
12 | # Imports | |
13 | #----------------------------------------------------------------------------- |
|
13 | #----------------------------------------------------------------------------- | |
14 | from __future__ import print_function |
|
14 | from __future__ import print_function | |
15 |
|
15 | |||
16 | # Stdlib |
|
16 | # Stdlib | |
17 | import io |
|
17 | import io | |
18 | import json |
|
18 | import json | |
19 | import sys |
|
19 | import sys | |
20 | from pprint import pformat |
|
20 | from pprint import pformat | |
21 |
|
21 | |||
22 | # Our own packages |
|
22 | # Our own packages | |
23 | from IPython.core import magic_arguments, page |
|
23 | from IPython.core import magic_arguments, page | |
24 | from IPython.core.error import UsageError |
|
24 | from IPython.core.error import UsageError | |
25 | from IPython.core.magic import Magics, magics_class, line_magic, magic_escapes |
|
25 | from IPython.core.magic import Magics, magics_class, line_magic, magic_escapes | |
26 | from IPython.utils.text import format_screen, dedent, indent |
|
26 | from IPython.utils.text import format_screen, dedent, indent | |
27 | from IPython.testing.skipdoctest import skip_doctest |
|
27 | from IPython.testing.skipdoctest import skip_doctest | |
28 | from IPython.utils.ipstruct import Struct |
|
28 | from IPython.utils.ipstruct import Struct | |
29 | from IPython.utils.path import unquote_filename |
|
29 | from IPython.utils.path import unquote_filename | |
30 | from IPython.utils.py3compat import unicode_type |
|
30 | from IPython.utils.py3compat import unicode_type | |
31 | from IPython.utils.warn import warn, error |
|
31 | from IPython.utils.warn import warn, error | |
32 |
|
32 | |||
33 | #----------------------------------------------------------------------------- |
|
33 | #----------------------------------------------------------------------------- | |
34 | # Magics class implementation |
|
34 | # Magics class implementation | |
35 | #----------------------------------------------------------------------------- |
|
35 | #----------------------------------------------------------------------------- | |
36 |
|
36 | |||
37 | class MagicsDisplay(object): |
|
37 | class MagicsDisplay(object): | |
38 | def __init__(self, magics_manager): |
|
38 | def __init__(self, magics_manager): | |
39 | self.magics_manager = magics_manager |
|
39 | self.magics_manager = magics_manager | |
40 |
|
40 | |||
41 | def _lsmagic(self): |
|
41 | def _lsmagic(self): | |
42 | """The main implementation of the %lsmagic""" |
|
42 | """The main implementation of the %lsmagic""" | |
43 | mesc = magic_escapes['line'] |
|
43 | mesc = magic_escapes['line'] | |
44 | cesc = magic_escapes['cell'] |
|
44 | cesc = magic_escapes['cell'] | |
45 | mman = self.magics_manager |
|
45 | mman = self.magics_manager | |
46 | magics = mman.lsmagic() |
|
46 | magics = mman.lsmagic() | |
47 | out = ['Available line magics:', |
|
47 | out = ['Available line magics:', | |
48 | mesc + (' '+mesc).join(sorted(magics['line'])), |
|
48 | mesc + (' '+mesc).join(sorted(magics['line'])), | |
49 | '', |
|
49 | '', | |
50 | 'Available cell magics:', |
|
50 | 'Available cell magics:', | |
51 | cesc + (' '+cesc).join(sorted(magics['cell'])), |
|
51 | cesc + (' '+cesc).join(sorted(magics['cell'])), | |
52 | '', |
|
52 | '', | |
53 | mman.auto_status()] |
|
53 | mman.auto_status()] | |
54 | return '\n'.join(out) |
|
54 | return '\n'.join(out) | |
55 |
|
55 | |||
56 | def _repr_pretty_(self, p, cycle): |
|
56 | def _repr_pretty_(self, p, cycle): | |
57 | p.text(self._lsmagic()) |
|
57 | p.text(self._lsmagic()) | |
58 |
|
58 | |||
59 | def __str__(self): |
|
59 | def __str__(self): | |
60 | return self._lsmagic() |
|
60 | return self._lsmagic() | |
61 |
|
61 | |||
62 | def _jsonable(self): |
|
62 | def _jsonable(self): | |
63 | """turn magics dict into jsonable dict of the same structure |
|
63 | """turn magics dict into jsonable dict of the same structure | |
64 |
|
64 | |||
65 | replaces object instances with their class names as strings |
|
65 | replaces object instances with their class names as strings | |
66 | """ |
|
66 | """ | |
67 | magic_dict = {} |
|
67 | magic_dict = {} | |
68 | mman = self.magics_manager |
|
68 | mman = self.magics_manager | |
69 | magics = mman.lsmagic() |
|
69 | magics = mman.lsmagic() | |
70 | for key, subdict in magics.items(): |
|
70 | for key, subdict in magics.items(): | |
71 | d = {} |
|
71 | d = {} | |
72 | magic_dict[key] = d |
|
72 | magic_dict[key] = d | |
73 | for name, obj in subdict.items(): |
|
73 | for name, obj in subdict.items(): | |
74 | try: |
|
74 | try: | |
75 | classname = obj.__self__.__class__.__name__ |
|
75 | classname = obj.__self__.__class__.__name__ | |
76 | except AttributeError: |
|
76 | except AttributeError: | |
77 | classname = 'Other' |
|
77 | classname = 'Other' | |
78 |
|
78 | |||
79 | d[name] = classname |
|
79 | d[name] = classname | |
80 | return magic_dict |
|
80 | return magic_dict | |
81 |
|
81 | |||
82 | def _repr_json_(self): |
|
82 | def _repr_json_(self): | |
83 | return json.dumps(self._jsonable()) |
|
83 | return json.dumps(self._jsonable()) | |
84 |
|
84 | |||
85 |
|
85 | |||
86 | @magics_class |
|
86 | @magics_class | |
87 | class BasicMagics(Magics): |
|
87 | class BasicMagics(Magics): | |
88 | """Magics that provide central IPython functionality. |
|
88 | """Magics that provide central IPython functionality. | |
89 |
|
89 | |||
90 | These are various magics that don't fit into specific categories but that |
|
90 | These are various magics that don't fit into specific categories but that | |
91 | are all part of the base 'IPython experience'.""" |
|
91 | are all part of the base 'IPython experience'.""" | |
92 |
|
92 | |||
93 | @magic_arguments.magic_arguments() |
|
93 | @magic_arguments.magic_arguments() | |
94 | @magic_arguments.argument( |
|
94 | @magic_arguments.argument( | |
95 | '-l', '--line', action='store_true', |
|
95 | '-l', '--line', action='store_true', | |
96 | help="""Create a line magic alias.""" |
|
96 | help="""Create a line magic alias.""" | |
97 | ) |
|
97 | ) | |
98 | @magic_arguments.argument( |
|
98 | @magic_arguments.argument( | |
99 | '-c', '--cell', action='store_true', |
|
99 | '-c', '--cell', action='store_true', | |
100 | help="""Create a cell magic alias.""" |
|
100 | help="""Create a cell magic alias.""" | |
101 | ) |
|
101 | ) | |
102 | @magic_arguments.argument( |
|
102 | @magic_arguments.argument( | |
103 | 'name', |
|
103 | 'name', | |
104 | help="""Name of the magic to be created.""" |
|
104 | help="""Name of the magic to be created.""" | |
105 | ) |
|
105 | ) | |
106 | @magic_arguments.argument( |
|
106 | @magic_arguments.argument( | |
107 | 'target', |
|
107 | 'target', | |
108 | help="""Name of the existing line or cell magic.""" |
|
108 | help="""Name of the existing line or cell magic.""" | |
109 | ) |
|
109 | ) | |
110 | @line_magic |
|
110 | @line_magic | |
111 | def alias_magic(self, line=''): |
|
111 | def alias_magic(self, line=''): | |
112 | """Create an alias for an existing line or cell magic. |
|
112 | """Create an alias for an existing line or cell magic. | |
113 |
|
113 | |||
114 | Examples |
|
114 | Examples | |
115 | -------- |
|
115 | -------- | |
116 | :: |
|
116 | :: | |
117 |
|
117 | |||
118 | In [1]: %alias_magic t timeit |
|
118 | In [1]: %alias_magic t timeit | |
119 | Created `%t` as an alias for `%timeit`. |
|
119 | Created `%t` as an alias for `%timeit`. | |
120 | Created `%%t` as an alias for `%%timeit`. |
|
120 | Created `%%t` as an alias for `%%timeit`. | |
121 |
|
121 | |||
122 | In [2]: %t -n1 pass |
|
122 | In [2]: %t -n1 pass | |
123 | 1 loops, best of 3: 954 ns per loop |
|
123 | 1 loops, best of 3: 954 ns per loop | |
124 |
|
124 | |||
125 | In [3]: %%t -n1 |
|
125 | In [3]: %%t -n1 | |
126 | ...: pass |
|
126 | ...: pass | |
127 | ...: |
|
127 | ...: | |
128 | 1 loops, best of 3: 954 ns per loop |
|
128 | 1 loops, best of 3: 954 ns per loop | |
129 |
|
129 | |||
130 | In [4]: %alias_magic --cell whereami pwd |
|
130 | In [4]: %alias_magic --cell whereami pwd | |
131 | UsageError: Cell magic function `%%pwd` not found. |
|
131 | UsageError: Cell magic function `%%pwd` not found. | |
132 | In [5]: %alias_magic --line whereami pwd |
|
132 | In [5]: %alias_magic --line whereami pwd | |
133 | Created `%whereami` as an alias for `%pwd`. |
|
133 | Created `%whereami` as an alias for `%pwd`. | |
134 |
|
134 | |||
135 | In [6]: %whereami |
|
135 | In [6]: %whereami | |
136 | Out[6]: u'/home/testuser' |
|
136 | Out[6]: u'/home/testuser' | |
137 | """ |
|
137 | """ | |
138 | args = magic_arguments.parse_argstring(self.alias_magic, line) |
|
138 | args = magic_arguments.parse_argstring(self.alias_magic, line) | |
139 | shell = self.shell |
|
139 | shell = self.shell | |
140 | mman = self.shell.magics_manager |
|
140 | mman = self.shell.magics_manager | |
141 | escs = ''.join(magic_escapes.values()) |
|
141 | escs = ''.join(magic_escapes.values()) | |
142 |
|
142 | |||
143 | target = args.target.lstrip(escs) |
|
143 | target = args.target.lstrip(escs) | |
144 | name = args.name.lstrip(escs) |
|
144 | name = args.name.lstrip(escs) | |
145 |
|
145 | |||
146 | # Find the requested magics. |
|
146 | # Find the requested magics. | |
147 | m_line = shell.find_magic(target, 'line') |
|
147 | m_line = shell.find_magic(target, 'line') | |
148 | m_cell = shell.find_magic(target, 'cell') |
|
148 | m_cell = shell.find_magic(target, 'cell') | |
149 | if args.line and m_line is None: |
|
149 | if args.line and m_line is None: | |
150 | raise UsageError('Line magic function `%s%s` not found.' % |
|
150 | raise UsageError('Line magic function `%s%s` not found.' % | |
151 | (magic_escapes['line'], target)) |
|
151 | (magic_escapes['line'], target)) | |
152 | if args.cell and m_cell is None: |
|
152 | if args.cell and m_cell is None: | |
153 | raise UsageError('Cell magic function `%s%s` not found.' % |
|
153 | raise UsageError('Cell magic function `%s%s` not found.' % | |
154 | (magic_escapes['cell'], target)) |
|
154 | (magic_escapes['cell'], target)) | |
155 |
|
155 | |||
156 | # If --line and --cell are not specified, default to the ones |
|
156 | # If --line and --cell are not specified, default to the ones | |
157 | # that are available. |
|
157 | # that are available. | |
158 | if not args.line and not args.cell: |
|
158 | if not args.line and not args.cell: | |
159 | if not m_line and not m_cell: |
|
159 | if not m_line and not m_cell: | |
160 | raise UsageError( |
|
160 | raise UsageError( | |
161 | 'No line or cell magic with name `%s` found.' % target |
|
161 | 'No line or cell magic with name `%s` found.' % target | |
162 | ) |
|
162 | ) | |
163 | args.line = bool(m_line) |
|
163 | args.line = bool(m_line) | |
164 | args.cell = bool(m_cell) |
|
164 | args.cell = bool(m_cell) | |
165 |
|
165 | |||
166 | if args.line: |
|
166 | if args.line: | |
167 | mman.register_alias(name, target, 'line') |
|
167 | mman.register_alias(name, target, 'line') | |
168 | print('Created `%s%s` as an alias for `%s%s`.' % ( |
|
168 | print('Created `%s%s` as an alias for `%s%s`.' % ( | |
169 | magic_escapes['line'], name, |
|
169 | magic_escapes['line'], name, | |
170 | magic_escapes['line'], target)) |
|
170 | magic_escapes['line'], target)) | |
171 |
|
171 | |||
172 | if args.cell: |
|
172 | if args.cell: | |
173 | mman.register_alias(name, target, 'cell') |
|
173 | mman.register_alias(name, target, 'cell') | |
174 | print('Created `%s%s` as an alias for `%s%s`.' % ( |
|
174 | print('Created `%s%s` as an alias for `%s%s`.' % ( | |
175 | magic_escapes['cell'], name, |
|
175 | magic_escapes['cell'], name, | |
176 | magic_escapes['cell'], target)) |
|
176 | magic_escapes['cell'], target)) | |
177 |
|
177 | |||
178 | @line_magic |
|
178 | @line_magic | |
179 | def lsmagic(self, parameter_s=''): |
|
179 | def lsmagic(self, parameter_s=''): | |
180 | """List currently available magic functions.""" |
|
180 | """List currently available magic functions.""" | |
181 | return MagicsDisplay(self.shell.magics_manager) |
|
181 | return MagicsDisplay(self.shell.magics_manager) | |
182 |
|
182 | |||
183 | def _magic_docs(self, brief=False, rest=False): |
|
183 | def _magic_docs(self, brief=False, rest=False): | |
184 | """Return docstrings from magic functions.""" |
|
184 | """Return docstrings from magic functions.""" | |
185 | mman = self.shell.magics_manager |
|
185 | mman = self.shell.magics_manager | |
186 | docs = mman.lsmagic_docs(brief, missing='No documentation') |
|
186 | docs = mman.lsmagic_docs(brief, missing='No documentation') | |
187 |
|
187 | |||
188 | if rest: |
|
188 | if rest: | |
189 | format_string = '**%s%s**::\n\n%s\n\n' |
|
189 | format_string = '**%s%s**::\n\n%s\n\n' | |
190 | else: |
|
190 | else: | |
191 | format_string = '%s%s:\n%s\n' |
|
191 | format_string = '%s%s:\n%s\n' | |
192 |
|
192 | |||
193 | return ''.join( |
|
193 | return ''.join( | |
194 | [format_string % (magic_escapes['line'], fname, |
|
194 | [format_string % (magic_escapes['line'], fname, | |
195 | indent(dedent(fndoc))) |
|
195 | indent(dedent(fndoc))) | |
196 | for fname, fndoc in sorted(docs['line'].items())] |
|
196 | for fname, fndoc in sorted(docs['line'].items())] | |
197 | + |
|
197 | + | |
198 | [format_string % (magic_escapes['cell'], fname, |
|
198 | [format_string % (magic_escapes['cell'], fname, | |
199 | indent(dedent(fndoc))) |
|
199 | indent(dedent(fndoc))) | |
200 | for fname, fndoc in sorted(docs['cell'].items())] |
|
200 | for fname, fndoc in sorted(docs['cell'].items())] | |
201 | ) |
|
201 | ) | |
202 |
|
202 | |||
203 | @line_magic |
|
203 | @line_magic | |
204 | def magic(self, parameter_s=''): |
|
204 | def magic(self, parameter_s=''): | |
205 | """Print information about the magic function system. |
|
205 | """Print information about the magic function system. | |
206 |
|
206 | |||
207 | Supported formats: -latex, -brief, -rest |
|
207 | Supported formats: -latex, -brief, -rest | |
208 | """ |
|
208 | """ | |
209 |
|
209 | |||
210 | mode = '' |
|
210 | mode = '' | |
211 | try: |
|
211 | try: | |
212 | mode = parameter_s.split()[0][1:] |
|
212 | mode = parameter_s.split()[0][1:] | |
213 | if mode == 'rest': |
|
213 | if mode == 'rest': | |
214 | rest_docs = [] |
|
214 | rest_docs = [] | |
215 | except IndexError: |
|
215 | except IndexError: | |
216 | pass |
|
216 | pass | |
217 |
|
217 | |||
218 | brief = (mode == 'brief') |
|
218 | brief = (mode == 'brief') | |
219 | rest = (mode == 'rest') |
|
219 | rest = (mode == 'rest') | |
220 | magic_docs = self._magic_docs(brief, rest) |
|
220 | magic_docs = self._magic_docs(brief, rest) | |
221 |
|
221 | |||
222 | if mode == 'latex': |
|
222 | if mode == 'latex': | |
223 | print(self.format_latex(magic_docs)) |
|
223 | print(self.format_latex(magic_docs)) | |
224 | return |
|
224 | return | |
225 | else: |
|
225 | else: | |
226 | magic_docs = format_screen(magic_docs) |
|
226 | magic_docs = format_screen(magic_docs) | |
227 |
|
227 | |||
228 | out = [""" |
|
228 | out = [""" | |
229 | IPython's 'magic' functions |
|
229 | IPython's 'magic' functions | |
230 | =========================== |
|
230 | =========================== | |
231 |
|
231 | |||
232 | The magic function system provides a series of functions which allow you to |
|
232 | The magic function system provides a series of functions which allow you to | |
233 | control the behavior of IPython itself, plus a lot of system-type |
|
233 | control the behavior of IPython itself, plus a lot of system-type | |
234 | features. There are two kinds of magics, line-oriented and cell-oriented. |
|
234 | features. There are two kinds of magics, line-oriented and cell-oriented. | |
235 |
|
235 | |||
236 | Line magics are prefixed with the % character and work much like OS |
|
236 | Line magics are prefixed with the % character and work much like OS | |
237 | command-line calls: they get as an argument the rest of the line, where |
|
237 | command-line calls: they get as an argument the rest of the line, where | |
238 | arguments are passed without parentheses or quotes. For example, this will |
|
238 | arguments are passed without parentheses or quotes. For example, this will | |
239 | time the given statement:: |
|
239 | time the given statement:: | |
240 |
|
240 | |||
241 | %timeit range(1000) |
|
241 | %timeit range(1000) | |
242 |
|
242 | |||
243 | Cell magics are prefixed with a double %%, and they are functions that get as |
|
243 | Cell magics are prefixed with a double %%, and they are functions that get as | |
244 | an argument not only the rest of the line, but also the lines below it in a |
|
244 | an argument not only the rest of the line, but also the lines below it in a | |
245 | separate argument. These magics are called with two arguments: the rest of the |
|
245 | separate argument. These magics are called with two arguments: the rest of the | |
246 | call line and the body of the cell, consisting of the lines below the first. |
|
246 | call line and the body of the cell, consisting of the lines below the first. | |
247 | For example:: |
|
247 | For example:: | |
248 |
|
248 | |||
249 | %%timeit x = numpy.random.randn((100, 100)) |
|
249 | %%timeit x = numpy.random.randn((100, 100)) | |
250 | numpy.linalg.svd(x) |
|
250 | numpy.linalg.svd(x) | |
251 |
|
251 | |||
252 | will time the execution of the numpy svd routine, running the assignment of x |
|
252 | will time the execution of the numpy svd routine, running the assignment of x | |
253 | as part of the setup phase, which is not timed. |
|
253 | as part of the setup phase, which is not timed. | |
254 |
|
254 | |||
255 | In a line-oriented client (the terminal or Qt console IPython), starting a new |
|
255 | In a line-oriented client (the terminal or Qt console IPython), starting a new | |
256 | input with %% will automatically enter cell mode, and IPython will continue |
|
256 | input with %% will automatically enter cell mode, and IPython will continue | |
257 | reading input until a blank line is given. In the notebook, simply type the |
|
257 | reading input until a blank line is given. In the notebook, simply type the | |
258 | whole cell as one entity, but keep in mind that the %% escape can only be at |
|
258 | whole cell as one entity, but keep in mind that the %% escape can only be at | |
259 | the very start of the cell. |
|
259 | the very start of the cell. | |
260 |
|
260 | |||
261 | NOTE: If you have 'automagic' enabled (via the command line option or with the |
|
261 | NOTE: If you have 'automagic' enabled (via the command line option or with the | |
262 | %automagic function), you don't need to type in the % explicitly for line |
|
262 | %automagic function), you don't need to type in the % explicitly for line | |
263 | magics; cell magics always require an explicit '%%' escape. By default, |
|
263 | magics; cell magics always require an explicit '%%' escape. By default, | |
264 | IPython ships with automagic on, so you should only rarely need the % escape. |
|
264 | IPython ships with automagic on, so you should only rarely need the % escape. | |
265 |
|
265 | |||
266 | Example: typing '%cd mydir' (without the quotes) changes you working directory |
|
266 | Example: typing '%cd mydir' (without the quotes) changes you working directory | |
267 | to 'mydir', if it exists. |
|
267 | to 'mydir', if it exists. | |
268 |
|
268 | |||
269 | For a list of the available magic functions, use %lsmagic. For a description |
|
269 | For a list of the available magic functions, use %lsmagic. For a description | |
270 | of any of them, type %magic_name?, e.g. '%cd?'. |
|
270 | of any of them, type %magic_name?, e.g. '%cd?'. | |
271 |
|
271 | |||
272 | Currently the magic system has the following functions:""", |
|
272 | Currently the magic system has the following functions:""", | |
273 | magic_docs, |
|
273 | magic_docs, | |
274 | "Summary of magic functions (from %slsmagic):" % magic_escapes['line'], |
|
274 | "Summary of magic functions (from %slsmagic):" % magic_escapes['line'], | |
275 | str(self.lsmagic()), |
|
275 | str(self.lsmagic()), | |
276 | ] |
|
276 | ] | |
277 | page.page('\n'.join(out)) |
|
277 | page.page('\n'.join(out)) | |
278 |
|
278 | |||
279 |
|
279 | |||
280 | @line_magic |
|
280 | @line_magic | |
281 | def page(self, parameter_s=''): |
|
281 | def page(self, parameter_s=''): | |
282 | """Pretty print the object and display it through a pager. |
|
282 | """Pretty print the object and display it through a pager. | |
283 |
|
283 | |||
284 | %page [options] OBJECT |
|
284 | %page [options] OBJECT | |
285 |
|
285 | |||
286 | If no object is given, use _ (last output). |
|
286 | If no object is given, use _ (last output). | |
287 |
|
287 | |||
288 | Options: |
|
288 | Options: | |
289 |
|
289 | |||
290 | -r: page str(object), don't pretty-print it.""" |
|
290 | -r: page str(object), don't pretty-print it.""" | |
291 |
|
291 | |||
292 | # After a function contributed by Olivier Aubert, slightly modified. |
|
292 | # After a function contributed by Olivier Aubert, slightly modified. | |
293 |
|
293 | |||
294 | # Process options/args |
|
294 | # Process options/args | |
295 | opts, args = self.parse_options(parameter_s, 'r') |
|
295 | opts, args = self.parse_options(parameter_s, 'r') | |
296 | raw = 'r' in opts |
|
296 | raw = 'r' in opts | |
297 |
|
297 | |||
298 | oname = args and args or '_' |
|
298 | oname = args and args or '_' | |
299 | info = self.shell._ofind(oname) |
|
299 | info = self.shell._ofind(oname) | |
300 | if info['found']: |
|
300 | if info['found']: | |
301 | txt = (raw and str or pformat)( info['obj'] ) |
|
301 | txt = (raw and str or pformat)( info['obj'] ) | |
302 | page.page(txt) |
|
302 | page.page(txt) | |
303 | else: |
|
303 | else: | |
304 | print('Object `%s` not found' % oname) |
|
304 | print('Object `%s` not found' % oname) | |
305 |
|
305 | |||
306 | @line_magic |
|
306 | @line_magic | |
307 | def profile(self, parameter_s=''): |
|
307 | def profile(self, parameter_s=''): | |
308 | """Print your currently active IPython profile. |
|
308 | """Print your currently active IPython profile. | |
309 |
|
309 | |||
310 | See Also |
|
310 | See Also | |
311 | -------- |
|
311 | -------- | |
312 | prun : run code using the Python profiler |
|
312 | prun : run code using the Python profiler | |
313 | (:meth:`~IPython.core.magics.execution.ExecutionMagics.prun`) |
|
313 | (:meth:`~IPython.core.magics.execution.ExecutionMagics.prun`) | |
314 | """ |
|
314 | """ | |
315 | warn("%profile is now deprecated. Please use get_ipython().profile instead.") |
|
315 | warn("%profile is now deprecated. Please use get_ipython().profile instead.") | |
316 | from IPython.core.application import BaseIPythonApplication |
|
316 | from IPython.core.application import BaseIPythonApplication | |
317 | if BaseIPythonApplication.initialized(): |
|
317 | if BaseIPythonApplication.initialized(): | |
318 | print(BaseIPythonApplication.instance().profile) |
|
318 | print(BaseIPythonApplication.instance().profile) | |
319 | else: |
|
319 | else: | |
320 | error("profile is an application-level value, but you don't appear to be in an IPython application") |
|
320 | error("profile is an application-level value, but you don't appear to be in an IPython application") | |
321 |
|
321 | |||
322 | @line_magic |
|
322 | @line_magic | |
323 | def pprint(self, parameter_s=''): |
|
323 | def pprint(self, parameter_s=''): | |
324 | """Toggle pretty printing on/off.""" |
|
324 | """Toggle pretty printing on/off.""" | |
325 | ptformatter = self.shell.display_formatter.formatters['text/plain'] |
|
325 | ptformatter = self.shell.display_formatter.formatters['text/plain'] | |
326 | ptformatter.pprint = bool(1 - ptformatter.pprint) |
|
326 | ptformatter.pprint = bool(1 - ptformatter.pprint) | |
327 | print('Pretty printing has been turned', |
|
327 | print('Pretty printing has been turned', | |
328 | ['OFF','ON'][ptformatter.pprint]) |
|
328 | ['OFF','ON'][ptformatter.pprint]) | |
329 |
|
329 | |||
330 | @line_magic |
|
330 | @line_magic | |
331 | def colors(self, parameter_s=''): |
|
331 | def colors(self, parameter_s=''): | |
332 | """Switch color scheme for prompts, info system and exception handlers. |
|
332 | """Switch color scheme for prompts, info system and exception handlers. | |
333 |
|
333 | |||
334 | Currently implemented schemes: NoColor, Linux, LightBG. |
|
334 | Currently implemented schemes: NoColor, Linux, LightBG. | |
335 |
|
335 | |||
336 | Color scheme names are not case-sensitive. |
|
336 | Color scheme names are not case-sensitive. | |
337 |
|
337 | |||
338 | Examples |
|
338 | Examples | |
339 | -------- |
|
339 | -------- | |
340 | To get a plain black and white terminal:: |
|
340 | To get a plain black and white terminal:: | |
341 |
|
341 | |||
342 | %colors nocolor |
|
342 | %colors nocolor | |
343 | """ |
|
343 | """ | |
344 | def color_switch_err(name): |
|
344 | def color_switch_err(name): | |
345 | warn('Error changing %s color schemes.\n%s' % |
|
345 | warn('Error changing %s color schemes.\n%s' % | |
346 | (name, sys.exc_info()[1])) |
|
346 | (name, sys.exc_info()[1])) | |
347 |
|
347 | |||
348 |
|
348 | |||
349 | new_scheme = parameter_s.strip() |
|
349 | new_scheme = parameter_s.strip() | |
350 | if not new_scheme: |
|
350 | if not new_scheme: | |
351 | raise UsageError( |
|
351 | raise UsageError( | |
352 | "%colors: you must specify a color scheme. See '%colors?'") |
|
352 | "%colors: you must specify a color scheme. See '%colors?'") | |
353 | # local shortcut |
|
353 | # local shortcut | |
354 | shell = self.shell |
|
354 | shell = self.shell | |
355 |
|
355 | |||
356 | import IPython.utils.rlineimpl as readline |
|
356 | import IPython.utils.rlineimpl as readline | |
357 |
|
357 | |||
358 | if not shell.colors_force and \ |
|
358 | if not shell.colors_force and \ | |
359 | not readline.have_readline and \ |
|
359 | not readline.have_readline and \ | |
360 | (sys.platform == "win32" or sys.platform == "cli"): |
|
360 | (sys.platform == "win32" or sys.platform == "cli"): | |
361 | msg = """\ |
|
361 | msg = """\ | |
362 | Proper color support under MS Windows requires the pyreadline library. |
|
362 | Proper color support under MS Windows requires the pyreadline library. | |
363 | You can find it at: |
|
363 | You can find it at: | |
364 | http://ipython.org/pyreadline.html |
|
364 | http://ipython.org/pyreadline.html | |
365 | Gary's readline needs the ctypes module, from: |
|
|||
366 | http://starship.python.net/crew/theller/ctypes |
|
|||
367 | (Note that ctypes is already part of Python versions 2.5 and newer). |
|
|||
368 |
|
365 | |||
369 | Defaulting color scheme to 'NoColor'""" |
|
366 | Defaulting color scheme to 'NoColor'""" | |
370 | new_scheme = 'NoColor' |
|
367 | new_scheme = 'NoColor' | |
371 | warn(msg) |
|
368 | warn(msg) | |
372 |
|
369 | |||
373 | # readline option is 0 |
|
370 | # readline option is 0 | |
374 | if not shell.colors_force and not shell.has_readline: |
|
371 | if not shell.colors_force and not shell.has_readline: | |
375 | new_scheme = 'NoColor' |
|
372 | new_scheme = 'NoColor' | |
376 |
|
373 | |||
377 | # Set prompt colors |
|
374 | # Set prompt colors | |
378 | try: |
|
375 | try: | |
379 | shell.prompt_manager.color_scheme = new_scheme |
|
376 | shell.prompt_manager.color_scheme = new_scheme | |
380 | except: |
|
377 | except: | |
381 | color_switch_err('prompt') |
|
378 | color_switch_err('prompt') | |
382 | else: |
|
379 | else: | |
383 | shell.colors = \ |
|
380 | shell.colors = \ | |
384 | shell.prompt_manager.color_scheme_table.active_scheme_name |
|
381 | shell.prompt_manager.color_scheme_table.active_scheme_name | |
385 | # Set exception colors |
|
382 | # Set exception colors | |
386 | try: |
|
383 | try: | |
387 | shell.InteractiveTB.set_colors(scheme = new_scheme) |
|
384 | shell.InteractiveTB.set_colors(scheme = new_scheme) | |
388 | shell.SyntaxTB.set_colors(scheme = new_scheme) |
|
385 | shell.SyntaxTB.set_colors(scheme = new_scheme) | |
389 | except: |
|
386 | except: | |
390 | color_switch_err('exception') |
|
387 | color_switch_err('exception') | |
391 |
|
388 | |||
392 | # Set info (for 'object?') colors |
|
389 | # Set info (for 'object?') colors | |
393 | if shell.color_info: |
|
390 | if shell.color_info: | |
394 | try: |
|
391 | try: | |
395 | shell.inspector.set_active_scheme(new_scheme) |
|
392 | shell.inspector.set_active_scheme(new_scheme) | |
396 | except: |
|
393 | except: | |
397 | color_switch_err('object inspector') |
|
394 | color_switch_err('object inspector') | |
398 | else: |
|
395 | else: | |
399 | shell.inspector.set_active_scheme('NoColor') |
|
396 | shell.inspector.set_active_scheme('NoColor') | |
400 |
|
397 | |||
401 | @line_magic |
|
398 | @line_magic | |
402 | def xmode(self, parameter_s=''): |
|
399 | def xmode(self, parameter_s=''): | |
403 | """Switch modes for the exception handlers. |
|
400 | """Switch modes for the exception handlers. | |
404 |
|
401 | |||
405 | Valid modes: Plain, Context and Verbose. |
|
402 | Valid modes: Plain, Context and Verbose. | |
406 |
|
403 | |||
407 | If called without arguments, acts as a toggle.""" |
|
404 | If called without arguments, acts as a toggle.""" | |
408 |
|
405 | |||
409 | def xmode_switch_err(name): |
|
406 | def xmode_switch_err(name): | |
410 | warn('Error changing %s exception modes.\n%s' % |
|
407 | warn('Error changing %s exception modes.\n%s' % | |
411 | (name,sys.exc_info()[1])) |
|
408 | (name,sys.exc_info()[1])) | |
412 |
|
409 | |||
413 | shell = self.shell |
|
410 | shell = self.shell | |
414 | new_mode = parameter_s.strip().capitalize() |
|
411 | new_mode = parameter_s.strip().capitalize() | |
415 | try: |
|
412 | try: | |
416 | shell.InteractiveTB.set_mode(mode=new_mode) |
|
413 | shell.InteractiveTB.set_mode(mode=new_mode) | |
417 | print('Exception reporting mode:',shell.InteractiveTB.mode) |
|
414 | print('Exception reporting mode:',shell.InteractiveTB.mode) | |
418 | except: |
|
415 | except: | |
419 | xmode_switch_err('user') |
|
416 | xmode_switch_err('user') | |
420 |
|
417 | |||
421 | @line_magic |
|
418 | @line_magic | |
422 | def quickref(self,arg): |
|
419 | def quickref(self,arg): | |
423 | """ Show a quick reference sheet """ |
|
420 | """ Show a quick reference sheet """ | |
424 | from IPython.core.usage import quick_reference |
|
421 | from IPython.core.usage import quick_reference | |
425 | qr = quick_reference + self._magic_docs(brief=True) |
|
422 | qr = quick_reference + self._magic_docs(brief=True) | |
426 | page.page(qr) |
|
423 | page.page(qr) | |
427 |
|
424 | |||
428 | @line_magic |
|
425 | @line_magic | |
429 | def doctest_mode(self, parameter_s=''): |
|
426 | def doctest_mode(self, parameter_s=''): | |
430 | """Toggle doctest mode on and off. |
|
427 | """Toggle doctest mode on and off. | |
431 |
|
428 | |||
432 | This mode is intended to make IPython behave as much as possible like a |
|
429 | This mode is intended to make IPython behave as much as possible like a | |
433 | plain Python shell, from the perspective of how its prompts, exceptions |
|
430 | plain Python shell, from the perspective of how its prompts, exceptions | |
434 | and output look. This makes it easy to copy and paste parts of a |
|
431 | and output look. This makes it easy to copy and paste parts of a | |
435 | session into doctests. It does so by: |
|
432 | session into doctests. It does so by: | |
436 |
|
433 | |||
437 | - Changing the prompts to the classic ``>>>`` ones. |
|
434 | - Changing the prompts to the classic ``>>>`` ones. | |
438 | - Changing the exception reporting mode to 'Plain'. |
|
435 | - Changing the exception reporting mode to 'Plain'. | |
439 | - Disabling pretty-printing of output. |
|
436 | - Disabling pretty-printing of output. | |
440 |
|
437 | |||
441 | Note that IPython also supports the pasting of code snippets that have |
|
438 | Note that IPython also supports the pasting of code snippets that have | |
442 | leading '>>>' and '...' prompts in them. This means that you can paste |
|
439 | leading '>>>' and '...' prompts in them. This means that you can paste | |
443 | doctests from files or docstrings (even if they have leading |
|
440 | doctests from files or docstrings (even if they have leading | |
444 | whitespace), and the code will execute correctly. You can then use |
|
441 | whitespace), and the code will execute correctly. You can then use | |
445 | '%history -t' to see the translated history; this will give you the |
|
442 | '%history -t' to see the translated history; this will give you the | |
446 | input after removal of all the leading prompts and whitespace, which |
|
443 | input after removal of all the leading prompts and whitespace, which | |
447 | can be pasted back into an editor. |
|
444 | can be pasted back into an editor. | |
448 |
|
445 | |||
449 | With these features, you can switch into this mode easily whenever you |
|
446 | With these features, you can switch into this mode easily whenever you | |
450 | need to do testing and changes to doctests, without having to leave |
|
447 | need to do testing and changes to doctests, without having to leave | |
451 | your existing IPython session. |
|
448 | your existing IPython session. | |
452 | """ |
|
449 | """ | |
453 |
|
450 | |||
454 | # Shorthands |
|
451 | # Shorthands | |
455 | shell = self.shell |
|
452 | shell = self.shell | |
456 | pm = shell.prompt_manager |
|
453 | pm = shell.prompt_manager | |
457 | meta = shell.meta |
|
454 | meta = shell.meta | |
458 | disp_formatter = self.shell.display_formatter |
|
455 | disp_formatter = self.shell.display_formatter | |
459 | ptformatter = disp_formatter.formatters['text/plain'] |
|
456 | ptformatter = disp_formatter.formatters['text/plain'] | |
460 | # dstore is a data store kept in the instance metadata bag to track any |
|
457 | # dstore is a data store kept in the instance metadata bag to track any | |
461 | # changes we make, so we can undo them later. |
|
458 | # changes we make, so we can undo them later. | |
462 | dstore = meta.setdefault('doctest_mode',Struct()) |
|
459 | dstore = meta.setdefault('doctest_mode',Struct()) | |
463 | save_dstore = dstore.setdefault |
|
460 | save_dstore = dstore.setdefault | |
464 |
|
461 | |||
465 | # save a few values we'll need to recover later |
|
462 | # save a few values we'll need to recover later | |
466 | mode = save_dstore('mode',False) |
|
463 | mode = save_dstore('mode',False) | |
467 | save_dstore('rc_pprint',ptformatter.pprint) |
|
464 | save_dstore('rc_pprint',ptformatter.pprint) | |
468 | save_dstore('xmode',shell.InteractiveTB.mode) |
|
465 | save_dstore('xmode',shell.InteractiveTB.mode) | |
469 | save_dstore('rc_separate_out',shell.separate_out) |
|
466 | save_dstore('rc_separate_out',shell.separate_out) | |
470 | save_dstore('rc_separate_out2',shell.separate_out2) |
|
467 | save_dstore('rc_separate_out2',shell.separate_out2) | |
471 | save_dstore('rc_prompts_pad_left',pm.justify) |
|
468 | save_dstore('rc_prompts_pad_left',pm.justify) | |
472 | save_dstore('rc_separate_in',shell.separate_in) |
|
469 | save_dstore('rc_separate_in',shell.separate_in) | |
473 | save_dstore('rc_active_types',disp_formatter.active_types) |
|
470 | save_dstore('rc_active_types',disp_formatter.active_types) | |
474 | save_dstore('prompt_templates',(pm.in_template, pm.in2_template, pm.out_template)) |
|
471 | save_dstore('prompt_templates',(pm.in_template, pm.in2_template, pm.out_template)) | |
475 |
|
472 | |||
476 | if mode == False: |
|
473 | if mode == False: | |
477 | # turn on |
|
474 | # turn on | |
478 | pm.in_template = '>>> ' |
|
475 | pm.in_template = '>>> ' | |
479 | pm.in2_template = '... ' |
|
476 | pm.in2_template = '... ' | |
480 | pm.out_template = '' |
|
477 | pm.out_template = '' | |
481 |
|
478 | |||
482 | # Prompt separators like plain python |
|
479 | # Prompt separators like plain python | |
483 | shell.separate_in = '' |
|
480 | shell.separate_in = '' | |
484 | shell.separate_out = '' |
|
481 | shell.separate_out = '' | |
485 | shell.separate_out2 = '' |
|
482 | shell.separate_out2 = '' | |
486 |
|
483 | |||
487 | pm.justify = False |
|
484 | pm.justify = False | |
488 |
|
485 | |||
489 | ptformatter.pprint = False |
|
486 | ptformatter.pprint = False | |
490 | disp_formatter.active_types = ['text/plain'] |
|
487 | disp_formatter.active_types = ['text/plain'] | |
491 |
|
488 | |||
492 | shell.magic('xmode Plain') |
|
489 | shell.magic('xmode Plain') | |
493 | else: |
|
490 | else: | |
494 | # turn off |
|
491 | # turn off | |
495 | pm.in_template, pm.in2_template, pm.out_template = dstore.prompt_templates |
|
492 | pm.in_template, pm.in2_template, pm.out_template = dstore.prompt_templates | |
496 |
|
493 | |||
497 | shell.separate_in = dstore.rc_separate_in |
|
494 | shell.separate_in = dstore.rc_separate_in | |
498 |
|
495 | |||
499 | shell.separate_out = dstore.rc_separate_out |
|
496 | shell.separate_out = dstore.rc_separate_out | |
500 | shell.separate_out2 = dstore.rc_separate_out2 |
|
497 | shell.separate_out2 = dstore.rc_separate_out2 | |
501 |
|
498 | |||
502 | pm.justify = dstore.rc_prompts_pad_left |
|
499 | pm.justify = dstore.rc_prompts_pad_left | |
503 |
|
500 | |||
504 | ptformatter.pprint = dstore.rc_pprint |
|
501 | ptformatter.pprint = dstore.rc_pprint | |
505 | disp_formatter.active_types = dstore.rc_active_types |
|
502 | disp_formatter.active_types = dstore.rc_active_types | |
506 |
|
503 | |||
507 | shell.magic('xmode ' + dstore.xmode) |
|
504 | shell.magic('xmode ' + dstore.xmode) | |
508 |
|
505 | |||
509 | # Store new mode and inform |
|
506 | # Store new mode and inform | |
510 | dstore.mode = bool(1-int(mode)) |
|
507 | dstore.mode = bool(1-int(mode)) | |
511 | mode_label = ['OFF','ON'][dstore.mode] |
|
508 | mode_label = ['OFF','ON'][dstore.mode] | |
512 | print('Doctest mode is:', mode_label) |
|
509 | print('Doctest mode is:', mode_label) | |
513 |
|
510 | |||
514 | @line_magic |
|
511 | @line_magic | |
515 | def gui(self, parameter_s=''): |
|
512 | def gui(self, parameter_s=''): | |
516 | """Enable or disable IPython GUI event loop integration. |
|
513 | """Enable or disable IPython GUI event loop integration. | |
517 |
|
514 | |||
518 | %gui [GUINAME] |
|
515 | %gui [GUINAME] | |
519 |
|
516 | |||
520 | This magic replaces IPython's threaded shells that were activated |
|
517 | This magic replaces IPython's threaded shells that were activated | |
521 | using the (pylab/wthread/etc.) command line flags. GUI toolkits |
|
518 | using the (pylab/wthread/etc.) command line flags. GUI toolkits | |
522 | can now be enabled at runtime and keyboard |
|
519 | can now be enabled at runtime and keyboard | |
523 | interrupts should work without any problems. The following toolkits |
|
520 | interrupts should work without any problems. The following toolkits | |
524 | are supported: wxPython, PyQt4, PyGTK, Tk and Cocoa (OSX):: |
|
521 | are supported: wxPython, PyQt4, PyGTK, Tk and Cocoa (OSX):: | |
525 |
|
522 | |||
526 | %gui wx # enable wxPython event loop integration |
|
523 | %gui wx # enable wxPython event loop integration | |
527 | %gui qt4|qt # enable PyQt4 event loop integration |
|
524 | %gui qt4|qt # enable PyQt4 event loop integration | |
528 | %gui qt5 # enable PyQt5 event loop integration |
|
525 | %gui qt5 # enable PyQt5 event loop integration | |
529 | %gui gtk # enable PyGTK event loop integration |
|
526 | %gui gtk # enable PyGTK event loop integration | |
530 | %gui gtk3 # enable Gtk3 event loop integration |
|
527 | %gui gtk3 # enable Gtk3 event loop integration | |
531 | %gui tk # enable Tk event loop integration |
|
528 | %gui tk # enable Tk event loop integration | |
532 | %gui osx # enable Cocoa event loop integration |
|
529 | %gui osx # enable Cocoa event loop integration | |
533 | # (requires %matplotlib 1.1) |
|
530 | # (requires %matplotlib 1.1) | |
534 | %gui # disable all event loop integration |
|
531 | %gui # disable all event loop integration | |
535 |
|
532 | |||
536 | WARNING: after any of these has been called you can simply create |
|
533 | WARNING: after any of these has been called you can simply create | |
537 | an application object, but DO NOT start the event loop yourself, as |
|
534 | an application object, but DO NOT start the event loop yourself, as | |
538 | we have already handled that. |
|
535 | we have already handled that. | |
539 | """ |
|
536 | """ | |
540 | opts, arg = self.parse_options(parameter_s, '') |
|
537 | opts, arg = self.parse_options(parameter_s, '') | |
541 | if arg=='': arg = None |
|
538 | if arg=='': arg = None | |
542 | try: |
|
539 | try: | |
543 | return self.shell.enable_gui(arg) |
|
540 | return self.shell.enable_gui(arg) | |
544 | except Exception as e: |
|
541 | except Exception as e: | |
545 | # print simple error message, rather than traceback if we can't |
|
542 | # print simple error message, rather than traceback if we can't | |
546 | # hook up the GUI |
|
543 | # hook up the GUI | |
547 | error(str(e)) |
|
544 | error(str(e)) | |
548 |
|
545 | |||
549 | @skip_doctest |
|
546 | @skip_doctest | |
550 | @line_magic |
|
547 | @line_magic | |
551 | def precision(self, s=''): |
|
548 | def precision(self, s=''): | |
552 | """Set floating point precision for pretty printing. |
|
549 | """Set floating point precision for pretty printing. | |
553 |
|
550 | |||
554 | Can set either integer precision or a format string. |
|
551 | Can set either integer precision or a format string. | |
555 |
|
552 | |||
556 | If numpy has been imported and precision is an int, |
|
553 | If numpy has been imported and precision is an int, | |
557 | numpy display precision will also be set, via ``numpy.set_printoptions``. |
|
554 | numpy display precision will also be set, via ``numpy.set_printoptions``. | |
558 |
|
555 | |||
559 | If no argument is given, defaults will be restored. |
|
556 | If no argument is given, defaults will be restored. | |
560 |
|
557 | |||
561 | Examples |
|
558 | Examples | |
562 | -------- |
|
559 | -------- | |
563 | :: |
|
560 | :: | |
564 |
|
561 | |||
565 | In [1]: from math import pi |
|
562 | In [1]: from math import pi | |
566 |
|
563 | |||
567 | In [2]: %precision 3 |
|
564 | In [2]: %precision 3 | |
568 | Out[2]: u'%.3f' |
|
565 | Out[2]: u'%.3f' | |
569 |
|
566 | |||
570 | In [3]: pi |
|
567 | In [3]: pi | |
571 | Out[3]: 3.142 |
|
568 | Out[3]: 3.142 | |
572 |
|
569 | |||
573 | In [4]: %precision %i |
|
570 | In [4]: %precision %i | |
574 | Out[4]: u'%i' |
|
571 | Out[4]: u'%i' | |
575 |
|
572 | |||
576 | In [5]: pi |
|
573 | In [5]: pi | |
577 | Out[5]: 3 |
|
574 | Out[5]: 3 | |
578 |
|
575 | |||
579 | In [6]: %precision %e |
|
576 | In [6]: %precision %e | |
580 | Out[6]: u'%e' |
|
577 | Out[6]: u'%e' | |
581 |
|
578 | |||
582 | In [7]: pi**10 |
|
579 | In [7]: pi**10 | |
583 | Out[7]: 9.364805e+04 |
|
580 | Out[7]: 9.364805e+04 | |
584 |
|
581 | |||
585 | In [8]: %precision |
|
582 | In [8]: %precision | |
586 | Out[8]: u'%r' |
|
583 | Out[8]: u'%r' | |
587 |
|
584 | |||
588 | In [9]: pi**10 |
|
585 | In [9]: pi**10 | |
589 | Out[9]: 93648.047476082982 |
|
586 | Out[9]: 93648.047476082982 | |
590 | """ |
|
587 | """ | |
591 | ptformatter = self.shell.display_formatter.formatters['text/plain'] |
|
588 | ptformatter = self.shell.display_formatter.formatters['text/plain'] | |
592 | ptformatter.float_precision = s |
|
589 | ptformatter.float_precision = s | |
593 | return ptformatter.float_format |
|
590 | return ptformatter.float_format | |
594 |
|
591 | |||
595 | @magic_arguments.magic_arguments() |
|
592 | @magic_arguments.magic_arguments() | |
596 | @magic_arguments.argument( |
|
593 | @magic_arguments.argument( | |
597 | '-e', '--export', action='store_true', default=False, |
|
594 | '-e', '--export', action='store_true', default=False, | |
598 | help='Export IPython history as a notebook. The filename argument ' |
|
595 | help='Export IPython history as a notebook. The filename argument ' | |
599 | 'is used to specify the notebook name and format. For example ' |
|
596 | 'is used to specify the notebook name and format. For example ' | |
600 | 'a filename of notebook.ipynb will result in a notebook name ' |
|
597 | 'a filename of notebook.ipynb will result in a notebook name ' | |
601 | 'of "notebook" and a format of "json". Likewise using a ".py" ' |
|
598 | 'of "notebook" and a format of "json". Likewise using a ".py" ' | |
602 | 'file extension will write the notebook as a Python script' |
|
599 | 'file extension will write the notebook as a Python script' | |
603 | ) |
|
600 | ) | |
604 | @magic_arguments.argument( |
|
601 | @magic_arguments.argument( | |
605 | '-f', '--format', |
|
602 | '-f', '--format', | |
606 | help='Convert an existing IPython notebook to a new format. This option ' |
|
603 | help='Convert an existing IPython notebook to a new format. This option ' | |
607 | 'specifies the new format and can have the values: json, py. ' |
|
604 | 'specifies the new format and can have the values: json, py. ' | |
608 | 'The target filename is chosen automatically based on the new ' |
|
605 | 'The target filename is chosen automatically based on the new ' | |
609 | 'format. The filename argument gives the name of the source file.' |
|
606 | 'format. The filename argument gives the name of the source file.' | |
610 | ) |
|
607 | ) | |
611 | @magic_arguments.argument( |
|
608 | @magic_arguments.argument( | |
612 | 'filename', type=unicode_type, |
|
609 | 'filename', type=unicode_type, | |
613 | help='Notebook name or filename' |
|
610 | help='Notebook name or filename' | |
614 | ) |
|
611 | ) | |
615 | @line_magic |
|
612 | @line_magic | |
616 | def notebook(self, s): |
|
613 | def notebook(self, s): | |
617 | """Export and convert IPython notebooks. |
|
614 | """Export and convert IPython notebooks. | |
618 |
|
615 | |||
619 | This function can export the current IPython history to a notebook file |
|
616 | This function can export the current IPython history to a notebook file | |
620 | or can convert an existing notebook file into a different format. For |
|
617 | or can convert an existing notebook file into a different format. For | |
621 | example, to export the history to "foo.ipynb" do "%notebook -e foo.ipynb". |
|
618 | example, to export the history to "foo.ipynb" do "%notebook -e foo.ipynb". | |
622 | To export the history to "foo.py" do "%notebook -e foo.py". To convert |
|
619 | To export the history to "foo.py" do "%notebook -e foo.py". To convert | |
623 | "foo.ipynb" to "foo.json" do "%notebook -f json foo.ipynb". Possible |
|
620 | "foo.ipynb" to "foo.json" do "%notebook -f json foo.ipynb". Possible | |
624 | formats include (json/ipynb, py). |
|
621 | formats include (json/ipynb, py). | |
625 | """ |
|
622 | """ | |
626 | args = magic_arguments.parse_argstring(self.notebook, s) |
|
623 | args = magic_arguments.parse_argstring(self.notebook, s) | |
627 |
|
624 | |||
628 | from IPython.nbformat import current |
|
625 | from IPython.nbformat import current | |
629 | args.filename = unquote_filename(args.filename) |
|
626 | args.filename = unquote_filename(args.filename) | |
630 | if args.export: |
|
627 | if args.export: | |
631 | fname, name, format = current.parse_filename(args.filename) |
|
628 | fname, name, format = current.parse_filename(args.filename) | |
632 | cells = [] |
|
629 | cells = [] | |
633 | hist = list(self.shell.history_manager.get_range()) |
|
630 | hist = list(self.shell.history_manager.get_range()) | |
634 | for session, prompt_number, input in hist[:-1]: |
|
631 | for session, prompt_number, input in hist[:-1]: | |
635 | cells.append(current.new_code_cell(prompt_number=prompt_number, |
|
632 | cells.append(current.new_code_cell(prompt_number=prompt_number, | |
636 | input=input)) |
|
633 | input=input)) | |
637 | worksheet = current.new_worksheet(cells=cells) |
|
634 | worksheet = current.new_worksheet(cells=cells) | |
638 | nb = current.new_notebook(name=name,worksheets=[worksheet]) |
|
635 | nb = current.new_notebook(name=name,worksheets=[worksheet]) | |
639 | with io.open(fname, 'w', encoding='utf-8') as f: |
|
636 | with io.open(fname, 'w', encoding='utf-8') as f: | |
640 | current.write(nb, f, format); |
|
637 | current.write(nb, f, format); | |
641 | elif args.format is not None: |
|
638 | elif args.format is not None: | |
642 | old_fname, old_name, old_format = current.parse_filename(args.filename) |
|
639 | old_fname, old_name, old_format = current.parse_filename(args.filename) | |
643 | new_format = args.format |
|
640 | new_format = args.format | |
644 | if new_format == u'xml': |
|
641 | if new_format == u'xml': | |
645 | raise ValueError('Notebooks cannot be written as xml.') |
|
642 | raise ValueError('Notebooks cannot be written as xml.') | |
646 | elif new_format == u'ipynb' or new_format == u'json': |
|
643 | elif new_format == u'ipynb' or new_format == u'json': | |
647 | new_fname = old_name + u'.ipynb' |
|
644 | new_fname = old_name + u'.ipynb' | |
648 | new_format = u'json' |
|
645 | new_format = u'json' | |
649 | elif new_format == u'py': |
|
646 | elif new_format == u'py': | |
650 | new_fname = old_name + u'.py' |
|
647 | new_fname = old_name + u'.py' | |
651 | else: |
|
648 | else: | |
652 | raise ValueError('Invalid notebook format: %s' % new_format) |
|
649 | raise ValueError('Invalid notebook format: %s' % new_format) | |
653 | with io.open(old_fname, 'r', encoding='utf-8') as f: |
|
650 | with io.open(old_fname, 'r', encoding='utf-8') as f: | |
654 | nb = current.read(f, old_format) |
|
651 | nb = current.read(f, old_format) | |
655 | with io.open(new_fname, 'w', encoding='utf-8') as f: |
|
652 | with io.open(new_fname, 'w', encoding='utf-8') as f: | |
656 | current.write(nb, f, new_format) |
|
653 | current.write(nb, f, new_format) |
@@ -1,170 +1,167 b'' | |||||
1 | # encoding: utf-8 |
|
1 | # encoding: utf-8 | |
2 | """ |
|
2 | """ | |
3 | Utilities for getting information about IPython and the system it's running in. |
|
3 | Utilities for getting information about IPython and the system it's running in. | |
4 | """ |
|
4 | """ | |
5 |
|
5 | |||
6 | #----------------------------------------------------------------------------- |
|
6 | #----------------------------------------------------------------------------- | |
7 | # Copyright (C) 2008-2011 The IPython Development Team |
|
7 | # Copyright (C) 2008-2011 The IPython Development Team | |
8 | # |
|
8 | # | |
9 | # Distributed under the terms of the BSD License. The full license is in |
|
9 | # Distributed under the terms of the BSD License. The full license is in | |
10 | # the file COPYING, distributed as part of this software. |
|
10 | # the file COPYING, distributed as part of this software. | |
11 | #----------------------------------------------------------------------------- |
|
11 | #----------------------------------------------------------------------------- | |
12 |
|
12 | |||
13 | #----------------------------------------------------------------------------- |
|
13 | #----------------------------------------------------------------------------- | |
14 | # Imports |
|
14 | # Imports | |
15 | #----------------------------------------------------------------------------- |
|
15 | #----------------------------------------------------------------------------- | |
16 |
|
16 | |||
17 | import os |
|
17 | import os | |
18 | import platform |
|
18 | import platform | |
19 | import pprint |
|
19 | import pprint | |
20 | import sys |
|
20 | import sys | |
21 | import subprocess |
|
21 | import subprocess | |
22 |
|
22 | |||
23 | from IPython.core import release |
|
23 | from IPython.core import release | |
24 | from IPython.utils import py3compat, _sysinfo, encoding |
|
24 | from IPython.utils import py3compat, _sysinfo, encoding | |
25 |
|
25 | |||
26 | #----------------------------------------------------------------------------- |
|
26 | #----------------------------------------------------------------------------- | |
27 | # Code |
|
27 | # Code | |
28 | #----------------------------------------------------------------------------- |
|
28 | #----------------------------------------------------------------------------- | |
29 |
|
29 | |||
30 | def pkg_commit_hash(pkg_path): |
|
30 | def pkg_commit_hash(pkg_path): | |
31 | """Get short form of commit hash given directory `pkg_path` |
|
31 | """Get short form of commit hash given directory `pkg_path` | |
32 |
|
32 | |||
33 | We get the commit hash from (in order of preference): |
|
33 | We get the commit hash from (in order of preference): | |
34 |
|
34 | |||
35 | * IPython.utils._sysinfo.commit |
|
35 | * IPython.utils._sysinfo.commit | |
36 | * git output, if we are in a git repository |
|
36 | * git output, if we are in a git repository | |
37 |
|
37 | |||
38 | If these fail, we return a not-found placeholder tuple |
|
38 | If these fail, we return a not-found placeholder tuple | |
39 |
|
39 | |||
40 | Parameters |
|
40 | Parameters | |
41 | ---------- |
|
41 | ---------- | |
42 | pkg_path : str |
|
42 | pkg_path : str | |
43 | directory containing package |
|
43 | directory containing package | |
44 | only used for getting commit from active repo |
|
44 | only used for getting commit from active repo | |
45 |
|
45 | |||
46 | Returns |
|
46 | Returns | |
47 | ------- |
|
47 | ------- | |
48 | hash_from : str |
|
48 | hash_from : str | |
49 | Where we got the hash from - description |
|
49 | Where we got the hash from - description | |
50 | hash_str : str |
|
50 | hash_str : str | |
51 | short form of hash |
|
51 | short form of hash | |
52 | """ |
|
52 | """ | |
53 | # Try and get commit from written commit text file |
|
53 | # Try and get commit from written commit text file | |
54 | if _sysinfo.commit: |
|
54 | if _sysinfo.commit: | |
55 | return "installation", _sysinfo.commit |
|
55 | return "installation", _sysinfo.commit | |
56 |
|
56 | |||
57 | # maybe we are in a repository |
|
57 | # maybe we are in a repository | |
58 | proc = subprocess.Popen('git rev-parse --short HEAD', |
|
58 | proc = subprocess.Popen('git rev-parse --short HEAD', | |
59 | stdout=subprocess.PIPE, |
|
59 | stdout=subprocess.PIPE, | |
60 | stderr=subprocess.PIPE, |
|
60 | stderr=subprocess.PIPE, | |
61 | cwd=pkg_path, shell=True) |
|
61 | cwd=pkg_path, shell=True) | |
62 | repo_commit, _ = proc.communicate() |
|
62 | repo_commit, _ = proc.communicate() | |
63 | if repo_commit: |
|
63 | if repo_commit: | |
64 | return 'repository', repo_commit.strip().decode('ascii') |
|
64 | return 'repository', repo_commit.strip().decode('ascii') | |
65 | return '(none found)', u'<not found>' |
|
65 | return '(none found)', u'<not found>' | |
66 |
|
66 | |||
67 |
|
67 | |||
68 | def pkg_info(pkg_path): |
|
68 | def pkg_info(pkg_path): | |
69 | """Return dict describing the context of this package |
|
69 | """Return dict describing the context of this package | |
70 |
|
70 | |||
71 | Parameters |
|
71 | Parameters | |
72 | ---------- |
|
72 | ---------- | |
73 | pkg_path : str |
|
73 | pkg_path : str | |
74 | path containing __init__.py for package |
|
74 | path containing __init__.py for package | |
75 |
|
75 | |||
76 | Returns |
|
76 | Returns | |
77 | ------- |
|
77 | ------- | |
78 | context : dict |
|
78 | context : dict | |
79 | with named parameters of interest |
|
79 | with named parameters of interest | |
80 | """ |
|
80 | """ | |
81 | src, hsh = pkg_commit_hash(pkg_path) |
|
81 | src, hsh = pkg_commit_hash(pkg_path) | |
82 | return dict( |
|
82 | return dict( | |
83 | ipython_version=release.version, |
|
83 | ipython_version=release.version, | |
84 | ipython_path=pkg_path, |
|
84 | ipython_path=pkg_path, | |
85 | commit_source=src, |
|
85 | commit_source=src, | |
86 | commit_hash=hsh, |
|
86 | commit_hash=hsh, | |
87 | sys_version=sys.version, |
|
87 | sys_version=sys.version, | |
88 | sys_executable=sys.executable, |
|
88 | sys_executable=sys.executable, | |
89 | sys_platform=sys.platform, |
|
89 | sys_platform=sys.platform, | |
90 | platform=platform.platform(), |
|
90 | platform=platform.platform(), | |
91 | os_name=os.name, |
|
91 | os_name=os.name, | |
92 | default_encoding=encoding.DEFAULT_ENCODING, |
|
92 | default_encoding=encoding.DEFAULT_ENCODING, | |
93 | ) |
|
93 | ) | |
94 |
|
94 | |||
95 | def get_sys_info(): |
|
95 | def get_sys_info(): | |
96 | """Return useful information about IPython and the system, as a dict.""" |
|
96 | """Return useful information about IPython and the system, as a dict.""" | |
97 | p = os.path |
|
97 | p = os.path | |
98 | path = p.realpath(p.dirname(p.abspath(p.join(__file__, '..')))) |
|
98 | path = p.realpath(p.dirname(p.abspath(p.join(__file__, '..')))) | |
99 | return pkg_info(path) |
|
99 | return pkg_info(path) | |
100 |
|
100 | |||
101 | @py3compat.doctest_refactor_print |
|
101 | @py3compat.doctest_refactor_print | |
102 | def sys_info(): |
|
102 | def sys_info(): | |
103 | """Return useful information about IPython and the system, as a string. |
|
103 | """Return useful information about IPython and the system, as a string. | |
104 |
|
104 | |||
105 | Examples |
|
105 | Examples | |
106 | -------- |
|
106 | -------- | |
107 | :: |
|
107 | :: | |
108 |
|
108 | |||
109 | In [2]: print sys_info() |
|
109 | In [2]: print sys_info() | |
110 | {'commit_hash': '144fdae', # random |
|
110 | {'commit_hash': '144fdae', # random | |
111 | 'commit_source': 'repository', |
|
111 | 'commit_source': 'repository', | |
112 | 'ipython_path': '/home/fperez/usr/lib/python2.6/site-packages/IPython', |
|
112 | 'ipython_path': '/home/fperez/usr/lib/python2.6/site-packages/IPython', | |
113 | 'ipython_version': '0.11.dev', |
|
113 | 'ipython_version': '0.11.dev', | |
114 | 'os_name': 'posix', |
|
114 | 'os_name': 'posix', | |
115 | 'platform': 'Linux-2.6.35-22-generic-i686-with-Ubuntu-10.10-maverick', |
|
115 | 'platform': 'Linux-2.6.35-22-generic-i686-with-Ubuntu-10.10-maverick', | |
116 | 'sys_executable': '/usr/bin/python', |
|
116 | 'sys_executable': '/usr/bin/python', | |
117 | 'sys_platform': 'linux2', |
|
117 | 'sys_platform': 'linux2', | |
118 | 'sys_version': '2.6.6 (r266:84292, Sep 15 2010, 15:52:39) \\n[GCC 4.4.5]'} |
|
118 | 'sys_version': '2.6.6 (r266:84292, Sep 15 2010, 15:52:39) \\n[GCC 4.4.5]'} | |
119 | """ |
|
119 | """ | |
120 | return pprint.pformat(get_sys_info()) |
|
120 | return pprint.pformat(get_sys_info()) | |
121 |
|
121 | |||
122 | def _num_cpus_unix(): |
|
122 | def _num_cpus_unix(): | |
123 | """Return the number of active CPUs on a Unix system.""" |
|
123 | """Return the number of active CPUs on a Unix system.""" | |
124 | return os.sysconf("SC_NPROCESSORS_ONLN") |
|
124 | return os.sysconf("SC_NPROCESSORS_ONLN") | |
125 |
|
125 | |||
126 |
|
126 | |||
127 | def _num_cpus_darwin(): |
|
127 | def _num_cpus_darwin(): | |
128 | """Return the number of active CPUs on a Darwin system.""" |
|
128 | """Return the number of active CPUs on a Darwin system.""" | |
129 | p = subprocess.Popen(['sysctl','-n','hw.ncpu'],stdout=subprocess.PIPE) |
|
129 | p = subprocess.Popen(['sysctl','-n','hw.ncpu'],stdout=subprocess.PIPE) | |
130 | return p.stdout.read() |
|
130 | return p.stdout.read() | |
131 |
|
131 | |||
132 |
|
132 | |||
133 | def _num_cpus_windows(): |
|
133 | def _num_cpus_windows(): | |
134 | """Return the number of active CPUs on a Windows system.""" |
|
134 | """Return the number of active CPUs on a Windows system.""" | |
135 | return os.environ.get("NUMBER_OF_PROCESSORS") |
|
135 | return os.environ.get("NUMBER_OF_PROCESSORS") | |
136 |
|
136 | |||
137 |
|
137 | |||
138 | def num_cpus(): |
|
138 | def num_cpus(): | |
139 | """Return the effective number of CPUs in the system as an integer. |
|
139 | """Return the effective number of CPUs in the system as an integer. | |
140 |
|
140 | |||
141 | This cross-platform function makes an attempt at finding the total number of |
|
141 | This cross-platform function makes an attempt at finding the total number of | |
142 | available CPUs in the system, as returned by various underlying system and |
|
142 | available CPUs in the system, as returned by various underlying system and | |
143 | python calls. |
|
143 | python calls. | |
144 |
|
144 | |||
145 | If it can't find a sensible answer, it returns 1 (though an error *may* make |
|
145 | If it can't find a sensible answer, it returns 1 (though an error *may* make | |
146 | it return a large positive number that's actually incorrect). |
|
146 | it return a large positive number that's actually incorrect). | |
147 | """ |
|
147 | """ | |
148 |
|
148 | |||
149 | # Many thanks to the Parallel Python project (http://www.parallelpython.com) |
|
149 | # Many thanks to the Parallel Python project (http://www.parallelpython.com) | |
150 | # for the names of the keys we needed to look up for this function. This |
|
150 | # for the names of the keys we needed to look up for this function. This | |
151 | # code was inspired by their equivalent function. |
|
151 | # code was inspired by their equivalent function. | |
152 |
|
152 | |||
153 | ncpufuncs = {'Linux':_num_cpus_unix, |
|
153 | ncpufuncs = {'Linux':_num_cpus_unix, | |
154 | 'Darwin':_num_cpus_darwin, |
|
154 | 'Darwin':_num_cpus_darwin, | |
155 |
'Windows':_num_cpus_windows |
|
155 | 'Windows':_num_cpus_windows | |
156 | # On Vista, python < 2.5.2 has a bug and returns 'Microsoft' |
|
|||
157 | # See http://bugs.python.org/issue1082 for details. |
|
|||
158 | 'Microsoft':_num_cpus_windows, |
|
|||
159 | } |
|
156 | } | |
160 |
|
157 | |||
161 | ncpufunc = ncpufuncs.get(platform.system(), |
|
158 | ncpufunc = ncpufuncs.get(platform.system(), | |
162 | # default to unix version (Solaris, AIX, etc) |
|
159 | # default to unix version (Solaris, AIX, etc) | |
163 | _num_cpus_unix) |
|
160 | _num_cpus_unix) | |
164 |
|
161 | |||
165 | try: |
|
162 | try: | |
166 | ncpus = max(1,int(ncpufunc())) |
|
163 | ncpus = max(1,int(ncpufunc())) | |
167 | except: |
|
164 | except: | |
168 | ncpus = 1 |
|
165 | ncpus = 1 | |
169 | return ncpus |
|
166 | return ncpus | |
170 |
|
167 |
General Comments 0
You need to be logged in to leave comments.
Login now