Show More
The requested changes are too big and content was truncated. Show full diff
@@ -1,235 +1,235 b'' | |||
|
1 | 1 | """hooks for IPython. |
|
2 | 2 | |
|
3 | 3 | In Python, it is possible to overwrite any method of any object if you really |
|
4 | 4 | want to. But IPython exposes a few 'hooks', methods which are _designed_ to |
|
5 | 5 | be overwritten by users for customization purposes. This module defines the |
|
6 | 6 | default versions of all such hooks, which get used by IPython if not |
|
7 | 7 | overridden by the user. |
|
8 | 8 | |
|
9 | 9 | hooks are simple functions, but they should be declared with 'self' as their |
|
10 | 10 | first argument, because when activated they are registered into IPython as |
|
11 | 11 | instance methods. The self argument will be the IPython running instance |
|
12 | 12 | itself, so hooks have full access to the entire IPython object. |
|
13 | 13 | |
|
14 | 14 | If you wish to define a new hook and activate it, you need to put the |
|
15 | 15 | necessary code into a python file which can be either imported or execfile()'d |
|
16 |
from within your ipython |
|
|
16 | from within your profile's ipython_config.py configuration. | |
|
17 | 17 | |
|
18 | 18 | For example, suppose that you have a module called 'myiphooks' in your |
|
19 | 19 | PYTHONPATH, which contains the following definition: |
|
20 | 20 | |
|
21 | 21 | import os |
|
22 | 22 | from IPython.core import ipapi |
|
23 | 23 | ip = ipapi.get() |
|
24 | 24 | |
|
25 | 25 | def calljed(self,filename, linenum): |
|
26 | 26 | "My editor hook calls the jed editor directly." |
|
27 | 27 | print "Calling my own editor, jed ..." |
|
28 | 28 | if os.system('jed +%d %s' % (linenum,filename)) != 0: |
|
29 | 29 | raise TryNext() |
|
30 | 30 | |
|
31 | 31 | ip.set_hook('editor', calljed) |
|
32 | 32 | |
|
33 | 33 | You can then enable the functionality by doing 'import myiphooks' |
|
34 | 34 | somewhere in your configuration files or ipython command line. |
|
35 | 35 | """ |
|
36 | 36 | |
|
37 | 37 | #***************************************************************************** |
|
38 | 38 | # Copyright (C) 2005 Fernando Perez. <fperez@colorado.edu> |
|
39 | 39 | # |
|
40 | 40 | # Distributed under the terms of the BSD License. The full license is in |
|
41 | 41 | # the file COPYING, distributed as part of this software. |
|
42 | 42 | #***************************************************************************** |
|
43 | 43 | |
|
44 | 44 | import os, bisect |
|
45 | 45 | import sys |
|
46 | 46 | |
|
47 | 47 | from IPython.core.error import TryNext |
|
48 | 48 | |
|
49 | 49 | # List here all the default hooks. For now it's just the editor functions |
|
50 | 50 | # but over time we'll move here all the public API for user-accessible things. |
|
51 | 51 | |
|
52 | 52 | __all__ = ['editor', 'fix_error_editor', 'synchronize_with_editor', |
|
53 | 53 | 'input_prefilter', 'shutdown_hook', 'late_startup_hook', |
|
54 | 54 | 'generate_prompt', 'show_in_pager','pre_prompt_hook', |
|
55 | 55 | 'pre_run_code_hook', 'clipboard_get'] |
|
56 | 56 | |
|
57 | 57 | def editor(self,filename, linenum=None): |
|
58 | 58 | """Open the default editor at the given filename and linenumber. |
|
59 | 59 | |
|
60 | 60 | This is IPython's default editor hook, you can use it as an example to |
|
61 | 61 | write your own modified one. To set your own editor function as the |
|
62 | 62 | new editor hook, call ip.set_hook('editor',yourfunc).""" |
|
63 | 63 | |
|
64 | 64 | # IPython configures a default editor at startup by reading $EDITOR from |
|
65 | 65 | # the environment, and falling back on vi (unix) or notepad (win32). |
|
66 | 66 | editor = self.editor |
|
67 | 67 | |
|
68 | 68 | # marker for at which line to open the file (for existing objects) |
|
69 | 69 | if linenum is None or editor=='notepad': |
|
70 | 70 | linemark = '' |
|
71 | 71 | else: |
|
72 | 72 | linemark = '+%d' % int(linenum) |
|
73 | 73 | |
|
74 | 74 | # Enclose in quotes if necessary and legal |
|
75 | 75 | if ' ' in editor and os.path.isfile(editor) and editor[0] != '"': |
|
76 | 76 | editor = '"%s"' % editor |
|
77 | 77 | |
|
78 | 78 | # Call the actual editor |
|
79 | 79 | if os.system('%s %s %s' % (editor,linemark,filename)) != 0: |
|
80 | 80 | raise TryNext() |
|
81 | 81 | |
|
82 | 82 | import tempfile |
|
83 | 83 | def fix_error_editor(self,filename,linenum,column,msg): |
|
84 | 84 | """Open the editor at the given filename, linenumber, column and |
|
85 | 85 | show an error message. This is used for correcting syntax errors. |
|
86 | 86 | The current implementation only has special support for the VIM editor, |
|
87 | 87 | and falls back on the 'editor' hook if VIM is not used. |
|
88 | 88 | |
|
89 | 89 | Call ip.set_hook('fix_error_editor',youfunc) to use your own function, |
|
90 | 90 | """ |
|
91 | 91 | def vim_quickfix_file(): |
|
92 | 92 | t = tempfile.NamedTemporaryFile() |
|
93 | 93 | t.write('%s:%d:%d:%s\n' % (filename,linenum,column,msg)) |
|
94 | 94 | t.flush() |
|
95 | 95 | return t |
|
96 | 96 | if os.path.basename(self.editor) != 'vim': |
|
97 | 97 | self.hooks.editor(filename,linenum) |
|
98 | 98 | return |
|
99 | 99 | t = vim_quickfix_file() |
|
100 | 100 | try: |
|
101 | 101 | if os.system('vim --cmd "set errorformat=%f:%l:%c:%m" -q ' + t.name): |
|
102 | 102 | raise TryNext() |
|
103 | 103 | finally: |
|
104 | 104 | t.close() |
|
105 | 105 | |
|
106 | 106 | |
|
107 | 107 | def synchronize_with_editor(self, filename, linenum, column): |
|
108 | 108 | pass |
|
109 | 109 | |
|
110 | 110 | |
|
111 | 111 | class CommandChainDispatcher: |
|
112 | 112 | """ Dispatch calls to a chain of commands until some func can handle it |
|
113 | 113 | |
|
114 | 114 | Usage: instantiate, execute "add" to add commands (with optional |
|
115 | 115 | priority), execute normally via f() calling mechanism. |
|
116 | 116 | |
|
117 | 117 | """ |
|
118 | 118 | def __init__(self,commands=None): |
|
119 | 119 | if commands is None: |
|
120 | 120 | self.chain = [] |
|
121 | 121 | else: |
|
122 | 122 | self.chain = commands |
|
123 | 123 | |
|
124 | 124 | |
|
125 | 125 | def __call__(self,*args, **kw): |
|
126 | 126 | """ Command chain is called just like normal func. |
|
127 | 127 | |
|
128 | 128 | This will call all funcs in chain with the same args as were given to this |
|
129 | 129 | function, and return the result of first func that didn't raise |
|
130 | 130 | TryNext """ |
|
131 | 131 | |
|
132 | 132 | for prio,cmd in self.chain: |
|
133 | 133 | #print "prio",prio,"cmd",cmd #dbg |
|
134 | 134 | try: |
|
135 | 135 | return cmd(*args, **kw) |
|
136 | 136 | except TryNext, exc: |
|
137 | 137 | if exc.args or exc.kwargs: |
|
138 | 138 | args = exc.args |
|
139 | 139 | kw = exc.kwargs |
|
140 | 140 | # if no function will accept it, raise TryNext up to the caller |
|
141 | 141 | raise TryNext |
|
142 | 142 | |
|
143 | 143 | def __str__(self): |
|
144 | 144 | return str(self.chain) |
|
145 | 145 | |
|
146 | 146 | def add(self, func, priority=0): |
|
147 | 147 | """ Add a func to the cmd chain with given priority """ |
|
148 | 148 | bisect.insort(self.chain,(priority,func)) |
|
149 | 149 | |
|
150 | 150 | def __iter__(self): |
|
151 | 151 | """ Return all objects in chain. |
|
152 | 152 | |
|
153 | 153 | Handy if the objects are not callable. |
|
154 | 154 | """ |
|
155 | 155 | return iter(self.chain) |
|
156 | 156 | |
|
157 | 157 | |
|
158 | 158 | def input_prefilter(self,line): |
|
159 | 159 | """ Default input prefilter |
|
160 | 160 | |
|
161 | 161 | This returns the line as unchanged, so that the interpreter |
|
162 | 162 | knows that nothing was done and proceeds with "classic" prefiltering |
|
163 | 163 | (%magics, !shell commands etc.). |
|
164 | 164 | |
|
165 | 165 | Note that leading whitespace is not passed to this hook. Prefilter |
|
166 | 166 | can't alter indentation. |
|
167 | 167 | |
|
168 | 168 | """ |
|
169 | 169 | #print "attempt to rewrite",line #dbg |
|
170 | 170 | return line |
|
171 | 171 | |
|
172 | 172 | |
|
173 | 173 | def shutdown_hook(self): |
|
174 | 174 | """ default shutdown hook |
|
175 | 175 | |
|
176 | 176 | Typically, shotdown hooks should raise TryNext so all shutdown ops are done |
|
177 | 177 | """ |
|
178 | 178 | |
|
179 | 179 | #print "default shutdown hook ok" # dbg |
|
180 | 180 | return |
|
181 | 181 | |
|
182 | 182 | |
|
183 | 183 | def late_startup_hook(self): |
|
184 | 184 | """ Executed after ipython has been constructed and configured |
|
185 | 185 | |
|
186 | 186 | """ |
|
187 | 187 | #print "default startup hook ok" # dbg |
|
188 | 188 | |
|
189 | 189 | |
|
190 | 190 | def generate_prompt(self, is_continuation): |
|
191 | 191 | """ calculate and return a string with the prompt to display """ |
|
192 | 192 | if is_continuation: |
|
193 | 193 | return str(self.displayhook.prompt2) |
|
194 | 194 | return str(self.displayhook.prompt1) |
|
195 | 195 | |
|
196 | 196 | |
|
197 | 197 | def show_in_pager(self,s): |
|
198 | 198 | """ Run a string through pager """ |
|
199 | 199 | # raising TryNext here will use the default paging functionality |
|
200 | 200 | raise TryNext |
|
201 | 201 | |
|
202 | 202 | |
|
203 | 203 | def pre_prompt_hook(self): |
|
204 | 204 | """ Run before displaying the next prompt |
|
205 | 205 | |
|
206 | 206 | Use this e.g. to display output from asynchronous operations (in order |
|
207 | 207 | to not mess up text entry) |
|
208 | 208 | """ |
|
209 | 209 | |
|
210 | 210 | return None |
|
211 | 211 | |
|
212 | 212 | |
|
213 | 213 | def pre_run_code_hook(self): |
|
214 | 214 | """ Executed before running the (prefiltered) code in IPython """ |
|
215 | 215 | return None |
|
216 | 216 | |
|
217 | 217 | |
|
218 | 218 | def clipboard_get(self): |
|
219 | 219 | """ Get text from the clipboard. |
|
220 | 220 | """ |
|
221 | 221 | from IPython.lib.clipboard import ( |
|
222 | 222 | osx_clipboard_get, tkinter_clipboard_get, |
|
223 | 223 | win32_clipboard_get |
|
224 | 224 | ) |
|
225 | 225 | if sys.platform == 'win32': |
|
226 | 226 | chain = [win32_clipboard_get, tkinter_clipboard_get] |
|
227 | 227 | elif sys.platform == 'darwin': |
|
228 | 228 | chain = [osx_clipboard_get, tkinter_clipboard_get] |
|
229 | 229 | else: |
|
230 | 230 | chain = [tkinter_clipboard_get] |
|
231 | 231 | dispatcher = CommandChainDispatcher() |
|
232 | 232 | for func in chain: |
|
233 | 233 | dispatcher.add(func) |
|
234 | 234 | text = dispatcher() |
|
235 | 235 | return text |
|
1 | NO CONTENT: modified file | |
The requested commit or file is too big and content was truncated. Show full diff |
@@ -1,524 +1,524 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """Usage information for the main IPython applications. |
|
3 | 3 | """ |
|
4 | 4 | #----------------------------------------------------------------------------- |
|
5 | 5 | # Copyright (C) 2008-2010 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] [files] |
|
31 | 31 | |
|
32 | 32 | If invoked with no options, it executes all the files listed in sequence |
|
33 | 33 | and exits, use -i to enter interactive mode after running the files. Files |
|
34 | 34 | ending in .py will be treated as normal Python, but files ending in .ipy |
|
35 | 35 | can contain special IPython syntax (magic commands, shell expansions, etc.) |
|
36 | 36 | |
|
37 | 37 | Almost all configuration in IPython is available via the command-line. Do |
|
38 | 38 | `ipython --help-all` to see all available options. For persistent |
|
39 | 39 | configuration, look into your `ipython_config.py` configuration file for |
|
40 | 40 | details. |
|
41 | 41 | |
|
42 | 42 | This file is typically installed in the `IPYTHON_DIR` directory, and there |
|
43 | 43 | is a separate configuration directory for each profile. The default profile |
|
44 | 44 | directory will be located in $IPYTHON_DIR/profile_default. For Linux users, |
|
45 | 45 | IPYTHON_DIR defaults to `$HOME/.config/ipython`, and for other Unix systems |
|
46 | 46 | to `$HOME/.ipython`. For Windows users, $HOME resolves to C:\\Documents |
|
47 | 47 | and Settings\\YourUserName in most instances. |
|
48 | 48 | |
|
49 | 49 | To initialize a profile with the default configuration file, do:: |
|
50 | 50 | |
|
51 | 51 | $> ipython profile create |
|
52 | 52 | |
|
53 | 53 | and start editing `IPYTHON_DIR/profile_default/ipython_config.py` |
|
54 | 54 | |
|
55 | 55 | In IPython's documentation, we will refer to this directory as |
|
56 | 56 | `IPYTHON_DIR`, you can change its default location by creating an |
|
57 | 57 | environment variable with this name and setting it to the desired path. |
|
58 | 58 | |
|
59 | 59 | For more information, see the manual available in HTML and PDF in your |
|
60 | 60 | installation, or online at http://ipython.org/documentation.html. |
|
61 | 61 | """ |
|
62 | 62 | |
|
63 | 63 | interactive_usage = """ |
|
64 | 64 | IPython -- An enhanced Interactive Python |
|
65 | 65 | ========================================= |
|
66 | 66 | |
|
67 | 67 | IPython offers a combination of convenient shell features, special commands |
|
68 | 68 | and a history mechanism for both input (command history) and output (results |
|
69 | 69 | caching, similar to Mathematica). It is intended to be a fully compatible |
|
70 | 70 | replacement for the standard Python interpreter, while offering vastly |
|
71 | 71 | improved functionality and flexibility. |
|
72 | 72 | |
|
73 | 73 | At your system command line, type 'ipython -h' to see the command line |
|
74 | 74 | options available. This document only describes interactive features. |
|
75 | 75 | |
|
76 | 76 | MAIN FEATURES |
|
77 | 77 | |
|
78 | 78 | * Access to the standard Python help. As of Python 2.1, a help system is |
|
79 | 79 | available with access to object docstrings and the Python manuals. Simply |
|
80 | 80 | type 'help' (no quotes) to access it. |
|
81 | 81 | |
|
82 | 82 | * Magic commands: type %magic for information on the magic subsystem. |
|
83 | 83 | |
|
84 |
* System command aliases, via the %alias command or the |
|
|
84 | * System command aliases, via the %alias command or the configuration file(s). | |
|
85 | 85 | |
|
86 | 86 | * Dynamic object information: |
|
87 | 87 | |
|
88 | 88 | Typing ?word or word? prints detailed information about an object. If |
|
89 | 89 | certain strings in the object are too long (docstrings, code, etc.) they get |
|
90 | 90 | snipped in the center for brevity. |
|
91 | 91 | |
|
92 | 92 | Typing ??word or word?? gives access to the full information without |
|
93 | 93 | snipping long strings. Long strings are sent to the screen through the less |
|
94 | 94 | pager if longer than the screen, printed otherwise. |
|
95 | 95 | |
|
96 | 96 | The ?/?? system gives access to the full source code for any object (if |
|
97 | 97 | available), shows function prototypes and other useful information. |
|
98 | 98 | |
|
99 | 99 | If you just want to see an object's docstring, type '%pdoc object' (without |
|
100 | 100 | quotes, and without % if you have automagic on). |
|
101 | 101 | |
|
102 | 102 | Both %pdoc and ?/?? give you access to documentation even on things which are |
|
103 | 103 | not explicitely defined. Try for example typing {}.get? or after import os, |
|
104 | 104 | type os.path.abspath??. The magic functions %pdef, %source and %file operate |
|
105 | 105 | similarly. |
|
106 | 106 | |
|
107 | 107 | * Completion in the local namespace, by typing TAB at the prompt. |
|
108 | 108 | |
|
109 | 109 | At any time, hitting tab will complete any available python commands or |
|
110 | 110 | variable names, and show you a list of the possible completions if there's |
|
111 | 111 | no unambiguous one. It will also complete filenames in the current directory. |
|
112 | 112 | |
|
113 | 113 | This feature requires the readline and rlcomplete modules, so it won't work |
|
114 | 114 | if your Python lacks readline support (such as under Windows). |
|
115 | 115 | |
|
116 | 116 | * Search previous command history in two ways (also requires readline): |
|
117 | 117 | |
|
118 | 118 | - Start typing, and then use Ctrl-p (previous,up) and Ctrl-n (next,down) to |
|
119 | 119 | search through only the history items that match what you've typed so |
|
120 | 120 | far. If you use Ctrl-p/Ctrl-n at a blank prompt, they just behave like |
|
121 | 121 | normal arrow keys. |
|
122 | 122 | |
|
123 | 123 | - Hit Ctrl-r: opens a search prompt. Begin typing and the system searches |
|
124 | 124 | your history for lines that match what you've typed so far, completing as |
|
125 | 125 | much as it can. |
|
126 | 126 | |
|
127 | 127 | - %hist: search history by index (this does *not* require readline). |
|
128 | 128 | |
|
129 | 129 | * Persistent command history across sessions. |
|
130 | 130 | |
|
131 | 131 | * Logging of input with the ability to save and restore a working session. |
|
132 | 132 | |
|
133 | 133 | * System escape with !. Typing !ls will run 'ls' in the current directory. |
|
134 | 134 | |
|
135 | 135 | * The reload command does a 'deep' reload of a module: changes made to the |
|
136 | 136 | module since you imported will actually be available without having to exit. |
|
137 | 137 | |
|
138 | 138 | * Verbose and colored exception traceback printouts. See the magic xmode and |
|
139 | 139 | xcolor functions for details (just type %magic). |
|
140 | 140 | |
|
141 | 141 | * Input caching system: |
|
142 | 142 | |
|
143 | 143 | IPython offers numbered prompts (In/Out) with input and output caching. All |
|
144 | 144 | input is saved and can be retrieved as variables (besides the usual arrow |
|
145 | 145 | key recall). |
|
146 | 146 | |
|
147 | 147 | The following GLOBAL variables always exist (so don't overwrite them!): |
|
148 | 148 | _i: stores previous input. |
|
149 | 149 | _ii: next previous. |
|
150 | 150 | _iii: next-next previous. |
|
151 | 151 | _ih : a list of all input _ih[n] is the input from line n. |
|
152 | 152 | |
|
153 | 153 | Additionally, global variables named _i<n> are dynamically created (<n> |
|
154 | 154 | being the prompt counter), such that _i<n> == _ih[<n>] |
|
155 | 155 | |
|
156 | 156 | For example, what you typed at prompt 14 is available as _i14 and _ih[14]. |
|
157 | 157 | |
|
158 | 158 | You can create macros which contain multiple input lines from this history, |
|
159 | 159 | for later re-execution, with the %macro function. |
|
160 | 160 | |
|
161 | 161 | The history function %hist allows you to see any part of your input history |
|
162 | 162 | by printing a range of the _i variables. Note that inputs which contain |
|
163 | 163 | magic functions (%) appear in the history with a prepended comment. This is |
|
164 | 164 | because they aren't really valid Python code, so you can't exec them. |
|
165 | 165 | |
|
166 | 166 | * Output caching system: |
|
167 | 167 | |
|
168 | 168 | For output that is returned from actions, a system similar to the input |
|
169 | 169 | cache exists but using _ instead of _i. Only actions that produce a result |
|
170 | 170 | (NOT assignments, for example) are cached. If you are familiar with |
|
171 | 171 | Mathematica, IPython's _ variables behave exactly like Mathematica's % |
|
172 | 172 | variables. |
|
173 | 173 | |
|
174 | 174 | The following GLOBAL variables always exist (so don't overwrite them!): |
|
175 | 175 | _ (one underscore): previous output. |
|
176 | 176 | __ (two underscores): next previous. |
|
177 | 177 | ___ (three underscores): next-next previous. |
|
178 | 178 | |
|
179 | 179 | Global variables named _<n> are dynamically created (<n> being the prompt |
|
180 | 180 | counter), such that the result of output <n> is always available as _<n>. |
|
181 | 181 | |
|
182 | 182 | Finally, a global dictionary named _oh exists with entries for all lines |
|
183 | 183 | which generated output. |
|
184 | 184 | |
|
185 | 185 | * Directory history: |
|
186 | 186 | |
|
187 | 187 | Your history of visited directories is kept in the global list _dh, and the |
|
188 | 188 | magic %cd command can be used to go to any entry in that list. |
|
189 | 189 | |
|
190 | 190 | * Auto-parentheses and auto-quotes (adapted from Nathan Gray's LazyPython) |
|
191 | 191 | |
|
192 | 192 | 1. Auto-parentheses |
|
193 | 193 | Callable objects (i.e. functions, methods, etc) can be invoked like |
|
194 | 194 | this (notice the commas between the arguments): |
|
195 | 195 | >>> callable_ob arg1, arg2, arg3 |
|
196 | 196 | and the input will be translated to this: |
|
197 | 197 | --> callable_ob(arg1, arg2, arg3) |
|
198 | 198 | You can force auto-parentheses by using '/' as the first character |
|
199 | 199 | of a line. For example: |
|
200 | 200 | >>> /globals # becomes 'globals()' |
|
201 | 201 | Note that the '/' MUST be the first character on the line! This |
|
202 | 202 | won't work: |
|
203 | 203 | >>> print /globals # syntax error |
|
204 | 204 | |
|
205 | 205 | In most cases the automatic algorithm should work, so you should |
|
206 | 206 | rarely need to explicitly invoke /. One notable exception is if you |
|
207 | 207 | are trying to call a function with a list of tuples as arguments (the |
|
208 | 208 | parenthesis will confuse IPython): |
|
209 | 209 | In [1]: zip (1,2,3),(4,5,6) # won't work |
|
210 | 210 | but this will work: |
|
211 | 211 | In [2]: /zip (1,2,3),(4,5,6) |
|
212 | 212 | ------> zip ((1,2,3),(4,5,6)) |
|
213 | 213 | Out[2]= [(1, 4), (2, 5), (3, 6)] |
|
214 | 214 | |
|
215 | 215 | IPython tells you that it has altered your command line by |
|
216 | 216 | displaying the new command line preceded by -->. e.g.: |
|
217 | 217 | In [18]: callable list |
|
218 | 218 | -------> callable (list) |
|
219 | 219 | |
|
220 | 220 | 2. Auto-Quoting |
|
221 | 221 | You can force auto-quoting of a function's arguments by using ',' as |
|
222 | 222 | the first character of a line. For example: |
|
223 | 223 | >>> ,my_function /home/me # becomes my_function("/home/me") |
|
224 | 224 | |
|
225 | 225 | If you use ';' instead, the whole argument is quoted as a single |
|
226 | 226 | string (while ',' splits on whitespace): |
|
227 | 227 | >>> ,my_function a b c # becomes my_function("a","b","c") |
|
228 | 228 | >>> ;my_function a b c # becomes my_function("a b c") |
|
229 | 229 | |
|
230 | 230 | Note that the ',' MUST be the first character on the line! This |
|
231 | 231 | won't work: |
|
232 | 232 | >>> x = ,my_function /home/me # syntax error |
|
233 | 233 | """ |
|
234 | 234 | |
|
235 | 235 | interactive_usage_min = """\ |
|
236 | 236 | An enhanced console for Python. |
|
237 | 237 | Some of its features are: |
|
238 | 238 | - Readline support if the readline library is present. |
|
239 | 239 | - Tab completion in the local namespace. |
|
240 | 240 | - Logging of input, see command-line options. |
|
241 | 241 | - System shell escape via ! , eg !ls. |
|
242 | 242 | - Magic commands, starting with a % (like %ls, %pwd, %cd, etc.) |
|
243 | 243 | - Keeps track of locally defined variables via %who, %whos. |
|
244 | 244 | - Show object information with a ? eg ?x or x? (use ?? for more info). |
|
245 | 245 | """ |
|
246 | 246 | |
|
247 | 247 | quick_reference = r""" |
|
248 | 248 | IPython -- An enhanced Interactive Python - Quick Reference Card |
|
249 | 249 | ================================================================ |
|
250 | 250 | |
|
251 | 251 | obj?, obj?? : Get help, or more help for object (also works as |
|
252 | 252 | ?obj, ??obj). |
|
253 | 253 | ?foo.*abc* : List names in 'foo' containing 'abc' in them. |
|
254 | 254 | %magic : Information about IPython's 'magic' % functions. |
|
255 | 255 | |
|
256 | 256 | Magic functions are prefixed by %, and typically take their arguments without |
|
257 | 257 | parentheses, quotes or even commas for convenience. |
|
258 | 258 | |
|
259 | 259 | Example magic function calls: |
|
260 | 260 | |
|
261 | 261 | %alias d ls -F : 'd' is now an alias for 'ls -F' |
|
262 | 262 | alias d ls -F : Works if 'alias' not a python name |
|
263 | 263 | alist = %alias : Get list of aliases to 'alist' |
|
264 | 264 | cd /usr/share : Obvious. cd -<tab> to choose from visited dirs. |
|
265 | 265 | %cd?? : See help AND source for magic %cd |
|
266 | 266 | |
|
267 | 267 | System commands: |
|
268 | 268 | |
|
269 | 269 | !cp a.txt b/ : System command escape, calls os.system() |
|
270 | 270 | cp a.txt b/ : after %rehashx, most system commands work without ! |
|
271 | 271 | cp ${f}.txt $bar : Variable expansion in magics and system commands |
|
272 | 272 | files = !ls /usr : Capture sytem command output |
|
273 | 273 | files.s, files.l, files.n: "a b c", ['a','b','c'], 'a\nb\nc' |
|
274 | 274 | |
|
275 | 275 | History: |
|
276 | 276 | |
|
277 | 277 | _i, _ii, _iii : Previous, next previous, next next previous input |
|
278 | 278 | _i4, _ih[2:5] : Input history line 4, lines 2-4 |
|
279 | 279 | exec _i81 : Execute input history line #81 again |
|
280 | 280 | %rep 81 : Edit input history line #81 |
|
281 | 281 | _, __, ___ : previous, next previous, next next previous output |
|
282 | 282 | _dh : Directory history |
|
283 | 283 | _oh : Output history |
|
284 | 284 | %hist : Command history. '%hist -g foo' search history for 'foo' |
|
285 | 285 | |
|
286 | 286 | Autocall: |
|
287 | 287 | |
|
288 | 288 | f 1,2 : f(1,2) |
|
289 | 289 | /f 1,2 : f(1,2) (forced autoparen) |
|
290 | 290 | ,f 1 2 : f("1","2") |
|
291 | 291 | ;f 1 2 : f("1 2") |
|
292 | 292 | |
|
293 | 293 | Remember: TAB completion works in many contexts, not just file names |
|
294 | 294 | or python names. |
|
295 | 295 | |
|
296 | 296 | The following magic functions are currently available: |
|
297 | 297 | |
|
298 | 298 | """ |
|
299 | 299 | |
|
300 | 300 | gui_reference = """\ |
|
301 | 301 | =============================== |
|
302 | 302 | The graphical IPython console |
|
303 | 303 | =============================== |
|
304 | 304 | |
|
305 | 305 | This console is designed to emulate the look, feel and workflow of a terminal |
|
306 | 306 | environment, while adding a number of enhancements that are simply not possible |
|
307 | 307 | in a real terminal, such as inline syntax highlighting, true multiline editing, |
|
308 | 308 | inline graphics and much more. |
|
309 | 309 | |
|
310 | 310 | This quick reference document contains the basic information you'll need to |
|
311 | 311 | know to make the most efficient use of it. For the various command line |
|
312 | 312 | options available at startup, type ``ipython qtconsole --help`` at the command line. |
|
313 | 313 | |
|
314 | 314 | |
|
315 | 315 | Multiline editing |
|
316 | 316 | ================= |
|
317 | 317 | |
|
318 | 318 | The graphical console is capable of true multiline editing, but it also tries |
|
319 | 319 | to behave intuitively like a terminal when possible. If you are used to |
|
320 | 320 | IPyhton's old terminal behavior, you should find the transition painless, and |
|
321 | 321 | once you learn a few basic keybindings it will be a much more efficient |
|
322 | 322 | environment. |
|
323 | 323 | |
|
324 | 324 | For single expressions or indented blocks, the console behaves almost like the |
|
325 | 325 | terminal IPython: single expressions are immediately evaluated, and indented |
|
326 | 326 | blocks are evaluated once a single blank line is entered:: |
|
327 | 327 | |
|
328 | 328 | In [1]: print "Hello IPython!" # Enter was pressed at the end of the line |
|
329 | 329 | Hello IPython! |
|
330 | 330 | |
|
331 | 331 | In [2]: for i in range(10): |
|
332 | 332 | ...: print i, |
|
333 | 333 | ...: |
|
334 | 334 | 0 1 2 3 4 5 6 7 8 9 |
|
335 | 335 | |
|
336 | 336 | If you want to enter more than one expression in a single input block |
|
337 | 337 | (something not possible in the terminal), you can use ``Control-Enter`` at the |
|
338 | 338 | end of your first line instead of ``Enter``. At that point the console goes |
|
339 | 339 | into 'cell mode' and even if your inputs are not indented, it will continue |
|
340 | 340 | accepting arbitrarily many lines until either you enter an extra blank line or |
|
341 | 341 | you hit ``Shift-Enter`` (the key binding that forces execution). When a |
|
342 | 342 | multiline cell is entered, IPython analyzes it and executes its code producing |
|
343 | 343 | an ``Out[n]`` prompt only for the last expression in it, while the rest of the |
|
344 | 344 | cell is executed as if it was a script. An example should clarify this:: |
|
345 | 345 | |
|
346 | 346 | In [3]: x=1 # Hit C-Enter here |
|
347 | 347 | ...: y=2 # from now on, regular Enter is sufficient |
|
348 | 348 | ...: z=3 |
|
349 | 349 | ...: x**2 # This does *not* produce an Out[] value |
|
350 | 350 | ...: x+y+z # Only the last expression does |
|
351 | 351 | ...: |
|
352 | 352 | Out[3]: 6 |
|
353 | 353 | |
|
354 | 354 | The behavior where an extra blank line forces execution is only active if you |
|
355 | 355 | are actually typing at the keyboard each line, and is meant to make it mimic |
|
356 | 356 | the IPython terminal behavior. If you paste a long chunk of input (for example |
|
357 | 357 | a long script copied form an editor or web browser), it can contain arbitrarily |
|
358 | 358 | many intermediate blank lines and they won't cause any problems. As always, |
|
359 | 359 | you can then make it execute by appending a blank line *at the end* or hitting |
|
360 | 360 | ``Shift-Enter`` anywhere within the cell. |
|
361 | 361 | |
|
362 | 362 | With the up arrow key, you can retrieve previous blocks of input that contain |
|
363 | 363 | multiple lines. You can move inside of a multiline cell like you would in any |
|
364 | 364 | text editor. When you want it executed, the simplest thing to do is to hit the |
|
365 | 365 | force execution key, ``Shift-Enter`` (though you can also navigate to the end |
|
366 | 366 | and append a blank line by using ``Enter`` twice). |
|
367 | 367 | |
|
368 | 368 | If you've edited a multiline cell and accidentally navigate out of it with the |
|
369 | 369 | up or down arrow keys, IPython will clear the cell and replace it with the |
|
370 | 370 | contents of the one above or below that you navigated to. If this was an |
|
371 | 371 | accident and you want to retrieve the cell you were editing, use the Undo |
|
372 | 372 | keybinding, ``Control-z``. |
|
373 | 373 | |
|
374 | 374 | |
|
375 | 375 | Key bindings |
|
376 | 376 | ============ |
|
377 | 377 | |
|
378 | 378 | The IPython console supports most of the basic Emacs line-oriented keybindings, |
|
379 | 379 | in addition to some of its own. |
|
380 | 380 | |
|
381 | 381 | The keybinding prefixes mean: |
|
382 | 382 | |
|
383 | 383 | - ``C``: Control |
|
384 | 384 | - ``S``: Shift |
|
385 | 385 | - ``M``: Meta (typically the Alt key) |
|
386 | 386 | |
|
387 | 387 | The keybindings themselves are: |
|
388 | 388 | |
|
389 | 389 | - ``Enter``: insert new line (may cause execution, see above). |
|
390 | 390 | - ``C-Enter``: force new line, *never* causes execution. |
|
391 | 391 | - ``S-Enter``: *force* execution regardless of where cursor is, no newline added. |
|
392 | 392 | - ``C-c``: copy highlighted text to clipboard (prompts are automatically stripped). |
|
393 | 393 | - ``C-S-c``: copy highlighted text to clipboard (prompts are not stripped). |
|
394 | 394 | - ``C-v``: paste text from clipboard. |
|
395 | 395 | - ``C-z``: undo (retrieves lost text if you move out of a cell with the arrows). |
|
396 | 396 | - ``C-S-z``: redo. |
|
397 | 397 | - ``C-o``: move to 'other' area, between pager and terminal. |
|
398 | 398 | - ``C-l``: clear terminal. |
|
399 | 399 | - ``C-a``: go to beginning of line. |
|
400 | 400 | - ``C-e``: go to end of line. |
|
401 | 401 | - ``C-k``: kill from cursor to the end of the line. |
|
402 | 402 | - ``C-y``: yank (paste) |
|
403 | 403 | - ``C-p``: previous line (like up arrow) |
|
404 | 404 | - ``C-n``: next line (like down arrow) |
|
405 | 405 | - ``C-f``: forward (like right arrow) |
|
406 | 406 | - ``C-b``: back (like left arrow) |
|
407 | 407 | - ``C-d``: delete next character. |
|
408 | 408 | - ``M-<``: move to the beginning of the input region. |
|
409 | 409 | - ``M->``: move to the end of the input region. |
|
410 | 410 | - ``M-d``: delete next word. |
|
411 | 411 | - ``M-Backspace``: delete previous word. |
|
412 | 412 | - ``C-.``: force a kernel restart (a confirmation dialog appears). |
|
413 | 413 | - ``C-+``: increase font size. |
|
414 | 414 | - ``C--``: decrease font size. |
|
415 | 415 | |
|
416 | 416 | The IPython pager |
|
417 | 417 | ================= |
|
418 | 418 | |
|
419 | 419 | IPython will show long blocks of text from many sources using a builtin pager. |
|
420 | 420 | You can control where this pager appears with the ``--paging`` command-line |
|
421 | 421 | flag: |
|
422 | 422 | |
|
423 | 423 | - ``inside`` [default]: the pager is overlaid on top of the main terminal. You |
|
424 | 424 | must quit the pager to get back to the terminal (similar to how a pager such |
|
425 | 425 | as ``less`` or ``more`` works). |
|
426 | 426 | |
|
427 | 427 | - ``vsplit``: the console is made double-tall, and the pager appears on the |
|
428 | 428 | bottom area when needed. You can view its contents while using the terminal. |
|
429 | 429 | |
|
430 | 430 | - ``hsplit``: the console is made double-wide, and the pager appears on the |
|
431 | 431 | right area when needed. You can view its contents while using the terminal. |
|
432 | 432 | |
|
433 | 433 | - ``none``: the console never pages output. |
|
434 | 434 | |
|
435 | 435 | If you use the vertical or horizontal paging modes, you can navigate between |
|
436 | 436 | terminal and pager as follows: |
|
437 | 437 | |
|
438 | 438 | - Tab key: goes from pager to terminal (but not the other way around). |
|
439 | 439 | - Control-o: goes from one to another always. |
|
440 | 440 | - Mouse: click on either. |
|
441 | 441 | |
|
442 | 442 | In all cases, the ``q`` or ``Escape`` keys quit the pager (when used with the |
|
443 | 443 | focus on the pager area). |
|
444 | 444 | |
|
445 | 445 | Running subprocesses |
|
446 | 446 | ==================== |
|
447 | 447 | |
|
448 | 448 | The graphical IPython console uses the ``pexpect`` module to run subprocesses |
|
449 | 449 | when you type ``!command``. This has a number of advantages (true asynchronous |
|
450 | 450 | output from subprocesses as well as very robust termination of rogue |
|
451 | 451 | subprocesses with ``Control-C``), as well as some limitations. The main |
|
452 | 452 | limitation is that you can *not* interact back with the subprocess, so anything |
|
453 | 453 | that invokes a pager or expects you to type input into it will block and hang |
|
454 | 454 | (you can kill it with ``Control-C``). |
|
455 | 455 | |
|
456 | 456 | We have provided as magics ``%less`` to page files (aliased to ``%more``), |
|
457 | 457 | ``%clear`` to clear the terminal, and ``%man`` on Linux/OSX. These cover the |
|
458 | 458 | most common commands you'd want to call in your subshell and that would cause |
|
459 | 459 | problems if invoked via ``!cmd``, but you need to be aware of this limitation. |
|
460 | 460 | |
|
461 | 461 | Display |
|
462 | 462 | ======= |
|
463 | 463 | |
|
464 | 464 | The IPython console can now display objects in a variety of formats, including |
|
465 | 465 | HTML, PNG and SVG. This is accomplished using the display functions in |
|
466 | 466 | ``IPython.core.display``:: |
|
467 | 467 | |
|
468 | 468 | In [4]: from IPython.core.display import display, display_html |
|
469 | 469 | |
|
470 | 470 | In [5]: from IPython.core.display import display_png, display_svg |
|
471 | 471 | |
|
472 | 472 | Python objects can simply be passed to these functions and the appropriate |
|
473 | 473 | representations will be displayed in the console as long as the objects know |
|
474 | 474 | how to compute those representations. The easiest way of teaching objects how |
|
475 | 475 | to format themselves in various representations is to define special methods |
|
476 | 476 | such as: ``_repr_html_``, ``_repr_svg_`` and ``_repr_png_``. IPython's display formatters |
|
477 | 477 | can also be given custom formatter functions for various types:: |
|
478 | 478 | |
|
479 | 479 | In [6]: ip = get_ipython() |
|
480 | 480 | |
|
481 | 481 | In [7]: html_formatter = ip.display_formatter.formatters['text/html'] |
|
482 | 482 | |
|
483 | 483 | In [8]: html_formatter.for_type(Foo, foo_to_html) |
|
484 | 484 | |
|
485 | 485 | For further details, see ``IPython.core.formatters``. |
|
486 | 486 | |
|
487 | 487 | Inline matplotlib graphics |
|
488 | 488 | ========================== |
|
489 | 489 | |
|
490 | 490 | The IPython console is capable of displaying matplotlib figures inline, in SVG |
|
491 | 491 | or PNG format. If started with the ``pylab=inline``, then all figures are |
|
492 | 492 | rendered inline automatically (PNG by default). If started with ``--pylab`` |
|
493 | 493 | or ``pylab=<your backend>``, then a GUI backend will be used, but IPython's |
|
494 | 494 | ``display()`` and ``getfigs()`` functions can be used to view plots inline:: |
|
495 | 495 | |
|
496 | 496 | In [9]: display(*getfigs()) # display all figures inline |
|
497 | 497 | |
|
498 | 498 | In[10]: display(*getfigs(1,2)) # display figures 1 and 2 inline |
|
499 | 499 | """ |
|
500 | 500 | |
|
501 | 501 | |
|
502 | 502 | quick_guide = """\ |
|
503 | 503 | ? -> Introduction and overview of IPython's features. |
|
504 | 504 | %quickref -> Quick reference. |
|
505 | 505 | help -> Python's own help system. |
|
506 | 506 | object? -> Details about 'object', use 'object??' for extra details. |
|
507 | 507 | """ |
|
508 | 508 | |
|
509 | 509 | gui_note = """\ |
|
510 | 510 | %guiref -> A brief reference about the graphical user interface. |
|
511 | 511 | """ |
|
512 | 512 | |
|
513 | 513 | default_banner_parts = [ |
|
514 | 514 | 'Python %s\n' % (sys.version.split('\n')[0],), |
|
515 | 515 | 'Type "copyright", "credits" or "license" for more information.\n\n', |
|
516 | 516 | 'IPython %s -- An enhanced Interactive Python.\n' % (release.version,), |
|
517 | 517 | quick_guide |
|
518 | 518 | ] |
|
519 | 519 | |
|
520 | 520 | default_gui_banner_parts = default_banner_parts + [gui_note] |
|
521 | 521 | |
|
522 | 522 | default_banner = ''.join(default_banner_parts) |
|
523 | 523 | |
|
524 | 524 | default_gui_banner = ''.join(default_gui_banner_parts) |
@@ -1,439 +1,440 b'' | |||
|
1 | 1 | #!/usr/bin/env python |
|
2 | 2 | """Module for interactively running scripts. |
|
3 | 3 | |
|
4 | 4 | This module implements classes for interactively running scripts written for |
|
5 | 5 | any system with a prompt which can be matched by a regexp suitable for |
|
6 | 6 | pexpect. It can be used to run as if they had been typed up interactively, an |
|
7 | 7 | arbitrary series of commands for the target system. |
|
8 | 8 | |
|
9 | 9 | The module includes classes ready for IPython (with the default prompts), |
|
10 | 10 | plain Python and SAGE, but making a new one is trivial. To see how to use it, |
|
11 | 11 | simply run the module as a script: |
|
12 | 12 | |
|
13 | 13 | ./irunner.py --help |
|
14 | 14 | |
|
15 | 15 | |
|
16 | 16 | This is an extension of Ken Schutte <kschutte-AT-csail.mit.edu>'s script |
|
17 | 17 | contributed on the ipython-user list: |
|
18 | 18 | |
|
19 | 19 | http://mail.scipy.org/pipermail/ipython-user/2006-May/003539.html |
|
20 | 20 | |
|
21 | 21 | |
|
22 | 22 | NOTES: |
|
23 | 23 | |
|
24 | 24 | - This module requires pexpect, available in most linux distros, or which can |
|
25 | 25 | be downloaded from |
|
26 | 26 | |
|
27 | 27 | http://pexpect.sourceforge.net |
|
28 | 28 | |
|
29 | 29 | - Because pexpect only works under Unix or Windows-Cygwin, this has the same |
|
30 | 30 | limitations. This means that it will NOT work under native windows Python. |
|
31 | 31 | """ |
|
32 | 32 | |
|
33 | 33 | # Stdlib imports |
|
34 | 34 | import optparse |
|
35 | 35 | import os |
|
36 | 36 | import sys |
|
37 | 37 | |
|
38 | 38 | # Third-party modules: we carry a copy of pexpect to reduce the need for |
|
39 | 39 | # external dependencies, but our import checks for a system version first. |
|
40 | 40 | from IPython.external import pexpect |
|
41 | 41 | |
|
42 | 42 | # Global usage strings, to avoid indentation issues when typing it below. |
|
43 | 43 | USAGE = """ |
|
44 | 44 | Interactive script runner, type: %s |
|
45 | 45 | |
|
46 | 46 | runner [opts] script_name |
|
47 | 47 | """ |
|
48 | 48 | |
|
49 | 49 | def pexpect_monkeypatch(): |
|
50 | 50 | """Patch pexpect to prevent unhandled exceptions at VM teardown. |
|
51 | 51 | |
|
52 | 52 | Calling this function will monkeypatch the pexpect.spawn class and modify |
|
53 | 53 | its __del__ method to make it more robust in the face of failures that can |
|
54 | 54 | occur if it is called when the Python VM is shutting down. |
|
55 | 55 | |
|
56 | 56 | Since Python may fire __del__ methods arbitrarily late, it's possible for |
|
57 | 57 | them to execute during the teardown of the Python VM itself. At this |
|
58 | 58 | point, various builtin modules have been reset to None. Thus, the call to |
|
59 | 59 | self.close() will trigger an exception because it tries to call os.close(), |
|
60 | 60 | and os is now None. |
|
61 | 61 | """ |
|
62 | 62 | |
|
63 | 63 | if pexpect.__version__[:3] >= '2.2': |
|
64 | 64 | # No need to patch, fix is already the upstream version. |
|
65 | 65 | return |
|
66 | 66 | |
|
67 | 67 | def __del__(self): |
|
68 | 68 | """This makes sure that no system resources are left open. |
|
69 | 69 | Python only garbage collects Python objects. OS file descriptors |
|
70 | 70 | are not Python objects, so they must be handled explicitly. |
|
71 | 71 | If the child file descriptor was opened outside of this class |
|
72 | 72 | (passed to the constructor) then this does not close it. |
|
73 | 73 | """ |
|
74 | 74 | if not self.closed: |
|
75 | 75 | try: |
|
76 | 76 | self.close() |
|
77 | 77 | except AttributeError: |
|
78 | 78 | pass |
|
79 | 79 | |
|
80 | 80 | pexpect.spawn.__del__ = __del__ |
|
81 | 81 | |
|
82 | 82 | pexpect_monkeypatch() |
|
83 | 83 | |
|
84 | 84 | # The generic runner class |
|
85 | 85 | class InteractiveRunner(object): |
|
86 | 86 | """Class to run a sequence of commands through an interactive program.""" |
|
87 | 87 | |
|
88 | 88 | def __init__(self,program,prompts,args=None,out=sys.stdout,echo=True): |
|
89 | 89 | """Construct a runner. |
|
90 | 90 | |
|
91 | 91 | Inputs: |
|
92 | 92 | |
|
93 | 93 | - program: command to execute the given program. |
|
94 | 94 | |
|
95 | 95 | - prompts: a list of patterns to match as valid prompts, in the |
|
96 | 96 | format used by pexpect. This basically means that it can be either |
|
97 | 97 | a string (to be compiled as a regular expression) or a list of such |
|
98 | 98 | (it must be a true list, as pexpect does type checks). |
|
99 | 99 | |
|
100 | 100 | If more than one prompt is given, the first is treated as the main |
|
101 | 101 | program prompt and the others as 'continuation' prompts, like |
|
102 | 102 | python's. This means that blank lines in the input source are |
|
103 | 103 | ommitted when the first prompt is matched, but are NOT ommitted when |
|
104 | 104 | the continuation one matches, since this is how python signals the |
|
105 | 105 | end of multiline input interactively. |
|
106 | 106 | |
|
107 | 107 | Optional inputs: |
|
108 | 108 | |
|
109 | 109 | - args(None): optional list of strings to pass as arguments to the |
|
110 | 110 | child program. |
|
111 | 111 | |
|
112 | 112 | - out(sys.stdout): if given, an output stream to be used when writing |
|
113 | 113 | output. The only requirement is that it must have a .write() method. |
|
114 | 114 | |
|
115 | 115 | Public members not parameterized in the constructor: |
|
116 | 116 | |
|
117 | 117 | - delaybeforesend(0): Newer versions of pexpect have a delay before |
|
118 | 118 | sending each new input. For our purposes here, it's typically best |
|
119 | 119 | to just set this to zero, but if you encounter reliability problems |
|
120 | 120 | or want an interactive run to pause briefly at each prompt, just |
|
121 | 121 | increase this value (it is measured in seconds). Note that this |
|
122 | 122 | variable is not honored at all by older versions of pexpect. |
|
123 | 123 | """ |
|
124 | 124 | |
|
125 | 125 | self.program = program |
|
126 | 126 | self.prompts = prompts |
|
127 | 127 | if args is None: args = [] |
|
128 | 128 | self.args = args |
|
129 | 129 | self.out = out |
|
130 | 130 | self.echo = echo |
|
131 | 131 | # Other public members which we don't make as parameters, but which |
|
132 | 132 | # users may occasionally want to tweak |
|
133 | 133 | self.delaybeforesend = 0 |
|
134 | 134 | |
|
135 | 135 | # Create child process and hold on to it so we don't have to re-create |
|
136 | 136 | # for every single execution call |
|
137 | 137 | c = self.child = pexpect.spawn(self.program,self.args,timeout=None) |
|
138 | 138 | c.delaybeforesend = self.delaybeforesend |
|
139 | 139 | # pexpect hard-codes the terminal size as (24,80) (rows,columns). |
|
140 | 140 | # This causes problems because any line longer than 80 characters gets |
|
141 | 141 | # completely overwrapped on the printed outptut (even though |
|
142 | 142 | # internally the code runs fine). We reset this to 99 rows X 200 |
|
143 | 143 | # columns (arbitrarily chosen), which should avoid problems in all |
|
144 | 144 | # reasonable cases. |
|
145 | 145 | c.setwinsize(99,200) |
|
146 | 146 | |
|
147 | 147 | def close(self): |
|
148 | 148 | """close child process""" |
|
149 | 149 | |
|
150 | 150 | self.child.close() |
|
151 | 151 | |
|
152 | 152 | def run_file(self,fname,interact=False,get_output=False): |
|
153 | 153 | """Run the given file interactively. |
|
154 | 154 | |
|
155 | 155 | Inputs: |
|
156 | 156 | |
|
157 | 157 | -fname: name of the file to execute. |
|
158 | 158 | |
|
159 | 159 | See the run_source docstring for the meaning of the optional |
|
160 | 160 | arguments.""" |
|
161 | 161 | |
|
162 | 162 | fobj = open(fname,'r') |
|
163 | 163 | try: |
|
164 | 164 | out = self.run_source(fobj,interact,get_output) |
|
165 | 165 | finally: |
|
166 | 166 | fobj.close() |
|
167 | 167 | if get_output: |
|
168 | 168 | return out |
|
169 | 169 | |
|
170 | 170 | def run_source(self,source,interact=False,get_output=False): |
|
171 | 171 | """Run the given source code interactively. |
|
172 | 172 | |
|
173 | 173 | Inputs: |
|
174 | 174 | |
|
175 | 175 | - source: a string of code to be executed, or an open file object we |
|
176 | 176 | can iterate over. |
|
177 | 177 | |
|
178 | 178 | Optional inputs: |
|
179 | 179 | |
|
180 | 180 | - interact(False): if true, start to interact with the running |
|
181 | 181 | program at the end of the script. Otherwise, just exit. |
|
182 | 182 | |
|
183 | 183 | - get_output(False): if true, capture the output of the child process |
|
184 | 184 | (filtering the input commands out) and return it as a string. |
|
185 | 185 | |
|
186 | 186 | Returns: |
|
187 | 187 | A string containing the process output, but only if requested. |
|
188 | 188 | """ |
|
189 | 189 | |
|
190 | 190 | # if the source is a string, chop it up in lines so we can iterate |
|
191 | 191 | # over it just as if it were an open file. |
|
192 | 192 | if not isinstance(source,file): |
|
193 | 193 | source = source.splitlines(True) |
|
194 | 194 | |
|
195 | 195 | if self.echo: |
|
196 | 196 | # normalize all strings we write to use the native OS line |
|
197 | 197 | # separators. |
|
198 | 198 | linesep = os.linesep |
|
199 | 199 | stdwrite = self.out.write |
|
200 | 200 | write = lambda s: stdwrite(s.replace('\r\n',linesep)) |
|
201 | 201 | else: |
|
202 | 202 | # Quiet mode, all writes are no-ops |
|
203 | 203 | write = lambda s: None |
|
204 | 204 | |
|
205 | 205 | c = self.child |
|
206 | 206 | prompts = c.compile_pattern_list(self.prompts) |
|
207 | 207 | prompt_idx = c.expect_list(prompts) |
|
208 | 208 | |
|
209 | 209 | # Flag whether the script ends normally or not, to know whether we can |
|
210 | 210 | # do anything further with the underlying process. |
|
211 | 211 | end_normal = True |
|
212 | 212 | |
|
213 | 213 | # If the output was requested, store it in a list for return at the end |
|
214 | 214 | if get_output: |
|
215 | 215 | output = [] |
|
216 | 216 | store_output = output.append |
|
217 | 217 | |
|
218 | 218 | for cmd in source: |
|
219 | 219 | # skip blank lines for all matches to the 'main' prompt, while the |
|
220 | 220 | # secondary prompts do not |
|
221 | 221 | if prompt_idx==0 and \ |
|
222 | 222 | (cmd.isspace() or cmd.lstrip().startswith('#')): |
|
223 | 223 | write(cmd) |
|
224 | 224 | continue |
|
225 | 225 | |
|
226 | 226 | # write('AFTER: '+c.after) # dbg |
|
227 | 227 | write(c.after) |
|
228 | 228 | c.send(cmd) |
|
229 | 229 | try: |
|
230 | 230 | prompt_idx = c.expect_list(prompts) |
|
231 | 231 | except pexpect.EOF: |
|
232 | 232 | # this will happen if the child dies unexpectedly |
|
233 | 233 | write(c.before) |
|
234 | 234 | end_normal = False |
|
235 | 235 | break |
|
236 | 236 | |
|
237 | 237 | write(c.before) |
|
238 | 238 | |
|
239 | 239 | # With an echoing process, the output we get in c.before contains |
|
240 | 240 | # the command sent, a newline, and then the actual process output |
|
241 | 241 | if get_output: |
|
242 | 242 | store_output(c.before[len(cmd+'\n'):]) |
|
243 | 243 | #write('CMD: <<%s>>' % cmd) # dbg |
|
244 | 244 | #write('OUTPUT: <<%s>>' % output[-1]) # dbg |
|
245 | 245 | |
|
246 | 246 | self.out.flush() |
|
247 | 247 | if end_normal: |
|
248 | 248 | if interact: |
|
249 | 249 | c.send('\n') |
|
250 | 250 | print '<< Starting interactive mode >>', |
|
251 | 251 | try: |
|
252 | 252 | c.interact() |
|
253 | 253 | except OSError: |
|
254 | 254 | # This is what fires when the child stops. Simply print a |
|
255 | 255 | # newline so the system prompt is aligned. The extra |
|
256 | 256 | # space is there to make sure it gets printed, otherwise |
|
257 | 257 | # OS buffering sometimes just suppresses it. |
|
258 | 258 | write(' \n') |
|
259 | 259 | self.out.flush() |
|
260 | 260 | else: |
|
261 | 261 | if interact: |
|
262 | 262 | e="Further interaction is not possible: child process is dead." |
|
263 | 263 | print >> sys.stderr, e |
|
264 | 264 | |
|
265 | 265 | # Leave the child ready for more input later on, otherwise select just |
|
266 | 266 | # hangs on the second invocation. |
|
267 | 267 | if c.isalive(): |
|
268 | 268 | c.send('\n') |
|
269 | 269 | |
|
270 | 270 | # Return any requested output |
|
271 | 271 | if get_output: |
|
272 | 272 | return ''.join(output) |
|
273 | 273 | |
|
274 | 274 | def main(self,argv=None): |
|
275 | 275 | """Run as a command-line script.""" |
|
276 | 276 | |
|
277 | 277 | parser = optparse.OptionParser(usage=USAGE % self.__class__.__name__) |
|
278 | 278 | newopt = parser.add_option |
|
279 | 279 | newopt('-i','--interact',action='store_true',default=False, |
|
280 | 280 | help='Interact with the program after the script is run.') |
|
281 | 281 | |
|
282 | 282 | opts,args = parser.parse_args(argv) |
|
283 | 283 | |
|
284 | 284 | if len(args) != 1: |
|
285 | 285 | print >> sys.stderr,"You must supply exactly one file to run." |
|
286 | 286 | sys.exit(1) |
|
287 | 287 | |
|
288 | 288 | self.run_file(args[0],opts.interact) |
|
289 | 289 | |
|
290 | 290 | |
|
291 | 291 | # Specific runners for particular programs |
|
292 | 292 | class IPythonRunner(InteractiveRunner): |
|
293 | 293 | """Interactive IPython runner. |
|
294 | 294 | |
|
295 | 295 | This initalizes IPython in 'nocolor' mode for simplicity. This lets us |
|
296 | 296 | avoid having to write a regexp that matches ANSI sequences, though pexpect |
|
297 | 297 | does support them. If anyone contributes patches for ANSI color support, |
|
298 | 298 | they will be welcome. |
|
299 | 299 | |
|
300 | 300 | It also sets the prompts manually, since the prompt regexps for |
|
301 | 301 | pexpect need to be matched to the actual prompts, so user-customized |
|
302 | 302 | prompts would break this. |
|
303 | 303 | """ |
|
304 | 304 | |
|
305 | 305 | def __init__(self,program = 'ipython',args=None,out=sys.stdout,echo=True): |
|
306 | 306 | """New runner, optionally passing the ipython command to use.""" |
|
307 | 307 | args0 = ['--colors=NoColor', |
|
308 | 308 | '--no-term-title', |
|
309 | 309 | '--no-autoindent', |
|
310 | 310 | # '--quick' is important, to prevent loading default config: |
|
311 | 311 | '--quick'] |
|
312 | 312 | if args is None: args = args0 |
|
313 | 313 | else: args = args0 + args |
|
314 | 314 | prompts = [r'In \[\d+\]: ',r' \.*: '] |
|
315 | 315 | InteractiveRunner.__init__(self,program,prompts,args,out,echo) |
|
316 | 316 | |
|
317 | 317 | |
|
318 | 318 | class PythonRunner(InteractiveRunner): |
|
319 | 319 | """Interactive Python runner.""" |
|
320 | 320 | |
|
321 | 321 | def __init__(self,program='python',args=None,out=sys.stdout,echo=True): |
|
322 | 322 | """New runner, optionally passing the python command to use.""" |
|
323 | 323 | |
|
324 | 324 | prompts = [r'>>> ',r'\.\.\. '] |
|
325 | 325 | InteractiveRunner.__init__(self,program,prompts,args,out,echo) |
|
326 | 326 | |
|
327 | 327 | |
|
328 | 328 | class SAGERunner(InteractiveRunner): |
|
329 | 329 | """Interactive SAGE runner. |
|
330 | 330 | |
|
331 |
WARNING: this runner only works if you manually |
|
|
332 | to use 'colors NoColor' in the ipythonrc config file, since currently the | |
|
333 |
prompt matching regexp does not identify |
|
|
331 | WARNING: this runner only works if you manually adjust your SAGE | |
|
332 | configuration so that the 'color' option in the configuration file is set to | |
|
333 | 'NoColor', because currently the prompt matching regexp does not identify | |
|
334 | color sequences.""" | |
|
334 | 335 | |
|
335 | 336 | def __init__(self,program='sage',args=None,out=sys.stdout,echo=True): |
|
336 | 337 | """New runner, optionally passing the sage command to use.""" |
|
337 | 338 | |
|
338 | 339 | prompts = ['sage: ',r'\s*\.\.\. '] |
|
339 | 340 | InteractiveRunner.__init__(self,program,prompts,args,out,echo) |
|
340 | 341 | |
|
341 | 342 | |
|
342 | 343 | class RunnerFactory(object): |
|
343 | 344 | """Code runner factory. |
|
344 | 345 | |
|
345 | 346 | This class provides an IPython code runner, but enforces that only one |
|
346 | 347 | runner is ever instantiated. The runner is created based on the extension |
|
347 | 348 | of the first file to run, and it raises an exception if a runner is later |
|
348 | 349 | requested for a different extension type. |
|
349 | 350 | |
|
350 | 351 | This ensures that we don't generate example files for doctest with a mix of |
|
351 | 352 | python and ipython syntax. |
|
352 | 353 | """ |
|
353 | 354 | |
|
354 | 355 | def __init__(self,out=sys.stdout): |
|
355 | 356 | """Instantiate a code runner.""" |
|
356 | 357 | |
|
357 | 358 | self.out = out |
|
358 | 359 | self.runner = None |
|
359 | 360 | self.runnerClass = None |
|
360 | 361 | |
|
361 | 362 | def _makeRunner(self,runnerClass): |
|
362 | 363 | self.runnerClass = runnerClass |
|
363 | 364 | self.runner = runnerClass(out=self.out) |
|
364 | 365 | return self.runner |
|
365 | 366 | |
|
366 | 367 | def __call__(self,fname): |
|
367 | 368 | """Return a runner for the given filename.""" |
|
368 | 369 | |
|
369 | 370 | if fname.endswith('.py'): |
|
370 | 371 | runnerClass = PythonRunner |
|
371 | 372 | elif fname.endswith('.ipy'): |
|
372 | 373 | runnerClass = IPythonRunner |
|
373 | 374 | else: |
|
374 | 375 | raise ValueError('Unknown file type for Runner: %r' % fname) |
|
375 | 376 | |
|
376 | 377 | if self.runner is None: |
|
377 | 378 | return self._makeRunner(runnerClass) |
|
378 | 379 | else: |
|
379 | 380 | if runnerClass==self.runnerClass: |
|
380 | 381 | return self.runner |
|
381 | 382 | else: |
|
382 | 383 | e='A runner of type %r can not run file %r' % \ |
|
383 | 384 | (self.runnerClass,fname) |
|
384 | 385 | raise ValueError(e) |
|
385 | 386 | |
|
386 | 387 | |
|
387 | 388 | # Global usage string, to avoid indentation issues if typed in a function def. |
|
388 | 389 | MAIN_USAGE = """ |
|
389 | 390 | %prog [options] file_to_run |
|
390 | 391 | |
|
391 | 392 | This is an interface to the various interactive runners available in this |
|
392 | 393 | module. If you want to pass specific options to one of the runners, you need |
|
393 | 394 | to first terminate the main options with a '--', and then provide the runner's |
|
394 | 395 | options. For example: |
|
395 | 396 | |
|
396 | 397 | irunner.py --python -- --help |
|
397 | 398 | |
|
398 | 399 | will pass --help to the python runner. Similarly, |
|
399 | 400 | |
|
400 | 401 | irunner.py --ipython -- --interact script.ipy |
|
401 | 402 | |
|
402 | 403 | will run the script.ipy file under the IPython runner, and then will start to |
|
403 | 404 | interact with IPython at the end of the script (instead of exiting). |
|
404 | 405 | |
|
405 | 406 | The already implemented runners are listed below; adding one for a new program |
|
406 | 407 | is a trivial task, see the source for examples. |
|
407 | 408 | """ |
|
408 | 409 | |
|
409 | 410 | def main(): |
|
410 | 411 | """Run as a command-line script.""" |
|
411 | 412 | |
|
412 | 413 | parser = optparse.OptionParser(usage=MAIN_USAGE) |
|
413 | 414 | newopt = parser.add_option |
|
414 | 415 | newopt('--ipython',action='store_const',dest='mode',const='ipython', |
|
415 | 416 | help='IPython interactive runner (default).') |
|
416 | 417 | newopt('--python',action='store_const',dest='mode',const='python', |
|
417 | 418 | help='Python interactive runner.') |
|
418 | 419 | newopt('--sage',action='store_const',dest='mode',const='sage', |
|
419 | 420 | help='SAGE interactive runner.') |
|
420 | 421 | |
|
421 | 422 | opts,args = parser.parse_args() |
|
422 | 423 | runners = dict(ipython=IPythonRunner, |
|
423 | 424 | python=PythonRunner, |
|
424 | 425 | sage=SAGERunner) |
|
425 | 426 | |
|
426 | 427 | try: |
|
427 | 428 | ext = os.path.splitext(args[0])[-1] |
|
428 | 429 | except IndexError: |
|
429 | 430 | ext = '' |
|
430 | 431 | modes = {'.ipy':'ipython', |
|
431 | 432 | '.py':'python', |
|
432 | 433 | '.sage':'sage'} |
|
433 | 434 | mode = modes.get(ext,"ipython") |
|
434 | 435 | if opts.mode: |
|
435 | 436 | mode = opts.mode |
|
436 | 437 | runners[mode]().main(args) |
|
437 | 438 | |
|
438 | 439 | if __name__ == '__main__': |
|
439 | 440 | main() |
@@ -1,793 +1,792 b'' | |||
|
1 | 1 | """Nose Plugin that supports IPython doctests. |
|
2 | 2 | |
|
3 | 3 | Limitations: |
|
4 | 4 | |
|
5 | 5 | - When generating examples for use as doctests, make sure that you have |
|
6 |
pretty-printing OFF. This can be done either by s |
|
|
7 | flag '--nopprint', by setting pprint to 0 in your ipythonrc file, or by | |
|
8 | interactively disabling it with %Pprint. This is required so that IPython | |
|
9 |
|
|
|
10 | execution. | |
|
6 | pretty-printing OFF. This can be done either by setting the 'pprint' option | |
|
7 | in your configuration file to 'False', or by interactively disabling it with | |
|
8 | %Pprint. This is required so that IPython output matches that of normal | |
|
9 | Python, which is used by doctest for internal execution. | |
|
11 | 10 | |
|
12 | 11 | - Do not rely on specific prompt numbers for results (such as using |
|
13 | 12 | '_34==True', for example). For IPython tests run via an external process the |
|
14 | 13 | prompt numbers may be different, and IPython tests run as normal python code |
|
15 | 14 | won't even have these special _NN variables set at all. |
|
16 | 15 | """ |
|
17 | 16 | |
|
18 | 17 | #----------------------------------------------------------------------------- |
|
19 | 18 | # Module imports |
|
20 | 19 | |
|
21 | 20 | # From the standard library |
|
22 | 21 | import __builtin__ |
|
23 | 22 | import commands |
|
24 | 23 | import doctest |
|
25 | 24 | import inspect |
|
26 | 25 | import logging |
|
27 | 26 | import os |
|
28 | 27 | import re |
|
29 | 28 | import sys |
|
30 | 29 | import traceback |
|
31 | 30 | import unittest |
|
32 | 31 | |
|
33 | 32 | from inspect import getmodule |
|
34 | 33 | from StringIO import StringIO |
|
35 | 34 | |
|
36 | 35 | # We are overriding the default doctest runner, so we need to import a few |
|
37 | 36 | # things from doctest directly |
|
38 | 37 | from doctest import (REPORTING_FLAGS, REPORT_ONLY_FIRST_FAILURE, |
|
39 | 38 | _unittest_reportflags, DocTestRunner, |
|
40 | 39 | _extract_future_flags, pdb, _OutputRedirectingPdb, |
|
41 | 40 | _exception_traceback, |
|
42 | 41 | linecache) |
|
43 | 42 | |
|
44 | 43 | # Third-party modules |
|
45 | 44 | import nose.core |
|
46 | 45 | |
|
47 | 46 | from nose.plugins import doctests, Plugin |
|
48 | 47 | from nose.util import anyp, getpackage, test_address, resolve_name, tolist |
|
49 | 48 | |
|
50 | 49 | #----------------------------------------------------------------------------- |
|
51 | 50 | # Module globals and other constants |
|
52 | 51 | #----------------------------------------------------------------------------- |
|
53 | 52 | |
|
54 | 53 | log = logging.getLogger(__name__) |
|
55 | 54 | |
|
56 | 55 | |
|
57 | 56 | #----------------------------------------------------------------------------- |
|
58 | 57 | # Classes and functions |
|
59 | 58 | #----------------------------------------------------------------------------- |
|
60 | 59 | |
|
61 | 60 | def is_extension_module(filename): |
|
62 | 61 | """Return whether the given filename is an extension module. |
|
63 | 62 | |
|
64 | 63 | This simply checks that the extension is either .so or .pyd. |
|
65 | 64 | """ |
|
66 | 65 | return os.path.splitext(filename)[1].lower() in ('.so','.pyd') |
|
67 | 66 | |
|
68 | 67 | |
|
69 | 68 | class DocTestSkip(object): |
|
70 | 69 | """Object wrapper for doctests to be skipped.""" |
|
71 | 70 | |
|
72 | 71 | ds_skip = """Doctest to skip. |
|
73 | 72 | >>> 1 #doctest: +SKIP |
|
74 | 73 | """ |
|
75 | 74 | |
|
76 | 75 | def __init__(self,obj): |
|
77 | 76 | self.obj = obj |
|
78 | 77 | |
|
79 | 78 | def __getattribute__(self,key): |
|
80 | 79 | if key == '__doc__': |
|
81 | 80 | return DocTestSkip.ds_skip |
|
82 | 81 | else: |
|
83 | 82 | return getattr(object.__getattribute__(self,'obj'),key) |
|
84 | 83 | |
|
85 | 84 | # Modified version of the one in the stdlib, that fixes a python bug (doctests |
|
86 | 85 | # not found in extension modules, http://bugs.python.org/issue3158) |
|
87 | 86 | class DocTestFinder(doctest.DocTestFinder): |
|
88 | 87 | |
|
89 | 88 | def _from_module(self, module, object): |
|
90 | 89 | """ |
|
91 | 90 | Return true if the given object is defined in the given |
|
92 | 91 | module. |
|
93 | 92 | """ |
|
94 | 93 | if module is None: |
|
95 | 94 | return True |
|
96 | 95 | elif inspect.isfunction(object): |
|
97 | 96 | return module.__dict__ is object.func_globals |
|
98 | 97 | elif inspect.isbuiltin(object): |
|
99 | 98 | return module.__name__ == object.__module__ |
|
100 | 99 | elif inspect.isclass(object): |
|
101 | 100 | return module.__name__ == object.__module__ |
|
102 | 101 | elif inspect.ismethod(object): |
|
103 | 102 | # This one may be a bug in cython that fails to correctly set the |
|
104 | 103 | # __module__ attribute of methods, but since the same error is easy |
|
105 | 104 | # to make by extension code writers, having this safety in place |
|
106 | 105 | # isn't such a bad idea |
|
107 | 106 | return module.__name__ == object.im_class.__module__ |
|
108 | 107 | elif inspect.getmodule(object) is not None: |
|
109 | 108 | return module is inspect.getmodule(object) |
|
110 | 109 | elif hasattr(object, '__module__'): |
|
111 | 110 | return module.__name__ == object.__module__ |
|
112 | 111 | elif isinstance(object, property): |
|
113 | 112 | return True # [XX] no way not be sure. |
|
114 | 113 | else: |
|
115 | 114 | raise ValueError("object must be a class or function") |
|
116 | 115 | |
|
117 | 116 | def _find(self, tests, obj, name, module, source_lines, globs, seen): |
|
118 | 117 | """ |
|
119 | 118 | Find tests for the given object and any contained objects, and |
|
120 | 119 | add them to `tests`. |
|
121 | 120 | """ |
|
122 | 121 | #print '_find for:', obj, name, module # dbg |
|
123 | 122 | if hasattr(obj,"skip_doctest"): |
|
124 | 123 | #print 'SKIPPING DOCTEST FOR:',obj # dbg |
|
125 | 124 | obj = DocTestSkip(obj) |
|
126 | 125 | |
|
127 | 126 | doctest.DocTestFinder._find(self,tests, obj, name, module, |
|
128 | 127 | source_lines, globs, seen) |
|
129 | 128 | |
|
130 | 129 | # Below we re-run pieces of the above method with manual modifications, |
|
131 | 130 | # because the original code is buggy and fails to correctly identify |
|
132 | 131 | # doctests in extension modules. |
|
133 | 132 | |
|
134 | 133 | # Local shorthands |
|
135 | 134 | from inspect import isroutine, isclass, ismodule |
|
136 | 135 | |
|
137 | 136 | # Look for tests in a module's contained objects. |
|
138 | 137 | if inspect.ismodule(obj) and self._recurse: |
|
139 | 138 | for valname, val in obj.__dict__.items(): |
|
140 | 139 | valname1 = '%s.%s' % (name, valname) |
|
141 | 140 | if ( (isroutine(val) or isclass(val)) |
|
142 | 141 | and self._from_module(module, val) ): |
|
143 | 142 | |
|
144 | 143 | self._find(tests, val, valname1, module, source_lines, |
|
145 | 144 | globs, seen) |
|
146 | 145 | |
|
147 | 146 | # Look for tests in a class's contained objects. |
|
148 | 147 | if inspect.isclass(obj) and self._recurse: |
|
149 | 148 | #print 'RECURSE into class:',obj # dbg |
|
150 | 149 | for valname, val in obj.__dict__.items(): |
|
151 | 150 | # Special handling for staticmethod/classmethod. |
|
152 | 151 | if isinstance(val, staticmethod): |
|
153 | 152 | val = getattr(obj, valname) |
|
154 | 153 | if isinstance(val, classmethod): |
|
155 | 154 | val = getattr(obj, valname).im_func |
|
156 | 155 | |
|
157 | 156 | # Recurse to methods, properties, and nested classes. |
|
158 | 157 | if ((inspect.isfunction(val) or inspect.isclass(val) or |
|
159 | 158 | inspect.ismethod(val) or |
|
160 | 159 | isinstance(val, property)) and |
|
161 | 160 | self._from_module(module, val)): |
|
162 | 161 | valname = '%s.%s' % (name, valname) |
|
163 | 162 | self._find(tests, val, valname, module, source_lines, |
|
164 | 163 | globs, seen) |
|
165 | 164 | |
|
166 | 165 | |
|
167 | 166 | class IPDoctestOutputChecker(doctest.OutputChecker): |
|
168 | 167 | """Second-chance checker with support for random tests. |
|
169 | 168 | |
|
170 | 169 | If the default comparison doesn't pass, this checker looks in the expected |
|
171 | 170 | output string for flags that tell us to ignore the output. |
|
172 | 171 | """ |
|
173 | 172 | |
|
174 | 173 | random_re = re.compile(r'#\s*random\s+') |
|
175 | 174 | |
|
176 | 175 | def check_output(self, want, got, optionflags): |
|
177 | 176 | """Check output, accepting special markers embedded in the output. |
|
178 | 177 | |
|
179 | 178 | If the output didn't pass the default validation but the special string |
|
180 | 179 | '#random' is included, we accept it.""" |
|
181 | 180 | |
|
182 | 181 | # Let the original tester verify first, in case people have valid tests |
|
183 | 182 | # that happen to have a comment saying '#random' embedded in. |
|
184 | 183 | ret = doctest.OutputChecker.check_output(self, want, got, |
|
185 | 184 | optionflags) |
|
186 | 185 | if not ret and self.random_re.search(want): |
|
187 | 186 | #print >> sys.stderr, 'RANDOM OK:',want # dbg |
|
188 | 187 | return True |
|
189 | 188 | |
|
190 | 189 | return ret |
|
191 | 190 | |
|
192 | 191 | |
|
193 | 192 | class DocTestCase(doctests.DocTestCase): |
|
194 | 193 | """Proxy for DocTestCase: provides an address() method that |
|
195 | 194 | returns the correct address for the doctest case. Otherwise |
|
196 | 195 | acts as a proxy to the test case. To provide hints for address(), |
|
197 | 196 | an obj may also be passed -- this will be used as the test object |
|
198 | 197 | for purposes of determining the test address, if it is provided. |
|
199 | 198 | """ |
|
200 | 199 | |
|
201 | 200 | # Note: this method was taken from numpy's nosetester module. |
|
202 | 201 | |
|
203 | 202 | # Subclass nose.plugins.doctests.DocTestCase to work around a bug in |
|
204 | 203 | # its constructor that blocks non-default arguments from being passed |
|
205 | 204 | # down into doctest.DocTestCase |
|
206 | 205 | |
|
207 | 206 | def __init__(self, test, optionflags=0, setUp=None, tearDown=None, |
|
208 | 207 | checker=None, obj=None, result_var='_'): |
|
209 | 208 | self._result_var = result_var |
|
210 | 209 | doctests.DocTestCase.__init__(self, test, |
|
211 | 210 | optionflags=optionflags, |
|
212 | 211 | setUp=setUp, tearDown=tearDown, |
|
213 | 212 | checker=checker) |
|
214 | 213 | # Now we must actually copy the original constructor from the stdlib |
|
215 | 214 | # doctest class, because we can't call it directly and a bug in nose |
|
216 | 215 | # means it never gets passed the right arguments. |
|
217 | 216 | |
|
218 | 217 | self._dt_optionflags = optionflags |
|
219 | 218 | self._dt_checker = checker |
|
220 | 219 | self._dt_test = test |
|
221 | 220 | self._dt_test_globs_ori = test.globs |
|
222 | 221 | self._dt_setUp = setUp |
|
223 | 222 | self._dt_tearDown = tearDown |
|
224 | 223 | |
|
225 | 224 | # XXX - store this runner once in the object! |
|
226 | 225 | runner = IPDocTestRunner(optionflags=optionflags, |
|
227 | 226 | checker=checker, verbose=False) |
|
228 | 227 | self._dt_runner = runner |
|
229 | 228 | |
|
230 | 229 | |
|
231 | 230 | # Each doctest should remember the directory it was loaded from, so |
|
232 | 231 | # things like %run work without too many contortions |
|
233 | 232 | self._ori_dir = os.path.dirname(test.filename) |
|
234 | 233 | |
|
235 | 234 | # Modified runTest from the default stdlib |
|
236 | 235 | def runTest(self): |
|
237 | 236 | test = self._dt_test |
|
238 | 237 | runner = self._dt_runner |
|
239 | 238 | |
|
240 | 239 | old = sys.stdout |
|
241 | 240 | new = StringIO() |
|
242 | 241 | optionflags = self._dt_optionflags |
|
243 | 242 | |
|
244 | 243 | if not (optionflags & REPORTING_FLAGS): |
|
245 | 244 | # The option flags don't include any reporting flags, |
|
246 | 245 | # so add the default reporting flags |
|
247 | 246 | optionflags |= _unittest_reportflags |
|
248 | 247 | |
|
249 | 248 | try: |
|
250 | 249 | # Save our current directory and switch out to the one where the |
|
251 | 250 | # test was originally created, in case another doctest did a |
|
252 | 251 | # directory change. We'll restore this in the finally clause. |
|
253 | 252 | curdir = os.getcwdu() |
|
254 | 253 | #print 'runTest in dir:', self._ori_dir # dbg |
|
255 | 254 | os.chdir(self._ori_dir) |
|
256 | 255 | |
|
257 | 256 | runner.DIVIDER = "-"*70 |
|
258 | 257 | failures, tries = runner.run(test,out=new.write, |
|
259 | 258 | clear_globs=False) |
|
260 | 259 | finally: |
|
261 | 260 | sys.stdout = old |
|
262 | 261 | os.chdir(curdir) |
|
263 | 262 | |
|
264 | 263 | if failures: |
|
265 | 264 | raise self.failureException(self.format_failure(new.getvalue())) |
|
266 | 265 | |
|
267 | 266 | def setUp(self): |
|
268 | 267 | """Modified test setup that syncs with ipython namespace""" |
|
269 | 268 | #print "setUp test", self._dt_test.examples # dbg |
|
270 | 269 | if isinstance(self._dt_test.examples[0],IPExample): |
|
271 | 270 | # for IPython examples *only*, we swap the globals with the ipython |
|
272 | 271 | # namespace, after updating it with the globals (which doctest |
|
273 | 272 | # fills with the necessary info from the module being tested). |
|
274 | 273 | _ip.user_ns.update(self._dt_test.globs) |
|
275 | 274 | self._dt_test.globs = _ip.user_ns |
|
276 | 275 | # IPython must protect the _ key in the namespace (it can't exist) |
|
277 | 276 | # so that Python's doctest code sets it naturally, so we enable |
|
278 | 277 | # this feature of our testing namespace. |
|
279 | 278 | _ip.user_ns.protect_underscore = True |
|
280 | 279 | |
|
281 | 280 | super(DocTestCase, self).setUp() |
|
282 | 281 | |
|
283 | 282 | def tearDown(self): |
|
284 | 283 | |
|
285 | 284 | # Undo the test.globs reassignment we made, so that the parent class |
|
286 | 285 | # teardown doesn't destroy the ipython namespace |
|
287 | 286 | if isinstance(self._dt_test.examples[0],IPExample): |
|
288 | 287 | self._dt_test.globs = self._dt_test_globs_ori |
|
289 | 288 | # Restore the behavior of the '_' key in the user namespace to |
|
290 | 289 | # normal after each doctest, so that unittests behave normally |
|
291 | 290 | _ip.user_ns.protect_underscore = False |
|
292 | 291 | |
|
293 | 292 | # XXX - fperez: I am not sure if this is truly a bug in nose 0.11, but |
|
294 | 293 | # it does look like one to me: its tearDown method tries to run |
|
295 | 294 | # |
|
296 | 295 | # delattr(__builtin__, self._result_var) |
|
297 | 296 | # |
|
298 | 297 | # without checking that the attribute really is there; it implicitly |
|
299 | 298 | # assumes it should have been set via displayhook. But if the |
|
300 | 299 | # displayhook was never called, this doesn't necessarily happen. I |
|
301 | 300 | # haven't been able to find a little self-contained example outside of |
|
302 | 301 | # ipython that would show the problem so I can report it to the nose |
|
303 | 302 | # team, but it does happen a lot in our code. |
|
304 | 303 | # |
|
305 | 304 | # So here, we just protect as narrowly as possible by trapping an |
|
306 | 305 | # attribute error whose message would be the name of self._result_var, |
|
307 | 306 | # and letting any other error propagate. |
|
308 | 307 | try: |
|
309 | 308 | super(DocTestCase, self).tearDown() |
|
310 | 309 | except AttributeError, exc: |
|
311 | 310 | if exc.args[0] != self._result_var: |
|
312 | 311 | raise |
|
313 | 312 | |
|
314 | 313 | |
|
315 | 314 | # A simple subclassing of the original with a different class name, so we can |
|
316 | 315 | # distinguish and treat differently IPython examples from pure python ones. |
|
317 | 316 | class IPExample(doctest.Example): pass |
|
318 | 317 | |
|
319 | 318 | |
|
320 | 319 | class IPExternalExample(doctest.Example): |
|
321 | 320 | """Doctest examples to be run in an external process.""" |
|
322 | 321 | |
|
323 | 322 | def __init__(self, source, want, exc_msg=None, lineno=0, indent=0, |
|
324 | 323 | options=None): |
|
325 | 324 | # Parent constructor |
|
326 | 325 | doctest.Example.__init__(self,source,want,exc_msg,lineno,indent,options) |
|
327 | 326 | |
|
328 | 327 | # An EXTRA newline is needed to prevent pexpect hangs |
|
329 | 328 | self.source += '\n' |
|
330 | 329 | |
|
331 | 330 | |
|
332 | 331 | class IPDocTestParser(doctest.DocTestParser): |
|
333 | 332 | """ |
|
334 | 333 | A class used to parse strings containing doctest examples. |
|
335 | 334 | |
|
336 | 335 | Note: This is a version modified to properly recognize IPython input and |
|
337 | 336 | convert any IPython examples into valid Python ones. |
|
338 | 337 | """ |
|
339 | 338 | # This regular expression is used to find doctest examples in a |
|
340 | 339 | # string. It defines three groups: `source` is the source code |
|
341 | 340 | # (including leading indentation and prompts); `indent` is the |
|
342 | 341 | # indentation of the first (PS1) line of the source code; and |
|
343 | 342 | # `want` is the expected output (including leading indentation). |
|
344 | 343 | |
|
345 | 344 | # Classic Python prompts or default IPython ones |
|
346 | 345 | _PS1_PY = r'>>>' |
|
347 | 346 | _PS2_PY = r'\.\.\.' |
|
348 | 347 | |
|
349 | 348 | _PS1_IP = r'In\ \[\d+\]:' |
|
350 | 349 | _PS2_IP = r'\ \ \ \.\.\.+:' |
|
351 | 350 | |
|
352 | 351 | _RE_TPL = r''' |
|
353 | 352 | # Source consists of a PS1 line followed by zero or more PS2 lines. |
|
354 | 353 | (?P<source> |
|
355 | 354 | (?:^(?P<indent> [ ]*) (?P<ps1> %s) .*) # PS1 line |
|
356 | 355 | (?:\n [ ]* (?P<ps2> %s) .*)*) # PS2 lines |
|
357 | 356 | \n? # a newline |
|
358 | 357 | # Want consists of any non-blank lines that do not start with PS1. |
|
359 | 358 | (?P<want> (?:(?![ ]*$) # Not a blank line |
|
360 | 359 | (?![ ]*%s) # Not a line starting with PS1 |
|
361 | 360 | (?![ ]*%s) # Not a line starting with PS2 |
|
362 | 361 | .*$\n? # But any other line |
|
363 | 362 | )*) |
|
364 | 363 | ''' |
|
365 | 364 | |
|
366 | 365 | _EXAMPLE_RE_PY = re.compile( _RE_TPL % (_PS1_PY,_PS2_PY,_PS1_PY,_PS2_PY), |
|
367 | 366 | re.MULTILINE | re.VERBOSE) |
|
368 | 367 | |
|
369 | 368 | _EXAMPLE_RE_IP = re.compile( _RE_TPL % (_PS1_IP,_PS2_IP,_PS1_IP,_PS2_IP), |
|
370 | 369 | re.MULTILINE | re.VERBOSE) |
|
371 | 370 | |
|
372 | 371 | # Mark a test as being fully random. In this case, we simply append the |
|
373 | 372 | # random marker ('#random') to each individual example's output. This way |
|
374 | 373 | # we don't need to modify any other code. |
|
375 | 374 | _RANDOM_TEST = re.compile(r'#\s*all-random\s+') |
|
376 | 375 | |
|
377 | 376 | # Mark tests to be executed in an external process - currently unsupported. |
|
378 | 377 | _EXTERNAL_IP = re.compile(r'#\s*ipdoctest:\s*EXTERNAL') |
|
379 | 378 | |
|
380 | 379 | def ip2py(self,source): |
|
381 | 380 | """Convert input IPython source into valid Python.""" |
|
382 | 381 | out = [] |
|
383 | 382 | newline = out.append |
|
384 | 383 | #print 'IPSRC:\n',source,'\n###' # dbg |
|
385 | 384 | # The input source must be first stripped of all bracketing whitespace |
|
386 | 385 | # and turned into lines, so it looks to the parser like regular user |
|
387 | 386 | # input |
|
388 | 387 | for lnum,line in enumerate(source.strip().splitlines()): |
|
389 | 388 | newline(_ip.prefilter(line,lnum>0)) |
|
390 | 389 | newline('') # ensure a closing newline, needed by doctest |
|
391 | 390 | #print "PYSRC:", '\n'.join(out) # dbg |
|
392 | 391 | return '\n'.join(out) |
|
393 | 392 | |
|
394 | 393 | def parse(self, string, name='<string>'): |
|
395 | 394 | """ |
|
396 | 395 | Divide the given string into examples and intervening text, |
|
397 | 396 | and return them as a list of alternating Examples and strings. |
|
398 | 397 | Line numbers for the Examples are 0-based. The optional |
|
399 | 398 | argument `name` is a name identifying this string, and is only |
|
400 | 399 | used for error messages. |
|
401 | 400 | """ |
|
402 | 401 | |
|
403 | 402 | #print 'Parse string:\n',string # dbg |
|
404 | 403 | |
|
405 | 404 | string = string.expandtabs() |
|
406 | 405 | # If all lines begin with the same indentation, then strip it. |
|
407 | 406 | min_indent = self._min_indent(string) |
|
408 | 407 | if min_indent > 0: |
|
409 | 408 | string = '\n'.join([l[min_indent:] for l in string.split('\n')]) |
|
410 | 409 | |
|
411 | 410 | output = [] |
|
412 | 411 | charno, lineno = 0, 0 |
|
413 | 412 | |
|
414 | 413 | # We make 'all random' tests by adding the '# random' mark to every |
|
415 | 414 | # block of output in the test. |
|
416 | 415 | if self._RANDOM_TEST.search(string): |
|
417 | 416 | random_marker = '\n# random' |
|
418 | 417 | else: |
|
419 | 418 | random_marker = '' |
|
420 | 419 | |
|
421 | 420 | # Whether to convert the input from ipython to python syntax |
|
422 | 421 | ip2py = False |
|
423 | 422 | # Find all doctest examples in the string. First, try them as Python |
|
424 | 423 | # examples, then as IPython ones |
|
425 | 424 | terms = list(self._EXAMPLE_RE_PY.finditer(string)) |
|
426 | 425 | if terms: |
|
427 | 426 | # Normal Python example |
|
428 | 427 | #print '-'*70 # dbg |
|
429 | 428 | #print 'PyExample, Source:\n',string # dbg |
|
430 | 429 | #print '-'*70 # dbg |
|
431 | 430 | Example = doctest.Example |
|
432 | 431 | else: |
|
433 | 432 | # It's an ipython example. Note that IPExamples are run |
|
434 | 433 | # in-process, so their syntax must be turned into valid python. |
|
435 | 434 | # IPExternalExamples are run out-of-process (via pexpect) so they |
|
436 | 435 | # don't need any filtering (a real ipython will be executing them). |
|
437 | 436 | terms = list(self._EXAMPLE_RE_IP.finditer(string)) |
|
438 | 437 | if self._EXTERNAL_IP.search(string): |
|
439 | 438 | #print '-'*70 # dbg |
|
440 | 439 | #print 'IPExternalExample, Source:\n',string # dbg |
|
441 | 440 | #print '-'*70 # dbg |
|
442 | 441 | Example = IPExternalExample |
|
443 | 442 | else: |
|
444 | 443 | #print '-'*70 # dbg |
|
445 | 444 | #print 'IPExample, Source:\n',string # dbg |
|
446 | 445 | #print '-'*70 # dbg |
|
447 | 446 | Example = IPExample |
|
448 | 447 | ip2py = True |
|
449 | 448 | |
|
450 | 449 | for m in terms: |
|
451 | 450 | # Add the pre-example text to `output`. |
|
452 | 451 | output.append(string[charno:m.start()]) |
|
453 | 452 | # Update lineno (lines before this example) |
|
454 | 453 | lineno += string.count('\n', charno, m.start()) |
|
455 | 454 | # Extract info from the regexp match. |
|
456 | 455 | (source, options, want, exc_msg) = \ |
|
457 | 456 | self._parse_example(m, name, lineno,ip2py) |
|
458 | 457 | |
|
459 | 458 | # Append the random-output marker (it defaults to empty in most |
|
460 | 459 | # cases, it's only non-empty for 'all-random' tests): |
|
461 | 460 | want += random_marker |
|
462 | 461 | |
|
463 | 462 | if Example is IPExternalExample: |
|
464 | 463 | options[doctest.NORMALIZE_WHITESPACE] = True |
|
465 | 464 | want += '\n' |
|
466 | 465 | |
|
467 | 466 | # Create an Example, and add it to the list. |
|
468 | 467 | if not self._IS_BLANK_OR_COMMENT(source): |
|
469 | 468 | output.append(Example(source, want, exc_msg, |
|
470 | 469 | lineno=lineno, |
|
471 | 470 | indent=min_indent+len(m.group('indent')), |
|
472 | 471 | options=options)) |
|
473 | 472 | # Update lineno (lines inside this example) |
|
474 | 473 | lineno += string.count('\n', m.start(), m.end()) |
|
475 | 474 | # Update charno. |
|
476 | 475 | charno = m.end() |
|
477 | 476 | # Add any remaining post-example text to `output`. |
|
478 | 477 | output.append(string[charno:]) |
|
479 | 478 | return output |
|
480 | 479 | |
|
481 | 480 | def _parse_example(self, m, name, lineno,ip2py=False): |
|
482 | 481 | """ |
|
483 | 482 | Given a regular expression match from `_EXAMPLE_RE` (`m`), |
|
484 | 483 | return a pair `(source, want)`, where `source` is the matched |
|
485 | 484 | example's source code (with prompts and indentation stripped); |
|
486 | 485 | and `want` is the example's expected output (with indentation |
|
487 | 486 | stripped). |
|
488 | 487 | |
|
489 | 488 | `name` is the string's name, and `lineno` is the line number |
|
490 | 489 | where the example starts; both are used for error messages. |
|
491 | 490 | |
|
492 | 491 | Optional: |
|
493 | 492 | `ip2py`: if true, filter the input via IPython to convert the syntax |
|
494 | 493 | into valid python. |
|
495 | 494 | """ |
|
496 | 495 | |
|
497 | 496 | # Get the example's indentation level. |
|
498 | 497 | indent = len(m.group('indent')) |
|
499 | 498 | |
|
500 | 499 | # Divide source into lines; check that they're properly |
|
501 | 500 | # indented; and then strip their indentation & prompts. |
|
502 | 501 | source_lines = m.group('source').split('\n') |
|
503 | 502 | |
|
504 | 503 | # We're using variable-length input prompts |
|
505 | 504 | ps1 = m.group('ps1') |
|
506 | 505 | ps2 = m.group('ps2') |
|
507 | 506 | ps1_len = len(ps1) |
|
508 | 507 | |
|
509 | 508 | self._check_prompt_blank(source_lines, indent, name, lineno,ps1_len) |
|
510 | 509 | if ps2: |
|
511 | 510 | self._check_prefix(source_lines[1:], ' '*indent + ps2, name, lineno) |
|
512 | 511 | |
|
513 | 512 | source = '\n'.join([sl[indent+ps1_len+1:] for sl in source_lines]) |
|
514 | 513 | |
|
515 | 514 | if ip2py: |
|
516 | 515 | # Convert source input from IPython into valid Python syntax |
|
517 | 516 | source = self.ip2py(source) |
|
518 | 517 | |
|
519 | 518 | # Divide want into lines; check that it's properly indented; and |
|
520 | 519 | # then strip the indentation. Spaces before the last newline should |
|
521 | 520 | # be preserved, so plain rstrip() isn't good enough. |
|
522 | 521 | want = m.group('want') |
|
523 | 522 | want_lines = want.split('\n') |
|
524 | 523 | if len(want_lines) > 1 and re.match(r' *$', want_lines[-1]): |
|
525 | 524 | del want_lines[-1] # forget final newline & spaces after it |
|
526 | 525 | self._check_prefix(want_lines, ' '*indent, name, |
|
527 | 526 | lineno + len(source_lines)) |
|
528 | 527 | |
|
529 | 528 | # Remove ipython output prompt that might be present in the first line |
|
530 | 529 | want_lines[0] = re.sub(r'Out\[\d+\]: \s*?\n?','',want_lines[0]) |
|
531 | 530 | |
|
532 | 531 | want = '\n'.join([wl[indent:] for wl in want_lines]) |
|
533 | 532 | |
|
534 | 533 | # If `want` contains a traceback message, then extract it. |
|
535 | 534 | m = self._EXCEPTION_RE.match(want) |
|
536 | 535 | if m: |
|
537 | 536 | exc_msg = m.group('msg') |
|
538 | 537 | else: |
|
539 | 538 | exc_msg = None |
|
540 | 539 | |
|
541 | 540 | # Extract options from the source. |
|
542 | 541 | options = self._find_options(source, name, lineno) |
|
543 | 542 | |
|
544 | 543 | return source, options, want, exc_msg |
|
545 | 544 | |
|
546 | 545 | def _check_prompt_blank(self, lines, indent, name, lineno, ps1_len): |
|
547 | 546 | """ |
|
548 | 547 | Given the lines of a source string (including prompts and |
|
549 | 548 | leading indentation), check to make sure that every prompt is |
|
550 | 549 | followed by a space character. If any line is not followed by |
|
551 | 550 | a space character, then raise ValueError. |
|
552 | 551 | |
|
553 | 552 | Note: IPython-modified version which takes the input prompt length as a |
|
554 | 553 | parameter, so that prompts of variable length can be dealt with. |
|
555 | 554 | """ |
|
556 | 555 | space_idx = indent+ps1_len |
|
557 | 556 | min_len = space_idx+1 |
|
558 | 557 | for i, line in enumerate(lines): |
|
559 | 558 | if len(line) >= min_len and line[space_idx] != ' ': |
|
560 | 559 | raise ValueError('line %r of the docstring for %s ' |
|
561 | 560 | 'lacks blank after %s: %r' % |
|
562 | 561 | (lineno+i+1, name, |
|
563 | 562 | line[indent:space_idx], line)) |
|
564 | 563 | |
|
565 | 564 | |
|
566 | 565 | SKIP = doctest.register_optionflag('SKIP') |
|
567 | 566 | |
|
568 | 567 | |
|
569 | 568 | class IPDocTestRunner(doctest.DocTestRunner,object): |
|
570 | 569 | """Test runner that synchronizes the IPython namespace with test globals. |
|
571 | 570 | """ |
|
572 | 571 | |
|
573 | 572 | def run(self, test, compileflags=None, out=None, clear_globs=True): |
|
574 | 573 | |
|
575 | 574 | # Hack: ipython needs access to the execution context of the example, |
|
576 | 575 | # so that it can propagate user variables loaded by %run into |
|
577 | 576 | # test.globs. We put them here into our modified %run as a function |
|
578 | 577 | # attribute. Our new %run will then only make the namespace update |
|
579 | 578 | # when called (rather than unconconditionally updating test.globs here |
|
580 | 579 | # for all examples, most of which won't be calling %run anyway). |
|
581 | 580 | #_ip._ipdoctest_test_globs = test.globs |
|
582 | 581 | #_ip._ipdoctest_test_filename = test.filename |
|
583 | 582 | |
|
584 | 583 | test.globs.update(_ip.user_ns) |
|
585 | 584 | |
|
586 | 585 | return super(IPDocTestRunner,self).run(test, |
|
587 | 586 | compileflags,out,clear_globs) |
|
588 | 587 | |
|
589 | 588 | |
|
590 | 589 | class DocFileCase(doctest.DocFileCase): |
|
591 | 590 | """Overrides to provide filename |
|
592 | 591 | """ |
|
593 | 592 | def address(self): |
|
594 | 593 | return (self._dt_test.filename, None, None) |
|
595 | 594 | |
|
596 | 595 | |
|
597 | 596 | class ExtensionDoctest(doctests.Doctest): |
|
598 | 597 | """Nose Plugin that supports doctests in extension modules. |
|
599 | 598 | """ |
|
600 | 599 | name = 'extdoctest' # call nosetests with --with-extdoctest |
|
601 | 600 | enabled = True |
|
602 | 601 | |
|
603 | 602 | def __init__(self,exclude_patterns=None): |
|
604 | 603 | """Create a new ExtensionDoctest plugin. |
|
605 | 604 | |
|
606 | 605 | Parameters |
|
607 | 606 | ---------- |
|
608 | 607 | |
|
609 | 608 | exclude_patterns : sequence of strings, optional |
|
610 | 609 | These patterns are compiled as regular expressions, subsequently used |
|
611 | 610 | to exclude any filename which matches them from inclusion in the test |
|
612 | 611 | suite (using pattern.search(), NOT pattern.match() ). |
|
613 | 612 | """ |
|
614 | 613 | |
|
615 | 614 | if exclude_patterns is None: |
|
616 | 615 | exclude_patterns = [] |
|
617 | 616 | self.exclude_patterns = map(re.compile,exclude_patterns) |
|
618 | 617 | doctests.Doctest.__init__(self) |
|
619 | 618 | |
|
620 | 619 | def options(self, parser, env=os.environ): |
|
621 | 620 | Plugin.options(self, parser, env) |
|
622 | 621 | parser.add_option('--doctest-tests', action='store_true', |
|
623 | 622 | dest='doctest_tests', |
|
624 | 623 | default=env.get('NOSE_DOCTEST_TESTS',True), |
|
625 | 624 | help="Also look for doctests in test modules. " |
|
626 | 625 | "Note that classes, methods and functions should " |
|
627 | 626 | "have either doctests or non-doctest tests, " |
|
628 | 627 | "not both. [NOSE_DOCTEST_TESTS]") |
|
629 | 628 | parser.add_option('--doctest-extension', action="append", |
|
630 | 629 | dest="doctestExtension", |
|
631 | 630 | help="Also look for doctests in files with " |
|
632 | 631 | "this extension [NOSE_DOCTEST_EXTENSION]") |
|
633 | 632 | # Set the default as a list, if given in env; otherwise |
|
634 | 633 | # an additional value set on the command line will cause |
|
635 | 634 | # an error. |
|
636 | 635 | env_setting = env.get('NOSE_DOCTEST_EXTENSION') |
|
637 | 636 | if env_setting is not None: |
|
638 | 637 | parser.set_defaults(doctestExtension=tolist(env_setting)) |
|
639 | 638 | |
|
640 | 639 | |
|
641 | 640 | def configure(self, options, config): |
|
642 | 641 | Plugin.configure(self, options, config) |
|
643 | 642 | self.doctest_tests = options.doctest_tests |
|
644 | 643 | self.extension = tolist(options.doctestExtension) |
|
645 | 644 | |
|
646 | 645 | self.parser = doctest.DocTestParser() |
|
647 | 646 | self.finder = DocTestFinder() |
|
648 | 647 | self.checker = IPDoctestOutputChecker() |
|
649 | 648 | self.globs = None |
|
650 | 649 | self.extraglobs = None |
|
651 | 650 | |
|
652 | 651 | |
|
653 | 652 | def loadTestsFromExtensionModule(self,filename): |
|
654 | 653 | bpath,mod = os.path.split(filename) |
|
655 | 654 | modname = os.path.splitext(mod)[0] |
|
656 | 655 | try: |
|
657 | 656 | sys.path.append(bpath) |
|
658 | 657 | module = __import__(modname) |
|
659 | 658 | tests = list(self.loadTestsFromModule(module)) |
|
660 | 659 | finally: |
|
661 | 660 | sys.path.pop() |
|
662 | 661 | return tests |
|
663 | 662 | |
|
664 | 663 | # NOTE: the method below is almost a copy of the original one in nose, with |
|
665 | 664 | # a few modifications to control output checking. |
|
666 | 665 | |
|
667 | 666 | def loadTestsFromModule(self, module): |
|
668 | 667 | #print '*** ipdoctest - lTM',module # dbg |
|
669 | 668 | |
|
670 | 669 | if not self.matches(module.__name__): |
|
671 | 670 | log.debug("Doctest doesn't want module %s", module) |
|
672 | 671 | return |
|
673 | 672 | |
|
674 | 673 | tests = self.finder.find(module,globs=self.globs, |
|
675 | 674 | extraglobs=self.extraglobs) |
|
676 | 675 | if not tests: |
|
677 | 676 | return |
|
678 | 677 | |
|
679 | 678 | # always use whitespace and ellipsis options |
|
680 | 679 | optionflags = doctest.NORMALIZE_WHITESPACE | doctest.ELLIPSIS |
|
681 | 680 | |
|
682 | 681 | tests.sort() |
|
683 | 682 | module_file = module.__file__ |
|
684 | 683 | if module_file[-4:] in ('.pyc', '.pyo'): |
|
685 | 684 | module_file = module_file[:-1] |
|
686 | 685 | for test in tests: |
|
687 | 686 | if not test.examples: |
|
688 | 687 | continue |
|
689 | 688 | if not test.filename: |
|
690 | 689 | test.filename = module_file |
|
691 | 690 | |
|
692 | 691 | yield DocTestCase(test, |
|
693 | 692 | optionflags=optionflags, |
|
694 | 693 | checker=self.checker) |
|
695 | 694 | |
|
696 | 695 | |
|
697 | 696 | def loadTestsFromFile(self, filename): |
|
698 | 697 | #print "ipdoctest - from file", filename # dbg |
|
699 | 698 | if is_extension_module(filename): |
|
700 | 699 | for t in self.loadTestsFromExtensionModule(filename): |
|
701 | 700 | yield t |
|
702 | 701 | else: |
|
703 | 702 | if self.extension and anyp(filename.endswith, self.extension): |
|
704 | 703 | name = os.path.basename(filename) |
|
705 | 704 | dh = open(filename) |
|
706 | 705 | try: |
|
707 | 706 | doc = dh.read() |
|
708 | 707 | finally: |
|
709 | 708 | dh.close() |
|
710 | 709 | test = self.parser.get_doctest( |
|
711 | 710 | doc, globs={'__file__': filename}, name=name, |
|
712 | 711 | filename=filename, lineno=0) |
|
713 | 712 | if test.examples: |
|
714 | 713 | #print 'FileCase:',test.examples # dbg |
|
715 | 714 | yield DocFileCase(test) |
|
716 | 715 | else: |
|
717 | 716 | yield False # no tests to load |
|
718 | 717 | |
|
719 | 718 | def wantFile(self,filename): |
|
720 | 719 | """Return whether the given filename should be scanned for tests. |
|
721 | 720 | |
|
722 | 721 | Modified version that accepts extension modules as valid containers for |
|
723 | 722 | doctests. |
|
724 | 723 | """ |
|
725 | 724 | #print '*** ipdoctest- wantFile:',filename # dbg |
|
726 | 725 | |
|
727 | 726 | for pat in self.exclude_patterns: |
|
728 | 727 | if pat.search(filename): |
|
729 | 728 | # print '###>>> SKIP:',filename # dbg |
|
730 | 729 | return False |
|
731 | 730 | |
|
732 | 731 | if is_extension_module(filename): |
|
733 | 732 | return True |
|
734 | 733 | else: |
|
735 | 734 | return doctests.Doctest.wantFile(self,filename) |
|
736 | 735 | |
|
737 | 736 | |
|
738 | 737 | class IPythonDoctest(ExtensionDoctest): |
|
739 | 738 | """Nose Plugin that supports doctests in extension modules. |
|
740 | 739 | """ |
|
741 | 740 | name = 'ipdoctest' # call nosetests with --with-ipdoctest |
|
742 | 741 | enabled = True |
|
743 | 742 | |
|
744 | 743 | def makeTest(self, obj, parent): |
|
745 | 744 | """Look for doctests in the given object, which will be a |
|
746 | 745 | function, method or class. |
|
747 | 746 | """ |
|
748 | 747 | #print 'Plugin analyzing:', obj, parent # dbg |
|
749 | 748 | # always use whitespace and ellipsis options |
|
750 | 749 | optionflags = doctest.NORMALIZE_WHITESPACE | doctest.ELLIPSIS |
|
751 | 750 | |
|
752 | 751 | doctests = self.finder.find(obj, module=getmodule(parent)) |
|
753 | 752 | if doctests: |
|
754 | 753 | for test in doctests: |
|
755 | 754 | if len(test.examples) == 0: |
|
756 | 755 | continue |
|
757 | 756 | |
|
758 | 757 | yield DocTestCase(test, obj=obj, |
|
759 | 758 | optionflags=optionflags, |
|
760 | 759 | checker=self.checker) |
|
761 | 760 | |
|
762 | 761 | def options(self, parser, env=os.environ): |
|
763 | 762 | #print "Options for nose plugin:", self.name # dbg |
|
764 | 763 | Plugin.options(self, parser, env) |
|
765 | 764 | parser.add_option('--ipdoctest-tests', action='store_true', |
|
766 | 765 | dest='ipdoctest_tests', |
|
767 | 766 | default=env.get('NOSE_IPDOCTEST_TESTS',True), |
|
768 | 767 | help="Also look for doctests in test modules. " |
|
769 | 768 | "Note that classes, methods and functions should " |
|
770 | 769 | "have either doctests or non-doctest tests, " |
|
771 | 770 | "not both. [NOSE_IPDOCTEST_TESTS]") |
|
772 | 771 | parser.add_option('--ipdoctest-extension', action="append", |
|
773 | 772 | dest="ipdoctest_extension", |
|
774 | 773 | help="Also look for doctests in files with " |
|
775 | 774 | "this extension [NOSE_IPDOCTEST_EXTENSION]") |
|
776 | 775 | # Set the default as a list, if given in env; otherwise |
|
777 | 776 | # an additional value set on the command line will cause |
|
778 | 777 | # an error. |
|
779 | 778 | env_setting = env.get('NOSE_IPDOCTEST_EXTENSION') |
|
780 | 779 | if env_setting is not None: |
|
781 | 780 | parser.set_defaults(ipdoctest_extension=tolist(env_setting)) |
|
782 | 781 | |
|
783 | 782 | def configure(self, options, config): |
|
784 | 783 | #print "Configuring nose plugin:", self.name # dbg |
|
785 | 784 | Plugin.configure(self, options, config) |
|
786 | 785 | self.doctest_tests = options.ipdoctest_tests |
|
787 | 786 | self.extension = tolist(options.ipdoctest_extension) |
|
788 | 787 | |
|
789 | 788 | self.parser = IPDocTestParser() |
|
790 | 789 | self.finder = DocTestFinder(parser=self.parser) |
|
791 | 790 | self.checker = IPDoctestOutputChecker() |
|
792 | 791 | self.globs = None |
|
793 | 792 | self.extraglobs = None |
@@ -1,457 +1,458 b'' | |||
|
1 | 1 | """A ZMQ-based subclass of InteractiveShell. |
|
2 | 2 | |
|
3 | 3 | This code is meant to ease the refactoring of the base InteractiveShell into |
|
4 | 4 | something with a cleaner architecture for 2-process use, without actually |
|
5 | 5 | breaking InteractiveShell itself. So we're doing something a bit ugly, where |
|
6 | 6 | we subclass and override what we want to fix. Once this is working well, we |
|
7 | 7 | can go back to the base class and refactor the code for a cleaner inheritance |
|
8 | 8 | implementation that doesn't rely on so much monkeypatching. |
|
9 | 9 | |
|
10 | 10 | But this lets us maintain a fully working IPython as we develop the new |
|
11 | 11 | machinery. This should thus be thought of as scaffolding. |
|
12 | 12 | """ |
|
13 | 13 | #----------------------------------------------------------------------------- |
|
14 | 14 | # Imports |
|
15 | 15 | #----------------------------------------------------------------------------- |
|
16 | 16 | from __future__ import print_function |
|
17 | 17 | |
|
18 | 18 | # Stdlib |
|
19 | 19 | import inspect |
|
20 | 20 | import os |
|
21 | 21 | |
|
22 | 22 | # Our own |
|
23 | 23 | from IPython.core.interactiveshell import ( |
|
24 | 24 | InteractiveShell, InteractiveShellABC |
|
25 | 25 | ) |
|
26 | 26 | from IPython.core import page |
|
27 | 27 | from IPython.core.autocall import ZMQExitAutocall |
|
28 | 28 | from IPython.core.displaypub import DisplayPublisher |
|
29 | 29 | from IPython.core.macro import Macro |
|
30 | 30 | from IPython.core.magic import MacroToEdit |
|
31 | 31 | from IPython.core.payloadpage import install_payload_page |
|
32 | 32 | from IPython.utils import io |
|
33 | 33 | from IPython.utils.path import get_py_filename |
|
34 | 34 | from IPython.utils.traitlets import Instance, Type, Dict, CBool |
|
35 | 35 | from IPython.utils.warn import warn |
|
36 | 36 | from IPython.zmq.displayhook import ZMQShellDisplayHook, _encode_png |
|
37 | 37 | from IPython.zmq.session import extract_header |
|
38 | 38 | from session import Session |
|
39 | 39 | |
|
40 | 40 | #----------------------------------------------------------------------------- |
|
41 | 41 | # Globals and side-effects |
|
42 | 42 | #----------------------------------------------------------------------------- |
|
43 | 43 | |
|
44 | 44 | # Install the payload version of page. |
|
45 | 45 | install_payload_page() |
|
46 | 46 | |
|
47 | 47 | #----------------------------------------------------------------------------- |
|
48 | 48 | # Functions and classes |
|
49 | 49 | #----------------------------------------------------------------------------- |
|
50 | 50 | |
|
51 | 51 | class ZMQDisplayPublisher(DisplayPublisher): |
|
52 | 52 | """A display publisher that publishes data using a ZeroMQ PUB socket.""" |
|
53 | 53 | |
|
54 | 54 | session = Instance(Session) |
|
55 | 55 | pub_socket = Instance('zmq.Socket') |
|
56 | 56 | parent_header = Dict({}) |
|
57 | 57 | |
|
58 | 58 | def set_parent(self, parent): |
|
59 | 59 | """Set the parent for outbound messages.""" |
|
60 | 60 | self.parent_header = extract_header(parent) |
|
61 | 61 | |
|
62 | 62 | def publish(self, source, data, metadata=None): |
|
63 | 63 | if metadata is None: |
|
64 | 64 | metadata = {} |
|
65 | 65 | self._validate_data(source, data, metadata) |
|
66 | 66 | content = {} |
|
67 | 67 | content['source'] = source |
|
68 | 68 | _encode_png(data) |
|
69 | 69 | content['data'] = data |
|
70 | 70 | content['metadata'] = metadata |
|
71 | 71 | self.session.send( |
|
72 | 72 | self.pub_socket, u'display_data', content, |
|
73 | 73 | parent=self.parent_header |
|
74 | 74 | ) |
|
75 | 75 | |
|
76 | 76 | |
|
77 | 77 | class ZMQInteractiveShell(InteractiveShell): |
|
78 | 78 | """A subclass of InteractiveShell for ZMQ.""" |
|
79 | 79 | |
|
80 | 80 | displayhook_class = Type(ZMQShellDisplayHook) |
|
81 | 81 | display_pub_class = Type(ZMQDisplayPublisher) |
|
82 | 82 | |
|
83 | 83 | # Override the traitlet in the parent class, because there's no point using |
|
84 | 84 | # readline for the kernel. Can be removed when the readline code is moved |
|
85 | 85 | # to the terminal frontend. |
|
86 | 86 | |
|
87 | 87 | # FIXME. This is disabled for now, even though it may cause problems under |
|
88 | 88 | # Windows, because it breaks %run in the Qt console. See gh-617 for more |
|
89 | 89 | # details. Re-enable once we've fully tested that %run works in the Qt |
|
90 | 90 | # console with syntax highlighting in tracebacks. |
|
91 | 91 | # readline_use = CBool(False) |
|
92 | 92 | # /FIXME |
|
93 | 93 | |
|
94 | 94 | exiter = Instance(ZMQExitAutocall) |
|
95 | 95 | def _exiter_default(self): |
|
96 | 96 | return ZMQExitAutocall(self) |
|
97 | 97 | |
|
98 | 98 | keepkernel_on_exit = None |
|
99 | 99 | |
|
100 | 100 | def init_environment(self): |
|
101 | 101 | """Configure the user's environment. |
|
102 | 102 | |
|
103 | 103 | """ |
|
104 | 104 | env = os.environ |
|
105 | 105 | # These two ensure 'ls' produces nice coloring on BSD-derived systems |
|
106 | 106 | env['TERM'] = 'xterm-color' |
|
107 | 107 | env['CLICOLOR'] = '1' |
|
108 | 108 | # Since normal pagers don't work at all (over pexpect we don't have |
|
109 | 109 | # single-key control of the subprocess), try to disable paging in |
|
110 | 110 | # subprocesses as much as possible. |
|
111 | 111 | env['PAGER'] = 'cat' |
|
112 | 112 | env['GIT_PAGER'] = 'cat' |
|
113 | 113 | |
|
114 | 114 | def auto_rewrite_input(self, cmd): |
|
115 | 115 | """Called to show the auto-rewritten input for autocall and friends. |
|
116 | 116 | |
|
117 | 117 | FIXME: this payload is currently not correctly processed by the |
|
118 | 118 | frontend. |
|
119 | 119 | """ |
|
120 | 120 | new = self.displayhook.prompt1.auto_rewrite() + cmd |
|
121 | 121 | payload = dict( |
|
122 | 122 | source='IPython.zmq.zmqshell.ZMQInteractiveShell.auto_rewrite_input', |
|
123 | 123 | transformed_input=new, |
|
124 | 124 | ) |
|
125 | 125 | self.payload_manager.write_payload(payload) |
|
126 | 126 | |
|
127 | 127 | def ask_exit(self): |
|
128 | 128 | """Engage the exit actions.""" |
|
129 | 129 | payload = dict( |
|
130 | 130 | source='IPython.zmq.zmqshell.ZMQInteractiveShell.ask_exit', |
|
131 | 131 | exit=True, |
|
132 | 132 | keepkernel=self.keepkernel_on_exit, |
|
133 | 133 | ) |
|
134 | 134 | self.payload_manager.write_payload(payload) |
|
135 | 135 | |
|
136 | 136 | def _showtraceback(self, etype, evalue, stb): |
|
137 | 137 | |
|
138 | 138 | exc_content = { |
|
139 | 139 | u'traceback' : stb, |
|
140 | 140 | u'ename' : unicode(etype.__name__), |
|
141 | 141 | u'evalue' : unicode(evalue) |
|
142 | 142 | } |
|
143 | 143 | |
|
144 | 144 | dh = self.displayhook |
|
145 | 145 | # Send exception info over pub socket for other clients than the caller |
|
146 | 146 | # to pick up |
|
147 | 147 | exc_msg = dh.session.send(dh.pub_socket, u'pyerr', exc_content, dh.parent_header) |
|
148 | 148 | |
|
149 | 149 | # FIXME - Hack: store exception info in shell object. Right now, the |
|
150 | 150 | # caller is reading this info after the fact, we need to fix this logic |
|
151 | 151 | # to remove this hack. Even uglier, we need to store the error status |
|
152 | 152 | # here, because in the main loop, the logic that sets it is being |
|
153 | 153 | # skipped because runlines swallows the exceptions. |
|
154 | 154 | exc_content[u'status'] = u'error' |
|
155 | 155 | self._reply_content = exc_content |
|
156 | 156 | # /FIXME |
|
157 | 157 | |
|
158 | 158 | return exc_content |
|
159 | 159 | |
|
160 | 160 | #------------------------------------------------------------------------ |
|
161 | 161 | # Magic overrides |
|
162 | 162 | #------------------------------------------------------------------------ |
|
163 | 163 | # Once the base class stops inheriting from magic, this code needs to be |
|
164 | 164 | # moved into a separate machinery as well. For now, at least isolate here |
|
165 | 165 | # the magics which this class needs to implement differently from the base |
|
166 | 166 | # class, or that are unique to it. |
|
167 | 167 | |
|
168 | 168 | def magic_doctest_mode(self,parameter_s=''): |
|
169 | 169 | """Toggle doctest mode on and off. |
|
170 | 170 | |
|
171 | 171 | This mode is intended to make IPython behave as much as possible like a |
|
172 | 172 | plain Python shell, from the perspective of how its prompts, exceptions |
|
173 | 173 | and output look. This makes it easy to copy and paste parts of a |
|
174 | 174 | session into doctests. It does so by: |
|
175 | 175 | |
|
176 | 176 | - Changing the prompts to the classic ``>>>`` ones. |
|
177 | 177 | - Changing the exception reporting mode to 'Plain'. |
|
178 | 178 | - Disabling pretty-printing of output. |
|
179 | 179 | |
|
180 | 180 | Note that IPython also supports the pasting of code snippets that have |
|
181 | 181 | leading '>>>' and '...' prompts in them. This means that you can paste |
|
182 | 182 | doctests from files or docstrings (even if they have leading |
|
183 | 183 | whitespace), and the code will execute correctly. You can then use |
|
184 | 184 | '%history -t' to see the translated history; this will give you the |
|
185 | 185 | input after removal of all the leading prompts and whitespace, which |
|
186 | 186 | can be pasted back into an editor. |
|
187 | 187 | |
|
188 | 188 | With these features, you can switch into this mode easily whenever you |
|
189 | 189 | need to do testing and changes to doctests, without having to leave |
|
190 | 190 | your existing IPython session. |
|
191 | 191 | """ |
|
192 | 192 | |
|
193 | 193 | from IPython.utils.ipstruct import Struct |
|
194 | 194 | |
|
195 | 195 | # Shorthands |
|
196 | 196 | shell = self.shell |
|
197 | 197 | disp_formatter = self.shell.display_formatter |
|
198 | 198 | ptformatter = disp_formatter.formatters['text/plain'] |
|
199 | 199 | # dstore is a data store kept in the instance metadata bag to track any |
|
200 | 200 | # changes we make, so we can undo them later. |
|
201 | 201 | dstore = shell.meta.setdefault('doctest_mode', Struct()) |
|
202 | 202 | save_dstore = dstore.setdefault |
|
203 | 203 | |
|
204 | 204 | # save a few values we'll need to recover later |
|
205 | 205 | mode = save_dstore('mode', False) |
|
206 | 206 | save_dstore('rc_pprint', ptformatter.pprint) |
|
207 | 207 | save_dstore('rc_plain_text_only',disp_formatter.plain_text_only) |
|
208 | 208 | save_dstore('xmode', shell.InteractiveTB.mode) |
|
209 | 209 | |
|
210 | 210 | if mode == False: |
|
211 | 211 | # turn on |
|
212 | 212 | ptformatter.pprint = False |
|
213 | 213 | disp_formatter.plain_text_only = True |
|
214 | 214 | shell.magic_xmode('Plain') |
|
215 | 215 | else: |
|
216 | 216 | # turn off |
|
217 | 217 | ptformatter.pprint = dstore.rc_pprint |
|
218 | 218 | disp_formatter.plain_text_only = dstore.rc_plain_text_only |
|
219 | 219 | shell.magic_xmode(dstore.xmode) |
|
220 | 220 | |
|
221 | 221 | # Store new mode and inform on console |
|
222 | 222 | dstore.mode = bool(1-int(mode)) |
|
223 | 223 | mode_label = ['OFF','ON'][dstore.mode] |
|
224 | 224 | print('Doctest mode is:', mode_label) |
|
225 | 225 | |
|
226 | 226 | # Send the payload back so that clients can modify their prompt display |
|
227 | 227 | payload = dict( |
|
228 | 228 | source='IPython.zmq.zmqshell.ZMQInteractiveShell.magic_doctest_mode', |
|
229 | 229 | mode=dstore.mode) |
|
230 | 230 | self.payload_manager.write_payload(payload) |
|
231 | 231 | |
|
232 | 232 | def magic_edit(self,parameter_s='',last_call=['','']): |
|
233 | 233 | """Bring up an editor and execute the resulting code. |
|
234 | 234 | |
|
235 | 235 | Usage: |
|
236 | 236 | %edit [options] [args] |
|
237 | 237 | |
|
238 | 238 | %edit runs IPython's editor hook. The default version of this hook is |
|
239 | 239 | set to call the __IPYTHON__.rc.editor command. This is read from your |
|
240 | 240 | environment variable $EDITOR. If this isn't found, it will default to |
|
241 | 241 | vi under Linux/Unix and to notepad under Windows. See the end of this |
|
242 | 242 | docstring for how to change the editor hook. |
|
243 | 243 | |
|
244 | 244 | You can also set the value of this editor via the command line option |
|
245 | '-editor' or in your ipythonrc file. This is useful if you wish to use | |
|
246 | specifically for IPython an editor different from your typical default | |
|
247 | (and for Windows users who typically don't set environment variables). | |
|
245 | '-editor' or via the 'editor' option in your configuration file. | |
|
246 | This is useful if you wish to use specifically for IPython an editor | |
|
247 | different from your typical default (and for Windows users who typically | |
|
248 | don't set environment variables). | |
|
248 | 249 | |
|
249 | 250 | This command allows you to conveniently edit multi-line code right in |
|
250 | 251 | your IPython session. |
|
251 | 252 | |
|
252 | 253 | If called without arguments, %edit opens up an empty editor with a |
|
253 | 254 | temporary file and will execute the contents of this file when you |
|
254 | 255 | close it (don't forget to save it!). |
|
255 | 256 | |
|
256 | 257 | |
|
257 | 258 | Options: |
|
258 | 259 | |
|
259 | 260 | -n <number>: open the editor at a specified line number. By default, |
|
260 | 261 | the IPython editor hook uses the unix syntax 'editor +N filename', but |
|
261 | 262 | you can configure this by providing your own modified hook if your |
|
262 | 263 | favorite editor supports line-number specifications with a different |
|
263 | 264 | syntax. |
|
264 | 265 | |
|
265 | 266 | -p: this will call the editor with the same data as the previous time |
|
266 | 267 | it was used, regardless of how long ago (in your current session) it |
|
267 | 268 | was. |
|
268 | 269 | |
|
269 | 270 | -r: use 'raw' input. This option only applies to input taken from the |
|
270 | 271 | user's history. By default, the 'processed' history is used, so that |
|
271 | 272 | magics are loaded in their transformed version to valid Python. If |
|
272 | 273 | this option is given, the raw input as typed as the command line is |
|
273 | 274 | used instead. When you exit the editor, it will be executed by |
|
274 | 275 | IPython's own processor. |
|
275 | 276 | |
|
276 | 277 | -x: do not execute the edited code immediately upon exit. This is |
|
277 | 278 | mainly useful if you are editing programs which need to be called with |
|
278 | 279 | command line arguments, which you can then do using %run. |
|
279 | 280 | |
|
280 | 281 | |
|
281 | 282 | Arguments: |
|
282 | 283 | |
|
283 | 284 | If arguments are given, the following possibilites exist: |
|
284 | 285 | |
|
285 | 286 | - The arguments are numbers or pairs of colon-separated numbers (like |
|
286 | 287 | 1 4:8 9). These are interpreted as lines of previous input to be |
|
287 | 288 | loaded into the editor. The syntax is the same of the %macro command. |
|
288 | 289 | |
|
289 | 290 | - If the argument doesn't start with a number, it is evaluated as a |
|
290 | 291 | variable and its contents loaded into the editor. You can thus edit |
|
291 | 292 | any string which contains python code (including the result of |
|
292 | 293 | previous edits). |
|
293 | 294 | |
|
294 | 295 | - If the argument is the name of an object (other than a string), |
|
295 | 296 | IPython will try to locate the file where it was defined and open the |
|
296 | 297 | editor at the point where it is defined. You can use `%edit function` |
|
297 | 298 | to load an editor exactly at the point where 'function' is defined, |
|
298 | 299 | edit it and have the file be executed automatically. |
|
299 | 300 | |
|
300 | 301 | If the object is a macro (see %macro for details), this opens up your |
|
301 | 302 | specified editor with a temporary file containing the macro's data. |
|
302 | 303 | Upon exit, the macro is reloaded with the contents of the file. |
|
303 | 304 | |
|
304 | 305 | Note: opening at an exact line is only supported under Unix, and some |
|
305 | 306 | editors (like kedit and gedit up to Gnome 2.8) do not understand the |
|
306 | 307 | '+NUMBER' parameter necessary for this feature. Good editors like |
|
307 | 308 | (X)Emacs, vi, jed, pico and joe all do. |
|
308 | 309 | |
|
309 | 310 | - If the argument is not found as a variable, IPython will look for a |
|
310 | 311 | file with that name (adding .py if necessary) and load it into the |
|
311 | 312 | editor. It will execute its contents with execfile() when you exit, |
|
312 | 313 | loading any code in the file into your interactive namespace. |
|
313 | 314 | |
|
314 | 315 | After executing your code, %edit will return as output the code you |
|
315 | 316 | typed in the editor (except when it was an existing file). This way |
|
316 | 317 | you can reload the code in further invocations of %edit as a variable, |
|
317 | 318 | via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of |
|
318 | 319 | the output. |
|
319 | 320 | |
|
320 | 321 | Note that %edit is also available through the alias %ed. |
|
321 | 322 | |
|
322 | 323 | This is an example of creating a simple function inside the editor and |
|
323 | 324 | then modifying it. First, start up the editor: |
|
324 | 325 | |
|
325 | 326 | In [1]: ed |
|
326 | 327 | Editing... done. Executing edited code... |
|
327 | 328 | Out[1]: 'def foo():n print "foo() was defined in an editing session"n' |
|
328 | 329 | |
|
329 | 330 | We can then call the function foo(): |
|
330 | 331 | |
|
331 | 332 | In [2]: foo() |
|
332 | 333 | foo() was defined in an editing session |
|
333 | 334 | |
|
334 | 335 | Now we edit foo. IPython automatically loads the editor with the |
|
335 | 336 | (temporary) file where foo() was previously defined: |
|
336 | 337 | |
|
337 | 338 | In [3]: ed foo |
|
338 | 339 | Editing... done. Executing edited code... |
|
339 | 340 | |
|
340 | 341 | And if we call foo() again we get the modified version: |
|
341 | 342 | |
|
342 | 343 | In [4]: foo() |
|
343 | 344 | foo() has now been changed! |
|
344 | 345 | |
|
345 | 346 | Here is an example of how to edit a code snippet successive |
|
346 | 347 | times. First we call the editor: |
|
347 | 348 | |
|
348 | 349 | In [5]: ed |
|
349 | 350 | Editing... done. Executing edited code... |
|
350 | 351 | hello |
|
351 | 352 | Out[5]: "print 'hello'n" |
|
352 | 353 | |
|
353 | 354 | Now we call it again with the previous output (stored in _): |
|
354 | 355 | |
|
355 | 356 | In [6]: ed _ |
|
356 | 357 | Editing... done. Executing edited code... |
|
357 | 358 | hello world |
|
358 | 359 | Out[6]: "print 'hello world'n" |
|
359 | 360 | |
|
360 | 361 | Now we call it with the output #8 (stored in _8, also as Out[8]): |
|
361 | 362 | |
|
362 | 363 | In [7]: ed _8 |
|
363 | 364 | Editing... done. Executing edited code... |
|
364 | 365 | hello again |
|
365 | 366 | Out[7]: "print 'hello again'n" |
|
366 | 367 | |
|
367 | 368 | |
|
368 | 369 | Changing the default editor hook: |
|
369 | 370 | |
|
370 | 371 | If you wish to write your own editor hook, you can put it in a |
|
371 | 372 | configuration file which you load at startup time. The default hook |
|
372 | 373 | is defined in the IPython.core.hooks module, and you can use that as a |
|
373 | 374 | starting example for further modifications. That file also has |
|
374 | 375 | general instructions on how to set a new hook for use once you've |
|
375 | 376 | defined it.""" |
|
376 | 377 | |
|
377 | 378 | opts,args = self.parse_options(parameter_s,'prn:') |
|
378 | 379 | |
|
379 | 380 | try: |
|
380 | 381 | filename, lineno, _ = self._find_edit_target(args, opts, last_call) |
|
381 | 382 | except MacroToEdit as e: |
|
382 | 383 | # TODO: Implement macro editing over 2 processes. |
|
383 | 384 | print("Macro editing not yet implemented in 2-process model.") |
|
384 | 385 | return |
|
385 | 386 | |
|
386 | 387 | # Make sure we send to the client an absolute path, in case the working |
|
387 | 388 | # directory of client and kernel don't match |
|
388 | 389 | filename = os.path.abspath(filename) |
|
389 | 390 | |
|
390 | 391 | payload = { |
|
391 | 392 | 'source' : 'IPython.zmq.zmqshell.ZMQInteractiveShell.edit_magic', |
|
392 | 393 | 'filename' : filename, |
|
393 | 394 | 'line_number' : lineno |
|
394 | 395 | } |
|
395 | 396 | self.payload_manager.write_payload(payload) |
|
396 | 397 | |
|
397 | 398 | def magic_gui(self, *args, **kwargs): |
|
398 | 399 | raise NotImplementedError( |
|
399 | 400 | 'Kernel GUI support is not implemented yet, except for --pylab.') |
|
400 | 401 | |
|
401 | 402 | def magic_pylab(self, *args, **kwargs): |
|
402 | 403 | raise NotImplementedError( |
|
403 | 404 | 'pylab support must be enabled in command line options.') |
|
404 | 405 | |
|
405 | 406 | # A few magics that are adapted to the specifics of using pexpect and a |
|
406 | 407 | # remote terminal |
|
407 | 408 | |
|
408 | 409 | def magic_clear(self, arg_s): |
|
409 | 410 | """Clear the terminal.""" |
|
410 | 411 | if os.name == 'posix': |
|
411 | 412 | self.shell.system("clear") |
|
412 | 413 | else: |
|
413 | 414 | self.shell.system("cls") |
|
414 | 415 | |
|
415 | 416 | if os.name == 'nt': |
|
416 | 417 | # This is the usual name in windows |
|
417 | 418 | magic_cls = magic_clear |
|
418 | 419 | |
|
419 | 420 | # Terminal pagers won't work over pexpect, but we do have our own pager |
|
420 | 421 | |
|
421 | 422 | def magic_less(self, arg_s): |
|
422 | 423 | """Show a file through the pager. |
|
423 | 424 | |
|
424 | 425 | Files ending in .py are syntax-highlighted.""" |
|
425 | 426 | cont = open(arg_s).read() |
|
426 | 427 | if arg_s.endswith('.py'): |
|
427 | 428 | cont = self.shell.pycolorize(cont) |
|
428 | 429 | page.page(cont) |
|
429 | 430 | |
|
430 | 431 | magic_more = magic_less |
|
431 | 432 | |
|
432 | 433 | # Man calls a pager, so we also need to redefine it |
|
433 | 434 | if os.name == 'posix': |
|
434 | 435 | def magic_man(self, arg_s): |
|
435 | 436 | """Find the man page for the given command and display in pager.""" |
|
436 | 437 | page.page(self.shell.getoutput('man %s | col -b' % arg_s, |
|
437 | 438 | split=False)) |
|
438 | 439 | |
|
439 | 440 | # FIXME: this is specific to the GUI, so we should let the gui app load |
|
440 | 441 | # magics at startup that are only for the gui. Once the gui app has proper |
|
441 | 442 | # profile and configuration management, we can have it initialize a kernel |
|
442 | 443 | # with a special config file that provides these. |
|
443 | 444 | def magic_guiref(self, arg_s): |
|
444 | 445 | """Show a basic reference about the GUI console.""" |
|
445 | 446 | from IPython.core.usage import gui_reference |
|
446 | 447 | page.page(gui_reference, auto_html=True) |
|
447 | 448 | |
|
448 | 449 | def set_next_input(self, text): |
|
449 | 450 | """Send the specified text to the frontend to be presented at the next |
|
450 | 451 | input cell.""" |
|
451 | 452 | payload = dict( |
|
452 | 453 | source='IPython.zmq.zmqshell.ZMQInteractiveShell.set_next_input', |
|
453 | 454 | text=text |
|
454 | 455 | ) |
|
455 | 456 | self.payload_manager.write_payload(payload) |
|
456 | 457 | |
|
457 | 458 | InteractiveShellABC.register(ZMQInteractiveShell) |
@@ -1,1310 +1,1310 b'' | |||
|
1 | 1 | ================= |
|
2 | 2 | IPython reference |
|
3 | 3 | ================= |
|
4 | 4 | |
|
5 | 5 | .. _command_line_options: |
|
6 | 6 | |
|
7 | 7 | Command-line usage |
|
8 | 8 | ================== |
|
9 | 9 | |
|
10 | 10 | You start IPython with the command:: |
|
11 | 11 | |
|
12 | 12 | $ ipython [options] files |
|
13 | 13 | |
|
14 | 14 | If invoked with no options, it executes all the files listed in sequence |
|
15 | 15 | and drops you into the interpreter while still acknowledging any options |
|
16 | 16 | you may have set in your ipython_config.py. This behavior is different from |
|
17 | 17 | standard Python, which when called as python -i will only execute one |
|
18 | 18 | file and ignore your configuration setup. |
|
19 | 19 | |
|
20 | 20 | Please note that some of the configuration options are not available at |
|
21 | 21 | the command line, simply because they are not practical here. Look into |
|
22 |
your |
|
|
23 | installed in the IPYTHON_DIR directory. For Linux | |
|
24 | users, this will be $HOME/.config/ipython, and for other users it will be | |
|
25 | $HOME/.ipython. For Windows users, $HOME resolves to C:\\Documents and | |
|
22 | your configuration files for details on those. There are separate configuration | |
|
23 | files for each profile, and the files look like "ipython_config.py" or | |
|
24 | "ipython_config_<frontendname>.py". Profile directories look like | |
|
25 | "profile_profilename" and are typically installed in the IPYTHON_DIR directory. | |
|
26 | For Linux users, this will be $HOME/.config/ipython, and for other users it | |
|
27 | will be $HOME/.ipython. For Windows users, $HOME resolves to C:\\Documents and | |
|
26 | 28 | Settings\\YourUserName in most instances. |
|
27 | 29 | |
|
28 | 30 | |
|
29 | 31 | Eventloop integration |
|
30 | 32 | --------------------- |
|
31 | 33 | |
|
32 | 34 | Previously IPython had command line options for controlling GUI event loop |
|
33 | 35 | integration (-gthread, -qthread, -q4thread, -wthread, -pylab). As of IPython |
|
34 | 36 | version 0.11, these have been removed. Please see the new ``%gui`` |
|
35 | 37 | magic command or :ref:`this section <gui_support>` for details on the new |
|
36 | 38 | interface, or specify the gui at the commandline:: |
|
37 | 39 | |
|
38 | 40 | $ ipython --gui=qt |
|
39 | 41 | |
|
40 | 42 | |
|
41 | 43 | Regular Options |
|
42 | 44 | --------------- |
|
43 | 45 | |
|
44 | 46 | After the above threading options have been given, regular options can |
|
45 | 47 | follow in any order. All options can be abbreviated to their shortest |
|
46 | 48 | non-ambiguous form and are case-sensitive. One or two dashes can be |
|
47 | 49 | used. Some options have an alternate short form, indicated after a ``|``. |
|
48 | 50 | |
|
49 |
Most options can also be set from your |
|
|
50 |
|
|
|
51 |
|
|
|
51 | Most options can also be set from your configuration file. See the provided | |
|
52 | example for more details on what the options do. Options given at the command | |
|
53 | line override the values set in the configuration file. | |
|
52 | 54 | |
|
53 | 55 | All options with a [no] prepended can be specified in negated form |
|
54 | 56 | (--no-option instead of --option) to turn the feature off. |
|
55 | 57 | |
|
56 | 58 | ``-h, --help`` print a help message and exit. |
|
57 | 59 | |
|
58 | 60 | ``--pylab, pylab=<name>`` |
|
59 | 61 | See :ref:`Matplotlib support <matplotlib_support>` |
|
60 | 62 | for more details. |
|
61 | 63 | |
|
62 | 64 | ``--autocall=<val>`` |
|
63 | 65 | Make IPython automatically call any callable object even if you |
|
64 | 66 | didn't type explicit parentheses. For example, 'str 43' becomes |
|
65 | 67 | 'str(43)' automatically. The value can be '0' to disable the feature, |
|
66 | 68 | '1' for smart autocall, where it is not applied if there are no more |
|
67 | 69 | arguments on the line, and '2' for full autocall, where all callable |
|
68 | 70 | objects are automatically called (even if no arguments are |
|
69 | 71 | present). The default is '1'. |
|
70 | 72 | |
|
71 | 73 | ``--[no-]autoindent`` |
|
72 | 74 | Turn automatic indentation on/off. |
|
73 | 75 | |
|
74 | 76 | ``--[no-]automagic`` |
|
75 | 77 | make magic commands automatic (without needing their first character |
|
76 | 78 | to be %). Type %magic at the IPython prompt for more information. |
|
77 | 79 | |
|
78 | 80 | ``--[no-]autoedit_syntax`` |
|
79 | 81 | When a syntax error occurs after editing a file, automatically |
|
80 | 82 | open the file to the trouble causing line for convenient |
|
81 | 83 | fixing. |
|
82 | 84 | |
|
83 | 85 | ``--[no-]banner`` |
|
84 | 86 | Print the initial information banner (default on). |
|
85 | 87 | |
|
86 | 88 | ``--c=<command>`` |
|
87 | 89 | execute the given command string. This is similar to the -c |
|
88 | 90 | option in the normal Python interpreter. |
|
89 | 91 | |
|
90 | 92 | ``--cache-size=<n>`` |
|
91 | 93 | size of the output cache (maximum number of entries to hold in |
|
92 | 94 | memory). The default is 1000, you can change it permanently in your |
|
93 | 95 | config file. Setting it to 0 completely disables the caching system, |
|
94 | 96 | and the minimum value accepted is 20 (if you provide a value less than |
|
95 | 97 | 20, it is reset to 0 and a warning is issued) This limit is defined |
|
96 | 98 | because otherwise you'll spend more time re-flushing a too small cache |
|
97 | 99 | than working. |
|
98 | 100 | |
|
99 | 101 | ``--classic`` |
|
100 | 102 | Gives IPython a similar feel to the classic Python |
|
101 | 103 | prompt. |
|
102 | 104 | |
|
103 | 105 | ``--colors=<scheme>`` |
|
104 | 106 | Color scheme for prompts and exception reporting. Currently |
|
105 | 107 | implemented: NoColor, Linux and LightBG. |
|
106 | 108 | |
|
107 | 109 | ``--[no-]color_info`` |
|
108 | 110 | IPython can display information about objects via a set of functions, |
|
109 | 111 | and optionally can use colors for this, syntax highlighting source |
|
110 | 112 | code and various other elements. However, because this information is |
|
111 | 113 | passed through a pager (like 'less') and many pagers get confused with |
|
112 | 114 | color codes, this option is off by default. You can test it and turn |
|
113 |
it on permanently in your |
|
|
115 | it on permanently in your configuration file if it works for you. As a | |
|
114 | 116 | reference, the 'less' pager supplied with Mandrake 8.2 works ok, but |
|
115 | 117 | that in RedHat 7.2 doesn't. |
|
116 | 118 | |
|
117 | 119 | Test it and turn it on permanently if it works with your |
|
118 | 120 | system. The magic function %color_info allows you to toggle this |
|
119 | 121 | interactively for testing. |
|
120 | 122 | |
|
121 | 123 | ``--[no-]debug`` |
|
122 | 124 | Show information about the loading process. Very useful to pin down |
|
123 | 125 | problems with your configuration files or to get details about |
|
124 | 126 | session restores. |
|
125 | 127 | |
|
126 | 128 | ``--[no-]deep_reload`` |
|
127 | 129 | IPython can use the deep_reload module which reloads changes in |
|
128 | 130 | modules recursively (it replaces the reload() function, so you don't |
|
129 | 131 | need to change anything to use it). deep_reload() forces a full |
|
130 | 132 | reload of modules whose code may have changed, which the default |
|
131 | 133 | reload() function does not. |
|
132 | 134 | |
|
133 | 135 | When deep_reload is off, IPython will use the normal reload(), |
|
134 | 136 | but deep_reload will still be available as dreload(). This |
|
135 | 137 | feature is off by default [which means that you have both |
|
136 | 138 | normal reload() and dreload()]. |
|
137 | 139 | |
|
138 | 140 | ``--editor=<name>`` |
|
139 | 141 | Which editor to use with the %edit command. By default, |
|
140 | 142 | IPython will honor your EDITOR environment variable (if not |
|
141 | 143 | set, vi is the Unix default and notepad the Windows one). |
|
142 | 144 | Since this editor is invoked on the fly by IPython and is |
|
143 | 145 | meant for editing small code snippets, you may want to use a |
|
144 | 146 | small, lightweight editor here (in case your default EDITOR is |
|
145 | 147 | something like Emacs). |
|
146 | 148 | |
|
147 | 149 | ``--ipython_dir=<name>`` |
|
148 | 150 | name of your IPython configuration directory IPYTHON_DIR. This |
|
149 | 151 | can also be specified through the environment variable |
|
150 | 152 | IPYTHON_DIR. |
|
151 | 153 | |
|
152 | 154 | ``--logfile=<name>`` |
|
153 | 155 | specify the name of your logfile. |
|
154 | 156 | |
|
155 | 157 | This implies ``%logstart`` at the beginning of your session |
|
156 | 158 | |
|
157 | 159 | generate a log file of all input. The file is named |
|
158 | 160 | ipython_log.py in your current directory (which prevents logs |
|
159 | 161 | from multiple IPython sessions from trampling each other). You |
|
160 | 162 | can use this to later restore a session by loading your |
|
161 | 163 | logfile with ``ipython --i ipython_log.py`` |
|
162 | 164 | |
|
163 | 165 | ``--logplay=<name>`` |
|
164 | 166 | |
|
165 | 167 | NOT AVAILABLE in 0.11 |
|
166 | 168 | |
|
167 | 169 | you can replay a previous log. For restoring a session as close as |
|
168 | 170 | possible to the state you left it in, use this option (don't just run |
|
169 | 171 | the logfile). With -logplay, IPython will try to reconstruct the |
|
170 | 172 | previous working environment in full, not just execute the commands in |
|
171 | 173 | the logfile. |
|
172 | 174 | |
|
173 | 175 | When a session is restored, logging is automatically turned on |
|
174 | 176 | again with the name of the logfile it was invoked with (it is |
|
175 | 177 | read from the log header). So once you've turned logging on for |
|
176 | 178 | a session, you can quit IPython and reload it as many times as |
|
177 | 179 | you want and it will continue to log its history and restore |
|
178 | 180 | from the beginning every time. |
|
179 | 181 | |
|
180 | 182 | Caveats: there are limitations in this option. The history |
|
181 | 183 | variables _i*,_* and _dh don't get restored properly. In the |
|
182 | 184 | future we will try to implement full session saving by writing |
|
183 | 185 | and retrieving a 'snapshot' of the memory state of IPython. But |
|
184 | 186 | our first attempts failed because of inherent limitations of |
|
185 | 187 | Python's Pickle module, so this may have to wait. |
|
186 | 188 | |
|
187 | 189 | ``--[no-]messages`` |
|
188 | 190 | Print messages which IPython collects about its startup |
|
189 | 191 | process (default on). |
|
190 | 192 | |
|
191 | 193 | ``--[no-]pdb`` |
|
192 | 194 | Automatically call the pdb debugger after every uncaught |
|
193 | 195 | exception. If you are used to debugging using pdb, this puts |
|
194 | 196 | you automatically inside of it after any call (either in |
|
195 | 197 | IPython or in code called by it) which triggers an exception |
|
196 | 198 | which goes uncaught. |
|
197 | 199 | |
|
198 | 200 | ``--[no-]pprint`` |
|
199 | 201 | ipython can optionally use the pprint (pretty printer) module |
|
200 | 202 | for displaying results. pprint tends to give a nicer display |
|
201 | 203 | of nested data structures. If you like it, you can turn it on |
|
202 | 204 | permanently in your config file (default off). |
|
203 | 205 | |
|
204 | 206 | ``--profile=<name>`` |
|
205 | 207 | |
|
206 | 208 | Select the IPython profile by name. |
|
207 | 209 | |
|
208 | 210 | This is a quick way to keep and load multiple |
|
209 | 211 | config files for different tasks, especially if you use the |
|
210 | 212 | include option of config files. You can keep a basic |
|
211 | 213 | :file:`IPYTHON_DIR/profile_default/ipython_config.py` file |
|
212 | 214 | and then have other 'profiles' which |
|
213 | 215 | include this one and load extra things for particular |
|
214 | 216 | tasks. For example: |
|
215 | 217 | |
|
216 | 218 | 1. $IPYTHON_DIR/profile_default : load basic things you always want. |
|
217 | 219 | 2. $IPYTHON_DIR/profile_math : load (1) and basic math-related modules. |
|
218 | 220 | 3. $IPYTHON_DIR/profile_numeric : load (1) and Numeric and plotting modules. |
|
219 | 221 | |
|
220 | 222 | Since it is possible to create an endless loop by having |
|
221 | 223 | circular file inclusions, IPython will stop if it reaches 15 |
|
222 | 224 | recursive inclusions. |
|
223 | 225 | |
|
224 | 226 | ``InteractiveShell.prompt_in1=<string>`` |
|
225 | 227 | |
|
226 | 228 | Specify the string used for input prompts. Note that if you are using |
|
227 | 229 | numbered prompts, the number is represented with a '\#' in the |
|
228 | 230 | string. Don't forget to quote strings with spaces embedded in |
|
229 | 231 | them. Default: 'In [\#]:'. The :ref:`prompts section <prompts>` |
|
230 | 232 | discusses in detail all the available escapes to customize your |
|
231 | 233 | prompts. |
|
232 | 234 | |
|
233 | 235 | ``InteractiveShell.prompt_in2=<string>`` |
|
234 | 236 | Similar to the previous option, but used for the continuation |
|
235 | 237 | prompts. The special sequence '\D' is similar to '\#', but |
|
236 | 238 | with all digits replaced dots (so you can have your |
|
237 | 239 | continuation prompt aligned with your input prompt). Default: |
|
238 | 240 | ' .\D.:' (note three spaces at the start for alignment with |
|
239 | 241 | 'In [\#]'). |
|
240 | 242 | |
|
241 | 243 | ``InteractiveShell.prompt_out=<string>`` |
|
242 | 244 | String used for output prompts, also uses numbers like |
|
243 | 245 | prompt_in1. Default: 'Out[\#]:' |
|
244 | 246 | |
|
245 | 247 | ``--quick`` |
|
246 | 248 | start in bare bones mode (no config file loaded). |
|
247 | 249 | |
|
248 | 250 | ``config_file=<name>`` |
|
249 | 251 | name of your IPython resource configuration file. Normally |
|
250 | 252 | IPython loads ipython_config.py (from current directory) or |
|
251 | 253 | IPYTHON_DIR/profile_default. |
|
252 | 254 | |
|
253 | 255 | If the loading of your config file fails, IPython starts with |
|
254 | 256 | a bare bones configuration (no modules loaded at all). |
|
255 | 257 | |
|
256 | 258 | ``--[no-]readline`` |
|
257 | 259 | use the readline library, which is needed to support name |
|
258 | 260 | completion and command history, among other things. It is |
|
259 | 261 | enabled by default, but may cause problems for users of |
|
260 | 262 | X/Emacs in Python comint or shell buffers. |
|
261 | 263 | |
|
262 | 264 | Note that X/Emacs 'eterm' buffers (opened with M-x term) support |
|
263 | 265 | IPython's readline and syntax coloring fine, only 'emacs' (M-x |
|
264 | 266 | shell and C-c !) buffers do not. |
|
265 | 267 | |
|
266 | 268 | ``--TerminalInteractiveShell.screen_length=<n>`` |
|
267 | 269 | number of lines of your screen. This is used to control |
|
268 | 270 | printing of very long strings. Strings longer than this number |
|
269 | 271 | of lines will be sent through a pager instead of directly |
|
270 | 272 | printed. |
|
271 | 273 | |
|
272 | 274 | The default value for this is 0, which means IPython will |
|
273 | 275 | auto-detect your screen size every time it needs to print certain |
|
274 | 276 | potentially long strings (this doesn't change the behavior of the |
|
275 | 277 | 'print' keyword, it's only triggered internally). If for some |
|
276 | 278 | reason this isn't working well (it needs curses support), specify |
|
277 | 279 | it yourself. Otherwise don't change the default. |
|
278 | 280 | |
|
279 | 281 | ``--TerminalInteractiveShell.separate_in=<string>`` |
|
280 | 282 | |
|
281 | 283 | separator before input prompts. |
|
282 | 284 | Default: '\n' |
|
283 | 285 | |
|
284 | 286 | ``--TerminalInteractiveShell.separate_out=<string>`` |
|
285 | 287 | separator before output prompts. |
|
286 | 288 | Default: nothing. |
|
287 | 289 | |
|
288 | 290 | ``--TerminalInteractiveShell.separate_out2=<string>`` |
|
289 | 291 | separator after output prompts. |
|
290 | 292 | Default: nothing. |
|
291 | 293 | For these three options, use the value 0 to specify no separator. |
|
292 | 294 | |
|
293 | 295 | ``--nosep`` |
|
294 | 296 | shorthand for setting the above separators to empty strings. |
|
295 | 297 | |
|
296 | 298 | Simply removes all input/output separators. |
|
297 | 299 | |
|
298 | 300 | ``--init`` |
|
299 | 301 | allows you to initialize a profile dir for configuration when you |
|
300 | 302 | install a new version of IPython or want to use a new profile. |
|
301 | 303 | Since new versions may include new command line options or example |
|
302 | 304 | files, this copies updated config files. Note that you should probably |
|
303 | 305 | use %upgrade instead,it's a safer alternative. |
|
304 | 306 | |
|
305 | 307 | ``--version`` print version information and exit. |
|
306 | 308 | |
|
307 | 309 | ``--xmode=<modename>`` |
|
308 | 310 | |
|
309 | 311 | Mode for exception reporting. |
|
310 | 312 | |
|
311 | 313 | Valid modes: Plain, Context and Verbose. |
|
312 | 314 | |
|
313 | 315 | * Plain: similar to python's normal traceback printing. |
|
314 | 316 | * Context: prints 5 lines of context source code around each |
|
315 | 317 | line in the traceback. |
|
316 | 318 | * Verbose: similar to Context, but additionally prints the |
|
317 | 319 | variables currently visible where the exception happened |
|
318 | 320 | (shortening their strings if too long). This can potentially be |
|
319 | 321 | very slow, if you happen to have a huge data structure whose |
|
320 | 322 | string representation is complex to compute. Your computer may |
|
321 | 323 | appear to freeze for a while with cpu usage at 100%. If this |
|
322 | 324 | occurs, you can cancel the traceback with Ctrl-C (maybe hitting it |
|
323 | 325 | more than once). |
|
324 | 326 | |
|
325 | 327 | Interactive use |
|
326 | 328 | =============== |
|
327 | 329 | |
|
328 | 330 | IPython is meant to work as a drop-in replacement for the standard interactive |
|
329 | 331 | interpreter. As such, any code which is valid python should execute normally |
|
330 | 332 | under IPython (cases where this is not true should be reported as bugs). It |
|
331 | 333 | does, however, offer many features which are not available at a standard python |
|
332 | 334 | prompt. What follows is a list of these. |
|
333 | 335 | |
|
334 | 336 | |
|
335 | 337 | Caution for Windows users |
|
336 | 338 | ------------------------- |
|
337 | 339 | |
|
338 | 340 | Windows, unfortunately, uses the '\\' character as a path separator. This is a |
|
339 | 341 | terrible choice, because '\\' also represents the escape character in most |
|
340 | 342 | modern programming languages, including Python. For this reason, using '/' |
|
341 | 343 | character is recommended if you have problems with ``\``. However, in Windows |
|
342 | 344 | commands '/' flags options, so you can not use it for the root directory. This |
|
343 | 345 | means that paths beginning at the root must be typed in a contrived manner |
|
344 | 346 | like: ``%copy \opt/foo/bar.txt \tmp`` |
|
345 | 347 | |
|
346 | 348 | .. _magic: |
|
347 | 349 | |
|
348 | 350 | Magic command system |
|
349 | 351 | -------------------- |
|
350 | 352 | |
|
351 | 353 | IPython will treat any line whose first character is a % as a special |
|
352 | 354 | call to a 'magic' function. These allow you to control the behavior of |
|
353 | 355 | IPython itself, plus a lot of system-type features. They are all |
|
354 | 356 | prefixed with a % character, but parameters are given without |
|
355 | 357 | parentheses or quotes. |
|
356 | 358 | |
|
357 | 359 | Example: typing ``%cd mydir`` changes your working directory to 'mydir', if it |
|
358 | 360 | exists. |
|
359 | 361 | |
|
360 | 362 | If you have 'automagic' enabled (as it by default), you don't need |
|
361 | 363 | to type in the % explicitly. IPython will scan its internal list of |
|
362 | 364 | magic functions and call one if it exists. With automagic on you can |
|
363 | 365 | then just type ``cd mydir`` to go to directory 'mydir'. The automagic |
|
364 | 366 | system has the lowest possible precedence in name searches, so defining |
|
365 | 367 | an identifier with the same name as an existing magic function will |
|
366 | 368 | shadow it for automagic use. You can still access the shadowed magic |
|
367 | 369 | function by explicitly using the % character at the beginning of the line. |
|
368 | 370 | |
|
369 | 371 | An example (with automagic on) should clarify all this: |
|
370 | 372 | |
|
371 | 373 | .. sourcecode:: ipython |
|
372 | 374 | |
|
373 | 375 | In [1]: cd ipython # %cd is called by automagic |
|
374 | 376 | |
|
375 | 377 | /home/fperez/ipython |
|
376 | 378 | |
|
377 | 379 | In [2]: cd=1 # now cd is just a variable |
|
378 | 380 | |
|
379 | 381 | In [3]: cd .. # and doesn't work as a function anymore |
|
380 | 382 | |
|
381 | 383 | ------------------------------ |
|
382 | 384 | |
|
383 | 385 | File "<console>", line 1 |
|
384 | 386 | |
|
385 | 387 | cd .. |
|
386 | 388 | |
|
387 | 389 | ^ |
|
388 | 390 | |
|
389 | 391 | SyntaxError: invalid syntax |
|
390 | 392 | |
|
391 | 393 | In [4]: %cd .. # but %cd always works |
|
392 | 394 | |
|
393 | 395 | /home/fperez |
|
394 | 396 | |
|
395 | 397 | In [5]: del cd # if you remove the cd variable |
|
396 | 398 | |
|
397 | 399 | In [6]: cd ipython # automagic can work again |
|
398 | 400 | |
|
399 | 401 | /home/fperez/ipython |
|
400 | 402 | |
|
401 | 403 | You can define your own magic functions to extend the system. The |
|
402 | 404 | following example defines a new magic command, %impall: |
|
403 | 405 | |
|
404 | 406 | .. sourcecode:: python |
|
405 | 407 | |
|
406 | 408 | ip = get_ipython() |
|
407 | 409 | |
|
408 | 410 | def doimp(self, arg): |
|
409 | 411 | |
|
410 | 412 | ip = self.api |
|
411 | 413 | |
|
412 | 414 | ip.ex("import %s; reload(%s); from %s import *" % ( |
|
413 | 415 | |
|
414 | 416 | arg,arg,arg) |
|
415 | 417 | |
|
416 | 418 | ) |
|
417 | 419 | |
|
418 | 420 | ip.expose_magic('impall', doimp) |
|
419 | 421 | |
|
420 | 422 | Type `%magic` for more information, including a list of all available magic |
|
421 | 423 | functions at any time and their docstrings. You can also type |
|
422 | 424 | %magic_function_name? (see :ref:`below <dynamic_object_info` for information on |
|
423 | 425 | the '?' system) to get information about any particular magic function you are |
|
424 | 426 | interested in. |
|
425 | 427 | |
|
426 | 428 | The API documentation for the :mod:`IPython.core.magic` module contains the full |
|
427 | 429 | docstrings of all currently available magic commands. |
|
428 | 430 | |
|
429 | 431 | |
|
430 | 432 | Access to the standard Python help |
|
431 | 433 | ---------------------------------- |
|
432 | 434 | |
|
433 | 435 | As of Python 2.1, a help system is available with access to object docstrings |
|
434 | 436 | and the Python manuals. Simply type 'help' (no quotes) to access it. You can |
|
435 | 437 | also type help(object) to obtain information about a given object, and |
|
436 | 438 | help('keyword') for information on a keyword. As noted :ref:`here |
|
437 | 439 | <accessing_help>`, you need to properly configure your environment variable |
|
438 | 440 | PYTHONDOCS for this feature to work correctly. |
|
439 | 441 | |
|
440 | 442 | .. _dynamic_object_info: |
|
441 | 443 | |
|
442 | 444 | Dynamic object information |
|
443 | 445 | -------------------------- |
|
444 | 446 | |
|
445 | 447 | Typing ``?word`` or ``word?`` prints detailed information about an object. If |
|
446 | 448 | certain strings in the object are too long (docstrings, code, etc.) they get |
|
447 | 449 | snipped in the center for brevity. This system gives access variable types and |
|
448 | 450 | values, full source code for any object (if available), function prototypes and |
|
449 | 451 | other useful information. |
|
450 | 452 | |
|
451 | 453 | Typing ``??word`` or ``word??`` gives access to the full information without |
|
452 | 454 | snipping long strings. Long strings are sent to the screen through the |
|
453 | 455 | less pager if longer than the screen and printed otherwise. On systems |
|
454 | 456 | lacking the less command, IPython uses a very basic internal pager. |
|
455 | 457 | |
|
456 | 458 | The following magic functions are particularly useful for gathering |
|
457 | 459 | information about your working environment. You can get more details by |
|
458 | 460 | typing ``%magic`` or querying them individually (use %function_name? with or |
|
459 | 461 | without the %), this is just a summary: |
|
460 | 462 | |
|
461 | 463 | * **%pdoc <object>**: Print (or run through a pager if too long) the |
|
462 | 464 | docstring for an object. If the given object is a class, it will |
|
463 | 465 | print both the class and the constructor docstrings. |
|
464 | 466 | * **%pdef <object>**: Print the definition header for any callable |
|
465 | 467 | object. If the object is a class, print the constructor information. |
|
466 | 468 | * **%psource <object>**: Print (or run through a pager if too long) |
|
467 | 469 | the source code for an object. |
|
468 | 470 | * **%pfile <object>**: Show the entire source file where an object was |
|
469 | 471 | defined via a pager, opening it at the line where the object |
|
470 | 472 | definition begins. |
|
471 | 473 | * **%who/%whos**: These functions give information about identifiers |
|
472 | 474 | you have defined interactively (not things you loaded or defined |
|
473 | 475 | in your configuration files). %who just prints a list of |
|
474 | 476 | identifiers and %whos prints a table with some basic details about |
|
475 | 477 | each identifier. |
|
476 | 478 | |
|
477 | 479 | Note that the dynamic object information functions (?/??, ``%pdoc``, |
|
478 | 480 | ``%pfile``, ``%pdef``, ``%psource``) give you access to documentation even on |
|
479 | 481 | things which are not really defined as separate identifiers. Try for example |
|
480 | 482 | typing {}.get? or after doing import os, type ``os.path.abspath??``. |
|
481 | 483 | |
|
482 | 484 | .. _readline: |
|
483 | 485 | |
|
484 | 486 | Readline-based features |
|
485 | 487 | ----------------------- |
|
486 | 488 | |
|
487 | 489 | These features require the GNU readline library, so they won't work if your |
|
488 | 490 | Python installation lacks readline support. We will first describe the default |
|
489 | 491 | behavior IPython uses, and then how to change it to suit your preferences. |
|
490 | 492 | |
|
491 | 493 | |
|
492 | 494 | Command line completion |
|
493 | 495 | +++++++++++++++++++++++ |
|
494 | 496 | |
|
495 | 497 | At any time, hitting TAB will complete any available python commands or |
|
496 | 498 | variable names, and show you a list of the possible completions if |
|
497 | 499 | there's no unambiguous one. It will also complete filenames in the |
|
498 | 500 | current directory if no python names match what you've typed so far. |
|
499 | 501 | |
|
500 | 502 | |
|
501 | 503 | Search command history |
|
502 | 504 | ++++++++++++++++++++++ |
|
503 | 505 | |
|
504 | 506 | IPython provides two ways for searching through previous input and thus |
|
505 | 507 | reduce the need for repetitive typing: |
|
506 | 508 | |
|
507 | 509 | 1. Start typing, and then use Ctrl-p (previous,up) and Ctrl-n |
|
508 | 510 | (next,down) to search through only the history items that match |
|
509 | 511 | what you've typed so far. If you use Ctrl-p/Ctrl-n at a blank |
|
510 | 512 | prompt, they just behave like normal arrow keys. |
|
511 | 513 | 2. Hit Ctrl-r: opens a search prompt. Begin typing and the system |
|
512 | 514 | searches your history for lines that contain what you've typed so |
|
513 | 515 | far, completing as much as it can. |
|
514 | 516 | |
|
515 | 517 | |
|
516 | 518 | Persistent command history across sessions |
|
517 | 519 | ++++++++++++++++++++++++++++++++++++++++++ |
|
518 | 520 | |
|
519 | 521 | IPython will save your input history when it leaves and reload it next |
|
520 | 522 | time you restart it. By default, the history file is named |
|
521 | 523 | $IPYTHON_DIR/profile_<name>/history.sqlite. This allows you to keep |
|
522 | 524 | separate histories related to various tasks: commands related to |
|
523 | 525 | numerical work will not be clobbered by a system shell history, for |
|
524 | 526 | example. |
|
525 | 527 | |
|
526 | 528 | |
|
527 | 529 | Autoindent |
|
528 | 530 | ++++++++++ |
|
529 | 531 | |
|
530 | 532 | IPython can recognize lines ending in ':' and indent the next line, |
|
531 | 533 | while also un-indenting automatically after 'raise' or 'return'. |
|
532 | 534 | |
|
533 | 535 | This feature uses the readline library, so it will honor your |
|
534 | 536 | :file:`~/.inputrc` configuration (or whatever file your INPUTRC variable points |
|
535 | 537 | to). Adding the following lines to your :file:`.inputrc` file can make |
|
536 | 538 | indenting/unindenting more convenient (M-i indents, M-u unindents):: |
|
537 | 539 | |
|
538 | 540 | $if Python |
|
539 | 541 | "\M-i": " " |
|
540 | 542 | "\M-u": "\d\d\d\d" |
|
541 | 543 | $endif |
|
542 | 544 | |
|
543 | 545 | Note that there are 4 spaces between the quote marks after "M-i" above. |
|
544 | 546 | |
|
545 | 547 | .. warning:: |
|
546 | 548 | |
|
547 | 549 | Setting the above indents will cause problems with unicode text entry in |
|
548 | 550 | the terminal. |
|
549 | 551 | |
|
550 | 552 | .. warning:: |
|
551 | 553 | |
|
552 | 554 | Autoindent is ON by default, but it can cause problems with the pasting of |
|
553 | 555 | multi-line indented code (the pasted code gets re-indented on each line). A |
|
554 | 556 | magic function %autoindent allows you to toggle it on/off at runtime. You |
|
555 | 557 | can also disable it permanently on in your :file:`ipython_config.py` file |
|
556 | 558 | (set TerminalInteractiveShell.autoindent=False). |
|
557 | 559 | |
|
558 | 560 | If you want to paste multiple lines, it is recommended that you use |
|
559 | 561 | ``%paste``. |
|
560 | 562 | |
|
561 | 563 | |
|
562 | 564 | Customizing readline behavior |
|
563 | 565 | +++++++++++++++++++++++++++++ |
|
564 | 566 | |
|
565 | 567 | All these features are based on the GNU readline library, which has an |
|
566 | 568 | extremely customizable interface. Normally, readline is configured via a |
|
567 | 569 | file which defines the behavior of the library; the details of the |
|
568 | 570 | syntax for this can be found in the readline documentation available |
|
569 | 571 | with your system or on the Internet. IPython doesn't read this file (if |
|
570 | 572 | it exists) directly, but it does support passing to readline valid |
|
571 | 573 | options via a simple interface. In brief, you can customize readline by |
|
572 |
setting the following options in your |
|
|
574 | setting the following options in your configuration file (note | |
|
573 | 575 | that these options can not be specified at the command line): |
|
574 | 576 | |
|
575 | 577 | * **readline_parse_and_bind**: this option can appear as many times as |
|
576 | 578 | you want, each time defining a string to be executed via a |
|
577 | 579 | readline.parse_and_bind() command. The syntax for valid commands |
|
578 | 580 | of this kind can be found by reading the documentation for the GNU |
|
579 | 581 | readline library, as these commands are of the kind which readline |
|
580 | 582 | accepts in its configuration file. |
|
581 | 583 | * **readline_remove_delims**: a string of characters to be removed |
|
582 | 584 | from the default word-delimiters list used by readline, so that |
|
583 | 585 | completions may be performed on strings which contain them. Do not |
|
584 | 586 | change the default value unless you know what you're doing. |
|
585 | 587 | * **readline_omit__names**: when tab-completion is enabled, hitting |
|
586 | 588 | <tab> after a '.' in a name will complete all attributes of an |
|
587 | 589 | object, including all the special methods whose names include |
|
588 | 590 | double underscores (like __getitem__ or __class__). If you'd |
|
589 | 591 | rather not see these names by default, you can set this option to |
|
590 | 592 | 1. Note that even when this option is set, you can still see those |
|
591 | 593 | names by explicitly typing a _ after the period and hitting <tab>: |
|
592 | 594 | 'name._<tab>' will always complete attribute names starting with '_'. |
|
593 | 595 | |
|
594 | 596 | This option is off by default so that new users see all |
|
595 | 597 | attributes of any objects they are dealing with. |
|
596 | 598 | |
|
597 |
You will find the default values |
|
|
598 | explanation in your ipythonrc file. | |
|
599 | You will find the default values in your configuration file. | |
|
599 | 600 | |
|
600 | 601 | |
|
601 | 602 | Session logging and restoring |
|
602 | 603 | ----------------------------- |
|
603 | 604 | |
|
604 | 605 | You can log all input from a session either by starting IPython with the |
|
605 | 606 | command line switch ``--logfile=foo.py`` (see :ref:`here <command_line_options>`) |
|
606 | 607 | or by activating the logging at any moment with the magic function %logstart. |
|
607 | 608 | |
|
608 | 609 | Log files can later be reloaded by running them as scripts and IPython |
|
609 | 610 | will attempt to 'replay' the log by executing all the lines in it, thus |
|
610 | 611 | restoring the state of a previous session. This feature is not quite |
|
611 | 612 | perfect, but can still be useful in many cases. |
|
612 | 613 | |
|
613 | 614 | The log files can also be used as a way to have a permanent record of |
|
614 | 615 | any code you wrote while experimenting. Log files are regular text files |
|
615 | 616 | which you can later open in your favorite text editor to extract code or |
|
616 | 617 | to 'clean them up' before using them to replay a session. |
|
617 | 618 | |
|
618 | 619 | The `%logstart` function for activating logging in mid-session is used as |
|
619 | 620 | follows:: |
|
620 | 621 | |
|
621 | 622 | %logstart [log_name [log_mode]] |
|
622 | 623 | |
|
623 | 624 | If no name is given, it defaults to a file named 'ipython_log.py' in your |
|
624 | 625 | current working directory, in 'rotate' mode (see below). |
|
625 | 626 | |
|
626 | 627 | '%logstart name' saves to file 'name' in 'backup' mode. It saves your |
|
627 | 628 | history up to that point and then continues logging. |
|
628 | 629 | |
|
629 | 630 | %logstart takes a second optional parameter: logging mode. This can be |
|
630 | 631 | one of (note that the modes are given unquoted): |
|
631 | 632 | |
|
632 | 633 | * [over:] overwrite existing log_name. |
|
633 | 634 | * [backup:] rename (if exists) to log_name~ and start log_name. |
|
634 | 635 | * [append:] well, that says it. |
|
635 | 636 | * [rotate:] create rotating logs log_name.1~, log_name.2~, etc. |
|
636 | 637 | |
|
637 | 638 | The %logoff and %logon functions allow you to temporarily stop and |
|
638 | 639 | resume logging to a file which had previously been started with |
|
639 | 640 | %logstart. They will fail (with an explanation) if you try to use them |
|
640 | 641 | before logging has been started. |
|
641 | 642 | |
|
642 | 643 | .. _system_shell_access: |
|
643 | 644 | |
|
644 | 645 | System shell access |
|
645 | 646 | ------------------- |
|
646 | 647 | |
|
647 | 648 | Any input line beginning with a ! character is passed verbatim (minus |
|
648 | 649 | the !, of course) to the underlying operating system. For example, |
|
649 | 650 | typing ``!ls`` will run 'ls' in the current directory. |
|
650 | 651 | |
|
651 | 652 | Manual capture of command output |
|
652 | 653 | -------------------------------- |
|
653 | 654 | |
|
654 | 655 | If the input line begins with two exclamation marks, !!, the command is |
|
655 | 656 | executed but its output is captured and returned as a python list, split |
|
656 | 657 | on newlines. Any output sent by the subprocess to standard error is |
|
657 | 658 | printed separately, so that the resulting list only captures standard |
|
658 | 659 | output. The !! syntax is a shorthand for the %sx magic command. |
|
659 | 660 | |
|
660 | 661 | Finally, the %sc magic (short for 'shell capture') is similar to %sx, |
|
661 | 662 | but allowing more fine-grained control of the capture details, and |
|
662 | 663 | storing the result directly into a named variable. The direct use of |
|
663 | 664 | %sc is now deprecated, and you should ise the ``var = !cmd`` syntax |
|
664 | 665 | instead. |
|
665 | 666 | |
|
666 | 667 | IPython also allows you to expand the value of python variables when |
|
667 | 668 | making system calls. Any python variable or expression which you prepend |
|
668 | 669 | with $ will get expanded before the system call is made:: |
|
669 | 670 | |
|
670 | 671 | In [1]: pyvar='Hello world' |
|
671 | 672 | In [2]: !echo "A python variable: $pyvar" |
|
672 | 673 | A python variable: Hello world |
|
673 | 674 | |
|
674 | 675 | If you want the shell to actually see a literal $, you need to type it |
|
675 | 676 | twice:: |
|
676 | 677 | |
|
677 | 678 | In [3]: !echo "A system variable: $$HOME" |
|
678 | 679 | A system variable: /home/fperez |
|
679 | 680 | |
|
680 | 681 | You can pass arbitrary expressions, though you'll need to delimit them |
|
681 | 682 | with {} if there is ambiguity as to the extent of the expression:: |
|
682 | 683 | |
|
683 | 684 | In [5]: x=10 |
|
684 | 685 | In [6]: y=20 |
|
685 | 686 | In [13]: !echo $x+y |
|
686 | 687 | 10+y |
|
687 | 688 | In [7]: !echo ${x+y} |
|
688 | 689 | 30 |
|
689 | 690 | |
|
690 | 691 | Even object attributes can be expanded:: |
|
691 | 692 | |
|
692 | 693 | In [12]: !echo $sys.argv |
|
693 | 694 | [/home/fperez/usr/bin/ipython] |
|
694 | 695 | |
|
695 | 696 | |
|
696 | 697 | System command aliases |
|
697 | 698 | ---------------------- |
|
698 | 699 | |
|
699 | The %alias magic function and the alias option in the ipythonrc | |
|
700 | configuration file allow you to define magic functions which are in fact | |
|
700 | The %alias magic functionallows you to define magic functions which are in fact | |
|
701 | 701 | system shell commands. These aliases can have parameters. |
|
702 | 702 | |
|
703 | 703 | ``%alias alias_name cmd`` defines 'alias_name' as an alias for 'cmd' |
|
704 | 704 | |
|
705 | 705 | Then, typing ``%alias_name params`` will execute the system command 'cmd |
|
706 | 706 | params' (from your underlying operating system). |
|
707 | 707 | |
|
708 | 708 | You can also define aliases with parameters using %s specifiers (one per |
|
709 | 709 | parameter). The following example defines the %parts function as an |
|
710 | 710 | alias to the command 'echo first %s second %s' where each %s will be |
|
711 | 711 | replaced by a positional parameter to the call to %parts:: |
|
712 | 712 | |
|
713 | 713 | In [1]: alias parts echo first %s second %s |
|
714 | 714 | In [2]: %parts A B |
|
715 | 715 | first A second B |
|
716 | 716 | In [3]: %parts A |
|
717 | 717 | Incorrect number of arguments: 2 expected. |
|
718 | 718 | parts is an alias to: 'echo first %s second %s' |
|
719 | 719 | |
|
720 | 720 | If called with no parameters, %alias prints the table of currently |
|
721 | 721 | defined aliases. |
|
722 | 722 | |
|
723 | 723 | The %rehashx magic allows you to load your entire $PATH as |
|
724 | 724 | ipython aliases. See its docstring for further details. |
|
725 | 725 | |
|
726 | 726 | |
|
727 | 727 | .. _dreload: |
|
728 | 728 | |
|
729 | 729 | Recursive reload |
|
730 | 730 | ---------------- |
|
731 | 731 | |
|
732 | 732 | The dreload function does a recursive reload of a module: changes made |
|
733 | 733 | to the module since you imported will actually be available without |
|
734 | 734 | having to exit. |
|
735 | 735 | |
|
736 | 736 | |
|
737 | 737 | Verbose and colored exception traceback printouts |
|
738 | 738 | ------------------------------------------------- |
|
739 | 739 | |
|
740 | 740 | IPython provides the option to see very detailed exception tracebacks, |
|
741 | 741 | which can be especially useful when debugging large programs. You can |
|
742 | 742 | run any Python file with the %run function to benefit from these |
|
743 | 743 | detailed tracebacks. Furthermore, both normal and verbose tracebacks can |
|
744 | 744 | be colored (if your terminal supports it) which makes them much easier |
|
745 | 745 | to parse visually. |
|
746 | 746 | |
|
747 | 747 | See the magic xmode and colors functions for details (just type %magic). |
|
748 | 748 | |
|
749 | 749 | These features are basically a terminal version of Ka-Ping Yee's cgitb |
|
750 | 750 | module, now part of the standard Python library. |
|
751 | 751 | |
|
752 | 752 | |
|
753 | 753 | .. _input_caching: |
|
754 | 754 | |
|
755 | 755 | Input caching system |
|
756 | 756 | -------------------- |
|
757 | 757 | |
|
758 | 758 | IPython offers numbered prompts (In/Out) with input and output caching |
|
759 | 759 | (also referred to as 'input history'). All input is saved and can be |
|
760 | 760 | retrieved as variables (besides the usual arrow key recall), in |
|
761 | 761 | addition to the %rep magic command that brings a history entry |
|
762 | 762 | up for editing on the next command line. |
|
763 | 763 | |
|
764 | 764 | The following GLOBAL variables always exist (so don't overwrite them!): |
|
765 | 765 | |
|
766 | 766 | * _i, _ii, _iii: store previous, next previous and next-next previous inputs. |
|
767 | 767 | * In, _ih : a list of all inputs; _ih[n] is the input from line n. If you |
|
768 | 768 | overwrite In with a variable of your own, you can remake the assignment to the |
|
769 | 769 | internal list with a simple ``In=_ih``. |
|
770 | 770 | |
|
771 | 771 | Additionally, global variables named _i<n> are dynamically created (<n> |
|
772 | 772 | being the prompt counter), so ``_i<n> == _ih[<n>] == In[<n>]``. |
|
773 | 773 | |
|
774 | 774 | For example, what you typed at prompt 14 is available as _i14, _ih[14] |
|
775 | 775 | and In[14]. |
|
776 | 776 | |
|
777 | 777 | This allows you to easily cut and paste multi line interactive prompts |
|
778 | 778 | by printing them out: they print like a clean string, without prompt |
|
779 | 779 | characters. You can also manipulate them like regular variables (they |
|
780 | 780 | are strings), modify or exec them (typing ``exec _i9`` will re-execute the |
|
781 | 781 | contents of input prompt 9. |
|
782 | 782 | |
|
783 | 783 | You can also re-execute multiple lines of input easily by using the |
|
784 | 784 | magic %macro function (which automates the process and allows |
|
785 | 785 | re-execution without having to type 'exec' every time). The macro system |
|
786 | 786 | also allows you to re-execute previous lines which include magic |
|
787 | 787 | function calls (which require special processing). Type %macro? for more details |
|
788 | 788 | on the macro system. |
|
789 | 789 | |
|
790 | 790 | A history function %hist allows you to see any part of your input |
|
791 | 791 | history by printing a range of the _i variables. |
|
792 | 792 | |
|
793 | 793 | You can also search ('grep') through your history by typing |
|
794 | 794 | ``%hist -g somestring``. This is handy for searching for URLs, IP addresses, |
|
795 | 795 | etc. You can bring history entries listed by '%hist -g' up for editing |
|
796 | 796 | with the %recall command, or run them immediately with %rerun. |
|
797 | 797 | |
|
798 | 798 | .. _output_caching: |
|
799 | 799 | |
|
800 | 800 | Output caching system |
|
801 | 801 | --------------------- |
|
802 | 802 | |
|
803 | 803 | For output that is returned from actions, a system similar to the input |
|
804 | 804 | cache exists but using _ instead of _i. Only actions that produce a |
|
805 | 805 | result (NOT assignments, for example) are cached. If you are familiar |
|
806 | 806 | with Mathematica, IPython's _ variables behave exactly like |
|
807 | 807 | Mathematica's % variables. |
|
808 | 808 | |
|
809 | 809 | The following GLOBAL variables always exist (so don't overwrite them!): |
|
810 | 810 | |
|
811 | 811 | * [_] (a single underscore) : stores previous output, like Python's |
|
812 | 812 | default interpreter. |
|
813 | 813 | * [__] (two underscores): next previous. |
|
814 | 814 | * [___] (three underscores): next-next previous. |
|
815 | 815 | |
|
816 | 816 | Additionally, global variables named _<n> are dynamically created (<n> |
|
817 | 817 | being the prompt counter), such that the result of output <n> is always |
|
818 | 818 | available as _<n> (don't use the angle brackets, just the number, e.g. |
|
819 | 819 | _21). |
|
820 | 820 | |
|
821 | 821 | These global variables are all stored in a global dictionary (not a |
|
822 | 822 | list, since it only has entries for lines which returned a result) |
|
823 | 823 | available under the names _oh and Out (similar to _ih and In). So the |
|
824 | 824 | output from line 12 can be obtained as _12, Out[12] or _oh[12]. If you |
|
825 | 825 | accidentally overwrite the Out variable you can recover it by typing |
|
826 | 826 | 'Out=_oh' at the prompt. |
|
827 | 827 | |
|
828 | 828 | This system obviously can potentially put heavy memory demands on your |
|
829 | 829 | system, since it prevents Python's garbage collector from removing any |
|
830 | 830 | previously computed results. You can control how many results are kept |
|
831 |
in memory with the option (at the command line or in your |
|
|
831 | in memory with the option (at the command line or in your configuration | |
|
832 | 832 | file) cache_size. If you set it to 0, the whole system is completely |
|
833 | 833 | disabled and the prompts revert to the classic '>>>' of normal Python. |
|
834 | 834 | |
|
835 | 835 | |
|
836 | 836 | Directory history |
|
837 | 837 | ----------------- |
|
838 | 838 | |
|
839 | 839 | Your history of visited directories is kept in the global list _dh, and |
|
840 | 840 | the magic %cd command can be used to go to any entry in that list. The |
|
841 | 841 | %dhist command allows you to view this history. Do ``cd -<TAB>`` to |
|
842 | 842 | conveniently view the directory history. |
|
843 | 843 | |
|
844 | 844 | |
|
845 | 845 | Automatic parentheses and quotes |
|
846 | 846 | -------------------------------- |
|
847 | 847 | |
|
848 | 848 | These features were adapted from Nathan Gray's LazyPython. They are |
|
849 | 849 | meant to allow less typing for common situations. |
|
850 | 850 | |
|
851 | 851 | |
|
852 | 852 | Automatic parentheses |
|
853 | 853 | --------------------- |
|
854 | 854 | |
|
855 | 855 | Callable objects (i.e. functions, methods, etc) can be invoked like this |
|
856 | 856 | (notice the commas between the arguments):: |
|
857 | 857 | |
|
858 | 858 | >>> callable_ob arg1, arg2, arg3 |
|
859 | 859 | |
|
860 | 860 | and the input will be translated to this:: |
|
861 | 861 | |
|
862 | 862 | -> callable_ob(arg1, arg2, arg3) |
|
863 | 863 | |
|
864 | 864 | You can force automatic parentheses by using '/' as the first character |
|
865 | 865 | of a line. For example:: |
|
866 | 866 | |
|
867 | 867 | >>> /globals # becomes 'globals()' |
|
868 | 868 | |
|
869 | 869 | Note that the '/' MUST be the first character on the line! This won't work:: |
|
870 | 870 | |
|
871 | 871 | >>> print /globals # syntax error |
|
872 | 872 | |
|
873 | 873 | In most cases the automatic algorithm should work, so you should rarely |
|
874 | 874 | need to explicitly invoke /. One notable exception is if you are trying |
|
875 | 875 | to call a function with a list of tuples as arguments (the parenthesis |
|
876 | 876 | will confuse IPython):: |
|
877 | 877 | |
|
878 | 878 | In [1]: zip (1,2,3),(4,5,6) # won't work |
|
879 | 879 | |
|
880 | 880 | but this will work:: |
|
881 | 881 | |
|
882 | 882 | In [2]: /zip (1,2,3),(4,5,6) |
|
883 | 883 | ---> zip ((1,2,3),(4,5,6)) |
|
884 | 884 | Out[2]= [(1, 4), (2, 5), (3, 6)] |
|
885 | 885 | |
|
886 | 886 | IPython tells you that it has altered your command line by displaying |
|
887 | 887 | the new command line preceded by ->. e.g.:: |
|
888 | 888 | |
|
889 | 889 | In [18]: callable list |
|
890 | 890 | ----> callable (list) |
|
891 | 891 | |
|
892 | 892 | |
|
893 | 893 | Automatic quoting |
|
894 | 894 | ----------------- |
|
895 | 895 | |
|
896 | 896 | You can force automatic quoting of a function's arguments by using ',' |
|
897 | 897 | or ';' as the first character of a line. For example:: |
|
898 | 898 | |
|
899 | 899 | >>> ,my_function /home/me # becomes my_function("/home/me") |
|
900 | 900 | |
|
901 | 901 | If you use ';' instead, the whole argument is quoted as a single string |
|
902 | 902 | (while ',' splits on whitespace):: |
|
903 | 903 | |
|
904 | 904 | >>> ,my_function a b c # becomes my_function("a","b","c") |
|
905 | 905 | |
|
906 | 906 | >>> ;my_function a b c # becomes my_function("a b c") |
|
907 | 907 | |
|
908 | 908 | Note that the ',' or ';' MUST be the first character on the line! This |
|
909 | 909 | won't work:: |
|
910 | 910 | |
|
911 | 911 | >>> x = ,my_function /home/me # syntax error |
|
912 | 912 | |
|
913 | 913 | IPython as your default Python environment |
|
914 | 914 | ========================================== |
|
915 | 915 | |
|
916 | 916 | Python honors the environment variable PYTHONSTARTUP and will execute at |
|
917 | 917 | startup the file referenced by this variable. If you put at the end of |
|
918 | 918 | this file the following two lines of code:: |
|
919 | 919 | |
|
920 | 920 | from IPython.frontend.terminal.ipapp import launch_new_instance |
|
921 | 921 | launch_new_instance() |
|
922 | 922 | raise SystemExit |
|
923 | 923 | |
|
924 | 924 | then IPython will be your working environment anytime you start Python. |
|
925 | 925 | The ``raise SystemExit`` is needed to exit Python when |
|
926 | 926 | it finishes, otherwise you'll be back at the normal Python '>>>' |
|
927 | 927 | prompt. |
|
928 | 928 | |
|
929 | 929 | This is probably useful to developers who manage multiple Python |
|
930 | 930 | versions and don't want to have correspondingly multiple IPython |
|
931 | 931 | versions. Note that in this mode, there is no way to pass IPython any |
|
932 | 932 | command-line options, as those are trapped first by Python itself. |
|
933 | 933 | |
|
934 | 934 | .. _Embedding: |
|
935 | 935 | |
|
936 | 936 | Embedding IPython |
|
937 | 937 | ================= |
|
938 | 938 | |
|
939 | 939 | It is possible to start an IPython instance inside your own Python |
|
940 | 940 | programs. This allows you to evaluate dynamically the state of your |
|
941 | 941 | code, operate with your variables, analyze them, etc. Note however that |
|
942 | 942 | any changes you make to values while in the shell do not propagate back |
|
943 | 943 | to the running code, so it is safe to modify your values because you |
|
944 | 944 | won't break your code in bizarre ways by doing so. |
|
945 | 945 | |
|
946 | 946 | This feature allows you to easily have a fully functional python |
|
947 | 947 | environment for doing object introspection anywhere in your code with a |
|
948 | 948 | simple function call. In some cases a simple print statement is enough, |
|
949 | 949 | but if you need to do more detailed analysis of a code fragment this |
|
950 | 950 | feature can be very valuable. |
|
951 | 951 | |
|
952 | 952 | It can also be useful in scientific computing situations where it is |
|
953 | 953 | common to need to do some automatic, computationally intensive part and |
|
954 | 954 | then stop to look at data, plots, etc. |
|
955 | 955 | Opening an IPython instance will give you full access to your data and |
|
956 | 956 | functions, and you can resume program execution once you are done with |
|
957 | 957 | the interactive part (perhaps to stop again later, as many times as |
|
958 | 958 | needed). |
|
959 | 959 | |
|
960 | 960 | The following code snippet is the bare minimum you need to include in |
|
961 | 961 | your Python programs for this to work (detailed examples follow later):: |
|
962 | 962 | |
|
963 | 963 | from IPython import embed |
|
964 | 964 | |
|
965 | 965 | embed() # this call anywhere in your program will start IPython |
|
966 | 966 | |
|
967 | 967 | You can run embedded instances even in code which is itself being run at |
|
968 | 968 | the IPython interactive prompt with '%run <filename>'. Since it's easy |
|
969 | 969 | to get lost as to where you are (in your top-level IPython or in your |
|
970 | 970 | embedded one), it's a good idea in such cases to set the in/out prompts |
|
971 | 971 | to something different for the embedded instances. The code examples |
|
972 | 972 | below illustrate this. |
|
973 | 973 | |
|
974 | 974 | You can also have multiple IPython instances in your program and open |
|
975 | 975 | them separately, for example with different options for data |
|
976 | 976 | presentation. If you close and open the same instance multiple times, |
|
977 | 977 | its prompt counters simply continue from each execution to the next. |
|
978 | 978 | |
|
979 | 979 | Please look at the docstrings in the :mod:`~IPython.frontend.terminal.embed` |
|
980 | 980 | module for more details on the use of this system. |
|
981 | 981 | |
|
982 | 982 | The following sample file illustrating how to use the embedding |
|
983 | 983 | functionality is provided in the examples directory as example-embed.py. |
|
984 | 984 | It should be fairly self-explanatory: |
|
985 | 985 | |
|
986 | 986 | .. literalinclude:: ../../examples/core/example-embed.py |
|
987 | 987 | :language: python |
|
988 | 988 | |
|
989 | 989 | Once you understand how the system functions, you can use the following |
|
990 | 990 | code fragments in your programs which are ready for cut and paste: |
|
991 | 991 | |
|
992 | 992 | .. literalinclude:: ../../examples/core/example-embed-short.py |
|
993 | 993 | :language: python |
|
994 | 994 | |
|
995 | 995 | Using the Python debugger (pdb) |
|
996 | 996 | =============================== |
|
997 | 997 | |
|
998 | 998 | Running entire programs via pdb |
|
999 | 999 | ------------------------------- |
|
1000 | 1000 | |
|
1001 | 1001 | pdb, the Python debugger, is a powerful interactive debugger which |
|
1002 | 1002 | allows you to step through code, set breakpoints, watch variables, |
|
1003 | 1003 | etc. IPython makes it very easy to start any script under the control |
|
1004 | 1004 | of pdb, regardless of whether you have wrapped it into a 'main()' |
|
1005 | 1005 | function or not. For this, simply type '%run -d myscript' at an |
|
1006 | 1006 | IPython prompt. See the %run command's documentation (via '%run?' or |
|
1007 | 1007 | in Sec. magic_ for more details, including how to control where pdb |
|
1008 | 1008 | will stop execution first. |
|
1009 | 1009 | |
|
1010 | 1010 | For more information on the use of the pdb debugger, read the included |
|
1011 | 1011 | pdb.doc file (part of the standard Python distribution). On a stock |
|
1012 | 1012 | Linux system it is located at /usr/lib/python2.3/pdb.doc, but the |
|
1013 | 1013 | easiest way to read it is by using the help() function of the pdb module |
|
1014 | 1014 | as follows (in an IPython prompt):: |
|
1015 | 1015 | |
|
1016 | 1016 | In [1]: import pdb |
|
1017 | 1017 | In [2]: pdb.help() |
|
1018 | 1018 | |
|
1019 | 1019 | This will load the pdb.doc document in a file viewer for you automatically. |
|
1020 | 1020 | |
|
1021 | 1021 | |
|
1022 | 1022 | Automatic invocation of pdb on exceptions |
|
1023 | 1023 | ----------------------------------------- |
|
1024 | 1024 | |
|
1025 | 1025 | IPython, if started with the -pdb option (or if the option is set in |
|
1026 | 1026 | your rc file) can call the Python pdb debugger every time your code |
|
1027 | 1027 | triggers an uncaught exception. This feature |
|
1028 | 1028 | can also be toggled at any time with the %pdb magic command. This can be |
|
1029 | 1029 | extremely useful in order to find the origin of subtle bugs, because pdb |
|
1030 | 1030 | opens up at the point in your code which triggered the exception, and |
|
1031 | 1031 | while your program is at this point 'dead', all the data is still |
|
1032 | 1032 | available and you can walk up and down the stack frame and understand |
|
1033 | 1033 | the origin of the problem. |
|
1034 | 1034 | |
|
1035 | 1035 | Furthermore, you can use these debugging facilities both with the |
|
1036 | 1036 | embedded IPython mode and without IPython at all. For an embedded shell |
|
1037 | 1037 | (see sec. Embedding_), simply call the constructor with |
|
1038 | 1038 | '--pdb' in the argument string and automatically pdb will be called if an |
|
1039 | 1039 | uncaught exception is triggered by your code. |
|
1040 | 1040 | |
|
1041 | 1041 | For stand-alone use of the feature in your programs which do not use |
|
1042 | 1042 | IPython at all, put the following lines toward the top of your 'main' |
|
1043 | 1043 | routine:: |
|
1044 | 1044 | |
|
1045 | 1045 | import sys |
|
1046 | 1046 | from IPython.core import ultratb |
|
1047 | 1047 | sys.excepthook = ultratb.FormattedTB(mode='Verbose', |
|
1048 | 1048 | color_scheme='Linux', call_pdb=1) |
|
1049 | 1049 | |
|
1050 | 1050 | The mode keyword can be either 'Verbose' or 'Plain', giving either very |
|
1051 | 1051 | detailed or normal tracebacks respectively. The color_scheme keyword can |
|
1052 | 1052 | be one of 'NoColor', 'Linux' (default) or 'LightBG'. These are the same |
|
1053 | 1053 | options which can be set in IPython with -colors and -xmode. |
|
1054 | 1054 | |
|
1055 | 1055 | This will give any of your programs detailed, colored tracebacks with |
|
1056 | 1056 | automatic invocation of pdb. |
|
1057 | 1057 | |
|
1058 | 1058 | |
|
1059 | 1059 | Extensions for syntax processing |
|
1060 | 1060 | ================================ |
|
1061 | 1061 | |
|
1062 | 1062 | This isn't for the faint of heart, because the potential for breaking |
|
1063 | 1063 | things is quite high. But it can be a very powerful and useful feature. |
|
1064 | 1064 | In a nutshell, you can redefine the way IPython processes the user input |
|
1065 | 1065 | line to accept new, special extensions to the syntax without needing to |
|
1066 | 1066 | change any of IPython's own code. |
|
1067 | 1067 | |
|
1068 | 1068 | In the IPython/extensions directory you will find some examples |
|
1069 | 1069 | supplied, which we will briefly describe now. These can be used 'as is' |
|
1070 | 1070 | (and both provide very useful functionality), or you can use them as a |
|
1071 | 1071 | starting point for writing your own extensions. |
|
1072 | 1072 | |
|
1073 | 1073 | .. _pasting_with_prompts: |
|
1074 | 1074 | |
|
1075 | 1075 | Pasting of code starting with Python or IPython prompts |
|
1076 | 1076 | ------------------------------------------------------- |
|
1077 | 1077 | |
|
1078 | 1078 | IPython is smart enough to filter out input prompts, be they plain Python ones |
|
1079 | 1079 | (``>>>`` and ``...``) or IPython ones (``In [N]:`` and `` ...:``). You can |
|
1080 | 1080 | therefore copy and paste from existing interactive sessions without worry. |
|
1081 | 1081 | |
|
1082 | 1082 | The following is a 'screenshot' of how things work, copying an example from the |
|
1083 | 1083 | standard Python tutorial:: |
|
1084 | 1084 | |
|
1085 | 1085 | In [1]: >>> # Fibonacci series: |
|
1086 | 1086 | |
|
1087 | 1087 | In [2]: ... # the sum of two elements defines the next |
|
1088 | 1088 | |
|
1089 | 1089 | In [3]: ... a, b = 0, 1 |
|
1090 | 1090 | |
|
1091 | 1091 | In [4]: >>> while b < 10: |
|
1092 | 1092 | ...: ... print b |
|
1093 | 1093 | ...: ... a, b = b, a+b |
|
1094 | 1094 | ...: |
|
1095 | 1095 | 1 |
|
1096 | 1096 | 1 |
|
1097 | 1097 | 2 |
|
1098 | 1098 | 3 |
|
1099 | 1099 | 5 |
|
1100 | 1100 | 8 |
|
1101 | 1101 | |
|
1102 | 1102 | And pasting from IPython sessions works equally well:: |
|
1103 | 1103 | |
|
1104 | 1104 | In [1]: In [5]: def f(x): |
|
1105 | 1105 | ...: ...: "A simple function" |
|
1106 | 1106 | ...: ...: return x**2 |
|
1107 | 1107 | ...: ...: |
|
1108 | 1108 | |
|
1109 | 1109 | In [2]: f(3) |
|
1110 | 1110 | Out[2]: 9 |
|
1111 | 1111 | |
|
1112 | 1112 | .. _gui_support: |
|
1113 | 1113 | |
|
1114 | 1114 | GUI event loop support |
|
1115 | 1115 | ====================== |
|
1116 | 1116 | |
|
1117 | 1117 | .. versionadded:: 0.11 |
|
1118 | 1118 | The ``%gui`` magic and :mod:`IPython.lib.inputhook`. |
|
1119 | 1119 | |
|
1120 | 1120 | .. warning:: |
|
1121 | 1121 | |
|
1122 | 1122 | All GUI support with the ``%gui`` magic, described in this section, applies |
|
1123 | 1123 | only to the plain terminal IPython, *not* to the Qt console. The Qt console |
|
1124 | 1124 | currently only supports GUI interaction via the ``--pylab`` flag, as |
|
1125 | 1125 | explained :ref:`in the matplotlib section <matplotlib_support>`. |
|
1126 | 1126 | |
|
1127 | 1127 | We intend to correct this limitation as soon as possible, you can track our |
|
1128 | 1128 | progress at issue #643_. |
|
1129 | 1129 | |
|
1130 | 1130 | .. _643: https://github.com/ipython/ipython/issues/643 |
|
1131 | 1131 | |
|
1132 | 1132 | IPython has excellent support for working interactively with Graphical User |
|
1133 | 1133 | Interface (GUI) toolkits, such as wxPython, PyQt4, PyGTK and Tk. This is |
|
1134 | 1134 | implemented using Python's builtin ``PyOSInputHook`` hook. This implementation |
|
1135 | 1135 | is extremely robust compared to our previous thread-based version. The |
|
1136 | 1136 | advantages of this are: |
|
1137 | 1137 | |
|
1138 | 1138 | * GUIs can be enabled and disabled dynamically at runtime. |
|
1139 | 1139 | * The active GUI can be switched dynamically at runtime. |
|
1140 | 1140 | * In some cases, multiple GUIs can run simultaneously with no problems. |
|
1141 | 1141 | * There is a developer API in :mod:`IPython.lib.inputhook` for customizing |
|
1142 | 1142 | all of these things. |
|
1143 | 1143 | |
|
1144 | 1144 | For users, enabling GUI event loop integration is simple. You simple use the |
|
1145 | 1145 | ``%gui`` magic as follows:: |
|
1146 | 1146 | |
|
1147 | 1147 | %gui [GUINAME] |
|
1148 | 1148 | |
|
1149 | 1149 | With no arguments, ``%gui`` removes all GUI support. Valid ``GUINAME`` |
|
1150 | 1150 | arguments are ``wx``, ``qt4``, ``gtk`` and ``tk``. |
|
1151 | 1151 | |
|
1152 | 1152 | Thus, to use wxPython interactively and create a running :class:`wx.App` |
|
1153 | 1153 | object, do:: |
|
1154 | 1154 | |
|
1155 | 1155 | %gui wx |
|
1156 | 1156 | |
|
1157 | 1157 | For information on IPython's Matplotlib integration (and the ``pylab`` mode) |
|
1158 | 1158 | see :ref:`this section <matplotlib_support>`. |
|
1159 | 1159 | |
|
1160 | 1160 | For developers that want to use IPython's GUI event loop integration in the |
|
1161 | 1161 | form of a library, these capabilities are exposed in library form in the |
|
1162 | 1162 | :mod:`IPython.lib.inputhook` and :mod:`IPython.lib.guisupport` modules. |
|
1163 | 1163 | Interested developers should see the module docstrings for more information, |
|
1164 | 1164 | but there are a few points that should be mentioned here. |
|
1165 | 1165 | |
|
1166 | 1166 | First, the ``PyOSInputHook`` approach only works in command line settings |
|
1167 | 1167 | where readline is activated. As indicated in the warning above, we plan on |
|
1168 | 1168 | improving the integration of GUI event loops with the standalone kernel used by |
|
1169 | 1169 | the Qt console and other frontends (issue 643_). |
|
1170 | 1170 | |
|
1171 | 1171 | Second, when using the ``PyOSInputHook`` approach, a GUI application should |
|
1172 | 1172 | *not* start its event loop. Instead all of this is handled by the |
|
1173 | 1173 | ``PyOSInputHook``. This means that applications that are meant to be used both |
|
1174 | 1174 | in IPython and as standalone apps need to have special code to detects how the |
|
1175 | 1175 | application is being run. We highly recommend using IPython's support for this. |
|
1176 | 1176 | Since the details vary slightly between toolkits, we point you to the various |
|
1177 | 1177 | examples in our source directory :file:`docs/examples/lib` that demonstrate |
|
1178 | 1178 | these capabilities. |
|
1179 | 1179 | |
|
1180 | 1180 | .. warning:: |
|
1181 | 1181 | |
|
1182 | 1182 | The WX version of this is currently broken. While ``--pylab=wx`` works |
|
1183 | 1183 | fine, standalone WX apps do not. See |
|
1184 | 1184 | https://github.com/ipython/ipython/issues/645 for details of our progress on |
|
1185 | 1185 | this issue. |
|
1186 | 1186 | |
|
1187 | 1187 | |
|
1188 | 1188 | Third, unlike previous versions of IPython, we no longer "hijack" (replace |
|
1189 | 1189 | them with no-ops) the event loops. This is done to allow applications that |
|
1190 | 1190 | actually need to run the real event loops to do so. This is often needed to |
|
1191 | 1191 | process pending events at critical points. |
|
1192 | 1192 | |
|
1193 | 1193 | Finally, we also have a number of examples in our source directory |
|
1194 | 1194 | :file:`docs/examples/lib` that demonstrate these capabilities. |
|
1195 | 1195 | |
|
1196 | 1196 | PyQt and PySide |
|
1197 | 1197 | --------------- |
|
1198 | 1198 | |
|
1199 | 1199 | .. attempt at explanation of the complete mess that is Qt support |
|
1200 | 1200 | |
|
1201 | 1201 | When you use ``--gui=qt`` or ``--pylab=qt``, IPython can work with either |
|
1202 | 1202 | PyQt4 or PySide. There are three options for configuration here, because |
|
1203 | 1203 | PyQt4 has two APIs for QString and QVariant - v1, which is the default on |
|
1204 | 1204 | Python 2, and the more natural v2, which is the only API supported by PySide. |
|
1205 | 1205 | v2 is also the default for PyQt4 on Python 3. IPython's code for the QtConsole |
|
1206 | 1206 | uses v2, but you can still use any interface in your code, since the |
|
1207 | 1207 | Qt frontend is in a different process. |
|
1208 | 1208 | |
|
1209 | 1209 | The default will be to import PyQt4 without configuration of the APIs, thus |
|
1210 | 1210 | matching what most applications would expect. It will fall back of PySide if |
|
1211 | 1211 | PyQt4 is unavailable. |
|
1212 | 1212 | |
|
1213 | 1213 | If specified, IPython will respect the environment variable ``QT_API`` used |
|
1214 | 1214 | by ETS. ETS 4.0 also works with both PyQt4 and PySide, but it requires |
|
1215 | 1215 | PyQt4 to use its v2 API. So if ``QT_API=pyside`` PySide will be used, |
|
1216 | 1216 | and if ``QT_API=pyqt`` then PyQt4 will be used *with the v2 API* for |
|
1217 | 1217 | QString and QVariant, so ETS codes like MayaVi will also work with IPython. |
|
1218 | 1218 | |
|
1219 | 1219 | If you launch IPython in pylab mode with ``ipython --pylab=qt``, then IPython |
|
1220 | 1220 | will ask matplotlib which Qt library to use (only if QT_API is *not set*), via |
|
1221 | 1221 | the 'backend.qt4' rcParam. If matplotlib is version 1.0.1 or older, then |
|
1222 | 1222 | IPython will always use PyQt4 without setting the v2 APIs, since neither v2 |
|
1223 | 1223 | PyQt nor PySide work. |
|
1224 | 1224 | |
|
1225 | 1225 | .. warning:: |
|
1226 | 1226 | |
|
1227 | 1227 | Note that this means for ETS 4 to work with PyQt4, ``QT_API`` *must* be set |
|
1228 | 1228 | to work with IPython's qt integration, because otherwise PyQt4 will be |
|
1229 | 1229 | loaded in an incompatible mode. |
|
1230 | 1230 | |
|
1231 | 1231 | It also means that you must *not* have ``QT_API`` set if you want to |
|
1232 | 1232 | use ``--gui=qt`` with code that requires PyQt4 API v1. |
|
1233 | 1233 | |
|
1234 | 1234 | |
|
1235 | 1235 | .. _matplotlib_support: |
|
1236 | 1236 | |
|
1237 | 1237 | Plotting with matplotlib |
|
1238 | 1238 | ======================== |
|
1239 | 1239 | |
|
1240 | 1240 | `Matplotlib`_ provides high quality 2D and 3D plotting for Python. Matplotlib |
|
1241 | 1241 | can produce plots on screen using a variety of GUI toolkits, including Tk, |
|
1242 | 1242 | PyGTK, PyQt4 and wxPython. It also provides a number of commands useful for |
|
1243 | 1243 | scientific computing, all with a syntax compatible with that of the popular |
|
1244 | 1244 | Matlab program. |
|
1245 | 1245 | |
|
1246 | 1246 | To start IPython with matplotlib support, use the ``--pylab`` switch. If no |
|
1247 | 1247 | arguments are given, IPython will automatically detect your choice of |
|
1248 | 1248 | matplotlib backend. You can also request a specific backend with |
|
1249 | 1249 | ``--pylab=backend``, where ``backend`` must be one of: 'tk', 'qt', 'wx', 'gtk', |
|
1250 | 1250 | 'osx'. |
|
1251 | 1251 | |
|
1252 | 1252 | .. _Matplotlib: http://matplotlib.sourceforge.net |
|
1253 | 1253 | |
|
1254 | 1254 | .. _interactive_demos: |
|
1255 | 1255 | |
|
1256 | 1256 | Interactive demos with IPython |
|
1257 | 1257 | ============================== |
|
1258 | 1258 | |
|
1259 | 1259 | IPython ships with a basic system for running scripts interactively in |
|
1260 | 1260 | sections, useful when presenting code to audiences. A few tags embedded |
|
1261 | 1261 | in comments (so that the script remains valid Python code) divide a file |
|
1262 | 1262 | into separate blocks, and the demo can be run one block at a time, with |
|
1263 | 1263 | IPython printing (with syntax highlighting) the block before executing |
|
1264 | 1264 | it, and returning to the interactive prompt after each block. The |
|
1265 | 1265 | interactive namespace is updated after each block is run with the |
|
1266 | 1266 | contents of the demo's namespace. |
|
1267 | 1267 | |
|
1268 | 1268 | This allows you to show a piece of code, run it and then execute |
|
1269 | 1269 | interactively commands based on the variables just created. Once you |
|
1270 | 1270 | want to continue, you simply execute the next block of the demo. The |
|
1271 | 1271 | following listing shows the markup necessary for dividing a script into |
|
1272 | 1272 | sections for execution as a demo: |
|
1273 | 1273 | |
|
1274 | 1274 | .. literalinclude:: ../../examples/lib/example-demo.py |
|
1275 | 1275 | :language: python |
|
1276 | 1276 | |
|
1277 | 1277 | In order to run a file as a demo, you must first make a Demo object out |
|
1278 | 1278 | of it. If the file is named myscript.py, the following code will make a |
|
1279 | 1279 | demo:: |
|
1280 | 1280 | |
|
1281 | 1281 | from IPython.lib.demo import Demo |
|
1282 | 1282 | |
|
1283 | 1283 | mydemo = Demo('myscript.py') |
|
1284 | 1284 | |
|
1285 | 1285 | This creates the mydemo object, whose blocks you run one at a time by |
|
1286 | 1286 | simply calling the object with no arguments. If you have autocall active |
|
1287 | 1287 | in IPython (the default), all you need to do is type:: |
|
1288 | 1288 | |
|
1289 | 1289 | mydemo |
|
1290 | 1290 | |
|
1291 | 1291 | and IPython will call it, executing each block. Demo objects can be |
|
1292 | 1292 | restarted, you can move forward or back skipping blocks, re-execute the |
|
1293 | 1293 | last block, etc. Simply use the Tab key on a demo object to see its |
|
1294 | 1294 | methods, and call '?' on them to see their docstrings for more usage |
|
1295 | 1295 | details. In addition, the demo module itself contains a comprehensive |
|
1296 | 1296 | docstring, which you can access via:: |
|
1297 | 1297 | |
|
1298 | 1298 | from IPython.lib import demo |
|
1299 | 1299 | |
|
1300 | 1300 | demo? |
|
1301 | 1301 | |
|
1302 | 1302 | Limitations: It is important to note that these demos are limited to |
|
1303 | 1303 | fairly simple uses. In particular, you can not put division marks in |
|
1304 | 1304 | indented code (loops, if statements, function definitions, etc.) |
|
1305 | 1305 | Supporting something like this would basically require tracking the |
|
1306 | 1306 | internal execution state of the Python interpreter, so only top-level |
|
1307 | 1307 | divisions are allowed. If you want to be able to open an IPython |
|
1308 | 1308 | instance at an arbitrary point in a program, you can use IPython's |
|
1309 | 1309 | embedding facilities, see :func:`IPython.embed` for details. |
|
1310 | 1310 |
@@ -1,131 +1,135 b'' | |||
|
1 | 1 | .. _tips: |
|
2 | 2 | |
|
3 | 3 | ===================== |
|
4 | 4 | IPython Tips & Tricks |
|
5 | 5 | ===================== |
|
6 | 6 | |
|
7 | 7 | The `IPython cookbook <http://ipython.scipy.org/moin/Cookbook>`_ details more |
|
8 | 8 | things you can do with IPython. |
|
9 | 9 | |
|
10 | 10 | .. This is not in the current version: |
|
11 | 11 | |
|
12 | 12 | |
|
13 | 13 | Embed IPython in your programs |
|
14 | 14 | ------------------------------ |
|
15 | 15 | |
|
16 | 16 | A few lines of code are enough to load a complete IPython inside your own |
|
17 | 17 | programs, giving you the ability to work with your data interactively after |
|
18 | 18 | automatic processing has been completed. See :ref:`the embedding section <embedding>`. |
|
19 | 19 | |
|
20 | 20 | Run doctests |
|
21 | 21 | ------------ |
|
22 | 22 | |
|
23 | 23 | Run your doctests from within IPython for development and debugging. The |
|
24 | 24 | special %doctest_mode command toggles a mode where the prompt, output and |
|
25 | 25 | exceptions display matches as closely as possible that of the default Python |
|
26 | 26 | interpreter. In addition, this mode allows you to directly paste in code that |
|
27 | 27 | contains leading '>>>' prompts, even if they have extra leading whitespace |
|
28 | 28 | (as is common in doctest files). This combined with the ``%history -t`` call |
|
29 | 29 | to see your translated history allows for an easy doctest workflow, where you |
|
30 | 30 | can go from doctest to interactive execution to pasting into valid Python code |
|
31 | 31 | as needed. |
|
32 | 32 | |
|
33 | 33 | Use IPython to present interactive demos |
|
34 | 34 | ---------------------------------------- |
|
35 | 35 | |
|
36 | 36 | Use the :class:`IPython.lib.demo.Demo` class to load any Python script as an interactive |
|
37 | 37 | demo. With a minimal amount of simple markup, you can control the execution of |
|
38 | 38 | the script, stopping as needed. See :ref:`here <interactive_demos>` for more. |
|
39 | 39 | |
|
40 | 40 | Suppress output |
|
41 | 41 | --------------- |
|
42 | 42 | |
|
43 | 43 | Put a ';' at the end of a line to suppress the printing of output. This is |
|
44 | 44 | useful when doing calculations which generate long output you are not |
|
45 | 45 | interested in seeing. |
|
46 | 46 | |
|
47 | 47 | Lightweight 'version control' |
|
48 | 48 | ----------------------------- |
|
49 | 49 | |
|
50 | 50 | When you call ``%edit`` with no arguments, IPython opens an empty editor |
|
51 | 51 | with a temporary file, and it returns the contents of your editing |
|
52 | 52 | session as a string variable. Thanks to IPython's output caching |
|
53 | 53 | mechanism, this is automatically stored:: |
|
54 | 54 | |
|
55 | 55 | In [1]: %edit |
|
56 | 56 | |
|
57 | 57 | IPython will make a temporary file named: /tmp/ipython_edit_yR-HCN.py |
|
58 | 58 | |
|
59 | 59 | Editing... done. Executing edited code... |
|
60 | 60 | |
|
61 | 61 | hello - this is a temporary file |
|
62 | 62 | |
|
63 | 63 | Out[1]: "print 'hello - this is a temporary file'\n" |
|
64 | 64 | |
|
65 | 65 | Now, if you call ``%edit -p``, IPython tries to open an editor with the |
|
66 | 66 | same data as the last time you used %edit. So if you haven't used %edit |
|
67 | 67 | in the meantime, this same contents will reopen; however, it will be |
|
68 | 68 | done in a new file. This means that if you make changes and you later |
|
69 | 69 | want to find an old version, you can always retrieve it by using its |
|
70 | 70 | output number, via '%edit _NN', where NN is the number of the output |
|
71 | 71 | prompt. |
|
72 | 72 | |
|
73 | 73 | Continuing with the example above, this should illustrate this idea:: |
|
74 | 74 | |
|
75 | 75 | In [2]: edit -p |
|
76 | 76 | |
|
77 | 77 | IPython will make a temporary file named: /tmp/ipython_edit_nA09Qk.py |
|
78 | 78 | |
|
79 | 79 | Editing... done. Executing edited code... |
|
80 | 80 | |
|
81 | 81 | hello - now I made some changes |
|
82 | 82 | |
|
83 | 83 | Out[2]: "print 'hello - now I made some changes'\n" |
|
84 | 84 | |
|
85 | 85 | In [3]: edit _1 |
|
86 | 86 | |
|
87 | 87 | IPython will make a temporary file named: /tmp/ipython_edit_gy6-zD.py |
|
88 | 88 | |
|
89 | 89 | Editing... done. Executing edited code... |
|
90 | 90 | |
|
91 | 91 | hello - this is a temporary file |
|
92 | 92 | |
|
93 | 93 | IPython version control at work :) |
|
94 | 94 | |
|
95 | 95 | Out[3]: "print 'hello - this is a temporary file'\nprint 'IPython version control at work :)'\n" |
|
96 | 96 | |
|
97 | 97 | |
|
98 | 98 | This section was written after a contribution by Alexander Belchenko on |
|
99 | 99 | the IPython user list. |
|
100 | 100 | |
|
101 | 101 | .. The section below needs to be updated for the new config system. |
|
102 | 102 | |
|
103 | 103 | .. Effective logging |
|
104 | 104 | ----------------- |
|
105 | 105 | |
|
106 | 106 | .. A very useful suggestion sent in by Robert Kern follows: |
|
107 | 107 | |
|
108 | 108 | .. I recently happened on a nifty way to keep tidy per-project log files. I |
|
109 | 109 | made a profile for my project (which is called "parkfield"):: |
|
110 | 110 | |
|
111 | 111 | include ipythonrc |
|
112 | 112 | |
|
113 | 113 | # cancel earlier logfile invocation: |
|
114 | 114 | |
|
115 | 115 | logfile '' |
|
116 | 116 | |
|
117 | 117 | execute import time |
|
118 | 118 | |
|
119 | 119 | execute __cmd = '/Users/kern/research/logfiles/parkfield-%s.log rotate' |
|
120 | 120 | |
|
121 | 121 | execute __IP.magic_logstart(__cmd % time.strftime('%Y-%m-%d')) |
|
122 | 122 | |
|
123 | 123 | .. I also added a shell alias for convenience:: |
|
124 | 124 | |
|
125 | 125 | alias parkfield="ipython --pylab profile=parkfield" |
|
126 | 126 | |
|
127 | 127 | .. Now I have a nice little directory with everything I ever type in, |
|
128 | 128 | organized by project and date. |
|
129 | 129 | |
|
130 | .. warning:: | |
|
131 | ||
|
132 | This example uses the outdated ipythonrc-style configuration files, which no | |
|
133 | longer work as of IPython 0.11 | |
|
130 | 134 | |
|
131 | 135 |
General Comments 0
You need to be logged in to leave comments.
Login now