Show More
This diff has been collapsed as it changes many lines, (716 lines changed) Show them Hide them | |||
@@ -1,170 +1,770 | |||
|
1 | 1 | { |
|
2 | 2 | "metadata": { |
|
3 | 3 | "name": "", |
|
4 | "signature": "sha256:3f30c6e839ac39f890da34a2af6bf50bf0d99ea32f7aadc043f3e31f619e4bc9" | |
|
4 | "signature": "sha256:6d8c7c51322c4911e478068e8fa8e897bd72c614096f5df110ed86d01d66001c" | |
|
5 | 5 | }, |
|
6 | 6 | "nbformat": 3, |
|
7 | 7 | "nbformat_minor": 0, |
|
8 | 8 | "worksheets": [ |
|
9 | 9 | { |
|
10 | 10 | "cells": [ |
|
11 | 11 | { |
|
12 | 12 | "cell_type": "heading", |
|
13 | 13 | "level": 1, |
|
14 | 14 | "metadata": {}, |
|
15 | 15 | "source": [ |
|
16 | "Interact" | |
|
16 | "Using Interact" | |
|
17 | 17 | ] |
|
18 | 18 | }, |
|
19 | 19 | { |
|
20 | 20 | "cell_type": "markdown", |
|
21 | 21 | "metadata": {}, |
|
22 | 22 | "source": [ |
|
23 | "The `interact` function provides a high-level interface for creating user interface controls to use in exploring code and data interactively." | |
|
23 | "The `interact` function (`IPython.html.widgets.interact`) automatically creates user interface (UI) controls for exploring code and data interactively. It is the easiest way to get started using IPython's widgets." | |
|
24 | 24 | ] |
|
25 | 25 | }, |
|
26 | 26 | { |
|
27 | 27 | "cell_type": "code", |
|
28 | 28 | "collapsed": false, |
|
29 | 29 | "input": [ |
|
30 | 30 | "from IPython.html.widgets import interact, interactive, fixed\n", |
|
31 |
"from IPython.html import widgets |
|
|
32 | "from IPython.display import clear_output, display, HTML" | |
|
31 | "from IPython.html import widgets" | |
|
33 | 32 | ], |
|
34 | 33 | "language": "python", |
|
35 | 34 | "metadata": {}, |
|
36 | 35 | "outputs": [], |
|
37 | 36 | "prompt_number": 1 |
|
38 | 37 | }, |
|
39 | 38 | { |
|
39 | "cell_type": "markdown", | |
|
40 | "metadata": {}, | |
|
41 | "source": [ | |
|
42 | "<div class=\"alert alert-success\">\n", | |
|
43 | "As of IPython 2.0, the widgets in this notebook won't show up on http://nbviewer.ipython.org. To view the widgets and interact with them, you will need to download this notebook and run it with an IPython Notebook server.\n", | |
|
44 | "</div>" | |
|
45 | ] | |
|
46 | }, | |
|
47 | { | |
|
40 | 48 | "cell_type": "heading", |
|
41 | 49 | "level": 2, |
|
42 | 50 | "metadata": {}, |
|
43 | 51 | "source": [ |
|
44 | "Basic interact" | |
|
52 | "Basic `interact`" | |
|
45 | 53 | ] |
|
46 | 54 | }, |
|
47 | 55 | { |
|
48 | 56 | "cell_type": "markdown", |
|
49 | 57 | "metadata": {}, |
|
50 | 58 | "source": [ |
|
51 | "Here is a simple function that displays its arguments as an HTML table:" | |
|
59 | "At the most basic level, `interact` autogenerates UI controls for function arguments, and then calls the function with those arguments when you manipulate the controls interactively. To use `interact`, you need to define a function that you want to explore. Here is a function that prints its only argument `x`." | |
|
52 | 60 | ] |
|
53 | 61 | }, |
|
54 | 62 | { |
|
55 | 63 | "cell_type": "code", |
|
56 | 64 | "collapsed": false, |
|
57 | 65 | "input": [ |
|
58 |
"def |
|
|
59 | " s = '<h3>Arguments:</h3><table>\\n'\n", | |
|
60 | " for k,v in kwargs.items():\n", | |
|
61 | " s += '<tr><td>{0}</td><td>{1}</td></tr>\\n'.format(k,v)\n", | |
|
62 | " s += '</table>'\n", | |
|
63 | " display(HTML(s))" | |
|
66 | "def f(x):\n", | |
|
67 | " print x" | |
|
64 | 68 | ], |
|
65 | 69 | "language": "python", |
|
66 | 70 | "metadata": {}, |
|
67 | 71 | "outputs": [], |
|
68 | 72 | "prompt_number": 2 |
|
69 | 73 | }, |
|
70 | 74 | { |
|
75 | "cell_type": "markdown", | |
|
76 | "metadata": {}, | |
|
77 | "source": [ | |
|
78 | "When you pass this function as the first argument to `interact` along with an integer keyword argument (`x=10`), a slider is generated and bound to the function." | |
|
79 | ] | |
|
80 | }, | |
|
81 | { | |
|
71 | 82 | "cell_type": "code", |
|
72 | 83 | "collapsed": false, |
|
73 | 84 | "input": [ |
|
74 | "show_args(a=10, b='Hi There', c=True)" | |
|
85 | "interact(f, x=10);" | |
|
75 | 86 | ], |
|
76 | 87 | "language": "python", |
|
77 | 88 | "metadata": {}, |
|
78 | 89 | "outputs": [ |
|
79 | 90 | { |
|
80 | "html": [ | |
|
81 | "<h3>Arguments:</h3><table>\n", | |
|
82 | "<tr><td>a</td><td>10</td></tr>\n", | |
|
83 | "<tr><td>c</td><td>True</td></tr>\n", | |
|
84 | "<tr><td>b</td><td>Hi There</td></tr>\n", | |
|
85 | "</table>" | |
|
86 | ], | |
|
87 | "metadata": {}, | |
|
88 | "output_type": "display_data", | |
|
91 | "output_type": "stream", | |
|
92 | "stream": "stdout", | |
|
89 | 93 | "text": [ |
|
90 | "<IPython.core.display.HTML object>" | |
|
94 | "9\n" | |
|
91 | 95 | ] |
|
92 | 96 | } |
|
93 | 97 | ], |
|
94 | 98 | "prompt_number": 3 |
|
95 | 99 | }, |
|
96 | 100 | { |
|
97 | 101 | "cell_type": "markdown", |
|
98 | 102 | "metadata": {}, |
|
99 | 103 | "source": [ |
|
100 | "Let's use this function to explore how `interact` works." | |
|
104 | "When you move the slider, the function is called and the current value of `x` is printed.\n", | |
|
105 | "\n", | |
|
106 | "If you pass `True` or `False`, `interact` will generate a checkbox:" | |
|
101 | 107 | ] |
|
102 | 108 | }, |
|
103 | 109 | { |
|
104 | 110 | "cell_type": "code", |
|
105 | 111 | "collapsed": false, |
|
106 | 112 | "input": [ |
|
107 | "i = interact(show_args,\n", | |
|
108 | " Temp=(0,10),\n", | |
|
109 | " Current=(0.,10.,0.01),\n", | |
|
110 | " z=True,\n", | |
|
111 | " Text=u'Type here!',\n", | |
|
112 | " #Algorithm=['This','That','Other'],\n", | |
|
113 | " a=widgets.FloatSliderWidget(min=-10.0, max=10.0, step=0.1, value=5.0, description=\"Float (a)\")\n", | |
|
114 | " )" | |
|
113 | "interact(f, x=True);" | |
|
115 | 114 | ], |
|
116 | 115 | "language": "python", |
|
117 | 116 | "metadata": {}, |
|
118 | 117 | "outputs": [ |
|
119 | 118 | { |
|
120 | "html": [ | |
|
121 | "<h3>Arguments:</h3><table>\n", | |
|
122 | "<tr><td>Current</td><td>4.99</td></tr>\n", | |
|
123 | "<tr><td>Text</td><td>Type here!</td></tr>\n", | |
|
124 | "<tr><td>z</td><td>True</td></tr>\n", | |
|
125 | "<tr><td>Temp</td><td>5</td></tr>\n", | |
|
126 | "<tr><td>Float (a)</td><td>5.0</td></tr>\n", | |
|
127 | "</table>" | |
|
128 | ], | |
|
129 | "metadata": {}, | |
|
130 | "output_type": "display_data", | |
|
119 | "output_type": "stream", | |
|
120 | "stream": "stdout", | |
|
131 | 121 | "text": [ |
|
132 | "<IPython.core.display.HTML object>" | |
|
122 | "True\n" | |
|
133 | 123 | ] |
|
134 | 124 | } |
|
135 | 125 | ], |
|
136 | 126 | "prompt_number": 4 |
|
137 | 127 | }, |
|
138 | 128 | { |
|
129 | "cell_type": "markdown", | |
|
130 | "metadata": {}, | |
|
131 | "source": [ | |
|
132 | "If you pass a string, `interact` will generate a text area." | |
|
133 | ] | |
|
134 | }, | |
|
135 | { | |
|
139 | 136 | "cell_type": "code", |
|
140 | 137 | "collapsed": false, |
|
141 | 138 | "input": [ |
|
142 | "i.widget" | |
|
139 | "interact(f, x='Hi there!');" | |
|
143 | 140 | ], |
|
144 | 141 | "language": "python", |
|
145 | 142 | "metadata": {}, |
|
146 | 143 | "outputs": [ |
|
147 | 144 | { |
|
148 | "html": [ | |
|
149 | "<h3>Arguments:</h3><table>\n", | |
|
150 | "<tr><td>Current</td><td>4.99</td></tr>\n", | |
|
151 | "<tr><td>Text</td><td>Type here!</td></tr>\n", | |
|
152 | "<tr><td>z</td><td>True</td></tr>\n", | |
|
153 | "<tr><td>Temp</td><td>5</td></tr>\n", | |
|
154 | "<tr><td>Float (a)</td><td>5.0</td></tr>\n", | |
|
155 | "</table>" | |
|
156 | ], | |
|
157 | "metadata": {}, | |
|
158 | "output_type": "display_data", | |
|
145 | "output_type": "stream", | |
|
146 | "stream": "stdout", | |
|
159 | 147 | "text": [ |
|
160 | "<IPython.core.display.HTML object>" | |
|
148 | "Hi there!\n" | |
|
161 | 149 | ] |
|
162 | 150 | } |
|
163 | 151 | ], |
|
164 | 152 | "prompt_number": 5 |
|
153 | }, | |
|
154 | { | |
|
155 | "cell_type": "markdown", | |
|
156 | "metadata": {}, | |
|
157 | "source": [ | |
|
158 | "`interact` can also be used as a decorator. This allows you to define a function and interact with it in a single shot. As this example shows, `interact` also works with functions that have multiple arguments." | |
|
159 | ] | |
|
160 | }, | |
|
161 | { | |
|
162 | "cell_type": "code", | |
|
163 | "collapsed": false, | |
|
164 | "input": [ | |
|
165 | "@interact(x=True, y=1.0)\n", | |
|
166 | "def g(x, y):\n", | |
|
167 | " print x, y" | |
|
168 | ], | |
|
169 | "language": "python", | |
|
170 | "metadata": {}, | |
|
171 | "outputs": [ | |
|
172 | { | |
|
173 | "output_type": "stream", | |
|
174 | "stream": "stdout", | |
|
175 | "text": [ | |
|
176 | "True 1.0\n" | |
|
177 | ] | |
|
178 | } | |
|
179 | ], | |
|
180 | "prompt_number": 6 | |
|
181 | }, | |
|
182 | { | |
|
183 | "cell_type": "heading", | |
|
184 | "level": 2, | |
|
185 | "metadata": {}, | |
|
186 | "source": [ | |
|
187 | "Fixing arguments using `fixed`" | |
|
188 | ] | |
|
189 | }, | |
|
190 | { | |
|
191 | "cell_type": "markdown", | |
|
192 | "metadata": {}, | |
|
193 | "source": [ | |
|
194 | "There are times when you may want to explore a function using `interact`, but fix one or more of its arguments to specific values. This can be accomplished by wrapping values with the `fixed` function." | |
|
195 | ] | |
|
196 | }, | |
|
197 | { | |
|
198 | "cell_type": "code", | |
|
199 | "collapsed": false, | |
|
200 | "input": [ | |
|
201 | "def h(p, q):\n", | |
|
202 | " print p, q" | |
|
203 | ], | |
|
204 | "language": "python", | |
|
205 | "metadata": {}, | |
|
206 | "outputs": [], | |
|
207 | "prompt_number": 7 | |
|
208 | }, | |
|
209 | { | |
|
210 | "cell_type": "markdown", | |
|
211 | "metadata": {}, | |
|
212 | "source": [ | |
|
213 | "When we call `interact`, we pass `fixed(20)` for q to hold it fixed at a value of `20`." | |
|
214 | ] | |
|
215 | }, | |
|
216 | { | |
|
217 | "cell_type": "code", | |
|
218 | "collapsed": false, | |
|
219 | "input": [ | |
|
220 | "interact(h, p=5, q=fixed(20));" | |
|
221 | ], | |
|
222 | "language": "python", | |
|
223 | "metadata": {}, | |
|
224 | "outputs": [ | |
|
225 | { | |
|
226 | "output_type": "stream", | |
|
227 | "stream": "stdout", | |
|
228 | "text": [ | |
|
229 | "5 20\n" | |
|
230 | ] | |
|
231 | } | |
|
232 | ], | |
|
233 | "prompt_number": 8 | |
|
234 | }, | |
|
235 | { | |
|
236 | "cell_type": "markdown", | |
|
237 | "metadata": {}, | |
|
238 | "source": [ | |
|
239 | "Notice that a slider is only produced for `p` as the value of `q` is fixed." | |
|
240 | ] | |
|
241 | }, | |
|
242 | { | |
|
243 | "cell_type": "heading", | |
|
244 | "level": 2, | |
|
245 | "metadata": {}, | |
|
246 | "source": [ | |
|
247 | "Widget abbreviations" | |
|
248 | ] | |
|
249 | }, | |
|
250 | { | |
|
251 | "cell_type": "markdown", | |
|
252 | "metadata": {}, | |
|
253 | "source": [ | |
|
254 | "When you pass an integer valued keyword argument (`x=10`) to `interact`, it generates an integer valued slider control with a range of $[-10,+3\\times10]$. In this case `10` is an *abbreviation* for an actual slider widget:\n", | |
|
255 | "\n", | |
|
256 | "```python\n", | |
|
257 | "IntSliderWidget(min=-10,max=30,step=1,value=10)\n", | |
|
258 | "```\n", | |
|
259 | "\n", | |
|
260 | "In fact, we can get the same result if we pass this `IntSliderWidget` as the keyword argument for `x`:" | |
|
261 | ] | |
|
262 | }, | |
|
263 | { | |
|
264 | "cell_type": "code", | |
|
265 | "collapsed": false, | |
|
266 | "input": [ | |
|
267 | "interact(f, x=widgets.IntSliderWidget(min=-10,max=30,step=1,value=10));" | |
|
268 | ], | |
|
269 | "language": "python", | |
|
270 | "metadata": {}, | |
|
271 | "outputs": [ | |
|
272 | { | |
|
273 | "output_type": "stream", | |
|
274 | "stream": "stdout", | |
|
275 | "text": [ | |
|
276 | "10\n" | |
|
277 | ] | |
|
278 | } | |
|
279 | ], | |
|
280 | "prompt_number": 9 | |
|
281 | }, | |
|
282 | { | |
|
283 | "cell_type": "markdown", | |
|
284 | "metadata": {}, | |
|
285 | "source": [ | |
|
286 | "This examples clarifies how `interact` proceses its keyword arguments:\n", | |
|
287 | "\n", | |
|
288 | "1. If the keyword argument is `Widget` instance with a `value` attribute, that widget is used. Any widget with a `value` attribute can be used, even custom ones.\n", | |
|
289 | "2. Otherwise, the value is treated as a *widget abbreviation* that is converted to a widget before it is used.\n", | |
|
290 | "\n", | |
|
291 | "The following table gives an overview of different widget abbreviations:\n", | |
|
292 | "\n", | |
|
293 | "<table class=\"table table-condensed table-bordered\">\n", | |
|
294 | " <tr><td><strong>Keyword argument</strong></td><td><strong>Widget</strong></td></tr> \n", | |
|
295 | " <tr><td>`True` or `False`</td><td>CheckboxWiget</td></tr> \n", | |
|
296 | " <tr><td>`'Hi there'`</td><td>TextareaWidget</td></tr>\n", | |
|
297 | " <tr><td>`value` or `(min,max)` or `(min,max,step)` if integers are passed</td><td>IntSliderWidget</td></tr>\n", | |
|
298 | " <tr><td>`value` or `(min,max)` or `(min,max,step)` if floats are passed</td><td>FloatSliderWidget</td></tr>\n", | |
|
299 | " <tr><td>`('orange','apple')` or `{'one':1,'two':2}`</td><td>DropdownWidget</td></tr>\n", | |
|
300 | "</table>" | |
|
301 | ] | |
|
302 | }, | |
|
303 | { | |
|
304 | "cell_type": "markdown", | |
|
305 | "metadata": {}, | |
|
306 | "source": [ | |
|
307 | "You have seen how the checkbox and textarea widgets work above. Here, more details about the different abbreviations for sliders and dropdowns are given.\n", | |
|
308 | "\n", | |
|
309 | "If a 2-tuple of integers is passed `(min,max)` a integer valued slider is produced with those minimum and maximum (inclusive) values. In this case, the default step size of `1` is used." | |
|
310 | ] | |
|
311 | }, | |
|
312 | { | |
|
313 | "cell_type": "code", | |
|
314 | "collapsed": false, | |
|
315 | "input": [ | |
|
316 | "interact(f, x=(0,4));" | |
|
317 | ], | |
|
318 | "language": "python", | |
|
319 | "metadata": {}, | |
|
320 | "outputs": [ | |
|
321 | { | |
|
322 | "output_type": "stream", | |
|
323 | "stream": "stdout", | |
|
324 | "text": [ | |
|
325 | "2\n" | |
|
326 | ] | |
|
327 | } | |
|
328 | ], | |
|
329 | "prompt_number": 10 | |
|
330 | }, | |
|
331 | { | |
|
332 | "cell_type": "markdown", | |
|
333 | "metadata": {}, | |
|
334 | "source": [ | |
|
335 | "If a 3-tuple of integers is passed `(min,max,step)` the step size can also be set." | |
|
336 | ] | |
|
337 | }, | |
|
338 | { | |
|
339 | "cell_type": "code", | |
|
340 | "collapsed": false, | |
|
341 | "input": [ | |
|
342 | "interact(f, x=(0,8,2));" | |
|
343 | ], | |
|
344 | "language": "python", | |
|
345 | "metadata": {}, | |
|
346 | "outputs": [ | |
|
347 | { | |
|
348 | "output_type": "stream", | |
|
349 | "stream": "stdout", | |
|
350 | "text": [ | |
|
351 | "4\n" | |
|
352 | ] | |
|
353 | } | |
|
354 | ], | |
|
355 | "prompt_number": 11 | |
|
356 | }, | |
|
357 | { | |
|
358 | "cell_type": "markdown", | |
|
359 | "metadata": {}, | |
|
360 | "source": [ | |
|
361 | "A float valued slider is produced if the elements of the tuples are floats. Here the minimum is `0.0`, the maximum is `10.0` and step size is `0.1` (the default)." | |
|
362 | ] | |
|
363 | }, | |
|
364 | { | |
|
365 | "cell_type": "code", | |
|
366 | "collapsed": false, | |
|
367 | "input": [ | |
|
368 | "interact(f, x=(0.0,10.0));" | |
|
369 | ], | |
|
370 | "language": "python", | |
|
371 | "metadata": {}, | |
|
372 | "outputs": [ | |
|
373 | { | |
|
374 | "output_type": "stream", | |
|
375 | "stream": "stdout", | |
|
376 | "text": [ | |
|
377 | "5.0\n" | |
|
378 | ] | |
|
379 | } | |
|
380 | ], | |
|
381 | "prompt_number": 12 | |
|
382 | }, | |
|
383 | { | |
|
384 | "cell_type": "markdown", | |
|
385 | "metadata": {}, | |
|
386 | "source": [ | |
|
387 | "The step size can be changed by passing a 3rd element in the tuple." | |
|
388 | ] | |
|
389 | }, | |
|
390 | { | |
|
391 | "cell_type": "code", | |
|
392 | "collapsed": false, | |
|
393 | "input": [ | |
|
394 | "interact(f, x=(0.0,10.0,0.01));" | |
|
395 | ], | |
|
396 | "language": "python", | |
|
397 | "metadata": {}, | |
|
398 | "outputs": [ | |
|
399 | { | |
|
400 | "output_type": "stream", | |
|
401 | "stream": "stdout", | |
|
402 | "text": [ | |
|
403 | "4.99\n" | |
|
404 | ] | |
|
405 | } | |
|
406 | ], | |
|
407 | "prompt_number": 13 | |
|
408 | }, | |
|
409 | { | |
|
410 | "cell_type": "markdown", | |
|
411 | "metadata": {}, | |
|
412 | "source": [ | |
|
413 | "For both integer and float valued sliders, you can pick the initial value of the widget by passing a default keyword argument to the underlying Python function. Here we set the initial value of a float slider to `5.5`." | |
|
414 | ] | |
|
415 | }, | |
|
416 | { | |
|
417 | "cell_type": "code", | |
|
418 | "collapsed": false, | |
|
419 | "input": [ | |
|
420 | "@interact(x=(0.0,20.0,0.5))\n", | |
|
421 | "def h(x=5.5):\n", | |
|
422 | " print x" | |
|
423 | ], | |
|
424 | "language": "python", | |
|
425 | "metadata": {}, | |
|
426 | "outputs": [ | |
|
427 | { | |
|
428 | "output_type": "stream", | |
|
429 | "stream": "stdout", | |
|
430 | "text": [ | |
|
431 | "5.5\n" | |
|
432 | ] | |
|
433 | } | |
|
434 | ], | |
|
435 | "prompt_number": 14 | |
|
436 | }, | |
|
437 | { | |
|
438 | "cell_type": "markdown", | |
|
439 | "metadata": {}, | |
|
440 | "source": [ | |
|
441 | "Dropdown menus can be produced by passing a tuple of strings. In this case, the strings are both used as the names in the dropdown menu UI and passed to the underlying Python function." | |
|
442 | ] | |
|
443 | }, | |
|
444 | { | |
|
445 | "cell_type": "code", | |
|
446 | "collapsed": false, | |
|
447 | "input": [ | |
|
448 | "interact(f, x=('apples','oranges'));" | |
|
449 | ], | |
|
450 | "language": "python", | |
|
451 | "metadata": {}, | |
|
452 | "outputs": [ | |
|
453 | { | |
|
454 | "output_type": "stream", | |
|
455 | "stream": "stdout", | |
|
456 | "text": [ | |
|
457 | "apples\n" | |
|
458 | ] | |
|
459 | } | |
|
460 | ], | |
|
461 | "prompt_number": 15 | |
|
462 | }, | |
|
463 | { | |
|
464 | "cell_type": "markdown", | |
|
465 | "metadata": {}, | |
|
466 | "source": [ | |
|
467 | "If you want a dropdown menu that passes non-string values to the Python function, you can pass a dictionary. The keys in the dictionary are used for the names in the dropdown menu UI and the values are the arguments that are passed to the underlying Python function." | |
|
468 | ] | |
|
469 | }, | |
|
470 | { | |
|
471 | "cell_type": "code", | |
|
472 | "collapsed": false, | |
|
473 | "input": [ | |
|
474 | "interact(f, x={'one': 10, 'two': 20});" | |
|
475 | ], | |
|
476 | "language": "python", | |
|
477 | "metadata": {}, | |
|
478 | "outputs": [ | |
|
479 | { | |
|
480 | "output_type": "stream", | |
|
481 | "stream": "stdout", | |
|
482 | "text": [ | |
|
483 | "20\n" | |
|
484 | ] | |
|
485 | } | |
|
486 | ], | |
|
487 | "prompt_number": 16 | |
|
488 | }, | |
|
489 | { | |
|
490 | "cell_type": "heading", | |
|
491 | "level": 2, | |
|
492 | "metadata": {}, | |
|
493 | "source": [ | |
|
494 | "Using function annotations with `interact`" | |
|
495 | ] | |
|
496 | }, | |
|
497 | { | |
|
498 | "cell_type": "markdown", | |
|
499 | "metadata": {}, | |
|
500 | "source": [ | |
|
501 | "If you are using Python 3, you can also specify widget abbreviations using [function annotations](https://docs.python.org/3/tutorial/controlflow.html#function-annotations). This is a convenient approach allows the widget abbreviations to be defined with a function.\n", | |
|
502 | "\n", | |
|
503 | "Define a function with an checkbox widget abbreviation for the argument `x`." | |
|
504 | ] | |
|
505 | }, | |
|
506 | { | |
|
507 | "cell_type": "code", | |
|
508 | "collapsed": false, | |
|
509 | "input": [ | |
|
510 | "def f(x:True):\n", | |
|
511 | " print x" | |
|
512 | ], | |
|
513 | "language": "python", | |
|
514 | "metadata": {}, | |
|
515 | "outputs": [] | |
|
516 | }, | |
|
517 | { | |
|
518 | "cell_type": "markdown", | |
|
519 | "metadata": {}, | |
|
520 | "source": [ | |
|
521 | "Then, because the widget abbreviation has already been defined, you can call `interact` with a single argument." | |
|
522 | ] | |
|
523 | }, | |
|
524 | { | |
|
525 | "cell_type": "code", | |
|
526 | "collapsed": false, | |
|
527 | "input": [ | |
|
528 | "interact(f);" | |
|
529 | ], | |
|
530 | "language": "python", | |
|
531 | "metadata": {}, | |
|
532 | "outputs": [] | |
|
533 | }, | |
|
534 | { | |
|
535 | "cell_type": "markdown", | |
|
536 | "metadata": {}, | |
|
537 | "source": [ | |
|
538 | "If you are running Python 2, function annotations can be defined using the `@annotate` function." | |
|
539 | ] | |
|
540 | }, | |
|
541 | { | |
|
542 | "cell_type": "code", | |
|
543 | "collapsed": false, | |
|
544 | "input": [ | |
|
545 | "from IPython.utils.py3compat import annotate" | |
|
546 | ], | |
|
547 | "language": "python", | |
|
548 | "metadata": {}, | |
|
549 | "outputs": [], | |
|
550 | "prompt_number": 50 | |
|
551 | }, | |
|
552 | { | |
|
553 | "cell_type": "code", | |
|
554 | "collapsed": false, | |
|
555 | "input": [ | |
|
556 | "@annotate(x=True)\n", | |
|
557 | "def f(x):\n", | |
|
558 | " print x" | |
|
559 | ], | |
|
560 | "language": "python", | |
|
561 | "metadata": {}, | |
|
562 | "outputs": [], | |
|
563 | "prompt_number": 51 | |
|
564 | }, | |
|
565 | { | |
|
566 | "cell_type": "code", | |
|
567 | "collapsed": false, | |
|
568 | "input": [ | |
|
569 | "interact(f);" | |
|
570 | ], | |
|
571 | "language": "python", | |
|
572 | "metadata": {}, | |
|
573 | "outputs": [ | |
|
574 | { | |
|
575 | "output_type": "stream", | |
|
576 | "stream": "stdout", | |
|
577 | "text": [ | |
|
578 | "True\n" | |
|
579 | ] | |
|
580 | } | |
|
581 | ], | |
|
582 | "prompt_number": 52 | |
|
583 | }, | |
|
584 | { | |
|
585 | "cell_type": "heading", | |
|
586 | "level": 2, | |
|
587 | "metadata": {}, | |
|
588 | "source": [ | |
|
589 | "`interactive`" | |
|
590 | ] | |
|
591 | }, | |
|
592 | { | |
|
593 | "cell_type": "markdown", | |
|
594 | "metadata": {}, | |
|
595 | "source": [ | |
|
596 | "In addition to `interact` IPython provides another function, `interactive`, that is useful when you want to reuse the widget that are produced or access the data that is bound to the UI controls." | |
|
597 | ] | |
|
598 | }, | |
|
599 | { | |
|
600 | "cell_type": "markdown", | |
|
601 | "metadata": {}, | |
|
602 | "source": [ | |
|
603 | "Here is a function that returns the sum of its two arguments." | |
|
604 | ] | |
|
605 | }, | |
|
606 | { | |
|
607 | "cell_type": "code", | |
|
608 | "collapsed": false, | |
|
609 | "input": [ | |
|
610 | "def f(a, b):\n", | |
|
611 | " return a+b" | |
|
612 | ], | |
|
613 | "language": "python", | |
|
614 | "metadata": {}, | |
|
615 | "outputs": [], | |
|
616 | "prompt_number": 18 | |
|
617 | }, | |
|
618 | { | |
|
619 | "cell_type": "markdown", | |
|
620 | "metadata": {}, | |
|
621 | "source": [ | |
|
622 | "Unlike `interact`, `interactive` returns a `Widget` instance rather than immediately displaying the widget." | |
|
623 | ] | |
|
624 | }, | |
|
625 | { | |
|
626 | "cell_type": "code", | |
|
627 | "collapsed": false, | |
|
628 | "input": [ | |
|
629 | "w = interactive(f, a=10, b=20)" | |
|
630 | ], | |
|
631 | "language": "python", | |
|
632 | "metadata": {}, | |
|
633 | "outputs": [], | |
|
634 | "prompt_number": 19 | |
|
635 | }, | |
|
636 | { | |
|
637 | "cell_type": "markdown", | |
|
638 | "metadata": {}, | |
|
639 | "source": [ | |
|
640 | "The widget is a `ContainerWidget`, which is a container for other widgets." | |
|
641 | ] | |
|
642 | }, | |
|
643 | { | |
|
644 | "cell_type": "code", | |
|
645 | "collapsed": false, | |
|
646 | "input": [ | |
|
647 | "type(w)" | |
|
648 | ], | |
|
649 | "language": "python", | |
|
650 | "metadata": {}, | |
|
651 | "outputs": [ | |
|
652 | { | |
|
653 | "metadata": {}, | |
|
654 | "output_type": "pyout", | |
|
655 | "prompt_number": 20, | |
|
656 | "text": [ | |
|
657 | "IPython.html.widgets.widget_container.ContainerWidget" | |
|
658 | ] | |
|
659 | } | |
|
660 | ], | |
|
661 | "prompt_number": 20 | |
|
662 | }, | |
|
663 | { | |
|
664 | "cell_type": "markdown", | |
|
665 | "metadata": {}, | |
|
666 | "source": [ | |
|
667 | "The children of the `ContainerWidget` are two integer valued sliders produced by the widget abbreviations above." | |
|
668 | ] | |
|
669 | }, | |
|
670 | { | |
|
671 | "cell_type": "code", | |
|
672 | "collapsed": false, | |
|
673 | "input": [ | |
|
674 | "w.children" | |
|
675 | ], | |
|
676 | "language": "python", | |
|
677 | "metadata": {}, | |
|
678 | "outputs": [ | |
|
679 | { | |
|
680 | "metadata": {}, | |
|
681 | "output_type": "pyout", | |
|
682 | "prompt_number": 21, | |
|
683 | "text": [ | |
|
684 | "(<IPython.html.widgets.widget_int.IntSliderWidget at 0x10557ee90>,\n", | |
|
685 | " <IPython.html.widgets.widget_int.IntSliderWidget at 0x10616ebd0>)" | |
|
686 | ] | |
|
687 | } | |
|
688 | ], | |
|
689 | "prompt_number": 21 | |
|
690 | }, | |
|
691 | { | |
|
692 | "cell_type": "markdown", | |
|
693 | "metadata": {}, | |
|
694 | "source": [ | |
|
695 | "To actually display the widgets, you can use IPython's `display` function." | |
|
696 | ] | |
|
697 | }, | |
|
698 | { | |
|
699 | "cell_type": "code", | |
|
700 | "collapsed": false, | |
|
701 | "input": [ | |
|
702 | "from IPython.display import display\n", | |
|
703 | "display(w)" | |
|
704 | ], | |
|
705 | "language": "python", | |
|
706 | "metadata": {}, | |
|
707 | "outputs": [], | |
|
708 | "prompt_number": 22 | |
|
709 | }, | |
|
710 | { | |
|
711 | "cell_type": "markdown", | |
|
712 | "metadata": {}, | |
|
713 | "source": [ | |
|
714 | "At this point, the UI controls work just like they would if `interact` had been used. You can manipulate them interactively and the function will be called. However, the widget instance returned by `interactive` also give you access to the current keyword arguments and return value of the underlying Python function.\n", | |
|
715 | "\n", | |
|
716 | "Here are the current keyword arguments. If you rerun this cell after manipulating the sliders, the values will have changed." | |
|
717 | ] | |
|
718 | }, | |
|
719 | { | |
|
720 | "cell_type": "code", | |
|
721 | "collapsed": false, | |
|
722 | "input": [ | |
|
723 | "w.kwargs" | |
|
724 | ], | |
|
725 | "language": "python", | |
|
726 | "metadata": {}, | |
|
727 | "outputs": [ | |
|
728 | { | |
|
729 | "metadata": {}, | |
|
730 | "output_type": "pyout", | |
|
731 | "prompt_number": 23, | |
|
732 | "text": [ | |
|
733 | "{u'a': 10, u'b': 20}" | |
|
734 | ] | |
|
735 | } | |
|
736 | ], | |
|
737 | "prompt_number": 23 | |
|
738 | }, | |
|
739 | { | |
|
740 | "cell_type": "markdown", | |
|
741 | "metadata": {}, | |
|
742 | "source": [ | |
|
743 | "Here is the current return value of the function." | |
|
744 | ] | |
|
745 | }, | |
|
746 | { | |
|
747 | "cell_type": "code", | |
|
748 | "collapsed": false, | |
|
749 | "input": [ | |
|
750 | "w.result" | |
|
751 | ], | |
|
752 | "language": "python", | |
|
753 | "metadata": {}, | |
|
754 | "outputs": [ | |
|
755 | { | |
|
756 | "metadata": {}, | |
|
757 | "output_type": "pyout", | |
|
758 | "prompt_number": 24, | |
|
759 | "text": [ | |
|
760 | "30" | |
|
761 | ] | |
|
762 | } | |
|
763 | ], | |
|
764 | "prompt_number": 24 | |
|
165 | 765 | } |
|
166 | 766 | ], |
|
167 | 767 | "metadata": {} |
|
168 | 768 | } |
|
169 | 769 | ] |
|
170 | 770 | } No newline at end of file |
General Comments 0
You need to be logged in to leave comments.
Login now