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