cpython/Lib/idlelib
Terry Jan Reedy e25511a566 Issue #24820: Update IDLE NEWS items. 2015-10-04 01:17:13 -04:00
..
Icons
idle_test Merge with 3.4 2015-09-20 19:57:37 -04:00
AutoComplete.py Issue #18409: Idle: add unittest for AutoComplete. Patch by Phil Webster. 2014-06-03 20:54:21 -04:00
AutoCompleteWindow.py Issue #24570: Idle: make calltip and completion boxes appear on Macs 2015-09-26 20:03:57 -04:00
AutoExpand.py merge from 3.4 2014-06-04 20:54:43 -04:00
Bindings.py Issue #3068: Add Idle extension configuration dialog to Options menu. 2014-10-22 20:15:18 -04:00
CREDITS.txt
CallTipWindow.py Issue #24570: Idle: make calltip and completion boxes appear on Macs 2015-09-26 20:03:57 -04:00
CallTips.py
ChangeLog Removed unintentional trailing spaces in text files. 2015-03-29 19:12:58 +03:00
ClassBrowser.py Issue #22629: Revise idle_test.htest, mostly docstring. Start revision of 2014-10-17 01:31:35 -04:00
CodeContext.py Issue #23880: Tkinter's getint() and getdouble() now support Tcl_Obj. 2015-05-06 14:00:04 +03:00
ColorDelegator.py Issue #22629: Revise idle_test.htest, mostly docstring. Start revision of 2014-10-17 01:31:35 -04:00
Debugger.py Delete a few unused names suggested by pyflakes. 2014-07-01 18:52:37 -04:00
Delegator.py
EditorWindow.py Issue #24972: New option is only valid in tk 8.5+. 2015-09-28 04:52:49 -04:00
FileList.py
FormatParagraph.py Issue #20577: move configuration of FormatParagraph extension to new extension 2014-12-16 03:21:26 -05:00
GrepDialog.py idlelib: remove unused names and imports (one is a duplicate import). 2015-05-14 18:10:50 -04:00
HISTORY.txt Removed unintentional trailing spaces in text files. 2015-03-29 19:12:58 +03:00
HyperParser.py Issue #21765: Add support for non-ascii identifiers to HyperParser 2014-07-16 16:33:36 +03:00
IOBinding.py Issue #25173: Replace 'master' with 'parent' in tkinter.messagebox calls. 2015-09-25 22:22:55 -04:00
IdleHistory.py Issue #18492: Allow all resources when tests are not run by regrtest.py. 2014-06-02 16:01:29 -05:00
MultiCall.py Issue #20167: revise condition to accomodate message change. 2014-10-09 23:13:36 -04:00
MultiStatusBar.py Issue #21477: Idle htest: merge and modify run and runall; add many tests. 2014-05-24 18:48:18 -04:00
NEWS.txt Issue #24820: Update IDLE NEWS items. 2015-10-04 01:17:13 -04:00
ObjectBrowser.py Issue #21477: Add htests for GrepDialog, UndoDelegator, and configDialog. 2014-05-29 01:46:26 -04:00
OutputWindow.py Issue #25173: Replace 'master' with 'parent' in tkinter.messagebox calls. 2015-09-25 22:22:55 -04:00
ParenMatch.py Issue #21694: Add unittest for ParenMatch. Patch by Saimadhav Heblikar. 2014-06-17 16:35:20 -04:00
PathBrowser.py Issue #20792: Expand idle_test.test_pathbowser. Tweak file to not copy twice. 2015-07-20 17:44:59 -04:00
Percolator.py Issue #21477: Idle htest: modify run; add more tests. 2014-05-25 18:44:05 -04:00
PyParse.py idlelib: remove unused names and imports (one is a duplicate import). 2015-05-14 18:10:50 -04:00
PyShell.py Issue #25173: Replace 'master' with 'parent' in tkinter.messagebox calls. 2015-09-25 22:22:55 -04:00
README.txt Issue #25224: README.txt is now an idlelib index for IDLE developers and 2015-10-02 23:22:59 -04:00
RemoteDebugger.py Issue #23184: idlelib, remove more unused names and imports. 2015-05-15 23:03:17 -04:00
RemoteObjectBrowser.py
ReplaceDialog.py Issue #18592: Method return signature changes made to SearchDialogBase for 2014-07-13 17:27:26 -04:00
RstripExtension.py
ScriptBinding.py Issue #25173: Replace 'master' with 'parent' in tkinter.messagebox calls. 2015-09-25 22:22:55 -04:00
ScrolledList.py Issue #24988: Idle ScrolledList context menus (used in debugger) 2015-09-26 18:50:26 -04:00
SearchDialog.py idlelib: remove unused names and imports (one is a duplicate import). 2015-05-14 18:10:50 -04:00
SearchDialogBase.py Issue #18592: Method return signature changes made to SearchDialogBase for 2014-07-13 17:27:26 -04:00
SearchEngine.py Issue #23943: Fix typos. Patch by Piotr Kasprzyk. 2015-04-14 09:30:01 +03:00
StackViewer.py Issue #24790: correct typo noticed by Eric Smith 2015-08-27 13:02:11 -04:00
TODO.txt
ToolTip.py Issue #21477: Idle htest: modify run; add more tests. 2014-05-25 18:44:05 -04:00
TreeWidget.py idlelib: remove unused names and imports (one is a duplicate import). 2015-05-14 18:10:50 -04:00
UndoDelegator.py Issue #21477: Add htests for GrepDialog, UndoDelegator, and configDialog. 2014-05-29 01:46:26 -04:00
WidgetRedirector.py Issue #22033: Reprs of most Python implemened classes now contain actual 2014-07-25 23:36:00 +03:00
WindowList.py
ZoomHeight.py Issue #17654: Ensure IDLE menus are customized properly on OS X for 2014-03-27 20:49:14 -07:00
__init__.py Issue #24861: Add docstring to idlelib.__init__ with 'private' warning. 2015-09-21 01:44:06 -04:00
__main__.py Issue #24212: Put reference in idle.__main__ to issue with explanation. 2015-05-16 18:31:15 -04:00
aboutDialog.py Issue #24199: Make idlever module self updating. Syop using it in aboutDialog. 2015-05-16 19:28:32 -04:00
config-extensions.def Issue #20577: move configuration of FormatParagraph extension to new extension 2014-12-16 03:21:26 -05:00
config-highlight.def Issue #24820: Add 'IDLE Dark' text color theme, warning, and solution. 2015-10-04 00:31:05 -04:00
config-keys.def Issue #12387: Add missing upper(lower)case versions of default Windows key 2014-06-12 01:03:08 -04:00
config-main.def Issue 24745: Switch from Courier to platform-sensitive TkFixedFont as default 2015-08-01 18:57:33 -04:00
configDialog.py Issue #24820: Add 'IDLE Dark' text color theme, warning, and solution. 2015-10-04 00:31:05 -04:00
configHandler.py Issue #24745: Prevent IDLE initialization crash with Tk 8.4; patch by Ned Deily. 2015-09-04 04:37:56 -04:00
configHelpSourceEdit.py Issue #21477: Idle htest: merge and modify run and runall; add many tests. 2014-05-24 18:48:18 -04:00
configSectionNameDialog.py Issue #18104: Add idlelib/idle_test/htest.py with a few sample tests to begin 2014-05-11 23:32:32 -04:00
dynOptionMenuWidget.py Issue #22629: Revise idle_test.htest, mostly docstring. Start revision of 2014-10-17 01:31:35 -04:00
extend.txt
help.html Issue #25224: README.txt is now an idlelib index for IDLE developers and 2015-10-02 23:22:59 -04:00
help.py Issue #25198: When using the Idle dov TOC menu, put the section title at the 2015-09-27 04:40:08 -04:00
help.txt Issue #16893: Replace help.txt with idle.html for Idle doc display. 2015-09-20 19:57:13 -04:00
idle.bat Issue #17202: Add .bat to .hgeol to force them to CRLF. 2015-04-13 11:59:54 -05:00
idle.py
idle.pyw Issue #24245: Eliminated senseless expect clauses that have no any effect in 2015-05-20 16:15:02 +03:00
idlever.py Issue #24199: Add stacklevel to deprecation warning call. 2015-09-20 02:34:03 -04:00
keybindingDialog.py Issue #21477: Idle htest: modify run; add more tests. 2014-05-25 18:44:05 -04:00
macosxSupport.py Issue #25199: Idle: add synchronization comments for future maintainers. 2015-09-20 22:55:39 -04:00
rpc.py Issue #24245: Eliminated senseless expect clauses that have no any effect in 2015-05-20 16:15:02 +03:00
run.py Issue #25173: Replace 'master' with 'parent' in tkinter.messagebox calls. 2015-09-25 22:22:55 -04:00
tabbedpages.py Issue #21477: Idle htest: merge and modify run and runall; add many tests. 2014-05-24 18:48:18 -04:00
textView.py Issue #18910: Add unittest for textView. Patch by Phil Webster. 2014-06-05 03:38:34 -04:00

README.txt

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

README.txt: an index to idlelib files and the IDLE menu.

IDLE is Pythons Integrated Development and Learning
Environment.  The user documentation is part of the Library Reference and
is available in IDLE by selecting Help => IDLE Help.  This README documents
idlelib for IDLE developers and curious users.

IDLELIB FILES lists files alphabetically by category,
with a short description of each.

IDLE MENU show the menu tree, annotated with the module
or module object that implements the corresponding function.

This file is descriptive, not prescriptive, and may have errors
and omissions and lag behind changes in idlelib.


IDLELIB FILES
Implemetation files not in IDLE MENU are marked (nim).
Deprecated files and objects are listed separately as the end.

Startup
-------
__init__.py  # import, does nothing
__main__.py  # -m, starts IDLE
idle.bat
idle.py
idle.pyw

Implementation
--------------
AutoComplete.py   # Complete attribute names or filenames.
AutoCompleteWindow.py  # Display completions.
AutoExpand.py     # Expand word with previous word in file.
Bindings.py       # Define most of IDLE menu.
CallTipWindow.py  # Display calltip.
CallTips.py       # Create calltip text.
ClassBrowser.py   # Create module browser window.
CodeContext.py    # Show compound statement headers otherwise not visible.
ColorDelegator.py # Colorize text (nim).
Debugger.py       # Debug code run from editor; show window.
Delegator.py      # Define base class for delegators (nim).
EditorWindow.py   # Define most of editor and utility functions.
FileList.py       # Open files and manage list of open windows (nim).
FormatParagraph.py# Re-wrap multiline strings and comments.
GrepDialog.py     # Find all occurrences of pattern in multiple files.
HyperParser.py    # Parse code around a given index.
IOBinding.py      # Open, read, and write files
IdleHistory.py    # Get previous or next user input in shell (nim)
MultiCall.py      # Wrap tk widget to allow multiple calls per event (nim).
MultiStatusBar.py # Define status bar for windows (nim).
ObjectBrowser.py  # Define class used in StackViewer (nim).
OutputWindow.py   # Create window for grep output.
ParenMatch.py     # Match fenceposts: (), [], and {}.
PathBrowser.py    # Create path browser window.
Percolator.py     # Manage delegator stack (nim).
PyParse.py        # Give information on code indentation
PyShell.py        # Start IDLE, manage shell, complete editor window
RemoteDebugger.py # Debug code run in remote process.
RemoteObjectBrowser.py # Communicate objects between processes with rpc (nim).
ReplaceDialog.py  # Search and replace pattern in text.
RstripExtension.py# Strip trailing whitespace
ScriptBinding.py  # Check and run user code.
ScrolledList.py   # Define ScrolledList widget for IDLE (nim).
SearchDialog.py   # Search for pattern in text.
SearchDialogBase.py  # Define base for search, replace, and grep dialogs.
SearchEngine.py   # Define engine for all 3 search dialogs.
StackViewer.py    # View stack after exception.
TreeWidget.py     # Define tree widger, used in browsers (nim).
UndoDelegator.py  # Manage undo stack.
WidgetRedirector.py # Intercept widget subcommands (for percolator) (nim).
WindowList.py     # Manage window list and define listed top level.
ZoomHeight.py     # Zoom window to full height of screen.
aboutDialog.py    # Display About IDLE dialog.
configDialog.py   # Display user configuration dialogs.
configHandler.py  # Load, fetch, and save configuration (nim).
configHelpSourceEdit.py  # Specify help source.
configSectionNameDialog.py  # Spefify user config section name
dynOptionMenuWidget.py  # define mutable OptionMenu widget (nim).
help.py           # Display IDLE's html doc.
keybindingDialog.py  # Change keybindings.
macosxSupport.py  # Help IDLE run on Macs (nim).
rpc.py            # Commuicate between idle and user processes (nim).
run.py            # Manage user code execution subprocess.
tabbedpages.py    # Define tabbed pages widget (nim).
textView.py       # Define read-only text widget (nim).

Configuration
-------------
config-extensions.def # Defaults for extensions
config-highlight.def  # Defaults for colorizing
config-keys.def       # Defaults for key bindings
config-main.def       # Defai;ts fpr font and geneal

Text
----
CREDITS.txt  # not maintained, displayed by About IDLE
HISTORY.txt  # NEWS up to July 2001
NEWS.txt     # commits, displayed by About IDLE
README.txt   # this file, displeyed by About IDLE
TODO.txt     # needs review
extend.txt   # about writing extensions
help.html    # copy of idle.html in docs, displayed by IDLE Help

Subdirectories
--------------
Icons  # small image files
idle_test  # files for human test and automated unit tests

Unused and Deprecated files and objects (nim)
---------------------------------------------
EditorWindow.py: Helpdialog and helpDialog
ToolTip.py: unused.
help.txt
idlever.py


IDLE MENUS
Top level items and most submenu items are defined in Bindings.
Extenstions add submenu items when active.  The names given are
found, quoted, in one of these modules, paired with a '<<pseudoevent>>'.
Each pseudoevent is bound to an event handler.  Some event handlers
call another function that does the actual work.  The annotations below
are intended to at least give the module where the actual work is done.

File  # IOBindig except as noted
  New File
  Open...  # IOBinding.open
  Open Module
  Recent Files
  Class Browser  # Class Browser
  Path Browser  # Path Browser
  ---
  Save  # IDBinding.save
  Save As...  # IOBinding.save_as
  Save Copy As...  # IOBindling.save_a_copy
  ---
  Print Window  # IOBinding.print_window
  ---
  Close
  Exit

Edit
  Undo  # undoDelegator
  Redo  # undoDelegator
  ---
  Cut
  Copy
  Paste
  Select All
  ---  # Next 5 items use SearchEngine; dialogs use SearchDialogBase
  Find  # Search Dialog
  Find Again
  Find Selection
  Find in Files...  # GrepDialog
  Replace...  # ReplaceDialog
  Go to Line
  Show Completions  # AutoComplete extension and AutoCompleteWidow (&HP)
  Expand Word  # AutoExpand extension
  Show call tip  # Calltips extension and CalltipWindow (& Hyperparser)
  Show surrounding parens  # ParenMatch (& Hyperparser)

Shell  # PyShell
  View Last Restart  # PyShell.?
  Restart Shell  # PyShell.?

Debug (Shell only)
  Go to File/Line
  Debugger  # Debugger, RemoteDebugger
  Stack Viewer  # StackViewer
  Auto-open Stack Viewer  # StackViewer

Format (Editor only)
  Indent Region
  Dedent Region
  Comment Out Region
  Uncomment Region
  Tabify Region
  Untabify Region
  Toggle Tabs
  New Indent Width
  Format Paragraph  # FormatParagraph extension
  ---
  Strip tailing whitespace  # RstripExtension extension

Run (Editor only)
  Python Shell  # PyShell
  ---
  Check Module  # ScriptBinding
  Run Module  # ScriptBinding

Options
  Configure IDLE  # configDialog
    (tabs in the dialog)
    Font tab  # onfig-main.def
    Highlight tab  # configSectionNameDialog, config-highlight.def
    Keys tab  # keybindingDialog, configSectionNameDialog, onfig-keus.def
    General tab  # configHelpSourceEdit, config-main.def
  Configure Extensions  # configDialog
    Xyz tab  # xyz.py, config-extensions.def
  ---
  Code Context (editor only)  # CodeContext extension

Window
  Zoomheight  # ZoomHeight extension
  ---
  <open windows>  # WindowList

Help
  About IDLE  # aboutDialog
  ---
  IDLE Help  # help
  Python Doc
  Turtle Demo
  ---
  <other help sources>

<Context Menu> (right click)
Defined in EditorWindow, PyShell, Output
   Cut
   Copy
   Paste
   ---
   Go to file/line (shell and output only)
   Set Breakpoint (editor only)
   Clear Breakpoint (editor only)
 Defined in Debugger
   Go to source line
   Show stack frame