Show More
@@ -1,354 +1,349 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """Usage information for the main IPython applications. |
|
2 | """Usage information for the main IPython applications. | |
3 | """ |
|
3 | """ | |
4 | #----------------------------------------------------------------------------- |
|
4 | #----------------------------------------------------------------------------- | |
5 | # Copyright (C) 2008-2011 The IPython Development Team |
|
5 | # Copyright (C) 2008-2011 The IPython Development Team | |
6 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> |
|
6 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> | |
7 | # |
|
7 | # | |
8 | # Distributed under the terms of the BSD License. The full license is in |
|
8 | # Distributed under the terms of the BSD License. The full license is in | |
9 | # the file COPYING, distributed as part of this software. |
|
9 | # the file COPYING, distributed as part of this software. | |
10 | #----------------------------------------------------------------------------- |
|
10 | #----------------------------------------------------------------------------- | |
11 |
|
11 | |||
12 | import sys |
|
12 | import sys | |
13 | from IPython.core import release |
|
13 | from IPython.core import release | |
14 |
|
14 | |||
15 | cl_usage = """\ |
|
15 | cl_usage = """\ | |
16 | ========= |
|
16 | ========= | |
17 | IPython |
|
17 | IPython | |
18 | ========= |
|
18 | ========= | |
19 |
|
19 | |||
20 | Tools for Interactive Computing in Python |
|
20 | Tools for Interactive Computing in Python | |
21 | ========================================= |
|
21 | ========================================= | |
22 |
|
22 | |||
23 | A Python shell with automatic history (input and output), dynamic object |
|
23 | A Python shell with automatic history (input and output), dynamic object | |
24 | introspection, easier configuration, command completion, access to the |
|
24 | introspection, easier configuration, command completion, access to the | |
25 | system shell and more. IPython can also be embedded in running programs. |
|
25 | system shell and more. IPython can also be embedded in running programs. | |
26 |
|
26 | |||
27 |
|
27 | |||
28 | Usage |
|
28 | Usage | |
29 |
|
29 | |||
30 | ipython [subcommand] [options] [-c cmd | -m mod | file] [--] [arg] ... |
|
30 | ipython [subcommand] [options] [-c cmd | -m mod | file] [--] [arg] ... | |
31 |
|
31 | |||
32 | If invoked with no options, it executes the file and exits, passing the |
|
32 | If invoked with no options, it executes the file and exits, passing the | |
33 | remaining arguments to the script, just as if you had specified the same |
|
33 | remaining arguments to the script, just as if you had specified the same | |
34 | command with python. You may need to specify `--` before args to be passed |
|
34 | command with python. You may need to specify `--` before args to be passed | |
35 | to the script, to prevent IPython from attempting to parse them. If you |
|
35 | to the script, to prevent IPython from attempting to parse them. If you | |
36 | specify the option `-i` before the filename, it will enter an interactive |
|
36 | specify the option `-i` before the filename, it will enter an interactive | |
37 | IPython session after running the script, rather than exiting. Files ending |
|
37 | IPython session after running the script, rather than exiting. Files ending | |
38 | in .py will be treated as normal Python, but files ending in .ipy can |
|
38 | in .py will be treated as normal Python, but files ending in .ipy can | |
39 | contain special IPython syntax (magic commands, shell expansions, etc.). |
|
39 | contain special IPython syntax (magic commands, shell expansions, etc.). | |
40 |
|
40 | |||
41 | Almost all configuration in IPython is available via the command-line. Do |
|
41 | Almost all configuration in IPython is available via the command-line. Do | |
42 | `ipython --help-all` to see all available options. For persistent |
|
42 | `ipython --help-all` to see all available options. For persistent | |
43 | configuration, look into your `ipython_config.py` configuration file for |
|
43 | configuration, look into your `ipython_config.py` configuration file for | |
44 | details. |
|
44 | details. | |
45 |
|
45 | |||
46 | This file is typically installed in the `IPYTHONDIR` directory, and there |
|
46 | This file is typically installed in the `IPYTHONDIR` directory, and there | |
47 | is a separate configuration directory for each profile. The default profile |
|
47 | is a separate configuration directory for each profile. The default profile | |
48 | directory will be located in $IPYTHONDIR/profile_default. IPYTHONDIR |
|
48 | directory will be located in $IPYTHONDIR/profile_default. IPYTHONDIR | |
49 | defaults to to `$HOME/.ipython`. For Windows users, $HOME resolves to |
|
49 | defaults to to `$HOME/.ipython`. For Windows users, $HOME resolves to | |
50 | C:\\Users\\YourUserName in most instances. |
|
50 | C:\\Users\\YourUserName in most instances. | |
51 |
|
51 | |||
52 | To initialize a profile with the default configuration file, do:: |
|
52 | To initialize a profile with the default configuration file, do:: | |
53 |
|
53 | |||
54 | $> ipython profile create |
|
54 | $> ipython profile create | |
55 |
|
55 | |||
56 | and start editing `IPYTHONDIR/profile_default/ipython_config.py` |
|
56 | and start editing `IPYTHONDIR/profile_default/ipython_config.py` | |
57 |
|
57 | |||
58 | In IPython's documentation, we will refer to this directory as |
|
58 | In IPython's documentation, we will refer to this directory as | |
59 | `IPYTHONDIR`, you can change its default location by creating an |
|
59 | `IPYTHONDIR`, you can change its default location by creating an | |
60 | environment variable with this name and setting it to the desired path. |
|
60 | environment variable with this name and setting it to the desired path. | |
61 |
|
61 | |||
62 | For more information, see the manual available in HTML and PDF in your |
|
62 | For more information, see the manual available in HTML and PDF in your | |
63 | installation, or online at http://ipython.org/documentation.html. |
|
63 | installation, or online at http://ipython.org/documentation.html. | |
64 | """ |
|
64 | """ | |
65 |
|
65 | |||
66 | interactive_usage = """ |
|
66 | interactive_usage = """ | |
67 | IPython -- An enhanced Interactive Python |
|
67 | IPython -- An enhanced Interactive Python | |
68 | ========================================= |
|
68 | ========================================= | |
69 |
|
69 | |||
70 | IPython offers a combination of convenient shell features, special commands |
|
70 | IPython offers fully compatible replacement for the standard Python | |
71 | and a history mechanism for both input (command history) and output (results |
|
71 | interpreter with convenient shell features, special commands, command | |
72 | caching, similar to Mathematica). It is intended to be a fully compatible |
|
72 | history mechanism and output results caching. | |
73 | replacement for the standard Python interpreter, while offering vastly |
|
|||
74 | improved functionality and flexibility. |
|
|||
75 |
|
73 | |||
76 | At your system command line, type 'ipython -h' to see the command line |
|
74 | At your system command line, type 'ipython -h' to see the command line | |
77 | options available. This document only describes interactive features. |
|
75 | options available. This document only describes interactive features. | |
78 |
|
76 | |||
79 | GETTING HELP |
|
77 | GETTING HELP | |
80 | ------------ |
|
78 | ------------ | |
81 |
|
79 | |||
82 | Within IPython you have various way to access help: |
|
80 | Within IPython you have various way to access help: | |
83 |
|
81 | |||
84 | ? -> Introduction and overview of IPython's features (this screen). |
|
82 | ? -> Introduction and overview of IPython's features (this screen). | |
85 | object? -> Details about 'object'. |
|
83 | object? -> Details about 'object'. | |
86 | object?? -> More detailed, verbose information about 'object'. |
|
84 | object?? -> More detailed, verbose information about 'object'. | |
87 | %quickref -> Quick reference of all IPython specific syntax and magics. |
|
85 | %quickref -> Quick reference of all IPython specific syntax and magics. | |
88 | help -> Access Python's own help system. |
|
86 | help -> Access Python's own help system. | |
89 |
|
87 | |||
90 | If you are in terminal IPython you can quit this screen by pressing `q`. |
|
88 | If you are in terminal IPython you can quit this screen by pressing `q`. | |
91 |
|
89 | |||
92 |
|
90 | |||
93 | MAIN FEATURES |
|
91 | MAIN FEATURES | |
94 | ------------- |
|
92 | ------------- | |
95 |
|
93 | |||
96 |
* Access to the standard Python help |
|
94 | * Access to the standard Python help with object docstrings and the Python | |
97 | available with access to object docstrings and the Python manuals. Simply |
|
95 | manuals. Simply type 'help' (no quotes) to invoke it. | |
98 | type 'help' (no quotes) to access it. |
|
|||
99 |
|
96 | |||
100 | * Magic commands: type %magic for information on the magic subsystem. |
|
97 | * Magic commands: type %magic for information on the magic subsystem. | |
101 |
|
98 | |||
102 | * System command aliases, via the %alias command or the configuration file(s). |
|
99 | * System command aliases, via the %alias command or the configuration file(s). | |
103 |
|
100 | |||
104 | * Dynamic object information: |
|
101 | * Dynamic object information: | |
105 |
|
102 | |||
106 |
Typing ?word or word? prints detailed information about an object. |
|
103 | Typing ?word or word? prints detailed information about an object. Long | |
107 | certain strings in the object are too long (docstrings, code, etc.) they get |
|
104 | strings (docstrings, code, etc.) get snipped in the center for brevity. | |
108 | snipped in the center for brevity. |
|
|||
109 |
|
105 | |||
110 | Typing ??word or word?? gives access to the full information without |
|
106 | Typing ??word or word?? gives access to the full information without | |
111 |
snipping long strings. |
|
107 | snipping long strings. Strings that are longer than the screen are printed | |
112 | pager if longer than the screen, printed otherwise. |
|
108 | through the less pager. | |
113 |
|
109 | |||
114 | The ?/?? system gives access to the full source code for any object (if |
|
110 | The ?/?? system gives access to the full source code for any object (if | |
115 | available), shows function prototypes and other useful information. |
|
111 | available), shows function prototypes and other useful information. | |
116 |
|
112 | |||
117 | If you just want to see an object's docstring, type '%pdoc object' (without |
|
113 | If you just want to see an object's docstring, type '%pdoc object' (without | |
118 | quotes, and without % if you have automagic on). |
|
114 | quotes, and without % if you have automagic on). | |
119 |
|
115 | |||
120 |
* |
|
116 | * Tab completion in the local namespace: | |
121 |
|
117 | |||
122 | At any time, hitting tab will complete any available python commands or |
|
118 | At any time, hitting tab will complete any available python commands or | |
123 | variable names, and show you a list of the possible completions if there's |
|
119 | variable names, and show you a list of the possible completions if there's | |
124 | no unambiguous one. It will also complete filenames in the current directory. |
|
120 | no unambiguous one. It will also complete filenames in the current directory. | |
125 |
|
121 | |||
126 |
* Search previous command history in |
|
122 | * Search previous command history in multiple ways: | |
127 |
|
123 | |||
128 |
- Start typing, and then use Ctrl-p (previous, up) and Ctrl-n (next,down) |
|
124 | - Start typing, and then use Ctrl-p (previous, up) and Ctrl-n (next, down) | |
129 |
search through |
|
125 | to search through the history items that match what you've typed so | |
130 | far. If you use Ctrl-p/Ctrl-n at a blank prompt, they just behave like |
|
126 | far. At a blank prompt, Ctrl-p/Ctrl-n behave like normal arrow keys. | |
131 | normal arrow keys. |
|
|||
132 |
|
127 | |||
133 | - Hit Ctrl-r: opens a search prompt. Begin typing and the system searches |
|
128 | - Hit Ctrl-r: opens a search prompt. Begin typing and the system searches | |
134 | your history for lines that match what you've typed so far, completing as |
|
129 | your history for lines that match what you've typed so far, completing as | |
135 | much as it can. |
|
130 | much as it can. | |
136 |
|
131 | |||
137 | - %hist: search history by index. |
|
132 | - %hist: search history by index. | |
138 |
|
133 | |||
139 | * Persistent command history across sessions. |
|
134 | * Persistent command history across sessions. | |
140 |
|
135 | |||
141 | * Logging of input with the ability to save and restore a working session. |
|
136 | * Logging of input with the ability to save and restore a working session. | |
142 |
|
137 | |||
143 |
* System |
|
138 | * System shell with !. Typing !ls will run 'ls' in the current directory. | |
144 |
|
139 | |||
145 | * The reload command does a 'deep' reload of a module: changes made to the |
|
140 | * The reload command does a 'deep' reload of a module: changes made to the | |
146 | module since you imported will actually be available without having to exit. |
|
141 | module since you imported will actually be available without having to exit. | |
147 |
|
142 | |||
148 | * Verbose and colored exception traceback printouts. See the magic xmode and |
|
143 | * Verbose and colored exception traceback printouts. See the magic xmode and | |
149 | xcolor functions for details (just type %magic). |
|
144 | xcolor functions for details (just type %magic). | |
150 |
|
145 | |||
151 | * Input caching system: |
|
146 | * Input caching system: | |
152 |
|
147 | |||
153 | IPython offers numbered prompts (In/Out) with input and output caching. All |
|
148 | IPython offers numbered prompts (In/Out) with input and output caching. All | |
154 | input is saved and can be retrieved as variables (besides the usual arrow |
|
149 | input is saved and can be retrieved as variables (besides the usual arrow | |
155 | key recall). |
|
150 | key recall). | |
156 |
|
151 | |||
157 | The following GLOBAL variables always exist (so don't overwrite them!): |
|
152 | The following GLOBAL variables always exist (so don't overwrite them!): | |
158 | _i: stores previous input. |
|
153 | _i: stores previous input. | |
159 | _ii: next previous. |
|
154 | _ii: next previous. | |
160 | _iii: next-next previous. |
|
155 | _iii: next-next previous. | |
161 | _ih : a list of all input _ih[n] is the input from line n. |
|
156 | _ih : a list of all input _ih[n] is the input from line n. | |
162 |
|
157 | |||
163 | Additionally, global variables named _i<n> are dynamically created (<n> |
|
158 | Additionally, global variables named _i<n> are dynamically created (<n> | |
164 | being the prompt counter), such that _i<n> == _ih[<n>] |
|
159 | being the prompt counter), such that _i<n> == _ih[<n>] | |
165 |
|
160 | |||
166 | For example, what you typed at prompt 14 is available as _i14 and _ih[14]. |
|
161 | For example, what you typed at prompt 14 is available as _i14 and _ih[14]. | |
167 |
|
162 | |||
168 | You can create macros which contain multiple input lines from this history, |
|
163 | You can create macros which contain multiple input lines from this history, | |
169 | for later re-execution, with the %macro function. |
|
164 | for later re-execution, with the %macro function. | |
170 |
|
165 | |||
171 | The history function %hist allows you to see any part of your input history |
|
166 | The history function %hist allows you to see any part of your input history | |
172 | by printing a range of the _i variables. Note that inputs which contain |
|
167 | by printing a range of the _i variables. Note that inputs which contain | |
173 | magic functions (%) appear in the history with a prepended comment. This is |
|
168 | magic functions (%) appear in the history with a prepended comment. This is | |
174 | because they aren't really valid Python code, so you can't exec them. |
|
169 | because they aren't really valid Python code, so you can't exec them. | |
175 |
|
170 | |||
176 | * Output caching system: |
|
171 | * Output caching system: | |
177 |
|
172 | |||
178 | For output that is returned from actions, a system similar to the input |
|
173 | For output that is returned from actions, a system similar to the input | |
179 | cache exists but using _ instead of _i. Only actions that produce a result |
|
174 | cache exists but using _ instead of _i. Only actions that produce a result | |
180 | (NOT assignments, for example) are cached. If you are familiar with |
|
175 | (NOT assignments, for example) are cached. If you are familiar with | |
181 | Mathematica, IPython's _ variables behave exactly like Mathematica's % |
|
176 | Mathematica, IPython's _ variables behave exactly like Mathematica's % | |
182 | variables. |
|
177 | variables. | |
183 |
|
178 | |||
184 | The following GLOBAL variables always exist (so don't overwrite them!): |
|
179 | The following GLOBAL variables always exist (so don't overwrite them!): | |
185 | _ (one underscore): previous output. |
|
180 | _ (one underscore): previous output. | |
186 | __ (two underscores): next previous. |
|
181 | __ (two underscores): next previous. | |
187 | ___ (three underscores): next-next previous. |
|
182 | ___ (three underscores): next-next previous. | |
188 |
|
183 | |||
189 | Global variables named _<n> are dynamically created (<n> being the prompt |
|
184 | Global variables named _<n> are dynamically created (<n> being the prompt | |
190 | counter), such that the result of output <n> is always available as _<n>. |
|
185 | counter), such that the result of output <n> is always available as _<n>. | |
191 |
|
186 | |||
192 | Finally, a global dictionary named _oh exists with entries for all lines |
|
187 | Finally, a global dictionary named _oh exists with entries for all lines | |
193 | which generated output. |
|
188 | which generated output. | |
194 |
|
189 | |||
195 | * Directory history: |
|
190 | * Directory history: | |
196 |
|
191 | |||
197 | Your history of visited directories is kept in the global list _dh, and the |
|
192 | Your history of visited directories is kept in the global list _dh, and the | |
198 | magic %cd command can be used to go to any entry in that list. |
|
193 | magic %cd command can be used to go to any entry in that list. | |
199 |
|
194 | |||
200 | * Auto-parentheses and auto-quotes (adapted from Nathan Gray's LazyPython) |
|
195 | * Auto-parentheses and auto-quotes (adapted from Nathan Gray's LazyPython) | |
201 |
|
196 | |||
202 | 1. Auto-parentheses |
|
197 | 1. Auto-parentheses | |
203 |
|
198 | |||
204 | Callable objects (i.e. functions, methods, etc) can be invoked like |
|
199 | Callable objects (i.e. functions, methods, etc) can be invoked like | |
205 | this (notice the commas between the arguments):: |
|
200 | this (notice the commas between the arguments):: | |
206 |
|
201 | |||
207 | In [1]: callable_ob arg1, arg2, arg3 |
|
202 | In [1]: callable_ob arg1, arg2, arg3 | |
208 |
|
203 | |||
209 | and the input will be translated to this:: |
|
204 | and the input will be translated to this:: | |
210 |
|
205 | |||
211 | callable_ob(arg1, arg2, arg3) |
|
206 | callable_ob(arg1, arg2, arg3) | |
212 |
|
207 | |||
213 | This feature is off by default (in rare cases it can produce |
|
208 | This feature is off by default (in rare cases it can produce | |
214 | undesirable side-effects), but you can activate it at the command-line |
|
209 | undesirable side-effects), but you can activate it at the command-line | |
215 | by starting IPython with `--autocall 1`, set it permanently in your |
|
210 | by starting IPython with `--autocall 1`, set it permanently in your | |
216 | configuration file, or turn on at runtime with `%autocall 1`. |
|
211 | configuration file, or turn on at runtime with `%autocall 1`. | |
217 |
|
212 | |||
218 | You can force auto-parentheses by using '/' as the first character |
|
213 | You can force auto-parentheses by using '/' as the first character | |
219 | of a line. For example:: |
|
214 | of a line. For example:: | |
220 |
|
215 | |||
221 | In [1]: /globals # becomes 'globals()' |
|
216 | In [1]: /globals # becomes 'globals()' | |
222 |
|
217 | |||
223 | Note that the '/' MUST be the first character on the line! This |
|
218 | Note that the '/' MUST be the first character on the line! This | |
224 | won't work:: |
|
219 | won't work:: | |
225 |
|
220 | |||
226 | In [2]: print /globals # syntax error |
|
221 | In [2]: print /globals # syntax error | |
227 |
|
222 | |||
228 | In most cases the automatic algorithm should work, so you should |
|
223 | In most cases the automatic algorithm should work, so you should | |
229 | rarely need to explicitly invoke /. One notable exception is if you |
|
224 | rarely need to explicitly invoke /. One notable exception is if you | |
230 | are trying to call a function with a list of tuples as arguments (the |
|
225 | are trying to call a function with a list of tuples as arguments (the | |
231 | parenthesis will confuse IPython):: |
|
226 | parenthesis will confuse IPython):: | |
232 |
|
227 | |||
233 | In [1]: zip (1,2,3),(4,5,6) # won't work |
|
228 | In [1]: zip (1,2,3),(4,5,6) # won't work | |
234 |
|
229 | |||
235 | but this will work:: |
|
230 | but this will work:: | |
236 |
|
231 | |||
237 | In [2]: /zip (1,2,3),(4,5,6) |
|
232 | In [2]: /zip (1,2,3),(4,5,6) | |
238 | ------> zip ((1,2,3),(4,5,6)) |
|
233 | ------> zip ((1,2,3),(4,5,6)) | |
239 | Out[2]= [(1, 4), (2, 5), (3, 6)] |
|
234 | Out[2]= [(1, 4), (2, 5), (3, 6)] | |
240 |
|
235 | |||
241 | IPython tells you that it has altered your command line by |
|
236 | IPython tells you that it has altered your command line by | |
242 | displaying the new command line preceded by -->. e.g.:: |
|
237 | displaying the new command line preceded by -->. e.g.:: | |
243 |
|
238 | |||
244 | In [18]: callable list |
|
239 | In [18]: callable list | |
245 | -------> callable (list) |
|
240 | -------> callable (list) | |
246 |
|
241 | |||
247 | 2. Auto-Quoting |
|
242 | 2. Auto-Quoting | |
248 |
|
243 | |||
249 | You can force auto-quoting of a function's arguments by using ',' as |
|
244 | You can force auto-quoting of a function's arguments by using ',' as | |
250 | the first character of a line. For example:: |
|
245 | the first character of a line. For example:: | |
251 |
|
246 | |||
252 | In [1]: ,my_function /home/me # becomes my_function("/home/me") |
|
247 | In [1]: ,my_function /home/me # becomes my_function("/home/me") | |
253 |
|
248 | |||
254 | If you use ';' instead, the whole argument is quoted as a single |
|
249 | If you use ';' instead, the whole argument is quoted as a single | |
255 | string (while ',' splits on whitespace):: |
|
250 | string (while ',' splits on whitespace):: | |
256 |
|
251 | |||
257 | In [2]: ,my_function a b c # becomes my_function("a","b","c") |
|
252 | In [2]: ,my_function a b c # becomes my_function("a","b","c") | |
258 | In [3]: ;my_function a b c # becomes my_function("a b c") |
|
253 | In [3]: ;my_function a b c # becomes my_function("a b c") | |
259 |
|
254 | |||
260 | Note that the ',' MUST be the first character on the line! This |
|
255 | Note that the ',' MUST be the first character on the line! This | |
261 | won't work:: |
|
256 | won't work:: | |
262 |
|
257 | |||
263 | In [4]: x = ,my_function /home/me # syntax error |
|
258 | In [4]: x = ,my_function /home/me # syntax error | |
264 | """ |
|
259 | """ | |
265 |
|
260 | |||
266 | interactive_usage_min = """\ |
|
261 | interactive_usage_min = """\ | |
267 | An enhanced console for Python. |
|
262 | An enhanced console for Python. | |
268 | Some of its features are: |
|
263 | Some of its features are: | |
269 | - Tab completion in the local namespace. |
|
264 | - Tab completion in the local namespace. | |
270 | - Logging of input, see command-line options. |
|
265 | - Logging of input, see command-line options. | |
271 | - System shell escape via ! , eg !ls. |
|
266 | - System shell escape via ! , eg !ls. | |
272 | - Magic commands, starting with a % (like %ls, %pwd, %cd, etc.) |
|
267 | - Magic commands, starting with a % (like %ls, %pwd, %cd, etc.) | |
273 | - Keeps track of locally defined variables via %who, %whos. |
|
268 | - Keeps track of locally defined variables via %who, %whos. | |
274 | - Show object information with a ? eg ?x or x? (use ?? for more info). |
|
269 | - Show object information with a ? eg ?x or x? (use ?? for more info). | |
275 | """ |
|
270 | """ | |
276 |
|
271 | |||
277 | quick_reference = r""" |
|
272 | quick_reference = r""" | |
278 | IPython -- An enhanced Interactive Python - Quick Reference Card |
|
273 | IPython -- An enhanced Interactive Python - Quick Reference Card | |
279 | ================================================================ |
|
274 | ================================================================ | |
280 |
|
275 | |||
281 | obj?, obj?? : Get help, or more help for object (also works as |
|
276 | obj?, obj?? : Get help, or more help for object (also works as | |
282 | ?obj, ??obj). |
|
277 | ?obj, ??obj). | |
283 | ?foo.*abc* : List names in 'foo' containing 'abc' in them. |
|
278 | ?foo.*abc* : List names in 'foo' containing 'abc' in them. | |
284 | %magic : Information about IPython's 'magic' % functions. |
|
279 | %magic : Information about IPython's 'magic' % functions. | |
285 |
|
280 | |||
286 | Magic functions are prefixed by % or %%, and typically take their arguments |
|
281 | Magic functions are prefixed by % or %%, and typically take their arguments | |
287 | without parentheses, quotes or even commas for convenience. Line magics take a |
|
282 | without parentheses, quotes or even commas for convenience. Line magics take a | |
288 | single % and cell magics are prefixed with two %%. |
|
283 | single % and cell magics are prefixed with two %%. | |
289 |
|
284 | |||
290 | Example magic function calls: |
|
285 | Example magic function calls: | |
291 |
|
286 | |||
292 | %alias d ls -F : 'd' is now an alias for 'ls -F' |
|
287 | %alias d ls -F : 'd' is now an alias for 'ls -F' | |
293 | alias d ls -F : Works if 'alias' not a python name |
|
288 | alias d ls -F : Works if 'alias' not a python name | |
294 | alist = %alias : Get list of aliases to 'alist' |
|
289 | alist = %alias : Get list of aliases to 'alist' | |
295 | cd /usr/share : Obvious. cd -<tab> to choose from visited dirs. |
|
290 | cd /usr/share : Obvious. cd -<tab> to choose from visited dirs. | |
296 | %cd?? : See help AND source for magic %cd |
|
291 | %cd?? : See help AND source for magic %cd | |
297 | %timeit x=10 : time the 'x=10' statement with high precision. |
|
292 | %timeit x=10 : time the 'x=10' statement with high precision. | |
298 | %%timeit x=2**100 |
|
293 | %%timeit x=2**100 | |
299 | x**100 : time 'x**100' with a setup of 'x=2**100'; setup code is not |
|
294 | x**100 : time 'x**100' with a setup of 'x=2**100'; setup code is not | |
300 | counted. This is an example of a cell magic. |
|
295 | counted. This is an example of a cell magic. | |
301 |
|
296 | |||
302 | System commands: |
|
297 | System commands: | |
303 |
|
298 | |||
304 | !cp a.txt b/ : System command escape, calls os.system() |
|
299 | !cp a.txt b/ : System command escape, calls os.system() | |
305 | cp a.txt b/ : after %rehashx, most system commands work without ! |
|
300 | cp a.txt b/ : after %rehashx, most system commands work without ! | |
306 | cp ${f}.txt $bar : Variable expansion in magics and system commands |
|
301 | cp ${f}.txt $bar : Variable expansion in magics and system commands | |
307 | files = !ls /usr : Capture sytem command output |
|
302 | files = !ls /usr : Capture sytem command output | |
308 | files.s, files.l, files.n: "a b c", ['a','b','c'], 'a\nb\nc' |
|
303 | files.s, files.l, files.n: "a b c", ['a','b','c'], 'a\nb\nc' | |
309 |
|
304 | |||
310 | History: |
|
305 | History: | |
311 |
|
306 | |||
312 | _i, _ii, _iii : Previous, next previous, next next previous input |
|
307 | _i, _ii, _iii : Previous, next previous, next next previous input | |
313 | _i4, _ih[2:5] : Input history line 4, lines 2-4 |
|
308 | _i4, _ih[2:5] : Input history line 4, lines 2-4 | |
314 | exec _i81 : Execute input history line #81 again |
|
309 | exec _i81 : Execute input history line #81 again | |
315 | %rep 81 : Edit input history line #81 |
|
310 | %rep 81 : Edit input history line #81 | |
316 | _, __, ___ : previous, next previous, next next previous output |
|
311 | _, __, ___ : previous, next previous, next next previous output | |
317 | _dh : Directory history |
|
312 | _dh : Directory history | |
318 | _oh : Output history |
|
313 | _oh : Output history | |
319 | %hist : Command history of current session. |
|
314 | %hist : Command history of current session. | |
320 | %hist -g foo : Search command history of (almost) all sessions for 'foo'. |
|
315 | %hist -g foo : Search command history of (almost) all sessions for 'foo'. | |
321 | %hist -g : Command history of (almost) all sessions. |
|
316 | %hist -g : Command history of (almost) all sessions. | |
322 | %hist 1/2-8 : Command history containing lines 2-8 of session 1. |
|
317 | %hist 1/2-8 : Command history containing lines 2-8 of session 1. | |
323 | %hist 1/ ~2/ : Command history of session 1 and 2 sessions before current. |
|
318 | %hist 1/ ~2/ : Command history of session 1 and 2 sessions before current. | |
324 | %hist ~8/1-~6/5 : Command history from line 1 of 8 sessions ago to |
|
319 | %hist ~8/1-~6/5 : Command history from line 1 of 8 sessions ago to | |
325 | line 5 of 6 sessions ago. |
|
320 | line 5 of 6 sessions ago. | |
326 | %edit 0/ : Open editor to execute code with history of current session. |
|
321 | %edit 0/ : Open editor to execute code with history of current session. | |
327 |
|
322 | |||
328 | Autocall: |
|
323 | Autocall: | |
329 |
|
324 | |||
330 | f 1,2 : f(1,2) # Off by default, enable with %autocall magic. |
|
325 | f 1,2 : f(1,2) # Off by default, enable with %autocall magic. | |
331 | /f 1,2 : f(1,2) (forced autoparen) |
|
326 | /f 1,2 : f(1,2) (forced autoparen) | |
332 | ,f 1 2 : f("1","2") |
|
327 | ,f 1 2 : f("1","2") | |
333 | ;f 1 2 : f("1 2") |
|
328 | ;f 1 2 : f("1 2") | |
334 |
|
329 | |||
335 | Remember: TAB completion works in many contexts, not just file names |
|
330 | Remember: TAB completion works in many contexts, not just file names | |
336 | or python names. |
|
331 | or python names. | |
337 |
|
332 | |||
338 | The following magic functions are currently available: |
|
333 | The following magic functions are currently available: | |
339 |
|
334 | |||
340 | """ |
|
335 | """ | |
341 |
|
336 | |||
342 | default_banner_parts = ["Python %s\n"%sys.version.split("\n")[0], |
|
337 | default_banner_parts = ["Python %s\n"%sys.version.split("\n")[0], | |
343 | "Type 'copyright', 'credits' or 'license' for more information\n" , |
|
338 | "Type 'copyright', 'credits' or 'license' for more information\n" , | |
344 | "IPython {version} -- An enhanced Interactive Python. Type '?' for help.\n".format(version=release.version), |
|
339 | "IPython {version} -- An enhanced Interactive Python. Type '?' for help.\n".format(version=release.version), | |
345 | ] |
|
340 | ] | |
346 |
|
341 | |||
347 | default_banner = ''.join(default_banner_parts) |
|
342 | default_banner = ''.join(default_banner_parts) | |
348 |
|
343 | |||
349 | # deprecated GUI banner |
|
344 | # deprecated GUI banner | |
350 |
|
345 | |||
351 | default_gui_banner = '\n'.join([ |
|
346 | default_gui_banner = '\n'.join([ | |
352 | 'DEPRECATED: IPython.core.usage.default_gui_banner is deprecated and will be removed', |
|
347 | 'DEPRECATED: IPython.core.usage.default_gui_banner is deprecated and will be removed', | |
353 | default_banner, |
|
348 | default_banner, | |
354 | ]) |
|
349 | ]) |
General Comments 0
You need to be logged in to leave comments.
Login now