Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 1 | |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| 3 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 4 | |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 5 | <html xmlns="http://www.w3.org/1999/xhtml"> |
| 6 | <head> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 7 | <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 8 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 9 | <title>IDLE — Python 3.8.0a0 documentation</title> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 10 | <link rel="stylesheet" href="../_static/pydoctheme.css" type="text/css" /> |
| 11 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 12 | |
| 13 | <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 14 | <script type="text/javascript" src="../_static/jquery.js"></script> |
| 15 | <script type="text/javascript" src="../_static/underscore.js"></script> |
| 16 | <script type="text/javascript" src="../_static/doctools.js"></script> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 17 | <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script> |
| 18 | |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 19 | <script type="text/javascript" src="../_static/sidebar.js"></script> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 20 | |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 21 | <link rel="search" type="application/opensearchdescription+xml" |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 22 | title="Search within Python 3.8.0a0 documentation" |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 23 | href="../_static/opensearch.xml"/> |
| 24 | <link rel="author" title="About these documents" href="../about.html" /> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 25 | <link rel="index" title="Index" href="../genindex.html" /> |
| 26 | <link rel="search" title="Search" href="../search.html" /> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 27 | <link rel="copyright" title="Copyright" href="../copyright.html" /> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 28 | <link rel="next" title="Other Graphical User Interface Packages" href="othergui.html" /> |
| 29 | <link rel="prev" title="tkinter.scrolledtext — Scrolled Text Widget" href="tkinter.scrolledtext.html" /> |
terryjreedy | 188aedf | 2017-06-13 21:32:16 -0400 | [diff] [blame] | 30 | <link rel="canonical" href="https://docs.python.org/3/library/idle.html" /> |
| 31 | |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 32 | |
| 33 | |
| 34 | |
| 35 | |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 36 | |
| 37 | <style> |
| 38 | @media only screen { |
| 39 | table.full-width-table { |
| 40 | width: 100%; |
| 41 | } |
| 42 | } |
| 43 | </style> |
| 44 | |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 45 | <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> |
| 46 | |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 47 | <script type="text/javascript" src="../_static/copybutton.js"></script> |
Terry Jan Reedy | 963a38b | 2015-09-20 20:03:01 -0400 | [diff] [blame] | 48 | |
| 49 | |
| 50 | |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 51 | |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 52 | </head><body> |
Terry Jan Reedy | f8cd02d | 2016-03-01 00:29:57 -0500 | [diff] [blame] | 53 | <div class="related" role="navigation" aria-label="related navigation"> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 54 | <h3>Navigation</h3> |
| 55 | <ul> |
| 56 | <li class="right" style="margin-right: 10px"> |
| 57 | <a href="../genindex.html" title="General Index" |
| 58 | accesskey="I">index</a></li> |
| 59 | <li class="right" > |
| 60 | <a href="../py-modindex.html" title="Python Module Index" |
| 61 | >modules</a> |</li> |
| 62 | <li class="right" > |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 63 | <a href="othergui.html" title="Other Graphical User Interface Packages" |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 64 | accesskey="N">next</a> |</li> |
| 65 | <li class="right" > |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 66 | <a href="tkinter.scrolledtext.html" title="tkinter.scrolledtext — Scrolled Text Widget" |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 67 | accesskey="P">previous</a> |</li> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 68 | |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 69 | <li><img src="../_static/py.png" alt="" |
| 70 | style="vertical-align: middle; margin-top: -1px"/></li> |
| 71 | <li><a href="https://www.python.org/">Python</a> »</li> |
| 72 | |
| 73 | |
| 74 | <li> |
| 75 | <a href="../index.html">3.8.0a0 Documentation</a> » |
| 76 | </li> |
| 77 | |
| 78 | <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^] | 79 | <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] | 80 | <li class="right"> |
| 81 | |
| 82 | |
| 83 | <div class="inline-search" style="display: none" role="search"> |
| 84 | <form class="inline-search" action="../search.html" method="get"> |
| 85 | <input placeholder="Quick search" type="text" name="q" /> |
| 86 | <input type="submit" value="Go" /> |
| 87 | <input type="hidden" name="check_keywords" value="yes" /> |
| 88 | <input type="hidden" name="area" value="default" /> |
| 89 | </form> |
| 90 | </div> |
| 91 | <script type="text/javascript">$('.inline-search').show(0);</script> |
| 92 | | |
| 93 | </li> |
| 94 | |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 95 | </ul> |
Terry Jan Reedy | 963a38b | 2015-09-20 20:03:01 -0400 | [diff] [blame] | 96 | </div> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 97 | |
| 98 | <div class="document"> |
| 99 | <div class="documentwrapper"> |
| 100 | <div class="bodywrapper"> |
Terry Jan Reedy | f8cd02d | 2016-03-01 00:29:57 -0500 | [diff] [blame] | 101 | <div class="body" role="main"> |
Terry Jan Reedy | 963a38b | 2015-09-20 20:03:01 -0400 | [diff] [blame] | 102 | |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 103 | <div class="section" id="idle"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 104 | <span id="id1"></span><h1>IDLE<a class="headerlink" href="#idle" title="Permalink to this headline">¶</a></h1> |
terryjreedy | 188aedf | 2017-06-13 21:32:16 -0400 | [diff] [blame] | 105 | <p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/master/Lib/idlelib/">Lib/idlelib/</a></p> |
Terry Jan Reedy | fa089b9 | 2016-06-11 15:02:54 -0400 | [diff] [blame] | 106 | <hr class="docutils" id="index-0" /> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 107 | <p>IDLE is Python’s Integrated Development and Learning Environment.</p> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 108 | <p>IDLE has the following features:</p> |
| 109 | <ul class="simple"> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 110 | <li>coded in 100% pure Python, using the <a class="reference internal" href="tkinter.html#module-tkinter" title="tkinter: Interface to Tcl/Tk for graphical user interfaces"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tkinter</span></code></a> GUI toolkit</li> |
Terry Jan Reedy | 0053c47 | 2015-09-24 03:09:43 -0400 | [diff] [blame] | 111 | <li>cross-platform: works mostly the same on Windows, Unix, and Mac OS X</li> |
Terry Jan Reedy | 6e10ec5 | 2015-09-23 20:00:33 -0400 | [diff] [blame] | 112 | <li>Python shell window (interactive interpreter) with colorizing |
| 113 | of code input, output, and error messages</li> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 114 | <li>multi-window text editor with multiple undo, Python colorizing, |
Terry Jan Reedy | 6e10ec5 | 2015-09-23 20:00:33 -0400 | [diff] [blame] | 115 | smart indent, call tips, auto completion, and other features</li> |
| 116 | <li>search within any window, replace within editor windows, and search |
| 117 | through multiple files (grep)</li> |
| 118 | <li>debugger with persistent breakpoints, stepping, and viewing |
| 119 | of global and local namespaces</li> |
| 120 | <li>configuration, browsers, and other dialogs</li> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 121 | </ul> |
| 122 | <div class="section" id="menus"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 123 | <h2>Menus<a class="headerlink" href="#menus" title="Permalink to this headline">¶</a></h2> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 124 | <p>IDLE has two main window types, the Shell window and the Editor window. It is |
| 125 | possible to have multiple editor windows simultaneously. Output windows, such |
| 126 | as used for Edit / Find in Files, are a subtype of edit window. They currently |
| 127 | have the same top menu as Editor windows but a different default title and |
| 128 | context menu.</p> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 129 | <p>IDLE’s menus dynamically change based on which window is currently selected. |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 130 | Each menu documented below indicates which window type it is associated with.</p> |
| 131 | <div class="section" id="file-menu-shell-and-editor"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 132 | <h3>File menu (Shell and Editor)<a class="headerlink" href="#file-menu-shell-and-editor" title="Permalink to this headline">¶</a></h3> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 133 | <dl class="docutils"> |
| 134 | <dt>New File</dt> |
| 135 | <dd>Create a new file editing window.</dd> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 136 | <dt>Open…</dt> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 137 | <dd>Open an existing file with an Open dialog.</dd> |
| 138 | <dt>Recent Files</dt> |
| 139 | <dd>Open a list of recent files. Click one to open it.</dd> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 140 | <dt>Open Module…</dt> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 141 | <dd>Open an existing module (searches sys.path).</dd> |
| 142 | </dl> |
| 143 | <dl class="docutils" id="index-1"> |
| 144 | <dt>Class Browser</dt> |
| 145 | <dd>Show functions, classes, and methods in the current Editor file in a |
| 146 | tree structure. In the shell, open a module first.</dd> |
| 147 | <dt>Path Browser</dt> |
| 148 | <dd>Show sys.path directories, modules, functions, classes and methods in a |
| 149 | tree structure.</dd> |
| 150 | <dt>Save</dt> |
| 151 | <dd>Save the current window to the associated file, if there is one. Windows |
| 152 | that have been changed since being opened or last saved have a * before |
| 153 | and after the window title. If there is no associated file, |
| 154 | do Save As instead.</dd> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 155 | <dt>Save As…</dt> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 156 | <dd>Save the current window with a Save As dialog. The file saved becomes the |
| 157 | new associated file for the window.</dd> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 158 | <dt>Save Copy As…</dt> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 159 | <dd>Save the current window to different file without changing the associated |
| 160 | file.</dd> |
| 161 | <dt>Print Window</dt> |
| 162 | <dd>Print the current window to the default printer.</dd> |
| 163 | <dt>Close</dt> |
| 164 | <dd>Close the current window (ask to save if unsaved).</dd> |
| 165 | <dt>Exit</dt> |
| 166 | <dd>Close all windows and quit IDLE (ask to save unsaved windows).</dd> |
| 167 | </dl> |
| 168 | </div> |
| 169 | <div class="section" id="edit-menu-shell-and-editor"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 170 | <h3>Edit menu (Shell and Editor)<a class="headerlink" href="#edit-menu-shell-and-editor" title="Permalink to this headline">¶</a></h3> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 171 | <dl class="docutils"> |
| 172 | <dt>Undo</dt> |
| 173 | <dd>Undo the last change to the current window. A maximum of 1000 changes may |
| 174 | be undone.</dd> |
| 175 | <dt>Redo</dt> |
| 176 | <dd>Redo the last undone change to the current window.</dd> |
| 177 | <dt>Cut</dt> |
| 178 | <dd>Copy selection into the system-wide clipboard; then delete the selection.</dd> |
| 179 | <dt>Copy</dt> |
| 180 | <dd>Copy selection into the system-wide clipboard.</dd> |
| 181 | <dt>Paste</dt> |
| 182 | <dd>Insert contents of the system-wide clipboard into the current window.</dd> |
| 183 | </dl> |
| 184 | <p>The clipboard functions are also available in context menus.</p> |
| 185 | <dl class="docutils"> |
| 186 | <dt>Select All</dt> |
| 187 | <dd>Select the entire contents of the current window.</dd> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 188 | <dt>Find…</dt> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 189 | <dd>Open a search dialog with many options</dd> |
| 190 | <dt>Find Again</dt> |
| 191 | <dd>Repeat the last search, if there is one.</dd> |
| 192 | <dt>Find Selection</dt> |
| 193 | <dd>Search for the currently selected string, if there is one.</dd> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 194 | <dt>Find in Files…</dt> |
Terry Jan Reedy | 929d7f8 | 2016-05-02 18:30:02 -0400 | [diff] [blame] | 195 | <dd>Open a file search dialog. Put results in a new output window.</dd> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 196 | <dt>Replace…</dt> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 197 | <dd>Open a search-and-replace dialog.</dd> |
| 198 | <dt>Go to Line</dt> |
| 199 | <dd>Move cursor to the line number requested and make that line visible.</dd> |
| 200 | <dt>Show Completions</dt> |
| 201 | <dd>Open a scrollable list allowing selection of keywords and attributes. See |
| 202 | Completions in the Tips sections below.</dd> |
| 203 | <dt>Expand Word</dt> |
| 204 | <dd>Expand a prefix you have typed to match a full word in the same window; |
| 205 | repeat to get a different expansion.</dd> |
| 206 | <dt>Show call tip</dt> |
| 207 | <dd>After an unclosed parenthesis for a function, open a small window with |
| 208 | function parameter hints.</dd> |
| 209 | <dt>Show surrounding parens</dt> |
| 210 | <dd>Highlight the surrounding parenthesis.</dd> |
| 211 | </dl> |
| 212 | </div> |
| 213 | <div class="section" id="format-menu-editor-window-only"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 214 | <h3>Format menu (Editor window only)<a class="headerlink" href="#format-menu-editor-window-only" title="Permalink to this headline">¶</a></h3> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 215 | <dl class="docutils"> |
| 216 | <dt>Indent Region</dt> |
| 217 | <dd>Shift selected lines right by the indent width (default 4 spaces).</dd> |
| 218 | <dt>Dedent Region</dt> |
| 219 | <dd>Shift selected lines left by the indent width (default 4 spaces).</dd> |
| 220 | <dt>Comment Out Region</dt> |
| 221 | <dd>Insert ## in front of selected lines.</dd> |
| 222 | <dt>Uncomment Region</dt> |
| 223 | <dd>Remove leading # or ## from selected lines.</dd> |
| 224 | <dt>Tabify Region</dt> |
| 225 | <dd>Turn <em>leading</em> stretches of spaces into tabs. (Note: We recommend using |
| 226 | 4 space blocks to indent Python code.)</dd> |
| 227 | <dt>Untabify Region</dt> |
| 228 | <dd>Turn <em>all</em> tabs into the correct number of spaces.</dd> |
| 229 | <dt>Toggle Tabs</dt> |
| 230 | <dd>Open a dialog to switch between indenting with spaces and tabs.</dd> |
| 231 | <dt>New Indent Width</dt> |
| 232 | <dd>Open a dialog to change indent width. The accepted default by the Python |
| 233 | community is 4 spaces.</dd> |
| 234 | <dt>Format Paragraph</dt> |
| 235 | <dd>Reformat the current blank-line-delimited paragraph in comment block or |
| 236 | multiline string or selected line in a string. All lines in the |
| 237 | paragraph will be formatted to less than N columns, where N defaults to 72.</dd> |
| 238 | <dt>Strip trailing whitespace</dt> |
Terry Jan Reedy | ff70289 | 2017-09-15 13:05:28 -0400 | [diff] [blame] | 239 | <dd>Remove trailing space and other whitespace characters after the last |
| 240 | non-whitespace character of a line by applying str.rstrip to each line, |
| 241 | including lines within multiline strings.</dd> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 242 | </dl> |
| 243 | </div> |
| 244 | <div class="section" id="run-menu-editor-window-only"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 245 | <span id="index-2"></span><h3>Run menu (Editor window only)<a class="headerlink" href="#run-menu-editor-window-only" title="Permalink to this headline">¶</a></h3> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 246 | <dl class="docutils"> |
| 247 | <dt>Python Shell</dt> |
| 248 | <dd>Open or wake up the Python Shell window.</dd> |
| 249 | <dt>Check Module</dt> |
| 250 | <dd>Check the syntax of the module currently open in the Editor window. If the |
| 251 | module has not been saved IDLE will either prompt the user to save or |
| 252 | autosave, as selected in the General tab of the Idle Settings dialog. If |
| 253 | there is a syntax error, the approximate location is indicated in the |
| 254 | Editor window.</dd> |
| 255 | <dt>Run Module</dt> |
| 256 | <dd>Do Check Module (above). If no error, restart the shell to clean the |
Terry Jan Reedy | 0053c47 | 2015-09-24 03:09:43 -0400 | [diff] [blame] | 257 | environment, then execute the module. Output is displayed in the Shell |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 258 | 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] | 259 | When execution is complete, the Shell retains focus and displays a prompt. |
| 260 | At this point, one may interactively explore the result of execution. |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 261 | 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 |
Terry Jan Reedy | 0053c47 | 2015-09-24 03:09:43 -0400 | [diff] [blame] | 262 | line.</dd> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 263 | </dl> |
| 264 | </div> |
| 265 | <div class="section" id="shell-menu-shell-window-only"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 266 | <h3>Shell menu (Shell window only)<a class="headerlink" href="#shell-menu-shell-window-only" title="Permalink to this headline">¶</a></h3> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 267 | <dl class="docutils"> |
| 268 | <dt>View Last Restart</dt> |
| 269 | <dd>Scroll the shell window to the last Shell restart.</dd> |
| 270 | <dt>Restart Shell</dt> |
| 271 | <dd>Restart the shell to clean the environment.</dd> |
Terry Jan Reedy | 4b73676 | 2016-09-12 01:50:03 -0400 | [diff] [blame] | 272 | <dt>Interrupt Execution</dt> |
| 273 | <dd>Stop a running program.</dd> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 274 | </dl> |
| 275 | </div> |
| 276 | <div class="section" id="debug-menu-shell-window-only"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 277 | <h3>Debug menu (Shell window only)<a class="headerlink" href="#debug-menu-shell-window-only" title="Permalink to this headline">¶</a></h3> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 278 | <dl class="docutils"> |
| 279 | <dt>Go to File/Line</dt> |
| 280 | <dd>Look on the current line. with the cursor, and the line above for a filename |
| 281 | and line number. If found, open the file if not already open, and show the |
| 282 | line. Use this to view source lines referenced in an exception traceback |
| 283 | and lines found by Find in Files. Also available in the context menu of |
| 284 | the Shell window and Output windows.</dd> |
| 285 | </dl> |
| 286 | <dl class="docutils" id="index-3"> |
| 287 | <dt>Debugger (toggle)</dt> |
terryjreedy | 188aedf | 2017-06-13 21:32:16 -0400 | [diff] [blame] | 288 | <dd>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] | 289 | under the debugger. In the Editor, breakpoints can be set with the context |
| 290 | menu. This feature is still incomplete and somewhat experimental.</dd> |
| 291 | <dt>Stack Viewer</dt> |
| 292 | <dd>Show the stack traceback of the last exception in a tree widget, with |
| 293 | access to locals and globals.</dd> |
| 294 | <dt>Auto-open Stack Viewer</dt> |
| 295 | <dd>Toggle automatically opening the stack viewer on an unhandled exception.</dd> |
| 296 | </dl> |
| 297 | </div> |
| 298 | <div class="section" id="options-menu-shell-and-editor"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 299 | <h3>Options menu (Shell and Editor)<a class="headerlink" href="#options-menu-shell-and-editor" title="Permalink to this headline">¶</a></h3> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 300 | <dl class="docutils"> |
| 301 | <dt>Configure IDLE</dt> |
Terry Jan Reedy | 93f3542 | 2015-10-13 22:03:51 -0400 | [diff] [blame] | 302 | <dd><p class="first">Open a configuration dialog and change preferences for the following: |
| 303 | fonts, indentation, keybindings, text color themes, startup windows and |
| 304 | size, additional help sources, and extensions (see below). On OS X, |
| 305 | open the configuration dialog by selecting Preferences in the application |
| 306 | menu. To use a new built-in color theme (IDLE Dark) with older IDLEs, |
| 307 | save it as a new custom theme.</p> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 308 | <p class="last">Non-default user settings are saved in a .idlerc directory in the user’s |
Terry Jan Reedy | 93f3542 | 2015-10-13 22:03:51 -0400 | [diff] [blame] | 309 | home directory. Problems caused by bad user configuration files are solved |
| 310 | by editing or deleting one or more of the files in .idlerc.</p> |
| 311 | </dd> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 312 | <dt>Code Context (toggle)(Editor Window only)</dt> |
| 313 | <dd>Open a pane at the top of the edit window which shows the block context |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 314 | of the code which has scrolled above the top of the window. Clicking a |
| 315 | line in this pane exposes that line at the top of the editor.</dd> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 316 | </dl> |
| 317 | </div> |
| 318 | <div class="section" id="window-menu-shell-and-editor"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 319 | <h3>Window menu (Shell and Editor)<a class="headerlink" href="#window-menu-shell-and-editor" title="Permalink to this headline">¶</a></h3> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 320 | <dl class="docutils"> |
| 321 | <dt>Zoom Height</dt> |
| 322 | <dd>Toggles the window between normal size and maximum height. The initial size |
| 323 | defaults to 40 lines by 80 chars unless changed on the General tab of the |
| 324 | Configure IDLE dialog.</dd> |
| 325 | </dl> |
| 326 | <p>The rest of this menu lists the names of all open windows; select one to bring |
| 327 | it to the foreground (deiconifying it if necessary).</p> |
| 328 | </div> |
| 329 | <div class="section" id="help-menu-shell-and-editor"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 330 | <h3>Help menu (Shell and Editor)<a class="headerlink" href="#help-menu-shell-and-editor" title="Permalink to this headline">¶</a></h3> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 331 | <dl class="docutils"> |
| 332 | <dt>About IDLE</dt> |
| 333 | <dd>Display version, copyright, license, credits, and more.</dd> |
| 334 | <dt>IDLE Help</dt> |
| 335 | <dd>Display a help file for IDLE detailing the menu options, basic editing and |
| 336 | navigation, and other tips.</dd> |
| 337 | <dt>Python Docs</dt> |
| 338 | <dd>Access local Python documentation, if installed, or start a web browser |
| 339 | and open docs.python.org showing the latest Python documentation.</dd> |
| 340 | <dt>Turtle Demo</dt> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 341 | <dd>Run the turtledemo module with example Python code and turtle drawings.</dd> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 342 | </dl> |
| 343 | <p>Additional help sources may be added here with the Configure IDLE dialog under |
| 344 | the General tab.</p> |
| 345 | </div> |
| 346 | <div class="section" id="context-menus"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 347 | <span id="index-4"></span><h3>Context Menus<a class="headerlink" href="#context-menus" title="Permalink to this headline">¶</a></h3> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 348 | <p>Open a context menu by right-clicking in a window (Control-click on OS X). |
| 349 | Context menus have the standard clipboard functions also on the Edit menu.</p> |
| 350 | <dl class="docutils"> |
| 351 | <dt>Cut</dt> |
| 352 | <dd>Copy selection into the system-wide clipboard; then delete the selection.</dd> |
| 353 | <dt>Copy</dt> |
| 354 | <dd>Copy selection into the system-wide clipboard.</dd> |
| 355 | <dt>Paste</dt> |
| 356 | <dd>Insert contents of the system-wide clipboard into the current window.</dd> |
| 357 | </dl> |
| 358 | <p>Editor windows also have breakpoint functions. Lines with a breakpoint set are |
| 359 | specially marked. Breakpoints only have an effect when running under the |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 360 | debugger. Breakpoints for a file are saved in the user’s .idlerc directory.</p> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 361 | <dl class="docutils"> |
| 362 | <dt>Set Breakpoint</dt> |
| 363 | <dd>Set a breakpoint on the current line.</dd> |
| 364 | <dt>Clear Breakpoint</dt> |
| 365 | <dd>Clear the breakpoint on that line.</dd> |
| 366 | </dl> |
| 367 | <p>Shell and Output windows have the following.</p> |
| 368 | <dl class="docutils"> |
| 369 | <dt>Go to file/line</dt> |
| 370 | <dd>Same as in Debug menu.</dd> |
| 371 | </dl> |
| 372 | </div> |
| 373 | </div> |
| 374 | <div class="section" id="editing-and-navigation"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 375 | <h2>Editing and navigation<a class="headerlink" href="#editing-and-navigation" title="Permalink to this headline">¶</a></h2> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 376 | <p>In this section, ‘C’ refers to the <kbd class="kbd docutils literal notranslate">Control</kbd> key on Windows and Unix and |
| 377 | the <kbd class="kbd docutils literal notranslate">Command</kbd> key on Mac OSX.</p> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 378 | <ul> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 379 | <li><p class="first"><kbd class="kbd docutils literal notranslate">Backspace</kbd> deletes to the left; <kbd class="kbd docutils literal notranslate">Del</kbd> deletes to the right</p> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 380 | </li> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 381 | <li><p class="first"><kbd class="kbd docutils literal notranslate">C-Backspace</kbd> delete word left; <kbd class="kbd docutils literal notranslate">C-Del</kbd> delete word to the right</p> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 382 | </li> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 383 | <li><p class="first">Arrow keys and <kbd class="kbd docutils literal notranslate">Page Up</kbd>/<kbd class="kbd docutils literal notranslate">Page Down</kbd> to move around</p> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 384 | </li> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 385 | <li><p class="first"><kbd class="kbd docutils literal notranslate">C-LeftArrow</kbd> and <kbd class="kbd docutils literal notranslate">C-RightArrow</kbd> moves by words</p> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 386 | </li> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 387 | <li><p class="first"><kbd class="kbd docutils literal notranslate">Home</kbd>/<kbd class="kbd docutils literal notranslate">End</kbd> go to begin/end of line</p> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 388 | </li> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 389 | <li><p class="first"><kbd class="kbd docutils literal notranslate">C-Home</kbd>/<kbd class="kbd docutils literal notranslate">C-End</kbd> go to begin/end of file</p> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 390 | </li> |
| 391 | <li><p class="first">Some useful Emacs bindings are inherited from Tcl/Tk:</p> |
| 392 | <blockquote> |
| 393 | <div><ul class="simple"> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 394 | <li><kbd class="kbd docutils literal notranslate">C-a</kbd> beginning of line</li> |
| 395 | <li><kbd class="kbd docutils literal notranslate">C-e</kbd> end of line</li> |
| 396 | <li><kbd class="kbd docutils literal notranslate">C-k</kbd> kill line (but doesn’t put it in clipboard)</li> |
| 397 | <li><kbd class="kbd docutils literal notranslate">C-l</kbd> center window around the insertion point</li> |
| 398 | <li><kbd class="kbd docutils literal notranslate">C-b</kbd> go backward one character without deleting (usually you can |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 399 | also use the cursor key for this)</li> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 400 | <li><kbd class="kbd docutils literal notranslate">C-f</kbd> go forward one character without deleting (usually you can |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 401 | also use the cursor key for this)</li> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 402 | <li><kbd class="kbd docutils literal notranslate">C-p</kbd> go up one line (usually you can also use the cursor key for |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 403 | this)</li> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 404 | <li><kbd class="kbd docutils literal notranslate">C-d</kbd> delete next character</li> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 405 | </ul> |
| 406 | </div></blockquote> |
| 407 | </li> |
| 408 | </ul> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 409 | <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] | 410 | may work. Keybindings are selected in the Configure IDLE dialog.</p> |
| 411 | <div class="section" id="automatic-indentation"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 412 | <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] | 413 | <p>After a block-opening statement, the next line is indented by 4 spaces (in the |
| 414 | 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] | 415 | the next line is dedented. In leading indentation, <kbd class="kbd docutils literal notranslate">Backspace</kbd> deletes up |
| 416 | 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] | 417 | Shell window one tab), number depends on Indent width. Currently, tabs |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 418 | are restricted to four spaces due to Tcl/Tk limitations.</p> |
| 419 | <p>See also the indent/dedent region commands in the edit menu.</p> |
| 420 | </div> |
| 421 | <div class="section" id="completions"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 422 | <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] | 423 | <p>Completions are supplied for functions, classes, and attributes of classes, |
| 424 | both built-in and user-defined. Completions are also provided for |
| 425 | filenames.</p> |
| 426 | <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] | 427 | 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] | 428 | of those characters (plus zero or more other characters) a tab is typed |
| 429 | the ACW will open immediately if a possible continuation is found.</p> |
| 430 | <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] | 431 | <kbd class="kbd docutils literal notranslate">Tab</kbd> will supply that completion without opening the ACW.</p> |
| 432 | <p>‘Show Completions’ will force open a completions window, by default the |
| 433 | <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] | 434 | string, this will contain the files in the current directory. On a |
| 435 | blank line, it will contain the built-in and user-defined functions and |
terryjreedy | 188aedf | 2017-06-13 21:32:16 -0400 | [diff] [blame] | 436 | classes in the current namespaces, plus any modules imported. If some |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 437 | characters have been entered, the ACW will attempt to be more specific.</p> |
| 438 | <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] | 439 | 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] | 440 | 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] | 441 | 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] | 442 | will return or a double click. Cursor keys, Page Up/Down, mouse selection, |
| 443 | and the scroll wheel all operate on the ACW.</p> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 444 | <p>“Hidden” attributes can be accessed by typing the beginning of hidden |
| 445 | name after a ‘.’, e.g. ‘_’. This allows access to modules with |
| 446 | <code class="docutils literal notranslate"><span class="pre">__all__</span></code> set, or to class-private attributes.</p> |
| 447 | <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] | 448 | <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] | 449 | 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] | 450 | not be found. Run the module once with your imports to correct this situation. |
| 451 | Note that IDLE itself places quite a few modules in sys.modules, so |
| 452 | 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] | 453 | <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] | 454 | longer or disable the extension.</p> |
| 455 | </div> |
| 456 | <div class="section" id="calltips"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 457 | <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] | 458 | <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] | 459 | function. A name expression may include dots and subscripts. A calltip |
| 460 | 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] | 461 | 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] | 462 | the menu or shortcut display a calltip.</p> |
| 463 | <p>A calltip consists of the function signature and the first line of the |
| 464 | docstring. For builtins without an accessible signature, the calltip |
| 465 | consists of all lines up the fifth line or the first blank line. These |
| 466 | details may change.</p> |
| 467 | <p>The set of <em>accessible</em> functions depends on what modules have been imported |
| 468 | into the user process, including those imported by Idle itself, |
| 469 | 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] | 470 | <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] | 471 | 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] | 472 | (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] | 473 | not import turtle. The menu or shortcut do nothing either. Enter |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 474 | <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] | 475 | <p>In an editor, import statements have no effect until one runs the file. One |
| 476 | might want to run a file after writing the import statements at the top, |
| 477 | or immediately run an existing file before editing.</p> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 478 | </div> |
| 479 | <div class="section" id="python-shell-window"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 480 | <h3>Python Shell window<a class="headerlink" href="#python-shell-window" title="Permalink to this headline">¶</a></h3> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 481 | <ul> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 482 | <li><p class="first"><kbd class="kbd docutils literal notranslate">C-c</kbd> interrupts executing command</p> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 483 | </li> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 484 | <li><p class="first"><kbd class="kbd docutils literal notranslate">C-d</kbd> sends end-of-file; closes window if typed at a <code class="docutils literal notranslate"><span class="pre">>>></span></code> prompt</p> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 485 | </li> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 486 | <li><p class="first"><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] | 487 | <p>Command history</p> |
| 488 | <ul class="simple"> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 489 | <li><kbd class="kbd docutils literal notranslate">Alt-p</kbd> retrieves previous command matching what you have typed. On |
| 490 | OS X use <kbd class="kbd docutils literal notranslate">C-p</kbd>.</li> |
| 491 | <li><kbd class="kbd docutils literal notranslate">Alt-n</kbd> retrieves next. On OS X use <kbd class="kbd docutils literal notranslate">C-n</kbd>.</li> |
| 492 | <li><kbd class="kbd docutils literal notranslate">Return</kbd> while on any previous command retrieves that command</li> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 493 | </ul> |
| 494 | </li> |
| 495 | </ul> |
| 496 | </div> |
Terry Jan Reedy | ce021db | 2015-09-24 23:18:57 -0400 | [diff] [blame] | 497 | <div class="section" id="text-colors"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 498 | <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] | 499 | <p>Idle defaults to black on white text, but colors text with special meanings. |
| 500 | For the shell, these are shell output, shell error, user output, and |
| 501 | 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] | 502 | keywords, builtin class and function names, names following <code class="docutils literal notranslate"><span class="pre">class</span></code> and |
| 503 | <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] | 504 | present), found text (when possible), and selected text.</p> |
| 505 | <p>Text coloring is done in the background, so uncolorized text is occasionally |
| 506 | visible. To change the color scheme, use the Configure IDLE dialog |
| 507 | Highlighting tab. The marking of debugger breakpoint lines in the editor and |
| 508 | text in popups and dialogs is not user-configurable.</p> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 509 | </div> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 510 | </div> |
Terry Jan Reedy | 0053c47 | 2015-09-24 03:09:43 -0400 | [diff] [blame] | 511 | <div class="section" id="startup-and-code-execution"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 512 | <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] | 513 | <p>Upon startup with the <code class="docutils literal notranslate"><span class="pre">-s</span></code> option, IDLE will execute the file referenced by |
| 514 | 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>. |
| 515 | 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 |
| 516 | referenced is run. If <code class="docutils literal notranslate"><span class="pre">IDLESTARTUP</span></code> is not present, IDLE checks for |
| 517 | <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] | 518 | convenient places to store functions that are used frequently from the IDLE |
| 519 | shell, or for executing import statements to import common modules.</p> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 520 | <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 |
| 521 | Tk file is loaded unconditionally. This additional file is <code class="docutils literal notranslate"><span class="pre">.Idle.py</span></code> and is |
| 522 | 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] | 523 | 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] | 524 | functions to be used from IDLE’s Python shell.</p> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 525 | <div class="section" id="command-line-usage"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 526 | <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] | 527 | <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] | 528 | |
Terry Jan Reedy | 968e285 | 2015-09-23 03:52:23 -0400 | [diff] [blame] | 529 | -c command run command in the shell window |
| 530 | -d enable debugger and open shell window |
| 531 | -e open editor window |
Terry Jan Reedy | 3399e1e | 2016-08-30 16:58:01 -0400 | [diff] [blame] | 532 | -h print help message with legal combinations and exit |
Terry Jan Reedy | 968e285 | 2015-09-23 03:52:23 -0400 | [diff] [blame] | 533 | -i open shell window |
| 534 | -r file run file in shell window |
| 535 | -s run $IDLESTARTUP or $PYTHONSTARTUP first, in shell window |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 536 | -t title set title of shell window |
Terry Jan Reedy | 968e285 | 2015-09-23 03:52:23 -0400 | [diff] [blame] | 537 | - run stdin in shell (- must be last option before args) |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 538 | </pre></div> |
| 539 | </div> |
| 540 | <p>If there are arguments:</p> |
Terry Jan Reedy | 968e285 | 2015-09-23 03:52:23 -0400 | [diff] [blame] | 541 | <ul class="simple"> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 542 | <li>If <code class="docutils literal notranslate"><span class="pre">-</span></code>, <code class="docutils literal notranslate"><span class="pre">-c</span></code>, or <code class="docutils literal notranslate"><span class="pre">r</span></code> is used, all arguments are placed in |
| 543 | <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>, |
| 544 | or <code class="docutils literal notranslate"><span class="pre">'-r'</span></code>. No editor window is opened, even if that is the default |
Terry Jan Reedy | 968e285 | 2015-09-23 03:52:23 -0400 | [diff] [blame] | 545 | set in the Options dialog.</li> |
| 546 | <li>Otherwise, arguments are files opened for editing and |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 547 | <code class="docutils literal notranslate"><span class="pre">sys.argv</span></code> reflects the arguments passed to IDLE itself.</li> |
Terry Jan Reedy | 968e285 | 2015-09-23 03:52:23 -0400 | [diff] [blame] | 548 | </ul> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 549 | </div> |
terryjreedy | 188aedf | 2017-06-13 21:32:16 -0400 | [diff] [blame] | 550 | <div class="section" id="startup-failure"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 551 | <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] | 552 | <p>IDLE uses a socket to communicate between the IDLE GUI process and the user |
| 553 | code execution process. A connection must be established whenever the Shell |
| 554 | 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] | 555 | ‘RESTART’). If the user process fails to connect to the GUI process, it |
| 556 | 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] | 557 | user here. It then exits.</p> |
| 558 | <p>A common cause of failure is a user-written file with the same name as a |
| 559 | standard library module, such as <em>random.py</em> and <em>tkinter.py</em>. When such a |
| 560 | file is located in the same directory as a file that is about to be run, |
| 561 | IDLE cannot import the stdlib file. The current fix is to rename the |
| 562 | user file.</p> |
| 563 | <p>Though less common than in the past, an antivirus or firewall program may |
| 564 | stop the connection. If the program cannot be taught to allow the |
| 565 | connection, then it must be turned off for IDLE to work. It is safe to |
| 566 | allow this internal connection because no data is visible on external |
| 567 | ports. A similar problem is a network mis-configuration that blocks |
| 568 | connections.</p> |
| 569 | <p>Python installation issues occasionally stop IDLE: multiple versions can |
| 570 | clash, or a single installation might need admin access. If one undo the |
| 571 | clash, or cannot or does not want to run as admin, it might be easiest to |
| 572 | completely remove Python and start over.</p> |
| 573 | <p>A zombie pythonw.exe process could be a problem. On Windows, use Task |
| 574 | Manager to detect and stop one. Sometimes a restart initiated by a program |
| 575 | crash or Keyboard Interrupt (control-C) may fail to connect. Dismissing |
| 576 | the error box or Restart Shell on the Shell menu may fix a temporary problem.</p> |
| 577 | <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] | 578 | ~/.idlerc/ (~ is one’s home directory). If there is a problem, an error |
terryjreedy | 188aedf | 2017-06-13 21:32:16 -0400 | [diff] [blame] | 579 | message should be displayed. Leaving aside random disk glitches, this can |
| 580 | be prevented by never editing the files by hand, using the configuration |
| 581 | dialog, under Options, instead Options. Once it happens, the solution may |
| 582 | be to delete one or more of the configuration files.</p> |
| 583 | <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] | 584 | 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] | 585 | </div> |
Terry Jan Reedy | 0053c47 | 2015-09-24 03:09:43 -0400 | [diff] [blame] | 586 | <div class="section" id="idle-console-differences"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 587 | <h3>IDLE-console differences<a class="headerlink" href="#idle-console-differences" title="Permalink to this headline">¶</a></h3> |
Terry Jan Reedy | 98758bc | 2017-09-12 09:05:16 -0400 | [diff] [blame] | 588 | <p>With rare exceptions, the result of executing Python code with IDLE is |
| 589 | intended to be the same as executing the same code in a console window. |
| 590 | However, the different interface and operation occasionally affect |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 591 | visible results. For instance, <code class="docutils literal notranslate"><span class="pre">sys.modules</span></code> starts with more entries.</p> |
| 592 | <p>IDLE also 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> with |
Terry Jan Reedy | 929d7f8 | 2016-05-02 18:30:02 -0400 | [diff] [blame] | 593 | objects that get input from and send output to the Shell window. |
Terry Jan Reedy | 98758bc | 2017-09-12 09:05:16 -0400 | [diff] [blame] | 594 | When Shell has the focus, it controls the keyboard and screen. This is |
| 595 | normally transparent, but functions that directly access the keyboard |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 596 | and screen will not work. If <code class="docutils literal notranslate"><span class="pre">sys</span></code> is reset with <code class="docutils literal notranslate"><span class="pre">importlib.reload(sys)</span></code>, |
| 597 | IDLE’s changes are lost and things like <code class="docutils literal notranslate"><span class="pre">input</span></code>, <code class="docutils literal notranslate"><span class="pre">raw_input</span></code>, and |
| 598 | <code class="docutils literal notranslate"><span class="pre">print</span></code> will not work correctly.</p> |
| 599 | <p>With IDLE’s Shell, one enters, edits, and recalls complete statements. |
Terry Jan Reedy | 1f8cc33 | 2016-08-25 01:22:30 -0400 | [diff] [blame] | 600 | Some consoles only work with a single physical line at a time. IDLE uses |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 601 | <code class="docutils literal notranslate"><span class="pre">exec</span></code> to run each statement. As a result, <code class="docutils literal notranslate"><span class="pre">'__builtins__'</span></code> is always |
Terry Jan Reedy | 1f8cc33 | 2016-08-25 01:22:30 -0400 | [diff] [blame] | 602 | defined for each statement.</p> |
Terry Jan Reedy | 0053c47 | 2015-09-24 03:09:43 -0400 | [diff] [blame] | 603 | </div> |
Terry Jan Reedy | 98758bc | 2017-09-12 09:05:16 -0400 | [diff] [blame] | 604 | <div class="section" id="developing-tkinter-applications"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 605 | <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] | 606 | <p>IDLE is intentionally different from standard Python in order to |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 607 | 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] | 608 | <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 |
| 609 | 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] | 610 | <code class="docutils literal notranslate"><span class="pre">root.update()</span></code> to see the window. IDLE does the equivalent in the |
Terry Jan Reedy | 98758bc | 2017-09-12 09:05:16 -0400 | [diff] [blame] | 611 | background, about 20 times a second, which is about every 50 milleseconds. |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 612 | 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, |
| 613 | nothing visibly changes in standard Python until one enters <code class="docutils literal notranslate"><span class="pre">root.update()</span></code>.</p> |
| 614 | <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] | 615 | 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] | 616 | <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 |
| 617 | 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] | 618 | to interact with.</p> |
| 619 | <p>When running a tkinter program from an IDLE editor, one can comment out |
| 620 | the mainloop call. One then gets a shell prompt immediately and can |
| 621 | interact with the live application. One just has to remember to |
| 622 | re-enable the mainloop call when running in standard Python.</p> |
| 623 | </div> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 624 | <div class="section" id="running-without-a-subprocess"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 625 | <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] | 626 | <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] | 627 | which uses the internal loopback interface. This connection is not |
| 628 | externally visible and no data is sent to or received from the Internet. |
| 629 | If firewall software complains anyway, you can ignore it.</p> |
| 630 | <p>If the attempt to make the socket connection fails, Idle will notify you. |
| 631 | Such failures are sometimes transient, but if persistent, the problem |
terryjreedy | 188aedf | 2017-06-13 21:32:16 -0400 | [diff] [blame] | 632 | may be either a firewall blocking the connection or misconfiguration of |
Terry Jan Reedy | 6e10ec5 | 2015-09-23 20:00:33 -0400 | [diff] [blame] | 633 | a particular system. Until the problem is fixed, one can run Idle with |
| 634 | the -n command line switch.</p> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 635 | <p>If IDLE is started with the -n command line switch it will run in a |
| 636 | single process and will not create the subprocess which runs the RPC |
| 637 | Python execution server. This can be useful if Python cannot create |
| 638 | the subprocess or the RPC socket interface on your platform. However, |
| 639 | in this mode user code is not isolated from IDLE itself. Also, the |
| 640 | environment is not restarted when Run/Run Module (F5) is selected. If |
| 641 | your code has been modified, you must reload() the affected modules and |
| 642 | re-import any specific items (e.g. from foo import baz) if the changes |
| 643 | are to take effect. For these reasons, it is preferable to run IDLE |
| 644 | with the default subprocess if at all possible.</p> |
| 645 | <div class="deprecated"> |
| 646 | <p><span class="versionmodified">Deprecated since version 3.4.</span></p> |
| 647 | </div> |
| 648 | </div> |
| 649 | </div> |
| 650 | <div class="section" id="help-and-preferences"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 651 | <h2>Help and preferences<a class="headerlink" href="#help-and-preferences" title="Permalink to this headline">¶</a></h2> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 652 | <div class="section" id="additional-help-sources"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 653 | <h3>Additional help sources<a class="headerlink" href="#additional-help-sources" title="Permalink to this headline">¶</a></h3> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 654 | <p>IDLE includes a help menu entry called “Python Docs” that will open the |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 655 | extensive sources of help, including tutorials, available at docs.python.org. |
| 656 | Selected URLs can be added or removed from the help menu at any time using the |
| 657 | Configure IDLE dialog. See the IDLE help option in the help menu of IDLE for |
| 658 | more information.</p> |
| 659 | </div> |
| 660 | <div class="section" id="setting-preferences"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 661 | <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] | 662 | <p>The font preferences, highlighting, keys, and general preferences can be |
| 663 | changed via Configure IDLE on the Option menu. Keys can be user defined; |
terryjreedy | 188aedf | 2017-06-13 21:32:16 -0400 | [diff] [blame] | 664 | IDLE ships with four built-in key sets. In addition, a user can create a |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 665 | custom key set in the Configure IDLE dialog under the keys tab.</p> |
| 666 | </div> |
| 667 | <div class="section" id="extensions"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 668 | <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] | 669 | <p>IDLE contains an extension facility. Preferences for extensions can be |
Terry Jan Reedy | adb4cd2 | 2017-09-12 07:45:15 -0400 | [diff] [blame] | 670 | changed with the Extensions tab of the preferences dialog. See the |
| 671 | beginning of config-extensions.def in the idlelib directory for further |
| 672 | information. The only current default extension is zzdummy, an example |
Terry Jan Reedy | 98758bc | 2017-09-12 09:05:16 -0400 | [diff] [blame] | 673 | also used for testing.</p> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 674 | </div> |
| 675 | </div> |
| 676 | </div> |
| 677 | |
| 678 | |
| 679 | </div> |
| 680 | </div> |
| 681 | </div> |
Terry Jan Reedy | f8cd02d | 2016-03-01 00:29:57 -0500 | [diff] [blame] | 682 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 683 | <div class="sphinxsidebarwrapper"> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 684 | <h3><a href="../contents.html">Table of Contents</a></h3> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 685 | <ul> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 686 | <li><a class="reference internal" href="#">IDLE</a><ul> |
| 687 | <li><a class="reference internal" href="#menus">Menus</a><ul> |
| 688 | <li><a class="reference internal" href="#file-menu-shell-and-editor">File menu (Shell and Editor)</a></li> |
| 689 | <li><a class="reference internal" href="#edit-menu-shell-and-editor">Edit menu (Shell and Editor)</a></li> |
| 690 | <li><a class="reference internal" href="#format-menu-editor-window-only">Format menu (Editor window only)</a></li> |
| 691 | <li><a class="reference internal" href="#run-menu-editor-window-only">Run menu (Editor window only)</a></li> |
| 692 | <li><a class="reference internal" href="#shell-menu-shell-window-only">Shell menu (Shell window only)</a></li> |
| 693 | <li><a class="reference internal" href="#debug-menu-shell-window-only">Debug menu (Shell window only)</a></li> |
| 694 | <li><a class="reference internal" href="#options-menu-shell-and-editor">Options menu (Shell and Editor)</a></li> |
| 695 | <li><a class="reference internal" href="#window-menu-shell-and-editor">Window menu (Shell and Editor)</a></li> |
| 696 | <li><a class="reference internal" href="#help-menu-shell-and-editor">Help menu (Shell and Editor)</a></li> |
| 697 | <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] | 698 | </ul> |
| 699 | </li> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 700 | <li><a class="reference internal" href="#editing-and-navigation">Editing and navigation</a><ul> |
| 701 | <li><a class="reference internal" href="#automatic-indentation">Automatic indentation</a></li> |
| 702 | <li><a class="reference internal" href="#completions">Completions</a></li> |
| 703 | <li><a class="reference internal" href="#calltips">Calltips</a></li> |
| 704 | <li><a class="reference internal" href="#python-shell-window">Python Shell window</a></li> |
| 705 | <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] | 706 | </ul> |
| 707 | </li> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 708 | <li><a class="reference internal" href="#startup-and-code-execution">Startup and code execution</a><ul> |
| 709 | <li><a class="reference internal" href="#command-line-usage">Command line usage</a></li> |
| 710 | <li><a class="reference internal" href="#startup-failure">Startup failure</a></li> |
| 711 | <li><a class="reference internal" href="#idle-console-differences">IDLE-console differences</a></li> |
| 712 | <li><a class="reference internal" href="#developing-tkinter-applications">Developing tkinter applications</a></li> |
| 713 | <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] | 714 | </ul> |
| 715 | </li> |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 716 | <li><a class="reference internal" href="#help-and-preferences">Help and preferences</a><ul> |
| 717 | <li><a class="reference internal" href="#additional-help-sources">Additional help sources</a></li> |
| 718 | <li><a class="reference internal" href="#setting-preferences">Setting preferences</a></li> |
| 719 | <li><a class="reference internal" href="#extensions">Extensions</a></li> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 720 | </ul> |
| 721 | </li> |
| 722 | </ul> |
| 723 | </li> |
| 724 | </ul> |
| 725 | |
| 726 | <h4>Previous topic</h4> |
| 727 | <p class="topless"><a href="tkinter.scrolledtext.html" |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 728 | title="previous chapter"><code class="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] | 729 | <h4>Next topic</h4> |
| 730 | <p class="topless"><a href="othergui.html" |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 731 | title="next chapter">Other Graphical User Interface Packages</a></p> |
Terry Jan Reedy | 4b73676 | 2016-09-12 01:50:03 -0400 | [diff] [blame] | 732 | <div role="note" aria-label="source link"> |
| 733 | <h3>This Page</h3> |
| 734 | <ul class="this-page-menu"> |
| 735 | <li><a href="../bugs.html">Report a Bug</a></li> |
terryjreedy | 188aedf | 2017-06-13 21:32:16 -0400 | [diff] [blame] | 736 | <li> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 737 | <a href="https://github.com/python/cpython/blob/master/Doc/library/idle.rst" |
terryjreedy | 188aedf | 2017-06-13 21:32:16 -0400 | [diff] [blame] | 738 | rel="nofollow">Show Source |
| 739 | </a> |
| 740 | </li> |
Terry Jan Reedy | 4b73676 | 2016-09-12 01:50:03 -0400 | [diff] [blame] | 741 | </ul> |
| 742 | </div> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 743 | </div> |
| 744 | </div> |
| 745 | <div class="clearer"></div> |
Terry Jan Reedy | 963a38b | 2015-09-20 20:03:01 -0400 | [diff] [blame] | 746 | </div> |
Terry Jan Reedy | f8cd02d | 2016-03-01 00:29:57 -0500 | [diff] [blame] | 747 | <div class="related" role="navigation" aria-label="related navigation"> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 748 | <h3>Navigation</h3> |
| 749 | <ul> |
| 750 | <li class="right" style="margin-right: 10px"> |
| 751 | <a href="../genindex.html" title="General Index" |
| 752 | >index</a></li> |
| 753 | <li class="right" > |
| 754 | <a href="../py-modindex.html" title="Python Module Index" |
| 755 | >modules</a> |</li> |
| 756 | <li class="right" > |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 757 | <a href="othergui.html" title="Other Graphical User Interface Packages" |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 758 | >next</a> |</li> |
| 759 | <li class="right" > |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 760 | <a href="tkinter.scrolledtext.html" title="tkinter.scrolledtext — Scrolled Text Widget" |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 761 | >previous</a> |</li> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 762 | |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 763 | <li><img src="../_static/py.png" alt="" |
| 764 | style="vertical-align: middle; margin-top: -1px"/></li> |
| 765 | <li><a href="https://www.python.org/">Python</a> »</li> |
| 766 | |
| 767 | |
| 768 | <li> |
| 769 | <a href="../index.html">3.8.0a0 Documentation</a> » |
| 770 | </li> |
| 771 | |
| 772 | <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^] | 773 | <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] | 774 | <li class="right"> |
| 775 | |
| 776 | |
| 777 | <div class="inline-search" style="display: none" role="search"> |
| 778 | <form class="inline-search" action="../search.html" method="get"> |
| 779 | <input placeholder="Quick search" type="text" name="q" /> |
| 780 | <input type="submit" value="Go" /> |
| 781 | <input type="hidden" name="check_keywords" value="yes" /> |
| 782 | <input type="hidden" name="area" value="default" /> |
| 783 | </form> |
| 784 | </div> |
| 785 | <script type="text/javascript">$('.inline-search').show(0);</script> |
| 786 | | |
| 787 | </li> |
| 788 | |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 789 | </ul> |
Terry Jan Reedy | 963a38b | 2015-09-20 20:03:01 -0400 | [diff] [blame] | 790 | </div> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 791 | <div class="footer"> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 792 | © <a href="../copyright.html">Copyright</a> 2001-2018, Python Software Foundation. |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 793 | <br /> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 794 | |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 795 | The Python Software Foundation is a non-profit corporation. |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 796 | <a href="https://www.python.org/psf/donations/">Please donate.</a> |
| 797 | <br /> |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 798 | <br /> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 799 | |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 800 | Last updated on Oct 27, 2018. |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 801 | <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] | 802 | <br /> |
Terry Jan Reedy | af4b013 | 2018-06-10 15:48:41 -0400 | [diff] [blame] | 803 | |
Terry Jan Reedy | db40cb5 | 2018-10-28 01:21:36 -0400 | [diff] [blame^] | 804 | Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.8.1. |
Terry Jan Reedy | 5d46ab1 | 2015-09-20 19:57:13 -0400 | [diff] [blame] | 805 | </div> |
| 806 | |
| 807 | </body> |
Terry Jan Reedy | 963a38b | 2015-09-20 20:03:01 -0400 | [diff] [blame] | 808 | </html> |