Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / cpython3 / 50ff02b43145f33f8e28ffbfcc6a9d15c4749a64 / . / Lib / idlelib / help.html
blob: a8afc75c316ca30b30aa0e6eb802aa902705a49b [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 Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]9 <title>IDLE &#8212; Python 3.8.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>
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 Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]22 title="Search within Python 3.8.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>
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>
75 <a href="../index.html">3.8.0a0 Documentation</a> &#187;
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 Reedy0053c472015-09-24 03:09:43 -0400[diff] [blame]111<li>cross-platform: works mostly the same on Windows, Unix, and Mac OS X</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>
131<p>On MacOS, there is one application menu. It dynamically changes according
132to the window currently selected. It has an IDLE menu, and some entries
133described below are moved around to conform to Apple guidlines.</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
205Completions in the Tips sections below.</dd>
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
211function parameter hints.</dd>
212<dt>Show surrounding parens</dt>
213<dd>Highlight the surrounding parenthesis.</dd>
214</dl>
215</div>
216<div class="section" id="format-menu-editor-window-only">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]217<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]218<dl class="docutils">
219<dt>Indent Region</dt>
220<dd>Shift selected lines right by the indent width (default 4 spaces).</dd>
221<dt>Dedent Region</dt>
222<dd>Shift selected lines left by the indent width (default 4 spaces).</dd>
223<dt>Comment Out Region</dt>
224<dd>Insert ## in front of selected lines.</dd>
225<dt>Uncomment Region</dt>
226<dd>Remove leading # or ## from selected lines.</dd>
227<dt>Tabify Region</dt>
228<dd>Turn <em>leading</em> stretches of spaces into tabs. (Note: We recommend using
2294 space blocks to indent Python code.)</dd>
230<dt>Untabify Region</dt>
231<dd>Turn <em>all</em> tabs into the correct number of spaces.</dd>
232<dt>Toggle Tabs</dt>
233<dd>Open a dialog to switch between indenting with spaces and tabs.</dd>
234<dt>New Indent Width</dt>
235<dd>Open a dialog to change indent width. The accepted default by the Python
236community is 4 spaces.</dd>
237<dt>Format Paragraph</dt>
238<dd>Reformat the current blank-line-delimited paragraph in comment block or
239multiline string or selected line in a string. All lines in the
240paragraph will be formatted to less than N columns, where N defaults to 72.</dd>
241<dt>Strip trailing whitespace</dt>
Terry Jan Reedyff702892017-09-15 13:05:28 -0400[diff] [blame]242<dd>Remove trailing space and other whitespace characters after the last
243non-whitespace character of a line by applying str.rstrip to each line,
244including lines within multiline strings.</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]245</dl>
246</div>
247<div class="section" id="run-menu-editor-window-only">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]248<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]249<dl class="docutils">
250<dt>Python Shell</dt>
251<dd>Open or wake up the Python Shell window.</dd>
252<dt>Check Module</dt>
253<dd>Check the syntax of the module currently open in the Editor window. If the
254module has not been saved IDLE will either prompt the user to save or
255autosave, as selected in the General tab of the Idle Settings dialog. If
256there is a syntax error, the approximate location is indicated in the
257Editor window.</dd>
258<dt>Run Module</dt>
259<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]260environment, then execute the module. Output is displayed in the Shell
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]261window. 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]262When execution is complete, the Shell retains focus and displays a prompt.
263At this point, one may interactively explore the result of execution.
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]264This 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]265line.</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]266</dl>
267</div>
268<div class="section" id="shell-menu-shell-window-only">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]269<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]270<dl class="docutils">
271<dt>View Last Restart</dt>
272<dd>Scroll the shell window to the last Shell restart.</dd>
273<dt>Restart Shell</dt>
274<dd>Restart the shell to clean the environment.</dd>
Terry Jan Reedy4b736762016-09-12 01:50:03 -0400[diff] [blame]275<dt>Interrupt Execution</dt>
276<dd>Stop a running program.</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]277</dl>
278</div>
279<div class="section" id="debug-menu-shell-window-only">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]280<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]281<dl class="docutils">
282<dt>Go to File/Line</dt>
283<dd>Look on the current line. with the cursor, and the line above for a filename
284and line number. If found, open the file if not already open, and show the
285line. Use this to view source lines referenced in an exception traceback
286and lines found by Find in Files. Also available in the context menu of
287the Shell window and Output windows.</dd>
288</dl>
289<dl class="docutils" id="index-3">
290<dt>Debugger (toggle)</dt>
terryjreedy188aedf2017-06-13 21:32:16 -0400[diff] [blame]291<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]292under the debugger. In the Editor, breakpoints can be set with the context
293menu. This feature is still incomplete and somewhat experimental.</dd>
294<dt>Stack Viewer</dt>
295<dd>Show the stack traceback of the last exception in a tree widget, with
296access to locals and globals.</dd>
297<dt>Auto-open Stack Viewer</dt>
298<dd>Toggle automatically opening the stack viewer on an unhandled exception.</dd>
299</dl>
300</div>
301<div class="section" id="options-menu-shell-and-editor">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]302<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]303<dl class="docutils">
304<dt>Configure IDLE</dt>
Terry Jan Reedy93f35422015-10-13 22:03:51 -0400[diff] [blame]305<dd><p class="first">Open a configuration dialog and change preferences for the following:
306fonts, indentation, keybindings, text color themes, startup windows and
307size, additional help sources, and extensions (see below). On OS X,
308open the configuration dialog by selecting Preferences in the application
309menu. To use a new built-in color theme (IDLE Dark) with older IDLEs,
310save it as a new custom theme.</p>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]311<p class="last">Non-default user settings are saved in a .idlerc directory in the user’s
Terry Jan Reedy93f35422015-10-13 22:03:51 -0400[diff] [blame]312home directory. Problems caused by bad user configuration files are solved
313by editing or deleting one or more of the files in .idlerc.</p>
314</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]315<dt>Code Context (toggle)(Editor Window only)</dt>
316<dd>Open a pane at the top of the edit window which shows the block context
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]317of the code which has scrolled above the top of the window. Clicking a
318line in this pane exposes that line at the top of the editor.</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]319</dl>
320</div>
321<div class="section" id="window-menu-shell-and-editor">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]322<h3>Window menu (Shell and Editor)<a class="headerlink" href="#window-menu-shell-and-editor" title="Permalink to this headline"></a></h3>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]323<dl class="docutils">
324<dt>Zoom Height</dt>
325<dd>Toggles the window between normal size and maximum height. The initial size
326defaults to 40 lines by 80 chars unless changed on the General tab of the
327Configure IDLE dialog.</dd>
328</dl>
329<p>The rest of this menu lists the names of all open windows; select one to bring
330it to the foreground (deiconifying it if necessary).</p>
331</div>
332<div class="section" id="help-menu-shell-and-editor">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]333<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]334<dl class="docutils">
335<dt>About IDLE</dt>
336<dd>Display version, copyright, license, credits, and more.</dd>
337<dt>IDLE Help</dt>
Terry Jan Reedy18032632018-10-28 16:21:18 -0400[diff] [blame]338<dd>Display this IDLE document, detailing the menu options, basic editing and
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]339navigation, and other tips.</dd>
340<dt>Python Docs</dt>
341<dd>Access local Python documentation, if installed, or start a web browser
342and open docs.python.org showing the latest Python documentation.</dd>
343<dt>Turtle Demo</dt>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]344<dd>Run the turtledemo module with example Python code and turtle drawings.</dd>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]345</dl>
346<p>Additional help sources may be added here with the Configure IDLE dialog under
Terry Jan Reedy18032632018-10-28 16:21:18 -0400[diff] [blame]347the General tab. See the “Help sources” subsection below for more
348on Help menu choices.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]349</div>
350<div class="section" id="context-menus">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]351<span id="index-4"></span><h3>Context Menus<a class="headerlink" href="#context-menus" title="Permalink to this headline"></a></h3>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]352<p>Open a context menu by right-clicking in a window (Control-click on OS X).
353Context menus have the standard clipboard functions also on the Edit menu.</p>
354<dl class="docutils">
355<dt>Cut</dt>
356<dd>Copy selection into the system-wide clipboard; then delete the selection.</dd>
357<dt>Copy</dt>
358<dd>Copy selection into the system-wide clipboard.</dd>
359<dt>Paste</dt>
360<dd>Insert contents of the system-wide clipboard into the current window.</dd>
361</dl>
362<p>Editor windows also have breakpoint functions. Lines with a breakpoint set are
363specially marked. Breakpoints only have an effect when running under the
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]364debugger. Breakpoints for a file are saved in the user’s .idlerc directory.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]365<dl class="docutils">
366<dt>Set Breakpoint</dt>
367<dd>Set a breakpoint on the current line.</dd>
368<dt>Clear Breakpoint</dt>
369<dd>Clear the breakpoint on that line.</dd>
370</dl>
Terry Jan Reedy68d6dc02018-10-28 12:44:44 -0400[diff] [blame]371<p>Shell and Output windows also have the following.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]372<dl class="docutils">
373<dt>Go to file/line</dt>
374<dd>Same as in Debug menu.</dd>
375</dl>
Terry Jan Reedy68d6dc02018-10-28 12:44:44 -0400[diff] [blame]376<p>The Shell window also has an output squeezing facility explained in the
377the <em>Python Shell window</em> subsection below.</p>
378<dl class="docutils">
379<dt>Squeeze</dt>
380<dd>If the cursor is over an output line, squeeze all the output between
381the code above and the prompt below down to a ‘Squeezed text’ label.</dd>
382</dl>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]383</div>
384</div>
385<div class="section" id="editing-and-navigation">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]386<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]387<div class="section" id="editor-windows">
388<h3>Editor windows<a class="headerlink" href="#editor-windows" title="Permalink to this headline"></a></h3>
389<p>IDLE may open editor windows when it starts, depending on settings
390and how you start IDLE. Thereafter, use the File menu. There can be only
391one open editor window for a given file.</p>
392<p>The title bar contains the name of the file, the full path, and the version
393of Python and IDLE running the window. The status bar contains the line
394number (‘Ln’) and column number (‘Col’). Line numbers start with 1;
395column numbers with 0.</p>
396<p>IDLE assumes that files with a known .py* extension contain Python code
397and that other files do not. Run Python code with the Run menu.</p>
398</div>
399<div class="section" id="key-bindings">
400<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]401<p>In this section, ‘C’ refers to the <kbd class="kbd docutils literal notranslate">Control</kbd> key on Windows and Unix and
402the <kbd class="kbd docutils literal notranslate">Command</kbd> key on Mac OSX.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]403<ul>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]404<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]405</li>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]406<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]407</li>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]408<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]409</li>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]410<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]411</li>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]412<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]413</li>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]414<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]415</li>
416<li><p class="first">Some useful Emacs bindings are inherited from Tcl/Tk:</p>
417<blockquote>
418<div><ul class="simple">
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]419<li><kbd class="kbd docutils literal notranslate">C-a</kbd> beginning of line</li>
420<li><kbd class="kbd docutils literal notranslate">C-e</kbd> end of line</li>
421<li><kbd class="kbd docutils literal notranslate">C-k</kbd> kill line (but doesn’t put it in clipboard)</li>
422<li><kbd class="kbd docutils literal notranslate">C-l</kbd> center window around the insertion point</li>
423<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]424also use the cursor key for this)</li>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]425<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]426also use the cursor key for this)</li>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]427<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]428this)</li>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]429<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]430</ul>
431</div></blockquote>
432</li>
433</ul>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]434<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]435may work. Keybindings are selected in the Configure IDLE dialog.</p>
Terry Jan Reedyea9c8bd2018-10-28 20:42:18 -0400[diff] [blame]436</div>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]437<div class="section" id="automatic-indentation">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]438<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]439<p>After a block-opening statement, the next line is indented by 4 spaces (in the
440Python Shell window by one tab). After certain keywords (break, return etc.)
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]441the next line is dedented. In leading indentation, <kbd class="kbd docutils literal notranslate">Backspace</kbd> deletes up
442to 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]443Shell window one tab), number depends on Indent width. Currently, tabs
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]444are restricted to four spaces due to Tcl/Tk limitations.</p>
445<p>See also the indent/dedent region commands in the edit menu.</p>
446</div>
447<div class="section" id="completions">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]448<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">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]483<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>
505<div class="section" id="python-shell-window">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]506<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]507<p>With IDLE’s Shell, one enters, edits, and recalls complete statements.
508Most consoles and terminals only work with a single physical line at a time.</p>
509<p>When one pastes code into Shell, it is not compiled and possibly executed
510until one hits <kbd class="kbd docutils literal notranslate">Return</kbd>. One may edit pasted code first.
511If one pastes more that one statement into Shell, the result will be a
512<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>
513<p>The editing features described in previous subsections work when entering
514code interactively. IDLE’s Shell window also responds to the following keys.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]515<ul>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]516<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]517</li>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]518<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]519</li>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]520<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]521<p>Command history</p>
522<ul class="simple">
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]523<li><kbd class="kbd docutils literal notranslate">Alt-p</kbd> retrieves previous command matching what you have typed. On
524OS X use <kbd class="kbd docutils literal notranslate">C-p</kbd>.</li>
525<li><kbd class="kbd docutils literal notranslate">Alt-n</kbd> retrieves next. On OS X use <kbd class="kbd docutils literal notranslate">C-n</kbd>.</li>
526<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]527</ul>
528</li>
529</ul>
530</div>
Terry Jan Reedyce021db2015-09-24 23:18:57 -0400[diff] [blame]531<div class="section" id="text-colors">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]532<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]533<p>Idle defaults to black on white text, but colors text with special meanings.
534For the shell, these are shell output, shell error, user output, and
535user 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]536keywords, builtin class and function names, names following <code class="docutils literal notranslate"><span class="pre">class</span></code> and
537<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]538present), found text (when possible), and selected text.</p>
539<p>Text coloring is done in the background, so uncolorized text is occasionally
540visible. To change the color scheme, use the Configure IDLE dialog
541Highlighting tab. The marking of debugger breakpoint lines in the editor and
542text in popups and dialogs is not user-configurable.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]543</div>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]544</div>
Terry Jan Reedy0053c472015-09-24 03:09:43 -0400[diff] [blame]545<div class="section" id="startup-and-code-execution">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]546<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]547<p>Upon startup with the <code class="docutils literal notranslate"><span class="pre">-s</span></code> option, IDLE will execute the file referenced by
548the 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>.
549IDLE 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
550referenced is run. If <code class="docutils literal notranslate"><span class="pre">IDLESTARTUP</span></code> is not present, IDLE checks for
551<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]552convenient places to store functions that are used frequently from the IDLE
553shell, or for executing import statements to import common modules.</p>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]554<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
555Tk file is loaded unconditionally. This additional file is <code class="docutils literal notranslate"><span class="pre">.Idle.py</span></code> and is
556looked for in the user’s home directory. Statements in this file will be
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]557executed in the Tk namespace, so this file is not useful for importing
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]558functions to be used from IDLE’s Python shell.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]559<div class="section" id="command-line-usage">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]560<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]561<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]562
Terry Jan Reedy968e2852015-09-23 03:52:23 -0400[diff] [blame]563-c command run command in the shell window
564-d enable debugger and open shell window
565-e open editor window
Terry Jan Reedy3399e1e2016-08-30 16:58:01 -0400[diff] [blame]566-h print help message with legal combinations and exit
Terry Jan Reedy968e2852015-09-23 03:52:23 -0400[diff] [blame]567-i open shell window
568-r file run file in shell window
569-s run $IDLESTARTUP or $PYTHONSTARTUP first, in shell window
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]570-t title set title of shell window
Terry Jan Reedy968e2852015-09-23 03:52:23 -0400[diff] [blame]571- run stdin in shell (- must be last option before args)
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]572</pre></div>
573</div>
574<p>If there are arguments:</p>
Terry Jan Reedy968e2852015-09-23 03:52:23 -0400[diff] [blame]575<ul class="simple">
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]576<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
577<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>,
578or <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]579set in the Options dialog.</li>
580<li>Otherwise, arguments are files opened for editing and
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]581<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]582</ul>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]583</div>
terryjreedy188aedf2017-06-13 21:32:16 -0400[diff] [blame]584<div class="section" id="startup-failure">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]585<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]586<p>IDLE uses a socket to communicate between the IDLE GUI process and the user
587code execution process. A connection must be established whenever the Shell
588starts or restarts. (The latter is indicated by a divider line that says
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]589‘RESTART’). If the user process fails to connect to the GUI process, it
590displays 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]591user here. It then exits.</p>
592<p>A common cause of failure is a user-written file with the same name as a
593standard library module, such as <em>random.py</em> and <em>tkinter.py</em>. When such a
594file is located in the same directory as a file that is about to be run,
595IDLE cannot import the stdlib file. The current fix is to rename the
596user file.</p>
597<p>Though less common than in the past, an antivirus or firewall program may
598stop the connection. If the program cannot be taught to allow the
599connection, then it must be turned off for IDLE to work. It is safe to
600allow this internal connection because no data is visible on external
601ports. A similar problem is a network mis-configuration that blocks
602connections.</p>
603<p>Python installation issues occasionally stop IDLE: multiple versions can
604clash, or a single installation might need admin access. If one undo the
605clash, or cannot or does not want to run as admin, it might be easiest to
606completely remove Python and start over.</p>
607<p>A zombie pythonw.exe process could be a problem. On Windows, use Task
608Manager to detect and stop one. Sometimes a restart initiated by a program
609crash or Keyboard Interrupt (control-C) may fail to connect. Dismissing
610the error box or Restart Shell on the Shell menu may fix a temporary problem.</p>
611<p>When IDLE first starts, it attempts to read user configuration files in
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]612~/.idlerc/ (~ is one’s home directory). If there is a problem, an error
terryjreedy188aedf2017-06-13 21:32:16 -0400[diff] [blame]613message should be displayed. Leaving aside random disk glitches, this can
614be prevented by never editing the files by hand, using the configuration
615dialog, under Options, instead Options. Once it happens, the solution may
616be to delete one or more of the configuration files.</p>
617<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]618starting 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]619</div>
Terry Jan Reedyf1d3efc2018-11-05 22:17:57 -0500[diff] [blame]620<div class="section" id="running-user-code">
621<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]622<p>With rare exceptions, the result of executing Python code with IDLE is
Terry Jan Reedyf1d3efc2018-11-05 22:17:57 -0500[diff] [blame]623intended to be the same as executing the same code by the default method,
624directly with Python in a text-mode system console or terminal window.
Terry Jan Reedy98758bc2017-09-12 09:05:16 -0400[diff] [blame]625However, the different interface and operation occasionally affect
Terry Jan Reedyf1d3efc2018-11-05 22:17:57 -0500[diff] [blame]626visible results. For instance, <code class="docutils literal notranslate"><span class="pre">sys.modules</span></code> starts with more entries,
627and <code class="docutils literal notranslate"><span class="pre">threading.activeCount()</span></code> returns 2 instead of 1.</p>
628<p>By default, IDLE runs user code in a separate OS process rather than in
629the user interface process that runs the shell and editor. In the execution
630process, 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>
631with objects that get input from and send output to the Shell window.
632The 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
633<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>
634<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]635normally transparent, but functions that directly access the keyboard
Terry Jan Reedyf1d3efc2018-11-05 22:17:57 -0500[diff] [blame]636and screen will not work. These include system-specific functions that
637determine whether a key has been pressed and if so, which.</p>
638<p>IDLE’s standard stream replacements are not inherited by subprocesses
639created in the execution process, whether directly by user code or by modules
640such as multiprocessing. If such subprocess use <code class="docutils literal notranslate"><span class="pre">input</span></code> from sys.stdin
641or <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,
642IDLE should be started in a command line window. The secondary subprocess
643will then be attached to that window for input and output.</p>
644<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>,
645IDLE’s changes are lost and input from the keyboard and output to the screen
646will not work correctly.</p>
Terry Jan Reedy0053c472015-09-24 03:09:43 -0400[diff] [blame]647</div>
Terry Jan Reedy75d9d592018-11-06 12:37:36 -0500[diff] [blame]648<div class="section" id="user-output-in-shell">
649<h3>User output in Shell<a class="headerlink" href="#user-output-in-shell" title="Permalink to this headline"></a></h3>
650<p>When a program outputs text, the result is determined by the
651corresponding output device. When IDLE executes user code, <code class="docutils literal notranslate"><span class="pre">sys.stdout</span></code>
652and <code class="docutils literal notranslate"><span class="pre">sys.stderr</span></code> are connected to the display area of IDLE’s Shell. Some of
653its features are inherited from the underlying Tk Text widget. Others
Terry Jan Reedy76cd0c32018-11-06 23:55:06 -0500[diff] [blame]654are programmed additions. Where it matters, Shell is designed for development
655rather than production runs.</p>
656<p>For instance, Shell never throws away output. A program that sends unlimited
657output to Shell will eventually fill memory, resulting in a memory error.
658In contrast, some system text windows only keep the last n lines of output.
659A Windows console, for instance, keeps a user-settable 1 to 9999 lines,
660with 300 the default.</p>
Terry Jan Reedy75d9d592018-11-06 12:37:36 -0500[diff] [blame]661<p>Text widgets display a subset of Unicode, the Basic Multilingual Plane (BMP).
662Which characters get a proper glyph instead of a replacement box depends on
663the operating system and installed fonts. Newline characters cause following
Terry Jan Reedy76cd0c32018-11-06 23:55:06 -0500[diff] [blame]664text to appear on a new line, but other control characters are either
665replaced with a box or deleted. However, <code class="docutils literal notranslate"><span class="pre">repr()</span></code>, which is used for
666interactive echo of expression values, replaces control characters,
667some BMP codepoints, and all non-BMP characters with escape codes
668before they are output.</p>
Terry Jan Reedy75d9d592018-11-06 12:37:36 -0500[diff] [blame]669<p>Normal and error output are generally kept separate (on separate lines)
670from code input and each other. They each get different highlight colors.</p>
671<p>For SyntaxError tracebacks, the normal ‘^’ marking where the error was
672detected is replaced by coloring the text with an error highlight.
673When code run from a file causes other exceptions, one may right click
674on a traceback line to jump to the corresponding line in an IDLE editor.
675The file will be opened if necessary.</p>
676<p>Shell has a special facility for squeezing output lines down to a
677‘Squeezed text’ label. This is done automatically
678for output over N lines (N = 50 by default).
679N can be changed in the PyShell section of the General
680page of the Settings dialog. Output with fewer lines can be squeezed by
681right clicking on the output. This can be useful lines long enough to slow
682down scrolling.</p>
683<p>Squeezed output is expanded in place by double-clicking the label.
684It can also be sent to the clipboard or a separate view window by
685right-clicking the label.</p>
686</div>
Terry Jan Reedy98758bc2017-09-12 09:05:16 -0400[diff] [blame]687<div class="section" id="developing-tkinter-applications">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]688<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]689<p>IDLE is intentionally different from standard Python in order to
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]690facilitate 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]691<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
692in IDLE and a tk window appears. In standard Python, one must also enter
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]693<code class="docutils literal notranslate"><span class="pre">root.update()</span></code> to see the window. IDLE does the equivalent in the
Terry Jan Reedy98758bc2017-09-12 09:05:16 -0400[diff] [blame]694background, about 20 times a second, which is about every 50 milleseconds.
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]695Next 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,
696nothing visibly changes in standard Python until one enters <code class="docutils literal notranslate"><span class="pre">root.update()</span></code>.</p>
697<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]698return until the tk app is destroyed. If the program is run with
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]699<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
700appear 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]701to interact with.</p>
702<p>When running a tkinter program from an IDLE editor, one can comment out
703the mainloop call. One then gets a shell prompt immediately and can
704interact with the live application. One just has to remember to
705re-enable the mainloop call when running in standard Python.</p>
706</div>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]707<div class="section" id="running-without-a-subprocess">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]708<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]709<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]710which uses the internal loopback interface. This connection is not
711externally visible and no data is sent to or received from the Internet.
712If firewall software complains anyway, you can ignore it.</p>
713<p>If the attempt to make the socket connection fails, Idle will notify you.
714Such failures are sometimes transient, but if persistent, the problem
terryjreedy188aedf2017-06-13 21:32:16 -0400[diff] [blame]715may be either a firewall blocking the connection or misconfiguration of
Terry Jan Reedy6e10ec52015-09-23 20:00:33 -0400[diff] [blame]716a particular system. Until the problem is fixed, one can run Idle with
717the -n command line switch.</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]718<p>If IDLE is started with the -n command line switch it will run in a
719single process and will not create the subprocess which runs the RPC
720Python execution server. This can be useful if Python cannot create
721the subprocess or the RPC socket interface on your platform. However,
722in this mode user code is not isolated from IDLE itself. Also, the
723environment is not restarted when Run/Run Module (F5) is selected. If
724your code has been modified, you must reload() the affected modules and
725re-import any specific items (e.g. from foo import baz) if the changes
726are to take effect. For these reasons, it is preferable to run IDLE
727with the default subprocess if at all possible.</p>
728<div class="deprecated">
729<p><span class="versionmodified">Deprecated since version 3.4.</span></p>
730</div>
731</div>
732</div>
733<div class="section" id="help-and-preferences">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]734<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]735<div class="section" id="help-sources">
736<h3>Help sources<a class="headerlink" href="#help-sources" title="Permalink to this headline"></a></h3>
737<p>Help menu entry “IDLE Help” displays a formatted html version of the
738IDLE chapter of the Library Reference. The result, in a read-only
739tkinter text window, is close to what one sees in a web browser.
740Navigate through the text with a mousewheel,
741the scrollbar, or up and down arrow keys held down.
742Or click the TOC (Table of Contents) button and select a section
743header in the opened box.</p>
744<p>Help menu entry “Python Docs” opens the extensive sources of help,
745including tutorials, available at docs.python.org/x.y, where ‘x.y’
746is the currently running Python version. If your system
747has an off-line copy of the docs (this may be an installation option),
748that will be opened instead.</p>
749<p>Selected URLs can be added or removed from the help menu at any time using the
750General tab of the Configure IDLE dialog .</p>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]751</div>
752<div class="section" id="setting-preferences">
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]753<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]754<p>The font preferences, highlighting, keys, and general preferences can be
755changed via Configure IDLE on the Option menu. Keys can be user defined;
terryjreedy188aedf2017-06-13 21:32:16 -0400[diff] [blame]756IDLE ships with four built-in key sets. In addition, a user can create a
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]757custom key set in the Configure IDLE dialog under the keys tab.</p>
758</div>
Terry Jan Reedy50ff02b2018-11-10 23:26:31 -0500[diff] [blame^]759<div class="section" id="idle-on-macos">
760<h3>IDLE on MacOS<a class="headerlink" href="#idle-on-macos" title="Permalink to this headline"></a></h3>
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>
804<li><a class="reference internal" href="#python-shell-window">Python Shell window</a></li>
805<li><a class="reference internal" href="#text-colors">Text colors</a></li>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]806</ul>
807</li>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]808<li><a class="reference internal" href="#startup-and-code-execution">Startup and code execution</a><ul>
809<li><a class="reference internal" href="#command-line-usage">Command line usage</a></li>
810<li><a class="reference internal" href="#startup-failure">Startup failure</a></li>
Terry Jan Reedyf1d3efc2018-11-05 22:17:57 -0500[diff] [blame]811<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]812<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]813<li><a class="reference internal" href="#developing-tkinter-applications">Developing tkinter applications</a></li>
814<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]815</ul>
816</li>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]817<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]818<li><a class="reference internal" href="#help-sources">Help sources</a></li>
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]819<li><a class="reference internal" href="#setting-preferences">Setting preferences</a></li>
Terry Jan Reedy50ff02b2018-11-10 23:26:31 -0500[diff] [blame^]820<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]821<li><a class="reference internal" href="#extensions">Extensions</a></li>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]822</ul>
823</li>
824</ul>
825</li>
826</ul>
827
828 <h4>Previous topic</h4>
829 <p class="topless"><a href="tkinter.scrolledtext.html"
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]830 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]831 <h4>Next topic</h4>
832 <p class="topless"><a href="othergui.html"
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]833 title="next chapter">Other Graphical User Interface Packages</a></p>
Terry Jan Reedy4b736762016-09-12 01:50:03 -0400[diff] [blame]834 <div role="note" aria-label="source link">
835 <h3>This Page</h3>
836 <ul class="this-page-menu">
837 <li><a href="../bugs.html">Report a Bug</a></li>
terryjreedy188aedf2017-06-13 21:32:16 -0400[diff] [blame]838 <li>
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]839 <a href="https://github.com/python/cpython/blob/master/Doc/library/idle.rst"
terryjreedy188aedf2017-06-13 21:32:16 -0400[diff] [blame]840 rel="nofollow">Show Source
841 </a>
842 </li>
Terry Jan Reedy4b736762016-09-12 01:50:03 -0400[diff] [blame]843 </ul>
844 </div>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]845 </div>
846 </div>
847 <div class="clearer"></div>
Terry Jan Reedy963a38b2015-09-20 20:03:01 -0400[diff] [blame]848 </div>
Terry Jan Reedyf8cd02d2016-03-01 00:29:57 -0500[diff] [blame]849 <div class="related" role="navigation" aria-label="related navigation">
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]850 <h3>Navigation</h3>
851 <ul>
852 <li class="right" style="margin-right: 10px">
853 <a href="../genindex.html" title="General Index"
854 >index</a></li>
855 <li class="right" >
856 <a href="../py-modindex.html" title="Python Module Index"
857 >modules</a> |</li>
858 <li class="right" >
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]859 <a href="othergui.html" title="Other Graphical User Interface Packages"
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]860 >next</a> |</li>
861 <li class="right" >
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]862 <a href="tkinter.scrolledtext.html" title="tkinter.scrolledtext — Scrolled Text Widget"
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]863 >previous</a> |</li>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]864
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]865 <li><img src="../_static/py.png" alt=""
866 style="vertical-align: middle; margin-top: -1px"/></li>
867 <li><a href="https://www.python.org/">Python</a> &#187;</li>
868
869
870 <li>
871 <a href="../index.html">3.8.0a0 Documentation</a> &#187;
872 </li>
873
874 <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]875 <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]876 <li class="right">
877
878
879 <div class="inline-search" style="display: none" role="search">
880 <form class="inline-search" action="../search.html" method="get">
881 <input placeholder="Quick search" type="text" name="q" />
882 <input type="submit" value="Go" />
883 <input type="hidden" name="check_keywords" value="yes" />
884 <input type="hidden" name="area" value="default" />
885 </form>
886 </div>
887 <script type="text/javascript">$('.inline-search').show(0);</script>
888 |
889 </li>
890
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]891 </ul>
Terry Jan Reedy963a38b2015-09-20 20:03:01 -0400[diff] [blame]892 </div>
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]893 <div class="footer">
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]894 &copy; <a href="../copyright.html">Copyright</a> 2001-2018, Python Software Foundation.
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]895 <br />
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]896
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]897 The Python Software Foundation is a non-profit corporation.
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]898<a href="https://www.python.org/psf/donations/">Please donate.</a>
899<br />
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]900 <br />
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]901
Terry Jan Reedy50ff02b2018-11-10 23:26:31 -0500[diff] [blame^]902 Last updated on Nov 10, 2018.
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]903 <a href="https://docs.python.org/3/bugs.html">Found a bug</a>?
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]904 <br />
Terry Jan Reedyaf4b0132018-06-10 15:48:41 -0400[diff] [blame]905
Terry Jan Reedydb40cb52018-10-28 01:21:36 -0400[diff] [blame]906 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.8.1.
Terry Jan Reedy5d46ab12015-09-20 19:57:13 -0400[diff] [blame]907 </div>
908
909 </body>
Terry Jan Reedy963a38b2015-09-20 20:03:01 -0400[diff] [blame]910</html>