Show More
@@ -1,7 +1,7 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """Tools for coloring text in ANSI terminals. |
|
3 | 3 | |
|
4 |
$Id: ColorANSI.py |
|
|
4 | $Id: ColorANSI.py 2152 2007-03-18 20:13:35Z fperez $""" | |
|
5 | 5 | |
|
6 | 6 | #***************************************************************************** |
|
7 | 7 | # Copyright (C) 2002-2006 Fernando Perez. <fperez@colorado.edu> |
@@ -79,8 +79,14 b' class InputTermColors:' | |||
|
79 | 79 | This class should be used as a mixin for building color schemes.""" |
|
80 | 80 | |
|
81 | 81 | NoColor = '' # for color schemes in color-less terminals. |
|
82 | Normal = '\001\033[0m\002' # Reset normal coloring | |
|
83 | _base = '\001\033[%sm\002' # Template for all other colors | |
|
82 | ||
|
83 | if os.name == 'nt' and os.environ.get('TERM','dumb') != 'emacs': | |
|
84 | # (X)emacs on W32 gets confused with \001 and \002 so we remove them | |
|
85 | Normal = '\033[0m' # Reset normal coloring | |
|
86 | _base = '\033[%sm' # Template for all other colors | |
|
87 | else: | |
|
88 | Normal = '\001\033[0m\002' # Reset normal coloring | |
|
89 | _base = '\001\033[%sm\002' # Template for all other colors | |
|
84 | 90 | |
|
85 | 91 | # Build the actual color table as a set of class attributes: |
|
86 | 92 | make_color_table(InputTermColors) |
@@ -5,7 +5,7 b' General purpose utilities.' | |||
|
5 | 5 | This is a grab-bag of stuff I find useful in most programs I write. Some of |
|
6 | 6 | these things are also convenient when working at the command line. |
|
7 | 7 | |
|
8 |
$Id: genutils.py 21 |
|
|
8 | $Id: genutils.py 2152 2007-03-18 20:13:35Z fperez $""" | |
|
9 | 9 | |
|
10 | 10 | #***************************************************************************** |
|
11 | 11 | # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu> |
@@ -1247,7 +1247,8 b' def get_pager_start(pager,start):' | |||
|
1247 | 1247 | return start_string |
|
1248 | 1248 | |
|
1249 | 1249 | #---------------------------------------------------------------------------- |
|
1250 | if os.name == "nt": | |
|
1250 | # (X)emacs on W32 doesn't like to be bypassed with msvcrt.getch() | |
|
1251 | if os.name == 'nt' and os.environ.get('TERM','dumb') != 'emacs': | |
|
1251 | 1252 | import msvcrt |
|
1252 | 1253 | def page_more(): |
|
1253 | 1254 | """ Smart pausing between pages |
@@ -6,7 +6,7 b'' | |||
|
6 | 6 | # the file COPYING, distributed as part of this software. |
|
7 | 7 | #***************************************************************************** |
|
8 | 8 | |
|
9 |
# $Id: usage.py 2 |
|
|
9 | # $Id: usage.py 2152 2007-03-18 20:13:35Z fperez $ | |
|
10 | 10 | |
|
11 | 11 | from IPython import Release |
|
12 | 12 | __author__ = '%s <%s>' % Release.authors['Fernando'] |
@@ -53,19 +53,19 b' SPECIAL THREADING OPTIONS' | |||
|
53 | 53 | ization of ipython itself, before the normal option-handling mechanism |
|
54 | 54 | is active. |
|
55 | 55 | |
|
56 | -gthread, -qthread, -wthread, -pylab | |
|
56 | -gthread, -qthread, -q4thread, -wthread, -pylab | |
|
57 | 57 | |
|
58 | 58 | Only ONE of these can be given, and it can only be given as the |
|
59 | 59 | first option passed to IPython (it will have no effect in any |
|
60 | 60 | other position). They provide threading support for the GTK, QT |
|
61 | 61 | and WXWidgets toolkits, and for the matplotlib library. |
|
62 | 62 | |
|
63 |
With any of the first |
|
|
63 | With any of the first four options, IPython starts running a | |
|
64 | 64 | separate thread for the graphical toolkit's operation, so that |
|
65 | 65 | you can open and control graphical elements from within an |
|
66 |
IPython command line, without blocking. All |
|
|
67 |
essentially the same functionality, respectively for GTK, QT |
|
|
68 | WXWidgets (via their Python interfaces). | |
|
66 | IPython command line, without blocking. All four provide | |
|
67 | essentially the same functionality, respectively for GTK, QT3, | |
|
68 | QT4 and WXWidgets (via their Python interfaces). | |
|
69 | 69 | |
|
70 | 70 | Note that with -wthread, you can additionally use the -wxversion |
|
71 | 71 | option to request a specific version of wx to be used. This |
@@ -81,14 +81,14 b' SPECIAL THREADING OPTIONS' | |||
|
81 | 81 | execute (without blocking) any matplotlib-based script which |
|
82 | 82 | calls show() at the end. |
|
83 | 83 | |
|
84 | -tk The -g/q/wthread options, and -pylab (if matplotlib is | |
|
84 | -tk The -g/q/q4/wthread options, and -pylab (if matplotlib is | |
|
85 | 85 | configured to use GTK, QT or WX), will normally block Tk |
|
86 | 86 | graphical interfaces. This means that when GTK, QT or WX |
|
87 | 87 | threading is active, any attempt to open a Tk GUI will result in |
|
88 | 88 | a dead window, and possibly cause the Python interpreter to |
|
89 | 89 | crash. An extra option, -tk, is available to address this |
|
90 | 90 | issue. It can ONLY be given as a SECOND option after any of the |
|
91 | above (-gthread, -qthread, -wthread or -pylab). | |
|
91 | above (-gthread, -qthread, q4thread, -wthread or -pylab). | |
|
92 | 92 | |
|
93 | 93 | If -tk is given, IPython will try to coordinate Tk threading |
|
94 | 94 | with GTK, QT or WX. This is however potentially unreliable, and |
@@ -1,3 +1,8 b'' | |||
|
1 | 2007-03-18 Fernando Perez <Fernando.Perez@colorado.edu> | |
|
2 | ||
|
3 | * IPython/ColorANSI.py (InputTermColors.Normal): applied Nicolas | |
|
4 | Pernetty's patch to improve support for (X)Emacs under Win32. | |
|
5 | ||
|
1 | 6 | 2007-03-17 Fernando Perez <Fernando.Perez@colorado.edu> |
|
2 | 7 | |
|
3 | 8 | * IPython/Shell.py (hijack_wx): ipmort WX with current semantics |
@@ -36,18 +36,18 b' The following special options are ONLY valid at the beginning of the command' | |||
|
36 | 36 | line, and not later. This is because they control the initialization of |
|
37 | 37 | ipython itself, before the normal option-handling mechanism is active. |
|
38 | 38 | .TP |
|
39 | .B \-gthread, \-qthread, \-wthread, \-pylab | |
|
39 | .B \-gthread, \-qthread, \-q4thread, \-wthread, \-pylab | |
|
40 | 40 | Only ONE of these can be given, and it can only be given as the first option |
|
41 | passed to IPython (it will have no effect in any other position). They | |
|
42 |
|
|
|
41 | passed to IPython (it will have no effect in any other position). They provide | |
|
42 | threading support for the GTK, QT3, QT4 and WXWidgets toolkits, and for the | |
|
43 | 43 | matplotlib library. |
|
44 | 44 | .br |
|
45 | 45 | .sp 1 |
|
46 |
With any of the first |
|
|
46 | With any of the first four options, IPython starts running a separate thread | |
|
47 | 47 | for the graphical toolkit's operation, so that you can open and control |
|
48 | 48 | graphical elements from within an IPython command line, without blocking. All |
|
49 |
|
|
|
50 | WXWidgets (via their Python interfaces). | |
|
49 | four provide essentially the same functionality, respectively for GTK, QT3, QT4 | |
|
50 | and WXWidgets (via their Python interfaces). | |
|
51 | 51 | .br |
|
52 | 52 | .sp 1 |
|
53 | 53 | Note that with \-wthread, you can additionally use the \-wxversion option to |
@@ -64,7 +64,7 b' backend requires it. It also modifies the %run command to correctly execute' | |||
|
64 | 64 | (without blocking) any matplotlib-based script which calls show() at the end. |
|
65 | 65 | .TP |
|
66 | 66 | .B \-tk |
|
67 | The \-g/q/wthread options, and \-pylab (if matplotlib is configured to use | |
|
67 | The \-g/q/q4/wthread options, and \-pylab (if matplotlib is configured to use | |
|
68 | 68 | GTK, QT or WX), will normally block Tk graphical interfaces. This means that |
|
69 | 69 | when GTK, QT or WX threading is active, any attempt to open a Tk GUI will |
|
70 | 70 | result in a dead window, and possibly cause the Python interpreter to crash. |
This diff has been collapsed as it changes many lines, (8815 lines changed) Show them Hide them | |||
@@ -1,5 +1,7 b'' | |||
|
1 | #LyX 1.3 created this file. For more info see http://www.lyx.org/ | |
|
2 |
\lyxformat 2 |
|
|
1 | #LyX 1.4.3 created this file. For more info see http://www.lyx.org/ | |
|
2 | \lyxformat 245 | |
|
3 | \begin_document | |
|
4 | \begin_header | |
|
3 | 5 | \textclass article |
|
4 | 6 | \begin_preamble |
|
5 | 7 | %\usepackage{ae,aecompl} |
@@ -50,13 +52,12 b'' | |||
|
50 | 52 | \fontscheme palatino |
|
51 | 53 | \graphics default |
|
52 | 54 | \paperfontsize 11 |
|
53 |
\spacing single |
|
|
54 |
\papersize |
|
|
55 | \paperpackage a4 | |
|
56 |
\use_ |
|
|
57 | \use_amsmath 0 | |
|
58 | \use_natbib 0 | |
|
59 | \use_numerical_citations 0 | |
|
55 | \spacing single | |
|
56 | \papersize default | |
|
57 | \use_geometry true | |
|
58 | \use_amsmath 1 | |
|
59 | \cite_engine basic | |
|
60 | \use_bibtopic false | |
|
60 | 61 | \paperorientation portrait |
|
61 | 62 | \leftmargin 1in |
|
62 | 63 | \topmargin 1in |
@@ -67,97 +68,121 b'' | |||
|
67 | 68 | \paragraph_separation skip |
|
68 | 69 | \defskip medskip |
|
69 | 70 | \quotes_language english |
|
70 | \quotes_times 2 | |
|
71 | 71 | \papercolumns 1 |
|
72 | 72 | \papersides 2 |
|
73 | 73 | \paperpagestyle fancy |
|
74 | \tracking_changes false | |
|
75 | \output_changes true | |
|
76 | \end_header | |
|
74 | 77 | |
|
75 | \layout Title | |
|
78 | \begin_body | |
|
76 | 79 | |
|
80 | \begin_layout Title | |
|
77 | 81 | IPython |
|
78 |
\newline |
|
|
82 | \newline | |
|
79 | 83 | |
|
80 |
\size larger |
|
|
84 | \size larger | |
|
81 | 85 | An enhanced Interactive Python |
|
82 |
\size large |
|
|
86 | \size large | |
|
83 | 87 | |
|
84 |
\newline |
|
|
88 | \newline | |
|
85 | 89 | User Manual, v. |
|
86 | 90 | __version__ |
|
87 | \layout Author | |
|
91 | \end_layout | |
|
88 | 92 | |
|
93 | \begin_layout Author | |
|
89 | 94 | Fernando P�rez |
|
90 | 95 | \begin_inset Foot |
|
91 |
collapsed |
|
|
96 | status collapsed | |
|
92 | 97 | |
|
93 | \layout Standard | |
|
98 | \begin_layout Standard | |
|
94 | 99 | |
|
95 | ||
|
96 | \size scriptsize | |
|
100 | \size scriptsize | |
|
97 | 101 | Department of Applied Mathematics, University of Colorado at Boulder. |
|
98 | 102 | |
|
99 |
\family typewriter |
|
|
103 | \family typewriter | |
|
100 | 104 | <Fernando.Perez@colorado.edu> |
|
101 | \end_inset | |
|
105 | \end_layout | |
|
102 | 106 | |
|
107 | \end_inset | |
|
103 | 108 | |
|
104 | \layout Standard | |
|
105 | 109 | |
|
110 | \end_layout | |
|
106 | 111 | |
|
112 | \begin_layout Standard | |
|
107 | 113 | \begin_inset ERT |
|
108 |
status |
|
|
114 | status collapsed | |
|
115 | ||
|
116 | \begin_layout Standard | |
|
109 | 117 | |
|
110 | \layout Standard | |
|
111 | 118 | |
|
112 |
\backslash |
|
|
119 | \backslash | |
|
113 | 120 | latex{ |
|
114 | \end_inset | |
|
121 | \end_layout | |
|
122 | ||
|
123 | \end_inset | |
|
115 | 124 | |
|
116 | 125 | |
|
117 | 126 | \begin_inset LatexCommand \tableofcontents{} |
|
118 | 127 | |
|
119 |
\end_inset |
|
|
128 | \end_inset | |
|
120 | 129 | |
|
121 | 130 | |
|
122 | 131 | \begin_inset ERT |
|
123 |
status |
|
|
132 | status collapsed | |
|
133 | ||
|
134 | \begin_layout Standard | |
|
124 | 135 | |
|
125 | \layout Standard | |
|
126 | 136 | } |
|
127 | \end_inset | |
|
137 | \end_layout | |
|
128 | 138 | |
|
139 | \end_inset | |
|
129 | 140 | |
|
130 | \layout Standard | |
|
131 | 141 | |
|
142 | \end_layout | |
|
132 | 143 | |
|
144 | \begin_layout Standard | |
|
133 | 145 | \begin_inset ERT |
|
134 |
status |
|
|
146 | status open | |
|
135 | 147 | |
|
136 | \layout Standard | |
|
148 | \begin_layout Standard | |
|
137 | 149 | |
|
138 | \backslash | |
|
150 | ||
|
151 | \backslash | |
|
139 | 152 | html{ |
|
140 |
\backslash |
|
|
153 | \backslash | |
|
141 | 154 | bodytext{bgcolor=#ffffff}} |
|
142 | \end_inset | |
|
155 | \end_layout | |
|
156 | ||
|
157 | \end_inset | |
|
158 | ||
|
143 | 159 | |
|
160 | \end_layout | |
|
144 | 161 | |
|
145 |
\layout S |
|
|
146 | \pagebreak_top | |
|
162 | \begin_layout Standard | |
|
163 | ||
|
164 | \newpage | |
|
165 | ||
|
166 | \end_layout | |
|
167 | ||
|
168 | \begin_layout Section | |
|
147 | 169 | Overview |
|
148 | \layout Standard | |
|
170 | \end_layout | |
|
149 | 171 | |
|
172 | \begin_layout Standard | |
|
150 | 173 | One of Python's most useful features is its interactive interpreter. |
|
151 | 174 | This system allows very fast testing of ideas without the overhead of creating |
|
152 | 175 | test files as is typical in most programming languages. |
|
153 | 176 | However, the interpreter supplied with the standard Python distribution |
|
154 | 177 | is somewhat limited for extended interactive use. |
|
155 | \layout Standard | |
|
178 | \end_layout | |
|
156 | 179 | |
|
180 | \begin_layout Standard | |
|
157 | 181 | IPython is a free software project (released under the BSD license) which |
|
158 | 182 | tries to: |
|
159 | \layout Enumerate | |
|
183 | \end_layout | |
|
160 | 184 | |
|
185 | \begin_layout Enumerate | |
|
161 | 186 | Provide an interactive shell superior to Python's default. |
|
162 | 187 | IPython has many features for object introspection, system shell access, |
|
163 | 188 | and its own special command system for adding functionality when working |
@@ -165,388 +190,425 b" Provide an interactive shell superior to Python's default." | |||
|
165 | 190 | It tries to be a very efficient environment both for Python code development |
|
166 | 191 | and for exploration of problems using Python objects (in situations like |
|
167 | 192 | data analysis). |
|
168 | \layout Enumerate | |
|
193 | \end_layout | |
|
169 | 194 | |
|
195 | \begin_layout Enumerate | |
|
170 | 196 | Serve as an embeddable, ready to use interpreter for your own programs. |
|
171 | 197 | IPython can be started with a single call from inside another program, |
|
172 | 198 | providing access to the current namespace. |
|
173 | 199 | This can be very useful both for debugging purposes and for situations |
|
174 | 200 | where a blend of batch-processing and interactive exploration are needed. |
|
175 | \layout Enumerate | |
|
201 | \end_layout | |
|
176 | 202 | |
|
203 | \begin_layout Enumerate | |
|
177 | 204 | Offer a flexible framework which can be used as the base environment for |
|
178 | 205 | other systems with Python as the underlying language. |
|
179 | 206 | Specifically scientific environments like Mathematica, IDL and Matlab inspired |
|
180 | 207 | its design, but similar ideas can be useful in many fields. |
|
181 | \layout Enumerate | |
|
208 | \end_layout | |
|
182 | 209 | |
|
210 | \begin_layout Enumerate | |
|
183 | 211 | Allow interactive testing of threaded graphical toolkits. |
|
184 | 212 | IPython has support for interactive, non-blocking control of GTK, Qt and |
|
185 | 213 | WX applications via special threading flags. |
|
186 | 214 | The normal Python shell can only do this for Tkinter applications. |
|
187 | \layout Subsection | |
|
215 | \end_layout | |
|
188 | 216 | |
|
217 | \begin_layout Subsection | |
|
189 | 218 | Main features |
|
190 | \layout Itemize | |
|
219 | \end_layout | |
|
191 | 220 | |
|
221 | \begin_layout Itemize | |
|
192 | 222 | Dynamic object introspection. |
|
193 | 223 | One can access docstrings, function definition prototypes, source code, |
|
194 | 224 | source files and other details of any object accessible to the interpreter |
|
195 | 225 | with a single keystroke (` |
|
196 |
\family typewriter |
|
|
226 | \family typewriter | |
|
197 | 227 | ? |
|
198 |
\family default |
|
|
228 | \family default | |
|
199 | 229 | ', and using ` |
|
200 |
\family typewriter |
|
|
230 | \family typewriter | |
|
201 | 231 | ?? |
|
202 |
\family default |
|
|
232 | \family default | |
|
203 | 233 | ' provides additional detail). |
|
204 | \layout Itemize | |
|
234 | \end_layout | |
|
205 | 235 | |
|
236 | \begin_layout Itemize | |
|
206 | 237 | Searching through modules and namespaces with ` |
|
207 |
\family typewriter |
|
|
238 | \family typewriter | |
|
208 | 239 | * |
|
209 |
\family default |
|
|
240 | \family default | |
|
210 | 241 | ' wildcards, both when using the ` |
|
211 |
\family typewriter |
|
|
242 | \family typewriter | |
|
212 | 243 | ? |
|
213 |
\family default |
|
|
244 | \family default | |
|
214 | 245 | ' system and via the |
|
215 |
\family typewriter |
|
|
246 | \family typewriter | |
|
216 | 247 | %psearch |
|
217 |
\family default |
|
|
248 | \family default | |
|
218 | 249 | command. |
|
219 | \layout Itemize | |
|
250 | \end_layout | |
|
220 | 251 | |
|
252 | \begin_layout Itemize | |
|
221 | 253 | Completion in the local namespace, by typing TAB at the prompt. |
|
222 | 254 | This works for keywords, methods, variables and files in the current directory. |
|
223 | 255 | This is supported via the readline library, and full access to configuring |
|
224 | 256 | readline's behavior is provided. |
|
225 | \layout Itemize | |
|
257 | \end_layout | |
|
226 | 258 | |
|
259 | \begin_layout Itemize | |
|
227 | 260 | Numbered input/output prompts with command history (persistent across sessions |
|
228 | 261 | and tied to each profile), full searching in this history and caching of |
|
229 | 262 | all input and output. |
|
230 | \layout Itemize | |
|
263 | \end_layout | |
|
231 | 264 | |
|
265 | \begin_layout Itemize | |
|
232 | 266 | User-extensible `magic' commands. |
|
233 | 267 | A set of commands prefixed with |
|
234 |
\family typewriter |
|
|
268 | \family typewriter | |
|
235 | 269 | % |
|
236 |
\family default |
|
|
270 | \family default | |
|
237 | 271 | is available for controlling IPython itself and provides directory control, |
|
238 | 272 | namespace information and many aliases to common system shell commands. |
|
239 | \layout Itemize | |
|
273 | \end_layout | |
|
240 | 274 | |
|
275 | \begin_layout Itemize | |
|
241 | 276 | Alias facility for defining your own system aliases. |
|
242 | \layout Itemize | |
|
277 | \end_layout | |
|
243 | 278 | |
|
279 | \begin_layout Itemize | |
|
244 | 280 | Complete system shell access. |
|
245 | 281 | Lines starting with ! are passed directly to the system shell, and using |
|
246 | 282 | !! captures shell output into python variables for further use. |
|
247 | \layout Itemize | |
|
283 | \end_layout | |
|
248 | 284 | |
|
285 | \begin_layout Itemize | |
|
249 | 286 | Background execution of Python commands in a separate thread. |
|
250 | 287 | IPython has an internal job manager called |
|
251 |
\family typewriter |
|
|
288 | \family typewriter | |
|
252 | 289 | jobs |
|
253 |
\family default |
|
|
290 | \family default | |
|
254 | 291 | , and a conveninence backgrounding magic function called |
|
255 |
\family typewriter |
|
|
292 | \family typewriter | |
|
256 | 293 | %bg |
|
257 |
\family default |
|
|
294 | \family default | |
|
258 | 295 | . |
|
259 | \layout Itemize | |
|
296 | \end_layout | |
|
260 | 297 | |
|
298 | \begin_layout Itemize | |
|
261 | 299 | The ability to expand python variables when calling the system shell. |
|
262 | 300 | In a shell command, any python variable prefixed with |
|
263 |
\family typewriter |
|
|
301 | \family typewriter | |
|
264 | 302 | $ |
|
265 |
\family default |
|
|
303 | \family default | |
|
266 | 304 | is expanded. |
|
267 | 305 | A double |
|
268 |
\family typewriter |
|
|
306 | \family typewriter | |
|
269 | 307 | $$ |
|
270 |
\family default |
|
|
308 | \family default | |
|
271 | 309 | allows passing a literal |
|
272 |
\family typewriter |
|
|
310 | \family typewriter | |
|
273 | 311 | $ |
|
274 |
\family default |
|
|
312 | \family default | |
|
275 | 313 | to the shell (for access to shell and environment variables like |
|
276 |
\family typewriter |
|
|
314 | \family typewriter | |
|
277 | 315 | $PATH |
|
278 |
\family default |
|
|
316 | \family default | |
|
279 | 317 | ). |
|
280 | \layout Itemize | |
|
318 | \end_layout | |
|
281 | 319 | |
|
320 | \begin_layout Itemize | |
|
282 | 321 | Filesystem navigation, via a magic |
|
283 |
\family typewriter |
|
|
322 | \family typewriter | |
|
284 | 323 | %cd |
|
285 |
\family default |
|
|
324 | \family default | |
|
286 | 325 | command, along with a persistent bookmark system (using |
|
287 |
\family typewriter |
|
|
326 | \family typewriter | |
|
288 | 327 | %bookmark |
|
289 |
\family default |
|
|
328 | \family default | |
|
290 | 329 | ) for fast access to frequently visited directories. |
|
291 | \layout Itemize | |
|
330 | \end_layout | |
|
292 | 331 | |
|
332 | \begin_layout Itemize | |
|
293 | 333 | A lightweight persistence framework via the |
|
294 |
\family typewriter |
|
|
334 | \family typewriter | |
|
295 | 335 | %store |
|
296 |
\family default |
|
|
336 | \family default | |
|
297 | 337 | command, which allows you to save arbitrary Python variables. |
|
298 | 338 | These get restored automatically when your session restarts. |
|
299 | \layout Itemize | |
|
339 | \end_layout | |
|
300 | 340 | |
|
341 | \begin_layout Itemize | |
|
301 | 342 | Automatic indentation (optional) of code as you type (through the readline |
|
302 | 343 | library). |
|
303 | \layout Itemize | |
|
344 | \end_layout | |
|
304 | 345 | |
|
346 | \begin_layout Itemize | |
|
305 | 347 | Macro system for quickly re-executing multiple lines of previous input with |
|
306 | 348 | a single name. |
|
307 | 349 | Macros can be stored persistently via |
|
308 |
\family typewriter |
|
|
350 | \family typewriter | |
|
309 | 351 | %store |
|
310 |
\family default |
|
|
352 | \family default | |
|
311 | 353 | and edited via |
|
312 |
\family typewriter |
|
|
354 | \family typewriter | |
|
313 | 355 | %edit |
|
314 |
\family default |
|
|
356 | \family default | |
|
315 | 357 | . |
|
316 | 358 | |
|
317 | \layout Itemize | |
|
359 | \end_layout | |
|
318 | 360 | |
|
361 | \begin_layout Itemize | |
|
319 | 362 | Session logging (you can then later use these logs as code in your programs). |
|
320 | 363 | Logs can optionally timestamp all input, and also store session output |
|
321 | 364 | (marked as comments, so the log remains valid Python source code). |
|
322 | \layout Itemize | |
|
365 | \end_layout | |
|
323 | 366 | |
|
367 | \begin_layout Itemize | |
|
324 | 368 | Session restoring: logs can be replayed to restore a previous session to |
|
325 | 369 | the state where you left it. |
|
326 | \layout Itemize | |
|
370 | \end_layout | |
|
327 | 371 | |
|
372 | \begin_layout Itemize | |
|
328 | 373 | Verbose and colored exception traceback printouts. |
|
329 | 374 | Easier to parse visually, and in verbose mode they produce a lot of useful |
|
330 | 375 | debugging information (basically a terminal version of the cgitb module). |
|
331 | \layout Itemize | |
|
376 | \end_layout | |
|
332 | 377 | |
|
378 | \begin_layout Itemize | |
|
333 | 379 | Auto-parentheses: callable objects can be executed without parentheses: |
|
334 | 380 | |
|
335 |
\family typewriter |
|
|
381 | \family typewriter | |
|
336 | 382 | `sin 3' |
|
337 |
\family default |
|
|
383 | \family default | |
|
338 | 384 | is automatically converted to |
|
339 |
\family typewriter |
|
|
385 | \family typewriter | |
|
340 | 386 | `sin(3) |
|
341 |
\family default |
|
|
387 | \family default | |
|
342 | 388 | '. |
|
343 | \layout Itemize | |
|
389 | \end_layout | |
|
344 | 390 | |
|
391 | \begin_layout Itemize | |
|
345 | 392 | Auto-quoting: using ` |
|
346 |
\family typewriter |
|
|
393 | \family typewriter | |
|
347 | 394 | , |
|
348 |
\family default |
|
|
395 | \family default | |
|
349 | 396 | ' or ` |
|
350 |
\family typewriter |
|
|
397 | \family typewriter | |
|
351 | 398 | ; |
|
352 |
\family default |
|
|
399 | \family default | |
|
353 | 400 | ' as the first character forces auto-quoting of the rest of the line: |
|
354 |
\family typewriter |
|
|
355 |
`,my_function a\ |
|
|
401 | \family typewriter | |
|
402 | `,my_function a\InsetSpace ~ | |
|
356 | 403 | b' |
|
357 |
\family default |
|
|
404 | \family default | |
|
358 | 405 | becomes automatically |
|
359 |
\family typewriter |
|
|
406 | \family typewriter | |
|
360 | 407 | `my_function("a","b")' |
|
361 |
\family default |
|
|
408 | \family default | |
|
362 | 409 | , while |
|
363 |
\family typewriter |
|
|
364 |
`;my_function a\ |
|
|
410 | \family typewriter | |
|
411 | `;my_function a\InsetSpace ~ | |
|
365 | 412 | b' |
|
366 |
\family default |
|
|
413 | \family default | |
|
367 | 414 | becomes |
|
368 |
\family typewriter |
|
|
415 | \family typewriter | |
|
369 | 416 | `my_function("a b")' |
|
370 |
\family default |
|
|
417 | \family default | |
|
371 | 418 | . |
|
372 | \layout Itemize | |
|
419 | \end_layout | |
|
373 | 420 | |
|
421 | \begin_layout Itemize | |
|
374 | 422 | Extensible input syntax. |
|
375 | 423 | You can define filters that pre-process user input to simplify input in |
|
376 | 424 | special situations. |
|
377 | 425 | This allows for example pasting multi-line code fragments which start with |
|
378 | 426 | |
|
379 |
\family typewriter |
|
|
427 | \family typewriter | |
|
380 | 428 | `>>>' |
|
381 |
\family default |
|
|
429 | \family default | |
|
382 | 430 | or |
|
383 |
\family typewriter |
|
|
431 | \family typewriter | |
|
384 | 432 | `...' |
|
385 |
\family default |
|
|
433 | \family default | |
|
386 | 434 | such as those from other python sessions or the standard Python documentation. |
|
387 | \layout Itemize | |
|
435 | \end_layout | |
|
388 | 436 | |
|
437 | \begin_layout Itemize | |
|
389 | 438 | Flexible configuration system. |
|
390 | 439 | It uses a configuration file which allows permanent setting of all command-line |
|
391 | 440 | options, module loading, code and file execution. |
|
392 | 441 | The system allows recursive file inclusion, so you can have a base file |
|
393 | 442 | with defaults and layers which load other customizations for particular |
|
394 | 443 | projects. |
|
395 | \layout Itemize | |
|
444 | \end_layout | |
|
396 | 445 | |
|
446 | \begin_layout Itemize | |
|
397 | 447 | Embeddable. |
|
398 | 448 | You can call IPython as a python shell inside your own python programs. |
|
399 | 449 | This can be used both for debugging code or for providing interactive abilities |
|
400 | 450 | to your programs with knowledge about the local namespaces (very useful |
|
401 | 451 | in debugging and data analysis situations). |
|
402 | \layout Itemize | |
|
452 | \end_layout | |
|
403 | 453 | |
|
454 | \begin_layout Itemize | |
|
404 | 455 | Easy debugger access. |
|
405 | 456 | You can set IPython to call up an enhanced version of the Python debugger |
|
406 | 457 | ( |
|
407 |
\family typewriter |
|
|
458 | \family typewriter | |
|
408 | 459 | pdb |
|
409 |
\family default |
|
|
460 | \family default | |
|
410 | 461 | ) every time there is an uncaught exception. |
|
411 | 462 | This drops you inside the code which triggered the exception with all the |
|
412 | 463 | data live and it is possible to navigate the stack to rapidly isolate the |
|
413 | 464 | source of a bug. |
|
414 | 465 | The |
|
415 |
\family typewriter |
|
|
466 | \family typewriter | |
|
416 | 467 | %run |
|
417 |
\family default |
|
|
468 | \family default | |
|
418 | 469 | magic command --with the |
|
419 |
\family typewriter |
|
|
470 | \family typewriter | |
|
420 | 471 | -d |
|
421 |
\family default |
|
|
472 | \family default | |
|
422 | 473 | option-- can run any script under |
|
423 |
\family typewriter |
|
|
474 | \family typewriter | |
|
424 | 475 | pdb |
|
425 |
\family default |
|
|
476 | \family default | |
|
426 | 477 | 's control, automatically setting initial breakpoints for you. |
|
427 | 478 | This version of |
|
428 |
\family typewriter |
|
|
479 | \family typewriter | |
|
429 | 480 | pdb |
|
430 |
\family default |
|
|
481 | \family default | |
|
431 | 482 | has IPython-specific improvements, including tab-completion and traceback |
|
432 | 483 | coloring support. |
|
433 | \layout Itemize | |
|
484 | \end_layout | |
|
434 | 485 | |
|
486 | \begin_layout Itemize | |
|
435 | 487 | Profiler support. |
|
436 | 488 | You can run single statements (similar to |
|
437 |
\family typewriter |
|
|
489 | \family typewriter | |
|
438 | 490 | profile.run() |
|
439 |
\family default |
|
|
491 | \family default | |
|
440 | 492 | ) or complete programs under the profiler's control. |
|
441 | 493 | While this is possible with standard |
|
442 |
\family typewriter |
|
|
494 | \family typewriter | |
|
443 | 495 | cProfile |
|
444 |
\family default |
|
|
496 | \family default | |
|
445 | 497 | or |
|
446 |
\family typewriter |
|
|
498 | \family typewriter | |
|
447 | 499 | profile |
|
448 |
\family default |
|
|
500 | \family default | |
|
449 | 501 | modules, IPython wraps this functionality with magic commands (see |
|
450 |
\family typewriter |
|
|
502 | \family typewriter | |
|
451 | 503 | `%prun' |
|
452 |
\family default |
|
|
504 | \family default | |
|
453 | 505 | and |
|
454 |
\family typewriter |
|
|
506 | \family typewriter | |
|
455 | 507 | `%run -p |
|
456 |
\family default |
|
|
508 | \family default | |
|
457 | 509 | ') convenient for rapid interactive work. |
|
458 | \layout Subsection | |
|
510 | \end_layout | |
|
459 | 511 | |
|
512 | \begin_layout Subsection | |
|
460 | 513 | Portability and Python requirements |
|
461 | \layout Standard | |
|
514 | \end_layout | |
|
462 | 515 | |
|
516 | \begin_layout Standard | |
|
463 | 517 | |
|
464 |
\series bold |
|
|
518 | \series bold | |
|
465 | 519 | Python requirements: |
|
466 |
\series default |
|
|
520 | \series default | |
|
467 | 521 | IPython requires with Python version 2.3 or newer. |
|
468 | 522 | If you are still using Python 2.2 and can not upgrade, the last version |
|
469 | 523 | of IPython which worked with Python 2.2 was 0.6.15, so you will have to use |
|
470 | 524 | that. |
|
471 | \layout Standard | |
|
525 | \end_layout | |
|
472 | 526 | |
|
527 | \begin_layout Standard | |
|
473 | 528 | IPython is developed under |
|
474 |
\series bold |
|
|
529 | \series bold | |
|
475 | 530 | Linux |
|
476 |
\series default |
|
|
531 | \series default | |
|
477 | 532 | , but it should work in any reasonable Unix-type system (tested OK under |
|
478 | 533 | Solaris and the *BSD family, for which a port exists thanks to Dryice Liu). |
|
479 | \layout Standard | |
|
534 | \end_layout | |
|
480 | 535 | |
|
536 | \begin_layout Standard | |
|
481 | 537 | |
|
482 |
\series bold |
|
|
538 | \series bold | |
|
483 | 539 | Mac OS X |
|
484 |
\series default |
|
|
540 | \series default | |
|
485 | 541 | : it works, apparently without any problems (thanks to Jim Boyle at Lawrence |
|
486 | 542 | Livermore for the information). |
|
487 | 543 | Thanks to Andrea Riciputi, Fink support is available. |
|
488 | \layout Standard | |
|
544 | \end_layout | |
|
489 | 545 | |
|
546 | \begin_layout Standard | |
|
490 | 547 | |
|
491 |
\series bold |
|
|
548 | \series bold | |
|
492 | 549 | CygWin |
|
493 |
\series default |
|
|
550 | \series default | |
|
494 | 551 | : it works mostly OK, though some users have reported problems with prompt |
|
495 | 552 | coloring. |
|
496 | 553 | No satisfactory solution to this has been found so far, you may want to |
|
497 | 554 | disable colors permanently in the |
|
498 |
\family typewriter |
|
|
555 | \family typewriter | |
|
499 | 556 | ipythonrc |
|
500 |
\family default |
|
|
557 | \family default | |
|
501 | 558 | configuration file if you experience problems. |
|
502 | 559 | If you have proper color support under cygwin, please post to the IPython |
|
503 | 560 | mailing list so this issue can be resolved for all users. |
|
504 | \layout Standard | |
|
561 | \end_layout | |
|
505 | 562 | |
|
563 | \begin_layout Standard | |
|
506 | 564 | |
|
507 |
\series bold |
|
|
565 | \series bold | |
|
508 | 566 | Windows |
|
509 |
\series default |
|
|
567 | \series default | |
|
510 | 568 | : it works well under Windows XP/2k, and I suspect NT should behave similarly. |
|
511 |
Section\ |
|
|
569 | Section\InsetSpace ~ | |
|
512 | 570 | |
|
513 | 571 | \begin_inset LatexCommand \ref{sub:Under-Windows} |
|
514 | 572 | |
|
515 |
\end_inset |
|
|
573 | \end_inset | |
|
516 | 574 | |
|
517 | 575 | describes installation details for Windows, including some additional tools |
|
518 | 576 | needed on this platform. |
|
519 | \layout Standard | |
|
577 | \end_layout | |
|
520 | 578 | |
|
579 | \begin_layout Standard | |
|
521 | 580 | Windows 9x support is present, and has been reported to work fine (at least |
|
522 | 581 | on WinME). |
|
523 | \layout Standard | |
|
582 | \end_layout | |
|
524 | 583 | |
|
584 | \begin_layout Standard | |
|
525 | 585 | Note, that I have very little access to and experience with Windows development. |
|
526 | 586 | However, an excellent group of Win32 users (led by Ville Vainio), consistently |
|
527 | 587 | contribute bugfixes and platform-specific enhancements, so they more than |
|
528 | 588 | make up for my deficiencies on that front. |
|
529 |
In fact, Win32 users report using IPython as a system shell (see Sec.\ |
|
|
589 | In fact, Win32 users report using IPython as a system shell (see Sec.\InsetSpace ~ | |
|
530 | 590 | |
|
531 | 591 | \begin_inset LatexCommand \ref{sec:IPython-as-shell} |
|
532 | 592 | |
|
533 |
\end_inset |
|
|
593 | \end_inset | |
|
534 | 594 | |
|
535 | 595 | for details), as it offers a level of control and features which the default |
|
536 | 596 | |
|
537 |
\family typewriter |
|
|
597 | \family typewriter | |
|
538 | 598 | cmd.exe |
|
539 |
\family default |
|
|
599 | \family default | |
|
540 | 600 | doesn't provide. |
|
541 | \layout Subsection | |
|
601 | \end_layout | |
|
542 | 602 | |
|
603 | \begin_layout Subsection | |
|
543 | 604 | Location |
|
544 | \layout Standard | |
|
605 | \end_layout | |
|
545 | 606 | |
|
607 | \begin_layout Standard | |
|
546 | 608 | IPython is generously hosted at |
|
547 | 609 | \begin_inset LatexCommand \htmlurl{http://ipython.scipy.org} |
|
548 | 610 | |
|
549 |
\end_inset |
|
|
611 | \end_inset | |
|
550 | 612 | |
|
551 | 613 | by the Enthought, Inc and the SciPy project. |
|
552 | 614 | This site offers downloads, subversion access, mailing lists and a bug |
@@ -554,464 +616,525 b' IPython is generously hosted at' | |||
|
554 | 616 | I am very grateful to Enthought ( |
|
555 | 617 | \begin_inset LatexCommand \htmlurl{http://www.enthought.com} |
|
556 | 618 | |
|
557 |
\end_inset |
|
|
619 | \end_inset | |
|
558 | 620 | |
|
559 | 621 | ) and all of the SciPy team for their contribution. |
|
560 | \layout Section | |
|
561 | ||
|
622 | \end_layout | |
|
562 | 623 | |
|
624 | \begin_layout Section | |
|
563 | 625 | \begin_inset LatexCommand \label{sec:install} |
|
564 | 626 | |
|
565 |
\end_inset |
|
|
627 | \end_inset | |
|
566 | 628 | |
|
567 | 629 | Installation |
|
568 | \layout Subsection | |
|
630 | \end_layout | |
|
569 | 631 | |
|
632 | \begin_layout Subsection | |
|
570 | 633 | Instant instructions |
|
571 | \layout Standard | |
|
634 | \end_layout | |
|
572 | 635 | |
|
636 | \begin_layout Standard | |
|
573 | 637 | If you are of the impatient kind, under Linux/Unix simply untar/unzip the |
|
574 | 638 | download, then install with |
|
575 |
\family typewriter |
|
|
639 | \family typewriter | |
|
576 | 640 | `python setup.py install' |
|
577 |
\family default |
|
|
641 | \family default | |
|
578 | 642 | . |
|
579 | 643 | Under Windows, double-click on the provided |
|
580 |
\family typewriter |
|
|
644 | \family typewriter | |
|
581 | 645 | .exe |
|
582 |
\family default |
|
|
646 | \family default | |
|
583 | 647 | binary installer. |
|
584 | \layout Standard | |
|
648 | \end_layout | |
|
585 | 649 | |
|
650 | \begin_layout Standard | |
|
586 | 651 | Then, take a look at Sections |
|
587 | 652 | \begin_inset LatexCommand \ref{sec:good_config} |
|
588 | 653 | |
|
589 |
\end_inset |
|
|
654 | \end_inset | |
|
590 | 655 | |
|
591 | 656 | for configuring things optimally and |
|
592 | 657 | \begin_inset LatexCommand \ref{sec:quick_tips} |
|
593 | 658 | |
|
594 |
\end_inset |
|
|
659 | \end_inset | |
|
595 | 660 | |
|
596 | 661 | for quick tips on efficient use of IPython. |
|
597 | 662 | You can later refer to the rest of the manual for all the gory details. |
|
598 | \layout Standard | |
|
663 | \end_layout | |
|
599 | 664 | |
|
665 | \begin_layout Standard | |
|
600 | 666 | See the notes in sec. |
|
601 | 667 | |
|
602 | 668 | \begin_inset LatexCommand \ref{sec:upgrade} |
|
603 | 669 | |
|
604 |
\end_inset |
|
|
670 | \end_inset | |
|
605 | 671 | |
|
606 | 672 | for upgrading IPython versions. |
|
607 | \layout Subsection | |
|
673 | \end_layout | |
|
608 | 674 | |
|
675 | \begin_layout Subsection | |
|
609 | 676 | Detailed Unix instructions (Linux, Mac OS X, etc.) |
|
610 | \layout Standard | |
|
677 | \end_layout | |
|
611 | 678 | |
|
679 | \begin_layout Standard | |
|
612 | 680 | For RPM based systems, simply install the supplied package in the usual |
|
613 | 681 | manner. |
|
614 | 682 | If you download the tar archive, the process is: |
|
615 | \layout Enumerate | |
|
683 | \end_layout | |
|
616 | 684 | |
|
685 | \begin_layout Enumerate | |
|
617 | 686 | Unzip/untar the |
|
618 |
\family typewriter |
|
|
687 | \family typewriter | |
|
619 | 688 | ipython-XXX.tar.gz |
|
620 |
\family default |
|
|
689 | \family default | |
|
621 | 690 | file wherever you want ( |
|
622 |
\family typewriter |
|
|
691 | \family typewriter | |
|
623 | 692 | XXX |
|
624 |
\family default |
|
|
693 | \family default | |
|
625 | 694 | is the version number). |
|
626 | 695 | It will make a directory called |
|
627 |
\family typewriter |
|
|
696 | \family typewriter | |
|
628 | 697 | ipython-XXX. |
|
629 | 698 | |
|
630 |
\family default |
|
|
699 | \family default | |
|
631 | 700 | Change into that directory where you will find the files |
|
632 |
\family typewriter |
|
|
701 | \family typewriter | |
|
633 | 702 | README |
|
634 |
\family default |
|
|
703 | \family default | |
|
635 | 704 | and |
|
636 |
\family typewriter |
|
|
705 | \family typewriter | |
|
637 | 706 | setup.py |
|
638 |
\family default |
|
|
707 | \family default | |
|
639 | 708 | . |
|
640 | 709 | |
|
641 |
\family typewriter |
|
|
710 | \family typewriter | |
|
642 | 711 | O |
|
643 |
\family default |
|
|
712 | \family default | |
|
644 | 713 | nce you've completed the installation, you can safely remove this directory. |
|
645 | 714 | |
|
646 | \layout Enumerate | |
|
715 | \end_layout | |
|
647 | 716 | |
|
717 | \begin_layout Enumerate | |
|
648 | 718 | If you are installing over a previous installation of version 0.2.0 or earlier, |
|
649 | 719 | first remove your |
|
650 |
\family typewriter |
|
|
720 | \family typewriter | |
|
651 | 721 | $HOME/.ipython |
|
652 |
\family default |
|
|
722 | \family default | |
|
653 | 723 | directory, since the configuration file format has changed somewhat (the |
|
654 | 724 | '=' were removed from all option specifications). |
|
655 | 725 | Or you can call ipython with the |
|
656 |
\family typewriter |
|
|
726 | \family typewriter | |
|
657 | 727 | -upgrade |
|
658 |
\family default |
|
|
728 | \family default | |
|
659 | 729 | option and it will do this automatically for you. |
|
660 | \layout Enumerate | |
|
730 | \end_layout | |
|
661 | 731 | |
|
732 | \begin_layout Enumerate | |
|
662 | 733 | IPython uses distutils, so you can install it by simply typing at the system |
|
663 | 734 | prompt (don't type the |
|
664 |
\family typewriter |
|
|
735 | \family typewriter | |
|
665 | 736 | $ |
|
666 |
\family default |
|
|
737 | \family default | |
|
667 | 738 | ) |
|
668 |
\newline |
|
|
739 | \newline | |
|
669 | 740 | |
|
670 |
\family typewriter |
|
|
741 | \family typewriter | |
|
671 | 742 | $ python setup.py install |
|
672 |
\family default |
|
|
743 | \family default | |
|
673 | 744 | |
|
674 |
\newline |
|
|
745 | \newline | |
|
675 | 746 | Note that this assumes you have root access to your machine. |
|
676 | 747 | If you don't have root access or don't want IPython to go in the default |
|
677 | 748 | python directories, you'll need to use the |
|
678 | 749 | \begin_inset ERT |
|
679 |
status |
|
|
750 | status collapsed | |
|
751 | ||
|
752 | \begin_layout Standard | |
|
680 | 753 | |
|
681 | \layout Standard | |
|
682 | 754 | |
|
683 |
\backslash |
|
|
755 | \backslash | |
|
684 | 756 | verb|--home| |
|
685 | \end_inset | |
|
757 | \end_layout | |
|
758 | ||
|
759 | \end_inset | |
|
686 | 760 | |
|
687 | 761 | option (or |
|
688 | 762 | \begin_inset ERT |
|
689 |
status |
|
|
763 | status collapsed | |
|
690 | 764 | |
|
691 | \layout Standard | |
|
765 | \begin_layout Standard | |
|
692 | 766 | |
|
693 | \backslash | |
|
767 | ||
|
768 | \backslash | |
|
694 | 769 | verb|--prefix| |
|
695 | \end_inset | |
|
770 | \end_layout | |
|
771 | ||
|
772 | \end_inset | |
|
696 | 773 | |
|
697 | 774 | ). |
|
698 | 775 | For example: |
|
699 |
\newline |
|
|
776 | \newline | |
|
700 | 777 | |
|
701 | 778 | \begin_inset ERT |
|
702 |
status |
|
|
779 | status collapsed | |
|
703 | 780 | |
|
704 | \layout Standard | |
|
781 | \begin_layout Standard | |
|
705 | 782 | |
|
706 | \backslash | |
|
783 | ||
|
784 | \backslash | |
|
707 | 785 | verb|$ python setup.py install --home $HOME/local| |
|
708 | \end_inset | |
|
786 | \end_layout | |
|
787 | ||
|
788 | \end_inset | |
|
709 | 789 | |
|
710 | 790 | |
|
711 |
\newline |
|
|
791 | \newline | |
|
712 | 792 | will install IPython into |
|
713 |
\family typewriter |
|
|
793 | \family typewriter | |
|
714 | 794 | $HOME/local |
|
715 |
\family default |
|
|
795 | \family default | |
|
716 | 796 | and its subdirectories (creating them if necessary). |
|
717 |
\newline |
|
|
797 | \newline | |
|
718 | 798 | You can type |
|
719 |
\newline |
|
|
799 | \newline | |
|
720 | 800 | |
|
721 | 801 | \begin_inset ERT |
|
722 |
status |
|
|
802 | status collapsed | |
|
723 | 803 | |
|
724 | \layout Standard | |
|
804 | \begin_layout Standard | |
|
725 | 805 | |
|
726 | \backslash | |
|
806 | ||
|
807 | \backslash | |
|
727 | 808 | verb|$ python setup.py --help| |
|
728 | \end_inset | |
|
809 | \end_layout | |
|
810 | ||
|
811 | \end_inset | |
|
729 | 812 | |
|
730 | 813 | |
|
731 |
\newline |
|
|
814 | \newline | |
|
732 | 815 | for more details. |
|
733 |
\newline |
|
|
816 | \newline | |
|
734 | 817 | Note that if you change the default location for |
|
735 | 818 | \begin_inset ERT |
|
736 |
status |
|
|
819 | status collapsed | |
|
820 | ||
|
821 | \begin_layout Standard | |
|
737 | 822 | |
|
738 | \layout Standard | |
|
739 | 823 | |
|
740 |
\backslash |
|
|
824 | \backslash | |
|
741 | 825 | verb|--home| |
|
742 | \end_inset | |
|
826 | \end_layout | |
|
827 | ||
|
828 | \end_inset | |
|
743 | 829 | |
|
744 | 830 | at installation, IPython may end up installed at a location which is not |
|
745 | 831 | part of your |
|
746 |
\family typewriter |
|
|
832 | \family typewriter | |
|
747 | 833 | $PYTHONPATH |
|
748 |
\family default |
|
|
834 | \family default | |
|
749 | 835 | environment variable. |
|
750 | 836 | In this case, you'll need to configure this variable to include the actual |
|
751 | 837 | directory where the |
|
752 |
\family typewriter |
|
|
838 | \family typewriter | |
|
753 | 839 | IPython/ |
|
754 |
\family default |
|
|
840 | \family default | |
|
755 | 841 | directory ended (typically the value you give to |
|
756 | 842 | \begin_inset ERT |
|
757 |
status |
|
|
843 | status collapsed | |
|
844 | ||
|
845 | \begin_layout Standard | |
|
758 | 846 | |
|
759 | \layout Standard | |
|
760 | 847 | |
|
761 |
\backslash |
|
|
848 | \backslash | |
|
762 | 849 | verb|--home| |
|
763 | \end_inset | |
|
850 | \end_layout | |
|
851 | ||
|
852 | \end_inset | |
|
764 | 853 | |
|
765 | 854 | plus |
|
766 |
\family typewriter |
|
|
855 | \family typewriter | |
|
767 | 856 | /lib/python |
|
768 |
\family default |
|
|
857 | \family default | |
|
769 | 858 | ). |
|
770 | \layout Subsubsection | |
|
859 | \end_layout | |
|
771 | 860 | |
|
861 | \begin_layout Subsubsection | |
|
772 | 862 | Mac OSX information |
|
773 | \layout Standard | |
|
863 | \end_layout | |
|
774 | 864 | |
|
865 | \begin_layout Standard | |
|
775 | 866 | Under OSX, there is a choice you need to make. |
|
776 | 867 | Apple ships its own build of Python, which lives in the core OSX filesystem |
|
777 | 868 | hierarchy. |
|
778 | 869 | You can also manually install a separate Python, either purely by hand |
|
779 | 870 | (typically in |
|
780 |
\family typewriter |
|
|
871 | \family typewriter | |
|
781 | 872 | /usr/local |
|
782 |
\family default |
|
|
873 | \family default | |
|
783 | 874 | ) or by using Fink, which puts everything under |
|
784 |
\family typewriter |
|
|
875 | \family typewriter | |
|
785 | 876 | /sw |
|
786 |
\family default |
|
|
877 | \family default | |
|
787 | 878 | . |
|
788 | 879 | Which route to follow is a matter of personal preference, as I've seen |
|
789 | 880 | users who favor each of the approaches. |
|
790 | 881 | Here I will simply list the known installation issues under OSX, along |
|
791 | 882 | with their solutions. |
|
792 | \layout Standard | |
|
883 | \end_layout | |
|
793 | 884 | |
|
885 | \begin_layout Standard | |
|
794 | 886 | This page: |
|
795 | 887 | \begin_inset LatexCommand \htmlurl{http://geosci.uchicago.edu/~tobis/pylab.html} |
|
796 | 888 | |
|
797 |
\end_inset |
|
|
889 | \end_inset | |
|
798 | 890 | |
|
799 | 891 | contains information on this topic, with additional details on how to make |
|
800 | 892 | IPython and matplotlib play nicely under OSX. |
|
801 | \layout Subsubsection* | |
|
893 | \end_layout | |
|
802 | 894 | |
|
895 | \begin_layout Subsubsection* | |
|
803 | 896 | GUI problems |
|
804 | \layout Standard | |
|
897 | \end_layout | |
|
805 | 898 | |
|
899 | \begin_layout Standard | |
|
806 | 900 | The following instructions apply to an install of IPython under OSX from |
|
807 | 901 | unpacking the |
|
808 |
\family typewriter |
|
|
902 | \family typewriter | |
|
809 | 903 | .tar.gz |
|
810 |
\family default |
|
|
904 | \family default | |
|
811 | 905 | distribution and installing it for the default Python interpreter shipped |
|
812 | 906 | by Apple. |
|
813 | 907 | If you are using a fink install, fink will take care of these details for |
|
814 | 908 | you, by installing IPython against fink's Python. |
|
815 | \layout Standard | |
|
909 | \end_layout | |
|
816 | 910 | |
|
911 | \begin_layout Standard | |
|
817 | 912 | IPython offers various forms of support for interacting with graphical applicati |
|
818 | 913 | ons from the command line, from simple Tk apps (which are in principle always |
|
819 | 914 | supported by Python) to interactive control of WX, Qt and GTK apps. |
|
820 | 915 | Under OSX, however, this requires that ipython is installed by calling |
|
821 | 916 | the special |
|
822 |
\family typewriter |
|
|
917 | \family typewriter | |
|
823 | 918 | pythonw |
|
824 |
\family default |
|
|
919 | \family default | |
|
825 | 920 | script at installation time, which takes care of coordinating things with |
|
826 | 921 | Apple's graphical environment. |
|
827 | \layout Standard | |
|
922 | \end_layout | |
|
828 | 923 | |
|
924 | \begin_layout Standard | |
|
829 | 925 | So when installing under OSX, it is best to use the following command: |
|
830 |
\family typewriter |
|
|
926 | \family typewriter | |
|
831 | 927 | |
|
832 |
\newline |
|
|
928 | \newline | |
|
833 | 929 | |
|
834 |
\family default |
|
|
930 | \family default | |
|
835 | 931 | |
|
836 | 932 | \begin_inset ERT |
|
837 |
status |
|
|
933 | status collapsed | |
|
838 | 934 | |
|
839 | \layout Standard | |
|
935 | \begin_layout Standard | |
|
840 | 936 | |
|
841 | \backslash | |
|
937 | ||
|
938 | \backslash | |
|
842 | 939 | verb| $ sudo pythonw setup.py install --install-scripts=/usr/local/bin| |
|
843 | \end_inset | |
|
940 | \end_layout | |
|
941 | ||
|
942 | \end_inset | |
|
844 | 943 | |
|
845 | 944 | |
|
846 |
\newline |
|
|
945 | \newline | |
|
847 | 946 | or |
|
848 |
\newline |
|
|
947 | \newline | |
|
849 | 948 | |
|
850 | 949 | \begin_inset ERT |
|
851 |
status |
|
|
950 | status collapsed | |
|
951 | ||
|
952 | \begin_layout Standard | |
|
852 | 953 | |
|
853 | \layout Standard | |
|
854 | 954 | |
|
855 |
\backslash |
|
|
955 | \backslash | |
|
856 | 956 | verb| $ sudo pythonw setup.py install --install-scripts=/usr/bin| |
|
857 | \end_inset | |
|
957 | \end_layout | |
|
858 | 958 | |
|
959 | \end_inset | |
|
859 | 960 | |
|
860 | \newline | |
|
961 | ||
|
962 | \newline | |
|
861 | 963 | depending on where you like to keep hand-installed executables. |
|
862 | \layout Standard | |
|
964 | \end_layout | |
|
863 | 965 | |
|
966 | \begin_layout Standard | |
|
864 | 967 | The resulting script will have an appropriate shebang line (the first line |
|
865 | 968 | in the script whic begins with |
|
866 |
\family typewriter |
|
|
969 | \family typewriter | |
|
867 | 970 | #!... |
|
868 |
\family default |
|
|
971 | \family default | |
|
869 | 972 | ) such that the ipython interpreter can interact with the OS X GUI. |
|
870 | 973 | If the installed version does not work and has a shebang line that points |
|
871 | 974 | to, for example, just |
|
872 |
\family typewriter |
|
|
975 | \family typewriter | |
|
873 | 976 | /usr/bin/python |
|
874 |
\family default |
|
|
977 | \family default | |
|
875 | 978 | , then you might have a stale, cached version in your |
|
876 |
\family typewriter |
|
|
979 | \family typewriter | |
|
877 | 980 | build/scripts-<python-version> |
|
878 |
\family default |
|
|
981 | \family default | |
|
879 | 982 | directory. |
|
880 | 983 | Delete that directory and rerun the |
|
881 |
\family typewriter |
|
|
984 | \family typewriter | |
|
882 | 985 | setup.py |
|
883 |
\family default |
|
|
986 | \family default | |
|
884 | 987 | . |
|
885 | 988 | |
|
886 | \layout Standard | |
|
989 | \end_layout | |
|
887 | 990 | |
|
991 | \begin_layout Standard | |
|
888 | 992 | It is also a good idea to use the special flag |
|
889 | 993 | \begin_inset ERT |
|
890 |
status |
|
|
994 | status collapsed | |
|
995 | ||
|
996 | \begin_layout Standard | |
|
891 | 997 | |
|
892 | \layout Standard | |
|
893 | 998 | |
|
894 |
\backslash |
|
|
999 | \backslash | |
|
895 | 1000 | verb|--install-scripts| |
|
896 | \end_inset | |
|
1001 | \end_layout | |
|
1002 | ||
|
1003 | \end_inset | |
|
897 | 1004 | |
|
898 | 1005 | as indicated above, to ensure that the ipython scripts end up in a location |
|
899 | 1006 | which is part of your |
|
900 |
\family typewriter |
|
|
1007 | \family typewriter | |
|
901 | 1008 | $PATH |
|
902 |
\family default |
|
|
1009 | \family default | |
|
903 | 1010 | . |
|
904 | 1011 | Otherwise Apple's Python will put the scripts in an internal directory |
|
905 | 1012 | not available by default at the command line (if you use |
|
906 |
\family typewriter |
|
|
1013 | \family typewriter | |
|
907 | 1014 | /usr/local/bin |
|
908 |
\family default |
|
|
1015 | \family default | |
|
909 | 1016 | , you need to make sure this is in your |
|
910 |
\family typewriter |
|
|
1017 | \family typewriter | |
|
911 | 1018 | $PATH |
|
912 |
\family default |
|
|
1019 | \family default | |
|
913 | 1020 | , which may not be true by default). |
|
914 | \layout Subsubsection* | |
|
1021 | \end_layout | |
|
915 | 1022 | |
|
1023 | \begin_layout Subsubsection* | |
|
916 | 1024 | Readline problems |
|
917 | \layout Standard | |
|
1025 | \end_layout | |
|
918 | 1026 | |
|
1027 | \begin_layout Standard | |
|
919 | 1028 | By default, the Python version shipped by Apple does |
|
920 |
\emph on |
|
|
1029 | \emph on | |
|
921 | 1030 | not |
|
922 |
\emph default |
|
|
1031 | \emph default | |
|
923 | 1032 | include the readline library, so central to IPython's behavior. |
|
924 | 1033 | If you install IPython against Apple's Python, you will not have arrow |
|
925 | 1034 | keys, tab completion, etc. |
|
926 | 1035 | For Mac OSX 10.3 (Panther), you can find a prebuilt readline library here: |
|
927 |
\newline |
|
|
1036 | \newline | |
|
928 | 1037 | |
|
929 | 1038 | \begin_inset LatexCommand \htmlurl{http://pythonmac.org/packages/readline-5.0-py2.3-macosx10.3.zip} |
|
930 | 1039 | |
|
931 |
\end_inset |
|
|
1040 | \end_inset | |
|
932 | 1041 | |
|
933 | 1042 | |
|
934 | \layout Standard | |
|
1043 | \end_layout | |
|
935 | 1044 | |
|
1045 | \begin_layout Standard | |
|
936 | 1046 | If you are using OSX 10.4 (Tiger), after installing this package you need |
|
937 | 1047 | to either: |
|
938 | \layout Enumerate | |
|
1048 | \end_layout | |
|
939 | 1049 | |
|
1050 | \begin_layout Enumerate | |
|
940 | 1051 | move |
|
941 |
\family typewriter |
|
|
1052 | \family typewriter | |
|
942 | 1053 | readline.so |
|
943 |
\family default |
|
|
1054 | \family default | |
|
944 | 1055 | from |
|
945 |
\family typewriter |
|
|
1056 | \family typewriter | |
|
946 | 1057 | /Library/Python/2.3 |
|
947 |
\family default |
|
|
1058 | \family default | |
|
948 | 1059 | to |
|
949 |
\family typewriter |
|
|
1060 | \family typewriter | |
|
950 | 1061 | /Library/Python/2.3/site-packages |
|
951 |
\family default |
|
|
1062 | \family default | |
|
952 | 1063 | , or |
|
953 | \layout Enumerate | |
|
1064 | \end_layout | |
|
954 | 1065 | |
|
1066 | \begin_layout Enumerate | |
|
955 | 1067 | install |
|
956 | 1068 | \begin_inset LatexCommand \htmlurl{http://pythonmac.org/packages/TigerPython23Compat.pkg.zip} |
|
957 | 1069 | |
|
958 |
\end_inset |
|
|
1070 | \end_inset | |
|
959 | 1071 | |
|
960 | 1072 | |
|
961 | \layout Standard | |
|
1073 | \end_layout | |
|
962 | 1074 | |
|
1075 | \begin_layout Standard | |
|
963 | 1076 | Users installing against Fink's Python or a properly hand-built one should |
|
964 | 1077 | not have this problem. |
|
965 | \layout Subsubsection* | |
|
1078 | \end_layout | |
|
966 | 1079 | |
|
1080 | \begin_layout Subsubsection* | |
|
967 | 1081 | DarwinPorts |
|
968 | \layout Standard | |
|
1082 | \end_layout | |
|
969 | 1083 | |
|
1084 | \begin_layout Standard | |
|
970 | 1085 | I report here a message from an OSX user, who suggests an alternative means |
|
971 | 1086 | of using IPython under this operating system with good results. |
|
972 | 1087 | Please let me know of any updates that may be useful for this section. |
|
973 | 1088 | His message is reproduced verbatim below: |
|
974 |
\layout |
|
|
1089 | \end_layout | |
|
975 | 1090 | |
|
1091 | \begin_layout Quote | |
|
976 | 1092 | From: Markus Banfi |
|
977 |
\family typewriter |
|
|
1093 | \family typewriter | |
|
978 | 1094 | <markus.banfi-AT-mospheira.net> |
|
979 |
\layout |
|
|
1095 | \end_layout | |
|
980 | 1096 | |
|
1097 | \begin_layout Quote | |
|
981 | 1098 | As a MacOS X (10.4.2) user I prefer to install software using DawinPorts instead |
|
982 | 1099 | of Fink. |
|
983 | 1100 | I had no problems installing ipython with DarwinPorts. |
|
984 | 1101 | It's just: |
|
985 |
\layout |
|
|
1102 | \end_layout | |
|
986 | 1103 | |
|
1104 | \begin_layout Quote | |
|
987 | 1105 | |
|
988 |
\family typewriter |
|
|
1106 | \family typewriter | |
|
989 | 1107 | sudo port install py-ipython |
|
990 |
\layout |
|
|
1108 | \end_layout | |
|
991 | 1109 | |
|
1110 | \begin_layout Quote | |
|
992 | 1111 | It automatically resolved all dependencies (python24, readline, py-readline). |
|
993 | 1112 | So far I did not encounter any problems with the DarwinPorts port of ipython. |
|
994 | 1113 | |
|
995 | \layout Subsection | |
|
996 | ||
|
1114 | \end_layout | |
|
997 | 1115 | |
|
1116 | \begin_layout Subsection | |
|
998 | 1117 | \begin_inset LatexCommand \label{sub:Under-Windows} |
|
999 | 1118 | |
|
1000 |
\end_inset |
|
|
1119 | \end_inset | |
|
1001 | 1120 | |
|
1002 | 1121 | Windows instructions |
|
1003 | \layout Standard | |
|
1122 | \end_layout | |
|
1004 | 1123 | |
|
1124 | \begin_layout Standard | |
|
1005 | 1125 | Some of IPython's very useful features are: |
|
1006 | \layout Itemize | |
|
1126 | \end_layout | |
|
1007 | 1127 | |
|
1128 | \begin_layout Itemize | |
|
1008 | 1129 | Integrated readline support (Tab-based file, object and attribute completion, |
|
1009 | 1130 | input history across sessions, editable command line, etc.) |
|
1010 | \layout Itemize | |
|
1131 | \end_layout | |
|
1011 | 1132 | |
|
1133 | \begin_layout Itemize | |
|
1012 | 1134 | Coloring of prompts, code and tracebacks. |
|
1013 | \layout Standard | |
|
1135 | \end_layout | |
|
1014 | 1136 | |
|
1137 | \begin_layout Standard | |
|
1015 | 1138 | These, by default, are only available under Unix-like operating systems. |
|
1016 | 1139 | However, thanks to Gary Bishop's work, Windows XP/2k users can also benefit |
|
1017 | 1140 | from them. |
@@ -1019,83 +1142,89 b' These, by default, are only available under Unix-like operating systems.' | |||
|
1019 | 1142 | and color support, so that IPython under Windows XP/2k can be as friendly |
|
1020 | 1143 | and powerful as under Unix-like environments. |
|
1021 | 1144 | |
|
1022 | \layout Standard | |
|
1145 | \end_layout | |
|
1023 | 1146 | |
|
1147 | \begin_layout Standard | |
|
1024 | 1148 | This library, now named |
|
1025 |
\family typewriter |
|
|
1149 | \family typewriter | |
|
1026 | 1150 | PyReadline |
|
1027 |
\family default |
|
|
1151 | \family default | |
|
1028 | 1152 | , has been absorbed by the IPython team (J�rgen Stenarson, in particular), |
|
1029 | 1153 | and it continues to be developed with new features, as well as being distribute |
|
1030 | 1154 | d directly from the IPython site. |
|
1031 | \layout Standard | |
|
1155 | \end_layout | |
|
1032 | 1156 | |
|
1157 | \begin_layout Standard | |
|
1033 | 1158 | The |
|
1034 |
\family typewriter |
|
|
1159 | \family typewriter | |
|
1035 | 1160 | PyReadline |
|
1036 |
\family default |
|
|
1161 | \family default | |
|
1037 | 1162 | extension requires |
|
1038 |
\family typewriter |
|
|
1163 | \family typewriter | |
|
1039 | 1164 | CTypes |
|
1040 |
\family default |
|
|
1165 | \family default | |
|
1041 | 1166 | and the windows IPython installer needs |
|
1042 |
\family typewriter |
|
|
1167 | \family typewriter | |
|
1043 | 1168 | PyWin32 |
|
1044 |
\family default |
|
|
1169 | \family default | |
|
1045 | 1170 | , so in all you need: |
|
1046 | \layout Enumerate | |
|
1171 | \end_layout | |
|
1047 | 1172 | |
|
1173 | \begin_layout Enumerate | |
|
1048 | 1174 | |
|
1049 |
\family typewriter |
|
|
1175 | \family typewriter | |
|
1050 | 1176 | PyWin32 |
|
1051 |
\family default |
|
|
1177 | \family default | |
|
1052 | 1178 | from |
|
1053 | 1179 | \begin_inset LatexCommand \htmlurl{http://starship.python.net/crew/mhammond} |
|
1054 | 1180 | |
|
1055 |
\end_inset |
|
|
1181 | \end_inset | |
|
1056 | 1182 | |
|
1057 | 1183 | . |
|
1058 | \layout Enumerate | |
|
1184 | \end_layout | |
|
1059 | 1185 | |
|
1186 | \begin_layout Enumerate | |
|
1060 | 1187 | |
|
1061 |
\family typewriter |
|
|
1188 | \family typewriter | |
|
1062 | 1189 | CTypes |
|
1063 |
\family default |
|
|
1190 | \family default | |
|
1064 | 1191 | from |
|
1065 | 1192 | \begin_inset LatexCommand \htmlurl{http://starship.python.net/crew/theller/ctypes} |
|
1066 | 1193 | |
|
1067 |
\end_inset |
|
|
1194 | \end_inset | |
|
1068 | 1195 | |
|
1069 | 1196 | (you |
|
1070 |
\emph on |
|
|
1197 | \emph on | |
|
1071 | 1198 | must |
|
1072 |
\emph default |
|
|
1199 | \emph default | |
|
1073 | 1200 | use version 0.9.1 or newer). |
|
1074 | \layout Enumerate | |
|
1201 | \end_layout | |
|
1075 | 1202 | |
|
1203 | \begin_layout Enumerate | |
|
1076 | 1204 | |
|
1077 |
\family typewriter |
|
|
1205 | \family typewriter | |
|
1078 | 1206 | PyReadline |
|
1079 |
\family default |
|
|
1207 | \family default | |
|
1080 | 1208 | for Windows from |
|
1081 | 1209 | \begin_inset LatexCommand \htmlurl{http://projects.scipy.org/ipython/ipython/wiki/PyReadline/Intro} |
|
1082 | 1210 | |
|
1083 |
\end_inset |
|
|
1211 | \end_inset | |
|
1084 | 1212 | |
|
1085 | 1213 | . |
|
1086 | 1214 | That page contains further details on using and configuring the system |
|
1087 | 1215 | to your liking. |
|
1088 | \layout Standard | |
|
1216 | \end_layout | |
|
1089 | 1217 | |
|
1218 | \begin_layout Standard | |
|
1090 | 1219 | |
|
1091 |
\series bold |
|
|
1220 | \series bold | |
|
1092 | 1221 | Warning about a broken readline-like library: |
|
1093 |
\series default |
|
|
1222 | \series default | |
|
1094 | 1223 | several users have reported problems stemming from using the pseudo-readline |
|
1095 | 1224 | library at |
|
1096 | 1225 | \begin_inset LatexCommand \htmlurl{http://newcenturycomputers.net/projects/readline.html} |
|
1097 | 1226 | |
|
1098 |
\end_inset |
|
|
1227 | \end_inset | |
|
1099 | 1228 | |
|
1100 | 1229 | . |
|
1101 | 1230 | This is a broken library which, while called readline, only implements |
@@ -1104,20 +1233,22 b' Warning about a broken readline-like library:' | |||
|
1104 | 1233 | and causes unpredictable crashes later. |
|
1105 | 1234 | If you wish to use IPython under Windows, you must NOT use this library, |
|
1106 | 1235 | which for all purposes is (at least as of version 1.6) terminally broken. |
|
1107 | \layout Subsubsection | |
|
1236 | \end_layout | |
|
1108 | 1237 | |
|
1238 | \begin_layout Subsubsection | |
|
1109 | 1239 | Installation procedure |
|
1110 | \layout Standard | |
|
1240 | \end_layout | |
|
1111 | 1241 | |
|
1242 | \begin_layout Standard | |
|
1112 | 1243 | Once you have the above installed, from the IPython download directory grab |
|
1113 | 1244 | the |
|
1114 |
\family typewriter |
|
|
1245 | \family typewriter | |
|
1115 | 1246 | ipython-XXX.win32.exe |
|
1116 |
\family default |
|
|
1247 | \family default | |
|
1117 | 1248 | file, where |
|
1118 |
\family typewriter |
|
|
1249 | \family typewriter | |
|
1119 | 1250 | XXX |
|
1120 |
\family default |
|
|
1251 | \family default | |
|
1121 | 1252 | represents the version number. |
|
1122 | 1253 | This is a regular windows executable installer, which you can simply double-cli |
|
1123 | 1254 | ck to install. |
@@ -1125,103 +1256,110 b' ck to install.' | |||
|
1125 | 1256 | IPython in the Windows list of applications, so you can later uninstall |
|
1126 | 1257 | it from the Control Panel. |
|
1127 | 1258 | |
|
1128 | \layout Standard | |
|
1259 | \end_layout | |
|
1129 | 1260 | |
|
1261 | \begin_layout Standard | |
|
1130 | 1262 | IPython tries to install the configuration information in a directory named |
|
1131 | 1263 | |
|
1132 |
\family typewriter |
|
|
1264 | \family typewriter | |
|
1133 | 1265 | .ipython |
|
1134 |
\family default |
|
|
1266 | \family default | |
|
1135 | 1267 | ( |
|
1136 |
\family typewriter |
|
|
1268 | \family typewriter | |
|
1137 | 1269 | _ipython |
|
1138 |
\family default |
|
|
1270 | \family default | |
|
1139 | 1271 | under Windows) located in your `home' directory. |
|
1140 | 1272 | IPython sets this directory by looking for a |
|
1141 |
\family typewriter |
|
|
1273 | \family typewriter | |
|
1142 | 1274 | HOME |
|
1143 |
\family default |
|
|
1275 | \family default | |
|
1144 | 1276 | environment variable; if such a variable does not exist, it uses |
|
1145 |
\family typewriter |
|
|
1277 | \family typewriter | |
|
1146 | 1278 | HOMEDRIVE |
|
1147 |
\backslash |
|
|
1279 | \backslash | |
|
1148 | 1280 | HOMEPATH |
|
1149 |
\family default |
|
|
1281 | \family default | |
|
1150 | 1282 | (these are always defined by Windows). |
|
1151 | 1283 | This typically gives something like |
|
1152 |
\family typewriter |
|
|
1284 | \family typewriter | |
|
1153 | 1285 | C: |
|
1154 |
\backslash |
|
|
1286 | \backslash | |
|
1155 | 1287 | Documents and Settings |
|
1156 |
\backslash |
|
|
1288 | \backslash | |
|
1157 | 1289 | YourUserName |
|
1158 |
\family default |
|
|
1290 | \family default | |
|
1159 | 1291 | , but your local details may vary. |
|
1160 | 1292 | In this directory you will find all the files that configure IPython's |
|
1161 | 1293 | defaults, and you can put there your profiles and extensions. |
|
1162 | 1294 | This directory is automatically added by IPython to |
|
1163 |
\family typewriter |
|
|
1295 | \family typewriter | |
|
1164 | 1296 | sys.path |
|
1165 |
\family default |
|
|
1297 | \family default | |
|
1166 | 1298 | , so anything you place there can be found by |
|
1167 |
\family typewriter |
|
|
1299 | \family typewriter | |
|
1168 | 1300 | import |
|
1169 |
\family default |
|
|
1301 | \family default | |
|
1170 | 1302 | statements. |
|
1171 | \layout Paragraph | |
|
1303 | \end_layout | |
|
1172 | 1304 | |
|
1305 | \begin_layout Paragraph | |
|
1173 | 1306 | Upgrading |
|
1174 | \layout Standard | |
|
1307 | \end_layout | |
|
1175 | 1308 | |
|
1309 | \begin_layout Standard | |
|
1176 | 1310 | For an IPython upgrade, you should first uninstall the previous version. |
|
1177 | 1311 | This will ensure that all files and directories (such as the documentation) |
|
1178 | 1312 | which carry embedded version strings in their names are properly removed. |
|
1179 | \layout Paragraph | |
|
1313 | \end_layout | |
|
1180 | 1314 | |
|
1315 | \begin_layout Paragraph | |
|
1181 | 1316 | Manual installation under Win32 |
|
1182 | \layout Standard | |
|
1317 | \end_layout | |
|
1183 | 1318 | |
|
1319 | \begin_layout Standard | |
|
1184 | 1320 | In case the automatic installer does not work for some reason, you can download |
|
1185 | 1321 | the |
|
1186 |
\family typewriter |
|
|
1322 | \family typewriter | |
|
1187 | 1323 | ipython-XXX.tar.gz |
|
1188 |
\family default |
|
|
1324 | \family default | |
|
1189 | 1325 | file, which contains the full IPython source distribution (the popular |
|
1190 | 1326 | WinZip can read |
|
1191 |
\family typewriter |
|
|
1327 | \family typewriter | |
|
1192 | 1328 | .tar.gz |
|
1193 |
\family default |
|
|
1329 | \family default | |
|
1194 | 1330 | files). |
|
1195 | 1331 | After uncompressing the archive, you can install it at a command terminal |
|
1196 | 1332 | just like any other Python module, by using |
|
1197 |
\family typewriter |
|
|
1333 | \family typewriter | |
|
1198 | 1334 | `python setup.py install' |
|
1199 |
\family default |
|
|
1335 | \family default | |
|
1200 | 1336 | . |
|
1201 | 1337 | |
|
1202 | \layout Standard | |
|
1338 | \end_layout | |
|
1203 | 1339 | |
|
1340 | \begin_layout Standard | |
|
1204 | 1341 | After the installation, run the supplied |
|
1205 |
\family typewriter |
|
|
1342 | \family typewriter | |
|
1206 | 1343 | win32_manual_post_install.py |
|
1207 |
\family default |
|
|
1344 | \family default | |
|
1208 | 1345 | script, which creates the necessary Start Menu shortcuts for you. |
|
1209 | \layout Subsection | |
|
1210 | ||
|
1346 | \end_layout | |
|
1211 | 1347 | |
|
1348 | \begin_layout Subsection | |
|
1212 | 1349 | \begin_inset LatexCommand \label{sec:upgrade} |
|
1213 | 1350 | |
|
1214 |
\end_inset |
|
|
1351 | \end_inset | |
|
1215 | 1352 | |
|
1216 | 1353 | Upgrading from a previous version |
|
1217 | \layout Standard | |
|
1354 | \end_layout | |
|
1218 | 1355 | |
|
1356 | \begin_layout Standard | |
|
1219 | 1357 | If you are upgrading from a previous version of IPython, after doing the |
|
1220 | 1358 | routine installation described above, you should call IPython with the |
|
1221 | 1359 | |
|
1222 |
\family typewriter |
|
|
1360 | \family typewriter | |
|
1223 | 1361 | -upgrade |
|
1224 |
\family default |
|
|
1362 | \family default | |
|
1225 | 1363 | option the first time you run your new copy. |
|
1226 | 1364 | This will automatically update your configuration directory while preserving |
|
1227 | 1365 | copies of your old files. |
@@ -1229,78 +1367,85 b' If you are upgrading from a previous version of IPython, after doing the' | |||
|
1229 | 1367 | made into the new files. |
|
1230 | 1368 | It is a good idea to do this as there may be new options available in the |
|
1231 | 1369 | new configuration files which you will not have. |
|
1232 | \layout Standard | |
|
1370 | \end_layout | |
|
1233 | 1371 | |
|
1372 | \begin_layout Standard | |
|
1234 | 1373 | Under Windows, if you don't know how to call python scripts with arguments |
|
1235 | 1374 | from a command line, simply delete the old config directory and IPython |
|
1236 | 1375 | will make a new one. |
|
1237 | 1376 | Win2k and WinXP users will find it in |
|
1238 |
\family typewriter |
|
|
1377 | \family typewriter | |
|
1239 | 1378 | C: |
|
1240 |
\backslash |
|
|
1379 | \backslash | |
|
1241 | 1380 | Documents and Settings |
|
1242 |
\backslash |
|
|
1381 | \backslash | |
|
1243 | 1382 | YourUserName |
|
1244 |
\backslash |
|
|
1383 | \backslash | |
|
1245 | 1384 | _ipython |
|
1246 |
\family default |
|
|
1385 | \family default | |
|
1247 | 1386 | , and Win 9x users under |
|
1248 |
\family typewriter |
|
|
1387 | \family typewriter | |
|
1249 | 1388 | C: |
|
1250 |
\backslash |
|
|
1389 | \backslash | |
|
1251 | 1390 | Program Files |
|
1252 |
\backslash |
|
|
1391 | \backslash | |
|
1253 | 1392 | IPython |
|
1254 |
\backslash |
|
|
1393 | \backslash | |
|
1255 | 1394 | _ipython. |
|
1256 | \layout Section | |
|
1257 | ||
|
1395 | \end_layout | |
|
1258 | 1396 | |
|
1397 | \begin_layout Section | |
|
1259 | 1398 | \begin_inset LatexCommand \label{sec:good_config} |
|
1260 | 1399 | |
|
1261 |
\end_inset |
|
|
1400 | \end_inset | |
|
1262 | 1401 | |
|
1263 | 1402 | |
|
1264 | 1403 | \begin_inset OptArg |
|
1265 |
collapsed |
|
|
1266 | ||
|
1267 | \layout Standard | |
|
1404 | status collapsed | |
|
1268 | 1405 | |
|
1406 | \begin_layout Standard | |
|
1269 | 1407 | Initial configuration |
|
1270 | 1408 | \begin_inset ERT |
|
1271 |
status |
|
|
1409 | status collapsed | |
|
1272 | 1410 | |
|
1273 | \layout Standard | |
|
1411 | \begin_layout Standard | |
|
1274 | 1412 | |
|
1275 | \backslash | |
|
1413 | ||
|
1414 | \backslash | |
|
1276 | 1415 | ldots |
|
1277 | \end_inset | |
|
1416 | \end_layout | |
|
1417 | ||
|
1418 | \end_inset | |
|
1419 | ||
|
1278 | 1420 | |
|
1421 | \end_layout | |
|
1279 | 1422 | |
|
1280 |
\end_inset |
|
|
1423 | \end_inset | |
|
1281 | 1424 | |
|
1282 | 1425 | Initial configuration of your environment |
|
1283 | \layout Standard | |
|
1426 | \end_layout | |
|
1284 | 1427 | |
|
1428 | \begin_layout Standard | |
|
1285 | 1429 | This section will help you set various things in your environment for your |
|
1286 | 1430 | IPython sessions to be as efficient as possible. |
|
1287 | 1431 | All of IPython's configuration information, along with several example |
|
1288 | 1432 | files, is stored in a directory named by default |
|
1289 |
\family typewriter |
|
|
1433 | \family typewriter | |
|
1290 | 1434 | $HOME/.ipython |
|
1291 |
\family default |
|
|
1435 | \family default | |
|
1292 | 1436 | . |
|
1293 | 1437 | You can change this by defining the environment variable |
|
1294 |
\family typewriter |
|
|
1438 | \family typewriter | |
|
1295 | 1439 | IPYTHONDIR |
|
1296 |
\family default |
|
|
1440 | \family default | |
|
1297 | 1441 | , or at runtime with the command line option |
|
1298 |
\family typewriter |
|
|
1442 | \family typewriter | |
|
1299 | 1443 | -ipythondir |
|
1300 |
\family default |
|
|
1444 | \family default | |
|
1301 | 1445 | . |
|
1302 | \layout Standard | |
|
1446 | \end_layout | |
|
1303 | 1447 | |
|
1448 | \begin_layout Standard | |
|
1304 | 1449 | If all goes well, the first time you run IPython it should automatically |
|
1305 | 1450 | create a user copy of the config directory for you, based on its builtin |
|
1306 | 1451 | defaults. |
@@ -1308,18 +1453,18 b' If all goes well, the first time you run IPython it should automatically' | |||
|
1308 | 1453 | system. |
|
1309 | 1454 | The main file you will modify to configure IPython's behavior is called |
|
1310 | 1455 | |
|
1311 |
\family typewriter |
|
|
1456 | \family typewriter | |
|
1312 | 1457 | ipythonrc |
|
1313 |
\family default |
|
|
1458 | \family default | |
|
1314 | 1459 | (with a |
|
1315 |
\family typewriter |
|
|
1460 | \family typewriter | |
|
1316 | 1461 | .ini |
|
1317 |
\family default |
|
|
1462 | \family default | |
|
1318 | 1463 | extension under Windows), included for reference in Sec. |
|
1319 | 1464 | |
|
1320 | 1465 | \begin_inset LatexCommand \ref{sec:ipytonrc-sample} |
|
1321 | 1466 | |
|
1322 |
\end_inset |
|
|
1467 | \end_inset | |
|
1323 | 1468 | |
|
1324 | 1469 | . |
|
1325 | 1470 | This file is very commented and has many variables you can change to suit |
@@ -1327,618 +1472,684 b' ipythonrc' | |||
|
1327 | 1472 | |
|
1328 | 1473 | \begin_inset LatexCommand \ref{sec:customization} |
|
1329 | 1474 | |
|
1330 |
\end_inset |
|
|
1475 | \end_inset | |
|
1331 | 1476 | |
|
1332 | 1477 | . |
|
1333 | 1478 | Here we discuss the basic things you will want to make sure things are |
|
1334 | 1479 | working properly from the beginning. |
|
1335 | \layout Subsection | |
|
1336 | ||
|
1480 | \end_layout | |
|
1337 | 1481 | |
|
1482 | \begin_layout Subsection | |
|
1338 | 1483 | \begin_inset LatexCommand \label{sec:help-access} |
|
1339 | 1484 | |
|
1340 |
\end_inset |
|
|
1485 | \end_inset | |
|
1341 | 1486 | |
|
1342 | 1487 | Access to the Python help system |
|
1343 | \layout Standard | |
|
1488 | \end_layout | |
|
1344 | 1489 | |
|
1490 | \begin_layout Standard | |
|
1345 | 1491 | This is true for Python in general (not just for IPython): you should have |
|
1346 | 1492 | an environment variable called |
|
1347 |
\family typewriter |
|
|
1493 | \family typewriter | |
|
1348 | 1494 | PYTHONDOCS |
|
1349 |
\family default |
|
|
1495 | \family default | |
|
1350 | 1496 | pointing to the directory where your HTML Python documentation lives. |
|
1351 | 1497 | In my system it's |
|
1352 |
\family typewriter |
|
|
1498 | \family typewriter | |
|
1353 | 1499 | /usr/share/doc/python-docs-2.3.4/html |
|
1354 |
\family default |
|
|
1500 | \family default | |
|
1355 | 1501 | , check your local details or ask your systems administrator. |
|
1356 | 1502 | |
|
1357 | \layout Standard | |
|
1503 | \end_layout | |
|
1358 | 1504 | |
|
1505 | \begin_layout Standard | |
|
1359 | 1506 | This is the directory which holds the HTML version of the Python manuals. |
|
1360 | 1507 | Unfortunately it seems that different Linux distributions package these |
|
1361 | 1508 | files differently, so you may have to look around a bit. |
|
1362 | 1509 | Below I show the contents of this directory on my system for reference: |
|
1363 | \layout Standard | |
|
1510 | \end_layout | |
|
1364 | 1511 | |
|
1512 | \begin_layout Standard | |
|
1365 | 1513 | |
|
1366 |
\family typewriter |
|
|
1514 | \family typewriter | |
|
1367 | 1515 | [html]> ls |
|
1368 |
\newline |
|
|
1369 |
about.dat acks.html dist/ ext/ index.html lib/ modindex.html stdabout.dat |
|
|
1370 | about.html api/ doc/ icons/ inst/ mac/ ref/ style.css | |
|
1371 | \layout Standard | |
|
1516 | \newline | |
|
1517 | about.dat acks.html dist/ ext/ index.html lib/ modindex.html stdabout.dat | |
|
1518 | tut/ about.html api/ doc/ icons/ inst/ mac/ ref/ style.css | |
|
1519 | \end_layout | |
|
1372 | 1520 | |
|
1521 | \begin_layout Standard | |
|
1373 | 1522 | You should really make sure this variable is correctly set so that Python's |
|
1374 | 1523 | pydoc-based help system works. |
|
1375 | 1524 | It is a powerful and convenient system with full access to the Python manuals |
|
1376 | 1525 | and all modules accessible to you. |
|
1377 | \layout Standard | |
|
1526 | \end_layout | |
|
1378 | 1527 | |
|
1528 | \begin_layout Standard | |
|
1379 | 1529 | Under Windows it seems that pydoc finds the documentation automatically, |
|
1380 | 1530 | so no extra setup appears necessary. |
|
1381 | \layout Subsection | |
|
1531 | \end_layout | |
|
1382 | 1532 | |
|
1533 | \begin_layout Subsection | |
|
1383 | 1534 | Editor |
|
1384 | \layout Standard | |
|
1535 | \end_layout | |
|
1385 | 1536 | |
|
1537 | \begin_layout Standard | |
|
1386 | 1538 | The |
|
1387 |
\family typewriter |
|
|
1539 | \family typewriter | |
|
1388 | 1540 | %edit |
|
1389 |
\family default |
|
|
1541 | \family default | |
|
1390 | 1542 | command (and its alias |
|
1391 |
\family typewriter |
|
|
1543 | \family typewriter | |
|
1392 | 1544 | %ed |
|
1393 |
\family default |
|
|
1545 | \family default | |
|
1394 | 1546 | ) will invoke the editor set in your environment as |
|
1395 |
\family typewriter |
|
|
1547 | \family typewriter | |
|
1396 | 1548 | EDITOR |
|
1397 |
\family default |
|
|
1549 | \family default | |
|
1398 | 1550 | . |
|
1399 | 1551 | If this variable is not set, it will default to |
|
1400 |
\family typewriter |
|
|
1552 | \family typewriter | |
|
1401 | 1553 | vi |
|
1402 |
\family default |
|
|
1554 | \family default | |
|
1403 | 1555 | under Linux/Unix and to |
|
1404 |
\family typewriter |
|
|
1556 | \family typewriter | |
|
1405 | 1557 | notepad |
|
1406 |
\family default |
|
|
1558 | \family default | |
|
1407 | 1559 | under Windows. |
|
1408 | 1560 | You may want to set this variable properly and to a lightweight editor |
|
1409 | 1561 | which doesn't take too long to start (that is, something other than a new |
|
1410 | 1562 | instance of |
|
1411 |
\family typewriter |
|
|
1563 | \family typewriter | |
|
1412 | 1564 | Emacs |
|
1413 |
\family default |
|
|
1565 | \family default | |
|
1414 | 1566 | ). |
|
1415 | 1567 | This way you can edit multi-line code quickly and with the power of a real |
|
1416 | 1568 | editor right inside IPython. |
|
1417 | 1569 | |
|
1418 | \layout Standard | |
|
1570 | \end_layout | |
|
1419 | 1571 | |
|
1572 | \begin_layout Standard | |
|
1420 | 1573 | If you are a dedicated |
|
1421 |
\family typewriter |
|
|
1574 | \family typewriter | |
|
1422 | 1575 | Emacs |
|
1423 |
\family default |
|
|
1576 | \family default | |
|
1424 | 1577 | user, you should set up the |
|
1425 |
\family typewriter |
|
|
1578 | \family typewriter | |
|
1426 | 1579 | Emacs |
|
1427 |
\family default |
|
|
1580 | \family default | |
|
1428 | 1581 | server so that new requests are handled by the original process. |
|
1429 | 1582 | This means that almost no time is spent in handling the request (assuming |
|
1430 | 1583 | an |
|
1431 |
\family typewriter |
|
|
1584 | \family typewriter | |
|
1432 | 1585 | Emacs |
|
1433 |
\family default |
|
|
1586 | \family default | |
|
1434 | 1587 | process is already running). |
|
1435 | 1588 | For this to work, you need to set your |
|
1436 |
\family typewriter |
|
|
1589 | \family typewriter | |
|
1437 | 1590 | EDITOR |
|
1438 |
\family default |
|
|
1591 | \family default | |
|
1439 | 1592 | environment variable to |
|
1440 |
\family typewriter |
|
|
1593 | \family typewriter | |
|
1441 | 1594 | 'emacsclient' |
|
1442 |
\family default |
|
|
1595 | \family default | |
|
1443 | 1596 | . |
|
1444 | 1597 | |
|
1445 |
\family typewriter |
|
|
1598 | \family typewriter | |
|
1446 | 1599 | |
|
1447 |
\family default |
|
|
1600 | \family default | |
|
1448 | 1601 | The code below, supplied by Francois Pinard, can then be used in your |
|
1449 |
\family typewriter |
|
|
1602 | \family typewriter | |
|
1450 | 1603 | .emacs |
|
1451 |
\family default |
|
|
1604 | \family default | |
|
1452 | 1605 | file to enable the server: |
|
1453 | \layout Standard | |
|
1606 | \end_layout | |
|
1454 | 1607 | |
|
1608 | \begin_layout Standard | |
|
1455 | 1609 | |
|
1456 |
\family typewriter |
|
|
1610 | \family typewriter | |
|
1457 | 1611 | (defvar server-buffer-clients) |
|
1458 |
\newline |
|
|
1459 |
(when (and (fboundp 'server-start) (string-equal |
|
|
1460 | \newline | |
|
1612 | \newline | |
|
1613 | (when (and (fboundp 'server-start) (string-equal | |
|
1614 | (getenv "TERM") 'xterm)) | |
|
1615 | \newline | |
|
1461 | 1616 | |
|
1462 | 1617 | \begin_inset ERT |
|
1463 |
status |
|
|
1618 | status collapsed | |
|
1619 | ||
|
1620 | \begin_layout Standard | |
|
1464 | 1621 | |
|
1465 | \layout Standard | |
|
1466 | 1622 | |
|
1467 |
\backslash |
|
|
1623 | \backslash | |
|
1468 | 1624 | hspace*{0mm} |
|
1469 | \end_inset | |
|
1625 | \end_layout | |
|
1626 | ||
|
1627 | \end_inset | |
|
1470 | 1628 | |
|
1471 | \SpecialChar ~ | |
|
1472 | \SpecialChar ~ | |
|
1629 | \InsetSpace ~ | |
|
1630 | \InsetSpace ~ | |
|
1473 | 1631 | (server-start) |
|
1474 |
\newline |
|
|
1632 | \newline | |
|
1475 | 1633 | |
|
1476 | 1634 | \begin_inset ERT |
|
1477 |
status |
|
|
1635 | status collapsed | |
|
1478 | 1636 | |
|
1479 | \layout Standard | |
|
1637 | \begin_layout Standard | |
|
1480 | 1638 | |
|
1481 | \backslash | |
|
1639 | ||
|
1640 | \backslash | |
|
1482 | 1641 | hspace*{0mm} |
|
1483 | \end_inset | |
|
1642 | \end_layout | |
|
1643 | ||
|
1644 | \end_inset | |
|
1484 | 1645 | |
|
1485 | \SpecialChar ~ | |
|
1486 | \SpecialChar ~ | |
|
1646 | \InsetSpace ~ | |
|
1647 | \InsetSpace ~ | |
|
1487 | 1648 | (defun fp-kill-server-with-buffer-routine () |
|
1488 |
\newline |
|
|
1649 | \newline | |
|
1489 | 1650 | |
|
1490 | 1651 | \begin_inset ERT |
|
1491 |
status |
|
|
1652 | status collapsed | |
|
1492 | 1653 | |
|
1493 | \layout Standard | |
|
1654 | \begin_layout Standard | |
|
1494 | 1655 | |
|
1495 | \backslash | |
|
1656 | ||
|
1657 | \backslash | |
|
1496 | 1658 | hspace*{0mm} |
|
1497 | \end_inset | |
|
1659 | \end_layout | |
|
1660 | ||
|
1661 | \end_inset | |
|
1498 | 1662 | |
|
1499 | \SpecialChar ~ | |
|
1500 | \SpecialChar ~ | |
|
1501 | \SpecialChar ~ | |
|
1502 | \SpecialChar ~ | |
|
1663 | \InsetSpace ~ | |
|
1664 | \InsetSpace ~ | |
|
1665 | \InsetSpace ~ | |
|
1666 | \InsetSpace ~ | |
|
1503 | 1667 | (and server-buffer-clients (server-done))) |
|
1504 |
\newline |
|
|
1668 | \newline | |
|
1505 | 1669 | |
|
1506 | 1670 | \begin_inset ERT |
|
1507 |
status |
|
|
1671 | status collapsed | |
|
1508 | 1672 | |
|
1509 | \layout Standard | |
|
1673 | \begin_layout Standard | |
|
1510 | 1674 | |
|
1511 | \backslash | |
|
1675 | ||
|
1676 | \backslash | |
|
1512 | 1677 | hspace*{0mm} |
|
1513 | \end_inset | |
|
1678 | \end_layout | |
|
1679 | ||
|
1680 | \end_inset | |
|
1514 | 1681 | |
|
1515 | \SpecialChar ~ | |
|
1516 | \SpecialChar ~ | |
|
1682 | \InsetSpace ~ | |
|
1683 | \InsetSpace ~ | |
|
1517 | 1684 | (add-hook 'kill-buffer-hook 'fp-kill-server-with-buffer-routine)) |
|
1518 | \layout Standard | |
|
1685 | \end_layout | |
|
1519 | 1686 | |
|
1687 | \begin_layout Standard | |
|
1520 | 1688 | You can also set the value of this editor via the commmand-line option '- |
|
1521 |
\family typewriter |
|
|
1689 | \family typewriter | |
|
1522 | 1690 | editor' |
|
1523 |
\family default |
|
|
1691 | \family default | |
|
1524 | 1692 | or in your |
|
1525 |
\family typewriter |
|
|
1693 | \family typewriter | |
|
1526 | 1694 | ipythonrc |
|
1527 |
\family default |
|
|
1695 | \family default | |
|
1528 | 1696 | file. |
|
1529 | 1697 | This is useful if you wish to use specifically for IPython an editor different |
|
1530 | 1698 | from your typical default (and for Windows users who tend to use fewer |
|
1531 | 1699 | environment variables). |
|
1532 | \layout Subsection | |
|
1700 | \end_layout | |
|
1533 | 1701 | |
|
1702 | \begin_layout Subsection | |
|
1534 | 1703 | Color |
|
1535 | \layout Standard | |
|
1704 | \end_layout | |
|
1536 | 1705 | |
|
1706 | \begin_layout Standard | |
|
1537 | 1707 | The default IPython configuration has most bells and whistles turned on |
|
1538 | 1708 | (they're pretty safe). |
|
1539 | 1709 | But there's one that |
|
1540 |
\emph on |
|
|
1710 | \emph on | |
|
1541 | 1711 | may |
|
1542 |
\emph default |
|
|
1712 | \emph default | |
|
1543 | 1713 | cause problems on some systems: the use of color on screen for displaying |
|
1544 | 1714 | information. |
|
1545 | 1715 | This is very useful, since IPython can show prompts and exception tracebacks |
|
1546 | 1716 | with various colors, display syntax-highlighted source code, and in general |
|
1547 | 1717 | make it easier to visually parse information. |
|
1548 | \layout Standard | |
|
1718 | \end_layout | |
|
1549 | 1719 | |
|
1720 | \begin_layout Standard | |
|
1550 | 1721 | The following terminals seem to handle the color sequences fine: |
|
1551 | \layout Itemize | |
|
1722 | \end_layout | |
|
1552 | 1723 | |
|
1724 | \begin_layout Itemize | |
|
1553 | 1725 | Linux main text console, KDE Konsole, Gnome Terminal, E-term, rxvt, xterm. |
|
1554 | \layout Itemize | |
|
1726 | \end_layout | |
|
1555 | 1727 | |
|
1728 | \begin_layout Itemize | |
|
1556 | 1729 | CDE terminal (tested under Solaris). |
|
1557 | 1730 | This one boldfaces light colors. |
|
1558 | \layout Itemize | |
|
1731 | \end_layout | |
|
1559 | 1732 | |
|
1733 | \begin_layout Itemize | |
|
1560 | 1734 | (X)Emacs buffers. |
|
1561 | 1735 | See sec. |
|
1562 | 1736 | \begin_inset LatexCommand \ref{sec:emacs} |
|
1563 | 1737 | |
|
1564 |
\end_inset |
|
|
1738 | \end_inset | |
|
1565 | 1739 | |
|
1566 | 1740 | for more details on using IPython with (X)Emacs. |
|
1567 | \layout Itemize | |
|
1741 | \end_layout | |
|
1568 | 1742 | |
|
1743 | \begin_layout Itemize | |
|
1569 | 1744 | A Windows (XP/2k) command prompt |
|
1570 |
\emph on |
|
|
1745 | \emph on | |
|
1571 | 1746 | with Gary Bishop's support extensions |
|
1572 |
\emph default |
|
|
1747 | \emph default | |
|
1573 | 1748 | . |
|
1574 |
Gary's extensions are discussed in Sec.\ |
|
|
1749 | Gary's extensions are discussed in Sec.\InsetSpace ~ | |
|
1575 | 1750 | |
|
1576 | 1751 | \begin_inset LatexCommand \ref{sub:Under-Windows} |
|
1577 | 1752 | |
|
1578 |
\end_inset |
|
|
1753 | \end_inset | |
|
1579 | 1754 | |
|
1580 | 1755 | . |
|
1581 | \layout Itemize | |
|
1756 | \end_layout | |
|
1582 | 1757 | |
|
1758 | \begin_layout Itemize | |
|
1583 | 1759 | A Windows (XP/2k) CygWin shell. |
|
1584 | 1760 | Although some users have reported problems; it is not clear whether there |
|
1585 | 1761 | is an issue for everyone or only under specific configurations. |
|
1586 | 1762 | If you have full color support under cygwin, please post to the IPython |
|
1587 | 1763 | mailing list so this issue can be resolved for all users. |
|
1588 | \layout Standard | |
|
1764 | \end_layout | |
|
1589 | 1765 | |
|
1766 | \begin_layout Standard | |
|
1590 | 1767 | These have shown problems: |
|
1591 | \layout Itemize | |
|
1768 | \end_layout | |
|
1592 | 1769 | |
|
1770 | \begin_layout Itemize | |
|
1593 | 1771 | Windows command prompt in WinXP/2k logged into a Linux machine via telnet |
|
1594 | 1772 | or ssh. |
|
1595 | \layout Itemize | |
|
1773 | \end_layout | |
|
1596 | 1774 | |
|
1775 | \begin_layout Itemize | |
|
1597 | 1776 | Windows native command prompt in WinXP/2k, |
|
1598 |
\emph on |
|
|
1777 | \emph on | |
|
1599 | 1778 | without |
|
1600 |
\emph default |
|
|
1779 | \emph default | |
|
1601 | 1780 | Gary Bishop's extensions. |
|
1602 | 1781 | Once Gary's readline library is installed, the normal WinXP/2k command |
|
1603 | 1782 | prompt works perfectly. |
|
1604 | \layout Standard | |
|
1783 | \end_layout | |
|
1605 | 1784 | |
|
1785 | \begin_layout Standard | |
|
1606 | 1786 | Currently the following color schemes are available: |
|
1607 | \layout Itemize | |
|
1787 | \end_layout | |
|
1608 | 1788 | |
|
1789 | \begin_layout Itemize | |
|
1609 | 1790 | |
|
1610 |
\family typewriter |
|
|
1791 | \family typewriter | |
|
1611 | 1792 | NoColor |
|
1612 |
\family default |
|
|
1793 | \family default | |
|
1613 | 1794 | : uses no color escapes at all (all escapes are empty |
|
1614 | 1795 | \begin_inset Quotes eld |
|
1615 |
\end_inset |
|
|
1796 | \end_inset | |
|
1616 | 1797 | |
|
1617 | 1798 | |
|
1618 | 1799 | \begin_inset Quotes eld |
|
1619 |
\end_inset |
|
|
1800 | \end_inset | |
|
1620 | 1801 | |
|
1621 | 1802 | strings). |
|
1622 | 1803 | This 'scheme' is thus fully safe to use in any terminal. |
|
1623 | \layout Itemize | |
|
1804 | \end_layout | |
|
1624 | 1805 | |
|
1806 | \begin_layout Itemize | |
|
1625 | 1807 | |
|
1626 |
\family typewriter |
|
|
1808 | \family typewriter | |
|
1627 | 1809 | Linux |
|
1628 |
\family default |
|
|
1810 | \family default | |
|
1629 | 1811 | : works well in Linux console type environments: dark background with light |
|
1630 | 1812 | fonts. |
|
1631 | 1813 | It uses bright colors for information, so it is difficult to read if you |
|
1632 | 1814 | have a light colored background. |
|
1633 | \layout Itemize | |
|
1815 | \end_layout | |
|
1634 | 1816 | |
|
1817 | \begin_layout Itemize | |
|
1635 | 1818 | |
|
1636 |
\family typewriter |
|
|
1819 | \family typewriter | |
|
1637 | 1820 | LightBG |
|
1638 |
\family default |
|
|
1821 | \family default | |
|
1639 | 1822 | : the basic colors are similar to those in the |
|
1640 |
\family typewriter |
|
|
1823 | \family typewriter | |
|
1641 | 1824 | Linux |
|
1642 |
\family default |
|
|
1825 | \family default | |
|
1643 | 1826 | scheme but darker. |
|
1644 | 1827 | It is easy to read in terminals with light backgrounds. |
|
1645 | \layout Standard | |
|
1828 | \end_layout | |
|
1646 | 1829 | |
|
1830 | \begin_layout Standard | |
|
1647 | 1831 | IPython uses colors for two main groups of things: prompts and tracebacks |
|
1648 | 1832 | which are directly printed to the terminal, and the object introspection |
|
1649 | 1833 | system which passes large sets of data through a pager. |
|
1650 | \layout Subsubsection | |
|
1834 | \end_layout | |
|
1651 | 1835 | |
|
1836 | \begin_layout Subsubsection | |
|
1652 | 1837 | Input/Output prompts and exception tracebacks |
|
1653 | \layout Standard | |
|
1838 | \end_layout | |
|
1654 | 1839 | |
|
1840 | \begin_layout Standard | |
|
1655 | 1841 | You can test whether the colored prompts and tracebacks work on your system |
|
1656 | 1842 | interactively by typing |
|
1657 |
\family typewriter |
|
|
1843 | \family typewriter | |
|
1658 | 1844 | '%colors Linux' |
|
1659 |
\family default |
|
|
1845 | \family default | |
|
1660 | 1846 | at the prompt (use ' |
|
1661 |
\family typewriter |
|
|
1847 | \family typewriter | |
|
1662 | 1848 | %colors LightBG' |
|
1663 |
\family default |
|
|
1849 | \family default | |
|
1664 | 1850 | if your terminal has a light background). |
|
1665 | 1851 | If the input prompt shows garbage like: |
|
1666 |
\newline |
|
|
1852 | \newline | |
|
1667 | 1853 | |
|
1668 |
\family typewriter |
|
|
1854 | \family typewriter | |
|
1669 | 1855 | [0;32mIn [[1;32m1[0;32m]: [0;00m |
|
1670 |
\family default |
|
|
1856 | \family default | |
|
1671 | 1857 | |
|
1672 |
\newline |
|
|
1858 | \newline | |
|
1673 | 1859 | instead of (in color) something like: |
|
1674 |
\newline |
|
|
1860 | \newline | |
|
1675 | 1861 | |
|
1676 |
\family typewriter |
|
|
1862 | \family typewriter | |
|
1677 | 1863 | In [1]: |
|
1678 |
\family default |
|
|
1864 | \family default | |
|
1679 | 1865 | |
|
1680 |
\newline |
|
|
1866 | \newline | |
|
1681 | 1867 | this means that your terminal doesn't properly handle color escape sequences. |
|
1682 | 1868 | You can go to a 'no color' mode by typing ' |
|
1683 |
\family typewriter |
|
|
1869 | \family typewriter | |
|
1684 | 1870 | %colors NoColor |
|
1685 |
\family default |
|
|
1871 | \family default | |
|
1686 | 1872 | '. |
|
1687 | 1873 | |
|
1688 | \layout Standard | |
|
1874 | \end_layout | |
|
1689 | 1875 | |
|
1876 | \begin_layout Standard | |
|
1690 | 1877 | You can try using a different terminal emulator program (Emacs users, see |
|
1691 | 1878 | below). |
|
1692 | 1879 | To permanently set your color preferences, edit the file |
|
1693 |
\family typewriter |
|
|
1880 | \family typewriter | |
|
1694 | 1881 | $HOME/.ipython/ipythonrc |
|
1695 |
\family default |
|
|
1882 | \family default | |
|
1696 | 1883 | and set the |
|
1697 |
\family typewriter |
|
|
1884 | \family typewriter | |
|
1698 | 1885 | colors |
|
1699 |
\family default |
|
|
1886 | \family default | |
|
1700 | 1887 | option to the desired value. |
|
1701 | \layout Subsubsection | |
|
1888 | \end_layout | |
|
1702 | 1889 | |
|
1890 | \begin_layout Subsubsection | |
|
1703 | 1891 | Object details (types, docstrings, source code, etc.) |
|
1704 | \layout Standard | |
|
1892 | \end_layout | |
|
1705 | 1893 | |
|
1894 | \begin_layout Standard | |
|
1706 | 1895 | IPython has a set of special functions for studying the objects you are |
|
1707 | 1896 | working with, discussed in detail in Sec. |
|
1708 | 1897 | |
|
1709 | 1898 | \begin_inset LatexCommand \ref{sec:dyn-object-info} |
|
1710 | 1899 | |
|
1711 |
\end_inset |
|
|
1900 | \end_inset | |
|
1712 | 1901 | |
|
1713 | 1902 | . |
|
1714 | 1903 | But this system relies on passing information which is longer than your |
|
1715 | 1904 | screen through a data pager, such as the common Unix |
|
1716 |
\family typewriter |
|
|
1905 | \family typewriter | |
|
1717 | 1906 | less |
|
1718 |
\family default |
|
|
1907 | \family default | |
|
1719 | 1908 | and |
|
1720 |
\family typewriter |
|
|
1909 | \family typewriter | |
|
1721 | 1910 | more |
|
1722 |
\family default |
|
|
1911 | \family default | |
|
1723 | 1912 | programs. |
|
1724 | 1913 | In order to be able to see this information in color, your pager needs |
|
1725 | 1914 | to be properly configured. |
|
1726 | 1915 | I strongly recommend using |
|
1727 |
\family typewriter |
|
|
1916 | \family typewriter | |
|
1728 | 1917 | less |
|
1729 |
\family default |
|
|
1918 | \family default | |
|
1730 | 1919 | instead of |
|
1731 |
\family typewriter |
|
|
1920 | \family typewriter | |
|
1732 | 1921 | more |
|
1733 |
\family default |
|
|
1922 | \family default | |
|
1734 | 1923 | , as it seems that |
|
1735 |
\family typewriter |
|
|
1924 | \family typewriter | |
|
1736 | 1925 | more |
|
1737 |
\family default |
|
|
1926 | \family default | |
|
1738 | 1927 | simply can not understand colored text correctly. |
|
1739 | \layout Standard | |
|
1928 | \end_layout | |
|
1740 | 1929 | |
|
1930 | \begin_layout Standard | |
|
1741 | 1931 | In order to configure |
|
1742 |
\family typewriter |
|
|
1932 | \family typewriter | |
|
1743 | 1933 | less |
|
1744 |
\family default |
|
|
1934 | \family default | |
|
1745 | 1935 | as your default pager, do the following: |
|
1746 | \layout Enumerate | |
|
1936 | \end_layout | |
|
1747 | 1937 | |
|
1938 | \begin_layout Enumerate | |
|
1748 | 1939 | Set the environment |
|
1749 |
\family typewriter |
|
|
1940 | \family typewriter | |
|
1750 | 1941 | PAGER |
|
1751 |
\family default |
|
|
1942 | \family default | |
|
1752 | 1943 | variable to |
|
1753 |
\family typewriter |
|
|
1944 | \family typewriter | |
|
1754 | 1945 | less |
|
1755 |
\family default |
|
|
1946 | \family default | |
|
1756 | 1947 | . |
|
1757 | \layout Enumerate | |
|
1948 | \end_layout | |
|
1758 | 1949 | |
|
1950 | \begin_layout Enumerate | |
|
1759 | 1951 | Set the environment |
|
1760 |
\family typewriter |
|
|
1952 | \family typewriter | |
|
1761 | 1953 | LESS |
|
1762 |
\family default |
|
|
1954 | \family default | |
|
1763 | 1955 | variable to |
|
1764 |
\family typewriter |
|
|
1956 | \family typewriter | |
|
1765 | 1957 | -r |
|
1766 |
\family default |
|
|
1958 | \family default | |
|
1767 | 1959 | (plus any other options you always want to pass to |
|
1768 |
\family typewriter |
|
|
1960 | \family typewriter | |
|
1769 | 1961 | less |
|
1770 |
\family default |
|
|
1962 | \family default | |
|
1771 | 1963 | by default). |
|
1772 | 1964 | This tells |
|
1773 |
\family typewriter |
|
|
1965 | \family typewriter | |
|
1774 | 1966 | less |
|
1775 |
\family default |
|
|
1967 | \family default | |
|
1776 | 1968 | to properly interpret control sequences, which is how color information |
|
1777 | 1969 | is given to your terminal. |
|
1778 | \layout Standard | |
|
1970 | \end_layout | |
|
1779 | 1971 | |
|
1972 | \begin_layout Standard | |
|
1780 | 1973 | For the |
|
1781 |
\family typewriter |
|
|
1974 | \family typewriter | |
|
1782 | 1975 | csh |
|
1783 |
\family default |
|
|
1976 | \family default | |
|
1784 | 1977 | or |
|
1785 |
\family typewriter |
|
|
1978 | \family typewriter | |
|
1786 | 1979 | tcsh |
|
1787 |
\family default |
|
|
1980 | \family default | |
|
1788 | 1981 | shells, add to your |
|
1789 |
\family typewriter |
|
|
1982 | \family typewriter | |
|
1790 | 1983 | ~/.cshrc |
|
1791 |
\family default |
|
|
1984 | \family default | |
|
1792 | 1985 | file the lines: |
|
1793 | \layout Standard | |
|
1986 | \end_layout | |
|
1794 | 1987 | |
|
1988 | \begin_layout Standard | |
|
1795 | 1989 | |
|
1796 |
\family typewriter |
|
|
1990 | \family typewriter | |
|
1797 | 1991 | setenv PAGER less |
|
1798 |
\newline |
|
|
1992 | \newline | |
|
1799 | 1993 | setenv LESS -r |
|
1800 | \layout Standard | |
|
1994 | \end_layout | |
|
1801 | 1995 | |
|
1996 | \begin_layout Standard | |
|
1802 | 1997 | There is similar syntax for other Unix shells, look at your system documentation |
|
1803 | 1998 | for details. |
|
1804 | \layout Standard | |
|
1999 | \end_layout | |
|
1805 | 2000 | |
|
2001 | \begin_layout Standard | |
|
1806 | 2002 | If you are on a system which lacks proper data pagers (such as Windows), |
|
1807 | 2003 | IPython will use a very limited builtin pager. |
|
1808 | \layout Subsection | |
|
1809 | ||
|
2004 | \end_layout | |
|
1810 | 2005 | |
|
2006 | \begin_layout Subsection | |
|
1811 | 2007 | \begin_inset LatexCommand \label{sec:emacs} |
|
1812 | 2008 | |
|
1813 |
\end_inset |
|
|
2009 | \end_inset | |
|
1814 | 2010 | |
|
1815 | 2011 | (X)Emacs configuration |
|
1816 | \layout Standard | |
|
2012 | \end_layout | |
|
1817 | 2013 | |
|
2014 | \begin_layout Standard | |
|
1818 | 2015 | Thanks to the work of Alexander Schmolck and Prabhu Ramachandran, currently |
|
1819 | 2016 | (X)Emacs and IPython get along very well. |
|
1820 | 2017 | |
|
1821 | \layout Standard | |
|
2018 | \end_layout | |
|
1822 | 2019 | |
|
2020 | \begin_layout Standard | |
|
1823 | 2021 | |
|
1824 |
\series bold |
|
|
2022 | \series bold | |
|
1825 | 2023 | Important note: |
|
1826 |
\series default |
|
|
2024 | \series default | |
|
1827 | 2025 | You will need to use a recent enough version of |
|
1828 |
\family typewriter |
|
|
2026 | \family typewriter | |
|
1829 | 2027 | python-mode.el |
|
1830 |
\family default |
|
|
2028 | \family default | |
|
1831 | 2029 | , along with the file |
|
1832 |
\family typewriter |
|
|
2030 | \family typewriter | |
|
1833 | 2031 | ipython.el |
|
1834 |
\family default |
|
|
2032 | \family default | |
|
1835 | 2033 | . |
|
1836 | 2034 | You can check that the version you have of |
|
1837 |
\family typewriter |
|
|
2035 | \family typewriter | |
|
1838 | 2036 | python-mode.el |
|
1839 |
\family default |
|
|
2037 | \family default | |
|
1840 | 2038 | is new enough by either looking at the revision number in the file itself, |
|
1841 | 2039 | or asking for it in (X)Emacs via |
|
1842 |
\family typewriter |
|
|
2040 | \family typewriter | |
|
1843 | 2041 | M-x py-version |
|
1844 |
\family default |
|
|
2042 | \family default | |
|
1845 | 2043 | . |
|
1846 | 2044 | Versions 4.68 and newer contain the necessary fixes for proper IPython support. |
|
1847 | \layout Standard | |
|
2045 | \end_layout | |
|
1848 | 2046 | |
|
2047 | \begin_layout Standard | |
|
1849 | 2048 | The file |
|
1850 |
\family typewriter |
|
|
2049 | \family typewriter | |
|
1851 | 2050 | ipython.el |
|
1852 |
\family default |
|
|
2051 | \family default | |
|
1853 | 2052 | is included with the IPython distribution, in the documentation directory |
|
1854 | 2053 | (where this manual resides in PDF and HTML formats). |
|
1855 | \layout Standard | |
|
2054 | \end_layout | |
|
1856 | 2055 | |
|
2056 | \begin_layout Standard | |
|
1857 | 2057 | Once you put these files in your Emacs path, all you need in your |
|
1858 |
\family typewriter |
|
|
2058 | \family typewriter | |
|
1859 | 2059 | .emacs |
|
1860 |
\family default |
|
|
2060 | \family default | |
|
1861 | 2061 | file is: |
|
1862 | \layout LyX-Code | |
|
2062 | \end_layout | |
|
1863 | 2063 | |
|
2064 | \begin_layout LyX-Code | |
|
1864 | 2065 | (require 'ipython) |
|
1865 | \layout Standard | |
|
2066 | \end_layout | |
|
1866 | 2067 | |
|
2068 | \begin_layout Standard | |
|
1867 | 2069 | This should give you full support for executing code snippets via IPython, |
|
1868 | 2070 | opening IPython as your Python shell via |
|
1869 |
\family typewriter |
|
|
1870 | C-c\SpecialChar ~ | |
|
2071 | \family typewriter | |
|
2072 | C-c\InsetSpace ~ | |
|
1871 | 2073 | ! |
|
1872 |
\family default |
|
|
2074 | \family default | |
|
1873 | 2075 | , etc. |
|
1874 | 2076 | |
|
1875 | \layout Standard | |
|
2077 | \end_layout | |
|
1876 | 2078 | |
|
2079 | \begin_layout Standard | |
|
1877 | 2080 | If you happen to get garbage instead of colored prompts as described in |
|
1878 | 2081 | the previous section, you may need to set also in your |
|
1879 |
\family typewriter |
|
|
2082 | \family typewriter | |
|
1880 | 2083 | .emacs |
|
1881 |
\family default |
|
|
2084 | \family default | |
|
1882 | 2085 | file: |
|
1883 | \layout LyX-Code | |
|
2086 | \end_layout | |
|
1884 | 2087 | |
|
2088 | \begin_layout LyX-Code | |
|
1885 | 2089 | (setq ansi-color-for-comint-mode t) |
|
1886 | \layout Subsubsection* | |
|
2090 | \end_layout | |
|
1887 | 2091 | |
|
2092 | \begin_layout Subsubsection* | |
|
1888 | 2093 | Notes |
|
1889 | \layout Itemize | |
|
2094 | \end_layout | |
|
1890 | 2095 | |
|
2096 | \begin_layout Itemize | |
|
1891 | 2097 | There is one caveat you should be aware of: you must start the IPython shell |
|
1892 | 2098 | |
|
1893 |
\emph on |
|
|
2099 | \emph on | |
|
1894 | 2100 | before |
|
1895 |
\emph default |
|
|
2101 | \emph default | |
|
1896 | 2102 | attempting to execute any code regions via |
|
1897 |
\family typewriter |
|
|
1898 | C-c\SpecialChar ~ | |
|
2103 | \family typewriter | |
|
2104 | C-c\InsetSpace ~ | |
|
1899 | 2105 | | |
|
1900 |
\family default |
|
|
2106 | \family default | |
|
1901 | 2107 | . |
|
1902 | 2108 | Simply type |
|
1903 |
\family typewriter |
|
|
1904 | C-c\SpecialChar ~ | |
|
2109 | \family typewriter | |
|
2110 | C-c\InsetSpace ~ | |
|
1905 | 2111 | ! |
|
1906 |
\family default |
|
|
2112 | \family default | |
|
1907 | 2113 | to start IPython before passing any code regions to the interpreter, and |
|
1908 | 2114 | you shouldn't experience any problems. |
|
1909 |
\newline |
|
|
1910 |
This is due to a bug in Python itself, |
|
|
1911 | but exists as of Python 2.2.2 (reported as SF bug [ 737947 ]). | |
|
1912 | \layout Itemize | |
|
2115 | \newline | |
|
2116 | This is due to a bug in Python itself, | |
|
2117 | which has been fixed for Python 2.3, but exists as of Python 2.2.2 (reported | |
|
2118 | as SF bug [ 737947 ]). | |
|
2119 | \end_layout | |
|
1913 | 2120 | |
|
2121 | \begin_layout Itemize | |
|
1914 | 2122 | The (X)Emacs support is maintained by Alexander Schmolck, so all comments/reques |
|
1915 | 2123 | ts should be directed to him through the IPython mailing lists. |
|
1916 | 2124 | |
|
1917 | \layout Itemize | |
|
2125 | \end_layout | |
|
1918 | 2126 | |
|
2127 | \begin_layout Itemize | |
|
1919 | 2128 | This code is still somewhat experimental so it's a bit rough around the |
|
1920 | 2129 | edges (although in practice, it works quite well). |
|
1921 | \layout Itemize | |
|
2130 | \end_layout | |
|
1922 | 2131 | |
|
2132 | \begin_layout Itemize | |
|
1923 | 2133 | Be aware that if you customize |
|
1924 |
\family typewriter |
|
|
2134 | \family typewriter | |
|
1925 | 2135 | py-python-command |
|
1926 |
\family default |
|
|
2136 | \family default | |
|
1927 | 2137 | previously, this value will override what |
|
1928 |
\family typewriter |
|
|
2138 | \family typewriter | |
|
1929 | 2139 | ipython.el |
|
1930 |
\family default |
|
|
2140 | \family default | |
|
1931 | 2141 | does (because loading the customization variables comes later). |
|
1932 | \layout Section | |
|
1933 | ||
|
2142 | \end_layout | |
|
1934 | 2143 | |
|
2144 | \begin_layout Section | |
|
1935 | 2145 | \begin_inset LatexCommand \label{sec:quick_tips} |
|
1936 | 2146 | |
|
1937 |
\end_inset |
|
|
2147 | \end_inset | |
|
1938 | 2148 | |
|
1939 | 2149 | Quick tips |
|
1940 | \layout Standard | |
|
2150 | \end_layout | |
|
1941 | 2151 | |
|
2152 | \begin_layout Standard | |
|
1942 | 2153 | IPython can be used as an improved replacement for the Python prompt, and |
|
1943 | 2154 | for that you don't really need to read any more of this manual. |
|
1944 | 2155 | But in this section we'll try to summarize a few tips on how to make the |
@@ -1946,105 +2157,109 b' IPython can be used as an improved replacement for the Python prompt, and' | |||
|
1946 | 2157 | things you might miss in the rest of the manual (which is getting long). |
|
1947 | 2158 | We'll give references to parts in the manual which provide more detail |
|
1948 | 2159 | when appropriate. |
|
1949 | \layout Standard | |
|
2160 | \end_layout | |
|
1950 | 2161 | |
|
2162 | \begin_layout Standard | |
|
1951 | 2163 | The following article by Jeremy Jones provides an introductory tutorial |
|
1952 | 2164 | about IPython: |
|
1953 |
\newline |
|
|
2165 | \newline | |
|
1954 | 2166 | |
|
1955 | 2167 | \begin_inset LatexCommand \htmlurl{http://www.onlamp.com/pub/a/python/2005/01/27/ipython.html} |
|
1956 | 2168 | |
|
1957 |
\end_inset |
|
|
2169 | \end_inset | |
|
1958 | 2170 | |
|
1959 | 2171 | |
|
1960 | \layout Itemize | |
|
2172 | \end_layout | |
|
1961 | 2173 | |
|
2174 | \begin_layout Itemize | |
|
1962 | 2175 | The TAB key. |
|
1963 | 2176 | TAB-completion, especially for attributes, is a convenient way to explore |
|
1964 | 2177 | the structure of any object you're dealing with. |
|
1965 | 2178 | Simply type |
|
1966 |
\family typewriter |
|
|
2179 | \family typewriter | |
|
1967 | 2180 | object_name.<TAB> |
|
1968 |
\family default |
|
|
2181 | \family default | |
|
1969 | 2182 | and a list of the object's attributes will be printed (see sec. |
|
1970 | 2183 | |
|
1971 | 2184 | \begin_inset LatexCommand \ref{sec:readline} |
|
1972 | 2185 | |
|
1973 |
\end_inset |
|
|
2186 | \end_inset | |
|
1974 | 2187 | |
|
1975 | 2188 | for more). |
|
1976 | 2189 | Tab completion also works on file and directory names, which combined with |
|
1977 | 2190 | IPython's alias system allows you to do from within IPython many of the |
|
1978 | 2191 | things you normally would need the system shell for. |
|
1979 | 2192 | |
|
1980 | \layout Itemize | |
|
2193 | \end_layout | |
|
1981 | 2194 | |
|
2195 | \begin_layout Itemize | |
|
1982 | 2196 | Explore your objects. |
|
1983 | 2197 | Typing |
|
1984 |
\family typewriter |
|
|
2198 | \family typewriter | |
|
1985 | 2199 | object_name? |
|
1986 |
\family default |
|
|
2200 | \family default | |
|
1987 | 2201 | will print all sorts of details about any object, including docstrings, |
|
1988 | 2202 | function definition lines (for call arguments) and constructor details |
|
1989 | 2203 | for classes. |
|
1990 | 2204 | The magic commands |
|
1991 |
\family typewriter |
|
|
2205 | \family typewriter | |
|
1992 | 2206 | %pdoc |
|
1993 |
\family default |
|
|
2207 | \family default | |
|
1994 | 2208 | , |
|
1995 |
\family typewriter |
|
|
2209 | \family typewriter | |
|
1996 | 2210 | %pdef |
|
1997 |
\family default |
|
|
2211 | \family default | |
|
1998 | 2212 | , |
|
1999 |
\family typewriter |
|
|
2213 | \family typewriter | |
|
2000 | 2214 | %psource |
|
2001 |
\family default |
|
|
2215 | \family default | |
|
2002 | 2216 | and |
|
2003 |
\family typewriter |
|
|
2217 | \family typewriter | |
|
2004 | 2218 | %pfile |
|
2005 |
\family default |
|
|
2219 | \family default | |
|
2006 | 2220 | will respectively print the docstring, function definition line, full source |
|
2007 | 2221 | code and the complete file for any object (when they can be found). |
|
2008 | 2222 | If automagic is on (it is by default), you don't need to type the ' |
|
2009 |
\family typewriter |
|
|
2223 | \family typewriter | |
|
2010 | 2224 | % |
|
2011 |
\family default |
|
|
2225 | \family default | |
|
2012 | 2226 | ' explicitly. |
|
2013 | 2227 | See sec. |
|
2014 | 2228 | |
|
2015 | 2229 | \begin_inset LatexCommand \ref{sec:dyn-object-info} |
|
2016 | 2230 | |
|
2017 |
\end_inset |
|
|
2231 | \end_inset | |
|
2018 | 2232 | |
|
2019 | 2233 | for more. |
|
2020 | \layout Itemize | |
|
2234 | \end_layout | |
|
2021 | 2235 | |
|
2236 | \begin_layout Itemize | |
|
2022 | 2237 | The |
|
2023 |
\family typewriter |
|
|
2238 | \family typewriter | |
|
2024 | 2239 | %run |
|
2025 |
\family default |
|
|
2240 | \family default | |
|
2026 | 2241 | magic command allows you to run any python script and load all of its data |
|
2027 | 2242 | directly into the interactive namespace. |
|
2028 | 2243 | Since the file is re-read from disk each time, changes you make to it are |
|
2029 | 2244 | reflected immediately (in contrast to the behavior of |
|
2030 |
\family typewriter |
|
|
2245 | \family typewriter | |
|
2031 | 2246 | import |
|
2032 |
\family default |
|
|
2247 | \family default | |
|
2033 | 2248 | ). |
|
2034 | 2249 | I rarely use |
|
2035 |
\family typewriter |
|
|
2250 | \family typewriter | |
|
2036 | 2251 | import |
|
2037 |
\family default |
|
|
2252 | \family default | |
|
2038 | 2253 | for code I am testing, relying on |
|
2039 |
\family typewriter |
|
|
2254 | \family typewriter | |
|
2040 | 2255 | %run |
|
2041 |
\family default |
|
|
2256 | \family default | |
|
2042 | 2257 | instead. |
|
2043 | 2258 | See sec. |
|
2044 | 2259 | |
|
2045 | 2260 | \begin_inset LatexCommand \ref{sec:magic} |
|
2046 | 2261 | |
|
2047 |
\end_inset |
|
|
2262 | \end_inset | |
|
2048 | 2263 | |
|
2049 | 2264 | for more on this and other magic commands, or type the name of any magic |
|
2050 | 2265 | command and ? to get details on it. |
@@ -2052,838 +2267,911 b' import' | |||
|
2052 | 2267 | |
|
2053 | 2268 | \begin_inset LatexCommand \ref{sec:dreload} |
|
2054 | 2269 | |
|
2055 |
\end_inset |
|
|
2270 | \end_inset | |
|
2056 | 2271 | |
|
2057 | 2272 | for a recursive reload command. |
|
2058 |
\newline |
|
|
2273 | \newline | |
|
2059 | 2274 | |
|
2060 |
\family typewriter |
|
|
2275 | \family typewriter | |
|
2061 | 2276 | %run |
|
2062 |
\family default |
|
|
2277 | \family default | |
|
2063 | 2278 | also has special flags for timing the execution of your scripts ( |
|
2064 |
\family typewriter |
|
|
2279 | \family typewriter | |
|
2065 | 2280 | -t |
|
2066 |
\family default |
|
|
2281 | \family default | |
|
2067 | 2282 | ) and for executing them under the control of either Python's |
|
2068 |
\family typewriter |
|
|
2283 | \family typewriter | |
|
2069 | 2284 | pdb |
|
2070 |
\family default |
|
|
2285 | \family default | |
|
2071 | 2286 | debugger ( |
|
2072 |
\family typewriter |
|
|
2287 | \family typewriter | |
|
2073 | 2288 | -d |
|
2074 |
\family default |
|
|
2289 | \family default | |
|
2075 | 2290 | ) or profiler ( |
|
2076 |
\family typewriter |
|
|
2291 | \family typewriter | |
|
2077 | 2292 | -p |
|
2078 |
\family default |
|
|
2293 | \family default | |
|
2079 | 2294 | ). |
|
2080 | 2295 | With all of these, |
|
2081 |
\family typewriter |
|
|
2296 | \family typewriter | |
|
2082 | 2297 | %run |
|
2083 |
\family default |
|
|
2298 | \family default | |
|
2084 | 2299 | can be used as the main tool for efficient interactive development of code |
|
2085 | 2300 | which you write in your editor of choice. |
|
2086 | \layout Itemize | |
|
2301 | \end_layout | |
|
2087 | 2302 | |
|
2303 | \begin_layout Itemize | |
|
2088 | 2304 | Use the Python debugger, |
|
2089 |
\family typewriter |
|
|
2305 | \family typewriter | |
|
2090 | 2306 | pdb |
|
2091 |
\family default |
|
|
2307 | \family default | |
|
2092 | 2308 | |
|
2093 | 2309 | \begin_inset Foot |
|
2094 |
collapsed |
|
|
2095 | ||
|
2096 | \layout Standard | |
|
2310 | status collapsed | |
|
2097 | 2311 | |
|
2312 | \begin_layout Standard | |
|
2098 | 2313 | Thanks to Christian Hart and Matthew Arnison for the suggestions leading |
|
2099 | 2314 | to IPython's improved debugger and profiler support. |
|
2100 | \end_inset | |
|
2315 | \end_layout | |
|
2316 | ||
|
2317 | \end_inset | |
|
2101 | 2318 | |
|
2102 | 2319 | . |
|
2103 | 2320 | The |
|
2104 |
\family typewriter |
|
|
2321 | \family typewriter | |
|
2105 | 2322 | %pdb |
|
2106 |
\family default |
|
|
2323 | \family default | |
|
2107 | 2324 | command allows you to toggle on and off the automatic invocation of an |
|
2108 | 2325 | IPython-enhanced |
|
2109 |
\family typewriter |
|
|
2326 | \family typewriter | |
|
2110 | 2327 | pdb |
|
2111 |
\family default |
|
|
2328 | \family default | |
|
2112 | 2329 | debugger (with coloring, tab completion and more) at any uncaught exception. |
|
2113 | 2330 | The advantage of this is that |
|
2114 |
\family typewriter |
|
|
2331 | \family typewriter | |
|
2115 | 2332 | pdb |
|
2116 |
\family default |
|
|
2333 | \family default | |
|
2117 | 2334 | starts |
|
2118 |
\emph on |
|
|
2335 | \emph on | |
|
2119 | 2336 | inside |
|
2120 |
\emph default |
|
|
2337 | \emph default | |
|
2121 | 2338 | the function where the exception occurred, with all data still available. |
|
2122 | 2339 | You can print variables, see code, execute statements and even walk up |
|
2123 | 2340 | and down the call stack to track down the true source of the problem (which |
|
2124 | 2341 | often is many layers in the stack above where the exception gets triggered). |
|
2125 |
\newline |
|
|
2126 | Running programs with | |
|
2127 | \family typewriter | |
|
2342 | \newline | |
|
2343 | Runn | |
|
2344 | ing programs with | |
|
2345 | \family typewriter | |
|
2128 | 2346 | %run |
|
2129 |
\family default |
|
|
2347 | \family default | |
|
2130 | 2348 | and pdb active can be an efficient to develop and debug code, in many cases |
|
2131 | 2349 | eliminating the need for |
|
2132 |
\family typewriter |
|
|
2350 | \family typewriter | |
|
2133 | 2351 | |
|
2134 |
\family default |
|
|
2352 | \family default | |
|
2135 | 2353 | statements or external debugging tools. |
|
2136 | 2354 | I often simply put a |
|
2137 |
\family typewriter |
|
|
2355 | \family typewriter | |
|
2138 | 2356 | 1/0 |
|
2139 |
\family default |
|
|
2357 | \family default | |
|
2140 | 2358 | in a place where I want to take a look so that pdb gets called, quickly |
|
2141 | 2359 | view whatever variables I need to or test various pieces of code and then |
|
2142 | 2360 | remove the |
|
2143 |
\family typewriter |
|
|
2361 | \family typewriter | |
|
2144 | 2362 | 1/0 |
|
2145 |
\family default |
|
|
2363 | \family default | |
|
2146 | 2364 | . |
|
2147 |
\newline |
|
|
2365 | \newline | |
|
2148 | 2366 | Note also that ` |
|
2149 |
\family typewriter |
|
|
2367 | \family typewriter | |
|
2150 | 2368 | %run -d |
|
2151 |
\family default |
|
|
2369 | \family default | |
|
2152 | 2370 | ' activates |
|
2153 |
\family typewriter |
|
|
2371 | \family typewriter | |
|
2154 | 2372 | pdb |
|
2155 |
\family default |
|
|
2373 | \family default | |
|
2156 | 2374 | and automatically sets initial breakpoints for you to step through your |
|
2157 | 2375 | code, watch variables, etc. |
|
2158 |
See Sec.\ |
|
|
2376 | See Sec.\InsetSpace ~ | |
|
2159 | 2377 | |
|
2160 | 2378 | \begin_inset LatexCommand \ref{sec:cache_output} |
|
2161 | 2379 | |
|
2162 |
\end_inset |
|
|
2380 | \end_inset | |
|
2163 | 2381 | |
|
2164 | 2382 | for details. |
|
2165 | \layout Itemize | |
|
2383 | \end_layout | |
|
2166 | 2384 | |
|
2385 | \begin_layout Itemize | |
|
2167 | 2386 | Use the output cache. |
|
2168 | 2387 | All output results are automatically stored in a global dictionary named |
|
2169 | 2388 | |
|
2170 |
\family typewriter |
|
|
2389 | \family typewriter | |
|
2171 | 2390 | Out |
|
2172 |
\family default |
|
|
2391 | \family default | |
|
2173 | 2392 | and variables named |
|
2174 |
\family typewriter |
|
|
2393 | \family typewriter | |
|
2175 | 2394 | _1 |
|
2176 |
\family default |
|
|
2395 | \family default | |
|
2177 | 2396 | , |
|
2178 |
\family typewriter |
|
|
2397 | \family typewriter | |
|
2179 | 2398 | _2 |
|
2180 |
\family default |
|
|
2399 | \family default | |
|
2181 | 2400 | , etc. |
|
2182 | 2401 | alias them. |
|
2183 | 2402 | For example, the result of input line 4 is available either as |
|
2184 |
\family typewriter |
|
|
2403 | \family typewriter | |
|
2185 | 2404 | Out[4] |
|
2186 |
\family default |
|
|
2405 | \family default | |
|
2187 | 2406 | or as |
|
2188 |
\family typewriter |
|
|
2407 | \family typewriter | |
|
2189 | 2408 | _4 |
|
2190 |
\family default |
|
|
2409 | \family default | |
|
2191 | 2410 | . |
|
2192 | 2411 | Additionally, three variables named |
|
2193 |
\family typewriter |
|
|
2412 | \family typewriter | |
|
2194 | 2413 | _ |
|
2195 |
\family default |
|
|
2414 | \family default | |
|
2196 | 2415 | , |
|
2197 |
\family typewriter |
|
|
2416 | \family typewriter | |
|
2198 | 2417 | __ |
|
2199 |
\family default |
|
|
2418 | \family default | |
|
2200 | 2419 | and |
|
2201 |
\family typewriter |
|
|
2420 | \family typewriter | |
|
2202 | 2421 | ___ |
|
2203 |
\family default |
|
|
2422 | \family default | |
|
2204 | 2423 | are always kept updated with the for the last three results. |
|
2205 | 2424 | This allows you to recall any previous result and further use it for new |
|
2206 | 2425 | calculations. |
|
2207 |
See Sec.\ |
|
|
2426 | See Sec.\InsetSpace ~ | |
|
2208 | 2427 | |
|
2209 | 2428 | \begin_inset LatexCommand \ref{sec:cache_output} |
|
2210 | 2429 | |
|
2211 |
\end_inset |
|
|
2430 | \end_inset | |
|
2212 | 2431 | |
|
2213 | 2432 | for more. |
|
2214 | \layout Itemize | |
|
2433 | \end_layout | |
|
2215 | 2434 | |
|
2435 | \begin_layout Itemize | |
|
2216 | 2436 | Put a ' |
|
2217 |
\family typewriter |
|
|
2437 | \family typewriter | |
|
2218 | 2438 | ; |
|
2219 |
\family default |
|
|
2439 | \family default | |
|
2220 | 2440 | ' at the end of a line to supress the printing of output. |
|
2221 | 2441 | This is useful when doing calculations which generate long output you are |
|
2222 | 2442 | not interested in seeing. |
|
2223 | 2443 | The |
|
2224 |
\family typewriter |
|
|
2444 | \family typewriter | |
|
2225 | 2445 | _* |
|
2226 |
\family default |
|
|
2446 | \family default | |
|
2227 | 2447 | variables and the |
|
2228 |
\family typewriter |
|
|
2448 | \family typewriter | |
|
2229 | 2449 | Out[] |
|
2230 |
\family default |
|
|
2450 | \family default | |
|
2231 | 2451 | list do get updated with the contents of the output, even if it is not |
|
2232 | 2452 | printed. |
|
2233 | 2453 | You can thus still access the generated results this way for further processing. |
|
2234 | \layout Itemize | |
|
2454 | \end_layout | |
|
2235 | 2455 | |
|
2456 | \begin_layout Itemize | |
|
2236 | 2457 | A similar system exists for caching input. |
|
2237 | 2458 | All input is stored in a global list called |
|
2238 |
\family typewriter |
|
|
2459 | \family typewriter | |
|
2239 | 2460 | In |
|
2240 |
\family default |
|
|
2461 | \family default | |
|
2241 | 2462 | , so you can re-execute lines 22 through 28 plus line 34 by typing |
|
2242 |
\family typewriter |
|
|
2463 | \family typewriter | |
|
2243 | 2464 | 'exec In[22:29]+In[34]' |
|
2244 |
\family default |
|
|
2465 | \family default | |
|
2245 | 2466 | (using Python slicing notation). |
|
2246 | 2467 | If you need to execute the same set of lines often, you can assign them |
|
2247 | 2468 | to a macro with the |
|
2248 |
\family typewriter |
|
|
2469 | \family typewriter | |
|
2249 | 2470 | %macro |
|
2250 |
\family default |
|
|
2471 | \family default | |
|
2251 | 2472 | |
|
2252 |
\family typewriter |
|
|
2473 | \family typewriter | |
|
2253 | 2474 | function. |
|
2254 | 2475 | |
|
2255 |
\family default |
|
|
2476 | \family default | |
|
2256 | 2477 | See sec. |
|
2257 | 2478 | |
|
2258 | 2479 | \begin_inset LatexCommand \ref{sec:cache_input} |
|
2259 | 2480 | |
|
2260 |
\end_inset |
|
|
2481 | \end_inset | |
|
2261 | 2482 | |
|
2262 | 2483 | for more. |
|
2263 | \layout Itemize | |
|
2484 | \end_layout | |
|
2264 | 2485 | |
|
2486 | \begin_layout Itemize | |
|
2265 | 2487 | Use your input history. |
|
2266 | 2488 | The |
|
2267 |
\family typewriter |
|
|
2489 | \family typewriter | |
|
2268 | 2490 | %hist |
|
2269 |
\family default |
|
|
2491 | \family default | |
|
2270 | 2492 | command can show you all previous input, without line numbers if desired |
|
2271 | 2493 | (option |
|
2272 |
\family typewriter |
|
|
2494 | \family typewriter | |
|
2273 | 2495 | -n |
|
2274 |
\family default |
|
|
2496 | \family default | |
|
2275 | 2497 | ) so you can directly copy and paste code either back in IPython or in a |
|
2276 | 2498 | text editor. |
|
2277 | 2499 | You can also save all your history by turning on logging via |
|
2278 |
\family typewriter |
|
|
2500 | \family typewriter | |
|
2279 | 2501 | %logstart |
|
2280 |
\family default |
|
|
2502 | \family default | |
|
2281 | 2503 | ; these logs can later be either reloaded as IPython sessions or used as |
|
2282 | 2504 | code for your programs. |
|
2283 | \layout Itemize | |
|
2505 | \end_layout | |
|
2284 | 2506 | |
|
2507 | \begin_layout Itemize | |
|
2285 | 2508 | Define your own system aliases. |
|
2286 | 2509 | Even though IPython gives you access to your system shell via the |
|
2287 |
\family typewriter |
|
|
2510 | \family typewriter | |
|
2288 | 2511 | ! |
|
2289 |
\family default |
|
|
2512 | \family default | |
|
2290 | 2513 | prefix, it is convenient to have aliases to the system commands you use |
|
2291 | 2514 | most often. |
|
2292 | 2515 | This allows you to work seamlessly from inside IPython with the same commands |
|
2293 | 2516 | you are used to in your system shell. |
|
2294 |
\newline |
|
|
2295 |
IPython comes with some pre-defined |
|
|
2296 | directories, both via a stack (see | |
|
2297 | \family typewriter | |
|
2517 | \newline | |
|
2518 | IPython comes with some pre-defined | |
|
2519 | aliases and a complete system for changing directories, both via a stack | |
|
2520 | (see | |
|
2521 | \family typewriter | |
|
2298 | 2522 | %pushd |
|
2299 |
\family default |
|
|
2523 | \family default | |
|
2300 | 2524 | , |
|
2301 |
\family typewriter |
|
|
2525 | \family typewriter | |
|
2302 | 2526 | %popd |
|
2303 |
\family default |
|
|
2527 | \family default | |
|
2304 | 2528 | and |
|
2305 |
\family typewriter |
|
|
2529 | \family typewriter | |
|
2306 | 2530 | %dhist |
|
2307 |
\family default |
|
|
2531 | \family default | |
|
2308 | 2532 | ) and via direct |
|
2309 |
\family typewriter |
|
|
2533 | \family typewriter | |
|
2310 | 2534 | %cd |
|
2311 |
\family default |
|
|
2535 | \family default | |
|
2312 | 2536 | . |
|
2313 | 2537 | The latter keeps a history of visited directories and allows you to go |
|
2314 | 2538 | to any previously visited one. |
|
2315 | \layout Itemize | |
|
2539 | \end_layout | |
|
2316 | 2540 | |
|
2541 | \begin_layout Itemize | |
|
2317 | 2542 | Use Python to manipulate the results of system commands. |
|
2318 | 2543 | The ` |
|
2319 |
\family typewriter |
|
|
2544 | \family typewriter | |
|
2320 | 2545 | !! |
|
2321 |
\family default |
|
|
2546 | \family default | |
|
2322 | 2547 | ' special syntax, and the |
|
2323 |
\family typewriter |
|
|
2548 | \family typewriter | |
|
2324 | 2549 | %sc |
|
2325 |
\family default |
|
|
2550 | \family default | |
|
2326 | 2551 | and |
|
2327 |
\family typewriter |
|
|
2552 | \family typewriter | |
|
2328 | 2553 | %sx |
|
2329 |
\family default |
|
|
2554 | \family default | |
|
2330 | 2555 | magic commands allow you to capture system output into Python variables. |
|
2331 | \layout Itemize | |
|
2556 | \end_layout | |
|
2332 | 2557 | |
|
2558 | \begin_layout Itemize | |
|
2333 | 2559 | Expand python variables when calling the shell (either via |
|
2334 |
\family typewriter |
|
|
2560 | \family typewriter | |
|
2335 | 2561 | `!' |
|
2336 |
\family default |
|
|
2562 | \family default | |
|
2337 | 2563 | and |
|
2338 |
\family typewriter |
|
|
2564 | \family typewriter | |
|
2339 | 2565 | `!!' |
|
2340 |
\family default |
|
|
2566 | \family default | |
|
2341 | 2567 | or via aliases) by prepending a |
|
2342 |
\family typewriter |
|
|
2568 | \family typewriter | |
|
2343 | 2569 | $ |
|
2344 |
\family default |
|
|
2570 | \family default | |
|
2345 | 2571 | in front of them. |
|
2346 | 2572 | You can also expand complete python expressions. |
|
2347 |
See sec.\ |
|
|
2573 | See sec.\InsetSpace ~ | |
|
2348 | 2574 | |
|
2349 | 2575 | \begin_inset LatexCommand \ref{sub:System-shell-access} |
|
2350 | 2576 | |
|
2351 |
\end_inset |
|
|
2577 | \end_inset | |
|
2352 | 2578 | |
|
2353 | 2579 | for more. |
|
2354 | \layout Itemize | |
|
2580 | \end_layout | |
|
2355 | 2581 | |
|
2582 | \begin_layout Itemize | |
|
2356 | 2583 | Use profiles to maintain different configurations (modules to load, function |
|
2357 | 2584 | definitions, option settings) for particular tasks. |
|
2358 | 2585 | You can then have customized versions of IPython for specific purposes. |
|
2359 |
See sec.\ |
|
|
2586 | See sec.\InsetSpace ~ | |
|
2360 | 2587 | |
|
2361 | 2588 | \begin_inset LatexCommand \ref{sec:profiles} |
|
2362 | 2589 | |
|
2363 |
\end_inset |
|
|
2590 | \end_inset | |
|
2364 | 2591 | |
|
2365 | 2592 | for more. |
|
2366 | \layout Itemize | |
|
2593 | \end_layout | |
|
2367 | 2594 | |
|
2595 | \begin_layout Itemize | |
|
2368 | 2596 | Embed IPython in your programs. |
|
2369 | 2597 | A few lines of code are enough to load a complete IPython inside your own |
|
2370 | 2598 | programs, giving you the ability to work with your data interactively after |
|
2371 | 2599 | automatic processing has been completed. |
|
2372 |
See sec.\ |
|
|
2600 | See sec.\InsetSpace ~ | |
|
2373 | 2601 | |
|
2374 | 2602 | \begin_inset LatexCommand \ref{sec:embed} |
|
2375 | 2603 | |
|
2376 |
\end_inset |
|
|
2604 | \end_inset | |
|
2377 | 2605 | |
|
2378 | 2606 | for more. |
|
2379 | \layout Itemize | |
|
2607 | \end_layout | |
|
2380 | 2608 | |
|
2609 | \begin_layout Itemize | |
|
2381 | 2610 | Use the Python profiler. |
|
2382 | 2611 | When dealing with performance issues, the |
|
2383 |
\family typewriter |
|
|
2612 | \family typewriter | |
|
2384 | 2613 | %run |
|
2385 |
\family default |
|
|
2614 | \family default | |
|
2386 | 2615 | command with a |
|
2387 |
\family typewriter |
|
|
2616 | \family typewriter | |
|
2388 | 2617 | -p |
|
2389 |
\family default |
|
|
2618 | \family default | |
|
2390 | 2619 | option allows you to run complete programs under the control of the Python |
|
2391 | 2620 | profiler. |
|
2392 | 2621 | The |
|
2393 |
\family typewriter |
|
|
2622 | \family typewriter | |
|
2394 | 2623 | %prun |
|
2395 |
\family default |
|
|
2624 | \family default | |
|
2396 | 2625 | command does a similar job for single Python expressions (like function |
|
2397 | 2626 | calls). |
|
2398 | \layout Itemize | |
|
2627 | \end_layout | |
|
2399 | 2628 | |
|
2629 | \begin_layout Itemize | |
|
2400 | 2630 | Use the IPython.demo.Demo class to load any Python script as an interactive |
|
2401 | 2631 | demo. |
|
2402 | 2632 | With a minimal amount of simple markup, you can control the execution of |
|
2403 | 2633 | the script, stopping as needed. |
|
2404 |
See sec.\ |
|
|
2634 | See sec.\InsetSpace ~ | |
|
2405 | 2635 | |
|
2406 | 2636 | \begin_inset LatexCommand \ref{sec:interactive-demos} |
|
2407 | 2637 | |
|
2408 |
\end_inset |
|
|
2638 | \end_inset | |
|
2409 | 2639 | |
|
2410 | 2640 | for more. |
|
2411 | \layout Subsection | |
|
2641 | \end_layout | |
|
2412 | 2642 | |
|
2643 | \begin_layout Subsection | |
|
2413 | 2644 | Source code handling tips |
|
2414 | \layout Standard | |
|
2645 | \end_layout | |
|
2415 | 2646 | |
|
2647 | \begin_layout Standard | |
|
2416 | 2648 | IPython is a line-oriented program, without full control of the terminal. |
|
2417 | 2649 | Therefore, it doesn't support true multiline editing. |
|
2418 | 2650 | However, it has a number of useful tools to help you in dealing effectively |
|
2419 | 2651 | with more complex editing. |
|
2420 | \layout Standard | |
|
2652 | \end_layout | |
|
2421 | 2653 | |
|
2654 | \begin_layout Standard | |
|
2422 | 2655 | The |
|
2423 |
\family typewriter |
|
|
2656 | \family typewriter | |
|
2424 | 2657 | %edit |
|
2425 |
\family default |
|
|
2658 | \family default | |
|
2426 | 2659 | command gives a reasonable approximation of multiline editing, by invoking |
|
2427 | 2660 | your favorite editor on the spot. |
|
2428 | 2661 | IPython will execute the code you type in there as if it were typed interactive |
|
2429 | 2662 | ly. |
|
2430 | 2663 | Type |
|
2431 |
\family typewriter |
|
|
2664 | \family typewriter | |
|
2432 | 2665 | %edit? |
|
2433 |
\family default |
|
|
2666 | \family default | |
|
2434 | 2667 | for the full details on the edit command. |
|
2435 | \layout Standard | |
|
2668 | \end_layout | |
|
2436 | 2669 | |
|
2670 | \begin_layout Standard | |
|
2437 | 2671 | If you have typed various commands during a session, which you'd like to |
|
2438 | 2672 | reuse, IPython provides you with a number of tools. |
|
2439 | 2673 | Start by using |
|
2440 |
\family typewriter |
|
|
2674 | \family typewriter | |
|
2441 | 2675 | %hist |
|
2442 |
\family default |
|
|
2676 | \family default | |
|
2443 | 2677 | to see your input history, so you can see the line numbers of all input. |
|
2444 | 2678 | Let us say that you'd like to reuse lines 10 through 20, plus lines 24 |
|
2445 | 2679 | and 28. |
|
2446 | 2680 | All the commands below can operate on these with the syntax |
|
2447 | \layout LyX-Code | |
|
2681 | \end_layout | |
|
2448 | 2682 | |
|
2683 | \begin_layout LyX-Code | |
|
2449 | 2684 | %command 10-20 24 28 |
|
2450 | \layout Standard | |
|
2685 | \end_layout | |
|
2451 | 2686 | |
|
2687 | \begin_layout Standard | |
|
2452 | 2688 | where the command given can be: |
|
2453 | \layout Itemize | |
|
2689 | \end_layout | |
|
2454 | 2690 | |
|
2691 | \begin_layout Itemize | |
|
2455 | 2692 | |
|
2456 |
\family typewriter |
|
|
2693 | \family typewriter | |
|
2457 | 2694 | %macro <macroname> |
|
2458 |
\family default |
|
|
2695 | \family default | |
|
2459 | 2696 | : this stores the lines into a variable which, when called at the prompt, |
|
2460 | 2697 | re-executes the input. |
|
2461 | 2698 | Macros can be edited later using |
|
2462 |
\family typewriter |
|
|
2699 | \family typewriter | |
|
2463 | 2700 | `%edit macroname |
|
2464 |
\family default |
|
|
2701 | \family default | |
|
2465 | 2702 | ', and they can be stored persistently across sessions with ` |
|
2466 |
\family typewriter |
|
|
2703 | \family typewriter | |
|
2467 | 2704 | %store macroname |
|
2468 |
\family default |
|
|
2705 | \family default | |
|
2469 | 2706 | ' (the storage system is per-profile). |
|
2470 | 2707 | The combination of quick macros, persistent storage and editing, allows |
|
2471 | 2708 | you to easily refine quick-and-dirty interactive input into permanent utilities |
|
2472 | 2709 | , always available both in IPython and as files for general reuse. |
|
2473 | \layout Itemize | |
|
2710 | \end_layout | |
|
2474 | 2711 | |
|
2712 | \begin_layout Itemize | |
|
2475 | 2713 | |
|
2476 |
\family typewriter |
|
|
2714 | \family typewriter | |
|
2477 | 2715 | %edit |
|
2478 |
\family default |
|
|
2716 | \family default | |
|
2479 | 2717 | : this will open a text editor with those lines pre-loaded for further modificat |
|
2480 | 2718 | ion. |
|
2481 | 2719 | It will then execute the resulting file's contents as if you had typed |
|
2482 | 2720 | it at the prompt. |
|
2483 | \layout Itemize | |
|
2721 | \end_layout | |
|
2484 | 2722 | |
|
2723 | \begin_layout Itemize | |
|
2485 | 2724 | |
|
2486 |
\family typewriter |
|
|
2725 | \family typewriter | |
|
2487 | 2726 | %save <filename> |
|
2488 |
\family default |
|
|
2727 | \family default | |
|
2489 | 2728 | : this saves the lines directly to a named file on disk. |
|
2490 | \layout Standard | |
|
2729 | \end_layout | |
|
2491 | 2730 | |
|
2731 | \begin_layout Standard | |
|
2492 | 2732 | While |
|
2493 |
\family typewriter |
|
|
2733 | \family typewriter | |
|
2494 | 2734 | %macro |
|
2495 |
\family default |
|
|
2735 | \family default | |
|
2496 | 2736 | saves input lines into memory for interactive re-execution, sometimes you'd |
|
2497 | 2737 | like to save your input directly to a file. |
|
2498 | 2738 | The |
|
2499 |
\family typewriter |
|
|
2739 | \family typewriter | |
|
2500 | 2740 | %save |
|
2501 |
\family default |
|
|
2741 | \family default | |
|
2502 | 2742 | magic does this: its input sytnax is the same as |
|
2503 |
\family typewriter |
|
|
2743 | \family typewriter | |
|
2504 | 2744 | %macro |
|
2505 |
\family default |
|
|
2745 | \family default | |
|
2506 | 2746 | , but it saves your input directly to a Python file. |
|
2507 | 2747 | Note that the |
|
2508 |
\family typewriter |
|
|
2748 | \family typewriter | |
|
2509 | 2749 | %logstart |
|
2510 |
\family default |
|
|
2750 | \family default | |
|
2511 | 2751 | command also saves input, but it logs |
|
2512 |
\emph on |
|
|
2752 | \emph on | |
|
2513 | 2753 | all |
|
2514 |
\emph default |
|
|
2754 | \emph default | |
|
2515 | 2755 | input to disk (though you can temporarily suspend it and reactivate it |
|
2516 | 2756 | with |
|
2517 |
\family typewriter |
|
|
2757 | \family typewriter | |
|
2518 | 2758 | %logoff/%logon |
|
2519 |
\family default |
|
|
2759 | \family default | |
|
2520 | 2760 | ); |
|
2521 |
\family typewriter |
|
|
2761 | \family typewriter | |
|
2522 | 2762 | %save |
|
2523 |
\family default |
|
|
2763 | \family default | |
|
2524 | 2764 | allows you to select which lines of input you need to save. |
|
2525 | \layout Subsubsection* | |
|
2765 | \end_layout | |
|
2526 | 2766 | |
|
2767 | \begin_layout Subsubsection* | |
|
2527 | 2768 | Lightweight 'version control' |
|
2528 | \layout Standard | |
|
2769 | \end_layout | |
|
2529 | 2770 | |
|
2771 | \begin_layout Standard | |
|
2530 | 2772 | When you call |
|
2531 |
\family typewriter |
|
|
2773 | \family typewriter | |
|
2532 | 2774 | %edit |
|
2533 |
\family default |
|
|
2775 | \family default | |
|
2534 | 2776 | with no arguments, IPython opens an empty editor with a temporary file, |
|
2535 | 2777 | and it returns the contents of your editing session as a string variable. |
|
2536 | 2778 | Thanks to IPython's output caching mechanism, this is automatically stored: |
|
2537 | \layout LyX-Code | |
|
2779 | \end_layout | |
|
2538 | 2780 | |
|
2781 | \begin_layout LyX-Code | |
|
2539 | 2782 | In [1]: %edit |
|
2540 | \layout LyX-Code | |
|
2783 | \end_layout | |
|
2541 | 2784 | |
|
2785 | \begin_layout LyX-Code | |
|
2542 | 2786 | IPython will make a temporary file named: /tmp/ipython_edit_yR-HCN.py |
|
2543 | \layout LyX-Code | |
|
2787 | \end_layout | |
|
2544 | 2788 | |
|
2789 | \begin_layout LyX-Code | |
|
2545 | 2790 | Editing... |
|
2546 | 2791 | done. |
|
2547 | 2792 | Executing edited code... |
|
2548 | \layout LyX-Code | |
|
2793 | \end_layout | |
|
2549 | 2794 | |
|
2795 | \begin_layout LyX-Code | |
|
2550 | 2796 | hello - this is a temporary file |
|
2551 | \layout LyX-Code | |
|
2797 | \end_layout | |
|
2552 | 2798 | |
|
2799 | \begin_layout LyX-Code | |
|
2553 | 2800 | Out[1]: "print 'hello - this is a temporary file' |
|
2554 |
\backslash |
|
|
2801 | \backslash | |
|
2555 | 2802 | n" |
|
2556 | \layout Standard | |
|
2803 | \end_layout | |
|
2557 | 2804 | |
|
2805 | \begin_layout Standard | |
|
2558 | 2806 | Now, if you call |
|
2559 |
\family typewriter |
|
|
2807 | \family typewriter | |
|
2560 | 2808 | `%edit -p' |
|
2561 |
\family default |
|
|
2809 | \family default | |
|
2562 | 2810 | , IPython tries to open an editor with the same data as the last time you |
|
2563 | 2811 | used |
|
2564 |
\family typewriter |
|
|
2812 | \family typewriter | |
|
2565 | 2813 | %edit |
|
2566 |
\family default |
|
|
2814 | \family default | |
|
2567 | 2815 | . |
|
2568 | 2816 | So if you haven't used |
|
2569 |
\family typewriter |
|
|
2817 | \family typewriter | |
|
2570 | 2818 | %edit |
|
2571 |
\family default |
|
|
2819 | \family default | |
|
2572 | 2820 | in the meantime, this same contents will reopen; however, it will be done |
|
2573 | 2821 | in a |
|
2574 |
\emph on |
|
|
2822 | \emph on | |
|
2575 | 2823 | new file |
|
2576 |
\emph default |
|
|
2824 | \emph default | |
|
2577 | 2825 | . |
|
2578 | 2826 | This means that if you make changes and you later want to find an old version, |
|
2579 | 2827 | you can always retrieve it by using its output number, via |
|
2580 |
\family typewriter |
|
|
2828 | \family typewriter | |
|
2581 | 2829 | `%edit _NN' |
|
2582 |
\family default |
|
|
2830 | \family default | |
|
2583 | 2831 | , where |
|
2584 |
\family typewriter |
|
|
2832 | \family typewriter | |
|
2585 | 2833 | NN |
|
2586 |
\family default |
|
|
2834 | \family default | |
|
2587 | 2835 | is the number of the output prompt. |
|
2588 | \layout Standard | |
|
2836 | \end_layout | |
|
2589 | 2837 | |
|
2838 | \begin_layout Standard | |
|
2590 | 2839 | Continuing with the example above, this should illustrate this idea: |
|
2591 | \layout LyX-Code | |
|
2840 | \end_layout | |
|
2592 | 2841 | |
|
2842 | \begin_layout LyX-Code | |
|
2593 | 2843 | In [2]: edit -p |
|
2594 | \layout LyX-Code | |
|
2844 | \end_layout | |
|
2595 | 2845 | |
|
2846 | \begin_layout LyX-Code | |
|
2596 | 2847 | IPython will make a temporary file named: /tmp/ipython_edit_nA09Qk.py |
|
2597 | \layout LyX-Code | |
|
2848 | \end_layout | |
|
2598 | 2849 | |
|
2850 | \begin_layout LyX-Code | |
|
2599 | 2851 | Editing... |
|
2600 | 2852 | done. |
|
2601 | 2853 | Executing edited code... |
|
2602 | \layout LyX-Code | |
|
2854 | \end_layout | |
|
2603 | 2855 | |
|
2856 | \begin_layout LyX-Code | |
|
2604 | 2857 | hello - now I made some changes |
|
2605 | \layout LyX-Code | |
|
2858 | \end_layout | |
|
2606 | 2859 | |
|
2860 | \begin_layout LyX-Code | |
|
2607 | 2861 | Out[2]: "print 'hello - now I made some changes' |
|
2608 |
\backslash |
|
|
2862 | \backslash | |
|
2609 | 2863 | n" |
|
2610 | \layout LyX-Code | |
|
2864 | \end_layout | |
|
2611 | 2865 | |
|
2866 | \begin_layout LyX-Code | |
|
2612 | 2867 | In [3]: edit _1 |
|
2613 | \layout LyX-Code | |
|
2868 | \end_layout | |
|
2614 | 2869 | |
|
2870 | \begin_layout LyX-Code | |
|
2615 | 2871 | IPython will make a temporary file named: /tmp/ipython_edit_gy6-zD.py |
|
2616 | \layout LyX-Code | |
|
2872 | \end_layout | |
|
2617 | 2873 | |
|
2874 | \begin_layout LyX-Code | |
|
2618 | 2875 | Editing... |
|
2619 | 2876 | done. |
|
2620 | 2877 | Executing edited code... |
|
2621 | \layout LyX-Code | |
|
2878 | \end_layout | |
|
2622 | 2879 | |
|
2880 | \begin_layout LyX-Code | |
|
2623 | 2881 | hello - this is a temporary file |
|
2624 | \layout LyX-Code | |
|
2882 | \end_layout | |
|
2625 | 2883 | |
|
2884 | \begin_layout LyX-Code | |
|
2626 | 2885 | IPython version control at work :) |
|
2627 | \layout LyX-Code | |
|
2886 | \end_layout | |
|
2628 | 2887 | |
|
2888 | \begin_layout LyX-Code | |
|
2629 | 2889 | Out[3]: "print 'hello - this is a temporary file' |
|
2630 |
\backslash |
|
|
2890 | \backslash | |
|
2631 | 2891 | nprint 'IPython version control at work :)' |
|
2632 |
\backslash |
|
|
2892 | \backslash | |
|
2633 | 2893 | n" |
|
2634 | \layout Standard | |
|
2894 | \end_layout | |
|
2635 | 2895 | |
|
2896 | \begin_layout Standard | |
|
2636 | 2897 | This section was written after a contribution by Alexander Belchenko on |
|
2637 | 2898 | the IPython user list. |
|
2638 | \layout LyX-Code | |
|
2899 | \end_layout | |
|
2639 | 2900 | |
|
2640 | \layout Subsection | |
|
2901 | \begin_layout LyX-Code | |
|
2641 | 2902 | |
|
2903 | \end_layout | |
|
2904 | ||
|
2905 | \begin_layout Subsection | |
|
2642 | 2906 | Effective logging |
|
2643 | \layout Standard | |
|
2907 | \end_layout | |
|
2644 | 2908 | |
|
2909 | \begin_layout Standard | |
|
2645 | 2910 | A very useful suggestion sent in by Robert Kern follows: |
|
2646 | \layout Standard | |
|
2911 | \end_layout | |
|
2647 | 2912 | |
|
2913 | \begin_layout Standard | |
|
2648 | 2914 | I recently happened on a nifty way to keep tidy per-project log files. |
|
2649 | 2915 | I made a profile for my project (which is called "parkfield"). |
|
2650 | \layout LyX-Code | |
|
2916 | \end_layout | |
|
2651 | 2917 | |
|
2918 | \begin_layout LyX-Code | |
|
2652 | 2919 | include ipythonrc |
|
2653 | \layout LyX-Code | |
|
2920 | \end_layout | |
|
2654 | 2921 | |
|
2922 | \begin_layout LyX-Code | |
|
2655 | 2923 | # cancel earlier logfile invocation: |
|
2656 | \layout LyX-Code | |
|
2924 | \end_layout | |
|
2657 | 2925 | |
|
2926 | \begin_layout LyX-Code | |
|
2658 | 2927 | logfile '' |
|
2659 | \layout LyX-Code | |
|
2928 | \end_layout | |
|
2660 | 2929 | |
|
2930 | \begin_layout LyX-Code | |
|
2661 | 2931 | execute import time |
|
2662 | \layout LyX-Code | |
|
2932 | \end_layout | |
|
2663 | 2933 | |
|
2934 | \begin_layout LyX-Code | |
|
2664 | 2935 | execute __cmd = '/Users/kern/research/logfiles/parkfield-%s.log rotate' |
|
2665 | \layout LyX-Code | |
|
2936 | \end_layout | |
|
2666 | 2937 | |
|
2938 | \begin_layout LyX-Code | |
|
2667 | 2939 | execute __IP.magic_logstart(__cmd % time.strftime('%Y-%m-%d')) |
|
2668 | \layout Standard | |
|
2940 | \end_layout | |
|
2669 | 2941 | |
|
2942 | \begin_layout Standard | |
|
2670 | 2943 | I also added a shell alias for convenience: |
|
2671 | \layout LyX-Code | |
|
2944 | \end_layout | |
|
2672 | 2945 | |
|
2946 | \begin_layout LyX-Code | |
|
2673 | 2947 | alias parkfield="ipython -pylab -profile parkfield" |
|
2674 | \layout Standard | |
|
2948 | \end_layout | |
|
2675 | 2949 | |
|
2950 | \begin_layout Standard | |
|
2676 | 2951 | Now I have a nice little directory with everything I ever type in, organized |
|
2677 | 2952 | by project and date. |
|
2678 | \layout Standard | |
|
2953 | \end_layout | |
|
2679 | 2954 | |
|
2955 | \begin_layout Standard | |
|
2680 | 2956 | |
|
2681 |
\series bold |
|
|
2957 | \series bold | |
|
2682 | 2958 | Contribute your own: |
|
2683 |
\series default |
|
|
2959 | \series default | |
|
2684 | 2960 | If you have your own favorite tip on using IPython efficiently for a certain |
|
2685 | 2961 | task (especially things which can't be done in the normal Python interpreter), |
|
2686 | 2962 | don't hesitate to send it! |
|
2687 | \layout Section | |
|
2963 | \end_layout | |
|
2688 | 2964 | |
|
2965 | \begin_layout Section | |
|
2689 | 2966 | Command-line use |
|
2690 | \layout Standard | |
|
2967 | \end_layout | |
|
2691 | 2968 | |
|
2969 | \begin_layout Standard | |
|
2692 | 2970 | You start IPython with the command: |
|
2693 | \layout Standard | |
|
2971 | \end_layout | |
|
2694 | 2972 | |
|
2973 | \begin_layout Standard | |
|
2695 | 2974 | |
|
2696 |
\family typewriter |
|
|
2975 | \family typewriter | |
|
2697 | 2976 | $ ipython [options] files |
|
2698 | \layout Standard | |
|
2977 | \end_layout | |
|
2699 | 2978 | |
|
2979 | \begin_layout Standard | |
|
2700 | 2980 | If invoked with no options, it executes all the files listed in sequence |
|
2701 | 2981 | and drops you into the interpreter while still acknowledging any options |
|
2702 | 2982 | you may have set in your ipythonrc file. |
|
2703 | 2983 | This behavior is different from standard Python, which when called as |
|
2704 |
\family typewriter |
|
|
2984 | \family typewriter | |
|
2705 | 2985 | python -i |
|
2706 |
\family default |
|
|
2986 | \family default | |
|
2707 | 2987 | will only execute one file and ignore your configuration setup. |
|
2708 | \layout Standard | |
|
2988 | \end_layout | |
|
2709 | 2989 | |
|
2990 | \begin_layout Standard | |
|
2710 | 2991 | Please note that some of the configuration options are not available at |
|
2711 | 2992 | the command line, simply because they are not practical here. |
|
2712 | 2993 | Look into your ipythonrc configuration file for details on those. |
|
2713 | 2994 | This file typically installed in the |
|
2714 |
\family typewriter |
|
|
2995 | \family typewriter | |
|
2715 | 2996 | $HOME/.ipython |
|
2716 |
\family default |
|
|
2997 | \family default | |
|
2717 | 2998 | directory. |
|
2718 | 2999 | For Windows users, |
|
2719 |
\family typewriter |
|
|
3000 | \family typewriter | |
|
2720 | 3001 | $HOME |
|
2721 |
\family default |
|
|
3002 | \family default | |
|
2722 | 3003 | resolves to |
|
2723 |
\family typewriter |
|
|
3004 | \family typewriter | |
|
2724 | 3005 | C: |
|
2725 |
\backslash |
|
|
3006 | \backslash | |
|
2726 | 3007 | |
|
2727 |
\backslash |
|
|
3008 | \backslash | |
|
2728 | 3009 | Documents and Settings |
|
2729 |
\backslash |
|
|
3010 | \backslash | |
|
2730 | 3011 | |
|
2731 |
\backslash |
|
|
3012 | \backslash | |
|
2732 | 3013 | YourUserName |
|
2733 |
\family default |
|
|
3014 | \family default | |
|
2734 | 3015 | in most instances. |
|
2735 | 3016 | In the rest of this text, we will refer to this directory as |
|
2736 |
\family typewriter |
|
|
3017 | \family typewriter | |
|
2737 | 3018 | IPYTHONDIR |
|
2738 |
\family default |
|
|
3019 | \family default | |
|
2739 | 3020 | . |
|
2740 | \layout Subsection | |
|
2741 | ||
|
3021 | \end_layout | |
|
2742 | 3022 | |
|
3023 | \begin_layout Subsection | |
|
2743 | 3024 | \begin_inset LatexCommand \label{sec:threading-opts} |
|
2744 | 3025 | |
|
2745 |
\end_inset |
|
|
3026 | \end_inset | |
|
2746 | 3027 | |
|
2747 | 3028 | Special Threading Options |
|
2748 | \layout Standard | |
|
3029 | \end_layout | |
|
2749 | 3030 | |
|
3031 | \begin_layout Standard | |
|
2750 | 3032 | The following special options are ONLY valid at the beginning of the command |
|
2751 | 3033 | line, and not later. |
|
2752 | 3034 | This is because they control the initial- ization of ipython itself, before |
|
2753 | 3035 | the normal option-handling mechanism is active. |
|
2754 |
\layou |
|
|
2755 | \labelwidthstring 00.00.0000 | |
|
3036 | \end_layout | |
|
2756 | 3037 | |
|
3038 | \begin_layout List | |
|
3039 | \labelwidthstring 00.00.0000 | |
|
2757 | 3040 | |
|
2758 |
\family typewriter |
|
|
2759 |
\series bold |
|
|
2760 |
-gthread,\ |
|
|
2761 |
-qthread,\ |
|
|
2762 |
- |
|
|
3041 | \family typewriter | |
|
3042 | \series bold | |
|
3043 | -gthread,\InsetSpace ~ | |
|
3044 | -qthread,\InsetSpace ~ | |
|
3045 | -q4thread,\InsetSpace ~ | |
|
3046 | -wthread,\InsetSpace ~ | |
|
2763 | 3047 | -pylab: |
|
2764 |
\family default |
|
|
2765 |
\series default |
|
|
3048 | \family default | |
|
3049 | \series default | |
|
2766 | 3050 | Only |
|
2767 |
\emph on |
|
|
3051 | \emph on | |
|
2768 | 3052 | one |
|
2769 |
\emph default |
|
|
3053 | \emph default | |
|
2770 | 3054 | of these can be given, and it can only be given as the first option passed |
|
2771 | 3055 | to IPython (it will have no effect in any other position). |
|
2772 |
They provide threading support for the GTK Qt and WXPython |
|
|
2773 | for the matplotlib library. | |
|
2774 |
\layou |
|
|
2775 | \labelwidthstring 00.00.0000 | |
|
3056 | They provide threading support for the GTK, Qt (versions 3 and 4) and WXPython | |
|
3057 | toolkits, and for the matplotlib library. | |
|
3058 | \end_layout | |
|
2776 | 3059 | |
|
2777 | \SpecialChar ~ | |
|
2778 | With any of the first three options, IPython starts running a separate | |
|
2779 | thread for the graphical toolkit's operation, so that you can open and | |
|
2780 | control graphical elements from within an IPython command line, without | |
|
2781 | blocking. | |
|
2782 | All three provide essentially the same functionality, respectively for | |
|
2783 | GTK, QT and WXWidgets (via their Python interfaces). | |
|
2784 | \layout List | |
|
3060 | \begin_layout List | |
|
2785 | 3061 | \labelwidthstring 00.00.0000 |
|
3062 | \InsetSpace ~ | |
|
3063 | With any of the first four options, IPython starts running a separate thread | |
|
3064 | for the graphical toolkit's operation, so that you can open and control | |
|
3065 | graphical elements from within an IPython command line, without blocking. | |
|
3066 | All four provide essentially the same functionality, respectively for GTK, | |
|
3067 | Qt3, Qt4 and WXWidgets (via their Python interfaces). | |
|
3068 | \end_layout | |
|
2786 | 3069 | |
|
2787 | \SpecialChar ~ | |
|
3070 | \begin_layout List | |
|
3071 | \labelwidthstring 00.00.0000 | |
|
3072 | \InsetSpace ~ | |
|
2788 | 3073 | Note that with |
|
2789 |
\family typewriter |
|
|
3074 | \family typewriter | |
|
2790 | 3075 | -wthread |
|
2791 |
\family default |
|
|
3076 | \family default | |
|
2792 | 3077 | , you can additionally use the -wxversion option to request a specific version |
|
2793 | 3078 | of wx to be used. |
|
2794 | 3079 | This requires that you have the |
|
2795 |
\family typewriter |
|
|
3080 | \family typewriter | |
|
2796 | 3081 | wxversion |
|
2797 |
\family default |
|
|
3082 | \family default | |
|
2798 | 3083 | Python module installed, which is part of recent wxPython distributions. |
|
2799 |
\layou |
|
|
2800 | \labelwidthstring 00.00.0000 | |
|
3084 | \end_layout | |
|
2801 | 3085 | |
|
2802 | \SpecialChar ~ | |
|
3086 | \begin_layout List | |
|
3087 | \labelwidthstring 00.00.0000 | |
|
3088 | \InsetSpace ~ | |
|
2803 | 3089 | If |
|
2804 |
\family typewriter |
|
|
3090 | \family typewriter | |
|
2805 | 3091 | -pylab |
|
2806 |
\family default |
|
|
3092 | \family default | |
|
2807 | 3093 | is given, IPython loads special support for the mat plotlib library ( |
|
2808 | 3094 | \begin_inset LatexCommand \htmlurl{http://matplotlib.sourceforge.net} |
|
2809 | 3095 | |
|
2810 |
\end_inset |
|
|
3096 | \end_inset | |
|
2811 | 3097 | |
|
2812 | 3098 | ), allowing interactive usage of any of its backends as defined in the user's |
|
2813 | 3099 | |
|
2814 |
\family typewriter |
|
|
3100 | \family typewriter | |
|
2815 | 3101 | ~/.matplotlib/matplotlibrc |
|
2816 |
\family default |
|
|
3102 | \family default | |
|
2817 | 3103 | file. |
|
2818 | 3104 | It automatically activates GTK, Qt or WX threading for IPyhton if the choice |
|
2819 | 3105 | of matplotlib backend requires it. |
|
2820 | 3106 | It also modifies the |
|
2821 |
\family typewriter |
|
|
3107 | \family typewriter | |
|
2822 | 3108 | %run |
|
2823 |
\family default |
|
|
3109 | \family default | |
|
2824 | 3110 | command to correctly execute (without blocking) any matplotlib-based script |
|
2825 | 3111 | which calls |
|
2826 |
\family typewriter |
|
|
3112 | \family typewriter | |
|
2827 | 3113 | show() |
|
2828 |
\family default |
|
|
3114 | \family default | |
|
2829 | 3115 | at the end. |
|
2830 | 3116 | |
|
2831 |
\layou |
|
|
2832 | \labelwidthstring 00.00.0000 | |
|
3117 | \end_layout | |
|
2833 | 3118 | |
|
3119 | \begin_layout List | |
|
3120 | \labelwidthstring 00.00.0000 | |
|
2834 | 3121 | |
|
2835 |
\family typewriter |
|
|
2836 |
\series bold |
|
|
3122 | \family typewriter | |
|
3123 | \series bold | |
|
2837 | 3124 | -tk |
|
2838 |
\family default |
|
|
2839 |
\series default |
|
|
3125 | \family default | |
|
3126 | \series default | |
|
2840 | 3127 | The |
|
2841 |
\family typewriter |
|
|
2842 | -g/q/wthread | |
|
2843 |
\family default |
|
|
3128 | \family typewriter | |
|
3129 | -g/q/q4/wthread | |
|
3130 | \family default | |
|
2844 | 3131 | options, and |
|
2845 |
\family typewriter |
|
|
3132 | \family typewriter | |
|
2846 | 3133 | -pylab |
|
2847 |
\family default |
|
|
2848 |
(if matplotlib is configured to use GTK, Qt or WX), will normally |
|
|
2849 | Tk graphical interfaces. | |
|
3134 | \family default | |
|
3135 | (if matplotlib is configured to use GTK, Qt3, Qt4 or WX), will normally | |
|
3136 | block Tk graphical interfaces. | |
|
2850 | 3137 | This means that when either GTK, Qt or WX threading is active, any attempt |
|
2851 | 3138 | to open a Tk GUI will result in a dead window, and possibly cause the Python |
|
2852 | 3139 | interpreter to crash. |
|
2853 | 3140 | An extra option, |
|
2854 |
\family typewriter |
|
|
3141 | \family typewriter | |
|
2855 | 3142 | -tk |
|
2856 |
\family default |
|
|
3143 | \family default | |
|
2857 | 3144 | , is available to address this issue. |
|
2858 | 3145 | It can |
|
2859 |
\emph on |
|
|
3146 | \emph on | |
|
2860 | 3147 | only |
|
2861 |
\emph default |
|
|
3148 | \emph default | |
|
2862 | 3149 | be given as a |
|
2863 |
\emph on |
|
|
3150 | \emph on | |
|
2864 | 3151 | second |
|
2865 |
\emph default |
|
|
3152 | \emph default | |
|
2866 | 3153 | option after any of the above ( |
|
2867 |
\family typewriter |
|
|
3154 | \family typewriter | |
|
2868 | 3155 | -gthread |
|
2869 |
\family default |
|
|
3156 | \family default | |
|
2870 | 3157 | , |
|
2871 |
\family typewriter |
|
|
3158 | \family typewriter | |
|
2872 | 3159 | -wthread |
|
2873 |
\family default |
|
|
3160 | \family default | |
|
2874 | 3161 | or |
|
2875 |
\family typewriter |
|
|
3162 | \family typewriter | |
|
2876 | 3163 | -pylab |
|
2877 |
\family default |
|
|
3164 | \family default | |
|
2878 | 3165 | ). |
|
2879 |
\layou |
|
|
2880 | \labelwidthstring 00.00.0000 | |
|
3166 | \end_layout | |
|
2881 | 3167 | |
|
2882 | \SpecialChar ~ | |
|
3168 | \begin_layout List | |
|
3169 | \labelwidthstring 00.00.0000 | |
|
3170 | \InsetSpace ~ | |
|
2883 | 3171 | If |
|
2884 |
\family typewriter |
|
|
3172 | \family typewriter | |
|
2885 | 3173 | -tk |
|
2886 |
\family default |
|
|
3174 | \family default | |
|
2887 | 3175 | is given, IPython will try to coordinate Tk threading with GTK, Qt or WX. |
|
2888 | 3176 | This is however potentially unreliable, and you will have to test on your |
|
2889 | 3177 | platform and Python configuration to determine whether it works for you. |
@@ -2893,265 +3181,281 b' second' | |||
|
2893 | 3181 | caused random crashes and lockups of the Python interpreter. |
|
2894 | 3182 | Under other operating systems (Mac OSX and Windows), you'll need to try |
|
2895 | 3183 | it to find out, since currently no user reports are available. |
|
2896 |
\layou |
|
|
2897 | \labelwidthstring 00.00.0000 | |
|
3184 | \end_layout | |
|
2898 | 3185 | |
|
2899 | \SpecialChar ~ | |
|
3186 | \begin_layout List | |
|
3187 | \labelwidthstring 00.00.0000 | |
|
3188 | \InsetSpace ~ | |
|
2900 | 3189 | There is unfortunately no way for IPython to determine at run time whether |
|
2901 | 3190 | |
|
2902 |
\family typewriter |
|
|
3191 | \family typewriter | |
|
2903 | 3192 | -tk |
|
2904 |
\family default |
|
|
3193 | \family default | |
|
2905 | 3194 | will work reliably or not, so you will need to do some experiments before |
|
2906 | 3195 | relying on it for regular work. |
|
2907 | 3196 | |
|
2908 | \layout Subsection | |
|
2909 | ||
|
3197 | \end_layout | |
|
2910 | 3198 | |
|
3199 | \begin_layout Subsection | |
|
2911 | 3200 | \begin_inset LatexCommand \label{sec:cmd-line-opts} |
|
2912 | 3201 | |
|
2913 |
\end_inset |
|
|
3202 | \end_inset | |
|
2914 | 3203 | |
|
2915 | 3204 | Regular Options |
|
2916 | \layout Standard | |
|
3205 | \end_layout | |
|
2917 | 3206 | |
|
3207 | \begin_layout Standard | |
|
2918 | 3208 | After the above threading options have been given, regular options can follow |
|
2919 | 3209 | in any order. |
|
2920 | 3210 | All options can be abbreviated to their shortest non-ambiguous form and |
|
2921 | 3211 | are case-sensitive. |
|
2922 | 3212 | One or two dashes can be used. |
|
2923 | 3213 | Some options have an alternate short form, indicated after a |
|
2924 |
\family typewriter |
|
|
3214 | \family typewriter | |
|
2925 | 3215 | | |
|
2926 |
\family default |
|
|
3216 | \family default | |
|
2927 | 3217 | . |
|
2928 | \layout Standard | |
|
3218 | \end_layout | |
|
2929 | 3219 | |
|
3220 | \begin_layout Standard | |
|
2930 | 3221 | Most options can also be set from your ipythonrc configuration file. |
|
2931 | 3222 | See the provided example for more details on what the options do. |
|
2932 | 3223 | Options given at the command line override the values set in the ipythonrc |
|
2933 | 3224 | file. |
|
2934 | \layout Standard | |
|
3225 | \end_layout | |
|
2935 | 3226 | |
|
3227 | \begin_layout Standard | |
|
2936 | 3228 | All options with a |
|
2937 |
\family typewriter |
|
|
3229 | \family typewriter | |
|
2938 | 3230 | [no] |
|
2939 |
\family default |
|
|
3231 | \family default | |
|
2940 | 3232 | prepended can be specified in negated form ( |
|
2941 |
\family typewriter |
|
|
3233 | \family typewriter | |
|
2942 | 3234 | -nooption |
|
2943 |
\family default |
|
|
3235 | \family default | |
|
2944 | 3236 | instead of |
|
2945 |
\family typewriter |
|
|
3237 | \family typewriter | |
|
2946 | 3238 | -option |
|
2947 |
\family default |
|
|
3239 | \family default | |
|
2948 | 3240 | ) to turn the feature off. |
|
2949 |
\layou |
|
|
2950 | \labelwidthstring 00.00.0000 | |
|
3241 | \end_layout | |
|
2951 | 3242 | |
|
3243 | \begin_layout List | |
|
3244 | \labelwidthstring 00.00.0000 | |
|
2952 | 3245 | |
|
2953 |
\family typewriter |
|
|
2954 |
\series bold |
|
|
3246 | \family typewriter | |
|
3247 | \series bold | |
|
2955 | 3248 | -help |
|
2956 |
\family default |
|
|
2957 |
\series default |
|
|
3249 | \family default | |
|
3250 | \series default | |
|
2958 | 3251 | : print a help message and exit. |
|
2959 |
\layou |
|
|
2960 | \labelwidthstring 00.00.0000 | |
|
3252 | \end_layout | |
|
2961 | 3253 | |
|
3254 | \begin_layout List | |
|
3255 | \labelwidthstring 00.00.0000 | |
|
2962 | 3256 | |
|
2963 |
\family typewriter |
|
|
2964 |
\series bold |
|
|
3257 | \family typewriter | |
|
3258 | \series bold | |
|
2965 | 3259 | -pylab: |
|
2966 |
\family default |
|
|
2967 |
\series default |
|
|
3260 | \family default | |
|
3261 | \series default | |
|
2968 | 3262 | this can |
|
2969 |
\emph on |
|
|
3263 | \emph on | |
|
2970 | 3264 | only |
|
2971 |
\emph default |
|
|
3265 | \emph default | |
|
2972 | 3266 | be given as the |
|
2973 |
\emph on |
|
|
3267 | \emph on | |
|
2974 | 3268 | first |
|
2975 |
\emph default |
|
|
3269 | \emph default | |
|
2976 | 3270 | option passed to IPython (it will have no effect in any other position). |
|
2977 | 3271 | It adds special support for the matplotlib library ( |
|
2978 | 3272 | \begin_inset LatexCommand \htmlurl[http://matplotlib.sourceforge.net]{http://matplotlib.sourceforge.net} |
|
2979 | 3273 | |
|
2980 |
\end_inset |
|
|
3274 | \end_inset | |
|
2981 | 3275 | |
|
2982 | 3276 | ), allowing interactive usage of any of its backends as defined in the user's |
|
2983 | 3277 | |
|
2984 |
\family typewriter |
|
|
3278 | \family typewriter | |
|
2985 | 3279 | .matplotlibrc |
|
2986 |
\family default |
|
|
3280 | \family default | |
|
2987 | 3281 | file. |
|
2988 | 3282 | It automatically activates GTK or WX threading for IPyhton if the choice |
|
2989 | 3283 | of matplotlib backend requires it. |
|
2990 | 3284 | It also modifies the |
|
2991 |
\family typewriter |
|
|
3285 | \family typewriter | |
|
2992 | 3286 | %run |
|
2993 |
\family default |
|
|
3287 | \family default | |
|
2994 | 3288 | command to correctly execute (without blocking) any matplotlib-based script |
|
2995 | 3289 | which calls |
|
2996 |
\family typewriter |
|
|
3290 | \family typewriter | |
|
2997 | 3291 | show() |
|
2998 |
\family default |
|
|
3292 | \family default | |
|
2999 | 3293 | at the end. |
|
3000 |
See Sec.\ |
|
|
3294 | See Sec.\InsetSpace ~ | |
|
3001 | 3295 | |
|
3002 | 3296 | \begin_inset LatexCommand \ref{sec:matplotlib-support} |
|
3003 | 3297 | |
|
3004 |
\end_inset |
|
|
3298 | \end_inset | |
|
3005 | 3299 | |
|
3006 | 3300 | for more details. |
|
3007 |
\layou |
|
|
3008 | \labelwidthstring 00.00.0000 | |
|
3301 | \end_layout | |
|
3009 | 3302 | |
|
3303 | \begin_layout List | |
|
3304 | \labelwidthstring 00.00.0000 | |
|
3010 | 3305 | |
|
3011 |
\family typewriter |
|
|
3012 |
\series bold |
|
|
3306 | \family typewriter | |
|
3307 | \series bold | |
|
3013 | 3308 | -autocall <val>: |
|
3014 |
\family default |
|
|
3015 |
\series default |
|
|
3309 | \family default | |
|
3310 | \series default | |
|
3016 | 3311 | Make IPython automatically call any callable object even if you didn't |
|
3017 | 3312 | type explicit parentheses. |
|
3018 | 3313 | For example, `str 43' becomes `str(43)' automatically. |
|
3019 | 3314 | The value can be `0' to disable the feature, `1' for |
|
3020 |
\emph on |
|
|
3315 | \emph on | |
|
3021 | 3316 | smart |
|
3022 |
\emph default |
|
|
3317 | \emph default | |
|
3023 | 3318 | autocall, where it is not applied if there are no more arguments on the |
|
3024 | 3319 | line, and `2' for |
|
3025 |
\emph on |
|
|
3320 | \emph on | |
|
3026 | 3321 | full |
|
3027 |
\emph default |
|
|
3322 | \emph default | |
|
3028 | 3323 | autocall, where all callable objects are automatically called (even if |
|
3029 | 3324 | no arguments are present). |
|
3030 | 3325 | The default is `1'. |
|
3031 |
\layou |
|
|
3032 | \labelwidthstring 00.00.0000 | |
|
3326 | \end_layout | |
|
3033 | 3327 | |
|
3328 | \begin_layout List | |
|
3329 | \labelwidthstring 00.00.0000 | |
|
3034 | 3330 | |
|
3035 |
\family typewriter |
|
|
3036 |
\series bold |
|
|
3331 | \family typewriter | |
|
3332 | \series bold | |
|
3037 | 3333 | -[no]autoindent: |
|
3038 |
\family default |
|
|
3039 |
\series default |
|
|
3334 | \family default | |
|
3335 | \series default | |
|
3040 | 3336 | Turn automatic indentation on/off. |
|
3041 |
\layou |
|
|
3042 | \labelwidthstring 00.00.0000 | |
|
3337 | \end_layout | |
|
3043 | 3338 | |
|
3339 | \begin_layout List | |
|
3340 | \labelwidthstring 00.00.0000 | |
|
3044 | 3341 | |
|
3045 |
\family typewriter |
|
|
3046 |
\series bold |
|
|
3342 | \family typewriter | |
|
3343 | \series bold | |
|
3047 | 3344 | -[no]automagic |
|
3048 |
\series default |
|
|
3345 | \series default | |
|
3049 | 3346 | : |
|
3050 |
\family default |
|
|
3347 | \family default | |
|
3051 | 3348 | make magic commands automatic (without needing their first character to |
|
3052 | 3349 | be |
|
3053 |
\family typewriter |
|
|
3350 | \family typewriter | |
|
3054 | 3351 | % |
|
3055 |
\family default |
|
|
3352 | \family default | |
|
3056 | 3353 | ). |
|
3057 | 3354 | Type |
|
3058 |
\family typewriter |
|
|
3355 | \family typewriter | |
|
3059 | 3356 | %magic |
|
3060 |
\family default |
|
|
3357 | \family default | |
|
3061 | 3358 | at the IPython prompt for more information. |
|
3062 |
\layou |
|
|
3063 | \labelwidthstring 00.00.0000 | |
|
3359 | \end_layout | |
|
3064 | 3360 | |
|
3361 | \begin_layout List | |
|
3362 | \labelwidthstring 00.00.0000 | |
|
3065 | 3363 | |
|
3066 |
\family typewriter |
|
|
3067 |
\series bold |
|
|
3364 | \family typewriter | |
|
3365 | \series bold | |
|
3068 | 3366 | -[no]autoedit_syntax: |
|
3069 |
\family default |
|
|
3070 |
\series default |
|
|
3367 | \family default | |
|
3368 | \series default | |
|
3071 | 3369 | When a syntax error occurs after editing a file, automatically open the |
|
3072 | 3370 | file to the trouble causing line for convenient fixing. |
|
3073 | 3371 | |
|
3074 |
\layou |
|
|
3075 | \labelwidthstring 00.00.0000 | |
|
3372 | \end_layout | |
|
3076 | 3373 | |
|
3374 | \begin_layout List | |
|
3375 | \labelwidthstring 00.00.0000 | |
|
3077 | 3376 | |
|
3078 |
\family typewriter |
|
|
3079 |
\series bold |
|
|
3377 | \family typewriter | |
|
3378 | \series bold | |
|
3080 | 3379 | -[no]banner |
|
3081 |
\series default |
|
|
3380 | \series default | |
|
3082 | 3381 | : |
|
3083 |
\family default |
|
|
3382 | \family default | |
|
3084 | 3383 | Print the initial information banner (default on). |
|
3085 |
\layou |
|
|
3086 | \labelwidthstring 00.00.0000 | |
|
3384 | \end_layout | |
|
3087 | 3385 | |
|
3386 | \begin_layout List | |
|
3387 | \labelwidthstring 00.00.0000 | |
|
3088 | 3388 | |
|
3089 |
\family typewriter |
|
|
3090 |
\series bold |
|
|
3091 | -c\SpecialChar ~ | |
|
3389 | \family typewriter | |
|
3390 | \series bold | |
|
3391 | -c\InsetSpace ~ | |
|
3092 | 3392 | <command>: |
|
3093 |
\family default |
|
|
3094 |
\series default |
|
|
3393 | \family default | |
|
3394 | \series default | |
|
3095 | 3395 | execute the given command string, and set sys.argv to |
|
3096 |
\family typewriter |
|
|
3396 | \family typewriter | |
|
3097 | 3397 | ['c'] |
|
3098 |
\family default |
|
|
3398 | \family default | |
|
3099 | 3399 | . |
|
3100 | 3400 | This is similar to the |
|
3101 |
\family typewriter |
|
|
3401 | \family typewriter | |
|
3102 | 3402 | -c |
|
3103 |
\family default |
|
|
3403 | \family default | |
|
3104 | 3404 | option in the normal Python interpreter. |
|
3105 | 3405 | |
|
3106 |
\layou |
|
|
3107 | \labelwidthstring 00.00.0000 | |
|
3406 | \end_layout | |
|
3108 | 3407 | |
|
3408 | \begin_layout List | |
|
3409 | \labelwidthstring 00.00.0000 | |
|
3109 | 3410 | |
|
3110 |
\family typewriter |
|
|
3111 |
\series bold |
|
|
3112 |
-cache_size|cs\ |
|
|
3411 | \family typewriter | |
|
3412 | \series bold | |
|
3413 | -cache_size|cs\InsetSpace ~ | |
|
3113 | 3414 | <n> |
|
3114 |
\series default |
|
|
3415 | \series default | |
|
3115 | 3416 | : |
|
3116 |
\family default |
|
|
3417 | \family default | |
|
3117 | 3418 | size of the output cache (maximum number of entries to hold in memory). |
|
3118 | 3419 | The default is 1000, you can change it permanently in your config file. |
|
3119 | 3420 | Setting it to 0 completely disables the caching system, and the minimum |
|
3120 | 3421 | value accepted is 20 (if you provide a value less than 20, it is reset |
|
3121 | 3422 | to 0 and a warning is issued) This limit is defined because otherwise you'll |
|
3122 | 3423 | spend more time re-flushing a too small cache than working. |
|
3123 |
\layou |
|
|
3124 | \labelwidthstring 00.00.0000 | |
|
3424 | \end_layout | |
|
3125 | 3425 | |
|
3426 | \begin_layout List | |
|
3427 | \labelwidthstring 00.00.0000 | |
|
3126 | 3428 | |
|
3127 |
\family typewriter |
|
|
3128 |
\series bold |
|
|
3429 | \family typewriter | |
|
3430 | \series bold | |
|
3129 | 3431 | -classic|cl |
|
3130 |
\series default |
|
|
3432 | \series default | |
|
3131 | 3433 | : |
|
3132 |
\family default |
|
|
3434 | \family default | |
|
3133 | 3435 | Gives IPython a similar feel to the classic Python prompt. |
|
3134 |
\layou |
|
|
3135 | \labelwidthstring 00.00.0000 | |
|
3436 | \end_layout | |
|
3136 | 3437 | |
|
3438 | \begin_layout List | |
|
3439 | \labelwidthstring 00.00.0000 | |
|
3137 | 3440 | |
|
3138 |
\family typewriter |
|
|
3139 |
\series bold |
|
|
3140 |
-colors\ |
|
|
3441 | \family typewriter | |
|
3442 | \series bold | |
|
3443 | -colors\InsetSpace ~ | |
|
3141 | 3444 | <scheme>: |
|
3142 |
\family default |
|
|
3143 |
\series default |
|
|
3445 | \family default | |
|
3446 | \series default | |
|
3144 | 3447 | Color scheme for prompts and exception reporting. |
|
3145 | 3448 | Currently implemented: NoColor, Linux and LightBG. |
|
3146 |
\layou |
|
|
3147 | \labelwidthstring 00.00.0000 | |
|
3449 | \end_layout | |
|
3148 | 3450 | |
|
3451 | \begin_layout List | |
|
3452 | \labelwidthstring 00.00.0000 | |
|
3149 | 3453 | |
|
3150 |
\family typewriter |
|
|
3151 |
\series bold |
|
|
3454 | \family typewriter | |
|
3455 | \series bold | |
|
3152 | 3456 | -[no]color_info: |
|
3153 |
\family default |
|
|
3154 |
\series default |
|
|
3457 | \family default | |
|
3458 | \series default | |
|
3155 | 3459 | IPython can display information about objects via a set of functions, and |
|
3156 | 3460 | optionally can use colors for this, syntax highlighting source code and |
|
3157 | 3461 | various other elements. |
@@ -3161,510 +3465,539 b' full' | |||
|
3161 | 3465 | works for you. |
|
3162 | 3466 | As a reference, the 'less' pager supplied with Mandrake 8.2 works ok, but |
|
3163 | 3467 | that in RedHat 7.2 doesn't. |
|
3164 |
\layou |
|
|
3165 | \labelwidthstring 00.00.0000 | |
|
3468 | \end_layout | |
|
3166 | 3469 | |
|
3167 | \SpecialChar ~ | |
|
3470 | \begin_layout List | |
|
3471 | \labelwidthstring 00.00.0000 | |
|
3472 | \InsetSpace ~ | |
|
3168 | 3473 | Test it and turn it on permanently if it works with your system. |
|
3169 | 3474 | The magic function |
|
3170 |
\family typewriter |
|
|
3475 | \family typewriter | |
|
3171 | 3476 | %color_info |
|
3172 |
\family default |
|
|
3477 | \family default | |
|
3173 | 3478 | allows you to toggle this interactively for testing. |
|
3174 |
\layou |
|
|
3175 | \labelwidthstring 00.00.0000 | |
|
3479 | \end_layout | |
|
3176 | 3480 | |
|
3481 | \begin_layout List | |
|
3482 | \labelwidthstring 00.00.0000 | |
|
3177 | 3483 | |
|
3178 |
\family typewriter |
|
|
3179 |
\series bold |
|
|
3484 | \family typewriter | |
|
3485 | \series bold | |
|
3180 | 3486 | -[no]debug |
|
3181 |
\family default |
|
|
3182 |
\series default |
|
|
3487 | \family default | |
|
3488 | \series default | |
|
3183 | 3489 | : Show information about the loading process. |
|
3184 | 3490 | Very useful to pin down problems with your configuration files or to get |
|
3185 | 3491 | details about session restores. |
|
3186 |
\layou |
|
|
3187 | \labelwidthstring 00.00.0000 | |
|
3492 | \end_layout | |
|
3188 | 3493 | |
|
3494 | \begin_layout List | |
|
3495 | \labelwidthstring 00.00.0000 | |
|
3189 | 3496 | |
|
3190 |
\family typewriter |
|
|
3191 |
\series bold |
|
|
3497 | \family typewriter | |
|
3498 | \series bold | |
|
3192 | 3499 | -[no]deep_reload |
|
3193 |
\series default |
|
|
3500 | \series default | |
|
3194 | 3501 | : |
|
3195 |
\family default |
|
|
3502 | \family default | |
|
3196 | 3503 | IPython can use the |
|
3197 |
\family typewriter |
|
|
3504 | \family typewriter | |
|
3198 | 3505 | deep_reload |
|
3199 |
\family default |
|
|
3506 | \family default | |
|
3200 | 3507 | module which reloads changes in modules recursively (it replaces the |
|
3201 |
\family typewriter |
|
|
3508 | \family typewriter | |
|
3202 | 3509 | reload() |
|
3203 |
\family default |
|
|
3510 | \family default | |
|
3204 | 3511 | function, so you don't need to change anything to use it). |
|
3205 | 3512 | |
|
3206 |
\family typewriter |
|
|
3513 | \family typewriter | |
|
3207 | 3514 | deep_reload() |
|
3208 |
\family default |
|
|
3515 | \family default | |
|
3209 | 3516 | forces a full reload of modules whose code may have changed, which the |
|
3210 | 3517 | default |
|
3211 |
\family typewriter |
|
|
3518 | \family typewriter | |
|
3212 | 3519 | reload() |
|
3213 |
\family default |
|
|
3520 | \family default | |
|
3214 | 3521 | function does not. |
|
3215 |
\layou |
|
|
3216 | \labelwidthstring 00.00.0000 | |
|
3522 | \end_layout | |
|
3217 | 3523 | |
|
3218 | \SpecialChar ~ | |
|
3524 | \begin_layout List | |
|
3525 | \labelwidthstring 00.00.0000 | |
|
3526 | \InsetSpace ~ | |
|
3219 | 3527 | When deep_reload is off, IPython will use the normal |
|
3220 |
\family typewriter |
|
|
3528 | \family typewriter | |
|
3221 | 3529 | reload() |
|
3222 |
\family default |
|
|
3530 | \family default | |
|
3223 | 3531 | , but deep_reload will still be available as |
|
3224 |
\family typewriter |
|
|
3532 | \family typewriter | |
|
3225 | 3533 | dreload() |
|
3226 |
\family default |
|
|
3534 | \family default | |
|
3227 | 3535 | . |
|
3228 | 3536 | This feature is off by default [which means that you have both normal |
|
3229 |
\family typewriter |
|
|
3537 | \family typewriter | |
|
3230 | 3538 | reload() |
|
3231 |
\family default |
|
|
3539 | \family default | |
|
3232 | 3540 | and |
|
3233 |
\family typewriter |
|
|
3541 | \family typewriter | |
|
3234 | 3542 | dreload() |
|
3235 |
\family default |
|
|
3543 | \family default | |
|
3236 | 3544 | ]. |
|
3237 |
\layou |
|
|
3238 | \labelwidthstring 00.00.0000 | |
|
3545 | \end_layout | |
|
3239 | 3546 | |
|
3547 | \begin_layout List | |
|
3548 | \labelwidthstring 00.00.0000 | |
|
3240 | 3549 | |
|
3241 |
\family typewriter |
|
|
3242 |
\series bold |
|
|
3243 |
-editor\ |
|
|
3550 | \family typewriter | |
|
3551 | \series bold | |
|
3552 | -editor\InsetSpace ~ | |
|
3244 | 3553 | <name> |
|
3245 |
\family default |
|
|
3246 |
\series default |
|
|
3554 | \family default | |
|
3555 | \series default | |
|
3247 | 3556 | : Which editor to use with the |
|
3248 |
\family typewriter |
|
|
3557 | \family typewriter | |
|
3249 | 3558 | %edit |
|
3250 |
\family default |
|
|
3559 | \family default | |
|
3251 | 3560 | command. |
|
3252 | 3561 | By default, IPython will honor your |
|
3253 |
\family typewriter |
|
|
3562 | \family typewriter | |
|
3254 | 3563 | EDITOR |
|
3255 |
\family default |
|
|
3564 | \family default | |
|
3256 | 3565 | environment variable (if not set, vi is the Unix default and notepad the |
|
3257 | 3566 | Windows one). |
|
3258 | 3567 | Since this editor is invoked on the fly by IPython and is meant for editing |
|
3259 | 3568 | small code snippets, you may want to use a small, lightweight editor here |
|
3260 | 3569 | (in case your default |
|
3261 |
\family typewriter |
|
|
3570 | \family typewriter | |
|
3262 | 3571 | EDITOR |
|
3263 |
\family default |
|
|
3572 | \family default | |
|
3264 | 3573 | is something like Emacs). |
|
3265 |
\layou |
|
|
3266 | \labelwidthstring 00.00.0000 | |
|
3574 | \end_layout | |
|
3267 | 3575 | |
|
3576 | \begin_layout List | |
|
3577 | \labelwidthstring 00.00.0000 | |
|
3268 | 3578 | |
|
3269 |
\family typewriter |
|
|
3270 |
\series bold |
|
|
3271 |
-ipythondir\ |
|
|
3579 | \family typewriter | |
|
3580 | \series bold | |
|
3581 | -ipythondir\InsetSpace ~ | |
|
3272 | 3582 | <name> |
|
3273 |
\series default |
|
|
3583 | \series default | |
|
3274 | 3584 | : |
|
3275 |
\family default |
|
|
3585 | \family default | |
|
3276 | 3586 | name of your IPython configuration directory |
|
3277 |
\family typewriter |
|
|
3587 | \family typewriter | |
|
3278 | 3588 | IPYTHONDIR |
|
3279 |
\family default |
|
|
3589 | \family default | |
|
3280 | 3590 | . |
|
3281 | 3591 | This can also be specified through the environment variable |
|
3282 |
\family typewriter |
|
|
3592 | \family typewriter | |
|
3283 | 3593 | IPYTHONDIR |
|
3284 |
\family default |
|
|
3594 | \family default | |
|
3285 | 3595 | . |
|
3286 |
\layou |
|
|
3287 | \labelwidthstring 00.00.0000 | |
|
3596 | \end_layout | |
|
3288 | 3597 | |
|
3598 | \begin_layout List | |
|
3599 | \labelwidthstring 00.00.0000 | |
|
3289 | 3600 | |
|
3290 |
\family typewriter |
|
|
3291 |
\series bold |
|
|
3601 | \family typewriter | |
|
3602 | \series bold | |
|
3292 | 3603 | -log|l |
|
3293 |
\family default |
|
|
3294 |
\series default |
|
|
3604 | \family default | |
|
3605 | \series default | |
|
3295 | 3606 | : generate a log file of all input. |
|
3296 | 3607 | The file is named |
|
3297 |
\family typewriter |
|
|
3608 | \family typewriter | |
|
3298 | 3609 | ipython_log.py |
|
3299 |
\family default |
|
|
3610 | \family default | |
|
3300 | 3611 | in your current directory (which prevents logs from multiple IPython sessions |
|
3301 | 3612 | from trampling each other). |
|
3302 | 3613 | You can use this to later restore a session by loading your logfile as |
|
3303 | 3614 | a file to be executed with option |
|
3304 |
\family typewriter |
|
|
3615 | \family typewriter | |
|
3305 | 3616 | -logplay |
|
3306 |
\family default |
|
|
3617 | \family default | |
|
3307 | 3618 | (see below). |
|
3308 |
\layou |
|
|
3309 | \labelwidthstring 00.00.0000 | |
|
3619 | \end_layout | |
|
3310 | 3620 | |
|
3621 | \begin_layout List | |
|
3622 | \labelwidthstring 00.00.0000 | |
|
3311 | 3623 | |
|
3312 |
\family typewriter |
|
|
3313 |
\series bold |
|
|
3314 |
-logfile|lf\ |
|
|
3624 | \family typewriter | |
|
3625 | \series bold | |
|
3626 | -logfile|lf\InsetSpace ~ | |
|
3315 | 3627 | <name> |
|
3316 |
\series default |
|
|
3628 | \series default | |
|
3317 | 3629 | : |
|
3318 |
\family default |
|
|
3630 | \family default | |
|
3319 | 3631 | specify the name of your logfile. |
|
3320 |
\layou |
|
|
3321 | \labelwidthstring 00.00.0000 | |
|
3632 | \end_layout | |
|
3322 | 3633 | |
|
3634 | \begin_layout List | |
|
3635 | \labelwidthstring 00.00.0000 | |
|
3323 | 3636 | |
|
3324 |
\family typewriter |
|
|
3325 |
\series bold |
|
|
3326 |
-logplay|lp\ |
|
|
3637 | \family typewriter | |
|
3638 | \series bold | |
|
3639 | -logplay|lp\InsetSpace ~ | |
|
3327 | 3640 | <name> |
|
3328 |
\series default |
|
|
3641 | \series default | |
|
3329 | 3642 | : |
|
3330 |
\family default |
|
|
3643 | \family default | |
|
3331 | 3644 | you can replay a previous log. |
|
3332 | 3645 | For restoring a session as close as possible to the state you left it in, |
|
3333 | 3646 | use this option (don't just run the logfile). |
|
3334 | 3647 | With |
|
3335 |
\family typewriter |
|
|
3648 | \family typewriter | |
|
3336 | 3649 | -logplay |
|
3337 |
\family default |
|
|
3650 | \family default | |
|
3338 | 3651 | , IPython will try to reconstruct the previous working environment in full, |
|
3339 | 3652 | not just execute the commands in the logfile. |
|
3340 |
\layou |
|
|
3341 | \labelwidthstring 00.00.0000 | |
|
3653 | \end_layout | |
|
3342 | 3654 | |
|
3343 | \SpecialChar ~ | |
|
3655 | \begin_layout List | |
|
3656 | \labelwidthstring 00.00.0000 | |
|
3657 | \InsetSpace ~ | |
|
3344 | 3658 | When a session is restored, logging is automatically turned on again with |
|
3345 | 3659 | the name of the logfile it was invoked with (it is read from the log header). |
|
3346 | 3660 | So once you've turned logging on for a session, you can quit IPython and |
|
3347 | 3661 | reload it as many times as you want and it will continue to log its history |
|
3348 | 3662 | and restore from the beginning every time. |
|
3349 |
\layou |
|
|
3350 | \labelwidthstring 00.00.0000 | |
|
3663 | \end_layout | |
|
3351 | 3664 | |
|
3352 | \SpecialChar ~ | |
|
3665 | \begin_layout List | |
|
3666 | \labelwidthstring 00.00.0000 | |
|
3667 | \InsetSpace ~ | |
|
3353 | 3668 | Caveats: there are limitations in this option. |
|
3354 | 3669 | The history variables |
|
3355 |
\family typewriter |
|
|
3670 | \family typewriter | |
|
3356 | 3671 | _i* |
|
3357 |
\family default |
|
|
3672 | \family default | |
|
3358 | 3673 | , |
|
3359 |
\family typewriter |
|
|
3674 | \family typewriter | |
|
3360 | 3675 | _* |
|
3361 |
\family default |
|
|
3676 | \family default | |
|
3362 | 3677 | and |
|
3363 |
\family typewriter |
|
|
3678 | \family typewriter | |
|
3364 | 3679 | _dh |
|
3365 |
\family default |
|
|
3680 | \family default | |
|
3366 | 3681 | don't get restored properly. |
|
3367 | 3682 | In the future we will try to implement full session saving by writing and |
|
3368 | 3683 | retrieving a 'snapshot' of the memory state of IPython. |
|
3369 | 3684 | But our first attempts failed because of inherent limitations of Python's |
|
3370 | 3685 | Pickle module, so this may have to wait. |
|
3371 |
\layou |
|
|
3372 | \labelwidthstring 00.00.0000 | |
|
3686 | \end_layout | |
|
3373 | 3687 | |
|
3688 | \begin_layout List | |
|
3689 | \labelwidthstring 00.00.0000 | |
|
3374 | 3690 | |
|
3375 |
\family typewriter |
|
|
3376 |
\series bold |
|
|
3691 | \family typewriter | |
|
3692 | \series bold | |
|
3377 | 3693 | -[no]messages |
|
3378 |
\series default |
|
|
3694 | \series default | |
|
3379 | 3695 | : |
|
3380 |
\family default |
|
|
3696 | \family default | |
|
3381 | 3697 | Print messages which IPython collects about its startup process (default |
|
3382 | 3698 | on). |
|
3383 |
\layou |
|
|
3384 | \labelwidthstring 00.00.0000 | |
|
3699 | \end_layout | |
|
3385 | 3700 | |
|
3701 | \begin_layout List | |
|
3702 | \labelwidthstring 00.00.0000 | |
|
3386 | 3703 | |
|
3387 |
\family typewriter |
|
|
3388 |
\series bold |
|
|
3704 | \family typewriter | |
|
3705 | \series bold | |
|
3389 | 3706 | -[no]pdb |
|
3390 |
\family default |
|
|
3391 |
\series default |
|
|
3707 | \family default | |
|
3708 | \series default | |
|
3392 | 3709 | : Automatically call the pdb debugger after every uncaught exception. |
|
3393 | 3710 | If you are used to debugging using pdb, this puts you automatically inside |
|
3394 | 3711 | of it after any call (either in IPython or in code called by it) which |
|
3395 | 3712 | triggers an exception which goes uncaught. |
|
3396 |
\layou |
|
|
3397 | \labelwidthstring 00.00.0000 | |
|
3713 | \end_layout | |
|
3398 | 3714 | |
|
3715 | \begin_layout List | |
|
3716 | \labelwidthstring 00.00.0000 | |
|
3399 | 3717 | |
|
3400 |
\family typewriter |
|
|
3401 |
\series bold |
|
|
3718 | \family typewriter | |
|
3719 | \series bold | |
|
3402 | 3720 | -[no]pprint |
|
3403 |
\series default |
|
|
3721 | \series default | |
|
3404 | 3722 | : |
|
3405 |
\family default |
|
|
3723 | \family default | |
|
3406 | 3724 | ipython can optionally use the pprint (pretty printer) module for displaying |
|
3407 | 3725 | results. |
|
3408 | 3726 | pprint tends to give a nicer display of nested data structures. |
|
3409 | 3727 | If you like it, you can turn it on permanently in your config file (default |
|
3410 | 3728 | off). |
|
3411 |
\layou |
|
|
3412 | \labelwidthstring 00.00.0000 | |
|
3729 | \end_layout | |
|
3413 | 3730 | |
|
3731 | \begin_layout List | |
|
3732 | \labelwidthstring 00.00.0000 | |
|
3414 | 3733 | |
|
3415 |
\family typewriter |
|
|
3416 |
\series bold |
|
|
3734 | \family typewriter | |
|
3735 | \series bold | |
|
3417 | 3736 | -profile|p <name> |
|
3418 |
\series default |
|
|
3737 | \series default | |
|
3419 | 3738 | : |
|
3420 |
\family default |
|
|
3739 | \family default | |
|
3421 | 3740 | assume that your config file is |
|
3422 |
\family typewriter |
|
|
3741 | \family typewriter | |
|
3423 | 3742 | ipythonrc-<name> |
|
3424 |
\family default |
|
|
3743 | \family default | |
|
3425 | 3744 | (looks in current dir first, then in |
|
3426 |
\family typewriter |
|
|
3745 | \family typewriter | |
|
3427 | 3746 | IPYTHONDIR |
|
3428 |
\family default |
|
|
3747 | \family default | |
|
3429 | 3748 | ). |
|
3430 | 3749 | This is a quick way to keep and load multiple config files for different |
|
3431 | 3750 | tasks, especially if you use the include option of config files. |
|
3432 | 3751 | You can keep a basic |
|
3433 |
\family typewriter |
|
|
3752 | \family typewriter | |
|
3434 | 3753 | IPYTHONDIR/ipythonrc |
|
3435 |
\family default |
|
|
3754 | \family default | |
|
3436 | 3755 | file and then have other 'profiles' which include this one and load extra |
|
3437 | 3756 | things for particular tasks. |
|
3438 | 3757 | For example: |
|
3439 |
\layou |
|
|
3440 | \labelwidthstring 00.00.0000 | |
|
3758 | \end_layout | |
|
3441 | 3759 | |
|
3760 | \begin_layout List | |
|
3761 | \labelwidthstring 00.00.0000 | |
|
3442 | 3762 | |
|
3443 |
\family typewriter |
|
|
3444 | \SpecialChar ~ | |
|
3763 | \family typewriter | |
|
3764 | \InsetSpace ~ | |
|
3445 | 3765 | |
|
3446 |
\family default |
|
|
3766 | \family default | |
|
3447 | 3767 | 1. |
|
3448 | 3768 | |
|
3449 |
\family typewriter |
|
|
3769 | \family typewriter | |
|
3450 | 3770 | $HOME/.ipython/ipythonrc |
|
3451 |
\family default |
|
|
3771 | \family default | |
|
3452 | 3772 | : load basic things you always want. |
|
3453 |
\layou |
|
|
3454 | \labelwidthstring 00.00.0000 | |
|
3773 | \end_layout | |
|
3455 | 3774 | |
|
3775 | \begin_layout List | |
|
3776 | \labelwidthstring 00.00.0000 | |
|
3456 | 3777 | |
|
3457 |
\family typewriter |
|
|
3458 | \SpecialChar ~ | |
|
3778 | \family typewriter | |
|
3779 | \InsetSpace ~ | |
|
3459 | 3780 | |
|
3460 |
\family default |
|
|
3781 | \family default | |
|
3461 | 3782 | 2. |
|
3462 | 3783 | |
|
3463 |
\family typewriter |
|
|
3784 | \family typewriter | |
|
3464 | 3785 | $HOME/.ipython/ipythonrc-math |
|
3465 |
\family default |
|
|
3786 | \family default | |
|
3466 | 3787 | : load (1) and basic math-related modules. |
|
3467 | 3788 | |
|
3468 |
\layou |
|
|
3469 | \labelwidthstring 00.00.0000 | |
|
3789 | \end_layout | |
|
3470 | 3790 | |
|
3791 | \begin_layout List | |
|
3792 | \labelwidthstring 00.00.0000 | |
|
3471 | 3793 | |
|
3472 |
\family typewriter |
|
|
3473 | \SpecialChar ~ | |
|
3794 | \family typewriter | |
|
3795 | \InsetSpace ~ | |
|
3474 | 3796 | |
|
3475 |
\family default |
|
|
3797 | \family default | |
|
3476 | 3798 | 3. |
|
3477 | 3799 | |
|
3478 |
\family typewriter |
|
|
3800 | \family typewriter | |
|
3479 | 3801 | $HOME/.ipython/ipythonrc-numeric |
|
3480 |
\family default |
|
|
3802 | \family default | |
|
3481 | 3803 | : load (1) and Numeric and plotting modules. |
|
3482 |
\layou |
|
|
3483 | \labelwidthstring 00.00.0000 | |
|
3804 | \end_layout | |
|
3484 | 3805 | |
|
3485 | \SpecialChar ~ | |
|
3806 | \begin_layout List | |
|
3807 | \labelwidthstring 00.00.0000 | |
|
3808 | \InsetSpace ~ | |
|
3486 | 3809 | Since it is possible to create an endless loop by having circular file |
|
3487 | 3810 | inclusions, IPython will stop if it reaches 15 recursive inclusions. |
|
3488 |
\layou |
|
|
3489 | \labelwidthstring 00.00.0000 | |
|
3811 | \end_layout | |
|
3490 | 3812 | |
|
3813 | \begin_layout List | |
|
3814 | \labelwidthstring 00.00.0000 | |
|
3491 | 3815 | |
|
3492 |
\family typewriter |
|
|
3493 |
\series bold |
|
|
3494 |
-prompt_in1|pi1\ |
|
|
3816 | \family typewriter | |
|
3817 | \series bold | |
|
3818 | -prompt_in1|pi1\InsetSpace ~ | |
|
3495 | 3819 | <string>: |
|
3496 |
\family default |
|
|
3497 |
\series default |
|
|
3820 | \family default | |
|
3821 | \series default | |
|
3498 | 3822 | Specify the string used for input prompts. |
|
3499 | 3823 | Note that if you are using numbered prompts, the number is represented |
|
3500 | 3824 | with a ' |
|
3501 |
\backslash |
|
|
3825 | \backslash | |
|
3502 | 3826 | #' in the string. |
|
3503 | 3827 | Don't forget to quote strings with spaces embedded in them. |
|
3504 | 3828 | Default: ' |
|
3505 |
\family typewriter |
|
|
3506 | In\SpecialChar ~ | |
|
3829 | \family typewriter | |
|
3830 | In\InsetSpace ~ | |
|
3507 | 3831 | [ |
|
3508 |
\backslash |
|
|
3832 | \backslash | |
|
3509 | 3833 | #]: |
|
3510 |
\family default |
|
|
3834 | \family default | |
|
3511 | 3835 | '. |
|
3512 |
Sec.\ |
|
|
3836 | Sec.\InsetSpace ~ | |
|
3513 | 3837 | |
|
3514 | 3838 | \begin_inset LatexCommand \ref{sec:prompts} |
|
3515 | 3839 | |
|
3516 |
\end_inset |
|
|
3840 | \end_inset | |
|
3517 | 3841 | |
|
3518 | 3842 | discusses in detail all the available escapes to customize your prompts. |
|
3519 |
\layou |
|
|
3520 | \labelwidthstring 00.00.0000 | |
|
3843 | \end_layout | |
|
3521 | 3844 | |
|
3845 | \begin_layout List | |
|
3846 | \labelwidthstring 00.00.0000 | |
|
3522 | 3847 | |
|
3523 |
\family typewriter |
|
|
3524 |
\series bold |
|
|
3525 |
-prompt_in2|pi2\ |
|
|
3848 | \family typewriter | |
|
3849 | \series bold | |
|
3850 | -prompt_in2|pi2\InsetSpace ~ | |
|
3526 | 3851 | <string>: |
|
3527 |
\family default |
|
|
3528 |
\series default |
|
|
3852 | \family default | |
|
3853 | \series default | |
|
3529 | 3854 | Similar to the previous option, but used for the continuation prompts. |
|
3530 | 3855 | The special sequence ' |
|
3531 |
\family typewriter |
|
|
3856 | \family typewriter | |
|
3532 | 3857 | |
|
3533 |
\backslash |
|
|
3858 | \backslash | |
|
3534 | 3859 | D |
|
3535 |
\family default |
|
|
3860 | \family default | |
|
3536 | 3861 | ' is similar to ' |
|
3537 |
\family typewriter |
|
|
3862 | \family typewriter | |
|
3538 | 3863 | |
|
3539 |
\backslash |
|
|
3864 | \backslash | |
|
3540 | 3865 | # |
|
3541 |
\family default |
|
|
3866 | \family default | |
|
3542 | 3867 | ', but with all digits replaced dots (so you can have your continuation |
|
3543 | 3868 | prompt aligned with your input prompt). |
|
3544 | 3869 | Default: ' |
|
3545 |
\family typewriter |
|
|
3546 | \SpecialChar ~ | |
|
3547 | \SpecialChar ~ | |
|
3548 | \SpecialChar ~ | |
|
3870 | \family typewriter | |
|
3871 | \InsetSpace ~ | |
|
3872 | \InsetSpace ~ | |
|
3873 | \InsetSpace ~ | |
|
3549 | 3874 | . |
|
3550 |
\backslash |
|
|
3875 | \backslash | |
|
3551 | 3876 | D.: |
|
3552 |
\family default |
|
|
3877 | \family default | |
|
3553 | 3878 | ' (note three spaces at the start for alignment with ' |
|
3554 |
\family typewriter |
|
|
3555 | In\SpecialChar ~ | |
|
3879 | \family typewriter | |
|
3880 | In\InsetSpace ~ | |
|
3556 | 3881 | [ |
|
3557 |
\backslash |
|
|
3882 | \backslash | |
|
3558 | 3883 | #] |
|
3559 |
\family default |
|
|
3884 | \family default | |
|
3560 | 3885 | '). |
|
3561 |
\layou |
|
|
3562 | \labelwidthstring 00.00.0000 | |
|
3886 | \end_layout | |
|
3563 | 3887 | |
|
3888 | \begin_layout List | |
|
3889 | \labelwidthstring 00.00.0000 | |
|
3564 | 3890 | |
|
3565 |
\family typewriter |
|
|
3566 |
\series bold |
|
|
3567 |
-prompt_out|po\ |
|
|
3891 | \family typewriter | |
|
3892 | \series bold | |
|
3893 | -prompt_out|po\InsetSpace ~ | |
|
3568 | 3894 | <string>: |
|
3569 |
\family default |
|
|
3570 |
\series default |
|
|
3895 | \family default | |
|
3896 | \series default | |
|
3571 | 3897 | String used for output prompts, also uses numbers like |
|
3572 |
\family typewriter |
|
|
3898 | \family typewriter | |
|
3573 | 3899 | prompt_in1 |
|
3574 |
\family default |
|
|
3900 | \family default | |
|
3575 | 3901 | . |
|
3576 | 3902 | Default: ' |
|
3577 |
\family typewriter |
|
|
3903 | \family typewriter | |
|
3578 | 3904 | Out[ |
|
3579 |
\backslash |
|
|
3905 | \backslash | |
|
3580 | 3906 | #]: |
|
3581 |
\family default |
|
|
3907 | \family default | |
|
3582 | 3908 | ' |
|
3583 |
\layou |
|
|
3584 | \labelwidthstring 00.00.0000 | |
|
3909 | \end_layout | |
|
3585 | 3910 | |
|
3911 | \begin_layout List | |
|
3912 | \labelwidthstring 00.00.0000 | |
|
3586 | 3913 | |
|
3587 |
\family typewriter |
|
|
3588 |
\series bold |
|
|
3914 | \family typewriter | |
|
3915 | \series bold | |
|
3589 | 3916 | -quick |
|
3590 |
\family default |
|
|
3591 |
\series default |
|
|
3917 | \family default | |
|
3918 | \series default | |
|
3592 | 3919 | : start in bare bones mode (no config file loaded). |
|
3593 |
\layou |
|
|
3594 | \labelwidthstring 00.00.0000 | |
|
3920 | \end_layout | |
|
3595 | 3921 | |
|
3922 | \begin_layout List | |
|
3923 | \labelwidthstring 00.00.0000 | |
|
3596 | 3924 | |
|
3597 |
\family typewriter |
|
|
3598 |
\series bold |
|
|
3599 |
-rcfile\ |
|
|
3925 | \family typewriter | |
|
3926 | \series bold | |
|
3927 | -rcfile\InsetSpace ~ | |
|
3600 | 3928 | <name> |
|
3601 |
\series default |
|
|
3929 | \series default | |
|
3602 | 3930 | : |
|
3603 |
\family default |
|
|
3931 | \family default | |
|
3604 | 3932 | name of your IPython resource configuration file. |
|
3605 | 3933 | Normally IPython loads ipythonrc (from current directory) or |
|
3606 |
\family typewriter |
|
|
3934 | \family typewriter | |
|
3607 | 3935 | IPYTHONDIR/ipythonrc |
|
3608 |
\family default |
|
|
3936 | \family default | |
|
3609 | 3937 | . |
|
3610 |
\layou |
|
|
3611 | \labelwidthstring 00.00.0000 | |
|
3938 | \end_layout | |
|
3612 | 3939 | |
|
3613 | \SpecialChar ~ | |
|
3940 | \begin_layout List | |
|
3941 | \labelwidthstring 00.00.0000 | |
|
3942 | \InsetSpace ~ | |
|
3614 | 3943 | If the loading of your config file fails, IPython starts with a bare bones |
|
3615 | 3944 | configuration (no modules loaded at all). |
|
3616 |
\layou |
|
|
3617 | \labelwidthstring 00.00.0000 | |
|
3945 | \end_layout | |
|
3618 | 3946 | |
|
3947 | \begin_layout List | |
|
3948 | \labelwidthstring 00.00.0000 | |
|
3619 | 3949 | |
|
3620 |
\family typewriter |
|
|
3621 |
\series bold |
|
|
3950 | \family typewriter | |
|
3951 | \series bold | |
|
3622 | 3952 | -[no]readline |
|
3623 |
\family default |
|
|
3624 |
\series default |
|
|
3953 | \family default | |
|
3954 | \series default | |
|
3625 | 3955 | : use the readline library, which is needed to support name completion and |
|
3626 | 3956 | command history, among other things. |
|
3627 | 3957 | It is enabled by default, but may cause problems for users of X/Emacs in |
|
3628 | 3958 | Python comint or shell buffers. |
|
3629 |
\layou |
|
|
3630 | \labelwidthstring 00.00.0000 | |
|
3959 | \end_layout | |
|
3631 | 3960 | |
|
3632 | \SpecialChar ~ | |
|
3961 | \begin_layout List | |
|
3962 | \labelwidthstring 00.00.0000 | |
|
3963 | \InsetSpace ~ | |
|
3633 | 3964 | Note that X/Emacs 'eterm' buffers (opened with |
|
3634 |
\family typewriter |
|
|
3635 | M-x\SpecialChar ~ | |
|
3965 | \family typewriter | |
|
3966 | M-x\InsetSpace ~ | |
|
3636 | 3967 | term |
|
3637 |
\family default |
|
|
3968 | \family default | |
|
3638 | 3969 | ) support IPython's readline and syntax coloring fine, only 'emacs' ( |
|
3639 |
\family typewriter |
|
|
3640 | M-x\SpecialChar ~ | |
|
3970 | \family typewriter | |
|
3971 | M-x\InsetSpace ~ | |
|
3641 | 3972 | shell |
|
3642 |
\family default |
|
|
3973 | \family default | |
|
3643 | 3974 | and |
|
3644 |
\family typewriter |
|
|
3645 | C-c\SpecialChar ~ | |
|
3975 | \family typewriter | |
|
3976 | C-c\InsetSpace ~ | |
|
3646 | 3977 | ! |
|
3647 |
\family default |
|
|
3978 | \family default | |
|
3648 | 3979 | ) buffers do not. |
|
3649 |
\layou |
|
|
3650 | \labelwidthstring 00.00.0000 | |
|
3980 | \end_layout | |
|
3651 | 3981 | |
|
3982 | \begin_layout List | |
|
3983 | \labelwidthstring 00.00.0000 | |
|
3652 | 3984 | |
|
3653 |
\family typewriter |
|
|
3654 |
\series bold |
|
|
3655 |
-screen_length|sl\ |
|
|
3985 | \family typewriter | |
|
3986 | \series bold | |
|
3987 | -screen_length|sl\InsetSpace ~ | |
|
3656 | 3988 | <n> |
|
3657 |
\series default |
|
|
3989 | \series default | |
|
3658 | 3990 | : |
|
3659 |
\family default |
|
|
3991 | \family default | |
|
3660 | 3992 | number of lines of your screen. |
|
3661 | 3993 | This is used to control printing of very long strings. |
|
3662 | 3994 | Strings longer than this number of lines will be sent through a pager instead |
|
3663 | 3995 | of directly printed. |
|
3664 |
\layou |
|
|
3665 | \labelwidthstring 00.00.0000 | |
|
3996 | \end_layout | |
|
3666 | 3997 | |
|
3667 | \SpecialChar ~ | |
|
3998 | \begin_layout List | |
|
3999 | \labelwidthstring 00.00.0000 | |
|
4000 | \InsetSpace ~ | |
|
3668 | 4001 | The default value for this is 0, which means IPython will auto-detect your |
|
3669 | 4002 | screen size every time it needs to print certain potentially long strings |
|
3670 | 4003 | (this doesn't change the behavior of the 'print' keyword, it's only triggered |
@@ -3672,152 +4005,165 b' C-c\\SpecialChar ~' | |||
|
3672 | 4005 | If for some reason this isn't working well (it needs curses support), specify |
|
3673 | 4006 | it yourself. |
|
3674 | 4007 | Otherwise don't change the default. |
|
3675 |
\layou |
|
|
3676 | \labelwidthstring 00.00.0000 | |
|
4008 | \end_layout | |
|
3677 | 4009 | |
|
4010 | \begin_layout List | |
|
4011 | \labelwidthstring 00.00.0000 | |
|
3678 | 4012 | |
|
3679 |
\family typewriter |
|
|
3680 |
\series bold |
|
|
3681 |
-separate_in|si\ |
|
|
4013 | \family typewriter | |
|
4014 | \series bold | |
|
4015 | -separate_in|si\InsetSpace ~ | |
|
3682 | 4016 | <string> |
|
3683 |
\series default |
|
|
4017 | \series default | |
|
3684 | 4018 | : |
|
3685 |
\family default |
|
|
4019 | \family default | |
|
3686 | 4020 | separator before input prompts. |
|
3687 | 4021 | Default: ' |
|
3688 |
\family typewriter |
|
|
4022 | \family typewriter | |
|
3689 | 4023 | |
|
3690 |
\backslash |
|
|
4024 | \backslash | |
|
3691 | 4025 | n |
|
3692 |
\family default |
|
|
4026 | \family default | |
|
3693 | 4027 | ' |
|
3694 |
\layou |
|
|
3695 | \labelwidthstring 00.00.0000 | |
|
4028 | \end_layout | |
|
3696 | 4029 | |
|
4030 | \begin_layout List | |
|
4031 | \labelwidthstring 00.00.0000 | |
|
3697 | 4032 | |
|
3698 |
\family typewriter |
|
|
3699 |
\series bold |
|
|
3700 |
-separate_out|so\ |
|
|
4033 | \family typewriter | |
|
4034 | \series bold | |
|
4035 | -separate_out|so\InsetSpace ~ | |
|
3701 | 4036 | <string> |
|
3702 |
\family default |
|
|
3703 |
\series default |
|
|
4037 | \family default | |
|
4038 | \series default | |
|
3704 | 4039 | : separator before output prompts. |
|
3705 | 4040 | Default: nothing. |
|
3706 |
\layou |
|
|
3707 | \labelwidthstring 00.00.0000 | |
|
4041 | \end_layout | |
|
3708 | 4042 | |
|
4043 | \begin_layout List | |
|
4044 | \labelwidthstring 00.00.0000 | |
|
3709 | 4045 | |
|
3710 |
\family typewriter |
|
|
3711 |
\series bold |
|
|
3712 |
-separate_out2|so2\ |
|
|
4046 | \family typewriter | |
|
4047 | \series bold | |
|
4048 | -separate_out2|so2\InsetSpace ~ | |
|
3713 | 4049 | <string> |
|
3714 |
\series default |
|
|
4050 | \series default | |
|
3715 | 4051 | : |
|
3716 |
\family default |
|
|
4052 | \family default | |
|
3717 | 4053 | separator after output prompts. |
|
3718 | 4054 | Default: nothing. |
|
3719 |
\layou |
|
|
3720 | \labelwidthstring 00.00.0000 | |
|
4055 | \end_layout | |
|
3721 | 4056 | |
|
3722 | \SpecialChar ~ | |
|
3723 | For these three options, use the value 0 to specify no separator. | |
|
3724 | \layout List | |
|
4057 | \begin_layout List | |
|
3725 | 4058 | \labelwidthstring 00.00.0000 |
|
4059 | \InsetSpace ~ | |
|
4060 | For these three options, use the value 0 to specify no separator. | |
|
4061 | \end_layout | |
|
3726 | 4062 | |
|
4063 | \begin_layout List | |
|
4064 | \labelwidthstring 00.00.0000 | |
|
3727 | 4065 | |
|
3728 |
\family typewriter |
|
|
3729 |
\series bold |
|
|
4066 | \family typewriter | |
|
4067 | \series bold | |
|
3730 | 4068 | -nosep |
|
3731 |
\series default |
|
|
4069 | \series default | |
|
3732 | 4070 | : |
|
3733 |
\family default |
|
|
4071 | \family default | |
|
3734 | 4072 | shorthand for |
|
3735 |
\family typewriter |
|
|
4073 | \family typewriter | |
|
3736 | 4074 | '-SeparateIn 0 -SeparateOut 0 -SeparateOut2 0' |
|
3737 |
\family default |
|
|
4075 | \family default | |
|
3738 | 4076 | . |
|
3739 | 4077 | Simply removes all input/output separators. |
|
3740 |
\layou |
|
|
3741 | \labelwidthstring 00.00.0000 | |
|
4078 | \end_layout | |
|
3742 | 4079 | |
|
4080 | \begin_layout List | |
|
4081 | \labelwidthstring 00.00.0000 | |
|
3743 | 4082 | |
|
3744 |
\family typewriter |
|
|
3745 |
\series bold |
|
|
4083 | \family typewriter | |
|
4084 | \series bold | |
|
3746 | 4085 | -upgrade |
|
3747 |
\family default |
|
|
3748 |
\series default |
|
|
4086 | \family default | |
|
4087 | \series default | |
|
3749 | 4088 | : allows you to upgrade your |
|
3750 |
\family typewriter |
|
|
4089 | \family typewriter | |
|
3751 | 4090 | IPYTHONDIR |
|
3752 |
\family default |
|
|
4091 | \family default | |
|
3753 | 4092 | configuration when you install a new version of IPython. |
|
3754 | 4093 | Since new versions may include new command line options or example files, |
|
3755 | 4094 | this copies updated ipythonrc-type files. |
|
3756 | 4095 | However, it backs up (with a |
|
3757 |
\family typewriter |
|
|
4096 | \family typewriter | |
|
3758 | 4097 | .old |
|
3759 |
\family default |
|
|
4098 | \family default | |
|
3760 | 4099 | extension) all files which it overwrites so that you can merge back any |
|
3761 | 4100 | customizations you might have in your personal files. |
|
3762 |
\layou |
|
|
3763 | \labelwidthstring 00.00.0000 | |
|
4101 | \end_layout | |
|
3764 | 4102 | |
|
4103 | \begin_layout List | |
|
4104 | \labelwidthstring 00.00.0000 | |
|
3765 | 4105 | |
|
3766 |
\family typewriter |
|
|
3767 |
\series bold |
|
|
4106 | \family typewriter | |
|
4107 | \series bold | |
|
3768 | 4108 | -Version |
|
3769 |
\series default |
|
|
4109 | \series default | |
|
3770 | 4110 | : |
|
3771 |
\family default |
|
|
4111 | \family default | |
|
3772 | 4112 | print version information and exit. |
|
3773 |
\layou |
|
|
3774 | \labelwidthstring 00.00.0000 | |
|
4113 | \end_layout | |
|
3775 | 4114 | |
|
4115 | \begin_layout List | |
|
4116 | \labelwidthstring 00.00.0000 | |
|
3776 | 4117 | |
|
3777 |
\family typewriter |
|
|
3778 |
\series bold |
|
|
3779 |
-wxversion\ |
|
|
4118 | \family typewriter | |
|
4119 | \series bold | |
|
4120 | -wxversion\InsetSpace ~ | |
|
3780 | 4121 | <string>: |
|
3781 |
\family default |
|
|
3782 |
\series default |
|
|
4122 | \family default | |
|
4123 | \series default | |
|
3783 | 4124 | Select a specific version of wxPython (used in conjunction with |
|
3784 |
\family typewriter |
|
|
4125 | \family typewriter | |
|
3785 | 4126 | -wthread |
|
3786 |
\family default |
|
|
4127 | \family default | |
|
3787 | 4128 | ). |
|
3788 | 4129 | Requires the wxversion module, part of recent wxPython distributions |
|
3789 |
\layou |
|
|
3790 | \labelwidthstring 00.00.0000 | |
|
4130 | \end_layout | |
|
3791 | 4131 | |
|
4132 | \begin_layout List | |
|
4133 | \labelwidthstring 00.00.0000 | |
|
3792 | 4134 | |
|
3793 |
\family typewriter |
|
|
3794 |
\series bold |
|
|
3795 |
-xmode\ |
|
|
4135 | \family typewriter | |
|
4136 | \series bold | |
|
4137 | -xmode\InsetSpace ~ | |
|
3796 | 4138 | <modename> |
|
3797 |
\series default |
|
|
4139 | \series default | |
|
3798 | 4140 | : |
|
3799 |
\family default |
|
|
4141 | \family default | |
|
3800 | 4142 | Mode for exception reporting. |
|
3801 |
\layou |
|
|
3802 | \labelwidthstring 00.00.0000 | |
|
4143 | \end_layout | |
|
3803 | 4144 | |
|
3804 | \SpecialChar ~ | |
|
3805 | Valid modes: Plain, Context and Verbose. | |
|
3806 | \layout List | |
|
4145 | \begin_layout List | |
|
3807 | 4146 | \labelwidthstring 00.00.0000 |
|
4147 | \InsetSpace ~ | |
|
4148 | Valid modes: Plain, Context and Verbose. | |
|
4149 | \end_layout | |
|
3808 | 4150 | |
|
3809 | \SpecialChar ~ | |
|
3810 | Plain: similar to python's normal traceback printing. | |
|
3811 | \layout List | |
|
4151 | \begin_layout List | |
|
3812 | 4152 | \labelwidthstring 00.00.0000 |
|
4153 | \InsetSpace ~ | |
|
4154 | Plain: similar to python's normal traceback printing. | |
|
4155 | \end_layout | |
|
3813 | 4156 | |
|
3814 | \SpecialChar ~ | |
|
4157 | \begin_layout List | |
|
4158 | \labelwidthstring 00.00.0000 | |
|
4159 | \InsetSpace ~ | |
|
3815 | 4160 | Context: prints 5 lines of context source code around each line in the |
|
3816 | 4161 | traceback. |
|
3817 |
\layou |
|
|
3818 | \labelwidthstring 00.00.0000 | |
|
4162 | \end_layout | |
|
3819 | 4163 | |
|
3820 | \SpecialChar ~ | |
|
4164 | \begin_layout List | |
|
4165 | \labelwidthstring 00.00.0000 | |
|
4166 | \InsetSpace ~ | |
|
3821 | 4167 | Verbose: similar to Context, but additionally prints the variables currently |
|
3822 | 4168 | visible where the exception happened (shortening their strings if too long). |
|
3823 | 4169 | This can potentially be very slow, if you happen to have a huge data structure |
@@ -3825,27 +4171,30 b' IPYTHONDIR' | |||
|
3825 | 4171 | Your computer may appear to freeze for a while with cpu usage at 100%. |
|
3826 | 4172 | If this occurs, you can cancel the traceback with Ctrl-C (maybe hitting |
|
3827 | 4173 | it more than once). |
|
3828 | \layout Section | |
|
4174 | \end_layout | |
|
3829 | 4175 | |
|
4176 | \begin_layout Section | |
|
3830 | 4177 | Interactive use |
|
3831 | \layout Standard | |
|
4178 | \end_layout | |
|
3832 | 4179 | |
|
4180 | \begin_layout Standard | |
|
3833 | 4181 | |
|
3834 |
\series bold |
|
|
4182 | \series bold | |
|
3835 | 4183 | Warning |
|
3836 |
\series default |
|
|
4184 | \series default | |
|
3837 | 4185 | : IPython relies on the existence of a global variable called |
|
3838 |
\family typewriter |
|
|
4186 | \family typewriter | |
|
3839 | 4187 | __IP |
|
3840 |
\family default |
|
|
4188 | \family default | |
|
3841 | 4189 | which controls the shell itself. |
|
3842 | 4190 | If you redefine |
|
3843 |
\family typewriter |
|
|
4191 | \family typewriter | |
|
3844 | 4192 | __IP |
|
3845 |
\family default |
|
|
4193 | \family default | |
|
3846 | 4194 | to anything, bizarre behavior will quickly occur. |
|
3847 | \layout Standard | |
|
4195 | \end_layout | |
|
3848 | 4196 | |
|
4197 | \begin_layout Standard | |
|
3849 | 4198 | Other than the above warning, IPython is meant to work as a drop-in replacement |
|
3850 | 4199 | for the standard interactive interpreter. |
|
3851 | 4200 | As such, any code which is valid python should execute normally under IPython |
@@ -3853,651 +4202,715 b' Other than the above warning, IPython is meant to work as a drop-in replacement' | |||
|
3853 | 4202 | It does, however, offer many features which are not available at a standard |
|
3854 | 4203 | python prompt. |
|
3855 | 4204 | What follows is a list of these. |
|
3856 | \layout Subsection | |
|
4205 | \end_layout | |
|
3857 | 4206 | |
|
4207 | \begin_layout Subsection | |
|
3858 | 4208 | Caution for Windows users |
|
3859 | \layout Standard | |
|
4209 | \end_layout | |
|
3860 | 4210 | |
|
4211 | \begin_layout Standard | |
|
3861 | 4212 | Windows, unfortunately, uses the ` |
|
3862 |
\family typewriter |
|
|
4213 | \family typewriter | |
|
3863 | 4214 | |
|
3864 |
\backslash |
|
|
4215 | \backslash | |
|
3865 | 4216 | |
|
3866 |
\family default |
|
|
4217 | \family default | |
|
3867 | 4218 | ' character as a path separator. |
|
3868 | 4219 | This is a terrible choice, because ` |
|
3869 |
\family typewriter |
|
|
4220 | \family typewriter | |
|
3870 | 4221 | |
|
3871 |
\backslash |
|
|
4222 | \backslash | |
|
3872 | 4223 | |
|
3873 |
\family default |
|
|
4224 | \family default | |
|
3874 | 4225 | ' also represents the escape character in most modern programming languages, |
|
3875 | 4226 | including Python. |
|
3876 | 4227 | For this reason, issuing many of the commands discussed below (especially |
|
3877 | 4228 | magics which affect the filesystem) with ` |
|
3878 |
\family typewriter |
|
|
4229 | \family typewriter | |
|
3879 | 4230 | |
|
3880 |
\backslash |
|
|
4231 | \backslash | |
|
3881 | 4232 | |
|
3882 |
\family default |
|
|
4233 | \family default | |
|
3883 | 4234 | ' in them will cause strange errors. |
|
3884 | \layout Standard | |
|
4235 | \end_layout | |
|
3885 | 4236 | |
|
4237 | \begin_layout Standard | |
|
3886 | 4238 | A partial solution is to use instead the ` |
|
3887 |
\family typewriter |
|
|
4239 | \family typewriter | |
|
3888 | 4240 | / |
|
3889 |
\family default |
|
|
4241 | \family default | |
|
3890 | 4242 | ' character as a path separator, which Windows recognizes in |
|
3891 |
\emph on |
|
|
4243 | \emph on | |
|
3892 | 4244 | most |
|
3893 |
\emph default |
|
|
4245 | \emph default | |
|
3894 | 4246 | situations. |
|
3895 | 4247 | However, in Windows commands ` |
|
3896 |
\family typewriter |
|
|
4248 | \family typewriter | |
|
3897 | 4249 | / |
|
3898 |
\family default |
|
|
4250 | \family default | |
|
3899 | 4251 | ' flags options, so you can not use it for the root directory. |
|
3900 | 4252 | This means that paths beginning at the root must be typed in a contrived |
|
3901 | 4253 | manner like: |
|
3902 |
\newline |
|
|
4254 | \newline | |
|
3903 | 4255 | |
|
3904 |
\family typewriter |
|
|
4256 | \family typewriter | |
|
3905 | 4257 | %copy |
|
3906 |
\backslash |
|
|
4258 | \backslash | |
|
3907 | 4259 | opt/foo/bar.txt |
|
3908 |
\backslash |
|
|
4260 | \backslash | |
|
3909 | 4261 | tmp |
|
3910 | \layout Standard | |
|
4262 | \end_layout | |
|
3911 | 4263 | |
|
4264 | \begin_layout Standard | |
|
3912 | 4265 | There is no sensible thing IPython can do to truly work around this flaw |
|
3913 | 4266 | in Windows |
|
3914 | 4267 | \begin_inset Foot |
|
3915 |
collapsed |
|
|
3916 | ||
|
3917 | \layout Standard | |
|
4268 | status collapsed | |
|
3918 | 4269 | |
|
4270 | \begin_layout Standard | |
|
3919 | 4271 | If anyone comes up with a |
|
3920 |
\emph on |
|
|
4272 | \emph on | |
|
3921 | 4273 | clean |
|
3922 |
\emph default |
|
|
4274 | \emph default | |
|
3923 | 4275 | solution which works consistently and does not negatively impact other |
|
3924 | 4276 | platforms at all, I'll gladly accept a patch. |
|
3925 | \end_inset | |
|
4277 | \end_layout | |
|
3926 | 4278 | |
|
3927 | . | |
|
3928 | \layout Subsection | |
|
4279 | \end_inset | |
|
3929 | 4280 | |
|
4281 | . | |
|
4282 | \end_layout | |
|
3930 | 4283 | |
|
4284 | \begin_layout Subsection | |
|
3931 | 4285 | \begin_inset LatexCommand \label{sec:magic} |
|
3932 | 4286 | |
|
3933 |
\end_inset |
|
|
4287 | \end_inset | |
|
3934 | 4288 | |
|
3935 | 4289 | Magic command system |
|
3936 | \layout Standard | |
|
4290 | \end_layout | |
|
3937 | 4291 | |
|
4292 | \begin_layout Standard | |
|
3938 | 4293 | IPython will treat any line whose first character is a |
|
3939 |
\family typewriter |
|
|
4294 | \family typewriter | |
|
3940 | 4295 | % |
|
3941 |
\family default |
|
|
4296 | \family default | |
|
3942 | 4297 | as a special call to a 'magic' function. |
|
3943 | 4298 | These allow you to control the behavior of IPython itself, plus a lot of |
|
3944 | 4299 | system-type features. |
|
3945 | 4300 | They are all prefixed with a |
|
3946 |
\family typewriter |
|
|
4301 | \family typewriter | |
|
3947 | 4302 | % |
|
3948 |
\family default |
|
|
4303 | \family default | |
|
3949 | 4304 | character, but parameters are given without parentheses or quotes. |
|
3950 | \layout Standard | |
|
4305 | \end_layout | |
|
3951 | 4306 | |
|
4307 | \begin_layout Standard | |
|
3952 | 4308 | Example: typing |
|
3953 |
\family typewriter |
|
|
4309 | \family typewriter | |
|
3954 | 4310 | '%cd mydir' |
|
3955 |
\family default |
|
|
4311 | \family default | |
|
3956 | 4312 | (without the quotes) changes you working directory to |
|
3957 |
\family typewriter |
|
|
4313 | \family typewriter | |
|
3958 | 4314 | 'mydir' |
|
3959 |
\family default |
|
|
4315 | \family default | |
|
3960 | 4316 | , if it exists. |
|
3961 | \layout Standard | |
|
4317 | \end_layout | |
|
3962 | 4318 | |
|
4319 | \begin_layout Standard | |
|
3963 | 4320 | If you have 'automagic' enabled (in your |
|
3964 |
\family typewriter |
|
|
4321 | \family typewriter | |
|
3965 | 4322 | ipythonrc |
|
3966 |
\family default |
|
|
4323 | \family default | |
|
3967 | 4324 | file, via the command line option |
|
3968 |
\family typewriter |
|
|
4325 | \family typewriter | |
|
3969 | 4326 | -automagic |
|
3970 |
\family default |
|
|
4327 | \family default | |
|
3971 | 4328 | or with the |
|
3972 |
\family typewriter |
|
|
4329 | \family typewriter | |
|
3973 | 4330 | %automagic |
|
3974 |
\family default |
|
|
4331 | \family default | |
|
3975 | 4332 | function), you don't need to type in the |
|
3976 |
\family typewriter |
|
|
4333 | \family typewriter | |
|
3977 | 4334 | % |
|
3978 |
\family default |
|
|
4335 | \family default | |
|
3979 | 4336 | explicitly. |
|
3980 | 4337 | IPython will scan its internal list of magic functions and call one if |
|
3981 | 4338 | it exists. |
|
3982 | 4339 | With automagic on you can then just type ' |
|
3983 |
\family typewriter |
|
|
4340 | \family typewriter | |
|
3984 | 4341 | cd mydir |
|
3985 |
\family default |
|
|
4342 | \family default | |
|
3986 | 4343 | ' to go to directory ' |
|
3987 |
\family typewriter |
|
|
4344 | \family typewriter | |
|
3988 | 4345 | mydir |
|
3989 |
\family default |
|
|
4346 | \family default | |
|
3990 | 4347 | '. |
|
3991 | 4348 | The automagic system has the lowest possible precedence in name searches, |
|
3992 | 4349 | so defining an identifier with the same name as an existing magic function |
|
3993 | 4350 | will shadow it for automagic use. |
|
3994 | 4351 | You can still access the shadowed magic function by explicitly using the |
|
3995 | 4352 | |
|
3996 |
\family typewriter |
|
|
4353 | \family typewriter | |
|
3997 | 4354 | % |
|
3998 |
\family default |
|
|
4355 | \family default | |
|
3999 | 4356 | character at the beginning of the line. |
|
4000 | \layout Standard | |
|
4357 | \end_layout | |
|
4001 | 4358 | |
|
4359 | \begin_layout Standard | |
|
4002 | 4360 | An example (with automagic on) should clarify all this: |
|
4003 | \layout LyX-Code | |
|
4361 | \end_layout | |
|
4004 | 4362 | |
|
4363 | \begin_layout LyX-Code | |
|
4005 | 4364 | In [1]: cd ipython # %cd is called by automagic |
|
4006 | \layout LyX-Code | |
|
4365 | \end_layout | |
|
4007 | 4366 | |
|
4367 | \begin_layout LyX-Code | |
|
4008 | 4368 | /home/fperez/ipython |
|
4009 | \layout LyX-Code | |
|
4369 | \end_layout | |
|
4010 | 4370 | |
|
4371 | \begin_layout LyX-Code | |
|
4011 | 4372 | In [2]: cd=1 # now cd is just a variable |
|
4012 | \layout LyX-Code | |
|
4373 | \end_layout | |
|
4013 | 4374 | |
|
4375 | \begin_layout LyX-Code | |
|
4014 | 4376 | In [3]: cd .. |
|
4015 | 4377 | # and doesn't work as a function anymore |
|
4016 | \layout LyX-Code | |
|
4378 | \end_layout | |
|
4017 | 4379 | |
|
4380 | \begin_layout LyX-Code | |
|
4018 | 4381 | ------------------------------------------------------------ |
|
4019 | \layout LyX-Code | |
|
4382 | \end_layout | |
|
4020 | 4383 | |
|
4384 | \begin_layout LyX-Code | |
|
4021 | 4385 | File "<console>", line 1 |
|
4022 | \layout LyX-Code | |
|
4386 | \end_layout | |
|
4023 | 4387 | |
|
4388 | \begin_layout LyX-Code | |
|
4024 | 4389 | cd .. |
|
4025 | \layout LyX-Code | |
|
4390 | \end_layout | |
|
4026 | 4391 | |
|
4392 | \begin_layout LyX-Code | |
|
4027 | 4393 | ^ |
|
4028 | \layout LyX-Code | |
|
4394 | \end_layout | |
|
4029 | 4395 | |
|
4396 | \begin_layout LyX-Code | |
|
4030 | 4397 | SyntaxError: invalid syntax |
|
4031 | \layout LyX-Code | |
|
4398 | \end_layout | |
|
4399 | ||
|
4400 | \begin_layout LyX-Code | |
|
4032 | 4401 | |
|
4033 | \layout LyX-Code | |
|
4402 | \end_layout | |
|
4034 | 4403 | |
|
4404 | \begin_layout LyX-Code | |
|
4035 | 4405 | In [4]: %cd .. |
|
4036 | 4406 | # but %cd always works |
|
4037 | \layout LyX-Code | |
|
4407 | \end_layout | |
|
4038 | 4408 | |
|
4409 | \begin_layout LyX-Code | |
|
4039 | 4410 | /home/fperez |
|
4040 | \layout LyX-Code | |
|
4411 | \end_layout | |
|
4041 | 4412 | |
|
4413 | \begin_layout LyX-Code | |
|
4042 | 4414 | In [5]: del cd # if you remove the cd variable |
|
4043 | \layout LyX-Code | |
|
4415 | \end_layout | |
|
4044 | 4416 | |
|
4417 | \begin_layout LyX-Code | |
|
4045 | 4418 | In [6]: cd ipython # automagic can work again |
|
4046 | \layout LyX-Code | |
|
4419 | \end_layout | |
|
4047 | 4420 | |
|
4421 | \begin_layout LyX-Code | |
|
4048 | 4422 | /home/fperez/ipython |
|
4049 | \layout Standard | |
|
4423 | \end_layout | |
|
4050 | 4424 | |
|
4425 | \begin_layout Standard | |
|
4051 | 4426 | You can define your own magic functions to extend the system. |
|
4052 | 4427 | The following is a snippet of code which shows how to do it. |
|
4053 | 4428 | It is provided as file |
|
4054 |
\family typewriter |
|
|
4429 | \family typewriter | |
|
4055 | 4430 | example-magic.py |
|
4056 |
\family default |
|
|
4431 | \family default | |
|
4057 | 4432 | in the examples directory: |
|
4058 | \layout Standard | |
|
4059 | ||
|
4433 | \end_layout | |
|
4060 | 4434 | |
|
4435 | \begin_layout Standard | |
|
4061 | 4436 | \begin_inset ERT |
|
4062 |
status |
|
|
4437 | status open | |
|
4438 | ||
|
4439 | \begin_layout Standard | |
|
4063 | 4440 | |
|
4064 | \layout Standard | |
|
4065 | 4441 | |
|
4066 |
\backslash |
|
|
4442 | \backslash | |
|
4067 | 4443 | codelist{examples/example-magic.py} |
|
4068 | \end_inset | |
|
4444 | \end_layout | |
|
4445 | ||
|
4446 | \end_inset | |
|
4069 | 4447 | |
|
4070 | 4448 | |
|
4071 | \layout Standard | |
|
4449 | \end_layout | |
|
4072 | 4450 | |
|
4451 | \begin_layout Standard | |
|
4073 | 4452 | You can also define your own aliased names for magic functions. |
|
4074 | 4453 | In your |
|
4075 |
\family typewriter |
|
|
4454 | \family typewriter | |
|
4076 | 4455 | ipythonrc |
|
4077 |
\family default |
|
|
4456 | \family default | |
|
4078 | 4457 | file, placing a line like: |
|
4079 | \layout Standard | |
|
4458 | \end_layout | |
|
4080 | 4459 | |
|
4460 | \begin_layout Standard | |
|
4081 | 4461 | |
|
4082 |
\family typewriter |
|
|
4462 | \family typewriter | |
|
4083 | 4463 | execute __IP.magic_cl = __IP.magic_clear |
|
4084 | \layout Standard | |
|
4464 | \end_layout | |
|
4085 | 4465 | |
|
4466 | \begin_layout Standard | |
|
4086 | 4467 | will define |
|
4087 |
\family typewriter |
|
|
4468 | \family typewriter | |
|
4088 | 4469 | %cl |
|
4089 |
\family default |
|
|
4470 | \family default | |
|
4090 | 4471 | as a new name for |
|
4091 |
\family typewriter |
|
|
4472 | \family typewriter | |
|
4092 | 4473 | %clear |
|
4093 |
\family default |
|
|
4474 | \family default | |
|
4094 | 4475 | . |
|
4095 | \layout Standard | |
|
4476 | \end_layout | |
|
4096 | 4477 | |
|
4478 | \begin_layout Standard | |
|
4097 | 4479 | Type |
|
4098 |
\family typewriter |
|
|
4480 | \family typewriter | |
|
4099 | 4481 | %magic |
|
4100 |
\family default |
|
|
4482 | \family default | |
|
4101 | 4483 | for more information, including a list of all available magic functions |
|
4102 | 4484 | at any time and their docstrings. |
|
4103 | 4485 | You can also type |
|
4104 |
\family typewriter |
|
|
4486 | \family typewriter | |
|
4105 | 4487 | %magic_function_name? |
|
4106 |
\family default |
|
|
4488 | \family default | |
|
4107 | 4489 | (see sec. |
|
4108 | 4490 | |
|
4109 | 4491 | \begin_inset LatexCommand \ref{sec:dyn-object-info} |
|
4110 | 4492 | |
|
4111 |
\end_inset |
|
|
4493 | \end_inset | |
|
4112 | 4494 | |
|
4113 | 4495 | for information on the |
|
4114 |
\family typewriter |
|
|
4496 | \family typewriter | |
|
4115 | 4497 | '?' |
|
4116 |
\family default |
|
|
4498 | \family default | |
|
4117 | 4499 | system) to get information about any particular magic function you are |
|
4118 | 4500 | interested in. |
|
4119 | \layout Subsubsection | |
|
4501 | \end_layout | |
|
4120 | 4502 | |
|
4503 | \begin_layout Subsubsection | |
|
4121 | 4504 | Magic commands |
|
4122 | \layout Standard | |
|
4505 | \end_layout | |
|
4123 | 4506 | |
|
4507 | \begin_layout Standard | |
|
4124 | 4508 | The rest of this section is automatically generated for each release from |
|
4125 | 4509 | the docstrings in the IPython code. |
|
4126 | 4510 | Therefore the formatting is somewhat minimal, but this method has the advantage |
|
4127 | 4511 | of having information always in sync with the code. |
|
4128 | \layout Standard | |
|
4512 | \end_layout | |
|
4129 | 4513 | |
|
4514 | \begin_layout Standard | |
|
4130 | 4515 | A list of all the magic commands available in IPython's |
|
4131 |
\emph on |
|
|
4516 | \emph on | |
|
4132 | 4517 | default |
|
4133 |
\emph default |
|
|
4518 | \emph default | |
|
4134 | 4519 | installation follows. |
|
4135 | 4520 | This is similar to what you'll see by simply typing |
|
4136 |
\family typewriter |
|
|
4521 | \family typewriter | |
|
4137 | 4522 | %magic |
|
4138 |
\family default |
|
|
4523 | \family default | |
|
4139 | 4524 | at the prompt, but that will also give you information about magic commands |
|
4140 | 4525 | you may have added as part of your personal customizations. |
|
4141 | \layout Standard | |
|
4142 | ||
|
4526 | \end_layout | |
|
4143 | 4527 | |
|
4528 | \begin_layout Standard | |
|
4144 | 4529 | \begin_inset Include \input{magic.tex} |
|
4145 | 4530 | preview false |
|
4146 | 4531 | |
|
4147 |
\end_inset |
|
|
4532 | \end_inset | |
|
4148 | 4533 | |
|
4149 | 4534 | |
|
4150 | \layout Subsection | |
|
4535 | \end_layout | |
|
4151 | 4536 | |
|
4537 | \begin_layout Subsection | |
|
4152 | 4538 | Access to the standard Python help |
|
4153 | \layout Standard | |
|
4539 | \end_layout | |
|
4154 | 4540 | |
|
4541 | \begin_layout Standard | |
|
4155 | 4542 | As of Python 2.1, a help system is available with access to object docstrings |
|
4156 | 4543 | and the Python manuals. |
|
4157 | 4544 | Simply type |
|
4158 |
\family typewriter |
|
|
4545 | \family typewriter | |
|
4159 | 4546 | 'help' |
|
4160 |
\family default |
|
|
4547 | \family default | |
|
4161 | 4548 | (no quotes) to access it. |
|
4162 | 4549 | You can also type |
|
4163 |
\family typewriter |
|
|
4550 | \family typewriter | |
|
4164 | 4551 | help(object) |
|
4165 |
\family default |
|
|
4552 | \family default | |
|
4166 | 4553 | to obtain information about a given object, and |
|
4167 |
\family typewriter |
|
|
4554 | \family typewriter | |
|
4168 | 4555 | help('keyword') |
|
4169 |
\family default |
|
|
4556 | \family default | |
|
4170 | 4557 | for information on a keyword. |
|
4171 | 4558 | As noted in sec. |
|
4172 | 4559 | |
|
4173 | 4560 | \begin_inset LatexCommand \ref{sec:help-access} |
|
4174 | 4561 | |
|
4175 |
\end_inset |
|
|
4562 | \end_inset | |
|
4176 | 4563 | |
|
4177 | 4564 | , you need to properly configure your environment variable |
|
4178 |
\family typewriter |
|
|
4565 | \family typewriter | |
|
4179 | 4566 | PYTHONDOCS |
|
4180 |
\family default |
|
|
4567 | \family default | |
|
4181 | 4568 | for this feature to work correctly. |
|
4182 | \layout Subsection | |
|
4183 | ||
|
4569 | \end_layout | |
|
4184 | 4570 | |
|
4571 | \begin_layout Subsection | |
|
4185 | 4572 | \begin_inset LatexCommand \label{sec:dyn-object-info} |
|
4186 | 4573 | |
|
4187 |
\end_inset |
|
|
4574 | \end_inset | |
|
4188 | 4575 | |
|
4189 | 4576 | Dynamic object information |
|
4190 | \layout Standard | |
|
4577 | \end_layout | |
|
4191 | 4578 | |
|
4579 | \begin_layout Standard | |
|
4192 | 4580 | Typing |
|
4193 |
\family typewriter |
|
|
4581 | \family typewriter | |
|
4194 | 4582 | ?word |
|
4195 |
\family default |
|
|
4583 | \family default | |
|
4196 | 4584 | or |
|
4197 |
\family typewriter |
|
|
4585 | \family typewriter | |
|
4198 | 4586 | word? |
|
4199 |
\family default |
|
|
4587 | \family default | |
|
4200 | 4588 | prints detailed information about an object. |
|
4201 | 4589 | If certain strings in the object are too long (docstrings, code, etc.) they |
|
4202 | 4590 | get snipped in the center for brevity. |
|
4203 | 4591 | This system gives access variable types and values, full source code for |
|
4204 | 4592 | any object (if available), function prototypes and other useful information. |
|
4205 | \layout Standard | |
|
4593 | \end_layout | |
|
4206 | 4594 | |
|
4595 | \begin_layout Standard | |
|
4207 | 4596 | Typing |
|
4208 |
\family typewriter |
|
|
4597 | \family typewriter | |
|
4209 | 4598 | ??word |
|
4210 |
\family default |
|
|
4599 | \family default | |
|
4211 | 4600 | or |
|
4212 |
\family typewriter |
|
|
4601 | \family typewriter | |
|
4213 | 4602 | word?? |
|
4214 |
\family default |
|
|
4603 | \family default | |
|
4215 | 4604 | gives access to the full information without snipping long strings. |
|
4216 | 4605 | Long strings are sent to the screen through the |
|
4217 |
\family typewriter |
|
|
4606 | \family typewriter | |
|
4218 | 4607 | less |
|
4219 |
\family default |
|
|
4608 | \family default | |
|
4220 | 4609 | pager if longer than the screen and printed otherwise. |
|
4221 | 4610 | On systems lacking the |
|
4222 |
\family typewriter |
|
|
4611 | \family typewriter | |
|
4223 | 4612 | less |
|
4224 |
\family default |
|
|
4613 | \family default | |
|
4225 | 4614 | command, IPython uses a very basic internal pager. |
|
4226 | \layout Standard | |
|
4615 | \end_layout | |
|
4227 | 4616 | |
|
4617 | \begin_layout Standard | |
|
4228 | 4618 | The following magic functions are particularly useful for gathering information |
|
4229 | 4619 | about your working environment. |
|
4230 | 4620 | You can get more details by typing |
|
4231 |
\family typewriter |
|
|
4621 | \family typewriter | |
|
4232 | 4622 | %magic |
|
4233 |
\family default |
|
|
4623 | \family default | |
|
4234 | 4624 | or querying them individually (use |
|
4235 |
\family typewriter |
|
|
4625 | \family typewriter | |
|
4236 | 4626 | %function_name? |
|
4237 |
\family default |
|
|
4627 | \family default | |
|
4238 | 4628 | with or without the |
|
4239 |
\family typewriter |
|
|
4629 | \family typewriter | |
|
4240 | 4630 | % |
|
4241 |
\family default |
|
|
4631 | \family default | |
|
4242 | 4632 | ), this is just a summary: |
|
4243 |
\layou |
|
|
4244 | \labelwidthstring 00.00.0000 | |
|
4633 | \end_layout | |
|
4245 | 4634 | |
|
4635 | \begin_layout List | |
|
4636 | \labelwidthstring 00.00.0000 | |
|
4246 | 4637 | |
|
4247 |
\family typewriter |
|
|
4248 |
\series bold |
|
|
4249 |
%pdoc\ |
|
|
4638 | \family typewriter | |
|
4639 | \series bold | |
|
4640 | %pdoc\InsetSpace ~ | |
|
4250 | 4641 | <object> |
|
4251 |
\family default |
|
|
4252 |
\series default |
|
|
4642 | \family default | |
|
4643 | \series default | |
|
4253 | 4644 | : Print (or run through a pager if too long) the docstring for an object. |
|
4254 | 4645 | If the given object is a class, it will print both the class and the constructo |
|
4255 | 4646 | r docstrings. |
|
4256 |
\layou |
|
|
4257 | \labelwidthstring 00.00.0000 | |
|
4647 | \end_layout | |
|
4258 | 4648 | |
|
4649 | \begin_layout List | |
|
4650 | \labelwidthstring 00.00.0000 | |
|
4259 | 4651 | |
|
4260 |
\family typewriter |
|
|
4261 |
\series bold |
|
|
4262 |
%pdef\ |
|
|
4652 | \family typewriter | |
|
4653 | \series bold | |
|
4654 | %pdef\InsetSpace ~ | |
|
4263 | 4655 | <object> |
|
4264 |
\family default |
|
|
4265 |
\series default |
|
|
4656 | \family default | |
|
4657 | \series default | |
|
4266 | 4658 | : Print the definition header for any callable object. |
|
4267 | 4659 | If the object is a class, print the constructor information. |
|
4268 |
\layou |
|
|
4269 | \labelwidthstring 00.00.0000 | |
|
4660 | \end_layout | |
|
4270 | 4661 | |
|
4662 | \begin_layout List | |
|
4663 | \labelwidthstring 00.00.0000 | |
|
4271 | 4664 | |
|
4272 |
\family typewriter |
|
|
4273 |
\series bold |
|
|
4274 |
%psource\ |
|
|
4665 | \family typewriter | |
|
4666 | \series bold | |
|
4667 | %psource\InsetSpace ~ | |
|
4275 | 4668 | <object> |
|
4276 |
\family default |
|
|
4277 |
\series default |
|
|
4669 | \family default | |
|
4670 | \series default | |
|
4278 | 4671 | : Print (or run through a pager if too long) the source code for an object. |
|
4279 |
\layou |
|
|
4280 | \labelwidthstring 00.00.0000 | |
|
4672 | \end_layout | |
|
4281 | 4673 | |
|
4674 | \begin_layout List | |
|
4675 | \labelwidthstring 00.00.0000 | |
|
4282 | 4676 | |
|
4283 |
\family typewriter |
|
|
4284 |
\series bold |
|
|
4285 |
%pfile\ |
|
|
4677 | \family typewriter | |
|
4678 | \series bold | |
|
4679 | %pfile\InsetSpace ~ | |
|
4286 | 4680 | <object> |
|
4287 |
\family default |
|
|
4288 |
\series default |
|
|
4681 | \family default | |
|
4682 | \series default | |
|
4289 | 4683 | : Show the entire source file where an object was defined via a pager, opening |
|
4290 | 4684 | it at the line where the object definition begins. |
|
4291 |
\layou |
|
|
4292 | \labelwidthstring 00.00.0000 | |
|
4685 | \end_layout | |
|
4293 | 4686 | |
|
4687 | \begin_layout List | |
|
4688 | \labelwidthstring 00.00.0000 | |
|
4294 | 4689 | |
|
4295 |
\family typewriter |
|
|
4296 |
\series bold |
|
|
4690 | \family typewriter | |
|
4691 | \series bold | |
|
4297 | 4692 | %who/%whos |
|
4298 |
\family default |
|
|
4299 |
\series default |
|
|
4693 | \family default | |
|
4694 | \series default | |
|
4300 | 4695 | : These functions give information about identifiers you have defined interactiv |
|
4301 | 4696 | ely (not things you loaded or defined in your configuration files). |
|
4302 | 4697 | |
|
4303 |
\family typewriter |
|
|
4698 | \family typewriter | |
|
4304 | 4699 | %who |
|
4305 |
\family default |
|
|
4700 | \family default | |
|
4306 | 4701 | just prints a list of identifiers and |
|
4307 |
\family typewriter |
|
|
4702 | \family typewriter | |
|
4308 | 4703 | %whos |
|
4309 |
\family default |
|
|
4704 | \family default | |
|
4310 | 4705 | prints a table with some basic details about each identifier. |
|
4311 | \layout Standard | |
|
4706 | \end_layout | |
|
4312 | 4707 | |
|
4708 | \begin_layout Standard | |
|
4313 | 4709 | Note that the dynamic object information functions ( |
|
4314 |
\family typewriter |
|
|
4710 | \family typewriter | |
|
4315 | 4711 | ?/??, %pdoc, %pfile, %pdef, %psource |
|
4316 |
\family default |
|
|
4712 | \family default | |
|
4317 | 4713 | ) give you access to documentation even on things which are not really defined |
|
4318 | 4714 | as separate identifiers. |
|
4319 | 4715 | Try for example typing |
|
4320 |
\family typewriter |
|
|
4716 | \family typewriter | |
|
4321 | 4717 | {}.get? |
|
4322 |
\family default |
|
|
4718 | \family default | |
|
4323 | 4719 | or after doing |
|
4324 |
\family typewriter |
|
|
4720 | \family typewriter | |
|
4325 | 4721 | import os |
|
4326 |
\family default |
|
|
4722 | \family default | |
|
4327 | 4723 | , type |
|
4328 |
\family typewriter |
|
|
4724 | \family typewriter | |
|
4329 | 4725 | os.path.abspath?? |
|
4330 |
\family default |
|
|
4726 | \family default | |
|
4331 | 4727 | . |
|
4332 | \layout Subsection | |
|
4333 | ||
|
4728 | \end_layout | |
|
4334 | 4729 | |
|
4730 | \begin_layout Subsection | |
|
4335 | 4731 | \begin_inset LatexCommand \label{sec:readline} |
|
4336 | 4732 | |
|
4337 |
\end_inset |
|
|
4733 | \end_inset | |
|
4338 | 4734 | |
|
4339 | 4735 | Readline-based features |
|
4340 | \layout Standard | |
|
4736 | \end_layout | |
|
4341 | 4737 | |
|
4738 | \begin_layout Standard | |
|
4342 | 4739 | These features require the GNU readline library, so they won't work if your |
|
4343 | 4740 | Python installation lacks readline support. |
|
4344 | 4741 | We will first describe the default behavior IPython uses, and then how |
|
4345 | 4742 | to change it to suit your preferences. |
|
4346 | \layout Subsubsection | |
|
4743 | \end_layout | |
|
4347 | 4744 | |
|
4745 | \begin_layout Subsubsection | |
|
4348 | 4746 | Command line completion |
|
4349 | \layout Standard | |
|
4747 | \end_layout | |
|
4350 | 4748 | |
|
4749 | \begin_layout Standard | |
|
4351 | 4750 | At any time, hitting TAB will complete any available python commands or |
|
4352 | 4751 | variable names, and show you a list of the possible completions if there's |
|
4353 | 4752 | no unambiguous one. |
|
4354 | 4753 | It will also complete filenames in the current directory if no python names |
|
4355 | 4754 | match what you've typed so far. |
|
4356 | \layout Subsubsection | |
|
4755 | \end_layout | |
|
4357 | 4756 | |
|
4757 | \begin_layout Subsubsection | |
|
4358 | 4758 | Search command history |
|
4359 | \layout Standard | |
|
4759 | \end_layout | |
|
4360 | 4760 | |
|
4761 | \begin_layout Standard | |
|
4361 | 4762 | IPython provides two ways for searching through previous input and thus |
|
4362 | 4763 | reduce the need for repetitive typing: |
|
4363 | \layout Enumerate | |
|
4764 | \end_layout | |
|
4364 | 4765 | |
|
4766 | \begin_layout Enumerate | |
|
4365 | 4767 | Start typing, and then use |
|
4366 |
\family typewriter |
|
|
4768 | \family typewriter | |
|
4367 | 4769 | Ctrl-p |
|
4368 |
\family default |
|
|
4770 | \family default | |
|
4369 | 4771 | (previous,up) and |
|
4370 |
\family typewriter |
|
|
4772 | \family typewriter | |
|
4371 | 4773 | Ctrl-n |
|
4372 |
\family default |
|
|
4774 | \family default | |
|
4373 | 4775 | (next,down) to search through only the history items that match what you've |
|
4374 | 4776 | typed so far. |
|
4375 | 4777 | If you use |
|
4376 |
\family typewriter |
|
|
4778 | \family typewriter | |
|
4377 | 4779 | Ctrl-p/Ctrl-n |
|
4378 |
\family default |
|
|
4780 | \family default | |
|
4379 | 4781 | at a blank prompt, they just behave like normal arrow keys. |
|
4380 | \layout Enumerate | |
|
4782 | \end_layout | |
|
4381 | 4783 | |
|
4784 | \begin_layout Enumerate | |
|
4382 | 4785 | Hit |
|
4383 |
\family typewriter |
|
|
4786 | \family typewriter | |
|
4384 | 4787 | Ctrl-r |
|
4385 |
\family default |
|
|
4788 | \family default | |
|
4386 | 4789 | : opens a search prompt. |
|
4387 | 4790 | Begin typing and the system searches your history for lines that contain |
|
4388 | 4791 | what you've typed so far, completing as much as it can. |
|
4389 | \layout Subsubsection | |
|
4792 | \end_layout | |
|
4390 | 4793 | |
|
4794 | \begin_layout Subsubsection | |
|
4391 | 4795 | Persistent command history across sessions |
|
4392 | \layout Standard | |
|
4796 | \end_layout | |
|
4393 | 4797 | |
|
4798 | \begin_layout Standard | |
|
4394 | 4799 | IPython will save your input history when it leaves and reload it next time |
|
4395 | 4800 | you restart it. |
|
4396 | 4801 | By default, the history file is named |
|
4397 |
\family typewriter |
|
|
4802 | \family typewriter | |
|
4398 | 4803 | $IPYTHONDIR/history |
|
4399 |
\family default |
|
|
4804 | \family default | |
|
4400 | 4805 | , but if you've loaded a named profile, ' |
|
4401 |
\family typewriter |
|
|
4806 | \family typewriter | |
|
4402 | 4807 | -PROFILE_NAME |
|
4403 |
\family default |
|
|
4808 | \family default | |
|
4404 | 4809 | ' is appended to the name. |
|
4405 | 4810 | This allows you to keep separate histories related to various tasks: commands |
|
4406 | 4811 | related to numerical work will not be clobbered by a system shell history, |
|
4407 | 4812 | for example. |
|
4408 | \layout Subsubsection | |
|
4813 | \end_layout | |
|
4409 | 4814 | |
|
4815 | \begin_layout Subsubsection | |
|
4410 | 4816 | Autoindent |
|
4411 | \layout Standard | |
|
4817 | \end_layout | |
|
4412 | 4818 | |
|
4819 | \begin_layout Standard | |
|
4413 | 4820 | IPython can recognize lines ending in ':' and indent the next line, while |
|
4414 | 4821 | also un-indenting automatically after 'raise' or 'return'. |
|
4415 | 4822 | |
|
4416 | \layout Standard | |
|
4823 | \end_layout | |
|
4417 | 4824 | |
|
4825 | \begin_layout Standard | |
|
4418 | 4826 | This feature uses the readline library, so it will honor your |
|
4419 |
\family typewriter |
|
|
4827 | \family typewriter | |
|
4420 | 4828 | ~/.inputrc |
|
4421 |
\family default |
|
|
4829 | \family default | |
|
4422 | 4830 | configuration (or whatever file your |
|
4423 |
\family typewriter |
|
|
4831 | \family typewriter | |
|
4424 | 4832 | INPUTRC |
|
4425 |
\family default |
|
|
4833 | \family default | |
|
4426 | 4834 | variable points to). |
|
4427 | 4835 | Adding the following lines to your |
|
4428 |
\family typewriter |
|
|
4836 | \family typewriter | |
|
4429 | 4837 | .inputrc |
|
4430 |
\family default |
|
|
4838 | \family default | |
|
4431 | 4839 | file can make indenting/unindenting more convenient ( |
|
4432 |
\family typewriter |
|
|
4840 | \family typewriter | |
|
4433 | 4841 | M-i |
|
4434 |
\family default |
|
|
4842 | \family default | |
|
4435 | 4843 | indents, |
|
4436 |
\family typewriter |
|
|
4844 | \family typewriter | |
|
4437 | 4845 | M-u |
|
4438 |
\family default |
|
|
4846 | \family default | |
|
4439 | 4847 | unindents): |
|
4440 | \layout Standard | |
|
4848 | \end_layout | |
|
4441 | 4849 | |
|
4850 | \begin_layout Standard | |
|
4442 | 4851 | |
|
4443 |
\family typewriter |
|
|
4852 | \family typewriter | |
|
4444 | 4853 | $if Python |
|
4445 |
\newline |
|
|
4854 | \newline | |
|
4446 | 4855 | " |
|
4447 |
\backslash |
|
|
4448 |
M-i": "\ |
|
|
4449 | \SpecialChar ~ | |
|
4450 | \SpecialChar ~ | |
|
4451 | \SpecialChar ~ | |
|
4856 | \backslash | |
|
4857 | M-i": "\InsetSpace ~ | |
|
4858 | \InsetSpace ~ | |
|
4859 | \InsetSpace ~ | |
|
4860 | \InsetSpace ~ | |
|
4452 | 4861 | " |
|
4453 |
\newline |
|
|
4862 | \newline | |
|
4454 | 4863 | " |
|
4455 |
\backslash |
|
|
4864 | \backslash | |
|
4456 | 4865 | M-u": " |
|
4457 |
\backslash |
|
|
4866 | \backslash | |
|
4458 | 4867 | d |
|
4459 |
\backslash |
|
|
4868 | \backslash | |
|
4460 | 4869 | d |
|
4461 |
\backslash |
|
|
4870 | \backslash | |
|
4462 | 4871 | d |
|
4463 |
\backslash |
|
|
4872 | \backslash | |
|
4464 | 4873 | d" |
|
4465 |
\newline |
|
|
4874 | \newline | |
|
4466 | 4875 | $endif |
|
4467 | \layout Standard | |
|
4876 | \end_layout | |
|
4468 | 4877 | |
|
4878 | \begin_layout Standard | |
|
4469 | 4879 | Note that there are 4 spaces between the quote marks after |
|
4470 |
\family typewriter |
|
|
4880 | \family typewriter | |
|
4471 | 4881 | "M-i" |
|
4472 |
\family default |
|
|
4882 | \family default | |
|
4473 | 4883 | above. |
|
4474 | \layout Standard | |
|
4884 | \end_layout | |
|
4475 | 4885 | |
|
4886 | \begin_layout Standard | |
|
4476 | 4887 | |
|
4477 |
\series bold |
|
|
4888 | \series bold | |
|
4478 | 4889 | Warning: |
|
4479 |
\series default |
|
|
4890 | \series default | |
|
4480 | 4891 | this feature is ON by default, but it can cause problems with the pasting |
|
4481 | 4892 | of multi-line indented code (the pasted code gets re-indented on each line). |
|
4482 | 4893 | A magic function |
|
4483 |
\family typewriter |
|
|
4894 | \family typewriter | |
|
4484 | 4895 | %autoindent |
|
4485 |
\family default |
|
|
4896 | \family default | |
|
4486 | 4897 | allows you to toggle it on/off at runtime. |
|
4487 | 4898 | You can also disable it permanently on in your |
|
4488 |
\family typewriter |
|
|
4899 | \family typewriter | |
|
4489 | 4900 | ipythonrc |
|
4490 |
\family default |
|
|
4901 | \family default | |
|
4491 | 4902 | file (set |
|
4492 |
\family typewriter |
|
|
4903 | \family typewriter | |
|
4493 | 4904 | autoindent 0 |
|
4494 |
\family default |
|
|
4905 | \family default | |
|
4495 | 4906 | ). |
|
4496 | \layout Subsubsection | |
|
4907 | \end_layout | |
|
4497 | 4908 | |
|
4909 | \begin_layout Subsubsection | |
|
4498 | 4910 | Customizing readline behavior |
|
4499 | \layout Standard | |
|
4911 | \end_layout | |
|
4500 | 4912 | |
|
4913 | \begin_layout Standard | |
|
4501 | 4914 | All these features are based on the GNU readline library, which has an extremely |
|
4502 | 4915 | customizable interface. |
|
4503 | 4916 | Normally, readline is configured via a file which defines the behavior |
@@ -4507,1630 +4920,1769 b' All these features are based on the GNU readline library, which has an extremely' | |||
|
4507 | 4920 | passing to readline valid options via a simple interface. |
|
4508 | 4921 | In brief, you can customize readline by setting the following options in |
|
4509 | 4922 | your |
|
4510 |
\family typewriter |
|
|
4923 | \family typewriter | |
|
4511 | 4924 | ipythonrc |
|
4512 |
\family default |
|
|
4925 | \family default | |
|
4513 | 4926 | configuration file (note that these options can |
|
4514 |
\emph on |
|
|
4927 | \emph on | |
|
4515 | 4928 | not |
|
4516 |
\emph default |
|
|
4929 | \emph default | |
|
4517 | 4930 | be specified at the command line): |
|
4518 |
\layou |
|
|
4519 | \labelwidthstring 00.00.0000 | |
|
4931 | \end_layout | |
|
4520 | 4932 | |
|
4933 | \begin_layout List | |
|
4934 | \labelwidthstring 00.00.0000 | |
|
4521 | 4935 | |
|
4522 |
\family typewriter |
|
|
4523 |
\series bold |
|
|
4936 | \family typewriter | |
|
4937 | \series bold | |
|
4524 | 4938 | readline_parse_and_bind: |
|
4525 |
\family default |
|
|
4526 |
\series default |
|
|
4939 | \family default | |
|
4940 | \series default | |
|
4527 | 4941 | this option can appear as many times as you want, each time defining a |
|
4528 | 4942 | string to be executed via a |
|
4529 |
\family typewriter |
|
|
4943 | \family typewriter | |
|
4530 | 4944 | readline.parse_and_bind() |
|
4531 |
\family default |
|
|
4945 | \family default | |
|
4532 | 4946 | command. |
|
4533 | 4947 | The syntax for valid commands of this kind can be found by reading the |
|
4534 | 4948 | documentation for the GNU readline library, as these commands are of the |
|
4535 | 4949 | kind which readline accepts in its configuration file. |
|
4536 |
\layou |
|
|
4537 | \labelwidthstring 00.00.0000 | |
|
4950 | \end_layout | |
|
4538 | 4951 | |
|
4952 | \begin_layout List | |
|
4953 | \labelwidthstring 00.00.0000 | |
|
4539 | 4954 | |
|
4540 |
\family typewriter |
|
|
4541 |
\series bold |
|
|
4955 | \family typewriter | |
|
4956 | \series bold | |
|
4542 | 4957 | readline_remove_delims: |
|
4543 |
\family default |
|
|
4544 |
\series default |
|
|
4958 | \family default | |
|
4959 | \series default | |
|
4545 | 4960 | a string of characters to be removed from the default word-delimiters list |
|
4546 | 4961 | used by readline, so that completions may be performed on strings which |
|
4547 | 4962 | contain them. |
|
4548 | 4963 | Do not change the default value unless you know what you're doing. |
|
4549 |
\layou |
|
|
4550 | \labelwidthstring 00.00.0000 | |
|
4964 | \end_layout | |
|
4551 | 4965 | |
|
4966 | \begin_layout List | |
|
4967 | \labelwidthstring 00.00.0000 | |
|
4552 | 4968 | |
|
4553 |
\family typewriter |
|
|
4554 |
\series bold |
|
|
4969 | \family typewriter | |
|
4970 | \series bold | |
|
4555 | 4971 | readline_omit__names |
|
4556 |
\family default |
|
|
4557 |
\series default |
|
|
4972 | \family default | |
|
4973 | \series default | |
|
4558 | 4974 | : when tab-completion is enabled, hitting |
|
4559 |
\family typewriter |
|
|
4975 | \family typewriter | |
|
4560 | 4976 | <tab> |
|
4561 |
\family default |
|
|
4977 | \family default | |
|
4562 | 4978 | after a ' |
|
4563 |
\family typewriter |
|
|
4979 | \family typewriter | |
|
4564 | 4980 | . |
|
4565 |
\family default |
|
|
4981 | \family default | |
|
4566 | 4982 | ' in a name will complete all attributes of an object, including all the |
|
4567 | 4983 | special methods whose names include double underscores (like |
|
4568 |
\family typewriter |
|
|
4984 | \family typewriter | |
|
4569 | 4985 | __getitem__ |
|
4570 |
\family default |
|
|
4986 | \family default | |
|
4571 | 4987 | or |
|
4572 |
\family typewriter |
|
|
4988 | \family typewriter | |
|
4573 | 4989 | __class__ |
|
4574 |
\family default |
|
|
4990 | \family default | |
|
4575 | 4991 | ). |
|
4576 | 4992 | If you'd rather not see these names by default, you can set this option |
|
4577 | 4993 | to 1. |
|
4578 | 4994 | Note that even when this option is set, you can still see those names by |
|
4579 | 4995 | explicitly typing a |
|
4580 |
\family typewriter |
|
|
4996 | \family typewriter | |
|
4581 | 4997 | _ |
|
4582 |
\family default |
|
|
4998 | \family default | |
|
4583 | 4999 | after the period and hitting |
|
4584 |
\family typewriter |
|
|
5000 | \family typewriter | |
|
4585 | 5001 | <tab> |
|
4586 |
\family default |
|
|
5002 | \family default | |
|
4587 | 5003 | : ' |
|
4588 |
\family typewriter |
|
|
5004 | \family typewriter | |
|
4589 | 5005 | name._<tab> |
|
4590 |
\family default |
|
|
5006 | \family default | |
|
4591 | 5007 | ' will always complete attribute names starting with ' |
|
4592 |
\family typewriter |
|
|
5008 | \family typewriter | |
|
4593 | 5009 | _ |
|
4594 |
\family default |
|
|
5010 | \family default | |
|
4595 | 5011 | '. |
|
4596 |
\layou |
|
|
4597 | \labelwidthstring 00.00.0000 | |
|
5012 | \end_layout | |
|
4598 | 5013 | |
|
4599 | \SpecialChar ~ | |
|
5014 | \begin_layout List | |
|
5015 | \labelwidthstring 00.00.0000 | |
|
5016 | \InsetSpace ~ | |
|
4600 | 5017 | This option is off by default so that new users see all attributes of any |
|
4601 | 5018 | objects they are dealing with. |
|
4602 | \layout Standard | |
|
5019 | \end_layout | |
|
4603 | 5020 | |
|
5021 | \begin_layout Standard | |
|
4604 | 5022 | You will find the default values along with a corresponding detailed explanation |
|
4605 | 5023 | in your |
|
4606 |
\family typewriter |
|
|
5024 | \family typewriter | |
|
4607 | 5025 | ipythonrc |
|
4608 |
\family default |
|
|
5026 | \family default | |
|
4609 | 5027 | file. |
|
4610 | \layout Subsection | |
|
5028 | \end_layout | |
|
4611 | 5029 | |
|
5030 | \begin_layout Subsection | |
|
4612 | 5031 | Session logging and restoring |
|
4613 | \layout Standard | |
|
5032 | \end_layout | |
|
4614 | 5033 | |
|
5034 | \begin_layout Standard | |
|
4615 | 5035 | You can log all input from a session either by starting IPython with the |
|
4616 | 5036 | command line switches |
|
4617 |
\family typewriter |
|
|
5037 | \family typewriter | |
|
4618 | 5038 | -log |
|
4619 |
\family default |
|
|
5039 | \family default | |
|
4620 | 5040 | or |
|
4621 |
\family typewriter |
|
|
5041 | \family typewriter | |
|
4622 | 5042 | -logfile |
|
4623 |
\family default |
|
|
5043 | \family default | |
|
4624 | 5044 | (see sec. |
|
4625 | 5045 | |
|
4626 | 5046 | \begin_inset LatexCommand \ref{sec:cmd-line-opts} |
|
4627 | 5047 | |
|
4628 |
\end_inset |
|
|
5048 | \end_inset | |
|
4629 | 5049 | |
|
4630 | 5050 | )or by activating the logging at any moment with the magic function |
|
4631 |
\family typewriter |
|
|
5051 | \family typewriter | |
|
4632 | 5052 | %logstart |
|
4633 |
\family default |
|
|
5053 | \family default | |
|
4634 | 5054 | . |
|
4635 | 5055 | |
|
4636 | \layout Standard | |
|
5056 | \end_layout | |
|
4637 | 5057 | |
|
5058 | \begin_layout Standard | |
|
4638 | 5059 | Log files can later be reloaded with the |
|
4639 |
\family typewriter |
|
|
5060 | \family typewriter | |
|
4640 | 5061 | -logplay |
|
4641 |
\family default |
|
|
5062 | \family default | |
|
4642 | 5063 | option and IPython will attempt to 'replay' the log by executing all the |
|
4643 | 5064 | lines in it, thus restoring the state of a previous session. |
|
4644 | 5065 | This feature is not quite perfect, but can still be useful in many cases. |
|
4645 | \layout Standard | |
|
5066 | \end_layout | |
|
4646 | 5067 | |
|
5068 | \begin_layout Standard | |
|
4647 | 5069 | The log files can also be used as a way to have a permanent record of any |
|
4648 | 5070 | code you wrote while experimenting. |
|
4649 | 5071 | Log files are regular text files which you can later open in your favorite |
|
4650 | 5072 | text editor to extract code or to 'clean them up' before using them to |
|
4651 | 5073 | replay a session. |
|
4652 | \layout Standard | |
|
5074 | \end_layout | |
|
4653 | 5075 | |
|
5076 | \begin_layout Standard | |
|
4654 | 5077 | The |
|
4655 |
\family typewriter |
|
|
5078 | \family typewriter | |
|
4656 | 5079 | %logstart |
|
4657 |
\family default |
|
|
5080 | \family default | |
|
4658 | 5081 | function for activating logging in mid-session is used as follows: |
|
4659 | \layout Standard | |
|
5082 | \end_layout | |
|
4660 | 5083 | |
|
5084 | \begin_layout Standard | |
|
4661 | 5085 | |
|
4662 |
\family typewriter |
|
|
5086 | \family typewriter | |
|
4663 | 5087 | %logstart [log_name [log_mode]] |
|
4664 | \layout Standard | |
|
5088 | \end_layout | |
|
4665 | 5089 | |
|
5090 | \begin_layout Standard | |
|
4666 | 5091 | If no name is given, it defaults to a file named |
|
4667 |
\family typewriter |
|
|
5092 | \family typewriter | |
|
4668 | 5093 | 'log' |
|
4669 |
\family default |
|
|
5094 | \family default | |
|
4670 | 5095 | in your IPYTHONDIR directory, in |
|
4671 |
\family typewriter |
|
|
5096 | \family typewriter | |
|
4672 | 5097 | 'rotate' |
|
4673 |
\family default |
|
|
5098 | \family default | |
|
4674 | 5099 | mode (see below). |
|
4675 | \layout Standard | |
|
5100 | \end_layout | |
|
4676 | 5101 | |
|
5102 | \begin_layout Standard | |
|
4677 | 5103 | ' |
|
4678 |
\family typewriter |
|
|
5104 | \family typewriter | |
|
4679 | 5105 | %logstart name |
|
4680 |
\family default |
|
|
5106 | \family default | |
|
4681 | 5107 | ' saves to file |
|
4682 |
\family typewriter |
|
|
5108 | \family typewriter | |
|
4683 | 5109 | 'name' |
|
4684 |
\family default |
|
|
5110 | \family default | |
|
4685 | 5111 | in |
|
4686 |
\family typewriter |
|
|
5112 | \family typewriter | |
|
4687 | 5113 | 'backup' |
|
4688 |
\family default |
|
|
5114 | \family default | |
|
4689 | 5115 | mode. |
|
4690 | 5116 | It saves your history up to that point and then continues logging. |
|
4691 | \layout Standard | |
|
5117 | \end_layout | |
|
4692 | 5118 | |
|
5119 | \begin_layout Standard | |
|
4693 | 5120 | |
|
4694 |
\family typewriter |
|
|
5121 | \family typewriter | |
|
4695 | 5122 | %logstart |
|
4696 |
\family default |
|
|
5123 | \family default | |
|
4697 | 5124 | takes a second optional parameter: logging mode. |
|
4698 | 5125 | This can be one of (note that the modes are given unquoted): |
|
4699 |
\layou |
|
|
4700 | \labelwidthstring 00.00.0000 | |
|
5126 | \end_layout | |
|
4701 | 5127 | |
|
5128 | \begin_layout List | |
|
5129 | \labelwidthstring 00.00.0000 | |
|
4702 | 5130 | |
|
4703 |
\family typewriter |
|
|
5131 | \family typewriter | |
|
4704 | 5132 | over |
|
4705 |
\family default |
|
|
5133 | \family default | |
|
4706 | 5134 | : overwrite existing |
|
4707 |
\family typewriter |
|
|
5135 | \family typewriter | |
|
4708 | 5136 | log_name |
|
4709 |
\family default |
|
|
5137 | \family default | |
|
4710 | 5138 | . |
|
4711 |
\layou |
|
|
4712 | \labelwidthstring 00.00.0000 | |
|
5139 | \end_layout | |
|
4713 | 5140 | |
|
5141 | \begin_layout List | |
|
5142 | \labelwidthstring 00.00.0000 | |
|
4714 | 5143 | |
|
4715 |
\family typewriter |
|
|
5144 | \family typewriter | |
|
4716 | 5145 | backup |
|
4717 |
\family default |
|
|
5146 | \family default | |
|
4718 | 5147 | : rename (if exists) to |
|
4719 |
\family typewriter |
|
|
5148 | \family typewriter | |
|
4720 | 5149 | log_name~ |
|
4721 |
\family default |
|
|
5150 | \family default | |
|
4722 | 5151 | and start |
|
4723 |
\family typewriter |
|
|
5152 | \family typewriter | |
|
4724 | 5153 | log_name |
|
4725 |
\family default |
|
|
5154 | \family default | |
|
4726 | 5155 | . |
|
4727 |
\layou |
|
|
4728 | \labelwidthstring 00.00.0000 | |
|
5156 | \end_layout | |
|
4729 | 5157 | |
|
5158 | \begin_layout List | |
|
5159 | \labelwidthstring 00.00.0000 | |
|
4730 | 5160 | |
|
4731 |
\family typewriter |
|
|
5161 | \family typewriter | |
|
4732 | 5162 | append |
|
4733 |
\family default |
|
|
5163 | \family default | |
|
4734 | 5164 | : well, that says it. |
|
4735 |
\layou |
|
|
4736 | \labelwidthstring 00.00.0000 | |
|
5165 | \end_layout | |
|
4737 | 5166 | |
|
5167 | \begin_layout List | |
|
5168 | \labelwidthstring 00.00.0000 | |
|
4738 | 5169 | |
|
4739 |
\family typewriter |
|
|
5170 | \family typewriter | |
|
4740 | 5171 | rotate |
|
4741 |
\family default |
|
|
5172 | \family default | |
|
4742 | 5173 | : create rotating logs |
|
4743 |
\family typewriter |
|
|
5174 | \family typewriter | |
|
4744 | 5175 | log_name |
|
4745 |
\family default |
|
|
5176 | \family default | |
|
4746 | 5177 | . |
|
4747 |
\family typewriter |
|
|
5178 | \family typewriter | |
|
4748 | 5179 | 1~ |
|
4749 |
\family default |
|
|
5180 | \family default | |
|
4750 | 5181 | , |
|
4751 |
\family typewriter |
|
|
5182 | \family typewriter | |
|
4752 | 5183 | log_name.2~ |
|
4753 |
\family default |
|
|
5184 | \family default | |
|
4754 | 5185 | , etc. |
|
4755 | \layout Standard | |
|
5186 | \end_layout | |
|
4756 | 5187 | |
|
5188 | \begin_layout Standard | |
|
4757 | 5189 | The |
|
4758 |
\family typewriter |
|
|
5190 | \family typewriter | |
|
4759 | 5191 | %logoff |
|
4760 |
\family default |
|
|
5192 | \family default | |
|
4761 | 5193 | and |
|
4762 |
\family typewriter |
|
|
5194 | \family typewriter | |
|
4763 | 5195 | %logon |
|
4764 |
\family default |
|
|
5196 | \family default | |
|
4765 | 5197 | functions allow you to temporarily stop and resume logging to a file which |
|
4766 | 5198 | had previously been started with |
|
4767 |
\family typewriter |
|
|
5199 | \family typewriter | |
|
4768 | 5200 | %logstart |
|
4769 |
\family default |
|
|
5201 | \family default | |
|
4770 | 5202 | . |
|
4771 | 5203 | They will fail (with an explanation) if you try to use them before logging |
|
4772 | 5204 | has been started. |
|
4773 | \layout Subsection | |
|
4774 | ||
|
5205 | \end_layout | |
|
4775 | 5206 | |
|
5207 | \begin_layout Subsection | |
|
4776 | 5208 | \begin_inset LatexCommand \label{sub:System-shell-access} |
|
4777 | 5209 | |
|
4778 |
\end_inset |
|
|
5210 | \end_inset | |
|
4779 | 5211 | |
|
4780 | 5212 | System shell access |
|
4781 | \layout Standard | |
|
5213 | \end_layout | |
|
4782 | 5214 | |
|
5215 | \begin_layout Standard | |
|
4783 | 5216 | Any input line beginning with a |
|
4784 |
\family typewriter |
|
|
5217 | \family typewriter | |
|
4785 | 5218 | ! |
|
4786 |
\family default |
|
|
5219 | \family default | |
|
4787 | 5220 | character is passed verbatim (minus the |
|
4788 |
\family typewriter |
|
|
5221 | \family typewriter | |
|
4789 | 5222 | ! |
|
4790 |
\family default |
|
|
5223 | \family default | |
|
4791 | 5224 | , of course) to the underlying operating system. |
|
4792 | 5225 | For example, typing |
|
4793 |
\family typewriter |
|
|
5226 | \family typewriter | |
|
4794 | 5227 | !ls |
|
4795 |
\family default |
|
|
5228 | \family default | |
|
4796 | 5229 | will run |
|
4797 |
\family typewriter |
|
|
5230 | \family typewriter | |
|
4798 | 5231 | 'ls' |
|
4799 |
\family default |
|
|
5232 | \family default | |
|
4800 | 5233 | in the current directory. |
|
4801 | \layout Subsubsection | |
|
5234 | \end_layout | |
|
4802 | 5235 | |
|
5236 | \begin_layout Subsubsection | |
|
4803 | 5237 | Manual capture of command output |
|
4804 | \layout Standard | |
|
5238 | \end_layout | |
|
4805 | 5239 | |
|
5240 | \begin_layout Standard | |
|
4806 | 5241 | If the input line begins with |
|
4807 |
\emph on |
|
|
5242 | \emph on | |
|
4808 | 5243 | two |
|
4809 |
\emph default |
|
|
5244 | \emph default | |
|
4810 | 5245 | exclamation marks, |
|
4811 |
\family typewriter |
|
|
5246 | \family typewriter | |
|
4812 | 5247 | !! |
|
4813 |
\family default |
|
|
5248 | \family default | |
|
4814 | 5249 | , the command is executed but its output is captured and returned as a python |
|
4815 | 5250 | list, split on newlines. |
|
4816 | 5251 | Any output sent by the subprocess to standard error is printed separately, |
|
4817 | 5252 | so that the resulting list only captures standard output. |
|
4818 | 5253 | The |
|
4819 |
\family typewriter |
|
|
5254 | \family typewriter | |
|
4820 | 5255 | !! |
|
4821 |
\family default |
|
|
5256 | \family default | |
|
4822 | 5257 | syntax is a shorthand for the |
|
4823 |
\family typewriter |
|
|
5258 | \family typewriter | |
|
4824 | 5259 | %sx |
|
4825 |
\family default |
|
|
5260 | \family default | |
|
4826 | 5261 | magic command. |
|
4827 | \layout Standard | |
|
5262 | \end_layout | |
|
4828 | 5263 | |
|
5264 | \begin_layout Standard | |
|
4829 | 5265 | Finally, the |
|
4830 |
\family typewriter |
|
|
5266 | \family typewriter | |
|
4831 | 5267 | %sc |
|
4832 |
\family default |
|
|
5268 | \family default | |
|
4833 | 5269 | magic (short for `shell capture') is similar to |
|
4834 |
\family typewriter |
|
|
5270 | \family typewriter | |
|
4835 | 5271 | %sx |
|
4836 |
\family default |
|
|
5272 | \family default | |
|
4837 | 5273 | , but allowing more fine-grained control of the capture details, and storing |
|
4838 | 5274 | the result directly into a named variable. |
|
4839 | \layout Standard | |
|
5275 | \end_layout | |
|
4840 | 5276 | |
|
4841 | See Sec.\SpecialChar ~ | |
|
5277 | \begin_layout Standard | |
|
5278 | See Sec.\InsetSpace ~ | |
|
4842 | 5279 | |
|
4843 | 5280 | \begin_inset LatexCommand \ref{sec:magic} |
|
4844 | 5281 | |
|
4845 |
\end_inset |
|
|
5282 | \end_inset | |
|
4846 | 5283 | |
|
4847 | 5284 | for details on the magics |
|
4848 |
\family typewriter |
|
|
5285 | \family typewriter | |
|
4849 | 5286 | %sc |
|
4850 |
\family default |
|
|
5287 | \family default | |
|
4851 | 5288 | and |
|
4852 |
\family typewriter |
|
|
5289 | \family typewriter | |
|
4853 | 5290 | %sx |
|
4854 |
\family default |
|
|
5291 | \family default | |
|
4855 | 5292 | , or use IPython's own help ( |
|
4856 |
\family typewriter |
|
|
5293 | \family typewriter | |
|
4857 | 5294 | sc? |
|
4858 |
\family default |
|
|
5295 | \family default | |
|
4859 | 5296 | and |
|
4860 |
\family typewriter |
|
|
5297 | \family typewriter | |
|
4861 | 5298 | sx? |
|
4862 |
\family default |
|
|
5299 | \family default | |
|
4863 | 5300 | ) for further details. |
|
4864 | \layout Standard | |
|
5301 | \end_layout | |
|
4865 | 5302 | |
|
5303 | \begin_layout Standard | |
|
4866 | 5304 | IPython also allows you to expand the value of python variables when making |
|
4867 | 5305 | system calls. |
|
4868 | 5306 | Any python variable or expression which you prepend with |
|
4869 |
\family typewriter |
|
|
5307 | \family typewriter | |
|
4870 | 5308 | $ |
|
4871 |
\family default |
|
|
5309 | \family default | |
|
4872 | 5310 | will get expanded before the system call is made. |
|
4873 | 5311 | |
|
4874 | \layout Standard | |
|
5312 | \end_layout | |
|
4875 | 5313 | |
|
5314 | \begin_layout Standard | |
|
4876 | 5315 | |
|
4877 |
\family typewriter |
|
|
5316 | \family typewriter | |
|
4878 | 5317 | In [1]: pyvar='Hello world' |
|
4879 |
\newline |
|
|
5318 | \newline | |
|
4880 | 5319 | In [2]: !echo "A python variable: $pyvar" |
|
4881 |
\newline |
|
|
4882 | A python variable: Hello world | |
|
4883 | \layout Standard | |
|
5320 | \newline | |
|
5321 | A python | |
|
5322 | variable: Hello world | |
|
5323 | \end_layout | |
|
4884 | 5324 | |
|
5325 | \begin_layout Standard | |
|
4885 | 5326 | If you want the shell to actually see a literal |
|
4886 |
\family typewriter |
|
|
5327 | \family typewriter | |
|
4887 | 5328 | $ |
|
4888 |
\family default |
|
|
5329 | \family default | |
|
4889 | 5330 | , you need to type it twice: |
|
4890 | \layout Standard | |
|
5331 | \end_layout | |
|
4891 | 5332 | |
|
5333 | \begin_layout Standard | |
|
4892 | 5334 | |
|
4893 |
\family typewriter |
|
|
5335 | \family typewriter | |
|
4894 | 5336 | In [3]: !echo "A system variable: $$HOME" |
|
4895 |
\newline |
|
|
5337 | \newline | |
|
4896 | 5338 | A system variable: /home/fperez |
|
4897 | \layout Standard | |
|
5339 | \end_layout | |
|
4898 | 5340 | |
|
5341 | \begin_layout Standard | |
|
4899 | 5342 | You can pass arbitrary expressions, though you'll need to delimit them with |
|
4900 | 5343 | |
|
4901 |
\family typewriter |
|
|
5344 | \family typewriter | |
|
4902 | 5345 | {} |
|
4903 |
\family default |
|
|
5346 | \family default | |
|
4904 | 5347 | if there is ambiguity as to the extent of the expression: |
|
4905 | \layout Standard | |
|
5348 | \end_layout | |
|
4906 | 5349 | |
|
5350 | \begin_layout Standard | |
|
4907 | 5351 | |
|
4908 |
\family typewriter |
|
|
5352 | \family typewriter | |
|
4909 | 5353 | In [5]: x=10 |
|
4910 |
\newline |
|
|
5354 | \newline | |
|
4911 | 5355 | In [6]: y=20 |
|
4912 |
\newline |
|
|
5356 | \newline | |
|
4913 | 5357 | In [13]: !echo $x+y |
|
4914 |
\newline |
|
|
5358 | \newline | |
|
4915 | 5359 | 10+y |
|
4916 |
\newline |
|
|
5360 | \newline | |
|
4917 | 5361 | In [7]: !echo ${x+y} |
|
4918 |
\newline |
|
|
4919 |
30 |
|
|
4920 | \layout Standard | |
|
5362 | \newline | |
|
5363 | 30 | |
|
5364 | ||
|
5365 | \end_layout | |
|
4921 | 5366 | |
|
5367 | \begin_layout Standard | |
|
4922 | 5368 | Even object attributes can be expanded: |
|
4923 | \layout Standard | |
|
5369 | \end_layout | |
|
4924 | 5370 | |
|
5371 | \begin_layout Standard | |
|
4925 | 5372 | |
|
4926 |
\family typewriter |
|
|
5373 | \family typewriter | |
|
4927 | 5374 | In [12]: !echo $sys.argv |
|
4928 |
\newline |
|
|
5375 | \newline | |
|
4929 | 5376 | [/home/fperez/usr/bin/ipython] |
|
4930 | \layout Subsection | |
|
5377 | \end_layout | |
|
4931 | 5378 | |
|
5379 | \begin_layout Subsection | |
|
4932 | 5380 | System command aliases |
|
4933 | \layout Standard | |
|
5381 | \end_layout | |
|
4934 | 5382 | |
|
5383 | \begin_layout Standard | |
|
4935 | 5384 | The |
|
4936 |
\family typewriter |
|
|
5385 | \family typewriter | |
|
4937 | 5386 | %alias |
|
4938 |
\family default |
|
|
5387 | \family default | |
|
4939 | 5388 | magic function and the |
|
4940 |
\family typewriter |
|
|
5389 | \family typewriter | |
|
4941 | 5390 | alias |
|
4942 |
\family default |
|
|
5391 | \family default | |
|
4943 | 5392 | option in the |
|
4944 |
\family typewriter |
|
|
5393 | \family typewriter | |
|
4945 | 5394 | ipythonrc |
|
4946 |
\family default |
|
|
5395 | \family default | |
|
4947 | 5396 | configuration file allow you to define magic functions which are in fact |
|
4948 | 5397 | system shell commands. |
|
4949 | 5398 | These aliases can have parameters. |
|
4950 | 5399 | |
|
4951 | \layout Standard | |
|
5400 | \end_layout | |
|
4952 | 5401 | |
|
5402 | \begin_layout Standard | |
|
4953 | 5403 | ' |
|
4954 |
\family typewriter |
|
|
5404 | \family typewriter | |
|
4955 | 5405 | %alias alias_name cmd |
|
4956 |
\family default |
|
|
5406 | \family default | |
|
4957 | 5407 | ' defines ' |
|
4958 |
\family typewriter |
|
|
5408 | \family typewriter | |
|
4959 | 5409 | alias_name |
|
4960 |
\family default |
|
|
5410 | \family default | |
|
4961 | 5411 | ' as an alias for ' |
|
4962 |
\family typewriter |
|
|
5412 | \family typewriter | |
|
4963 | 5413 | cmd |
|
4964 |
\family default |
|
|
5414 | \family default | |
|
4965 | 5415 | ' |
|
4966 | \layout Standard | |
|
5416 | \end_layout | |
|
4967 | 5417 | |
|
5418 | \begin_layout Standard | |
|
4968 | 5419 | Then, typing ' |
|
4969 |
\family typewriter |
|
|
5420 | \family typewriter | |
|
4970 | 5421 | %alias_name params |
|
4971 |
\family default |
|
|
5422 | \family default | |
|
4972 | 5423 | ' will execute the system command ' |
|
4973 |
\family typewriter |
|
|
5424 | \family typewriter | |
|
4974 | 5425 | cmd params |
|
4975 |
\family default |
|
|
5426 | \family default | |
|
4976 | 5427 | ' (from your underlying operating system). |
|
4977 | 5428 | |
|
4978 | \layout Standard | |
|
5429 | \end_layout | |
|
4979 | 5430 | |
|
5431 | \begin_layout Standard | |
|
4980 | 5432 | You can also define aliases with parameters using |
|
4981 |
\family typewriter |
|
|
5433 | \family typewriter | |
|
4982 | 5434 | %s |
|
4983 |
\family default |
|
|
5435 | \family default | |
|
4984 | 5436 | specifiers (one per parameter). |
|
4985 | 5437 | The following example defines the |
|
4986 |
\family typewriter |
|
|
5438 | \family typewriter | |
|
4987 | 5439 | %parts |
|
4988 |
\family default |
|
|
5440 | \family default | |
|
4989 | 5441 | function as an alias to the command ' |
|
4990 |
\family typewriter |
|
|
5442 | \family typewriter | |
|
4991 | 5443 | echo first %s second %s |
|
4992 |
\family default |
|
|
5444 | \family default | |
|
4993 | 5445 | ' where each |
|
4994 |
\family typewriter |
|
|
5446 | \family typewriter | |
|
4995 | 5447 | %s |
|
4996 |
\family default |
|
|
5448 | \family default | |
|
4997 | 5449 | will be replaced by a positional parameter to the call to |
|
4998 |
\family typewriter |
|
|
5450 | \family typewriter | |
|
4999 | 5451 | %parts: |
|
5000 | \layout Standard | |
|
5452 | \end_layout | |
|
5001 | 5453 | |
|
5454 | \begin_layout Standard | |
|
5002 | 5455 | |
|
5003 |
\family typewriter |
|
|
5456 | \family typewriter | |
|
5004 | 5457 | In [1]: alias parts echo first %s second %s |
|
5005 |
\newline |
|
|
5458 | \newline | |
|
5006 | 5459 | In [2]: %parts A B |
|
5007 |
\newline |
|
|
5008 |
first A second |
|
|
5009 | \newline | |
|
5460 | \newline | |
|
5461 | first A second | |
|
5462 | B | |
|
5463 | \newline | |
|
5010 | 5464 | In [3]: %parts A |
|
5011 |
\newline |
|
|
5465 | \newline | |
|
5012 | 5466 | Incorrect number of arguments: 2 expected. |
|
5013 | 5467 | |
|
5014 |
\newline |
|
|
5468 | \newline | |
|
5015 | 5469 | parts is an alias to: 'echo first %s second %s' |
|
5016 | \layout Standard | |
|
5470 | \end_layout | |
|
5017 | 5471 | |
|
5472 | \begin_layout Standard | |
|
5018 | 5473 | If called with no parameters, |
|
5019 |
\family typewriter |
|
|
5474 | \family typewriter | |
|
5020 | 5475 | %alias |
|
5021 |
\family default |
|
|
5476 | \family default | |
|
5022 | 5477 | prints the table of currently defined aliases. |
|
5023 | \layout Standard | |
|
5478 | \end_layout | |
|
5024 | 5479 | |
|
5480 | \begin_layout Standard | |
|
5025 | 5481 | The |
|
5026 |
\family typewriter |
|
|
5482 | \family typewriter | |
|
5027 | 5483 | %rehash/rehashx |
|
5028 |
\family default |
|
|
5484 | \family default | |
|
5029 | 5485 | magics allow you to load your entire |
|
5030 |
\family typewriter |
|
|
5486 | \family typewriter | |
|
5031 | 5487 | $PATH |
|
5032 |
\family default |
|
|
5488 | \family default | |
|
5033 | 5489 | as ipython aliases. |
|
5034 |
See their respective docstrings (or sec.\ |
|
|
5490 | See their respective docstrings (or sec.\InsetSpace ~ | |
|
5035 | 5491 | |
|
5036 | 5492 | \begin_inset LatexCommand \ref{sec:magic} |
|
5037 | 5493 | |
|
5038 |
\end_inset |
|
|
5494 | \end_inset | |
|
5039 | 5495 | |
|
5040 | 5496 | for further details). |
|
5041 | \layout Subsection | |
|
5042 | ||
|
5497 | \end_layout | |
|
5043 | 5498 | |
|
5499 | \begin_layout Subsection | |
|
5044 | 5500 | \begin_inset LatexCommand \label{sec:dreload} |
|
5045 | 5501 | |
|
5046 |
\end_inset |
|
|
5502 | \end_inset | |
|
5047 | 5503 | |
|
5048 | 5504 | Recursive reload |
|
5049 | \layout Standard | |
|
5505 | \end_layout | |
|
5050 | 5506 | |
|
5507 | \begin_layout Standard | |
|
5051 | 5508 | The |
|
5052 |
\family typewriter |
|
|
5509 | \family typewriter | |
|
5053 | 5510 | dreload |
|
5054 |
\family default |
|
|
5511 | \family default | |
|
5055 | 5512 | function does a recursive reload of a module: changes made to the module |
|
5056 | 5513 | since you imported will actually be available without having to exit. |
|
5057 | \layout Subsection | |
|
5514 | \end_layout | |
|
5058 | 5515 | |
|
5516 | \begin_layout Subsection | |
|
5059 | 5517 | Verbose and colored exception traceback printouts |
|
5060 | \layout Standard | |
|
5518 | \end_layout | |
|
5061 | 5519 | |
|
5520 | \begin_layout Standard | |
|
5062 | 5521 | IPython provides the option to see very detailed exception tracebacks, which |
|
5063 | 5522 | can be especially useful when debugging large programs. |
|
5064 | 5523 | You can run any Python file with the |
|
5065 |
\family typewriter |
|
|
5524 | \family typewriter | |
|
5066 | 5525 | %run |
|
5067 |
\family default |
|
|
5526 | \family default | |
|
5068 | 5527 | function to benefit from these detailed tracebacks. |
|
5069 | 5528 | Furthermore, both normal and verbose tracebacks can be colored (if your |
|
5070 | 5529 | terminal supports it) which makes them much easier to parse visually. |
|
5071 | \layout Standard | |
|
5530 | \end_layout | |
|
5072 | 5531 | |
|
5532 | \begin_layout Standard | |
|
5073 | 5533 | See the magic |
|
5074 |
\family typewriter |
|
|
5534 | \family typewriter | |
|
5075 | 5535 | xmode |
|
5076 |
\family default |
|
|
5536 | \family default | |
|
5077 | 5537 | and |
|
5078 |
\family typewriter |
|
|
5538 | \family typewriter | |
|
5079 | 5539 | colors |
|
5080 |
\family default |
|
|
5540 | \family default | |
|
5081 | 5541 | functions for details (just type |
|
5082 |
\family typewriter |
|
|
5542 | \family typewriter | |
|
5083 | 5543 | %magic |
|
5084 |
\family default |
|
|
5544 | \family default | |
|
5085 | 5545 | ). |
|
5086 | \layout Standard | |
|
5546 | \end_layout | |
|
5087 | 5547 | |
|
5548 | \begin_layout Standard | |
|
5088 | 5549 | These features are basically a terminal version of Ka-Ping Yee's |
|
5089 |
\family typewriter |
|
|
5550 | \family typewriter | |
|
5090 | 5551 | cgitb |
|
5091 |
\family default |
|
|
5552 | \family default | |
|
5092 | 5553 | module, now part of the standard Python library. |
|
5093 | \layout Subsection | |
|
5094 | ||
|
5554 | \end_layout | |
|
5095 | 5555 | |
|
5556 | \begin_layout Subsection | |
|
5096 | 5557 | \begin_inset LatexCommand \label{sec:cache_input} |
|
5097 | 5558 | |
|
5098 |
\end_inset |
|
|
5559 | \end_inset | |
|
5099 | 5560 | |
|
5100 | 5561 | Input caching system |
|
5101 | \layout Standard | |
|
5562 | \end_layout | |
|
5102 | 5563 | |
|
5564 | \begin_layout Standard | |
|
5103 | 5565 | IPython offers numbered prompts (In/Out) with input and output caching. |
|
5104 | 5566 | All input is saved and can be retrieved as variables (besides the usual |
|
5105 | 5567 | arrow key recall). |
|
5106 | \layout Standard | |
|
5568 | \end_layout | |
|
5107 | 5569 | |
|
5570 | \begin_layout Standard | |
|
5108 | 5571 | The following GLOBAL variables always exist (so don't overwrite them!): |
|
5109 | 5572 | |
|
5110 |
\family typewriter |
|
|
5573 | \family typewriter | |
|
5111 | 5574 | _i |
|
5112 |
\family default |
|
|
5575 | \family default | |
|
5113 | 5576 | : stores previous input. |
|
5114 | 5577 | |
|
5115 |
\family typewriter |
|
|
5578 | \family typewriter | |
|
5116 | 5579 | _ii |
|
5117 |
\family default |
|
|
5580 | \family default | |
|
5118 | 5581 | : next previous. |
|
5119 | 5582 | |
|
5120 |
\family typewriter |
|
|
5583 | \family typewriter | |
|
5121 | 5584 | _iii |
|
5122 |
\family default |
|
|
5585 | \family default | |
|
5123 | 5586 | : next-next previous. |
|
5124 | 5587 | |
|
5125 |
\family typewriter |
|
|
5588 | \family typewriter | |
|
5126 | 5589 | _ih |
|
5127 |
\family default |
|
|
5590 | \family default | |
|
5128 | 5591 | : a list of all input |
|
5129 |
\family typewriter |
|
|
5592 | \family typewriter | |
|
5130 | 5593 | _ih[n] |
|
5131 |
\family default |
|
|
5594 | \family default | |
|
5132 | 5595 | is the input from line |
|
5133 |
\family typewriter |
|
|
5596 | \family typewriter | |
|
5134 | 5597 | n |
|
5135 |
\family default |
|
|
5598 | \family default | |
|
5136 | 5599 | and this list is aliased to the global variable |
|
5137 |
\family typewriter |
|
|
5600 | \family typewriter | |
|
5138 | 5601 | In |
|
5139 |
\family default |
|
|
5602 | \family default | |
|
5140 | 5603 | . |
|
5141 | 5604 | If you overwrite |
|
5142 |
\family typewriter |
|
|
5605 | \family typewriter | |
|
5143 | 5606 | In |
|
5144 |
\family default |
|
|
5607 | \family default | |
|
5145 | 5608 | with a variable of your own, you can remake the assignment to the internal |
|
5146 | 5609 | list with a simple |
|
5147 |
\family typewriter |
|
|
5610 | \family typewriter | |
|
5148 | 5611 | 'In=_ih' |
|
5149 |
\family default |
|
|
5612 | \family default | |
|
5150 | 5613 | . |
|
5151 | \layout Standard | |
|
5614 | \end_layout | |
|
5152 | 5615 | |
|
5616 | \begin_layout Standard | |
|
5153 | 5617 | Additionally, global variables named |
|
5154 |
\family typewriter |
|
|
5618 | \family typewriter | |
|
5155 | 5619 | _i<n> |
|
5156 |
\family default |
|
|
5620 | \family default | |
|
5157 | 5621 | are dynamically created ( |
|
5158 |
\family typewriter |
|
|
5622 | \family typewriter | |
|
5159 | 5623 | <n> |
|
5160 |
\family default |
|
|
5624 | \family default | |
|
5161 | 5625 | being the prompt counter), such that |
|
5162 |
\newline |
|
|
5626 | \newline | |
|
5163 | 5627 | |
|
5164 |
\family typewriter |
|
|
5628 | \family typewriter | |
|
5165 | 5629 | _i<n> == _ih[<n>] == In[<n>]. |
|
5166 | \layout Standard | |
|
5630 | \end_layout | |
|
5167 | 5631 | |
|
5632 | \begin_layout Standard | |
|
5168 | 5633 | For example, what you typed at prompt 14 is available as |
|
5169 |
\family typewriter |
|
|
5634 | \family typewriter | |
|
5170 | 5635 | _i14, |
|
5171 |
\family default |
|
|
5636 | \family default | |
|
5172 | 5637 | |
|
5173 |
\family typewriter |
|
|
5638 | \family typewriter | |
|
5174 | 5639 | _ih[14] |
|
5175 |
\family default |
|
|
5640 | \family default | |
|
5176 | 5641 | and |
|
5177 |
\family typewriter |
|
|
5642 | \family typewriter | |
|
5178 | 5643 | In[14] |
|
5179 |
\family default |
|
|
5644 | \family default | |
|
5180 | 5645 | . |
|
5181 | \layout Standard | |
|
5646 | \end_layout | |
|
5182 | 5647 | |
|
5648 | \begin_layout Standard | |
|
5183 | 5649 | This allows you to easily cut and paste multi line interactive prompts by |
|
5184 | 5650 | printing them out: they print like a clean string, without prompt characters. |
|
5185 | 5651 | You can also manipulate them like regular variables (they are strings), |
|
5186 | 5652 | modify or exec them (typing |
|
5187 |
\family typewriter |
|
|
5653 | \family typewriter | |
|
5188 | 5654 | 'exec _i9' |
|
5189 |
\family default |
|
|
5655 | \family default | |
|
5190 | 5656 | will re-execute the contents of input prompt 9, ' |
|
5191 |
\family typewriter |
|
|
5657 | \family typewriter | |
|
5192 | 5658 | exec In[9:14]+In[18] |
|
5193 |
\family default |
|
|
5659 | \family default | |
|
5194 | 5660 | ' will re-execute lines 9 through 13 and line 18). |
|
5195 | \layout Standard | |
|
5661 | \end_layout | |
|
5196 | 5662 | |
|
5663 | \begin_layout Standard | |
|
5197 | 5664 | You can also re-execute multiple lines of input easily by using the magic |
|
5198 | 5665 | |
|
5199 |
\family typewriter |
|
|
5666 | \family typewriter | |
|
5200 | 5667 | %macro |
|
5201 |
\family default |
|
|
5668 | \family default | |
|
5202 | 5669 | function (which automates the process and allows re-execution without having |
|
5203 | 5670 | to type ' |
|
5204 |
\family typewriter |
|
|
5671 | \family typewriter | |
|
5205 | 5672 | exec |
|
5206 |
\family default |
|
|
5673 | \family default | |
|
5207 | 5674 | ' every time). |
|
5208 | 5675 | The macro system also allows you to re-execute previous lines which include |
|
5209 | 5676 | magic function calls (which require special processing). |
|
5210 | 5677 | Type |
|
5211 |
\family typewriter |
|
|
5678 | \family typewriter | |
|
5212 | 5679 | %macro? |
|
5213 |
\family default |
|
|
5680 | \family default | |
|
5214 | 5681 | or see sec. |
|
5215 | 5682 | |
|
5216 | 5683 | \begin_inset LatexCommand \ref{sec:magic} |
|
5217 | 5684 | |
|
5218 |
\end_inset |
|
|
5685 | \end_inset | |
|
5219 | 5686 | |
|
5220 | 5687 | for more details on the macro system. |
|
5221 | \layout Standard | |
|
5688 | \end_layout | |
|
5222 | 5689 | |
|
5690 | \begin_layout Standard | |
|
5223 | 5691 | A history function |
|
5224 |
\family typewriter |
|
|
5692 | \family typewriter | |
|
5225 | 5693 | %hist |
|
5226 |
\family default |
|
|
5694 | \family default | |
|
5227 | 5695 | allows you to see any part of your input history by printing a range of |
|
5228 | 5696 | the |
|
5229 |
\family typewriter |
|
|
5697 | \family typewriter | |
|
5230 | 5698 | _i |
|
5231 |
\family default |
|
|
5699 | \family default | |
|
5232 | 5700 | variables. |
|
5233 | \layout Subsection | |
|
5234 | ||
|
5701 | \end_layout | |
|
5235 | 5702 | |
|
5703 | \begin_layout Subsection | |
|
5236 | 5704 | \begin_inset LatexCommand \label{sec:cache_output} |
|
5237 | 5705 | |
|
5238 |
\end_inset |
|
|
5706 | \end_inset | |
|
5239 | 5707 | |
|
5240 | 5708 | Output caching system |
|
5241 | \layout Standard | |
|
5709 | \end_layout | |
|
5242 | 5710 | |
|
5711 | \begin_layout Standard | |
|
5243 | 5712 | For output that is returned from actions, a system similar to the input |
|
5244 | 5713 | cache exists but using |
|
5245 |
\family typewriter |
|
|
5714 | \family typewriter | |
|
5246 | 5715 | _ |
|
5247 |
\family default |
|
|
5716 | \family default | |
|
5248 | 5717 | instead of |
|
5249 |
\family typewriter |
|
|
5718 | \family typewriter | |
|
5250 | 5719 | _i |
|
5251 |
\family default |
|
|
5720 | \family default | |
|
5252 | 5721 | . |
|
5253 | 5722 | Only actions that produce a result (NOT assignments, for example) are cached. |
|
5254 | 5723 | If you are familiar with Mathematica, IPython's |
|
5255 |
\family typewriter |
|
|
5724 | \family typewriter | |
|
5256 | 5725 | _ |
|
5257 |
\family default |
|
|
5726 | \family default | |
|
5258 | 5727 | variables behave exactly like Mathematica's |
|
5259 |
\family typewriter |
|
|
5728 | \family typewriter | |
|
5260 | 5729 | % |
|
5261 |
\family default |
|
|
5730 | \family default | |
|
5262 | 5731 | variables. |
|
5263 | \layout Standard | |
|
5732 | \end_layout | |
|
5264 | 5733 | |
|
5734 | \begin_layout Standard | |
|
5265 | 5735 | The following GLOBAL variables always exist (so don't overwrite them!): |
|
5266 | 5736 | |
|
5267 |
\layou |
|
|
5268 | \labelwidthstring 00.00.0000 | |
|
5737 | \end_layout | |
|
5269 | 5738 | |
|
5739 | \begin_layout List | |
|
5740 | \labelwidthstring 00.00.0000 | |
|
5270 | 5741 | |
|
5271 |
\family typewriter |
|
|
5272 |
\series bold |
|
|
5742 | \family typewriter | |
|
5743 | \series bold | |
|
5273 | 5744 | _ |
|
5274 |
\family default |
|
|
5275 |
\series default |
|
|
5745 | \family default | |
|
5746 | \series default | |
|
5276 | 5747 | (a |
|
5277 |
\emph on |
|
|
5748 | \emph on | |
|
5278 | 5749 | single |
|
5279 |
\emph default |
|
|
5750 | \emph default | |
|
5280 | 5751 | underscore) : stores previous output, like Python's default interpreter. |
|
5281 |
\layou |
|
|
5282 | \labelwidthstring 00.00.0000 | |
|
5752 | \end_layout | |
|
5283 | 5753 | |
|
5754 | \begin_layout List | |
|
5755 | \labelwidthstring 00.00.0000 | |
|
5284 | 5756 | |
|
5285 |
\family typewriter |
|
|
5286 |
\series bold |
|
|
5757 | \family typewriter | |
|
5758 | \series bold | |
|
5287 | 5759 | __ |
|
5288 |
\family default |
|
|
5289 |
\series default |
|
|
5760 | \family default | |
|
5761 | \series default | |
|
5290 | 5762 | (two underscores): next previous. |
|
5291 |
\layou |
|
|
5292 | \labelwidthstring 00.00.0000 | |
|
5763 | \end_layout | |
|
5293 | 5764 | |
|
5765 | \begin_layout List | |
|
5766 | \labelwidthstring 00.00.0000 | |
|
5294 | 5767 | |
|
5295 |
\family typewriter |
|
|
5296 |
\series bold |
|
|
5768 | \family typewriter | |
|
5769 | \series bold | |
|
5297 | 5770 | ___ |
|
5298 |
\family default |
|
|
5299 |
\series default |
|
|
5771 | \family default | |
|
5772 | \series default | |
|
5300 | 5773 | (three underscores): next-next previous. |
|
5301 | \layout Standard | |
|
5774 | \end_layout | |
|
5302 | 5775 | |
|
5776 | \begin_layout Standard | |
|
5303 | 5777 | Additionally, global variables named |
|
5304 |
\family typewriter |
|
|
5778 | \family typewriter | |
|
5305 | 5779 | _<n> |
|
5306 |
\family default |
|
|
5780 | \family default | |
|
5307 | 5781 | are dynamically created ( |
|
5308 |
\family typewriter |
|
|
5782 | \family typewriter | |
|
5309 | 5783 | <n> |
|
5310 |
\family default |
|
|
5784 | \family default | |
|
5311 | 5785 | being the prompt counter), such that the result of output |
|
5312 |
\family typewriter |
|
|
5786 | \family typewriter | |
|
5313 | 5787 | <n> |
|
5314 |
\family default |
|
|
5788 | \family default | |
|
5315 | 5789 | is always available as |
|
5316 |
\family typewriter |
|
|
5790 | \family typewriter | |
|
5317 | 5791 | _<n> |
|
5318 |
\family default |
|
|
5792 | \family default | |
|
5319 | 5793 | (don't use the angle brackets, just the number, e.g. |
|
5320 | 5794 | |
|
5321 |
\family typewriter |
|
|
5795 | \family typewriter | |
|
5322 | 5796 | _21 |
|
5323 |
\family default |
|
|
5797 | \family default | |
|
5324 | 5798 | ). |
|
5325 | \layout Standard | |
|
5799 | \end_layout | |
|
5326 | 5800 | |
|
5801 | \begin_layout Standard | |
|
5327 | 5802 | These global variables are all stored in a global dictionary (not a list, |
|
5328 | 5803 | since it only has entries for lines which returned a result) available |
|
5329 | 5804 | under the names |
|
5330 |
\family typewriter |
|
|
5805 | \family typewriter | |
|
5331 | 5806 | _oh |
|
5332 |
\family default |
|
|
5807 | \family default | |
|
5333 | 5808 | and |
|
5334 |
\family typewriter |
|
|
5809 | \family typewriter | |
|
5335 | 5810 | Out |
|
5336 |
\family default |
|
|
5811 | \family default | |
|
5337 | 5812 | (similar to |
|
5338 |
\family typewriter |
|
|
5813 | \family typewriter | |
|
5339 | 5814 | _ih |
|
5340 |
\family default |
|
|
5815 | \family default | |
|
5341 | 5816 | and |
|
5342 |
\family typewriter |
|
|
5817 | \family typewriter | |
|
5343 | 5818 | In |
|
5344 |
\family default |
|
|
5819 | \family default | |
|
5345 | 5820 | ). |
|
5346 | 5821 | So the output from line 12 can be obtained as |
|
5347 |
\family typewriter |
|
|
5822 | \family typewriter | |
|
5348 | 5823 | _12 |
|
5349 |
\family default |
|
|
5824 | \family default | |
|
5350 | 5825 | , |
|
5351 |
\family typewriter |
|
|
5826 | \family typewriter | |
|
5352 | 5827 | Out[12] |
|
5353 |
\family default |
|
|
5828 | \family default | |
|
5354 | 5829 | or |
|
5355 |
\family typewriter |
|
|
5830 | \family typewriter | |
|
5356 | 5831 | _oh[12] |
|
5357 |
\family default |
|
|
5832 | \family default | |
|
5358 | 5833 | . |
|
5359 | 5834 | If you accidentally overwrite the |
|
5360 |
\family typewriter |
|
|
5835 | \family typewriter | |
|
5361 | 5836 | Out |
|
5362 |
\family default |
|
|
5837 | \family default | |
|
5363 | 5838 | variable you can recover it by typing |
|
5364 |
\family typewriter |
|
|
5839 | \family typewriter | |
|
5365 | 5840 | 'Out=_oh |
|
5366 |
\family default |
|
|
5841 | \family default | |
|
5367 | 5842 | ' at the prompt. |
|
5368 | \layout Standard | |
|
5843 | \end_layout | |
|
5369 | 5844 | |
|
5845 | \begin_layout Standard | |
|
5370 | 5846 | This system obviously can potentially put heavy memory demands on your system, |
|
5371 | 5847 | since it prevents Python's garbage collector from removing any previously |
|
5372 | 5848 | computed results. |
|
5373 | 5849 | You can control how many results are kept in memory with the option (at |
|
5374 | 5850 | the command line or in your |
|
5375 |
\family typewriter |
|
|
5851 | \family typewriter | |
|
5376 | 5852 | ipythonrc |
|
5377 |
\family default |
|
|
5853 | \family default | |
|
5378 | 5854 | file) |
|
5379 |
\family typewriter |
|
|
5855 | \family typewriter | |
|
5380 | 5856 | cache_size |
|
5381 |
\family default |
|
|
5857 | \family default | |
|
5382 | 5858 | . |
|
5383 | 5859 | If you set it to 0, the whole system is completely disabled and the prompts |
|
5384 | 5860 | revert to the classic |
|
5385 |
\family typewriter |
|
|
5861 | \family typewriter | |
|
5386 | 5862 | '>>>' |
|
5387 |
\family default |
|
|
5863 | \family default | |
|
5388 | 5864 | of normal Python. |
|
5389 | \layout Subsection | |
|
5865 | \end_layout | |
|
5390 | 5866 | |
|
5867 | \begin_layout Subsection | |
|
5391 | 5868 | Directory history |
|
5392 | \layout Standard | |
|
5869 | \end_layout | |
|
5393 | 5870 | |
|
5871 | \begin_layout Standard | |
|
5394 | 5872 | Your history of visited directories is kept in the global list |
|
5395 |
\family typewriter |
|
|
5873 | \family typewriter | |
|
5396 | 5874 | _dh |
|
5397 |
\family default |
|
|
5875 | \family default | |
|
5398 | 5876 | , and the magic |
|
5399 |
\family typewriter |
|
|
5877 | \family typewriter | |
|
5400 | 5878 | %cd |
|
5401 |
\family default |
|
|
5879 | \family default | |
|
5402 | 5880 | command can be used to go to any entry in that list. |
|
5403 | 5881 | The |
|
5404 |
\family typewriter |
|
|
5882 | \family typewriter | |
|
5405 | 5883 | %dhist |
|
5406 |
\family default |
|
|
5884 | \family default | |
|
5407 | 5885 | command allows you to view this history. |
|
5408 | \layout Subsection | |
|
5886 | \end_layout | |
|
5409 | 5887 | |
|
5888 | \begin_layout Subsection | |
|
5410 | 5889 | Automatic parentheses and quotes |
|
5411 | \layout Standard | |
|
5890 | \end_layout | |
|
5412 | 5891 | |
|
5892 | \begin_layout Standard | |
|
5413 | 5893 | These features were adapted from Nathan Gray's LazyPython. |
|
5414 | 5894 | They are meant to allow less typing for common situations. |
|
5415 | \layout Subsubsection | |
|
5895 | \end_layout | |
|
5416 | 5896 | |
|
5897 | \begin_layout Subsubsection | |
|
5417 | 5898 | Automatic parentheses |
|
5418 | \layout Standard | |
|
5899 | \end_layout | |
|
5419 | 5900 | |
|
5901 | \begin_layout Standard | |
|
5420 | 5902 | Callable objects (i.e. |
|
5421 | 5903 | functions, methods, etc) can be invoked like this (notice the commas between |
|
5422 | 5904 | the arguments): |
|
5423 | \layout Standard | |
|
5905 | \end_layout | |
|
5424 | 5906 | |
|
5907 | \begin_layout Standard | |
|
5425 | 5908 | |
|
5426 |
\family typewriter |
|
|
5909 | \family typewriter | |
|
5427 | 5910 | >>> callable_ob arg1, arg2, arg3 |
|
5428 | \layout Standard | |
|
5911 | \end_layout | |
|
5429 | 5912 | |
|
5913 | \begin_layout Standard | |
|
5430 | 5914 | and the input will be translated to this: |
|
5431 | \layout Standard | |
|
5915 | \end_layout | |
|
5432 | 5916 | |
|
5917 | \begin_layout Standard | |
|
5433 | 5918 | |
|
5434 |
\family typewriter |
|
|
5919 | \family typewriter | |
|
5435 | 5920 | --> callable_ob(arg1, arg2, arg3) |
|
5436 | \layout Standard | |
|
5921 | \end_layout | |
|
5437 | 5922 | |
|
5923 | \begin_layout Standard | |
|
5438 | 5924 | You can force automatic parentheses by using '/' as the first character |
|
5439 | 5925 | of a line. |
|
5440 | 5926 | For example: |
|
5441 | \layout Standard | |
|
5927 | \end_layout | |
|
5442 | 5928 | |
|
5929 | \begin_layout Standard | |
|
5443 | 5930 | |
|
5444 |
\family typewriter |
|
|
5931 | \family typewriter | |
|
5445 | 5932 | >>> /globals # becomes 'globals()' |
|
5446 | \layout Standard | |
|
5933 | \end_layout | |
|
5447 | 5934 | |
|
5935 | \begin_layout Standard | |
|
5448 | 5936 | Note that the '/' MUST be the first character on the line! This won't work: |
|
5449 | 5937 | |
|
5450 | \layout Standard | |
|
5938 | \end_layout | |
|
5451 | 5939 | |
|
5940 | \begin_layout Standard | |
|
5452 | 5941 | |
|
5453 |
\family typewriter |
|
|
5942 | \family typewriter | |
|
5454 | 5943 | >>> print /globals # syntax error |
|
5455 | \layout Standard | |
|
5944 | \end_layout | |
|
5456 | 5945 | |
|
5946 | \begin_layout Standard | |
|
5457 | 5947 | In most cases the automatic algorithm should work, so you should rarely |
|
5458 | 5948 | need to explicitly invoke /. |
|
5459 | 5949 | One notable exception is if you are trying to call a function with a list |
|
5460 | 5950 | of tuples as arguments (the parenthesis will confuse IPython): |
|
5461 | \layout Standard | |
|
5951 | \end_layout | |
|
5462 | 5952 | |
|
5953 | \begin_layout Standard | |
|
5463 | 5954 | |
|
5464 |
\family typewriter |
|
|
5955 | \family typewriter | |
|
5465 | 5956 | In [1]: zip (1,2,3),(4,5,6) # won't work |
|
5466 | \layout Standard | |
|
5957 | \end_layout | |
|
5467 | 5958 | |
|
5959 | \begin_layout Standard | |
|
5468 | 5960 | but this will work: |
|
5469 | \layout Standard | |
|
5961 | \end_layout | |
|
5470 | 5962 | |
|
5963 | \begin_layout Standard | |
|
5471 | 5964 | |
|
5472 |
\family typewriter |
|
|
5965 | \family typewriter | |
|
5473 | 5966 | In [2]: /zip (1,2,3),(4,5,6) |
|
5474 |
\newline |
|
|
5967 | \newline | |
|
5475 | 5968 | ------> zip ((1,2,3),(4,5,6)) |
|
5476 |
\newline |
|
|
5477 |
Out[2]= [(1, 4), |
|
|
5478 | \layout Standard | |
|
5969 | \newline | |
|
5970 | Out[2]= [(1, 4), | |
|
5971 | (2, 5), (3, 6)] | |
|
5972 | \end_layout | |
|
5479 | 5973 | |
|
5974 | \begin_layout Standard | |
|
5480 | 5975 | IPython tells you that it has altered your command line by displaying the |
|
5481 | 5976 | new command line preceded by |
|
5482 |
\family typewriter |
|
|
5977 | \family typewriter | |
|
5483 | 5978 | --> |
|
5484 |
\family default |
|
|
5979 | \family default | |
|
5485 | 5980 | . |
|
5486 | 5981 | e.g.: |
|
5487 | \layout Standard | |
|
5982 | \end_layout | |
|
5488 | 5983 | |
|
5984 | \begin_layout Standard | |
|
5489 | 5985 | |
|
5490 |
\family typewriter |
|
|
5986 | \family typewriter | |
|
5491 | 5987 | In [18]: callable list |
|
5492 |
\newline |
|
|
5988 | \newline | |
|
5493 | 5989 | -------> callable (list) |
|
5494 | \layout Subsubsection | |
|
5990 | \end_layout | |
|
5495 | 5991 | |
|
5992 | \begin_layout Subsubsection | |
|
5496 | 5993 | Automatic quoting |
|
5497 | \layout Standard | |
|
5994 | \end_layout | |
|
5498 | 5995 | |
|
5996 | \begin_layout Standard | |
|
5499 | 5997 | You can force automatic quoting of a function's arguments by using |
|
5500 |
\family typewriter |
|
|
5998 | \family typewriter | |
|
5501 | 5999 | `,' |
|
5502 |
\family default |
|
|
6000 | \family default | |
|
5503 | 6001 | or |
|
5504 |
\family typewriter |
|
|
6002 | \family typewriter | |
|
5505 | 6003 | `;' |
|
5506 |
\family default |
|
|
6004 | \family default | |
|
5507 | 6005 | as the first character of a line. |
|
5508 | 6006 | For example: |
|
5509 | \layout Standard | |
|
6007 | \end_layout | |
|
5510 | 6008 | |
|
6009 | \begin_layout Standard | |
|
5511 | 6010 | |
|
5512 |
\family typewriter |
|
|
6011 | \family typewriter | |
|
5513 | 6012 | >>> ,my_function /home/me # becomes my_function("/home/me") |
|
5514 | \layout Standard | |
|
6013 | \end_layout | |
|
5515 | 6014 | |
|
6015 | \begin_layout Standard | |
|
5516 | 6016 | If you use |
|
5517 |
\family typewriter |
|
|
6017 | \family typewriter | |
|
5518 | 6018 | `;' |
|
5519 |
\family default |
|
|
6019 | \family default | |
|
5520 | 6020 | instead, the whole argument is quoted as a single string (while |
|
5521 |
\family typewriter |
|
|
6021 | \family typewriter | |
|
5522 | 6022 | `,' |
|
5523 |
\family default |
|
|
6023 | \family default | |
|
5524 | 6024 | splits on whitespace): |
|
5525 | \layout Standard | |
|
6025 | \end_layout | |
|
5526 | 6026 | |
|
6027 | \begin_layout Standard | |
|
5527 | 6028 | |
|
5528 |
\family typewriter |
|
|
6029 | \family typewriter | |
|
5529 | 6030 | >>> ,my_function a b c # becomes my_function("a","b","c") |
|
5530 | \layout Standard | |
|
6031 | \end_layout | |
|
5531 | 6032 | |
|
6033 | \begin_layout Standard | |
|
5532 | 6034 | |
|
5533 |
\family typewriter |
|
|
6035 | \family typewriter | |
|
5534 | 6036 | >>> ;my_function a b c # becomes my_function("a b c") |
|
5535 | \layout Standard | |
|
6037 | \end_layout | |
|
5536 | 6038 | |
|
6039 | \begin_layout Standard | |
|
5537 | 6040 | Note that the ` |
|
5538 |
\family typewriter |
|
|
6041 | \family typewriter | |
|
5539 | 6042 | , |
|
5540 |
\family default |
|
|
6043 | \family default | |
|
5541 | 6044 | ' or ` |
|
5542 |
\family typewriter |
|
|
6045 | \family typewriter | |
|
5543 | 6046 | ; |
|
5544 |
\family default |
|
|
6047 | \family default | |
|
5545 | 6048 | ' MUST be the first character on the line! This won't work: |
|
5546 | \layout Standard | |
|
6049 | \end_layout | |
|
5547 | 6050 | |
|
6051 | \begin_layout Standard | |
|
5548 | 6052 | |
|
5549 |
\family typewriter |
|
|
6053 | \family typewriter | |
|
5550 | 6054 | >>> x = ,my_function /home/me # syntax error |
|
5551 | \layout Section | |
|
5552 | ||
|
6055 | \end_layout | |
|
5553 | 6056 | |
|
6057 | \begin_layout Section | |
|
5554 | 6058 | \begin_inset LatexCommand \label{sec:customization} |
|
5555 | 6059 | |
|
5556 |
\end_inset |
|
|
6060 | \end_inset | |
|
5557 | 6061 | |
|
5558 | 6062 | Customization |
|
5559 | \layout Standard | |
|
6063 | \end_layout | |
|
5560 | 6064 | |
|
6065 | \begin_layout Standard | |
|
5561 | 6066 | As we've already mentioned, IPython reads a configuration file which can |
|
5562 | 6067 | be specified at the command line ( |
|
5563 |
\family typewriter |
|
|
6068 | \family typewriter | |
|
5564 | 6069 | -rcfile |
|
5565 |
\family default |
|
|
6070 | \family default | |
|
5566 | 6071 | ) or which by default is assumed to be called |
|
5567 |
\family typewriter |
|
|
6072 | \family typewriter | |
|
5568 | 6073 | ipythonrc |
|
5569 |
\family default |
|
|
6074 | \family default | |
|
5570 | 6075 | . |
|
5571 | 6076 | Such a file is looked for in the current directory where IPython is started |
|
5572 | 6077 | and then in your |
|
5573 |
\family typewriter |
|
|
6078 | \family typewriter | |
|
5574 | 6079 | IPYTHONDIR |
|
5575 |
\family default |
|
|
6080 | \family default | |
|
5576 | 6081 | , which allows you to have local configuration files for specific projects. |
|
5577 | 6082 | In this section we will call these types of configuration files simply |
|
5578 | 6083 | rcfiles (short for resource configuration file). |
|
5579 | \layout Standard | |
|
6084 | \end_layout | |
|
5580 | 6085 | |
|
6086 | \begin_layout Standard | |
|
5581 | 6087 | The syntax of an rcfile is one of key-value pairs separated by whitespace, |
|
5582 | 6088 | one per line. |
|
5583 | 6089 | Lines beginning with a |
|
5584 |
\family typewriter |
|
|
6090 | \family typewriter | |
|
5585 | 6091 | # |
|
5586 |
\family default |
|
|
6092 | \family default | |
|
5587 | 6093 | are ignored as comments, but comments can |
|
5588 |
\series bold |
|
|
6094 | \series bold | |
|
5589 | 6095 | not |
|
5590 |
\series default |
|
|
6096 | \series default | |
|
5591 | 6097 | be put on lines with data (the parser is fairly primitive). |
|
5592 | 6098 | Note that these are not python files, and this is deliberate, because it |
|
5593 | 6099 | allows us to do some things which would be quite tricky to implement if |
|
5594 | 6100 | they were normal python files. |
|
5595 | \layout Standard | |
|
6101 | \end_layout | |
|
5596 | 6102 | |
|
6103 | \begin_layout Standard | |
|
5597 | 6104 | First, an rcfile can contain permanent default values for almost all command |
|
5598 | 6105 | line options (except things like |
|
5599 |
\family typewriter |
|
|
6106 | \family typewriter | |
|
5600 | 6107 | -help |
|
5601 |
\family default |
|
|
6108 | \family default | |
|
5602 | 6109 | or |
|
5603 |
\family typewriter |
|
|
6110 | \family typewriter | |
|
5604 | 6111 | -Version |
|
5605 |
\family default |
|
|
6112 | \family default | |
|
5606 | 6113 | ). |
|
5607 | Sec\SpecialChar ~ | |
|
6114 | Sec\InsetSpace ~ | |
|
5608 | 6115 | |
|
5609 | 6116 | \begin_inset LatexCommand \ref{sec:cmd-line-opts} |
|
5610 | 6117 | |
|
5611 |
\end_inset |
|
|
6118 | \end_inset | |
|
5612 | 6119 | |
|
5613 | 6120 | contains a description of all command-line options. |
|
5614 | 6121 | However, values you explicitly specify at the command line override the |
|
5615 | 6122 | values defined in the rcfile. |
|
5616 | \layout Standard | |
|
6123 | \end_layout | |
|
5617 | 6124 | |
|
6125 | \begin_layout Standard | |
|
5618 | 6126 | Besides command line option values, the rcfile can specify values for certain |
|
5619 | 6127 | extra special options which are not available at the command line. |
|
5620 | 6128 | These options are briefly described below. |
|
5621 | 6129 | |
|
5622 | \layout Standard | |
|
6130 | \end_layout | |
|
5623 | 6131 | |
|
6132 | \begin_layout Standard | |
|
5624 | 6133 | Each of these options may appear as many times as you need it in the file. |
|
5625 |
\layou |
|
|
5626 | \labelwidthstring 00.00.0000 | |
|
6134 | \end_layout | |
|
5627 | 6135 | |
|
6136 | \begin_layout List | |
|
6137 | \labelwidthstring 00.00.0000 | |
|
5628 | 6138 | |
|
5629 |
\family typewriter |
|
|
5630 |
\series bold |
|
|
5631 |
include\ |
|
|
5632 |
<file1>\ |
|
|
5633 |
<file2>\ |
|
|
6139 | \family typewriter | |
|
6140 | \series bold | |
|
6141 | include\InsetSpace ~ | |
|
6142 | <file1>\InsetSpace ~ | |
|
6143 | <file2>\InsetSpace ~ | |
|
5634 | 6144 | ... |
|
5635 |
\family default |
|
|
5636 |
\series default |
|
|
6145 | \family default | |
|
6146 | \series default | |
|
5637 | 6147 | : you can name |
|
5638 |
\emph on |
|
|
6148 | \emph on | |
|
5639 | 6149 | other |
|
5640 |
\emph default |
|
|
6150 | \emph default | |
|
5641 | 6151 | rcfiles you want to recursively load up to 15 levels (don't use the |
|
5642 |
\family typewriter |
|
|
6152 | \family typewriter | |
|
5643 | 6153 | <> |
|
5644 |
\family default |
|
|
6154 | \family default | |
|
5645 | 6155 | brackets in your names!). |
|
5646 | 6156 | This feature allows you to define a 'base' rcfile with general options |
|
5647 | 6157 | and special-purpose files which can be loaded only when needed with particular |
|
5648 | 6158 | configuration options. |
|
5649 | 6159 | To make this more convenient, IPython accepts the |
|
5650 |
\family typewriter |
|
|
6160 | \family typewriter | |
|
5651 | 6161 | -profile <name> |
|
5652 |
\family default |
|
|
6162 | \family default | |
|
5653 | 6163 | option (abbreviates to |
|
5654 |
\family typewriter |
|
|
6164 | \family typewriter | |
|
5655 | 6165 | -p <name |
|
5656 |
\family default |
|
|
6166 | \family default | |
|
5657 | 6167 | >) |
|
5658 |
\family typewriter |
|
|
6168 | \family typewriter | |
|
5659 | 6169 | which |
|
5660 |
\family default |
|
|
6170 | \family default | |
|
5661 | 6171 | tells it to look for an rcfile named |
|
5662 |
\family typewriter |
|
|
6172 | \family typewriter | |
|
5663 | 6173 | ipythonrc-<name> |
|
5664 |
\family default |
|
|
6174 | \family default | |
|
5665 | 6175 | . |
|
5666 | 6176 | |
|
5667 |
\layou |
|
|
5668 | \labelwidthstring 00.00.0000 | |
|
6177 | \end_layout | |
|
5669 | 6178 | |
|
6179 | \begin_layout List | |
|
6180 | \labelwidthstring 00.00.0000 | |
|
5670 | 6181 | |
|
5671 |
\family typewriter |
|
|
5672 |
\series bold |
|
|
5673 |
import_mod\ |
|
|
5674 |
<mod1>\ |
|
|
5675 |
<mod2>\ |
|
|
6182 | \family typewriter | |
|
6183 | \series bold | |
|
6184 | import_mod\InsetSpace ~ | |
|
6185 | <mod1>\InsetSpace ~ | |
|
6186 | <mod2>\InsetSpace ~ | |
|
5676 | 6187 | ... |
|
5677 |
\family default |
|
|
5678 |
\series default |
|
|
6188 | \family default | |
|
6189 | \series default | |
|
5679 | 6190 | : import modules with ' |
|
5680 |
\family typewriter |
|
|
6191 | \family typewriter | |
|
5681 | 6192 | import |
|
5682 |
\family default |
|
|
6193 | \family default | |
|
5683 | 6194 | |
|
5684 |
\family typewriter |
|
|
6195 | \family typewriter | |
|
5685 | 6196 | <mod1>,<mod2>,... |
|
5686 |
\family default |
|
|
6197 | \family default | |
|
5687 | 6198 | ' |
|
5688 |
\layou |
|
|
5689 | \labelwidthstring 00.00.0000 | |
|
6199 | \end_layout | |
|
5690 | 6200 | |
|
6201 | \begin_layout List | |
|
6202 | \labelwidthstring 00.00.0000 | |
|
5691 | 6203 | |
|
5692 |
\family typewriter |
|
|
5693 |
\series bold |
|
|
5694 |
import_some\ |
|
|
5695 |
<mod>\ |
|
|
5696 | <f1>\SpecialChar ~ | |
|
5697 | <f2>\SpecialChar ~ | |
|
6204 | \family typewriter | |
|
6205 | \series bold | |
|
6206 | import_some\InsetSpace ~ | |
|
6207 | <mod>\InsetSpace ~ | |
|
6208 | <f1>\InsetSpace ~ | |
|
6209 | <f2>\InsetSpace ~ | |
|
5698 | 6210 | ... |
|
5699 |
\family default |
|
|
5700 |
\series default |
|
|
6211 | \family default | |
|
6212 | \series default | |
|
5701 | 6213 | : import functions with ' |
|
5702 |
\family typewriter |
|
|
6214 | \family typewriter | |
|
5703 | 6215 | from <mod> import |
|
5704 |
\family default |
|
|
6216 | \family default | |
|
5705 | 6217 | |
|
5706 |
\family typewriter |
|
|
6218 | \family typewriter | |
|
5707 | 6219 | <f1>,<f2>,... |
|
5708 |
\family default |
|
|
6220 | \family default | |
|
5709 | 6221 | ' |
|
5710 |
\layou |
|
|
5711 | \labelwidthstring 00.00.0000 | |
|
6222 | \end_layout | |
|
5712 | 6223 | |
|
6224 | \begin_layout List | |
|
6225 | \labelwidthstring 00.00.0000 | |
|
5713 | 6226 | |
|
5714 |
\family typewriter |
|
|
5715 |
\series bold |
|
|
5716 |
import_all\ |
|
|
5717 |
<mod1>\ |
|
|
5718 |
<mod2>\ |
|
|
6227 | \family typewriter | |
|
6228 | \series bold | |
|
6229 | import_all\InsetSpace ~ | |
|
6230 | <mod1>\InsetSpace ~ | |
|
6231 | <mod2>\InsetSpace ~ | |
|
5719 | 6232 | ... |
|
5720 |
\family default |
|
|
5721 |
\series default |
|
|
6233 | \family default | |
|
6234 | \series default | |
|
5722 | 6235 | : for each module listed import functions with ' |
|
5723 |
\family typewriter |
|
|
6236 | \family typewriter | |
|
5724 | 6237 | from <mod> import * |
|
5725 |
\family default |
|
|
6238 | \family default | |
|
5726 | 6239 | ' |
|
5727 |
\layou |
|
|
5728 | \labelwidthstring 00.00.0000 | |
|
6240 | \end_layout | |
|
5729 | 6241 | |
|
6242 | \begin_layout List | |
|
6243 | \labelwidthstring 00.00.0000 | |
|
5730 | 6244 | |
|
5731 |
\family typewriter |
|
|
5732 |
\series bold |
|
|
5733 |
execute\ |
|
|
5734 |
<python\ |
|
|
6245 | \family typewriter | |
|
6246 | \series bold | |
|
6247 | execute\InsetSpace ~ | |
|
6248 | <python\InsetSpace ~ | |
|
5735 | 6249 | code> |
|
5736 |
\family default |
|
|
5737 |
\series default |
|
|
6250 | \family default | |
|
6251 | \series default | |
|
5738 | 6252 | : give any single-line python code to be executed. |
|
5739 |
\layou |
|
|
5740 | \labelwidthstring 00.00.0000 | |
|
6253 | \end_layout | |
|
5741 | 6254 | |
|
6255 | \begin_layout List | |
|
6256 | \labelwidthstring 00.00.0000 | |
|
5742 | 6257 | |
|
5743 |
\family typewriter |
|
|
5744 |
\series bold |
|
|
5745 |
execfile\ |
|
|
6258 | \family typewriter | |
|
6259 | \series bold | |
|
6260 | execfile\InsetSpace ~ | |
|
5746 | 6261 | <filename> |
|
5747 |
\family default |
|
|
5748 |
\series default |
|
|
6262 | \family default | |
|
6263 | \series default | |
|
5749 | 6264 | : execute the python file given with an ' |
|
5750 |
\family typewriter |
|
|
6265 | \family typewriter | |
|
5751 | 6266 | execfile(filename) |
|
5752 |
\family default |
|
|
6267 | \family default | |
|
5753 | 6268 | ' command. |
|
5754 | 6269 | Username expansion is performed on the given names. |
|
5755 | 6270 | So if you need any amount of extra fancy customization that won't fit in |
|
5756 | 6271 | any of the above 'canned' options, you can just put it in a separate python |
|
5757 | 6272 | file and execute it. |
|
5758 |
\layou |
|
|
5759 | \labelwidthstring 00.00.0000 | |
|
6273 | \end_layout | |
|
5760 | 6274 | |
|
6275 | \begin_layout List | |
|
6276 | \labelwidthstring 00.00.0000 | |
|
5761 | 6277 | |
|
5762 |
\family typewriter |
|
|
5763 |
\series bold |
|
|
5764 |
alias\ |
|
|
6278 | \family typewriter | |
|
6279 | \series bold | |
|
6280 | alias\InsetSpace ~ | |
|
5765 | 6281 | <alias_def> |
|
5766 |
\family default |
|
|
5767 |
\series default |
|
|
6282 | \family default | |
|
6283 | \series default | |
|
5768 | 6284 | : this is equivalent to calling ' |
|
5769 |
\family typewriter |
|
|
5770 |
%alias\ |
|
|
6285 | \family typewriter | |
|
6286 | %alias\InsetSpace ~ | |
|
5771 | 6287 | <alias_def> |
|
5772 |
\family default |
|
|
6288 | \family default | |
|
5773 | 6289 | ' at the IPython command line. |
|
5774 | 6290 | This way, from within IPython you can do common system tasks without having |
|
5775 | 6291 | to exit it or use the |
|
5776 |
\family typewriter |
|
|
6292 | \family typewriter | |
|
5777 | 6293 | ! |
|
5778 |
\family default |
|
|
6294 | \family default | |
|
5779 | 6295 | escape. |
|
5780 | 6296 | IPython isn't meant to be a shell replacement, but it is often very useful |
|
5781 | 6297 | to be able to do things with files while testing code. |
|
5782 | 6298 | This gives you the flexibility to have within IPython any aliases you may |
|
5783 | 6299 | be used to under your normal system shell. |
|
5784 | \layout Subsection | |
|
5785 | ||
|
6300 | \end_layout | |
|
5786 | 6301 | |
|
6302 | \begin_layout Subsection | |
|
5787 | 6303 | \begin_inset LatexCommand \label{sec:ipytonrc-sample} |
|
5788 | 6304 | |
|
5789 |
\end_inset |
|
|
6305 | \end_inset | |
|
5790 | 6306 | |
|
5791 | 6307 | Sample |
|
5792 |
\family typewriter |
|
|
6308 | \family typewriter | |
|
5793 | 6309 | ipythonrc |
|
5794 |
\family default |
|
|
6310 | \family default | |
|
5795 | 6311 | file |
|
5796 | \layout Standard | |
|
6312 | \end_layout | |
|
5797 | 6313 | |
|
6314 | \begin_layout Standard | |
|
5798 | 6315 | The default rcfile, called |
|
5799 |
\family typewriter |
|
|
6316 | \family typewriter | |
|
5800 | 6317 | ipythonrc |
|
5801 |
\family default |
|
|
6318 | \family default | |
|
5802 | 6319 | and supplied in your |
|
5803 |
\family typewriter |
|
|
6320 | \family typewriter | |
|
5804 | 6321 | IPYTHONDIR |
|
5805 |
\family default |
|
|
6322 | \family default | |
|
5806 | 6323 | directory contains lots of comments on all of these options. |
|
5807 | 6324 | We reproduce it here for reference: |
|
5808 | \layout Standard | |
|
5809 | ||
|
6325 | \end_layout | |
|
5810 | 6326 | |
|
6327 | \begin_layout Standard | |
|
5811 | 6328 | \begin_inset ERT |
|
5812 |
status |
|
|
6329 | status open | |
|
5813 | 6330 | |
|
5814 | \layout Standard | |
|
6331 | \begin_layout Standard | |
|
5815 | 6332 | |
|
5816 | \backslash | |
|
6333 | ||
|
6334 | \backslash | |
|
5817 | 6335 | codelist{../IPython/UserConfig/ipythonrc} |
|
5818 | \end_inset | |
|
6336 | \end_layout | |
|
5819 | 6337 | |
|
6338 | \end_inset | |
|
5820 | 6339 | |
|
5821 | \layout Subsection | |
|
5822 | 6340 | |
|
6341 | \end_layout | |
|
5823 | 6342 | |
|
6343 | \begin_layout Subsection | |
|
5824 | 6344 | \begin_inset LatexCommand \label{sec:prompts} |
|
5825 | 6345 | |
|
5826 |
\end_inset |
|
|
6346 | \end_inset | |
|
5827 | 6347 | |
|
5828 | 6348 | Fine-tuning your prompt |
|
5829 | \layout Standard | |
|
6349 | \end_layout | |
|
5830 | 6350 | |
|
6351 | \begin_layout Standard | |
|
5831 | 6352 | IPython's prompts can be customized using a syntax similar to that of the |
|
5832 | 6353 | |
|
5833 |
\family typewriter |
|
|
6354 | \family typewriter | |
|
5834 | 6355 | bash |
|
5835 |
\family default |
|
|
6356 | \family default | |
|
5836 | 6357 | shell. |
|
5837 | 6358 | Many of |
|
5838 |
\family typewriter |
|
|
6359 | \family typewriter | |
|
5839 | 6360 | bash |
|
5840 |
\family default |
|
|
6361 | \family default | |
|
5841 | 6362 | 's escapes are supported, as well as a few additional ones. |
|
5842 | 6363 | We list them below: |
|
5843 | \layout Description | |
|
6364 | \end_layout | |
|
5844 | 6365 | |
|
6366 | \begin_layout Description | |
|
5845 | 6367 | |
|
5846 |
\backslash |
|
|
6368 | \backslash | |
|
5847 | 6369 | # the prompt/history count number |
|
5848 | \layout Description | |
|
6370 | \end_layout | |
|
5849 | 6371 | |
|
6372 | \begin_layout Description | |
|
5850 | 6373 | |
|
5851 |
\backslash |
|
|
6374 | \backslash | |
|
5852 | 6375 | D the prompt/history count, with the actual digits replaced by dots. |
|
5853 | 6376 | Used mainly in continuation prompts (prompt_in2) |
|
5854 | \layout Description | |
|
6377 | \end_layout | |
|
5855 | 6378 | |
|
6379 | \begin_layout Description | |
|
5856 | 6380 | |
|
5857 |
\backslash |
|
|
6381 | \backslash | |
|
5858 | 6382 | w the current working directory |
|
5859 | \layout Description | |
|
6383 | \end_layout | |
|
5860 | 6384 | |
|
6385 | \begin_layout Description | |
|
5861 | 6386 | |
|
5862 |
\backslash |
|
|
6387 | \backslash | |
|
5863 | 6388 | W the basename of current working directory |
|
5864 | \layout Description | |
|
6389 | \end_layout | |
|
5865 | 6390 | |
|
6391 | \begin_layout Description | |
|
5866 | 6392 | |
|
5867 |
\backslash |
|
|
6393 | \backslash | |
|
5868 | 6394 | X |
|
5869 |
\emph on |
|
|
6395 | \emph on | |
|
5870 | 6396 | n |
|
5871 |
\emph default |
|
|
6397 | \emph default | |
|
5872 | 6398 | where |
|
5873 | 6399 | \begin_inset Formula $n=0\ldots5.$ |
|
5874 |
\end_inset |
|
|
6400 | \end_inset | |
|
5875 | 6401 | |
|
5876 | 6402 | The current working directory, with |
|
5877 |
\family typewriter |
|
|
6403 | \family typewriter | |
|
5878 | 6404 | $HOME |
|
5879 |
\family default |
|
|
6405 | \family default | |
|
5880 | 6406 | replaced by |
|
5881 |
\family typewriter |
|
|
6407 | \family typewriter | |
|
5882 | 6408 | ~ |
|
5883 |
\family default |
|
|
6409 | \family default | |
|
5884 | 6410 | , and filtered out to contain only |
|
5885 | 6411 | \begin_inset Formula $n$ |
|
5886 |
\end_inset |
|
|
6412 | \end_inset | |
|
5887 | 6413 | |
|
5888 | 6414 | path elements |
|
5889 | \layout Description | |
|
6415 | \end_layout | |
|
5890 | 6416 | |
|
6417 | \begin_layout Description | |
|
5891 | 6418 | |
|
5892 |
\backslash |
|
|
6419 | \backslash | |
|
5893 | 6420 | Y |
|
5894 |
\emph on |
|
|
6421 | \emph on | |
|
5895 | 6422 | n |
|
5896 |
\emph default |
|
|
6423 | \emph default | |
|
5897 | 6424 | Similar to |
|
5898 |
\backslash |
|
|
6425 | \backslash | |
|
5899 | 6426 | X |
|
5900 |
\emph on |
|
|
6427 | \emph on | |
|
5901 | 6428 | n |
|
5902 |
\emph default |
|
|
6429 | \emph default | |
|
5903 | 6430 | , but with the |
|
5904 | 6431 | \begin_inset Formula $n+1$ |
|
5905 |
\end_inset |
|
|
6432 | \end_inset | |
|
5906 | 6433 | |
|
5907 | 6434 | element included if it is |
|
5908 |
\family typewriter |
|
|
6435 | \family typewriter | |
|
5909 | 6436 | ~ |
|
5910 |
\family default |
|
|
6437 | \family default | |
|
5911 | 6438 | (this is similar to the behavior of the %c |
|
5912 |
\emph on |
|
|
6439 | \emph on | |
|
5913 | 6440 | n |
|
5914 |
\emph default |
|
|
6441 | \emph default | |
|
5915 | 6442 | escapes in |
|
5916 |
\family typewriter |
|
|
6443 | \family typewriter | |
|
5917 | 6444 | tcsh |
|
5918 |
\family default |
|
|
6445 | \family default | |
|
5919 | 6446 | ) |
|
5920 | \layout Description | |
|
6447 | \end_layout | |
|
5921 | 6448 | |
|
6449 | \begin_layout Description | |
|
5922 | 6450 | |
|
5923 |
\backslash |
|
|
6451 | \backslash | |
|
5924 | 6452 | u the username of the current user |
|
5925 | \layout Description | |
|
6453 | \end_layout | |
|
5926 | 6454 | |
|
6455 | \begin_layout Description | |
|
5927 | 6456 | |
|
5928 |
\backslash |
|
|
6457 | \backslash | |
|
5929 | 6458 | $ if the effective UID is 0, a #, otherwise a $ |
|
5930 | \layout Description | |
|
6459 | \end_layout | |
|
5931 | 6460 | |
|
6461 | \begin_layout Description | |
|
5932 | 6462 | |
|
5933 |
\backslash |
|
|
6463 | \backslash | |
|
5934 | 6464 | h the hostname up to the first `.' |
|
5935 | \layout Description | |
|
6465 | \end_layout | |
|
5936 | 6466 | |
|
6467 | \begin_layout Description | |
|
5937 | 6468 | |
|
5938 |
\backslash |
|
|
6469 | \backslash | |
|
5939 | 6470 | H the hostname |
|
5940 | \layout Description | |
|
6471 | \end_layout | |
|
5941 | 6472 | |
|
6473 | \begin_layout Description | |
|
5942 | 6474 | |
|
5943 |
\backslash |
|
|
6475 | \backslash | |
|
5944 | 6476 | n a newline |
|
5945 | \layout Description | |
|
6477 | \end_layout | |
|
5946 | 6478 | |
|
6479 | \begin_layout Description | |
|
5947 | 6480 | |
|
5948 |
\backslash |
|
|
6481 | \backslash | |
|
5949 | 6482 | r a carriage return |
|
5950 | \layout Description | |
|
6483 | \end_layout | |
|
5951 | 6484 | |
|
6485 | \begin_layout Description | |
|
5952 | 6486 | |
|
5953 |
\backslash |
|
|
6487 | \backslash | |
|
5954 | 6488 | v IPython version string |
|
5955 | \layout Standard | |
|
6489 | \end_layout | |
|
5956 | 6490 | |
|
6491 | \begin_layout Standard | |
|
5957 | 6492 | In addition to these, ANSI color escapes can be insterted into the prompts, |
|
5958 | 6493 | as |
|
5959 |
\family typewriter |
|
|
6494 | \family typewriter | |
|
5960 | 6495 | |
|
5961 |
\backslash |
|
|
6496 | \backslash | |
|
5962 | 6497 | C_ |
|
5963 |
\emph on |
|
|
6498 | \emph on | |
|
5964 | 6499 | ColorName |
|
5965 |
\family default |
|
|
5966 |
\emph default |
|
|
6500 | \family default | |
|
6501 | \emph default | |
|
5967 | 6502 | . |
|
5968 | 6503 | The list of valid color names is: Black, Blue, Brown, Cyan, DarkGray, Green, |
|
5969 | 6504 | LightBlue, LightCyan, LightGray, LightGreen, LightPurple, LightRed, NoColor, |
|
5970 | 6505 | Normal, Purple, Red, White, Yellow. |
|
5971 | \layout Standard | |
|
6506 | \end_layout | |
|
5972 | 6507 | |
|
6508 | \begin_layout Standard | |
|
5973 | 6509 | Finally, IPython supports the evaluation of arbitrary expressions in your |
|
5974 | 6510 | prompt string. |
|
5975 | 6511 | The prompt strings are evaluated through the syntax of PEP 215, but basically |
|
5976 | 6512 | you can use |
|
5977 |
\family typewriter |
|
|
6513 | \family typewriter | |
|
5978 | 6514 | $x.y |
|
5979 |
\family default |
|
|
6515 | \family default | |
|
5980 | 6516 | to expand the value of |
|
5981 |
\family typewriter |
|
|
6517 | \family typewriter | |
|
5982 | 6518 | x.y |
|
5983 |
\family default |
|
|
6519 | \family default | |
|
5984 | 6520 | , and for more complicated expressions you can use braces: |
|
5985 |
\family typewriter |
|
|
6521 | \family typewriter | |
|
5986 | 6522 | ${foo()+x} |
|
5987 |
\family default |
|
|
6523 | \family default | |
|
5988 | 6524 | will call function |
|
5989 |
\family typewriter |
|
|
6525 | \family typewriter | |
|
5990 | 6526 | foo |
|
5991 |
\family default |
|
|
6527 | \family default | |
|
5992 | 6528 | and add to it the value of |
|
5993 |
\family typewriter |
|
|
6529 | \family typewriter | |
|
5994 | 6530 | x |
|
5995 |
\family default |
|
|
6531 | \family default | |
|
5996 | 6532 | , before putting the result into your prompt. |
|
5997 | 6533 | For example, using |
|
5998 |
\newline |
|
|
6534 | \newline | |
|
5999 | 6535 | |
|
6000 |
\family typewriter |
|
|
6536 | \family typewriter | |
|
6001 | 6537 | prompt_in1 '${commands.getoutput("uptime")} |
|
6002 |
\backslash |
|
|
6538 | \backslash | |
|
6003 | 6539 | nIn [ |
|
6004 |
\backslash |
|
|
6540 | \backslash | |
|
6005 | 6541 | #]: ' |
|
6006 |
\newline |
|
|
6542 | \newline | |
|
6007 | 6543 | |
|
6008 |
\family default |
|
|
6544 | \family default | |
|
6009 | 6545 | will print the result of the uptime command on each prompt (assuming the |
|
6010 | 6546 | |
|
6011 |
\family typewriter |
|
|
6547 | \family typewriter | |
|
6012 | 6548 | commands |
|
6013 |
\family default |
|
|
6549 | \family default | |
|
6014 | 6550 | module has been imported in your |
|
6015 |
\family typewriter |
|
|
6551 | \family typewriter | |
|
6016 | 6552 | ipythonrc |
|
6017 |
\family default |
|
|
6553 | \family default | |
|
6018 | 6554 | file). |
|
6019 | \layout Subsubsection | |
|
6555 | \end_layout | |
|
6020 | 6556 | |
|
6557 | \begin_layout Subsubsection | |
|
6021 | 6558 | Prompt examples |
|
6022 | \layout Standard | |
|
6559 | \end_layout | |
|
6023 | 6560 | |
|
6561 | \begin_layout Standard | |
|
6024 | 6562 | The following options in an ipythonrc file will give you IPython's default |
|
6025 | 6563 | prompts: |
|
6026 | \layout Standard | |
|
6564 | \end_layout | |
|
6027 | 6565 | |
|
6566 | \begin_layout Standard | |
|
6028 | 6567 | |
|
6029 |
\family typewriter |
|
|
6568 | \family typewriter | |
|
6030 | 6569 | prompt_in1 'In [ |
|
6031 |
\backslash |
|
|
6570 | \backslash | |
|
6032 | 6571 | #]:' |
|
6033 |
\newline |
|
|
6034 |
prompt_in2 '\ |
|
|
6035 | \SpecialChar ~ | |
|
6036 | \SpecialChar ~ | |
|
6572 | \newline | |
|
6573 | prompt_in2 '\InsetSpace ~ | |
|
6574 | \InsetSpace ~ | |
|
6575 | \InsetSpace ~ | |
|
6037 | 6576 | . |
|
6038 |
\backslash |
|
|
6577 | \backslash | |
|
6039 | 6578 | D.:' |
|
6040 |
\newline |
|
|
6579 | \newline | |
|
6041 | 6580 | prompt_out 'Out[ |
|
6042 |
\backslash |
|
|
6581 | \backslash | |
|
6043 | 6582 | #]:' |
|
6044 | \layout Standard | |
|
6583 | \end_layout | |
|
6045 | 6584 | |
|
6585 | \begin_layout Standard | |
|
6046 | 6586 | which look like this: |
|
6047 | \layout Standard | |
|
6587 | \end_layout | |
|
6048 | 6588 | |
|
6589 | \begin_layout Standard | |
|
6049 | 6590 | |
|
6050 |
\family typewriter |
|
|
6591 | \family typewriter | |
|
6051 | 6592 | In [1]: 1+2 |
|
6052 |
\newline |
|
|
6593 | \newline | |
|
6053 | 6594 | Out[1]: 3 |
|
6054 | \layout Standard | |
|
6595 | \end_layout | |
|
6055 | 6596 | |
|
6597 | \begin_layout Standard | |
|
6056 | 6598 | |
|
6057 |
\family typewriter |
|
|
6599 | \family typewriter | |
|
6058 | 6600 | In [2]: for i in (1,2,3): |
|
6059 |
\newline |
|
|
6601 | \newline | |
|
6060 | 6602 | |
|
6061 | 6603 | \begin_inset ERT |
|
6062 |
status |
|
|
6604 | status collapsed | |
|
6605 | ||
|
6606 | \begin_layout Standard | |
|
6063 | 6607 | |
|
6064 | \layout Standard | |
|
6065 | 6608 | |
|
6066 |
\backslash |
|
|
6609 | \backslash | |
|
6067 | 6610 | hspace*{0mm} |
|
6068 | \end_inset | |
|
6069 | ||
|
6070 | \SpecialChar ~ | |
|
6071 | \SpecialChar ~ | |
|
6072 | \SpecialChar ~ | |
|
6073 | ...: \SpecialChar ~ | |
|
6074 | \SpecialChar ~ | |
|
6075 | \SpecialChar ~ | |
|
6076 | \SpecialChar ~ | |
|
6611 | \end_layout | |
|
6612 | ||
|
6613 | \end_inset | |
|
6614 | ||
|
6615 | \InsetSpace ~ | |
|
6616 | \InsetSpace ~ | |
|
6617 | \InsetSpace ~ | |
|
6618 | ...: \InsetSpace ~ | |
|
6619 | \InsetSpace ~ | |
|
6620 | \InsetSpace ~ | |
|
6621 | \InsetSpace ~ | |
|
6077 | 6622 | print i, |
|
6078 |
\newline |
|
|
6623 | \newline | |
|
6079 | 6624 | |
|
6080 | 6625 | \begin_inset ERT |
|
6081 |
status |
|
|
6626 | status collapsed | |
|
6627 | ||
|
6628 | \begin_layout Standard | |
|
6082 | 6629 | |
|
6083 | \layout Standard | |
|
6084 | 6630 | |
|
6085 |
\backslash |
|
|
6631 | \backslash | |
|
6086 | 6632 | hspace*{0mm} |
|
6087 | \end_inset | |
|
6633 | \end_layout | |
|
6088 | 6634 | |
|
6089 | \SpecialChar ~ | |
|
6090 | \SpecialChar ~ | |
|
6091 | \SpecialChar ~ | |
|
6635 | \end_inset | |
|
6636 | ||
|
6637 | \InsetSpace ~ | |
|
6638 | \InsetSpace ~ | |
|
6639 | \InsetSpace ~ | |
|
6092 | 6640 | ...: |
|
6093 |
\newline |
|
|
6641 | \newline | |
|
6094 | 6642 | 1 2 3 |
|
6095 | \layout Standard | |
|
6643 | \end_layout | |
|
6096 | 6644 | |
|
6645 | \begin_layout Standard | |
|
6097 | 6646 | These will give you a very colorful prompt with path information: |
|
6098 | \layout Standard | |
|
6647 | \end_layout | |
|
6099 | 6648 | |
|
6649 | \begin_layout Standard | |
|
6100 | 6650 | |
|
6101 |
\family typewriter |
|
|
6651 | \family typewriter | |
|
6102 | 6652 | #prompt_in1 ' |
|
6103 |
\backslash |
|
|
6653 | \backslash | |
|
6104 | 6654 | C_Red |
|
6105 |
\backslash |
|
|
6655 | \backslash | |
|
6106 | 6656 | u |
|
6107 |
\backslash |
|
|
6657 | \backslash | |
|
6108 | 6658 | C_Blue[ |
|
6109 |
\backslash |
|
|
6659 | \backslash | |
|
6110 | 6660 | C_Cyan |
|
6111 |
\backslash |
|
|
6661 | \backslash | |
|
6112 | 6662 | Y1 |
|
6113 |
\backslash |
|
|
6663 | \backslash | |
|
6114 | 6664 | C_Blue] |
|
6115 |
\backslash |
|
|
6665 | \backslash | |
|
6116 | 6666 | C_LightGreen |
|
6117 |
\backslash |
|
|
6667 | \backslash | |
|
6118 | 6668 | #>' |
|
6119 |
\newline |
|
|
6669 | \newline | |
|
6120 | 6670 | prompt_in2 ' .. |
|
6121 |
\backslash |
|
|
6671 | \backslash | |
|
6122 | 6672 | D>' |
|
6123 |
\newline |
|
|
6673 | \newline | |
|
6124 | 6674 | prompt_out '< |
|
6125 |
\backslash |
|
|
6675 | \backslash | |
|
6126 | 6676 | #>' |
|
6127 | \layout Standard | |
|
6677 | \end_layout | |
|
6128 | 6678 | |
|
6679 | \begin_layout Standard | |
|
6129 | 6680 | which look like this: |
|
6130 | \layout Standard | |
|
6681 | \end_layout | |
|
6131 | 6682 | |
|
6683 | \begin_layout Standard | |
|
6132 | 6684 | |
|
6133 |
\family typewriter |
|
|
6685 | \family typewriter | |
|
6134 | 6686 | \color red |
|
6135 | 6687 | fperez |
|
6136 | 6688 | \color blue |
@@ -6143,39 +6695,42 b' fperez' | |||
|
6143 | 6695 | 1> |
|
6144 | 6696 | \color default |
|
6145 | 6697 | 1+2 |
|
6146 |
\newline |
|
|
6698 | \newline | |
|
6147 | 6699 | |
|
6148 | 6700 | \begin_inset ERT |
|
6149 |
status |
|
|
6701 | status collapsed | |
|
6702 | ||
|
6703 | \begin_layout Standard | |
|
6150 | 6704 | |
|
6151 | \layout Standard | |
|
6152 | 6705 | |
|
6153 |
\backslash |
|
|
6706 | \backslash | |
|
6154 | 6707 | hspace*{0mm} |
|
6155 | \end_inset | |
|
6156 | ||
|
6157 | \SpecialChar ~ | |
|
6158 | \SpecialChar ~ | |
|
6159 | \SpecialChar ~ | |
|
6160 | \SpecialChar ~ | |
|
6161 | \SpecialChar ~ | |
|
6162 | \SpecialChar ~ | |
|
6163 | \SpecialChar ~ | |
|
6164 | \SpecialChar ~ | |
|
6165 | \SpecialChar ~ | |
|
6166 | \SpecialChar ~ | |
|
6167 | \SpecialChar ~ | |
|
6168 | \SpecialChar ~ | |
|
6169 | \SpecialChar ~ | |
|
6170 | \SpecialChar ~ | |
|
6171 | \SpecialChar ~ | |
|
6172 | \SpecialChar ~ | |
|
6708 | \end_layout | |
|
6709 | ||
|
6710 | \end_inset | |
|
6711 | ||
|
6712 | \InsetSpace ~ | |
|
6713 | \InsetSpace ~ | |
|
6714 | \InsetSpace ~ | |
|
6715 | \InsetSpace ~ | |
|
6716 | \InsetSpace ~ | |
|
6717 | \InsetSpace ~ | |
|
6718 | \InsetSpace ~ | |
|
6719 | \InsetSpace ~ | |
|
6720 | \InsetSpace ~ | |
|
6721 | \InsetSpace ~ | |
|
6722 | \InsetSpace ~ | |
|
6723 | \InsetSpace ~ | |
|
6724 | \InsetSpace ~ | |
|
6725 | \InsetSpace ~ | |
|
6726 | \InsetSpace ~ | |
|
6727 | \InsetSpace ~ | |
|
6173 | 6728 | |
|
6174 | 6729 | \color red |
|
6175 | 6730 | <1> |
|
6176 | 6731 | \color default |
|
6177 | 6732 | 3 |
|
6178 |
\newline |
|
|
6733 | \newline | |
|
6179 | 6734 | |
|
6180 | 6735 | \color red |
|
6181 | 6736 | fperez |
@@ -6189,123 +6744,132 b' fperez' | |||
|
6189 | 6744 | 2> |
|
6190 | 6745 | \color default |
|
6191 | 6746 | for i in (1,2,3): |
|
6192 |
\newline |
|
|
6747 | \newline | |
|
6193 | 6748 | |
|
6194 | 6749 | \begin_inset ERT |
|
6195 |
status |
|
|
6750 | status collapsed | |
|
6751 | ||
|
6752 | \begin_layout Standard | |
|
6196 | 6753 | |
|
6197 | \layout Standard | |
|
6198 | 6754 | |
|
6199 |
\backslash |
|
|
6755 | \backslash | |
|
6200 | 6756 | hspace*{0mm} |
|
6201 | \end_inset | |
|
6202 | ||
|
6203 | \SpecialChar ~ | |
|
6204 | \SpecialChar ~ | |
|
6205 | \SpecialChar ~ | |
|
6206 | \SpecialChar ~ | |
|
6207 | \SpecialChar ~ | |
|
6208 | \SpecialChar ~ | |
|
6209 | \SpecialChar ~ | |
|
6210 | \SpecialChar ~ | |
|
6211 | \SpecialChar ~ | |
|
6212 | \SpecialChar ~ | |
|
6213 | \SpecialChar ~ | |
|
6214 | \SpecialChar ~ | |
|
6215 | \SpecialChar ~ | |
|
6216 | \SpecialChar ~ | |
|
6217 | \SpecialChar ~ | |
|
6757 | \end_layout | |
|
6758 | ||
|
6759 | \end_inset | |
|
6760 | ||
|
6761 | \InsetSpace ~ | |
|
6762 | \InsetSpace ~ | |
|
6763 | \InsetSpace ~ | |
|
6764 | \InsetSpace ~ | |
|
6765 | \InsetSpace ~ | |
|
6766 | \InsetSpace ~ | |
|
6767 | \InsetSpace ~ | |
|
6768 | \InsetSpace ~ | |
|
6769 | \InsetSpace ~ | |
|
6770 | \InsetSpace ~ | |
|
6771 | \InsetSpace ~ | |
|
6772 | \InsetSpace ~ | |
|
6773 | \InsetSpace ~ | |
|
6774 | \InsetSpace ~ | |
|
6775 | \InsetSpace ~ | |
|
6218 | 6776 | |
|
6219 | 6777 | \color green |
|
6220 | 6778 | ...> |
|
6221 | 6779 | \color default |
|
6222 | \SpecialChar ~ | |
|
6223 | \SpecialChar ~ | |
|
6224 | \SpecialChar ~ | |
|
6225 | \SpecialChar ~ | |
|
6780 | \InsetSpace ~ | |
|
6781 | \InsetSpace ~ | |
|
6782 | \InsetSpace ~ | |
|
6783 | \InsetSpace ~ | |
|
6226 | 6784 | print i, |
|
6227 |
\newline |
|
|
6785 | \newline | |
|
6228 | 6786 | |
|
6229 | 6787 | \begin_inset ERT |
|
6230 |
status |
|
|
6788 | status collapsed | |
|
6231 | 6789 | |
|
6232 | \layout Standard | |
|
6790 | \begin_layout Standard | |
|
6233 | 6791 | |
|
6234 | \backslash | |
|
6792 | ||
|
6793 | \backslash | |
|
6235 | 6794 | hspace*{0mm} |
|
6236 | \end_inset | |
|
6237 | ||
|
6238 | \SpecialChar ~ | |
|
6239 | \SpecialChar ~ | |
|
6240 | \SpecialChar ~ | |
|
6241 | \SpecialChar ~ | |
|
6242 | \SpecialChar ~ | |
|
6243 | \SpecialChar ~ | |
|
6244 | \SpecialChar ~ | |
|
6245 | \SpecialChar ~ | |
|
6246 | \SpecialChar ~ | |
|
6247 | \SpecialChar ~ | |
|
6248 | \SpecialChar ~ | |
|
6249 | \SpecialChar ~ | |
|
6250 | \SpecialChar ~ | |
|
6251 | \SpecialChar ~ | |
|
6252 | \SpecialChar ~ | |
|
6795 | \end_layout | |
|
6796 | ||
|
6797 | \end_inset | |
|
6798 | ||
|
6799 | \InsetSpace ~ | |
|
6800 | \InsetSpace ~ | |
|
6801 | \InsetSpace ~ | |
|
6802 | \InsetSpace ~ | |
|
6803 | \InsetSpace ~ | |
|
6804 | \InsetSpace ~ | |
|
6805 | \InsetSpace ~ | |
|
6806 | \InsetSpace ~ | |
|
6807 | \InsetSpace ~ | |
|
6808 | \InsetSpace ~ | |
|
6809 | \InsetSpace ~ | |
|
6810 | \InsetSpace ~ | |
|
6811 | \InsetSpace ~ | |
|
6812 | \InsetSpace ~ | |
|
6813 | \InsetSpace ~ | |
|
6253 | 6814 | |
|
6254 | 6815 | \color green |
|
6255 | 6816 | ...> |
|
6256 | 6817 | \color default |
|
6257 | 6818 | |
|
6258 |
\newline |
|
|
6819 | \newline | |
|
6259 | 6820 | 1 2 3 |
|
6260 | \layout Standard | |
|
6821 | \end_layout | |
|
6261 | 6822 | |
|
6823 | \begin_layout Standard | |
|
6262 | 6824 | The following shows the usage of dynamic expression evaluation: |
|
6263 | \layout Subsection | |
|
6264 | ||
|
6825 | \end_layout | |
|
6265 | 6826 | |
|
6827 | \begin_layout Subsection | |
|
6266 | 6828 | \begin_inset LatexCommand \label{sec:profiles} |
|
6267 | 6829 | |
|
6268 |
\end_inset |
|
|
6830 | \end_inset | |
|
6269 | 6831 | |
|
6270 | 6832 | IPython profiles |
|
6271 | \layout Standard | |
|
6833 | \end_layout | |
|
6272 | 6834 | |
|
6835 | \begin_layout Standard | |
|
6273 | 6836 | As we already mentioned, IPython supports the |
|
6274 |
\family typewriter |
|
|
6837 | \family typewriter | |
|
6275 | 6838 | -profile |
|
6276 |
\family default |
|
|
6839 | \family default | |
|
6277 | 6840 | command-line option (see sec. |
|
6278 | 6841 | |
|
6279 | 6842 | \begin_inset LatexCommand \ref{sec:cmd-line-opts} |
|
6280 | 6843 | |
|
6281 |
\end_inset |
|
|
6844 | \end_inset | |
|
6282 | 6845 | |
|
6283 | 6846 | ). |
|
6284 | 6847 | A profile is nothing more than a particular configuration file like your |
|
6285 | 6848 | basic |
|
6286 |
\family typewriter |
|
|
6849 | \family typewriter | |
|
6287 | 6850 | ipythonrc |
|
6288 |
\family default |
|
|
6851 | \family default | |
|
6289 | 6852 | one, but with particular customizations for a specific purpose. |
|
6290 | 6853 | When you start IPython with ' |
|
6291 |
\family typewriter |
|
|
6854 | \family typewriter | |
|
6292 | 6855 | ipython -profile <name> |
|
6293 |
\family default |
|
|
6856 | \family default | |
|
6294 | 6857 | ', it assumes that in your |
|
6295 |
\family typewriter |
|
|
6858 | \family typewriter | |
|
6296 | 6859 | IPYTHONDIR |
|
6297 |
\family default |
|
|
6860 | \family default | |
|
6298 | 6861 | there is a file called |
|
6299 |
\family typewriter |
|
|
6862 | \family typewriter | |
|
6300 | 6863 | ipythonrc-<name> |
|
6301 |
\family default |
|
|
6864 | \family default | |
|
6302 | 6865 | , and loads it instead of the normal |
|
6303 |
\family typewriter |
|
|
6866 | \family typewriter | |
|
6304 | 6867 | ipythonrc |
|
6305 |
\family default |
|
|
6868 | \family default | |
|
6306 | 6869 | . |
|
6307 | \layout Standard | |
|
6870 | \end_layout | |
|
6308 | 6871 | |
|
6872 | \begin_layout Standard | |
|
6309 | 6873 | This system allows you to maintain multiple configurations which load modules, |
|
6310 | 6874 | set options, define functions, etc. |
|
6311 | 6875 | suitable for different tasks and activate them in a very simple manner. |
@@ -6314,1654 +6878,1836 b' This system allows you to maintain multiple configurations which load modules,' | |||
|
6314 | 6878 | can include another configuration file. |
|
6315 | 6879 | The most common way to use profiles is then to have each one include your |
|
6316 | 6880 | basic |
|
6317 |
\family typewriter |
|
|
6881 | \family typewriter | |
|
6318 | 6882 | ipythonrc |
|
6319 |
\family default |
|
|
6883 | \family default | |
|
6320 | 6884 | file as a starting point, and then add further customizations. |
|
6321 | \layout Standard | |
|
6885 | \end_layout | |
|
6322 | 6886 | |
|
6887 | \begin_layout Standard | |
|
6323 | 6888 | In sections |
|
6324 | 6889 | \begin_inset LatexCommand \ref{sec:syntax-extensions} |
|
6325 | 6890 | |
|
6326 |
\end_inset |
|
|
6891 | \end_inset | |
|
6327 | 6892 | |
|
6328 | 6893 | and |
|
6329 | 6894 | \begin_inset LatexCommand \ref{sec:Gnuplot} |
|
6330 | 6895 | |
|
6331 |
\end_inset |
|
|
6896 | \end_inset | |
|
6332 | 6897 | |
|
6333 | 6898 | we discuss some particular profiles which come as part of the standard |
|
6334 | 6899 | IPython distribution. |
|
6335 | 6900 | You may also look in your |
|
6336 |
\family typewriter |
|
|
6901 | \family typewriter | |
|
6337 | 6902 | IPYTHONDIR |
|
6338 |
\family default |
|
|
6903 | \family default | |
|
6339 | 6904 | directory, any file whose name begins with |
|
6340 |
\family typewriter |
|
|
6905 | \family typewriter | |
|
6341 | 6906 | ipythonrc- |
|
6342 |
\family default |
|
|
6907 | \family default | |
|
6343 | 6908 | is a profile. |
|
6344 | 6909 | You can use those as examples for further customizations to suit your own |
|
6345 | 6910 | needs. |
|
6346 | \layout Section | |
|
6347 | ||
|
6911 | \end_layout | |
|
6348 | 6912 | |
|
6913 | \begin_layout Section | |
|
6349 | 6914 | \begin_inset OptArg |
|
6350 | collapsed false | |
|
6351 | ||
|
6352 | \layout Standard | |
|
6915 | status open | |
|
6353 | 6916 | |
|
6917 | \begin_layout Standard | |
|
6354 | 6918 | IPython as default... |
|
6355 | \end_inset | |
|
6919 | \end_layout | |
|
6920 | ||
|
6921 | \end_inset | |
|
6356 | 6922 | |
|
6357 | 6923 | IPython as your default Python environment |
|
6358 | \layout Standard | |
|
6924 | \end_layout | |
|
6359 | 6925 | |
|
6926 | \begin_layout Standard | |
|
6360 | 6927 | Python honors the environment variable |
|
6361 |
\family typewriter |
|
|
6928 | \family typewriter | |
|
6362 | 6929 | PYTHONSTARTUP |
|
6363 |
\family default |
|
|
6930 | \family default | |
|
6364 | 6931 | and will execute at startup the file referenced by this variable. |
|
6365 | 6932 | If you put at the end of this file the following two lines of code: |
|
6366 | \layout Standard | |
|
6933 | \end_layout | |
|
6367 | 6934 | |
|
6935 | \begin_layout Standard | |
|
6368 | 6936 | |
|
6369 |
\family typewriter |
|
|
6937 | \family typewriter | |
|
6370 | 6938 | import IPython |
|
6371 |
\newline |
|
|
6939 | \newline | |
|
6372 | 6940 | IPython.Shell.IPShell().mainloop(sys_exit=1) |
|
6373 | \layout Standard | |
|
6941 | \end_layout | |
|
6374 | 6942 | |
|
6943 | \begin_layout Standard | |
|
6375 | 6944 | then IPython will be your working environment anytime you start Python. |
|
6376 | 6945 | The |
|
6377 |
\family typewriter |
|
|
6946 | \family typewriter | |
|
6378 | 6947 | sys_exit=1 |
|
6379 |
\family default |
|
|
6948 | \family default | |
|
6380 | 6949 | is needed to have IPython issue a call to |
|
6381 |
\family typewriter |
|
|
6950 | \family typewriter | |
|
6382 | 6951 | sys.exit() |
|
6383 |
\family default |
|
|
6952 | \family default | |
|
6384 | 6953 | when it finishes, otherwise you'll be back at the normal Python ' |
|
6385 |
\family typewriter |
|
|
6954 | \family typewriter | |
|
6386 | 6955 | >>> |
|
6387 |
\family default |
|
|
6956 | \family default | |
|
6388 | 6957 | ' prompt |
|
6389 | 6958 | \begin_inset Foot |
|
6390 |
collapsed |
|
|
6391 | ||
|
6392 | \layout Standard | |
|
6959 | status collapsed | |
|
6393 | 6960 | |
|
6961 | \begin_layout Standard | |
|
6394 | 6962 | Based on an idea by Holger Krekel. |
|
6395 | \end_inset | |
|
6963 | \end_layout | |
|
6964 | ||
|
6965 | \end_inset | |
|
6396 | 6966 | |
|
6397 | 6967 | . |
|
6398 | \layout Standard | |
|
6968 | \end_layout | |
|
6399 | 6969 | |
|
6970 | \begin_layout Standard | |
|
6400 | 6971 | This is probably useful to developers who manage multiple Python versions |
|
6401 | 6972 | and don't want to have correspondingly multiple IPython versions. |
|
6402 | 6973 | Note that in this mode, there is no way to pass IPython any command-line |
|
6403 | 6974 | options, as those are trapped first by Python itself. |
|
6404 | \layout Section | |
|
6405 | ||
|
6975 | \end_layout | |
|
6406 | 6976 | |
|
6977 | \begin_layout Section | |
|
6407 | 6978 | \begin_inset LatexCommand \label{sec:embed} |
|
6408 | 6979 | |
|
6409 |
\end_inset |
|
|
6980 | \end_inset | |
|
6410 | 6981 | |
|
6411 | 6982 | Embedding IPython |
|
6412 | \layout Standard | |
|
6983 | \end_layout | |
|
6413 | 6984 | |
|
6985 | \begin_layout Standard | |
|
6414 | 6986 | It is possible to start an IPython instance |
|
6415 |
\emph on |
|
|
6987 | \emph on | |
|
6416 | 6988 | inside |
|
6417 |
\emph default |
|
|
6989 | \emph default | |
|
6418 | 6990 | your own Python programs. |
|
6419 | 6991 | This allows you to evaluate dynamically the state of your code, operate |
|
6420 | 6992 | with your variables, analyze them, etc. |
|
6421 | 6993 | Note however that any changes you make to values while in the shell do |
|
6422 | 6994 | |
|
6423 |
\emph on |
|
|
6995 | \emph on | |
|
6424 | 6996 | not |
|
6425 |
\emph default |
|
|
6997 | \emph default | |
|
6426 | 6998 | propagate back to the running code, so it is safe to modify your values |
|
6427 | 6999 | because you won't break your code in bizarre ways by doing so. |
|
6428 | \layout Standard | |
|
7000 | \end_layout | |
|
6429 | 7001 | |
|
7002 | \begin_layout Standard | |
|
6430 | 7003 | This feature allows you to easily have a fully functional python environment |
|
6431 | 7004 | for doing object introspection anywhere in your code with a simple function |
|
6432 | 7005 | call. |
|
6433 | 7006 | In some cases a simple print statement is enough, but if you need to do |
|
6434 | 7007 | more detailed analysis of a code fragment this feature can be very valuable. |
|
6435 | \layout Standard | |
|
7008 | \end_layout | |
|
6436 | 7009 | |
|
7010 | \begin_layout Standard | |
|
6437 | 7011 | It can also be useful in scientific computing situations where it is common |
|
6438 | 7012 | to need to do some automatic, computationally intensive part and then stop |
|
6439 | 7013 | to look at data, plots, etc |
|
6440 | 7014 | \begin_inset Foot |
|
6441 |
collapsed |
|
|
6442 | ||
|
6443 | \layout Standard | |
|
7015 | status collapsed | |
|
6444 | 7016 | |
|
7017 | \begin_layout Standard | |
|
6445 | 7018 | This functionality was inspired by IDL's combination of the |
|
6446 |
\family typewriter |
|
|
7019 | \family typewriter | |
|
6447 | 7020 | stop |
|
6448 |
\family default |
|
|
7021 | \family default | |
|
6449 | 7022 | keyword and the |
|
6450 |
\family typewriter |
|
|
7023 | \family typewriter | |
|
6451 | 7024 | .continue |
|
6452 |
\family default |
|
|
7025 | \family default | |
|
6453 | 7026 | executive command, which I have found very useful in the past, and by a |
|
6454 | 7027 | posting on comp.lang.python by cmkl <cmkleffner-AT-gmx.de> on Dec. |
|
6455 | 7028 | 06/01 concerning similar uses of pyrepl. |
|
6456 | \end_inset | |
|
7029 | \end_layout | |
|
7030 | ||
|
7031 | \end_inset | |
|
6457 | 7032 | |
|
6458 | 7033 | . |
|
6459 | 7034 | Opening an IPython instance will give you full access to your data and |
|
6460 | 7035 | functions, and you can resume program execution once you are done with |
|
6461 | 7036 | the interactive part (perhaps to stop again later, as many times as needed). |
|
6462 | \layout Standard | |
|
7037 | \end_layout | |
|
6463 | 7038 | |
|
7039 | \begin_layout Standard | |
|
6464 | 7040 | The following code snippet is the bare minimum you need to include in your |
|
6465 | 7041 | Python programs for this to work (detailed examples follow later): |
|
6466 | \layout LyX-Code | |
|
7042 | \end_layout | |
|
6467 | 7043 | |
|
7044 | \begin_layout LyX-Code | |
|
6468 | 7045 | from IPython.Shell import IPShellEmbed |
|
6469 | \layout LyX-Code | |
|
7046 | \end_layout | |
|
6470 | 7047 | |
|
7048 | \begin_layout LyX-Code | |
|
6471 | 7049 | ipshell = IPShellEmbed() |
|
6472 | \layout LyX-Code | |
|
7050 | \end_layout | |
|
6473 | 7051 | |
|
7052 | \begin_layout LyX-Code | |
|
6474 | 7053 | ipshell() # this call anywhere in your program will start IPython |
|
6475 | \layout Standard | |
|
7054 | \end_layout | |
|
6476 | 7055 | |
|
7056 | \begin_layout Standard | |
|
6477 | 7057 | You can run embedded instances even in code which is itself being run at |
|
6478 | 7058 | the IPython interactive prompt with ' |
|
6479 |
\family typewriter |
|
|
6480 | %run\SpecialChar ~ | |
|
7059 | \family typewriter | |
|
7060 | %run\InsetSpace ~ | |
|
6481 | 7061 | <filename> |
|
6482 |
\family default |
|
|
7062 | \family default | |
|
6483 | 7063 | '. |
|
6484 | 7064 | Since it's easy to get lost as to where you are (in your top-level IPython |
|
6485 | 7065 | or in your embedded one), it's a good idea in such cases to set the in/out |
|
6486 | 7066 | prompts to something different for the embedded instances. |
|
6487 | 7067 | The code examples below illustrate this. |
|
6488 | \layout Standard | |
|
7068 | \end_layout | |
|
6489 | 7069 | |
|
7070 | \begin_layout Standard | |
|
6490 | 7071 | You can also have multiple IPython instances in your program and open them |
|
6491 | 7072 | separately, for example with different options for data presentation. |
|
6492 | 7073 | If you close and open the same instance multiple times, its prompt counters |
|
6493 | 7074 | simply continue from each execution to the next. |
|
6494 | \layout Standard | |
|
7075 | \end_layout | |
|
6495 | 7076 | |
|
7077 | \begin_layout Standard | |
|
6496 | 7078 | Please look at the docstrings in the |
|
6497 |
\family typewriter |
|
|
7079 | \family typewriter | |
|
6498 | 7080 | Shell.py |
|
6499 |
\family default |
|
|
7081 | \family default | |
|
6500 | 7082 | module for more details on the use of this system. |
|
6501 | \layout Standard | |
|
7083 | \end_layout | |
|
6502 | 7084 | |
|
7085 | \begin_layout Standard | |
|
6503 | 7086 | The following sample file illustrating how to use the embedding functionality |
|
6504 | 7087 | is provided in the examples directory as |
|
6505 |
\family typewriter |
|
|
7088 | \family typewriter | |
|
6506 | 7089 | example-embed.py |
|
6507 |
\family default |
|
|
7090 | \family default | |
|
6508 | 7091 | . |
|
6509 | 7092 | It should be fairly self-explanatory: |
|
6510 | \layout Standard | |
|
6511 | ||
|
7093 | \end_layout | |
|
6512 | 7094 | |
|
7095 | \begin_layout Standard | |
|
6513 | 7096 | \begin_inset ERT |
|
6514 |
status |
|
|
7097 | status open | |
|
7098 | ||
|
7099 | \begin_layout Standard | |
|
6515 | 7100 | |
|
6516 | \layout Standard | |
|
6517 | 7101 | |
|
6518 |
\backslash |
|
|
7102 | \backslash | |
|
6519 | 7103 | codelist{examples/example-embed.py} |
|
6520 | \end_inset | |
|
7104 | \end_layout | |
|
7105 | ||
|
7106 | \end_inset | |
|
6521 | 7107 | |
|
6522 | 7108 | |
|
6523 | \layout Standard | |
|
7109 | \end_layout | |
|
6524 | 7110 | |
|
7111 | \begin_layout Standard | |
|
6525 | 7112 | Once you understand how the system functions, you can use the following |
|
6526 | 7113 | code fragments in your programs which are ready for cut and paste: |
|
6527 | \layout Standard | |
|
6528 | ||
|
7114 | \end_layout | |
|
6529 | 7115 | |
|
7116 | \begin_layout Standard | |
|
6530 | 7117 | \begin_inset ERT |
|
6531 |
status |
|
|
7118 | status open | |
|
7119 | ||
|
7120 | \begin_layout Standard | |
|
6532 | 7121 | |
|
6533 | \layout Standard | |
|
6534 | 7122 | |
|
6535 |
\backslash |
|
|
7123 | \backslash | |
|
6536 | 7124 | codelist{examples/example-embed-short.py} |
|
6537 | \end_inset | |
|
7125 | \end_layout | |
|
6538 | 7126 | |
|
7127 | \end_inset | |
|
6539 | 7128 | |
|
6540 | \layout Section | |
|
6541 | 7129 | |
|
7130 | \end_layout | |
|
6542 | 7131 | |
|
7132 | \begin_layout Section | |
|
6543 | 7133 | \begin_inset LatexCommand \label{sec:using-pdb} |
|
6544 | 7134 | |
|
6545 |
\end_inset |
|
|
7135 | \end_inset | |
|
6546 | 7136 | |
|
6547 | 7137 | Using the Python debugger ( |
|
6548 |
\family typewriter |
|
|
7138 | \family typewriter | |
|
6549 | 7139 | pdb |
|
6550 |
\family default |
|
|
7140 | \family default | |
|
6551 | 7141 | ) |
|
6552 | \layout Subsection | |
|
7142 | \end_layout | |
|
6553 | 7143 | |
|
7144 | \begin_layout Subsection | |
|
6554 | 7145 | Running entire programs via |
|
6555 |
\family typewriter |
|
|
7146 | \family typewriter | |
|
6556 | 7147 | pdb |
|
6557 | \layout Standard | |
|
7148 | \end_layout | |
|
6558 | 7149 | |
|
7150 | \begin_layout Standard | |
|
6559 | 7151 | |
|
6560 |
\family typewriter |
|
|
7152 | \family typewriter | |
|
6561 | 7153 | pdb |
|
6562 |
\family default |
|
|
7154 | \family default | |
|
6563 | 7155 | , the Python debugger, is a powerful interactive debugger which allows you |
|
6564 | 7156 | to step through code, set breakpoints, watch variables, etc. |
|
6565 | 7157 | IPython makes it very easy to start any script under the control of |
|
6566 |
\family typewriter |
|
|
7158 | \family typewriter | |
|
6567 | 7159 | pdb |
|
6568 |
\family default |
|
|
7160 | \family default | |
|
6569 | 7161 | , regardless of whether you have wrapped it into a |
|
6570 |
\family typewriter |
|
|
7162 | \family typewriter | |
|
6571 | 7163 | `main()' |
|
6572 |
\family default |
|
|
7164 | \family default | |
|
6573 | 7165 | function or not. |
|
6574 | 7166 | For this, simply type |
|
6575 |
\family typewriter |
|
|
7167 | \family typewriter | |
|
6576 | 7168 | `%run -d myscript' |
|
6577 |
\family default |
|
|
7169 | \family default | |
|
6578 | 7170 | at an IPython prompt. |
|
6579 | 7171 | See the |
|
6580 |
\family typewriter |
|
|
7172 | \family typewriter | |
|
6581 | 7173 | %run |
|
6582 |
\family default |
|
|
7174 | \family default | |
|
6583 | 7175 | command's documentation (via |
|
6584 |
\family typewriter |
|
|
7176 | \family typewriter | |
|
6585 | 7177 | `%run?' |
|
6586 |
\family default |
|
|
6587 |
or in Sec.\ |
|
|
7178 | \family default | |
|
7179 | or in Sec.\InsetSpace ~ | |
|
6588 | 7180 | |
|
6589 | 7181 | \begin_inset LatexCommand \ref{sec:magic} |
|
6590 | 7182 | |
|
6591 |
\end_inset |
|
|
7183 | \end_inset | |
|
6592 | 7184 | |
|
6593 | 7185 | ) for more details, including how to control where |
|
6594 |
\family typewriter |
|
|
7186 | \family typewriter | |
|
6595 | 7187 | pdb |
|
6596 |
\family default |
|
|
7188 | \family default | |
|
6597 | 7189 | will stop execution first. |
|
6598 | \layout Standard | |
|
7190 | \end_layout | |
|
6599 | 7191 | |
|
7192 | \begin_layout Standard | |
|
6600 | 7193 | For more information on the use of the |
|
6601 |
\family typewriter |
|
|
7194 | \family typewriter | |
|
6602 | 7195 | pdb |
|
6603 |
\family default |
|
|
7196 | \family default | |
|
6604 | 7197 | debugger, read the included |
|
6605 |
\family typewriter |
|
|
7198 | \family typewriter | |
|
6606 | 7199 | pdb.doc |
|
6607 |
\family default |
|
|
7200 | \family default | |
|
6608 | 7201 | file (part of the standard Python distribution). |
|
6609 | 7202 | On a stock Linux system it is located at |
|
6610 |
\family typewriter |
|
|
7203 | \family typewriter | |
|
6611 | 7204 | /usr/lib/python2.3/pdb.doc |
|
6612 |
\family default |
|
|
7205 | \family default | |
|
6613 | 7206 | , but the easiest way to read it is by using the |
|
6614 |
\family typewriter |
|
|
7207 | \family typewriter | |
|
6615 | 7208 | help() |
|
6616 |
\family default |
|
|
7209 | \family default | |
|
6617 | 7210 | function of the |
|
6618 |
\family typewriter |
|
|
7211 | \family typewriter | |
|
6619 | 7212 | pdb |
|
6620 |
\family default |
|
|
7213 | \family default | |
|
6621 | 7214 | module as follows (in an IPython prompt): |
|
6622 | \layout Standard | |
|
7215 | \end_layout | |
|
6623 | 7216 | |
|
7217 | \begin_layout Standard | |
|
6624 | 7218 | |
|
6625 |
\family typewriter |
|
|
7219 | \family typewriter | |
|
6626 | 7220 | In [1]: import pdb |
|
6627 |
\newline |
|
|
7221 | \newline | |
|
6628 | 7222 | In [2]: pdb.help() |
|
6629 | \layout Standard | |
|
7223 | \end_layout | |
|
6630 | 7224 | |
|
7225 | \begin_layout Standard | |
|
6631 | 7226 | This will load the |
|
6632 |
\family typewriter |
|
|
7227 | \family typewriter | |
|
6633 | 7228 | pdb.doc |
|
6634 |
\family default |
|
|
7229 | \family default | |
|
6635 | 7230 | document in a file viewer for you automatically. |
|
6636 | \layout Subsection | |
|
7231 | \end_layout | |
|
6637 | 7232 | |
|
7233 | \begin_layout Subsection | |
|
6638 | 7234 | Automatic invocation of |
|
6639 |
\family typewriter |
|
|
7235 | \family typewriter | |
|
6640 | 7236 | pdb |
|
6641 |
\family default |
|
|
7237 | \family default | |
|
6642 | 7238 | on exceptions |
|
6643 | \layout Standard | |
|
7239 | \end_layout | |
|
6644 | 7240 | |
|
7241 | \begin_layout Standard | |
|
6645 | 7242 | IPython, if started with the |
|
6646 |
\family typewriter |
|
|
7243 | \family typewriter | |
|
6647 | 7244 | -pdb |
|
6648 |
\family default |
|
|
7245 | \family default | |
|
6649 | 7246 | option (or if the option is set in your rc file) can call the Python |
|
6650 |
\family typewriter |
|
|
7247 | \family typewriter | |
|
6651 | 7248 | pdb |
|
6652 |
\family default |
|
|
7249 | \family default | |
|
6653 | 7250 | debugger every time your code triggers an uncaught exception |
|
6654 | 7251 | \begin_inset Foot |
|
6655 |
collapsed |
|
|
6656 | ||
|
6657 | \layout Standard | |
|
7252 | status collapsed | |
|
6658 | 7253 | |
|
7254 | \begin_layout Standard | |
|
6659 | 7255 | Many thanks to Christopher Hart for the request which prompted adding this |
|
6660 | 7256 | feature to IPython. |
|
6661 | \end_inset | |
|
7257 | \end_layout | |
|
7258 | ||
|
7259 | \end_inset | |
|
6662 | 7260 | |
|
6663 | 7261 | . |
|
6664 | 7262 | This feature can also be toggled at any time with the |
|
6665 |
\family typewriter |
|
|
7263 | \family typewriter | |
|
6666 | 7264 | %pdb |
|
6667 |
\family default |
|
|
7265 | \family default | |
|
6668 | 7266 | magic command. |
|
6669 | 7267 | This can be extremely useful in order to find the origin of subtle bugs, |
|
6670 | 7268 | because |
|
6671 |
\family typewriter |
|
|
7269 | \family typewriter | |
|
6672 | 7270 | pdb |
|
6673 |
\family default |
|
|
7271 | \family default | |
|
6674 | 7272 | opens up at the point in your code which triggered the exception, and while |
|
6675 | 7273 | your program is at this point `dead', all the data is still available and |
|
6676 | 7274 | you can walk up and down the stack frame and understand the origin of the |
|
6677 | 7275 | problem. |
|
6678 | \layout Standard | |
|
7276 | \end_layout | |
|
6679 | 7277 | |
|
7278 | \begin_layout Standard | |
|
6680 | 7279 | Furthermore, you can use these debugging facilities both with the embedded |
|
6681 | 7280 | IPython mode and without IPython at all. |
|
6682 | 7281 | For an embedded shell (see sec. |
|
6683 | 7282 | |
|
6684 | 7283 | \begin_inset LatexCommand \ref{sec:embed} |
|
6685 | 7284 | |
|
6686 |
\end_inset |
|
|
7285 | \end_inset | |
|
6687 | 7286 | |
|
6688 | 7287 | ), simply call the constructor with |
|
6689 |
\family typewriter |
|
|
7288 | \family typewriter | |
|
6690 | 7289 | `-pdb' |
|
6691 |
\family default |
|
|
7290 | \family default | |
|
6692 | 7291 | in the argument string and automatically |
|
6693 |
\family typewriter |
|
|
7292 | \family typewriter | |
|
6694 | 7293 | pdb |
|
6695 |
\family default |
|
|
7294 | \family default | |
|
6696 | 7295 | will be called if an uncaught exception is triggered by your code. |
|
6697 | 7296 | |
|
6698 | \layout Standard | |
|
7297 | \end_layout | |
|
6699 | 7298 | |
|
7299 | \begin_layout Standard | |
|
6700 | 7300 | For stand-alone use of the feature in your programs which do not use IPython |
|
6701 | 7301 | at all, put the following lines toward the top of your `main' routine: |
|
6702 | \layout Standard | |
|
6703 | \align left | |
|
7302 | \end_layout | |
|
7303 | ||
|
7304 | \begin_layout Standard | |
|
7305 | \align left | |
|
6704 | 7306 | |
|
6705 |
\family typewriter |
|
|
7307 | \family typewriter | |
|
6706 | 7308 | import sys,IPython.ultraTB |
|
6707 |
\newline |
|
|
6708 |
sys.excepthook = IPython.ultraTB.FormattedTB(mode=`Verbos |
|
|
6709 | call_pdb=1) | |
|
6710 | \layout Standard | |
|
7309 | \newline | |
|
7310 | sys.excepthook = IPython.ultraTB.FormattedTB(mode=`Verbos | |
|
7311 | e', color_scheme=`Linux', call_pdb=1) | |
|
7312 | \end_layout | |
|
6711 | 7313 | |
|
7314 | \begin_layout Standard | |
|
6712 | 7315 | The |
|
6713 |
\family typewriter |
|
|
7316 | \family typewriter | |
|
6714 | 7317 | mode |
|
6715 |
\family default |
|
|
7318 | \family default | |
|
6716 | 7319 | keyword can be either |
|
6717 |
\family typewriter |
|
|
7320 | \family typewriter | |
|
6718 | 7321 | `Verbose' |
|
6719 |
\family default |
|
|
7322 | \family default | |
|
6720 | 7323 | or |
|
6721 |
\family typewriter |
|
|
7324 | \family typewriter | |
|
6722 | 7325 | `Plain' |
|
6723 |
\family default |
|
|
7326 | \family default | |
|
6724 | 7327 | , giving either very detailed or normal tracebacks respectively. |
|
6725 | 7328 | The |
|
6726 |
\family typewriter |
|
|
7329 | \family typewriter | |
|
6727 | 7330 | color_scheme |
|
6728 |
\family default |
|
|
7331 | \family default | |
|
6729 | 7332 | keyword can be one of |
|
6730 |
\family typewriter |
|
|
7333 | \family typewriter | |
|
6731 | 7334 | `NoColor' |
|
6732 |
\family default |
|
|
7335 | \family default | |
|
6733 | 7336 | , |
|
6734 |
\family typewriter |
|
|
7337 | \family typewriter | |
|
6735 | 7338 | `Linux' |
|
6736 |
\family default |
|
|
7339 | \family default | |
|
6737 | 7340 | (default) or |
|
6738 |
\family typewriter |
|
|
7341 | \family typewriter | |
|
6739 | 7342 | `LightBG' |
|
6740 |
\family default |
|
|
7343 | \family default | |
|
6741 | 7344 | . |
|
6742 | 7345 | These are the same options which can be set in IPython with |
|
6743 |
\family typewriter |
|
|
7346 | \family typewriter | |
|
6744 | 7347 | -colors |
|
6745 |
\family default |
|
|
7348 | \family default | |
|
6746 | 7349 | and |
|
6747 |
\family typewriter |
|
|
7350 | \family typewriter | |
|
6748 | 7351 | -xmode |
|
6749 |
\family default |
|
|
7352 | \family default | |
|
6750 | 7353 | . |
|
6751 | \layout Standard | |
|
7354 | \end_layout | |
|
6752 | 7355 | |
|
7356 | \begin_layout Standard | |
|
6753 | 7357 | This will give any of your programs detailed, colored tracebacks with automatic |
|
6754 | 7358 | invocation of |
|
6755 |
\family typewriter |
|
|
7359 | \family typewriter | |
|
6756 | 7360 | pdb |
|
6757 |
\family default |
|
|
7361 | \family default | |
|
6758 | 7362 | . |
|
6759 | \layout Section | |
|
6760 | ||
|
7363 | \end_layout | |
|
6761 | 7364 | |
|
7365 | \begin_layout Section | |
|
6762 | 7366 | \begin_inset LatexCommand \label{sec:syntax-extensions} |
|
6763 | 7367 | |
|
6764 |
\end_inset |
|
|
7368 | \end_inset | |
|
6765 | 7369 | |
|
6766 | 7370 | Extensions for syntax processing |
|
6767 | \layout Standard | |
|
7371 | \end_layout | |
|
6768 | 7372 | |
|
7373 | \begin_layout Standard | |
|
6769 | 7374 | This isn't for the faint of heart, because the potential for breaking things |
|
6770 | 7375 | is quite high. |
|
6771 | 7376 | But it can be a very powerful and useful feature. |
|
6772 | 7377 | In a nutshell, you can redefine the way IPython processes the user input |
|
6773 | 7378 | line to accept new, special extensions to the syntax without needing to |
|
6774 | 7379 | change any of IPython's own code. |
|
6775 | \layout Standard | |
|
7380 | \end_layout | |
|
6776 | 7381 | |
|
7382 | \begin_layout Standard | |
|
6777 | 7383 | In the |
|
6778 |
\family typewriter |
|
|
7384 | \family typewriter | |
|
6779 | 7385 | IPython/Extensions |
|
6780 |
\family default |
|
|
7386 | \family default | |
|
6781 | 7387 | directory you will find some examples supplied, which we will briefly describe |
|
6782 | 7388 | now. |
|
6783 | 7389 | These can be used `as is' (and both provide very useful functionality), |
|
6784 | 7390 | or you can use them as a starting point for writing your own extensions. |
|
6785 | \layout Subsection | |
|
7391 | \end_layout | |
|
6786 | 7392 | |
|
7393 | \begin_layout Subsection | |
|
6787 | 7394 | Pasting of code starting with |
|
6788 |
\family typewriter |
|
|
7395 | \family typewriter | |
|
6789 | 7396 | `>>> |
|
6790 |
\family default |
|
|
7397 | \family default | |
|
6791 | 7398 | ' or |
|
6792 |
\family typewriter |
|
|
7399 | \family typewriter | |
|
6793 | 7400 | `... |
|
6794 | 7401 | |
|
6795 |
\family default |
|
|
7402 | \family default | |
|
6796 | 7403 | ' |
|
6797 | \layout Standard | |
|
7404 | \end_layout | |
|
6798 | 7405 | |
|
7406 | \begin_layout Standard | |
|
6799 | 7407 | In the python tutorial it is common to find code examples which have been |
|
6800 | 7408 | taken from real python sessions. |
|
6801 | 7409 | The problem with those is that all the lines begin with either |
|
6802 |
\family typewriter |
|
|
7410 | \family typewriter | |
|
6803 | 7411 | `>>> |
|
6804 |
\family default |
|
|
7412 | \family default | |
|
6805 | 7413 | ' or |
|
6806 |
\family typewriter |
|
|
7414 | \family typewriter | |
|
6807 | 7415 | `... |
|
6808 | 7416 | |
|
6809 |
\family default |
|
|
7417 | \family default | |
|
6810 | 7418 | ', which makes it impossible to paste them all at once. |
|
6811 | 7419 | One must instead do a line by line manual copying, carefully removing the |
|
6812 | 7420 | leading extraneous characters. |
|
6813 | \layout Standard | |
|
7421 | \end_layout | |
|
6814 | 7422 | |
|
7423 | \begin_layout Standard | |
|
6815 | 7424 | This extension identifies those starting characters and removes them from |
|
6816 | 7425 | the input automatically, so that one can paste multi-line examples directly |
|
6817 | 7426 | into IPython, saving a lot of time. |
|
6818 | 7427 | Please look at the file |
|
6819 |
\family typewriter |
|
|
7428 | \family typewriter | |
|
6820 | 7429 | InterpreterPasteInput.py |
|
6821 |
\family default |
|
|
7430 | \family default | |
|
6822 | 7431 | in the |
|
6823 |
\family typewriter |
|
|
7432 | \family typewriter | |
|
6824 | 7433 | IPython/Extensions |
|
6825 |
\family default |
|
|
7434 | \family default | |
|
6826 | 7435 | directory for details on how this is done. |
|
6827 | \layout Standard | |
|
7436 | \end_layout | |
|
6828 | 7437 | |
|
7438 | \begin_layout Standard | |
|
6829 | 7439 | IPython comes with a special profile enabling this feature, called |
|
6830 |
\family typewriter |
|
|
7440 | \family typewriter | |
|
6831 | 7441 | tutorial |
|
6832 |
\family default |
|
|
6833 |
\emph on |
|
|
7442 | \family default | |
|
7443 | \emph on | |
|
6834 | 7444 | . |
|
6835 | 7445 | |
|
6836 |
\emph default |
|
|
7446 | \emph default | |
|
6837 | 7447 | Simply start IPython via |
|
6838 |
\family typewriter |
|
|
6839 |
`ipython\ |
|
|
6840 | -p\SpecialChar ~ | |
|
7448 | \family typewriter | |
|
7449 | `ipython\InsetSpace ~ | |
|
7450 | -p\InsetSpace ~ | |
|
6841 | 7451 | tutorial' |
|
6842 |
\family default |
|
|
7452 | \family default | |
|
6843 | 7453 | and the feature will be available. |
|
6844 | 7454 | In a normal IPython session you can activate the feature by importing the |
|
6845 | 7455 | corresponding module with: |
|
6846 |
\newline |
|
|
7456 | \newline | |
|
6847 | 7457 | |
|
6848 |
\family typewriter |
|
|
7458 | \family typewriter | |
|
6849 | 7459 | In [1]: import IPython.Extensions.InterpreterPasteInput |
|
6850 | \layout Standard | |
|
7460 | \end_layout | |
|
6851 | 7461 | |
|
7462 | \begin_layout Standard | |
|
6852 | 7463 | The following is a 'screenshot' of how things work when this extension is |
|
6853 | 7464 | on, copying an example from the standard tutorial: |
|
6854 | \layout Standard | |
|
7465 | \end_layout | |
|
6855 | 7466 | |
|
7467 | \begin_layout Standard | |
|
6856 | 7468 | |
|
6857 |
\family typewriter |
|
|
7469 | \family typewriter | |
|
6858 | 7470 | IPython profile: tutorial |
|
6859 |
\newline |
|
|
6860 | \SpecialChar ~ | |
|
7471 | \newline | |
|
7472 | \InsetSpace ~ | |
|
6861 | 7473 | |
|
6862 |
\newline |
|
|
7474 | \newline | |
|
6863 | 7475 | *** Pasting of code with ">>>" or "..." has been enabled. |
|
6864 |
\newline |
|
|
6865 | \SpecialChar ~ | |
|
7476 | \newline | |
|
7477 | \InsetSpace ~ | |
|
6866 | 7478 | |
|
6867 |
\newline |
|
|
6868 | In [1]: >>> def fib2(n): # return Fibonacci series up to n | |
|
6869 | \newline | |
|
7479 | \newline | |
|
7480 | In | |
|
7481 | [1]: >>> def fib2(n): # return Fibonacci series up to n | |
|
7482 | \newline | |
|
6870 | 7483 | |
|
6871 | 7484 | \begin_inset ERT |
|
6872 |
status |
|
|
7485 | status collapsed | |
|
6873 | 7486 | |
|
6874 | \layout Standard | |
|
7487 | \begin_layout Standard | |
|
6875 | 7488 | |
|
6876 | \backslash | |
|
7489 | ||
|
7490 | \backslash | |
|
6877 | 7491 | hspace*{0mm} |
|
6878 | \end_inset | |
|
6879 | ||
|
6880 | \SpecialChar ~ | |
|
6881 | \SpecialChar ~ | |
|
6882 | ...: ...\SpecialChar ~ | |
|
6883 | \SpecialChar ~ | |
|
6884 | \SpecialChar ~ | |
|
6885 | \SpecialChar ~ | |
|
7492 | \end_layout | |
|
7493 | ||
|
7494 | \end_inset | |
|
7495 | ||
|
7496 | \InsetSpace ~ | |
|
7497 | \InsetSpace ~ | |
|
7498 | ...: ...\InsetSpace ~ | |
|
7499 | \InsetSpace ~ | |
|
7500 | \InsetSpace ~ | |
|
7501 | \InsetSpace ~ | |
|
6886 | 7502 | """Return a list containing the Fibonacci series up to n.""" |
|
6887 |
\newline |
|
|
7503 | \newline | |
|
6888 | 7504 | |
|
6889 | 7505 | \begin_inset ERT |
|
6890 |
status |
|
|
7506 | status collapsed | |
|
6891 | 7507 | |
|
6892 | \layout Standard | |
|
7508 | \begin_layout Standard | |
|
6893 | 7509 | |
|
6894 | \backslash | |
|
7510 | ||
|
7511 | \backslash | |
|
6895 | 7512 | hspace*{0mm} |
|
6896 | \end_inset | |
|
6897 | ||
|
6898 | \SpecialChar ~ | |
|
6899 | \SpecialChar ~ | |
|
6900 | ...: ...\SpecialChar ~ | |
|
6901 | \SpecialChar ~ | |
|
6902 | \SpecialChar ~ | |
|
6903 | \SpecialChar ~ | |
|
7513 | \end_layout | |
|
7514 | ||
|
7515 | \end_inset | |
|
7516 | ||
|
7517 | \InsetSpace ~ | |
|
7518 | \InsetSpace ~ | |
|
7519 | ...: ...\InsetSpace ~ | |
|
7520 | \InsetSpace ~ | |
|
7521 | \InsetSpace ~ | |
|
7522 | \InsetSpace ~ | |
|
6904 | 7523 | result = [] |
|
6905 |
\newline |
|
|
7524 | \newline | |
|
6906 | 7525 | |
|
6907 | 7526 | \begin_inset ERT |
|
6908 |
status |
|
|
7527 | status collapsed | |
|
6909 | 7528 | |
|
6910 | \layout Standard | |
|
7529 | \begin_layout Standard | |
|
6911 | 7530 | |
|
6912 | \backslash | |
|
7531 | ||
|
7532 | \backslash | |
|
6913 | 7533 | hspace*{0mm} |
|
6914 | \end_inset | |
|
6915 | ||
|
6916 | \SpecialChar ~ | |
|
6917 | \SpecialChar ~ | |
|
6918 | ...: ...\SpecialChar ~ | |
|
6919 | \SpecialChar ~ | |
|
6920 | \SpecialChar ~ | |
|
6921 | \SpecialChar ~ | |
|
7534 | \end_layout | |
|
7535 | ||
|
7536 | \end_inset | |
|
7537 | ||
|
7538 | \InsetSpace ~ | |
|
7539 | \InsetSpace ~ | |
|
7540 | ...: ...\InsetSpace ~ | |
|
7541 | \InsetSpace ~ | |
|
7542 | \InsetSpace ~ | |
|
7543 | \InsetSpace ~ | |
|
6922 | 7544 | a, b = 0, 1 |
|
6923 |
\newline |
|
|
7545 | \newline | |
|
6924 | 7546 | |
|
6925 | 7547 | \begin_inset ERT |
|
6926 |
status |
|
|
7548 | status collapsed | |
|
6927 | 7549 | |
|
6928 | \layout Standard | |
|
7550 | \begin_layout Standard | |
|
6929 | 7551 | |
|
6930 | \backslash | |
|
7552 | ||
|
7553 | \backslash | |
|
6931 | 7554 | hspace*{0mm} |
|
6932 | \end_inset | |
|
6933 | ||
|
6934 | \SpecialChar ~ | |
|
6935 | \SpecialChar ~ | |
|
6936 | ...: ...\SpecialChar ~ | |
|
6937 | \SpecialChar ~ | |
|
6938 | \SpecialChar ~ | |
|
6939 | \SpecialChar ~ | |
|
7555 | \end_layout | |
|
7556 | ||
|
7557 | \end_inset | |
|
7558 | ||
|
7559 | \InsetSpace ~ | |
|
7560 | \InsetSpace ~ | |
|
7561 | ...: ...\InsetSpace ~ | |
|
7562 | \InsetSpace ~ | |
|
7563 | \InsetSpace ~ | |
|
7564 | \InsetSpace ~ | |
|
6940 | 7565 | while b < n: |
|
6941 |
\newline |
|
|
7566 | \newline | |
|
6942 | 7567 | |
|
6943 | 7568 | \begin_inset ERT |
|
6944 |
status |
|
|
7569 | status collapsed | |
|
7570 | ||
|
7571 | \begin_layout Standard | |
|
6945 | 7572 | |
|
6946 | \layout Standard | |
|
6947 | 7573 | |
|
6948 |
\backslash |
|
|
7574 | \backslash | |
|
6949 | 7575 | hspace*{0mm} |
|
6950 | \end_inset | |
|
6951 | ||
|
6952 | \SpecialChar ~ | |
|
6953 | \SpecialChar ~ | |
|
6954 | ...: ...\SpecialChar ~ | |
|
6955 | \SpecialChar ~ | |
|
6956 | \SpecialChar ~ | |
|
6957 | \SpecialChar ~ | |
|
6958 | \SpecialChar ~ | |
|
6959 | \SpecialChar ~ | |
|
6960 | \SpecialChar ~ | |
|
6961 | \SpecialChar ~ | |
|
6962 | result.append(b)\SpecialChar ~ | |
|
6963 | \SpecialChar ~ | |
|
6964 | \SpecialChar ~ | |
|
7576 | \end_layout | |
|
7577 | ||
|
7578 | \end_inset | |
|
7579 | ||
|
7580 | \InsetSpace ~ | |
|
7581 | \InsetSpace ~ | |
|
7582 | ...: ...\InsetSpace ~ | |
|
7583 | \InsetSpace ~ | |
|
7584 | \InsetSpace ~ | |
|
7585 | \InsetSpace ~ | |
|
7586 | \InsetSpace ~ | |
|
7587 | \InsetSpace ~ | |
|
7588 | \InsetSpace ~ | |
|
7589 | \InsetSpace ~ | |
|
7590 | result.append(b)\InsetSpace ~ | |
|
7591 | \InsetSpace ~ | |
|
7592 | \InsetSpace ~ | |
|
6965 | 7593 | # see below |
|
6966 |
\newline |
|
|
7594 | \newline | |
|
6967 | 7595 | |
|
6968 | 7596 | \begin_inset ERT |
|
6969 |
status |
|
|
7597 | status collapsed | |
|
6970 | 7598 | |
|
6971 | \layout Standard | |
|
7599 | \begin_layout Standard | |
|
6972 | 7600 | |
|
6973 | \backslash | |
|
7601 | ||
|
7602 | \backslash | |
|
6974 | 7603 | hspace*{0mm} |
|
6975 | \end_inset | |
|
6976 | ||
|
6977 | \SpecialChar ~ | |
|
6978 | \SpecialChar ~ | |
|
6979 | ...: ...\SpecialChar ~ | |
|
6980 | \SpecialChar ~ | |
|
6981 | \SpecialChar ~ | |
|
6982 | \SpecialChar ~ | |
|
6983 | \SpecialChar ~ | |
|
6984 | \SpecialChar ~ | |
|
6985 | \SpecialChar ~ | |
|
6986 | \SpecialChar ~ | |
|
7604 | \end_layout | |
|
7605 | ||
|
7606 | \end_inset | |
|
7607 | ||
|
7608 | \InsetSpace ~ | |
|
7609 | \InsetSpace ~ | |
|
7610 | ...: ...\InsetSpace ~ | |
|
7611 | \InsetSpace ~ | |
|
7612 | \InsetSpace ~ | |
|
7613 | \InsetSpace ~ | |
|
7614 | \InsetSpace ~ | |
|
7615 | \InsetSpace ~ | |
|
7616 | \InsetSpace ~ | |
|
7617 | \InsetSpace ~ | |
|
6987 | 7618 | a, b = b, a+b |
|
6988 |
\newline |
|
|
7619 | \newline | |
|
6989 | 7620 | |
|
6990 | 7621 | \begin_inset ERT |
|
6991 |
status |
|
|
7622 | status collapsed | |
|
7623 | ||
|
7624 | \begin_layout Standard | |
|
6992 | 7625 | |
|
6993 | \layout Standard | |
|
6994 | 7626 | |
|
6995 |
\backslash |
|
|
7627 | \backslash | |
|
6996 | 7628 | hspace*{0mm} |
|
6997 | \end_inset | |
|
6998 | ||
|
6999 | \SpecialChar ~ | |
|
7000 | \SpecialChar ~ | |
|
7001 | ...: ...\SpecialChar ~ | |
|
7002 | \SpecialChar ~ | |
|
7003 | \SpecialChar ~ | |
|
7004 | \SpecialChar ~ | |
|
7629 | \end_layout | |
|
7630 | ||
|
7631 | \end_inset | |
|
7632 | ||
|
7633 | \InsetSpace ~ | |
|
7634 | \InsetSpace ~ | |
|
7635 | ...: ...\InsetSpace ~ | |
|
7636 | \InsetSpace ~ | |
|
7637 | \InsetSpace ~ | |
|
7638 | \InsetSpace ~ | |
|
7005 | 7639 | return result |
|
7006 |
\newline |
|
|
7640 | \newline | |
|
7007 | 7641 | |
|
7008 | 7642 | \begin_inset ERT |
|
7009 |
status |
|
|
7643 | status collapsed | |
|
7644 | ||
|
7645 | \begin_layout Standard | |
|
7010 | 7646 | |
|
7011 | \layout Standard | |
|
7012 | 7647 | |
|
7013 |
\backslash |
|
|
7648 | \backslash | |
|
7014 | 7649 | hspace*{0mm} |
|
7015 | \end_inset | |
|
7650 | \end_layout | |
|
7651 | ||
|
7652 | \end_inset | |
|
7016 | 7653 | |
|
7017 | \SpecialChar ~ | |
|
7018 | \SpecialChar ~ | |
|
7654 | \InsetSpace ~ | |
|
7655 | \InsetSpace ~ | |
|
7019 | 7656 | ...: |
|
7020 |
\newline |
|
|
7021 | \SpecialChar ~ | |
|
7657 | \newline | |
|
7658 | \InsetSpace ~ | |
|
7022 | 7659 | |
|
7023 |
\newline |
|
|
7660 | \newline | |
|
7024 | 7661 | In [2]: fib2(10) |
|
7025 |
\newline |
|
|
7662 | \newline | |
|
7026 | 7663 | Out[2]: [1, 1, 2, 3, 5, 8] |
|
7027 | \layout Standard | |
|
7664 | \end_layout | |
|
7028 | 7665 | |
|
7666 | \begin_layout Standard | |
|
7029 | 7667 | Note that as currently written, this extension does |
|
7030 |
\emph on |
|
|
7668 | \emph on | |
|
7031 | 7669 | not |
|
7032 |
\emph default |
|
|
7670 | \emph default | |
|
7033 | 7671 | recognize IPython's prompts for pasting. |
|
7034 | 7672 | Those are more complicated, since the user can change them very easily, |
|
7035 | 7673 | they involve numbers and can vary in length. |
|
7036 | 7674 | One could however extract all the relevant information from the IPython |
|
7037 | 7675 | instance and build an appropriate regular expression. |
|
7038 | 7676 | This is left as an exercise for the reader. |
|
7039 | \layout Subsection | |
|
7677 | \end_layout | |
|
7040 | 7678 | |
|
7679 | \begin_layout Subsection | |
|
7041 | 7680 | Input of physical quantities with units |
|
7042 | \layout Standard | |
|
7681 | \end_layout | |
|
7043 | 7682 | |
|
7683 | \begin_layout Standard | |
|
7044 | 7684 | The module |
|
7045 |
\family typewriter |
|
|
7685 | \family typewriter | |
|
7046 | 7686 | PhysicalQInput |
|
7047 |
\family default |
|
|
7687 | \family default | |
|
7048 | 7688 | allows a simplified form of input for physical quantities with units. |
|
7049 | 7689 | This file is meant to be used in conjunction with the |
|
7050 |
\family typewriter |
|
|
7690 | \family typewriter | |
|
7051 | 7691 | PhysicalQInteractive |
|
7052 |
\family default |
|
|
7692 | \family default | |
|
7053 | 7693 | module (in the same directory) and |
|
7054 |
\family typewriter |
|
|
7694 | \family typewriter | |
|
7055 | 7695 | Physics.PhysicalQuantities |
|
7056 |
\family default |
|
|
7696 | \family default | |
|
7057 | 7697 | from Konrad Hinsen's ScientificPython ( |
|
7058 | 7698 | \begin_inset LatexCommand \htmlurl{http://dirac.cnrs-orleans.fr/ScientificPython/} |
|
7059 | 7699 | |
|
7060 |
\end_inset |
|
|
7700 | \end_inset | |
|
7061 | 7701 | |
|
7062 | 7702 | ). |
|
7063 | \layout Standard | |
|
7703 | \end_layout | |
|
7064 | 7704 | |
|
7705 | \begin_layout Standard | |
|
7065 | 7706 | The |
|
7066 |
\family typewriter |
|
|
7707 | \family typewriter | |
|
7067 | 7708 | Physics.PhysicalQuantities |
|
7068 |
\family default |
|
|
7709 | \family default | |
|
7069 | 7710 | module defines |
|
7070 |
\family typewriter |
|
|
7711 | \family typewriter | |
|
7071 | 7712 | PhysicalQuantity |
|
7072 |
\family default |
|
|
7713 | \family default | |
|
7073 | 7714 | objects, but these must be declared as instances of a class. |
|
7074 | 7715 | For example, to define |
|
7075 |
\family typewriter |
|
|
7716 | \family typewriter | |
|
7076 | 7717 | v |
|
7077 |
\family default |
|
|
7078 |
as a velocity of 3\ |
|
|
7718 | \family default | |
|
7719 | as a velocity of 3\InsetSpace ~ | |
|
7079 | 7720 | m/s, normally you would write: |
|
7080 |
\family typewriter |
|
|
7721 | \family typewriter | |
|
7081 | 7722 | |
|
7082 |
\newline |
|
|
7723 | \newline | |
|
7083 | 7724 | In [1]: v = PhysicalQuantity(3,'m/s') |
|
7084 | \layout Standard | |
|
7725 | \end_layout | |
|
7085 | 7726 | |
|
7727 | \begin_layout Standard | |
|
7086 | 7728 | Using the |
|
7087 |
\family typewriter |
|
|
7729 | \family typewriter | |
|
7088 | 7730 | PhysicalQ_Input |
|
7089 |
\family default |
|
|
7731 | \family default | |
|
7090 | 7732 | extension this can be input instead as: |
|
7091 |
\family typewriter |
|
|
7733 | \family typewriter | |
|
7092 | 7734 | |
|
7093 |
\newline |
|
|
7735 | \newline | |
|
7094 | 7736 | In [1]: v = 3 m/s |
|
7095 |
\family default |
|
|
7737 | \family default | |
|
7096 | 7738 | |
|
7097 |
\newline |
|
|
7739 | \newline | |
|
7098 | 7740 | which is much more convenient for interactive use (even though it is blatantly |
|
7099 | 7741 | invalid Python syntax). |
|
7100 | \layout Standard | |
|
7742 | \end_layout | |
|
7101 | 7743 | |
|
7744 | \begin_layout Standard | |
|
7102 | 7745 | The |
|
7103 |
\family typewriter |
|
|
7746 | \family typewriter | |
|
7104 | 7747 | physics |
|
7105 |
\family default |
|
|
7748 | \family default | |
|
7106 | 7749 | profile supplied with IPython (enabled via |
|
7107 |
\family typewriter |
|
|
7750 | \family typewriter | |
|
7108 | 7751 | 'ipython -p physics' |
|
7109 |
\family default |
|
|
7752 | \family default | |
|
7110 | 7753 | ) uses these extensions, which you can also activate with: |
|
7111 | \layout Standard | |
|
7754 | \end_layout | |
|
7112 | 7755 | |
|
7756 | \begin_layout Standard | |
|
7113 | 7757 | |
|
7114 |
\family typewriter |
|
|
7758 | \family typewriter | |
|
7115 | 7759 | from math import * # math MUST be imported BEFORE PhysicalQInteractive |
|
7116 |
\newline |
|
|
7117 | from IPython.Extensions.PhysicalQInteractive import * | |
|
7118 | \newline | |
|
7119 | import IPython.Extensions.PhysicalQInput | |
|
7120 | \layout Section | |
|
7121 | ||
|
7122 | ||
|
7760 | \newline | |
|
7761 | from | |
|
7762 | IPython.Extensions.PhysicalQInteractive import * | |
|
7763 | \newline | |
|
7764 | import IPython.Extensions.PhysicalQ | |
|
7765 | Input | |
|
7766 | \end_layout | |
|
7767 | ||
|
7768 | \begin_layout Section | |
|
7123 | 7769 | \begin_inset LatexCommand \label{sec:IPython-as-shell} |
|
7124 | 7770 | |
|
7125 |
\end_inset |
|
|
7771 | \end_inset | |
|
7126 | 7772 | |
|
7127 | 7773 | IPython as a system shell |
|
7128 | \layout Standard | |
|
7774 | \end_layout | |
|
7129 | 7775 | |
|
7776 | \begin_layout Standard | |
|
7130 | 7777 | IPython ships with a special profile called |
|
7131 |
\family typewriter |
|
|
7778 | \family typewriter | |
|
7132 | 7779 | pysh |
|
7133 |
\family default |
|
|
7780 | \family default | |
|
7134 | 7781 | , which you can activate at the command line as |
|
7135 |
\family typewriter |
|
|
7782 | \family typewriter | |
|
7136 | 7783 | `ipython -p pysh' |
|
7137 |
\family default |
|
|
7784 | \family default | |
|
7138 | 7785 | . |
|
7139 | 7786 | This loads |
|
7140 |
\family typewriter |
|
|
7787 | \family typewriter | |
|
7141 | 7788 | InterpreterExec |
|
7142 |
\family default |
|
|
7789 | \family default | |
|
7143 | 7790 | , along with some additional facilities and a prompt customized for filesystem |
|
7144 | 7791 | navigation. |
|
7145 | \layout Standard | |
|
7792 | \end_layout | |
|
7146 | 7793 | |
|
7794 | \begin_layout Standard | |
|
7147 | 7795 | Note that this does |
|
7148 |
\emph on |
|
|
7796 | \emph on | |
|
7149 | 7797 | not |
|
7150 |
\emph default |
|
|
7798 | \emph default | |
|
7151 | 7799 | make IPython a full-fledged system shell. |
|
7152 | 7800 | In particular, it has no job control, so if you type Ctrl-Z (under Unix), |
|
7153 | 7801 | you'll suspend pysh itself, not the process you just started. |
|
7154 | 7802 | |
|
7155 | \layout Standard | |
|
7803 | \end_layout | |
|
7156 | 7804 | |
|
7805 | \begin_layout Standard | |
|
7157 | 7806 | What the shell profile allows you to do is to use the convenient and powerful |
|
7158 | 7807 | syntax of Python to do quick scripting at the command line. |
|
7159 | 7808 | Below we describe some of its features. |
|
7160 | \layout Subsection | |
|
7809 | \end_layout | |
|
7161 | 7810 | |
|
7811 | \begin_layout Subsection | |
|
7162 | 7812 | Aliases |
|
7163 | \layout Standard | |
|
7813 | \end_layout | |
|
7164 | 7814 | |
|
7815 | \begin_layout Standard | |
|
7165 | 7816 | All of your |
|
7166 |
\family typewriter |
|
|
7817 | \family typewriter | |
|
7167 | 7818 | $PATH |
|
7168 |
\family default |
|
|
7819 | \family default | |
|
7169 | 7820 | has been loaded as IPython aliases, so you should be able to type any normal |
|
7170 | 7821 | system command and have it executed. |
|
7171 | 7822 | See |
|
7172 |
\family typewriter |
|
|
7823 | \family typewriter | |
|
7173 | 7824 | %alias? |
|
7174 |
\family default |
|
|
7825 | \family default | |
|
7175 | 7826 | and |
|
7176 |
\family typewriter |
|
|
7827 | \family typewriter | |
|
7177 | 7828 | %unalias? |
|
7178 |
\family default |
|
|
7829 | \family default | |
|
7179 | 7830 | for details on the alias facilities. |
|
7180 | 7831 | See also |
|
7181 |
\family typewriter |
|
|
7832 | \family typewriter | |
|
7182 | 7833 | %rehash? |
|
7183 |
\family default |
|
|
7834 | \family default | |
|
7184 | 7835 | and |
|
7185 |
\family typewriter |
|
|
7836 | \family typewriter | |
|
7186 | 7837 | %rehashx? |
|
7187 |
\family default |
|
|
7838 | \family default | |
|
7188 | 7839 | for details on the mechanism used to load |
|
7189 |
\family typewriter |
|
|
7840 | \family typewriter | |
|
7190 | 7841 | $PATH |
|
7191 |
\family default |
|
|
7842 | \family default | |
|
7192 | 7843 | . |
|
7193 | \layout Subsection | |
|
7844 | \end_layout | |
|
7194 | 7845 | |
|
7846 | \begin_layout Subsection | |
|
7195 | 7847 | Special syntax |
|
7196 | \layout Standard | |
|
7848 | \end_layout | |
|
7197 | 7849 | |
|
7850 | \begin_layout Standard | |
|
7198 | 7851 | Any lines which begin with |
|
7199 |
\family typewriter |
|
|
7852 | \family typewriter | |
|
7200 | 7853 | `~' |
|
7201 |
\family default |
|
|
7854 | \family default | |
|
7202 | 7855 | , |
|
7203 |
\family typewriter |
|
|
7856 | \family typewriter | |
|
7204 | 7857 | `/' |
|
7205 |
\family default |
|
|
7858 | \family default | |
|
7206 | 7859 | and |
|
7207 |
\family typewriter |
|
|
7860 | \family typewriter | |
|
7208 | 7861 | `.' |
|
7209 |
\family default |
|
|
7862 | \family default | |
|
7210 | 7863 | will be executed as shell commands instead of as Python code. |
|
7211 | 7864 | The special escapes below are also recognized. |
|
7212 | 7865 | |
|
7213 |
\family typewriter |
|
|
7866 | \family typewriter | |
|
7214 | 7867 | !cmd |
|
7215 |
\family default |
|
|
7868 | \family default | |
|
7216 | 7869 | is valid in single or multi-line input, all others are only valid in single-lin |
|
7217 | 7870 | e input: |
|
7218 | \layout Description | |
|
7871 | \end_layout | |
|
7219 | 7872 | |
|
7873 | \begin_layout Description | |
|
7220 | 7874 | |
|
7221 |
\family typewriter |
|
|
7875 | \family typewriter | |
|
7222 | 7876 | !cmd |
|
7223 |
\family default |
|
|
7877 | \family default | |
|
7224 | 7878 | pass `cmd' directly to the shell |
|
7225 | \layout Description | |
|
7879 | \end_layout | |
|
7226 | 7880 | |
|
7881 | \begin_layout Description | |
|
7227 | 7882 | |
|
7228 |
\family typewriter |
|
|
7883 | \family typewriter | |
|
7229 | 7884 | !!cmd |
|
7230 |
\family default |
|
|
7885 | \family default | |
|
7231 | 7886 | execute `cmd' and return output as a list (split on ` |
|
7232 |
\backslash |
|
|
7887 | \backslash | |
|
7233 | 7888 | n') |
|
7234 | \layout Description | |
|
7889 | \end_layout | |
|
7235 | 7890 | |
|
7891 | \begin_layout Description | |
|
7236 | 7892 | |
|
7237 |
\family typewriter |
|
|
7893 | \family typewriter | |
|
7238 | 7894 | $var=cmd |
|
7239 |
\family default |
|
|
7895 | \family default | |
|
7240 | 7896 | capture output of cmd into var, as a string |
|
7241 | \layout Description | |
|
7897 | \end_layout | |
|
7242 | 7898 | |
|
7899 | \begin_layout Description | |
|
7243 | 7900 | |
|
7244 |
\family typewriter |
|
|
7901 | \family typewriter | |
|
7245 | 7902 | $$var=cmd |
|
7246 |
\family default |
|
|
7903 | \family default | |
|
7247 | 7904 | capture output of cmd into var, as a list (split on ` |
|
7248 |
\backslash |
|
|
7905 | \backslash | |
|
7249 | 7906 | n') |
|
7250 | \layout Standard | |
|
7907 | \end_layout | |
|
7251 | 7908 | |
|
7909 | \begin_layout Standard | |
|
7252 | 7910 | The |
|
7253 |
\family typewriter |
|
|
7911 | \family typewriter | |
|
7254 | 7912 | $ |
|
7255 |
\family default |
|
|
7913 | \family default | |
|
7256 | 7914 | / |
|
7257 |
\family typewriter |
|
|
7915 | \family typewriter | |
|
7258 | 7916 | $$ |
|
7259 |
\family default |
|
|
7917 | \family default | |
|
7260 | 7918 | syntaxes make Python variables from system output, which you can later |
|
7261 | 7919 | use for further scripting. |
|
7262 | 7920 | The converse is also possible: when executing an alias or calling to the |
|
7263 | 7921 | system via |
|
7264 |
\family typewriter |
|
|
7922 | \family typewriter | |
|
7265 | 7923 | ! |
|
7266 |
\family default |
|
|
7924 | \family default | |
|
7267 | 7925 | / |
|
7268 |
\family typewriter |
|
|
7926 | \family typewriter | |
|
7269 | 7927 | !! |
|
7270 |
\family default |
|
|
7928 | \family default | |
|
7271 | 7929 | , you can expand any python variable or expression by prepending it with |
|
7272 | 7930 | |
|
7273 |
\family typewriter |
|
|
7931 | \family typewriter | |
|
7274 | 7932 | $ |
|
7275 |
\family default |
|
|
7933 | \family default | |
|
7276 | 7934 | . |
|
7277 | 7935 | Full details of the allowed syntax can be found in Python's PEP 215. |
|
7278 | \layout Standard | |
|
7936 | \end_layout | |
|
7279 | 7937 | |
|
7938 | \begin_layout Standard | |
|
7280 | 7939 | A few brief examples will illustrate these (note that the indentation below |
|
7281 | 7940 | may be incorrectly displayed): |
|
7282 | \layout Standard | |
|
7941 | \end_layout | |
|
7283 | 7942 | |
|
7943 | \begin_layout Standard | |
|
7284 | 7944 | |
|
7285 |
\family typewriter |
|
|
7945 | \family typewriter | |
|
7286 | 7946 | fperez[~/test]|3> !ls *s.py |
|
7287 |
\newline |
|
|
7947 | \newline | |
|
7288 | 7948 | scopes.py strings.py |
|
7289 | \layout Standard | |
|
7949 | \end_layout | |
|
7290 | 7950 | |
|
7951 | \begin_layout Standard | |
|
7291 | 7952 | ls is an internal alias, so there's no need to use |
|
7292 |
\family typewriter |
|
|
7953 | \family typewriter | |
|
7293 | 7954 | ! |
|
7294 |
\family default |
|
|
7955 | \family default | |
|
7295 | 7956 | : |
|
7296 | \layout Standard | |
|
7957 | \end_layout | |
|
7297 | 7958 | |
|
7959 | \begin_layout Standard | |
|
7298 | 7960 | |
|
7299 |
\family typewriter |
|
|
7961 | \family typewriter | |
|
7300 | 7962 | fperez[~/test]|4> ls *s.py |
|
7301 |
\newline |
|
|
7963 | \newline | |
|
7302 | 7964 | scopes.py* strings.py |
|
7303 | \layout Standard | |
|
7965 | \end_layout | |
|
7304 | 7966 | |
|
7967 | \begin_layout Standard | |
|
7305 | 7968 | !!ls will return the output into a Python variable: |
|
7306 | \layout Standard | |
|
7969 | \end_layout | |
|
7307 | 7970 | |
|
7971 | \begin_layout Standard | |
|
7308 | 7972 | |
|
7309 |
\family typewriter |
|
|
7973 | \family typewriter | |
|
7310 | 7974 | fperez[~/test]|5> !!ls *s.py |
|
7311 |
\newline |
|
|
7975 | \newline | |
|
7312 | 7976 | |
|
7313 | 7977 | \begin_inset ERT |
|
7314 |
status |
|
|
7978 | status collapsed | |
|
7979 | ||
|
7980 | \begin_layout Standard | |
|
7315 | 7981 | |
|
7316 | \layout Standard | |
|
7317 | 7982 | |
|
7318 |
\backslash |
|
|
7983 | \backslash | |
|
7319 | 7984 | hspace*{0mm} |
|
7320 | \end_inset | |
|
7321 | ||
|
7322 | \SpecialChar ~ | |
|
7323 | \SpecialChar ~ | |
|
7324 | \SpecialChar ~ | |
|
7325 | \SpecialChar ~ | |
|
7326 | \SpecialChar ~ | |
|
7327 | \SpecialChar ~ | |
|
7328 | \SpecialChar ~ | |
|
7329 | \SpecialChar ~ | |
|
7330 | \SpecialChar ~ | |
|
7331 | \SpecialChar ~ | |
|
7332 | \SpecialChar ~ | |
|
7333 | \SpecialChar ~ | |
|
7334 | \SpecialChar ~ | |
|
7335 | \SpecialChar ~ | |
|
7985 | \end_layout | |
|
7986 | ||
|
7987 | \end_inset | |
|
7988 | ||
|
7989 | \InsetSpace ~ | |
|
7990 | \InsetSpace ~ | |
|
7991 | \InsetSpace ~ | |
|
7992 | \InsetSpace ~ | |
|
7993 | \InsetSpace ~ | |
|
7994 | \InsetSpace ~ | |
|
7995 | \InsetSpace ~ | |
|
7996 | \InsetSpace ~ | |
|
7997 | \InsetSpace ~ | |
|
7998 | \InsetSpace ~ | |
|
7999 | \InsetSpace ~ | |
|
8000 | \InsetSpace ~ | |
|
8001 | \InsetSpace ~ | |
|
8002 | \InsetSpace ~ | |
|
7336 | 8003 | <5> ['scopes.py', 'strings.py'] |
|
7337 |
\newline |
|
|
8004 | \newline | |
|
7338 | 8005 | fperez[~/test]|6> print _5 |
|
7339 |
\newline |
|
|
7340 |
['scopes.py', 'strings.py |
|
|
7341 | \layout Standard | |
|
8006 | \newline | |
|
8007 | ['scopes.py', 'strings.py | |
|
8008 | '] | |
|
8009 | \end_layout | |
|
7342 | 8010 | |
|
8011 | \begin_layout Standard | |
|
7343 | 8012 | |
|
7344 |
\family typewriter |
|
|
8013 | \family typewriter | |
|
7345 | 8014 | $ |
|
7346 |
\family default |
|
|
8015 | \family default | |
|
7347 | 8016 | and |
|
7348 |
\family typewriter |
|
|
8017 | \family typewriter | |
|
7349 | 8018 | $$ |
|
7350 |
\family default |
|
|
8019 | \family default | |
|
7351 | 8020 | allow direct capture to named variables: |
|
7352 | \layout Standard | |
|
8021 | \end_layout | |
|
7353 | 8022 | |
|
8023 | \begin_layout Standard | |
|
7354 | 8024 | |
|
7355 |
\family typewriter |
|
|
8025 | \family typewriter | |
|
7356 | 8026 | fperez[~/test]|7> $astr = ls *s.py |
|
7357 |
\newline |
|
|
8027 | \newline | |
|
7358 | 8028 | fperez[~/test]|8> astr |
|
7359 |
\newline |
|
|
8029 | \newline | |
|
7360 | 8030 | |
|
7361 | 8031 | \begin_inset ERT |
|
7362 |
status |
|
|
8032 | status collapsed | |
|
7363 | 8033 | |
|
7364 | \layout Standard | |
|
8034 | \begin_layout Standard | |
|
7365 | 8035 | |
|
7366 | \backslash | |
|
8036 | ||
|
8037 | \backslash | |
|
7367 | 8038 | hspace*{0mm} |
|
7368 | \end_inset | |
|
7369 | ||
|
7370 | \SpecialChar ~ | |
|
7371 | \SpecialChar ~ | |
|
7372 | \SpecialChar ~ | |
|
7373 | \SpecialChar ~ | |
|
7374 | \SpecialChar ~ | |
|
7375 | \SpecialChar ~ | |
|
7376 | \SpecialChar ~ | |
|
7377 | \SpecialChar ~ | |
|
7378 | \SpecialChar ~ | |
|
7379 | \SpecialChar ~ | |
|
7380 | \SpecialChar ~ | |
|
7381 | \SpecialChar ~ | |
|
7382 | \SpecialChar ~ | |
|
7383 | \SpecialChar ~ | |
|
8039 | \end_layout | |
|
8040 | ||
|
8041 | \end_inset | |
|
8042 | ||
|
8043 | \InsetSpace ~ | |
|
8044 | \InsetSpace ~ | |
|
8045 | \InsetSpace ~ | |
|
8046 | \InsetSpace ~ | |
|
8047 | \InsetSpace ~ | |
|
8048 | \InsetSpace ~ | |
|
8049 | \InsetSpace ~ | |
|
8050 | \InsetSpace ~ | |
|
8051 | \InsetSpace ~ | |
|
8052 | \InsetSpace ~ | |
|
8053 | \InsetSpace ~ | |
|
8054 | \InsetSpace ~ | |
|
8055 | \InsetSpace ~ | |
|
8056 | \InsetSpace ~ | |
|
7384 | 8057 | <8> 'scopes.py |
|
7385 |
\backslash |
|
|
8058 | \backslash | |
|
7386 | 8059 | nstrings.py' |
|
7387 | \layout Standard | |
|
8060 | \end_layout | |
|
7388 | 8061 | |
|
8062 | \begin_layout Standard | |
|
7389 | 8063 | |
|
7390 |
\family typewriter |
|
|
8064 | \family typewriter | |
|
7391 | 8065 | fperez[~/test]|9> $$alist = ls *s.py |
|
7392 |
\newline |
|
|
8066 | \newline | |
|
7393 | 8067 | fperez[~/test]|10> alist |
|
7394 |
\newline |
|
|
8068 | \newline | |
|
7395 | 8069 | |
|
7396 | 8070 | \begin_inset ERT |
|
7397 |
status |
|
|
8071 | status collapsed | |
|
8072 | ||
|
8073 | \begin_layout Standard | |
|
7398 | 8074 | |
|
7399 | \layout Standard | |
|
7400 | 8075 | |
|
7401 |
\backslash |
|
|
8076 | \backslash | |
|
7402 | 8077 | hspace*{0mm} |
|
7403 | \end_inset | |
|
7404 | ||
|
7405 | \SpecialChar ~ | |
|
7406 | \SpecialChar ~ | |
|
7407 | \SpecialChar ~ | |
|
7408 | \SpecialChar ~ | |
|
7409 | \SpecialChar ~ | |
|
7410 | \SpecialChar ~ | |
|
7411 | \SpecialChar ~ | |
|
7412 | \SpecialChar ~ | |
|
7413 | \SpecialChar ~ | |
|
7414 | \SpecialChar ~ | |
|
7415 | \SpecialChar ~ | |
|
7416 | \SpecialChar ~ | |
|
7417 | \SpecialChar ~ | |
|
7418 | \SpecialChar ~ | |
|
8078 | \end_layout | |
|
8079 | ||
|
8080 | \end_inset | |
|
8081 | ||
|
8082 | \InsetSpace ~ | |
|
8083 | \InsetSpace ~ | |
|
8084 | \InsetSpace ~ | |
|
8085 | \InsetSpace ~ | |
|
8086 | \InsetSpace ~ | |
|
8087 | \InsetSpace ~ | |
|
8088 | \InsetSpace ~ | |
|
8089 | \InsetSpace ~ | |
|
8090 | \InsetSpace ~ | |
|
8091 | \InsetSpace ~ | |
|
8092 | \InsetSpace ~ | |
|
8093 | \InsetSpace ~ | |
|
8094 | \InsetSpace ~ | |
|
8095 | \InsetSpace ~ | |
|
7419 | 8096 | <10> ['scopes.py', 'strings.py'] |
|
7420 | \layout Standard | |
|
8097 | \end_layout | |
|
7421 | 8098 | |
|
8099 | \begin_layout Standard | |
|
7422 | 8100 | alist is now a normal python list you can loop over. |
|
7423 | 8101 | Using |
|
7424 |
\family typewriter |
|
|
8102 | \family typewriter | |
|
7425 | 8103 | $ |
|
7426 |
\family default |
|
|
8104 | \family default | |
|
7427 | 8105 | will expand back the python values when alias calls are made: |
|
7428 | \layout Standard | |
|
8106 | \end_layout | |
|
7429 | 8107 | |
|
8108 | \begin_layout Standard | |
|
7430 | 8109 | |
|
7431 |
\family typewriter |
|
|
8110 | \family typewriter | |
|
7432 | 8111 | fperez[~/test]|11> for f in alist: |
|
7433 |
\newline |
|
|
8112 | \newline | |
|
7434 | 8113 | |
|
7435 | 8114 | \begin_inset ERT |
|
7436 |
status |
|
|
8115 | status collapsed | |
|
7437 | 8116 | |
|
7438 | \layout Standard | |
|
8117 | \begin_layout Standard | |
|
7439 | 8118 | |
|
7440 | \backslash | |
|
8119 | ||
|
8120 | \backslash | |
|
7441 | 8121 | hspace*{0mm} |
|
7442 | \end_inset | |
|
7443 | ||
|
7444 | \SpecialChar ~ | |
|
7445 | \SpecialChar ~ | |
|
7446 | \SpecialChar ~ | |
|
7447 | \SpecialChar ~ | |
|
7448 | \SpecialChar ~ | |
|
7449 | \SpecialChar ~ | |
|
7450 | \SpecialChar ~ | |
|
7451 | \SpecialChar ~ | |
|
7452 | \SpecialChar ~ | |
|
7453 | \SpecialChar ~ | |
|
7454 | \SpecialChar ~ | |
|
7455 | \SpecialChar ~ | |
|
7456 | \SpecialChar ~ | |
|
7457 | \SpecialChar ~ | |
|
7458 | |..> \SpecialChar ~ | |
|
7459 | \SpecialChar ~ | |
|
7460 | \SpecialChar ~ | |
|
7461 | \SpecialChar ~ | |
|
8122 | \end_layout | |
|
8123 | ||
|
8124 | \end_inset | |
|
8125 | ||
|
8126 | \InsetSpace ~ | |
|
8127 | \InsetSpace ~ | |
|
8128 | \InsetSpace ~ | |
|
8129 | \InsetSpace ~ | |
|
8130 | \InsetSpace ~ | |
|
8131 | \InsetSpace ~ | |
|
8132 | \InsetSpace ~ | |
|
8133 | \InsetSpace ~ | |
|
8134 | \InsetSpace ~ | |
|
8135 | \InsetSpace ~ | |
|
8136 | \InsetSpace ~ | |
|
8137 | \InsetSpace ~ | |
|
8138 | \InsetSpace ~ | |
|
8139 | \InsetSpace ~ | |
|
8140 | |..> \InsetSpace ~ | |
|
8141 | \InsetSpace ~ | |
|
8142 | \InsetSpace ~ | |
|
8143 | \InsetSpace ~ | |
|
7462 | 8144 | print 'file',f, |
|
7463 |
\newline |
|
|
8145 | \newline | |
|
7464 | 8146 | |
|
7465 | 8147 | \begin_inset ERT |
|
7466 |
status |
|
|
8148 | status collapsed | |
|
8149 | ||
|
8150 | \begin_layout Standard | |
|
7467 | 8151 | |
|
7468 | \layout Standard | |
|
7469 | 8152 | |
|
7470 |
\backslash |
|
|
8153 | \backslash | |
|
7471 | 8154 | hspace*{0mm} |
|
7472 | \end_inset | |
|
7473 | ||
|
7474 | \SpecialChar ~ | |
|
7475 | \SpecialChar ~ | |
|
7476 | \SpecialChar ~ | |
|
7477 | \SpecialChar ~ | |
|
7478 | \SpecialChar ~ | |
|
7479 | \SpecialChar ~ | |
|
7480 | \SpecialChar ~ | |
|
7481 | \SpecialChar ~ | |
|
7482 | \SpecialChar ~ | |
|
7483 | \SpecialChar ~ | |
|
7484 | \SpecialChar ~ | |
|
7485 | \SpecialChar ~ | |
|
7486 | \SpecialChar ~ | |
|
7487 | \SpecialChar ~ | |
|
7488 | |..> \SpecialChar ~ | |
|
7489 | \SpecialChar ~ | |
|
7490 | \SpecialChar ~ | |
|
7491 | \SpecialChar ~ | |
|
8155 | \end_layout | |
|
8156 | ||
|
8157 | \end_inset | |
|
8158 | ||
|
8159 | \InsetSpace ~ | |
|
8160 | \InsetSpace ~ | |
|
8161 | \InsetSpace ~ | |
|
8162 | \InsetSpace ~ | |
|
8163 | \InsetSpace ~ | |
|
8164 | \InsetSpace ~ | |
|
8165 | \InsetSpace ~ | |
|
8166 | \InsetSpace ~ | |
|
8167 | \InsetSpace ~ | |
|
8168 | \InsetSpace ~ | |
|
8169 | \InsetSpace ~ | |
|
8170 | \InsetSpace ~ | |
|
8171 | \InsetSpace ~ | |
|
8172 | \InsetSpace ~ | |
|
8173 | |..> \InsetSpace ~ | |
|
8174 | \InsetSpace ~ | |
|
8175 | \InsetSpace ~ | |
|
8176 | \InsetSpace ~ | |
|
7492 | 8177 | wc -l $f |
|
7493 |
\newline |
|
|
8178 | \newline | |
|
7494 | 8179 | |
|
7495 | 8180 | \begin_inset ERT |
|
7496 |
status |
|
|
8181 | status collapsed | |
|
7497 | 8182 | |
|
7498 | \layout Standard | |
|
8183 | \begin_layout Standard | |
|
7499 | 8184 | |
|
7500 | \backslash | |
|
8185 | ||
|
8186 | \backslash | |
|
7501 | 8187 | hspace*{0mm} |
|
7502 | \end_inset | |
|
7503 | ||
|
7504 | \SpecialChar ~ | |
|
7505 | \SpecialChar ~ | |
|
7506 | \SpecialChar ~ | |
|
7507 | \SpecialChar ~ | |
|
7508 | \SpecialChar ~ | |
|
7509 | \SpecialChar ~ | |
|
7510 | \SpecialChar ~ | |
|
7511 | \SpecialChar ~ | |
|
7512 | \SpecialChar ~ | |
|
7513 | \SpecialChar ~ | |
|
7514 | \SpecialChar ~ | |
|
7515 | \SpecialChar ~ | |
|
7516 | \SpecialChar ~ | |
|
7517 | \SpecialChar ~ | |
|
8188 | \end_layout | |
|
8189 | ||
|
8190 | \end_inset | |
|
8191 | ||
|
8192 | \InsetSpace ~ | |
|
8193 | \InsetSpace ~ | |
|
8194 | \InsetSpace ~ | |
|
8195 | \InsetSpace ~ | |
|
8196 | \InsetSpace ~ | |
|
8197 | \InsetSpace ~ | |
|
8198 | \InsetSpace ~ | |
|
8199 | \InsetSpace ~ | |
|
8200 | \InsetSpace ~ | |
|
8201 | \InsetSpace ~ | |
|
8202 | \InsetSpace ~ | |
|
8203 | \InsetSpace ~ | |
|
8204 | \InsetSpace ~ | |
|
8205 | \InsetSpace ~ | |
|
7518 | 8206 | |..> |
|
7519 |
\newline |
|
|
8207 | \newline | |
|
7520 | 8208 | file scopes.py 13 scopes.py |
|
7521 |
\newline |
|
|
8209 | \newline | |
|
7522 | 8210 | file strings.py 4 strings.py |
|
7523 | \layout Standard | |
|
8211 | \end_layout | |
|
7524 | 8212 | |
|
8213 | \begin_layout Standard | |
|
7525 | 8214 | Note that you may need to protect your variables with braces if you want |
|
7526 | 8215 | to append strings to their names. |
|
7527 | 8216 | To copy all files in alist to |
|
7528 |
\family typewriter |
|
|
8217 | \family typewriter | |
|
7529 | 8218 | .bak |
|
7530 |
\family default |
|
|
8219 | \family default | |
|
7531 | 8220 | extensions, you must use: |
|
7532 | \layout Standard | |
|
8221 | \end_layout | |
|
7533 | 8222 | |
|
8223 | \begin_layout Standard | |
|
7534 | 8224 | |
|
7535 |
\family typewriter |
|
|
8225 | \family typewriter | |
|
7536 | 8226 | fperez[~/test]|12> for f in alist: |
|
7537 |
\newline |
|
|
8227 | \newline | |
|
7538 | 8228 | |
|
7539 | 8229 | \begin_inset ERT |
|
7540 |
status |
|
|
8230 | status collapsed | |
|
8231 | ||
|
8232 | \begin_layout Standard | |
|
7541 | 8233 | |
|
7542 | \layout Standard | |
|
7543 | 8234 | |
|
7544 |
\backslash |
|
|
8235 | \backslash | |
|
7545 | 8236 | hspace*{0mm} |
|
7546 | \end_inset | |
|
7547 | ||
|
7548 | \SpecialChar ~ | |
|
7549 | \SpecialChar ~ | |
|
7550 | \SpecialChar ~ | |
|
7551 | \SpecialChar ~ | |
|
7552 | \SpecialChar ~ | |
|
7553 | \SpecialChar ~ | |
|
7554 | \SpecialChar ~ | |
|
7555 | \SpecialChar ~ | |
|
7556 | \SpecialChar ~ | |
|
7557 | \SpecialChar ~ | |
|
7558 | \SpecialChar ~ | |
|
7559 | \SpecialChar ~ | |
|
7560 | \SpecialChar ~ | |
|
7561 | \SpecialChar ~ | |
|
7562 | |..> \SpecialChar ~ | |
|
7563 | \SpecialChar ~ | |
|
7564 | \SpecialChar ~ | |
|
7565 | \SpecialChar ~ | |
|
8237 | \end_layout | |
|
8238 | ||
|
8239 | \end_inset | |
|
8240 | ||
|
8241 | \InsetSpace ~ | |
|
8242 | \InsetSpace ~ | |
|
8243 | \InsetSpace ~ | |
|
8244 | \InsetSpace ~ | |
|
8245 | \InsetSpace ~ | |
|
8246 | \InsetSpace ~ | |
|
8247 | \InsetSpace ~ | |
|
8248 | \InsetSpace ~ | |
|
8249 | \InsetSpace ~ | |
|
8250 | \InsetSpace ~ | |
|
8251 | \InsetSpace ~ | |
|
8252 | \InsetSpace ~ | |
|
8253 | \InsetSpace ~ | |
|
8254 | \InsetSpace ~ | |
|
8255 | |..> \InsetSpace ~ | |
|
8256 | \InsetSpace ~ | |
|
8257 | \InsetSpace ~ | |
|
8258 | \InsetSpace ~ | |
|
7566 | 8259 | cp $f ${f}.bak |
|
7567 | \layout Standard | |
|
8260 | \end_layout | |
|
7568 | 8261 | |
|
8262 | \begin_layout Standard | |
|
7569 | 8263 | If you try using |
|
7570 |
\family typewriter |
|
|
8264 | \family typewriter | |
|
7571 | 8265 | $f.bak |
|
7572 |
\family default |
|
|
8266 | \family default | |
|
7573 | 8267 | , you'll get an AttributeError exception saying that your string object |
|
7574 | 8268 | doesn't have a |
|
7575 |
\family typewriter |
|
|
8269 | \family typewriter | |
|
7576 | 8270 | .bak |
|
7577 |
\family default |
|
|
8271 | \family default | |
|
7578 | 8272 | attribute. |
|
7579 | 8273 | This is because the |
|
7580 |
\family typewriter |
|
|
8274 | \family typewriter | |
|
7581 | 8275 | $ |
|
7582 |
\family default |
|
|
8276 | \family default | |
|
7583 | 8277 | expansion mechanism allows you to expand full Python expressions: |
|
7584 | \layout Standard | |
|
8278 | \end_layout | |
|
7585 | 8279 | |
|
8280 | \begin_layout Standard | |
|
7586 | 8281 | |
|
7587 |
\family typewriter |
|
|
8282 | \family typewriter | |
|
7588 | 8283 | fperez[~/test]|13> echo "sys.platform is: $sys.platform" |
|
7589 |
\newline |
|
|
8284 | \newline | |
|
7590 | 8285 | sys.platform is: linux2 |
|
7591 | \layout Standard | |
|
8286 | \end_layout | |
|
7592 | 8287 | |
|
8288 | \begin_layout Standard | |
|
7593 | 8289 | IPython's input history handling is still active, which allows you to rerun |
|
7594 | 8290 | a single block of multi-line input by simply using exec: |
|
7595 |
\newline |
|
|
8291 | \newline | |
|
7596 | 8292 | |
|
7597 |
\family typewriter |
|
|
8293 | \family typewriter | |
|
7598 | 8294 | fperez[~/test]|14> $$alist = ls *.eps |
|
7599 |
\newline |
|
|
8295 | \newline | |
|
7600 | 8296 | fperez[~/test]|15> exec _i11 |
|
7601 |
\newline |
|
|
7602 |
file image2.eps |
|
|
7603 | \newline | |
|
8297 | \newline | |
|
8298 | file image2.eps | |
|
8299 | 921 image2.eps | |
|
8300 | \newline | |
|
7604 | 8301 | file image.eps 921 image.eps |
|
7605 | \layout Standard | |
|
8302 | \end_layout | |
|
7606 | 8303 | |
|
8304 | \begin_layout Standard | |
|
7607 | 8305 | While these are new special-case syntaxes, they are designed to allow very |
|
7608 | 8306 | efficient use of the shell with minimal typing. |
|
7609 | 8307 | At an interactive shell prompt, conciseness of expression wins over readability. |
|
7610 | \layout Subsection | |
|
8308 | \end_layout | |
|
7611 | 8309 | |
|
8310 | \begin_layout Subsection | |
|
7612 | 8311 | Useful functions and modules |
|
7613 | \layout Standard | |
|
8312 | \end_layout | |
|
7614 | 8313 | |
|
8314 | \begin_layout Standard | |
|
7615 | 8315 | The os, sys and shutil modules from the Python standard library are automaticall |
|
7616 | 8316 | y loaded. |
|
7617 | 8317 | Some additional functions, useful for shell usage, are listed below. |
|
7618 | 8318 | You can request more help about them with ` |
|
7619 |
\family typewriter |
|
|
8319 | \family typewriter | |
|
7620 | 8320 | ? |
|
7621 |
\family default |
|
|
8321 | \family default | |
|
7622 | 8322 | '. |
|
7623 | \layout Description | |
|
8323 | \end_layout | |
|
7624 | 8324 | |
|
8325 | \begin_layout Description | |
|
7625 | 8326 | |
|
7626 |
\family typewriter |
|
|
8327 | \family typewriter | |
|
7627 | 8328 | shell |
|
7628 |
\family default |
|
|
8329 | \family default | |
|
7629 | 8330 | - execute a command in the underlying system shell |
|
7630 | \layout Description | |
|
8331 | \end_layout | |
|
7631 | 8332 | |
|
8333 | \begin_layout Description | |
|
7632 | 8334 | |
|
7633 |
\family typewriter |
|
|
8335 | \family typewriter | |
|
7634 | 8336 | system |
|
7635 |
\family default |
|
|
8337 | \family default | |
|
7636 | 8338 | - like |
|
7637 |
\family typewriter |
|
|
8339 | \family typewriter | |
|
7638 | 8340 | shell() |
|
7639 |
\family default |
|
|
8341 | \family default | |
|
7640 | 8342 | , but return the exit status of the command |
|
7641 | \layout Description | |
|
8343 | \end_layout | |
|
7642 | 8344 | |
|
8345 | \begin_layout Description | |
|
7643 | 8346 | |
|
7644 |
\family typewriter |
|
|
8347 | \family typewriter | |
|
7645 | 8348 | sout |
|
7646 |
\family default |
|
|
8349 | \family default | |
|
7647 | 8350 | - capture the output of a command as a string |
|
7648 | \layout Description | |
|
8351 | \end_layout | |
|
7649 | 8352 | |
|
8353 | \begin_layout Description | |
|
7650 | 8354 | |
|
7651 |
\family typewriter |
|
|
8355 | \family typewriter | |
|
7652 | 8356 | lout |
|
7653 |
\family default |
|
|
8357 | \family default | |
|
7654 | 8358 | - capture the output of a command as a list (split on ` |
|
7655 |
\backslash |
|
|
8359 | \backslash | |
|
7656 | 8360 | n') |
|
7657 | \layout Description | |
|
8361 | \end_layout | |
|
7658 | 8362 | |
|
8363 | \begin_layout Description | |
|
7659 | 8364 | |
|
7660 |
\family typewriter |
|
|
8365 | \family typewriter | |
|
7661 | 8366 | getoutputerror |
|
7662 |
\family default |
|
|
8367 | \family default | |
|
7663 | 8368 | - capture (output,error) of a shell commandss |
|
7664 | \layout Standard | |
|
8369 | \end_layout | |
|
7665 | 8370 | |
|
8371 | \begin_layout Standard | |
|
7666 | 8372 | |
|
7667 |
\family typewriter |
|
|
8373 | \family typewriter | |
|
7668 | 8374 | sout |
|
7669 |
\family default |
|
|
8375 | \family default | |
|
7670 | 8376 | / |
|
7671 |
\family typewriter |
|
|
8377 | \family typewriter | |
|
7672 | 8378 | lout |
|
7673 |
\family default |
|
|
8379 | \family default | |
|
7674 | 8380 | are the functional equivalents of |
|
7675 |
\family typewriter |
|
|
8381 | \family typewriter | |
|
7676 | 8382 | $ |
|
7677 |
\family default |
|
|
8383 | \family default | |
|
7678 | 8384 | / |
|
7679 |
\family typewriter |
|
|
8385 | \family typewriter | |
|
7680 | 8386 | $$ |
|
7681 |
\family default |
|
|
8387 | \family default | |
|
7682 | 8388 | . |
|
7683 | 8389 | They are provided to allow you to capture system output in the middle of |
|
7684 | 8390 | true python code, function definitions, etc (where |
|
7685 |
\family typewriter |
|
|
8391 | \family typewriter | |
|
7686 | 8392 | $ |
|
7687 |
\family default |
|
|
8393 | \family default | |
|
7688 | 8394 | and |
|
7689 |
\family typewriter |
|
|
8395 | \family typewriter | |
|
7690 | 8396 | $$ |
|
7691 |
\family default |
|
|
8397 | \family default | |
|
7692 | 8398 | are invalid). |
|
7693 | \layout Subsection | |
|
8399 | \end_layout | |
|
7694 | 8400 | |
|
8401 | \begin_layout Subsection | |
|
7695 | 8402 | Directory management |
|
7696 | \layout Standard | |
|
8403 | \end_layout | |
|
7697 | 8404 | |
|
8405 | \begin_layout Standard | |
|
7698 | 8406 | Since each command passed by pysh to the underlying system is executed in |
|
7699 | 8407 | a subshell which exits immediately, you can NOT use !cd to navigate the |
|
7700 | 8408 | filesystem. |
|
7701 | \layout Standard | |
|
8409 | \end_layout | |
|
7702 | 8410 | |
|
8411 | \begin_layout Standard | |
|
7703 | 8412 | Pysh provides its own builtin |
|
7704 |
\family typewriter |
|
|
8413 | \family typewriter | |
|
7705 | 8414 | `%cd |
|
7706 |
\family default |
|
|
8415 | \family default | |
|
7707 | 8416 | ' magic command to move in the filesystem (the |
|
7708 |
\family typewriter |
|
|
8417 | \family typewriter | |
|
7709 | 8418 | % |
|
7710 |
\family default |
|
|
8419 | \family default | |
|
7711 | 8420 | is not required with automagic on). |
|
7712 | 8421 | It also maintains a list of visited directories (use |
|
7713 |
\family typewriter |
|
|
8422 | \family typewriter | |
|
7714 | 8423 | %dhist |
|
7715 |
\family default |
|
|
8424 | \family default | |
|
7716 | 8425 | to see it) and allows direct switching to any of them. |
|
7717 | 8426 | Type |
|
7718 |
\family typewriter |
|
|
8427 | \family typewriter | |
|
7719 | 8428 | `cd? |
|
7720 |
\family default |
|
|
8429 | \family default | |
|
7721 | 8430 | ' for more details. |
|
7722 | \layout Standard | |
|
8431 | \end_layout | |
|
7723 | 8432 | |
|
8433 | \begin_layout Standard | |
|
7724 | 8434 | |
|
7725 |
\family typewriter |
|
|
8435 | \family typewriter | |
|
7726 | 8436 | %pushd |
|
7727 |
\family default |
|
|
8437 | \family default | |
|
7728 | 8438 | , |
|
7729 |
\family typewriter |
|
|
8439 | \family typewriter | |
|
7730 | 8440 | %popd |
|
7731 |
\family default |
|
|
8441 | \family default | |
|
7732 | 8442 | and |
|
7733 |
\family typewriter |
|
|
8443 | \family typewriter | |
|
7734 | 8444 | %dirs |
|
7735 |
\family default |
|
|
8445 | \family default | |
|
7736 | 8446 | are provided for directory stack handling. |
|
7737 | \layout Subsection | |
|
8447 | \end_layout | |
|
7738 | 8448 | |
|
8449 | \begin_layout Subsection | |
|
7739 | 8450 | Prompt customization |
|
7740 | \layout Standard | |
|
8451 | \end_layout | |
|
7741 | 8452 | |
|
8453 | \begin_layout Standard | |
|
7742 | 8454 | The supplied |
|
7743 |
\family typewriter |
|
|
8455 | \family typewriter | |
|
7744 | 8456 | ipythonrc-pysh |
|
7745 |
\family default |
|
|
8457 | \family default | |
|
7746 | 8458 | profile comes with an example of a very colored and detailed prompt, mainly |
|
7747 | 8459 | to serve as an illustration. |
|
7748 | 8460 | The valid escape sequences, besides color names, are: |
|
7749 | \layout Description | |
|
8461 | \end_layout | |
|
7750 | 8462 | |
|
8463 | \begin_layout Description | |
|
7751 | 8464 | |
|
7752 |
\backslash |
|
|
8465 | \backslash | |
|
7753 | 8466 | # - Prompt number. |
|
7754 | \layout Description | |
|
8467 | \end_layout | |
|
7755 | 8468 | |
|
8469 | \begin_layout Description | |
|
7756 | 8470 | |
|
7757 |
\backslash |
|
|
8471 | \backslash | |
|
7758 | 8472 | D - Dots, as many as there are digits in |
|
7759 |
\backslash |
|
|
8473 | \backslash | |
|
7760 | 8474 | # (so they align). |
|
7761 | \layout Description | |
|
8475 | \end_layout | |
|
7762 | 8476 | |
|
8477 | \begin_layout Description | |
|
7763 | 8478 | |
|
7764 |
\backslash |
|
|
8479 | \backslash | |
|
7765 | 8480 | w - Current working directory (cwd). |
|
7766 | \layout Description | |
|
8481 | \end_layout | |
|
7767 | 8482 | |
|
8483 | \begin_layout Description | |
|
7768 | 8484 | |
|
7769 |
\backslash |
|
|
8485 | \backslash | |
|
7770 | 8486 | W - Basename of current working directory. |
|
7771 | \layout Description | |
|
8487 | \end_layout | |
|
7772 | 8488 | |
|
8489 | \begin_layout Description | |
|
7773 | 8490 | |
|
7774 |
\backslash |
|
|
8491 | \backslash | |
|
7775 | 8492 | X |
|
7776 |
\emph on |
|
|
8493 | \emph on | |
|
7777 | 8494 | N |
|
7778 |
\emph default |
|
|
8495 | \emph default | |
|
7779 | 8496 | - Where |
|
7780 |
\emph on |
|
|
8497 | \emph on | |
|
7781 | 8498 | N |
|
7782 |
\emph default |
|
|
8499 | \emph default | |
|
7783 | 8500 | =0..5. |
|
7784 | 8501 | N terms of the cwd, with $HOME written as ~. |
|
7785 | \layout Description | |
|
8502 | \end_layout | |
|
7786 | 8503 | |
|
8504 | \begin_layout Description | |
|
7787 | 8505 | |
|
7788 |
\backslash |
|
|
8506 | \backslash | |
|
7789 | 8507 | Y |
|
7790 |
\emph on |
|
|
8508 | \emph on | |
|
7791 | 8509 | N |
|
7792 |
\emph default |
|
|
8510 | \emph default | |
|
7793 | 8511 | - Where |
|
7794 |
\emph on |
|
|
8512 | \emph on | |
|
7795 | 8513 | N |
|
7796 |
\emph default |
|
|
8514 | \emph default | |
|
7797 | 8515 | =0..5. |
|
7798 | 8516 | Like X |
|
7799 |
\emph on |
|
|
8517 | \emph on | |
|
7800 | 8518 | N |
|
7801 |
\emph default |
|
|
8519 | \emph default | |
|
7802 | 8520 | , but if ~ is term |
|
7803 |
\emph on |
|
|
8521 | \emph on | |
|
7804 | 8522 | N |
|
7805 |
\emph default |
|
|
8523 | \emph default | |
|
7806 | 8524 | +1 it's also shown. |
|
7807 | \layout Description | |
|
8525 | \end_layout | |
|
7808 | 8526 | |
|
8527 | \begin_layout Description | |
|
7809 | 8528 | |
|
7810 |
\backslash |
|
|
8529 | \backslash | |
|
7811 | 8530 | u - Username. |
|
7812 | \layout Description | |
|
8531 | \end_layout | |
|
7813 | 8532 | |
|
8533 | \begin_layout Description | |
|
7814 | 8534 | |
|
7815 |
\backslash |
|
|
8535 | \backslash | |
|
7816 | 8536 | H - Full hostname. |
|
7817 | \layout Description | |
|
8537 | \end_layout | |
|
7818 | 8538 | |
|
8539 | \begin_layout Description | |
|
7819 | 8540 | |
|
7820 |
\backslash |
|
|
8541 | \backslash | |
|
7821 | 8542 | h - Hostname up to first '.' |
|
7822 | \layout Description | |
|
8543 | \end_layout | |
|
7823 | 8544 | |
|
8545 | \begin_layout Description | |
|
7824 | 8546 | |
|
7825 |
\backslash |
|
|
8547 | \backslash | |
|
7826 | 8548 | $ - Root symbol ($ or #). |
|
7827 | 8549 | |
|
7828 | \layout Description | |
|
8550 | \end_layout | |
|
7829 | 8551 | |
|
8552 | \begin_layout Description | |
|
7830 | 8553 | |
|
7831 |
\backslash |
|
|
8554 | \backslash | |
|
7832 | 8555 | t - Current time, in H:M:S format. |
|
7833 | \layout Description | |
|
8556 | \end_layout | |
|
7834 | 8557 | |
|
8558 | \begin_layout Description | |
|
7835 | 8559 | |
|
7836 |
\backslash |
|
|
8560 | \backslash | |
|
7837 | 8561 | v - IPython release version. |
|
7838 | 8562 | |
|
7839 | \layout Description | |
|
8563 | \end_layout | |
|
7840 | 8564 | |
|
8565 | \begin_layout Description | |
|
7841 | 8566 | |
|
7842 |
\backslash |
|
|
8567 | \backslash | |
|
7843 | 8568 | n - Newline. |
|
7844 | 8569 | |
|
7845 | \layout Description | |
|
8570 | \end_layout | |
|
7846 | 8571 | |
|
8572 | \begin_layout Description | |
|
7847 | 8573 | |
|
7848 |
\backslash |
|
|
8574 | \backslash | |
|
7849 | 8575 | r - Carriage return. |
|
7850 | 8576 | |
|
7851 | \layout Description | |
|
8577 | \end_layout | |
|
7852 | 8578 | |
|
8579 | \begin_layout Description | |
|
7853 | 8580 | |
|
7854 |
\backslash |
|
|
8581 | \backslash | |
|
7855 | 8582 | |
|
7856 |
\backslash |
|
|
8583 | \backslash | |
|
7857 | 8584 | - An explicitly escaped ' |
|
7858 |
\backslash |
|
|
8585 | \backslash | |
|
7859 | 8586 | '. |
|
7860 | \layout Standard | |
|
8587 | \end_layout | |
|
7861 | 8588 | |
|
8589 | \begin_layout Standard | |
|
7862 | 8590 | You can configure your prompt colors using any ANSI color escape. |
|
7863 | 8591 | Each color escape sets the color for any subsequent text, until another |
|
7864 | 8592 | escape comes in and changes things. |
|
7865 | 8593 | The valid color escapes are: |
|
7866 | \layout Description | |
|
8594 | \end_layout | |
|
7867 | 8595 | |
|
8596 | \begin_layout Description | |
|
7868 | 8597 | |
|
7869 |
\backslash |
|
|
8598 | \backslash | |
|
7870 | 8599 | C_Black |
|
7871 | \layout Description | |
|
8600 | \end_layout | |
|
7872 | 8601 | |
|
8602 | \begin_layout Description | |
|
7873 | 8603 | |
|
7874 |
\backslash |
|
|
8604 | \backslash | |
|
7875 | 8605 | C_Blue |
|
7876 | \layout Description | |
|
8606 | \end_layout | |
|
7877 | 8607 | |
|
8608 | \begin_layout Description | |
|
7878 | 8609 | |
|
7879 |
\backslash |
|
|
8610 | \backslash | |
|
7880 | 8611 | C_Brown |
|
7881 | \layout Description | |
|
8612 | \end_layout | |
|
7882 | 8613 | |
|
8614 | \begin_layout Description | |
|
7883 | 8615 | |
|
7884 |
\backslash |
|
|
8616 | \backslash | |
|
7885 | 8617 | C_Cyan |
|
7886 | \layout Description | |
|
8618 | \end_layout | |
|
7887 | 8619 | |
|
8620 | \begin_layout Description | |
|
7888 | 8621 | |
|
7889 |
\backslash |
|
|
8622 | \backslash | |
|
7890 | 8623 | C_DarkGray |
|
7891 | \layout Description | |
|
8624 | \end_layout | |
|
7892 | 8625 | |
|
8626 | \begin_layout Description | |
|
7893 | 8627 | |
|
7894 |
\backslash |
|
|
8628 | \backslash | |
|
7895 | 8629 | C_Green |
|
7896 | \layout Description | |
|
8630 | \end_layout | |
|
7897 | 8631 | |
|
8632 | \begin_layout Description | |
|
7898 | 8633 | |
|
7899 |
\backslash |
|
|
8634 | \backslash | |
|
7900 | 8635 | C_LightBlue |
|
7901 | \layout Description | |
|
8636 | \end_layout | |
|
7902 | 8637 | |
|
8638 | \begin_layout Description | |
|
7903 | 8639 | |
|
7904 |
\backslash |
|
|
8640 | \backslash | |
|
7905 | 8641 | C_LightCyan |
|
7906 | \layout Description | |
|
8642 | \end_layout | |
|
7907 | 8643 | |
|
8644 | \begin_layout Description | |
|
7908 | 8645 | |
|
7909 |
\backslash |
|
|
8646 | \backslash | |
|
7910 | 8647 | C_LightGray |
|
7911 | \layout Description | |
|
8648 | \end_layout | |
|
7912 | 8649 | |
|
8650 | \begin_layout Description | |
|
7913 | 8651 | |
|
7914 |
\backslash |
|
|
8652 | \backslash | |
|
7915 | 8653 | C_LightGreen |
|
7916 | \layout Description | |
|
8654 | \end_layout | |
|
7917 | 8655 | |
|
8656 | \begin_layout Description | |
|
7918 | 8657 | |
|
7919 |
\backslash |
|
|
8658 | \backslash | |
|
7920 | 8659 | C_LightPurple |
|
7921 | \layout Description | |
|
8660 | \end_layout | |
|
7922 | 8661 | |
|
8662 | \begin_layout Description | |
|
7923 | 8663 | |
|
7924 |
\backslash |
|
|
8664 | \backslash | |
|
7925 | 8665 | C_LightRed |
|
7926 | \layout Description | |
|
8666 | \end_layout | |
|
7927 | 8667 | |
|
8668 | \begin_layout Description | |
|
7928 | 8669 | |
|
7929 |
\backslash |
|
|
8670 | \backslash | |
|
7930 | 8671 | C_Purple |
|
7931 | \layout Description | |
|
8672 | \end_layout | |
|
7932 | 8673 | |
|
8674 | \begin_layout Description | |
|
7933 | 8675 | |
|
7934 |
\backslash |
|
|
8676 | \backslash | |
|
7935 | 8677 | C_Red |
|
7936 | \layout Description | |
|
8678 | \end_layout | |
|
7937 | 8679 | |
|
8680 | \begin_layout Description | |
|
7938 | 8681 | |
|
7939 |
\backslash |
|
|
8682 | \backslash | |
|
7940 | 8683 | C_White |
|
7941 | \layout Description | |
|
8684 | \end_layout | |
|
7942 | 8685 | |
|
8686 | \begin_layout Description | |
|
7943 | 8687 | |
|
7944 |
\backslash |
|
|
8688 | \backslash | |
|
7945 | 8689 | C_Yellow |
|
7946 | \layout Description | |
|
8690 | \end_layout | |
|
7947 | 8691 | |
|
8692 | \begin_layout Description | |
|
7948 | 8693 | |
|
7949 |
\backslash |
|
|
8694 | \backslash | |
|
7950 | 8695 | C_Normal Stop coloring, defaults to your terminal settings. |
|
7951 | \layout Section | |
|
7952 | ||
|
8696 | \end_layout | |
|
7953 | 8697 | |
|
8698 | \begin_layout Section | |
|
7954 | 8699 | \begin_inset LatexCommand \label{sec:Threading-support} |
|
7955 | 8700 | |
|
7956 |
\end_inset |
|
|
8701 | \end_inset | |
|
7957 | 8702 | |
|
7958 | 8703 | Threading support |
|
7959 | \layout Standard | |
|
8704 | \end_layout | |
|
7960 | 8705 | |
|
8706 | \begin_layout Standard | |
|
7961 | 8707 | |
|
7962 |
\series bold |
|
|
8708 | \series bold | |
|
7963 | 8709 | WARNING: |
|
7964 |
\series default |
|
|
8710 | \series default | |
|
7965 | 8711 | The threading support is still somewhat experimental, and it has only seen |
|
7966 | 8712 | reasonable testing under Linux. |
|
7967 | 8713 | Threaded code is particularly tricky to debug, and it tends to show extremely |
@@ -7969,25 +8715,26 b' The threading support is still somewhat experimental, and it has only seen' | |||
|
7969 | 8715 | Since I only have access to Linux machines, I will have to rely on user's |
|
7970 | 8716 | experiences and assistance for this area of IPython to improve under other |
|
7971 | 8717 | platforms. |
|
7972 | \layout Standard | |
|
8718 | \end_layout | |
|
7973 | 8719 | |
|
8720 | \begin_layout Standard | |
|
7974 | 8721 | IPython, via the |
|
7975 |
\family typewriter |
|
|
8722 | \family typewriter | |
|
7976 | 8723 | -gthread |
|
7977 |
\family default |
|
|
8724 | \family default | |
|
7978 | 8725 | , |
|
7979 |
\family typewriter |
|
|
8726 | \family typewriter | |
|
7980 | 8727 | -qthread |
|
7981 |
\family default |
|
|
8728 | \family default | |
|
7982 | 8729 | and |
|
7983 |
\family typewriter |
|
|
8730 | \family typewriter | |
|
7984 | 8731 | -wthread |
|
7985 |
\family default |
|
|
7986 |
options (described in Sec.\ |
|
|
8732 | \family default | |
|
8733 | options (described in Sec.\InsetSpace ~ | |
|
7987 | 8734 | |
|
7988 | 8735 | \begin_inset LatexCommand \ref{sec:threading-opts} |
|
7989 | 8736 | |
|
7990 |
\end_inset |
|
|
8737 | \end_inset | |
|
7991 | 8738 | |
|
7992 | 8739 | ), can run in multithreaded mode to support pyGTK, Qt and WXPython applications |
|
7993 | 8740 | respectively. |
@@ -7995,181 +8742,193 b' IPython, via the' | |||
|
7995 | 8742 | under a normal Python interpreter, starting a pyGTK, Qt or WXPython application |
|
7996 | 8743 | will immediately freeze the shell. |
|
7997 | 8744 | |
|
7998 | \layout Standard | |
|
8745 | \end_layout | |
|
7999 | 8746 | |
|
8747 | \begin_layout Standard | |
|
8000 | 8748 | IPython, with one of these options (you can only use one at a time), separates |
|
8001 | 8749 | the graphical loop and IPython's code execution run into different threads. |
|
8002 | 8750 | This allows you to test interactively (with |
|
8003 |
\family typewriter |
|
|
8751 | \family typewriter | |
|
8004 | 8752 | %run |
|
8005 |
\family default |
|
|
8753 | \family default | |
|
8006 | 8754 | , for example) your GUI code without blocking. |
|
8007 | \layout Standard | |
|
8755 | \end_layout | |
|
8008 | 8756 | |
|
8757 | \begin_layout Standard | |
|
8009 | 8758 | A nice mini-tutorial on using IPython along with the Qt Designer application |
|
8010 | 8759 | is available at the SciPy wiki: |
|
8011 | 8760 | \begin_inset LatexCommand \htmlurl{http://www.scipy.org/Cookbook/Matplotlib/Qt_with_IPython_and_Designer} |
|
8012 | 8761 | |
|
8013 |
\end_inset |
|
|
8762 | \end_inset | |
|
8014 | 8763 | |
|
8015 | 8764 | . |
|
8016 | \layout Subsection | |
|
8765 | \end_layout | |
|
8017 | 8766 | |
|
8767 | \begin_layout Subsection | |
|
8018 | 8768 | Tk issues |
|
8019 | \layout Standard | |
|
8769 | \end_layout | |
|
8020 | 8770 | |
|
8021 | As indicated in Sec.\SpecialChar ~ | |
|
8771 | \begin_layout Standard | |
|
8772 | As indicated in Sec.\InsetSpace ~ | |
|
8022 | 8773 | |
|
8023 | 8774 | \begin_inset LatexCommand \ref{sec:threading-opts} |
|
8024 | 8775 | |
|
8025 |
\end_inset |
|
|
8776 | \end_inset | |
|
8026 | 8777 | |
|
8027 | 8778 | , a special |
|
8028 |
\family typewriter |
|
|
8779 | \family typewriter | |
|
8029 | 8780 | -tk |
|
8030 |
\family default |
|
|
8781 | \family default | |
|
8031 | 8782 | option is provided to try and allow Tk graphical applications to coexist |
|
8032 | 8783 | interactively with WX, Qt or GTK ones. |
|
8033 | 8784 | Whether this works at all, however, is very platform and configuration |
|
8034 | 8785 | dependent. |
|
8035 | 8786 | Please experiment with simple test cases before committing to using this |
|
8036 | 8787 | combination of Tk and GTK/Qt/WX threading in a production environment. |
|
8037 | \layout Subsection | |
|
8788 | \end_layout | |
|
8038 | 8789 | |
|
8790 | \begin_layout Subsection | |
|
8039 | 8791 | Signals and Threads |
|
8040 | \layout Standard | |
|
8792 | \end_layout | |
|
8041 | 8793 | |
|
8794 | \begin_layout Standard | |
|
8042 | 8795 | When any of the thread systems (GTK, Qt or WX) are active, either directly |
|
8043 | 8796 | or via |
|
8044 |
\family typewriter |
|
|
8797 | \family typewriter | |
|
8045 | 8798 | -pylab |
|
8046 |
\family default |
|
|
8799 | \family default | |
|
8047 | 8800 | with a threaded backend, it is impossible to interrupt long-running Python |
|
8048 | 8801 | code via |
|
8049 |
\family typewriter |
|
|
8802 | \family typewriter | |
|
8050 | 8803 | Ctrl-C |
|
8051 |
\family default |
|
|
8804 | \family default | |
|
8052 | 8805 | . |
|
8053 | 8806 | IPython can not pass the KeyboardInterrupt exception (or the underlying |
|
8054 | 8807 | |
|
8055 |
\family typewriter |
|
|
8808 | \family typewriter | |
|
8056 | 8809 | SIGINT |
|
8057 |
\family default |
|
|
8810 | \family default | |
|
8058 | 8811 | ) across threads, so any long-running process started from IPython will |
|
8059 | 8812 | run to completion, or will have to be killed via an external (OS-based) |
|
8060 | 8813 | mechanism. |
|
8061 | \layout Standard | |
|
8814 | \end_layout | |
|
8062 | 8815 | |
|
8816 | \begin_layout Standard | |
|
8063 | 8817 | To the best of my knowledge, this limitation is imposed by the Python interprete |
|
8064 | 8818 | r itself, and it comes from the difficulty of writing portable signal/threaded |
|
8065 | 8819 | code. |
|
8066 | 8820 | If any user is an expert on this topic and can suggest a better solution, |
|
8067 | 8821 | I would love to hear about it. |
|
8068 | 8822 | In the IPython sources, look at the |
|
8069 |
\family typewriter |
|
|
8823 | \family typewriter | |
|
8070 | 8824 | Shell.py |
|
8071 |
\family default |
|
|
8825 | \family default | |
|
8072 | 8826 | module, and in particular at the |
|
8073 |
\family typewriter |
|
|
8827 | \family typewriter | |
|
8074 | 8828 | runcode() |
|
8075 |
\family default |
|
|
8829 | \family default | |
|
8076 | 8830 | method. |
|
8077 | 8831 | |
|
8078 | \layout Subsection | |
|
8832 | \end_layout | |
|
8079 | 8833 | |
|
8834 | \begin_layout Subsection | |
|
8080 | 8835 | I/O pitfalls |
|
8081 | \layout Standard | |
|
8836 | \end_layout | |
|
8082 | 8837 | |
|
8838 | \begin_layout Standard | |
|
8083 | 8839 | Be mindful that the Python interpreter switches between threads every |
|
8084 | 8840 | \begin_inset Formula $N$ |
|
8085 |
\end_inset |
|
|
8841 | \end_inset | |
|
8086 | 8842 | |
|
8087 |
bytecodes, where the default value as of Python\ |
|
|
8843 | bytecodes, where the default value as of Python\InsetSpace ~ | |
|
8088 | 8844 | 2.3 is |
|
8089 | 8845 | \begin_inset Formula $N=100.$ |
|
8090 |
\end_inset |
|
|
8846 | \end_inset | |
|
8091 | 8847 | |
|
8092 | 8848 | This value can be read by using the |
|
8093 |
\family typewriter |
|
|
8849 | \family typewriter | |
|
8094 | 8850 | sys.getcheckinterval() |
|
8095 |
\family default |
|
|
8851 | \family default | |
|
8096 | 8852 | function, and it can be reset via |
|
8097 |
\family typewriter |
|
|
8853 | \family typewriter | |
|
8098 | 8854 | sys.setcheckinterval( |
|
8099 |
\emph on |
|
|
8855 | \emph on | |
|
8100 | 8856 | N |
|
8101 |
\emph default |
|
|
8857 | \emph default | |
|
8102 | 8858 | ) |
|
8103 |
\family default |
|
|
8859 | \family default | |
|
8104 | 8860 | . |
|
8105 | 8861 | This switching of threads can cause subtly confusing effects if one of |
|
8106 | 8862 | your threads is doing file I/O. |
|
8107 | 8863 | In text mode, most systems only flush file buffers when they encounter |
|
8108 | 8864 | a |
|
8109 |
\family typewriter |
|
|
8865 | \family typewriter | |
|
8110 | 8866 | ` |
|
8111 |
\backslash |
|
|
8867 | \backslash | |
|
8112 | 8868 | n' |
|
8113 |
\family default |
|
|
8869 | \family default | |
|
8114 | 8870 | . |
|
8115 | 8871 | An instruction as simple as |
|
8116 |
\family typewriter |
|
|
8872 | \family typewriter | |
|
8117 | 8873 | |
|
8118 |
\newline |
|
|
8119 | \SpecialChar ~ | |
|
8120 | \SpecialChar ~ | |
|
8874 | \newline | |
|
8875 | \InsetSpace ~ | |
|
8876 | \InsetSpace ~ | |
|
8121 | 8877 | print >> filehandle, |
|
8122 | 8878 | \begin_inset Quotes eld |
|
8123 |
\end_inset |
|
|
8879 | \end_inset | |
|
8124 | 8880 | |
|
8125 | 8881 | hello world |
|
8126 | 8882 | \begin_inset Quotes erd |
|
8127 |
\end_inset |
|
|
8883 | \end_inset | |
|
8128 | 8884 | |
|
8129 | 8885 | |
|
8130 |
\family default |
|
|
8886 | \family default | |
|
8131 | 8887 | |
|
8132 |
\newline |
|
|
8888 | \newline | |
|
8133 | 8889 | actually consists of several bytecodes, so it is possible that the newline |
|
8134 | 8890 | does not reach your file before the next thread switch. |
|
8135 | 8891 | Similarly, if you are writing to a file in binary mode, the file won't |
|
8136 | 8892 | be flushed until the buffer fills, and your other thread may see apparently |
|
8137 | 8893 | truncated files. |
|
8138 | 8894 | |
|
8139 | \layout Standard | |
|
8895 | \end_layout | |
|
8140 | 8896 | |
|
8897 | \begin_layout Standard | |
|
8141 | 8898 | For this reason, if you are using IPython's thread support and have (for |
|
8142 | 8899 | example) a GUI application which will read data generated by files written |
|
8143 | 8900 | to from the IPython thread, the safest approach is to open all of your |
|
8144 | 8901 | files in unbuffered mode (the third argument to the |
|
8145 |
\family typewriter |
|
|
8902 | \family typewriter | |
|
8146 | 8903 | file/open |
|
8147 |
\family default |
|
|
8904 | \family default | |
|
8148 | 8905 | function is the buffering value): |
|
8149 |
\newline |
|
|
8906 | \newline | |
|
8150 | 8907 | |
|
8151 |
\family typewriter |
|
|
8152 | \SpecialChar ~ | |
|
8153 | \SpecialChar ~ | |
|
8908 | \family typewriter | |
|
8909 | \InsetSpace ~ | |
|
8910 | \InsetSpace ~ | |
|
8154 | 8911 | filehandle = open(filename,mode,0) |
|
8155 | \layout Standard | |
|
8912 | \end_layout | |
|
8156 | 8913 | |
|
8914 | \begin_layout Standard | |
|
8157 | 8915 | This is obviously a brute force way of avoiding race conditions with the |
|
8158 | 8916 | file buffering. |
|
8159 | 8917 | If you want to do it cleanly, and you have a resource which is being shared |
|
8160 | 8918 | by the interactive IPython loop and your GUI thread, you should really |
|
8161 | 8919 | handle it with thread locking and syncrhonization properties. |
|
8162 | 8920 | The Python documentation discusses these. |
|
8163 | \layout Section | |
|
8164 | ||
|
8921 | \end_layout | |
|
8165 | 8922 | |
|
8923 | \begin_layout Section | |
|
8166 | 8924 | \begin_inset LatexCommand \label{sec:interactive-demos} |
|
8167 | 8925 | |
|
8168 |
\end_inset |
|
|
8926 | \end_inset | |
|
8169 | 8927 | |
|
8170 | 8928 | Interactive demos with IPython |
|
8171 | \layout Standard | |
|
8929 | \end_layout | |
|
8172 | 8930 | |
|
8931 | \begin_layout Standard | |
|
8173 | 8932 | IPython ships with a basic system for running scripts interactively in sections, |
|
8174 | 8933 | useful when presenting code to audiences. |
|
8175 | 8934 | A few tags embedded in comments (so that the script remains valid Python |
@@ -8178,90 +8937,103 b' IPython ships with a basic system for running scripts interactively in sections,' | |||
|
8178 | 8937 | executing it, and returning to the interactive prompt after each block. |
|
8179 | 8938 | The interactive namespace is updated after each block is run with the contents |
|
8180 | 8939 | of the demo's namespace. |
|
8181 | \layout Standard | |
|
8940 | \end_layout | |
|
8182 | 8941 | |
|
8942 | \begin_layout Standard | |
|
8183 | 8943 | This allows you to show a piece of code, run it and then execute interactively |
|
8184 | 8944 | commands based on the variables just created. |
|
8185 | 8945 | Once you want to continue, you simply execute the next block of the demo. |
|
8186 | 8946 | The following listing shows the markup necessary for dividing a script |
|
8187 | 8947 | into sections for execution as a demo. |
|
8188 | \layout Standard | |
|
8189 | ||
|
8948 | \end_layout | |
|
8190 | 8949 | |
|
8950 | \begin_layout Standard | |
|
8191 | 8951 | \begin_inset ERT |
|
8192 |
status |
|
|
8952 | status open | |
|
8953 | ||
|
8954 | \begin_layout Standard | |
|
8193 | 8955 | |
|
8194 | \layout Standard | |
|
8195 | 8956 | |
|
8196 |
\backslash |
|
|
8957 | \backslash | |
|
8197 | 8958 | codelist{examples/example-demo.py} |
|
8198 | \end_inset | |
|
8959 | \end_layout | |
|
8199 | 8960 | |
|
8961 | \end_inset | |
|
8200 | 8962 | |
|
8201 | \layout Standard | |
|
8202 | 8963 | |
|
8964 | \end_layout | |
|
8965 | ||
|
8966 | \begin_layout Standard | |
|
8203 | 8967 | In order to run a file as a demo, you must first make a |
|
8204 |
\family typewriter |
|
|
8968 | \family typewriter | |
|
8205 | 8969 | Demo |
|
8206 |
\family default |
|
|
8970 | \family default | |
|
8207 | 8971 | object out of it. |
|
8208 | 8972 | If the file is named |
|
8209 |
\family typewriter |
|
|
8973 | \family typewriter | |
|
8210 | 8974 | myscript.py |
|
8211 |
\family default |
|
|
8975 | \family default | |
|
8212 | 8976 | , the following code will make a demo: |
|
8213 | \layout LyX-Code | |
|
8977 | \end_layout | |
|
8214 | 8978 | |
|
8979 | \begin_layout LyX-Code | |
|
8215 | 8980 | from IPython.demo import Demo |
|
8216 | \layout LyX-Code | |
|
8981 | \end_layout | |
|
8217 | 8982 | |
|
8983 | \begin_layout LyX-Code | |
|
8218 | 8984 | mydemo = Demo('myscript.py') |
|
8219 | \layout Standard | |
|
8985 | \end_layout | |
|
8220 | 8986 | |
|
8987 | \begin_layout Standard | |
|
8221 | 8988 | This creates the |
|
8222 |
\family typewriter |
|
|
8989 | \family typewriter | |
|
8223 | 8990 | mydemo |
|
8224 |
\family default |
|
|
8991 | \family default | |
|
8225 | 8992 | object, whose blocks you run one at a time by simply calling the object |
|
8226 | 8993 | with no arguments. |
|
8227 | 8994 | If you have autocall active in IPython (the default), all you need to do |
|
8228 | 8995 | is type |
|
8229 | \layout LyX-Code | |
|
8996 | \end_layout | |
|
8230 | 8997 | |
|
8998 | \begin_layout LyX-Code | |
|
8231 | 8999 | mydemo |
|
8232 | \layout Standard | |
|
9000 | \end_layout | |
|
8233 | 9001 | |
|
9002 | \begin_layout Standard | |
|
8234 | 9003 | and IPython will call it, executing each block. |
|
8235 | 9004 | Demo objects can be restarted, you can move forward or back skipping blocks, |
|
8236 | 9005 | re-execute the last block, etc. |
|
8237 | 9006 | Simply use the Tab key on a demo object to see its methods, and call |
|
8238 |
\family typewriter |
|
|
9007 | \family typewriter | |
|
8239 | 9008 | `?' |
|
8240 |
\family default |
|
|
9009 | \family default | |
|
8241 | 9010 | on them to see their docstrings for more usage details. |
|
8242 | 9011 | In addition, the |
|
8243 |
\family typewriter |
|
|
9012 | \family typewriter | |
|
8244 | 9013 | demo |
|
8245 |
\family default |
|
|
9014 | \family default | |
|
8246 | 9015 | module itself contains a comprehensive docstring, which you can access |
|
8247 | 9016 | via |
|
8248 | \layout LyX-Code | |
|
9017 | \end_layout | |
|
8249 | 9018 | |
|
9019 | \begin_layout LyX-Code | |
|
8250 | 9020 | from IPython import demo |
|
8251 | \layout LyX-Code | |
|
9021 | \end_layout | |
|
8252 | 9022 | |
|
9023 | \begin_layout LyX-Code | |
|
8253 | 9024 | demo? |
|
8254 | \layout Standard | |
|
9025 | \end_layout | |
|
8255 | 9026 | |
|
9027 | \begin_layout Standard | |
|
8256 | 9028 | |
|
8257 |
\series bold |
|
|
9029 | \series bold | |
|
8258 | 9030 | Limitations: |
|
8259 |
\series default |
|
|
9031 | \series default | |
|
8260 | 9032 | It is important to note that these demos are limited to fairly simple uses. |
|
8261 | 9033 | In particular, you can |
|
8262 |
\emph on |
|
|
9034 | \emph on | |
|
8263 | 9035 | not |
|
8264 |
\emph default |
|
|
9036 | \emph default | |
|
8265 | 9037 | put division marks in indented code (loops, if statements, function definitions |
|
8266 | 9038 | , etc.) Supporting something like this would basically require tracking the |
|
8267 | 9039 | internal execution state of the Python interpreter, so only top-level divisions |
@@ -8269,385 +9041,417 b' not' | |||
|
8269 | 9041 | If you want to be able to open an IPython instance at an arbitrary point |
|
8270 | 9042 | in a program, you can use IPython's embedding facilities, described in |
|
8271 | 9043 | detail in Sec\SpecialChar \@. |
|
8272 | \SpecialChar ~ | |
|
9044 | \InsetSpace ~ | |
|
8273 | 9045 | |
|
8274 | 9046 | \begin_inset LatexCommand \ref{sec:embed} |
|
8275 | 9047 | |
|
8276 |
\end_inset |
|
|
9048 | \end_inset | |
|
8277 | 9049 | |
|
8278 | 9050 | . |
|
8279 | \layout Section | |
|
8280 | ||
|
9051 | \end_layout | |
|
8281 | 9052 | |
|
9053 | \begin_layout Section | |
|
8282 | 9054 | \begin_inset LatexCommand \label{sec:matplotlib-support} |
|
8283 | 9055 | |
|
8284 |
\end_inset |
|
|
9056 | \end_inset | |
|
8285 | 9057 | |
|
8286 | 9058 | Plotting with |
|
8287 |
\family typewriter |
|
|
9059 | \family typewriter | |
|
8288 | 9060 | matplotlib |
|
8289 |
\family default |
|
|
9061 | \family default | |
|
8290 | 9062 | |
|
8291 | \layout Standard | |
|
9063 | \end_layout | |
|
8292 | 9064 | |
|
9065 | \begin_layout Standard | |
|
8293 | 9066 | The matplotlib library ( |
|
8294 | 9067 | \begin_inset LatexCommand \htmlurl[http://matplotlib.sourceforge.net]{http://matplotlib.sourceforge.net} |
|
8295 | 9068 | |
|
8296 |
\end_inset |
|
|
9069 | \end_inset | |
|
8297 | 9070 | |
|
8298 | 9071 | ) provides high quality 2D plotting for Python. |
|
8299 | 9072 | Matplotlib can produce plots on screen using a variety of GUI toolkits, |
|
8300 | 9073 | including Tk, GTK and WXPython. |
|
8301 | 9074 | It also provides a number of commands useful for scientific computing, |
|
8302 | 9075 | all with a syntax compatible with that of the popular Matlab program. |
|
8303 | \layout Standard | |
|
9076 | \end_layout | |
|
8304 | 9077 | |
|
9078 | \begin_layout Standard | |
|
8305 | 9079 | IPython accepts the special option |
|
8306 |
\family typewriter |
|
|
9080 | \family typewriter | |
|
8307 | 9081 | -pylab |
|
8308 |
\family default |
|
|
8309 |
(Sec.\ |
|
|
9082 | \family default | |
|
9083 | (Sec.\InsetSpace ~ | |
|
8310 | 9084 | |
|
8311 | 9085 | \begin_inset LatexCommand \ref{sec:cmd-line-opts} |
|
8312 | 9086 | |
|
8313 |
\end_inset |
|
|
9087 | \end_inset | |
|
8314 | 9088 | |
|
8315 | 9089 | ). |
|
8316 | 9090 | This configures it to support matplotlib, honoring the settings in the |
|
8317 | 9091 | |
|
8318 |
\family typewriter |
|
|
9092 | \family typewriter | |
|
8319 | 9093 | .matplotlibrc |
|
8320 |
\family default |
|
|
9094 | \family default | |
|
8321 | 9095 | file. |
|
8322 | 9096 | IPython will detect the user's choice of matplotlib GUI backend, and automatica |
|
8323 | 9097 | lly select the proper threading model to prevent blocking. |
|
8324 | 9098 | It also sets matplotlib in interactive mode and modifies |
|
8325 |
\family typewriter |
|
|
9099 | \family typewriter | |
|
8326 | 9100 | %run |
|
8327 |
\family default |
|
|
9101 | \family default | |
|
8328 | 9102 | slightly, so that any matplotlib-based script can be executed using |
|
8329 |
\family typewriter |
|
|
9103 | \family typewriter | |
|
8330 | 9104 | %run |
|
8331 |
\family default |
|
|
9105 | \family default | |
|
8332 | 9106 | and the final |
|
8333 |
\family typewriter |
|
|
9107 | \family typewriter | |
|
8334 | 9108 | show() |
|
8335 |
\family default |
|
|
9109 | \family default | |
|
8336 | 9110 | command does not block the interactive shell. |
|
8337 | \layout Standard | |
|
9111 | \end_layout | |
|
8338 | 9112 | |
|
9113 | \begin_layout Standard | |
|
8339 | 9114 | The |
|
8340 |
\family typewriter |
|
|
9115 | \family typewriter | |
|
8341 | 9116 | -pylab |
|
8342 |
\family default |
|
|
9117 | \family default | |
|
8343 | 9118 | option must be given first in order for IPython to configure its threading |
|
8344 | 9119 | mode. |
|
8345 | 9120 | However, you can still issue other options afterwards. |
|
8346 | 9121 | This allows you to have a matplotlib-based environment customized with |
|
8347 |
additional modules using the standard IPython profile mechanism (Sec.\ |
|
|
9122 | additional modules using the standard IPython profile mechanism (Sec.\InsetSpace ~ | |
|
8348 | 9123 | |
|
8349 | 9124 | \begin_inset LatexCommand \ref{sec:profiles} |
|
8350 | 9125 | |
|
8351 |
\end_inset |
|
|
9126 | \end_inset | |
|
8352 | 9127 | |
|
8353 | 9128 | ): `` |
|
8354 |
\family typewriter |
|
|
9129 | \family typewriter | |
|
8355 | 9130 | ipython -pylab -p myprofile |
|
8356 |
\family default |
|
|
9131 | \family default | |
|
8357 | 9132 | '' will load the profile defined in |
|
8358 |
\family typewriter |
|
|
9133 | \family typewriter | |
|
8359 | 9134 | ipythonrc-myprofile |
|
8360 |
\family default |
|
|
9135 | \family default | |
|
8361 | 9136 | after configuring matplotlib. |
|
8362 | \layout Section | |
|
8363 | ||
|
9137 | \end_layout | |
|
8364 | 9138 | |
|
9139 | \begin_layout Section | |
|
8365 | 9140 | \begin_inset LatexCommand \label{sec:Gnuplot} |
|
8366 | 9141 | |
|
8367 |
\end_inset |
|
|
9142 | \end_inset | |
|
8368 | 9143 | |
|
8369 | 9144 | Plotting with |
|
8370 |
\family typewriter |
|
|
9145 | \family typewriter | |
|
8371 | 9146 | Gnuplot |
|
8372 | \layout Standard | |
|
9147 | \end_layout | |
|
8373 | 9148 | |
|
9149 | \begin_layout Standard | |
|
8374 | 9150 | Through the magic extension system described in sec. |
|
8375 | 9151 | |
|
8376 | 9152 | \begin_inset LatexCommand \ref{sec:magic} |
|
8377 | 9153 | |
|
8378 |
\end_inset |
|
|
9154 | \end_inset | |
|
8379 | 9155 | |
|
8380 | 9156 | , IPython incorporates a mechanism for conveniently interfacing with the |
|
8381 | 9157 | Gnuplot system ( |
|
8382 | 9158 | \begin_inset LatexCommand \htmlurl{http://www.gnuplot.info} |
|
8383 | 9159 | |
|
8384 |
\end_inset |
|
|
9160 | \end_inset | |
|
8385 | 9161 | |
|
8386 | 9162 | ). |
|
8387 | 9163 | Gnuplot is a very complete 2D and 3D plotting package available for many |
|
8388 | 9164 | operating systems and commonly included in modern Linux distributions. |
|
8389 | 9165 | |
|
8390 | \layout Standard | |
|
9166 | \end_layout | |
|
8391 | 9167 | |
|
9168 | \begin_layout Standard | |
|
8392 | 9169 | Besides having Gnuplot installed, this functionality requires the |
|
8393 |
\family typewriter |
|
|
9170 | \family typewriter | |
|
8394 | 9171 | Gnuplot.py |
|
8395 |
\family default |
|
|
9172 | \family default | |
|
8396 | 9173 | module for interfacing python with Gnuplot. |
|
8397 | 9174 | It can be downloaded from: |
|
8398 | 9175 | \begin_inset LatexCommand \htmlurl{http://gnuplot-py.sourceforge.net} |
|
8399 | 9176 | |
|
8400 |
\end_inset |
|
|
9177 | \end_inset | |
|
8401 | 9178 | |
|
8402 | 9179 | . |
|
8403 | \layout Subsection | |
|
9180 | \end_layout | |
|
8404 | 9181 | |
|
9182 | \begin_layout Subsection | |
|
8405 | 9183 | Proper Gnuplot configuration |
|
8406 | \layout Standard | |
|
9184 | \end_layout | |
|
8407 | 9185 | |
|
9186 | \begin_layout Standard | |
|
8408 | 9187 | As of version 4.0, Gnuplot has excellent mouse and interactive keyboard support. |
|
8409 | 9188 | However, as of |
|
8410 |
\family typewriter |
|
|
9189 | \family typewriter | |
|
8411 | 9190 | Gnuplot.py |
|
8412 |
\family default |
|
|
9191 | \family default | |
|
8413 | 9192 | version 1.7, a new option was added to communicate between Python and Gnuplot |
|
8414 | 9193 | via FIFOs (pipes). |
|
8415 | 9194 | This mechanism, while fast, also breaks the mouse system. |
|
8416 | 9195 | You must therefore set the variable |
|
8417 |
\family typewriter |
|
|
9196 | \family typewriter | |
|
8418 | 9197 | prefer_fifo_data |
|
8419 |
\family default |
|
|
9198 | \family default | |
|
8420 | 9199 | to |
|
8421 |
\family typewriter |
|
|
9200 | \family typewriter | |
|
8422 | 9201 | 0 |
|
8423 |
\family default |
|
|
9202 | \family default | |
|
8424 | 9203 | in file |
|
8425 |
\family typewriter |
|
|
9204 | \family typewriter | |
|
8426 | 9205 | gp_unix.py |
|
8427 |
\family default |
|
|
9206 | \family default | |
|
8428 | 9207 | if you wish to keep the interactive mouse and keyboard features working |
|
8429 | 9208 | properly ( |
|
8430 |
\family typewriter |
|
|
9209 | \family typewriter | |
|
8431 | 9210 | prefer_inline_data |
|
8432 |
\family default |
|
|
9211 | \family default | |
|
8433 | 9212 | also must be |
|
8434 |
\family typewriter |
|
|
9213 | \family typewriter | |
|
8435 | 9214 | 0 |
|
8436 |
\family default |
|
|
9215 | \family default | |
|
8437 | 9216 | , but this is the default so unless you've changed it manually you should |
|
8438 | 9217 | be fine). |
|
8439 | \layout Standard | |
|
9218 | \end_layout | |
|
8440 | 9219 | |
|
9220 | \begin_layout Standard | |
|
8441 | 9221 | 'Out of the box', Gnuplot is configured with a rather poor set of size, |
|
8442 | 9222 | color and linewidth choices which make the graphs fairly hard to read on |
|
8443 | 9223 | modern high-resolution displays (although they work fine on old 640x480 |
|
8444 | 9224 | ones). |
|
8445 | 9225 | Below is a section of my |
|
8446 |
\family typewriter |
|
|
9226 | \family typewriter | |
|
8447 | 9227 | .Xdefaults |
|
8448 |
\family default |
|
|
9228 | \family default | |
|
8449 | 9229 | file which I use for having a more convenient Gnuplot setup. |
|
8450 | 9230 | Remember to load it by running |
|
8451 |
\family typewriter |
|
|
9231 | \family typewriter | |
|
8452 | 9232 | `xrdb .Xdefaults` |
|
8453 |
\family default |
|
|
9233 | \family default | |
|
8454 | 9234 | : |
|
8455 | \layout Standard | |
|
9235 | \end_layout | |
|
8456 | 9236 | |
|
9237 | \begin_layout Standard | |
|
8457 | 9238 | |
|
8458 |
\family typewriter |
|
|
9239 | \family typewriter | |
|
8459 | 9240 | !****************************************************************** |
|
8460 |
\newline |
|
|
8461 |
! gnuplot |
|
|
8462 | \newline | |
|
9241 | \newline | |
|
9242 | ! gnuplot | |
|
9243 | options | |
|
9244 | \newline | |
|
8463 | 9245 | ! modify this for a convenient window size |
|
8464 |
\newline |
|
|
9246 | \newline | |
|
8465 | 9247 | gnuplot*geometry: 780x580 |
|
8466 | \layout Standard | |
|
9248 | \end_layout | |
|
8467 | 9249 | |
|
9250 | \begin_layout Standard | |
|
8468 | 9251 | |
|
8469 |
\family typewriter |
|
|
9252 | \family typewriter | |
|
8470 | 9253 | ! on-screen font (not for PostScript) |
|
8471 |
\newline |
|
|
8472 |
gnuplot*font: -misc-fixed-bold-r-normal--15 |
|
|
8473 | \layout Standard | |
|
9254 | \newline | |
|
9255 | gnuplot*font: -misc-fixed-bold-r-normal--15 | |
|
9256 | -120-100-100-c-90-iso8859-1 | |
|
9257 | \end_layout | |
|
8474 | 9258 | |
|
9259 | \begin_layout Standard | |
|
8475 | 9260 | |
|
8476 |
\family typewriter |
|
|
9261 | \family typewriter | |
|
8477 | 9262 | ! color options |
|
8478 |
\newline |
|
|
9263 | \newline | |
|
8479 | 9264 | gnuplot*background: black |
|
8480 |
\newline |
|
|
9265 | \newline | |
|
8481 | 9266 | gnuplot*textColor: white |
|
8482 |
\newline |
|
|
8483 |
gnuplot*borderCo |
|
|
8484 | \newline | |
|
9267 | \newline | |
|
9268 | gnuplot*borderCo | |
|
9269 | lor: white | |
|
9270 | \newline | |
|
8485 | 9271 | gnuplot*axisColor: white |
|
8486 |
\newline |
|
|
9272 | \newline | |
|
8487 | 9273 | gnuplot*line1Color: red |
|
8488 |
\newline |
|
|
8489 |
gnuplot*line2Color: |
|
|
8490 | \newline | |
|
9274 | \newline | |
|
9275 | gnuplot*line2Color: | |
|
9276 | green | |
|
9277 | \newline | |
|
8491 | 9278 | gnuplot*line3Color: blue |
|
8492 |
\newline |
|
|
9279 | \newline | |
|
8493 | 9280 | gnuplot*line4Color: magenta |
|
8494 |
\newline |
|
|
8495 |
gnuplot*line5Color: |
|
|
8496 | \newline | |
|
9281 | \newline | |
|
9282 | gnuplot*line5Color: | |
|
9283 | cyan | |
|
9284 | \newline | |
|
8497 | 9285 | gnuplot*line6Color: sienna |
|
8498 |
\newline |
|
|
9286 | \newline | |
|
8499 | 9287 | gnuplot*line7Color: orange |
|
8500 |
\newline |
|
|
8501 |
gnuplot*line8Color: |
|
|
8502 | \layout Standard | |
|
9288 | \newline | |
|
9289 | gnuplot*line8Color: | |
|
9290 | coral | |
|
9291 | \end_layout | |
|
8503 | 9292 | |
|
9293 | \begin_layout Standard | |
|
8504 | 9294 | |
|
8505 |
\family typewriter |
|
|
9295 | \family typewriter | |
|
8506 | 9296 | ! multiplicative factor for point styles |
|
8507 |
\newline |
|
|
9297 | \newline | |
|
8508 | 9298 | gnuplot*pointsize: 2 |
|
8509 | \layout Standard | |
|
9299 | \end_layout | |
|
8510 | 9300 | |
|
9301 | \begin_layout Standard | |
|
8511 | 9302 | |
|
8512 |
\family typewriter |
|
|
9303 | \family typewriter | |
|
8513 | 9304 | ! line width options (in pixels) |
|
8514 |
\newline |
|
|
9305 | \newline | |
|
8515 | 9306 | gnuplot*borderWidth: 2 |
|
8516 |
\newline |
|
|
8517 |
gnuplot*axisWidth: |
|
|
8518 | \newline | |
|
9307 | \newline | |
|
9308 | gnuplot*axisWidth: | |
|
9309 | 2 | |
|
9310 | \newline | |
|
8519 | 9311 | gnuplot*line1Width: 2 |
|
8520 |
\newline |
|
|
9312 | \newline | |
|
8521 | 9313 | gnuplot*line2Width: 2 |
|
8522 |
\newline |
|
|
9314 | \newline | |
|
8523 | 9315 | gnuplot*line3Width: 2 |
|
8524 |
\newline |
|
|
8525 |
gnuplot*line4Wi |
|
|
8526 | \newline | |
|
9316 | \newline | |
|
9317 | gnuplot*line4Wi | |
|
9318 | dth: 2 | |
|
9319 | \newline | |
|
8527 | 9320 | gnuplot*line5Width: 2 |
|
8528 |
\newline |
|
|
9321 | \newline | |
|
8529 | 9322 | gnuplot*line6Width: 2 |
|
8530 |
\newline |
|
|
9323 | \newline | |
|
8531 | 9324 | gnuplot*line7Width: 2 |
|
8532 |
\newline |
|
|
8533 |
gnuplot*lin |
|
|
8534 | \layout Subsection | |
|
9325 | \newline | |
|
9326 | gnuplot*lin | |
|
9327 | e8Width: 2 | |
|
9328 | \end_layout | |
|
8535 | 9329 | |
|
9330 | \begin_layout Subsection | |
|
8536 | 9331 | The |
|
8537 |
\family typewriter |
|
|
9332 | \family typewriter | |
|
8538 | 9333 | IPython.GnuplotRuntime |
|
8539 |
\family default |
|
|
9334 | \family default | |
|
8540 | 9335 | module |
|
8541 | \layout Standard | |
|
9336 | \end_layout | |
|
8542 | 9337 | |
|
9338 | \begin_layout Standard | |
|
8543 | 9339 | IPython includes a module called |
|
8544 |
\family typewriter |
|
|
9340 | \family typewriter | |
|
8545 | 9341 | Gnuplot2.py |
|
8546 |
\family default |
|
|
9342 | \family default | |
|
8547 | 9343 | which extends and improves the default |
|
8548 |
\family typewriter |
|
|
9344 | \family typewriter | |
|
8549 | 9345 | Gnuplot |
|
8550 |
\family default |
|
|
9346 | \family default | |
|
8551 | 9347 | . |
|
8552 |
\family typewriter |
|
|
9348 | \family typewriter | |
|
8553 | 9349 | py |
|
8554 |
\family default |
|
|
9350 | \family default | |
|
8555 | 9351 | (which it still relies upon). |
|
8556 | 9352 | For example, the new |
|
8557 |
\family typewriter |
|
|
9353 | \family typewriter | |
|
8558 | 9354 | plot |
|
8559 |
\family default |
|
|
9355 | \family default | |
|
8560 | 9356 | function adds several improvements to the original making it more convenient |
|
8561 | 9357 | for interactive use, and |
|
8562 |
\family typewriter |
|
|
9358 | \family typewriter | |
|
8563 | 9359 | hardcopy |
|
8564 |
\family default |
|
|
9360 | \family default | |
|
8565 | 9361 | fixes a bug in the original which under some circumstances blocks the creation |
|
8566 | 9362 | of PostScript output. |
|
8567 | \layout Standard | |
|
9363 | \end_layout | |
|
8568 | 9364 | |
|
9365 | \begin_layout Standard | |
|
8569 | 9366 | For scripting use, |
|
8570 |
\family typewriter |
|
|
9367 | \family typewriter | |
|
8571 | 9368 | GnuplotRuntime.py |
|
8572 |
\family default |
|
|
9369 | \family default | |
|
8573 | 9370 | is provided, which wraps |
|
8574 |
\family typewriter |
|
|
9371 | \family typewriter | |
|
8575 | 9372 | Gnuplot2.py |
|
8576 |
\family default |
|
|
9373 | \family default | |
|
8577 | 9374 | and creates a series of global aliases. |
|
8578 | 9375 | These make it easy to control Gnuplot plotting jobs through the Python |
|
8579 | 9376 | language. |
|
8580 | \layout Standard | |
|
9377 | \end_layout | |
|
8581 | 9378 | |
|
9379 | \begin_layout Standard | |
|
8582 | 9380 | Below is some example code which illustrates how to configure Gnuplot inside |
|
8583 | 9381 | your own programs but have it available for further interactive use through |
|
8584 | 9382 | an embedded IPython instance. |
|
8585 | 9383 | Simply run this file at a system prompt. |
|
8586 | 9384 | This file is provided as |
|
8587 |
\family typewriter |
|
|
9385 | \family typewriter | |
|
8588 | 9386 | example-gnuplot.py |
|
8589 |
\family default |
|
|
9387 | \family default | |
|
8590 | 9388 | in the examples directory: |
|
8591 | \layout Standard | |
|
8592 | ||
|
9389 | \end_layout | |
|
8593 | 9390 | |
|
9391 | \begin_layout Standard | |
|
8594 | 9392 | \begin_inset ERT |
|
8595 |
status |
|
|
9393 | status open | |
|
9394 | ||
|
9395 | \begin_layout Standard | |
|
8596 | 9396 | |
|
8597 | \layout Standard | |
|
8598 | 9397 | |
|
8599 |
\backslash |
|
|
9398 | \backslash | |
|
8600 | 9399 | codelist{examples/example-gnuplot.py} |
|
8601 | \end_inset | |
|
9400 | \end_layout | |
|
8602 | 9401 | |
|
9402 | \end_inset | |
|
8603 | 9403 | |
|
8604 | \layout Subsection | |
|
8605 | 9404 | |
|
9405 | \end_layout | |
|
9406 | ||
|
9407 | \begin_layout Subsection | |
|
8606 | 9408 | The |
|
8607 |
\family typewriter |
|
|
9409 | \family typewriter | |
|
8608 | 9410 | numeric |
|
8609 |
\family default |
|
|
9411 | \family default | |
|
8610 | 9412 | profile: a scientific computing environment |
|
8611 | \layout Standard | |
|
9413 | \end_layout | |
|
8612 | 9414 | |
|
9415 | \begin_layout Standard | |
|
8613 | 9416 | The |
|
8614 |
\family typewriter |
|
|
9417 | \family typewriter | |
|
8615 | 9418 | numeric |
|
8616 |
\family default |
|
|
9419 | \family default | |
|
8617 | 9420 | IPython profile, which you can activate with |
|
8618 |
\family typewriter |
|
|
9421 | \family typewriter | |
|
8619 | 9422 | `ipython -p numeric |
|
8620 |
\family default |
|
|
9423 | \family default | |
|
8621 | 9424 | ' will automatically load the IPython Gnuplot extensions (plus Numeric and |
|
8622 | 9425 | other useful things for numerical computing), contained in the |
|
8623 |
\family typewriter |
|
|
9426 | \family typewriter | |
|
8624 | 9427 | IPython.GnuplotInteractive |
|
8625 |
\family default |
|
|
9428 | \family default | |
|
8626 | 9429 | module. |
|
8627 | 9430 | This will create the globals |
|
8628 |
\family typewriter |
|
|
9431 | \family typewriter | |
|
8629 | 9432 | Gnuplot |
|
8630 |
\family default |
|
|
9433 | \family default | |
|
8631 | 9434 | (an alias to the improved Gnuplot2 module), |
|
8632 |
\family typewriter |
|
|
9435 | \family typewriter | |
|
8633 | 9436 | gp |
|
8634 |
\family default |
|
|
9437 | \family default | |
|
8635 | 9438 | (a Gnuplot active instance), the new magic commands |
|
8636 |
\family typewriter |
|
|
9439 | \family typewriter | |
|
8637 | 9440 | %gpc |
|
8638 |
\family default |
|
|
9441 | \family default | |
|
8639 | 9442 | and |
|
8640 |
\family typewriter |
|
|
9443 | \family typewriter | |
|
8641 | 9444 | %gp_set_instance |
|
8642 |
\family default |
|
|
9445 | \family default | |
|
8643 | 9446 | and several other convenient globals. |
|
8644 | 9447 | Type |
|
8645 |
\family typewriter |
|
|
9448 | \family typewriter | |
|
8646 | 9449 | gphelp() |
|
8647 |
\family default |
|
|
9450 | \family default | |
|
8648 | 9451 | for further details. |
|
8649 | \layout Standard | |
|
9452 | \end_layout | |
|
8650 | 9453 | |
|
9454 | \begin_layout Standard | |
|
8651 | 9455 | This should turn IPython into a convenient environment for numerical computing, |
|
8652 | 9456 | with all the functions in the NumPy library and the Gnuplot facilities |
|
8653 | 9457 | for plotting. |
@@ -8655,44 +9459,49 b' This should turn IPython into a convenient environment for numerical computing,' | |||
|
8655 | 9459 | scientific computing, available at |
|
8656 | 9460 | \begin_inset LatexCommand \htmlurl{http://scipy.org} |
|
8657 | 9461 | |
|
8658 |
\end_inset |
|
|
9462 | \end_inset | |
|
8659 | 9463 | |
|
8660 | 9464 | . |
|
8661 | \layout Standard | |
|
9465 | \end_layout | |
|
8662 | 9466 | |
|
9467 | \begin_layout Standard | |
|
8663 | 9468 | If you are in the middle of a working session with numerical objects and |
|
8664 | 9469 | need to plot them but you didn't start the |
|
8665 |
\family typewriter |
|
|
9470 | \family typewriter | |
|
8666 | 9471 | numeric |
|
8667 |
\family default |
|
|
9472 | \family default | |
|
8668 | 9473 | profile, you can load these extensions at any time by typing |
|
8669 |
\newline |
|
|
9474 | \newline | |
|
8670 | 9475 | |
|
8671 |
\family typewriter |
|
|
9476 | \family typewriter | |
|
8672 | 9477 | from IPython.GnuplotInteractive import * |
|
8673 |
\newline |
|
|
9478 | \newline | |
|
8674 | 9479 | |
|
8675 |
\family default |
|
|
9480 | \family default | |
|
8676 | 9481 | at the IPython prompt. |
|
8677 | 9482 | This will allow you to keep your objects intact and start using Gnuplot |
|
8678 | 9483 | to view them. |
|
8679 | \layout Section | |
|
9484 | \end_layout | |
|
8680 | 9485 | |
|
9486 | \begin_layout Section | |
|
8681 | 9487 | Reporting bugs |
|
8682 | \layout Subsection* | |
|
9488 | \end_layout | |
|
8683 | 9489 | |
|
9490 | \begin_layout Subsection* | |
|
8684 | 9491 | Automatic crash reports |
|
8685 | \layout Standard | |
|
9492 | \end_layout | |
|
8686 | 9493 | |
|
9494 | \begin_layout Standard | |
|
8687 | 9495 | Ideally, IPython itself shouldn't crash. |
|
8688 | 9496 | It will catch exceptions produced by you, but bugs in its internals will |
|
8689 | 9497 | still crash it. |
|
8690 | \layout Standard | |
|
9498 | \end_layout | |
|
8691 | 9499 | |
|
9500 | \begin_layout Standard | |
|
8692 | 9501 | In such a situation, IPython will leave a file named |
|
8693 |
\family typewriter |
|
|
9502 | \family typewriter | |
|
8694 | 9503 | IPython_crash_report.txt |
|
8695 |
\family default |
|
|
9504 | \family default | |
|
8696 | 9505 | in your IPYTHONDIR directory (that way if crashes happen several times |
|
8697 | 9506 | it won't litter many directories, the post-mortem file is always located |
|
8698 | 9507 | in the same place and new occurrences just overwrite the previous one). |
@@ -8700,86 +9509,99 b' IPython_crash_report.txt' | |||
|
8700 | 9509 | |
|
8701 | 9510 | \begin_inset LatexCommand \ref{sec:credits} |
|
8702 | 9511 | |
|
8703 |
\end_inset |
|
|
9512 | \end_inset | |
|
8704 | 9513 | |
|
8705 | 9514 | for names and addresses), it will help us |
|
8706 |
\emph on |
|
|
9515 | \emph on | |
|
8707 | 9516 | a lot |
|
8708 |
\emph default |
|
|
9517 | \emph default | |
|
8709 | 9518 | in understanding the cause of the problem and fixing it sooner. |
|
8710 | \layout Subsection* | |
|
9519 | \end_layout | |
|
8711 | 9520 | |
|
9521 | \begin_layout Subsection* | |
|
8712 | 9522 | The bug tracker |
|
8713 | \layout Standard | |
|
9523 | \end_layout | |
|
8714 | 9524 | |
|
9525 | \begin_layout Standard | |
|
8715 | 9526 | IPython also has an online bug-tracker, located at |
|
8716 | 9527 | \begin_inset LatexCommand \htmlurl{http://projects.scipy.org/ipython/ipython/report/1} |
|
8717 | 9528 | |
|
8718 |
\end_inset |
|
|
9529 | \end_inset | |
|
8719 | 9530 | |
|
8720 | 9531 | . |
|
8721 | 9532 | In addition to mailing the developers, it would be a good idea to file |
|
8722 | 9533 | a bug report here. |
|
8723 | 9534 | This will ensure that the issue is properly followed to conclusion. |
|
8724 | 9535 | To report new bugs you will have to register first. |
|
8725 | \layout Standard | |
|
9536 | \end_layout | |
|
8726 | 9537 | |
|
9538 | \begin_layout Standard | |
|
8727 | 9539 | You can also use this bug tracker to file feature requests. |
|
8728 | \layout Section | |
|
9540 | \end_layout | |
|
8729 | 9541 | |
|
9542 | \begin_layout Section | |
|
8730 | 9543 | Brief history |
|
8731 | \layout Subsection | |
|
9544 | \end_layout | |
|
8732 | 9545 | |
|
9546 | \begin_layout Subsection | |
|
8733 | 9547 | Origins |
|
8734 | \layout Standard | |
|
9548 | \end_layout | |
|
8735 | 9549 | |
|
9550 | \begin_layout Standard | |
|
8736 | 9551 | The current IPython system grew out of the following three projects: |
|
8737 |
\layou |
|
|
8738 | \labelwidthstring 00.00.0000 | |
|
9552 | \end_layout | |
|
8739 | 9553 | |
|
9554 | \begin_layout List | |
|
9555 | \labelwidthstring 00.00.0000 | |
|
8740 | 9556 | ipython by Fernando P |
|
8741 | 9557 | \begin_inset ERT |
|
8742 |
status |
|
|
9558 | status collapsed | |
|
9559 | ||
|
9560 | \begin_layout Standard | |
|
8743 | 9561 | |
|
8744 | \layout Standard | |
|
8745 | 9562 | |
|
8746 |
\backslash |
|
|
9563 | \backslash | |
|
8747 | 9564 | '{e} |
|
8748 | \end_inset | |
|
9565 | \end_layout | |
|
9566 | ||
|
9567 | \end_inset | |
|
8749 | 9568 | |
|
8750 | 9569 | rez. |
|
8751 | 9570 | I was working on adding Mathematica-type prompts and a flexible configuration |
|
8752 | 9571 | system (something better than |
|
8753 |
\family typewriter |
|
|
9572 | \family typewriter | |
|
8754 | 9573 | $PYTHONSTARTUP |
|
8755 |
\family default |
|
|
9574 | \family default | |
|
8756 | 9575 | ) to the standard Python interactive interpreter. |
|
8757 |
\layou |
|
|
8758 | \labelwidthstring 00.00.0000 | |
|
9576 | \end_layout | |
|
8759 | 9577 | |
|
9578 | \begin_layout List | |
|
9579 | \labelwidthstring 00.00.0000 | |
|
8760 | 9580 | IPP by Janko Hauser. |
|
8761 | 9581 | Very well organized, great usability. |
|
8762 | 9582 | Had an old help system. |
|
8763 | 9583 | IPP was used as the `container' code into which I added the functionality |
|
8764 | 9584 | from ipython and LazyPython. |
|
8765 |
\layou |
|
|
8766 | \labelwidthstring 00.00.0000 | |
|
9585 | \end_layout | |
|
8767 | 9586 | |
|
9587 | \begin_layout List | |
|
9588 | \labelwidthstring 00.00.0000 | |
|
8768 | 9589 | LazyPython by Nathan Gray. |
|
8769 | 9590 | Simple but |
|
8770 |
\emph on |
|
|
9591 | \emph on | |
|
8771 | 9592 | very |
|
8772 |
\emph default |
|
|
9593 | \emph default | |
|
8773 | 9594 | powerful. |
|
8774 | 9595 | The quick syntax (auto parens, auto quotes) and verbose/colored tracebacks |
|
8775 | 9596 | were all taken from here. |
|
8776 | \layout Standard | |
|
9597 | \end_layout | |
|
8777 | 9598 | |
|
9599 | \begin_layout Standard | |
|
8778 | 9600 | When I found out (see sec. |
|
8779 | 9601 | |
|
8780 | 9602 | \begin_inset LatexCommand \ref{figgins} |
|
8781 | 9603 | |
|
8782 |
\end_inset |
|
|
9604 | \end_inset | |
|
8783 | 9605 | |
|
8784 | 9606 | ) about IPP and LazyPython I tried to join all three into a unified system. |
|
8785 | 9607 | I thought this could provide a very nice working environment, both for |
@@ -8788,17 +9610,20 b' When I found out (see sec.' | |||
|
8788 | 9610 | and help facilities. |
|
8789 | 9611 | I think it worked reasonably well, though it was a lot more work than I |
|
8790 | 9612 | had initially planned. |
|
8791 | \layout Subsection | |
|
9613 | \end_layout | |
|
8792 | 9614 | |
|
9615 | \begin_layout Subsection | |
|
8793 | 9616 | Current status |
|
8794 | \layout Standard | |
|
9617 | \end_layout | |
|
8795 | 9618 | |
|
9619 | \begin_layout Standard | |
|
8796 | 9620 | The above listed features work, and quite well for the most part. |
|
8797 | 9621 | But until a major internal restructuring is done (see below), only bug |
|
8798 | 9622 | fixing will be done, no other features will be added (unless very minor |
|
8799 | 9623 | and well localized in the cleaner parts of the code). |
|
8800 | \layout Standard | |
|
9624 | \end_layout | |
|
8801 | 9625 | |
|
9626 | \begin_layout Standard | |
|
8802 | 9627 | IPython consists of some 18000 lines of pure python code, of which roughly |
|
8803 | 9628 | two thirds is reasonably clean. |
|
8804 | 9629 | The rest is, messy code which needs a massive restructuring before any |
@@ -8806,98 +9631,112 b' IPython consists of some 18000 lines of pure python code, of which roughly' | |||
|
8806 | 9631 | Even the messy code is fairly well documented though, and most of the problems |
|
8807 | 9632 | in the (non-existent) class design are well pointed to by a PyChecker run. |
|
8808 | 9633 | So the rewriting work isn't that bad, it will just be time-consuming. |
|
8809 | \layout Subsection | |
|
9634 | \end_layout | |
|
8810 | 9635 | |
|
9636 | \begin_layout Subsection | |
|
8811 | 9637 | Future |
|
8812 | \layout Standard | |
|
9638 | \end_layout | |
|
8813 | 9639 | |
|
9640 | \begin_layout Standard | |
|
8814 | 9641 | See the separate |
|
8815 |
\family typewriter |
|
|
9642 | \family typewriter | |
|
8816 | 9643 | new_design |
|
8817 |
\family default |
|
|
9644 | \family default | |
|
8818 | 9645 | document for details. |
|
8819 | 9646 | Ultimately, I would like to see IPython become part of the standard Python |
|
8820 | 9647 | distribution as a `big brother with batteries' to the standard Python interacti |
|
8821 | 9648 | ve interpreter. |
|
8822 | 9649 | But that will never happen with the current state of the code, so all contribut |
|
8823 | 9650 | ions are welcome. |
|
8824 | \layout Section | |
|
9651 | \end_layout | |
|
8825 | 9652 | |
|
9653 | \begin_layout Section | |
|
8826 | 9654 | License |
|
8827 | \layout Standard | |
|
9655 | \end_layout | |
|
8828 | 9656 | |
|
9657 | \begin_layout Standard | |
|
8829 | 9658 | IPython is released under the terms of the BSD license, whose general form |
|
8830 | 9659 | can be found at: |
|
8831 | 9660 | \begin_inset LatexCommand \htmlurl{http://www.opensource.org/licenses/bsd-license.php} |
|
8832 | 9661 | |
|
8833 |
\end_inset |
|
|
9662 | \end_inset | |
|
8834 | 9663 | |
|
8835 | 9664 | . |
|
8836 | 9665 | The full text of the IPython license is reproduced below: |
|
8837 |
\layout |
|
|
9666 | \end_layout | |
|
8838 | 9667 | |
|
9668 | \begin_layout Quote | |
|
8839 | 9669 | |
|
8840 |
\family typewriter |
|
|
8841 |
\size small |
|
|
9670 | \family typewriter | |
|
9671 | \size small | |
|
8842 | 9672 | IPython is released under a BSD-type license. |
|
8843 |
\layout |
|
|
9673 | \end_layout | |
|
8844 | 9674 | |
|
9675 | \begin_layout Quote | |
|
8845 | 9676 | |
|
8846 |
\family typewriter |
|
|
8847 |
\size small |
|
|
9677 | \family typewriter | |
|
9678 | \size small | |
|
8848 | 9679 | Copyright (c) 2001, 2002, 2003, 2004 Fernando Perez <fperez@colorado.edu>. |
|
8849 |
\layout |
|
|
9680 | \end_layout | |
|
8850 | 9681 | |
|
9682 | \begin_layout Quote | |
|
8851 | 9683 | |
|
8852 |
\family typewriter |
|
|
8853 |
\size small |
|
|
9684 | \family typewriter | |
|
9685 | \size small | |
|
8854 | 9686 | Copyright (c) 2001 Janko Hauser <jhauser@zscout.de> and |
|
8855 |
\newline |
|
|
8856 |
Nathaniel Gray <n8gray@ca |
|
|
8857 | \layout Quote | |
|
9687 | \newline | |
|
9688 | Nathaniel Gray <n8gray@ca | |
|
9689 | ltech.edu>. | |
|
9690 | \end_layout | |
|
8858 | 9691 | |
|
9692 | \begin_layout Quote | |
|
8859 | 9693 | |
|
8860 |
\family typewriter |
|
|
8861 |
\size small |
|
|
9694 | \family typewriter | |
|
9695 | \size small | |
|
8862 | 9696 | All rights reserved. |
|
8863 |
\layout |
|
|
9697 | \end_layout | |
|
8864 | 9698 | |
|
9699 | \begin_layout Quote | |
|
8865 | 9700 | |
|
8866 |
\family typewriter |
|
|
8867 |
\size small |
|
|
9701 | \family typewriter | |
|
9702 | \size small | |
|
8868 | 9703 | Redistribution and use in source and binary forms, with or without modification, |
|
8869 | 9704 | are permitted provided that the following conditions are met: |
|
8870 |
\layout |
|
|
9705 | \end_layout | |
|
8871 | 9706 | |
|
9707 | \begin_layout Quote | |
|
8872 | 9708 | |
|
8873 |
\family typewriter |
|
|
8874 |
\size small |
|
|
9709 | \family typewriter | |
|
9710 | \size small | |
|
8875 | 9711 | a. |
|
8876 | 9712 | Redistributions of source code must retain the above copyright notice, |
|
8877 | 9713 | this list of conditions and the following disclaimer. |
|
8878 |
\layout |
|
|
9714 | \end_layout | |
|
8879 | 9715 | |
|
9716 | \begin_layout Quote | |
|
8880 | 9717 | |
|
8881 |
\family typewriter |
|
|
8882 |
\size small |
|
|
9718 | \family typewriter | |
|
9719 | \size small | |
|
8883 | 9720 | b. |
|
8884 | 9721 | Redistributions in binary form must reproduce the above copyright notice, |
|
8885 | 9722 | this list of conditions and the following disclaimer in the documentation |
|
8886 | 9723 | and/or other materials provided with the distribution. |
|
8887 |
\layout |
|
|
9724 | \end_layout | |
|
8888 | 9725 | |
|
9726 | \begin_layout Quote | |
|
8889 | 9727 | |
|
8890 |
\family typewriter |
|
|
8891 |
\size small |
|
|
9728 | \family typewriter | |
|
9729 | \size small | |
|
8892 | 9730 | c. |
|
8893 | 9731 | Neither the name of the copyright holders nor the names of any contributors |
|
8894 | 9732 | to this software may be used to endorse or promote products derived from |
|
8895 | 9733 | this software without specific prior written permission. |
|
8896 |
\layout |
|
|
9734 | \end_layout | |
|
8897 | 9735 | |
|
9736 | \begin_layout Quote | |
|
8898 | 9737 | |
|
8899 |
\family typewriter |
|
|
8900 |
\size small |
|
|
9738 | \family typewriter | |
|
9739 | \size small | |
|
8901 | 9740 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS |
|
8902 | 9741 | IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, |
|
8903 | 9742 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
@@ -8910,640 +9749,712 b' THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS' | |||
|
8910 | 9749 | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
|
8911 | 9750 | THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
|
8912 | 9751 | |
|
8913 | \layout Standard | |
|
9752 | \end_layout | |
|
8914 | 9753 | |
|
9754 | \begin_layout Standard | |
|
8915 | 9755 | Individual authors are the holders of the copyright for their code and are |
|
8916 | 9756 | listed in each file. |
|
8917 | \layout Standard | |
|
9757 | \end_layout | |
|
8918 | 9758 | |
|
9759 | \begin_layout Standard | |
|
8919 | 9760 | Some files ( |
|
8920 |
\family typewriter |
|
|
9761 | \family typewriter | |
|
8921 | 9762 | DPyGetOpt.py |
|
8922 |
\family default |
|
|
9763 | \family default | |
|
8923 | 9764 | , for example) may be licensed under different conditions. |
|
8924 | 9765 | Ultimately each file indicates clearly the conditions under which its author/au |
|
8925 | 9766 | thors have decided to publish the code. |
|
8926 | \layout Standard | |
|
9767 | \end_layout | |
|
8927 | 9768 | |
|
9769 | \begin_layout Standard | |
|
8928 | 9770 | Versions of IPython up to and including 0.6.3 were released under the GNU |
|
8929 | 9771 | Lesser General Public License (LGPL), available at |
|
8930 | 9772 | \begin_inset LatexCommand \htmlurl{http://www.gnu.org/copyleft/lesser.html} |
|
8931 | 9773 | |
|
8932 |
\end_inset |
|
|
9774 | \end_inset | |
|
8933 | 9775 | |
|
8934 | 9776 | . |
|
8935 | \layout Section | |
|
8936 | ||
|
9777 | \end_layout | |
|
8937 | 9778 | |
|
9779 | \begin_layout Section | |
|
8938 | 9780 | \begin_inset LatexCommand \label{sec:credits} |
|
8939 | 9781 | |
|
8940 |
\end_inset |
|
|
9782 | \end_inset | |
|
8941 | 9783 | |
|
8942 | 9784 | Credits |
|
8943 | \layout Standard | |
|
9785 | \end_layout | |
|
8944 | 9786 | |
|
9787 | \begin_layout Standard | |
|
8945 | 9788 | IPython is mainly developed by Fernando P |
|
8946 | 9789 | \begin_inset ERT |
|
8947 |
status |
|
|
9790 | status collapsed | |
|
9791 | ||
|
9792 | \begin_layout Standard | |
|
8948 | 9793 | |
|
8949 | \layout Standard | |
|
8950 | 9794 | |
|
8951 |
\backslash |
|
|
9795 | \backslash | |
|
8952 | 9796 | '{e} |
|
8953 | \end_inset | |
|
9797 | \end_layout | |
|
9798 | ||
|
9799 | \end_inset | |
|
8954 | 9800 | |
|
8955 | 9801 | rez |
|
8956 |
\family typewriter |
|
|
9802 | \family typewriter | |
|
8957 | 9803 | <Fernando.Perez@colorado.edu> |
|
8958 |
\family default |
|
|
9804 | \family default | |
|
8959 | 9805 | , but the project was born from mixing in Fernando's code with the IPP project |
|
8960 | 9806 | by Janko Hauser |
|
8961 |
\family typewriter |
|
|
9807 | \family typewriter | |
|
8962 | 9808 | <jhauser-AT-zscout.de> |
|
8963 |
\family default |
|
|
9809 | \family default | |
|
8964 | 9810 | and LazyPython by Nathan Gray |
|
8965 |
\family typewriter |
|
|
9811 | \family typewriter | |
|
8966 | 9812 | <n8gray-AT-caltech.edu> |
|
8967 |
\family default |
|
|
9813 | \family default | |
|
8968 | 9814 | . |
|
8969 | 9815 | For all IPython-related requests, please contact Fernando. |
|
8970 | 9816 | |
|
8971 | \layout Standard | |
|
9817 | \end_layout | |
|
8972 | 9818 | |
|
9819 | \begin_layout Standard | |
|
8973 | 9820 | As of early 2006, the following developers have joined the core team: |
|
8974 |
\layou |
|
|
8975 | \labelwidthstring 00.00.0000 | |
|
9821 | \end_layout | |
|
8976 | 9822 | |
|
8977 | Robert\SpecialChar ~ | |
|
9823 | \begin_layout List | |
|
9824 | \labelwidthstring 00.00.0000 | |
|
9825 | Robert\InsetSpace ~ | |
|
8978 | 9826 | Kern |
|
8979 |
\family typewriter |
|
|
9827 | \family typewriter | |
|
8980 | 9828 | <rkern-AT-enthought.com> |
|
8981 |
\family default |
|
|
9829 | \family default | |
|
8982 | 9830 | : co-mentored the 2005 Google Summer of Code project to develop python interacti |
|
8983 | 9831 | ve notebooks (XML documents) and graphical interface. |
|
8984 | 9832 | This project was awarded to the students Tzanko Matev |
|
8985 |
\family typewriter |
|
|
9833 | \family typewriter | |
|
8986 | 9834 | <tsanko-AT-gmail.com> |
|
8987 |
\family default |
|
|
9835 | \family default | |
|
8988 | 9836 | and Toni Alatalo |
|
8989 |
\family typewriter |
|
|
9837 | \family typewriter | |
|
8990 | 9838 | <antont-AT-an.org> |
|
8991 |
\layou |
|
|
8992 | \labelwidthstring 00.00.0000 | |
|
9839 | \end_layout | |
|
8993 | 9840 | |
|
8994 | Brian\SpecialChar ~ | |
|
9841 | \begin_layout List | |
|
9842 | \labelwidthstring 00.00.0000 | |
|
9843 | Brian\InsetSpace ~ | |
|
8995 | 9844 | Granger |
|
8996 |
\family typewriter |
|
|
9845 | \family typewriter | |
|
8997 | 9846 | <bgranger-AT-scu.edu> |
|
8998 |
\family default |
|
|
9847 | \family default | |
|
8999 | 9848 | : extending IPython to allow support for interactive parallel computing. |
|
9000 |
\layou |
|
|
9001 | \labelwidthstring 00.00.0000 | |
|
9849 | \end_layout | |
|
9002 | 9850 | |
|
9003 | Ville\SpecialChar ~ | |
|
9851 | \begin_layout List | |
|
9852 | \labelwidthstring 00.00.0000 | |
|
9853 | Ville\InsetSpace ~ | |
|
9004 | 9854 | Vainio |
|
9005 |
\family typewriter |
|
|
9855 | \family typewriter | |
|
9006 | 9856 | <vivainio-AT-gmail.com> |
|
9007 |
\family default |
|
|
9857 | \family default | |
|
9008 | 9858 | : Ville is the new maintainer for the main trunk of IPython after version |
|
9009 | 9859 | 0.7.1. |
|
9010 | \layout Standard | |
|
9860 | \end_layout | |
|
9011 | 9861 | |
|
9862 | \begin_layout Standard | |
|
9012 | 9863 | User or development help should be requested via the IPython mailing lists: |
|
9013 | \layout Description | |
|
9864 | \end_layout | |
|
9014 | 9865 | |
|
9015 | User\SpecialChar ~ | |
|
9866 | \begin_layout Description | |
|
9867 | User\InsetSpace ~ | |
|
9016 | 9868 | list: |
|
9017 | 9869 | \begin_inset LatexCommand \htmlurl{http://scipy.net/mailman/listinfo/ipython-user} |
|
9018 | 9870 | |
|
9019 |
\end_inset |
|
|
9871 | \end_inset | |
|
9020 | 9872 | |
|
9021 | 9873 | |
|
9022 | \layout Description | |
|
9874 | \end_layout | |
|
9023 | 9875 | |
|
9024 | Developer's\SpecialChar ~ | |
|
9876 | \begin_layout Description | |
|
9877 | Developer's\InsetSpace ~ | |
|
9025 | 9878 | list: |
|
9026 | 9879 | \begin_inset LatexCommand \htmlurl{http://scipy.net/mailman/listinfo/ipython-dev} |
|
9027 | 9880 | |
|
9028 |
\end_inset |
|
|
9881 | \end_inset | |
|
9029 | 9882 | |
|
9030 | 9883 | |
|
9031 | \layout Standard | |
|
9884 | \end_layout | |
|
9032 | 9885 | |
|
9886 | \begin_layout Standard | |
|
9033 | 9887 | The IPython project is also very grateful to |
|
9034 | 9888 | \begin_inset Foot |
|
9035 |
collapsed |
|
|
9036 | ||
|
9037 | \layout Standard | |
|
9889 | status collapsed | |
|
9038 | 9890 | |
|
9891 | \begin_layout Standard | |
|
9039 | 9892 | I've mangled email addresses to reduce spam, since the IPython manuals can |
|
9040 | 9893 | be accessed online. |
|
9041 | \end_inset | |
|
9894 | \end_layout | |
|
9895 | ||
|
9896 | \end_inset | |
|
9042 | 9897 | |
|
9043 | 9898 | : |
|
9044 | \layout Standard | |
|
9899 | \end_layout | |
|
9045 | 9900 | |
|
9901 | \begin_layout Standard | |
|
9046 | 9902 | Bill Bumgarner |
|
9047 |
\family typewriter |
|
|
9903 | \family typewriter | |
|
9048 | 9904 | <bbum-AT-friday.com> |
|
9049 |
\family default |
|
|
9905 | \family default | |
|
9050 | 9906 | : for providing the DPyGetOpt module which gives very powerful and convenient |
|
9051 | 9907 | handling of command-line options (light years ahead of what Python 2.1.1's |
|
9052 | 9908 | getopt module does). |
|
9053 | \layout Standard | |
|
9909 | \end_layout | |
|
9054 | 9910 | |
|
9911 | \begin_layout Standard | |
|
9055 | 9912 | Ka-Ping Yee |
|
9056 |
\family typewriter |
|
|
9913 | \family typewriter | |
|
9057 | 9914 | <ping-AT-lfw.org> |
|
9058 |
\family default |
|
|
9915 | \family default | |
|
9059 | 9916 | : for providing the Itpl module for convenient and powerful string interpolation |
|
9060 | 9917 | with a much nicer syntax than formatting through the '%' operator. |
|
9061 | \layout Standard | |
|
9918 | \end_layout | |
|
9062 | 9919 | |
|
9920 | \begin_layout Standard | |
|
9063 | 9921 | Arnd Baecker |
|
9064 |
\family typewriter |
|
|
9922 | \family typewriter | |
|
9065 | 9923 | <baecker-AT-physik.tu-dresden.de> |
|
9066 |
\family default |
|
|
9924 | \family default | |
|
9067 | 9925 | : for his many very useful suggestions and comments, and lots of help with |
|
9068 | 9926 | testing and documentation checking. |
|
9069 | 9927 | Many of IPython's newer features are a result of discussions with him (bugs |
|
9070 | 9928 | are still my fault, not his). |
|
9071 | \layout Standard | |
|
9929 | \end_layout | |
|
9072 | 9930 | |
|
9073 | Obviously Guido van\SpecialChar ~ | |
|
9931 | \begin_layout Standard | |
|
9932 | Obviously Guido van\InsetSpace ~ | |
|
9074 | 9933 | Rossum and the whole Python development team, that goes |
|
9075 | 9934 | without saying. |
|
9076 | \layout Standard | |
|
9935 | \end_layout | |
|
9077 | 9936 | |
|
9937 | \begin_layout Standard | |
|
9078 | 9938 | IPython's website is generously hosted at |
|
9079 | 9939 | \begin_inset LatexCommand \htmlurl{http://ipython.scipy.org} |
|
9080 | 9940 | |
|
9081 |
\end_inset |
|
|
9941 | \end_inset | |
|
9082 | 9942 | |
|
9083 | 9943 | by Enthought ( |
|
9084 | 9944 | \begin_inset LatexCommand \htmlurl{http://www.enthought.com} |
|
9085 | 9945 | |
|
9086 |
\end_inset |
|
|
9946 | \end_inset | |
|
9087 | 9947 | |
|
9088 | 9948 | ). |
|
9089 | 9949 | I am very grateful to them and all of the SciPy team for their contribution. |
|
9090 | \layout Standard | |
|
9091 | ||
|
9950 | \end_layout | |
|
9092 | 9951 | |
|
9952 | \begin_layout Standard | |
|
9093 | 9953 | \begin_inset LatexCommand \label{figgins} |
|
9094 | 9954 | |
|
9095 |
\end_inset |
|
|
9955 | \end_inset | |
|
9096 | 9956 | |
|
9097 | 9957 | Fernando would also like to thank Stephen Figgins |
|
9098 |
\family typewriter |
|
|
9958 | \family typewriter | |
|
9099 | 9959 | <fig-AT-monitor.net> |
|
9100 |
\family default |
|
|
9960 | \family default | |
|
9101 | 9961 | , an O'Reilly Python editor. |
|
9102 | 9962 | His Oct/11/2001 article about IPP and LazyPython, was what got this project |
|
9103 | 9963 | started. |
|
9104 | 9964 | You can read it at: |
|
9105 | 9965 | \begin_inset LatexCommand \htmlurl{http://www.onlamp.com/pub/a/python/2001/10/11/pythonnews.html} |
|
9106 | 9966 | |
|
9107 |
\end_inset |
|
|
9967 | \end_inset | |
|
9108 | 9968 | |
|
9109 | 9969 | . |
|
9110 | \layout Standard | |
|
9970 | \end_layout | |
|
9111 | 9971 | |
|
9972 | \begin_layout Standard | |
|
9112 | 9973 | And last but not least, all the kind IPython users who have emailed new |
|
9113 | 9974 | code, bug reports, fixes, comments and ideas. |
|
9114 | 9975 | A brief list follows, please let me know if I have ommitted your name by |
|
9115 | 9976 | accident: |
|
9116 |
\layou |
|
|
9117 | \labelwidthstring 00.00.0000 | |
|
9977 | \end_layout | |
|
9118 | 9978 | |
|
9119 | Jack\SpecialChar ~ | |
|
9979 | \begin_layout List | |
|
9980 | \labelwidthstring 00.00.0000 | |
|
9981 | Jack\InsetSpace ~ | |
|
9120 | 9982 | Moffit |
|
9121 |
\family typewriter |
|
|
9983 | \family typewriter | |
|
9122 | 9984 | <jack-AT-xiph.org> |
|
9123 |
\family default |
|
|
9985 | \family default | |
|
9124 | 9986 | Bug fixes, including the infamous color problem. |
|
9125 | 9987 | This bug alone caused many lost hours and frustration, many thanks to him |
|
9126 | 9988 | for the fix. |
|
9127 | 9989 | I've always been a fan of Ogg & friends, now I have one more reason to |
|
9128 | 9990 | like these folks. |
|
9129 |
\newline |
|
|
9130 |
Jack is also contributing with Debian packaging and many |
|
|
9131 | \layout List | |
|
9132 | \labelwidthstring 00.00.0000 | |
|
9991 | \newline | |
|
9992 | Jack is also contributing with Debian packaging and many | |
|
9993 | other things. | |
|
9994 | \end_layout | |
|
9133 | 9995 | |
|
9134 | Alexander\SpecialChar ~ | |
|
9996 | \begin_layout List | |
|
9997 | \labelwidthstring 00.00.0000 | |
|
9998 | Alexander\InsetSpace ~ | |
|
9135 | 9999 | Schmolck |
|
9136 |
\family typewriter |
|
|
10000 | \family typewriter | |
|
9137 | 10001 | <a.schmolck-AT-gmx.net> |
|
9138 |
\family default |
|
|
10002 | \family default | |
|
9139 | 10003 | Emacs work, bug reports, bug fixes, ideas, lots more. |
|
9140 | 10004 | The ipython.el mode for (X)Emacs is Alex's code, providing full support |
|
9141 | 10005 | for IPython under (X)Emacs. |
|
9142 |
\layou |
|
|
9143 | \labelwidthstring 00.00.0000 | |
|
10006 | \end_layout | |
|
9144 | 10007 | |
|
9145 | Andrea\SpecialChar ~ | |
|
10008 | \begin_layout List | |
|
10009 | \labelwidthstring 00.00.0000 | |
|
10010 | Andrea\InsetSpace ~ | |
|
9146 | 10011 | Riciputi |
|
9147 |
\family typewriter |
|
|
10012 | \family typewriter | |
|
9148 | 10013 | <andrea.riciputi-AT-libero.it> |
|
9149 |
\family default |
|
|
10014 | \family default | |
|
9150 | 10015 | Mac OSX information, Fink package management. |
|
9151 |
\layou |
|
|
9152 | \labelwidthstring 00.00.0000 | |
|
10016 | \end_layout | |
|
9153 | 10017 | |
|
9154 | Gary\SpecialChar ~ | |
|
10018 | \begin_layout List | |
|
10019 | \labelwidthstring 00.00.0000 | |
|
10020 | Gary\InsetSpace ~ | |
|
9155 | 10021 | Bishop |
|
9156 |
\family typewriter |
|
|
10022 | \family typewriter | |
|
9157 | 10023 | <gb-AT-cs.unc.edu> |
|
9158 |
\family default |
|
|
10024 | \family default | |
|
9159 | 10025 | Bug reports, and patches to work around the exception handling idiosyncracies |
|
9160 | 10026 | of WxPython. |
|
9161 | 10027 | Readline and color support for Windows. |
|
9162 |
\layou |
|
|
9163 | \labelwidthstring 00.00.0000 | |
|
10028 | \end_layout | |
|
9164 | 10029 | |
|
9165 | Jeffrey\SpecialChar ~ | |
|
10030 | \begin_layout List | |
|
10031 | \labelwidthstring 00.00.0000 | |
|
10032 | Jeffrey\InsetSpace ~ | |
|
9166 | 10033 | Collins |
|
9167 |
\family typewriter |
|
|
10034 | \family typewriter | |
|
9168 | 10035 | <Jeff.Collins-AT-vexcel.com> |
|
9169 |
\family default |
|
|
10036 | \family default | |
|
9170 | 10037 | Bug reports. |
|
9171 | 10038 | Much improved readline support, including fixes for Python 2.3. |
|
9172 |
\layou |
|
|
9173 | \labelwidthstring 00.00.0000 | |
|
10039 | \end_layout | |
|
9174 | 10040 | |
|
9175 | Dryice\SpecialChar ~ | |
|
10041 | \begin_layout List | |
|
10042 | \labelwidthstring 00.00.0000 | |
|
10043 | Dryice\InsetSpace ~ | |
|
9176 | 10044 | Liu |
|
9177 |
\family typewriter |
|
|
10045 | \family typewriter | |
|
9178 | 10046 | <dryice-AT-liu.com.cn> |
|
9179 |
\family default |
|
|
10047 | \family default | |
|
9180 | 10048 | FreeBSD port. |
|
9181 |
\layou |
|
|
9182 | \labelwidthstring 00.00.0000 | |
|
10049 | \end_layout | |
|
9183 | 10050 | |
|
9184 | Mike\SpecialChar ~ | |
|
10051 | \begin_layout List | |
|
10052 | \labelwidthstring 00.00.0000 | |
|
10053 | Mike\InsetSpace ~ | |
|
9185 | 10054 | Heeter |
|
9186 |
\family typewriter |
|
|
10055 | \family typewriter | |
|
9187 | 10056 | <korora-AT-SDF.LONESTAR.ORG> |
|
9188 |
\layou |
|
|
9189 | \labelwidthstring 00.00.0000 | |
|
10057 | \end_layout | |
|
9190 | 10058 | |
|
9191 | Christopher\SpecialChar ~ | |
|
10059 | \begin_layout List | |
|
10060 | \labelwidthstring 00.00.0000 | |
|
10061 | Christopher\InsetSpace ~ | |
|
9192 | 10062 | Hart |
|
9193 |
\family typewriter |
|
|
10063 | \family typewriter | |
|
9194 | 10064 | <hart-AT-caltech.edu> |
|
9195 |
\family default |
|
|
10065 | \family default | |
|
9196 | 10066 | PDB integration. |
|
9197 |
\layou |
|
|
9198 | \labelwidthstring 00.00.0000 | |
|
10067 | \end_layout | |
|
9199 | 10068 | |
|
9200 | Milan\SpecialChar ~ | |
|
10069 | \begin_layout List | |
|
10070 | \labelwidthstring 00.00.0000 | |
|
10071 | Milan\InsetSpace ~ | |
|
9201 | 10072 | Zamazal |
|
9202 |
\family typewriter |
|
|
10073 | \family typewriter | |
|
9203 | 10074 | <pdm-AT-zamazal.org> |
|
9204 |
\family default |
|
|
10075 | \family default | |
|
9205 | 10076 | Emacs info. |
|
9206 |
\layou |
|
|
9207 | \labelwidthstring 00.00.0000 | |
|
10077 | \end_layout | |
|
9208 | 10078 | |
|
9209 | Philip\SpecialChar ~ | |
|
10079 | \begin_layout List | |
|
10080 | \labelwidthstring 00.00.0000 | |
|
10081 | Philip\InsetSpace ~ | |
|
9210 | 10082 | Hisley |
|
9211 |
\family typewriter |
|
|
10083 | \family typewriter | |
|
9212 | 10084 | <compsys-AT-starpower.net> |
|
9213 |
\layou |
|
|
9214 | \labelwidthstring 00.00.0000 | |
|
10085 | \end_layout | |
|
9215 | 10086 | |
|
9216 | Holger\SpecialChar ~ | |
|
10087 | \begin_layout List | |
|
10088 | \labelwidthstring 00.00.0000 | |
|
10089 | Holger\InsetSpace ~ | |
|
9217 | 10090 | Krekel |
|
9218 |
\family typewriter |
|
|
10091 | \family typewriter | |
|
9219 | 10092 | <pyth-AT-devel.trillke.net> |
|
9220 |
\family default |
|
|
10093 | \family default | |
|
9221 | 10094 | Tab completion, lots more. |
|
9222 |
\layou |
|
|
9223 | \labelwidthstring 00.00.0000 | |
|
10095 | \end_layout | |
|
9224 | 10096 | |
|
9225 | Robin\SpecialChar ~ | |
|
10097 | \begin_layout List | |
|
10098 | \labelwidthstring 00.00.0000 | |
|
10099 | Robin\InsetSpace ~ | |
|
9226 | 10100 | Siebler |
|
9227 |
\family typewriter |
|
|
10101 | \family typewriter | |
|
9228 | 10102 | <robinsiebler-AT-starband.net> |
|
9229 |
\layou |
|
|
9230 | \labelwidthstring 00.00.0000 | |
|
10103 | \end_layout | |
|
9231 | 10104 | |
|
9232 | Ralf\SpecialChar ~ | |
|
10105 | \begin_layout List | |
|
10106 | \labelwidthstring 00.00.0000 | |
|
10107 | Ralf\InsetSpace ~ | |
|
9233 | 10108 | Ahlbrink |
|
9234 |
\family typewriter |
|
|
10109 | \family typewriter | |
|
9235 | 10110 | <ralf_ahlbrink-AT-web.de> |
|
9236 |
\layou |
|
|
9237 | \labelwidthstring 00.00.0000 | |
|
10111 | \end_layout | |
|
9238 | 10112 | |
|
9239 | Thorsten\SpecialChar ~ | |
|
10113 | \begin_layout List | |
|
10114 | \labelwidthstring 00.00.0000 | |
|
10115 | Thorsten\InsetSpace ~ | |
|
9240 | 10116 | Kampe |
|
9241 |
\family typewriter |
|
|
10117 | \family typewriter | |
|
9242 | 10118 | <thorsten-AT-thorstenkampe.de> |
|
9243 |
\layou |
|
|
9244 | \labelwidthstring 00.00.0000 | |
|
10119 | \end_layout | |
|
9245 | 10120 | |
|
9246 | Fredrik\SpecialChar ~ | |
|
10121 | \begin_layout List | |
|
10122 | \labelwidthstring 00.00.0000 | |
|
10123 | Fredrik\InsetSpace ~ | |
|
9247 | 10124 | Kant |
|
9248 |
\family typewriter |
|
|
10125 | \family typewriter | |
|
9249 | 10126 | <fredrik.kant-AT-front.com> |
|
9250 |
\family default |
|
|
10127 | \family default | |
|
9251 | 10128 | Windows setup. |
|
9252 |
\layou |
|
|
9253 | \labelwidthstring 00.00.0000 | |
|
10129 | \end_layout | |
|
9254 | 10130 | |
|
9255 | Syver\SpecialChar ~ | |
|
10131 | \begin_layout List | |
|
10132 | \labelwidthstring 00.00.0000 | |
|
10133 | Syver\InsetSpace ~ | |
|
9256 | 10134 | Enstad |
|
9257 |
\family typewriter |
|
|
10135 | \family typewriter | |
|
9258 | 10136 | <syver-en-AT-online.no> |
|
9259 |
\family default |
|
|
10137 | \family default | |
|
9260 | 10138 | Windows setup. |
|
9261 |
\layou |
|
|
9262 | \labelwidthstring 00.00.0000 | |
|
10139 | \end_layout | |
|
9263 | 10140 | |
|
10141 | \begin_layout List | |
|
10142 | \labelwidthstring 00.00.0000 | |
|
9264 | 10143 | Richard |
|
9265 |
\family typewriter |
|
|
10144 | \family typewriter | |
|
9266 | 10145 | <rxe-AT-renre-europe.com> |
|
9267 |
\family default |
|
|
10146 | \family default | |
|
9268 | 10147 | Global embedding. |
|
9269 |
\layou |
|
|
9270 | \labelwidthstring 00.00.0000 | |
|
10148 | \end_layout | |
|
9271 | 10149 | |
|
9272 | Hayden\SpecialChar ~ | |
|
10150 | \begin_layout List | |
|
10151 | \labelwidthstring 00.00.0000 | |
|
10152 | Hayden\InsetSpace ~ | |
|
9273 | 10153 | Callow |
|
9274 |
\family typewriter |
|
|
10154 | \family typewriter | |
|
9275 | 10155 | <h.callow-AT-elec.canterbury.ac.nz> |
|
9276 |
\family default |
|
|
10156 | \family default | |
|
9277 | 10157 | Gnuplot.py 1.6 compatibility. |
|
9278 |
\layou |
|
|
9279 | \labelwidthstring 00.00.0000 | |
|
10158 | \end_layout | |
|
9280 | 10159 | |
|
9281 | Leonardo\SpecialChar ~ | |
|
10160 | \begin_layout List | |
|
10161 | \labelwidthstring 00.00.0000 | |
|
10162 | Leonardo\InsetSpace ~ | |
|
9282 | 10163 | Santagada |
|
9283 |
\family typewriter |
|
|
10164 | \family typewriter | |
|
9284 | 10165 | <retype-AT-terra.com.br> |
|
9285 |
\family default |
|
|
10166 | \family default | |
|
9286 | 10167 | Fixes for Windows installation. |
|
9287 |
\layou |
|
|
9288 | \labelwidthstring 00.00.0000 | |
|
10168 | \end_layout | |
|
9289 | 10169 | |
|
9290 | Christopher\SpecialChar ~ | |
|
10170 | \begin_layout List | |
|
10171 | \labelwidthstring 00.00.0000 | |
|
10172 | Christopher\InsetSpace ~ | |
|
9291 | 10173 | Armstrong |
|
9292 |
\family typewriter |
|
|
10174 | \family typewriter | |
|
9293 | 10175 | <radix-AT-twistedmatrix.com> |
|
9294 |
\family default |
|
|
10176 | \family default | |
|
9295 | 10177 | Bugfixes. |
|
9296 |
\layou |
|
|
9297 | \labelwidthstring 00.00.0000 | |
|
10178 | \end_layout | |
|
9298 | 10179 | |
|
9299 | Francois\SpecialChar ~ | |
|
10180 | \begin_layout List | |
|
10181 | \labelwidthstring 00.00.0000 | |
|
10182 | Francois\InsetSpace ~ | |
|
9300 | 10183 | Pinard |
|
9301 |
\family typewriter |
|
|
10184 | \family typewriter | |
|
9302 | 10185 | <pinard-AT-iro.umontreal.ca> |
|
9303 |
\family default |
|
|
10186 | \family default | |
|
9304 | 10187 | Code and documentation fixes. |
|
9305 |
\layou |
|
|
9306 | \labelwidthstring 00.00.0000 | |
|
10188 | \end_layout | |
|
9307 | 10189 | |
|
9308 | Cory\SpecialChar ~ | |
|
10190 | \begin_layout List | |
|
10191 | \labelwidthstring 00.00.0000 | |
|
10192 | Cory\InsetSpace ~ | |
|
9309 | 10193 | Dodt |
|
9310 |
\family typewriter |
|
|
10194 | \family typewriter | |
|
9311 | 10195 | <cdodt-AT-fcoe.k12.ca.us> |
|
9312 |
\family default |
|
|
10196 | \family default | |
|
9313 | 10197 | Bug reports and Windows ideas. |
|
9314 | 10198 | Patches for Windows installer. |
|
9315 |
\layou |
|
|
9316 | \labelwidthstring 00.00.0000 | |
|
10199 | \end_layout | |
|
9317 | 10200 | |
|
9318 | Olivier\SpecialChar ~ | |
|
10201 | \begin_layout List | |
|
10202 | \labelwidthstring 00.00.0000 | |
|
10203 | Olivier\InsetSpace ~ | |
|
9319 | 10204 | Aubert |
|
9320 |
\family typewriter |
|
|
10205 | \family typewriter | |
|
9321 | 10206 | <oaubert-AT-bat710.univ-lyon1.fr> |
|
9322 |
\family default |
|
|
10207 | \family default | |
|
9323 | 10208 | New magics. |
|
9324 |
\layou |
|
|
9325 | \labelwidthstring 00.00.0000 | |
|
10209 | \end_layout | |
|
9326 | 10210 | |
|
9327 | King\SpecialChar ~ | |
|
9328 | C.\SpecialChar ~ | |
|
10211 | \begin_layout List | |
|
10212 | \labelwidthstring 00.00.0000 | |
|
10213 | King\InsetSpace ~ | |
|
10214 | C.\InsetSpace ~ | |
|
9329 | 10215 | Shu |
|
9330 |
\family typewriter |
|
|
10216 | \family typewriter | |
|
9331 | 10217 | <kingshu-AT-myrealbox.com> |
|
9332 |
\family default |
|
|
10218 | \family default | |
|
9333 | 10219 | Autoindent patch. |
|
9334 |
\layou |
|
|
9335 | \labelwidthstring 00.00.0000 | |
|
10220 | \end_layout | |
|
9336 | 10221 | |
|
9337 | Chris\SpecialChar ~ | |
|
10222 | \begin_layout List | |
|
10223 | \labelwidthstring 00.00.0000 | |
|
10224 | Chris\InsetSpace ~ | |
|
9338 | 10225 | Drexler |
|
9339 |
\family typewriter |
|
|
10226 | \family typewriter | |
|
9340 | 10227 | <chris-AT-ac-drexler.de> |
|
9341 |
\family default |
|
|
10228 | \family default | |
|
9342 | 10229 | Readline packages for Win32/CygWin. |
|
9343 |
\layou |
|
|
9344 | \labelwidthstring 00.00.0000 | |
|
10230 | \end_layout | |
|
9345 | 10231 | |
|
9346 | Gustavo\SpecialChar ~ | |
|
9347 | Cordova\SpecialChar ~ | |
|
10232 | \begin_layout List | |
|
10233 | \labelwidthstring 00.00.0000 | |
|
10234 | Gustavo\InsetSpace ~ | |
|
10235 | Cordova\InsetSpace ~ | |
|
9348 | 10236 | Avila |
|
9349 |
\family typewriter |
|
|
10237 | \family typewriter | |
|
9350 | 10238 | <gcordova-AT-sismex.com> |
|
9351 |
\family default |
|
|
10239 | \family default | |
|
9352 | 10240 | EvalDict code for nice, lightweight string interpolation. |
|
9353 |
\layou |
|
|
9354 | \labelwidthstring 00.00.0000 | |
|
10241 | \end_layout | |
|
9355 | 10242 | |
|
9356 | Kasper\SpecialChar ~ | |
|
10243 | \begin_layout List | |
|
10244 | \labelwidthstring 00.00.0000 | |
|
10245 | Kasper\InsetSpace ~ | |
|
9357 | 10246 | Souren |
|
9358 |
\family typewriter |
|
|
10247 | \family typewriter | |
|
9359 | 10248 | <Kasper.Souren-AT-ircam.fr> |
|
9360 |
\family default |
|
|
10249 | \family default | |
|
9361 | 10250 | Bug reports, ideas. |
|
9362 |
\layou |
|
|
9363 | \labelwidthstring 00.00.0000 | |
|
10251 | \end_layout | |
|
9364 | 10252 | |
|
9365 | Gever\SpecialChar ~ | |
|
10253 | \begin_layout List | |
|
10254 | \labelwidthstring 00.00.0000 | |
|
10255 | Gever\InsetSpace ~ | |
|
9366 | 10256 | Tulley |
|
9367 |
\family typewriter |
|
|
10257 | \family typewriter | |
|
9368 | 10258 | <gever-AT-helium.com> |
|
9369 |
\family default |
|
|
10259 | \family default | |
|
9370 | 10260 | Code contributions. |
|
9371 |
\layou |
|
|
9372 | \labelwidthstring 00.00.0000 | |
|
10261 | \end_layout | |
|
9373 | 10262 | |
|
9374 | Ralf\SpecialChar ~ | |
|
10263 | \begin_layout List | |
|
10264 | \labelwidthstring 00.00.0000 | |
|
10265 | Ralf\InsetSpace ~ | |
|
9375 | 10266 | Schmitt |
|
9376 |
\family typewriter |
|
|
10267 | \family typewriter | |
|
9377 | 10268 | <ralf-AT-brainbot.com> |
|
9378 |
\family default |
|
|
10269 | \family default | |
|
9379 | 10270 | Bug reports & fixes. |
|
9380 |
\layou |
|
|
9381 | \labelwidthstring 00.00.0000 | |
|
10271 | \end_layout | |
|
9382 | 10272 | |
|
9383 | Oliver\SpecialChar ~ | |
|
10273 | \begin_layout List | |
|
10274 | \labelwidthstring 00.00.0000 | |
|
10275 | Oliver\InsetSpace ~ | |
|
9384 | 10276 | Sander |
|
9385 |
\family typewriter |
|
|
10277 | \family typewriter | |
|
9386 | 10278 | <osander-AT-gmx.de> |
|
9387 |
\family default |
|
|
10279 | \family default | |
|
9388 | 10280 | Bug reports. |
|
9389 |
\layou |
|
|
9390 | \labelwidthstring 00.00.0000 | |
|
10281 | \end_layout | |
|
9391 | 10282 | |
|
9392 | Rod\SpecialChar ~ | |
|
10283 | \begin_layout List | |
|
10284 | \labelwidthstring 00.00.0000 | |
|
10285 | Rod\InsetSpace ~ | |
|
9393 | 10286 | Holland |
|
9394 |
\family typewriter |
|
|
10287 | \family typewriter | |
|
9395 | 10288 | <rhh-AT-structurelabs.com> |
|
9396 |
\family default |
|
|
10289 | \family default | |
|
9397 | 10290 | Bug reports and fixes to logging module. |
|
9398 |
\layou |
|
|
9399 | \labelwidthstring 00.00.0000 | |
|
10291 | \end_layout | |
|
9400 | 10292 | |
|
9401 | Daniel\SpecialChar ~ | |
|
9402 | 'Dang'\SpecialChar ~ | |
|
10293 | \begin_layout List | |
|
10294 | \labelwidthstring 00.00.0000 | |
|
10295 | Daniel\InsetSpace ~ | |
|
10296 | 'Dang'\InsetSpace ~ | |
|
9403 | 10297 | Griffith |
|
9404 |
\family typewriter |
|
|
10298 | \family typewriter | |
|
9405 | 10299 | <pythondev-dang-AT-lazytwinacres.net> |
|
9406 |
\family default |
|
|
10300 | \family default | |
|
9407 | 10301 | Fixes, enhancement suggestions for system shell use. |
|
9408 |
\layou |
|
|
9409 | \labelwidthstring 00.00.0000 | |
|
10302 | \end_layout | |
|
9410 | 10303 | |
|
9411 | Viktor\SpecialChar ~ | |
|
10304 | \begin_layout List | |
|
10305 | \labelwidthstring 00.00.0000 | |
|
10306 | Viktor\InsetSpace ~ | |
|
9412 | 10307 | Ransmayr |
|
9413 |
\family typewriter |
|
|
10308 | \family typewriter | |
|
9414 | 10309 | <viktor.ransmayr-AT-t-online.de> |
|
9415 |
\family default |
|
|
10310 | \family default | |
|
9416 | 10311 | Tests and reports on Windows installation issues. |
|
9417 | 10312 | Contributed a true Windows binary installer. |
|
9418 |
\layou |
|
|
9419 | \labelwidthstring 00.00.0000 | |
|
10313 | \end_layout | |
|
9420 | 10314 | |
|
9421 | Mike\SpecialChar ~ | |
|
10315 | \begin_layout List | |
|
10316 | \labelwidthstring 00.00.0000 | |
|
10317 | Mike\InsetSpace ~ | |
|
9422 | 10318 | Salib |
|
9423 |
\family typewriter |
|
|
10319 | \family typewriter | |
|
9424 | 10320 | <msalib-AT-mit.edu> |
|
9425 |
\family default |
|
|
10321 | \family default | |
|
9426 | 10322 | Help fixing a subtle bug related to traceback printing. |
|
9427 |
\layou |
|
|
9428 | \labelwidthstring 00.00.0000 | |
|
10323 | \end_layout | |
|
9429 | 10324 | |
|
9430 | W.J.\SpecialChar ~ | |
|
9431 | van\SpecialChar ~ | |
|
9432 | der\SpecialChar ~ | |
|
10325 | \begin_layout List | |
|
10326 | \labelwidthstring 00.00.0000 | |
|
10327 | W.J.\InsetSpace ~ | |
|
10328 | van\InsetSpace ~ | |
|
10329 | der\InsetSpace ~ | |
|
9433 | 10330 | Laan |
|
9434 |
\family typewriter |
|
|
10331 | \family typewriter | |
|
9435 | 10332 | <gnufnork-AT-hetdigitalegat.nl> |
|
9436 |
\family default |
|
|
10333 | \family default | |
|
9437 | 10334 | Bash-like prompt specials. |
|
9438 |
\layou |
|
|
9439 | \labelwidthstring 00.00.0000 | |
|
10335 | \end_layout | |
|
9440 | 10336 | |
|
9441 | Antoon\SpecialChar ~ | |
|
10337 | \begin_layout List | |
|
10338 | \labelwidthstring 00.00.0000 | |
|
10339 | Antoon\InsetSpace ~ | |
|
9442 | 10340 | Pardon |
|
9443 |
\family typewriter |
|
|
10341 | \family typewriter | |
|
9444 | 10342 | <Antoon.Pardon-AT-rece.vub.ac.be> |
|
9445 |
\family default |
|
|
10343 | \family default | |
|
9446 | 10344 | Critical fix for the multithreaded IPython. |
|
9447 |
\layou |
|
|
9448 | \labelwidthstring 00.00.0000 | |
|
10345 | \end_layout | |
|
9449 | 10346 | |
|
9450 | John\SpecialChar ~ | |
|
10347 | \begin_layout List | |
|
10348 | \labelwidthstring 00.00.0000 | |
|
10349 | John\InsetSpace ~ | |
|
9451 | 10350 | Hunter |
|
9452 |
\family typewriter |
|
|
10351 | \family typewriter | |
|
9453 | 10352 | <jdhunter-AT-nitace.bsd.uchicago.edu> |
|
9454 |
\family default |
|
|
10353 | \family default | |
|
9455 | 10354 | Matplotlib author, helped with all the development of support for matplotlib |
|
9456 | 10355 | in IPyhton, including making necessary changes to matplotlib itself. |
|
9457 |
\layou |
|
|
9458 | \labelwidthstring 00.00.0000 | |
|
10356 | \end_layout | |
|
9459 | 10357 | |
|
9460 | Matthew\SpecialChar ~ | |
|
10358 | \begin_layout List | |
|
10359 | \labelwidthstring 00.00.0000 | |
|
10360 | Matthew\InsetSpace ~ | |
|
9461 | 10361 | Arnison |
|
9462 |
\family typewriter |
|
|
10362 | \family typewriter | |
|
9463 | 10363 | <maffew-AT-cat.org.au> |
|
9464 |
\family default |
|
|
10364 | \family default | |
|
9465 | 10365 | Bug reports, ` |
|
9466 |
\family typewriter |
|
|
10366 | \family typewriter | |
|
9467 | 10367 | %run -d |
|
9468 |
\family default |
|
|
10368 | \family default | |
|
9469 | 10369 | ' idea. |
|
9470 |
\layou |
|
|
9471 | \labelwidthstring 00.00.0000 | |
|
10370 | \end_layout | |
|
9472 | 10371 | |
|
9473 | Prabhu\SpecialChar ~ | |
|
10372 | \begin_layout List | |
|
10373 | \labelwidthstring 00.00.0000 | |
|
10374 | Prabhu\InsetSpace ~ | |
|
9474 | 10375 | Ramachandran |
|
9475 |
\family typewriter |
|
|
10376 | \family typewriter | |
|
9476 | 10377 | <prabhu_r-AT-users.sourceforge.net> |
|
9477 |
\family default |
|
|
10378 | \family default | |
|
9478 | 10379 | Help with (X)Emacs support, threading patches, ideas... |
|
9479 |
\layou |
|
|
9480 | \labelwidthstring 00.00.0000 | |
|
10380 | \end_layout | |
|
9481 | 10381 | |
|
9482 | Norbert\SpecialChar ~ | |
|
10382 | \begin_layout List | |
|
10383 | \labelwidthstring 00.00.0000 | |
|
10384 | Norbert\InsetSpace ~ | |
|
9483 | 10385 | Tretkowski |
|
9484 |
\family typewriter |
|
|
10386 | \family typewriter | |
|
9485 | 10387 | <tretkowski-AT-inittab.de> |
|
9486 |
\family default |
|
|
10388 | \family default | |
|
9487 | 10389 | help with Debian packaging and distribution. |
|
9488 |
\layou |
|
|
9489 | \labelwidthstring 00.00.0000 | |
|
10390 | \end_layout | |
|
9490 | 10391 | |
|
9491 | George\SpecialChar ~ | |
|
10392 | \begin_layout List | |
|
10393 | \labelwidthstring 00.00.0000 | |
|
10394 | George\InsetSpace ~ | |
|
9492 | 10395 | Sakkis < |
|
9493 |
\family typewriter |
|
|
10396 | \family typewriter | |
|
9494 | 10397 | gsakkis-AT-eden.rutgers.edu> |
|
9495 |
\family default |
|
|
10398 | \family default | |
|
9496 | 10399 | New matcher for tab-completing named arguments of user-defined functions. |
|
9497 |
\layou |
|
|
9498 | \labelwidthstring 00.00.0000 | |
|
10400 | \end_layout | |
|
9499 | 10401 | |
|
9500 | J�rgen\SpecialChar ~ | |
|
10402 | \begin_layout List | |
|
10403 | \labelwidthstring 00.00.0000 | |
|
10404 | J�rgen\InsetSpace ~ | |
|
9501 | 10405 | Stenarson |
|
9502 |
\family typewriter |
|
|
10406 | \family typewriter | |
|
9503 | 10407 | <jorgen.stenarson-AT-bostream.nu> |
|
9504 |
\family default |
|
|
10408 | \family default | |
|
9505 | 10409 | Wildcard support implementation for searching namespaces. |
|
9506 |
\layou |
|
|
9507 | \labelwidthstring 00.00.0000 | |
|
10410 | \end_layout | |
|
9508 | 10411 | |
|
9509 | Vivian\SpecialChar ~ | |
|
9510 | De\SpecialChar ~ | |
|
10412 | \begin_layout List | |
|
10413 | \labelwidthstring 00.00.0000 | |
|
10414 | Vivian\InsetSpace ~ | |
|
10415 | De\InsetSpace ~ | |
|
9511 | 10416 | Smedt |
|
9512 |
\family typewriter |
|
|
10417 | \family typewriter | |
|
9513 | 10418 | <vivian-AT-vdesmedt.com> |
|
9514 |
\family default |
|
|
10419 | \family default | |
|
9515 | 10420 | Debugger enhancements, so that when pdb is activated from within IPython, |
|
9516 | 10421 | coloring, tab completion and other features continue to work seamlessly. |
|
9517 |
\layou |
|
|
9518 | \labelwidthstring 00.00.0000 | |
|
10422 | \end_layout | |
|
9519 | 10423 | |
|
9520 | Scott\SpecialChar ~ | |
|
10424 | \begin_layout List | |
|
10425 | \labelwidthstring 00.00.0000 | |
|
10426 | Scott\InsetSpace ~ | |
|
9521 | 10427 | Tsai |
|
9522 |
\family typewriter |
|
|
10428 | \family typewriter | |
|
9523 | 10429 | <scottt958-AT-yahoo.com.tw> |
|
9524 |
\family default |
|
|
10430 | \family default | |
|
9525 | 10431 | Support for automatic editor invocation on syntax errors (see |
|
9526 | 10432 | \begin_inset LatexCommand \htmlurl{http://www.scipy.net/roundup/ipython/issue36} |
|
9527 | 10433 | |
|
9528 |
\end_inset |
|
|
10434 | \end_inset | |
|
9529 | 10435 | |
|
9530 | 10436 | ). |
|
9531 |
\layou |
|
|
9532 | \labelwidthstring 00.00.0000 | |
|
10437 | \end_layout | |
|
9533 | 10438 | |
|
9534 | Alexander\SpecialChar ~ | |
|
10439 | \begin_layout List | |
|
10440 | \labelwidthstring 00.00.0000 | |
|
10441 | Alexander\InsetSpace ~ | |
|
9535 | 10442 | Belchenko |
|
9536 |
\family typewriter |
|
|
10443 | \family typewriter | |
|
9537 | 10444 | <bialix-AT-ukr.net> |
|
9538 |
\family default |
|
|
10445 | \family default | |
|
9539 | 10446 | Improvements for win32 paging system. |
|
9540 |
\layou |
|
|
9541 | \labelwidthstring 00.00.0000 | |
|
10447 | \end_layout | |
|
9542 | 10448 | |
|
9543 | Will\SpecialChar ~ | |
|
10449 | \begin_layout List | |
|
10450 | \labelwidthstring 00.00.0000 | |
|
10451 | Will\InsetSpace ~ | |
|
9544 | 10452 | Maier |
|
9545 |
\family typewriter |
|
|
10453 | \family typewriter | |
|
9546 | 10454 | <willmaier-AT-ml1.net> |
|
9547 |
\family default |
|
|
10455 | \family default | |
|
9548 | 10456 | Official OpenBSD port. |
|
9549 | \the_end | |
|
10457 | \end_layout | |
|
10458 | ||
|
10459 | \end_body | |
|
10460 | \end_document |
@@ -88,6 +88,11 b' def run(wait=0):' | |||
|
88 | 88 | # make shortcuts for IPython, html and pdf docs. |
|
89 | 89 | print 'Making entries for IPython in Start Menu...', |
|
90 | 90 | |
|
91 | # Create .bat file in \\Scripts | |
|
92 | fic = open(sys.prefix + '\\Scripts\\ipython.bat','w') | |
|
93 | fic.write('"' + sys.prefix + '\\python.exe' + '" -i ' + '"' + sys.prefix + '\\Scripts\ipython" %*') | |
|
94 | fic.close() | |
|
95 | ||
|
91 | 96 | # Create shortcuts in Programs\IPython: |
|
92 | 97 | if not os.path.isdir(ip_prog_dir): |
|
93 | 98 | os.mkdir(ip_prog_dir) |
General Comments 0
You need to be logged in to leave comments.
Login now