try: import StringIO except: import io as StringIO import traceback from os.path import basename try: __setFalse = False except: import __builtin__ setattr(__builtin__, 'True', 1) setattr(__builtin__, 'False', 0) import pydevd_constants from pydevd_constants import DictIterItems, xrange # Note: 300 is already a lot to see in the outline (after that the user should really use the shell to get things) # and this also means we'll pass less information to the client side (which makes debugging faster). MAX_ITEMS_TO_HANDLE = 300 TOO_LARGE_MSG = 'Too large to show contents. Max items to show: ' + str(MAX_ITEMS_TO_HANDLE) TOO_LARGE_ATTR = 'Unable to handle:' #======================================================================================================================= # UnableToResolveVariableException #======================================================================================================================= class UnableToResolveVariableException(Exception): pass #======================================================================================================================= # InspectStub #======================================================================================================================= class InspectStub: def isbuiltin(self, _args): return False def isroutine(self, object): return False try: import inspect except: inspect = InspectStub() try: import java.lang #@UnresolvedImport except: pass #types does not include a MethodWrapperType try: MethodWrapperType = type([].__str__) except: MethodWrapperType = None #======================================================================================================================= # AbstractResolver #======================================================================================================================= class AbstractResolver: ''' This class exists only for documentation purposes to explain how to create a resolver. Some examples on how to resolve things: - list: getDictionary could return a dict with index->item and use the index to resolve it later - set: getDictionary could return a dict with id(object)->object and reiterate in that array to resolve it later - arbitrary instance: getDictionary could return dict with attr_name->attr and use getattr to resolve it later ''' def resolve(self, var, attribute): ''' In this method, we'll resolve some child item given the string representation of the item in the key representing the previously asked dictionary. @param var: this is the actual variable to be resolved. @param attribute: this is the string representation of a key previously returned in getDictionary. ''' raise NotImplementedError def getDictionary(self, var): ''' @param var: this is the variable that should have its children gotten. @return: a dictionary where each pair key, value should be shown to the user as children items in the variables view for the given var. ''' raise NotImplementedError #======================================================================================================================= # DefaultResolver #======================================================================================================================= class DefaultResolver: ''' DefaultResolver is the class that'll actually resolve how to show some variable. ''' def resolve(self, var, attribute): return getattr(var, attribute) def getDictionary(self, var): if MethodWrapperType: return self._getPyDictionary(var) else: return self._getJyDictionary(var) def _getJyDictionary(self, obj): ret = {} found = java.util.HashMap() original = obj if hasattr(obj, '__class__') and obj.__class__ == java.lang.Class: #get info about superclasses classes = [] classes.append(obj) c = obj.getSuperclass() while c != None: classes.append(c) c = c.getSuperclass() #get info about interfaces interfs = [] for obj in classes: interfs.extend(obj.getInterfaces()) classes.extend(interfs) #now is the time when we actually get info on the declared methods and fields for obj in classes: declaredMethods = obj.getDeclaredMethods() declaredFields = obj.getDeclaredFields() for i in xrange(len(declaredMethods)): name = declaredMethods[i].getName() ret[name] = declaredMethods[i].toString() found.put(name, 1) for i in xrange(len(declaredFields)): name = declaredFields[i].getName() found.put(name, 1) #if declaredFields[i].isAccessible(): declaredFields[i].setAccessible(True) #ret[name] = declaredFields[i].get( declaredFields[i] ) try: ret[name] = declaredFields[i].get(original) except: ret[name] = declaredFields[i].toString() #this simple dir does not always get all the info, that's why we have the part before #(e.g.: if we do a dir on String, some methods that are from other interfaces such as #charAt don't appear) try: d = dir(original) for name in d: if found.get(name) is not 1: ret[name] = getattr(original, name) except: #sometimes we're unable to do a dir pass return ret def _getPyDictionary(self, var): filterPrivate = False filterSpecial = True filterFunction = True filterBuiltIn = True names = dir(var) if not names and hasattr(var, '__members__'): names = var.__members__ d = {} #Be aware that the order in which the filters are applied attempts to #optimize the operation by removing as many items as possible in the #first filters, leaving fewer items for later filters if filterBuiltIn or filterFunction: for n in names: if filterSpecial: if n.startswith('__') and n.endswith('__'): continue if filterPrivate: if n.startswith('_') or n.endswith('__'): continue try: attr = getattr(var, n) #filter builtins? if filterBuiltIn: if inspect.isbuiltin(attr): continue #filter functions? if filterFunction: if inspect.isroutine(attr) or isinstance(attr, MethodWrapperType): continue except: #if some error occurs getting it, let's put it to the user. strIO = StringIO.StringIO() traceback.print_exc(file=strIO) attr = strIO.getvalue() d[ n ] = attr return d #======================================================================================================================= # DictResolver #======================================================================================================================= class DictResolver: def resolve(self, dict, key): if key in ('__len__', TOO_LARGE_ATTR): return None if '(' not in key: #we have to treat that because the dict resolver is also used to directly resolve the global and local #scopes (which already have the items directly) return dict[key] #ok, we have to iterate over the items to find the one that matches the id, because that's the only way #to actually find the reference from the string we have before. expected_id = int(key.split('(')[-1][:-1]) for key, val in DictIterItems(dict): if id(key) == expected_id: return val raise UnableToResolveVariableException() def keyStr(self, key): if isinstance(key, str): return "'%s'"%key else: if not pydevd_constants.IS_PY3K: if isinstance(key, unicode): return "u'%s'"%key return key def getDictionary(self, dict): ret = {} i = 0 for key, val in DictIterItems(dict): i += 1 #we need to add the id because otherwise we cannot find the real object to get its contents later on. key = '%s (%s)' % (self.keyStr(key), id(key)) ret[key] = val if i > MAX_ITEMS_TO_HANDLE: ret[TOO_LARGE_ATTR] = TOO_LARGE_MSG break ret['__len__'] = len(dict) return ret #======================================================================================================================= # TupleResolver #======================================================================================================================= class TupleResolver: #to enumerate tuples and lists def resolve(self, var, attribute): ''' @param var: that's the original attribute @param attribute: that's the key passed in the dict (as a string) ''' if attribute in ('__len__', TOO_LARGE_ATTR): return None return var[int(attribute)] def getDictionary(self, var): l = len(var) d = {} format_str = '%0' + str(int(len(str(l)))) + 'd' i = 0 for item in var: d[format_str % i] = item i += 1 if i > MAX_ITEMS_TO_HANDLE: d[TOO_LARGE_ATTR] = TOO_LARGE_MSG break d['__len__'] = len(var) return d #======================================================================================================================= # SetResolver #======================================================================================================================= class SetResolver: ''' Resolves a set as dict id(object)->object ''' def resolve(self, var, attribute): if attribute in ('__len__', TOO_LARGE_ATTR): return None attribute = int(attribute) for v in var: if id(v) == attribute: return v raise UnableToResolveVariableException('Unable to resolve %s in %s' % (attribute, var)) def getDictionary(self, var): d = {} i = 0 for item in var: i+= 1 d[id(item)] = item if i > MAX_ITEMS_TO_HANDLE: d[TOO_LARGE_ATTR] = TOO_LARGE_MSG break d['__len__'] = len(var) return d #======================================================================================================================= # InstanceResolver #======================================================================================================================= class InstanceResolver: def resolve(self, var, attribute): field = var.__class__.getDeclaredField(attribute) field.setAccessible(True) return field.get(var) def getDictionary(self, obj): ret = {} declaredFields = obj.__class__.getDeclaredFields() for i in xrange(len(declaredFields)): name = declaredFields[i].getName() try: declaredFields[i].setAccessible(True) ret[name] = declaredFields[i].get(obj) except: traceback.print_exc() return ret #======================================================================================================================= # JyArrayResolver #======================================================================================================================= class JyArrayResolver: ''' This resolves a regular Object[] array from java ''' def resolve(self, var, attribute): if attribute == '__len__': return None return var[int(attribute)] def getDictionary(self, obj): ret = {} for i in xrange(len(obj)): ret[ i ] = obj[i] ret['__len__'] = len(obj) return ret #======================================================================================================================= # NdArrayResolver #======================================================================================================================= class NdArrayResolver: ''' This resolves a numpy ndarray returning some metadata about the NDArray ''' def is_numeric(self, obj): if not hasattr(obj, 'dtype'): return False return obj.dtype.kind in 'biufc' def resolve(self, obj, attribute): if attribute == '__internals__': return defaultResolver.getDictionary(obj) if attribute == 'min': if self.is_numeric(obj): return obj.min() else: return None if attribute == 'max': if self.is_numeric(obj): return obj.max() else: return None if attribute == 'shape': return obj.shape if attribute == 'dtype': return obj.dtype if attribute == 'size': return obj.size if attribute.startswith('['): container = NdArrayItemsContainer() i = 0 format_str = '%0' + str(int(len(str(len(obj))))) + 'd' for item in obj: setattr(container, format_str % i, item) i += 1 if i > MAX_ITEMS_TO_HANDLE: setattr(container, TOO_LARGE_ATTR, TOO_LARGE_MSG) break return container return None def getDictionary(self, obj): ret = dict() ret['__internals__'] = defaultResolver.getDictionary(obj) if obj.size > 1024 * 1024: ret['min'] = 'ndarray too big, calculating min would slow down debugging' ret['max'] = 'ndarray too big, calculating max would slow down debugging' else: if self.is_numeric(obj): ret['min'] = obj.min() ret['max'] = obj.max() else: ret['min'] = 'not a numeric object' ret['max'] = 'not a numeric object' ret['shape'] = obj.shape ret['dtype'] = obj.dtype ret['size'] = obj.size ret['[0:%s]' % (len(obj))] = list(obj) return ret class NdArrayItemsContainer: pass #======================================================================================================================= # FrameResolver #======================================================================================================================= class FrameResolver: ''' This resolves a frame. ''' def resolve(self, obj, attribute): if attribute == '__internals__': return defaultResolver.getDictionary(obj) if attribute == 'stack': return self.getFrameStack(obj) if attribute == 'f_locals': return obj.f_locals return None def getDictionary(self, obj): ret = dict() ret['__internals__'] = defaultResolver.getDictionary(obj) ret['stack'] = self.getFrameStack(obj) ret['f_locals'] = obj.f_locals return ret def getFrameStack(self, frame): ret = [] if frame is not None: ret.append(self.getFrameName(frame)) while frame.f_back: frame = frame.f_back ret.append(self.getFrameName(frame)) return ret def getFrameName(self, frame): if frame is None: return 'None' try: name = basename(frame.f_code.co_filename) return 'frame: %s [%s:%s] id:%s' % (frame.f_code.co_name, name, frame.f_lineno, id(frame)) except: return 'frame object' defaultResolver = DefaultResolver() dictResolver = DictResolver() tupleResolver = TupleResolver() instanceResolver = InstanceResolver() jyArrayResolver = JyArrayResolver() setResolver = SetResolver() ndarrayResolver = NdArrayResolver() frameResolver = FrameResolver()