/usr/share/pyshared/tables/tests/common.py is in python-tables 2.3.1-2ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 | """
Utilities for PyTables' test suites
===================================
:Author: Ivan Vilata i Balaguer
:Contact: ivan@selidor.net
:Created: 2005-05-24
:License: BSD
:Revision: $Id$
"""
import unittest
import tempfile
import os
import os.path
import warnings
import sys
import time
import numpy
# numarray and Numeric has serious problems with Python2.5 and 64-bit
# platforms, so we won't even try to import them on this scenario
plat64 = (numpy.int_(0).itemsize == 8)
py25 = (sys.version_info[0] >= 2 and sys.version_info[1] >= 5)
# Numeric and numarray are now deprecated
if False: # if not (plat64 and py25):
try:
import numarray
import numarray.strings
import numarray.records
numarray_imported = True
except ImportError:
numarray_imported = False
try:
import Numeric
numeric_imported = True
except ImportError:
numeric_imported = False
else:
numarray_imported = False
numeric_imported = False
if plat64 and py25 and (numarray_imported or numeric_imported):
print "***Python2.5 in 64-bit platform detected: disabling numarray/Numeric tests***"
import tables
if numarray_imported == True:
# Import nra module only if numarray is installed
from tables import nra
verbose = False
"""Show detailed output of the testing process."""
heavy = False
"""Run all tests even when they take long to complete."""
show_memory = False
"""Show the progress of memory consumption."""
if 'verbose' in sys.argv:
verbose = True
sys.argv.remove('verbose')
if 'silent' in sys.argv: # take care of old flag, just in case
verbose = False
sys.argv.remove('silent')
if '--heavy' in sys.argv:
heavy = True
sys.argv.remove('--heavy')
# Map between PyTables types and Numeric typecodes
typecode = {
'bool': 'B',
'int8': '1',
'int16': 's',
'int32': 'i',
'int64': 'N',
'uint8': 'b',
'uint16': 'w',
'uint32': 'u',
'uint64': 'U',
'float32': 'f',
'float64': 'd',
'complex64': 'F',
'complex128': 'D',
}
def verbosePrint(string, nonl=False):
"""Print out the `string` if verbose output is enabled."""
if not verbose:
return
if nonl:
print string,
else:
print string
def cleanup(klass):
#klass.__dict__.clear() # This is too hard. Don't do that
# print "Class attributes deleted"
for key in klass.__dict__.keys():
if not klass.__dict__[key].__class__.__name__ in ('instancemethod'):
klass.__dict__[key] = None
def allequal(a,b, flavor="numpy"):
"""Checks if two numerical objects are equal"""
#print "a-->", repr(a)
#print "b-->", repr(b)
if not hasattr(b, "shape"):
# Scalar case
return a == b
if flavor == "numeric":
# Convert the parameters to numpy objects
if a.typecode() == "c":
shape = a.shape
if shape == ():
a = numpy.array(a.tostring(), dtype="S1")
else:
a = numpy.array(a.tolist(), dtype="S1")
a.shape = shape
shape = b.shape
if shape == ():
b = numpy.array(a.tostring(), dtype="S1")
else:
b = numpy.array(a.tolist(), dtype="S1")
b.shape = shape
else:
a = numpy.asarray(a)
b = numpy.asarray(b)
elif flavor == "numarray":
# Convert the parameters to numpy objects
a = numpy.asarray(a)
b = numpy.asarray(b)
if ((not hasattr(a, "shape") or a.shape == ()) and
(not hasattr(b, "shape") or b.shape == ())):
return a == b
if a.shape != b.shape:
if verbose:
print "Shape is not equal:", a.shape, "!=", b.shape
return 0
# Way to check the type equality without byteorder considerations
if hasattr(b, "dtype") and a.dtype.str[1:] != b.dtype.str[1:]:
if verbose:
print "dtype is not equal:", a.dtype, "!=", b.dtype
return 0
# Rank-0 case
if len(a.shape) == 0:
if a[()] == b[()]:
return 1
else:
if verbose:
print "Shape is not equal:", a.shape, "!=", b.shape
return 0
# null arrays
if a.size == 0: # len(a) is not correct for generic shapes
if b.size == 0:
return 1
else:
if verbose:
print "length is not equal"
print "len(a.data) ==>", len(a.data)
print "len(b.data) ==>", len(b.data)
return 0
# Multidimensional case
result = (a == b)
result = numpy.all(result)
if not result and verbose:
print "Some of the elements in arrays are not equal"
return result
def areArraysEqual(arr1, arr2):
"""
Are both `arr1` and `arr2` equal arrays?
Arguments can be regular NumPy arrays, chararray arrays or record
arrays (including nested record arrays). They are checked for type
and value equality.
"""
t1 = type(arr1)
t2 = type(arr2)
if not ((hasattr(arr1, 'dtype') and arr1.dtype == arr2.dtype) or
issubclass(t1, t2) or issubclass(t2, t1)):
return False
if numarray_imported:
if isinstance(arr1, nra.NestedRecArray):
arr1 = arr1.asRecArray()
if isinstance(arr2, nra.NestedRecArray):
arr2 = arr2.asRecArray()
if isinstance(arr1, nra.NestedRecord):
row = arr1.row
arr1 = arr1.array[row:row+1]
if isinstance(arr2, nra.NestedRecord):
row = arr2.row
arr2 = arr2.array[row:row+1]
if numarray_imported and isinstance(arr1, numarray.records.RecArray):
arr1Names = arr1._names
arr2Names = arr2._names
if arr1Names != arr2Names:
return False
for fieldName in arr1Names:
if not areArraysEqual(arr1.field(fieldName),
arr2.field(fieldName)):
return False
return True
if numarray_imported and isinstance(arr1, numarray.NumArray):
if arr1.shape != arr2.shape:
return False
if arr1.type() != arr2.type():
return False
# The lines below are equivalent
#return numarray.alltrue(arr1.flat == arr2.flat)
return numarray.all(arr1 == arr2)
if numarray_imported and isinstance(arr1, numarray.strings.CharArray):
if arr1.shape != arr2.shape:
return False
if arr1._type != arr2._type:
return False
return numarray.all(arr1 == arr2)
return numpy.all(arr1 == arr2)
def pyTablesTest(oldmethod):
def newmethod(self, *args, **kwargs):
self._verboseHeader()
try:
try:
return oldmethod(self, *args, **kwargs)
except SkipTest, se:
if se.args:
msg = se.args[0]
else:
msg = "<skipped>"
verbosePrint("\nSkipped test: %s" % msg)
except self.failureException, fe:
if fe.args:
msg = fe.args[0]
else:
msg = "<failed>"
verbosePrint("\nTest failed: %s" % msg)
raise
except Exception, exc:
cname = exc.__class__.__name__
verbosePrint("\nError in test::\n\n %s: %s" % (cname, exc))
raise
finally:
verbosePrint('') # separator line between tests
newmethod.__name__ = oldmethod.__name__
newmethod.__doc__ = oldmethod.__doc__
return newmethod
class SkipTest(Exception):
"""When this exception is raised, the test is skipped successfully."""
pass
class MetaPyTablesTestCase(type):
"""Metaclass for PyTables test case classes."""
# http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/198078
def __new__(class_, name, bases, dict_):
newdict = {}
for (aname, avalue) in dict_.iteritems():
if callable(avalue) and aname.startswith('test'):
avalue = pyTablesTest(avalue)
newdict[aname] = avalue
return type.__new__(class_, name, bases, newdict)
class PyTablesTestCase(unittest.TestCase):
"""Abstract test case with useful methods."""
__metaclass__ = MetaPyTablesTestCase
def _getName(self):
"""Get the name of this test case."""
return self.id().split('.')[-2]
def _getMethodName(self):
"""Get the name of the method currently running in the test case."""
return self.id().split('.')[-1]
def _verboseHeader(self):
"""Print a nice header for the current test method if verbose."""
if verbose:
name = self._getName()
methodName = self._getMethodName()
title = "Running %s.%s" % (name, methodName)
print '%s\n%s' % (title, '-'*len(title))
@classmethod
def _testFilename(class_, filename):
"""
Returns an absolute version of the `filename`, taking care of
the location of the calling test case class.
"""
modname = class_.__module__
# When the definitive switch to ``setuptools`` is made,
# this should definitely use the ``pkg_resouces`` API::
#
# return pkg_resources.resource_filename(modname, filename)
#
modfile = sys.modules[modname].__file__
dirname = os.path.dirname(modfile)
return os.path.join(dirname, filename)
def failUnlessWarns(self, warnClass, callableObj, *args, **kwargs):
"""
Fail unless a warning of class `warnClass` is issued.
This method will fail if no warning belonging to the given
`warnClass` is issued when invoking `callableObj` with arguments
`args` and keyword arguments `kwargs`. Warnings of the
`warnClass` are hidden, while others are shown.
This method returns the value returned by the call to
`callableObj`.
"""
issued = [False] # let's avoid scoping problems ;)
# Save the original warning-showing function.
showwarning = warnings.showwarning
# This warning-showing function hides and takes note
# of expected warnings and acts normally on others.
def myShowWarning(message, category, filename, lineno,
file=None, line=None):
if issubclass(category, warnClass):
issued[0] = True
verbosePrint(
"Great! The following ``%s`` was caught::\n"
"\n"
" %s\n"
"\n"
"In file ``%s``, line number %d.\n"
% (category.__name__, message, filename, lineno))
else:
showwarning(message, category, filename, lineno, file, line)
# By forcing Python to always show warnings of the wanted class,
# and replacing the warning-showing function with a tailored one,
# we can check for *every* occurence of the warning.
warnings.filterwarnings('always', category=warnClass)
warnings.showwarning = myShowWarning
try:
# Run code and see what happens.
ret = callableObj(*args, **kwargs)
finally:
# Restore the original warning-showing function
# and warning filter.
warnings.showwarning = showwarning
warnings.filterwarnings('default', category=warnClass)
if not issued[0]:
raise self.failureException(
"``%s`` was not issued" % warnClass.__name__)
# We only get here if the call to `callableObj` was successful
# and it issued the expected warning.
return ret
assertWarns = failUnlessWarns
def failUnlessRaises(self, excClass, callableObj, *args, **kwargs):
if not verbose:
# Use the ordinary implementation from `unittest.TestCase`.
return super(PyTablesTestCase, self).assertRaises(
excClass, callableObj, *args, **kwargs)
try:
callableObj(*args, **kwargs)
except excClass, exc:
print (
"Great! The following ``%s`` was caught::\n"
"\n"
" %s\n"
% (exc.__class__.__name__, exc))
else:
raise self.failureException(
"``%s`` was not raised" % excClass.__name__)
assertRaises = failUnlessRaises
def _checkEqualityGroup(self, node1, node2, hardlink=False):
if verbose:
print "Group 1:", node1
print "Group 2:", node2
if hardlink:
self.assert_(node1._v_pathname != node2._v_pathname,
"node1 and node2 have the same pathnames.")
else:
self.assert_(node1._v_pathname == node2._v_pathname,
"node1 and node2 does not have the same pathnames.")
self.assert_(node1._v_children == node2._v_children,
"node1 and node2 does not have the same children.")
def _checkEqualityLeaf(self, node1, node2, hardlink=False):
if verbose:
print "Leaf 1:", node1
print "Leaf 2:", node2
if hardlink:
self.assert_(node1._v_pathname != node2._v_pathname,
"node1 and node2 have the same pathnames.")
else:
self.assert_(node1._v_pathname == node2._v_pathname,
"node1 and node2 does not have the same pathnames.")
self.assert_(areArraysEqual(node1[:], node2[:]),
"node1 and node2 does not have the same values.")
class TempFileMixin:
def setUp(self):
"""
Set ``h5file`` and ``h5fname`` instance attributes.
* ``h5fname``: the name of the temporary HDF5 file.
* ``h5file``: the writable, empty, temporary HDF5 file.
"""
self.h5fname = tempfile.mktemp(suffix='.h5')
self.h5file = tables.openFile(
self.h5fname, 'w', title=self._getName())
def tearDown(self):
"""Close ``h5file`` and remove ``h5fname``."""
self.h5file.close()
self.h5file = None
os.remove(self.h5fname) # comment this for debugging purposes only
def _reopen(self, mode='r'):
"""Reopen ``h5file`` in the specified ``mode``.
Returns a true or false value depending on whether the file was
reopenend or not. If not, nothing is changed.
"""
self.h5file.close()
self.h5file = tables.openFile(self.h5fname, mode)
return True
class ShowMemTime(PyTablesTestCase):
tref = time.time()
"""Test for showing memory and time consumption."""
def test00(self):
"""Showing memory and time consumption."""
# Obtain memory info (only for Linux 2.6.x)
for line in open("/proc/self/status"):
if line.startswith("VmSize:"):
vmsize = int(line.split()[1])
elif line.startswith("VmRSS:"):
vmrss = int(line.split()[1])
elif line.startswith("VmData:"):
vmdata = int(line.split()[1])
elif line.startswith("VmStk:"):
vmstk = int(line.split()[1])
elif line.startswith("VmExe:"):
vmexe = int(line.split()[1])
elif line.startswith("VmLib:"):
vmlib = int(line.split()[1])
print "\nWallClock time:", time.time() - self.tref
print "Memory usage: ******* %s *******" % self._getName()
print "VmSize: %7s kB\tVmRSS: %7s kB" % (vmsize, vmrss)
print "VmData: %7s kB\tVmStk: %7s kB" % (vmdata, vmstk)
print "VmExe: %7s kB\tVmLib: %7s kB" % (vmexe, vmlib)
## Local Variables:
## mode: python
## py-indent-offset: 4
## tab-width: 4
## fill-column: 72
## End:
|