IDLE startup file .Idle.py not documented

[MLModel]

BPO	5276
Nosy	@birkenfeld, @MLModel
Files	idlestartdoc.patch

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/birkenfeld'
closed_at = <Date 2009-03-15.21:52:01.507>
created_at = <Date 2009-02-15.23:41:56.840>
labels = ['expert-IDLE', 'docs']
title = 'IDLE startup file .Idle.py not documented'
updated_at = <Date 2009-03-15.21:52:01.506>
user = 'https://github.com/MLModel'

bugs.python.org fields:

activity = <Date 2009-03-15.21:52:01.506>
actor = 'georg.brandl'
assignee = 'georg.brandl'
closed = True
closed_date = <Date 2009-03-15.21:52:01.507>
closer = 'georg.brandl'
components = ['Documentation', 'IDLE']
creation = <Date 2009-02-15.23:41:56.840>
creator = 'MLModel'
dependencies = []
files = ['13296']
hgrepos = []
issue_num = 5276
keywords = ['patch']
message_count = 3.0
messages = ['82186', '83442', '83646']
nosy_count = 3.0
nosy_names = ['georg.brandl', 'bmiller', 'MLModel']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue5276'
versions = ['Python 2.6', 'Python 3.0', 'Python 3.1', 'Python 2.7']

[MLModel]

The following behavior should be documented but it is not:

If the user has a .Idle.py file IDLE will run it when it starts up. This
is independent of running IDLESTARTUP or PYTHONSTARTUP when the -s
switch is given. It is run by Tk.readprofile as called from Tk.__init__.
The "Idle" comes from the name passed to TK() when PyShell.py creates
its Tk root. In fact, not only is it independent, but it works
differently: any imports done in .Idle.py go into Tk's name space,
whereas IDLESTARTUP/PYTHONSTARTUP is exec'd and imports go into the
interpreter's namespace.

Note that the 'I' in '.Idle.py' is really uppercase, which will matter
on case-sensitive platforms.

[bmiller]

Here's a simple patch that documents the different startup files. It is
missing a good use case for .Idle.py but I'd be happy to add that if
someone can give me one.

[birkenfeld]

Thanks, edited a bit and committed in r70395.