summaryrefslogtreecommitdiff
path: root/base/testing.py
diff options
context:
space:
mode:
authorTravis Oliphant <oliphant@enthought.com>2005-09-14 22:28:28 +0000
committerTravis Oliphant <oliphant@enthought.com>2005-09-14 22:28:28 +0000
commit61b48697e440f76b2337c790ec5ca763cd55200b (patch)
treeda64ece2ba0b6b97deb51c36ca320c64102e9baa /base/testing.py
parent575d373479c63a42bc4a729a058da31a74e75d3e (diff)
downloadnumpy-61b48697e440f76b2337c790ec5ca763cd55200b.tar.gz
Moving things to live under scipy
Diffstat (limited to 'base/testing.py')
-rw-r--r--base/testing.py588
1 files changed, 0 insertions, 588 deletions
diff --git a/base/testing.py b/base/testing.py
deleted file mode 100644
index 26f86cc7e..000000000
--- a/base/testing.py
+++ /dev/null
@@ -1,588 +0,0 @@
-"""
-Unit-testing
-------------
-
- ScipyTest -- Scipy tests site manager
- ScipyTestCase -- unittest.TestCase with measure method
- IgnoreException -- raise when checking disabled feature ('ignoring' is displayed)
- set_package_path -- prepend package build directory to path
- set_local_path -- prepend local directory (to tests files) to path
- restore_path -- restore path after set_package_path
-
-Timing tools
-------------
-
- jiffies -- return 1/100ths of a second that the current process has used
- memusage -- virtual memory size in bytes of the running python [linux]
-
-Utility functions
------------------
-
- assert_equal -- assert equality
- assert_almost_equal -- assert equality with decimal tolerance
- assert_approx_equal -- assert equality with significant digits tolerance
- assert_array_equal -- assert arrays equality
- assert_array_almost_equal -- assert arrays equality with decimal tolerance
- assert_array_less -- assert arrays less-ordering
- rand -- array of random numbers from given shape
-
-"""
-
-__all__ = []
-
-import os,sys,time,glob,string,traceback,unittest
-import types
-import imp
-
-#
-# Imports from scipy_base must be done at the end of this file.
-#
-
-DEBUG = 0
-
-__all__.append('set_package_path')
-def set_package_path(level=1):
- """ Prepend package directory to sys.path.
-
- set_package_path should be called from a test_file.py that
- satisfies the following tree structure:
-
- <somepath>/<somedir>/test_file.py
-
- Then the first existing path name from the following list
-
- <somepath>/build/lib.<platform>-<version>
- <somepath>/..
-
- is prepended to sys.path.
- The caller is responsible for removing this path by using
-
- restore_path()
- """
- from distutils.util import get_platform
- from scipy.distutils.misc_util import get_frame
- f = get_frame(level)
- if f.f_locals['__name__']=='__main__':
- testfile = sys.argv[0]
- else:
- testfile = f.f_locals['__file__']
- d = os.path.dirname(os.path.dirname(os.path.abspath(testfile)))
- d1 = os.path.join(d,'build','lib.%s-%s'%(get_platform(),sys.version[:3]))
- if not os.path.isdir(d1):
- d1 = os.path.dirname(d)
- if DEBUG:
- print 'Inserting %r to sys.path' % (d1)
- sys.path.insert(0,d1)
-
-__all__.append('set_local_path')
-def set_local_path(reldir='', level=1):
- """ Prepend local directory to sys.path.
-
- The caller is responsible for removing this path by using
-
- restore_path()
- """
- from scipy.distutils.misc_util import get_frame
- f = get_frame(level)
- if f.f_locals['__name__']=='__main__':
- testfile = sys.argv[0]
- else:
- testfile = f.f_locals['__file__']
- local_path = os.path.join(os.path.dirname(os.path.abspath(testfile)),reldir)
- if DEBUG:
- print 'Inserting %r to sys.path' % (local_path)
- sys.path.insert(0,local_path)
-
-__all__.append('restore_path')
-def restore_path():
- if DEBUG:
- print 'Removing %r from sys.path' % (sys.path[0])
- del sys.path[0]
-
-__all__.extend(['jiffies','memusage'])
-if sys.platform[:5]=='linux':
- def jiffies(_proc_pid_stat = '/proc/%s/stat'%(os.getpid()),
- _load_time=time.time()):
- """ Return number of jiffies (1/100ths of a second) that this
- process has been scheduled in user mode. See man 5 proc. """
- try:
- f=open(_proc_pid_stat,'r')
- l = f.readline().split(' ')
- f.close()
- return int(l[13])
- except:
- return int(100*(time.time()-_load_time))
-
- def memusage(_proc_pid_stat = '/proc/%s/stat'%(os.getpid())):
- """ Return virtual memory size in bytes of the running python.
- """
- try:
- f=open(_proc_pid_stat,'r')
- l = f.readline().split(' ')
- f.close()
- return int(l[22])
- except:
- return
-else:
- # os.getpid is not in all platforms available.
- # Using time is safe but inaccurate, especially when process
- # was suspended or sleeping.
- def jiffies(_load_time=time.time()):
- """ Return number of jiffies (1/100ths of a second) that this
- process has been scheduled in user mode. [Emulation with time.time]. """
- return int(100*(time.time()-_load_time))
-
- def memusage():
- """ Return memory usage of running python. [Not implemented]"""
- return
-
-__all__.append('ScipyTestCase')
-class ScipyTestCase (unittest.TestCase):
-
- def measure(self,code_str,times=1):
- """ Return elapsed time for executing code_str in the
- namespace of the caller for given times.
- """
- frame = sys._getframe(1)
- locs,globs = frame.f_locals,frame.f_globals
- code = compile(code_str,
- 'ScipyTestCase runner for '+self.__class__.__name__,
- 'exec')
- i = 0
- elapsed = jiffies()
- while i<times:
- i += 1
- exec code in globs,locs
- elapsed = jiffies() - elapsed
- return 0.01*elapsed
-
- def __call__(self, result=None):
- if result is None:
- return unittest.TestCase.__call__(self, result)
-
- nof_errors = len(result.errors)
- save_stream = result.stream
- result.stream = _dummy_stream(save_stream)
- unittest.TestCase.__call__(self, result)
- if nof_errors != len(result.errors):
- test, errstr = result.errors[-1]
- if type(errstr) is type(()):
- errstr = str(errstr[0])
- else:
- errstr = errstr.split('\n')[-2]
- l = len(result.stream.data)
- if errstr.startswith('IgnoreException:'):
- if l==1:
- assert result.stream.data[-1]=='E',`result.stream.data`
- result.stream.data[-1] = 'i'
- else:
- assert result.stream.data[-1]=='ERROR\n',`result.stream.data`
- result.stream.data[-1] = 'ignoring\n'
- del result.errors[-1]
- map(save_stream.write, result.stream.data)
- result.stream = save_stream
-
-class _dummy_stream:
- def __init__(self,stream):
- self.data = []
- self.stream = stream
- def write(self,message):
- if not self.data and not message.startswith('E'):
- self.stream.write(message)
- self.stream.flush()
- message = ''
- self.data.append(message)
- def writeln(self,message):
- self.write(message+'\n')
-
-__all__.append('IgnoreException')
-class IgnoreException(Exception):
- "Ignoring this exception due to disabled feature"
-
-#------------
-
-def _get_all_method_names(cls):
- names = dir(cls)
- if sys.version[:3]<='2.1':
- for b in cls.__bases__:
- for n in dir(b)+_get_all_method_names(b):
- if n not in names:
- names.append(n)
- return names
-
-__all__.append('ScipyTest')
-class ScipyTest:
- """ Scipy tests site manager.
-
- Usage:
- >>> ScipyTest(<package>).test(level=1,verbosity=2)
-
- <package> is package name or its module object.
-
- Package is supposed to contain a directory tests/
- with test_*.py files where * refers to the names of submodules.
-
- test_*.py files are supposed to define a classes, derived
- from ScipyTestCase or unittest.TestCase, with methods having
- names starting with test or bench or check.
-
- And that is it! No need to implement test or test_suite functions
- in each .py file.
-
- Also old styled test_suite(level=1) hooks are supported but
- soon to be removed.
- """
- def __init__(self, package='__main__'):
- self.package = package
-
- def _module_str(self, module):
- filename = module.__file__[-30:]
- if filename!=module.__file__:
- filename = '...'+filename
- return '<module %s from %s>' % (`module.__name__`, `filename`)
-
- def _get_method_names(self,clsobj,level):
- names = []
- for mthname in _get_all_method_names(clsobj):
- if mthname[:5] not in ['bench','check'] \
- and mthname[:4] not in ['test']:
- continue
- mth = getattr(clsobj, mthname)
- if type(mth) is not types.MethodType:
- continue
- d = mth.im_func.func_defaults
- if d is not None:
- mthlevel = d[0]
- else:
- mthlevel = 1
- if level>=mthlevel:
- if mthname not in names:
- names.append(mthname)
- for base in clsobj.__bases__:
- for n in self._get_method_names(base,level):
- if n not in names:
- names.append(n)
- return names
-
- def _get_module_tests(self,module,level):
- mstr = self._module_str
- d,f = os.path.split(module.__file__)
-
- short_module_name = os.path.splitext(os.path.basename(f))[0]
- if short_module_name=='__init__':
- short_module_name = module.__name__.split('.')[-1]
-
- test_dir = os.path.join(d,'tests')
- test_file = os.path.join(test_dir,'test_'+short_module_name+'.py')
-
- local_test_dir = os.path.join(os.getcwd(),'tests')
- local_test_file = os.path.join(local_test_dir,
- 'test_'+short_module_name+'.py')
- if os.path.basename(os.path.dirname(local_test_dir)) \
- == os.path.basename(os.path.dirname(test_dir)) \
- and os.path.isfile(local_test_file):
- test_file = local_test_file
-
- if not os.path.isfile(test_file):
- if short_module_name[:5]=='info_' \
- and short_module_name[5:]==module.__name__.split('.')[-2]:
- return []
- if short_module_name in ['__cvs_version__','__svn_version__']:
- return []
- if short_module_name[-8:]=='_version' \
- and short_module_name[:-8]==module.__name__.split('.')[-2]:
- return []
- print ' !! No test file %r found for %s' \
- % (os.path.basename(test_file), mstr(module))
- return []
-
- try:
- if sys.version[:3]=='2.1':
- # Workaround for Python 2.1 .pyc file generator bug
- import random
- pref = '-nopyc'+`random.randint(1,100)`
- else:
- pref = ''
- f = open(test_file,'r')
- test_module = imp.load_module(\
- module.__name__+'.test_'+short_module_name+pref,
- f, test_file+pref,('.py', 'r', 1))
- f.close()
- if sys.version[:3]=='2.1' and os.path.isfile(test_file+pref+'c'):
- os.remove(test_file+pref+'c')
- except:
- print ' !! FAILURE importing tests for ', mstr(module)
- print ' ',
- output_exception()
- return []
- return self._get_suite_list(test_module, level, module.__name__)
-
- def _get_suite_list(self, test_module, level, module_name='__main__'):
- mstr = self._module_str
- if hasattr(test_module,'test_suite'):
- # Using old styled test suite
- try:
- total_suite = test_module.test_suite(level)
- return total_suite._tests
- except:
- print ' !! FAILURE building tests for ', mstr(test_module)
- print ' ',
- output_exception()
- return []
- suite_list = []
- for name in dir(test_module):
- obj = getattr(test_module, name)
- if type(obj) is not type(unittest.TestCase) \
- or not issubclass(obj, unittest.TestCase) \
- or obj.__name__[:4] != 'test':
- continue
- for mthname in self._get_method_names(obj,level):
- suite = obj(mthname)
- if getattr(suite,'isrunnable',lambda mthname:1)(mthname):
- suite_list.append(suite)
- print ' Found',len(suite_list),'tests for',module_name
- return suite_list
-
- def _touch_ppimported(self, module):
- from scipy.base.ppimport import _ModuleLoader
- if os.path.isdir(os.path.join(os.path.dirname(module.__file__),'tests')):
- # only touching those modules that have tests/ directory
- try: module._pliuh_plauh
- except AttributeError: pass
- for name in dir(module):
- obj = getattr(module,name)
- if isinstance(obj,_ModuleLoader) \
- and not hasattr(obj,'_ppimport_module') \
- and not hasattr(obj,'_ppimport_exc_info'):
- self._touch_ppimported(obj)
-
- def test(self,level=1,verbosity=1):
- """ Run Scipy module test suite with level and verbosity.
- """
- if type(self.package) is type(''):
- exec 'import %s as this_package' % (self.package)
- else:
- this_package = self.package
-
- self._touch_ppimported(this_package)
-
- package_name = this_package.__name__
-
- suites = []
- for name, module in sys.modules.items():
- if package_name != name[:len(package_name)] \
- or module is None \
- or os.path.basename(os.path.dirname(module.__file__))=='tests':
- continue
- suites.extend(self._get_module_tests(module, level))
-
- suites.extend(self._get_suite_list(sys.modules[package_name], level))
-
- all_tests = unittest.TestSuite(suites)
- runner = unittest.TextTestRunner(verbosity=verbosity)
- runner.run(all_tests)
- return runner
-
- def run(self):
- """ Run Scipy module test suite with level and verbosity
- taken from sys.argv. Requires optparse module.
- """
- try:
- from optparse import OptionParser
- except ImportError:
- print 'Failed to import optparse module, ignoring.'
- return self.test()
- usage = r'usage: %prog [-v <verbosity>] [-l <level>]'
- parser = OptionParser(usage)
- parser.add_option("-v", "--verbosity",
- action="store",
- dest="verbosity",
- default=1,
- type='int')
- parser.add_option("-l", "--level",
- action="store",
- dest="level",
- default=1,
- type='int')
- (options, args) = parser.parse_args()
- self.test(options.level,options.verbosity)
-
-#------------
-# Utility function to facilitate testing.
-
-__all__.append('assert_equal')
-def assert_equal(actual,desired,err_msg='',verbose=1):
- """ Raise an assertion if two items are not
- equal. I think this should be part of unittest.py
- """
- if isinstance(actual, ArrayType) or isinstance(desired, ArrayType):
- return assert_array_equal(actual, desired, err_msg)
- msg = '\nItems are not equal:\n' + err_msg
- try:
- if ( verbose and len(repr(desired)) < 100 and len(repr(actual)) ):
- msg = msg \
- + 'DESIRED: ' + repr(desired) \
- + '\nACTUAL: ' + repr(actual)
- except:
- msg = msg \
- + 'DESIRED: ' + repr(desired) \
- + '\nACTUAL: ' + repr(actual)
- assert desired == actual, msg
-
-__all__.append('assert_almost_equal')
-def assert_almost_equal(actual,desired,decimal=7,err_msg='',verbose=1):
- """ Raise an assertion if two items are not
- equal. I think this should be part of unittest.py
- """
- if isinstance(actual, ArrayType) or isinstance(desired, ArrayType):
- return assert_array_almost_equal(actual, desired, decimal, err_msg)
- msg = '\nItems are not equal:\n' + err_msg
- try:
- if ( verbose and len(repr(desired)) < 100 and len(repr(actual)) ):
- msg = msg \
- + 'DESIRED: ' + repr(desired) \
- + '\nACTUAL: ' + repr(actual)
- except:
- msg = msg \
- + 'DESIRED: ' + repr(desired) \
- + '\nACTUAL: ' + repr(actual)
- assert round(abs(desired - actual),decimal) == 0, msg
-
-__all__.append('assert_approx_equal')
-def assert_approx_equal(actual,desired,significant=7,err_msg='',verbose=1):
- """ Raise an assertion if two items are not
- equal. I think this should be part of unittest.py
- Approximately equal is defined as the number of significant digits
- correct
- """
- msg = '\nItems are not equal to %d significant digits:\n' % significant
- msg += err_msg
- actual, desired = map(float, (actual, desired))
- # Normalized the numbers to be in range (-10.0,10.0)
- scale = pow(10,math.floor(math.log10(0.5*(abs(desired)+abs(actual)))))
- try:
- sc_desired = desired/scale
- except ZeroDivisionError:
- sc_desired = 0.0
- try:
- sc_actual = actual/scale
- except ZeroDivisionError:
- sc_actual = 0.0
- try:
- if ( verbose and len(repr(desired)) < 100 and len(repr(actual)) ):
- msg = msg \
- + 'DESIRED: ' + repr(desired) \
- + '\nACTUAL: ' + repr(actual)
- except:
- msg = msg \
- + 'DESIRED: ' + repr(desired) \
- + '\nACTUAL: ' + repr(actual)
- assert math.fabs(sc_desired - sc_actual) < pow(10.,-1*significant), msg
-
-
-__all__.append('assert_array_equal')
-def assert_array_equal(x,y,err_msg=''):
- x,y = asarray(x), asarray(y)
- msg = '\nArrays are not equal'
- try:
- assert 0 in [len(shape(x)),len(shape(y))] \
- or (len(shape(x))==len(shape(y)) and \
- alltrue(equal(shape(x),shape(y)))),\
- msg + ' (shapes %s, %s mismatch):\n\t' \
- % (shape(x),shape(y)) + err_msg
- reduced = ravel(equal(x,y))
- cond = alltrue(reduced)
- if not cond:
- s1 = array2string(x,precision=16)
- s2 = array2string(y,precision=16)
- if len(s1)>120: s1 = s1[:120] + '...'
- if len(s2)>120: s2 = s2[:120] + '...'
- match = 100-100.0*reduced.tolist().count(1)/len(reduced)
- msg = msg + ' (mismatch %s%%):\n\tArray 1: %s\n\tArray 2: %s' % (match,s1,s2)
- assert cond,\
- msg + '\n\t' + err_msg
- except ValueError:
- raise ValueError, msg
-
-__all__.append('assert_array_almost_equal')
-def assert_array_almost_equal(x,y,decimal=6,err_msg=''):
- x = asarray(x)
- y = asarray(y)
- msg = '\nArrays are not almost equal'
- try:
- cond = alltrue(equal(shape(x),shape(y)))
- if not cond:
- msg = msg + ' (shapes mismatch):\n\t'\
- 'Shape of array 1: %s\n\tShape of array 2: %s' % (shape(x),shape(y))
- assert cond, msg + '\n\t' + err_msg
- reduced = ravel(equal(less_equal(around(abs(x-y),decimal),10.0**(-decimal)),1))
- cond = alltrue(reduced)
- if not cond:
- s1 = array2string(x,precision=decimal+1)
- s2 = array2string(y,precision=decimal+1)
- if len(s1)>120: s1 = s1[:120] + '...'
- if len(s2)>120: s2 = s2[:120] + '...'
- match = 100-100.0*reduced.tolist().count(1)/len(reduced)
- msg = msg + ' (mismatch %s%%):\n\tArray 1: %s\n\tArray 2: %s' % (match,s1,s2)
- assert cond,\
- msg + '\n\t' + err_msg
- except ValueError:
- print sys.exc_value
- print shape(x),shape(y)
- print x, y
- raise ValueError, 'arrays are not almost equal'
-
-__all__.append('assert_array_less')
-def assert_array_less(x,y,err_msg=''):
- x,y = asarray(x), asarray(y)
- msg = '\nArrays are not less-ordered'
- try:
- assert alltrue(equal(shape(x),shape(y))),\
- msg + ' (shapes mismatch):\n\t' + err_msg
- reduced = ravel(less(x,y))
- cond = alltrue(reduced)
- if not cond:
- s1 = array2string(x,precision=16)
- s2 = array2string(y,precision=16)
- if len(s1)>120: s1 = s1[:120] + '...'
- if len(s2)>120: s2 = s2[:120] + '...'
- match = 100-100.0*reduced.tolist().count(1)/len(reduced)
- msg = msg + ' (mismatch %s%%):\n\tArray 1: %s\n\tArray 2: %s' % (match,s1,s2)
- assert cond,\
- msg + '\n\t' + err_msg
- except ValueError:
- print shape(x),shape(y)
- raise ValueError, 'arrays are not less-ordered'
-
-__all__.append('rand')
-def rand(*args):
- """ Returns an array of random numbers with the given shape.
- used for testing
- """
- import random
- results = zeros(args,Float64)
- f = results.flat
- for i in range(len(f)):
- f[i] = random.random()
- return results
-
-def output_exception():
- try:
- type, value, tb = sys.exc_info()
- info = traceback.extract_tb(tb)
- #this is more verbose
- #traceback.print_exc()
- filename, lineno, function, text = info[-1] # last line only
- print "%s:%d: %s: %s (in %s)" %\
- (filename, lineno, type.__name__, str(value), function)
- finally:
- type = value = tb = None # clean up
-
-from scipy.base import alltrue, equal, shape, ravel, around, zeros,\
- Float64, asarray, less_equal, array2string, less, ArrayType
-
-try:
- from scipy.base import fastumath as math
-except ImportError,msg:
- print msg
- import math