python.AccumulatorCache Namespace Reference

Classes
class	AccumulatorCachable
class	AccumulatorDecorator
class	DataHandle
class	NotHashable

Functions
	AccumulatorCache (func=None, maxSize=128, verifyResult=AccumulatorDecorator.VERIFY_NOTHING, deepCopy=True)

Variables
	_msg = logging.getLogger('AccumulatorCache')

Function Documentation

AccumulatorCache()

python.AccumulatorCache.AccumulatorCache	(		func = None,
			maxSize = 128,
			verifyResult = AccumulatorDecorator.VERIFY_NOTHING,
			deepCopy = True )

Function decorator, implements memoization.

Keyword arguments:
    maxSize: maximum size for the cache associated with the function (default 128)
    verifyResult:   takes two possible values
                    
                    AccumulatorDecorator.VERIFY_NOTHING -   default, the cached function result is returned with no verification
                    AccumulatorDecorator.VERIFY_HASH -      before returning the cached function value, the hash of the
                                                            result is checked to verify if this object was not modified
                                                            between function calls
    deepCopy:   if True (default) a deep copy of the function result will be stored in the cache.

Returns:
    An instance of AccumulatorDecorator.

Definition at line 229 of file AccumulatorCache.py.

                     verifyResult = AccumulatorDecorator.VERIFY_NOTHING, deepCopy = True):
    """Function decorator, implements memoization.
 
    Keyword arguments:
        maxSize: maximum size for the cache associated with the function (default 128)
        verifyResult:   takes two possible values
                        
                        AccumulatorDecorator.VERIFY_NOTHING -   default, the cached function result is returned with no verification
                        AccumulatorDecorator.VERIFY_HASH -      before returning the cached function value, the hash of the
                                                                result is checked to verify if this object was not modified
                                                                between function calls
        deepCopy:   if True (default) a deep copy of the function result will be stored in the cache.
    
    Returns:
        An instance of AccumulatorDecorator.
    """
 
    def wrapper_accumulator(func):
        return AccumulatorDecorator(func, maxSize, verifyResult, deepCopy)
 
    return wrapper_accumulator(func) if func else wrapper_accumulator

Variable Documentation

_msg

python.AccumulatorCache._msg = logging.getLogger('AccumulatorCache')

protected

Definition at line 6 of file AccumulatorCache.py.