blob: e80384b7775222ce97185cafeb56af2d7dfa8057 [file] [log] [blame]
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -04001
Tal Einat580bdb02019-09-03 23:52:58 +03002<!DOCTYPE html>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -04003
Terry Jan Reedya460d452020-10-20 20:56:01 -04004<html>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -04005 <head>
Tal Einat580bdb02019-09-03 23:52:58 +03006 <meta charset="utf-8" />
Terry Jan Reedya460d452020-10-20 20:56:01 -04007 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
Terry Jan Reedy1b4a9c72021-03-31 01:19:38 -04008 <title>IDLE &#8212; Python 3.10.0a6 documentation</title>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -04009 <link rel="stylesheet" href="../_static/pydoctheme.css" type="text/css" />
10 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
Terry Jan Reedydb40cb52018-10-28 01:21:36 -040011
Terry Jan Reedya460d452020-10-20 20:56:01 -040012 <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
13 <script src="../_static/jquery.js"></script>
14 <script src="../_static/underscore.js"></script>
15 <script src="../_static/doctools.js"></script>
16 <script src="../_static/language_data.js"></script>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -040017
Terry Jan Reedya460d452020-10-20 20:56:01 -040018 <script src="../_static/sidebar.js"></script>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -040019
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -040020 <link rel="search" type="application/opensearchdescription+xml"
Terry Jan Reedy1b4a9c72021-03-31 01:19:38 -040021 title="Search within Python 3.10.0a6 documentation"
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -040022 href="../_static/opensearch.xml"/>
23 <link rel="author" title="About these documents" href="../about.html" />
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -040024 <link rel="index" title="Index" href="../genindex.html" />
25 <link rel="search" title="Search" href="../search.html" />
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -040026 <link rel="copyright" title="Copyright" href="../copyright.html" />
Terry Jan Reedydb40cb52018-10-28 01:21:36 -040027 <link rel="next" title="Other Graphical User Interface Packages" href="othergui.html" />
Terry Jan Reedy6bf644e2019-11-24 16:29:29 -050028 <link rel="prev" title="tkinter.tix — Extension widgets for Tk" href="tkinter.tix.html" />
terryjreedy188aedf2017-06-13 21:32:16 -040029 <link rel="canonical" href="https://docs.python.org/3/library/idle.html" />
30
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -040031
32
33
34
Terry Jan Reedydb40cb52018-10-28 01:21:36 -040035 <style>
36 @media only screen {
37 table.full-width-table {
38 width: 100%;
39 }
40 }
41 </style>
42
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -040043 <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
44
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -040045 <script type="text/javascript" src="../_static/copybutton.js"></script>
Terry Jan Reedy963a38b2015-09-20 20:03:01 -040046
47
48
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -040049
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -040050 </head><body>
Tal Einat5bff3c82019-06-17 22:41:00 +030051
Terry Jan Reedyf8cd02d2016-03-01 00:29:57 -050052 <div class="related" role="navigation" aria-label="related navigation">
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -040053 <h3>Navigation</h3>
54 <ul>
55 <li class="right" style="margin-right: 10px">
56 <a href="../genindex.html" title="General Index"
57 accesskey="I">index</a></li>
58 <li class="right" >
59 <a href="../py-modindex.html" title="Python Module Index"
60 >modules</a> |</li>
61 <li class="right" >
Terry Jan Reedydb40cb52018-10-28 01:21:36 -040062 <a href="othergui.html" title="Other Graphical User Interface Packages"
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -040063 accesskey="N">next</a> |</li>
64 <li class="right" >
Terry Jan Reedy6bf644e2019-11-24 16:29:29 -050065 <a href="tkinter.tix.html" title="tkinter.tix — Extension widgets for Tk"
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -040066 accesskey="P">previous</a> |</li>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -040067
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -040068 <li><img src="../_static/py.png" alt=""
69 style="vertical-align: middle; margin-top: -1px"/></li>
70 <li><a href="https://www.python.org/">Python</a> &#187;</li>
71
72
Terry Jan Reedy4cf7bb82021-02-21 02:44:11 -050073 <li id="cpython-language-and-version">
Terry Jan Reedy1b4a9c72021-03-31 01:19:38 -040074 <a href="../index.html">3.10.0a6 Documentation</a> &#187;
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -040075 </li>
76
77 <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -040078 <li class="nav-item nav-item-2"><a href="tk.html" accesskey="U">Graphical User Interfaces with Tk</a> &#187;</li>
Terry Jan Reedya460d452020-10-20 20:56:01 -040079 <li class="nav-item nav-item-this"><a href="">IDLE</a></li>
Terry Jan Reedy4b736762016-09-12 01:50:03 -040080 <li class="right">
81
82
83 <div class="inline-search" style="display: none" role="search">
84 <form class="inline-search" action="../search.html" method="get">
85 <input placeholder="Quick search" type="text" name="q" />
86 <input type="submit" value="Go" />
87 <input type="hidden" name="check_keywords" value="yes" />
88 <input type="hidden" name="area" value="default" />
89 </form>
90 </div>
91 <script type="text/javascript">$('.inline-search').show(0);</script>
92 |
93 </li>
94
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -040095 </ul>
Terry Jan Reedy963a38b2015-09-20 20:03:01 -040096 </div>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -040097
98 <div class="document">
99 <div class="documentwrapper">
100 <div class="bodywrapper">
Terry Jan Reedyf8cd02d2016-03-01 00:29:57 -0500101 <div class="body" role="main">
Terry Jan Reedy963a38b2015-09-20 20:03:01 -0400102
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400103 <div class="section" id="idle">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400104<span id="id1"></span><h1>IDLE<a class="headerlink" href="#idle" title="Permalink to this headline"></a></h1>
terryjreedy188aedf2017-06-13 21:32:16 -0400105<p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/master/Lib/idlelib/">Lib/idlelib/</a></p>
Terry Jan Reedyfa089b92016-06-11 15:02:54 -0400106<hr class="docutils" id="index-0" />
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400107<p>IDLE is Python’s Integrated Development and Learning Environment.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400108<p>IDLE has the following features:</p>
109<ul class="simple">
Tal Einat580bdb02019-09-03 23:52:58 +0300110<li><p>coded in 100% pure Python, using the <a class="reference internal" href="tkinter.html#module-tkinter" title="tkinter: Interface to Tcl/Tk for graphical user interfaces"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tkinter</span></code></a> GUI toolkit</p></li>
111<li><p>cross-platform: works mostly the same on Windows, Unix, and macOS</p></li>
112<li><p>Python shell window (interactive interpreter) with colorizing
113of code input, output, and error messages</p></li>
114<li><p>multi-window text editor with multiple undo, Python colorizing,
115smart indent, call tips, auto completion, and other features</p></li>
116<li><p>search within any window, replace within editor windows, and search
117through multiple files (grep)</p></li>
118<li><p>debugger with persistent breakpoints, stepping, and viewing
119of global and local namespaces</p></li>
120<li><p>configuration, browsers, and other dialogs</p></li>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400121</ul>
122<div class="section" id="menus">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400123<h2>Menus<a class="headerlink" href="#menus" title="Permalink to this headline"></a></h2>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400124<p>IDLE has two main window types, the Shell window and the Editor window. It is
Terry Jan Reedy50ff02b2018-11-10 23:26:31 -0500125possible to have multiple editor windows simultaneously. On Windows and
126Linux, each has its own top menu. Each menu documented below indicates
127which window type it is associated with.</p>
128<p>Output windows, such as used for Edit =&gt; Find in Files, are a subtype of editor
129window. They currently have the same top menu but a different
130default title and context menu.</p>
Terry Jan Reedyb65413b2018-11-15 13:15:13 -0500131<p>On macOS, there is one application menu. It dynamically changes according
Terry Jan Reedy50ff02b2018-11-10 23:26:31 -0500132to the window currently selected. It has an IDLE menu, and some entries
Terry Jan Reedy8a533ff2019-05-16 01:20:37 -0400133described below are moved around to conform to Apple guidelines.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400134<div class="section" id="file-menu-shell-and-editor">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400135<h3>File menu (Shell and Editor)<a class="headerlink" href="#file-menu-shell-and-editor" title="Permalink to this headline"></a></h3>
Tal Einat580bdb02019-09-03 23:52:58 +0300136<dl class="simple">
137<dt>New File</dt><dd><p>Create a new file editing window.</p>
138</dd>
139<dt>Open…</dt><dd><p>Open an existing file with an Open dialog.</p>
140</dd>
141<dt>Recent Files</dt><dd><p>Open a list of recent files. Click one to open it.</p>
142</dd>
143<dt>Open Module…</dt><dd><p>Open an existing module (searches sys.path).</p>
144</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400145</dl>
Tal Einat580bdb02019-09-03 23:52:58 +0300146<dl class="simple" id="index-1">
147<dt>Class Browser</dt><dd><p>Show functions, classes, and methods in the current Editor file in a
148tree structure. In the shell, open a module first.</p>
149</dd>
150<dt>Path Browser</dt><dd><p>Show sys.path directories, modules, functions, classes and methods in a
151tree structure.</p>
152</dd>
153<dt>Save</dt><dd><p>Save the current window to the associated file, if there is one. Windows
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400154that have been changed since being opened or last saved have a * before
155and after the window title. If there is no associated file,
Tal Einat580bdb02019-09-03 23:52:58 +0300156do Save As instead.</p>
157</dd>
158<dt>Save As…</dt><dd><p>Save the current window with a Save As dialog. The file saved becomes the
159new associated file for the window.</p>
160</dd>
161<dt>Save Copy As…</dt><dd><p>Save the current window to different file without changing the associated
162file.</p>
163</dd>
164<dt>Print Window</dt><dd><p>Print the current window to the default printer.</p>
165</dd>
166<dt>Close</dt><dd><p>Close the current window (ask to save if unsaved).</p>
167</dd>
168<dt>Exit</dt><dd><p>Close all windows and quit IDLE (ask to save unsaved windows).</p>
169</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400170</dl>
171</div>
172<div class="section" id="edit-menu-shell-and-editor">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400173<h3>Edit menu (Shell and Editor)<a class="headerlink" href="#edit-menu-shell-and-editor" title="Permalink to this headline"></a></h3>
Tal Einat580bdb02019-09-03 23:52:58 +0300174<dl class="simple">
175<dt>Undo</dt><dd><p>Undo the last change to the current window. A maximum of 1000 changes may
176be undone.</p>
177</dd>
178<dt>Redo</dt><dd><p>Redo the last undone change to the current window.</p>
179</dd>
180<dt>Cut</dt><dd><p>Copy selection into the system-wide clipboard; then delete the selection.</p>
181</dd>
182<dt>Copy</dt><dd><p>Copy selection into the system-wide clipboard.</p>
183</dd>
184<dt>Paste</dt><dd><p>Insert contents of the system-wide clipboard into the current window.</p>
185</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400186</dl>
187<p>The clipboard functions are also available in context menus.</p>
Tal Einat580bdb02019-09-03 23:52:58 +0300188<dl class="simple">
189<dt>Select All</dt><dd><p>Select the entire contents of the current window.</p>
190</dd>
191<dt>Find…</dt><dd><p>Open a search dialog with many options</p>
192</dd>
193<dt>Find Again</dt><dd><p>Repeat the last search, if there is one.</p>
194</dd>
195<dt>Find Selection</dt><dd><p>Search for the currently selected string, if there is one.</p>
196</dd>
197<dt>Find in Files…</dt><dd><p>Open a file search dialog. Put results in a new output window.</p>
198</dd>
199<dt>Replace…</dt><dd><p>Open a search-and-replace dialog.</p>
200</dd>
Terry Jan Reedy2522db12020-03-08 14:32:42 -0400201<dt>Go to Line</dt><dd><p>Move the cursor to the beginning of the line requested and make that
202line visible. A request past the end of the file goes to the end.
203Clear any selection and update the line and column status.</p>
Tal Einat580bdb02019-09-03 23:52:58 +0300204</dd>
Terry Jan Reedybce2eb42020-07-09 18:08:33 -0400205<dt>Show Completions</dt><dd><p>Open a scrollable list allowing selection of existing names. See
Tal Einat580bdb02019-09-03 23:52:58 +0300206<a class="reference internal" href="#completions"><span class="std std-ref">Completions</span></a> in the Editing and navigation section below.</p>
207</dd>
208<dt>Expand Word</dt><dd><p>Expand a prefix you have typed to match a full word in the same window;
209repeat to get a different expansion.</p>
210</dd>
211<dt>Show call tip</dt><dd><p>After an unclosed parenthesis for a function, open a small window with
Cheryl Sabella01421be2018-12-20 00:38:54 -0500212function parameter hints. See <a class="reference internal" href="#calltips"><span class="std std-ref">Calltips</span></a> in the
Tal Einat580bdb02019-09-03 23:52:58 +0300213Editing and navigation section below.</p>
214</dd>
215<dt>Show surrounding parens</dt><dd><p>Highlight the surrounding parenthesis.</p>
216</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400217</dl>
218</div>
219<div class="section" id="format-menu-editor-window-only">
Terry Jan Reedy292cd6e2018-12-20 06:06:29 -0500220<span id="format-menu"></span><h3>Format menu (Editor window only)<a class="headerlink" href="#format-menu-editor-window-only" title="Permalink to this headline"></a></h3>
Tal Einat580bdb02019-09-03 23:52:58 +0300221<dl class="simple">
222<dt>Indent Region</dt><dd><p>Shift selected lines right by the indent width (default 4 spaces).</p>
223</dd>
224<dt>Dedent Region</dt><dd><p>Shift selected lines left by the indent width (default 4 spaces).</p>
225</dd>
226<dt>Comment Out Region</dt><dd><p>Insert ## in front of selected lines.</p>
227</dd>
228<dt>Uncomment Region</dt><dd><p>Remove leading # or ## from selected lines.</p>
229</dd>
230<dt>Tabify Region</dt><dd><p>Turn <em>leading</em> stretches of spaces into tabs. (Note: We recommend using
2314 space blocks to indent Python code.)</p>
232</dd>
233<dt>Untabify Region</dt><dd><p>Turn <em>all</em> tabs into the correct number of spaces.</p>
234</dd>
235<dt>Toggle Tabs</dt><dd><p>Open a dialog to switch between indenting with spaces and tabs.</p>
236</dd>
237<dt>New Indent Width</dt><dd><p>Open a dialog to change indent width. The accepted default by the Python
238community is 4 spaces.</p>
239</dd>
240<dt>Format Paragraph</dt><dd><p>Reformat the current blank-line-delimited paragraph in comment block or
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400241multiline string or selected line in a string. All lines in the
Tal Einat580bdb02019-09-03 23:52:58 +0300242paragraph will be formatted to less than N columns, where N defaults to 72.</p>
243</dd>
244<dt>Strip trailing whitespace</dt><dd><p>Remove trailing space and other whitespace characters after the last
Terry Jan Reedyff702892017-09-15 13:05:28 -0400245non-whitespace character of a line by applying str.rstrip to each line,
Terry Jan Reedy6bf644e2019-11-24 16:29:29 -0500246including lines within multiline strings. Except for Shell windows,
247remove extra newlines at the end of the file.</p>
Tal Einat580bdb02019-09-03 23:52:58 +0300248</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400249</dl>
250</div>
251<div class="section" id="run-menu-editor-window-only">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400252<span id="index-2"></span><h3>Run menu (Editor window only)<a class="headerlink" href="#run-menu-editor-window-only" title="Permalink to this headline"></a></h3>
Tal Einat580bdb02019-09-03 23:52:58 +0300253<dl class="simple" id="run-module">
254<dt>Run Module</dt><dd><p>Do <a class="reference internal" href="#check-module"><span class="std std-ref">Check Module</span></a>. If no error, restart the shell to clean the
Terry Jan Reedy0053c472015-09-24 03:09:43 -0400255environment, then execute the module. Output is displayed in the Shell
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400256window. Note that output requires use of <code class="docutils literal notranslate"><span class="pre">print</span></code> or <code class="docutils literal notranslate"><span class="pre">write</span></code>.
Terry Jan Reedy0053c472015-09-24 03:09:43 -0400257When execution is complete, the Shell retains focus and displays a prompt.
258At this point, one may interactively explore the result of execution.
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400259This is similar to executing a file with <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-i</span> <span class="pre">file</span></code> at a command
Tal Einat580bdb02019-09-03 23:52:58 +0300260line.</p>
261</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400262</dl>
Tal Einat580bdb02019-09-03 23:52:58 +0300263<dl class="simple" id="run-custom">
264<dt>Run… Customized</dt><dd><p>Same as <a class="reference internal" href="#run-module"><span class="std std-ref">Run Module</span></a>, but run the module with customized
Cheryl Sabella201bc2d2019-06-17 22:24:10 -0400265settings. <em>Command Line Arguments</em> extend <a class="reference internal" href="sys.html#sys.argv" title="sys.argv"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.argv</span></code></a> as if passed
Tal Einat580bdb02019-09-03 23:52:58 +0300266on a command line. The module can be run in the Shell without restarting.</p>
267</dd>
Cheryl Sabella201bc2d2019-06-17 22:24:10 -0400268</dl>
Tal Einat580bdb02019-09-03 23:52:58 +0300269<dl class="simple" id="check-module">
270<dt>Check Module</dt><dd><p>Check the syntax of the module currently open in the Editor window. If the
Terry Jan Reedy14070292019-08-04 16:45:15 -0400271module has not been saved IDLE will either prompt the user to save or
272autosave, as selected in the General tab of the Idle Settings dialog. If
273there is a syntax error, the approximate location is indicated in the
Tal Einat580bdb02019-09-03 23:52:58 +0300274Editor window.</p>
275</dd>
Terry Jan Reedy14070292019-08-04 16:45:15 -0400276</dl>
Tal Einat580bdb02019-09-03 23:52:58 +0300277<dl class="simple" id="python-shell">
278<dt>Python Shell</dt><dd><p>Open or wake up the Python Shell window.</p>
279</dd>
Terry Jan Reedy14070292019-08-04 16:45:15 -0400280</dl>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400281</div>
282<div class="section" id="shell-menu-shell-window-only">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400283<h3>Shell menu (Shell window only)<a class="headerlink" href="#shell-menu-shell-window-only" title="Permalink to this headline"></a></h3>
Tal Einat580bdb02019-09-03 23:52:58 +0300284<dl class="simple">
285<dt>View Last Restart</dt><dd><p>Scroll the shell window to the last Shell restart.</p>
286</dd>
Terry Jan Reedy4cf7bb82021-02-21 02:44:11 -0500287<dt>Restart Shell</dt><dd><p>Restart the shell to clean the environment and reset display and exception handling.</p>
Tal Einat580bdb02019-09-03 23:52:58 +0300288</dd>
289<dt>Previous History</dt><dd><p>Cycle through earlier commands in history which match the current entry.</p>
290</dd>
291<dt>Next History</dt><dd><p>Cycle through later commands in history which match the current entry.</p>
292</dd>
293<dt>Interrupt Execution</dt><dd><p>Stop a running program.</p>
294</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400295</dl>
296</div>
297<div class="section" id="debug-menu-shell-window-only">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400298<h3>Debug menu (Shell window only)<a class="headerlink" href="#debug-menu-shell-window-only" title="Permalink to this headline"></a></h3>
Tal Einat580bdb02019-09-03 23:52:58 +0300299<dl class="simple">
300<dt>Go to File/Line</dt><dd><p>Look on the current line. with the cursor, and the line above for a filename
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400301and line number. If found, open the file if not already open, and show the
302line. Use this to view source lines referenced in an exception traceback
303and lines found by Find in Files. Also available in the context menu of
Tal Einat580bdb02019-09-03 23:52:58 +0300304the Shell window and Output windows.</p>
305</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400306</dl>
Tal Einat580bdb02019-09-03 23:52:58 +0300307<dl class="simple" id="index-3">
308<dt>Debugger (toggle)</dt><dd><p>When activated, code entered in the Shell or run from an Editor will run
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400309under the debugger. In the Editor, breakpoints can be set with the context
Tal Einat580bdb02019-09-03 23:52:58 +0300310menu. This feature is still incomplete and somewhat experimental.</p>
311</dd>
312<dt>Stack Viewer</dt><dd><p>Show the stack traceback of the last exception in a tree widget, with
313access to locals and globals.</p>
314</dd>
315<dt>Auto-open Stack Viewer</dt><dd><p>Toggle automatically opening the stack viewer on an unhandled exception.</p>
316</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400317</dl>
318</div>
319<div class="section" id="options-menu-shell-and-editor">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400320<h3>Options menu (Shell and Editor)<a class="headerlink" href="#options-menu-shell-and-editor" title="Permalink to this headline"></a></h3>
Tal Einat580bdb02019-09-03 23:52:58 +0300321<dl class="simple">
322<dt>Configure IDLE</dt><dd><p>Open a configuration dialog and change preferences for the following:
Terry Jan Reedy93f35422015-10-13 22:03:51 -0400323fonts, indentation, keybindings, text color themes, startup windows and
Terry Jan Reedy14070292019-08-04 16:45:15 -0400324size, additional help sources, and extensions. On macOS, open the
Terry Jan Reedy292cd6e2018-12-20 06:06:29 -0500325configuration dialog by selecting Preferences in the application
Terry Jan Reedy14070292019-08-04 16:45:15 -0400326menu. For more details, see
Tal Einat580bdb02019-09-03 23:52:58 +0300327<a class="reference internal" href="#preferences"><span class="std std-ref">Setting preferences</span></a> under Help and preferences.</p>
328</dd>
Terry Jan Reedy14070292019-08-04 16:45:15 -0400329</dl>
330<p>Most configuration options apply to all windows or all future windows.
331The option items below only apply to the active window.</p>
Tal Einat580bdb02019-09-03 23:52:58 +0300332<dl class="simple">
333<dt>Show/Hide Code Context (Editor Window only)</dt><dd><p>Open a pane at the top of the edit window which shows the block context
Cheryl Sabella01421be2018-12-20 00:38:54 -0500334of the code which has scrolled above the top of the window. See
Terry Jan Reedy14070292019-08-04 16:45:15 -0400335<a class="reference internal" href="#code-context"><span class="std std-ref">Code Context</span></a> in the Editing and Navigation section
Tal Einat580bdb02019-09-03 23:52:58 +0300336below.</p>
337</dd>
338<dt>Show/Hide Line Numbers (Editor Window only)</dt><dd><p>Open a column to the left of the edit window which shows the number
Terry Jan Reedy14070292019-08-04 16:45:15 -0400339of each line of text. The default is off, which may be changed in the
Tal Einat580bdb02019-09-03 23:52:58 +0300340preferences (see <a class="reference internal" href="#preferences"><span class="std std-ref">Setting preferences</span></a>).</p>
341</dd>
342<dt>Zoom/Restore Height</dt><dd><p>Toggles the window between normal size and maximum height. The initial size
Terry Jan Reedydf9b0322019-05-27 19:16:46 -0400343defaults to 40 lines by 80 chars unless changed on the General tab of the
Tal Einat5bff3c82019-06-17 22:41:00 +0300344Configure IDLE dialog. The maximum height for a screen is determined by
345momentarily maximizing a window the first time one is zoomed on the screen.
Terry Jan Reedy14070292019-08-04 16:45:15 -0400346Changing screen settings may invalidate the saved height. This toggle has
Tal Einat580bdb02019-09-03 23:52:58 +0300347no effect when a window is maximized.</p>
348</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400349</dl>
350</div>
351<div class="section" id="window-menu-shell-and-editor">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400352<h3>Window menu (Shell and Editor)<a class="headerlink" href="#window-menu-shell-and-editor" title="Permalink to this headline"></a></h3>
Cheryl Sabellac0381aa2018-12-28 15:11:30 -0500353<p>Lists the names of all open windows; select one to bring it to the foreground
354(deiconifying it if necessary).</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400355</div>
356<div class="section" id="help-menu-shell-and-editor">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400357<h3>Help menu (Shell and Editor)<a class="headerlink" href="#help-menu-shell-and-editor" title="Permalink to this headline"></a></h3>
Tal Einat580bdb02019-09-03 23:52:58 +0300358<dl class="simple">
359<dt>About IDLE</dt><dd><p>Display version, copyright, license, credits, and more.</p>
360</dd>
361<dt>IDLE Help</dt><dd><p>Display this IDLE document, detailing the menu options, basic editing and
362navigation, and other tips.</p>
363</dd>
364<dt>Python Docs</dt><dd><p>Access local Python documentation, if installed, or start a web browser
365and open docs.python.org showing the latest Python documentation.</p>
366</dd>
367<dt>Turtle Demo</dt><dd><p>Run the turtledemo module with example Python code and turtle drawings.</p>
368</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400369</dl>
370<p>Additional help sources may be added here with the Configure IDLE dialog under
Cheryl Sabella01421be2018-12-20 00:38:54 -0500371the General tab. See the <a class="reference internal" href="#help-sources"><span class="std std-ref">Help sources</span></a> subsection below
372for more on Help menu choices.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400373</div>
374<div class="section" id="context-menus">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400375<span id="index-4"></span><h3>Context Menus<a class="headerlink" href="#context-menus" title="Permalink to this headline"></a></h3>
Terry Jan Reedyb65413b2018-11-15 13:15:13 -0500376<p>Open a context menu by right-clicking in a window (Control-click on macOS).
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400377Context menus have the standard clipboard functions also on the Edit menu.</p>
Tal Einat580bdb02019-09-03 23:52:58 +0300378<dl class="simple">
379<dt>Cut</dt><dd><p>Copy selection into the system-wide clipboard; then delete the selection.</p>
380</dd>
381<dt>Copy</dt><dd><p>Copy selection into the system-wide clipboard.</p>
382</dd>
383<dt>Paste</dt><dd><p>Insert contents of the system-wide clipboard into the current window.</p>
384</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400385</dl>
386<p>Editor windows also have breakpoint functions. Lines with a breakpoint set are
387specially marked. Breakpoints only have an effect when running under the
Tal Einatd6c08db2020-01-06 01:51:48 +0200388debugger. Breakpoints for a file are saved in the user’s <code class="docutils literal notranslate"><span class="pre">.idlerc</span></code>
389directory.</p>
Tal Einat580bdb02019-09-03 23:52:58 +0300390<dl class="simple">
391<dt>Set Breakpoint</dt><dd><p>Set a breakpoint on the current line.</p>
392</dd>
393<dt>Clear Breakpoint</dt><dd><p>Clear the breakpoint on that line.</p>
394</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400395</dl>
Terry Jan Reedy68d6dc02018-10-28 12:44:44 -0400396<p>Shell and Output windows also have the following.</p>
Tal Einat580bdb02019-09-03 23:52:58 +0300397<dl class="simple">
398<dt>Go to file/line</dt><dd><p>Same as in Debug menu.</p>
399</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400400</dl>
Terry Jan Reedy55d03512019-04-26 23:22:36 -0400401<p>The Shell window also has an output squeezing facility explained in the <em>Python
402Shell window</em> subsection below.</p>
Tal Einat580bdb02019-09-03 23:52:58 +0300403<dl class="simple">
404<dt>Squeeze</dt><dd><p>If the cursor is over an output line, squeeze all the output between
405the code above and the prompt below down to a ‘Squeezed text’ label.</p>
406</dd>
Terry Jan Reedy68d6dc02018-10-28 12:44:44 -0400407</dl>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400408</div>
409</div>
410<div class="section" id="editing-and-navigation">
Cheryl Sabella01421be2018-12-20 00:38:54 -0500411<span id="id2"></span><h2>Editing and navigation<a class="headerlink" href="#editing-and-navigation" title="Permalink to this headline"></a></h2>
Terry Jan Reedyea9c8bd2018-10-28 20:42:18 -0400412<div class="section" id="editor-windows">
413<h3>Editor windows<a class="headerlink" href="#editor-windows" title="Permalink to this headline"></a></h3>
414<p>IDLE may open editor windows when it starts, depending on settings
415and how you start IDLE. Thereafter, use the File menu. There can be only
416one open editor window for a given file.</p>
417<p>The title bar contains the name of the file, the full path, and the version
418of Python and IDLE running the window. The status bar contains the line
419number (‘Ln’) and column number (‘Col’). Line numbers start with 1;
420column numbers with 0.</p>
421<p>IDLE assumes that files with a known .py* extension contain Python code
422and that other files do not. Run Python code with the Run menu.</p>
423</div>
424<div class="section" id="key-bindings">
425<h3>Key bindings<a class="headerlink" href="#key-bindings" title="Permalink to this headline"></a></h3>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400426<p>In this section, ‘C’ refers to the <kbd class="kbd docutils literal notranslate">Control</kbd> key on Windows and Unix and
Terry Jan Reedyb65413b2018-11-15 13:15:13 -0500427the <kbd class="kbd docutils literal notranslate">Command</kbd> key on macOS.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400428<ul>
Tal Einat580bdb02019-09-03 23:52:58 +0300429<li><p><kbd class="kbd docutils literal notranslate">Backspace</kbd> deletes to the left; <kbd class="kbd docutils literal notranslate">Del</kbd> deletes to the right</p></li>
Terry Jan Reedya460d452020-10-20 20:56:01 -0400430<li><p><kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">C</kbd>-<kbd class="kbd docutils literal notranslate">Backspace</kbd></kbd> delete word left; <kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">C</kbd>-<kbd class="kbd docutils literal notranslate">Del</kbd></kbd> delete word to the right</p></li>
431<li><p>Arrow keys and <kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Page</kbd> <kbd class="kbd docutils literal notranslate">Up</kbd></kbd>/<kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Page</kbd> <kbd class="kbd docutils literal notranslate">Down</kbd></kbd> to move around</p></li>
432<li><p><kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">C</kbd>-<kbd class="kbd docutils literal notranslate">LeftArrow</kbd></kbd> and <kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">C</kbd>-<kbd class="kbd docutils literal notranslate">RightArrow</kbd></kbd> moves by words</p></li>
Tal Einat580bdb02019-09-03 23:52:58 +0300433<li><p><kbd class="kbd docutils literal notranslate">Home</kbd>/<kbd class="kbd docutils literal notranslate">End</kbd> go to begin/end of line</p></li>
Terry Jan Reedya460d452020-10-20 20:56:01 -0400434<li><p><kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">C</kbd>-<kbd class="kbd docutils literal notranslate">Home</kbd></kbd>/<kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">C</kbd>-<kbd class="kbd docutils literal notranslate">End</kbd></kbd> go to begin/end of file</p></li>
Tal Einat580bdb02019-09-03 23:52:58 +0300435<li><p>Some useful Emacs bindings are inherited from Tcl/Tk:</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400436<blockquote>
437<div><ul class="simple">
Terry Jan Reedya460d452020-10-20 20:56:01 -0400438<li><p><kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">C</kbd>-<kbd class="kbd docutils literal notranslate">a</kbd></kbd> beginning of line</p></li>
439<li><p><kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">C</kbd>-<kbd class="kbd docutils literal notranslate">e</kbd></kbd> end of line</p></li>
440<li><p><kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">C</kbd>-<kbd class="kbd docutils literal notranslate">k</kbd></kbd> kill line (but doesn’t put it in clipboard)</p></li>
441<li><p><kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">C</kbd>-<kbd class="kbd docutils literal notranslate">l</kbd></kbd> center window around the insertion point</p></li>
442<li><p><kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">C</kbd>-<kbd class="kbd docutils literal notranslate">b</kbd></kbd> go backward one character without deleting (usually you can
Tal Einat580bdb02019-09-03 23:52:58 +0300443also use the cursor key for this)</p></li>
Terry Jan Reedya460d452020-10-20 20:56:01 -0400444<li><p><kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">C</kbd>-<kbd class="kbd docutils literal notranslate">f</kbd></kbd> go forward one character without deleting (usually you can
Tal Einat580bdb02019-09-03 23:52:58 +0300445also use the cursor key for this)</p></li>
Terry Jan Reedya460d452020-10-20 20:56:01 -0400446<li><p><kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">C</kbd>-<kbd class="kbd docutils literal notranslate">p</kbd></kbd> go up one line (usually you can also use the cursor key for
Tal Einat580bdb02019-09-03 23:52:58 +0300447this)</p></li>
Terry Jan Reedya460d452020-10-20 20:56:01 -0400448<li><p><kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">C</kbd>-<kbd class="kbd docutils literal notranslate">d</kbd></kbd> delete next character</p></li>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400449</ul>
450</div></blockquote>
451</li>
452</ul>
Terry Jan Reedya460d452020-10-20 20:56:01 -0400453<p>Standard keybindings (like <kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">C</kbd>-<kbd class="kbd docutils literal notranslate">c</kbd></kbd> to copy and <kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">C</kbd>-<kbd class="kbd docutils literal notranslate">v</kbd></kbd> to paste)
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400454may work. Keybindings are selected in the Configure IDLE dialog.</p>
Terry Jan Reedyea9c8bd2018-10-28 20:42:18 -0400455</div>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400456<div class="section" id="automatic-indentation">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400457<h3>Automatic indentation<a class="headerlink" href="#automatic-indentation" title="Permalink to this headline"></a></h3>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400458<p>After a block-opening statement, the next line is indented by 4 spaces (in the
459Python Shell window by one tab). After certain keywords (break, return etc.)
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400460the next line is dedented. In leading indentation, <kbd class="kbd docutils literal notranslate">Backspace</kbd> deletes up
461to 4 spaces if they are there. <kbd class="kbd docutils literal notranslate">Tab</kbd> inserts spaces (in the Python
terryjreedy188aedf2017-06-13 21:32:16 -0400462Shell window one tab), number depends on Indent width. Currently, tabs
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400463are restricted to four spaces due to Tcl/Tk limitations.</p>
Terry Jan Reedy292cd6e2018-12-20 06:06:29 -0500464<p>See also the indent/dedent region commands on the
465<a class="reference internal" href="#format-menu"><span class="std std-ref">Format menu</span></a>.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400466</div>
467<div class="section" id="completions">
Cheryl Sabella01421be2018-12-20 00:38:54 -0500468<span id="id3"></span><h3>Completions<a class="headerlink" href="#completions" title="Permalink to this headline"></a></h3>
Terry Jan Reedybce2eb42020-07-09 18:08:33 -0400469<p>Completions are supplied, when requested and available, for module
470names, attributes of classes or functions, or filenames. Each request
471method displays a completion box with existing names. (See tab
472completions below for an exception.) For any box, change the name
473being completed and the item highlighted in the box by
474typing and deleting characters; by hitting <kbd class="kbd docutils literal notranslate">Up</kbd>, <kbd class="kbd docutils literal notranslate">Down</kbd>,
475<kbd class="kbd docutils literal notranslate">PageUp</kbd>, <kbd class="kbd docutils literal notranslate">PageDown</kbd>, <kbd class="kbd docutils literal notranslate">Home</kbd>, and <kbd class="kbd docutils literal notranslate">End</kbd> keys;
476and by a single click within the box. Close the box with <kbd class="kbd docutils literal notranslate">Escape</kbd>,
477<kbd class="kbd docutils literal notranslate">Enter</kbd>, and double <kbd class="kbd docutils literal notranslate">Tab</kbd> keys or clicks outside the box.
478A double click within the box selects and closes.</p>
479<p>One way to open a box is to type a key character and wait for a
480predefined interval. This defaults to 2 seconds; customize it
481in the settings dialog. (To prevent auto popups, set the delay to a
482large number of milliseconds, such as 100000000.) For imported module
483names or class or function attributes, type ‘.’.
484For filenames in the root directory, type <a class="reference internal" href="os.html#os.sep" title="os.sep"><code class="xref py py-data docutils literal notranslate"><span class="pre">os.sep</span></code></a> or
Terry Jan Reedy47124712020-09-09 18:53:18 -0400485<a class="reference internal" href="os.html#os.altsep" title="os.altsep"><code class="xref py py-data docutils literal notranslate"><span class="pre">os.altsep</span></code></a> immediately after an opening quote. (On Windows,
Terry Jan Reedybce2eb42020-07-09 18:08:33 -0400486one can specify a drive first.) Move into subdirectories by typing a
487directory name and a separator.</p>
Terry Jan Reedy47124712020-09-09 18:53:18 -0400488<p>Instead of waiting, or after a box is closed, open a completion box
Terry Jan Reedybce2eb42020-07-09 18:08:33 -0400489immediately with Show Completions on the Edit menu. The default hot
Terry Jan Reedya460d452020-10-20 20:56:01 -0400490key is <kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">C</kbd>-<kbd class="kbd docutils literal notranslate">space</kbd></kbd>. If one types a prefix for the desired name
Terry Jan Reedy47124712020-09-09 18:53:18 -0400491before opening the box, the first match or near miss is made visible.
Terry Jan Reedybce2eb42020-07-09 18:08:33 -0400492The result is the same as if one enters a prefix
493after the box is displayed. Show Completions after a quote completes
494filenames in the current directory instead of a root directory.</p>
495<p>Hitting <kbd class="kbd docutils literal notranslate">Tab</kbd> after a prefix usually has the same effect as Show
496Completions. (With no prefix, it indents.) However, if there is only
497one match to the prefix, that match is immediately added to the editor
498text without opening a box.</p>
499<p>Invoking ‘Show Completions’, or hitting <kbd class="kbd docutils literal notranslate">Tab</kbd> after a prefix,
500outside of a string and without a preceding ‘.’ opens a box with
501keywords, builtin names, and available module-level names.</p>
502<p>When editing code in an editor (as oppose to Shell), increase the
503available module-level names by running your code
504and not restarting the Shell thereafter. This is especially useful
505after adding imports at the top of a file. This also increases
506possible attribute completions.</p>
507<p>Completion boxes intially exclude names beginning with ‘_’ or, for
508modules, not included in ‘__all__’. The hidden names can be accessed
509by typing ‘_’ after ‘.’, either before or after the box is opened.</p>
Terry Jan Reedy37f81352015-09-29 01:55:57 -0400510</div>
511<div class="section" id="calltips">
Cheryl Sabella01421be2018-12-20 00:38:54 -0500512<span id="id4"></span><h3>Calltips<a class="headerlink" href="#calltips" title="Permalink to this headline"></a></h3>
Terry Jan Reedy947adca2020-09-22 13:21:58 -0400513<p>A calltip is shown automatically when one types <kbd class="kbd docutils literal notranslate">(</kbd> after the name
514of an <em>accessible</em> function. A function name expression may include
515dots and subscripts. A calltip remains until it is clicked, the cursor
516is moved out of the argument area, or <kbd class="kbd docutils literal notranslate">)</kbd> is typed. Whenever the
517cursor is in the argument part of a definition, select Edit and “Show
518Call Tip” on the menu or enter its shortcut to display a calltip.</p>
519<p>The calltip consists of the function’s signature and docstring up to
520the latter’s first blank line or the fifth non-blank line. (Some builtin
521functions lack an accessible signature.) A ‘/’ or ‘*’ in the signature
522indicates that the preceding or following arguments are passed by
523position or name (keyword) only. Details are subject to change.</p>
524<p>In Shell, the accessible functions depends on what modules have been
525imported into the user process, including those imported by Idle itself,
526and which definitions have been run, all since the last restart.</p>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400527<p>For example, restart the Shell and enter <code class="docutils literal notranslate"><span class="pre">itertools.count(</span></code>. A calltip
Terry Jan Reedy947adca2020-09-22 13:21:58 -0400528appears because Idle imports itertools into the user process for its own
529use. (This could change.) Enter <code class="docutils literal notranslate"><span class="pre">turtle.write(</span></code> and nothing appears.
530Idle does not itself import turtle. The menu entry and shortcut also do
531nothing. Enter <code class="docutils literal notranslate"><span class="pre">import</span> <span class="pre">turtle</span></code>. Thereafter, <code class="docutils literal notranslate"><span class="pre">turtle.write(</span></code>
532will display a calltip.</p>
533<p>In an editor, import statements have no effect until one runs the file.
534One might want to run a file after writing import statements, after
535adding function definitions, or after opening an existing file.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400536</div>
Cheryl Sabella01421be2018-12-20 00:38:54 -0500537<div class="section" id="code-context">
538<span id="id5"></span><h3>Code Context<a class="headerlink" href="#code-context" title="Permalink to this headline"></a></h3>
539<p>Within an editor window containing Python code, code context can be toggled
540in order to show or hide a pane at the top of the window. When shown, this
541pane freezes the opening lines for block code, such as those beginning with
542<code class="docutils literal notranslate"><span class="pre">class</span></code>, <code class="docutils literal notranslate"><span class="pre">def</span></code>, or <code class="docutils literal notranslate"><span class="pre">if</span></code> keywords, that would have otherwise scrolled
543out of view. The size of the pane will be expanded and contracted as needed
544to show the all current levels of context, up to the maximum number of
545lines defined in the Configure IDLE dialog (which defaults to 15). If there
546are no current context lines and the feature is toggled on, a single blank
547line will display. Clicking on a line in the context pane will move that
548line to the top of the editor.</p>
549<p>The text and background colors for the context pane can be configured under
550the Highlights tab in the Configure IDLE dialog.</p>
551</div>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400552<div class="section" id="python-shell-window">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400553<h3>Python Shell window<a class="headerlink" href="#python-shell-window" title="Permalink to this headline"></a></h3>
Terry Jan Reedy75d9d592018-11-06 12:37:36 -0500554<p>With IDLE’s Shell, one enters, edits, and recalls complete statements.
555Most consoles and terminals only work with a single physical line at a time.</p>
556<p>When one pastes code into Shell, it is not compiled and possibly executed
557until one hits <kbd class="kbd docutils literal notranslate">Return</kbd>. One may edit pasted code first.
558If one pastes more that one statement into Shell, the result will be a
559<a class="reference internal" href="exceptions.html#SyntaxError" title="SyntaxError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">SyntaxError</span></code></a> when multiple statements are compiled as if they were one.</p>
560<p>The editing features described in previous subsections work when entering
561code interactively. IDLE’s Shell window also responds to the following keys.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400562<ul>
Terry Jan Reedya460d452020-10-20 20:56:01 -0400563<li><p><kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">C</kbd>-<kbd class="kbd docutils literal notranslate">c</kbd></kbd> interrupts executing command</p></li>
564<li><p><kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">C</kbd>-<kbd class="kbd docutils literal notranslate">d</kbd></kbd> sends end-of-file; closes window if typed at a <code class="docutils literal notranslate"><span class="pre">&gt;&gt;&gt;</span></code> prompt</p></li>
565<li><p><kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Alt</kbd>-<kbd class="kbd docutils literal notranslate">/</kbd></kbd> (Expand word) is also useful to reduce typing</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400566<p>Command history</p>
567<ul class="simple">
Terry Jan Reedya460d452020-10-20 20:56:01 -0400568<li><p><kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Alt</kbd>-<kbd class="kbd docutils literal notranslate">p</kbd></kbd> retrieves previous command matching what you have typed. On
569macOS use <kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">C</kbd>-<kbd class="kbd docutils literal notranslate">p</kbd></kbd>.</p></li>
570<li><p><kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Alt</kbd>-<kbd class="kbd docutils literal notranslate">n</kbd></kbd> retrieves next. On macOS use <kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">C</kbd>-<kbd class="kbd docutils literal notranslate">n</kbd></kbd>.</p></li>
Tal Einat580bdb02019-09-03 23:52:58 +0300571<li><p><kbd class="kbd docutils literal notranslate">Return</kbd> while on any previous command retrieves that command</p></li>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400572</ul>
573</li>
574</ul>
575</div>
Terry Jan Reedyce021db2015-09-24 23:18:57 -0400576<div class="section" id="text-colors">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400577<h3>Text colors<a class="headerlink" href="#text-colors" title="Permalink to this headline"></a></h3>
Terry Jan Reedyce021db2015-09-24 23:18:57 -0400578<p>Idle defaults to black on white text, but colors text with special meanings.
579For the shell, these are shell output, shell error, user output, and
580user error. For Python code, at the shell prompt or in an editor, these are
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400581keywords, builtin class and function names, names following <code class="docutils literal notranslate"><span class="pre">class</span></code> and
582<code class="docutils literal notranslate"><span class="pre">def</span></code>, strings, and comments. For any text window, these are the cursor (when
Terry Jan Reedyce021db2015-09-24 23:18:57 -0400583present), found text (when possible), and selected text.</p>
584<p>Text coloring is done in the background, so uncolorized text is occasionally
585visible. To change the color scheme, use the Configure IDLE dialog
586Highlighting tab. The marking of debugger breakpoint lines in the editor and
587text in popups and dialogs is not user-configurable.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400588</div>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400589</div>
Terry Jan Reedy0053c472015-09-24 03:09:43 -0400590<div class="section" id="startup-and-code-execution">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400591<h2>Startup and code execution<a class="headerlink" href="#startup-and-code-execution" title="Permalink to this headline"></a></h2>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400592<p>Upon startup with the <code class="docutils literal notranslate"><span class="pre">-s</span></code> option, IDLE will execute the file referenced by
593the environment variables <span class="target" id="index-5"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">IDLESTARTUP</span></code> or <span class="target" id="index-6"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONSTARTUP"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONSTARTUP</span></code></a>.
594IDLE first checks for <code class="docutils literal notranslate"><span class="pre">IDLESTARTUP</span></code>; if <code class="docutils literal notranslate"><span class="pre">IDLESTARTUP</span></code> is present the file
595referenced is run. If <code class="docutils literal notranslate"><span class="pre">IDLESTARTUP</span></code> is not present, IDLE checks for
596<code class="docutils literal notranslate"><span class="pre">PYTHONSTARTUP</span></code>. Files referenced by these environment variables are
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400597convenient places to store functions that are used frequently from the IDLE
598shell, or for executing import statements to import common modules.</p>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400599<p>In addition, <code class="docutils literal notranslate"><span class="pre">Tk</span></code> also loads a startup file if it is present. Note that the
600Tk file is loaded unconditionally. This additional file is <code class="docutils literal notranslate"><span class="pre">.Idle.py</span></code> and is
601looked for in the user’s home directory. Statements in this file will be
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400602executed in the Tk namespace, so this file is not useful for importing
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400603functions to be used from IDLE’s Python shell.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400604<div class="section" id="command-line-usage">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400605<h3>Command line usage<a class="headerlink" href="#command-line-usage" title="Permalink to this headline"></a></h3>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400606<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>idle.py [-c command] [-d] [-e] [-h] [-i] [-r file] [-s] [-t title] [-] [arg] ...
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400607
Terry Jan Reedy968e2852015-09-23 03:52:23 -0400608-c command run command in the shell window
609-d enable debugger and open shell window
610-e open editor window
Terry Jan Reedy3399e1e2016-08-30 16:58:01 -0400611-h print help message with legal combinations and exit
Terry Jan Reedy968e2852015-09-23 03:52:23 -0400612-i open shell window
613-r file run file in shell window
614-s run $IDLESTARTUP or $PYTHONSTARTUP first, in shell window
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400615-t title set title of shell window
Terry Jan Reedy968e2852015-09-23 03:52:23 -0400616- run stdin in shell (- must be last option before args)
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400617</pre></div>
618</div>
619<p>If there are arguments:</p>
Terry Jan Reedy968e2852015-09-23 03:52:23 -0400620<ul class="simple">
Tal Einat580bdb02019-09-03 23:52:58 +0300621<li><p>If <code class="docutils literal notranslate"><span class="pre">-</span></code>, <code class="docutils literal notranslate"><span class="pre">-c</span></code>, or <code class="docutils literal notranslate"><span class="pre">r</span></code> is used, all arguments are placed in
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400622<code class="docutils literal notranslate"><span class="pre">sys.argv[1:...]</span></code> and <code class="docutils literal notranslate"><span class="pre">sys.argv[0]</span></code> is set to <code class="docutils literal notranslate"><span class="pre">''</span></code>, <code class="docutils literal notranslate"><span class="pre">'-c'</span></code>,
623or <code class="docutils literal notranslate"><span class="pre">'-r'</span></code>. No editor window is opened, even if that is the default
Tal Einat580bdb02019-09-03 23:52:58 +0300624set in the Options dialog.</p></li>
625<li><p>Otherwise, arguments are files opened for editing and
626<code class="docutils literal notranslate"><span class="pre">sys.argv</span></code> reflects the arguments passed to IDLE itself.</p></li>
Terry Jan Reedy968e2852015-09-23 03:52:23 -0400627</ul>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400628</div>
terryjreedy188aedf2017-06-13 21:32:16 -0400629<div class="section" id="startup-failure">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400630<h3>Startup failure<a class="headerlink" href="#startup-failure" title="Permalink to this headline"></a></h3>
terryjreedy188aedf2017-06-13 21:32:16 -0400631<p>IDLE uses a socket to communicate between the IDLE GUI process and the user
632code execution process. A connection must be established whenever the Shell
633starts or restarts. (The latter is indicated by a divider line that says
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400634‘RESTART’). If the user process fails to connect to the GUI process, it
Terry Jan Reedy1b4a9c72021-03-31 01:19:38 -0400635usually displays a <code class="docutils literal notranslate"><span class="pre">Tk</span></code> error box with a ‘cannot connect’ message
636that directs the user here. It then exits.</p>
637<p>One specific connection failure on Unix systems results from
638misconfigured masquerading rules somewhere in a system’s network setup.
639When IDLE is started from a terminal, one will see a message starting
640with <code class="docutils literal notranslate"><span class="pre">**</span> <span class="pre">Invalid</span> <span class="pre">host:</span></code>.
641The valid value is <code class="docutils literal notranslate"><span class="pre">127.0.0.1</span> <span class="pre">(idlelib.rpc.LOCALHOST)</span></code>.
642One can diagnose with <code class="docutils literal notranslate"><span class="pre">tcpconnect</span> <span class="pre">-irv</span> <span class="pre">127.0.0.1</span> <span class="pre">6543</span></code> in one
643terminal window and <code class="docutils literal notranslate"><span class="pre">tcplisten</span> <span class="pre">&lt;same</span> <span class="pre">args&gt;</span></code> in another.</p>
terryjreedy188aedf2017-06-13 21:32:16 -0400644<p>A common cause of failure is a user-written file with the same name as a
645standard library module, such as <em>random.py</em> and <em>tkinter.py</em>. When such a
646file is located in the same directory as a file that is about to be run,
647IDLE cannot import the stdlib file. The current fix is to rename the
648user file.</p>
649<p>Though less common than in the past, an antivirus or firewall program may
650stop the connection. If the program cannot be taught to allow the
651connection, then it must be turned off for IDLE to work. It is safe to
652allow this internal connection because no data is visible on external
653ports. A similar problem is a network mis-configuration that blocks
654connections.</p>
655<p>Python installation issues occasionally stop IDLE: multiple versions can
656clash, or a single installation might need admin access. If one undo the
657clash, or cannot or does not want to run as admin, it might be easiest to
658completely remove Python and start over.</p>
659<p>A zombie pythonw.exe process could be a problem. On Windows, use Task
Terry Jan Reedy2522db12020-03-08 14:32:42 -0400660Manager to check for one and stop it if there is. Sometimes a restart
661initiated by a program crash or Keyboard Interrupt (control-C) may fail
662to connect. Dismissing the error box or using Restart Shell on the Shell
663menu may fix a temporary problem.</p>
terryjreedy188aedf2017-06-13 21:32:16 -0400664<p>When IDLE first starts, it attempts to read user configuration files in
Tal Einatd6c08db2020-01-06 01:51:48 +0200665<code class="docutils literal notranslate"><span class="pre">~/.idlerc/</span></code> (~ is one’s home directory). If there is a problem, an error
terryjreedy188aedf2017-06-13 21:32:16 -0400666message should be displayed. Leaving aside random disk glitches, this can
Terry Jan Reedy2522db12020-03-08 14:32:42 -0400667be prevented by never editing the files by hand. Instead, use the
668configuration dialog, under Options. Once there is an error in a user
669configuration file, the best solution may be to delete it and start over
670with the settings dialog.</p>
terryjreedy188aedf2017-06-13 21:32:16 -0400671<p>If IDLE quits with no message, and it was not started from a console, try
Terry Jan Reedy2522db12020-03-08 14:32:42 -0400672starting it from a console or terminal (<code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-m</span> <span class="pre">idlelib</span></code>) and see if
673this results in an error message.</p>
Terry Jan Reedy1b4a9c72021-03-31 01:19:38 -0400674<p>On Unix-based systems with tcl/tk older than <code class="docutils literal notranslate"><span class="pre">8.6.11</span></code> (see
675<code class="docutils literal notranslate"><span class="pre">About</span> <span class="pre">IDLE</span></code>) certain characters of certain fonts can cause
676a tk failure with a message to the terminal. This can happen either
677if one starts IDLE to edit a file with such a character or later
678when entering such a character. If one cannot upgrade tcl/tk,
679then re-configure IDLE to use a font that works better.</p>
terryjreedy188aedf2017-06-13 21:32:16 -0400680</div>
Terry Jan Reedyf1d3efc2018-11-05 22:17:57 -0500681<div class="section" id="running-user-code">
682<h3>Running user code<a class="headerlink" href="#running-user-code" title="Permalink to this headline"></a></h3>
Terry Jan Reedy98758bc2017-09-12 09:05:16 -0400683<p>With rare exceptions, the result of executing Python code with IDLE is
Terry Jan Reedyf1d3efc2018-11-05 22:17:57 -0500684intended to be the same as executing the same code by the default method,
685directly with Python in a text-mode system console or terminal window.
Terry Jan Reedy98758bc2017-09-12 09:05:16 -0400686However, the different interface and operation occasionally affect
Terry Jan Reedyf1d3efc2018-11-05 22:17:57 -0500687visible results. For instance, <code class="docutils literal notranslate"><span class="pre">sys.modules</span></code> starts with more entries,
688and <code class="docutils literal notranslate"><span class="pre">threading.activeCount()</span></code> returns 2 instead of 1.</p>
689<p>By default, IDLE runs user code in a separate OS process rather than in
690the user interface process that runs the shell and editor. In the execution
691process, it replaces <code class="docutils literal notranslate"><span class="pre">sys.stdin</span></code>, <code class="docutils literal notranslate"><span class="pre">sys.stdout</span></code>, and <code class="docutils literal notranslate"><span class="pre">sys.stderr</span></code>
692with objects that get input from and send output to the Shell window.
693The original values stored in <code class="docutils literal notranslate"><span class="pre">sys.__stdin__</span></code>, <code class="docutils literal notranslate"><span class="pre">sys.__stdout__</span></code>, and
694<code class="docutils literal notranslate"><span class="pre">sys.__stderr__</span></code> are not touched, but may be <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>
Terry Jan Reedy2827e8a2021-02-23 19:39:51 -0500695<p>Sending print output from one process to a text widget in another is
696slower than printing to a system terminal in the same process.
697This has the most effect when printing multiple arguments, as the string
698for each argument, each separator, the newline are sent separately.
699For development, this is usually not a problem, but if one wants to
700print faster in IDLE, format and join together everything one wants
701displayed together and then print a single string. Both format strings
702and <a class="reference internal" href="stdtypes.html#str.join" title="str.join"><code class="xref py py-meth docutils literal notranslate"><span class="pre">str.join()</span></code></a> can help combine fields and lines.</p>
Terry Jan Reedy4cf7bb82021-02-21 02:44:11 -0500703<p>IDLE’s standard stream replacements are not inherited by subprocesses
704created in the execution process, whether directly by user code or by
705modules such as multiprocessing. If such subprocess use <code class="docutils literal notranslate"><span class="pre">input</span></code> from
706sys.stdin or <code class="docutils literal notranslate"><span class="pre">print</span></code> or <code class="docutils literal notranslate"><span class="pre">write</span></code> to sys.stdout or sys.stderr,
707IDLE should be started in a command line window. The secondary subprocess
708will then be attached to that window for input and output.</p>
709<p>If <code class="docutils literal notranslate"><span class="pre">sys</span></code> is reset by user code, such as with <code class="docutils literal notranslate"><span class="pre">importlib.reload(sys)</span></code>,
710IDLE’s changes are lost and input from the keyboard and output to the screen
711will not work correctly.</p>
Terry Jan Reedyf1d3efc2018-11-05 22:17:57 -0500712<p>When Shell has the focus, it controls the keyboard and screen. This is
Terry Jan Reedy98758bc2017-09-12 09:05:16 -0400713normally transparent, but functions that directly access the keyboard
Terry Jan Reedyf1d3efc2018-11-05 22:17:57 -0500714and screen will not work. These include system-specific functions that
715determine whether a key has been pressed and if so, which.</p>
Tal Einatfcf1d002019-07-06 15:35:24 +0300716<p>The IDLE code running in the execution process adds frames to the call stack
717that would not be there otherwise. IDLE wraps <code class="docutils literal notranslate"><span class="pre">sys.getrecursionlimit</span></code> and
Terry Jan Reedy4cf7bb82021-02-21 02:44:11 -0500718<code class="docutils literal notranslate"><span class="pre">sys.setrecursionlimit</span></code> to reduce the effect of the additional stack
719frames.</p>
720<p>When user code raises SystemExit either directly or by calling sys.exit,
721IDLE returns to a Shell prompt instead of exiting.</p>
Terry Jan Reedy0053c472015-09-24 03:09:43 -0400722</div>
Terry Jan Reedy75d9d592018-11-06 12:37:36 -0500723<div class="section" id="user-output-in-shell">
724<h3>User output in Shell<a class="headerlink" href="#user-output-in-shell" title="Permalink to this headline"></a></h3>
725<p>When a program outputs text, the result is determined by the
726corresponding output device. When IDLE executes user code, <code class="docutils literal notranslate"><span class="pre">sys.stdout</span></code>
727and <code class="docutils literal notranslate"><span class="pre">sys.stderr</span></code> are connected to the display area of IDLE’s Shell. Some of
728its features are inherited from the underlying Tk Text widget. Others
Terry Jan Reedy76cd0c32018-11-06 23:55:06 -0500729are programmed additions. Where it matters, Shell is designed for development
730rather than production runs.</p>
731<p>For instance, Shell never throws away output. A program that sends unlimited
732output to Shell will eventually fill memory, resulting in a memory error.
733In contrast, some system text windows only keep the last n lines of output.
734A Windows console, for instance, keeps a user-settable 1 to 9999 lines,
735with 300 the default.</p>
Terry Jan Reedy55d03512019-04-26 23:22:36 -0400736<p>A Tk Text widget, and hence IDLE’s Shell, displays characters (codepoints) in
737the BMP (Basic Multilingual Plane) subset of Unicode. Which characters are
738displayed with a proper glyph and which with a replacement box depends on the
739operating system and installed fonts. Tab characters cause the following text
740to begin after the next tab stop. (They occur every 8 ‘characters’). Newline
741characters cause following text to appear on a new line. Other control
742characters are ignored or displayed as a space, box, or something else,
743depending on the operating system and font. (Moving the text cursor through
744such output with arrow keys may exhibit some surprising spacing behavior.)</p>
745<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">s</span> <span class="o">=</span> <span class="s1">&#39;a</span><span class="se">\t</span><span class="s1">b</span><span class="se">\a</span><span class="s1">&lt;</span><span class="se">\x02</span><span class="s1">&gt;&lt;</span><span class="se">\r</span><span class="s1">&gt;</span><span class="se">\b</span><span class="s1">c</span><span class="se">\n</span><span class="s1">d&#39;</span> <span class="c1"># Enter 22 chars.</span>
746<span class="gp">&gt;&gt;&gt; </span><span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
747<span class="go">14</span>
748<span class="gp">&gt;&gt;&gt; </span><span class="n">s</span> <span class="c1"># Display repr(s)</span>
749<span class="go">&#39;a\tb\x07&lt;\x02&gt;&lt;\r&gt;\x08c\nd&#39;</span>
750<span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">end</span><span class="o">=</span><span class="s1">&#39;&#39;</span><span class="p">)</span> <span class="c1"># Display s as is.</span>
751<span class="go"># Result varies by OS and font. Try it.</span>
Terry Jan Reedy8a03ff22019-02-08 22:51:51 -0500752</pre></div>
753</div>
754<p>The <code class="docutils literal notranslate"><span class="pre">repr</span></code> function is used for interactive echo of expression
755values. It returns an altered version of the input string in which
756control codes, some BMP codepoints, and all non-BMP codepoints are
757replaced with escape codes. As demonstrated above, it allows one to
758identify the characters in a string, regardless of how they are displayed.</p>
Terry Jan Reedy75d9d592018-11-06 12:37:36 -0500759<p>Normal and error output are generally kept separate (on separate lines)
760from code input and each other. They each get different highlight colors.</p>
761<p>For SyntaxError tracebacks, the normal ‘^’ marking where the error was
762detected is replaced by coloring the text with an error highlight.
763When code run from a file causes other exceptions, one may right click
764on a traceback line to jump to the corresponding line in an IDLE editor.
765The file will be opened if necessary.</p>
766<p>Shell has a special facility for squeezing output lines down to a
767‘Squeezed text’ label. This is done automatically
768for output over N lines (N = 50 by default).
769N can be changed in the PyShell section of the General
770page of the Settings dialog. Output with fewer lines can be squeezed by
771right clicking on the output. This can be useful lines long enough to slow
772down scrolling.</p>
773<p>Squeezed output is expanded in place by double-clicking the label.
774It can also be sent to the clipboard or a separate view window by
775right-clicking the label.</p>
776</div>
Terry Jan Reedy98758bc2017-09-12 09:05:16 -0400777<div class="section" id="developing-tkinter-applications">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400778<h3>Developing tkinter applications<a class="headerlink" href="#developing-tkinter-applications" title="Permalink to this headline"></a></h3>
Terry Jan Reedy98758bc2017-09-12 09:05:16 -0400779<p>IDLE is intentionally different from standard Python in order to
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400780facilitate development of tkinter programs. Enter <code class="docutils literal notranslate"><span class="pre">import</span> <span class="pre">tkinter</span> <span class="pre">as</span> <span class="pre">tk;</span>
Terry Jan Reedy98758bc2017-09-12 09:05:16 -0400781<span class="pre">root</span> <span class="pre">=</span> <span class="pre">tk.Tk()</span></code> in standard Python and nothing appears. Enter the same
782in IDLE and a tk window appears. In standard Python, one must also enter
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400783<code class="docutils literal notranslate"><span class="pre">root.update()</span></code> to see the window. IDLE does the equivalent in the
penguindustin96466302019-05-06 14:57:17 -0400784background, about 20 times a second, which is about every 50 milliseconds.
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400785Next enter <code class="docutils literal notranslate"><span class="pre">b</span> <span class="pre">=</span> <span class="pre">tk.Button(root,</span> <span class="pre">text='button');</span> <span class="pre">b.pack()</span></code>. Again,
786nothing visibly changes in standard Python until one enters <code class="docutils literal notranslate"><span class="pre">root.update()</span></code>.</p>
787<p>Most tkinter programs run <code class="docutils literal notranslate"><span class="pre">root.mainloop()</span></code>, which usually does not
Terry Jan Reedy98758bc2017-09-12 09:05:16 -0400788return until the tk app is destroyed. If the program is run with
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400789<code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-i</span></code> or from an IDLE editor, a <code class="docutils literal notranslate"><span class="pre">&gt;&gt;&gt;</span></code> shell prompt does not
790appear until <code class="docutils literal notranslate"><span class="pre">mainloop()</span></code> returns, at which time there is nothing left
Terry Jan Reedy98758bc2017-09-12 09:05:16 -0400791to interact with.</p>
792<p>When running a tkinter program from an IDLE editor, one can comment out
793the mainloop call. One then gets a shell prompt immediately and can
794interact with the live application. One just has to remember to
795re-enable the mainloop call when running in standard Python.</p>
796</div>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400797<div class="section" id="running-without-a-subprocess">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400798<h3>Running without a subprocess<a class="headerlink" href="#running-without-a-subprocess" title="Permalink to this headline"></a></h3>
Terry Jan Reedy0053c472015-09-24 03:09:43 -0400799<p>By default, IDLE executes user code in a separate subprocess via a socket,
Terry Jan Reedy6e10ec52015-09-23 20:00:33 -0400800which uses the internal loopback interface. This connection is not
801externally visible and no data is sent to or received from the Internet.
802If firewall software complains anyway, you can ignore it.</p>
803<p>If the attempt to make the socket connection fails, Idle will notify you.
804Such failures are sometimes transient, but if persistent, the problem
terryjreedy188aedf2017-06-13 21:32:16 -0400805may be either a firewall blocking the connection or misconfiguration of
Terry Jan Reedy6e10ec52015-09-23 20:00:33 -0400806a particular system. Until the problem is fixed, one can run Idle with
807the -n command line switch.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400808<p>If IDLE is started with the -n command line switch it will run in a
809single process and will not create the subprocess which runs the RPC
810Python execution server. This can be useful if Python cannot create
811the subprocess or the RPC socket interface on your platform. However,
812in this mode user code is not isolated from IDLE itself. Also, the
813environment is not restarted when Run/Run Module (F5) is selected. If
814your code has been modified, you must reload() the affected modules and
815re-import any specific items (e.g. from foo import baz) if the changes
816are to take effect. For these reasons, it is preferable to run IDLE
817with the default subprocess if at all possible.</p>
818<div class="deprecated">
Tal Einatfcf1d002019-07-06 15:35:24 +0300819<p><span class="versionmodified deprecated">Deprecated since version 3.4.</span></p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400820</div>
821</div>
822</div>
823<div class="section" id="help-and-preferences">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400824<h2>Help and preferences<a class="headerlink" href="#help-and-preferences" title="Permalink to this headline"></a></h2>
Terry Jan Reedy18032632018-10-28 16:21:18 -0400825<div class="section" id="help-sources">
Cheryl Sabella01421be2018-12-20 00:38:54 -0500826<span id="id6"></span><h3>Help sources<a class="headerlink" href="#help-sources" title="Permalink to this headline"></a></h3>
Terry Jan Reedy18032632018-10-28 16:21:18 -0400827<p>Help menu entry “IDLE Help” displays a formatted html version of the
828IDLE chapter of the Library Reference. The result, in a read-only
829tkinter text window, is close to what one sees in a web browser.
830Navigate through the text with a mousewheel,
831the scrollbar, or up and down arrow keys held down.
832Or click the TOC (Table of Contents) button and select a section
833header in the opened box.</p>
834<p>Help menu entry “Python Docs” opens the extensive sources of help,
Tal Einatd6c08db2020-01-06 01:51:48 +0200835including tutorials, available at <code class="docutils literal notranslate"><span class="pre">docs.python.org/x.y</span></code>, where ‘x.y’
Terry Jan Reedy18032632018-10-28 16:21:18 -0400836is the currently running Python version. If your system
837has an off-line copy of the docs (this may be an installation option),
838that will be opened instead.</p>
839<p>Selected URLs can be added or removed from the help menu at any time using the
Tal Einatd6c08db2020-01-06 01:51:48 +0200840General tab of the Configure IDLE dialog.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400841</div>
842<div class="section" id="setting-preferences">
Terry Jan Reedy292cd6e2018-12-20 06:06:29 -0500843<span id="preferences"></span><h3>Setting preferences<a class="headerlink" href="#setting-preferences" title="Permalink to this headline"></a></h3>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400844<p>The font preferences, highlighting, keys, and general preferences can be
Terry Jan Reedy292cd6e2018-12-20 06:06:29 -0500845changed via Configure IDLE on the Option menu.
Tal Einatd6c08db2020-01-06 01:51:48 +0200846Non-default user settings are saved in a <code class="docutils literal notranslate"><span class="pre">.idlerc</span></code> directory in the user’s
Terry Jan Reedy292cd6e2018-12-20 06:06:29 -0500847home directory. Problems caused by bad user configuration files are solved
Tal Einatd6c08db2020-01-06 01:51:48 +0200848by editing or deleting one or more of the files in <code class="docutils literal notranslate"><span class="pre">.idlerc</span></code>.</p>
Terry Jan Reedyd6101162019-02-23 23:04:53 -0500849<p>On the Font tab, see the text sample for the effect of font face and size
850on multiple characters in multiple languages. Edit the sample to add
851other characters of personal interest. Use the sample to select
852monospaced fonts. If particular characters have problems in Shell or an
853editor, add them to the top of the sample and try changing first size
854and then font.</p>
Terry Jan Reedy292cd6e2018-12-20 06:06:29 -0500855<p>On the Highlights and Keys tab, select a built-in or custom color theme
856and key set. To use a newer built-in color theme or key set with older
857IDLEs, save it as a new custom theme or key set and it well be accessible
858to older IDLEs.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400859</div>
Terry Jan Reedy50ff02b2018-11-10 23:26:31 -0500860<div class="section" id="idle-on-macos">
Terry Jan Reedyb65413b2018-11-15 13:15:13 -0500861<h3>IDLE on macOS<a class="headerlink" href="#idle-on-macos" title="Permalink to this headline"></a></h3>
Terry Jan Reedy50ff02b2018-11-10 23:26:31 -0500862<p>Under System Preferences: Dock, one can set “Prefer tabs when opening
863documents” to “Always”. This setting is not compatible with the tk/tkinter
864GUI framework used by IDLE, and it breaks a few IDLE features.</p>
865</div>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400866<div class="section" id="extensions">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400867<h3>Extensions<a class="headerlink" href="#extensions" title="Permalink to this headline"></a></h3>
terryjreedy188aedf2017-06-13 21:32:16 -0400868<p>IDLE contains an extension facility. Preferences for extensions can be
Terry Jan Reedyadb4cd22017-09-12 07:45:15 -0400869changed with the Extensions tab of the preferences dialog. See the
870beginning of config-extensions.def in the idlelib directory for further
871information. The only current default extension is zzdummy, an example
Terry Jan Reedy98758bc2017-09-12 09:05:16 -0400872also used for testing.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400873</div>
874</div>
875</div>
876
877
Terry Jan Reedya460d452020-10-20 20:56:01 -0400878 <div class="clearer"></div>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400879 </div>
880 </div>
881 </div>
Terry Jan Reedyf8cd02d2016-03-01 00:29:57 -0500882 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400883 <div class="sphinxsidebarwrapper">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400884 <h3><a href="../contents.html">Table of Contents</a></h3>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400885 <ul>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400886<li><a class="reference internal" href="#">IDLE</a><ul>
887<li><a class="reference internal" href="#menus">Menus</a><ul>
888<li><a class="reference internal" href="#file-menu-shell-and-editor">File menu (Shell and Editor)</a></li>
889<li><a class="reference internal" href="#edit-menu-shell-and-editor">Edit menu (Shell and Editor)</a></li>
890<li><a class="reference internal" href="#format-menu-editor-window-only">Format menu (Editor window only)</a></li>
891<li><a class="reference internal" href="#run-menu-editor-window-only">Run menu (Editor window only)</a></li>
892<li><a class="reference internal" href="#shell-menu-shell-window-only">Shell menu (Shell window only)</a></li>
893<li><a class="reference internal" href="#debug-menu-shell-window-only">Debug menu (Shell window only)</a></li>
894<li><a class="reference internal" href="#options-menu-shell-and-editor">Options menu (Shell and Editor)</a></li>
895<li><a class="reference internal" href="#window-menu-shell-and-editor">Window menu (Shell and Editor)</a></li>
896<li><a class="reference internal" href="#help-menu-shell-and-editor">Help menu (Shell and Editor)</a></li>
897<li><a class="reference internal" href="#context-menus">Context Menus</a></li>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400898</ul>
899</li>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400900<li><a class="reference internal" href="#editing-and-navigation">Editing and navigation</a><ul>
Terry Jan Reedyea9c8bd2018-10-28 20:42:18 -0400901<li><a class="reference internal" href="#editor-windows">Editor windows</a></li>
902<li><a class="reference internal" href="#key-bindings">Key bindings</a></li>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400903<li><a class="reference internal" href="#automatic-indentation">Automatic indentation</a></li>
904<li><a class="reference internal" href="#completions">Completions</a></li>
905<li><a class="reference internal" href="#calltips">Calltips</a></li>
Cheryl Sabella01421be2018-12-20 00:38:54 -0500906<li><a class="reference internal" href="#code-context">Code Context</a></li>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400907<li><a class="reference internal" href="#python-shell-window">Python Shell window</a></li>
908<li><a class="reference internal" href="#text-colors">Text colors</a></li>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400909</ul>
910</li>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400911<li><a class="reference internal" href="#startup-and-code-execution">Startup and code execution</a><ul>
912<li><a class="reference internal" href="#command-line-usage">Command line usage</a></li>
913<li><a class="reference internal" href="#startup-failure">Startup failure</a></li>
Terry Jan Reedyf1d3efc2018-11-05 22:17:57 -0500914<li><a class="reference internal" href="#running-user-code">Running user code</a></li>
Terry Jan Reedy75d9d592018-11-06 12:37:36 -0500915<li><a class="reference internal" href="#user-output-in-shell">User output in Shell</a></li>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400916<li><a class="reference internal" href="#developing-tkinter-applications">Developing tkinter applications</a></li>
917<li><a class="reference internal" href="#running-without-a-subprocess">Running without a subprocess</a></li>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400918</ul>
919</li>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400920<li><a class="reference internal" href="#help-and-preferences">Help and preferences</a><ul>
Terry Jan Reedy18032632018-10-28 16:21:18 -0400921<li><a class="reference internal" href="#help-sources">Help sources</a></li>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400922<li><a class="reference internal" href="#setting-preferences">Setting preferences</a></li>
Terry Jan Reedyb65413b2018-11-15 13:15:13 -0500923<li><a class="reference internal" href="#idle-on-macos">IDLE on macOS</a></li>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400924<li><a class="reference internal" href="#extensions">Extensions</a></li>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400925</ul>
926</li>
927</ul>
928</li>
929</ul>
930
931 <h4>Previous topic</h4>
Terry Jan Reedy6bf644e2019-11-24 16:29:29 -0500932 <p class="topless"><a href="tkinter.tix.html"
933 title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tkinter.tix</span></code> — Extension widgets for Tk</a></p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400934 <h4>Next topic</h4>
935 <p class="topless"><a href="othergui.html"
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400936 title="next chapter">Other Graphical User Interface Packages</a></p>
Terry Jan Reedy4b736762016-09-12 01:50:03 -0400937 <div role="note" aria-label="source link">
938 <h3>This Page</h3>
939 <ul class="this-page-menu">
940 <li><a href="../bugs.html">Report a Bug</a></li>
terryjreedy188aedf2017-06-13 21:32:16 -0400941 <li>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400942 <a href="https://github.com/python/cpython/blob/master/Doc/library/idle.rst"
terryjreedy188aedf2017-06-13 21:32:16 -0400943 rel="nofollow">Show Source
944 </a>
945 </li>
Terry Jan Reedy4b736762016-09-12 01:50:03 -0400946 </ul>
947 </div>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400948 </div>
949 </div>
950 <div class="clearer"></div>
Terry Jan Reedy963a38b2015-09-20 20:03:01 -0400951 </div>
Terry Jan Reedyf8cd02d2016-03-01 00:29:57 -0500952 <div class="related" role="navigation" aria-label="related navigation">
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400953 <h3>Navigation</h3>
954 <ul>
955 <li class="right" style="margin-right: 10px">
956 <a href="../genindex.html" title="General Index"
957 >index</a></li>
958 <li class="right" >
959 <a href="../py-modindex.html" title="Python Module Index"
960 >modules</a> |</li>
961 <li class="right" >
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400962 <a href="othergui.html" title="Other Graphical User Interface Packages"
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400963 >next</a> |</li>
964 <li class="right" >
Terry Jan Reedy6bf644e2019-11-24 16:29:29 -0500965 <a href="tkinter.tix.html" title="tkinter.tix — Extension widgets for Tk"
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400966 >previous</a> |</li>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400967
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400968 <li><img src="../_static/py.png" alt=""
969 style="vertical-align: middle; margin-top: -1px"/></li>
970 <li><a href="https://www.python.org/">Python</a> &#187;</li>
971
972
Terry Jan Reedy4cf7bb82021-02-21 02:44:11 -0500973 <li id="cpython-language-and-version">
Terry Jan Reedy1b4a9c72021-03-31 01:19:38 -0400974 <a href="../index.html">3.10.0a6 Documentation</a> &#187;
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400975 </li>
976
977 <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400978 <li class="nav-item nav-item-2"><a href="tk.html" >Graphical User Interfaces with Tk</a> &#187;</li>
Terry Jan Reedya460d452020-10-20 20:56:01 -0400979 <li class="nav-item nav-item-this"><a href="">IDLE</a></li>
Terry Jan Reedy4b736762016-09-12 01:50:03 -0400980 <li class="right">
981
982
983 <div class="inline-search" style="display: none" role="search">
984 <form class="inline-search" action="../search.html" method="get">
985 <input placeholder="Quick search" type="text" name="q" />
986 <input type="submit" value="Go" />
987 <input type="hidden" name="check_keywords" value="yes" />
988 <input type="hidden" name="area" value="default" />
989 </form>
990 </div>
991 <script type="text/javascript">$('.inline-search').show(0);</script>
992 |
993 </li>
994
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400995 </ul>
Terry Jan Reedy963a38b2015-09-20 20:03:01 -0400996 </div>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400997 <div class="footer">
Terry Jan Reedy4cf7bb82021-02-21 02:44:11 -0500998 &copy; <a href="../copyright.html">Copyright</a> 2001-2021, Python Software Foundation.
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400999 <br />
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -04001000
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -04001001 The Python Software Foundation is a non-profit corporation.
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -04001002<a href="https://www.python.org/psf/donations/">Please donate.</a>
1003<br />
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -04001004 <br />
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -04001005
Terry Jan Reedy1b4a9c72021-03-31 01:19:38 -04001006 Last updated on Mar 29, 2021.
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -04001007 <a href="https://docs.python.org/3/bugs.html">Found a bug</a>?
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -04001008 <br />
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -04001009
Terry Jan Reedya460d452020-10-20 20:56:01 -04001010 Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -04001011 </div>
1012
1013 </body>
Terry Jan Reedy963a38b2015-09-20 20:03:01 -04001014</html>