##// END OF EJS Templates
add unformal Name for 1.0
Matthias BUSSONNIER -
Show More
@@ -1,149 +1,151
1 1 # -*- coding: utf-8 -*-
2 2 """Release data for the IPython project."""
3 3
4 4 #-----------------------------------------------------------------------------
5 5 # Copyright (c) 2008, IPython Development Team.
6 6 # Copyright (c) 2001, Fernando Perez <fernando.perez@colorado.edu>
7 7 # Copyright (c) 2001, Janko Hauser <jhauser@zscout.de>
8 8 # Copyright (c) 2001, Nathaniel Gray <n8gray@caltech.edu>
9 9 #
10 10 # Distributed under the terms of the Modified BSD License.
11 11 #
12 12 # The full license is in the file COPYING.txt, distributed with this software.
13 13 #-----------------------------------------------------------------------------
14 14
15 15 # Name of the package for release purposes. This is the name which labels
16 16 # the tarballs and RPMs made by distutils, so it's best to lowercase it.
17 17 name = 'ipython'
18 18
19 19 # IPython version information. An empty _version_extra corresponds to a full
20 20 # release. 'dev' as a _version_extra string means this is a development
21 21 # version
22 22 _version_major = 1
23 23 _version_minor = 0
24 24 _version_patch = 0
25 25 _version_extra = 'dev'
26 26 #_version_extra = 'rc1'
27 27 # _version_extra = '' # Uncomment this for full releases
28 28
29 unformal_name = 'An Afternoon Hack'
30
29 31 # Construct full version string from these.
30 32 _ver = [_version_major, _version_minor, _version_patch]
31 33
32 34 __version__ = '.'.join(map(str, _ver))
33 35 if _version_extra:
34 36 __version__ = __version__ + '-' + _version_extra
35 37
36 38 version = __version__ # backwards compatibility name
37 39 version_info = (_version_major, _version_minor, _version_patch, _version_extra)
38 40
39 41 # Change this when incrementing the kernel protocol version
40 42 kernel_protocol_version_info = (4, 0)
41 43
42 44 description = "IPython: Productive Interactive Computing"
43 45
44 46 long_description = \
45 47 """
46 48 IPython provides a rich toolkit to help you make the most out of using Python
47 49 interactively. Its main components are:
48 50
49 51 * Powerful interactive Python shells (terminal- and Qt-based).
50 52 * A web-based interactive notebook environment with all shell features plus
51 53 support for embedded figures, animations and rich media.
52 54 * Support for interactive data visualization and use of GUI toolkits.
53 55 * Flexible, embeddable interpreters to load into your own projects.
54 56 * A high-performance library for high level and interactive parallel computing
55 57 that works in multicore systems, clusters, supercomputing and cloud scenarios.
56 58
57 59 The enhanced interactive Python shells have the following main features:
58 60
59 61 * Comprehensive object introspection.
60 62
61 63 * Input history, persistent across sessions.
62 64
63 65 * Caching of output results during a session with automatically generated
64 66 references.
65 67
66 68 * Extensible tab completion, with support by default for completion of python
67 69 variables and keywords, filenames and function keywords.
68 70
69 71 * Extensible system of 'magic' commands for controlling the environment and
70 72 performing many tasks related either to IPython or the operating system.
71 73
72 74 * A rich configuration system with easy switching between different setups
73 75 (simpler than changing $PYTHONSTARTUP environment variables every time).
74 76
75 77 * Session logging and reloading.
76 78
77 79 * Extensible syntax processing for special purpose situations.
78 80
79 81 * Access to the system shell with user-extensible alias system.
80 82
81 83 * Easily embeddable in other Python programs and GUIs.
82 84
83 85 * Integrated access to the pdb debugger and the Python profiler.
84 86
85 87 The parallel computing architecture has the following main features:
86 88
87 89 * Quickly parallelize Python code from an interactive Python/IPython session.
88 90
89 91 * A flexible and dynamic process model that be deployed on anything from
90 92 multicore workstations to supercomputers.
91 93
92 94 * An architecture that supports many different styles of parallelism, from
93 95 message passing to task farming.
94 96
95 97 * Both blocking and fully asynchronous interfaces.
96 98
97 99 * High level APIs that enable many things to be parallelized in a few lines
98 100 of code.
99 101
100 102 * Share live parallel jobs with other users securely.
101 103
102 104 * Dynamically load balanced task farming system.
103 105
104 106 * Robust error handling in parallel code.
105 107
106 108 The latest development version is always available from IPython's `GitHub
107 109 site <http://github.com/ipython>`_.
108 110 """
109 111
110 112 license = 'BSD'
111 113
112 114 authors = {'Fernando' : ('Fernando Perez','fperez.net@gmail.com'),
113 115 'Janko' : ('Janko Hauser','jhauser@zscout.de'),
114 116 'Nathan' : ('Nathaniel Gray','n8gray@caltech.edu'),
115 117 'Ville' : ('Ville Vainio','vivainio@gmail.com'),
116 118 'Brian' : ('Brian E Granger', 'ellisonbg@gmail.com'),
117 119 'Min' : ('Min Ragan-Kelley', 'benjaminrk@gmail.com'),
118 120 'Thomas' : ('Thomas A. Kluyver', 'takowl@gmail.com'),
119 121 'Jorgen' : ('Jorgen Stenarson', 'jorgen.stenarson@bostream.nu'),
120 122 'Matthias' : ('Matthias Bussonnier', 'bussonniermatthias@gmail.com'),
121 123 }
122 124
123 125 author = 'The IPython Development Team'
124 126
125 127 author_email = 'ipython-dev@scipy.org'
126 128
127 129 url = 'http://ipython.org'
128 130
129 131 download_url = 'https://github.com/ipython/ipython/downloads'
130 132
131 133 platforms = ['Linux','Mac OSX','Windows XP/Vista/7/8']
132 134
133 135 keywords = ['Interactive','Interpreter','Shell','Parallel','Distributed',
134 136 'Web-based computing', 'Qt console', 'Embedding']
135 137
136 138 classifiers = [
137 139 'Intended Audience :: Developers',
138 140 'Intended Audience :: Science/Research',
139 141 'License :: OSI Approved :: BSD License',
140 142 'Programming Language :: Python',
141 143 'Programming Language :: Python :: 2',
142 144 'Programming Language :: Python :: 2.6',
143 145 'Programming Language :: Python :: 2.7',
144 146 'Programming Language :: Python :: 3',
145 147 'Programming Language :: Python :: 3.2',
146 148 'Programming Language :: Python :: 3.3',
147 149 'Topic :: System :: Distributed Computing',
148 150 'Topic :: System :: Shells'
149 151 ]
@@ -1,569 +1,572
1 1 # -*- coding: utf-8 -*-
2 2 """Usage information for the main IPython applications.
3 3 """
4 4 #-----------------------------------------------------------------------------
5 5 # Copyright (C) 2008-2011 The IPython Development Team
6 6 # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu>
7 7 #
8 8 # Distributed under the terms of the BSD License. The full license is in
9 9 # the file COPYING, distributed as part of this software.
10 10 #-----------------------------------------------------------------------------
11 11
12 12 import sys
13 13 from IPython.core import release
14 14
15 15 cl_usage = """\
16 16 =========
17 17 IPython
18 18 =========
19 19
20 20 Tools for Interactive Computing in Python
21 21 =========================================
22 22
23 23 A Python shell with automatic history (input and output), dynamic object
24 24 introspection, easier configuration, command completion, access to the
25 25 system shell and more. IPython can also be embedded in running programs.
26 26
27 27
28 28 Usage
29 29
30 30 ipython [subcommand] [options] [-c cmd | -m mod | file] [--] [arg] ...
31 31
32 32 If invoked with no options, it executes the file and exits, passing the
33 33 remaining arguments to the script, just as if you had specified the same
34 34 command with python. You may need to specify `--` before args to be passed
35 35 to the script, to prevent IPython from attempting to parse them. If you
36 36 specify the option `-i` before the filename, it will enter an interactive
37 37 IPython session after running the script, rather than exiting. Files ending
38 38 in .py will be treated as normal Python, but files ending in .ipy can
39 39 contain special IPython syntax (magic commands, shell expansions, etc.).
40 40
41 41 Almost all configuration in IPython is available via the command-line. Do
42 42 `ipython --help-all` to see all available options. For persistent
43 43 configuration, look into your `ipython_config.py` configuration file for
44 44 details.
45 45
46 46 This file is typically installed in the `IPYTHONDIR` directory, and there
47 47 is a separate configuration directory for each profile. The default profile
48 48 directory will be located in $IPYTHONDIR/profile_default. For Linux users,
49 49 IPYTHONDIR defaults to `$HOME/.config/ipython`, and for other Unix systems
50 50 to `$HOME/.ipython`. For Windows users, $HOME resolves to C:\\Documents
51 51 and Settings\\YourUserName in most instances.
52 52
53 53 To initialize a profile with the default configuration file, do::
54 54
55 55 $> ipython profile create
56 56
57 57 and start editing `IPYTHONDIR/profile_default/ipython_config.py`
58 58
59 59 In IPython's documentation, we will refer to this directory as
60 60 `IPYTHONDIR`, you can change its default location by creating an
61 61 environment variable with this name and setting it to the desired path.
62 62
63 63 For more information, see the manual available in HTML and PDF in your
64 64 installation, or online at http://ipython.org/documentation.html.
65 65 """
66 66
67 67 interactive_usage = """
68 68 IPython -- An enhanced Interactive Python
69 69 =========================================
70 70
71 71 IPython offers a combination of convenient shell features, special commands
72 72 and a history mechanism for both input (command history) and output (results
73 73 caching, similar to Mathematica). It is intended to be a fully compatible
74 74 replacement for the standard Python interpreter, while offering vastly
75 75 improved functionality and flexibility.
76 76
77 77 At your system command line, type 'ipython -h' to see the command line
78 78 options available. This document only describes interactive features.
79 79
80 80 MAIN FEATURES
81 81 -------------
82 82
83 83 * Access to the standard Python help. As of Python 2.1, a help system is
84 84 available with access to object docstrings and the Python manuals. Simply
85 85 type 'help' (no quotes) to access it.
86 86
87 87 * Magic commands: type %magic for information on the magic subsystem.
88 88
89 89 * System command aliases, via the %alias command or the configuration file(s).
90 90
91 91 * Dynamic object information:
92 92
93 93 Typing ?word or word? prints detailed information about an object. If
94 94 certain strings in the object are too long (docstrings, code, etc.) they get
95 95 snipped in the center for brevity.
96 96
97 97 Typing ??word or word?? gives access to the full information without
98 98 snipping long strings. Long strings are sent to the screen through the less
99 99 pager if longer than the screen, printed otherwise.
100 100
101 101 The ?/?? system gives access to the full source code for any object (if
102 102 available), shows function prototypes and other useful information.
103 103
104 104 If you just want to see an object's docstring, type '%pdoc object' (without
105 105 quotes, and without % if you have automagic on).
106 106
107 107 Both %pdoc and ?/?? give you access to documentation even on things which are
108 108 not explicitely defined. Try for example typing {}.get? or after import os,
109 109 type os.path.abspath??. The magic functions %pdef, %source and %file operate
110 110 similarly.
111 111
112 112 * Completion in the local namespace, by typing TAB at the prompt.
113 113
114 114 At any time, hitting tab will complete any available python commands or
115 115 variable names, and show you a list of the possible completions if there's
116 116 no unambiguous one. It will also complete filenames in the current directory.
117 117
118 118 This feature requires the readline and rlcomplete modules, so it won't work
119 119 if your Python lacks readline support (such as under Windows).
120 120
121 121 * Search previous command history in two ways (also requires readline):
122 122
123 123 - Start typing, and then use Ctrl-p (previous,up) and Ctrl-n (next,down) to
124 124 search through only the history items that match what you've typed so
125 125 far. If you use Ctrl-p/Ctrl-n at a blank prompt, they just behave like
126 126 normal arrow keys.
127 127
128 128 - Hit Ctrl-r: opens a search prompt. Begin typing and the system searches
129 129 your history for lines that match what you've typed so far, completing as
130 130 much as it can.
131 131
132 132 - %hist: search history by index (this does *not* require readline).
133 133
134 134 * Persistent command history across sessions.
135 135
136 136 * Logging of input with the ability to save and restore a working session.
137 137
138 138 * System escape with !. Typing !ls will run 'ls' in the current directory.
139 139
140 140 * The reload command does a 'deep' reload of a module: changes made to the
141 141 module since you imported will actually be available without having to exit.
142 142
143 143 * Verbose and colored exception traceback printouts. See the magic xmode and
144 144 xcolor functions for details (just type %magic).
145 145
146 146 * Input caching system:
147 147
148 148 IPython offers numbered prompts (In/Out) with input and output caching. All
149 149 input is saved and can be retrieved as variables (besides the usual arrow
150 150 key recall).
151 151
152 152 The following GLOBAL variables always exist (so don't overwrite them!):
153 153 _i: stores previous input.
154 154 _ii: next previous.
155 155 _iii: next-next previous.
156 156 _ih : a list of all input _ih[n] is the input from line n.
157 157
158 158 Additionally, global variables named _i<n> are dynamically created (<n>
159 159 being the prompt counter), such that _i<n> == _ih[<n>]
160 160
161 161 For example, what you typed at prompt 14 is available as _i14 and _ih[14].
162 162
163 163 You can create macros which contain multiple input lines from this history,
164 164 for later re-execution, with the %macro function.
165 165
166 166 The history function %hist allows you to see any part of your input history
167 167 by printing a range of the _i variables. Note that inputs which contain
168 168 magic functions (%) appear in the history with a prepended comment. This is
169 169 because they aren't really valid Python code, so you can't exec them.
170 170
171 171 * Output caching system:
172 172
173 173 For output that is returned from actions, a system similar to the input
174 174 cache exists but using _ instead of _i. Only actions that produce a result
175 175 (NOT assignments, for example) are cached. If you are familiar with
176 176 Mathematica, IPython's _ variables behave exactly like Mathematica's %
177 177 variables.
178 178
179 179 The following GLOBAL variables always exist (so don't overwrite them!):
180 180 _ (one underscore): previous output.
181 181 __ (two underscores): next previous.
182 182 ___ (three underscores): next-next previous.
183 183
184 184 Global variables named _<n> are dynamically created (<n> being the prompt
185 185 counter), such that the result of output <n> is always available as _<n>.
186 186
187 187 Finally, a global dictionary named _oh exists with entries for all lines
188 188 which generated output.
189 189
190 190 * Directory history:
191 191
192 192 Your history of visited directories is kept in the global list _dh, and the
193 193 magic %cd command can be used to go to any entry in that list.
194 194
195 195 * Auto-parentheses and auto-quotes (adapted from Nathan Gray's LazyPython)
196 196
197 197 1. Auto-parentheses
198 198
199 199 Callable objects (i.e. functions, methods, etc) can be invoked like
200 200 this (notice the commas between the arguments)::
201 201
202 202 In [1]: callable_ob arg1, arg2, arg3
203 203
204 204 and the input will be translated to this::
205 205
206 206 callable_ob(arg1, arg2, arg3)
207 207
208 208 This feature is off by default (in rare cases it can produce
209 209 undesirable side-effects), but you can activate it at the command-line
210 210 by starting IPython with `--autocall 1`, set it permanently in your
211 211 configuration file, or turn on at runtime with `%autocall 1`.
212 212
213 213 You can force auto-parentheses by using '/' as the first character
214 214 of a line. For example::
215 215
216 216 In [1]: /globals # becomes 'globals()'
217 217
218 218 Note that the '/' MUST be the first character on the line! This
219 219 won't work::
220 220
221 221 In [2]: print /globals # syntax error
222 222
223 223 In most cases the automatic algorithm should work, so you should
224 224 rarely need to explicitly invoke /. One notable exception is if you
225 225 are trying to call a function with a list of tuples as arguments (the
226 226 parenthesis will confuse IPython)::
227 227
228 228 In [1]: zip (1,2,3),(4,5,6) # won't work
229 229
230 230 but this will work::
231 231
232 232 In [2]: /zip (1,2,3),(4,5,6)
233 233 ------> zip ((1,2,3),(4,5,6))
234 234 Out[2]= [(1, 4), (2, 5), (3, 6)]
235 235
236 236 IPython tells you that it has altered your command line by
237 237 displaying the new command line preceded by -->. e.g.::
238 238
239 239 In [18]: callable list
240 240 -------> callable (list)
241 241
242 242 2. Auto-Quoting
243 243
244 244 You can force auto-quoting of a function's arguments by using ',' as
245 245 the first character of a line. For example::
246 246
247 247 In [1]: ,my_function /home/me # becomes my_function("/home/me")
248 248
249 249 If you use ';' instead, the whole argument is quoted as a single
250 250 string (while ',' splits on whitespace)::
251 251
252 252 In [2]: ,my_function a b c # becomes my_function("a","b","c")
253 253 In [3]: ;my_function a b c # becomes my_function("a b c")
254 254
255 255 Note that the ',' MUST be the first character on the line! This
256 256 won't work::
257 257
258 258 In [4]: x = ,my_function /home/me # syntax error
259 259 """
260 260
261 261 interactive_usage_min = """\
262 262 An enhanced console for Python.
263 263 Some of its features are:
264 264 - Readline support if the readline library is present.
265 265 - Tab completion in the local namespace.
266 266 - Logging of input, see command-line options.
267 267 - System shell escape via ! , eg !ls.
268 268 - Magic commands, starting with a % (like %ls, %pwd, %cd, etc.)
269 269 - Keeps track of locally defined variables via %who, %whos.
270 270 - Show object information with a ? eg ?x or x? (use ?? for more info).
271 271 """
272 272
273 273 quick_reference = r"""
274 274 IPython -- An enhanced Interactive Python - Quick Reference Card
275 275 ================================================================
276 276
277 277 obj?, obj?? : Get help, or more help for object (also works as
278 278 ?obj, ??obj).
279 279 ?foo.*abc* : List names in 'foo' containing 'abc' in them.
280 280 %magic : Information about IPython's 'magic' % functions.
281 281
282 282 Magic functions are prefixed by % or %%, and typically take their arguments
283 283 without parentheses, quotes or even commas for convenience. Line magics take a
284 284 single % and cell magics are prefixed with two %%.
285 285
286 286 Example magic function calls:
287 287
288 288 %alias d ls -F : 'd' is now an alias for 'ls -F'
289 289 alias d ls -F : Works if 'alias' not a python name
290 290 alist = %alias : Get list of aliases to 'alist'
291 291 cd /usr/share : Obvious. cd -<tab> to choose from visited dirs.
292 292 %cd?? : See help AND source for magic %cd
293 293 %timeit x=10 : time the 'x=10' statement with high precision.
294 294 %%timeit x=2**100
295 295 x**100 : time 'x*100' with a setup of 'x=2**100'; setup code is not
296 296 counted. This is an example of a cell magic.
297 297
298 298 System commands:
299 299
300 300 !cp a.txt b/ : System command escape, calls os.system()
301 301 cp a.txt b/ : after %rehashx, most system commands work without !
302 302 cp ${f}.txt $bar : Variable expansion in magics and system commands
303 303 files = !ls /usr : Capture sytem command output
304 304 files.s, files.l, files.n: "a b c", ['a','b','c'], 'a\nb\nc'
305 305
306 306 History:
307 307
308 308 _i, _ii, _iii : Previous, next previous, next next previous input
309 309 _i4, _ih[2:5] : Input history line 4, lines 2-4
310 310 exec _i81 : Execute input history line #81 again
311 311 %rep 81 : Edit input history line #81
312 312 _, __, ___ : previous, next previous, next next previous output
313 313 _dh : Directory history
314 314 _oh : Output history
315 315 %hist : Command history. '%hist -g foo' search history for 'foo'
316 316
317 317 Autocall:
318 318
319 319 f 1,2 : f(1,2) # Off by default, enable with %autocall magic.
320 320 /f 1,2 : f(1,2) (forced autoparen)
321 321 ,f 1 2 : f("1","2")
322 322 ;f 1 2 : f("1 2")
323 323
324 324 Remember: TAB completion works in many contexts, not just file names
325 325 or python names.
326 326
327 327 The following magic functions are currently available:
328 328
329 329 """
330 330
331 331 gui_reference = """\
332 332 ===============================
333 333 The graphical IPython console
334 334 ===============================
335 335
336 336 This console is designed to emulate the look, feel and workflow of a terminal
337 337 environment, while adding a number of enhancements that are simply not possible
338 338 in a real terminal, such as inline syntax highlighting, true multiline editing,
339 339 inline graphics and much more.
340 340
341 341 This quick reference document contains the basic information you'll need to
342 342 know to make the most efficient use of it. For the various command line
343 343 options available at startup, type ``ipython qtconsole --help`` at the command line.
344 344
345 345
346 346 Multiline editing
347 347 =================
348 348
349 349 The graphical console is capable of true multiline editing, but it also tries
350 350 to behave intuitively like a terminal when possible. If you are used to
351 351 IPython's old terminal behavior, you should find the transition painless, and
352 352 once you learn a few basic keybindings it will be a much more efficient
353 353 environment.
354 354
355 355 For single expressions or indented blocks, the console behaves almost like the
356 356 terminal IPython: single expressions are immediately evaluated, and indented
357 357 blocks are evaluated once a single blank line is entered::
358 358
359 359 In [1]: print "Hello IPython!" # Enter was pressed at the end of the line
360 360 Hello IPython!
361 361
362 362 In [2]: for i in range(10):
363 363 ...: print i,
364 364 ...:
365 365 0 1 2 3 4 5 6 7 8 9
366 366
367 367 If you want to enter more than one expression in a single input block
368 368 (something not possible in the terminal), you can use ``Control-Enter`` at the
369 369 end of your first line instead of ``Enter``. At that point the console goes
370 370 into 'cell mode' and even if your inputs are not indented, it will continue
371 371 accepting arbitrarily many lines until either you enter an extra blank line or
372 372 you hit ``Shift-Enter`` (the key binding that forces execution). When a
373 373 multiline cell is entered, IPython analyzes it and executes its code producing
374 374 an ``Out[n]`` prompt only for the last expression in it, while the rest of the
375 375 cell is executed as if it was a script. An example should clarify this::
376 376
377 377 In [3]: x=1 # Hit C-Enter here
378 378 ...: y=2 # from now on, regular Enter is sufficient
379 379 ...: z=3
380 380 ...: x**2 # This does *not* produce an Out[] value
381 381 ...: x+y+z # Only the last expression does
382 382 ...:
383 383 Out[3]: 6
384 384
385 385 The behavior where an extra blank line forces execution is only active if you
386 386 are actually typing at the keyboard each line, and is meant to make it mimic
387 387 the IPython terminal behavior. If you paste a long chunk of input (for example
388 388 a long script copied form an editor or web browser), it can contain arbitrarily
389 389 many intermediate blank lines and they won't cause any problems. As always,
390 390 you can then make it execute by appending a blank line *at the end* or hitting
391 391 ``Shift-Enter`` anywhere within the cell.
392 392
393 393 With the up arrow key, you can retrieve previous blocks of input that contain
394 394 multiple lines. You can move inside of a multiline cell like you would in any
395 395 text editor. When you want it executed, the simplest thing to do is to hit the
396 396 force execution key, ``Shift-Enter`` (though you can also navigate to the end
397 397 and append a blank line by using ``Enter`` twice).
398 398
399 399 If you've edited a multiline cell and accidentally navigate out of it with the
400 400 up or down arrow keys, IPython will clear the cell and replace it with the
401 401 contents of the one above or below that you navigated to. If this was an
402 402 accident and you want to retrieve the cell you were editing, use the Undo
403 403 keybinding, ``Control-z``.
404 404
405 405
406 406 Key bindings
407 407 ============
408 408
409 409 The IPython console supports most of the basic Emacs line-oriented keybindings,
410 410 in addition to some of its own.
411 411
412 412 The keybinding prefixes mean:
413 413
414 414 - ``C``: Control
415 415 - ``S``: Shift
416 416 - ``M``: Meta (typically the Alt key)
417 417
418 418 The keybindings themselves are:
419 419
420 420 - ``Enter``: insert new line (may cause execution, see above).
421 421 - ``C-Enter``: *force* new line, *never* causes execution.
422 422 - ``S-Enter``: *force* execution regardless of where cursor is, no newline added.
423 423 - ``Up``: step backwards through the history.
424 424 - ``Down``: step forwards through the history.
425 425 - ``S-Up``: search backwards through the history (like ``C-r`` in bash).
426 426 - ``S-Down``: search forwards through the history.
427 427 - ``C-c``: copy highlighted text to clipboard (prompts are automatically stripped).
428 428 - ``C-S-c``: copy highlighted text to clipboard (prompts are not stripped).
429 429 - ``C-v``: paste text from clipboard.
430 430 - ``C-z``: undo (retrieves lost text if you move out of a cell with the arrows).
431 431 - ``C-S-z``: redo.
432 432 - ``C-o``: move to 'other' area, between pager and terminal.
433 433 - ``C-l``: clear terminal.
434 434 - ``C-a``: go to beginning of line.
435 435 - ``C-e``: go to end of line.
436 436 - ``C-u``: kill from cursor to the begining of the line.
437 437 - ``C-k``: kill from cursor to the end of the line.
438 438 - ``C-y``: yank (paste)
439 439 - ``C-p``: previous line (like up arrow)
440 440 - ``C-n``: next line (like down arrow)
441 441 - ``C-f``: forward (like right arrow)
442 442 - ``C-b``: back (like left arrow)
443 443 - ``C-d``: delete next character, or exits if input is empty
444 444 - ``M-<``: move to the beginning of the input region.
445 445 - ``M->``: move to the end of the input region.
446 446 - ``M-d``: delete next word.
447 447 - ``M-Backspace``: delete previous word.
448 448 - ``C-.``: force a kernel restart (a confirmation dialog appears).
449 449 - ``C-+``: increase font size.
450 450 - ``C--``: decrease font size.
451 451 - ``C-M-Space``: toggle full screen. (Command-Control-Space on Mac OS X)
452 452
453 453 The IPython pager
454 454 =================
455 455
456 456 IPython will show long blocks of text from many sources using a builtin pager.
457 457 You can control where this pager appears with the ``--paging`` command-line
458 458 flag:
459 459
460 460 - ``inside`` [default]: the pager is overlaid on top of the main terminal. You
461 461 must quit the pager to get back to the terminal (similar to how a pager such
462 462 as ``less`` or ``more`` works).
463 463
464 464 - ``vsplit``: the console is made double-tall, and the pager appears on the
465 465 bottom area when needed. You can view its contents while using the terminal.
466 466
467 467 - ``hsplit``: the console is made double-wide, and the pager appears on the
468 468 right area when needed. You can view its contents while using the terminal.
469 469
470 470 - ``none``: the console never pages output.
471 471
472 472 If you use the vertical or horizontal paging modes, you can navigate between
473 473 terminal and pager as follows:
474 474
475 475 - Tab key: goes from pager to terminal (but not the other way around).
476 476 - Control-o: goes from one to another always.
477 477 - Mouse: click on either.
478 478
479 479 In all cases, the ``q`` or ``Escape`` keys quit the pager (when used with the
480 480 focus on the pager area).
481 481
482 482 Running subprocesses
483 483 ====================
484 484
485 485 The graphical IPython console uses the ``pexpect`` module to run subprocesses
486 486 when you type ``!command``. This has a number of advantages (true asynchronous
487 487 output from subprocesses as well as very robust termination of rogue
488 488 subprocesses with ``Control-C``), as well as some limitations. The main
489 489 limitation is that you can *not* interact back with the subprocess, so anything
490 490 that invokes a pager or expects you to type input into it will block and hang
491 491 (you can kill it with ``Control-C``).
492 492
493 493 We have provided as magics ``%less`` to page files (aliased to ``%more``),
494 494 ``%clear`` to clear the terminal, and ``%man`` on Linux/OSX. These cover the
495 495 most common commands you'd want to call in your subshell and that would cause
496 496 problems if invoked via ``!cmd``, but you need to be aware of this limitation.
497 497
498 498 Display
499 499 =======
500 500
501 501 The IPython console can now display objects in a variety of formats, including
502 502 HTML, PNG and SVG. This is accomplished using the display functions in
503 503 ``IPython.core.display``::
504 504
505 505 In [4]: from IPython.core.display import display, display_html
506 506
507 507 In [5]: from IPython.core.display import display_png, display_svg
508 508
509 509 Python objects can simply be passed to these functions and the appropriate
510 510 representations will be displayed in the console as long as the objects know
511 511 how to compute those representations. The easiest way of teaching objects how
512 512 to format themselves in various representations is to define special methods
513 513 such as: ``_repr_html_``, ``_repr_svg_`` and ``_repr_png_``. IPython's display formatters
514 514 can also be given custom formatter functions for various types::
515 515
516 516 In [6]: ip = get_ipython()
517 517
518 518 In [7]: html_formatter = ip.display_formatter.formatters['text/html']
519 519
520 520 In [8]: html_formatter.for_type(Foo, foo_to_html)
521 521
522 522 For further details, see ``IPython.core.formatters``.
523 523
524 524 Inline matplotlib graphics
525 525 ==========================
526 526
527 527 The IPython console is capable of displaying matplotlib figures inline, in SVG
528 528 or PNG format. If started with the ``pylab=inline``, then all figures are
529 529 rendered inline automatically (PNG by default). If started with ``--pylab``
530 530 or ``pylab=<your backend>``, then a GUI backend will be used, but IPython's
531 531 ``display()`` and ``getfigs()`` functions can be used to view plots inline::
532 532
533 533 In [9]: display(*getfigs()) # display all figures inline
534 534
535 535 In[10]: display(*getfigs(1,2)) # display figures 1 and 2 inline
536 536 """
537 537
538 538
539 539 quick_guide = """\
540 540 ? -> Introduction and overview of IPython's features.
541 541 %quickref -> Quick reference.
542 542 help -> Python's own help system.
543 543 object? -> Details about 'object', use 'object??' for extra details.
544 544 """
545 545
546 546 gui_note = """\
547 547 %guiref -> A brief reference about the graphical user interface.
548 548 """
549 549
550 550 default_banner_parts = [
551 551 'Python %s\n' % (sys.version.split('\n')[0],),
552 552 'Type "copyright", "credits" or "license" for more information.\n\n',
553 'IPython %s -- An enhanced Interactive Python.\n' % (release.version,),
553 'IPython {version} ({name}) -- An enhanced Interactive Python.\n'.format(
554 version=release.version,
555 name=release.unformal_name
556 ),
554 557 quick_guide
555 558 ]
556 559
557 560 default_gui_banner_parts = default_banner_parts + [gui_note]
558 561
559 562 default_banner = ''.join(default_banner_parts)
560 563
561 564 default_gui_banner = ''.join(default_gui_banner_parts)
562 565
563 566 # page GUI Reference, for use as a magic:
564 567
565 568 def page_guiref(arg_s=None):
566 569 """Show a basic reference about the GUI Console."""
567 570 from IPython.core import page
568 571 page.page(gui_reference, auto_html=True)
569 572
General Comments 0
You need to be logged in to leave comments. Login now