Show More
@@ -1,529 +1,529 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """Usage information for the main IPython applications. |
|
2 | """Usage information for the main IPython applications. | |
3 | """ |
|
3 | """ | |
4 | #----------------------------------------------------------------------------- |
|
4 | #----------------------------------------------------------------------------- | |
5 | # Copyright (C) 2008-2010 The IPython Development Team |
|
5 | # Copyright (C) 2008-2010 The IPython Development Team | |
6 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> |
|
6 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> | |
7 | # |
|
7 | # | |
8 | # Distributed under the terms of the BSD License. The full license is in |
|
8 | # Distributed under the terms of the BSD License. The full license is in | |
9 | # the file COPYING, distributed as part of this software. |
|
9 | # the file COPYING, distributed as part of this software. | |
10 | #----------------------------------------------------------------------------- |
|
10 | #----------------------------------------------------------------------------- | |
11 |
|
11 | |||
12 | import sys |
|
12 | import sys | |
13 | from IPython.core import release |
|
13 | from IPython.core import release | |
14 |
|
14 | |||
15 | cl_usage = """\ |
|
15 | cl_usage = """\ | |
16 | ========= |
|
16 | ========= | |
17 | IPython |
|
17 | IPython | |
18 | ========= |
|
18 | ========= | |
19 |
|
19 | |||
20 | Tools for Interactive Computing in Python |
|
20 | Tools for Interactive Computing in Python | |
21 | ========================================= |
|
21 | ========================================= | |
22 |
|
22 | |||
23 | A Python shell with automatic history (input and output), dynamic object |
|
23 | A Python shell with automatic history (input and output), dynamic object | |
24 | introspection, easier configuration, command completion, access to the |
|
24 | introspection, easier configuration, command completion, access to the | |
25 | system shell and more. IPython can also be embedded in running programs. |
|
25 | system shell and more. IPython can also be embedded in running programs. | |
26 |
|
26 | |||
27 |
|
27 | |||
28 | Usage |
|
28 | Usage | |
29 |
|
29 | |||
30 | ipython [subcommand] [options] [files] |
|
30 | ipython [subcommand] [options] [files] | |
31 |
|
31 | |||
32 | If invoked with no options, it executes all the files listed in sequence |
|
32 | If invoked with no options, it executes all the files listed in sequence | |
33 | and exits, use -i to enter interactive mode after running the files. Files |
|
33 | and exits, use -i to enter interactive mode after running the files. Files | |
34 | ending in .py will be treated as normal Python, but files ending in .ipy |
|
34 | ending in .py will be treated as normal Python, but files ending in .ipy | |
35 | can contain special IPython syntax (magic commands, shell expansions, etc.) |
|
35 | can contain special IPython syntax (magic commands, shell expansions, etc.) | |
36 |
|
36 | |||
37 | Almost all configuration in IPython is available via the command-line. Do |
|
37 | Almost all configuration in IPython is available via the command-line. Do | |
38 | `ipython --help-all` to see all available options. For persistent |
|
38 | `ipython --help-all` to see all available options. For persistent | |
39 | configuration, look into your `ipython_config.py` configuration file for |
|
39 | configuration, look into your `ipython_config.py` configuration file for | |
40 | details. |
|
40 | details. | |
41 |
|
41 | |||
42 | This file is typically installed in the `IPYTHON_DIR` directory, and there |
|
42 | This file is typically installed in the `IPYTHON_DIR` directory, and there | |
43 | is a separate configuration directory for each profile. The default profile |
|
43 | is a separate configuration directory for each profile. The default profile | |
44 | directory will be located in $IPYTHON_DIR/profile_default. For Linux users, |
|
44 | directory will be located in $IPYTHON_DIR/profile_default. For Linux users, | |
45 | IPYTHON_DIR defaults to `$HOME/.config/ipython`, and for other Unix systems |
|
45 | IPYTHON_DIR defaults to `$HOME/.config/ipython`, and for other Unix systems | |
46 | to `$HOME/.ipython`. For Windows users, $HOME resolves to C:\\Documents |
|
46 | to `$HOME/.ipython`. For Windows users, $HOME resolves to C:\\Documents | |
47 | and Settings\\YourUserName in most instances. |
|
47 | and Settings\\YourUserName in most instances. | |
48 |
|
48 | |||
49 | To initialize a profile with the default configuration file, do:: |
|
49 | To initialize a profile with the default configuration file, do:: | |
50 |
|
50 | |||
51 | $> ipython profile create |
|
51 | $> ipython profile create | |
52 |
|
52 | |||
53 | and start editing `IPYTHON_DIR/profile_default/ipython_config.py` |
|
53 | and start editing `IPYTHON_DIR/profile_default/ipython_config.py` | |
54 |
|
54 | |||
55 | In IPython's documentation, we will refer to this directory as |
|
55 | In IPython's documentation, we will refer to this directory as | |
56 | `IPYTHON_DIR`, you can change its default location by creating an |
|
56 | `IPYTHON_DIR`, you can change its default location by creating an | |
57 | environment variable with this name and setting it to the desired path. |
|
57 | environment variable with this name and setting it to the desired path. | |
58 |
|
58 | |||
59 | For more information, see the manual available in HTML and PDF in your |
|
59 | For more information, see the manual available in HTML and PDF in your | |
60 | installation, or online at http://ipython.org/documentation.html. |
|
60 | installation, or online at http://ipython.org/documentation.html. | |
61 | """ |
|
61 | """ | |
62 |
|
62 | |||
63 | interactive_usage = """ |
|
63 | interactive_usage = """ | |
64 | IPython -- An enhanced Interactive Python |
|
64 | IPython -- An enhanced Interactive Python | |
65 | ========================================= |
|
65 | ========================================= | |
66 |
|
66 | |||
67 | IPython offers a combination of convenient shell features, special commands |
|
67 | IPython offers a combination of convenient shell features, special commands | |
68 | and a history mechanism for both input (command history) and output (results |
|
68 | and a history mechanism for both input (command history) and output (results | |
69 | caching, similar to Mathematica). It is intended to be a fully compatible |
|
69 | caching, similar to Mathematica). It is intended to be a fully compatible | |
70 | replacement for the standard Python interpreter, while offering vastly |
|
70 | replacement for the standard Python interpreter, while offering vastly | |
71 | improved functionality and flexibility. |
|
71 | improved functionality and flexibility. | |
72 |
|
72 | |||
73 | At your system command line, type 'ipython -h' to see the command line |
|
73 | At your system command line, type 'ipython -h' to see the command line | |
74 | options available. This document only describes interactive features. |
|
74 | options available. This document only describes interactive features. | |
75 |
|
75 | |||
76 | MAIN FEATURES |
|
76 | MAIN FEATURES | |
77 |
|
77 | |||
78 | * Access to the standard Python help. As of Python 2.1, a help system is |
|
78 | * Access to the standard Python help. As of Python 2.1, a help system is | |
79 | available with access to object docstrings and the Python manuals. Simply |
|
79 | available with access to object docstrings and the Python manuals. Simply | |
80 | type 'help' (no quotes) to access it. |
|
80 | type 'help' (no quotes) to access it. | |
81 |
|
81 | |||
82 | * Magic commands: type %magic for information on the magic subsystem. |
|
82 | * Magic commands: type %magic for information on the magic subsystem. | |
83 |
|
83 | |||
84 | * System command aliases, via the %alias command or the configuration file(s). |
|
84 | * System command aliases, via the %alias command or the configuration file(s). | |
85 |
|
85 | |||
86 | * Dynamic object information: |
|
86 | * Dynamic object information: | |
87 |
|
87 | |||
88 | Typing ?word or word? prints detailed information about an object. If |
|
88 | Typing ?word or word? prints detailed information about an object. If | |
89 | certain strings in the object are too long (docstrings, code, etc.) they get |
|
89 | certain strings in the object are too long (docstrings, code, etc.) they get | |
90 | snipped in the center for brevity. |
|
90 | snipped in the center for brevity. | |
91 |
|
91 | |||
92 | Typing ??word or word?? gives access to the full information without |
|
92 | Typing ??word or word?? gives access to the full information without | |
93 | snipping long strings. Long strings are sent to the screen through the less |
|
93 | snipping long strings. Long strings are sent to the screen through the less | |
94 | pager if longer than the screen, printed otherwise. |
|
94 | pager if longer than the screen, printed otherwise. | |
95 |
|
95 | |||
96 | The ?/?? system gives access to the full source code for any object (if |
|
96 | The ?/?? system gives access to the full source code for any object (if | |
97 | available), shows function prototypes and other useful information. |
|
97 | available), shows function prototypes and other useful information. | |
98 |
|
98 | |||
99 | If you just want to see an object's docstring, type '%pdoc object' (without |
|
99 | If you just want to see an object's docstring, type '%pdoc object' (without | |
100 | quotes, and without % if you have automagic on). |
|
100 | quotes, and without % if you have automagic on). | |
101 |
|
101 | |||
102 | Both %pdoc and ?/?? give you access to documentation even on things which are |
|
102 | Both %pdoc and ?/?? give you access to documentation even on things which are | |
103 | not explicitely defined. Try for example typing {}.get? or after import os, |
|
103 | not explicitely defined. Try for example typing {}.get? or after import os, | |
104 | type os.path.abspath??. The magic functions %pdef, %source and %file operate |
|
104 | type os.path.abspath??. The magic functions %pdef, %source and %file operate | |
105 | similarly. |
|
105 | similarly. | |
106 |
|
106 | |||
107 | * Completion in the local namespace, by typing TAB at the prompt. |
|
107 | * Completion in the local namespace, by typing TAB at the prompt. | |
108 |
|
108 | |||
109 | At any time, hitting tab will complete any available python commands or |
|
109 | At any time, hitting tab will complete any available python commands or | |
110 | variable names, and show you a list of the possible completions if there's |
|
110 | variable names, and show you a list of the possible completions if there's | |
111 | no unambiguous one. It will also complete filenames in the current directory. |
|
111 | no unambiguous one. It will also complete filenames in the current directory. | |
112 |
|
112 | |||
113 | This feature requires the readline and rlcomplete modules, so it won't work |
|
113 | This feature requires the readline and rlcomplete modules, so it won't work | |
114 | if your Python lacks readline support (such as under Windows). |
|
114 | if your Python lacks readline support (such as under Windows). | |
115 |
|
115 | |||
116 | * Search previous command history in two ways (also requires readline): |
|
116 | * Search previous command history in two ways (also requires readline): | |
117 |
|
117 | |||
118 | - Start typing, and then use Ctrl-p (previous,up) and Ctrl-n (next,down) to |
|
118 | - Start typing, and then use Ctrl-p (previous,up) and Ctrl-n (next,down) to | |
119 | search through only the history items that match what you've typed so |
|
119 | search through only the history items that match what you've typed so | |
120 | far. If you use Ctrl-p/Ctrl-n at a blank prompt, they just behave like |
|
120 | far. If you use Ctrl-p/Ctrl-n at a blank prompt, they just behave like | |
121 | normal arrow keys. |
|
121 | normal arrow keys. | |
122 |
|
122 | |||
123 | - Hit Ctrl-r: opens a search prompt. Begin typing and the system searches |
|
123 | - Hit Ctrl-r: opens a search prompt. Begin typing and the system searches | |
124 | your history for lines that match what you've typed so far, completing as |
|
124 | your history for lines that match what you've typed so far, completing as | |
125 | much as it can. |
|
125 | much as it can. | |
126 |
|
126 | |||
127 | - %hist: search history by index (this does *not* require readline). |
|
127 | - %hist: search history by index (this does *not* require readline). | |
128 |
|
128 | |||
129 | * Persistent command history across sessions. |
|
129 | * Persistent command history across sessions. | |
130 |
|
130 | |||
131 | * Logging of input with the ability to save and restore a working session. |
|
131 | * Logging of input with the ability to save and restore a working session. | |
132 |
|
132 | |||
133 | * System escape with !. Typing !ls will run 'ls' in the current directory. |
|
133 | * System escape with !. Typing !ls will run 'ls' in the current directory. | |
134 |
|
134 | |||
135 | * The reload command does a 'deep' reload of a module: changes made to the |
|
135 | * The reload command does a 'deep' reload of a module: changes made to the | |
136 | module since you imported will actually be available without having to exit. |
|
136 | module since you imported will actually be available without having to exit. | |
137 |
|
137 | |||
138 | * Verbose and colored exception traceback printouts. See the magic xmode and |
|
138 | * Verbose and colored exception traceback printouts. See the magic xmode and | |
139 | xcolor functions for details (just type %magic). |
|
139 | xcolor functions for details (just type %magic). | |
140 |
|
140 | |||
141 | * Input caching system: |
|
141 | * Input caching system: | |
142 |
|
142 | |||
143 | IPython offers numbered prompts (In/Out) with input and output caching. All |
|
143 | IPython offers numbered prompts (In/Out) with input and output caching. All | |
144 | input is saved and can be retrieved as variables (besides the usual arrow |
|
144 | input is saved and can be retrieved as variables (besides the usual arrow | |
145 | key recall). |
|
145 | key recall). | |
146 |
|
146 | |||
147 | The following GLOBAL variables always exist (so don't overwrite them!): |
|
147 | The following GLOBAL variables always exist (so don't overwrite them!): | |
148 | _i: stores previous input. |
|
148 | _i: stores previous input. | |
149 | _ii: next previous. |
|
149 | _ii: next previous. | |
150 | _iii: next-next previous. |
|
150 | _iii: next-next previous. | |
151 | _ih : a list of all input _ih[n] is the input from line n. |
|
151 | _ih : a list of all input _ih[n] is the input from line n. | |
152 |
|
152 | |||
153 | Additionally, global variables named _i<n> are dynamically created (<n> |
|
153 | Additionally, global variables named _i<n> are dynamically created (<n> | |
154 | being the prompt counter), such that _i<n> == _ih[<n>] |
|
154 | being the prompt counter), such that _i<n> == _ih[<n>] | |
155 |
|
155 | |||
156 | For example, what you typed at prompt 14 is available as _i14 and _ih[14]. |
|
156 | For example, what you typed at prompt 14 is available as _i14 and _ih[14]. | |
157 |
|
157 | |||
158 | You can create macros which contain multiple input lines from this history, |
|
158 | You can create macros which contain multiple input lines from this history, | |
159 | for later re-execution, with the %macro function. |
|
159 | for later re-execution, with the %macro function. | |
160 |
|
160 | |||
161 | The history function %hist allows you to see any part of your input history |
|
161 | The history function %hist allows you to see any part of your input history | |
162 | by printing a range of the _i variables. Note that inputs which contain |
|
162 | by printing a range of the _i variables. Note that inputs which contain | |
163 | magic functions (%) appear in the history with a prepended comment. This is |
|
163 | magic functions (%) appear in the history with a prepended comment. This is | |
164 | because they aren't really valid Python code, so you can't exec them. |
|
164 | because they aren't really valid Python code, so you can't exec them. | |
165 |
|
165 | |||
166 | * Output caching system: |
|
166 | * Output caching system: | |
167 |
|
167 | |||
168 | For output that is returned from actions, a system similar to the input |
|
168 | For output that is returned from actions, a system similar to the input | |
169 | cache exists but using _ instead of _i. Only actions that produce a result |
|
169 | cache exists but using _ instead of _i. Only actions that produce a result | |
170 | (NOT assignments, for example) are cached. If you are familiar with |
|
170 | (NOT assignments, for example) are cached. If you are familiar with | |
171 | Mathematica, IPython's _ variables behave exactly like Mathematica's % |
|
171 | Mathematica, IPython's _ variables behave exactly like Mathematica's % | |
172 | variables. |
|
172 | variables. | |
173 |
|
173 | |||
174 | The following GLOBAL variables always exist (so don't overwrite them!): |
|
174 | The following GLOBAL variables always exist (so don't overwrite them!): | |
175 | _ (one underscore): previous output. |
|
175 | _ (one underscore): previous output. | |
176 | __ (two underscores): next previous. |
|
176 | __ (two underscores): next previous. | |
177 | ___ (three underscores): next-next previous. |
|
177 | ___ (three underscores): next-next previous. | |
178 |
|
178 | |||
179 | Global variables named _<n> are dynamically created (<n> being the prompt |
|
179 | Global variables named _<n> are dynamically created (<n> being the prompt | |
180 | counter), such that the result of output <n> is always available as _<n>. |
|
180 | counter), such that the result of output <n> is always available as _<n>. | |
181 |
|
181 | |||
182 | Finally, a global dictionary named _oh exists with entries for all lines |
|
182 | Finally, a global dictionary named _oh exists with entries for all lines | |
183 | which generated output. |
|
183 | which generated output. | |
184 |
|
184 | |||
185 | * Directory history: |
|
185 | * Directory history: | |
186 |
|
186 | |||
187 | Your history of visited directories is kept in the global list _dh, and the |
|
187 | Your history of visited directories is kept in the global list _dh, and the | |
188 | magic %cd command can be used to go to any entry in that list. |
|
188 | magic %cd command can be used to go to any entry in that list. | |
189 |
|
189 | |||
190 | * Auto-parentheses and auto-quotes (adapted from Nathan Gray's LazyPython) |
|
190 | * Auto-parentheses and auto-quotes (adapted from Nathan Gray's LazyPython) | |
191 |
|
191 | |||
192 | 1. Auto-parentheses |
|
192 | 1. Auto-parentheses | |
193 | Callable objects (i.e. functions, methods, etc) can be invoked like |
|
193 | Callable objects (i.e. functions, methods, etc) can be invoked like | |
194 | this (notice the commas between the arguments): |
|
194 | this (notice the commas between the arguments): | |
195 |
|
|
195 | In [1]: callable_ob arg1, arg2, arg3 | |
196 | and the input will be translated to this: |
|
196 | and the input will be translated to this: | |
197 | --> callable_ob(arg1, arg2, arg3) |
|
197 | ------> callable_ob(arg1, arg2, arg3) | |
198 | You can force auto-parentheses by using '/' as the first character |
|
198 | You can force auto-parentheses by using '/' as the first character | |
199 | of a line. For example: |
|
199 | of a line. For example: | |
200 |
|
|
200 | In [1]: /globals # becomes 'globals()' | |
201 | Note that the '/' MUST be the first character on the line! This |
|
201 | Note that the '/' MUST be the first character on the line! This | |
202 | won't work: |
|
202 | won't work: | |
203 |
|
|
203 | In [2]: print /globals # syntax error | |
204 |
|
204 | |||
205 | In most cases the automatic algorithm should work, so you should |
|
205 | In most cases the automatic algorithm should work, so you should | |
206 | rarely need to explicitly invoke /. One notable exception is if you |
|
206 | rarely need to explicitly invoke /. One notable exception is if you | |
207 | are trying to call a function with a list of tuples as arguments (the |
|
207 | are trying to call a function with a list of tuples as arguments (the | |
208 | parenthesis will confuse IPython): |
|
208 | parenthesis will confuse IPython): | |
209 | In [1]: zip (1,2,3),(4,5,6) # won't work |
|
209 | In [1]: zip (1,2,3),(4,5,6) # won't work | |
210 | but this will work: |
|
210 | but this will work: | |
211 | In [2]: /zip (1,2,3),(4,5,6) |
|
211 | In [2]: /zip (1,2,3),(4,5,6) | |
212 | ------> zip ((1,2,3),(4,5,6)) |
|
212 | ------> zip ((1,2,3),(4,5,6)) | |
213 | Out[2]= [(1, 4), (2, 5), (3, 6)] |
|
213 | Out[2]= [(1, 4), (2, 5), (3, 6)] | |
214 |
|
214 | |||
215 | IPython tells you that it has altered your command line by |
|
215 | IPython tells you that it has altered your command line by | |
216 | displaying the new command line preceded by -->. e.g.: |
|
216 | displaying the new command line preceded by -->. e.g.: | |
217 | In [18]: callable list |
|
217 | In [18]: callable list | |
218 | -------> callable (list) |
|
218 | -------> callable (list) | |
219 |
|
219 | |||
220 | 2. Auto-Quoting |
|
220 | 2. Auto-Quoting | |
221 | You can force auto-quoting of a function's arguments by using ',' as |
|
221 | You can force auto-quoting of a function's arguments by using ',' as | |
222 | the first character of a line. For example: |
|
222 | the first character of a line. For example: | |
223 |
|
|
223 | In [1]: ,my_function /home/me # becomes my_function("/home/me") | |
224 |
|
224 | |||
225 | If you use ';' instead, the whole argument is quoted as a single |
|
225 | If you use ';' instead, the whole argument is quoted as a single | |
226 | string (while ',' splits on whitespace): |
|
226 | string (while ',' splits on whitespace): | |
227 |
|
|
227 | In [2]: ,my_function a b c # becomes my_function("a","b","c") | |
228 |
|
|
228 | In [3]: ;my_function a b c # becomes my_function("a b c") | |
229 |
|
229 | |||
230 | Note that the ',' MUST be the first character on the line! This |
|
230 | Note that the ',' MUST be the first character on the line! This | |
231 | won't work: |
|
231 | won't work: | |
232 |
|
|
232 | In [4]: x = ,my_function /home/me # syntax error | |
233 | """ |
|
233 | """ | |
234 |
|
234 | |||
235 | interactive_usage_min = """\ |
|
235 | interactive_usage_min = """\ | |
236 | An enhanced console for Python. |
|
236 | An enhanced console for Python. | |
237 | Some of its features are: |
|
237 | Some of its features are: | |
238 | - Readline support if the readline library is present. |
|
238 | - Readline support if the readline library is present. | |
239 | - Tab completion in the local namespace. |
|
239 | - Tab completion in the local namespace. | |
240 | - Logging of input, see command-line options. |
|
240 | - Logging of input, see command-line options. | |
241 | - System shell escape via ! , eg !ls. |
|
241 | - System shell escape via ! , eg !ls. | |
242 | - Magic commands, starting with a % (like %ls, %pwd, %cd, etc.) |
|
242 | - Magic commands, starting with a % (like %ls, %pwd, %cd, etc.) | |
243 | - Keeps track of locally defined variables via %who, %whos. |
|
243 | - Keeps track of locally defined variables via %who, %whos. | |
244 | - Show object information with a ? eg ?x or x? (use ?? for more info). |
|
244 | - Show object information with a ? eg ?x or x? (use ?? for more info). | |
245 | """ |
|
245 | """ | |
246 |
|
246 | |||
247 | quick_reference = r""" |
|
247 | quick_reference = r""" | |
248 | IPython -- An enhanced Interactive Python - Quick Reference Card |
|
248 | IPython -- An enhanced Interactive Python - Quick Reference Card | |
249 | ================================================================ |
|
249 | ================================================================ | |
250 |
|
250 | |||
251 | obj?, obj?? : Get help, or more help for object (also works as |
|
251 | obj?, obj?? : Get help, or more help for object (also works as | |
252 | ?obj, ??obj). |
|
252 | ?obj, ??obj). | |
253 | ?foo.*abc* : List names in 'foo' containing 'abc' in them. |
|
253 | ?foo.*abc* : List names in 'foo' containing 'abc' in them. | |
254 | %magic : Information about IPython's 'magic' % functions. |
|
254 | %magic : Information about IPython's 'magic' % functions. | |
255 |
|
255 | |||
256 | Magic functions are prefixed by %, and typically take their arguments without |
|
256 | Magic functions are prefixed by %, and typically take their arguments without | |
257 | parentheses, quotes or even commas for convenience. |
|
257 | parentheses, quotes or even commas for convenience. | |
258 |
|
258 | |||
259 | Example magic function calls: |
|
259 | Example magic function calls: | |
260 |
|
260 | |||
261 | %alias d ls -F : 'd' is now an alias for 'ls -F' |
|
261 | %alias d ls -F : 'd' is now an alias for 'ls -F' | |
262 | alias d ls -F : Works if 'alias' not a python name |
|
262 | alias d ls -F : Works if 'alias' not a python name | |
263 | alist = %alias : Get list of aliases to 'alist' |
|
263 | alist = %alias : Get list of aliases to 'alist' | |
264 | cd /usr/share : Obvious. cd -<tab> to choose from visited dirs. |
|
264 | cd /usr/share : Obvious. cd -<tab> to choose from visited dirs. | |
265 | %cd?? : See help AND source for magic %cd |
|
265 | %cd?? : See help AND source for magic %cd | |
266 |
|
266 | |||
267 | System commands: |
|
267 | System commands: | |
268 |
|
268 | |||
269 | !cp a.txt b/ : System command escape, calls os.system() |
|
269 | !cp a.txt b/ : System command escape, calls os.system() | |
270 | cp a.txt b/ : after %rehashx, most system commands work without ! |
|
270 | cp a.txt b/ : after %rehashx, most system commands work without ! | |
271 | cp ${f}.txt $bar : Variable expansion in magics and system commands |
|
271 | cp ${f}.txt $bar : Variable expansion in magics and system commands | |
272 | files = !ls /usr : Capture sytem command output |
|
272 | files = !ls /usr : Capture sytem command output | |
273 | files.s, files.l, files.n: "a b c", ['a','b','c'], 'a\nb\nc' |
|
273 | files.s, files.l, files.n: "a b c", ['a','b','c'], 'a\nb\nc' | |
274 |
|
274 | |||
275 | History: |
|
275 | History: | |
276 |
|
276 | |||
277 | _i, _ii, _iii : Previous, next previous, next next previous input |
|
277 | _i, _ii, _iii : Previous, next previous, next next previous input | |
278 | _i4, _ih[2:5] : Input history line 4, lines 2-4 |
|
278 | _i4, _ih[2:5] : Input history line 4, lines 2-4 | |
279 | exec _i81 : Execute input history line #81 again |
|
279 | exec _i81 : Execute input history line #81 again | |
280 | %rep 81 : Edit input history line #81 |
|
280 | %rep 81 : Edit input history line #81 | |
281 | _, __, ___ : previous, next previous, next next previous output |
|
281 | _, __, ___ : previous, next previous, next next previous output | |
282 | _dh : Directory history |
|
282 | _dh : Directory history | |
283 | _oh : Output history |
|
283 | _oh : Output history | |
284 | %hist : Command history. '%hist -g foo' search history for 'foo' |
|
284 | %hist : Command history. '%hist -g foo' search history for 'foo' | |
285 |
|
285 | |||
286 | Autocall: |
|
286 | Autocall: | |
287 |
|
287 | |||
288 | f 1,2 : f(1,2) |
|
288 | f 1,2 : f(1,2) | |
289 | /f 1,2 : f(1,2) (forced autoparen) |
|
289 | /f 1,2 : f(1,2) (forced autoparen) | |
290 | ,f 1 2 : f("1","2") |
|
290 | ,f 1 2 : f("1","2") | |
291 | ;f 1 2 : f("1 2") |
|
291 | ;f 1 2 : f("1 2") | |
292 |
|
292 | |||
293 | Remember: TAB completion works in many contexts, not just file names |
|
293 | Remember: TAB completion works in many contexts, not just file names | |
294 | or python names. |
|
294 | or python names. | |
295 |
|
295 | |||
296 | The following magic functions are currently available: |
|
296 | The following magic functions are currently available: | |
297 |
|
297 | |||
298 | """ |
|
298 | """ | |
299 |
|
299 | |||
300 | gui_reference = """\ |
|
300 | gui_reference = """\ | |
301 | =============================== |
|
301 | =============================== | |
302 | The graphical IPython console |
|
302 | The graphical IPython console | |
303 | =============================== |
|
303 | =============================== | |
304 |
|
304 | |||
305 | This console is designed to emulate the look, feel and workflow of a terminal |
|
305 | This console is designed to emulate the look, feel and workflow of a terminal | |
306 | environment, while adding a number of enhancements that are simply not possible |
|
306 | environment, while adding a number of enhancements that are simply not possible | |
307 | in a real terminal, such as inline syntax highlighting, true multiline editing, |
|
307 | in a real terminal, such as inline syntax highlighting, true multiline editing, | |
308 | inline graphics and much more. |
|
308 | inline graphics and much more. | |
309 |
|
309 | |||
310 | This quick reference document contains the basic information you'll need to |
|
310 | This quick reference document contains the basic information you'll need to | |
311 | know to make the most efficient use of it. For the various command line |
|
311 | know to make the most efficient use of it. For the various command line | |
312 | options available at startup, type ``ipython qtconsole --help`` at the command line. |
|
312 | options available at startup, type ``ipython qtconsole --help`` at the command line. | |
313 |
|
313 | |||
314 |
|
314 | |||
315 | Multiline editing |
|
315 | Multiline editing | |
316 | ================= |
|
316 | ================= | |
317 |
|
317 | |||
318 | The graphical console is capable of true multiline editing, but it also tries |
|
318 | The graphical console is capable of true multiline editing, but it also tries | |
319 | to behave intuitively like a terminal when possible. If you are used to |
|
319 | to behave intuitively like a terminal when possible. If you are used to | |
320 | IPyhton's old terminal behavior, you should find the transition painless, and |
|
320 | IPyhton's old terminal behavior, you should find the transition painless, and | |
321 | once you learn a few basic keybindings it will be a much more efficient |
|
321 | once you learn a few basic keybindings it will be a much more efficient | |
322 | environment. |
|
322 | environment. | |
323 |
|
323 | |||
324 | For single expressions or indented blocks, the console behaves almost like the |
|
324 | For single expressions or indented blocks, the console behaves almost like the | |
325 | terminal IPython: single expressions are immediately evaluated, and indented |
|
325 | terminal IPython: single expressions are immediately evaluated, and indented | |
326 | blocks are evaluated once a single blank line is entered:: |
|
326 | blocks are evaluated once a single blank line is entered:: | |
327 |
|
327 | |||
328 | In [1]: print "Hello IPython!" # Enter was pressed at the end of the line |
|
328 | In [1]: print "Hello IPython!" # Enter was pressed at the end of the line | |
329 | Hello IPython! |
|
329 | Hello IPython! | |
330 |
|
330 | |||
331 | In [2]: for i in range(10): |
|
331 | In [2]: for i in range(10): | |
332 | ...: print i, |
|
332 | ...: print i, | |
333 | ...: |
|
333 | ...: | |
334 | 0 1 2 3 4 5 6 7 8 9 |
|
334 | 0 1 2 3 4 5 6 7 8 9 | |
335 |
|
335 | |||
336 | If you want to enter more than one expression in a single input block |
|
336 | If you want to enter more than one expression in a single input block | |
337 | (something not possible in the terminal), you can use ``Control-Enter`` at the |
|
337 | (something not possible in the terminal), you can use ``Control-Enter`` at the | |
338 | end of your first line instead of ``Enter``. At that point the console goes |
|
338 | end of your first line instead of ``Enter``. At that point the console goes | |
339 | into 'cell mode' and even if your inputs are not indented, it will continue |
|
339 | into 'cell mode' and even if your inputs are not indented, it will continue | |
340 | accepting arbitrarily many lines until either you enter an extra blank line or |
|
340 | accepting arbitrarily many lines until either you enter an extra blank line or | |
341 | you hit ``Shift-Enter`` (the key binding that forces execution). When a |
|
341 | you hit ``Shift-Enter`` (the key binding that forces execution). When a | |
342 | multiline cell is entered, IPython analyzes it and executes its code producing |
|
342 | multiline cell is entered, IPython analyzes it and executes its code producing | |
343 | an ``Out[n]`` prompt only for the last expression in it, while the rest of the |
|
343 | an ``Out[n]`` prompt only for the last expression in it, while the rest of the | |
344 | cell is executed as if it was a script. An example should clarify this:: |
|
344 | cell is executed as if it was a script. An example should clarify this:: | |
345 |
|
345 | |||
346 | In [3]: x=1 # Hit C-Enter here |
|
346 | In [3]: x=1 # Hit C-Enter here | |
347 | ...: y=2 # from now on, regular Enter is sufficient |
|
347 | ...: y=2 # from now on, regular Enter is sufficient | |
348 | ...: z=3 |
|
348 | ...: z=3 | |
349 | ...: x**2 # This does *not* produce an Out[] value |
|
349 | ...: x**2 # This does *not* produce an Out[] value | |
350 | ...: x+y+z # Only the last expression does |
|
350 | ...: x+y+z # Only the last expression does | |
351 | ...: |
|
351 | ...: | |
352 | Out[3]: 6 |
|
352 | Out[3]: 6 | |
353 |
|
353 | |||
354 | The behavior where an extra blank line forces execution is only active if you |
|
354 | The behavior where an extra blank line forces execution is only active if you | |
355 | are actually typing at the keyboard each line, and is meant to make it mimic |
|
355 | are actually typing at the keyboard each line, and is meant to make it mimic | |
356 | the IPython terminal behavior. If you paste a long chunk of input (for example |
|
356 | the IPython terminal behavior. If you paste a long chunk of input (for example | |
357 | a long script copied form an editor or web browser), it can contain arbitrarily |
|
357 | a long script copied form an editor or web browser), it can contain arbitrarily | |
358 | many intermediate blank lines and they won't cause any problems. As always, |
|
358 | many intermediate blank lines and they won't cause any problems. As always, | |
359 | you can then make it execute by appending a blank line *at the end* or hitting |
|
359 | you can then make it execute by appending a blank line *at the end* or hitting | |
360 | ``Shift-Enter`` anywhere within the cell. |
|
360 | ``Shift-Enter`` anywhere within the cell. | |
361 |
|
361 | |||
362 | With the up arrow key, you can retrieve previous blocks of input that contain |
|
362 | With the up arrow key, you can retrieve previous blocks of input that contain | |
363 | multiple lines. You can move inside of a multiline cell like you would in any |
|
363 | multiple lines. You can move inside of a multiline cell like you would in any | |
364 | text editor. When you want it executed, the simplest thing to do is to hit the |
|
364 | text editor. When you want it executed, the simplest thing to do is to hit the | |
365 | force execution key, ``Shift-Enter`` (though you can also navigate to the end |
|
365 | force execution key, ``Shift-Enter`` (though you can also navigate to the end | |
366 | and append a blank line by using ``Enter`` twice). |
|
366 | and append a blank line by using ``Enter`` twice). | |
367 |
|
367 | |||
368 | If you've edited a multiline cell and accidentally navigate out of it with the |
|
368 | If you've edited a multiline cell and accidentally navigate out of it with the | |
369 | up or down arrow keys, IPython will clear the cell and replace it with the |
|
369 | up or down arrow keys, IPython will clear the cell and replace it with the | |
370 | contents of the one above or below that you navigated to. If this was an |
|
370 | contents of the one above or below that you navigated to. If this was an | |
371 | accident and you want to retrieve the cell you were editing, use the Undo |
|
371 | accident and you want to retrieve the cell you were editing, use the Undo | |
372 | keybinding, ``Control-z``. |
|
372 | keybinding, ``Control-z``. | |
373 |
|
373 | |||
374 |
|
374 | |||
375 | Key bindings |
|
375 | Key bindings | |
376 | ============ |
|
376 | ============ | |
377 |
|
377 | |||
378 | The IPython console supports most of the basic Emacs line-oriented keybindings, |
|
378 | The IPython console supports most of the basic Emacs line-oriented keybindings, | |
379 | in addition to some of its own. |
|
379 | in addition to some of its own. | |
380 |
|
380 | |||
381 | The keybinding prefixes mean: |
|
381 | The keybinding prefixes mean: | |
382 |
|
382 | |||
383 | - ``C``: Control |
|
383 | - ``C``: Control | |
384 | - ``S``: Shift |
|
384 | - ``S``: Shift | |
385 | - ``M``: Meta (typically the Alt key) |
|
385 | - ``M``: Meta (typically the Alt key) | |
386 |
|
386 | |||
387 | The keybindings themselves are: |
|
387 | The keybindings themselves are: | |
388 |
|
388 | |||
389 | - ``Enter``: insert new line (may cause execution, see above). |
|
389 | - ``Enter``: insert new line (may cause execution, see above). | |
390 | - ``C-Enter``: *force* new line, *never* causes execution. |
|
390 | - ``C-Enter``: *force* new line, *never* causes execution. | |
391 | - ``S-Enter``: *force* execution regardless of where cursor is, no newline added. |
|
391 | - ``S-Enter``: *force* execution regardless of where cursor is, no newline added. | |
392 | - ``Up``: step backwards through the history. |
|
392 | - ``Up``: step backwards through the history. | |
393 | - ``Down``: step forwards through the history. |
|
393 | - ``Down``: step forwards through the history. | |
394 | - ``S-Up``: search backwards through the history (like ``C-r`` in bash). |
|
394 | - ``S-Up``: search backwards through the history (like ``C-r`` in bash). | |
395 | - ``S-Down``: search forwards through the history. |
|
395 | - ``S-Down``: search forwards through the history. | |
396 | - ``C-c``: copy highlighted text to clipboard (prompts are automatically stripped). |
|
396 | - ``C-c``: copy highlighted text to clipboard (prompts are automatically stripped). | |
397 | - ``C-S-c``: copy highlighted text to clipboard (prompts are not stripped). |
|
397 | - ``C-S-c``: copy highlighted text to clipboard (prompts are not stripped). | |
398 | - ``C-v``: paste text from clipboard. |
|
398 | - ``C-v``: paste text from clipboard. | |
399 | - ``C-z``: undo (retrieves lost text if you move out of a cell with the arrows). |
|
399 | - ``C-z``: undo (retrieves lost text if you move out of a cell with the arrows). | |
400 | - ``C-S-z``: redo. |
|
400 | - ``C-S-z``: redo. | |
401 | - ``C-o``: move to 'other' area, between pager and terminal. |
|
401 | - ``C-o``: move to 'other' area, between pager and terminal. | |
402 | - ``C-l``: clear terminal. |
|
402 | - ``C-l``: clear terminal. | |
403 | - ``C-a``: go to beginning of line. |
|
403 | - ``C-a``: go to beginning of line. | |
404 | - ``C-e``: go to end of line. |
|
404 | - ``C-e``: go to end of line. | |
405 | - ``C-k``: kill from cursor to the end of the line. |
|
405 | - ``C-k``: kill from cursor to the end of the line. | |
406 | - ``C-y``: yank (paste) |
|
406 | - ``C-y``: yank (paste) | |
407 | - ``C-p``: previous line (like up arrow) |
|
407 | - ``C-p``: previous line (like up arrow) | |
408 | - ``C-n``: next line (like down arrow) |
|
408 | - ``C-n``: next line (like down arrow) | |
409 | - ``C-f``: forward (like right arrow) |
|
409 | - ``C-f``: forward (like right arrow) | |
410 | - ``C-b``: back (like left arrow) |
|
410 | - ``C-b``: back (like left arrow) | |
411 | - ``C-d``: delete next character. |
|
411 | - ``C-d``: delete next character. | |
412 | - ``M-<``: move to the beginning of the input region. |
|
412 | - ``M-<``: move to the beginning of the input region. | |
413 | - ``M->``: move to the end of the input region. |
|
413 | - ``M->``: move to the end of the input region. | |
414 | - ``M-d``: delete next word. |
|
414 | - ``M-d``: delete next word. | |
415 | - ``M-Backspace``: delete previous word. |
|
415 | - ``M-Backspace``: delete previous word. | |
416 | - ``C-.``: force a kernel restart (a confirmation dialog appears). |
|
416 | - ``C-.``: force a kernel restart (a confirmation dialog appears). | |
417 | - ``C-+``: increase font size. |
|
417 | - ``C-+``: increase font size. | |
418 | - ``C--``: decrease font size. |
|
418 | - ``C--``: decrease font size. | |
419 | - ``C-M-Space``: toggle full screen. (Command-Control-Space on Mac OS X) |
|
419 | - ``C-M-Space``: toggle full screen. (Command-Control-Space on Mac OS X) | |
420 |
|
420 | |||
421 | The IPython pager |
|
421 | The IPython pager | |
422 | ================= |
|
422 | ================= | |
423 |
|
423 | |||
424 | IPython will show long blocks of text from many sources using a builtin pager. |
|
424 | IPython will show long blocks of text from many sources using a builtin pager. | |
425 | You can control where this pager appears with the ``--paging`` command-line |
|
425 | You can control where this pager appears with the ``--paging`` command-line | |
426 | flag: |
|
426 | flag: | |
427 |
|
427 | |||
428 | - ``inside`` [default]: the pager is overlaid on top of the main terminal. You |
|
428 | - ``inside`` [default]: the pager is overlaid on top of the main terminal. You | |
429 | must quit the pager to get back to the terminal (similar to how a pager such |
|
429 | must quit the pager to get back to the terminal (similar to how a pager such | |
430 | as ``less`` or ``more`` works). |
|
430 | as ``less`` or ``more`` works). | |
431 |
|
431 | |||
432 | - ``vsplit``: the console is made double-tall, and the pager appears on the |
|
432 | - ``vsplit``: the console is made double-tall, and the pager appears on the | |
433 | bottom area when needed. You can view its contents while using the terminal. |
|
433 | bottom area when needed. You can view its contents while using the terminal. | |
434 |
|
434 | |||
435 | - ``hsplit``: the console is made double-wide, and the pager appears on the |
|
435 | - ``hsplit``: the console is made double-wide, and the pager appears on the | |
436 | right area when needed. You can view its contents while using the terminal. |
|
436 | right area when needed. You can view its contents while using the terminal. | |
437 |
|
437 | |||
438 | - ``none``: the console never pages output. |
|
438 | - ``none``: the console never pages output. | |
439 |
|
439 | |||
440 | If you use the vertical or horizontal paging modes, you can navigate between |
|
440 | If you use the vertical or horizontal paging modes, you can navigate between | |
441 | terminal and pager as follows: |
|
441 | terminal and pager as follows: | |
442 |
|
442 | |||
443 | - Tab key: goes from pager to terminal (but not the other way around). |
|
443 | - Tab key: goes from pager to terminal (but not the other way around). | |
444 | - Control-o: goes from one to another always. |
|
444 | - Control-o: goes from one to another always. | |
445 | - Mouse: click on either. |
|
445 | - Mouse: click on either. | |
446 |
|
446 | |||
447 | In all cases, the ``q`` or ``Escape`` keys quit the pager (when used with the |
|
447 | In all cases, the ``q`` or ``Escape`` keys quit the pager (when used with the | |
448 | focus on the pager area). |
|
448 | focus on the pager area). | |
449 |
|
449 | |||
450 | Running subprocesses |
|
450 | Running subprocesses | |
451 | ==================== |
|
451 | ==================== | |
452 |
|
452 | |||
453 | The graphical IPython console uses the ``pexpect`` module to run subprocesses |
|
453 | The graphical IPython console uses the ``pexpect`` module to run subprocesses | |
454 | when you type ``!command``. This has a number of advantages (true asynchronous |
|
454 | when you type ``!command``. This has a number of advantages (true asynchronous | |
455 | output from subprocesses as well as very robust termination of rogue |
|
455 | output from subprocesses as well as very robust termination of rogue | |
456 | subprocesses with ``Control-C``), as well as some limitations. The main |
|
456 | subprocesses with ``Control-C``), as well as some limitations. The main | |
457 | limitation is that you can *not* interact back with the subprocess, so anything |
|
457 | limitation is that you can *not* interact back with the subprocess, so anything | |
458 | that invokes a pager or expects you to type input into it will block and hang |
|
458 | that invokes a pager or expects you to type input into it will block and hang | |
459 | (you can kill it with ``Control-C``). |
|
459 | (you can kill it with ``Control-C``). | |
460 |
|
460 | |||
461 | We have provided as magics ``%less`` to page files (aliased to ``%more``), |
|
461 | We have provided as magics ``%less`` to page files (aliased to ``%more``), | |
462 | ``%clear`` to clear the terminal, and ``%man`` on Linux/OSX. These cover the |
|
462 | ``%clear`` to clear the terminal, and ``%man`` on Linux/OSX. These cover the | |
463 | most common commands you'd want to call in your subshell and that would cause |
|
463 | most common commands you'd want to call in your subshell and that would cause | |
464 | problems if invoked via ``!cmd``, but you need to be aware of this limitation. |
|
464 | problems if invoked via ``!cmd``, but you need to be aware of this limitation. | |
465 |
|
465 | |||
466 | Display |
|
466 | Display | |
467 | ======= |
|
467 | ======= | |
468 |
|
468 | |||
469 | The IPython console can now display objects in a variety of formats, including |
|
469 | The IPython console can now display objects in a variety of formats, including | |
470 | HTML, PNG and SVG. This is accomplished using the display functions in |
|
470 | HTML, PNG and SVG. This is accomplished using the display functions in | |
471 | ``IPython.core.display``:: |
|
471 | ``IPython.core.display``:: | |
472 |
|
472 | |||
473 | In [4]: from IPython.core.display import display, display_html |
|
473 | In [4]: from IPython.core.display import display, display_html | |
474 |
|
474 | |||
475 | In [5]: from IPython.core.display import display_png, display_svg |
|
475 | In [5]: from IPython.core.display import display_png, display_svg | |
476 |
|
476 | |||
477 | Python objects can simply be passed to these functions and the appropriate |
|
477 | Python objects can simply be passed to these functions and the appropriate | |
478 | representations will be displayed in the console as long as the objects know |
|
478 | representations will be displayed in the console as long as the objects know | |
479 | how to compute those representations. The easiest way of teaching objects how |
|
479 | how to compute those representations. The easiest way of teaching objects how | |
480 | to format themselves in various representations is to define special methods |
|
480 | to format themselves in various representations is to define special methods | |
481 | such as: ``_repr_html_``, ``_repr_svg_`` and ``_repr_png_``. IPython's display formatters |
|
481 | such as: ``_repr_html_``, ``_repr_svg_`` and ``_repr_png_``. IPython's display formatters | |
482 | can also be given custom formatter functions for various types:: |
|
482 | can also be given custom formatter functions for various types:: | |
483 |
|
483 | |||
484 | In [6]: ip = get_ipython() |
|
484 | In [6]: ip = get_ipython() | |
485 |
|
485 | |||
486 | In [7]: html_formatter = ip.display_formatter.formatters['text/html'] |
|
486 | In [7]: html_formatter = ip.display_formatter.formatters['text/html'] | |
487 |
|
487 | |||
488 | In [8]: html_formatter.for_type(Foo, foo_to_html) |
|
488 | In [8]: html_formatter.for_type(Foo, foo_to_html) | |
489 |
|
489 | |||
490 | For further details, see ``IPython.core.formatters``. |
|
490 | For further details, see ``IPython.core.formatters``. | |
491 |
|
491 | |||
492 | Inline matplotlib graphics |
|
492 | Inline matplotlib graphics | |
493 | ========================== |
|
493 | ========================== | |
494 |
|
494 | |||
495 | The IPython console is capable of displaying matplotlib figures inline, in SVG |
|
495 | The IPython console is capable of displaying matplotlib figures inline, in SVG | |
496 | or PNG format. If started with the ``pylab=inline``, then all figures are |
|
496 | or PNG format. If started with the ``pylab=inline``, then all figures are | |
497 | rendered inline automatically (PNG by default). If started with ``--pylab`` |
|
497 | rendered inline automatically (PNG by default). If started with ``--pylab`` | |
498 | or ``pylab=<your backend>``, then a GUI backend will be used, but IPython's |
|
498 | or ``pylab=<your backend>``, then a GUI backend will be used, but IPython's | |
499 | ``display()`` and ``getfigs()`` functions can be used to view plots inline:: |
|
499 | ``display()`` and ``getfigs()`` functions can be used to view plots inline:: | |
500 |
|
500 | |||
501 | In [9]: display(*getfigs()) # display all figures inline |
|
501 | In [9]: display(*getfigs()) # display all figures inline | |
502 |
|
502 | |||
503 | In[10]: display(*getfigs(1,2)) # display figures 1 and 2 inline |
|
503 | In[10]: display(*getfigs(1,2)) # display figures 1 and 2 inline | |
504 | """ |
|
504 | """ | |
505 |
|
505 | |||
506 |
|
506 | |||
507 | quick_guide = """\ |
|
507 | quick_guide = """\ | |
508 | ? -> Introduction and overview of IPython's features. |
|
508 | ? -> Introduction and overview of IPython's features. | |
509 | %quickref -> Quick reference. |
|
509 | %quickref -> Quick reference. | |
510 | help -> Python's own help system. |
|
510 | help -> Python's own help system. | |
511 | object? -> Details about 'object', use 'object??' for extra details. |
|
511 | object? -> Details about 'object', use 'object??' for extra details. | |
512 | """ |
|
512 | """ | |
513 |
|
513 | |||
514 | gui_note = """\ |
|
514 | gui_note = """\ | |
515 | %guiref -> A brief reference about the graphical user interface. |
|
515 | %guiref -> A brief reference about the graphical user interface. | |
516 | """ |
|
516 | """ | |
517 |
|
517 | |||
518 | default_banner_parts = [ |
|
518 | default_banner_parts = [ | |
519 | 'Python %s\n' % (sys.version.split('\n')[0],), |
|
519 | 'Python %s\n' % (sys.version.split('\n')[0],), | |
520 | 'Type "copyright", "credits" or "license" for more information.\n\n', |
|
520 | 'Type "copyright", "credits" or "license" for more information.\n\n', | |
521 | 'IPython %s -- An enhanced Interactive Python.\n' % (release.version,), |
|
521 | 'IPython %s -- An enhanced Interactive Python.\n' % (release.version,), | |
522 | quick_guide |
|
522 | quick_guide | |
523 | ] |
|
523 | ] | |
524 |
|
524 | |||
525 | default_gui_banner_parts = default_banner_parts + [gui_note] |
|
525 | default_gui_banner_parts = default_banner_parts + [gui_note] | |
526 |
|
526 | |||
527 | default_banner = ''.join(default_banner_parts) |
|
527 | default_banner = ''.join(default_banner_parts) | |
528 |
|
528 | |||
529 | default_gui_banner = ''.join(default_gui_banner_parts) |
|
529 | default_gui_banner = ''.join(default_gui_banner_parts) |
@@ -1,1048 +1,1048 b'' | |||||
1 | """Views of remote engines. |
|
1 | """Views of remote engines. | |
2 |
|
2 | |||
3 | Authors: |
|
3 | Authors: | |
4 |
|
4 | |||
5 | * Min RK |
|
5 | * Min RK | |
6 | """ |
|
6 | """ | |
7 | #----------------------------------------------------------------------------- |
|
7 | #----------------------------------------------------------------------------- | |
8 | # Copyright (C) 2010-2011 The IPython Development Team |
|
8 | # Copyright (C) 2010-2011 The IPython Development Team | |
9 | # |
|
9 | # | |
10 | # Distributed under the terms of the BSD License. The full license is in |
|
10 | # Distributed under the terms of the BSD License. The full license is in | |
11 | # the file COPYING, distributed as part of this software. |
|
11 | # the file COPYING, distributed as part of this software. | |
12 | #----------------------------------------------------------------------------- |
|
12 | #----------------------------------------------------------------------------- | |
13 |
|
13 | |||
14 | #----------------------------------------------------------------------------- |
|
14 | #----------------------------------------------------------------------------- | |
15 | # Imports |
|
15 | # Imports | |
16 | #----------------------------------------------------------------------------- |
|
16 | #----------------------------------------------------------------------------- | |
17 |
|
17 | |||
18 | import imp |
|
18 | import imp | |
19 | import sys |
|
19 | import sys | |
20 | import warnings |
|
20 | import warnings | |
21 | from contextlib import contextmanager |
|
21 | from contextlib import contextmanager | |
22 | from types import ModuleType |
|
22 | from types import ModuleType | |
23 |
|
23 | |||
24 | import zmq |
|
24 | import zmq | |
25 |
|
25 | |||
26 | from IPython.testing.skipdoctest import skip_doctest |
|
26 | from IPython.testing.skipdoctest import skip_doctest | |
27 | from IPython.utils.traitlets import HasTraits, Any, Bool, List, Dict, Set, Int, Instance, CFloat, CInt |
|
27 | from IPython.utils.traitlets import HasTraits, Any, Bool, List, Dict, Set, Int, Instance, CFloat, CInt | |
28 | from IPython.external.decorator import decorator |
|
28 | from IPython.external.decorator import decorator | |
29 |
|
29 | |||
30 | from IPython.parallel import util |
|
30 | from IPython.parallel import util | |
31 | from IPython.parallel.controller.dependency import Dependency, dependent |
|
31 | from IPython.parallel.controller.dependency import Dependency, dependent | |
32 |
|
32 | |||
33 | from . import map as Map |
|
33 | from . import map as Map | |
34 | from .asyncresult import AsyncResult, AsyncMapResult |
|
34 | from .asyncresult import AsyncResult, AsyncMapResult | |
35 | from .remotefunction import ParallelFunction, parallel, remote |
|
35 | from .remotefunction import ParallelFunction, parallel, remote | |
36 |
|
36 | |||
37 | #----------------------------------------------------------------------------- |
|
37 | #----------------------------------------------------------------------------- | |
38 | # Decorators |
|
38 | # Decorators | |
39 | #----------------------------------------------------------------------------- |
|
39 | #----------------------------------------------------------------------------- | |
40 |
|
40 | |||
41 | @decorator |
|
41 | @decorator | |
42 | def save_ids(f, self, *args, **kwargs): |
|
42 | def save_ids(f, self, *args, **kwargs): | |
43 | """Keep our history and outstanding attributes up to date after a method call.""" |
|
43 | """Keep our history and outstanding attributes up to date after a method call.""" | |
44 | n_previous = len(self.client.history) |
|
44 | n_previous = len(self.client.history) | |
45 | try: |
|
45 | try: | |
46 | ret = f(self, *args, **kwargs) |
|
46 | ret = f(self, *args, **kwargs) | |
47 | finally: |
|
47 | finally: | |
48 | nmsgs = len(self.client.history) - n_previous |
|
48 | nmsgs = len(self.client.history) - n_previous | |
49 | msg_ids = self.client.history[-nmsgs:] |
|
49 | msg_ids = self.client.history[-nmsgs:] | |
50 | self.history.extend(msg_ids) |
|
50 | self.history.extend(msg_ids) | |
51 | map(self.outstanding.add, msg_ids) |
|
51 | map(self.outstanding.add, msg_ids) | |
52 | return ret |
|
52 | return ret | |
53 |
|
53 | |||
54 | @decorator |
|
54 | @decorator | |
55 | def sync_results(f, self, *args, **kwargs): |
|
55 | def sync_results(f, self, *args, **kwargs): | |
56 | """sync relevant results from self.client to our results attribute.""" |
|
56 | """sync relevant results from self.client to our results attribute.""" | |
57 | ret = f(self, *args, **kwargs) |
|
57 | ret = f(self, *args, **kwargs) | |
58 | delta = self.outstanding.difference(self.client.outstanding) |
|
58 | delta = self.outstanding.difference(self.client.outstanding) | |
59 | completed = self.outstanding.intersection(delta) |
|
59 | completed = self.outstanding.intersection(delta) | |
60 | self.outstanding = self.outstanding.difference(completed) |
|
60 | self.outstanding = self.outstanding.difference(completed) | |
61 | for msg_id in completed: |
|
61 | for msg_id in completed: | |
62 | self.results[msg_id] = self.client.results[msg_id] |
|
62 | self.results[msg_id] = self.client.results[msg_id] | |
63 | return ret |
|
63 | return ret | |
64 |
|
64 | |||
65 | @decorator |
|
65 | @decorator | |
66 | def spin_after(f, self, *args, **kwargs): |
|
66 | def spin_after(f, self, *args, **kwargs): | |
67 | """call spin after the method.""" |
|
67 | """call spin after the method.""" | |
68 | ret = f(self, *args, **kwargs) |
|
68 | ret = f(self, *args, **kwargs) | |
69 | self.spin() |
|
69 | self.spin() | |
70 | return ret |
|
70 | return ret | |
71 |
|
71 | |||
72 | #----------------------------------------------------------------------------- |
|
72 | #----------------------------------------------------------------------------- | |
73 | # Classes |
|
73 | # Classes | |
74 | #----------------------------------------------------------------------------- |
|
74 | #----------------------------------------------------------------------------- | |
75 |
|
75 | |||
76 | @skip_doctest |
|
76 | @skip_doctest | |
77 | class View(HasTraits): |
|
77 | class View(HasTraits): | |
78 | """Base View class for more convenint apply(f,*args,**kwargs) syntax via attributes. |
|
78 | """Base View class for more convenint apply(f,*args,**kwargs) syntax via attributes. | |
79 |
|
79 | |||
80 | Don't use this class, use subclasses. |
|
80 | Don't use this class, use subclasses. | |
81 |
|
81 | |||
82 | Methods |
|
82 | Methods | |
83 | ------- |
|
83 | ------- | |
84 |
|
84 | |||
85 | spin |
|
85 | spin | |
86 | flushes incoming results and registration state changes |
|
86 | flushes incoming results and registration state changes | |
87 | control methods spin, and requesting `ids` also ensures up to date |
|
87 | control methods spin, and requesting `ids` also ensures up to date | |
88 |
|
88 | |||
89 | wait |
|
89 | wait | |
90 | wait on one or more msg_ids |
|
90 | wait on one or more msg_ids | |
91 |
|
91 | |||
92 | execution methods |
|
92 | execution methods | |
93 | apply |
|
93 | apply | |
94 | legacy: execute, run |
|
94 | legacy: execute, run | |
95 |
|
95 | |||
96 | data movement |
|
96 | data movement | |
97 | push, pull, scatter, gather |
|
97 | push, pull, scatter, gather | |
98 |
|
98 | |||
99 | query methods |
|
99 | query methods | |
100 | get_result, queue_status, purge_results, result_status |
|
100 | get_result, queue_status, purge_results, result_status | |
101 |
|
101 | |||
102 | control methods |
|
102 | control methods | |
103 | abort, shutdown |
|
103 | abort, shutdown | |
104 |
|
104 | |||
105 | """ |
|
105 | """ | |
106 | # flags |
|
106 | # flags | |
107 | block=Bool(False) |
|
107 | block=Bool(False) | |
108 | track=Bool(True) |
|
108 | track=Bool(True) | |
109 | targets = Any() |
|
109 | targets = Any() | |
110 |
|
110 | |||
111 | history=List() |
|
111 | history=List() | |
112 | outstanding = Set() |
|
112 | outstanding = Set() | |
113 | results = Dict() |
|
113 | results = Dict() | |
114 | client = Instance('IPython.parallel.Client') |
|
114 | client = Instance('IPython.parallel.Client') | |
115 |
|
115 | |||
116 | _socket = Instance('zmq.Socket') |
|
116 | _socket = Instance('zmq.Socket') | |
117 | _flag_names = List(['targets', 'block', 'track']) |
|
117 | _flag_names = List(['targets', 'block', 'track']) | |
118 | _targets = Any() |
|
118 | _targets = Any() | |
119 | _idents = Any() |
|
119 | _idents = Any() | |
120 |
|
120 | |||
121 | def __init__(self, client=None, socket=None, **flags): |
|
121 | def __init__(self, client=None, socket=None, **flags): | |
122 | super(View, self).__init__(client=client, _socket=socket) |
|
122 | super(View, self).__init__(client=client, _socket=socket) | |
123 | self.block = client.block |
|
123 | self.block = client.block | |
124 |
|
124 | |||
125 | self.set_flags(**flags) |
|
125 | self.set_flags(**flags) | |
126 |
|
126 | |||
127 | assert not self.__class__ is View, "Don't use base View objects, use subclasses" |
|
127 | assert not self.__class__ is View, "Don't use base View objects, use subclasses" | |
128 |
|
128 | |||
129 |
|
129 | |||
130 | def __repr__(self): |
|
130 | def __repr__(self): | |
131 | strtargets = str(self.targets) |
|
131 | strtargets = str(self.targets) | |
132 | if len(strtargets) > 16: |
|
132 | if len(strtargets) > 16: | |
133 | strtargets = strtargets[:12]+'...]' |
|
133 | strtargets = strtargets[:12]+'...]' | |
134 | return "<%s %s>"%(self.__class__.__name__, strtargets) |
|
134 | return "<%s %s>"%(self.__class__.__name__, strtargets) | |
135 |
|
135 | |||
136 | def set_flags(self, **kwargs): |
|
136 | def set_flags(self, **kwargs): | |
137 | """set my attribute flags by keyword. |
|
137 | """set my attribute flags by keyword. | |
138 |
|
138 | |||
139 | Views determine behavior with a few attributes (`block`, `track`, etc.). |
|
139 | Views determine behavior with a few attributes (`block`, `track`, etc.). | |
140 | These attributes can be set all at once by name with this method. |
|
140 | These attributes can be set all at once by name with this method. | |
141 |
|
141 | |||
142 | Parameters |
|
142 | Parameters | |
143 | ---------- |
|
143 | ---------- | |
144 |
|
144 | |||
145 | block : bool |
|
145 | block : bool | |
146 | whether to wait for results |
|
146 | whether to wait for results | |
147 | track : bool |
|
147 | track : bool | |
148 | whether to create a MessageTracker to allow the user to |
|
148 | whether to create a MessageTracker to allow the user to | |
149 | safely edit after arrays and buffers during non-copying |
|
149 | safely edit after arrays and buffers during non-copying | |
150 | sends. |
|
150 | sends. | |
151 | """ |
|
151 | """ | |
152 | for name, value in kwargs.iteritems(): |
|
152 | for name, value in kwargs.iteritems(): | |
153 | if name not in self._flag_names: |
|
153 | if name not in self._flag_names: | |
154 | raise KeyError("Invalid name: %r"%name) |
|
154 | raise KeyError("Invalid name: %r"%name) | |
155 | else: |
|
155 | else: | |
156 | setattr(self, name, value) |
|
156 | setattr(self, name, value) | |
157 |
|
157 | |||
158 | @contextmanager |
|
158 | @contextmanager | |
159 | def temp_flags(self, **kwargs): |
|
159 | def temp_flags(self, **kwargs): | |
160 | """temporarily set flags, for use in `with` statements. |
|
160 | """temporarily set flags, for use in `with` statements. | |
161 |
|
161 | |||
162 | See set_flags for permanent setting of flags |
|
162 | See set_flags for permanent setting of flags | |
163 |
|
163 | |||
164 | Examples |
|
164 | Examples | |
165 | -------- |
|
165 | -------- | |
166 |
|
166 | |||
167 | >>> view.track=False |
|
167 | >>> view.track=False | |
168 | ... |
|
168 | ... | |
169 | >>> with view.temp_flags(track=True): |
|
169 | >>> with view.temp_flags(track=True): | |
170 | ... ar = view.apply(dostuff, my_big_array) |
|
170 | ... ar = view.apply(dostuff, my_big_array) | |
171 | ... ar.tracker.wait() # wait for send to finish |
|
171 | ... ar.tracker.wait() # wait for send to finish | |
172 | >>> view.track |
|
172 | >>> view.track | |
173 | False |
|
173 | False | |
174 |
|
174 | |||
175 | """ |
|
175 | """ | |
176 | # preflight: save flags, and set temporaries |
|
176 | # preflight: save flags, and set temporaries | |
177 | saved_flags = {} |
|
177 | saved_flags = {} | |
178 | for f in self._flag_names: |
|
178 | for f in self._flag_names: | |
179 | saved_flags[f] = getattr(self, f) |
|
179 | saved_flags[f] = getattr(self, f) | |
180 | self.set_flags(**kwargs) |
|
180 | self.set_flags(**kwargs) | |
181 | # yield to the with-statement block |
|
181 | # yield to the with-statement block | |
182 | try: |
|
182 | try: | |
183 | yield |
|
183 | yield | |
184 | finally: |
|
184 | finally: | |
185 | # postflight: restore saved flags |
|
185 | # postflight: restore saved flags | |
186 | self.set_flags(**saved_flags) |
|
186 | self.set_flags(**saved_flags) | |
187 |
|
187 | |||
188 |
|
188 | |||
189 | #---------------------------------------------------------------- |
|
189 | #---------------------------------------------------------------- | |
190 | # apply |
|
190 | # apply | |
191 | #---------------------------------------------------------------- |
|
191 | #---------------------------------------------------------------- | |
192 |
|
192 | |||
193 | @sync_results |
|
193 | @sync_results | |
194 | @save_ids |
|
194 | @save_ids | |
195 | def _really_apply(self, f, args, kwargs, block=None, **options): |
|
195 | def _really_apply(self, f, args, kwargs, block=None, **options): | |
196 | """wrapper for client.send_apply_message""" |
|
196 | """wrapper for client.send_apply_message""" | |
197 | raise NotImplementedError("Implement in subclasses") |
|
197 | raise NotImplementedError("Implement in subclasses") | |
198 |
|
198 | |||
199 | def apply(self, f, *args, **kwargs): |
|
199 | def apply(self, f, *args, **kwargs): | |
200 | """calls f(*args, **kwargs) on remote engines, returning the result. |
|
200 | """calls f(*args, **kwargs) on remote engines, returning the result. | |
201 |
|
201 | |||
202 | This method sets all apply flags via this View's attributes. |
|
202 | This method sets all apply flags via this View's attributes. | |
203 |
|
203 | |||
204 | if self.block is False: |
|
204 | if self.block is False: | |
205 | returns AsyncResult |
|
205 | returns AsyncResult | |
206 | else: |
|
206 | else: | |
207 | returns actual result of f(*args, **kwargs) |
|
207 | returns actual result of f(*args, **kwargs) | |
208 | """ |
|
208 | """ | |
209 | return self._really_apply(f, args, kwargs) |
|
209 | return self._really_apply(f, args, kwargs) | |
210 |
|
210 | |||
211 | def apply_async(self, f, *args, **kwargs): |
|
211 | def apply_async(self, f, *args, **kwargs): | |
212 | """calls f(*args, **kwargs) on remote engines in a nonblocking manner. |
|
212 | """calls f(*args, **kwargs) on remote engines in a nonblocking manner. | |
213 |
|
213 | |||
214 | returns AsyncResult |
|
214 | returns AsyncResult | |
215 | """ |
|
215 | """ | |
216 | return self._really_apply(f, args, kwargs, block=False) |
|
216 | return self._really_apply(f, args, kwargs, block=False) | |
217 |
|
217 | |||
218 | @spin_after |
|
218 | @spin_after | |
219 | def apply_sync(self, f, *args, **kwargs): |
|
219 | def apply_sync(self, f, *args, **kwargs): | |
220 | """calls f(*args, **kwargs) on remote engines in a blocking manner, |
|
220 | """calls f(*args, **kwargs) on remote engines in a blocking manner, | |
221 | returning the result. |
|
221 | returning the result. | |
222 |
|
222 | |||
223 | returns: actual result of f(*args, **kwargs) |
|
223 | returns: actual result of f(*args, **kwargs) | |
224 | """ |
|
224 | """ | |
225 | return self._really_apply(f, args, kwargs, block=True) |
|
225 | return self._really_apply(f, args, kwargs, block=True) | |
226 |
|
226 | |||
227 | #---------------------------------------------------------------- |
|
227 | #---------------------------------------------------------------- | |
228 | # wrappers for client and control methods |
|
228 | # wrappers for client and control methods | |
229 | #---------------------------------------------------------------- |
|
229 | #---------------------------------------------------------------- | |
230 | @sync_results |
|
230 | @sync_results | |
231 | def spin(self): |
|
231 | def spin(self): | |
232 | """spin the client, and sync""" |
|
232 | """spin the client, and sync""" | |
233 | self.client.spin() |
|
233 | self.client.spin() | |
234 |
|
234 | |||
235 | @sync_results |
|
235 | @sync_results | |
236 | def wait(self, jobs=None, timeout=-1): |
|
236 | def wait(self, jobs=None, timeout=-1): | |
237 | """waits on one or more `jobs`, for up to `timeout` seconds. |
|
237 | """waits on one or more `jobs`, for up to `timeout` seconds. | |
238 |
|
238 | |||
239 | Parameters |
|
239 | Parameters | |
240 | ---------- |
|
240 | ---------- | |
241 |
|
241 | |||
242 | jobs : int, str, or list of ints and/or strs, or one or more AsyncResult objects |
|
242 | jobs : int, str, or list of ints and/or strs, or one or more AsyncResult objects | |
243 | ints are indices to self.history |
|
243 | ints are indices to self.history | |
244 | strs are msg_ids |
|
244 | strs are msg_ids | |
245 | default: wait on all outstanding messages |
|
245 | default: wait on all outstanding messages | |
246 | timeout : float |
|
246 | timeout : float | |
247 | a time in seconds, after which to give up. |
|
247 | a time in seconds, after which to give up. | |
248 | default is -1, which means no timeout |
|
248 | default is -1, which means no timeout | |
249 |
|
249 | |||
250 | Returns |
|
250 | Returns | |
251 | ------- |
|
251 | ------- | |
252 |
|
252 | |||
253 | True : when all msg_ids are done |
|
253 | True : when all msg_ids are done | |
254 | False : timeout reached, some msg_ids still outstanding |
|
254 | False : timeout reached, some msg_ids still outstanding | |
255 | """ |
|
255 | """ | |
256 | if jobs is None: |
|
256 | if jobs is None: | |
257 | jobs = self.history |
|
257 | jobs = self.history | |
258 | return self.client.wait(jobs, timeout) |
|
258 | return self.client.wait(jobs, timeout) | |
259 |
|
259 | |||
260 | def abort(self, jobs=None, targets=None, block=None): |
|
260 | def abort(self, jobs=None, targets=None, block=None): | |
261 | """Abort jobs on my engines. |
|
261 | """Abort jobs on my engines. | |
262 |
|
262 | |||
263 | Parameters |
|
263 | Parameters | |
264 | ---------- |
|
264 | ---------- | |
265 |
|
265 | |||
266 | jobs : None, str, list of strs, optional |
|
266 | jobs : None, str, list of strs, optional | |
267 | if None: abort all jobs. |
|
267 | if None: abort all jobs. | |
268 | else: abort specific msg_id(s). |
|
268 | else: abort specific msg_id(s). | |
269 | """ |
|
269 | """ | |
270 | block = block if block is not None else self.block |
|
270 | block = block if block is not None else self.block | |
271 | targets = targets if targets is not None else self.targets |
|
271 | targets = targets if targets is not None else self.targets | |
272 | return self.client.abort(jobs=jobs, targets=targets, block=block) |
|
272 | return self.client.abort(jobs=jobs, targets=targets, block=block) | |
273 |
|
273 | |||
274 | def queue_status(self, targets=None, verbose=False): |
|
274 | def queue_status(self, targets=None, verbose=False): | |
275 | """Fetch the Queue status of my engines""" |
|
275 | """Fetch the Queue status of my engines""" | |
276 | targets = targets if targets is not None else self.targets |
|
276 | targets = targets if targets is not None else self.targets | |
277 | return self.client.queue_status(targets=targets, verbose=verbose) |
|
277 | return self.client.queue_status(targets=targets, verbose=verbose) | |
278 |
|
278 | |||
279 | def purge_results(self, jobs=[], targets=[]): |
|
279 | def purge_results(self, jobs=[], targets=[]): | |
280 | """Instruct the controller to forget specific results.""" |
|
280 | """Instruct the controller to forget specific results.""" | |
281 | if targets is None or targets == 'all': |
|
281 | if targets is None or targets == 'all': | |
282 | targets = self.targets |
|
282 | targets = self.targets | |
283 | return self.client.purge_results(jobs=jobs, targets=targets) |
|
283 | return self.client.purge_results(jobs=jobs, targets=targets) | |
284 |
|
284 | |||
285 | def shutdown(self, targets=None, restart=False, hub=False, block=None): |
|
285 | def shutdown(self, targets=None, restart=False, hub=False, block=None): | |
286 | """Terminates one or more engine processes, optionally including the hub. |
|
286 | """Terminates one or more engine processes, optionally including the hub. | |
287 | """ |
|
287 | """ | |
288 | block = self.block if block is None else block |
|
288 | block = self.block if block is None else block | |
289 | if targets is None or targets == 'all': |
|
289 | if targets is None or targets == 'all': | |
290 | targets = self.targets |
|
290 | targets = self.targets | |
291 | return self.client.shutdown(targets=targets, restart=restart, hub=hub, block=block) |
|
291 | return self.client.shutdown(targets=targets, restart=restart, hub=hub, block=block) | |
292 |
|
292 | |||
293 | @spin_after |
|
293 | @spin_after | |
294 | def get_result(self, indices_or_msg_ids=None): |
|
294 | def get_result(self, indices_or_msg_ids=None): | |
295 | """return one or more results, specified by history index or msg_id. |
|
295 | """return one or more results, specified by history index or msg_id. | |
296 |
|
296 | |||
297 | See client.get_result for details. |
|
297 | See client.get_result for details. | |
298 |
|
298 | |||
299 | """ |
|
299 | """ | |
300 |
|
300 | |||
301 | if indices_or_msg_ids is None: |
|
301 | if indices_or_msg_ids is None: | |
302 | indices_or_msg_ids = -1 |
|
302 | indices_or_msg_ids = -1 | |
303 | if isinstance(indices_or_msg_ids, int): |
|
303 | if isinstance(indices_or_msg_ids, int): | |
304 | indices_or_msg_ids = self.history[indices_or_msg_ids] |
|
304 | indices_or_msg_ids = self.history[indices_or_msg_ids] | |
305 | elif isinstance(indices_or_msg_ids, (list,tuple,set)): |
|
305 | elif isinstance(indices_or_msg_ids, (list,tuple,set)): | |
306 | indices_or_msg_ids = list(indices_or_msg_ids) |
|
306 | indices_or_msg_ids = list(indices_or_msg_ids) | |
307 | for i,index in enumerate(indices_or_msg_ids): |
|
307 | for i,index in enumerate(indices_or_msg_ids): | |
308 | if isinstance(index, int): |
|
308 | if isinstance(index, int): | |
309 | indices_or_msg_ids[i] = self.history[index] |
|
309 | indices_or_msg_ids[i] = self.history[index] | |
310 | return self.client.get_result(indices_or_msg_ids) |
|
310 | return self.client.get_result(indices_or_msg_ids) | |
311 |
|
311 | |||
312 | #------------------------------------------------------------------- |
|
312 | #------------------------------------------------------------------- | |
313 | # Map |
|
313 | # Map | |
314 | #------------------------------------------------------------------- |
|
314 | #------------------------------------------------------------------- | |
315 |
|
315 | |||
316 | def map(self, f, *sequences, **kwargs): |
|
316 | def map(self, f, *sequences, **kwargs): | |
317 | """override in subclasses""" |
|
317 | """override in subclasses""" | |
318 | raise NotImplementedError |
|
318 | raise NotImplementedError | |
319 |
|
319 | |||
320 | def map_async(self, f, *sequences, **kwargs): |
|
320 | def map_async(self, f, *sequences, **kwargs): | |
321 | """Parallel version of builtin `map`, using this view's engines. |
|
321 | """Parallel version of builtin `map`, using this view's engines. | |
322 |
|
322 | |||
323 | This is equivalent to map(...block=False) |
|
323 | This is equivalent to map(...block=False) | |
324 |
|
324 | |||
325 | See `self.map` for details. |
|
325 | See `self.map` for details. | |
326 | """ |
|
326 | """ | |
327 | if 'block' in kwargs: |
|
327 | if 'block' in kwargs: | |
328 | raise TypeError("map_async doesn't take a `block` keyword argument.") |
|
328 | raise TypeError("map_async doesn't take a `block` keyword argument.") | |
329 | kwargs['block'] = False |
|
329 | kwargs['block'] = False | |
330 | return self.map(f,*sequences,**kwargs) |
|
330 | return self.map(f,*sequences,**kwargs) | |
331 |
|
331 | |||
332 | def map_sync(self, f, *sequences, **kwargs): |
|
332 | def map_sync(self, f, *sequences, **kwargs): | |
333 | """Parallel version of builtin `map`, using this view's engines. |
|
333 | """Parallel version of builtin `map`, using this view's engines. | |
334 |
|
334 | |||
335 | This is equivalent to map(...block=True) |
|
335 | This is equivalent to map(...block=True) | |
336 |
|
336 | |||
337 | See `self.map` for details. |
|
337 | See `self.map` for details. | |
338 | """ |
|
338 | """ | |
339 | if 'block' in kwargs: |
|
339 | if 'block' in kwargs: | |
340 | raise TypeError("map_sync doesn't take a `block` keyword argument.") |
|
340 | raise TypeError("map_sync doesn't take a `block` keyword argument.") | |
341 | kwargs['block'] = True |
|
341 | kwargs['block'] = True | |
342 | return self.map(f,*sequences,**kwargs) |
|
342 | return self.map(f,*sequences,**kwargs) | |
343 |
|
343 | |||
344 | def imap(self, f, *sequences, **kwargs): |
|
344 | def imap(self, f, *sequences, **kwargs): | |
345 | """Parallel version of `itertools.imap`. |
|
345 | """Parallel version of `itertools.imap`. | |
346 |
|
346 | |||
347 | See `self.map` for details. |
|
347 | See `self.map` for details. | |
348 |
|
348 | |||
349 | """ |
|
349 | """ | |
350 |
|
350 | |||
351 | return iter(self.map_async(f,*sequences, **kwargs)) |
|
351 | return iter(self.map_async(f,*sequences, **kwargs)) | |
352 |
|
352 | |||
353 | #------------------------------------------------------------------- |
|
353 | #------------------------------------------------------------------- | |
354 | # Decorators |
|
354 | # Decorators | |
355 | #------------------------------------------------------------------- |
|
355 | #------------------------------------------------------------------- | |
356 |
|
356 | |||
357 | def remote(self, block=True, **flags): |
|
357 | def remote(self, block=True, **flags): | |
358 | """Decorator for making a RemoteFunction""" |
|
358 | """Decorator for making a RemoteFunction""" | |
359 | block = self.block if block is None else block |
|
359 | block = self.block if block is None else block | |
360 | return remote(self, block=block, **flags) |
|
360 | return remote(self, block=block, **flags) | |
361 |
|
361 | |||
362 | def parallel(self, dist='b', block=None, **flags): |
|
362 | def parallel(self, dist='b', block=None, **flags): | |
363 | """Decorator for making a ParallelFunction""" |
|
363 | """Decorator for making a ParallelFunction""" | |
364 | block = self.block if block is None else block |
|
364 | block = self.block if block is None else block | |
365 | return parallel(self, dist=dist, block=block, **flags) |
|
365 | return parallel(self, dist=dist, block=block, **flags) | |
366 |
|
366 | |||
367 | @skip_doctest |
|
367 | @skip_doctest | |
368 | class DirectView(View): |
|
368 | class DirectView(View): | |
369 | """Direct Multiplexer View of one or more engines. |
|
369 | """Direct Multiplexer View of one or more engines. | |
370 |
|
370 | |||
371 | These are created via indexed access to a client: |
|
371 | These are created via indexed access to a client: | |
372 |
|
372 | |||
373 | >>> dv_1 = client[1] |
|
373 | >>> dv_1 = client[1] | |
374 | >>> dv_all = client[:] |
|
374 | >>> dv_all = client[:] | |
375 | >>> dv_even = client[::2] |
|
375 | >>> dv_even = client[::2] | |
376 | >>> dv_some = client[1:3] |
|
376 | >>> dv_some = client[1:3] | |
377 |
|
377 | |||
378 | This object provides dictionary access to engine namespaces: |
|
378 | This object provides dictionary access to engine namespaces: | |
379 |
|
379 | |||
380 | # push a=5: |
|
380 | # push a=5: | |
381 | >>> dv['a'] = 5 |
|
381 | >>> dv['a'] = 5 | |
382 | # pull 'foo': |
|
382 | # pull 'foo': | |
383 | >>> db['foo'] |
|
383 | >>> db['foo'] | |
384 |
|
384 | |||
385 | """ |
|
385 | """ | |
386 |
|
386 | |||
387 | def __init__(self, client=None, socket=None, targets=None): |
|
387 | def __init__(self, client=None, socket=None, targets=None): | |
388 | super(DirectView, self).__init__(client=client, socket=socket, targets=targets) |
|
388 | super(DirectView, self).__init__(client=client, socket=socket, targets=targets) | |
389 |
|
389 | |||
390 | @property |
|
390 | @property | |
391 | def importer(self): |
|
391 | def importer(self): | |
392 | """sync_imports(local=True) as a property. |
|
392 | """sync_imports(local=True) as a property. | |
393 |
|
393 | |||
394 | See sync_imports for details. |
|
394 | See sync_imports for details. | |
395 |
|
395 | |||
396 | """ |
|
396 | """ | |
397 | return self.sync_imports(True) |
|
397 | return self.sync_imports(True) | |
398 |
|
398 | |||
399 | @contextmanager |
|
399 | @contextmanager | |
400 | def sync_imports(self, local=True): |
|
400 | def sync_imports(self, local=True): | |
401 | """Context Manager for performing simultaneous local and remote imports. |
|
401 | """Context Manager for performing simultaneous local and remote imports. | |
402 |
|
402 | |||
403 | 'import x as y' will *not* work. The 'as y' part will simply be ignored. |
|
403 | 'import x as y' will *not* work. The 'as y' part will simply be ignored. | |
404 |
|
404 | |||
405 | >>> with view.sync_imports(): |
|
405 | >>> with view.sync_imports(): | |
406 | ... from numpy import recarray |
|
406 | ... from numpy import recarray | |
407 | importing recarray from numpy on engine(s) |
|
407 | importing recarray from numpy on engine(s) | |
408 |
|
408 | |||
409 | """ |
|
409 | """ | |
410 | import __builtin__ |
|
410 | import __builtin__ | |
411 | local_import = __builtin__.__import__ |
|
411 | local_import = __builtin__.__import__ | |
412 | modules = set() |
|
412 | modules = set() | |
413 | results = [] |
|
413 | results = [] | |
414 | @util.interactive |
|
414 | @util.interactive | |
415 | def remote_import(name, fromlist, level): |
|
415 | def remote_import(name, fromlist, level): | |
416 | """the function to be passed to apply, that actually performs the import |
|
416 | """the function to be passed to apply, that actually performs the import | |
417 | on the engine, and loads up the user namespace. |
|
417 | on the engine, and loads up the user namespace. | |
418 | """ |
|
418 | """ | |
419 | import sys |
|
419 | import sys | |
420 | user_ns = globals() |
|
420 | user_ns = globals() | |
421 | mod = __import__(name, fromlist=fromlist, level=level) |
|
421 | mod = __import__(name, fromlist=fromlist, level=level) | |
422 | if fromlist: |
|
422 | if fromlist: | |
423 | for key in fromlist: |
|
423 | for key in fromlist: | |
424 | user_ns[key] = getattr(mod, key) |
|
424 | user_ns[key] = getattr(mod, key) | |
425 | else: |
|
425 | else: | |
426 | user_ns[name] = sys.modules[name] |
|
426 | user_ns[name] = sys.modules[name] | |
427 |
|
427 | |||
428 | def view_import(name, globals={}, locals={}, fromlist=[], level=-1): |
|
428 | def view_import(name, globals={}, locals={}, fromlist=[], level=-1): | |
429 | """the drop-in replacement for __import__, that optionally imports |
|
429 | """the drop-in replacement for __import__, that optionally imports | |
430 | locally as well. |
|
430 | locally as well. | |
431 | """ |
|
431 | """ | |
432 | # don't override nested imports |
|
432 | # don't override nested imports | |
433 | save_import = __builtin__.__import__ |
|
433 | save_import = __builtin__.__import__ | |
434 | __builtin__.__import__ = local_import |
|
434 | __builtin__.__import__ = local_import | |
435 |
|
435 | |||
436 | if imp.lock_held(): |
|
436 | if imp.lock_held(): | |
437 | # this is a side-effect import, don't do it remotely, or even |
|
437 | # this is a side-effect import, don't do it remotely, or even | |
438 | # ignore the local effects |
|
438 | # ignore the local effects | |
439 | return local_import(name, globals, locals, fromlist, level) |
|
439 | return local_import(name, globals, locals, fromlist, level) | |
440 |
|
440 | |||
441 | imp.acquire_lock() |
|
441 | imp.acquire_lock() | |
442 | if local: |
|
442 | if local: | |
443 | mod = local_import(name, globals, locals, fromlist, level) |
|
443 | mod = local_import(name, globals, locals, fromlist, level) | |
444 | else: |
|
444 | else: | |
445 | raise NotImplementedError("remote-only imports not yet implemented") |
|
445 | raise NotImplementedError("remote-only imports not yet implemented") | |
446 | imp.release_lock() |
|
446 | imp.release_lock() | |
447 |
|
447 | |||
448 | key = name+':'+','.join(fromlist or []) |
|
448 | key = name+':'+','.join(fromlist or []) | |
449 | if level == -1 and key not in modules: |
|
449 | if level == -1 and key not in modules: | |
450 | modules.add(key) |
|
450 | modules.add(key) | |
451 | if fromlist: |
|
451 | if fromlist: | |
452 | print "importing %s from %s on engine(s)"%(','.join(fromlist), name) |
|
452 | print "importing %s from %s on engine(s)"%(','.join(fromlist), name) | |
453 | else: |
|
453 | else: | |
454 | print "importing %s on engine(s)"%name |
|
454 | print "importing %s on engine(s)"%name | |
455 | results.append(self.apply_async(remote_import, name, fromlist, level)) |
|
455 | results.append(self.apply_async(remote_import, name, fromlist, level)) | |
456 | # restore override |
|
456 | # restore override | |
457 | __builtin__.__import__ = save_import |
|
457 | __builtin__.__import__ = save_import | |
458 |
|
458 | |||
459 | return mod |
|
459 | return mod | |
460 |
|
460 | |||
461 | # override __import__ |
|
461 | # override __import__ | |
462 | __builtin__.__import__ = view_import |
|
462 | __builtin__.__import__ = view_import | |
463 | try: |
|
463 | try: | |
464 | # enter the block |
|
464 | # enter the block | |
465 | yield |
|
465 | yield | |
466 | except ImportError: |
|
466 | except ImportError: | |
467 | if not local: |
|
467 | if not local: | |
468 | # ignore import errors if not doing local imports |
|
468 | # ignore import errors if not doing local imports | |
469 | pass |
|
469 | pass | |
470 | finally: |
|
470 | finally: | |
471 | # always restore __import__ |
|
471 | # always restore __import__ | |
472 | __builtin__.__import__ = local_import |
|
472 | __builtin__.__import__ = local_import | |
473 |
|
473 | |||
474 | for r in results: |
|
474 | for r in results: | |
475 | # raise possible remote ImportErrors here |
|
475 | # raise possible remote ImportErrors here | |
476 | r.get() |
|
476 | r.get() | |
477 |
|
477 | |||
478 |
|
478 | |||
479 | @sync_results |
|
479 | @sync_results | |
480 | @save_ids |
|
480 | @save_ids | |
481 | def _really_apply(self, f, args=None, kwargs=None, targets=None, block=None, track=None): |
|
481 | def _really_apply(self, f, args=None, kwargs=None, targets=None, block=None, track=None): | |
482 | """calls f(*args, **kwargs) on remote engines, returning the result. |
|
482 | """calls f(*args, **kwargs) on remote engines, returning the result. | |
483 |
|
483 | |||
484 | This method sets all of `apply`'s flags via this View's attributes. |
|
484 | This method sets all of `apply`'s flags via this View's attributes. | |
485 |
|
485 | |||
486 | Parameters |
|
486 | Parameters | |
487 | ---------- |
|
487 | ---------- | |
488 |
|
488 | |||
489 | f : callable |
|
489 | f : callable | |
490 |
|
490 | |||
491 | args : list [default: empty] |
|
491 | args : list [default: empty] | |
492 |
|
492 | |||
493 | kwargs : dict [default: empty] |
|
493 | kwargs : dict [default: empty] | |
494 |
|
494 | |||
495 | targets : target list [default: self.targets] |
|
495 | targets : target list [default: self.targets] | |
496 | where to run |
|
496 | where to run | |
497 | block : bool [default: self.block] |
|
497 | block : bool [default: self.block] | |
498 | whether to block |
|
498 | whether to block | |
499 | track : bool [default: self.track] |
|
499 | track : bool [default: self.track] | |
500 | whether to ask zmq to track the message, for safe non-copying sends |
|
500 | whether to ask zmq to track the message, for safe non-copying sends | |
501 |
|
501 | |||
502 | Returns |
|
502 | Returns | |
503 | ------- |
|
503 | ------- | |
504 |
|
504 | |||
505 | if self.block is False: |
|
505 | if self.block is False: | |
506 | returns AsyncResult |
|
506 | returns AsyncResult | |
507 | else: |
|
507 | else: | |
508 | returns actual result of f(*args, **kwargs) on the engine(s) |
|
508 | returns actual result of f(*args, **kwargs) on the engine(s) | |
509 | This will be a list of self.targets is also a list (even length 1), or |
|
509 | This will be a list of self.targets is also a list (even length 1), or | |
510 | the single result if self.targets is an integer engine id |
|
510 | the single result if self.targets is an integer engine id | |
511 | """ |
|
511 | """ | |
512 | args = [] if args is None else args |
|
512 | args = [] if args is None else args | |
513 | kwargs = {} if kwargs is None else kwargs |
|
513 | kwargs = {} if kwargs is None else kwargs | |
514 | block = self.block if block is None else block |
|
514 | block = self.block if block is None else block | |
515 | track = self.track if track is None else track |
|
515 | track = self.track if track is None else track | |
516 | targets = self.targets if targets is None else targets |
|
516 | targets = self.targets if targets is None else targets | |
517 |
|
517 | |||
518 | _idents = self.client._build_targets(targets)[0] |
|
518 | _idents = self.client._build_targets(targets)[0] | |
519 | msg_ids = [] |
|
519 | msg_ids = [] | |
520 | trackers = [] |
|
520 | trackers = [] | |
521 | for ident in _idents: |
|
521 | for ident in _idents: | |
522 | msg = self.client.send_apply_message(self._socket, f, args, kwargs, track=track, |
|
522 | msg = self.client.send_apply_message(self._socket, f, args, kwargs, track=track, | |
523 | ident=ident) |
|
523 | ident=ident) | |
524 | if track: |
|
524 | if track: | |
525 | trackers.append(msg['tracker']) |
|
525 | trackers.append(msg['tracker']) | |
526 | msg_ids.append(msg['header']['msg_id']) |
|
526 | msg_ids.append(msg['header']['msg_id']) | |
527 | tracker = None if track is False else zmq.MessageTracker(*trackers) |
|
527 | tracker = None if track is False else zmq.MessageTracker(*trackers) | |
528 | ar = AsyncResult(self.client, msg_ids, fname=f.__name__, targets=targets, tracker=tracker) |
|
528 | ar = AsyncResult(self.client, msg_ids, fname=f.__name__, targets=targets, tracker=tracker) | |
529 | if block: |
|
529 | if block: | |
530 | try: |
|
530 | try: | |
531 | return ar.get() |
|
531 | return ar.get() | |
532 | except KeyboardInterrupt: |
|
532 | except KeyboardInterrupt: | |
533 | pass |
|
533 | pass | |
534 | return ar |
|
534 | return ar | |
535 |
|
535 | |||
536 | @spin_after |
|
536 | @spin_after | |
537 | def map(self, f, *sequences, **kwargs): |
|
537 | def map(self, f, *sequences, **kwargs): | |
538 | """view.map(f, *sequences, block=self.block) => list|AsyncMapResult |
|
538 | """view.map(f, *sequences, block=self.block) => list|AsyncMapResult | |
539 |
|
539 | |||
540 | Parallel version of builtin `map`, using this View's `targets`. |
|
540 | Parallel version of builtin `map`, using this View's `targets`. | |
541 |
|
541 | |||
542 | There will be one task per target, so work will be chunked |
|
542 | There will be one task per target, so work will be chunked | |
543 | if the sequences are longer than `targets`. |
|
543 | if the sequences are longer than `targets`. | |
544 |
|
544 | |||
545 | Results can be iterated as they are ready, but will become available in chunks. |
|
545 | Results can be iterated as they are ready, but will become available in chunks. | |
546 |
|
546 | |||
547 | Parameters |
|
547 | Parameters | |
548 | ---------- |
|
548 | ---------- | |
549 |
|
549 | |||
550 | f : callable |
|
550 | f : callable | |
551 | function to be mapped |
|
551 | function to be mapped | |
552 | *sequences: one or more sequences of matching length |
|
552 | *sequences: one or more sequences of matching length | |
553 | the sequences to be distributed and passed to `f` |
|
553 | the sequences to be distributed and passed to `f` | |
554 | block : bool |
|
554 | block : bool | |
555 | whether to wait for the result or not [default self.block] |
|
555 | whether to wait for the result or not [default self.block] | |
556 |
|
556 | |||
557 | Returns |
|
557 | Returns | |
558 | ------- |
|
558 | ------- | |
559 |
|
559 | |||
560 | if block=False: |
|
560 | if block=False: | |
561 | AsyncMapResult |
|
561 | AsyncMapResult | |
562 | An object like AsyncResult, but which reassembles the sequence of results |
|
562 | An object like AsyncResult, but which reassembles the sequence of results | |
563 | into a single list. AsyncMapResults can be iterated through before all |
|
563 | into a single list. AsyncMapResults can be iterated through before all | |
564 | results are complete. |
|
564 | results are complete. | |
565 | else: |
|
565 | else: | |
566 | list |
|
566 | list | |
567 | the result of map(f,*sequences) |
|
567 | the result of map(f,*sequences) | |
568 | """ |
|
568 | """ | |
569 |
|
569 | |||
570 | block = kwargs.pop('block', self.block) |
|
570 | block = kwargs.pop('block', self.block) | |
571 | for k in kwargs.keys(): |
|
571 | for k in kwargs.keys(): | |
572 | if k not in ['block', 'track']: |
|
572 | if k not in ['block', 'track']: | |
573 | raise TypeError("invalid keyword arg, %r"%k) |
|
573 | raise TypeError("invalid keyword arg, %r"%k) | |
574 |
|
574 | |||
575 | assert len(sequences) > 0, "must have some sequences to map onto!" |
|
575 | assert len(sequences) > 0, "must have some sequences to map onto!" | |
576 | pf = ParallelFunction(self, f, block=block, **kwargs) |
|
576 | pf = ParallelFunction(self, f, block=block, **kwargs) | |
577 | return pf.map(*sequences) |
|
577 | return pf.map(*sequences) | |
578 |
|
578 | |||
579 | def execute(self, code, targets=None, block=None): |
|
579 | def execute(self, code, targets=None, block=None): | |
580 | """Executes `code` on `targets` in blocking or nonblocking manner. |
|
580 | """Executes `code` on `targets` in blocking or nonblocking manner. | |
581 |
|
581 | |||
582 | ``execute`` is always `bound` (affects engine namespace) |
|
582 | ``execute`` is always `bound` (affects engine namespace) | |
583 |
|
583 | |||
584 | Parameters |
|
584 | Parameters | |
585 | ---------- |
|
585 | ---------- | |
586 |
|
586 | |||
587 | code : str |
|
587 | code : str | |
588 | the code string to be executed |
|
588 | the code string to be executed | |
589 | block : bool |
|
589 | block : bool | |
590 | whether or not to wait until done to return |
|
590 | whether or not to wait until done to return | |
591 | default: self.block |
|
591 | default: self.block | |
592 | """ |
|
592 | """ | |
593 | return self._really_apply(util._execute, args=(code,), block=block, targets=targets) |
|
593 | return self._really_apply(util._execute, args=(code,), block=block, targets=targets) | |
594 |
|
594 | |||
595 | def run(self, filename, targets=None, block=None): |
|
595 | def run(self, filename, targets=None, block=None): | |
596 | """Execute contents of `filename` on my engine(s). |
|
596 | """Execute contents of `filename` on my engine(s). | |
597 |
|
597 | |||
598 | This simply reads the contents of the file and calls `execute`. |
|
598 | This simply reads the contents of the file and calls `execute`. | |
599 |
|
599 | |||
600 | Parameters |
|
600 | Parameters | |
601 | ---------- |
|
601 | ---------- | |
602 |
|
602 | |||
603 | filename : str |
|
603 | filename : str | |
604 | The path to the file |
|
604 | The path to the file | |
605 | targets : int/str/list of ints/strs |
|
605 | targets : int/str/list of ints/strs | |
606 | the engines on which to execute |
|
606 | the engines on which to execute | |
607 | default : all |
|
607 | default : all | |
608 | block : bool |
|
608 | block : bool | |
609 | whether or not to wait until done |
|
609 | whether or not to wait until done | |
610 | default: self.block |
|
610 | default: self.block | |
611 |
|
611 | |||
612 | """ |
|
612 | """ | |
613 | with open(filename, 'r') as f: |
|
613 | with open(filename, 'r') as f: | |
614 | # add newline in case of trailing indented whitespace |
|
614 | # add newline in case of trailing indented whitespace | |
615 | # which will cause SyntaxError |
|
615 | # which will cause SyntaxError | |
616 | code = f.read()+'\n' |
|
616 | code = f.read()+'\n' | |
617 | return self.execute(code, block=block, targets=targets) |
|
617 | return self.execute(code, block=block, targets=targets) | |
618 |
|
618 | |||
619 | def update(self, ns): |
|
619 | def update(self, ns): | |
620 | """update remote namespace with dict `ns` |
|
620 | """update remote namespace with dict `ns` | |
621 |
|
621 | |||
622 | See `push` for details. |
|
622 | See `push` for details. | |
623 | """ |
|
623 | """ | |
624 | return self.push(ns, block=self.block, track=self.track) |
|
624 | return self.push(ns, block=self.block, track=self.track) | |
625 |
|
625 | |||
626 | def push(self, ns, targets=None, block=None, track=None): |
|
626 | def push(self, ns, targets=None, block=None, track=None): | |
627 | """update remote namespace with dict `ns` |
|
627 | """update remote namespace with dict `ns` | |
628 |
|
628 | |||
629 | Parameters |
|
629 | Parameters | |
630 | ---------- |
|
630 | ---------- | |
631 |
|
631 | |||
632 | ns : dict |
|
632 | ns : dict | |
633 | dict of keys with which to update engine namespace(s) |
|
633 | dict of keys with which to update engine namespace(s) | |
634 | block : bool [default : self.block] |
|
634 | block : bool [default : self.block] | |
635 | whether to wait to be notified of engine receipt |
|
635 | whether to wait to be notified of engine receipt | |
636 |
|
636 | |||
637 | """ |
|
637 | """ | |
638 |
|
638 | |||
639 | block = block if block is not None else self.block |
|
639 | block = block if block is not None else self.block | |
640 | track = track if track is not None else self.track |
|
640 | track = track if track is not None else self.track | |
641 | targets = targets if targets is not None else self.targets |
|
641 | targets = targets if targets is not None else self.targets | |
642 | # applier = self.apply_sync if block else self.apply_async |
|
642 | # applier = self.apply_sync if block else self.apply_async | |
643 | if not isinstance(ns, dict): |
|
643 | if not isinstance(ns, dict): | |
644 | raise TypeError("Must be a dict, not %s"%type(ns)) |
|
644 | raise TypeError("Must be a dict, not %s"%type(ns)) | |
645 | return self._really_apply(util._push, (ns,), block=block, track=track, targets=targets) |
|
645 | return self._really_apply(util._push, (ns,), block=block, track=track, targets=targets) | |
646 |
|
646 | |||
647 | def get(self, key_s): |
|
647 | def get(self, key_s): | |
648 | """get object(s) by `key_s` from remote namespace |
|
648 | """get object(s) by `key_s` from remote namespace | |
649 |
|
649 | |||
650 | see `pull` for details. |
|
650 | see `pull` for details. | |
651 | """ |
|
651 | """ | |
652 | # block = block if block is not None else self.block |
|
652 | # block = block if block is not None else self.block | |
653 | return self.pull(key_s, block=True) |
|
653 | return self.pull(key_s, block=True) | |
654 |
|
654 | |||
655 | def pull(self, names, targets=None, block=None): |
|
655 | def pull(self, names, targets=None, block=None): | |
656 | """get object(s) by `name` from remote namespace |
|
656 | """get object(s) by `name` from remote namespace | |
657 |
|
657 | |||
658 | will return one object if it is a key. |
|
658 | will return one object if it is a key. | |
659 | can also take a list of keys, in which case it will return a list of objects. |
|
659 | can also take a list of keys, in which case it will return a list of objects. | |
660 | """ |
|
660 | """ | |
661 | block = block if block is not None else self.block |
|
661 | block = block if block is not None else self.block | |
662 | targets = targets if targets is not None else self.targets |
|
662 | targets = targets if targets is not None else self.targets | |
663 | applier = self.apply_sync if block else self.apply_async |
|
663 | applier = self.apply_sync if block else self.apply_async | |
664 | if isinstance(names, basestring): |
|
664 | if isinstance(names, basestring): | |
665 | pass |
|
665 | pass | |
666 | elif isinstance(names, (list,tuple,set)): |
|
666 | elif isinstance(names, (list,tuple,set)): | |
667 | for key in names: |
|
667 | for key in names: | |
668 | if not isinstance(key, basestring): |
|
668 | if not isinstance(key, basestring): | |
669 | raise TypeError("keys must be str, not type %r"%type(key)) |
|
669 | raise TypeError("keys must be str, not type %r"%type(key)) | |
670 | else: |
|
670 | else: | |
671 | raise TypeError("names must be strs, not %r"%names) |
|
671 | raise TypeError("names must be strs, not %r"%names) | |
672 | return self._really_apply(util._pull, (names,), block=block, targets=targets) |
|
672 | return self._really_apply(util._pull, (names,), block=block, targets=targets) | |
673 |
|
673 | |||
674 | def scatter(self, key, seq, dist='b', flatten=False, targets=None, block=None, track=None): |
|
674 | def scatter(self, key, seq, dist='b', flatten=False, targets=None, block=None, track=None): | |
675 | """ |
|
675 | """ | |
676 | Partition a Python sequence and send the partitions to a set of engines. |
|
676 | Partition a Python sequence and send the partitions to a set of engines. | |
677 | """ |
|
677 | """ | |
678 | block = block if block is not None else self.block |
|
678 | block = block if block is not None else self.block | |
679 | track = track if track is not None else self.track |
|
679 | track = track if track is not None else self.track | |
680 | targets = targets if targets is not None else self.targets |
|
680 | targets = targets if targets is not None else self.targets | |
681 |
|
681 | |||
682 | mapObject = Map.dists[dist]() |
|
682 | mapObject = Map.dists[dist]() | |
683 | nparts = len(targets) |
|
683 | nparts = len(targets) | |
684 | msg_ids = [] |
|
684 | msg_ids = [] | |
685 | trackers = [] |
|
685 | trackers = [] | |
686 | for index, engineid in enumerate(targets): |
|
686 | for index, engineid in enumerate(targets): | |
687 | partition = mapObject.getPartition(seq, index, nparts) |
|
687 | partition = mapObject.getPartition(seq, index, nparts) | |
688 | if flatten and len(partition) == 1: |
|
688 | if flatten and len(partition) == 1: | |
689 | ns = {key: partition[0]} |
|
689 | ns = {key: partition[0]} | |
690 | else: |
|
690 | else: | |
691 | ns = {key: partition} |
|
691 | ns = {key: partition} | |
692 | r = self.push(ns, block=False, track=track, targets=engineid) |
|
692 | r = self.push(ns, block=False, track=track, targets=engineid) | |
693 | msg_ids.extend(r.msg_ids) |
|
693 | msg_ids.extend(r.msg_ids) | |
694 | if track: |
|
694 | if track: | |
695 | trackers.append(r._tracker) |
|
695 | trackers.append(r._tracker) | |
696 |
|
696 | |||
697 | if track: |
|
697 | if track: | |
698 | tracker = zmq.MessageTracker(*trackers) |
|
698 | tracker = zmq.MessageTracker(*trackers) | |
699 | else: |
|
699 | else: | |
700 | tracker = None |
|
700 | tracker = None | |
701 |
|
701 | |||
702 | r = AsyncResult(self.client, msg_ids, fname='scatter', targets=targets, tracker=tracker) |
|
702 | r = AsyncResult(self.client, msg_ids, fname='scatter', targets=targets, tracker=tracker) | |
703 | if block: |
|
703 | if block: | |
704 | r.wait() |
|
704 | r.wait() | |
705 | else: |
|
705 | else: | |
706 | return r |
|
706 | return r | |
707 |
|
707 | |||
708 | @sync_results |
|
708 | @sync_results | |
709 | @save_ids |
|
709 | @save_ids | |
710 | def gather(self, key, dist='b', targets=None, block=None): |
|
710 | def gather(self, key, dist='b', targets=None, block=None): | |
711 | """ |
|
711 | """ | |
712 | Gather a partitioned sequence on a set of engines as a single local seq. |
|
712 | Gather a partitioned sequence on a set of engines as a single local seq. | |
713 | """ |
|
713 | """ | |
714 | block = block if block is not None else self.block |
|
714 | block = block if block is not None else self.block | |
715 | targets = targets if targets is not None else self.targets |
|
715 | targets = targets if targets is not None else self.targets | |
716 | mapObject = Map.dists[dist]() |
|
716 | mapObject = Map.dists[dist]() | |
717 | msg_ids = [] |
|
717 | msg_ids = [] | |
718 |
|
718 | |||
719 | for index, engineid in enumerate(targets): |
|
719 | for index, engineid in enumerate(targets): | |
720 | msg_ids.extend(self.pull(key, block=False, targets=engineid).msg_ids) |
|
720 | msg_ids.extend(self.pull(key, block=False, targets=engineid).msg_ids) | |
721 |
|
721 | |||
722 | r = AsyncMapResult(self.client, msg_ids, mapObject, fname='gather') |
|
722 | r = AsyncMapResult(self.client, msg_ids, mapObject, fname='gather') | |
723 |
|
723 | |||
724 | if block: |
|
724 | if block: | |
725 | try: |
|
725 | try: | |
726 | return r.get() |
|
726 | return r.get() | |
727 | except KeyboardInterrupt: |
|
727 | except KeyboardInterrupt: | |
728 | pass |
|
728 | pass | |
729 | return r |
|
729 | return r | |
730 |
|
730 | |||
731 | def __getitem__(self, key): |
|
731 | def __getitem__(self, key): | |
732 | return self.get(key) |
|
732 | return self.get(key) | |
733 |
|
733 | |||
734 | def __setitem__(self,key, value): |
|
734 | def __setitem__(self,key, value): | |
735 | self.update({key:value}) |
|
735 | self.update({key:value}) | |
736 |
|
736 | |||
737 | def clear(self, targets=None, block=False): |
|
737 | def clear(self, targets=None, block=False): | |
738 | """Clear the remote namespaces on my engines.""" |
|
738 | """Clear the remote namespaces on my engines.""" | |
739 | block = block if block is not None else self.block |
|
739 | block = block if block is not None else self.block | |
740 | targets = targets if targets is not None else self.targets |
|
740 | targets = targets if targets is not None else self.targets | |
741 | return self.client.clear(targets=targets, block=block) |
|
741 | return self.client.clear(targets=targets, block=block) | |
742 |
|
742 | |||
743 | def kill(self, targets=None, block=True): |
|
743 | def kill(self, targets=None, block=True): | |
744 | """Kill my engines.""" |
|
744 | """Kill my engines.""" | |
745 | block = block if block is not None else self.block |
|
745 | block = block if block is not None else self.block | |
746 | targets = targets if targets is not None else self.targets |
|
746 | targets = targets if targets is not None else self.targets | |
747 | return self.client.kill(targets=targets, block=block) |
|
747 | return self.client.kill(targets=targets, block=block) | |
748 |
|
748 | |||
749 | #---------------------------------------- |
|
749 | #---------------------------------------- | |
750 | # activate for %px,%autopx magics |
|
750 | # activate for %px,%autopx magics | |
751 | #---------------------------------------- |
|
751 | #---------------------------------------- | |
752 | def activate(self): |
|
752 | def activate(self): | |
753 | """Make this `View` active for parallel magic commands. |
|
753 | """Make this `View` active for parallel magic commands. | |
754 |
|
754 | |||
755 | IPython has a magic command syntax to work with `MultiEngineClient` objects. |
|
755 | IPython has a magic command syntax to work with `MultiEngineClient` objects. | |
756 | In a given IPython session there is a single active one. While |
|
756 | In a given IPython session there is a single active one. While | |
757 | there can be many `Views` created and used by the user, |
|
757 | there can be many `Views` created and used by the user, | |
758 | there is only one active one. The active `View` is used whenever |
|
758 | there is only one active one. The active `View` is used whenever | |
759 | the magic commands %px and %autopx are used. |
|
759 | the magic commands %px and %autopx are used. | |
760 |
|
760 | |||
761 | The activate() method is called on a given `View` to make it |
|
761 | The activate() method is called on a given `View` to make it | |
762 | active. Once this has been done, the magic commands can be used. |
|
762 | active. Once this has been done, the magic commands can be used. | |
763 | """ |
|
763 | """ | |
764 |
|
764 | |||
765 | try: |
|
765 | try: | |
766 | # This is injected into __builtins__. |
|
766 | # This is injected into __builtins__. | |
767 | ip = get_ipython() |
|
767 | ip = get_ipython() | |
768 | except NameError: |
|
768 | except NameError: | |
769 | print "The IPython parallel magics (%result, %px, %autopx) only work within IPython." |
|
769 | print "The IPython parallel magics (%result, %px, %autopx) only work within IPython." | |
770 | else: |
|
770 | else: | |
771 | pmagic = ip.plugin_manager.get_plugin('parallelmagic') |
|
771 | pmagic = ip.plugin_manager.get_plugin('parallelmagic') | |
772 | if pmagic is None: |
|
772 | if pmagic is None: | |
773 | ip.magic_load_ext('parallelmagic') |
|
773 | ip.magic_load_ext('parallelmagic') | |
774 | pmagic = ip.plugin_manager.get_plugin('parallelmagic') |
|
774 | pmagic = ip.plugin_manager.get_plugin('parallelmagic') | |
775 |
|
775 | |||
776 | pmagic.active_view = self |
|
776 | pmagic.active_view = self | |
777 |
|
777 | |||
778 |
|
778 | |||
779 | @skip_doctest |
|
779 | @skip_doctest | |
780 | class LoadBalancedView(View): |
|
780 | class LoadBalancedView(View): | |
781 | """An load-balancing View that only executes via the Task scheduler. |
|
781 | """An load-balancing View that only executes via the Task scheduler. | |
782 |
|
782 | |||
783 | Load-balanced views can be created with the client's `view` method: |
|
783 | Load-balanced views can be created with the client's `view` method: | |
784 |
|
784 | |||
785 | >>> v = client.load_balanced_view() |
|
785 | >>> v = client.load_balanced_view() | |
786 |
|
786 | |||
787 | or targets can be specified, to restrict the potential destinations: |
|
787 | or targets can be specified, to restrict the potential destinations: | |
788 |
|
788 | |||
789 |
>>> v = client.client.load_balanced_view( |
|
789 | >>> v = client.client.load_balanced_view([1,3]) | |
790 |
|
790 | |||
791 | which would restrict loadbalancing to between engines 1 and 3. |
|
791 | which would restrict loadbalancing to between engines 1 and 3. | |
792 |
|
792 | |||
793 | """ |
|
793 | """ | |
794 |
|
794 | |||
795 | follow=Any() |
|
795 | follow=Any() | |
796 | after=Any() |
|
796 | after=Any() | |
797 | timeout=CFloat() |
|
797 | timeout=CFloat() | |
798 | retries = CInt(0) |
|
798 | retries = CInt(0) | |
799 |
|
799 | |||
800 | _task_scheme = Any() |
|
800 | _task_scheme = Any() | |
801 | _flag_names = List(['targets', 'block', 'track', 'follow', 'after', 'timeout', 'retries']) |
|
801 | _flag_names = List(['targets', 'block', 'track', 'follow', 'after', 'timeout', 'retries']) | |
802 |
|
802 | |||
803 | def __init__(self, client=None, socket=None, **flags): |
|
803 | def __init__(self, client=None, socket=None, **flags): | |
804 | super(LoadBalancedView, self).__init__(client=client, socket=socket, **flags) |
|
804 | super(LoadBalancedView, self).__init__(client=client, socket=socket, **flags) | |
805 | self._task_scheme=client._task_scheme |
|
805 | self._task_scheme=client._task_scheme | |
806 |
|
806 | |||
807 | def _validate_dependency(self, dep): |
|
807 | def _validate_dependency(self, dep): | |
808 | """validate a dependency. |
|
808 | """validate a dependency. | |
809 |
|
809 | |||
810 | For use in `set_flags`. |
|
810 | For use in `set_flags`. | |
811 | """ |
|
811 | """ | |
812 | if dep is None or isinstance(dep, (basestring, AsyncResult, Dependency)): |
|
812 | if dep is None or isinstance(dep, (basestring, AsyncResult, Dependency)): | |
813 | return True |
|
813 | return True | |
814 | elif isinstance(dep, (list,set, tuple)): |
|
814 | elif isinstance(dep, (list,set, tuple)): | |
815 | for d in dep: |
|
815 | for d in dep: | |
816 | if not isinstance(d, (basestring, AsyncResult)): |
|
816 | if not isinstance(d, (basestring, AsyncResult)): | |
817 | return False |
|
817 | return False | |
818 | elif isinstance(dep, dict): |
|
818 | elif isinstance(dep, dict): | |
819 | if set(dep.keys()) != set(Dependency().as_dict().keys()): |
|
819 | if set(dep.keys()) != set(Dependency().as_dict().keys()): | |
820 | return False |
|
820 | return False | |
821 | if not isinstance(dep['msg_ids'], list): |
|
821 | if not isinstance(dep['msg_ids'], list): | |
822 | return False |
|
822 | return False | |
823 | for d in dep['msg_ids']: |
|
823 | for d in dep['msg_ids']: | |
824 | if not isinstance(d, basestring): |
|
824 | if not isinstance(d, basestring): | |
825 | return False |
|
825 | return False | |
826 | else: |
|
826 | else: | |
827 | return False |
|
827 | return False | |
828 |
|
828 | |||
829 | return True |
|
829 | return True | |
830 |
|
830 | |||
831 | def _render_dependency(self, dep): |
|
831 | def _render_dependency(self, dep): | |
832 | """helper for building jsonable dependencies from various input forms.""" |
|
832 | """helper for building jsonable dependencies from various input forms.""" | |
833 | if isinstance(dep, Dependency): |
|
833 | if isinstance(dep, Dependency): | |
834 | return dep.as_dict() |
|
834 | return dep.as_dict() | |
835 | elif isinstance(dep, AsyncResult): |
|
835 | elif isinstance(dep, AsyncResult): | |
836 | return dep.msg_ids |
|
836 | return dep.msg_ids | |
837 | elif dep is None: |
|
837 | elif dep is None: | |
838 | return [] |
|
838 | return [] | |
839 | else: |
|
839 | else: | |
840 | # pass to Dependency constructor |
|
840 | # pass to Dependency constructor | |
841 | return list(Dependency(dep)) |
|
841 | return list(Dependency(dep)) | |
842 |
|
842 | |||
843 | def set_flags(self, **kwargs): |
|
843 | def set_flags(self, **kwargs): | |
844 | """set my attribute flags by keyword. |
|
844 | """set my attribute flags by keyword. | |
845 |
|
845 | |||
846 | A View is a wrapper for the Client's apply method, but with attributes |
|
846 | A View is a wrapper for the Client's apply method, but with attributes | |
847 | that specify keyword arguments, those attributes can be set by keyword |
|
847 | that specify keyword arguments, those attributes can be set by keyword | |
848 | argument with this method. |
|
848 | argument with this method. | |
849 |
|
849 | |||
850 | Parameters |
|
850 | Parameters | |
851 | ---------- |
|
851 | ---------- | |
852 |
|
852 | |||
853 | block : bool |
|
853 | block : bool | |
854 | whether to wait for results |
|
854 | whether to wait for results | |
855 | track : bool |
|
855 | track : bool | |
856 | whether to create a MessageTracker to allow the user to |
|
856 | whether to create a MessageTracker to allow the user to | |
857 | safely edit after arrays and buffers during non-copying |
|
857 | safely edit after arrays and buffers during non-copying | |
858 | sends. |
|
858 | sends. | |
859 |
|
859 | |||
860 | after : Dependency or collection of msg_ids |
|
860 | after : Dependency or collection of msg_ids | |
861 | Only for load-balanced execution (targets=None) |
|
861 | Only for load-balanced execution (targets=None) | |
862 | Specify a list of msg_ids as a time-based dependency. |
|
862 | Specify a list of msg_ids as a time-based dependency. | |
863 | This job will only be run *after* the dependencies |
|
863 | This job will only be run *after* the dependencies | |
864 | have been met. |
|
864 | have been met. | |
865 |
|
865 | |||
866 | follow : Dependency or collection of msg_ids |
|
866 | follow : Dependency or collection of msg_ids | |
867 | Only for load-balanced execution (targets=None) |
|
867 | Only for load-balanced execution (targets=None) | |
868 | Specify a list of msg_ids as a location-based dependency. |
|
868 | Specify a list of msg_ids as a location-based dependency. | |
869 | This job will only be run on an engine where this dependency |
|
869 | This job will only be run on an engine where this dependency | |
870 | is met. |
|
870 | is met. | |
871 |
|
871 | |||
872 | timeout : float/int or None |
|
872 | timeout : float/int or None | |
873 | Only for load-balanced execution (targets=None) |
|
873 | Only for load-balanced execution (targets=None) | |
874 | Specify an amount of time (in seconds) for the scheduler to |
|
874 | Specify an amount of time (in seconds) for the scheduler to | |
875 | wait for dependencies to be met before failing with a |
|
875 | wait for dependencies to be met before failing with a | |
876 | DependencyTimeout. |
|
876 | DependencyTimeout. | |
877 |
|
877 | |||
878 | retries : int |
|
878 | retries : int | |
879 | Number of times a task will be retried on failure. |
|
879 | Number of times a task will be retried on failure. | |
880 | """ |
|
880 | """ | |
881 |
|
881 | |||
882 | super(LoadBalancedView, self).set_flags(**kwargs) |
|
882 | super(LoadBalancedView, self).set_flags(**kwargs) | |
883 | for name in ('follow', 'after'): |
|
883 | for name in ('follow', 'after'): | |
884 | if name in kwargs: |
|
884 | if name in kwargs: | |
885 | value = kwargs[name] |
|
885 | value = kwargs[name] | |
886 | if self._validate_dependency(value): |
|
886 | if self._validate_dependency(value): | |
887 | setattr(self, name, value) |
|
887 | setattr(self, name, value) | |
888 | else: |
|
888 | else: | |
889 | raise ValueError("Invalid dependency: %r"%value) |
|
889 | raise ValueError("Invalid dependency: %r"%value) | |
890 | if 'timeout' in kwargs: |
|
890 | if 'timeout' in kwargs: | |
891 | t = kwargs['timeout'] |
|
891 | t = kwargs['timeout'] | |
892 | if not isinstance(t, (int, long, float, type(None))): |
|
892 | if not isinstance(t, (int, long, float, type(None))): | |
893 | raise TypeError("Invalid type for timeout: %r"%type(t)) |
|
893 | raise TypeError("Invalid type for timeout: %r"%type(t)) | |
894 | if t is not None: |
|
894 | if t is not None: | |
895 | if t < 0: |
|
895 | if t < 0: | |
896 | raise ValueError("Invalid timeout: %s"%t) |
|
896 | raise ValueError("Invalid timeout: %s"%t) | |
897 | self.timeout = t |
|
897 | self.timeout = t | |
898 |
|
898 | |||
899 | @sync_results |
|
899 | @sync_results | |
900 | @save_ids |
|
900 | @save_ids | |
901 | def _really_apply(self, f, args=None, kwargs=None, block=None, track=None, |
|
901 | def _really_apply(self, f, args=None, kwargs=None, block=None, track=None, | |
902 | after=None, follow=None, timeout=None, |
|
902 | after=None, follow=None, timeout=None, | |
903 | targets=None, retries=None): |
|
903 | targets=None, retries=None): | |
904 | """calls f(*args, **kwargs) on a remote engine, returning the result. |
|
904 | """calls f(*args, **kwargs) on a remote engine, returning the result. | |
905 |
|
905 | |||
906 | This method temporarily sets all of `apply`'s flags for a single call. |
|
906 | This method temporarily sets all of `apply`'s flags for a single call. | |
907 |
|
907 | |||
908 | Parameters |
|
908 | Parameters | |
909 | ---------- |
|
909 | ---------- | |
910 |
|
910 | |||
911 | f : callable |
|
911 | f : callable | |
912 |
|
912 | |||
913 | args : list [default: empty] |
|
913 | args : list [default: empty] | |
914 |
|
914 | |||
915 | kwargs : dict [default: empty] |
|
915 | kwargs : dict [default: empty] | |
916 |
|
916 | |||
917 | block : bool [default: self.block] |
|
917 | block : bool [default: self.block] | |
918 | whether to block |
|
918 | whether to block | |
919 | track : bool [default: self.track] |
|
919 | track : bool [default: self.track] | |
920 | whether to ask zmq to track the message, for safe non-copying sends |
|
920 | whether to ask zmq to track the message, for safe non-copying sends | |
921 |
|
921 | |||
922 | !!!!!! TODO: THE REST HERE !!!! |
|
922 | !!!!!! TODO: THE REST HERE !!!! | |
923 |
|
923 | |||
924 | Returns |
|
924 | Returns | |
925 | ------- |
|
925 | ------- | |
926 |
|
926 | |||
927 | if self.block is False: |
|
927 | if self.block is False: | |
928 | returns AsyncResult |
|
928 | returns AsyncResult | |
929 | else: |
|
929 | else: | |
930 | returns actual result of f(*args, **kwargs) on the engine(s) |
|
930 | returns actual result of f(*args, **kwargs) on the engine(s) | |
931 | This will be a list of self.targets is also a list (even length 1), or |
|
931 | This will be a list of self.targets is also a list (even length 1), or | |
932 | the single result if self.targets is an integer engine id |
|
932 | the single result if self.targets is an integer engine id | |
933 | """ |
|
933 | """ | |
934 |
|
934 | |||
935 | # validate whether we can run |
|
935 | # validate whether we can run | |
936 | if self._socket.closed: |
|
936 | if self._socket.closed: | |
937 | msg = "Task farming is disabled" |
|
937 | msg = "Task farming is disabled" | |
938 | if self._task_scheme == 'pure': |
|
938 | if self._task_scheme == 'pure': | |
939 | msg += " because the pure ZMQ scheduler cannot handle" |
|
939 | msg += " because the pure ZMQ scheduler cannot handle" | |
940 | msg += " disappearing engines." |
|
940 | msg += " disappearing engines." | |
941 | raise RuntimeError(msg) |
|
941 | raise RuntimeError(msg) | |
942 |
|
942 | |||
943 | if self._task_scheme == 'pure': |
|
943 | if self._task_scheme == 'pure': | |
944 | # pure zmq scheme doesn't support extra features |
|
944 | # pure zmq scheme doesn't support extra features | |
945 | msg = "Pure ZMQ scheduler doesn't support the following flags:" |
|
945 | msg = "Pure ZMQ scheduler doesn't support the following flags:" | |
946 | "follow, after, retries, targets, timeout" |
|
946 | "follow, after, retries, targets, timeout" | |
947 | if (follow or after or retries or targets or timeout): |
|
947 | if (follow or after or retries or targets or timeout): | |
948 | # hard fail on Scheduler flags |
|
948 | # hard fail on Scheduler flags | |
949 | raise RuntimeError(msg) |
|
949 | raise RuntimeError(msg) | |
950 | if isinstance(f, dependent): |
|
950 | if isinstance(f, dependent): | |
951 | # soft warn on functional dependencies |
|
951 | # soft warn on functional dependencies | |
952 | warnings.warn(msg, RuntimeWarning) |
|
952 | warnings.warn(msg, RuntimeWarning) | |
953 |
|
953 | |||
954 | # build args |
|
954 | # build args | |
955 | args = [] if args is None else args |
|
955 | args = [] if args is None else args | |
956 | kwargs = {} if kwargs is None else kwargs |
|
956 | kwargs = {} if kwargs is None else kwargs | |
957 | block = self.block if block is None else block |
|
957 | block = self.block if block is None else block | |
958 | track = self.track if track is None else track |
|
958 | track = self.track if track is None else track | |
959 | after = self.after if after is None else after |
|
959 | after = self.after if after is None else after | |
960 | retries = self.retries if retries is None else retries |
|
960 | retries = self.retries if retries is None else retries | |
961 | follow = self.follow if follow is None else follow |
|
961 | follow = self.follow if follow is None else follow | |
962 | timeout = self.timeout if timeout is None else timeout |
|
962 | timeout = self.timeout if timeout is None else timeout | |
963 | targets = self.targets if targets is None else targets |
|
963 | targets = self.targets if targets is None else targets | |
964 |
|
964 | |||
965 | if not isinstance(retries, int): |
|
965 | if not isinstance(retries, int): | |
966 | raise TypeError('retries must be int, not %r'%type(retries)) |
|
966 | raise TypeError('retries must be int, not %r'%type(retries)) | |
967 |
|
967 | |||
968 | if targets is None: |
|
968 | if targets is None: | |
969 | idents = [] |
|
969 | idents = [] | |
970 | else: |
|
970 | else: | |
971 | idents = self.client._build_targets(targets)[0] |
|
971 | idents = self.client._build_targets(targets)[0] | |
972 | # ensure *not* bytes |
|
972 | # ensure *not* bytes | |
973 | idents = [ ident.decode() for ident in idents ] |
|
973 | idents = [ ident.decode() for ident in idents ] | |
974 |
|
974 | |||
975 | after = self._render_dependency(after) |
|
975 | after = self._render_dependency(after) | |
976 | follow = self._render_dependency(follow) |
|
976 | follow = self._render_dependency(follow) | |
977 | subheader = dict(after=after, follow=follow, timeout=timeout, targets=idents, retries=retries) |
|
977 | subheader = dict(after=after, follow=follow, timeout=timeout, targets=idents, retries=retries) | |
978 |
|
978 | |||
979 | msg = self.client.send_apply_message(self._socket, f, args, kwargs, track=track, |
|
979 | msg = self.client.send_apply_message(self._socket, f, args, kwargs, track=track, | |
980 | subheader=subheader) |
|
980 | subheader=subheader) | |
981 | tracker = None if track is False else msg['tracker'] |
|
981 | tracker = None if track is False else msg['tracker'] | |
982 |
|
982 | |||
983 | ar = AsyncResult(self.client, msg['header']['msg_id'], fname=f.__name__, targets=None, tracker=tracker) |
|
983 | ar = AsyncResult(self.client, msg['header']['msg_id'], fname=f.__name__, targets=None, tracker=tracker) | |
984 |
|
984 | |||
985 | if block: |
|
985 | if block: | |
986 | try: |
|
986 | try: | |
987 | return ar.get() |
|
987 | return ar.get() | |
988 | except KeyboardInterrupt: |
|
988 | except KeyboardInterrupt: | |
989 | pass |
|
989 | pass | |
990 | return ar |
|
990 | return ar | |
991 |
|
991 | |||
992 | @spin_after |
|
992 | @spin_after | |
993 | @save_ids |
|
993 | @save_ids | |
994 | def map(self, f, *sequences, **kwargs): |
|
994 | def map(self, f, *sequences, **kwargs): | |
995 | """view.map(f, *sequences, block=self.block, chunksize=1) => list|AsyncMapResult |
|
995 | """view.map(f, *sequences, block=self.block, chunksize=1) => list|AsyncMapResult | |
996 |
|
996 | |||
997 | Parallel version of builtin `map`, load-balanced by this View. |
|
997 | Parallel version of builtin `map`, load-balanced by this View. | |
998 |
|
998 | |||
999 | `block`, and `chunksize` can be specified by keyword only. |
|
999 | `block`, and `chunksize` can be specified by keyword only. | |
1000 |
|
1000 | |||
1001 | Each `chunksize` elements will be a separate task, and will be |
|
1001 | Each `chunksize` elements will be a separate task, and will be | |
1002 | load-balanced. This lets individual elements be available for iteration |
|
1002 | load-balanced. This lets individual elements be available for iteration | |
1003 | as soon as they arrive. |
|
1003 | as soon as they arrive. | |
1004 |
|
1004 | |||
1005 | Parameters |
|
1005 | Parameters | |
1006 | ---------- |
|
1006 | ---------- | |
1007 |
|
1007 | |||
1008 | f : callable |
|
1008 | f : callable | |
1009 | function to be mapped |
|
1009 | function to be mapped | |
1010 | *sequences: one or more sequences of matching length |
|
1010 | *sequences: one or more sequences of matching length | |
1011 | the sequences to be distributed and passed to `f` |
|
1011 | the sequences to be distributed and passed to `f` | |
1012 | block : bool |
|
1012 | block : bool | |
1013 | whether to wait for the result or not [default self.block] |
|
1013 | whether to wait for the result or not [default self.block] | |
1014 | track : bool |
|
1014 | track : bool | |
1015 | whether to create a MessageTracker to allow the user to |
|
1015 | whether to create a MessageTracker to allow the user to | |
1016 | safely edit after arrays and buffers during non-copying |
|
1016 | safely edit after arrays and buffers during non-copying | |
1017 | sends. |
|
1017 | sends. | |
1018 | chunksize : int |
|
1018 | chunksize : int | |
1019 | how many elements should be in each task [default 1] |
|
1019 | how many elements should be in each task [default 1] | |
1020 |
|
1020 | |||
1021 | Returns |
|
1021 | Returns | |
1022 | ------- |
|
1022 | ------- | |
1023 |
|
1023 | |||
1024 | if block=False: |
|
1024 | if block=False: | |
1025 | AsyncMapResult |
|
1025 | AsyncMapResult | |
1026 | An object like AsyncResult, but which reassembles the sequence of results |
|
1026 | An object like AsyncResult, but which reassembles the sequence of results | |
1027 | into a single list. AsyncMapResults can be iterated through before all |
|
1027 | into a single list. AsyncMapResults can be iterated through before all | |
1028 | results are complete. |
|
1028 | results are complete. | |
1029 | else: |
|
1029 | else: | |
1030 | the result of map(f,*sequences) |
|
1030 | the result of map(f,*sequences) | |
1031 |
|
1031 | |||
1032 | """ |
|
1032 | """ | |
1033 |
|
1033 | |||
1034 | # default |
|
1034 | # default | |
1035 | block = kwargs.get('block', self.block) |
|
1035 | block = kwargs.get('block', self.block) | |
1036 | chunksize = kwargs.get('chunksize', 1) |
|
1036 | chunksize = kwargs.get('chunksize', 1) | |
1037 |
|
1037 | |||
1038 | keyset = set(kwargs.keys()) |
|
1038 | keyset = set(kwargs.keys()) | |
1039 | extra_keys = keyset.difference_update(set(['block', 'chunksize'])) |
|
1039 | extra_keys = keyset.difference_update(set(['block', 'chunksize'])) | |
1040 | if extra_keys: |
|
1040 | if extra_keys: | |
1041 | raise TypeError("Invalid kwargs: %s"%list(extra_keys)) |
|
1041 | raise TypeError("Invalid kwargs: %s"%list(extra_keys)) | |
1042 |
|
1042 | |||
1043 | assert len(sequences) > 0, "must have some sequences to map onto!" |
|
1043 | assert len(sequences) > 0, "must have some sequences to map onto!" | |
1044 |
|
1044 | |||
1045 | pf = ParallelFunction(self, f, block=block, chunksize=chunksize) |
|
1045 | pf = ParallelFunction(self, f, block=block, chunksize=chunksize) | |
1046 | return pf.map(*sequences) |
|
1046 | return pf.map(*sequences) | |
1047 |
|
1047 | |||
1048 | __all__ = ['LoadBalancedView', 'DirectView'] |
|
1048 | __all__ = ['LoadBalancedView', 'DirectView'] |
General Comments 0
You need to be logged in to leave comments.
Login now