from matutils import * from meshutils import exampleLomGird, meshTensors from lomutils import volTetra, faceInfo, indexCube from interputils import interpmat from ipythonutils import easyAnimate as animate import ModelBuilder import types import time import numpy as np from functools import wraps class SimPEGMetaClass(type): def __new__(cls, name, bases, attrs): return super(SimPEGMetaClass, cls).__new__(cls, name, bases, attrs) def hook(obj, method, name=None, overwrite=False, silent=False): """ This dynamically binds a method to the instance of the class. If name is None, the name of the method is used. """ if name is None: name = method.__name__ if name == '': raise Exception('Must provide name to hook lambda functions.') if not hasattr(obj,name) or overwrite: setattr(obj, name, types.MethodType( method, obj )) if getattr(obj,'debug',False): print 'Method '+name+' was added to class.' elif not silent or getattr(obj,'debug',False): print 'Method '+name+' was not overwritten.' def setKwargs(obj, **kwargs): """Sets key word arguments (kwargs) that are present in the object, throw an error if they don't exist.""" for attr in kwargs: if hasattr(obj, attr): setattr(obj, attr, kwargs[attr]) else: raise Exception('%s attr is not recognized' % attr) hook(obj,hook, silent=True) hook(obj,setKwargs, silent=True) def printTitles(obj, printers, name='Print Titles', pad=''): titles = '' widths = 0 for printer in printers: titles += ('{:^%i}'%printer['width']).format(printer['title']) + '' widths += printer['width'] print pad + "{0} {1} {0}".format('='*((widths-1-len(name))/2), name) print pad + titles print pad + "%s" % '-'*widths def printLine(obj, printers, pad=''): values = '' for printer in printers: values += ('{:^%i}'%printer['width']).format(printer['format'] % printer['value'](obj)) print pad + values def checkStoppers(obj, stoppers): # check stopping rules optimal = [] critical = [] for stopper in stoppers: l = stopper['left'](obj) r = stopper['right'](obj) if stopper['stopType'] == 'optimal': optimal.append(l <= r) if stopper['stopType'] == 'critical': critical.append(l <= r) if obj.debug: print 'checkStoppers.optimal: ', optimal if obj.debug: print 'checkStoppers.critical: ', critical return (len(optimal)>0 and all(optimal)) | (len(critical)>0 and any(critical)) def printStoppers(obj, stoppers, pad='', stop='STOP!', done='DONE!'): print pad + "%s%s%s" % ('-'*25,stop,'-'*25) for stopper in stoppers: l = stopper['left'](obj) r = stopper['right'](obj) print pad + stopper['str'] % (l<=r,l,r) print pad + "%s%s%s" % ('-'*25,done,'-'*25) def callHooks(match, mainFirst=False): """ Use this to wrap a funciton:: @callHooks('doEndIteration') def doEndIteration(self): pass This will call everything named _doEndIteration* at the beginning of the function call. By default the master method (doEndIteration) is run after all of the sub methods (_doEndIteration*). This can be reversed by adding the mainFirst=True kwarg. """ def callHooksWrap(f): @wraps(f) def wrapper(self,*args,**kwargs): if not mainFirst: for method in [posible for posible in dir(self) if ('_'+match) in posible]: if getattr(self,'debug',False): print (match+' is calling self.'+method) getattr(self,method)(*args, **kwargs) return f(self,*args,**kwargs) else: out = f(self,*args,**kwargs) for method in [posible for posible in dir(self) if ('_'+match) in posible]: if getattr(self,'debug',False): print (match+' is calling self.'+method) getattr(self,method)(*args, **kwargs) return out extra = """ If you have things that also need to run in the method %s, you can create a method:: def _%s*(self, ... ): pass Where the * can be any string. If present, _%s* will be called at the start of the default %s call. You may also completely overwrite this function. """ % (match, match, match, match) doc = wrapper.__doc__ wrapper.__doc__ = ('' if doc is None else doc) + extra return wrapper return callHooksWrap def dependentProperty(name, value, children, doc): def fget(self): return getattr(self,name,value) def fset(self, val): if getattr(self,name,value) == val: return # it is the same! for child in children: if hasattr(self, child): delattr(self, child) setattr(self, name, val) return property(fget=fget, fset=fset, doc=doc) def requires(var): """ Use this to wrap a funciton:: @requires('prob') def dpred(self): pass This wrapper will ensure that a problem has been bound to the data. If a problem is not bound an Exception will be raised, and an nice error message printed. """ def requiresVar(f): if var is 'prob': extra = """ .. note:: To use data.%s(), SimPEG requires that a problem be bound to the data. If a problem has not been bound, an Exception will be raised. To bind a problem to the Data object:: data.pair(myProblem) """ % f.__name__ else: extra = """ To use *%s* method, SimPEG requires that the %s be specified. """ % (f.__name__, var) @wraps(f) def requiresVarWrapper(self,*args,**kwargs): if getattr(self, var, None) is None: raise Exception(extra) return f(self,*args,**kwargs) doc = requiresVarWrapper.__doc__ requiresVarWrapper.__doc__ = ('' if doc is None else doc) + extra return requiresVarWrapper return requiresVar class Counter(object): """ Counter allows anything that calls it to record iterations and timings in a simple way. Also has plotting functions that allow quick recalls of data. If you want to use this, import *count* or *timeIt* and use them as decorators on class methods. :: class MyClass(object): def __init__(self, url): self.counter = Counter() @count def MyMethod(self): pass @timeIt def MySecondMethod(self): pass c = MyClass('blah') for i in range(100): c.MyMethod() for i in range(300): c.MySecondMethod() c.counter.summary() """ def __init__(self): self._countList = {} self._timeList = {} def count(self, prop): """ Increases the count of the property. """ assert type(prop) is str, 'The property must be a string.' if prop not in self._countList: self._countList[prop] = 0 self._countList[prop] += 1 def countTic(self, prop): """ Times a property call, this is the init call. """ assert type(prop) is str, 'The property must be a string.' if prop not in self._timeList: self._timeList[prop] = [] self._timeList[prop].append(-time.time()) def countToc(self, prop): """ Times a property call, this is the end call. """ assert type(prop) is str, 'The property must be a string.' assert prop in self._timeList, 'The property must already be in the dictionary.' self._timeList[prop][-1] += time.time() def summary(self): """ Provides a text summary of the current counters and timers. """ print 'Counters:' for prop in sorted(self._countList): print " {0:<40}: {1:8d}".format(prop,self._countList[prop]) print '\nTimes:'+' '*40+'mean sum' for prop in sorted(self._timeList): l = len(self._timeList[prop]) a = np.array(self._timeList[prop]) print " {0:<40}: {1:4.2e}, {2:4.2e}, {3:4d}x".format(prop,a.mean(),a.sum(),l) def count(f): @wraps(f) def wrapper(self,*args,**kwargs): counter = getattr(self,'counter',None) if type(counter) is Counter: counter.count(self.__class__.__name__+'.'+f.__name__) out = f(self,*args,**kwargs) return out return wrapper def timeIt(f): @wraps(f) def wrapper(self,*args,**kwargs): counter = getattr(self,'counter',None) if type(counter) is Counter: counter.countTic(self.__class__.__name__+'.'+f.__name__) out = f(self,*args,**kwargs) if type(counter) is Counter: counter.countToc(self.__class__.__name__+'.'+f.__name__) return out return wrapper if __name__ == '__main__': class MyClass(object): def __init__(self, url): self.counter = Counter() @count def MyMethod(self): pass @timeIt def MySecondMethod(self): pass c = MyClass('blah') for i in range(100): c.MyMethod() for i in range(300): c.MySecondMethod() c.counter.summary()