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