tfds.testing.DatasetBuilderTestCase

View source on GitHub

Inherit this class to test your DatasetBuilder class.

Inherits From: SubTestCase, TestCase

tfds.testing.DatasetBuilderTestCase(
    methodName='runTest'
)

You must set the following class attributes:

• DATASET_CLASS: class object of DatasetBuilder you want to test.
• SPLITS: dict mapping split name to expected number of examples.

You may set the following class attributes:

• VERSION: str. The version used to run the test. eg: '1.2.*'. Defaults to None (canonical version).
• BUILDER_CONFIG_NAMES_TO_TEST: list[str | tfds.core.BuilderConfig], the list of builder configs that should be tested. If None, all the BUILDER_CONFIGS from the class will be tested.
• DL_EXTRACT_RESULT: dict[str, str], the returned result of mocked download_and_extract method. The values should be the path of files present in the fake_examples directory, relative to that directory. If not specified, path to fake_examples will always be returned.
• DL_EXTRACT_ONLY_RESULT: dict[str, str], the returned result of mocked extract method. The values should be the path of files present in the fake_examples directory, relative to that directory. If not specified: will call DownloadManager extract method.
• DL_DOWNLOAD_RESULT: dict[str, str], the returned result of mocked download_and_extract method. The values should be the path of files present in the fake_examples directory, relative to that directory. If not specified: will use DL_EXTRACT_RESULT (this is due to backwards compatibility and will be removed in the future).
• EXAMPLE_DIR: str, the base directory in in which fake examples are contained. Optional; defaults to <dataset dir>/dummy_data/.
• OVERLAPPING_SPLITS: list[str], splits containing examples from other splits (e.g. a "example" split containing pictures from other splits).
• MOCK_OUT_FORBIDDEN_OS_FUNCTIONS: bool, defaults to True. Set to False to disable checks preventing usage of os or builtin functions instead of recommended tf.io.gfile API.
• SKIP_CHECKSUMS: Checks that the urls called by dl_manager.download are registered.
• SKIP_TF1_GRAPH_MODE: Runs in eager mode only.

This test case will check for the following:

• the dataset builder is correctly registered, i.e. tfds.load(name) works;
• the dataset builder can read the fake examples stored in testing/test_data/fake_examples/{dataset_name};
• the dataset builder can produce serialized data;
• the dataset builder produces a valid Dataset object from serialized data
  • in eager mode;
  • in graph mode.
• the produced Dataset examples have the expected dimensions and types;
• the produced Dataset has and the expected number of examples;
• a example is not part of two splits, or one of these splits is whitelisted in OVERLAPPING_SPLITS.

Child Classes

class failureException

Methods

addClassCleanup

@classmethod
addClassCleanup(
    function, *args, /, **kwargs
)

Same as addCleanup, except the cleanup items are called even if setUpClass fails (unlike tearDownClass).

addCleanup

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

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.

assertAllClose

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

Asserts that two structures of numpy arrays or Tensors, have near values.

a and b can be arbitrarily nested structures. A layer of a nested structure can be a dict, namedtuple, tuple or list.

assertAllCloseAccordingToType

assertAllCloseAccordingToType(
    a,
    b,
    rtol=1e-06,
    atol=1e-06,
    float_rtol=1e-06,
    float_atol=1e-06,
    half_rtol=0.001,
    half_atol=0.001,
    bfloat16_rtol=0.01,
    bfloat16_atol=0.01,
    msg=None
)

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.

assertAllEqual

assertAllEqual(
    a, b, msg=None
)

Asserts that two numpy arrays or Tensors have the same values.

assertAllEqualNested

View source

assertAllEqualNested(
    d1, d2, *, atol: Optional[float] = None
)

Same as assertAllEqual but compatible with nested dict.

assertAllGreater

assertAllGreater(
    a, comparison_target
)

Assert element values are all greater than a target value.

assertAllGreaterEqual

assertAllGreaterEqual(
    a, comparison_target
)

Assert element values are all greater than or equal to a target value.

assertAllInRange

assertAllInRange(
    target,
    lower_bound,
    upper_bound,
    open_lower_bound=False,
    open_upper_bound=False
)

Assert that elements in a Tensor are all in a given range.

assertAllInSet

assertAllInSet(
    target, expected_set
)

Assert that elements of a Tensor are all in a given closed set.

assertAllLess

assertAllLess(
    a, comparison_target
)

Assert element values are all less than a target value.

assertAllLessEqual

assertAllLessEqual(
    a, comparison_target
)

Assert element values are all less than or equal to a target value.

assertAlmostEqual

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 difference 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 significant digit).

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

assertAlmostEquals

assertAlmostEquals(
    *args, **kwargs
)

assertArrayNear

assertArrayNear(
    farray1, farray2, err, msg=None
)

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.

assertBetween

assertBetween(
    value, minv, maxv, msg=None
)

Asserts that value is between minv and maxv (inclusive).

assertCommandFails

assertCommandFails(
    command, regexes, env=None, close_fds=True, msg=None
)

Asserts a shell command fails and the error matches a regex in a list.

assertCommandSucceeds

assertCommandSucceeds(
    command, regexes=(b'',), env=None, close_fds=True, msg=None
)

Asserts that a shell command succeeds (i.e. exits with code 0).

assertContainsExactSubsequence

assertContainsExactSubsequence(
    container, subsequence, msg=None
)

Asserts that "container" contains "subsequence" as an exact subsequence.

Asserts that "container" contains all the elements of "subsequence", in order, and without other elements interspersed. For example, [1, 2, 3] is an exact subsequence of [0, 0, 1, 2, 3, 0] but not of [0, 0, 1, 2, 0, 3, 0].

assertContainsInOrder

assertContainsInOrder(
    strings, target, msg=None
)

Asserts that the strings provided are found in the target in order.

This may be useful for checking HTML output.

assertContainsSubsequence

assertContainsSubsequence(
    container, subsequence, msg=None
)

Asserts that "container" contains "subsequence" as a subsequence.

Asserts that "container" contains all the elements of "subsequence", in order, but possibly with other elements interspersed. For example, [1, 2, 3] is a subsequence of [0, 0, 1, 2, 0, 3, 0] but not of [0, 0, 1, 3, 0, 2, 0].

assertContainsSubset

assertContainsSubset(
    expected_subset, actual_set, msg=None
)

Checks whether actual iterable is a superset of expected iterable.

assertCountEqual

assertCountEqual(
    first, second, msg=None
)

Asserts that two iterables have the same elements, the same number of times, without regard to order.

self.assertEqual(Counter(list(first)),
                 Counter(list(second)))

Example:

- [0, 1, 1] and [1, 0, 1] compare equal.
- [0, 0, 1] and [0, 1] compare unequal.

assertDTypeEqual

assertDTypeEqual(
    target, expected_dtype
)

Assert ndarray data type is equal to expected.

assertDataclassEqual

assertDataclassEqual(
    first, second, msg=None
)

Asserts two dataclasses are equal with more informative errors.

Arguments must both be dataclasses. This compares equality of individual fields and takes care to not compare fields that are marked as non-comparable. It gives per field differences, which are easier to parse than the comparison of the string representations from assertEqual.

In cases where the dataclass has a custom eq, and it is defined in a way that is inconsistent with equality of comparable fields, we raise an exception without further trying to figure out how they are different.

assertDeviceEqual

assertDeviceEqual(
    device1, device2, msg=None
)

Asserts that the two given devices are the same.

assertDictContainsSubset

assertDictContainsSubset(
    subset, dictionary, msg=None
)

Checks whether dictionary is a superset of subset.

assertDictEqual

assertDictEqual(
    a, b, msg=None
)

Assert that two given dictionary of tensors are the same.

assertEmpty

assertEmpty(
    container, msg=None
)

Asserts that an object has zero length.

assertEndsWith

assertEndsWith(
    actual, expected_end, msg=None
)

Asserts that actual.endswith(expected_end) is True.

assertEqual

assertEqual(
    first, second, msg=None
)

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

assertEquals

assertEquals(
    *args, **kwargs
)

assertFalse

assertFalse(
    expr, msg=None
)

Check that the expression is false.

assertGreater

assertGreater(
    a, b, msg=None
)

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

assertGreaterEqual

assertGreaterEqual(
    a, b, msg=None
)

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

assertIn

assertIn(
    member, container, msg=None
)

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

assertIs

assertIs(
    expr1, expr2, msg=None
)

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

assertIsInstance

assertIsInstance(
    obj, cls, msg=None
)

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

assertIsNone

assertIsNone(
    obj, msg=None
)

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

assertIsNot

assertIsNot(
    expr1, expr2, msg=None
)

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

assertIsNotNone

assertIsNotNone(
    obj, msg=None
)

Included for symmetry with assertIsNone.

assertItemsEqual

assertItemsEqual(
    first, second, msg=None
)

Asserts that two iterables have the same elements, the same number of times, without regard to order.

self.assertEqual(Counter(list(first)),
                 Counter(list(second)))

Example:

- [0, 1, 1] and [1, 0, 1] compare equal.
- [0, 0, 1] and [0, 1] compare unequal.

assertJsonEqual

assertJsonEqual(
    first, second, msg=None
)

Asserts that the JSON objects defined in two strings are equal.

A summary of the differences will be included in the failure message using assertSameStructure.

assertLen

assertLen(
    container, expected_len, msg=None
)

Asserts that an object has the expected length.

assertLess

assertLess(
    a, b, msg=None
)

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

assertLessEqual

assertLessEqual(
    a, b, msg=None
)

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

assertListEqual

assertListEqual(
    list1, list2, msg=None
)

A list-specific equality assertion.

assertLogs

View source

@contextlib.contextmanager
assertLogs(
    text, level='info'
)

Fail unless a log message of level level or higher is emitted on logger_name or its children. If omitted, level defaults to INFO and logger defaults to the root logger.

This method must be used as a context manager, and will yield a recording object with two attributes: output and records. At the end of the context manager, the output attribute will be a list of the matching formatted log messages and the records attribute will be a list of the corresponding LogRecord objects.

Example::

with self.assertLogs('foo', level='INFO') as cm:
    logging.getLogger('foo').info('first message')
    logging.getLogger('foo.bar').error('second message')
self.assertEqual(cm.output, ['INFO:foo:first message',
                             'ERROR:foo.bar:second message'])

assertMultiLineEqual

assertMultiLineEqual(
    first, second, msg=None, **kwargs
)

Asserts that two multi-line strings are equal.

assertNDArrayNear

assertNDArrayNear(
    ndarray1, ndarray2, err, msg=None
)

Asserts that two numpy arrays have near values.

assertNear

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.

assertNoCommonElements

assertNoCommonElements(
    expected_seq, actual_seq, msg=None
)

Checks whether actual iterable and expected iterable are disjoint.

assertNotAllClose

assertNotAllClose(
    a, b, rtol=1e-06, atol=1e-06, msg=None
)

Assert that two numpy arrays, or Tensors, do not have near values.

assertNotAllEqual

assertNotAllEqual(
    a, b, msg=None
)

Asserts that two numpy arrays or Tensors do not have the same values.

assertNotAlmostEqual

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 difference 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 significant digit).

Objects that are equal automatically fail.

assertNotAlmostEquals

assertNotAlmostEquals(
    *args, **kwargs
)

assertNotEmpty

assertNotEmpty(
    container, msg=None
)

Asserts that an object has non-zero length.

assertNotEndsWith

assertNotEndsWith(
    actual, unexpected_end, msg=None
)

Asserts that actual.endswith(unexpected_end) is False.

assertNotEqual

assertNotEqual(
    first, second, msg=None
)

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

assertNotEquals

assertNotEquals(
    *args, **kwargs
)

assertNotIn

assertNotIn(
    member, container, msg=None
)

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

assertNotIsInstance

assertNotIsInstance(
    obj, cls, msg=None
)

Included for symmetry with assertIsInstance.

assertNotRegex

assertNotRegex(
    text, unexpected_regex, msg=None
)

Fail the test if the text matches the regular expression.

assertNotRegexpMatches

assertNotRegexpMatches(
    *args, **kwargs
)

assertNotStartsWith

assertNotStartsWith(
    actual, unexpected_start, msg=None
)

Asserts that actual.startswith(unexpected_start) is False.

assertProtoEquals

assertProtoEquals(
    expected_message_maybe_ascii, message, msg=None, relative_tolerance=None
)

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().

assertProtoEqualsVersion

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

assertRaises

assertRaises(
    expected_exception, *args, **kwargs
)

Fail unless an exception of class expected_exception is raised by the callable when invoked with specified positional and keyword arguments. 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 the callable and arguments omitted, will return a context object used like this::

 with self.assertRaises(SomeException):
     do_something()

An optional keyword argument 'msg' can be provided when assertRaises is used as a context object.

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)

assertRaisesIncompatibleShapesError

assertRaisesIncompatibleShapesError(
    exception_type=errors.InvalidArgumentError
)

assertRaisesOpError

assertRaisesOpError(
    expected_err_re_or_predicate
)

assertRaisesRegex

assertRaisesRegex(
    expected_exception, expected_regex, *args, **kwargs
)

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

assertRaisesRegexp

assertRaisesRegexp(
    expected_exception, expected_regex, *args, **kwargs
)

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

assertRaisesWithLiteralMatch

assertRaisesWithLiteralMatch(
    expected_exception,
    expected_exception_message,
    callable_obj=None,
    *args,
    **kwargs
)

Asserts that the message in a raised exception equals the given string.

Unlike assertRaisesRegex, this method takes a literal string, not a regular expression.

with self.assertRaisesWithLiteralMatch(ExType, 'message'): DoSomething()

assertRaisesWithPredicateMatch

View source

assertRaisesWithPredicateMatch(
    err_type, predicate
)

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.

assertRegex

assertRegex(
    text, expected_regex, msg=None
)

Fail the test unless the text matches the regular expression.

assertRegexMatch

assertRegexMatch(
    actual_str, regexes, message=None
)

Asserts that at least one regex in regexes matches str.

If possible you should use assertRegex, which is a simpler version of this method. assertRegex takes a single regular expression (a string or re compiled object) instead of a list.

Notes:

1. This function uses substring matching, i.e. the matching succeeds if any substring of the error message matches any regex in the list. This is more convenient for the user than full-string matching.

2. If regexes is the empty list, the matching will always fail.

3. Use regexes=[''] for a regex that will always pass.

4. '.' matches any single character except the newline. To match any character, use '(.|\n)'.

5. '^' matches the beginning of each line, not just the beginning of the string. Similarly, '$' matches the end of each line.

6. An exception will be thrown if regexes contains an invalid regex.

assertRegexpMatches

assertRegexpMatches(
    *args, **kwargs
)

assertSameElements

assertSameElements(
    expected_seq, actual_seq, msg=None
)

Asserts that two sequences have the same elements (in any order).

This method, unlike assertCountEqual, doesn't care about any duplicates in the expected and actual sequences::

# Doesn't raise an AssertionError
assertSameElements([1, 1, 1, 0, 0, 0], [0, 1])

If possible, you should use assertCountEqual instead of assertSameElements.

assertSameStructure

assertSameStructure(
    a, b, aname='a', bname='b', msg=None
)

Asserts that two values contain the same structural content.

The two arguments should be data trees consisting of trees of dicts and lists. They will be deeply compared by walking into the contents of dicts and lists; other items will be compared using the == operator. If the two structures differ in content, the failure message will indicate the location within the structures where the first difference is found. This may be helpful when comparing large structures.

Mixed Sequence and Set types are supported. Mixed Mapping types are supported, but the order of the keys will not be considered in the comparison.

assertSequenceAlmostEqual

assertSequenceAlmostEqual(
    expected_seq, actual_seq, places=None, msg=None, delta=None
)

An approximate equality assertion for ordered sequences.

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

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

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

assertSequenceEqual

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.

assertSequenceStartsWith

assertSequenceStartsWith(
    prefix, whole, msg=None
)

An equality assertion for the beginning of ordered sequences.

If prefix is an empty sequence, it will raise an error unless whole is also an empty sequence.

If prefix is not a sequence, it will raise an error if the first element of whole does not match.

assertSetEqual

assertSetEqual(
    set1, set2, msg=None
)

A set-specific equality assertion.

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

assertShapeEqual

assertShapeEqual(
    input_a, input_b, msg=None
)

Asserts that two Numpy or TensorFlow objects have the same shape.

For Tensors, this compares statically known shapes at compile time, not dynamic shapes at runtime.

assertStartsWith

assertStartsWith(
    actual, expected_start, msg=None
)

Assert that actual.startswith(expected_start) is True.

assertTotallyOrdered

assertTotallyOrdered(
    *groups, **kwargs
)

Asserts that total ordering has been implemented correctly.

For example, say you have a class A that compares only on its attribute x. Comparators other than __lt__ are omitted for brevity::

class A(object):
  def __init__(self, x, y):
    self.x = x
    self.y = y

  def __hash__(self):
    return hash(self.x)

  def __lt__(self, other):
    try:
      return self.x < other.x
    except AttributeError:
      return NotImplemented

assertTotallyOrdered will check that instances can be ordered correctly. For example::

self.assertTotallyOrdered(
    [None],  # None should come before everything else.
    [1],  # Integers sort earlier.
    [A(1, 'a')],
    [A(2, 'b')],  # 2 is after 1.
    [A(3, 'c'), A(3, 'd')],  # The second argument is irrelevant.
    [A(4, 'z')],
    ['foo'])  # Strings sort last.

assertTrue

assertTrue(
    expr, msg=None
)

Check that the expression is true.

assertTupleEqual

assertTupleEqual(
    tuple1, tuple2, msg=None
)

A tuple-specific equality assertion.

assertUrlEqual

assertUrlEqual(
    a, b, msg=None
)

Asserts that urls are equal, ignoring ordering of query params.

assertWarns

assertWarns(
    expected_warning, *args, **kwargs
)

Fail unless a warning of class warnClass is triggered by the callable when invoked with specified positional and keyword arguments. If a different type of warning is triggered, it will not be handled: depending on the other warning filtering rules in effect, it might be silenced, printed out, or raised as an exception.

If called with the callable and arguments omitted, will return a context object used like this::

 with self.assertWarns(SomeWarning):
     do_something()

An optional keyword argument 'msg' can be provided when assertWarns is used as a context object.

The context manager keeps a reference to the first matching warning as the 'warning' attribute; similarly, the 'filename' and 'lineno' attributes give you information about the line of Python code from which the warning was triggered. This allows you to inspect the warning after the assertion::

with self.assertWarns(SomeWarning) as cm:
    do_something()
the_warning = cm.warning
self.assertEqual(the_warning.some_attribute, 147)

assertWarnsRegex

assertWarnsRegex(
    expected_warning, expected_regex, *args, **kwargs
)

Asserts that the message in a triggered warning matches a regexp. Basic functioning is similar to assertWarns() with the addition that only warnings whose messages also match the regular expression are considered successful matches.

assert_

assert_(
    *args, **kwargs
)

cached_session

@contextlib.contextmanager
cached_session(
    graph: Optional[ops.Graph] = None,
    config: Optional[config_pb2.ConfigProto] = None,
    use_gpu: bool = True,
    force_gpu: bool = False
) -> Iterator[s.Session]

Returns a TensorFlow Session for use in executing tests.

This method behaves differently than self.session(): for performance reasons cached_session will by default reuse the same session within the same test. The session returned by this function will only be closed at the end of the test (in the TearDown function).

Use the use_gpu and force_gpu options to control where ops are run. If force_gpu is True, all ops are pinned to /device: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.cached_session() as sess:
      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()

captureWritesToStream

@contextlib.contextmanager
captureWritesToStream(
    stream
) -> Iterator[CapturedWrites]

A context manager that captures the writes to a given stream.

This context manager captures all writes to a given stream inside of a CapturedWrites object. When this context manager is created, it yields the CapturedWrites object. The captured contents can be accessed by calling .contents() on the CapturedWrites.

For this function to work, the stream must have a file descriptor that can be modified using os.dup and os.dup2, and the stream must support a .flush() method. The default python sys.stdout and sys.stderr are examples of this. Note that this does not work in Colab or Jupyter notebooks, because those use alternate stdout streams.

Example:

class MyOperatorTest(test_util.TensorFlowTestCase):
  def testMyOperator(self):
    input = [1.0, 2.0, 3.0, 4.0, 5.0]
    with self.captureWritesToStream(sys.stdout) as captured:
      result = MyOperator(input).eval()
    self.assertStartsWith(captured.contents(), "This was printed.")

checkedThread

checkedThread(
    target: Callable[..., Any],
    args: Optional[tuple[Any, ...]] = None,
    kwargs: Optional[dict[str, Any]] = None
) -> _CheckedThread

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.

countTestCases

countTestCases()

create_tempdir

create_tempdir(
    name=None, cleanup=None
)

Create a temporary directory specific to the test.

This creates a named directory on disk that is isolated to this test, and will be properly cleaned up by the test. This avoids several pitfalls of creating temporary directories for test purposes, as well as makes it easier to setup directories and verify their contents. For example::

def test_foo(self):
  out_dir = self.create_tempdir()
  out_log = out_dir.create_file('output.log')
  expected_outputs = [
      os.path.join(out_dir, 'data-0.txt'),
      os.path.join(out_dir, 'data-1.txt'),
  ]
  code_under_test(out_dir)
  self.assertTrue(os.path.exists(expected_paths[0]))
  self.assertTrue(os.path.exists(expected_paths[1]))
  self.assertEqual('foo', out_log.read_text())

See also: :meth:create_tempfile for creating temporary files.

create_tempfile

create_tempfile(
    file_path=None,
    content=None,
    mode='w',
    encoding='utf8',
    errors='strict',
    cleanup=None
)

Create a temporary file specific to the test.

This creates a named file on disk that is isolated to this test, and will be properly cleaned up by the test. This avoids several pitfalls of creating temporary files for test purposes, as well as makes it easier to setup files, their data, read them back, and inspect them when a test fails. For example::

def test_foo(self):
  output = self.create_tempfile()
  code_under_test(output)
  self.assertGreater(os.path.getsize(output), 0)
  self.assertEqual('foo', output.read_text())

See also: :meth:create_tempdir for creating temporary directories, and _TempDir.create_file for creating files within a temporary directory.

debug

debug()

Run the test without collecting errors in a TestResult

defaultTestResult

defaultTestResult()

doClassCleanups

@classmethod
doClassCleanups()

Execute all class cleanup functions. Normally called for you after tearDownClass.

doCleanups

doCleanups()

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

enter_context

enter_context()

evaluate

evaluate(
    tensors
) -> Union[ragged_tensor_value.RaggedTensorValue, sparse_tensor.
    SparseTensorValue, None]

Evaluates tensors and returns numpy values.

evaluate_if_both_tensors

evaluate_if_both_tensors(
    a, b
)

fail

fail(
    msg=None, user_msg=None
) -> NoReturn

Fail immediately with the given standard message and user message.

failIf

failIf(
    *args, **kwargs
)

failIfAlmostEqual

failIfAlmostEqual(
    *args, **kwargs
)

failIfEqual

failIfEqual(
    *args, **kwargs
)

failUnless

failUnless(
    *args, **kwargs
)

failUnlessAlmostEqual

failUnlessAlmostEqual(
    *args, **kwargs
)

failUnlessEqual

failUnlessEqual(
    *args, **kwargs
)

failUnlessRaises

failUnlessRaises(
    *args, **kwargs
)

gcs_access

View source

@contextlib.contextmanager
gcs_access()

get_temp_dir

get_temp_dir() -> str

Returns a unique temporary directory for the test to use.

If you call this method multiple times during in a test, it will return the same folder. However, across different runs the directories will be different. This will ensure that across different runs tests will not be able to pollute each others environment. If you need multiple unique directories within a single test, you should use tempfile.mkdtemp as follows: tempfile.mkdtemp(dir=self.get_temp_dir()):

id

id()

Returns the descriptive ID of the test.

This is used internally by the unittesting framework to get a name for the test to be used in reports.

run

run(
    result=None
)

session

@contextlib.contextmanager
session(
    graph: Optional[ops.Graph] = None,
    config: Optional[config_pb2.ConfigProto] = None,
    use_gpu: bool = True,
    force_gpu: bool = False
) -> Iterator[s.Session]

A context manager for a TensorFlow Session for use in executing tests.

Note that this will set this session and the graph as global defaults.

Use the use_gpu and force_gpu options to control where ops are run. If force_gpu is True, all ops are pinned to /device: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.session():
      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()

setUp

View source

setUp()

Hook method for setting up the test fixture before exercising it.

setUpClass

View source

@classmethod
setUpClass()

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

shortDescription

shortDescription()

Formats both the test method name and the first line of its docstring.

If no docstring is given, only returns the method name.

This method overrides unittest.TestCase.shortDescription(), which only returns the first line of the docstring, obscuring the name of the test upon failure.

skipTest

skipTest(
    reason
)

Skip this test.

subTest

@contextlib.contextmanager
subTest(
    msg=_subtest_msg_sentinel, **params
)

Return a context manager that will return the enclosed block of code in a subtest identified by the optional message and keyword parameters. A failure in the subtest marks the test case as failed but resumes execution at the end of the enclosed block, allowing further test code to be executed.

tearDown

View source

tearDown()

Hook method for deconstructing the test fixture after testing it.

tearDownClass

View source

@classmethod
tearDownClass()

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

test_baseclass

View source

test_baseclass()

test_download_and_prepare_as_dataset

View source

test_download_and_prepare_as_dataset(
    *args, **kwargs
)

Run the decorated test method.

test_info

View source

test_info()

test_registered

View source

test_registered()

test_session

@contextlib.contextmanager
test_session(
    graph: Optional[ops.Graph] = None,
    config: Optional[config_pb2.ConfigProto] = None,
    use_gpu: bool = True,
    force_gpu: bool = False
) -> Iterator[s.Session]

Use cached_session instead. (deprecated)

test_tags_are_valid

View source

test_tags_are_valid()

__call__

__call__(
    *args, **kwds
)

Call self as a function.

__eq__

__eq__(
    other
)

Return self==value.

}