This file, idlelib/help.txt is out-of-date and no longer used by Idle.

[0] Fix | Delete

It is deprecated and will be removed in the future, possibly in 3.6

[1] Fix | Delete

----------------------------------------------------------------------

[2] Fix | Delete

[3] Fix | Delete

[See the end of this file for ** TIPS ** on using IDLE !!]

[4] Fix | Delete

[5] Fix | Delete

File Menu:

[6] Fix | Delete

[7] Fix | Delete

New File -- Create a new editing window

[8] Fix | Delete

Open... -- Open an existing file

[9] Fix | Delete

Recent Files... -- Open a list of recent files

[10] Fix | Delete

Open Module... -- Open an existing module (searches sys.path)

[11] Fix | Delete

Class Browser -- Show classes and methods in current file

[12] Fix | Delete

Path Browser -- Show sys.path directories, modules, classes

[13] Fix | Delete

and methods

[14] Fix | Delete

---

[15] Fix | Delete

Save -- Save current window to the associated file (unsaved

[16] Fix | Delete

windows have a * before and after the window title)

[17] Fix | Delete

[18] Fix | Delete

Save As... -- Save current window to new file, which becomes

[19] Fix | Delete

the associated file

[20] Fix | Delete

Save Copy As... -- Save current window to different file

[21] Fix | Delete

without changing the associated file

[22] Fix | Delete

---

[23] Fix | Delete

Print Window -- Print the current window

[24] Fix | Delete

---

[25] Fix | Delete

Close -- Close current window (asks to save if unsaved)

[26] Fix | Delete

Exit -- Close all windows, quit (asks to save if unsaved)

[27] Fix | Delete

[28] Fix | Delete

Edit Menu:

[29] Fix | Delete

[30] Fix | Delete

Undo -- Undo last change to current window

[31] Fix | Delete

(A maximum of 1000 changes may be undone)

[32] Fix | Delete

Redo -- Redo last undone change to current window

[33] Fix | Delete

---

[34] Fix | Delete

Cut -- Copy a selection into system-wide clipboard,

[35] Fix | Delete

then delete the selection

[36] Fix | Delete

Copy -- Copy selection into system-wide clipboard

[37] Fix | Delete

Paste -- Insert system-wide clipboard into window

[38] Fix | Delete

Select All -- Select the entire contents of the edit buffer

[39] Fix | Delete

---

[40] Fix | Delete

Find... -- Open a search dialog box with many options

[41] Fix | Delete

Find Again -- Repeat last search

[42] Fix | Delete

Find Selection -- Search for the string in the selection

[43] Fix | Delete

Find in Files... -- Open a search dialog box for searching files

[44] Fix | Delete

Replace... -- Open a search-and-replace dialog box

[45] Fix | Delete

Go to Line -- Ask for a line number and show that line

[46] Fix | Delete

Show Calltip -- Open a small window with function param hints

[47] Fix | Delete

Show Completions -- Open a scroll window allowing selection keywords

[48] Fix | Delete

and attributes. (see '*TIPS*', below)

[49] Fix | Delete

Show Parens -- Highlight the surrounding parenthesis

[50] Fix | Delete

Expand Word -- Expand the word you have typed to match another

[51] Fix | Delete

word in the same buffer; repeat to get a

[52] Fix | Delete

different expansion

[53] Fix | Delete

[54] Fix | Delete

Format Menu (only in Edit window):

[55] Fix | Delete

[56] Fix | Delete

Indent Region -- Shift selected lines right 4 spaces

[57] Fix | Delete

Dedent Region -- Shift selected lines left 4 spaces

[58] Fix | Delete

Comment Out Region -- Insert ## in front of selected lines

[59] Fix | Delete

Uncomment Region -- Remove leading # or ## from selected lines

[60] Fix | Delete

Tabify Region -- Turns *leading* stretches of spaces into tabs

[61] Fix | Delete

(Note: We recommend using 4 space blocks to indent Python code.)

[62] Fix | Delete

Untabify Region -- Turn *all* tabs into the right number of spaces

[63] Fix | Delete

New Indent Width... -- Open dialog to change indent width

[64] Fix | Delete

Format Paragraph -- Reformat the current blank-line-separated

[65] Fix | Delete

paragraph

[66] Fix | Delete

[67] Fix | Delete

Run Menu (only in Edit window):

[68] Fix | Delete

[69] Fix | Delete

Python Shell -- Open or wake up the Python shell window

[70] Fix | Delete

---

[71] Fix | Delete

Check Module -- Run a syntax check on the module

[72] Fix | Delete

Run Module -- Execute the current file in the __main__ namespace

[73] Fix | Delete

[74] Fix | Delete

Shell Menu (only in Shell window):

[75] Fix | Delete

[76] Fix | Delete

View Last Restart -- Scroll the shell window to the last restart

[77] Fix | Delete

Restart Shell -- Restart the interpreter with a fresh environment

[78] Fix | Delete

[79] Fix | Delete

Debug Menu (only in Shell window):

[80] Fix | Delete

[81] Fix | Delete

Go to File/Line -- look around the insert point for a filename

[82] Fix | Delete

and line number, open the file, and show the line

[83] Fix | Delete

Debugger (toggle) -- Run commands in the shell under the debugger

[84] Fix | Delete

Stack Viewer -- Show the stack traceback of the last exception

[85] Fix | Delete

Auto-open Stack Viewer (toggle) -- Open stack viewer on traceback

[86] Fix | Delete

[87] Fix | Delete

Options Menu:

[88] Fix | Delete

[89] Fix | Delete

Configure IDLE -- Open a configuration dialog. Fonts, indentation,

[90] Fix | Delete

keybindings, and color themes may be altered.

[91] Fix | Delete

Startup Preferences may be set, and Additional Help

[92] Fix | Delete

Sources can be specified. On OS X, open the

[93] Fix | Delete

configuration dialog by selecting Preferences

[94] Fix | Delete

in the application menu.

[95] Fix | Delete

---

[96] Fix | Delete

Code Context -- Open a pane at the top of the edit window which

[97] Fix | Delete

shows the block context of the section of code

[98] Fix | Delete

which is scrolling off the top or the window.

[99] Fix | Delete

(Not present in Shell window.)

[100] Fix | Delete

[101] Fix | Delete

Window Menu:

[102] Fix | Delete

[103] Fix | Delete

Zoom Height -- toggles the window between configured size

[104] Fix | Delete

and maximum height.

[105] Fix | Delete

---

[106] Fix | Delete

The rest of this menu lists the names of all open windows;

[107] Fix | Delete

select one to bring it to the foreground (deiconifying it if

[108] Fix | Delete

necessary).

[109] Fix | Delete

[110] Fix | Delete

Help Menu:

[111] Fix | Delete

[112] Fix | Delete

About IDLE -- Version, copyright, license, credits

[113] Fix | Delete

IDLE Readme -- Background discussion and change details

[114] Fix | Delete

---

[115] Fix | Delete

IDLE Help -- Display this file

[116] Fix | Delete

Python Docs -- Access local Python documentation, if

[117] Fix | Delete

installed. Otherwise, access www.python.org.

[118] Fix | Delete

---

[119] Fix | Delete

(Additional Help Sources may be added here)

[120] Fix | Delete

[121] Fix | Delete

Edit context menu (Right-click / Control-click on OS X in Edit window):

[122] Fix | Delete

[123] Fix | Delete

Cut -- Copy a selection into system-wide clipboard,

[124] Fix | Delete

then delete the selection

[125] Fix | Delete

Copy -- Copy selection into system-wide clipboard

[126] Fix | Delete

Paste -- Insert system-wide clipboard into window

[127] Fix | Delete

Set Breakpoint -- Sets a breakpoint (when debugger open)

[128] Fix | Delete

Clear Breakpoint -- Clears the breakpoint on that line

[129] Fix | Delete

[130] Fix | Delete

Shell context menu (Right-click / Control-click on OS X in Shell window):

[131] Fix | Delete

[132] Fix | Delete

Cut -- Copy a selection into system-wide clipboard,

[133] Fix | Delete

then delete the selection

[134] Fix | Delete

Copy -- Copy selection into system-wide clipboard

[135] Fix | Delete

Paste -- Insert system-wide clipboard into window

[136] Fix | Delete

---

[137] Fix | Delete

Go to file/line -- Same as in Debug menu

[138] Fix | Delete

[139] Fix | Delete

[140] Fix | Delete

** TIPS **

[141] Fix | Delete

==========

[142] Fix | Delete

[143] Fix | Delete

Additional Help Sources:

[144] Fix | Delete

[145] Fix | Delete

Windows users can Google on zopeshelf.chm to access Zope help files in

[146] Fix | Delete

the Windows help format. The Additional Help Sources feature of the

[147] Fix | Delete

configuration GUI supports .chm, along with any other filetypes

[148] Fix | Delete

supported by your browser. Supply a Menu Item title, and enter the

[149] Fix | Delete

location in the Help File Path slot of the New Help Source dialog. Use

[150] Fix | Delete

http:// and/or www. to identify external URLs, or download the file and

[151] Fix | Delete

browse for its path on your machine using the Browse button.

[152] Fix | Delete

[153] Fix | Delete

All users can access the extensive sources of help, including

[154] Fix | Delete

tutorials, available at www.python.org/doc. Selected URLs can be added

[155] Fix | Delete

or removed from the Help menu at any time using Configure IDLE.

[156] Fix | Delete

[157] Fix | Delete

Basic editing and navigation:

[158] Fix | Delete

[159] Fix | Delete

Backspace deletes char to the left; DEL deletes char to the right.

[160] Fix | Delete

Control-backspace deletes word left, Control-DEL deletes word right.

[161] Fix | Delete

Arrow keys and Page Up/Down move around.

[162] Fix | Delete

Control-left/right Arrow moves by words in a strange but useful way.

[163] Fix | Delete

Home/End go to begin/end of line.

[164] Fix | Delete

Control-Home/End go to begin/end of file.

[165] Fix | Delete

Some useful Emacs bindings are inherited from Tcl/Tk:

[166] Fix | Delete

Control-a beginning of line

[167] Fix | Delete

Control-e end of line

[168] Fix | Delete

Control-k kill line (but doesn't put it in clipboard)

[169] Fix | Delete

Control-l center window around the insertion point

[170] Fix | Delete

Standard Windows bindings may work on that platform.

[171] Fix | Delete

Keybindings are selected in the Settings Dialog, look there.

[172] Fix | Delete

[173] Fix | Delete

Automatic indentation:

[174] Fix | Delete

[175] Fix | Delete

After a block-opening statement, the next line is indented by 4 spaces

[176] Fix | Delete

(in the Python Shell window by one tab). After certain keywords

[177] Fix | Delete

(break, return etc.) the next line is dedented. In leading

[178] Fix | Delete

indentation, Backspace deletes up to 4 spaces if they are there. Tab

[179] Fix | Delete

inserts spaces (in the Python Shell window one tab), number depends on

[180] Fix | Delete

Indent Width. (N.B. Currently tabs are restricted to four spaces due

[181] Fix | Delete

to Tcl/Tk issues.)

[182] Fix | Delete

[183] Fix | Delete

See also the indent/dedent region commands in the edit menu.

[184] Fix | Delete

[185] Fix | Delete

Completions:

[186] Fix | Delete

[187] Fix | Delete

Completions are supplied for functions, classes, and attributes of

[188] Fix | Delete

classes, both built-in and user-defined. Completions are also provided

[189] Fix | Delete

for filenames.

[190] Fix | Delete

[191] Fix | Delete

The AutoCompleteWindow (ACW) will open after a predefined delay

[192] Fix | Delete

(default is two seconds) after a '.' or (in a string) an os.sep is

[193] Fix | Delete

typed. If after one of those characters (plus zero or more other

[194] Fix | Delete

characters) you type a Tab the ACW will open immediately if a possible

[195] Fix | Delete

continuation is found.

[196] Fix | Delete

[197] Fix | Delete

If there is only one possible completion for the characters entered, a

[198] Fix | Delete

Tab will supply that completion without opening the ACW.

[199] Fix | Delete

[200] Fix | Delete

'Show Completions' will force open a completions window. In an empty

[201] Fix | Delete

string, this will contain the files in the current directory. On a

[202] Fix | Delete

blank line, it will contain the built-in and user-defined functions and

[203] Fix | Delete

classes in the current name spaces, plus any modules imported. If some

[204] Fix | Delete

characters have been entered, the ACW will attempt to be more specific.

[205] Fix | Delete

[206] Fix | Delete

If string of characters is typed, the ACW selection will jump to the

[207] Fix | Delete

entry most closely matching those characters. Entering a Tab will cause

[208] Fix | Delete

the longest non-ambiguous match to be entered in the Edit window or

[209] Fix | Delete

Shell. Two Tabs in a row will supply the current ACW selection, as

[210] Fix | Delete

will Return or a double click. Cursor keys, Page Up/Down, mouse

[211] Fix | Delete

selection, and the scrollwheel all operate on the ACW.

[212] Fix | Delete

[213] Fix | Delete

'Hidden' attributes can be accessed by typing the beginning of hidden

[214] Fix | Delete

name after a '.'. e.g. '_'. This allows access to modules with

[215] Fix | Delete

'__all__' set, or to class-private attributes.

[216] Fix | Delete

[217] Fix | Delete

Completions and the 'Expand Word' facility can save a lot of typing!

[218] Fix | Delete

[219] Fix | Delete

Completions are currently limited to those in the namespaces. Names in

[220] Fix | Delete

an Edit window which are not via __main__ or sys.modules will not be

[221] Fix | Delete

found. Run the module once with your imports to correct this

[222] Fix | Delete

situation. Note that IDLE itself places quite a few modules in

[223] Fix | Delete

sys.modules, so much can be found by default, e.g. the re module.

[224] Fix | Delete

[225] Fix | Delete

If you don't like the ACW popping up unbidden, simply make the delay

[226] Fix | Delete

longer or disable the extension. OTOH, you could make the delay zero.

[227] Fix | Delete

[228] Fix | Delete

You could also switch off the CallTips extension. (We will be adding

[229] Fix | Delete

a delay to the call tip window.)

[230] Fix | Delete

[231] Fix | Delete

Python Shell window:

[232] Fix | Delete

[233] Fix | Delete

Control-c interrupts executing command.

[234] Fix | Delete

Control-d sends end-of-file; closes window if typed at >>> prompt.

[235] Fix | Delete

[236] Fix | Delete

Command history:

[237] Fix | Delete

[238] Fix | Delete

Alt-p retrieves previous command matching what you have typed.

[239] Fix | Delete

Alt-n retrieves next.

[240] Fix | Delete

(These are Control-p, Control-n on OS X)

[241] Fix | Delete

Return while cursor is on a previous command retrieves that command.

[242] Fix | Delete

Expand word is also useful to reduce typing.

[243] Fix | Delete

[244] Fix | Delete

Syntax colors:

[245] Fix | Delete

[246] Fix | Delete

The coloring is applied in a background "thread", so you may

[247] Fix | Delete

occasionally see uncolorized text. To change the color

[248] Fix | Delete

scheme, use the Configure IDLE / Highlighting dialog.

[249] Fix | Delete

[250] Fix | Delete

Python default syntax colors:

[251] Fix | Delete

[252] Fix | Delete

Keywords orange

[253] Fix | Delete

Builtins royal purple

[254] Fix | Delete

Strings green

[255] Fix | Delete

Comments red

[256] Fix | Delete

Definitions blue

[257] Fix | Delete

[258] Fix | Delete

Shell default colors:

[259] Fix | Delete

[260] Fix | Delete

Console output brown

[261] Fix | Delete

stdout blue

[262] Fix | Delete

stderr red

[263] Fix | Delete

stdin black

[264] Fix | Delete

[265] Fix | Delete

Other preferences:

[266] Fix | Delete

[267] Fix | Delete

The font preferences, keybinding, and startup preferences can

[268] Fix | Delete

be changed using the Settings dialog.

[269] Fix | Delete

[270] Fix | Delete

Command line usage:

[271] Fix | Delete

[272] Fix | Delete

Enter idle -h at the command prompt to get a usage message.

[273] Fix | Delete

[274] Fix | Delete

Running without a subprocess:

[275] Fix | Delete

[276] Fix | Delete

If IDLE is started with the -n command line switch it will run in a

[277] Fix | Delete

single process and will not create the subprocess which runs the RPC

[278] Fix | Delete

Python execution server. This can be useful if Python cannot create

[279] Fix | Delete

the subprocess or the RPC socket interface on your platform. However,

[280] Fix | Delete

in this mode user code is not isolated from IDLE itself. Also, the

[281] Fix | Delete

environment is not restarted when Run/Run Module (F5) is selected. If

[282] Fix | Delete

your code has been modified, you must reload() the affected modules and

[283] Fix | Delete

re-import any specific items (e.g. from foo import baz) if the changes

[284] Fix | Delete

are to take effect. For these reasons, it is preferable to run IDLE

[285] Fix | Delete

with the default subprocess if at all possible.

[286] Fix | Delete

[287] Fix | Delete

Extensions:

[288] Fix | Delete

[289] Fix | Delete

IDLE contains an extension facility. See the beginning of

[290] Fix | Delete

config-extensions.def in the idlelib directory for further information.

[291] Fix | Delete

The default extensions are currently:

[292] Fix | Delete

[293] Fix | Delete

FormatParagraph

[294] Fix | Delete

AutoExpand

[295] Fix | Delete

ZoomHeight

[296] Fix | Delete

ScriptBinding

[297] Fix | Delete

CallTips

[298] Fix | Delete

ParenMatch

[299] Fix | Delete

AutoComplete

[300] Fix | Delete

CodeContext

[301] Fix | Delete

[302] Fix | Delete