--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/DebugClients/Python/DebugClientBase.py Mon Sep 19 22:47:52 2016 +0200
@@ -0,0 +1,2086 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2009 - 2016 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 json
+import imp
+import re
+import atexit
+import signal
+
+
+import DebugClientCapabilities
+import DebugVariables
+from DebugBase import setRecursionLimit, printerr # __IGNORE_WARNING__
+from AsyncFile import AsyncFile, AsyncPendingWrite
+from DebugConfig import ConfigVarTypeStrings
+from FlexCompleter import Completer
+from DebugUtilities import getargvalues, formatargvalues, prepareJsonCommand
+from BreakpointWatch import Breakpoint, Watch
+
+
+DebugClientInstance = None
+
+###############################################################################
+
+
+def DebugClientInput(prompt="", echo=True):
+ """
+ Replacement for the standard input builtin.
+
+ This function works with the split debugger.
+
+ @param prompt prompt to be shown (string)
+ @param echo flag indicating to echo the output (boolean)
+ @return result of the input() call
+ """
+ if DebugClientInstance is None or not DebugClientInstance.redirect:
+ return DebugClientOrigInput(prompt)
+
+ return DebugClientInstance.input(prompt, echo)
+
+# 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().
+
+ @return result of the fork() call
+ """
+ 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.
+
+ The protocol between the debugger and the client is based on JSONRPC 2.0
+ PDUs. Each one is sent on a single line, i.e. commands or responses are
+ separated by a linefeed character.
+
+ 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
+
+ # keep these in sync with VariablesViewer.VariableItem.Indicators
+ Indicators = ("()", "[]", "{:}", "{}") # __IGNORE_WARNING__
+
+ def __init__(self):
+ """
+ Constructor
+ """
+ self.breakpoints = {}
+ self.redirect = True
+ self.__receiveBuffer = ""
+
+ # 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__')
+ self.debugMod.__dict__['__builtins__'] = __builtins__
+
+ # The list of complete lines to execute.
+ self.buffer = ''
+
+ # The list of regexp objects to filter variables against
+ self.globalsFilterObjects = []
+ self.localsFilterObjects = []
+
+ self._fncache = {}
+ self.dircache = []
+ self.passive = False # used to indicate the passive mode
+ self.running = None
+ self.test = None
+ self.debugging = False
+
+ self.fork_auto = False
+ self.fork_child = False
+
+ self.readstream = None
+ self.writestream = None
+ self.errorstream = None
+ self.pollingDisabled = False
+
+ self.callTraceEnabled = None
+
+ 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 True, 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
+ """
+ pass
+
+ def __dumpThreadList(self):
+ """
+ Private method to send the list of threads.
+ """
+ threadList = []
+ if self.threads and self.currentThread:
+ # 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"
+ if hasattr(self, "isBroken"):
+ d["broken"] = self.isBroken()
+ else:
+ d["broken"] = False
+ threadList.append(d)
+
+ self.sendJsonCommand("ResponseThreadList", {
+ "currentID": currentId,
+ "threadList": threadList,
+ })
+
+ def input(self, prompt, echo=True):
+ """
+ Public method to implement input() using the event loop.
+
+ @param prompt the prompt to be shown (string)
+ @param echo Flag indicating echoing of the input (boolean)
+ @return the entered string
+ """
+ self.sendJsonCommand("RequestRaw", {
+ "prompt": prompt,
+ "echo": echo,
+ })
+ self.eventLoop(True)
+ return self.rawLine
+
+ 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 Exception:
+ pass
+
+ 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, encoding=self.__coding) as fp:
+ statement = fp.read()
+
+ try:
+ code = compile(statement + '\n', filename, mode)
+ except SyntaxError:
+ exctype, excval, exctb = sys.exc_info()
+ try:
+ message = str(excval)
+ filename = excval.filename
+ lineno = excval.lineno
+ charno = excval.offset
+ except (AttributeError, ValueError):
+ message = ""
+ filename = ""
+ lineno = 0
+ charno = 0
+ self.sendSyntaxError(message, filename, lineno, charno)
+ 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
+
+ self.handleJsonCommand(line)
+
+ def handleJsonCommand(self, jsonStr):
+ """
+ Public method to handle a command serialized as a JSON string.
+
+ @param jsonStr string containing the command received from the IDE
+ @type str
+ """
+ try:
+ commandDict = json.loads(jsonStr.strip())
+ except (TypeError, ValueError) as err:
+ printerr(str(err))
+ return
+
+ method = commandDict["method"]
+ params = commandDict["params"]
+
+ if method == "RequestVariables":
+ self.__dumpVariables(
+ params["frameNumber"], params["scope"], params["filters"])
+
+ elif method == "RequestVariable":
+ self.__dumpVariable(
+ params["variable"], params["frameNumber"],
+ params["scope"], params["filters"])
+
+ elif method == "RequestThreadList":
+ self.__dumpThreadList()
+
+ elif method == "RequestThreadSet":
+ if params["threadID"] in self.threads:
+ self.setCurrentThread(params["threadID"])
+ self.sendJsonCommand("ResponseThreadSet", {})
+ stack = self.currentThread.getStack()
+ self.sendJsonCommand("ResponseStack", {
+ "stack": stack,
+ })
+
+ elif method == "RequestCapabilities":
+ self.sendJsonCommand("ResponseCapabilities", {
+ "capabilities": self.__clientCapabilities(),
+ "clientType": "Python3"
+ })
+
+ elif method == "RequestBanner":
+ self.sendJsonCommand("ResponseBanner", {
+ "version": "Python {0}".format(sys.version),
+ "platform": socket.gethostname(),
+ "dbgclient": self.variant,
+ })
+
+ elif method == "RequestSetFilter":
+ self.__generateFilterObjects(params["scope"], params["filter"])
+
+ elif method == "RequestCallTrace":
+ if params["enable"]:
+ callTraceEnabled = self.profile
+ else:
+ callTraceEnabled = None
+
+ if self.debugging:
+ sys.setprofile(callTraceEnabled)
+ else:
+ # remember for later
+ self.callTraceEnabled = callTraceEnabled
+
+ elif method == "RequestEnvironment":
+ for key, value in params["environment"].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
+
+ elif method == "RequestLoad":
+ self._fncache = {}
+ self.dircache = []
+ sys.argv = []
+ self.__setCoding(params["filename"])
+ sys.argv.append(params["filename"])
+ sys.argv.extend(params["argv"])
+ sys.path = self.__getSysPath(os.path.dirname(sys.argv[0]))
+ if params["workdir"] == '':
+ os.chdir(sys.path[1])
+ else:
+ os.chdir(params["workdir"])
+
+ self.running = sys.argv[0]
+ self.mainFrame = None
+ self.debugging = True
+
+ self.fork_auto = params["autofork"]
+ self.fork_child = params["forkChild"]
+
+ 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.__interceptSignals()
+
+ # clear all old breakpoints, they'll get set after we have
+ # started
+ Breakpoint.clear_all_breaks()
+ Watch.clear_all_watches()
+
+ self.mainThread.tracePythonLibs(params["traceInterpreter"])
+
+ # This will eventually enter a local event loop.
+ self.debugMod.__dict__['__file__'] = self.running
+ sys.modules['__main__'] = self.debugMod
+ code = self.__compileFileSource(self.running)
+ if code:
+ sys.setprofile(self.callTraceEnabled)
+ res = self.mainThread.run(code, self.debugMod.__dict__)
+ self.progTerminated(res)
+
+ elif method == "RequestRun":
+ sys.argv = []
+ self.__setCoding(params["filename"])
+ sys.argv.append(params["filename"])
+ sys.argv.extend(params["argv"])
+ sys.path = self.__getSysPath(os.path.dirname(sys.argv[0]))
+ if params["workdir"] == '':
+ os.chdir(sys.path[1])
+ else:
+ os.chdir(params["workdir"])
+
+ self.running = sys.argv[0]
+ self.mainFrame = None
+ self.botframe = None
+
+ self.fork_auto = params["autofork"]
+ self.fork_child = params["forkChild"]
+
+ 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.__interceptSignals()
+
+ self.mainThread.tracePythonLibs(False)
+
+ self.debugMod.__dict__['__file__'] = sys.argv[0]
+ sys.modules['__main__'] = self.debugMod
+ res = 0
+ code = self.__compileFileSource(self.running)
+ if code:
+ try:
+ exec(code, self.debugMod.__dict__)
+ except SystemExit as exc:
+ res = exc.code
+ atexit._run_exitfuncs()
+ self.writestream.flush()
+ self.progTerminated(res)
+
+ elif method == "RequestCoverage":
+ from coverage import coverage
+ sys.argv = []
+ self.__setCoding(params["filename"])
+ sys.argv.append(params["filename"])
+ sys.argv.extend(params["argv"])
+ sys.path = self.__getSysPath(os.path.dirname(sys.argv[0]))
+ if params["workdir"] == '':
+ os.chdir(sys.path[1])
+ else:
+ os.chdir(params["workdir"])
+
+ # set the system exception handling function to ensure, that
+ # we report on all unhandled exceptions
+ sys.excepthook = self.__unhandled_exception
+ self.__interceptSignals()
+
+ # generate a coverage object
+ self.cover = coverage(
+ auto_data=True,
+ data_file="{0}.coverage".format(
+ os.path.splitext(sys.argv[0])[0]))
+
+ if params["erase"]:
+ self.cover.erase()
+ sys.modules['__main__'] = self.debugMod
+ self.debugMod.__dict__['__file__'] = sys.argv[0]
+ fp = open(sys.argv[0], encoding=self.__coding)
+ try:
+ script = fp.read()
+ finally:
+ fp.close()
+ if script:
+ if not script.endswith('\n'):
+ script += '\n'
+ code = compile(script, sys.argv[0], 'exec')
+ self.running = sys.argv[0]
+ res = 0
+ self.cover.start()
+ try:
+ exec(code, self.debugMod.__dict__)
+ except SystemExit as exc:
+ res = exc.code
+ atexit._run_exitfuncs()
+ self.cover.stop()
+ self.cover.save()
+ self.writestream.flush()
+ self.progTerminated(res)
+
+ elif method == "RequestProfile":
+ sys.setprofile(None)
+ import PyProfile
+ sys.argv = []
+ self.__setCoding(params["filename"])
+ sys.argv.append(params["filename"])
+ sys.argv.extend(params["argv"])
+ sys.path = self.__getSysPath(os.path.dirname(sys.argv[0]))
+ if params["workdir"] == '':
+ os.chdir(sys.path[1])
+ else:
+ os.chdir(params["workdir"])
+
+ # set the system exception handling function to ensure, that
+ # we report on all unhandled exceptions
+ sys.excepthook = self.__unhandled_exception
+ self.__interceptSignals()
+
+ # generate a profile object
+ self.prof = PyProfile.PyProfile(sys.argv[0])
+
+ if params["erase"]:
+ self.prof.erase()
+ self.debugMod.__dict__['__file__'] = sys.argv[0]
+ sys.modules['__main__'] = self.debugMod
+ fp = open(sys.argv[0], encoding=self.__coding)
+ try:
+ script = fp.read()
+ finally:
+ fp.close()
+ if script:
+ if not script.endswith('\n'):
+ script += '\n'
+ self.running = sys.argv[0]
+ res = 0
+ try:
+ self.prof.run(script)
+ except SystemExit as exc:
+ res = exc.code
+ atexit._run_exitfuncs()
+ self.prof.save()
+ self.writestream.flush()
+ self.progTerminated(res)
+
+ elif method == "ExecuteStatement":
+ if self.buffer:
+ self.buffer = self.buffer + '\n' + params["statement"]
+ else:
+ self.buffer = params["statement"]
+
+ 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()
+ self.sendJsonCommand("ClientOutput", {
+ "text": "".join(traceback.format_exception_only(
+ sys.last_type, sys.last_value))
+ })
+ self.buffer = ''
+ else:
+ if code is None:
+ self.sendJsonCommand("ResponseContinue", {})
+ return
+ 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 = \
+ self.currentThread.getFrameLocals(
+ self.framenr)
+ # 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)
+
+ self.currentThread.storeFrameLocals(self.framenr)
+ except SystemExit as exc:
+ self.progTerminated(exc.code)
+ except Exception:
+ # Report the exception and the traceback
+ tlist = []
+ 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]
+ tlist = traceback.format_list(tblist)
+ if tlist:
+ tlist.insert(
+ 0, "Traceback (innermost last):\n")
+ tlist.extend(traceback.format_exception_only(
+ exc_type, exc_value))
+ finally:
+ tblist = exc_tb = None
+
+ self.sendJsonCommand("ClientOutput", {
+ "text": "".join(tlist)
+ })
+
+ self.sendJsonCommand("ResponseOK", {})
+
+ elif method == "RequestStep":
+ self.currentThread.step(True)
+ self.eventExit = True
+
+ elif method == "RequestStepOver":
+ self.currentThread.step(False)
+ self.eventExit = True
+
+ elif method == "RequestStepOut":
+ self.currentThread.stepOut()
+ self.eventExit = True
+
+ elif method == "RequestStepQuit":
+ if self.passive:
+ self.progTerminated(42)
+ else:
+ self.set_quit()
+ self.eventExit = True
+
+ elif method == "RequestContinue":
+ self.currentThread.go(params["special"])
+ self.eventExit = True
+
+ elif method == "RawInput":
+ # If we are handling raw mode input then break out of the current
+ # event loop.
+ self.rawLine = params["input"]
+ self.eventExit = True
+
+ elif method == "RequestBreakpoint":
+ if params["setBreakpoint"]:
+ if params["condition"] in ['None', '']:
+ cond = None
+ elif params["condition"] is not None:
+ try:
+ cond = compile(params["condition"], '<string>', 'eval')
+ except SyntaxError:
+ self.sendJsonCommand("ResponseBPConditionError", {
+ "filename": params["filename"],
+ "line": params["line"],
+ })
+ return
+ else:
+ cond = None
+
+ Breakpoint(
+ params["filename"], params["line"], params["temporary"],
+ cond)
+ else:
+ Breakpoint.clear_break(params["filename"], params["line"])
+
+ elif method == "RequestBreakpointEnable":
+ bp = Breakpoint.get_break(params["filename"], params["line"])
+ if bp is not None:
+ if params["enable"]:
+ bp.enable()
+ else:
+ bp.disable()
+
+ elif method == "RequestBreakpointIgnore":
+ bp = Breakpoint.get_break(params["filename"], params["line"])
+ if bp is not None:
+ bp.ignore = params["count"]
+
+ elif method == "RequestWatch":
+ if params["setWatch"]:
+ if params["condition"].endswith(
+ ('??created??', '??changed??')):
+ compiledCond, flag = params["condition"].split()
+ else:
+ compiledCond = params["condition"]
+ flag = ''
+
+ try:
+ compiledCond = compile(
+ compiledCond, '<string>', 'eval')
+ except SyntaxError:
+ self.sendJsonCommand("ResponseWatchConditionError", {
+ "condition": params["condition"],
+ })
+ return
+ Watch(
+ params["condition"], compiledCond, flag,
+ params["temporary"])
+ else:
+ Watch.clear_watch(params["condition"])
+
+ elif method == "RequestWatchEnable":
+ wp = Watch.get_watch(params["condition"])
+ if wp is not None:
+ if params["enable"]:
+ wp.enable()
+ else:
+ wp.disable()
+
+ elif method == "RequestWatchIgnore":
+ wp = Watch.get_watch(params["condition"])
+ if wp is not None:
+ wp.ignore = params["count"]
+
+ elif method == "RequestShutdown":
+ self.sessionClose()
+
+ elif method == "RequestCompletion":
+ self.__completionList(params["text"])
+
+ elif method == "RequestUTPrepare":
+ sys.path.insert(
+ 0, os.path.dirname(os.path.abspath(params["filename"])))
+ 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
+ self.__interceptSignals()
+
+ try:
+ import unittest
+ utModule = imp.load_source(
+ params["testname"], params["filename"])
+ try:
+ if params["failed"]:
+ self.test = unittest.defaultTestLoader\
+ .loadTestsFromNames(params["failed"], utModule)
+ else:
+ self.test = unittest.defaultTestLoader\
+ .loadTestsFromName(params["testfunctionname"],
+ utModule)
+ except AttributeError:
+ self.test = unittest.defaultTestLoader\
+ .loadTestsFromModule(utModule)
+ except Exception:
+ exc_type, exc_value, exc_tb = sys.exc_info()
+ self.sendJsonCommand("ResponseUTPrepared", {
+ "count": 0,
+ "exception": exc_type.__name__,
+ "message": str(exc_value),
+ })
+ return
+
+ # generate a coverage object
+ if params["coverage"]:
+ from coverage import coverage
+ self.cover = coverage(
+ auto_data=True,
+ data_file="{0}.coverage".format(
+ os.path.splitext(params["coveragefile"])[0]))
+ if params["coverageerase"]:
+ self.cover.erase()
+ else:
+ self.cover = None
+
+ self.sendJsonCommand("ResponseUTPrepared", {
+ "count": self.test.countTestCases(),
+ "exception": "",
+ "message": "",
+ })
+
+ elif method == "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.sendJsonCommand("ResponseUTFinished", {})
+
+ elif method == "RequestUTStop":
+ self.testResult.stop()
+
+ elif method == "ResponseForkTo":
+ # this results from a separate event loop
+ self.fork_child = (params["target"] == 'child')
+ self.eventExit = True
+
+ def sendJsonCommand(self, method, params):
+ """
+ Public method to send a single command or response to the IDE.
+
+ @param method command or response command name to be sent
+ @type str
+ @param params dictionary of named parameters for the command or
+ response
+ @type dict
+ """
+ cmd = prepareJsonCommand(method, params)
+
+ self.writestream.write_p(cmd)
+ self.writestream.flush()
+
+ def sendClearTemporaryBreakpoint(self, filename, lineno):
+ """
+ Public method to signal the deletion of a temporary breakpoint.
+
+ @param filename name of the file the bp belongs to
+ @type str
+ @param lineno linenumber of the bp
+ @type int
+ """
+ self.sendJsonCommand("ResponseClearBreakpoint", {
+ "filename": filename,
+ "line": lineno
+ })
+
+ def sendClearTemporaryWatch(self, condition):
+ """
+ Public method to signal the deletion of a temporary watch expression.
+
+ @param condition condition of the watch expression to be cleared
+ @type str
+ """
+ self.sendJsonCommand("ResponseClearWatch", {
+ "condition": condition,
+ })
+
+ def sendResponseLine(self, stack):
+ """
+ Public method to send the current call stack.
+
+ @param stack call stack
+ @type list
+ """
+ self.sendJsonCommand("ResponseLine", {
+ "stack": stack,
+ })
+
+ def sendCallTrace(self, event, fromInfo, toInfo):
+ """
+ Public method to send a call trace entry.
+
+ @param event trace event (call or return)
+ @type str
+ @param fromInfo dictionary containing the origin info
+ @type dict with 'filename', 'linenumber' and 'codename'
+ as keys
+ @param toInfo dictionary containing the target info
+ @type dict with 'filename', 'linenumber' and 'codename'
+ as keys
+ """
+ self.sendJsonCommand("CallTrace", {
+ "event": event[0],
+ "from": fromInfo,
+ "to": toInfo,
+ })
+
+ def sendException(self, exceptionType, exceptionMessage, stack):
+ """
+ Public method to send information for an exception.
+
+ @param exceptionType type of exception raised
+ @type str
+ @param exceptionMessage message of the exception
+ @type str
+ @param stack stack trace information
+ @type list
+ """
+ self.sendJsonCommand("ResponseException", {
+ "type": exceptionType,
+ "message": exceptionMessage,
+ "stack": stack,
+ })
+
+ def sendSyntaxError(self, message, filename, lineno, charno):
+ """
+ Public method to send information for a syntax error.
+
+ @param message syntax error message
+ @type str
+ @param filename name of the faulty file
+ @type str
+ @param lineno line number info
+ @type int
+ @param charno character number info
+ @type int
+ """
+ self.sendJsonCommand("ResponseSyntax", {
+ "message": message,
+ "filename": filename,
+ "linenumber": lineno,
+ "characternumber": charno,
+ })
+
+ def sendPassiveStartup(self, filename, exceptions):
+ """
+ Public method to send the passive start information.
+
+ @param filename name of the script
+ @type str
+ @param exceptions flag to enable exception reporting of the IDE
+ @type bool
+ """
+ self.sendJsonCommand("PassiveStartup", {
+ "filename": filename,
+ "exceptions": exceptions,
+ })
+
+ def __clientCapabilities(self):
+ """
+ Private method to determine the clients capabilities.
+
+ @return client capabilities (integer)
+ """
+ try:
+ import PyProfile # __IGNORE_WARNING__
+ try:
+ del sys.modules['PyProfile']
+ except KeyError:
+ pass
+ return self.clientCapabilities
+ except ImportError:
+ return (
+ self.clientCapabilities & ~DebugClientCapabilities.HasProfiler)
+
+ def readReady(self, stream):
+ """
+ Public method called when there is data ready to be read.
+
+ @param stream file like object that has data to be written
+ """
+ try:
+ got = stream.readline_p()
+ except Exception:
+ return
+
+ if len(got) == 0:
+ self.sessionClose()
+ return
+
+ self.__receiveBuffer = self.__receiveBuffer + got
+
+ # Call handleLine for the line if it is complete.
+ eol = self.__receiveBuffer.find('\n')
+ while eol >= 0:
+ line = self.__receiveBuffer[:eol + 1]
+ self.__receiveBuffer = self.__receiveBuffer[eol + 1:]
+ self.handleLine(line)
+ eol = self.__receiveBuffer.find('\n')
+
+ def writeReady(self, stream):
+ """
+ Public method called when we are ready to write data.
+
+ @param stream file like object that has data to be written
+ """
+ stream.write_p("")
+ stream.flush()
+
+ def __interact(self):
+ """
+ Private method to interact with the debugger.
+ """
+ global DebugClientInstance
+
+ DebugClientInstance = self
+ self.__receiveBuffer = ""
+
+ 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 self.writestream.nWriteErrors > self.writestream.maxtries:
+ break
+
+ 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)
+
+ if self.writestream in wrdy:
+ self.writeReady(self.writestream)
+
+ if self.errorstream in wrdy:
+ self.writeReady(self.errorstream)
+
+ self.eventExit = None
+ self.pollingDisabled = False
+
+ def eventPoll(self):
+ """
+ Public method to poll for events like 'set break point'.
+ """
+ if self.pollingDisabled:
+ return
+
+ 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)
+
+ if self.writestream in wrdy:
+ self.writeReady(self.writestream)
+
+ if self.errorstream in wrdy:
+ self.writeReady(self.errorstream)
+
+ 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:
+ remoteAddress = "127.0.0.1"
+ elif "@@i" in remoteAddress:
+ remoteAddress = remoteAddress.split("@@i")[0]
+ sock = socket.create_connection((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 __interceptSignals(self):
+ """
+ Private method to intercept common signals.
+ """
+ for signum in [
+ signal.SIGABRT, # abnormal termination
+ signal.SIGFPE, # floating point exception
+ signal.SIGILL, # illegal instruction
+ signal.SIGSEGV, # segmentation violation
+ ]:
+ signal.signal(signum, self.__signalHandler)
+
+ def __signalHandler(self, signalNumber, stackFrame):
+ """
+ Private method to handle signals.
+
+ @param signalNumber number of the signal to be handled
+ @type int
+ @param stackFrame current stack frame
+ @type frame object
+ """
+ if signalNumber == signal.SIGABRT:
+ message = "Abnormal Termination"
+ elif signalNumber == signal.SIGFPE:
+ message = "Floating Point Exception"
+ elif signalNumber == signal.SIGILL:
+ message = "Illegal Instruction"
+ elif signalNumber == signal.SIGSEGV:
+ message = "Segmentation Violation"
+ else:
+ message = "Unknown Signal '{0}'".format(signalNumber)
+
+ filename = self.absPath(stackFrame)
+
+ linenr = stackFrame.f_lineno
+ ffunc = stackFrame.f_code.co_name
+
+ if ffunc == '?':
+ ffunc = ''
+
+ if ffunc and not ffunc.startswith("<"):
+ argInfo = getargvalues(stackFrame)
+ try:
+ fargs = formatargvalues(
+ argInfo.args, argInfo.varargs,
+ argInfo.keywords, argInfo.locals)
+ except Exception:
+ fargs = ""
+ else:
+ fargs = ""
+
+ self.sendJsonCommand("ResponseSignal", {
+ "message": message,
+ "filename": filename,
+ "linenumber": linenr,
+ "function": ffunc,
+ "arguments": fargs,
+ })
+
+ 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))
+ nafn = os.path.normcase(afn)
+
+ if os.path.exists(nafn):
+ 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))
+ nafn = os.path.normcase(afn)
+
+ if os.path.exists(nafn):
+ self._fncache[fn] = afn
+ return afn
+
+ # Nothing found.
+ return fn
+
+ def getRunning(self):
+ """
+ Public method to return the main script we are currently running.
+
+ @return flag indicating a running debug session (boolean)
+ """
+ return self.running
+
+ def progTerminated(self, status, message=""):
+ """
+ Public method to tell the debugger that the program has terminated.
+
+ @param status return status
+ @type int
+ @param message status message
+ @type str
+ """
+ if status is None:
+ status = 0
+ elif not isinstance(status, int):
+ message = str(status)
+ status = 1
+
+ if self.running:
+ self.set_quit()
+ self.running = None
+ self.sendJsonCommand("ResponseExit", {
+ "status": status,
+ "message": message,
+ })
+
+ # reset coding
+ self.__coding = self.defaultCoding
+
+ def __dumpVariables(self, frmnr, scope, filter):
+ """
+ Private method to return the variables of a frame to the debug server.
+
+ @param frmnr distance of frame reported on. 0 is the current frame
+ (int)
+ @param scope 1 to report global variables, 0 for local variables (int)
+ @param filter the indices of variable types to be filtered
+ (list of int)
+ """
+ if self.currentThread is None:
+ return
+
+ frmnr += self.currentThread.skipFrames
+ if scope == 0:
+ self.framenr = frmnr
+
+ f = self.currentThread.getCurrentFrame()
+
+ while f is not None and frmnr > 0:
+ f = f.f_back
+ frmnr -= 1
+
+ if f is None:
+ if scope:
+ dict = self.debugMod.__dict__
+ else:
+ scope = -1
+ elif scope:
+ dict = f.f_globals
+ elif f.f_globals is f.f_locals:
+ scope = -1
+ else:
+ dict = f.f_locals
+
+ varlist = []
+
+ if scope != -1:
+ keylist = dict.keys()
+
+ vlist = self.__formatVariablesList(keylist, dict, scope, filter)
+ varlist.extend(vlist)
+
+ self.sendJsonCommand("ResponseVariables", {
+ "scope": scope,
+ "variables": varlist,
+ })
+
+ def __dumpVariable(self, var, frmnr, scope, filter):
+ """
+ Private method to return the variables of a frame to the debug server.
+
+ @param var list encoded name of the requested variable
+ (list of strings)
+ @param frmnr distance of frame reported on. 0 is the current frame
+ (int)
+ @param scope 1 to report global variables, 0 for local variables (int)
+ @param filter the indices of variable types to be filtered
+ (list of int)
+ """
+ if self.currentThread is None:
+ return
+
+ frmnr += self.currentThread.skipFrames
+ f = self.currentThread.getCurrentFrame()
+
+ while f is not None and frmnr > 0:
+ f = f.f_back
+ frmnr -= 1
+
+ if f is None:
+ if scope:
+ dict = self.debugMod.__dict__
+ else:
+ scope = -1
+ elif scope:
+ dict = f.f_globals
+ elif f.f_globals is f.f_locals:
+ scope = -1
+ else:
+ dict = f.f_locals
+
+ varlist = []
+
+ if scope != -1:
+ variable = dict
+ for attribute in var:
+ attribute = self.__extractIndicators(attribute)[0]
+ typeObject, typeName, typeStr, resolver = \
+ DebugVariables.getType(variable)
+ if resolver:
+ variable = resolver.resolve(variable, attribute)
+ else:
+ break
+ typeObject, typeName, typeStr, resolver = \
+ DebugVariables.getType(variable)
+ if typeStr.startswith(("PyQt5.", "PyQt4.")):
+ vlist = self.__formatQtVariable(variable, typeName)
+ varlist.extend(vlist)
+ elif resolver:
+ dict = resolver.getDictionary(variable)
+ vlist = self.__formatVariablesList(
+ list(dict.keys()), dict, scope, filter)
+ varlist.extend(vlist)
+
+ self.sendJsonCommand("ResponseVariable", {
+ "scope": scope,
+ "variable": var,
+ "variables": varlist,
+ })
+
+ def __extractIndicators(self, var):
+ """
+ Private method to extract the indicator string from a variable text.
+
+ @param var variable text
+ @type str
+ @return tuple containing the variable text without indicators and the
+ indicator string
+ @rtype tuple of two str
+ """
+ for indicator in DebugClientBase.Indicators:
+ if var.endswith(indicator):
+ return var[:-len(indicator)], indicator
+
+ return var, ""
+
+ def __formatQtVariable(self, value, qttype):
+ """
+ Private method to produce a formatted output of a simple Qt4/Qt5 type.
+
+ @param value variable to be formatted
+ @param qttype type of the Qt variable to be formatted (string)
+ @return A tuple consisting of a list of formatted variables. Each
+ variable entry is a tuple of three elements, the variable name,
+ its type and value.
+ """
+ varlist = []
+ if qttype == 'QChar':
+ varlist.append(("", "QChar", "{0}".format(chr(value.unicode()))))
+ varlist.append(("", "int", "{0:d}".format(value.unicode())))
+ elif qttype == 'QByteArray':
+ varlist.append(
+ ("bytes", "QByteArray", "{0}".format(bytes(value))[2:-1]))
+ varlist.append(
+ ("hex", "QByteArray", "{0}".format(value.toHex())[2:-1]))
+ varlist.append(
+ ("base64", "QByteArray", "{0}".format(value.toBase64())[2:-1]))
+ varlist.append(("percent encoding", "QByteArray",
+ "{0}".format(value.toPercentEncoding())[2:-1]))
+ elif qttype == 'QPoint':
+ varlist.append(("x", "int", "{0:d}".format(value.x())))
+ varlist.append(("y", "int", "{0:d}".format(value.y())))
+ elif qttype == 'QPointF':
+ varlist.append(("x", "float", "{0:g}".format(value.x())))
+ varlist.append(("y", "float", "{0:g}".format(value.y())))
+ elif qttype == 'QRect':
+ varlist.append(("x", "int", "{0:d}".format(value.x())))
+ varlist.append(("y", "int", "{0:d}".format(value.y())))
+ varlist.append(("width", "int", "{0:d}".format(value.width())))
+ varlist.append(("height", "int", "{0:d}".format(value.height())))
+ elif qttype == 'QRectF':
+ varlist.append(("x", "float", "{0:g}".format(value.x())))
+ varlist.append(("y", "float", "{0:g}".format(value.y())))
+ varlist.append(("width", "float", "{0:g}".format(value.width())))
+ varlist.append(("height", "float", "{0:g}".format(value.height())))
+ elif qttype == 'QSize':
+ varlist.append(("width", "int", "{0:d}".format(value.width())))
+ varlist.append(("height", "int", "{0:d}".format(value.height())))
+ elif qttype == 'QSizeF':
+ varlist.append(("width", "float", "{0:g}".format(value.width())))
+ varlist.append(("height", "float", "{0:g}".format(value.height())))
+ elif qttype == 'QColor':
+ varlist.append(("name", "str", "{0}".format(value.name())))
+ r, g, b, a = value.getRgb()
+ varlist.append(
+ ("rgba", "int",
+ "{0:d}, {1:d}, {2:d}, {3:d}".format(r, g, b, a)))
+ h, s, v, a = value.getHsv()
+ varlist.append(
+ ("hsva", "int",
+ "{0:d}, {1:d}, {2:d}, {3:d}".format(h, s, v, a)))
+ c, m, y, k, a = value.getCmyk()
+ varlist.append(
+ ("cmyka", "int",
+ "{0:d}, {1:d}, {2:d}, {3:d}, {4:d}".format(c, m, y, k, a)))
+ elif qttype == 'QDate':
+ varlist.append(("", "QDate", "{0}".format(value.toString())))
+ elif qttype == 'QTime':
+ varlist.append(("", "QTime", "{0}".format(value.toString())))
+ elif qttype == 'QDateTime':
+ varlist.append(("", "QDateTime", "{0}".format(value.toString())))
+ elif qttype == 'QDir':
+ varlist.append(("path", "str", "{0}".format(value.path())))
+ varlist.append(("absolutePath", "str",
+ "{0}".format(value.absolutePath())))
+ varlist.append(("canonicalPath", "str",
+ "{0}".format(value.canonicalPath())))
+ elif qttype == 'QFile':
+ varlist.append(("fileName", "str", "{0}".format(value.fileName())))
+ elif qttype == 'QFont':
+ varlist.append(("family", "str", "{0}".format(value.family())))
+ varlist.append(
+ ("pointSize", "int", "{0:d}".format(value.pointSize())))
+ varlist.append(("weight", "int", "{0:d}".format(value.weight())))
+ varlist.append(("bold", "bool", "{0}".format(value.bold())))
+ varlist.append(("italic", "bool", "{0}".format(value.italic())))
+ elif qttype == 'QUrl':
+ varlist.append(("url", "str", "{0}".format(value.toString())))
+ varlist.append(("scheme", "str", "{0}".format(value.scheme())))
+ varlist.append(("user", "str", "{0}".format(value.userName())))
+ varlist.append(("password", "str", "{0}".format(value.password())))
+ varlist.append(("host", "str", "{0}".format(value.host())))
+ varlist.append(("port", "int", "{0:d}".format(value.port())))
+ varlist.append(("path", "str", "{0}".format(value.path())))
+ elif qttype == 'QModelIndex':
+ varlist.append(("valid", "bool", "{0}".format(value.isValid())))
+ if value.isValid():
+ varlist.append(("row", "int", "{0}".format(value.row())))
+ varlist.append(("column", "int", "{0}".format(value.column())))
+ varlist.append(
+ ("internalId", "int", "{0}".format(value.internalId())))
+ varlist.append(("internalPointer", "void *",
+ "{0}".format(value.internalPointer())))
+ elif qttype == 'QRegExp':
+ varlist.append(("pattern", "str", "{0}".format(value.pattern())))
+
+ # GUI stuff
+ elif qttype == 'QAction':
+ varlist.append(("name", "str", "{0}".format(value.objectName())))
+ varlist.append(("text", "str", "{0}".format(value.text())))
+ varlist.append(
+ ("icon text", "str", "{0}".format(value.iconText())))
+ varlist.append(("tooltip", "str", "{0}".format(value.toolTip())))
+ varlist.append(
+ ("whatsthis", "str", "{0}".format(value.whatsThis())))
+ varlist.append(
+ ("shortcut", "str",
+ "{0}".format(value.shortcut().toString())))
+ elif qttype == 'QKeySequence':
+ varlist.append(("value", "", "{0}".format(value.toString())))
+
+ # XML stuff
+ elif qttype == 'QDomAttr':
+ varlist.append(("name", "str", "{0}".format(value.name())))
+ varlist.append(("value", "str", "{0}".format(value.value())))
+ elif qttype == 'QDomCharacterData':
+ varlist.append(("data", "str", "{0}".format(value.data())))
+ elif qttype == 'QDomComment':
+ varlist.append(("data", "str", "{0}".format(value.data())))
+ elif qttype == "QDomDocument":
+ varlist.append(("text", "str", "{0}".format(value.toString())))
+ elif qttype == 'QDomElement':
+ varlist.append(("tagName", "str", "{0}".format(value.tagName())))
+ varlist.append(("text", "str", "{0}".format(value.text())))
+ elif qttype == 'QDomText':
+ varlist.append(("data", "str", "{0}".format(value.data())))
+
+ # Networking stuff
+ elif qttype == 'QHostAddress':
+ varlist.append(
+ ("address", "QHostAddress", "{0}".format(value.toString())))
+
+ return varlist
+
+ def __formatVariablesList(self, keylist, dict, scope, filter=[],
+ formatSequences=False):
+ """
+ Private method to produce a formated variables list.
+
+ The dictionary passed in to it is scanned. Variables are
+ only added to the list, if their type is not contained
+ in the filter list and their name doesn't match any of the filter
+ expressions. The formated variables list (a list of tuples of 3
+ values) is returned.
+
+ @param keylist keys of the dictionary
+ @param dict the dictionary to be scanned
+ @param scope 1 to filter using the globals filter, 0 using the locals
+ filter (int).
+ Variables are only added to the list, if their name do not match
+ any of the filter expressions.
+ @param filter the indices of variable types to be filtered. Variables
+ are only added to the list, if their type is not contained in the
+ filter list.
+ @param formatSequences flag indicating, that sequence or dictionary
+ variables should be formatted. If it is 0 (or false), just the
+ number of items contained in these variables is returned. (boolean)
+ @return A tuple consisting of a list of formatted variables. Each
+ variable entry is a tuple of three elements, the variable name,
+ its type and value.
+ """
+ varlist = []
+ if scope:
+ patternFilterObjects = self.globalsFilterObjects
+ else:
+ patternFilterObjects = self.localsFilterObjects
+
+ for key in keylist:
+ # filter based on the filter pattern
+ matched = False
+ for pat in patternFilterObjects:
+ if pat.match(str(key)):
+ matched = True
+ break
+ if matched:
+ continue
+
+ # filter hidden attributes (filter #0)
+ if 0 in filter and str(key)[:2] == '__' and not (
+ key == "___len___" and
+ DebugVariables.TooLargeAttribute in keylist):
+ continue
+
+ # special handling for '__builtins__' (it's way too big)
+ if key == '__builtins__':
+ rvalue = '<module __builtin__ (built-in)>'
+ valtype = 'module'
+ else:
+ value = dict[key]
+ valtypestr = str(type(value))[1:-1]
+
+ valtype = valtypestr[7:-1]
+ if valtype not in ConfigVarTypeStrings:
+ if ConfigVarTypeStrings.index('instance') in filter:
+ continue
+ elif valtype == "sip.methoddescriptor":
+ if ConfigVarTypeStrings.index(
+ 'method') in filter:
+ continue
+ elif valtype == "sip.enumtype":
+ if ConfigVarTypeStrings.index('class') in filter:
+ continue
+ valtype = valtypestr
+ else:
+ try:
+ if ConfigVarTypeStrings.index(valtype) in filter:
+ continue
+ except ValueError:
+ if valtype == "classobj":
+ if ConfigVarTypeStrings.index(
+ 'instance') in filter:
+ continue
+ elif valtype == "sip.methoddescriptor":
+ if ConfigVarTypeStrings.index(
+ 'method') in filter:
+ continue
+ elif valtype == "sip.enumtype":
+ if ConfigVarTypeStrings.index('class') in filter:
+ continue
+ elif not valtype.startswith("PySide") and \
+ ConfigVarTypeStrings.index('other') in filter:
+ continue
+
+ try:
+ if valtype not in ['list', 'tuple', 'dict', 'set',
+ 'frozenset']:
+ rvalue = repr(value)
+ if valtype.startswith('class') and \
+ rvalue[0] in ['{', '(', '[']:
+ rvalue = ""
+ else:
+ if valtype == 'dict':
+ rvalue = "{0:d}".format(len(value.keys()))
+ else:
+ rvalue = "{0:d}".format(len(value))
+ except Exception:
+ rvalue = ''
+
+ if formatSequences:
+ if str(key) == key:
+ key = "'{0!s}'".format(key)
+ else:
+ key = str(key)
+ varlist.append((key, valtype, rvalue))
+
+ return varlist
+
+ def __generateFilterObjects(self, scope, filterString):
+ """
+ Private slot to convert a filter string to a list of filter objects.
+
+ @param scope 1 to generate filter for global variables, 0 for local
+ variables (int)
+ @param filterString string of filter patterns separated by ';'
+ """
+ patternFilterObjects = []
+ for pattern in filterString.split(';'):
+ patternFilterObjects.append(re.compile('^{0}$'.format(pattern)))
+ if scope:
+ self.globalsFilterObjects = patternFilterObjects[:]
+ else:
+ self.localsFilterObjects = patternFilterObjects[:]
+
+ def __completionList(self, text):
+ """
+ Private slot to handle the request for a commandline completion list.
+
+ @param text the text to be completed (string)
+ """
+ completerDelims = ' \t\n`~!@#$%^&*()-=+[{]}\\|;:\'",<>/?'
+
+ completions = set()
+ # find position of last delim character
+ pos = -1
+ while pos >= -len(text):
+ if text[pos] in completerDelims:
+ if pos == -1:
+ text = ''
+ else:
+ text = text[pos + 1:]
+ break
+ pos -= 1
+
+ # Get local and global completions
+ try:
+ localdict = self.currentThread.getFrameLocals(self.framenr)
+ localCompleter = Completer(localdict).complete
+ self.__getCompletionList(text, localCompleter, completions)
+ except AttributeError:
+ pass
+ self.__getCompletionList(text, self.complete, completions)
+
+ self.sendJsonCommand("ResponseCompletion", {
+ "completions": list(completions),
+ "text": text,
+ })
+
+ def __getCompletionList(self, text, completer, completions):
+ """
+ Private method to create a completions list.
+
+ @param text text to complete (string)
+ @param completer completer methode
+ @param completions set where to add new completions strings (set)
+ """
+ state = 0
+ try:
+ comp = completer(text, state)
+ except Exception:
+ comp = None
+ while comp is not None:
+ completions.add(comp)
+ state += 1
+ try:
+ comp = completer(text, state)
+ except Exception:
+ comp = None
+
+ def startDebugger(self, filename=None, host=None, port=None,
+ enableTrace=True, exceptions=True, tracePython=False,
+ redirect=True):
+ """
+ Public method used to start the remote debugger.
+
+ @param filename the program to be debugged (string)
+ @param host hostname of the debug server (string)
+ @param port portnumber of the debug server (int)
+ @param enableTrace flag to enable the tracing function (boolean)
+ @param exceptions flag to enable exception reporting of the IDE
+ (boolean)
+ @param tracePython flag to enable tracing into the Python library
+ (boolean)
+ @param redirect flag indicating redirection of stdin, stdout and
+ stderr (boolean)
+ """
+ global debugClient
+ if host is None:
+ host = os.getenv('ERICHOST', 'localhost')
+ if port is None:
+ port = os.getenv('ERICPORT', 42424)
+
+ remoteAddress = self.__resolveHost(host)
+ self.connectDebugger(port, remoteAddress, redirect)
+ if filename is not None:
+ self.running = os.path.abspath(filename)
+ else:
+ try:
+ self.running = os.path.abspath(sys.argv[0])
+ except IndexError:
+ self.running = None
+ if self.running:
+ self.__setCoding(self.running)
+ self.passive = True
+ self.sendPassiveStartup(self.running, exceptions)
+ self.__interact()
+
+ # setup the debugger variables
+ self._fncache = {}
+ self.dircache = []
+ self.mainFrame = None
+ self.debugging = True
+
+ self.attachThread(mainThread=True)
+ self.mainThread.tracePythonLibs(tracePython)
+
+ # set the system exception handling function to ensure, that
+ # we report on all unhandled exceptions
+ sys.excepthook = self.__unhandled_exception
+ self.__interceptSignals()
+
+ # now start debugging
+ if enableTrace:
+ self.mainThread.set_trace()
+
+ def startProgInDebugger(self, progargs, wd='', host=None,
+ port=None, exceptions=True, tracePython=False,
+ redirect=True):
+ """
+ Public method used to start the remote debugger.
+
+ @param progargs commandline for the program to be debugged
+ (list of strings)
+ @param wd working directory for the program execution (string)
+ @param host hostname of the debug server (string)
+ @param port portnumber of the debug server (int)
+ @param exceptions flag to enable exception reporting of the IDE
+ (boolean)
+ @param tracePython flag to enable tracing into the Python library
+ (boolean)
+ @param redirect flag indicating redirection of stdin, stdout and
+ stderr (boolean)
+ """
+ if host is None:
+ host = os.getenv('ERICHOST', 'localhost')
+ if port is None:
+ port = os.getenv('ERICPORT', 42424)
+
+ remoteAddress = self.__resolveHost(host)
+ self.connectDebugger(port, remoteAddress, redirect)
+
+ self._fncache = {}
+ self.dircache = []
+ sys.argv = progargs[:]
+ sys.argv[0] = os.path.abspath(sys.argv[0])
+ 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.__setCoding(self.running)
+ self.mainFrame = None
+ self.debugging = True
+
+ self.passive = True
+ self.sendPassiveStartup(self.running, exceptions)
+ self.__interact()
+
+ self.attachThread(mainThread=True)
+ self.mainThread.tracePythonLibs(tracePython)
+
+ # set the system exception handling function to ensure, that
+ # we report on all unhandled exceptions
+ sys.excepthook = self.__unhandled_exception
+ self.__interceptSignals()
+
+ # 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
+ res = self.mainThread.run(
+ 'exec(open(' + repr(self.running) + ').read())',
+ self.debugMod.__dict__)
+ self.progTerminated(res)
+
+ def run_call(self, scriptname, func, *args):
+ """
+ Public method used to start the remote debugger and call a function.
+
+ @param scriptname name of the script to be debugged (string)
+ @param func function to be called
+ @param *args arguments being passed to func
+ @return result of the function call
+ """
+ self.startDebugger(scriptname, enableTrace=False)
+ res = self.mainThread.runcall(func, *args)
+ self.progTerminated(res)
+ return res
+
+ def __resolveHost(self, host):
+ """
+ Private method to resolve a hostname to an IP address.
+
+ @param host hostname of the debug server (string)
+ @return IP address (string)
+ """
+ try:
+ host, version = host.split("@@")
+ except ValueError:
+ version = 'v4'
+ if version == 'v4':
+ family = socket.AF_INET
+ else:
+ family = socket.AF_INET6
+ return socket.getaddrinfo(host, None,
+ family, socket.SOCK_STREAM)[0][4][0]
+
+ def main(self):
+ """
+ Public method implementing the main method.
+ """
+ if '--' in sys.argv:
+ args = sys.argv[1:]
+ host = None
+ port = None
+ wd = ''
+ tracePython = False
+ exceptions = True
+ redirect = True
+ while args[0]:
+ if args[0] == '-h':
+ host = args[1]
+ del args[0]
+ del args[0]
+ elif args[0] == '-p':
+ port = int(args[1])
+ del args[0]
+ del args[0]
+ elif args[0] == '-w':
+ wd = args[1]
+ del args[0]
+ del args[0]
+ elif args[0] == '-t':
+ tracePython = True
+ del args[0]
+ elif args[0] == '-e':
+ exceptions = False
+ del args[0]
+ elif args[0] == '-n':
+ redirect = False
+ del args[0]
+ elif args[0] == '--no-encoding':
+ self.noencoding = True
+ del args[0]
+ elif args[0] == '--fork-child':
+ self.fork_auto = True
+ self.fork_child = True
+ del args[0]
+ elif args[0] == '--fork-parent':
+ self.fork_auto = True
+ self.fork_child = False
+ del args[0]
+ elif args[0] == '--':
+ del args[0]
+ break
+ else: # unknown option
+ del args[0]
+ if not args:
+ print("No program given. Aborting!") # __IGNORE_WARNING__
+ else:
+ if not self.noencoding:
+ self.__coding = self.defaultCoding
+ self.startProgInDebugger(args, wd, host, port,
+ exceptions=exceptions,
+ tracePython=tracePython,
+ redirect=redirect)
+ else:
+ if sys.argv[1] == '--no-encoding':
+ self.noencoding = True
+ del sys.argv[1]
+ if sys.argv[1] == '':
+ del sys.argv[1]
+ try:
+ port = int(sys.argv[1])
+ except (ValueError, IndexError):
+ port = -1
+ try:
+ redirect = int(sys.argv[2])
+ except (ValueError, IndexError):
+ redirect = True
+ try:
+ ipOrHost = sys.argv[3]
+ if ':' in ipOrHost:
+ remoteAddress = ipOrHost
+ elif ipOrHost[0] in '0123456789':
+ remoteAddress = ipOrHost
+ else:
+ remoteAddress = self.__resolveHost(ipOrHost)
+ except Exception:
+ remoteAddress = None
+ sys.argv = ['']
+ if '' not in sys.path:
+ sys.path.insert(0, '')
+ if port >= 0:
+ if not self.noencoding:
+ self.__coding = self.defaultCoding
+ self.connectDebugger(port, remoteAddress, redirect)
+ self.__interact()
+ else:
+ print("No network port given. Aborting...") # __IGNORE_WARNING__
+
+ def fork(self):
+ """
+ Public method implementing a fork routine deciding which branch
+ to follow.
+
+ @return process ID (integer)
+ """
+ if not self.fork_auto:
+ self.sendJsonCommand("RequestForkTo", {})
+ self.eventLoop(True)
+ pid = DebugClientOrigFork()
+ if pid == 0:
+ # child
+ if not self.fork_child:
+ sys.settrace(None)
+ sys.setprofile(None)
+ self.sessionClose(0)
+ else:
+ # parent
+ if self.fork_child:
+ sys.settrace(None)
+ sys.setprofile(None)
+ self.sessionClose(0)
+ return pid
+
+ def close(self, fd):
+ """
+ Public method implementing a close method as a replacement for
+ os.close().
+
+ It prevents the debugger connections from being closed.
+
+ @param fd file descriptor to be closed (integer)
+ """
+ if fd in [self.readstream.fileno(), self.writestream.fileno(),
+ self.errorstream.fileno()]:
+ return
+
+ DebugClientOrigClose(fd)
+
+ def __getSysPath(self, firstEntry):
+ """
+ Private slot to calculate a path list including the PYTHONPATH
+ environment variable.
+
+ @param firstEntry entry to be put first in sys.path (string)
+ @return path list for use as sys.path (list of strings)
+ """
+ sysPath = [path for path in os.environ.get("PYTHONPATH", "")
+ .split(os.pathsep)
+ if path not in sys.path] + sys.path[:]
+ if "" in sysPath:
+ sysPath.remove("")
+ sysPath.insert(0, firstEntry)
+ sysPath.insert(0, '')
+ return sysPath
+
+#
+# eflag: noqa = M702
