Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / cpython3 / 6d965b39b7a486dd9e96a60b19ee92382d668299 / . / Lib / idlelib / help.html
blob: bc287d637ab738332e5f6445c60f6d07e9824fda [file] [log] [blame]
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]1
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]5<html xmlns="http://www.w3.org/1999/xhtml">
6 <head>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]7 <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]8 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
Terry Jan Reedy8a533ff2019-05-16 01:20:37 -0400[diff] [blame]9 <title>IDLE &#8212; Python 3.8.0a4 documentation</title>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]10 <link rel="stylesheet" href="../_static/pydoctheme.css" type="text/css" />
11 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]12
13 <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]14 <script type="text/javascript" src="../_static/jquery.js"></script>
15 <script type="text/javascript" src="../_static/underscore.js"></script>
16 <script type="text/javascript" src="../_static/doctools.js"></script>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]17 <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
18
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]19 <script type="text/javascript" src="../_static/sidebar.js"></script>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]20
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]21 <link rel="search" type="application/opensearchdescription+xml"
Terry Jan Reedy8a533ff2019-05-16 01:20:37 -0400[diff] [blame]22 title="Search within Python 3.8.0a4 documentation"
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]23 href="../_static/opensearch.xml"/>
24 <link rel="author" title="About these documents" href="../about.html" />
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]25 <link rel="index" title="Index" href="../genindex.html" />
26 <link rel="search" title="Search" href="../search.html" />
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]27 <link rel="copyright" title="Copyright" href="../copyright.html" />
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]28 <link rel="next" title="Other Graphical User Interface Packages" href="othergui.html" />
29 <link rel="prev" title="tkinter.scrolledtext — Scrolled Text Widget" href="tkinter.scrolledtext.html" />
terryjreedy188aedf2017-06-13 21:32:16 -0400[diff] [blame]30 <link rel="canonical" href="https://docs.python.org/3/library/idle.html" />
31
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]32
33
34
35
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]36
37 <style>
38 @media only screen {
39 table.full-width-table {
40 width: 100%;
41 }
42 }
43 </style>
44
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]45 <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
46
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]47 <script type="text/javascript" src="../_static/copybutton.js"></script>
Terry Jan Reedy963a38b2015-09-20 20:03:01 -0400[diff] [blame]48
49
50
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]51
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]52 </head><body>
Terry Jan Reedyf8cd02d2016-03-01 00:29:57 -0500[diff] [blame]53 <div class="related" role="navigation" aria-label="related navigation">
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]54 <h3>Navigation</h3>
55 <ul>
56 <li class="right" style="margin-right: 10px">
57 <a href="../genindex.html" title="General Index"
58 accesskey="I">index</a></li>
59 <li class="right" >
60 <a href="../py-modindex.html" title="Python Module Index"
61 >modules</a> |</li>
62 <li class="right" >
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]63 <a href="othergui.html" title="Other Graphical User Interface Packages"
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]64 accesskey="N">next</a> |</li>
65 <li class="right" >
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]66 <a href="tkinter.scrolledtext.html" title="tkinter.scrolledtext — Scrolled Text Widget"
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]67 accesskey="P">previous</a> |</li>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]68
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]69 <li><img src="../_static/py.png" alt=""
70 style="vertical-align: middle; margin-top: -1px"/></li>
71 <li><a href="https://www.python.org/">Python</a> &#187;</li>
72
73
74 <li>
Terry Jan Reedy8a533ff2019-05-16 01:20:37 -0400[diff] [blame]75 <a href="../index.html">3.8.0a4 Documentation</a> &#187;
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]76 </li>
77
78 <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 -0400[diff] [blame]79 <li class="nav-item nav-item-2"><a href="tk.html" accesskey="U">Graphical User Interfaces with Tk</a> &#187;</li>
Terry Jan Reedy4b736762016-09-12 01:50:03 -0400[diff] [blame]80 <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 -0400[diff] [blame]95 </ul>
Terry Jan Reedy963a38b2015-09-20 20:03:01 -0400[diff] [blame]96 </div>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]97
98 <div class="document">
99 <div class="documentwrapper">
100 <div class="bodywrapper">
Terry Jan Reedyf8cd02d2016-03-01 00:29:57 -0500[diff] [blame]101 <div class="body" role="main">
Terry Jan Reedy963a38b2015-09-20 20:03:01 -0400[diff] [blame]102
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]103 <div class="section" id="idle">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]104<span id="id1"></span><h1>IDLE<a class="headerlink" href="#idle" title="Permalink to this headline"></a></h1>
terryjreedy188aedf2017-06-13 21:32:16 -0400[diff] [blame]105<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 -0400[diff] [blame]106<hr class="docutils" id="index-0" />
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]107<p>IDLE is Python’s Integrated Development and Learning Environment.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]108<p>IDLE has the following features:</p>
109<ul class="simple">
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]110<li>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</li>
Terry Jan Reedyb65413b2018-11-15 13:15:13 -0500[diff] [blame]111<li>cross-platform: works mostly the same on Windows, Unix, and macOS</li>
Terry Jan Reedy6e10ec52015-09-23 20:00:33 -0400[diff] [blame]112<li>Python shell window (interactive interpreter) with colorizing
113of code input, output, and error messages</li>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]114<li>multi-window text editor with multiple undo, Python colorizing,
Terry Jan Reedy6e10ec52015-09-23 20:00:33 -0400[diff] [blame]115smart indent, call tips, auto completion, and other features</li>
116<li>search within any window, replace within editor windows, and search
117through multiple files (grep)</li>
118<li>debugger with persistent breakpoints, stepping, and viewing
119of global and local namespaces</li>
120<li>configuration, browsers, and other dialogs</li>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]121</ul>
122<div class="section" id="menus">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]123<h2>Menus<a class="headerlink" href="#menus" title="Permalink to this headline"></a></h2>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]124<p>IDLE has two main window types, the Shell window and the Editor window. It is
Terry Jan Reedy50ff02b2018-11-10 23:26:31 -0500[diff] [blame]125possible 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 -0500[diff] [blame]131<p>On macOS, there is one application menu. It dynamically changes according
Terry Jan Reedy50ff02b2018-11-10 23:26:31 -0500[diff] [blame]132to the window currently selected. It has an IDLE menu, and some entries
Terry Jan Reedy8a533ff2019-05-16 01:20:37 -0400[diff] [blame]133described below are moved around to conform to Apple guidelines.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]134<div class="section" id="file-menu-shell-and-editor">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]135<h3>File menu (Shell and Editor)<a class="headerlink" href="#file-menu-shell-and-editor" title="Permalink to this headline"></a></h3>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]136<dl class="docutils">
137<dt>New File</dt>
138<dd>Create a new file editing window.</dd>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]139<dt>Open…</dt>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]140<dd>Open an existing file with an Open dialog.</dd>
141<dt>Recent Files</dt>
142<dd>Open a list of recent files. Click one to open it.</dd>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]143<dt>Open Module…</dt>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]144<dd>Open an existing module (searches sys.path).</dd>
145</dl>
146<dl class="docutils" id="index-1">
147<dt>Class Browser</dt>
148<dd>Show functions, classes, and methods in the current Editor file in a
149tree structure. In the shell, open a module first.</dd>
150<dt>Path Browser</dt>
151<dd>Show sys.path directories, modules, functions, classes and methods in a
152tree structure.</dd>
153<dt>Save</dt>
154<dd>Save the current window to the associated file, if there is one. Windows
155that have been changed since being opened or last saved have a * before
156and after the window title. If there is no associated file,
157do Save As instead.</dd>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]158<dt>Save As…</dt>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]159<dd>Save the current window with a Save As dialog. The file saved becomes the
160new associated file for the window.</dd>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]161<dt>Save Copy As…</dt>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]162<dd>Save the current window to different file without changing the associated
163file.</dd>
164<dt>Print Window</dt>
165<dd>Print the current window to the default printer.</dd>
166<dt>Close</dt>
167<dd>Close the current window (ask to save if unsaved).</dd>
168<dt>Exit</dt>
169<dd>Close all windows and quit IDLE (ask to save unsaved windows).</dd>
170</dl>
171</div>
172<div class="section" id="edit-menu-shell-and-editor">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]173<h3>Edit menu (Shell and Editor)<a class="headerlink" href="#edit-menu-shell-and-editor" title="Permalink to this headline"></a></h3>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]174<dl class="docutils">
175<dt>Undo</dt>
176<dd>Undo the last change to the current window. A maximum of 1000 changes may
177be undone.</dd>
178<dt>Redo</dt>
179<dd>Redo the last undone change to the current window.</dd>
180<dt>Cut</dt>
181<dd>Copy selection into the system-wide clipboard; then delete the selection.</dd>
182<dt>Copy</dt>
183<dd>Copy selection into the system-wide clipboard.</dd>
184<dt>Paste</dt>
185<dd>Insert contents of the system-wide clipboard into the current window.</dd>
186</dl>
187<p>The clipboard functions are also available in context menus.</p>
188<dl class="docutils">
189<dt>Select All</dt>
190<dd>Select the entire contents of the current window.</dd>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]191<dt>Find…</dt>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]192<dd>Open a search dialog with many options</dd>
193<dt>Find Again</dt>
194<dd>Repeat the last search, if there is one.</dd>
195<dt>Find Selection</dt>
196<dd>Search for the currently selected string, if there is one.</dd>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]197<dt>Find in Files…</dt>
Terry Jan Reedy929d7f82016-05-02 18:30:02 -0400[diff] [blame]198<dd>Open a file search dialog. Put results in a new output window.</dd>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]199<dt>Replace…</dt>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]200<dd>Open a search-and-replace dialog.</dd>
201<dt>Go to Line</dt>
202<dd>Move cursor to the line number requested and make that line visible.</dd>
203<dt>Show Completions</dt>
204<dd>Open a scrollable list allowing selection of keywords and attributes. See
Cheryl Sabella01421be2018-12-20 00:38:54 -0500[diff] [blame]205<a class="reference internal" href="#completions"><span class="std std-ref">Completions</span></a> in the Editing and navigation section below.</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]206<dt>Expand Word</dt>
207<dd>Expand a prefix you have typed to match a full word in the same window;
208repeat to get a different expansion.</dd>
209<dt>Show call tip</dt>
210<dd>After an unclosed parenthesis for a function, open a small window with
Cheryl Sabella01421be2018-12-20 00:38:54 -0500[diff] [blame]211function parameter hints. See <a class="reference internal" href="#calltips"><span class="std std-ref">Calltips</span></a> in the
212Editing and navigation section below.</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]213<dt>Show surrounding parens</dt>
214<dd>Highlight the surrounding parenthesis.</dd>
215</dl>
216</div>
217<div class="section" id="format-menu-editor-window-only">
Terry Jan Reedy292cd6e2018-12-20 06:06:29 -0500[diff] [blame]218<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>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]219<dl class="docutils">
220<dt>Indent Region</dt>
221<dd>Shift selected lines right by the indent width (default 4 spaces).</dd>
222<dt>Dedent Region</dt>
223<dd>Shift selected lines left by the indent width (default 4 spaces).</dd>
224<dt>Comment Out Region</dt>
225<dd>Insert ## in front of selected lines.</dd>
226<dt>Uncomment Region</dt>
227<dd>Remove leading # or ## from selected lines.</dd>
228<dt>Tabify Region</dt>
229<dd>Turn <em>leading</em> stretches of spaces into tabs. (Note: We recommend using
2304 space blocks to indent Python code.)</dd>
231<dt>Untabify Region</dt>
232<dd>Turn <em>all</em> tabs into the correct number of spaces.</dd>
233<dt>Toggle Tabs</dt>
234<dd>Open a dialog to switch between indenting with spaces and tabs.</dd>
235<dt>New Indent Width</dt>
236<dd>Open a dialog to change indent width. The accepted default by the Python
237community is 4 spaces.</dd>
238<dt>Format Paragraph</dt>
239<dd>Reformat the current blank-line-delimited paragraph in comment block or
240multiline string or selected line in a string. All lines in the
241paragraph will be formatted to less than N columns, where N defaults to 72.</dd>
242<dt>Strip trailing whitespace</dt>
Terry Jan Reedyff702892017-09-15 13:05:28 -0400[diff] [blame]243<dd>Remove trailing space and other whitespace characters after the last
244non-whitespace character of a line by applying str.rstrip to each line,
245including lines within multiline strings.</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]246</dl>
247</div>
248<div class="section" id="run-menu-editor-window-only">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]249<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>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]250<dl class="docutils">
251<dt>Python Shell</dt>
252<dd>Open or wake up the Python Shell window.</dd>
253<dt>Check Module</dt>
254<dd>Check the syntax of the module currently open in the Editor window. If the
255module has not been saved IDLE will either prompt the user to save or
256autosave, as selected in the General tab of the Idle Settings dialog. If
257there is a syntax error, the approximate location is indicated in the
258Editor window.</dd>
259<dt>Run Module</dt>
260<dd>Do Check Module (above). If no error, restart the shell to clean the
Terry Jan Reedy0053c472015-09-24 03:09:43 -0400[diff] [blame]261environment, then execute the module. Output is displayed in the Shell
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]262window. 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 -0400[diff] [blame]263When execution is complete, the Shell retains focus and displays a prompt.
264At this point, one may interactively explore the result of execution.
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]265This 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
Terry Jan Reedy0053c472015-09-24 03:09:43 -0400[diff] [blame]266line.</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]267</dl>
268</div>
269<div class="section" id="shell-menu-shell-window-only">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]270<h3>Shell menu (Shell window only)<a class="headerlink" href="#shell-menu-shell-window-only" title="Permalink to this headline"></a></h3>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]271<dl class="docutils">
272<dt>View Last Restart</dt>
273<dd>Scroll the shell window to the last Shell restart.</dd>
274<dt>Restart Shell</dt>
275<dd>Restart the shell to clean the environment.</dd>
Cheryl Sabellac0381aa2018-12-28 15:11:30 -0500[diff] [blame]276<dt>Previous History</dt>
277<dd>Cycle through earlier commands in history which match the current entry.</dd>
278<dt>Next History</dt>
279<dd>Cycle through later commands in history which match the current entry.</dd>
Terry Jan Reedy4b736762016-09-12 01:50:03 -0400[diff] [blame]280<dt>Interrupt Execution</dt>
281<dd>Stop a running program.</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]282</dl>
283</div>
284<div class="section" id="debug-menu-shell-window-only">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]285<h3>Debug menu (Shell window only)<a class="headerlink" href="#debug-menu-shell-window-only" title="Permalink to this headline"></a></h3>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]286<dl class="docutils">
287<dt>Go to File/Line</dt>
288<dd>Look on the current line. with the cursor, and the line above for a filename
289and line number. If found, open the file if not already open, and show the
290line. Use this to view source lines referenced in an exception traceback
291and lines found by Find in Files. Also available in the context menu of
292the Shell window and Output windows.</dd>
293</dl>
294<dl class="docutils" id="index-3">
295<dt>Debugger (toggle)</dt>
terryjreedy188aedf2017-06-13 21:32:16 -0400[diff] [blame]296<dd>When activated, code entered in the Shell or run from an Editor will run
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]297under the debugger. In the Editor, breakpoints can be set with the context
298menu. This feature is still incomplete and somewhat experimental.</dd>
299<dt>Stack Viewer</dt>
300<dd>Show the stack traceback of the last exception in a tree widget, with
301access to locals and globals.</dd>
302<dt>Auto-open Stack Viewer</dt>
303<dd>Toggle automatically opening the stack viewer on an unhandled exception.</dd>
304</dl>
305</div>
306<div class="section" id="options-menu-shell-and-editor">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]307<h3>Options menu (Shell and Editor)<a class="headerlink" href="#options-menu-shell-and-editor" title="Permalink to this headline"></a></h3>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]308<dl class="docutils">
309<dt>Configure IDLE</dt>
Terry Jan Reedy292cd6e2018-12-20 06:06:29 -0500[diff] [blame]310<dd>Open a configuration dialog and change preferences for the following:
Terry Jan Reedy93f35422015-10-13 22:03:51 -0400[diff] [blame]311fonts, indentation, keybindings, text color themes, startup windows and
Terry Jan Reedy292cd6e2018-12-20 06:06:29 -0500[diff] [blame]312size, additional help sources, and extensions. On macOS, open the
313configuration dialog by selecting Preferences in the application
314menu. For more, see
315<a class="reference internal" href="#preferences"><span class="std std-ref">Setting preferences</span></a> under Help and preferences.</dd>
Cheryl Sabellac0381aa2018-12-28 15:11:30 -0500[diff] [blame]316<dt>Zoom/Restore Height</dt>
317<dd>Toggles the window between normal size and maximum height. The initial size
318defaults to 40 lines by 80 chars unless changed on the General tab of the
319Configure IDLE dialog.</dd>
320<dt>Show/Hide Code Context (Editor Window only)</dt>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]321<dd>Open a pane at the top of the edit window which shows the block context
Cheryl Sabella01421be2018-12-20 00:38:54 -0500[diff] [blame]322of the code which has scrolled above the top of the window. See
323<a class="reference internal" href="#code-context"><span class="std std-ref">Code Context</span></a> in the Editing and Navigation section below.</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]324</dl>
325</div>
326<div class="section" id="window-menu-shell-and-editor">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]327<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 -0500[diff] [blame]328<p>Lists the names of all open windows; select one to bring it to the foreground
329(deiconifying it if necessary).</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]330</div>
331<div class="section" id="help-menu-shell-and-editor">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]332<h3>Help menu (Shell and Editor)<a class="headerlink" href="#help-menu-shell-and-editor" title="Permalink to this headline"></a></h3>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]333<dl class="docutils">
334<dt>About IDLE</dt>
335<dd>Display version, copyright, license, credits, and more.</dd>
336<dt>IDLE Help</dt>
Terry Jan Reedy18032632018-10-28 16:21:18 -0400[diff] [blame]337<dd>Display this IDLE document, detailing the menu options, basic editing and
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]338navigation, and other tips.</dd>
339<dt>Python Docs</dt>
340<dd>Access local Python documentation, if installed, or start a web browser
341and open docs.python.org showing the latest Python documentation.</dd>
342<dt>Turtle Demo</dt>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]343<dd>Run the turtledemo module with example Python code and turtle drawings.</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]344</dl>
345<p>Additional help sources may be added here with the Configure IDLE dialog under
Cheryl Sabella01421be2018-12-20 00:38:54 -0500[diff] [blame]346the General tab. See the <a class="reference internal" href="#help-sources"><span class="std std-ref">Help sources</span></a> subsection below
347for more on Help menu choices.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]348</div>
349<div class="section" id="context-menus">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]350<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 -0500[diff] [blame]351<p>Open a context menu by right-clicking in a window (Control-click on macOS).
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]352Context menus have the standard clipboard functions also on the Edit menu.</p>
353<dl class="docutils">
354<dt>Cut</dt>
355<dd>Copy selection into the system-wide clipboard; then delete the selection.</dd>
356<dt>Copy</dt>
357<dd>Copy selection into the system-wide clipboard.</dd>
358<dt>Paste</dt>
359<dd>Insert contents of the system-wide clipboard into the current window.</dd>
360</dl>
361<p>Editor windows also have breakpoint functions. Lines with a breakpoint set are
362specially marked. Breakpoints only have an effect when running under the
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]363debugger. Breakpoints for a file are saved in the user’s .idlerc directory.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]364<dl class="docutils">
365<dt>Set Breakpoint</dt>
366<dd>Set a breakpoint on the current line.</dd>
367<dt>Clear Breakpoint</dt>
368<dd>Clear the breakpoint on that line.</dd>
369</dl>
Terry Jan Reedy68d6dc02018-10-28 12:44:44 -0400[diff] [blame]370<p>Shell and Output windows also have the following.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]371<dl class="docutils">
372<dt>Go to file/line</dt>
373<dd>Same as in Debug menu.</dd>
374</dl>
Terry Jan Reedy55d03512019-04-26 23:22:36 -0400[diff] [blame]375<p>The Shell window also has an output squeezing facility explained in the <em>Python
376Shell window</em> subsection below.</p>
Terry Jan Reedy68d6dc02018-10-28 12:44:44 -0400[diff] [blame]377<dl class="docutils">
378<dt>Squeeze</dt>
379<dd>If the cursor is over an output line, squeeze all the output between
380the code above and the prompt below down to a ‘Squeezed text’ label.</dd>
381</dl>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]382</div>
383</div>
384<div class="section" id="editing-and-navigation">
Cheryl Sabella01421be2018-12-20 00:38:54 -0500[diff] [blame]385<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 -0400[diff] [blame]386<div class="section" id="editor-windows">
387<h3>Editor windows<a class="headerlink" href="#editor-windows" title="Permalink to this headline"></a></h3>
388<p>IDLE may open editor windows when it starts, depending on settings
389and how you start IDLE. Thereafter, use the File menu. There can be only
390one open editor window for a given file.</p>
391<p>The title bar contains the name of the file, the full path, and the version
392of Python and IDLE running the window. The status bar contains the line
393number (‘Ln’) and column number (‘Col’). Line numbers start with 1;
394column numbers with 0.</p>
395<p>IDLE assumes that files with a known .py* extension contain Python code
396and that other files do not. Run Python code with the Run menu.</p>
397</div>
398<div class="section" id="key-bindings">
399<h3>Key bindings<a class="headerlink" href="#key-bindings" title="Permalink to this headline"></a></h3>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]400<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 -0500[diff] [blame]401the <kbd class="kbd docutils literal notranslate">Command</kbd> key on macOS.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]402<ul>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]403<li><p class="first"><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>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]404</li>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]405<li><p class="first"><kbd class="kbd docutils literal notranslate">C-Backspace</kbd> delete word left; <kbd class="kbd docutils literal notranslate">C-Del</kbd> delete word to the right</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]406</li>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]407<li><p class="first">Arrow keys and <kbd class="kbd docutils literal notranslate">Page Up</kbd>/<kbd class="kbd docutils literal notranslate">Page Down</kbd> to move around</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]408</li>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]409<li><p class="first"><kbd class="kbd docutils literal notranslate">C-LeftArrow</kbd> and <kbd class="kbd docutils literal notranslate">C-RightArrow</kbd> moves by words</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]410</li>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]411<li><p class="first"><kbd class="kbd docutils literal notranslate">Home</kbd>/<kbd class="kbd docutils literal notranslate">End</kbd> go to begin/end of line</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]412</li>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]413<li><p class="first"><kbd class="kbd docutils literal notranslate">C-Home</kbd>/<kbd class="kbd docutils literal notranslate">C-End</kbd> go to begin/end of file</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]414</li>
415<li><p class="first">Some useful Emacs bindings are inherited from Tcl/Tk:</p>
416<blockquote>
417<div><ul class="simple">
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]418<li><kbd class="kbd docutils literal notranslate">C-a</kbd> beginning of line</li>
419<li><kbd class="kbd docutils literal notranslate">C-e</kbd> end of line</li>
420<li><kbd class="kbd docutils literal notranslate">C-k</kbd> kill line (but doesn’t put it in clipboard)</li>
421<li><kbd class="kbd docutils literal notranslate">C-l</kbd> center window around the insertion point</li>
422<li><kbd class="kbd docutils literal notranslate">C-b</kbd> go backward one character without deleting (usually you can
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]423also use the cursor key for this)</li>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]424<li><kbd class="kbd docutils literal notranslate">C-f</kbd> go forward one character without deleting (usually you can
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]425also use the cursor key for this)</li>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]426<li><kbd class="kbd docutils literal notranslate">C-p</kbd> go up one line (usually you can also use the cursor key for
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]427this)</li>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]428<li><kbd class="kbd docutils literal notranslate">C-d</kbd> delete next character</li>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]429</ul>
430</div></blockquote>
431</li>
432</ul>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]433<p>Standard keybindings (like <kbd class="kbd docutils literal notranslate">C-c</kbd> to copy and <kbd class="kbd docutils literal notranslate">C-v</kbd> to paste)
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]434may work. Keybindings are selected in the Configure IDLE dialog.</p>
Terry Jan Reedyea9c8bd2018-10-28 20:42:18 -0400[diff] [blame]435</div>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]436<div class="section" id="automatic-indentation">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]437<h3>Automatic indentation<a class="headerlink" href="#automatic-indentation" title="Permalink to this headline"></a></h3>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]438<p>After a block-opening statement, the next line is indented by 4 spaces (in the
439Python Shell window by one tab). After certain keywords (break, return etc.)
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]440the next line is dedented. In leading indentation, <kbd class="kbd docutils literal notranslate">Backspace</kbd> deletes up
441to 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 -0400[diff] [blame]442Shell window one tab), number depends on Indent width. Currently, tabs
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]443are restricted to four spaces due to Tcl/Tk limitations.</p>
Terry Jan Reedy292cd6e2018-12-20 06:06:29 -0500[diff] [blame]444<p>See also the indent/dedent region commands on the
445<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 -0400[diff] [blame]446</div>
447<div class="section" id="completions">
Cheryl Sabella01421be2018-12-20 00:38:54 -0500[diff] [blame]448<span id="id3"></span><h3>Completions<a class="headerlink" href="#completions" title="Permalink to this headline"></a></h3>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]449<p>Completions are supplied for functions, classes, and attributes of classes,
450both built-in and user-defined. Completions are also provided for
451filenames.</p>
452<p>The AutoCompleteWindow (ACW) will open after a predefined delay (default is
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]453two seconds) after a ‘.’ or (in a string) an os.sep is typed. If after one
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]454of those characters (plus zero or more other characters) a tab is typed
455the ACW will open immediately if a possible continuation is found.</p>
456<p>If there is only one possible completion for the characters entered, a
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]457<kbd class="kbd docutils literal notranslate">Tab</kbd> will supply that completion without opening the ACW.</p>
458<p>‘Show Completions’ will force open a completions window, by default the
459<kbd class="kbd docutils literal notranslate">C-space</kbd> will open a completions window. In an empty
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]460string, this will contain the files in the current directory. On a
461blank line, it will contain the built-in and user-defined functions and
terryjreedy188aedf2017-06-13 21:32:16 -0400[diff] [blame]462classes in the current namespaces, plus any modules imported. If some
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]463characters have been entered, the ACW will attempt to be more specific.</p>
464<p>If a string of characters is typed, the ACW selection will jump to the
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]465entry most closely matching those characters. Entering a <kbd class="kbd docutils literal notranslate">tab</kbd> will
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]466cause the longest non-ambiguous match to be entered in the Editor window or
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]467Shell. Two <kbd class="kbd docutils literal notranslate">tab</kbd> in a row will supply the current ACW selection, as
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]468will return or a double click. Cursor keys, Page Up/Down, mouse selection,
469and the scroll wheel all operate on the ACW.</p>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]470<p>“Hidden” attributes can be accessed by typing the beginning of hidden
471name after a ‘.’, e.g. ‘_’. This allows access to modules with
472<code class="docutils literal notranslate"><span class="pre">__all__</span></code> set, or to class-private attributes.</p>
473<p>Completions and the ‘Expand Word’ facility can save a lot of typing!</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]474<p>Completions are currently limited to those in the namespaces. Names in
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]475an Editor window which are not via <code class="docutils literal notranslate"><span class="pre">__main__</span></code> and <a class="reference internal" href="sys.html#sys.modules" title="sys.modules"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.modules</span></code></a> will
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]476not be found. Run the module once with your imports to correct this situation.
477Note that IDLE itself places quite a few modules in sys.modules, so
478much can be found by default, e.g. the re module.</p>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]479<p>If you don’t like the ACW popping up unbidden, simply make the delay
Terry Jan Reedy37f81352015-09-29 01:55:57 -0400[diff] [blame]480longer or disable the extension.</p>
481</div>
482<div class="section" id="calltips">
Cheryl Sabella01421be2018-12-20 00:38:54 -0500[diff] [blame]483<span id="id4"></span><h3>Calltips<a class="headerlink" href="#calltips" title="Permalink to this headline"></a></h3>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]484<p>A calltip is shown when one types <kbd class="kbd docutils literal notranslate">(</kbd> after the name of an <em>accessible</em>
Terry Jan Reedy37f81352015-09-29 01:55:57 -0400[diff] [blame]485function. A name expression may include dots and subscripts. A calltip
486remains until it is clicked, the cursor is moved out of the argument area,
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]487or <kbd class="kbd docutils literal notranslate">)</kbd> is typed. When the cursor is in the argument part of a definition,
Terry Jan Reedy37f81352015-09-29 01:55:57 -0400[diff] [blame]488the menu or shortcut display a calltip.</p>
489<p>A calltip consists of the function signature and the first line of the
490docstring. For builtins without an accessible signature, the calltip
491consists of all lines up the fifth line or the first blank line. These
492details may change.</p>
493<p>The set of <em>accessible</em> functions depends on what modules have been imported
494into the user process, including those imported by Idle itself,
495and what definitions have been run, all since the last restart.</p>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]496<p>For example, restart the Shell and enter <code class="docutils literal notranslate"><span class="pre">itertools.count(</span></code>. A calltip
Terry Jan Reedy37f81352015-09-29 01:55:57 -0400[diff] [blame]497appears because Idle imports itertools into the user process for its own use.
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]498(This could change.) Enter <code class="docutils literal notranslate"><span class="pre">turtle.write(</span></code> and nothing appears. Idle does
Terry Jan Reedy37f81352015-09-29 01:55:57 -0400[diff] [blame]499not import turtle. The menu or shortcut do nothing either. Enter
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]500<code class="docutils literal notranslate"><span class="pre">import</span> <span class="pre">turtle</span></code> and then <code class="docutils literal notranslate"><span class="pre">turtle.write(</span></code> will work.</p>
Terry Jan Reedy37f81352015-09-29 01:55:57 -0400[diff] [blame]501<p>In an editor, import statements have no effect until one runs the file. One
502might want to run a file after writing the import statements at the top,
503or immediately run an existing file before editing.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]504</div>
Cheryl Sabella01421be2018-12-20 00:38:54 -0500[diff] [blame]505<div class="section" id="code-context">
506<span id="id5"></span><h3>Code Context<a class="headerlink" href="#code-context" title="Permalink to this headline"></a></h3>
507<p>Within an editor window containing Python code, code context can be toggled
508in order to show or hide a pane at the top of the window. When shown, this
509pane freezes the opening lines for block code, such as those beginning with
510<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
511out of view. The size of the pane will be expanded and contracted as needed
512to show the all current levels of context, up to the maximum number of
513lines defined in the Configure IDLE dialog (which defaults to 15). If there
514are no current context lines and the feature is toggled on, a single blank
515line will display. Clicking on a line in the context pane will move that
516line to the top of the editor.</p>
517<p>The text and background colors for the context pane can be configured under
518the Highlights tab in the Configure IDLE dialog.</p>
519</div>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]520<div class="section" id="python-shell-window">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]521<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 -0500[diff] [blame]522<p>With IDLE’s Shell, one enters, edits, and recalls complete statements.
523Most consoles and terminals only work with a single physical line at a time.</p>
524<p>When one pastes code into Shell, it is not compiled and possibly executed
525until one hits <kbd class="kbd docutils literal notranslate">Return</kbd>. One may edit pasted code first.
526If one pastes more that one statement into Shell, the result will be a
527<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>
528<p>The editing features described in previous subsections work when entering
529code interactively. IDLE’s Shell window also responds to the following keys.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]530<ul>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]531<li><p class="first"><kbd class="kbd docutils literal notranslate">C-c</kbd> interrupts executing command</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]532</li>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]533<li><p class="first"><kbd class="kbd docutils literal notranslate">C-d</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>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]534</li>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]535<li><p class="first"><kbd class="kbd docutils literal notranslate">Alt-/</kbd> (Expand word) is also useful to reduce typing</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]536<p>Command history</p>
537<ul class="simple">
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]538<li><kbd class="kbd docutils literal notranslate">Alt-p</kbd> retrieves previous command matching what you have typed. On
Terry Jan Reedyb65413b2018-11-15 13:15:13 -0500[diff] [blame]539macOS use <kbd class="kbd docutils literal notranslate">C-p</kbd>.</li>
540<li><kbd class="kbd docutils literal notranslate">Alt-n</kbd> retrieves next. On macOS use <kbd class="kbd docutils literal notranslate">C-n</kbd>.</li>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]541<li><kbd class="kbd docutils literal notranslate">Return</kbd> while on any previous command retrieves that command</li>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]542</ul>
543</li>
544</ul>
545</div>
Terry Jan Reedyce021db2015-09-24 23:18:57 -0400[diff] [blame]546<div class="section" id="text-colors">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]547<h3>Text colors<a class="headerlink" href="#text-colors" title="Permalink to this headline"></a></h3>
Terry Jan Reedyce021db2015-09-24 23:18:57 -0400[diff] [blame]548<p>Idle defaults to black on white text, but colors text with special meanings.
549For the shell, these are shell output, shell error, user output, and
550user error. For Python code, at the shell prompt or in an editor, these are
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]551keywords, builtin class and function names, names following <code class="docutils literal notranslate"><span class="pre">class</span></code> and
552<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 -0400[diff] [blame]553present), found text (when possible), and selected text.</p>
554<p>Text coloring is done in the background, so uncolorized text is occasionally
555visible. To change the color scheme, use the Configure IDLE dialog
556Highlighting tab. The marking of debugger breakpoint lines in the editor and
557text in popups and dialogs is not user-configurable.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]558</div>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]559</div>
Terry Jan Reedy0053c472015-09-24 03:09:43 -0400[diff] [blame]560<div class="section" id="startup-and-code-execution">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]561<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 -0400[diff] [blame]562<p>Upon startup with the <code class="docutils literal notranslate"><span class="pre">-s</span></code> option, IDLE will execute the file referenced by
563the 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>.
564IDLE 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
565referenced is run. If <code class="docutils literal notranslate"><span class="pre">IDLESTARTUP</span></code> is not present, IDLE checks for
566<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 -0400[diff] [blame]567convenient places to store functions that are used frequently from the IDLE
568shell, or for executing import statements to import common modules.</p>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]569<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
570Tk file is loaded unconditionally. This additional file is <code class="docutils literal notranslate"><span class="pre">.Idle.py</span></code> and is
571looked for in the user’s home directory. Statements in this file will be
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]572executed in the Tk namespace, so this file is not useful for importing
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]573functions to be used from IDLE’s Python shell.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]574<div class="section" id="command-line-usage">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]575<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 -0400[diff] [blame]576<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 -0400[diff] [blame]577
Terry Jan Reedy968e2852015-09-23 03:52:23 -0400[diff] [blame]578-c command run command in the shell window
579-d enable debugger and open shell window
580-e open editor window
Terry Jan Reedy3399e1e2016-08-30 16:58:01 -0400[diff] [blame]581-h print help message with legal combinations and exit
Terry Jan Reedy968e2852015-09-23 03:52:23 -0400[diff] [blame]582-i open shell window
583-r file run file in shell window
584-s run $IDLESTARTUP or $PYTHONSTARTUP first, in shell window
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]585-t title set title of shell window
Terry Jan Reedy968e2852015-09-23 03:52:23 -0400[diff] [blame]586- run stdin in shell (- must be last option before args)
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]587</pre></div>
588</div>
589<p>If there are arguments:</p>
Terry Jan Reedy968e2852015-09-23 03:52:23 -0400[diff] [blame]590<ul class="simple">
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]591<li>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
592<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>,
593or <code class="docutils literal notranslate"><span class="pre">'-r'</span></code>. No editor window is opened, even if that is the default
Terry Jan Reedy968e2852015-09-23 03:52:23 -0400[diff] [blame]594set in the Options dialog.</li>
595<li>Otherwise, arguments are files opened for editing and
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]596<code class="docutils literal notranslate"><span class="pre">sys.argv</span></code> reflects the arguments passed to IDLE itself.</li>
Terry Jan Reedy968e2852015-09-23 03:52:23 -0400[diff] [blame]597</ul>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]598</div>
terryjreedy188aedf2017-06-13 21:32:16 -0400[diff] [blame]599<div class="section" id="startup-failure">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]600<h3>Startup failure<a class="headerlink" href="#startup-failure" title="Permalink to this headline"></a></h3>
terryjreedy188aedf2017-06-13 21:32:16 -0400[diff] [blame]601<p>IDLE uses a socket to communicate between the IDLE GUI process and the user
602code execution process. A connection must be established whenever the Shell
603starts or restarts. (The latter is indicated by a divider line that says
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]604‘RESTART’). If the user process fails to connect to the GUI process, it
605displays a <code class="docutils literal notranslate"><span class="pre">Tk</span></code> error box with a ‘cannot connect’ message that directs the
terryjreedy188aedf2017-06-13 21:32:16 -0400[diff] [blame]606user here. It then exits.</p>
607<p>A common cause of failure is a user-written file with the same name as a
608standard library module, such as <em>random.py</em> and <em>tkinter.py</em>. When such a
609file is located in the same directory as a file that is about to be run,
610IDLE cannot import the stdlib file. The current fix is to rename the
611user file.</p>
612<p>Though less common than in the past, an antivirus or firewall program may
613stop the connection. If the program cannot be taught to allow the
614connection, then it must be turned off for IDLE to work. It is safe to
615allow this internal connection because no data is visible on external
616ports. A similar problem is a network mis-configuration that blocks
617connections.</p>
618<p>Python installation issues occasionally stop IDLE: multiple versions can
619clash, or a single installation might need admin access. If one undo the
620clash, or cannot or does not want to run as admin, it might be easiest to
621completely remove Python and start over.</p>
622<p>A zombie pythonw.exe process could be a problem. On Windows, use Task
623Manager to detect and stop one. Sometimes a restart initiated by a program
624crash or Keyboard Interrupt (control-C) may fail to connect. Dismissing
625the error box or Restart Shell on the Shell menu may fix a temporary problem.</p>
626<p>When IDLE first starts, it attempts to read user configuration files in
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]627~/.idlerc/ (~ is one’s home directory). If there is a problem, an error
terryjreedy188aedf2017-06-13 21:32:16 -0400[diff] [blame]628message should be displayed. Leaving aside random disk glitches, this can
629be prevented by never editing the files by hand, using the configuration
630dialog, under Options, instead Options. Once it happens, the solution may
631be to delete one or more of the configuration files.</p>
632<p>If IDLE quits with no message, and it was not started from a console, try
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]633starting from a console (<code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-m</span> <span class="pre">idlelib)</span></code> and see if a message appears.</p>
terryjreedy188aedf2017-06-13 21:32:16 -0400[diff] [blame]634</div>
Terry Jan Reedyf1d3efc2018-11-05 22:17:57 -0500[diff] [blame]635<div class="section" id="running-user-code">
636<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 -0400[diff] [blame]637<p>With rare exceptions, the result of executing Python code with IDLE is
Terry Jan Reedyf1d3efc2018-11-05 22:17:57 -0500[diff] [blame]638intended to be the same as executing the same code by the default method,
639directly with Python in a text-mode system console or terminal window.
Terry Jan Reedy98758bc2017-09-12 09:05:16 -0400[diff] [blame]640However, the different interface and operation occasionally affect
Terry Jan Reedyf1d3efc2018-11-05 22:17:57 -0500[diff] [blame]641visible results. For instance, <code class="docutils literal notranslate"><span class="pre">sys.modules</span></code> starts with more entries,
642and <code class="docutils literal notranslate"><span class="pre">threading.activeCount()</span></code> returns 2 instead of 1.</p>
643<p>By default, IDLE runs user code in a separate OS process rather than in
644the user interface process that runs the shell and editor. In the execution
645process, 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>
646with objects that get input from and send output to the Shell window.
647The 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
648<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>
649<p>When Shell has the focus, it controls the keyboard and screen. This is
Terry Jan Reedy98758bc2017-09-12 09:05:16 -0400[diff] [blame]650normally transparent, but functions that directly access the keyboard
Terry Jan Reedyf1d3efc2018-11-05 22:17:57 -0500[diff] [blame]651and screen will not work. These include system-specific functions that
652determine whether a key has been pressed and if so, which.</p>
653<p>IDLE’s standard stream replacements are not inherited by subprocesses
654created in the execution process, whether directly by user code or by modules
655such as multiprocessing. If such subprocess use <code class="docutils literal notranslate"><span class="pre">input</span></code> from sys.stdin
656or <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,
657IDLE should be started in a command line window. The secondary subprocess
658will then be attached to that window for input and output.</p>
659<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>,
660IDLE’s changes are lost and input from the keyboard and output to the screen
661will not work correctly.</p>
Terry Jan Reedy6d965b32019-05-19 22:52:22 -0400[diff] [blame^]662<p>When user code raises SystemExit either directly or by calling sys.exit, IDLE
663returns to a Shell prompt instead of exiting.</p>
Terry Jan Reedy0053c472015-09-24 03:09:43 -0400[diff] [blame]664</div>
Terry Jan Reedy75d9d592018-11-06 12:37:36 -0500[diff] [blame]665<div class="section" id="user-output-in-shell">
666<h3>User output in Shell<a class="headerlink" href="#user-output-in-shell" title="Permalink to this headline"></a></h3>
667<p>When a program outputs text, the result is determined by the
668corresponding output device. When IDLE executes user code, <code class="docutils literal notranslate"><span class="pre">sys.stdout</span></code>
669and <code class="docutils literal notranslate"><span class="pre">sys.stderr</span></code> are connected to the display area of IDLE’s Shell. Some of
670its features are inherited from the underlying Tk Text widget. Others
Terry Jan Reedy76cd0c32018-11-06 23:55:06 -0500[diff] [blame]671are programmed additions. Where it matters, Shell is designed for development
672rather than production runs.</p>
673<p>For instance, Shell never throws away output. A program that sends unlimited
674output to Shell will eventually fill memory, resulting in a memory error.
675In contrast, some system text windows only keep the last n lines of output.
676A Windows console, for instance, keeps a user-settable 1 to 9999 lines,
677with 300 the default.</p>
Terry Jan Reedy55d03512019-04-26 23:22:36 -0400[diff] [blame]678<p>A Tk Text widget, and hence IDLE’s Shell, displays characters (codepoints) in
679the BMP (Basic Multilingual Plane) subset of Unicode. Which characters are
680displayed with a proper glyph and which with a replacement box depends on the
681operating system and installed fonts. Tab characters cause the following text
682to begin after the next tab stop. (They occur every 8 ‘characters’). Newline
683characters cause following text to appear on a new line. Other control
684characters are ignored or displayed as a space, box, or something else,
685depending on the operating system and font. (Moving the text cursor through
686such output with arrow keys may exhibit some surprising spacing behavior.)</p>
687<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>
688<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>
689<span class="go">14</span>
690<span class="gp">&gt;&gt;&gt; </span><span class="n">s</span> <span class="c1"># Display repr(s)</span>
691<span class="go">&#39;a\tb\x07&lt;\x02&gt;&lt;\r&gt;\x08c\nd&#39;</span>
692<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>
693<span class="go"># Result varies by OS and font. Try it.</span>
Terry Jan Reedy8a03ff22019-02-08 22:51:51 -0500[diff] [blame]694</pre></div>
695</div>
696<p>The <code class="docutils literal notranslate"><span class="pre">repr</span></code> function is used for interactive echo of expression
697values. It returns an altered version of the input string in which
698control codes, some BMP codepoints, and all non-BMP codepoints are
699replaced with escape codes. As demonstrated above, it allows one to
700identify the characters in a string, regardless of how they are displayed.</p>
Terry Jan Reedy75d9d592018-11-06 12:37:36 -0500[diff] [blame]701<p>Normal and error output are generally kept separate (on separate lines)
702from code input and each other. They each get different highlight colors.</p>
703<p>For SyntaxError tracebacks, the normal ‘^’ marking where the error was
704detected is replaced by coloring the text with an error highlight.
705When code run from a file causes other exceptions, one may right click
706on a traceback line to jump to the corresponding line in an IDLE editor.
707The file will be opened if necessary.</p>
708<p>Shell has a special facility for squeezing output lines down to a
709‘Squeezed text’ label. This is done automatically
710for output over N lines (N = 50 by default).
711N can be changed in the PyShell section of the General
712page of the Settings dialog. Output with fewer lines can be squeezed by
713right clicking on the output. This can be useful lines long enough to slow
714down scrolling.</p>
715<p>Squeezed output is expanded in place by double-clicking the label.
716It can also be sent to the clipboard or a separate view window by
717right-clicking the label.</p>
718</div>
Terry Jan Reedy98758bc2017-09-12 09:05:16 -0400[diff] [blame]719<div class="section" id="developing-tkinter-applications">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]720<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 -0400[diff] [blame]721<p>IDLE is intentionally different from standard Python in order to
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]722facilitate 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 -0400[diff] [blame]723<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
724in IDLE and a tk window appears. In standard Python, one must also enter
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]725<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 -0400[diff] [blame]726background, about 20 times a second, which is about every 50 milliseconds.
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]727Next 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,
728nothing visibly changes in standard Python until one enters <code class="docutils literal notranslate"><span class="pre">root.update()</span></code>.</p>
729<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 -0400[diff] [blame]730return until the tk app is destroyed. If the program is run with
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]731<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
732appear 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 -0400[diff] [blame]733to interact with.</p>
734<p>When running a tkinter program from an IDLE editor, one can comment out
735the mainloop call. One then gets a shell prompt immediately and can
736interact with the live application. One just has to remember to
737re-enable the mainloop call when running in standard Python.</p>
738</div>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]739<div class="section" id="running-without-a-subprocess">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]740<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 -0400[diff] [blame]741<p>By default, IDLE executes user code in a separate subprocess via a socket,
Terry Jan Reedy6e10ec52015-09-23 20:00:33 -0400[diff] [blame]742which uses the internal loopback interface. This connection is not
743externally visible and no data is sent to or received from the Internet.
744If firewall software complains anyway, you can ignore it.</p>
745<p>If the attempt to make the socket connection fails, Idle will notify you.
746Such failures are sometimes transient, but if persistent, the problem
terryjreedy188aedf2017-06-13 21:32:16 -0400[diff] [blame]747may be either a firewall blocking the connection or misconfiguration of
Terry Jan Reedy6e10ec52015-09-23 20:00:33 -0400[diff] [blame]748a particular system. Until the problem is fixed, one can run Idle with
749the -n command line switch.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]750<p>If IDLE is started with the -n command line switch it will run in a
751single process and will not create the subprocess which runs the RPC
752Python execution server. This can be useful if Python cannot create
753the subprocess or the RPC socket interface on your platform. However,
754in this mode user code is not isolated from IDLE itself. Also, the
755environment is not restarted when Run/Run Module (F5) is selected. If
756your code has been modified, you must reload() the affected modules and
757re-import any specific items (e.g. from foo import baz) if the changes
758are to take effect. For these reasons, it is preferable to run IDLE
759with the default subprocess if at all possible.</p>
760<div class="deprecated">
761<p><span class="versionmodified">Deprecated since version 3.4.</span></p>
762</div>
763</div>
764</div>
765<div class="section" id="help-and-preferences">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]766<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 -0400[diff] [blame]767<div class="section" id="help-sources">
Cheryl Sabella01421be2018-12-20 00:38:54 -0500[diff] [blame]768<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 -0400[diff] [blame]769<p>Help menu entry “IDLE Help” displays a formatted html version of the
770IDLE chapter of the Library Reference. The result, in a read-only
771tkinter text window, is close to what one sees in a web browser.
772Navigate through the text with a mousewheel,
773the scrollbar, or up and down arrow keys held down.
774Or click the TOC (Table of Contents) button and select a section
775header in the opened box.</p>
776<p>Help menu entry “Python Docs” opens the extensive sources of help,
777including tutorials, available at docs.python.org/x.y, where ‘x.y’
778is the currently running Python version. If your system
779has an off-line copy of the docs (this may be an installation option),
780that will be opened instead.</p>
781<p>Selected URLs can be added or removed from the help menu at any time using the
782General tab of the Configure IDLE dialog .</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]783</div>
784<div class="section" id="setting-preferences">
Terry Jan Reedy292cd6e2018-12-20 06:06:29 -0500[diff] [blame]785<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 -0400[diff] [blame]786<p>The font preferences, highlighting, keys, and general preferences can be
Terry Jan Reedy292cd6e2018-12-20 06:06:29 -0500[diff] [blame]787changed via Configure IDLE on the Option menu.
788Non-default user settings are saved in a .idlerc directory in the user’s
789home directory. Problems caused by bad user configuration files are solved
790by editing or deleting one or more of the files in .idlerc.</p>
Terry Jan Reedyd6101162019-02-23 23:04:53 -0500[diff] [blame]791<p>On the Font tab, see the text sample for the effect of font face and size
792on multiple characters in multiple languages. Edit the sample to add
793other characters of personal interest. Use the sample to select
794monospaced fonts. If particular characters have problems in Shell or an
795editor, add them to the top of the sample and try changing first size
796and then font.</p>
Terry Jan Reedy292cd6e2018-12-20 06:06:29 -0500[diff] [blame]797<p>On the Highlights and Keys tab, select a built-in or custom color theme
798and key set. To use a newer built-in color theme or key set with older
799IDLEs, save it as a new custom theme or key set and it well be accessible
800to older IDLEs.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]801</div>
Terry Jan Reedy50ff02b2018-11-10 23:26:31 -0500[diff] [blame]802<div class="section" id="idle-on-macos">
Terry Jan Reedyb65413b2018-11-15 13:15:13 -0500[diff] [blame]803<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 -0500[diff] [blame]804<p>Under System Preferences: Dock, one can set “Prefer tabs when opening
805documents” to “Always”. This setting is not compatible with the tk/tkinter
806GUI framework used by IDLE, and it breaks a few IDLE features.</p>
807</div>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]808<div class="section" id="extensions">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]809<h3>Extensions<a class="headerlink" href="#extensions" title="Permalink to this headline"></a></h3>
terryjreedy188aedf2017-06-13 21:32:16 -0400[diff] [blame]810<p>IDLE contains an extension facility. Preferences for extensions can be
Terry Jan Reedyadb4cd22017-09-12 07:45:15 -0400[diff] [blame]811changed with the Extensions tab of the preferences dialog. See the
812beginning of config-extensions.def in the idlelib directory for further
813information. The only current default extension is zzdummy, an example
Terry Jan Reedy98758bc2017-09-12 09:05:16 -0400[diff] [blame]814also used for testing.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]815</div>
816</div>
817</div>
818
819
820 </div>
821 </div>
822 </div>
Terry Jan Reedyf8cd02d2016-03-01 00:29:57 -0500[diff] [blame]823 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]824 <div class="sphinxsidebarwrapper">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]825 <h3><a href="../contents.html">Table of Contents</a></h3>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]826 <ul>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]827<li><a class="reference internal" href="#">IDLE</a><ul>
828<li><a class="reference internal" href="#menus">Menus</a><ul>
829<li><a class="reference internal" href="#file-menu-shell-and-editor">File menu (Shell and Editor)</a></li>
830<li><a class="reference internal" href="#edit-menu-shell-and-editor">Edit menu (Shell and Editor)</a></li>
831<li><a class="reference internal" href="#format-menu-editor-window-only">Format menu (Editor window only)</a></li>
832<li><a class="reference internal" href="#run-menu-editor-window-only">Run menu (Editor window only)</a></li>
833<li><a class="reference internal" href="#shell-menu-shell-window-only">Shell menu (Shell window only)</a></li>
834<li><a class="reference internal" href="#debug-menu-shell-window-only">Debug menu (Shell window only)</a></li>
835<li><a class="reference internal" href="#options-menu-shell-and-editor">Options menu (Shell and Editor)</a></li>
836<li><a class="reference internal" href="#window-menu-shell-and-editor">Window menu (Shell and Editor)</a></li>
837<li><a class="reference internal" href="#help-menu-shell-and-editor">Help menu (Shell and Editor)</a></li>
838<li><a class="reference internal" href="#context-menus">Context Menus</a></li>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]839</ul>
840</li>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]841<li><a class="reference internal" href="#editing-and-navigation">Editing and navigation</a><ul>
Terry Jan Reedyea9c8bd2018-10-28 20:42:18 -0400[diff] [blame]842<li><a class="reference internal" href="#editor-windows">Editor windows</a></li>
843<li><a class="reference internal" href="#key-bindings">Key bindings</a></li>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]844<li><a class="reference internal" href="#automatic-indentation">Automatic indentation</a></li>
845<li><a class="reference internal" href="#completions">Completions</a></li>
846<li><a class="reference internal" href="#calltips">Calltips</a></li>
Cheryl Sabella01421be2018-12-20 00:38:54 -0500[diff] [blame]847<li><a class="reference internal" href="#code-context">Code Context</a></li>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]848<li><a class="reference internal" href="#python-shell-window">Python Shell window</a></li>
849<li><a class="reference internal" href="#text-colors">Text colors</a></li>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]850</ul>
851</li>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]852<li><a class="reference internal" href="#startup-and-code-execution">Startup and code execution</a><ul>
853<li><a class="reference internal" href="#command-line-usage">Command line usage</a></li>
854<li><a class="reference internal" href="#startup-failure">Startup failure</a></li>
Terry Jan Reedyf1d3efc2018-11-05 22:17:57 -0500[diff] [blame]855<li><a class="reference internal" href="#running-user-code">Running user code</a></li>
Terry Jan Reedy75d9d592018-11-06 12:37:36 -0500[diff] [blame]856<li><a class="reference internal" href="#user-output-in-shell">User output in Shell</a></li>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]857<li><a class="reference internal" href="#developing-tkinter-applications">Developing tkinter applications</a></li>
858<li><a class="reference internal" href="#running-without-a-subprocess">Running without a subprocess</a></li>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]859</ul>
860</li>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]861<li><a class="reference internal" href="#help-and-preferences">Help and preferences</a><ul>
Terry Jan Reedy18032632018-10-28 16:21:18 -0400[diff] [blame]862<li><a class="reference internal" href="#help-sources">Help sources</a></li>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]863<li><a class="reference internal" href="#setting-preferences">Setting preferences</a></li>
Terry Jan Reedyb65413b2018-11-15 13:15:13 -0500[diff] [blame]864<li><a class="reference internal" href="#idle-on-macos">IDLE on macOS</a></li>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]865<li><a class="reference internal" href="#extensions">Extensions</a></li>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]866</ul>
867</li>
868</ul>
869</li>
870</ul>
871
872 <h4>Previous topic</h4>
873 <p class="topless"><a href="tkinter.scrolledtext.html"
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]874 title="previous chapter"><code class="docutils literal notranslate"><span class="pre">tkinter.scrolledtext</span></code> — Scrolled Text Widget</a></p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]875 <h4>Next topic</h4>
876 <p class="topless"><a href="othergui.html"
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]877 title="next chapter">Other Graphical User Interface Packages</a></p>
Terry Jan Reedy4b736762016-09-12 01:50:03 -0400[diff] [blame]878 <div role="note" aria-label="source link">
879 <h3>This Page</h3>
880 <ul class="this-page-menu">
881 <li><a href="../bugs.html">Report a Bug</a></li>
terryjreedy188aedf2017-06-13 21:32:16 -0400[diff] [blame]882 <li>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]883 <a href="https://github.com/python/cpython/blob/master/Doc/library/idle.rst"
terryjreedy188aedf2017-06-13 21:32:16 -0400[diff] [blame]884 rel="nofollow">Show Source
885 </a>
886 </li>
Terry Jan Reedy4b736762016-09-12 01:50:03 -0400[diff] [blame]887 </ul>
888 </div>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]889 </div>
890 </div>
891 <div class="clearer"></div>
Terry Jan Reedy963a38b2015-09-20 20:03:01 -0400[diff] [blame]892 </div>
Terry Jan Reedyf8cd02d2016-03-01 00:29:57 -0500[diff] [blame]893 <div class="related" role="navigation" aria-label="related navigation">
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]894 <h3>Navigation</h3>
895 <ul>
896 <li class="right" style="margin-right: 10px">
897 <a href="../genindex.html" title="General Index"
898 >index</a></li>
899 <li class="right" >
900 <a href="../py-modindex.html" title="Python Module Index"
901 >modules</a> |</li>
902 <li class="right" >
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]903 <a href="othergui.html" title="Other Graphical User Interface Packages"
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]904 >next</a> |</li>
905 <li class="right" >
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]906 <a href="tkinter.scrolledtext.html" title="tkinter.scrolledtext — Scrolled Text Widget"
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]907 >previous</a> |</li>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]908
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]909 <li><img src="../_static/py.png" alt=""
910 style="vertical-align: middle; margin-top: -1px"/></li>
911 <li><a href="https://www.python.org/">Python</a> &#187;</li>
912
913
914 <li>
Terry Jan Reedy8a533ff2019-05-16 01:20:37 -0400[diff] [blame]915 <a href="../index.html">3.8.0a4 Documentation</a> &#187;
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]916 </li>
917
918 <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 -0400[diff] [blame]919 <li class="nav-item nav-item-2"><a href="tk.html" >Graphical User Interfaces with Tk</a> &#187;</li>
Terry Jan Reedy4b736762016-09-12 01:50:03 -0400[diff] [blame]920 <li class="right">
921
922
923 <div class="inline-search" style="display: none" role="search">
924 <form class="inline-search" action="../search.html" method="get">
925 <input placeholder="Quick search" type="text" name="q" />
926 <input type="submit" value="Go" />
927 <input type="hidden" name="check_keywords" value="yes" />
928 <input type="hidden" name="area" value="default" />
929 </form>
930 </div>
931 <script type="text/javascript">$('.inline-search').show(0);</script>
932 |
933 </li>
934
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]935 </ul>
Terry Jan Reedy963a38b2015-09-20 20:03:01 -0400[diff] [blame]936 </div>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]937 <div class="footer">
Terry Jan Reedy8a03ff22019-02-08 22:51:51 -0500[diff] [blame]938 &copy; <a href="../copyright.html">Copyright</a> 2001-2019, Python Software Foundation.
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]939 <br />
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]940
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]941 The Python Software Foundation is a non-profit corporation.
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]942<a href="https://www.python.org/psf/donations/">Please donate.</a>
943<br />
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]944 <br />
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]945
Terry Jan Reedy6d965b32019-05-19 22:52:22 -0400[diff] [blame^]946 Last updated on May 19, 2019.
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]947 <a href="https://docs.python.org/3/bugs.html">Found a bug</a>?
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]948 <br />
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]949
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]950 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.8.1.
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]951 </div>
952
953 </body>
Terry Jan Reedy963a38b2015-09-20 20:03:01 -0400[diff] [blame]954</html>