pyshell.py 55 KB
Newer Older
1
#! /usr/bin/env python3
David Scherer's avatar
David Scherer committed
2

3 4
import sys

5 6 7 8 9
try:
    from tkinter import *
except ImportError:
    print("** IDLE can't import Tkinter.\n"
          "Your Python may not be configured for Tk. **", file=sys.__stderr__)
10
    raise SystemExit(1)
11 12 13 14
import tkinter.messagebox as tkMessageBox
if TkVersion < 8.5:
    root = Tk()  # otherwise create root in main
    root.withdraw()
15 16
    from idlelib.run import fix_scaling
    fix_scaling(root)
17
    tkMessageBox.showerror("Idle Cannot Start",
18
            "Idle requires tcl/tk 8.5+, not %s." % TkVersion,
19
            parent=root)
20
    raise SystemExit(1)
21

22 23
from code import InteractiveInterpreter
import linecache
David Scherer's avatar
David Scherer committed
24
import os
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
25
import os.path
26
from platform import python_version
David Scherer's avatar
David Scherer committed
27
import re
Chui Tey's avatar
Chui Tey committed
28
import socket
29
import subprocess
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
30
import threading
31 32
import time
import tokenize
33
import warnings
David Scherer's avatar
David Scherer committed
34

35 36 37 38
from idlelib.colorizer import ColorDelegator
from idlelib.config import idleConf
from idlelib import debugger
from idlelib import debugger_r
39 40 41 42 43 44
from idlelib.editor import EditorWindow, fixwordbreaks
from idlelib.filelist import FileList
from idlelib.outwin import OutputWindow
from idlelib import rpc
from idlelib.run import idle_formatwarning, PseudoInputFile, PseudoOutputFile
from idlelib.undo import UndoDelegator
Chui Tey's avatar
Chui Tey committed
45

46 47
HOST = '127.0.0.1' # python execution server on localhost loopback
PORT = 0  # someday pass in host, port for remote debug capability
48

49 50 51 52
# Override warnings module to write to warning_stream.  Initialize to send IDLE
# internal warnings to the console.  ScriptBinding.check_syntax() will
# temporarily redirect the stream to the shell window to display warnings when
# checking user's code.
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
warning_stream = sys.__stderr__  # None, at least on Windows, if no console.

def idle_showwarning(
        message, category, filename, lineno, file=None, line=None):
    """Show Idle-format warning (after replacing warnings.showwarning).

    The differences are the formatter called, the file=None replacement,
    which can be None, the capture of the consequence AttributeError,
    and the output of a hard-coded prompt.
    """
    if file is None:
        file = warning_stream
    try:
        file.write(idle_formatwarning(
                message, category, filename, lineno, line=line))
        file.write(">>> ")
    except (AttributeError, OSError):
        pass  # if file (probably __stderr__) is invalid, skip warning.

_warnings_showwarning = None

def capture_warnings(capture):
    "Replace warning.showwarning with idle_showwarning, or reverse."

    global _warnings_showwarning
    if capture:
        if _warnings_showwarning is None:
            _warnings_showwarning = warnings.showwarning
            warnings.showwarning = idle_showwarning
    else:
        if _warnings_showwarning is not None:
            warnings.showwarning = _warnings_showwarning
            _warnings_showwarning = None

capture_warnings(True)
Chui Tey's avatar
Chui Tey committed
88

89 90
def extended_linecache_checkcache(filename=None,
                                  orig_checkcache=linecache.checkcache):
91 92
    """Extend linecache.checkcache to preserve the <pyshell#...> entries

93 94
    Rather than repeating the linecache code, patch it to save the
    <pyshell#...> entries, call the original linecache.checkcache()
95
    (skipping them), and then restore the saved entries.
96 97 98

    orig_checkcache is bound at definition time to the original
    method, allowing it to be patched.
99
    """
David Scherer's avatar
David Scherer committed
100 101
    cache = linecache.cache
    save = {}
102 103 104 105
    for key in list(cache):
        if key[:1] + key[-1:] == '<>':
            save[key] = cache.pop(key)
    orig_checkcache(filename)
David Scherer's avatar
David Scherer committed
106
    cache.update(save)
107

108 109
# Patch linecache.checkcache():
linecache.checkcache = extended_linecache_checkcache
David Scherer's avatar
David Scherer committed
110

111

David Scherer's avatar
David Scherer committed
112
class PyShellEditorWindow(EditorWindow):
113
    "Regular text edit window in IDLE, supports breakpoints"
114

David Scherer's avatar
David Scherer committed
115
    def __init__(self, *args):
116
        self.breakpoints = []
117
        EditorWindow.__init__(self, *args)
David Scherer's avatar
David Scherer committed
118
        self.text.bind("<<set-breakpoint-here>>", self.set_breakpoint_here)
119
        self.text.bind("<<clear-breakpoint-here>>", self.clear_breakpoint_here)
David Scherer's avatar
David Scherer committed
120 121
        self.text.bind("<<open-python-shell>>", self.flist.open_shell)

122 123
        self.breakpointPath = os.path.join(
                idleConf.userdir, 'breakpoints.lst')
124
        # whenever a file is changed, restore breakpoints
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
125 126
        def filename_changed_hook(old_hook=self.io.filename_change_hook,
                                  self=self):
127 128 129
            self.restore_file_breaks()
            old_hook()
        self.io.set_filename_change_hook(filename_changed_hook)
130 131
        if self.io.filename:
            self.restore_file_breaks()
132
        self.color_breakpoint_text()
133

134 135 136 137 138 139 140 141
    rmenu_specs = [
        ("Cut", "<<cut>>", "rmenu_check_cut"),
        ("Copy", "<<copy>>", "rmenu_check_copy"),
        ("Paste", "<<paste>>", "rmenu_check_paste"),
        (None, None, None),
        ("Set Breakpoint", "<<set-breakpoint-here>>", None),
        ("Clear Breakpoint", "<<clear-breakpoint-here>>", None)
    ]
David Scherer's avatar
David Scherer committed
142

143 144
    def color_breakpoint_text(self, color=True):
        "Turn colorizing of breakpoint text on or off"
145 146 147
        if self.io is None:
            # possible due to update in restore_file_breaks
            return
148
        if color:
149
            theme = idleConf.CurrentTheme()
150 151 152 153 154
            cfg = idleConf.GetHighlight(theme, "break")
        else:
            cfg = {'foreground': '', 'background': ''}
        self.text.tag_config('BREAK', cfg)

155
    def set_breakpoint(self, lineno):
156 157
        text = self.text
        filename = self.io.filename
158
        text.tag_add("BREAK", "%d.0" % lineno, "%d.0" % (lineno+1))
159
        try:
160
            self.breakpoints.index(lineno)
161
        except ValueError:  # only add if missing, i.e. do once
162 163 164 165 166 167
            self.breakpoints.append(lineno)
        try:    # update the subprocess debugger
            debug = self.flist.pyshell.interp.debugger
            debug.set_breakpoint_here(filename, lineno)
        except: # but debugger may not be active right now....
            pass
David Scherer's avatar
David Scherer committed
168

169 170 171 172 173 174 175 176 177
    def set_breakpoint_here(self, event=None):
        text = self.text
        filename = self.io.filename
        if not filename:
            text.bell()
            return
        lineno = int(float(text.index("insert")))
        self.set_breakpoint(lineno)

178
    def clear_breakpoint_here(self, event=None):
179 180 181 182
        text = self.text
        filename = self.io.filename
        if not filename:
            text.bell()
183
            return
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
        lineno = int(float(text.index("insert")))
        try:
            self.breakpoints.remove(lineno)
        except:
            pass
        text.tag_remove("BREAK", "insert linestart",\
                        "insert lineend +1char")
        try:
            debug = self.flist.pyshell.interp.debugger
            debug.clear_breakpoint_here(filename, lineno)
        except:
            pass

    def clear_file_breaks(self):
        if self.breakpoints:
            text = self.text
            filename = self.io.filename
            if not filename:
                text.bell()
                return
            self.breakpoints = []
            text.tag_remove("BREAK", "1.0", END)
            try:
                debug = self.flist.pyshell.interp.debugger
                debug.clear_file_breaks(filename)
            except:
                pass

212
    def store_file_breaks(self):
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
213 214 215 216 217 218
        "Save breakpoints when file is saved"
        # XXX 13 Dec 2002 KBK Currently the file must be saved before it can
        #     be run.  The breaks are saved at that time.  If we introduce
        #     a temporary file save feature the save breaks functionality
        #     needs to be re-verified, since the breaks at the time the
        #     temp file is created may differ from the breaks at the last
219 220 221 222
        #     permanent save of the file.  Currently, a break introduced
        #     after a save will be effective, but not persistent.
        #     This is necessary to keep the saved breaks synched with the
        #     saved file.
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
223
        #
224 225
        #     Breakpoints are set as tagged ranges in the text.
        #     Since a modified file has to be saved before it is
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
226 227 228 229 230 231
        #     run, and since self.breakpoints (from which the subprocess
        #     debugger is loaded) is updated during the save, the visible
        #     breaks stay synched with the subprocess even if one of these
        #     unexpected breakpoint deletions occurs.
        breaks = self.breakpoints
        filename = self.io.filename
232
        try:
233 234
            with open(self.breakpointPath, "r") as fp:
                lines = fp.readlines()
235
        except OSError:
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
236
            lines = []
237 238 239 240 241 242 243 244 245
        try:
            with open(self.breakpointPath, "w") as new_file:
                for line in lines:
                    if not line.startswith(filename + '='):
                        new_file.write(line)
                self.update_breakpoints()
                breaks = self.breakpoints
                if breaks:
                    new_file.write(filename + '=' + str(breaks) + '\n')
246
        except OSError as err:
247 248 249 250 251 252
            if not getattr(self.root, "breakpoint_error_displayed", False):
                self.root.breakpoint_error_displayed = True
                tkMessageBox.showerror(title='IDLE Error',
                    message='Unable to update breakpoint list:\n%s'
                        % str(err),
                    parent=self.text)
253 254 255

    def restore_file_breaks(self):
        self.text.update()   # this enables setting "BREAK" tags to be visible
256 257 258
        if self.io is None:
            # can happen if IDLE closes due to the .update() call
            return
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
259 260 261
        filename = self.io.filename
        if filename is None:
            return
262
        if os.path.isfile(self.breakpointPath):
263 264
            with open(self.breakpointPath, "r") as fp:
                lines = fp.readlines()
265
            for line in lines:
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
266
                if line.startswith(filename + '='):
267
                    breakpoint_linenumbers = eval(line[len(filename)+1:])
268 269
                    for breakpoint_linenumber in breakpoint_linenumbers:
                        self.set_breakpoint(breakpoint_linenumber)
270

Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
271 272
    def update_breakpoints(self):
        "Retrieves all the breakpoints in the current window"
273
        text = self.text
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
274 275 276 277 278 279 280
        ranges = text.tag_ranges("BREAK")
        linenumber_list = self.ranges_to_linenumbers(ranges)
        self.breakpoints = linenumber_list

    def ranges_to_linenumbers(self, ranges):
        lines = []
        for index in range(0, len(ranges), 2):
281 282
            lineno = int(float(ranges[index].string))
            end = int(float(ranges[index+1].string))
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
283 284 285 286 287
            while lineno < end:
                lines.append(lineno)
                lineno += 1
        return lines

288
# XXX 13 Dec 2002 KBK Not used currently
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
289 290 291 292 293
#    def saved_change_hook(self):
#        "Extend base method - clear breaks if module is modified"
#        if not self.get_saved():
#            self.clear_file_breaks()
#        EditorWindow.saved_change_hook(self)
294 295 296 297 298

    def _close(self):
        "Extend base method - clear breaks when module is closed"
        self.clear_file_breaks()
        EditorWindow._close(self)
299

David Scherer's avatar
David Scherer committed
300 301

class PyShellFileList(FileList):
302
    "Extend base class: IDLE supports a shell and breakpoints"
David Scherer's avatar
David Scherer committed
303

304 305
    # override FileList's class variable, instances return PyShellEditorWindow
    # instead of EditorWindow when new edit windows are created.
David Scherer's avatar
David Scherer committed
306 307 308 309 310 311
    EditorWindow = PyShellEditorWindow

    pyshell = None

    def open_shell(self, event=None):
        if self.pyshell:
312
            self.pyshell.top.wakeup()
David Scherer's avatar
David Scherer committed
313 314
        else:
            self.pyshell = PyShell(self)
315 316 317
            if self.pyshell:
                if not self.pyshell.begin():
                    return None
David Scherer's avatar
David Scherer committed
318 319 320 321
        return self.pyshell


class ModifiedColorDelegator(ColorDelegator):
322
    "Extend base class: colorizer for the shell window itself"
323

324 325 326
    def __init__(self):
        ColorDelegator.__init__(self)
        self.LoadTagDefs()
David Scherer's avatar
David Scherer committed
327 328 329 330 331

    def recolorize_main(self):
        self.tag_remove("TODO", "1.0", "iomark")
        self.tag_add("SYNC", "1.0", "iomark")
        ColorDelegator.recolorize_main(self)
332

333 334
    def LoadTagDefs(self):
        ColorDelegator.LoadTagDefs(self)
335
        theme = idleConf.CurrentTheme()
336 337 338 339 340 341
        self.tagdefs.update({
            "stdin": {'background':None,'foreground':None},
            "stdout": idleConf.GetHighlight(theme, "stdout"),
            "stderr": idleConf.GetHighlight(theme, "stderr"),
            "console": idleConf.GetHighlight(theme, "console"),
        })
David Scherer's avatar
David Scherer committed
342

343 344 345 346 347
    def removecolors(self):
        # Don't remove shell color tags before "iomark"
        for tag in self.tagdefs:
            self.tag_remove(tag, "iomark", "end")

David Scherer's avatar
David Scherer committed
348
class ModifiedUndoDelegator(UndoDelegator):
349
    "Extend base class: forbid insert/delete before the I/O mark"
David Scherer's avatar
David Scherer committed
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368

    def insert(self, index, chars, tags=None):
        try:
            if self.delegate.compare(index, "<", "iomark"):
                self.delegate.bell()
                return
        except TclError:
            pass
        UndoDelegator.insert(self, index, chars, tags)

    def delete(self, index1, index2=None):
        try:
            if self.delegate.compare(index1, "<", "iomark"):
                self.delegate.bell()
                return
        except TclError:
            pass
        UndoDelegator.delete(self, index1, index2)

Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
369 370 371 372 373 374 375

class MyRPCClient(rpc.RPCClient):

    def handle_EOF(self):
        "Override the base class - just re-raise EOFError"
        raise EOFError

376

David Scherer's avatar
David Scherer committed
377 378 379 380 381 382
class ModifiedInterpreter(InteractiveInterpreter):

    def __init__(self, tkconsole):
        self.tkconsole = tkconsole
        locals = sys.modules['__main__'].__dict__
        InteractiveInterpreter.__init__(self, locals=locals)
383
        self.save_warnings_filters = None
384
        self.restarting = False
385 386
        self.subprocess_arglist = None
        self.port = PORT
387
        self.original_compiler_flags = self.compile.compiler.flags
David Scherer's avatar
David Scherer committed
388

389
    _afterid = None
Chui Tey's avatar
Chui Tey committed
390
    rpcclt = None
391
    rpcsubproc = None
Chui Tey's avatar
Chui Tey committed
392

393
    def spawn_subprocess(self):
394
        if self.subprocess_arglist is None:
395
            self.subprocess_arglist = self.build_subprocess_arglist()
396
        self.rpcsubproc = subprocess.Popen(self.subprocess_arglist)
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
397

398
    def build_subprocess_arglist(self):
399 400
        assert (self.port!=0), (
            "Socket should have been assigned a port number.")
401 402 403 404
        w = ['-W' + s for s in sys.warnoptions]
        # Maybe IDLE is installed and is being accessed via sys.path,
        # or maybe it's not installed and the idle.py script is being
        # run from the IDLE source directory.
405 406
        del_exitf = idleConf.GetOption('main', 'General', 'delete-exitfunc',
                                       default=False, type='bool')
407
        if __name__ == 'idlelib.pyshell':
408
            command = "__import__('idlelib.run').run.main(%r)" % (del_exitf,)
409
        else:
410
            command = "__import__('run').main(%r)" % (del_exitf,)
411
        return [sys.executable] + w + ["-c", command, str(self.port)]
412

Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
413
    def start_subprocess(self):
414 415
        addr = (HOST, self.port)
        # GUI makes several attempts to acquire socket, listens for connection
416
        for i in range(3):
Chui Tey's avatar
Chui Tey committed
417 418
            time.sleep(i)
            try:
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
419
                self.rpcclt = MyRPCClient(addr)
Chui Tey's avatar
Chui Tey committed
420
                break
421
            except OSError:
422
                pass
Chui Tey's avatar
Chui Tey committed
423
        else:
424 425
            self.display_port_binding_error()
            return None
426 427 428 429 430 431 432 433 434 435 436 437
        # if PORT was 0, system will assign an 'ephemeral' port. Find it out:
        self.port = self.rpcclt.listening_sock.getsockname()[1]
        # if PORT was not 0, probably working with a remote execution server
        if PORT != 0:
            # To allow reconnection within the 2MSL wait (cf. Stevens TCP
            # V1, 18.6),  set SO_REUSEADDR.  Note that this can be problematic
            # on Windows since the implementation allows two active sockets on
            # the same address!
            self.rpcclt.listening_sock.setsockopt(socket.SOL_SOCKET,
                                           socket.SO_REUSEADDR, 1)
        self.spawn_subprocess()
        #time.sleep(20) # test to simulate GUI not accepting connection
438
        # Accept the connection from the Python execution server
439 440 441
        self.rpcclt.listening_sock.settimeout(10)
        try:
            self.rpcclt.accept()
442
        except socket.timeout:
443 444
            self.display_no_subprocess_error()
            return None
445 446
        self.rpcclt.register("console", self.tkconsole)
        self.rpcclt.register("stdin", self.tkconsole.stdin)
447 448
        self.rpcclt.register("stdout", self.tkconsole.stdout)
        self.rpcclt.register("stderr", self.tkconsole.stderr)
Chui Tey's avatar
Chui Tey committed
449
        self.rpcclt.register("flist", self.tkconsole.flist)
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
450
        self.rpcclt.register("linecache", linecache)
451
        self.rpcclt.register("interp", self)
452
        self.transfer_path(with_cwd=True)
Chui Tey's avatar
Chui Tey committed
453
        self.poll_subprocess()
454
        return self.rpcclt
Chui Tey's avatar
Chui Tey committed
455

456
    def restart_subprocess(self, with_cwd=False, filename=''):
457
        if self.restarting:
458
            return self.rpcclt
459
        self.restarting = True
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
460
        # close only the subprocess debugger
461 462
        debug = self.getdebugger()
        if debug:
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
463
            try:
464
                # Only close subprocess debugger, don't unregister gui_adap!
465
                debugger_r.close_subprocess_debugger(self.rpcclt)
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
466 467 468
            except:
                pass
        # Kill subprocess, spawn a new one, accept connection.
469
        self.rpcclt.close()
470
        self.terminate_subprocess()
471
        console = self.tkconsole
472
        was_executing = console.executing
473
        console.executing = False
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
474
        self.spawn_subprocess()
475 476
        try:
            self.rpcclt.accept()
477
        except socket.timeout:
478 479
            self.display_no_subprocess_error()
            return None
480
        self.transfer_path(with_cwd=with_cwd)
481
        console.stop_readline()
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
482
        # annotate restart in shell window and mark it
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
483
        console.text.delete("iomark", "end-1c")
484
        tag = 'RESTART: ' + (filename if filename else 'Shell')
485 486
        halfbar = ((int(console.width) -len(tag) - 4) // 2) * '='
        console.write("\n{0} {1} {0}".format(halfbar, tag))
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
487 488
        console.text.mark_set("restart", "end-1c")
        console.text.mark_gravity("restart", "left")
489 490
        if not filename:
            console.showprompt()
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
491
        # restart subprocess debugger
492
        if debug:
493
            # Restarted debugger connects to current instance of debug GUI
494
            debugger_r.restart_subprocess_debugger(self.rpcclt)
495 496
            # reload remote debugger breakpoints for all PyShellEditWindows
            debug.load_breakpoints()
497
        self.compile.compiler.flags = self.original_compiler_flags
498
        self.restarting = False
499
        return self.rpcclt
500

Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
501
    def __request_interrupt(self):
502
        self.rpcclt.remotecall("exec", "interrupt_the_server", (), {})
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
503 504

    def interrupt_subprocess(self):
505
        threading.Thread(target=self.__request_interrupt).start()
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
506

507
    def kill_subprocess(self):
508 509
        if self._afterid is not None:
            self.tkconsole.text.after_cancel(self._afterid)
510 511 512 513
        try:
            self.rpcclt.listening_sock.close()
        except AttributeError:  # no socket
            pass
514 515 516 517
        try:
            self.rpcclt.close()
        except AttributeError:  # no socket
            pass
518
        self.terminate_subprocess()
519 520
        self.tkconsole.executing = False
        self.rpcclt = None
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
521

522 523 524 525 526 527 528 529
    def terminate_subprocess(self):
        "Make sure subprocess is terminated"
        try:
            self.rpcsubproc.kill()
        except OSError:
            # process already terminated
            return
        else:
530
            try:
531
                self.rpcsubproc.wait()
532 533
            except OSError:
                return
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
534

535 536 537 538 539 540
    def transfer_path(self, with_cwd=False):
        if with_cwd:        # Issue 13506
            path = ['']     # include Current Working Directory
            path.extend(sys.path)
        else:
            path = sys.path
Terry Jan Reedy's avatar
Terry Jan Reedy committed
541

542 543
        self.runcommand("""if 1:
        import sys as _sys
544
        _sys.path = %r
545
        del _sys
546
        \n""" % (path,))
547

Chui Tey's avatar
Chui Tey committed
548 549 550 551 552 553
    active_seq = None

    def poll_subprocess(self):
        clt = self.rpcclt
        if clt is None:
            return
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
554
        try:
555
            response = clt.pollresponse(self.active_seq, wait=0.05)
556
        except (EOFError, OSError, KeyboardInterrupt):
557 558
            # lost connection or subprocess terminated itself, restart
            # [the KBI is from rpc.SocketIO.handle_EOF()]
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
559 560
            if self.tkconsole.closing:
                return
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
561 562
            response = None
            self.restart_subprocess()
Chui Tey's avatar
Chui Tey committed
563 564 565 566
        if response:
            self.tkconsole.resetoutput()
            self.active_seq = None
            how, what = response
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
567
            console = self.tkconsole.console
Chui Tey's avatar
Chui Tey committed
568 569
            if how == "OK":
                if what is not None:
570
                    print(repr(what), file=console)
Chui Tey's avatar
Chui Tey committed
571 572 573 574
            elif how == "EXCEPTION":
                if self.tkconsole.getvar("<<toggle-jit-stack-viewer>>"):
                    self.remote_stack_viewer()
            elif how == "ERROR":
575
                errmsg = "pyshell.ModifiedInterpreter: Subprocess ERROR:\n"
576 577
                print(errmsg, what, file=sys.__stderr__)
                print(errmsg, what, file=console)
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
578
            # we received a response to the currently active seq number:
579 580 581 582
            try:
                self.tkconsole.endexecuting()
            except AttributeError:  # shell may have closed
                pass
583 584
        # Reschedule myself
        if not self.tkconsole.closing:
585 586
            self._afterid = self.tkconsole.text.after(
                self.tkconsole.pollinterval, self.poll_subprocess)
Chui Tey's avatar
Chui Tey committed
587

588 589 590 591 592 593 594 595
    debugger = None

    def setdebugger(self, debugger):
        self.debugger = debugger

    def getdebugger(self):
        return self.debugger

596 597 598 599 600 601
    def open_remote_stack_viewer(self):
        """Initiate the remote stack viewer from a separate thread.

        This method is called from the subprocess, and by returning from this
        method we allow the subprocess to unblock.  After a bit the shell
        requests the subprocess to open the remote stack viewer which returns a
602
        static object looking at the last exception.  It is queried through
603 604 605 606 607 608
        the RPC mechanism.

        """
        self.tkconsole.text.after(300, self.remote_stack_viewer)
        return

Chui Tey's avatar
Chui Tey committed
609
    def remote_stack_viewer(self):
610
        from idlelib import debugobj_r
611
        oid = self.rpcclt.remotequeue("exec", "stackviewer", ("flist",), {})
Chui Tey's avatar
Chui Tey committed
612 613 614
        if oid is None:
            self.tkconsole.root.bell()
            return
615 616
        item = debugobj_r.StubObjectTreeItem(self.rpcclt, oid)
        from idlelib.tree import ScrolledCanvas, TreeNode
Chui Tey's avatar
Chui Tey committed
617
        top = Toplevel(self.tkconsole.root)
618
        theme = idleConf.CurrentTheme()
619 620
        background = idleConf.GetHighlight(theme, 'normal')['background']
        sc = ScrolledCanvas(top, bg=background, highlightthickness=0)
Chui Tey's avatar
Chui Tey committed
621 622 623 624 625
        sc.frame.pack(expand=1, fill="both")
        node = TreeNode(sc.canvas, None, item)
        node.expand()
        # XXX Should GC the remote tree when closing the window

David Scherer's avatar
David Scherer committed
626 627 628
    gid = 0

    def execsource(self, source):
629
        "Like runsource() but assumes complete exec source"
David Scherer's avatar
David Scherer committed
630 631 632 633
        filename = self.stuffsource(source)
        self.execfile(filename, source)

    def execfile(self, filename, source=None):
634
        "Execute an existing file"
David Scherer's avatar
David Scherer committed
635
        if source is None:
636
            with tokenize.open(filename) as fp:
637
                source = fp.read()
David Scherer's avatar
David Scherer committed
638 639 640 641
        try:
            code = compile(source, filename, "exec")
        except (OverflowError, SyntaxError):
            self.tkconsole.resetoutput()
642 643 644
            print('*** Error in script or command!\n'
                 'Traceback (most recent call last):',
                  file=self.tkconsole.stderr)
David Scherer's avatar
David Scherer committed
645
            InteractiveInterpreter.showsyntaxerror(self, filename)
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
646
            self.tkconsole.showprompt()
David Scherer's avatar
David Scherer committed
647 648 649 650
        else:
            self.runcode(code)

    def runsource(self, source):
651
        "Extend base class method: Stuff the source in the line cache first"
David Scherer's avatar
David Scherer committed
652 653
        filename = self.stuffsource(source)
        self.more = 0
654 655
        self.save_warnings_filters = warnings.filters[:]
        warnings.filterwarnings(action="error", category=SyntaxWarning)
656 657 658
        # at the moment, InteractiveInterpreter expects str
        assert isinstance(source, str)
        #if isinstance(source, str):
659
        #    from idlelib import iomenu
660
        #    try:
661
        #        source = source.encode(iomenu.encoding)
662 663 664 665
        #    except UnicodeError:
        #        self.tkconsole.resetoutput()
        #        self.write("Unsupported characters in input\n")
        #        return
666
        try:
667 668
            # InteractiveInterpreter.runsource() calls its runcode() method,
            # which is overridden (see below)
669 670 671 672 673
            return InteractiveInterpreter.runsource(self, source, filename)
        finally:
            if self.save_warnings_filters is not None:
                warnings.filters[:] = self.save_warnings_filters
                self.save_warnings_filters = None
David Scherer's avatar
David Scherer committed
674 675

    def stuffsource(self, source):
676
        "Stuff source in the filename cache"
David Scherer's avatar
David Scherer committed
677 678
        filename = "<pyshell#%d>" % self.gid
        self.gid = self.gid + 1
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
679
        lines = source.split("\n")
David Scherer's avatar
David Scherer committed
680 681
        linecache.cache[filename] = len(source)+1, 0, lines, filename
        return filename
682

683 684 685
    def prepend_syspath(self, filename):
        "Prepend sys.path with file's directory if not already included"
        self.runcommand("""if 1:
686
            _filename = %r
687 688 689 690 691 692
            import sys as _sys
            from os.path import dirname as _dirname
            _dir = _dirname(_filename)
            if not _dir in _sys.path:
                _sys.path.insert(0, _dir)
            del _filename, _sys, _dirname, _dir
693
            \n""" % (filename,))
694

David Scherer's avatar
David Scherer committed
695
    def showsyntaxerror(self, filename=None):
696
        """Override Interactive Interpreter method: Use Colorizing
697 698 699 700 701

        Color the offending position instead of printing it and pointing at it
        with a caret.

        """
702 703 704
        tkconsole = self.tkconsole
        text = tkconsole.text
        text.tag_remove("ERROR", "1.0", "end")
David Scherer's avatar
David Scherer committed
705
        type, value, tb = sys.exc_info()
706 707 708
        msg = getattr(value, 'msg', '') or value or "<no detail available>"
        lineno = getattr(value, 'lineno', '') or 1
        offset = getattr(value, 'offset', '') or 0
709 710 711 712
        if offset == 0:
            lineno += 1 #mark end of offending line
        if lineno == 1:
            pos = "iomark + %d chars" % (offset-1)
David Scherer's avatar
David Scherer committed
713
        else:
714 715 716 717 718 719
            pos = "iomark linestart + %d lines + %d chars" % \
                  (lineno-1, offset-1)
        tkconsole.colorize_syntax_error(text, pos)
        tkconsole.resetoutput()
        self.write("SyntaxError: %s\n" % msg)
        tkconsole.showprompt()
David Scherer's avatar
David Scherer committed
720 721

    def showtraceback(self):
722
        "Extend base class method to reset output properly"
David Scherer's avatar
David Scherer committed
723 724 725
        self.tkconsole.resetoutput()
        self.checklinecache()
        InteractiveInterpreter.showtraceback(self)
Chui Tey's avatar
Chui Tey committed
726 727
        if self.tkconsole.getvar("<<toggle-jit-stack-viewer>>"):
            self.tkconsole.open_stack_viewer()
David Scherer's avatar
David Scherer committed
728 729 730

    def checklinecache(self):
        c = linecache.cache
731
        for key in list(c.keys()):
David Scherer's avatar
David Scherer committed
732 733 734
            if key[:1] + key[-1:] != "<>":
                del c[key]

Chui Tey's avatar
Chui Tey committed
735
    def runcommand(self, code):
736
        "Run the code without invoking the debugger"
Chui Tey's avatar
Chui Tey committed
737 738
        # The code better not raise an exception!
        if self.tkconsole.executing:
739
            self.display_executing_dialog()
Chui Tey's avatar
Chui Tey committed
740 741
            return 0
        if self.rpcclt:
742
            self.rpcclt.remotequeue("exec", "runcode", (code,), {})
Chui Tey's avatar
Chui Tey committed
743
        else:
744
            exec(code, self.locals)
Chui Tey's avatar
Chui Tey committed
745 746
        return 1

David Scherer's avatar
David Scherer committed
747
    def runcode(self, code):
748
        "Override base class method"
Chui Tey's avatar
Chui Tey committed
749
        if self.tkconsole.executing:
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
750
            self.interp.restart_subprocess()
Chui Tey's avatar
Chui Tey committed
751
        self.checklinecache()
752 753 754
        if self.save_warnings_filters is not None:
            warnings.filters[:] = self.save_warnings_filters
            self.save_warnings_filters = None
David Scherer's avatar
David Scherer committed
755 756
        debugger = self.debugger
        try:
757
            self.tkconsole.beginexecuting()
758 759 760 761 762 763 764 765 766 767 768 769 770
            if not debugger and self.rpcclt is not None:
                self.active_seq = self.rpcclt.asyncqueue("exec", "runcode",
                                                        (code,), {})
            elif debugger:
                debugger.run(code, self.locals)
            else:
                exec(code, self.locals)
        except SystemExit:
            if not self.tkconsole.closing:
                if tkMessageBox.askyesno(
                    "Exit?",
                    "Do you want to exit altogether?",
                    default="yes",
771
                    parent=self.tkconsole.text):
772
                    raise
773
                else:
774
                    self.showtraceback()
775 776 777 778 779 780
            else:
                raise
        except:
            if use_subprocess:
                print("IDLE internal error in runcode()",
                      file=self.tkconsole.stderr)
David Scherer's avatar
David Scherer committed
781
                self.showtraceback()
782 783 784 785 786 787 788
                self.tkconsole.endexecuting()
            else:
                if self.tkconsole.canceled:
                    self.tkconsole.canceled = False
                    print("KeyboardInterrupt", file=self.tkconsole.stderr)
                else:
                    self.showtraceback()
789 790
        finally:
            if not use_subprocess:
791 792 793 794
                try:
                    self.tkconsole.endexecuting()
                except AttributeError:  # shell may have closed
                    pass
David Scherer's avatar
David Scherer committed
795 796

    def write(self, s):
797
        "Override base class method"
798
        return self.tkconsole.stderr.write(s)
David Scherer's avatar
David Scherer committed
799

800 801 802
    def display_port_binding_error(self):
        tkMessageBox.showerror(
            "Port Binding Error",
803 804 805 806 807 808
            "IDLE can't bind to a TCP/IP port, which is necessary to "
            "communicate with its Python execution server.  This might be "
            "because no networking is installed on this computer.  "
            "Run IDLE with the -n command line switch to start without a "
            "subprocess and refer to Help/IDLE Help 'Running without a "
            "subprocess' for further details.",
809
            parent=self.tkconsole.text)
810 811 812 813 814 815 816

    def display_no_subprocess_error(self):
        tkMessageBox.showerror(
            "Subprocess Startup Error",
            "IDLE's subprocess didn't make connection.  Either IDLE can't "
            "start a subprocess or personal firewall software is blocking "
            "the connection.",
817
            parent=self.tkconsole.text)
818 819 820 821 822 823

    def display_executing_dialog(self):
        tkMessageBox.showerror(
            "Already executing",
            "The Python Shell window is already executing a command; "
            "please wait until it is finished.",
824
            parent=self.tkconsole.text)
825 826


David Scherer's avatar
David Scherer committed
827 828
class PyShell(OutputWindow):

829
    shell_title = "Python " + python_version() + " Shell"
David Scherer's avatar
David Scherer committed
830 831 832 833 834

    # Override classes
    ColorDelegator = ModifiedColorDelegator
    UndoDelegator = ModifiedUndoDelegator

835
    # Override menus
836 837 838
    menu_specs = [
        ("file", "_File"),
        ("edit", "_Edit"),
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
839
        ("debug", "_Debug"),
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
840
        ("options", "_Options"),
841
        ("windows", "_Window"),
842 843
        ("help", "_Help"),
    ]
David Scherer's avatar
David Scherer committed
844

845

David Scherer's avatar
David Scherer committed
846
    # New classes
847
    from idlelib.history import History
David Scherer's avatar
David Scherer committed
848 849

    def __init__(self, flist=None):
850
        if use_subprocess:
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
851 852
            ms = self.menu_specs
            if ms[2][0] != "shell":
853
                ms.insert(2, ("shell", "She_ll"))
David Scherer's avatar
David Scherer committed
854 855 856 857 858 859
        self.interp = ModifiedInterpreter(self)
        if flist is None:
            root = Tk()
            fixwordbreaks(root)
            root.withdraw()
            flist = PyShellFileList(root)
860
        #
David Scherer's avatar
David Scherer committed
861
        OutputWindow.__init__(self, flist, None, None)
862
        #
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
863 864 865 866 867
##        self.config(usetabs=1, indentwidth=8, context_use_ps1=1)
        self.usetabs = True
        # indentwidth must be 8 when using tabs.  See note in EditorWindow:
        self.indentwidth = 8
        self.context_use_ps1 = True
868
        #
David Scherer's avatar
David Scherer committed
869 870 871 872 873 874 875
        text = self.text
        text.configure(wrap="char")
        text.bind("<<newline-and-indent>>", self.enter_callback)
        text.bind("<<plain-newline-and-indent>>", self.linefeed_callback)
        text.bind("<<interrupt-execution>>", self.cancel_callback)
        text.bind("<<end-of-file>>", self.eof_callback)
        text.bind("<<open-stack-viewer>>", self.open_stack_viewer)
876
        text.bind("<<toggle-debugger>>", self.toggle_debugger)
David Scherer's avatar
David Scherer committed
877
        text.bind("<<toggle-jit-stack-viewer>>", self.toggle_jit_stack_viewer)
878 879 880
        if use_subprocess:
            text.bind("<<view-restart>>", self.view_restart_mark)
            text.bind("<<restart-shell>>", self.restart_shell)
881
        #
David Scherer's avatar
David Scherer committed
882 883 884
        self.save_stdout = sys.stdout
        self.save_stderr = sys.stderr
        self.save_stdin = sys.stdin
885 886 887 888 889
        from idlelib import iomenu
        self.stdin = PseudoInputFile(self, "stdin", iomenu.encoding)
        self.stdout = PseudoOutputFile(self, "stdout", iomenu.encoding)
        self.stderr = PseudoOutputFile(self, "stderr", iomenu.encoding)
        self.console = PseudoOutputFile(self, "console", iomenu.encoding)
Chui Tey's avatar
Chui Tey committed
890 891
        if not use_subprocess:
            sys.stdout = self.stdout
892
            sys.stderr = self.stderr
893
            sys.stdin = self.stdin
894 895 896
        try:
            # page help() text to shell.
            import pydoc # import must be done here to capture i/o rebinding.
897
            # XXX KBK 27Dec07 use text viewer someday, but must work w/o subproc
898 899 900 901
            pydoc.pager = pydoc.plainpager
        except:
            sys.stderr = sys.__stderr__
            raise
902
        #
David Scherer's avatar
David Scherer committed
903
        self.history = self.History(self.text)
904
        #
905
        self.pollinterval = 50  # millisec
Chui Tey's avatar
Chui Tey committed
906

907 908 909
    def get_standard_extension_names(self):
        return idleConf.GetExtensions(shell_only=True)

Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
910 911 912 913 914
    reading = False
    executing = False
    canceled = False
    endoffile = False
    closing = False
915
    _stop_readline_flag = False
David Scherer's avatar
David Scherer committed
916

917
    def set_warning_stream(self, stream):
918 919
        global warning_stream
        warning_stream = stream
920 921 922 923

    def get_warning_stream(self):
        return warning_stream

David Scherer's avatar
David Scherer committed
924 925 926 927
    def toggle_debugger(self, event=None):
        if self.executing:
            tkMessageBox.showerror("Don't debug now",
                "You can only toggle the debugger when idle",
928
                parent=self.text)
David Scherer's avatar
David Scherer committed
929 930 931 932 933 934 935 936 937 938 939 940 941
            self.set_debugger_indicator()
            return "break"
        else:
            db = self.interp.getdebugger()
            if db:
                self.close_debugger()
            else:
                self.open_debugger()

    def set_debugger_indicator(self):
        db = self.interp.getdebugger()
        self.setvar("<<toggle-debugger>>", not not db)

Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
942
    def toggle_jit_stack_viewer(self, event=None):
David Scherer's avatar
David Scherer committed
943 944 945 946 947 948 949
        pass # All we need is the variable

    def close_debugger(self):
        db = self.interp.getdebugger()
        if db:
            self.interp.setdebugger(None)
            db.close()
950
            if self.interp.rpcclt:
951
                debugger_r.close_remote_debugger(self.interp.rpcclt)
David Scherer's avatar
David Scherer committed
952 953 954 955 956 957 958
            self.resetoutput()
            self.console.write("[DEBUG OFF]\n")
            sys.ps1 = ">>> "
            self.showprompt()
        self.set_debugger_indicator()

    def open_debugger(self):
Chui Tey's avatar
Chui Tey committed
959
        if self.interp.rpcclt:
960
            dbg_gui = debugger_r.start_remote_debugger(self.interp.rpcclt,
961 962
                                                           self)
        else:
963
            dbg_gui = debugger.Debugger(self)
964 965
        self.interp.setdebugger(dbg_gui)
        dbg_gui.load_breakpoints()
Chui Tey's avatar
Chui Tey committed
966 967 968 969
        sys.ps1 = "[DEBUG ON]\n>>> "
        self.showprompt()
        self.set_debugger_indicator()

David Scherer's avatar
David Scherer committed
970
    def beginexecuting(self):
971
        "Helper for ModifiedInterpreter"
David Scherer's avatar
David Scherer committed
972 973 974 975
        self.resetoutput()
        self.executing = 1

    def endexecuting(self):
976
        "Helper for ModifiedInterpreter"
David Scherer's avatar
David Scherer committed
977 978
        self.executing = 0
        self.canceled = 0
Chui Tey's avatar
Chui Tey committed
979
        self.showprompt()
David Scherer's avatar
David Scherer committed
980 981

    def close(self):
982
        "Extend EditorWindow.close()"
David Scherer's avatar
David Scherer committed
983
        if self.executing:
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
984
            response = tkMessageBox.askokcancel(
David Scherer's avatar
David Scherer committed
985
                "Kill?",
986
                "Your program is still running!\n Do you want to kill it?",
David Scherer's avatar
David Scherer committed
987
                default="ok",
988
                parent=self.text)
989
            if response is False:
David Scherer's avatar
David Scherer committed
990
                return "cancel"
991
        self.stop_readline()
992
        self.canceled = True
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
993
        self.closing = True
994
        return EditorWindow.close(self)
David Scherer's avatar
David Scherer committed
995 996

    def _close(self):
997
        "Extend EditorWindow._close(), shut down debugger and execution server"
David Scherer's avatar
David Scherer committed
998
        self.close_debugger()
999 1000
        if use_subprocess:
            self.interp.kill_subprocess()
David Scherer's avatar
David Scherer committed
1001 1002 1003 1004 1005 1006 1007 1008 1009
        # Restore std streams
        sys.stdout = self.save_stdout
        sys.stderr = self.save_stderr
        sys.stdin = self.save_stdin
        # Break cycles
        self.interp = None
        self.console = None
        self.flist.pyshell = None
        self.history = None
1010
        EditorWindow._close(self)
David Scherer's avatar
David Scherer committed
1011 1012

    def ispythonsource(self, filename):
1013
        "Override EditorWindow method: never remove the colorizer"
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
1014
        return True
David Scherer's avatar
David Scherer committed
1015 1016 1017 1018

    def short_title(self):
        return self.shell_title

1019
    COPYRIGHT = \
1020
          'Type "copyright", "credits" or "license()" for more information.'
1021

David Scherer's avatar
David Scherer committed
1022
    def begin(self):
1023
        self.text.mark_set("iomark", "insert")
David Scherer's avatar
David Scherer committed
1024
        self.resetoutput()
1025 1026
        if use_subprocess:
            nosub = ''
1027 1028 1029
            client = self.interp.start_subprocess()
            if not client:
                self.close()
1030
                return False
1031
        else:
1032
            nosub = ("==== No Subprocess ====\n\n" +
Andrew Svetlov's avatar
Andrew Svetlov committed
1033
                    "WARNING: Running IDLE without a Subprocess is deprecated\n" +
1034 1035
                    "and will be removed in a later version. See Help/IDLE Help\n" +
                    "for details.\n\n")
1036 1037
            sys.displayhook = rpc.displayhook

1038 1039
        self.write("Python %s on %s\n%s\n%s" %
                   (sys.version, sys.platform, self.COPYRIGHT, nosub))
1040
        self.text.focus_force()
David Scherer's avatar
David Scherer committed
1041
        self.showprompt()
1042 1043
        import tkinter
        tkinter._default_root = None # 03Jan04 KBK What's this?
1044
        return True
David Scherer's avatar
David Scherer committed
1045

1046 1047 1048 1049 1050 1051
    def stop_readline(self):
        if not self.reading:  # no nested mainloop to exit.
            return
        self._stop_readline_flag = True
        self.top.quit()

David Scherer's avatar
David Scherer committed
1052 1053 1054 1055
    def readline(self):
        save = self.reading
        try:
            self.reading = 1
1056
            self.top.mainloop()  # nested mainloop()
David Scherer's avatar
David Scherer committed
1057 1058
        finally:
            self.reading = save
1059 1060 1061
        if self._stop_readline_flag:
            self._stop_readline_flag = False
            return ""
David Scherer's avatar
David Scherer committed
1062
        line = self.text.get("iomark", "end-1c")
1063 1064
        if len(line) == 0:  # may be EOF if we quit our mainloop with Ctrl-C
            line = "\n"
David Scherer's avatar
David Scherer committed
1065 1066 1067
        self.resetoutput()
        if self.canceled:
            self.canceled = 0
1068 1069
            if not use_subprocess:
                raise KeyboardInterrupt
David Scherer's avatar
David Scherer committed
1070 1071
        if self.endoffile:
            self.endoffile = 0
1072
            line = ""
David Scherer's avatar
David Scherer committed
1073 1074 1075
        return line

    def isatty(self):
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
1076
        return True
David Scherer's avatar
David Scherer committed
1077

Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
1078
    def cancel_callback(self, event=None):
David Scherer's avatar
David Scherer committed
1079 1080 1081 1082 1083 1084 1085
        try:
            if self.text.compare("sel.first", "!=", "sel.last"):
                return # Active selection -- always use default binding
        except:
            pass
        if not (self.executing or self.reading):
            self.resetoutput()
1086
            self.interp.write("KeyboardInterrupt\n")
David Scherer's avatar
David Scherer committed
1087 1088 1089
            self.showprompt()
            return "break"
        self.endoffile = 0
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
1090
        self.canceled = 1
1091
        if (self.executing and self.interp.rpcclt):
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
1092 1093 1094 1095
            if self.interp.getdebugger():
                self.interp.restart_subprocess()
            else:
                self.interp.interrupt_subprocess()
1096 1097
        if self.reading:
            self.top.quit()  # exit the nested mainloop() in readline()
David Scherer's avatar
David Scherer committed
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120
        return "break"

    def eof_callback(self, event):
        if self.executing and not self.reading:
            return # Let the default binding (delete next char) take over
        if not (self.text.compare("iomark", "==", "insert") and
                self.text.compare("insert", "==", "end-1c")):
            return # Let the default binding (delete next char) take over
        if not self.executing:
            self.resetoutput()
            self.close()
        else:
            self.canceled = 0
            self.endoffile = 1
            self.top.quit()
        return "break"

    def linefeed_callback(self, event):
        # Insert a linefeed without entering anything (still autoindented)
        if self.reading:
            self.text.insert("insert", "\n")
            self.text.see("insert")
        else:
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
1121
            self.newline_and_indent_event(event)
David Scherer's avatar
David Scherer committed
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
        return "break"

    def enter_callback(self, event):
        if self.executing and not self.reading:
            return # Let the default binding (insert '\n') take over
        # If some text is selected, recall the selection
        # (but only if this before the I/O mark)
        try:
            sel = self.text.get("sel.first", "sel.last")
            if sel:
                if self.text.compare("sel.last", "<=", "iomark"):
1133
                    self.recall(sel, event)
David Scherer's avatar
David Scherer committed
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143
                    return "break"
        except:
            pass
        # If we're strictly before the line containing iomark, recall
        # the current line, less a leading prompt, less leading or
        # trailing whitespace
        if self.text.compare("insert", "<", "iomark linestart"):
            # Check if there's a relevant stdin range -- if so, use it
            prev = self.text.tag_prevrange("stdin", "insert")
            if prev and self.text.compare("insert", "<", prev[1]):
1144
                self.recall(self.text.get(prev[0], prev[1]), event)
David Scherer's avatar
David Scherer committed
1145 1146 1147
                return "break"
            next = self.text.tag_nextrange("stdin", "insert")
            if next and self.text.compare("insert lineend", ">=", next[0]):
1148
                self.recall(self.text.get(next[0], next[1]), event)
David Scherer's avatar
David Scherer committed
1149
                return "break"
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
1150
            # No stdin mark -- just get the current line, less any prompt
1151 1152 1153 1154 1155 1156
            indices = self.text.tag_nextrange("console", "insert linestart")
            if indices and \
               self.text.compare(indices[0], "<=", "insert linestart"):
                self.recall(self.text.get(indices[1], "insert lineend"), event)
            else:
                self.recall(self.text.get("insert linestart", "insert lineend"), event)
David Scherer's avatar
David Scherer committed
1157
            return "break"
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
1158
        # If we're between the beginning of the line and the iomark, i.e.
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
1159
        # in the prompt area, move to the end of the prompt
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
1160
        if self.text.compare("insert", "<", "iomark"):
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
1161
            self.text.mark_set("insert", "iomark")
David Scherer's avatar
David Scherer committed
1162 1163 1164
        # If we're in the current input and there's only whitespace
        # beyond the cursor, erase that whitespace first
        s = self.text.get("insert", "end-1c")
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
1165
        if s and not s.strip():
David Scherer's avatar
David Scherer committed
1166 1167 1168 1169
            self.text.delete("insert", "end-1c")
        # If we're in the current input before its last line,
        # insert a newline right at the insert point
        if self.text.compare("insert", "<", "end-1c linestart"):
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
1170
            self.newline_and_indent_event(event)
David Scherer's avatar
David Scherer committed
1171 1172 1173 1174 1175 1176 1177
            return "break"
        # We're in the last line; append a newline and submit it
        self.text.mark_set("insert", "end-1c")
        if self.reading:
            self.text.insert("insert", "\n")
            self.text.see("insert")
        else:
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
1178
            self.newline_and_indent_event(event)
David Scherer's avatar
David Scherer committed
1179 1180 1181
        self.text.tag_add("stdin", "iomark", "end-1c")
        self.text.update_idletasks()
        if self.reading:
1182
            self.top.quit() # Break out of recursive mainloop()
David Scherer's avatar
David Scherer committed
1183 1184 1185 1186
        else:
            self.runit()
        return "break"

1187
    def recall(self, s, event):
1188 1189 1190 1191
        # remove leading and trailing empty or whitespace lines
        s = re.sub(r'^\s*\n', '' , s)
        s = re.sub(r'\n\s*$', '', s)
        lines = s.split('\n')
1192 1193 1194 1195
        self.text.undo_block_start()
        try:
            self.text.tag_remove("sel", "1.0", "end")
            self.text.mark_set("insert", "end-1c")
1196 1197
            prefix = self.text.get("insert linestart", "insert")
            if prefix.rstrip().endswith(':'):
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
1198
                self.newline_and_indent_event(event)
1199 1200
                prefix = self.text.get("insert linestart", "insert")
            self.text.insert("insert", lines[0].strip())
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
1201
            if len(lines) > 1:
1202 1203
                orig_base_indent = re.search(r'^([ \t]*)', lines[0]).group(0)
                new_base_indent  = re.search(r'^([ \t]*)', prefix).group(0)
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
1204
                for line in lines[1:]:
1205 1206 1207 1208
                    if line.startswith(orig_base_indent):
                        # replace orig base indentation with new indentation
                        line = new_base_indent + line[len(orig_base_indent):]
                    self.text.insert('insert', '\n'+line.rstrip())
1209 1210 1211
        finally:
            self.text.see("insert")
            self.text.undo_block_stop()
David Scherer's avatar
David Scherer committed
1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224

    def runit(self):
        line = self.text.get("iomark", "end-1c")
        # Strip off last newline and surrounding whitespace.
        # (To allow you to hit return twice to end a statement.)
        i = len(line)
        while i > 0 and line[i-1] in " \t":
            i = i-1
        if i > 0 and line[i-1] == "\n":
            i = i-1
        while i > 0 and line[i-1] in " \t":
            i = i-1
        line = line[:i]
1225
        self.interp.runsource(line)
David Scherer's avatar
David Scherer committed
1226 1227

    def open_stack_viewer(self, event=None):
Chui Tey's avatar
Chui Tey committed
1228 1229
        if self.interp.rpcclt:
            return self.interp.remote_stack_viewer()
David Scherer's avatar
David Scherer committed
1230 1231 1232 1233 1234 1235
        try:
            sys.last_traceback
        except:
            tkMessageBox.showerror("No stack trace",
                "There is no stack trace yet.\n"
                "(sys.last_traceback is not defined)",
1236
                parent=self.text)
David Scherer's avatar
David Scherer committed
1237
            return
1238
        from idlelib.stackviewer import StackBrowser
1239
        StackBrowser(self.root, self.flist)
David Scherer's avatar
David Scherer committed
1240

Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
1241 1242 1243 1244 1245
    def view_restart_mark(self, event=None):
        self.text.see("iomark")
        self.text.see("restart")

    def restart_shell(self, event=None):
1246 1247
        "Callback for Run/Restart Shell Cntl-F6"
        self.interp.restart_subprocess(with_cwd=True)
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
1248

David Scherer's avatar
David Scherer committed
1249 1250 1251 1252 1253 1254 1255 1256
    def showprompt(self):
        self.resetoutput()
        try:
            s = str(sys.ps1)
        except:
            s = ""
        self.console.write(s)
        self.text.mark_set("insert", "end-1c")
Chui Tey's avatar
Chui Tey committed
1257
        self.set_line_and_column()
1258
        self.io.reset_undo()
David Scherer's avatar
David Scherer committed
1259 1260 1261 1262

    def resetoutput(self):
        source = self.text.get("iomark", "end-1c")
        if self.history:
1263
            self.history.store(source)
David Scherer's avatar
David Scherer committed
1264 1265 1266
        if self.text.get("end-2c") != "\n":
            self.text.insert("end-1c", "\n")
        self.text.mark_set("iomark", "end-1c")
Chui Tey's avatar
Chui Tey committed
1267
        self.set_line_and_column()
David Scherer's avatar
David Scherer committed
1268 1269

    def write(self, s, tags=()):
1270 1271 1272 1273 1274 1275 1276 1277 1278 1279
        if isinstance(s, str) and len(s) and max(s) > '\uffff':
            # Tk doesn't support outputting non-BMP characters
            # Let's assume what printed string is not very long,
            # find first non-BMP character and construct informative
            # UnicodeEncodeError exception.
            for start, char in enumerate(s):
                if char > '\uffff':
                    break
            raise UnicodeEncodeError("UCS-2", char, start, start+1,
                                     'Non-BMP character not supported in Tk')
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
1280 1281
        try:
            self.text.mark_gravity("iomark", "right")
1282
            count = OutputWindow.write(self, s, tags, "iomark")
Kurt B. Kaiser's avatar
Kurt B. Kaiser committed
1283 1284
            self.text.mark_gravity("iomark", "left")
        except:
1285 1286
            raise ###pass  # ### 11Aug07 KBK if we are expecting exceptions
                           # let's find out what they are and be specific.
David Scherer's avatar
David Scherer committed
1287 1288
        if self.canceled:
            self.canceled = 0
1289 1290
            if not use_subprocess:
                raise KeyboardInterrupt
1291
        return count
David Scherer's avatar
David Scherer committed
1292

1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305
    def rmenu_check_cut(self):
        try:
            if self.text.compare('sel.first', '<', 'iomark'):
                return 'disabled'
        except TclError: # no selection, so the index 'sel.first' doesn't exist
            return 'disabled'
        return super().rmenu_check_cut()

    def rmenu_check_paste(self):
        if self.text.compare('insert','<','iomark'):
            return 'disabled'
        return super().rmenu_check_paste()

1306

1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317
def fix_x11_paste(root):
    "Make paste replace selection on x11.  See issue #5124."
    if root._windowingsystem == 'x11':
        for cls in 'Text', 'Entry', 'Spinbox':
            root.bind_class(
                cls,
                '<<Paste>>',
                'catch {%W delete sel.first sel.last}\n' +
                        root.bind_class(cls, '<<Paste>>'))


David Scherer's avatar
David Scherer committed
1318 1319
usage_msg = """\

1320 1321 1322
USAGE: idle  [-deins] [-t title] [file]*
       idle  [-dns] [-t title] (-c cmd | -r file) [arg]*
       idle  [-dns] [-t title] - [arg]*
1323

1324
  -h         print this help message and exit
1325 1326
  -n         run IDLE without a subprocess (DEPRECATED,
             see Help/IDLE Help for details)
1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346

The following options will override the IDLE 'settings' configuration:

  -e         open an edit window
  -i         open a shell window

The following options imply -i and will open a shell:

  -c cmd     run the command in a shell, or
  -r file    run script from file

  -d         enable the debugger
  -s         run $IDLESTARTUP or $PYTHONSTARTUP before anything else
  -t title   set title of shell window

A default edit window will be bypassed when -c, -r, or - are used.

[arg]* are passed to the command (-c) or script (-r) in sys.argv[1:].

Examples:
David Scherer's avatar
David Scherer committed
1347

1348 1349
idle
        Open an edit window or shell depending on IDLE's configuration.
1350

1351 1352 1353 1354 1355 1356 1357
idle foo.py foobar.py
        Edit the files, also open a shell if configured to start with shell.

idle -est "Baz" foo.py
        Run $IDLESTARTUP or $PYTHONSTARTUP, edit foo.py, and open a shell
        window with the title "Baz".

1358
idle -c "import sys; print(sys.argv)" "foo"
1359 1360 1361 1362 1363 1364 1365 1366
        Open a shell window and run the command, passing "-c" in sys.argv[0]
        and "foo" in sys.argv[1].

idle -d -s -r foo.py "Hello World"
        Open a shell window, run a startup script, enable the debugger, and
        run foo.py, passing "foo.py" in sys.argv[0] and "Hello World" in
        sys.argv[1].

1367
echo "import sys; print(sys.argv)" | idle - "foobar"
1368 1369
        Open a shell window, run the script piped in, passing '' in sys.argv[0]
        and "foobar" in sys.argv[1].
David Scherer's avatar
David Scherer committed
1370 1371
"""

1372
def main():
1373 1374 1375 1376 1377
    import getopt
    from platform import system
    from idlelib import testing  # bool value
    from idlelib import macosx

1378 1379
    global flist, root, use_subprocess

1380
    capture_warnings(True)
1381
    use_subprocess = True
1382
    enable_shell = False
1383 1384
    enable_edit = False
    debug = False
1385 1386
    cmd = None
    script = None
1387
    startup = False
1388
    try:
1389
        opts, args = getopt.getopt(sys.argv[1:], "c:deihnr:st:")
1390
    except getopt.error as msg:
1391
        print("Error: %s\n%s" % (msg, usage_msg), file=sys.stderr)
1392 1393 1394 1395
        sys.exit(2)
    for o, a in opts:
        if o == '-c':
            cmd = a
1396
            enable_shell = True
1397
        if o == '-d':
1398 1399
            debug = True
            enable_shell = True
1400
        if o == '-e':
1401 1402 1403 1404 1405 1406
            enable_edit = True
        if o == '-h':
            sys.stdout.write(usage_msg)
            sys.exit()
        if o == '-i':
            enable_shell = True
1407
        if o == '-n':
1408 1409
            print(" Warning: running IDLE without a subprocess is deprecated.",
                  file=sys.stderr)
1410
            use_subprocess = False
1411 1412
        if o == '-r':
            script = a
1413 1414 1415
            if os.path.isfile(script):
                pass
            else:
1416
                print("No script file: ", script)
1417 1418
                sys.exit()
            enable_shell = True
1419
        if o == '-s':
1420 1421
            startup = True
            enable_shell = True
1422 1423
        if o == '-t':
            PyShell.shell_title = a
1424 1425 1426 1427 1428
            enable_shell = True
    if args and args[0] == '-':
        cmd = sys.stdin.read()
        enable_shell = True
    # process sys.argv and sys.path:
1429 1430
    for i in range(len(sys.path)):
        sys.path[i] = os.path.abspath(sys.path[i])
1431 1432 1433 1434 1435 1436 1437 1438 1439
    if args and args[0] == '-':
        sys.argv = [''] + args[1:]
    elif cmd:
        sys.argv = ['-c'] + args
    elif script:
        sys.argv = [script] + args
    elif args:
        enable_edit = True
        pathx = []
1440 1441
        for filename in args:
            pathx.append(os.path.dirname(filename))
1442 1443 1444 1445
        for dir in pathx:
            dir = os.path.abspath(dir)
            if not dir in sys.path:
                sys.path.insert(0, dir)
1446
    else:
1447 1448
        dir = os.getcwd()
        if dir not in sys.path:
1449
            sys.path.insert(0, dir)
1450 1451
    # check the IDLE settings configuration (but command line overrides)
    edit_start = idleConf.GetOption('main', 'General',
1452
                                    'editor-on-startup', type='bool')
1453
    enable_edit = enable_edit or edit_start
1454
    enable_shell = enable_shell or not enable_edit
1455

1456 1457 1458
    # Setup root.  Don't break user code run in IDLE process.
    # Don't change environment when testing.
    if use_subprocess and not testing:
1459
        NoDefaultRoot()
1460
    root = Tk(className="Idle")
1461
    root.withdraw()
1462 1463
    from idlelib.run import fix_scaling
    fix_scaling(root)
1464

1465 1466 1467 1468 1469
    # set application icon
    icondir = os.path.join(os.path.dirname(__file__), 'Icons')
    if system() == 'Windows':
        iconfile = os.path.join(icondir, 'idle.ico')
        root.wm_iconbitmap(default=iconfile)
1470
    else:
1471 1472 1473
        ext = '.png' if TkVersion >= 8.6 else '.gif'
        iconfiles = [os.path.join(icondir, 'idle_%d%s' % (size, ext))
                     for size in (16, 32, 48)]
1474 1475
        icons = [PhotoImage(master=root, file=iconfile)
                 for iconfile in iconfiles]
1476 1477
        root.wm_iconphoto(True, *icons)

1478
    # start editor and/or shell windows:
1479
    fixwordbreaks(root)
1480
    fix_x11_paste(root)
1481
    flist = PyShellFileList(root)
1482
    macosx.setupApp(root, flist)
Terry Jan Reedy's avatar
Terry Jan Reedy committed
1483

1484 1485
    if enable_edit:
        if not (cmd or script):
1486 1487 1488 1489
            for filename in args[:]:
                if flist.open(filename) is None:
                    # filename is a directory actually, disconsider it
                    args.remove(filename)
1490 1491
            if not args:
                flist.new()
1492

1493
    if enable_shell:
1494 1495
        shell = flist.open_shell()
        if not shell:
1496
            return # couldn't open shell
1497
        if macosx.isAquaTk() and flist.dict:
1498 1499 1500 1501 1502
            # On OSX: when the user has double-clicked on a file that causes
            # IDLE to be launched the shell window will open just in front of
            # the file she wants to see. Lower the interpreter window when
            # there are open files.
            shell.top.lower()
1503 1504
    else:
        shell = flist.pyshell
1505

1506 1507
    # Handle remaining options. If any of these are set, enable_shell
    # was set also, so shell must be true to reach here.
1508 1509
    if debug:
        shell.open_debugger()
1510 1511 1512 1513
    if startup:
        filename = os.environ.get("IDLESTARTUP") or \
                   os.environ.get("PYTHONSTARTUP")
        if filename and os.path.isfile(filename):
1514
            shell.interp.execfile(filename)
1515
    if cmd or script:
1516 1517
        shell.interp.runcommand("""if 1:
            import sys as _sys
1518
            _sys.argv = %r
1519
            del _sys
1520
            \n""" % (sys.argv,))
1521 1522 1523
        if cmd:
            shell.interp.execsource(cmd)
        elif script:
1524
            shell.interp.prepend_syspath(script)
1525
            shell.interp.execfile(script)
1526 1527 1528 1529 1530
    elif shell:
        # If there is a shell window and no cmd or script in progress,
        # check for problematic OS X Tk versions and print a warning
        # message in the IDLE shell window; this is less intrusive
        # than always opening a separate window.
1531
        tkversionwarning = macosx.tkVersionWarning(root)
1532 1533
        if tkversionwarning:
            shell.interp.runcommand("print('%s')" % tkversionwarning)
1534

1535 1536
    while flist.inversedict:  # keep IDLE running while files are open.
        root.mainloop()
1537
    root.destroy()
1538
    capture_warnings(False)
1539

David Scherer's avatar
David Scherer committed
1540
if __name__ == "__main__":
1541
    sys.modules['pyshell'] = sys.modules['__main__']
David Scherer's avatar
David Scherer committed
1542
    main()
1543 1544

capture_warnings(False)  # Make sure turned off; see issue 18081