eric: DebugClients/Python3/DebugClientBase.py@015c7e35bd84 (annotated)

 # -*- coding: utf-8 -*-
 # Copyright (c) 2009 - 2010 Detlev Offenbach <detlev@die-offenbachs.de>
 #
 """
 Module implementing a debug client base class.
 """
 import sys
 import socket
 import select
 import codeop
 import traceback
 import os
 import time
 import imp
 import re
 import distutils.sysconfig
 import imp
 from DebugProtocol import *
 import DebugClientCapabilities
 from DebugBase import setRecursionLimit, printerr
 from AsyncFile import *
 from DebugConfig import ConfigVarTypeStrings
 from FlexCompleter import Completer
 DebugClientInstance = None
 ################################################################################
 def DebugClientInput(prompt = ""):
     """
     Replacement for the standard input builtin.
     This function works with the split debugger.
     @param prompt The prompt to be shown. (string)
     """
     if DebugClientInstance is None or not DebugClientInstance.redirect:
         return DebugClientOrigInput(prompt)
     return DebugClientInstance.input(prompt)
 # Use our own input().
 try:
     DebugClientOrigInput = __builtins__.__dict__['input']
     __builtins__.__dict__['input'] = DebugClientInput
 except (AttributeError, KeyError):
     import __main__
     DebugClientOrigInput = __main__.__builtins__.__dict__['input']
     __main__.__builtins__.__dict__['input'] = DebugClientInput
 ################################################################################
 def DebugClientFork():
     """
     Replacement for the standard os.fork().
     """
     if DebugClientInstance is None:
         return DebugClientOrigFork()
     return DebugClientInstance.fork()
 # use our own fork().
 if 'fork' in dir(os):
     DebugClientOrigFork = os.fork
     os.fork = DebugClientFork
 ################################################################################
 def DebugClientClose(fd):
     """
     Replacement for the standard os.close(fd).
     @param fd open file descriptor to be closed (integer)
     """
     if DebugClientInstance is None:
         DebugClientOrigClose(fd)
     DebugClientInstance.close(fd)
 # use our own close().
 if 'close' in dir(os):
     DebugClientOrigClose = os.close
     os.close = DebugClientClose
 ################################################################################
 def DebugClientSetRecursionLimit(limit):
     """
     Replacement for the standard sys.setrecursionlimit(limit).
     @param limit recursion limit (integer)
     """
     rl = max(limit, 64)
     setRecursionLimit(rl)
     DebugClientOrigSetRecursionLimit(rl + 64)
 # use our own setrecursionlimit().
 if 'setrecursionlimit' in dir(sys):
     DebugClientOrigSetRecursionLimit = sys.setrecursionlimit
     sys.setrecursionlimit = DebugClientSetRecursionLimit
     DebugClientSetRecursionLimit(sys.getrecursionlimit())
 ################################################################################
 class DebugClientBase(object):
     """
     Class implementing the client side of the debugger.
     It provides access to the Python interpeter from a debugger running in another
     process whether or not the Qt event loop is running.
     The protocol between the debugger and the client assumes that there will be
     a single source of debugger commands and a single source of Python
     statements.  Commands and statement are always exactly one line and may be
     interspersed.
     The protocol is as follows.  First the client opens a connection to the
     debugger and then sends a series of one line commands.  A command is either
     &gt;Load&lt;, &gt;Step&lt;, &gt;StepInto&lt;, ... or a Python statement.
     See DebugProtocol.py for a listing of valid protocol tokens.
     A Python statement consists of the statement to execute, followed (in a
     separate line) by &gt;OK?&lt;.  If the statement was incomplete then the response
     is &gt;Continue&lt;.  If there was an exception then the response is
     &gt;Exception&lt;.
     Otherwise the response is &gt;OK&lt;.  The reason for the &gt;OK?&lt; part is to
     provide a sentinal (ie. the responding &gt;OK&lt;) after any possible output as a
     result of executing the command.
     The client may send any other lines at any other time which should be
     interpreted as program output.
     If the debugger closes the session there is no response from the client.
     The client may close the session at any time as a result of the script
     being debugged closing or crashing.
     <b>Note</b>: This class is meant to be subclassed by individual DebugClient classes.
     Do not instantiate it directly.
     """
     clientCapabilities = DebugClientCapabilities.HasAll
     def __init__(self):
         """
         Constructor
         """
         self.breakpoints = {}
         self.redirect = True
         # The next couple of members are needed for the threaded version.
         # For this base class they contain static values for the non threaded
         # debugger
         # dictionary of all threads running
         self.threads = {}
         # the "current" thread, basically the thread we are at a breakpoint for.
         self.currentThread = self
         # special objects representing the main scripts thread and frame
         self.mainThread = self
         self.mainFrame = None
         self.framenr = 0
         # The context to run the debugged program in.
         self.debugMod = imp.new_module('__main__')
         # The list of complete lines to execute.
         self.buffer = ''
         # The list of regexp objects to filter variables against
         self.globalsFilterObjects = []
         self.localsFilterObjects = []
         self.pendingResponse = ResponseOK
         self.fncache = {}
         self.dircache = []
         self.inRawMode = False
         self.mainProcStr = None     # used for the passive mode
         self.passive = False        # used to indicate the passive mode
         self.running = None
         self.test = None
         self.tracePython = False
         self.debugging = False
         self.fork_auto = False
         self.fork_child = False
         self.readstream = None
         self.writestream = None
         self.errorstream = None
         self.pollingDisabled = False
         self.skipdirs = sys.path[:]
         self.variant = 'You should not see this'
         # commandline completion stuff
         self.complete = Completer(self.debugMod.__dict__).complete
         self.compile_command = codeop.CommandCompiler()
         self.coding_re = re.compile(r"coding[:=]\s*([-\w_.]+)")
         self.defaultCoding = 'utf-8'
         self.__coding = self.defaultCoding
         self.noencoding = False
     def getCoding(self):
         """
         Public method to return the current coding.
         @return codec name (string)
         """
         return self.__coding
     def __setCoding(self, filename):
         """
         Private method to set the coding used by a python file.
         @param filename name of the file to inspect (string)
         """
         if self.noencoding:
             self.__coding = sys.getdefaultencoding()
         else:
             default = 'utf-8'
             try:
                 f = open(filename, 'rb')
                 # read the first and second line
                 text = f.readline()
                 text = "{0}{1}".format(text, f.readline())
                 f.close()
             except IOError:
                 self.__coding = default
                 return
             for l in text.splitlines():
                 m = self.coding_re.search(l)
                 if m:
                     self.__coding = m.group(1)
                     return
             self.__coding = default
     def attachThread(self, target = None, args = None, kwargs = None, mainThread = False):
         """
         Public method to setup a thread for DebugClient to debug.
         If mainThread is non-zero, then we are attaching to the already
         started mainthread of the app and the rest of the args are ignored.
         @param target the start function of the target thread (i.e. the user code)
         @param args arguments to pass to target
         @param kwargs keyword arguments to pass to target
         @param mainThread True, if we are attaching to the already
               started mainthread of the app
         @return The identifier of the created thread
         """
         if self.debugging:
             sys.setprofile(self.profile)
     def __dumpThreadList(self):
         """
         Public method to send the list of threads.
         """
         threadList = []
         if self.threads:    # indication for the threaded debugger
             currentId = self.currentThread.get_ident()
             for t in self.threads.values():
                 d = {}
                 d["id"] = t.get_ident()
                 d["name"] = t.get_name()
                 d["broken"] = t.isBroken()
                 threadList.append(d)
         else:
             currentId = -1
             d = {}
             d["id"] = -1
             d["name"] = "MainThread"
             d["broken"] = self.isBroken()
             threadList.append(d)
         self.write("{0}{1!r}\n".format(ResponseThreadList, (currentId, threadList)))
     def input(self, prompt):
         """
         Public method to implement input() using the event loop.
         @param prompt the prompt to be shown (string)
         @return the entered string
         """
         self.write("{0}{1!r}\n".format(ResponseRaw, (prompt, 1)))
         self.inRawMode = True
         self.eventLoop(True)
         return self.rawLine
     def __exceptionRaised(self):
         """
         Private method called in the case of an exception
         It ensures that the debug server is informed of the raised exception.
         """
         self.pendingResponse = ResponseException
     def sessionClose(self, exit = True):
         """
         Public method to close the session with the debugger and optionally terminate.
         @param exit flag indicating to terminate (boolean)
         """
         try:
             self.set_quit()
         except:
             pass
         # clean up asyncio.
         self.disconnect()
         self.debugging = False
         # make sure we close down our end of the socket
         # might be overkill as normally stdin, stdout and stderr
         # SHOULD be closed on exit, but it does not hurt to do it here
         self.readstream.close(True)
         self.writestream.close(True)
         self.errorstream.close(True)
         if exit:
             # Ok, go away.
             sys.exit()
     def __compileFileSource(self, filename, mode = 'exec'):
         """
         Private method to compile source code read from a file.
         @param filename name of the source file (string)
         @param mode kind of code to be generated (string, exec or eval)
         @return compiled code object (None in case of errors)
         """
         with open(filename) as fp:
             statement = fp.read()
         try:
             code = compile(statement + '\n', filename, mode)
         except SyntaxError:
             exctype, excval, exctb = sys.exc_info()
             try:
                 message, (filename, linenr, charnr, text) = excval[0], excval[1]
             except ValueError:
                 exclist = []
             else:
                 exclist = [message, [filename, linenr, charnr]]
             self.write("{0}{1}\n".format(ResponseSyntax, str(exclist)))
             return None
         return code
     def handleLine(self,line):
         """
         Public method to handle the receipt of a complete line.
         It first looks for a valid protocol token at the start of the line. Thereafter
         it trys to execute the lines accumulated so far.
         @param line the received line
         """
         # Remove any newline.
         if line[-1] == '\n':
             line = line[:-1]
 ##        printerr(line)          ##debug
         eoc = line.find('<')
         if eoc >= 0 and line[0] == '>':
             # Get the command part and any argument.
             cmd = line[:eoc + 1]
             arg = line[eoc + 1:]
             if cmd == RequestVariables:
                 frmnr, scope, filter = eval(arg.replace("u'", "'"))
                 self.__dumpVariables(int(frmnr), int(scope), filter)
                 return
             if cmd == RequestVariable:
                 var, frmnr, scope, filter = eval(arg.replace("u'", "'"))
                 self.__dumpVariable(var, int(frmnr), int(scope), filter)
                 return
             if cmd == RequestThreadList:
                 self.__dumpThreadList()
                 return
             if cmd == RequestThreadSet:
                 tid = eval(arg)
                 if tid in self.threads:
                     self.setCurrentThread(tid)
                     self.write(ResponseThreadSet + '\n')
                     stack = self.currentThread.getStack()
                     self.write('{0}{1!r}\n'.format(ResponseStack, stack))
                 return
             if cmd == RequestStep:
                 self.currentThread.step(True)
                 self.eventExit = True
                 return
             if cmd == RequestStepOver:
                 self.currentThread.step(False)
                 self.eventExit = True
                 return
             if cmd == RequestStepOut:
                 self.currentThread.stepOut()
                 self.eventExit = True
                 return
             if cmd == RequestStepQuit:
                 if self.passive:
                     self.progTerminated(42)
                 else:
                     self.set_quit()
                     self.eventExit = True
                 return
             if cmd == RequestContinue:
                 special = int(arg)
                 self.currentThread.go(special)
                 self.eventExit = True
                 return
             if cmd == RequestOK:
                 self.write(self.pendingResponse + '\n')
                 self.pendingResponse = ResponseOK
                 return
             if cmd == RequestEnv:
                 env = eval(arg.replace("u'", "'"))
                 for key, value in env.items():
                     if key.endswith("+"):
                         if key[:-1] in os.environ:
                             os.environ[key[:-1]] += value
                         else:
                             os.environ[key[:-1]] = value
                     else:
                         os.environ[key] = value
                 return
             if cmd == RequestLoad:
                 self.fncache = {}
                 self.dircache = []
                 sys.argv = []
                 wd, fn, args, tracePython = arg.split('|')
                 self.__setCoding(fn)
                 try:
                     sys.setappdefaultencoding(self.__coding)
                 except AttributeError:
                     pass
                 sys.argv.append(fn)
                 sys.argv.extend(eval(args.replace("u'", "'")))
                 sys.path = self.__getSysPath(os.path.dirname(sys.argv[0]))
                 if wd == '':
                     os.chdir(sys.path[1])
                 else:
                     os.chdir(wd)
                 tracePython = int(tracePython)
                 self.running = sys.argv[0]
                 self.mainFrame = None
                 self.inRawMode = False
                 self.debugging = True
                 self.threads.clear()
                 self.attachThread(mainThread = True)
                 # set the system exception handling function to ensure, that
                 # we report on all unhandled exceptions
                 sys.excepthook = self.__unhandled_exception
                 # clear all old breakpoints, they'll get set after we have started
                 self.mainThread.clear_all_breaks()
                 self.mainThread.tracePython = tracePython
                 # This will eventually enter a local event loop.
                 # Note the use of backquotes to cause a repr of self.running. The
                 # need for this is on Windows os where backslash is the path separator.
                 # They will get inadvertantly stripped away during the eval causing
                 # IOErrors, if self.running is passed as a normal str.
                 self.debugMod.__dict__['__file__'] = self.running
                 sys.modules['__main__'] = self.debugMod
                 code = self.__compileFileSource(self.running)
                 if code:
                     res = self.mainThread.run(code, self.debugMod.__dict__)
                     self.progTerminated(res)
                 return
             if cmd == RequestRun:
                 sys.argv = []
                 wd, fn, args = arg.split('|')
                 self.__setCoding(fn)
                 try:
                     sys.setappdefaultencoding(self.__coding)
                 except AttributeError:
                     pass
                 sys.argv.append(fn)
                 sys.argv.extend(eval(args.replace("u'", "'")))
                 sys.path = self.__getSysPath(os.path.dirname(sys.argv[0]))
                 if wd == '':
                     os.chdir(sys.path[1])
                 else:
                     os.chdir(wd)
                 self.running = sys.argv[0]
                 self.mainFrame = None
                 self.botframe = None
                 self.inRawMode = False
                 self.threads.clear()
                 self.attachThread(mainThread = True)
                 # set the system exception handling function to ensure, that
                 # we report on all unhandled exceptions
                 sys.excepthook = self.__unhandled_exception
                 self.mainThread.tracePython = False
                 self.debugMod.__dict__['__file__'] = sys.argv[0]
                 sys.modules['__main__'] = self.debugMod
                 exec(open(sys.argv[0]).read(), self.debugMod.__dict__)
                 self.writestream.flush()
                 return
             if cmd == RequestProfile:
                 sys.setprofile(None)
                 import PyProfile
                 sys.argv = []
                 wd, fn, args, erase = arg.split('|')
                 self.__setCoding(fn)
                 try:
                     sys.setappdefaultencoding(self.__coding)
                 except AttributeError:
                     pass
                 sys.argv.append(fn)
                 sys.argv.extend(eval(args.replace("u'", "'")))
                 sys.path = self.__getSysPath(os.path.dirname(sys.argv[0]))
                 if wd == '':
                     os.chdir(sys.path[1])
                 else:
                     os.chdir(wd)
                 # set the system exception handling function to ensure, that
                 # we report on all unhandled exceptions
                 sys.excepthook = self.__unhandled_exception
                 # generate a profile object
                 self.prof = PyProfile.PyProfile(sys.argv[0])
                 if int(erase):
                     self.prof.erase()
                 self.debugMod.__dict__['__file__'] = sys.argv[0]
                 sys.modules['__main__'] = self.debugMod
                 fp = open(sys.argv[0])
                 try:
                     script = fp.read()
                 finally:
                     fp.close()
                 if script:
                     self.prof.run("exec({0!r}\n)".format(script))
                     self.prof.save()
                     self.writestream.flush()
                 return
             if cmd == RequestCoverage:
                 from coverage import coverage
                 sys.argv = []
                 wd, fn, args, erase = arg.split('@@')
                 self.__setCoding(fn)
                 try:
                     sys.setappdefaultencoding(self.__coding)
                 except AttributeError:
                     pass
                 sys.argv.append(fn)
                 sys.argv.extend(eval(args.replace("u'", "'")))
                 sys.path = self.__getSysPath(os.path.dirname(sys.argv[0]))
                 if wd == '':
                     os.chdir(sys.path[1])
                 else:
                     os.chdir(wd)
                 # set the system exception handling function to ensure, that
                 # we report on all unhandled exceptions
                 sys.excepthook = self.__unhandled_exception
                 # generate a coverage object
                 self.cover = coverage(auto_data = True,
                     data_file = "{0}.coverage".format(os.path.splitext(sys.argv[0])[0]))
                 self.cover.use_cache(True)
                 if int(erase):
                     self.cover.erase()
                 sys.modules['__main__'] = self.debugMod
                 self.debugMod.__dict__['__file__'] = sys.argv[0]
                 self.cover.start()
                 exec(open(sys.argv[0]).read(), self.debugMod.__dict__)
                 self.cover.stop()
                 self.cover.save()
                 self.writestream.flush()
                 return
             if cmd == RequestShutdown:
                 self.sessionClose()
                 return
             if cmd == RequestBreak:
                 fn, line, temporary, set, cond = arg.split('@@')
                 line = int(line)
                 set = int(set)
                 temporary = int(temporary)
                 if set:
                     if cond == 'None' or cond == '':
                         cond = None
                     else:
                         try:
                             compile(cond, '<string>', 'eval')
                         except SyntaxError:
                             self.write('{0}{1},{2:d}\n'.format(
                                        ResponseBPConditionError, fn, line))
                             return
                     self.mainThread.set_break(fn, line, temporary, cond)
                 else:
                     self.mainThread.clear_break(fn, line)
                 return
             if cmd == RequestBreakEnable:
                 fn, line, enable = arg.split(',')
                 line = int(line)
                 enable = int(enable)
                 bp = self.mainThread.get_break(fn, line)
                 if bp is not None:
                     if enable:
                         bp.enable()
                     else:
                         bp.disable()
                 return
             if cmd == RequestBreakIgnore:
                 fn, line, count = arg.split(',')
                 line = int(line)
                 count = int(count)
                 bp = self.mainThread.get_break(fn, line)
                 if bp is not None:
                     bp.ignore = count
                 return
             if cmd == RequestWatch:
                 cond, temporary, set = arg.split('@@')
                 set = int(set)
                 temporary = int(temporary)
                 if set:
                     if not cond.endswith('??created??') and \
                        not cond.endswith('??changed??'):
                         try:
                             compile(cond, '<string>', 'eval')
                         except SyntaxError:
                             self.write('{0}{1}\n'.format(ResponseWPConditionError, cond))
                             return
                     self.mainThread.set_watch(cond, temporary)
                 else:
                     self.mainThread.clear_watch(cond)
                 return
             if cmd == RequestWatchEnable:
                 cond, enable = arg.split(',')
                 enable = int(enable)
                 bp = self.mainThread.get_watch(cond)
                 if bp is not None:
                     if enable:
                         bp.enable()
                     else:
                         bp.disable()
                 return
             if cmd == RequestWatchIgnore:
                 cond, count = arg.split(',')
                 count = int(count)
                 bp = self.mainThread.get_watch(cond)
                 if bp is not None:
                     bp.ignore = count
                 return
             if cmd == RequestEval:
                 try:
                     value = eval(arg, self.currentThread.getCurrentFrame().f_globals,
                                       self.currentThread.getCurrentFrame().f_locals)
                 except:
                     # Report the exception and the traceback
                     try:
                         type, value, tb = sys.exc_info()
                         sys.last_type = type
                         sys.last_value = value
                         sys.last_traceback = tb
                         tblist = traceback.extract_tb(tb)
                         del tblist[:1]
                         list = traceback.format_list(tblist)
                         if list:
                             list.insert(0, "Traceback (innermost last):\n")
                             list[len(list):] = \
                                 traceback.format_exception_only(type, value)
                     finally:
                         tblist = tb = None
                     for l in list:
                         self.write(l)
                     self.write(ResponseException + '\n')
                 else:
                     self.write(str(value) + '\n')
                     self.write(ResponseOK + '\n')
                 return
             if cmd == RequestExec:
                 _globals = self.currentThread.getCurrentFrame().f_globals
                 _locals = self.currentThread.getCurrentFrame().f_locals
                 try:
                     code = compile(arg + '\n', '<stdin>', 'single')
                     exec(code, _globals, _locals)
                 except:
                     # Report the exception and the traceback
                     try:
                         type, value, tb = sys.exc_info()
                         sys.last_type = type
                         sys.last_value = value
                         sys.last_traceback = tb
                         tblist = traceback.extract_tb(tb)
                         del tblist[:1]
                         list = traceback.format_list(tblist)
                         if list:
                             list.insert(0, "Traceback (innermost last):\n")
                             list[len(list):] = \
                                 traceback.format_exception_only(type, value)
                     finally:
                         tblist = tb = None
                     for l in list:
                         self.write(l)
                     self.write(ResponseException + '\n')
                 return
             if cmd == RequestBanner:
                 self.write('{0}{1}\n'.format(ResponseBanner,
                     str(("Python {0}".format(sys.version),
                          socket.gethostname(), self.variant))))
                 return
             if cmd == RequestCapabilities:
                 self.write('{0}{1:d}, "Python3"\n'.format(ResponseCapabilities,
                     self.__clientCapabilities()))
                 return
             if cmd == RequestCompletion:
                 self.__completionList(arg.replace("u'", "'"))
                 return
             if cmd == RequestSetFilter:
                 scope, filterString = eval(arg.replace("u'", "'"))
                 self.__generateFilterObjects(int(scope), filterString)
                 return
             if cmd == RequestUTPrepare:
                 fn, tn, tfn, cov, covname, erase = arg.split('|')
                 sys.path.insert(0, os.path.dirname(os.path.abspath(fn)))
                 os.chdir(sys.path[0])
                 # set the system exception handling function to ensure, that
                 # we report on all unhandled exceptions
                 sys.excepthook = self.__unhandled_exception
                 try:
                     import unittest
                     utModule = imp.load_source(tn, fn)
                     try:
                         self.test = unittest.defaultTestLoader\
                                     .loadTestsFromName(tfn, utModule)
                     except AttributeError:
                         self.test = unittest.defaultTestLoader\
                                     .loadTestsFromModule(utModule)
                 except:
                     exc_type, exc_value, exc_tb = sys.exc_info()
                     self.write('{0}{1}\n'.format(ResponseUTPrepared,
                         str((0, str(exc_type), str(exc_value)))))
                     self.__exceptionRaised()
                     return
                 # generate a coverage object
                 if int(cov):
                     from coverage import coverage
                     self.cover = coverage(auto_data = True,
                         data_file = "{0}.coverage".format(os.path.splitext(covname)[0]))
                     self.cover.use_cache(True)
                     if int(erase):
                         self.cover.erase()
                 else:
                     self.cover = None
                 self.write('{0}{1}\n'.format(ResponseUTPrepared,
                     str((self.test.countTestCases(), "", ""))))
                 return
             if cmd == RequestUTRun:
                 from DCTestResult import DCTestResult
                 self.testResult = DCTestResult(self)
                 if self.cover:
                     self.cover.start()
                 self.test.run(self.testResult)
                 if self.cover:
                     self.cover.stop()
                     self.cover.save()
                 self.write('{0}\n'.format(ResponseUTFinished))
                 return
             if cmd == RequestUTStop:
                 self.testResult.stop()
                 return
             if cmd == ResponseForkTo:
                 # this results from a separate event loop
                 self.fork_child = (arg == 'child')
                 self.eventExit = True
                 return
             if cmd == RequestForkMode:
                 self.fork_auto, self.fork_child = eval(arg)
                 return
         # If we are handling raw mode input then reset the mode and break out
         # of the current event loop.
         if self.inRawMode:
             self.inRawMode = False
             self.rawLine = line
             self.eventExit = True
             return
         if self.buffer:
             self.buffer = self.buffer + '\n' + line
         else:
             self.buffer = line
         try:
             code = self.compile_command(self.buffer, self.readstream.name)
         except (OverflowError, SyntaxError, ValueError):
             # Report the exception
             sys.last_type, sys.last_value, sys.last_traceback = sys.exc_info()
             for l in traceback.format_exception_only(sys.last_type, sys.last_value):
                 self.write(l)
             self.buffer = ''
             self.__exceptionRaised()
         else:
             if code is None:
                 self.pendingResponse = ResponseContinue
             else:
                 self.buffer = ''
                 try:
                     if self.running is None:
                         exec(code, self.debugMod.__dict__)
                     else:
                         if self.currentThread is None:
                             # program has terminated
                             self.running = None
                             _globals = self.debugMod.__dict__
                             _locals = _globals
                         else:
                             cf = self.currentThread.getCurrentFrame()
                             # program has terminated
                             if cf is None:
                                 self.running = None
                                 _globals = self.debugMod.__dict__
                                 _locals = _globals
                             else:
                                 frmnr = self.framenr
                                 while cf is not None and frmnr > 0:
                                     cf = cf.f_back
                                     frmnr -= 1
                                 _globals = cf.f_globals
                                 _locals = cf.f_locals
                         # reset sys.stdout to our redirector (unconditionally)
                         if "sys" in _globals:
                             __stdout = _globals["sys"].stdout
                             _globals["sys"].stdout = self.writestream
                             exec(code, _globals, _locals)
                             _globals["sys"].stdout = __stdout
                         elif "sys" in _locals:
                             __stdout = _locals["sys"].stdout
                             _locals["sys"].stdout = self.writestream
                             exec(code, _globals, _locals)
                             _locals["sys"].stdout = __stdout
                         else:
                             exec(code, _globals, _locals)
                 except SystemExit as exc:
                     self.progTerminated(exc.code)
                 except:
                     # Report the exception and the traceback
                     try:
                         exc_type, exc_value, exc_tb = sys.exc_info()
                         sys.last_type = exc_type
                         sys.last_value = exc_value
                         sys.last_traceback = exc_tb
                         tblist = traceback.extract_tb(exc_tb)
                         del tblist[:1]
                         list = traceback.format_list(tblist)
                         if list:
                             list.insert(0, "Traceback (innermost last):\n")
                             list[len(list):] = \
                                 traceback.format_exception_only(exc_type, exc_value)
                     finally:
                         tblist = exc_tb = None
                     for l in list:
                         self.write(l)
                     self.__exceptionRaised()
     def __clientCapabilities(self):
         """
         Private method to determine the clients capabilities.
         @return client capabilities (integer)
         """
         try:
             import PyProfile
             try:
                 del sys.modules['PyProfile']
             except KeyError:
                 pass
             return self.clientCapabilities
         except ImportError:
             return self.clientCapabilities & ~DebugClientCapabilities.HasProfiler
     def write(self,s):
         """
         Public method to write data to the output stream.
         @param s data to be written (string)
         """
         self.writestream.write(s)
         self.writestream.flush()
     def __interact(self):
         """
         Private method to Interact with  the debugger.
         """
         global DebugClientInstance
         self.setDescriptors(self.readstream, self.writestream)
         DebugClientInstance = self
         if not self.passive:
             # At this point simulate an event loop.
             self.eventLoop()
     def eventLoop(self, disablePolling = False):
         """
         Public method implementing our event loop.
         @param disablePolling flag indicating to enter an event loop with
             polling disabled (boolean)
         """
         self.eventExit = None
         self.pollingDisabled = disablePolling
         while self.eventExit is None:
             wrdy = []
             if AsyncPendingWrite(self.writestream):
                 wrdy.append(self.writestream)
             if AsyncPendingWrite(self.errorstream):
                 wrdy.append(self.errorstream)
             try:
                 rrdy, wrdy, xrdy = select.select([self.readstream], wrdy, [])
             except (select.error, KeyboardInterrupt, socket.error):
                 # just carry on
                 continue
             if self.readstream in rrdy:
                 self.readReady(self.readstream.fileno())
             if self.writestream in wrdy:
                 self.writeReady(self.writestream.fileno())
             if self.errorstream in wrdy:
                 self.writeReady(self.errorstream.fileno())
         self.eventExit = None
         self.pollingDisabled = False
     def eventPoll(self):
         """
         Public method to poll for events like 'set break point'.
         """
         if self.pollingDisabled:
             return
         # the choice of a ~0.5 second poll interval is arbitrary.
         lasteventpolltime = getattr(self, 'lasteventpolltime', time.time())
         now = time.time()
         if now - lasteventpolltime < 0.5:
             self.lasteventpolltime = lasteventpolltime
             return
         else:
             self.lasteventpolltime = now
         wrdy = []
         if AsyncPendingWrite(self.writestream):
             wrdy.append(self.writestream)
         if AsyncPendingWrite(self.errorstream):
             wrdy.append(self.errorstream)
         # immediate return if nothing is ready.
         try:
             rrdy, wrdy, xrdy = select.select([self.readstream], wrdy, [], 0)
         except (select.error, KeyboardInterrupt, socket.error):
             return
         if self.readstream in rrdy:
             self.readReady(self.readstream.fileno())
         if self.writestream in wrdy:
             self.writeReady(self.writestream.fileno())
         if self.errorstream in wrdy:
             self.writeReady(self.errorstream.fileno())
     def connectDebugger(self, port, remoteAddress = None, redirect = True):
         """
         Public method to establish a session with the debugger.
         It opens a network connection to the debugger, connects it to stdin,
         stdout and stderr and saves these file objects in case the application
         being debugged redirects them itself.
         @param port the port number to connect to (int)
         @param remoteAddress the network address of the debug server host (string)
         @param redirect flag indicating redirection of stdin, stdout and stderr (boolean)
         """
         if remoteAddress is None:                               # default: 127.0.0.1
             sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
             sock.connect((DebugAddress, port))
         elif ":" in remoteAddress:                              # IPv6
             sock = socket.socket(socket.AF_INET6, socket.SOCK_STREAM)
             sock.connect((remoteAddress, port))
         else:                                                   # IPv4
             sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
             sock.connect((remoteAddress, port))
         self.readstream = AsyncFile(sock, sys.stdin.mode, sys.stdin.name)
         self.writestream = AsyncFile(sock, sys.stdout.mode, sys.stdout.name)
         self.errorstream = AsyncFile(sock, sys.stderr.mode, sys.stderr.name)
         if redirect:
             sys.stdin = self.readstream
             sys.stdout = self.writestream
             sys.stderr = self.errorstream
         self.redirect = redirect
         # attach to the main thread here
         self.attachThread(mainThread = True)
     def __unhandled_exception(self, exctype, excval, exctb):
         """
         Private method called to report an uncaught exception.
         @param exctype the type of the exception
         @param excval data about the exception
         @param exctb traceback for the exception
         """
         self.mainThread.user_exception(None, (exctype, excval, exctb), True)
     def absPath(self, fn):
         """
         Public method to convert a filename to an absolute name.
         sys.path is used as a set of possible prefixes. The name stays
         relative if a file could not be found.
         @param fn filename (string)
         @return the converted filename (string)
         """
         if os.path.isabs(fn):
             return fn
         # Check the cache.
         if fn in self.fncache:
             return self.fncache[fn]
         # Search sys.path.
         for p in sys.path:
             afn = os.path.abspath(os.path.join(p, fn))
             afn = os.path.normcase(afn)
             if os.path.exists(afn):
                 self.fncache[fn] = afn
                 d = os.path.dirname(afn)
                 if (d not in sys.path) and (d not in self.dircache):
                     self.dircache.append(d)
                 return afn
         # Search the additional directory cache
         for p in self.dircache:
             afn = os.path.abspath(os.path.join(p, fn))
             afn = os.path.normcase(afn)
             if os.path.exists(afn):
                 self.fncache[fn] = afn
                 return afn
         # Nothing found.
         return fn
     def shouldSkip(self, fn):
         """
         Public method to check if a file should be skipped.
         @param fn filename to be checked
         @return non-zero if fn represents a file we are 'skipping', zero otherwise.
         """
         if self.mainThread.tracePython:     # trace into Python library
             return False
         # Eliminate anything that is part of the Python installation.
         afn = self.absPath(fn)
         for d in self.skipdirs:
             if afn.startswith(d):
                 return True
         return False
     def getRunning(self):
         """
         Public method to return the main script we are currently running.
         """
 de9c2efb9d02
Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>
parents: 
diff
changeset

Mercurial Repositories > eric / annotate

DebugClients/Python3/DebugClientBase.py@015c7e35bd84 (annotated)

DebugClients/Python3/DebugClientBase.py