tf.test.TestCase

class tf.test.TestCase

See the guide: Testing > Unit tests

Base class for tests that need to test TensorFlow.

Child Classes

class failureException

Methods

__init__(methodName='runTest')

addCleanup(function, *args, **kwargs)

Add a function, with arguments, to be called when the test is completed. Functions added are called on a LIFO basis and are called after tearDown on test failure or success.

Cleanup items are called even if setUp fails (unlike tearDown).

addTypeEqualityFunc(typeobj, function)

Add a type specific assertEqual style function to compare a type.

This method is for use by TestCase subclasses that need to register their own type equality functions to provide nicer error messages.

Args:

typeobj: The data type to call this function on when both values
        are of the same type in assertEqual().
function: The callable taking two arguments and an optional
        msg= argument that raises self.failureException with a
        useful error message when the two arguments are not equal.

assertAllClose(a, b, rtol=1e-06, atol=1e-06)

Asserts that two numpy arrays have near values.

Args:

• a: a numpy ndarray or anything can be converted to one.
• b: a numpy ndarray or anything can be converted to one.
• rtol: relative tolerance
• atol: absolute tolerance

assertAllCloseAccordingToType(a, b, rtol=1e-06, atol=1e-06)

Like assertAllClose, but also suitable for comparing fp16 arrays.

In particular, the tolerance is reduced to 1e-3 if at least one of the arguments is of type float16.

Args:

• a: a numpy ndarray or anything can be converted to one.
• b: a numpy ndarray or anything can be converted to one.
• rtol: relative tolerance
• atol: absolute tolerance

assertAllEqual(a, b)

Asserts that two numpy arrays have the same values.

Args:

• a: a numpy ndarray or anything can be converted to one.
• b: a numpy ndarray or anything can be converted to one.

assertAlmostEqual(first, second, places=None, msg=None, delta=None)

Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero, or by comparing that the between the two objects is more than the given delta.

Note that decimal places (from zero) are usually not the same as significant digits (measured from the most signficant digit).

If the two objects compare equal then they will automatically compare almost equal.

assertAlmostEquals(first, second, places=None, msg=None, delta=None)

Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero, or by comparing that the between the two objects is more than the given delta.

Note that decimal places (from zero) are usually not the same as significant digits (measured from the most signficant digit).

If the two objects compare equal then they will automatically compare almost equal.

assertArrayNear(farray1, farray2, err)

Asserts that two float arrays are near each other.

Checks that for all elements of farray1 and farray2 |f1 - f2| < err. Asserts a test failure if not.

Args:

• farray1: a list of float values.
• farray2: a list of float values.
• err: a float value.

assertDeviceEqual(device1, device2)

Asserts that the two given devices are the same.

Args:

• device1: A string device name or TensorFlow DeviceSpec object.
• device2: A string device name or TensorFlow DeviceSpec object.

assertDictContainsSubset(expected, actual, msg=None)

Checks whether actual is a superset of expected.

assertDictEqual(d1, d2, msg=None)

assertEqual(first, second, msg=None)

Fail if the two objects are unequal as determined by the '==' operator.

assertEquals(first, second, msg=None)

Fail if the two objects are unequal as determined by the '==' operator.

assertFalse(expr, msg=None)

Check that the expression is false.

assertGreater(a, b, msg=None)

Just like self.assertTrue(a > b), but with a nicer default message.

assertGreaterEqual(a, b, msg=None)

Just like self.assertTrue(a >= b), but with a nicer default message.

assertIn(member, container, msg=None)

Just like self.assertTrue(a in b), but with a nicer default message.

assertIs(expr1, expr2, msg=None)

Just like self.assertTrue(a is b), but with a nicer default message.

assertIsInstance(obj, cls, msg=None)

Same as self.assertTrue(isinstance(obj, cls)), with a nicer default message.

assertIsNone(obj, msg=None)

Same as self.assertTrue(obj is None), with a nicer default message.

assertIsNot(expr1, expr2, msg=None)

Just like self.assertTrue(a is not b), but with a nicer default message.

assertIsNotNone(obj, msg=None)

Included for symmetry with assertIsNone.

assertItemsEqual(expected_seq, actual_seq, msg=None)

An unordered sequence specific comparison. It asserts that actual_seq and expected_seq have the same element counts. Equivalent to::

self.assertEqual(Counter(iter(actual_seq)),
                 Counter(iter(expected_seq)))

Asserts that each element has the same count in both sequences. Example: - [0, 1, 1] and [1, 0, 1] compare equal. - [0, 0, 1] and [0, 1] compare unequal.

assertLess(a, b, msg=None)

Just like self.assertTrue(a < b), but with a nicer default message.

assertLessEqual(a, b, msg=None)

Just like self.assertTrue(a <= b), but with a nicer default message.

assertListEqual(list1, list2, msg=None)

A list-specific equality assertion.

Args:

list1: The first list to compare.
list2: The second list to compare.
msg: Optional message to use on failure instead of a list of
        differences.

assertMultiLineEqual(first, second, msg=None)

Assert that two multi-line strings are equal.

assertNDArrayNear(ndarray1, ndarray2, err)

Asserts that two numpy arrays have near values.

Args:

• ndarray1: a numpy ndarray.
• ndarray2: a numpy ndarray.
• err: a float. The maximum absolute difference allowed.

assertNear(f1, f2, err, msg=None)

Asserts that two floats are near each other.

Checks that |f1 - f2| < err and asserts a test failure if not.

Args:

• f1: A float value.
• f2: A float value.
• err: A float value.
• msg: An optional string message to append to the failure message.

assertNotAlmostEqual(first, second, places=None, msg=None, delta=None)

Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero, or by comparing that the between the two objects is less than the given delta.

Note that decimal places (from zero) are usually not the same as significant digits (measured from the most signficant digit).

Objects that are equal automatically fail.

assertNotAlmostEquals(first, second, places=None, msg=None, delta=None)

Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero, or by comparing that the between the two objects is less than the given delta.

Note that decimal places (from zero) are usually not the same as significant digits (measured from the most signficant digit).

Objects that are equal automatically fail.

assertNotEqual(first, second, msg=None)

Fail if the two objects are equal as determined by the '!=' operator.

assertNotEquals(first, second, msg=None)

Fail if the two objects are equal as determined by the '!=' operator.

assertNotIn(member, container, msg=None)

Just like self.assertTrue(a not in b), but with a nicer default message.

assertNotIsInstance(obj, cls, msg=None)

Included for symmetry with assertIsInstance.

assertNotRegexpMatches(text, unexpected_regexp, msg=None)

Fail the test if the text matches the regular expression.

assertProtoEquals(expected_message_maybe_ascii, message)

Asserts that message is same as parsed expected_message_ascii.

Creates another prototype of message, reads the ascii message into it and then compares them using self._AssertProtoEqual().

Args:

• expected_message_maybe_ascii: proto message in original or ascii form
• message: the message to validate

assertProtoEqualsVersion(expected, actual, producer=versions.GRAPH_DEF_VERSION, min_consumer=versions.GRAPH_DEF_VERSION_MIN_CONSUMER)

assertRaises(excClass, callableObj=None, *args, **kwargs)

Fail unless an exception of class excClass is raised by callableObj when invoked with arguments args and keyword arguments kwargs. If a different type of exception is raised, it will not be caught, and the test case will be deemed to have suffered an error, exactly as for an unexpected exception.

If called with callableObj omitted or None, will return a context object used like this::

with self.assertRaises(SomeException):
    do_something()

The context manager keeps a reference to the exception as the 'exception' attribute. This allows you to inspect the exception after the assertion::

with self.assertRaises(SomeException) as cm:
    do_something()
the_exception = cm.exception
self.assertEqual(the_exception.error_code, 3)

assertRaisesOpError(expected_err_re_or_predicate)

assertRaisesRegexp(expected_exception, expected_regexp, callable_obj=None, *args, **kwargs)

Asserts that the message in a raised exception matches a regexp.

Args:

expected_exception: Exception class expected to be raised.
expected_regexp: Regexp (re pattern object or string) expected
        to be found in error message.
callable_obj: Function to be called.
args: Extra args.
kwargs: Extra kwargs.

assertRaisesWithPredicateMatch(*args, **kwds)

Returns a context manager to enclose code expected to raise an exception.

If the exception is an OpError, the op stack is also included in the message predicate search.

Args:

• exception_type: The expected type of exception that should be raised.
• expected_err_re_or_predicate: If this is callable, it should be a function of one argument that inspects the passed-in exception and returns True (success) or False (please fail the test). Otherwise, the error message is expected to match this regular expression partially.

Returns:

A context manager to surround code that is expected to raise an exception.

assertRegexpMatches(text, expected_regexp, msg=None)

Fail the test unless the text matches the regular expression.

assertSequenceEqual(seq1, seq2, msg=None, seq_type=None)

An equality assertion for ordered sequences (like lists and tuples).

For the purposes of this function, a valid ordered sequence type is one which can be indexed, has a length, and has an equality operator.

Args:

seq1: The first sequence to compare.
seq2: The second sequence to compare.
seq_type: The expected datatype of the sequences, or None if no
        datatype should be enforced.
msg: Optional message to use on failure instead of a list of
        differences.

assertSetEqual(set1, set2, msg=None)

A set-specific equality assertion.

Args:

set1: The first set to compare.
set2: The second set to compare.
msg: Optional message to use on failure instead of a list of
        differences.

assertSetEqual uses ducktyping to support different types of sets, and is optimized for sets specifically (parameters must support a difference method).

assertShapeEqual(np_array, tf_tensor)

Asserts that a Numpy ndarray and a TensorFlow tensor have the same shape.

Args:

• np_array: A Numpy ndarray or Numpy scalar.
• tf_tensor: A Tensor.

Raises:

• TypeError: If the arguments have the wrong type.

assertStartsWith(actual, expected_start, msg=None)

Assert that actual.startswith(expected_start) is True.

Args:

• actual: str
• expected_start: str
• msg: Optional message to report on failure.

assertTrue(expr, msg=None)

Check that the expression is true.

assertTupleEqual(tuple1, tuple2, msg=None)

A tuple-specific equality assertion.

Args:

tuple1: The first tuple to compare.
tuple2: The second tuple to compare.
msg: Optional message to use on failure instead of a list of
        differences.

assert_(expr, msg=None)

Check that the expression is true.

checkedThread(target, args=None, kwargs=None)

Returns a Thread wrapper that asserts 'target' completes successfully.

This method should be used to create all threads in test cases, as otherwise there is a risk that a thread will silently fail, and/or assertions made in the thread will not be respected.

Args:

• target: A callable object to be executed in the thread.
• args: The argument tuple for the target invocation. Defaults to ().
• kwargs: A dictionary of keyword arguments for the target invocation. Defaults to {}.

Returns:

A wrapper for threading.Thread that supports start() and join() methods.

countTestCases()

debug()

Run the test without collecting errors in a TestResult

defaultTestResult()

doCleanups()

Execute all cleanup functions. Normally called for you after tearDown.

fail(msg=None)

Fail immediately, with the given message.

failIf(*args, **kwargs)

failIfAlmostEqual(*args, **kwargs)

failIfEqual(*args, **kwargs)

failUnless(*args, **kwargs)

failUnlessAlmostEqual(*args, **kwargs)

failUnlessEqual(*args, **kwargs)

failUnlessRaises(*args, **kwargs)

get_temp_dir()

Returns a unique temporary directory for the test to use.

Across different test runs, this method will return a different folder. This will ensure that across different runs tests will not be able to pollute each others environment.

Returns:

string, the path to the unique temporary directory created for this test.

id()

run(result=None)

setUp()

setUpClass(cls)

Hook method for setting up class fixture before running tests in the class.

shortDescription()

Returns a one-line description of the test, or None if no description has been provided.

The default implementation of this method returns the first line of the specified test method's docstring.

skipTest(reason)

Skip this test.

tearDown()

tearDownClass(cls)

Hook method for deconstructing the class fixture after running all tests in the class.

test_session(*args, **kwds)

Returns a TensorFlow Session for use in executing tests.

This method should be used for all functional tests.

Use the use_gpu and force_gpu options to control where ops are run. If force_gpu is True, all ops are pinned to /gpu:0. Otherwise, if use_gpu is True, TensorFlow tries to run as many ops on the GPU as possible. If both force_gpu anduse_gpu` are False, all ops are pinned to the CPU.

Example:

class MyOperatorTest(test_util.TensorFlowTestCase): def testMyOperator(self): with self.test_session(use_gpu=True): valid_input = [1.0, 2.0, 3.0, 4.0, 5.0] result = MyOperator(valid_input).eval() self.assertEqual(result, [1.0, 2.0, 3.0, 5.0, 8.0] invalid_input = [-1.0, 2.0, 7.0] with self.assertRaisesOpError("negative input not supported"): MyOperator(invalid_input).eval()

Args:

• graph: Optional graph to use during the returned session.
• config: An optional config_pb2.ConfigProto to use to configure the session.
• use_gpu: If True, attempt to run as many ops as possible on GPU.
• force_gpu: If True, pin all ops to /gpu:0.

Returns:

A Session object that should be used as a context manager to surround the graph building and execution code in a test case.

Class Members

longMessage

maxDiff

Defined in tensorflow/python/framework/test_util.py.