Lib/idlelib/ScriptBinding.py

   1 """Extension to execute code outside the Python shell window.
   2
   3 This adds the following commands:
   4
   5 - Check module does a full syntax check of the current module.
   6   It also runs the tabnanny to catch any inconsistent tabs.
   7
   8 - Run module executes the module's code in the __main__ namespace.  The window
   9   must have been saved previously. The module is added to sys.modules, and is
  10   also added to the __main__ namespace.
  11
  12 XXX GvR Redesign this interface (yet again) as follows:
  13
  14 - Present a dialog box for ``Run Module''
  15
  16 - Allow specify command line arguments in the dialog box
  17
  18 """
  19
  20 import os
  21 import re
  22 import string
  23 import tabnanny
  24 import tokenize
  25 import tkMessageBox
  26 import PyShell
  27
  28 from configHandler import idleConf
  29
  30 IDENTCHARS = string.ascii_letters + string.digits + "_"
  31
  32 indent_message = """Error: Inconsistent indentation detected!
  33
  34 1) Your indentation is outright incorrect (easy to fix), OR
  35
  36 2) Your indentation mixes tabs and spaces.
  37
  38 To fix case 2, change all tabs to spaces by using Edit->Select All followed \
  39 by Format->Untabify Region and specify the number of columns used by each tab.
  40 """
  41
  42 class ScriptBinding:
  43
  44     menudefs = [
  45         ('run', [None,
  46                  ('Check Module', '<<check-module>>'),
  47                  ('Run Module', '<<run-module>>'), ]), ]
  48
  49     def __init__(self, editwin):
  50         self.editwin = editwin
  51         # Provide instance variables referenced by Debugger
  52         # XXX This should be done differently
  53         self.flist = self.editwin.flist
  54         self.root = self.editwin.root
  55
  56     def check_module_event(self, event):
  57         filename = self.getfilename()
  58         if not filename:
  59             return
  60         if not self.tabnanny(filename):
  61             return
  62         self.checksyntax(filename)
  63
  64     def tabnanny(self, filename):
  65         f = open(filename, 'r')
  66         try:
  67             tabnanny.process_tokens(tokenize.generate_tokens(f.readline))
  68         except tokenize.TokenError, msg:
  69             msgtxt, (lineno, start) = msg
  70             self.editwin.gotoline(lineno)
  71             self.errorbox("Tabnanny Tokenizing Error",
  72                           "Token Error: %s" % msgtxt)
  73             return False
  74         except tabnanny.NannyNag, nag:
  75             # The error messages from tabnanny are too confusing...
  76             self.editwin.gotoline(nag.get_lineno())
  77             self.errorbox("Tab/space error", indent_message)
  78             return False
  79         except IndentationError:
  80             # From tokenize(), let compile() in checksyntax find it again.
  81             pass
  82         return True
  83
  84     def checksyntax(self, filename):
  85         self.shell = shell = self.flist.open_shell()
  86         saved_stream = shell.get_warning_stream()
  87         shell.set_warning_stream(shell.stderr)
  88         f = open(filename, 'r')
  89         source = f.read()
  90         f.close()
  91         if '\r' in source:
  92             source = re.sub(r"\r\n", "\n", source)
  93             source = re.sub(r"\r", "\n", source)
  94         if source and source[-1] != '\n':
  95             source = source + '\n'
  96         text = self.editwin.text
  97         text.tag_remove("ERROR", "1.0", "end")
  98         try:
  99             try:
 100                 # If successful, return the compiled code
 101                 return compile(source, filename, "exec")
 102             except (SyntaxError, OverflowError), err:
 103                 try:
 104                     msg, (errorfilename, lineno, offset, line) = err
 105                     if not errorfilename:
 106                         err.args = msg, (filename, lineno, offset, line)
 107                         err.filename = filename
 108                     self.colorize_syntax_error(msg, lineno, offset)
 109                 except:
 110                     msg = "*** " + str(err)
 111                 self.errorbox("Syntax error",
 112                               "There's an error in your program:\n" + msg)
 113                 return False
 114         finally:
 115             shell.set_warning_stream(saved_stream)
 116
 117     def colorize_syntax_error(self, msg, lineno, offset):
 118         text = self.editwin.text
 119         pos = "0.0 + %d lines + %d chars" % (lineno-1, offset-1)
 120         text.tag_add("ERROR", pos)
 121         char = text.get(pos)
 122         if char and char in IDENTCHARS:
 123             text.tag_add("ERROR", pos + " wordstart", pos)
 124         if '\n' == text.get(pos):   # error at line end
 125             text.mark_set("insert", pos)
 126         else:
 127             text.mark_set("insert", pos + "+1c")
 128         text.see(pos)
 129
 130     def run_module_event(self, event):
 131         """Run the module after setting up the environment.
 132
 133         First check the syntax.  If OK, make sure the shell is active and
 134         then transfer the arguments, set the run environment's working
 135         directory to the directory of the module being executed and also
 136         add that directory to its sys.path if not already included.
 137
 138         """
 139         filename = self.getfilename()
 140         if not filename:
 141             return
 142         if not self.tabnanny(filename):
 143             return
 144         code = self.checksyntax(filename)
 145         if not code:
 146             return
 147         shell = self.shell
 148         interp = shell.interp
 149         if PyShell.use_subprocess:
 150             shell.restart_shell()
 151         dirname = os.path.dirname(filename)
 152         # XXX Too often this discards arguments the user just set...
 153         interp.runcommand("""if 1:
 154             _filename = %r
 155             import sys as _sys
 156             from os.path import basename as _basename
 157             if (not _sys.argv or
 158                 _basename(_sys.argv[0]) != _basename(_filename)):
 159                 _sys.argv = [_filename]
 160             import os as _os
 161             _os.chdir(%r)
 162             del _filename, _sys, _basename, _os
 163             \n""" % (filename, dirname))
 164         interp.prepend_syspath(filename)
 165         # XXX KBK 03Jul04 When run w/o subprocess, runtime warnings still
 166         #         go to __stderr__.  With subprocess, they go to the shell.
 167         #         Need to change streams in PyShell.ModifiedInterpreter.
 168         interp.runcode(code)
 169
 170     def getfilename(self):
 171         """Get source filename.  If not saved, offer to save (or create) file
 172
 173         The debugger requires a source file.  Make sure there is one, and that
 174         the current version of the source buffer has been saved.  If the user
 175         declines to save or cancels the Save As dialog, return None.
 176
 177         If the user has configured IDLE for Autosave, the file will be
 178         silently saved if it already exists and is dirty.
 179
 180         """
 181         filename = self.editwin.io.filename
 182         if not self.editwin.get_saved():
 183             autosave = idleConf.GetOption('main', 'General',
 184                                           'autosave', type='bool')
 185             if autosave and filename:
 186                 self.editwin.io.save(None)
 187             else:
 188                 reply = self.ask_save_dialog()
 189                 self.editwin.text.focus_set()
 190                 if reply == "ok":
 191                     self.editwin.io.save(None)
 192                     filename = self.editwin.io.filename
 193                 else:
 194                     filename = None
 195         return filename
 196
 197     def ask_save_dialog(self):
 198         msg = "Source Must Be Saved\n" + 5*' ' + "OK to Save?"
 199         mb = tkMessageBox.Message(title="Save Before Run or Check",
 200                                   message=msg,
 201                                   icon=tkMessageBox.QUESTION,
 202                                   type=tkMessageBox.OKCANCEL,
 203                                   default=tkMessageBox.OK,
 204                                   master=self.editwin.text)
 205         return mb.show()
 206
 207     def errorbox(self, title, message):
 208         # XXX This should really be a function of EditorWindow...
 209         tkMessageBox.showerror(title, message, master=self.editwin.text)
 210         self.editwin.text.focus_set()