##// END OF EJS Templates
Updated Windows HOME folder...
Adal Chiriliuc -
Show More
@@ -1,565 +1,565 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:\\Documents and Settings\\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 a combination of convenient shell features, special commands
71 and a history mechanism for both input (command history) and output (results
71 and a history mechanism for both input (command history) and output (results
72 caching, similar to Mathematica). It is intended to be a fully compatible
72 caching, similar to Mathematica). It is intended to be a fully compatible
73 replacement for the standard Python interpreter, while offering vastly
73 replacement for the standard Python interpreter, while offering vastly
74 improved functionality and flexibility.
74 improved functionality and flexibility.
75
75
76 At your system command line, type 'ipython -h' to see the command line
76 At your system command line, type 'ipython -h' to see the command line
77 options available. This document only describes interactive features.
77 options available. This document only describes interactive features.
78
78
79 MAIN FEATURES
79 MAIN FEATURES
80 -------------
80 -------------
81
81
82 * Access to the standard Python help. As of Python 2.1, a help system is
82 * Access to the standard Python help. As of Python 2.1, a help system is
83 available with access to object docstrings and the Python manuals. Simply
83 available with access to object docstrings and the Python manuals. Simply
84 type 'help' (no quotes) to access it.
84 type 'help' (no quotes) to access it.
85
85
86 * Magic commands: type %magic for information on the magic subsystem.
86 * Magic commands: type %magic for information on the magic subsystem.
87
87
88 * System command aliases, via the %alias command or the configuration file(s).
88 * System command aliases, via the %alias command or the configuration file(s).
89
89
90 * Dynamic object information:
90 * Dynamic object information:
91
91
92 Typing ?word or word? prints detailed information about an object. If
92 Typing ?word or word? prints detailed information about an object. If
93 certain strings in the object are too long (docstrings, code, etc.) they get
93 certain strings in the object are too long (docstrings, code, etc.) they get
94 snipped in the center for brevity.
94 snipped in the center for brevity.
95
95
96 Typing ??word or word?? gives access to the full information without
96 Typing ??word or word?? gives access to the full information without
97 snipping long strings. Long strings are sent to the screen through the less
97 snipping long strings. Long strings are sent to the screen through the less
98 pager if longer than the screen, printed otherwise.
98 pager if longer than the screen, printed otherwise.
99
99
100 The ?/?? system gives access to the full source code for any object (if
100 The ?/?? system gives access to the full source code for any object (if
101 available), shows function prototypes and other useful information.
101 available), shows function prototypes and other useful information.
102
102
103 If you just want to see an object's docstring, type '%pdoc object' (without
103 If you just want to see an object's docstring, type '%pdoc object' (without
104 quotes, and without % if you have automagic on).
104 quotes, and without % if you have automagic on).
105
105
106 * Completion in the local namespace, by typing TAB at the prompt.
106 * Completion in the local namespace, by typing TAB at the prompt.
107
107
108 At any time, hitting tab will complete any available python commands or
108 At any time, hitting tab will complete any available python commands or
109 variable names, and show you a list of the possible completions if there's
109 variable names, and show you a list of the possible completions if there's
110 no unambiguous one. It will also complete filenames in the current directory.
110 no unambiguous one. It will also complete filenames in the current directory.
111
111
112 This feature requires the readline and rlcomplete modules, so it won't work
112 This feature requires the readline and rlcomplete modules, so it won't work
113 if your Python lacks readline support (such as under Windows).
113 if your Python lacks readline support (such as under Windows).
114
114
115 * Search previous command history in two ways (also requires readline):
115 * Search previous command history in two ways (also requires readline):
116
116
117 - Start typing, and then use Ctrl-p (previous,up) and Ctrl-n (next,down) to
117 - Start typing, and then use Ctrl-p (previous,up) and Ctrl-n (next,down) to
118 search through only the history items that match what you've typed so
118 search through only the history items that match what you've typed so
119 far. If you use Ctrl-p/Ctrl-n at a blank prompt, they just behave like
119 far. If you use Ctrl-p/Ctrl-n at a blank prompt, they just behave like
120 normal arrow keys.
120 normal arrow keys.
121
121
122 - Hit Ctrl-r: opens a search prompt. Begin typing and the system searches
122 - Hit Ctrl-r: opens a search prompt. Begin typing and the system searches
123 your history for lines that match what you've typed so far, completing as
123 your history for lines that match what you've typed so far, completing as
124 much as it can.
124 much as it can.
125
125
126 - %hist: search history by index (this does *not* require readline).
126 - %hist: search history by index (this does *not* require readline).
127
127
128 * Persistent command history across sessions.
128 * Persistent command history across sessions.
129
129
130 * Logging of input with the ability to save and restore a working session.
130 * Logging of input with the ability to save and restore a working session.
131
131
132 * System escape with !. Typing !ls will run 'ls' in the current directory.
132 * System escape with !. Typing !ls will run 'ls' in the current directory.
133
133
134 * The reload command does a 'deep' reload of a module: changes made to the
134 * The reload command does a 'deep' reload of a module: changes made to the
135 module since you imported will actually be available without having to exit.
135 module since you imported will actually be available without having to exit.
136
136
137 * Verbose and colored exception traceback printouts. See the magic xmode and
137 * Verbose and colored exception traceback printouts. See the magic xmode and
138 xcolor functions for details (just type %magic).
138 xcolor functions for details (just type %magic).
139
139
140 * Input caching system:
140 * Input caching system:
141
141
142 IPython offers numbered prompts (In/Out) with input and output caching. All
142 IPython offers numbered prompts (In/Out) with input and output caching. All
143 input is saved and can be retrieved as variables (besides the usual arrow
143 input is saved and can be retrieved as variables (besides the usual arrow
144 key recall).
144 key recall).
145
145
146 The following GLOBAL variables always exist (so don't overwrite them!):
146 The following GLOBAL variables always exist (so don't overwrite them!):
147 _i: stores previous input.
147 _i: stores previous input.
148 _ii: next previous.
148 _ii: next previous.
149 _iii: next-next previous.
149 _iii: next-next previous.
150 _ih : a list of all input _ih[n] is the input from line n.
150 _ih : a list of all input _ih[n] is the input from line n.
151
151
152 Additionally, global variables named _i<n> are dynamically created (<n>
152 Additionally, global variables named _i<n> are dynamically created (<n>
153 being the prompt counter), such that _i<n> == _ih[<n>]
153 being the prompt counter), such that _i<n> == _ih[<n>]
154
154
155 For example, what you typed at prompt 14 is available as _i14 and _ih[14].
155 For example, what you typed at prompt 14 is available as _i14 and _ih[14].
156
156
157 You can create macros which contain multiple input lines from this history,
157 You can create macros which contain multiple input lines from this history,
158 for later re-execution, with the %macro function.
158 for later re-execution, with the %macro function.
159
159
160 The history function %hist allows you to see any part of your input history
160 The history function %hist allows you to see any part of your input history
161 by printing a range of the _i variables. Note that inputs which contain
161 by printing a range of the _i variables. Note that inputs which contain
162 magic functions (%) appear in the history with a prepended comment. This is
162 magic functions (%) appear in the history with a prepended comment. This is
163 because they aren't really valid Python code, so you can't exec them.
163 because they aren't really valid Python code, so you can't exec them.
164
164
165 * Output caching system:
165 * Output caching system:
166
166
167 For output that is returned from actions, a system similar to the input
167 For output that is returned from actions, a system similar to the input
168 cache exists but using _ instead of _i. Only actions that produce a result
168 cache exists but using _ instead of _i. Only actions that produce a result
169 (NOT assignments, for example) are cached. If you are familiar with
169 (NOT assignments, for example) are cached. If you are familiar with
170 Mathematica, IPython's _ variables behave exactly like Mathematica's %
170 Mathematica, IPython's _ variables behave exactly like Mathematica's %
171 variables.
171 variables.
172
172
173 The following GLOBAL variables always exist (so don't overwrite them!):
173 The following GLOBAL variables always exist (so don't overwrite them!):
174 _ (one underscore): previous output.
174 _ (one underscore): previous output.
175 __ (two underscores): next previous.
175 __ (two underscores): next previous.
176 ___ (three underscores): next-next previous.
176 ___ (three underscores): next-next previous.
177
177
178 Global variables named _<n> are dynamically created (<n> being the prompt
178 Global variables named _<n> are dynamically created (<n> being the prompt
179 counter), such that the result of output <n> is always available as _<n>.
179 counter), such that the result of output <n> is always available as _<n>.
180
180
181 Finally, a global dictionary named _oh exists with entries for all lines
181 Finally, a global dictionary named _oh exists with entries for all lines
182 which generated output.
182 which generated output.
183
183
184 * Directory history:
184 * Directory history:
185
185
186 Your history of visited directories is kept in the global list _dh, and the
186 Your history of visited directories is kept in the global list _dh, and the
187 magic %cd command can be used to go to any entry in that list.
187 magic %cd command can be used to go to any entry in that list.
188
188
189 * Auto-parentheses and auto-quotes (adapted from Nathan Gray's LazyPython)
189 * Auto-parentheses and auto-quotes (adapted from Nathan Gray's LazyPython)
190
190
191 1. Auto-parentheses
191 1. Auto-parentheses
192
192
193 Callable objects (i.e. functions, methods, etc) can be invoked like
193 Callable objects (i.e. functions, methods, etc) can be invoked like
194 this (notice the commas between the arguments)::
194 this (notice the commas between the arguments)::
195
195
196 In [1]: callable_ob arg1, arg2, arg3
196 In [1]: callable_ob arg1, arg2, arg3
197
197
198 and the input will be translated to this::
198 and the input will be translated to this::
199
199
200 callable_ob(arg1, arg2, arg3)
200 callable_ob(arg1, arg2, arg3)
201
201
202 This feature is off by default (in rare cases it can produce
202 This feature is off by default (in rare cases it can produce
203 undesirable side-effects), but you can activate it at the command-line
203 undesirable side-effects), but you can activate it at the command-line
204 by starting IPython with `--autocall 1`, set it permanently in your
204 by starting IPython with `--autocall 1`, set it permanently in your
205 configuration file, or turn on at runtime with `%autocall 1`.
205 configuration file, or turn on at runtime with `%autocall 1`.
206
206
207 You can force auto-parentheses by using '/' as the first character
207 You can force auto-parentheses by using '/' as the first character
208 of a line. For example::
208 of a line. For example::
209
209
210 In [1]: /globals # becomes 'globals()'
210 In [1]: /globals # becomes 'globals()'
211
211
212 Note that the '/' MUST be the first character on the line! This
212 Note that the '/' MUST be the first character on the line! This
213 won't work::
213 won't work::
214
214
215 In [2]: print /globals # syntax error
215 In [2]: print /globals # syntax error
216
216
217 In most cases the automatic algorithm should work, so you should
217 In most cases the automatic algorithm should work, so you should
218 rarely need to explicitly invoke /. One notable exception is if you
218 rarely need to explicitly invoke /. One notable exception is if you
219 are trying to call a function with a list of tuples as arguments (the
219 are trying to call a function with a list of tuples as arguments (the
220 parenthesis will confuse IPython)::
220 parenthesis will confuse IPython)::
221
221
222 In [1]: zip (1,2,3),(4,5,6) # won't work
222 In [1]: zip (1,2,3),(4,5,6) # won't work
223
223
224 but this will work::
224 but this will work::
225
225
226 In [2]: /zip (1,2,3),(4,5,6)
226 In [2]: /zip (1,2,3),(4,5,6)
227 ------> zip ((1,2,3),(4,5,6))
227 ------> zip ((1,2,3),(4,5,6))
228 Out[2]= [(1, 4), (2, 5), (3, 6)]
228 Out[2]= [(1, 4), (2, 5), (3, 6)]
229
229
230 IPython tells you that it has altered your command line by
230 IPython tells you that it has altered your command line by
231 displaying the new command line preceded by -->. e.g.::
231 displaying the new command line preceded by -->. e.g.::
232
232
233 In [18]: callable list
233 In [18]: callable list
234 -------> callable (list)
234 -------> callable (list)
235
235
236 2. Auto-Quoting
236 2. Auto-Quoting
237
237
238 You can force auto-quoting of a function's arguments by using ',' as
238 You can force auto-quoting of a function's arguments by using ',' as
239 the first character of a line. For example::
239 the first character of a line. For example::
240
240
241 In [1]: ,my_function /home/me # becomes my_function("/home/me")
241 In [1]: ,my_function /home/me # becomes my_function("/home/me")
242
242
243 If you use ';' instead, the whole argument is quoted as a single
243 If you use ';' instead, the whole argument is quoted as a single
244 string (while ',' splits on whitespace)::
244 string (while ',' splits on whitespace)::
245
245
246 In [2]: ,my_function a b c # becomes my_function("a","b","c")
246 In [2]: ,my_function a b c # becomes my_function("a","b","c")
247 In [3]: ;my_function a b c # becomes my_function("a b c")
247 In [3]: ;my_function a b c # becomes my_function("a b c")
248
248
249 Note that the ',' MUST be the first character on the line! This
249 Note that the ',' MUST be the first character on the line! This
250 won't work::
250 won't work::
251
251
252 In [4]: x = ,my_function /home/me # syntax error
252 In [4]: x = ,my_function /home/me # syntax error
253 """
253 """
254
254
255 interactive_usage_min = """\
255 interactive_usage_min = """\
256 An enhanced console for Python.
256 An enhanced console for Python.
257 Some of its features are:
257 Some of its features are:
258 - Readline support if the readline library is present.
258 - Readline support if the readline library is present.
259 - Tab completion in the local namespace.
259 - Tab completion in the local namespace.
260 - Logging of input, see command-line options.
260 - Logging of input, see command-line options.
261 - System shell escape via ! , eg !ls.
261 - System shell escape via ! , eg !ls.
262 - Magic commands, starting with a % (like %ls, %pwd, %cd, etc.)
262 - Magic commands, starting with a % (like %ls, %pwd, %cd, etc.)
263 - Keeps track of locally defined variables via %who, %whos.
263 - Keeps track of locally defined variables via %who, %whos.
264 - Show object information with a ? eg ?x or x? (use ?? for more info).
264 - Show object information with a ? eg ?x or x? (use ?? for more info).
265 """
265 """
266
266
267 quick_reference = r"""
267 quick_reference = r"""
268 IPython -- An enhanced Interactive Python - Quick Reference Card
268 IPython -- An enhanced Interactive Python - Quick Reference Card
269 ================================================================
269 ================================================================
270
270
271 obj?, obj?? : Get help, or more help for object (also works as
271 obj?, obj?? : Get help, or more help for object (also works as
272 ?obj, ??obj).
272 ?obj, ??obj).
273 ?foo.*abc* : List names in 'foo' containing 'abc' in them.
273 ?foo.*abc* : List names in 'foo' containing 'abc' in them.
274 %magic : Information about IPython's 'magic' % functions.
274 %magic : Information about IPython's 'magic' % functions.
275
275
276 Magic functions are prefixed by % or %%, and typically take their arguments
276 Magic functions are prefixed by % or %%, and typically take their arguments
277 without parentheses, quotes or even commas for convenience. Line magics take a
277 without parentheses, quotes or even commas for convenience. Line magics take a
278 single % and cell magics are prefixed with two %%.
278 single % and cell magics are prefixed with two %%.
279
279
280 Example magic function calls:
280 Example magic function calls:
281
281
282 %alias d ls -F : 'd' is now an alias for 'ls -F'
282 %alias d ls -F : 'd' is now an alias for 'ls -F'
283 alias d ls -F : Works if 'alias' not a python name
283 alias d ls -F : Works if 'alias' not a python name
284 alist = %alias : Get list of aliases to 'alist'
284 alist = %alias : Get list of aliases to 'alist'
285 cd /usr/share : Obvious. cd -<tab> to choose from visited dirs.
285 cd /usr/share : Obvious. cd -<tab> to choose from visited dirs.
286 %cd?? : See help AND source for magic %cd
286 %cd?? : See help AND source for magic %cd
287 %timeit x=10 : time the 'x=10' statement with high precision.
287 %timeit x=10 : time the 'x=10' statement with high precision.
288 %%timeit x=2**100
288 %%timeit x=2**100
289 x**100 : time 'x**100' with a setup of 'x=2**100'; setup code is not
289 x**100 : time 'x**100' with a setup of 'x=2**100'; setup code is not
290 counted. This is an example of a cell magic.
290 counted. This is an example of a cell magic.
291
291
292 System commands:
292 System commands:
293
293
294 !cp a.txt b/ : System command escape, calls os.system()
294 !cp a.txt b/ : System command escape, calls os.system()
295 cp a.txt b/ : after %rehashx, most system commands work without !
295 cp a.txt b/ : after %rehashx, most system commands work without !
296 cp ${f}.txt $bar : Variable expansion in magics and system commands
296 cp ${f}.txt $bar : Variable expansion in magics and system commands
297 files = !ls /usr : Capture sytem command output
297 files = !ls /usr : Capture sytem command output
298 files.s, files.l, files.n: "a b c", ['a','b','c'], 'a\nb\nc'
298 files.s, files.l, files.n: "a b c", ['a','b','c'], 'a\nb\nc'
299
299
300 History:
300 History:
301
301
302 _i, _ii, _iii : Previous, next previous, next next previous input
302 _i, _ii, _iii : Previous, next previous, next next previous input
303 _i4, _ih[2:5] : Input history line 4, lines 2-4
303 _i4, _ih[2:5] : Input history line 4, lines 2-4
304 exec _i81 : Execute input history line #81 again
304 exec _i81 : Execute input history line #81 again
305 %rep 81 : Edit input history line #81
305 %rep 81 : Edit input history line #81
306 _, __, ___ : previous, next previous, next next previous output
306 _, __, ___ : previous, next previous, next next previous output
307 _dh : Directory history
307 _dh : Directory history
308 _oh : Output history
308 _oh : Output history
309 %hist : Command history. '%hist -g foo' search history for 'foo'
309 %hist : Command history. '%hist -g foo' search history for 'foo'
310
310
311 Autocall:
311 Autocall:
312
312
313 f 1,2 : f(1,2) # Off by default, enable with %autocall magic.
313 f 1,2 : f(1,2) # Off by default, enable with %autocall magic.
314 /f 1,2 : f(1,2) (forced autoparen)
314 /f 1,2 : f(1,2) (forced autoparen)
315 ,f 1 2 : f("1","2")
315 ,f 1 2 : f("1","2")
316 ;f 1 2 : f("1 2")
316 ;f 1 2 : f("1 2")
317
317
318 Remember: TAB completion works in many contexts, not just file names
318 Remember: TAB completion works in many contexts, not just file names
319 or python names.
319 or python names.
320
320
321 The following magic functions are currently available:
321 The following magic functions are currently available:
322
322
323 """
323 """
324
324
325 gui_reference = """\
325 gui_reference = """\
326 ===============================
326 ===============================
327 The graphical IPython console
327 The graphical IPython console
328 ===============================
328 ===============================
329
329
330 This console is designed to emulate the look, feel and workflow of a terminal
330 This console is designed to emulate the look, feel and workflow of a terminal
331 environment, while adding a number of enhancements that are simply not possible
331 environment, while adding a number of enhancements that are simply not possible
332 in a real terminal, such as inline syntax highlighting, true multiline editing,
332 in a real terminal, such as inline syntax highlighting, true multiline editing,
333 inline graphics and much more.
333 inline graphics and much more.
334
334
335 This quick reference document contains the basic information you'll need to
335 This quick reference document contains the basic information you'll need to
336 know to make the most efficient use of it. For the various command line
336 know to make the most efficient use of it. For the various command line
337 options available at startup, type ``ipython qtconsole --help`` at the command line.
337 options available at startup, type ``ipython qtconsole --help`` at the command line.
338
338
339
339
340 Multiline editing
340 Multiline editing
341 =================
341 =================
342
342
343 The graphical console is capable of true multiline editing, but it also tries
343 The graphical console is capable of true multiline editing, but it also tries
344 to behave intuitively like a terminal when possible. If you are used to
344 to behave intuitively like a terminal when possible. If you are used to
345 IPython's old terminal behavior, you should find the transition painless, and
345 IPython's old terminal behavior, you should find the transition painless, and
346 once you learn a few basic keybindings it will be a much more efficient
346 once you learn a few basic keybindings it will be a much more efficient
347 environment.
347 environment.
348
348
349 For single expressions or indented blocks, the console behaves almost like the
349 For single expressions or indented blocks, the console behaves almost like the
350 terminal IPython: single expressions are immediately evaluated, and indented
350 terminal IPython: single expressions are immediately evaluated, and indented
351 blocks are evaluated once a single blank line is entered::
351 blocks are evaluated once a single blank line is entered::
352
352
353 In [1]: print "Hello IPython!" # Enter was pressed at the end of the line
353 In [1]: print "Hello IPython!" # Enter was pressed at the end of the line
354 Hello IPython!
354 Hello IPython!
355
355
356 In [2]: for i in range(10):
356 In [2]: for i in range(10):
357 ...: print i,
357 ...: print i,
358 ...:
358 ...:
359 0 1 2 3 4 5 6 7 8 9
359 0 1 2 3 4 5 6 7 8 9
360
360
361 If you want to enter more than one expression in a single input block
361 If you want to enter more than one expression in a single input block
362 (something not possible in the terminal), you can use ``Control-Enter`` at the
362 (something not possible in the terminal), you can use ``Control-Enter`` at the
363 end of your first line instead of ``Enter``. At that point the console goes
363 end of your first line instead of ``Enter``. At that point the console goes
364 into 'cell mode' and even if your inputs are not indented, it will continue
364 into 'cell mode' and even if your inputs are not indented, it will continue
365 accepting arbitrarily many lines until either you enter an extra blank line or
365 accepting arbitrarily many lines until either you enter an extra blank line or
366 you hit ``Shift-Enter`` (the key binding that forces execution). When a
366 you hit ``Shift-Enter`` (the key binding that forces execution). When a
367 multiline cell is entered, IPython analyzes it and executes its code producing
367 multiline cell is entered, IPython analyzes it and executes its code producing
368 an ``Out[n]`` prompt only for the last expression in it, while the rest of the
368 an ``Out[n]`` prompt only for the last expression in it, while the rest of the
369 cell is executed as if it was a script. An example should clarify this::
369 cell is executed as if it was a script. An example should clarify this::
370
370
371 In [3]: x=1 # Hit C-Enter here
371 In [3]: x=1 # Hit C-Enter here
372 ...: y=2 # from now on, regular Enter is sufficient
372 ...: y=2 # from now on, regular Enter is sufficient
373 ...: z=3
373 ...: z=3
374 ...: x**2 # This does *not* produce an Out[] value
374 ...: x**2 # This does *not* produce an Out[] value
375 ...: x+y+z # Only the last expression does
375 ...: x+y+z # Only the last expression does
376 ...:
376 ...:
377 Out[3]: 6
377 Out[3]: 6
378
378
379 The behavior where an extra blank line forces execution is only active if you
379 The behavior where an extra blank line forces execution is only active if you
380 are actually typing at the keyboard each line, and is meant to make it mimic
380 are actually typing at the keyboard each line, and is meant to make it mimic
381 the IPython terminal behavior. If you paste a long chunk of input (for example
381 the IPython terminal behavior. If you paste a long chunk of input (for example
382 a long script copied form an editor or web browser), it can contain arbitrarily
382 a long script copied form an editor or web browser), it can contain arbitrarily
383 many intermediate blank lines and they won't cause any problems. As always,
383 many intermediate blank lines and they won't cause any problems. As always,
384 you can then make it execute by appending a blank line *at the end* or hitting
384 you can then make it execute by appending a blank line *at the end* or hitting
385 ``Shift-Enter`` anywhere within the cell.
385 ``Shift-Enter`` anywhere within the cell.
386
386
387 With the up arrow key, you can retrieve previous blocks of input that contain
387 With the up arrow key, you can retrieve previous blocks of input that contain
388 multiple lines. You can move inside of a multiline cell like you would in any
388 multiple lines. You can move inside of a multiline cell like you would in any
389 text editor. When you want it executed, the simplest thing to do is to hit the
389 text editor. When you want it executed, the simplest thing to do is to hit the
390 force execution key, ``Shift-Enter`` (though you can also navigate to the end
390 force execution key, ``Shift-Enter`` (though you can also navigate to the end
391 and append a blank line by using ``Enter`` twice).
391 and append a blank line by using ``Enter`` twice).
392
392
393 If you've edited a multiline cell and accidentally navigate out of it with the
393 If you've edited a multiline cell and accidentally navigate out of it with the
394 up or down arrow keys, IPython will clear the cell and replace it with the
394 up or down arrow keys, IPython will clear the cell and replace it with the
395 contents of the one above or below that you navigated to. If this was an
395 contents of the one above or below that you navigated to. If this was an
396 accident and you want to retrieve the cell you were editing, use the Undo
396 accident and you want to retrieve the cell you were editing, use the Undo
397 keybinding, ``Control-z``.
397 keybinding, ``Control-z``.
398
398
399
399
400 Key bindings
400 Key bindings
401 ============
401 ============
402
402
403 The IPython console supports most of the basic Emacs line-oriented keybindings,
403 The IPython console supports most of the basic Emacs line-oriented keybindings,
404 in addition to some of its own.
404 in addition to some of its own.
405
405
406 The keybinding prefixes mean:
406 The keybinding prefixes mean:
407
407
408 - ``C``: Control
408 - ``C``: Control
409 - ``S``: Shift
409 - ``S``: Shift
410 - ``M``: Meta (typically the Alt key)
410 - ``M``: Meta (typically the Alt key)
411
411
412 The keybindings themselves are:
412 The keybindings themselves are:
413
413
414 - ``Enter``: insert new line (may cause execution, see above).
414 - ``Enter``: insert new line (may cause execution, see above).
415 - ``C-Enter``: *force* new line, *never* causes execution.
415 - ``C-Enter``: *force* new line, *never* causes execution.
416 - ``S-Enter``: *force* execution regardless of where cursor is, no newline added.
416 - ``S-Enter``: *force* execution regardless of where cursor is, no newline added.
417 - ``Up``: step backwards through the history.
417 - ``Up``: step backwards through the history.
418 - ``Down``: step forwards through the history.
418 - ``Down``: step forwards through the history.
419 - ``S-Up``: search backwards through the history (like ``C-r`` in bash).
419 - ``S-Up``: search backwards through the history (like ``C-r`` in bash).
420 - ``S-Down``: search forwards through the history.
420 - ``S-Down``: search forwards through the history.
421 - ``C-c``: copy highlighted text to clipboard (prompts are automatically stripped).
421 - ``C-c``: copy highlighted text to clipboard (prompts are automatically stripped).
422 - ``C-S-c``: copy highlighted text to clipboard (prompts are not stripped).
422 - ``C-S-c``: copy highlighted text to clipboard (prompts are not stripped).
423 - ``C-v``: paste text from clipboard.
423 - ``C-v``: paste text from clipboard.
424 - ``C-z``: undo (retrieves lost text if you move out of a cell with the arrows).
424 - ``C-z``: undo (retrieves lost text if you move out of a cell with the arrows).
425 - ``C-S-z``: redo.
425 - ``C-S-z``: redo.
426 - ``C-o``: move to 'other' area, between pager and terminal.
426 - ``C-o``: move to 'other' area, between pager and terminal.
427 - ``C-l``: clear terminal.
427 - ``C-l``: clear terminal.
428 - ``C-a``: go to beginning of line.
428 - ``C-a``: go to beginning of line.
429 - ``C-e``: go to end of line.
429 - ``C-e``: go to end of line.
430 - ``C-u``: kill from cursor to the begining of the line.
430 - ``C-u``: kill from cursor to the begining of the line.
431 - ``C-k``: kill from cursor to the end of the line.
431 - ``C-k``: kill from cursor to the end of the line.
432 - ``C-y``: yank (paste)
432 - ``C-y``: yank (paste)
433 - ``C-p``: previous line (like up arrow)
433 - ``C-p``: previous line (like up arrow)
434 - ``C-n``: next line (like down arrow)
434 - ``C-n``: next line (like down arrow)
435 - ``C-f``: forward (like right arrow)
435 - ``C-f``: forward (like right arrow)
436 - ``C-b``: back (like left arrow)
436 - ``C-b``: back (like left arrow)
437 - ``C-d``: delete next character, or exits if input is empty
437 - ``C-d``: delete next character, or exits if input is empty
438 - ``M-<``: move to the beginning of the input region.
438 - ``M-<``: move to the beginning of the input region.
439 - ``M->``: move to the end of the input region.
439 - ``M->``: move to the end of the input region.
440 - ``M-d``: delete next word.
440 - ``M-d``: delete next word.
441 - ``M-Backspace``: delete previous word.
441 - ``M-Backspace``: delete previous word.
442 - ``C-.``: force a kernel restart (a confirmation dialog appears).
442 - ``C-.``: force a kernel restart (a confirmation dialog appears).
443 - ``C-+``: increase font size.
443 - ``C-+``: increase font size.
444 - ``C--``: decrease font size.
444 - ``C--``: decrease font size.
445 - ``C-M-Space``: toggle full screen. (Command-Control-Space on Mac OS X)
445 - ``C-M-Space``: toggle full screen. (Command-Control-Space on Mac OS X)
446
446
447 The IPython pager
447 The IPython pager
448 =================
448 =================
449
449
450 IPython will show long blocks of text from many sources using a builtin pager.
450 IPython will show long blocks of text from many sources using a builtin pager.
451 You can control where this pager appears with the ``--paging`` command-line
451 You can control where this pager appears with the ``--paging`` command-line
452 flag:
452 flag:
453
453
454 - ``inside`` [default]: the pager is overlaid on top of the main terminal. You
454 - ``inside`` [default]: the pager is overlaid on top of the main terminal. You
455 must quit the pager to get back to the terminal (similar to how a pager such
455 must quit the pager to get back to the terminal (similar to how a pager such
456 as ``less`` or ``more`` works).
456 as ``less`` or ``more`` works).
457
457
458 - ``vsplit``: the console is made double-tall, and the pager appears on the
458 - ``vsplit``: the console is made double-tall, and the pager appears on the
459 bottom area when needed. You can view its contents while using the terminal.
459 bottom area when needed. You can view its contents while using the terminal.
460
460
461 - ``hsplit``: the console is made double-wide, and the pager appears on the
461 - ``hsplit``: the console is made double-wide, and the pager appears on the
462 right area when needed. You can view its contents while using the terminal.
462 right area when needed. You can view its contents while using the terminal.
463
463
464 - ``none``: the console never pages output.
464 - ``none``: the console never pages output.
465
465
466 If you use the vertical or horizontal paging modes, you can navigate between
466 If you use the vertical or horizontal paging modes, you can navigate between
467 terminal and pager as follows:
467 terminal and pager as follows:
468
468
469 - Tab key: goes from pager to terminal (but not the other way around).
469 - Tab key: goes from pager to terminal (but not the other way around).
470 - Control-o: goes from one to another always.
470 - Control-o: goes from one to another always.
471 - Mouse: click on either.
471 - Mouse: click on either.
472
472
473 In all cases, the ``q`` or ``Escape`` keys quit the pager (when used with the
473 In all cases, the ``q`` or ``Escape`` keys quit the pager (when used with the
474 focus on the pager area).
474 focus on the pager area).
475
475
476 Running subprocesses
476 Running subprocesses
477 ====================
477 ====================
478
478
479 The graphical IPython console uses the ``pexpect`` module to run subprocesses
479 The graphical IPython console uses the ``pexpect`` module to run subprocesses
480 when you type ``!command``. This has a number of advantages (true asynchronous
480 when you type ``!command``. This has a number of advantages (true asynchronous
481 output from subprocesses as well as very robust termination of rogue
481 output from subprocesses as well as very robust termination of rogue
482 subprocesses with ``Control-C``), as well as some limitations. The main
482 subprocesses with ``Control-C``), as well as some limitations. The main
483 limitation is that you can *not* interact back with the subprocess, so anything
483 limitation is that you can *not* interact back with the subprocess, so anything
484 that invokes a pager or expects you to type input into it will block and hang
484 that invokes a pager or expects you to type input into it will block and hang
485 (you can kill it with ``Control-C``).
485 (you can kill it with ``Control-C``).
486
486
487 We have provided as magics ``%less`` to page files (aliased to ``%more``),
487 We have provided as magics ``%less`` to page files (aliased to ``%more``),
488 ``%clear`` to clear the terminal, and ``%man`` on Linux/OSX. These cover the
488 ``%clear`` to clear the terminal, and ``%man`` on Linux/OSX. These cover the
489 most common commands you'd want to call in your subshell and that would cause
489 most common commands you'd want to call in your subshell and that would cause
490 problems if invoked via ``!cmd``, but you need to be aware of this limitation.
490 problems if invoked via ``!cmd``, but you need to be aware of this limitation.
491
491
492 Display
492 Display
493 =======
493 =======
494
494
495 The IPython console can now display objects in a variety of formats, including
495 The IPython console can now display objects in a variety of formats, including
496 HTML, PNG and SVG. This is accomplished using the display functions in
496 HTML, PNG and SVG. This is accomplished using the display functions in
497 ``IPython.core.display``::
497 ``IPython.core.display``::
498
498
499 In [4]: from IPython.core.display import display, display_html
499 In [4]: from IPython.core.display import display, display_html
500
500
501 In [5]: from IPython.core.display import display_png, display_svg
501 In [5]: from IPython.core.display import display_png, display_svg
502
502
503 Python objects can simply be passed to these functions and the appropriate
503 Python objects can simply be passed to these functions and the appropriate
504 representations will be displayed in the console as long as the objects know
504 representations will be displayed in the console as long as the objects know
505 how to compute those representations. The easiest way of teaching objects how
505 how to compute those representations. The easiest way of teaching objects how
506 to format themselves in various representations is to define special methods
506 to format themselves in various representations is to define special methods
507 such as: ``_repr_html_``, ``_repr_svg_`` and ``_repr_png_``. IPython's display formatters
507 such as: ``_repr_html_``, ``_repr_svg_`` and ``_repr_png_``. IPython's display formatters
508 can also be given custom formatter functions for various types::
508 can also be given custom formatter functions for various types::
509
509
510 In [6]: ip = get_ipython()
510 In [6]: ip = get_ipython()
511
511
512 In [7]: html_formatter = ip.display_formatter.formatters['text/html']
512 In [7]: html_formatter = ip.display_formatter.formatters['text/html']
513
513
514 In [8]: html_formatter.for_type(Foo, foo_to_html)
514 In [8]: html_formatter.for_type(Foo, foo_to_html)
515
515
516 For further details, see ``IPython.core.formatters``.
516 For further details, see ``IPython.core.formatters``.
517
517
518 Inline matplotlib graphics
518 Inline matplotlib graphics
519 ==========================
519 ==========================
520
520
521 The IPython console is capable of displaying matplotlib figures inline, in SVG
521 The IPython console is capable of displaying matplotlib figures inline, in SVG
522 or PNG format. If started with the ``matplotlib=inline``, then all figures are
522 or PNG format. If started with the ``matplotlib=inline``, then all figures are
523 rendered inline automatically (PNG by default). If started with ``--matplotlib``
523 rendered inline automatically (PNG by default). If started with ``--matplotlib``
524 or ``matplotlib=<your backend>``, then a GUI backend will be used, but IPython's
524 or ``matplotlib=<your backend>``, then a GUI backend will be used, but IPython's
525 ``display()`` and ``getfigs()`` functions can be used to view plots inline::
525 ``display()`` and ``getfigs()`` functions can be used to view plots inline::
526
526
527 In [9]: display(*getfigs()) # display all figures inline
527 In [9]: display(*getfigs()) # display all figures inline
528
528
529 In[10]: display(*getfigs(1,2)) # display figures 1 and 2 inline
529 In[10]: display(*getfigs(1,2)) # display figures 1 and 2 inline
530 """
530 """
531
531
532
532
533 quick_guide = """\
533 quick_guide = """\
534 ? -> Introduction and overview of IPython's features.
534 ? -> Introduction and overview of IPython's features.
535 %quickref -> Quick reference.
535 %quickref -> Quick reference.
536 help -> Python's own help system.
536 help -> Python's own help system.
537 object? -> Details about 'object', use 'object??' for extra details.
537 object? -> Details about 'object', use 'object??' for extra details.
538 """
538 """
539
539
540 gui_note = """\
540 gui_note = """\
541 %guiref -> A brief reference about the graphical user interface.
541 %guiref -> A brief reference about the graphical user interface.
542 """
542 """
543
543
544 default_banner_parts = [
544 default_banner_parts = [
545 'Python %s\n' % (sys.version.split('\n')[0],),
545 'Python %s\n' % (sys.version.split('\n')[0],),
546 'Type "copyright", "credits" or "license" for more information.\n\n',
546 'Type "copyright", "credits" or "license" for more information.\n\n',
547 'IPython {version} -- An enhanced Interactive Python.\n'.format(
547 'IPython {version} -- An enhanced Interactive Python.\n'.format(
548 version=release.version,
548 version=release.version,
549 ),
549 ),
550 quick_guide
550 quick_guide
551 ]
551 ]
552
552
553 default_gui_banner_parts = default_banner_parts + [gui_note]
553 default_gui_banner_parts = default_banner_parts + [gui_note]
554
554
555 default_banner = ''.join(default_banner_parts)
555 default_banner = ''.join(default_banner_parts)
556
556
557 default_gui_banner = ''.join(default_gui_banner_parts)
557 default_gui_banner = ''.join(default_gui_banner_parts)
558
558
559 # page GUI Reference, for use as a magic:
559 # page GUI Reference, for use as a magic:
560
560
561 def page_guiref(arg_s=None):
561 def page_guiref(arg_s=None):
562 """Show a basic reference about the GUI Console."""
562 """Show a basic reference about the GUI Console."""
563 from IPython.core import page
563 from IPython.core import page
564 page.page(gui_reference)
564 page.page(gui_reference)
565
565
General Comments 0
You need to be logged in to leave comments. Login now