mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-14 12:46:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 12

Issue #5066: Update IDLE docs

Browse source 
Patch by Todd Rovito
This commit is contained in:
Andrew Svetlov 2013-01-14 19:27:36 +02:00
parent 0c8ad61c95
commit 1bd7f02c81
4 changed files with 558 additions and 287 deletions
Download patch file Download diff file Expand all files Collapse all files

343
Doc/library/idle.rst
View file

@ -16,70 +16,82 @@ IDLE has the following features:
* coded in 100% pure Python, using the :mod:`tkinter` GUI toolkit * coded in 100% pure Python, using the :mod:`tkinter` GUI toolkit
* cross-platform: works on Windows and Unix * cross-platform: works on Windows, Unix, and Mac OS X
* multi-window text editor with multiple undo, Python colorizing and many other * multi-window text editor with multiple undo, Python colorizing,
features, e.g. smart indent and call tips smart indent, call tips, and many other features
* Python shell window (a.k.a. interactive interpreter) * Python shell window (a.k.a. interactive interpreter)
* debugger (not complete, but you can set breakpoints, view and step) * debugger (not complete, but you can set breakpoints, view and step)
Menus Menus
----- -----
IDLE has two window types, the Shell window and the Editor window. It is
possible to have multiple editor windows simultaneously. IDLE's
menus dynamically change based on which window is currently selected. Each menu
documented below indicates which window type it is associated with. Click on
the dotted line at the top of a menu to "tear it off": a separate window
containing the menu is created (for Unix and Windows only).
File menu File menu (Shell and Editor)
^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New window New window
create a new editing window Create a new editing window
Open... Open...
open an existing file Open an existing file
Open module... Open module...
open an existing module (searches sys.path) Open an existing module (searches sys.path)
Recent Files
Open a list of recent files
Class browser Class browser
show classes and methods in current file Show classes and methods in current file
Path browser Path browser
show sys.path directories, modules, classes and methods Show sys.path directories, modules, classes and methods
.. index:: .. index::
single: Class browser single: Class browser
single: Path browser single: Path browser
Save Save
save current window to the associated file (unsaved windows have a \* before and Save current window to the associated file (unsaved windows have a
after the window title) \* before and after the window title)
Save As... Save As...
save current window to new file, which becomes the associated file Save current window to new file, which becomes the associated file
Save Copy As... Save Copy As...
save current window to different file without changing the associated file Save current window to different file without changing the associated file
Print Window
Print the current window
Close Close
close current window (asks to save if unsaved) Close current window (asks to save if unsaved)
Exit Exit
close all windows and quit IDLE (asks to save if unsaved) Close all windows and quit IDLE (asks to save if unsaved)
Edit menu Edit menu (Shell and Editor)
^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Undo Undo
Undo last change to current window (max 1000 changes) Undo last change to current window (a maximum of 1000 changes may be undone)
Redo Redo
Redo last undone change to current window Redo last undone change to current window
Cut Cut
Copy selection into system-wide clipboard; then delete selection Copy selection into system-wide clipboard; then delete the selection
Copy Copy
Copy selection into system-wide clipboard Copy selection into system-wide clipboard
@ -108,11 +120,30 @@ Replace...
Go to line Go to line
Ask for a line number and show that line Ask for a line number and show that line
Expand word
Expand the word you have typed to match another word in the same buffer;
repeat to get a different expansion
Show call tip
After an unclosed parenthesis for a function, open a small window with
function parameter hints
Show surrounding parens
Highlight the surrounding parenthesis
Show Completions
Open a scroll window allowing selection keywords and attributes. See
Completions below.
Format menu (Editor window only)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Indent region Indent region
Shift selected lines right 4 spaces Shift selected lines right by the indent width (default 4 spaces)
Dedent region Dedent region
Shift selected lines left 4 spaces Shift selected lines left by the indent width (default 4 spaces)
Comment out region Comment out region
Insert ## in front of selected lines Insert ## in front of selected lines
@ -121,67 +152,121 @@ Uncomment region
Remove leading # or ## from selected lines Remove leading # or ## from selected lines
Tabify region Tabify region
Turns *leading* stretches of spaces into tabs Turns *leading* stretches of spaces into tabs. (Note: We recommend using
4 space blocks to indent Python code.)
Untabify region Untabify region
Turn *all* tabs into the right number of spaces Turn *all* tabs into the correct number of spaces
Expand word Toggle tabs
Expand the word you have typed to match another word in the same buffer; repeat Open a dialog to switch between indenting with spaces and tabs.
to get a different expansion
New Indent Width
Open a dialog to change indent width. The accepted default by the Python
community is 4 spaces.
Format Paragraph Format Paragraph
Reformat the current blank-line-separated paragraph Reformat the current blank-line-separated paragraph. All lines in the
paragraph will be formatted to less than 80 columns.
Import module Strip trailing whitespace
Import or reload the current module Removes any space characters after the end of the last non-space character
Run script
Execute the current file in the __main__ namespace
.. index:: .. index::
single: Import module single: Import module
single: Run script single: Run script
Windows menu Run menu (Editor window only)
^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Zoom Height Python Shell
toggles the window between normal size (24x80) and maximum height. Open or wake up the Python Shell window
The rest of this menu lists the names of all open windows; select one to bring Check module
it to the foreground (deiconifying it if necessary). Check the syntax of the module currently open in the Editor window. If the
module has not been saved IDLE will prompt the user to save the code.
Run module
Restart the shell to clean the environment, then execute the currently
open module. If the module has not been saved IDLE will prompt the user
to save the code.
Debug menu Shell menu (Shell window only)
^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* in the Python Shell window only View Last Restart
Scroll the shell window to the last Shell restart
Restart Shell
Restart the shell to clean the environment
Debug menu (Shell window only)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Go to file/line Go to file/line
Look around the insert point for a filename and line number, open the file, Look around the insert point for a filename and line number, open the file,
and show the line. Useful to view the source lines referenced in an and show the line. Useful to view the source lines referenced in an
exception traceback. exception traceback. Available in the context menu of the Shell window.
Debugger Debugger (toggle)
Run commands in the shell under the debugger. This feature is not complete and considered experimental. Run commands in
the shell under the debugger
Stack viewer Stack viewer
Show the stack traceback of the last exception. Show the stack traceback of the last exception
Auto-open Stack Viewer Auto-open Stack Viewer
Open stack viewer on traceback. Toggle automatically opening the stack viewer on unhandled exception
.. index:: .. index::
single: stack viewer single: stack viewer
single: debugger single: debugger
Options menu (Shell and Editor)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Edit context menu Configure IDLE
^^^^^^^^^^^^^^^^^ Open a configuration dialog. Fonts, indentation, keybindings, and color
themes may be altered. Startup Preferences may be set, and additional
help sources can be specified.
* Right-click in Edit window (Control-click on OS X) Code Context (toggle)(Editor Window only)
Open a pane at the top of the edit window which shows the block context
of the section of code which is scrolling off the top of the window.
Windows menu (Shell and Editor)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Zoom Height
Toggles the window between normal size (40x80 initial setting) and maximum
height. The initial size is in the Configure IDLE dialog under the general
tab.
The rest of this menu lists the names of all open windows; select one to bring
it to the foreground (deiconifying it if necessary).
Help menu (Shell and Editor)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
About IDLE
Version, copyright, license, credits
IDLE Help
Display a help file for IDLE detailing the menu options, basic editing and
navigation, and other tips.
Python Docs
Access local Python documentation, if installed. Or will start a web browser
and open docs.python.org showing the latest Python documentation.
Additional help sources may be added here with the Configure IDLE dialog under
the General tab.
Editor Window context menu
^^^^^^^^^^^^^^^^^^^^^^^^^^
* Right-click in Editor window (Control-click on OS X)
Cut Cut
Copy selection into system-wide clipboard; then delete selection Copy selection into system-wide clipboard; then delete selection
@ -207,8 +292,8 @@ Clear Breakpoint
single: breakpoints single: breakpoints
Shell context menu Shell Window context menu
^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^
* Right-click in Python Shell window (Control-click on OS X) * Right-click in Python Shell window (Control-click on OS X)
@ -225,19 +310,44 @@ Go to file/line
Same as in Debug menu. Same as in Debug menu.
Basic editing and navigation Editing and navigation
---------------------------- ----------------------
* :kbd:`Backspace` deletes to the left; :kbd:`Del` deletes to the right * :kbd:`Backspace` deletes to the left; :kbd:`Del` deletes to the right
* :kbd:`C-Backspace` delete word left; :kbd:`C-Del` delete word to the right
* Arrow keys and :kbd:`Page Up`/:kbd:`Page Down` to move around * Arrow keys and :kbd:`Page Up`/:kbd:`Page Down` to move around
* :kbd:`C-LeftArrow` and :kbd:`C-RightArrow` moves by words
* :kbd:`Home`/:kbd:`End` go to begin/end of line * :kbd:`Home`/:kbd:`End` go to begin/end of line
* :kbd:`C-Home`/:kbd:`C-End` go to begin/end of file * :kbd:`C-Home`/:kbd:`C-End` go to begin/end of file
* Some :program:`Emacs` bindings may also work, including :kbd:`C-B`, * Some useful Emacs bindings are inherited from Tcl/Tk:
:kbd:`C-P`, :kbd:`C-A`, :kbd:`C-E`, :kbd:`C-D`, :kbd:`C-L`
* :kbd:`C-a` beginning of line
* :kbd:`C-e` end of line
* :kbd:`C-k` kill line (but doesn't put it in clipboard)
* :kbd:`C-l` center window around the insertion point
* :kbd:`C-b` go backwards one character without deleting (usually you can
also use the cursor key for this)
* :kbd:`C-f` go forward one character without deleting (usually you can
also use the cursor key for this)
* :kbd:`C-p` go up one line (usually you can also use the cursor key for
this)
* :kbd:`C-d` delete next character
Standard keybindings (like :kbd:`C-c` to copy and :kbd:`C-v` to paste)
may work. Keybindings are selected in the Configure IDLE dialog.
Automatic indentation Automatic indentation
@ -246,27 +356,76 @@ Automatic indentation
After a block-opening statement, the next line is indented by 4 spaces (in the 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.) Python Shell window by one tab). After certain keywords (break, return etc.)
the next line is dedented. In leading indentation, :kbd:`Backspace` deletes up the next line is dedented. In leading indentation, :kbd:`Backspace` deletes up
to 4 spaces if they are there. :kbd:`Tab` inserts 1-4 spaces (in the Python to 4 spaces if they are there. :kbd:`Tab` inserts spaces (in the Python
Shell window one tab). See also the indent/dedent region commands in the edit Shell window one tab), number depends on Indent width. Currently tabs
menu. are restricted to four spaces due to Tcl/Tk limitations.
See also the indent/dedent region commands in the edit menu.
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
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
:kbd:`Tab` will supply that completion without opening the ACW.
'Show Completions' will force open a completions window, by default the
:kbd:`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 name spaces, 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 :kbd:`tab` will
cause the longest non-ambiguous match to be entered in the Editor window or
Shell. Two :kbd:`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!
Completions are currently limited to those in the namespaces. Names in
an Editor window which are not via ``__main__`` and :data:`sys.modules` will
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
longer or disable the extension. Or another option is the delay could
be set to zero. Another alternative to preventing ACW popups is to
disable the call tips extension.
Python Shell window Python Shell window
^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^
* :kbd:`C-C` interrupts executing command * :kbd:`C-c` interrupts executing command
* :kbd:`C-D` sends end-of-file; closes window if typed at a ``>>>`` prompt * :kbd:`C-d` sends end-of-file; closes window if typed at a ``>>>`` prompt
(this is :kbd:`C-z` on Windows).
* :kbd:`Alt-p` retrieves previous command matching what you have typed * :kbd:`Alt-/` (Expand word) is also useful to reduce typing
* :kbd:`Alt-n` retrieves next Command history
* :kbd:`Return` while on any previous command retrieves that command * :kbd:`Alt-p` retrieves previous command matching what you have typed. On
OS X use :kbd:`C-p`.
* :kbd:`Alt-/` (Expand word) is also useful here * :kbd:`Alt-n` retrieves next. On OS X use :kbd:`C-n`.
.. index:: single: indentation * :kbd:`Return` while on any previous command retrieves that command
Syntax colors Syntax colors
@ -308,17 +467,17 @@ Startup
Upon startup with the ``-s`` option, IDLE will execute the file referenced by Upon startup with the ``-s`` option, IDLE will execute the file referenced by
the environment variables :envvar:`IDLESTARTUP` or :envvar:`PYTHONSTARTUP`. the environment variables :envvar:`IDLESTARTUP` or :envvar:`PYTHONSTARTUP`.
Idle first checks for ``IDLESTARTUP``; if ``IDLESTARTUP`` is present the file IDLE first checks for ``IDLESTARTUP``; if ``IDLESTARTUP`` is present the file
referenced is run. If ``IDLESTARTUP`` is not present, Idle checks for referenced is run. If ``IDLESTARTUP`` is not present, IDLE checks for
``PYTHONSTARTUP``. Files referenced by these environment variables are ``PYTHONSTARTUP``. Files referenced by these environment variables are
convenient places to store functions that are used frequently from the Idle convenient places to store functions that are used frequently from the IDLE
shell, or for executing import statements to import common modules. shell, or for executing import statements to import common modules.
In addition, ``Tk`` also loads a startup file if it is present. Note that the In addition, ``Tk`` also loads a startup file if it is present. Note that the
Tk file is loaded unconditionally. This additional file is ``.Idle.py`` and is Tk file is loaded unconditionally. This additional file is ``.Idle.py`` and is
looked for in the user's home directory. Statements in this file will be 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 executed in the Tk namespace, so this file is not useful for importing functions
to be used from Idle's Python shell. to be used from IDLE's Python shell.
Command line usage Command line usage
@ -349,3 +508,45 @@ If there are arguments:
the arguments are still available in ``sys.argv``. the arguments are still available in ``sys.argv``.
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.
Other preferences
-----------------
The font preferences, highlighting, keys, and general preferences can be
changed via the Configure IDLE menu option. Be sure to note that
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.
Extensions
----------
IDLE contains an extension facility. See the beginning of
config-extensions.def in the idlelib directory for further information. The
default extensions are currently:
* FormatParagraph
* AutoExpand
* ZoomHeight
* ScriptBinding
* CallTips
* ParenMatch
* AutoComplete
* CodeContext

2
Lib/idlelib/NEWS.txt
View file

@ -1,6 +1,8 @@
What's New in IDLE 3.4.0? What's New in IDLE 3.4.0?
========================= =========================
- Issue #5066: Update IDLE docs. Patch by Todd Rovito.
- Issue #16226: Fix IDLE Path Browser crash. - Issue #16226: Fix IDLE Path Browser crash.
(Patch by Roger Serwy) (Patch by Roger Serwy)

498
Lib/idlelib/help.txt
View file

@ -1,142 +1,185 @@
[See the end of this file for ** TIPS ** on using IDLE !!] [See the end of this file for ** TIPS ** on using IDLE !!]
Click on the dotted line at the top of a menu to "tear it off": a IDLE is the Python IDE built with the tkinter GUI toolkit.
separate window containing the menu is created.
File Menu: IDLE has the following features:
-coded in 100% pure Python, using the tkinter GUI toolkit
-cross-platform: works on Windows, Unix, and OS X
-multi-window text editor with multiple undo, Python colorizing, smart indent,
call tips, and many other features
-Python shell window (a.k.a interactive interpreter)
-debugger (not complete, but you can set breakpoints, view and step)
New Window -- Create a new editing window Menus:
Open... -- Open an existing file
Recent Files... -- Open a list of recent files IDLE has two window types the Shell window and the Editor window. It is
Open Module... -- Open an existing module (searches sys.path) possible to have multiple editor windows simultaneously. IDLE's
Class Browser -- Show classes and methods in current file menus dynamically change based on which window is currently selected. Each menu
Path Browser -- Show sys.path directories, modules, classes documented below indicates which window type it is associated with. Click on
the dotted line at the top of a menu to "tear it off": a separate window
containing the menu is created (for Unix and Windows only).
File Menu (Shell and Editor):
New Window -- Create a new editing window
Open... -- Open an existing file
Open Module... -- Open an existing module (searches sys.path)
Recent Files... -- Open a list of recent files
Class Browser -- Show classes and methods in current file
Path Browser -- Show sys.path directories, modules, classes,
and methods and methods
--- ---
Save -- Save current window to the associated file (unsaved Save -- Save current window to the associated file (unsaved
windows have a * before and after the window title) windows have a * before and after the window title)
Save As... -- Save current window to new file, which becomes Save As... -- Save current window to new file, which becomes
the associated file the associated file
Save Copy As... -- Save current window to different file Save Copy As... -- Save current window to different file
without changing the associated file without changing the associated file
--- ---
Print Window -- Print the current window Print Window -- Print the current window
--- ---
Close -- Close current window (asks to save if unsaved) Close -- Close current window (asks to save if unsaved)
Exit -- Close all windows, quit (asks to save if unsaved) Exit -- Close all windows, quit (asks to save if unsaved)
Edit Menu: Edit Menu (Shell and Editor):
Undo -- Undo last change to current window Undo -- Undo last change to current window
(A maximum of 1000 changes may be undone) (a maximum of 1000 changes may be undone)
Redo -- Redo last undone change to current window Redo -- Redo last undone change to current window
--- ---
Cut -- Copy a selection into system-wide clipboard, Cut -- Copy a selection into system-wide clipboard,
then delete the selection then delete the selection
Copy -- Copy selection into system-wide clipboard Copy -- Copy selection into system-wide clipboard
Paste -- Insert system-wide clipboard into window Paste -- Insert system-wide clipboard into window
Select All -- Select the entire contents of the edit buffer Select All -- Select the entire contents of the edit buffer
--- ---
Find... -- Open a search dialog box with many options Find... -- Open a search dialog box with many options
Find Again -- Repeat last search Find Again -- Repeat last search
Find Selection -- Search for the string in the selection Find Selection -- Search for the string in the selection
Find in Files... -- Open a search dialog box for searching files Find in Files... -- Open a search dialog box for searching files
Replace... -- Open a search-and-replace dialog box Replace... -- Open a search-and-replace dialog box
Go to Line -- Ask for a line number and show that line Go to Line -- Ask for a line number and show that line
Show Calltip -- Open a small window with function param hints Expand Word -- Expand the word you have typed to match another
Show Completions -- Open a scroll window allowing selection keywords word in the same buffer; repeat to get a
and attributes. (see '*TIPS*', below)
Show Parens -- Highlight the surrounding parenthesis
Expand Word -- Expand the word you have typed to match another
word in the same buffer; repeat to get a
different expansion different expansion
Show Calltip -- After an unclosed parenthesis for a function, open
a small window with function parameter hints
Show Parens -- Highlight the surrounding parenthesis
Show Completions -- Open a scroll window allowing selection keywords
and attributes. (see '*TIPS*', below)
Format Menu (only in Edit window): Format Menu (Editor window only):
Indent Region -- Shift selected lines right 4 spaces Indent Region -- Shift selected lines right by the indent width
Dedent Region -- Shift selected lines left 4 spaces (default 4 spaces)
Comment Out Region -- Insert ## in front of selected lines Dedent Region -- Shift selected lines left by the indent width
Uncomment Region -- Remove leading # or ## from selected lines (default 4 spaces)
Tabify Region -- Turns *leading* stretches of spaces into tabs Comment Out Region -- Insert ## in front of selected lines
(Note: We recommend using 4 space blocks to indent Python code.) Uncomment Region -- Remove leading # or ## from selected lines
Untabify Region -- Turn *all* tabs into the right number of spaces Tabify Region -- Turns *leading* stretches of spaces into tabs.
New Indent Width... -- Open dialog to change indent width (Note: We recommend using 4 space blocks to indent Python code.)
Format Paragraph -- Reformat the current blank-line-separated Untabify Region -- Turn *all* tabs into the corrent number of spaces
paragraph Toggle tabs -- Open a dialog to switch between indenting with
spaces and tabs.
New Indent Width... -- Open a dialog to change indent width. The
accepted default by the Python community is 4
spaces.
Format Paragraph -- Reformat the current blank-line-separated
paragraph. All lines in the paragraph will be
formatted to less than 80 columns.
---
Strip trailing whitespace -- Removed any space characters after the end
of the last non-space character
Run Menu (only in Edit window): Run Menu (Editor window only):
Python Shell -- Open or wake up the Python shell window Python Shell -- Open or wake up the Python shell window
--- ---
Check Module -- Run a syntax check on the module Check Module -- Check the syntax of the module currently open in the
Run Module -- Execute the current file in the __main__ namespace Editor window. If the module has not been saved IDLE
will prompt the user to save the code.
Run Module -- Restart the shell to clean the environment, then
execute the currently open module. If the module has
not been saved IDLE will prompt the user to save the
code.
Shell Menu (only in Shell window): Shell Menu (Shell window only):
View Last Restart -- Scroll the shell window to the last restart View Last Restart -- Scroll the shell window to the last Shell restart
Restart Shell -- Restart the interpreter with a fresh environment Restart Shell -- Restart the shell to clean the environment
Debug Menu (only in Shell window): Debug Menu (Shell window only):
Go to File/Line -- look around the insert point for a filename Go to File/Line -- Look around the insert point for a filename
and line number, open the file, and show the line and line number, open the file, and show the line.
Debugger (toggle) -- Run commands in the shell under the debugger Useful to view the source lines referenced in an
Stack Viewer -- Show the stack traceback of the last exception exception traceback. Available in the context
Auto-open Stack Viewer (toggle) -- Open stack viewer on traceback menu of the Shell window.
Debugger (toggle) -- This feature is not complete and considered
experimental. Run commands in the shell under the
debugger.
Stack Viewer -- Show the stack traceback of the last exception
Auto-open Stack Viewer (toggle) -- Toggle automatically opening the
stack viewer on unhandled
exception
Options Menu: Options Menu (Shell and Editor):
Configure IDLE -- Open a configuration dialog. Fonts, indentation, Configure IDLE -- Open a configuration dialog. Fonts, indentation,
keybindings, and color themes may be altered. keybindings, and color themes may be altered.
Startup Preferences may be set, and Additional Help Startup Preferences may be set, and additional Help
Sources can be specified. sources can be specified.
On OS X this menu is not present, use
menu 'IDLE -> Preferences...' instead.
---
Code Context -- Open a pane at the top of the edit window which
shows the block context of the section of code
which is scrolling off the top or the window.
(Not present in Shell window.)
Windows Menu: ---
Code Context (toggle) -- Open a pane at the top of the edit window
which shows the block context of the section
of code which is scrolling off the top or the
window. This is not present in the Shell
window only the Editor window.
Zoom Height -- toggles the window between configured size Windows Menu (Shell and Editor):
and maximum height.
--- Zoom Height -- Toggles the window between normal size (40x80 initial
The rest of this menu lists the names of all open windows; setting) and maximum height. The initial size is in the Configure
select one to bring it to the foreground (deiconifying it if IDLE dialog under the general tab.
necessary). ---
The rest of this menu lists the names of all open windows;
select one to bring it to the foreground (deiconifying it if
necessary).
Help Menu: Help Menu:
About IDLE -- Version, copyright, license, credits About IDLE -- Version, copyright, license, credits
IDLE Readme -- Background discussion and change details ---
--- IDLE Help -- Display this file which is a help file for IDLE
IDLE Help -- Display this file detailing the menu options, basic editing and navigation,
Python Docs -- Access local Python documentation, if and other tips.
installed. Otherwise, access www.python.org. Python Docs -- Access local Python documentation, if
--- installed. Or will start a web browser and open
(Additional Help Sources may be added here) docs.python.org showing the latest Python documentation.
---
Additional help sources may be added here with the Configure IDLE
dialog under the General tab.
Edit context menu (Right-click / Control-click on OS X in Edit window): Editor context menu (Right-click / Control-click on OS X in Edit window):
Cut -- Copy a selection into system-wide clipboard, Cut -- Copy a selection into system-wide clipboard,
then delete the selection then delete the selection
Copy -- Copy selection into system-wide clipboard Copy -- Copy selection into system-wide clipboard
Paste -- Insert system-wide clipboard into window Paste -- Insert system-wide clipboard into window
Set Breakpoint -- Sets a breakpoint (when debugger open) Set Breakpoint -- Sets a breakpoint. Breakpoints are only enabled
Clear Breakpoint -- Clears the breakpoint on that line when the debugger is open.
Clear Breakpoint -- Clears the breakpoint on that line
Shell context menu (Right-click / Control-click on OS X in Shell window): Shell context menu (Right-click / Control-click on OS X in Shell window):
Cut -- Copy a selection into system-wide clipboard, Cut -- Copy a selection into system-wide clipboard,
then delete the selection then delete the selection
Copy -- Copy selection into system-wide clipboard Copy -- Copy selection into system-wide clipboard
Paste -- Insert system-wide clipboard into window Paste -- Insert system-wide clipboard into window
--- ---
Go to file/line -- Same as in Debug menu Go to file/line -- Same as in Debug menu
** TIPS ** ** TIPS **
@ -144,160 +187,183 @@ Shell context menu (Right-click / Control-click on OS X in Shell window):
Additional Help Sources: Additional Help Sources:
Windows users can Google on zopeshelf.chm to access Zope help files in Windows users can Google on zopeshelf.chm to access Zope help files in
the Windows help format. The Additional Help Sources feature of the the Windows help format. The Additional Help Sources feature of the
configuration GUI supports .chm, along with any other filetypes configuration GUI supports .chm, along with any other filetypes
supported by your browser. Supply a Menu Item title, and enter the supported by your browser. Supply a Menu Item title, and enter the
location in the Help File Path slot of the New Help Source dialog. Use location in the Help File Path slot of the New Help Source dialog. Use
http:// and/or www. to identify external URLs, or download the file and http:// and/or www. to identify external URLs, or download the file and
browse for its path on your machine using the Browse button. browse for its path on your machine using the Browse button.
All users can access the extensive sources of help, including All users can access the extensive sources of help, including
tutorials, available at www.python.org/doc. Selected URLs can be added tutorials, available at docs.python.org. Selected URLs can be added
or removed from the Help menu at any time using Configure IDLE. or removed from the Help menu at any time using Configure IDLE.
Basic editing and navigation: Basic editing and navigation:
Backspace deletes char to the left; DEL deletes char to the right. Backspace deletes char to the left; DEL deletes char to the right.
Control-backspace deletes word left, Control-DEL deletes word right. Control-backspace deletes word left, Control-DEL deletes word right.
Arrow keys and Page Up/Down move around. Arrow keys and Page Up/Down move around.
Control-left/right Arrow moves by words in a strange but useful way. Control-left/right Arrow moves by words in a strange but useful way.
Home/End go to begin/end of line. Home/End go to begin/end of line.
Control-Home/End go to begin/end of file. Control-Home/End go to begin/end of file.
Some useful Emacs bindings are inherited from Tcl/Tk: Some useful Emacs bindings are inherited from Tcl/Tk:
Control-a beginning of line Control-a beginning of line
Control-e end of line Control-e end of line
Control-k kill line (but doesn't put it in clipboard) Control-k kill line (but doesn't put it in clipboard)
Control-l center window around the insertion point Control-l center window around the insertion point
Standard Windows bindings may work on that platform. Standard keybindings (like Control-c to copy and Control-v to
Keybindings are selected in the Settings Dialog, look there. paste) may work. Keybindings are selected in the Configure IDLE
dialog.
Automatic indentation: Automatic indentation:
After a block-opening statement, the next line is indented by 4 spaces After a block-opening statement, the next line is indented by 4 spaces
(in the Python Shell window by one tab). After certain keywords (in the Python Shell window by one tab). After certain keywords
(break, return etc.) the next line is dedented. In leading (break, return etc.) the next line is dedented. In leading
indentation, Backspace deletes up to 4 spaces if they are there. Tab indentation, Backspace deletes up to 4 spaces if they are there. Tab
inserts spaces (in the Python Shell window one tab), number depends on inserts spaces (in the Python Shell window one tab), number depends on
Indent Width. (N.B. Currently tabs are restricted to four spaces due Indent Width. Currently tabs are restricted to four spaces due
to Tcl/Tk issues.) to Tcl/Tk limitations.
See also the indent/dedent region commands in the edit menu. See also the indent/dedent region commands in the edit menu.
Completions: Completions:
Completions are supplied for functions, classes, and attributes of Completions are supplied for functions, classes, and attributes of
classes, both built-in and user-defined. Completions are also provided classes, both built-in and user-defined. Completions are also provided
for filenames. for filenames.
The AutoCompleteWindow (ACW) will open after a predefined delay The AutoCompleteWindow (ACW) will open after a predefined delay
(default is two seconds) after a '.' or (in a string) an os.sep is (default is two seconds) after a '.' or (in a string) an os.sep is
typed. If after one of those characters (plus zero or more other typed. If after one of those characters (plus zero or more other
characters) you type a Tab the ACW will open immediately if a possible characters) a tab is typed the ACW will open immediately if a possible
continuation is found. continuation is found.
If there is only one possible completion for the characters entered, a If there is only one possible completion for the characters entered, a
Tab will supply that completion without opening the ACW. tab will supply that completion without opening the ACW.
'Show Completions' will force open a completions window. In an empty 'Show Completions' will force open a completions window, by default the
string, this will contain the files in the current directory. On a Control-space keys will open a completions window. In an empty
blank line, it will contain the built-in and user-defined functions and string, this will contain the files in the current directory. On a
classes in the current name spaces, plus any modules imported. If some blank line, it will contain the built-in and user-defined functions and
characters have been entered, the ACW will attempt to be more specific. classes in the current name spaces, plus any modules imported. If some
characters have been entered, the ACW will attempt to be more specific.
If string of characters is typed, the ACW selection will jump to the If string of characters is typed, the ACW selection will jump to the
entry most closely matching those characters. Entering a Tab will cause entry most closely matching those characters. Entering a tab will cause
the longest non-ambiguous match to be entered in the Edit window or the longest non-ambiguous match to be entered in the Edit window or
Shell. Two Tabs in a row will supply the current ACW selection, as Shell. Two tabs in a row will supply the current ACW selection, as
will Return or a double click. Cursor keys, Page Up/Down, mouse will return or a double click. Cursor keys, Page Up/Down, mouse
selection, and the scrollwheel all operate on the ACW. selection, and the scroll wheel all operate on the ACW.
'Hidden' attributes can be accessed by typing the beginning of hidden "Hidden" attributes can be accessed by typing the beginning of hidden
name after a '.'. e.g. '_'. This allows access to modules with name after a '.', e.g. '_'. This allows access to modules with
'__all__' set, or to class-private attributes. '__all__' set, or to class-private attributes.
Completions and the 'Expand Word' facility can save a lot of typing! Completions and the 'Expand Word' facility can save a lot of typing!
Completions are currently limited to those in the namespaces. Names in Completions are currently limited to those in the namespaces. Names in
an Edit window which are not via __main__ or sys.modules will not be an Editor window which are not via __main__ or sys.modules will not be
found. Run the module once with your imports to correct this found. Run the module once with your imports to correct this
situation. Note that IDLE itself places quite a few modules in 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. 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. OTOH, you could make the delay zero. longer or disable the extension. Or another option is the delay could
be set to zero. Another alternative to preventing ACW popups is to
You could also switch off the CallTips extension. (We will be adding disable the call tips extension.
a delay to the call tip window.)
Python Shell window: Python Shell window:
Control-c interrupts executing command. Control-c interrupts executing command.
Control-d sends end-of-file; closes window if typed at >>> prompt Control-d sends end-of-file; closes window if typed at >>> prompt
(this is Control-z on Windows). (this is Control-z on Windows).
Alt-/ expand word is also useful to reduce typing.
Command history: Command history:
Alt-p retrieves previous command matching what you have typed. Alt-p retrieves previous command matching what you have typed. On OS X
Alt-n retrieves next. use Control-p.
(These are Control-p, Control-n on OS X) Alt-n retrieves next. On OS X use Control-n.
Return while cursor is on a previous command retrieves that command. Return while cursor is on a previous command retrieves that command.
Expand word is also useful to reduce typing.
Syntax colors: Syntax colors:
The coloring is applied in a background "thread", so you may The coloring is applied in a background "thread", so you may
occasionally see uncolorized text. To change the color occasionally see uncolorized text. To change the color
scheme, use the Configure IDLE / Highlighting dialog. scheme, use the Configure IDLE / Highlighting dialog.
Python default syntax colors: Python default syntax colors:
Keywords orange Keywords orange
Builtins royal purple Builtins royal purple
Strings green Strings green
Comments red Comments red
Definitions blue Definitions blue
Shell default colors: Shell default colors:
Console output brown Console output brown
stdout blue stdout blue
stderr red stderr red
stdin black stdin black
Other preferences: Other preferences:
The font preferences, keybinding, and startup preferences can The font preferences, highlighting, keys, and general preferences can
be changed using the Settings dialog. be changed via the Configure IDLE menu option. Be sure to note that
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.
Command line usage: Command line usage:
Enter idle -h at the command prompt to get a usage message. Enter idle -h at the command prompt to get a usage message.
Running without a subprocess: (DEPRECATED) idle.py [-c command] [-d] [-e] [-s] [-t title] [arg] ...
If IDLE is started with the -n command line switch it will run in a -c command run this command
single process and will not create the subprocess which runs the RPC -d enable debugger
Python execution server. This can be useful if Python cannot create -e edit mode; arguments are files to be edited
the subprocess or the RPC socket interface on your platform. However, -s run $IDLESTARTUP or $PYTHONSTARTUP first
in this mode user code is not isolated from IDLE itself. Also, the -t title set title of shell window
environment is not restarted when Run/Run Module (F5) is selected. If
your code has been modified, you must reload() the affected modules and If there are arguments:
re-import any specific items (e.g. from foo import baz) if the changes 1. If -e is used, arguments are files opened for editing and sys.argv
are to take effect. For these reasons, it is preferable to run IDLE reflects the arguments passed to IDLE itself.
with the default subprocess if at all possible. 2. Otherwise, if -c is used, all arguments are placed in
sys.argv[1:...], with sys.argv[0] set to -c.
3. Otherwise, if neither -e nor -c is used, the first argument is a
script which is executed with the remaining arguments in
sys.argv[1:...] and sys.argv[0] set to the script name. If the
script name is -, no script is executed but an interactive Python
session is started; the arguments are still available in sys.argv.
Running without a subprocess: (DEPRECATED in Python 3.5 see Issue 16123)
If IDLE is started with the -n command line switch it will run in a
single process and will not create the subprocess which runs the RPC
Python execution server. This can be useful if Python cannot create
the subprocess or the RPC socket interface on your platform. However,
in this mode user code is not isolated from IDLE itself. Also, the
environment is not restarted when Run/Run Module (F5) is selected. If
your code has been modified, you must reload() the affected modules and
re-import any specific items (e.g. from foo import baz) if the changes
are to take effect. For these reasons, it is preferable to run IDLE
with the default subprocess if at all possible.
Extensions: Extensions:
IDLE contains an extension facility. See the beginning of IDLE contains an extension facility. See the beginning of
config-extensions.def in the idlelib directory for further information. config-extensions.def in the idlelib directory for further information.
The default extensions are currently: The default extensions are currently:
FormatParagraph FormatParagraph
AutoExpand AutoExpand
ZoomHeight ZoomHeight
ScriptBinding ScriptBinding
CallTips CallTips
ParenMatch ParenMatch
AutoComplete AutoComplete
CodeContext CodeContext

2
Misc/NEWS
View file

@ -217,6 +217,8 @@ Core and Builtins
Library Library
------- -------
- Issue #5066: Update IDLE docs. Patch by Todd Rovito.
- Issue #16955: Fix the poll() method for multiprocessing's socket - Issue #16955: Fix the poll() method for multiprocessing's socket
connections on Windows. connections on Windows.