25.5. IDLE¶
+26.5. IDLE¶
Source code: Lib/idlelib/
-
IDLE is Python’s Integrated Development and Learning Environment.
+IDLE is Python’s Integrated Development and Learning Environment.
IDLE has the following features:
-
-
- coded in 100% pure Python, using the
tkinterGUI toolkit
+ - coded in 100% pure Python, using the
tkinterGUI toolkit - cross-platform: works mostly the same on Windows, Unix, and Mac OS X
- Python shell window (interactive interpreter) with colorizing of code input, output, and error messages @@ -111,24 +107,24 @@
- configuration, browsers, and other dialogs
Navigation
25.5.1. Menus¶
+26.5.1. Menus¶
IDLE has two main window types, the Shell window and the Editor window. It is possible to have multiple editor windows simultaneously. Output windows, such as used for Edit / Find in Files, are a subtype of edit window. They currently have the same top menu as Editor windows but a different default title and context menu.
-IDLE’s menus dynamically change based on which window is currently selected. +
IDLE’s menus dynamically change based on which window is currently selected. Each menu documented below indicates which window type it is associated with.
25.5.1.8. Window menu (Shell and Editor)¶
+26.5.1.8. Window menu (Shell and Editor)¶
- Zoom Height
- Toggles the window between normal size and maximum height. The initial size
@@ -317,7 +314,7 @@
25.5.1.8. Window menu (Shell and Editor) -
25.5.1.9. Help menu (Shell and Editor)¶
+26.5.1.9. Help menu (Shell and Editor)¶
- About IDLE
- Display version, copyright, license, credits, and more. @@ -334,7 +331,7 @@
- Set Breakpoint
- Set a breakpoint on the current line. @@ -362,93 +359,93 @@
+Backspacedeletes to the left;Deldeletes to the rightBackspace deletes to the left; Del deletes to the right
-
+C-Backspacedelete word left;C-Deldelete word to the rightC-Backspace delete word left; C-Del delete word to the right
-Arrow keys and
+Page Up/Page Downto move aroundArrow keys and Page Up/Page Down to move around
-
+C-LeftArrowandC-RightArrowmoves by wordsC-LeftArrow and C-RightArrow moves by words
-
+Home/Endgo to begin/end of lineHome/End go to begin/end of line
-
+C-Home/C-Endgo to begin/end of fileC-Home/C-End go to begin/end of file
Some useful Emacs bindings are inherited from Tcl/Tk:
-
-
C-abeginning of line
-C-eend of line
-C-kkill line (but doesn’t put it in clipboard)
-C-lcenter window around the insertion point
-C-bgo backward one character without deleting (usually you can +- C-a beginning of line +
- C-e end of line +
- C-k kill line (but doesn’t put it in clipboard) +
- C-l center window around the insertion point +
- C-b go backward one character without deleting (usually you can also use the cursor key for this) -
C-fgo forward one character without deleting (usually you can +- C-f go forward one character without deleting (usually you can also use the cursor key for this) -
C-pgo up one line (usually you can also use the cursor key for +- C-p go up one line (usually you can also use the cursor key for this) -
C-ddelete next character
+- C-d delete next character
+C-cinterrupts executing commandC-c interrupts executing command
-
+C-dsends end-of-file; closes window if typed at a>>>promptC-d sends end-of-file; closes window if typed at a
>>>prompt
-
+Alt-/(Expand word) is also useful to reduce typingAlt-/ (Expand word) is also useful to reduce typing
Command history
-
-
Alt-pretrieves previous command matching what you have typed. On -OS X useC-p.
-Alt-nretrieves next. On OS X useC-n.
-Returnwhile on any previous command retrieves that command
+- Alt-p retrieves previous command matching what you have typed. On +OS X use C-p. +
- Alt-n retrieves next. On OS X use C-n. +
- Return while on any previous command retrieves that command
- If
-,-c, orris used, all arguments are placed in -sys.argv[1:...]andsys.argv[0]is set to'','-c', -or'-r'. No editor window is opened, even if that is the default + - If
-,-c, orris used, all arguments are placed in +sys.argv[1:...]andsys.argv[0]is set to'','-c', +or'-r'. No editor window is opened, even if that is the default set in the Options dialog. - Otherwise, arguments are files opened for editing and
-
sys.argvreflects the arguments passed to IDLE itself.
+ - 25.5. IDLE
-
-
- 25.5.1. Menus
-
-
- 25.5.1.1. File menu (Shell and Editor) -
- 25.5.1.2. Edit menu (Shell and Editor) -
- 25.5.1.3. Format menu (Editor window only) -
- 25.5.1.4. Run menu (Editor window only) -
- 25.5.1.5. Shell menu (Shell window only) -
- 25.5.1.6. Debug menu (Shell window only) -
- 25.5.1.7. Options menu (Shell and Editor) -
- 25.5.1.8. Window menu (Shell and Editor) -
- 25.5.1.9. Help menu (Shell and Editor) -
- 25.5.1.10. Context Menus +
- 26.5. IDLE
-
+
- 26.5.1. Menus
-
+
- 26.5.1.1. File menu (Shell and Editor) +
- 26.5.1.2. Edit menu (Shell and Editor) +
- 26.5.1.3. Format menu (Editor window only) +
- 26.5.1.4. Run menu (Editor window only) +
- 26.5.1.5. Shell menu (Shell window only) +
- 26.5.1.6. Debug menu (Shell window only) +
- 26.5.1.7. Options menu (Shell and Editor) +
- 26.5.1.8. Window menu (Shell and Editor) +
- 26.5.1.9. Help menu (Shell and Editor) +
- 26.5.1.10. Context Menus
- - 25.5.2. Editing and navigation
-
-
- 25.5.2.1. Automatic indentation -
- 25.5.2.2. Completions -
- 25.5.2.3. Calltips -
- 25.5.2.4. Python Shell window -
- 25.5.2.5. Text colors +
- 26.5.2. Editing and navigation -
- 25.5.3. Startup and code execution
-
-
- 25.5.3.1. Command line usage -
- 25.5.3.2. Startup failure -
- 25.5.3.3. IDLE-console differences -
- 25.5.3.4. Developing tkinter applications -
- 25.5.3.5. Running without a subprocess +
- 26.5.3. Startup and code execution -
- 25.5.4. Help and preferences
-
-
- 25.5.4.1. Additional help sources -
- 25.5.4.2. Setting preferences -
- 25.5.4.3. Extensions +
- 26.5.4. Help and preferences
Table Of Contents
Previous topic
25.4.
+ title="previous chapter">26.4.tkinter.scrolledtext— Scrolled Text Widgettkinter.scrolledtext— Scrolled Text Widget
- 26.5.1. Menus
- 25.5.1. Menus
- Report a Bug
- - Show Source @@ -744,20 +741,23 @@
- - next |
- - previous | -
- - Python » -
- - 3.7.0a0 Documentation » - - - - + +
-
+
- Python » + + +
- + 3.8.0a0 Documentation » + + + +
-
@@ -776,15 +776,19 @@
Navigation
25.5.1.9. Help menu (Shell and Editor) -
25.5.1.10. Context Menus¶
+26.5.1.10. Context Menus¶
Open a context menu by right-clicking in a window (Control-click on OS X). Context menus have the standard clipboard functions also on the Edit menu.
-
@@ -347,7 +344,7 @@
25.5.1.9. Help menu (Shell and Editor)
25.5.1.9. Help menu (Shell and Editor) -
25.5.2. Editing and navigation¶
-In this section, ‘C’ refers to the
+Controlkey on Windows and Unix and -theCommandkey on Mac OSX.26.5.2. Editing and navigation¶
+In this section, ‘C’ refers to the Control key on Windows and Unix and +the Command key on Mac OSX.
-
-
Standard keybindings (like
C-cto copy andC-vto paste) +Standard keybindings (like C-c to copy and C-v to paste) may work. Keybindings are selected in the Configure IDLE dialog.
-25.5.2.1. Automatic indentation¶
+26.5.2.1. Automatic indentation¶
After a block-opening statement, the next line is indented by 4 spaces (in the Python Shell window by one tab). After certain keywords (break, return etc.) -the next line is dedented. In leading indentation,
Backspacedeletes up -to 4 spaces if they are there.Tabinserts spaces (in the Python +the next line is dedented. In leading indentation, Backspace deletes up +to 4 spaces if they are there. Tab inserts spaces (in the Python Shell window one tab), number depends on Indent width. Currently, tabs are restricted to four spaces due to Tcl/Tk limitations.See also the indent/dedent region commands in the edit menu.
-25.5.2.2. Completions¶
+26.5.2.2. Completions¶
Completions are supplied for functions, classes, and attributes of classes, both built-in and user-defined. Completions are also provided for filenames.
The AutoCompleteWindow (ACW) will open after a predefined delay (default is -two seconds) after a ‘.’ or (in a string) an os.sep is typed. If after one +two seconds) after a ‘.’ or (in a string) an os.sep is typed. If after one of those characters (plus zero or more other characters) a tab is typed the ACW will open immediately if a possible continuation is found.
If there is only one possible completion for the characters entered, a -
-Tabwill supply that completion without opening the ACW.‘Show Completions’ will force open a completions window, by default the -
+C-spacewill open a completions window. In an empty +Tab will supply that completion without opening the ACW.‘Show Completions’ will force open a completions window, by default the +C-space will open a completions window. In an empty string, this will contain the files in the current directory. On a blank line, it will contain the built-in and user-defined functions and classes in the current namespaces, plus any modules imported. If some characters have been entered, the ACW will attempt to be more specific.
If a string of characters is typed, the ACW selection will jump to the -entry most closely matching those characters. Entering a
-tabwill +entry most closely matching those characters. Entering a tab will cause the longest non-ambiguous match to be entered in the Editor window or -Shell. Twotabin a row will supply the current ACW selection, as +Shell. Two tab in a row will supply the current ACW selection, as will return or a double click. Cursor keys, Page Up/Down, mouse selection, and the scroll wheel all operate on the ACW.“Hidden” attributes can be accessed by typing the beginning of hidden -name after a ‘.’, e.g. ‘_’. This allows access to modules with -
-__all__set, or to class-private attributes.Completions and the ‘Expand Word’ facility can save a lot of typing!
+“Hidden” attributes can be accessed by typing the beginning of hidden +name after a ‘.’, e.g. ‘_’. This allows access to modules with +
+__all__set, or to class-private attributes.Completions and the ‘Expand Word’ facility can save a lot of typing!
Completions are currently limited to those in the namespaces. Names in -an Editor window which are not via
-__main__andsys.moduleswill +an Editor window which are not via__main__andsys.moduleswill not be found. Run the module once with your imports to correct this situation. Note that IDLE itself places quite a few modules in sys.modules, so much can be found by default, e.g. the re module.If you don’t like the ACW popping up unbidden, simply make the delay +
If you don’t like the ACW popping up unbidden, simply make the delay longer or disable the extension.
-25.5.2.3. Calltips¶
-A calltip is shown when one types
(after the name of an accessible +26.5.2.3. Calltips¶
+A calltip is shown when one types ( after the name of an accessible function. A name expression may include dots and subscripts. A calltip remains until it is clicked, the cursor is moved out of the argument area, -or
)is typed. When the cursor is in the argument part of a definition, +or ) is typed. When the cursor is in the argument part of a definition, the menu or shortcut display a calltip.A calltip consists of the function signature and the first line of the docstring. For builtins without an accessible signature, the calltip @@ -457,40 +454,40 @@
25.5.2.3. Calltipsitertools.count(. A calltip +
For example, restart the Shell and enter
+itertools.count(. A calltip appears because Idle imports itertools into the user process for its own use. -(This could change.) Enterturtle.write(and nothing appears. Idle does +(This could change.) Enterturtle.write(and nothing appears. Idle does not import turtle. The menu or shortcut do nothing either. Enter -import turtleand thenturtle.write(will work.import turtleand thenturtle.write(will work.In an editor, import statements have no effect until one runs the file. One might want to run a file after writing the import statements at the top, or immediately run an existing file before editing.
-25.5.2.4. Python Shell window¶
+26.5.2.4. Python Shell window¶
-
-
-25.5.2.5. Text colors¶
+26.5.2.5. Text colors¶
Idle defaults to black on white text, but colors text with special meanings. For the shell, these are shell output, shell error, user output, and user error. For Python code, at the shell prompt or in an editor, these are -keywords, builtin class and function names, names following
classand -def, strings, and comments. For any text window, these are the cursor (when +keywords, builtin class and function names, names followingclassand +def, strings, and comments. For any text window, these are the cursor (when present), found text (when possible), and selected text.Text coloring is done in the background, so uncolorized text is occasionally visible. To change the color scheme, use the Configure IDLE dialog @@ -499,22 +496,22 @@
25.5.2.5. Text colors -
25.5.3. Startup and code execution¶
-Upon startup with the
-soption, IDLE will execute the file referenced by -the environment variablesIDLESTARTUPorPYTHONSTARTUP. -IDLE first checks forIDLESTARTUP; ifIDLESTARTUPis present the file -referenced is run. IfIDLESTARTUPis not present, IDLE checks for -PYTHONSTARTUP. Files referenced by these environment variables are +26.5.3. Startup and code execution¶
+Upon startup with the
--soption, IDLE will execute the file referenced by +the environment variablesIDLESTARTUPorPYTHONSTARTUP. +IDLE first checks forIDLESTARTUP; ifIDLESTARTUPis present the file +referenced is run. IfIDLESTARTUPis not present, IDLE checks for +PYTHONSTARTUP. Files referenced by these environment variables are convenient places to store functions that are used frequently from the IDLE shell, or for executing import statements to import common modules.In addition,
Tkalso loads a startup file if it is present. Note that the -Tk file is loaded unconditionally. This additional file is.Idle.pyand is -looked for in the user’s home directory. Statements in this file will be +In addition,
+functions to be used from IDLE’s Python shell.Tkalso loads a startup file if it is present. Note that the +Tk file is loaded unconditionally. This additional file is.Idle.pyand is +looked for in the user’s home directory. Statements in this file will be executed in the Tk namespace, so this file is not useful for importing -functions to be used from IDLE’s Python shell.-25.5.3.1. Command line usage¶
-idle.py [-c command] [-d] [-e] [-h] [-i] [-r file] [-s] [-t title] [-] [arg] ... +
26.5.3.1. Command line usage¶
+idle.py [-c command] [-d] [-e] [-h] [-i] [-r file] [-s] [-t title] [-] [arg] ... -c command run command in the shell window -d enable debugger and open shell window @@ -529,21 +526,21 @@
25.5.3.1. Command line usage
If there are arguments:
-
-
sys.argvreflects the arguments passed to IDLE itself.-25.5.3.2. Startup failure¶
+26.5.3.2. Startup failure¶
IDLE uses a socket to communicate between the IDLE GUI process and the user code execution process. A connection must be established whenever the Shell starts or restarts. (The latter is indicated by a divider line that says -‘RESTART’). If the user process fails to connect to the GUI process, it -displays a
Tkerror box with a ‘cannot connect’ message that directs the +‘RESTART’). If the user process fails to connect to the GUI process, it +displays aTkerror box with a ‘cannot connect’ message that directs the user here. It then exits.A common cause of failure is a user-written file with the same name as a standard library module, such as random.py and tkinter.py. When such a @@ -565,46 +562,46 @@
25.5.3.2. Startup failure
When IDLE first starts, it attempts to read user configuration files in -~/.idlerc/ (~ is one’s home directory). If there is a problem, an error +~/.idlerc/ (~ is one’s home directory). If there is a problem, an error message should be displayed. Leaving aside random disk glitches, this can be prevented by never editing the files by hand, using the configuration dialog, under Options, instead Options. Once it happens, the solution may be to delete one or more of the configuration files.
If IDLE quits with no message, and it was not started from a console, try -starting from a console (
+starting from a console (python -m idlelib)and see if a message appears.python -m idlelib)and see if a message appears.-25.5.3.3. IDLE-console differences¶
+26.5.3.3. IDLE-console differences¶
With rare exceptions, the result of executing Python code with IDLE is intended to be the same as executing the same code in a console window. However, the different interface and operation occasionally affect -visible results. For instance,
-sys.modulesstarts with more entries.IDLE also replaces
+sys.stdin,sys.stdout, andsys.stderrwith +visible results. For instance,sys.modulesstarts with more entries.IDLE also replaces
-sys.stdin,sys.stdout, andsys.stderrwith objects that get input from and send output to the Shell window. When Shell has the focus, it controls the keyboard and screen. This is normally transparent, but functions that directly access the keyboard -and screen will not work. Ifsysis reset withimportlib.reload(sys), -IDLE’s changes are lost and things likeinput,raw_input, and -printwill not work correctly.With IDLE’s Shell, one enters, edits, and recalls complete statements. +and screen will not work. If
+sysis reset withimportlib.reload(sys), +IDLE’s changes are lost and things likeinput,raw_input, and +printwill not work correctly.With IDLE’s Shell, one enters, edits, and recalls complete statements. Some consoles only work with a single physical line at a time. IDLE uses -
execto run each statement. As a result,'__builtins__'is always +execto run each statement. As a result,'__builtins__'is always defined for each statement.-25.5.3.4. Developing tkinter applications¶
+26.5.3.4. Developing tkinter applications¶
IDLE is intentionally different from standard Python in order to -facilitate development of tkinter programs. Enter
-import tkinter as tk; +facilitate development of tkinter programs. Enterimport tkinter as tk; root = tk.Tk()in standard Python and nothing appears. Enter the same in IDLE and a tk window appears. In standard Python, one must also enter -root.update()to see the window. IDLE does the equivalent in the +root.update()to see the window. IDLE does the equivalent in the background, about 20 times a second, which is about every 50 milleseconds. -Next enterb = tk.Button(root, text='button'); b.pack(). Again, -nothing visibly changes in standard Python until one entersroot.update().Most tkinter programs run
+root.mainloop(), which usually does not +Next enterb = tk.Button(root, text='button'); b.pack(). Again, +nothing visibly changes in standard Python until one entersroot.update().Most tkinter programs run
root.mainloop(), which usually does not return until the tk app is destroyed. If the program is run with -python -ior from an IDLE editor, a>>>shell prompt does not -appear untilmainloop()returns, at which time there is nothing left +python -ior from an IDLE editor, a>>>shell prompt does not +appear untilmainloop()returns, at which time there is nothing left to interact with.When running a tkinter program from an IDLE editor, one can comment out the mainloop call. One then gets a shell prompt immediately and can @@ -612,7 +609,7 @@
25.5.3.4. Developing tkinter applications -
25.5.3.5. Running without a subprocess¶
+26.5.3.5. Running without a subprocess¶
By default, IDLE executes user code in a separate subprocess via a socket, which uses the internal loopback interface. This connection is not externally visible and no data is sent to or received from the Internet. @@ -638,24 +635,24 @@
25.5.3.5. Running without a subprocess -
25.5.4. Help and preferences¶
+26.5.4. Help and preferences¶
-25.5.4.1. Additional help sources¶
-IDLE includes a help menu entry called “Python Docs” that will open the +
26.5.4.1. Additional help sources¶
+IDLE includes a help menu entry called “Python Docs” that will open the extensive sources of help, including tutorials, available at docs.python.org. Selected URLs can be added or removed from the help menu at any time using the Configure IDLE dialog. See the IDLE help option in the help menu of IDLE for more information.
-25.5.4.2. Setting preferences¶
+26.5.4.2. Setting preferences¶
The font preferences, highlighting, keys, and general preferences can be changed via Configure IDLE on the Option menu. Keys can be user defined; IDLE ships with four built-in key sets. In addition, a user can create a custom key set in the Configure IDLE dialog under the keys tab.
-25.5.4.3. Extensions¶
+26.5.4.3. Extensions¶
IDLE contains an extension facility. Preferences for extensions can be changed with the Extensions tab of the preferences dialog. See the beginning of config-extensions.def in the idlelib directory for further @@ -673,40 +670,40 @@
25.5.4.3. Extensions
Table Of Contents
-
-
Next topic
25.6. Other Graphical User Interface Packages
+ title="next chapter">26.6. Other Graphical User Interface PackagesThis Page
Navigation
modules |