Idle: Print filename when running a file from editor

[terryjreedy]

BPO	21192
Nosy	@rhettinger, @terryjreedy, @larryhastings, @benjaminp
Files	PyShell.py @restart.diff: one line change

^{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/terryjreedy'
closed_at = <Date 2015-09-04.08:22:53.678>
created_at = <Date 2014-04-09.21:24:46.177>
labels = ['expert-IDLE', 'type-feature']
title = 'Idle: Print filename when running a file from editor'
updated_at = <Date 2015-09-04.08:22:53.677>
user = 'https://github.com/terryjreedy'

bugs.python.org fields:

activity = <Date 2015-09-04.08:22:53.677>
actor = 'terry.reedy'
assignee = 'terry.reedy'
closed = True
closed_date = <Date 2015-09-04.08:22:53.678>
closer = 'terry.reedy'
components = ['IDLE']
creation = <Date 2014-04-09.21:24:46.177>
creator = 'terry.reedy'
dependencies = []
files = ['34783', '40278']
hgrepos = []
issue_num = 21192
keywords = ['patch']
message_count = 25.0
messages = ['215846', '215888', '216277', '216497', '216525', '247795', '247796', '247825', '248864', '248876', '249263', '249590', '249592', '249619', '249686', '249692', '249704', '249705', '249714', '249733', '249734', '249736', '249737', '249739', '249740']
nosy_count = 6.0
nosy_names = ['rhettinger', 'terry.reedy', 'larry', 'benjamin.peterson', 'python-dev', 'Adnan.Umer']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue21192'
versions = ['Python 2.7', 'Python 3.4', 'Python 3.5', 'Python 3.6']

[terryjreedy]

Upon restarting the user process, Idle prints a separator bar in the shell:
====================================== RESTART=====================....
When restart is due to running a file with F5, print "RUN filename" instead of "RESTART". Idea from Adnan Umer, pydev list. For Shell / Restart Shell Cntl+F6, maybe change to "RESTART Shell" (my additional idea).

[AdnanUmer]

Method: runcode
Class: ModifiedInterpreter
Line: 752

Added
if code.co_filename[0] != '<':
self.tkconsole.write('Executing ' + code.co_filename + '\n')

To print file path that is executed

[terryjreedy]

I have not tried your patch yet, but the relevant code seems to be

class ModifiedInterpreter(InteractiveInterpreter):
    def runcode(self, code):
        if code.co_filename[0] != '<': ## your patch
            self.tkconsole.write('Executing ' + code.co_filename + '\n')
        if self.tkconsole.executing:
            self.interp.restart_subprocess()

     def restart_subprocess(self, with_cwd=False):
        if was_executing:
            console.write('\n')
            console.showprompt()
        halfbar = ((int(console.width) - 16) // 2) * '='
        console.write(halfbar + ' RESTART ' + halfbar)

The 2 problems I see with the patch are that 1) it prints prematurely and 2) it does not replace RESTART. Both should be solved by passing the title string to restart_process as a new 'title' arg (title=' RESTART ').

The halfbar expression should use len(title). I believe 16 is 9 (len(' RESTART ')) + 4 (len('>>> ')) + 3 (console.width (80) - 77). So
        halfbar = ((int(console.width) - len(title) - 7) // 2) * '='

I think the bar would be better without a prompt before it. If console.showprompt() is deleted, 7 becomes 3.
I will code this later.

[AdnanUmer]

I tried to replace RESTART by doing these little changing

# PyShell.Py
class ModifiedInterpreter(InteractiveInterpreter):
    def restart_subprocess(self, with_cwd=False, with_msg=True):
        ...
        if with_msg:
            halfbar = ((int(console.width) - 16) // 2) * '='
            console.write(halfbar + ' RESTART ' + halfbar)

    def runcode(self, code):
        with_msg = True
        if code.co_filename[0] != '<':
            self.tkconsole.write('Executing ' + code.co_filename + '\n')
            with_msg = False
        
        if self.tkconsole.executing:
            self.interp.restart_subprocess(with_msg)

# ScriptBinding.Py
class ScriptBinding:
    def _run_module_event(self, event):
        filename = self.getfilename()
        if not filename:
            return 'break'
        code = self.checksyntax(filename)
        if not code:
            return 'break'
        if not self.tabnanny(filename):
            return 'break'
        interp = self.shell.interp
        if PyShell.use_subprocess:
            interp.restart_subprocess(with_cwd=False, with_msg=False)

This works fine and replaces RESTART with Execute <filename> when file is executed in Python Shell.

Also instead of this

halfbar = ((int(console.width) - 16) // 2) * '='
console.write(halfbar + ' RESTART ' + halfbar)

my recomemdation is:
console.write('[SHELL RESTART]')

[terryjreedy]

I took another look and tried the patch and discovered that my comments are partly wrong because restart_shell is called before runcode when runcode is use to run a file. (I am not sure how it is called otherwise with self.tkconsole.executing == True.) This happens in ScriptBinding.ScriptBinding._run_module_event and that is where filename could be added to the restart_shell call.

The rest of my comment was about not printing fake prompts that the user can never respond to. In particular, Run F5 is like python -i, and for that the console interpreter does not print a prompt until it is done running the script and ready for user input.

C:\Programs\Python34>python -i tem.py
start
stop

>>

[python-dev]

New changeset 20a8e5dccf66 by Terry Jan Reedy in branch '2.7':
Issue bpo-21192: Idle Editor. When a file is run, put its name in the restart bar.
https://hg.python.org/cpython/rev/20a8e5dccf66

New changeset 2ae12789dcb8 by Terry Jan Reedy in branch '3.4':
Issue bpo-21192: Idle Editor. When a file is run, put its name in the restart bar.
https://hg.python.org/cpython/rev/2ae12789dcb8

[terryjreedy]

This is how restarts look now. Thanks for the initial idea and patch.

>>
====================== RUN C:\Programs\Python34\tem.py =================

xxxx
>>> 
=============================== RESTART Shell 

=========================

>>

[python-dev]

New changeset edf9bfe36ad0 by Terry Jan Reedy in branch '2.7':
Issue bpo-21192: acks for 2.7
https://hg.python.org/cpython/rev/edf9bfe36ad0

[rhettinger]

I've found this to be a serious usability regression and think it should be reverted right-away. It makes IDLE unsuitable for evening showing turtle demos to kids. For adults in my classes, it was also confusing because unlike the old restart-bar it fails to make a clean distinction between sessions and making it clear that old variable definitions have be forgotten. The issue is even more acute because cmd-p can cycle through statements in previous sessions.

[terryjreedy]

How about 'RESTART: Shell' and 'RESTART: <name of file>' to make it clear that old definitions are forgotten in both cases while new definitions are added in the second case.

I do not understand the comment about turtledemo as it runs separately from Idle.