def __init__(self, methodName='runTest'):
    """Create an instance of the class that will use the named test
       method when executed. Raises a ValueError if the instance does
       not have a method with the specified name.
    """
    self._testMethodName = methodName
    self._outcome = None
    self._testMethodDoc = 'No test'
    try:
        testMethod = getattr(self, methodName)
    except AttributeError:
        if methodName != 'runTest':
            # we allow instantiation with no explicit method name
            # but not an *incorrect* or missing method name
            raise ValueError("no such test method in %s: %s" %
                  (self.__class__, methodName))
    else:
        self._testMethodDoc = testMethod.__doc__
    self._cleanups = []
    self._subtest = None
    # Map types to custom assertEqual functions that will compare
    # instances of said type in more detail to generate a more useful
    # error message.
    self._type_equality_funcs = {}
    self.addTypeEqualityFunc(dict, 'assertDictEqual')
    self.addTypeEqualityFunc(list, 'assertListEqual')
    self.addTypeEqualityFunc(tuple, 'assertTupleEqual')
    self.addTypeEqualityFunc(set, 'assertSetEqual')
    self.addTypeEqualityFunc(frozenset, 'assertSetEqual')
    self.addTypeEqualityFunc(str, 'assertMultiLineEqual')

def addCleanup(*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)."""
    if len(args) >= 2:
        self, function, *args = args
    elif not args:
        raise TypeError("descriptor 'addCleanup' of 'TestCase' object "
                        "needs an argument")
    elif 'function' in kwargs:
        function = kwargs.pop('function')
        self, *args = args
        import warnings
        warnings.warn("Passing 'function' as keyword argument is deprecated",
                      DeprecationWarning, stacklevel=2)
    else:
        raise TypeError('addCleanup expected at least 1 positional '
                        'argument, got %d' % (len(args)-1))
    args = tuple(args)
    self._cleanups.append((function, args, kwargs))

def addTypeEqualityFunc(self, 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.
    """
    self._type_equality_funcs[typeobj] = function

def assertAlmostEqual(self, 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.
    """
    if first == second:
        # shortcut
        return
    if delta is not None and places is not None:
        raise TypeError("specify delta or places not both")
    diff = abs(first - second)
    if delta is not None:
        if diff <= delta:
            return
        standardMsg = '%s != %s within %s delta (%s difference)' % (
            safe_repr(first),
            safe_repr(second),
            safe_repr(delta),
            safe_repr(diff))
    else:
        if places is None:
            places = 7
        if round(diff, places) == 0:
            return
        standardMsg = '%s != %s within %r places (%s difference)' % (
            safe_repr(first),
            safe_repr(second),
            places,
            safe_repr(diff))
    msg = self._formatMessage(msg, standardMsg)
    raise self.failureException(msg)

def deprecated_func(*args, **kwargs):
    warnings.warn(
        'Please use {0} instead.'.format(original_func.__name__),
        DeprecationWarning, 2)
    return original_func(*args, **kwargs)

def assertCountEqual(self, 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.
    """
    first_seq, second_seq = list(first), list(second)
    try:
        first = collections.Counter(first_seq)
        second = collections.Counter(second_seq)
    except TypeError:
        # Handle case with unhashable elements
        differences = _count_diff_all_purpose(first_seq, second_seq)
    else:
        if first == second:
            return
        differences = _count_diff_hashable(first_seq, second_seq)
    if differences:
        standardMsg = 'Element counts were not equal:\n'
        lines = ['First has %d, Second has %d:  %r' % diff for diff in differences]
        diffMsg = '\n'.join(lines)
        standardMsg = self._truncateMessage(standardMsg, diffMsg)
        msg = self._formatMessage(msg, standardMsg)
        self.fail(msg)

def assertDictContainsSubset(self, subset, dictionary, msg=None):
    """Checks whether dictionary is a superset of subset."""
    warnings.warn('assertDictContainsSubset is deprecated',
                  DeprecationWarning)
    missing = []
    mismatched = []
    for key, value in subset.items():
        if key not in dictionary:
            missing.append(key)
        elif value != dictionary[key]:
            mismatched.append('%s, expected: %s, actual: %s' %
                              (safe_repr(key), safe_repr(value),
                               safe_repr(dictionary[key])))
    if not (missing or mismatched):
        return
    standardMsg = ''
    if missing:
        standardMsg = 'Missing: %s' % ','.join(safe_repr(m) for m in
                                                missing)
    if mismatched:
        if standardMsg:
            standardMsg += '; '
        standardMsg += 'Mismatched values: %s' % ','.join(mismatched)
    self.fail(self._formatMessage(msg, standardMsg))

def assertDictEqual(self, d1, d2, msg=None):
    self.assertIsInstance(d1, dict, 'First argument is not a dictionary')
    self.assertIsInstance(d2, dict, 'Second argument is not a dictionary')
    if d1 != d2:
        standardMsg = '%s != %s' % _common_shorten_repr(d1, d2)
        diff = ('\n' + '\n'.join(difflib.ndiff(
                       pprint.pformat(d1).splitlines(),
                       pprint.pformat(d2).splitlines())))
        standardMsg = self._truncateMessage(standardMsg, diff)
        self.fail(self._formatMessage(msg, standardMsg))

def assertEqual(self, first, second, msg=None):
    """Fail if the two objects are unequal as determined by the '=='
       operator.
    """
    assertion_func = self._getAssertEqualityFunc(first, second)
    assertion_func(first, second, msg=msg)

def deprecated_func(*args, **kwargs):
    warnings.warn(
        'Please use {0} instead.'.format(original_func.__name__),
        DeprecationWarning, 2)
    return original_func(*args, **kwargs)

def assertFalse(self, expr, msg=None):
    """Check that the expression is false."""
    if expr:
        msg = self._formatMessage(msg, "%s is not false" % safe_repr(expr))
        raise self.failureException(msg)

def assertGreater(self, a, b, msg=None):
    """Just like self.assertTrue(a > b), but with a nicer default message."""
    if not a > b:
        standardMsg = '%s not greater than %s' % (safe_repr(a), safe_repr(b))
        self.fail(self._formatMessage(msg, standardMsg))

def assertGreaterEqual(self, a, b, msg=None):
    """Just like self.assertTrue(a >= b), but with a nicer default message."""
    if not a >= b:
        standardMsg = '%s not greater than or equal to %s' % (safe_repr(a), safe_repr(b))
        self.fail(self._formatMessage(msg, standardMsg))

def assertIn(self, member, container, msg=None):
    """Just like self.assertTrue(a in b), but with a nicer default message."""
    if member not in container:
        standardMsg = '%s not found in %s' % (safe_repr(member),
                                              safe_repr(container))
        self.fail(self._formatMessage(msg, standardMsg))

def assertIs(self, expr1, expr2, msg=None):
    """Just like self.assertTrue(a is b), but with a nicer default message."""
    if expr1 is not expr2:
        standardMsg = '%s is not %s' % (safe_repr(expr1),
                                         safe_repr(expr2))
        self.fail(self._formatMessage(msg, standardMsg))

def assertIsInstance(self, obj, cls, msg=None):
    """Same as self.assertTrue(isinstance(obj, cls)), with a nicer
    default message."""
    if not isinstance(obj, cls):
        standardMsg = '%s is not an instance of %r' % (safe_repr(obj), cls)
        self.fail(self._formatMessage(msg, standardMsg))

def assertIsNone(self, obj, msg=None):
    """Same as self.assertTrue(obj is None), with a nicer default message."""
    if obj is not None:
        standardMsg = '%s is not None' % (safe_repr(obj),)
        self.fail(self._formatMessage(msg, standardMsg))

def assertIsNot(self, expr1, expr2, msg=None):
    """Just like self.assertTrue(a is not b), but with a nicer default message."""
    if expr1 is expr2:
        standardMsg = 'unexpectedly identical: %s' % (safe_repr(expr1),)
        self.fail(self._formatMessage(msg, standardMsg))

def assertIsNotNone(self, obj, msg=None):
    """Included for symmetry with assertIsNone."""
    if obj is None:
        standardMsg = 'unexpectedly None'
        self.fail(self._formatMessage(msg, standardMsg))

def assertLess(self, a, b, msg=None):
    """Just like self.assertTrue(a < b), but with a nicer default message."""
    if not a < b:
        standardMsg = '%s not less than %s' % (safe_repr(a), safe_repr(b))
        self.fail(self._formatMessage(msg, standardMsg))

def assertLessEqual(self, a, b, msg=None):
    """Just like self.assertTrue(a <= b), but with a nicer default message."""
    if not a <= b:
        standardMsg = '%s not less than or equal to %s' % (safe_repr(a), safe_repr(b))
        self.fail(self._formatMessage(msg, standardMsg))

def assertListEqual(self, 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.
    """
    self.assertSequenceEqual(list1, list2, msg, seq_type=list)

def assertLogs(self, logger=None, level=None):
    """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'])
    """
    return _AssertLogsContext(self, logger, level)

def assertMultiLineEqual(self, first, second, msg=None):
    """Assert that two multi-line strings are equal."""
    self.assertIsInstance(first, str, 'First argument is not a string')
    self.assertIsInstance(second, str, 'Second argument is not a string')
    if first != second:
        # don't use difflib if the strings are too long
        if (len(first) > self._diffThreshold or
            len(second) > self._diffThreshold):
            self._baseAssertEqual(first, second, msg)
        firstlines = first.splitlines(keepends=True)
        secondlines = second.splitlines(keepends=True)
        if len(firstlines) == 1 and first.strip('\r\n') == first:
            firstlines = [first + '\n']
            secondlines = [second + '\n']
        standardMsg = '%s != %s' % _common_shorten_repr(first, second)
        diff = '\n' + ''.join(difflib.ndiff(firstlines, secondlines))
        standardMsg = self._truncateMessage(standardMsg, diff)
        self.fail(self._formatMessage(msg, standardMsg))

def assertNotAlmostEqual(self, 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.
    """
    if delta is not None and places is not None:
        raise TypeError("specify delta or places not both")
    diff = abs(first - second)
    if delta is not None:
        if not (first == second) and diff > delta:
            return
        standardMsg = '%s == %s within %s delta (%s difference)' % (
            safe_repr(first),
            safe_repr(second),
            safe_repr(delta),
            safe_repr(diff))
    else:
        if places is None:
            places = 7
        if not (first == second) and round(diff, places) != 0:
            return
        standardMsg = '%s == %s within %r places' % (safe_repr(first),
                                                     safe_repr(second),
                                                     places)
    msg = self._formatMessage(msg, standardMsg)
    raise self.failureException(msg)

def deprecated_func(*args, **kwargs):
    warnings.warn(
        'Please use {0} instead.'.format(original_func.__name__),
        DeprecationWarning, 2)
    return original_func(*args, **kwargs)

def assertNotEqual(self, first, second, msg=None):
    """Fail if the two objects are equal as determined by the '!='
       operator.
    """
    if not first != second:
        msg = self._formatMessage(msg, '%s == %s' % (safe_repr(first),
                                                      safe_repr(second)))
        raise self.failureException(msg)

def deprecated_func(*args, **kwargs):
    warnings.warn(
        'Please use {0} instead.'.format(original_func.__name__),
        DeprecationWarning, 2)
    return original_func(*args, **kwargs)

def assertNotIn(self, member, container, msg=None):
    """Just like self.assertTrue(a not in b), but with a nicer default message."""
    if member in container:
        standardMsg = '%s unexpectedly found in %s' % (safe_repr(member),
                                                    safe_repr(container))
        self.fail(self._formatMessage(msg, standardMsg))

def assertNotIsInstance(self, obj, cls, msg=None):
    """Included for symmetry with assertIsInstance."""
    if isinstance(obj, cls):
        standardMsg = '%s is an instance of %r' % (safe_repr(obj), cls)
        self.fail(self._formatMessage(msg, standardMsg))

def assertNotRegex(self, text, unexpected_regex, msg=None):
    """Fail the test if the text matches the regular expression."""
    if isinstance(unexpected_regex, (str, bytes)):
        unexpected_regex = re.compile(unexpected_regex)
    match = unexpected_regex.search(text)
    if match:
        standardMsg = 'Regex matched: %r matches %r in %r' % (
            text[match.start() : match.end()],
            unexpected_regex.pattern,
            text)
        # _formatMessage ensures the longMessage option is respected
        msg = self._formatMessage(msg, standardMsg)
        raise self.failureException(msg)

def deprecated_func(*args, **kwargs):
    warnings.warn(
        'Please use {0} instead.'.format(original_func.__name__),
        DeprecationWarning, 2)
    return original_func(*args, **kwargs)

def assertRaises(self, 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)
    """
    context = _AssertRaisesContext(expected_exception, self)
    try:
        return context.handle('assertRaises', args, kwargs)
    finally:
        # bpo-23890: manually break a reference cycle
        context = None